diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..4f8075ffce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: New feedback experience + url: https://learn.microsoft.com/office/new-feedback + about: We’re transitioning our feedback experience away from GitHub Issues. For more information, select Open. \ No newline at end of file diff --git a/.github/workflows/AutoLabelAssign.yml b/.github/workflows/AutoLabelAssign.yml new file mode 100644 index 0000000000..65e87b3d4b --- /dev/null +++ b/.github/workflows/AutoLabelAssign.yml @@ -0,0 +1,37 @@ +name: Assign and label PR + +permissions: + pull-requests: write + contents: read + actions: read + +on: + workflow_run: + workflows: [Background tasks] + types: + - completed + +jobs: + download-payload: + name: Download and extract payload artifact + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-ExtractPayload.yml@workflows-prod + with: + WorkflowId: ${{ github.event.workflow_run.id }} + OrgRepo: ${{ github.repository }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + + label-assign: + name: Run assign and label + if: github.repository_owner == 'MicrosoftDocs' + needs: [download-payload] + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-AutoLabelAssign.yml@workflows-prod + with: + PayloadJson: ${{ needs.download-payload.outputs.WorkflowPayload }} + AutoAssignUsers: 1 + AutoLabel: 1 + ExcludedUserList: '["user1", "user2"]' + ExcludedBranchList: '["branch1", "branch2"]' + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/AutoLabelMsftContributor.yml b/.github/workflows/AutoLabelMsftContributor.yml new file mode 100644 index 0000000000..6fcfb6e43e --- /dev/null +++ b/.github/workflows/AutoLabelMsftContributor.yml @@ -0,0 +1,35 @@ +name: Auto label Microsoft contributors + +permissions: + pull-requests: write + contents: read + actions: read + +on: + workflow_run: + workflows: [Background tasks] + types: + - completed + +jobs: + download-payload: + if: github.repository_owner == 'MicrosoftDocs' && github.repository_visibility == 'public' + name: Download and extract payload artifact + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-ExtractPayload.yml@workflows-prod + with: + WorkflowId: ${{ github.event.workflow_run.id }} + OrgRepo: ${{ github.repository }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + + label-msft: + name: Label Microsoft contributors + if: github.repository_owner == 'MicrosoftDocs' && github.repository_visibility == 'public' + needs: [download-payload] + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-AutoLabelMsftContributor.yml@workflows-prod + with: + PayloadJson: ${{ needs.download-payload.outputs.WorkflowPayload }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + ClientId: ${{ secrets.M365_APP_CLIENT_ID }} + PrivateKey: ${{ secrets.M365_APP_PRIVATE_KEY }} \ No newline at end of file diff --git a/.github/workflows/AutoPublish.yml b/.github/workflows/AutoPublish.yml new file mode 100644 index 0000000000..c067d8f47b --- /dev/null +++ b/.github/workflows/AutoPublish.yml @@ -0,0 +1,27 @@ +name: (Scheduled) Publish to live + +permissions: + contents: write + pull-requests: write + checks: read + +on: + schedule: + - cron: "25 2,5,8,11,14,17,20,22 * * *" # Times are UTC based on Daylight Saving Time. Need to be adjusted for Standard Time. Scheduling at :25 to account for queuing lag. + + workflow_dispatch: + +jobs: + + auto-publish: + if: github.repository_owner == 'MicrosoftDocs' && contains(github.event.repository.topics, 'build') + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-AutoPublishV2.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + EnableAutoPublish: true + EnableAutoMerge: true + + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + PrivateKey: ${{ secrets.M365_APP_PRIVATE_KEY }} + ClientId: ${{ secrets.M365_APP_CLIENT_ID }} \ No newline at end of file diff --git a/.github/workflows/BackgroundTasks.yml b/.github/workflows/BackgroundTasks.yml new file mode 100644 index 0000000000..8dc3ceae0a --- /dev/null +++ b/.github/workflows/BackgroundTasks.yml @@ -0,0 +1,27 @@ +name: Background tasks + +permissions: + pull-requests: write + contents: read + +on: + pull_request_target: + +jobs: + upload: + if: github.repository_owner == 'MicrosoftDocs' + runs-on: ubuntu-latest + + steps: + - name: Save payload data + env: + PayloadJson: ${{ toJSON(github) }} + AccessToken: ${{ github.token }} + run: | + mkdir -p ./pr + echo $PayloadJson > ./pr/PayloadJson.json + sed -i -e "s/$AccessToken/XYZ/g" ./pr/PayloadJson.json + - uses: actions/upload-artifact@v4 + with: + name: PayloadJson + path: pr/ \ No newline at end of file diff --git a/.github/workflows/BuildValidation.yml b/.github/workflows/BuildValidation.yml new file mode 100644 index 0000000000..dadccacbef --- /dev/null +++ b/.github/workflows/BuildValidation.yml @@ -0,0 +1,19 @@ +name: PR has no warnings or errors + +permissions: + pull-requests: write + statuses: write + +on: + issue_comment: + types: [created] + +jobs: + + build-status: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-BuildValidation.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/LiveMergeCheck.yml b/.github/workflows/LiveMergeCheck.yml new file mode 100644 index 0000000000..7db35548e9 --- /dev/null +++ b/.github/workflows/LiveMergeCheck.yml @@ -0,0 +1,20 @@ +name: PR can merge into branch + +permissions: + pull-requests: write + statuses: write + contents: read + +on: + pull_request_target: + types: [opened, reopened, synchronize, edited] + +jobs: + + live-merge: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-LiveMergeCheck.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/PrFileCount.yml b/.github/workflows/PrFileCount.yml new file mode 100644 index 0000000000..17faf7a211 --- /dev/null +++ b/.github/workflows/PrFileCount.yml @@ -0,0 +1,20 @@ +name: PR file count less than limit + +permissions: + pull-requests: write + statuses: write + contents: read + +on: + pull_request_target: + types: [opened, reopened, synchronize, labeled, unlabeled, edited] + +jobs: + + file-count: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-PrFileCount.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/ProtectedFiles.yml b/.github/workflows/ProtectedFiles.yml new file mode 100644 index 0000000000..bbdbbe2e40 --- /dev/null +++ b/.github/workflows/ProtectedFiles.yml @@ -0,0 +1,18 @@ +name: PR has no protected files + +permissions: + pull-requests: write + statuses: write + contents: read + +on: [pull_request_target] + +jobs: + + protected-files: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-ProtectedFiles.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/Stale.yml b/.github/workflows/Stale.yml new file mode 100644 index 0000000000..7f262d325a --- /dev/null +++ b/.github/workflows/Stale.yml @@ -0,0 +1,20 @@ +name: (Scheduled) Mark stale pull requests + +permissions: + issues: write + pull-requests: write + +on: + schedule: + - cron: "0 */6 * * *" + workflow_dispatch: + +jobs: + stale: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-Stale.yml@workflows-prod + with: + RunDebug: false + RepoVisibility: ${{ github.repository_visibility }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/StaleBranch.yml b/.github/workflows/StaleBranch.yml new file mode 100644 index 0000000000..30212d1836 --- /dev/null +++ b/.github/workflows/StaleBranch.yml @@ -0,0 +1,32 @@ +name: (Scheduled) Stale branch removal + +permissions: + contents: write + pull-requests: read + +# This workflow is designed to be run in the days up to, and including, a "deletion day", specified by 'DeleteOnDayOfMonth' in env: in https://github.com/MicrosoftDocs/microsoft-365-docs/blob/workflows-prod/.github/workflows/Shared-StaleBranch.yml. +# On the days leading up to "deletion day", the workflow will report the branches to be deleted. This lets users see which branches will be deleted. On "deletion day", those branches are deleted. +# The workflow should not be configured to run after "deletion day" so that users can review the branches were deleted. +# Recommendation: configure cron to run on days 1,15-31 where 1 is what's configured in 'DeleteOnDayOfMonth'. If 'DeleteOnDayOfMonth' is set to something else, update cron to run the two weeks leading up to it. + +on: + schedule: + - cron: "0 9 1,15-31 * *" + + workflow_dispatch: + + +jobs: + + stale-branch: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-StaleBranch.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + RepoBranchSkipList: '[ + "ExampleBranch1", + "ExampleBranch2" + ]' + ReportOnly: false + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/TierManagement.yml b/.github/workflows/TierManagement.yml new file mode 100644 index 0000000000..47baf0be65 --- /dev/null +++ b/.github/workflows/TierManagement.yml @@ -0,0 +1,21 @@ +name: Tier management + +permissions: + pull-requests: write + contents: read + +on: + issue_comment: + types: [created, edited] + +jobs: + + tier-mgmt: + if: github.repository_owner == 'MicrosoftDocs' && github.repository_visibility == 'private' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-TierManagement.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + EnableWriteSignOff: 1 + EnableReadOnlySignoff: 1 + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore index fa3869f7cb..41b9a36fff 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,13 @@ _site/ .optemp/ _themes*/ .vs/ +common/ +.vscode/ +*.ini +.DS_Store +*.db +\.idea/ .local/ .openpublishing.buildcore.ps1 +**/node_modules diff --git a/.openpublishing.build.ps1 b/.openpublishing.build.ps1 deleted file mode 100644 index aadef76202..0000000000 --- a/.openpublishing.build.ps1 +++ /dev/null @@ -1,17 +0,0 @@ -param( - [string]$buildCorePowershellUrl = "https://opbuildstorageprod.blob.core.windows.net/opps1container/.openpublishing.buildcore.ps1", - [string]$parameters -) -# Main -$errorActionPreference = 'Stop' - -# Step-1: Download buildcore script to local -echo "download build core script to local with source url: $buildCorePowershellUrl" -$repositoryRoot = Split-Path -Parent $MyInvocation.MyCommand.Definition -$buildCorePowershellDestination = "$repositoryRoot\.openpublishing.buildcore.ps1" -Invoke-WebRequest $buildCorePowershellUrl -OutFile "$buildCorePowershellDestination" - -# Step-2: Run build core -echo "run build core script with parameters: $parameters" -& "$buildCorePowershellDestination" "$parameters" -exit $LASTEXITCODE diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 320cd41f1a..72c839af99 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -12,21 +12,19 @@ "Conceptual": "Content", "ManagedReference": "Content", "RestApi": "Content", - "AzurePsModulePage": "Content" + "PowershellModule": "Content", + "PowershellCmdlet": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], "customized_tasks": { "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" + "_dependentPackages/MAML2Yaml/tools/Run.ps1" ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -41,50 +39,14 @@ "Conceptual": "Content", "ManagedReference": "Content", "RestApi": "Content", - "AzurePsModulePage": "Content" + "PowershellModule": "Content", + "PowershellCmdlet": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" - ] - }, - { - "docset_name": "sharepoint-ps", - "build_source_folder": "sharepoint", - "build_output_subfolder": "sharepoint-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "AzurePsModulePage": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" - ] - }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -99,27 +61,25 @@ "Conceptual": "Content", "ManagedReference": "Content", "RestApi": "Content", - "AzurePsModulePage": "Content" + "PowershellModule": "Content", + "PowershellCmdlet": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], "customized_tasks": { "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" + "_dependentPackages/MAML2Yaml/tools/Run.ps1" ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { - "docset_name": "staffhub-ps", - "build_source_folder": "staffhub", - "build_output_subfolder": "staffhub-ps", + "docset_name": "spmt-ps", + "build_source_folder": "spmt", + "build_output_subfolder": "spmt-ps", "locale": "en-us", "monikers": [], "moniker_ranges": [], @@ -128,21 +88,14 @@ "Conceptual": "Content", "ManagedReference": "Content", "RestApi": "Content", - "AzurePsModulePage": "Content" + "PowershellModule": "Content", + "PowershellCmdlet": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" - ] - }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -157,50 +110,19 @@ "Conceptual": "Content", "ManagedReference": "Content", "RestApi": "Content", - "AzurePsModulePage": "Content" + "PowershellModule": "Content", + "PowershellCmdlet": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], "customized_tasks": { "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" + "_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", - "AzurePsModulePage": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -215,71 +137,58 @@ "Conceptual": "Content", "ManagedReference": "Content", "RestApi": "Content", - "AzurePsModulePage": "Content" + "PowershellModule": "Content", + "PowershellCmdlet": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_template_paths": [ - "_dependentPackages/azurecli.plugins/azurecli" - ], "customized_tasks": { "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1" + "_dependentPackages/MAML2Yaml/tools/Run.ps1" ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] } ], "notification_subscribers": [], + "sync_notification_subscribers": [], "branches_to_filter": [], - "git_repository_branch_open_to_public_contributors": "master", - "skip_source_output_uploading": false, + "git_repository_branch_open_to_public_contributors": "main", "need_preview_pull_request": true, - "contribution_branch_mappings": {}, "dependent_repositories": [ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "master", - "branch_mapping": {} - }, - { - "path_to_root": "_themes.pdf", - "url": "https://github.com/Microsoft/templates.docs.msft.pdf", - "branch": "master", + "branch": "main", "branch_mapping": {} } ], "branch_target_mapping": { "live": [ - "Publish", - "Pdf" + "Publish" ] }, - "need_generate_pdf_url_template": true, "targets": { "Pdf": { "template_folder": "_themes.pdf" } }, - "need_generate_pdf": false, + "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": [ { - "path_to_root": "_dependentPackages/azurecli.plugins", - "id": "opbuild.templates.azurecli", - "version": "latest", - "nuget_feed": "https://www.myget.org/F/op/api/v2" - }, - { - "path_to_root": "_dependentPackages/CommonPlugins", + "id": "Microsoft.DocAsCode.MAML2Yaml", + "nuget_feed": "https://www.myget.org/F/op/api/v2", + "path_to_root": "_dependentPackages/MAML2Yaml", "target_framework": "net45", - "version": "latest", - "id": "Microsoft.OpenPublishing.CommonPlugins", - "nuget_feed": "https://www.myget.org/F/op/api/v2" + "version": "latest" } ] -} +} \ No newline at end of file diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json new file mode 100644 index 0000000000..0c2327fa83 --- /dev/null +++ b/.openpublishing.redirection.json @@ -0,0 +1,9026 @@ +{ + "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": "exchange/virtual-folder/exchange/Get-VivaFeatureCategory.md", + "redirect_url": "/viva/feature-access-management", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RecordLabel.md", + "redirect_url": "/powershell/module/exchange/remove-label", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/teams/Disable-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/teams/Enable-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/Export-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/export-csonlineaudiofile.md", + "redirect_url": "/powershell/module/teams/export-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Find-CsGroup.md", + "redirect_url": "/powershell/module/teams/Find-CsGroup", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Find-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Find-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsApplicationMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantStatus.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedLanguage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedTimeZone", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantTenantInformation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Get-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/Get-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Get-CsEffectiveTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Get-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/Get-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMeetingMigrationStatus.md", + "redirect_url": "/powershell/module/teams/Get-CsMeetingMigrationStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociationStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingBridge", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingLanguagesSupported", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingTenantConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialOutPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialOutPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenant.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDirectoryTenant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlinePstnUsage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineTelephoneNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineUser.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailUserSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsClientConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsEducationAssignmentsAppPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestCallingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMessagingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsVideoInteropServicePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenant.md", + "redirect_url": "/powershell/module/teams/Get-CsTenant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantBlockedCallingNumbers", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantFederationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantLicensingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantLicensingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantMigrationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/Get-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Grant-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsCloudMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsDialoutPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsDialoutPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsExternalUserCommunicationPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsVideoInteropServicePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Grant-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/Import-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/Import-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallableEntity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallFlow", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallHandlingAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantDialScope", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenu.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenu", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenuOption", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantPrompt", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/New-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/New-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowAllKnownDomains.md", + "redirect_url": "/powershell/module/teams/New-CsEdgeAllowAllKnownDomains", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowList.md", + "redirect_url": "/powershell/module/teams/New-CsEdgeAllowList", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeDomainPattern.md", + "redirect_url": "/powershell/module/teams/New-CsEdgeDomainPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/New-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/New-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineDateTimeRange.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineDateTimeRange", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/New-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineTimeRange.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineTimeRange", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPairedApplication.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPairedApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingExtendedNotification.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingExtendedNotification", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyNumber.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/New-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/New-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/New-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/New-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Register-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Register-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Remove-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Remove-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/Remove-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Remove-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/Remove-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineTelephoneNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/Remove-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsApplicationMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Set-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Set-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/Set-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Set-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/Set-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingBridge", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUserDefaultNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlinePstnUsage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailUserSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsClientConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsEducationAssignmentsAppPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestCallingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMessagingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantBlockedCallingNumbers", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantFederationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantMigrationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/Set-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsExMeetingMigration.md", + "redirect_url": "/powershell/module/teams/Start-CsExMeetingMigration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Sync-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Sync-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Test-CsEffectiveTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Test-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Test-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Unregister-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Update-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Clear-CsOnlineTelephoneNumberReservation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHuntGroupTenantInformation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserInfo.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserState.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenantNumberCities.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortOutOrderPin.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberAvailableCount.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCities.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantStatus.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeStatus.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantPublicProvider.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsBroadcastMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineBulkAssignmentInput.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineSession.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenu.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Search-CsOnlineTelephoneNumberInventory.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Select-CsOnlineTelephoneNumberInventory.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDirectoryUser.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortOutOrderPin.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUserBulk.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantPublicProvider.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlineCarrierPortabilityIn.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlinePortabilityIn.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + } + ] } diff --git a/ContentOwners.txt b/ContentOwners.txt new file mode 100644 index 0000000000..95093fb98b --- /dev/null +++ b/ContentOwners.txt @@ -0,0 +1 @@ +* @tiburd @yogkumgit diff --git a/README.md b/README.md index 4940047461..799d11a6c6 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,93 @@ -# Short URL: aka.ms/office-powershell +--- +ms.date: 05/16/2025 +--- # Overview -This repository holds reference content of Office PowerShell cmdlets for help purpose. The expert knowledge around Office PowerShell is distributed among customers, MVPs, partners, product teams, support, and other community members. Consumers also have various preferences when consuming knowledge such as a website, PowerShell Get-Help, Windows app, iOS app, Android app, and others. The following diagram illustrates the point. -![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png) -# Learn How To Contribute -Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics. -When you contribute your work will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet. +## Learn how to contribute -> Notice that if you are looking into contributing for the **PnP PowerShell cmdlets**, their documentation is automatically generated from the code, and you should be submitting your change towards the original code at https://github.com/SharePoint/PnP-powershell. See, for example, how the attributes are used in the code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet. +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: . -# Quick Start +If you get stuck and are a Microsoft employee or vendor, post a message to [Ask an Admin](https://aka.ms/askanadmin). -## Contribute using the GitHub website +### Quickly update an article using GitHub.com -[![Image of Quick Start video](images/edit_video_capture.jpg)](https://support.office.com/en-us/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf?ui=en-US&rs=en-US&ad=US) +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. -1. Open your browser, log in to GitHub, and then navigate to https://github.com/microsoftdocs/office-docs-powershell -2. Browse to the file you want to edit. In this example, we will edit https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/New-Team.md and add a link in the Related Links section. -3. Click the Edit icon which looks like a pencil in the upper right corner. -![Image of Edit button on Github](images/edit_icon.png) +> [!TIP] +> To edit an article, you need to get to it on the GitHub.com backend. If you're already on the GitHub.com page of the article, you're starting at step 4. +> +> Your permissions in the repo determine what you see in step 5 and later. People with no special privileges see the steps as described. People with permissions to approve their own pull requests see a similar experience with different button and page titles (for example, **Commit changes** instead of **Propose changes**), extra options for creating a new branch, and fewer confirmation pages. The point is: click any green buttons that are presented to you until there are no more. -4. Your browser will then open the file in an edit window. We want to add a link. So we scroll down to the Related Links section and add the link in the correct format. -![Image of Edit button on Github](images/add_related_link.png) +1. Verify that you're signed in to GitHub.com with your GitHub account. +2. On learn.microsoft.com, find the article that you want to update. +3. Above the title of the article, select ![Edit this document icon.](images/m365-cc-sc-edit-icon.png) **Edit this document**. -**Note** Since you are likely not a maintainer of the Git repository, GitHub will automatically 'Fork' the project into your personal GitHub account. A fork is just an exact copy of the repository in your own account so that you have total access to make edits. You are now 'editing' a copy of the project in your own GitHub account. You can always find it again by looking at your GitHub Repositories in your GitHub Profile (drop-down from your name in the top right). -![Image of Automatic Fork message on Github](images/auto_fork.png) + ![Screenshot of how to select the Edit this document button on a learn.microsoft.com article.](images/quick-update-edit-button-on-learn-page.png) -5. You can click the Preview changes link to see what the changes will look like. +4. The corresponding article file opens on GitHub. Select ![Edit icon.](images/quick-update-github-edit-icon.png) **Edit**. - **IMPORTANT** The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help. - Any deviation will throw errors in the Pull Request. The schema can be found here: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md + ![Screenshot of how to select the Edit button on a GitHub article file.](images/quick-update-edit-button-on-github-page.png) -6. Once you are satisfied with your work, go to the **Propose file change** area at the bottom of the topic. Enter a title and other description information, and then click **Propose file change**. -![Image of Propose file change on Github](images/propose_file_change.png) +5. If a **You need to fork this repository to propose changes** page opens, select **Fork this repository**. -7. On the next screen, click **Create pull request**. + ![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) -Looking for more in-depth content? Check out the following: -* [Frequently Asked Questions (FAQ)](repo_docs/FAQ.md) -* [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md) -* [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md) +6. The article file opens in a line-numbered editor page where you can make updates. -# Microsoft Open Source Code of Conduct + 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/). -## Contributing + > [!TIP] + > Cmdlet reference articles follow a very strict schema with limited formatting options, because the articles are also converted and used for help at the command line (`Get-Help `). Use existing content as a guide. For more information, see [platyPS Schema](https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md). -This project welcomes contributions and suggestions. Most contributions require you to agree to a -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us -the rights to use your contribution. For details, visit https://cla.microsoft.com. + Select **Preview** to view your changes as you go. Select **Edit** to go back to making updates. -When you submit a pull request, a CLA-bot will automatically determine whether you need to provide -a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions -provided by the bot. You will only need to do this once across all repos using our CLA. + When you're finished making changes, select the green **Commit changes** button. + + ![Screenshot of how to select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) + +7. In the **Propose changes** dialog that opens, review and/or enter the following values: + - **Commit message**: This value is required. You can accept the default value ("Update \") or you can change it. + - **Extended description**: This value is optional. For example: + - An explanation of the changes. + - @ include the GitHub alias of someone to review and merge your changes. + + When you're finished on the **Propose changes** dialog, select the green **Propose changes** button. + + ![Screenshot of how to select the green Propose changes button in the Propose changes dialog.](images/quick-update-propose-changes-dialog.png) + +8. On the **Comparing changes** page that opens, select the green **Create pull request** button. + + ![Screenshot of how to select the green Create pull request button on the Comparing changes page.](images/quick-update-comparing-changes-page.png) + +9. On the **Open a pull request** page that opens, review the title and comments, and then select the green **Create pull request** button. + + ![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) + +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. + +## Microsoft Open Source Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. -## Legal Notices +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any questions or comments. + +### Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit . + +When you submit a pull request, a CLA-bot automatically determines whether you need to provide a CLA and decorate the PR appropriately (for example, label, comment). Follow the instructions provided by the bot. You only need to do this step once across all repos using our CLA. + +### Legal Notices + +Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the [LICENSE-CODE](LICENSE-CODE) file. -Microsoft and any contributors grant you a license to the Microsoft documentation and other content -in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), -see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the -[LICENSE-CODE](LICENSE-CODE) file. +Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries/regions. -Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation -may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. -The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. -Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653. +The licenses for this project don't grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at . -Privacy information can be found at https://privacy.microsoft.com/en-us/ +Privacy information can be found at -Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, -or trademarks, whether by implication, estoppel or otherwise. +Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..e138ec5d6a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,41 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). + +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). + +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd). + + diff --git a/cabgen-bootstrap.yml b/cabgen-bootstrap.yml new file mode 100644 index 0000000000..51843abfaa --- /dev/null +++ b/cabgen-bootstrap.yml @@ -0,0 +1,14 @@ +trigger: +- live + +pr: none # Disable pull request triggers. + +resources: + repositories: + - repository: templates + type: git + name: Content CI/ReferenceAutomation + ref: refs/heads/master + +extends: + template: PowerShell/cabgen.yml@templates \ No newline at end of file diff --git a/exchange/docfx.json b/exchange/docfx.json index 87a885fd00..e0a0abf6b0 100644 --- a/exchange/docfx.json +++ b/exchange/docfx.json @@ -2,7 +2,10 @@ "build": { "content": [ { - "files": ["**/*.md"], + "files": [ + "**/*.md", + "**/*.yml" + ], "src": "docs-conceptual", "version": "exchange-ps", "dest": "exchange", @@ -12,26 +15,44 @@ "README.md", "LICENSE", "LICENSE-CODE", - "ThirdPartyNotices"] + "ThirdPartyNotices" + ] }, { - "files": ["toc.yml"], + "files": [ + "toc.yml" + ], "src": "docs-conceptual", "version": "exchange-ps", "dest": "exchange/exchange-ps" }, { - "files": ["**/*.md"], - "src": "exchange-ps", - "version": "exchange-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "exchange-ps", - "version": "exchange-ps", - "dest": "module/exchange-ps" - } + "files": [ + "**/*.yml" + ], + "exclude": [ + "toc.yml" + ], + "src": "exchange-ps", + "version": "exchange-ps", + "dest": "module" + }, + { + "files": [ + "toc.yml" + ], + "src": "exchange-ps", + "version": "exchange-ps", + "dest": "module/exchange-ps" + }, + { + "files": [ + "**/*.md" + ], + "src": "virtual-folder", + "version": "exchange-ps", + "dest": "module" + } ], "resource": [ { @@ -54,23 +75,29 @@ "overwrite": [], "externalReference": [], "globalMetadata": { - "author" : "chrisda", - "ms.author" : "chrisda", - "manager" : "serdars", - "ms.date" : "09/25/2017", - "ms.topic" : "reference", - "ms.service" : "exchange-powershell", - "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "uhfHeaderId": "MSDocsHeader-M365-IT", + "author": "chrisda", + "ms.author": "chrisda", + "manager": "serdars", + "ms.date": "09/25/2017", + "ms.topic": "reference", + "ms.service": "exchange-powershell", + "products": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/0b654e73-5728-4af3-8c2e-17bfbf4c9f23", + "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" + ], + "ms.devlang": "powershell", + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": { - "apiPlatform":{ - "exchange-ps/exchange" : [ "PowerShell" ] + "apiPlatform": { + "exchange-ps/exchange/**/*.yml": [ + "powershell" + ] } }, "template": [], "dest": "exchange-ps" } -} +} \ No newline at end of file diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md new file mode 100644 index 0000000000..f23758f7ff --- /dev/null +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -0,0 +1,540 @@ +--- +title: App-only authentication in Exchange Online PowerShell and Security & Compliance PowerShell +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 12/12/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn how to configure app-only authentication (also known as certificate based authentication or CBA) using the Exchange Online PowerShell V3 module in scripts and other long-running tasks." +--- + +# App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell + +Auditing and reporting scenarios in Microsoft 365 often involve unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell. In the past, unattended sign in required you to store the username and password in a local file or in a secret vault that's accessed at run-time. But, as we all know, storing user credentials locally isn't a good security practice. + +Certificate based authentication (CBA) or app-only authentication as described in this article supports unattended script and automation scenarios by using Microsoft Entra apps and self-signed certificates. + +> [!NOTE] +> +> - Did you know that you can connect to Exchange Online PowerShell using managed identities in Azure? Check out [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). +> +> - The features and procedures described in this article require the following versions of the Exchange Online PowerShell module: +> - **Exchange Online PowerShell (Connect-ExchangeOnline)**: Version 2.0.3 or later. +> - **Security & Compliance PowerShell (Connect-IPPSSession)**: Version 3.0.0 or later. +> +> For instructions on how to install or update the module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). For instructions on how to use the module in Azure automation, see [Manage modules in Azure Automation](/azure/automation/shared-resources/modules). +> +> - REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). +> +> If the procedures in this article don't work for you, verify that you don't have Beta versions of the PackageManagement or PowerShellGet modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. +> +> - In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) +> - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) +> - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) +> - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) +> +> You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). +> +> - In Security & Compliance PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> - [Get-ComplianceSearchAction](/powershell/module/exchange/get-compliancesearchaction) +> - [New-ComplianceSearch](/powershell/module/exchange/new-compliancesearch) +> - [Start-ComplianceSearch](/powershell/module/exchange/start-compliancesearch) +> +> - Delegated scenarios are supported in Exchange Online. The recommended method for connecting with delegation is using GDAP and App Consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). You can also use multi-tenant applications when CSP relationships are not created with the customer. The required steps for using multi-tenant applications are called out within the regular instructions in this article. +> +> - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet if you get the following error when using the Windows PowerShell SDK to connect: `The term 'Update-ModuleManifest' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.` + +## How does it work? + +The Exchange Online PowerShell module uses the Active Directory Authentication Library to fetch an app-only token using the application ID, tenant ID (organization), and certificate thumbprint. The application object provisioned inside Microsoft Entra ID has a Directory Role assigned to it, which is returned in the access token. The session's role based access control (RBAC) is configured using the directory role information that's available in the token. + +## Connection examples + +The following examples show how to use the Exchange Online PowerShell module with app-only authentication: + +> [!IMPORTANT] +> In the following connection commands, use the primary `.onmicrosoft.com` domain for your organization as the value of the _Organization_ parameter. +> +> The following connection commands have many of the same options available as described in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For example: +> +> - Microsoft 365 GCC High or Microsoft 365 DoD environments require the following additional parameters and values: +> - **Connect-ExchangeOnline in GCC High**: `-ExchangeEnvironmentName O365USGovGCCHigh`. +> - **Connect-IPPSSession in GCC High**: `-ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common`. +> - **Connect-ExchangeOnline in DoD**: `-ExchangeEnvironmentName O365USGovDoD`. +> - **Connect-IPPSSession in DoD**: `-ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common`. +> +> - If a **Connect-IPPSSession** command presents a login prompt, run the command: `$Global:IsWindows = $true` before the **Connect-IPPSSession** command. + +- **Connect using a certificate thumbprint**: + + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. + + The certificate needs to be installed on the computer where you're running the command. The certificate should be installed in the user certificate store. + + - Exchange Online PowerShell: + + ```powershell + Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` + + - Security & Compliance PowerShell: + + ```powershell + Connect-IPPSSession -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` + +- **Connect using a certificate object**: + + The certificate doesn't need to be installed on the computer where you're running the command. You can store the certificate object remotely. The certificate is fetched when the script is run. + + - Exchange Online PowerShell: + + ```powershell + Connect-ExchangeOnline -Certificate <%X509Certificate2 Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` + + - Security & Compliance PowerShell: + + ```powershell + Connect-IPPSSession -Certificate <%X509Certificate2 Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` + +- **Connect using a local certificate**: + + > [!NOTE] + > Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + + - Exchange Online PowerShell: + + ```powershell + Connect-ExchangeOnline -CertificateFilePath "C:\Users\navin\Desktop\automation-cert.pfx" -CertificatePassword (Get-Credential).password -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` + + - Security & Compliance PowerShell: + + ```powershell + Connect-IPPSSession -CertificateFilePath "C:\Users\navin\Desktop\automation-cert.pfx" -CertificatePassword (Get-Credential).password -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` + +## Set up app-only authentication + +An initial onboarding is required for authentication using application objects. Application and service principal are used interchangeably, but an application is like a class object while a service principal is like an instance of the class. For more information, see [Application and service principal objects in Microsoft Entra ID](/entra/identity-platform/app-objects-and-service-principals). + +For a detailed visual flow about creating applications in Microsoft Entra ID, see . + +1. [Register the application in Microsoft Entra ID](#step-1-register-the-application-in-microsoft-entra-id). + +2. [Assign API permissions to the application](#step-2-assign-api-permissions-to-the-application). + + An application object has the **Delegated** API permission **Microsoft Graph** \> **User.Read** by default. For the application object to access resources in Exchange, it needs the **Application** API permission **Office 365 Exchange Online** \> **Exchange.ManageAsApp**. + +3. [Generate a self-signed certificate](#step-3-generate-a-self-signed-certificate) + + - For app-only authentication in Microsoft Entra ID, you typically use a certificate to request access. Anyone who has the certificate and its private key can use the app with the permissions granted to the app. + + - Create and configure a self-signed X.509 certificate, which is used to authenticate your Application against Microsoft Entra ID, while requesting the app-only access token. + + - This procedure is similar to generating a password for user accounts. The certificate can be self-signed as well. See [this section](#step-3-generate-a-self-signed-certificate) later in this article for instructions to generate certificates in PowerShell. + + > [!NOTE] + > Cryptography: Next Generation (CNG) certificates aren't supported for app-only authentication with Exchange. CNG certificates are created by default in modern versions of Windows. You must use a certificate from a CSP key provider. [This section](#step-3-generate-a-self-signed-certificate) section covers two supported methods to create a CSP certificate. + +4. [Attach the certificate to the Microsoft Entra application](#step-4-attach-the-certificate-to-the-microsoft-entra-application) + +5. [Assign Microsoft Entra roles to the application](#step-5-assign-microsoft-entra-roles-to-the-application) + + The application needs to have the appropriate RBAC roles assigned. Because the apps are provisioned in Microsoft Entra ID, you can use any of the supported built-in roles. + +### Step 1: Register the application in Microsoft Entra ID + +> [!NOTE] +> If you encounter problems, check the [required permissions](/entra/identity-platform/howto-create-service-principal-portal#permissions-required-for-registering-an-app) to verify that your account can create the identity. + +1. Open the Microsoft Entra admin center at . + +2. In the **Search** box at the top of the page, start typing **App registrations**, and then select **App registrations** from the results in the **Services** section. + + ![Screenshot that shows App registrations in the Search results on the home page of the Azure portal.](media/exo-app-only-auth-find-app-registrations.png) + + Or, to go directly to the **App registrations** page, use . + +3. On the **App registrations** page, select **New registration**. + + ![Select New registration on the App registrations page.](media/exo-app-only-auth-new-app-registration.png) + + On the **Register an application** page that opens, configure the following settings: + + - **Name**: Enter something descriptive. For example, ExO PowerShell CBA. + + - **Supported account types**: Verify that **Accounts in this organizational directory only (\ only - Single tenant)** is selected. + + > [!NOTE] + > To make the application multi-tenant for **Exchange Online** delegated scenarios, select the value **Accounts in any organizational directory (Any Microsoft Entra directory - Multitenant)**. + + - **Redirect URI (optional)**: This setting is optional. If you need to use it, configure the following settings: + - **Platform**: Select **Web**. + - **URI**: Enter the URI where the access token is sent. + + > [!NOTE] + > You can't create credentials for [native applications](/entra/identity/app-proxy/application-proxy-configure-native-client-application), because you can't use native applications for automated applications. + + ![Register an application.](media/exo-app-only-auth-register-app.png) + + When you're finished on the **App registrations** page, select **Register**. + +4. You're taken to the **Overview** page of the app you just registered. Leave this page open. You'll use it in the next step. + +### Step 2: Assign API permissions to the application + +Choose **one** of the following methods in this section to assign API permissions to the app: + +- Select and assign the API permissions from the portal. +- Modify the app manifest to assign API permissions. (Microsoft 365 GCC High and DoD organizations should use this method) + +#### Select and assign the API permissions from the portal + +1. On the app **Overview** page, select **API permissions** from the **Manage** section. + + ![Select API permissions on the application overview page.](media/exo-app-only-auth-select-manifest.png) + +2. On the app **API Permissions** page, select **Add a permission**. + + ![Select Add a permission on the API permissions page of the application.](media/exo-app-only-auth-api-permissions-add-a-permission.png) + +3. In the **Request API permissions** flyout that opens, select the **APIs my organization uses** tab, start typing **Office 365 Exchange Online** in the **Search** box, and then select it from the results. + + ![Find and select Office 365 Exchange Online on the APIs my organization uses tab.](media/exo-app-only-auth-api-permissions-select-o365-exo.png) + +4. On the **What type of permissions does your application require?** flyout that appears, select **Application permissions**. + +5. In the permissions list that appears, expand **Exchange**, select **Exchange.ManageAsApp**, and then select **Add permissions**. + + ![Find and select Exchange.ManageAsApp permissions from the Application permission tab.](media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png) + +6. Back on the app **API permissions** page, verify **Office 365 Exchange Online** \> **Exchange.ManageAsApp** is listed and contains the following values: + - **Type**: **Application**. + - **Admin consent required**: **Yes**. + + - **Status**: The current incorrect value is **Not granted for \**. + + Change this value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. + + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) + + The **Status** value is now **Granted for \**. + + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) + +7. For the default **Microsoft Graph** \> **User.Read** entry, select **...** \> **Revoke admin consent**, and then select **Yes** in the confirmation dialog that opens to return **Status** back to the default blank value. + + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) + +8. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You use the **App registrations** page in an upcoming step. + +#### Modify the app manifest to assign API permissions + +> [!NOTE] +> The procedures in this section _append_ the existing default permissions on the app (delegated **User.Read** permissions in **Microsoft Graph**) with the required application **Exchange.ManageAsApp** permissions in **Office 365 Exchange Online**. + +1. On the app **Overview** page, select **Manifest** from the **Manage** section. + + ![Select Manifest on the application overview page.](media/exo-app-only-auth-select-manifest.png) + +2. On the app **Manifest** page, find the `requiredResourceAccess` entry (on or about line 42), and make the entry look like the following code snippet: + + ```json + "requiredResourceAccess": [ + { + "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", + "resourceAccess": [ + { + "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", + "type": "Role" + } + ] + }, + { + "resourceAppId": "00000003-0000-0000-c000-000000000000", + "resourceAccess": [ + { + "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", + "type": "Scope" + } + ] + } + ], + ``` + + > [!NOTE] + > Microsoft 365 GCC High or DoD environments have access to Security & Compliance PowerShell only. Use the following values for the `requiredResourceAccess` entry: + > + > ```json + > "requiredResourceAccess": [ + > { + > "resourceAppId": "00000007-0000-0ff1-ce00-000000000000", + > "resourceAccess": [ + > { + > "id": "455e5cd2-84e8-4751-8344-5672145dfa17", + > "type": "Role" + > } + > ] + > }, + > { + > "resourceAppId": "00000003-0000-0000-c000-000000000000", + > "resourceAccess": [ + > { + > "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", + > "type": "Scope" + > } + > ] + > } + > ], + > ``` + + When you're finished on the **Manifest** page, select **Save**. + +3. Still on the **Manifest** page, select **API permissions** from the **Manage** section. + + ![Select API permissions from the Manifest page.](media/exo-app-only-auth-manifest-select-api-permissions.png) + +4. On the **API permissions** page, verify **Office 365 Exchange Online** \> **Exchange.ManageAsApp** is listed and contains the following values: + - **Type**: **Application**. + - **Admin consent required**: **Yes**. + + - **Status**: The current incorrect value is **Not granted for \** for the **Office 365 Exchange Online** \> **Exchange.ManageAsApp** entry. + + Change the **Status** value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. + + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) + + The **Status** value is now **Granted for \**. + + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) + +5. For the default **Microsoft Graph** \> **User.Read** entry, select **...** \> **Revoke admin consent**, and then select **Yes** in the confirmation dialog that opens to return **Status** back to the default blank value. + + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) + +6. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You use the **App registrations** page in an upcoming step. + +### Step 3: Generate a self-signed certificate + +Create a self-signed x.509 certificate using one of the following methods: + +- (Recommended) Use the [New-SelfSignedCertificate](/powershell/module/pki/new-selfsignedcertificate), [Export-Certificate](/powershell/module/pki/export-certificate) and [Export-PfxCertificate](/powershell/module/pki/export-pfxcertificate) cmdlets in an elevated (run as administrator) Windows PowerShell session to request a self-signed certificate and export it to `.cer` and `.pfx` (SHA1 by default). For example: + + ```powershell + # Create certificate + $mycert = New-SelfSignedCertificate -DnsName "contoso.org" -CertStoreLocation "cert:\CurrentUser\My" -NotAfter (Get-Date).AddYears(1) -KeySpec KeyExchange + + # Export certificate to .pfx file + $mycert | Export-PfxCertificate -FilePath mycert.pfx -Password (Get-Credential).password + + # Export certificate to .cer file + $mycert | Export-Certificate -FilePath mycert.cer + ``` + +- Use the [Create-SelfSignedCertificate script](https://github.com/SharePoint/PnP-Partner-Pack/blob/master/scripts/Create-SelfSignedCertificate.ps1) script to generate SHA1 certificates. + + ```powershell + .\Create-SelfSignedCertificate.ps1 -CommonName "MyCompanyName" -StartDate 2021-01-06 -EndDate 2022-01-06 + ``` + +### Step 4: Attach the certificate to the Microsoft Entra application + +After you register the certificate with your application, you can use the private key (`.pfx` file) or the thumbprint for authentication. + +1. On the **Owned applications** tab on the **Apps registration** page from the end of [Step 2](#step-2-assign-api-permissions-to-the-application), select your application. + + If you need to get back to **Apps registration** page, use , verify the **Owned applications** tab is selected, and then select your application. + + ![Apps registration page where you select your app.](media/exo-app-only-auth-app-registration-page.png) + +2. On the application page that opens, select **Certificates & secrets** from the **Manage** section. + + ![Select Certificates & Secrets on the application properties page.](media/exo-app-only-auth-select-certificates-and-secrets.png) + +3. On the **Certificates & secrets** page, select **Upload certificate**. + + ![Select Upload certificate on the Certificates & secrets page.](media/exo-app-only-auth-select-upload-certificate.png) + + In the dialog that opens, browse to the self-signed certificate (`.cer` file) that you created in [Step 3](#step-3-generate-a-self-signed-certificate). + + ![Browse to the certificate and then select Add.](media/exo-app-only-auth-upload-certificate-dialog.png) + + When you're finished, select **Add**. + + The certificate is now shown in the **Certificates** section. + + ![Application page showing that the certificate was added.](media/exo-app-only-auth-certificate-successfully-added.png) + +4. Close the current **Certificates & secrets** page, and then the **App registrations** page to return to the main page. You'll use it in the next step. + +### Step 4b: Exchange Online delegated scenarios only: Grant admin consent for the multi-tenant app + +If you made the application multi-tenant for **Exchange Online** delegated scenarios in [Step 1](#step-1-register-the-application-in-microsoft-entra-id), you need to grant admin consent to the Exchange.ManageAsApp permission so the application can run cmdlets in Exchange Online **in each tenant organization**. To do this, generate an admin consent URL for each customer tenant. Before anyone uses the multi-tenant application to connect to Exchange Online in the tenant organization, an admin in the customer tenant should open the following URL: + +`https://login.microsoftonline.com//adminconsent?client_id=&scope=https://outlook.office365.com/.default` + +- `` is the customer's tenant ID. +- `` is the ID of the multi-tenant application. +- The default scope is used to grant application permissions. + +For more information about the URL syntax, see [Request the permissions from a directory admin](/entra/identity-platform/v2-admin-consent#request-the-permissions-from-a-directory-admin). + +### Step 5: Assign Microsoft Entra roles to the application + +You have two options: + +- **Assign Microsoft Entra roles to the application** +- **Assign custom role groups to the application using service principals**: This method is supported only when you connect to Exchange Online PowerShell or Security & Compliance PowerShell in [REST API mode](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). Security & Compliance PowerShell supports REST API mode in v3.2.0 or later. + +> [!NOTE] +> You can also combine both methods to assign permissions. For example, you can use Microsoft Entra roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. +> +> For multi-tenant applications in **Exchange Online** delegated scenarios, you need to assign permissions in each customer tenant. + +#### Assign Microsoft Entra roles to the application + +The supported Microsoft Entra roles are described in the following table: + +|Role|Exchange Online
PowerShell|Security & Compliance
PowerShell| +|---|:---:|:---:| +|[Compliance Administrator](/entra/identity/role-based-access-control/permissions-reference#compliance-administrator)|✔|✔| +|[Exchange Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-administrator)¹|✔|| +|[Exchange Recipient Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-recipient-administrator)|✔|| +|[Global Administrator](/entra/identity/role-based-access-control/permissions-reference#global-administrator)¹ ²|✔|✔| +|[Global Reader](/entra/identity/role-based-access-control/permissions-reference#global-reader)|✔|✔| +|[Helpdesk Administrator](/entra/identity/role-based-access-control/permissions-reference#helpdesk-administrator)|✔|| +|[Security Administrator](/entra/identity/role-based-access-control/permissions-reference#security-administrator)¹|✔|✔| +|[Security Reader](/entra/identity/role-based-access-control/permissions-reference#security-reader)|✔|✔| + +¹ The Global Administrator and Exchange Administrator roles provide the required permissions for any task in Exchange Online PowerShell. For example: + +- Recipient management. +- Security and protection features. For example, anti-spam, anti-malware, anti-phishing, and the associated reports. + +The Security Administrator role does not have the necessary permissions for those same tasks. + +² Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +For general instructions about assigning roles in Microsoft Entra ID, see [Assign Microsoft Entra roles to users](/entra/identity/role-based-access-control/manage-roles-portal). + +> [!NOTE] +> The following steps are slightly different for Exchange Online PowerShell vs. Security & Compliance PowerShell. The steps for both environments are shown. To configure roles for both environments, repeat the steps in this section. + +1. In Microsoft Entra admin center at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Microsoft Entra roles and administrators** from the results in the **Services** section. + + ![Screenshot that shows Microsoft Entra roles and administrators in the Search results on the on the home page of the Azure portal.](media/exo-app-only-auth-find-roles-and-administrators.png) + + Or, to go directly to the **Microsoft Entra roles and administrators** page, use . + +2. On the **Roles and administrators** page that opens, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. + + - **Exchange Online PowerShell**: For example, find and select the **Exchange administrator** role. + + ![Find and select a supported Exchange Online PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role.png) + + - **Security & Compliance PowerShell**: For example, find and select the **Compliance Administrator** role. + + ![Find and select a supported Security & Compliance PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role-scc.png) + +3. On the **Assignments** page that opens, select **Add assignments**. + + - **Exchange Online PowerShell**: + + ![Select Add assignments on the role assignments page for Exchange Online PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments.png) + + - **Security & Compliance PowerShell**: + + ![Select Add assignments on the role assignments page for Security & Compliance PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png) + +4. In the **Add assignments** flyout that opens, find and select the app that you created in [Step 1](#step-1-register-the-application-in-microsoft-entra-id). + + ![Find and select your app on the Add assignments flyout.](media/exo-app-only-auth-find-add-select-app-for-assignment.png) + + When you're finished in the **Add assignments** flyout, select **Add**. + +5. Back on the **Assignments** page, verify that the role has been assigned to the app. + + - **Exchange Online PowerShell**: + + ![The role assignments page after to added the app to the role for Exchange Online PowerShell.](media/exo-app-only-auth-app-assigned-to-role.png) + + - **Security & Compliance PowerShell**: + + ![The role assignments page after to added the app to the role for Security & Compliance PowerShell.](media/exo-app-only-auth-app-assigned-to-role-scc.png) + +#### Assign custom role groups to the application using service principals + +> [!NOTE] +> You need to connect to Exchange Online PowerShell or Security & Compliance PowerShell _before_ completing steps to create a new service principal. Creating a new service principal without connecting to PowerShell won't work (your Azure App ID and Object ID are needed to create the new service principal). +> +> This method is supported only when you connect to Exchange Online PowerShell or Security & Compliance PowerShell in [REST API mode](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). Security & Compliance PowerShell supports REST API mode in v3.2.0 or later. + +For information about creating custom role groups, see [Create role groups in Exchange Online](/exchange/permissions-exo/role-groups#create-role-groups) and [Create Email & collaboration role groups in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions#create-email--collaboration-role-groups-in-the-microsoft-defender-portal). The custom role group that you assign to the application can contain any combination of built-in and custom roles. + +To assign custom role groups to the application using service principals, do the following steps: + +1. In [Microsoft Graph PowerShell](/powershell/microsoftgraph/installation), run the following commands to store the details of the Microsoft Entra application that you registered in [Step 1](#step-1-register-the-application-in-microsoft-entra-id) in a variable: + + ```powershell + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + + $ = Get-MgServicePrincipal -Filter "DisplayName eq ''" + ``` + + For example: + + ```powershell + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + + $AzureADApp = Get-MgServicePrincipal -Filter "DisplayName eq 'ExO PowerShell CBA'" + ``` + + For detailed syntax and parameter information, see [Get-MgServicePrincipal](/powershell/module/microsoft.graph.applications/get-mgserviceprincipal). + +2. In the same PowerShell window, connect to [Exchange Online PowerShell](connect-to-exchange-online-powershell.md) or [Security & Compliance PowerShell](connect-to-scc-powershell.md) and run the following commands to: + - Create a service principal object for the Microsoft Entra application. + - Store the details of the service principal in a variable to use in the next step. + + ```powershell + New-ServicePrincipal -AppId $.AppId -ObjectId $.Id -DisplayName "" + + $ = Get-ServicePrincipal -Identity "" + ``` + + For example: + + ```powershell + New-ServicePrincipal -AppId $AzureADApp.AppId -ObjectId $AzureADApp.Id -DisplayName "SP for Azure AD App ExO PowerShell CBA" + + $SP = Get-ServicePrincipal -Identity "SP for Azure AD App ExO PowerShell CBA" + ``` + + For detailed syntax and parameter information, see [New-ServicePrincipal](/powershell/module/exchange/new-serviceprincipal). + +3. In Exchange Online PowerShell or Security & Compliance PowerShell, run the following command to add the service principal as a member of the custom role group: + + ```powershell + Add-RoleGroupMember -Identity "" -Member <$.Identity | $.ObjectId | $.Id> + ``` + + For example: + + ```powershell + Add-RoleGroupMember -Identity "Contoso View-Only Recipients" -Member $SP.Identity + ``` + + For detailed syntax and parameter information, see [Add-RoleGroupMember](/powershell/module/exchange/add-rolegroupmember). diff --git a/exchange/docs-conceptual/client-advanced-settings.md b/exchange/docs-conceptual/client-advanced-settings.md new file mode 100644 index 0000000000..dc5a85dd20 --- /dev/null +++ b/exchange/docs-conceptual/client-advanced-settings.md @@ -0,0 +1,436 @@ +--- +title: PowerShell advanced settings for Microsoft Purview Information Protection client +ms.author: yangczhang +author: zhang-yangchen +manager: aashishr +ms.date: 04/17/2024 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: purview +ms.reviewer: +ms.localizationpriority: high +ms.collection: +- tier3 +- purview-compliance +search.appverid: +description: "Security & Compliance PowerShell advanced settings for Microsoft Purview Information Protection client." +--- + +# Advanced settings for Microsoft Purview Information Protection client + +This article contains the [Security & Compliance PowerShell](/powershell/exchange/office-365-scc/office-365-scc-powershell) advanced settings that are supported by [Microsoft Purview Information Protection client](/purview/information-protection-client) when you use the following cmdlets: + +- [New-Label](/powershell/module/exchange/new-label) or [Set-Label](/powershell/module/exchange/set-label) +- [New-LabelPolicy](/powershell/module/exchange/new-labelpolicy) or [Set-LabelPolicy](/powershell/module/exchange/set-labelpolicy) + +The advanced settings that are supported by sensitivity labels built into Microsoft 365 apps and services are included on the cmdlet page itself. You might also find useful [PowerShell tips for specifying the advanced settings](/purview/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings). + +|Advanced settings for labels|Description| +|---|---| +|[Color](#color)|Specify a color for the label| +|[DefaultSubLabelId](#defaultsublabelid)|Specify a default sublabel for a parent label| + +|Advanced settings for label policies|Description| +|---|---| +|[AdditionalPPrefixExtensions](#additionalpprefixextensions)|Support for changing \.PFILE to P\| +|[EnableAudit](#enableaudit)|Prevent audit data from being sent to Microsoft Purview| +|[EnableContainerSupport](#enablecontainersupport)|Enable removal of encryption from PST, rar, 7zip, and MSG files| +|[EnableCustomPermissions](#enablecustompermissions)|Turn off custom permissions in File Explorer| +|[EnableCustomPermissionsForCustomProtectedFiles](#enablecustompermissionsforcustomprotectedfiles)|For files encrypted with custom permissions, always display custom permissions to users in File Explorer| +|[EnableGlobalization](#enableglobalization) |Turn on classification globalization features| +|[JustificationTextForUserText](#justificationtextforusertext) |Customize justification prompt texts for modified labels| +|[LogMatchedContent](#logmatchedcontent)|Send information type matches to Microsoft Purview| +|[OfficeContentExtractionTimeout](#officecontentextractiontimeout)|Configure the auto-labeling timeout for Office files| +|[PFileSupportedExtensions](#pfilesupportedextensions)|Change which file types to protect| +|[ReportAnIssueLink](#reportanissuelink) |Add "Report an Issue" for users| +|[ScannerMaxCPU](#scannermaxcpu) |Limit CPU consumption| +|[ScannerMinCPU](#scannermincpu) |Limit CPU consumption| +|[ScannerConcurrencyLevel](#scannerconcurrencylevel)|Limit the number of threads used by the scanner| +|[ScannerFSAttributesToSkip](#scannerfsattributestoskip) |Skip or ignore files during scans depending on file attributes) +|[SharepointWebRequestTimeout](#sharepointwebrequesttimeout)|Configure SharePoint timeouts| +|[SharepointFileWebRequestTimeout](#sharepointfilewebrequesttimeout )|Configure SharePoint timeouts| +|[UseCopyAndPreserveNTFSOwner](#usecopyandpreserventfsowner) |Preserve NTFS owners during labeling| + +## AdditionalPPrefixExtensions + +This advanced property to change \.PFILE to P\ is supported by File Explorer, PowerShell, and by the scanner. All apps have similar behavior. + +- Key: **AdditionalPPrefixExtensions** + +- Value: **\** + +Use the following table to identify the string value to specify: + +| String value| Client and scanner| +|---|---| +|\*|All PFile extensions become P\| +|\| Default value behaves like the default encryption value.| +|ConvertTo-Json(".dwg", ".zip")|In addition to the previous list, ".dwg" and ".zip" become P\| + +With this setting, the following extensions always become **P\**: ".txt", ".xml", ".bmp", ".jt", ".jpg", ".jpeg", ".jpe", ".jif", ".jfif", ".jfi", ".png", ".tif", ".tiff", ".gif"). Notable exclusion is that "ptxt" does not become "txt.pfile". + +This setting requires the advanced setting *PFileSupportedExtension* to be enabled. + +**Example 1**: PowerShell command to behave like the default behavior where Protect ".dwg" becomes ".dwg.pfile": + +```PowerShell +Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions =""} +``` + +**Example 2**: PowerShell command to change all PFile extensions from generic encryption to native encryption when the files are labeled and encrypted: + +```PowerShell +Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions ="*"} +``` + +**Example 3**: PowerShell command to change ".dwg" to ".pdwg" when using this service protect this file: + +```PowerShell +Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions =ConvertTo-Json(".dwg")} +``` + +## Color + +Use this advanced setting to set a color for a label. To specify the color, enter a hex triplet code for the red, green, and blue (RGB) components of the color. For example, #40e0d0 is the RGB hex value for turquoise. + +If you need a reference for these codes, you'll find a helpful table from the [\](https://developer.mozilla.org/docs/Web/CSS/color_value) page from the MSDN web docs. You also find these codes in many applications that let you edit pictures. For example, Microsoft Paint lets you choose a custom color from a palette and the RGB values are automatically displayed, which you can then copy. + +To configure the advanced setting for a label's color, enter the following strings for the selected label: + +- Key: **color** + +- Value: **\** + +Example PowerShell command, where your label is named "Public": + +```PowerShell +Set-Label -Identity Public -AdvancedSettings @{color="#40e0d0"} +``` + +## DefaultSubLabelId + +When you add a sublabel to a label, users can no longer apply the parent label to a document or email. By default, users select the parent label to see the sublabels that they can apply, and then select one of those sublabels. If you configure this advanced setting, when users select the parent label, a sublabel is automatically selected and applied for them: + +- Key: **DefaultSubLabelId** + +- Value: **\** + +Example PowerShell command, where your parent label is named "Confidential" and the "All Employees" sublabel has a GUID of 8faca7b8-8d20-48a3-8ea2-0f96310a848e: + +```PowerShell +Set-Label -Identity "Confidential" -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"} +``` + +## EnableAudit + +By default, the information protection client sends audit data to Microsoft Purview where you can view this data in [activity explorer](/purview/data-classification-activity-explorer). + +To change this behavior, use the following advanced setting: + +- Key: **EnableAudit** + +- Value: **False** + +For example, if your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"} +``` + +Then on local computers that run the information protection client, delete the following folder: **%localappdata%\Microsoft\MSIP\mip** + +To enable the client to send audit log data again, change the advanced setting value to **True**. You do not need to manually create the **%localappdata%\Microsoft\MSIP\mip** folder again on your client computers. + +## EnableContainerSupport + +This setting enables the information protection client to remove encryption from PST, rar, and 7zip files. + +- Key: **EnableContainerSupport** + +- Value: **True** + +For example, if your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableContainerSupport="True"} +``` + +## EnableCustomPermissions + +By default, users see an option named **Protect with custom permissions** when they right-click in File Explorer with the file labeler. This option lets them set their own encryption settings that can override any encryption settings that you might have included with a label configuration. Users can also see an option to remove encryption. When you configure this setting, users do not see these options. + +Use the following setting so users don't see these options: + +- Key: **EnableCustomPermissions** + +- Value: **False** + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableCustomPermissions="False"} +``` + +## EnableCustomPermissionsForCustomProtectedFiles + +When you configure the advanced client setting *EnableCustomPermissions* to turn off custom permissions in File Explorer, by default, users are not able to see or change custom permissions that are already set in an encrypted document. + +However, there's another advanced client setting that you can specify so that in this scenario, users can see and change custom permissions for an encrypted document when they use File Explorer and right-click the file. + +- Key: **EnableCustomPermissionsForCustomProtectedFiles** + +- Value: **True** + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableCustomPermissionsForCustomProtectedFiles="True"} +``` + +## EnableGlobalization + +Classification globalization features including increased accuracy for East Asian languages and support for double-byte characters. These enhancements are provided only for 64-bit processes, and are turned off by default. + +Turn on these features for your policy specify the following strings: + +- Key: **EnableGlobalization** + +- Value: `True` + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableGlobalization="True"} +``` + +To turn off support again and revert to the default, set the **EnableGlobalization** advanced setting to an empty string. + +## JustificationTextForUserText + +Customize the justification prompts that are displayed when end users change sensitivity labels on files. + +For example, as an administrator, you might want to remind your users not to add any customer identifying information into this field. + +To modify the default **Other** option that users can select in the dialog box, use the *JustificationTextForUserText* advanced setting. Set the value to the text you want to use instead. + +Example PowerShell command, where your label policy is named "Global": + +``` PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{JustificationTextForUserText="Other (please explain) - Do not enter sensitive info"} +``` + +## LogMatchedContent + +By default, the information protection client doesn't send content matches for sensitive info types to Microsoft Purview, which can then be displayed in [activity explorer](/purview/data-classification-activity-explorer). The scanner always sends this information. For more information about this additional information that can be sent, see [Content matches for deeper analysis](/azure/information-protection/reports-aip#content-matches-for-deeper-analysis). + +To send content matches when sensitive information types are sent, use the following advanced setting in a label policy: + +- Key: **LogMatchedContent** + +- Value: **True** + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{LogMatchedContent="True"} +``` + +## OfficeContentExtractionTimeout + +By default, the scanner's auto-labeling timeout on Office files is 3 seconds. + +If you have a complex Excel file with many sheets or rows, 3 seconds might not be enough to automatically apply labels. To increase this timeout for the selected label policy, specify the following strings: + +- Key: **OfficeContentExtractionTimeout** + +- Value: Seconds, in the following format: `hh:mm:ss`. + +> [!IMPORTANT] +> We recommend that you don't raise this timeout to higher than 15 seconds. + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{OfficeContentExtractionTimeout="00:00:15"} +``` + +The updated timeout applies to auto-labeling on all Office files. + +## PFileSupportedExtensions + +With this setting, you can change which file types are encrypted but you cannot change the default encryption level from native to generic. For example, for users running the file labeler, you can change the default setting so that only Office files and PDF files are encrypted instead of all file types. But you cannot change these file types to be generically encrypted with a .pfile file name extension. + +- Key: **PFileSupportedExtensions** + +- Value: **\** + +Use the following table to identify the string value to specify: + +| String value|Client|Scanner| +|---|---|---| +|\*|Default value: Apply encryption to all file types|Apply encryption to all file types| +|ConvertTo-Json(".jpg", ".png")|In addition to Office file types and PDF files, apply encryption to the specified file name extensions | In addition to Office file types and PDF files, apply encryption to the specified file name extensions + +**Example 1**: PowerShell command for the scanner to encrypt all file types, where your label policy is named "Scanner": + +```PowerShell +Set-LabelPolicy -Identity Scanner -AdvancedSettings @{PFileSupportedExtensions="*"} +``` + +**Example 2**: PowerShell command for the scanner to encrypt .txt files and .csv files in addition to Office files and PDF files, where your label policy is named "Scanner": + +```PowerShell +Set-LabelPolicy -Identity Scanner -AdvancedSettings @{PFileSupportedExtensions=ConvertTo-Json(".txt", ".csv")} +``` + +## ReportAnIssueLink + +When you specify the following advanced client setting, users see a **Report an Issue** option that they can select from the **Help and Feedback** client dialog box in the file labeler. Specify an HTTP string for the link. For example, a customized web page that you have for users to report issues, or an email address that goes to your help desk. + +To configure this advanced setting, enter the following strings for the selected label policy: + +- Key: **ReportAnIssueLink** + +- Value: **\** + +Example value for a website: `https://support.contoso.com` + +Example value for an email address: `mailto:helpdesk@contoso.com` + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{ReportAnIssueLink="mailto:helpdesk@contoso.com"} +``` + +## ScannerMaxCPU + +> [!IMPORTANT] +> We recommend limiting CPU consumption by using the advanced settings *ScannerMaxCPU* and *ScannerMinCPU* instead of *ScannerConcurrencyLevel* that's supported for backwards compatibility. +> +> If the older advanced setting is specified,*ScannerMaxCPU* and *ScannerMinCPU* advanced settings are ignored. + +Use this advanced setting in conjunction with *ScannerMinCPU* to limit CPU consumption on the scanner computer. + +- Key: **ScannerMaxCPU** + +- Value: \** + +The value is set to **100** by default, which means there is no limit of maximum CPU consumption. In this case, the scanner process will try to use all available CPU time to maximize your scan rates. + +If you set **ScannerMaxCPU** to less than 100, the scanner will monitor the CPU consumption over the last 30 minutes. If the average CPU crossed the limit you set, it will start to reduce the number of threads allocated for new files. + +The limit on the number of threads will continue as long as CPU consumption is higher than the limit set for **ScannerMaxCPU**. + +## ScannerMinCPU + +> [!IMPORTANT] +> We recommend limiting CPU consumption by using the advanced settings *ScannerMaxCPU* and *ScannerMinCPU* instead of *ScannerConcurrencyLevel* that's supported for backwards compatibility. +> +> If the older advanced setting is specified,*ScannerMaxCPU* and *ScannerMinCPU* advanced settings are ignored. + +Used only if *ScannerMaxCPU* is not equal to 100, and cannot be set to a number that is higher than the **ScannerMaxCPU** value. + +We recommend keeping **ScannerMinCPU** set at least 15 points lower than the value of *ScannerMaxCPU*. + +The value is set to **50** by default, which means that if CPU consumption in the last 30 minutes when lower than this value, the scanner will start adding new threads to scan more files in parallel, until the CPU consumption reaches the level you have set for *ScannerMaxCPU*-15. + +## ScannerConcurrencyLevel + +> [!IMPORTANT] +> We recommend limiting CPU consumption by using the advanced settings *ScannerMaxCPU* and *ScannerMinCPU* instead of *ScannerConcurrencyLevel* that's supported for backwards compatibility. +> +> When this older advanced setting is specified,*ScannerMaxCPU* and *ScannerMinCPU* advanced settings are ignored. + +By default, the scanner uses all available processor resources on the computer running the scanner service. If you need to limit the CPU consumption while this service is scanning, specify the number of concurrent threads that the scanner can run in parallel. The scanner uses a separate thread for each file that it scans, so this throttling configuration also defines the number of files that can be scanned in parallel. + +When you first configure the value for testing, we recommend you specify 2 per core, and then monitor the results. For example, if you run the scanner on a computer that has 4 cores, first set the value to 8. If necessary, increase or decrease that number, according to the resulting performance you require for the scanner computer and your scanning rates. + +- Key: **ScannerConcurrencyLevel** + +- Value: **\** + +Example PowerShell command, where your label policy is named "Scanner": + +```PowerShell +Set-LabelPolicy -Identity Scanner -AdvancedSettings @{ScannerConcurrencyLevel="8"} +``` + +## ScannerFSAttributesToSkip + +By default, the information protection scanner scans all relevant files. However, you might want to define specific files to be skipped, such as for archived files or files that have been moved. + +Enable the scanner to skip specific files based on their file attributes by using the **ScannerFSAttributesToSkip** advanced setting. In the setting value, list the file attributes that will enable the file to be skipped when they are all set to **true**. This list of file attributes uses the AND logic. + +Example PowerShell commands, where your label policy is named "Global". + +**Skip files that are both read-only and archived** + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{ ScannerFSAttributesToSkip =" FILE_ATTRIBUTE_READONLY, FILE_ATTRIBUTE_ARCHIVE"} +``` + +**Skip files that are either read-only or archived** + +To use an OR logic, run the same property multiple times. For example: + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{ ScannerFSAttributesToSkip =" FILE_ATTRIBUTE_READONLY"} +Set-LabelPolicy -Identity Global -AdvancedSettings @{ ScannerFSAttributesToSkip =" FILE_ATTRIBUTE_ARCHIVE"} +``` + +> [!TIP] +> We recommend that you consider enabling the scanner to skip files with the following attributes: +> +> - FILE_ATTRIBUTE_SYSTEM +> - FILE_ATTRIBUTE_HIDDEN +> - FILE_ATTRIBUTE_DEVICE +> - FILE_ATTRIBUTE_OFFLINE +> - FILE_ATTRIBUTE_RECALL_ON_DATA_ACCESS +> - FILE_ATTRIBUTE_RECALL_ON_OPEN +> - FILE_ATTRIBUTE_TEMPORARY + +For a list of all file attributes that can be defined in the **ScannerFSAttributesToSkip** advanced setting, see the [Win32 File Attribute Constants](/windows/win32/fileio/file-attribute-constants) + +## SharepointWebRequestTimeout + +By default, the timeout for SharePoint interactions is two minutes, after which the attempted information protection client operation fails. Control this timeout using the *SharepointWebRequestTimeout* and *SharepointFileWebRequestTimeout* advanced settings, using an **hh:mm:ss** syntax to define the timeouts. + +Specify a value to determine the timeout for all information protection client web requests to SharePoint. The default is minutes. + +For example, if your policy is named **Global**, the following sample PowerShell command updates the web request timeout to 5 minutes. + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{SharepointWebRequestTimeout="00:05:00"} +``` + +## SharepointFileWebRequestTimeout + +By default, the timeout for SharePoint interactions is two minutes, after which the attempted information protection client operation fails. Control this timeout using the *SharepointWebRequestTimeout* and *SharepointFileWebRequestTimeout* advanced settings, using an **hh:mm:ss** syntax to define the timeouts. + +Specify the timeout value for SharePoint files via information protection client web requests. The default is 15 minutes. + +For example, if your policy is named **Global**, the following sample PowerShell command updates the file web request timeout to 10 minutes. + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{SharepointFileWebRequestTimeout="00:10:00"} +``` + +## UseCopyAndPreserveNTFSOwner + +> [!NOTE] +> This feature is currently in PREVIEW. The [Azure Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. + +By default, the information protection client doesn't preserve the NTFS owner that was defined before applying a sensitivity label. + +To ensure that the NTFS owner value is preserved, set the *UseCopyAndPreserveNTFSOwner* advanced setting to **true** for the selected label policy. + +> [!CAUTION] +> For the scanner: Define this advanced setting only when you can ensure a low-latency, reliable network connection between the scanner and the scanned repository. A network failure during the automatic labeling process can cause the file to be lost. + +Example PowerShell command, where your label policy is named "Global" + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{UseCopyAndPreserveNTFSOwner ="true"} +``` diff --git a/exchange/docs-conceptual/cmdlet-property-sets.md b/exchange/docs-conceptual/cmdlet-property-sets.md new file mode 100644 index 0000000000..bbd2cf89d9 --- /dev/null +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -0,0 +1,125 @@ +--- +title: Property sets in Exchange Online PowerShell module cmdlets +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/1/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: "Admins can lear about the property sets that are available in the nine exclusive Get-EXO cmdlets in the Exchange Online PowerShell V2 module and V3 module." +--- + +# Property sets in Exchange Online PowerShell module cmdlets + +This article describes the property sets that are available in the nine exclusive **Get-EXO\*** [cmdlets in the Exchange Online PowerShell module](exchange-online-powershell-v2.md#cmdlets-in-the-exchange-online-powershell-module). For more information about property sets, see [Properties and property sets in the Exchange Online PowerShell module](exchange-online-powershell-v2.md#properties-and-property-sets-in-the-exchange-online-powershell-module). + +For more information about filtering with cmdlets in the module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). + + > [!TIP] + > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). + +## Get-EXOCasMailbox property sets + +The available property sets for the **Get-EXOCasMailbox** cmdlet and the properties they contain are described in the following table: + +|PropertySet|Properties| +|---|---| +|**Minimum**|ActiveSyncEnabled
DisplayName
ECPEnabled
EmailAddresses
EwsEnabled
ExchangeVersion
Guid
Identity
ImapEnabled
MAPIEnabled
Name
OWAEnabled
OrganizationId
PopEnabled
PrimarySmtpAddress
ServerLegacyDN| +|**ActiveSync**|ActiveSyncAllowedDeviceIDs
ActiveSyncBlockedDeviceIDs
ActiveSyncEnabled
ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
ActiveSyncSuppressReadReceipt
ExternalDirectoryObjectId
Guid
HasActiveSyncDevicePartnership
Identity
Name
OrganizationId| +|**Ews**|EwsAllowMacOutlook
EwsAllowOutlook
EwsEnabled
ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId| +|**Imap**|ExternalDirectoryObjectId
Guid
Identity
ImapEnableExactRFC822Size
ImapEnabled
ImapForceICalForCalendarRetrievalOption
ImapMessagesRetrievalMimeFormat
ImapSuppressReadReceipt
ImapUseProtocolDefaults
Name
OrganizationId| +|**Mapi**|ExternalDirectoryObjectId
Guid
Identity
MAPIBlockOutlookExternalConnectivity
MAPIBlockOutlookNonCachedMode
MAPIBlockOutlookRpcHttp
MAPIBlockOutlookVersions
MAPIEnabled
MapiHttpEnabled
Name
OrganizationId| +|**Pop**|ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId
PopEnableExactRFC822Size
PopEnabled
PopMessagesRetrievalMimeFormat
PopSuppressReadReceipt
PopUseProtocolDefaults| +|**ProtocolSettings**|ExternalDirectoryObjectId
ExternalImapSettings
ExternalPopSettings
ExternalSmtpSettings
Guid
Identity
InternalImapSettings
InternalPopSettings
InternalSmtpSettings
Name
OrganizationId| + +**Note**: The following **Get-CasMailbox** parameters aren't available on **Get-EXOCasMailbox**: + +- *ActiveSyncDebugLogging* +- *IgnoreDefaultScope* +- *ReadIsOptimizedForAccessibility* +- *SortBy* + +For more information, see: + +- [Get-EXOCASMailbox](/powershell/module/exchange/get-exocasmailbox) +- [Get-CASMailbox](/powershell/module/exchange/get-casmailbox) + +## Get-EXOMailbox property sets + +The available property sets for the **Get-EXOMailbox** cmdlet and the properties they contain are described in the following table: + +|PropertySet|Properties| +|---|---| +|**Minimum**|Alias
DisplayName
DistinguishedName
EmailAddresses
ExchangeVersion
ExternalDirectoryObjectId
Guid
Id
Name
OrganizationId
PrimarySmtpAddress
RecipientType
RecipientTypeDetails
UserPrincipalName| +|**AddressList**|AddressBookPolicy
AddressListMembership
ExternalDirectoryObjectId
GeneratedOfflineAddressBooks
HiddenFromAddressListsEnabled
OfflineAddressBook| +|**Archive**|ArchiveDatabase
ArchiveDomain
ArchiveGuid
ArchiveName
ArchiveQuota
ArchiveRelease
ArchiveState
ArchiveStatus
ArchiveWarningQuota
AutoExpandingArchiveEnabled
DisabledArchiveDatabase
DisabledArchiveGuid
ExternalDirectoryObjectId
JournalArchiveAddress| +|**Audit**|AuditAdmin
AuditDelegate
AuditEnabled
AuditLogAgeLimit
AuditOwner
DefaultAuditSet
ExternalDirectoryObjectId| +|**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5
ExternalDirectoryObjectId| +|**Delivery**|AcceptMessagesOnlyFrom
AcceptMessagesOnlyFromDLMembers
AcceptMessagesOnlyFromSendersOrMembers
DeliverToMailboxAndForward
DowngradeHighPriorityMessagesEnabled
ExternalDirectoryObjectId
ForwardingAddress
ForwardingSmtpAddress
GrantSendOnBehalfTo
MaxBlockedSenders
MaxReceiveSize
MaxSafeSenders
MaxSendSize
MessageCopyForSendOnBehalfEnabled
MessageCopyForSentAsEnabled
MessageRecallProcessingEnabled
MessageTrackingReadStatusEnabled
RecipientLimits
RejectMessagesFrom
RejectMessagesFromDLMembers
RejectMessagesFromSendersOrMembers
RulesQuota| +|**Hold**|ComplianceTagHoldApplied
DelayHoldApplied
ExternalDirectoryObjectId
InPlaceHolds
InactiveMailboxRetireTime
LitigationHoldDate
LitigationHoldDuration
LitigationHoldEnabled
LitigationHoldOwner| +|**Moderation**|BypassModerationFromSendersOrMembers
ExternalDirectoryObjectId
ModeratedBy
ModerationEnabled
SendModerationNotifications| +|**Move**|ExternalDirectoryObjectId
MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| +|**Policy**|AddressBookPolicy
DataEncryptionPolicy
EmailAddressPolicyEnabled
ExternalDirectoryObjectId
ManagedFolderMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RemoteAccountPolicy
RetentionPolicy
RetentionUrl
RoleAssignmentPolicy
SharingPolicy
ThrottlingPolicy| +|**PublicFolder**|DefaultPublicFolderMailbox
EffectivePublicFolderMailbox
ExternalDirectoryObjectId
IsExcludedFromServingHierarchy
IsHierarchyReady
IsHierarchySyncEnabled
IsRootPublicFolderMailbox| +|**Quota**|ArchiveQuota
ArchiveWarningQuota
CalendarLoggingQuota
ExternalDirectoryObjectId
IssueWarningQuota
ProhibitSendQuota
ProhibitSendReceiveQuota
RecoverableItemsQuota
RecoverableItemsWarningQuota
RulesQuota
UseDatabaseQuotaDefaults| +|**Resource**|ExternalDirectoryObjectId
IsResource
ResourceCapacity
ResourceCustom
ResourceType
RoomMailboxAccountEnabled| +|**Retention**|EndDateForRetentionHold
ExternalDirectoryObjectId
OrphanSoftDeleteTrackingTime
RetainDeletedItemsFor
RetainDeletedItemsUntilBackup
RetentionComment
RetentionHoldEnabled
RetentionPolicy
RetentionUrl
SingleItemRecoveryEnabled
StartDateForRetentionHold
UseDatabaseRetentionDefaults| +|**SCL**|AntispamBypassEnabled
ExternalDirectoryObjectId
SCLDeleteEnabled
SCLDeleteThreshold
SCLJunkEnabled
SCLJunkThreshold
SCLQuarantineEnabled
SCLQuarantineThreshold
SCLRejectEnabled
SCLRejectThreshold| +|**SoftDelete**|ExternalDirectoryObjectId
IncludeInGarbageCollection
IsInactiveMailbox
IsSoftDeletedByDisable
IsSoftDeletedByRemove
WhenSoftDeleted| +|**StatisticsSeed**|ArchiveDatabaseGuid
DatabaseGuid
ExchangeGuid
ExternalDirectoryObjectId| + +**Note**: The following **Get-Mailbox** parameters aren't available on **Get-EXOMailbox**: + +- *Async* +- *GroupMailbox* +- *Migration* +- *PublicFolder* +- *SortBy* + +For more information, see: + +- [Get-EXOMailbox](/powershell/module/exchange/get-exomailbox) +- [Get-Mailbox](/powershell/module/exchange/get-mailbox) + +## Get-EXOMailboxStatistics property sets + +The available property sets for the **Get-EXOMailboxStatistics** cmdlet and the properties they contain are described in the following table: + +|PropertySet|Properties| +|---|---| +|**Minimum**|DeletedItemCount
DisplayName
ItemCount
MailboxGuid
TotalDeletedItemSize
TotalItemSize| +|**All**|AssociatedItemCount
AttachmentTableAvailableSize
AttachmentTableTotalSize
DatabaseIssueWarningQuota
DatabaseName
DatabaseProhibitSendQuota
DatabaseProhibitSendReceiveQuota
DeletedItemCount
DisconnectDate
DisconnectReason
DisplayName
DumpsterMessagesPerFolderCountReceiveQuota
DumpsterMessagesPerFolderCountWarningQuota
ExternalDirectoryOrganizationId
FastIsEnabled
FolderHierarchyChildrenCountReceiveQuota
FolderHierarchyChildrenCountWarningQuota
FolderHierarchyDepthReceiveQuota
FolderHierarchyDepthWarningQuota
FoldersCountReceiveQuota
FoldersCountWarningQuota
IsAbandonedMoveDestination
IsArchiveMailbox
IsDatabaseCopyActive
IsHighDensityShard
IsMoveDestination
IsQuarantined
ItemCount
LastLoggedOnUserAccount
LastLogoffTime
LastLogonTime
LegacyDN
MailboxGuid
MailboxMessagesPerFolderCountReceiveQuota
MailboxMessagesPerFolderCountWarningQuota
MailboxType
MailboxTypeDetail
MessageTableAvailableSize
MessageTableTotalSize
NamedPropertiesCountQuota
NeedsToMove
OtherTablesAvailableSize
OtherTablesTotalSize
OwnerADGuid
QuarantineClients
QuarantineDescription
QuarantineEnd
QuarantineFileVersion
QuarantineLastCrash
ResourceUsageRollingAvgDatabaseReads
ResourceUsageRollingAvgRop
ResourceUsageRollingClientTypes
ServerName
StorageLimitStatus
SystemMessageCount
SystemMessageSize
SystemMessageSizeShutoffQuota
SystemMessageSizeWarningQuota
TotalDeletedItemSize
TotalItemSize| + +For more information, see: + +- [Get-EXOMailboxStatistics](/powershell/module/exchange/get-exomailboxstatistics) +- [Get-MailboxStatistics](/powershell/module/exchange/get-mailboxstatistics) + +## Get-EXORecipient property sets + +The available property sets for the **Get-EXORecipient** cmdlet and the properties they contain are described in the following table: + +|PropertySet|Properties| +|---|---| +|**Minimum**|ExchangeVersion
ExternalDirectoryObjectID
Name
OrganizationId
RecipientType
RecipientTypeDetails| +|**Archive**|ArchiveDatabase
ArchiveGuid
ArchiveRelease
ArchiveState
ArchiveStatus| +|**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5| +|**MailboxMove**|MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| +|**Policy**|ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
AddressBookPolicy
EmailAddressPolicyEnabled
ManagedFolderMailboxPolicy
OwaMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RetentionPolicy
SharingPolicy
ShouldUseDefaultRetentionPolicy
UMMailboxPolicy| + +**Note**: The following **Get-Recipient** parameters aren't available on **Get-EXORecipient**: + +- *SortBy* + +For more information, see: + +- [Get-EXORecipient](/powershell/module/exchange/get-exorecipient) +- [Get-Recipient](/powershell/module/exchange/get-recipient) diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md new file mode 100644 index 0000000000..2f484fd336 --- /dev/null +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -0,0 +1,595 @@ +--- +title: Use Azure managed identities to connect to Exchange Online PowerShell +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 8/24/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about using the Exchange Online PowerShell V3 module and Azure managed identity to connect to Exchange Online PowerShell." +--- + +# Use Azure managed identities to connect to Exchange Online PowerShell + +Using the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module), you can connect to Exchange Online PowerShell using a user-assigned or system assigned Azure managed identity. For more information about managed identities, see [What are managed identities for Azure resources?](/entra/identity/managed-identities-azure-resources/overview). + +Unlike other connection methods using the Exchange Online PowerShell module, you can't run the connection commands in a Windows PowerShell session on your local computer. Instead, you connect in the context of the Azure resource that's associated with the managed identity (for example, an Azure automation account or an Azure Virtual Machine). + +The rest of this article explains how to connect using managed identity, and the requirements for creating and configuring the proper resources with managed identities in Azure. + +> [!NOTE] +> In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> +> - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) +> - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) +> - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) +> - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) +> +> You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). +> +> REST API connections in the V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +## Connect to Exchange Online PowerShell using system-assigned managed identity + +After you've [Created and configured a system-assigned managed identity](#create-and-configure-a-system-assigned-managed-identity), use the following syntax to connect to Exchange Online PowerShell: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization .onmicrosoft.com +``` + +For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com +``` + +The rest of this section explains how to connect using supported Azure resources. For example: + +- A PowerShell runbook on the Azure Automation account with system-assigned managed identity. +- An Azure VM with a system-assigned managed identity. + +After the resource is connected, the Exchange Online PowerShell cmdlets and parameters are available based on the RBAC role you assigned in [Step 5: Assign Microsoft Entra roles to the managed identity](#step-5-assign-microsoft-entra-roles-to-the-managed-identity) + +### Connect to Exchange Online PowerShell using Azure Automation accounts with system-assigned managed identity + +Create a PowerShell runbook on the automation account. For instructions, see [Manage runbooks in Azure Automation](/azure/automation/manage-runbooks). + +The first command in the PowerShell runbook must be the `Connect-ExchangeOnline...` command as described in the beginning of this section. For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com +``` + +After that, as a test, you can start with as simple, low-impact command in the runbook before moving on to more complex commands or scripts. For example: + +```powershell +Get-AcceptedDomain | Format-Table Name +``` + +After you've successfully created, saved, and published the PowerShell runbook, do the following steps to run it in the future: + +1. On the **Automation accounts** page at , select the Automation account. +2. In the details flyout that opens, start typing "Runbooks" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Runbooks** from results. +3. On the **Runbooks** flyout that opens, select the runbook. +4. On the details page of the runbook, select **Start**. + +### Connect to Exchange Online PowerShell using Azure VMs with system-assigned managed identity + +In a Windows PowerShell window in the Azure VM, use the command as described in the beginning of this section. For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com +``` + +## Connect to Exchange Online PowerShell using user-assigned managed identity + +After you've [created and configured a user-assigned managed identity](#create-and-configure-a-user-assigned-managed-identity), use the following syntax to connect to Exchange Online PowerShell: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization .onmicrosoft.com -ManagedIdentityAccountId +``` + +You get the \ value from [Step 3: Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable). + +The rest of this section explains how to connect using supported Azure resources. For example: + +- A PowerShell runbook on the Azure Automation account with user-assigned managed identity. +- An Azure VM with a user-assigned managed identity. + +After the resource is connected, the Exchange Online PowerShell cmdlets and parameters are available based on the RBAC role you assigned in [Step 6: Assign Microsoft Entra roles to the managed identity](#step-6-assign-microsoft-entra-roles-to-the-managed-identity). + +### Connect to Exchange Online PowerShell using Azure Automation accounts with user-assigned managed identities + +Create a PowerShell runbook on the automation account. For instructions, see [Manage runbooks in Azure Automation](/azure/automation/manage-runbooks). + +The first command in the PowerShell runbook must be the `Connect-ExchangeOnline...` command as described in the beginning of this section. For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com -ManagedIdentityAccountId bf6dcc76-4331-4942-8d50-87ea41d6e8a1 +``` + +You get the ManagedIdentityAccount value from [Step 3: Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable). + +After that, as a test, you can start with as simple, low-impact command in the runbook before moving on to more complex commands or scripts. For example: + +```powershell +Get-AcceptedDomain | Format-Table Name +``` + +After you've successfully created the PowerShell runbook, do the following steps to run it in the future: + +1. On the **Automation accounts** page at , select the Automation account. +2. In the details flyout that opens, start typing "Runbooks" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Runbooks** from results. +3. On the **Runbooks** flyout that opens, select the runbook. +4. On the details page of the runbook, select **Start**. + +### Connect to Exchange Online PowerShell using Azure VMs with system-assigned managed identities + +In a Windows PowerShell window in the Azure VM, use the command as described in the beginning of this section. For example: + +```powershell +$MI_ID = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").ClientId + +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com -ManagedIdentityAccountId $MI_ID +``` + +## Create and configure a system-assigned managed identity + +The steps are: + +1. [(Optional) Create a resource with system-assigned managed identity](#step-1-create-a-resource-with-system-assigned-managed-identity) +2. [Store the system-assigned managed identity in a variable](#step-2-store-the-system-assigned-managed-identity-in-a-variable) +3. [Add the Exchange Online PowerShell module to the managed identity](#step-3-add-the-exchange-online-powershell-module-to-the-managed-identity) +4. [Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online](#step-4-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online) +5. [Assign Microsoft Entra roles to the managed identity](#step-5-assign-microsoft-entra-roles-to-the-managed-identity) + +After you complete the steps, you're ready to [Connect to Exchange Online PowerShell using system-assigned managed identity](#connect-to-exchange-online-powershell-using-system-assigned-managed-identity). + +### Step 1: Create a resource with system-assigned managed identity + +If you're going to use an existing resource that's already configured with system-assigned managed identity, you can skip to the [next step](#step-2-store-the-system-assigned-managed-identity-in-a-variable). The following resource types are supported: + +- Azure Automation accounts +- Azure virtual machines (VMs) + +#### Create Azure Automation accounts with system-assigned managed identities + +Create an Automation account that's configured for system-assigned managed identity by using the instructions at [Quickstart: Create an Automation account using the Azure portal](/azure/automation/quickstarts/create-azure-automation-account-portal). + +- Automation accounts are available on the **Automation accounts** page at . + +- When you create the Automation account, system-assigned managed identity is selected by default on the **[Advanced](/azure/automation/quickstarts/create-azure-automation-account-portal#advanced)** tab of the details of the Automation account. + +- To enable the system-assigned managed identity on an existing Automation account, see [Enable system-assigned managed identity](/azure/automation/quickstarts/enable-managed-identity#enable-system-assigned-managed-identity). + +To create the Automation account with system-assigned managed identity in [Azure PowerShell](/powershell/azure/what-is-azure-powershell), do the following steps: + +1. Connect to [Azure Az PowerShell](/powershell/azure/install-az-ps) by running the following command: + + ```powershell + Connect-AzAccount + ``` + +2. If necessary, create an Azure resource group to use with the Automation account by running the following command: + + ```powershell + New-AzResourceGroup -Name "" -Location "" + ``` + + - \ is the unique name for the new resource group. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzResourceGroup -Name "ContosoRG" -Location "West US" + ``` + + For complete instructions, see [Create resource groups](/azure/azure-resource-manager/management/manage-resource-groups-powershell#create-resource-groups). + +3. Use the following syntax to create an Automation account with system-assigned managed identity: + + ```powershell + New-AzAutomationAccount -Name "" -ResourceGroupName "" -Location "" -AssignSystemIdentity + ``` + + - \ is the unique name for the new Automation account. + - \ is the name of the existing resource group that you want to use. Valid values are visible in the output of the command: `Get-AzResourceGroup`. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzAutomationAccount -Name "ContosoAzAuto1" -ResourceGroupName "ContosoRG" -Location "West US" -AssignSystemIdentity + ``` + + For detailed syntax and parameter information, see [New-AzAutomationAccount](/powershell/module/az.automation/new-azautomationaccount). + +#### Configure Azure VMs with system-assigned managed identities + +For instructions, see the following articles: + +- [System-assigned managed identity in the Azure portal](/entra/identity/managed-identities-azure-resources/qs-configure-portal-windows-vm#system-assigned-managed-identity) + +- [System-assigned managed identity in PowerShell](/entra/identity/managed-identities-azure-resources/qs-configure-powershell-windows-vm#system-assigned-managed-identity) + +### Step 2: Store the system-assigned managed identity in a variable + +Use the following syntax to store the Id (GUID) value of the managed identity in a variable that you'll use in the upcoming steps in [Azure Az PowerShell](/powershell/azure/install-az-ps). + +```powershell +$MI_ID = (Get-AzADServicePrincipal -DisplayName "").Id +``` + +Where \ is the name of the Azure Automation account or the Azure VM. For example: + +```powershell +$MI_ID = (Get-AzADServicePrincipal -DisplayName "ContosoAzAuto1").Id +``` + +To verify that the variable was captured successfully, run the command `$MI_ID`. The output should be a GUID value (for example, 9f164909-3007-466e-a1fe-28d20b16e2c2). + +For detailed syntax and parameter information, see [Get-AzADServicePrincipal](/powershell/module/az.resources/get-azadserviceprincipal). + +### Step 3: Add the Exchange Online PowerShell module to the managed identity + +#### Add the Exchange Online PowerShell module to Azure Automation accounts with system-assigned managed identities + +> [!TIP] +> If the following procedure in the Azure portal doesn't work for you, try the **New-AzAutomationModule** command in Azure PowerShell that's described after the Azure portal procedure. + +1. On the **Automation accounts** page at , select the Automation account. +2. In the details flyout that opens, start typing "Modules" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Modules** from results. +3. On the **Modules** flyout that opens, select ![Add module icon.](media/add-icon.png) **Add a module**. +4. On the **Add a module** page that opens, configure the following settings: + - **Upload a module file**: Select **Browse from gallery**. + - **PowerShell module file**: Select **Click here to browse from gallery**: + 1. In the **Browse Gallery** page that opens, start typing "ExchangeOnlineManagement" in the ![Search icon.](media/search-icon.png) **Search** box, press Enter, and then select **ExchangeOnlineManagement** from the results. + 2. On the details page that opens, select **Select** to return to the **Add a module** page. + - **Runtime version**: Select **5.1** or **7.1 (Preview)**. To add both versions, repeat the steps in this section to add and select the other runtime version for the module. + + When you're finished, select **Import**. + + ![Screenshot of adding a module to an Automation account in the Azure portal.](media/mi-add-exo-module.png) + +5. Back on the **Modules** flyout, start typing "ExchangeOnlineManagement" in the ![Search icon.](media/search-icon.png) **Search** box to see the **Status** value. When the module import is complete, the value is **Available**. + +To add the module to the Automation account in Azure PowerShell, use the following syntax: + +```powershell +New-AzAutomationModule -ResourceGroupName "" -AutomationAccountName "" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/ +``` + +- \ is the name of the resource group that's already assigned to the Automation account. +- \ is the name of the Automation account. +- \ is the current version of the ExchangeOnlineManagement module. To see the latest General Availability (GA; non-Preview) version of the module, run the following command in Windows PowerShell: `Find-Module ExchangeOnlineManagement`. To see the latest Preview release, run the following command: `Find-Module ExchangeOnlineManagement -AllowPrerelease`. +- Currently, the PowerShell procedures don't give you a choice for the runtime version (it's 5.1). + +For example: + +```powershell +New-AzAutomationModule -ResourceGroupName "ContosoRG" -AutomationAccountName "ContosoAzAuto1" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0 +``` + +To verify that the module imported successfully, run the following command: + +```powershell +Get-AzAutomationModule -ResourceGroupName ContosoRG -AutomationAccountName ContosoAzAuto1 -Name ExchangeOnlineManagement +``` + +During the import, the ProvisioningState property will have the value Creating. When the module import is complete, the value will change to Succeeded. + +For detailed syntax and parameter information, see [New-AzAutomationModule](/powershell/module/az.automation/new-azautomationmodule). + +#### Add the Exchange Online PowerShell module to Azure VMs with system-assigned managed identities + +Install the Exchange Online PowerShell module in the Azure VM. For instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). + +### Step 4: Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online + +The procedures in this step require the Microsoft Graph PowerShell SDK. For installation instructions, see [Install the Microsoft Graph PowerShell SDK](/powershell/microsoftgraph/installation). + +1. Run the following command to connect to Microsoft Graph PowerShell with the required permissions: + + ```powershell + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + ``` + + If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. + +2. Run the following command to verify that the Office 365 Exchange Online resource is available in Microsoft Entra ID: + + ```powershell + Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" + ``` + + If the command returns no results, the next step won't work. See the subsection at the end of this section to fix the issue before you continue. + +3. Run the following commands to grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online: + + ```powershell + $AppRoleID = "dc50a0fb-09a3-484d-be87-e023b12c6440" + + $ResourceID = (Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'").Id + + New-MgServicePrincipalAppRoleAssignment -ServicePrincipalId $MI_ID -PrincipalId $MI_ID -AppRoleId $AppRoleID -ResourceId $ResourceID + ``` + + - `$MI_ID` is the Id (GUID) value of the managed identity that you stored in a variable in [Step 2](#step-2-store-the-system-assigned-managed-identity-in-a-variable). + - `$AppRoleID` is the Id (GUID) value of the **Exchange.ManageAsApp** API permission that's the same in every organization. + - `$ResourceID` is the Id (GUID) value of the **Office 365 Exchange Online** resource in Microsoft Entra ID. The AppId value is the same in every organization, but the Id value is different in every organization. + +For detailed syntax and parameter information, see the following articles: + +- [Connect-MgGraph](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment) +- [Get-MgServicePrincipal](/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) +- [New-MgServicePrincipalAppRoleAssignment](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment) + +#### What to do if the Office 365 Exchange Online resource is not available in Microsoft Entra ID + +If the following command returns no results: + +```powershell +Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" +``` + +Do the following steps: + +1. Register an application in Microsoft Entra ID as described in [Step 1: Register the application in Microsoft Entra ID](app-only-auth-powershell-v2.md#step-1-register-the-application-in-microsoft-entra-id). +2. Assign the Office 365 Exchange Online \> Exchange.ManageAsApp API permission to the application using the "Modify the app manifest" method as described in [Step 2: Assign API permissions to the application](app-only-auth-powershell-v2.md#step-2-assign-api-permissions-to-the-application). + +After you do these steps, run the **Get-MgServicePrincipal** command again to confirm that the Office 365 Exchange Online resource is available in Microsoft Entra ID. + +For even more information, run the following command to verify that the Exchange.ManageAsApp API permission (`dc50a0fb-09a3-484d-be87-e023b12c6440`) is available in the Office 365 Exchange Online resource: + +```powershell +Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" | Select-Object -ExpandProperty AppRoles | Format-Table Value,Id +``` + +Now that the Office 365 Exchange Online resource is available, return to Step 4.3 in this section. + +### Step 5: Assign Microsoft Entra roles to the managed identity + +The supported Microsoft Entra roles are described in the following list: + +- [Compliance Administrator](/entra/identity/role-based-access-control/permissions-reference#compliance-administrator) +- [Exchange Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-administrator)¹ +- [Exchange Recipient Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-recipient-administrator) +- [Global Administrator](/entra/identity/role-based-access-control/permissions-reference#global-administrator)¹ ² +- [Global Reader](/entra/identity/role-based-access-control/permissions-reference#global-reader) +- [Helpdesk Administrator](/entra/identity/role-based-access-control/permissions-reference#helpdesk-administrator) +- [Security Administrator](/entra/identity/role-based-access-control/permissions-reference#security-administrator)¹ +- [Security Reader](/entra/identity/role-based-access-control/permissions-reference#security-reader) + +¹ The Global Administrator and Exchange Administrator roles provide the required permissions for any task in Exchange Online PowerShell. For example: + +- Recipient management. +- Security and protection features. For example, anti-spam, anti-malware, anti-phishing, and the associated reports. + +The Security Administrator role does not have the necessary permissions for those same tasks. + +² Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +For general instructions about assigning roles in Microsoft Entra ID, see [Assign Microsoft Entra roles to users](/entra/identity/role-based-access-control/manage-roles-portal). + +1. In Microsoft Entra admin center at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Microsoft Entra roles and administrators** from the results in the **Services** section. + + ![Screenshot that shows Microsoft Entra roles and administrators in the Search results on the on the home page of the Azure portal.](media/exo-app-only-auth-find-roles-and-administrators.png) + + Or, to go directly to the **Microsoft Entra roles and administrators** page, use . + +2. On the **Roles and administrators** page, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. For example, find and select the **Exchange administrator** role. + + ![Find and select a supported Exchange Online PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role.png) + +3. On the **Assignments** page that opens, select **Add assignments**. + + ![Select Add assignments on the role assignments page for Exchange Online PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments.png) + +4. In the **Add assignments** flyout that opens, find and select the managed identity you created or identified in [Step 1](#step-1-create-a-resource-with-system-assigned-managed-identity). + + When you're finished, select **Add**. + +5. Back on the **Assignments** page, verify that the role has been assigned to the managed identity. + +To assign a role to the managed identity in Microsoft Graph PowerShell, do the following steps: + +1. Run the following command to connect to Microsoft Graph PowerShell with the required permissions: + + ```powershell + Connect-MgGraph -Scopes RoleManagement.ReadWrite.Directory + ``` + + If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. + +2. Use the following syntax to assign the required Microsoft Entra role to the managed identity: + + ```powershell + $RoleID = (Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq ''").Id + + New-MgRoleManagementDirectoryRoleAssignment -PrincipalId $MI_ID -RoleDefinitionId $RoleID -DirectoryScopeId "/" + ``` + + - \ is the name of the Microsoft Entra role as listed earlier in this section. + - `$MI_ID` is the Id (GUID) value of the managed identity that you stored in a variable in [Step 2](#step-2-store-the-system-assigned-managed-identity-in-a-variable). + + For example: + + ```powershell + $RoleID = (Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq 'Exchange Administrator'").Id + + New-MgRoleManagementDirectoryRoleAssignment -PrincipalId $MI_ID -RoleDefinitionId $RoleID -DirectoryScopeId "/" + ``` + +For detailed syntax and parameter information, see the following articles: + +- [Connect-MgGraph](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment). +- [New-MgRoleManagementDirectoryRoleAssignment](/powershell/module/microsoft.graph.identity.governance/new-mgrolemanagementdirectoryroleassignment) + +## Create and configure a user-assigned managed identity + +The steps are: + +1. [(Optional) Create a user-assigned managed identity](#step-1-create-a-user-assigned-managed-identity) +2. [(Optional) Create a resource with user-assigned managed identity](#step-2-create-a-resource-with-user-assigned-managed-identity) +3. [Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable) +4. [Add the Exchange Online PowerShell module to the managed identity](#step-4-add-the-exchange-online-powershell-module-to-the-managed-identity) +5. [Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online](#step-5-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online) +6. [Assign Microsoft Entra roles to the managed identity](#step-6-assign-microsoft-entra-roles-to-the-managed-identity) + +After you complete the steps, you're ready to [Connect to Exchange Online PowerShell using user-assigned managed identity](#connect-to-exchange-online-powershell-using-user-assigned-managed-identity). + +### Step 1: Create a user-assigned managed identity + +If you already have an existing user-assigned managed identity that you're going to use, you can skip to the [next step](#step-2-create-a-resource-with-user-assigned-managed-identity) to create a resource with the user-assigned managed identity. + +Otherwise, create the user-assigned managed identity in the Azure portal by using the instructions at [Create a user-assigned managed identity](/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity). + +To create the user-assigned managed identity in [Azure PowerShell](/powershell/azure/what-is-azure-powershell), do the following steps: + +1. Connect to [Azure Az PowerShell](/powershell/azure/install-az-ps) by running the following command: + + ```powershell + Connect-AzAccount + ``` + +2. If necessary, create an Azure resource group to use with the user-assigned managed identity by running the following command: + + ```powershell + New-AzResourceGroup -Name "" -Location "" + ``` + + - \ is the unique name for the new resource group. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzResourceGroup -Name "ContosoRG2" -Location "West US" + ``` + + For complete instructions, see [Create resource groups](/azure/azure-resource-manager/management/manage-resource-groups-powershell#create-resource-groups). + +3. Use the following syntax to create a user-assigned managed identity: + + ```powershell + New-AzUserAssignedIdentity -Name "" -ResourceGroupName "" -Location "" + ``` + + - \ is the unique name for the user-assigned managed identity. + - \ is the name of the existing resource group that you want to use. Valid values are visible in the output of the command: `Get-AzResourceGroup`. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2" -Location "West US" + ``` + + For detailed syntax and parameter information, see [New-AzUserAssignedIdentity](/powershell/module/az.managedserviceidentity/new-azuserassignedidentity). + +### Step 2: Create a resource with user-assigned managed identity + +If you're going to use an existing resource that's already configured with user-assigned managed identity, you can skip to the [next step](#step-3-store-the-user-assigned-managed-identity-in-a-variable). The following resource types are supported: + +- Azure Automation accounts +- Azure Virtual Machines (VMs) + +#### Create Azure Automation accounts with user-assigned managed identities + +Create an Automation account that's configured for user-assigned managed identity by using the instructions at [Quickstart: Create an Automation account using the Azure portal](/azure/automation/quickstarts/create-azure-automation-account-portal). + +- Automation accounts are available on the **Automation accounts** page at . + +- Be sure to change the managed identity selection on the **[Advanced](/azure/automation/quickstarts/create-azure-automation-account-portal#advanced)** tab to **User assigned**. + +- To enable the user-assigned managed identity on an existing Automation account, see [Add user-assigned managed identity](/azure/automation/quickstarts/enable-managed-identity#add-user-assigned-managed-identity). + +To create the Automation account with user-assigned managed identity in [Azure PowerShell](/powershell/azure/what-is-azure-powershell), do the following steps: + +1. Connect to [Azure Az PowerShell](/powershell/azure/install-az-ps) by running the following command: + + ```powershell + Connect-AzAccount + ``` + +2. Use the following syntax to create an Automation account with user-assigned managed identity: + + ```powershell + $UAMI = (Get-AzUserAssignedIdentity -Name "" -ResourceGroupName "").Id + + New-AzAutomationAccount -Name "" -ResourceGroupName "" -Location "" -AssignUserIdentity $UAMI + ``` + + - \ is the name of the user-assigned managed identity that you want to use. + - \ is the name of the resource group that's assigned to the user-assigned managed identity. Valid values are visible in the output of the command: `Get-AzResourceGroup`. + - \ is the unique name for the new Automation account. + - \ is the name of the resource group that you want to use, which could be the same value as \. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + $UAMI = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").Id + + New-AzAutomationAccount -Name "ContosoAzAuto2" -ResourceGroupName "ContosoRG2" -Location "West US" -AssignUserIdentity $UAMI + ``` + + For detailed syntax and parameter information, see [New-AzAutomationAccount](/powershell/module/az.automation/new-azautomationaccount). + +#### Configure Azure VMs with user-assigned managed identities + +For instructions, see the following articles: + +- [User-assigned managed identity in the Azure portal](/entra/identity/managed-identities-azure-resources/qs-configure-portal-windows-vm#user-assigned-managed-identity) +- [User-assigned managed identity in PowerShell](/entra/identity/managed-identities-azure-resources/qs-configure-powershell-windows-vm#user-assigned-managed-identity) + +### Step 3: Store the user-assigned managed identity in a variable + +Use the following syntax in [Azure Az PowerShell](/powershell/azure/install-az-ps) to store the ClientId value of the user-assigned managed identity in variable that you'll use in the upcoming steps: + +```powershell +$MI_ID = (Get-AzUserAssignedIdentity -Name "" -ResourceGroupName "").ClientId +``` + +- \ is the name of the user-assigned managed identity. +- \ is the name of the resource group that's associated with the user-assigned managed identity. + +For example: + +```powershell +$MI_ID = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").ClientId +``` + +To verify that the variable was captured successfully, run the command `$MI_ID`. The output should be a GUID value (for example, bf6dcc76-4331-4942-8d50-87ea41d6e8a1). + +For detailed syntax and parameter information, see [Get-AzUserAssignedIdentity](/powershell/module/az.managedserviceidentity/get-azuserassignedidentity). + +### Step 4: Add the Exchange Online PowerShell module to the managed identity + +The steps for user-assigned managed identity are the same as in [System-assigned managed identity Step 3](#step-3-add-the-exchange-online-powershell-module-to-the-managed-identity). + +> [!NOTE] +> Be sure to use the correct values for the resource group name and automation account name! + +### Step 5: Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online + +The steps for user-assigned managed identity are the same as in [System-assigned managed identity Step 4](#step-4-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online). + +Although the managed identity values were obtained differently for user-assigned vs. system-assigned, we're using the same variable name in the command (`$MI_ID`), so the command works for both types of managed identities. + +### Step 6: Assign Microsoft Entra roles to the managed identity + +The steps for user-assigned managed identity are basically the same as in [System-assigned managed identity Step 5](#step-5-assign-microsoft-entra-roles-to-the-managed-identity). + +In the Azure portal, be sure to select the [user-assigned managed identity](#step-2-create-a-resource-with-user-assigned-managed-identity) as the managed identity to assign the Microsoft Entra role to (not the automation account itself). + +The PowerShell command works for both user-assigned and system-assigned managed identities. Although the managed identity values were obtained differently for user-assigned vs. system-assigned, we're using the same variable name in the command (`$MI_ID`). diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md new file mode 100644 index 0000000000..75be6dcc6a --- /dev/null +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -0,0 +1,475 @@ +--- +title: Connect to Exchange Online PowerShell +author: chrisda +manager: deniseb +ms.date: 05/07/2025 +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 Exchange Online PowerShell with modern authentication and/or multi-factor 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). + +The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). + +To connect to Exchange Online PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md) and [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + +To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md). + +## What do you need to know before you begin? + +- The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). + + > [!NOTE] + > Remote PowerShell connections are deprecated in Exchange Online PowerShell. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). + > + > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). + + To find the permissions that are required to run specific Exchange Online cmdlets, see [Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md). + +> [!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: + +```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 [-ExchangeEnvironmentName ] [-ShowBanner:$false] [-LoadCmdletHelp] [-DelegatedOrganization ] [-SkipLoadingFormatData] [-DisableWAM] + ``` + +For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). + +- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). + +- 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| + |---|---| + |Microsoft 365 or Microsoft 365 GCC|n/a\*| + |Microsoft 365 GCC High|`O365USGovGCCHigh`| + |Microsoft 365 DoD|`O365USGovDoD`| + |Office 365 Germany|`O365GermanyCloud`| + |Office 365 operated by 21Vianet|`O365China`| + + \* 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. + +- If you aren't using MFA, you should be able to use the _Credential_ parameter instead of the _UserPrincipalName_ parameter. First, run the command `$Credential = Get-Credential`, enter your username and password, and then use the variable name for the _Credential_ parameter (`-Credential $Credential`). If it doesn't work, then you need to use the _UserPrincipalName_ parameter. + +- Use the _SkipLoadingFormatData_ switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service. + +- Using the module in PowerShell 7 requires version 2.0.4 or later. + +- In version 3.7.2 or later, the _DisableWAM_ switch is available to disable Web Account Manager (WAM) if you get WAM-related connection errors. + +The connection examples in the following sections use modern authentication, and are incapable of using Basic authentication. + +### Connect to Exchange Online PowerShell with an interactive login prompt + +1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: + + - **This example connects to Exchange Online PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com + ``` + + - **This example connects to Exchange Online PowerShell in a Microsoft GCC High organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName laura@blueyonderairlines.us -ExchangeEnvironmentName O365USGovGCCHigh + ``` + + - **This example connects to Exchange Online PowerShell in a Microsoft 365 DoD organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName julia@adatum.mil -ExchangeEnvironmentName O365USGovDoD + ``` + + - **This example connects to Exchange Online PowerShell in an Office 365 Germany organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName lukas@fabrikam.de -ExchangeEnvironmentName O365GermanyCloud + ``` + +2. In the sign-in window that opens, enter your password, and then click **Sign in**. + + ![Enter your password in the Sign in to your account window.](media/connect-exo-password-prompt.png) + + > [!NOTE] + > In PowerShell 7, browser-based single sign-on (SSO) is used by default, so the sign-in prompt opens in your default web browser instead of a standalone dialog. + +3. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). + + In the verification window that opens, enter the verification code, and then click **Verify**. + + ![Enter your verification code in the Sign in to your account window.](media/connect-exo-mfa-verify-prompt.png) + +#### PowerShell 7 exclusive connection methods + +- In PowerShell 7 for **accounts without MFA**, this example prompts for credentials within the PowerShell window: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com -InlineCredential + ``` + +- In PowerShell 7 for accounts with or without MFA, this example uses another computer to authenticate and complete the connection. Typically, you use this method on computers that don't have web browsers (users are unable to enter their credentials in PowerShell 7): + + 1. Run the following command on the computer where you want to connect: + + ```powershell + Connect-ExchangeOnline -Device + ``` + + The connection command waits at following output: + + > To sign in, use a web browser to open the page and enter the code \ to authenticate. + + Note the \ code value. + + 2. On any other device with a web browser and internet access, open and enter the \ code value from the previous step. + + 3. Enter your credentials on the resulting pages. + + 4. In the confirmation prompt, click **Continue**. The next message should indicate success, and you can close the browser or tab. + + 5. The command from step 1 continues to connect you to Exchange Online PowerShell. + +### Connect to Exchange Online PowerShell without a login prompt (unattended scripts) + +For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). + +### Connect to Exchange Online PowerShell in customer organizations + +For more information about partners and customer organizations, see the following topics: + +- [What is the Cloud Solution Provider (CSP) program?](/partner-center/csp-overview). +- [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction) + +This example connects to customer organizations in the following scenarios: + +- Connect to a customer organization using a CSP account. +- Connect to a customer organization using a GDAP. +- Connect to a customer organization as a guest user. + + ```powershell + Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com + ``` + +### Connect to Exchange Online PowerShell using managed identity + +For more information, see [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + +- System-assigned managed identity: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "cohovinyard.onmicrosoft.com" + ``` + +- User-assigned assigned managed identity: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "constoso.onmicrosoft.com" -ManagedIdentityAccountId + ``` + +## Step 3: Disconnect when you're finished + +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: + +```powershell +Disconnect-ExchangeOnline +``` + +To silently disconnect without a confirmation prompt, run the following command: + +```powershell +Disconnect-ExchangeOnline -Confirm:$false +``` + +> [!NOTE] +> The disconnect command will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. + +## How do you know you've connected successfully? + +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 receive errors, check the following requirements: + +- A common problem is an incorrect password. Run the connection steps again and pay close attention to the username and password that you use. + +- The account that you use to connect to must be enabled for PowerShell access. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). + +- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. + +- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. + +- REST-based connections to Exchange Online PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: + + > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. + + For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +- After you connect, you might received an error that looks like this: + + > Could not load file or assembly 'System.IdentityModel.Tokens.Jwt,Version=\, Culture=neutral, PublicKeyToken=\'. Could not find or load a specific file. + + This error happens when the Exchange Online PowerShell module conflicts with another module that's imported into the runspace. Try connecting in a new Windows PowerShell window before importing other modules. + +## Appendix: Comparison of old and new connection methods + +This section attempts to compare older connection methods that have been replaced by the Exchange Online PowerShell module. The Basic authentication and OAuth token procedures are included for historical reference only and are no longer supported. + +### Connect without multi-factor authentication + +- **Exchange Online PowerShell module with interactive credential prompt**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com + ``` + +- **Exchange Online PowerShell module without interactive credential prompt**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + Connect-ExchangeOnline -Credential $o365cred + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/ -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?BasicAuthToOAuthConversion=true -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect with multi-factor authentication + +- **Exchange Online PowerShell module with interactive credential prompt**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com + ``` + +- **Basic authentication**: Not available. + +- **New-PSSession with OAuth token**: Not available. + +### Connect to a customer organization with a CSP account + +- **Exchange Online PowerShell module**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com -DelegatedOrganization delegated.onmicrosoft.com + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/? DelegatedOrg=delegated.onmicrosoft.com&BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect to a customer organization using GDAP + +- **Exchange Online PowerShell module**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com -DelegatedOrganization delegated.onmicrosoft.com + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect to a customer organization as a guest user + +- **Exchange Online PowerShell module**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com -DelegatedOrganization delegated.onmicrosoft.com + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect to run unattended scripts + +- **Exchange Online PowerShell module**: + + - **Certificate thumbprint**: + + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. + + ```powershell + Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" + ``` + + - **Certificate object**: + + ```powershell + Connect-ExchangeOnline -Certificate <%X509Certificate2Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" + ``` + + - **Certificate file**: + + ```powershell + Connect-ExchangeOnline -CertificateFilePath "C:\Users\navin\Desktop\automation-cert.pfx" -CertificatePassword (ConvertTo-SecureString -String "" -AsPlainText -Force) -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" + ``` + + For more information, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/ -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@contoso.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect using managed identity + +- **Exchange Online PowerShell module**: + + - **System-assigned managed identity**: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "contoso.onmicrosoft.com" + ``` + + - **User-assigned managed identity**: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "contoso.onmicrosoft.com" -ManagedIdentityAccountId + ``` + + For more information, see [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + +- **Basic authentication**: Not available. + +- **New-PSSession with OAuth token**: Not available. diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md new file mode 100644 index 0000000000..7e28d7e8a7 --- /dev/null +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -0,0 +1,111 @@ +--- +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-exchange-servers-using-remote-powershell.md b/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md new file mode 100644 index 0000000000..a43bdfc46f --- /dev/null +++ b/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md @@ -0,0 +1,112 @@ +--- +title: "Connect to Exchange servers using remote PowerShell" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/7/2023 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: 0b5987c3-8836-456d-99f7-abc2ffb57300 +description: "Use Windows PowerShell on a local computer to connect to an Exchange Server." +--- + +# Connect to Exchange servers using remote PowerShell + +If you don't have the Exchange management tools installed on your local computer, you can use Windows PowerShell to create a remote PowerShell session to an Exchange server. It's a simple three-step process, where you enter your credentials, provide the required connection settings, and then import the Exchange cmdlets into your local Windows PowerShell session. + +> [!NOTE] +> +> - We recommend that you use the Exchange Management Shell on any computer that you use to extensively administer Exchange servers. You get the Exchange Management Shell by installing the Exchange management tools. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md). For more information about the Exchange Management Shell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). +> +> - The **Get-ExchangeCertificate** cmdlet does not fully support remote PowerShell. We recommend that you use the Exchange Management Shell instead to see all properties of certificate objects. + +## What do you need to know before you begin? + +- Estimated time to complete: less than 5 minutes + +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Exchange Server permissions](/exchange/permissions/permissions). + +- You can use the following versions of Windows: + - Windows 11 + - Windows 10 + - Windows 8.1 + - Windows Server 2019 + - Windows Server 2016 + - Windows Server 2012 or Windows Server 2012 R2 + - Windows 7 Service Pack 1 (SP1)* + - Windows Server 2008 R2 SP1* + + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + +- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect: + + > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. + + To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): + + ```powershell + Set-ExecutionPolicy RemoteSigned + ``` + + For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). + +> [!TIP] +> Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forum. + +## Connect to a remote Exchange server + +1. On your local computer, open Windows PowerShell, and run the following command: + + ```powershell + $UserCredential = Get-Credential + ``` + + In the **Windows PowerShell Credential Request** dialog box that opens, enter your user principal name (UPN) (for example, `chris@contoso.com`) and password, and then select **OK**. + +2. Replace `` with the fully qualified domain name of your Exchange server (for example, `mailbox01.contoso.com`) and run the following command: + + ```powershell + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri http:///PowerShell/ -Authentication Kerberos -Credential $UserCredential + ``` + + **Note**: The _ConnectionUri_ value is `http`, not `https`. + +3. Run the following command: + + ```powershell + Import-PSSession $Session -DisableNameChecking + ``` + +> [!NOTE] +> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: + +```powershell +Remove-PSSession $Session +``` + +## How do you know that you've successfully connected? + +After Step 3, the Exchange cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange cmdlet (for example, **Get-Mailbox**) and review the results. + +If you receive errors, check the following requirements: + +- A common problem is an incorrect password. Run the three steps again, and pay close attention to the user name and password you enter in Step 1. + +- The account you use to connect to the Exchange server needs to be enabled for remote PowerShell access. For more information, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). + +- TCP port 80 traffic needs to be open between your local computer and the Exchange server. It's probably open, but it's something to consider if your organization has a restrictive network access policy. + +## See also + +The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. + +- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) +- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) +- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) +- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) +- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) diff --git a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md new file mode 100644 index 0000000000..f34a86b8d1 --- /dev/null +++ b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md @@ -0,0 +1,347 @@ +--- +title: Use C# to connect to Exchange Online PowerShell +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 8/21/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about using the Exchange Online PowerShell V3 module and C# to connect to Exchange Online." +--- + +# Use C# to connect to Exchange Online PowerShell + +The code samples in this article use the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module) module to connect to Exchange Online from C#. + +To install the Exchange Online PowerShell module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). + +> [!TIP] +> REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). +> +> If you get errors when you try to connect, use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet. + +## Sample 1: Create a single connection using a PowerShell runspace + +```csharp +using System.Collections.ObjectModel; + +using System.Management.Automation; + +using System.Management.Automation.Runspaces; + +using System.Security; + +void SingleConnectionToExchangeOnline() + +{ + + // Setup the Initial Session State of each runspace in the pool + + // Import the ExchangeOnlineManagement module. + + // Set the Execution Policy of the runspace. + + InitialSessionState iss = InitialSessionState.CreateDefault(); + + iss.ImportPSModule(new string[] { "ExchangeOnlineManagement" }); + + iss.ExecutionPolicy = Microsoft.PowerShell.ExecutionPolicy.RemoteSigned; + + iss.ThrowOnRunspaceOpenError = true; + + Runspace runspace = RunspaceFactory.CreateRunspace(iss); + + runspace.Open(); + + // Run the Connect-ExchangeOnline command in the runspace to create a connection with EXO. + + PowerShell ps = PowerShell.Create(runspace); + + ps.AddCommand("Connect-ExchangeOnline"); + + ps.AddParameters(new Dictionary + + { + + ["Organization"] = "contoso.onmicrosoft.com", + + ["CertificateFilePath"] = "C:\\Users\\Certificates\\mycert.pfx", + + ["CertificatePassword"] = GetPassword(), + + ["AppID"] = "a37927a4-1a1a-4162-aa29-e346d5324590" + + }); + + // Execute the script synchronously. + + Collection connectionResult = ps.Invoke(); + + // Clear the connection commands before running cmdlets. + + ps.Commands.Clear(); + + // Create a new command to execute an Exchange Online cmdlet. + + ps.AddCommand("Get-Mailbox"); + + ps.AddParameter("Identity", "ContosoUser1"); + + Collection results = ps.Invoke(); + + // Check if there were any errors. + + if (!ps.HadErrors) + + { + + // Write the results to console. + + foreach (PSObject result in results) + + { + + Console.WriteLine(result.ToString()); + + } + + } + + else + + { + + // Write the errors to console by accessing the error stream of the Powershell object. + + foreach (ErrorRecord error in ps.Streams.Error) + + { + + Console.WriteLine(error.ToString()); + + } + + } + +} + +SecureString GetPassword() + +{ + + // Return the Password as a SecureString + +} +``` + +## Sample 2: Create a multiple connections using PowerShell runspace pools + +Use this code sample to run multiple Exchange Online PowerShell cmdlets in parallel. + +```csharp +PowerShell CreateConnectionCommand(RunspacePool pool) + +{ + + PowerShell ps = PowerShell.Create(); + + ps.RunspacePool = pool; + + ps.AddCommand("Connect-ExchangeOnline"); + + ps.AddParameters(new Dictionary + + { + + ["Organization"] = "contoso.onmicrosoft.com", + + ["CertificateFilePath"] = "C:\\Users\\Certificates\\mycert.pfx", + + ["CertificatePassword"] = GetPassword(), + + ["AppID"] = "a37927a4-1a1a-4162-aa29-e346d5324590" + + }); + + return ps; + +} + +void ParallelConnectionsToExchangeOnline() + +{ + + // Setup the Initial Session State of each runspace in the pool + + // Import the ExchangeOnlineManagement module. + + // Set the Execution Policy of the runspace. + + InitialSessionState iss = InitialSessionState.CreateDefault(); + + iss.ImportPSModule(new string[] { "ExchangeOnlineManagement" }); + + iss.ExecutionPolicy = Microsoft.PowerShell.ExecutionPolicy.RemoteSigned; + + iss.ThrowOnRunspaceOpenError = true; + + // Create a RunspacePool initialized with the Initial Session State. + + using (RunspacePool pool = RunspaceFactory.CreateRunspacePool(iss)) + + { + + // Configure the number of runspaces to maintain in the RunspacePool. + + pool.SetMaxRunspaces(3); + + pool.SetMinRunspaces(3); + + // Set the ThreadOptions to reuse the same threads for the runspaces so that + + // the Exchange Online cmdlets will be available after running Connect-ExchangeOnline in each runspace. + + pool.ThreadOptions = PSThreadOptions.ReuseThread; + + pool.Open(); + + // Run the Connect-ExchangeOnline cmdlet in all the runspaces in the pool + + // so that any cmdlets can be run in them after that. + + PowerShell ps1 = CreateConnectionCommand(pool); + + PowerShell ps2 = CreateConnectionCommand(pool); + + PowerShell ps3 = CreateConnectionCommand(pool); + + // Execute each of the 3 Connect-ExchangeOnline commands asynchronously. + + IAsyncResult job1 = ps1.BeginInvoke(); + + IAsyncResult job2 = ps2.BeginInvoke(); + + IAsyncResult job3 = ps3.BeginInvoke(); + + // Get the results of the commands. + + PSDataCollection connectionResult = ps1.EndInvoke(job1); + + PSDataCollection connectionResult2 = ps2.EndInvoke(job2); + + PSDataCollection connectionResult3 = ps3.EndInvoke(job3); + + // Execute two Exchange-Online commands in parallel using the runspacepool. + + // All of them have an active connection to Exchange Online. + + // NOTE : Cmdlets that update the same object or can cause conflicting + // results should not be run in parallel as they can lead to an undefined + // outcome. + + PowerShell commandPS1 = PowerShell.Create(); + + commandPS1.RunspacePool = pool; + + commandPS1.AddCommand("Get-Mailbox"); + + commandPS1.AddParameter("Identity", "ContosoUser1"); + + PowerShell commandPS2 = PowerShell.Create(); + + commandPS2.RunspacePool = pool; + + commandPS2.AddCommand("Get-Mailbox"); + + commandPS2.AddParameter("Identity", "ContosoUser2"); + + IAsyncResult commandJob1 = commandPS1.BeginInvoke(); + + IAsyncResult commandJob2 = commandPS2.BeginInvoke(); + + // Wait for the commands to finish and return the results. + + PSDataCollection command1Result = commandPS1.EndInvoke(commandJob1); + + PSDataCollection command2Result = commandPS2.EndInvoke(commandJob2); + + // Check if there were any errors. + + if (!commandPS1.HadErrors) + + { + + // Write the results to console. + + foreach (PSObject result in command1Result) + + { + + Console.WriteLine(result.ToString()); + + } + + } + + else + + { + + // Write the errors to console by accessing the error stream of the Powershell object. + + foreach (ErrorRecord error in commandPS1.Streams.Error) + + { + + Console.WriteLine(error.ToString()); + + } + + } + + // Check if there were any errors. + + if (!commandPS2.HadErrors) + + { + + // Write the results to console. + + foreach (PSObject result in command2Result) + + { + + Console.WriteLine(result.ToString()); + + } + + } + + else + + { + + // Write the errors to console by accessing the error stream of the Powershell object. + + foreach (ErrorRecord error in commandPS2.Streams.Error) + + { + + Console.WriteLine(error.ToString()); + + } + + } + + } + +} +``` diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md new file mode 100644 index 0000000000..b35779fdaf --- /dev/null +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -0,0 +1,189 @@ +--- +title: Connect to Security & Compliance PowerShell +author: chrisda +manager: deniseb +ms.date: 05/07/2025 +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 Security & Compliance PowerShell with modern authentication and/or multi-factor 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). + +The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). + +To connect to Security & Compliance PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md). + +## What do you need to know before you begin? + +- The requirements for installing and using the 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). + +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/purview/purview-compliance-portal-permissions). + +## Step 1: Load the Exchange Online PowerShell module + +> [!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: + +```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-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +``` + +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`). + +- The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following list: + - **Microsoft 365 or Microsoft 365 GCC**: + - _ConnectionUri_: None. The required value `https://ps.compliance.protection.outlook.com/powershell-liveid/` is also the default value, so you don't need to use the _ConnectionUri_ parameter in Microsoft 365 or Microsoft 365 GCC environments. + - _AzureADAuthorizationEndpointUri_: None. The required value `https://login.microsoftonline.com/common` is also the default value, so you don't need to use the _AzureADAuthorizationEndpointUri_ parameter in Microsoft 365 or Microsoft 365 GCC environments. + - **Microsoft 365 GCC High**: + - _ConnectionUri_: `https://ps.compliance.protection.office365.us/powershell-liveid/` + - _AzureADAuthorizationEndpointUri_: `https://login.microsoftonline.us/common` + - **Microsoft 365 DoD**: + - _ConnectionUri_: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/` + - _AzureADAuthorizationEndpointUri_: `https://login.microsoftonline.us/common` + - **Office 365 operated by 21Vianet**: + - _ConnectionUri_: `https://ps.compliance.protection.partner.outlook.cn/powershell-liveid` + - _AzureADAuthorizationEndpointUri_: `https://login.chinacloudapi.cn/common` + +- If you're behind a proxy server, you can use the _PSSessionOption_ parameter in the connection command. First, run this command: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the value `$ProxyOptions` for the _PSSessionOption_ parameter. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). + +- Depending on the nature of your organization, you might be able to omit the _UserPrincipalName_ parameter in the next step. Instead, you enter the username and password or select stored credentials after you run the **Connect-IPPSSession** command. If it doesn't work, then you need to use the _UserPrincipalName_ parameter. + +- If you aren't using MFA, you should be able to use the _Credential_ parameter instead of the _UserPrincipalName_ parameter. First, run the command `$Credential = Get-Credential`, enter your username and password, and then use the variable name for the _Credential_ parameter (`-Credential $Credential`). If it doesn't work, then you need to use the _UserPrincipalName_ parameter. + +### Connect to Security & Compliance PowerShell with an interactive login prompt + +1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: + + - **This example connects to Security & Compliance PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com + ``` + + - **This example connects to Security & Compliance PowerShell in a Microsoft GCC High organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName chris@govt.us -ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common + ``` + + - **This example connects to Security & Compliance PowerShell in a Microsoft 365 DoD organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName michelle@govt.mil -ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common + ``` + + - **This example connects to Security & Compliance PowerShell in an Office 365 operated by 21Vianet organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName li@fabrikam.cn -ConnectionUri https://ps.compliance.protection.partner.outlook.cn/powershell-liveid -AzureADAuthorizationEndpointUri https://login.chinacloudapi.cn/common + ``` + +2. In the sign-in window that opens, enter your password, and then click **Sign in**. + + ![Enter your password in the Sign in to your account window.](media/connect-exo-password-prompt.png) + + > [!NOTE] + > In PowerShell 7, browser-based single sign-on (SSO) is used by default, so the sign in prompt opens in your default web browser instead of a standalone dialog. + +3. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). + + In the verification window that opens, enter the verification code, and then click **Verify**. + + ![Enter your verification code in the Sign in to your account window.](media/connect-exo-mfa-verify-prompt.png) + +### Connect to Security & Compliance PowerShell without a login prompt (unattended scripts) + +For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). + +### Connect to Security & Compliance PowerShell in customer organizations + +The procedures in this section require version 3.0.0 or later of the module. + +In Security & Compliance PowerShell, you need to use the _AzureADAuthorizationEndpointUri_ with the _DelegatedOrganization_ parameter. + +For more information, about partners and customer organizations, see the following topics: + +- [What is the Cloud Solution Provider (CSP) program?](/partner-center/csp-overview). +- [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction) + +This example connects to customer organizations in the following scenarios: + +- Connect to a customer organization using a CSP account. +- Connect to a customer organization using a GDAP. +- Connect to a customer organization as a guest user. + + ```powershell + Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com -AzureADAuthorizationEndpointUri https://login.microsoftonline.com/adatum.onmicrosoft.com + ``` + +## Step 3: Disconnect when you're finished + +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: + +```powershell +Disconnect-ExchangeOnline +``` + +To silently disconnect without a confirmation prompt, run the following command: + +```powershell +Disconnect-ExchangeOnline -Confirm:$false +``` + +> [!NOTE] +> The disconnect command will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. + +## How do you know you've connected successfully? + +The Security & Compliance PowerShell cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you've connected successfully. A quick test is to run a Security & Compliance PowerShell cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. + +If you receive errors, check the following requirements: + +- A common problem is an incorrect password. Run the three steps again and pay close attention to the username and password that you use. + +- The account that you use to connect must be enabled for PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). + +- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. + +- REST-based connections to Security & Compliance PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: + + > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. + + For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +- You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: + + > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. + + To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance PowerShell endpoint. diff --git a/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md b/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md new file mode 100644 index 0000000000..eafad0e59b --- /dev/null +++ b/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md @@ -0,0 +1,130 @@ +--- +title: "Control remote PowerShell access to Exchange servers" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/7/2023 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: 064e3bb0-38bf-495e-9994-784f823b88dd +description: "Administrators can learn how to block or allow users' remote PowerShell access to Exchange servers." +--- + +# Control remote PowerShell access to Exchange servers + +Remote PowerShell in Microsoft Exchange allows you to manage your Exchange organization from a remote computer that's on your internal network or from the internet. You can disable or enable a user's ability to connect to an Exchange server using remote PowerShell and the Exchange Management Shell. For more information about remote PowerShell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). + +For additional management tasks related to remote PowerShell, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). + +## What do you need to know before you begin? + +- Estimated time to complete each procedure: less than 5 minutes + +- By default, all user accounts have access to remote PowerShell. However, to actually use remote PowerShell to connect to an Exchange server, the user needs to be a member of a management role group, or be directly assigned a management role that enables the user to run Exchange cmdlets. For more information about role groups and management roles, see [Exchange Server permissions](/Exchange/permissions/permissions). + + > [!IMPORTANT] + > In your haste to quickly and globally disable remote PowerShell access in your organization, beware of commands like `Get-User | Set-User -RemotePowerShellEnabled $false` without considering administrator accounts, service accounts, or health monitoring mailboxes that need remote PowerShell access. Use the procedures in this article to selectively remove remote PowerShell access, or preserve access for those who need it by using the following syntax in your global removal command: `Get-User | Where-Object {$_.UserPrincipalName -ne 'admin1@contoso.com' -and $_.UserPrincipalName -ne 'admin2@contoso.com'...} | Set-User -RemotePowerShellEnabled $false`. + > + > If you accidentally lock yourself out of remote PowerShell access, you'll need to use the otherwise highly discouraged method of directly loading the Exchange Management Shell snap-in (`Add-PSSnapIn Microsoft.Exchange.Management.PowerShell.SnapIn`) to give yourself access. Minimize the time and changes you're using with this method. Fix one account and open the Exchange Management Shell to make any additional changes. + +- You can only use PowerShell to perform these procedures. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). + +- For detailed information about OPATH filter syntax in Exchange, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). + +- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Remote PowerShell" entry in the [Exchange infrastructure and PowerShell permissions](/Exchange/permissions/feature-permissions/infrastructure-permissions) article. + +- If you're using third-party tools to customize email addresses of users, you need to disable email address policies on the affected users before you do the procedures in this article. If you don't, the **Set-User** commands change the email addresses of the users to match the applicable email address policy. To disable email address policies on users, set the value of the EmailAddressPolicyEnabled parameter to $false on the [Set-Mailbox](/powershell/module/exchange/set-mailbox) cmdlet. + +> [!TIP] +> Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. + +## View the remote PowerShell access for users + +To view the remote PowerShell access status for a specific user, replace \ with the name or user principal name (UPN) of the user, and then run the following command: + +```powershell +Get-User -Identity "" | Format-List RemotePowerShellEnabled +``` + +To display the remote PowerShell access status for all users, run the following command: + +```powershell +Get-User -ResultSize unlimited | Format-Table Name,DisplayName,RemotePowerShellEnabled -AutoSize +``` + +To display all users who don't have access to remote PowerShell, run the following command: + +```powershell +Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $false' +``` + +To display all users who have access to remote PowerShell, run the following command: + +```powershell +Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $true' +``` + +## Use the Exchange Management Shell to enable or disable remote PowerShell access for a user + +This example disables remote PowerShell access for the user named Therese Lindqvist. + +```powershell +Set-User "Therese Lindqvist" -RemotePowerShellEnabled $false +``` + +This example enables remote PowerShell access for the user named Sirirat Kitjakarn. + +```powershell +Set-User "Sirirat Kitjakarn" -RemotePowerShellEnabled $true +``` + +## Use the Exchange Management Shell to disable remote PowerShell access for many users + +To prevent remote PowerShell access for a specific group of existing users, you have the following options: + +- **Filter users based on an existing attribute**: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes, such as Title, Department, address information, and telephone number, are visible only when you use the **Get-User** cmdlet. Other attributes, such as CustomAttribute1-15, are visible only when you use the **Get-Mailbox** cmdlet. + +- **Use a list of specific users**: After you generate the list of specific users, you can use that list to disable their access to remote PowerShell. + +### Filter users based on an existing attribute + +To disable access to remote PowerShell for any number of users based on an existing attribute, use the following syntax: + +```powershell +$ = -ResultSize unlimited -Filter + +$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +``` + +This example removes access to remote PowerShell for all users whose **Title** attribute contains the value "Sales Associate". + +```powershell +$DSA = Get-User -ResultSize unlimited -Filter "(RecipientType -eq 'UserMailbox') -and (Title -like '*Sales Associate*')" + +$DSA | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +``` + +### Use a list of specific users + +To disable access to remote PowerShell for a list of specific users, use the following syntax: + +```powershell +$ = Get-Content + +$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +``` + +This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their user principal name (UPN). The text file must contain one UPN on each line like this: + +> akol@contoso.com
tjohnston@contoso.com
kakers@contoso.com + +After you populate the text file with the user accounts you want to update, run the following commands: + +```powershell +$NPS = Get-Content "C:\My Documents\NoPowerShell.txt" + +$NPS | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +``` diff --git a/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md new file mode 100644 index 0000000000..79a641ef08 --- /dev/null +++ b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md @@ -0,0 +1,135 @@ +--- +title: "Enable or disable access to Exchange Online PowerShell" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 12/11/2024 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: f969816a-2607-4655-9d47-9e8767fb5633 +search.appverid: MET150 +description: "Admins can learn how to disable or enable access to Exchange Online PowerShell for users in their organization" +--- + +# Enable or disable access to Exchange Online PowerShell + +Exchange Online PowerShell is the administrative interface that enables admins to manage the Exchange Online part of a Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365). + +By default, all accounts in Microsoft 365 are allowed to use Exchange Online PowerShell. This access doesn't give users administrative capabilities. They're still limited by [role based access control (RBAC)](/exchange/permissions-exo/permissions-exo). For example, they can configure some settings on their own mailbox and manage distribution groups that they own, but not much else. + +Admins can use the procedures in this article to disable or enable a user's ability to connect to Exchange Online PowerShell. + +## What do you need to know before you begin? + +- Estimated time to complete each procedure: less than 5 minutes + +- The procedures in this article are available only in Exchange Online PowerShell. To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). + +- You need to be assigned permissions before you can do the procedures in this article. You have the following options: + - [Exchange Online RBAC](/exchange/permissions-exo/permissions-exo): Membership in the **Organization Management** or **Recipient Management** role groups. + - [Microsoft Entra RBAC](/microsoft-365/admin/add-users/about-admin-roles): Membership in the **Exchange Administrator** or **Global Administrator**\* roles gives users the required permissions *and* permissions for other features in Microsoft 365. + + > [!IMPORTANT] + > In your haste to quickly and globally disable PowerShell access in your cloud-based organization, beware of commands like `Get-User | Set-User -EXOModuleEnabled $false` without considering admin accounts. Use the procedures in this article to **selectively** remove PowerShell access, or **preserve access for those who need it** by using the following syntax in your global removal command: `Get-User | Where-Object {$_.UserPrincipalName -ne 'admin1@contoso.onmicrosoft.com' -and $_.UserPrincipalName -ne 'admin2@contoso.onmicrosoft.com'...} | Set-User -EXOModuleEnabled $false`. + > + > If you accidentally lock yourself out of PowerShell access, create a new admin account in the Microsoft 365 admin center, and then use that account to give yourself PowerShell access using the procedures in this article. + > + > \* Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +- For detailed information about OPATH filter syntax in Exchange Online, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). + +> [!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`. + +```powershell +Set-User -Identity david@contoso.onmicrosoft.com -EXOModuleEnabled $false +``` + +This example enables access to Exchange Online PowerShell for the user `chris@contoso.onmicrosoft.com`. + +```powershell +Set-User -Identity chris@contoso.onmicrosoft.com -EXOModuleEnabled $true +``` + +## Disable access to Exchange Online PowerShell for many users + +To prevent access to Exchange Online PowerShell for a specific group of existing users, you have the following options: + +- **Filter users based on an existing attribute**: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes (for example, Title, Department, address information, and telephone number) are available only from the **Get-User** cmdlet. Other attributes (for example, CustomAttribute1 to CustomAttribute15) are available only from the **Get-Mailbox** cmdlet. +- **Use a list of specific users**: After you generate the list of specific users, you can use that list to disable their access to Exchange Online PowerShell. + +### Filter users based on an existing attribute + +To disable access to Exchange Online PowerShell for any number of users based on an existing attribute, use the following syntax: + +```powershell +$ = -ResultSize unlimited -Filter + +$ | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false} +``` + +This example removes access to Exchange Online PowerShell for all users whose **Title** attribute contains the value "Sales Associate". + +```powershell +$DSA = Get-User -ResultSize unlimited -Filter "(RecipientType -eq 'UserMailbox') -and (Title -like 'Sales Associate*')" + +$DSA | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false} +``` + +### Use a list of specific users + +To disable access to Exchange Online PowerShell for a list of specific users, use the following syntax: + +```powershell +$ = Get-Content + +$ | foreach {Set-User -Identity $_ -EXOModuleEnabled $false} +``` + +The following example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their accounts. The text file must contain one account on each line as follows: + +> `akol@contoso.onmicrosoft.com`
`tjohnston@contoso.onmicrosoft.com`
`kakers@contoso.onmicrosoft.com` + +After you populate the text file with the user accounts you want to update, run the following commands: + +```powershell +$NoPS = Get-Content "C:\My Documents\NoPowerShell.txt" + +$NoPS | foreach {Set-User -Identity $_ -EXOModuleEnabled $false} +``` + +## View the Exchange Online PowerShell access status for users + +> [!TIP] +> The newer `EXOModuleEnabled` property isn't available to use with the *Filter* parameter on the **Get-User** cmdlet, but the values of the `EXOModuleEnabled` property and the older `RemotePowerShellEnabled` property are always the same, so use the `RemotePowerShellEnabled` property with the *Filter* parameter on the **Get-User** cmdlet. + +To view the PowerShell access status for a specific user, replace \ with the name or user principal name (UPN) of the user, and run the following command: + +```powershell +Get-User -Identity "" | Format-List EXOModuleEnabled +``` + +To display the Exchange Online PowerShell access status for all users, run the following command: + +```powershell +Get-User -ResultSize unlimited | Format-Table -Auto DisplayName,EXOModuleEnabled +``` + +To display all users who don't have access to Exchange Online PowerShell, run the following command: + +```powershell +Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $false' +``` + +To display all users who have access to Exchange Online PowerShell, run the following command: + +```powershell +Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $true' +``` diff --git a/exchange/docs-conceptual/exchange-cmdlet-syntax.md b/exchange/docs-conceptual/exchange-cmdlet-syntax.md new file mode 100644 index 0000000000..2d91c08839 --- /dev/null +++ b/exchange/docs-conceptual/exchange-cmdlet-syntax.md @@ -0,0 +1,141 @@ +--- +title: "Exchange cmdlet syntax" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/7/2023 +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." +--- + +# 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. +- 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. + +## 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`.| + +These command conventions help you understand how a command is constructed. Except for the hyphen that indicates a parameter, you don't use these symbols as they're described in the table when you run cmdlets in Exchange PowerShell. + +## Parameter sets in Exchange PowerShell + +Parameter sets are groups of parameters that can be used with each other in the same command. Each parameter set contains at least one parameter that isn't available in the other parameter sets, but parameter sets typically share some parameters.s. + +Many cmdlets have only one parameter set, which means that all parameters can be used with each other. Other cmdlets have several parameter sets, which means some parameters can't be used with other parameters. For example, suppose the following parameter sets are available on the **New-SystemMessage** cmdlet: + +`New-SystemMessage -DsnCode -Internal -Language -Text [-Confirm] [-DomainController ] [-WhatIf] ` + +`New-SystemMessage -QuotaMessageType -Language -Text [-Confirm] [-DomainController ] [-WhatIf] ` + +The following parameters are available in the first parameter set, so you can use them in the same command: + +- _DsnCode_ +- _Internal_ +- _Language_ +- _Text_ +- _Confirm_ +- _DomainController_ +- _WhatIf_ + +The following parameters are available in the second parameter set, so you can use them in the same command: + +- _QuotaMessageType_ +- _Language_ +- _Text_ +- _Confirm_ +- _DomainController_ +- _WhatIf_ + +The parameters _DsnCode_ and _Internal_ are available only in the first parameter set. The parameter _QuotaMessageType_ is available only in the second parameter set. So, you can't use the following parameters in the same command: + +- _DsnCode_ and _QuotaMessageType_. +- _Internal_ and _QuotaMessageType_. + +The following parameters are available in both parameter sets, so you can use them in any **New-SystemMessage** command: + +- _Language_ +- _Text_ +- _Confirm_ +- _DomainController_ +- _WhatIf_ + +The `` entry indicates the cmdlet supports the basic Windows PowerShell parameters that are available on virtually any cmdlet (for example, _Verbose_). You can use common parameters with parameters from any parameter set. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## Quotation marks in Exchange PowerShell + +In Exchange PowerShell, you use single quotation marks ( ' ) or double quotation marks ( " ) to enclose parameter values that contain spaces. For example, the following commands behave the same: + +- `Get-ReceiveConnector -Identity "Contoso Receive Connector"` + +- `Get-ReceiveConnector -Identity 'Contoso Receive Connector'` + +In the previous examples, if you don't enclose the value in single or double quotation marks, the command fails because PowerShell treats each word as a new argument (it thinks `Contoso` is the value of the _Identity_ parameter, and `Receive` is the value of an unspecified positional parameter). In this example, the error looks like this: + +> A positional parameter cannot be found that accepts argument 'Receive' + +For plain text values, single quotation marks vs. double quotation marks don't really matter. But, the choice is important when variables are involved: + +- **Double quotation marks**: Variables are substituted with their actual values. +- **Single quotation marks**: Variables are treated literally. + +For example, `$Server = Mailbox01` results in the following output based on which quotation marks you use: + +- **"$Server Example"** results in `Mailbox01 Example`. +- **'$Server Example'** results in `$Server Example`. + +For more information about variables, see [about_Variables](/powershell/module/microsoft.powershell.core/about/about_variables) and [about_Automatic_Variables](/powershell/module/microsoft.powershell.core/about/about_automatic_variables). + +## Escape characters in Exchange PowerShell + +In any programming language, an _escape character_ is used to identify special characters literally, and not by their normal function in that language. In Exchange PowerShell, when you enclose a text string in double quotation marks, the escape character is the back quotation mark escape character ( ` ). + +For example, if you want the output `The price is $23`, enter the value **"The price is \`$23"**. The escape character is required on the dollar sign character ( $ ) because $ defines variables in PowerShell. + +If you enclose the string in single quotation marks, the only special character you need to worry about is the single quotation mark character itself, which requires two single quotation marks to escape ( `''` ). + + For example, if you want the output `Don't confuse two single quotation marks with a double quotation mark!`, enter the value **'Don''t confuse two single quotation marks with a double quotation mark!'**. + +## 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"}`.| diff --git a/exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md deleted file mode 100644 index 2744d7d773..0000000000 --- a/exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "Connect to Exchange Online Protection PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 5/9/2018 -ms.audience: Admin -ms.topic: article -ms.service: eop -localization_priority: Normal -ms.assetid: 054e0fd7-d465-4572-93f8-a00a9136e4d1 -description: "Use remote PowerShell to connect to an Exchange Online Protection organization" ---- - -# Connect to Exchange Online Protection PowerShell - -Exchange Online Protection PowerShell allows you to manage your Exchange Online Protection settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online Protection. It's a simple three-step process where you enter your Office 365 credentials, provide the required connection settings, and then import the Exchange Online Protection cmdlets into your local Windows PowerShell session so that you can use them. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- You can use the following versions of Windows: - - - Windows 10 - - - Windows 8.1 - - - Windows Server 2016 - - - Windows Server 2012 or Windows Server 2012 R2 - - - Windows 7 Service Pack 1 (SP1)* - - - Windows Server 2008 R2 SP1* - - * For older versions of Windows, you need to install the Microsoft.NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868), [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757), [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - - - Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - `Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.` - - To require all scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ``` - Set-ExecutionPolicy RemoteSigned - ``` - - You need to configure this setting only once on your computer, not every time you connect. - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612), [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online Protection - -1. On your local computer, open Windows PowerShell and run the following command: - - ``` - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ``` - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.protection.outlook.de/powershell-liveid/` - - - For Exchange Online Protection subscriptions that are Exchange Enterprise CAL with Services (includes data loss prevention (DLP) and reporting using web services), use the _ConnectionUri_ value: `https://outlook.office365.com/powershell-liveid/` - -3. Run the following command: - - ``` - Import-PSSession $Session -DisableNameChecking - ``` - - [!NOTE] - Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: - - ``` - Remove-PSSession $Session - ``` - -## How do you know this worked? - -After Step 3, the Exchange Online Protection cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online Protection cmdlet, for example, **Get-TransportRule**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to your Exchange Online Protection organization. - -- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - `The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation.` - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint. - -## See also - -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. - -- [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkId=389618) - -- [New-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389621) - -- [Import-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389619) - -- [Remove-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389620) - -- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623) \ No newline at end of file diff --git a/exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md deleted file mode 100644 index e8a758a67f..0000000000 --- a/exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Exchange Online Protection PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 2/20/2018 -ms.audience: Admin -ms.topic: article -ms.service: eop -localization_priority: Normal -ms.assetid: f7918a88-774a-405e-945b-bc2f5ee9f748 -description: "Learn about using PowerShell in Exchange Online Protection" ---- - -# Exchange Online Protection PowerShell - -Exchange Online Protection PowerShell is the administrative interface that enables you to manage your Exchange Online Protection (EOP) organization from the command line. For example, you can use Exchange Online Protection PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following topics provide information about using Exchange Online Protection PowerShell: - -- To create a remote PowerShell session to your Exchange Online Protection organization, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). - -- For a sample script that lets admins who manage multiple tenants (companies) apply configuration settings to their tenants, see [Sample script for applying EOP settings to multiple tenants](http://technet.microsoft.com/library/e87e84e1-7be0-44bf-a414-d91d60ed8817.aspx). - -- The following introductory video shows you how to connect to and use Exchange Online Protection PowerShell. - - **Note:** This video applies to Exchange Online and EOP organizations. When you connect to your organization, be careful to specify the correct URL (_ConnectionUri_ value). The required URL is different for Exchange Online and EOP organizations. - - [Use Remote PowerShell in EOP](https://videoplayercdn.osi.office.net/hub/?csid=ux-cms-en-us-msoffice&uuid=9cb28006-c2cb-45b6-b72e-eeed8767dee7&AutoPlayVideo=false) - - diff --git a/exchange/docs-conceptual/exchange-eop/media/MSN_Video_Widget.gif b/exchange/docs-conceptual/exchange-eop/media/MSN_Video_Widget.gif deleted file mode 100644 index 852a7daa98..0000000000 Binary files a/exchange/docs-conceptual/exchange-eop/media/MSN_Video_Widget.gif and /dev/null differ diff --git a/exchange/docs-conceptual/exchange-management-shell.md b/exchange/docs-conceptual/exchange-management-shell.md new file mode 100644 index 0000000000..f10d3cc542 --- /dev/null +++ b/exchange/docs-conceptual/exchange-management-shell.md @@ -0,0 +1,82 @@ +--- +title: "Exchange Server PowerShell (Exchange Management Shell)" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/1/2023 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: 925ad66f-2f05-4269-9923-c353d9c19312 +description: "Learn about Exchange Server PowerShell, also known as the Exchange Management Shell. This article describes how PowerShell works on Exchange servers, and provides links to other articles that can help you learn how to use the Exchange Management Shell." +--- + +# Exchange Server PowerShell (Exchange Management Shell) + +The Exchange Management Shell is built on Windows PowerShell technology and provides a powerful command-line interface that enables the automation of Exchange administration tasks. You can use the Exchange Management Shell to manage every aspect of Exchange. For example, you can create email accounts, create Send connectors and Receive connectors, configure mailbox database properties, and manage distribution groups. + +You can use the Exchange Management Shell to perform every task that's available in the Exchange graphical management tools, plus things that you can't do there (for example, bulk operations). In fact, when you do something in the Exchange admin center (EAC), the Exchange Control Panel (ECP), or the Exchange Management Console (EMC), it's the Exchange Management Shell that does the work behind the scenes. + +The Exchange Management Shell also provides a robust and flexible scripting platform. You can often replace long, complex Visual Basic scripts with Exchange Management Shell commands that use as little as one line of code. The Exchange Management Shell offers this flexibility because it uses an object model that's based on the Microsoft .NET Framework. This object model enables Exchange cmdlets to apply the output from one command to subsequent commands. + +To start using the Exchange Management Shell immediately, see the [Exchange Management Shell documentation](#exchange-management-shell-documentation) section later in this article. + +> [!NOTE] +> There is no Microsoft-provided module in the PowerShell Gallery for Exchange Server PowerShell. Instead, to use PowerShell in Exchange Server, you have the following options: +> +> - Open the Exchange Management Shell on an Exchange server or that you've installed locally on your own computer using a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md). +> - Open a remote PowerShell session from Windows PowerShell on your local computer. For more information, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). + +## How the Exchange Management Shell works on all Exchange server roles except Edge Transport + +Whether you use the Exchange Management Shell on a local Exchange server or on an Exchange server that's located across the country, remote PowerShell does the work. + +When you select the Exchange Management Shell shortcut on an Exchange server, the local instance of Windows PowerShell takes the following steps: + +1. Connects to the closest Exchange server (typically, the local Exchange server) using a required Windows PowerShell component called Windows Remote Management (WinRM). +2. Performs authentication checks. +3. Creates a remote PowerShell session for you to use. + +You only get access to the Exchange cmdlets and parameters that are associated with the Exchange management role groups and management roles you're assigned. For more information about how Exchange uses role groups and roles to manage who can do what tasks, see [Exchange Server permissions](/Exchange/permissions/permissions). + +A benefit of remote PowerShell is that you can use Windows PowerShell on a local computer to connect to an Exchange server remotely by importing the Exchange cmdlets into the PowerShell session. The only requirements for the computer are: + +- A supported operating system for Exchange Server. +- A supported version of the .NET Framework. +- A supported version of the Windows Management Framework (WMF), which includes WinRM and Windows PowerShell. + +For details, see the following articles: + +- [Exchange 2019 system requirements](/Exchange/plan-and-deploy/system-requirements?view=exchserver-2019&preserve-view=true) +- [Exchange 2016 system requirements](/Exchange/plan-and-deploy/system-requirements?view=exchserver-2016&preserve-view=true) +- [Exchange 2013 system requirements](/exchange/exchange-2013-system-requirements-exchange-2013-help) +- [Exchange 2010 system requirements](/previous-versions/office/exchange-server-2010/aa996719(v=exchg.141)) + +However, we recommend that you install the Exchange management tools (which includes the Exchange Management Shell) on any computer that you use to frequently manage Exchange Server. Without the Exchange management tools installed, you need to manually connect to the remote Exchange server, and you don't have access to the additional capabilities that the Exchange management tools provide. + +For more information about connecting to Exchange servers without the Exchange management tools installed, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). + +## How the Exchange Management Shell works on Edge Transport servers + +On Edge Transport servers, the Exchange Management Shell works differently. You typically deploy Edge Transport servers in your perimeter network, either as stand-alone servers or as members of a perimeter Active Directory domain. + +When you select the Exchange Management Shell shortcut on an Exchange Edge Transport server, the local instance of Windows PowerShell creates a local PowerShell session for you to use. + +Edge Transport servers don't use management roles or management role groups to control permissions. The local Administrators group controls who can configure the Exchange features on the local server. + +For more information about Edge Transport servers, see [Edge Transport Servers](/Exchange/architecture/edge-transport-servers/edge-transport-servers). + +## Exchange Management Shell documentation + +The following table provides links to articles that can help you learn about and use the Exchange Management Shell. + +|Article|Description| +|---|---| +|[Open the Exchange Management Shell](open-the-exchange-management-shell.md)|Find and open the Exchange Management Shell on an Exchange server or a computer that has the Exchange management tools installed.| +|[Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md)|Use Windows PowerShell on a local computer to connect to an Exchange server.| +|[Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md)|Learn how to block or allow users' remote PowerShell access to Exchange servers.| +|[Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md)|Find the permissions you need to run a specific cmdlet, or one or more parameters on the cmdlet.| +|[Exchange cmdlet syntax](exchange-cmdlet-syntax.md)|Learn about the structure and syntax of cmdlets in Exchange PowerShell.| +|[Recipient filters in Exchange Management Shell commands](recipient-filters.md)|Learn about recipient filters in the Exchange Management Shell.| diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md new file mode 100644 index 0000000000..5849e19153 --- /dev/null +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -0,0 +1,786 @@ +--- +title: About the Exchange Online PowerShell V3 module +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 05/07/2025 +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 +keywords: Exchange Online PowerShell V2 module, Exchange Online PowerShell V3 module, EXO V2 module, EXO V3 module +description: "Admins can learn about the installation, maintenance, and design of the Exchange Online PowerShell V3 module that they use to connect to all Exchange-related PowerShell environments in Microsoft 365." +--- + +# About the Exchange Online PowerShell module + +The Exchange Online PowerShell module uses modern authentication and works with or without multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. + +For connection instructions using the module, see the following articles: + +- [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) +- [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md) +- [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md) +- [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md) +- [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md) +- [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md) + +The rest of this article explains how the module works, how to install and maintain the module, and the optimized Exchange Online cmdlets that are available in the module. + +> [!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. + +REST API connections require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](#powershellget-for-rest-api-connections-in-windows). + +Cmdlets in REST API connections have the following advantages over their historical counterparts: + +- **More secure**: Built-in support for modern authentication and no dependence on the remote PowerShell session. PowerShell on your client computer doesn't need [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm). +- **More reliable**: Transient failures use built-in retries, so failures or delays are minimized. For example: + - Failures due to network delays. + - Delays due to large queries that take a long time to complete. +- **Better performance**: REST API connections avoid setting up a PowerShell runspace. + +The benefits of cmdlets in REST API connections are described in the following table: + +| |Remote PowerShell cmdlets|Get-EXO\* cmdlets|REST API cmdlets| +|---|---|---|---| +|**Security**|Least secure|Highly secure|Highly secure| +|**Performance**|Low performance|High performance|Medium performance| +|**Reliability**|Least reliable|Highly reliable|Highly reliable| +|**Functionality**|All parameters and output properties available|Limited parameters and output properties available|All parameters and output properties available| + +REST API cmdlets have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update cmdlet names or parameters in older scripts. + +> [!TIP] +> The [Invoke-Command](/powershell/module/microsoft.powershell.core/invoke-command) cmdlet doesn't work in REST API connections. For alternatives, see [Workarounds for Invoke-Command scenarios in REST API connections](invoke-command-workarounds-rest-api.md). + +Basic authentication (remote PowerShell) connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell. For more information, see [here](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692) and [here](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + +A few cmdlets in Exchange Online PowerShell have been updated with the experimental _UseCustomRouting_ switch in REST API connections. This switch routes the command directly to the required Mailbox server, and might improve overall performance. Use the _UseCustomRouting_ switch experimentally. + +- When you use the _UseCustomRouting_ switch, you can use only the following values for identity of the mailbox: + - User principal name (UPN) + - Email address + - Mailbox GUID + +- The _UseCustomRouting_ switch is available only on the following Exchange Online PowerShell cmdlets in REST API connections: + - **Get-Clutter** + - **Get-FocusedInbox** + - **Get-InboxRule** + - **Get-MailboxAutoReplyConfiguration** + - **Get-MailboxCalendarFolder** + - **Get-MailboxFolderPermission** + - **Get-MailboxFolderStatistics** + - **Get-MailboxMessageConfiguration** + - **Get-MailboxPermission** + - **Get-MailboxRegionalConfiguration** + - **Get-MailboxStatistics** + - **Get-MobileDeviceStatistics** + - **Get-UserPhoto** + - **Remove-CalendarEvents** + - **Set-Clutter** + - **Set-FocusedInbox** + - **Set-MailboxRegionalConfiguration** + - **Set-UserPhoto** + +- Use the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet to get information about REST API connections to Exchange Online PowerShell and Security & Compliance PowerShell. This cmdlet is required because the [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession) cmdlet in Windows PowerShell doesn't return information for REST API connections. + + Scenarios where you can use **Get-ConnectionInformation** are described in the following table: + + |Scenario|Expected output| + |---|---| + |Run after **Connect-ExchangeOnline** or **Connect-IPPSSession** commands for REST API connections.|Returns one connection information object.| + |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands for REST API connections.|Returns a collection of connection information objects.| + +- Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. + +- Cmdlets backed by the REST API have a 15-minute timeout, which can affect bulk operations. For example, the following **Update-DistributionGroupMember** command to update 10,000 members of a distribution group might time out: + + ```powershell + $Members = @("member1","member2",...,"member10000") + + Update-DistributionGroupMember -Identity DG01 -Members $Members + ``` + + Instead, use the **Update-DistributionGroupMember** command to update fewer members, and then add the remaining members individually using an **Add-DistributionGroupMember** command. For example: + + ```powershell + Update-DistributionGroupMember -Identity DG01 -Members $Members[0..4999] + + $Remaining = $Members[-5000..-1] + + foreach ($Member in $Remaining) + + { + Add-DistributionGroupMember -Identity DG01 -Member $Member + } + ``` + +For more information about what's new in the EXO V3 module, see the [Release notes](#release-notes) section later in this article. + +## Report bugs and issues for Preview versions of the Exchange Online PowerShell module + +> [!TIP] +> For General Availability (GA) versions of the module, don't use the following email address to report issues. Messages about GA versions of the module won't be answered. Instead, open a support ticket. + +For **Preview versions of the module**, use `exocmdletpreview[at]service[dot]microsoft[dot]com` to report any issues that you might encounter. Be sure to include the log files in your email message. To generate the log files, replace \ with an output folder, and then run the following command: + +```powershell +Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath -LogLevel All +``` + +## Cmdlets in the Exchange Online PowerShell module + +The EXO module contains nine exclusive **Get-EXO\*** cmdlets that are optimized for speed in bulk data retrieval scenarios (thousands and thousands of objects) in Exchange Online PowerShell. The improved cmdlets in the module are listed in the following table: + +|EXO module cmdlet|Older related cmdlet| +|---|---| +|[Get-EXOMailbox](/powershell/module/exchange/get-exomailbox)|[Get-Mailbox](/powershell/module/exchange/get-mailbox)| +|[Get-EXORecipient](/powershell/module/exchange/get-exorecipient)|[Get-Recipient](/powershell/module/exchange/get-recipient)| +|[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)| + +> [!TIP] +> If you open multiple connections to Exchange Online PowerShell in the same window, the **Get-EXO\*** cmdlets are always associated with the last (most recent) Exchange Online PowerShell connection. Run the following command to find the REST API session where the **Get-EXO\*** cmdlets are run: `Get-ConnectionInformation | Where-Object {$_.ConnectionUsedForInbuiltCmdlets -eq $true}`. + +The connection-related cmdlets in the module are listed in the following table: + +|EXO module cmdlet|Older related cmdlet|Comments| +|---|---|---| +|[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|**Connect-EXOPSSession** in V1 of the module
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| +|[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|**Connect-IPPSSession** in V1 of the module|| +|[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| +|[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v3.0.0 or later.| + +> [!TIP] +> Frequent use of the **Connect-ExchangeOnline** and **Disconnect-ExchangeOnline** cmdlets in a single PowerShell session or script might lead to a memory leak. The best way to avoid this issue is to use the _CommandName_ parameter on the **Connect-ExchangeOnline** cmdlet to limit the cmdlets that are used in the session. + +Miscellaneous Exchange Online cmdlets that happen to be in the module are listed in the following table: + +|Cmdlet|Comments| +|---|---| +|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| +|[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| +|[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| +|[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).| +|[Set-UserBriefingConfig](/powershell/module/exchange/set-userbriefingconfig)|Replaced by [Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig).| +|[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5 or later.| +|[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5 or later.| +|[Get-VivaModuleFeature](/powershell/module/exchange/get-vivamodulefeature)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeatureEnablement](/powershell/module/exchange/get-vivamodulefeatureenablement)|Available in v3.2.0 or later.| +|[Add-VivaModuleFeaturePolicy](/powershell/module/exchange/add-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| + +## Install and maintain the Exchange Online PowerShell module + +You download the module from the PowerShell gallery at . + +The procedures in this section explain how to install, update, and uninstall the module. + +### 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. + +Specifically, version **2.0.4 or later** is supported in **PowerShell 7.0.3 or later**. + +For more information about PowerShell 7, see [Announcing PowerShell 7.0](https://devblogs.microsoft.com/powershell/announcing-PowerShell-7-0/). + +#### Apple macOS + +The module is supported in the following versions of macOS: + +- macOS 11 Big Sur or later +- macOS 10.15 Catalina +- macOS 10.14 Mojave + +For instructions on installing PowerShell 7 on macOS, see [Installing PowerShell on macOS](/powershell/scripting/install/installing-powershell-core-on-macos). + +As described in the installation article, you need to install OpenSSL, which is required for WSMan. + +After you install PowerShell 7 and OpenSSL, do the following steps: + +1. Run PowerShell as superuser: `sudo pwsh` +2. In the PowerShell superuser session, run the following commands: + + ```powershell + Install-Module -Name PSWSMan + + Install-WSMan + ``` + + If prompted, accept PSGallery as the source for the cmdlets. + +Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). + +#### Linux + +The module is officially supported in the following distributions of Linux: + +- Ubuntu 24.04 LTS +- Ubuntu 20.04 LTS +- Ubuntu 18.04 LTS + +For instructions on installing PowerShell 7 on Linux, see [Installing PowerShell on Linux](/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-7.1&preserve-view=true). + +After you install PowerShell 7, do the following steps: + +1. Run PowerShell as superuser: `sudo pwsh` +2. In the PowerShell superuser session, run the following commands: + + ```powershell + Install-Module -Name PSWSMan + + Install-WSMan + ``` + + If prompted, accept PSGallery as the source for the cmdlets. + +Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). + +> [!NOTE] +> If you connect to Exchange Online PowerShell from a network that's behind a proxy server, the EXO V2 module (version v2.0.5 or earlier) doesn't work in Linux. You need to use the EXO V3 module (v3.0.0 or later) in Linux to connect from a network that's behind a proxy server. + +#### Windows + +All versions of the module are supported in Windows PowerShell 5.1. + +PowerShell 7 on Windows requires version 2.0.4 or later. + +Version 2.0.5 or later of the module requires the Microsoft .NET Framework 4.7.2 or later to connect. Otherwise, you get a `System.Runtime.InteropServices.OSPlatform` error. This requirement shouldn't be an issue in current versions of Windows. For more information about versions of Windows that support the .NET Framework 4.7.2, see [this article](/dotnet/framework/migration-guide/versions-and-dependencies#net-framework-472). + +Windows PowerShell requirements and module support **in older versions of Windows** are described in the following list: + +- Windows 8.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). + +### Prerequisites for the Exchange Online PowerShell module + +#### Set the PowerShell execution policy to RemoteSigned + +> [!TIP] +> The settings in this section apply to all versions of PowerShell on all operating systems. + +PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect: + +> Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. + +To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated PowerShell window (a PowerShell window you open by selecting **Run as administrator**): + +```powershell +Set-ExecutionPolicy RemoteSigned +``` + +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**: + +> [!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**: + + ```DOS + winrm set winrm/config/client/auth @{Basic="true"} + ``` + +- **In Windows PowerShell**: + + ```powershell + winrm set winrm/config/client/auth '@{Basic="true"}' + ``` + +- **In Windows PowerShell to modify the registry**: + + ```PowerShell + Set-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WinRM\Client' -Name 'AllowBasic' -Type DWord -Value '1' + ``` + +If Basic authentication for WinRM is disabled, you get one of the following errors when you try to connect using a Basic authentication (remote PowerShell) connection: + +> The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. +> +> Create Powershell Session is failed using OAuth. + +### PowerShellGet for REST API connections in Windows + +[REST API connections](#rest-api-connections-in-the-exo-v3-module) in Windows require the PowerShellGet module, and by dependency, the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all versions of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). + +> [!TIP] +> Beta versions of the PackageManagement or PowerShellGet modules might cause connection issues. If you have connection issues, verify that you don't have Beta versions of the modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. + +If you don't have PowerShellGet installed when you try to create a REST API connection, you get the following error when you try to connect: + +> Cannot find a cmdlet Update-Manifest + +### Install the Exchange Online PowerShell module + +To install the module for the first time, complete the following steps: + +1. Install or update the PowerShellGet module as described in [Installing PowerShellGet](/powershell/scripting/gallery/installing-psget). + +2. Close and re-open the Windows PowerShell window. + +3. Now you can use the **Install-Module** cmdlet to install the module from the PowerShell Gallery. Typically, you want the latest public version of the module, but you can also install a Preview version if any are available. + + - To install **the latest public version** of the module, run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Install-Module -Name ExchangeOnlineManagement + ``` + + - Only for the current user account: + + ```powershell + Install-Module -Name ExchangeOnlineManagement -Scope CurrentUser + ``` + + - To see **the available Preview versions** of the module, run the following command: + + ```powershell + Find-Module ExchangeOnlineManagement -AllVersions -AllowPrerelease + ``` + + - To install **the latest available Preview version** of the module, run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Install-Module -Name ExchangeOnlineManagement -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Install-Module -Name ExchangeOnlineManagement -Scope CurrentUser -AllowPrerelease + ``` + + - To install **a specific Preview version** of the module, replace \ with the necessary value, and run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Install-Module -Name ExchangeOnlineManagement -RequiredVersion -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Install-Module -Name ExchangeOnlineManagement -RequiredVersion -AllowPrerelease -Scope CurrentUser + ``` + + When you're finished, enter **Y** to accept the license agreement. + +For detailed syntax and parameter information, see [Install-Module](/powershell/module/powershellget/install-module). + +### Update the Exchange Online PowerShell module + +If the module is already installed on your computer, you can use the procedures in this section to update the module. + +1. To see the version of the module that's currently installed and where it's installed, run the following command: + + ```powershell + Get-InstalledModule ExchangeOnlineManagement | Format-List Name,Version,InstalledLocation + ``` + + If the module is installed in C:\Program Files\WindowsPowerShell\Modules\, it's installed for all users. If the module is installed in your Documents folder, it's installed only for the current user account. + +2. You can use the **Update-Module** cmdlet to update the module from the PowerShell Gallery. Typically, you want the latest public version of the module, but you can also upgrade to a Preview version if any are available. + + - To upgrade to **the latest public version** of the module, run **one** of the following commands based on how you originally installed the module (all users vs. only for the current user account): + + - In an elevated PowerShell window (all users): + + ```powershell + Update-Module -Name ExchangeOnlineManagement + ``` + + - Only for the current user account: + + ```powershell + Update-Module -Name ExchangeOnlineManagement -Scope CurrentUser + ``` + + - To upgrade to **a Preview version** of the module, you can upgrade to the latest available Preview version, or you can use the _RequiredVersion_ parameter to upgrade to a specific Preview version. + + - To see **the available Preview versions** of the module, run the following command: + + ```powershell + Find-Module ExchangeOnlineManagement -AllVersions -AllowPrerelease + ``` + + - To upgrade to **the latest available Preview version** of the module, run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Update-Module -Name ExchangeOnlineManagement -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Update-Module -Name ExchangeOnlineManagement -Scope CurrentUser -AllowPrerelease + ``` + + - To upgrade to **a specific Preview version** of the module, replace \ with the necessary value, and run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Update-Module -Name ExchangeOnlineManagement -RequiredVersion -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Update-Module -Name ExchangeOnlineManagement -Scope CurrentUser -RequiredVersion -AllowPrerelease + ``` + + When you're finished, enter **Y** to accept the license agreement. + +3. To confirm that the update was successful, run the following commands to check the version information of the module that's installed: + + ```powershell + Import-Module ExchangeOnlineManagement; Get-Module ExchangeOnlineManagement + ``` + +For detailed syntax and parameter information, see [Update-Module](/powershell/module/powershellget/update-module). + +### Troubleshoot installing the Exchange Online PowerShell module + +- You receive one of the following errors: + + > The specified module 'ExchangeOnlineManagement' with PowerShellGetFormatVersion '\' isn't supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'ExchangeOnlineManagement'. + + > WARNING: Unable to download from URI 'https://go.microsoft.com/fwlink/?LinkID=627338&clcid=0x409' to ''. + + > WARNING: Unable to download the list of available providers. Check your internet connection. + + Update your installation of the PowerShellGet module to the latest version as described in [Installing PowerShellGet](/powershell/scripting/gallery/installing-psget). Be sure to close and re-open the PowerShell window before you attempt to update the ExchangeOnlineManagement module again. + +- You receive the following error: + + > No match was found for the specified search criteria and module name 'ExchangeOnlineManagement'. Try running `Get-PSRepository` to see all available registered module repositories. + + The default repository for PowerShell modules isn't set to PSGallery. To fix this error, run the following command: + + ```powershell + Register-PSRepository -Default + ``` + +- As of April 2020, the PowerShell Gallery only supports connections using TLS 1.2 or later. For more information, see [PowerShell Gallery TLS Support](https://devblogs.microsoft.com/powershell/powershell-gallery-tls-support/). + + To check your current settings in the Microsoft .NET Framework, run the following command in Windows PowerShell: + + ```powershell + [Net.ServicePointManager]::SecurityProtocol + ``` + + As described in the PowerShell Gallery TLS Support article, to _temporarily_ change the security protocol to TLS 1.2 to install the PowerShellGet or ExchangeOnlineManagement modules, run the following command in Windows PowerShell _before_ you install the module: + + ```powershell + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + ``` + + To _permanently_ enable strong cryptography in the Microsoft .NET Framework version 4.x or later, run one of the following commands based on your Windows architecture: + + - x64: + + ```powershell + Set-ItemProperty -Path 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1' + ``` + + - x86: + + ```powershell + Set-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1' + ``` + + For more information, see [SchUseStrongCrypto](/dotnet/framework/network-programming/tls#schusestrongcrypto). + +### Uninstall the Exchange Online PowerShell module + +To see the version of the module that's currently installed and where it's installed, run the following command: + + ```powershell + Get-InstalledModule ExchangeOnlineManagement | Format-List Name,Version,InstalledLocation + ``` + + If the module is installed in C:\Program Files\WindowsPowerShell\Modules\, it was installed for all users. If the module is installed in your Documents folder, it was installed only for the current user account. + +To uninstall the module, run the following command in one of the following environments based on how you originally installed the module (all users vs. only for the current user account): + +- In an elevated PowerShell window (all users). +- In a normal PowerShell window (only for the current user account). + + ```powershell + Uninstall-Module -Name ExchangeOnlineManagement + ``` + +For detailed syntax and parameter information, see [Uninstall-Module](/powershell/module/powershellget/uninstall-module). + +## Properties and property sets in the Exchange Online PowerShell module + +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 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) + +In those cmdlets, property sets are controlled by the following parameters: + +- _PropertySets_: This parameter accepts one or more available property set names separated by commas. The available property sets are described in [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). +- _Properties_: This parameter accepts one or more property names separated by commas. + +You can use the _PropertySets_ and _Properties_ parameters together in the same command. + +We also included a Minimum property set that includes a bare minimum set of required properties for the cmdlet output (for example, identity properties). The properties in the Minimum property sets are also described in [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). + +- If you don't use the _PropertySets_ or _Properties_ parameters, you automatically get the properties in the Minimum property set. +- If you use the _PropertySets_ or _Properties_ parameters, you get the specified properties **and** the properties in the Minimum property set. + +Either way, the cmdlet output contains far fewer properties, and the results are returned much faster. + +For example, after you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md), the following example returns only the properties in the Minimum property set for the first 10 mailboxes. + +```powershell +Get-EXOMailbox -ResultSize 10 +``` + +In contrast, the output of the same **Get-Mailbox** command would return at least 230 properties for each of the first 10 mailboxes. + +> [!NOTE] +> Although the _PropertySets_ parameter accepts the value All, we highly discourage using this value to retrieve all properties, because it slows down the command and reduces reliability. Always use the _PropertySets_ and _Properties_ parameters to retrieve the minimum number of properties that are required for your scenario. + +For more information about filtering in the module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). + +## Release notes + +Unless otherwise noted, the current release of the Exchange Online PowerShell module contains all features of previous releases. + +### Current release + +#### Version 3.7.2 + +- The _DisableWAM_ switch is available on the **Connect-ExchangeOnline** cmdlet to disable Web Account Manager (WAM) if you get WAM-related connection errors. + +### Previous releases + +#### Version 3.7.1 + +- Added a new property named `ExoExchangeSecurityDescriptor` to the output of **Get-EXOMailbox** that's similar to the `ExchangeSecurityDescriptor` property in the output of **Get-Mailbox**. +- Added new cmdlets to support the Viva Org Insights Delegation feature: + - **Add-VivaOrgInsightsDelegatedRole** + - **Get-VivaOrgInsightsDelegatedRole** + - **Remove-VivaOrgInsightsDelegatedRole** + +#### Version 3.7.0 + +- Integrated Web Account Manager (WAM) in authentication flows to enhance security. +- Command line help for Exchange Online PowerShell cmdlets is no longer loaded by default. Use the _LoadCmdletHelp_ switch in the **Connect-ExchangeOnline** command so help for Exchange Online PowerShell cmdlets is available to the **Get-Help** cmdlet. +- Fixed connection issues with app only authentication in Security & Compliance PowerShell. + +#### Version 3.6.0 + +- **Get-VivaModuleFeature** now returns information about the kinds of identities that the feature supports creating policies for (for example, users, groups, or the entire tenant). +- Cmdlets for Viva feature access management now handle continuous access evaluation (CAE) claim challenges. +- Added fix for compatibility issue with the Microsoft.Graph module. + +#### Version 3.5.1 + +- Bug fixes in **Get-EXOMailboxPermission** and **Get-EXOMailbox**. +- The module has been upgraded to run on .NET 8, replacing the previous version based on .NET 6. +- Enhancements in **Add-VivaModuleFeaturePolicy**. + +#### Version 3.5.0 + +- New **Get-VivaFeatureCategory** cmdlet. +- Added support for policy operations at the category level in Viva Feature Access Management (VFAM). +- New IsFeatureEnabledByDefault property in the output of **Get-VivaModuleFeaturePolicy**. The value of this property shows the default enablement state for users in the tenant when no tenant or user/group policies were created. + +#### Version 3.4.0 + +- Bug fixes in **Connect-ExchangeOnline**, **Get-EXORecipientPermission**, and **Get-EXOMailboxFolderPermission**. +- The _SigningCertificate_ parameter in **Connect-ExchangeOnline** now supports [Constrained Language Mode (CLM)](/powershell/module/microsoft.powershell.core/about/about_language_modes#constrainedlanguage-mode). + +#### Version 3.3.0 + +- _SkipLoadingCmdletHelp_ parameter on **Connect-ExchangeOnline** to support skip loading cmdlet help files. +- Global variable `EXO_LastExecutionStatus` is available to check the status of the last cmdlet that was run. +- Bug fixes in **Connect-ExchangeOnline** and **Connect-IPPSSession**. +- _IsUserControlEnabled_ parameter on **Add-VivaModuleFeaturePolicy** and **Update-VivaModuleFeaturePolicy** to support the enablement of user controls by policy for features that are onboarded to Viva feature access management. + +#### Version 3.2.0 + +- New cmdlets: + - **Get-DefaultTenantBriefingConfig** and **Set-DefaultTenantBriefingConfig**. + - **Get-DefaultTenantMyAnalyticsFeatureConfig** and **Set-DefaultTenantMyAnalyticsFeatureConfig**. + - **Get-VivaModuleFeature**, **Get-VivaModuleFeatureEnablement**, **Add-VivaModuleFeaturePolicy**, **Get-VivaModuleFeaturePolicy**, **Remove-VivaModuleFeaturePolicy**, and **Update-VivaModuleFeaturePolicy**. +- REST API connection support for Security & Compliance PowerShell. +- _ConnectionId_ parameter on **Get-ConnectionInformation** and **Disconnect-ExchangeOnline**: + - Get connection information for specific REST API connections. + - Selective disconnect for REST API connections. +- _SigningCertificate_ parameter on **Connect-ExchangeOnline** allows you to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that **Connect-ExchangeOnline** creates with a client certificate to use in all PowerShell execution policies. +- Bug fixes in **Connect-ExchangeOnline**. + +#### Version 3.1.0 + +- _AccessToken_ parameter available in **Connect-ExchangeOnline**. +- Bug fixes in **Connect-ExchangeOnline** and **Get-ConnectionInformation**. +- Bug fix in **Connect-IPPSSession** for connecting to Security & Compliance PowerShell using _CertificateThumbprint_. + +#### Version 3.0.0 (Preview versions known as v2.0.6-PreviewX) + +- Features already described in the [REST API connections in the EXO V3 module](#rest-api-connections-in-the-exo-v3-module) section: + - [Certificate based authentication](app-only-auth-powershell-v2.md) for Security & Compliance PowerShell (version 2.0.6-Preview5 or later). + - The [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet for REST-based connections (version 2.0.6-Preview7 or later). + - The _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet for REST-based connections (version 2.0.6-Preview8 or later). +- The _DelegatedOrganization_ parameter works in the **Connect-IPPSSession** cmdlet as long as you also use the _AzureADAuthorizationEndpointUri_ parameter in the command. +- Certain cmdlets that used to prompt for confirmation in specific scenarios no longer do so. By default, the cmdlet runs to completion. +- The format of the error returned from failed cmdlet execution is slightly modified. The exception now contains more data (for example, the exception type), and the `FullyQualifiedErrorId` doesn't contain the `FailureCategory`. The format of the error is subject to further modification. + +#### Version 2.0.5 + +- New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlets to manage ownerless Microsoft 365 groups. + + > [!NOTE] + > Although the _cmdlets_ are available in the module, the _feature_ is only available to members of a Private Preview. + +- New **Get-VivaInsightsSettings** and **Set-VivaInsightsSettings** cmdlets to control user access to Headspace features in Viva Insights. + +#### Version 2.0.4 + +- PowerShell 7 is officially supported in Windows, Linux, and Apple macOS as described in the [Prerequisites for the Exchange Online PowerShell module](#prerequisites-for-the-exchange-online-powershell-module) section in this article. + +- The module in PowerShell 7 supports browser-based single sign-on (SSO) and other sign in methods. For more information, see [PowerShell 7 exclusive connection methods](connect-to-exchange-online-powershell.md#powershell-7-exclusive-connection-methods). + +- The **Get-UserAnalyticsConfig** and **Set-UserAnalyticsConfig** cmdlets were replaced by the **Get-MyAnalyticsConfig** and **Set-MyAnalyticsConfig**. Additionally, you can configure access at feature level. For more information, see [Configure MyAnalytics](/workplace-analytics/myanalytics/setup/configure-myanalytics). + +- Real-time policy and security enforcement in all user based authentication. Continuous Access Evaluation (CAE) is enabled in the module. Read more about CAE [here](https://techcommunity.microsoft.com/t5/azure-active-directory-identity/moving-towards-real-time-policy-and-security-enforcement/ba-p/1276933). + +- The _LastUserActionTime_ and _LastInteractionTime_ properties are now available in the output of the **Get-EXOMailboxStatistics** cmdlet. + +- The interactive sign-in process now uses a more secure method to fetch access tokens using safe reply URLs. + +#### Version 2.0.3 + +- General availability of certificate based authentication (CBA), which enables using modern authentication in unattended scripting or background automation scenarios. The available certificate storage locations are: + - 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). +- 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. + +#### 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. +- 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. + +#### Version 0.4578.0 + +- Added support for configuring the Briefing Email for your organization at the user level with **Set-UserBriefingConfig** and **Get-UserBriefingConfig** cmdlets. +- Support for session cleanup using **Disconnect-ExchangeOnline** cmdlet. This cmdlet is the V2 equivalent of `Get-PSSession | Remove-PSSession`. In addition to cleaning up session object and local files, it also removes the access token from cache, which is used for authenticating against V2 cmdlets. +- 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. + +#### 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. + +#### Version 0.3582.0 + +- Support for prefix during session creation: + - You can create only one session at a time that contains prefixed cmdlets. + - EXO V2 cmdlets aren't prefixed because they already have the prefix EXO, so don't use `EXO` as a prefix. +- Use EXO V2 cmdlets even if WinRM Basic Auth is disabled on client machine. Remote PowerShell connections require WinRM Basic Auth, and remote PowerShell cmdlets aren't available if Basic Auth is disabled in WinRM. +- Identity parameter for V2 cmdlets now supports Name and Alias. Using Alias or Name slows down the performance of V2 cmdlets, so we don't recommend using them. +- Fixed issue where the data type of attributes returned by V2 cmdlet was different from remote PowerShell cmdlets. We still have few attributes with differing data types, and we plan to handle them in coming months. +- Fixed bug: Frequent sessions reconnect issue when Connect-ExchangeOnline was invoked with Credentials or UserPrincipalName + +#### Version 0.3555.1 + +- Fixed a bug where piped cmdlets were failing with the following error due to an authentication issue: + > Cannot invoke the pipeline because the runspace isn't in the Opened state. Current state of the runspace is 'Closed'. + +#### Version 0.3527.4 + +- Updated Get-Help content. +- Fixed an issue in **Get-Help** where the _Online_ parameter was redirecting to a nonexistent page with error code 400. + +#### Version 0.3527.3 + +- Added support for managing Exchange for a different tenant using delegation flow. +- Works in tandem with other PowerShell modules in a single PowerShell window. +- Added support for positional parameters. +- Date Time field now supports client locale. +- Bug fix: PSCredential empty when passed during Connect-ExchangeOnline. +- Bug fix: Client module error when filter contained $null. +- Sessions created internal to EXO V2 Module now have names (naming pattern: ExchangeOnlineInternalSession_%SomeNumber%). +- Bug fix: Remote PowerShell cmdlets intermittently failing due to time the difference between token expiry and the Session going idle. +- Major security update. +- Bug fixes and enhancements. diff --git a/exchange/docs-conceptual/exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online-powershell.md new file mode 100644 index 0000000000..348084ae8d --- /dev/null +++ b/exchange/docs-conceptual/exchange-online-powershell.md @@ -0,0 +1,46 @@ +--- +title: "Exchange Online PowerShell" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 05/07/2025 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: 1cb603b0-2961-4afe-b879-b048fe0f64a2 +search.appverid: MET150 +description: "Learn about articles that are available for using PowerShell in Exchange Online." +--- + +# Exchange Online PowerShell + +Exchange Online PowerShell is the administrative interface that enables you to manage the Exchange Online part of your Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365). For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following articles provide information about using Exchange Online PowerShell: + +- To learn about the 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). + + To learn about different methods to connect to Exchange Online PowerShell, see the following articles: + + - [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). + - [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + - [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md) + +- To block or allow access to Exchange Online PowerShell in your organization, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). + +- To learn about the structure and layout of the cmdlet reference articles in Exchange Online PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). + +- To find the permissions that you need to run a specific cmdlet, or one or more parameters on a cmdlet, see [Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md). + +- 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 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 new file mode 100644 index 0000000000..93e9dd4bf7 --- /dev/null +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -0,0 +1,39 @@ +--- +title: "Exchange Online Protection PowerShell" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/1/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: f7918a88-774a-405e-945b-bc2f5ee9f748 +description: "Learn about the articles that are available for using PowerShell in Exchange Online Protection (EOP) only organizations without cloud mailboxes." +--- + +# Exchange Online Protection PowerShell + +Exchange Online Protection PowerShell is the administrative interface that enables you to manage 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. + +> [!TIP] +> Microsoft 365 organizations with cloud mailboxes (Microsoft 365 A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, etc.) use [Exchange Online PowerShell](exchange-online-powershell.md) to manage these same features. + +Exchange Online Protection PowerShell includes the following environments: + +- **Standalone EOP organizations**: Your Microsoft 365 subscription includes no Exchange Online mailboxes, because you use EOP to protect your on-premises email environment. +- **Exchange Enterprise CAL with Services**: The licenses for your on-premises Exchange organization include Exchange Enterprise CAL with Services (EOP is one of the services). + +The following articles provide information about using Exchange Online Protection PowerShell: + +- To learn about the 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 what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). + +- To connect to Exchange Online Protection PowerShell, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). + +- To learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). diff --git a/exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md deleted file mode 100644 index 0f26c4218f..0000000000 --- a/exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: "Connect to Exchange Online PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 7/10/2017 -ms.audience: Admin -ms.topic: article -ms.service: exchange-online -localization_priority: Priority -ms.collection: Strat_EX_Admin -ms.custom: -ms.assetid: c8bea338-6c1a-4bdf-8de0-7895d427ee5b -search.appverid: MET150 -description: "Learn how to use remote PowerShell to connect to Exchange Online." ---- - -# Connect to Exchange Online PowerShell -Exchange Online PowerShell allows you to manage your Exchange Online settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online. It's a simple three-step process where you enter your Office 365 credentials, provide the required connection settings, and then import the Exchange Online cmdlets into your local Windows PowerShell session so that you can use them. - -> [!IMPORTANT] -> If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you need to download and use the Exchange Online Remote PowerShell Module. For more information, see [Connect to Exchange Online PowerShell using multi-factor authentication](mfa-connect-to-exchange-online-powershell.md). If you're an Exchange Online Protection (EOP) standalone customer, and you're using the service to protect on-premises mailboxes, use the connection instructions in the topic [Connect to Exchange Online Protection PowerShell](../../exchange-eop/connect-to-exchange-online-protection-powershell.md). If your EOP subscription is Exchange Enterprise CAL with Services (includes data loss prevention (DLP) and reporting using web services), the connection instructions in this topic will work for you. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- You can use the following versions of Windows: - - - Windows 10 - - - Windows 8.1 - - - Windows Server 2016 - - - Windows Server 2012 or Windows Server 2012 R2 - - - Windows 7 Service Pack 1 (SP1)* - - - Windows Server 2008 R2 SP1* - - * For older versions of Windows, you need to install the Microsoft.NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868), [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757), [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - `Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.` - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ``` - Set-ExecutionPolicy RemoteSigned - ``` - - You need to configure this setting only once on your computer, not every time you connect. - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online PowerShell - -1. On your local computer, open Windows PowerShell and run the following command. - - ``` - $UserCredential = Get-Credential - ``` - In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**. - -2. Run the following command. - - ``` - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell` - - - For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/` - - - If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where the _ProxyAccessType_ value is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. - - Then, add the following parameter and value to the end of the $Session = ... command: `-SessionOption $ProxyOptions`. - - For more information, see [New-PSSessionOption](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption). - -3. Run the following command. - - ``` - Import-PSSession $Session -DisableNameChecking - ``` - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. - -``` -Remove-PSSession $Session -``` - -## How do you know this worked? - -After Step 3, the Exchange Online cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to your Exchange Online organization. - -- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](../disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -## See also - -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. - -- [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkId=389618) - -- [New-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389621) - -- [Import-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389619) - -- [Remove-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389620) - -- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623) - -For more information about managing Office 365, see [Manage Office 365](https://docs.microsoft.com/en-us/Office365/). - diff --git a/exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md deleted file mode 100644 index 1ca9df6e95..0000000000 --- a/exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: "Connect to Exchange Online PowerShell using multi-factor authentication" -ms.author: chrisda -author: chrisda -ms.date: 10/24/2017 -ms.audience: Admin -ms.topic: article -ms.service: exchange-online -localization_priority: Normal -ms.assetid: 04dae4ce-34a7-49c5-bf75-11e72452e04a -search.appverid: MET150 -description: "Learn how to connect to Exchange Online PowerShell by using multi-factor authentication (MFA)." ---- - -# Connect to Exchange Online PowerShell using multi-factor authentication -If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you can't use the instructions at [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) to use remote PowerShell to connect to Exchange Online. MFA requires you to install the Exchange Online Remote PowerShell Module, and use the **Connect-EXOPSSession** cmdlet to connect. - -> [!NOTE] -> • You can't use the Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell and Security & Compliance Center PowerShell in the same session (window). You need to use separate sessions of the Exchange Online Remote PowerShell Module.
• Delegated Access Permission (DAP) partners can't use the procedures in this topic to connect to their customer tenant organizations in Exchange Online PowerShell. MFA and the Exchange Online Remote PowerShell Module don't work with delegated authentication. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- You can use the following versions of Windows: - - - Windows 10 - - - Windows 8.1 - - - Windows Server 2016 - - - Windows Server 2012 or Windows Server 2012 R2 - - - Windows 7 Service Pack 1 (SP1)* - - - Windows Server 2008 R2 SP1* - - * For older versions of Windows, you need to install the Microsoft.NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868), [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757), [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- The Exchange Online Remote PowerShell Module needs to be installed on your computer: - - 1. In Internet Explorer or Edge, open the Exchange admin center (EAC) for your Exchange Online organization. For instructions, see [Exchange Admin Center in Exchange Online](http://technet.microsoft.com/library/ace44f6b-4084-4f9c-89b3-e0317962472b.aspx). - - **Note**: Internet Explorer or Edge is required because the download in the next step uses ClickOnce, so Google Chrome or Mozilla Firefox won't work. - - 2. In the EAC, go to **Hybrid** > **Setup** and click the appropriate **Configure** button to download the Exchange Online Remote PowerShell Module for multi-factor authentication. - - ![Download the Exchange Online PowerShell Module from the Hybrid tab in the EAC](../../media/24645e56-8b11-4c0f-ace4-09bdb2703562.png) - - 3. In the **Application Install** window that opens, click **Install**. - - ![Click Install in the Exchange Online PowerShell Module window](../../media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png) - -- Windows Remote Management (WinRM) on your computer needs to allow basic authentication (it's enabled by default). To verify that basic authentication is enabled, run this command in a Command Prompt: - - ``` - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command to enable basic authentication for WinRM: - - ``` - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - If basic authentication is disabled, you'll get this error when you try to connect: - - `The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again.` - -- When you use the Exchange Online Remote PowerShell Module, your session will end after one hour, which can be problematic for long-running scripts or processes. To avoid this issue, use [Trusted IPs](https://docs.microsoft.com/azure/active-directory/authentication/howto-mfa-mfasettings#trusted-ips) to bypass MFA for connections from your intranet. Trusted IPs allow you to connect to Exchange Online PowerShell from your intranet using the old instructions at [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). Also, if you have servers in a datacenter, be sure to add their public IP addresses to Trusted IPs as described [here](https://docs.microsoft.com/azure/active-directory/authentication/howto-mfa-mfasettings#enable-the-trusted-ips-feature-by-using-service-settings). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online PowerShell by using MFA - -1. On your local computer, open the **Exchange Online Remote PowerShell Module** ( **Microsoft Corporation** > **Microsoft Exchange Online Remote PowerShell Module**). - -2. The command that you need to run uses the following syntax: - - ``` - Connect-EXOPSSession -UserPrincipalName [-ConnectionUri -AzureADAuthorizationEndPointUri ] - ``` - - - _\_ is your Office 365 work or school account. - - - The _\_ and _\_ values depend on the location of your Office 365 organization as described in the following table: - - |**Office 365 offering**|**_ConnectionUri_ parameter value**|**_AzureADAuthorizationEndPointUri_ parameter value**| - |:-----|:-----|:-----| - |Office 365|Not used|Not used| - |Office 365 Germany|`https://outlook.office.de/PowerShell-LiveID`|`https://login.microsoftonline.de/common`| - - This example connects to Exchange Online in Office 365 using the account chris@contoso.com. - - ``` - Connect-EXOPSSession -UserPrincipalName chris@contoso.com - ``` - - This example connects to Exchange Online in Office 365 Germany using the account lukas@fabrikam.com. - - ``` - Connect-EXOPSSession -UserPrincipalName lukas@fabrikam.com -ConnectionUri https://outlook.office.de/PowerShell-LiveID -AzureADAuthorizationEndPointUri https://login.microsoftonline.de/common - ``` - -3. In the sign-in window that opens, enter your password, and then click **Sign in**. - - ![Enter your password in the Exchange Online Remote PowerShell window](../../media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png) - - A verification code is generated and delivered based on the verification response option that's configured for your account (for example, a text message or the Azure Authenticator app on your mobile phone). - -4. In the verification window that opens, enter the verification code, and then click **Sign in**. - - ![Enter your verification code in the Exchange Online Remote PowerShell window](../../media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png) - ->[!NOTE] ->Be sure to disconnect the remote PowerShell session when you're finished. If you close the Exchange Online Remote PowerShell Module window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect all currently open PowerShell sessions in the current window, run the following command: - -``` -Get-PSSession | Remove-PSSession -``` - -## How do you know this worked? - -After Step 4, the Exchange Online cmdlets are imported into your Exchange Online Remote PowerShell Module session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results. - -If you receive errors, check the following requirements: - -- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to your Exchange Online organization. - -- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](../disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. diff --git a/exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md deleted file mode 100644 index 19bec35dbe..0000000000 --- a/exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "Enable or disable access to Exchange Online PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: -ms.audience: Admin -ms.topic: article -ms.service: exchange-online -localization_priority: Normal -ms.assetid: f969816a-2607-4655-9d47-9e8767fb5633 -search.appverid: MET150 -description: "Admins can learn how to enable or disable access to Exchange Online PowerShell for users in their organization" ---- - -# Enable or disable access to Exchange Online PowerShell -Exchange Online PowerShell enables you to manage your Exchange Online organization from the command line. By default, all accounts you create in Office 365 are allowed to use Exchange Online PowerShell. Administrators can use Exchange Online PowerShell to enable or disable a user's ability to connect to Exchange Online PowerShell. Note that access to Exchange Online PowerShell doesn't give users extra administrative powers in your organization. A user's capabilities in Exchange Online PowerShell are still defined by role based access control (RBAC) and the roles that are assigned to them. - -## What do you need to know before you begin? - -- Estimated time to complete each procedure: less than 5 minutes - -- Office 365 global admins have access to Exchange Online PowerShell, and can use the procedures in this topic to configure Exchange Online PowerShell access for other users. For more information about permissions in Exchange Online, see [Feature Permissions in Exchange Online](http://technet.microsoft.com/library/15073ce1-0917-403b-8839-02a2ebc96e16.aspx). - -- You can only use Exchange Online PowerShell to perform this procedure. To learn how to use Windows PowerShell to connect to Exchange Online, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md). - - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Enable or disable access to Exchange Online PowerShell for a user - -This example disables access to Exchange Online PowerShell for the user david@contoso.com. - -``` -Set-User -Identity david@contoso.com -RemotePowerShellEnabled $false -``` - -This example enables access to Exchange Online PowerShell for the user david@contoso.com. - -``` -Set-User -Identity david@contoso.com -RemotePowerShellEnabled $true -``` - -## Disable access to Exchange Online PowerShell for many users - -To prevent access to Exchange Online PowerShell for a specific group of existing users, you have the following options: - -- **Filter users based on an existing attribute**: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes, such as Title, Department, address information, and telephone number, are visible only when you use the **Get-User** cmdlet. Other attributes, such as CustomAttribute1-15, are visible only when you use the **Get-Mailbox** cmdlet. - -- **Use a list of specific users**: After you generate the list of specific users, you can use that list to disable their access to Exchange Online PowerShell. - -### Filter users based on an existing attribute - -To disable access to Exchange Online PowerShell for any number of users based on an existing attribute, use the following syntax: - -``` -$ = -ResultSize unlimited -Filter -``` - -``` -$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} -``` - -This example removes access to Exchange Online PowerShell for all users whose **Title** attribute contains the value "Sales Associate". - -``` -$DSA = Get-User -ResultSize unlimited -Filter {(RecipientType -eq 'UserMailbox') -and (Title -like '*Sales Associate*')} -``` - -``` -$DSA | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} -``` - -### Use a list of specific users - -To disable access to Exchange Online PowerShell for a list of specific users, use the following syntax: - -``` -$ = Get-Content -``` - -``` -$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} -``` - -This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their accounts. The text file must contain one account on each line as follows: - -``` -akol@contoso.com -tjohnston@contoso.com -kakers@contoso.com -``` - -After you populate the text file with the user accounts you want to update, run the following commands: - -``` -$NPS = Get-Content "C:\My Documents\NoPowerShell.txt" -``` - -``` -$NPS | foreach {Set-User -Identity $_.MicrosoftOnlineServicesID -RemotePowerShellEnabled $false} -``` - -## View the Exchange Online PowerShell access for users - -To view the Exchange Online PowerShell access status for a specific user, use the following syntax: - -``` -Get-User -Identity | Format-List RemotePowerShellEnabled -``` - -This example displays the Exchange Online PowerShell access status of the user named Sarah Jones. - -``` -Get-User -Identity "Sarah Jones" | Format-List RemotePowerShellEnabled -``` - -To display the Exchange Online PowerShell access status for all users, run the following command: - -``` -Get-User -ResultSize unlimited | Format-Table -Auto Name,DisplayName,RemotePowerShellEnabled -``` - -To display only those users who don't have access to Exchange Online PowerShell, run the following command: - -``` -Get-User -ResultSize unlimited -Filter {RemotePowerShellEnabled -eq $false} -``` - -To display only those users who have access to Exchange Online PowerShell, run the following command: - -``` -Get-User -ResultSize unlimited -Filter {RemotePowerShellEnabled -eq $true} -``` diff --git a/exchange/docs-conceptual/exchange-online/exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online/exchange-online-powershell.md deleted file mode 100644 index a34923cee4..0000000000 --- a/exchange/docs-conceptual/exchange-online/exchange-online-powershell.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Exchange Online PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 2/20/2018 -ms.audience: Admin -ms.topic: article -ms.service: exchange-online -localization_priority: Normal -ms.assetid: 1cb603b0-2961-4afe-b879-b048fe0f64a2 -search.appverid: MET150 -description: "Learn about using PowerShell in Exchange Online" ---- - -# Exchange Online PowerShell - -Exchange Online PowerShell is the administrative interface that enables you to manage your Microsoft Exchange Online organization from the command line. For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following topics provide information about using Exchange Online PowerShell: - -- To create a remote PowerShell session to your Exchange Online organization, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md). - -- To prevent or allow connections to connect to your Exchange Online organization using remote PowerShell, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - -- The following introductory video shows you how to connect to and use Exchange Online PowerShell. - - **Note:** This video applies to Exchange Online and Exchange Online Protection (EOP) organizations. When you connect to your organization, be careful to specify the correct URL (*ConnectionUri* value). The required URL is different for Exchange Online and EOP organizations. - - [Use Remote PowerShell in EOP](https://videoplayercdn.osi.office.net/hub/?csid=ux-cms-en-us-msoffice&uuid=9cb28006-c2cb-45b6-b72e-eeed8767dee7&AutoPlayVideo=false) - - diff --git a/exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md b/exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md deleted file mode 100644 index c8ac46416b..0000000000 --- a/exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: "Connect to Exchange servers using remote PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 12/20/2016 -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Priority -ms.collection: Strat_EX_Admin -ms.custom: -ms.assetid: 0b5987c3-8836-456d-99f7-abc2ffb57300 -description: "Use Windows PowerShell on a local computer to connect to an Exchange Server." ---- - -# Connect to Exchange servers using remote PowerShell -If you don't have the Exchange management tools installed on your local computer, you can use Windows PowerShell to create a remote PowerShell session to an Exchange server. It's a simple three-step process, where you enter your credentials, provide the required connection settings, and then import the Exchange cmdlets into your local Windows PowerShell session so that you can use them. - -> [!NOTE] -> We recommend that you use the Exchange Management Shell on any computer that you use to extensively administer Exchange servers. You'll get the Exchange Management Shell by installing the Exchange management tools. For more information, see [Install the Exchange Server Management Tools](https://technet.microsoft.com/library/71fcbe4c-783b-4f77-aabb-a21aa7a4ef23.aspx) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md). For more information about the Exchange Management Shell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). - -## What do you need to know before you begin? - -- Estimated time to complete: less than 5 minutes - -- You can use the following versions of Windows: - - - Windows 10 - - - Windows 8.1\* - - - Windows Server 2016 - - - Windows Server 2012 R2\* - - - Windows Server 2012\*\* - - \* You need to install the Microsoft .NET Framework 4.5.2 or later. For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868). - - \*\* After you install the .NET Framework 4.5.2 or later, you also need to install the Windows Management Framework 4.0. For more information, see [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - `Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.` - - To require all scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ``` - Set-ExecutionPolicy RemoteSigned - ``` - - You need to configure this setting only once on your computer, not every time you connect. - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612). - -## Connect to a remote Exchange server - -1. On your local computer, open Windows PowerShell, and run the following command: - - ``` - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box that opens, enter your user principal name (UPN) (for example, `chris@contoso.com`) and password, and then click **OK**. - -2. Replace `` with the fully qualified domain name of your Exchange server (for example, `mailbox01.contoso.com`) and run the following command: - - ``` - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri http:///PowerShell/ -Authentication Kerberos -Credential $UserCredential - ``` - - **Note**: The _ConnectionUri_ value is `http`, not `https`. - -3. Run the following command: - - ``` - Import-PSSession $Session -DisableNameChecking - ``` - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: - - ``` - Remove-PSSession $Session - ``` - -## How do you know this worked? - -After Step 3, the Exchange cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange cmdlet (for example, **Get-Mailbox**) and review the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again, and pay close attention to the user name and password you enter in Step 1. - -- The account you use to connect to the Exchange server needs to be enabled for remote PowerShell access. For more information, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). - -- TCP port 80 traffic needs to be open between your local computer and the Exchange server. It's probably open, but it's something to consider if your organization has a restrictive network access policy. - -## See also - -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. - -- [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkId=389618) - -- [New-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389621) - -- [Import-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389619) - -- [Remove-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389620) - -- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623) - - diff --git a/exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md b/exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md deleted file mode 100644 index f099239d6f..0000000000 --- a/exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: "Control remote PowerShell access to Exchange servers" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 9/30/2015 -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: 064e3bb0-38bf-495e-9994-784f823b88dd -description: "Administrators can learn how to block or allow users' remote PowerShell access to Exchange servers." ---- - -# Control remote PowerShell access to Exchange servers -Remote PowerShell in Microsoft Exchange allows you to manage your Exchange organization from a remote computer that's on your internal network or from the Internet. You can disable or enable a user's ability to connect to an Exchange server using remote PowerShell. For more information about remote PowerShell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). - -For additional management tasks related to remote PowerShell, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). - -## What do you need to know before you begin? - -- Estimated time to complete each procedure: less than 5 minutes - -- You can only use PowerShell to perform this procedure. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). - -- By default, all user accounts have access to remote PowerShell. However, to actually use remote PowerShell to connect to an Exchange server, the user needs to be a member of a management role group, or be directly assigned a management role that enables the user to run Exchange cmdlets. For more information about role groups and management roles, see [Permissions](https://technet.microsoft.com/library/d8dd605e-0af1-4e18-9ce6-e51d04e161ba.aspx). - -- 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 and Shell Infrastructure Permissions](https://technet.microsoft.com/library/3646a4e8-36b2-41fb-89a4-79b0963fcb11.aspx) topic. - - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612). - -## Use the Exchange Management Shell to enable or disable remote PowerShell access for a user - -This example disables remote PowerShell access for the user named Therese Lindqvist. - -``` -Set-User "Therese Lindqvist" -RemotePowerShellEnabled $false -``` - -This example enables remote PowerShell access for the user named Sirirat Kitjakarn. - -``` -Set-User "Sirirat Kitjakarn" -RemotePowerShellEnabled $true -``` - -## Use the Exchange Management Shell to disable remote PowerShell access for many users - -To prevent remote PowerShell access for a specific group of existing users, you have the following options: - -- **Filter users based on an existing attribute**: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes, such as Title, Department, address information, and telephone number, are visible only when you use the **Get-User** cmdlet. Other attributes, such as CustomAttribute1-15, are visible only when you use the **Get-Mailbox** cmdlet. - -- **Use a list of specific users**: After you generate the list of specific users, you can use that list to disable their access to remote PowerShell. - -### Filter users based on an existing attribute - -To disable access to remote PowerShell for any number of users based on an existing attribute, use the following syntax: - -``` -$ = -ResultSize unlimited -Filter -``` - -``` -$ | foreach {Set-User -RemotePowerShellEnabled $false} -``` - -This example removes access to remote PowerShell for all users whose **Title** attribute contains the value "Sales Associate". - -``` -$DSA = Get-User -ResultSize unlimited -Filter {(RecipientType -eq 'UserMailbox') -and (Title -like '*Sales Associate*')} -``` - -``` -$DSA | foreach {Set-User -RemotePowerShellEnabled $false} -``` - -### Use a list of specific users - -To disable access to remote PowerShell for a list of specific users, use the following syntax: - -``` -$ = Get-Content -``` - -``` -$ | foreach {Set-User -RemotePowerShellEnabled $false -``` - -This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their user principal name (UPN). The text file must contain one UPN on each line as follows: - -``` -akol@contoso.com -tjohnston@contoso.com -kakers@contoso.com -``` - -After you populate the text file with the user accounts you want to update, run the following commands: - -``` -$NPS = Get-Content "C:\My Documents\NoPowerShell.txt" -``` - -``` -$NPS | foreach {Set-User -RemotePowerShellEnabled $false} -``` - -## View the remote PowerShell access for users - -To view the remote PowerShell access status for a specific user, use the following syntax: - -``` -Get-User -Identity | Format-List RemotePowerShellEnabled -``` - -This example displays the remote PowerShell access status of the user named Sarah Jones. - -``` -Get-User -Identity "Sarah Jones" | Format-List RemotePowerShellEnabled -``` - -To display the remote PowerShell access status for all users, run the following command: - -``` -Get-User -ResultSize unlimited | Format-Table -Auto Name,DisplayName,RemotePowerShellEnabled -``` - -To display only those users who don't have access to remote PowerShell, run the following command: - -``` -Get-User -ResultSize unlimited -Filter {RemotePowerShellEnabled -eq $false} -``` - -To display only those users who have access to remote PowerShell, run the following command: - -``` -Get-User -ResultSize unlimited -Filter {RemotePowerShellEnabled -eq $true} -``` diff --git a/exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md b/exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md deleted file mode 100644 index d83743fa2b..0000000000 --- a/exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: "Exchange cmdlet syntax" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 11/30/2015 -ms.audience: Admin -ms.topic: article -ms.service: exchange-online -localization_priority: Normal -ms.assetid: 85ffe9c8-7f03-4877-8e55-3cbd40228d84 -description: "Learn about the structure and syntax of cmdlets in Exchange, Exchange Online, Exchange Online Protection, and the Office 365 Security & Compliance Center." ---- - -# Exchange cmdlet syntax -Exchange cmdlet reference topics use a standardized method that describes key aspects about the cmdlet. For example: - -- Parameters that are available on the cmdlet. - -- Values that each parameter accepts. - -- Parameters that can be used together, and parameters that need to be used separately. - -This topic explains these conventions, and also the syntax that's 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 ]`. Parameter-value pairs that aren't enclosed in square brackets are required.| -|\| |Pipe symbols in parameter values indicate a choice between values. For example, -Enabled \<$true \| $false\> indicates the _Enabled_ parameter can have the value `$true` or `$false`.| - -These command conventions help you understand how a command is constructed. With the exception of the hyphen that indicates a parameter, you don't use these symbols as they're described in the table when you run cmdlets in Exchange PowerShell. - -## Parameter sets in Exchange PowerShell -Parameter sets are groups of parameters that can be used with each other in the same command. Parameters that exist different parameter sets are mutually exclusive (they can't be used together in the same command). - -Many cmdlets have only one parameter set, which means that all available parameters can be used with each other. Other cmdlets have several parameter sets, which indicates some parameters perform functions that are incompatible with other parameters. For example, suppose the following parameter sets are available on the **New-SystemMessage** cmdlet: - -``` -New-SystemMessage -DsnCode -Internal <$true | $false> -Language -Text [-Confirm []] [-DomainController ] [-WhatIf []] - -New-SystemMessage -Language -QuotaMessageType -Text [-Confirm []] [-DomainController ] [-WhatIf []] -``` - -This cmdlet has two separate parameter sets. This indicates that you can use these parameters together in the same command: - -- _DsnCode_ - -- _Internal_ - -- _Language_ - -- _Text_ - -- _Confirm_ - -- _DomainController_ - -- _WhatIf_ - -And you can use these parameters together in the same command: - -- _Language_ - -- _QuotaMessageType_ - -- _Text_ - -- _Confirm_ - -- _DomainController_ - -- _WhatIf_ - -But you can't use these parameters together in the same command: - -- _DsnCode_ and _QuotaMessageType_. - -- _Internal_ and _QuotaMessageType_. - -The `` entry indicates the cmdlet supports the basic Windows PowerShell parameters that are available on virtually any cmdlet (for example, _Debug_). You can use common parameters with parameters from any parameter set. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## Quotation marks in Exchange PowerShell -In Exchange PowerShell, you use single quotation marks ( ' ) or double quotation marks ( " ) to enclose parameter values that contain spaces. For example, the following commands behave the same: - -- `Get-ReceiveConnector -Identity "Contoso Receive Connector"` - -- `Get-ReceiveConnector -Identity 'Contoso Receive Connector'` - -If you don't enclose the value `Contoso Receive Connector` in quotes, Exchange PowerShell tries to treat each word as a new argument, and the command will fail. In this example, you'll receive an error that looks like this: - - `A positional parameter cannot be found that accepts argument 'Receive'` - -If the value contains variables, you need choose carefully between single quotes and double quotes. For example, suppose you have a variable named `$Server` that has the value `Mailbox01`. - -- **Double quotation marks**: Variables are substituted with their values. The input **"$Server Example"** results in the output `Mailbox01 Example`. - -- **Single quotation marks**: Variables are treated literally. The input **'$Server Example'** results in the output `$Server Example`. - -For more information about variables, see [User-Defined Variables](https://technet.microsoft.com/library/8af62634-2e0b-4da0-ae94-a890f6f24d8a.aspx) and [Shell Variables](https://technet.microsoft.com/library/a601c3d9-534d-4155-9a8e-73ef2c2229f2.aspx). - -## Escape characters in Exchange PowerShell -In any programming language, an escape character is used to identify special characters literally, and not by their normal function in that language. In Exchange PowerShell, when you enclose a text string in double quotation marks, the escape character is the back quotation mark escape character ( \` ). - -For example, if you want the output `The price is $23`, enter the value **"The price is \`$23"**. The escape character is required because the dollar sign character ( $ ) defines variables in Exchange PowerShell. - -If you enclose the string in single quotation marks, the only special character you need to worry about is the single quotation mark character itself, which requires two single quotation marks ( '' ). - - For example, if you want the output `Don't confuse two single quotation marks with a double quotation mark!`, enter the value **'Don''t confuse two single quotation marks with a double quotation mark!'**. - -## 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 section. However, these symbols have different meanings when they're used on the command line as operators. For example, the minus sign that's used to indicate a parameter can also be used in a command as a mathematical operator. - -|**Operator**|**Description**| -|:-----|:-----| -|**=** | The equal sign is used as an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side of the equal sign. The following characters are also assignment characters:
• **+=**: Add the value on the right side of the equal sign to the current value that's contained in the variable on the left side of the equal sign.
• **-=**: Subtract the value on the right side of the equal sign from the current value that's contained in the variable on the left side of the equal sign.
• **\*=**: Multiply the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
• **/=**: Divide the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
• **%=**: Modify the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign. | -|**:** | A colon can be used to separate a parameter's name from the parameter's value. For example, `-Enabled:$True`. Using a colon is optional with all parameter types except switch parameters. For more information about switch parameters, see [Parameters](https://technet.microsoft.com/library/bc81f639-c822-4b2b-a692-694c43f5f57e.aspx). | -|**!** | The exclamation point is a logical **NOT** operator. When it is used with the equal ( **=** ) sign, the combined pair means "not equal to." | -|**[ ]** | Brackets are used to specify the index value of an array position. Index values are offsets that start at zero. For example, `$Red[9]` refers to the tenth index position in the array, `$Red`.
Brackets can also be used to assign a type to a variable (for example, `$A=[XML] "value"`). The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.` | -|**{ }** |Braces are used to include an expression in a command. For example, Get-Process \| Where {$\_.HandleCount -gt 400} | -|**\|** |The pipe symbol is used when one cmdlet pipes a result to another cmdlet. For example, Get-Mailbox -Server SRV1 \| Set-Mailbox -ProhibitSendQuota 2GB. | -|**\>** |The right-angle bracket is used to send the output of a command to a file, and the contents of the file are overwritten. For example, `Get-TransportRulePredicate > "C:\My Documents\Output.txt"`. | -|**\>\>** |Double right-angle brackets are used to append the output of a command to an existing file. If the file doesn't exist, a new file is created. For example, `Get-TransportRulePredicate >> "C:\My Documents\Output.txt"`. | -|**"** |Double quotation marks are used to enclose text strings that contains spaces. | -|**$** |A dollar sign indicates a variable. For example, `$Blue = 10` assigns the value `10` to the variable `$Blue`. | -|**@** |The @ symbol references an associative array. For more information, see [Arrays](https://technet.microsoft.com/library/599ed6d7-553a-41be-b4a3-aa75ab9dbb5d.aspx). | -|**$( )** |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 **+** operator adds two values together. For example, `6 + 6` equals `12`. | -|**-** |The **-** 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 the wildcard character to match strings (for example, Get-User \| Where-Object {$\_.Department -like 'Sales*'}), multiply numeric values (for example, `6 * 6` equals `36`), or repeat the string value the specified number of times (for example, `"Test" * 3` equals `TestTestTest`).| -|**/** |The **/** operator divides one value by another. For example, `6 / 6` equals `1`. | -|**%** |In a numerical evaluation, the **%** operator returns the remainder from a division operator. For example, `6 % 4` equals `2`.
In a pipeline, the percent character ( `%` ) is 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}. For more information, see [Pipelining](https://technet.microsoft.com/library/59411ed3-926b-4eec-a462-84e6b26056c9.aspx). | -|**?** |The question mark character ( **?** ) is shorthand for the **Where-Object** cmdlet. For example, Get-Alias \| Where-Object {$\_.Definition -eq "Clear-Host"} is the same as Get-Alias \| ? {$\_.Definition -eq "Clear-Host"}| - - diff --git a/exchange/docs-conceptual/exchange-server/exchange-management-shell.md b/exchange/docs-conceptual/exchange-server/exchange-management-shell.md deleted file mode 100644 index 8dc45edf28..0000000000 --- a/exchange/docs-conceptual/exchange-server/exchange-management-shell.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Exchange Server PowerShell (Exchange Management Shell)" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 8/20/2015 -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: 925ad66f-2f05-4269-9923-c353d9c19312 -description: "Learn about Exchange Server PowerShell, also known as the Exchange Management Shell. This topic describes how PowerShell works on Exchange servers, and provides links to other topics that can help you learn how to use the Exchange Management Shell." ---- - -# Exchange Server PowerShell (Exchange Management Shell) -The Exchange Management Shell is built on Windows PowerShell technology and provides a powerful command-line interface that enables the automation of Exchange administration tasks. You can use the Exchange Management Shell to manage every aspect of Exchange. For example, you can create email accounts, create Send connectors and Receive connectors, configure mailbox database properties, and manage distribution groups. You can use the Exchange Management Shell to perform every task that's available in the Exchange graphical management tools, plus things that you can't do there (for example, bulk operations). In fact, when you do something in the Exchange admin center (EAC), the Exchange Control Panel (ECP), or the Exchange Management Console (EMC), it's the Exchange Management Shell that does the work behind the scenes. - -The Exchange Management Shell also provides a robust and flexible scripting platform. Visual Basic scripts that required many lines of code can be replaced by Exchange Management Shell commands that use as little as one line of code. The Exchange Management Shell provides this flexibility because it uses an object model that's based on the Microsoft .NET Framework. This object model enables Exchange cmdlets to apply the output from one command to subsequent commands. - -To start using the Exchange Management Shell immediately, see the [Exchange Management Shell documentation](exchange-management-shell.md#ShellDocs) section later in this topic. - -## How the Exchange Management Shell works on all Exchange server roles except Edge Transport - -Whether you use the Exchange Management Shell on a local Exchange server or on an Exchange server that's located across the country, remote PowerShell does the work. - -When you click the Exchange Management Shell shortcut on an Exchange server, the local instance of Windows PowerShell performs the following steps: - -1. Connect to the closest Exchange server (most often, the local Exchange server) using a required Windows PowerShell component called Windows Remote Management (WinRM). - -2. Perform authentication checks. - -3. Create a remote PowerShell session for you to use. - -You only get access to the Exchange cmdlets and parameters that are associated with the Exchange management role groups and management roles you're assigned. For more information about how Exchange uses role groups and roles to manage who can do what tasks, see [Permissions](https://technet.microsoft.com/library/d8dd605e-0af1-4e18-9ce6-e51d04e161ba.aspx). - -A benefit of remote PowerShell is that you can use Windows PowerShell on a local computer to connect to a remote Exchange server, and import the Exchange cmdlets in the Windows PowerShell session so you can administer Exchange. The only requirements for the computer are: - -- A supported operating system for Exchange Server. - -- A supported version of the .NET Framework. - -- A supported version of the Windows Management Framework (WMF), which includes WinRM and Windows PowerShell. - -For details, see the following topics: - -- [Exchange 2016 system requirements](https://technet.microsoft.com/library/aa996719(v=exchg.160).aspx) - -- [Exchange 2013 system requirements](https://technet.microsoft.com/library/aa996719(v=exchg.150).aspx) - -- [Exchange 2010 system requirements](https://technet.microsoft.com/library/aa996719(v=exchg.141).aspx) - -However, we recommend that you install the Exchange management tools (which includes the Exchange Management Shell) on any computer that you use to extensively manage Exchange 2016. Without the Exchange management tools installed, you need to connect to the remote Exchange server manually, and you don't have access to the additional capabilities that the Exchange management tools provide. - -For more information about connecting to Exchange servers without the Exchange management tools installed, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). - -## How Exchange Management Shell works on Edge Transport servers - -On Edge Transport servers, the Exchange Management Shell works differently. You typically deploy Edge Transport servers in your perimeter network, either as stand-alone servers or as members of a perimeter Active Directory domain. - -When you click the Exchange Management Shell shortcut on an Exchange Edge Transport server, the local instance of Windows PowerShell creates a local PowerShell session for you to use. - -Edge Transport servers don't use management roles or management role groups to control permissions. The local Administrators group controls who can configure the Exchange features on the local server. - -For more information about Edge Transport servers, see [Edge Transport Servers](https://technet.microsoft.com/library/cfff9f59-afac-447c-8297-afcebe49a52d.aspx). - -## Exchange Management Shell documentation - - -The following table provides links to topics that can help you learn about and use the Exchange Management Shell. - -|**Topic**|**Description**| -|:-----|:-----| -|[Open the Exchange Management Shell](open-the-exchange-management-shell.md)|Find and open the Exchange Management Shell on an Exchange server or a computer that has the Exchange management tools installed.| -|[Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md)|Use Windows PowerShell on a local computer to connect to an Exchange server.| -|[Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md)|Learn how to block or allow users' remote PowerShell access to Exchange servers.| -|[Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md)|Find the permissions you need to run a specific cmdlet, or one or more parameters on the cmdlet.| -|[Exchange cmdlet syntax](exchange-cmdlet-syntax.md)|Learn about the structure and syntax of cmdlets in Exchange PowerShell.| -|[Recipient filters in Exchange Management Shell commands](recipient-filters/recipient-filters.md)|Learn about recipient filters in the Exchange Management Shell.| -|[Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers](use-update-exchangehelp.md)|Learn how to use Update-ExchangeHelp to update help for Exchange cmdlet reference topics on Exchange servers.| \ No newline at end of file diff --git a/exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md deleted file mode 100644 index 673e98e046..0000000000 --- a/exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: "Find the permissions required to run any Exchange cmdlet" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 12/20/2016 -ms.audience: ITPro -ms.topic: article -ms.service: exchange-online -localization_priority: Normal -ms.assetid: 5bcc46d3-8a07-4e9f-b1b0-e4cb0b0afc12 -description: "Admins can learn how to use PowerShell to find the permissions required to run any Exchange or Exchange Online cmdlet." ---- - -# Find the permissions required to run any Exchange cmdlet -You can use PowerShell to find the permissions required to run any Exchange or Exchange Online cmdlet. This procedure shows the role-based access control (RBAC) management roles and role groups that give you access to a specified cmdlet—even if your organization has custom roles, custom role groups, or custom role assignments. - -## What do you need to know before you begin? - -- Estimated time to complete this procedure: less than 5 minutes. - -- You can only use PowerShell to perform this procedure. - -- Basically, you need to be an administrator to complete this procedure. Specifically, you need access to the **Get-ManagementRole** and **Get-ManagementRoleAssignment** cmdlets. By default, access to these cmdlets is granted by the View-Only Configuration or Role Management roles, which are assigned to the View-Only Organization Management and Organization Management role groups. - -- The procedures in this topic don't work in the Office 365 Security & Compliance Center. For more information about permissions in the Security & Compliance Center, see [Permissions in Office 365 Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). - -- The procedures in this topic don't work in Exchange Online Protection (EOP). For more information about permissions in EOP, see [Feature Permissions in EOP](https://technet.microsoft.com/library/34674847-a6b7-4a7e-9eaa-b64f22bc150d.aspx). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) or [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542). - -## Use PowerShell to find the permissions required to run a cmdlet - -1. Open the PowerShell environment where you want to run the cmdlet. - - - To learn how to use Windows PowerShell to connect to Exchange Online, see [Connect to Exchange Online PowerShell](../exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md). - - - To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). - -2. Run the following command to identify the cmdlet and, optionally, one or more parameters on the cmdlet. Be sure to replace `` and optionally, `,,...` with the actual cmdlet and parameter names you are interested in. If you specify multiple parameters separated by commas, only the roles that include **all** of the parameters are returned. - - ``` - $Perms = Get-ManagementRole -Cmdlet [-CmdletParameters ,,... ] - ``` - -3. Run the following command: - - ``` - $Perms | foreach {Get-ManagementRoleAssignment -Role $_.Name -Delegating $false | Format-Table -Auto Role,RoleAssigneeType,RoleAssigneeName} - ``` - -## Interpreting the results - -The results contain the following information: - -- **Role**: Indicates the role that gives access to the cmdlet or the combination of cmdlet and parameters. Note that role names that begin with "My" are user roles that allow regular users to operate on objects they own (for example, their own mailbox or their distribution groups). - -- **RoleAssigneeType** and **RoleAssigneeName**: These values are inter-related. **RoleAssigneeType** is the type of object that has the role assigned to it, and **RoleAssigneeName** is the name of the object. **RoleAssigneeType** can be a role group, role assignment policy, security group, or user. Typically, administrator roles are assigned to role groups. - -## Troubleshooting - -What if there are no results? - -- Verify that you entered the cmdlet and parameter names correctly. - -- You might have entered too many parameters, and all of the parameters on the cmdlet aren't defined in a single role. Try specifying only the cmdlet name in Step 2, and run Step 3 to verify that the cmdlet is available in your environment. Then, add parameters one at a time to Step 2 before running Step 3. - -- These possible causes have the same solution: - - - You might have entered a cmdlet or parameters that are defined in a role that isn't assigned to anyone by default. - - - You might have entered a cmdlet or parameter that isn't available in your environment. For example, when you enter an Exchange Online cmdlet or parameters in an on-premises Exchange 2016 environment. - - Run the following command to find the role that contains the cmdlet or parameters. Be sure to replace `` and optionally, `,,...` with the actual cmdlet and parameter names you are interested in. Note that you can use wildcard characters (*) in the cmdlet and parameter names (for example, `*-Mailbox*`). - - ``` - Get-ManagementRoleEntry -Identity *\ [-Parameters ,,... ] - ``` - - - If the command returns an error saying the object couldn't be found, the cmdlet or parameters aren't available in your environment. - - - If the command returns one or more entries for **Name**, **Role**, and **Parameters**, the cmdlet (or parameters on the cmdlet) is available in your environment, but the required role isn't assigned to anyone. To see all roles that aren't assigned to anyone, run the following command: - - ``` - $na = Get-ManagementRole ; $na | foreach {If ((Get-ManagementRoleAssignment -Role $_.Name -Delegating $false) -eq $null) {$_.Name}} - ``` - -## Related procedures - -- Management role scopes define where cmdlets can operate (in particular, write scopes). - - To include scope information in Step 2, substitute the following command: - - ``` - $Perms | foreach {Get-ManagementRoleAssignment -Role $_.Name -Delegating $false | Format-List Role,RoleAssigneeType,RoleAssigneeName,*Scope*} - ``` - -- To see all roles assigned to a specific user, run the following command: - - ``` - Get-ManagementRoleAssignment -RoleAssignee -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType - ``` - For example: - - ``` - Get-ManagementRoleAssignment -RoleAssignee julia@contoso.com -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType - ``` - -- To see all users who are assigned a specific role, run the following command: - - ``` - Get-ManagementRoleAssignment -Role "" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod - ``` - - For example: - - ``` - Get-ManagementRoleAssignment -Role "Mailbox Import Export" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod - ``` - - - -- To see the members of a specific role group, run the following command: - - ``` - Get-RoleGroupMember "" - ``` - - For example: - - ``` - Get-RoleGroupMember "Organization Management" - ``` diff --git a/exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md b/exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md deleted file mode 100644 index 7e044bd797..0000000000 --- a/exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Open the Exchange Management Shell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 10/27/2015 -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: 63976059-25f8-4b4f-b597-633e78b803c0 -description: "Find and open the shortcut for Exchange PowerShell (also known as the Exchange Management Shell) on Exchange 2016 servers or computers that have the Exchange management tools installed." ---- - -# Open the Exchange Management Shell -When you open the Exchange Management Shell you can perform administrative tasks on Exchange Server 2016 from the command line. You can open the Exchange Management Shell from the following locations: - -- On the Exchange server directly or in a Remote Desktop Connection session. - -- On a local computer after you install the Exchange management tools. For more information, see [Install the Exchange 2016 Management Tools](https://technet.microsoft.com/library/71fcbe4c-783b-4f77-aabb-a21aa7a4ef23.aspx). - -## What do you need to know before you begin? - -- Estimated time to complete this procedure: less than 1 minute. - -- The user must be assigned at least one management role. For detailed steps, see [Permissions](https://technet.microsoft.com/library/d8dd605e-0af1-4e18-9ce6-e51d04e161ba.aspx). - -- If you want to run the Exchange Management Shell from a local installation of the Exchange management tools, you need to consider remote PowerShell access for your user account. By default, users are allowed to use remote PowerShell to connect to an Exchange server. However, you can block remote PowerShell access for a user account. For more information, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612), [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Open the Exchange Management Shell in Windows 10 - -Click **Start** > **All Apps** > **Microsoft Exchange Server 2016 \>** **Exchange Management Shell**. - -## Open the Exchange Management Shell in Windows Server 2012 R2 or Windows 8.1 - -When you install Exchange 2016 on Windows Server 2012 R2 or the Exchange management tools on Windows 8.1, the Exchange Management Shell shortcut isn't automatically pinned to the Start screen. - -To pin the shortcut to the Start screen, do the following: - -1. On the Start screen, open the Apps view by clicking the down arrow near the lower-left corner or swiping up from the middle of the screen. - -2. The **Exchange Management Shell** shortcut is in a group named **Microsoft Exchange Server 2016**. When you find the shortcut, right-click it or press and hold it, and select **Pin to Start**. To pin it to the desktop taskbar, select **Pin to taskbar**. - -To use the Search charm to find and run the Exchange Management Shell, use one of the methods described in the next section. - -## Open the Exchange Management Shell in Windows Server 2012 - -When you install Exchange 2016 on Windows Server 2012, the Exchange Management Shell shortcut should automatically be pinned to the Start screen. - -If it's not, or if you just want to quickly find and run the Exchange Management Shell, use one of the following methods: - -- On the Start screen, click an empty area, and type Exchange Management Shell. When the shortcut appears in the search results, you can select it. - -- On the desktop or the Start screen, press Windows key + Q. In the Search charm, type Exchange Management Shell. When the shortcut appears in the results, you can select it. - -- On the desktop or the Start screen, move your cursor to the upper-right corner, or swipe left from the right edge of the screen to show the charms. Click the Search charm, and type Exchange Management Shell. When the shortcut appears in the results, you can select it. - -If you are using Remote Desktop Connection, you might need to use one of the following methods so the Search charm appears on the remote Exchange server and not on your local computer: - -- Open Remote Desktop Connection and click **Show Options** > **Local Resources** tab > **Apply Windows key combinations**. The default value is **Only when using the full screen**, but you can change it to **On the remote computer**. - -- While you're connected to the remote Exchange server, use the connection bar that appears at the top of the screen to open the Exchange server's Search charm or Start screen by clicking the down arrow and selecting **Charms** or **Start**. - - diff --git a/exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md b/exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md deleted file mode 100644 index dabb1455b2..0000000000 --- a/exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -title: "Filterable properties for the Filter parameter" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: b02b0005-2fb6-4bc2-8815-305259fa5432 -description: "Learn about the filterable properties for the Filter parameter in on-premises Exchange." ---- - -# Filterable properties for the Filter parameter -You use the _Filter_ parameter to create OPATH filters based on the properties of user and group objects in Exchange Server 2016. The _Filter_ parameter is available on these recipient cmdlets: - -- [Get-CASMailbox](../../../exchange-ps/exchange/client-access/get-casmailbox.md) - -- [Get-Contact](../../../exchange-ps/exchange/users-and-groups/get-contact.md) - -- [Get-DistributionGroup](../../../exchange-ps/exchange/users-and-groups/get-distributiongroup.md) - -- [Get-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/get-dynamicdistributiongroup.md) - -- [Get-Group](../../../exchange-ps/exchange/users-and-groups/get-group.md) - -- [Get-LinkedUser](../../../exchange-ps/exchange/users-and-groups/get-linkeduser.md) - -- [Get-Mailbox](../../../exchange-ps/exchange/mailboxes/get-mailbox.md) - -- [Get-MailContact](../../../exchange-ps/exchange/users-and-groups/get-mailcontact.md) - -- [Get-MailPublicFolder](../../../exchange-ps/exchange/sharing-and-collaboration/get-mailpublicfolder.md) - -- [Get-MailUser](../../../exchange-ps/exchange/users-and-groups/get-mailuser.md) - -- [Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md) - -- [Get-RemoteMailbox](../../../exchange-ps/exchange/federation-and-hybrid/get-remotemailbox.md) - -- [Get-SecurityPrincipal](../../../exchange-ps/exchange/users-and-groups/get-securityprincipal.md) - -- [Get-UMMailbox](../../../exchange-ps/exchange/unified-messaging/get-ummailbox.md) - -- [Get-User](../../../exchange-ps/exchange/users-and-groups/get-user.md) - -For more information, see [Recipient filters in Exchange Management Shell commands](recipient-filters.md). - - **Note**: The _Filter_ parameter is also available on other cmdlets (for example, **Get-MailboxStatistics**, **Get-Queue**, and **Get-Message** ). However, the property values that are accepted by the _Filter_ parameter on these cmdlets aren't similar to the user and group properties that are described in this topic. - -## Filterable properties - -The properties that have been _confirmed_ to work with the _Filter_ parameter in user and group cmdlets are described in the following table. - - **Notes**: - -- The list might include: - - - Properties that are only used in one type of environment: Microsoft Office 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is only meaningful (a value other than blank or `None`) in one type of environment. - - - Properties that are present, but correspond to features that are no longer used in Exchange 2016. - -- Not all recipient properties have a corresponding Active Directory property. The LDAP display name value in the table is "n/a" for these properties, which indicates that the property calculated (likely by Exchange). - -- Text string properties that accept wildcard characters require the `-like` operator (for example, `Property -like '*abc'`). - -- To look for blank or non-blank property values, use the value `$null` (for example, `{Property -eq $null}` or `{Property -ne $null`}). - -- For more information about creating filters in recipient commands, see [Additional OPATH syntax information](https://technet.microsoft.com/library/b22affa2-ef51-4e4e-b59c-a58620baf8aa.aspx#OPATH). - -|**Property name**|**LDAP display name**|**Available on cmdlets**|**Value**|**Comments**| -|:-----|:-----|:-----|:-----|:-----| -|_AcceptMessagesOnlyFrom_|_authOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter {AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'}` or `Get-DistributionGroup -Filter {AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter {AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'}`. or `Get-Mailbox -Filter {AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'}`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: Get-DistributionGroup -Identity "\" \| Format-List Name,DistinguishedName or Get-DynamicDistributionGroup -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: Get-MobileDevice -Mailbox \ \| Format-List.
After you have the device ID value, you can use it in the filter. For example, `Get-CasMailbox -Filter {(ActiveSyncAllowedDeviceIDs -like '*text1') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'}`.| -|_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: Get-MobileDevice -Mailbox \ \| Format-List.
After you have the device ID value, you can use it in a filter. For example, `Get-CasMailbox -Filter {(ActiveSyncBlockedDeviceIDs -like '*text1') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'}`.| -|_ActiveSyncEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CasMailbox -Filter {ActiveSyncEnable -eq $false}`.| -|_ActiveSyncMailboxPolicy_|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the ActiveSync mailbox policy. For example, `Get-CASMailbox -Filter {ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of ActiveSync mailbox policies by running this command: Get-MobileDeviceMailboxPolicy \| Format-List Name,DistinguishedName.
**Note**: For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the **ActiveSyncMailboxPolicy** property is blank ( `$null`).| -|_ActiveSyncSuppressReadReceipt_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CasMailbox -Filter {ActiveSyncSuppressReadReceipt -eq $true}`.| -|_AddressBookPolicy_|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the address book policy. For example, `Get-Mailbox -Filter {AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of address book policies by running this command: Get-AddressBookPolicy \| Format-List Name,DistinguishedName.| -|_AddressListMembership_|_showInAddressBook_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the address list. For example, `Get-MailContact -Filter {AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of address lists by running this command: Get-AddressList \| Format-List Name,DistinguishedName.| -|_AdminDisplayName_|_adminDisplayName_|**Get-SecurityPrincipal**|String (wildcards accepted) or `$null`|For example, Get-SecurityPrincipal -Filter {AdminDisplayName -ne $null} \| Format-Table -Auto Name,AdminDisplayName.| -|_AdministrativeUnits_|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String or `$null`|For example, `Get-User -Filter {AdministrativeUnits -ne $null}`.| -|_AggregatedMailboxGuids_|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter {AggregatedMailboxGuids -ne $null}`.| -|_Alias_|_mailNickname_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted)|For example, `Get-Recipient -Filter {Alias -like '*smith'}`.| -|_AllowUMCallsFromNonUsers_|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)|For example, `Get-User -Filter {AllowUMCallsFromNonUsers -ne 'SearchEnabled'}`.| -|_ArbitrationMailbox_|_msExchArbitrationMailbox_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the arbitration mailbox. For example, `Get-DistributionGroup -Filter {ArbitrationMailbox -eq 'CN=SystemMailbox{1f05a927-2e8f-4cbb-9039-2cfb8b95e486},CN=Users,DC=contoso,DC=com'}`.
You can find the distinguished names of arbitration mailboxes by running this command: Get-Mailbox -Arbitration \| Format-List Name,DistinguishedName.| -|_ArchiveDatabase_|_msExchArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the archive mailbox database. For example, `Get-Mailbox -Filter {ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase \| Format-List Name,DistinguishedName.| -|_ArchiveDomain_|_msExchArchiveAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is used in on-premises Exchange environments to identify the Office 365 organization that holds the archive mailbox. For example, `Get-Mailbox -Filter {ArchiveDomain -like '*contoso.onmicrosoft.com'}`.| -|_ArchiveGuid_|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter {ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'}`.
You can find the GUID of archive mailboxes by running this command: Get-Mailbox -Archive \| Format-Table -Auto Name,ArchiveGUID.| -|_ArchiveName_|_msExchArchiveName_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `null`|This filter requires the name of the archive mailbox. For example, `Get-Mailbox -Filter {ArchiveName -like 'In-Place Archive*'}`.
You can find the names of archive mailboxes by running this command: Get-Mailbox -Archive \| Format-Table -Auto Name,ArchiveName.| -|_ArchiveQuota_|_msExchArchiveQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {ArchiveQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {ArchiveQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.ArchiveQuota - ''}. For example, Get-Mailbox \| where {$_.ArchiveQuota -gt '85GB'}.| -|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {ArchiveWarningQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {ArchiveWarningQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.ArchiveWarningQuota - ''}. For example, Get-Mailbox \| where {$_.ArchiveWarningQuota -gt '85GB'}.| -|_ArchiveRelease_|_msExchArchiveRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter {ArchiveRelease -ne $null}`.| -|_ArchiveState_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|For example, `Get-Recipient -Filter {ArchiveState -eq 'HostedProvisioned'}`.| -|_ArchiveStatus_|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).|For example, `Get-Recipient -Filter {ArchiveStatus -eq 'Active'}`.| -|_AssistantName_|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {AssistantName -like 'Julia*'}`.| -|_AuditEnabled_|_msExchMailboxAuditEnable_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {AuditEnabled -eq $true}`.| -|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|**Get-Mailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: Get-Mailbox \| where {$_.AuditLogAgeLimit - ''}. For example, Get-Mailbox \| where {$_.AuditLogAgeLimit -gt '60.00:00:00'}.| -|_BlockedSendersHash_|_msExchBlockedSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter {BlockedSendersHash -ne $null}.`| -|_c_|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`|This filter requires the ISO 3166-1 two-letter country code for the user (for example, `S` for the United States). This property is used together with the _co_ and _countryCode_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter {c -eq 'US'}`.| -|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|**Get-Mailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {CalendarLoggingQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {CalendarLoggingQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.CalendarLoggingQuota - ''}. For example, Get-Mailbox \| where {$_.CalendarLoggingQuota -gt '10GB'}.| -|_CalendarRepairDisabled_|_msExchCalendarRepairDisabled_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {CalendarRepairDisabled -eq $true}`.| -|_CertificateSubject_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).
For example, `Get-User -Filter {CertificateSubject -eq 'X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`')| -|_City_|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {City -eq 'Redmond'}`.| -|_Company_|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Company -like 'Contoso*'}`.| -|_ComplianceTagHoldApplied_|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {ComplianceTagHoldApplied -eq $true}`.| -|_ConsumerNetID_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter {ConsumerNetID -ne $null}`.| -|_CountryCode_|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer|This filter requires the ISO 3166-1 three-digit country code for the user (for example, `840` for the United States). This property is used together with the _c_ and _co_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter {countryCode -eq 796}`.| -|_CountryOrRegion_|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String|This filter requires the ISO 3166-1 country name for the user (for example, `United States`). You can select an available value in Active Directory Users and Computers ( **Address** tab > **Country/region** field), or the Exchange admin center (user properties > **Contact information** tab > **Country/Region** field).
When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the _co_ and _countryCode_ properties are automatically configured.
For example, `Get-User -Filter {CountryOrRegion -like 'United*'}`.| -|_CustomAttribute1_ to _CustomAttribute15_|_extensionAttribute1_ to _extensionAttribute15_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {CustomAttribute8 -like '*audited*'}`.| -|_Database_|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String|This filter requires the distinguished name of the mailbox database. For example, `Get-Mailbox -Filter {Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase \| Format-List Name,DistinguishedName.| -|_DefaultPublicFolderMailbox_|_msExchPublicFolderMailbox_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, `Get-Mailbox -Filter {DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'}`.
To find the distinguished names of public folder mailboxes, run this command: Get-Mailbox -PublicFolder \| Format-List Name,DistinguishedName.| -|_DeletedItemFlags_|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).|For example, `Get-Mailbox -Filter {DeletedItemFlags -ne 'DatabaseDefault'}`.| -|_DeliverToMailboxAndForward_|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {DeliverToMailboxAndForward -eq $true}`.| -|_Department_|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `null`|For example, `Get-Recipient -Filter {Department -like 'Engineering*'}`.| -|_DirectReports_|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the direct report. For example, `Get-User -Filter {DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-User -Filter {DirectReports -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a direct report, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_DisabledArchiveDatabase_|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the disabled archive mailbox database. For example, `Get-Mailbox -Filter {DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase \| Format-List Name,DistinguishedName.| -|_DisabledArchiveGuid_|_msExchDisabledArchiveDatabaseGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `null`|This filter requires the GUID of the disabled archive mailbox. For example, `Get-Mailbox -Filter {DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'}`.
You can find the GUID of archive mailboxes by running this command: Get-Mailbox -Archive \| Format-Table -Auto Name,ArchiveGUID.| -|_DisplayName_|_displayName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-Recipient -Filter {DisplayName -like 'Julia*'}`.| -|_DistinguishedName_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String|This filter requires the distinguished name of the recipient. For example, `Get-Mailbox -Filter {DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'}`.
You can find the distinguished names of recipients by running this command: Get-Recipient \| Format-List Name,RecipientType,DistinguishedName.| -|_EcpEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter {EcpEnabled -eq $false}`.| -|_EmailAddresses_|_proxyAddresses_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**|String (wildcards accepted)|For example, `Get-Recipient -Filter {EmailAddresses -like '*marketing*'}`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `{EmailAddresses -eq 'lila@fabrikam.com'}` returns a match, `{EmailAddresses -like 'lila*'}` won't return a match, but `{EmailAddresses -like '*lila*'}` or `{EmailAddresses -like 'smtp:lila*'}` will return a match.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_EmailAddressPolicyEnabled_|n/a|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter {EmailAddressPolicyEnabled -eq $false}`.| -|_EntryId_|_msExchPublicFolderEntryId_|**Get-MailPublicFolder**|String (wildcards accepted)|For example, `Get-MailPublicFolder -Filter {EntryId -like '*60000'}`.
You can find the entry IDs of mail-enabled public folders by running this command: Get-MailPublicFolder \| Format-List Name,EntryId.| -|_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|**Get-CASMailbox**|`EnforceAllowList`, `EnforceBlockList`. or `$null`|For example, `Get-CASMailbox -Filter {EwsApplicationAccessPolicy -ne $null}`.| -|_EwsEnabled_|_msExchEwsEnabled_|**Get-CASMailbox**|0 (disabled), 1 (enabled) or `$null`.|For example, `Get-CASMailbox -Filter {EwsEnabled -eq 1}`.| -|_ExchangeGuid_|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String|For example, `Get-Mailbox -Filter {ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'}`.
To find the Exchange GUID of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,ExchangeGuid.
Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is `00000000-0000-0000-0000-000000000000`.| -|_ExchangeUserAccountControl_|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)|For example, `Get-Mailbox -Filter {ExchangeUserAccountControl -eq 'AccountDisabled'}`.| -|_ExchangeVersion_|_msExchVersion_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|Integer|This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: Get-Recipient \| Format-Table Name,RecipientType,ExchangeVersion.
For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter.
For the Exchange 2013 or Exchange 2013 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter.
For example, `Get-Recipient -Filter {ExchangeVersion -lt 88218628259840}`.| -|_ExpansionServer_|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {ExpansionServer -like '*Mailbox01'}`.
For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter {ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'}`
You can find the **ExchangeLegacyDN** value by running this command: Get-ExchangeServer \| Format-List Name,ExchangeLegacyDN.| -|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {ExtensionCustomAttribute8 -like '*audited*'}`.| -|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|String or `$null`|For example, `Get-Recipient -Filter {ExternalDirectoryObjectId -ne $null}`.| -|_ExternalEmailAddress_|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {ExternalEmailAddress -like '*@fabrikam.com'}`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `{ExternalEmailAddress -eq 'lila@fabrikam.com'}` returns a match, `{ExternalEmailAddress -like 'lila*'}` won't return a match, but `{ExternalEmailAddress -like '*lila*'}` or `{ExternalEmailAddress -like 'smtp:lila*'}` will return a match.| -|_ExternalOofOptions_|_msExchExternalOOFOptions_|**Get-Mailbox**|`External` (0) or `InternalOnly` (1)|For example, `Get-Mailbox -Filter {ExternalOofOptions -eq 'External'}`.| -|_Fax_|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Fax -like '206*'}`.| -|_FirstName_|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {FirstName -like 'Chris*'}`.| -|_ForwardingAddress_|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter {ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a forwarding recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.| -|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {ForwardingSmtpAddress -like '*@fabrikam.com'}`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `{ForwardingSmtpAddress -eq 'lila@fabrikam.com'}` returns a match, `{ForwardingSmtpAddress -like 'lila*'}` won't return a match, but `{ForwardingSmtpAddress -like '*lila*'}` or `{ForwardingSmtpAddress -like 'smtp:lila*'}` will return a match.| -|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`|This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter {GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of offline address books by running this command: Get-OfflineAddressBook \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_GrantSendOnBehalfTo_|_publicDelegates_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter {GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_GroupType_|_groupType_|**Get-DistributionGroup**
**Get-Group**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter {GroupType -eq 'Universal,SecurityEnabled'}` returns the same results as `Get-DistributionGroup -Filter {GroupType -eq 'SecurityEnabled,Universal'}`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_Guid_|_objectGuid_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String|For example, `Get-Recipient -Filter {Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'}`.
You can find the GUIDs of recipients by running this command: Get-Recipient \| Format-List Name,RecipientType,Guid.
Note that an object's GUID value is different than its Exchange GUID value.| -|_HasActiveSyncDevicePartnership_|Not applicable|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter {HasActiveSyncDevicePartnership -eq $true}`.| -|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter {HiddenFromAddressListsEnabled -eq $true}`.| -|_HomePhone_|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {HomePhone -like '206*'}`.| -|_Id_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**
**Get-User**
**Get-SecurityPrincipal**||This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter {Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {Id -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "" \| Format-List Name,DistinguishedName.| -|_IgnoreMissingFolderLink_|n/a|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-MailPublicFolder -Filter {IgnoreMissingFolderLink -eq $true}`.| -|_ImapEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter {ImapEnabled -eq $false}`.| -|_ImmutableId_|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter {ImmutableId -ne $null}`.| -|_IncludeInGarbageCollection_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IncludeInGarbageCollection -eq $true}`.| -|_Initials_|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Initials -like 'B.'}`.| -|_InPlaceHolds_|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter {InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'}`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: Get-MailboxSearch \| Format-Table Name,InPlaceHoldIdentity.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_InPlaceHoldsRaw_|n/a|**Get-LinkedUser**
**Get-User**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter {InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'}`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: Get-MailboxSearch \| Format-Table Name,InPlaceHoldIdentity.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_IsDirSynced_|_msExchIsMSODirsynced_|**Get-Contact**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter {IsDirSynced -eq $true}`.| -|_IsExcludedFromServingHierarchy_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsExcludedFromServingHierarchy -eq $true}`.| -|_IsHierarchyReady_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsHierarchyReady -eq $false}`.| -|_IsHierarchySyncEnabled_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsHierarchySyncEnabled -eq $false}`.| -|_IsInactiveMailbox_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsInactiveMailbox -eq $false}`.| -|_IsLinked_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsLinked -eq $true}`.| -|_IsMailboxEnabled_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsMailboxEnabled -eq $false}`.| -|_IsResource_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsResource -eq $true}`.| -|_IsSecurityPrincipal_|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter {IsSecurityPrincipal -eq $false}`.| -|_IsShared_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsShared -eq $true}`.| -|_IsSoftDeletedByDisable_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsSoftDeletedByDisable -eq $true}`.| -|_IsSoftDeletedByRemove_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {IsSoftDeletedByRemove -eq $true}`.| -|_IssueWarningQuota_|_mDBStorageQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {IssueWarningQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {IssueWarningQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.IssueWarningQuota - ''}. For example, Get-Mailbox \| where {$_.IssueWarningQuota -lt '50GB'}.| -|_JournalArchiveAddress_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This property uses an SMTP email address. For example, `Get-Mailbox -Filter {JournalArchiveAddress -eq 'michelle@contoso.com'}`.| -|_LanguagesRaw_|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/p/?LinkID=255174).
You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter {LanguagesRaw -eq 'en-US,es-MX'}` returns different results than `Get-Mailbox -Filter {LanguagesRaw -eq 'es-MX,en-US'}`.
For single values, this multivalued property will return a match if the property _contains_ the specified value.| -|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|A date/time value or `$null`|For example, `Get-Mailbox -Filter {LastExchangeChangedTime -ne $null}`.| -|_LitigationHoldDate_|_msExchLitigationHoldDate_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A date/time value or `$null`|For example, `Get-Mailbox -Filter {LitigationHoldDate -gt '8/13/2017'}`.| -|_LitigationHoldEnabled_|_n/a_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {LitigationHoldEnabled -eq $true}`.| -|_LitigationHoldOwner_|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter {LitigationHoldOwner -eq 'agruber@contoso.com'}`.| -|_LastName_|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {LastName -like 'Martin*'}`.| -|_LegacyExchangeDN_|_legacyExchangeDN_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-User -Filter {LegacyExchangeDN -like '*-Osca'}`.
You can find LegacyExchangeDN values for users by running this command: Get-User \| Format-List Name,LegacyExchangeDN| -|_MailboxContainerGUID_|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter {MailboxContainerGUID -ne $null}`.| -|_MailboxMoveBatchName_|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property includes the name of the migration batch. For example, `Get-Mailbox -Filter {MailboxMoveBatchName -like '*LocalMove 01*'}`.
You can find the names of migration batches by running the **Get-MigrationBatch** command. Note that migration batches that you create in the Exchange admin center use the naming convention `MigrationService:`.| -|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in[Get-MoveRequest](../../../exchange-ps/exchange/move-and-migration/get-moverequest.md).|For example, `Get-Mailbox -Filter {MailboxMoveFlags -ne 'None'}`.
You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter {MailboxMoveFlags -eq 'IntraOrg,Pull'}` returns the same results as `Get-Recipient -Filter {MailboxMoveFlags -eq 'Pull,IntraOrg'}`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_MailboxMoveRemoteHostName_|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter {MailboxMoveRemoteHostName -ne $null}`.| -|_MailboxMoveSourceMDB_|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the source mailbox database. For example, `Get-Mailbox -Filter {MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase \| Format-List Name,DistinguishedName.| -|_MailboxMoveStatus_|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in[Get-MoveRequest](../../../exchange-ps/exchange/move-and-migration/get-moverequest.md).|For example, `Get-Mailbox -Filter {MailboxMoveStatus -eq 'Completed'}`.| -|_MailboxMoveTargetMDB_|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the target mailbox database. For example, `Get-Mailbox -Filter {MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase \| Format-List Name,DistinguishedName.| -|_MailboxPlan_|_msExchParentPlanLink_|**Get-Mailbox**|String or `$null`|Mailbox plans correspond to Office 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain.
For example, `Get-Mailbox -Filter {MailboxPlan -ne $null}`.| -|_MailboxRelease_|_msExchMailboxRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter {MailboxRelease -ne $null}`.| -|_MailTipTranslations_|_msExchSenderHintTranslations_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) `$null`|When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, `Get-DistributionGroup -Filter {MailTipTranslations -like '*is not monitored.*'}`.| -|_ManagedBy_|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter {ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {ManagedBy -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ManagedFolderMailboxPolicy_|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|Managed folder mailbox policies aren't available in Exchange 2013 or later.
For example, `Get-Mailbox -Filter {ManagedFolderMailboxPolicy -eq $null}`.
This filter requires the distinguished name of the managed folder mailbox policy. For example, `Get-Mailbox -Filter {ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: Get-ManagedFolderMailboxPolicy \| Format-List Name,DistinguishedName.| -|_Manager_|_manager_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, `Get-User -Filter {Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {Manager -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a manager, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.| -|_MAPIEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter {MAPIEnabled -eq $false}`.| -|_MasterAccountSid_|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`|For example, `Get-Mailbox -Filter {MasterAccountSid -ne $null}`.
This value is blank ( `$null`) for mailboxes with associated user accounts, and `S-1-5-10` (Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes).| -|_MaxBlockedSenders_|_msExchMaxBlockedSenders_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter {MaxBlockedSenders -gt 0}`.| -|_MaxReceiveSize_|_delivContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {MaxReceiveSize -eq 'Unlimited'}` or `Get-Mailbox -Filter {MaxReceiveSize -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.MaxReceiveSize - ''}. For example, Get-Mailbox \| where {$_.MaxReceiveSize -gt '50GB'}.| -|_MaxSafeSenders_|_msExchMaxSafeSenders_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter {MaxSafeSenders -gt 0}`.| -|_MaxSendSize_|_submissionContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {MaxSendSize -eq 'Unlimited'}` or `Get-Mailbox -Filter {MaxSendSize -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.MaxReceiveSize - ''}. For example, Get-Mailbox \| where {$_.MaxSendSize -gt '50GB'}.| -|_MemberDepartRestriction_|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|For example, `Get-DistributionGroup -Filter {MemberDepartRestriction -eq 'ApprovalRequired'}`.| -|_MemberJoinRestriction_|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|For example, `Get-DistributionGroup -Filter {MemberJoinRestriction -eq 'ApprovalRequired'}`.| -|_MemberOfGroup_|_memberOf_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, `Get-User -Filter {MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'}` or `Get-User -Filter {MemberOfGroup -eq 'contoso.com/Users/Marketing Group'}`.
To find the distinguished name of a group, replace _\_ with the name, alias, or email address of the group, and run this command: Get-DistributionGroup -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Members_|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group member. For example, `Get-Group -Filter {Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-User -Filter {Members -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a group member, replace _\_ with the name, alias, or email address of the group member, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_MobilePhone_|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {MobilePhone -like '*5555'}`.| -|_ModeratedBy_|_msExchModeratedByLink_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String|This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, `Get-DistributionGroup -Filter {ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-DistributionGroup -Filter {ModeratedBy -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ModerationEnabled_|_msExchEnableModeration_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter {ModerationEnabled -eq $true}`.| -|_Name_|_name_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-User -Filter {Name -like 'Laura*'}`.| -|_NetID_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`|This property is populated for Office 365 mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`.
For example, `Get-User -Filter {NetId -ne $null}`.| -|_Notes_|_info_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Notes -like '*Events Team*'}`.| -|_ObjectCategory_|_objectCategory_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String|This filter requires the canonical distinguished name of the object. The value uses the syntax `/Configuration/Schema/`.
Valid _\_ values are: `Person` for mailboxes, mail users, and mail contacts, `Group` for distribution groups and mail-enabled security groups, `ms-Exch-Public-Folder` for mail-enabled public folders, and `ms-Exch-Dynamic-Distribution-List` for dynamic distribution groups.
For example, `Get-Recipient -Filter {ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'}`.| -|_ObjectClass_|_objectClass_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String|The value of this property is `top, person, organizationalPerson, user` for mailboxes and mail users, `top, person, organizationalPerson, contact` for mail contacts, `top, group` for distribution groups and mail-enabled security groups, `msExchDynamicDistributionList` for dynamic distribution groups and `top, publicFolder` for mail-eanbled public folders
For example, `Get-Recipient -Filter {ObjectClass -eq 'Contact'}`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Office_|_physicalDeliveryOfficeName_|**Get-Contact**
**Get-LinkedUser**
**Get-Mailbox**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Office -like '22*'}`.| -|_OfflineAddressBook_|_msExchUseOAB_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter {OfflineAddressBook -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`
You can find the distinguished names of offline address books by running this command: Get-OfflineAddressBook \| Format-List Name,DistinguishedName.| -|_OnPremisesObjectId_|n/a|**Get-MailPublicFolder**|String or `$null`|For example, `Get-MailPublicFolder -Filter {OnPremisesObjectId -ne $null}`.| -|_OperatorNumber_|_msExchUMOperatorNumber_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter {OperatorNumber -eq 5}`.| -|_OtherFax_|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {OtherFax -like '206*'}`.| -|_OtherHomePhone_|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {OtherHomePhone -like '206*'}`.| -|_OtherTelephone_|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {OtherTelephone -like '206*'}`.| -|_OWAEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|The filter operates backwards. For example, `Get-CASMailbox -Filter {OWAEnabled -eq $true}` returns mailboxes where the **OWAEnabled** property is `False`, and `Get-CASMailbox -Filter {OWAEnabled -eq $false}` returns mailboxes where the **OWAEnabled** property is `True`| -|_OWAforDevicesEnabled_|_msExchOmaAdminWirelessEnable_|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter {OWAForDevicesEnabled -eq $true}`.| -|_OWAMailboxPolicy_|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, `Get-CASMailbox -Filter {OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com`'}.
You can find the distinguished names of Outlook on the web mailbox policies by running this command: Get-OwaMailboxPolicy \| Format-List Name,DistinguishedName.| -|_Pager_|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Pager -like '206*'}`.| -|_PersistedCapabilities_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|Typically, the value of this property something other than `$null` (blank) for Office 365 accounts and mailboxes. For more information about the valid property values, see[Capability enumeration](https://go.microsoft.com/fwlink/p/?linkid=854610).
For example, `Get-Mailbox -Filter {PersistedCapabilities -ne $null}`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Phone_|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Phone -like '206*'}`.| -|_PhoneProviderId_|_msExchUMPhoneProvider_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMMailbox -Filter {PhoneProviderId -like '*206*'}`.| -|_PhoneticDisplayName_|_msDS-PhoneticDisplayName_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-MailPublicFolder**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {PhoneticDisplayName -like '*Lila*'}`.| -|_PoliciesExcluded_|_msExchPoliciesExcluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Recipient -Filter {PoliciesExcluded -ne $null}`.| -|_PoliciesIncluded_|_msExchPoliciesIncluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Recipient -Filter {PoliciesIncluded -eq $null}`.| -|_PopEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter {POPEnabled -eq $false}`.| -|_PostalCode_|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {PostalCode -eq 90210}`.| -|_PostOfficeBox_|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {PostOfficeBox -like '*555*'}`.| -|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`|For valid values, see the description of the _RecipientTypeDetails_ parameter in[Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md).
For example, `Get-User -Filter {PreviousRecipientTypeDetails -ne $null}`.| -|_PrimarySmtpAddress_|n/a|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**|String (wildcards accepted)|For example, `Get-Recipient -Filter {PrimarySMTPAddress -like '*@fabrikam.com'}`.| -|_ProhibitSendQuota_|_mDBOverQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {ProhibitSendQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {ProhibitSendQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.ProhibitSendQuota - ''}. For example, Get-Mailbox \| where {$_.ProhibitSendQuota -lt '70GB'}.| -|_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {ProhibitSendReceiveQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {ProhibitSendReceiveQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.ProhibitSendReceiveQuota - ''}. For example, Get-Mailbox \| where {$_.ProhibitSendReceiveQuota -lt '70GB'}.| -|_ProtocolSettings_|_protocolSettings_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable prococols (for example, POP3 or IMAP4).
For example, `Get-Mailbox -Filter {ProtocolSettings -like '*POP3*'}`.| -|_PublicFolderContacts_|_pFContacts_|**Get-MailPublicFolder**|String or `$null`|This property is displayed as **Contacts** in the results of the command Get-MailPublicFolder -Identity \ \| Format-List, but you need to use the property name **PublicFolderContacts** in the filter.
This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter {PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-MailPublicFolder -Filter {PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of a public folder contact, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_QueryBaseDN_|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`|This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`).
For example, `Get-Mailbox -Filter {QueryBaseDN -ne $null}`.| -|_RecipientContainer_|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter {RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'}` or `Get-DynamicDistributionGroup -Filter {RecipientContainer -eq 'contoso.com/Users'}`
To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: Get-OrganizationalUnit -IncludeContainers \| Format-List Name,DistinguishedName,ID| -|_RecipientLimits_|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`|For example, `Get-Mailbox -Filter {RecipientLimits -ne 'Unlimited'}`.| -|_RecipientType_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**|`DynamicDistributionGroup`, `MailContact`, `MailNonUniversalGroup`, `MailUniversalDistributionGroup`, `MailUniversalSecurityGroup`, `MailUser`, `PublicFolder` or `UserMailbox`|For example, `Get-Recipient -Filter {RecipientType -eq 'MailContact'}`.| -|_RecipientTypeDetails_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**|String|For valid values, see the description of the _RecipientTypeDetails_ parameter in[Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md).
For example, `Get-Recipient -Filter {RecipientTypeDetails -eq 'SharedMailbox'}`.| -|_RecoverableItemsQuota_|_msExchDumpsterQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {RecoverableItemsQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {RecoverableItemsQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.RecoverableItemsQuota - ''`. For example, Get-Mailbox \| where {$_.RecoverableItemsQuota -gt '35GB'}.| -|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {RecoverableItemsWarningQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {RecoverableItemsWarningQuota -ne 'Unlimited'}`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.RecoverableItemsWarningQuota - ''}. For example, Get-Mailbox \| where {$_.RecoverableItemsWarningQuota -gt '25GB'}.| -|_RejectMessagesFrom_|_unauthOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter {RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'}` or `Get-DistributionGroup -Filter {RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'}`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter {RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'}`. or `Get-Mailbox -Filter {RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'}`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: Get-DistributionGroup -Identity "\" \| Format-List Name,DistinguishedName or Get-DynamicDistributionGroup -Identity "\" \| Format-List Name,DistinguishedName.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the remote account policy. For example, `Get-Mailbox -Filter {RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.| -|_RemotePowerShellEnabled_|n/a|**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter {RemotePowerShellEnabled -eq $false}`.| -|_RemoteRecipientType_|_msExchRemoteRecipientType_|**Get-Mailbox**
**Get-RemoteMailbox**|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), `TeamMailbox` (128), or `$null`.|For example, `Get-RemoteMailbox -Filter {RemoteRecipientType -eq 'ProvisionMailbox'}`.| -|_ReportToManagerEnabled_|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter {ReportToManagerEnabled -eq $true}`.| -|_ReportToOriginatorEnabled_|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter {ReportToOriginatorEnabled -eq $false}`.| -|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**|Boolean (`$true` or `$false`)|This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command Get- -Identity \ \| Format-List, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter.
For example, `Get-DistributionGroup -Filter {RequireAllSendersAreAuthenticated -eq $false}`.| -|_ResourceCapacity_|_msExchResourceCapacity_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter {ResourceCapacity -gt 15}`| -|_ResourceCustom_|n/a|**Get-Mailbox**|String or `$null`|You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`.
When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter {ResourceCustom -eq 'Whiteboard'}`.| -|_ResourceType_|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`|For example, `Get-Mailbox -Filter {ResourceType -eq 'Equipment'}`| -|_RetainDeletedItemsFor_|_garbageCollPeriod_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: Get-Mailbox \| where {$_.RetainDeletedItemsFor - ''}. For example, Get-Mailbox \| where {$_.RetainDeletedItemsFor -gt '14.00:00:00'}.| -|_RetentionComment_|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {RetentionComment -like '*7 years*'}`| -|_RetentionPolicy_|n/a|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter {RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
To find the distinguished names of retention policies, run this command: Get-RetetionPolicy \| Format-List Name,DistinguishedName.| -|_RetentionUrl_|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {RetentionUrl -like 'https://intranet.contoso.com/*'}`| -|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This filter requires the distinguished name of the role assignment policy in Office 365. For example, `Get-Mailbox -Filter {RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'}`.
To find the distinguished names of role assignment policies in Office 365, run this command: Get-RoleAssignmentPolicy \| Format-List Name,DistinguishedName.| -|_RulesQuota_|_msExchMDBRulesQuota_|**Get-Mailbox**|A byte quantified size value (for example, `50B` or `128KB`). Unqualified values are treated as bytes.|You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox \| where {$_.RulesQuota - ''}. For example, Get-Mailbox \| where {$_.RulesQuota -lt '256KB'}.| -|_SafeRecipientsHash_|_msExchSafeRecipientsHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter {SafeRecipientsHash -ne $null}.`| -|_SafeSendersHash_|_msExchSafeSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter {SafeSendersHash -ne $null}.`| -|_SamAccountName_|_SamAccountName_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {SamAccountName -like '*laura*'}`| -|_SCLDeleteThresholdInt_|_msExchMessageHygieneSCLDeleteThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLDeleteThreshold** in the results of the command Get-Mailbox -Identity \ \| Format-List, but you need to use the property name **SCLDeleteThresholdInt** in the filter.
For example, `Get-Mailbox -Filter {SCLDeleteThresholdInt -ge -2147483640}`.| -|_SCLJunkThresholdInt_|_msExchMessageHygieneSCLJunkThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLJunkThreshold** in the results of the command Get-Mailbox -Identity \ \| Format-List, but you need to use the property name **SCLJunkThresholdInt** in the filter.
For example, `Get-Mailbox -Filter {SCLJunkThresholdInt -ge -2147483645}`.| -|_SCLQuarantineThresholdInt_|_msExchMessageHygieneSCLQuarantineThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLQuarantineThreshold** in the results of the command Get-Mailbox -Identity \ \| Format-List, but you need to use the property name **SCLQuarantineThresholdInt** in the filter.
For example, `Get-Mailbox -Filter {SCLQuarantineThresholdInt -ge -2147483643}`.| -|_SCLRejectThresholdInt_|_msExchMessageHygieneSCLRejectThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLRejectThreshold** in the results of the command Get-Mailbox -Identity \ \| Format-List, but you need to use the property name **SCLRejectThresholdInt** in the filter.
For example, `Get-Mailbox -Filter {SCLRejectThresholdInt -ge -2147483641}`.| -|_SendOofMessageToOriginatorEnabled_|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter {SendOofMessageToOriginatorEnabled -eq $true}`.| -|_ServerLegacyDN_|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {ServerLegacyDN -like '*Mailbox01'}`.
This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01`.| -|_ServerName_|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`|For example, `Get-Recipient -Filter {ServerName -eq 'Mailbox01'}`.| -|_SharingPolicy_|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the sharing policy. For example, `Get-Mailbox -Filter {SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
To find the distinguished names of sharing policies, run this command: Get-SharingPolicy \| Format-List Name,DistinguishedName.
**Note**: For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the **SharingPolicy** property is blank ( `$null`).| -|_Sid_|_objectSid_|**Get-Group**
**Get-LinkedUser**
**Get-SecurityPrincipal**
**Get-User**|String|For example, `Get-User -Filter {Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'}`.| -|_SidHistory_|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter {SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'}`.| -|_SimpleDisplayName_|_displayNamePrintable_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {SimpleDisplayName -like '*lila*'}`.| -|_SingleItemrecoveryEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {SingleItemRecoveryEnabled -eq $true}`.| -|_SKUAssigned_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.|For example, `Get-User -Filter {SKUAssigned -eq $true}`.| -|_SourceAnchor_|n/a|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {SourceAnchor -ne $null}`.| -|_StateOrProvince_|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {StateOrProvince -like '*Carolina'}`.| -|_StreetAddress_|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {StreetAddress -like '*36th Ave NE*'}`.| -|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|A date/time value or `$null`|For example, `Get-User -Filter {StsRefreshTokensValidFrom -gt '8/1/2017'}`.| -|_TelephoneAssistant_|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {TelephoneAssistant -like '206*'}`.| -|_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the throttling policy. For example, `Get-Mailbox -Filter {ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
To find the distinguished names of throttling policies, run this command: Get-ThrottlingPolicy \| Format-List Name,DistinguishedName.| -|_Title_|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Title -eq 'Dr.'}`.| -|_UMAddresses_|_msExchUMAddresses_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter {UMAddresses -ne $null}`.| -|_UMCallingLineIds_|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {UMCallingLineIds -like '123*'}`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_UMDtmfMap_|_msExchUMDtmfMap_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {UMDtmfMap -like '*26297*'}`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_UMEnabled_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {UMEnabled -eq $true}`.| -|_UMMailboxPolicy_|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`|This filter requires the distinguished name of the UM mailbox policy. For example, `Get-Recipient -Filter {UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
To find the distinguished names of UM mailbox policies, run this command: Get-UMMailboxPolicy \| Format-List Name,DistinguishedName.| -|_UMRecipientDialPlanId_|_msExchUMRecipientDialPlanLink_|**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the UM dial plan. For example, `Get-Recipient -Filter {UMMailboxPolicy -eq 'CN=Contoso ,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.
To find the distinguished names of UM dial plans, run this command: Get-UMDialPlan \| Format-List Name,DistinguishedName.| -|_UpgradeRequest_|n/a|**Get-User**|`None` (0), `TenantUpgrade` (1), `PrestageUpgrade` (2), `CancelPrestageUpgrade` (3), `PilotUpgrade` (4), or `TenantUpgradeDryRun` (5),|For example, `Get-User -Filter {UpgradeRequest -ne 'None'}`.| -|_UpgradeStatus_|n/a|**Get-User**|`None` (0), `NotStarted` (1), `InProgress` (2), `Warning` (3), `Error` (4), `Cancelled` (5), `Complete` (6), or `ForceComplete` (7).|For example, `Get-User -Filter {UpgradeStatus -ne 'None'}`.| -|_UsageLocation_|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`|This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Office 365. For more information, see [Country Codes - ISO 3166](https://go.microsoft.com/fwlink/p/?linkid=213779).
For example, `Get-Recipient -Filter {UsageLocation -ne $null}`.| -|_UseDatabaseQuotaDefaults_|_mDBUseDefaults_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {UseDatabaseQuotaDefaults -eq $false}`.| -|_UserAccountControl_|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExiprePassword`, or `NormalAccount`|For example, `Get-User -Filter {UserAccountControl -eq 'NormalAccount'}`.
You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter {UserAccountControl -eq 'AccountDisabled,NormalAccount'}` returns different results than `Get-User -Filter {UserAccountControl -eq 'NormalAccount,AccountDisabled'}`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_UserPrincipalName_|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-User -Filter {UserPrincipalName -like 'julia@*'}`.| -|_VoiceMailSettings_|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter {VoiceMailSettings -ne $null}`.| -|_WebPage_|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {WebPage -like 'https://intranet.contoso.com/*'}`.| -|_WhenChanged_|_WhenChanged_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|A date/time value|For example, `Get-Recipient -Filter {WhenChanged -gt '8/1/2017 2:00:00 PM'}`.| -|_WhenChangedUTC_|_n/a_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|A date/time value in Coordinated Universal Time (UTC)|For example, `Get-Recipient -Filter {WhenChangedUTC -gt '8/1/2017 2:00:00 PM'}`.| -|_WhenCreated_|_whenCreated_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|A date/time value|For example, `Get-Recipient -Filter {WhenCreated -gt '8/1/2017 2:00:00 PM'}`.| -|_WhenCreatedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|A date/time value in Coordinated Universal Time (UTC)|For example, `Get-Recipient -Filter {WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'}`.| -|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|A date/time value|For example, `Get-Recipient -Filter {WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'}`.| -|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|A date/time value|This filter requires the _SoftDeleted_ switch in the command for mailboxes.
For example, `Get-Mailbox -SoftDeleted -Filter {WhenChanged -gt '8/1/2017 2:00:00 PM'}`.| -|_WindowsEmailAddress_|_mail_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`.|For example, `Get-Mailbox -Filter {WindowsEmailAddress -like '*@fabrikam.com'}`.| -|_WindowsLiveID_|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`.|For example, `Get-Mailbox -Filter {WindowsEmailAddress -like '*@fabrikam.onmicrosoft.com'}`.| - -## For more information - -Exchange 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, [Need help converting your LDAP filters to OPATH?](https://go.microsoft.com/fwlink/p/?LinkId=88854). - -For more information about the syntax that can be used within OPATH filters, see [Exchange cmdlet syntax](../exchange-cmdlet-syntax.md). - - diff --git a/exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md b/exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md deleted file mode 100644 index 48926c83c0..0000000000 --- a/exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -title: "Recipient filters in Exchange Management Shell commands" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 3/17/2017 -ms.audience: ITPro -ms.topic: reference -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: fb4b1396-9aae-4037-be1a-b09e336b890e -description: "Learn about creating different kinds of recipient filters in the Exchange Management Shell." ---- - -# Recipient filters in Exchange Management Shell commands -You can use several Exchange Management Shell commands to filter a set of recipients. You can create the following types of filters in an Exchange command: - -- Precanned filters - -- Custom filters using the _RecipientFilter_ parameter - -- Custom filters using the _Filter_ parameter - -- Custom filters using the _ContentFilter_ parameter - -Older versions of Exchange used LDAP filtering syntax to create custom address lists, global address lists (GALs), email address policies, and distribution groups. In Exchange Server 2007 and later versions, OPATH filtering syntax replaced LDAP filtering syntax. - -## Precanned filters -A precanned filter is a commonly used Exchange filter that you can use to meet a variety of recipient-filtering criteria for creating dynamic distribution groups, email address policies, address lists, or GALs. With precanned filters, you can use either the Exchange Management Shell or the Exchange admin center (EAC). Using precanned filters, you can do the following: - -- Determine the scope of recipients. - -- Add conditional filtering based on properties such as company, department, and state or region. - -- Add custom attributes for recipients. For more information, see [Custom Attributes](https://technet.microsoft.com/library/2b043878-0b34-4563-a9c2-28a9efa7447e.aspx). - -The following parameters are considered precanned filters: - -- _IncludedRecipients_ - -- _ConditionalCompany_ - -- _ConditionalDepartment_ - -- _ConditionalStateOrProvince_ - -- _ConditionalCustomAttribute1_ to _ConditionalCustomAttribute15_. - -Precanned filters are available for the following cmdlets: - -- [New-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/new-dynamicdistributiongroup.md) - -- [Set-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/set-dynamicdistributiongroup.md) - -- [New-EmailAddressPolicy](../../../exchange-ps/exchange/email-addresses-and-address-books/new-emailaddresspolicy.md) - -- [Set-EmailAddressPolicy](../../../exchange-ps/exchange/email-addresses-and-address-books/set-emailaddresspolicy.md) - -- [New-AddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/new-addresslist.md) - -- [Set-AddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/set-addresslist.md) - -- [New-GlobalAddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/new-globaladdresslist.md) - -- [Set-GlobalAddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/set-globaladdresslist.md) - -### Example - -This example describes using precanned filters in the Exchange Management Shell to create a dynamic distribution group. The syntax in this example is similar but not identical to the syntax you would use to create an email address policy, address list, or GAL. When creating a precanned filter, you should ask the following questions: - -- From which organizational unit (OU) do you want to include recipients? (This question corresponds to the _RecipientContainer_ parameter.) - -> [!NOTE] -> Selecting the OU for this purpose applies only when creating dynamic distribution groups, and not when creating email address policies, address lists, or GALs. - -- What type of recipients do you want to include? (This question corresponds to the _IncludedRecipients_ parameter.) - -- What additional conditions do you want to include in the filter? (This question corresponds to the _ConditionalCompany_, _ConditionalDepartment_, _ConditionalStateOrProvince_, and _ConditionalCustomAttribute_ parameters.) - -This example creates the dynamic distribution group Contoso Finance for user mailboxes in the OU Contoso.com/Users and specifies the condition to include only recipients who have the **Department** attribute defined as Finance and the **Company** attribute defined as Contoso. - -``` -New-DynamicDistributionGroup -Name "Contoso Finance" -OrganizationalUnit Contoso.com/Users -RecipientContainer Contoso.com/Users -IncludedRecipients MailboxUsers -ConditionalDepartment "Finance" -ConditionalCompany "Contoso" -``` - -This example displays the properties of this new dynamic distribution group. - -``` -Get-DynamicDistributionGroup -Identity "Contoso Finance" | Format-List Recipient*,Included* -``` - -## Custom filters using the RecipientFilter parameter -If precanned filters don't meet your needs for creating or modifying dynamic distribution groups, email address policies, and address lists, you can create a custom filter by using the _RecipientFilter_ parameter. - -The recipient filter parameter is available for the following cmdlets: - -- [New-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/new-dynamicdistributiongroup.md) - -- [Set-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/set-dynamicdistributiongroup.md) - -- [New-EmailAddressPolicy](../../../exchange-ps/exchange/email-addresses-and-address-books/new-emailaddresspolicy.md) - -- [Set-EmailAddressPolicy](../../../exchange-ps/exchange/email-addresses-and-address-books/set-emailaddresspolicy.md) - -- [New-AddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/new-addresslist.md) - -- [Set-AddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/set-addresslist.md) - -- [New-GlobalAddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/new-globaladdresslist.md) - -- [Set-GlobalAddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/set-globaladdresslist.md) - -For more information about the filterable properties you can use with the _RecipientFilter_ parameter, see [Filterable properties for the RecipientFilter parameter](recipientfilter-properties.md). - -### Example - -The following example uses the _RecipientFilter_ parameter to create a dynamic distribution group. The syntax in this example is similar but not identical to the syntax you use to create an email address policy, address list, or GAL. - -This example uses custom filters to create a dynamic distribution group for user mailboxes that have the **Company** attribute defined as Contoso and the **Office** attribute defined as North Building. - -``` -New-DynamicDistributionGroup -Name AllContosoNorth -OrganizationalUnit contoso.com/Users -RecipientFilter { ((RecipientType -eq 'UserMailbox') -and (Company -eq 'Contoso') -and (Office -eq 'North Building')) } -``` - -## Custom filters using the Filter parameter -You can use the _Filter_ parameter to filter the results of a command to specify which objects to retrieve. For example, instead of retrieving all users or groups, you can specify a set of users or groups by using a filter string. This type of filter doesn't modify any configuration or attributes of objects. It only modifies the set of objects that the command returns. - -Using the _Filter_ parameter to modify command results is known as server-side filtering. Server-side filtering submits the command and the filter to the server for processing. The Exchange Management Shell also supports client-side filtering, in which the command retrieves all objects from the server and then applies the filter in the local console window. To perform client-side filtering, use the **Where-Object** cmdlet. For more information about server-side and client-side filtering, see "How to Filter Data" in [Working with Command Output](https://technet.microsoft.com/library/8320e1a5-d3f5-4615-878d-b23e2aaa6b1e.aspx). - -To find the filterable properties for cmdlets that have the _Filter_ parameter, you can run the **Get** command against an object and format the output by pipelining the **Format-List** parameter. Most of the returned values will be available for use in the _Filter_ parameter. The following example returns a detailed list for the mailbox Ayla. - -``` -Get-Mailbox -Identity Ayla | Format-List -``` - -The _Filter_ parameter is available for the following recipient cmdlets: - -- [Get-CASMailbox](../../../exchange-ps/exchange/client-access/get-casmailbox.md) - -- [Get-Contact](../../../exchange-ps/exchange/users-and-groups/get-contact.md) - -- [Get-DistributionGroup](../../../exchange-ps/exchange/users-and-groups/get-distributiongroup.md) - -- [Get-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/get-dynamicdistributiongroup.md) - -- [Get-Group](../../../exchange-ps/exchange/users-and-groups/get-group.md) - -- [Get-Mailbox](../../../exchange-ps/exchange/mailboxes/get-mailbox.md) - -- [Get-MailContact](../../../exchange-ps/exchange/users-and-groups/get-mailcontact.md) - -- [Get-MailPublicFolder](../../../exchange-ps/exchange/sharing-and-collaboration/get-mailpublicfolder.md) - -- [Get-MailUser](../../../exchange-ps/exchange/users-and-groups/get-mailuser.md) - -- [Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md) - -- [Get-RemoteMailbox](../../../exchange-ps/exchange/federation-and-hybrid/get-remotemailbox.md) - -- [Get-SecurityPrincipal](../../../exchange-ps/exchange/users-and-groups/get-securityprincipal.md) - -- [Get-UMMailbox](../../../exchange-ps/exchange/unified-messaging/get-ummailbox.md) - -- [Get-User](../../../exchange-ps/exchange/users-and-groups/get-user.md) - -For more information about the filterable properties you can use with the _Filter_ parameter, see [Filterable properties for the Filter parameter](filter-properties.md). - -### Example - -This example uses the _Filter_ parameter to return information about users whose title contains the word "manager". - -``` -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](../../../exchange-ps/exchange/mailboxes/new-mailboxexportrequest.md) cmdlet. If the command finds a message that contains the match to the content filter, it exports the message to a .pst file. - -### Example -This example creates an export request that searches Ayla's mailbox for messages where the body contains the phrase "company prospectus". If that phrase is found, the command exports all messages with that phrase to a .pst file. - -``` -New-MailboxExportRequest -Mailbox Ayla -ContentFilter {Body -like "company prospectus*"} -``` - -For more information about the filterable properties you can use with the _ContentFilter_ parameter, see [Filterable Properties for the ContentFilter Parameter](https://technet.microsoft.com/library/cf504a59-1938-489c-bb48-b27b2ac3234e.aspx). - -## Additional OPATH syntax information -When creating your own custom filters, be aware of the following: - -- Use braces { } around the entire OPATH filter string with the _Filter_ or _RecipientFilter_ parameters. - -- Include the hyphen before all operators. The most common operators include: - - - **-and** - - - **-or** - - - **-not** - - - **-eq** (equals) - - - **-ne** (not equal) - - - **-lt** (less than) - - - **-gt** (greater than) - - - **-like** (string comparison) - - - **-notlike** (string comparison) - -- Many of the properties for the _RecipientFilter_ and _Filter_ parameters accept wildcard characters. If you use a wildcard character, use the **like** operator instead of the **eq** operator. The **like** operator is used to find pattern matches in rich types, such as strings, whereas the **eq** operator is used to find an exact match. - -- For more information about operators you can use, see: - - - [About Logical Operators](https://technet.microsoft.com/library/hh847789.aspx) - - - [About Comparison Operators](https://technet.microsoft.com/library/hh847759.aspx) - -## Recipient filter documentation -The following table contains links to topics that will help you learn more about the filterable properties that you can use with Exchange recipient commands. - -|**Topic**|**Description**| -|:-----|:-----| -|[Filterable properties for the RecipientFilter parameter](recipientfilter-properties.md) |Learn more about the filterable properties for the _RecipientFilter_ parameter. | -|[Filterable properties for the Filter parameter](filter-properties.md) |Learn more about the filterable properties for the _Filter_ parameter. | \ No newline at end of file diff --git a/exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md b/exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md deleted file mode 100644 index 4152c8a23a..0000000000 --- a/exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -title: "Filterable properties for the RecipientFilter parameter" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 3/17/2017 -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: cf78aca5-6699-485c-9b15-e0adba252176 -description: "Learn about the recipient properties that you can use with the RecipientFilter parameter in Exchange 2016 cmdlets." ---- - -# Filterable properties for the -RecipientFilter parameter - -Learn about the recipient properties that you can use with the _RecipientFilter_ parameter in Exchange 2016 cmdlets. - -You use the _RecipientFilter_ parameter to create OPATH filters based on the properties of recipient objects in Exchange Server 2016. The _RecipientFilter_ parameter is available in the following cmdlets: - -- [New-AddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/new-addresslist.md) and [Set-AddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/set-addresslist.md) - -- [New-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/new-dynamicdistributiongroup.md) and [Set-DynamicDistributionGroup](../../../exchange-ps/exchange/users-and-groups/set-dynamicdistributiongroup.md) - -- [New-EmailAddressPolicy](../../../exchange-ps/exchange/email-addresses-and-address-books/new-emailaddresspolicy.md) and [Set-EmailAddressPolicy](../../../exchange-ps/exchange/email-addresses-and-address-books/set-emailaddresspolicy.md) - -- [New-GlobalAddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/new-globaladdresslist.md) and [Set-GlobalAddressList](../../../exchange-ps/exchange/email-addresses-and-address-books/set-globaladdresslist.md) - -## Filterable recipient properties - -The recipient properties that have been *confirmed* to work with the _RecipientFilter_ parameter in *all* cmdlets are described in the following table. - - **Notes**: - -- The list might include: - - - Properties that are only used in one type of environment: Microsoft Office 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is only meaningful (a value other than blank or `None`) in one type of environment. - - - Properties that are present, but correspond to features that are no longer used in Exchange 2016. - -- You can't use properties from other Active Directory schema extensions with the _RecipientFilter_ parameter. - -- Not all recipient properties have a corresponding Active Directory property. The LDAP display name value in the table is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange). - -- You typically use the object's name for properties that require a valid object value (for example, a mailbox, a distribution group, or an email address policy, but the property might also accept the object's distinguished name (DN) or globally unique identifier (GUID). To find the object's DN or GUID, use the **Get-** cmdlet that corresponds to the object's type (for example, `Get-EmailAddressPolicy | Format-List Name,DistinguishedName,GUID`). - -- Text string properties that accept wildcard characters require the `-like` operator (for example, `Property -like '*abc'`). - -- The Value column in the table describes the acceptable values for the *filter* , not necessarily for the property itself. For example, a property might obviously contain a date or numeric value, but when you use that property in a filter, it might be treated like a text string (no value check, and wildcards are supported). - -- To look for blank or non-blank property values, use the value `$null` (for example, `Property -eq $null` or `Property -ne $null`). - -- For more information about creating filters in recipient commands, see [Additional OPATH syntax information](https://technet.microsoft.com/library/b22affa2-ef51-4e4e-b59c-a58620baf8aa.aspx#OPATH). - -**** - -|**Property name**|**LDAP display name**|**Value**|**Comments**| -|:-----|:-----|:-----|:-----| -|_AcceptMessagesOnlyFrom_|_authOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| -|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| -|_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|String (wildcards accepted).|| -|_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|String (wildcards accepted).|| -|_ActiveSyncEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_ActiveSyncMailboxPolicy_|_msExchMobileMailboxPolicyLink_|String (wildcards accepted in dynamic distribution groups).|The default Exchange ActiveSync mailbox policy is named Default.| -|_ActiveSyncSuppressReadReceipt_|n/a|Boolean ( `$true` or `$false`)|| -|_AddressBookPolicy_|_msExchAddressBookPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| -|_AddressListMembership_|_showInAddressBook_|String (wildcards accepted in dynamic distribution groups).|| -|_AdminDisplayName_|_adminDisplayName_|String (wildcards accepted).|| -|_AdministrativeUnits_|_msExchAdministrativeUnitLink_|String (wildcards accepted in dynamic distribution groups).|| -|_AggregatedMailboxGuids_|_msExchAlternateMailboxes_|String (wildcards accepted).|| -|_Alias_|_mailNickname_|String (wildcards accepted).|This property contains the recipient's Exchange alias (also known as the mail nickname). 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.| -|_AllowUMCallsFromNonUsers_|_msExchUMListInDirectorySearch_|`None` (0) or `SearchEnabled` (1)|| -|_ArbitrationMailbox_|_msExchArbitrationMailbox_|String (wildcards accepted in dynamic distribution groups).|| -|_ArchiveDatabase_|_msExchArchiveDatabaseLink_|String|| -|_ArchiveDomain_|_msExchArchiveAddress_|String (wildcards accepted).|| -|_ArchiveGuid_|_msExchArchiveGUID_|String (wildcards accepted).|| -|_ArchiveName_|_msExchArchiveName_|String (wildcards accepted).|| -|_ArchiveQuota_|_msExchArchiveQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_ArchiveRelease_|_msExchArchiveRelease_|String (wildcards accepted).|| -|_ArchiveState_|n/a|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|| -|_ArchiveStatus_|_msExchArchiveStatus_|`None` (0) or `Active` (1).|| -|_AssistantName_|_msExchAssistantName_|String (wildcards accepted).|The name of the recipient's assistant.| -|_AuditEnabled_|_msExchMailboxAuditEnable_|Boolean ( `$true` or `$false`)|| -|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|The value of this property is a time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.| -|_AuthenticationPolicy_|_msExchAuthPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| -|_C_|_C_|String (wildcards accepted).|This property contains the two-letter country/region designation from International Organization for Standardization (ISO) 3166. For more information, see [Country Codes - ISO 3166](https://go.microsoft.com/fwlink/p/?linkid=213779).| -|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|Dynamic distribution groups: `Unlimited` or a byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: `Unlimited`, or blank/non-blank.|| -|_CalendarRepairDisabled_|_msExchCalendarRepairDisabled_|Boolean ( `$true` or `$false`)|| -|_Certificate_|_userCertificate_|`System.Byte[]`|This property contains the DER-encoded X509v3 certificates that are issued to the user.| -|_CertificateSubject_|n/a|`X509:X500IssuerX500Subject` (for example, `X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`)|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).| -|_City_|_l_|String (wildcards accepted).|The recipient's city.| -|_Co_|_Co_|String (wildcards accepted).|The name of the recipient's country or region. You can locate valid _Co_ values on the **Address** tab in the recipient's properties in Active Directory Users and Computers.| -|_CommonName_|_cn_|String (wildcards accepted).|| -|_ComplianceTagHoldApplied_|n/a|Boolean ( `$true` or `$false`)|| -|_Company_|_company_|String (wildcards accepted).|The recipient's company name.| -|_CountryOrRegion_|c|String (wildcards accepted).|This property contains the two-letter country/region designation from ISO 3166. For more information, see [Country Codes - ISO 3166](https://go.microsoft.com/fwlink/p/?linkid=213779).| -|_CustomAttribute1_ to _CustomAttribute15_|_extensionAttribute1_ to _extensionAttribute15_|String (wildcards accepted).|These properties contain custom attributes that you can add to a recipient.| -|_Database_|_homeMDB_|String (wildcards accepted).|The identity of the user's mailbox database.| -|_Department_|_department_|String (wildcards accepted).|The recipient's department.| -|_DataEncryptionPolicy_|_msExchDataEncryptionPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| -|_DefaultPublicFolderMailbox_|_msExchPublicFolderMailbox_|String (wildcards accepted in dynamic distribution groups).|| -|_DeletedItemFlags_|_deletedItemFlags_|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).|| -|_DeliverToMailboxAndForward_|_deliverAndRedirect_|Boolean ( `$true` or `$false`)|| -|_Description_|_description_|String (wildcards accepted).|| -|_DirectReports_|_directReports_|String (wildcards accepted in dynamic distribution groups).|| -|_DisabledArchiveDatabase_|_msExchDisabledArchiveDatabaseLink_|String (wildcards accepted).|| -|_DisabledArchiveGuid_|_msExchDisabledArchiveDatabaseGUID_|String (wildcards accepted).|| -|_DisplayName_|_displayName_|String (wildcards accepted).|| -|_DistinguishedName_|_distinguishedName_|String (wildcards accepted).|| -|_EcpEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_ElcExpirationSuspensionEndDate_|_msExchELCExpirySuspensionEnd_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| -|_ElcExpirationSuspensionStartDate_|_msExchELCExpirySuspensionStart_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| -|_ElcMailboxFlags_|_msExchELCMailboxFlags_|`None` (0), `ExpirationSuspended` (1), `ElcV2` (2), `DisableCalendarLogging` (4),`LitigationHold` (8), `SingleItemRecovery` (16), `ValidArchiveDatabase` (32), `ShouldUseDefaultRetentionPolicy` (128), `EnableSiteMailboxMessageDedup` (256), `ElcProcessingDisabled` (512), or `ComplianceTagHold` (1024).|| -|_EmailAddresses_|_proxyAddresses_|String (wildcards accepted).|This property contains the recipient's email addresses (the primary email address and all proxy addresses).| -|_EmailAddressPolicyEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_EntryId_|_msExchPublicFolderEntryId_|String (wildcards accepted).|| -|_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|`EnforceAllowList` or `EnforceBlockList`.|| -|_EwsEnabled_|_msExchEwsEnabled_|Integer|| -|_ExchangeGuid_|_msExchMailboxGuid_|String (wildcards accepted).|| -|_ExchangeUserAccountControl_|_msExchUserAccountControl_|For valid values, see [ADS_USER_FLAG_ENUM enumeration](https://go.microsoft.com/fwlink/p/?linkid=190424). The integer values will work as described. Most of the text values won't work as described (even if you remove `ADS_UF` and all underscores).|| -|_ExchangeVersion_|_msExchVersion_|Dynamic distribution groups: String (wildcards accepted).
Others: `ExchangeObjectVersion` values.|| -|_ExpansionServer_|_msExchExpansionServerName_|String (wildcards accepted).|| -|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|String (wildcards accepted).|| -|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|String (wildcards accepted).|| -|_ExternalEmailAddress_|_targetAddress_|String (wildcards accepted).|This property contains the external email address for mail contacts and mail users.| -|_ExternalOofOptions_|_msExchExternalOOFOptions_|`External` (0) or `InternalOnly` (1).|| -|_Fax_|_facsimileTelephoneNumber_|String (wildcards accepted).|| -|_FirstName_|_givenName_|String (wildcards accepted).|The recipient's first name.| -|_ForwardingAddress_|_altRecipient_|String (wildcards accepted).|| -|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|String (wildcards accepted).|| -|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|String (wildcards accepted in dynamic distribution groups).|| -|_GrantSendOnBehalfTo_|_publicDelegates_|String (wildcards accepted in dynamic distribution groups).|| -|_GroupType_|_groupType_|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|| -|_Guid_|_objectGuid_|String (wildcards accepted).|| -|_HasActiveSyncDevicePartnership_|n/a|Boolean ( `$true` or `$false`)|| -|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|Boolean ( `$true` or `$false`)|This property specifies whether the recipient is visible in the global address list or other address lists.| -|_HiddenGroupMembershipEnabled_|_hideDLMembership_|Boolean ( `$true` or `$false`)|| -|_HomeMTA_|_homeMTA_|String (wildcards accepted in dynamic distribution groups).|| -|_HomePhone_|_homePhone_|String (wildcards accepted).|| -|_Id_|_distinguishedName_|String (wildcards accepted in dynamic distribution groups).|| -|_ImapEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_ImmutableId_|_msExchGenericImmutableId_|String (wildcards accepted).|| -|_IncludedRecipients_|n/a|`None` (0), `MailboxUsers` (1), `Resources` (2), `MailContacts` (4), `MailGroups` (8), `MailUsers` (16), or `AllRecipients` (-1).|| -|_IncludeInGarbageCollection_|n/a|Boolean ( `$true` or `$false`)|| -|_Initials_|_initials_|String (wildcards accepted).|| -|_InPlaceHolds_|_msExchUserHoldPolicies_|String|| -|_InPlaceHoldsRaw_|n/a|String|| -|_InternetEncoding_|_internetEncoding_|Integer|For valid values, see the Remarks section in the topic, [Encoding Class](https://go.microsoft.com/fwlink/p/?linkid=184080).| -|_IsDirSynced_|_msExchIsMSODirsynced_|Boolean ( `$true` or `$false`)|| -|_IsExcludedFromServingHierarchy_|n/a|Boolean ( `$true` or `$false`)|| -|_IsHierarchyReady_|n/a|Boolean ( `$true` or `$false`)|| -|_IsHierarchySyncEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_IsInactiveMailbox_|n/a|Boolean ( `$true` or `$false`)|| -|_IsMailboxEnabled_|n/a|Boolean ( `$true` or `$false`)|This property specifies whether the user is mailbox-enabled.| -|_IsSecurityPrincipal_|n/a|Boolean ( `$true` or `$false`)|| -|_IsSoftDeletedByDisable_|n/a|Boolean ( `$true` or `$false`)|| -|_IsSoftDeletedByRemove_|n/a|Boolean ( `$true` or `$false`)|| -|_IssueWarningQuota_|_mDBStorageQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_JournalArchiveAddress_|n/a|An SMTP email address (for example, `julia@contoso.com`).|| -|_LanguagesRaw_|_msExchUserCulture_|String (wildcards accepted).|This property contains the language preference for this mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/p/?LinkID=255174).| -|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_LastName_|_sn_|String (wildcards accepted).|| -|_LdapRecipientFilter_|_msExchDynamicDLFilter_|String (wildcards accepted).|| -|_LegacyExchangeDN_|_legacyExchangeDN_|String (wildcards accepted).|| -|_LitigationHoldDate_|_msExchLitigationHoldDate_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_LitigationHoldEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_LitigationHoldOwner_|_msExchLitigationHoldOwner_|String (wildcards accepted).|| -|_LocaleID_|_localeID_|Integer|For valid values, [Microsoft Locale ID Values](https://go.microsoft.com/fwlink/p/?linkid=229656).| -|_MailboxMoveBatchName_|_msExchMailboxMoveBatchName_|String (wildcards accepted).|| -|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|For valid values, see the description of the _Flags_ parameter in[Get-MoveRequest](../../../exchange-ps/exchange/move-and-migration/get-moverequest.md).|| -|_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](../../../exchange-ps/exchange/move-and-migration/get-moverequest.md).|| -|_MailboxMoveTargetMDB_|_msExchMailboxMoveTargetMDBLink_|String (wildcards accepted in dynamic distribution groups).|| -|_MailboxPlan_|_msExchParentPlanLink_|String (wildcards accepted).|Mailbox plans correspond to Office 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).|| -|_MailTipTranslations_|_msExchSenderHintTranslations_|String (wildcards accepted).|| -|_ManagedBy_|_managedBy_|String (wildcards accepted in dynamic distribution groups).|This property identifies the security principal that's the manager of the group.| -|_Manager_|_manager_|String (wildcards accepted in dynamic distribution groups).|The recipient's manager.| -|_MAPIEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_MapiRecipient_|_mAPIRecipient_|Boolean ( `$true` or `$false`)|| -|_MaxBlockedSenders_|_msExchMaxBlockedSenders_|`Unlimited` or an integer.|| -|_MaxSafeSenders_|_msExchMaxSafeSenders_|`Unlimited` or an integer.|| -|_MaxReceiveSize_|_delivContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_MaxSendSize_|_submissionContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_MemberDepartRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| -|_MemberJoinRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| -|_MemberOfGroup_|_memberOf_|String (wildcards accepted in dynamic distribution groups).|| -|_Members_|_member_|String (wildcards accepted in dynamic distribution groups).|| -|_MessageHygieneFlags_|_msExchMessageHygieneFlags_|`None` (0) or `AntispamBypass` (1).|| -|_MobileAdminExtendedSettings_|_msExchOmaAdminExtendedSettings_|String (wildcards accepted).|| -|_MobileMailboxFlags_|_msExchMobileMailboxFlags_|`None` (0), `HasDevicePartnership` (1), or ActiveSyncSuppressReadReceipt (2).|| -|_MobileFeaturesEnabled_|_msExchOmaAdminWirelessEnable_|`None` (0), `AirSyncDisabled` (4), or `MowaDisabled` (8).|| -|_MobilePhone_|_mobile_|String (wildcards accepted).|| -|_ModeratedBy_|_msExchModeratedByLink_|String (wildcards accepted in dynamic distribution groups).|| -|_ModerationEnabled_|_msExchEnableModeration_|Boolean ( `$true` or `$false`)|| -|_Name_|_name_|String (wildcards accepted).|The unique name value of the recipient.| -|_NetID_|n/a|A sample value is `1003BFFD9A0CFA03`.|This property is populated for Office 365 mailboxes in hybrid environments.| -|_Notes_|_info_|String (wildcards accepted).|| -|_ObjectCategory_|_objectCategory_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Valid values use the format `CN=,CN=Schema,CN=Configuration,DC=`, where _\_ is typically `Person` or `Group` for recipients. For example, `CN=Person,CN=Schema,CN=Configuration,DC=contoso,DC=com`.| -|_ObjectClass_|_objectClass_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Common values for recipients are: `contact`, `organizationalPerson`, `person`, `top`, `group`, `msExchDynamicDistributionList`, and `user`.| -|_Office_|_physicalDeliveryOfficeName_|String (wildcards accepted).|| -|_OfflineAddressBook_|_msExchUseOAB_|String (wildcards accepted in dynamic distribution groups).|This property contains the offline address book (OAB) that's associated with this recipient.| -|_OperatorNumber_|_msExchUMOperatorNumber_|String (wildcards accepted).|| -|_OtherFax_|_otherFacsimileTelephoneNumber_|String (wildcards accepted).|| -|_OtherHomePhone_|_otherHomePhone_|String (wildcards accepted).|| -|_OtherTelephone_|_otherTelephone_|String (wildcards accepted).|| -|_OWAEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_OWAforDevicesEnabled_|_msExchOmaAdminWirelessEnable_|Boolean ( `$true` or `$false`)|| -|_OWAMailboxPolicy_|_msExchOWAPolicy_|String (wildcards accepted in dynamic distribution groups).|| -|_Pager_|_pager_|String (wildcards accepted).|| -|_Phone_|_telephoneNumber_|String (wildcards accepted).|| -|_PhoneProviderId_|_msExchUMPhoneProvider_|String (wildcards accepted).|| -|_PhoneticCompany_|_msDS-PhoneticCompanyName_|String (wildcards accepted).|| -|_PhoneticDepartment_|_msDS-PhoneticDepartment_|String (wildcards accepted).|| -|_PhoneticDisplayName_|_msDS-PhoneticDisplayName_|String (wildcards accepted).|| -|_PhoneticFirstName_|_msDS-PhoneticFirstName_|String (wildcards accepted).|| -|_PhoneticLastName_|_msDS-PhoneticLastName_|String (wildcards accepted).|| -|_PoliciesExcluded_|_msExchPoliciesExcluded_|String (wildcards accepted).|| -|_PoliciesIncluded_|_msExchPoliciesIncluded_|String (wildcards accepted).|| -|_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](../../../exchange-ps/exchange/users-and-groups/get-recipient.md).|| -|_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).|| -|_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).|| -|_PublicFolderContacts_|_pFContacts_|String (wildcards accepted in dynamic distribution groups).|| -|_PurportedSearchUI_|_msExchPurportedSearchUI_|String (wildcards accepted).|| -|_QueryBaseDN_|_msExchQueryBaseDN_|String (wildcards accepted in dynamic distribution groups).|| -|_RawCanonicalName_|_canonicalName_|String (wildcards accepted).|| -|_RawExternalEmailAddress_|_targetAddress_|String (wildcards accepted).|| -|_RawName_|_name_|String (wildcards accepted).|| -|_RecipientContainer_|_msExchDynamicDLBaseDN_|String (wildcards accepted).|The Active Directory container or organizational unit (OU) that holds the recipient object.| -|_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](../../../exchange-ps/exchange/users-and-groups/get-recipient.md).|| -|_RecipientTypeDetails_|n/a|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md).|| -|_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.|| -|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| -|_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|String (wildcards accepted in dynamic distribution groups).|| -|_RemotePowerShellEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_RemoteRecipientType_|_msExchRemoteRecipientType_|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), or `TeamMailbox` (128).|| -|_ReportToManagerEnabled_|_reportToOwner_|Boolean ( `$true` or `$false`)|| -|_ReportToOriginatorEnabled_|_reportToOriginator_|Boolean ( `$true` or `$false`)|| -|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|Boolean ( `$true` or `$false`)|| -|_ResourceCapacity_|_msExchResourceCapacity_|Integers.|| -|_ResourceCustom_|n/a|String|| -|_ResourceMetaData_|_msExchResourceMetaData_|String (wildcards accepted).|| -|_ResourcePropertiesDisplay_|_msExchResourceDisplay_|String (wildcards accepted).|| -|_ResourceSearchProperties_|_msExchResourceSearchProperties_|String (wildcards accepted).|| -|_ResourceType_|n/a|`Room` (0) or `Equipment` (1).|| -|_RetainDeletedItemsFor_|_garbageCollPeriod_|Dynamic distribution groups: A time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.
Others: Blank or non-blank.|| -|_RetentionComment_|_msExchRetentionComment_|String (wildcards accepted).|| -|_RetentionPolicy_|n/a|String|| -|_RetentionUrl_|_msExchRetentionURL_|String (wildcards accepted).|| -|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| -|_RulesQuota_|_msExchMDBRulesQuota_|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.|| -|_SamAccountName_|_SamAccountName_|String (wildcards accepted in dynamic distribution groups).|This property specifies an identifier that's compatible with older versions of Microsoft Windows client and server operating systems (also known as the pre-Windows 2000 user account or group name)| -|_SafeRecipientsHash_|_msExchSafeRecipientsHash_|`System.Byte[]`|A user's safe recipients list is hashed (SHA-256) one way before it's stored as a binary large object in Active Directory.| -|_SafeSendersHash_|_msExchSafeSendersHash_|`System.Byte[]`|A user's safe senders list is hashed (SHA-256) one way before it's stored as a binary large object in Active Directory.| -|_SCLDeleteThresholdInt_|_msExchMessageHygieneSCLDeleteThreshold_|An integer from 0 through 9.|| -|_SCLJunkThresholdInt_|_msExchMessageHygieneSCLJunkThreshold_|An integer from 0 through 9.|| -|_SCLQuarantineThresholdInt_|_msExchMessageHygieneSCLQuarantineThreshold_|An integer from 0 through 9.|| -|_SCLRejectThresholdInt_|_msExchMessageHygieneSCLRejectThreshold_|An integer from 0 through 9.|| -|_SecurityProtocol_|_securityProtocol_|`System.Byte[]`|| -|_SendDeliveryReportsTo_|n/a|`None` (0), `Manager` (1) or `Originator` (2).|| -|_SendOofMessageToOriginatorEnabled_|_oOFReplyToOriginator_|Boolean ( `$true` or `$false`)|| -|_ServerLegacyDN_|_msExchHomeServerName_|String (wildcards accepted).|| -|_ServerName_|n/a|String|| -|_SharingPolicy_|_msExchSharingPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| -|_SimpleDisplayName_|_displayNamePrintable_|String (wildcards accepted).|| -|_SingleItemrecoveryEnabled_|n/a|Boolean ( `$true` or `$false`)|| -|_SKUAssigned_|n/a|Boolean ( `$true` or `$false`)|| -|_SMimeCertificate_|_userSMIMECertificate_|`System.Byte[]`|This property contains the binary encoded S/MIME certificates that are issued to the user.| -|_StateOrProvince_|_st_|String (wildcards accepted).|| -|_StreetAddress_|_streetAddress_|String (wildcards accepted).|| -|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_TelephoneAssistant_|_telephoneAssistant_|String (wildcards accepted).|| -|_TextEncodedORAddress_|_textEncodedORAddress_|String (wildcards accepted).|| -|_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|String (wildcards accepted in dynamic distribution groups).|| -|_Title_|_title_|String (wildcards accepted).|| -|_UMAddresses_|_msExchUMAddresses_|String (wildcards accepted).|| -|_UMCallingLineIds_|_msExchUMCallingLineIds_|String (wildcards accepted).|| -|_UMDtmfMap_|_msExchUMDtmfMap_|String (wildcards accepted).|| -|_UMEnabled_|n/a|Boolean ( `$true` or `$false`)|This property specifies whether Unified Messaging (UM) is enabled for this mailbox.| -|_UMEnabledFlags_|_msExchUMEnabledFlags_|`None` (0), `UMEnabled` (1), `FaxEnabled` (2), `TUIAccessToCalendarEnabled` (4), `TUIAccessToEmailEnabled` (8), `SubscriberAccessEnabled` (16), `TUIAccessToAddressBookEnabled` (32), `AnonymousCallersCanLeaveMessages` (256), `ASREnabled` (512), or `VoiceMailAnalysisEnabled` (1024).|| -|_UMMailboxPolicy_|_msExchUMTemplateLink_|String (wildcards accepted in dynamic distribution groups).|| -|_UMPinChecksum_|_msExchUMPinChecksum_|`System.Byte[]`|| -|_UMRecipientDialPlanId_|_msExchUMRecipientDialPlanLink_|String (wildcards accepted in dynamic distribution groups).|| -|_UMServerWritableFlags_|_msExchUMServerWritableFlags_|`None` (0), `MissedCallNotificationEnabled` (1), `SMSVoiceMailNotificationEnabled` (2), `SMSMissedCallNotificationEnabled` (4), or `PinlessAccessToVoiceMailEnabled` (8).|| -|_UMSpokenName_|_msExchUMSpokenName_|`System.Byte[]`|| -|_UnicodePassword_|_unicodePwd_|`System.Byte[]`|| -|_UsageLocation_|_msExchUsageLocation_|A valid two-letter country/region ISO 3166 value, or the corresponding display name (for example, `US` or `UnitedStates`). For more information, see [Country Codes - ISO 3166](https://go.microsoft.com/fwlink/p/?linkid=213779).|| -|_UseDatabaseQuotaDefaults_|_mDBUseDefaults_|Boolean ( `$true` or `$false`)|If the value of this property is $true, the values of these properties are ignored for the mailbox: _IssueWarningQuota_, _ProhibitSendQuota_, _ProhibitSendReceiveQuota_, , _CalendarLoggingQuota_, _RecoverableItemsWarningQuota_, and _RecoverableItemsQuota_.| -|_UserAccountControl_|_userAccountControl_|For valid values, see the Remarks section in [User-Account-Control attribute](https://go.microsoft.com/fwlink/p/?linkid=183366). You need to convert the hexadecimal values to decimal. Most of the text values won't work as described (even if you remove `ADS_UF` and all underscores).|| -|_UserPrincipalName_|_userPrincipalName_|String (wildcards accepted).|This property contains the user principal name (UPN) for this recipient (for example, `kim@contoso.com`).| -|_VoiceMailSettings_|_msExchUCVoiceMailSettings_|String (wildcards accepted).|Valid values for this property are: `ExchangeHostedVoiceMail=0`, `ExchangeHostedVoiceMail=1`, `CsHostedVoiceMail=0`, or `CsHostedVoiceMail=1`.| -|_WebPage_|_wWWHomePage_|String (wildcards accepted).|| -|_WhenChanged_|_whenChanged_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WhenChangedUTC_|n/a|Dynamic distribution groups: A date/time value in Coordinated Universal Time (UTC).
Others: Blank or non-blank.|| -|_WhenCreated_|_whenCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WhenCreatedUTC_|n/a|Dynamic distribution groups: A date/time value in UTC.
Others: Blank or non-blank.|| -|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WindowsEmailAddress_|_mail_|String (wildcards accepted).|| -|_WindowsLiveID_|_msExchWindowsLiveID_|String (wildcards accepted).|| - -## For more information - -Exchange 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, [Need help converting your LDAP filters to OPATH?](https://go.microsoft.com/fwlink/p/?LinkId=88854). - -For more information about the syntax that can be used within OPATH filters, see [Exchange cmdlet syntax](../exchange-cmdlet-syntax.md). diff --git a/exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md b/exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md deleted file mode 100644 index 4d719277a2..0000000000 --- a/exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -title: "Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 12/20/2016 -ms.audience: ITPro -ms.topic: article -ms.prod: exchange-server-itpro -localization_priority: Normal -ms.assetid: 219f78a3-f0e5-4dc6-9787-9a0b9756ee09 -description: "Administrators can learn how to use Update-ExchangeHelp to update Exchange cmdlet reference topics that are available in Exchange Management Shell in Exchange 2016" ---- - -# Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers -Exchange cmdlet reference topics are created and updated all the time, but it's been difficult to get those updates into Exchange code in a timely manner so they're available in the Exchange Management Shell. Now, you can use the **Update-ExchangeHelp** cmdlet in the Exchange Management Shell to get the most up-to-date cmdlet reference topics for the command line in Exchange 2016.The **Update-ExchangeHelp** cmdlet automatically connects to a predefined website, compares the version of the local Exchange server and the installed languages to what's available in the update packages, and then downloads and installed the updated Exchange Management Shell help. Typically, the cmdlet connects to the Internet, but you can configure it to connect to an Intranet source inside your organization. - -**Contents**: - -[Use Update-ExchangeHelp on a single Internet-connected Exchange server](use-update-exchangehelp.md#Internet) - -[Configure Update-ExchangeHelp to get updates from an internal web server](use-update-exchangehelp.md#Internal) - -[Details about Update-ExchangeHelp](use-update-exchangehelp.md#Details) -## What do you need to know before you begin? - - -- Estimated time to complete: - - - Use **Update-ExchangeHelp** on a single Internet-connected Exchange server: less than 5 minutes. - - - Configure **Update-ExchangeHelp** to get updates from an internal web server: 30 minutes. - -- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Exchange server configuration settings" entry in the [Exchange and Shell infrastructure permissions](https://technet.microsoft.com/library/3646a4e8-36b2-41fb-89a4-79b0963fcb11.aspx) topic. - -- You can only use PowerShell to perform this procedure. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612). - -## Use Update-ExchangeHelp on a single Internet-connected Exchange server - - -This method requires that the Exchange 2016 server has direct access to the Internet. - -Run the following command in the Exchange Management Shell: - -``` -Update-ExchangeHelp -Verbose -``` - - **Notes:** - -- The _Verbose_ switch is important because it provides useful information. For example, it tells you if your Exchange server already has the latest version of help installed, or if you've run the command in the last 24 hours. - -- If you want to check for updates again within 24 hours, use the _Force_ switch. - -[Return to top](use-update-exchangehelp.md#RTT) - -## Configure Update-ExchangeHelp to get updates from an internal web server - - -In some organizations, internal servers don't have access to the Internet. If your internal Exchange 2016 servers don't have Internet access, you can configure **Update-ExchangeHelp** to point to an internal web server to get updates. The steps are as follows: - -1. Download and inspect the ExchangeHelpInfo.xml manifest file. - -2. Download the update packages, publish the update packages on an internal web server, and customize the ExchangeHelpInfo.xml manifest file. - -3. Publish the customized ExchangeHelpInfo.xml manifest file on an internal web server. - -4. Modify the registry of the Exchange servers to point to the customized ExchangeHelpInfo.xml manifest file. - -5. Use and maintenance of **Update-ExchangeHelp**. - -[Return to top](use-update-exchangehelp.md#RTT) - -### Step 1. Download and inspect the ExchangeHelpInfo.xml manifest file - -On a computer that has Internet access, open [https://go.microsoft.com/fwlink/p/?LinkId=287244](https://go.microsoft.com/fwlink/p/?LinkId=287244), save the ExchangeHelpInfo.xml manifest file in a location that's easy to remember, and open the file in Notepad. - -Each available update package is defined in a **\** section, and each **\** section contains the following keys. - -- **\** This key identifies the version Exchange that the update package applies to. `15.01.xxxx.xxx` is Exchange 2016. `15.00.xxxx.xxx` is Exchange 2013. Typically, this key specifies a range of versions. - -- **\** This key identifies the language that the update package applies to. This key might specify only one language or multiple languages. - -- **\** This key identifies the order that the updated packages were released for the major version of Exchange. In other words, the first update package released for Exchange 2016 is `001`, the second is `002`, etc. And, there's no relationship between the update packages and the order they were released in. For example, `001` might be an English only update, `002` might be an update for all other supported languages, and `003` might be a German-only update. - -- **\** This key identifies the name and location of the update package for the **\** section. - -The update package that's defined in a **\** section applies to an Exchange server based on the combination of **\** and **\** values. - -You might find that multiple **\** sections apply to your Exchange servers for a given version of Exchange. For example, there might be multiple updates for the same language, or separate updates for different languages that both apply to your Exchange servers because you have multiple languages installed. Either way, you need only the most recent update for your Exchange server version and language based on the **\** key. - -For example, suppose your Exchange servers are running Exchange 2016 version `15.01.0225.040` with English and Spanish installed, and the ExchangeHelpInfo.xml manifest file looks like this: - -``` - - - - - 15.01.0225.030-15.01.0225.050 - 001 - en - http://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En.cab - - - 15.01.0225.030-15.01.0225.050 - 002 - de, es, fr, it, ja, ko, pt, pu, ru, zh-HanS, zh-HanT - http://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_Loc.cab - - - 15.01.0225.030-15.01.0225.050 - 003 - en - http://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En2.cab - - - -``` - -In this example, all the updates apply to you based on the version of Exchange. However, you need only revision `003` for English, and revision `002` for Spanish. You don't need revision `001` for English because revision `003` is newer. - -[Return to top](use-update-exchangehelp.md#RTT) - -### Step 2. Download the update packages, publish the update packages on an internal web server, and customize the ExchangeHelpInfo.xml manifest file - -The easiest and least time-consuming approach might be to download every available update package that's defined in the ExchangeHelpInfo.xml manifest file. The benefits to this approach are: - -- **No analysis required**: It's difficult to make a mistake and accidentally miss an update that applies to you, because you're downloading every available update package. The **Update-ExchangeHelp** cmdlet ignores the update packages that don't apply to the Exchange server, so it doesn't hurt to download unneeded update packages. - -- **Easier maintenance**: Whenever a new update package is released, you don't need to spend time determining if the update package applies to you. You just download and customize the new ExchangeHelpInfo.xml manifest file, and download the new cabinet (.cab) file that's defined in it. - -To download all of the update packages, follow these steps. - -1. Download all of the .cab files that are defined in the ExchangeHelpInfo.xml manifest file by using the **\** values. Save the files in a location that's easy to remember. - -2. Publish the .cab files on an internal web server (for example `http://intranet.contoso.com/downloads/exchange`). - -3. Modify the URL values of the **\** keys to point to the internal web server where you published the .cab files. - - For example, change the value `http://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En.cab` to `http://intranet.contoso.com/downloads/exchange/ExchangePS_Update_En.cab`. - -4. Save the customized ExchangeHelpInfo.xml manifest file. - -The drawback to this approach is you download more .cab files than you actually need, and the unneeded .cab files consume space on your internal web server. - -If you want to identify only the update packages that apply to you, follow these steps. - -1. Find the version details for your Exchange servers. - - To find the version details on a single Exchange server, run the following command: - - ``` - Get-Command Exsetup.exe | ForEach {$_.FileVersionInfo} - ``` - - To find the version details for all Exchange servers in your organization, run the following command: - - ``` - Get-ExchangeServer | Sort-Object Name | ForEach {Invoke-Command -ComputerName $_.Name -ScriptBlock {Get-Command ExSetup.exe | ForEach{$_.FileVersionInfo}}} | Format-Table -Auto - ``` - - The result for **ProductVersion** will be in the format `15.01.0225.xxx`. - -2. Find the **\** sections in the ExchangeHelpInfo.xml manifest file that apply to your Exchange servers based on the values of the **\**, **\**, and **\** keys. The methodology was described in Step 1. - -After you identify the update packages that apply to you, follow these steps: - -1. Download the applicable .cab files by using the **\** values. Save the files in a location that's easy to remember. - -2. Publish the .cab files on an internal web server (for example `http://intranet.contoso.com/downloads/exchange`). - -3. Modify the URL values of the **\** keys to point to the internal web server where you published the .cab files. - - For example, change the value `http://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En.cab` to `http://intranet.contoso.com/downloads/exchange/ExchangePS_Update_En.cab`. - -4. Optionally, you can delete the **\** sections that don't apply to you. - -5. Save the customized ExchangeHelpInfo.xml manifest file. - -[Return to top](use-update-exchangehelp.md#RTT) - -### Step 3. Publish the customized ExchangeHelpInfo.xml manifest file on an internal web server - -Publish the customized ExchangeHelpInfo.xml manifest file from Step 2 on an internal web server that's accessible to your internal Exchange servers. For example, `http://intranet.contoso.com/downloads/exchange/ExchangeHelpInfo.xml`. You'll use the URL value of this location in Step 4. - -Note that there's no relationship between the ExchangeHelpInfo.xml manifest file and .cab file locations. You can have them available at the same URL or on different servers. - -[Return to top](use-update-exchangehelp.md#RTT) - -### Step 4. Modify the registry of your Exchange servers to point to the customized ExchangeHelpInfo.xml manifest file - -You need the download location of the customized ExchangeHelpInfo.xml manifest file that you configured in Step 3. This example uses the value `http://intranet.contoso.com/downloads/exchange/ExchangeHelpInfo.xml`. - -1. Copy and paste the following text into Notepad, customize the URL for your environment, and save the file as UpdateExchangeHelp.reg in a location that's easy to remember. - - ``` - Windows Registry Editor Version 5.00 - - [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExchangeServer\v15\UpdateExchangeHelp] - "ManifestUrl"="http://intranet.contoso.com/downloads/exchange/ExchangeHelpInfo.xml" - ``` - -2. Run the UpdateExchangeHelp.reg file on your internal Exchange servers. - -[Return to top](use-update-exchangehelp.md#RTT) - -### Step 5. Use and maintenance of Update-ExchangeHelp - -Now, when you run **Update-ExchangeHelp** in the Exchange Management Shell on your internal Exchange servers, the command gets download information and downloads files from the internal locations you specified. - -More interesting is the long-term maintenance of this customized configuration. Basically, you'll need to repeat Step 1 through Step 3 when you discover an update has been made available for Exchange cmdlet reference help, and you want to deploy that updated help to your Exchange servers. - -An easy way to find new update packages is to periodically run **Update-ExchangeHelp** on an Internet-connected Exchange server, or computer that has the Exchange mangement tools installed. - -[Return to top](use-update-exchangehelp.md#RTT) - -## Details about Update-ExchangeHelp - - -Windows PowerShell has the **Update-Help** and **Save-Help** cmdlets for online and offline updates of cmdlet reference topics. However, these cmdlets don't support Exchange cmdlet help, so a specific Exchange cmdlet is required to update cmdlet reference topics in the Exchange Management Shell. - -[Return to top](use-update-exchangehelp.md#RTT) - - diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md new file mode 100644 index 0000000000..acd6c6bdeb --- /dev/null +++ b/exchange/docs-conceptual/filter-properties.md @@ -0,0 +1,2182 @@ +--- +title: "Filterable properties for the Filter parameter" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 1/9/2024 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: b02b0005-2fb6-4bc2-8815-305259fa5432 +description: "Learn about the filterable properties for the Filter parameter in Exchange Server and Exchange Online." +--- + +# Filterable properties for the Filter parameter on Exchange cmdlets + +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) + +For more information about _recipient_ filters in Exchange PowerShell, see [Recipient filters in Exchange PowerShell commands](recipient-filters.md). + +> [!NOTE] +> The _Filter_ parameter is also available on other cmdlets (for example, **Get-MailboxStatistics**, **Get-Queue**, and **Get-Message**). However, the property values that are accepted by the _Filter_ parameter on these cmdlets aren't similar to the user and group properties that are described in this article. + +The properties that have been _confirmed_ to work with the _Filter_ parameter in user and group cmdlets are described in this article. + + **Notes**: + +- The list might include: + - Properties that are used only in one type of environment: Microsoft 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is meaningful (a value other than blank or `None`) only in one type of environment. + - Properties that are present, but correspond to features that are no longer used. + +- Not all recipient properties have a corresponding Active Directory property. The LDAP display name value is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange). + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although the _Filter_ parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). + +- Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). + +- To look for blank or non-blank property values, use the value `$null` (for example, `'Property -eq $null'` or `'Property -ne $null'`). + +- For filtering considerations for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). + +## AcceptMessagesOnlyFrom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_authOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## AcceptMessagesOnlyFromDLMembers + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_dLMemSubmitPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"`. or `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`. + +To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## ActiveSyncAllowedDeviceIDs + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMobileAllowedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`| + +A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`. + +After you have the device ID value, you can use it in the filter. For example, `Get-CasMailbox -Filter "(ActiveSyncAllowedDeviceIDs -like 'text1*') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'"`. + +## ActiveSyncBlockedDeviceIDs + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMobileBlockedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`| + +A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`. + +After you have the device ID value, you can use it in a filter. For example, `Get-CasMailbox -Filter "(ActiveSyncBlockedDeviceIDs -like 'text1*') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'"`. + +## ActiveSyncEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CasMailbox -Filter 'ActiveSyncEnable -eq $false'`. + +## ActiveSyncMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the ActiveSync mailbox policy. For example, `Get-CASMailbox -Filter "ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of ActiveSync mailbox policies by running this command: `Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName`. + +> [!NOTE] +> For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the **ActiveSyncMailboxPolicy** property is blank (`$null`). + +## ActiveSyncSuppressReadReceipt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CasMailbox -Filter 'ActiveSyncSuppressReadReceipt -eq $true'`. + +## AddressBookPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the address book policy. For example, `Get-Mailbox -Filter "AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of address book policies by running this command: `Get-AddressBookPolicy | Format-List Name,DistinguishedName`. + +## AddressListMembership + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_showInAddressBook_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name of the address list. For example, `Get-MailContact -Filter "AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of address lists by running this command: `Get-AddressList | Format-List Name,DistinguishedName`. + +## AdminDisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_adminDisplayName_|**Get-SecurityPrincipal**|String (wildcards accepted) or `$null`| + +For example, `Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Format-Table -Auto Name,AdminDisplayName`. + +## AdministrativeUnits + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|`$null`| + +For example, `Get-User -Filter 'AdministrativeUnits -ne $null'`. + +## AggregatedMailboxGuids + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'`. + +## Alias + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mailNickname_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-Recipient -Filter "Alias -like 'smith*'"`. + +## AllowUMCallsFromNonUsers + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)| + +For example, `Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"`. + +## ArbitrationMailbox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArbitrationMailbox_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the arbitration mailbox. For example, `Get-DistributionGroup -Filter "ArbitrationMailbox -eq 'CN=SystemMailbox"1f05a927-2e8f-4cbb-9039-2cfb8b95e486",CN=Users,DC=contoso,DC=com'"`. + +You can find the distinguished names of arbitration mailboxes by running this command: `Get-Mailbox -Arbitration | Format-List Name,DistinguishedName`. + +## ArchiveDatabase + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the archive mailbox database. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## ArchiveDomain + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +This property is used in on-premises Exchange environments to identify the Exchange Online organization that holds the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveDomain -like 'contoso.onmicrosoft.com*'"`. + +## ArchiveGuid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`. + +You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`. + +## ArchiveName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveName_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +This filter requires the name of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveName -like 'In-Place Archive*'"`. + +You can find the names of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName`. + +## ArchiveQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveQuota -gt '85GB'"`. + +## ArchiveRelease + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.| + +For example, `Get-Recipient -Filter 'ArchiveRelease -ne $null'`. + +## ArchiveState + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).| + +For example, `Get-Recipient -Filter "ArchiveState -eq 'HostedProvisioned'"`. + +## ArchiveStatus + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).| + +For example, `Get-Recipient -Filter "ArchiveStatus -eq 'Active'"`. + +## ArchiveWarningQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveWarnQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveWarningQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveWarningQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveWarningQuota -gt '85GB'"`. + +## AssistantName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "AssistantName -like 'Julia*'"`. + +## AuditEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxAuditEnable_|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'AuditEnabled -eq $true'`. + +## AuditLogAgeLimit + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxAuditLogAgeLimit_|**Get-Mailbox**
**Get-UnifiedGroup**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.| + +You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.AuditLogAgeLimit - ''"`. For example, `Get-Mailbox | where "$_.AuditLogAgeLimit -gt '60.00:00:00'"`. + +## AuthenticationPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAuthPolicyLink_|**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "AuthenticationPolicy -eq 'CN=Block Basic Auth,CN=Auth Policies,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR11B009,DC=PROD,DC=OUTLOOK,DC=COM'"`. + +## BlockedSendersHash + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchBlockedSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.| + +Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'BlockedSendersHash -ne $null'.` + +## c + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`| + +This filter requires the ISO 3166-1 two-letter country code for the user (for example, `US` for the United States). This property is used together with the _co_ and _countryCode_ properties to define the user's country in Active Directory. + +For example, `Get-User -Filter "c -eq 'US'"`. + +## CalendarLoggingQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchCalendarLoggingQuota_|**Get-Mailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "CalendarLoggingQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "CalendarLoggingQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.CalendarLoggingQuota - ''"`. For example, `Get-Mailbox | where "$_.CalendarLoggingQuota -gt '10GB'"`. + +## CalendarRepairDisabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchCalendarRepairDisabled_|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'`. + +## CertificateSubject + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`| + +The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers). + +For example, `Get-User -Filter "CertificateSubject -eq 'X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`') + +## City + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "City -eq 'Redmond'"`. + +## Company + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Company -like 'Contoso*'"`. + +## ComplianceTagHoldApplied + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`. + +## ConsumerNetID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`| + +For example, `Get-User -Filter 'ConsumerNetID -ne $null'`. + +## CountryCode + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer| + +This filter requires the ISO 3166-1 three-digit country code for the user (for example, `840` for the United States). This property is used together with the _c_ and _co_ properties to define the user's country in Active Directory. + +For example, `Get-User -Filter "countryCode -eq 796"`. + +## CountryOrRegion + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String| + +This filter requires the ISO 3166-1 country name for the user (for example, `United States`). You can select an available value in Active Directory Users and Computers ( **Address** tab > **Country/region** field), or the Exchange admin center (user properties > **Contact information** tab > **Country/Region** field). + +When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the _co_ and _countryCode_ properties are automatically configured. + +For example, `Get-User -Filter "CountryOrRegion -like 'United*'"`. + +## CustomAttribute1 to CustomAttribute15 + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_extensionAttribute1_ to _extensionAttribute15_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "CustomAttribute8 -like 'audited*'"`. + +## Database + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String| + +This filter requires the distinguished name of the mailbox database. For example, `Get-Mailbox -Filter "Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## DefaultPublicFolderMailbox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPublicFolderMailbox_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'"`. + +To find the distinguished names of public folder mailboxes, run this command: `Get-Mailbox -PublicFolder | Format-List Name,DistinguishedName`. + +## DeletedItemFlags + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).| + +For example, `Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"`. + +## DeliverToMailboxAndForward + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'`. + +## Department + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "Department -like 'Engineering*'"`. + +## DirectReports + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the direct report. For example, `Get-User -Filter "DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "DirectReports -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a direct report, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## DisabledArchiveDatabase + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the disabled archive mailbox database. For example, `Get-Mailbox -Filter "DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## DisabledArchiveGuid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDisabledArchiveDatabaseGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the GUID of the disabled archive mailbox. For example, `Get-Mailbox -Filter "DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`. + +You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`. + +## DisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_displayName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-Recipient -Filter "DisplayName -like 'Julia*'"`. + +## DistinguishedName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +This filter requires the distinguished name of the recipient. For example, `Get-Mailbox -Filter "DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'"`. + +You can find the distinguished names of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,DistinguishedName`. + +## EcpEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'EcpEnabled -eq $false'`. + +## EmailAddresses + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_proxyAddresses_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`. + +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but or `"EmailAddresses -like 'smtp:lila*'"` will return a match. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## EmailAddressPolicyEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-Recipient -Filter 'EmailAddressPolicyEnabled -eq $false'`. + +## EntryId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPublicFolderEntryId_|**Get-MailPublicFolder**|String (wildcards accepted)| + +For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`. + +You can find the entry IDs of mail-enabled public folders by running this command: `Get-MailPublicFolder | Format-List Name,EntryId`. + +## EwsApplicationAccessPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchEwsApplicationAccessPolicy_|**Get-CASMailbox**|`EnforceAllowList`, `EnforceBlockList`. or `$null`| + +For example, `Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'`. + +## EwsEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchEwsEnabled_|**Get-CASMailbox**|0 (disabled), 1 (enabled) or `$null`.| + +For example, `Get-CASMailbox -Filter "EwsEnabled -eq 1"`. + +## ExchangeGuid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String| + +For example, `Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"`. + +To find the Exchange GUID of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,ExchangeGuid`. + +Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is `00000000-0000-0000-0000-000000000000`. + +## ExchangeUserAccountControl + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)| + +For example, `Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"`. + +## ExchangeVersion + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchVersion_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|Integer| + +This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: `Get-Recipient | Format-Table Name,RecipientType,ExchangeVersion`. + +For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter. + +For the Exchange 2013 or Exchange 2016 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter. + +For example, `Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"`. + +## ExpansionServer + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"`. + +For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter "ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'"` + +You can find the **ExchangeLegacyDN** value by running this command: `Get-ExchangeServer | Format-List Name,ExchangeLegacyDN`. + +## ExtensionCustomAttribute1 to ExtensionCustomAttribute5 + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "ExtensionCustomAttribute8 -like 'audited*'"`. + +## ExternalDirectoryObjectId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`| + +For example, `Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'`. + +## ExternalEmailAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`. + +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` will return a match. + +## ExternalOofOptions + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExternalOOFOptions_|**Get-Mailbox**|`External` (0) or `InternalOnly` (1)| + +For example, `Get-Mailbox -Filter "ExternalOofOptions -eq 'External'"`. + +## Fax + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Fax -like '206*'"`. + +## FirstName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "FirstName -like 'Chris*'"`. + +## ForwardingAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter "ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a forwarding recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +## ForwardingSmtpAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"`. + +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ForwardingSmtpAddress -eq 'lila@fabrikam.com'"` returns a match, `"ForwardingSmtpAddress -like 'lila*'"` won't return a match, but `"ForwardingSmtpAddress -like 'smtp:lila*'"` will return a match. + +## GeneratedOfflineAddressBooks + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`| + +This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## GrantSendOnBehalfTo + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_publicDelegates_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## GroupMemberCount + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|Integer| + +For example, `Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"`. + +## GroupExternalMemberCount + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|Integer| + +For example, `Get-UnifiedGroup -Filter "GroupExternalMemberCount -gt 0"`. + +## GroupType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_groupType_|**Get-DistributionGroup**
**Get-Group**
**Get-UnifiedGroup**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).| + +Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter "GroupType -eq 'Universal,SecurityEnabled'"` returns the same results as `Get-DistributionGroup -Filter "GroupType -eq 'SecurityEnabled,Universal'"`. + +This multivalued property will only return a match if the property _equals_ the specified value. + +## Guid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectGuid_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +For example, `Get-Recipient -Filter "Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'"`. + +You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`. + +Note that an object's GUID value is different than its Exchange GUID value. + +## HasActiveSyncDevicePartnership + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)| + +For example, `Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'`. + +## HiddenFromAddressListsEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchHideFromAddressLists_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'`. + +## HiddenGroupMembershipEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_hideDLMembership_|**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-UnifiedGroup -Filter 'HiddenGroupMembershipEnabled -eq $true'`. + +## HomePhone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "HomePhone -like '206*'"`. + +## Id + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**
**Get-User**
**Get-SecurityPrincipal**
**Get-UnifiedGroup**|String| + +This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter "Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Id -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +## IgnoreMissingFolderLink + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| + +For example, `Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'`. + +## ImapEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'ImapEnabled -eq $false'`. + +## ImmutableId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`. + +## IncludeInGarbageCollection + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IncludeInGarbageCollection -eq $true'`. + +## Initials + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Initials -like 'B.'"`. + +## InPlaceHolds + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String| + +This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`. + +To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## InPlaceHoldsRaw + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|String| + +This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`. + +To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## IsDirSynced + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchIsMSODirsynced_|**Get-Contact**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-User -Filter 'IsDirSynced -eq $true'`. + +## IsExcludedFromServingHierarchy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'`. + +## IsHierarchyReady + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsHierarchyReady -eq $false'`. + +## IsHierarchySyncEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'`. + +## IsInactiveMailbox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'`. + +## IsLinked + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`. + +## IsMailboxEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'`. + +## IsResource + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsResource -eq $true'`. + +## IsSecurityPrincipal + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`. + +## IsShared + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsShared -eq $true'`. + +## IsSoftDeletedByDisable + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'`. + +## IsSoftDeletedByRemove + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsSoftDeletedByRemove -eq $true'`. + +## IssueWarningQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBStorageQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "IssueWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "IssueWarningQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.IssueWarningQuota - ''`". For example, `Get-Mailbox | where "$_.IssueWarningQuota -lt '50GB'"`. + +## JournalArchiveAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String| + +This property uses an SMTP email address. For example, `Get-Mailbox -Filter "JournalArchiveAddress -eq 'michelle@contoso.com'"`. + +## LanguagesRaw + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](/dotnet/api/system.globalization.cultureinfo). + +You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter "LanguagesRaw -eq 'en-US,es-MX'"` returns different results than `Get-Mailbox -Filter "LanguagesRaw -eq 'es-MX,en-US'"`. + +For single values, this multivalued property will return a match if the property _contains_ the specified value. + +## LastExchangeChangedTime + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchLastExchangeChangedTime_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Mailbox -Filter 'LastExchangeChangedTime -ne $null'`. + +## LegacyExchangeDN + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_legacyExchangeDN_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-User -Filter "LegacyExchangeDN -like 'Osca*'"`. + +You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN` + +## LitigationHoldDate + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchLitigationHoldDate_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"`. + +## LitigationHoldEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'`. + +## LitigationHoldOwner + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter "LitigationHoldOwner -eq 'agruber@contoso.com'"`. + +## LastName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "LastName -like 'Martin*'"`. + +## MailboxContainerGUID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'`. + +## MailboxMoveBatchName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +This property includes the name of the migration batch. For example, `Get-Mailbox -Filter "MailboxMoveBatchName -like 'LocalMove 01*'"`. + +You can find the names of migration batches by running the **Get-MigrationBatch** command. Note that migration batches that you create in the Exchange admin center use the naming convention `MigrationService:`. + +## MailboxMoveFlags + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest#-flags).| + +For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`. + +You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"` returns the same results as `Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"`. + +This multivalued property will only return a match if the property _equals_ the specified value. + +## MailboxMoveRemoteHostName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'`. + +## MailboxMoveSourceMDB + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the source mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## MailboxMoveStatus + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest#-movestatus).| + +For example, `Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"`. + +## MailboxMoveTargetMDB + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the target mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## MailboxPlan + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchParentPlanLink_|**Get-Mailbox**|String or `$null`| + +Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain. + +For example, `Get-Mailbox -Filter 'MailboxPlan -ne $null'`. + +## MailboxRelease + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.| + +For example, `Get-Recipient -Filter 'MailboxRelease -ne $null'`. + +## MailTipTranslations + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSenderHintTranslations_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, `Get-DistributionGroup -Filter "MailTipTranslations -like 'is not monitored.*'"`. + +## ManagedBy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ManagedBy -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## ManagedFolderMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +Managed folder mailbox policies aren't available in Exchange 2013 or later. + +For example, `Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'`. + +This filter requires the distinguished name of the managed folder mailbox policy. For example, `Get-Mailbox -Filter "ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: `Get-ManagedFolderMailboxPolicy | Format-List Name,DistinguishedName`. + +## Manager + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_manager_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, `Get-User -Filter "Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Manager -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a manager, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName.` + +## MAPIEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'MAPIEnabled -eq $false'`. + +## MasterAccountSid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $null'`. + +This value is blank ( `$null`) for mailboxes with associated user accounts, and `S-1-5-10` (Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes). + +## MaxBlockedSenders + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMaxBlockedSenders_|**Get-Mailbox**|Integer or `$null`| + +For example, `Get-Mailbox -Filter "MaxBlockedSenders -gt 0"`. + +## MaxReceiveSize + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_delivContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxReceiveSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxReceiveSize -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxReceiveSize -gt '50GB'"`. + +## MaxSafeSenders + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMaxSafeSenders_|**Get-Mailbox**|Integer or `$null`| + +For example, `Get-Mailbox -Filter "MaxSafeSenders -gt 0"`. + +## MaxSendSize + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_submissionContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxSendSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxSendSize -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxSendSize -gt '50GB'"`. + +## MemberDepartRestriction + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).| + +For example, `Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'ApprovalRequired'"`. + +## MemberJoinRestriction + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).| + +For example, `Get-DistributionGroup -Filter "MemberJoinRestriction -eq 'ApprovalRequired'"`. + +## MemberOfGroup + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_memberOf_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, `Get-User -Filter "MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "MemberOfGroup -eq 'contoso.com/Users/Marketing Group'"`. + +To find the distinguished name of a group, replace _\_ with the name, alias, or email address of the group, and run this command: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## Members + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group member. For example, `Get-Group -Filter "Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "Members -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a group member, replace _\_ with the name, alias, or email address of the group member, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## MobilePhone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "MobilePhone -like '555*'"`. + +## ModeratedBy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchModeratedByLink_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String| + +This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, `Get-DistributionGroup -Filter "ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "ModeratedBy -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## ModerationEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchEnableModeration_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'ModerationEnabled -eq $true'`. + +## Name + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_name_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-User -Filter "Name -like 'Laura*'"`. + +## NetID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`| + +This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`. + +For example, `Get-User -Filter 'NetId -ne $null'`. + +## Notes + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_info_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Notes -like 'Events Team*'"`. + +## ObjectCategory + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectCategory_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +This filter requires the canonical distinguished name of the object. The value uses the syntax `/Configuration/Schema/`. + +Valid _\_ values are: `Person` for mailboxes, mail users, and mail contacts, `Group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `ms-Exch-Public-Folder` for mail-enabled public folders, and `ms-Exch-Dynamic-Distribution-List` for dynamic distribution groups. + +For example, `Get-Recipient -Filter "ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'"`. + +## ObjectClass + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectClass_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +The value of this property is `top, person, organizationalPerson, user` for mailboxes and mail users, `top, person, organizationalPerson, contact` for mail contacts, `top, group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `msExchDynamicDistributionList` for dynamic distribution groups and `top, publicFolder` for mail-enabled public folders + +For example, `Get-Recipient -Filter "ObjectClass -eq 'Contact'"`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## Office + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_physicalDeliveryOfficeName_|**Get-Contact**
**Get-LinkedUser**
**Get-Mailbox**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Office -like '22*'"`. + +## OfflineAddressBook + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUseOAB_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "OfflineAddressBook -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"` + +You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`. + +## OnPremisesObjectId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-MailPublicFolder**|String or `$null`| + +For example, `Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'`. + +## OperatorNumber + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMOperatorNumber_|**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-UMMailbox -Filter "OperatorNumber -eq 5"`. + +## OtherFax + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "OtherFax -like '206*'"`. + +## OtherHomePhone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "OtherHomePhone -like '206*'"`. + +## OtherTelephone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "OtherTelephone -like '206*'"`. + +## OWAEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +The filter operates backwards. For example, `Get-CASMailbox -Filter 'OWAEnabled -eq $true'` returns mailboxes where the **OWAEnabled** property is `False`, and `Get-CASMailbox -Filter 'OWAEnabled -eq $false'` returns mailboxes where the **OWAEnabled** property is `True` + +## OWAforDevicesEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchOmaAdminWirelessEnable_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'OWAForDevicesEnabled -eq $true'`. + +## OWAMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, `Get-CASMailbox -Filter "OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com`'". + +You can find the distinguished names of Outlook on the web mailbox policies by running this command: `Get-OwaMailboxPolicy | Format-List Name,DistinguishedName`. + +## Pager + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Pager -like '206*'"`. + +## PersistedCapabilities + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +Typically, the value of this property something other than `$null` (blank) for Microsoft 365 accounts and mailboxes. For more information about the valid property values, see [Capability enumeration](/previous-versions/office/exchange-server-api/ff441134(v=exchg.150)). + +For example, `Get-Mailbox -Filter 'PersistedCapabilities -ne $null'`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## Phone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Phone -like '206*'"`. + +## PhoneProviderId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMPhoneProvider_|**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-UMMailbox -Filter "PhoneProviderId -like '206*'"`. + +## PhoneticDisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msDS-PhoneticDisplayName_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-MailPublicFolder**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "PhoneticDisplayName -like 'Lila*'"`. + +## PoliciesExcluded + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPoliciesExcluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +For example, `Get-Recipient -Filter 'PoliciesExcluded -ne $null'`. + +## PoliciesIncluded + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPoliciesIncluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +For example, `Get-Recipient -Filter 'PoliciesIncluded -eq $null'`. + +## PopEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'POPEnabled -eq $false'`. + +## PostalCode + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "PostalCode -eq 90210"`. + +## PostOfficeBox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "PostOfficeBox -like '555*'"`. + +## PreviousRecipientTypeDetails + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`| + +For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient#-recipienttypedetails). + +For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`. + +## PrimarySmtpAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)| + +Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property will also search values in the _EmailAddresses_ property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`. + +## ProhibitSendQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBOverQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendQuota -lt '70GB'"`. + +## ProhibitSendReceiveQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBOverHardQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendReceiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendReceiveQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendReceiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendReceiveQuota -lt '70GB'"`. + +## ProtocolSettings + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_protocolSettings_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4). + +For example, `Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"`. + +## PublicFolderContacts + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_pFContacts_|**Get-MailPublicFolder**|String or `$null`| + +This property is displayed as **Contacts** in the results of the command `Get-MailPublicFolder -Identity | Format-List`, but you need to use the property name **PublicFolderContacts** in the filter. + +This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a public folder contact, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## QueryBaseDN + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`| + +This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`). + +For example, `Get-Mailbox -Filter 'QueryBaseDN -ne $null'`. + +## RecipientContainer + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'"` or `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'contoso.com/Users'"` + +To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: `Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID`. + +## RecipientLimits + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`| + +For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`. + +## RecipientType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|`DynamicDistributionGroup`, `MailContact`, `MailNonUniversalGroup`, `MailUniversalDistributionGroup`, `MailUniversalSecurityGroup`, `MailUser`, `PublicFolder` or `UserMailbox`| + +For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`. + +## RecipientTypeDetails + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|String| + +For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient#-recipienttypedetails). + +For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`. + +## RecoverableItemsQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDumpsterQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsQuota - ''`. For example, `Get-Mailbox | where "$_.RecoverableItemsQuota -gt '35GB'"`. + +## RecoverableItemsWarningQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDumpsterWarningQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsWarningQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsWarningQuota - ''`". For example, `Get-Mailbox | where "$_.RecoverableItemsWarningQuota -gt '25GB'"`. + +## RejectMessagesFrom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_unauthOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## RejectMessagesFromDLMembers + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_dLMemRejectPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`. + +To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## RemoteAccountPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSyncAccountsPolicyDN_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name of the remote account policy. For example, `Get-Mailbox -Filter "RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +## RemotePowerShellEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-User -Filter 'RemotePowerShellEnabled -eq $false'`. + +## RemoteRecipientType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRemoteRecipientType_|**Get-Mailbox**
**Get-RemoteMailbox**|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), `TeamMailbox` (128), or `$null`.| + +For example, `Get-RemoteMailbox -Filter "RemoteRecipientType -eq 'ProvisionMailbox'"`. + +## ReportToManagerEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'`. + +## ReportToOriginatorEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'`. + +## RequireAllSendersAreAuthenticated + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRequireAuthToSendTo_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**|Boolean (`$true` or `$false`)| + +This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command `Get- -Identity | Format-List`, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter. For example, `Get-DistributionGroup -Filter 'RequireAllSendersAreAuthenticated -eq $false'`. + +## ResourceBehaviorOptions + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|`AllowOnlyMembersToPost`, `CalendarMemberReadOnly`, `ConnectorsEnabled`, `HideGroupInOutlook`, `NotebookForLearningCommunitiesEnabled`, `ReportToOriginator`, `SharePointReadonlyForMembers`, `SubscriptionEnabled`, `SubscribeMembersToCalendarEvents`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers`, `WelcomeEmailDisabled`, `WelcomeEmailEnabled`, or `$null`| + +For example, `Get-UnifiedGroup -Filter "ResourceBehaviorOptions -eq 'CalendarMemberReadOnly'"` + +## ResourceCapacity + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchResourceCapacity_|**Get-Mailbox**|Integer or `$null`| + +For example, `Get-Mailbox -Filter "ResourceCapacity -gt 15"` + +## ResourceCustom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|String or `$null`| + +You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`. + +When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter "ResourceCustom -eq 'Whiteboard'"`. + +## ResourceProvisioningOptions + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|`Team` or `$null`| + +For example, `Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"` + +## ResourceType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`| + +For example, `Get-Mailbox -Filter "ResourceType -eq 'Equipment'"` + +## RetainDeletedItemsFor + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_garbageCollPeriod_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.| + +You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.RetainDeletedItemsFor - ''"`. For example, `Get-Mailbox | where "$_.RetainDeletedItemsFor -gt '14.00:00:00'"`. + +## RetentionComment + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"` + +## RetentionPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter "RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of retention policies, run this command: `Get-RetentionPolicy | Format-List Name,DistinguishedName`. + +## RetentionUrl + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"` + +## RoleAssignmentPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, `Get-Mailbox -Filter "RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'"`. + +To find the distinguished names of role assignment policies in Exchange Online, run this command: `Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName`. + +## RulesQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMDBRulesQuota_|**Get-Mailbox**|A byte quantified size value (for example, `50B` or `128KB`). Unqualified values are treated as bytes.| + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RulesQuota - ''"`. For example, `Get-Mailbox | where "$_.RulesQuota -lt '256KB'"`. + +## SafeRecipientsHash + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSafeRecipientsHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.| + +Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeRecipientsHash -ne $null'.` + +## SafeSendersHash + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSafeSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.| + +Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeSendersHash -ne $null'.` + +## SamAccountName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_SamAccountName_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "SamAccountName -like 'laura*'"` + +## SCLDeleteThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLDeleteThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLDeleteThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLDeleteThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLDeleteThresholdInt -ge -2147483640"`. + +## SCLJunkThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLJunkThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLJunkThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLJunkThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLJunkThresholdInt -ge -2147483645"`. + +## SCLQuarantineThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLQuarantineThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLQuarantineThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLQuarantineThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLQuarantineThresholdInt -ge -2147483643"`. + +## SCLRejectThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLRejectThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLRejectThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLRejectThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLRejectThresholdInt -ge -2147483641"`. + +## SendOofMessageToOriginatorEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'`. + +## ServerLegacyDN + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"`. + +This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01`. + +## ServerName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`| + +For example, `Get-Recipient -Filter "ServerName -eq 'Mailbox01'"`. + +## SharingPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the sharing policy. For example, `Get-Mailbox -Filter "SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of sharing policies, run this command: `Get-SharingPolicy | Format-List Name,DistinguishedName`. + +> [!NOTE] +> For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the **SharingPolicy** property is blank (`$null`). + +## Sid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectSid_|**Get-Group**
**Get-LinkedUser**
**Get-SecurityPrincipal**
**Get-User**|String| + +For example, `Get-User -Filter "Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`. + +## SidHistory + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`| + +For example, `Get-User -Filter "SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`. + +## SimpleDisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_displayNamePrintable_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "SimpleDisplayName -like 'lila*'"`. + +## SingleItemrecoveryEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`. + +## SKUAssigned + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.| + +For example, `Get-User -Filter 'SKUAssigned -eq $true'`. + +## SourceAnchor + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter 'SourceAnchor -ne $null'`. + +## StateOrProvince + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "StateOrProvince -like 'Carolina*'"`. + +## StreetAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "StreetAddress -like '36th Ave NE*'"`. + +## StsRefreshTokensValidFrom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchStsRefreshTokensValidFrom_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-User -Filter "StsRefreshTokensValidFrom -gt '8/1/2017'"`. + +## TelephoneAssistant + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "TelephoneAssistant -like '206*'"`. + +## ThrottlingPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchThrottlingPolicyDN_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name of the throttling policy. For example, `Get-Mailbox -Filter "ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of throttling policies, run this command: `Get-ThrottlingPolicy | Format-List Name,DistinguishedName`. + +## Title + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Title -eq 'Dr.'"`. + +## UMAddresses + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMAddresses_|**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-UMMailbox -Filter 'UMAddresses -ne $null'`. + +## UMCallingLineIds + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "UMCallingLineIds -like '123*'"`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## UMDtmfMap + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMDtmfMap_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "UMDtmfMap -like '26297*'"`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## UMEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'UMEnabled -eq $true'`. + +## UMMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`| + +This filter requires the distinguished name of the UM mailbox policy. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of UM mailbox policies, run this command: `Get-UMMailboxPolicy | Format-List Name,DistinguishedName`. + +## UMRecipientDialPlanId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMRecipientDialPlanLink_|**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the UM dial plan. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Dial Plan,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of UM dial plans, run this command: `Get-UMDialPlan | Format-List Name,DistinguishedName`. + +## UpgradeRequest + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-User**|`None` (0), `TenantUpgrade` (1), `PrestageUpgrade` (2), `CancelPrestageUpgrade` (3), `PilotUpgrade` (4), or `TenantUpgradeDryRun` (5),| + +For example, `Get-User -Filter "UpgradeRequest -ne 'None'"`. + +## UpgradeStatus + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-User**|`None` (0), `NotStarted` (1), `InProgress` (2), `Warning` (3), `Error` (4), `Cancelled` (5), `Complete` (6), or `ForceComplete` (7).| + +For example, `Get-User -Filter "UpgradeStatus -ne 'None'"`. + +## UsageLocation + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`| + +This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html). + +For example, `Get-Recipient -Filter 'UsageLocation -eq "US"'`. + +## UseDatabaseQuotaDefaults + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBUseDefaults_|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'UseDatabaseQuotaDefaults -eq $false'`. + +## UserAccountControl + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExpirePassword`, or `NormalAccount`| + +For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`. + +You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"` returns different results than `Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"`. + +This multivalued property will only return a match if the property _equals_ the specified value. + +## UserPrincipalName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)| + +For example, `Get-User -Filter "UserPrincipalName -like 'julia@*'"`. + +## VoiceMailSettings + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| + +For example, `Get-User -Filter 'VoiceMailSettings -ne $null'`. + +## WebPage + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "WebPage -like 'https://intranet.contoso.com/*'"`. + +## WhenChanged + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_WhenChanged_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"`. + +## WhenChangedUTC + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenChangedUTC -gt '8/1/2017 2:00:00 PM'"`. + +## WhenCreated + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_whenCreated_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"`. + +## WhenCreatedUTC + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'"`. + +## WhenMailboxCreated + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchWhenMailboxCreated_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'"`. + +## WhenSoftDeleted + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +This filter requires the _SoftDeleted_ switch in the command for mailboxes. + +For example, `Get-Mailbox -SoftDeletedMailbox -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`. + +## WindowsEmailAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mail_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.com*'"`. + +## WindowsLiveID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.onmicrosoft.com*'"`.| + +## For more information + +Exchange 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, [Need help converting your LDAP filters to OPATH?](https://techcommunity.microsoft.com/t5/exchange-team-blog/need-help-converting-your-ldap-filters-to-opath/ba-p/595108). diff --git a/exchange/docs-conceptual/filters-v2.md b/exchange/docs-conceptual/filters-v2.md new file mode 100644 index 0000000000..aae21efdc2 --- /dev/null +++ b/exchange/docs-conceptual/filters-v2.md @@ -0,0 +1,72 @@ +--- +title: Filters in the Exchange Online PowerShell module +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/1/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 about how to use filtering for cmdlets in the Exchange Online V2 module and V3 module." +--- + +# Filters in the Exchange Online PowerShell module + +The Exchange Online PowerShell module contains nine exclusive **Get-EXO\*** cmdlets that are optimized for high speed, high volume operations, and (after you connect to your organization) gives you access to the hundreds of existing cmdlets in the service. For more information, see [Cmdlets in the Exchange Online PowerShell module](exchange-online-powershell-v2.md#cmdlets-in-the-exchange-online-powershell-module). + +In order to get the most out of filters in the nine exclusive **Get-EXO\*** cmdlets in the module, you need to follow the guidance in this article. + +> [!TIP] +> Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). + +## Use client-side filtering for the best performance + +Server-side filtering uses the available _Filter_ or _RecipientFilter_ parameters on a cmdlet. + +Client-side filtering uses the [Where-Object](/powershell/module/microsoft.powershell.core/where-object) cmdlet (also known as **where** or **?**). + +Generally, you get much better performance in Exchange PowerShell cmdlets with server-side filtering. However, for the Exchange Online PowerShell module, you actually get better performance when you use client-side filtering. We're working on improving the performance of server-side filtering in the module. + +## Unsupported filterable properties + +The **Get-EXO\*** cmdlets in the module support the majority of [filterable properties](filter-properties.md) that are available in their older, equivalent cmdlets. But, there are currently some properties that don't work with filtering in the **Get-EXO\*** cmdlets. These properties are described in the following table: + +|Cmdlet|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| + +## Supported operators + +The following operators are fully supported for all string formats in the **Get-EXO\*** cmdlets in the Exchange Online PowerShell module: + +- [Logical operators](/powershell/module/microsoft.powershell.core/about/about_logical_operators): + - `-and` + - `-not` + - `-or` + +- [Comparison operators](/powershell/module/microsoft.powershell.core/about/about_comparison_operators) + - `-eq` + - `-ne` + - `-lt` + - `-gt` + - `-like` + - `-notlike` + +The `-like` and `-notlike` operators are limited in using wildcards (*). Specifically, you can only use wildcards at the beginning of a string value, at the end of a string value, or both. + +For example, the following text search is not supported: + +`"UPN -like 'A*B*C'` + +However, the following searches are supported: + +`"UPN -like 'A*' -and UPN -like '*C' -and UPN like '*B*'"` diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md new file mode 100644 index 0000000000..e19393384e --- /dev/null +++ b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md @@ -0,0 +1,174 @@ +--- +title: "Find the permissions required to run any Exchange cmdlet" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 06/06/2024 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: 5bcc46d3-8a07-4e9f-b1b0-e4cb0b0afc12 +description: "Admins can learn how to use PowerShell to find the permissions required to run any cmdlet in Exchange Server PowerShell or Exchange Online PowerShell." +--- + +# Find the permissions required to run any Exchange cmdlet + +You can use PowerShell to find the permissions required to run any Exchange or Exchange Online cmdlet. This procedure shows the role-based access control (RBAC) management roles and role groups that give you access to a specified cmdlet—even if your organization has custom roles, custom role groups, or custom role assignments. + +> [!TIP] +> Currently, the procedures in this article don't work with Microsoft 365 Group cmdlets (**\*-UnifiedGroup**) in Exchange Online PowerShell. + +## What do you need to know before you begin? + +- Estimated time to complete this procedure: less than 5 minutes. + +- You can only use PowerShell to perform these procedures. + +- The procedures in this article don't work in Security & Compliance PowerShell. For more information about Security & Compliance permissions, see the following articles: + - [Permissions in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions) + - [Permissions in the Microsoft Purview compliance portal](/purview/purview-compliance-portal-permissions) + +- You need to be assigned permissions before you can do the procedures in this article. You have the following options: + - [Exchange Server permissions](/exchange/permissions/permissions): Membership in one of the following role groups: + - **Compliance Management** + - **Hygiene Management** + - **Organization Management** + - **View-Only Organization Management** + - [Exchange Online permissions](/exchange/permissions-exo/permissions-exo): Membership in one of the following role groups: + - **Compliance Management** + - **Delegated Setup** + - **Hygiene Management** + - **Organization Management** + - **View-Only Organization Management** + - [Microsoft Entra permissions](/entra/identity/role-based-access-control/manage-roles-portal): Membership in the **Global Administrator**\* or **Global Reader** roles gives users the required permissions _and_ permissions for other features in Microsoft 365. + + > [!IMPORTANT] + > \* Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## Use PowerShell to find the permissions required to run a cmdlet + +1. If you haven't already, open the Exchange PowerShell environment that you're interested in: + - **Exchange Online**: [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). + - **Exchange Online Protection** (Microsoft 365 organizations without Exchange Online mailboxes): [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). + - **Exchange Server**: [Open the Exchange Management Shell](open-the-exchange-management-shell.md) or [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). + +2. Replace `` and optionally, `,,...` with the values that you want to use, and run the following command: + + ```powershell + $Perms = Get-ManagementRole -Cmdlet [-CmdletParameters ,,...] + ``` + + > [!TIP] + > If you specify multiple parameters, only roles that include _all_ of the specified parameters on the cmdlet are returned. + +3. Run the following command: + + ```powershell + $Perms | foreach {Get-ManagementRoleAssignment -Role $_.Name -Delegating $false | Format-Table -Auto Role,RoleAssigneeType,RoleAssigneeName} + ``` + +## Interpreting the results + +The results contain the following information: + +- **Role**: Indicates the role that gives access to the cmdlet or the combination of cmdlet and parameters. Role names that begin with "My" are user roles that allow regular users to operate on objects they own (for example, their own mailbox or their distribution groups). + +- **RoleAssigneeType** and **RoleAssigneeName**: These values are inter-related: + - **RoleAssigneeType** is the type of object that has the role assigned to it. For administrator roles, this value is typically a role group, but it can also be a role assignment policy, a security group, or a user. + - **RoleAssigneeName** is the name of the role group, role assignment policy, security group, or user. + +## Troubleshooting + +What if there are no results? + +- Verify that you entered the cmdlet and parameter names correctly. +- Multiple parameters for a cmdlet might not be defined in a single role (some parameters might be in one role, while the others are in a different role). Take it one step at a time: + - Run the first command with no parameters, and then run the second command. + - Add one parameter to the first command, and then run the second command. + - Repeat the previous step by adding other parameters to the first command before running the second command. + +Otherwise, no results are likely caused by one of the following conditions: + +- The cmdlet or parameters are defined in a role that isn't assigned to any role groups by default. +- The cmdlet or parameters aren't available in your environment. For example, you specified an Exchange Online cmdlet or Exchange Online parameters in an on-premises Exchange environment. + +To find the roles in your environment (if any) that contain the cmdlet or parameters, replace `` and optionally, `,,...` with the values that you want to use and run the following command: + +```powershell +Get-ManagementRoleEntry -Identity *\ [-Parameters ,,...] +``` + +> [!TIP] +> You can use wildcard characters (\*) in the cmdlet and parameter names (for example, `*-Mailbox*`). + +If the command returns an error saying the object couldn't be found, the cmdlet or parameters aren't available in your environment. + +If the command returns results, the cmdlet or parameters are available in your environment, but the required role isn't assigned to any role groups. To find roles that aren't assigned to any role groups, run the following command: + +```powershell +$na = Get-ManagementRole; $na | foreach {If ((Get-ManagementRoleAssignment -Role $_.Name -Delegating $false) -eq $null) {$_.Name}} +``` + +## Related procedures + +### Include management role scopes + +Management role scopes (in particular, write scopes) define where cmdlets can operate. For example, the entire organization or only on specific user objects. + +To include scope information in the [Use PowerShell to find the permissions required to run a cmdlet](#use-powershell-to-find-the-permissions-required-to-run-a-cmdlet) output, add `*Scope*` to the second command: + +```powershell +$Perms | foreach {Get-ManagementRoleAssignment -Role $_.Name -Delegating $false | Format-List Role,RoleAssigneeType,RoleAssigneeName,*Scope*} +``` + +For detailed information about management role scopes, see [Understanding management role scopes](/exchange/understanding-management-role-scopes-exchange-2013-help). + +### Find all roles assigned to a specific user + +To see all roles that are assigned to a specific user, replace `` with the name, alias, or email address of the user and run the following command: + +```powershell +Get-ManagementRoleAssignment -RoleAssignee -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType +``` + +For example: + +```powershell +Get-ManagementRoleAssignment -RoleAssignee julia@contoso.com -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType +``` + +> [!TIP] +> The _RoleAssignee_ parameter returns both direct role assignments to users (uncommon) and indirect role assignments granted to the user through their membership in role groups. + +### Find all users who have a specific role assigned + +To see all users who have a specific role assigned to them, replace `` with the name of the role and run the following command: + +```powershell +Get-ManagementRoleAssignment -Role "" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod +``` + +For example: + +```powershell +Get-ManagementRoleAssignment -Role "Mailbox Import Export" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod +``` + +### Find the members of a role group + +To see the members of a specific role group, replace `` with the name of the role group and run the following command: + +```powershell +Get-RoleGroupMember "" +``` + +For example: + +```powershell +Get-RoleGroupMember "Organization Management" +``` + +> [!TIP] +> To see the names of all available role groups, run `Get-RoleGroup`. diff --git a/exchange/docs-conceptual/index.md b/exchange/docs-conceptual/index.md deleted file mode 100644 index 4a91526d40..0000000000 --- a/exchange/docs-conceptual/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Exchange PowerShell -description: Learn about the Exchange PowerShell environments that are available in on-premises Exchange and Office 365. -services: exchange-online -author: chrisda -manager: serdars -layout: LandingPage -ms.assetid: 9983a964-f642-4fcd-856b-452a172bcd4e -ms.service: exchange-online -ms.tgt_pltfrm: na -ms.devlang: na -ms.topic: landing-page -ms.date: 3/16/2018 -ms.author: chrisda ---- -# Exchange PowerShell - -Exchange PowerShell enables you to manage your Exchange Server and Office 365 organizations from the command line. For more information, select your environment: - -

diff --git a/exchange/docs-conceptual/index.yml b/exchange/docs-conceptual/index.yml new file mode 100644 index 0000000000..7fe140c922 --- /dev/null +++ b/exchange/docs-conceptual/index.yml @@ -0,0 +1,65 @@ +### YamlMime:Landing + +title: Exchange PowerShell documentation # < 60 chars +summary: Learn about the PowerShell environments that are available in on-premises Exchange Server and Microsoft 365. # < 160 chars + +metadata: + title: Exchange PowerShell documentation # Required; page title displayed in search results. Include the brand. < 60 chars. + description: Learn about the PowerShell environments that are available in on-premises Exchange and Microsoft 365. # Required; article description that is displayed in search results. < 160 chars. + services: exchange-online + ms.service: exchange-online #Required; service per approved list. service slug assigned to your service by ACOM. + ms.topic: landing-page # Required + ms.assetid: 9983a964-f642-4fcd-856b-452a172bcd4e + manager: deniseb + author: chrisda #Required; your GitHub user alias, with correct capitalization. + ms.author: chrisda #Required; microsoft alias of author; optional team alias. + ms.date: 9/1/2023 #Required; mm/dd/yyyy format. + +# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | sample | tutorial | video | whats-new + +landingContent: +# Cards and links should be based on top customer tasks or top subjects +# Start card title with a verb + # Card (optional) + - title: About + linkLists: + - linkListType: overview + links: + - text: Exchange Server PowerShell + url: /powershell/exchange/exchange-management-shell + - text: Exchange Online PowerShell + url: /powershell/exchange/exchange-online-powershell + - text: Security & Compliance PowerShell + url: /powershell/exchange/scc-powershell + - text: Exchange Online Protection PowerShell + url: /powershell/exchange/exchange-online-protection-powershell + - title: Connect + linkLists: + - linkListType: overview + links: + - text: Open the Exchange Management Shell + url: /powershell/exchange/open-the-exchange-management-shell + - text: Remotely connect to Exchange Server PowerShell + url: /powershell/exchange/connect-to-exchange-servers-using-remote-powershell + - text: Connect to Exchange Online PowerShell + url: /powershell/exchange/connect-to-exchange-online-powershell + - text: Connect to Security & Compliance PowerShell + url: /powershell/exchange/connect-to-scc-powershell + - text: Connect to Exchange Online Protection PowerShell + url: /powershell/exchange/connect-to-exchange-online-protection-powershell + - title: More + linkLists: + - linkListType: overview + links: + - text: Exchange cmdlet syntax + url: /powershell/exchange/exchange-cmdlet-syntax + - text: Find the permissions required to run any Exchange cmdlet + url: /powershell/exchange/find-exchange-cmdlet-permissions + - text: Control remote PowerShell access to Exchange servers + url: /powershell/exchange/control-remote-powershell-access-to-exchange-servers + - text: About the Exchange Online PowerShell module + url: /powershell/exchange/exchange-online-powershell-v2 + - text: What's new in the Exchange Online PowerShell module + url: /powershell/exchange/whats-new-in-the-exo-module + - text: Enable or disable access to Exchange Online PowerShell + url: /powershell/exchange/disable-access-to-exchange-online-powershell diff --git a/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md b/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md new file mode 100644 index 0000000000..50aba1763d --- /dev/null +++ b/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md @@ -0,0 +1,127 @@ +--- +title: Workarounds for Invoke-Command scenarios in REST API connections +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 7/5/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-powershell +ms.reviewer: +ms.localizationpriority: medium +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about the alternatives to Invoke-Command commands in REST API connections using the EXO V3 module." +--- + +# Workarounds for Invoke-Command scenarios in REST API connections + +In multiple connections to Exchange Online or Security & Compliance PowerShell in the same window, you use the [Invoke-Command](/powershell/module/microsoft.powershell.core/invoke-command) cmdlet to run scripts or commands in a specific remote PowerShell session. But, the **Invoke-Command** cmdlet doesn't work in [REST API connections](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module) to Exchange Online or Security & Compliance PowerShell. + +This article offers REST API alternatives for scenarios that that use **Invoke-Command** commands. + +## Scenario 1: Run Exchange Online cmdlets + +This example finds the identity of any other user (`$Us = $User.Identity`). + +> [!TIP] +> Other commands were required to get the values of `$User` and therefore `$Us`. Those commands aren't important. The overall approach that's being used is what's important. + +- **In a remote PowerShell session**: Use the **Get-PSSession** cmdlet to store the remote PowerShell session details in the variable named `$Session`, and then run the following command: + + ```powershell + Invoke-Command -Session $Session -ScriptBlock {Get-User $Using:Us | Select-Object DistinguishedName, ExternalDirectoryObjectId} -ErrorAction SilentlyContinue + ``` + +- **In a REST API session**: Run the following command: + + ```powershell + Get-User $Us | Format-List DistinguishedName, ExternalDirectoryObjectId + ``` + +This example finds the identity of a group member: + +- **In a remote PowerShell session**: Use the **Get-PSSession** cmdlet to store the remote PowerShell session details in the variable named `$Session`, and then run the following command: + + ```powershell + Invoke-Command -Session $Session -ScriptBlock {Get-Recipient -Filter "Members -eq '$($User.DistinguishedName)'" -RecipientTypeDetails MailUniversalDistributionGroup | Select-Object DisplayName, ExternalDirectoryObjectId, RecipientTypeDetails} -ErrorAction SilentlyContinue -HideComputerName + ``` + +- **In a REST API session**: Run the following command: + + ```powershell + Get-Recipient -Filter "Members -eq '$($User.DistinguishedName)'" -RecipientTypeDetails MailUniversalDistributionGroup | Format-List DisplayName, ExternalDirectoryObjectId, RecipientTypeDetails + ``` + +## Scenario 2: Run Exchange Online cmdlets and expand specific properties + +This example finds all mailboxes where the GrantSendOnBehalfTo permission is set, and then returns the users who have the permission on the mailbox. + +- **In a remote PowerShell session**: Use the **Get-PSSession** cmdlet to store the remote PowerShell session details in the variable named `$Session`, and then run the following command: + + ```powershell + Invoke-Command -Session $Session -ScriptBlock {Get-Mailbox -Filter "GrantSendOnBehalfTo -ne `$null" -ErrorAction SilentlyContinue | Select-Object ExternalDirectoryObjectId, GrantSendOnBehalfTo -ExpandProperty GrantSendOnBehalfTo} + ``` + +- **In a REST API session**: Run the following command: + + ```powershell + $mailboxes = Get-Mailbox -Filter "GrantSendOnBehalfTo -ne `$null" + + foreach ($mailbox in $mailboxes) + + { + $users = $mailbox | Select-Object GrantSendOnBehalfTo -ExpandProperty GrantSendOnBehalfTo | Get-User + + $users | Select-Object Name, Guid + } + ``` + +## Scenario 3: Run Exchange Online cmdlets in a specific PowerShell session when multiple sessions are present + +This example shows how to create two PowerShell sessions in the same window and run the **Get-Mailbox** cmdlet in each session. + +- **In a remote PowerShell session**: + 1. Use the **Get-PSSession** cmdlet to store the first remote PowerShell session details in the variable named `$Session1`. + 2. Use the **Get-PSSession** cmdlet to store the second remote PowerShell session details in the variable named `$Session2`. + 3. Run the following commands: + + ```powershell + Invoke-Command -Session $Session1 -ScriptBlock {Get-Mailbox -ResultSize 1} + + Invoke-Command -Session $Session2 -ScriptBlock {Get-Mailbox -ResultSize 1} + ``` + +- **In a REST API session**: + 1. In the first **Connect-ExchangeOnline** command, use the parameter _Prefix_ with the value C1. + 2. Store the first REST API connection details in the variable named `$ConnectionInfo1` by running the following command: + + ```powershell + $ConnectionInfo1 = Get-ConnectionInformation | Where-Object { $_.ModulePrefix -eq "C1"} + ``` + + 3. In the second **Connect-ExchangeOnline** command, use the parameter _Prefix_ with the value C2. + 4. Store the second REST API connection details in the variable named `$ConnectionInfo2` by running the following command: + + ```powershell + $ConnectionInfo1 = Get-ConnectionInformation | Where-Object { $_.ModulePrefix -eq "C2"} + ``` + + 5. Now you can run commands in either session. For example: + + ```powershell + $CommandStr1 = "Get-$($ConnectionInfo1.ModulePrefix)Mailbox -ResultSize 10" + + Invoke-Expression $CommandStr1 + ``` + + Or + + ```powershell + $CommandStr2 = "Get-$($ConnectionInfo2.ModulePrefix)Mailbox -ResultSize 10" + + Invoke-Expression $CommandStr2 + ``` diff --git a/exchange/docs-conceptual/media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png b/exchange/docs-conceptual/media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png deleted file mode 100644 index ab6fca6e9e..0000000000 Binary files a/exchange/docs-conceptual/media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/24645e56-8b11-4c0f-ace4-09bdb2703562.png b/exchange/docs-conceptual/media/24645e56-8b11-4c0f-ace4-09bdb2703562.png deleted file mode 100644 index e3bb7eb65a..0000000000 Binary files a/exchange/docs-conceptual/media/24645e56-8b11-4c0f-ace4-09bdb2703562.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/MSN_Video_Widget.gif b/exchange/docs-conceptual/media/MSN_Video_Widget.gif deleted file mode 100644 index 852a7daa98..0000000000 Binary files a/exchange/docs-conceptual/media/MSN_Video_Widget.gif and /dev/null differ diff --git a/exchange/docs-conceptual/media/add-icon.png b/exchange/docs-conceptual/media/add-icon.png new file mode 100644 index 0000000000..9a4d36acf7 Binary files /dev/null and b/exchange/docs-conceptual/media/add-icon.png differ diff --git a/exchange/docs-conceptual/media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png b/exchange/docs-conceptual/media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png deleted file mode 100644 index 9973407fe0..0000000000 Binary files a/exchange/docs-conceptual/media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/connect-exo-mfa-verify-prompt.png b/exchange/docs-conceptual/media/connect-exo-mfa-verify-prompt.png new file mode 100644 index 0000000000..9878357ce7 Binary files /dev/null and b/exchange/docs-conceptual/media/connect-exo-mfa-verify-prompt.png differ diff --git a/exchange/docs-conceptual/media/connect-exo-password-prompt.png b/exchange/docs-conceptual/media/connect-exo-password-prompt.png new file mode 100644 index 0000000000..0046efef70 Binary files /dev/null and b/exchange/docs-conceptual/media/connect-exo-password-prompt.png differ diff --git a/exchange/docs-conceptual/media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png b/exchange/docs-conceptual/media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png deleted file mode 100644 index 014a8d3165..0000000000 Binary files a/exchange/docs-conceptual/media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png new file mode 100644 index 0000000000..75ff84fb7f Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-removed-from-graph.png b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-removed-from-graph.png new file mode 100644 index 0000000000..1da31d9437 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-removed-from-graph.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-add-a-permission.png b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-add-a-permission.png new file mode 100644 index 0000000000..52056bb322 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-add-a-permission.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png new file mode 100644 index 0000000000..e39a40aaec Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-o365-exo.png b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-o365-exo.png new file mode 100644 index 0000000000..5db4cced79 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-o365-exo.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role-scc.png b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role-scc.png new file mode 100644 index 0000000000..4783aede58 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role-scc.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role.png b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role.png new file mode 100644 index 0000000000..5e05c99150 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-app-registration-page.png b/exchange/docs-conceptual/media/exo-app-only-auth-app-registration-page.png new file mode 100644 index 0000000000..c43cf46b86 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-app-registration-page.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-certificate-successfully-added.png b/exchange/docs-conceptual/media/exo-app-only-auth-certificate-successfully-added.png new file mode 100644 index 0000000000..27c2e1e65d Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-certificate-successfully-added.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-add-select-app-for-assignment.PNG b/exchange/docs-conceptual/media/exo-app-only-auth-find-add-select-app-for-assignment.PNG new file mode 100644 index 0000000000..09b7bcb514 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-add-select-app-for-assignment.PNG differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role-scc.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role-scc.png new file mode 100644 index 0000000000..10075fff24 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role-scc.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role.png new file mode 100644 index 0000000000..2b4aa3aaf5 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-app-registrations.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-app-registrations.png new file mode 100644 index 0000000000..ebdbe372a5 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-app-registrations.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-roles-and-administrators.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-roles-and-administrators.png new file mode 100644 index 0000000000..373d9995a9 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-roles-and-administrators.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-manifest-select-api-permissions.png b/exchange/docs-conceptual/media/exo-app-only-auth-manifest-select-api-permissions.png new file mode 100644 index 0000000000..da6ca1af65 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-manifest-select-api-permissions.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-new-app-registration.png b/exchange/docs-conceptual/media/exo-app-only-auth-new-app-registration.png new file mode 100644 index 0000000000..dc4154af4a Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-new-app-registration.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png b/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png new file mode 100644 index 0000000000..4d52b45e84 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png b/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png new file mode 100644 index 0000000000..d06da71669 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png new file mode 100644 index 0000000000..4fb99251c5 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments.png b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments.png new file mode 100644 index 0000000000..64f2025b8f Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-role-description-page-click-assignments.PNG b/exchange/docs-conceptual/media/exo-app-only-auth-role-description-page-click-assignments.PNG new file mode 100644 index 0000000000..4f7e9e97ab Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-role-description-page-click-assignments.PNG differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-certificates-and-secrets.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-certificates-and-secrets.png new file mode 100644 index 0000000000..1c5f46f150 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-certificates-and-secrets.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png new file mode 100644 index 0000000000..89eb491ef9 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-upload-certificate.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-upload-certificate.png new file mode 100644 index 0000000000..bf40ab47a3 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-upload-certificate.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-upload-certificate-dialog.png b/exchange/docs-conceptual/media/exo-app-only-auth-upload-certificate-dialog.png new file mode 100644 index 0000000000..77ef07a65a Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-upload-certificate-dialog.png differ diff --git a/exchange/docs-conceptual/media/mi-add-exo-module.png b/exchange/docs-conceptual/media/mi-add-exo-module.png new file mode 100644 index 0000000000..fa36117aa4 Binary files /dev/null and b/exchange/docs-conceptual/media/mi-add-exo-module.png differ diff --git a/exchange/docs-conceptual/media/search-icon.png b/exchange/docs-conceptual/media/search-icon.png new file mode 100644 index 0000000000..6241aea737 Binary files /dev/null and b/exchange/docs-conceptual/media/search-icon.png differ diff --git a/exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md b/exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md deleted file mode 100644 index d0db4f9b8a..0000000000 --- a/exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "Connect to Office 365 Security & Compliance Center PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 5/9/2018 -ms.audience: Admin -ms.topic: article -ms.service: o365-security-and-compliance -localization_priority: Normal -ms.assetid: 45a5242d-95b7-4a6a-9794-095bb6d8d9d0 -search.appverid: MET150 -description: "Learn how to connect to Security & Compliance Center PowerShell." ---- - -# Connect to Office 365 Security & Compliance Center PowerShell -Office 365 Security & Compliance Center PowerShell allows you to manage your Office 365 Security & Compliance Center settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to the Security & Compliance Center. It's a simple three-step process where you enter your Office 365 credentials, provide the required connection settings, and then import the Security & Compliance Center cmdlets into your local Windows PowerShell session so that you can use them. - -> [!NOTE] -> If you want to use multi-factor authentication (MFA) to connect to Security & Compliance Center PowerShell, or if your organization uses federated authentication, you need to download and use the Exchange Online Remote PowerShell Module. For more information, see [Connect to Office 365 Security & Compliance Center PowerShell using multi-factor authentication](mfa-connect-to-scc-powershell.md). For some features (for example, mailbox archiving), the Security & Compliance Center links to existing functionality in the Exchange admin center (EAC). To use PowerShell with these features, you need to connect to Exchange Online instead of the Security & Compliance Center. For more information, see [Connect to Exchange Online PowerShell](../../exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md). - -For more information about the Security & Compliance Center, see [Office 365 Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=627054). - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- Office 365 global admins have access to the Security & Compliance Center, but everyone else needs to have their access configured for them. For details, see [Give users access to the Office 365 Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=627057). - -- You can use the following versions of Windows: - - - Windows 10 - - - Windows 8.1 - - - Windows Server 2016 - - - Windows Server 2012 or Windows Server 2012 R2 - - - Windows 7 Service Pack 1 (SP1)* - - - Windows Server 2008 R2 SP1* - - * For older versions of Windows, you need to install the Microsoft.NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868), [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757), [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - `Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.` - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ``` - Set-ExecutionPolicy RemoteSigned - ``` - - You need to configure this setting only once on your computer, not every time you connect. - -## Connect to the Security & Compliance Center - -1. On your local computer, open Windows PowerShell and run the following command: - - ``` - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box that appears, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ``` - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.compliance.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.compliance.protection.outlook.de/powershell-liveid/` - - - If you want to connect to Security & Compliance Center PowerShell in the same window as an active Exchange Online PowerShell connection, you need to add `-Prefix "CC"` to the end of this command to prevent cmdlet name collisions (both environments share some cmdlets with the same names). - -3. Run the following command: - - ``` - Import-PSSession $Session -DisableNameChecking - ``` - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. - -``` -Remove-PSSession $Session -``` - -## How do you know this worked? - -After Step 3, the Security & Compliance Center cmdlets are imported into your local Windows PowerShell session as tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run a Security & Compliance Center cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- Verify that your account has permission to access the Security & Compliance Center. For details, see [Give users access to the Office 365 Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=627057). - -- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to the Security & Compliance Center. - -- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - `The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation.` - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance Center PowerShell endpoint. - -## See also - -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. - -- [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkId=389618) - -- [New-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389621) - -- [Import-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389619) - -- [Remove-PSSession](https://go.microsoft.com/fwlink/p/?LinkId=389620) - -- [Set-ExecutionPolicy](https://go.microsoft.com/fwlink/p/?LinkId=389623) - - diff --git a/exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md b/exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md deleted file mode 100644 index dd236c3c18..0000000000 --- a/exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: "Connect to Office 365 Security & Compliance Center PowerShell using multi-factor authentication" -ms.author: chrisda -author: chrisda -ms.date: 5/9/2018 -ms.audience: Admin -ms.topic: article -ms.service: o365-security-and-compliance -localization_priority: Normal -ms.assetid: 8e11c808-e734-4874-ac94-e5251ea85c19 -search.appverid: MET150 -description: "Learn how to connect to Security & Compliance Center PowerShell by using multi-factor authentication (MFA) or federated authentication." ---- - -# Connect to Office 365 Security & Compliance Center PowerShell using multi-factor authentication -If your account uses multi-factor authentication (MFA) or federated authentication, you can't use the instructions at [Connect to Office 365 Security & Compliance Center PowerShell](connect-to-scc-powershell.md) to use remote PowerShell to connect to the Office 365 Security & Compliance Center. Instead, you need to install the Exchange Online Remote PowerShell Module, and use the **Connect-IPPSSession** cmdlet to connect to Security & Compliance Center PowerShell. - -> [!NOTE] -> • You can't use the Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell and Security & Compliance Center PowerShell in the same session (window). You need to use separate sessions of the Exchange Online Remote PowerShell Module.
• Delegated Access Permission (DAP) partners can't use the procedures in this topic to connect to their customer tenant organizations in Security & Compliance Center PowerShell. MFA and the Exchange Online Remote PowerShell Module don't work with delegated authentication. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- You can use the following versions of Windows: - - - Windows 10 - - - Windows 8.1 - - - Windows Server 2016 - - - Windows Server 2012 or Windows Server 2012 R2 - - - Windows 7 Service Pack 1 (SP1)* - - - Windows Server 2008 R2 SP1* - - * For older versions of Windows, you need to install the Microsoft.NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Installing the .NET Framework](https://go.microsoft.com/fwlink/p/?LinkId=257868), [Windows Management Framework 3.0](https://go.microsoft.com/fwlink/p/?LinkId=272757), [Windows Management Framework 4.0](https://go.microsoft.com/fwlink/p/?LinkId=391344), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- The Exchange Online Remote PowerShell Module needs to be installed on your computer. If your installed version of the Exchange Online Remote PowerShell Module doesn't have the **Connect-IPPSSession** cmdlet, you need to install the latest version of the module: - - 1. In Internet Explorer or Edge, open the Exchange admin center (EAC) for your Exchange Online organization. For instructions, see [Exchange Admin Center in Exchange Online](http://technet.microsoft.com/library/ace44f6b-4084-4f9c-89b3-e0317962472b.aspx). - - **Note**: Internet Explorer or Edge is required because the download in the next step uses ClickOnce, so Google Chrome or Mozilla Firefox won't work. - - 2. In the EAC, go to **Hybrid** > **Setup** and click the appropriate **Configure** button to download the Exchange Online Remote PowerShell Module for multi-factor authentication. - - ![Download the Exchange Online PowerShell Module from the Hybrid tab in the EAC](../../media/24645e56-8b11-4c0f-ace4-09bdb2703562.png) - - 3. In the **Application Install** window that opens, click **Install**. - - ![Click Install in the Exchange Online PowerShell Module window](../../media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png) - -- Windows Remote Management (WinRM) on your computer needs to allow basic authentication (it's enabled by default). To verify that basic authentication is enabled, run this command in a Command Prompt: - - ``` - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command from an elevated Command Prompt (a Command Prompt window you open by selecting **Run as administrator**) to enable basic authentication for WinRM: - - ``` - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - If basic authentication is disabled, you'll get this error when you try to connect: - - `The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again.` - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612), [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Security & Compliance Center PowerShell by using MFA or federated authentication - -1. On your local computer, open the **Exchange Online Remote PowerShell Module** (**Microsoft Corporation** > **Microsoft Exchange Online Remote PowerShell Module**). - -2. The command that you need to run uses the following syntax: - - ``` - Connect-IPPSSession -UserPrincipalName [-ConnectionUri -AzureADAuthorizationEndPointUri ] - ``` - - - _\_ is your Office 365 work or school account. - - - The _\_ and _\_ values depend on the location of your Office 365 organization as described in the following table: - - |**Office 365 offering**|**_ConnectionUri_ parameter value**|**_AzureADAuthorizationEndPointUri_ parameter value**| - |:-----|:-----|:-----| - |Office 365 |Not used |Not used | - |Office 365 Germany | `https://ps.compliance.protection.outlook.de/PowerShell-LiveID` | `https://login.microsoftonline.de/common` | - - This example connects to the Security & Compliance Center in Office 365 using the account chris@contoso.com. - - ``` - Connect-IPPSSession -UserPrincipalName chris@contoso.com - ``` - - This example connects to the Security & Compliance Center in Office 365 Germany using the account lukas@fabrikam.com. - - ``` - Connect-IPPSSession -UserPrincipalName lukas@fabrikam.com -ConnectionUri https://ps.compliance.protection.outlook.de/PowerShell-LiveID -AzureADAuthorizationEndPointUri https://login.microsoftonline.de/common - ``` - -3. In the sign-in window that opens, enter your password, and then click **Sign in**. - - ![Enter your password in the Exchange Online Remote PowerShell window](../../media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png) - - For MFA, a verification code is generated and delivered based on the verification response option that's configured for your account (for example, a text message or the Azure Authenticator app on your mobile phone). - -4. **(MFA only)**: In the verification window that opens, enter the verification code, and then click **Sign in**. - - ![Enter your verification code in the Exchange Online Remote PowerShell window](../../media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png) - -## How do you know this worked? - -After you sign in, the Security & Compliance Center cmdlets are imported into your Exchange Online Remote PowerShell Module session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Security & Compliance Center cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. - -If you receive errors, check the following requirements: - -- To help prevent denial-of-service (DoS) attacks, you're limited to three open remote PowerShell connections to the Security & Compliance Center. - -- The account you use to connect to the Security & Compliance Center must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](../../exchange-online/disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Office 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The **Connect-IPPSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - `The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation.` - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance PowerShell endpoint. diff --git a/exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md b/exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md deleted file mode 100644 index 7a933beb1d..0000000000 --- a/exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Office 365 Security & Compliance Center PowerShell" -ms.author: chrisda -author: chrisda -manager: serdars -ms.date: 9/29/2015 -ms.audience: Admin -ms.topic: article -ms.service: o365-security-and-compliance -localization_priority: Normal -ms.assetid: 2f33bb84-cede-46f6-9d39-d246e8ce3543 -search.appverid: MET150 -description: "Learn about using PowerShell in the Office 365 Security & Compliance Center." ---- - -# Office 365 Security & Compliance Center PowerShell -Security & Compliance Center PowerShell is the administrative interface that enables you to manage your Office 365 Security & Compliance Center settings from the command line. For example, you can use Security & Compliance Center PowerShell to perform Compliance Searches and configure access to the Security & Compliance Center. The following topics provide information about using Security & Compliance Center PowerShell: - -- To create a remote PowerShell session to the Security & Compliance Center, see [Connect to Office 365 Security & Compliance Center PowerShell](connect-to-scc-powershell/connect-to-scc-powershell.md). Note that the connection instructions are different from Exchange Online or Exchange Online Protection (the _ConnectionUri_ value is different). - -- A cmdlet is a lightweight command that is imported into your local Windows PowerShell session. Note that some cmdlets are available only in the Security & Compliance Center. Other cmdlets have the same names and functionality as those in Exchange Online, but they are also available in the Security & Compliance Center. - - diff --git a/exchange/docs-conceptual/open-the-exchange-management-shell.md b/exchange/docs-conceptual/open-the-exchange-management-shell.md new file mode 100644 index 0000000000..c097a3fc37 --- /dev/null +++ b/exchange/docs-conceptual/open-the-exchange-management-shell.md @@ -0,0 +1,80 @@ +--- +title: "Open the Exchange Management Shell" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/7/2023 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: 63976059-25f8-4b4f-b597-633e78b803c0 +description: "Find and open the shortcut for Exchange PowerShell (also known as the Exchange Management Shell) on Exchange servers or computers that have the Exchange management tools installed." +--- + +# Open the Exchange Management Shell + +The Exchange Management Shell enables you to do administrative tasks on Exchange servers from the command line. You can open the Exchange Management Shell from the following locations: + +- On the Exchange server directly or in a Remote Desktop Connection session. +- On a local computer after you install the Exchange management tools. For more information, see [Install the Exchange management tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools). + +## What do you need to know before you begin? + +- Estimated time to complete this procedure: less than 1 minute. + +- To do the procedures in this article, you need to be assigned at least one management role (typically, via membership in a role group). After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Exchange Server permissions](/exchange/permissions/permissions). + +- Running the Exchange Management Shell from a local installation of the Exchange management tools requires remote PowerShell access for your user account. By default, users are allowed to use remote PowerShell to connect to an Exchange server, but you can block remote PowerShell access for user accounts. For instructions, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). + +> [!TIP] +> Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. + +## Open the Exchange Management Shell in Windows Server 2019 Core + +- **Mailbox servers**: Run the following command from a Command Prompt: + + ```dos + LaunchEMS + ``` + +- **Edge Transport servers**: Run the following commands from a Command Prompt. These two separate commands are presented on one line for ease of copying and running: + + ```dos + exshell.psc1 & exchange.ps1 + ``` + +## Open the Exchange Management Shell in Windows Server 2016 or Windows 10 + +Select **Start** \> **Microsoft Exchange Server 2016 \>** **Exchange Management Shell**. + +## Open the Exchange Management Shell in Windows Server 2012 R2 or Windows 8.1 + +When you install Exchange on Windows Server 2012 R2 or the Exchange management tools on Windows 8.1, the Exchange Management Shell shortcut isn't automatically pinned to the Start screen. + +To pin the shortcut to the Start screen, do the following steps: + +1. On the Start screen, open the Apps view by selecting the down arrow near the lower-left corner or swiping up from the middle of the screen. + +2. The **Exchange Management Shell** shortcut is in a group named **Microsoft Exchange Server 2016**. When you find the shortcut, right-click it or press and hold it, and select **Pin to Start**. To pin it to the desktop taskbar, select **Pin to taskbar**. + +To use the Search charm to find and run the Exchange Management Shell, use one of the methods described in the next section. + +## Open the Exchange Management Shell in Windows Server 2012 + +When you install Exchange on Windows Server 2012, the Exchange Management Shell shortcut should automatically be pinned to the Start screen. + +If it's not, or if you just want to quickly find and run the Exchange Management Shell, use one of the following methods: + +- On the Start screen, click in an empty area, and type Exchange Management Shell. When the shortcut appears in the search results, you can select it. + +- On the desktop or the Start screen, press Windows key + Q. In the Search charm, type Exchange Management Shell. When the shortcut appears in the results, you can select it. + +- On the desktop or the Start screen, move your cursor to the upper-right corner, or swipe left from the right edge of the screen to show the charms. Select the Search charm, and type Exchange Management Shell. When the shortcut appears in the results, you can select it. + +If you're using Remote Desktop Connection, you might need to use one of the following methods so the Search charm appears on the remote Exchange server and not on your local computer: + +- Open Remote Desktop Connection and select **Show Options** \> **Local Resources** tab \> **Apply Windows key combinations**. The default value is **Only when using the full screen**, but you can change it to **On the remote computer**. + +- While you're connected to the remote Exchange server, use the connection bar that appears at the top of the screen to open the Exchange server's Search charm or Start screen by clicking the down arrow and selecting **Charms** or **Start**. diff --git a/exchange/docs-conceptual/recipient-filters.md b/exchange/docs-conceptual/recipient-filters.md new file mode 100644 index 0000000000..dc3ea8bf77 --- /dev/null +++ b/exchange/docs-conceptual/recipient-filters.md @@ -0,0 +1,249 @@ +--- +title: "Recipient filters in Exchange PowerShell commands" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 09/07/2023 +ms.audience: ITPro +audience: ITPro +ms.topic: reference +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: fb4b1396-9aae-4037-be1a-b09e336b890e +description: "Learn about creating different kinds of recipient filters in the Exchange Management Shell and Exchange Online PowerShell." +--- + +# Recipient filters in Exchange PowerShell commands + +The cmdlets in the [Exchange Management Shell](exchange-management-shell.md) and [Exchange Online PowerShell](exchange-online-powershell.md)l support different types of filters in recipient related cmdlets: + +- Precanned filters. +- Custom filters using the _RecipientFilter_ parameter. +- Custom filters using the _Filter_ parameter. +- Custom filters using the _ContentFilter_ parameter. + +Older versions of Exchange used LDAP filtering syntax to create custom address lists, global address lists (GALs), email address policies, and distribution groups. OPATH filtering syntax replaced LDAP filtering syntax starting in Exchange Server 2007. + +## Precanned filters + +A _precanned filter_ uses popular properties in Exchange to filter recipients for dynamic distribution groups, email address policies, address lists, or GALs. With precanned filters, you can use either the Exchange PowerShell or the Exchange admin center (EAC). Using precanned filters, you can do the following tasks: + +- Determine the scope of recipients. +- Add conditional filtering based on common properties such as company, department, and state or region. +- Add custom attributes for recipients. For more information, see [Custom Attributes](/Exchange/recipients/mailbox-custom-attributes). + +The following parameters are considered precanned filters: + +- _IncludedRecipients_ +- _ConditionalCompany_ +- _ConditionalDepartment_ +- _ConditionalStateOrProvince_ +- _ConditionalCustomAttribute1_ to _ConditionalCustomAttribute15_. + +Precanned filters are available on the following cmdlets: + +- [New-DynamicDistributionGroup](/powershell/module/exchange/new-dynamicdistributiongroup) +- [Set-DynamicDistributionGroup](/powershell/module/exchange/set-dynamicdistributiongroup) + +- [New-EmailAddressPolicy](/powershell/module/exchange/new-emailaddresspolicy) +- [Set-EmailAddressPolicy](/powershell/module/exchange/set-emailaddresspolicy) + +- [New-AddressList](/powershell/module/exchange/new-addresslist) +- [Set-AddressList](/powershell/module/exchange/set-addresslist) + +- [New-GlobalAddressList](/powershell/module/exchange/new-globaladdresslist) +- [Set-GlobalAddressList](/powershell/module/exchange/set-globaladdresslist) + +### Precanned filter example + +This example describes using precanned filters in the Exchange Management Shell to create a dynamic distribution group. The syntax in this example is similar but not identical to the syntax you would use to create an email address policy, address list, or GAL. When creating a precanned filter, you should ask the following questions: + +- From which organizational unit (OU) do you want to include recipients (the _RecipientContainer_ parameter)? + + > [!NOTE] + > Selecting the OU for this purpose applies only to creating dynamic distribution groups, and not to creating email address policies, address lists, or GALs. + +- What types of recipients do you want to include (the _IncludedRecipients_ parameter)? + +- What additional conditions do you want to include in the filter (the _ConditionalCompany_, _ConditionalDepartment_, _ConditionalStateOrProvince_, and _ConditionalCustomAttribute_ parameters)? + +This example creates a dynamic distribution group with the following properties: + +- **Name**: Contoso Finance. +- **Recipient types**: User mailboxes. +- **Recipient location**: The OU named Contoso.com/Users. +- **Filters** Include only recipients who have the **Department** attribute defined as Finance and the **Company** attribute defined as Contoso. + +```powershell +New-DynamicDistributionGroup -Name "Contoso Finance" -OrganizationalUnit Contoso.com/Users -RecipientContainer Contoso.com/Users -IncludedRecipients MailboxUsers -ConditionalDepartment "Finance" -ConditionalCompany "Contoso" +``` + +This example displays the properties of this new dynamic distribution group. + +```powershell +Get-DynamicDistributionGroup -Identity "Contoso Finance" | Format-List Recipient*,Included* +``` + +## Custom filters using the RecipientFilter parameter + +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-EmailAddressPolicy](/powershell/module/exchange/new-emailaddresspolicy) +- [Set-EmailAddressPolicy](/powershell/module/exchange/set-emailaddresspolicy) + +- [New-AddressList](/powershell/module/exchange/new-addresslist) +- [Set-AddressList](/powershell/module/exchange/set-addresslist) + +- [New-GlobalAddressList](/powershell/module/exchange/new-globaladdresslist) +- [Set-GlobalAddressList](/powershell/module/exchange/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). + +### Custom filter example + +The following example uses the _RecipientFilter_ parameter to create a dynamic distribution group. The syntax in this example is similar but not identical to the syntax you use to create an email address policy, address list, or GAL. + +This example uses custom filters to create a dynamic distribution group with the following properties: + +- **Name**: AllContosoNorth. +- **Recipient types**: User mailboxes. +- **Recipient location**: The OU named Contoso.com/Users. +- **Filters** Include only recipients who have the **Company** attribute defined as Contoso and the **Office** attribute defined as North Building. + +```powershell +New-DynamicDistributionGroup -Name AllContosoNorth -OrganizationalUnit contoso.com/Users -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and (Company -eq 'Contoso') -and (Office -eq 'North Building'))" +``` + +## Custom filters using the Filter parameter + +You can use the _Filter_ parameter to filter the results of a command to specify which objects to retrieve. For example, instead of retrieving all users or groups, you can specify a set of users or groups using a filter string. This type of filter doesn't modify any configuration or attributes of objects. It only modifies the set of objects that the command returns. + +Using the _Filter_ parameter to modify command results is known as _server-side filtering_. Server-side filtering submits the command and the filter to the server for processing. We also support client-side filtering, in which the command retrieves all objects from the server and then applies the filter in the local console window. To perform client-side filtering, use the **Where-Object** cmdlet. For more information about server-side and client-side filtering, see "How to Filter Data" in [Working with Command Output](/exchange/working-with-command-output-exchange-2013-help). + +To find the filterable properties for cmdlets that have the _Filter_ parameter, you can run the **Get** command against an object and format the output by pipelining the **Format-List** parameter. Most of the returned values are available for use in the _Filter_ parameter. + +The following example returns a detailed list for the mailbox Ayla. + +```powershell +Get-Mailbox -Identity Ayla | Format-List +``` + +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) + +For more information about the filterable properties you can use with the _Filter_ parameter, see [Filterable properties for the Filter parameter](filter-properties.md). + +### Filter parameter example + +This example uses the _Filter_ parameter to return information about users whose title contains the word "manager." + +```powershell +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. + +### ContentFilter parameter example + +This example creates an export request that searches Ayla's mailbox for messages where the body contains the phrase "company prospectus." If that phrase is found, the command exports all messages with that phrase to a .pst file. + +```powershell +New-MailboxExportRequest -Mailbox Ayla -ContentFilter "Body -like 'company prospectus*'" +``` + +For more information about the filterable properties that you can use with the _ContentFilter_ parameter, see [Filterable properties for the ContentFilter parameter](/exchange/filterable-properties-for-the-contentfilter-parameter). + +## Additional OPATH syntax information + +When creating your own custom OPATH filters, consider the following items: + +- Use the following syntax to identify the types of values that you're searching for: + + - **Text values**: Enclose the text in single quotation marks (for example, `'Value'` or `'Value with spaces'`). Or, you can enclose a text value in double quotation marks, but that limits the characters you can use to enclose the whole OPATH filter. + + - **Variables**: Enclose variables that need to be expanded in single quotation marks (for example, `'$User'`). If the variable value itself contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. + + - **Integer values**: You don't need to enclose integers (for example, `500`). You can often enclose integers in single quotation marks or double quotation marks, but that limits the characters you can use to enclose the whole OPATH filter. + + - **System values**: Don't enclose system values (for example, `$true`, `$false`, or `$null`). To enclose the whole OPATH filter in double quotation marks, you need to escape the dollar sign in system value (for example, `` `$true``). + +- You need to enclose the whole OPATH filter in double quotation marks " " or single quotation marks ' '. Although any OPATH filter object is technically a string and not a script block, you can still use braces { }, but only if the filter doesn't contain variables that require expansion. The characters that you can use to enclose the whole OPATH filter depend on types of values that you're searching for and the characters you used (or didn't use) to enclose those values: + + - **Text values**: Depends on how you enclosed the text to search for: + - **Text enclosed in single quotation marks**: Enclose the whole OPATH filter in double quotation marks or braces. + - **Text enclosed in double quotation marks**: Enclose the whole OPATH filter in braces. + + - **Variables**: Enclose the whole OPATH filter in double quotation marks (for example, `"Name -eq '$User'"`). + + - **Integer values**: To ensure they work in all cases, enclose them in one of the following ways: + - **Integer enclosed in single quotation marks**: Enclose the whole OPATH filter in double quotation marks or braces `"CountryCode -eq '840'"`. + - **Integer enclosed in double quotation marks**: Enclose the whole OPATH filter in braces (for example `{CountryCode -eq "840"}`). + + - **System values**: Enclose the whole OPATH filter in single quotation marks or braces (for example `'HiddenFromAddressListsEnabled -eq $true'`). If you escape the dollar sign system value, you can also enclose the whole OPATH filter in double quotation marks (for example, ``"HiddenFromAddressListsEnabled -eq `$true"``). + + The compatibility of search criteria and the valid characters that you can use to enclose the whole OPATH filter are summarized in the following table: + + |Search value|OPATH filter
enclosed in
double quotation marks|OPATH filter
enclosed in
single quotation marks|OPATH filter enclosed in
braces| + |---|:---:|:---:|:---:| + |`'Text'`|✔||✔| + |`"Text"`|||✔| + |`'$Variable'`|✔||| + |`500`|✔|✔|✔| + |`'500'`|✔||✔| + |`"500"`|||✔| + |`$true`||✔|✔| + |`` `$true``|✔|✔|✔| + +- Include the hyphen before all logical or comparison operators. The most common operators include: + + - `-and` + - `-or` + - `-not` + - `-eq` (equals) + - `-ne` (not equal) + - `-lt` (less than) + - `-gt` (greater than) + - `-like` (string comparison) + - `-notlike` (string comparison) + +- Many filterable properties accept wildcard characters. If you use a wildcard character, use the **-like** operator instead of the **-eq** operator. Use the **-like** operator to find pattern matches in rich types (for example, strings). Use the **-eq** operator to find an exact match. + + When you use the **-like** operator in Exchange Online PowerShell, the wildcard character is supported only as a suffix in **most** parameters. For example, `"Department -like 'sales*'"` is allowed, but `"Department -like '*sales'"` isn't allowed. + + > [!TIP] + > Even if a wildcard prefix works in a filter parameter in Exchange Online PowerShell, we don't recommend using it due to low performance issues. + +- For more information about operators that you can use, see: + + - [about_Logical_Operators](/powershell/module/microsoft.powershell.core/about/about_logical_operators) + - [about_Comparison_Operators](/powershell/module/microsoft.powershell.core/about/about_comparison_operators) + +## Recipient filter documentation + +The following table contains links to articles to help you learn more about the filterable properties that you can use with Exchange recipient commands. + +|Article|Description| +|---|---| +|[Filterable properties for the RecipientFilter parameter on Exchange cmdlets](recipientfilter-properties.md)|Learn more about the filterable properties that are available for the _RecipientFilter_ parameter.| +|[Filterable properties for the Filter parameter on Exchange cmdlets](filter-properties.md) |Learn more about the filterable properties that are available for the _Filter_ parameter.| +|[Filters in the Exchange Online PowerShell module](filters-v2.md)|Learn about the considerations for filters in the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module.| diff --git a/exchange/docs-conceptual/recipientfilter-properties.md b/exchange/docs-conceptual/recipientfilter-properties.md new file mode 100644 index 0000000000..0c75acd5b6 --- /dev/null +++ b/exchange/docs-conceptual/recipientfilter-properties.md @@ -0,0 +1,316 @@ +--- +title: "Filterable properties for the RecipientFilter parameter" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 09/07/2023 +ms.audience: ITPro +audience: ITPro +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: cf78aca5-6699-485c-9b15-e0adba252176 +description: "Learn about the recipient properties that you can use with the RecipientFilter parameter in Exchange Server and Exchange Online cmdlets." +--- + +# Filterable properties for the RecipientFilter parameter on Exchange cmdlets + +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) + +## Filterable recipient properties + +The recipient properties that have been *confirmed* to work with the _RecipientFilter_ parameter in *all* cmdlets are described in the following table. + + **Notes**: + +- The list might include: + - Properties that are only used in one type of environment: Microsoft 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is only meaningful (a value other than blank or `None`) in one type of environment. + - Properties that are present, but correspond to features that are no longer used in Exchange. + +- You can't use properties from other Active Directory schema extensions with the _RecipientFilter_ parameter. + +- Not all recipient properties have a corresponding Active Directory property. The LDAP display name value in the table is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange). + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). + +- You typically use the object's name for properties that require a valid object value (for example, a mailbox, a distribution group, or an email address policy, but the property might also accept the object's distinguished name (DN) or globally unique identifier (GUID). To find the object's DN or GUID, use the **Get-** cmdlet that corresponds to the object's type (for example, `Get-EmailAddressPolicy | Format-List Name,DistinguishedName,GUID`). + +- Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). In Exchange Online PowerShell, you can't use the wildcard as a prefix in **most** parameters (for example, `"Property -like '*abc'"`) isn't allowed). + + > [!TIP] + > Even if a wildcard prefix works in a filter parameter in Exchange Online PowerShell, we don't recommend using it due to low performance issues. + +- The Value column in the table describes the acceptable values for the _filter_, not necessarily for the property itself. For example, a property might obviously contain a date or numeric value, but when you use that property in a filter, it might be treated like a text string (no value check, and wildcards are supported). + +- To look for blank or non-blank property values, use the value `$null` (for example, `'Property -eq $null'` or `'Property -ne $null'`). + +- For filtering considerations for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). + +- In Exchange Online, you can't use a wildcard character (*) as the first character in the search string. + +|Property name|LDAP display name|Value|Comments| +|---|---|---|---| +|_AcceptMessagesOnlyFrom_|_authOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|String (wildcards accepted).|| +|_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|String (wildcards accepted).|| +|_ActiveSyncEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_ActiveSyncMailboxPolicy_|_msExchMobileMailboxPolicyLink_|String (wildcards accepted in dynamic distribution groups).|The default Exchange ActiveSync mailbox policy is named Default.| +|_ActiveSyncSuppressReadReceipt_|n/a|Boolean (`$true` or `$false`)|| +|_AddressBookPolicy_|_msExchAddressBookPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| +|_AddressListMembership_|_showInAddressBook_|String (wildcards accepted in dynamic distribution groups).|| +|_AdminDisplayName_|_adminDisplayName_|String (wildcards accepted).|| +|_AdministrativeUnits_|_msExchAdministrativeUnitLink_|String (wildcards accepted in dynamic distribution groups).|| +|_AggregatedMailboxGuids_|_msExchAlternateMailboxes_|String (wildcards accepted).|| +|_Alias_|_mailNickname_|String (wildcards accepted).|This property contains the recipient's Exchange alias (also known as the mail nickname). 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.| +|_AllowUMCallsFromNonUsers_|_msExchUMListInDirectorySearch_|`None` (0) or `SearchEnabled` (1)|| +|_ArbitrationMailbox_|_msExchArbitrationMailbox_|String (wildcards accepted in dynamic distribution groups).|| +|_ArchiveDatabase_|_msExchArchiveDatabaseLink_|String|| +|_ArchiveDomain_|_msExchArchiveAddress_|String (wildcards accepted).|| +|_ArchiveGuid_|_msExchArchiveGUID_|String (wildcards accepted).|| +|_ArchiveName_|_msExchArchiveName_|String (wildcards accepted).|| +|_ArchiveQuota_|_msExchArchiveQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_ArchiveRelease_|_msExchArchiveRelease_|String (wildcards accepted).|| +|_ArchiveState_|n/a|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|| +|_ArchiveStatus_|_msExchArchiveStatus_|`None` (0) or `Active` (1).|| +|_AssistantName_|_msExchAssistantName_|String (wildcards accepted).|The name of the recipient's assistant.| +|_AuditEnabled_|_msExchMailboxAuditEnable_|Boolean (`$true` or `$false`)|| +|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|The value of this property is a time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.| +|_AuthenticationPolicy_|_msExchAuthPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| +|_C_|_C_|String (wildcards accepted).|This property contains the two-letter country/region designation from International Organization for Standardization (ISO) 3166. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).| +|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|Dynamic distribution groups: `Unlimited` or a byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: `Unlimited`, or blank/non-blank.|| +|_CalendarRepairDisabled_|_msExchCalendarRepairDisabled_|Boolean (`$true` or `$false`)|| +|_Certificate_|_userCertificate_|`System.Byte[]`|This property contains the DER-encoded X509v3 certificates that are issued to the user.| +|_CertificateSubject_|n/a|`X509:X500IssuerX500Subject` (for example, `X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`)|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).| +|_City_|_l_|String (wildcards accepted).|The recipient's city.| +|_Co_|_Co_|String (wildcards accepted).|The name of the recipient's country or region. You can locate valid _Co_ values on the **Address** tab in the recipient's properties in Active Directory Users and Computers.| +|_CommonName_|_cn_|String (wildcards accepted).|| +|_ComplianceTagHoldApplied_|n/a|Boolean (`$true` or `$false`)|| +|_Company_|_company_|String (wildcards accepted).|The recipient's company name.| +|_CountryOrRegion_|c|String (wildcards accepted).|This property contains the two-letter country/region designation from ISO 3166. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).| +|_CustomAttribute1_ to _CustomAttribute15_|_extensionAttribute1_ to _extensionAttribute15_|String (wildcards accepted).|These properties contain custom attributes that you can add to a recipient.| +|_Database_|_homeMDB_|String (wildcards accepted).|The identity of the user's mailbox database.| +|_Department_|_department_|String (wildcards accepted).|The recipient's department.| +|_DataEncryptionPolicy_|_msExchDataEncryptionPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| +|_DefaultPublicFolderMailbox_|_msExchPublicFolderMailbox_|String (wildcards accepted in dynamic distribution groups).|| +|_DeletedItemFlags_|_deletedItemFlags_|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).|| +|_DeliverToMailboxAndForward_|_deliverAndRedirect_|Boolean (`$true` or `$false`)|| +|_Description_|_description_|String (wildcards accepted).|| +|_DirectReports_|_directReports_|String (wildcards accepted in dynamic distribution groups).|| +|_DisabledArchiveDatabase_|_msExchDisabledArchiveDatabaseLink_|String (wildcards accepted).|| +|_DisabledArchiveGuid_|_msExchDisabledArchiveDatabaseGUID_|String (wildcards accepted).|| +|_DisplayName_|_displayName_|String (wildcards accepted).|| +|_DistinguishedName_|_distinguishedName_|String (wildcards accepted).|| +|_EcpEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_ElcExpirationSuspensionEndDate_|_msExchELCExpirySuspensionEnd_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| +|_ElcExpirationSuspensionStartDate_|_msExchELCExpirySuspensionStart_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| +|_ElcMailboxFlags_|_msExchELCMailboxFlags_|`None` (0), `ExpirationSuspended` (1), `ElcV2` (2), `DisableCalendarLogging` (4),`LitigationHold` (8), `SingleItemRecovery` (16), `ValidArchiveDatabase` (32), `ShouldUseDefaultRetentionPolicy` (128), `EnableSiteMailboxMessageDedup` (256), `ElcProcessingDisabled` (512), or `ComplianceTagHold` (1024).|| +|_EmailAddresses_|_proxyAddresses_|String (wildcards accepted).|This property contains the recipient's email addresses (the primary email address and all proxy addresses). This is the property used to identify inactive mailboxes.| +|_EmailAddressPolicyEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_EntryId_|_msExchPublicFolderEntryId_|String (wildcards accepted).|| +|_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|`EnforceAllowList` or `EnforceBlockList`.|| +|_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).|| +|_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).| +|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|String (wildcards accepted).|| +|_ExternalEmailAddress_|_targetAddress_|String (wildcards accepted).|This property contains the external email address for mail contacts and mail users.| +|_ExternalOofOptions_|_msExchExternalOOFOptions_|`External` (0) or `InternalOnly` (1).|| +|_Fax_|_facsimileTelephoneNumber_|String (wildcards accepted).|| +|_FirstName_|_givenName_|String (wildcards accepted).|The recipient's first name.| +|_ForwardingAddress_|_altRecipient_|String (wildcards accepted).|| +|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|String (wildcards accepted).|| +|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|String (wildcards accepted in dynamic distribution groups).|| +|_GrantSendOnBehalfTo_|_publicDelegates_|String (wildcards accepted in dynamic distribution groups).|| +|_GroupType_|_groupType_|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|| +|_Guid_|_objectGuid_|String (wildcards accepted).|| +|_HasActiveSyncDevicePartnership_|n/a|Boolean (`$true` or `$false`)|| +|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|Boolean (`$true` or `$false`)|This property specifies whether the recipient is visible in the global address list or other address lists.| +|_HiddenGroupMembershipEnabled_|_hideDLMembership_|Boolean (`$true` or `$false`)|| +|_HomeMTA_|_homeMTA_|String (wildcards accepted in dynamic distribution groups).|| +|_HomePhone_|_homePhone_|String (wildcards accepted).|| +|_Id_|_distinguishedName_|String (wildcards accepted in dynamic distribution groups).|| +|_ImapEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_ImmutableId_|_msExchGenericImmutableId_|String (wildcards accepted).|| +|_IncludedRecipients_|n/a|`None` (0), `MailboxUsers` (1), `Resources` (2), `MailContacts` (4), `MailGroups` (8), `MailUsers` (16), or `AllRecipients` (-1).|| +|_IncludeInGarbageCollection_|n/a|Boolean (`$true` or `$false`)|| +|_Initials_|_initials_|String (wildcards accepted).|| +|_InPlaceHolds_|_msExchUserHoldPolicies_|String|| +|_InPlaceHoldsRaw_|n/a|String|| +|_InternetEncoding_|_internetEncoding_|Integer|For valid values, see the Remarks section in the article, [Encoding Class](/dotnet/api/system.text.encoding).| +|_IsDirSynced_|_msExchIsMSODirsynced_|Boolean (`$true` or `$false`)|| +|_IsExcludedFromServingHierarchy_|n/a|Boolean (`$true` or `$false`)|| +|_IsHierarchyReady_|n/a|Boolean (`$true` or `$false`)|| +|_IsHierarchySyncEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_IsInactiveMailbox_|n/a|Boolean (`$true` or `$false`)|| +|_IsMailboxEnabled_|n/a|Boolean (`$true` or `$false`)|This property specifies whether the user is mailbox-enabled.| +|_IsSecurityPrincipal_|n/a|Boolean (`$true` or `$false`)|| +|_IsSoftDeletedByDisable_|n/a|Boolean (`$true` or `$false`)|| +|_IsSoftDeletedByRemove_|n/a|Boolean (`$true` or `$false`)|| +|_IssueWarningQuota_|_mDBStorageQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_JournalArchiveAddress_|n/a|An SMTP email address (for example, `julia@contoso.com`).|| +|_LanguagesRaw_|_msExchUserCulture_|String (wildcards accepted).|This property contains the language preference for this mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](/dotnet/api/system.globalization.cultureinfo).| +|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_LastName_|_sn_|String (wildcards accepted).|| +|_LdapRecipientFilter_|_msExchDynamicDLFilter_|String (wildcards accepted).|| +|_LegacyExchangeDN_|_legacyExchangeDN_|String (wildcards accepted).|| +|_LitigationHoldDate_|_msExchLitigationHoldDate_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_LitigationHoldEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_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).|| +|_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).|| +|_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).|| +|_MailTipTranslations_|_msExchSenderHintTranslations_|String (wildcards accepted).|| +|_ManagedBy_|_managedBy_|String (wildcards accepted in dynamic distribution groups).|This property identifies the security principal that's the manager of the group.| +|_Manager_|_manager_|String (wildcards accepted in dynamic distribution groups).|The recipient's manager.| +|_MAPIEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_MapiRecipient_|_mAPIRecipient_|Boolean (`$true` or `$false`)|| +|_MaxBlockedSenders_|_msExchMaxBlockedSenders_|`Unlimited` or an integer.|| +|_MaxSafeSenders_|_msExchMaxSafeSenders_|`Unlimited` or an integer.|| +|_MaxReceiveSize_|_delivContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_MaxSendSize_|_submissionContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_MemberDepartRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| +|_MemberJoinRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| +|_MemberOfGroup_|_memberOf_|String (wildcards accepted in dynamic distribution groups).|You must use the DistinguishedName. This property only works with groups recognized by Exchange, therefore Microsoft Entra security groups do not work.| +|_Members_|_member_|String (wildcards accepted in dynamic distribution groups).|| +|_MessageHygieneFlags_|_msExchMessageHygieneFlags_|`None` (0) or `AntispamBypass` (1).|| +|_MobileAdminExtendedSettings_|_msExchOmaAdminExtendedSettings_|String (wildcards accepted).|| +|_MobileMailboxFlags_|_msExchMobileMailboxFlags_|`None` (0), `HasDevicePartnership` (1), or ActiveSyncSuppressReadReceipt (2).|| +|_MobileFeaturesEnabled_|_msExchOmaAdminWirelessEnable_|`None` (0), `AirSyncDisabled` (4), or `MowaDisabled` (8).|| +|_MobilePhone_|_mobile_|String (wildcards accepted).|| +|_ModeratedBy_|_msExchModeratedByLink_|String (wildcards accepted in dynamic distribution groups).|| +|_ModerationEnabled_|_msExchEnableModeration_|Boolean (`$true` or `$false`)|| +|_Name_|_name_|String (wildcards accepted).|The unique name value of the recipient.| +|_NetID_|n/a|A sample value is `1003BFFD9A0CFA03`.|This property is populated for Exchange Online mailboxes in hybrid environments.| +|_Notes_|_info_|String (wildcards accepted).|| +|_ObjectCategory_|_objectCategory_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Valid values use the format `CN=,CN=Schema,CN=Configuration,DC=`, where _\_ is typically `Person` or `Group` for recipients. For example, `CN=Person,CN=Schema,CN=Configuration,DC=contoso,DC=com`.| +|_ObjectClass_|_objectClass_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Common values for recipients are: `contact`, `organizationalPerson`, `person`, `top`, `group`, `msExchDynamicDistributionList`, and `user`.| +|_Office_|_physicalDeliveryOfficeName_|String (wildcards accepted).|| +|_OfflineAddressBook_|_msExchUseOAB_|String (wildcards accepted in dynamic distribution groups).|This property contains the offline address book (OAB) that's associated with this recipient.| +|_OperatorNumber_|_msExchUMOperatorNumber_|String (wildcards accepted).|| +|_OtherFax_|_otherFacsimileTelephoneNumber_|String (wildcards accepted).|| +|_OtherHomePhone_|_otherHomePhone_|String (wildcards accepted).|| +|_OtherTelephone_|_otherTelephone_|String (wildcards accepted).|| +|_OWAEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_OWAforDevicesEnabled_|_msExchOmaAdminWirelessEnable_|Boolean (`$true` or `$false`)|| +|_OWAMailboxPolicy_|_msExchOWAPolicy_|String (wildcards accepted in dynamic distribution groups).|| +|_Pager_|_pager_|String (wildcards accepted).|| +|_Phone_|_telephoneNumber_|String (wildcards accepted).|| +|_PhoneProviderId_|_msExchUMPhoneProvider_|String (wildcards accepted).|| +|_PhoneticCompany_|_msDS-PhoneticCompanyName_|String (wildcards accepted).|| +|_PhoneticDepartment_|_msDS-PhoneticDepartment_|String (wildcards accepted).|| +|_PhoneticDisplayName_|_msDS-PhoneticDisplayName_|String (wildcards accepted).|| +|_PhoneticFirstName_|_msDS-PhoneticFirstName_|String (wildcards accepted).|| +|_PhoneticLastName_|_msDS-PhoneticLastName_|String (wildcards accepted).|| +|_PoliciesExcluded_|_msExchPoliciesExcluded_|String (wildcards accepted).|| +|_PoliciesIncluded_|_msExchPoliciesIncluded_|String (wildcards accepted).|| +|_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).|| +|_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'"`.| +|_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).|| +|_PublicFolderContacts_|_pFContacts_|String (wildcards accepted in dynamic distribution groups).|| +|_PurportedSearchUI_|_msExchPurportedSearchUI_|String (wildcards accepted).|| +|_QueryBaseDN_|_msExchQueryBaseDN_|String (wildcards accepted in dynamic distribution groups).|| +|_RawCanonicalName_|_canonicalName_|String (wildcards accepted).|This property is based on a constructed Active Directory attribute, and does not correctly resolve all members when used in `Get-Recipient -RecipientPreviewFilter`.| +|_RawExternalEmailAddress_|_targetAddress_|String (wildcards accepted).|| +|_RawName_|_name_|String (wildcards accepted).|| +|_RecipientContainer_|_msExchDynamicDLBaseDN_|String (wildcards accepted).|The Active Directory container or organizational unit (OU) that holds the recipient object.| +|_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).|| +|_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.|| +|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|String (wildcards accepted in dynamic distribution groups).|| +|_RemotePowerShellEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_RemoteRecipientType_|_msExchRemoteRecipientType_|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), or `TeamMailbox` (128).|| +|_ReportToManagerEnabled_|_reportToOwner_|Boolean (`$true` or `$false`)|| +|_ReportToOriginatorEnabled_|_reportToOriginator_|Boolean (`$true` or `$false`)|| +|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|Boolean (`$true` or `$false`)|| +|_ResourceCapacity_|_msExchResourceCapacity_|Integers.|| +|_ResourceCustom_|n/a|String|| +|_ResourceMetaData_|_msExchResourceMetaData_|String (wildcards accepted).|| +|_ResourcePropertiesDisplay_|_msExchResourceDisplay_|String (wildcards accepted).|| +|_ResourceSearchProperties_|_msExchResourceSearchProperties_|String (wildcards accepted).|| +|_ResourceType_|n/a|`Room` (0) or `Equipment` (1).|| +|_RetainDeletedItemsFor_|_garbageCollPeriod_|Dynamic distribution groups: A time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.
Others: Blank or non-blank.|| +|_RetentionComment_|_msExchRetentionComment_|String (wildcards accepted).|| +|_RetentionPolicy_|n/a|String|| +|_RetentionUrl_|_msExchRetentionURL_|String (wildcards accepted).|| +|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| +|_RulesQuota_|_msExchMDBRulesQuota_|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.|| +|_SamAccountName_|_SamAccountName_|String (wildcards accepted in dynamic distribution groups).|This property specifies an identifier that's compatible with older versions of Microsoft Windows client and server operating systems (also known as the pre-Windows 2000 user account or group name)| +|_SafeRecipientsHash_|_msExchSafeRecipientsHash_|`System.Byte[]`|A user's safe recipients list is hashed (SHA-256) one way before it's stored as a binary large object in Active Directory.| +|_SafeSendersHash_|_msExchSafeSendersHash_|`System.Byte[]`|A user's safe senders list is hashed (SHA-256) one way before it's stored as a binary large object in Active Directory.| +|_SCLDeleteThresholdInt_|_msExchMessageHygieneSCLDeleteThreshold_|An integer from 0 through 9.|| +|_SCLJunkThresholdInt_|_msExchMessageHygieneSCLJunkThreshold_|An integer from 0 through 9.|| +|_SCLQuarantineThresholdInt_|_msExchMessageHygieneSCLQuarantineThreshold_|An integer from 0 through 9.|| +|_SCLRejectThresholdInt_|_msExchMessageHygieneSCLRejectThreshold_|An integer from 0 through 9.|| +|_SecurityProtocol_|_securityProtocol_|`System.Byte[]`|| +|_SendDeliveryReportsTo_|n/a|`None` (0), `Manager` (1) or `Originator` (2).|| +|_SendOofMessageToOriginatorEnabled_|_oOFReplyToOriginator_|Boolean (`$true` or `$false`)|| +|_ServerLegacyDN_|_msExchHomeServerName_|String (wildcards accepted).|| +|_ServerName_|n/a|String|| +|_SharingPolicy_|_msExchSharingPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| +|_SimpleDisplayName_|_displayNamePrintable_|String (wildcards accepted).|| +|_SingleItemrecoveryEnabled_|n/a|Boolean (`$true` or `$false`)|| +|_SKUAssigned_|n/a|Boolean (`$true` or `$false`)|| +|_SMimeCertificate_|_userSMIMECertificate_|`System.Byte[]`|This property contains the binary encoded S/MIME certificates that are issued to the user.| +|_StateOrProvince_|_st_|String (wildcards accepted).|| +|_StreetAddress_|_streetAddress_|String (wildcards accepted).|| +|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_TelephoneAssistant_|_telephoneAssistant_|String (wildcards accepted).|| +|_TextEncodedORAddress_|_textEncodedORAddress_|String (wildcards accepted).|| +|_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|String (wildcards accepted in dynamic distribution groups).|| +|_Title_|_title_|String (wildcards accepted).|| +|_UMAddresses_|_msExchUMAddresses_|String (wildcards accepted).|| +|_UMCallingLineIds_|_msExchUMCallingLineIds_|String (wildcards accepted).|| +|_UMDtmfMap_|_msExchUMDtmfMap_|String (wildcards accepted).|| +|_UMEnabled_|n/a|Boolean (`$true` or `$false`)|This property specifies whether Unified Messaging (UM) is enabled for this mailbox.| +|_UMEnabledFlags_|_msExchUMEnabledFlags_|`None` (0), `UMEnabled` (1), `FaxEnabled` (2), `TUIAccessToCalendarEnabled` (4), `TUIAccessToEmailEnabled` (8), `SubscriberAccessEnabled` (16), `TUIAccessToAddressBookEnabled` (32), `AnonymousCallersCanLeaveMessages` (256), `ASREnabled` (512), or `VoiceMailAnalysisEnabled` (1024).|| +|_UMMailboxPolicy_|_msExchUMTemplateLink_|String (wildcards accepted in dynamic distribution groups).|| +|_UMPinChecksum_|_msExchUMPinChecksum_|`System.Byte[]`|| +|_UMRecipientDialPlanId_|_msExchUMRecipientDialPlanLink_|String (wildcards accepted in dynamic distribution groups).|| +|_UMServerWritableFlags_|_msExchUMServerWritableFlags_|`None` (0), `MissedCallNotificationEnabled` (1), `SMSVoiceMailNotificationEnabled` (2), `SMSMissedCallNotificationEnabled` (4), or `PinlessAccessToVoiceMailEnabled` (8).|| +|_UMSpokenName_|_msExchUMSpokenName_|`System.Byte[]`|| +|_UnicodePassword_|_unicodePwd_|`System.Byte[]`|| +|_UsageLocation_|_msExchUsageLocation_|A valid ISO 3166-1 two-letter country code value or the corresponding display name (for example, `US` or `UnitedStates`). For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).|| +|_UseDatabaseQuotaDefaults_|_mDBUseDefaults_|Boolean (`$true` or `$false`)|If the value of this property is $true, the values of these properties are ignored for the mailbox: _IssueWarningQuota_, _ProhibitSendQuota_, _ProhibitSendReceiveQuota_, , _CalendarLoggingQuota_, _RecoverableItemsWarningQuota_, and _RecoverableItemsQuota_.| +|_UserAccountControl_|_userAccountControl_|For valid values, see the Remarks section in [User-Account-Control attribute](/windows/win32/adschema/a-useraccountcontrol). You need to convert the hexadecimal values to decimal. Most of the text values won't work as described (even if you remove `ADS_UF` and all underscores).|| +|_UserPrincipalName_|_userPrincipalName_|String (wildcards accepted).|This property contains the user principal name (UPN) for this recipient (for example, `kim@contoso.com`). This property is not supported to identify inactive mailboxes.| +|_VoiceMailSettings_|_msExchUCVoiceMailSettings_|String (wildcards accepted).|Valid values for this property are: `ExchangeHostedVoiceMail=0`, `ExchangeHostedVoiceMail=1`, `CsHostedVoiceMail=0`, or `CsHostedVoiceMail=1`.| +|_WebPage_|_wWWHomePage_|String (wildcards accepted).|| +|_WhenChanged_|_whenChanged_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenChangedUTC_|n/a|Dynamic distribution groups: A date/time value in Coordinated Universal Time (UTC).
Others: Blank or non-blank.|| +|_WhenCreated_|_whenCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenCreatedUTC_|n/a|Dynamic distribution groups: A date/time value in UTC.
Others: Blank or non-blank.|| +|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WindowsEmailAddress_|_mail_|String (wildcards accepted).|| +|_WindowsLiveID_|_msExchWindowsLiveID_|String (wildcards accepted).|| + +## For more information + +Exchange Server 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, [Need help converting your LDAP filters to OPATH?](https://techcommunity.microsoft.com/t5/Exchange-Team-Blog/Need-help-converting-your-LDAP-filters-to-OPATH/ba-p/595108). diff --git a/exchange/docs-conceptual/scc-powershell.md b/exchange/docs-conceptual/scc-powershell.md new file mode 100644 index 0000000000..e5ec203673 --- /dev/null +++ b/exchange/docs-conceptual/scc-powershell.md @@ -0,0 +1,42 @@ +--- +title: "Security & Compliance PowerShell" +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/1/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-powershell +ms.localizationpriority: medium +ms.assetid: 2f33bb84-cede-46f6-9d39-d246e8ce3543 +search.appverid: MET150 +description: "Learn about the articles that are available for using PowerShell for Microsoft Security & Compliance PowerShell." +--- + +# Security & Compliance PowerShell + +Security & Compliance PowerShell is the administrative interface that enables you to manage compliance and some security features of your Microsoft 365 organization from the command line (mostly Microsoft Purview risk and compliance features that were formerly part of Microsoft 365 compliance). For example, you can use Security & Compliance PowerShell to perform Compliance Searches. The following articles provide information about using Security & Compliance PowerShell: + +- To learn about the ExchangeOnlineManagement module that's required to connect to Security & Compliance PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). + + > [!TIP] + > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). + + To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). + +- To connect to Security & Compliance PowerShell, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). The connection instructions are different from Exchange Online PowerShell or standalone Exchange Online Protection (EOP) PowerShell. + + To connect to Security & Compliance PowerShell for unattended scripts, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). + +- To learn about the structure and layout of the cmdlet reference articles in Security & Compliance PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). + +Security & Compliance PowerShell contains the following types of cmdlets: + +- Cmdlets that correspond to features available only in Purview compliance and the Microsoft Purview compliance portal. Most cmdlets in Security & Compliance PowerShell fall into this category. +- Basic cmdlets that are also available in Exchange Online PowerShell (for example, [Get-User](/powershell/module/exchange/get-user), and [Get-RoleGroup](/powershell/module/exchange/get-rolegroup)). +- A few cmdlets that correspond to security features available in Exchange Online Protection (EOP) and Microsoft Defender for Office 365 in the Microsoft Defender portal (for example, [Set-SecOpsOverridePolicy](/powershell/module/exchange/set-secopsoverridepolicy)). + + Cmdlets for most EOP and Defender for Office 365 security features (for example, [anti-spam policies](/defender-office-365/anti-spam-protection-about)) are available only in [Exchange Online PowerShell](exchange-online-powershell.md). + +Check the **Applies to** value in the cmdlet references article to verify the PowerShell environment where the cmdlet actually resides. diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index ab40a0c2b9..b19c66c699 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -1,51 +1,85 @@ - - name: Home - href: index.md + href: index.yml items: - - name: Exchange Server PowerShell - href: exchange-server/exchange-management-shell.md - items: - - name: Open the Exchange Management Shell - href: exchange-server/open-the-exchange-management-shell.md - - name: Connect to Exchange servers using remote PowerShell - href: exchange-server/connect-to-exchange-servers-using-remote-powershell.md - - name: Control remote PowerShell access to Exchange servers - href: exchange-server/control-remote-powershell-access-to-exchange-servers.md - - name: Find the permissions required to run any Exchange cmdlet - href: exchange-server/find-exchange-cmdlet-permissions.md - - name: Exchange cmdlet syntax - href: exchange-server/exchange-cmdlet-syntax.md - - name: Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers - href: exchange-server/use-update-exchangehelp.md - - name: Recipient filters in Exchange Management Shell commands - href: exchange-server/recipient-filters/recipient-filters.md + - name: Exchange Server PowerShell + href: exchange-management-shell.md items: - - name: Filterable properties for the Filter parameter - href: exchange-server/recipient-filters/filter-properties.md - - name: Filterable properties for the RecipientFilter parameter - href: exchange-server/recipient-filters/recipientfilter-properties.md - - name: Exchange Online PowerShell - href: exchange-online/exchange-online-powershell.md - items: - - name: Connect to Exchange Online PowerShell - href: exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md + - name: Open the Exchange Management Shell + href: open-the-exchange-management-shell.md + - name: Connect to Exchange servers using remote PowerShell + href: connect-to-exchange-servers-using-remote-powershell.md + - name: Control remote PowerShell access to Exchange servers + href: control-remote-powershell-access-to-exchange-servers.md + - name: Find the permissions required to run any Exchange cmdlet + href: find-exchange-cmdlet-permissions.md + - name: Exchange cmdlet syntax + href: exchange-cmdlet-syntax.md + - name: Recipient filters in Exchange Management Shell commands + href: recipient-filters.md + items: + - name: Filterable properties for the Filter parameter + href: filter-properties.md + - name: Filterable properties for the RecipientFilter parameter + href: recipientfilter-properties.md + - name: Values for the CustomPropertyNames parameter + href: values-for-custompropertynames-parameter.md + - name: Exchange Online PowerShell + href: exchange-online-powershell.md items: - - name: Connect to Exchange Online PowerShell using multi-factor authentication - href: exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md - - name: Find the permissions required to run any Exchange cmdlet - href: exchange-server/find-exchange-cmdlet-permissions.md - - name: Enable or disable access to Exchange Online PowerShell - href: exchange-online/disable-access-to-exchange-online-powershell.md - - name: Office 365 Security & Compliance Center PowerShell - href: office-365-scc/office-365-scc-powershell.md - items: - - name: Connect to Office 365 Security & Compliance Center PowerShell - href: office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md + - name: About the Exchange Online PowerShell module + href: exchange-online-powershell-v2.md + - name: Connect to Exchange Online PowerShell - modern auth and MFA + href: connect-to-exchange-online-powershell.md + - name: Connect using app-only authentication for unattended scripts + href: app-only-auth-powershell-v2.md + - name: Connect using Azure managed identity + href: connect-exo-powershell-managed-identity.md + - name: Connect using C# + href: connect-to-exo-powershell-c-sharp.md + - name: Workarounds for Invoke-Command in REST API connections + href: invoke-command-workarounds-rest-api.md + - name: Enable or disable access to Exchange Online PowerShell + href: disable-access-to-exchange-online-powershell.md + - name: Exchange cmdlet syntax + href: exchange-cmdlet-syntax.md + - name: Find the permissions required to run any Exchange cmdlet + href: find-exchange-cmdlet-permissions.md + - name: What's new in the Exchange Online PowerShell module + href: whats-new-in-the-exo-module.md + - name: Recipient filters in Exchange PowerShell commands + href: recipient-filters.md + items: + - name: Filterable properties for the Filter parameter + href: filter-properties.md + - name: Filterable properties for the RecipientFilter parameter + href: recipientfilter-properties.md + - name: Filters in Exchange Online PowerShell module cmdlets + href: filters-v2.md + - name: Property sets in Exchange Online PowerShell module cmdlets + href: cmdlet-property-sets.md + - name: Security & Compliance PowerShell + href: scc-powershell.md items: - - name: Connect to Office 365 Security & Compliance Center PowerShell using multi-factor authentication - href: office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md - - name: Exchange Online Protection PowerShell - href: exchange-eop/exchange-online-protection-powershell.md - items: - - name: Connect to Exchange Online Protection PowerShell - href: exchange-eop/connect-to-exchange-online-protection-powershell.md + - name: About the Exchange Online PowerShell module + href: exchange-online-powershell-v2.md + - name: Connect to Security & Compliance PowerShell - modern auth and MFA + href: connect-to-scc-powershell.md + - name: App-only authentication for unattended scripts + href: app-only-auth-powershell-v2.md + - name: Exchange cmdlet syntax + href: exchange-cmdlet-syntax.md + - name: Information protection client advanced settings + href: client-advanced-settings.md + - name: What's new in the Exchange Online PowerShell module + href: whats-new-in-the-exo-module.md + - name: Exchange Online Protection PowerShell + href: exchange-online-protection-powershell.md + items: + - name: About the Exchange Online PowerShell module + href: exchange-online-powershell-v2.md + - name: Connect to Exchange Online Protection PowerShell - modern auth and MFA + href: connect-to-exchange-online-protection-powershell.md + - name: Exchange cmdlet syntax + href: exchange-cmdlet-syntax.md + - name: What's new in the Exchange Online PowerShell module + href: whats-new-in-the-exo-module.md diff --git a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md new file mode 100644 index 0000000000..ea729cff90 --- /dev/null +++ b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md @@ -0,0 +1,213 @@ +--- +title: Values for the CustomPropertyNames parameter +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 9/7/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about the valid values for the CustomPropertyNames parameter on the Get-CalendarDiagnosticsLog cmdlet in Exchange Online PowerShell." +--- + +# Values for the CustomPropertyNames parameter in Exchange Online PowerShell + +The _CustomPropertyNames_ parameter on the [Get-CalendarDiagnosticObjects](/powershell/module/exchange/get-calendardiagnosticobjects) cmdlet returns the specified properties in the results. + +The article describes the valid values for the _CustomPropertyNames_ parameter. + +|CustomPropertyNames|Description| +|---|---| +|AddOnlineMeetingOnFinalize|Add online meeting on finalize flag.| +|AllAttachmentsHidden|Displays whether there are non-inline attachments inside a protected message.| +|AppointmentAuxiliaryFlags|Detect whether the meeting request is a forwarded meeting (for example, IsForwardedMeeting or AttendeeCount).| +|AppointmentClass|The MessageClass of the calendar that the meeting message is created from.| +|AppointmentCounterEndWhole|End time proposal.| +|AppointmentCounterProposalCount|Current counter proposal count.| +|AppointmentCounterProposal|Indicates whether a Meeting Response object is a counter proposal.| +|AppointmentCounterStartWhole|Start time proposal.| +|AppointmentLastSequenceNumber|If AppointmentSequenceNumber doesn't match, use AppointmentLastSequenceNumber to decide if this is a stale incoming request.| +|AppointmentProposedDuration|Proposed duration of the meeting in total minutes.| +|AppointmentRecurrenceBlob|Holds a copy of recurring information only from Recurring Masters.| +|AppointmentRecurring|Boolean value indicating whether an Appointment is recurring.| +|AppointmentReplyName|The calendar item appointment reply name.| +|AppointmentReplyTime|Gets the time when the attendee replied to the meeting request.| +|AppointmentSequenceNumber|Gets the sequence number of this appointment.| +|AppointmentSequenceTime|A sequence number that's incremented on every modification.| +|AppointmentStateInternal|The state of this appointment (for example, Meeting or Received).| +|AppointmentState|The state of this appointment (for example, Meeting or Received).| +|AttendeeCriticalChangeTime|The attendee's critical change time.| +|BirthdayContactAttributionDisplayName|Indicates the name of the contact that's associated with the birthday event.| +|BirthdayContactId|Represents the birthday contact ID property.| +|BirthdayPersonId|Represents the birthday person ID property that's used to associate multiple contact objects to a single, aggregate person.| +|Birthday|Birthday of the contact.| +|CalendarItemExperienceTypeInternal|Experience type for a calendar item. Used by the client to render custom user experiences for different types of calendar items.| +|CalendarItemType|The Calendar Item Type (for example, RecurringMaster).| +|CalendarLogTriggerAction|The action that's taken on the item (for example, Create or Update).| +|CalendarOriginatorId|Identification of the organizer to prevent unintentional takeover of a meeting by other users.| +|CalendarProcessed|Check if XSO has processed the meeting message.| +|CalendarProcessingSteps|A set of flags for the various steps that were completed in the stages of processing.| +|ChangeHighlight|Encapsulates information on the change highlights of a meeting request.| +|ChangeList|Add item to change list.| +|Charm|Charm on a calendar folder or item.| +|CleanGlobalObjectId|The GlobalObjectId with the Instance Date segment zeroed out. This property is the same for all meeting objects of all exceptions and masters belonging to the same series.| +|ClientBuildVersion|Outlook client build version.| +|ClientInfoString|The entity that made the change (for example, `Client=OWA;, Client=WebServices;;`, or `Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;`).| +|ClientIntent|The intent of the client from any changes that are made to the item.| +|ClientProcessName|Client process name (for example, OUTLOOK.EXE).| +|ConferenceInfo|Used by legacy online meetings and by calling the UCWA APIs.| +|ConferenceTelURI|The conference telephone URI for online meeting.| +|ConferenceType|The type of conferencing that's used during the meeting.| +|ConnectedCalendarEventSourceData|Contains the data of a connected calendar event as received from the source.| +|CreationHash|A hash that identifies the original request to create an event.| +|CreationTime|Creation time of the item.| +|DisallowNewTimeProposal|Specifies whether recipients of the meeting request can propose a new time for the meeting.| +|DisplayAttendeesAll|List of all attendees.| +|DisplayAttendeesCc|Display the Attendees list in the Cc line.| +|DisplayAttendeesTo|Display the Attendees list in the To line.| +|DoNotForward|Organizer wants to prevent attendees from inviting others.| +|Duration|Duration in minutes.| +|EndTimeZoneId|Time zone of the end of the meeting.| +|EndTimeZone|Defines the EndTimeZone property.| +|EndTime|End time of a calendar item.| +|EndWallClock|The end time of the meeting expressed in the time zone of the meeting.| +|EnhancedLocation|Indicates that Enhanced Location data is present. Has value Microsoft.Exchange.Data.Storage.EnhancedLocation.| +|EntryId|The store entry ID or PR_ENTRYID (MAPI).| +|EstimatedAcceptCount|An estimated count of the number of attendees who accepted the meeting.| +|EstimatedAttendeeCount|An estimated count of the number of attendees of the meeting.| +|EstimatedDeclineCount|An estimated count of the number of attendees who declined the meeting.| +|EstimatedTentativeCount|An estimated count of the number of attendees who tentatively accepted the meeting.| +|EventClientId|Client-generated string representing the ID for a series of calendar events.| +|EventDraft|Indicates whether the calendar event is in the draft state.| +|EventResponseTrackingSource|Event response tracking status.| +|EventTimeBasedInboxRemindersState|Contains the state for time-based Inbox reminders pertaining to calendar events.| +|EventTimeBasedInboxReminders|Contains time-based Inbox reminders pertaining to calendar events.| +|ExceptionReplaceTime|The exception replace time.| +|ExceptionalAttendees|Boolean value indicating whether there are Exceptional Attendees.| +|ExceptionalBody|Boolean value indicating whether there are Exceptional Body is changed.| +|ExternalSharingMasterId|If a copy of a remote calendar in shared in the calendar, don't set the organizer, because the organizer isn't simply the owner of the current mailbox. It syncs back from master copy where it's properly evaluated when saved.| +|ForwardNotificationRecipients|List of Forwarded Recipients.| +|FreeBusyStatus|Free/busy status associated with the event.| +|From|From email address.| +|GlobalObjectId|A binary blob used to correlate the meeting requests/responses/cancellations in the Inbox with the meeting item in the Calendar.| +|HasAttachment|Indicates whether the item has attachments.| +|HasExceptionalInboxReminders|Whether a series has any exceptional Inbox reminders.| +|HijackedMeeting|Indicates whether the meeting request was hijacked. Useful to identify specific meetings that weren't processed because another user hijacked the meeting.| +|Importance|Importance status of the email (for example, Normal).| +|InboundICalStream|The contents of the iCalendar MIME part of the original MIME message.| +|InstanceCreationIndex|The index of this instance when the series was originally created.| +|IntendedFreeBusyStatus|The intended free/busy status of the meeting.| +|InternetMessageId|Internet Message ID of the e-mail message.| +|IsAllDayEvent|Indicates whether this appointment is an all day event.| +|IsBirthdayContactWritable|Indicates whether the contact that's associated with the birthday event is writable.| +|IsCancelled|Boolean value indicating whether the meeting is canceled.| +|IsCopyOnWriteItem|Indicator for Calendar Logging items.| +|IsDraft|Boolean value indicating whether the item is a draft. An item is a draft when it hasn't yet been sent.| +|IsEvent|Indicates if the meeting should be displayed in a banner for the event, not in the calendar grid area.| +|IsException|Indicates whether the calendar event is an exception in a recurring series.| +|IsHiddenFromLegacyClients|Decides whether the modern calendar item should be hidden for legacy clients.| +|IsMeetingPollEvent|Boolean value indicating whether the item is a meeting poll event.| +|IsMeeting|Boolean value indicating whether the calendar event is a meeting.| +|IsProcessed|Boolean value indicating whether the message was processed by XSO or by Outlook.| +|IsPublishedCalendarItem|Boolean value indicating whether a calendar event (schedule) has been published.| +|IsRecurring|Boolean value indicating whether the calendar event is recurring.| +|IsResponseRequested|Boolean value indicating whether responses are requested when invitations are sent for this meeting.| +|IsSeriesCancelled|Boolean value indicating whether the recurring master is canceled. Expected to be True for the attendee.| +|IsSilent|Boolean value indicating if the response doesn't contain message body text.| +|IsSingleBodyICal|Boolean value indicating that the original MIME message contained a single MIME part.| +|IsSoftDeleted|Boolean value indicating if the object is soft-deleted.| +|ItemClass|A text string that identifies the sender-defined message class (for example, IPM.Note).| +|ItemId|Object Store ItemId.| +|ItemVersion|Version of the item.| +|LastModifiedTime|The date/time that this item was last modified.| +|LocationAddressInternal|One of the properties that define the enhanced location and their corresponding default values.| +|Location|Gets the location of the calendar event.| +|MFNAddedRecipients|The list of recipients that were explicitly forwarded.| +|MailboxDatabaseName|The distinguished name (DN) of the mailbox database.| +|MapiEndTime|EndTime of Meeting.| +|MapiIsAllDayEvent|An all-day event is midnight to midnight.| +|MapiPREndDate|MapiPR(Pattern Recurrence) EndDate of Meeting.| +|MapiPRStartDate|MapiPR(Pattern Recurrence) StartDate of Meeting.| +|MapiStartTime|StartTime of Meeting.| +|MasterGlobalObjectId|The original GUID of the item if another process needs to change it.| +|MeetingRequestType|Defines the type of meeting request.| +|MeetingRequestWasSent|Indicates whether the meeting request has already been sent.| +|MeetingUniqueId|Unique meeting ID that's used to link meeting history to the master meeting item.| +|MeetingWorkspaceUrl|URL of the meeting workspace. A meeting workspace is a shared website for planning meetings and tracking results.| +|MiddleTierProcessName|ProcessName handling the request (for example, w3wp).| +|MiddleTierServerBuildVersion|EXO Build Version.| +|MiddleTierServerName|Backend Mailbox ServerName.| +|NormalizedSubject|Subject of the meeting.| +|OccurrencesExceptionalViewProperties|Blob representing the exceptional properties of instances of an NPR.| +|OldLocation|Saved old location before updating the new location.| +|OldStartWhole|Old time properties on the updated meeting request.| +|OnlineMeetingConfLink|The online meeting link.| +|OnlineMeetingExternalLink|The online meeting external link.| +|OnlineMeetingInformation|The online meeting information.| +|OnlineMeetingInternalLink|The HTTPS URI for joining the Lync online meeting. Deprecated.| +|OriginalClientInfoString|Some processes are touching the ClientInfoString, so we need to back up the original value for Calendar Logging items.| +|OriginalCreationTime|Creation time of the item.| +|OriginalEntryId|Original `PR_ENTRYID` (MAPI), unique ID identifier in store.| +|OriginalFolderId|Original `PR_FOLDERID` (MAPI), unique ID identifier in store.| +|OriginalGlobalObjectId|The original GUID of the item in case we have to change it.| +|OriginalICal|The original iCal of an imported item.| +|OriginalLastModifiedTime|Used as the primary sort field to order the events.| +|OriginalMeetingType|Retains the original MeetingType in case the original meeting type is reset.| +|OriginalStoreEntryId|Maintains a copy of the store entry ID if the original gets modified.| +|OwnerAppointmentID|A number that's unique to the sender's calendar. Outlook uses this number to correlate meeting messages with calendar items.| +|OwnerCriticalChangeTime|DateTime tracking value for Owner Critical Change Time.| +|ParentDisplayName|ParentDisplayName of the Folder.| +|ParkedCorrelationId|The correlation ID of parked message.| +|ParkedMessagesFolderEntryId|The entry ID of the ParkedMessages folder.| +|Preview|Preview of the email message.| +|PropertyChangeMetadataProcessingFlags|Flags representing property change metadata processing behavior.| +|PropertyChangeMetadataRaw|Blob representing property change metadata for Series exception management purposes.| +|PublishedCalendarItemUrl|The URL of a published calendar event (schedule).| +|RawAttendeeInformation|Raw attendee information provided by a client. Used to help troubleshoot and debug attendee translation issues.| +|ReceivedBy|The ReceivedBy property of the email message.| +|ReceivedRepresenting|Returns the received on behalf display name for delegate meeting message own meeting.| +|RecipientType|The recipient type of a recipient on the message.| +|RecurrencePattern|A date for which this pattern should be created.| +|ReminderIsSetInternal|Boolean value indicating whether the reminder is set internally.| +|ReminderMinutesBeforeStartInternal|Reminder in minutes before the meeting starts.| +|ResponseState|Values are Accepted, Tentative, or Declined.| +|ResponseType|Gets the type of response the attendee gave to the meeting invitation it received.| +|ResponsibleUserName|The LegacyExchangeDN value of the user who made the change (for example, `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant` or `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin`).| +|SenderEmailAddress|SMTP address of who sent it.| +|Sensitivity|The sensitivity of an item.| +|SentRepresentingDisplayName|The display name of the sent representing person.| +|SentRepresentingEmailAddress|Represents sent representing email address.| +|SentRepresentingEntryId|The entry ID of the sent representing person.| +|SentRepresentingType|The address type of the sent representing person.| +|SeriesId|Representing ID for series of calendar events.| +|SeriesReminderIsSet|Flag indicating whether a reminder is set for the whole series.| +|Size|Size in bytes of the Meeting Message.| +|SkypeTeamsMeetingUrl|The meeting URL for a Teams meeting.| +|SkypeTeamsProperties|The relevant properties for a Teams meeting.| +|StartTimeZoneId|Time zone of the start of the meeting.| +|StartTimeZone|Start timezone of a calendar item.| +|StartTime|Start time of a calendar item.| +|StartWallClock|The start time of the meeting expressed in the time zone of the meeting.| +|SuggestionCategory|The suggestion category for the message.| +|TimeZoneBlob|Outlook time zone blob (from the registry) for recurrence.| +|TimeZoneDefinitionEnd|Legacy time zone (ExchangeTimeZoneTime) blob for end time.| +|TimeZoneDefinitionRecurring|Legacy time zone (ExchangeTimeZoneTime) blob for recurrence.| +|TimeZoneDefinitionStart|Legacy time zone (ExchangeTimeZoneTime) blob for start time.| +|TimeZone|TimeZone value.| +|TransportMessageHeaders|Transport Message Header Information.| +|UCCapabilities|The XML blob of OCS capabilities for the Lync online meeting.| +|UCInband|The XML blob of Inband data for the Lync online meeting.| +|UCMeetingSettingSent|The XML blob of all information related to the Lync online meeting.| +|UCMeetingSetting|The XML blob of all information related to the Lync online meeting.| +|UCOpenedConferenceID|RThe guid associated with this online meeting.| +|UnsendableRecipients|Recipient data for all unsendable recipients.| +|ViewEndTime|End time of a calendar item.| +|ViewStartTime|Start time of a calendar item.| +|When|Localized text using the Exchange Server culture or the culture specified in the PreferredCulture property of the ExchangeService object that this appointment is bound to.| diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md new file mode 100644 index 0000000000..64e027b733 --- /dev/null +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -0,0 +1,126 @@ +--- +title: What's new in the Exchange Online PowerShell module +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 03/26/2025 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: medium +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +keywords: what's new in exchange online powershell, what's new in security & compliance powershell, EXO V2 module, EXO V3 module +description: "Learn about the new features and functionality available in the latest release of the Exchange Online PowerShell module." +--- + +# What's new in the Exchange Online PowerShell module + +This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**. + +## March 2025 + +- [Version 3.7.2](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.7.1) + + For information about what's in this release, see [Version 3.7.2](exchange-online-powershell-v2.md#version-372). + +## January 2025 + +- [Version 3.7.1](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.7.1) + + For information about what's in this release, see [Version 3.7.1](exchange-online-powershell-v2.md#version-371). + +## December 2024 + +- [Version 3.7.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.7.0) + + Starting with this version of the module, command line help for Exchange Online PowerShell cmdlets is no longer loaded by default. Use the _LoadCmdletHelp_ parameter in the **Connect-ExchangeOnline** command so help for Exchange Online PowerShell cmdlets is available to the **Get-Help** cmdlet. + + For information about what's in this release, see [Version 3.7.0](exchange-online-powershell-v2.md#version-370). + +## September 2024 + +- [Version 3.6.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.6.0) + + For information about what's in this release, see [Version 3.6.0](exchange-online-powershell-v2.md#version-360). + +## July 2024 + +- [Version 3.5.1](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.5.1) has been released. + + For information about what's in this release, see [Version 3.5.1](exchange-online-powershell-v2.md#version-351). + +## May 2024 + +- [Version 3.5.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.5.0) has been released. + + For information about what's in this release, see [Version 3.5.0](exchange-online-powershell-v2.md#version-350). + +## October 2023 + +- [Version 3.4.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.4.0) + + For information about what's in this release, see [Version 3.4.0](exchange-online-powershell-v2.md#version-340). + +## September 2023 + +- [Version 3.3.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.3.0) has been released. + + For information about what's in this release, see [Version 3.3.0](exchange-online-powershell-v2.md#version-330). + +## June 2023 + +- [Version 3.2.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0) has been released. + +- [Virtually all](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432) Security & Compliance PowerShell cmdlets are now backed by the REST API, and REST API is used by default. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. + + For information about what's in this release, see [Version 3.2.0](exchange-online-powershell-v2.md#version-320). + +## May 2023 + +- The end of support for remote PowerShell in Security & Compliance PowerShell has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + +- [Version 3.2.0-Preview4](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview4) has been released. + + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + + > [!NOTE] + > The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is now the same as **Connect-ExchangeOnline**. To connect in REST API mode, don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. + > + > REST API connections in the EXO V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +## April 2023 + +- [Version 3.2.0-Preview3](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview3) has been released. + + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + + > [!NOTE] + > The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is opposite of **Connect-ExchangeOnline**. To connect in REST API mode, use `-UseRPSSession:$false` in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. The default behavior will change in a later version of the module as more Security & Compliance cmdlets are available in REST API mode. + +## January 2023 + +- [Version 3.1.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0) has been released. + + For information about what's in this release, see [Version 3.1.0](exchange-online-powershell-v2.md#version-310). + +## December 2022 + +- The end of support for remote PowerShell in Exchange Online PowerShell (not in Security & Compliance PowerShell) has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). + +## September 2022 + +- Version 3.0.0 has been released, and is now known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module): + - Version 3.0.0 is the Generally Availability (GA) release of the 2.0.6-PreviewX versions of the module. + - All Exchange Online PowerShell cmdlets are now backed by the REST API. Basic authentication in WinRM is not required in Exchange Online PowerShell for REST API cmdlets. + + > [!TIP] + > REST API connections in the EXO V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + + - Certificate based authentication (also known as CBA or app-only authentication) is available for Security & Compliance PowerShell. + + For more information, see [REST API connections in the EXO V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module) and [Version 3.0.0](exchange-online-powershell-v2.md#version-300-preview-versions-known-as-v206-previewx). diff --git a/exchange/exchange-ps/exchange/Add-ADPermission.md b/exchange/exchange-ps/exchange/Add-ADPermission.md new file mode 100644 index 0000000000..c1daf4b98b --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-ADPermission.md @@ -0,0 +1,437 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-ADPermission + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Add-ADPermission cmdlet to add permissions to an Active Directory object. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AccessRights +``` +Add-ADPermission [-Identity] -User + [-AccessRights ] + [-ChildObjectTypes ] + [-Confirm] + [-Deny] + [-DomainController ] + [-ExtendedRights ] + [-InheritanceType ] + [-InheritedObjectType ] + [-Properties ] + [-WhatIf] + [] +``` + +### Owner +``` +Add-ADPermission [-Identity] -Owner + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### Instance +``` +Add-ADPermission [[-Identity] ] -Instance + [-AccessRights ] + [-ChildObjectTypes ] + [-Confirm] + [-Deny] + [-DomainController ] + [-ExtendedRights ] + [-InheritanceType ] + [-InheritedObjectType ] + [-Properties ] + [-User ] + [-WhatIf] + [] +``` + +## 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Add-ADPermission -Identity "Terry Adams" -User AaronPainter -AccessRights ExtendedRight -ExtendedRights "Send As" +``` + +This example grants Send As permissions for Aaron Painter to Terry Adams's mailbox. + +### Example 2 +```powershell +Add-AdPermission "IP Secured Inbound" -User "NT AUTHORITY\ANONYMOUS LOGON" -ExtendedRights ms-Exch-SMTP-Submit,ms-Exch-SMTP-Accept-Any-Recipient,ms-Exch-Bypass-Anti-Spam +``` + +This example configures the IP Secured Inbound Receive connector to accept anonymous SMTP messages. + +This example assumes that another security mechanism is used to ensure the Receive connector can't be used to send unsolicited commercial email messages. We recommend that you don't allow external clients to send messages anonymously through a Receive connector. + +## PARAMETERS + +### -Identity +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 +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +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 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Owner +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 +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the AccessRights or User parameters. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: Owner +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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 +- Mail users +- Security groups + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Owner parameter. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: Instance +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 +``` + +### -AccessRights +The AccessRights parameter specifies the rights that you want to add for the user on the Active Directory object. Valid values include: + +- AccessSystemSecurity +- CreateChild +- DeleteChild +- ListChildren +- Self +- ReadProperty +- WriteProperty +- DeleteTree +- ListObject +- ExtendedRight +- Delete +- ReadControl +- GenericExecute +- GenericWrite +- GenericRead +- WriteDacl +- WriteOwner +- GenericAll +- Synchronize + +You can specify multiple values separated by commas. + +You can't use this parameter with the Owner parameter. + +```yaml +Type: ActiveDirectoryRights[] +Parameter Sets: AccessRights, Instance +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 +``` + +### -ChildObjectTypes +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -Deny +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 +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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedRights +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InheritanceType +The InheritanceType parameter specifies how permissions are inherited. Valid values are: + +- None +- All (this is the default value) +- Children +- Descendents [sic] +- SelfAndChildren + +```yaml +Type: ActiveDirectorySecurityInheritance +Parameter Sets: AccessRights, Instance +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 +``` + +### -InheritedObjectType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Add-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md new file mode 100644 index 0000000000..000fae4281 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-AttachmentFilterEntry + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Add-AttachmentFilterEntry cmdlet to add an entry to the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-AttachmentFilterEntry -Name -Type + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Add-AttachmentFilterEntry -Name *.txt -Type FileName +``` + +This example adds an attachment filter entry based on a file name. After running this command, the Attachment Filtering agent filters all attachments that have a .txt extension. + +### Example 2 +```powershell +Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType +``` + +This example adds an attachment filter entry based on the MIME content type image/jpeg, which is a JPEG image binary file. After running this command, the Attachment Filtering agent filters all attachments of the MIME content type image/jpeg. + +## PARAMETERS + +### -Name +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. +- A valid MIME content type (for example, application/javascript or text/scriplet). You need to use the value ContentType for the Type parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +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. +- FileName: This value matches the attachment filter entry against the simple file name that's specified in the Name parameter. + +```yaml +Type: AttachmentType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md new file mode 100644 index 0000000000..aedd7aee1a --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md @@ -0,0 +1,297 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Add-AvailabilityAddressSpace cmdlet to create availability address space objects that are used to share free/busy data across Exchange organizations. + +The maximum number off Availability address spaces returned by Active Directory to Exchange is 100. We recommend using 100 or fewer address spaces in order for Availability lookups to work properly. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-AvailabilityAddressSpace -AccessMethod -ForestName + [-Confirm] + [-Credentials ] + [-DomainController ] + [-ProxyUrl ] + [-TargetAutodiscoverEpr ] + [-TargetServiceEpr ] + [-TargetTenantId ] + [-UseServiceAccount ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Add-AvailabilityAddressSpace -ForestName contoso.com -AccessMethod OrgWideFB -Credentials (Get-Credential) +``` + +In on-premises Exchange, this example is useful with an untrusted cross-forest Availability service, or if detailed cross-forest free/busy service isn't desired. Enter a username and password when you're prompted by the command. For an untrusted cross-forest configuration, make sure that the user doesn't have a mailbox. + +### Example 2 +```powershell +Add-AvailabilityAddressSpace -ForestName contoso.com -AccessMethod PerUserFB -Credentials (Get-Credential) +``` + +In on-premises Exchange, this example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest, and the specified account connects to the contoso.com forest. The specified account must be an existing account in the contoso.com forest. + +### Example 3 +```powershell +Add-AvailabilityAddressSpace -ForestName contoso.com -AccessMethod PerUserFB -UseServiceAccount $true +``` + +In on-premises Exchange, this example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest and uses the service account (typically the local system account or the computer account) to connect to the contoso.com forest. Because the service is trusted, there is no issue with authorization when the current forest tries to retrieve free/busy information from contoso.com. + +### Example 4 +```powershell +Add-AvailabilityAddressSpace -ForestName contoso.onmicrosoft.com -AccessMethod OrgWideFBToken -TargetTenantId "9d341953-da1f-41b0-8810-76d6ef905273" -TargetServiceEpr "outlook.office.com" +``` + +In Exchange Online, this example sets up the sharing of free/busy information with contoso.onmicrosoft.com (tenant ID value 9d341953-da1f-41b0-8810-76d6ef905273), which is a regular Microsoft 365 organization. + +## PARAMETERS + +### -AccessMethod +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. +- InternalProxy: The request is proxied to an Exchange server in the site that's running a later version of Exchange. +- PublicFolder: This value was used to access free/busy data on Exchange Server 2003 servers. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForestName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +The Credentials parameter specifies the username and password that's used to access the Availability services in the target forest. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -ProxyUrl +This parameter is available only in on-premises Exchange. + +The ProxyUrl parameter was used to specify the URL that directed an Exchange 2007 Client Access server to proxy 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). + +```yaml +Type: Uri +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 +``` + +### -TargetAutodiscoverEpr +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetServiceEpr +This parameter is available only in the cloud-based service. + +The TargetServiceEpr parameter specifies the Exchange Online Calendar Service URL of the external Microsoft 365 organization that you're trying to read free/busy information from. Valid values are: + +- Microsoft 365 or Microsoft 365 GCC: outlook.office.com +- Office 365 operated by 21Vianet: partner.outlook.cn +- Microsoft 365 GCC High or DoD: outlook.office365.us + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetTenantId +This parameter is available only in the cloud-based service. + +The TargetTenantID parameter specifies the tenant ID of the external Microsoft 365 organization that you're trying to read free/busy information from. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseServiceAccount +This parameter is available only in on-premises Exchange. + +The UseServiceAccount parameter specifies whether to use the local Availability service account for authorization. Valid values + +- $true: The local Availability service account is used for authorization. +- $false: The local Availability service account isn't used for authorization. You need to use the Credentials 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Add-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md new file mode 100644 index 0000000000..ddec608aad --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md @@ -0,0 +1,135 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Add-ComplianceCaseMember + +## 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 Add-ComplianceCaseMember cmdlet to add an individual member to an eDiscovery case in the Microsoft Purview compliance portal. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-ComplianceCaseMember [-Case] -Member + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You use eDiscovery cases to control who can create, access, and manage compliance searches in your organization. You use the New-ComplianceCase cmdlet to create eDiscovery cases. The eDiscovery Manager who created the case is automatically added as a member of the case. + +To add a member of an eDiscovery case, the user needs to be a member of the Reviewer or eDiscovery Manager role groups. When a member of the eDiscovery Manager role group is a member of an eDiscovery case, the user can: + +- Add and remove case members. +- Create and edit compliance searches associated with a case. +- Perform compliance actions (for example, export) on the results of a compliance search. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Add-ComplianceCaseMember -Case "Case 2112" -Member johnevans@contoso.com +``` + +This example adds John Evans to the eDiscovery case named Case 2112. + +## PARAMETERS + +### -Case +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Member +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```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 +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Add-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md similarity index 79% rename from exchange/exchange-ps/exchange/antispam-antimalware/Add-ContentFilterPhrase.md rename to exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md index ab6f326dc5..72bcef12ec 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Add-ContentFilterPhrase.md +++ b/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-ContentFilterPhrase @@ -11,26 +14,29 @@ monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Add-ContentFilterPhrase cmdlet to define custom words for the Content Filter agent. A custom word is a word or phrase that the administrator sets for the Content Filter agent to evaluate the content of an message and apply appropriate filter processing. +Use the Add-ContentFilterPhrase cmdlet to define custom words for the Content Filter agent. A custom word is a word or phrase that the administrator sets for the Content Filter agent to evaluate the content of an message and apply appropriate filter processing. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Add-ContentFilterPhrase [-Phrase] -Influence [-Confirm] - [-DomainController ] [-WhatIf] [] +Add-ContentFilterPhrase [-Phrase] -Influence + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-ContentFilterPhrase -Phrase "Free credit report" -Influence BadWord ``` @@ -38,33 +44,35 @@ This example adds the phrase Free credit report to the Block phrase list. Any me ## PARAMETERS -### -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. - -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. +### -Phrase +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: GoodWord | BadWord +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Phrase -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. +### -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. + +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. ```yaml -Type: String +Type: Influence Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False @@ -73,8 +81,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -82,6 +89,7 @@ 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 @@ -99,6 +107,7 @@ 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 @@ -114,6 +123,7 @@ 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 @@ -122,20 +132,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/ac73d6e0-f64a-4a49-99cf-ac8cfa349b5c.aspx) diff --git a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md new file mode 100644 index 0000000000..d1e4a31542 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md @@ -0,0 +1,171 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-DatabaseAvailabilityGroupServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Add-DatabaseAvailabilityGroupServer cmdlet to add a Mailbox server to a database availability group (DAG). A DAG is a set of Mailbox servers that use continuous replication and managed availability to provide automatic database-level recovery from database, server, or network failures. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-DatabaseAvailabilityGroupServer [-Identity] [-MailboxServer] + [-Confirm] + [-DomainController ] + [-SkipDagValidation] + [-WhatIf] + [] +``` + +## DESCRIPTION +A computer object for a DAG is created in Active Directory when the first server is added to the DAG. This object is used to authenticate servers to each other within a DAG. + +To add a Mailbox server to a DAG, the Mailbox server must be running the Windows Server 2008 R2 Enterprise or Datacenter operating system, the Windows Server 2012 Standard or Datacenter operating system, or the Windows Server 2012 R2 operating system, and it must not belong to any other DAG. The Mailbox server must be running the same versions of the Windows operating system and Microsoft Exchange, and be in the same Active Directory domain as all other Mailbox servers in the DAG. In addition, the Mailbox server must not be configured as an Active Directory domain controller or global catalog server. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Add-DatabaseAvailabilityGroupServer -Identity DAG1 -MailboxServer MBX1 +``` + +This example adds the Mailbox server MBX1 to the DAG DAG1. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MailboxServer +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 2 +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 +``` + +### -SkipDagValidation +The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when adding members to the DAG. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/users-and-groups/Add-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md similarity index 75% rename from exchange/exchange-ps/exchange/users-and-groups/Add-DistributionGroupMember.md rename to exchange/exchange-ps/exchange/Add-DistributionGroupMember.md index c8180c6f56..90029ad72b 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Add-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-DistributionGroupMember @@ -13,23 +16,27 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-DistributionGroupMember cmdlet to add a single recipient to distribution groups and mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Add-DistributionGroupMember [-Identity] [-BypassSecurityGroupManagerCheck] - [-Confirm] [-DomainController ] [-Member ] [-WhatIf] +Add-DistributionGroupMember [-Identity] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController ] + [-Member ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-DistributionGroupMember -Identity "Staff" -Member "JohnEvans@contoso.com" ``` @@ -38,22 +45,13 @@ This example adds John Evans to the distribution group named Staff. ## PARAMETERS ### -Identity -The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. - -For example: +The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID ```yaml @@ -61,6 +59,7 @@ 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 Default value: None @@ -69,19 +68,19 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) 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 @@ -92,8 +91,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -101,6 +99,7 @@ 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 @@ -118,6 +117,7 @@ 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 @@ -126,40 +126,13 @@ Accept wildcard characters: False ``` ### -Member -The Member parameter specifies the recipient (mail-enabled object) that you want to add to the group. You can use any value that uniquely identifies the recipient. - -For example: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- Email address - -- GUID - -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - - 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. @@ -169,6 +142,7 @@ 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 Default value: None @@ -184,6 +158,7 @@ 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 @@ -192,20 +167,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b586ea3a-8243-460a-a400-9ab5823ba782.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Add-FederatedDomain.md b/exchange/exchange-ps/exchange/Add-FederatedDomain.md similarity index 76% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Add-FederatedDomain.md rename to exchange/exchange-ps/exchange/Add-FederatedDomain.md index 37947c16df..1a193dfead 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Add-FederatedDomain.md +++ b/exchange/exchange-ps/exchange/Add-FederatedDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-FederatedDomain @@ -15,26 +18,29 @@ Use the Add-FederatedDomain cmdlet to configure a secondary domain with the fede The domains being added to the federation trust must exist as accepted domains in the Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Add-FederatedDomain [[-Identity] ] -DomainName [-Confirm] - [-DomainController ] [-WhatIf] [] +Add-FederatedDomain [[-Identity] ] -DomainName + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION You can add any registered Internet domain to the federated organization identifier. You must prove domain ownership by creating a TXT record in the Domain Name System (DNS) zone of each domain you add. -For more details, see Federation (https://technet.microsoft.com/library/dd335047.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-FederatedDomain -DomainName Contoso.co.uk ``` @@ -42,6 +48,22 @@ This example adds the domain Contoso.co.uk to the existing federation trust. ## PARAMETERS +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DomainName The DomainName parameter specifies the secondary domain to be configured. @@ -50,6 +72,7 @@ Type: SmtpDomain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -60,8 +83,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +91,7 @@ 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 @@ -84,6 +107,7 @@ 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 @@ -91,21 +115,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity 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 -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. @@ -114,6 +123,7 @@ 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 @@ -122,20 +132,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e44906ce-efa7-431c-a65f-b8489de1da33.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md similarity index 80% rename from exchange/exchange-ps/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md rename to exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md index 9b530b3307..975a6bf632 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-GlobalMonitoringOverride @@ -13,42 +16,46 @@ This cmdlet is available only in on-premises Exchange. Use the Add-GlobalMonitoringOverride cmdlet to override the thresholds and parameters of the managed availability probes, monitors and responders on all Exchange 2013 or later servers in your organization. The cmdlet enables monitoring changes and threshold tuning to the environment. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ApplyVersion ``` -Add-GlobalMonitoringOverride [-Identity] -ApplyVersion -ItemType -PropertyName -PropertyValue +Add-GlobalMonitoringOverride [-Identity] -ApplyVersion -ItemType -PropertyName -PropertyValue [-Confirm] [-DomainController ] [-Roles ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Duration ``` -Add-GlobalMonitoringOverride [-Identity] -ItemType -PropertyName -PropertyValue [-BuildRange ] [-Duration ] +Add-GlobalMonitoringOverride [-Identity] -ItemType -PropertyName -PropertyValue + [-BuildRange ] + [-Duration ] [-Confirm] [-DomainController ] [-Roles ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-GlobalMonitoringOverride -Identity "FrontendTransport\OnPremisesInboundProxy" -PropertyName Enabled -PropertyValue 0 -Duration 30.00:00:00 -ItemType Probe ``` This example adds a global monitoring override that disables the OnPremisesInboundProxy probe for 30 days. Note that the value of Identity is case-sensitive. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Add-GlobalMonitoringOverride -Identity "MailboxSpace\StorageLogicalDriveSpaceEscalate" -PropertyName Enabled -PropertyValue 0 -ItemType Responder -ApplyVersion "15.01.0225.0422" ``` @@ -56,35 +63,37 @@ This example adds a global monitoring override that disables the StorageLogicalD ## PARAMETERS -### -ApplyVersion -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. - -You can't use this parameter with the Duration parameter. +### -Identity +The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax `HealthSetName\MonitoringItemName[\TargetResource]`. Note that the values are case sensitive. For example, use `AD\ActiveDirectoryConnectivityServerReboot`, not `ad\activedirectoryconnectivityserverreboot`. ```yaml -Type: Version -Parameter Sets: ApplyVersion +Type: String +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax \\\\[\\\]. Note that the values are case sensitive. For example, use "AD\\ActiveDirectoryConnectivityServerReboot", not "ad\\activedirectoryconnectivityserverreboot". +### -ApplyVersion +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. + +You can't use this parameter with the Duration parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: Version +Parameter Sets: ApplyVersion Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -94,16 +103,15 @@ Accept wildcard characters: False The ItemType parameter specifies the item type for the property that you want to override. Valid values are: - Probe - - Monitor - - Responder ```yaml -Type: Probe | Monitor | Responder | Maintenance +Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -119,6 +127,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -134,6 +143,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -144,8 +154,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -153,6 +162,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,6 +180,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -191,6 +202,7 @@ Type: EnhancedTimeSpan Parameter Sets: Duration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -206,6 +218,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -221,6 +234,7 @@ Type: String Parameter Sets: Duration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -236,6 +250,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -244,20 +259,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/9d5ec0ec-a7bc-4bea-a62e-6252407ed7e8.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md similarity index 81% rename from exchange/exchange-ps/exchange/antispam-antimalware/Add-IPAllowListEntry.md rename to exchange/exchange-ps/exchange/Add-IPAllowListEntry.md index 147f995e06..d987ed4c56 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-IPAllowListEntry @@ -13,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Add-IPAllowListEntry cmdlet to add IP Allow list entries to the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,7 +27,8 @@ Add-IPAllowListEntry -IPAddress [-Confirm] [-ExpirationTime ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### IPRange @@ -34,7 +38,8 @@ Add-IPAllowListEntry -IPRange [-Confirm] [-ExpirationTime ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -43,19 +48,19 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-IPAllowListEntry -IPAddress 192.168.0.100 ``` This example adds the IP address 192.168.0.100 to the list of allowed IP addresses. -### -------------------------- Example 2 -------------------------- -``` -Add-IPAllowListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2013 23:59" +### Example 2 +```powershell +Add-IPAllowListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2014 23:59" ``` -This example adds the IP address range 192.168.0.1/24 to the list of allowed IP addresses and configures the IP Allow list entry to expire at 23:59 on January 3, 2013. +This example adds the IP address range 192.168.0.1/24 to the list of allowed IP addresses and configures the IP Allow list entry to expire at 23:59 on January 3, 2014. ## PARAMETERS @@ -67,6 +72,7 @@ Type: IPAddress Parameter Sets: IPAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -75,17 +81,17 @@ Accept wildcard characters: False ``` ### -IPRange -The IPRange parameter specifies a range of IP addresses to add to the IP Allow list. You can use the following formats: - -- CIDR IP:192.168.0.1/24 +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. +- IP address range: 192.168.0.1-192.168.0.254. +- Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.0.1/24. ```yaml Type: IPRange Parameter Sets: IPRange Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -101,6 +107,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -111,8 +118,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -120,6 +126,7 @@ 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 @@ -130,13 +137,14 @@ Accept wildcard characters: False ### -ExpirationTime The ExpirationTime parameter specifies a day and time when the IP Allow list entry that you're creating will expire. If you specify a time only and you don't specify a date, the current day is assumed. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -148,11 +156,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -164,6 +169,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -179,6 +185,7 @@ 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 @@ -187,20 +194,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8638ed06-b018-479e-85ce-693384f8851e.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Add-IPAllowListProvider.md similarity index 86% rename from exchange/exchange-ps/exchange/antispam-antimalware/Add-IPAllowListProvider.md rename to exchange/exchange-ps/exchange/Add-IPAllowListProvider.md index fe352cc0c4..9b528293bd 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Add-IPAllowListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-IPAllowListProvider @@ -13,14 +16,21 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Add-IPAllowListProvider cmdlet to create IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Add-IPAllowListProvider [-Name] -LookupDomain [-AnyMatch <$true | $false>] - [-BitmaskMatch ] [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-IPAddressesMatch ] [-Priority ] [-WhatIf] [] +Add-IPAllowListProvider [-Name] -LookupDomain + [-AnyMatch ] + [-BitmaskMatch ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IPAddressesMatch ] + [-Priority ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -28,15 +38,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-IPAllowListProvider -Name "Contoso.com Allow List" -LookupDomain allowlist.contoso.com -AnyMatch $true ``` This example adds a new IP Allow list provider and configures connection filtering to treat any IP address status code returned from the IP Allow list provider as a match and allow the connection. You get the value for the LookupDomain parameter from the allow list provider. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Add-IPAllowListProvider -Name "Fabrikam.com Allow List" -LookupDomain allowlist.fabrikam.com -BitmaskMatch 127.1.0.1 ``` @@ -44,31 +54,33 @@ This example adds an IP Allow list provider and configures a bitmask return valu ## PARAMETERS -### -LookupDomain -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. +### -Name +The Name parameter specifies a descriptive name for the IP Allow list provider. ```yaml -Type: SmtpDomain +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a descriptive name for the IP Allow list provider. +### -LookupDomain +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: String +Type: SmtpDomain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -78,10 +90,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -97,6 +110,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -107,8 +121,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -116,6 +129,7 @@ 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 @@ -133,6 +147,7 @@ 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 @@ -144,10 +159,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -163,6 +179,7 @@ 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 @@ -180,6 +197,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -195,6 +213,7 @@ 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 @@ -203,20 +222,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/f4aade29-19ba-434d-8da4-45af0a5ddaff.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md similarity index 81% rename from exchange/exchange-ps/exchange/antispam-antimalware/Add-IPBlockListEntry.md rename to exchange/exchange-ps/exchange/Add-IPBlockListEntry.md index 2fdad13829..35072b31fd 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-IPBlockListEntry @@ -13,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Add-IPBlockListEntry cmdlet to add IP Block list entries to the IP Block list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,7 +27,8 @@ Add-IPBlockListEntry -IPAddress [-Confirm] [-ExpirationTime ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### IPRange @@ -34,7 +38,8 @@ Add-IPBlockListEntry -IPRange [-Confirm] [-ExpirationTime ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -42,19 +47,19 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-IPBlockListEntry -IPAddress 192.168.0.100 ``` This example adds the IP address 192.168.0.100 to the list of blocked IP addresses. -### -------------------------- Example 2 -------------------------- -``` -Add-IPBlockListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2013 23:59" +### Example 2 +```powershell +Add-IPBlockListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2014 23:59" ``` -This example adds the IP address range 192.168.0.1/24 to the list of blocked IP addresses and configures the IP Block list entry to expire at 23:59 on January 3, 2013. +This example adds the IP address range 192.168.0.1/24 to the list of blocked IP addresses and configures the IP Block list entry to expire at 23:59 on January 3, 2014. ## PARAMETERS @@ -66,6 +71,7 @@ Type: IPAddress Parameter Sets: IPAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -74,17 +80,17 @@ Accept wildcard characters: False ``` ### -IPRange -The IPRange parameter specifies a range of IP addresses to add to the IP Block list. You can use the following formats: - -- CIDR IP:192.168.0.1/24 +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. +- IP address range: 192.168.0.1-192.168.0.254. +- Classless Inter-Domain Routing (CIDR) IP address range: 192.168.0.1/24. ```yaml Type: IPRange Parameter Sets: IPRange Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -100,6 +106,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,8 +117,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -119,6 +125,7 @@ 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 @@ -129,13 +136,14 @@ Accept wildcard characters: False ### -ExpirationTime The ExpirationTime parameter specifies a day and time when the IP Block list entry that you're creating will expire. If you specify a time only and you don't specify a date, the current day is assumed. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -147,11 +155,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -163,6 +168,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -178,6 +184,7 @@ 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 @@ -186,20 +193,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/02ff6f8f-3090-46b9-9e58-131239a75ad3.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Add-IPBlockListProvider.md similarity index 87% rename from exchange/exchange-ps/exchange/antispam-antimalware/Add-IPBlockListProvider.md rename to exchange/exchange-ps/exchange/Add-IPBlockListProvider.md index cb01f37c63..29ca57a584 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Add-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Add-IPBlockListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-IPBlockListProvider @@ -13,14 +16,21 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Add-IPBlockListProvider cmdlet to create IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Add-IPBlockListProvider [-Name] -LookupDomain [-AnyMatch <$true | $false>] - [-BitmaskMatch ] [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-IPAddressesMatch ] [-Priority ] [-RejectionResponse ] [-WhatIf] +Add-IPBlockListProvider [-Name] -LookupDomain + [-AnyMatch ] + [-BitmaskMatch ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IPAddressesMatch ] + [-Priority ] + [-RejectionResponse ] + [-WhatIf] [] ``` @@ -29,15 +39,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-IPBlockListProvider -Name "Contoso.com Block List" -LookupDomain blocklist.contoso.com -RejectionResponse "Source IP address is listed at the Contoso.com block list provider" ``` This example adds an IP Block list provider and sets a rejection response. You get the value for the LookupDomain parameter from the block list provider. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Add-IPBlockListProvider -Name "Fabrikam.com Block List" -LookupDomain blocklist.fabrikam.com -BitmaskMatch 127.1.0.1 ``` @@ -45,31 +55,33 @@ This example adds an IP Block list provider and configures a bitmask return valu ## PARAMETERS -### -LookupDomain -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. +### -Name +The Name parameter specifies a descriptive name for the IP Block list provider. ```yaml -Type: SmtpDomain +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a descriptive name for the IP Block list provider. +### -LookupDomain +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: String +Type: SmtpDomain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -79,10 +91,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -98,6 +111,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -108,8 +122,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -117,6 +130,7 @@ 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 @@ -134,6 +148,7 @@ 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 @@ -145,10 +160,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,6 +180,7 @@ 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 @@ -181,6 +198,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -198,6 +216,7 @@ Type: AsciiString Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -213,6 +232,7 @@ 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 @@ -221,20 +241,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b8785a3c-ebab-4a21-aaea-8db4953c458b.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md similarity index 86% rename from exchange/exchange-ps/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md rename to exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md index 6586d0a585..df90710452 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-MailboxDatabaseCopy @@ -13,50 +16,54 @@ This cmdlet is available only in on-premises Exchange. Use the Add-MailboxDatabaseCopy cmdlet to create a passive copy of an existing active mailbox database. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Add-MailboxDatabaseCopy [-Identity] [-MailboxServer] - [-ActivationPreference ] [-Confirm] [-DomainController ] [-ReplayLagTime ] - [-SeedingPostponed] [-TruncationLagTime ] [-WhatIf] [-ConfigurationOnly] - [-ReplayLagMaxDelay ] [] + [-ActivationPreference ] + [-ConfigurationOnly] + [-Confirm] + [-DomainController ] + [-ReplayLagMaxDelay ] + [-ReplayLagTime ] + [-SeedingPostponed] + [-TruncationLagTime ] + [-WhatIf] + [] ``` ## DESCRIPTION To use the Add-MailboxDatabaseCopy cmdlet to add a mailbox database copy, the following criteria must be met: - 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. 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-MailboxDatabaseCopy -Identity DB1 -MailboxServer MBX3 -ReplayLagTime 00:10:00 -TruncationLagTime 00:15:00 -ActivationPreference 2 ``` This example adds a copy of mailbox database DB1 to the Mailbox server MBX3. Replay lag time and truncation lag time are configured with values of 10 minutes and 15 minutes, respectively. The activation preference is configured with a value of 2. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Add-MailboxDatabaseCopy -Identity DB2 -MailboxServer MBX1 -ActivationPreference 3 ``` This example adds a copy of mailbox database DB2 to the Mailbox server MBX1. Replay lag time and truncation lag time are left at the default values of zero, and the activation preference is configured with a value of 3. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Add-MailboxDatabaseCopy -Identity DB3 -MailboxServer MBX4 -ActivationPreference 5 -SeedingPostponed ``` @@ -65,13 +72,18 @@ This example adds a copy of mailbox database DB3 to the Mailbox server MBX4. Rep ## PARAMETERS ### -Identity -The Identity parameter specifies the name of the mailbox database being copied. Database names must be unique within the Exchange organization. +The Identity parameter specifies the mailbox database that's being copied. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -87,6 +99,7 @@ Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 2 Default value: None @@ -102,6 +115,25 @@ Type: UInt32 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 +``` + +### -ConfigurationOnly +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -112,8 +144,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -121,6 +152,7 @@ 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 @@ -136,6 +168,29 @@ 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 +``` + +### -ReplayLagMaxDelay +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. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -155,6 +210,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,6 +226,7 @@ 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 @@ -189,6 +246,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -204,44 +262,7 @@ 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 -``` - -### -ConfigurationOnly -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplayLagMaxDelay -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. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -250,20 +271,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/84198fa9-ac8e-44ea-bd7b-64fe1e83e709.aspx) diff --git a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md new file mode 100644 index 0000000000..bda1bfce49 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md @@ -0,0 +1,308 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Add-MailboxFolderPermission cmdlet to add folder-level permissions for users in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-MailboxFolderPermission [-Identity] -AccessRights -User + [-Confirm] + [-DomainController ] + [-SendNotificationToUser ] + [-SharingPermissionFlags ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Add-MailboxFolderPermission -Identity ayla@contoso.com:\Marketing -User ed@contoso.com -AccessRights Owner +``` + +This example grants the Owner role to Ed on the Marketing folder in Ayla's mailbox. + +### Example 2 +```powershell +Add-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User julia@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate +``` + +In Exchange Online, this example adds Julia as a calendar delegate to Ayla's mailbox, but without access to private items. + +### Example 3 +```powershell +Add-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User laura@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate,CanViewPrivateItems +``` + +In Exchange Online, this example adds Laura as a calendar delegate to Ayla's mailbox with access to private items. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inbox\Reports`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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. + +The following individual permissions are available: + +- None: The user has no access to view or interact with the folder or its contents. +- CreateItems: The user can create items within the specified folder. +- CreateSubfolders: The user can create subfolders in the specified folder. +- DeleteAllItems: The user can delete all items in the specified folder. +- DeleteOwnedItems: The user can only delete items that they created from the specified folder. +- EditAllItems: The user can edit all items in the specified folder. +- EditOwnedItems: The user can only edit items that they created in the specified folder. +- FolderContact: The user is the contact for the specified public folder. +- FolderOwner: The user is the owner of the specified folder. The user can view the folder, move the folder and create subfolders. The user can't read items, edit items, delete items or create items. +- FolderVisible: The user can view the specified folder, but can't read or edit items within the specified public folder. +- ReadItems: The user can read items within the specified folder. + +The roles that are available, along with the permissions that they assign, are described in the following list: + +- Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- Contributor: CreateItems, FolderVisible +- Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- NonEditingAuthor: CreateItems, DeleteOwnedItems, FolderVisible, ReadItems +- Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems +- PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- PublishingEditor: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- Reviewer: FolderVisible, ReadItems + +The following roles apply specifically to calendar folders: + +- AvailabilityOnly: View only availability data +- LimitedDetails: View availability data with subject and location + +When the Editor role is applied to calendar folders, delegates can accept or decline meetings by manually selecting the meeting request in the mailbox. In Exchange Online, to send meeting requests to delegates where they can accept or decline meetings, also use the SharingPermissionFlags parameter with the value Delegate. + +```yaml +Type: MailboxFolderAccessRight[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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 +- Mail users +- Mail-enabled security groups (including nested mail-enabled security groups) + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailboxFolderUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendNotificationToUser +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: + +- $true: A sharing invitation is sent. +- $false: No sharing invitation is sent. This is the default value. + +This parameter only applies to calendar folders and can only be used with the following AccessRights parameter values: + +- AvailabilityOnly +- LimitedDetails +- Reviewer +- Editor + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharingPermissionFlags +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. +- 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. + +**Note**: You can't configure the **Deliver meeting requests addressed to me and responses to meeting requests where I am the organizer to** Outlook setting in PowerShell. But, you can configure the setting using Exchange Web Services (EWS). For more information, see [MeetingRequestsDeliveryScope Enum](https://learn.microsoft.com/dotnet/api/microsoft.exchange.webservices.data.meetingrequestsdeliveryscope). + +```yaml +Type: MailboxFolderPermissionFlags +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) + +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) + +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) + +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Add-MailboxPermission.md b/exchange/exchange-ps/exchange/Add-MailboxPermission.md new file mode 100644 index 0000000000..07ab0e946e --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-MailboxPermission.md @@ -0,0 +1,459 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Add-MailboxPermission cmdlet to add permissions to a mailbox or to an Exchange Server 2016, Exchange Server 2019, or Exchange Online mail user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AccessRights +``` +Add-MailboxPermission [-Identity] -AccessRights -User + [-AutoMapping ] + [-Confirm] + [-Deny] + [-DomainController ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-InheritanceType ] + [-WhatIf] + [] +``` + +### Owner +``` +Add-MailboxPermission [-Identity] -Owner + [-Confirm] + [-DomainController ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +### Instance +``` +Add-MailboxPermission [[-Identity] ] -Instance + [-AccessRights ] + [-User ] + [-AutoMapping ] + [-Confirm] + [-Deny] + [-DomainController ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-InheritanceType ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +> [!NOTE] +> You can use this cmdlet to add a maximum of 500 permission entries (ACEs) to a mailbox. To grant permissions to more than 500 users, use security groups instead of individual users for the User parameter. Security groups contain many members, but only count as one entry. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Add-MailboxPermission -Identity "Terry Adams" -User "Kevin Kelly" -AccessRights FullAccess -InheritanceType All +``` + +This example assigns the user Kevin Kelly Full Access permission to Terry Adams's mailbox. + +### Example 2 +```powershell +Add-MailboxPermission -Identity "Room 222" -Owner "Tony Smith" +``` + +This example sets the user Tony Smith as the owner of the resource mailbox named Room 222. + +### Example 3 +```powershell +Add-MailboxPermission -Identity "Jeroen Cool" -User "Mark Steele" -AccessRights FullAccess -InheritanceType All -AutoMapping $false +``` + +This example assigns the user Mark Steele Full Access permission to Jeroen Cool's mailbox, prevents Outlook from opening Jeroen Cool's mailbox when Mark Steele opens Outlook. + +### Example 4 +```powershell +Get-Mailbox -ResultSize unlimited -Filter "(RecipientTypeDetails -eq 'UserMailbox') -and (Alias -ne 'Admin')" | Add-MailboxPermission -User admin@contoso.com -AccessRights FullAccess -InheritanceType All +``` + +In Exchange Online, this example assigns the administrator account admin@contoso.com Full Access permission to all user mailboxes in the contoso.com organization. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: AccessRights, Owner +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept 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 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +The AccessRights parameter specifies the permission that you want to add for the user on the mailbox. Valid values are: + +- ChangeOwner +- ChangePermission +- DeleteItem +- ExternalAccount +- FullAccess +- ReadPermission + +You can specify multiple values separated by commas. + +You can't use this parameter with the Owner parameter. + +```yaml +Type: MailboxRights[] +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: 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 +``` + +### -Instance +This parameter is available only in on-premises Exchange. + +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Owner +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 +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +The default mailbox owner is NT AUTHORITY\\SELF. + +You can't use this parameter with the AccessRights or User parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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). + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Owner parameter. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SecurityPrincipalIdParameter +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 +``` + +### -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: + +- $true: The mailbox is automatically added to the user's Outlook profile if the user has Full Access permission. This is the default value. +- $false: The mailbox is not automatically added to the user's Outlook profile if the user has Full Access permission. + +**Note**: To disable auto-mapping for a mailbox where the user was already assigned Full Access permission, you need to remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet, and then reassign the user Full Access permission on the mailbox using the AutoMapping parameter with the value $false. + +```yaml +Type: Boolean +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: $true +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Deny +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights, Owner, Instance +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -InheritanceType +The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: + +- None +- All (this is the default value) +- Children +- Descendents [sic] +- SelfAndChildren + +```yaml +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: All +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/role-based-access-control/Add-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md similarity index 79% rename from exchange/exchange-ps/exchange/role-based-access-control/Add-ManagementRoleEntry.md rename to exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md index 74e58d1ea0..6b98323cb7 100644 --- a/exchange/exchange-ps/exchange/role-based-access-control/Add-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-ManagementRoleEntry @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-ManagementRoleEntry cmdlet to add management role entries to an existing management role. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,9 +29,10 @@ Add-ManagementRoleEntry [-Identity] [-Overwrite] [-Parameters ] [-PSSnapinName ] - [-Type ] + [-Type ] [-UnScopedTopLevel] - [-WhatIf] [] + [-WhatIf] + [] ``` ### ParentRoleEntry @@ -38,7 +42,8 @@ Add-ManagementRoleEntry [-ParentRoleEntry] -Role ] [-Force] [-Overwrite] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -46,35 +51,35 @@ The cmdlet and its parameters that you add to a role entry must exist in the par You can only add a role entry to a management role if the role entry exists in the role's parent role. For example, if you try to add the Search-Mailbox role entry to a role that's a child of the Mail Recipients role, you'll receive an error. This error occurs because the Search-Mailbox role entry doesn't exist in the Mail Recipients role. To add the Search-Mailbox role entry to a role, you need to create a role that's a child of the Mailbox Import Export role, which contains the Search-Mailbox role entry. Then you can use the Add-ManagementRoleEntry cmdlet to add the Search-Mailbox role entry to the new child role. -For more information about management role entries, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" ``` This example adds a new role entry for the Get-Mailbox cmdlet to the Recipient Administrators management role. The role entry for the Get-Mailbox cmdlet is added exactly as it's configured in the Recipient Administrators parent role. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter" ``` This example adds a new role entry for the Get-Mailbox cmdlet to the Recipient Administrators role. Only the Identity, Anr, Server and Filter parameters are added to the new role entry. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-ManagementRoleEntry "Mail Recipients\*Mailbox*" | Add-ManagementRoleEntry -Role "Mailbox Administrators" ``` This example uses the Get-ManagementRoleEntry cmdlet to retrieve a list of all the role entries that exist on the Mail Recipients management role that contain the string "Mailbox" in the cmdlet name and then adds them to the Mailbox Administrators role using the Add-ManagementRoleEntry cmdlet. The role entries are added to the child role exactly as they're configured on the parent role. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevel ``` @@ -83,9 +88,9 @@ In on-premises Exchange, this example adds the MailboxAudit script with the Depa ## PARAMETERS ### -Identity -The Identity parameter specifies the role entry to add. You must specify the value of the Identity parameter in the format: \\\\, for example, ExampleRole\\Set-Mailbox. +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://technet.microsoft.com/library/dd298116.aspx). +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). The role entry you want to add must exist in the parent role. If the role entry name contains spaces, you must enclose the name in quotation marks ("). @@ -94,6 +99,7 @@ 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 Default value: None @@ -109,6 +115,7 @@ 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 Default value: None @@ -124,6 +131,7 @@ 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 Default value: None @@ -134,8 +142,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -143,6 +150,7 @@ 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 @@ -160,6 +168,7 @@ 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 @@ -170,13 +179,16 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -185,13 +197,14 @@ Accept wildcard characters: False ``` ### -Overwrite -The Overwrite parameter causes existing role entries to be overwritten by the role entries being added. +The Overwrite switch causes existing role entries to be overwritten by the role entries being added. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (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 @@ -207,6 +220,7 @@ 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 Default value: None @@ -224,6 +238,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -235,10 +250,11 @@ Accept wildcard characters: False The Type parameter specifies the type of role entry being added. The valid values are Cmdlet, Script and ApplicationPermission. ```yaml -Type: Cmdlet | Script | ApplicationPermission | All +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 Default value: None @@ -247,13 +263,13 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. +This parameter is available only in on-premises Exchange. -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). The UnScopedTopLevel switch specifies that you're adding the role entry to an unscoped top-level management role. You don't need to specify a value with this switch. -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role(https://technet.microsoft.com/library/dd876886.aspx). +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). You can't use this switch with the ParentRoleEntry parameter. @@ -262,6 +278,7 @@ Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -277,6 +294,7 @@ 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 @@ -285,20 +303,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/ece406f2-a6d6-4b5d-94f0-2819a7672088.aspx) diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md new file mode 100644 index 0000000000..153ba0c086 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md @@ -0,0 +1,381 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Add-PublicFolderAdministrativePermission + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Add-PublicFolderAdministrativePermission cmdlet to add administrative permissions to a public folder or a public folder hierarchy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Add-PublicFolderAdministrativePermission [-Identity] -AccessRights -User + [-Confirm] + [-Deny] + [-DomainController ] + [-InheritanceType ] + [-Server ] + [-WhatIf] + [] +``` + +### Instance +``` +Add-PublicFolderAdministrativePermission [[-Identity] ] -Instance + [-AccessRights ] + [-User ] + [-Confirm] + [-Deny] + [-DomainController ] + [-InheritanceType ] + [-Server ] + [-WhatIf] + [] +``` + +### Owner +``` +Add-PublicFolderAdministrativePermission [-Identity] -Owner + [-Confirm] + [-DomainController ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Add-PublicFolderAdministrativePermission -User Chris -Identity \MyPublicFolder -AccessRights ViewInformationStore +``` + +This example grants the user Chris the ViewInformationStore permission on the public folder MyPublicFolder. + +### Example 2 +```powershell +Add-PublicFolderAdministrativePermission -User Chris -Identity \MyPublicFolder -AccessRights ViewInformationStore -Deny +``` + +This example denies the user Chris the ViewInformationStore permission. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: Identity, Owner +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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. +- ModifyPublicFolderACL The administrator has the right to modify client access permissions for the specified folder. +- ModifyPublicFolderAdminACL The administrator has the right to modify administrator permissions for the specified public folder. +- ModifyPublicFolderDeletedItemRetention The administrator has the right to modify the Public Folder Deleted Item Retention attributes (RetainDeletedItemsFor and UseDatabaseRetentionDefaults). +- ModifyPublicFolderExpiry The administrator has the right to modify the Public Folder Expiration attributes (AgeLimit and UseDatabaseAgeDefaults). +- ModifyPublicFolderQuotas The administrator has the right to modify the Public Folder Quota attributes (MaxItemSize, PostQuota, PostWarningQuota, and UseDatabaseQuotaDefaults) +- ModifyPublicFolderReplicaList The administrator has the right to modify the replica list attribute for the specified public folder (Replicas). +- AdministerInformationStore The administrator has the right to modify all other public folder properties that aren't defined previously. +- ViewInformationStore The administrator has the right to view public folder properties. +- AllExtendedRights The administrator has the right to modify all public folder properties. + +You can specify multiple values separated by commas. + +You can't use this parameter with the Owner parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +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 +``` + +### -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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Owner +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 +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the AccessRights or User parameters. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: Owner +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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 +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Owner parameter. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Deny +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InheritanceType +The InheritanceType parameter specifies how permissions are inherited. Valid values are: + +- None +- All (this is the default value) +- Children +- Descendents [sic] +- SelfAndChildren + +```yaml +Type: ActiveDirectorySecurityInheritance +Parameter Sets: Identity, Instance +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md new file mode 100644 index 0000000000..059bc10445 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md @@ -0,0 +1,228 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Add-PublicFolderClientPermission cmdlet to add permissions to public folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-PublicFolderClientPermission [-Identity] -AccessRights -User + [-Confirm] + [-DomainController ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Add-PublicFolderClientPermission -Identity "\My Public Folder" -User Chris -AccessRights CreateItems -Server "My Server" +``` + +In Exchange 2010, this example adds permission for the user Chris to create items in the public folder My Public Folder on the server My Server. + +### Example 2 +```powershell +Add-PublicFolderClientPermission -Identity "\My Public Folder" -User Chris -AccessRights CreateItems +``` + +This example adds permission for the user Chris to create items in the public folder My Public Folder. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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. + +The following individual permissions are available: + +- CreateItems: The user has the right to create items within the specified public folder. +- CreateSubfolders: The user has the right to create subfolders in the specified public folder. +- DeleteAllItems: The user has the right to delete all items in the specified public folder. +- DeleteOwnedItems: The user has the right to delete items that the user owns in the specified public folder. +- EditAllItems: The user has the right to edit all items in the specified public folder. +- EditOwnedItems: The user has the right to edit the items that the user owns in the specified public folder. +- FolderContact: The user is the contact for the specified public folder. +- FolderOwner: The user is the owner of the specified public folder. The user has the right to view and move the public folder and create subfolders. The user can't read items, edit items, delete items, or create items. +- FolderVisible: The user can view the specified public folder, but can't read or edit items within the specified public folder. +- ReadItems: The user has the right to read items within the specified public folder. + +In addition to access rights, you can create rights based upon roles, which includes multiple access rights. This parameter accepts the following values for roles: + +- Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- Contributor: CreateItems, FolderVisible +- Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- None: FolderVisible +- NonEditingAuthor: CreateItems, DeleteOwnedItems, FolderVisible, ReadItems +- Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems +- PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- PublishingEditor: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- Reviewer: FolderVisible, ReadItems + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the user for whom rights are being added. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +```yaml +Type: PublicFolderUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Add-RecipientPermission.md b/exchange/exchange-ps/exchange/Add-RecipientPermission.md new file mode 100644 index 0000000000..06dfc9280a --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-RecipientPermission.md @@ -0,0 +1,180 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Add-RecipientPermission + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Add-RecipientPermission cmdlet to add SendAs permission to users in a cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-RecipientPermission [-Identity] -AccessRights -Trustee + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +SendAs permission allows a user or group members to send messages that appear to come from the specified mailbox, mail contact, mail user, or group. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Add-RecipientPermission "Help Desk" -AccessRights SendAs -Trustee "Ayla Kol" +``` + +This example gives the user Ayla Kol SendAs permission for the mailbox Help Desk. Ayla can send messages that appear to come directly from the Help Desk mailbox. + +## PARAMETERS + +### -Identity +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: + +- Mailboxes +- Mail users +- External contacts +- Distribution groups +- Dynamic distribution groups + +You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Trustee +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 +- Mail users with a Microsoft account +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/mail-flow/Add-ResubmitRequest.md b/exchange/exchange-ps/exchange/Add-ResubmitRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/mail-flow/Add-ResubmitRequest.md rename to exchange/exchange-ps/exchange/Add-ResubmitRequest.md index c65eb724ba..d1801a114d 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Add-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Add-ResubmitRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-ResubmitRequest @@ -13,39 +16,46 @@ This cmdlet is available only in on-premises Exchange. Use the Add-ResubmitRequest cmdlet to add requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### MDBResubmit ``` -Add-ResubmitRequest -EndTime -StartTime [-Destination ] +Add-ResubmitRequest -EndTime -StartTime + [-Destination ] [-Confirm] [-CorrelationId ] [-Server ] - [-TestOnly <$true | $false>] + [-TestOnly ] [-UnresponsivePrimaryServers ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### ConditionalResubmit ``` -Add-ResubmitRequest -EndTime -StartTime [-MessageId ] [-Recipient ] [-ResubmitTo ] [-Sender ] +Add-ResubmitRequest -EndTime -StartTime + [-MessageId ] + [-Recipient ] + [-ResubmitTo ] + [-Sender ] [-Confirm] [-CorrelationId ] [-Server ] - [-TestOnly <$true | $false>] + [-TestOnly ] [-UnresponsivePrimaryServers ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-ResubmitRequest -Destination 5364aeea-6e6b-4055-8258-229b2c6ac9a2 -StartTime "06/01/2018 6:00 PM" -EndTime "06/02/2018 5:00 AM" ``` @@ -56,7 +66,7 @@ This example replays the redundant copies of messages delivered from 6:00 PM Jun ### -EndTime The EndTime parameter specifies the delivery time of the latest messages that need to be resubmitted from Safety Net. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The date and time specified by the EndTime parameter must be later than the date and time specified by the StartTime parameter. The date and time specified by both parameters must be in the past. @@ -65,6 +75,7 @@ Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -75,7 +86,7 @@ Accept wildcard characters: False ### -StartTime The StartTime parameter specifies the delivery time of the oldest messages that need to be resubmitted from Safety Net. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The date and time specified by the StartTime parameter must be earlier than the date and time specified by the EndTime parameter. The date and time specified by both parameters must be in the past. @@ -84,6 +95,7 @@ Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -94,8 +106,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -103,6 +114,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,6 +130,7 @@ Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -126,7 +139,7 @@ Accept wildcard characters: False ``` ### -Destination -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. +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. @@ -135,6 +148,7 @@ Type: Guid Parameter Sets: MDBResubmit Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,13 +157,14 @@ 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. This may include angle brackets. +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: ConditionalResubmit Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -167,6 +182,7 @@ Type: String Parameter Sets: ConditionalResubmit Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -182,6 +198,7 @@ Type: String Parameter Sets: ConditionalResubmit Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -199,6 +216,7 @@ Type: String Parameter Sets: ConditionalResubmit Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -210,11 +228,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -224,6 +239,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -235,10 +251,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -254,6 +271,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -269,6 +287,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -277,20 +296,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7d6f8a28-2f23-4139-b44f-2a6d57ee912a.aspx) diff --git a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md new file mode 100644 index 0000000000..5f64ff5636 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md @@ -0,0 +1,216 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Add-RoleGroupMember cmdlet to add members to a management role group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-RoleGroupMember [-Identity] -Member + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you add a member to a role group, the member is given the effective permissions provided by the management roles assigned to the role group. + +If the ManagedBy property has been populated with role group managers, the user adding a role group member 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. + +In on-premises Exchange, if the role group is a linked role group, you can't use the Add-RoleGroupMember cmdlet to add members to the role group. Instead, you need to add members to the foreign universal security group (USG) that's linked to the linked role group. To find the foreign USG that's linked to a role group, use the Get-RoleGroup cmdlet. + +For more information about role groups, see [Understanding management role groups](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Add-RoleGroupMember "Recipient Management" -Member David +``` + +This example adds the user David to the role group Recipient Management. + +### Example 2 +```powershell +Get-User -Filter "Department -eq 'Sales' -and RecipientType -eq 'UserMailbox'" | Get-Mailbox | Add-RoleGroupMember "Sales and Marketing Group" -WhatIf +``` + +This example finds all the mailboxes that are part of the Sales department and adds them to the Sales and Marketing Group role group. Because we're using the WhatIf switch, the changes aren't written to the role group, so you can verify that the correct members will be added. + +After you've verified that the correct members will be added to the role group, remove the WhatIf switch and run the command again. + +For more information about pipelining and the WhatIf parameter, see the following topics: + +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [WhatIf, Confirm and ValidateOnly switches](https://learn.microsoft.com/exchange/whatif-confirm-and-validateonly-switches-exchange-2013-help) + +### Example 3 +```powershell +Add-RoleGroupMember "Training Administrators" -Member "Training Assistants" -BypassSecurityGroupManagerCheck +``` + +This example adds the Training Assistants USG to the Training Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Member +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 +- Mail users +- Mail-enabled security groups +- Security groups (on-premises Exchange only) + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +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 +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/server-health-and-performance/Add-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md similarity index 77% rename from exchange/exchange-ps/exchange/server-health-and-performance/Add-ServerMonitoringOverride.md rename to exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md index 5f36d332d2..97858e26e8 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Add-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Add-ServerMonitoringOverride @@ -13,31 +16,34 @@ This cmdlet is available only in on-premises Exchange. Use the Add-ServerMonitoringOverride cmdlet to override the thresholds and parameters of managed availability probes, monitors, and responders on Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ApplyVersion ``` -Add-ServerMonitoringOverride [-Identity] -ApplyVersion -ItemType -PropertyName -PropertyValue -Server +Add-ServerMonitoringOverride [-Identity] -ApplyVersion -ItemType -PropertyName -PropertyValue -Server [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Duration ``` -Add-ServerMonitoringOverride [-Identity] -ItemType -PropertyName -PropertyValue -Server [-Duration ] +Add-ServerMonitoringOverride [-Identity] -ItemType -PropertyName -PropertyValue -Server + [-Duration ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Add-ServerMonitoringOverride -Identity "AD\ActiveDirectoryConnectivityConfigDCServerReboot" -Server EXCH03 -ItemType Responder -PropertyName Enabled -PropertyValue 0 -Duration 20.00:00:00 ``` @@ -45,37 +51,39 @@ This example adds a server monitoring override that disables the responder Activ ## PARAMETERS -### -ApplyVersion -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. +### -Identity +The Identity parameter specifies the identity of the monitoring item that you want to override. This parameter uses the syntax `HealthSet\MonitoringItemName[\TargetResource]`. Note that the values are case sensitive. For example, use `AD\ActiveDirectoryConnectivityConfigDCServerReboot`, not `ad\activedirectoryconnectivityconfigdcserverreboot`. -You can't use this parameter with the Duration parameter. +You can use Get-ServerHealth to find the correct object for the monitoring item you want to override. ```yaml -Type: Version -Parameter Sets: ApplyVersion +Type: String +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity of the monitoring item that you want to override. This parameter uses the syntax \\\\[\\\]. Note that the values are case sensitive. For example, use "AD\\ActiveDirectoryConnectivityConfigDCServerReboot", not "ad\\activedirectoryconnectivityconfigdcserverreboot". +### -ApplyVersion +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. -You can use Get-ServerHealth to find the correct object for the monitoring item you want to override. +Valid input for this parameter is an Exchange version number in the format 15.01.xxxx.xxx. + +You can't use this parameter with the Duration parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: Version +Parameter Sets: ApplyVersion Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -85,16 +93,15 @@ Accept wildcard characters: False The ItemType parameter specifies the server item type for the property that you want to override. Valid value are: - Probe - - Monitor - - Responder ```yaml -Type: Probe | Monitor | Responder | Maintenance +Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -110,6 +117,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -125,6 +133,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -136,11 +145,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN You can't use this parameter to configure other Edge Transport servers remotely. @@ -150,6 +156,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -160,8 +167,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -169,6 +175,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -190,6 +197,7 @@ Type: EnhancedTimeSpan Parameter Sets: Duration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -205,6 +213,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -213,20 +222,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/350eb7e0-3181-4de9-9934-6c8467b920c3.aspx) diff --git a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md new file mode 100644 index 0000000000..e58e810aba --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md @@ -0,0 +1,184 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Add-UnifiedGroupLinks + +## SYNOPSIS +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). +> +> 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). + +## SYNTAX + +``` +Add-UnifiedGroupLinks [-Identity] -Links -LinkType + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +**Note**: Only members can be owners of a group, so you must first add a user as member before adding it as an owner. Guest users cannot be an owner of groups, even if the users are members of the groups. + +## EXAMPLES + +### Example 1 +```powershell +Add-UnifiedGroupLinks -Identity "Legal Department" -LinkType Members -Links chris@contoso.com,michelle@contoso.com +``` + +This example adds members `chris@contoso.com` and `michelle@contoso.com` to the Microsoft 365 Group named Legal Department. + +### Example 2 +```powershell +$users= Get-User -ResultSize unlimited | where {$_.Department -eq "Marketing" -AND $_.RecipientType -eq "UserMailbox"} + +Add-UnifiedGroupLinks -Identity Marketing -LinkType members -Links ($users.UserPrincipalName) +``` + +This example shows how to add bulk members to a Microsoft 365 Group. Mailboxes where the Department attribute is "Marketing" are added to Microsoft 365 Group named Marketing. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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. + +You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkType +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: 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 Links 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..340921a576 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -0,0 +1,344 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivamodulefeaturepolicy +applicable: Exchange Online +title: Add-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. + +- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant. +- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. +- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. + +Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX +``` +Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureEnabled -ModuleId -Name + [-Confirm] + [-Everyone] + [-GroupIds ] + [-IsUserControlEnabled ] + [-IsUserOptedInByDefault ] + [-ResultSize ] + [-UserIds ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureEnabled $false -Everyone +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the organization. + +### Example 2 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the specified groups. + +### Example 3 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureEnabled $false -UserIds user1@contoso.com,user2@contoso.com +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users. + +### Example 4 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com,user2@contoso.com +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users and group members. + +### Example 5 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -Name SoftDisableShowAISkillsPolicy -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false -UserIds user1@contoso.com,user2@contoso.com +``` + +This example adds a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the specified users, allows user controls, and opted out users by default (Soft Disable policy). + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. + +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are: + +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module that you want to add the feature policy for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +Valid characters are English letters, numbers, commas, periods, and spaces. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Everyone +The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch. + +Don't use this switch with the GroupIds or UserIds parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupIds +The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both [Mail-enabled and non-mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the policy apply to all users in the organization, use the Everyone switch. + +**Note**: In v3.5.1-Preview2 or later of the module, this parameter supports security group object IDs (GUIDs). Previous versions of the module accept only email addresses for this parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserControlEnabled +This parameter is available in version 3.3.0 or later of the module. + +The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: + +- $true: User control is enabled by the policy. Users can opt out of the feature. +- $false: User control isn't enabled by the policy. Users can't opt of the feature. + +Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserOptedInByDefault +This parameter is available in version 3.8.0-Preview2 or later of the module. + +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: + +- $true: By default, users are opted in by the policy if the user hasn't set a preference. +- $false: By default, users are opted out by the policy if the user hasn't set a preference. + +This parameter is optional and can be used to override the default user opt-in value set in the feature metadata. + +This parameter can be set only when the IsUserControlEnabled parameter is set to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the policy apply to all users in the organization, use the Everyone switch. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..0bd5527745 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivaorginsightsdelegatedrole +title: Add-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegate) so they can view organizational insights like the leader (the delegator). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-VivaOrgInsightsDelegatedRole -Delegate -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Add-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example adds the organization insights viewing capability of the specified delegator account to the specified delegate account. + +## PARAMETERS + +### -Delegate +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). + +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegator +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. + +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md new file mode 100644 index 0000000000..ddb6eb30ff --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Add-eDiscoveryCaseAdmin + +## 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 Add-eDiscoveryCaseAdmin cmdlet to add an eDiscovery Administrator in the Microsoft Purview compliance portal. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-eDiscoveryCaseAdmin -User + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +Add-eDiscoveryCaseAdmin -User michelle@contoso.com +``` + +This example adds an eDiscovery Administrator. + +## PARAMETERS + +### -User +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```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 +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md b/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md similarity index 79% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md rename to exchange/exchange-ps/exchange/Clean-MailboxDatabase.md index 4b58eab239..9e3829eb4e 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Clean-MailboxDatabase @@ -13,12 +16,15 @@ This cmdlet is available only in Exchange Server 2010. Use the Clean-MailboxDatabase cmdlet to scan Active Directory for disconnected mailboxes that aren't yet marked as disconnected in the Microsoft Exchange store and update the status of those mailboxes in the Exchange store. This cmdlet isn't able to update the Exchange store unless the Microsoft Exchange Information Store service is running and the database is mounted. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Clean-MailboxDatabase [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Clean-MailboxDatabase [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` @@ -29,12 +35,12 @@ If you want to reconnect a disconnected mailbox to an Active Directory user acco Under normal circumstances, it isn't necessary to run the Clean-MailboxDatabase cmdlet because a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. If you used the Disable-Mailbox cmdlet or the Remove-Mailbox cmdlet while the Microsoft Exchange Information Store service was stopped, or if a mailbox was disabled by an external means other than the Disable-Mailbox cmdlet or Remove-Mailbox cmdlet, you may want to use the Clean-MailboxDatabase cmdlet to scan for disconnected mailboxes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Clean-MailboxDatabase MBD01 ``` @@ -43,19 +49,18 @@ This example cleans the mailbox database MBD01. ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox database that you want to update. You can use one of the following values: - -- GUID +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 - Distinguished name (DN) - -- Name of the mailbox database +- GUID ```yaml Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -66,8 +71,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -75,6 +79,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -92,6 +97,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -107,6 +113,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -115,20 +122,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a68d31b6-4f32-4a73-b9d9-5d5a6fc1c2f0.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md similarity index 75% rename from exchange/exchange-ps/exchange/devices/Clear-ActiveSyncDevice.md rename to exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md index ef4f31cd1d..f729195ad5 100644 --- a/exchange/exchange-ps/exchange/devices/Clear-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Clear-ActiveSyncDevice @@ -13,15 +16,20 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Clear-ActiveSyncDevice cmdlet to delete all data from a mobile device. -Note: In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice. +**Note**: In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Clear-ActiveSyncDevice [-Identity] [-Cancel] [-Confirm] - [-DomainController ] [-NotificationEmailAddresses ] [-WhatIf] [] +Clear-ActiveSyncDevice [-Identity] + [-Cancel] + [-Confirm] + [-DomainController ] + [-NotificationEmailAddresses ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,26 +37,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Clear-ActiveSyncDevice -Identity WM_JeffHay ``` This example clears all data from the mobile device with the identity WM\_JeffHay. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Clear-ActiveSyncDevice -Identity WM_TonySmith -NotificationEmailAddresses "tony@contoso.com" ``` This example clears all data from the mobile device for Tony Smith and sends a confirmation email message to tony@contoso.com. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Clear-ActiveSyncDevice -Identity WM_TonySmith -Cancel $true ``` @@ -64,6 +72,7 @@ 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 Default value: None @@ -72,13 +81,14 @@ Accept wildcard characters: False ``` ### -Cancel -The Cancel switch specifies whether the command should be canceled. If you use the Cancel switch, a cancellation request is issued for the remote device wipe. +The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter 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 @@ -89,15 +99,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -115,6 +127,7 @@ 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 @@ -123,13 +136,14 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses -The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. +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 Default value: None @@ -145,6 +159,7 @@ 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 Default value: None @@ -153,20 +168,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/016768f2-98b3-4f71-b15a-830285a6feac.aspx) diff --git a/exchange/exchange-ps/exchange/Clear-MobileDevice.md b/exchange/exchange-ps/exchange/Clear-MobileDevice.md new file mode 100644 index 0000000000..9a5eda7425 --- /dev/null +++ b/exchange/exchange-ps/exchange/Clear-MobileDevice.md @@ -0,0 +1,206 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Clear-MobileDevice cmdlet to delete all data from a mobile phone. This action is often called a remote device wipe. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Clear-MobileDevice [-Identity] + [-AccountOnly] + [-Cancel] + [-Confirm] + [-DomainController ] + [-NotificationEmailAddresses ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Clear-MobileDevice cmdlet deletes all user data from a mobile device the next time that the device receives data from the Microsoft Exchange server. This cmdlet sets the DeviceWipeStatus parameter to $true. The mobile device acknowledges the cmdlet and records the time stamp in the DeviceWipeAckTime parameter. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Clear-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac +``` + +This example clears all data from the specified mobile device. + +### Example 2 +```powershell +Clear-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac -NotificationEmailAddresses "chris@contoso.com" +``` + +This example clears all data from the specified mobile device and sends a confirmation email message to chris@contoso.com. + +### Example 3 +```powershell +Clear-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac -Cancel +``` + +This example cancels a previously sent Clear-MobileDevice command request for the specified mobile device. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mobile device that you want to reset. You can use the following values that uniquely identifies the mobile device: + +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) + +```yaml +Type: MobileDeviceIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccountOnly +The AccountOnly switch specifies whether to perform an account-only remote device wipe where only Exchange mailbox data is removed from the device. You don't need to specify a value with this switch. + +You don't need to use this switch for the DeviceType value Outlook, because an account-only remote device wipe is the only type of wipe that's used on Outlook devices. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cancel +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailAddresses +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Clear-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md new file mode 100644 index 0000000000..0cfbdb03d1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md @@ -0,0 +1,164 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +The Clear-TextMessagingAccount cmdlet allows a user to remove the text messaging settings from their own mailbox. An administrator can't use this cmdlet to remove the text messaging settings from another user's mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Clear-TextMessagingAccount [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Clear-TextMessagingAccount -Identity tony@contoso.com +``` + +This example clears the text messaging account settings and notification settings from Tony's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the target mailbox. You can any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Compare-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md new file mode 100644 index 0000000000..c536c48908 --- /dev/null +++ b/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md @@ -0,0 +1,174 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Compare-TextMessagingVerificationCode cmdlet to verify the text messaging verification code that the user specified as part of configuring text message notifications on the mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Compare-TextMessagingVerificationCode [[-Identity] ] -VerificationCode + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Compare-TextMessagingVerificationCode cmdlet returns the value true if the code matches the stored code that was generated by the Send-TextMessagingVerificationCode cmdlet. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Compare-TextMessagingVerificationCode -Identity TonySmith -VerificationCode 111555 +``` + +This example compares the verification code 111555 to the code sent to Tony Smith's mobile phone. + +### Example 2 +```powershell +Compare-TextMessagingVerificationCode -Identity tony@contoso.com -VerificationCode 123456 +``` + +This example compares the verification code 123456 to the code sent to Tony Smith's mobile phone. + +### Example 3 +```powershell +Compare-TextMessagingVerificationCode -Identity TonySmith -VerificationCode 111555 -Confirm $true +``` + +This example compares the verification code 111555 to the code sent to Tony Smith's mobile phone after confirmation is given. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -VerificationCode +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/move-and-migration/Complete-MigrationBatch.md b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md similarity index 76% rename from exchange/exchange-ps/exchange/move-and-migration/Complete-MigrationBatch.md rename to exchange/exchange-ps/exchange/Complete-MigrationBatch.md index 5f9979b214..922eeca5b8 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Complete-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Complete-MigrationBatch @@ -13,13 +16,19 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Complete-MigrationBatch cmdlet to finalize a migration batch for a local move, cross-forest move, or remote move migration that has successfully finished initial synchronization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Complete-MigrationBatch [[-Identity] ] [-Confirm] [-DomainController ] - [-NotificationEmails ] [-WhatIf] [-Partition ] [-SyncAndComplete] +Complete-MigrationBatch [[-Identity] ] + [-CompletePublicFolderMigrationWithDataLoss] + [-Confirm] + [-DomainController ] + [-NotificationEmails ] + [-Partition ] + [-SyncAndComplete] + [-WhatIf] [] ``` @@ -27,23 +36,21 @@ Complete-MigrationBatch [[-Identity] ] [-Confirm] [-D After a migration batch for a local or cross-forest move has successfully run and has a status state of Synced, use the Complete-MigrationBatch cmdlet to finalize the migration batch. Finalization is the last phase performed during a local or cross-forest move. When you finalize a migration batch, the cmdlet does the following for each mailbox in the migration batch: - Runs a final incremental synchronization. - - Configures the user's Microsoft Outlook profile to point to the new target domain. - - Converts the source mailbox to a mail-enabled user in the source domain. -In the cloud-based service, this cmdlet sets the value of CompleteAfter to the current time. It is important to remember that any CompleteAfter setting that has been applied to the individual users within the batch will override the setting on the batch, so the completion for some users may be delayed until their configured time. +In the cloud-based service, this cmdlet sets the value of CompleteAfter to the current time. It is important to remember that any CompleteAfter setting that has been applied to the individual users within the batch will override the setting on the batch, so the completion for some users may be delayed until their configured time. When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet. If a migration batch has a status of Completed with Errors, you can re-attempt to finalize the failed users. In Exchange Online, use the Start-MigrationBatch cmdlet to retry migration for failed users. In Exchange 2013 or Exchange 2016, use the Complete-MigrationBatch to retry these failed users. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Complete-MigrationBatch -Identity LocalMove1 -NotificationEmails admin@contoso.com,lucio@contoso.com ``` @@ -51,18 +58,54 @@ This example completes the migration batch LocalMove1 and sends a notification e ## PARAMETERS +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CompletePublicFolderMigrationWithDataLoss +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -80,6 +123,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -87,21 +131,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -NotificationEmails This parameter is available only in on-premises Exchange. @@ -114,6 +143,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -121,14 +151,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: MailboxIdParameter Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -136,14 +169,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Partition -This parameter is reserved for internal Microsoft use. +### -SyncAndComplete +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: MailboxIdParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -151,14 +185,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncAndComplete -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. +### -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: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -167,20 +202,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/572077f0-5457-48ad-b78a-7bd945997300.aspx) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md new file mode 100644 index 0000000000..96f0891ba3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -0,0 +1,857 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Connect-ExchangeOnline + +## 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). + +To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Connect-ExchangeOnline + [[-ConnectionUri] ] + [[-AzureADAuthorizationEndpointUri] ] + [[-ExchangeEnvironmentName] ] + [[-PSSessionOption] ] + [[-DelegatedOrganization] ] + [[-Prefix] ] + [[-CommandName] ] + [[-FormatTypeName] ] + [-AccessToken ] + [-AppId ] + [-BypassMailboxAnchoring] + [-Certificate ] + [-CertificateFilePath ] + [-CertificatePassword ] + [-CertificateThumbprint ] + [-Credential ] + [-Device] + [-DisableWAM] + [-EnableErrorReporting] + [-InlineCredential] + [-LoadCmdletHelp] + [-LogDirectoryPath ] + [-LogLevel ] + [-ManagedIdentity] + [-ManagedIdentityAccountId ] + [-Organization ] + [-PageSize ] + [-ShowBanner] + [-ShowProgress ] + [-SigningCertificate ] + [-SkipLoadingCmdletHelp] + [-SkipLoadingFormatData] + [-TrackPerformance ] + [-UseMultithreading ] + [-UserPrincipalName ] + [-UseRPSSession] + [] +``` + +## DESCRIPTION +This cmdlet creates a PowerShell connection to your Exchange Online organization. + +Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. + +## EXAMPLES + +### Example 1 +```powershell +Connect-ExchangeOnline -UserPrincipalName chris@contoso.com +``` + +This example connects to Exchange Online PowerShell using modern authentication, with or without multi-factor authentication (MFA). The connection uses REST API mode and doesn't require Basic authentication to be enabled in WinRM on the local computer. + +### Example 2 +```powershell +Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" +``` + +This example connects to Exchange Online PowerShell in an unattended scripting scenario using a certificate thumbprint. + +### Example 3 +```powershell +Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" +``` + +This example connects to Exchange Online PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. + +### Example 4 +```powershell +Connect-ExchangeOnline -Device +``` + +In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this example connects to Exchange Online PowerShell in interactive scripting scenarios on computers that don't have web browsers. + +The command returns a URL and unique code that's tied to the session. You need to open the URL in a browser on any computer, and then enter the unique code. After you complete the login in the web browser, the session in the Powershell 7 window is authenticated via the regular Microsoft Entra authentication flow, and the Exchange Online cmdlets are imported after few seconds. + +### Example 6 +```powershell +Connect-ExchangeOnline -InlineCredential +``` + +In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this example connects to Exchange Online PowerShell in interactive scripting scenarios by passing credentials directly in the PowerShell window. + +## PARAMETERS + +### -ConnectionUri +**Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. + +The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following Exchange Online PowerShell environments and related values are supported: + +- Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://outlook.office365.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. +- Office 365 Germany: `https://outlook.office.de/PowerShell-LiveID` +- Office 365 operated by 21Vianet: `https://partner.outlook.cn/PowerShell` +- Microsoft 365 GCC High: `https://outlook.office365.us/powershell-liveID` +- Microsoft 365 DoD: `https://webmail.apps.mil/powershell-liveID` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureADAuthorizationEndpointUri +**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: + +- Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. +- Office 365 Germany: `https://login.microsoftonline.de/common` +- Microsoft 365 GCC High or Microsoft 365 DoD: `https://login.microsoftonline.us/common` + +If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). + +**Note**: MFA authentication or federated authentication isn't available in Office 365 operated by 21Vianet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeEnvironmentName +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. +- Office 365 Germany: `O365GermanyCloud` +- Office 365 operated by 21Vianet: `O365China` +- Microsoft 365 GCC High: `O365USGovGCCHigh` +- Microsoft 365 DoD: `O365USGovDoD` + +```yaml +Type: ExchangeEnvironment +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: O365Default +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSSessionOption +**Note**: This parameter doesn't work in REST API connections. + +The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. This parameter works only if you also use the UseRPSSession switch in the same command. + +Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable (for example, `$PSOptions = New-PSSessionOption `), and use the variable name as the value for this parameter (for example, `$PSOptions`). + +```yaml +Type: PSSessionOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedOrganization +The DelegatedOrganization parameter specifies the customer organization that you want to manage. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the customer organization. + +This parameter works only if the customer organization has agreed to your delegated management via the CSP program. + +After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +The Prefix parameter specifies a text value to add to the names of Exchange Online PowerShell cmdlets when you connect. For example, Get-InboundConnector becomes Get-ContosoInboundConnector when you use the value Contoso for this parameter. + +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Exchange Online cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatTypeName +The FormatTypeName parameter specifies the output format of the cmdlet. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessToken +**Note**: This parameter is available in version 3.1.0 or later of the module. + +The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Exchange Online. + +Depending on the type of access token, you need to use this parameter with the Organization, DelegatedOrganization, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppId +The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. + +For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassMailboxAnchoring +The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Certificate +The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. + +Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: X509Certificate2 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFilePath +The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. + +Don't use this parameter with the Certificate or CertificateThumbprint parameters. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. + +Don't use this parameter with the Certificate or CertificateFilePath parameters. + +**Note**: The CertificateThumbprint parameter is supported only in Microsoft Windows. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). + +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. + +After the Connect-ExchangeOnline command is complete, the password key in the variable is emptied. + +To specify the password for a certificate file, don't use this parameter; use the CertificatePassword parameter instead. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Device +**Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. + +The Device switch is typically used on computers without web browsers. You don't need to specify a value with this switch. + +Using this switch results in an on-screen message that contains the URL and a unique code. On any other device with a web browser and internet access, open the URL, enter the unique code, and enter your credentials in the subsequent pages. + +If your login was successful, the PowerShell connection continues. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableWAM +**Note**: This parameter is available in version 3.7.2-Preview1 or later of the module. + +The DisableWAM switch disables Web Account Manager (WAM). You don't need to specify a value with this switch. + +Starting in version 3.7.0, WAM is enabled by default when connecting to Exchange Online. If you encounter WAM-related issues during sign in, you can use this switch to disable WAM. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableErrorReporting +The EnableErrorReporting switch specifies whether to enable error reporting. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InlineCredential +**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. + +This switch is similar to the Credential parameter, but with added security. The InlineCredential switch doesn't require you to store the credentials locally in the script, and you can enter credentials directly in an interactive PowerShell session. + +This switch does not work with accounts that use MFA. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadCmdletHelp +**Note**: This parameter is available in version 3.7.0-Preview1 or later of the module. + +The LoadCmdletHelp switch downloads cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. + +Starting in v3.7.0-Preview1, help files for the command line aren't downloaded by default. Use this switch to download the files for cmdlet help at the command line. + +**Tip**: This parameter replaces the SkipLoadingCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer works, because cmdlet help files are no longer downloaded by default. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogDirectoryPath +The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`. + +If you specify a custom location and filename that contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentity +The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. + +Managed identity connections are currently supported for the following types of Azure resources: + +- Azure Automation runbooks +- Azure Virtual Machines +- Azure Virtual Machine Scale Sets +- Azure Functions + +You must use this switch with the Organization parameter. + +For user-assigned managed identity, you must also use this switch with the ManagedIdentityAccountId parameter. + +For more information about connecting with managed identity, see [Use Azure managed identities to connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-exo-powershell-managed-identity). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityAccountId +The ManagedIdentityAccountId parameter specifies the user-assigned managed identity that you're using to connect. A valid value for this parameter is the application ID (GUID) of the service principal that corresponds to the user-assigned managed identity in Azure. + +You must use this parameter with the Organization parameter and the ManagedIdentity switch. + +For more information about connecting with managed identity, see [Use Azure managed identities to connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-exo-powershell-managed-identity). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +The Organization parameter specifies the organization when you connect using CBA or managed identity. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the organization. + +For more information about connecting with CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +For more information about connecting with managed identity, see [Use Azure managed identities to connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-exo-powershell-managed-identity). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 1000. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowBanner +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). +- To hide the banner, use this exact syntax: `-ShowBanner:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: $true +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowProgress +The ShowProgress parameter specifies whether to show or hide the progress bar of imported cmdlets when you connect. Valid values are: + +- $true: The progress bar is displayed. This is the default value. +- $false: Currently, this value has no effect. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SigningCertificate +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The SigningCertificate parameter specifies the client certificate that's used to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates. + +A valid value for this parameter is a variable that contains the certificate, or a command or expression that gets the certificate. + +To find the certificate, use the Get-PfxCertificate cmdlet in the Microsoft.PowerShell.Security module or use the Get-ChildItem cmdlet in the certificate (Cert:) drive. If the certificate isn't valid or doesn't have sufficient authority, the command will fail. + +```yaml +Type: X509Certificate2 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipLoadingCmdletHelp +**Note**: This parameter is available in version 3.3.0 or later of the module. + +In version 3.7.0-Preview1 or later, this parameter is replaced by the LoadCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer does anything, because cmdlet help files are no longer downloaded by default. Eventually, this parameter will be retired, so remove it from any scripts. + +The SkipLoadingCmdletHelp switch prevents downloading the cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. + +When you use this switch, you don't get local help files for any cmdlet at the command line. + +This switch doesn't work with the UseRPSSession switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipLoadingFormatData +The SkipLoadingFormatData switch prevents downloading the format data for REST API connections. You don't need to specify a value with this switch. + +When you use this switch, the output of any Exchange cmdlet will be unformatted. + +Use this switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service or the Windows PowerShell SDK. + +This switch doesn't work with the UseRPSSession switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrackPerformance +The TrackPerformance parameter measures additional events (for example, CPU load and memory consumed). Valid values are: + +- $true: Performance tracking is enabled. +- $false: Performance tracking is disabled. This is the default value. + +This parameter works only when logging is enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMultithreading +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The UserPrincipalName parameter specifies the account that you want to use to connect (for example, `navin@contoso.onmicrosoft.com`). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password). + +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). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseRPSSession +**Note**: Remote PowerShell connections to Exchange Online PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). + +The UseRPSSession switch allows you to connect to Exchange Online PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch. + +This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). + +If you don't use this switch, REST API mode is used for the connection, so Basic authentication in WinRM isn't required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md new file mode 100644 index 0000000000..a260cad194 --- /dev/null +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -0,0 +1,453 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Connect-IPPSSession + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. + +**Note**: Version 3.2.0 or later of the module supports REST API mode for virtually all Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Connect-IPPSSession + [[-ConnectionUri] ] + [[-AzureADAuthorizationEndpointUri] ] + [[-DelegatedOrganization] ] + [[-PSSessionOption] ] + [[-Prefix] ] + [[-CommandName] ] + [[-FormatTypeName] ] + [-AccessToken ] + [-AppId ] + [-BypassMailboxAnchoring] + [-Certificate ] + [-CertificateFilePath ] + [-CertificatePassword ] + [-CertificateThumbprint ] + [-Credential ] + [-Organization ] + [-UserPrincipalName ] + [-UseRPSSession] + [] +``` + +## DESCRIPTION +For detailed connection instructions, including prerequisites, see [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell). + +## EXAMPLES + +### Example 1 +```powershell +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com +``` + +This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0 or later of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer. + +### Example 2 +```powershell +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession +``` + +This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0 or later of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer. + +### Example 3 +```powershell +Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" +``` + +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. + +### Example 4 +```powershell +Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" +``` + +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. + +## PARAMETERS + +### -ConnectionUri +The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following PowerShell environments and related values are supported: + +- Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://ps.compliance.protection.outlook.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. +- Security & Compliance PowerShell in Office 365 operated by 21Vianet: `https://ps.compliance.protection.partner.outlook.cn/powershell-liveid` +- Security & Compliance PowerShell in Microsoft GCC High: `https://ps.compliance.protection.office365.us/powershell-liveid/` +- Security & Compliance PowerShell in Microsoft DoD: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureADAuthorizationEndpointUri +The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following PowerShell environments and related values are supported: + +- Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. +- Security & Compliance PowerShell in Office 365 operated by 21Vianet: `https://login.chinacloudapi.cn/common` +- Security & Compliance PowerShell in Microsoft GCC High or Microsoft DoD: `https://login.microsoftonline.us/common` + +If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedOrganization +The DelegatedOrganization parameter specifies the customer organization that you want to manage (for example, contosoelectronics.onmicrosoft.com). This parameter works only if the customer organization has agreed to your delegated management via the CSP program. + +After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization. + +**Notes**: + +- Use the primary .onmicrosoft.com domain of the delegated organization for the value of this parameter. +- You must use the AzureADAuthorizationEndpointUri parameter with this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSSessionOption +**Note**: This parameter doesn't work in REST API connections. + +The PSSessionOption parameter specifies the remote PowerShell session options to use in your connection to Security & Compliance PowerShell. This parameter works only if you also use the UseRPSSession switch in the same command. + +Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable (for example, `$PSOptions = New-PSSessionOption `), and use the variable name as the value for this parameter (for example, `$PSOptions`). + +```yaml +Type: PSSessionOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +The Prefix parameter specifies a text value to add to the names of Security & Compliance PowerShell cmdlets when you connect. For example, Get-ComplianceCase becomes Get-ContosoComplianceCase when you use the value Contoso for this parameter. + +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Security & Compliance cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatTypeName +The FormatTypeName parameter specifies the output format of the cmdlet. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessToken +**Note**: This parameter is available in version 3.8.0-Preview1 or later of the module. + +The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Security and Compliance PowerShell. + +Depending on the type of access token, you need to use this parameter with the Organization, DelegatedOrganization, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppId +The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. + +For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassMailboxAnchoring +The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Certificate +The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. + +Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: X509Certificate2 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFilePath +The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. + +Don't use this parameter with the Certificate or CertificateThumbprint parameters. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. + +Don't use this parameter with the Certificate or CertificateFilePath parameters. + +**Note**: The CertificateThumbprint parameter is supported only in Microsoft Windows. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). + +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. + +After the Connect-IPPSSession command is complete, the password key in the variable is emptied. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +The Organization parameter specifies the organization when you connect using CBA. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The UserPrincipalName parameter specifies the account that you want to use to connect (for example, navin@contoso.onmicrosoft.com). Using this parameter allows you to skip 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). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseRPSSession +This parameter is available in version 3.2.0 or later of the module. + +**Note**: Remote PowerShell connections to Security & Compliance are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + +The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch. + +This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). + +If you don't use this switch, Basic authentication in WinRM is not required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailboxes/Connect-Mailbox.md b/exchange/exchange-ps/exchange/Connect-Mailbox.md similarity index 78% rename from exchange/exchange-ps/exchange/mailboxes/Connect-Mailbox.md rename to exchange/exchange-ps/exchange/Connect-Mailbox.md index 85c0bc7156..87bea6279a 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Connect-Mailbox.md +++ b/exchange/exchange-ps/exchange/Connect-Mailbox.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Connect-Mailbox @@ -11,9 +14,9 @@ monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Connect-Mailbox cmdlet to connect disconnected mailboxes to existing user accounts that don't already have mailboxess. +Use the Connect-Mailbox cmdlet to connect disconnected mailboxes to existing user accounts that don't already have mailboxes. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,18 +38,18 @@ Connect-Mailbox [-Identity] [-Database] [-Database] -LinkedDomainController -LinkedMasterAccount +Connect-Mailbox [-Identity] [-Database] -LinkedDomainController -LinkedMasterAccount [-LinkedCredential ] [-ActiveSyncMailboxPolicy ] [-Alias ] [-Confirm] [-DomainController ] [-Force] - [-LinkedCredential ] [-ManagedFolderMailboxPolicy ] [-ManagedFolderMailboxPolicyAllowed] [-RetentionPolicy ] [-User ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Room @@ -61,7 +64,8 @@ Connect-Mailbox [-Identity] [-Database] ] [-User ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Shared @@ -76,7 +80,8 @@ Connect-Mailbox [-Identity] [-Database] ] [-User ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### ValidateOnly @@ -85,12 +90,16 @@ Connect-Mailbox [-Identity] [-Database] ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### User ``` -Connect-Mailbox [-Identity] [-Database] [-AddressBookPolicy ] [-AllowLegacyDNMismatch] [-Archive] +Connect-Mailbox [-Identity] [-Database] [-User ] + [-AddressBookPolicy ] + [-AllowLegacyDNMismatch] + [-Archive] [-ActiveSyncMailboxPolicy ] [-Alias ] [-Confirm] @@ -99,60 +108,56 @@ Connect-Mailbox [-Identity] [-Database] ] [-ManagedFolderMailboxPolicyAllowed] [-RetentionPolicy ] - [-User ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION If you link a mailbox to an existing user account, that user account has full access to the mailbox and all mail in the mailbox. -If you use the User parameter to specify the user account, make sure you specify the correct account. If you don't use the User parameter, we recommend that you use the ValidateOnlyswitch to verify which user account the mailbox will try to connect to. +If you use the User parameter to specify the user account, make sure you specify the correct account. If you don't use the User parameter, we recommend that you use the ValidateOnly switch to verify which user account the mailbox will try to connect to. There is no Disconnect-Mailbox cmdlet. You can use the Disable-Mailbox or Remove-Mailbox cmdlets to effectively disconnect mailboxes from user accounts. Use the Disable-Mailbox cmdlet to: - Disconnect the mailbox from the user account. - - Keep the mailbox in the disabled state before it's permanently deleted, subject to the deleted mailbox retention period. - - Keep the user account, but remove the Exchange attributes from the account. Use the Remove-Mailbox cmdlet to: - Disconnect the mailbox from the user account. - - Keep the mailbox in the disabled state before it's permanently deleted, subject to the deleted mailbox retention period (except if you use the Permanent or StoreMailboxIdentity parameters, which immediately deletes the mailbox from the database). - - Remove the user account. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Connect-Mailbox -Database "Mailbox Database" -Identity "John Evans" ``` This example connects John Evans' disconnected mailbox. The example doesn't specify a user to connect the mailbox to, so the command attempts to find a uniquely matched user object. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Connect-Mailbox -Identity "John Evans" -Database "MBXDB02" -LinkedDomainController FabrikamDC01 -LinkedMasterAccount john@fabrikam.com ``` This example connects a linked mailbox. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Connect-Mailbox -Identity "CAR001" -Database "MBXResourceDB" -Equipment -User "CAR001" ``` This example connects an equipment mailbox. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Connect-Mailbox -Identity "ConfRm212" -Database "MBXResourceDB" -Room -User "Conference Room 212" ``` @@ -164,9 +169,7 @@ This example connects a room mailbox. 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 - - GUID - - LegacyExchangeDN You use this parameter with the Database parameter to specify the mailbox that you want to connect. @@ -176,6 +179,7 @@ Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -187,9 +191,7 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID You use this parameter with the Identity parameter to specify the mailbox that you want to connect. @@ -199,6 +201,7 @@ Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 2 Default value: None @@ -207,13 +210,16 @@ Accept wildcard characters: False ``` ### -Equipment -The Equipment switch specifies that you are connecting an equipment mailbox, if this mailbox is a resource mailbox. You don't need to specify a value with this switch. This switch is required only if you're connecting a resource mailbox +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). ```yaml Type: SwitchParameter Parameter Sets: Equipment Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -231,6 +237,7 @@ Type: Fqdn Parameter Sets: Linked Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -241,16 +248,9 @@ Accept wildcard characters: False ### -LinkedMasterAccount The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox. You can use any value that uniquely identifies the master account. For example: -For example: - - Name - -- Display name - - Distinguished name (DN) - - Canonical DN - - GUID This parameter is required only if you're connecting a linked mailbox. @@ -260,6 +260,7 @@ Type: UserIdParameter Parameter Sets: Linked Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -268,13 +269,16 @@ Accept wildcard characters: False ``` ### -Room -The Room switch specifies that you are connecting a room mailbox, if this mailbox is a resource mailbox. You don't need to specify a value with this switch. This switch is required only if you're connecting a resource mailbox. +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). ```yaml Type: SwitchParameter Parameter Sets: Room Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -283,7 +287,7 @@ Accept wildcard characters: False ``` ### -Shared -The Shared switch specifies that you are connecting a shared mailbox. You don't need to specify a value with this switch. This switch is required only if you're connecting a shared mailbox. +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. @@ -292,6 +296,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -300,13 +305,16 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used. +The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. + +No changes are made when you use this switch. ```yaml Type: SwitchParameter Parameter Sets: ValidateOnly Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -318,9 +326,7 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID If you don't use this parameter, the default mobile device mailbox policy is used. @@ -330,6 +336,7 @@ 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 Default value: None @@ -341,18 +348,17 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID -For more information about address book policies, see Address book policies (https://technet.microsoft.com/library/hh529948.aspx). +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -361,17 +367,21 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -382,6 +392,7 @@ 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 Default value: None @@ -397,6 +408,7 @@ Type: SwitchParameter Parameter Sets: User Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -412,6 +424,7 @@ Type: SwitchParameter Parameter Sets: User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -422,8 +435,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -431,6 +443,7 @@ 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 @@ -446,6 +459,7 @@ 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 @@ -454,13 +468,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -471,13 +488,14 @@ Accept wildcard characters: False ### -LinkedCredential The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're connecting a linked mailbox. -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in 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: Linked Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -493,6 +511,7 @@ 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 Default value: None @@ -508,6 +527,7 @@ 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 Default value: None @@ -519,9 +539,7 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. @@ -531,6 +549,7 @@ 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 Default value: None @@ -539,27 +558,28 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user object in Active Directory that you want to connect the mailbox to. You can use any value that uniquely identifies the user. For example: +The User parameter specifies the user object in Active Directory that you want to connect the mailbox to. -For example: +For the best results, we recommend using the following values: -- Name +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. -- Display name +Otherwise, you can use any value that uniquely identifies the user. For example: +- Name - Distinguished name (DN) - - Canonical DN - - GUID -If you don't use this parameter, the command uses the LegacyExchangeDN and DisplayNameproperty values of the mailbox to find a user account that has those same values. If it can't find a unique match, it doesn't connect the mailbox. +If you don't use this parameter, the command uses the LegacyExchangeDN and DisplayName property values of the mailbox to find a user account that has those same values. If it can't find a unique match, it doesn't connect the mailbox. ```yaml 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 Default value: None @@ -575,6 +595,7 @@ 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 @@ -583,20 +604,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/48757062-abe5-4c61-acc5-5884569c1d8b.aspx) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md new file mode 100644 index 0000000000..3dc21e421f --- /dev/null +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -0,0 +1,228 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Delete-QuarantineMessage + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Delete-QuarantineMessage cmdlet to delete quarantine messages from your cloud-based organization + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identities +``` +Delete-QuarantineMessage -Identities + [-Identity ] + [-Confirm] + [-EntityType ] + [-HardDelete] + [-RecipientAddress ] + [-WhatIf] + [] +``` + +### IdentityOnly +``` +Delete-QuarantineMessage -Identity + [-Confirm] + [-EntityType ] + [-HardDelete] + [-RecipientAddress ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Delete-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 +``` + +This example deletes the quarantined message with the specified Identity value. + +### Example 2 +```powershell +$ids = Get-QuarantineMessage | select -ExpandProperty Identity + +Delete-QuarantineMessage -Identity $ids[4] +``` + +This example deletes the 5th quarantined message in the list of results from Get-QuarantineMessage. The first message has the index number 0, the second has the index number 1 and so on. + +### Example 3 +```powershell +$ids = Get-QuarantineMessage | select -ExpandProperty Identity + +Delete-QuarantineMessage -Identities $ids -Identity 000 +``` + +This example deletes all quarantined messages. The Identity parameter is required, but the value 000 is ignored. + +## PARAMETERS + +### -Identities +The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). + +You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. + +When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. + +```yaml +Type: QuarantineMessageIdentity[] +Parameter Sets: Identities +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +```yaml +Type: QuarantineMessageIdentity +Parameter Sets: IdentityOnly +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HardDelete +The HardDelete switch specifies the message is permanently deleted and isn't recoverable. You don't need to specify a value with this switch. + +If you don't use this switch, the message is deleted, but is potentially recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..fe87141f2e --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule +applicable: Exchange Online +title: Disable-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-ATPProtectionPolicyRule and Disable-EOPProtectionPolicyRule cmdlets together to turn off the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-ATPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Disabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md b/exchange/exchange-ps/exchange/Disable-AddressListPaging.md new file mode 100644 index 0000000000..45471267d2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-AddressListPaging.md @@ -0,0 +1,112 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-AddressListPaging + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-AddressListPaging cmdlet to disable Active Directory virtual list view for address lists. Virtual list view displays address lists in your organization as pages instead of loading and viewing the entire directory. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-AddressListPaging [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-AddressListPaging +``` + +This example disables virtual list view for address lists in your organization. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -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/Disable-AntiPhishRule.md b/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md new file mode 100644 index 0000000000..df08fecd4f --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-AntiPhishRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-AntiPhishRule cmdlet to disable antiphish rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-AntiPhishRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-AntiPhishRule -Identity "Engineering Department Phishing Rule" +``` + +This example disables the antiphish rule named Engineering Department Phishing Rule. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-App.md b/exchange/exchange-ps/exchange/Disable-App.md new file mode 100644 index 0000000000..881f7f9195 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-App.md @@ -0,0 +1,179 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Disable-App cmdlet to disable (turn off) a specific app for a specific user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-App [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Disable-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). + +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b -Mailbox Tony +``` + +This example disables the Bing Maps app for user Tony. + +### Example 2 +```powershell +Disable-App -Identity -Mailbox Tony +``` + +This example disables the administrator-installed app FinanceTestApp for user Tony. + +### Example 3 +```powershell +Disable-App -Identity 545d8236-721a-468f-85d8-254eca7cb0da -Mailbox Tony +``` + +This example disables the Share to Teams app for user Tony. + +## PARAMETERS + +### -Identity +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 +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the identity of the mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Identity parameter. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/organization/Disable-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md similarity index 76% rename from exchange/exchange-ps/exchange/organization/Disable-CmdletExtensionAgent.md rename to exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md index 07a0085d9d..071e1f83ec 100644 --- a/exchange/exchange-ps/exchange/organization/Disable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-CmdletExtensionAgent @@ -13,13 +16,16 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-CmdletExtensionAgent cmdlet to disable existing cmdlet extension agents. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Disable-CmdletExtensionAgent [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Disable-CmdletExtensionAgent [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,12 +33,12 @@ Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and When you disable a cmdlet extension agent, the agent is disabled for the entire organization. When an agent is disabled, it's not made available to cmdlets. Cmdlets can no longer use the agent to perform additional operations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-CmdletExtensionAgent "Scripting Agent" ``` @@ -44,9 +50,7 @@ This example disables the cmdlet extension agent named Scripting Agent. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -54,6 +58,7 @@ Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -64,15 +69,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -88,6 +95,7 @@ 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 @@ -103,6 +111,7 @@ 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 @@ -111,20 +120,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8e4b3691-b8e8-4299-97a3-027b9503966a.aspx) diff --git a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md b/exchange/exchange-ps/exchange/Disable-DistributionGroup.md new file mode 100644 index 0000000000..e773646d76 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-DistributionGroup.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-DistributionGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-DistributionGroup cmdlet to remove email capabilities from existing mail-enabled security groups and distribution groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-DistributionGroup [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-DistributionGroup -Identity "Distribution Group1" +``` + +This example mail-disables the distribution group named Distribution Group1. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: DistributionGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -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/Disable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md new file mode 100644 index 0000000000..9b1751508e --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-dnssecforverifieddomain +applicable: Exchange Online +title: Disable-DnssecForVerifiedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-DnssecForVerifiedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-DnssecForVerifiedDomain cmdlet to disable Domain Name System Security (DNSSEC) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-DnssecForVerifiedDomain [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-DnssecForVerifiedDomain -DomainName contoso.com +``` + +This example disables DNSSEC for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to disable DNSSEC (for example, contoso.com). Use the Get-DnssecForVerifiedDomain cmdlet to see information about DNSSEC for the domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..b611fc63b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Disable-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-EOPProtectionPolicyRule cmdlet to turn off the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Disable-ATPProtectionPolicyRule cmdlet to turn off the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-EOPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State property value of the rule is now Disabled. + +### Example 2 +```powershell +Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Disabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md new file mode 100644 index 0000000000..7adfa0cbae --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md @@ -0,0 +1,116 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-HostedContentFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-HostedContentFilterRule cmdlet to disable spam filter rules (content filter rules) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-HostedContentFilterRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-HostedContentFilterRule "Contoso Recipients" +``` + +This example disables the enabled spam filter rule named Contoso Recipients. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/Disable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md new file mode 100644 index 0000000000..442273d3c0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-HostedOutboundSpamFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-HostedOutboundSpamFilterRule cmdlet to disable outbound spam filter rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-HostedOutboundSpamFilterRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-HostedOutboundSpamFilterRule "Contoso Executives" +``` + +This example disables the enabled outbound spam filter rule named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md new file mode 100644 index 0000000000..59ff3a79b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md @@ -0,0 +1,105 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/disable-ipv6foraccepteddomain +applicable: Exchange Online +title: Disable-IPv6ForAcceptedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-IPv6ForAcceptedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-IPv6ForAcceptedDomain cmdlet to disable or opt-out of support for mail delivery to accepted domains in Exchange Online using IPv6. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-IPv6ForAcceptedDomain [[-Domain] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Online organization to use with this cmdlet. + +If IPv6 is enabled for an accepted domain in Exchange Online, IPv4 and IPv6 addresses are returned in DNS queries for mail flow records of the domain. If IPv6 is disabled, only IPv4 addresses are returned in DNS queries for mail flow records of the domain. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-IPv6ForAcceptedDomain -Domain contoso.com +``` + +This example disables IPv6 support for mail sent to contoso.com. Mail can be delivered to the domain using IPv4 only. + +## PARAMETERS + +### -Domain +The Domain parameter specifies the accepted domain that you want to disable mail delivery using IPv6 for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-InboxRule.md b/exchange/exchange-ps/exchange/Disable-InboxRule.md new file mode 100644 index 0000000000..7bc6e6bce3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-InboxRule.md @@ -0,0 +1,204 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Disable-InboxRule cmdlet to disable existing Inbox rules in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-InboxRule [-Identity] + [-AlwaysDeleteOutlookRulesBlob] + [-Confirm] + [-DomainController ] + [-Force] + [-Mailbox ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-InboxRule -Identity "MoveAnnouncements" -Mailbox "Joe@Contoso.com" +``` + +This example disables the Inbox rule MoveAnnouncements in the mailbox Joe@Contoso.com. + +## PARAMETERS + +### -Identity +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 +- RuleIdentity property (for example, 16752869479666417665). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). + +```yaml +Type: InboxRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AlwaysDeleteOutlookRulesBlob +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Disable-JournalArchiving.md b/exchange/exchange-ps/exchange/Disable-JournalArchiving.md new file mode 100644 index 0000000000..a1bf697510 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-JournalArchiving.md @@ -0,0 +1,135 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-JournalArchiving + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-JournalArchiving cmdlet to disable journal archiving for specific users. Microsoft 365 journal archiving uses mailboxes in Exchange Online to record or journal messages for mailboxes in on-premises organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-JournalArchiving [-Identity] + [-Confirm] + [-PreserveMailUser] + [-WhatIf] + [] +``` + +## DESCRIPTION +For each on-premise mailbox that's configured for journal archiving in Microsoft 365, a mail user (also known as a mail-enabled user) and a journal archive mailbox are created in Exchange Online. The mail user routes the incoming journaled messages from the on-premises organization, and the journal archive mailbox stores the journaled messages in the cloud. + +The Disable-JournalArchiving cmdlet removes the mail user and converts the journal archive mailbox into an inactive mailbox. The inactive mailbox remains fully available for In-place eDiscovery. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-JournalArchiving -Identity TimothyAmaral_Archive +``` + +This example disables the journal archiving for the user named Timothy Amaral. Timothy's journal archive mailbox in Exchange Online is named TimothyAmaral\_Archive. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveMailUser +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-JournalRule.md b/exchange/exchange-ps/exchange/Disable-JournalRule.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance/Disable-JournalRule.md rename to exchange/exchange-ps/exchange/Disable-JournalRule.md index 92ba46297b..f36f1eaaaa 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-JournalRule.md +++ b/exchange/exchange-ps/exchange/Disable-JournalRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-JournalRule @@ -13,31 +16,34 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-JournalRule cmdlet to disable a journal rule on a Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Disable-JournalRule -Identity [-Confirm] [-DomainController ] - [-WhatIf] [] +Disable-JournalRule -Identity + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-JournalRule "Brokerage Communications" ``` This example disables the journal rule Brokerage Communications. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-JournalRule | Disable-JournalRule ``` @@ -53,6 +59,7 @@ 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 Default value: None @@ -63,15 +70,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -89,6 +98,7 @@ 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 @@ -104,6 +114,7 @@ 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 Default value: None @@ -112,20 +123,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0324144b-2818-4e7f-a483-d6d6a19f8276.aspx) diff --git a/exchange/exchange-ps/exchange/Disable-MailContact.md b/exchange/exchange-ps/exchange/Disable-MailContact.md new file mode 100644 index 0000000000..97902c5fd6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-MailContact.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-MailContact + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-MailContact cmdlet to remove email capabilities from existing mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-MailContact [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-MailContact -Identity "EdMeadows" +``` + +This example mail-disables the mail contact named Ed Meadows. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailContactIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -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/Disable-MailPublicFolder.md b/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md new file mode 100644 index 0000000000..a4aadbbe70 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md @@ -0,0 +1,159 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Disable-MailPublicFolder cmdlet to mail-disable a public folder. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-MailPublicFolder [-Identity] + [-Confirm] + [-DomainController ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-MailPublicFolder -Identity "\Help Desk" +``` + +This example mail-disables the public folder Help Desk. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label Identity so that only the public folder name or GUID is supplied. + +```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 +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Disable-MailUser.md b/exchange/exchange-ps/exchange/Disable-MailUser.md new file mode 100644 index 0000000000..c0728ff91a --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-MailUser.md @@ -0,0 +1,181 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-MailUser + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-MailUser cmdlet to remove email capabilities from existing mail users. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-MailUser [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-MailUser -Identity markus@contoso.com +``` + +This example mail-disables an existing mail user. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IgnoreLegalHold +The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. + +After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -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/Disable-Mailbox.md b/exchange/exchange-ps/exchange/Disable-Mailbox.md new file mode 100644 index 0000000000..8997b03b35 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-Mailbox.md @@ -0,0 +1,380 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Disable-Mailbox cmdlet to disable the mailbox of existing users who already have mailboxes. For this cmdlet, a user could also be a public folder mailbox or an InetOrgPerson object. The user account that's associated with the mailbox remains, but it's no longer associated with a mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Arbitration +``` +Disable-Mailbox [-Identity] + [-Arbitration] + [-DisableLastArbitrationMailboxAllowed] + [-DisableArbitrationMailboxWithOABsAllowed] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +### Archive +``` +Disable-Mailbox [-Identity] + [-Archive] + [-PermanentlyDisable] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +### PublicFolder +``` +Disable-Mailbox [-Identity] + [-Confirm] + [-PublicFolder] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +### RemoteArchive +``` +Disable-Mailbox [-Identity] + [-RemoteArchive] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Disable-Mailbox cmdlet removes the mailbox's Exchange attributes from Active Directory. The mailbox isn't deleted and can be reconnected to its user at a later date by using the Connect-Mailbox cmdlet. + +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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-Mailbox -Identity "John Woods" +``` + +This example disables the mailbox of the user named John Woods and removes all mailbox attributes from John's user account. + +### Example 2 +```powershell +Disable-Mailbox -Identity "John Woods" -RemoteArchive +``` + +This example disables the remote archive for the on-premises user named John Woods. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to mailbox-disable. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow. + +```yaml +Type: SwitchParameter +Parameter Sets: Arbitration +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 +``` + +### -Archive +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableArbitrationMailboxWithOABsAllowed +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Arbitration +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 +``` + +### -DisableLastArbitrationMailboxAllowed +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Arbitration +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IgnoreLegalHold +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. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. + +After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -PermanentlyDisable +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. + +**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. + +```yaml +Type: SwitchParameter +Parameter Sets: Archive +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +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. + +Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder +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 +``` + +### -RemoteArchive +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. + +You can't use this switch with the Archive switch. + +```yaml +Type: SwitchParameter +Parameter Sets: RemoteArchive +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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md b/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md similarity index 81% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md rename to exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md index 0a9e99070c..98aaf73776 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md +++ b/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-MailboxQuarantine @@ -13,54 +16,65 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-MailboxQuarantine cmdlet to release quarantined mailboxes. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### MailboxIdentity +### MailboxIdentity ``` Disable-MailboxQuarantine [-Identity] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### MailboxOrMailUserIdentity ``` -Disable-MailboxQuarantine [-Identity] [-IncludePassive] +Disable-MailboxQuarantine [-Identity] + [-IncludePassive] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### StoreMailboxIdentity ``` -Disable-MailboxQuarantine -Database -StoreMailboxIdentity [-IncludePassive] +Disable-MailboxQuarantine -Database -StoreMailboxIdentity + [-IncludePassive] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### IncludeAllMailboxes ``` -Disable-MailboxQuarantine -Database [-IncludeAllMailboxes] [-IncludePassive] +Disable-MailboxQuarantine -Database + [-IncludeAllMailboxes] + [-IncludePassive] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### IncludeAllDatabases ``` -Disable-MailboxQuarantine -Server [-IncludeAllDatabases] [-IncludePassive] +Disable-MailboxQuarantine -Server + [-IncludeAllDatabases] + [-IncludePassive] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION Mailboxes are quarantined when they affect the availability of the mailbox database. Typically a software fix from Microsoft is required before releasing a mailbox from quarantine. If a fix isn't deployed before releasing the mailbox, the quarantine on the mailbox will be re-enabled if the condition recurs. The default quarantine duration is 24 hours. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-MailboxQuarantine "Brian Johnson" ``` @@ -69,30 +83,17 @@ This example releases the mailbox for the user Brian Johnson from quarantine. ## PARAMETERS ### -Identity -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) You can't use this parameter with the Database or Server parameters. @@ -102,6 +103,7 @@ Type: GeneralMailboxIdParameter Parameter Sets: MailboxIdentity Aliases: Applicable: Exchange Server 2013 + Required: True Position: 1 Default value: None @@ -114,6 +116,7 @@ Type: GeneralMailboxOrMailUserIdParameter Parameter Sets: MailboxOrMailUserIdentity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -125,9 +128,7 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID You identify the mailboxes by using the IncludeAllMailboxes switch or the StoreMailboxIdentity parameter. @@ -139,6 +140,7 @@ Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity, IncludeAllMailboxes Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -156,6 +158,7 @@ Type: SwitchParameter Parameter Sets: IncludeAllDatabases Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -173,6 +176,7 @@ Type: SwitchParameter Parameter Sets: IncludeAllMailboxes Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -184,11 +188,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished Name (DN) - - Exchange Legacy DN You can't use this parameter with the Identity or Database parameters. @@ -198,6 +199,7 @@ Type: ServerIdParameter Parameter Sets: IncludeAllDatabases Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -217,6 +219,7 @@ Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -227,15 +230,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -251,6 +256,7 @@ Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, IncludeAllMailboxes, MailboxOrMailUserIdentity, IncludeAllDatabases Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -266,6 +272,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -274,20 +281,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5e990971-e24a-4977-9408-fbab1289ea7e.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Disable-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md similarity index 75% rename from exchange/exchange-ps/exchange/antispam-antimalware/Disable-MalwareFilterRule.md rename to exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md index 5f311c5ad9..127a8f0542 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Disable-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-MalwareFilterRule @@ -13,22 +16,25 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-MalwareFilterRule cmdlet to disable malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Disable-MalwareFilterRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Disable-MalwareFilterRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-MalwareFilterRule "Contoso Recipients" ``` @@ -44,6 +50,7 @@ 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 Default value: None @@ -54,15 +61,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -80,6 +89,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,6 +105,7 @@ 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 Default value: None @@ -103,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/83376568-d37f-41b7-aea3-bd08333ce07e.aspx) diff --git a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md new file mode 100644 index 0000000000..87451f2763 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md @@ -0,0 +1,111 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-MetaCacheDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-MetaCacheDatabase cmdlet to disable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-MetaCacheDatabase -Server + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-MetaCacheDatabase -Server Mailbox01 +``` + +This example disables the metacache database on the Exchange server named Mailbox01. + +## PARAMETERS + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). For example, "Server1","Server2"..."ServerN". + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md new file mode 100644 index 0000000000..30685164f7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md @@ -0,0 +1,179 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-OutlookAnywhere + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Disable-OutlookAnywhere cmdlet to disable Outlook Anywhere on Exchange Server 2010 Client Access servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Disable-OutlookAnywhere [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### Server +``` +Disable-OutlookAnywhere [-Server ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Enabling Outlook Anywhere on the Client Access server prevents the server from accepting external connections by Outlook 2003 or later clients by using Outlook Anywhere. + +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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-OutlookAnywhere -Server CAS01 +``` + +This example disables Outlook Anywhere on the Client Access server named CAS01. + +### Example 2 +```powershell +Disable-OutlookAnywhere -Identity: "exch01\rpc (Default Web Site)" +``` + +This example disables Outlook Anywhere on the specified virtual directory on the Client Access server named exch01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +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 Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md new file mode 100644 index 0000000000..6032b60587 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md @@ -0,0 +1,137 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-OutlookProtectionRule + +## 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. + +Use the Disable-OutlookProtectionRule cmdlet to disable an existing Microsoft Outlook protection rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-OutlookProtectionRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Outlook protection rules are administrator-created rules applied before a user sends a message using Outlook. Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. + +For more information, see [Outlook protection rules](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-OutlookProtectionRule -Identity "Project Contoso" +``` + +This example disables the Outlook protection rule Project Contoso. + +## PARAMETERS + +### -Identity +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 +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Disable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md new file mode 100644 index 0000000000..ade8f3935d --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md @@ -0,0 +1,97 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-PushNotificationProxy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-PushNotificationProxy cmdlet to disable the push notification proxy that's configured between an on-premises Microsoft Exchange organization and a Microsoft 365 organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-PushNotificationProxy [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-PushNotificationProxy +``` + +This example disables the push notification proxy in the on-premises Exchange organization. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Disable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md new file mode 100644 index 0000000000..8039e5d1fd --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md @@ -0,0 +1,219 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-RemoteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-RemoteMailbox cmdlet to remove user mailboxes from the cloud-based service but keep the associated user objects in the on-premises Active Directory. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-RemoteMailbox [-Identity] + [-Archive] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +## 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. +- 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. + +Directory synchronization must be configured correctly for a mailbox to be removed from the cloud. Removal of the cloud-based mailbox isn't immediate and depends on the directory synchronization schedule. + +**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. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +### 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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the cloud-based mailbox. Valid values are: + +- ADObjectID +- GUID +- Distinguished name (DN) +- Domain\\Username +- User principal name (UPN) +- LegacyExchangeDN +- Email address +- User alias + +```yaml +Type: RemoteMailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Archive +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IgnoreLegalHold +The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. + +This switch disables the instance of the remote object in the on-premises organization, and the request to disable the mailbox is synchronized to the cloud. However, if the cloud mailbox is on hold, the request to disable the mailbox is blocked, and an error is returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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/Disable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md new file mode 100644 index 0000000000..8e8073a184 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-reportsubmissionrule +applicable: Exchange Online +title: Disable-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-ReportSubmissionRule cmdlet to disable the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-ReportSubmissionRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-ReportSubmissionRule -Identity DefaultReportSubmissionRule. +``` + +This example disables the report submission rule if it's already enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to disable. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md new file mode 100644 index 0000000000..35ef4b854d --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-SafeAttachmentRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-SafeAttachmentRule cmdlet to disable safe attachment rules in your cloud-based organization. This cmdlet is also responsible for disabling complete Safe Attachments policies in the admin center, which consist of the safe attachment rule and the corresponding assigned safe attachment policy in PowerShell. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-SafeAttachmentRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-SafeAttachmentRule -Identity "Engineering Department Attachment Rule" +``` + +This example disables the safe attachment rule named Engineering Department Attachment Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md new file mode 100644 index 0000000000..fa714bf72f --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-SafeLinksRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-SafeLinksRule cmdlet to disable enabled Safe Links rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-SafeLinksRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-SafeLinksRule -Identity "Engineering Department URL Rule" +``` + +This example disables the enabled Safe Links rule named Engineering Department URL Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md new file mode 100644 index 0000000000..13a29e56ed --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md @@ -0,0 +1,158 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-ServiceEmailChannel + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-ServiceEmailChannel cmdlet to disable the .NET service channel for a specific user. The .NET service channel enables Microsoft Exchange to store information that it later forwards to applications or devices that aren't permanently connected to the server running Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-ServiceEmailChannel [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-ServiceEmailChannel -Identity JeffHay +``` + +This example disables the .NET service channel for the user Jeff Hay. + +### Example 2 +```powershell +Disable-ServiceEmailChannel -Identity JeffHay -Confirm $true +``` + +This example disables the .NET service channel for the user Jeff Hay after confirmation is given. + +### Example 3 +```powershell +Disable-ServiceEmailChannel -Identity JeffHay -Confirm $false +``` + +This example disables the .NET service channel for the user Jeff Hay without requiring confirmation. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -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/Disable-SmtpDaneInbound.md b/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md new file mode 100644 index 0000000000..927fd4cd53 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-smtpdaneinbound +applicable: Exchange Online +title: Disable-SmtpDaneInbound +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-SmtpDaneInbound + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-SMTPDaneInbound cmdlet to disable SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-SmtpDaneInbound [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-SmtpDaneInbound -DomainName contoso.com +``` + +This example disables SMTP DANE for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to disable SMTP DANE (for example, contoso.com). Use the Get-SmtpDaneInboundStatus cmdlet to see information about SMTP DNAME for the domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-SweepRule.md b/exchange/exchange-ps/exchange/Disable-SweepRule.md new file mode 100644 index 0000000000..225c628693 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-SweepRule.md @@ -0,0 +1,162 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Disable-SweepRule cmdlet to disable Sweep rules in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-SweepRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" +``` + +This example disables the specified Sweep rule. + +### Example 2 +```powershell +Get-SweepRule -Mailbox laura@contoso.com | Disable-SweepRule +``` + +This example disables all Sweep rules in the specified mailbox. + +## PARAMETERS + +### -Identity +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==). +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). + +```yaml +Type: SweepRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: 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 Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Disable-TransportAgent.md b/exchange/exchange-ps/exchange/Disable-TransportAgent.md similarity index 76% rename from exchange/exchange-ps/exchange/mail-flow/Disable-TransportAgent.md rename to exchange/exchange-ps/exchange/Disable-TransportAgent.md index 5f92d648dd..5ccd3fab73 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Disable-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Disable-TransportAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-TransportAgent @@ -13,22 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-TransportAgent cmdlet to disable a transport agent. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Disable-TransportAgent [-Identity] [-Confirm] [-DomainController ] [-WhatIf] - [-TransportService ] [] +Disable-TransportAgent [-Identity] + [-Confirm] + [-DomainController ] + [-TransportService ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-TransportAgent "Test App" -TransportService Hub ``` @@ -44,6 +51,7 @@ Type: TransportAgentObjectId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,15 +62,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -80,21 +90,7 @@ 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 -``` -### -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 @@ -106,20 +102,33 @@ Accept wildcard characters: False 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. - - MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - - MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - - FrontEnd for the Front End Transport service on Mailbox servers. - - Edge on Edge Transport servers. ```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery +Type: TransportService Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 @@ -128,20 +137,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/48929018-619f-4b7a-aecc-af284df14125.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-TransportRule.md b/exchange/exchange-ps/exchange/Disable-TransportRule.md similarity index 77% rename from exchange/exchange-ps/exchange/policy-and-compliance/Disable-TransportRule.md rename to exchange/exchange-ps/exchange/Disable-TransportRule.md index 91f05357d4..03d4189525 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Disable-TransportRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-TransportRule @@ -13,24 +16,27 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-TransportRule cmdlet to disable transport rules (mail flow rules) in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Disable-TransportRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Disable-TransportRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-TransportRule -Identity "Sales Disclaimer" ``` @@ -42,9 +48,7 @@ This example disables the rule named Sales Disclaimer. The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name - - Distinguished name (DN) - - GUID ```yaml @@ -52,6 +56,7 @@ 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 Default value: None @@ -62,15 +67,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -90,6 +97,7 @@ 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 @@ -105,6 +113,7 @@ 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 @@ -113,20 +122,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/f1b5c2d6-cfcd-4180-89f5-13723d87a1b4.aspx) diff --git a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md new file mode 100644 index 0000000000..9a332903c9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-UMAutoAttendant + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-UMAutoAttendant cmdlet to disable an existing Unified Messaging (UM) auto attendant that's enabled. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-UMAutoAttendant [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-UMAutoAttendant -Identity MyUMAutoAttendant +``` + +This example disables the UM auto attendant MyUMAutoAttendant. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Disable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md new file mode 100644 index 0000000000..d9f8154eaf --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md @@ -0,0 +1,177 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-UMCallAnsweringRule + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-UMCallAnsweringRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Disable-UMCallAnsweringRule cmdlet disables the call answering rule by modifying its status variable. Disabling a call answering rule prevents it from being retrieved and processed when an incoming call is received. With this cmdlet, you can disable an existing call answering rule that's enabled. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Disable -UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith +``` + +This example disables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith. + +### Example 2 +```powershell +Disable -UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -WhatIf +``` + +This example uses the WhatIf switch to test whether the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith is ready to be disabled and if there are any errors within the command. + +### Example 3 +```powershell +Disable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -Confirm +``` + +This example disables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith and prompts the user logged on to confirm that they're disabling the call answering rule. + +## PARAMETERS + +### -Identity +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 +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the mailbox of the user who is running the command is used. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Disable-UMIPGateway.md b/exchange/exchange-ps/exchange/Disable-UMIPGateway.md new file mode 100644 index 0000000000..f0738b7185 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-UMIPGateway.md @@ -0,0 +1,155 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-UMIPGateway + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-UMIPGateway cmdlet to disable a Unified Messaging (UM) IP gateway. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-UMIPGateway [-Identity] + [-Confirm] + [-DomainController ] + [-Immediate ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-UMIPGateway -Identity MyUMIPGateway +``` + +This example disables the UM IP gateway MyUMIPGateway and stops it from accepting incoming calls from the IP gateway. + +### Example 2 +```powershell +Disable-UMIPGateway -Identity MyUMIPGateway -Immediate $true +``` + +This example disables the UM IP gateway MyUMIPGateway and disconnects all current calls immediately. + +## PARAMETERS + +### -Identity +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 +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Immediate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Disable-UMMailbox.md b/exchange/exchange-ps/exchange/Disable-UMMailbox.md new file mode 100644 index 0000000000..f9ea3dd8ba --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-UMMailbox.md @@ -0,0 +1,182 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-UMMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-UMMailbox cmdlet to disable Unified Messaging (UM) for UM-enabled mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-UMMailbox [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-KeepProperties ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-UMMailbox -Identity tonysmith@contoso.com +``` + +This example disables Unified Messaging on the mailbox for tonysmith@contoso.com. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeepProperties +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/unified-messaging/Disable-UMServer.md b/exchange/exchange-ps/exchange/Disable-UMServer.md similarity index 78% rename from exchange/exchange-ps/exchange/unified-messaging/Disable-UMServer.md rename to exchange/exchange-ps/exchange/Disable-UMServer.md index eb259788db..2b34bd0f25 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMServer.md +++ b/exchange/exchange-ps/exchange/Disable-UMServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Disable-UMServer @@ -13,13 +16,17 @@ This cmdlet is available only in Exchange Server 2010. Use the Disable-UMServer cmdlet to set the status of an Exchange Server 2010 Unified Messaging (UM) server to disabled. This prevents the Unified Messaging server from processing UM calls. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Disable-UMServer [-Identity] [-Confirm] [-DomainController ] - [-Immediate <$true | $false>] [-WhatIf] [] +Disable-UMServer [-Identity] + [-Confirm] + [-DomainController ] + [-Immediate ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -28,26 +35,23 @@ The Disable-UMServer cmdlet sets the status of a Unified Messaging server. A UM After this task is completed, the UM server can no longer: - Answer any incoming calls - - Respond to Play on Phone requests from a Client Access server - - 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Disable-UMServer -Identity MyUMServer ``` This example disables Unified Messaging on the Unified Messaging server named MyUMServer but doesn't disconnect calls that are being processed. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Disable-UMServer -Identity MyUMServer -Immediate $true ``` @@ -63,6 +67,7 @@ Type: UMServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -73,8 +78,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -82,6 +86,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -97,6 +102,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -108,10 +114,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -127,6 +134,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -135,20 +143,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f5d77b6c-7229-4ffb-a9e5-ec4ddf98f838.aspx) diff --git a/exchange/exchange-ps/exchange/Disable-UMService.md b/exchange/exchange-ps/exchange/Disable-UMService.md new file mode 100644 index 0000000000..48cc82a85b --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-UMService.md @@ -0,0 +1,167 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disable-UMService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Disable-UMService cmdlet to set the status of an Exchange Server 2010 Unified Messaging server to disabled. This prevents the UM server from processing UM incoming calls. + +You can run this cmdlet in Exchange 2013 or Exchange 2016, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to disable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-UMService [-Identity] + [-Confirm] + [-DomainController ] + [-Immediate ] + [-WhatIf] + [] +``` + +## 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. + +After this task is completed, the UM server can no longer: + +- Answer any incoming calls. +- Respond to Play on Phone requests from a UM server. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Disable-UMService -Identity MyUMServer +``` + +This example disables Unified Messaging on the UM server MyUMServer but doesn't disconnect calls that are being processed. + +### Example 2 +```powershell +Disable-UMService -Identity MyUMServer -Immediate $true +``` + +This example disables Unified Messaging on the UM server MyUMServer and disconnects all calls being processed. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +```yaml +Type: UMServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Immediate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md new file mode 100644 index 0000000000..c2a6bb1153 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -0,0 +1,171 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Disconnect-ExchangeOnline + +## 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 Disconnect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to disconnect the connections that you created using the Connect-ExchangeOnline or Connect-IPPSSession cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Disconnect-ExchangeOnline + [-Confirm] + [-WhatIf] + [] +``` + +### ConnectionId +``` +Disconnect-ExchangeOnline -ConnectionId + [-Confirm] + [-WhatIf] + [] +``` + +### ModulePrefix +``` +Disconnect-ExchangeOnline -ModulePrefix + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet is the counterpart to the Connect-ExchangeOnline and Connect-IPPSSession cmdlets. + +This cmdlet disconnects any connections and clears the cache. After a successful disconnect, you can't successfully run any cmdlets for your organization. + +Disconnect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. + +## EXAMPLES + +### Example 1 +```powershell +Disconnect-ExchangeOnline +``` + +This example asks for confirmation before disconnecting from Exchange Online PowerShell or Security & Compliance PowerShell. + +### Example 2 +```powershell +Disconnect-ExchangeOnline -Confirm:$false +``` + +This example silently disconnects from Exchange Online PowerShell or Security & Compliance PowerShell without a confirmation prompt or any notification text. + +### Example 3 +```powershell +Disconnect-ExchangeOnline -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85 +``` + +This example disconnects the REST-based Exchange Online PowerShell connection with the specified ConnectionId value. Any other remote PowerShell connections to Exchange Online PowerShell or Security & Compliance PowerShell in the same Windows PowerShell window are also disconnected. + +### Example 4 +```powershell +Disconnect-ExchangeOnline -ModulePrefix Contoso,Fabrikam +``` + +This example disconnects the REST-based Exchange Online PowerShell connections that are using the specified prefix values. Any other remote PowerShell connections to Exchange Online PowerShell or Security & Compliance PowerShell in the same Windows PowerShell window are also disconnected. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ConnectionId parameter specifies the REST API connections to disconnect by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. + +Don't use this parameter with the ModulePrefix parameter. + +```yaml +Type: String[] +Parameter Sets: ConnectionId +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulePrefix +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ModulePrefix parameter specifies the REST API connections to disconnect by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. + +Don't use this parameter with the ConnectionId parameter. + +```yaml +Type: String[] +Parameter Sets: ModulePrefix +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Dismount-Database.md b/exchange/exchange-ps/exchange/Dismount-Database.md similarity index 75% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Dismount-Database.md rename to exchange/exchange-ps/exchange/Dismount-Database.md index 48d6a0c075..7159912a4e 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Dismount-Database.md +++ b/exchange/exchange-ps/exchange/Dismount-Database.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Dismount-Database @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Dismount-Database cmdlet to dismount databases. You can run this command only if the Microsoft Exchange Information Store service is running. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Dismount-Database [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Dismount-Database [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Dismount-Database -Identity MyDatabase ``` @@ -42,9 +48,7 @@ Regardless of where you run this cmdlet, it operates against the server hosting The Identity parameter specifies the database that you want to dismount. You can use any value that uniquely identifies the database. For example: - Name - - Distinguished name (DN) - - GUID ```yaml @@ -52,6 +56,7 @@ Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -62,8 +67,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -71,6 +75,7 @@ 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 @@ -86,6 +91,7 @@ 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 @@ -101,6 +107,7 @@ 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 @@ -109,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e261955b-a9f0-4d87-bf56-f9e67ea5ba3f.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Dump-ProvisioningCache.md b/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md similarity index 79% rename from exchange/exchange-ps/exchange/active-directory/Dump-ProvisioningCache.md rename to exchange/exchange-ps/exchange/Dump-ProvisioningCache.md index 8deb298341..b16e9a249e 100644 --- a/exchange/exchange-ps/exchange/active-directory/Dump-ProvisioningCache.md +++ b/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Dump-ProvisioningCache @@ -13,24 +16,29 @@ This cmdlet is available only in on-premises Exchange. Use the Dump-ProvisioningCache cmdlet to return a list of the cached keys and values for the specified server and Windows PowerShell application. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### GlobalCache ``` -Dump-ProvisioningCache [-Server] -Application [-GlobalCache] +Dump-ProvisioningCache [-Server] -Application + [-GlobalCache] [-CacheKeys ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### OrganizationCache ``` -Dump-ProvisioningCache [-Server] -Application [-CurrentOrganization] [-Organizations ] +Dump-ProvisioningCache [-Server] -Application + [-CurrentOrganization] + [-Organizations ] [-CacheKeys ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -38,12 +46,12 @@ The Dump-ProvisioningCache cmdlet is for diagnostic purposes only and is rarely The Dump-ProvisioningCache cmdlet displays a list of the Windows PowerShell provisioning cache keys. Use the value of these cache keys with the Reset-ProvisioningCache cmdlet to reset provisioning cache data. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Dump-ProvisioningCache -Server EXSRV1.contoso.com -Application Powershell-Proxy -GlobalCache ``` @@ -51,19 +59,30 @@ This example displays all cache keys for the specified server and Windows PowerS ## PARAMETERS +### -Server +The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Application The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: - Powershell - - Powershell-LiveId - - Powershell-Proxy - - PowershellLiveId-Proxy - - Ecp - - Psws ```yaml @@ -71,6 +90,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -79,13 +99,14 @@ Accept wildcard characters: False ``` ### -GlobalCache -The GlobalCache switch specifies that all cache keys are cleared. +The GlobalCache switch specifies that all cache keys are cleared. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCache Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -93,21 +114,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Server -The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -CacheKeys The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx @@ -118,6 +124,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -128,8 +135,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -137,6 +143,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -145,13 +152,14 @@ Accept wildcard characters: False ``` ### -CurrentOrganization -The CurrentOrganization switch specifies that the provision cache is reset for this organization. +The CurrentOrganization switch specifies that the provision cache is reset for this organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: OrganizationCache Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -167,6 +175,7 @@ Type: MultiValuedProperty Parameter Sets: OrganizationCache Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -182,6 +191,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -190,20 +200,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d79009fc-4dea-44f9-89e0-732106ac67a0.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..af887e025f --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule +applicable: Exchange Online +title: Enable-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-ATPProtectionPolicyRule and Enable-EOPProtectionPolicyRule cmdlets together to turn on the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-ATPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns on the Standard preset security policy. The State value of both rules is now Enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md b/exchange/exchange-ps/exchange/Enable-AddressListPaging.md new file mode 100644 index 0000000000..7bdc8deb33 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-AddressListPaging.md @@ -0,0 +1,112 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-AddressListPaging + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-AddressListPaging cmdlet to enable Active Directory virtual list view for address lists. Virtual list view allows you to display the address lists in your organization as pages instead of loading and viewing the entire directory. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-AddressListPaging [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-AddressListPaging +``` + +This example enables virtual list view for your organization. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```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 +``` + +### -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/Enable-AntiPhishRule.md b/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md new file mode 100644 index 0000000000..55bc463ac2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-AntiPhishRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-AntiPhishRule cmdlet to enable antiphish rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-AntiPhishRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-AntiPhishRule -Identity "Marketing Department Phishing Rule" +``` + +This example enables the antiphish rule named Marketing Department Phishing Rule. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md b/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md new file mode 100644 index 0000000000..40a8ec1a57 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md @@ -0,0 +1,122 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-AntispamUpdates + +## SYNOPSIS +The Enable-AntispamUpdates cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-AntispamUpdates [[-Identity] ] + [-Confirm] + [-SpamSignatureUpdatesEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AntispamUpdates +``` + +This cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamSignatureUpdatesEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/Enable-App.md b/exchange/exchange-ps/exchange/Enable-App.md new file mode 100644 index 0000000000..788dc99c86 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-App.md @@ -0,0 +1,175 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-App cmdlet to enable (turn on) a specific app for a specific user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-App [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Enable-App cmdlet requires that the specified app has already been installed (for example, that it has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). + +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b -Mailbox Tony +``` + +This example enables the default Bing Maps app installed for user Tony. + +### Example 2 +```powershell +Enable-App -Identity -Mailbox Tony +``` + +This example enables the administrator-installed app FinanceTestApp for user Tony. + +### Example 3 +```powershell +Enable-App -Identity 545d8236-721a-468f-85d8-254eca7cb0da -Mailbox Tony +``` + +This example enables the Share to Teams app for user Tony. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/organization/Enable-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md similarity index 79% rename from exchange/exchange-ps/exchange/organization/Enable-CmdletExtensionAgent.md rename to exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md index 5a69d3f517..588d8f1d9a 100644 --- a/exchange/exchange-ps/exchange/organization/Enable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-CmdletExtensionAgent @@ -13,13 +16,16 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-CmdletExtensionAgent cmdlet to enable existing cmdlet extension agents. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Enable-CmdletExtensionAgent [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Enable-CmdletExtensionAgent [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,12 +35,12 @@ When you enable a cmdlet extension agent, the agent is run on every Exchange ser Before you enable agents, be sure that you're aware of how the agent works and what impact the agent will have on your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-CmdletExtensionAgent "Scripting Agent" ``` @@ -46,9 +52,7 @@ This example enables the cmdlet extension agent named Scripting Agent. Before yo 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 - - Distinguished name (DN) - - GUID ```yaml @@ -56,6 +60,7 @@ Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -66,8 +71,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -75,6 +79,7 @@ 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 @@ -90,6 +95,7 @@ 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 @@ -105,6 +111,7 @@ 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 @@ -113,20 +120,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/349823d2-55cb-46d5-b658-ea15d2bbebaa.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md new file mode 100644 index 0000000000..c2a69f5215 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md @@ -0,0 +1,107 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-ComplianceTagStorage + +## 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 Enable-ComplianceTagStorage cmdlet to create the retention label policy in the Microsoft Purview compliance portal. This is a one-time operation. Retention labels apply retention settings to content. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-ComplianceTagStorage + [-Confirm] + [-RecordsManagementSecurityGroupEmail ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can check the status by running the following command: `Get-ComplianceTagStorage | Format-List Enabled,DistributionStatus`. The value True for the Enabled property and the value Success for the DistributionStatus property indicates the Enable-ComplianceTagStorage cmdlet has already been run in the organization, and you don't need to run it again. If you run the cmdlet unnecessarily, you'll get a warning, and the DistributionStatus property changes to the value Pending for a few minutes before returning to the value Success. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-ComplianceTagStorage +``` + +This example creates the label policy in the Microsoft Purview compliance portal. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```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 +``` + +### -RecordsManagementSecurityGroupEmail +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 +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/Enable-DistributionGroup.md b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md new file mode 100644 index 0000000000..cda305dfb4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md @@ -0,0 +1,207 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-DistributionGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-DistributionGroup cmdlet to mail-enable existing universal security groups and universal distribution groups that aren't already mail-enabled. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-DistributionGroup [-Identity] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-PrimarySmtpAddress ] + [-WhatIf] + [] +``` + +## 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). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. + +## EXAMPLES + +### Example 1 +```powershell +Enable-DistributionGroup -Identity "Distribution Group1" +``` + +This example mail-enables the universal distribution group named Distribution Group1. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: GroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +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 +``` + +### -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 +``` + +### -DisplayName +The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +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 +``` + +### -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 +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. + +By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of the group won't be 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Enable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md new file mode 100644 index 0000000000..785b0029ab --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-dnssecforverifieddomain +applicable: Exchange Online +title: Enable-DnssecForVerifiedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-DnssecForVerifiedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-DnssecForVerifiedDomain cmdlet to enable Domain Name System Security (DNSSEC) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-DnssecForVerifiedDomain [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The output of this cmdlet is an MX record value that you need to add to DNS for the specified domain. + +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-DnssecForVerifiedDomain -DomainName contoso.com +``` + +This example enables DNSSEC for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to enable DNSSEC (for example, contoso.com). Use the Get-AcceptedDomain cmdlet to see the accepted domains in the organization. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..a73b54c47d --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Enable-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-EOPProtectionPolicyRule cmdlet to turn on the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Enable-ATPProtectionPolicyRule cmdlet to turn on the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-EOPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State property value of the rule is now Enabled. + +### Example 2 +```powershell +Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns on the Standard preset security policy. The State property value of both rules is now Enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md similarity index 83% rename from exchange/exchange-ps/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md rename to exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md index dba50c08d8..29cc1af6d3 100644 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-ExchangeCertificate @@ -13,33 +16,35 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-ExchangeCertificate cmdlet to enable an existing certificate on the Exchange server for Exchange services such as Internet Information Services (IIS), SMTP, POP, IMAP and Unified Messaging (UM). Once you enable a certificate for a service, you can't disable it. -To see the existing certificates that are used for Exchange services, use Get-ExchangeCertificate (https://docs.microsoft.com/powershell/module/exchange/encryption-and-certificates/get-exchangecertificate). +To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Thumbprint ``` -Enable-ExchangeCertificate [-Thumbprint] -Services +Enable-ExchangeCertificate [-Thumbprint] -Services [-Confirm] [-DomainController ] [-DoNotRequireSsl] [-Force] [-NetworkServiceAllowed] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Identity ``` -Enable-ExchangeCertificate [[-Identity] ] -Services +Enable-ExchangeCertificate [[-Identity] ] -Services [-Confirm] [-DomainController ] [-DoNotRequireSsl] [-Force] [-NetworkServiceAllowed] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -47,16 +52,16 @@ The Enable-ExchangeCertificate cmdlet enables certificates by updating the metad After you run the Enable-ExchangeCertificate cmdlet, you might need to restart Internet Information Services (IIS). In some scenarios, Exchange might continue to use the previous certificate for encrypting and decrypting the cookie that's used for Outlook on the web (formerly known as Outlook Web App) authentication. We recommend restarting IIS in environments that use Layer 4 load balancing. -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see Digital certificates and encryption in Exchange 2016 (https://technet.microsoft.com/library/dd351044.aspx). +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out Protecting you against the SSL 3.0 vulnerability (https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -Services POP,IMAP,SMTP,IIS ``` @@ -64,21 +69,58 @@ This example enables a certificate for POP, IMAP, SMTP and IIS services. ## PARAMETERS +### -Thumbprint +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. + +```yaml +Type: String +Parameter Sets: Thumbprint +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the certificate that you want to configure. Valid values are: + +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` + +You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. + +You can't use this parameter with the Server parameter. + +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. + +```yaml +Type: ExchangeCertificateIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Services 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. - - IIS: By default, when you enable a certificate for IIS, the "require SSL" setting is configured on the default web site in IIS. To prevent this change, use the DoNotRequireSsl switch. - - IMAP: Don't enable a wildcard certificate for the IMAP4 service. Instead, use the Set-ImapSettings cmdlet to configure the FQDN that clients use to connect to the IMAP4 service. - - POP: Don't enable a wildcard certificate for the POP3 service. Instead, use the Set-PopSettings cmdlet to configure the FQDN that clients use to connect to the POP3 service. - - SMTP: When you enable a certificate for SMTP, you're prompted to replace the default Exchange self-signed certificate that's used to encrypt SMTP traffic between internal Exchange. Typically, you don't need to replace the default certificate with a certificate from a commercial CA for the purpose of encrypting internal SMTP traffic. If you want to replace the default certificate without the confirmation prompt, use the Force switch. - - UM: You can only enable a certificate for the UM service when the UMStartupMode parameter on the Set-UMService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value TCP, you can't enable the certificate for the UM service. - - UMCallRouter: You can only enable a certificate for the UM Call Router service when the UMStartupMode parameter on the Set-UMCallRouterService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value TCP, you can't enable the certificate for the UM Call Router service. You can specify multiple values separated by commas. @@ -88,10 +130,11 @@ The values that you specify with this parameter are additive. When you enable a 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. ```yaml -Type: None | IMAP | POP | UM | IIS | SMTP | Federation | UMCallRouter +Type: AllowedServices Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -99,28 +142,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Thumbprint -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. - -```yaml -Type: String -Parameter Sets: Thumbprint -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -128,6 +153,7 @@ 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 @@ -145,6 +171,7 @@ 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 @@ -162,6 +189,7 @@ 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 @@ -170,7 +198,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. By default, when you enable a certificate for SMTP, the command prompts you to replace the existing certificate that's enabled for SMTP, which is likely the default Exchange self-signed certificate. @@ -179,33 +209,9 @@ 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 -``` -### -Identity -The Identity parameter specifies the certificate that you want to configure. Valid values are: - -- \\\\ - -- \ - -You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. - -You can't use this parameter with the Server parameter. - -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. - -```yaml -Type: ExchangeCertificateIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -219,6 +225,7 @@ 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 @@ -230,11 +237,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -246,6 +250,7 @@ Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -261,6 +266,7 @@ 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 @@ -269,20 +275,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3536f005-d0c4-4745-aec2-55836d86f5a0.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md new file mode 100644 index 0000000000..8b49e06134 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-HostedContentFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-HostedContentFilterRule cmdlet to enable spam filter rules (content filter rules) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-HostedContentFilterRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-HostedContentFilterRule "Contoso Recipients" +``` + +This example enables the disabled spam filter rule named Contoso Recipients. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/Enable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md new file mode 100644 index 0000000000..b0b6d2ea45 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-HostedOutboundSpamFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-HostedOutboundSpamFilterRule cmdlet to enable outbound spam filter rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-HostedOutboundSpamFilterRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-HostedOutboundSpamFilterRule "Contoso Executives" +``` + +This example enables the disabled outbound spam filter rule named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md new file mode 100644 index 0000000000..1ce4f5db89 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md @@ -0,0 +1,105 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/enable-ipv6foraccepteddomain +applicable: Exchange Online +title: Enable-IPv6ForAcceptedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-IPv6ForAcceptedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-IPv6ForAcceptedDomain cmdlet to enable support for mail delivery to accepted domains in Exchange Online using IPv6. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-IPv6ForAcceptedDomain [[-Domain] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Online organization to use with this cmdlet + +If IPv6 is enabled for an accepted domain in Exchange Online, IPv4 and IPv6 addresses are returned in DNS queries for mail flow records of the domain. If IPv6 is disabled, only IPv4 addresses are returned in DNS queries for mail flow records of the domain. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-IPv6ForAcceptedDomain -Domain contoso.com +``` + +This example enables IPv6 support for mail sent to contoso.com. Mail can be delivered to the domain using IPv4 or IPv6. + +## PARAMETERS + +### -Domain +The Domain parameter specifies the accepted domain that you want to enable mail delivery using IPv6 for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-InboxRule.md b/exchange/exchange-ps/exchange/Enable-InboxRule.md new file mode 100644 index 0000000000..a4e38bdcbb --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-InboxRule.md @@ -0,0 +1,202 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-InboxRule cmdlet to enable an Inbox rule. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-InboxRule [-Identity] + [-AlwaysDeleteOutlookRulesBlob] + [-Confirm] + [-DomainController ] + [-Force] + [-Mailbox ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-InboxRule "Move To Junk Mail" -Mailbox "User 1" +``` + +This example enables the Inbox rule named Move To Junk Mail in the mailbox that belongs to User 1. + +## PARAMETERS + +### -Identity +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 +- RuleIdentity property (for example, 16752869479666417665). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). + +```yaml +Type: InboxRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AlwaysDeleteOutlookRulesBlob +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Enable-JournalRule.md b/exchange/exchange-ps/exchange/Enable-JournalRule.md new file mode 100644 index 0000000000..a642ee6b6f --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-JournalRule.md @@ -0,0 +1,131 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-JournalRule cmdlet to enable an existing journal rule on a Mailbox server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-JournalRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-JournalRule "Brokerage Communications" +``` + +This example enables the existing journal rule Brokerage Communications. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/users-and-groups/Enable-MailContact.md b/exchange/exchange-ps/exchange/Enable-MailContact.md similarity index 80% rename from exchange/exchange-ps/exchange/users-and-groups/Enable-MailContact.md rename to exchange/exchange-ps/exchange/Enable-MailContact.md index e66e67a52e..32afb576cd 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Enable-MailContact.md +++ b/exchange/exchange-ps/exchange/Enable-MailContact.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-MailContact @@ -13,27 +16,34 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MailContact cmdlet to add email capabilities to existing contacts that aren't already mail-enabled. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Enable-MailContact [-Identity] -ExternalEmailAddress [-Alias ] - [-Confirm] [-DisplayName ] [-DomainController ] - [-MacAttachmentFormat ] - [-MessageBodyFormat ] [-MessageFormat ] - [-PrimarySmtpAddress ] [-UsePreferMessageFormat <$true | $false>] [-WhatIf] [] +Enable-MailContact [-Identity] -ExternalEmailAddress + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-MacAttachmentFormat ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-PrimarySmtpAddress ] + [-UsePreferMessageFormat ] + [-WhatIf] + [] ``` ## DESCRIPTION The Enable-MailContact cmdlet mail-enables existing contacts by adding the email attributes that are required by Exchange. Mail contacts are visible to the other \*-MailContact 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-MailContact -Identity Roland -ExternalEmailAddress "roland@tailspintoys.com" ``` @@ -41,62 +51,61 @@ This example mail-enables an existing contact that isn't mail-enabled. ## PARAMETERS -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. +### -Identity +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: -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. +- Name +- Distinguished name (DN) +- Canonical DN +- GUID ```yaml -Type: ProxyAddress +Type: ContactIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN +### -ExternalEmailAddress +The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. -- GUID +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: ContactIdParameter +Type: ProxyAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipeints without user accounts (for example, room mailboxes, mail contacts and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -107,6 +116,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -117,8 +127,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -126,6 +135,7 @@ 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 @@ -141,6 +151,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -156,6 +167,7 @@ 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 @@ -167,24 +179,21 @@ Accept wildcard characters: False 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) - - UuEncode - - AppleSingle - - AppleDouble The MacAttachmentFormat and MessageFormat parameters are interdependent: - MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. - - MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. ```yaml -Type: BinHex | UuEncode | AppleSingle | AppleDouble +Type: MacAttachmentFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -196,22 +205,20 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. ```yaml -Type: Text | Html | TextAndHtml +Type: MessageBodyFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -223,22 +230,21 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. ```yaml -Type: Text | Mime +Type: MessageFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -247,7 +253,7 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. +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. @@ -258,6 +264,7 @@ Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -269,14 +276,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -292,6 +299,7 @@ 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 @@ -300,20 +308,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0accff85-3a03-4068-81e2-0508a4df21ec.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md b/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md new file mode 100644 index 0000000000..a029579014 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md @@ -0,0 +1,200 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-MailPublicFolder cmdlet to mail-enable public folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-MailPublicFolder [-Identity] + [-Confirm] + [-DomainController ] + [-HiddenFromAddressListsEnabled ] + [-OverrideRecipientQuotas] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-MailPublicFolder "\My Public Folder" +``` + +This example mail-enables the top-level public folder My Public Folder. + +### Example 2 +```powershell +Enable-MailPublicFolder "\Marketing\Reports" +``` + +This example mail-enables the public folder Reports that's in the parent folder Marketing. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -HiddenFromAddressListsEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideRecipientQuotas +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/users-and-groups/Enable-MailUser.md b/exchange/exchange-ps/exchange/Enable-MailUser.md similarity index 81% rename from exchange/exchange-ps/exchange/users-and-groups/Enable-MailUser.md rename to exchange/exchange-ps/exchange/Enable-MailUser.md index 6a33026162..0a00e13f2c 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Enable-MailUser.md +++ b/exchange/exchange-ps/exchange/Enable-MailUser.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-MailUser @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MailUser cmdlet to mail-enable existing users that aren't already mail-enabled. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,23 +27,26 @@ Enable-MailUser [-Identity] -ExternalEmailAddress ] [-DomainController ] - [-MacAttachmentFormat ] - [-MessageBodyFormat ] - [-MessageFormat ] + [-MacAttachmentFormat ] + [-MessageBodyFormat ] + [-MessageFormat ] [-PrimarySmtpAddress ] - [-UsePreferMessageFormat <$true | $false>] - [-WhatIf] [] + [-UsePreferMessageFormat ] + [-WhatIf] + [] ``` ### EnableGuestUser ``` -Enable-MailUser [-Identity] [-ExternalEmailAddress ] +Enable-MailUser [-Identity] + [-ExternalEmailAddress ] [-Alias ] [-Confirm] [-DisplayName ] [-DomainController ] [-PrimarySmtpAddress ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -48,12 +54,12 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-MailUser -Identity John -ExternalEmailAddress john@contoso.com ``` @@ -62,18 +68,11 @@ This example mail-enables user John with the external email address john@contoso ## PARAMETERS ### -Identity -The Identity parameter specifies the user that you want to mail-enable. You can use any value that uniquely identifies the user. - -For example: +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 - -- Display name - - Distinguished name (DN) - - Canonical DN - - GUID ```yaml @@ -81,6 +80,7 @@ Type: UserIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -96,6 +96,7 @@ Type: ProxyAddress Parameter Sets: EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -108,6 +109,7 @@ Type: ProxyAddress Parameter Sets: EnableGuestUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -116,17 +118,21 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -137,6 +143,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -147,8 +154,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -156,6 +162,7 @@ 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 @@ -171,6 +178,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -186,6 +194,7 @@ 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 @@ -197,24 +206,21 @@ Accept wildcard characters: False 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) - - UuEncode - - AppleSingle - - AppleDouble The MacAttachmentFormat and MessageFormat parameters are interdependent: - MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. - - MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle or AppleDouble. ```yaml -Type: BinHex | UuEncode | AppleSingle | AppleDouble +Type: MacAttachmentFormat Parameter Sets: EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -226,22 +232,20 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. ```yaml -Type: Text | Html | TextAndHtml +Type: MessageBodyFormat Parameter Sets: EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -253,22 +257,21 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. ```yaml -Type: Text | Mime +Type: MessageFormat Parameter Sets: EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -277,7 +280,7 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. +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. @@ -288,6 +291,7 @@ Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -299,14 +303,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -322,6 +326,7 @@ 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 @@ -330,20 +335,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1a6e86d0-09d8-4570-bf43-7ae6f1386c78.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/exchange/Enable-Mailbox.md new file mode 100644 index 0000000000..3a49c7ac0c --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-Mailbox.md @@ -0,0 +1,1035 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-Mailbox cmdlet to create mailboxes for existing users who don't already have mailboxes. You can also use this cmdlet to create In-Place archives for existing mailboxes. + +**Note**: In Exchange Online, you use this cmdlet to add archive mailboxes for existing users and to enable auto-expanding archives. To add a mailbox for an existing Microsoft Entra account, you need to add a license to the account as described in [Assign licenses to user accounts](https://learn.microsoft.com/office365/enterprise/powershell/assign-licenses-to-user-accounts-with-office-365-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Arbitration +``` +Enable-Mailbox [-Identity] [-Arbitration] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### RemoteArchive +``` +Enable-Mailbox [-Identity] -ArchiveDomain + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RemoteArchive] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### Discovery +``` +Enable-Mailbox [-Identity] [-Discovery] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### Equipment +``` +Enable-Mailbox [-Identity] [-Equipment] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### LinkedRoomMailbox +``` +Enable-Mailbox [-Identity] -LinkedDomainController -LinkedMasterAccount + [-LinkedCredential ] + [-LinkedRoom] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-ArchiveGuid ] + [-ArchiveName ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### Linked +``` +Enable-Mailbox [-Identity] -LinkedDomainController -LinkedMasterAccount + [-LinkedCredential ] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### PublicFolder +``` +Enable-Mailbox [-Identity] [-PublicFolder] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-HoldForMigration] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### Room +``` +Enable-Mailbox [-Identity] [-Room] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### Shared +``` +Enable-Mailbox [-Identity] [-Shared] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### User +``` +Enable-Mailbox [-Identity] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### Archive +``` +Enable-Mailbox [-Identity] ] [-Archive] + [-ArchiveDatabase ] + [-ArchiveGuid ] + [-ArchiveName ] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-Force] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### AuditLog +``` +Enable-Mailbox [-Identity] [-AuditLog] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-PrimarySmtpAddress ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +### AutoExpandingArchive +``` +Enable-Mailbox [-Identity] [-AutoExpandingArchive] + [-Confirm] + [-Force] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Enable-Mailbox cmdlet mailbox-enables existing users, public folders, or InetOrgPerson objects by adding the mailbox attributes that are required by Exchange. When the user logs on to the mailbox or receives email messages, the mailbox object is actually created in the Exchange database. + +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). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. + +## EXAMPLES + +### Example 1 +```powershell +Enable-Mailbox -Identity Ayla +``` + +This example creates a mailbox for the existing user named Ayla. + +### Example 2 +```powershell +Enable-Mailbox -Identity Ayla -Archive +``` + +This example creates an In-Place archive for the existing username Ayla who already has a mailbox. + +### Example 3 +```powershell +Enable-Mailbox -Identity ayla@contoso.com -RemoteArchive -ArchiveDomain "archive.contoso.com" +``` + +This example creates a remote archive for the existing on-premises user named Ayla. The archive is created in the cloud-based organization that uses the domain archive.contoso.com. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow. + +```yaml +Type: SwitchParameter +Parameter Sets: Arbitration +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +Only use this parameter if the archive is hosted in the cloud-based service. + +```yaml +Type: SmtpDomain +Parameter Sets: RemoteArchive +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Discovery +This parameter is available only in on-premises Exchange. + +The Discovery switch is required to mailbox-enable Discovery mailboxes. You don't need to specify a value with this switch. + +Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). + +```yaml +Type: SwitchParameter +Parameter Sets: Discovery +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Equipment +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. + +Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). + +```yaml +Type: SwitchParameter +Parameter Sets: Equipment +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +This parameter is required only if you're enabling a linked mailbox. + +```yaml +Type: String +Parameter Sets: LinkedRoomMailbox, Linked +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedMasterAccount +This parameter is available only in on-premises Exchange. + +The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +This parameter is required only if you're enabling a linked mailbox. + +```yaml +Type: UserIdParameter +Parameter Sets: LinkedRoomMailbox, Linked +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedRoom +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. + +A linked resource mailbox is useful in a scenario where you have an account in an authentication forest and you want it to be directly linked to a resource mailbox in resource forest. + +```yaml +Type: SwitchParameter +Parameter Sets: LinkedRoomMailbox +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +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. + +Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Room +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. + +Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). + +```yaml +Type: SwitchParameter +Parameter Sets: Room +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +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. + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncMailboxPolicy +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:. + +- Name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default mobile device mailbox policy is applied to the mailbox. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressBookPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). + +```yaml +Type: AddressBookMailboxPolicyIdParameter +Parameter Sets: User +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 +``` + +### -Alias +This parameter is available only in on-premises Exchange. + +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Archive +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 +``` + +### -ArchiveGuid +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: Archive +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 +``` + +### -ArchiveName +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: + +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Exchange Online, if you don't use this parameter, the default value is `In-Place Archive -`. + +In Outlook in Exchange Online, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Archive +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLog +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: AuditLog +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoExpandingArchive +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. + +After you enable auto-expanding archiving, additional storage space is automatically added to the user's archive mailbox when it approaches the storage limit. + +**Notes**: + +- The user's archive mailbox has to be enabled before auto-expanding archiving can be enabled. +- After you enable auto-expanding archiving for the user's mailbox, it can't be disabled. + +```yaml +Type: SwitchParameter +Parameter Sets: AutoExpandingArchive +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 ("). + +If you don't use DisplayName parameter, the value of the Name property is used for the display name. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldForMigration +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. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder +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 +``` + +### -LinkedCredential +This parameter is available only in on-premises Exchange. + +The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: LinkedRoomMailbox, Linked +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 +``` + +### -ManagedFolderMailboxPolicy +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. + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderMailboxPolicyAllowed +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. + +When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed switch is used. + +Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM. + +```yaml +Type: SwitchParameter +Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +This parameter is available only in on-premises Exchange. + +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. + +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteArchive +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. + +You need to use this parameter with the ArchiveDomain parameter, and you can't use this parameter with the Archive parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: RemoteArchive +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 +``` + +### -RetentionPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentPolicy +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 +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default role assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of $null. For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mailbox-databases-and-servers/Enable-MailboxQuarantine.md b/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md similarity index 81% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Enable-MailboxQuarantine.md rename to exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md index e3c2dc5241..94f1b1b2d7 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Enable-MailboxQuarantine.md +++ b/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-MailboxQuarantine @@ -13,44 +16,49 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MailboxQuarantine cmdlet to quarantine mailboxes that affect the availability of the mailbox database. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### MailboxIdentity +### MailboxIdentity ``` Enable-MailboxQuarantine [-Identity] [-AllowMigration] [-Confirm] [-Duration ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### MailboxOrMailUserIdentity ``` -Enable-MailboxQuarantine [-Identity] [-QuarantineReason ] +Enable-MailboxQuarantine [-Identity] + [-QuarantineReason ] [-AllowMigration] [-Confirm] [-Duration ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### StoreMailboxIdentity ``` -Enable-MailboxQuarantine -Database -StoreMailboxIdentity [-QuarantineReason ] +Enable-MailboxQuarantine -Database -StoreMailboxIdentity + [-QuarantineReason ] [-AllowMigration] [-Confirm] [-Duration ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-MailboxQuarantine "Brian Johnson" ``` @@ -59,30 +67,17 @@ This example quarantines the mailbox for the user Brian Johnson. ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox that you want to quarantine. You can use any value that uniquely identifies the mailbox. - -For example: +The Identity parameter specifies the mailbox that you want to quarantine. You can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) You can't use this parameter with the Database parameter. @@ -92,6 +87,7 @@ Type: GeneralMailboxIdParameter Parameter Sets: MailboxIdentity Aliases: Applicable: Exchange Server 2013 + Required: True Position: 1 Default value: None @@ -104,6 +100,7 @@ Type: GeneralMailboxOrMailUserIdParameter Parameter Sets: MailboxOrMailUserIdentity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -115,9 +112,7 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID You identify the mailbox by using the StoreMailboxIdentity parameter. @@ -129,6 +124,7 @@ Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -148,6 +144,7 @@ Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -156,7 +153,7 @@ Accept wildcard characters: False ``` ### -AllowMigration -The AllowMigration switch allows a quarantined mailbox to be moved to another mailbox database or to the cloud. You don't have to specify a value with this switch. +The AllowMigration switch allows a quarantined mailbox to be moved to another mailbox database or to the cloud. You don't need to specify a value with this switch. Moving a mailbox is one method of correcting data corruption that's required before releasing the mailbox from quarantine. @@ -165,6 +162,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -175,15 +173,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -201,6 +201,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -216,6 +217,7 @@ Type: String Parameter Sets: StoreMailboxIdentity, MailboxOrMailUserIdentity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -231,6 +233,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -239,20 +242,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/68bb689f-10e4-4fd0-9db4-6f00a55278d2.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Enable-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md similarity index 76% rename from exchange/exchange-ps/exchange/antispam-antimalware/Enable-MalwareFilterRule.md rename to exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md index de564f4d0b..d671effeae 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Enable-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-MalwareFilterRule @@ -13,22 +16,25 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-MalwareFilterRule cmdlet to enable malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Enable-MalwareFilterRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Enable-MalwareFilterRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-MalwareFilterRule "Contoso Recipients" ``` @@ -44,6 +50,7 @@ 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 Default value: None @@ -54,8 +61,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +69,7 @@ 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 Default value: None @@ -80,6 +87,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,6 +103,7 @@ 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 Default value: None @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1310fac0-7451-4b74-bca2-3398d6dd1e73.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md new file mode 100644 index 0000000000..642a0ec9b8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md @@ -0,0 +1,111 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-MetaCacheDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-MetaCacheDatabase cmdlet to enable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-MetaCacheDatabase -Server + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-MetaCacheDatabase -Server Mailbox01 +``` + +This example enables the metacache database on the Exchange server named Mailbox01. + +## PARAMETERS + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). For example, "Server1","Server2"..."ServerN". + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md new file mode 100644 index 0000000000..23f178be9e --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-OrganizationCustomization + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-OrganizationCustomization [-Confirm] + [-WhatIf] + [] +``` + +## 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. + +Here are some examples of when you might see this: + +- Creating a new role group or creating a new management role assignment. +- Creating a new role assignment policy or modifying a built-in role assignment policy. +- Creating a new Outlook on the web mailbox policy or modifying a built-in Outlook on the web mailbox policy. +- Creating a new sharing policy or modifying a built-in sharing policy. +- Creating a new retention policy or modifying a built-in retention policy. +- Enabling preset security policies in the Microsoft Defender portal. + +Note that you are only required to run the Enable-OrganizationCustomization cmdlet once in your Exchange Online organization. If you attempt to run the cmdlet again, you'll get an error. + +Whether or not this command has been previously run in an organization is available in the IsDehydrated property of the Get-OrganizationConfig cmdlet: False ($false) = the command has already been run; True ($true) = the command has never been run. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-OrganizationCustomization +``` + +This example runs the command as required. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/client-access-servers/Enable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access-servers/Enable-OutlookAnywhere.md rename to exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md index 0d5ec03f1e..f2706fde72 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Enable-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-OutlookAnywhere @@ -13,64 +16,67 @@ This cmdlet is available only in Exchange Server 2010. Use the Enable-OutlookAnywhere cmdlet to enable Outlook Anywhere on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed. Running the Enable-OutlookAnywhere cmdlet enables the server to accept requests from Microsoft Office Outlook 2007 and Outlook 2003 client computers from the Internet by using Outlook Anywhere, also known as RPC over HTTP. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### CustomIdentity ``` -Enable-OutlookAnywhere -ClientAuthenticationMethod - -ExternalHostname -SSLOffloading <$true | $false> [-IISAuthenticationMethods ] +Enable-OutlookAnywhere -ClientAuthenticationMethod -ExternalHostname -SSLOffloading + [-IISAuthenticationMethods ] [-Confirm] [-DomainController ] [-ExtendedProtectionFlags ] [-ExtendedProtectionSPNList ] - [-ExtendedProtectionTokenChecking ] + [-ExtendedProtectionTokenChecking ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### DefaultIdentity ``` -Enable-OutlookAnywhere -DefaultAuthenticationMethod - -ExternalHostname -SSLOffloading <$true | $false> +Enable-OutlookAnywhere -DefaultAuthenticationMethod -ExternalHostname -SSLOffloading [-Confirm] [-DomainController ] [-ExtendedProtectionFlags ] [-ExtendedProtectionSPNList ] - [-ExtendedProtectionTokenChecking ] + [-ExtendedProtectionTokenChecking ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -The Enable-OutlookAnywhere cmdlet enables the Exchange 2010 Client Access server for Outlook Anywhere. This lets the server accept requests from Outlook 2007 and Outlook 2003 clients from the Internet by using Outlook Anywhere. +Enabling Outlook Anywhere on the Client Access server allows the server to accept external connections by Outlook 2003 or later clients by using Outlook Anywhere. This cmdlet can be successfully run only if the RPC over HTTP proxy Windows networking component is already installed. 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. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +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). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-OutlookAnywhere -Server:Server01 -ExternalHostname:mail.contoso.com -ClientAuthenticationMethod:Ntlm -SSLOffloading:$true ``` This example enables the server Server01 for Outlook Anywhere. The external host name is set to mail.contoso.com, both Basic and NTLM authentication are used, and SSL offloading is set to $true. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Enable-OutlookAnywhere -DefaultAuthenticationMethod:Ntlm -ExternalHostname:mail.contoso.com -SSLOffloading:$false ``` This example enables Outlook Anywhere on the server that has the Client Access role installed. The SSLOffloading parameter is set to $false, the ExternalHostname parameter is specified as mail.contoso.com, and the DefaultAuthenticationMethod parameter is set to NTLM. -### -------------------------- Example 3 -------------------------- -``` -Enable-Outlookanywhere -IISAuthenticationMethods NTLM -SSlOffloading:$false -ClientAuthenticationMethod:Basic -ExternalHostname:mail.contoso.com +### Example 3 +```powershell +Enable-OutlookAnywhere -IISAuthenticationMethods NTLM -SSlOffloading:$false -ClientAuthenticationMethod:Basic -ExternalHostname:mail.contoso.com ``` This example enables the Exchange Client Access server for Outlook Anywhere. The SSLOffloading parameter is set to $false, the ExternalHostname parameter is set to mail.contoso.com, the IISAuthenticationMethods parameter is set to NTLM, and the ClientAuthenticationMethod parameter is set to Basic. @@ -81,7 +87,6 @@ This example enables the Exchange Client Access server for Outlook Anywhere. The 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 - - Ntlm 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. @@ -89,10 +94,11 @@ This parameter must be specified if you don't use the DefaultAuthenticationMetho Although this parameter only allows setting one authentication method, the command won't return an error if you include multiple values. ```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured +Type: AuthenticationMethod Parameter Sets: CustomIdentity Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -106,16 +112,16 @@ The DefaultAuthenticationMethod parameter specifies whether to set both the Clie 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: - Basic - - Ntlm If the DefaultAuthenticationMethod parameter is specified, neither the ClientAuthenticationMethod nor the IISAuthenticationMethods parameter can be used. ```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured +Type: AuthenticationMethod Parameter Sets: DefaultIdentity Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -131,6 +137,7 @@ Type: Hostname Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -142,10 +149,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -156,8 +164,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -165,6 +172,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -180,6 +188,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -190,21 +199,18 @@ Accept wildcard characters: False ### -ExtendedProtectionFlags 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. - -- 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. +- 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. +- 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. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -218,14 +224,14 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi The possible values are: - Null This is the default value. - -- 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 \/\. For example, a valid entry could be HTTP/mail.contoso.com. +- 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 Default value: None @@ -237,7 +243,6 @@ Accept wildcard characters: False 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. 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. @@ -246,13 +251,14 @@ If you have a proxy server between the client and the Client Access server that' If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList. -To learn more about Extended Protection for Authentication, see Understanding Extended Protection for Authentication. +To learn more about Extended Protection for Authentication, see [Understanding Extended Protection for Authentication](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/ff459225(v=exchg.141)). ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -274,6 +280,7 @@ Type: MultiValuedProperty Parameter Sets: CustomIdentity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -282,13 +289,19 @@ Accept wildcard characters: False ``` ### -Server -The Server parameter specifies the name of the Client Access server to be enabled for Outlook Anywhere. +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -304,6 +317,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -312,20 +326,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e5e30ed6-cc78-4e0c-b200-3160ccb77deb.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md new file mode 100644 index 0000000000..63e2c39801 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-OutlookProtectionRule + +## 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. + +Use the Enable-OutlookProtectionRule cmdlet to enable an existing Outlook protection rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-OutlookProtectionRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-OutlookProtectionRule -Identity "Project Contoso" +``` + +This example enables the Outlook protection rule Project Contoso. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Enable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md new file mode 100644 index 0000000000..e23369448c --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md @@ -0,0 +1,138 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-PushNotificationProxy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-PushNotificationProxy cmdlet to enable a push notification proxy between an on-premises Microsoft Exchange organization and a Microsoft 365 organization. + +In order for event notifications to be successfully delivered, you also need to configure OAuth authentication between your on-premises Exchange organization and your Microsoft 365 organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-PushNotificationProxy [-Confirm] + [-Organization ] + [-Uri ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-PushNotificationProxy -WhatIf +``` + +This example displays the status of the push notification proxy in the on-premises Exchange organization. + +### Example 2 +```powershell +Enable-PushNotificationProxy -Organization contoso.onmicrosoft.com +``` + +This example enables the push notification proxy in the on-premises Exchange organization by using the Microsoft 365 organization contoso.onmicrosoft.com. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +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 +``` + +### -Organization +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Enable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md new file mode 100644 index 0000000000..e2ca574784 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md @@ -0,0 +1,422 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-RemoteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-RemoteMailbox cmdlet to create a mailbox in the cloud-based service for an existing user in the on-premises Active Directory. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Enable-RemoteMailbox [-Identity] + [-RemoteRoutingAddress ] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-PrimarySmtpAddress ] + [-WhatIf] + [] +``` + +### Room +``` +Enable-RemoteMailbox [-Identity] + [-Room] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-PrimarySmtpAddress ] + [-RemoteRoutingAddress ] + [-WhatIf] + [] +``` + +### Equipment +``` +Enable-RemoteMailbox [-Identity] + [-Equipment] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-PrimarySmtpAddress ] + [-RemoteRoutingAddress ] + [-WhatIf] + [] +``` + +### Archive +``` +Enable-RemoteMailbox [-Identity] + [-Archive] + [-ArchiveName ] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-PrimarySmtpAddress ] + [-WhatIf] + [] +``` + +### Shared +``` +Enable-RemoteMailbox [-Identity] + [-Shared] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-PrimarySmtpAddress ] + [-RemoteRoutingAddress ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Enable-RemoteMailbox cmdlet mail-enables an existing on-premises user. The mail-enabled user contains a specific attribute that indicates that an associated mailbox in the service should be created when the user is synchronized to the service using directory synchronization. + +Directory synchronization must be configured correctly for a mailbox to be created in the service. Creation of the mailbox in the service isn't immediate and depends on the directory synchronization schedule. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-RemoteMailbox "Kim Akers" -RemoteRoutingAddress "kima@contoso.mail.onmicrosoft.com" +``` + +This example mail-enables an existing on-premises user and creates an associated mailbox in the service. + +After the user is mail-enabled, directory synchronization synchronizes the mail-enabled user to the service and the associated mailbox is created. + +### Example 2 +```powershell +Enable-RemoteMailbox "Kim Akers" -RemoteRoutingAddress "kima@contoso.mail.onmicrosoft.com" + +Enable-RemoteMailbox "Kim Akers" -Archive +``` + +This example does the following: + +Mail-enables an existing on-premises user. + +Creates the associated mailbox in the service. + +Creates an archive mailbox in the service for the mailbox. + +To mail-enable an on-premises user, create the associated mailbox in the service, enable the archive mailbox in the service and include the Archive switch with the Enable-RemoteMailbox cmdlet. + +## PARAMETERS + +### -Identity +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 +- GUID +- Distinguished name (DN) +- Domain\\Username +- User principal name (UPN) +- LegacyExchangeDN +- User alias + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Equipment +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). + +You can't use this switch with the Room or Shared switches. + +```yaml +Type: SwitchParameter +Parameter Sets: Equipment, Shared +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 this switch with the Equipment or Shared switches. + +```yaml +Type: SwitchParameter +Parameter Sets: Room +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +**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. + +You can't use this switch with the Room or Equipment switches. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +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 +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveName +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +If you don't use this parameter, the following default values are used based on the version of Exchange: + +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Outlook, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Archive +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 +``` + +### -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 +``` + +### -DisplayName +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 +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 +``` + +### -PrimarySmtpAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteRoutingAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Enable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md new file mode 100644 index 0000000000..9bf1aa79ac --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-reportsubmissionrule +applicable: Exchange Online +title: Enable-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-ReportSubmissionRule cmdlet to enable the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-ReportSubmissionRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-ReportSubmissionRule -Identity DefaultReportSubmissionRule. +``` + +This example enables the report submission rule if it's already disabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to enable. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md new file mode 100644 index 0000000000..2642212149 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-SafeAttachmentRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-SafeAttachmentRule cmdlet to enable safe attachment rules in your cloud-based organization. This cmdlet is also responsible for disabling complete Safe Attachments policies in the admin center, which consist of the safe attachment rule and the corresponding assigned safe attachment policy in PowerShell. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-SafeAttachmentRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-SafeAttachmentRule -Identity "Marketing Department Attachment Rule" +``` + +This example enables the disabled safe attachment rule named Marketing Department Attachment Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md new file mode 100644 index 0000000000..1314b22664 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-SafeLinksRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-SafeLinksRule cmdlet to enable disabled Safe Links rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-SafeLinksRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-SafeLinksRule -Identity "Marketing Department URL Rule" +``` + +This example enables the disabled Safe Links rule named Marketing Department URL Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md new file mode 100644 index 0000000000..206921ec6f --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md @@ -0,0 +1,156 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-ServiceEmailChannel + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-ServiceEmailChannel cmdlet to enable the .NET service channel for a specific user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-ServiceEmailChannel [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-ServiceEmailChannel -Identity "fourthcoffee\tony" +``` + +This example enables the .NET service channel for the user Tony Smith. + +### Example 2 +```powershell +Enable-ServiceEmailChannel -Identity "tony@contoso.com" +``` + +This example enables the .NET service channel for the user Tony Smith. + +### Example 3 +```powershell +Enable-ServiceEmailChannel -Identity "TonySmith" +``` + +This example enables the .NET service channel for the user Tony Smith. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 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 +``` + +### -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/Enable-SmtpDaneInbound.md b/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md new file mode 100644 index 0000000000..84502bb3b4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-smtpdaneinbound +applicable: Exchange Online +title: Enable-SmtpDaneInbound +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-SmtpDaneInbound + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-SMTPDaneInbound cmdlet to enable SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-SmtpDaneInbound [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-SmtpDaneInbound -DomainName contoso.com +``` + +This example enables SMTP DANE for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to enable SMTP DANE (for example, contoso.com). Use the Get-AcceptedDomain cmdlet to see the accepted domains in the organization. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-SweepRule.md b/exchange/exchange-ps/exchange/Enable-SweepRule.md new file mode 100644 index 0000000000..a5d16d3d5f --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-SweepRule.md @@ -0,0 +1,162 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-SweepRule cmdlet to enable Sweep rules in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-SweepRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" +``` + +This example enables the specified Sweep rule. + +### Example 2 +```powershell +Get-SweepRule -Mailbox laura@contoso.com | Enable-SweepRule +``` + +This example enables all Sweep rules in the specified mailbox. + +## PARAMETERS + +### -Identity +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==). +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). + +```yaml +Type: SweepRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: 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 Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Enable-TransportAgent.md b/exchange/exchange-ps/exchange/Enable-TransportAgent.md similarity index 76% rename from exchange/exchange-ps/exchange/mail-flow/Enable-TransportAgent.md rename to exchange/exchange-ps/exchange/Enable-TransportAgent.md index 04e6d386db..1985292cfa 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Enable-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Enable-TransportAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-TransportAgent @@ -13,22 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-TransportAgent cmdlet to enable a transport agent. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Enable-TransportAgent [-Identity] [-Confirm] [-DomainController ] [-WhatIf] - [-TransportService ] [] +Enable-TransportAgent [-Identity] + [-Confirm] + [-DomainController ] + [-TransportService ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-TransportAgent "Test App" -TransportService Hub ``` @@ -44,6 +51,7 @@ Type: TransportAgentObjectId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,8 +62,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +70,7 @@ 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 @@ -80,21 +88,7 @@ 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 -``` -### -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 @@ -106,20 +100,33 @@ Accept wildcard characters: False 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. - - MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - - MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - - FrontEnd for the Front End Transport service on Mailbox servers. - - Edge on Edge Transport servers. ```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery +Type: TransportService Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 @@ -128,20 +135,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e1022587-f9b6-4ff5-8970-73465e55a34d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Enable-TransportRule.md b/exchange/exchange-ps/exchange/Enable-TransportRule.md similarity index 77% rename from exchange/exchange-ps/exchange/policy-and-compliance/Enable-TransportRule.md rename to exchange/exchange-ps/exchange/Enable-TransportRule.md index f6abef23b1..4f9a620693 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Enable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Enable-TransportRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-TransportRule @@ -13,31 +16,35 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-TransportRule cmdlet to enable transport rules (mail flow rules) in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Enable-TransportRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] - [-Mode ] [] +Enable-TransportRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mode ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-TransportRule -Identity "Disclaimer-Finance" ``` This example enables the transport rule named Disclaimer Finance. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Enable-TransportRule -Identity "Require approval of messages to contoso.com" -Mode Audit ``` @@ -49,9 +56,7 @@ This example enables the transport rule named "Require approval of messages to c The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name - - Distinguished name (DN) - - GUID ```yaml @@ -59,6 +64,7 @@ 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 Default value: None @@ -69,8 +75,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -78,6 +83,7 @@ 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 @@ -97,6 +103,7 @@ 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 @@ -104,14 +111,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -Mode +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. +- 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. ```yaml -Type: SwitchParameter +Type: RuleMode Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -119,20 +133,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Mode -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. - -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. - -- Enforce: All actions specified in the rule are taken. This is the default value. +### -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: Audit | AuditAndNotify | Enforce +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +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 @@ -141,20 +150,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/203d2fa8-83fe-4643-bbc2-db746ffd76a7.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md new file mode 100644 index 0000000000..b5a6029718 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-UMAutoAttendant + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-UMAutoAttendant cmdlet to enable an existing Unified Messaging (UM) auto attendant that's disabled. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-UMAutoAttendant [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-UMAutoAttendant -Identity MyUMAutoAttendant +``` + +This example enables the UM auto attendant MyUMAutoAttendant. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Enable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md new file mode 100644 index 0000000000..871ebf54fd --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md @@ -0,0 +1,175 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-UMCallAnsweringRule + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-UMCallAnsweringRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Enable-UMCallAnsweringRule cmdlet enables the call answering rule by modifying its status variable. When the call answering rule is created, it's enabled. This cmdlet allows you to enable a previously disabled call answering rule. Enabling a call answering rule enables the cmdlet to retrieve the call answering rule including the conditions and actions for a specified call answering rule. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith +``` + +This example enables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith. + +### Example 2 +```powershell +Enable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -WhatIf +``` + +The example uses the WhatIf switch to test whether the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith is ready to be enabled and if there are any errors within the command. + +### Example 3 +```powershell +Enable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -Confirm +``` + +This example enables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith and prompts the logged-on user to confirm that the call answering rule is to be enabled. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the mailbox of the user who is running the command is used. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Enable-UMIPGateway.md b/exchange/exchange-ps/exchange/Enable-UMIPGateway.md new file mode 100644 index 0000000000..2b49427750 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-UMIPGateway.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-UMIPGateway + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-UMIPGateway cmdlet to enable a Unified Messaging (UM) IP gateway. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-UMIPGateway [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The status variable for a UM IP gateway can be used to enable or disable call answering destined for the IP gateway. The Enable-UMIPGateway cmdlet enables a UM IP gateway in Active Directory by modifying its status variable. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-UMIPGateway -Identity MyUMIPGateway +``` + +This example enables the UM IP gateway MyUMIPGateway. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/unified-messaging/Enable-UMMailbox.md b/exchange/exchange-ps/exchange/Enable-UMMailbox.md similarity index 77% rename from exchange/exchange-ps/exchange/unified-messaging/Enable-UMMailbox.md rename to exchange/exchange-ps/exchange/Enable-UMMailbox.md index e1ac5d0210..64d7a8d5d7 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Enable-UMMailbox.md @@ -1,26 +1,29 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/enable-ummailbox +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Enable-UMMailbox schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-UMMailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Enable-UMMailbox cmdlet to enable Unified Messaging (UM) for existing mailbox users. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Identity (Default) +### Identity (Default) ``` Enable-UMMailbox [-Identity] -UMMailboxPolicy - [-AutomaticSpeechRecognitionEnabled <$true | $false>] + [-AutomaticSpeechRecognitionEnabled ] [-Confirm] [-DomainController ] [-Extensions ] @@ -28,16 +31,18 @@ Enable-UMMailbox [-Identity] -UMMailboxPolicy ] [-PilotNumber ] [-PIN ] - [-PINExpired <$true | $false>] + [-PINExpired ] [-SIPResourceIdentifier ] [-ValidateOnly] - [-WhatIf] [] + [-WhatIf] + [] ``` ### CloudVoiceMail ``` -Enable-UMMailbox [-Identity] [-EnableCloudVoiceMail] - [-AutomaticSpeechRecognitionEnabled <$true | $false>] +Enable-UMMailbox [-Identity] + [-EnableCloudVoiceMail] + [-AutomaticSpeechRecognitionEnabled ] [-Confirm] [-DomainController ] [-Extensions ] @@ -45,30 +50,31 @@ Enable-UMMailbox [-Identity] [-EnableCloudVoiceMail] [-NotifyEmail ] [-PilotNumber ] [-Pin ] - [-PinExpired <$true | $false>] - [-SendWelcomeMail <$true | $false>] + [-PinExpired ] + [-SendWelcomeMail ] [-SIPResourceIdentifier ] [-UMMailboxPolicy ] [-ValidateOnly] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-UMMailbox -Identity tonysmith@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -NotifyEmail administrator@contoso.com -PINExpired $true ``` This example enables Unified Messaging on the mailbox for tonysmith@contoso.com, sets the extension and PIN for the user that must be changed when the user logs on to Outlook Voice Access, assigns the UM mailbox policy MyUMMailboxPolicy to the user's mailbox, and then sends an email message that contains the Unified Messaging welcome information to administrator@contoso.com. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Enable-UMMailbox -Identity tonysmith@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -SIPResourceIdentifier "tonysmith@contoso.com" -PINExpired $true ``` @@ -77,37 +83,25 @@ This example enables Unified Messaging on a SIP-enabled mailbox for tonysmith@co ## PARAMETERS ### -Identity -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: 1 Default value: None @@ -119,16 +113,15 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID ```yaml Type: MailboxPolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -140,7 +133,8 @@ Accept wildcard characters: False Type: MailboxPolicyIdParameter Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -152,14 +146,14 @@ Accept wildcard characters: False 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. - - $false: ASR is disabled for the mailbox. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -170,15 +164,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -187,15 +181,14 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -210,7 +203,8 @@ The EnableCloudVoiceMail switch specifies whether to enable the mailbox for UM i Type: SwitchParameter Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016 + Required: True Position: Named Default value: None @@ -227,7 +221,8 @@ 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, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -236,21 +231,19 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -265,7 +258,8 @@ The NotifyEmail parameter specifies the email address where the Unified Messagin Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -280,7 +274,8 @@ The PilotNumber parameter specifies the subscriber access number users can dial Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -297,7 +292,8 @@ 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, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -309,14 +305,14 @@ Accept wildcard characters: False 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. - - $false: The user isn't required to reset their PIN the next time they log on. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -328,14 +324,14 @@ Accept wildcard characters: False The SendWelcomeMail parameter specifies whether you want to send a welcome message after the mailbox has been enabled for UM. Valid values are: - $true: Send the welcome to UM message. - - $false: Don't send the welcome to UM message. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016 + Required: False Position: Named Default value: None @@ -350,7 +346,8 @@ The SIPResourceIdentifier parameter specifies the SIP address or E.164 address f Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -359,13 +356,16 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used. +The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. + +No changes are made when the ValidateOnly switch is used. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -380,7 +380,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -389,20 +390,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5391a63c-ca60-498c-8358-5f0667140738.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMServer.md b/exchange/exchange-ps/exchange/Enable-UMServer.md similarity index 76% rename from exchange/exchange-ps/exchange/unified-messaging/Enable-UMServer.md rename to exchange/exchange-ps/exchange/Enable-UMServer.md index 5faeaeb2fb..01417d0e76 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMServer.md +++ b/exchange/exchange-ps/exchange/Enable-UMServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Enable-UMServer @@ -13,12 +16,15 @@ This cmdlet is available only in Exchange Server 2010. Use the Enable-UMServer cmdlet to set the status of a Unified Messaging (UM) server to enabled. This enables the Unified Messaging server to process UM calls. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Enable-UMServer [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Enable-UMServer [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` @@ -27,12 +33,12 @@ The Enable-UMServer cmdlet sets the status of a Unified Messaging server. A UM s After this task is completed, the Unified Messaging server is available to answer incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Enable-UMServer -Identity MyUMServer ``` @@ -48,6 +54,7 @@ Type: UMServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -58,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -67,6 +73,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -82,6 +89,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -97,6 +105,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -105,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/20e214ba-e8cc-4ba1-ad21-4f7140330074.aspx) diff --git a/exchange/exchange-ps/exchange/Enable-UMService.md b/exchange/exchange-ps/exchange/Enable-UMService.md new file mode 100644 index 0000000000..d0441b4357 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-UMService.md @@ -0,0 +1,138 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Enable-UMService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Enable-UMService cmdlet to set the status of an Exchange Server 2010 Unified Messaging (UM) server to enabled. This setting enables the Unified Messaging server to process UM calls. + +You can run this cmdlet in Exchange 2013 or Exchange 2016, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to enable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-UMService [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Enable-UMService -Identity MyUMServer +``` + +This example enables Unified Messaging on the UM server MyUMServer. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +```yaml +Type: UMServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Execute-AzureADLabelSync.md b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md new file mode 100644 index 0000000000..8da13825b6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md @@ -0,0 +1,50 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Execute-AzureADLabelSync + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Execute-AzureADLabelSync cmdlet to start the synchronization of sensitivity labels into Microsoft Entra ID. This allows the application of sensitivity labels to Microsoft Teams sites, Microsoft 365 Groups, and SharePoint sites. This cmdlet is required if you were using sensitivity labels before September 2019. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Execute-AzureADLabelSync [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Execute-AzureADLabelSync +``` + +This example will initialize the synchronization of sensitivity labels into Microsoft Entra ID. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Expedite-Delicensing.md b/exchange/exchange-ps/exchange/Expedite-Delicensing.md new file mode 100644 index 0000000000..f5c2af5041 --- /dev/null +++ b/exchange/exchange-ps/exchange/Expedite-Delicensing.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/expedite-delicensing +applicable: Exchange Online +title: Expedite-Delicensing +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Expedite-Delicensing + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Expedite-Delicensing cmdlet to end the delay for removing mailbox licenses from users. After you remove the delay, the licenses are removed from mailboxes within 24 hours. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Expedite-Delicensing [-Identity] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Expedite-Delicensing -Identity yajvendra@contoso.onmicrosoft.com +``` + +This example ends the delay for the mailbox license removal request on the specified mailbox. Typically, the mailbox license is removed from the mailbox within 30 minutes after running the command, but it might take up to 24 hours. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox with a pending mailbox license removal request. + +You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Email address +- GUID +- LegacyExchangeDN +- User ID or user principal name (UPN) + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/devices/Export-ActiveSyncLog.md b/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md similarity index 75% rename from exchange/exchange-ps/exchange/devices/Export-ActiveSyncLog.md rename to exchange/exchange-ps/exchange/Export-ActiveSyncLog.md index b70ff64b1c..2af091f5e0 100644 --- a/exchange/exchange-ps/exchange/devices/Export-ActiveSyncLog.md +++ b/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Export-ActiveSyncLog @@ -13,38 +16,46 @@ This cmdlet is available only in on-premises Exchange. Use the Export-ActiveSyncLog cmdlet to parse the Internet Information Services (IIS) logs and return information about Microsoft Exchange ActiveSync usage, either on the screen or in an output file. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Export-ActiveSyncLog -Filename [-Confirm] [-EndDate ] [-Force] [-OutputPath ] - [-OutputPrefix ] [-StartDate ] [-UseGMT] [-WhatIf] [] +Export-ActiveSyncLog -Filename + [-Confirm] + [-EndDate ] + [-Force] + [-OutputPath ] + [-OutputPrefix ] + [-StartDate ] + [-UseGMT] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Export-ActiveSyncLog -Filename:"c:\Windows\System32\LogFiles\W2SVC1\ex060818.log" -StartDate:"06/08/18" -EndDate:"06/09/18" -UseGMT:$true -OutputPath:"c:\exreports\easreports" ``` This example exports the Exchange ActiveSync log for the date range 06/08/18 to 06/09/18. The times on the report are in Coordinated Universal Time (UTC) and the report is saved in c:\\exreports\\easreports. -### -------------------------- Example 2 -------------------------- -``` -Dir D:\Logs\*.log | Export-ActiveSyncLog -Filename:"c:\Windows\System32\LogFiles\W2SVC1\ex072018.log" -StartDate:"06/20/18" -EndDate:"07/20/18" -UseGMT:$true -Force $true -Confirm -OutputPath:"c:\exreports\easreports" +### Example 2 +```powershell +Get-Childitem D:\Logs\*.log | foreach { Export-ActiveSyncLog -Filename $_.FullName -StartDate:"06/20/18" -EndDate:"07/20/18" -UseGMT:$true -Force $true -Confirm -OutputPath:"c:\exreports\easreports" } ``` This example exports the Exchange ActiveSync log for the date range 06/20/18 to 07/20/18 by reading all log files in the D:\\logs directory. All prompts are suppressed while running the report and a confirmation message is displayed. The times on the report are in UTC and the report is saved in c:\\exreports\\easreports. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Export-ActiveSyncLog -Filename: "c:\Windows\System32\LogFiles\W2SVC1\ex020918.log" -StartDate:"02/01/18" -EndDate:"02/09/18" -UseGMT:$true -OutputPath:"c:\exreports\easreports" ``` @@ -60,6 +71,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -70,8 +82,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -79,6 +90,7 @@ 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 @@ -94,6 +106,7 @@ Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -102,13 +115,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,6 +140,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -139,6 +156,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -154,6 +172,7 @@ Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -162,13 +181,16 @@ Accept wildcard characters: False ``` ### -UseGMT -The UseGMT switch specifies that Coordinated Universal Time (Greenwich Mean Time) is used for the time in the report output. By default, if this parameter isn't specified, local time is used. +The UseGMT switch specifies that Coordinated Universal Time (Greenwich Mean Time) is used for the time in the report output. You don't need to specify a value with this switch. + +If you don't use this switch, local time is used. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -184,6 +206,7 @@ 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 @@ -192,20 +215,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/96488cda-9d33-4b67-9e86-2d03e89b1a20.aspx) diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md new file mode 100644 index 0000000000..8d5bf12471 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md @@ -0,0 +1,413 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata +applicable: Security & Compliance +title: Export-ActivityExplorerData +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-ActivityExplorerData + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Export-ActivityExplorerData cmdlet to export activities from Data classification \> Activity Explorer in the Microsoft 365 Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-ActivityExplorerData -EndTime -OutputFormat -StartTime + [-Filter1 ] + [-Filter2 ] + [-Filter3 ] + [-Filter4 ] + [-Filter5 ] + [-PageCookie ] + [-PageSize ] + [] +``` + +## DESCRIPTION +This cmdlet supports following filters: + +- Activity +- Application +- ArtifactType +- ClientIP +- ColdScanPolicyId +- CopilotAppHost +- CopilotThreadId +- CopilotType +- CreationTime +- DataState +- DestinationFilePath +- DestinationLocationType +- DeviceName +- DLPPolicyId +- DLPPolicyRuleId +- EmailReceiver +- EmailSender +- EndpointOperation +- EnforcementMode +- FalsePositive +- FileExtension +- GeneralPurposeComparison +- HowApplied +- HowAppliedDetail +- IrmUrlCategory +- IsProtected +- IsProtectedBefore +- ItemName +- LabelEventType +- Location +- MDATPDeviceId +- OriginatingDomain +- PageSize +- ParentArchiveHash +- Platform +- PolicyId +- PolicyMode +- PolicyName +- PolicyRuleAction +- PolicyRuleId +- PolicyRuleName +- PreviousFileName +- PreviousProtectionOwner +- ProtectionEventType +- ProtectionOwner +- RemovableMediaDeviceManufacturer +- RemovableMediaDeviceModel +- RemovableMediaDeviceSerialNumber +- RetentionLabel +- RMSEncrypted +- SensitiveInfoTypeClassifierType +- SensitiveInfoTypeConfidence +- SensitiveInfoTypeCount +- SensitiveInfoTypeId +- SensitivityLabel +- SensitivityLabelPolicy +- Sha1 +- Sha256 +- SourceLocationType +- TargetDomain +- TargetPrinterName +- User +- UsersPerDay +- Workload + +Valid workload filters include the following values: + +- Copilot +- Endpoint +- Exchange +- OnPremisesFileShareScanner +- OnPremisesSharePointScanner +- OneDrive +- PowerBI +- PurviewDataMap +- SharePoint + +Valid activity filters include the following values: + +- AIAppInteraction +- ArchiveCreated +- AutoLabelingSimulation +- BrowseToUrl +- ChangeProtection +- ClassificationAdded +- ClassificationDeleted +- ClassificationUpdated +- CopilotInteraction +- DLPInfo +- DLPRuleEnforce +- DLPRuleMatch +- DLPRuleUndo +- DlpClassification +- DownloadFile +- DownloadText +- FileAccessedByUnallowedApp +- FileArchived +- FileCopiedToClipboard +- FileCopiedToNetworkShare +- FileCopiedToRemoteDesktopSession +- FileCopiedToRemovableMedia +- FileCreated +- FileCreatedOnNetworkShare +- FileCreatedOnRemovableMedia +- FileDeleted +- FileDiscovered +- FileModified +- FilePrinted +- FileRead +- FileRenamed +- FileTransferredByBluetooth +- FileUploadedToCloud +- LabelApplied +- LabelChanged +- LabelRecommended +- LabelRecommendedAndDismissed +- LabelRemoved +- NewProtection +- PastedToBrowser +- RemoveProtection +- ScreenCapture +- UploadFile +- UploadText +- WebpageCopiedToClipboard +- WebpagePrinted +- WebpageSavedToLocal + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json +``` + +This example exports a maximum of 5000 records for the specified date range in JSON format. + +### Example 2 +```powershell +Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -OutputFormat Json +``` + +This example exports up to 100 records for the specified date range in Json format. If more than 100 records are available, the value of the LastPage property in the command output will be False. Use the value of the Watermark property as the value of the PageCookie parameter in a new query to get the next set of records. + +### Example 3 +```powershell +$res = Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json + +#Run the following steps in loop until all results are fetched + +while ($res.LastPage -ne $true) +{ + $pageCookie = $res.WaterMark + $res = Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json -PageCookie $pageCookie +} +``` + +This example is related to the previous example where more than 100 records were available (the value of the LastPage property from that command was False). We're using the same date range, but this time we're using the value of the Watermark property from the previous command for the PageCookie parameter in this command to get the remaining results in a loop. ResultData from each iteration can be used as needed. + +### Example 4 +```powershell +Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived") -OutputFormat Csv +``` + +This example exports up to 100 records for the specified date range in CSV format, and filters the output by the Activity value FileArchived. + +### Example 5 +```powershell +Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived", "ArchiveCreated") -OutputFormat Json +``` + +This example exports up to 100 records for the specified date range in JSON format, and filters the output by the Activity value FileArchived or ArchiveCreated. + +### Example 6 +```powershell +Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived", "ArchiveCreated") -Filter2 @("Workload","Endpoint") -OutputFormat Json +``` + +This example exports up to 100 records for the specified date range in JSON format, and filters the output by the Workload value Endpoint for FileArchived or ArchiveCreated activities. + +## PARAMETERS + +### -EndTime +The EndTime parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFormat +The OutputFormat parameter specifies the output format. Valid values are: + +- Csv +- Json + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: csv, json +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The StartTime parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter1 +The Filter1 parameter filters the data to export. This parameter takes a minimum of two values as input: a filter name and at least one filter value. For example, `@("Activity", "LabelApplied")` returns records with the activity value `LabelApplied`. + +If you specify multiple filter values for the same parameter, OR behavior is used. For example, `@("Activity", "LabelApplied", "LabelRemoved")` returns records with the activity values `LabelApplied` or `LabelRemoved`. + +If you use this parameter with other filter parameters, AND behavior is used across parameters. For example: + +`-Filter1 @("Activity", "LabelApplied", "LabelRemoved") -Filter2 = @("Workload", "Exchange")` returns records with the activity values `LabelApplied` or `LabelRemoved` for the `Exchange` workload. In other words, ((`Activity eq LabelApplied`) OR (`Activity eq LabelRemoved`)) AND (`Workload eq Exchange`). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter2 +The Filter2 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter1 parameter in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter3 +The Filter3 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter2 and Filter1 parameters in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter4 +The Filter4 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter3, Filter2, and Filter1 parameters in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter5 +The Filter5 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Filter1 parameters in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageCookie +The PageCookie parameter specifies whether to get more data when the value of the LastPage property in the command output is False. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 5000 records can be returned. To get more records than what as returned in the current command, use the value of the Watermark property from the output of the current command as the value for the PageCookie parameter in a new command with the same date range and filters. The PageCookie value is valid for 120 seconds to fetch the next set of records for same query. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 100. Consider using a smaller PageSize value to avoid PageCookie expiry when exporting large datasets. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +- The date-time field exported via this cmdlet is in UTC timezone. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md b/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md new file mode 100644 index 0000000000..01b6148ebe --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md @@ -0,0 +1,229 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-AutoDiscoverConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-AutoDiscoverConfig cmdlet to create or update a service connection point for an Autodiscover service pointer in a target Exchange forest. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX +``` +Export-AutoDiscoverConfig -TargetForestDomainController + [-Confirm] + [-DeleteConfig ] + [-DomainController ] + [-MultipleExchangeDeployments ] + [-PreferredSourceFqdn ] + [-SourceForestCredential ] + [-TargetForestCredential ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Autodiscover Service Connection Point pointer resides Active Directory in the user account forest and includes the LDAP URL of the resource forest that the client will use to locate the Autodiscover service in the resource forest. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Export-AutoDiscoverConfig -TargetForestDomainController contoso.com +``` + +This example creates a service connection point object to connect to contoso.com Active Directory forest so that Outlook clients can automatically connect to their mailbox without having to set up a profile. + +### Example 2 +```powershell +Export-AutoDiscoverConfig -TargetForestDomainController dc.contoso.com -MultipleExchangeDeployments $true +``` + +This example specifies that Exchange is deployed in more than one Active Directory forest while establishing an Autodiscover service connection point to the dc.contoso.com domain controller in contoso.com Active Directory forest. + +## PARAMETERS + +### -TargetForestDomainController +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -DeleteConfig +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 +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 +``` + +### -MultipleExchangeDeployments +The MultipleExchangeDeployments parameter specifies whether multiple Exchange deployments exist. Valid values are: + +- $true: Exchange is deployed in more than one Active Directory forest, and the forests are connected. The list of authoritative accepted domains for the source forest is written to the Autodiscover service connection point object. Outlook clients use this object to select the most appropriate forest to search for the Autodiscover service. +- $False: Multiple Exchange deployments aren't used. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -PreferredSourceFqdn +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceForestCredential +The SourceForestCredential parameter specifies the credentials to use when connecting to the source forest. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetForestCredential +The TargetForestCredential parameter specifies the credentials to use to connect to the target forest. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Export-ContentExplorerData.md b/exchange/exchange-ps/exchange/Export-ContentExplorerData.md new file mode 100644 index 0000000000..85f8802e21 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-ContentExplorerData.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/export-contentexplorerdata +applicable: Security & Compliance +title: Export-ContentExplorerData +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-ContentExplorerData + +## SYNOPSIS +**Note**: This cmdlet is currently in Preview and is subject to change. + +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Export-ContentExplorerData cmdlet to export data classification file details in Microsoft Purview compliance. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-ContentExplorerData [-TagName] [-TagType] + [-Aggregate] + [[-PageCookie] ] + [[-PageSize] ] + [[-SiteUrl] ] + [[-UserPrincipalName] ] + [[-Workload] ] + [] +``` + +## DESCRIPTION +The output of this cmdlet contains the following information: + +- TotalCount: Aggregate count. If only the TagName and TagType parameters are used, the value is the total aggregate count for that tag. If the Workload parameter is also used, the value is the aggregate count in the workload for that tag. If the UserPrincipalName or SiteUrl parameters are used, the value is the count for that specific folder. +- MorePagesAvailable: Shows whether there are more records left to export. The value is True or False. +- RecordsReturned: The number of records returned in the query. +- PageCookie: Used to get the next set of records when MorePagesAvailable is True. + +The following list describes best practices for scripts using this cmdlet: + +- We recommend not using a single script to export multiple SITs/Labels. Instead, create a script for one SIT/Label, and then re-use the same script for each SIT/Label in each workload as required. +- When retrying the script, make sure to reconnect to the session first. The session's token expires after about an hour, which can cause the cmdlet to fail. To fix this issue, reconnect to the session before retrying the script. If the script fails, restart it using the last page cookie returned to continue the export from where it left off. + + > [!TIP] + > To support unattended scripts that run for a long time, you can use [certificate-based authentication (CBA)](https://learn.microsoft.com/powershell/exchange/app-only-auth-powershell-v2). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Export-ContentExplorerData -TagType SensitiveInformationType -TagName "Credit Card Number" -Workload EXO -UserPrincipalName erika@contoso.onmicrosoft.com +``` + +This example exports records for the specified sensitive info type from Erika's mailbox. + +### Example 2 +```powershell +Export-ContentExplorerData -TagType SensitiveInformationType -TagName "Credit Card Number" -Workload ODB -SiteUrl https://contoso-my.sharepoint.com/personal/erika_contoso_onmicrosoft_com +``` + +This example exports records for the specified sensitive info type in Erika's OneDrive site. + +### Example 3 +```powershell +Export-ContentExplorerData -TagType SensitiveInformationType -TagName "All Full Names" +``` + +This example exports records for the specified sensitive info type for all workloads. + +## PARAMETERS + +### -TagType +The TagType parameter specifies the type of label to export file details from. Valid values are: + +- Retention +- SensitiveInformationType +- Sensitivity +- TrainableClassifier + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Aggregate +**Note:** This parameter is currently in Private Preview, isn't available in all organizations, and is subject to change. + +The Aggregate parameter switch returns the folder level aggregated numbers instead of returning details at the item level. You don't need to specify a value with this switch. + +Using this switch significantly reduces the export time. To download the items in a folder, run this cmdlet for specific folders. + +When you use this switch with the TagName, TagType, and Workload parameters, the command returns the following information: + +- SharePoint and OneDrive: The list of SiteUlrs. +- Exchange Online and Microsoft Teams: The list of UPNs. +- The count of items in the folders stamped with relevant tag. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageCookie +The PageCookie parameter specifies whether to get more data when the value of the MorePagesAvailable property in the command output is True. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 10000 records can be returned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of records to return in a single query. Valid input for this parameter is an integer between 1 and 10000. The default value is 100. + +**Note**: In empty folders or folders with few files, this parameter can cause the command to run for a long time as it tries to get the PageSize count of the results. To prevent this issue, the command returns data from 5 folders or the number of records specified by the PageSize parameter, whichever completes first. For example, if there are 10 folders with 1 record each, the command returns 5 records of the top 5 folders. In the next execution using page cookie, it returns 5 records from the remaining 5 folders, even if the PageSize value is 10. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteUrl +The SiteUrl parameter specifies the site URL to export file details from. + +You use this parameter for SharePoint and OneDrive workloads. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagName +The TagName parameter specifies the name of the label to export file details from. If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The UserPrincipalName parameter specifies the user account in UPN format to export message details from. An example UPN value is erika@contoso.onmicrosoft.com. + +You use this parameter for Exchange and Microsoft Teams workloads. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter specifies the location to export file details from. Valid values are: + +- EXO or Exchange +- ODB or OneDrive +- SPO or SharePoint +- Teams + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md new file mode 100644 index 0000000000..0c2de21c86 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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). + +This cmdlet is functional only in on-premises Exchange. + +Use the Export-DlpPolicyCollection cmdlet to export data loss prevention (DLP) policy collections that are based on transport rules (mail flow rules) from your organization to a file. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-DlpPolicyCollection [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +$DlpPol = Export-DlpPolicyCollection + +[System.IO.File]::WriteAllBytes('C:\My Documents\Contoso PII.xml', $DlpPol.FileData) +``` + +This example exports all the elements of the existing DLP policies to the file C:\\My Documents\\Contoso PII.xml. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Export-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md new file mode 100644 index 0000000000..ec431d5516 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md @@ -0,0 +1,306 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-ExchangeCertificate + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-ExchangeCertificate cmdlet to export existing certificates and pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Thumbprint +``` +Export-ExchangeCertificate [-Thumbprint] + [-Server ] + [-BinaryEncoded] + [-Confirm] + [-DomainController ] + [-FileName ] + [-Password ] + [-WhatIf] + [] +``` + +### Identity +``` +Export-ExchangeCertificate [[-Identity] ] + [-BinaryEncoded] + [-Confirm] + [-DomainController ] + [-FileName ] + [-Password ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Export-ExchangeCertificate cmdlet creates the following types of files: + +- Certificate files: When you export a certificate, the command creates a PKCS #12 file. PKCS #12 is the Personal Information Exchange Syntax standard specified by RSA Laboratories. For more information, see [PKCS #12: Personal Information Exchange Syntax Standard](https://www.emc.com/emc-plus/rsa-labs/standards-initiatives/pkcs12-personal-information-exchange-syntax-standard.htm). + + To export a certificate from an Exchange server, the certificate's PrivateKeyExportable property needs to have the value True. To import an exported certificate on another Exchange server, you need to export the certificate by using the Password parameter to include the private key or chain of trust in the certificate file. The default Microsoft Exchange self-signed certificate or new self-signed certificates that you create in the Exchange admin center or by using the default settings of the New-ExchangeCertificate cmdlet aren't exportable, because the private key isn't exportable (the default value of the PrivateKeyExportable parameter is $false). + +- Certificate request files: When you export a certificate request, the command creates a PKCS #10 file. PKCS #10 is the Certification Request Syntax standard specified by RFC 2314. For more information, see [PKCS #10: Certification Request Syntax](https://www.ietf.org/rfc/rfc2314.txt). + + 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). + +## EXAMPLES + +### Example 1 +```powershell +Export-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -FileName "C:\Data\HT cert.pfx" -BinaryEncoded -Password (Get-Credential).password +``` + +In **Exchange 2013**, this example exports a certificate from the local Exchange server to a file with the following settings: + +- The certificate to export has the thumbprint value 5113ae0233a72fccb75b1d0198628675333d010e. +- The exported certificate file is DER encoded (binary), not Base64. +- Enter the password when prompted. +- The certificate is exported to the file C:\\Data\\HT cert.pfx. + +**Note**: The FileName parameter is available only in Exchange 2013. To export the certificate in Exchange 2016 or Exchange 2019, see Example 2. + +### Example 2 +```powershell +$bincert = Export-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -BinaryEncoded -Password (Get-Credential).password + +[System.IO.File]::WriteAllBytes('C:\Data\HT cert.pfx', $bincert.FileData) +``` + +This example exports the same certificate from Example 1. This method is required in Exchange 2016 and Exchange 2019 because the FileName parameter is not available. + +### Example 3 +```powershell +Export-ExchangeCertificate -Thumbprint 72570529B260E556349F3403F5CF5819D19B3B58 -Server Mailbox01 -FileName "\\FileServer01\Data\Fabrikam.req" +``` + +In **Exchange 2013**, this example exports a pending certificate request to a file with the following settings: + +- The certificate request to export has the thumbprint value 72570529B260E556349F3403F5CF5819D19B3B58 and is located on the Exchange server named Mailbox01. +- The exported certificate request file is Base64 encoded, so the information that's written to the file is also displayed onscreen. +- The certificate request is exported to the file \\\\FileServer01\\Data\\Fabrikam.req. + +**Note**: The FileName parameter is available only in Exchange 2013. To export the pending certificate request in Exchange 2016 or Exchange 2019, see Example 4. + +### Example 4 +```powershell +$txtcert = Export-ExchangeCertificate -Thumbprint 72570529B260E556349F3403F5CF5819D19B3B58 -Server Mailbox01 + +[System.IO.File]::WriteAllBytes('\\FileServer01\Data\Fabrikam.req', [System.Text.Encoding]::Unicode.GetBytes($txtcert)) +``` + +This example exports the same pending certificate request from Example 3. This method is required in Exchange 2016 and Exchange 2019 because the FileName parameter is not available. + +## PARAMETERS + +### -Thumbprint +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. + +```yaml +Type: String +Parameter Sets: Thumbprint +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the certificate or certificate request that you want to export. Valid values are: + +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` + +You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. + +You can't use this parameter with the Server parameter. + +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. + +```yaml +Type: ExchangeCertificateIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BinaryEncoded +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileName +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate or certificate request to a file without using the FileName parameter, use the methods described in Example 2 and Example 4. + +This parameter is available only in Exchange 2013. + +The FileName parameter specifies the name and path of the exported certificate or certificate request file. You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password parameter specifies the password for the private key or chain of trust in the exported certificate file. To import the exported certificate file on another server, you need to know the password. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can't use this parameter with the Identity parameter, but you can use it with the Thumbprint parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Thumbprint +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 +``` + +### -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/Export-FilePlanProperty.md b/exchange/exchange-ps/exchange/Export-FilePlanProperty.md new file mode 100644 index 0000000000..91b4a41f26 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-FilePlanProperty.md @@ -0,0 +1,98 @@ +--- +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 +schema: 2.0.0 +--- + +# Export-FilePlanProperty + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Export-FilePlanProperty cmdlet to export file plan properties. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-FilePlanProperty [-Confirm] [-DomainController ] [-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 +Export-FilePlanProperty +``` + +The example exports the file plan properties. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```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/Export-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md new file mode 100644 index 0000000000..0b68ce68f7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md @@ -0,0 +1,159 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-JournalRuleCollection + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-JournalRuleCollection cmdlet to export the journal rules in your organization to an XML file. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-JournalRuleCollection [[-Identity] ] + [-Confirm] + [-DomainController ] + [-ExportLegacyRules] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use the Export-JournalRuleCollection cmdlet to export journal rules in your organization to create a backup copy of your rules. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$file = Export-JournalRuleCollection + +[System.IO.File]::WriteAllBytes('C:\MyDocs\JournalRules.xml', $file.FileData) +``` + +This example exports journal rules in a two-step process. In the first step, the Export-JournalRuleCollection cmdlet exports journal rules to the variable $file. In the second step, the Set-Content cmdlet saves the exported data to the XML file JournalRules.xml. + +### Example 2 +```powershell +$file = Export-JournalRuleCollection -ExportLegacyRules + +[System.IO.File]::WriteAllBytes('C:\MyDocs\LegacyJournalRules.xml', $file.FileData) +``` + +In Exchange Server 2010, this example exports legacy journal rules that were created in Exchange 2007 to an XML file. The first command uses the ExportLegacyRules switch to export legacy journal rules to the variable named $file. The second step saves the exported data to the XML file named LegacyJournalRules.xml. + +## PARAMETERS + +### -Identity +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 +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 +``` + +### -ExportLegacyRules +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md new file mode 100644 index 0000000000..dada5fa300 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md @@ -0,0 +1,319 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Export-MailboxDiagnosticLogs cmdlet to export diagnostic data from user and system mailboxes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### MailboxLog +``` +Export-MailboxDiagnosticLogs [-Identity] -ComponentName + [-Archive] + [-Confirm] + [-Credential ] + [-DomainController ] + [-IncludeInactiveMailboxes] + [-ReadFromDomainController] + [-ResultSize ] + [-WhatIf] + [] +``` + +### ExtendedProperties +``` +Export-MailboxDiagnosticLogs [-Identity] + [-ExtendedProperties] + [-Archive] + [-Confirm] + [-Credential ] + [-DomainController ] + [-IncludeInactiveMailboxes] + [-ReadFromDomainController] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Export-MailboxDiagnosticLogs -ComponentName OOF -Identity JohnSmith +``` + +In Exchange Server 2010 and 2013, this example retrieves the out-of-office diagnostic log for the user John Smith. + +### Example 2 +```powershell +Export-MailboxDiagnosticLogs -ComponentName CalendarPermissions -Identity "Yuuto Sasaki" +``` + +This example retrieves the calendar permissions diagnostic log for the mailbox named Yuuto Sasaki. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ComponentName +The ComponentName parameter specifies the component that you want to retrieve the diagnostic logs for. Valid values depend on the type and location of the mailbox (on-premises Exchange or Exchange Online). Valid values include: + +- AcceptCalendarSharingInvite +- ActionProcessingAgent +- BirthdayAssistant +- CalendarPermissions +- CalendarSharingInvite +- CalendarSharingLocalFolder +- DefaultViewIndexer +- FreeBusyPublishingAssistantQuickLog +- HoldTracking +- InternetCalendar +- InternalCalendarSharingMigration +- MRM +- OnlineMeetings +- OOFRules +- RBA +- RemindersAssistant +- Sharing +- SharingMigrationAssistant +- SharingSyncAssistant +- SubstrateHoldTracking +- SweepRules +- TimeProfile + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProperties +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -IncludeInactiveMailboxes +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. + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Export-Message.md b/exchange/exchange-ps/exchange/Export-Message.md new file mode 100644 index 0000000000..28b6f435c6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-Message.md @@ -0,0 +1,131 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-Message + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-Message cmdlet to copy a message from a queue on a Mailbox server or an Edge Transport server to a specified file path in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-Message [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Export-Message ExchSrv1\contoso.com\1234 | AssembleMessage -Path "c:\exportfolder\filename.eml" +``` + +This example exports a single message to the specified file path. Because the Export-Message cmdlet returns a binary object, you must use the AssembleMessage filter to be able to save the message content into a specified location. + +### Example 2 +```powershell +Get-Message -Queue "Server1\contoso.com" -ResultSize Unlimited | ForEach-Object {Suspend-Message $_.Identity -Confirm:$False + +$Temp="C:\ExportFolder\"+$_.InternetMessageID+".eml" + +$Temp=$Temp.Replace("<","_") + +$Temp=$Temp.Replace(">","_") + +Export-Message $_.Identity | AssembleMessage -Path $Temp} +``` + +This example retrieves all messages from the specified queue. The query results are then piped to the Export-Message command, and all the messages are copied to individual .eml files. The Internet Message IDs of each message are used as the file names. To accomplish this, the command does the following: + +- Retrieves all messages in a specific queue using the Get-Message cmdlet. +- The result is pipelined into the ForEach-Object cmdlet, which prepares a file name including full path using the temporary variable $Temp that consists of the Internet Message ID with .eml extension. The Internet Message ID field contains angled brackets (`<` and `>`) which need to be removed as they are invalid file names. This is done using the Replace method of the temporary variable. +- The ForEach-Object cmdlet also exports the message using the file name prepared. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://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 +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 +``` + +### -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/move-and-migration/Export-MigrationReport.md b/exchange/exchange-ps/exchange/Export-MigrationReport.md similarity index 83% rename from exchange/exchange-ps/exchange/move-and-migration/Export-MigrationReport.md rename to exchange/exchange-ps/exchange/Export-MigrationReport.md index c840e9440f..4610a82482 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Export-MigrationReport.md +++ b/exchange/exchange-ps/exchange/Export-MigrationReport.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Export-MigrationReport @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. The Export-MigrationReport is used by the Exchange migration process to enable an administrator to download a CSV file that contains migration errors for a selected migration batch. This cmdlet isn't run by an administrator in Windows PowerShell. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,16 +36,17 @@ Export-MigrationReport [-Identity] -RowCount ] [-Partition ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Export-MigrationReport ``` @@ -50,33 +54,35 @@ There are no examples for using this cmdlet because the values used for the requ ## PARAMETERS -### -CsvStream +### -Identity This parameter is reserved for internal Microsoft use. ```yaml -Type: Stream -Parameter Sets: StreamBased +Type: MigrationReportIdParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity +### -CsvStream This parameter is reserved for internal Microsoft use. ```yaml -Type: MigrationReportIdParameter -Parameter Sets: (All) +Type: Stream +Parameter Sets: StreamBased Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,6 +94,7 @@ Type: Int32 Parameter Sets: Paged Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -103,6 +110,7 @@ Type: Int32 Parameter Sets: Paged Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -113,8 +121,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -122,6 +129,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -139,6 +147,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,10 +161,11 @@ This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. ```yaml -Type: +Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -171,6 +181,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -179,20 +190,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/92d506ae-3de5-4a52-b4f8-a79ef94da4c7.aspx) diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md new file mode 100644 index 0000000000..f20bb9e7c2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -0,0 +1,279 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Export-QuarantineMessage + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Export-QuarantineMessage cmdlet to export quarantined messages and files from your cloud-based organization. Messages are exported to .eml message files so you can open them in Outlook. + +For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the files are exported in Base64 format. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identities +``` +Export-QuarantineMessage -Identities [-Identity ] + [-CompressOutput] + [-EntityType ] + [-ForceConversionToMime] + [-Password ] + [-PasswordV2 ] + [-ReasonForExport ] + [-RecipientAddress ] + [] +``` + +### IdentityOnly +``` +Export-QuarantineMessage -Identity + [-CompressOutput] + [-EntityType ] + [-ForceConversionToMime] + [-Password ] + [-PasswordV2 ] + [-ReasonForExport ] + [-RecipientAddress ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$e = Export-QuarantineMessage -Identity b28e0706-e50e-4c33-17e8-08daf2898d15\e939baaf-9dac-6126-2137-b82abf373159 + +$txt = [System.Text.Encoding]::Ascii.GetString([System.Convert]::FromBase64String($e.eml)) + +[IO.File]::WriteAllText("C:\My Documents\Quarantined Message.eml", $txt) +``` + +This example exports the specified message that was quarantined as spam: + +- The first command exports the quarantined message to the variable `$e`. The message is stored in the Eml property (the `$e.eml` value) as Base64 (based on the `$e.BodyEncoding` value). +- The second command converts the Eml property from Base64 to ASCII text and stores the result in the variable `$txt`. +- The third command writes the quarantined message to the specified .eml file. + +**Note**: Don't enclose the Identity value in quotation marks (you might get an error). + +### Example 2 +```powershell +$f = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111 + +$bytes = [Convert]::FromBase64String($f.eml) + +[IO.File]::WriteAllBytes("C:\My Documents\Quarantined Message with Attachments.eml", $bytes) +``` + +This example exports the specified message with attachments that was quarantined as malware: + +- The first command exports the quarantined message and attachments to the variable `$f`. The message and attachments are stored in the Eml property (the `$f.eml` value) as Base64 (based on the `$f.BodyEncoding` value). +- The second command converts the Eml property from Base64 to bytes and stores the result in the variable `$bytes`. +- The third command writes the quarantined message and attachments to the specified .eml file. + +## PARAMETERS + +### -Identities +The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). + +You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. + +When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. + +```yaml +Type: QuarantineMessageIdentity[] +Parameter Sets: Identities +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: QuarantineMessageIdentity +Parameter Sets: IdentityOnly +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CompressOutput +The CompressOutput switch exports the message as a compressed .zip file. You don't need to specify a value with this switch. + +For exported messages, including messages with attachments, the .zip file contains a folder that's named after the first GUID value in the Identity. The folder contains the .eml message that's named after the second GUID value in the Identity. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceConversionToMime +The ForceConversionToMime switch converts exported plain text messages to MIME formatting. You don't need to specify a value with this switch. + +This switch has no effect if the message is already encoded as Base64. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password parameter specifies the password that's required to open the exported message. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +To enter the password in plain text, use the PasswordV2 parameter. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordV2 +The PasswordV2 parameter specifies the plain text value of the password that's required to open the exported message. Enclose the value in quotation marks (for example, `''`). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReasonForExport +The ReasonForExport parameter specifies why the message was exported. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md new file mode 100644 index 0000000000..79ca27c8bb --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md @@ -0,0 +1,197 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-RecipientDataProperty + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-RecipientDataProperty cmdlet to download the picture or spoken name audio file of a mailbox or mail contact. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ExportPicture +``` +Export-RecipientDataProperty [-Identity] + [-Picture] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### ExportSpokenName +``` +Export-RecipientDataProperty [-Identity] + [-SpokenName] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$SN = Export-RecipientDataProperty -Identity tonys@contoso.com -SpokenName + +[System.IO.File]::WriteAllBytes('C:\tonysmith.wma', $SN.FileData) +``` + +This example exports Tony Smith's spoken name audio file and saves it to the local computer. + +### Example 2 +```powershell +$Pic = Export-RecipientDataProperty -Identity "Ayla Kol" -Picture + +[System.IO.File]::WriteAllBytes('C:\Data\aylakol.jpg', $Pic.FileData) +``` + +This example exports Ayla Kol's picture file to the local computer. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailboxUserContactIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -Picture +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. + +You can't use this switch with the SpokenName switch. + +```yaml +Type: SwitchParameter +Parameter Sets: ExportPicture +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 +``` + +### -SpokenName +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. + +You can't use this switch with the Picture switch. + +```yaml +Type: SwitchParameter +Parameter Sets: ExportSpokenName +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 +``` + +### -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/Export-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md new file mode 100644 index 0000000000..1996ade66b --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md @@ -0,0 +1,198 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Export-TransportRuleCollection cmdlet to export the transport rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-TransportRuleCollection [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Format ] + [-ExportLegacyRules] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Export-TransportRuleCollection cmdlet can be used to export the transport rule collection in your organization. The format of the exported transport rule collection changed in Exchange Server 2013. The new format can't be imported into Exchange Server 2010. + +Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see [Set-Content](https://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). + +## EXAMPLES + +### Example 1 +```powershell +$file = Export-TransportRuleCollection + +[System.IO.File]::WriteAllBytes('C:\My Docs\Rules.xml', $file.FileData) +``` + +This example exports transport rules. Rule data is first exported to the variable $file, and then written to the XML file Rules.xml in the C:\\My Docs folder. + +### Example 2 +```powershell +$file = Export-TransportRuleCollection -ExportLegacyRules + +[System.IO.File]::WriteAllBytes('C:\My Docs\LegacyRules.xml', $file.FileData) +``` + +In Exchange Server 2010, this example exports legacy transport rules that were created in Exchange 2007 to an XML file. The first command uses the ExportLegacyRules switch to export legacy transport rules to the variable named $file. The second step saves the exported data to the XML file named LegacyRules.xml. + +You can import the exported rules collection to Exchange 2010 using the Import-TransportRuleCollection cmdlet. + +You need to run these commands in this example on an Exchange 2010 Hub Transport server. + +## PARAMETERS + +### -Identity +This parameter is 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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportLegacyRules +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +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: + +- RuleCollectionXML +- InternalXML +- DlpMigrationRuleCollection + +```yaml +Type: RuleCollectionFormat +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Export-UMCallDataRecord.md b/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md new file mode 100644 index 0000000000..29e7f3790d --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md @@ -0,0 +1,188 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Export-UMCallDataRecord + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-UMCallDataRecord cmdlet to export Unified Messaging (UM) call data records for UM dial plans and UM IP gateways for a date that you've specified. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-UMCallDataRecord -ClientStream -Date + [-Confirm] + [-DomainController ] + [-UMDialPlan ] + [-UMIPGateway ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Export-UMCallDataRecord cmdlet exports Unified Messaging call data records for a specified date to a comma-separated value (CSV) file. You can filter call data records for specific UM dial plans or UM IP gateways. However, if you don't specify a UM IP gateway, all call data records are returned. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Export-UMCallDataRecord -Date 02/01/12 +``` + +This example returns all Unified Messaging call data records on February 1, 2018, and exports them to a CSV file. + +### Example 2 +```powershell +Export-UMCallDataRecord -Date 02/01/12 -UMDialPlan MyUMDialPlan +``` + +This example exports all Unified Messaging call data records for February 1, 2018, for the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -ClientStream +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMIPGateway +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/Export-UMPrompt.md b/exchange/exchange-ps/exchange/Export-UMPrompt.md new file mode 100644 index 0000000000..02e8841d44 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-UMPrompt.md @@ -0,0 +1,184 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Export-UMPrompt + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Export-UMPrompt cmdlet to export an audio file being used as a greeting prompt for Unified Messaging (UM) dial plans and auto attendants. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AACustomGreeting +``` +Export-UMPrompt -PromptFileName -UMAutoAttendant + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### DPCustomGreeting +``` +Export-UMPrompt -PromptFileName -UMDialPlan + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Export-UMPrompt cmdlet exports prompts that belong to existing UM dial plan and UM auto attendant objects. After the Export-UMPrompt cmdlet exports a prompt, you can save a copy of the prompt to a local drive as an audio file. You can then play the audio file using a media player. + +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). + +## EXAMPLES + +### Example 1 +```powershell +$prompt = Export-UMPrompt -PromptFileName "customgreeting.mp3" -UMDialPlan MyUMDialPlan + +[System.IO.File]::WriteAllBytes('D:\DialPlanPrompts\welcomegreeting.mp3', $prompt.AudioData) +``` + +This example exports the welcome greeting for the UM dial plan MyUMDialPlan and saves it as the file welcomegreeting.mp3. + +### Example 2 +```powershell +$prompt = Export-UMPrompt -PromptFileName "welcomegreeting.mp3" -UMAutoAttendant MyUMAutoAttendant + +[System.IO.File]::WriteAllBytes('E:\UMPromptsBackup\welcomegreetingbackup.mp3', $prompt.AudioData) +``` + +This example exports a custom greeting for the UM auto attendant MyUMAutoAttendant and saves it to the file welcomegreetingbackup.mp3. + +## PARAMETERS + +### -PromptFileName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMAutoAttendant +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ADPermission.md b/exchange/exchange-ps/exchange/Get-ADPermission.md new file mode 100644 index 0000000000..773f0467b4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ADPermission.md @@ -0,0 +1,169 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ADPermission + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ADPermission cmdlet to get permissions on an Active Directory object. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Owner +``` +Get-ADPermission [-Identity] + [-Owner] + [-DomainController ] + [] +``` + +### AccessRights +``` +Get-ADPermission [-Identity] + [-User ] + [-DomainController ] + [] +``` + +## 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ADPermission -Identity Ed +``` + +This example returns the permissions that have been applied to the user Ed. + +### Example 2 +```powershell +Get-ADPermission "Contoso.com" -User Chris +``` + +This example returns the permissions that have been granted to the user Chris on the Contoso.com Receive connector. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Owner +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Owner +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 +``` + +### -User +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 +- Mail users +- Security groups + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Owner parameter. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ADServerSettings.md b/exchange/exchange-ps/exchange/Get-ADServerSettings.md new file mode 100644 index 0000000000..e44f8bd977 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ADServerSettings.md @@ -0,0 +1,58 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +For 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 [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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 +``` + +This example displays the session settings for the current session. + +For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ADSite.md b/exchange/exchange-ps/exchange/Get-ADSite.md new file mode 100644 index 0000000000..507afd4a61 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ADSite.md @@ -0,0 +1,94 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +For 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] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdSite Default-First-Site-Name +``` + +This example displays the configuration details for the Active Directory site named Default-First-Site-Name. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md new file mode 100644 index 0000000000..714d4981eb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule +applicable: Exchange Online +title: Get-ATPBuiltInProtectionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ATPBuiltInProtectionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ATPBuiltInProtectionRule cmdlet to view the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ATPBuiltInProtectionRule [[-Identity] ] [-State ] [] +``` + +## DESCRIPTION +For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://learn.microsoft.com/defender-office-365/preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ATPBuiltInProtectionRule +``` + +This example shows the rule for the Built-in protection preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +The name of the only rule is ATP Built-In Protection Rule. + +```yaml +Type: DehydrateableRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Disabled +- Enabled + +The only rule is always enabled. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..f0a24d140f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule +applicable: Exchange Online +title: Get-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ATPProtectionPolicyRule cmdlet to view rules for Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ATPProtectionPolicyRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ATPProtectionPolicyRule | Format-Table Name,State +``` + +This example returns a summary list of the rules for Defender for Office 365 protections in preset security policies. + +### Example 2 +```powershell +Get-ATPProtectionPolicyRule -Identity "Strict Preset Security Policy" +``` + +This example returns detailed information about the rule named Strict Preset Security Policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Enabled +- Disabled + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md new file mode 100644 index 0000000000..754759eea3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md @@ -0,0 +1,260 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ATPTotalTrafficReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ATPTotalTrafficReport to view details about message traffic in your Microsoft Defender for Office 365 organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ATPTotalTrafficReport + [-Action ] + [-AggregateBy ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [-SummarizeBy ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- EventType: TotalBulkCount, TotalMalwareCount, TotalMissedSafeAttachmentCount, TotalMissedSafeLinkCount, TotalPhishCount, TotalSafeAttachmentCount, TotalSafeLinkCount, TotalSpamCount +- Organization +- Date +- MessageCount +- StartDate +- EndDate +- AggregateBy +- Index + +TotalMissedSafeAttachmentCount is when the recipient or tenant is not included in a Safe Attachments policy, but a message with a detected attachment was removed by zero-hour auto purge (ZAP) after delivery. + +TotalMissedSafeLinkCount is when the recipient or tenant is not included in a Safe Links policy, but a message with a detected URL was removed by ZAP after delivery. + +If the tenant had Safe Attachments or Safe Links policies, the messages would have been blocked and not delivered. + +By default, the command returns data for the last 14 days. Data for the last 90 days is available. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ATPTotalTrafficReport -StartDate (get-date).AddDays(-5) -EndDate (get-date).AddDays(-1) +``` + +This example returns data for the last 5 days. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. + +For this cmdlet, valid values are: + +- Action +- Direction +- Domain +- EventType + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md new file mode 100644 index 0000000000..7a46a55884 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md @@ -0,0 +1,120 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AcceptedDomain cmdlet to view the configuration information for the accepted domains in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AcceptedDomain [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AcceptedDomain +``` + +This example lists all the accepted domains in your organization. + +### Example 2 +```powershell +Get-AcceptedDomain | Where{$_.DomainType -eq 'Authoritative'} +``` + +This example lists all the authoritative accepted domains in your organization. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md new file mode 100644 index 0000000000..c42017f450 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AccessToCustomerDataRequest + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AccessToCustomerDataRequest cmdlet to view Microsoft 365 Customer Lockbox requests that control access to your data by Microsoft support engineers. + +**Note**: Customer Lockbox is included in Microsoft 365 E5, or you can buy a separate Customer Lockbox subscription with any Microsoft 365 Enterprise plan. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AccessToCustomerDataRequest [-ApprovalStatus ] + [-CreatedAfter ] + [-RequestId ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AccessToCustomerDataRequest +``` + +This example returns a summary list of all Customer Lockbox request. + +### Example 2 +```powershell +Get-AccessToCustomerDataRequest -ApprovalStatus Pending +``` + +This example returns a summary list of all Customer Lockbox requests that have the status value Pending. + +### Example 3 +```powershell +Get-AccessToCustomerDataRequest -RequestId EXSR123456 | Format-List +``` + +This example returns detailed information the Customer Lockbox request EXSR123456. + +## PARAMETERS + +### -ApprovalStatus +The ApprovalStatus parameter filters the results by approval status. Valid values are: + +- Approved +- Canceled +- Denied +- Pending + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedAfter +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: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md new file mode 100644 index 0000000000..76afb95c32 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md @@ -0,0 +1,298 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your organization that have active Exchange ActiveSync partnerships. + +**Note**: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Mailbox +``` +Get-ActiveSyncDevice -Mailbox + [-DomainController ] + [-Filter ] + [-OrganizationalUnit ] + [-ResultSize ] + [-SortBy ] + [-Monitoring] + [] +``` + +### Identity +``` +Get-ActiveSyncDevice [[-Identity] ] + [-DomainController ] + [-Filter ] + [-OrganizationalUnit ] + [-ResultSize ] + [-SortBy ] + [-Monitoring] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncDevice -Mailbox "TonySmith" +``` + +This example returns all Exchange ActiveSync mobile devices that Tony Smith has used and that are associated with his mailbox. + +### Example 2 +```powershell +Get-ActiveSyncDevice -ResultSize Unlimited | Where {$_.DeviceOS -eq "OutlookBasicAuth"} | Format-Table -Auto UserDisplayName,DeviceAccessState +``` + +This example returns the owner names of all Exchange ActiveSync mobile devices that connect via the Outlook Mobile app using Basic Authentication. + +### Example 3 +```powershell +Get-ActiveSyncDevice -ResultSize Unlimited | Where {$_.DeviceType -eq "OutlookService"} | Format-Table -Auto UserDisplayName,FirstSyncTime +``` + +This example returns the owner names of all Outlook Mobile apps that synch via Hybrid Modern Authentication. + +## PARAMETERS + +### -Identity +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 +- DeviceIdentity +- Multi-TenantID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can filter by the following properties: + +- ClientType +- DeviceAccessControlRule +- DeviceAccessState +- DeviceAccessStateReason +- DeviceActiveSyncVersion +- DeviceId +- DeviceImei +- DeviceMobileOperator +- DeviceModel +- DeviceOS +- DeviceOSLanguage +- DeviceTelephoneNumber +- DeviceType +- DeviceUserAgent +- FirstSyncTime +- FriendlyName +- ProvisioningFlags +- UserDisplayName + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Monitoring +This parameter is available only in on-premises Exchange. + +The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. + +Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- DeviceAccessControlRule +- DeviceAccessState +- DeviceAccessStateReason +- DeviceId +- DeviceImei +- DeviceMobileOperator +- DeviceModel +- DeviceOS +- DeviceOSLanguage +- DeviceTelephoneNumber +- DeviceType +- DeviceUserAgent +- FirstSyncTime +- FriendlyName +- UserDisplayName + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md new file mode 100644 index 0000000000..d3a5a05c35 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ActiveSyncDeviceAccessRule cmdlet to retrieve an access group of Exchange mobile devices along with their access level. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ActiveSyncDeviceAccessRule [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +You can create multiple groups of devices: allowed devices, blocked devices, and quarantined devices with the New-ActiveSyncDeviceAccessRule cmdlet. The Get-ActiveSyncDeviceAccessRule cmdlet retrieves the settings for any existing 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncDeviceAccessRule | where {$_.AccessLevel -eq 'Block'} +``` + +This example lists all the rules currently blocking mobile phones. + +### Example 2 +```powershell +Get-ActiveSyncDeviceAccessRule | Format-List Characteristic, QueryString, AccessLevel +``` + +This example lists all device access rules set up on the server. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md new file mode 100644 index 0000000000..0bb8724eba --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ActiveSyncDeviceAutoblockThreshold + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ActiveSyncDeviceAutoblockThreshold cmdlet to obtain the Autoblock settings for Microsoft Exchange ActiveSync mobile devices. + +For 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-ActiveSyncDeviceAutoblockThreshold [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +Microsoft Exchange and Exchange ActiveSync have the capability to block Exchange ActiveSync mobile devices if these devices display any of a defined list of behaviors that have the capability to cause issues with the server. The Get-ActiveSyncDeviceAutoblockThreshold cmdlet returns the settings for the requested threshold 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncDeviceAutoblockThreshold -Identity "UserAgentChanges" +``` + +This example retrieves the threshold settings for the Autoblock threshold rule for UserAgentChanges. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md new file mode 100644 index 0000000000..56664b5b8c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md @@ -0,0 +1,162 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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. + +For 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-ActiveSyncDeviceClass [[-Identity] ] + [-DomainController ] + [-Filter ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncDeviceClass -Filter "DeviceType -eq 'WP'" +``` + +This example returns a list of all Windows Phones. + +### Example 2 +```powershell +Get-ActiveSyncDeviceClass | group-object -Property DeviceType +``` + +This example lists all device types within the organization along with a count of the number of devices of each type present. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can filter by the following properties: + +- DeviceModel +- DeviceType +- LastUpdateTime + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- DeviceModel +- DeviceType +- LastUpdateTime + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md new file mode 100644 index 0000000000..df60827dd4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md @@ -0,0 +1,205 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ActiveSyncDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. + +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange or Exchange Online, use the Get-MobileDeviceStatistics cmdlet instead. If you have scripts that use Get-ActiveSyncDeviceStatistics, update them to use Get-MobileDeviceStatistics. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-ActiveSyncDeviceStatistics [-Identity] + [-DomainController ] + [-GetMailboxLog] + [-NotificationEmailAddresses ] + [-ShowRecoveryPassword] + [] +``` + +### Mailbox +``` +Get-ActiveSyncDeviceStatistics -Mailbox + [-DomainController ] + [-GetMailboxLog] + [-NotificationEmailAddresses ] + [-ShowRecoveryPassword] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncDeviceStatistics -Mailbox TonySmith +``` + +This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. + +### Example 2 +```powershell +$UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" + +Get-Mailbox $UserList | foreach {Get-ActiveSyncDeviceStatistics -Mailbox $_} +``` + +This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. + +**Note**: For more information about OPATH filter syntax, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +### Example 3 +```powershell +Get-ActiveSyncDeviceStatistics -Mailbox TonySmith -GetMailboxLog -NotificationEmailAddresses "admin@contoso.com" +``` + +This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. It also outputs the Exchange ActiveSync log file and sends it to the System Administrator at admin@contoso.com. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetMailboxLog +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailAddresses +The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. + +This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. + +```yaml +Type: MultiValuedProperty +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 +``` + +### -ShowRecoveryPassword +The ShowRecoveryPassword parameter specifies whether to return the recovery password for the mobile phone as one of the displayed statistics. If this parameter is set to $true, the command returns the recovery password for the mobile phone as one of the displayed statistics. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md new file mode 100644 index 0000000000..c43f7a04a7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md @@ -0,0 +1,110 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ActiveSyncMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. + +**Note**: In Exchange 2013 or later, use the Get-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Get-ActiveSyncMailboxPolicy, update them to use Get-MobileDeviceMailboxPolicy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ActiveSyncMailboxPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncMailboxPolicy -Identity "SalesPolicy" +``` + +This example returns the policy settings for the Mobile Device mailbox policy named SalesPolicy. + +### Example 2 +```powershell +Get-ActiveSyncMailboxPolicy -Identity "Default" +``` + +This example returns the policy settings for the Mobile Device mailbox policy named Default. + +### Example 3 +```powershell +Get-ActiveSyncMailboxPolicy -Identity "Management" +``` + +This example returns the policy settings for the Mobile Device mailbox policy named Management. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md new file mode 100644 index 0000000000..554ac124b7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ActiveSyncOrganizationSettings cmdlet to view the Microsoft Exchange ActiveSync settings for your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ActiveSyncOrganizationSettings [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncOrganizationSettings +``` + +This example retrieves the ActiveSync organization settings. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md new file mode 100644 index 0000000000..84a7bede86 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md @@ -0,0 +1,187 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ActiveSyncVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ActiveSyncVirtualDirectory cmdlet to view Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-ActiveSyncVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-ActiveSyncVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ActiveSyncVirtualDirectory -Server "MBX01" +``` + +This example returns a summary list of all Exchange ActiveSync virtual directories on the server named MBX01. + +### Example 2 +```powershell +Get-ActiveSyncVirtualDirectory -Identity "MBX01\Microsoft-Server-ActiveSync*" | Format-List +``` + +This example returns detailed information for the Exchange ActiveSync virtual directory named "Microsoft-Server-ActiveSync (Default Web Site)" on the server named MBX01. + +### Example 3 +```powershell +Get-ActiveSyncVirtualDirectory +``` + +This example returns a summary list of all Exchange ActiveSync virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdSiteLink.md b/exchange/exchange-ps/exchange/Get-AdSiteLink.md new file mode 100644 index 0000000000..11565da45f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AdSiteLink.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +For 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] ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ADSiteLink +``` + +This example returns a list of all IP site links in your organization. + +### Example 2 +```powershell +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. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md new file mode 100644 index 0000000000..1444986464 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-adaptivescope +applicable: Exchange Online, Security & Compliance +title: Get-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AdaptiveScope cmdlet to view adaptive scopes in your organization. Adaptive scopes (or static scopes) are used in retention policies and retention label policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AdaptiveScope [[-Identity] ] + [-AdministrativeUnits ] + [-LocationTypes ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdaptiveScope | Format-Table Name,Priority +``` + +This example returns a summary list of all adaptive scopes. +### Example 2 +```powershell +Get-AdaptiveScope -Identity "Project X" +``` + +This example returns detailed information about the adaptive scope named Project X. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the adaptive scope that you want to view. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdministrativeUnits +{{ Fill AdministrativeUnits Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationTypes +{{ Fill LocationTypes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md new file mode 100644 index 0000000000..83e1de7f90 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md @@ -0,0 +1,108 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AddressBookPolicy cmdlet to return address book policies that match the specified conditions. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AddressBookPolicy [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AddressBookPolicy | Format-List +``` + +This example returns detailed information about all address book policies in your organization by pipelining the Format-List cmdlet. + +### Example 2 +```powershell +Get-AddressBookPolicy -Identity "All Fabrikam" +``` + +This example returns default information about the address book policy All Fabrikam + +### Example 3 +```powershell +Get-AddressBookPolicy | where {$_.OfflineAddressBook -eq "\Fabrikam All OAB"} +``` + +This example returns information about all address book policies for which the offline address book (OAB) that the address book policy uses is named Fabrikam All OAB. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AddressList.md b/exchange/exchange-ps/exchange/Get-AddressList.md new file mode 100644 index 0000000000..cf62cd285e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AddressList.md @@ -0,0 +1,166 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AddressList cmdlet to view address lists. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Container +``` +Get-AddressList -Container + [-DomainController ] + [] +``` + +### Identity +``` +Get-AddressList [[-Identity] ] + [-DomainController ] + [] +``` + +### SearchSet +``` +Get-AddressList [-SearchText ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AddressList +``` + +This example returns a summary list of all the address lists. + +### Example 2 +```powershell +Get-AddressList -Identity "All Users\Sales\building4" | Format-List +``` + +This example returns detailed information for the address list named building4that's located under the All Users\\Sales\\ address list. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +You can't use this parameter with the Container or SearchText parameters. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Container +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +You can't use this parameter with the Identity or SearchText parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchText +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. + +```yaml +Type: String +Parameter Sets: SearchSet +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md new file mode 100644 index 0000000000..7faa2b133d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AddressRewriteEntry + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-AddressRewriteEntry cmdlet to view an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AddressRewriteEntry [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AddressRewriteEntry +``` + +This example returns a summary listing of all address rewrite entries. + +### Example 2 +```powershell +Get-AddressRewriteEntry "Address rewrite entry for contoso.com" | Format-List +``` + +This example returns the detailed configuration of a single address rewrite entry by piping the results to the Format-List command. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md new file mode 100644 index 0000000000..e9159a5432 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md @@ -0,0 +1,80 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AdminAuditLogConfig cmdlet to view the administrator audit logging configuration settings. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdminAuditLogConfig | Format-List +``` + +This example displays the administrator audit logging settings. The output of the Get-AdminAuditLogConfig cmdlet is piped to the Format-List cmdlet. For more information about piping and the Format-List cmdlet, see the following topics: + +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help) + +## PARAMETERS + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md new file mode 100644 index 0000000000..6a2753ab2d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md @@ -0,0 +1,138 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AdministrativeUnit + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Microsoft Entra containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users. + +**Note**: Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AdministrativeUnit [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdministrativeUnit +``` + +This example returns a summary list of all Microsoft Entra administrative units. + +### Example 2 +```powershell +Get-AdministrativeUnit -Identity "West Coast" | Format-List +``` + +This example returns detailed information about the administrative unit with the display name West Coast. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the administrative unit that you want to view. You can use any value that uniquely identifies the administrative unit. For example: + +- Display name (this value is the same in Microsoft Graph PowerShell) +- ExternalDirectoryObjectId (this GUID value is the same as the ObjectId property in Microsoft Graph PowerShell) +- Name (GUID value) +- Distinguished name (DN) +- GUID (different value than Name) + +```yaml +Type: AdministrativeUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AgentLog.md b/exchange/exchange-ps/exchange/Get-AgentLog.md new file mode 100644 index 0000000000..90b89266d4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AgentLog.md @@ -0,0 +1,134 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AgentLog + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-AgentLog cmdlet to parse log files that you specify as parameters and collect raw statistics from the filtering that anti-spam agents apply during a time period that you specify. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AgentLog [-EndDate ] + [-Location ] + [-StartDate ] + [-TransportService ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AgentLog -StartDate "01/04/2018 9:00:00 AM" -EndDate "01/08/2018 6:00:00 PM" -TransportService FrontEnd +``` + +This example returns a report that has statistics collected between 09:00 (9 A.M.), January 4, 2018 and 18:00 (6 P.M.), January 8, 2018 in the Front End Transport service. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Location +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -TransportService +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. +- MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. +- MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. +- FrontEnd for the Front End Transport service on Mailbox servers. +- Edge on Edge Transport servers. + +```yaml +Type: TransportService +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md new file mode 100644 index 0000000000..fd62052590 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-aggregatezapreport +applicable: Exchange Online +title: Get-AggregateZapReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AggregateZapReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AggregateZapReport cmdlet to view aggregate information about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AggregateZapReport + [[-EndDate] ] + [[-Page] ] + [[-PageSize] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- Date +- EventType +- ZapActionCount + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AggregateZapReport +``` + +This example retrieves information for the last 3 days. + +### Example 2 +```powershell +Get-AggregateZapReport -StartDate 7/1/2023 -EndDate 7/9/2023 +``` + +This example retrieves information for the specified date range. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use the EndDate parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md new file mode 100644 index 0000000000..332d193a34 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md @@ -0,0 +1,165 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AntiPhishPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AntiPhishPolicy cmdlet to view antiphish policies in your cloud-based organization. This cmdlet returns results only in Exchange Online PowerShell. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AntiPhishPolicy [-Identity ] + [-Advanced] + [-Impersonation] + [-Spoof] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AntiPhishPolicy | Format-Table Name,Enabled,IsDefault +``` + +This example shows a summary list of all antiphish policies. + +### Example 2 +```powershell +Get-AntiPhishPolicy -Identity "Office365 AntiPhish Default" +``` + +This example shows detailed information about the antiphish policy named Office 365 AntiPhish Default. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: AntiPhishPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Advanced +The Advanced switch filters the properties that are returned to the advanced settings in the policy. For example: + +- PhishThresholdLevel +- EnableSuspiciousSafetyTip (This value is always False, and you can't change it.) + +You don't need to specify a value with this switch. + +Advanced settings are available only in anti-phishing policies in Microsoft Defender for Office 365. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Impersonation +The Impersonation switch filters the properties that are returned to the impersonation settings in the policy. For example: + +- EnableMailboxIntelligence +- EnableMailboxIntelligenceProtection +- EnableOrganizationDomainsProtection +- EnableSimilarDomainsSafetyTips +- EnableSimilarUsersSafetyTips +- EnableTargetedDomainsProtection +- EnableTargetedUserProtection +- EnableUnusualCharactersSafetyTips +- ExcludedDomains +- ExcludedSenders +- ImpersonationProtectionState +- MailboxIntelligenceProtectionAction +- MailboxIntelligenceProtectionActionRecipients +- TargetedDomainActionRecipients +- TargetedDomainProtectionAction +- TargetedDomainsToProtect +- TargetedUserActionRecipients +- TargetedUserProtectionAction +- TargetedUsersToProtect + +You don't need to specify a value with this switch. + +Impersonation settings are available only in anti-phishing policies in Microsoft Defender for Office 365. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Spoof +The Spoof switch filters the properties that are returned to the spoof settings in the policy. For example: + +- EnableAntiSpoofEnforcement +- EnableUnauthenticatedSender + +You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-AntiPhishRule.md b/exchange/exchange-ps/exchange/Get-AntiPhishRule.md new file mode 100644 index 0000000000..9593dd004c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AntiPhishRule.md @@ -0,0 +1,95 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AntiPhishRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AntiPhishRule cmdlet to view antiphish rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AntiPhishRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AntiPhishRule | Format-Table Name,Priority,State +``` + +This example returns a summary list of all antiphish rules in your organization. + +### Example 2 +```powershell +Get-AntiPhishRule -Identity "Research Department Phishing Rule" +``` + +This example returns detailed information about the antiphish rule named Research Department Phishing Rule. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-App.md b/exchange/exchange-ps/exchange/Get-App.md new file mode 100644 index 0000000000..4d63102688 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-App.md @@ -0,0 +1,176 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-App cmdlet to view installed apps. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-App [[-Identity] ] + [-DomainController ] + [-Mailbox ] + [-OrganizationApp] + [-PrivateCatalog] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-App -Mailbox Tony +``` + +This example returns the summary list of apps installed for user Tony. The command returns the name of the app, whether the app is enabled, and the app version number. + +### Example 2 +```powershell +Get-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b | Format-List +``` + +This example displays detailed information for the Bing Maps app for the currently logged on user. + +### Example 3 +```powershell +Get-App -OrganizationApp +``` + +This example displays the summary list of apps installed by administrators for the entire organization. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Identity parameter. + +**Note**: This parameter only returns user installed and default add-ins. It doesn't return add-ins installed by admins from Integrated Apps. For more information, see [Deploy and manage Office Add-ins](https://learn.microsoft.com/microsoft-365/admin/manage/office-addins). + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationApp +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCatalog +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..1feb6b2100 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy +applicable: Security & Compliance +title: Get-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AppRetentionCompliancePolicy to view app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AppRetentionCompliancePolicy [[-Identity] ] + [-DistributionDetail] + [-ErrorPolicyOnly] + [-RetentionRuleTypes] + [] +``` + +## DESCRIPTION +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Viva Engage chats, and Viva Engage community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AppRetentionCompliancePolicy | Format-Table Name,GUID +``` + +This example returns a summary list of all app retention compliance policies. + +### Example 1 +```powershell +Get-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" +``` + +This example returns detailed information for the app retention compliance policy named Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorPolicyOnly +{{ Fill ErrorPolicyOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionRuleTypes +The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. + +To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-AppRetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the value appears blank. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..b61fb71ac0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancerule +applicable: Security & Compliance +title: Get-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AppRetentionComplianceRule to view app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AppRetentionComplianceRule [[-Identity] ] [-Policy ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AppRetentionComplianceRule | Format-Table Name,Policy +``` + +This example returns a summary list of all app retention compliance rules. + +### Example 1 +```powershell +Get-AppRetentionComplianceRule -Identity "Contoso Viva Engage" +``` + +This example returns detailed information for the app retention compliance rule named Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance rule that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the app retention compliance rule results by the associated app retention compliance policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md new file mode 100644 index 0000000000..60e3070aa4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md @@ -0,0 +1,76 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ApplicationAccessPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ApplicationAccessPolicy cmdlet to view the list of application access policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ApplicationAccessPolicy | Format-Table -Auto Description,ScopeName,AccessRight +``` + +This example returns a summary list of all application access policies in the organization. + +### Example 2 +```powershell +Get-ApplicationAccessPolicy -Identity "596ade3a-1abe-4c5b-b7d5-a169c4b05d4a\7a774f0c-7a6f-11e0-85ad-07fb4824019b:S-1-5-21-724521725-2336880675-2689004279-1821338;8b6ce428-cca2-459a-ac50-d38bcc932258" +``` + +This example returns detailed information for the specified application access policy. + +## PARAMETERS + +### -Identity +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 +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-ArcConfig.md b/exchange/exchange-ps/exchange/Get-ArcConfig.md new file mode 100644 index 0000000000..84df4c911e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ArcConfig.md @@ -0,0 +1,52 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-arcconfig +applicable: Exchange Online +title: Get-ArcConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ArcConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ArcConfig cmdlet to view the list of trusted Authenticated Received Chain (ARC) sealers that are configured in the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ArcConfig [] +``` + +## DESCRIPTION +Services that modify message content in transit before delivery can invalidate DKIM email signatures and affect the authentication of the message. These services can use ARC to provide details of the original authentication before the modifications occurred. Your organization can then trust these details to help authenticate the message. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ArcConfig +``` + +This example returns the trusted ARC sealers that are configured for the organization + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md new file mode 100644 index 0000000000..31818f3779 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md @@ -0,0 +1,77 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AtpPolicyForO365 + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AtpPolicyForO365 cmdlet to view the settings for the following features in Microsoft Defender for Office 365: + +- Safe Links protection for supported Office 365 apps. +- Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise. +- Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AtpPolicyForO365 [[-Identity] ] + [] +``` + +## DESCRIPTION +Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://learn.microsoft.com/defender-office-365/safe-links-about#safe-links-settings-for-office-apps). + +Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://learn.microsoft.com/defender-office-365/safe-documents-in-e5-plus-security-about). + +Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://learn.microsoft.com/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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AtpPolicyForO365 +``` + +This example returns detailed information about the default policy. + +## PARAMETERS + +### -Identity +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 +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-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md new file mode 100644 index 0000000000..f9144d58cd --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md @@ -0,0 +1,111 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AttachmentFilterEntry + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-AttachmentFilterEntry cmdlet to view the list of attachment filter entries that are used by the Attachment Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AttachmentFilterEntry [[-Identity] ] + [-DomainController ] + [] +``` + +## 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, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AttachmentFilterEntry +``` + +This example returns all attachment filter entries. + +### Example 2 +```powershell +Get-AttachmentFilterEntry FileName:*.txt +``` + +This example returns only the attachment filter entries that filter file names with a .txt extension. + +### Example 3 +```powershell +Get-AttachmentFilterEntry ContentType:image/jpeg +``` + +This example returns only the attachment filter entries that filter attachments that have the MIME content type image/jpeg. + +## PARAMETERS + +### -Identity +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. +- FileName: This value matches the attachment filter entry against the simple file name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: 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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md new file mode 100644 index 0000000000..f05c82c01c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md @@ -0,0 +1,77 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AttachmentFilterListConfig + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-AttachmentFilterListConfig cmdlet to view the configuration of the Attachment Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AttachmentFilterListConfig [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type or the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. + +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AttachmentFilterListConfig | Format-List +``` + +This example returns detailed information about the Attachment Filtering agent configuration for the Exchange server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuditConfig.md b/exchange/exchange-ps/exchange/Get-AuditConfig.md new file mode 100644 index 0000000000..65476171dc --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AuditConfig.md @@ -0,0 +1,67 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AuditConfig + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AuditConfig cmdlet to view the auditing configuration in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AuditConfig [-DomainController ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AuditConfig +``` + +This example shows the auditing configuration in the Microsoft Purview compliance portal. + +## PARAMETERS + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md b/exchange/exchange-ps/exchange/Get-AuditLogSearch.md new file mode 100644 index 0000000000..a77201fca0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AuditLogSearch.md @@ -0,0 +1,154 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AuditLogSearch cmdlet to return a list of current audit log searches that were created with the New-AdminAuditLogSearch or New-MailboxAuditLogSearch cmdlets. The Get-AuditLogSearch cmdlet also returns audit log searches that are initiated whenever an administrator uses the Exchange admin center (EAC) to export audit logs. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AuditLogSearch [[-Identity] ] + [-CreatedAfter ] + [-CreatedBefore ] + [-ResultSize ] + [-Type ] + [] +``` + +## DESCRIPTION +Run the Get-AuditLogSearch cmdlet to return a list of pending audit log searches. If an audit log search has been completed, it won't be displayed in the list of audit log searches. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AuditLogSearch | Format-List +``` + +This example displays detailed information for all current audit log searches. + +### Example 2 +```powershell +Get-AuditLogSearch -Type admin +``` + +This example returns a list of current administrator audit log searches. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CreatedAfter +The CreatedAfter parameter filters the results to audit log searches that were created after the specified date. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedBefore +The CreatedBefore parameter filters the results to audit log searches that were created before the specified date. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuthConfig.md b/exchange/exchange-ps/exchange/Get-AuthConfig.md new file mode 100644 index 0000000000..7acbfbce8c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AuthConfig.md @@ -0,0 +1,73 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AuthConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-AuthConfig cmdlet to get the authorization configuration for partner applications. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AuthConfig | Format-List +``` + +This example retrieves the authorization configuration for the Exchange organization and pipes the results to the Format-List command. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuthRedirect.md b/exchange/exchange-ps/exchange/Get-AuthRedirect.md new file mode 100644 index 0000000000..a1e538e22c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AuthRedirect.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AuthRedirect + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-AuthRedirect cmdlet to view OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AuthRedirect [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AuthRedirect +``` + +This example shows a summary list of all the OAuth redirection objects. + +### Example 2 +```powershell +Get-AuthRedirect -Identity AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE | Format-List +``` + +This example shows detailed information about the OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuthServer.md b/exchange/exchange-ps/exchange/Get-AuthServer.md new file mode 100644 index 0000000000..ecf577d5a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AuthServer.md @@ -0,0 +1,105 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AuthServer cmdlet to view the settings of authorization servers in the Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AuthServer [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AuthServer +``` + +This example returns a summary list of all authorization servers in the Exchange organization. + +### Example 2 +```powershell +Get-AuthServer -Identity WindowsAzureAC | Format-List +``` + +This example retrieves detailed information for the authorization server named WindowsAzureAC. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: AuthServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md new file mode 100644 index 0000000000..b79c7d9b3c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md @@ -0,0 +1,129 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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). + +## SYNTAX + +``` +Get-AuthenticationPolicy [[-Identity] ] + [-AllowLegacyExchangeTokens] + [-TenantId ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AuthenticationPolicy | Format-Table -Auto Name +``` + +This example returns a summary list of all authentication policies. + +### Example 2 +```powershell +Get-AuthenticationPolicy -Identity "Engineering Group" +``` + +This example returns detailed information for the authentication policy named Engineering Group. + +### Example 3 +```powershell +Get-AuthenticationPolicy -AllowLegacyExchangeTokens +``` + +In Exchange Online, this example specifies whether legacy Exchange tokens for Outlook add-ins are allowed in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the authentication policy you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: AuthPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The AllowLegacyExchangeTokens switch specifies whether legacy Exchange tokens are allowed for Outlook add-ins in your organization. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +**Important**: + +- The AllowLegacyExchangeTokens switch returns `Not Set` if tokens haven't been explicitly allowed or blocked in your organization using the _AllowLegacyExchangeTokens_ or _BlockLegacyExchangeTokens_ parameters on the **Set-AuthenticationPolicy** cmdlet. For more information, see [Get the status of legacy Exchange Online tokens and add-ins that use them](https://learn.microsoft.com/office/dev/add-ins/outlook/turn-exchange-tokens-on-off#get-the-status-of-legacy-exchange-online-tokens-and-add-ins-that-use-them). +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. Although tokens are blocked by default, the AllowLegacyExchangeTokens switch still returns `Not Set` if you haven't used the _AllowLegacyExchangeTokens_ or _BlockLegacyExchangeTokens_ parameters on the **Set-AuthenticationPolicy** cmdlet. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is available only in the cloud-based service. + +{{ Fill TenantId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md new file mode 100644 index 0000000000..b60b6db4da --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -0,0 +1,147 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AutoSensitivityLabelPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AutoSensitivityLabelPolicy [[-Identity] ] + [-DistributionDetail] + [-ForceValidate ] + [-IncludeProgressFeedback] + [-IncludeTestModeResults ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AutoSensitivityLabelPolicy -Identity "Employee Numbers" -IncludeTestModeResults $true +``` + +This example returns detailed information about the autosensitivity label policy named Employee Numbers. The IncludeTestModeResults parameter and value allows you to see the status of test mode. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceValidate +The ForceValidate parameter specifies whether to include details related to the AdminUnits of users, groups, or sites in the policy. Valid values are: + +- $true: Various properties in the policy include details of the AdminUnits that are associated with current set of selected users, groups, or sites. +- $false: The output doesn't contain the information. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeProgressFeedback +IncludeProgressFeedback specifies whether to include the labeling progress of files in SharePoint or OneDrive. You don't need to specify a value with this switch. + +If you use this switch, the command shows the progress of files to be labeled, files labeled in the last 7 days, and total files labeled for enabled auto-labeling policies. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTestModeResults +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. +- $false: Don't include the status of test mode in the policy details. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md new file mode 100644 index 0000000000..ebaea6d9d6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md @@ -0,0 +1,183 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AutoSensitivityLabelRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policy rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AutoSensitivityLabelRule [[-Identity] ] + [-Confirm] + [-ForceValidate] + [-IncludeExecutionRuleGuids ] + [-IncludeExecutionRuleInformation ] + [-Policy ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AutoSensitivityLabelRule +``` + +This example displays summary information for all autolabeling rules in the Microsoft Purview compliance portal. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeExecutionRuleGuids +The IncludeExecutionRuleGuids parameter specifies whether to include the execution rule GUID in the rule details. Valid values are: + +- $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. + +```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 +``` + +### -IncludeExecutionRuleInformation +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. + +```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 +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md new file mode 100644 index 0000000000..e8c693c9bf --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md @@ -0,0 +1,185 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AutodiscoverVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-AutodiscoverVirtualDirectory cmdlet to view Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-AutodiscoverVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-AutodiscoverVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AutodiscoverVirtualDirectory -Server MBX01 +``` + +This example returns a summary list of all Autodiscover virtual directories on the server named MBX01. + +### Example 2 +```powershell +Get-AutodiscoverVirtualDirectory -Identity "MBX01\Autodiscover*" | Format-List +``` + +This example returns detailed information for the Autodiscover virtual directory named "Autodiscover (Default Web Site)" on the server named MBX01. + +### Example 3 +```powershell +Get-AutodiscoverVirtualDirectory +``` + +This example returns a summary list of all Autodiscover virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md new file mode 100644 index 0000000000..bfde6fcc4c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md @@ -0,0 +1,105 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AvailabilityAddressSpace cmdlet to view existing availability address space objects that are used to share free/busy data across Exchange organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AvailabilityAddressSpace [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AvailabilityAddressSpace +``` + +This example returns a summary list of all availability address space objects that are configured in your organization. + +### Example 2 +```powershell +Get-AvailabilityAddressSpace -Identity Contoso.com | Format-List +``` + +This example returns details information for the availability address space object named Contoso.com. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md new file mode 100644 index 0000000000..7932aaed30 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md @@ -0,0 +1,97 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-AvailabilityConfig cmdlet to view information about the sharing of free/busy information between organizations: + +- In on-premises Exchange, the cmdlet returns the accounts that are trusted in the cross-forest sharing of free/busy information. +- In Exchange Online, the cmdlet returns the tenant IDs of organizations that free/busy information is being shared with. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AvailabilityConfig [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-AvailabilityConfig +``` + +In on-premises Exchange, this example returns the accounts that are trusted in the cross-forest shared of free/busy information. + +In Exchange Online, this examples returns the tenant IDs that free/busy information is being shared with. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the availability configuration 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md new file mode 100644 index 0000000000..b73d3f29f3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-AvailabilityReportOutage + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-AvailabilityReportOutage cmdlet to return the daily downtime (if any) for each service entity and its overridden value (if set) to the overall reported availability for the day. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AvailabilityReportOutage [[-Identity] ] + [-ReportDate ] + [-ReportingDatabase ] + [-ReportingServer ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AvailabilityReportOutage +``` + +This example returns all outages that occurred the previous day. This cmdlet always returns outages for one day. + +### Example 2 +```powershell +Get-AvailabilityReportOutage -ReportDate:"2009-12-05" -Identity:"Outlook*" +``` + +This example returns all outages reported for Microsoft Outlook services at all sites on the selected day. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the outage. + +```yaml +Type: AvailabilityReportOutageIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ReportDate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportingDatabase +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportingServer +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-BlockedConnector.md b/exchange/exchange-ps/exchange/Get-BlockedConnector.md new file mode 100644 index 0000000000..c6701d3230 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-BlockedConnector.md @@ -0,0 +1,73 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedconnector +applicable: Exchange Online, Exchange Online Protection +title: Get-BlockedConnector +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-BlockedConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-BlockedConnector cmdlet to view inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-BlockedConnector [-ConnectorId ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-BlockedConnector +``` + +This example returns a summary list of all blocked connectors. + +### Example 2 +```powershell +Get-BlockedConnector -ConnectorId 159eb7c4-75d7-43e2-95fe-ced44b3e0a56 | Format-List +``` + +This example returns detailed information for the specified blocked connector. + +## PARAMETERS + +### -ConnectorId +The ConnectorId parameter specifies the blocked connector that you want to view. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md b/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md new file mode 100644 index 0000000000..4a14ad443b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md @@ -0,0 +1,80 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-BlockedSenderAddress + +## 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. + +For 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-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-BlockedSenderAddress +``` + +This example returns information about all blocked senders. + +### Example 2 +```powershell +Get-BlockedSenderAddress -SenderAddress laura@contoso.com +``` + +This example returns information about the blocked sender laura@contoso.com. + +## PARAMETERS + +### -SenderAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Exchange Management Shell cmdlet input and output types](https://learn.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Exchange Management Shell cmdlet input and output types](https://learn.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CASMailbox.md b/exchange/exchange-ps/exchange/Get-CASMailbox.md new file mode 100644 index 0000000000..00439ed122 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CASMailbox.md @@ -0,0 +1,485 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-CASMailbox cmdlet to view the Client Access settings that are configured on mailboxes. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOCASMailbox cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-CASMailbox [-Anr ] + [-ActiveSyncDebugLogging] + [-ActiveSyncSuppressReadReceipt] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-Monitoring] + [-OrganizationalUnit ] + [-ProtocolSettings] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [-ReadIsOptimizedForAccessibility] + [-RecalculateHasActiveSyncDevicePartnership] [] + [-RecipientTypeDetails ] +``` + +### Identity +``` +Get-CASMailbox [[-Identity] ] + [-ActiveSyncDebugLogging] + [-ActiveSyncSuppressReadReceipt] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-Monitoring] + [-OrganizationalUnit ] + [-ProtocolSettings] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [-ReadIsOptimizedForAccessibility] + [-RecalculateHasActiveSyncDevicePartnership] [] + [-RecipientTypeDetails ] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-CASMailbox "Jeff Hay" +``` + +This example returns the values of the following client access settings for the user named Jeff Hay. + +- ActiveSyncEnabled +- OWAEnabled +- PopEnabled +- ImapEnabled +- MapiEnabled + +### Example 2 +```powershell +Get-CASMailbox tony@contoso.com | Format-List Imap* +``` + +This example returns all IMAP4 settings for the user tony@contoso.com. + +### Example 3 +```powershell +Get-CASMailbox chris@contoso.com | Format-List Ews* +``` + +This example returns all Exchange Web Services settings for the user chris@contoso.com. + +### Example 4 +```powershell +Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select * +``` + +In Exchange Online, this example filters the cmdlet output to only include shared mailboxes. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveSyncDebugLogging +The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, the value always appears as $false. + +To see this value, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncSuppressReadReceipt +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -Monitoring +This parameter is available only in on-premises Exchange. + +The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. + +Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtocolSettings +The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: + +- ExternalImapSettings +- InternalImapSettings +- ExternalPopSettings +- InternalPopSettings +- ExternalSmtpSettings +- InternalSmtpSettings + +You don't need to specify a value with this switch. + +To see these values, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List`. + +```yaml +Type: SwitchParameter +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 +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadIsOptimizedForAccessibility +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecalculateHasActiveSyncDevicePartnership +The RecalculateHasActiveSyncDevicePartnership switch recalculates the value of the HasActiveSyncDevicePartnership property on the mailbox. You don't need to specify a value with this switch. + +The value is automatically updated if it's found to be incorrect. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +This parameter is available only in the cloud-based service. + +The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: + +- DiscoveryMailbox +- EquipmentMailbox +- LegacyMailbox +- LinkedMailbox +- LinkedRoomMailbox +- MailUser +- RoomMailbox +- SharedMailbox +- TeamMailbox +- UserMailbox + +You can specify multiple values separated by commas. + +```yaml +Type: RecipientTypeDetails[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- ServerLegacyDN + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md new file mode 100644 index 0000000000..c825898743 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md @@ -0,0 +1,212 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-CASMailboxPlan + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Get-CASMailboxPlan cmdlet to view Client Access services (CAS) mailbox plans in cloud-based organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CASMailboxPlan [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-ResultSize ] + [-SortBy ] + [] +``` + +## DESCRIPTION +A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-CASMailboxPlan | Format-Table -Auto DisplayName,ActiveSyncEnabled,ImapEnabled,PopEnabled,OwaMailboxPolicy +``` + +This example returns a summary list of all CAS mailbox plans in the organization. + +### Example 2 +```powershell +Get-CASMailboxPlan -Identity ExchangeOnlineEnterprise +``` + +This example returns detailed information about the specified CAS mailbox plan. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise and `ExchangeOnlineEnterprise-GUID`). + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following attributes: + +- DisplayName +- Name + +The results are sorted in ascending order. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md new file mode 100644 index 0000000000..497c465e12 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md @@ -0,0 +1,219 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-CalendarDiagnosticAnalysis + +## SYNOPSIS +Although this cmdlet is available in on-premises Exchange and in the cloud-based service, it only works in on-premises Exchange. + +Use the Get-CalendarDiagnosticAnalysis cmdlet to troubleshoot calendar-related reliability issues. You can use this cmdlet to analyze calendar item data that's recorded in the Calendar Diagnostic logs. You provide the calendar item data to this cmdlet by using the Get-CalendarDiagnosticLog cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DefaultSet +``` +Get-CalendarDiagnosticAnalysis -CalendarLogs + [-DetailLevel ] + [-GlobalObjectId ] + [-OutputAs ] + [] +``` + +### LocationSet +``` +Get-CalendarDiagnosticAnalysis -LogLocation + [-DetailLevel ] + [-GlobalObjectId ] + [-OutputAs ] + [] +``` + +## DESCRIPTION +The following properties of the calendar item are returned in the default output of the cmdlet (when the DetailLevel parameter is set to Basic): + +- Local Log Time +- ItemId +- NormalizedSubject +- StartTime +- EndTime +- CalendarLogTriggerAction +- ClientInfoString +- OriginalLastModifiedTime +- ClientIntent +- CleanGlobalObjectId +- ItemClass +- ParentDisplay +- Duration +- AppointmentRecurring +- SentRepresentingEmailAddress +- 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). + +## EXAMPLES + +### Example 1 +```powershell +$logs = Get-CalendarDiagnosticLog -Identity oevans -MeetingID 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F + +Get-CalendarDiagnosticAnalysis -CalendarLogs $logs -DetailLevel Advanced | Set-Content -Path "C:\My Documents\Oscar Evans Analysis.csv" +``` + +This example gets the specified calendar item from Oscar Evans' mailbox, stores the item as a variable and writes the advanced analysis of the item to a CSV file. + +For basic analysis of the item, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. + +### Example 2 +```powershell +Get-CalendarDiagnosticAnalysis -LogLocation "C:\My Documents\Exported Calendar Logs\jkozma@contoso.com" -DetailLevel Advanced -OutputAs HTML | Set-Content -Path "C:\My Documents\Jasen Kozma Analysis.html" +``` + +In **Exchange 2013**, this example analyzes the calendar items that were previously exported from Jasen Kozma's mailbox by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter and writes the advanced analysis of the items to an HTML file. + +**Note**: The LogLocation parameter is available only in Exchange 2013. To specify the location of exported calendar items in Exchange 2016 or Exchange 2019, see Example 3. + +For basic analysis of the items, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. + +### Example 3 +```powershell +$calitems = Get-CalendarDiagnosticLog -Identity jkozma@contoso.com -Subject "Budget Meeting" + +ForEach($item in $calitems){$i++; Get-CalendarDiagnosticAnalysis -CalendarLogs $item -OutputAs HTML | Set-Content -Path ("\\FileServer01\Data\Jasen Kozma Analysis{0}.html" -f $i)} +``` + +This example analyzes the calendar items that were exported from Jasen Kozma's mailbox by using the Get-CalendarDiagnosticLog cmdlet and writes the advanced analysis for each item to an HTML file by using an UNC path. + +For basic analysis of the items, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. + +## PARAMETERS + +### -CalendarLogs +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. + +The value that you use for this parameter must identify a single item. To identify multiple items, see Example 3. + +You can't use this parameter with the LogLocation parameter. + +```yaml +Type: CalendarLog[] +Parameter Sets: DefaultSet +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLocation +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To specify the calendar items to analyze, use the CalendarLogs parameter. + +This parameter is functional only in Exchange 2013. + +The LogLocation parameter specifies the location of the exported calendar items that you want to analyze. You can specify a local path, or a UNC path (`\\Server\Share\User`). If the value contains spaces, enclose the value in quotation marks ("). + +You export the calendar items to .msg files by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter. If the path contains multiple .msg files, all of those files are analyzed when you run Get-CalendarDiagnosticAnalysis. + +You can't use this parameter with the CalendarLogs parameter. + +```yaml +Type: String[] +Parameter Sets: LocationSet +Aliases: +Applicable: Exchange Server 2013, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailLevel +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalObjectId +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). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputAs +The OutputAs parameter specifies the output format of the command. Valid values are: + +- CSV (This is the default value) +- HTML +- XML + +```yaml +Type: OutputType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md new file mode 100644 index 0000000000..38b63df96c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md @@ -0,0 +1,463 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-CalendarDiagnosticLog + +## SYNOPSIS +Although this cmdlet is available in on-premises Exchange and in the cloud-based service, it only works in on-premises Exchange. In cloud-based service, use the Get-CalendarDiagnosticObjects cmdlet instead. + +Use the Get-CalendarDiagnosticLog cmdlet to collect a range of calendar logs. The Calendar Diagnostic logs track all calendar items and meeting requests in mailboxes. You can use this information to troubleshoot calendar issues that occur in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### MeetingId +``` +Get-CalendarDiagnosticLog [-Identity] -MeetingID + [-Credential ] + [-DomainController ] + [-LogLocation ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +### MeetingSubject +``` +Get-CalendarDiagnosticLog [-Identity] -Subject + [-Credential ] + [-DomainController ] + [-LogLocation ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +### ExportToMsg +``` +Get-CalendarDiagnosticLog [-Identity] -LogLocation + [-Credential ] + [-DomainController ] + [-EndDate ] + [-EntryId ] + [-ExactMatch ] + [-ItemClass ] + [-ItemIds ] + [-Latest] + [-MeetingID ] + [-ReadFromDomainController] + [-ResultSize ] + [-StartDate ] + [-Subject ] + [] +``` + +## 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. +- 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-CalendarDiagnosticLog -Identity "Shannon Steele" -Subject "Weekly development meeting" -ExactMatch $true +``` + +This example retrieves the Calendar Diagnostic log entries for Shannon Steele's mailbox by using the subject Weekly development meeting. + +### Example 2 +```powershell +Get-CalendarDiagnosticLog -Identity oevans -StartDate "6/1/2018 6:00:00 AM" -EndDate "6/30/2018 5:00:00 PM" +``` + +This example retrieves the Calendar Diagnostic log entries for Oscar Evans' mailbox from 6/1/2018 to 6/30/2018. + +### Example 3 +```powershell +Get-CalendarDiagnosticLog -Identity jkozma@contoso.com -Subject "Weekly development meeting" -Latest +``` + +This example retrieves the Calendar Diagnostic log data only for the most recent calendar item in Jasen Kozma's mailbox with a message subject of "Weekly development meeting". + +### Example 4 +```powershell +Get-CalendarDiagnosticLog -Identity "Jasen Kozma" -Subject "Budget Meeting" -ExactMatch $true -LogLocation "C:\My Documents\Calendar Diagnostic Export" +``` + +In **Exchange 2013**, this example exports all calendar items in the Calendar Diagnostic log for Jasen Kozma's mailbox that have "Budget Meeting" anywhere in the subject to the specified folder. + +**Notes**: + +- In this example, the message files are written to C:\\My Documents\\Calendar Diagnostic Export\\jkozma@contoso.com. +- In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet to analyze the exported .msg files. +- This example doesn't work in Exchange 2016 or Exchange 2019 because the LogLocation parameter is not available. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that contains the calendar items. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogLocation +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. Usage of this cmdlet is now restricted to the local server. + +This parameter is functional only in Exchange 2010 and Exchange 2013. + +The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). + +In the location you specify, a subfolder is automatically created for the specified mailbox that holds the exported calendar items. For example, if you specify the value "C:\\My Documents\\Calendar Export" to export calendar items from the mailbox of Shannon Steele, the .msg files are actually stored in C:\\My Documents\\Calendar Export\\ssteele@contoso.com. + +In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet to analyze the exported .msg files. + +**Note**: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (`| Set-Content -Path "C:\My Documents\Calendar Export"`) or substitute the output to a PowerShell variable. + +```yaml +Type: String +Parameter Sets: ExportToMsg +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online + +Required: True +Position: Named +Default value: None +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingID +The MeetingID parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. + +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. + +Don't use this parameter with the Subject parameter, because the value of the MeetingID parameter takes precedence. + +```yaml +Type: String +Parameter Sets: MeetingId +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -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 +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: ExportToMsg +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 +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: ExportToMsg +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntryId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExactMatch +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. + +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. + +You only use this parameter with the Subject parameter. + +The value of this parameter is ignored when you use the MeetingId parameter. + +```yaml +Type: Boolean +Parameter Sets: ExportToMsg +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemClass +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. + +```yaml +Type: String[] +Parameter Sets: ExportToMsg +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemIds +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Latest +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: ExportToMsg +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md new file mode 100644 index 0000000000..e01ded63d5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md @@ -0,0 +1,472 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-CalendarDiagnosticObjects + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-CalendarDiagnosticObjects cmdlet to collect a range of calendar logs. The calendar diagnostic logs track important calendar-related event data for each mailbox, and can be used to troubleshoot calendar issues that occur in mailboxes. The logs track all calendar items and meeting messages. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CalendarDiagnosticObjects [-Identity] + [-AnalyzeExceptionWithOriginalStartDate ] + [-AutoRequeryOnMeetingId ] + [-ConfigurationName ] + [-CustomPropertyNames ] + [-EndDate ] + [-EntryId ] + [-EwsId ] + [-ExactMatch ] + [-ItemClass ] + [-ItemIds ] + [-MaxResults ] + [-MeetingId ] + [-ODataId ] + [-ResultSize ] + [-ShouldBindToItem ] + [-ShouldDecodeEnums ] + [-ShouldFetchAttendeeCollection ] + [-ShouldFetchRecurrenceExceptions ] + [-StartDate ] + [-Subject ] + [] +``` + +## 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. +- 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. +- OriginalLastModifiedTime: Used as the primary sort field to order the events. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true +``` + +This example retrieves the calendar diagnostic logs from Pedro Pizarro's mailbox for all items where the Subject is an exact match for Team Meeting. + +### Example 2 +```powershell +$A = Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true + +$A | Select-Object *,@{n='OLMT'; e={[DateTime]::Parse($_.OriginalLastModifiedTime.ToString())}} | sort OLMT | Format-Table OriginalLastModifiedTime,CalendarLogTriggerAction,ItemClass,ClientInfoString +``` + +This is the same as the previous example, but now the results are sorted by original last modified time. + +### Example 3 +```powershell +Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -MeetingID 40000008200E00074C5B7101A82E00800000000693ADAA3B5FCD201000000000000000010000000FF760A70460EAA4096B879872DF24F49 +``` + +This example retrieves the calendar diagnostic logs for Pedro Pizarro's mailbox for a meeting with the specified unique global object ID (GOID). + +### Example 4 +```powershell +Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Lunch" -StartDate 7/1/2018 -EndDate 7/31/2018 | Export-Csv "C:\My Documents\Team Lunch Meeting.csv" -NoTypeInformation +``` + +This example returns diagnostic information for meetings with the subject Team Lunch in Pedro Pizarro's mailbox that were modified in the month of July, 2018, and exports the results to the file C:\\My Documents\\Team Lunch Meeting.csv. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: UnifiedGroupOrUserMailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AnalyzeExceptionWithOriginalStartDate +{{ Fill AnalyzeExceptionWithOriginalStartDate Description }} + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRequeryOnMeetingId +{{ Fill AutoRequeryOnMeetingId Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +{{ Fill ConfigurationName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPropertyNames +The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see [Values for the CustomPropertyNames parameter in Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range 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". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntryId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsId +{{ Fill EwsId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExactMatch +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. + +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. + +You only use this parameter with the Subject parameter. + +The value of this parameter is ignored when you use the MeetingId parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemClass +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemIds +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxResults +{{ Fill MaxResults Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingId +The MeetingId parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ODataId +{{ Fill ODataId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldBindToItem +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldDecodeEnums +{{ Fill ShouldDecodeEnums Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldFetchAttendeeCollection +{{ Fill ShouldFetchAttendeeCollection Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldFetchRecurrenceExceptions +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range for the OriginalLastModifiedTime property (when the meeting was last modified, not created). + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CalendarNotification.md b/exchange/exchange-ps/exchange/Get-CalendarNotification.md new file mode 100644 index 0000000000..014d7e719e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CalendarNotification.md @@ -0,0 +1,162 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-CalendarNotification + +## SYNOPSIS +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. + +For 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-CalendarNotification [-Identity] + [-Credential ] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-CalendarNotification -Identity tony@contoso.com +``` + +This example returns the calendar text message notification settings for Tony's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/Get-CalendarProcessing.md b/exchange/exchange-ps/exchange/Get-CalendarProcessing.md new file mode 100644 index 0000000000..a38f7b7958 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CalendarProcessing.md @@ -0,0 +1,145 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-CalendarProcessing cmdlet to view the calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant and calendar configuration. Note that the settings returned by this cmdlet are editable only on resource mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CalendarProcessing [-Identity] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-CalendarProcessing -Identity "Room 212" | Format-List +``` + +This example shows the calendar processing options for the resource mailbox Room 212. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md new file mode 100644 index 0000000000..54654c842b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md @@ -0,0 +1,162 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-CaseHoldPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-CaseHoldPolicy to view existing case hold policies in the Microsoft Purview compliance portal. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CaseHoldPolicy [[-Identity] ] + [-Case ] + [-DistributionDetail] + [-IncludeBindings] + [-IncludeBindingsOnly] + [] +``` + +## 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-CaseHoldPolicy -Case "Contoso Legal" +``` + +This example displays detailed information for the policy that's associated with the eDiscovery case named Contoso Legal. + +### Example 2 +```powershell +Get-CaseHoldPolicy -Identity "Regulation 123 Compliance" +``` + +This example displays detailed information for the policy named "Regulation 123 Compliance". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Case +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 +- Identity (GUID value). + +You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionDetail +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". + +The following properties are affected by this switch: + +- SharePointLocation +- ExchangeLocation +- PublicFolderLocation +- DistributionStatus +- DistributionResults +- LastStatusUpdateTime + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBindings +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBindingsOnly +{{ Fill IncludeBindingsOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md new file mode 100644 index 0000000000..632e20fe65 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md @@ -0,0 +1,98 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-CaseHoldRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-CaseHoldRule to view case hold rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CaseHoldRule [[-Identity] ] + [-Policy ] + [] +``` + +## DESCRIPTION +In large environments, running this cmdlet without any parameters results in a timeout. As a workaround, you can run the following command: + +`Get-ComplianceCase | foreach {Get-CaseHoldPolicy -Case $_.Identity | foreach {Get-CaseHoldRule -Policy $_.Guid}}` + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-CaseHoldRule -Identity "30 Day Rule" +``` + +This example displays detailed information for the case hold rule named "30 Day Rule". + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +You can use this parameter with the Identity parameter in the same command. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md new file mode 100644 index 0000000000..b246435ac5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ClassificationRuleCollection cmdlet to view the classification rule collections in your organization. + +In the Microsoft Purview compliance portal, use the Get-DlpSensitiveInformationTypeRulePackage cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ClassificationRuleCollection [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ClassificationRuleCollection +``` + +This example returns a summary list of all classification rule collections. + +### Example 2 +```powershell +Get-ClassificationRuleCollection "Microsoft Rule Pack" | Format-List +``` + +This example returns detailed information about the classification rule collection named Microsoft Rule Pack. The command is piped to the Format-List cmdlet to display the detailed configuration of the specified classification rule collection. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/client-access-servers/Get-ClientAccessArray.md b/exchange/exchange-ps/exchange/Get-ClientAccessArray.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessArray.md rename to exchange/exchange-ps/exchange/Get-ClientAccessArray.md index 7f3f1c59df..c879bde532 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessArray.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-ClientAccessArray @@ -13,13 +16,15 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ClientAccessArray cmdlet to view legacy RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site) that exist in your Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ClientAccessArray [[-Identity] ] [-DomainController ] - [-Site ] [] +Get-ClientAccessArray [[-Identity] ] + [-DomainController ] + [-Site ] + [] ``` ## DESCRIPTION @@ -28,22 +33,21 @@ Client Access arrays were introduced in Exchange Server 2010 so Outlook clients Changes in the Exchange server architecture that were introduced in Exchange Server 2013 removed the need for RPC Client Access arrays: - 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). -- 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 2016 (https://technet.microsoft.com/library/jj898588.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-ClientAccessArray ``` This example returns a summary list of all Client Access arrays that exist in the local Active Directory site. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ClientAccessArray -Identity CASArray01 | Format-List ``` @@ -51,32 +55,13 @@ This example returns detailed information for the Client Access array named CASA ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the Client Access array that you want to view. You can use these values: - Name (if the value doesn't contain spaces) - - Distinguished name (DN) - - ExchangeLegacyDN - - Fully qualified domain name (FQDN) - - GUID ```yaml @@ -84,6 +69,7 @@ Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -91,15 +77,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + ### -Site The Site parameter filters the results by Active Directory site. You can use any value that uniquely identifies the site. For example: - Name - - Distinguished name (DN) - - GUID - - To see a list of available sites, use the Get-ADSite cmdlet. ```yaml @@ -107,6 +106,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -115,20 +115,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/4d366fb0-58b9-4730-9c67-8d4a0d47e19a.aspx) diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md new file mode 100644 index 0000000000..0e40aa0d98 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md @@ -0,0 +1,145 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ClientAccessRule + +## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. + +For 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-ClientAccessRule [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ClientAccessRule +``` + +This example shows a summary list of all client access rules. + +### Example 2 +```powershell +Get-ClientAccessRule "Block Client Connections from 192.168.1.0/24" | Format-List +``` + +This example retrieves details about the client access rule named "Block Client Connections from 192.168.1.0/24". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md new file mode 100644 index 0000000000..c3cb98eccc --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md @@ -0,0 +1,144 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ClientAccessServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ClientAccessServer cmdlet to view settings that are associated with the Client Access server role. + +**Note**: In Exchange 2013 or later, use the Get-ClientAccessService cmdlet instead. If you have scripts that use Get-ClientAccessServer, update them to use Get-ClientAccessService. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ClientAccessServer [[-Identity] ] + [-DomainController ] + [-IncludeAlternateServiceAccountCredentialPassword] + [-IncludeAlternateServiceAccountCredentialStatus] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ClientAccessServer +``` + +This example returns a summary list of all Exchange servers in your organization that have the Client Access server role installed. + +### Example 2 +```powershell +Get-ClientAccessServer -Identity mail.contoso.com | Format-List +``` + +This example returns detailed information for the server mail.contoso.com. + +## PARAMETERS + +### -Identity +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: + +- Name (for example, Exchange01) +- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) +- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +``` + +### -IncludeAlternateServiceAccountCredentialPassword +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`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAlternateServiceAccountCredentialStatus +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`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessService.md b/exchange/exchange-ps/exchange/Get-ClientAccessService.md new file mode 100644 index 0000000000..1f3d8c72e4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ClientAccessService.md @@ -0,0 +1,136 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ClientAccessService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ClientAccessService cmdlet to view settings that are associated with the Client Access server role. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ClientAccessService [[-Identity] ] + [-DomainController ] + [-IncludeAlternateServiceAccountCredentialPassword] + [-IncludeAlternateServiceAccountCredentialStatus] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ClientAccessService | Format-Table Name +``` + +This example returns a summary list of all Exchange servers in your organization that have theClient Access server role installed. + +### Example 2 +```powershell +Get-ClientAccessService -Identity mail.contoso.com | Format-List +``` + +This example returns detailed information for the server mail.contoso.com. + +## PARAMETERS + +### -Identity +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: + +- Name (for example, Exchange01) +- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) +- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAlternateServiceAccountCredentialPassword +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`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAlternateServiceAccountCredentialStatus +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`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-Clutter.md b/exchange/exchange-ps/exchange/Get-Clutter.md new file mode 100644 index 0000000000..abd9f70458 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Clutter.md @@ -0,0 +1,95 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-Clutter + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-Clutter cmdlet to view Clutter settings for mailboxes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-Clutter -Identity + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-Clutter -Identity "Constancia Pena" +``` + +This example returns the Clutter settings for the user Constancia Pena. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md new file mode 100644 index 0000000000..79f88947ca --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md @@ -0,0 +1,149 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-CmdletExtensionAgent + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-CmdletExtensionAgent cmdlet to view cmdlet extension agents. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filters +``` +Get-CmdletExtensionAgent [-Assembly ] + [-Enabled ] + [-DomainController ] + [] +``` + +### Identity +``` +Get-CmdletExtensionAgent [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-CmdletExtensionAgent | Format-Table -Auto Name,Enabled,Priority +``` + +This example displays a summary list of all the cmdlet extension agents in the organization. + +### Example 2 +```powershell +Get-CmdletExtensionAgent "Mailbox Creation Time Agent" +``` + +This example displays detailed information for the Exchange cmdlet extension agent named Mailbox Creation Time Agent. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: CmdletExtensionAgentIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Assembly +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 +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 +``` + +### -Enabled +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. +- $false: Only disabled agents are included in the results. + +If you don't use this parameter, enabled and disabled agents are included in the results. + +```yaml +Type: Boolean +Parameter Sets: Filters +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/exchange/Get-ComplianceCase.md new file mode 100644 index 0000000000..74d35075bf --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceCase.md @@ -0,0 +1,171 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceCase + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ComplianceCase cmdlet to different types of compliance cases in the Microsoft Purview compliance portal. See the CaseType parameter for a list of these case types. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ComplianceCase [-Identity] ] + [-CaseType ] + [-DomainController ] + [-RecentOnly] + [-RoleGroup ] + [] +``` + +## 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-ComplianceCase +``` + +This example returns a summary list of all eDiscovery Standard cases in the organization. + +### Example 2 +```powershell +Get-ComplianceCase -Identity "Contoso Legal" | Format-List +``` + +This example returns detailed information for the eDiscovery Standard case named Contoso Legal. + +### Example 3 +```powershell +Get-ComplianceCase -CaseType AdvancedEdiscovery +``` + +This example returns a summary list of all eDiscovery Premium cases in the organization. + +### Example 4 +```powershell +Get-ComplianceCase -CaseType DSR -RoleGroup "DSR Administrators" +``` + +This example returns a summary list of all DSR cases that the custom role group "DSR Administrators" is a member of. + +## PARAMETERS + +### -Identity +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 +- Identity (GUID value) + +```yaml +Type: ComplianceCaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CaseType +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**. +- ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft Purview compliance portal, trainable classifiers are displayed under **Data classification** \> **Trainable classifiers**. +- ComplianceWorkspace: This value is reserved for internal Microsoft use. +- DataInvestigation: Data investigation cases are used to investigate data spillage incidents. In the Microsoft Purview compliance portal, Data investigation cases are displayed on the **Data investigations** page. +- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Microsoft Purview compliance portal, DSR cases are displayed under **Data privacy** \> **Data subject requests**. +- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Standard cases are displayed under **eDiscovery** \> **Standard**. This is the default value. +- InsiderRisk: Insider risk cases are used to manage insider risk management cases. In the Microsoft Purview compliance portal, insider risk cases are displayed under **Insider risk management** \> **Cases**. Typically, insider risk management cases are manually created in the Microsoft Purview compliance portal to further investigate activity based on a risk alert. +- InternalInvestigation: This value is reserved for internal Microsoft use. +- SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft Purview compliance portal, communication compliance policies are displayed under **Communication compliance** \> **Policies**. + +```yaml +Type: ComplianceCaseType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: eDiscovery +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 +``` + +### -RecentOnly +The RecentOnly switch returns a list of the most recently modified cases of the specified case type. You don't need to specify a value with this switch. + +This switch is used to display data in the "Recent cases" widget in the Microsoft Purview compliance portal for some features that use compliance case objects. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleGroup +The RoleGroup parameter returns a list of compliance cases that the specified role group is a member of. If you don't include the CaseType parameter, the cmdlet returns a list of 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md new file mode 100644 index 0000000000..5588971c20 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceCaseMember + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ComplianceCaseMember cmdlet to view the members of eDiscovery cases in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-ComplianceCaseMember -Case + [-DomainController ] + [-ResultSize ] + [-ShowCaseAdmin] + [] +``` + +### AllCases +``` +Get-ComplianceCaseMember + [-DomainController ] + [-ResultSize ] + [] +``` + +## 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-ComplianceCaseMember -Case "Fabrikam Litigation" +``` + +This examples shows the members of the eDiscovery case named Fabrikam Litigation. + +## PARAMETERS + +### -Case +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 +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 +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowCaseAdmin +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md new file mode 100644 index 0000000000..4688db4274 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md @@ -0,0 +1,146 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceRetentionEvent + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ComplianceRetentionEvent [-Identity ] + [-BeginDateTime ] + [-DomainController ] + [-EndDateTime ] + [-PreviewOnly] + [] +``` + +## 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-ComplianceRetentionEvent | Format-Table Name,Description +``` + +The example returns a summary list of all compliance retention events. + +### Example 2 +```powershell +Get-ComplianceRetentionEvent -Identity "Case 1234" +``` + +This example returns detailed information about the compliance retention event named Case 1234. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BeginDateTime +{{ Fill BeginDateTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -EndDateTime +{{ Fill EndDateTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewOnly +{{ Fill PreviewOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md new file mode 100644 index 0000000000..413b3c7aa3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md @@ -0,0 +1,97 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceRetentionEventType + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ComplianceRetentionEventType cmdlet to view retention event types in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ComplianceRetentionEventType [-Identity ] + [-LoadTag] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ComplianceRetentionEventType | Format-Table Name,Priority +``` + +This example returns a summary list of all retention event types + +### Example 2 +```powershell +Get-ComplianceRetentionEventType -Identity "Fabrikam Project" -LoadTag +``` + +This example returns detailed information for the retention event type named Fabrikam Project, including the associated compliance tags. + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -LoadTag +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md new file mode 100644 index 0000000000..95ca1983f2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md @@ -0,0 +1,156 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ComplianceSearch cmdlet to view estimate compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. After you use the New-ComplianceSearchAction cmdlet to define a preview action for the compliance search, use the Get-ComplianceSearchAction cmdlet to view the results of the compliance search. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ComplianceSearch [[-Identity] ] + [-Case ] + [-DomainController ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ComplianceSearch +``` + +This example shows a summary list of all compliance searches. + +### Example 2 +```powershell +Get-ComplianceSearch -Identity "Case 1234" | Format-List +``` + +This examples show details of the compliance search named Case 1234. + +## PARAMETERS + +### -Identity +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: + +- Name +- JobRunId (GUID) + +You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status + +To improve the performance of this cmdlet, some compliance search properties aren't returned if you don't specify the identity of the compliance search. These properties are: + +- Items +- Size +- SuccessResults +- NumBindings +- ExchangeLocation +- SharePointLocation +- OneDriveLocation + +To view these properties, you need to use the Identity parameter in the command. + +**Note**: The NumBindings property includes the primary mailbox, the main archive, and any additional archives for users included in the search. NumBindings is not the number of users included in the search, because each included user could have or not have a combination of a primary mailbox, a main archive, and additional archives. + +```yaml +Type: ComplianceSearchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Case +This parameter is available only in the cloud-based service. + +The Case parameter filters the results by the name of an eDiscovery Standard case that the compliance search is associated with. If the value contains spaces, enclose the value in quotation marks. + +You can't use this parameter to view compliance searches associated with eDiscovery Premium cases. + +```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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md new file mode 100644 index 0000000000..a0ca0a62b5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -0,0 +1,296 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ComplianceSearchAction cmdlet to view information about compliance search actions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-ComplianceSearchAction [[-Identity] ] + [-Case ] + [-Details] + [-DomainController ] + [-IncludeCredential] + [-Organization ] + [-ResultSize ] + [] +``` + +### Preview +``` +Get-ComplianceSearchAction [-Preview] + [-Case ] + [-Details] + [-DomainController ] + [-IncludeCredential] + [-Organization ] + [-ResultSize ] + [] +``` + +### Purge +``` +Get-ComplianceSearchAction [-Purge] + [-Case ] + [-Details] + [-DomainController ] + [-IncludeCredential] + [-Organization ] + [-ResultSize ] + [] +``` + +### Export +``` +Get-ComplianceSearchAction [-Export] + [-Case ] + [-Details] + [-DomainController ] + [-IncludeCredential] + [-Organization ] + [-ResultSize ] + [] +``` + +## 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). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ComplianceSearchAction +``` + +This example shows a summary list of all compliance search actions. + +### Example 2 +```powershell +Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List +``` + +This example shows details about the compliance search action named "Case 1234_Preview" + +## PARAMETERS + +### -Identity +The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example: + +- Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"`. For example, `"Case 1234_Preview"`. +- JobRunId (GUID) + +You can't use this parameter with the Export, Preview, or Purge parameters. + +When you use the Identity parameter, more details are returned in the results. For example: + +- In the Results line, the values of the Item count, Total size, and Details properties are populated. +- Location lines are added to the results. +- The NumBindings property value is populated. This property includes the primary mailbox, the main archive, and any additional archives for users included in the search. NumBindings is not the number of users included in the search, because each included user could have or not have a combination of a primary mailbox, a main archive, and additional archives. +- The affected location properties (for example, ExchangeLocation) are populated. +- The CaseName property value is populated. + +```yaml +Type: ComplianceSearchActionIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Case +This parameter is available only in the cloud-based service. + +The Case parameter filters the results by the name of the specified case. 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 +``` + +### -Details +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +The Export switch filters the results by Export compliance search actions. You don't need to specify a value with this switch. + +You can't use this switch with the Identity, Preview, or Purge parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeCredential +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preview +The Preview switch filters the results by Preview compliance search actions. You don't need to specify a value with this switch. + +You can't use this switch with the Export, Identity, or Purge parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: Preview +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Purge +**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management 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. + +You can't use this switch with the Export, Identity, or Preview parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: Purge +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md new file mode 100644 index 0000000000..0c3ff1f88a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md @@ -0,0 +1,157 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceSecurityFilter + +## 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 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). + +## SYNTAX + +``` +Get-ComplianceSecurityFilter [-Action ] + [-Confirm] + [-FilterName ] + [-User ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Compliance security filters work with compliance searches in the Microsoft Purview compliance portal (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ComplianceSecurityFilter | Format-Table -Auto FilterName,Action +``` + +This example returns a summary list of all compliance security filters. + +### Example 2 +```powershell +Get-ComplianceSecurityFilter -FilterName "HR Filter" +``` + +This example returns detailed information about the compliance security filter named HR Filter. + +## PARAMETERS + +### -Action +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. +- Preview: The filter is applied when previewing search results. +- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. +- Search: The filter is applied when running a search. +- All: The filter is applied to all search actions. + +```yaml +Type: ComplianceSecurityFilterActionType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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. +- The value All. +- The name of a role group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, 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-ComplianceTag.md b/exchange/exchange-ps/exchange/Get-ComplianceTag.md new file mode 100644 index 0000000000..2c704b8488 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceTag.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceTag + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ComplianceTag cmdlet to view retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ComplianceTag [[-Identity] ] + [-IncludingLabelState] + [-PriorityCleanup] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ComplianceTag | Format-Table -Auto Name,Priority,RetentionAction,RetentionDuration,Workload +``` + +This example returns a summary list of all labels. + +### Example 2 +```powershell +Get-ComplianceTag -Identity "HR Content" +``` + +This example returns detailed information about the label named HR Content. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the label that you want to view. You can use any value that uniquely identifies the tag. For example: + +- Name +- Distinguished name (DN) +- GUID + +```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 +``` + +### -IncludingLabelState +{{ Fill IncludingLabelState Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md new file mode 100644 index 0000000000..c3aa8eaca3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ComplianceTagStorage + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ComplianceTagStorage cmdlet to confirm that you've created the retention label policy by using the Enable-ComplianceTagStorage cmdlet. Retention labels apply retention settings to content. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ComplianceTagStorage [[-Identity] ] + [-Organization ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ComplianceTagStorage +``` + +This example confirms that you've created the label policy in your organization. + +## PARAMETERS + +### -Identity +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) +- Distinguished name (DN) +- GUID (a different value than Name) + +However, there can be only one label policy in your organization. + +```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 +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md new file mode 100644 index 0000000000..d26e9e5e0d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md @@ -0,0 +1,151 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-CompromisedUserAggregateReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-CompromisedUserAggregateReport cmdlet to return general data about compromised users for the last 10 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CompromisedUserAggregateReport + [-Action ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [] +``` + +## DESCRIPTION +This cmdlet returns the following information: + +- Date +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-CompromisedUserAggregateReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Action Restricted +``` + +This example returns all restricted user accounts for the specified date range. + +## PARAMETERS + +### -Action +The Action parameter filters the results by the compromised user status. Valid values are: + +- Restricted +- Suspicious + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md new file mode 100644 index 0000000000..07d5d63148 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md @@ -0,0 +1,153 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-CompromisedUserDetailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-CompromisedUserDetailReport cmdlet to return detailed information about compromised users for the last 10 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-CompromisedUserDetailReport + [-Action ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [] +``` + +## DESCRIPTION +This cmdlet returns the following information: + +- Date +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-CompromisedUserDetailReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Action Suspicious +``` + +This example returns all suspicious user accounts for the specified date range. + +## PARAMETERS + +### -Action +The Action parameter filters the results by the compromised user status. Valid values are: + +- Restricted +- Suspicious + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +A value for this parameter can't be older than 30 days. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md new file mode 100644 index 0000000000..ff118bc38d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation +applicable: Exchange Online +title: Get-ConfigAnalyzerPolicyRecommendation +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ConfigAnalyzerPolicyRecommendation + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ConfigAnalyzerPolicyRecommendation cmdlet to compare the settings in your existing security policies to the settings that are used in the Standard or Strict preset security policies. Settings that are below the recommend value are returned in the results. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ConfigAnalyzerPolicyRecommendation -RecommendedPolicyType + [[-Identity] ] + [-IsAppliedToDisabled] + [] +``` + +## DESCRIPTION +For information about the policies and their recommended Standard and Strict values, see [Recommended settings for EOP and Microsoft Defender for Office 365 security](https://learn.microsoft.com/defender-office-365/recommended-settings-for-eop-and-office365). + +The output of this cmdlet only returns settings that fall below the value that you've specified as a baseline (Standard or Strict). + +The output contains the following information for each setting: + +- PolicyGroup: The type of policy. The value will be Anti-Spam, Anti-Phishing, Anti-Malware, ATP Safe Links, or ATP Safe Attachments +- SettingName: The name of the setting in the policy. +- SettingNameDescription: A description of the setting. +- Policy: The name of the policy. +- AppliedTo: The number of users or domains that the policy applies to. If the policy isn't applied to anyone (for example, it's disabled), this value will be blank. +- CurrentConfiguration: The current value of the setting. +- LastModified: When the policy was last modified. +- Recommendation: The recommended Standard or Strict value for the setting. +- SettingType: For example, Boolean, String, or Integer. + +If a setting is configured at or better than the Standard or Strict protection profile that you're comparing to, those settings/policies aren't returned in the results + +This cmdlet returns the following output for each setting in each policy that falls below the recommended value. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ConfigAnalyzerPolicyRecommendation -RecommendedPolicyType Strict +``` + +This example runs a comparison using the Strict preset security policy settings as a baseline. + +## PARAMETERS + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ConfigAnalyzerPolicyRecommendationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +The RecommendedPolicyType parameter specifies the preset security policy that you want to use as a baseline. Valid values are: + +- Standard +- Strict + +```yaml +Type: RecommendedPolicyType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAppliedToDisabled +The IsAppliedToDisabled switch filters the results by policies that aren't applied to anyone (the AppliedTo property is blank). You don't need to specify a value with this switch. + +If you don't use this switch, the results include policies that are applied to users and policies that aren't applied to anyone. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md new file mode 100644 index 0000000000..97f9d3efd2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-connectioninformation +applicable: Exchange Online +title: Get-ConnectionInformation +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ConnectionInformation + +## SYNOPSIS +This cmdlet is available in the Exchange Online PowerShell module v3.0.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-ConnectionInformation cmdlet to get information about all REST-based connections in the current PowerShell instance with Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default (Default) +``` +Get-ConnectionInformation [] +``` + +### ConnectionId +``` +Get-ConnectionInformation -ConnectionId [] +``` + +### ModulePrefix +``` +Get-ConnectionInformation -ModulePrefix [] +``` + +## DESCRIPTION +The Get-ConnectionInformation cmdlet returns the information about all active REST-based connections with Exchange Online in the current PowerShell instance. This cmdlet is equivalent to the Get-PSSession cmdlet that's used with remote PowerShell sessions. + +The output of the cmdlet contains the following properties: + +- ConnectionId: A unique GUID value for the connection. For example, 8b632b3a-a2e2-8ff3-adcd-6d119d07694b. +- State: For example, Connected. +- Id: An integer that identifies the session in the PowerShell window. The first connection is 1, the second is 2, etc. +- Name: A unique name that's based on the PowerShell environment and Id value. For example, ExchangeOnline_1 for Exchange Online PowerShell or ExchangeOnlineProtection_1 for Security & Compliance PowerShell. +- UserPrincipalName: The account that was used to connect. For example, `laura@contoso.onmicrosoft.com`. +- ConnectionUri: The connection endpoint that was used. For example, `https://outlook.office365.com` for Exchange Online PowerShell or `https://nam12b.ps.compliance.protection.outlook.com` for Security & Compliance PowerShell. +- AzureAdAuthorizationEndpointUri : The Microsoft Entra authorization endpoint for the connection. For example, `https://login.microsoftonline.com/organizations` for Exchange Online PowerShell or `https://login.microsoftonline.com/organizations` for Security & Compliance PowerShell. +- TokenExpiryTimeUTC: When the connection token expires. For example, 9/30/2023 6:42:24 PM +00:00. +- CertificateAuthentication: Whether certificate based authentication (also known as CBA or app-only authentication) was used to connect. Values are True or False. +- ModuleName: The filename and path of the temporary data for the session. For example, C:\Users\laura\AppData\Local\Temp\tmpEXO_a54z135k.qgv +- ModulePrefix: The value specified using the Prefix parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. +- Organization: The value specified using the Organization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA or managed identity connections. +- DelegatedOrganization: The value specified using the DelegatedOrganization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. +- AppId: The value specified using the AppId parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA connections. +- PageSize: The default maximum number of entries per page in the connection. The default value is 1000, or you can use the PageSize parameter in the Connect-ExchangeOnline command to specify a lower number. Individual cmdlets might also have a PageSize parameter. +- TenantID: The tenant ID GUID value. For example, 3750b40b-a68b-4632-9fb3-5b1aff664079. +- TokenStatus: For example, Active. +- ConnectionUsedForInbuiltCmdlets +- IsEopSession: For Exchange Online PowerShell connections, the value is False. For Security & Compliance PowerShell connections, the value is True. + +## EXAMPLES + +### Example 1 +```powershell +Get-ConnectionInformation +``` + +This example returns a list of all active REST-based connections with Exchange Online in the current PowerShell instance. + +### Example 2 +```powershell +Get-ConnectionInformation -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85 +``` + +This example returns the active REST-based connection with the specified ConnectionId value. + +### Example 3 +```powershell +Get-ConnectionInformation -ModulePrefix Contoso,Fabrikam +``` + +This example returns a list of active REST-based connections that are using the specified prefix values. + +## PARAMETERS + +### -ConnectionId +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ConnectionId parameter filters the connections by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. + +Don't use this parameter with the ModulePrefix parameter. + +```yaml +Type: String[] +Parameter Sets: ConnectionId +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulePrefix +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ModulePrefix parameter filters the connections by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. + +This parameter is meaningful only for connections that were created with the Prefix parameter. + +Don't use this parameter with the ConnectionId parameter. + +```yaml +Type: String[] +Parameter Sets: ModulePrefix +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Contact.md b/exchange/exchange-ps/exchange/Get-Contact.md new file mode 100644 index 0000000000..389fa44712 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Contact.md @@ -0,0 +1,333 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-Contact cmdlet to view existing contact objects in your organization. This cmdlet returns contacts and mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-Contact [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] [] +``` + +### Identity +``` +Get-Contact [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Contact +``` + +This example returns a summary list of all contacts in your organization. + +### Example 2 +```powershell +Get-Contact -Identity MarkusBreyer | Format-List +``` + +This example returns detailed information for the contact named Markus Breyer. + +### Example 3 +```powershell +Get-Contact -Anr Markus* -RecipientTypeDetails MailContact +``` + +This example uses the Anr parameter to retrieve all mail-enabled contacts whose names start with Markus. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the contact that you want to view. You can use any value that uniquely identifies the contact. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: ContactIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified contact subtype. Valid values are: + +- Contact +- MailContact +- MailForestContact + +You can specify multiple values separated by commas. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- City +- FirstName +- LastName +- Office + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md new file mode 100644 index 0000000000..8de0cb720d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md @@ -0,0 +1,75 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ContentFilterConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ContentFilterConfig cmdlet to view the content filter configuration for the computer on which the cmdlet is run. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ContentFilterConfig | Format-List +``` + +This example returns detailed information about the content filter configuration for the Exchange server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md new file mode 100644 index 0000000000..1b1f47b29b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md @@ -0,0 +1,134 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ContentFilterPhrase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ContentFilterPhrase cmdlet to view one or all custom words that the Content Filter agent processes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-ContentFilterPhrase [[-Identity] ] + [-DomainController ] + [] +``` + +### Phrase +``` +Get-ContentFilterPhrase [-Phrase ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ContentFilterPhrase +``` + +This example returns all custom words stored on the computer where the command is being run. + +### Example 2 +```powershell +Get-ContentFilterPhrase -Phrase "Free credit report" +``` + +This example returns a specific custom word specified by the Phrase parameter. In this example, the custom word is the phrase Free credit report. + +### Example 3 +```powershell +Get-ContentFilterPhrase | Where {$_.Phrase -like '*free offer*'} +``` + +This example returns all custom words and phrases that contain the words free offer. + +## PARAMETERS + +### -Identity +The Identity parameter specifies a custom word or phrase to display. You must enclose the value of the Identity parameter in quotation marks ("). + +The Identity and Phrase parameters are interchangeable. + +```yaml +Type: ContentFilterPhraseIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phrase +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. + +```yaml +Type: ContentFilterPhraseIdParameter +Parameter Sets: Phrase +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md new file mode 100644 index 0000000000..2c884d0e2f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport +applicable: Exchange Online +title: Get-ContentMalwareMdoAggregateReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ContentMalwareMdoAggregateReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ContentMalwareMdoAggregateReport cmdlet to view a summary detections by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ContentMalwareMdoAggregateReport + [-DetectionTechnology ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [-Workload ] + [] +``` + +## DESCRIPTION +For the specified reporting period, the cmdlet returns the following information: + +- Date +- Detection Technology +- Workload +- Count + +By default, the command returns data for the last 14 days. Data for the last 90 days is available. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ContentMalwareMdoAggregateReport -StartDate 1/1/2022 -EndDate 1/4/2022 -Workload OneDriveForBusiness +``` + +This example returns the results for OneDrive detections for the specified date range. + +## PARAMETERS + +### -DetectionTechnology +The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: + +- AntiMalware +- AtpSafeAttachment +- Reputation + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The EndDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter filters the results by where the detected file is located. Valid values are: + +- OneDriveForBusiness +- SharePoint +- Teams + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md new file mode 100644 index 0000000000..eb99b53c05 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport +applicable: Exchange Online +title: Get-ContentMalwareMdoDetailReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ContentMalwareMdoDetailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the ContentMalwareMdoDetailReport cmdlet to view detection details by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ContentMalwareMdoDetailReport + [-DetectionTechnology ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [-Workload ] + [] +``` + +## DESCRIPTION +For the specified reporting period, the cmdlet returns the following information: + +- Date +- File Name +- Workload +- Detection Technology +- File Size +- Last modifying user + +By default, the command returns data for the last 14 days. Data for the last 30 days is available. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ContentMalwareMdoDetailReport -StartDate 1/1/2022 -EndDate 1/4/2022 -DetectionTechnology AtpSafeAttachment +``` + +This example returns the results for detections by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams for the specified date range. + +## PARAMETERS + +### -DetectionTechnology +The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: + +- AntiMalware +- AtpSafeAttachment +- Reputation + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The EndDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter filters the results by where the detected file is located. Valid values are: + +- OneDriveForBusiness +- SharePoint +- Teams + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DataClassification.md b/exchange/exchange-ps/exchange/Get-DataClassification.md new file mode 100644 index 0000000000..9bfe9cc832 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DataClassification.md @@ -0,0 +1,136 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DataClassification + +## 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. + +Use the Get-DataClassification cmdlet to view the data classification rules in your organization. This cmdlet shows built-in data classification rules and rules that you created that use document fingerprints. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### RuleCollectionIdentity +``` +Get-DataClassification [[-ClassificationRuleCollectionIdentity] ] + [-DomainController ] + [] +``` + +### Identity +``` +Get-DataClassification [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DataClassification +``` + +This example returns a summary list of all data classification rules in the organization. + +### Example 2 +```powershell +Get-DataClassification -ClassificationRuleCollectionIdentity "Fingerprint Classification Collection" +``` + +This example returns a summary list of all new data classification rules based on document fingerprints that you created. + +### Example 3 +```powershell +Get-DataClassification "SWIFT Code" | Format-List +``` + +This example returns details of the built-in data classification rule named SWIFT Code. + +## PARAMETERS + +### -ClassificationRuleCollectionIdentity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the data classification rule that you want to view. You can use any value that uniquely identifies the data classification rule. For example: + +- Name +- LocalizedName +- Identity GUID value + +```yaml +Type: DataClassificationIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md b/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md new file mode 100644 index 0000000000..03342c3e31 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md @@ -0,0 +1,56 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DataClassificationConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DataClassificationConfig cmdlet to view the data classification configuration for your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DataClassificationConfig +``` + +This example returns the data classification configuration for your organization. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md new file mode 100644 index 0000000000..b58632caa0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DataEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DataEncryptionPolicy cmdlet to view data encryption policies in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DataEncryptionPolicy [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Data encryption policy cmdlets are the Exchange Online part of Customer Key. For more information, see [Controlling your data in Microsoft 365 using Customer Key](https://aka.ms/customerkey). + +You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DataEncryptionPolicy +``` + +This example returns a summary list of all data encryption policies in the organization. + +### Example 2 +```powershell +Get-DataEncryptionPolicy -Identity "Europe Mailboxes" +``` + +The example returns detailed information for the data encryption policy named Europe Mailboxes. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the data encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md new file mode 100644 index 0000000000..1f38d8c687 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md @@ -0,0 +1,133 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DataRetentionReport + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-DataRetentionReport cmdlet to view information about data retention in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DataRetentionReport + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [] +``` + +## DESCRIPTION +The following properties are returned by this cmdlet: + +- Organization +- Date +- Action +- DataSource +- MessageCount + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DataRetentionReport -StartDate 04/01/2018 -EndDate 04/30/2018 +``` + +This example lists the data detections for April, 2018. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +The StartDate value can't be older than 92 days from today. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md new file mode 100644 index 0000000000..6f519626b5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md @@ -0,0 +1,124 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DatabaseAvailabilityGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-DatabaseAvailabilityGroup cmdlet to obtain a variety of configuration settings, status and other information about a database availability group (DAG). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DatabaseAvailabilityGroup [[-Identity] ] + [-DomainController ] + [-Status] + [] +``` + +## DESCRIPTION +In addition to obtaining a list of DAG members, the Get-DatabaseAvailabilityGroup cmdlet can also be used to view real-time status information about a DAG, such as: + +- OperationalServers +- PrimaryActiveManager +- ReplicationPort +- NetworkNames +- WitnessShareInUse + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DatabaseAvailabilityGroup DAG1 | Format-List +``` + +This example displays the basic properties of the DAG DAG1. The output for the command is formatted as a list. + +### Example 2 +```powershell +Get-DatabaseAvailabilityGroup DAG2 -Status | Format-List +``` + +This example displays the properties of the DAG DAG2. Because it includes the Status parameter, the task also displays real-time status information for DAG2, such as the current list of operational servers and the server currently holding the Primary Active Manager role. In addition, several properties of the DAG, such as the witness server and directory configuration information are also displayed. The output for the command is formatted as a list. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### -Status +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md similarity index 78% rename from exchange/exchange-ps/exchange/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md index 6caced5d97..deb02d5a8e 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-DatabaseAvailabilityGroupNetwork @@ -13,13 +16,15 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DatabaseAvailabilityGroupNetwork cmdlet to display configuration and state information for a database availability group (DAG) network. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DatabaseAvailabilityGroupNetwork [[-Identity] ] - [-DomainController ] [-Server ] [] + [-DomainController ] + [-Server ] + [] ``` ## DESCRIPTION @@ -28,49 +33,40 @@ State information is returned for subnets and for network interfaces, as describ Valid states for Internet Protocol version 4 (IPv4) subnets - Up: All defined network interfaces in the DAG are functional and available for communication. This is the expected and normal operational state. - - Down: All defined network interfaces in the DAG are nonfunctional and have lost communication with each other and all external hosts. All connected network interfaces are in a Failed or Unreachable state. - - Partitioned: One or more network interfaces in the DAG are in an Unreachable state, but at least two interfaces can communicate with each other or an external host. - - Misconfigured: All subnets for a specified DAG network must have the same values for ReplicationEnabled and IgnoreNetwork. If any one of the subnets isn't configured with the same values for these parameters as all other subnets on the network, all subnets are in a Misconfigured state. - - Unavailable: The network isn't enabled for replication or use by the DAG, or all DAG members attached to the network are inactive or unavailable. - - Unknown: The system was unable to determine the state of the subnet. Valid states for network interfaces - Up: The network interface is functional and can communicate with all other network interfaces. This is the expected and normal operational state. - - Failed: The network interface is unable to communicate with other network interfaces or external hosts, although other network interfaces on the local area network (LAN) are able to communicate with each other and external hosts. - - Unreachable: The system was unable to communicate with at least one network interface whose state is Up. - - 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-DatabaseAvailabilityGroupNetwork -Identity DAG1 ``` This example gets basic configuration and status information for all networks in the DAG DAG1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-DatabaseAvailabilityGroupNetwork -Identity DAG1 | Format-List ``` This example gets complete configuration and status information for all networks in the DAG DAG1. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-DatabaseAvailabilityGroupNetwork -Identity DAG2\DAGNetwork02 -Server MBX1 | Format-List ``` @@ -78,44 +74,52 @@ This example gets complete configuration and status information for the network ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name of a DAG or a DAG network. ```yaml -Type: Fqdn +Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of a DAG or a DAG network. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: DatabaseAvailabilityGroupNetworkIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Server -The Server parameter specifies health information for the DAG network from a specific Mailbox server in the DAG. +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,20 +128,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/43f57126-a685-4208-ac63-4e3aba4a3e00.aspx) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..13ed2a7226 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig +applicable: Exchange Online +title: Get-DefaultTenantBriefingConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DefaultTenantBriefingConfig + [-ResultSize ] + [] +``` + +## DESCRIPTION +The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +``` +Get-DefaultTenantBriefingConfig +``` + +This example returns the default Briefing email configuration for the organization. + +## PARAMETERS + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..76bb40fd28 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig +applicable: Exchange Online +title: Get-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantMyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantMyAnalyticsFeatureConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize ] [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-DefaultTenantMyAnalyticsFeatureConfig +``` + +This example returns the default opt-in or opt-out information for the various Viva Insights settings. + +## PARAMETERS + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md new file mode 100644 index 0000000000..363d35c76f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeliveryAgentConnector + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-DeliveryAgentConnector cmdlet to retrieve information about a specific delivery agent connector in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeliveryAgentConnector [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DeliveryAgentConnector "Contoso X.400 Connector" | Format-List +``` + +This example reads the configuration of the delivery agent connector named Contoso X.400 Connector from Active Directory and displays all of its properties in a list format. + +### Example 2 +```powershell +Get-DeliveryAgentConnector | Format-Table Name,DeliveryProtocol +``` + +This example retrieves a list of all delivery agent connectors in your organization and displays their names and delivery protocols in a table format. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DetailZapReport.md b/exchange/exchange-ps/exchange/Get-DetailZapReport.md new file mode 100644 index 0000000000..e2332bf377 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DetailZapReport.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-detailzapreport +applicable: Exchange Online +title: Get-DetailZapReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DetailZapReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DetailZapReport cmdlet to view details about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DetailZapReport + [[-EndDate] ] + [[-Page] ] + [[-PageSize] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following default information: + +- Subject +- Received Time +- Sender + +If you append the command with ` | Format-List`, the following additional information is returned for each entry: + +- Recipient +- ZAP Time +- Original Threat +- Original Location +- Updated Threat +- Updated Delivery Location +- Delivery Status +- Detection Technology + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DetailZapReport +``` + +This example retrieves information for the last 3 days. + +### Example 2 +```powershell +Get-DetailZapReport -StartDate 7/1/2023 -EndDate 7/9/2023 +``` + +This example retrieves information for the specified date range. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md b/exchange/exchange-ps/exchange/Get-DetailsTemplate.md similarity index 75% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md rename to exchange/exchange-ps/exchange/Get-DetailsTemplate.md index 62cb513633..71900617a9 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md +++ b/exchange/exchange-ps/exchange/Get-DetailsTemplate.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-DetailsTemplate @@ -13,38 +16,41 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DetailsTemplate cmdlet to retrieve the attributes for details templates. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DetailsTemplate [[-Identity] ] [-Confirm] [-DomainController ] [-WhatIf] +Get-DetailsTemplate [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-DetailsTemplate -Identity en-us\User ``` This example retrieves all attributes for the User details template for the English language. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-DetailsTemplate -Identity *\* ``` This example retrieves all attributes for all details template types in all languages. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-DetailsTemplate -Identity *\User ``` @@ -52,11 +58,33 @@ This example retrieves all attributes for all User details template types in all ## PARAMETERS +### -Identity +The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types are: + +- User +- Group +- PublicFolder +- SearchDialog +- MailboxAgent +- Contact + +```yaml +Type: DetailsTemplateIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -64,6 +92,7 @@ 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 @@ -79,6 +108,7 @@ 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 @@ -86,33 +116,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types are: - -- User - -- Group - -- PublicFolder - -- SearchDialog - -- MailboxAgent - -- Contact - -```yaml -Type: DetailsTemplateIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -WhatIf The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -121,6 +124,7 @@ 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 @@ -129,20 +133,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/55efbcfc-838c-404c-a5b2-bbd7270ff0c5.aspx) diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md new file mode 100644 index 0000000000..a79926c166 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md @@ -0,0 +1,87 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeviceConditionalAccessPolicy + +## 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-DeviceConditionalAccessPolicy cmdlet to view mobile device conditional access policies in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeviceConditionalAccessPolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConditionalAccessPolicy | Format-Table Name,Enabled,Priority +``` + +This example shows summary information for all mobile device conditional access policies. + +### Example 2 +```powershell +Get-DeviceConditionalAccessPolicy -Identity "Human Resources" +``` + +This example shows details about the mobile device conditional access policy named Human Resources. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md new file mode 100644 index 0000000000..65fe845674 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeviceConditionalAccessRule + +## 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-DeviceConditionalAccessRule cmdlet to view mobile device conditional access rules in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeviceConditionalAccessRule [[-Identity] ] + [-CompareToWorkload] + [-DomainController ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConditionalAccessRule | Format-List Name,Disabled,Priority +``` + +This example shows a summary list of all mobile device conditional access rules. + +### Example 2 +```powershell +Get-DeviceConditionalAccessRule -Identity "Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}" +``` + +This example shows details for the mobile device conditional access rule named Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CompareToWorkload +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 +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md new file mode 100644 index 0000000000..34e6dc1ae0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md @@ -0,0 +1,87 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeviceConfigurationPolicy + +## 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-DeviceConfigurationPolicy cmdlet to view mobile device configuration policies in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeviceConfigurationPolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConfigurationPolicy | Format-Table Name,Enabled,Priority +``` + +This example shows summary information for all mobile device configuration policies. + +### Example 2 +```powershell +Get-DeviceConfigurationPolicy -Identity "Engineering Group" +``` + +This example shows details about the mobile device configuration policy named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md new file mode 100644 index 0000000000..84afa08d75 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeviceConfigurationRule + +## 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-DeviceConfigurationRule cmdlet to view mobile device configuration rules in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeviceConfigurationRule [[-Identity] ] + [-CompareToWorkload] + [-DomainController ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConfigurationRule | Format-List Name,Disabled,Priority +``` + +This example shows summary information for all mobile device configuration rules. + +### Example 2 +```powershell +Get-DeviceConfigurationRule -Identity "Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}" +``` + +This example shows details about the mobile device configuration rule named Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136} + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CompareToWorkload +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 +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DevicePolicy.md b/exchange/exchange-ps/exchange/Get-DevicePolicy.md new file mode 100644 index 0000000000..f7cb5c1dce --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DevicePolicy.md @@ -0,0 +1,87 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DevicePolicy + +## 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-DevicePolicy cmdlet to view all types of Basic Mobility and Security policies in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DevicePolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DevicePolicy | Format-Table Name,Type,Enabled,Priority +``` + +This example shows summary information for all mobile device policies. + +### Example 2 +```powershell +Get-DevicePolicy -Identity "Engineering Group" +``` + +This example shows details about the mobile device policy named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md new file mode 100644 index 0000000000..ce5c1c516e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md @@ -0,0 +1,76 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeviceTenantPolicy + +## 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-DeviceTenantPolicy cmdlet to view your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeviceTenantPolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceTenantPolicy +``` + +This example shows information for your organization's mobile device tenant policy. + +## PARAMETERS + +### -Identity +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 +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-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md new file mode 100644 index 0000000000..3d61488bdc --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md @@ -0,0 +1,93 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DeviceTenantRule + +## 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-DeviceTenantRule cmdlet to view your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DeviceTenantRule [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceTenantRule +``` + +This example shows information for your organization's mobile device tenant rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the mobile device tenant rule that you want to view, but there's only one in your organization. The name of the rule is a GUID value. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. + +```yaml +Type: 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-DistributionGroup.md b/exchange/exchange-ps/exchange/Get-DistributionGroup.md new file mode 100644 index 0000000000..601c6b2a36 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DistributionGroup.md @@ -0,0 +1,509 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-DistributionGroup cmdlet to view existing distribution groups or mail-enabled security groups. To view the members of a group, use the Get-DistributionGroupMember cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-DistributionGroup [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] [] +``` + +### Identity +``` +Get-DistributionGroup [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] [] +``` + +### ManagedBySet +``` +Get-DistributionGroup [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-ManagedBy ] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-DistributionGroup +``` + +This examples returns a summary list of all distribution groups and mail-enabled security groups in your organization. + +### Example 2 +```powershell +Get-DistributionGroup -Identity "Marketing Reports" | Format-List +``` + +This example returns detailed information about the distribution group named Marketing Reports. + +### Example 3 +```powershell +Get-DistributionGroup -Anr marketing | Format-Table Name, ManagedBy -Auto +``` + +This example returns all distribution groups and mail-enabled security groups whose names contain the string "marketing" and shows the group owners. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the distribution group or mail-enabled security group that you want to view. You can use any values that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: DistributionGroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromDLMembers recipients in the AcceptMessagesOnlyFromDLMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromDLMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromDLMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFrom recipients in the AcceptMessagesOnlyFromWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFrom recipients are shown as GUIDs and the AcceptMessagesOnlyFromWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeModeratedByWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified distribution group subtype. Valid values are: + +- MailNonUniversalGroup +- MailUniversalDistributionGroup +- MailUniversalSecurityGroup +- RoomList + +You can specify multiple values separated by commas. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias +- City +- FirstName +- LastName +- Office +- ServerLegacyDN + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md new file mode 100644 index 0000000000..3113e769e2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md @@ -0,0 +1,231 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DistributionGroupMember [-Identity] + [-Credential ] + [-DomainController ] + [-IgnoreDefaultScope] + [-IncludeSoftDeletedObjects] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## DESCRIPTION +If your organization has multiple Active Directory domains, you may need to run the Set-ADServerSettings cmdlet with the ViewEntireForest parameter set to $true before running the Get-DistributionGroupMember cmdlet to view the entire forest. For more information, see Example 2. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DistributionGroupMember -Identity "Marketing USA" +``` + +This example returns the existing distribution group members for the distribution group named Marketing USA. + +### Example 2 +```powershell +Set-ADServerSettings -ViewEntireForest $true + +Get-DistributionGroupMember -Identity "Marketing Worldwide" +``` + +This example sets the scope of the search to the entire forest by running the Set-ADServerSettings cmdlet, then the Get-DistributionGroupMember cmdlet searches the entire forest for the distribution group members in the Marketing Worldwide distribution group. + +### Example 3 +```powershell +$Groups = Get-UnifiedGroup -ResultSize Unlimited + +$Groups | ForEach-Object { +$group = $_ +Get-UnifiedGroupLinks -Identity $group.Name -LinkType Members -ResultSize Unlimited | ForEach-Object { + New-Object -TypeName PSObject -Property @{ + Group = $group.DisplayName + Member = $_.Name + EmailAddress = $_.PrimarySMTPAddress + RecipientType= $_.RecipientType +}}} | Export-CSV "$env:USERPROFILE\Desktop\Office365GroupMembers.csv" -NoTypeInformation -Encoding UTF8 +``` + +In the cloud-based service, this example downloads a comma-separated value (CSV) file named Office365GroupMembers.csv that contains all Microsoft 365 Groups and members to the current user's Desktop. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IncludeSoftDeletedObjects +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. + +Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md new file mode 100644 index 0000000000..9fe8d4bfd8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md @@ -0,0 +1,80 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DkimSigningConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DkimSigningConfig cmdlet to view the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DkimSigningConfig +``` + +This example shows a summary list of all DKIM signing policies in your organization. + +### Example 2 +```powershell +Get-DkimSigningConfig -Identity contoso.com | Format-List +``` + +This example shows detailed information for the DKIM signing policy for contoso.com. + +## PARAMETERS + +### -Identity +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). +- Distinguished name (DN) +- GUID + +```yaml +Type: DkimSigningConfigIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md new file mode 100644 index 0000000000..f5a379ed1b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md @@ -0,0 +1,231 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-DlpCompliancePolicy to view data loss prevention (DLP) policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpCompliancePolicy [[-Identity] ] + [-DisplayName ] + [-DistributionDetail] + [-ForceValidate ] + [-IncludeExtendedProperties ] + [-IncludeRulesMetadata ] + [-IncludeSimulationResults ] + [-IRMUserRiskConfiguredAnyRule] + [-Summary] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpCompliancePolicy +``` + +This example displays summary information for all DLP policies in the Microsoft Purview compliance portal. + +### Example 2 +```powershell +Get-DlpCompliancePolicy -Identity "PII Limited" | Format-List +``` + +This example displays detailed information for the DLP policy named "PII Limited". + +### Example 3 +```powershell +Get-DlpCompliancePolicy -Identity "PII Limited" -DistributionDetail | Format-List DistributionStatus +``` + +This example displays distribution details for a DLP policy. + +### Example 4 +```powershell +$dlp = Get-DlpCompliancePolicy; ForEach ($d in $dlp){Get-DlpCompliancePolicy -DistributionDetail $d.name | Format-List Name,DistributionStatus} +``` + +This example gets all of the DLP policies in an environment and displays the distribution status for each. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DisplayName +{{ Fill DisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. + +**Tip**: The DistributionResults property is unreliable and prone to errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeExtendedProperties +{{ Fill IncludeExtendedProperties 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 +``` + +### -IncludeRulesMetadata +{{ Fill IncludeRulesMetadata Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IRMUserRiskConfiguredAnyRule +{{ Fill IRMUserRiskConfiguredAnyRule Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSimulationResults +{{ Fill IncludeSimulationResults Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Summary +{{ Fill Summary Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md new file mode 100644 index 0000000000..3ec06ed550 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md @@ -0,0 +1,142 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-DlpComplianceRule to view data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules identify and protect sensitive information. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpComplianceRule [[-Identity] ] + [-DisplayName ] + [-IncludeExecutionRuleGuids ] + [-Policy ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpComplianceRule +``` + +This example displays summary information for all DLP rules in the Microsoft Purview compliance portal. + +### Example 2 +```powershell +Get-DlpComplianceRule -Identity "PII SS# Custom" | Format-List +``` + +This example displays detailed information for the DLP rule named "PII SS# Custom". + +### Example 3 +```powershell +Get-DlpComplianceRule -Policy "PII Limited" +``` + +This example lists all the rules included in the DLP compliance policy named "PII Limited". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Id + +```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 +``` + +### -DisplayName +{{ Fill DisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeExecutionRuleGuids +{{ Fill IncludeExecutionRuleGuids Description }} + +```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 +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md new file mode 100644 index 0000000000..ec4460246a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -0,0 +1,279 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpDetailReport + +## SYNOPSIS +**Note**: This cmdlet has been retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. + +This cmdlet is available only in the cloud-based service. + +Use the Get-DlpDetailReport cmdlet to list details about data loss prevention (DLP) rule matches for Exchange Online, SharePoint, and OneDrive in your cloud-based organization for the last 30 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpDetailReport [-Action ] + [-Actor ] + [-DlpCompliancePolicy ] + [-DlpComplianceRule ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-Source ] + [-StartDate ] + [] +``` + +## DESCRIPTION +The Get-DlpDetailReport cmdlet returns detailed information about specific DLP rule matches for the last 7 days. Although the cmdlet accepts date ranges older than 7 days, only information about the last 7 days are returned. The properties returned include: + +- Date +- Title +- Location +- Severity +- Size +- Source +- Actor +- DLPPolicy +- UserAction +- Justification +- SensitiveInformationType +- SensitiveInformationCount +- SensitiveInformationConfidence +- EventType +- Action +- ObjectId +- 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-DlpDetailReport -StartDate 11/01/2018 -EndDate 11/07/2018 +``` + +The following example lists the details of all the DLP policy activities defined in your organization between the dates specified. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken by DLP policies. Valid values are: + +- BlockAccess +- GenerateIncidentReport +- NotifyUser + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Actor +The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpCompliancePolicy +The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpComplianceRule +The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- DLPActionHits +- DLPActionUndo +- DLPMessages +- DLPPolicyFalsePositive +- DLPPolicyHits +- DLPPolicyOverride +- DLPRuleHits + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify DLP event types for DLP reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +The Source parameter filters the report by workload. Valid values are: + +- EXCH: Exchange Online +- ODB: OneDrive +- SPO: SharePoint + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md new file mode 100644 index 0000000000..be1c5ba605 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -0,0 +1,318 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpDetectionsReport + +## 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. + +Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint and OneDrive in your cloud-based organization for the last 30 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpDetectionsReport [-Action ] + [-AggregateBy ] + [-DlpCompliancePolicy ] + [-DlpComplianceRule ] + [-EndDate ] + [-Expression ] + [-EventType ] + [-Page ] + [-PageSize ] + [-Source ] + [-StartDate ] + [-SummarizeBy ] + [] +``` + +## DESCRIPTION +The Get-DlpDetectionsReport cmdlet returns general DLP detection data that's aggregated per day. The properties returned include: + +- Date +- DLP Policy +- DLP Compliance Rule +- Event Type +- Source +- Message Count + +To see all of these columns (width issues), write the output to a file. For example, `Get-DlpDetectionsReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\DLP Detections Report.txt"`. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpDetectionsReport -StartDate 11/01/2018 -EndDate 11/30/2018 +``` + +This example lists the DLP activities for November, 2018. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken by DLP policies. Valid values are: + +- BlockAccess +- GenerateIncidentReport +- NotifyUser + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpCompliancePolicy +The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpComplianceRule +The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- DataRetentions +- DLPActionHits +- DLPActionUndo +- DLPByIncidentIdActionHits +- DLPByIncidentIdMessages +- DLPByIncidentIdPolicyFalsePositive +- DLPByIncidentIdPolicyHits +- DLPByIncidentIdPolicyOverride +- DLPByIncidentIdRuleHits +- DLPMessages +- DLPPolicyFalsePositive +- DLPPolicyHits +- DLPPolicyOverride +- DLPRuleHits + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify DLP event types for DLP reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expression +This parameter is available only in Security & Compliance PowerShell + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Expression +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +The Source parameter filters the report by workload. Valid values are: + +- EXCH: Exchange Online +- ODB: OneDrive +- SPO: SharePoint + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. + +For this cmdlet, valid values are: + +- DLPPolicy +- Domain +- EventType + +You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, 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-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md new file mode 100644 index 0000000000..d9052762b8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md @@ -0,0 +1,79 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpEdmSchema + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-DlpEdmSchema cmdlet to view exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpEdmSchema [[-Identity] ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpEdmSchema +``` + +This example returns a summary list of all DLP EDM schemas in the organization. + +### Example 2 +```powershell +Get-DlpEdmSchema -Identity "Schema for Patient Records" +``` + +This example returns detailed information for the DLP EDM schema named Schema for patient Records. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) + +```yaml +Type: EdmStorageIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits) diff --git a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md new file mode 100644 index 0000000000..59707c5464 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpincidentdetailsreport +applicable: Exchange Online, Security & Compliance +title: Get-DlpIncidentDetailReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpIncidentDetailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) instead. + +Use the Get-DlpIncidentDetailReport cmdlet to view the details of incidents that happened in the last 30 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpIncidentDetailReport + [-Action ] + [-Actor ] + [-DlpCompliancePolicy ] + [-DlpComplianceRule ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-Source ] + [-StartDate ] + [] +``` + +## DESCRIPTION +The output of the Get-DlpIncidentDetailReport cmdlet includes the following properties: + +- Date +- Title +- Location +- Severity +- Size +- Source +- Actor +- DlpCompliancePolicy +- DlpComplianceRule +- UserAction +- Justification +- SensitiveInformationType +- SensitiveInformationCount +- SensitiveInformationConfidence +- EventType +- Action +- DistinctRuleCount +- DistinctPolicyCount +- RuleList +- PolicyList +- ActionList +- SensitiveInformationTypeList +- SensitiveInformationCountList +- SensitiveInformationConfidenceList + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpIncidentDetailReport -StartDate 2022/11 -EndDate 2022/11/30 +``` + +This example lists the details of the all incidents that occurred between the dates specified. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken by DLP policies. Valid values are: + +- BlockAccess +- GenerateIncidentReport +- NotifyUser + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Actor +The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpCompliancePolicy +The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpComplianceRule +The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- DLPByIncidentIdActionHits +- DLPByIncidentIdMessages +- DLPByIncidentIdPolicyFalsePositive +- DLPByIncidentIdPolicyHits +- DLPByIncidentIdPolicyOverride +- DLPByIncidentIdRuleHits + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify DLP incident event types for DLP incident reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +The Source parameter filters the report by workload. Valid values are: + +- EXCH: Exchange Online +- ODB: OneDrive +- SPO: SharePoint +- TEAMS + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md new file mode 100644 index 0000000000..cf21bb85d5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md @@ -0,0 +1,74 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpKeywordDictionary + +## 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-DlpKeywordDictionary cmdlet to view data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpKeywordDictionary [-Name ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpKeywordDictionary | Format-Table -Auto Name,Description +``` + +This example returns a summary list of all DLP keyword dictionaries. + +### Example 2 +```powershell +Get-DlpKeywordDictionary -Name "Financial Data" +``` + +This example returns detailed information about the DLP keyword dictionary named Financial Data. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DlpPolicy.md b/exchange/exchange-ps/exchange/Get-DlpPolicy.md new file mode 100644 index 0000000000..ef75ad1628 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpPolicy.md @@ -0,0 +1,103 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +This cmdlet is functional only in on-premises Exchange. + +Use the Get-DlpPolicy cmdlet to view existing data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpPolicy [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpPolicy +``` + +This example returns a summary list of all DLP policies. + +### Example 2 +```powershell +Get-DlpPolicy "Employee Numbers" | Format-List +``` + +This example returns detailed information about the DLP policy named Employee Numbers. The command is piped to the Format-List cmdlet to display the detailed configuration of the specified DLP policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DlpPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md new file mode 100644 index 0000000000..bafb90d765 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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). + +This cmdlet is functional only in on-premises Exchange. + +Use the Get-DlpPolicyTemplate cmdlet to view existing data loss prevention (DLP) policy templates that are based on transport rules (mail flow rules) in your Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpPolicyTemplate [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpPolicyTemplate +``` + +This example returns a summary list of all DLP policy templates. + +### Example 2 +```powershell +Get-DlpPolicyTemplate GLBA | Format-List +``` + +This example returns detailed information about the DLP policy template named GLBA. The command is piped to the Format-List cmdlet to display the detailed configuration of the specified DLP policy template. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy template you want to view. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. + +```yaml +Type: DlpPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md new file mode 100644 index 0000000000..99d0a14db7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md @@ -0,0 +1,147 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpSensitiveInformationType + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-DlpSensitiveInformationType cmdlet to list the sensitive information types that are defined for your organization in the Microsoft Purview compliance portal. Sensitive information types are used by data loss prevention (DLP) rules to check for sensitive information such as social security, passport, or credit card numbers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpSensitiveInformationType [[-Identity] ] + [-Capability ] + [-IncludeDetails] + [-IncludeElements ] + [-Organization ] + [] +``` + +## DESCRIPTION +The RecommendedConfidence property of the returned objects contains a value that represents the default (or recommended) confidence level that should be used with the corresponding sensitive information type. + +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-DlpSensitiveInformationType +``` + +This example lists all the sensitive information types defined for your organization. + +### Example 2 +```powershell +Get-DlpSensitiveInformationType -Identity "Credit Card Number" | Format-List +``` + +This example lists all the properties of the sensitive information type named "Credit Card Number". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the sensitive information type that you want to view. Valid values are: + +- Name +- Id (GUID value) + +```yaml +Type: SensitiveInformationTypeIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Capability +{{ Fill Capability Description }} + +```yaml +Type: ClassificationCapabilityType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +{{ Fill IncludeDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeElements +{{ Fill IncludeElements Description }} + +```yaml +Type: ClassificationPrimitiveElementType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md new file mode 100644 index 0000000000..322925e01f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md @@ -0,0 +1,97 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpSensitiveInformationTypeRulePackage + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-DlpSensitiveInformationTypeRulePackage cmdlet to view data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpSensitiveInformationTypeRulePackage [[-Identity] ] + [-Capability ] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpSensitiveInformationTypeRulePackage +``` + +This example returns a summary list of all sensitive information type rule packages in the organization. + +### Example 2 +```powershell +Get-DlpSensitiveInformationTypeRulePackage -Identity "Microsoft Rule Package" | Format-List +``` + +This example returns detailed information for the sensitive information type rule package named Microsoft Rule Package. + +## PARAMETERS + +### -Identity +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 +- LocalizedName +- GUID (from the Identity value) + +```yaml +Type: SensitiveInformationTypeRuleCollectionIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Capability +{{ Fill Capability Description }} + +```yaml +Type: ClassificationCapabilityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md new file mode 100644 index 0000000000..b89d2416f2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -0,0 +1,106 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpSiDetectionsReport + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. + +Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft Purview compliance portal for the last 90 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpSiDetectionsReport [-EndDate ] + [-SensitiveType ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- Organization +- Date +- SensitiveType: The GUID value of the DLP sensitive information type. To match the GUID value to the name of the sensitive information type, replace `` with the GUID value and run this command: `Get-DlpSensitiveInformationType -Identity `. +- DocumentCount: The number of documents that contain the detected sensitive information type. +- ProtectionStatus: Values are Unprotected (the sensitive information type is not defined in any DLP policy) or Protected (the sensitive information type is defined in a DLP policy). +- DlpComplianceRuleIds: The GUID value of the DLP compliance rule that detected the sensitive information type (for ProtectionStatus values of Protected). To match the GUID value to the name of the DLP compliance rule, replace `` with the GUID value and run this command: `Get-DlpComplianceRule -Identity `. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DLPSiDetectionsReport +``` + +This example returns all DLP sensitive information type detections. + +### Example 2 +```powershell +Get-DLPSiDetectionsReport -SensitiveType 0e9b3178-9678-47dd-a509-37222ca96b42 -EndDate 4/8/2019 +``` + +This example returns detections for the sensitive information type 0e9b3178-9678-47dd-a509-37222ca96b42 (EU Debit Card Number) during the specified date range. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SensitiveType +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md b/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md new file mode 100644 index 0000000000..05ddacb11c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-dnssecstatusforverifieddomain +applicable: Exchange Online +title: Get-DnssecStatusForVerifiedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DnssecStatusForVerifiedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DnssecStatusForVerifiedDomain cmdlet to view information about Domain Name System Security (DNSSEC) for accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DnssecStatusForVerifiedDomain [-DomainName] + [-Confirm] + [-SkipDnsValidation] + [-SkipMtaStsValidation] + [-SkipMxValidation] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-DnssecStatusForVerifiedDomain -DomainName contoso.com + +DnssecFeatureStatus : Enabled +ExpectedMxRecord : Microsoft.Exchange.Management.ProvisioningTasks.ExpectedMxRecordInfo +Errors : {} +Warnings : {} +DnsValidation : Microsoft.Exchange.Management.ProvisioningTasks.DnsValidationResult +MxValidation : Microsoft.Exchange.Management.ProvisioningTasks.MxValidationResult +MtaStsValidation : Microsoft.Exchange.Management.ProvisioningTasks.MtaStsValidationResult +``` + +This example shows the basic output of the cmdlet for the domain contoso.com. + +### Example 2 +```powershell +PS C:\> $result = Get-DnssecStatusForVerifiedDomain -DomainName contoso.com; $result; "DNSSEC feature"; $result.DnssecFeatureStatus; "DNSSEC validation"; $result.DnsValidation; "Expected MX record: [$($result.ExpectedMxRecord.Record)]"; "", "MX validation"; $result.MxValidation; "MTA-STS validation"; $result.MtaStsValidation + +DnssecFeatureStatus : Enabled +ExpectedMxRecord : Microsoft.Exchange.Management.ProvisioningTasks.ExpectedMxRecordInfo +Errors : {} +Warnings : {} +DnsValidation : Microsoft.Exchange.Management.ProvisioningTasks.DnsValidationResult +MxValidation : Microsoft.Exchange.Management.ProvisioningTasks.MxValidationResult +MtaStsValidation : Microsoft.Exchange.Management.ProvisioningTasks.MtaStsValidationResult + +DNSSEC feature +Value : Enabled + +DNSSEC validation +DnssecSupport : Valid +Errors : {} +Warnings : {} + +Expected MX record: [@ 60 IN MX 10 contoso-com.e-v1.mx.microsoft] + +MX validation +Status : Valid +ActualMxRecords : {@ 60 IN MX 10 contoso-com.e-v1.mx.microsoft} +Errors : {} +Warnings : {} + +MTA-STS validation +Status : Valid +MtaStsAvailable : False +MtaStsMode : Unavailable +Errors : {} +Warnings : {} +``` + +This example contains the output from Example 1 and readable values for the DnsValidation, MxValidation, and MtaStsValidation properties. This command confirms the following information: + +- The DNSSEC-secured MX record is present in the domain. +- The priority of the MX record is 10. +- The MTA-STS Policy contains the DNSSEC-secured mail host (if MTA-STS present). + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to view information about DNSSEC (for example, contoso.com). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDnsValidation +The SkipDnsValidation switch specifies whether to skip the check for the DNSSEC-secured MX record in the domain. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMtaStsValidation +The SkipMtaStsValidation switch specifies whether to skip the check for the DNSSEC-secured mail host in the MTA-STS Policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMxValidation +The SkipMxValidation switch specifies whether to skip the check for the priority value 10 in the DNSSEC-secured MX record. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DomainController.md b/exchange/exchange-ps/exchange/Get-DomainController.md new file mode 100644 index 0000000000..b36194819e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DomainController.md @@ -0,0 +1,144 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DomainController + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-DomainController cmdlet to view a list of domain controllers that exist in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### GlobalCatalog +``` +Get-DomainController [-GlobalCatalog] + [-Forest ] + [-Credential ] + [] +``` + +### DomainController +``` +Get-DomainController [-DomainName ] + [-Credential ] + [] +``` + +## DESCRIPTION + +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). + +## EXAMPLES + +### Example 1 +```powershell +$UserCredentials = Get-Credential + +Get-DomainController -DomainName corp.contoso.com -Credential $UserCredentials | Format-Table -AutoSize Name,ADSite +``` + +This example retrieves a list of global catalog servers in the corp.contoso.com domain. Because a different set of credentials are required to access this domain, the Get-Credential cmdlet is used to obtain the username and password from the user. + +The first command displays a prompt to the user that accepts the username and password. The credentials are then stored in the $UserCredentials variable. The second command uses the $UserCredentials variable for the Credential parameter value. To make the list more readable, the output is piped to the Format-Table cmdlet and only the Name and ADSite properties are displayed. + +For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +## PARAMETERS + +### -GlobalCatalog +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +If you use the Forest parameter, the credentials are used to access the forest. + +```yaml +Type: NetworkCredential +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 +``` + +### -DomainName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md new file mode 100644 index 0000000000..d988b7788e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md @@ -0,0 +1,513 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-DynamicDistributionGroup cmdlet to view existing dynamic distribution groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-DynamicDistributionGroup [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeSystemObjects] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +### Identity +``` +Get-DynamicDistributionGroup [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeSystemObjects] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +### ManagedBySet +``` +Get-DynamicDistributionGroup [-ManagedBy ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeSystemObjects] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-DynamicDistributionGroup +``` + +This example returns a summary list of all dynamic distribution groups in your organization. + +### Example 2 +```powershell +Get-DynamicDistributionGroup -Identity "Marketing Department" | Format-List +``` + +This example returns detailed information about the dynamic distribution group named Marketing Department. + +### Example 3 +```powershell +Get-DynamicDistributionGroup -Anr *research* | Format-Table Name, ManagedBy -Auto +``` + +This example returns all dynamic distribution groups whose names contain the string "research" and shows the group owners. + +### Example 4 +```powershell +$FTE = Get-DynamicDistributionGroup "Full Time Employees" + +Get-Recipient -RecipientPreviewFilter $FTE.RecipientFilter -OrganizationalUnit $FTE.RecipientContainer +``` + +This example returns the members for the dynamic distribution group named Full Time Employees. The first command stores the dynamic distribution group object in the variable $FTE. The second command uses the Get-Recipient cmdlet to list the recipients that match the criteria defined for the dynamic distribution group. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromDLMembers recipients in the AcceptMessagesOnlyFromDLMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromDLMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromDLMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFrom recipients in the AcceptMessagesOnlyFromWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFrom recipients are shown as GUIDs and the AcceptMessagesOnlyFromWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeModeratedByWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSystemObjects +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md new file mode 100644 index 0000000000..d93483e17c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-DynamicDistributionGroupMember + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DynamicDistributionGroupMember cmdlet to view the calculated membership list that's stored on dynamic distribution group objects. The results from this cmdlet are updated every 24 hours. + +Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DynamicDistributionGroupMember [-Identity] + [-Credential ] + [-IncludeSoftDeletedObjects] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DynamicDistributionGroupMember -Identity "Temporary Employees" +``` + +This example returns the existing members for the dynamic distribution group named Temporary Employees. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the dynamic distribution group. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: DynamicDistributionGroupMemberIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedObjects +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..6ca809c445 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md @@ -0,0 +1,103 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EOPProtectionPolicyRule + +## 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. + +For 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-EOPProtectionPolicyRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EOPProtectionPolicyRule | Format-Table Name,State +``` + +This example returns a summary list of the rules for EOP protections in preset security policies. + +### Example 2 +```powershell +Get-EOPProtectionPolicyRule -Identity "Strict Preset Security Policy" +``` + +This example returns detailed information about the rule named Strict Preset Security Policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Enabled +- Disabled. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md new file mode 100644 index 0000000000..72e7aca6f2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md @@ -0,0 +1,450 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOCasMailbox + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXOCasMailbox cmdlet to view the Client Access settings that are configured on mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-EXOCasMailbox [[-Identity] ] + [-ActiveSyncDebugLogging] + [-ExternalDirectoryObjectId ] + [-Filter ] + [-GetImapProtocolLog] + [-GetPopProtocolLog] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-Properties ] + [-PropertySets ] + [-ProtocolSettings] + [-ReadIsOptimizedForAccessibility] + [-ResultSize ] + [-SendLogsTo ] + [-UserPrincipalName ] + [] +``` + +### Anr +``` +Get-EXOCasMailbox [-Anr ] + [-ActiveSyncDebugLogging] + [-Filter ] + [-GetImapProtocolLog] + [-GetPopProtocolLog] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-Properties ] + [-PropertySets ] + [-ProtocolSettings] + [-ReadIsOptimizedForAccessibility] + [-ResultSize ] + [-SendLogsTo ] + [] +``` + +## 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. + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOCASMailbox -Identity "JeffHay@contoso.com" +``` + +This example returns the values of the following client access settings for the user with Identity Jeffhay@contoso.com: + +- ActiveSyncEnabled +- EwsEnabled +- OWAEnabled +- PopEnabled +- ImapEnabled +- MAPIEnabled +- ECPEnabled + +## PARAMETERS + +### -Identity +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) +- GUID + +Otherwise, you can use any other value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Domain\\Username +- Email address +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Anr +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncDebugLogging +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetImapProtocolLog +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetPopProtocolLog +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. + +For more information about the available properties, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertySets +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) +- ActiveSync +- Ews +- Imap +- Mapi +- Pop +- ProtocolSettings +- All + +You can specify multiple values separated by commas. + +For more information about the properties that are included in each property set, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). + +```yaml +Type: PropertySet[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtocolSettings +The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: + +- ExternalImapSettings +- InternalImapSettings +- ExternalPopSettings +- InternalPopSettings +- ExternalSmtpSettings +- InternalSmtpSettings + +You don't need to specify a value with this switch. + +To see these values, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadIsOptimizedForAccessibility +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendLogsTo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +The following Get-CasMailbox parameters are not available or supported in Get-EXOCasMailbox: + +- IgnoreDefaultScope +- ReadIsOptimizedForAccessibility +- SortBy + +## OUTPUTS + +### Output types +The following properties are removed by design from Get-EXOCasMailbox output: + +- RunspaceId +- Servername +- OriginatingServer +- IsValid + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/exchange/Get-EXOMailbox.md new file mode 100644 index 0000000000..fb1295de5f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOMailbox.md @@ -0,0 +1,559 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOMailbox + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXOMailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-EXOMailbox [[-Identity] ] + [-Archive] + [-Async] + [-ExternalDirectoryObjectId ] + [-Filter ] + [-GroupMailbox] + [-InactiveMailboxOnly] + [-IncludeInactiveMailbox] + [-MailboxPlan ] + [-Migration] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-Properties ] + [-PropertySets ] + [-PublicFolder] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SoftDeletedMailbox] + [-UserPrincipalName ] + [] +``` + +### Anr +``` +Get-EXOMailbox [-Anr ] + [-Archive] + [-Async] + [-Filter ] + [-GroupMailbox] + [-InactiveMailboxOnly] + [-IncludeInactiveMailbox] + [-MailboxPlan ] + [-Migration] + [-OrganizationalUnit ] + [-Properties ] + [-PropertySets ] + [-PublicFolder] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SoftDeletedMailbox] + [] +``` + +## DESCRIPTION +By default, this cmdlet returns a summary list (a minimum set of properties) of all mailboxes in your organization. + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOMailbox -ResultSize unlimited +``` + +This example returns a summary list of all mailboxes in the organization, and includes the default set of minimum output properties. To return additional properties, use the Properties and/or PropertySets parameters. + +### Example 2 +```powershell +Get-EXOMailbox -PropertySets Archive +``` + +This example returns the Properties that are defined in Archive property set. For a complete list of these properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). + +### Example 3 +```powershell +Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit +``` + +This example returns a summary list of all mailboxes in the organization, and includes the following properties: + +- The properties in Archive and Audit property sets. +- The Name and DistinguishedName properties. + +### Example 4 +```powershell +Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias +``` + +This example returns the specified properties for the mailbox John@contoso.com. + +## PARAMETERS + +### -Identity +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) +- GUID + +Otherwise, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Domain\\Username +- Email address +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Anr +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Async +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InactiveMailboxOnly +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. + +To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeInactiveMailbox +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. + +To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxPlan +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 +- Alias +- Display name +- Distinguished name (DN) +- GUID + +A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Migration +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. + +For more information about the available properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertySets +The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: + +- All +- Minimum (this is the default value) +- AddressList +- Archive +- Audit +- Custom +- Delivery +- Hold +- Moderation +- Move +- Policy +- PublicFolder +- Quota +- Resource +- Retention +- SCL +- SoftDelete +- StatisticsSeed + +You can specify multiple values separated by commas. + +For more information about the properties that are included in each property set, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). + +```yaml +Type: PropertySet[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: + +- DiscoveryMailbox +- EquipmentMailbox +- GroupMailbox +- LegacyMailbox +- LinkedMailbox +- LinkedRoomMailbox +- RoomMailbox +- SchedulingMailbox +- SharedMailbox +- TeamMailbox +- UserMailbox + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types + +The following Get-Mailbox parameters aren't available or functional in Get-EXOMailbox: + +- Async +- GroupMailbox +- Migration +- PublicFolder +- SortBy + +## OUTPUTS + +### Output types +The following properties aren't included in the output of Get-EXOMailbox: + +- RunspaceId +- Servername +- AdminDisplayVersion +- DelayReleaseHoldApplied +- EnforcedTimestamps +- Description +- OriginatingServer +- IsValid +- ObjectState + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md new file mode 100644 index 0000000000..d15ff5ab3c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md @@ -0,0 +1,194 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOMailboxFolderPermission + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-ExOMailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EXOMailboxFolderPermission [[-Identity] ] + [-ExternalDirectoryObjectId ] + [-GroupMailbox] + [-PrimarySmtpAddress ] + [-User ] + [-UserPrincipalName ] + [] +``` + +## DESCRIPTION +Use this cmdlet to retrieve folder level permission in the mailbox. + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports +``` + +This example returns the current list of user permissions for the Reports subfolder in the Marketing folder in John's mailbox. + +### Example 2 +```powershell +Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -User Kim@contoso.com +``` + +This example returns the permissions for the same folder in John's mailbox, but only for the user Kim. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Email address +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GroupMailbox +The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -User +The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The UserPrincipalName parameter 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) + +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) + +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) + +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md new file mode 100644 index 0000000000..b6d21cf8d8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md @@ -0,0 +1,281 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOMailboxFolderStatistics + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXOMailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EXOMailboxFolderStatistics + [-Archive] + [-DiagnosticInfo ] + [-ExternalDirectoryObjectId ] + [-Folderscope ] + [-Identity ] + [-IncludeAnalysis] + [-IncludeOldestAndNewestItems] + [-IncludeSoftDeletedRecipients] + [-PrimarySmtpAddress ] + [-UserPrincipalName ] + [] +``` + +## DESCRIPTION +A mailbox can have hidden items that are never visible to the user and are only used by applications. The Get-EXOMailboxFolderStatistics cmdlet can return hidden items for the following values: FolderSize, FolderAndSubfolderSize, ItemsInFolder and ItemsInFolderAndSubfolders. + +Don't confuse Get-EXOMailboxFolderStatistics cmdlet (folders) with the Get-EXOMailboxStatistics cmdlet (mailboxes). + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOMailboxFolderStatistics -Identity admin@contoso.com +``` + +This example returns statistics for all mailbox folders. Default is FolderScope All. + +### Example 2 +```powershell +Get-EXOMailboxFolderStatistics -Identity admin@contoso.com -FolderScope Calendar -IncludeOldestAndNewestItems +``` + +This example returns statistics only for calendar folders. + +### Example 3 +```powershell +Get-EXOMailbox -ResultSize Unlimited | Get-EXOMailboxFolderStatistics -FolderScope Inbox | Format-Table Identity,ItemsInFolderAndSubfolders,FolderAndSubfolderSize -AutoSize +``` + +This example uses the FolderScope parameter to view Inbox folder statistics for all mailboxes. + +## PARAMETERS + +### -Archive +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Folderscope +The FolderScope parameter specifies the scope of the search by folder type. Valid values include: + +- All +- Archive +- Calendar +- Clutter +- Contacts +- ConversationHistory +- DeletedItems +- Drafts +- Inbox +- Journal +- JunkEmail +- LegacyArchiveJournals +- ManagedCustomFolder +- NonIpmRoot +- Notes +- Outbox +- Personal +- RecoverableItems +- RssSubscriptions +- SentItems +- SyncIssues +- Tasks + +```yaml +Type: ElcFolderType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the 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: + +- Name +- Alias +- Distinguished name (DN) +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IncludeAnalysis +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeOldestAndNewestItems +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedRecipients +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md new file mode 100644 index 0000000000..d008aa8f24 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md @@ -0,0 +1,238 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOMailboxPermission + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXOMailboxPermission cmdlet to retrieve permissions on a 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). + +## SYNTAX + +### Default (Default) +``` +Get-EXOMailboxPermission [-ResultSize ] + [] +``` + +### Identity +``` +Get-EXOMailboxPermission + [-ExternalDirectoryObjectId ] + [-Identity ] + [-Owner] + [-PrimarySmtpAddress ] + [-ResultSize ] + [-SoftDeletedMailbox] + [-User ] + [-UserPrincipalName ] + [] +``` + +## DESCRIPTION +The output of this cmdlet shows the following information: + +- Identity: The mailbox in question. +- User: The security principal (user, security group, Exchange management role group, etc.) that has permission to the mailbox. +- AccessRights: The permission that the security principal has on the mailbox. The available values are ChangeOwner (change the owner of the mailbox), ChangePermission (change the permissions on the mailbox), DeleteItem (delete the mailbox), ExternalAccount (indicates the account isn't in the same domain), FullAccess (open the mailbox, access its contents, but can't send mail) and ReadPermission (read the permissions on the mailbox). Whether the permissions are allowed or denied is indicated in the Deny column. +- IsInherited: Whether the permission is inherited (True) or directly assigned to the mailbox (False). Permissions are inherited from the mailbox database and/or Active Directory. Typically, directly assigned permissions override inherited permissions. +- Deny: Whether the permission is allowed (False) or denied (True). Typically, deny permissions override allow permissions. + +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. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOMailboxPermission -Identity john@contoso.com +``` + +This example return the permission the user has on mailboxes + +## PARAMETERS + +### -ExternalDirectoryObjectId +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. + +You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Owner +The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +**Note**: Currently, the value that you provide for this parameter is case sensitive. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md new file mode 100644 index 0000000000..cbe03cc816 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md @@ -0,0 +1,275 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOMailboxStatistics + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXOMailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EXOMailboxStatistics + [-Archive] + [-DatabaseGuid ] + [-ExchangeGuid ] + [-Identity ] + [-IncludeMoveHistory] + [-IncludeMoveReport] + [-IncludeSoftDeletedRecipients] + [-PrimarySmtpAddress ] + [-Properties ] + [-PropertySets ] + [-UserPrincipalName ] + [] +``` + +## DESCRIPTION +You can use the detailed move history and a move report output from this cmdlet to troubleshoot a move request. To view the move history, you must pass this cmdlet as an object. Move histories are retained in the mailbox database, are numbered incrementally, and the last run move request is always numbered 0. + +You can only see move reports and move history for completed move requests. + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOMailboxStatistics -Identity john@contoso.com +``` + +This example retrieves the mailbox statistics for the specified mailbox. Only the minimum set of properties are returned. + +### Example 2 +```powershell +Get-EXOMailboxStatistics -Identity john@contoso.com -Properties SystemMessageSize,SystemMessageSizeWarningQuota,SystemMessageCount +``` + +This example retrieves the minimum set of properties and the specified properties for the specified mailbox. + +## PARAMETERS + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseGuid +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 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExchangeGuid +The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properties filter set to ExchangeGuid. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Domain\\Username +- Email address +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IncludeMoveHistory +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMoveReport +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedRecipients +The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. + +Soft-deleted recipients are deleted recipients that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. + +For more information about the available properties, see [Get-EXOMailboxStatistics property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertySets +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) +- All + +You can specify multiple values separated by commas. + +For more information about the properties that are included in each property set, see [Get-EXOMailboxStatistics property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). + +```yaml +Type: PropertySet[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The UserPrincipalName parameter 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md new file mode 100644 index 0000000000..91b5ebab64 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md @@ -0,0 +1,291 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXOMobileDeviceStatistics + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXOMobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-EXOMobileDeviceStatistics [-Identity ] + [-ActiveSync] + [-ExternalDirectoryObjectId ] + [-GetMailboxLog] + [-NotificationEmailAddresses ] + [-OWAforDevices] + [-PrimarySmtpAddress ] + [-RestApi] + [-ShowRecoveryPassword] + [-UniversalOutlook] + [-UserPrincipalName ] + [] +``` + +### MobileDeviceIdentity +``` +Get-EXOMobileDeviceStatistics [-Mailbox ] + [-ActiveSync] + [-GetMailboxLog] + [-NotificationEmailAddresses ] + [-OWAforDevices] + [-RestApi] + [-ShowRecoveryPassword] + [-UniversalOutlook] + [] +``` + +## DESCRIPTION +This 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. + +## EXAMPLES + +### Example 1 +```powershell +Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com +``` + +This example returns the statistics of all devices linked to user with email john.doe@contoso.com + +### Example 2 +```powershell +Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com -ActiveSync +``` + +This example returns the statistics for active sync devices linked to user with email john.doe@contoso.com + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example: + +- GUID +- DeviceID + +You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Mailbox +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 +- User ID or user principal name (UPN) + +You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: MobileDeviceIdentity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ActiveSync +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GetMailboxLog +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailAddresses +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAforDevices +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestApi +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowRecoveryPassword +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniversalOutlook +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXORecipient.md b/exchange/exchange-ps/exchange/Get-EXORecipient.md new file mode 100644 index 0000000000..fd34b10f9d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXORecipient.md @@ -0,0 +1,410 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXORecipient + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXORecipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-EXORecipient [[-Identity] ] + [-ExternalDirectoryObjectId ] + [-Filter ] + [-IncludeSoftDeletedRecipients] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-Properties ] + [-PropertySets ] + [-RecipientPreviewFilter ] + [-RecipientType ] + [-RecipientTypeDetails ] + [-ResultSize ] + [-UserPrincipalName ] + [] +``` + +### Anr +``` +Get-EXORecipient [-Anr ] + [-Filter ] + [-IncludeSoftDeletedRecipients] + [-OrganizationalUnit ] + [-Properties ] + [-PropertySets ] + [-RecipientPreviewFilter ] + [-RecipientType ] + [-RecipientTypeDetails ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Get-EXORecipient cmdlet can be used 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-EXORecipient -ResultSize 100 +``` + +This example returns the first 100 recipient objects in name sorted order. + +### Example 2 +```powershell +Get-EXORecipient -Identity john@contosot.com +``` + +This example returns the recipient attribute details for the user john@contoso.com + +## PARAMETERS + +### -Identity +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) +- GUID + +Otherwise, you can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Domain\\Username +- Email address +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Anr +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedRecipients +The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. + +Soft-deleted recipients are deleted recipients that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. + +For more information about the available properties, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertySets +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) +- Archive +- Custom +- MailboxMove +- Policy + +For more information about the properties that are included in each property set, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). + +```yaml +Type: PropertySet[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientPreviewFilter +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientType +The RecipientType parameter filters the results by the specified recipient type. Valid values are: + +- DynamicDistributionGroup +- MailContact +- MailNonUniversalGroup +- MailUniversalDistributionGroup +- MailUniversalSecurityGroup +- MailUser +- PublicFolder +- UserMailbox + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: + +- DiscoveryMailbox +- DynamicDistributionGroup +- EquipmentMailbox +- GroupMailbox +- GuestMailUser +- LegacyMailbox +- LinkedMailbox +- LinkedRoomMailbox +- MailContact +- MailForestContact +- MailNonUniversalGroup +- MailUniversalDistributionGroup +- MailUniversalSecurityGroup +- MailUser +- PublicFolder +- PublicFolderMailbox +- RemoteEquipmentMailbox +- RemoteRoomMailbox +- RemoteSharedMailbox +- RemoteTeamMailbox +- RemoteUserMailbox +- RoomList +- RoomMailbox +- SchedulingMailbox +- SharedMailbox +- SharedWithMailUser +- TeamMailbox +- UserMailbox + +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. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md new file mode 100644 index 0000000000..3ec37b7a9d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md @@ -0,0 +1,224 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EXORecipientPermission + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-EXORecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default (Default) +``` +Get-EXORecipientPermission + [-AccessRights ] + [-ResultSize ] + [-Trustee ] + [] +``` + +### Identity +``` +Get-EXORecipientPermission [[-Identity] ] + [-AccessRights ] + [-ExternalDirectoryObjectId ] + [-PrimarySmtpAddress ] + [-ResultSize ] + [-Trustee ] + [-UserPrincipalName ] + [] +``` + +## 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. + +## EXAMPLES + +### Example 1 +```powershell +Get-EXORecipientPermission -ResultSize 100 +``` +Above example returns recipient permission for first 100 mailbox users in the name sorted order. + +## PARAMETERS + +### -Identity +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 +- Mail users +- Mail contacts +- Distribution groups +- Dynamic distribution groups + +For the best performance, we recommend using the following values to identify the recipient: + +- User ID or user principal name (UPN) +- GUID + +Otherwise, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Domain\\Username +- Email address +- LegacyExchangeDN +- SamAccountName + +You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AccessRights +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDirectoryObjectId +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. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Trustee +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 +- Mail users with a Microsoft account +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- User Principal name (UPN) + +You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrincipalName, or ExternalDirectoryObjectId parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md new file mode 100644 index 0000000000..1235c14ba1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md @@ -0,0 +1,187 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EcpVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-EcpVirtualDirectory cmdlet to view Exchange Control Panel (ECP) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The Exchange admin center (EAC) uses the ECP virtual directories. + +The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-EcpVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-EcpVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-EcpVirtualDirectory -Server Server01 +``` + +This example returns a summary list of all Exchange Control Panel virtual directories on the server named Server01. + +### Example 2 +```powershell +Get-EcpVirtualDirectory -Identity "Server01\ecp*" | Format-List +``` + +This example returns detailed information for the Exchange Control Panel virtual directory named "ecp (Default Web Site)" on the server named Server01. + +### Example 3 +```powershell +Get-EcpVirtualDirectory +``` + +This example returns a summary list of all Exchange Control Panel virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md b/exchange/exchange-ps/exchange/Get-EdgeSubscription.md new file mode 100644 index 0000000000..4e288d9293 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EdgeSubscription.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EdgeSubscription + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-EdgeSubscription cmdlet to retrieve information about Edge Subscriptions in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EdgeSubscription [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-EdgeSubscription | Format-List +``` + +This example retrieves detailed Edge Subscription information for all Edge Transport servers subscribed to your Exchange organization. + +### Example 2 +```powershell +Get-EdgeSubscription Edge1 -DomainController DC1.contoso.com +``` + +This example retrieves the Edge Subscription information for the Edge Transport server name Edge1 from the domain controller named DC1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the Edge Transport server for which you want to retrieve Edge Subscription information. The identity is expressed as the host name of the Edge Transport server. If no identity is specified, all Edge Subscriptions are returned. + +```yaml +Type: TransportServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md new file mode 100644 index 0000000000..fa33987f4c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md @@ -0,0 +1,107 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EdgeSyncServiceConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-EdgeSyncServiceConfig cmdlet to retrieve the edge synchronization services settings that control the general synchronization behavior shared by all Microsoft Exchange EdgeSync services. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EdgeSyncServiceConfig [[-Identity] ] + [-DomainController ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-EdgeSyncServiceConfig "Primary EdgeSync Settings" | Format-List +``` + +This example reads the configuration of the Microsoft Exchange EdgeSync service settings named Primary EdgeSync Settings from Active Directory and displays all its properties in a list format. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### -Site +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md new file mode 100644 index 0000000000..fe9c386e7f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md @@ -0,0 +1,142 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EligibleDistributionGroupForMigration + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Get-EligibleDistributionGroupForMigration cmdlet to identify distribution groups that can be upgraded to Microsoft 365 Groups. You can't upgrade mail-enabled security groups to Microsoft 365 Groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-EligibleDistributionGroupForMigration [[-Identity] ] + [-OrganizationalUnit ] + [-ResultSize ] + [] +``` + +### ManagedBy +``` +Get-EligibleDistributionGroupForMigration [-ManagedBy ] + [-OrganizationalUnit ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EligibleDistributionGroupForMigration -ResultSize unlimited +``` + +This example returns a summary list of all distribution groups that can be upgraded to Microsoft 365 Groups. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: DistributionGroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ManagedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: GeneralRecipientIdParameter +Parameter Sets: ManagedBy +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md new file mode 100644 index 0000000000..1cb8b5a7a3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md @@ -0,0 +1,126 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-EmailAddressPolicy cmdlet to view email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EmailAddressPolicy [[-Identity] ] + [-DomainController ] + [-IncludeMailboxSettingOnlyPolicy] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-EmailAddressPolicy +``` + +This example returns a summary list of all email address policies in the organization. + +### Example 2 +```powershell +Get-EmailAddressPolicy -Identity "Contoso Employees" +``` + +This example returns detailed information for the email address policy named Contoso Employees. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the email address policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMailboxSettingOnlyPolicy +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. + +Microsoft Exchange Server 2010 supports policies that contain only address policy settings and policies that contain address policy settings and mailbox management configuration. Exchange 2010 doesn't support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. + +The attributes of address policies that contain only mailbox management configuration can't be modified in Exchange 2010. These policies can only be removed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md b/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md new file mode 100644 index 0000000000..025fdca73a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md @@ -0,0 +1,66 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-emailtenantsettings +applicable: Exchange Online +title: Get-EmailTenantSettings +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EmailTenantSettings + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-EmailTenantSettings cmdlet to view whether priority account protection is enabled or disabled in your Microsoft Defender for Office 365 organization. For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EmailTenantSettings [[-Identity] ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EmailTenantSettings | Format-List Identity,EnablePriorityAccountProtection +``` + +This example shows whether priority account protection is enabled or disabled in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the settings object that you want to view. The only settings object in the organization is named Default. + +```yaml +Type: EmailTenantSettingsIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EtrLimits.md b/exchange/exchange-ps/exchange/Get-EtrLimits.md new file mode 100644 index 0000000000..759a8d045c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EtrLimits.md @@ -0,0 +1,50 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-etrlimits +applicable: Exchange Online, Exchange Online Protection +title: Get-EtrLimits +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EtrLimits + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-EtrLimits cmdlet to show information about [mail flow rule (also known as transport rule) limits in Exchange Online](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#journal-transport-and-inbox-rule-limits), as well the current usage and the largest rule IDs in terms of size and regular expression character count. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EtrLimits [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EtrLimits +``` + +This example returns information about the number and size of mail flow rules in the organization, and the organizational limits for mail flow rules. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EventLogLevel.md b/exchange/exchange-ps/exchange/Get-EventLogLevel.md new file mode 100644 index 0000000000..cc925f4f3d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EventLogLevel.md @@ -0,0 +1,125 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EventLogLevel + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-EventLogLevel cmdlet to display a list of Exchange event categories and the corresponding log levels on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-EventLogLevel -Server + [-DomainController ] + [] +``` + +### Identity +``` +Get-EventLogLevel [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-EventLogLevel -Server "Exchange01" +``` + +This example displays the event categories and log levels for the server Exchange01. + +## PARAMETERS + +### -Identity +The Identity parameter filters the results by the name of the event category. To see the available event categories, run the following command: Get-EventLogLevel. + +You can't use this parameter with the Server parameter. + +```yaml +Type: ECIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use this parameter with the Identity parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md new file mode 100644 index 0000000000..30df67b8a5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md @@ -0,0 +1,69 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-EventsFromEmailConfiguration + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-EventsFromEmailConfiguration cmdlet to view the events from email settings on a mailbox. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-EventsFromEmailConfiguration -Identity peter@contoso.com +``` + +This example retrieves all events from email settings for peter@contoso.com's mailbox. + +## PARAMETERS + +### -Identity +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 +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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md new file mode 100644 index 0000000000..d2853de47a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExchangeAssistanceConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ExchangeAssistanceConfig cmdlet to view the configuration information for the URLs that Microsoft Exchange Help uses to connect to the source of the documentation. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExchangeAssistanceConfig [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExchangeAssistanceConfig -Identity Contoso.com +``` + +This example shows the configuration information that the web management interface uses to locate the source of the documentation for Contoso.com. + +### Example 2 +```powershell +Get-ExchangeAssistanceConfig | Format-Table +``` + +This example shows the configuration information for all organizations and formats the information into a table. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/encryption-and-certificates/Get-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md similarity index 83% rename from exchange/exchange-ps/exchange/encryption-and-certificates/Get-ExchangeCertificate.md rename to exchange/exchange-ps/exchange/Get-ExchangeCertificate.md index a6c2e1d310..eec9e123ff 100644 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-ExchangeCertificate @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeCertificate cmdlet to view Exchange certificates that are installed on Exchange servers. This cmdlet returns Exchange self-signed certificates, certificates that were issued by a certification authority and pending certificate requests (also known as certificate signing requests or CSRs). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,106 +50,74 @@ 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'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). - 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: - -- AccessRules: The host names or FQDNs in the certificate's Subject Alternative Name field. +If you append ` | Format-List` to the command, the cmdlet returns these additional certificate properties: +- AccessRules: Typically, this value is multiple instances of the value System.Security.AccessControl.CryptoKeyAccessRule separated by commas. - CertificateDomains: The host names or FQDNs in the certificate's Subject Alternative Name field. - - HasPrivateKey: Whether or not the certificate contains a private key. - - IsSelfSigned: Whether or not the certificate is self-signed (not issued by a certification authority). - - Issuer: Who issued the certificate. - - NotAfter: The certificate expiration date. - - NotBefore: The certificate issue date. - - PublicKeySize: The size of the public key in bytes. - - RootCAType: The type of CA that signed the certificate. Values are None (this value is found on the Microsoft Exchange Server Auth Certificate, and also new self-signed certificates that you create), ThirdParty, Enterprise, Registry (this value is found on Exchange self-signed certificates), GroupPolicy, or Unknown (this value is found on pending certificate requests). - - SerialNumber: The unique serial number of the certificate. - - Status: The status of the certificate. Values are DateInvalid, Invalid, PendingRequest, RevocationCheckFailure, Revoked, Unknown, Untrusted or Valid -If you append | Format-List \* to the command, the cmdlet returns these additional certificate properties: +If you append ` | Format-List *` to the command, the cmdlet returns these additional certificate properties: - Archived - - CertificateRequest: This property contains the hash value of the certificate request. - - DnsNameList - - EnhancedKeyUsageList: Typically, this value is Server Authentication (1.3.6.1.5.5.7.3.1). - - Extensions - - FriendlyName - - Handle - -- Identity: This value is \\\\ - +- Identity: This value uses the syntax ServerFQDN\\Thumbprint. - IISServices - - IssuerName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName. - - KeyIdentifier - - PrivateKey: Typically, this value is System.Security.Cryptography.RSACryptoServiceProvider. - - PrivateKeyExportable: If this value is True, you can export the certificate from the server. - - PublicKey: Typically, this value is System.Security.Cryptography.RSACryptoServiceProvider. - - RawData - - SendAsTrustedIssuer - - ServicesStringForm - - SignatureAlgorithm: Typically, this value is System.Security.Cryptography.Oid. - - SubjectKeyIdentifier - -- SubjectName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName . - +- 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-ExchangeCertificate -Server Mailbox01 ``` This example returns a summary list of all Exchange certificates and pending certificate requests on the server named Mailbox01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ExchangeCertificate -Thumbprint 0271A7F1CA9AD8A27152CCAE044F968F068B14B8 | Format-List ``` This example returns detailed information for the specified certificate. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-ExchangeCertificate -Thumbprint 0271A7F1CA9AD8A27152CCAE044F968F068B14B8 | Format-List * ``` This example returns all available information for the specified certificate. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-ExchangeCertificate -DomainName mail.contoso.com ``` @@ -154,56 +125,76 @@ This example shows which certificate Exchange will select for the domain name ma ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Thumbprint +The Thumbprint parameter specifies the thumbprint value of the certificate that you want to view. -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +The 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. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: String +Parameter Sets: Thumbprint Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -DomainName -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. +### -Identity +The Identity parameter specifies the certificate that you want to view. Valid values are: + +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` + +You can't use this parameter with the Server parameter. + +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. ```yaml -Type: MultiValuedProperty -Parameter Sets: (All) +Type: ExchangeCertificateIdParameter +Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the certificate that you want to view. Valid values are: +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -- \\\\ +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. -- \ +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -You can't use this parameter with the Server parameter. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -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. +### -DomainName +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: ExchangeCertificateIdParameter -Parameter Sets: Identity +Type: MultiValuedProperty +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -217,6 +208,7 @@ Type: X509Certificate2 Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -228,11 +220,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -244,6 +233,7 @@ Type: ServerIdParameter Parameter Sets: Instance, Thumbprint Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -251,38 +241,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Thumbprint -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. - -```yaml -Type: String -Parameter Sets: Thumbprint -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e368589a-6510-4209-9f10-171d1990cd7d.aspx) diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md new file mode 100644 index 0000000000..ca36c14478 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md @@ -0,0 +1,159 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExchangeDiagnosticInfo + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ExchangeDiagnosticInfo cmdlet to return information about processes that are running on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExchangeDiagnosticInfo [-Argument ] + [-Component ] + [-Process ] + [-Server ] + [-Unlimited] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ExchangeDiagnosticInfo +``` + +This example returns a summary list of all Exchange processes that are running on the server. + +### Example 2 +```powershell +[xml]$edi = Get-ExchangeDiagnosticInfo + +$edi.Diagnostics.Processlocator.Process | Format-Table -Auto Name,ID,Guid +``` + +This example display the XML output of the command in format that's easier to read. + +## PARAMETERS + +### -Argument +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. + +To see the Argument values that are available for a given Component value, run the command `Get-ExchangeDiagnosticInfo -Process ProcessName -Component ComponentName -Argument Help`. + +```yaml +Type: String +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 +``` + +### -Component +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`. + +```yaml +Type: String +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 +``` + +### -Process +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Unlimited +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ExchangeFeature.md b/exchange/exchange-ps/exchange/Get-ExchangeFeature.md new file mode 100644 index 0000000000..6bf6bb29bf --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExchangeFeature.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangefeature +applicable: Exchange Server 2019 +title: Get-ExchangeFeature +schema: 2.0.0 +author: lusassl-msft +ms.author: lusassl +ms.reviewer: srvar +--- + +# Get-ExchangeFeature + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ExchangeFeature cmdlet to return information about features that are flighted on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExchangeFeature [-Identity ] + [-FeatureID ] + [-RingLevel ] + [-Status ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExchangeFeature -Status "Enabled" +``` + +This example returns all enabled features. + +### Example 2 +```powershell +Get-ExchangeFeature -FeatureID "PING.1.0" +``` + +This example returns information about the feature with the feature id PING.1.0. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command returns information for all Exchange servers. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FeatureID +The FeatureID parameter specifies the feature you want to query information about. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RingLevel +The RingLevel parameter specifies the ring level you want to query information about. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status parameter specifies the status you want to query information about. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Get-ExchangeServer.md b/exchange/exchange-ps/exchange/Get-ExchangeServer.md similarity index 79% rename from exchange/exchange-ps/exchange/organization/Get-ExchangeServer.md rename to exchange/exchange-ps/exchange/Get-ExchangeServer.md index de490f2c26..4331ccbb63 100644 --- a/exchange/exchange-ps/exchange/organization/Get-ExchangeServer.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-ExchangeServer @@ -15,7 +18,7 @@ Use the Get-ExchangeServer cmdlet to view the properties of Exchange servers. When you run the Get-ExchangeServer cmdlet with no parameters, it returns the attributes of all the servers in the Exchange organization. To return specific server properties (including domain controller information) where the Get-ExchangeServer cmdlet has to contact servers directly or perform a complex or slow calculation, make sure you use the Status parameter. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,32 +26,34 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-ExchangeServer -Domain [-DomainController ] - [-Status] [] + [-Status] + [] ``` ### Identity ``` Get-ExchangeServer [[-Identity] ] [-DomainController ] - [-Status] [] + [-Status] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-ExchangeServer | Format-List ``` This example returns a summary list of all the Exchange servers in the organization. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ExchangeServer -Identity Mailbox01 | Format-List ``` @@ -56,6 +61,29 @@ This example returns detailed information about the Exchange server named Mailbo ## PARAMETERS +### -Identity +The Identity parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the Exchange server. For example: + +- Name +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use this parameter with the Domain parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Domain The Domain parameter filters the results by the fully qualified domain name (FQDN) of the domain (for example, contoso.com). @@ -66,6 +94,7 @@ Type: Fqdn Parameter Sets: Domain Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -83,6 +112,7 @@ 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 @@ -90,31 +120,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the Exchange server. For example: - -- Name - -- GUID - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use this parameter with the Domain parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Status The Status switch specifies whether to include additional property values in the results, for example, the Watson state, StaticDomainControllers, and runtime domain controller usage. You don't need to specify a value with this switch. @@ -125,6 +130,7 @@ 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 @@ -133,20 +139,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/96543903-10fa-46fe-9ea0-90570ca0ad2e.aspx) diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md new file mode 100644 index 0000000000..4d95f68bfd --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md @@ -0,0 +1,63 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExchangeServerAccessLicense + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ExchangeServerAccessLicense cmdlet to return a list of licenses in use in your Exchange organization. This refers to the specific legal name of the license, as defined in the Microsoft Product List and is representative of your licenses when you run this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExchangeServerAccessLicense [] +``` + +## DESCRIPTION +The Get-ExchangeServerAccessLicense cmdlet returns a collection of these license names: + +- Exchange Server Standard CAL +- Exchange Server Enterprise CAL +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExchangeServerAccessLicense +``` + +This example retrieves a list of Exchange licenses in your organization. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md new file mode 100644 index 0000000000..4c62c163e4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md @@ -0,0 +1,82 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExchangeServerAccessLicenseUser + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ExchangeServerAccessLicenseUser cmdlet to return a list of unique users for the specified license name. Each object contains the FQDN or primary SMTP address of the mailbox and the license that's associated with it. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExchangeServerAccessLicenseUser -LicenseName "Exchange Server 2016 Standard Edition" +``` + +This example returns the unique users for the license named Exchange Server 2016 Standard Edition. + +## PARAMETERS + +### -LicenseName +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` +- `Exchange Server Enterprise CAL` +- `Exchange Server Standard Edition` +- `Exchange Server Enterprise Edition` + +The `` value is 2013, 2016, or 2019. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Get-ExchangeSettings.md b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md similarity index 78% rename from exchange/exchange-ps/exchange/organization/Get-ExchangeSettings.md rename to exchange/exchange-ps/exchange/Get-ExchangeSettings.md index 1fb568aad1..9088353301 100644 --- a/exchange/exchange-ps/exchange/organization/Get-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-ExchangeSettings @@ -13,32 +16,42 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeSettings cmdlet to view customized Exchange setting objects that are stored in Active Directory. Use the New-ExchangeSettings to create the settings object, and the Set-ExchangeSettings cmdlet to define the actual settings. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ExchangeSettings [[-Identity] ] [-ConfigName ] - [-Database ] [-Diagnostic] [-DiagnosticArgument ] [-DomainController ] - [-Force] [-GenericScopeName ] [-GenericScopes ] [-GenericScopeValue ] - [-Organization ] [-Process ] [-Server ] [-User ] +Get-ExchangeSettings [[-Identity] ] + [-ConfigName ] + [-Database ] + [-Diagnostic] + [-DiagnosticArgument ] + [-DomainController ] + [-Force] + [-GenericScopeName ] + [-GenericScopes ] + [-GenericScopeValue ] + [-Organization ] + [-Process ] + [-Server ] + [-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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-ExchangeSettings ``` This example returns a summary list of all Exchange setting objects. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ExchangeSettings -Identity Audit | Format-List ``` @@ -46,6 +59,26 @@ This example returns a summary list of all Exchange setting objects. ## PARAMETERS +### -Identity +The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ExchangeSettingsIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -ConfigName The ConfigName parameter filter the results by the specified property name. The value you specify is visible in the EffectiveSetting property. @@ -56,6 +89,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -67,11 +101,8 @@ Accept wildcard characters: False The Database parameter filters the results by mailbox database. You can use any value that uniquely identifies the database. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID ```yaml @@ -79,6 +110,7 @@ Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -87,15 +119,18 @@ Accept wildcard characters: False ``` ### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. The detailed information is visible in the DiagnosticInfo property. +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -111,6 +146,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -126,6 +162,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -134,13 +171,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -156,6 +196,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,13 +205,14 @@ Accept wildcard characters: False ``` ### -GenericScopes -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 "\=\","\=\"... +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 Default value: None @@ -186,6 +228,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -193,27 +236,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example: - -- Name - -- Distingushed name (DN) - -- GUID - -```yaml -Type: ExchangeSettingsIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Organization This parameter is reserved for internal Microsoft use. @@ -222,6 +244,7 @@ Type: OrganizationIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -237,6 +260,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -248,11 +272,8 @@ Accept wildcard characters: False The Server parameter filters the results by Exchange server. You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID ```yaml @@ -260,6 +281,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -268,13 +290,14 @@ Accept wildcard characters: False ``` ### -User -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. +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 Default value: None @@ -283,20 +306,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/40557a97-7cc0-45b7-8b49-7fee2a1d7dc3.aspx) diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md new file mode 100644 index 0000000000..08f6210738 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy +applicable: Exchange Online +title: Get-ExoInformationBarrierPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoInformationBarrierPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoInformationBarrierPolicy cmdlet to view information barrier policies in your Exchange Online organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoInformationBarrierPolicy [[-Identity] ] [-ShowFriendlyValues] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoInformationBarrierPolicy -ShowFriendlyValues| Format-List Name,FriendlyRecipientFilter,InformationBarrierSegmentName +``` + +This example shows a summary list of all Exchange Online information barrier policies in the organization. + +### Example 2 +```powershell +Get-ExoInformationBarrierPolicy -Identity bf542929-a8c4-4167-88fb-3e5ef68a1dca -ShowFriendlyValues +``` + +This example shows detailed information for the specified Exchange Online information barrier policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange Online information barrier policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Display name +- Distinguished name (DN) +- GUID + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShowFriendlyValues +The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. + +When you use this switch, the following property values are shown: + +- FriendlyRecipientFilter +- InformationBarrierSegmentName + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md new file mode 100644 index 0000000000..8e1ddb9d25 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship +applicable: Exchange Online +title: Get-ExoInformationBarrierRelationship +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoInformationBarrierRelationship + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoInformationBarrierRelationship cmdlet to view information barrier relationships in your Exchange Online organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoInformationBarrierRelationship -RecipientId1 -RecipientId2 + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoInformationBarrierRelationship -RecipientId1 "Akia Al-Zuhairi" -RecipientId2 "Gabriela Laureano" +``` + +This example shows the Exchange Online information barrier relationship between the two specified recipients. + +## PARAMETERS + +### -RecipientId1 +The RecipientId1 parameter specifies the first recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientId2 +The RecipientId2 parameter specifies the second recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md new file mode 100644 index 0000000000..b0caf1efcb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment +applicable: Exchange Online +title: Get-ExoInformationBarrierSegment +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoInformationBarrierSegment + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoInformationBarrierSegment to view information barrier segments in your Exchange Online organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoInformationBarrierSegment [[-Identity] ] [-ShowFriendlyValues] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoInformationBarrierSegment -ShowFriendlyValues| Format-List DisplayName,Name,FriendlyRecipientFilter,AssociatedPolicy +``` + +This example shows a summary list of all Exchange Online information barrier segments in the organization. + +### Example 2 +```powershell +Get-ExoInformationBarrierSegment -Identity "Investment Banking" -ShowFriendlyValues +``` + +This example shows detailed information for the specified Exchange Online information barrier segment. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange Online information barrier segment that you want to view. You can use any value that uniquely identifies the segment. For example: + +- Name +- Display name +- Distinguished name (DN) +- GUID + +```yaml +Type: InformationBarrierSegmentIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShowFriendlyValues +The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. + +When you use this switch, the FriendlyMembershipFilter property value is shown. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..0baced66e2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exophishsimoverriderule +applicable: Exchange Online +title: Get-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoPhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoPhishSimOverrideRule [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Policy ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoPhishSimOverrideRule +``` + +This example returns detailed information about the phishing simulation override (there should be only one). + +### Example 2 +```powershell +Get-ExoPhishSimOverrideRule | Format-Table Name,Mode +``` + +This example identifies the valid rule (one) and any invalid rules. + +Although the previous command should return only one rule, a rule that's pending deletion might also be included in the results. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +The name of the rule uses the following syntax: `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the results by phishing simulator override policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..4f8ca933c6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule +applicable: Exchange Online +title: Get-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoSecOpsOverrideRule cmdlet to view SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoSecOpsOverrideRule [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Policy ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoSecOpsOverrideRule +``` + +This example returns detailed information about the SecOps mailbox override rule (there should be only one). + +### Example 2 +```powershell +Get-ExoSecOpsOverrideRule | Format-Table Name,Mode +``` + +This example identifies the valid rule (one) and any invalid rules. + +Although the previous command should return only one rule, a rule that's pending deletion might also be included in the results. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the SecOps override rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the results by SecOps mailbox override policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md b/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md new file mode 100644 index 0000000000..451de0b213 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md @@ -0,0 +1,71 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExternalInOutlook + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExternalInOutlook cmdlet to view the configuration of external sender identification that's available in Outlook, Outlook for Mac, Outlook on the web, and Outlook for iOS and Android. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExternalInOutlook [[-Identity] ] [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExternalInOutlook +``` + +This example returns the settings of the external sender identification feature for the organization. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md similarity index 80% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md rename to exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md index 0decf5ad68..14df25198f 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md +++ b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md @@ -1,19 +1,22 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-FailedContentIndexDocuments ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is functional only in Exchange Server 2016 or earlier. Use the Get-FailedContentIndexDocuments cmdlet to retrieve a list of documents for a mailbox, mailbox database, or Mailbox server that couldn't be indexed by Exchange Search. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,10 +28,11 @@ Get-FailedContentIndexDocuments [-Identity] [-DomainController ] [-EndDate ] [-ErrorCode ] - [-FailureMode ] + [-FailureMode ] [-ResultSize ] [-StartDate ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Database @@ -38,10 +42,11 @@ Get-FailedContentIndexDocuments -MailboxDatabase [-DomainController ] [-EndDate ] [-ErrorCode ] - [-FailureMode ] + [-FailureMode ] [-ResultSize ] [-StartDate ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Server @@ -51,10 +56,11 @@ Get-FailedContentIndexDocuments -Server [-DomainController ] [-EndDate ] [-ErrorCode ] - [-FailureMode ] + [-FailureMode ] [-ResultSize ] [-StartDate ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -64,48 +70,46 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-FailedContentIndexDocuments -Identity "Terry Adams" ``` This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox of user Terry Adams. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-FailedContentIndexDocuments -MailboxDatabase "Mailbox Database MDB2" ``` -This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox database Mailbox Database MDB2. +This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox database named Mailbox Database MDB2. ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox. You can use one of the following values: - -- GUID +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: +- Name +- Alias - Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - +- Canonical DN +- Domain\\Username +- Email address +- GUID - LegacyExchangeDN - -- SmtpAddress - -- Alias +- SamAccountName +- User ID or user principal name (UPN) ```yaml 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 Default value: None @@ -114,19 +118,18 @@ Accept wildcard characters: False ``` ### -MailboxDatabase -The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use the following values: - -- GUID of the database - -- Database name +The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use any value that uniquely identifies the database. For example: -- DN +- Name +- Distinguished name (DN) +- GUID ```yaml Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -138,16 +141,15 @@ Accept wildcard characters: False The Server parameter specifies a Mailbox server. You can use the following values: - Name - - GUID - - DN ```yaml Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -158,8 +160,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -167,6 +168,7 @@ 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 Default value: None @@ -181,7 +183,8 @@ 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -190,13 +193,16 @@ Accept wildcard characters: False ``` ### -Archive -The Archive switch restricts the scope of the cmdlet to the user's archive. When using the Archive switch, you must also specify the Identity parameter. +The Archive switch restricts the scope of the cmdlet to the user's archive. You don't need to specify a value with this switch. + +When using the Archive switch, you must also specify the Identity parameter. ```yaml Type: SwitchParameter Parameter Sets: Mailbox Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -207,13 +213,14 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -229,6 +236,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -240,16 +248,15 @@ Accept wildcard characters: False 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. - - Permanent: Returns items that couldn't be indexed due to a permanent error. Exchange Search does not attempt to index these items again. - - All: Returns items that couldn't be indexed regardless of nature of failure. ```yaml -Type: Transient | Permanent | All +Type: FailureMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -265,6 +272,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -275,13 +283,14 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -297,6 +306,7 @@ 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 Default value: None @@ -305,20 +315,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d128ec5f-f805-4bc0-982b-b9adceb8eca8.aspx) diff --git a/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md new file mode 100644 index 0000000000..87063ff596 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-featureconfiguration +applicable: Security & Compliance +title: Get-FeatureConfiguration +schema: 2.0.0 +--- + +# Get-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the Get-FeatureConfiguration cmdlet to view Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FeatureConfiguration [[-Identity] ] [-FeatureScenario] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FeatureConfiguration -FeatureScenario KnowYourData | Format-Table Name,Mode +``` + +This example returns a summary list of all collection policies in the organization. + +### Example 2 +```powershell +Get-FeatureConfiguration -FeatureScenario KnowYourData -Identity "Engineering Group" +``` + +This example returns detailed information about the specified collection policy. + +## PARAMETERS + +### -Identity +The Identity policy specifies the feature configuration that you want to view. You can use any value that uniquely identifies the configuration. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FeatureScenario +The FeatureScenario parameter specifies the scenario for the feature configuration. Currently, the only valid values are: +- `KnowYourData` for collection policies +- `TrustContainer` for Endpoint DLP trust container + +```yaml +Type: PolicyScenario +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md b/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md new file mode 100644 index 0000000000..498c943b79 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md @@ -0,0 +1,116 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-FederatedDomainProof + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-FederatedDomainProof cmdlet to generate a cryptographically secure string for the domain used for federated sharing in your Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FederatedDomainProof -DomainName + [-DomainController ] + [-Thumbprint ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-FederatedDomainProof -DomainName "contoso.com" +``` + +This example generates a cryptographically secure string for the domain contoso.com. + +### Example 2 +```powershell +Get-FederatedDomainProof -DomainName "contoso.com" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 +``` + +This example uses a specific certificate for the domain contoso.com. + +## PARAMETERS + +### -DomainName +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### -Thumbprint +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md new file mode 100644 index 0000000000..141f7f644a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md @@ -0,0 +1,120 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-FederatedOrganizationIdentifier cmdlet to retrieve the Exchange organization's federated organization identifier and related details, such as federated domains, organization contact and status. + +For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FederatedOrganizationIdentifier [[-Identity] ] + [-DomainController ] + [-IncludeExtendedDomainInfo] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-FederatedOrganizationIdentifier +``` + +This example retrieves the Exchange organization's federated organization identifier. + +### Example 2 +```powershell +Get-FederatedOrganizationIdentifier -IncludeExtendedDomainInfo +``` + +This example retrieves the Exchange organization's federated organization identifier. The IncludeExtendedDomainInfo switch is used to return the status of federated domains from the Microsoft Federation Gateway. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeExtendedDomainInfo +The IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. You don't need to specify a value with this switch. + +The status is returned with each domain in the Domains property. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FederationInformation.md b/exchange/exchange-ps/exchange/Get-FederationInformation.md new file mode 100644 index 0000000000..53be62c5c2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FederationInformation.md @@ -0,0 +1,132 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-FederationInformation cmdlet to get federation information, including federated domain names and target URLs, from an external Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FederationInformation -DomainName + [-BypassAdditionalDomainValidation] + [-Force] + [-TrustedHostnames ] + [] +``` + +## 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-FederationInformation -DomainName contoso.com +``` + +This example gets federation information from the domain contoso.com. + +## PARAMETERS + +### -DomainName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassAdditionalDomainValidation +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. + +```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 +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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedHostnames +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FederationTrust.md b/exchange/exchange-ps/exchange/Get-FederationTrust.md new file mode 100644 index 0000000000..98175c1a29 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FederationTrust.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-FederationTrust cmdlet to view the federation trust configured for the Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FederationTrust [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-FederationTrust | Format-List +``` + +This example retrieves properties of the federation trust configured for the Exchange organization. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md new file mode 100644 index 0000000000..023b70021a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md @@ -0,0 +1,74 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-FilePlanPropertyAuthority + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-FilePlanPropertyAuthority cmdlet to view file plan property authorities. + +For 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-FilePlanPropertyAuthority [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertyAuthority | Format-Table Name,Workload,Policy +``` + +This example returns a summary list of all file plan property authorities. + +### Example 2 +```powershell +Get-FilePlanPropertyAuthority -Identity "Contoso Authority" +``` + +This example returns detailed information about the custom file plan property authority named Contoso Authority. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md new file mode 100644 index 0000000000..c7b0bab4ef --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md @@ -0,0 +1,74 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertycategory +applicable: Security & Compliance +title: Get-FilePlanPropertyCategory +schema: 2.0.0 +--- + +# Get-FilePlanPropertyCategory + +## 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 Fet-FilePlanPropertyCategory cmdlet to view file plan property categories. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FilePlanPropertyCategory [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertyCategory | Format-Table Name,Workload,Policy +``` + +This example returns a summary list of all file plan property authorities. + +### Example 2 +```powershell +Get-FilePlanPropertyCategory -Identity "Contoso Category" +``` + +This example returns detailed information about the custom file plan property category named Contoso Category. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md new file mode 100644 index 0000000000..9080e6137a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md @@ -0,0 +1,74 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-FilePlanPropertyCitation + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-FilePlanPropertyCitation cmdlet to view file plan property citations. + +For 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-FilePlanPropertyCitation [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertyCitation | Format-Table Name,Workload,Policy +``` + +This example returns a summary list of all file plan property authorities. + +### Example 2 +```powershell +Get-FilePlanPropertyCitation -Identity "Contoso Citation" +``` + +This example returns detailed information about the custom file plan property citation named Contoso Citation. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md new file mode 100644 index 0000000000..58fc2c7f5e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md @@ -0,0 +1,74 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-FilePlanPropertyDepartment + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-FilePlanPropertyDepartment cmdlet to view file plan property departments. + +For 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-FilePlanPropertyDepartment [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertyDepartment | Format-Table Name,Workload,Policy +``` + +This example returns a summary list of all file plan property departments. + +### Example 2 +```powershell +Get-FilePlanPropertyDepartment -Identity "Contoso HR" +``` + +This example returns detailed information about the custom file plan property department named Contoso HR. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md new file mode 100644 index 0000000000..c1ec2f310a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md @@ -0,0 +1,74 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-FilePlanPropertyReferenceId + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-FilePlanPropertyReferenceId cmdlet to view file plan property reference IDs. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FilePlanPropertyReferenceId [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertyReferenceId | Format-Table Name,Workload,Policy +``` + +This example returns a summary list of all file plan property reference IDs. + +### Example 2 +```powershell +Get-FilePlanPropertyReferenceId -Identity "Contoso-0001" +``` + +This example returns detailed information about the custom file plan property reference ID named Contoso-0001. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FilePlanPropertyStructure.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md new file mode 100644 index 0000000000..f2e64f89a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md @@ -0,0 +1,63 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-FilePlanPropertyStructure + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-FilePlanPropertyStructure cmdlet to the view file plan property structure in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FilePlanPropertyStructure [-IncludeAdditionalInfo] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertyStructure -IncludeAdditionalInfo +``` + +This example returns the file plan property structure. + +## PARAMETERS + +### -IncludeAdditionalInfo +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md new file mode 100644 index 0000000000..ed2bc3113e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md @@ -0,0 +1,74 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-FilePlanPropertySubCategory + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-FilePlanPropertySubCategory cmdlet to view file plan property subcategories. + +For 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-FilePlanPropertySubCategory [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FilePlanPropertySubCategory | Format-Table Name,Workload,ParentCategory,Policy +``` + +This example returns a summary list of all file plan property subcategories. + +### Example 2 +```powershell +Get-FilePlanPropertySubCategory -Identity "US Tax" +``` + +This example returns detailed information about the custom file plan property subcategory named US Tax. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-FocusedInbox.md b/exchange/exchange-ps/exchange/Get-FocusedInbox.md new file mode 100644 index 0000000000..c7b5967c67 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FocusedInbox.md @@ -0,0 +1,97 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-FocusedInbox + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-FocusedInbox cmdlet to view the Focused Inbox configuration for mailboxes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FocusedInbox -Identity + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-FocusedInbox -Identity julia@contoso.com +``` + +This example returns the Focused Inbox configuration for the mailbox of julia@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ForeignConnector.md b/exchange/exchange-ps/exchange/Get-ForeignConnector.md new file mode 100644 index 0000000000..1d19d0d26f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ForeignConnector.md @@ -0,0 +1,103 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ForeignConnector + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ForeignConnector cmdlet to view the configuration information for a Foreign connector in the Transport service of a Mailbox server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ForeignConnector [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ForeignConnector +``` + +This example lists all Foreign connectors in your organization. + +### Example 2 +```powershell +Get-ForeignConnector "Fax Connector" | Format-List +``` + +This example displays detailed configuration information for the Foreign connector named Fax Connector. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Foreign connector that you want to examine. The Identity parameter can take any of the following values for the Foreign connector object: + +- GUID +- Connector name +- ServerName\\ConnectorName + +```yaml +Type: ForeignConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md b/exchange/exchange-ps/exchange/Get-FrontendTransportService.md new file mode 100644 index 0000000000..e768cd1838 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FrontendTransportService.md @@ -0,0 +1,106 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-FrontendTransportService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-FrontEndTransportService cmdlet to view the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FrontendTransportService [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-FrontEndTransportService +``` + +This example returns a list of all Exchange servers that have the Client Access server role installed. + +### Example 2 +```powershell +Get-FrontEndTransportService MBX01 | Format-List +``` + +This example retrieves the detailed configuration information for the Front End Transport service on the server named MBX01. + +## PARAMETERS + +### -Identity +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: + +- Name (for example, Exchange01) +- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) +- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) + +```yaml +Type: FrontendTransportServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md b/exchange/exchange-ps/exchange/Get-GlobalAddressList.md new file mode 100644 index 0000000000..0a3a6daa60 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-GlobalAddressList.md @@ -0,0 +1,131 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-GlobalAddressList cmdlet to view a global address list (GAL) or a set of GALs. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DefaultOnly +``` +Get-GlobalAddressList [-DefaultOnly] + [-DomainController ] + [] +``` + +### Identity +``` +Get-GlobalAddressList [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-GlobalAddressList +``` + +This example returns a summary list of all GALs. + +### Example 2 +```powershell +Get-GlobalAddressList -Identity GAL_AgencyB | Format-List +``` + +This example returns detailed information about the GAL named GAL\_AgencyB. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the global address list that you want to view. You can use any value that uniquely identifies the GAL. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: GlobalAddressListIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DefaultOnly +The DefaultOnly switch filters the results so only the default GAL is returned. You don't need to use a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md new file mode 100644 index 0000000000..24e4681b00 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md @@ -0,0 +1,82 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-GlobalMonitoringOverride + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-GlobalMonitoringOverride cmdlet to view the overrides of the thresholds and parameters of the managed availability probes, monitors and responders that are configured for all Exchange 2013 or later servers in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-GlobalMonitoringOverride +``` + +This example returns a summary list of all global monitoring overrides that are configured in your organization. + +### Example 2 +```powershell +Get-GlobalMonitoringOverride | Format-List +``` + +This example returns detailed information for the global monitoring overrides that are configured in your organization: + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-Group.md b/exchange/exchange-ps/exchange/Get-Group.md new file mode 100644 index 0000000000..b940181519 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Group.md @@ -0,0 +1,337 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-Group cmdlet to view existing group objects in your organization. In all environments, this cmdlet returns mail-enabled security groups, distribution groups, role groups, and room lists. For details about other supported group types in on-premises Exchange environments, see the RecipientTypeDetails parameter description. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-Group [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [] +``` + +### Identity +``` +Get-Group [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Group +``` + +This example returns a summary list of all groups in your organization. + +### Example 2 +```powershell +Get-Group -Identity "Marketing Reports" | Format-List +``` + +This example returns detailed information for the group named Marketing Reports. + +### Example 3 +```powershell +Get-Group -Anr Mar* +``` + +This example uses the Anr parameter to return all groups that begin with "Mar". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: GroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified group subtype. Valid values are: + +- MailNonUniversalGroup +- MailUniversalDistributionGroup +- MailUniversalSecurityGroup +- NonUniversalGroup (on-premises Exchange Server only) +- RoomList +- UniversalDistributionGroup (on-premises Exchange Server only) +- UniversalSecurityGroup (on-premises Exchange Server only) + +You can specify multiple values separated by commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HealthReport.md b/exchange/exchange-ps/exchange/Get-HealthReport.md new file mode 100644 index 0000000000..fb4ff840c9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HealthReport.md @@ -0,0 +1,172 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-HealthReport + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-HealthReport cmdlet to return health information for the Exchange server that you specify. You can use the health values to determine the state of the server. The cmdlet also returns an alert value that provides the specific state of your server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HealthReport [-Identity] + [-GroupSize ] + [-HaImpactingOnly] + [-HealthSet ] + [-MinimumOnlinePercent ] + [-RollupGroup] + [] +``` + +## DESCRIPTION +The following list contains the health values that are returned: + +- Online +- Partially Online +- Offline +- Sidelined +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-HealthReport -Identity Mailbox01-RollupGroup +``` + +This example retrieves health information for the server named Mailbox01. + +## PARAMETERS + +### -Identity +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -GroupSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HaImpactingOnly +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthSet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumOnlinePercent +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RollupGroup +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md b/exchange/exchange-ps/exchange/Get-HistoricalSearch.md new file mode 100644 index 0000000000..9aa5b5f171 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HistoricalSearch.md @@ -0,0 +1,82 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HistoricalSearch + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-HistoricalSearch cmdlet to view information about historical searches that have been performed within the last ten days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-HistoricalSearch +``` + +The example returns a summary list of all historical searches that have been performed in the last ten days. + +### Example 2 +```powershell +Get-HistoricalSearch -JobId f9c66f83-b5c8-4a0c-91f4-a38376f74182 | Format-List +``` + +This example returns detailed information about the historical search that's in progress that has the identity value f9c66f83-b5c8-4a0c-91f4-a38376f74182. + +## PARAMETERS + +### -JobId +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md new file mode 100644 index 0000000000..ec353acb7a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HoldCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-HoldCompliancePolicy to view existing preservation policies in the Microsoft Purview compliance portal. + +**Note**: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HoldCompliancePolicy [[-Identity] ] + [-DistributionDetail] + [] +``` + +## DESCRIPTION +This list describes the properties displayed by default. + +- Name: The unique name of the policy. +- Workload: Where the policy is applied. For example, SharePoint or Exchange. +- Enabled: The value True means the policy is enabled. +- Mode: The current operating mode of the policy. The possible values are Test (the content is tested, but no rules are enforced), AuditAndNotify (when content matches the conditions specified by the policy, the rule is not enforced, but notification emails are sent) or Enforce (all aspects of the policy are enabled and enforced). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-HoldCompliancePolicy +``` + +This example displays summary information for all preservation policies in your organization. + +### Example 2 +```powershell +Get-HoldCompliancePolicy -Identity "Regulation 123 Compliance" | Format-List +``` + +This example displays detailed information for the policy named "Regulation 123 Compliance". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the preservation policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md new file mode 100644 index 0000000000..898c6c476a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HoldComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-HoldComplianceRule to view preservation rules in the Microsoft Purview compliance portal. + +**Note**: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HoldComplianceRule [[-Identity] ] + [-Policy ] + [] +``` + +## DESCRIPTION +This list describes the properties that are displayed by default in the summary information. + +- Name: The unique name of the rule. +- Disabled: The enabled or disabled status of the rule. +- Mode: The current operating mode of the rule (for example, Enforce). +- Comment: An administrative comment. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-HoldComplianceRule +``` + +This example displays summary information for all preservation rules in your organization. + +### Example 2 +```powershell +Get-HoldComplianceRule -Identity "30DayRule" | Format-List +``` + +This example displays detailed information for the preservation rule named "30 Day Rule". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the preservation rule you want to view. You can use any value that uniquely identifies the rule. 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 +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +You can use this parameter with the Identity parameter in the same command. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md new file mode 100644 index 0000000000..95c62d1b40 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md @@ -0,0 +1,86 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HostedConnectionFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-HostedConnectionFilterPolicy cmdlet to view the settings of connection filter policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HostedConnectionFilterPolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-HostedConnectionFilterPolicy | Format-List Name,IPBlockList,IPAllowList,EnableSafeList +``` + +This example returns a summary list of all connection filter policies in your organization. + +### Example 2 +```powershell +Get-HostedConnectionFilterPolicy -Identity Default +``` + +This example returns detailed information about the connection filter policy named Default. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +Typically, you only have one connection filter policy: the default policy named Default. + +```yaml +Type: HostedConnectionFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md new file mode 100644 index 0000000000..855377d33a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md @@ -0,0 +1,93 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HostedContentFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-HostedContentFilterPolicy cmdlet to view the settings of spam filter policies (content filter policies) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-HostedContentFilterPolicy +``` + +This example shows a summary list of all the spam filter policies in your cloud-based organization. + +### Example 2 +```powershell +Get-HostedContentFilterPolicy Default | Format-List +``` + +This example retrieves details about the spam filter policy named Default. + +### Example 3 +```powershell +$x = Get-HostedContentFilterPolicy + +$x | foreach {write-host ("`r`n"*3)$_.Name,`r`n,("="*79),`r`n,"Allowed Senders"`r`n,("-"*79),`r`n,$_.AllowedSenders,("`r`n"*2),"Allowed Sender Domains",`r`n,("-"*79),`r`n,$_.AllowedSenderDomains,("`r`n"*2),"Blocked Senders"`r`n,("-"*79),`r`n,$_.BlockedSenders,("`r`n"*2),"Blocked Sender Domains",`r`n,("-"*79),`r`n,$_.BlockedSenderDomains} +``` + +This example shows the allowed and blocked senders and domains in all spam filter policies. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md new file mode 100644 index 0000000000..0531374eab --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md @@ -0,0 +1,121 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-HostedContentFilterRule + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Get-HostedContentFilterRule cmdlet to view spam filter rules (content filter rules) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HostedContentFilterRule [[-Identity] ] + [-DomainController ] + [-State ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-HostedContentFilterRule +``` + +This example shows a summary list of all the spam filter rules in your cloud-based organization. + +### Example 2 +```powershell +Get-HostedContentFilterRule "Contoso Recipients" | Format-List +``` + +This example retrieves details about the spam filter rule named Contoso Recipients. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +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: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Enabled: The command returns only enabled rules. +- Disabled: The command returns only disabled rules. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md new file mode 100644 index 0000000000..1e40b52a4d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md @@ -0,0 +1,84 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HostedOutboundSpamFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-HostedOutboundSpamFilterPolicy cmdlet to view outbound spam filter policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HostedOutboundSpamFilterPolicy [-Identity] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-HostedOutboundSpamFilterPolicy | Format-Table Name,Enabled,IsDefault,Action* +``` + +This example returns a summary list of all outbound spam filter policies. + +### Example 2 +```powershell +Get-HostedOutboundSpamFilterPolicy -Identity "Contoso Executives" +``` + +This example returns detailed information about the outbound spam filter policy named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: HostedOutboundSpamFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md new file mode 100644 index 0000000000..0a620cec54 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md @@ -0,0 +1,98 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HostedOutboundSpamFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-HostedOutboundSpamFilterRule cmdlet to view outbound spam filter rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HostedOutboundSpamFilterRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-HostedOutboundSpamFilterRule | Format-Table Name,Priority,State,HostedOutboundSpamFilterPolicy +``` + +This example returns a summary list of all outbound spam filter rules. + +### Example 2 +```powershell +Get-HostedOutboundSpamFilterRule -Identity "Contoso Executives" +``` + +This example returns detailed information for the outbound spam filter rule named "Contoso Executives" + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by enabled or disabled rules. Valid values are: + +- Enabled: Only enabled rules are returned. +- Disabled: Only disabled rules are returned. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md b/exchange/exchange-ps/exchange/Get-HybridConfiguration.md new file mode 100644 index 0000000000..426766c54c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HybridConfiguration.md @@ -0,0 +1,73 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-HybridConfiguration + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-HybridConfiguration cmdlet to view the hybrid configuration for the Microsoft Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-HybridConfiguration +``` + +This example returns detailed information about the hybrid deployment configuration. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md b/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md new file mode 100644 index 0000000000..4f793be1a3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md @@ -0,0 +1,56 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-HybridMailflowDatacenterIPs + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +This cmdlet has been deprecated and is no longer used. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-HybridMailflowDatacenterIPs [] +``` + +## DESCRIPTION +This cmdlet has been deprecated and is no longer used. + +## EXAMPLES + +### Example 1 +```powershell +Get-HybridMailflowDatacenterIPs +``` + +This cmdlet has been deprecated and is no longer used. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md b/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md new file mode 100644 index 0000000000..0da96065e8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md @@ -0,0 +1,77 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPAllowListConfig + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-IPAllowListConfig cmdlet to view the configuration information for the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPAllowListConfig [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, the Connection Filtering agent acts on the IP address of the incoming SMTP connection to determine what action, if any, to take on an incoming message. + +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPAllowListConfig | Format-List +``` + +This example returns detailed information about the IP Allow list configuration on the local Edge Transport server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/Get-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md similarity index 78% rename from exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListEntry.md rename to exchange/exchange-ps/exchange/Get-IPAllowListEntry.md index b57ad38402..7221b9e90b 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-IPAllowListEntry @@ -13,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPAllowListEntry cmdlet to view the IP address entries in the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,14 +24,16 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-IPAllowListEntry -IPAddress [-ResultSize ] - [-Server ] [] + [-Server ] + [] ``` ### Identity ``` Get-IPAllowListEntry [[-Identity] ] [-ResultSize ] - [-Server ] [] + [-Server ] + [] ``` ## DESCRIPTION @@ -36,15 +41,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-IPAllowListEntry ``` This example returns all entries in the IP Allow list on the local Edge Transport server. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-IPAllowListEntry -IPAddress 192.168.0.1 ``` @@ -52,33 +57,35 @@ This example returns an IP Allow list entry in which the specified IP address is ## PARAMETERS -### -IPAddress -The IPAddress parameter specifies an IP address to view in the IP Allow list entry or entries. For example, if you have an IP Allow list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Allow list IP address range to return the IP Allow list entry. +### -Identity +The Identity parameter specifies the identity integer value of the IP Allow list entry that you want to view. When you add an entry to the IP Allow list, the Identity value is automatically assigned. ```yaml -Type: IPAddress -Parameter Sets: IPAddress +Type: IPListEntryIdentity +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named + +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity integer value of the IP Allow list entry that you want to view. When you add an entry to the IP Allow list, the Identity value is automatically assigned. +### -IPAddress +The IPAddress parameter specifies an IP address to view in the IP Allow list entry or entries. For example, if you have an IP Allow list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Allow list IP address range to return the IP Allow list entry. ```yaml -Type: IPListEntryIdentity -Parameter Sets: Identity +Type: IPAddress +Parameter Sets: IPAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 + +Required: True +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,6 +97,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -101,11 +109,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -117,6 +122,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -125,20 +131,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8787482a-bf36-4700-bf8a-5b1530545da4.aspx) diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md new file mode 100644 index 0000000000..1d17905936 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md @@ -0,0 +1,103 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPAllowListProvider + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-IPAllowListProvider cmdlet to view IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPAllowListProvider [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPAllowListProvider +``` + +This example returns a summary list of all IP Allow list providers. + +### Example 2 +```powershell +Get-IPAllowListProvider Contoso.com | Format-List +``` + +This example returns detailed information for the IP Allow list provider named Contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the IP Allow list provider that you want to view. You can use any value that uniquely identifies the IP Allow list provider. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: IPAllowListProviderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md new file mode 100644 index 0000000000..b56f559df4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md @@ -0,0 +1,77 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPAllowListProvidersConfig + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-IPAllowListProvidersConfig cmdlet to view the settings that affect all IP Allow list providers that are configured on an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPAllowListProvidersConfig [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, IP Allow list providers are used by the Connection Filtering agent. The Connection Filtering agent acts on the IP address of the incoming SMTP connection to determine what action, if any, to take on an incoming message. + +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPAllowListProvidersConfig | Format-List +``` + +This example returns detailed information about the IP Allow list providers configuration on the local Edge Transport server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md b/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md new file mode 100644 index 0000000000..517988a7ae --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md @@ -0,0 +1,77 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPBlockListConfig + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-IPBlockListConfig cmdlet to view the IP Block list configuration information that's used by the Connection Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPBlockListConfig [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, the Connection Filtering agent acts on the incoming SMTP connection to determine what action, if any, to take on an incoming message. + +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPBlockListConfig | Format-List +``` + +This example returns detailed information about the IP Block list configuration on the local Edge Transport server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/Get-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md similarity index 78% rename from exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListEntry.md rename to exchange/exchange-ps/exchange/Get-IPBlockListEntry.md index 18e5b8b1ad..d6a1d41ce8 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-IPBlockListEntry @@ -13,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPBlockListEntry cmdlet to view the IP Block list entries that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,14 +24,16 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-IPBlockListEntry [[-Identity] ] [-ResultSize ] - [-Server ] [] + [-Server ] + [] ``` ### IPAddress ``` Get-IPBlockListEntry -IPAddress [-ResultSize ] - [-Server ] [] + [-Server ] + [] ``` ## DESCRIPTION @@ -36,15 +41,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-IPBlockListEntry ``` This example returns a list of all IP address entries in the IP Block list. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-IPBlockListEntry | where {$_.IsMachineGenerated} ``` @@ -60,6 +65,7 @@ Type: IPListEntryIdentity Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -75,6 +81,7 @@ Type: IPAddress Parameter Sets: IPAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -90,6 +97,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -101,11 +109,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -117,6 +122,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -125,20 +131,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/efdf2bc1-5571-417e-810a-b690bf5c8044.aspx) diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md new file mode 100644 index 0000000000..f8849f592d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md @@ -0,0 +1,103 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPBlockListProvider + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-IPBlockListProvider cmdlet to view IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPBlockListProvider [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPBlockListProvider +``` + +This example returns a summary list of all IP Block list providers configured on the local Edge Transport server. + +### Example 2 +```powershell +Get-IPBlockListProvider -Identity Contoso.com +``` + +This example returns detailed information for the existing IP Block list provider named Contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the IP Block list provider that you want to view. You can use any value that uniquely identifies the IP Block list provider. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: IPBlockListProviderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md new file mode 100644 index 0000000000..f7bcc606fa --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md @@ -0,0 +1,77 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPBlockListProvidersConfig + +## SYNOPSIS +This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. + +Use the Get-IPBlockListProvidersConfig cmdlet to view the settings that affect all IP Block list providers that are configured on an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPBlockListProvidersConfig [-DomainController ] + [] +``` + +## DESCRIPTION +On Edge Transport servers, IP Block list providers are used by the Connection Filtering agent. The Connection Filtering agent acts on the IP address of the incoming SMTP connection to determine what action, if any, to take on an incoming message. + +On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPBlockListProvidersConfig | Format-List +``` + +This example returns detailed information about the IP Block list providers on the local Edge Transport server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md b/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md new file mode 100644 index 0000000000..e8d7109c9a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md @@ -0,0 +1,117 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipv6statusforaccepteddomain +applicable: Exchange Online +title: Get-IPv6StatusForAcceptedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPv6StatusForAcceptedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-IPv6StatusForAcceptedDomain cmdlet to view the status of support for mail delivery to accepted domains in Exchange Online using IPv6. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPv6StatusForAcceptedDomain [[-Domain] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Online organization to use with this cmdlet + +If IPv6 is enabled for an accepted domain in Exchange Online, IPv4 and IPv6 addresses are returned in DNS queries for mail flow records of the domain. If IPv6 is disabled, only IPv4 addresses are returned in DNS queries for mail flow records of the domain. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +> [!NOTE] +> +> - When you use the Enable-IPv6ForAcceptedDomain or Disable-IPv6ForAcceptedDomain cmdlets to update the IPv6 setting for an accepted domain, the updated status can take up to an hour to be visible using Get-IPv6StatusForAcceptedDomain due to caching. +> +> For example, Get-IPv6StatusForAcceptedDomain shows the status value Enabled for a domain. You run Disable-IPv6ForAcceptedDomain to disable IPv6 for the domain, you immediately run Get-IPv6StatusForAcceptedDomain to check the status of the domain, and the command erroneously returns the value Enabled. It might take up to an hour before Get-IPv6StatusForAcceptedDomain shows the correct value Disabled for the domain. +> +> - If you receive the following error when running Get-Ipv6StatusForAcceptedDomain: +> +> WARNING: DNS record has unexpected value... +> +> Explicitly enable or disable IPv6 using the Enable-Ipv6ForAcceptedDomain or Disable-Ipv6ForAcceptedDomain cmdlets. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPv6StatusForAcceptedDomain -Domain contoso.com +``` + +This example returns the status of IPv6 support for mail sent to contoso.com. + +## PARAMETERS + +### -Domain +The Domain parameter specifies the accepted domain that you want to view IPv6 status for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md b/exchange/exchange-ps/exchange/Get-IRMConfiguration.md new file mode 100644 index 0000000000..377c44454f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IRMConfiguration.md @@ -0,0 +1,77 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-IRMConfiguration cmdlet to view the Information Rights Management (IRM) configuration in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-IRMConfiguration +``` + +This example retrieves the IRM configuration in your organization. + +## PARAMETERS + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ImapSettings.md b/exchange/exchange-ps/exchange/Get-ImapSettings.md new file mode 100644 index 0000000000..78a0faa6d4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ImapSettings.md @@ -0,0 +1,97 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ImapSettings + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ImapSettings cmdlet to view the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This is the client access (frontend) IMAP4 service that clients connect to. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ImapSettings [-DomainController ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-IMAPSettings -Server MBX01 +``` + +This example displays the settings and values of the Microsoft Exchange IMAP4 service that's running on the server named MBX01. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-InboundConnector.md b/exchange/exchange-ps/exchange/Get-InboundConnector.md new file mode 100644 index 0000000000..2447b733ef --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-InboundConnector.md @@ -0,0 +1,99 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-InboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-InboundConnector cmdlet to view the settings for an Inbound connector in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-InboundConnector [[-Identity] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Inbound connectors accept email messages from remote domains that require specific configuration options. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-InboundConnector "Inbound Connector for Contoso.com" | Format-List +``` + +This example displays detailed configuration information for the Inbound connector named Inbound Connector for Contoso.com. + +### Example 2 +```powershell +Get-InboundConnector +``` + +This example lists all the Inbound connectors configured in your cloud-based organization. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/exchange/Get-InboxRule.md new file mode 100644 index 0000000000..5ed6b13784 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-InboxRule.md @@ -0,0 +1,288 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-InboxRule cmdlet to view Inbox rule properties. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-InboxRule [[-Identity] ] + [-BypassScopeCheck] + [-DescriptionTimeFormat ] + [-DescriptionTimeZone ] + [-DomainController ] + [-IncludeHidden] + [-Mailbox ] + [-ResultSize ] + [-SkipCount ] + [-SweepRules] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +**Note**: This cmdlet doesn't work for members of View-Only Organization Management role group in Exchange Online or the Global Reader role in Microsoft Entra ID. + +## EXAMPLES + +### Example 1 +```powershell +Get-InboxRule -Mailbox Joe@Contoso.com +``` + +This example retrieves all Inbox rules for the mailbox Joe@Contoso.com. + +### Example 2 +```powershell +Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "MM/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time" +``` + +This example retrieves the Inbox rule ReceivedLastYear from the mailbox joe@contoso.com on which the ReceivedBeforeDate parameter was set when the rule was created. The DescriptionTimeFormat and DescriptionTimeZone parameters are used in this example to specify formatting of the time and the time zone used in the rule's Description property. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- RuleIdentity property (for example, 16752869479666417665). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). + +```yaml +Type: InboxRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassScopeCheck +The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DescriptionTimeFormat +The DescriptionTimeFormat parameter specifies the format for time values in the rule description. For example: + +MM/dd/yyyy, where MM is the 2-digit month, dd is the 2-digit day and yyyy is the 4-digit year. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DescriptionTimeZone +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"). + +To see the available values, run the following command: `$TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display`. + +If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHidden +The IncludeHidden switch specifies whether to include hidden Inbox rules in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SweepRules +This parameter is available only in on-premises Exchange. + +The SweepRules switch specifies whether to return only Sweep rules in the results. You don't need to specify a value with this switch. + +Sweep rules run at regular intervals to help keep your Inbox clean. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md new file mode 100644 index 0000000000..4ba383b667 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-InformationBarrierPoliciesApplicationStatus + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-InformationBarrierPoliciesApplicationStatus cmdlet to view the application status of information barrier policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default (Default) +``` +Get-InformationBarrierPoliciesApplicationStatus [-All] + [] +``` + +### Identity +``` +Get-InformationBarrierPoliciesApplicationStatus [[-Identity] ] + [-All] + [] +``` + +## DESCRIPTION + For more information, see [View status of information barrier policy application](https://learn.microsoft.com/purview/information-barriers-policies#view-status-of-user-accounts-segments-policies-or-policy-application). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-InformationBarrierPoliciesApplicationStatus +``` + +This example returns the most recent application of information barrier policies by the Start-InformationBarrierPoliciesApplication cmdlet. + +### Example 2 +```powershell +Get-InformationBarrierPoliciesApplicationStatus -All +``` + +This example returns all applications of information barrier policies by the Start-InformationBarrierPoliciesApplication cmdlet. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -All +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md new file mode 100644 index 0000000000..32c2276297 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-InformationBarrierPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-InformationBarrierPolicy cmdlet to view information barrier policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### InformationBarrierDefault (Default) +``` +Get-InformationBarrierPolicy [-ExoPolicyId ] + [] +``` + +### Identity +``` +Get-InformationBarrierPolicy [[-Identity] ] + [-ExoPolicyId ] + [] +``` + +## DESCRIPTION +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-InformationBarrierPolicy | Format-Table Name,State,AssignedSegment,Segments* -Auto +``` + +This example displays a summary list of all information barrier policies. + +### Example 2 +```powershell +Get-InformationBarrierPolicy -Identity HR-Sales +``` + +This example displays detailed information for the information barrier policy named HR-Sales. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +You can't use this parameter with the ExOPolicyId parameter. + +```yaml +Type: PolicyIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ExoPolicyId +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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md b/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md new file mode 100644 index 0000000000..862519808e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md @@ -0,0 +1,123 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-InformationBarrierRecipientStatus + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-InformationBarrierRecipientStatus cmdlet to return information about recipients and their relationship to information barrier policies. + +**Note**: This cmdlet doesn't work with information barriers in non-legacy mode. To determine your current mode, see [Check the IB mode for your organization](https://learn.microsoft.com/purview/information-barriers-multi-segment#check-the-ib-mode-for-your-organization). If you're in non-legacy mode, run the following command to get information about a single recipient: `Get-Recipient -Identity | Format-List Name,*segment*`. Similarly, to get the relationship information between two recipients, use the **Get-ExoInformationBarrierRelationship** cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-InformationBarrierRecipientStatus [-Identity] [[-Identity2] ] + [] +``` + +## DESCRIPTION +The following information is returned in the output of this cmdlet: + +- A warning message that indicates whether or not the recipient is included in an information barrier policy. +- If present, the GUID part in the ExOPolicyId property value identifies the information barrier policy that the recipient is included in. You can run the command `Get-InformationBarrierPolicy -ExOPolicyId ` to identify and view the details of the policy. +- Basic information about the recipient (display name, alias, and last name). +- Recipient properties that can be used in organization segments (Department, CustomAttributeN, etc.) and the current property values for the recipient. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-InformationBarrierRecipientStatus -Identity meganb +``` + +This example returns the information barrier policy information for the user meganb. + +### Example 2 +```powershell +Get-InformationBarrierRecipientStatus -Identity meganb -Identity2 alexw +``` + +This example returns the information barrier policy relationship for the users meganb and alexw. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Identity2 +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +When you include this parameter in a command, you get output for each recipient. + +You can only use this parameter with the Identity parameter; you can't use it by itself. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md b/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md new file mode 100644 index 0000000000..3178fd949a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md @@ -0,0 +1,79 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-IntraOrganizationConfiguration cmdlet to view the component settings of a hybrid Exchange deployment. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IntraOrganizationConfiguration [[-OrganizationGuid] ] + [] +``` + +## DESCRIPTION +A hybrid Exchange deployment results in one logical organization made up of a number of physical Exchange instances. Hybrid Exchange environments contain more than one Exchange instance and support topologies like two on-premises Microsoft Exchange forests in an organization, an Exchange on-premises organization and an Exchange Online organization or two Exchange Online organizations. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-IntraOrganizationConfiguration +``` + +This example returns the settings of the intra-organization configuration. + +## PARAMETERS + +### -OrganizationGuid +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. + +```yaml +Type: OnPremisesOrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md new file mode 100644 index 0000000000..d07a069726 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md @@ -0,0 +1,105 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-IntraOrganizationConnector cmdlet to view the settings of Intra-Organization connectors. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IntraOrganizationConnector [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +Intra-Organizational connectors enable features and services between divisions in your Exchange organization. It allows for the expansion of organizational boundaries for features and services across different hosts and network boundaries, such as between Active Directory forests, between on-premises and cloud-based organizations, or between tenants hosted in the same or different datacenters. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-IntraOrganizationConnector +``` + +This example returns a summary list of all Intra-Organization connectors. + +### Example 2 +```powershell +Get-IntraOrganizationConnector "MainCloudConnector" | Format-List +``` + +This example returns details about the Intra-Organization connector named "MainCloudConnector". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: IntraOrganizationConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-JournalRule.md b/exchange/exchange-ps/exchange/Get-JournalRule.md new file mode 100644 index 0000000000..68b259f8f9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-JournalRule.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-JournalRule cmdlet to view the journal rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-JournalRule [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-JournalRule +``` + +This example retrieves all journal rules configured in your organization. + +### Example 2 +```powershell +Get-JournalRule "Brokerage Communications" | Format-List +``` + +This example retrieves the specific journal rule Brokerage Communications and pipes the output to the Format-List cmdlet to view all the parameters of the rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule you want to view. Enter either the name or the GUID of the journal rule. You can omit the parameter label. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/exchange/Get-Label.md new file mode 100644 index 0000000000..b2cf3b4226 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Label.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-Label + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-Label cmdlet to view sensitivity labels in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-Label [[-Identity] ] + [-IncludeDetailedLabelActions] + [-SkipValidations] + [-ValidateContentTypeRemoval] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-Label +``` + +This example returns a summary list of all sensitivity labels in the organization. + +### Example 2 +```powershell +Get-Label -Identity "Engineering Group" | Format-List +``` + +This example returns detailed information for the sensitivity label named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -IncludeDetailedLabelActions +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipValidations +{{ Fill SkipValidations Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateContentTypeRemoval +{{ Fill ValidateContentTypeRemoval Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-LabelPolicy.md b/exchange/exchange-ps/exchange/Get-LabelPolicy.md new file mode 100644 index 0000000000..7a90fbaa71 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-LabelPolicy.md @@ -0,0 +1,95 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-LabelPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-LabelPolicy cmdlet to view sensitivity label policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-LabelPolicy [[-Identity] ] + [-ForceValidate ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-LabelPolicy | Format-Table Name +``` + +This example returns a summary list of all policies in the organization. + +### Example 2 +```powershell +Get-LabelPolicy -Identity "Engineering Group" | Format-List +``` + +This example returns detailed information for the policy named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-LinkedUser.md b/exchange/exchange-ps/exchange/Get-LinkedUser.md new file mode 100644 index 0000000000..7407a5f12b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-LinkedUser.md @@ -0,0 +1,206 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-LinkedUser + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-LinkedUser cmdlet to view existing linked user accounts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-LinkedUser [-Anr ] + [-Filter ] + [-OrganizationalUnit ] + [-ResultSize ] + [-SortBy ] + [] +``` + +### Identity +``` +Get-LinkedUser [[-Identity] ] + [-Filter ] + [-OrganizationalUnit ] + [-ResultSize ] + [-SortBy ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-LinkedUser +``` + +This example lists all linked users in the organization. + +### Example 2 +```powershell +Get-RemoteMailbox -Identity laura@contoso.com | Format-List +``` + +This example returns a detailed information for the linked for the user laura@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +Type: String +Parameter Sets: AnrSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- City +- FirstName +- LastName +- Office + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-LogonStatistics.md b/exchange/exchange-ps/exchange/Get-LogonStatistics.md new file mode 100644 index 0000000000..bfdee00794 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-LogonStatistics.md @@ -0,0 +1,168 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-LogonStatistics + +## SYNOPSIS +This cmdlet is functional only in Exchange Server 2010. + +The Get-LogonStatistics cmdlet has been deprecated and is no longer used. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Database +``` +Get-LogonStatistics -Database + [-DomainController ] + [] +``` + +### Identity +``` +Get-LogonStatistics [-Identity] + [-DomainController ] + [] +``` + +### Server +``` +Get-LogonStatistics -Server + [-DomainController ] + [] +``` + +## 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. + +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. + +## EXAMPLES + +### Example 1 +```powershell +Get-LogonStatistics -Server Server01 +``` + +This example returns logon statistics for all users connected to the server Server01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox to get logon statistics from. You can use one of the following values to identify the mailbox: + +- GUID +- Distinguished name (DN) +- Domain\\Account +- User principal name (UPN) +- Legacy Exchange DN +- SmtpAddress +- Alias + +This parameter accepts pipeline input from the Get-Mailbox command. + +You can't use this parameter with the Database or Server parameters. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Database +The Database parameter specifies the mailbox database to get logon statistics from (all mailboxes in the specified database). You can use any value that uniquely identifies the mailbox database. For example: + +- Name +- Distinguished name (DN) +- GUID + +This parameter accepts pipeline input from the Get-MailboxDatabase command. + +You can't use this parameter with the Identity or Server parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Mailbox server to get logon statistics from (all mailboxes on all databases, including recovery databases, on the specified server). You can use one of the following values to identify the server: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +This parameter accepts pipeline input from the Get-ExchangeServer and Get-MailboxServer commands. + +You can't use this parameter with the Database or Identity parameters. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..c7992e4955 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-M365DataAtRestEncryptionPolicy cmdlet to view existing Microsoft 365 data-at-rest encryption policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-M365DataAtRestEncryptionPolicy [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +M365 data-at-rest encryption policy cmdlets are accessible to compliance administrator role as part of the Exchange Online infrastructure. For more information, see [Service encryption with Microsoft Purview Customer Key](https://learn.microsoft.com/purview/customer-key-overview). + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-M365DataAtRestEncryptionPolicy +``` + +This example returns a summary list of all Microsoft 365 data-at-rest encryption policies. + +### Example 2 +```powershell +Get-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" | Format-List +``` + +This example returns detailed information about the policy named Contoso Corporate. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md new file mode 100644 index 0000000000..486e093215 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md @@ -0,0 +1,57 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-M365DataAtRestEncryptionPolicyAssignment + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-M365DataAtRestEncryptionPolicyAssignment cmdlet to view the currently assigned Microsoft 365 data-at-rest encryption policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-M365DataAtRestEncryptionPolicyAssignment +``` + +This example returns a summary list of all Microsoft 365 data-at-rest encryption policy assignments. + +### Example 2 +```powershell +Get-M365DataAtRestEncryptionPolicyAssignment | Format-List +``` + +This example returns detailed information for all Microsoft 365 data-at-rest encryption policy assignments. + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-MailContact.md b/exchange/exchange-ps/exchange/Get-MailContact.md new file mode 100644 index 0000000000..aa00b27a06 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailContact.md @@ -0,0 +1,326 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailContact cmdlet to view existing mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-MailContact [-ANR ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [] +``` + +### Identity +``` +Get-MailContact [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailContact +``` + +This example returns a summary list of all mail contacts. + +### Example 2 +```powershell +Get-MailContact -Identity Arlene | Format-List +``` + +This example retrieves detailed information for the mail contact named Arlene. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mail contact that you want to view. You can use any value that uniquely identifies the mail contact. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailContactIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ANR +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified mail contact subtype. Valid values are: + +- MailContact +- MailForestContact + +You can specify multiple values separated by commas. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md new file mode 100644 index 0000000000..910389aec2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md @@ -0,0 +1,368 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailDetailATPReport + +## 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. + +For 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-MailDetailATPReport + [-DataSource ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-MalwareName ] + [-MessageId ] + [-MessageTraceId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-RecipientAddress ] + [-SenderAddress ] + [-StartDate ] + [] +``` + +## DESCRIPTION +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. + +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. + +For the reporting period you specify, the cmdlet returns the following information: + +- Date +- Message ID +- Message Trace ID +- Domain +- Subject +- Message Size +- Direction: Values are Inbound, Outbound, IntraOrg Or Unknown. Unknown means the messages weren't processed by the filtering stack. In other words, the messages were dropped at the edge before they made it into our filtering stack, so we can't tell the direction for them. +- Sender Address +- Recipient Address +- Event Type +- Bulk complaint level +- Verdict Type +- Action +- File Name +- Malware Name + +This cmdlet is limited to 10,000 results. If you reach this limit, you can use the available parameters to filter the output. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +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.) + +## PARAMETERS + +### -DataSource +{{ Fill DataSource Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound +- IntraOrg + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- Advanced filter +- Anti-malware Engine +- Campaign +- File detonation +- File detonation reputation +- File reputation +- Fingerprint matching +- General filter +- Impersonation brand +- Impersonation domain +- Impersonation user +- Mailbox intelligence impersonation +- Message passed +- Mixed analysis detection +- Spoof DMARC +- Spoof external domain +- Spoof intra-org +- URL detonation +- URL detonation reputation +- URL malicious reputation + +**Note**: Some values correspond to features that are available only in Defender for Office 365 (plan 1 and plan 2 or plan 2 only). + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareName +The MalwareName parameter filters the results by malware payload. Valid values are: + +- Excel +- EXE +- Flash +- Others +- PDF +- PowerPoint +- URL + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md new file mode 100644 index 0000000000..213354eae3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md @@ -0,0 +1,342 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailDetailDlpPolicyReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailDetailDlpPolicyReport cmdlet to view the details of messages that matched the conditions defined by any data loss prevention (DLP) policies. This cmdlet works on messages that were sent within the last seven days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailDetailDlpPolicyReport [-Action ] + [-Direction ] + [-DlpPolicy ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-MessageId ] + [-MessageTraceId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-RecipientAddress ] + [-SenderAddress ] + [-StartDate ] + [-TransportRule ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MailDetailDlpPolicyReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com +``` + +This example retrieves the details of messages sent by john@contoso.com that matched the conditions defined by a DLP policy between June 13, 2015 and June 15, 2015. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- DLPActionHits +- DLPPolicyFalsePositive +- DLPPolicyHits +- DLPPolicyOverride +- DLPRuleHits + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify DLP event types for DLP reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRule +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md new file mode 100644 index 0000000000..62ff5f0f00 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailencryptionreport +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: Get-MailDetailEncryptionReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailDetailEncryptionReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailDetailEncryptionReport cmdlet to view the details of encryption in your cloud-based organization for the last 10 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailDetailEncryptionReport [[-Organization] ] + [-AggregateBy ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-MessageId ] + [-MessageTraceId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following default information: + +- DateTime +- Message ID +- Message Trace ID + +If you append the command with ` | Format-List`, the following additional information is returned: + +- Domain +- Direction +- Recipient Address +- Sender IP +- Sender Address +- Message Size +- Subject + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailDetailEncryptionReport -StartDate 12/13/2021 -EndDate 12/15/2021 +``` + +This example retrieves encryption details for messages between December 13, 2021 and December 15, 2021. + +## PARAMETERS + +### -Organization +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- EncryptionManual +- EncryptionPolicy + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md new file mode 100644 index 0000000000..ca463e1112 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md @@ -0,0 +1,326 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailDetailTransportRuleReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailDetailTransportRuleReport cmdlet to view the details of messages that matched the conditions defined by any transport rules for the last 10 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailDetailTransportRuleReport [-Action ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-MessageId ] + [-MessageTraceId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-RecipientAddress ] + [-SenderAddress ] + [-StartDate ] + [-TransportRule ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MailDetailTransportRuleReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com +``` + +This example retrieves the details of messages sent by john@contoso.com that matched the conditions defined by a transport rule between June 13, 2015 and June 15, 2015. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- EncryptionManual +- EncryptionPolicy +- TransportRuleActionHits +- TransportRuleHits + + To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify rule event types for rule reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +Although you can enter a date up to 30 days old, only data from the last 10 days is returned. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRule +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md b/exchange/exchange-ps/exchange/Get-MailFilterListReport.md new file mode 100644 index 0000000000..4fe3fbe363 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailFilterListReport.md @@ -0,0 +1,135 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailFilterListReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailFilterListReport cmdlet to obtain values for various parameters that can be supplied to other reporting cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailFilterListReport + [-Domain ] + [-Expression ] + [-ProbeTag ] + [-SelectionTarget ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MailFilterListReport -SelectionTarget TransportRule +``` + +This example uses the Get-MailFilterListReport cmdlet to return information about transport rules. + +## PARAMETERS + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Expression +This parameter is available only in Security & Compliance PowerShell. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Expression +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelectionTarget +The SelectionTarget parameter filters the report information by object type. Valid values are: + +- Actions +- DlpPolicy +- DlpRule +- Domain +- EventTypes +- FindOnPremConnector +- TransportRule + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md new file mode 100644 index 0000000000..eea8f2f7e7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md @@ -0,0 +1,320 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders. If you want information about the basic (not mail-related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-MailPublicFolder [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-ReadFromDomainController] + [-ResultSize ] + [-Server ] + [-SortBy ] [] +``` + +### Identity +``` +Get-MailPublicFolder [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-ReadFromDomainController] + [-ResultSize ] + [-Server ] + [-SortBy ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MailPublicFolder -ResultSize 100 | Format-List +``` + +This example returns the information for up to 100 mail-enabled public folders. In this example, the output of the Get-MailPublicFolder command is piped to the Format-List command so that all the available information is displayed in the result. + +### Example 2 +```powershell +Get-MailPublicFolder -Identity \Marketing\Reports +``` + +This example returns information for the mail-enabled public folder Reports that resides in the Marketing top-level public folder. + +### Example 3 +```powershell +Get-MailPublicFolder -Anr Marketing* +``` + +This example returns all mail-enabled public folders that begin with the word Marketing by using the Anr parameter. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: MailPublicFolderIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +This parameter is available only in the cloud-based service. + +{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias +- Id + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md new file mode 100644 index 0000000000..b18dc3f97a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md @@ -0,0 +1,364 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailTrafficATPReport + +## 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. + +For 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-MailTrafficATPReport + [-Action ] + [-AggregateBy ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-NumberOfRows ] + [-Page ] + [-PageSize ] + [-PivotBy ] + [-ProbeTag ] + [-StartDate ] + [-SummarizeBy ] + [-ThreatClassification ] + [] +``` + +## DESCRIPTION +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. + +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. + +For the reporting period you specify, the cmdlet returns the following information: + +- Date +- Event Type +- Direction +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailTrafficATPReport +``` + +This example retrieves details for messages for the last 92 days. + +### Example 2 +```powershell +Get-MailTrafficATPReport -StartDate (Get-Date "12/25/2021 12:01 AM").ToUniversalTime() -EndDate (Get-Date "12/25/2021 11:59 PM").ToUniversalTime() -Direction Outbound +``` + +This example retrieves the statistics for outgoing messages on December 25, 2021 and displays the results in a table. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound +- IntraOrg + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end of the date range in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- Advanced filter +- Anti-malware Engine +- Campaign +- File detonation +- File detonation reputation +- File reputation +- Fingerprint matching +- General filter +- Impersonation brand +- Impersonation domain +- Impersonation user +- Mailbox intelligence impersonation +- Message passed +- Mixed analysis detection +- Spoof DMARC +- Spoof external domain +- Spoof intra-org +- URL detonation +- URL detonation reputation +- URL malicious reputation + +**Note**: Some values correspond to features that are available only in Defender for Office 365 (plan 1 and plan 2 or plan 2 only). + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfRows +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PivotBy +{{ Fill PivotBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start of the date range in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +If you use this parameter, you also need to use the EndDate parameter. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. + +For this cmdlet, valid values are: + +- Action +- Direction +- Domain +- EventType + +You can specify multiple values separated by commas. When you specify the values Action or Domain, the value is not displayed in the results (the values in the corresponding columns are blank). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreatClassification +{{ Fill ThreatClassification Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md new file mode 100644 index 0000000000..8fe274f754 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: Get-MailTrafficEncryptionReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailTrafficEncryptionReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailTrafficEncryptionReport cmdlet to view the results of encryption in your cloud-based organization for the last 92 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailTrafficEncryptionReport + [-Action ] + [-AggregateBy ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [-SummarizeBy ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- DateTime +- Event Type +- Direction +- Action +- Message Count +- Recipient Count + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailTrafficEncryptionReport -Direction Inbound -StartDate 12/13/2021 -EndDate 12/15/2021 +``` + +This example retrieves encryption information for incoming messages between December 13, 2021 and December 15, 2021. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- EncryptionManual +- EncryptionPolicy + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. + +For this cmdlet, valid values are: + +- Action +- Domain +- EventType + +You can specify multiple values separated by commas. When you specify the values Action or Domain, the value is not displayed in the results (the values in the corresponding columns are blank). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md new file mode 100644 index 0000000000..f1ab603a7f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md @@ -0,0 +1,335 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailTrafficPolicyReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailTrafficPolicyReport cmdlet to view statistics about messages that were affected by data loss prevention (DLP) policies and transport rules for the last 90 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailTrafficPolicyReport [-Action ] + [-AggregateBy ] + [-Direction ] + [-DlpPolicy ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [-SummarizeBy ] + [-TransportRule ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- Domain +- Date +- DLP Policy +- Transport Rule +- Event Type +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailTrafficPolicyReport -Direction Outbound -StartDate 06/13/2015 -EndDate 06/15/2015 +``` + +This example retrieves the statics for outgoing messages between June 13, 2015 and June 15, 2015 that were affected by DLP policies and transport rules. + +### Example 2 +```powershell +Get-MailTrafficPolicyReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount +``` + +This example retrieves the statics for outgoing messages on December 12, 2015 and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table. + +### Example 3 +```powershell +Get-MailTrafficPolicyReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy Domain,DlpPolicy,TransportRule,EventType | Format-Table Domain,Date,EventType,Action,MessageCount +``` + +This example is similar to the previous example, but now the results are summarized. Because the EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced, and values of MessageCount are correspondingly larger on each row. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- DLPActionHits +- DLPPolicyFalsePositive +- DLPPolicyHits +- DLPPolicyOverride +- DLPRuleHits +- TransportRuleActionHits +- TransportRuleHits + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify policy event types for policy reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. + +For this cmdlet, valid values are: + +- Action +- Direction +- DLPPolicy +- Domain +- EventType +- TransportRule + +You can specify multiple values separated by commas. When you specify the values DLPPolicy, Domain, EventType, or TransportRule the value is not displayed in the results (the values in the corresponding columns are blank). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRule +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md new file mode 100644 index 0000000000..5ef4d9692a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md @@ -0,0 +1,243 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailTrafficSummaryReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailTrafficSummaryReport cmdlet to view summary information about message traffic in your organization for the last 90 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailTrafficSummaryReport [-Category ] + [-DlpPolicy ] + [-Domain ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [-TransportRule ] + [] +``` + +## DESCRIPTION +This cmdlet has C1, C2 and C3 as header names and the meaning of them depends on the category you choose. Next you can see an explanation about each category: + +- InboundTransportRuleHits and OutboundTransportRuleHits: C1 is the transport rule name, C2 the audit level and C3 the hits. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailTrafficSummaryReport -Category TopSpamRecipient -StartDate 06/13/2015 -EndDate 06/15/2015 +``` + +This example shows the top spam recipient statistics between June 13, 2015 and June 15, 2015. + +## PARAMETERS + +### -Category +The Category parameter filters the report by category. Valid values are: + +- InboundDLPHits +- OutboundDLPHits +- InboundTransportRuleHits +- OutboundTransportRuleHits +- InboundDLPPolicyRuleHits +- OutboundDLPPolicyRuleHits +- TopSpamRecipient +- TopMailSender +- TopMailRecipient +- TopMalwareRecipient +- TopMalwareAtpRecipient +- TopMalware +- TopPhishRecipient +- TopPhishAtpRecipient +- TopIntraOrgRecipient +- TopIntraOrgSender +- TopIntraOrgSpamRecipient +- TopIntraOrgMalwareRecipient +- TopIntraOrgPhishRecipient +- TopIntraOrgPhishAtpRecipient +- TopIntraOrgMalwareAtpRecipient +- TopComplianceTagActivityCount +- TopComplianceTagActivityCountByDay + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRule +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailUser.md b/exchange/exchange-ps/exchange/Get-MailUser.md new file mode 100644 index 0000000000..acaf5fe057 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailUser.md @@ -0,0 +1,405 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailUser cmdlet to view mail users and also guest users for Microsoft 365 Groups in cloud environments. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-MailUser [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SharedWithMailUser] + [-SoftDeletedMailUser] + [-SortBy ] + [] +``` + +### Identity +``` +Get-MailUser [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SharedWithMailUser] + [-SoftDeletedMailUser] + [-SortBy ] + [] +``` + +### LOBAppAccount +``` +Get-MailUser [-LOBAppAccount] + [-Filter ] + [-OrganizationalUnit ] + [-ProgressAction ] + [-ResultSize ] + [-SharedWithMailUser] + [-SoftDeletedMailUser] + [-SortBy ] + [] +``` + +### HVEAccount +``` +Get-MailUser [-HVEAccount] + [-Filter ] + [-OrganizationalUnit ] + [-ResultSize ] + [-SharedWithMailUser] + [-SortBy ] + [-SoftDeletedMailUser] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailUser +``` + +This example returns a summary list of all mail users in the organization. + +### Example 2 +```powershell +Get-MailUser -Identity Ed | Format-List +``` + +This example returns detailed information for the mail user named Ed. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailUserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -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. + +This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: AnrSet, Identity +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: AnrSet, Identity +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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -HVEAccount +This parameter is available only in the cloud-based service. + +The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: LOBAppAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Position: Named +Default value: None +Required: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity +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 +``` + +### -LOBAppAccount +This parameter is available only in the cloud-based service. + +{{ Fill LOBAppAccount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: LOBAppAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```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 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -SharedWithMailUser +This parameter is available only in the cloud-based service. + +{{ Fill SharedWithMailUser Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias + +```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 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -SoftDeletedMailUser +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. + +Soft-deleted mail users are deleted mail users that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md new file mode 100644 index 0000000000..cae3773fe1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -0,0 +1,923 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-Mailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailbox cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-Mailbox [-Anr ] + [-Arbitration] + [-Archive] + [-AuditLog] + [-AuxAuditLog] + [-Credential ] + [-DomainController ] + [-Filter ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-InactiveMailboxOnly] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeInactiveMailbox] + [-Migration] + [-Monitoring] + [-OrganizationalUnit ] + [-PublicFolder] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-RemoteArchive] + [-ResultSize ] + [-SoftDeletedMailbox] + [-SortBy ] + [-SupervisoryReviewPolicy] + [] +``` + +### DatabaseSet +``` +Get-Mailbox [-Database ] + [-Arbitration] + [-Archive] + [-AuditLog] + [-AuxAuditLog] + [-Credential ] + [-DomainController ] + [-Filter ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-Migration] + [-Monitoring] + [-OrganizationalUnit ] + [-PublicFolder] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-RemoteArchive] + [-ResultSize ] + [-SortBy ] + [-SupervisoryReviewPolicy] + [] +``` + +### Identity +``` +Get-Mailbox [[-Identity] ] + [-Arbitration] + [-Archive] + [-AuditLog] + [-AuxAuditLog] + [-Credential ] + [-DomainController ] + [-Filter ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-InactiveMailboxOnly] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeInactiveMailbox] + [-Migration] + [-Monitoring] + [-OrganizationalUnit ] + [-PublicFolder] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-RemoteArchive] + [-ResultSize ] + [-SoftDeletedMailbox] + [-SortBy ] + [-SupervisoryReviewPolicy] + [] +``` + +### ServerSet +``` +Get-Mailbox [-Server ] + [-Arbitration] + [-Archive] + [-AuditLog] + [-AuxAuditLog] + [-Credential ] + [-DomainController ] + [-Filter ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-Migration] + [-Monitoring] + [-OrganizationalUnit ] + [-PublicFolder] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-RemoteArchive] + [-ResultSize ] + [-SortBy ] + [-SupervisoryReviewPolicy] + [] +``` + +### MailboxPlanSet +``` +Get-Mailbox [-MailboxPlan ] + [-Archive] + [-Filter ] + [-GroupMailbox] + [-InactiveMailboxOnly] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeInactiveMailbox] + [-Migration] + [-OrganizationalUnit ] + [-PublicFolder] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SoftDeletedMailbox] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Mailbox -ResultSize unlimited +``` + +This example returns a summary list of all the mailboxes in your organization. + +### Example 2 +```powershell +Get-Mailbox -OrganizationalUnit Users +``` + +This example returns a list of all the mailboxes in your organization in the Users OU. + +### Example 3 +```powershell +Get-Mailbox -Anr Chr +``` + +This example returns all the mailboxes that resolve from the ambiguous name resolution search on the string "Chr". This example returns mailboxes for users such as Chris Ashton, Christian Hess, and Christa Geller. + +### Example 4 +```powershell +Get-Mailbox -Archive -Database MBXDB01 +``` + +This example returns a summary list of all archive mailboxes in the database named MBXDB01. + +### Example 5 +```powershell +Get-Mailbox -Identity ed@contoso.com -RemoteArchive +``` + +This example returns information about the remote archive mailbox for the user ed@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Anr, Database, MailboxPlan or Server parameters. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow. + +To return arbitration mailboxes that are used to store audit log settings or data, don't use this switch. Instead, use the AuditLog or AuxAuditLog switches. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To return other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxAuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To return other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in 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: AnrSet, DatabaseSet, Identity, ServerSet +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 +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Anr, Identity, or Server parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: DatabaseSet +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet +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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InactiveMailboxOnly +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. + +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. + +To include active and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAcceptMessagesOnlyFromWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeEmailAddressDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeEmailAddressDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeForwardingAddressWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeForwardingAddressWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeInactiveMailbox +This parameter is available only in the cloud-based service. + +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. + +To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxPlan +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: + +- Name +- Alias +- Display name +- Distinguished name (DN) +- GUID + +A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. + +You can't use this parameter with the Anr or Identity parameters. + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Migration +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Monitoring +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. + +Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet +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 +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet +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 +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: + +- DiscoveryMailbox +- EquipmentMailbox +- GroupMailbox (Exchange 2013 or later and cloud) +- LegacyMailbox +- LinkedMailbox +- LinkedRoomMailbox (Exchange 2013 or later and cloud) +- RoomMailbox +- SchedulingMailbox (Exchange 2016 or later and cloud) +- SharedMailbox +- TeamMailbox (Exchange 2013 or later and cloud) +- UserMailbox + +You can specify multiple values separated by commas. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteArchive +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. + +Remote archive mailboxes are archive mailboxes in the cloud-based service that are associated with mailbox users in on-premises Exchange organizations. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Server +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. + +You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use this parameter with the Anr, Database, or Identity parameters. + +The ServerName and ServerLegacyDN properties for a mailbox may not be updated immediately after a mailbox move within a database availability group (DAG). To get the most up-to-date values for these mailbox properties, run the command `Get-Mailbox | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN`. + +**Note**: The result from this parameter could be a legacy value before migration. For better results, use the Database parameter instead. + +```yaml +Type: ServerIdParameter +Parameter Sets: ServerSet +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 +``` + +### -SoftDeletedMailbox +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. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias +- Office +- ServerLegacyDN + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupervisoryReviewPolicy +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet +Aliases: +Applicable: 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/Get-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md new file mode 100644 index 0000000000..52e699b66f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md @@ -0,0 +1,127 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxAuditBypassAssociation [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +When you configure a user or computer account to bypass mailbox audit logging, access or actions taken by the user account or computer account to any mailbox isn't logged. By bypassing trusted user accounts or computer accounts that need to access mailboxes frequently, you can reduce the noise in mailbox audit logs. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MailboxAuditBypassAssociation -ResultSize unlimited | Format-Table Name,AuditBypassEnabled +``` + +This example returns all accounts and whether they are configured or not configured for mailbox audit logging bypass. + +### Example 2 +```powershell +Get-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" +``` + +This example returns the status of the AuditBypassEnabled property for the Svc-MyApplication account. + +### Example 3 +```powershell +$MBX = Get-MailboxAuditBypassAssociation -ResultSize unlimited + +$MBX | where {$_.AuditBypassEnabled -eq $true} | Format-Table Name,AuditBypassEnabled +``` + +This example returns all accounts that are configured for mailbox audit logging bypass. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md new file mode 100644 index 0000000000..2eaf391e3c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md @@ -0,0 +1,194 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve Automatic Replies settings for a specific 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). + +## SYNTAX + +``` +Get-MailboxAutoReplyConfiguration [-Identity] + [-Credential ] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +You can use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve all the mailboxes enabled for Automatic Replies. When run, the cmdlet returns Automatic Replies settings for the specified mailbox that include the following: + +- 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 +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Mailbox -ResultSize unlimited | Get-MailboxAutoReplyConfiguration +``` + +This example returns Automatic Replies settings for all mailboxes in the Exchange organization. + +### Example 2 +```powershell +Get-MailboxAutoReplyConfiguration -Identity 'contoso.com/Users/Tony Smith' +``` + +This example retrieves Automatic Replies settings for Tony's mailbox at contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md new file mode 100644 index 0000000000..d8966ce18e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md @@ -0,0 +1,173 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxCalendarConfiguration cmdlet to show the calendar settings for a specified mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Get-MailboxCalendarConfiguration [-Identity] [-DomainController ] + [] +``` + +### Identity +``` +Get-MailboxCalendarConfiguration [[-Identity] ] [] +``` + +### MailboxLocation +``` +Get-MailboxCalendarConfiguration [-MailboxLocation ] [] +``` + +## DESCRIPTION +The Get-MailboxCalendarConfiguration cmdlet returns settings for the calendar of the specified mailbox, including the following: + +- Workdays: Days that appear in the calendar as work days in Outlook on the web +- WorkingHoursStartTime: Time that the calendar work day starts +- WorkingHoursEndTime: Time that the calendar work day ends +- WorkingHoursTimeZone: Time zone set on the mailbox for the working hours start and end times +- WeekStartDay: First day of the calendar work week +- ShowWeekNumbers: Number for each week ranging from 1 through 52 for the calendar while in month view in Outlook on the web +- TimeIncrement: Increments in minutes in which the calendar displays time in Outlook on the web +- RemindersEnabled: Whether Outlook on the web provides a visual cue when a calendar reminder is due +- ReminderSoundEnabled: Whether a sound is played when a calendar reminder is due +- DefaultReminderTime: Length of time before each meeting or appointment that the calendar in Outlook on the web shows the reminder + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxCalendarConfiguration -Identity kai | Format-List +``` + +This example retrieves all the calendar settings for Kai's mailbox where the Identity parameter is specified in the alias format. + +### Example 2 +```powershell +Get-MailboxCalendarConfiguration -Identity contoso\tony +``` + +This example uses the Identity parameter specified in the domain\\account format and returns the calendar settings for Tony's mailbox. + +### Example 3 +```powershell +Get-MailboxCalendarConfiguration -Identity kai -DomainController DC1 +``` + +This example requests that the domain controller DC1 retrieves calendar settings for Kai's mailbox from Active Directory. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Default +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Default +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 +``` + +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md new file mode 100644 index 0000000000..075437cc2c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md @@ -0,0 +1,142 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxCalendarFolder cmdlet to retrieve the publishing or sharing settings for a specified mailbox calendar folder. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxCalendarFolder [-Identity] + [-UseCustomRouting] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxCalendarFolder -Identity kai:\Calendar +``` + +This example returns all provided publishing information for the specified calendar folder in Kai's mailbox. In this example, the Identity parameter specifies the mailbox with the alias format. + +### Example 2 +```powershell +Get-MailboxCalendarFolder -Identity kai:\Calendar -DomainController DC1 +``` + +This example returns all provided publishing information for the specified calendar folder in Kai's mailbox. This example also specifies DC1 as the domain controller to retrieve this information from Active Directory. + +### Example 3 +```powershell +Get-MailboxCalendarFolder -Identity contoso\kai:\Calendar +``` + +This example returns all provided publishing information for the specified calendar folder in Kai's mailbox. In this example, the Identity parameter specifies the mailbox with the domain\\account format. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Calendar`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md b/exchange/exchange-ps/exchange/Get-MailboxDatabase.md new file mode 100644 index 0000000000..82286a48e4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxDatabase.md @@ -0,0 +1,241 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MailboxDatabase cmdlet to retrieve one or more mailbox database objects from a server or organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-MailboxDatabase -Server + [-DomainController ] + [-DumpsterStatistics] + [-IncludeCorrupted] + [-IncludePreExchange2010] + [-IncludePreExchange2013] + [-Status] + [] +``` + +### Identity +``` +Get-MailboxDatabase [[-Identity] ] + [-DomainController ] + [-DumpsterStatistics] + [-IncludeCorrupted] + [-IncludePreExchange2010] + [-IncludePreExchange2013] + [-Status] + [] +``` + +## DESCRIPTION +If you use the Get-MailboxDatabase cmdlet with no parameters, it retrieves information about all mailbox databases in the Exchange organization. If you use the Get-MailboxDatabase cmdlet with the Server parameter, it retrieves information about all mailbox databases on the server that you specify. + +The following list describes the properties that are returned in the results. + +- Name: Name of the database. +- Server: Server hosting the database. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxDatabase +``` + +### Example 2 +```powershell +Get-MailboxDatabase -Identity MailboxDatabase01 -Status | Format-List +``` + +This example returns detailed information about the mailbox database named MailboxDatabase01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox database that you want to view. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter filters the results by the specified Mailbox server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use this parameter with the Identity parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +``` + +### -DumpsterStatistics +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeCorrupted +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePreExchange2010 +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePreExchange2013 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status switch specifies whether to retrieve the available free space in the database root and information about the following attributes: + +- BackupInProgress +- Mounted +- OnlineMaintenanceInProgress + +You don't need to specify a value with this switch. + +If you specify this switch, you should format the output in such a way that you can view the additional attributes, for example, pipe the output to the Format-List 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/database-availability-groups/Get-MailboxDatabaseCopyStatus.md b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md similarity index 76% rename from exchange/exchange-ps/exchange/database-availability-groups/Get-MailboxDatabaseCopyStatus.md rename to exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md index 93f13dc962..d58b4dc67d 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Get-MailboxDatabaseCopyStatus.md +++ b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxDatabaseCopyStatus @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxDatabaseCopyStatus cmdlet to view health and status information about one or more mailbox database copies. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,42 +27,45 @@ Get-MailboxDatabaseCopyStatus -Server [-ConnectionStatus] [-DomainController ] [-ExtendedErrorInfo] - [-UseServerCache] [] + [-UseServerCache] + [] ``` ### Identity ``` -Get-MailboxDatabaseCopyStatus [[-Identity] ] [-Local] +Get-MailboxDatabaseCopyStatus [[-Identity] ] + [-Local] [-Active] [-ConnectionStatus] [-DomainController ] [-ExtendedErrorInfo] - [-UseServerCache] [] + [-UseServerCache] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxDatabaseCopyStatus -Identity DB1 | Format-List ``` This example returns status information for all copies of the database DB1. The status results are displayed in a list format. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxDatabaseCopyStatus -Server MBX1 | Format-List ``` This example returns the status for all database copies on the Mailbox server MBX1. The status results are also displayed in a list format. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxDatabaseCopyStatus -Identity DB1\MBX2 | Format-List ``` @@ -67,6 +73,22 @@ This example returns the status for the copy of database DB1 on the Mailbox serv ## PARAMETERS +### -Identity +The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of `\`. Specifying just `` returns information for all copies of the database. This parameter can't be combined with the Server parameter. + +```yaml +Type: DatabaseCopyIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter specifies that a Mailbox server returns status information for all of its mailbox database copies. This parameter can't be combined with the Identity parameter. @@ -75,6 +97,7 @@ Type: MailboxServerIdParameter Parameter Sets: Server Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -83,13 +106,14 @@ Accept wildcard characters: False ``` ### -Active -The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. +The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -105,6 +129,7 @@ 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 @@ -120,6 +145,7 @@ 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 @@ -127,29 +153,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of \\\\. Specifying just \ returns information for all copies of the database. This parameter can't be combined with the Server parameter. - -```yaml -Type: DatabaseCopyIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Local -The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. +The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -158,13 +170,14 @@ Accept wildcard characters: False ``` ### -ExtendedErrorInfo -The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. +The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -173,13 +186,14 @@ Accept wildcard characters: False ``` ### -UseServerCache -The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. +The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -188,20 +202,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6ad690fb-3a23-41d4-b19d-666b34e62b26.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Get-MailboxExportRequest.md rename to exchange/exchange-ps/exchange/Get-MailboxExportRequest.md index d26a7e6ec7..106407e8e1 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxExportRequest @@ -13,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxExportRequest cmdlet to view the detailed status of an ongoing export request that was initiated by using the New-MailboxExportRequest cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,7 +26,8 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-MailboxExportRequest [[-Identity] ] [-DomainController ] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ### MailboxFiltering @@ -32,12 +36,13 @@ Get-MailboxExportRequest [-Mailbox ] [-BatchName ] [-Database ] [-DomainController ] - [-HighPriority <$true | $false>] + [-HighPriority ] [-Name ] [-ResultSize ] - [-Status ] - [-Suspend <$true | $false>] - [-RequestQueue ] [] + [-Status ] + [-Suspend ] + [-RequestQueue ] + [] ``` ### MailboxLocationFiltering @@ -46,44 +51,45 @@ Get-MailboxExportRequest [-Mailbox ] [-BatchName ] [-Database ] [-DomainController ] - [-HighPriority <$true | $false>] + [-HighPriority ] [-Name ] [-ResultSize ] - [-Status ] - [-Suspend <$true | $false>] - [-RequestQueue ] [] + [-Status ] + [-Suspend ] + [-RequestQueue ] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxExportRequest -Identity "tony\DB01toPST" ``` This example returns the status of the ongoing export request with the identity tony\\DB01toPST. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxExportRequest -Status InProgress -Database DB01 ``` In Exchange Server 2010, this example returns the status of in progress export requests for mailboxes or archives that reside on database DB01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxExportRequest -BatchName "Attachment_CompanyReport" -Status Completed ``` This example returns the status of export requests in the Attachment\_CompanyReport batch that completed. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MailboxExportRequest -Name "DB01toPST" -Suspend $true ``` @@ -92,20 +98,15 @@ This example returns all export requests that have the name DB01toPST where the ## PARAMETERS ### -Identity -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: \\\\. Exchange automatically precedes the request with the mailbox's alias. +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: - BatchName - - Mailbox - - Name - - Status - - Suspend - - HighPriority ```yaml @@ -113,6 +114,7 @@ Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -123,13 +125,14 @@ Accept wildcard characters: False ### -BatchName The BatchName parameter specifies the name given to a batch export request. -You can't use this parameter in conjunction with the Identity parameter. +You can't use this parameter with the Identity parameter. ```yaml Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -138,21 +141,22 @@ Accept wildcard characters: False ``` ### -Database -This parameter is available or functional only in Exchange Server 2010. - -The Database parameter specifies the database in which the user's mailbox or archive resides. You can use the following values: +This parameter is available only in Exchange Server 2010. -- GUID of the database +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: -- Database name +- Name +- Distinguished name (DN) +- GUID -You can't use this parameter in conjunction with the Identity parameter. +You can't use this parameter with the Identity parameter. ```yaml Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -168,6 +172,7 @@ 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 @@ -179,16 +184,16 @@ Accept wildcard characters: False 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. - - $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -204,25 +209,14 @@ In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParam In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdParameter, so you can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) You can't use this parameter with the Identity parameter. @@ -232,6 +226,7 @@ Type: MailboxOrMailUserIdParameter Parameter Sets: MailboxFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -244,6 +239,7 @@ Type: MailboxLocationIdParameter Parameter Sets: MailboxLocationFiltering Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -265,6 +261,7 @@ Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -280,6 +277,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -291,23 +289,14 @@ Accept wildcard characters: False The Status parameter filters the results based on status. You can use the following values: - AutoSuspended - - Completed - - CompletedWithWarning - - CompletionInProgress - - Failed - - InProgress - - Queued - - Retrying - - Suspended - - Synced You can't use this parameter with the Identity parameter. @@ -315,10 +304,11 @@ 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. ```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Completed | CompletedWithWarning | Suspended | Failed +Type: RequestStatus Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -332,10 +322,11 @@ The Suspend parameter specifies whether to return requests that have been suspen You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -346,9 +337,9 @@ Accept wildcard characters: False ### -RequestQueue 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -357,6 +348,7 @@ Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -365,20 +357,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/f9372840-f387-4e4e-bf56-cf9c4f49d4cb.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxExportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Get-MailboxExportRequestStatistics.md rename to exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md index ede3c8b040..27ef9ad06f 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxExportRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxExportRequestStatistics @@ -13,75 +16,88 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxExportRequestStatistics cmdlet to view detailed information about export requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Get-MailboxExportRequestStatistics [-Identity] [-DomainController ] - [-IncludeReport] [-Diagnostic] [-DiagnosticArgument ] [-DiagnosticInfo ] [-ReportOnly] [] +Get-MailboxExportRequestStatistics [-Identity] + [-DomainController ] + [-IncludeReport] + [-Diagnostic] + [-DiagnosticArgument ] + [-DiagnosticInfo ] + [-ReportOnly] + [] ``` ### MRSInstance ``` -Get-MailboxExportRequestStatistics -MRSInstance [-DomainController ] [-RequestGuid ] +Get-MailboxExportRequestStatistics -MRSInstance + [-DomainController ] + [-RequestGuid ] [] ``` ### MigrationRequestQueue ``` -Get-MailboxExportRequestStatistics -RequestQueue [-DomainController ] - [-IncludeReport] [-RequestGuid ] [-Diagnostic] [-DiagnosticArgument ] [-ReportOnly] +Get-MailboxExportRequestStatistics -RequestQueue + [-DomainController ] + [-IncludeReport] + [-RequestGuid ] + [-Diagnostic] + [-DiagnosticArgument ] + [-ReportOnly] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxExportRequestStatistics -Identity Tony\MailboxExport1 ``` This example returns the default statistics for the second export request for Tony Smith. The type of information returned by default includes name, mailbox, and status. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxExportRequestStatistics -Identity Tony\MailboxExport | Export-CSV \\SERVER01\ExportRequest_Reports\Tony_Exportstats.csv ``` This example returns statistics for Tony Smith's mailbox and exports the report to a .csv file. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxExportRequestStatistics -Identity Tony\LegalHold -IncludeReport | Format-List ``` This example returns additional information about the export request for Tony Smith's mailbox by using the IncludeReport parameter and by pipelining the results to the Format-List command. (The export request was created using the New-MailboxExportRequest.) -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell 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. -### -------------------------- Example 5 -------------------------- -``` +### 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. -### -------------------------- Example 6 -------------------------- -``` +### Example 6 +```powershell Get-MailboxExportRequest -Status Failed | Get-MailboxExportRequestStatistics -IncludeReport | Format-List > AllExportReports.txt ``` @@ -90,7 +106,7 @@ This example returns additional information for all the export requests that hav ## PARAMETERS ### -Identity -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: \\\\. +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. @@ -99,6 +115,7 @@ Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -107,17 +124,18 @@ Accept wildcard characters: False ``` ### -MRSInstance -This parameter is available or functional only in 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. -This parameter can't be used in conjunction with the Identity or RequestQueue parameters. +You can't use this parameter with the Identity or RequestQueue parameters. ```yaml Type: Fqdn Parameter Sets: MRSInstance Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -130,9 +148,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -141,6 +159,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -149,13 +168,16 @@ Accept wildcard characters: False ``` ### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -171,6 +193,7 @@ Type: String Parameter Sets: Identity, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -188,6 +211,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -203,6 +227,7 @@ 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 @@ -211,13 +236,14 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -233,6 +259,7 @@ Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -241,13 +268,14 @@ Accept wildcard characters: False ``` ### -RequestGuid -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 in conjunction with the Identity parameter. +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 Default value: None @@ -256,20 +284,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/73c79d8c-d8c0-4389-a5ad-520c2c94909e.aspx) diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolder.md b/exchange/exchange-ps/exchange/Get-MailboxFolder.md new file mode 100644 index 0000000000..3e9a4e5383 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxFolder.md @@ -0,0 +1,223 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxFolder cmdlet to view folders in your own mailbox. Administrators can't use this cmdlet to view folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### GetChildren +``` +Get-MailboxFolder [[-Identity] ] + [-GetChildren] + [-DomainController ] + [-MailFolderOnly] + [-ResultSize ] + [] +``` + +### Recurse +``` +Get-MailboxFolder [[-Identity] ] + [-Recurse] + [-DomainController ] + [-MailFolderOnly] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxFolder -Identity :\Inbox | Format List +``` + +This example returns detailed information about the Inbox folder in your own mailbox. + +### Example 2 +```powershell +Get-MailboxFolder +``` + +This example returns a summary list of the root folders in your own mailbox. + +### Example 3 +```powershell +Get-MailboxFolder -GetChildren -MailFolderOnly +``` + +This example returns the first level of mail folders in your own mailbox. + +### Example 4 +```powershell +Get-MailboxFolder -Identity :\Inbox -GetChildren +``` + +This example returns information about all the subfolders under Inbox in your own mailbox. + +### Example 5 +```powershell +Get-MailboxFolder -Identity :\Inbox -Recurse +``` + +This example returns a summary list of all levels of folders under Inbox in your own mailbox. + +## PARAMETERS + +### -Identity +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. + +For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't specify the folder, the command returns information about folders in the root hierarchy of the specified mailbox. + +Example values for this parameter are `john@contoso.com:`, `John:\Inbox`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -GetChildren +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailFolderOnly +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md new file mode 100644 index 0000000000..1873b6abc7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md @@ -0,0 +1,236 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxFolderPermission [-Identity] + [-DomainController ] + [-GroupMailbox] + [-ResultSize ] + [-SkipCount ] + [-UseCustomRouting] + [-User ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports +``` + +This example returns the current list of user permissions for the Reports subfolder in the Marketing folder in John's mailbox. + +### Example 2 +```powershell +Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -User Ayla@contoso.com +``` + +This example returns the permissions for the same folder in John's mailbox, but only for the user Ayla. + +### Example 3 +```powershell +Get-MailboxFolderPermission -Identity john@contoso.com:\Calendar -User Ayla@contoso.com +``` + +This example returns the permissions for the Calendar folder in John's mailbox, but only for the user Ayla. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inbox\Reports`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailboxFolderUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) + +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) + +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) + +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md new file mode 100644 index 0000000000..8b201910e4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md @@ -0,0 +1,424 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-MailboxFolderStatistics [-Identity] + [-Archive] + [-DiagnosticInfo ] + [-DomainController ] + [-FolderScope ] + [-IncludeAnalysis] + [-IncludeOldestAndNewestItems] + [-IncludeSoftDeletedRecipients] + [-ResultSize ] + [-SkipCount ] + [-UseCustomRouting] + [] +``` + +### AuditLog +``` +Get-MailboxFolderStatistics [[-Identity] ] + [-AuditLog] + [-DiagnosticInfo ] + [-DomainController ] + [-FolderScope ] + [-IncludeAnalysis] + [-IncludeOldestAndNewestItems] + [-IncludeSoftDeletedRecipients] + [-ResultSize ] + [-SkipCount ] + [] +``` + +### Database +``` +Get-MailboxFolderStatistics -Database -StoreMailboxIdentity + [-DiagnosticInfo ] + [-FolderScope ] + [-IncludeAnalysis] + [-IncludeOldestAndNewestItems] + [-IncludeSoftDeletedRecipients] + [-ResultSize ] + [-SkipCount ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://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. + +The Get-MailboxFolderStatistics cmdlet shouldn't be confused with the Get-MailboxStatistics cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxFolderStatistics -Identity contoso\chris +``` + +This example doesn't specify the FolderScope parameter and retrieves all the information about the user Chris in the Contoso domain. + +### Example 2 +```powershell +Get-MailboxFolderStatistics -Identity Chris -FolderScope Calendar +``` + +This example uses the FolderScope parameter to view the statistics for calendar folders for the user Chris. + +### Example 3 +```powershell +Get-MailboxFolderStatistics -Identity Ayla@contoso.com -Archive +``` + +This example uses the Archive switch to view the statistics for Ayla's archive. + +### Example 4 +```powershell +Get-MailboxFolderStatistics -Identity "Tony" -FolderScope RecoverableItems -IncludeAnalysis +``` + +This example uses the IncludeAnalysis switch to view the statistics of Tony's Recoverable Items folder. + +### Example 5 +```powershell +$All = Get-Mailbox -ResultSize Unlimited + +$All | foreach {Get-MailboxFolderStatistics -Identity $_.Identity -FolderScope Inbox | Format-Table Identity,ItemsInFolderAndSubfolders,FolderAndSubfolderSize -AutoSize} +``` + +This example uses the FolderScope parameter to view inbox folders statistics for all mailboxes. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: GeneralMailboxOrMailUserIdParameter +Parameter Sets: AuditLog +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Database +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoreMailboxIdentity +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLog +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: AuditLog +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticInfo +This parameter is available only in the cloud-based service. + +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Identity, AuditLog +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 +``` + +### -FolderScope +The FolderScope parameter specifies the scope of the search by folder type. Valid parameter values include: + +- All +- Archive: Exchange 2016 or later. +- Calendar +- Contacts +- ConversationHistory +- DeletedItems +- Drafts +- Inbox +- JunkEmail +- Journal +- LegacyArchiveJournals: Exchange 2013 or later. +- ManagedCustomFolder: Returns output for all managed custom folders. +- NonIpmRoot: Exchange 2013 or later. +- Notes +- Outbox +- Personal +- RecoverableItems: Returns output for the Recoverable Items folder and the Deletions, DiscoveryHolds, Purges, and Versions subfolders. +- RssSubscriptions +- SentItems +- SyncIssues +- Tasks + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAnalysis +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeOldestAndNewestItems +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedRecipients +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. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md new file mode 100644 index 0000000000..ca07bcdfd7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxirmaccess +applicable: Exchange Online +title: Get-MailboxIRMAccess +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxIRMAccess + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailboxIRMAccess cmdlet to view delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxIRMAccess [[-Identity] ] + [-User ] + [] +``` + +## DESCRIPTION +> [!NOTE] +> This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +> +> Delegates with Full Access permission to the mailbox who don't appear in the results of this cmdlet have access to IRM-protected messages. Only Full Access delegates who are blocked from reading IRM-protected messages in the mailbox appear in the results. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com +``` + +This example returns information about delegate access to IRM-protected messages in Lynette's mailbox: + +- Full Access delegates who appear in the results are blocked from reading IRM-protected messages in the mailbox. +- Full Access delegates who don't appear in the results can read IRM-protected messages in the mailbox. + +### Example 2 +```powershell +Get-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com +``` + +This example returns information about delegate Chris' access to IRM-protected messages in Lynette's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox where you want to view delegate access to IRM-protected messages. You can use any value that uniquely identifies the mailbox. For example + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -User +The User parameter filters the results in the mailbox by the specified delegate. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md similarity index 77% rename from exchange/exchange-ps/exchange/mailboxes/Get-MailboxImportRequest.md rename to exchange/exchange-ps/exchange/Get-MailboxImportRequest.md index 91e68bb640..63f31df6ff 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxImportRequest @@ -13,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxImportRequest cmdlet to view the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,7 +26,8 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-MailboxImportRequest [[-Identity] ] [-DomainController ] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ### MailboxFiltering @@ -32,13 +36,14 @@ Get-MailboxImportRequest [-BatchName ] [-Database ] [-DomainController ] - [-HighPriority <$true | $false>] + [-HighPriority ] [-Mailbox ] [-Name ] [-ResultSize ] - [-Status ] - [-Suspend <$true | $false>] - [-RequestQueue ] [] + [-Status ] + [-Suspend ] + [-RequestQueue ] + [] ``` ### MailboxLocationFiltering @@ -47,45 +52,46 @@ Get-MailboxImportRequest [-BatchName ] [-Database ] [-DomainController ] - [-HighPriority <$true | $false>] + [-HighPriority ] [-Mailbox ] [-Name ] [-ResultSize ] - [-Status ] - [-Suspend <$true | $false>] - [-RequestQueue ] [] + [-Status ] + [-Suspend ] + [-RequestQueue ] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxImportRequest -Identity "tony\Recovered" ``` This example returns the default information regarding the status of the ongoing import request with the identity tony\\Recovered. The type of information returned by default includes name, mailbox, and status. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxImportRequest -Status InProgress -Database DB01 ``` In Exchange Server 2010, this example returns the status of in progress import requests for mailboxes or archives that reside on database DB01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxImportRequest -BatchName "ImportingDB1PSTs" -Status Completed ``` This example returns the status of import requests in the ImportingDB1PSTs batch that completed. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MailboxImportRequest -Name "Recovered" -Suspend $true ``` @@ -94,20 +100,15 @@ This example returns all import requests that have the name Recovered where the ## PARAMETERS ### -Identity -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: \\\\. Microsoft Exchange automatically precedes the request with the mailbox's alias. +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: - BatchName - - Mailbox - - Name - - Status - - Suspend - - HighPriority ```yaml @@ -115,6 +116,7 @@ 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 Default value: None @@ -125,13 +127,14 @@ Accept wildcard characters: False ### -BatchName The BatchName parameter specifies the name given to a batch import request. -You can't use this parameter in conjunction with the Identity parameter. +You can't use this parameter with the Identity parameter. ```yaml 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 Default value: None @@ -140,21 +143,22 @@ Accept wildcard characters: False ``` ### -Database -This parameter is available or functional only in Exchange Server 2010. - -The Database parameter specifies the database in which the user's mailbox or archive resides. You can use the following values: +This parameter is available only in Exchange Server 2010. -- GUID of the database +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: -- Database name +- Name +- Distinguished name (DN) +- GUID -You can't use this parameter in conjunction with the Identity parameter. +You can't use this parameter with the Identity parameter. ```yaml Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -172,6 +176,7 @@ 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 @@ -185,16 +190,16 @@ 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: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. - - $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -203,6 +208,8 @@ Accept wildcard characters: False ``` ### -Mailbox +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. 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. @@ -210,25 +217,14 @@ In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParam In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdParameter, so you can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) You can't use this parameter with the Identity parameter. @@ -238,6 +234,7 @@ Type: MailboxOrMailUserIdParameter Parameter Sets: MailboxFiltering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -249,7 +246,8 @@ Accept wildcard characters: False Type: MailboxLocationIdParameter Parameter Sets: MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -269,6 +267,7 @@ 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 Default value: None @@ -284,6 +283,7 @@ 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 Default value: None @@ -295,23 +295,14 @@ Accept wildcard characters: False The Status parameter filters the results based on status. You can use the following values: - AutoSuspended - - Completed - - CompletedWithWarning - - CompletionInProgress - - Failed - - InProgress - - Queued - - Retrying - - Suspended - - Synced You can't use this parameter with the Identity parameter. @@ -319,10 +310,11 @@ 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. ```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Completed | CompletedWithWarning | Suspended | Failed +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 Default value: None @@ -336,10 +328,11 @@ The Suspend parameter specifies whether to return requests that have been suspen You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +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 Default value: None @@ -352,9 +345,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -363,6 +356,7 @@ Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -371,20 +365,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7ee34d59-190e-45b4-80be-4479b1935ae4.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxImportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md similarity index 77% rename from exchange/exchange-ps/exchange/mailboxes/Get-MailboxImportRequestStatistics.md rename to exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md index 5138e19721..5803c36890 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxImportRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxImportRequestStatistics @@ -13,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxImportRequestStatistics cmdlet to view detailed information about import requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,6 +38,7 @@ Get-MailboxImportRequestStatistics [-Identity] Get-MailboxImportRequestStatistics [-Identity] [-DiagnosticInfo ] [-IncludeReport] + [-IncludeSkippedItems] [-ReportOnly] [] ``` @@ -62,40 +66,40 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxImportRequestStatistics -Identity Tony\MailboxImport1 ``` This example returns the default statistics for the second import request for Tony Smith. The type of information returned by default includes name, mailbox and status. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxImportRequestStatistics -Identity Tony\MailboxImport1 | Export-CSV \\SERVER01\ImportRequest_Reports\Tony_Importstats.csv ``` This example returns the detailed statistics for the second import request for Tony Smith's mailbox and exports the report to a .csv file. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxImportRequestStatistics -Identity Tony\LegalHold -IncludeReport | Format-List ``` This example returns additional information about the import request for Tony Smith's mailbox by using the IncludeReport parameter and by pipelining the results to the Format-List command. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MailboxImportRequestStatistics -MRSInstance CAS01.contoso.com ``` In Exchange Server 2010, this example returns default statistics for an import request that was processed by the instance of MRS running on the server CAS01. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Get-MailboxImportRequest -Status Failed | Get-MailboxImportRequestStatistics -IncludeReport | Format-List > AllImportReports.txt ``` @@ -104,13 +108,16 @@ This example returns additional information for all the import requests that hav ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you specified a name when you created the import request, use the following syntax: \\\\. +The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name when you created the import request, use the following syntax: `Alias\Name`. + +**Note**: In Exchange Online, the alias of a soft-deleted mailbox might match the alias of an active mailbox. To ensure uniqueness, use the RequestGuid value from the output of the Get-MailboxImportRequest cmdlet for the value of this parameter. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -119,17 +126,18 @@ Accept wildcard characters: False ``` ### -MRSInstance -This parameter is available or functional only in 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. -This parameter can't be used in conjunction with the Identity or RequestQueue parameters. +You can't use this parameter with the Identity or RequestQueue parameters. ```yaml Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -144,9 +152,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -155,6 +163,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -165,13 +174,16 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,6 +201,7 @@ Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -206,6 +219,7 @@ Type: String Parameter Sets: IdentityCloud Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -223,6 +237,7 @@ 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 Default value: None @@ -231,13 +246,32 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue 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 +``` + +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -257,6 +291,7 @@ Type: Guid Parameter Sets: MigrationMRSInstance, MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -272,6 +307,7 @@ Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -280,20 +316,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/678ffbbb-469d-4681-ba2e-33d4e0afe94f.aspx) diff --git a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md new file mode 100644 index 0000000000..bc4b367757 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md @@ -0,0 +1,185 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxJunkEmailConfiguration cmdlet to view the junk email settings on mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxJunkEmailConfiguration [-Identity] + [-Credential ] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## DESCRIPTION +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. + + Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. + +- Configure the safelist collection: The safelist collection is the Safe Senders list, the Safe Recipients list, and the Blocked Senders list. Users can configure the safelist collection on their own mailbox by using Microsoft Outlook or Outlook on the web. + +Administrators can enable or disable the junk email rule, and configure the safelist collection on a mailbox by using the Set-MailboxJunkEmailConfiguration cmdlet. For more information, see [Configure Exchange antispam settings on mailboxes](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxJunkEmailConfiguration -Identity "David Pelton" +``` + +This example returns the junk email configuration for the user named David Pelton. + +### Example 2 +```powershell +$AllUsers = Get-Mailbox -ResultSize unlimited -RecipientTypeDetails UserMailbox + +$AllUsers | foreach {Get-MailboxJunkEmailConfiguration -Identity $_.UserPrincipalName} | Where {$_.Enabled -eq $false} | Format-Table -Auto Identity,Enabled +``` + +This example returns a summary list of all mailboxes in your organization where the junk email rule is disabled. The first command stores all user mailboxes in a variable. The second command parses through the mailboxes and returns the FQDN of the mailboxes where the junk email rule is disabled. + +To return all mailboxes where the junk email rule is enabled, change the value $false to $true. To return a mixed list of mailboxes where the junk email rule is enabled and disabled, remove the "| Where {$\_.Enabled -eq $false " part of the second command. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can use the wildcard character (\*) to identify multiple mailboxes. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: True +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxLocation.md b/exchange/exchange-ps/exchange/Get-MailboxLocation.md new file mode 100644 index 0000000000..ea42b8a024 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxLocation.md @@ -0,0 +1,253 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxLocation cmdlet to view mailbox location information in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DatabaseSet +``` +Get-MailboxLocation -Database + [-Confirm] + [-MailboxLocationType ] + [-ResultSize ] + [-WhatIf] + [] +``` + +### Identity +``` +Get-MailboxLocation -Identity + [-Confirm] + [-MailboxLocationType ] + [-ResultSize ] + [-WhatIf] + [] +``` + +### User +``` +Get-MailboxLocation -User + [-IncludePreviousPrimary] + [-Confirm] + [-MailboxLocationType ] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxLocation -User chris@contoso.com +``` + +In Exchange Online, this example returns the mailbox location information for the user chris@contoso.com. + +### Example 2 +```powershell +Get-MailboxLocation -Identity e15664af-82ed-4635-b02a-df7c2e03d950 +``` + +In Exchange Server or Exchange Online, this example returns the mailbox location information for the specified mailbox GUID (the ExchangeGuid property value from the results of `Get-Mailbox -Identity | Format-List ExchangeGuid`). + +## PARAMETERS + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: DatabaseSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the mailbox location object that you want to view. The value uses the either of the following formats: + +- TenantGUID\\MailboxGUID +- MailboxGUID + +In Exchange Server or Exchange Online, you can run the following command to find and compare the MailboxGUID values for the user: `Get-Mailbox -Identity | Format-List *GUID,MailboxLocations`. + +In Exchange Online, you can find the TenantGUID and MailboxGUID values after you run Get-MailboxLocation with the User parameter. + +You can't use this parameter with the User parameter. + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: UserIdParameter +Parameter Sets: User +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePreviousPrimary +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. + +You can only use this switch with the User parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: User +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxLocationType +The MailboxLocationType filters the results by the type of mailbox. Valid values are: + +- Aggregated +- AuxArchive +- AuxPrimary +- ComponentShared +- MainArchive +- PreviousPrimary (Exchange Online only) +- Primary + +```yaml +Type: MailboxLocationType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md new file mode 100644 index 0000000000..fff93d6e2a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md @@ -0,0 +1,210 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxMessageConfiguration cmdlet to view the Outlook on the web settings that are applied to specific mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxMessageConfiguration [-Identity] + [-Credential ] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [-SignatureName ] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +The Get-MailboxMessageConfiguration cmdlet shows Outlook on the web settings for the specified mailbox. These settings are not used in Microsoft Outlook, Microsoft Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. Settings that contain the word Mobile are applied in Microsoft Outlook on the web for devices only. + +> [!NOTE] +> The SignatureHtml and SignatureText parameters don't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Currently, the only way to make these parameters work again is to open a support ticket and ask to have Outlook roaming signatures disabled in your organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxMessageConfiguration tony@contoso.com +``` + +This example returns the Outlook on the web settings for Tony's mailbox. + +### Example 2 +```powershell +Get-MailboxMessageConfiguration tony@contoso.com -DomainController DC1 +``` + +This example returns the Outlook on the web settings for Tony's mailbox and specifies the domain controller that's used to get those settings. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password to use to access the mailbox. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SignatureName +This parameter is available only in the cloud-based service. + +{{ Fill SignatureName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxPermission.md b/exchange/exchange-ps/exchange/Get-MailboxPermission.md new file mode 100644 index 0000000000..80fc4e6f73 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxPermission.md @@ -0,0 +1,383 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxPermission cmdlet to retrieve permissions on a mailbox. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Owner +``` +Get-MailboxPermission [-Identity] [-Owner] + [-Credential ] + [-DomainController ] + [-GroupMailbox] + [-IncludeUserWithDisplayName] + [-ReadFromDomainController] + [-ResultSize ] + [-UseCustomRouting] + [] +``` + +### AccessRights +``` +Get-MailboxPermission [-Identity] [-User ] [-SoftDeletedMailbox] + [-Credential ] + [-DomainController ] + [-GroupMailbox] + [-IncludeSoftDeletedUserPermissions] + [-IncludeUnresolvedPermissions] + [-IncludeUserWithDisplayName] + [-ReadFromDomainController] + [-ResultSize ] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +The output of this cmdlet shows the following information: + +- Identity: The mailbox in question. +- User: The security principal (user, security group, Exchange management role group, etc.) that has permission to the mailbox. +- AccessRights: The permission that the security principal has on the mailbox. The available values are ChangeOwner (change the owner of the mailbox), ChangePermission (change the permissions on the mailbox), DeleteItem (delete the mailbox), ExternalAccount (indicates the account isn't in the same domain), FullAccess (open the mailbox, access its contents, but can't send mail) and ReadPermission (read the permissions on the mailbox). Whether the permissions are allowed or denied is indicated in the Deny column. +- IsInherited: Whether the permission is inherited (True) or directly assigned to the mailbox (False). Permissions are inherited from the mailbox database and/or Active Directory. Typically, directly assigned permissions override inherited permissions. +- Deny: Whether the permission is allowed (False) or denied (True). Typically, deny permissions override allow permissions. + +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. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxPermission -Identity john@contoso.com | Format-List +``` + +This example returns permissions on the mailbox by its SMTP address john@contoso.com. + +### Example 2 +```powershell +Get-MailboxPermission -Identity john@contoso.com -User "Ayla" +``` + +This example returns permissions that the user Ayla has on John's mailbox. + +### Example 3 +```powershell +Get-MailboxPermission -Identity Room222 -Owner +``` + +This example returns the owner information for the resource mailbox Room222. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -GroupMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedUserPermissions +This parameter is available only in the cloud-based service. + +The IncludeSoftDeletedUserPermissions switch returns permissions from soft-deleted mailbox users in the results. You don't need to specify a value with this switch. + +Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUnresolvedPermissions +This parameter is available only in the cloud-based service. + +The IncludeUnresolvedPermissions switch returns unresolved permissions in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUserWithDisplayName +This parameter is available only in the cloud-based service. + +{{ Fill IncludeUserWithDisplayName Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Owner +The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch. + +You can't use this switch with the User parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SoftDeletedMailbox +This parameter is available only in the cloud-based service. + +The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter filters the results by who has permissions to the mailbox that's specified by the Identity parameter. You can specify the following types of users or groups (security principals) for this parameter: + +- Mailbox users +- Mail users +- Security groups + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Owner switch. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxPlan.md b/exchange/exchange-ps/exchange/Get-MailboxPlan.md new file mode 100644 index 0000000000..c1a6bb560a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxPlan.md @@ -0,0 +1,211 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxPlan + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailboxPlan cmdlet to view information about mailbox plans in the cloud-based service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxPlan [[-Identity] ] + [-AllMailboxPlanReleases] + [-Credential ] + [-Filter ] + [-IgnoreDefaultScope] + [-ResultSize ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxPlan +``` + +This example returns a summary list of all mailbox plans in the organization. + +### Example 2 +```powershell +Get-MailboxPlan -Identity ExchangeOnlineEnterprise | Format-List +``` + +This example returns detailed information for the mailbox plan that has the display name ExchangeOnlineEnterprise. + +## PARAMETERS + +### -Identity +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 +- Alias +- Display name +- Distinguished name (DN) +- GUID + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllMailboxPlanReleases +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following attributes: + +- Alias +- DisplayName +- Name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md new file mode 100644 index 0000000000..0915467f52 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md @@ -0,0 +1,227 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxRegionalConfiguration cmdlet to view the regional settings of a mailbox. You can view the date format, time format, time zone, and language of the mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Get-MailboxRegionalConfiguration [-Identity] [-DomainController ] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +### Identity +``` +Get-MailboxRegionalConfiguration [[-Identity] ] [-Archive] [-UseCustomRouting] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +### MailboxLocation +``` +Get-MailboxRegionalConfiguration [-MailboxLocation ] [-UseCustomRouting] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +## DESCRIPTION +To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration) cmdlet. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxRegionalConfiguration -Identity "Marcelo Teixeira" +``` + +This example returns the regional settings for Marcelo Teixeira's mailbox. + +### Example 2 +```powershell +Get-MailboxRegionalConfiguration -Identity "Ella Lack" -DomainController dc01.contoso.com +``` + +In on-premises Exchange, this example returns the regional settings for Ella Lack's mailbox by using the specified domain controller. + +### Example 3 +```powershell +Get-MailboxRegionalConfiguration -Identity "Alice Jakobsen" -VerifyDefaultFolderNameLanguage | Format-List +``` + +This example returns the regional settings for Alice Jakobsen's mailbox and also indicates whether the default folder names of the mailbox are localized in the locale that's specified for the mailbox. The important properties are Language and DefaultFolderNameMatchingUserLanguage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Archive +This parameter is available only in the cloud-based service. + +{{ Fill Archive Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Default +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 +``` + +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VerifyDefaultFolderNameLanguage +The VerifyDefaultFolderNameLanguage switch verifies that the default folder names are localized in the language that's specified for the mailbox (the Language property value). You don't need to specify a value with this switch. + +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: + +- `Get-MailboxRegionalConfiguration -Identity -VerifyDefaultFolderNameLanguage | Format-List` + +Or + +- `Get-MailboxRegionalConfiguration -Identity -VerifyDefaultFolderNameLanguage | Format-Table Language,DefaultFolderNameMatchingUserLanguage` + +If you view the DefaultFolderNameMatchingUserLanguage property without using the VerifyDefaultFolderNameLanguage switch, the value is always $false, even if the default folder names are localized in the language that's specified for the mailbox. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md new file mode 100644 index 0000000000..d247baf12a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md @@ -0,0 +1,239 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxRepairRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MailboxRepairRequest cmdlet to display information about current mailbox repair requests. Mailbox repair requests are created using the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruptions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Database +``` +Get-MailboxRepairRequest [-Database] [[-StoreMailbox] ] + [-DomainController ] + [] +``` + +### Identity +``` +Get-MailboxRepairRequest [-Identity] [-Detailed] + [-DomainController ] + [] +``` + +### Mailbox +``` +Get-MailboxRepairRequest [-Mailbox] [-Archive] + [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-MailboxRepairRequest cmdlet displays information about mailbox repair requests. This information includes: + +- The mailbox GUID. +- The type of corruption that was specified when the mailbox repair request was created. +- The progress of the repair request in percentage of completion. +- The number of corruptions detected and fixed. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxDatabase | Get-MailboxRepairRequest | Format-Table Identity + +Get-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5\374289de-b899-42dc-8391-4f8579935f1f | Format-List +``` + +This example displays the value of the Identity property for all mailbox repair requests for all mailbox servers in your organization; the second command displays information about a specific mailbox repair request that was returned by the first command. + +### Example 2 +```powershell +Get-MailboxRepairRequest -Mailbox "Ann Beebe" | Format-List +``` + +This example displays repair request information for the mailbox of Ann Beebe using the Mailbox parameter. + +### Example 3 +```powershell +$MailboxGuid = Get-MailboxStatistics annb + +Get-MailboxRepairRequest -Database $MailboxGuid.Database -StoreMailbox $MailboxGuid.MailboxGuid | Format-List Identity +``` + +This example uses the Database and StoreMailbox parameters to display the Identity property of the repair request for the mailbox of Ann Beebe. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. + +You can't use this parameter with the Database or Mailbox parameters. + +```yaml +Type: StoreIntegrityCheckJobIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Database +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 +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity or Mailbox parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Database or Identity parameters. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StoreMailbox +The StoreMailbox parameter specifies the mailbox GUID of the mailbox that you want to get mailbox repair request information about. Use this parameter with the Database parameter. + +Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Archive +The Archive switch displays information about the associated archive mailbox if the archive mailbox was included when the mailbox repair request was created. You don't need to specify a value with this switch. + +If you don't use this switch, only information about the primary mailbox is returned. + +You can't use this switch with the Database parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: Mailbox +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 +``` + +### -Detailed +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 +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 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/mailboxes/Get-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md similarity index 78% rename from exchange/exchange-ps/exchange/mailboxes/Get-MailboxRestoreRequest.md rename to exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md index 834b1b7763..307c4af120 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxRestoreRequest @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,44 +24,54 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-MailboxRestoreRequest [[-Identity] ] [-DomainController ] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ### Filtering ``` -Get-MailboxRestoreRequest [-BatchName ] [-HighPriority <$true | $false>] [-Name ] [-RequestQueue ] [-SourceDatabase ] [-Status ] [-Suspend <$true | $false>] [-TargetDatabase ] [-TargetMailbox ] +Get-MailboxRestoreRequest [-BatchName ] + [-HighPriority ] + [-Name ] + [-RequestQueue ] + [-SourceDatabase ] + [-Status ] + [-Suspend ] + [-TargetDatabase ] + [-TargetMailbox ] [-DomainController ] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxRestoreRequest -Identity "ayla\MailboxRestore" +### Example 1 +```powershell +Get-MailboxRestoreRequest -Identity "Ayla\MailboxRestore" ``` -This example returns the status of the in-progress and queued restore request with the identity ayla\\MailboxRestore. +This example returns the status of the in-progress and queued restore request with the identity ayla\\MailboxRestore, where Ayla is the first name of the user. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxRestoreRequest -TargetDatabase MBD01 ``` In Exchange Server 2010, this example returns the status of in progress and queued restore requests that are being restored to the target database MBD01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxRestoreRequest -RequestQueue MBD01 ``` This example returns the status of in-progress and queued restore requests that are being restored to the mailbox database MBD01. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MailboxRestoreRequest -Name "RestoreToMBD01" -Suspend $true ``` @@ -67,7 +80,7 @@ This example returns all restore requests that have the name RestoreToMBD01 wher ## PARAMETERS ### -Identity -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: \\\\. +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). @@ -78,6 +91,7 @@ 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 Default value: None @@ -95,6 +109,7 @@ 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 Default value: None @@ -112,6 +127,7 @@ 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 @@ -123,16 +139,16 @@ Accept wildcard characters: False 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. - - $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +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 Default value: None @@ -154,6 +170,7 @@ 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 Default value: None @@ -166,9 +183,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -177,6 +194,7 @@ Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -192,6 +210,7 @@ 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 Default value: None @@ -202,11 +221,11 @@ Accept wildcard characters: False ### -SourceDatabase 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 the following values: - -- GUID of the database +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: -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -215,6 +234,7 @@ Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -226,32 +246,24 @@ Accept wildcard characters: False The Status parameter filters the results based on status. You can use the following values: - AutoSuspended - - Completed - - CompletedWithWarning - - CompletionInProgress - - Failed - - InProgress - - Queued - - Retrying - - Suspended - - Synced You can't use this parameter with the Identity parameter. ```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Completed | CompletedWithWarning | Suspended | Failed +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 Default value: None @@ -265,10 +277,11 @@ The Suspend parameter specifies whether to return requests that have been suspen You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +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 Default value: None @@ -277,21 +290,22 @@ Accept wildcard characters: False ``` ### -TargetDatabase -This parameter is available or functional 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 the following values: +This parameter is available only in Exchange Server 2010. -- GUID of the database +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: -- Database name +- Name +- Distinguished name (DN) +- GUID -You can't use this parameter in conjunction with the Identity parameter. +You can't use this parameter with the Identity parameter. ```yaml Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -303,17 +317,11 @@ Accept wildcard characters: False The TargetMailbox parameter specifies the identity of the target mailbox. You can use the following values: - GUID - - Distinguished name (DN) - - Domain\\Account - - User principal name (UPN) - - Legacy Exchange DN - - SMTP address - - Alias You can't use this parameter with the Identity parameter. @@ -323,6 +331,7 @@ 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 Default value: None @@ -331,20 +340,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6e2a5296-7820-4266-a96f-609588390a18.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md similarity index 81% rename from exchange/exchange-ps/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md rename to exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md index 152d48ea54..08a0693b85 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MailboxRestoreRequestStatistics @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxRestoreRequestStatistics cmdlet to view detailed information about restore requests. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,6 +35,7 @@ Get-MailboxRestoreRequestStatistics [-Identity] [-IncludeReport] + [-IncludeSkippedItems] [-DiagnosticInfo ] [-ReportOnly] [] @@ -58,40 +62,40 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxRestoreRequestStatistics -Identity "Tony\MailboxRestore1" ``` This example returns the default statistics for the restore request with the identity Tony\\MailboxRestore1. The type of information returned by default includes name, mailbox, status and percent complete. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxRestoreRequestStatistics -Identity Tony\MailboxRestore | Export-CSV \\SERVER01\RestoreRequest_Reports\Tony_Restorestats.csv ``` This example returns the statistics for Tony Smith's mailbox and exports the report to a CSV file. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxRestoreRequestStatistics -Identity Tony\MailboxRestore -IncludeReport | Format-List ``` This example returns additional information about the restore request for Tony Smith's mailbox by using the IncludeReport parameter and by pipelining the results to the Format-List command. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MailboxRestoreRequestStatistics -MRSInstance CAS01.contoso.com ``` In Exchange Server 2010 and 2013, this example returns default statistics for a restore request being processed by the instance of MRS running on the server CAS01. This command only returns information for restore requests currently being processed by an instance of MRS. If the Client Access server is finished processing all restore requests, no information is returned. This command is for debugging purposes only and should only be performed if requested by support personnel. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Get-MailboxRestoreRequest -Status Failed | Get-MailboxRestoreRequestStatistics -IncludeReport | Format-List > C:\Reports\AllRestoreReports.txt ``` @@ -100,17 +104,18 @@ This example returns additional information for all the restore requests that ha ## PARAMETERS ### -Identity -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: \\\\. +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). -This parameter can't be used in conjunction with the MRSInstance or RequestQueue parameters. +You can't use this parameter with the MRSInstance or RequestQueue parameters. ```yaml 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 Default value: None @@ -119,17 +124,18 @@ Accept wildcard characters: False ``` ### -MRSInstance -This parameter is available or functional only in 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. -This parameter can't be used in conjunction with the Identity or RequestQueue parameters. +You can't use this parameter with the Identity or RequestQueue parameters. ```yaml Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -144,9 +150,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -155,6 +161,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -163,13 +170,14 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -187,6 +195,7 @@ Type: Guid Parameter Sets: MigrationMRSInstance, MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -197,13 +206,16 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -221,6 +233,7 @@ Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -238,6 +251,7 @@ Type: String Parameter Sets: IdentityCloud Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -255,6 +269,25 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -270,6 +303,7 @@ Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -278,20 +312,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b28d5835-1f8f-4cd9-8f72-9d592adef3d9.aspx) diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/exchange/Get-MailboxSearch.md new file mode 100644 index 0000000000..3051b480ef --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxSearch.md @@ -0,0 +1,206 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete or stopped. + +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### SearchObjectIdentity +``` +Get-MailboxSearch [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [] +``` + +### EwsStoreObjectIdentity +``` +Get-MailboxSearch [[-Identity] ] + [-ShowDeletionInProgressSearches] + [-DomainController ] + [-ResultSize ] + [] +``` + +### InPlaceHoldIdentity +``` +Get-MailboxSearch -InPlaceHoldIdentity + [-ShowDeletionInProgressSearches] + [-DomainController ] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxSearch -ResultSize "unlimited" +``` + +This example retrieves a list of all mailbox searches. + +### Example 2 +```powershell +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). + +### Example 3 +```powershell +(Get-Mailbox Mark).InPlaceHolds + +Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb +``` + +This example retrieves the In-Place Holds that a user is placed on. The first command outputs GUIDs of In-Place Holds. The last command retrieves a mailbox search based on the GUID of the In-Place Hold that the user is placed on. + +## PARAMETERS + +### -Identity +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: + +- SourceMailboxes +- Sources +- SearchQuery +- ResultsLink +- PreviewResultsLink +- Errors + +To view these properties, you have to provide the name of a mailbox search. + +```yaml +Type: SearchObjectIdParameter +Parameter Sets: EwsStoreObjectIdentity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +```yaml +Type: SearchObjectIdParameter +Parameter Sets: SearchObjectIdentity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -InPlaceHoldIdentity +The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet. + +```yaml +Type: String +Parameter Sets: InPlaceHoldIdentity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowDeletionInProgressSearches +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md new file mode 100644 index 0000000000..0db5f4e4f3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md @@ -0,0 +1,97 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxSentItemsConfiguration + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-MailboxSentItemsConfiguration cmdlet to view the Sent Items settings on mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxSentItemsConfiguration [-DomainController ] + [-Identity ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxSentItemsConfiguration -Identity "Customer Support Feedback" +``` + +This example returns the Sent Items configuration for the shared mailbox named "Customer Support Feedback". + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxServer.md b/exchange/exchange-ps/exchange/Get-MailboxServer.md new file mode 100644 index 0000000000..7b2886ee8a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxServer.md @@ -0,0 +1,122 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MailboxServer cmdlet to view information about Mailbox servers in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxServer [[-Identity] ] + [-DomainController ] + [-Status] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxServer +``` + +This example returns a summary list of all the Mailbox servers in the organization. + +### Example 2 +```powershell +Get-MailboxServer -Identity Server1 | Format-List +``` + +This example returns detailed information about the Mailbox server named Server1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Mailbox server that you want to view. You can use any value that uniquely identifies the Mailbox server. For example: + +- Name +- GUID +- Distinguished name (DN) + +```yaml +Type: MailboxServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +``` + +### -Status +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md new file mode 100644 index 0000000000..711e199b87 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md @@ -0,0 +1,124 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxSpellingConfiguration cmdlet to retrieve the Outlook on the web spelling checker settings of a specified user. For example, users can set their dictionary language and configure the spelling checker to ignore mixed digits and words in all uppercase. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxSpellingConfiguration [-Identity] + [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-MailboxSpellingConfiguration cmdlet is primarily used to populate the spelling checker settings for end users in Outlook on the web. Administrators can also view users' settings by running this cmdlet. The following spelling checker settings are retrieved by the cmdlet for the specified mailbox: + +- Identity: This setting specifies the mailbox identity. +- CheckBeforeSend: This setting specifies whether Outlook on the web checks the spelling of every message when the user clicks Send in the new message form. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxSpellingConfiguration -Identity Tony +``` + +This example retrieves the Outlook on the web options of user Tony. + +### Example 2 +```powershell +Get-MailboxSpellingConfiguration -Identity Tony -DomainController DC1 +``` + +This example returns the Outlook on the web spelling checker options for Tony's mailbox by specifying domain controller DC1 to get the information from Active Directory. + +### Example 3 +```powershell +Get-MailboxSpellingConfiguration -Identity contoso\tony +``` + +This example returns the Outlook on the web spelling checker options for Tony's mailbox by specifying the identity of the mailbox in the format domain\\account. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md new file mode 100644 index 0000000000..364729d637 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md @@ -0,0 +1,484 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. In addition, you can get the move history or a move report of a completed move request. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Database +``` +Get-MailboxStatistics -Database [[-StoreMailboxIdentity] ] + [-CopyOnServer ] + [-DomainController ] + [-Filter ] + [-IncludeMoveHistory] + [-IncludeMoveReport] + [-IncludeQuarantineDetails] + [-NoADLookup] + [] +``` + +### Identity +``` +Get-MailboxStatistics [-Identity] + [-Archive] + [-CopyOnServer ] + [-DomainController ] + [-IncludeMoveHistory] + [-IncludeMoveReport] + [-IncludeQuarantineDetails] + [-IncludeSoftDeletedRecipients] + [-NoADLookup] + [-UseCustomRouting] + [] +``` + +### Server +``` +Get-MailboxStatistics -Server + [-DomainController ] + [-Filter ] + [-IncludeMoveHistory] + [-IncludeMoveReport] + [-IncludePassive] + [-IncludeQuarantineDetails] + [-NoADLookup] + [] +``` + +## DESCRIPTION +On Mailbox servers only, you can use the Get-MailboxStatistics cmdlet without parameters. In this case, the cmdlet returns the statistics for all mailboxes on all databases on the local server. + +The Get-MailboxStatistics cmdlet requires at least one of the following parameters to complete successfully: Server, Database or Identity. + +You can use the Get-MailboxStatistics cmdlet to return detailed move history and a move report for completed move requests to troubleshoot a move request. To view the move history, you must pass this cmdlet as an object. Move histories are retained in the mailbox database and are numbered incrementally and the last executed move request is always numbered 0. For more information, see "Example 7," "Example 8," and "Example 9" in this topic. + +You can only see move reports and move history for completed move requests. + +**Note**: We're deprecating the LastUserActionTime property in Exchange Online PowerShell. Don't use the value of that property as the last active time for a mailbox. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxStatistics -Identity AylaKol +``` + +This example retrieves the mailbox statistics for the mailbox of the user Ayla Kol by using its associated alias AylaKol. + +### Example 2 +```powershell +Get-MailboxStatistics -Server MailboxServer01 +``` + +This example retrieves the mailbox statistics for all mailboxes on the server MailboxServer01. + +### Example 3 +```powershell +Get-MailboxStatistics -Identity contoso\chris +``` + +This example retrieves the mailbox statistics for the specified mailbox. + +### Example 4 +```powershell +Get-MailboxStatistics -Database "Mailbox Database" +``` + +This example retrieves the mailbox statistics for all mailboxes in the specified mailbox database. + +### Example 5 +```powershell +Get-MailboxDatabase | Get-MailboxStatistics -Filter 'DisconnectDate -ne $null' +``` + +This example retrieves the mailbox statistics for the disconnected mailboxes for all mailbox databases in the organization. The -ne operator means not equal. + +### Example 6 +```powershell +Get-MailboxStatistics -Database "Mailbox Database" -StoreMailboxIdentity 3b475034-303d-49b2-9403-ae022b43742d +``` + +This example retrieves the mailbox statistics for a single disconnected mailbox. The value for the StoreMailboxIdentity parameter is the mailbox GUID of the disconnected mailbox. You can also use the LegacyDN. + +### Example 7 +```powershell +Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory | Format-List +``` + +This example returns the summary move history for the completed move request for Ayla Kol's mailbox. If you don't pipeline the output to the Format-List cmdlet, the move history doesn't display. + +### Example 8 +```powershell +$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]. + +### Example 9 +```powershell +$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveReport + +$temp.MoveHistory[0] | Export-CSV C:\MoveReport_AylaKol.csv +``` + +This example returns the detailed move history and a verbose detailed move report for Ayla Kol's mailbox. This example uses a temporary variable to store the move request statistics object and outputs the move report to a CSV file. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StoreMailboxIdentity +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: + +- MailboxGuid +- LegacyDN + +Use this syntax to retrieve information about disconnected mailboxes, which don't have a corresponding Active Directory object or that has a corresponding Active Directory object that doesn't point to the disconnected mailbox in the mailbox database. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyOnServer +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. + +You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: Database, Identity +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 +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +This parameter accepts pipeline input from the Get-MailboxDatabase cmdlet. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +This parameter is available only in on-premises Exchange. + +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +For example, to display all disconnected mailboxes on a specific mailbox database, use the following syntax: `'DisconnectDate -ne $null'`. + +```yaml +Type: String +Parameter Sets: Database, Server +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 +``` + +### -IncludeMoveHistory +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMoveReport +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePassive +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. + +If you don't use this switch, the command retrieves statistics from active database copies only. + +```yaml +Type: SwitchParameter +Parameter Sets: Server +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 +``` + +### -IncludeSoftDeletedRecipients +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. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeQuarantineDetails +This parameter is available only in on-premises Exchange. + +The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. You don't need to specify a value with this switch. + +Specifically, this switch returns the values of the QuarantineDescription, QuarantineLastCrash and QuarantineEnd properties on the mailbox. To see these values, you need use a formatting cmdlet. For example, `Get-MailboxStatistics -IncludeQuarantineDetails | Format-List Quarantine*`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoADLookup +This parameter is available only in on-premises Exchange. + +The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. You don't need to specify a value with this switch. + +This switch helps improve cmdlet performance when querying a mailbox database that contains a large number of mailboxes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +When you specify a value for the Server parameter, the command returns statistics for all the mailboxes on all the databases, including recovery databases, on the specified server. If you don't specify this parameter, the command returns logon statistics for the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md b/exchange/exchange-ps/exchange/Get-MailboxTransportService.md new file mode 100644 index 0000000000..4e4beb49a3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxTransportService.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxTransportService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MailboxTransportService cmdlet to view the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxTransportService [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxTransportService +``` + +This example displays a list of all Mailbox servers in your organization. + +### Example 2 +```powershell +Get-MailboxTransportService Mailbox01 | Format-List +``` + +This example retrieves the detailed transport configuration information for the Mailbox Transport service on the Mailbox server named Mailbox01. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md new file mode 100644 index 0000000000..6487e6dc0e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md @@ -0,0 +1,157 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MailboxUserConfiguration cmdlet to view user configuration items in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxUserConfiguration [-Identity] -Mailbox + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxUserConfiguration -Mailbox laura@contoso.com -Identity Configuration\* | Format-Table -Auto Identity +``` + +This example returns a summary list of all user configuration items in the Configuration folder in the mailbox laura@contoso.com. + +### Example 2 +```powershell +Get-MailboxUserConfiguration -Mailbox julia@contoso.com -Identity Configuration\IPM.Configuration.Aggregated.OwaUserConfiguration +``` + +This example returns detailed information for the specified user configuration item in the mailbox julia@contoso.com. + +## PARAMETERS + +### -Identity +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. +- Valid values for ItemName start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. + +```yaml +Type: MailboxUserConfigurationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-MailflowStatusReport.md b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md new file mode 100644 index 0000000000..fef6949dce --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md @@ -0,0 +1,213 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailFlowStatusReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailFlowStatusReport cmdlet to return the message counts for a specific date range organized by the final disposition of the message for the last 90 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailFlowStatusReport + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [] +``` + +## DESCRIPTION +This cmdlet returns the following information: + +- Date +- Direction +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailFlowStatusReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Direction Inbound,Outbound -EventType GoodMail,EdgeBlockSpam +``` + +This example returns inbound and outbound messages were classified as GoodMail or EdgeBlockSpam in the specified date range. + +## PARAMETERS + +### -Direction +The Direction parameter filters the results by the direction of the message. Valid values are: + +- Inbound +- IntraOrg +- Outbound + +You can specify multiple value separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- EdgeBlockSpam +- EmailMalware +- EmailPhish +- GoodMail +- SpamDetections +- TransportRules + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md new file mode 100644 index 0000000000..077860de6f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MalwareFilterPolicy cmdlet to view the malware filter policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MalwareFilterPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MalwareFilterPolicy +``` + +This example retrieves a summary list of all malware filter policies in your organization. + +### Example 2 +```powershell +Get-MalwareFilterPolicy Default | Format-List +``` + +This example retrieves detailed configuration information for the malware filter policy named Default. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the malware filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. + +```yaml +Type: MalwareFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md new file mode 100644 index 0000000000..d8b421d6ef --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md @@ -0,0 +1,116 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Enable-MalwareFilterRule cmdlet to view malware filter rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MalwareFilterRule [[-Identity] ] + [-DomainController ] + [-State ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MalwareFilterRule +``` + +This example retrieves a summary list of all malware filter rules in your organization. + +### Example 2 +```powershell +Get-MalwareFilterRule "Contoso Recipients" | Format-List +``` + +This example retrieves detailed configuration information for the malware filter rule named Contoso Recipients. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md new file mode 100644 index 0000000000..11a67a8298 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md @@ -0,0 +1,104 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MalwareFilteringServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MalwareFilteringServer cmdlet to view the Malware agent settings in the Transport service on a Mailbox server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MalwareFilteringServer [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MalwareFilteringServer +``` + +This example displays a summary of the Exchange Malware agent settings on all Mailbox servers in your organization. + +### Example 2 +```powershell +Get-MalwareFilteringServer Mailbox01 | Format-List +``` + +This example returns the detailed Exchange Malware agent settings on a Mailbox server named Mailbox01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: MalwareFilteringServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md new file mode 100644 index 0000000000..543f807e2a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ManagedContentSettings + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-ManagedContentSettings cmdlet to retrieve managed content settings associated with managed folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### FolderName +``` +Get-ManagedContentSettings [-FolderName ] + [-DomainController ] + [] +``` + +### Identity +``` +Get-ManagedContentSettings [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-ManagedContentSettings cmdlet retrieves from one to all of the managed content settings. You can also retrieve only the managed content settings associated with a specified managed folder. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ManagedContentSettings | Format-List +``` + +This example uses the Get-ManagedContentSettings cmdlet without parameters to obtain all managed content settings. The output of the Get-ManagedContentSettings cmdlet is piped to the Format-List cmdlet so that all the available information is displayed in the result. + +### Example 2 +```powershell +Get-ManagedContentSettings -Identity "Inbox Settings" +``` + +This example retrieves the managed content settings Inbox Settings. + +### Example 3 +```powershell +Get-ManagedContentSettings -FolderName "Inbox" +``` + +This example retrieves the managed content settings for the managed folder Inbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name, distinguished name (DN), or GUID of the set of managed content settings. When used, this command retrieves the folder content settings and all associated attributes. + +This parameter can't be used with the FolderName parameter. + +```yaml +Type: ELCContentSettingsIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderName +The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. When used, this command retrieves all the policies that apply to that folder. + +This parameter can't be used with the Identity parameter. + +```yaml +Type: ELCFolderIdParameter +Parameter Sets: FolderName +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolder.md b/exchange/exchange-ps/exchange/Get-ManagedFolder.md new file mode 100644 index 0000000000..f7a6302c2b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ManagedFolder.md @@ -0,0 +1,135 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ManagedFolder + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-ManagedFolder cmdlet to retrieve the attributes of one or more managed folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-ManagedFolder [[-Identity] ] + [-DomainController ] + [] +``` + +### Mailbox +``` +Get-ManagedFolder [-Mailbox ] + [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-ManagedFolder cmdlet retrieves the specified managed folder attributes: + +- If only an Identity parameter value is present, the command retrieves the specified folder and all associated attributes. +- If a Mailbox parameter value is present, the command retrieves all managed folders that apply to that user by means of a managed folder mailbox policy applied by an administrator. Managed folders that users add by means of an organization's managed folder opt-in Web site aren't displayed by this command. +- If no parameter values are specified, the command retrieves all the folder objects and their associated 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ManagedFolder MyManagedFolder | Format-List +``` + +This example retrieves information about the managed folder MyManagedFolder. The output of the Get-ManagedFolder cmdlet is piped to the Format-List cmdlet so that all the available information is displayed in the result. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +This cmdlet retrieves all the folders that apply to the specified mailbox. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md new file mode 100644 index 0000000000..773b53f264 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md @@ -0,0 +1,94 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ManagedFolderMailboxPolicy + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-ManagedFolderMailboxPolicy cmdlet to return all attributes of one or more managed folder mailbox policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ManagedFolderMailboxPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +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). + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ManagementRole.md b/exchange/exchange-ps/exchange/Get-ManagementRole.md new file mode 100644 index 0000000000..72a4c467e8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ManagementRole.md @@ -0,0 +1,296 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ManagementRole cmdlet to view management roles that have been created in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### GetChildren +``` +Get-ManagementRole [-Identity] + [-GetChildren] + [-DomainController ] + [-RoleType ] + [] +``` + +### Recurse +``` +Get-ManagementRole [-Identity] + [-Recurse] + [-DomainController ] + [-RoleType ] + [] +``` + +### Identity +``` +Get-ManagementRole [[-Identity] ] + [-Cmdlet ] + [-CmdletParameters ] + [-DomainController ] + [-RoleType ] + [] +``` + +### Script +``` +Get-ManagementRole [[-Identity] ] + [-Script ] + [-ScriptParameters ] + [-DomainController ] + [-RoleType ] + [] +``` + +## DESCRIPTION +You can view management roles in several ways, from listing all the roles in your organization to listing only the child roles of a specified parent role. You can also view the details of a specific role by piping the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. + +For more information about management roles, see [Understanding management roles](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ManagementRole +``` + +This example lists all the roles that have been created in your organization. + +### Example 2 +```powershell +Get-ManagementRole "Mail Recipients" -Recurse +``` + +This example lists all the roles that are children of the Mail Recipients management role. The command performs a recursive query of all the child roles of the specified parent role. This recursive query finds every child role from the immediate children of the parent to the last child role in the hierarchy. In a recursive list, the parent role is also returned in the list. + +### Example 3 +```powershell +Get-ManagementRole -CmdletParameters Identity, Database +``` + +This example lists all the roles that contain both the Identity and Database parameters. Roles that contain only one parameter or the other aren't returned. + +### Example 4 +```powershell +Get-ManagementRole -RoleType UnScopedTopLevel +``` + +This example lists all the roles that have a type of UnScopedTopLevel. These roles contain custom scripts or non-Exchange cmdlets. + +### Example 5 +```powershell +Get-ManagementRole "Transport Rules" | Format-List Name, RoleType +``` + +This example retrieves only the Transport Rules role and passes the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. The Format-List cmdlet then shows only the Name and RoleType properties of the Transport Rules role. For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +### Example 6 +```powershell +Get-ManagementRole "Mail Recipients" -GetChildren +``` + +This example lists the immediate children of the Mail Recipients role. Only the child roles that hold the Mail Recipients role as their parent role are returned. The Mail Recipients role isn't returned in the list. + +## PARAMETERS + +### -Identity +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 +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -GetChildren +The GetChildren parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. + +Only the immediate child roles of the parent role are included in the results. + +You can use this switch only with the Identity and RoleType parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: GetChildren +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +The Recurse parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. + +The role specified in the Identity parameter, its child roles, and their children are returned. + +You can use this switch only with the Identity and RoleType parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: Recurse +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cmdlet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CmdletParameters +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleType +The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see [Understanding management roles](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Script +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptParameters +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/role-based-access-control/Get-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md similarity index 81% rename from exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRoleAssignment.md rename to exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md index 4b34dfd97e..574baae033 100644 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-ManagementRoleAssignment @@ -13,27 +16,28 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ManagementRoleAssignment cmdlet to retrieve management role assignments. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` Get-ManagementRoleAssignment [[-Identity] ] - [-ConfigWriteScope ] + [-ConfigWriteScope ] [-CustomConfigWriteScope ] [-CustomRecipientWriteScope ] - [-Delegating <$true | $false>] + [-Delegating ] [-DomainController ] - [-Enabled <$true | $false>] - [-Exclusive <$true | $false>] + [-Enabled ] + [-Exclusive ] [-ExclusiveConfigWriteScope ] [-ExclusiveRecipientWriteScope ] [-GetEffectiveUsers] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] - [-RecipientWriteScope ] - [-RoleAssigneeType ] + [-RecipientWriteScope ] + [-RoleAssigneeType ] [-WritableDatabase ] [-WritableRecipient ] [-WritableServer ] @@ -42,22 +46,24 @@ Get-ManagementRoleAssignment [[-Identity] ] ### RoleAssignee ``` -Get-ManagementRoleAssignment [-AssignmentMethod ] [-Role ] - [-ConfigWriteScope ] +Get-ManagementRoleAssignment [-AssignmentMethod ] + [-Role ] + [-ConfigWriteScope ] [-CustomConfigWriteScope ] [-CustomRecipientWriteScope ] - [-Delegating <$true | $false>] + [-Delegating ] [-DomainController ] - [-Enabled <$true | $false>] - [-Exclusive <$true | $false>] + [-Enabled ] + [-Exclusive ] [-ExclusiveConfigWriteScope ] [-ExclusiveRecipientWriteScope ] [-GetEffectiveUsers] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] - [-RecipientWriteScope ] + [-RecipientWriteScope ] [-RoleAssignee ] - [-RoleAssigneeType ] + [-RoleAssigneeType ] [-WritableDatabase ] [-WritableRecipient ] [-WritableServer ] @@ -67,56 +73,56 @@ Get-ManagementRoleAssignment [-AssignmentMethod ] [-Role + [-DomainController ] + [-Parameters ] + [-PSSnapinName ] + [-ResultSize ] + [-Type ] + [] +``` + +## DESCRIPTION +The Get-ManagementRoleEntry cmdlet retrieves role entries that have been configured on roles. You can retrieve specific role entries that match specific criteria such as role name, cmdlet name, parameter name, or a combination of each, or role entry type or the associated Windows PowerShell snap-in. + +For more information about management role entries, see [Understanding management roles](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ManagementRoleEntry "Transport Rules\*" +``` + +This example retrieves a list of all the role entries that exist on the Transport Rules management role. + +### Example 2 +```powershell +Get-ManagementRoleEntry *\Get-Recipient +``` + +This example retrieves a list of all the role entries that contain the Get-Recipient cmdlet. + +### Example 3 +```powershell +Get-ManagementRoleEntry "Tier 2 Help Desk\Set-Mailbox" | Format-List Name, Parameters, Role, Type +``` + +This example retrieves the Tier 2 Help Desk\\Set-Mailbox role entry and pipes the output of the Get-ManagementRoleEntry cmdlet to the Format-List cmdlet. The Format-List cmdlet then outputs only the Name, Parameters, Role and Type properties from the role entry. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the role entry that you want to view. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). + +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). + +You can use the wildcard character (\*) instead of the role, cmdlet name or both. + +If the role entry name contains spaces, enclose the name in quotation marks ("). + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSSnapinName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Type parameter specifies the type of role entry to return. The valid values for the Type parameter are any combination of the following parameters, separated by commas: Cmdlet, Script and ApplicationPermission. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ManagementScope.md b/exchange/exchange-ps/exchange/Get-ManagementScope.md new file mode 100644 index 0000000000..38673e7eda --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ManagementScope.md @@ -0,0 +1,151 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ManagementScope cmdlet to return a list of management scopes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ManagementScope [[-Identity] ] + [-DomainController ] + [-Exclusive ] + [-Orphan] + [] +``` + +## DESCRIPTION +You can retrieve one scope or many, retrieve only scopes that aren't associated with management role assignments, or retrieve scopes that are exclusive or regular scopes. + +For more information about regular and exclusive scopes, see [Understanding management role scopes](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ManagementScope Redmond* +``` + +This example retrieves all the management scopes that start with the string Redmond. + +### Example 2 +```powershell +Get-ManagementScope "Redmond Servers Scope" | Format-List +``` + +This example retrieves the Redmond Servers Scope using the Get-ManagementScope cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +### Example 3 +```powershell +Get-ManagementScope -Orphan +``` + +This example retrieves a list of management scopes that aren't associated with any role assignments. + +### Example 4 +```powershell +Get-ManagementScope -Exclusive $True +``` + +This example retrieves a list of exclusive scopes. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the management scope to return. If the management scope name contains spaces, enclose it in quotation marks ("). + +```yaml +Type: ManagementScopeIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Exclusive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orphan +The Orphan switch specifies whether to return only management scopes that aren't associated with role assignments. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md new file mode 100644 index 0000000000..77a025f2c7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md @@ -0,0 +1,191 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MapiVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MapiVirtualDirectory cmdlet to view Message Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-MapiVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-MapiVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MapiVirtualDirectory -Server ContosoMail +``` + +This example returns a summary list of the MAPI virtual directories on the server named ContosoMail. + +### Example 2 +```powershell +Get-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" | Format-List + +Get-MapiVirtualDirectory "ContosoMail\mapi (Default Web Site)" | Format-List + +Get-MapiVirtualDirectory ContosoMai\mapi* | Format-List +``` + +These examples return detailed information for the MAPI virtual directory named "mapi (Default Web Site)" on the server named ContosoMail. All three commands do the same thing. + +### Example 3 +```powershell +Get-MapiVirtualDirectory +``` + +This example returns a summary list of all MAPI virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowMailboxVirtualDirectories +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. + +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Message.md b/exchange/exchange-ps/exchange/Get-Message.md new file mode 100644 index 0000000000..634425d077 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Message.md @@ -0,0 +1,353 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-Message + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-Message cmdlet to view the details of one or more messages in queues on Mailbox servers or Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Get-Message [-Filter ] + [-BookmarkIndex ] + [-BookmarkObject ] + [-IncludeBookmark ] + [-IncludeComponentLatencyInfo] + [-IncludeRecipientInfo] + [-ResultSize ] + [-ReturnPageInfo ] + [-SearchForward ] + [-Server ] + [-SortOrder ] + [] +``` + +### Identity +``` +Get-Message [[-Identity] ] + [-BookmarkIndex ] + [-BookmarkObject ] + [-IncludeBookmark ] + [-IncludeComponentLatencyInfo] + [-IncludeRecipientInfo] + [-ResultSize ] + [-ReturnPageInfo ] + [-SearchForward ] + [-SortOrder ] + [] +``` + +### Queue +``` +Get-Message [-Queue ] + [-BookmarkIndex ] + [-BookmarkObject ] + [-IncludeBookmark ] + [-IncludeComponentLatencyInfo] + [-IncludeRecipientInfo] + [-ResultSize ] + [-ReturnPageInfo ] + [-SearchForward ] + [-SortOrder ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Message -Filter "FromAddress -like '*@contoso.com'" | Format-List +``` + +This example displays detailed information about all messages queued on the local server and received from any sender at the contoso.com domain. + +### Example 2 +```powershell +Get-Message -Filter "FromAddress -like '*@contoso.com' -and SCL -gt 3" +``` + +This example lists all messages queued on the local server, received from any sender at the contoso.com domain and that have an SCL value greater than 3. + +### Example 3 +```powershell +Get-Message -Server Server01.contoso.com -SortOrder: +FromAddress,-Size +``` + +This example displays all messages queued on the server named Server01. The results are sorted first in ascending order by sender address and then in descending order of size. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookmarkIndex +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookmarkObject +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +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 +``` + +### -IncludeBookmark +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeComponentLatencyInfo +The IncludeComponentLatencyInfo switch specifies whether the information about component latency is included in the message properties. You don't need to specify a value with this switch. + +If you include this switch, the message objects returned will include latency measurements for each Transport component that has contributed to the local server latency for each queued message. + +```yaml +Type: SwitchParameter +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 +``` + +### -IncludeRecipientInfo +The IncludeRecipientInfo switch specifies whether to display the message recipients in the Recipients field. You don't need to specify a value with this switch. + +If you don't include the IncludeRecipientInfo switch, the Recipients field is blank. + +Storing the results of a `Get-Message -IncludeRecipientInfo` command in a variable allows you to display additional properties for the message recipients. The following list describes the available recipient properties: + +- 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. +- FinalDestination: The distinguished name (DN) of the object used to route the message. +- Status: The recipient status may be Complete, Ready or Retry. +- LastError: The SMTP response after the last delivery attempt or a localized error message if the message is placed in the unreachable queue. + +For example, to store the recipient information of a message in the contoso.com remote delivery queue that has the MessageIdentity value of 1234 to a variable named $x, use the following command: `$x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo`. + +To display the extended recipient properties that are now stored in the $x variable, use the following command: `$x.Recipients`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Queue +The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax `\` or ``, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in [Find queues and messages in queues in the Exchange Management Shell](https://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. + +```yaml +Type: QueueIdentity +Parameter Sets: Queue +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 +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ReturnPageInfo +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchForward +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -SortOrder +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. + +```yaml +Type: QueueViewerSortOrderEntry[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageCategory.md b/exchange/exchange-ps/exchange/Get-MessageCategory.md new file mode 100644 index 0000000000..6cebfc35f4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageCategory.md @@ -0,0 +1,122 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MessageCategory cmdlet to retrieve a message category from the specified mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageCategory [[-Identity] ] + [-DomainController ] + [-Mailbox ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageCategory -Mailbox "User1" +``` + +This example retrieves message categories from the mailbox User1. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageClassification.md b/exchange/exchange-ps/exchange/Get-MessageClassification.md new file mode 100644 index 0000000000..bfb6750a16 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageClassification.md @@ -0,0 +1,115 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MessageClassification cmdlet to view existing message classifications in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageClassification [[-Identity] ] + [-DomainController ] + [-IncludeLocales] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MessageClassification +``` + +This example lists all message classifications in your organization. + +## PARAMETERS + +### -Identity +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 +- Identity: `Default\` or `\`; for example, "Default\My Message Classification" or "es-ES\My Message Classification". +- ClassificationID (GUID) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```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 +``` + +### -IncludeLocales +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTrace.md b/exchange/exchange-ps/exchange/Get-MessageTrace.md new file mode 100644 index 0000000000..fa030fd3a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTrace.md @@ -0,0 +1,295 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTrace + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2) cmdlet and will eventually be deprecated. + +Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageTrace + [-EndDate ] + [-FromIP ] + [-MessageId ] + [-MessageTraceId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-RecipientAddress ] + [-SenderAddress ] + [-StartDate ] + [-Status ] + [-ToIP ] + [] +``` + +## 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. + +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. + +The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTrace -SenderAddress john@contoso.com -StartDate 06/13/2018 -EndDate 06/15/2018 +``` + +This example retrieves message trace information for messages sent by john@contoso.com between June 13, 2018 and June 15, 2018. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -FromIP +The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceDetail + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Status +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. +- GettingStatus: The message is waiting for status update. +- Failed: Message delivery was attempted and it failed or the message was filtered as spam or malware, or by transport rules. +- Pending: Message delivery is underway or was deferred and is being retried. +- 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. +- Quarantined: The message was quarantined. +- FilteredAsSpam: The message was marked as spam. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToIP +The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md new file mode 100644 index 0000000000..2053d79a67 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md @@ -0,0 +1,284 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceDetail + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceDetailV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2) cmdlet and will eventually be deprecated. + +Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageTraceDetail -MessageTraceId -RecipientAddress + [-Action ] + [-EndDate ] + [-Event ] + [-MessageId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-SenderAddress ] + [-StartDate ] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceDetail -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-MessageTrace -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress john@contoso.com -StartDate 06/13/2018 -EndDate 06/15/2018 | Get-MessageTraceDetail +``` + +This example uses the Get-MessageTrace cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f sent by john@contoso.com between June 13, 2018 and June 15, 2018, and pipelines the results to the Get-MessageTraceDetail cmdlet. + +## PARAMETERS + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTrace + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Event +The Event parameter filters the report by the message event. The following are examples of common events: + +- RECEIVE: The message was received by the service. +- SEND: The message was sent by the service. +- FAIL: The message failed to be delivered. +- DELIVER: The message was delivered to a mailbox. +- EXPAND: The message was sent to a distribution group that was expanded. +- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. +- DEFER: The message delivery was postponed and may be re-attempted later. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md new file mode 100644 index 0000000000..78e1a37969 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2 +applicable: Exchange Online +title: Get-MessageTraceDetailV2 +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceDetailV2 + +## SYNOPSIS + +## SYNTAX + +``` +Get-MessageTraceDetailV2 [-MessageTraceId] [-RecipientAddress] + [[-Action] ] + [[-EndDate] ] + [[-Event] ] + [[-MessageId] ] + [[-SenderAddress] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. You can only query 10 days worth of data per query. If you enter a timeframe that's older than 90 days, you receive an error and the command will return no results. + +Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceDetailV2 -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress robert@contoso.com +``` + +This example retrieves detailed message trace information for messages with the message trace ID value ae5c1219-4c90-41bf-fef5-08d837917e7c that were received by `robert@contoso.com`. + +### Example 2 +```powershell +Get-MessageTraceV2 -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 | Get-MessageTraceDetailV2 +``` + +This example uses the Get-MessageTraceV2 cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f sent by `john@contoso.com` between June 13, 2025 and June 15, 2025, and pipelines the results to the Get-MessageTraceDetailV2 cmdlet. + +## PARAMETERS + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Event +The Event parameter filters the report by the message event. The following are examples of common events: + +- RECEIVE: The message was received by the service. +- SEND: The message was sent by the service. +- FAIL: The message failed to be delivered. +- DELIVER: The message was delivered to a mailbox. +- EXPAND: The message was sent to a distribution group that was expanded. +- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. +- DEFER: The message delivery was postponed and may be re-attempted later. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceV2.md b/exchange/exchange-ps/exchange/Get-MessageTraceV2.md new file mode 100644 index 0000000000..f356876da6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceV2.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2 +applicable: Exchange Online +title: Get-MessageTraceV2 +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceV2 + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MessageTraceV2 cmdlet to trace messages as they pass through the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageTraceV2 + [[-EndDate] ] + [[-FromIP] ] + [[-MessageId] ] + [[-MessageTraceId] ] + [[-RecipientAddress] ] + [[-ResultSize] ] + [[-SenderAddress] ] + [[-StartDate] ] + [[-StartingRecipientAddress] ] + [[-Status] ] + [[-SubjectFilterType] ] + [[-Subject] ] + [[-ToIP] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. If you run this cmdlet without any parameters, only data from the last 48 hours is returned. You can only return 10 days worth of data per query. + +By default, this cmdlet returns up to 1000 results, with a maximum of 5000 results. If your data exceeds the result size, query in multiple rounds or use smaller StartDate and EndDate intervals. + +The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. + +Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes + +Pagination isn't supported in this cmdlet. To query subsequent data, use the StartingRecipientAddress and EndDate parameters with the values from the **Recipient address** and **Received Time** properties respectively of the previous result in the next query. + +Best Practices: + +- Use the ResultSize parameter to adjust the size of your results. +- Be as precise as possible. Narrow the gap between StartDate and EndDate and use additional parameters (for example, SenderAddress) where possible. +- Use MessageTraceId where possible (required for messages sent to more than 1000 recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceV2 -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 +``` + +This example retrieves message trace information for messages sent by `john@contoso.com` between June 13, 2025 and June 15, 2025. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FromIP +The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceDetailV2 + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. A valid value is from 1 to 5000. The default value is 1000. + +**Note**: This parameter replaces the PageSize parameter that was available on the Get-MessageTrace cmdlet. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartingRecipientAddress +The StartingRecipientAddress parameter is used with the EndDate parameter to query subsequent data for partial results while avoiding duplication. Query subsequent data by taking the **Recipient address** and **Received Time** values of the last record of the partial results and using them as the values for the StartingRecipientAddress and EndDate parameters respectively in the next query. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +The Status parameter filters the results by the delivery status of the message. Valid values are: + +- Delivered: The message was delivered to its destination. +- Expanded: There was no message delivery because the message was addressed to a distribution group and the membership of the distribution was expanded. +- Failed: Message delivery was attempted and it failed. +- FilteredAsSpam: The message was marked as spam. +- GettingStatus: The message is waiting for status update. +- None: The message has no delivery status because it was rejected or redirected to a different recipient. +- Pending: Message delivery is underway or was deferred and is being retried. +- Quarantined: The message was quarantined. + +You can separate multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +The Subject parameter filters the results by the subject of the message. If the value contains spaces, enclose the value in quotation marks ("). + +You specify how the value is evaluated in the message subject by using the SubjectFilterType parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectFilterType +The SubjectFilterType parameter specifies how the value of the Subject parameter is evaluated. Valid values are: + +- Contains +- EndsWith +- StartsWith + +We recommend using StartsWith or EndsWith instead of Contains whenever possible. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ToIP +The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrackingLog.md b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md similarity index 78% rename from exchange/exchange-ps/exchange/mail-flow/Get-MessageTrackingLog.md rename to exchange/exchange-ps/exchange/Get-MessageTrackingLog.md index dc5c6944c0..877d2fd0a3 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrackingLog.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MessageTrackingLog @@ -13,15 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MessageTrackingLog cmdlet to search for message delivery information stored in the message tracking log. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MessageTrackingLog [-DomainController ] [-End ] [-EventId ] - [-InternalMessageId ] [-MessageId ] [-MessageSubject ] [-Recipients ] - [-Reference ] [-ResultSize ] [-Sender ] [-Server ] - [-Start ] [-NetworkMessageId ] [-Source ] [-TransportTrafficType ] +Get-MessageTrackingLog [-DomainController ] + [-End ] + [-EventId ] + [-InternalMessageId ] + [-MessageId ] + [-MessageSubject ] + [-Recipients ] + [-Reference ] + [-ResultSize ] + [-Sender ] + [-Server ] + [-Start ] + [-NetworkMessageId ] + [-Source ] + [-TransportTrafficType ] [] ``` @@ -31,27 +45,31 @@ A unique message tracking log exists for the Transport service on a Mailbox serv The field names displayed in the results from the Get-MessageTrackingLog cmdlet are similar to the actual field names used in the message tracking logs. The differences are: - The dashes are removed from the field names. For example internal-message-id is displayed as InternalMessageId. - - The date-time field is displayed as Timestamp. - - The recipient-address field is displayed as Recipients. - - The sender-address field is displayed as Sender. -For more information about the message tracking log files, see Message tracking (https://technet.microsoft.com/library/bb124375.aspx). +For more information about the message tracking log files, see [Message tracking](https://learn.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking). -The Get-MessageTrackingLog results are displayed on-screen. 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: +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 +```powershell +Get-MessageTrackingLog -Server Mailbox01 -Start "03/13/2024 09:00:00" -End "03/15/2024 17:00:00" -Sender "john@contoso.com" ``` -Get-MessageTrackingLog -Server Mailbox01 -Start "03/13/2018 09:00:00" -End "03/15/2018 17:00:00" -Sender "john@contoso.com" + +This example searches the message tracking logs on the Mailbox server named Mailbox01 for information about all messages sent from March 13, 2024, 09:00 to March 15, 2024, 17:00 by the sender john@contoso.com. + +### Example 2 +```powershell +Get-MessageTrackingLog -Server Mailbox01 -Start "03/13/2024 09:00:00" -Recipients @("john@contoso.com","alice@contoso.com") ``` -This example searches the message tracking logs on the Mailbox server named Mailbox01 for information about all messages sent from March 13, 2018, 09:00 to March 15, 2018, 17:00 by the sender john@contoso.com. +This example searches the message tracking logs on the Mailbox server named Mailbox01 for information about all messages sent from March 13, 2024, 09:00 to today for the recipients john@contoso.com and/or alice@contoso.com. ## PARAMETERS @@ -65,6 +83,7 @@ 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 @@ -75,13 +94,14 @@ Accept wildcard characters: False ### -End The End parameter specifies the end date and time of the date range. Message delivery information is returned up to, but not including, the specified date and time. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -97,6 +117,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -114,6 +135,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -122,13 +144,14 @@ 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. +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, ""). ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,6 +167,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,13 +176,14 @@ Accept wildcard characters: False ``` ### -Recipients -The Recipients parameter filters the message tracking log entries by the SMTP email address of the message recipients. Multiple recipients in a single message are logged in a single message tracking log entry. Unexpanded distribution group recipients are logged by using the group's SMTP email address. You can specify multiple recipient email addresses separated by commas. +The Recipients parameter filters the message tracking log entries by the SMTP email address of the message recipients. Multiple recipients in a single message are logged in a single message tracking log entry. Unexpanded distribution group recipients are logged by using the group's SMTP email address. You can specify multiple recipients using an array of email addresses. ```yaml Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -174,6 +199,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,6 +215,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -204,6 +231,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -215,11 +243,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -229,6 +254,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -239,13 +265,14 @@ Accept wildcard characters: False ### -Start The Start parameter specifies the start date and time of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -261,6 +288,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -269,13 +297,14 @@ Accept wildcard characters: False ``` ### -Source -The Source parameter filters the message tracking log entries by the value of the Source field. These values indicate the transport component that's responsible for the message tracking event. For more information, see Source values in the message tracking log (https://technet.microsoft.com/library/bb124375.aspx#Source). +The Source parameter filters the message tracking log entries by the value of the Source field. These values indicate the transport component that's responsible for the message tracking event. For more information, see [Source values in the message tracking log](https://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 Default value: None @@ -291,6 +320,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -299,20 +329,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3e0e270a-ba0b-4231-a289-9a940bb63761.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md similarity index 79% rename from exchange/exchange-ps/exchange/mail-flow/Get-MessageTrackingReport.md rename to exchange/exchange-ps/exchange/Get-MessageTrackingReport.md index 0f5974da2e..fe0eb16c93 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md @@ -1,48 +1,62 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MessageTrackingReport ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. Use the Get-MessageTrackingReport cmdlet to return data for a specific message tracking report. This cmdlet is used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MessageTrackingReport [-Identity] [-BypassDelegateChecking] - [-DetailLevel ] [-DomainController ] [-DoNotResolve] - [-RecipientPathFilter ] [-Recipients ] [-ReportTemplate ] - [-ResultSize ] [-Status ] - [-TraceLevel ] [] +Get-MessageTrackingReport [-Identity] + [-BypassDelegateChecking] + [-DetailLevel ] + [-DomainController ] + [-DoNotResolve] + [-RecipientPathFilter ] + [-Recipients ] + [-ReportTemplate ] + [-ResultSize ] + [-Status ] + [-TraceLevel ] + [] ``` ## 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. +This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -$Temp = Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com"; Get-MessageTrackingReport -Identity $Temp.MessageTrackingReportID -ReportTemplate Summary +### Example 1 +```powershell +$Temp = Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com" + +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. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Search-MessageTrackingReport -Identity "Cigdem Akin" -Sender "joe@contoso.com" -ByPassDelegateChecking -DoNotResolve | ForEach-Object { Get-MessageTrackingReport -Identity $_.MessageTrackingReportID -DetailLevel Verbose -BypassDelegateChecking -DoNotResolve -RecipientPathFilter "cigdem@fabrikam.com" -ReportTemplate RecipientPath } ``` @@ -62,6 +76,7 @@ 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 Default value: None @@ -79,6 +94,7 @@ 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 @@ -90,14 +106,14 @@ Accept wildcard characters: False 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. - - Verbose: Full report information is returned, including server names and physical topology information. ```yaml -Type: Basic | Verbose +Type: MessageTrackingDetailLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -106,8 +122,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -115,6 +129,7 @@ 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 @@ -132,6 +147,7 @@ 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 @@ -147,6 +163,7 @@ 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 @@ -162,6 +179,7 @@ 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 Default value: None @@ -173,14 +191,14 @@ Accept wildcard characters: False 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. - - Summary: Returns a summary for all recipients of the message. You specify the recipients by using the Recipients parameter. ```yaml -Type: Summary | RecipientPath +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 Default value: None @@ -196,6 +214,7 @@ 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 Default value: None @@ -207,20 +226,17 @@ Accept wildcard characters: False The Status parameter filters the results by the specified delivery status codes. Valid values are: - Delivered - - Read - - Pending - - Transferred - - Unsuccessful ```yaml -Type: Unsuccessful | Pending | Delivered | Transferred | Read +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 Default value: None @@ -232,18 +248,17 @@ Accept wildcard characters: False 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. - - Medium: In addition to the data returned for the Low setting, the actual message tracking search results are also returned. - - High: Full diagnostic data is returned. You only need to use this parameter for troubleshooting message tracking issues. ```yaml -Type: Low | Medium | High +Type: TraceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -252,20 +267,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b949297c-843b-4eb6-9e5e-378c84b841a3.aspx) diff --git a/exchange/exchange-ps/exchange/Get-MigrationBatch.md b/exchange/exchange-ps/exchange/Get-MigrationBatch.md new file mode 100644 index 0000000000..ecc0d0aa97 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MigrationBatch.md @@ -0,0 +1,333 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MigrationBatch cmdlet to retrieve status information about the current migration batch. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-MigrationBatch [[-Identity] ] + [-Diagnostic] + [-DiagnosticArgument ] + [-DiagnosticInfo ] + [-DomainController ] + [-IncludeReport] + [-Partition ] + [-ResultSize ] + [-Status ] + [] +``` + +### BatchesFromEndpoint +``` +Get-MigrationBatch + [-Diagnostic] + [-DiagnosticArgument ] + [-DomainController ] + [-Endpoint ] + [-IncludeReport] + [-Status ] + [] +``` + +### BatchesByEndpoint +``` +Get-MigrationBatch + [-DiagnosticInfo ] + [-Endpoint ] + [-IncludeReport] + [-Partition ] + [-ResultSize ] + [] +``` + +### BatchesByStatus +``` +Get-MigrationBatch + [-DiagnosticInfo ] + [-IncludeReport] + [-Partition ] + [-ResultSize ] + [-Status ] + [] +``` + +## DESCRIPTION +The Get-MigrationBatch cmdlet displays status information about the current migration batch. This information includes the following information: + +- Status of the migration batch +- Total number of mailboxes being migrated +- Number of successfully completed migrations +- 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). + +**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. + +## EXAMPLES + +### Example 1 +```powershell +Get-MigrationBatch -Identity LocalMove2 +``` + +This example displays status information for the migration batch LocalMove2. + +### Example 2 +```powershell +Get-MigrationBatch -Endpoint exsrv1.contoso.com +``` + +This example displays information about all migration batches associated with the migration endpoint exsrv1.contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. + +If you use this parameter, you can't include the Endpoint parameter. + +```yaml +Type: MigrationBatchIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Diagnostic +This parameter is available only in on-premises Exchange. + +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, BatchesFromEndpoint +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticArgument +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. + +```yaml +Type: String +Parameter Sets: Identity, BatchesFromEndpoint +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticInfo +This parameter is available only in the cloud-based service. + +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- attachmentid=String +- batch=String +- confirm +- duration=String +- endpoints +- endtime=DateTime +- maxsize=Int32 +- organization=String +- partition=String +- reportid=String +- reports +- showtimeline +- showtimeslots=String +- starttime=DateTime +- status=String +- storage +- type=String +- user=String +- verbose + +```yaml +Type: String +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Identity, BatchesFromEndpoint +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. + +If you use this parameter, you can't include the Identity parameter. + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: BatchesFromEndpoint, BatchesByEndpoint +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeReport +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status parameter returns a list of migration batches that have the specified status state. Use one of the following values: + +- Completed +- CompletedWithErrors +- Completing +- Corrupted +- Created +- Failed +- IncrementalSyncing +- Removing +- Starting +- Stopped +- Syncing +- Stopping +- Synced +- SyncedwithErrors +- Waiting + +```yaml +Type: MMigrationBatchStatus +Parameter Sets: Identity, BatchesFromEndpoint, BatchesByStatus +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MigrationConfig.md b/exchange/exchange-ps/exchange/Get-MigrationConfig.md new file mode 100644 index 0000000000..1d8997faf8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MigrationConfig.md @@ -0,0 +1,144 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MigrationConfig cmdlet to retrieve migration configuration settings on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Get-MigrationConfig [-DomainController ] + [] +``` + +### 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MigrationConfig +``` + +This example retrieves the settings for the migration configuration. + +## PARAMETERS + +### -AllPartitions +This parameter is available only in the cloud-based service. + +{{ Fill AllPartitions Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AllPartitions +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSimplifiedGmailMigrationData +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSimplifiedGmailMigrationData Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Partition, AllPartitions +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Partition +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md new file mode 100644 index 0000000000..8f8f5dd3c9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md @@ -0,0 +1,264 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MigrationEndpoint cmdlet to retrieve migration endpoint settings for source or destination servers for cutover or staged Exchange migrations, IMAP migrations, and remote moves. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ConnectionSettingsFilter +``` +Get-MigrationEndpoint -ConnectionSettings + [-Diagnostic] + [-DiagnosticArgument ] + [-DomainController ] + [] +``` + +### TypeFilter +``` +Get-MigrationEndpoint -Type + [-Diagnostic] + [-DiagnosticArgument ] + [-DomainController ] + [-Partition ] + [-DiagnosticInfo ] + [] +``` + +### Identity +``` +Get-MigrationEndpoint [[-Identity] ] + [-Diagnostic] + [-DiagnosticArgument ] + [-DomainController ] + [-Partition ] + [-DiagnosticInfo ] + [] +``` + +## DESCRIPTION +The Get-MigrationEndpoint cmdlet retrieves settings for different types of migration: + +- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a RemoteMove endpoint. +- Remote move: In a hybrid deployment, a remote move involves onboarding or offboarding migrations. Remote moves require the use of a RemoteMove endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online, and uses a RemoteMove endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online to an on-premises Exchange organization and uses a RemoteMove endpoint as the target endpoint of the migration batch. +- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online. Cutover Exchange migration requires the use of an Exchange endpoint. +- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online. Staged Exchange migration requires the use of an Exchange endpoint. +- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. +- Local: Move mailboxes between different servers or databases within a single on-premises Exchange forest. Local moves don't require the use of an endpoint. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MigrationEndpoint -Identity OnboardingME01 +``` + +This example retrieves the settings for the migration endpoint, OnboardingME01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConnectionSettings +This parameter is available only in on-premises Exchange. + +The ConnectionSettings parameter specifies the configuration settings of source or target servers for which you want to find a matching endpoint. + +```yaml +Type: ExchangeConnectionSettings +Parameter Sets: ConnectionSettingsFilter +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Diagnostic +This parameter is available only in on-premises Exchange. + +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticArgument +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticInfo +This parameter is available only in the cloud-based service. + +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- attachmentid=String +- batch=String +- confirm +- duration=String +- endpoints +- endtime=DateTime +- maxsize=Int32 +- organization=String +- partition=String +- reportid=String +- reports +- showtimeline +- showtimeslots=String +- starttime=DateTime +- status=String +- storage +- type=String +- user=String +- verbose + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Type parameter filters the results by the type of migration. Valid values for this parameter are: + +- ExchangeOutlookAnywhere: Cutover or staged Exchange migrations +- ExchangeRemoteMove: Remote moves and migrations +- IMAP: IMAP migrations +- PublicFolder: Public folder migrations + +```yaml +Type: MigrationType +Parameter Sets: TypeFilter +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationStatistics.md new file mode 100644 index 0000000000..c397c884ee --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MigrationStatistics.md @@ -0,0 +1,173 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MigrationStatistics cmdlet to view detailed information about migration requests. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MigrationStatistics [-Diagnostic] + [-DiagnosticArgument ] + [-DiagnosticInfo ] + [-DomainController ] + [-Partition ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MigrationStatistics +``` + +This example returns the default statistics for the migration batches. + +## PARAMETERS + +### -Diagnostic +This parameter is available only in on-premises Exchange. + +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticArgument +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticInfo +This parameter is available only in the cloud-based service. + +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- attachmentid=String +- batch=String +- confirm +- duration=String +- endpoints +- endtime=DateTime +- maxsize=Int32 +- organization=String +- partition=String +- reportid=String +- reports +- showtimeline +- showtimeslots=String +- starttime=DateTime +- status=String +- storage +- type=String +- user=String +- verbose + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MigrationUser.md b/exchange/exchange-ps/exchange/Get-MigrationUser.md new file mode 100644 index 0000000000..e379851050 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MigrationUser.md @@ -0,0 +1,307 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MigrationUser cmdlet to view information about move and migration users. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### MailboxGuid +``` +Get-MigrationUser -MailboxGuid + [-DomainController ] + [-IncludeAssociatedUsers] + [-ResultSize ] + [-Partition ] + [] +``` + +### StatusAndBatchId +``` +Get-MigrationUser [-BatchId ] [-Status ] [-StatusSummary ] + [-DomainController ] + [-IncludeAssociatedUsers] + [-ResultSize ] + [-Partition ] + [] +``` + +### Identity +``` +Get-MigrationUser [[-Identity] ] + [-DomainController ] + [-IncludeAssociatedUsers] + [-ResultSize ] + [-Partition ] + [] +``` + +### EmailAddress +``` +Get-MigrationUser -EmailAddress + [-DomainController ] + [-IncludeAssociatedUsers] + [-ResultSize ] + [-Partition ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MigrationUser -Identity TonySmith@contoso.com +``` + +This example retrieves status information about the recently migrated user, Tony Smith. + +### Example 2 +```powershell +Get-MigrationUser -MailboxGuid b6a6795c-a010-4f67-aaaa-da372d56fcb9 | Get-MigrationUserStatistics +``` + +This example retrieves more detailed information about any ongoing migration for the user with the specified mailbox GUID. + +### Example 3 +```powershell +Get-MigrationUser -EmailAddress TonySmith@contoso.com +``` + +This example retrieves status information about the recently migrated user, Tony Smith. + +### Example 4 +```powershell +Get-MigrationUser -EmailAddress TonySmith@contoso.com | Get-MigrationUserStatistics +``` + +This example retrieves more detailed information about any ongoing migration for the user with the specified email address. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the particular ongoing migration that you want to retrieve information about. The Identity parameter is usually represented as an email address. + +```yaml +Type: MigrationUserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MailboxGuid +The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information. + +```yaml +Type: Guid +Parameter Sets: MailboxGuid +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +The EmailAddress parameter specifies the particular user that you want to retrieve information about. The EmailAddress parameter is represented as an email address. This parameter is available only in the cloud-based service. + +```yaml +Type: EmailAddress +Parameter Sets: EmailAddress +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAssociatedUsers +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAssociatedUsers Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Status +The Status parameter returns information about migration users that have the specified status state. Use one of the following values: + +- Completed +- CompletedWithWarnings +- Completing +- CompletionFailed +- CompletionSynced +- Corrupted +- Failed +- IncrementalFailed +- IncrementalStopped +- IncrementalSynced +- IncrementalSyncing +- Provisioning +- ProvisionUpdating +- Queued +- Removing +- Starting +- Stopped +- Stopping +- Synced +- Syncing +- Validating + +```yaml +Type: MigrationUserStatus +Parameter Sets: StatusAndBatchId +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusSummary +The StatusSummary parameter returns abbreviated information about migration users that have the specified status value. Use one of the following values: + +- Active +- Completed +- Failed +- Stopped +- Synced + +```yaml +Type: MigrationUserStatusSummary +Parameter Sets: StatusAndBatchId +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/move-and-migration/Get-MigrationUserStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md similarity index 75% rename from exchange/exchange-ps/exchange/move-and-migration/Get-MigrationUserStatistics.md rename to exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md index bc17bf8219..5e64b3de72 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationUserStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MigrationUserStatistics @@ -13,58 +16,67 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationUserStatistics cmdlet to view detailed information about the migration requested for a specific user. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MigrationUserStatistics [-Identity] [-Diagnostic] [-DiagnosticArgument ] - [-DiagnosticInfo ] [-DomainController ] [-IncludeReport] [-LimitSkippedItemsTo ] - [-IncludeSkippedItems] [-Partition ] [-SkipSubscription] [] +Get-MigrationUserStatistics [-Identity] + [-Diagnostic] + [-DiagnosticArgument ] + [-DiagnosticInfo ] + [-DomainController ] + [-IncludeCopilotReport] + [-IncludeReport] + [-IncludeSkippedItems] + [-LimitSkippedItemsTo ] + [-Partition ] + [-SkipSubscription] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MigrationUserStatistics -Identity davidp@corp.contoso.com -IncludeReport | Format-List Status,Error,Report ``` This example uses the IncludeReport parameter to display detailed information about the migration status for the user. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MigrationUserStatistics -Identity davidp@corp.contoso.com | Format-List SkippedItemCount,SkippedItems ``` This example displays the number of mailbox items that failed to migrate, which are called skipped items, and information about each skipped item. -### -------------------------- Example 3 -------------------------- -``` -Get-MigrationUserStatistics -Identity davidp@corp.contoso.com -LimitSkippedItemsTo 20 | Format-List SkippedItemCount,SkippedItems +### Example 3 +```powershell +Get-MigrationUserStatistics -Identity davidp@corp.contoso.com -IncludeSkippedItems | Select-Object -ExpandProperty SkippedItems | Format-List DateReceived, Subject ``` -This example displays results information in the SkippedItems property for a maximum of 20 skipped items. +This example displays results information in the SkippedItems property. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MigrationUser -BatchId StagedBatch1 | Get-MigrationUserStatistics ``` This example displays detailed information about users in the migration batch named StagedBatch1. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Get-MigrationUser | Get-MigrationUserStatistics ``` This example displays detailed information about users from all current migration batches. -### -------------------------- Example 6 -------------------------- -``` +### Example 6 +```powershell Get-MigrationUserStatistics -Identity davidp@corp.contoso.com -Diagnostic | Format-List Status,Error,DiagnosticInfo ``` @@ -80,6 +92,7 @@ Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -90,13 +103,16 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -114,6 +130,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -131,6 +148,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -148,6 +166,25 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeCopilotReport +This parameter is available only in the cloud-based service. + +{{ Fill IncludeCopilotReport Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -156,13 +193,14 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -178,6 +216,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -193,6 +232,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -209,7 +249,8 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -225,6 +266,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -233,20 +275,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b771bb31-7f5a-462f-b5e2-ce49fde9bfe5.aspx) diff --git a/exchange/exchange-ps/exchange/Get-MobileDevice.md b/exchange/exchange-ps/exchange/Get-MobileDevice.md new file mode 100644 index 0000000000..7da6e04fbb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MobileDevice.md @@ -0,0 +1,370 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MobileDevice cmdlet to get the list of devices in your organization that have active partnerships. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Mailbox +``` +Get-MobileDevice -Mailbox + [-ActiveSync] + [-DomainController ] + [-Filter ] + [-Monitoring] + [-OrganizationalUnit ] + [-OWAforDevices] + [-ResultSize ] + [-SortBy ] + [-RestApi] + [-UniversalOutlook] + [] +``` + +### Identity +``` +Get-MobileDevice [[-Identity] ] + [-ActiveSync] + [-DomainController ] + [-Filter ] + [-Monitoring] + [-OrganizationalUnit ] + [-OWAforDevices] + [-ResultSize ] + [-SortBy ] + [-RestApi] + [-UniversalOutlook] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MobileDevice -Mailbox "Tony Smith" +``` + +This example returns all the mobile devices that Tony Smith has used that are associated with his mailbox. + +### Example 2 +```powershell +Get-MobileDevice -ResultSize unlimited | Format-Table -Auto DeviceModel,Identity +``` + +This example returns a summary list of all mobile devices in the organization. + +### Example 3 +```powershell +Get-MobileDevice -Identity Lila\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac | Format-List +``` + +This example returns detailed information about the specified device on Lila's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: + +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) + +```yaml +Type: MobileDeviceIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter filters the results by mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Identity parameter. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveSync +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can filter by the following properties: + +- ClientType +- DeviceAccessControlRule +- DeviceAccessState +- DeviceAccessStateReason +- DeviceActiveSyncVersion +- DeviceId +- DeviceImei +- DeviceMobileOperator +- DeviceModel +- DeviceOS +- DeviceOSLanguage +- DeviceTelephoneNumber +- DeviceType +- DeviceUserAgent +- FirstSyncTime +- FriendlyName +- ProvisioningFlags +- UserDisplayName + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Monitoring +This parameter is available only in on-premises Exchange. + +The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. + +Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAforDevices +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- DeviceAccessControlRule +- DeviceAccessState +- DeviceAccessStateReason +- DeviceId +- DeviceImei +- DeviceMobileOperator +- DeviceModel +- DeviceOS +- DeviceOSLanguage +- DeviceTelephoneNumber +- DeviceType +- DeviceUserAgent +- FirstSyncTime +- FriendlyName +- UserDisplayName + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestApi +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniversalOutlook +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md new file mode 100644 index 0000000000..5a1d4c078b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md @@ -0,0 +1,101 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MobileDeviceMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MobileDeviceMailboxPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MobileDeviceMailboxPolicy -Identity "SalesPolicy" +``` + +This example returns the policy settings for the Mobile Device mailbox policy SalesPolicy. + +### Example 2 +```powershell +Get-MobileDeviceMailboxPolicy -Identity "Default" +``` + +This example returns the policy settings for the Mobile Device mailbox policy Default. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md new file mode 100644 index 0000000000..d493f60367 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md @@ -0,0 +1,305 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-MobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMobileDeviceStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-MobileDeviceStatistics [-Identity] + [-ActiveSync] + [-DomainController ] + [-GetMailboxLog] + [-NotificationEmailAddresses ] + [-OWAforDevices] + [-ShowRecoveryPassword] + [-RestApi] + [-UniversalOutlook] + [-UseCustomRouting] + [] +``` + +### Mailbox +``` +Get-MobileDeviceStatistics -Mailbox + [-ActiveSync] + [-DomainController ] + [-GetMailboxLog] + [-NotificationEmailAddresses ] + [-OWAforDevices] + [-ShowRecoveryPassword] + [-RestApi] + [-UniversalOutlook] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +The Get-MobileDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MobileDeviceStatistics -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac +``` + +This example retrieves the statistics for the specified mobile phone. + +### Example 2 +```powershell +$UserList = Get-CASMailbox -ResultSize unlimited -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" + +$UserList | foreach {Get-MobileDeviceStatistics -Mailbox $_.Identity} +``` + +This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. + +**Note**: For more information about OPATH filter syntax, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +### Example 3 +```powershell +Get-MobileDeviceStatistics -Mailbox "Tony Smith" -GetMailboxLog -NotificationEmailAddresses "admin@contoso.com" +``` + +This example retrieves the statistics for the mobile phone that's configured to synchronize with Tony Smith's mailbox. It also outputs the log file and sends it to the System Administrator at admin@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: + +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) + +You can't use this parameter with the Mailbox parameter. + +```yaml +Type: MobileDeviceIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Identity parameter. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveSync +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetMailboxLog +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailAddresses +The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. + +This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAforDevices +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowRecoveryPassword +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestApi +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniversalOutlook +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md new file mode 100644 index 0000000000..b720090806 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md @@ -0,0 +1,94 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MonitoringItemHelp + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MonitoringItemHelp cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. Monitoring items are preconfigured to help you with your server health and monitoring. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MonitoringItemHelp -Server Exch01 -Identity OutlookMapiHttp.Proxy\CrashEvent.msexchangemapifrontendapppoolEscalate\msexchangemapifrontendapppool | Format-List +``` + +This example retrieves health set information for a monitoring item on the server named Exch01 and displays the output without truncating the results. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md b/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md new file mode 100644 index 0000000000..993413da94 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md @@ -0,0 +1,94 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MonitoringItemIdentity + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-MonitoringItemIdentity cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MonitoringItemIdentity -Identity OutlookMapiHttp.Proxy -Server ExchSrv01 +``` + +This example returns information about the health set named OutlookMapiHttp.Proxy on the server named ExchSrv01. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MoveRequest.md b/exchange/exchange-ps/exchange/Get-MoveRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/move-and-migration/Get-MoveRequest.md rename to exchange/exchange-ps/exchange/Get-MoveRequest.md index 7177089afb..9bd1b19333 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Get-MoveRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MoveRequest @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MoveRequest cmdlet to view the detailed status of an ongoing asynchronous mailbox move that was initiated by using the New-MoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,20 +38,21 @@ Get-MoveRequest [[-Identity] ] Get-MoveRequest [-BatchName ] [-Credential ] [-DomainController ] - [-Flags ] - [-HighPriority <$true | $false>] + [-Flags ] + [-HighPriority ] [-IncludeSoftDeletedObjects] - [-MoveStatus ] - [-Offline <$true | $false>] + [-MoveStatus ] + [-Offline ] [-OrganizationalUnit ] - [-Protect <$true | $false>] + [-Protect ] [-ProxyToMailbox ] [-RemoteHostName ] [-ResultSize ] [-SortBy ] [-SourceDatabase ] - [-Suspend <$true | $false>] - [-SuspendWhenReadyToComplete <$true | $false>] + [-Status ] + [-Suspend ] + [-SuspendWhenReadyToComplete ] [-TargetDatabase ] [] ``` @@ -56,26 +60,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MoveRequest -Identity 'tony@contoso.com' ``` This example retrieves the status of the ongoing mailbox move for Tony Smith's mailbox (tony@contoso.com). -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MoveRequest -MoveStatus InProgress -TargetDatabase DB05 ``` This example retrieves the status of ongoing mailbox moves to the target database DB05. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MoveRequest -BatchName "FromDB01ToDB02" -MoveStatus CompletedWithWarning ``` @@ -84,52 +88,30 @@ This example retrieves the status of move requests in the FromDB01ToDB02 batch t ## PARAMETERS ### -Identity -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) You can use this parameter with the following parameters: - BatchName - - HighPriority - - MoveStatus - - Offline - - Protect - - RemoteHostName - - SourceDatabase - - Suspend - - SuspendWhenReadyToComplete - - TargetDatabase ```yaml @@ -137,6 +119,7 @@ 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 Default value: None @@ -154,6 +137,7 @@ 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 Default value: None @@ -164,15 +148,16 @@ Accept wildcard characters: False ### -Credential This parameter is available only in on-premises Exchange. -The Credential parameter specifies the user name 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. +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://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -190,6 +175,7 @@ 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 @@ -201,42 +187,28 @@ Accept wildcard characters: False The Flags parameter specifies the move type to retrieve information for. The following values may be used: - CrossOrg - - HighPriority - - IntraOrg - - Join - - MoveOnlyArchiveMailbox - - MoveOnlyPrimaryMailbox - - None - - Offline - - Protected - - Pull - - Push - - RemoteLegacy - - Split - - Suspend - - SuspendWhenReadyToComplete - - TargetIsAggregatedMailbox ```yaml -Type: None | CrossOrg | IntraOrg | Push | Pull | Offline | Protected | RemoteLegacy | HighPriority | Suspend | SuspendWhenReadyToComplete | MoveOnlyPrimaryMailbox | MoveOnlyArchiveMailbox | TargetIsAggregatedMailbox | Join | Split +Type: RequestFlags Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -252,10 +224,11 @@ The HighPriority parameter specifies that the cmdlet returns requests that were You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -273,6 +246,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -284,30 +258,23 @@ Accept wildcard characters: False The MoveStatus parameter returns move requests in the specified status. You can use the following values: - AutoSuspended - - Completed - - CompletedWithWarning - - CompletionInProgress - - Failed - - InProgress - - Queued - - Retrying - - Suspended You can't use this parameter with the Identity parameter. ```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Completed | CompletedWithWarning | Suspended | Failed +Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -321,10 +288,11 @@ The Offline parameter specifies whether to return mailboxes that are being moved You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +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 Default value: None @@ -333,21 +301,19 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: +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 - - Canonical name - - Distinguished name (DN) - - GUID ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -363,10 +329,11 @@ The Protect parameter returns mailboxes being moved in protected mode. This para You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -377,30 +344,17 @@ Accept wildcard characters: False ### -ProxyToMailbox 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: +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: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -408,6 +362,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -425,6 +380,7 @@ 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 Default value: None @@ -440,6 +396,7 @@ 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 Default value: None @@ -450,21 +407,20 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +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. You can sort by the following properties: - Name - - DisplayName - - Alias ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -475,11 +431,11 @@ Accept wildcard characters: False ### -SourceDatabase This parameter is available only in on-premises Exchange. -The SourceDatabase parameter specifies that all mailboxes being moved from the specified source database are returned. You can use the following values: +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: -- GUID of the database - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -488,6 +444,37 @@ Type: DatabaseIdParameter Parameter Sets: Filtering 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 +``` + +### -Status +This parameter is available only in the cloud-based service. + +The Status parameter filters the results by status. Valid values are: + +- AutoSuspended +- Completed +- CompletedWithSkippedItems +- CompletedWithWarning +- CompletionInProgress +- Failed +- InProgress +- Queued +- Retrying +- Suspended +- Synced + +```yaml +Type: RequestStatus +Parameter Sets: Filtering +Aliases: MoveStatus +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -501,10 +488,11 @@ The Suspend parameter specifies whether to return mailboxes with moves that have You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +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 Default value: None @@ -518,10 +506,11 @@ The SuspendWhenReadytoComplete parameter specifies whether to return mailboxes t You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +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 Default value: None @@ -532,11 +521,11 @@ Accept wildcard characters: False ### -TargetDatabase This parameter is available only in on-premises Exchange. -The TargetDatabase parameter specifies whether to return all mailboxes that are being moved to the specified target database. You can use the following values: - -- GUID of the database +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: -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -545,6 +534,7 @@ Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -553,20 +543,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3f8aa1a6-ed8c-4220-9cc7-dd615203f5c5.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md similarity index 76% rename from exchange/exchange-ps/exchange/move-and-migration/Get-MoveRequestStatistics.md rename to exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md index ae513ba064..8f312cf0ae 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MoveRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-MoveRequestStatistics @@ -15,7 +18,7 @@ Use the Get-MoveRequestStatistics cmdlet to view detailed information about move Some of the failure messages that are returned by this cmdlet are temporary and don't indicate that a request has actually failed. If the Status value is Queued or InProgress, then the request is proceeding normally. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +36,9 @@ Get-MoveRequestStatistics [-Identity] ### IdentityCloud ``` Get-MoveRequestStatistics [-Identity] + [-Analysis] [-DiagnosticInfo ] + [-DiagnosticOnly] [-IncludeReport] [-ProxyToMailbox ] [-ReportOnly] @@ -42,7 +47,8 @@ Get-MoveRequestStatistics [-Identity] ### MigrationMoveRequestQueue ``` -Get-MoveRequestStatistics -MoveRequestQueue [-MailboxGuid ] +Get-MoveRequestStatistics -MoveRequestQueue + [-MailboxGuid ] [-Diagnostic] [-DiagnosticArgument ] [-DomainController ] @@ -53,68 +59,70 @@ Get-MoveRequestStatistics -MoveRequestQueue [-MailboxGuid ### MigrationMRSInstance ``` -Get-MoveRequestStatistics -MRSInstance [-MailboxGuid ] +Get-MoveRequestStatistics -MRSInstance + [-MailboxGuid ] [-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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MoveRequestStatistics -Identity Tony@contoso.com ``` This example returns the default statistics for Tony Smith's mailbox, which include the status, mailbox size, archive mailbox size, and the percentage complete. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MoveRequestStatistics -Identity "contoso\tony" | Format-List ``` This example returns the detailed statistics for Tony Smith's mailbox by pipelining the results to the Format-List command. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MoveRequestStatistics -Identity Tony@contoso.com -IncludeReport | Export-CSV C:\MRStats.csv ``` This example returns additional information about the mailbox move for Tony Smith's mailbox and exports the report to a .csv file. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-MoveRequestStatistics -MoveRequestQueue "MBXDB02" ``` This example returns default statistics for all mailboxes whose move requests are in progress or haven't been cleared for the database MBXDB02. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell 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. +### Example 6 +```powershell +Get-MoveRequestStatistics tony@contoso.com -IncludeReport -DiagnosticInfo Verbose | Export-Clixml "C:\Data\MoveReport.xml" +``` + +This example exports the move request information so you can later import it into the MRS_Explorer.ps1 script for analysis. For more information, see [MRS-Explorer](https://github.com/zarkatech/MRS-Explorer). + ## PARAMETERS ### -Identity The Identity parameter specifies the identity of the mailbox or mail user. You can use one of the following values: - GUID - - Distinguished name (DN) - - Domain\\Account - - User principal name (UPN) - - Legacy Exchange DN - - SMTP address - - Alias You can use this parameter with the MoveRequestQueue or MailboxGuid parameters. @@ -124,6 +132,7 @@ 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 Default value: None @@ -136,11 +145,11 @@ This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. -The MoveRequestQueue parameter specifies the mailbox database on which the move request resides. You can use one of the following values: +The MoveRequestQueue parameter specifies the mailbox database on which the move request resides. You can use any value that uniquely identifies the database. For example: -- GUID of the database - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity or MRSInstance parameters. @@ -149,6 +158,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationMoveRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -157,7 +167,7 @@ Accept wildcard characters: False ``` ### -MRSInstance -This parameter is available or functional only in on-premises Exchange Server 2010. +This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -168,6 +178,7 @@ Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -175,6 +186,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Analysis +This parameter is available only in the cloud-based service. + +{{ Fill Analysis Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Diagnostic This parameter is available only in on-premises Exchange. @@ -187,6 +216,7 @@ Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -197,15 +227,14 @@ Accept wildcard characters: False ### -DiagnosticArgument This parameter is available only in on-premises Exchange. -The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. You don't need to specify a value with this switch. - -Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -216,13 +245,36 @@ Accept wildcard characters: False ### -DiagnosticInfo This parameter is available only in the cloud-based service. -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- ShowTimeline +- ShowTimeslot +- Verbose ```yaml Type: String Parameter Sets: IdentityCloud Aliases: Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticOnly +This parameter is available only in the cloud-based service. + +{{ Fill DiagnosticOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -240,6 +292,7 @@ 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 Default value: None @@ -255,6 +308,7 @@ 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 Default value: None @@ -274,6 +328,7 @@ Type: Guid Parameter Sets: MigrationMoveRequestQueue, MigrationMRSInstance Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -284,30 +339,17 @@ Accept wildcard characters: False ### -ProxyToMailbox 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: +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: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -315,6 +357,7 @@ Type: MailboxIdParameter Parameter Sets: IdentityCloud Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -323,13 +366,14 @@ Accept wildcard characters: False ``` ### -ReportOnly -The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. +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 Default value: None @@ -338,20 +382,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1baf0fd7-40e1-4d91-bab7-beff28b89e99.aspx) diff --git a/exchange/exchange-ps/exchange/Get-MxRecordReport.md b/exchange/exchange-ps/exchange/Get-MxRecordReport.md new file mode 100644 index 0000000000..1600495130 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MxRecordReport.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-MxRecordReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MxRecordReport cmdlet to view information about the mail exchanger (MX) records that are configured for a specified domain. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MxRecordReport [-Domain ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-MxRecordReport -Domain contoso.com +``` + +This example shows the MX record information for the contoso.com domain. + +## PARAMETERS + +### -Domain +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..ad5461513b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md @@ -0,0 +1,103 @@ +--- +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 +ms.author: chrisda +--- + +# Get-MyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-MyAnalyticsFeatureConfig cmdlet to view the availability and feature status of MyAnalytics for the specified user. + +**Note**: This cmdlet replaces the Get-UserAnalyticsConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MyAnalyticsFeatureConfig -Identity + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +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 +c:\users\vikram Get-MyAnalyticsFeatureConfig -Identity vikram@contoso.com + +UserId : vikram@contoso.com +PrivacyMode : opt-in +IsDashboardEnabled : true +IsAddInEnabled : true +IsDigestEmailEnabled : false +``` + +This example and the corresponding output shows the MyAnalytics configuration for the user vikram@contoso.com. MyAnalytics is available to Vikram (the PrivacyMode property value is opt-in). The only feature that's disabled is digest email messages. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md b/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md new file mode 100644 index 0000000000..3b753febcb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md @@ -0,0 +1,107 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-NetworkConnectionInfo + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-NetworkConnectionInfo cmdlet to view the network configuration information for all network adapters configured on the local server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-NetworkConnectionInfo [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +This cmdlet retrieves the following configuration information for each network adapter configured on the server: + +- Name: This field displays the name of the network adapter. This name indicates the manufacturer and model of the network adapter or the administrator-specified name of the network adapter. +- DnsServers: This field displays the DNS servers used by the network adapter. The server names are separated by commas. +- IPAddresses: This field displays the IP addresses used by the network adapter. The IP addresses are separated by commas. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-NetworkConnectionInfo Mailbox01 +``` + +This example retrieves network configuration information for all network adapters on the server named Mailbox01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the server you want to query. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use the Identity parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Notification.md b/exchange/exchange-ps/exchange/Get-Notification.md new file mode 100644 index 0000000000..a354e891db --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Notification.md @@ -0,0 +1,243 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. The classic Exchange admin center was deprecated in the cloud-based service in 2023. + +Use the Get-Notification cmdlet to view notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notifications are related to the following events: + +- Mailbox moves and migrations. +- Expiring and expired certificates. +- Exporting mailbox content to .pst files. +- Importing mailbox content from .pst files. +- Restoring deleted mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Settings +``` +Get-Notification [-Settings] -ProcessType + [-DomainController ] + [] +``` + +### Identity +``` +Get-Notification [[-Identity] ] + [-Summary] + [-DomainController ] + [] +``` + +### Filter +``` +Get-Notification [-ProcessType ] + [-ResultSize ] + [-StartDate ] + [-Summary] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Notification +``` + +This example displays a summary list of all notification events. + +### Example 2 +```powershell +Get-Notification -ProcessType Migration +``` + +This example displays a summary list of all mailbox move and migration notification events. + +### Example 3 +```powershell +Get-Notification -Identity 0259ec74-3539-4195-ab4f-de93e654ceaf | Format-List +``` + +This example displays detailed information for the specified notification event. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the notification event that you want to view. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. + +```yaml +Type: EwsStoreObjectIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Settings +This parameter is available only in on-premises Exchange. + +The Settings switch includes the ProcessType and NotificationEmail property values in the results. You don't need to specify a value with this switch. + +You can only use this switch with the ProcessType parameter value CertExpiry. + +You can't use this switch with the Summary switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Settings +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessType +The ProcessType parameter filters the results by the type of notification event. Valid values are: + +- CertExpiry +- ExportPST +- ImportPST +- MailboxRestore +- Migration + +```yaml +Type: AsyncOperationType +Parameter Sets: Settings +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: AsyncOperationType +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Summary +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, Filter +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md b/exchange/exchange-ps/exchange/Get-OMEConfiguration.md new file mode 100644 index 0000000000..801c20e7db --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OMEConfiguration.md @@ -0,0 +1,80 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-OMEConfiguration + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-OMEConfiguration cmdlet to view Microsoft Purview Message Encryption configurations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OMEConfiguration +``` + +This example returns a summary list of all OME configurations in the organization. + +### Example 2 +```powershell +Get-OMEConfiguration | Format-List +``` + +This example returns detailed information for all OME configurations in the organization. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md new file mode 100644 index 0000000000..1162642bbb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md @@ -0,0 +1,71 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-OMEMessageStatus + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-OMEMessageStatus cmdlet to view the Microsoft Purview Message Encryption revocation status for a specific message. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OMEMessageStatus -MessageId + [] +``` + +## DESCRIPTION +If encryption for the message was successfully revoked, the command will return the message: `The encrypted email with the subject "" and Message ID "" was successfully revoked`. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-OMEMessageStatus -MessageId "" +``` + +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, ""). + +You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md new file mode 100644 index 0000000000..274bd7b330 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md @@ -0,0 +1,185 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-OabVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-OabVirtualDirectory cmdlet to view offline address book (OAB) virtual directories(OAB distribution points) that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-OabVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-OabVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-OabVirtualDirectory +``` + +This example returns all OAB virtual directory web distribution points. + +### Example 2 +```powershell +Get-OabVirtualDirectory -Server MBX-01-007 +``` + +This example returns all OAB virtual directory web distribution points on the server named MBX-01-007. + +### Example 3 +```powershell +Get-OabVirtualDirectory -Identity "MBX-01-007\OAB*" | Format-List +``` + +This example returns detailed information for the OAB virtual directory named "OAB (Default Web Site)" on the server named MBX-01-007. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the OAB virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: + +- Name or Server\\Name +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md new file mode 100644 index 0000000000..dbf02a696b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md @@ -0,0 +1,150 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-OfflineAddressBook cmdlet to view offline address books (OABs). + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-OfflineAddressBook -Server + [-DomainController ] + [] +``` + +### Identity +``` +Get-OfflineAddressBook [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OfflineAddressBook +``` + +This example returns a summary list of all existing OABs. + +### Example 2 +```powershell +Get-OfflineAddressBook -Identity "\Default Offline Address Book" | Format-List +``` + +This example returns detailed information about the OAB named Default Offline Address Book. + +### Example 3 +```powershell +Get-OfflineAddressBook | Format-List Name,AddressLists,GeneratingMailbox,GUID +``` + +This example returns specific properties for all existing OABs, including the GeneratingMailbox property that specifies the arbitration mailbox that's responsible for generating the OAB. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example: + +- Name or \\Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Server parameter. + +```yaml +Type: OfflineAddressBookIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +This parameter is available only in on-premises Exchange. + +**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. + +The Server parameter returns all of the OABs that are generated by the specified Exchange 2010 or earlier server. You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- FQDN +- ExchangeLegacyDN +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md new file mode 100644 index 0000000000..18d268514c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md @@ -0,0 +1,88 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-OnPremisesOrganization + +## 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. + +For 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-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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-OnPremisesOrganization -Identity ExchangeMail | Format-List +``` + +This example retrieves the on-premises organization settings for ExchangeMail using the Identity parameter. + +### Example 2 +```powershell +Get-OnPremisesOrganization -DomainController 'mail.contoso.com' | Format-List +``` + +This example retrieves the on-premises organization settings by using the FQDN of the domain controller. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: + +- Canonical name +- GUID +- Name + +```yaml +Type: OnPremisesOrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md b/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md new file mode 100644 index 0000000000..57d2252911 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md @@ -0,0 +1,102 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-OnlineMeetingConfiguration + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Get-OnlineMeetingConfiguration cmdlet to view status and usage information about Skype Meetings and Skype for Business Online for mailboxes. Skype Meetings automatically includes Skype for Business Online conference join information in Exchange Online meeting invitations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OnlineMeetingConfiguration [-Identity] + [-DomainController ] + [] +``` + +## DESCRIPTION +Exchange Online maintains a per-user cache of Skype for Business Online meeting information that's updated every 24 hours. The Get-OnlineMeetingConfiguration cmdlet provides the following information about the Skype Meetings configuration and the Skype for Business Online meeting information for the user: + +- IsAutoOnlineMeetingEnabled: Indicates if Skype Meetings is enabled for the mailbox. +- OnlineMeetingInfo: Skype for Business Online meeting coordinates. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OnlineMeetingConfiguration -Identity carlam@fourthcoffee.com +``` + +This example gets the Skype Meetings configuration for the specified mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +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: 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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md b/exchange/exchange-ps/exchange/Get-OrganizationConfig.md new file mode 100644 index 0000000000..0d00218842 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OrganizationConfig.md @@ -0,0 +1,97 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-OrganizationConfig cmdlet to get configuration data for an Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OrganizationConfig -DomainController ContosoDC +``` + +This example gets the organization configuration information for the domain controller ContosoDC. + +### Example 2 +```powershell +Get-OrganizationConfig | Export-CliXML C:\Data\MyFile.xml +``` + +This example gets the configuration information for the cloud-based organization. + +For more information, see [Troubleshoot a hybrid deployment](https://learn.microsoft.com/exchange/hybrid-deployment/troubleshoot-a-hybrid-deployment). + +### Example 3 +```powershell +Get-OrganizationConfig | Format-List EwsApplicationAccessPolicy,Ews*List +``` + +This example shows the applications that are allowed access to EWS and REST. + +If the value of EwsApplicationAccessPolicy is EnforceAllowList, only the applications specified in EwsAllowList are allowed to access EWS and REST. + +If the value of EwsApplicationAccessPolicy is EnforceBlockList, all applications are allowed to access EWS and REST, except those specified in EwsBlockList. + +## PARAMETERS + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md new file mode 100644 index 0000000000..0c2f80f334 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md @@ -0,0 +1,103 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-OrganizationRelationship cmdlet to retrieve settings for an organization relationship that has been created for federated sharing with other federated Exchange organizations or for hybrid deployments with Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OrganizationRelationship [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OrganizationRelationship -Identity Contoso +``` + +This example retrieves the organization relationship settings for Contoso using the Identity parameter. + +### Example 2 +```powershell +Get-OrganizationRelationship -DomainController 'mail.contoso.com' +``` + +This example retrieves the organization relationship settings by using the FQDN of the domain controller. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the organizational relationship. You can use the following values: + +- Canonical name +- GUID +- Name + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md new file mode 100644 index 0000000000..12687a5a45 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md @@ -0,0 +1,92 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-OrganizationSegment + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-OrganizationSegment cmdlet to view organization segments in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### OrganizationSegmentsDefault (Default) +``` +Get-OrganizationSegment [] +``` + +### Identity +``` +Get-OrganizationSegment [[-Identity] ] + [] +``` + +## DESCRIPTION +Segments are defined by using certain [attributes](https://learn.microsoft.com/purview/information-barriers-attributes) in Microsoft Entra ID. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-OrganizationSegment | Format-List Name,UserGroupFilter +``` + +This example returns a summary list of all organization segments. + +### Example 2 +```powershell +Get-OrganizationSegment -Identity "Engineering Group" +``` + +This example returns detailed information about the organization segment named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- ExchangeObjectId (not the ExoSegmentId) + +```yaml +Type: PolicyIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-OrganizationalUnit.md b/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md similarity index 76% rename from exchange/exchange-ps/exchange/active-directory/Get-OrganizationalUnit.md rename to exchange/exchange-ps/exchange/Get-OrganizationalUnit.md index 1161e0cc52..01e951b29f 100644 --- a/exchange/exchange-ps/exchange/active-directory/Get-OrganizationalUnit.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-OrganizationalUnit @@ -13,16 +16,18 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OrganizationalUnit cmdlet to view a list of organizational units (OUs) that exist in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Get-OrganizationalUnit [[-Identity] ] [-SingleNodeOnly] +Get-OrganizationalUnit [[-Identity] ] + [-SingleNodeOnly] [-DomainController ] [-IncludeContainers] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ### Search @@ -30,33 +35,34 @@ Get-OrganizationalUnit [[-Identity] ] [-S Get-OrganizationalUnit [-SearchText ] [-DomainController ] [-IncludeContainers] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-OrganizationalUnit "North America" -SingleNodeOnly | Format-Table Name, DistinguishedName ``` This example retrieves a list of the first level child OUs beneath the North America OU and formats the output so that only the Name and DistinguishedName properties are displayed. -For more information about pipelining and the Format-Table cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). +For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-OrganizationalUnit -SearchText "Executives" | Format-Table Name, DistinguishedName ``` This example retrieves a list of OUs that match the text string "Executives" and formats the output so that only the Name and DistinguishedName properties are displayed. -For more information about pipelining and the Format-Table cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). +For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS @@ -64,11 +70,8 @@ For more information about pipelining and the Format-Table cmdlet, see Pipelinin 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 - - Canonical name - - Distinguished name (DN) - - GUID You can use this parameter with the SearchText parameter. @@ -78,6 +81,7 @@ 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 Default value: None @@ -95,6 +99,7 @@ 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 @@ -110,6 +115,7 @@ 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 @@ -125,6 +131,7 @@ 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 Default value: None @@ -140,6 +147,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -157,6 +165,7 @@ Type: String Parameter Sets: Search Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -165,20 +174,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/ec2d1cc9-863f-47f1-b235-57f2a2835437.aspx) diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnector.md b/exchange/exchange-ps/exchange/Get-OutboundConnector.md new file mode 100644 index 0000000000..ef832c3069 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OutboundConnector.md @@ -0,0 +1,140 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-OutboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-OutboundConnector cmdlet to view the configuration information for an Outbound connector in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OutboundConnector [[-Identity] ] + [-IncludeTestModeConnectors ] + [-IsTransportRuleScoped ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Outbound connectors send email messages to remote domains that require specific configuration options. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-OutboundConnector "Contoso Outbound Connector" | Format-List +``` + +This example displays detailed information about the Outbound connector named Contoso Outbound Connector. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: OutboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -IncludeTestModeConnectors +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. + +You configure an Outbound connector in test mode by using the TestMode parameter on the New-OutboundConnector or Set-OutboundConnector cmdlets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsTransportRuleScoped +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. + +You scope a transport rule to a specific Outbound connector by using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md b/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md new file mode 100644 index 0000000000..a111c53994 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-OutboundConnectorReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-OutboundConnectorReport cmdlet to view the Outbound connectors that are used to deliver mail to specific domains. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OutboundConnectorReport [-Domain ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OutboundConnectorReport -Domain contoso.com +``` + +This example shows the Outbound connector that's used to deliver mail to the contoso.com domain. + +## PARAMETERS + +### -Domain +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md new file mode 100644 index 0000000000..e2189d867d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md @@ -0,0 +1,178 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-OutlookAnywhere + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-OutlookAnywhere cmdlet to view Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-OutlookAnywhere -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-OutlookAnywhere [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-OutlookAnywhere -Server MBX01 +``` + +This example returns all Outlook Anywhere virtual directories on the server named MBX01. + +### Example 2 +```powershell +Get-OutlookAnywhere -Identity "EXCH01\Rpc (Default Web Site)" +``` + +This example returns information about the Outlook Anywhere virtual directory named Rpc on the default web site of the server named EXCH01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md new file mode 100644 index 0000000000..ed2ad0aa94 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md @@ -0,0 +1,105 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-OutlookProtectionRule + +## 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. + +Use the Get-OutlookProtectionRule cmdlet to retrieve Microsoft Outlook protection rules configured in an organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OutlookProtectionRule [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OutlookProtectionRule +``` + +This example gets details of all Outlook protection rules configured in the organization. + +### Example 2 +```powershell +Get-OutlookProtectionRule ProjectContoso | Format-List +``` + +This example gets all properties of the Outlook protection rule ProjectContoso. + +The Identity parameter is positional. When used after the cmdlet name, the parameter value can be specified without providing the parameter label. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OutlookProvider.md b/exchange/exchange-ps/exchange/Get-OutlookProvider.md new file mode 100644 index 0000000000..72b2e977b7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OutlookProvider.md @@ -0,0 +1,103 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-OutlookProvider + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-OutlookProvider cmdlet to obtain the global settings from the AutoDiscoverConfig object under the Global Settings object in Active Directory. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OutlookProvider [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OutlookProvider +``` + +This example returns a summary list of all available Outlook providers. + +### Example 2 +```powershell +Get-OutlookProvider -Identity WEB | Format-List +``` + +This example returns detailed information for the Outlook provider named WEB. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the ADIDParameter value of the MAPI protocol that you want to view. Typical values are: + +- EXCH +- EXPR +- WEB + +```yaml +Type: OutlookProviderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md new file mode 100644 index 0000000000..d3d81a63ed --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md @@ -0,0 +1,110 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-OwaMailboxPolicy cmdlet to view Outlook on the web mailbox policies in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-OwaMailboxPolicy [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OwaMailboxPolicy +``` + +This example retrieves a summary list of all mailbox policies in the organization. + +### Example 2 +```powershell +Get-OwaMailboxPolicy -Identity Executives | Format-List +``` + +This example retrieves detailed information for the mailbox policy named Executives. + +### Example 3 +```powershell +Get-OwaMailboxPolicy -Identity Proseware\Contoso\Corporate +``` + +This example retrieves the information for the mailbox policy named Corporate for the tenant Contoso in the organization Proseware. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md new file mode 100644 index 0000000000..6087a13fe7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md @@ -0,0 +1,189 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-OwaVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-OwaVirtualDirectory cmdlet to view Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-OwaVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-OwaVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +The Get-OwaVirtualDirectory cmdlet can be run on a local server or run remotely if the server name is specified in the Identity or Server parameters. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-OwaVirtualDirectory -Server Contoso +``` + +This example returns a summary list of all Outlook on the web virtual directories on the server named Contoso. + +### Example 2 +```powershell +Get-OwaVirtualDirectory -Identity "Contoso\owa*" | Format-List +``` + +This example returns detailed information for the Outlook on the web virtual directory named "owa (Default Web site)" on the server named Contoso. + +### Example 3 +```powershell +Get-OwaVirtualDirectory +``` + +This example returns a summary list of all Outlook on the web virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PartnerApplication.md b/exchange/exchange-ps/exchange/Get-PartnerApplication.md new file mode 100644 index 0000000000..1e1e76f5db --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PartnerApplication.md @@ -0,0 +1,113 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PartnerApplication cmdlet to retrieve settings for a partner application. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PartnerApplication [[-Identity] ] + [-DomainController ] + [-Organization ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PartnerApplication | Format-List * +``` + +This example retrieves settings for all partner applications configured in Exchange and pipes them to the Format-List cmdlet to display all properties in a list view. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md b/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md new file mode 100644 index 0000000000..ca13e8b6fa --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingdelicenseuser +applicable: Exchange Online, Exchange Online Protection +title: Get-PendingDelicenseUser +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PendingDelicenseUser + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-PendingDelicenseUser cmdlet to view information about mailboxes that have delayed mailbox license removal requests. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-PendingDelicenseUser [[-Identity] ] + [] +``` + +### TenantLevelParameterSet +``` +Get-PendingDelicenseUser [-ResultSize ] [-ShowDueObjectsOnly] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PendingDelicenseUser | Format-Table DisplayName,UserPrincipalName,WhenDueForDelicensingUTC +``` + +This example returns a summary list of all mailboxes that have pending mailbox license removal requests. + +### Example 2 +```powershell +Get-PendingDelicenseUser -Identity yajvendra@contoso.onmicrosoft.com +``` + +This example returns detailed information about the pending mailbox license removal request for the specified mailbox. + +### Example 3 +```powershell +Get-PendingDelicenseUser -ShowDueObjectsOnly | Format-Table DisplayName,UserPrincipalName,WhenDueForDelicensingUTC +``` + +This example returns a summary list of all mailboxes where the 30 day delay for mailbox license removal requests has ended, so the licenses can be removed from the mailboxes at any time. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox with a pending mailbox license removal request. + +You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Email address +- GUID +- LegacyExchangeDN +- User ID or user principal name (UPN) + +You can't use this parameter with the ShowDueObjectsOnly switch. + +```yaml +Type: RecipientIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: TenantLevelParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowDueObjectsOnly +The ShowDueObjectsOnly switch filters the results by mailboxes where the 30 day delay for removing the license has ended, and the license can be removed from the mailbox at any time. You don't need to specify a value with this switch. + +You can't use this switch with the Identity parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: TenantLevelParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md b/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md new file mode 100644 index 0000000000..e646d32251 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md @@ -0,0 +1,56 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PendingFederatedDomain + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +The Get-PendingFederatedDomain cmdlet is used by the Exchange admin center to display a list of pending federated domains for the federation trust for your Exchange organization. You shouldn't use this cmdlet to attempt to manually configure a federation trust. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PendingFederatedDomain +``` + +This example retrieves the pending federated domain information for the federation trust for your Exchange organization. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md b/exchange/exchange-ps/exchange/Get-PerimeterConfig.md new file mode 100644 index 0000000000..0559a00b0d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PerimeterConfig.md @@ -0,0 +1,73 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-PerimeterConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-PerimeterConfig cmdlet to view the list of gateway server and internal mail server IP addresses that have been added to the cloud-based safelists. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PerimeterConfig [[-Identity] ] + [] +``` + +## DESCRIPTION +If you have an on-premises email system, you can use the Set-PerimeterConfig cmdlet to add the IP addresses of your gateway servers to cloud-based safelists (also known as whitelists) to make sure that messages sent from your on-premises email system aren't treated as spam. + +## EXAMPLES + +### Example 1 +```powershell +Get-PerimeterConfig +``` + +This example returns the list of gateway servers and internal email servers in your organization that have been added to cloud-based safelists. + +## PARAMETERS + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md new file mode 100644 index 0000000000..7cb3d2c953 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md @@ -0,0 +1,87 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-PhishSimOverridePolicy + +## 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). + +For 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-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PhishSimOverridePolicy +``` + +This example returns detailed information about the one and only phishing simulation override policy. + +## PARAMETERS + +### -Identity +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 +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Place.md b/exchange/exchange-ps/exchange/Get-Place.md new file mode 100644 index 0000000000..c13137555b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Place.md @@ -0,0 +1,173 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-Place + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-Place cmdlet to view the additional metadata that was configured on room mailboxes by using the Set-Place cmdlet. The additional metadata provides a better search and room suggestion experience. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-Place [[-Identity] ] + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +### AllPlaces +``` +Get-Place [-Type ] + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-Place -Identity "Conference Room 01" +``` + +This example returns summary metadata for the room mailbox named Conference Room 1. + +### Example 2 +```powershell +Get-Place -Identity "Conference Room 01" | Format-List +``` + +This example returns detailed metadata for Conference Room 1. + +### Example 3 +```powershell +Get-Place -Type Room +``` + +This example returns all room mailboxes. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can't use this parameter with the Type parameter. + +```yaml +Type: RecipientIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Type parameter filters the results by the type of room mailbox. Valid values are: + +- Room +- RoomList +- Space + +You can't use this parameter with the Identity parameter. + +```yaml +Type: GetPlaceType +Parameter Sets: AllPlaces +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PolicyConfig.md b/exchange/exchange-ps/exchange/Get-PolicyConfig.md new file mode 100644 index 0000000000..7b985e28c4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PolicyConfig.md @@ -0,0 +1,66 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-PolicyConfig + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-PolicyConfig cmdlet to view the endpoint restrictions that are configured in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PolicyConfig [[-Identity] ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PolicyConfig +``` + +This example returns the endpoint restrictions that are available in the organization. + +## PARAMETERS + +### -Identity +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md new file mode 100644 index 0000000000..0704474cc3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md @@ -0,0 +1,185 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PolicyTipConfig cmdlet to view the data loss prevention (DLP) Policy Tips in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Parameters +``` +Get-PolicyTipConfig [-Action ] + [-Locale ] + [-Original] + [-DomainController ] + [] +``` + +### Identity +``` +Get-PolicyTipConfig [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PolicyTipConfig -Action NotifyOnly +``` + +This example returns a summary list of the custom Policy Tips in all languages that have the action value NotifyOnly. + +### Example 2 +```powershell +Get-PolicyTipConfig -Original -Locale fr +``` + +This example returns a summary list of all built-in French Policy Tips. + +### Example 3 +```powershell +Get-PolicyTipConfig en\RejectOverride | Format-List +``` + +This example returns details about the custom English Policy Tip for the action value RejectOverride. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: + +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- The value Url +- GUID +- Distinguished name (DN) + +You can't use the Identity parameter with the Action, Locale or Original parameters. + +```yaml +Type: PolicyTipConfigIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Action +The Action parameter filters the Policy Tips by action. Valid values for this parameter are: + +- NotifyOnly +- RejectOverride +- Reject + +You can't use the value Url with the Action parameter. Instead, use command: Get-PolicyTipConfig Url. + +You can't use the Action parameter with the Identity parameter. + +```yaml +Type: PolicyTipMessageConfigAction +Parameter Sets: Parameters +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +The Locale parameter specifies a locale-specific version of the Policy Tip. + +Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). + +You can't use the Locale parameter with the Identity parameter. + +```yaml +Type: CultureInfo +Parameter Sets: Parameters +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Original +The Original switch specifies whether to include built-in Policy Tips in the results. You don't need to specify a value with this switch. + +You can't use the Original switch with the Identity parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: Parameters +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PopSettings.md b/exchange/exchange-ps/exchange/Get-PopSettings.md new file mode 100644 index 0000000000..4223b39960 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PopSettings.md @@ -0,0 +1,104 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PopSettings + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-POPSettings cmdlet to view the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed and is used by POP3 clients to connect to Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PopSettings [-DomainController ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-POPSettings +``` + +This example returns a summary list of the configuration of the Microsoft Exchange POP3 service on the local server. + +### Example 2 +```powershell +Get-POPSettings -Server MBX01 | Format-List +``` + +This example returns detailed information for the Microsoft Exchange POP3 service on the server named MBX01. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md new file mode 100644 index 0000000000..b46a6dbd1e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md @@ -0,0 +1,185 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PowerShellVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-PowerShellVirtualDirectory cmdlet to view Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-PowerShellVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-PowerShellVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-PowerShellVirtualDirectory -Server Server01 +``` + +This example retrieves a summary list of all PowerShell virtual directories on the server named Server01. + +### Example 2 +```powershell +Get-PowerShellVirtualDirectory -Identity "Server01\PowerShell*" | Format-List +``` + +This example returns detailed information for the PowerShell virtual directory named "PowerShell (Default Web site)" on the server named Server01. + +### Example 3 +```powershell +Get-PowerShellVirtualDirectory +``` + +This example returns a summary list of all PowerShell virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md new file mode 100644 index 0000000000..2e99bc420c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md @@ -0,0 +1,95 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ProtectionAlert + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-ProtectionAlert cmdlet to view alert policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ProtectionAlert [[-Identity] ] + [-IncludeRuleXml] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ProtectionAlert | Format-List Name,Category,Comment,NotifyUser +``` + +This example returns a summary list of all alert policies. + +### Example 2 +```powershell +Get-ProtectionAlert -Identity "Malware campaign detected after delivery" +``` + +This example returns detailed information about the specified alert policy. + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -IncludeRuleXml +{{ Fill IncludeRuleXml Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolder.md b/exchange/exchange-ps/exchange/Get-PublicFolder.md similarity index 76% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolder.md rename to exchange/exchange-ps/exchange/Get-PublicFolder.md index d6c21bd22b..6236c3d432 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolder.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-PublicFolder @@ -13,30 +16,34 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### GetChildren ``` -Get-PublicFolder [[-Identity] ] [-GetChildren] +Get-PublicFolder [[-Identity] ] + [-GetChildren] [-DomainController ] [-Mailbox ] [-Organization ] [-ResidentFolders] [-ResultSize ] - [-Server ] [] + [-Server ] + [] ``` ### Recurse ``` -Get-PublicFolder [[-Identity] ] [-Recurse] +Get-PublicFolder [[-Identity] ] + [-Recurse] [-DomainController ] [-Mailbox ] [-Organization ] [-ResidentFolders] [-ResultSize ] - [-Server ] [] + [-Server ] + [] ``` ### LostAndFound @@ -46,7 +53,8 @@ Get-PublicFolder [-LostAndFound] [-Mailbox ] [-Organization ] [-ResidentFolders] - [-ResultSize ] [] + [-ResultSize ] + [] ``` ### Identity @@ -56,51 +64,52 @@ Get-PublicFolder [[-Identity] ] [-Mailbox ] [-Organization ] [-ResidentFolders] - [-Server ] [] + [-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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-PublicFolder ``` This example uses the Get-PublicFolder command without parameters to return the root public folder object (IPM\_SUBTREE). -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-PublicFolder -Identity \NON_IPM_SUBTREE -Recurse | Format-List Name ``` This example returns the names of all the system folders (which aren't shown by default), starting at the system folder root (\\NON\_IPM\_SUBTREE). -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation" ``` This example returns the Pending Litigation public folder from \\Legal\\Documents\\. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation" -Recurse ``` This example returns the Pending Litigation public folder from \\Legal\\Documents\\ and all the public folders under the Pending Litigation public folder. Because the result size isn't specified, the command returns up to the maximum number of public folders, which is 10,000. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation" -Recurse -ResultSize Unlimited ``` This example returns the Pending Litigation public folder from \\Legal\\Documents\\ and all the public folders under the Pending Litigation public folder, without a limit on the number returned. -### -------------------------- Example 6 -------------------------- -``` +### Example 6 +```powershell Get-PublicFolder -Mailbox "Legal Department" -ResidentFolders ``` @@ -108,6 +117,22 @@ This example returns the public folders that reside in the public folder content ## PARAMETERS +### -Identity +The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: GetChildren, Recurse, Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -GetChildren The GetChildren switch specifies whether to return only the children of the folder specified by the Identity parameter. You don't need to specify a value with this switch. @@ -118,6 +143,7 @@ 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 Default value: None @@ -135,6 +161,7 @@ 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 Default value: None @@ -152,6 +179,7 @@ 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 @@ -159,21 +187,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: \\\\\\\\...\\\\\\. For example, "\\Customer Discussion" or "\\Engineering\\Customer Discussion". - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: GetChildren, Recurse, Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -LostAndFound The LostAndFound switch specifies whether to return only orphaned folders that are located in \\NON\_IPM\_SUBTREE\\LOST\_AND\_FOUND. You don't need to specify a value with this switch. @@ -186,6 +199,7 @@ Type: SwitchParameter Parameter Sets: LostAndFound Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -194,30 +208,17 @@ Accept wildcard characters: False ``` ### -Mailbox -The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. You can use any value that uniquely identifies the mailbox. - -For example: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -225,6 +226,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -242,6 +244,7 @@ Type: OrganizationIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -250,13 +253,16 @@ Accept wildcard characters: False ``` ### -ResidentFolders -The ResidentFolders specifies whether to return public folders that reside in a specific content public folder mailbox. If this parameter isn't specified, the command will only return public folders whose contents reside in the primary hierarchy public folder mailbox. +The ResidentFolders switch specifies whether to return public folders that reside in a specific content public folder mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, the command will return only public folders whose contents reside in the primary hierarchy public folder mailbox. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -272,6 +278,7 @@ 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 Default value: None @@ -280,15 +287,21 @@ Accept wildcard characters: False ``` ### -Server -This parameter is available or functional only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. -The Server parameter specifies the server on which to perform the selected operations. +The Server parameter filters the results by the specified Exchange server. 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: GetChildren, Recurse, Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -297,20 +310,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/409711bc-6249-41d4-bf86-50e01240e69f.aspx) diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md new file mode 100644 index 0000000000..8827234280 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md @@ -0,0 +1,190 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-PublicFolderAdministrativePermission + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-PublicFolderAdministrativePermission cmdlet to get the administrative permissions for a public folder or a public folder hierarchy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-PublicFolderAdministrativePermission [-Identity] [-User ] + [-DomainController ] + [-Server ] + [] +``` + +### Owner +``` +Get-PublicFolderAdministrativePermission [-Identity] [-Owner] + [-DomainController ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderAdministrativePermission -Identity "\My Public Folder" +``` + +This example retrieves the administrative permissions for all users of the public folder My Public Folder. + +### Example 2 +```powershell +Get-PublicFolderAdministrativePermission -Identity "\My Public Folder" -User Chris -Server "My Server" | Format-List +``` + +This example retrieves the administrative permissions for the public folder My Public Folder, for the user Chris, on the server My Server. In this example, the output of the Get-PublicFolderAdministrativePermission command is piped to the Format-List command so that all the available information is displayed in the result. + +### Example 3 +```powershell +Get-PublicFolderAdministrativePermission -Identity "\My Public Folder" -Owner +``` + +This example retrieves the owner of the public folder My Public Folder. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Owner +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Owner +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -User +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 +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Owner switch. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md new file mode 100644 index 0000000000..cbf1b56f79 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md @@ -0,0 +1,198 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PublicFolderClientPermission cmdlet to retrieve the user permissions for a public folder. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PublicFolderClientPermission [-Identity] + [-DomainController ] + [-ResultSize ] + [-Server ] + [-User ] + [-Mailbox ] + [] +``` + +## DESCRIPTION +To view the permissions that are available on public folders, see [Public folder permissions for Exchange Server](https://support.microsoft.com/help/2573274). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderClientPermission "\My Public Folder" +``` + +This example retrieves the permissions for all users of \\My Public Folder. + +### Example 2 +```powershell +Get-PublicFolderClientPermission -Identity "\My Public Folder" -User Chris | Format-List +``` + +This example retrieves the permissions for the public folder My Public Folder, for the user Chris. In this example, the output of the Get-PublicFolderClientPermission command is piped to the Format-List command so that all available information is displayed in the result. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All)) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +This parameter is available only in Exchange Server 2010. + +The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the user for whom you want to view the permissions on the public folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +```yaml +Type: PublicFolderUserIdParameter +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 +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +By default, the permissions are returned from the primary public folder mailbox. Using this parameter allows you to specify a different public folder mailbox. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md new file mode 100644 index 0000000000..163d873ee4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md @@ -0,0 +1,205 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PublicFolderDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-PublicFolderDatabase cmdlet to view public folder database settings for Microsoft Exchange Server 2010 or earlier public folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-PublicFolderDatabase -Server + [-DomainController ] + [-IncludePreExchange2010] + [-Status] + [-IncludeCorrupted] + [] +``` + +### Identity +``` +Get-PublicFolderDatabase [[-Identity] ] + [-DomainController ] + [-IncludePreExchange2010] + [-Status] + [-IncludeCorrupted] + [] +``` + +## DESCRIPTION +You can specify either the Server or Identity parameter, but not both. Only the Server and Identity parameters can be piped. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderDatabase | Format-List +``` + +This example returns all the attributes of all the public folder databases in the organization by piping the results of the Get-PublicFolderDatabase command to the Format-List command. + +### Example 2 +```powershell +Get-PublicFolderDatabase -Identity "Server01\PFDatabase" +``` + +This example returns information about the public folder database PFDatabase that resides on Server01. + +### Example 3 +```powershell +Get-PublicFolderDatabase -Server Server01 +``` + +This example returns information about all public folders on Server01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +You can't the Identity and Server parameters in the same command. + +If you have multiple databases with the same name, the cmdlet retrieves all databases with the same name in the specified scope. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 +``` + +### -IncludePreExchange2010 +This parameter is available only in Exchange Server 2010. + +The IncludePreExchange2010 switch specifies whether to include information about Exchange 2003 or Exchange 2007 public folders in the results. You don't need to specify a value with this switch. + +This switch isn't useful in commands where you use the Server or Identity parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeCorrupted +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md new file mode 100644 index 0000000000..7e8d13e1d4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md @@ -0,0 +1,183 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PublicFolderItemStatistics cmdlet to view information about items within a specified public folder. Information returned includes subject, last modification time, creation time, attachments, message size, and the type of item. You can use this raw information to better understand the distribution of items and item characteristics across public folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PublicFolderItemStatistics [-Identity] + [-DomainController ] + [-ResultSize ] + [-Server ] + [-Mailbox ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderItemStatistics -Identity "\Marketing\2013\Pamphlets" +``` + +This example returns default statistics for all items in the Pamphlets public folder under the \\Marketing\\2013 path. Default information includes item identity, creation time and subject. + +### Example 2 +```powershell +Get-PublicFolderItemStatistics -Identity "\Marketing\2013\Pamphlets" | Format-List +``` + +This example returns additional information about the items within the public folder, such as subject, last modification time, creation time, attachments, message size and the type of item by piping the results of the Get-PublicFolderItemStatistics command to the Format-List command. + +### Example 3 +```powershell +Get-PublicFolderItemStatistics -Identity "\Marketing\Reports" | Select Subject,LastModificationTime,HasAttachments,ItemType,MessageSize | Export-CSV C:\PFItemStats.csv +``` + +This example exports the output of the Get-PublicFolderItemStatistics command to the PFItemStats.csv file that includes the following information for all items within the public folder \\Marketing\\Reports: + +- Subject of the message (Subject) +- Date and time when the item was last modified (LastModificationTime) +- If the item has attachments (HasAttachments) +- Type of item (ItemType) +- Size of the item (MessageSize) + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All)) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +This parameter is available only in Exchange Server 2010. + +The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md new file mode 100644 index 0000000000..d7b0c82238 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md @@ -0,0 +1,196 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PublicFolderMailboxDiagnostics cmdlet to view event-level information about a public folder mailbox. This information can be used to troubleshoot public folder issues. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PublicFolderMailboxDiagnostics [-Identity] + [-Confirm] + [-DomainController ] + [-IncludeDumpsterInfo] + [-IncludeHierarchyInfo] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderMailboxDiagnostics -Identity "Customer Escalations" +``` + +This example returns the diagnostic information for the public folder mailbox Customer Escalations. + +### Example 2 +```powershell +Get-PublicFolderMailboxDiagnostics -Identity "Sales Forecasts" | Export-CSV C:\Diagnostics\SalesForecasts.csv +``` + +This example returns the diagnostic information for the public folder mailbox Sales Forecasts and exports the report to a CSV file. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDumpsterInfo +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHierarchyInfo +The IncludeHierarchyInfo switch specifies whether to include folder hierarchy information in the results. You don't need to specify a value with this switch. + +Using this switch returns the following information: + +- TotalFolderCount: The total number of public folders in the specified public folder mailbox. +- MaxFolderChildCount: The largest number of child folders in the public folder hierarchy. +- HierarchyDepth: The depth of the public folder hierarchy. The root folder is 0. +- CalendarFolderCount: The number of calendar public folders. +- ContactFolderCount: The number of calendar public folders. +- MailPublicFolderCount: The number of mail-enabled public folders. +- NoteFolderCount: The number of note public folders. +- StickyNoteFolderCount: The number of sticky note public folders. +- TaskFolderCount: The number of task public folders. +- OtherFolderCount: The number of public folders that don't match any of the previously defined public folder types. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md similarity index 78% rename from exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md index ba391d99e2..4fe2797ff4 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-PublicFolderMailboxMigrationRequest @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderMailboxMigrationRequest cmdlet to view the status of individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,12 +24,12 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Get-PublicFolderMailboxMigrationRequest [-BatchName ] [-DomainController ] - [-HighPriority <$true | $false>] + [-HighPriority ] [-Name ] [-RequestQueue ] [-ResultSize ] - [-Status ] - [-Suspend <$true | $false>] + [-Status ] + [-Suspend ] [] ``` @@ -42,33 +45,70 @@ Get-PublicFolderMailboxMigrationRequest [[-Identity] ` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). + +You can't use this parameter with the following parameters: + +- BatchName +- HighPriority +- Name +- RequestQueue +- Suspend +- Status + +```yaml +Type: PublicFolderMailboxMigrationRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -BatchName -The BatchName parameter filters the results by the friendly BatchName value that was assigned when the batch job was created. The format of this value is: MigrationService:\. +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. @@ -77,6 +117,7 @@ Type: String Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -94,6 +135,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -107,16 +149,16 @@ 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: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. - - $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,37 +166,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: \\PublicFolderMailboxMigration\ (for example, \\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e). - -You can't use this parameter with the following parameters: - -- BatchName - -- HighPriority - -- Name - -- RequestQueue - -- Suspend - -- Status - -```yaml -Type: PublicFolderMailboxMigrationRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Name -The Name parameter specifies the name of the public folder mailbox migration request. If the name was not specified at creation, the default value is PublicFolderMailboxMigration\ (for example, PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8). +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. @@ -163,6 +176,7 @@ Type: String Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -175,9 +189,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -186,6 +200,7 @@ Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -201,6 +216,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -212,32 +228,24 @@ Accept wildcard characters: False The Status parameter filters the results based on status. You can use the following values: - AutoSuspended - - Completed - - CompletedWithWarning - - CompletionInProgress - - Failed - - InProgress - - Queued - - Retrying - - Suspended - - Synced You can't use this parameter with the Identity parameter. ```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed +Type: RequestStatus Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -251,10 +259,11 @@ The Suspend parameter specifies whether to return requests that have been suspen You can't use this parameter with the Identity parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Filtering Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -263,20 +272,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/27e715ca-1b64-493b-8f78-24d29a7b6b0a.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md similarity index 82% rename from exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md rename to exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md index 6b676a1130..cb164285ad 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-PublicFolderMailboxMigrationRequestStatistics @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderMailboxMigrationRequestStatistics cmdlet to view the detailed status of individual jobs in a public folder migration batch created using New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,6 +36,7 @@ Get-MailboxRestoreRequestStatistics [-Identity] [-DiagnosticInfo ] [-IncludeReport] + [-IncludeSkippedItems] [-ReportOnly] [] ``` @@ -53,19 +57,16 @@ Get-MailboxRestoreRequestStatistics -RequestQueue The Get-PublicFolderMailboxMigrationRequestStatistics cmdlet displays the following properties by default. - Name: The name assigned by the system to a specific mailbox migration job. - - StatusDetail: The current status of the job. - - 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-PublicFolderMailboxMigrationRequestStatistics -Identity \PublicFolderMailboxMigration4ce124b0-d760-4364-94bc-40d7918fd171 ``` @@ -74,7 +75,7 @@ This example uses the Identity parameter to return information about the specifi ## PARAMETERS ### -Identity -The Identity parameter specifies the public folder mailbox migration request. The default identity value is \\PublicFolderMailboxMigration\ (for example, \\PublicFolderMailboxMigration\ac6d9eb4-ee49-405f-b90d-04e9a258bd7e). +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,6 +84,7 @@ Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -97,9 +99,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -108,6 +110,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -118,13 +121,16 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -142,6 +148,7 @@ Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -159,6 +166,7 @@ Type: String Parameter Sets: IdentityCloud Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -176,6 +184,7 @@ Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -184,13 +193,32 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -206,6 +234,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -225,6 +254,7 @@ Type: Guid Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -233,20 +263,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0c34d326-5a8c-426e-bbb6-eab477f2aab7.aspx) diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md new file mode 100644 index 0000000000..c001744a6d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md @@ -0,0 +1,262 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PublicFolderMigrationRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-PublicFolderMigrationRequest cmdlet to view information about serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filtering +``` +Get-PublicFolderMigrationRequest + [-BatchName ] + [-DomainController ] + [-HighPriority ] + [-Name ] + [-RequestQueue ] + [-ResultSize ] + [-Status ] + [-Suspend ] + [] +``` + +### Identity +``` +Get-PublicFolderMigrationRequest [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderMigrationRequest +``` + +This example returns the status of in-progress migration requests. + +### Example 2 +```powershell +Get-PublicFolderMigrationRequest -Identity "PFMigrate10_11_12" | Format-List Suspended,AutoSuspended +``` + +This example returns all migration requests that have the name PFMigrate10\_11\_12 and the request has been suspended. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the public folder migration request that you want to view. You can use the following values: + +- GUID +- Name + +You can't use this parameter with other filtering parameters (BatchName, HighPriority, Name, RequestQueue, Status, or Suspend). + +```yaml +Type: PublicFolderMigrationRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BatchName +The BatchName parameter specifies the name that was given to a batch migration request. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: String +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighPriority +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. +- $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: Boolean +Parameter Sets: Filtering +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 +``` + +### -Name +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. + +```yaml +Type: String +Parameter Sets: Filtering +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 +``` + +### -RequestQueue +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 +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Filtering +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 +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status parameter filters the results based on status. You can use the following values: + +- AutoSuspended +- Completed +- CompletedWithWarning +- CompletionInProgress +- Failed +- InProgress +- Queued +- Retrying +- Suspended +- Synced + +You can't use this parameter with the Identity parameter. + +```yaml +Type: RequestStatus +Parameter Sets: Filtering +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 +``` + +### -Suspend +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. + +```yaml +Type: Boolean +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md new file mode 100644 index 0000000000..2ef492d5cb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md @@ -0,0 +1,230 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PublicFolderMigrationRequestStatistics + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-PublicFolderMigrationRequestStatistics cmdlet to view detailed information about serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-PublicFolderMigrationRequestStatistics [-Identity] + [-Diagnostic] + [-Diagnostic ] + [-DiagnosticArgument ] + [-DomainController ] + [-IncludeReport] + [-ReportOnly] + [] +``` + +### MigrationRequestQueue +``` +Get-PublicFolderMigrationRequestStatistics -RequestQueue + [-RequestGuid ] + [-Diagnostic] + [-DiagnosticArgument ] + [-DomainController ] + [-IncludeReport] + [-ReportOnly] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderMigrationRequestStatistics -RequestQueue "MBXDB02" +``` + +This example returns default statistics for all migration requests that are in progress or haven't been cleared for the database MBXDB02. + +### Example 2 +```powershell +Get-PublicFolderMigrationRequestStatistics -Identity "PFMigrate_MarketingReports" -IncludeReport | Export-CSV C:\PFMigstats.csv +``` + +This example returns additional information about the migration request and exports the report to a CSV file. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the migration request that you want to view. You can use the following values: + +- Name +- RequestGUID + +You can't use this parameter with the RequestQueue or RequestGuid parameter. + +```yaml +Type: PublicFolderMigrationRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RequestQueue +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Diagnostic +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticArgument +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 +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeReport +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportOnly +The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestGuid +The RequestGuid parameter specifies the GUID of a migration request. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: Guid +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md new file mode 100644 index 0000000000..5d234a047b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md @@ -0,0 +1,302 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PublicFolderMoveRequest cmdlet to view the detailed status of an ongoing public folder move that was initiated using the New-PublicFolderMoveRequest cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-PublicFolderMoveRequest [[-Identity] ] + [-AccountPartition ] + [-DomainController ] + [-Organization ] + [-ResultSize ] + [] +``` + +### Filtering +``` +Get-PublicFolderMoveRequest [-BatchName ] [-HighPriority ] [-Name ] [-RequestQueue ] [-Status ] [-Suspend ] + [-AccountPartition ] + [-DomainController ] + [-Organization ] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderMoveRequest -Identity \PublicFolderMove +``` + +This example returns the status of an in-progress public folder move request with the identity \\PublicFolderMove, which is the default name assigned to public folder moves. + +### Example 2 +```powershell +Get-PublicFolderMoveRequest -RequestQueue MBD01 +``` + +This example returns the status of in-progress and queued requests that are on the source database MBD01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the public folder move request. The default identity assigned to public folder move requests is \\PublicFolderMove. + +You can't use this parameter with the following parameters: + +- BatchName +- HighPriority +- Name +- RequestQueue +- Suspend +- Status + +```yaml +Type: PublicFolderMoveRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccountPartition +This parameter is available only in the cloud-based service. + +{{ Fill AccountPartition Description }} + +```yaml +Type: AccountPartitionIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchName +The BatchName parameter specifies the name that was given to a batch public folder move request. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: String +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighPriority +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. +- $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: Boolean +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: String +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is available only in the cloud-based service. + +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestQueue +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 +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Status +The Status parameter filters the results based on status. You can use the following values: + +- AutoSuspended +- Completed +- CompletedWithWarning +- CompletionInProgress +- Failed +- InProgress +- Queued +- Retrying +- Suspended +- Synced + +You can't use this parameter with the Identity parameter. + +```yaml +Type: RequestStatus +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +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. + +```yaml +Type: Boolean +Parameter Sets: Filtering +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md new file mode 100644 index 0000000000..475fc29578 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md @@ -0,0 +1,265 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PublicFolderMoveRequestStatistics cmdlet to view detailed information about public folder move requests. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-PublicFolderMoveRequestStatistics [-Identity] + [-Diagnostic] + [-DiagnosticArgument ] + [-DiagnosticInfo ] + [-DomainController ] + [-IncludeReport] + [-IncludeSkippedItems] + [-ReportOnly] + [] +``` + +### MigrationRequestQueue +``` +Get-PublicFolderMoveRequestStatistics -RequestQueue [-RequestGuid ] + [-Diagnostic] + [-DiagnosticArgument ] + [-DiagnosticInfo ] + [-DomainController ] + [-IncludeReport] + [-IncludeSkippedItems] + [-ReportOnly] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderMoveRequestStatistics -Identity \PublicFolderMove +``` + +This example returns the default statistics for the public folder move request \\PublicFolderMove. + +### Example 2 +```powershell +Get-PublicFolderMoveRequestStatistics -Identity \PublicFolderMove | Format-List +``` + +This example returns the detailed statistics for the move request \\PublicFolderMove by pipelining the results to the Format-List command. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: PublicFolderMoveRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RequestQueue +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Diagnostic +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticArgument +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticInfo +This parameter is available only in the cloud-based service. + +{{ Fill DiagnosticInfo Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeReport +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportOnly +The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestGuid +The RequestGuid parameter specifies the GUID of the public folder move request for which you want to view the request statistics. + +This parameter can't be used with the Identity parameter. + +```yaml +Type: Guid +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md new file mode 100644 index 0000000000..023a6d31c0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md @@ -0,0 +1,165 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-PublicFolderStatistics cmdlet to retrieve statistical information about public folders, such as folder size and last logon time. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-PublicFolderStatistics [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [-Server ] + [-Mailbox ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderStatistics -Identity "\Marketing\2013\Pamphlets" | Format-List +``` + +This example retrieves statistics about the public folder Marketing\\2013\\Pamphlets. The output of the Get-PublicFolderStatistics command is piped to the Format-List command so that all the available information is displayed in the result. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ResultSize +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md new file mode 100644 index 0000000000..7e98a8ee18 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -0,0 +1,595 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-QuarantineMessage + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization. Files are quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Details +``` +Get-QuarantineMessage -Identity + [-EntityType ] + [-RecipientAddress ] + [-SenderAddress ] + [-TeamsConversationTypes ] + [] +``` + +### Summary +``` +Get-QuarantineMessage + [-Direction ] + [-Domain ] + [-EndExpiresDate ] + [-EndReceivedDate ] + [-EntityType ] + [-IncludeMessagesFromBlockedSenderAddress] + [-MessageId ] + [-MyItems] + [-Page ] + [-PageSize ] + [-PolicyName ] + [-PolicyTypes ] + [-QuarantineTypes ] + [-RecipientAddress ] + [-RecipientTag ] + [-ReleaseStatus ] + [-Reported ] + [-SenderAddress ] + [-StartExpiresDate ] + [-StartReceivedDate ] + [-Subject ] + [-TeamsConversationTypes ] + [-Type ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-QuarantineMessage -StartReceivedDate 06/13/2017 -EndReceivedDate 06/15/2017 +``` + +This example returns a summary list of messages quarantined between June 13, 2017 and June 15, 2017. + +### Example 2 +```powershell +Get-QuarantineMessage -PageSize 50 -Page 3 +``` + +This example presents 50 quarantined messages per page, and returns the third page of results. + +### Example 3 +```powershell +Get-QuarantineMessage -MessageID "<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>" +``` + +This example returns the quarantined message with the Message-ID value `<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>`. + +### Example 4 +```powershell +Get-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 | Format-List +``` + +This example returns detailed information for the quarantined message with the specified Identity value. + +### Example 5 +```powershell +Get-QuarantineMessage -QuarantineTypes SPOMalware | Format-List +``` + +This example returns detailed information for the files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. + +## PARAMETERS + +### -Identity +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`. + +```yaml +Type: QuarantineMessageIdentity +Parameter Sets: Details +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndExpiresDate +The EndExpiresDate parameter specifies the latest messages that will automatically be deleted from the quarantine. Use this parameter with the StartExpiresDate parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. + +```yaml +Type: System.DateTime +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndReceivedDate +The EndReceivedDate parameter specifies the latest messages to return in the results. Use this parameter with the StartReceivedDate parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress switch specifies whether to include quarantined messages from blocked senders in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, `""`). + +```yaml +Type: String +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MyItems +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +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 +Default value: None +Accept pipeline input: False +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: String +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTypes +The PolicyTypes parameter filters the results by the type of protection policy that quarantined the message. Valid values are: + +- AntiMalwarePolicy +- AntiPhishPolicy +- DataLossPreventionRule +- ExchangeTransportRule (mail flow rule) +- HostedContentFilterPolicy (anti-spam policy) +- SafeAttachmentPolicy (Microsoft Defender for Office 365 only) + +You can specify multiple values separated by commas. + +```yaml +Type: QuarantinePolicyTypeEnum[] +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTypes +The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: + +- Bulk +- DataLossPrevention +- FileTypeBlock (common attachments filter in anti-malware policies in EOP) +- HighConfPhish +- Malware (anti-malware policies in EOP or Safe Attachments policies in Defender for Office 365) +- Phish +- Spam +- SPOMalware (Microsoft Defender for Office 365 only) +- TransportRule + +You can specify multiple values separated by commas. + +You don't need to use this parameter with the Type parameter. + +For files quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. + +```yaml +Type: QuarantineMessageTypeEnum[] +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: All +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTag +The RecipientTag parameter filters the results by the recipient's user tag value (for example, `Priority Account`). For more information about user tags, see [User tags in Defender for Office 365](https://learn.microsoft.com/defender-office-365/user-tags-about). + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseStatus +The ReleaseStatus parameter filters the results by the release status of the message. Valid values are: + +- Approved +- Denied +- Error +- NotReleased +- PreparingToRelease +- Released +- Requested + +You can specify multiple values separated by commas. + +**Note**: Messages that were quarantined and released by Microsoft due to a service issue have the SystemReleased property value TRUE. To filter the results by system released messages, run the following command: `Get-QuarantineMessage | where {$_.systemreleased -like "True"}`. + +```yaml +Type: ReleaseStatus[] +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reported +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. +- $false: The command only returns quarantined messages that haven't been reported as false positives. + +```yaml +Type: Boolean +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartExpiresDate +The StartExpiresDate parameter specifies the earliest messages that will automatically be deleted from the quarantine. Use this parameter with the EndExpiresDate parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. + +```yaml +Type: System.DateTime +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartReceivedDate +The StartReceivedDate parameter specifies the earliest messages to return in the results. Use this parameter with the EndReceivedDate parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +By default, if you don't use the StartReceivedDate and EndReceivedDate parameters, the command will return data for the last 16 days. The maximum value for this parameter is 30 days. If you use a value that's older than 30 days, the value is ignored and only data for the last 30 days is returned. + +```yaml +Type: System.DateTime +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsConversationTypes +This parameter is available only in Security & Compliance PowerShell. + +The TeamsConversationTypes parameters filters the results by Microsoft Teams conversation types. Valid values are: + +- Channel +- Chat + +You can specify multiple values separated by commas. + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.TeamsConversationType[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Type parameter filters the results by what caused the message to be quarantined. Valid values are: + +- Bulk +- DataLossPrevention +- HighConfPhish +- Malware +- Phish +- Spam +- SPOMalware (Microsoft Defender for Office 365 only) +- TransportRule + +You don't need to use this parameter with the QuarantineTypes parameter. + +For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageTypeEnum +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md new file mode 100644 index 0000000000..9dac21f945 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -0,0 +1,119 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-QuarantineMessageHeader + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-QuarantineMessageHeader -Identity + [-EntityType ] + [-RecipientAddress ] + [] +``` + +## DESCRIPTION +Standard SMTP message header syntax is described in RFC 5322. This cmdlet displays the message header exactly as it appears in the message. Individual header fields are not unfolded. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-QuarantineMessageHeader 65ab8c7d-dcd3-4067-7c60-08d116c001c3\8b677327-0ef3-166b-e108-ff6cb380d191 +``` + +This example displays the message header of the quarantined message that has the specified Identity value. + +### Example 2 +```powershell +$qMessages = Get-QuarantineMessage + +Get-QuarantineMessageHeader $qMessages[0].Identity +``` + +This example displays the message header of the first message that's returned by Get-QuarantineMessage cmdlet. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: QuarantineMessageIdentity +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md new file mode 100644 index 0000000000..93177a8f2a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinepolicy +applicable: Exchange Online, Exchange Online Protection +title: Get-QuarantinePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-QuarantinePolicy cmdlet to view quarantine policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-QuarantinePolicy [[-Identity] ] + [-QuarantinePolicyType ] + [] +``` + +## DESCRIPTION +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-QuarantinePolicy | Format-Table Name +``` + +This example returns as summary list of all quarantine policies. + +### Example 2 +```powershell +Get-QuarantinePolicy -Identity NoAccess +``` + +This example returns detailed information about the quarantine policy named NoAccess. + +### Example 3 +```powershell +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy +``` + +This example returns detailed information about the default quarantine policy named DefaultGlobalTag that controls the global quarantine notification (formerly known as end-user spam notification) settings. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: QuarantineTagIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -QuarantinePolicyType +The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are: + +- QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies. +- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named DefaultGlobalTag. + +```yaml +Type: QuarantinePolicyType +Parameter Sets: (All) +Aliases: +Accepted values: QuarantinePolicy, GlobalQuarantinePolicy +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-Queue.md b/exchange/exchange-ps/exchange/Get-Queue.md similarity index 78% rename from exchange/exchange-ps/exchange/mail-flow/Get-Queue.md rename to exchange/exchange-ps/exchange/Get-Queue.md index 9ab6e05126..1b83dcd4a3 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Get-Queue.md +++ b/exchange/exchange-ps/exchange/Get-Queue.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Get-Queue @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-Queue cmdlet to view configuration information for queues on Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,55 +27,58 @@ Get-Queue [[-Identity] ] [-BookmarkObject ] [-Exclude ] [-Include ] - [-IncludeBookmark <$true | $false>] + [-IncludeBookmark ] [-ResultSize ] - [-ReturnPageInfo <$true | $false>] - [-SearchForward <$true | $false>] - [-SortOrder ] [] + [-ReturnPageInfo ] + [-SearchForward ] + [-SortOrder ] + [] ``` ### Server ``` -Get-Queue [-Server ] [-Filter ] +Get-Queue [-Server ] + [-Filter ] [-BookmarkIndex ] [-BookmarkObject ] [-Exclude ] [-Include ] - [-IncludeBookmark <$true | $false>] + [-IncludeBookmark ] [-ResultSize ] - [-ReturnPageInfo <$true | $false>] - [-SearchForward <$true | $false>] - [-SortOrder ] [] + [-ReturnPageInfo ] + [-SearchForward ] + [-SortOrder ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-Queue | Format-List ``` This example displays detailed information for all queues on the Mailbox server on which the command is run. -### -------------------------- Example 2 -------------------------- -``` -Get-Queue -Filter {MessageCount -gt 100} +### Example 2 +```powershell +Get-Queue -Filter "MessageCount -gt 100" ``` This example lists the queues that contain more than 100 messages. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-Queue Server1\contoso.com | Format-List ``` This example displays detailed information for a specific queue that exists on the Mailbox server named Server1. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-Queue -Exclude Internal ``` @@ -81,13 +87,14 @@ This example lists only the external queues. ## PARAMETERS ### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). +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 Default value: None @@ -103,6 +110,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,6 +126,7 @@ Type: ExtensibleQueueInfo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -129,9 +138,7 @@ Accept wildcard characters: False The Exclude parameter specifies the types of queues you want to exclude from the results. Valid values for this parameter are: - Internal - - External - - A valid queue DeliveryType value. For details, see the NextHopSolutionKey section in Queues and messages in queues. ```yaml @@ -139,6 +146,7 @@ Type: QueueViewerIncludesAndExcludes Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -147,7 +155,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value, for example, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue properties (https://technet.microsoft.com/library/bb125237.aspx) and Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). +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 ("). @@ -156,6 +164,7 @@ Type: String Parameter Sets: Server Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -167,9 +176,7 @@ Accept wildcard characters: False The Include parameter specifies the types of queues you want to include the results. Valid values for this parameter are: - Internal - - External - - A valid queue DeliveryType value. For details, see the NextHopSolutionKey section in Queues and messages in queues. ```yaml @@ -177,6 +184,7 @@ Type: QueueViewerIncludesAndExcludes Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -188,10 +196,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -207,6 +216,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -218,10 +228,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -233,10 +244,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -248,11 +260,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -264,6 +273,7 @@ Type: ServerIdParameter Parameter Sets: Server Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -281,6 +291,7 @@ Type: QueueViewerSortOrderEntry[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -289,20 +300,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/df73c45e-3797-4da5-95e3-8478f48d06c1.aspx) diff --git a/exchange/exchange-ps/exchange/Get-QueueDigest.md b/exchange/exchange-ps/exchange/Get-QueueDigest.md new file mode 100644 index 0000000000..a45a074bd3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-QueueDigest.md @@ -0,0 +1,271 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-QueueDigest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-QueueDigest cmdlet to view information about message delivery queues across database availability groups (DAGs) Active Directory sites, or Active Directory forests in your organization. + +By default, the Get-QueueDigest cmdlet displays delivery queues that contain ten or more messages, and the results are between one and two minutes old. For instructions on how to change these default values, see [Configure Get-QueueDigest](https://learn.microsoft.com/exchange/configure-get-queuedigest-exchange-2013-help). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Dag +``` +Get-QueueDigest -Dag + [-DetailsLevel ] + [-Filter ] + [-GroupBy ] + [-ResultSize ] + [-Timeout ] + [] +``` + +### Forest +``` +Get-QueueDigest [-Forest] + [-DetailsLevel ] + [-Filter ] + [-GroupBy ] + [-ResultSize ] + [-Timeout ] + [] +``` + +### Server +``` +Get-QueueDigest -Server + [-DetailsLevel ] + [-Filter ] + [-GroupBy ] + [-ResultSize ] + [-Timeout ] + [] +``` + +### Site +``` +Get-QueueDigest -Site + [-DetailsLevel ] + [-Filter ] + [-GroupBy ] + [-ResultSize ] + [-Timeout ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-QueueDigest -Forest +``` + +This example returns information about all queues in the Active Directory forest. + +### Example 2 +```powershell +Get-QueueDigest -Dag DAG01 +``` + +This example returns information about all queues in the DAG named DAG01. + +## PARAMETERS + +### -Dag +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Dag +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Forest +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Forest +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Site +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Site +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DetailsLevel +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://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 ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupBy +The GroupedBy parameter sorts the messages in the delivery queue results. Valid values are: + +- DeliveryType +- LastError +- NextHopCategory +- NextHopDomain (this is the default value) +- NextHopKey +- RiskLevel +- Status +- ServerName +- OutboundIPPool + +```yaml +Type: QueueDigestGroupBy +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +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. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RMSTemplate.md b/exchange/exchange-ps/exchange/Get-RMSTemplate.md new file mode 100644 index 0000000000..e495368203 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RMSTemplate.md @@ -0,0 +1,164 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RMSTemplate [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [-TrustedPublishingDomain ] + [-Type ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RMSTemplate -ResultSize unlimited +``` + +This example retrieves all RMS templates available from the RMS deployment. + +### Example 2 +```powershell +Get-RMSTemplate -Identity "Company Confidential" +``` + +This example retrieves the Company Confidential RMS template. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedPublishingDomain +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RmsTrustedPublishingDomainIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +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: + +- All +- Archived +- Distributed + +```yaml +Type: RmsTemplateType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md new file mode 100644 index 0000000000..f34ec98584 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md @@ -0,0 +1,139 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReceiveConnector + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ReceiveConnector cmdlet to view Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-ReceiveConnector [[-Identity] ] + [-DomainController ] + [] +``` + +### Server +``` +Get-ReceiveConnector [-Server ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ReceiveConnector -Server Exchange01 +``` + +This example returns a summary list of all Receive connectors on the server named Exchange01. + +### Example 2 +```powershell +Get-ReceiveConnector -Identity "Receive Connector for Contoso.com" | Format-List +``` + +This example displays detailed information for the Receive connector named Receive Connector for Contoso.com on the local server. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Receive connector that you want to view. You can use any value that uniquely identifies the Receive connector. For example: + +- Name +- Distinguished name (DN) +- GUID +- ServerName\\Name + +You can't use this parameter with the Server parameter. + +```yaml +Type: ReceiveConnectorIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter filters the results by the specified Mailbox server or Edge Transport server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use this parameter with the Identity parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Recipient.md b/exchange/exchange-ps/exchange/Get-Recipient.md new file mode 100644 index 0000000000..4b5a71f8b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Recipient.md @@ -0,0 +1,635 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-Recipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups). + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipient cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +In cloud environments, to return Microsoft 365 Groups, you need to use the RecipientTypeDetails parameter with the value GroupMailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-Recipient [-Anr ] + [-AuthenticationType ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-PropertySet ] + [-ReadFromDomainController] + [-RecipientType ] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [-Capabilities ] + [-Database ] + [-Properties ] + [-IncludeManagerWithDisplayName] + [-IncludeSoftDeletedRecipients] + [] +``` + +### Identity +``` +Get-Recipient [[-Identity] ] + [-AuthenticationType ] + [-BookmarkDisplayName ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeBookmarkObject ] + [-OrganizationalUnit ] + [-PropertySet ] + [-ReadFromDomainController] + [-RecipientType ] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [-Capabilities ] + [-Properties ] + [-IncludeManagerWithDisplayName] + [-IncludeSoftDeletedRecipients] + [] +``` + +### DatabaseSet +``` +Get-Recipient [-Database ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-Properties ] + [-PropertySet ] + [-ReadFromDomainController] + [-RecipientType ] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [-IncludeSoftDeletedRecipients] + [] + [] +``` + +### RecipientPreviewFilterSet +``` +Get-Recipient [-RecipientPreviewFilter ] + [-AuthenticationType ] + [-Capabilities ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeManagerWithDisplayName] + [-IncludeSoftDeletedRecipients] + [-OrganizationalUnit ] + [-Properties ] + [-PropertySet ] + [-ReadFromDomainController] + [-RecipientType ] + [-RecipientTypeDetails ] + [-ResultSize ] + [-SortBy ] + [] +``` + +## DESCRIPTION +The Get-Recipient cmdlet may not return all object-specific properties for a recipient. To view the object-specific properties for a recipient, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox, Get-MailUser, or Get-DistributionGroup). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-Recipient -ResultSize unlimited +``` + +This example retrieves as summary list of all recipients in your organization. + +### Example 2 +```powershell +Get-Recipient -Identity "Marketing Department" | Format-List +``` + +This example returns detailed information for the recipient named Marketing Department. + +### Example 3 +```powershell +Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name +``` + +This example retrieves information about all the mail contacts in your organization and sorts them by office. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the recipient object that you want to view. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationType +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: + +- Federated +- Managed + +```yaml +Type: AuthenticationType +Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookmarkDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capabilities +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: DatabaseSet +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IncludeBookmarkObject +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 +This parameter is available only in the cloud-based service. + +{{ Fill IncludeManagerWithDisplayName Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, RecipientPreviewFilterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedRecipients +The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. + +Soft-deleted recipients are deleted recipients that are still recoverable. + +**Note**: Use this switch with the Identity or RecipientTypeDetails parameters to get the SoftDeletedRecipients. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertySet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientPreviewFilter +The RecipientPreviewFilter parameter tests a recipient filter that you would use in a dynamic distribution group, address list, or email address policy. This parameter uses the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientType +The RecipientType parameter filters the results by the specified recipient type. Valid values are: + +- DynamicDistributionGroup +- MailContact +- MailNonUniversalGroup +- MailUniversalDistributionGroup +- MailUniversalSecurityGroup +- MailUser +- PublicFolder +- UserMailbox + +You can specify multiple values separated by commas. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: + +- DiscoveryMailbox +- DynamicDistributionGroup +- EquipmentMailbox +- GroupMailbox (Exchange 2013 or later and cloud) +- GuestMailUser (Exchange 2016 or later and cloud) +- LegacyMailbox +- LinkedMailbox +- LinkedRoomMailbox (Exchange 2013 or later and cloud) +- MailContact +- MailForestContact +- MailNonUniversalGroup +- MailUniversalDistributionGroup +- MailUniversalSecurityGroup +- MailUser +- PublicFolder +- PublicFolderMailbox (Exchange 2013 or later and cloud) +- RemoteEquipmentMailbox +- RemoteRoomMailbox +- RemoteSharedMailbox +- RemoteTeamMailbox (Exchange 2013 or later and cloud) +- RemoteUserMailbox +- RoomList +- RoomMailbox +- SchedulingMailbox (Exchange 2016 or later and cloud) +- SharedMailbox +- SharedWithMailUser (cloud only) +- TeamMailbox (Exchange 2013 or later and cloud) +- UserMailbox + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias +- City +- FirstName +- LastName +- Office +- ServerLegacyDN + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md new file mode 100644 index 0000000000..76a02ece24 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-RecipientFilterConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-RecipientFilterConfig cmdlet to view the recipient filter configuration information for the Exchange server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RecipientFilterConfig [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RecipientFilterConfig | Format-List +``` + +This example returns detailed information about the recipient filter configuration for the Exchange server. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RecipientPermission.md b/exchange/exchange-ps/exchange/Get-RecipientPermission.md new file mode 100644 index 0000000000..985fc7ff66 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RecipientPermission.md @@ -0,0 +1,187 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RecipientPermission + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-RecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization. + +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipientPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RecipientPermission [[-Identity] ] + [-AccessRights ] + [-ReadFromDomainController] + [-ResultSize ] + [-Trustee ] + [] +``` + +## DESCRIPTION +When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. + +> [!NOTE] +> This cmdlet doesn't return expected results when the recipient specified by the Trustee parameter has multiple `SecurityPrincipalIdParameter` (Sid) values. When you use the Trustee parameter, the command compares the Sid of the specified Trustee with the recipient's access control list (ACL) record. If some of the recipient's Sid values have changed, there's a mismatch. The workaround is to not to use the user principal name (UPN) value, to use all Sids including the one for history. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RecipientPermission -Trustee "Kim Akers" +``` + +This example lists the recipients for whom the user Kim Akers has SendAs permission. Kim can send messages that appear to come directly from the recipients. + +### Example 2 +```powershell +Get-RecipientPermission "Help Desk" +``` + +This example lists the users who have SendAs permission on the mailbox Help Desk. The users listed can send messages that appear to come directly from the Help Desk mailbox. + +## PARAMETERS + +### -Identity +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 +- Mail users +- External contacts +- Distribution groups +- Dynamic distribution groups + +You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Trustee +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 +- Mail users with a Microsoft account +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md b/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md new file mode 100644 index 0000000000..8f2d888cba --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md @@ -0,0 +1,58 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RecipientStatisticsReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-RecipientStatisticsReport cmdlet to view the recipient statistics report. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RecipientStatisticsReport +``` + +This example displays the recipient statistics report for the organization. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md new file mode 100644 index 0000000000..4f413a8bf3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md @@ -0,0 +1,50 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RecordReviewNotificationTemplateConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-RecordReviewNotificationTemplateConfig cmdlet to view the record review notification and reminder settings. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RecordReviewNotificationTemplateConfig [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RecordReviewNotificationTemplateConfig +``` + +This example shows detailed information about the record review notification template configuration. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md new file mode 100644 index 0000000000..aebb11746e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -0,0 +1,331 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- +# 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. + +Use the Get-RecoverableItems items cmdlet to view deleted items in mailboxes. After you find the deleted items, you use the Restore-RecoverableItems cmdlet to restore them. + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### OnPremises +``` +Get-RecoverableItems -Identity + [-EntryID ] + [-FilterEndTime ] + [-FilterItemType ] + [-FilterStartTime ] + [-LastParentFolderID ] + [-ResultSize ] + [-SourceFolder ] + [-SubjectContains ] + [] +``` + +### Cloud +``` +Get-RecoverableItems -Identity + [-EntryID ] + [-FilterEndTime ] + [-FilterItemType ] + [-FilterStartTime ] + [-LastParentFolderID ] + [-MaxParallelSize ] + [-PolicyTag ] + [-ResultSize ] + [-SkipCount ] + [-SourceFolder ] + [-SubjectContains ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RecoverableItems -Identity laura@contoso.com -SubjectContains "FY17 Accounting" -FilterItemType IPM.Note -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM" +``` + +This example returns all of the available recoverable deleted messages with the specified subject in the mailbox laura@contoso.com for the specified date/time range. + +### Example 2 +```powershell +Get-RecoverableItems -Identity "malik@contoso.com", "lillian@contoso.com" -FilterItemType IPM.Note -FilterStartTime "3/15/2019 12:00:00 AM" -FilterEndTime "3/25/2019 11:59:59 PM" +``` + +This example returns all of the available recoverable deleted messages with the specified subject in the mailboxes of both malik@contoso.com and lillian@contoso.com for the specified date/time range. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +In Exchange Online, you can specify multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: GeneralMailboxOrMailUserIdParameter +Parameter Sets: OnPremises +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: GeneralMailboxOrMailUserIdParameter[] +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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.). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterEndTime +The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterItemType +The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: + +- IPM.Appointment (Meetings and appointments) +- IPM.Contact +- IPM.File +- IPM.Note +- IPM.Task + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterStartTime +The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastParentFolderID +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxParallelSize +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. + +The value of this parameter has no effect when the Identity parameter specifies only one mailbox. + +```yaml +Type: Int32 +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTag +This parameter is available only in the cloud-based service. + +{{ Fill PolicyTag Description }} + +```yaml +Type: String[] +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceFolder +The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: + +- DeletedItems: The Deleted Items folder. +- RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). +- PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). + +If you don't use this parameter, the command searches those three folders. + +- DiscoveryHoldsItems (cloud-only): The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. + +```yaml +Type: RecoverableItemsFolderType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectContains +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-RegulatoryComplianceUI.md b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md new file mode 100644 index 0000000000..69ceb96099 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md @@ -0,0 +1,48 @@ +--- +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 +schema: 2.0.0 +--- + +# Get-RegulatoryComplianceUI + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell) +. + +Use the Get-RegulatoryComplianceUI cmdlet to view the status of the regulatory compliance UI in the Microsoft Purview compliance portal (whether the preservation lock checkbox is displayed for retention policies and the immutable label checkbox is displayed for retention labels). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RegulatoryComplianceUI [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RegulatoryComplianceUI +``` + +This example returns the status of regulatory compliance UI. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RemoteDomain.md b/exchange/exchange-ps/exchange/Get-RemoteDomain.md new file mode 100644 index 0000000000..ea01811a75 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RemoteDomain.md @@ -0,0 +1,131 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RemoteDomain cmdlet to view the configuration information for the remote domains configured in your organization. You can view the remote domain configuration from inside the Exchange organization or from an Edge Transport server in the perimeter network. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RemoteDomain [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RemoteDomain +``` + +This example returns a summary list of all remote domains in the organization. + +### Example 2 +```powershell +Get-RemoteDomain -Identity Contoso | Format-List +``` + +This example returns detailed information for the remote domain named Contoso. + +### Example 3 +```powershell +Get-RemoteDomain | Where {$_.TNEFEnabled -eq $false} +``` + +This example returns all domains where Transport Neutral Encapsulation Format (TNEF) encoding isn't used. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RemoteDomainIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md new file mode 100644 index 0000000000..f40415ec08 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md @@ -0,0 +1,330 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-RemoteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-RemoteMailbox cmdlet to retrieve the mail-related attributes of users in the on-premises organization that have associated mailboxes in the cloud-based service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-RemoteMailbox [-Anr ] + [-Archive] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OnPremisesOrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] [] +``` + +### Identity +``` +Get-RemoteMailbox [[-Identity] ] + [-Archive] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OnPremisesOrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RemoteMailbox +``` + +This example returns a summary list of all remote mailboxes in your organization. + +### Example 2 +```powershell +Get-RemoteMailbox -Identity laura@contoso.com | Format-List +``` + +This example returns a detailed information for the remote mailbox for the user laura@contoso.com. + +### Example 3 +```powershell +$Credentials = Get-Credential + +Get-RemoteMailbox -Credential $Credentials +``` + +This example uses alternate credentials to retrieve a list of one or more mail-enabled users with mailboxes in the service. This is useful if the account you typically use doesn't have administrative permissions. The credentials are used to access the on-premises Active Directory domain controllers. + +First, run the following command to prompt you for your credentials and then store them in a variable. Then retrieve a list of remote mailboxes using the credentials you provided by using the second command. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: RemoteMailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +Type: String +Parameter Sets: AnrSet +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 +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -OnPremisesOrganizationalUnit +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +**Note**: Limitations on domain controllers might affect the number of results returned for the value unlimited. For more information, see [this article](https://learn.microsoft.com/troubleshoot/windows-server/identity/domain-controller-returns-500-values-ldap-response). + +```yaml +Type: Unlimited +Parameter Sets: (All) +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 +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md b/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md new file mode 100644 index 0000000000..134a709559 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md @@ -0,0 +1,91 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReportExecutionInstance + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReportExecutionInstance cmdlet to review the report execution instance in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReportExecutionInstance [-Identity ] + [-ScheduleId ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ReportExecutionInstance | Format-Table -Auto Identity,ScheduleId,ReportStartDate,ReportEndDate +``` + +This example returns a summary list of all report execution instances. + +### Example 2 +```powershell +Get-ReportExecutionInstance -Identity 277df7c3-5b73-4409-6264-08d4a8052836 +``` + +This example returns detailed information for the specified report execution instance. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..483f073460 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md @@ -0,0 +1,70 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionpolicy +applicable: Exchange Online +title: Get-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReportSubmissionPolicy cmdlet to view the report submission policy in your cloud-based organization. The report submission policy controls most of the user reported message settings in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReportSubmissionPolicy [[-Identity] ] [] +``` + +## DESCRIPTION +The report submission policy controls most of the settings for user submissions in the Microsoft Defender portal at . + +The report submission rule (\*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are delivered. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ReportSubmissionPolicy +``` + +This example returns the settings of the report submission policy in your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission policy that you want to view. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md new file mode 100644 index 0000000000..f64f8d899b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionrule +applicable: Exchange Online +title: Get-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReportSubmissionRule cmdlet to view the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReportSubmissionRule [[-Identity] ] [-State ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ReportSubmissionRule +``` + +This example returns detailed information about the report submission rule in your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to view. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by whether the report submission rule is enabled or disabled. Valid values are: + +- Disabled +- Enabled + +Remember, there's only one rule in your organization. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ResourceConfig.md b/exchange/exchange-ps/exchange/Get-ResourceConfig.md new file mode 100644 index 0000000000..e5087116d5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ResourceConfig.md @@ -0,0 +1,94 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-ResourceConfig cmdlet to view custom room and equipment mailbox properties that you've configured by using the Set-ResourceConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ResourceConfig [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ResourceConfig +``` + +This example returns all of the available custom room and equipment mailbox properties. + +## PARAMETERS + +### -Identity +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md b/exchange/exchange-ps/exchange/Get-ResubmitRequest.md new file mode 100644 index 0000000000..e6837d4223 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ResubmitRequest.md @@ -0,0 +1,104 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ResubmitRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ResubmitRequest cmdlet to view requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ResubmitRequest [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ResubmitRequest +``` + +This example returns the details of all resubmit requests. + +### Example 2 +```powershell +Get-ResubmitRequest 1 +``` + +This example returns details about the resubmit request with the identity 1. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md new file mode 100644 index 0000000000..fbb20052f5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -0,0 +1,210 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-RetentionCompliancePolicy to view existing retention policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RetentionCompliancePolicy [[-Identity] ] + [-DistributionDetail] + [-ErrorPolicyOnly] + [-ExcludeTeamsPolicy] + [-IncludeTestModeResults] + [-PriorityCleanup] + [-RetentionRuleTypes] + [-TeamsPolicyOnly] + [] +``` + +## DESCRIPTION +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. +- Enabled: The value True means the policy is enabled. +- Mode: The current operating mode of the policy. The possible values are Test (the content is tested, but no rules are enforced), AuditAndNotify (when content matches the conditions specified by the policy, the rule is not enforced, but notification emails are sent) or Enforce (all aspects of the policy are enabled and enforced). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RetentionCompliancePolicy +``` + +This example displays summary information for all retention policies in your organization. + +### Example 2 +```powershell +Get-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -DistributionDetail | Format-List +``` + +This example displays detailed information for the policy named "Regulation 123 Compliance", including accurate values for the DistributionStatus and \*Location properties. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. + +If you don't use this switch, the values of the DistributionStatus and \*Location property values will be inaccurate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorPolicyOnly +The ErrorPolicyOnly switch specifies whether to show only policies that have distribution errors in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeTeamsPolicy +The ExcludeTeamsPolicy switch specifies whether to exclude Teams policies from the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTestModeResults +The IncludeTestModeResults switch specifies whether to include the status of test mode in the policy details. You don't need to specify a value with this switch. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionRuleTypes +The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsPolicyOnly +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md new file mode 100644 index 0000000000..9c1279ce96 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-RetentionComplianceRule to view retention rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RetentionComplianceRule [[-Identity] ] + [-Policy ] + [-PriorityCleanup] + [] +``` + +## DESCRIPTION +This list describes the properties that are displayed by default in the summary information. + +- Name: The unique name of the rule. +- Disabled: The enabled or disabled status of the rule. +- Mode: The current operating mode of the rule (for example, Enforce). +- Comment: An administrative comment. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RetentionComplianceRule +``` + +This example displays summary information for all retention rules in your organization. + +### Example 2 +```powershell +Get-RetentionComplianceRule -Identity "30 Day Rule" | Format-List +``` + +This example displays detailed information for the retention rule named "30 Day Rule". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the retention rule you want to view. You can use any value that uniquely identifies the rule. 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 +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +You can use this parameter with the Identity parameter in the same command. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RetentionEvent.md b/exchange/exchange-ps/exchange/Get-RetentionEvent.md new file mode 100644 index 0000000000..c650acf830 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RetentionEvent.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RetentionEvent + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-RetentionEvent cmdlet to view retention events in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RetentionEvent [[-Identity] ] + [-AllStatus] + [-DomainController ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RetentionEvent +``` + +This example returns a summary list of all retention events. + +### Example 2 +```powershell +Get-RetentionEvent -Identity x | Format-List +``` + +This example returns detailed information about retention the specified retention event. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the retention event that you want to view. + +```yaml +Type: EwsStoreObjectIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllStatus +The AllStatus switch specifies whether to include zero count events in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-RetentionPolicy.md b/exchange/exchange-ps/exchange/Get-RetentionPolicy.md new file mode 100644 index 0000000000..231c381cff --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RetentionPolicy.md @@ -0,0 +1,94 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RetentionPolicy cmdlet to retrieve the settings for retention policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RetentionPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy may contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-RetentionPolicy -Identity "RP Finance" | Format-List +``` + +This example returns all the properties of the retention policy RP Finance. The output is piped to the Format-List cmdlet to format the results as a list of properties. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md new file mode 100644 index 0000000000..53ece7d08e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md @@ -0,0 +1,231 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RetentionPolicyTag cmdlet to retrieve settings for a retention tag. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-RetentionPolicyTag [[-Identity] ] + [-DomainController ] + [-IncludeSystemTags] + [-Types ] + [] +``` + +### Mailbox +``` +Get-RetentionPolicyTag [-Mailbox ] + [-OptionalInMailbox] + [-DomainController ] + [-IncludeSystemTags] + [-Types ] + [] +``` + +## DESCRIPTION +Retention tags are used to apply message retention settings to messages or folders. There are three types of retention tags: + +- Retention policy tags +- Default policy tags +- Personal tags + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RetentionPolicyTag +``` + +This example returns all retention tags. + +### Example 2 +```powershell +Get-RetentionPolicyTag -IncludeSystemTags +``` + +This example returns system tags in addition to personal and default tags. + +### Example 3 +```powershell +Get-RetentionPolicyTag "Consolidated Messenger" +``` + +This example returns the settings for the tag Consolidated Messenger. + +### Example 4 +```powershell +Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize +``` + +This example returns all retention tags of Inbox and All types and pipes the results to the Format-Table command to display the Name, Type, RetentionEnabled, AgeLimitForRetention and RetentionAction properties. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSystemTags +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +This parameter only returns default policy tags (DPTs) and personal tags; it doesn't return retention policy tags. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptionalInMailbox +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Types +The Types parameter specifies the type of retention tag to return. Valid values include: + +- Calendar +- Contacts +- DeletedItems +- Drafts +- Inbox +- JunkEmail +- Journal +- Notes +- Outbox +- SentItems +- Tasks +- All +- RssSubscriptions +- ConversationHistory +- Personal + +The parameter accepts multiple values separated by a comma. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/exchange/Get-ReviewItems.md new file mode 100644 index 0000000000..b9fa1c3b40 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReviewItems.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reviewitems +applicable: Exchange Online +title: Get-ReviewItems +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReviewItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label. + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReviewItems -TargetLabelId + [-Disposed ] + [-IncludeHeaders ] + [-PagingCookie ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/purview/disposition). + +## EXAMPLES + +### Example 1 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true + +$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers + +$formattedExportItems +``` + +This example retrieves the first page of items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results are converted to PSObject types for each item and then output to the screen. + +### Example 2 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -Disposed $true + +$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers + +$formattedExportItems | Select Subject,Location,ReviewAction,Comment,DeletedBy,DeletedDate +``` + +This example retrieves all disposed items for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9` and selects specific columns to output to the screen. + +### Example 3 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true + +$exportItems = $itemsPendingDisposition.ExportItems + +While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie)) +{ + $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -PagingCookie $itemsPendingDisposition.PaginationCookie + $exportItems += $itemsPendingDisposition.ExportItems +} + +$exportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers | Export-Csv C:\temp\ItemsPendingDisposition.csv -NoTypeInformation +``` + +This example retrieves all items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, the command continues until no more pages exist. The results are exported to the specified CSV file. + +**Note**: Although this cmdlet doesn't limit the number of items/pages that can be retrieved, other throttling might occur. To prevent throttling while retrieving a large number of items, we recommended including breaks in your script. You can use the PagingCookie parameter to pick up where the script left off after a break. + +## PARAMETERS + +### -TargetLabelId +The TargetLabelId parameter specifies the label that you want to retrieve review items for. A valid value for this parameter is the immutable ID of the label. + +To get the immutable ID value of a label, replace \ with the name of the label, and then run the following command in Exchange Online PowerShell: `Get-ComplianceTag -Identity "" | select ImmutableId`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disposed +The Disposed parameter specifies whether to return disposed items instead of items pending disposition. Valid values are: + +- $true: Return disposed items. +- $false: Return items pending disposition. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHeaders +The IncludeHeaders parameter specifies whether headers are returned as a property with the review items. Valid values are: + +- $true: Headers are returned as a property with the review items. This option is useful when converting the output to a PSObject in PowerShell or when exporting to CSV. +- $false: Headers are not returned as a property with the review items. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PagingCookie +The PagingCookie parameter identifies the page to retrieve. This parameter is useful in the following scenarios: + +- To avoid throttling while retrieving a large number of items. +- As a method of starting where the last operation left off. + +The PagingCookie value is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is blank (null), there are no more items to retrieve. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md new file mode 100644 index 0000000000..20474cb2b2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md @@ -0,0 +1,116 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RoleAssignmentPolicy cmdlet to view existing management role assignment policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RoleAssignmentPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RoleAssignmentPolicy +``` + +This example returns a list of all the existing role assignment policies. + +### Example 2 +```powershell +Get-RoleAssignmentPolicy "End User Policy" | Format-List +``` + +This example returns the details of the specified assignment policy. The output of the Get-RoleAssignmentPolicy cmdlet is piped to the Format-List cmdlet. + +For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +### Example 3 +```powershell +Get-RoleAssignmentPolicy | Where { $_.IsDefault -eq $True } +``` + +This example returns the default assignment policy. + +The output of the Get-RoleAssignmentPolicy cmdlet is piped to the Where cmdlet. The Where cmdlet filters out all of the policies except the policy that has the IsDefault property set to $True. + +For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/exchange/Get-RoleGroup.md new file mode 100644 index 0000000000..7e6cfdc324 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RoleGroup.md @@ -0,0 +1,237 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RoleGroup cmdlet to retrieve a list of management role groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RoleGroup [[-Identity] ] + [-DomainController ] + [-Filter ] + [-ReadFromDomainController] + [-ResultSize ] + [-ShowPartnerLinked] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RoleGroup +``` + +This example retrieves a list of role groups. + +### Example 2 +```powershell +Get-RoleGroup "Recipient Administrators" | Format-List +``` + +This example retrieves the details for the Recipient Administrators role group. + +### Example 3 +```powershell +Get-RoleGroup -ReadFromDomainController +``` + +This example retrieves a list of role groups as seen by the domain controller closest to the user. + +### Example 4 +```powershell +Get-RoleGroup -Filter "RoleGroupType -eq 'Linked'" | Format-Table Name, LinkedGroup +``` + +This example retrieves a list of all linked role groups and the Active Directory security identifier (SID) of the foreign universal security groups (USG) that are linked to each of them. You can then use the SIDs to find the USGs so you can modify their members. + +## PARAMETERS + +### -Identity +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. + +```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: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can filter on the following properties: + +- LinkedGroup +- ManagedBy +- Members +- Name +- RoleGroupType (the available values are Standard and Linked) +- DisplayName + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ShowPartnerLinked +This parameter is functional only in the cloud-based service. + +This ShowPartnerLinked switch specifies whether to return built-in role groups that are of type PartnerRoleGroup. You don't need to specify a value with this switch. + +This type of role group is used in the cloud-based service to allow partner service providers to manage their customer organizations. These types of role groups can't be edited and are not shown by default. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md b/exchange/exchange-ps/exchange/Get-RoleGroupMember.md new file mode 100644 index 0000000000..8416becc8f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RoleGroupMember.md @@ -0,0 +1,141 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-RoleGroupMember cmdlet to retrieve a list of members of a management role group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RoleGroupMember [-Identity] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RoleGroupMember "Recipient Administrators" +``` + +This example retrieves a list of all the members of the Recipient Administrators role group. + +### Example 2 +```powershell +Get-RoleGroupMember "Organization Administrators" -ReadFromDomainController +``` + +This example retrieves a list of all the members of the Organization Administrators role group as seen by the domain controller closest to the user running the command. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md new file mode 100644 index 0000000000..2f0f384197 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md @@ -0,0 +1,92 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-RoutingGroupConnector + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-RoutingGroupConnector cmdlet to view the configuration details of the routing group connectors in a Microsoft Exchange Server 2010 organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RoutingGroupConnector [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RoutingGroupConnector -Identity "Exchange Administrative Group (FYDIBOHF23SPDLT)\Exchange Routing Group (DWBGZMFD01QNBJR)\Ex2010 to Ex2003 RGC" +``` + +This example displays detailed configuration information for the routing group connector Ex2010 to Ex2003 RGC. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. You can use the wildcard character (\*) as part of the administrative group or routing group name. + +```yaml +Type: RoutingGroupConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md b/exchange/exchange-ps/exchange/Get-RpcClientAccess.md new file mode 100644 index 0000000000..adedda699a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-RpcClientAccess.md @@ -0,0 +1,104 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-RpcClientAccess + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-RpcClientAccess cmdlet to view the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-RpcClientAccess [-DomainController ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-RpcClientAccess +``` + +This example displays a summary list of the RPC Client Access service settings on all the servers in the organization. + +### Example 2 +```powershell +Get-RpcClientAccess -Server ENT01 | Format-List +``` + +This example returns detailed information for the RPC Client Access service on the server named ENT01. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that you want to view. + +You can use any value that uniquely identifies the server. For example: + +- Name (for example, Exchange01) +- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) +- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) + +```yaml +Type: ServerIdParameter +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SCInsights.md b/exchange/exchange-ps/exchange/Get-SCInsights.md new file mode 100644 index 0000000000..7675f4455f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SCInsights.md @@ -0,0 +1,87 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SCInsights + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SCInsights cmdlet to view Microsoft 365 insights information. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SCInsights [-EndDate ] + [] +``` + +## DESCRIPTION +This cmdlet returns the following output: + +- Organization: The Microsoft 365 domain. +- Date: The date of the event in Coordinated Universal Time (UTC). +- InsightType +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SCInsights +``` + +This example returns all insights data. + +### Example 2 +```powershell +Get-SCInsights -EndDate (Get-Date "3/3/2018 9:30 AM").ToUniversalTime() +``` + +This example return insights data for March 15, 2018. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md new file mode 100644 index 0000000000..1330056090 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md @@ -0,0 +1,82 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SafeAttachmentPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SafeAttachmentPolicy cmdlet to view safe attachment policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SafeAttachmentPolicy +``` + +This example shows a summary list of all safe attachment policies. + +### Example 2 +```powershell +Get-SafeAttachmentPolicy -Identity Default | Format-List +``` + +This example shows detailed information about the safe attachment policy named Default. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md new file mode 100644 index 0000000000..0dded56904 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md @@ -0,0 +1,99 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SafeAttachmentRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SafeAttachmentRule cmdlet to view safe attachment rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SafeAttachmentRule [[-Identity] ] + [-State ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SafeAttachmentRule +``` + +This example returns a summary list of all safe attachment rules in your organization. + +### Example 2 +```powershell +Get-SafeAttachmentRule -Identity "Research Department Attachment Rule" | Format-List +``` + +This example returns detailed information about the safe attachment rule named Research Department Attachment Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -State +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SafeLinksAggregateReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md new file mode 100644 index 0000000000..27c72f641a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md @@ -0,0 +1,177 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SafeLinksAggregateReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SafeLinksAggregateReport cmdlet to return general information about Safe Links results for the last 90 days. Yesterday is the most recent date that you can specify. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SafeLinksAggregateReport + [-Action ] + [-AppNameList ] + [-EndDate ] + [-StartDate ] + [-SummarizeBy ] + [] +``` + +## DESCRIPTION +**Note**: If you run Get-SafeLinksAggregateReport without specifying a date range, the command will return 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. + +For the reporting period you specify, the cmdlet returns the following information: + +- Action +- App +- MessageCount +- RecipientCount + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SafeLinksAggregateReport -StartDate 06-01-2020 -EndDate 06-10-2020 -SummarizeBy App -AppNameList "Email Client","Teams" +``` + +This example returns results summarized by Email Client and Teams results for the specified date range. + +## PARAMETERS + +### -Action +The Action parameter filters the results by action. Valid values are: + +- Allowed +- Blocked +- ClickedDuringScan +- ClickedEvenBlocked +- Scanning +- TenantAllowed +- TenantBlocked +- TenantBlockedAndClickedThrough + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppNameList +The AppNameList parameter filters the results by the app where the link was found. Valid values are: + +- Email Client +- OfficeDocs +- Teams + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 90 days. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 90 days. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of Action or AppNameList on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that specific Action or App on one row in the report. + +For this cmdlet, valid values are: + +- Action: Only the values specified by the Action parameter are returned. +- App: Only the values specified by the AppNameList parameter are returned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md new file mode 100644 index 0000000000..ef6379a4e6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md @@ -0,0 +1,245 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SafeLinksDetailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SafeLinksDetailReport cmdlet to return detailed information about Safe Links results for the last 7 days. Yesterday is the most recent date that you can specify. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SafeLinksDetailReport + [-Action ] + [-AppNameList ] + [-Domain ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-RecipientAddress ] + [-StartDate ] + [] +``` + +## DESCRIPTION +**Note**: If you run Get-SafeLinksDetailReport without specifying a date range, the command will return 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. + +This cmdlet returns the following information: + +- ClickTime +- NetworkMessageId +- ClientMessageId +- SenderAddress +- RecipientAddress +- Url +- UrlDomain +- Action +- AppName +- SourceId +- Organization +- DetectedBy (Safe Links in Microsoft Defender for Office 365) +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SafeLinksDetailReport -StartDate 06-07-2020 -EndDate 06-10-2020 -Action Allowed,Blocked -AppNameList "Email Client","Teams" -Domain google.com,teams.com -RecipientAddress faith@contoso.com,chris@contoso.com +``` + +This example returns filters the results by the following information: + +- Date range: June 7, 2020 to June 10, 2020 +- Action: Allowed and Blocked +- AppNameList: Email Client and Teams +- URL domain: google.com and teams.com +- Recipient email address: faith@contoso.com and chris@contoso.com + +## PARAMETERS + +### -Action +The Action parameter filters the results by action. Valid values are: + +- Allowed: URL was allowed due to a "Good" verdict. +- Blocked: URL was blocked due to a "Bad" verdict. +- ClickedDuringScan: User skipped verification of the URL and proceeded to the destination URL before Safe Links finished scanning. +- ClickedEvenBlocked: User was blocked at time of click from accessing URL. +- Scanning: URL is being scanned. +- TenantAllowed: URL allow entry in the Tenant Allow/Block List. +- TenantBlocked: URL block entry in the Tenant Allow/Block List. +- TenantBlockedAndClickedThrough: URL was blocked due to a block entry in the Tenant Allow/Block List, and the user clicked through the block page to access the URL. + +You can specify multiple values separated by commas. + +**Note**: Values for this parameter are case sensitive. No data returned for an action implies that the action didn't occur. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppNameList +The AppNameList parameter filters the results by the app where the link was found. Valid values are: + +- Email Client +- OfficeDocs +- Teams + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by the domain in the URL. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 7 days. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. + +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 7 days. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md new file mode 100644 index 0000000000..63a24625de --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md @@ -0,0 +1,82 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SafeLinksPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SafeLinksPolicy cmdlet to view Safe Links policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SafeLinksPolicy | Format-Table Name,EnableSafe* +``` + +This example shows a summary list of all Safe Links policies. + +### Example 2 +```powershell +Get-SafeLinksPolicy -Identity "Contoso All" +``` + +This example shows detailed information about the Safe Links policy named Contoso All. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md new file mode 100644 index 0000000000..279ebc68cd --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md @@ -0,0 +1,99 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SafeLinksRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SafeLinksRule cmdlet to view Safe Links rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SafeLinksRule [[-Identity] ] + [-State ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SafeLinksRule | Format-Table -Auto Name,State,Priority,SafeLinksPolicy,Comments +``` + +This example returns a summary list of all Safe Links rules in your organization. + +### Example 2 +```powershell +Get-SafeLinksRule -Identity "Research Department URL Rule" +``` + +This example returns detailed information about the Safe Links rule named Research Department URL Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -State +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md new file mode 100644 index 0000000000..562980e971 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md @@ -0,0 +1,108 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-SearchDocumentFormat cmdlet to retrieve details of file formats supported by Exchange Search. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SearchDocumentFormat [[-Identity] ] + [-Server ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SearchDocumentFormat +``` + +This example retrieves a list of all file formats supported by Exchange Search. + +### Example 2 +```powershell +Get-SearchDocumentFormat docx | Format-List * +``` + +This example retrieves all properties of the docx file format. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md new file mode 100644 index 0000000000..31c46f8403 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md @@ -0,0 +1,89 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SecOpsOverridePolicy + +## 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). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SecOpsOverridePolicy [[-Identity] ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SecOpsOverridePolicy +``` + +This example returns detailed information about the one and only SecOps mailbox override policy. + +## PARAMETERS + +### -Identity +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 +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md b/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md new file mode 100644 index 0000000000..458dcbe1b3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md @@ -0,0 +1,244 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-SecurityPrincipal cmdlet to return a list of security principals. Security principals are entities, such as users or security groups, which can be assigned permissions and user rights. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SecurityPrincipal [[-Identity] ] + [-DomainController ] + [-Filter ] + [-IncludeDomainLocalFrom ] + [-OrganizationalUnit ] + [-ResultSize ] + [-RoleGroupAssignable] + [-Types ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com +``` + +This example retrieves security principals from the People OU. + +### Example 2 +```powershell +Get-SecurityPrincipal -Filter "Department -eq 'Legal'" +``` + +This example retrieves security principals from the Legal department by using the Filter parameter. Only security principals matching the filter condition are retrieved. + +### Example 3 +```powershell +Get-SecurityPrincipal -Identity Administrator +``` + +This example retrieves a single security principal explicitly specified by using the Identity parameter. + +### Example 4 +```powershell +Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize +``` + +This example retrieves well-known security principals and displays only the Name and SID properties in the results. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned. + +```yaml +Type: ExtendedSecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomainLocalFrom +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. + +Don't use this parameter with the Filter or Identity parameters. + +```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: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -RoleGroupAssignable +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Types +The Types parameter filters the results by object type. Valid values are: + +- Computer +- GlobalSecurityGroup +- Group +- UniversalSecurityGroup +- User +- WellknownSecurityPrincipal + +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, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SendConnector.md b/exchange/exchange-ps/exchange/Get-SendConnector.md new file mode 100644 index 0000000000..b285afa86f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SendConnector.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SendConnector + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SendConnector cmdlet to view the settings for a Send connector. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SendConnector [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SendConnector "Contoso.com Send Connector" | Format-List +``` + +This example displays detailed information about the Send connector named Contoso.com Send Connector. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md new file mode 100644 index 0000000000..b89a8e9412 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SenderFilterConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SenderFilterConfig cmdlet to view the Sender Filter configuration information for the Exchange server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SenderFilterConfig [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SenderFilterConfig | Format-List +``` + +This example returns detailed information about the Sender Filter configuration for the Exchange server. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md b/exchange/exchange-ps/exchange/Get-SenderIdConfig.md new file mode 100644 index 0000000000..1e0dad4cd1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SenderIdConfig.md @@ -0,0 +1,75 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SenderIdConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SenderIdConfig cmdlet to view the Sender ID configuration information for the Exchange server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SenderIdConfig | Format-List +``` + +This example returns detailed information about the Sender ID configuration on the Exchange server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md b/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md new file mode 100644 index 0000000000..83288be5e1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md @@ -0,0 +1,75 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SenderReputationConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SenderReputationConfig cmdlet to view the configuration information for sender reputation on the computer on which the command is run. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SenderReputationConfig | Format-List +``` + +This example returns detailed information about the sender reputation configuration for the Exchange server. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ServerComponentState.md b/exchange/exchange-ps/exchange/Get-ServerComponentState.md new file mode 100644 index 0000000000..2008d37985 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ServerComponentState.md @@ -0,0 +1,120 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ServerComponentState + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ServerComponentState cmdlet to retrieve configuration settings for Microsoft Exchange components and endpoints. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ServerComponentState [-Identity] + [-Component ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ServerComponentState -Identity Mailbox01 +``` + +This example returns a summary list of all component and endpoint states on the server named Mailbox01. + +### Example 2 +```powershell +Get-ServerComponentState -Identity Mailbox01 -Component UnifiedMessaging | Format-List +``` + +This example returns detailed information for the component state of the Unified Messaging component on the server named Mailbox01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange server where you want to view the configuration settings. You can use the following values: + +- Name +- Distinguished name (DN) +- FQDN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Component +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 +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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-ServerHealth.md b/exchange/exchange-ps/exchange/Get-ServerHealth.md new file mode 100644 index 0000000000..329cfe409b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ServerHealth.md @@ -0,0 +1,123 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ServerHealth + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ServerHealth cmdlet to return health information related to the server you specify. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ServerHealth [-Identity] + [-HaImpactingOnly] + [-HealthSet ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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: + +- Degraded +- Unhealthy +- Repairing +- Disabled +- Unavailable +- UnInitialized + +## EXAMPLES + +### Example 1 +```powershell +Get-ServerHealth -Identity Server01 +``` + +This example returns the server health for server Server01. + +## PARAMETERS + +### -Identity +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -HaImpactingOnly +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthSet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md new file mode 100644 index 0000000000..2986dafdb9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md @@ -0,0 +1,80 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ServerMonitoringOverride + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ServerMonitoringOverride cmdlet to return all overrides created on the specified server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ServerMonitoringOverride -Server Exch01 +``` + +This example retrieves all monitoring overrides for the Exch01 server. + +## PARAMETERS + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use this parameter to configure other Edge Transport servers remotely. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md b/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md new file mode 100644 index 0000000000..842dc2fa11 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-ServiceDeliveryReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ServiceDeliveryReport cmdlet to view information about the message delivery path for a specified recipient. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ServiceDeliveryReport [-ProbeTag ] + [-Recipient ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-ServiceDeliveryReport -Recipient chris@contoso.com +``` + +This example shows the delivery path information for the recipient chris@contoso.com. + +## PARAMETERS + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recipient +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md new file mode 100644 index 0000000000..ee06d9d363 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: Get-ServicePrincipal +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ServicePrincipal + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ServicePrincipal cmdlet to view information about service principals in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ServicePrincipal [[-Identity] ] + [-Organization ] + [] +``` + +## DESCRIPTION +Service principals exist in Microsoft Entra ID to define what apps can do, who can access the apps, and what resources the apps can access. In Exchange Online, service principals are references to the service principals in Microsoft Entra ID. To assign Exchange Online role-based access control (RBAC) roles to service principals in Microsoft Entra ID, you use the service principal references in Exchange Online. The **\*-ServicePrincipal** cmdlets in Exchange Online PowerShell let you view, create, and remove these service principal references. + +For more information, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ServicePrincipal +``` + +This example returns a summary list of all service principals within an organization. + +### Example 2 +```powershell +Get-ServicePrincipal -Identity ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1 | Format-List +``` + +This example returns detailed information about the service principal with the ObjectId value ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to view. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ObjectId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SettingOverride.md b/exchange/exchange-ps/exchange/Get-SettingOverride.md new file mode 100644 index 0000000000..dec2d72019 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SettingOverride.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SettingOverride + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +**Caution**: Incorrect usage of the setting override cmdlets can cause serious damage to your Exchange organization. This damage could require you to reinstall Exchange. Only use these cmdlets as instructed by product documentation or under the direction of Microsoft Customer Service and Support. + +Use the Get-SettingOverride cmdlet to view existing setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SettingOverride [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SettingOverride | Format-List Name,Reason,ComponentName,SectionName,Parameters,Server +``` + +This example displays a summary list of all setting override objects. + +### Example 2 +```powershell +Get-SettingOverride -Identity "IM Server Integration" +``` + +This example displays a detailed information for the setting override object named IM Server Integration. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the setting override that you want to view. You can use any value that uniquely identifies the override. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SettingOverrideIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SharingPolicy.md b/exchange/exchange-ps/exchange/Get-SharingPolicy.md new file mode 100644 index 0000000000..a9e5d5b87f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SharingPolicy.md @@ -0,0 +1,106 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-SharingPolicy cmdlet to view existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SharingPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing settings for the mailbox. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SharingPolicy -Identity FourthCoffee +``` + +This example retrieves the default information for the sharing policy FourthCoffee. + +### Example 2 +```powershell +Get-SharingPolicy Fabrikam | Format-List +``` + +This example retrieves the full information for the sharing policy Fabrikam. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the sharing policy that you want to view. You can use one of the following values: + +- ADObjectID +- Distinguished name (DN) +- Legacy DN +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SiteMailbox.md b/exchange/exchange-ps/exchange/Get-SiteMailbox.md new file mode 100644 index 0000000000..a35a4f6e0c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SiteMailbox.md @@ -0,0 +1,214 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SiteMailbox + +## 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. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SiteMailbox [[-Identity] ] + [-Anr ] + [-BypassOwnerCheck] + [-DeletedSiteMailbox] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite +``` + +This example returns the default information about the site mailbox ContentSite, which includes the site name, when the site mailbox was closed, and the SharePoint URL. + +### Example 2 +```powershell +Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite | Format-List +``` + +This example returns the full information about the site mailbox ContentSite. + +### Example 3 +```powershell +Get-SiteMailbox -BypassOwnerCheck -DeletedSiteMailbox | Remove-Mailbox -Confirm:$false +``` + +This example queries for site mailboxes that are marked for deletion and removes them from the mailbox database by pipelining the Remove-Mailbox cmdlet. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassOwnerCheck +The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedSiteMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md b/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md new file mode 100644 index 0000000000..a79fefc2f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md @@ -0,0 +1,164 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SiteMailboxDiagnostics + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SiteMailboxDiagnostics [-Identity] + [-BypassOwnerCheck] + [-Confirm] + [-SendMeEmail] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SiteMailboxDiagnostics -BypassOwnerCheck -Identity "Marketing Events 2015" +``` + +This example returns the event information for the site mailbox by using its display name Marketing Events 2015. + +### Example 2 +```powershell +Get-SiteMailboxDiagnostics -BypassOwnerCheck -Identity events2015@contoso.com -SendMeEmail +``` + +This example returns the event information for the Marketing Events 2015 site mailbox and sends an email to the primary SMTP address of the user running this command. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassOwnerCheck +The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. + +If you don't use this switch and you aren't a member or owner of the site mailbox, the command will fail. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendMeEmail +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Get-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md new file mode 100644 index 0000000000..1e107e4c93 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md @@ -0,0 +1,105 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SiteMailboxProvisioningPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SiteMailboxProvisioningPolicy cmdlet to view site mailbox provisioning policies. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SiteMailboxProvisioningPolicy [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SiteMailboxProvisioningPolicy +``` + +This example returns a summary list of all site mailbox provisioning policies in your organization. + +### Example 2 +```powershell +Get-SiteMailboxProvisioningPolicy -Identity SM_NewPolicy | Format-List +``` + +This example returns detailed information about the site mailbox provisioning policy named SM\_NewPolicy + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SmimeConfig.md b/exchange/exchange-ps/exchange/Get-SmimeConfig.md new file mode 100644 index 0000000000..94acefe7bf --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SmimeConfig.md @@ -0,0 +1,73 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-SmimeConfig cmdlet to view the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SmimeConfig +``` + +This example shows the S/MIME configuration that's used with Outlook on the web. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md b/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md new file mode 100644 index 0000000000..2bc72a8f55 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-smtpdaneinboundstatus +applicable: Exchange Online +title: Get-SmtpDaneInboundStatus +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SmtpDaneInboundStatus + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SmtpDaneInboundStatus cmdlet to view information about SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SmtpDaneInboundStatus [-DomainName] [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SmtpDaneInboundStatus -DomainName contoso.com +``` + +This example checks the DANE status for the accepted domain contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to view information about DANE (for example, contoso.com). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md b/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md new file mode 100644 index 0000000000..01335195b4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md @@ -0,0 +1,84 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SpoofIntelligenceInsight + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SpoofIntelligenceInsight cmdlet to view spoofed senders that were allowed or blocked by spoof intelligence during the last 30 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SpoofIntelligenceInsight [[-Identity] ] [] +``` + +## DESCRIPTION +The Get-SpoofIntelligenceInsight cmdlet returns the following information: + +- SpoofedUser: The sending email address if the domain is one of your organization's domains, or the sending domain if the domain is external. +- SendingInfrastructure: 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. +- MessageCount: The number of messages. +- LastSeen: The date when the sending email address or domain was last seen by Microsoft 365. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SpoofIntelligenceInsight +``` + +This example returns the list of senders that appear to be sending spoofed email to your organization. + +### Example 2 +```powershell +$file = "C:\My Documents\Spoof Insights.csv" + +Get-SpoofIntelligenceInsight | Export-Csv $file +``` + +This example exports the same list of spoofed senders to a CSV file. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md new file mode 100644 index 0000000000..312ec706dc --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md @@ -0,0 +1,212 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SpoofMailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SpoofMailReport cmdlet to view information about spoofed senders in your cloud-based organization for the past 90 days. Spoofing is where the sender of the inbound message is different than the actual source of the message (for example, the sender is lila@contoso.com, but the message was sent from the email infrastructure of fabrikam.com). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SpoofMailReport [-Action ] + [-Direction ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [] +``` + +## DESCRIPTION +The Get-SpoofMailReport cmdlet returns the following information: + +- Date: Date the message was sent. +- Event Type: Typically, this value is SpoofMail. +- 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. +- 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. +- Source: Typically, this value is "Spoof intelligence". +- Result: CompAuthResult +- Result Code: CompAuthReason +- SPF +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SpoofMailReport -StartDate 03/01/2020 -EndDate 03/11/2020 +``` + +This example shows the insider spoofing detections in your organization during the month of March 2016. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +Common values for this report are GoodMail and CaughtAsSpam. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md b/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md new file mode 100644 index 0000000000..4a09b7af84 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md @@ -0,0 +1,247 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-StoreUsageStatistics + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-StoreUsageStatistics cmdlet to aid in diagnosing performance issues with your servers or databases. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Database +``` +Get-StoreUsageStatistics -Database + [-CopyOnServer ] + [-DomainController ] + [-Filter ] + [] +``` + +### Identity +``` +Get-StoreUsageStatistics [-Identity] + [-CopyOnServer ] + [-DomainController ] + [-Filter ] + [] +``` + +### Server +``` +Get-StoreUsageStatistics -Server + [-IncludePassive] + [-DomainController ] + [-Filter ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-StoreUsageStatistics -Server EX1 | ft -auto +``` + +This example retrieves store usage statistics for all active databases on server EX1. + +### Example 2 +```powershell +Get-StoreUsageStatistics -Server EX1 -IncludePassive | ft -auto +``` + +This example retrieves store usage statistics for all active and passive databases on server EX1. + +### Example 3 +```powershell +Get-StoreUsageStatistics -Database DB1 | Sort-Object LogRecordBytes -desc | Select-Object -First 10 | ft DigestCategory, *guid, LogRecordBytes, *time* -auto +``` + +This example retrieves store usage statistics for database DB1 and sorts the output by the 10 highest log file generators. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox to get usage statistics from. You can use one of the following values to identify the mailbox: + +- GUID +- Distinguished name (DN) +- Domain\\Account +- User principal name (UPN) +- Legacy Exchange DN +- SMTP address +- Alias + +The command returns results for the mailbox only if it's one of the top 25 users of store resources. + +You can't use this parameter with the Database or Server parameters. + +```yaml +Type: GeneralMailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Database +The Database parameter specifies the name of the mailbox database to get usage statistics from (the top 25 largest mailboxes on the specified mailbox database). You can use any value that uniquely identifies the mailbox database. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity or Server parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Mailbox server to get usage statistics from (the top 25 mailboxes on all active databases on the specified server). You can use one of the following values to identify the server: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +You can't use this parameter with the Database or Identity parameters. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CopyOnServer +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 +- Distinguished name (DN) +- GUID + +You use this parameter with the Server or Identity parameters. + +```yaml +Type: ServerIdParameter +Parameter Sets: Database, Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (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 +``` + +### -IncludePassive +The IncludePassive switch specifies whether to include usage statistics from active and passive copies of mailbox databases on the Mailbox server you specified with the Server parameter. You don't need to specify a value with this switch. + +If you don't use this switch, only statistics from active copies of mailbox databases are included in the results. + +```yaml +Type: SwitchParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md new file mode 100644 index 0000000000..420045a251 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewActivity + +## 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. + +For 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-SupervisoryReviewActivity -EndDate -PolicyId -StartDate + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SupervisoryReviewActivity -PolicyId $policyId -StartDate $startDate -EndDate $endDate | Sort-Object Timestamp -Descending | Format-List PolicyId,ItemSubject,ActivityId,Timestamp,ActionType,ActionAppliedBy,ItemStatusAfterAction +``` + +This example returns all the supervisory review activities for specified supervision policy. + +### Example 2 +```powershell +Get-SupervisoryReviewActivity -PolicyId $policyId -StartDate $startDate -EndDate $endDate | Sort-Object Timestamp -Descending | select-object PolicyId,ItemSubject,ActivityId,Timestamp,ActionType,ActionAppliedBy,ItemStatusAfterAction | Export-csv 'C:\Temp\SupervisoryReviewActivity.csv' +``` + +This example exports all the supervisory review activities for a policy to a .csv file named "SupervisoryReviewActivity". + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +{{ Fill PolicyId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, 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/Get-SupervisoryReviewOverallProgressReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md new file mode 100644 index 0000000000..3a432c1505 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md @@ -0,0 +1,122 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewOverallProgressReport + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-SupervisoryReviewOverallProgressReport cmdlet to view the total number of supervised communications classified as Pending, Resolved, Compliant, Non-compliant, and Questionable. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SupervisoryReviewOverallProgressReport [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [] +``` + +## 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-SupervisoryReviewOverallProgressReport | ft Pending, Resolved, Compliant, Noncompliant, Questionable +``` + +This example returns a list of the total number of supervised communications classified by status. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: 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-SupervisoryReviewPolicyReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md new file mode 100644 index 0000000000..d3982ce31b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md @@ -0,0 +1,157 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewPolicyReport + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-SupervisoryReviewPolicyReport cmdlet to view supervisory review policy events in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SupervisoryReviewPolicyReport [-EndDate ] + [-Page ] + [-PageSize ] + [-Policies ] + [-StartDate ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the Get-SupervisoryReviewPolicyReport cmdlet returns the following information: + +- Organization +- Date +- Policy +- Message Type +- Tag Type: Messages that are eligible for evaluation by the policy are `InPurview`. Messages that match the conditions of the policy are `HitPolicy`. Classifications that are manually assigned to messages by the designated reviewers using the Supervision add-in for Outlook web app are `Compliant`, `Non-compliant`, `Questionable`, and `Resolved`. Messages that match the conditions of a policy but haven't been reviewed by a designated reviewer are `Not-Reviewed`. Messages that match the conditions of a policy and have been reviewed by a designated reviewer are `New-Reviewed`. +- Item Count + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SupervisoryReviewPolicyReport -StartDate 03/01/2018 -EndDate 03/31/2018 +``` + +This example returns the supervisory review policy events for the month of March, 2018. + +### Example 2 +```powershell +Get-SupervisoryReviewPolicyReport -Policies "EU Brokers Policy" +``` + +This example returns the supervisory review policy events for the policy named EU Brokers Policy. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policies +The Policies parameter filters the results by the supervisory review policy. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md new file mode 100644 index 0000000000..cc356b57a5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md @@ -0,0 +1,78 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewPolicyV2 + +## 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-SupervisoryReviewPolicyV2 cmdlet to view supervisory review policies in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SupervisoryReviewPolicyV2 [[-Identity] ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SupervisoryReviewPolicyV2 +``` + +This example returns a summary list of all supervisory review policies. + +### Example 2 +```powershell +Get-SupervisoryReviewPolicyV2 -Identity "EU Brokers Policy" | Format-List +``` + +This example returns detailed information for the supervisory review policy named EU Brokers Policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SupervisoryReviewReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md new file mode 100644 index 0000000000..5e1a033aa5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md @@ -0,0 +1,167 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewReport + +## 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-SupervisoryReviewReport cmdlet to view supervisory review events in the Microsoft Purview compliance portal for the last 90 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SupervisoryReviewReport [-EndDate ] + [-Page ] + [-PageSize ] + [-Policies ] + [-Reviewers ] + [-StartDate ] + [] +``` + +## 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-SupervisoryReviewReport -StartDate 03/01/2018 -EndDate 03/31/2018 +``` + +This example returns the supervisory review events for the month of March, 2018. + +### Example 2 +```powershell +Get-SupervisoryReviewPolicyReport -Policies "US Brokers Policy" +``` + +This example returns the supervisory review events for the policy named US Brokers Policy. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policies +The Policies parameter filters the results by the supervisory review policy. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reviewers +The Reviewers parameter filters the results by the reviewers of the supervisory review policy. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, 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-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md new file mode 100644 index 0000000000..1a7f812f23 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md @@ -0,0 +1,123 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewRule + +## 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-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SupervisoryReviewRule [[-Identity] ] + [-IncludeRuleXml] + [-Policy ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SupervisoryReviewRule +``` + +This example returns a summary list of all supervisory review rules. + +### Example 2 +```powershell +Get-SupervisoryReviewRule -Identity "EU Brokers Rule" | Format-List +``` + +This example returns detailed information for the supervisory review rule named EU Brokers Rule. + +### Example 3 +```powershell +Get-SupervisoryReviewRule -Policy "EU Brokers Policy" +``` + +This example returns the rule that assigned to the supervisory review policy named EU Brokers Policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +``` + +### -IncludeRuleXml +{{ Fill IncludeRuleXml Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the results by supervisory review policy that's assigned to the rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md new file mode 100644 index 0000000000..f630b5e84b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md @@ -0,0 +1,121 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-SupervisoryReviewTopCasesReport + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-SupervisoryReviewTopCasesReport cmdlet to view the current status of the top supervision policies configured in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SupervisoryReviewTopCasesReport [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [] +``` + +## 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-SupervisoryReviewTopCasesReport | Sort-Object Policy | Format-Table Policy,Pending,Total,Date +``` +This example returns detailed information on supervisory policies, including the policy name, the total number of communications under review and pending, and the date of the report. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: 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-SweepRule.md b/exchange/exchange-ps/exchange/Get-SweepRule.md new file mode 100644 index 0000000000..ceab5bc86d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SweepRule.md @@ -0,0 +1,203 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SweepRule [[-Identity] ] + [-BypassScopeCheck] + [-DomainController ] + [-Mailbox ] + [-Provider ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SweepRule +``` + +This example returns a summary list of all Sweep rules. + +### Example 2 +```powershell +Get-SweepRule -Mailbox julia@contoso.com +``` + +This example returns a summary list of all Sweep rules in the specified mailbox. + +### Example 3 +```powershell +Get-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" +``` + +This example returns detailed information for the Sweep rule with the specified RuleId property value. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). + +```yaml +Type: SweepRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassScopeCheck +The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter filters the results by the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Provider +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SystemMessage.md b/exchange/exchange-ps/exchange/Get-SystemMessage.md new file mode 100644 index 0000000000..ba18ccc28c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SystemMessage.md @@ -0,0 +1,194 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SystemMessage + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-SystemMessage cmdlet to view default or custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Get-SystemMessage [[-Identity] ] + [-DomainController ] + [] +``` + +### Original +``` +Get-SystemMessage [-Original] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-SystemMessage +``` + +This example displays a summary list of all custom system messages in your organization. + +### Example 2 +```powershell +Get-SystemMessage En\Internal\5.3.2 | Format-List +``` + +This example displays detailed information for the specified custom NDR (combination of language, audience, and enhanced status code values). + +### Example 3 +```powershell +Get-SystemMessage En\WarningMailbox | Format-List +``` + +This example displays detailed information for the specified custom quota message (combination of language and quota values). + +### Example 4 +```powershell +Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default System Messages.html" +``` + +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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the custom system message that you want to view. You can use any value that uniquely identifies the system message. For example: + +- Identity +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Original switch. + +The identity value of a system message uses one of these formats: + +- System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailbox`. + +\: 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). + +\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command `Get-SystemMessage`. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. + +\: Valid value are: + +Mailbox size quotas: + +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. +- ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. +- WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. +- WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. + +Public folder size quotas: + +- ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. +- WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. +- WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. + +Maximum number of messages in a mailbox folder: + +- ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. +- WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. +- WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. + +Maximum number of subfolders in a mailbox folder: + +- ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. +- WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. +- WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. +- ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. +- WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. +- WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. + +Maximum number of levels (depth) in a mailbox folder: + +- ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. +- WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. +- WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. + +```yaml +Type: SystemMessageIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Original +The Original switch filters the results by the default system messages that are included with Exchange. You don't need to specify a value with this switch. + +You can't use this switch with the Identity parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: Original +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md new file mode 100644 index 0000000000..4f520c8a57 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md @@ -0,0 +1,67 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicy +applicable: Exchange Online +title: Get-TeamsProtectionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TeamsProtectionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-TeamsProtectionPolicy cmdlet to view Microsoft Teams protection policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TeamsProtectionPolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-TeamsProtectionPolicy +``` + +This example shows detailed information about the Teams protection policy in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy that you want to view. There's only one Teams protection policy in an organization named Teams Protection Policy. + +```yaml +Type: TeamsProtectionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md new file mode 100644 index 0000000000..5aba335ec7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicyrule +applicable: Exchange Online +title: Get-TeamsProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TeamsProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-TeamsProtectionPolicyRule cmdlet to view Microsoft Teams protection policy rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TeamsProtectionPolicyRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-TeamsProtectionPolicyRule +``` + +This example shows detailed information about the Teams protection policy in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy rule that you want to view. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the State value of the rule. Valid values are: + +- Enabled +- Disabled + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md new file mode 100644 index 0000000000..f2a8862ef7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -0,0 +1,232 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-TenantAllowBlockListItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-TenantAllowBlockListItems cmdlet to view entries in the Tenant Allow/Block List in the Microsoft Defender portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Expiration (Default) +``` +Get-TenantAllowBlockListItems -ListType [-ExpirationDate ] + [-Allow] + [-Block] + [-Entry ] + [-ListSubType ] + [-OutputJson] + [] +``` + +### NoExpiration +``` +Get-TenantAllowBlockListItems -ListType [-NoExpiration] + [-Allow] + [-Block] + [-Entry ] + [-ListSubType ] + [-OutputJson] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-TenantAllowBlockListItems -ListType Url -Block +``` + +This example returns all blocked URLs. + +### Example 2 +```powershell +Get-TenantAllowBlockListItems -ListType FileHash -Entry "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08" +``` + +This example returns information for the specified file hash value. + +### Example 3 +```powershell +Get-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery +``` + +This example returns information for all allowed third-party phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +## PARAMETERS + +### -ListType +The ListType parameter specifies the list to view. Valid values are: + +- FileHash +- Sender +- Url +- IP + +```yaml +Type: ListType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Entry +The Entry parameter filters the results based on the ListType parameter value. Valid values are: + +- FileHash: The exact SHA256 file hash value. +- Sender: The exact domain or email address value. +- Url: The exact URL value. +- IP: IPv6 addresses only. Single IPv6 addresses in colon-hexadecimal or zero-compression format or CIDR IPv6 ranges from 1 to 128. + +This value is shown in the Value property of the entry in the output of the Get-TenantAllowBlockListItems cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiration +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Allow +The Allow switch filters the results for allow entries. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Block switch filters the results for block entries. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDate +The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: Expiration +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType parameter filters the results by subtype. Valid values are: + +- AdvancedDelivery +- Tenant: This is the default value. + +```yaml +Type: ListSubType[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputJson +The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. + +You use this switch to prevent the command from halting on the first entry that contains a syntax error. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md new file mode 100644 index 0000000000..a77fd3036a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-TenantAllowBlockListSpoofItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-TenantAllowBlockListSpoofItems cmdlet to view spoofed sender entries in the Tenant Allow/Block List. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TenantAllowBlockListSpoofItems [[-Identity] ] + [-Action ] + [-SpoofType ] + [] +``` + +## DESCRIPTION +The Get-TenantAllowBlockListSpoofItems cmdlet returns the following information: + +- Identity: A random Guid assigned to the spoof pair. This will be used as an **Id parameter** while updating or deleting the spoof pair using **Set-TenantAllowBlockListSpoofItems** and **Remove-TenantAllowBlockListSpoofItems**. +- SpoofedUser: The sending email address if the domain is one of your organization's domains or the sending domain if the domain is external. +- SendingInfrastructure: 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. +- SpoofType: Indicates whether the domain is internal to your organization or external. +- Action: The two possible values are Allow (messages that contain any spoofed sender email addresses in your organization are allowed from the source email server) or Block (messages that contain any spoofed sender email addresses in your organization are not allowed from the source email server). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-TenantAllowBlockListSpoofItems -SpoofType Internal +``` +This example returns the list of internal spoof pairs. + +### Example 2 +```powershell +Get-TenantAllowBlockListSpoofItems -Action Block +``` +This example returns the list of blocked spoof pairs. + +### Example 3 +```powershell +Get-TenantAllowBlockListSpoofItems | Format-Table SpoofedUser,SendingInfrastructure,SpoofType,Action +``` + +This example returns the list of spoof pairs that appear to be sending spoofed email to your organization. + +### Example 4 +```powershell +$file = "C:\My Documents\Spoof Tenant Allow Block List.csv" + +Get-TenantAllowBlockListSpoofItems | Export-Csv $file +``` + +This example exports the same list of spoofed pairs to a CSV file. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Action +The Action parameter filters the results by action type. Valid values are: + +- Allow +- Block + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpoofType +The SpoofType parameter filters the results by spoof type. Valid values are: + +- External +- Internal + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md new file mode 100644 index 0000000000..11e102c7e7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md @@ -0,0 +1,171 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-TextMessagingAccount cmdlet to view the text notification settings on mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TextMessagingAccount [-Identity] + [-Credential ] + [-DomainController ] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TextMessagingAccount -Identity tony@contoso.com +``` + +This example returns the text messaging settings for Tony's mailbox. + +### Example 2 +```powershell +$mbx = Get-Mailbox -RecipientTypeDetails UserMailbox -ResultSize Unlimited + +$mbx | foreach {Get-TextMessagingAccount -Identity $_.Alias | where {($_.NotificationPhoneNumberVerified -eq $true)} | Format-Table Identity,NotificationPhoneNumber} +``` + +This example finds all user mailboxes where text messaging notifications are enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md new file mode 100644 index 0000000000..5299f4079b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ThrottlingPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ThrottlingPolicy cmdlet to view the user throttling settings for one or more throttling policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ThrottlingPolicy [[-Identity] ] + [-DomainController ] + [-Diagnostics] + [-Explicit] + [-ThrottlingPolicyScope ] + [] +``` + +## DESCRIPTION +The Get-ThrottlingPolicy cmdlet returns the client throttling settings for one or more throttling policies. If you use the Identity parameter, the cmdlet returns the settings for the identified throttling policy. If you don't use the Identity parameter, the cmdlet returns the settings for all throttling policies. + +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ThrottlingPolicy | Format-List +``` + +This example returns the settings for all throttling policies. + +### Example 2 +```powershell +Get-ThrottlingPolicy -Identity ThrottlingPolicy2 | Format-List +``` + +This example displays the parameters and values for throttling policy ThrottlingPolicy2. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Diagnostics +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Explicit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottlingPolicyScope +The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values: + +- Global +- Organization +- Regular + +For information about each of these policy scopes, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). + +```yaml +Type: ThrottlingPolicyScopeType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md new file mode 100644 index 0000000000..6850db5cc9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md @@ -0,0 +1,210 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ThrottlingPolicyAssociation + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ThrottlingPolicyAssociation cmdlet to view existing throttling policy associations in your organization. Throttling policies can be associated with mailboxes, user accounts, mail contacts, mail users, and Exchange server computer accounts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-ThrottlingPolicyAssociation [-Anr ] + [-DomainController ] + [-ResultSize ] + [-SortBy ] + [-ThrottlingPolicy ] + [] +``` + +### Identity +``` +Get-ThrottlingPolicyAssociation [[-Identity] ] + [-DomainController ] + [-ResultSize ] + [-SortBy ] + [-ThrottlingPolicy ] + [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-ThrottlingPolicyAssociation -ResultSize unlimited +``` + +This example retrieves a summary list of all throttling policy associations in your organization. + +### Example 2 +```powershell +Get-ThrottlingPolicyAssociation -Anr Chr -DomainController DC01 +``` + +In Exchange Server 2010 and 2013, this example returns all the mailboxes that resolve from the ambiguous name resolution search on the string "Chr" that are in the domain DC01. This example returns mailboxes for users such as Chris Ashton, Christian Hess, and Christa Geller. + +### Example 3 +```powershell +Get-ThrottlingPolicyAssociation -Identity "Courtney Sweet" | Format-List +``` + +This example returns detailed information for the throttling policy association named Courtney Sweet. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID For example: +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: ThrottlingPolicyAssociationIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +Type: String +Parameter Sets: AnrSet +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 +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -SortBy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottlingPolicy +The ThrottlingPolicy parameter filters the results by throttling policy. You can use any value that uniquely identifies the throttling policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ThrottlingPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportAgent.md b/exchange/exchange-ps/exchange/Get-TransportAgent.md new file mode 100644 index 0000000000..8efaaf32bc --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportAgent.md @@ -0,0 +1,122 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TransportAgent + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-TransportAgent cmdlet to view the configuration of a transport agent. + +For 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-TransportAgent [[-Identity] ] + [-DomainController ] + [-TransportService ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-TransportAgent +``` + +This example displays a summary list of all transport agents installed on all Exchange servers in your organization. + +### Example 2 +```powershell +Get-TransportAgent "Transport Rule Agent" -TransportService Hub | Format-List +``` + +This example displays detailed information about the Transport Rule agent that's installed in the Transport service on a Mailbox server. The output of the Get-TransportAgent command is piped to the Format-List command to display the detailed configuration of the transport agent. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the display name of the transport agent to be displayed. The length of the name can't exceed 64 characters. + +```yaml +Type: TransportAgentObjectId +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportService +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. +- MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. +- MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. +- FrontEnd for the Front End Transport service on Mailbox servers. +- Edge on Edge Transport servers. + +```yaml +Type: TransportService +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportConfig.md b/exchange/exchange-ps/exchange/Get-TransportConfig.md new file mode 100644 index 0000000000..3357a4be56 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportConfig.md @@ -0,0 +1,105 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-TransportConfig cmdlet to view organization-wide transport configuration settings. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TransportConfig [[-Identity] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportConfig +``` + +This example lists the organization-wide transport settings on Mailbox server, or the local transport settings on an Edge Transport server. + +### Example 2 +```powershell +Get-TransportConfig | Format-List *DSN* +``` + +This example lists all delivery status notification-related (DSN) configuration settings for your organization when run on a Mailbox server. When run on an Edge Transport server, it displays the DSN-related settings configured on that Edge Transport server. + +## PARAMETERS + +### -Identity +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportPipeline.md b/exchange/exchange-ps/exchange/Get-TransportPipeline.md new file mode 100644 index 0000000000..8366b7fc1a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportPipeline.md @@ -0,0 +1,90 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TransportPipeline + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-TransportPipeline cmdlet to view transport agents and the SMTP event where the transport agent is registered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TransportPipeline [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-TransportPipeline cmdlet enables you to view all the transport agents that are configured in the following locations: + +- In the Transport service on Mailbox servers. +- In the Front End Transport service on Mailbox servers. +- On Edge Transport server in the perimeter network. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportPipeline +``` + +This example returns a summary list of all agents in the transport pipeline that were involved in processing email messages since the last server or service restart. + +### Example 2 +```powershell +Get-TransportPipeline | Format-List +``` + +This example returns a list of agents registered in the transport pipeline, with full details for each transport event. + +## PARAMETERS + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportRule.md b/exchange/exchange-ps/exchange/Get-TransportRule.md new file mode 100644 index 0000000000..d55f8756f4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportRule.md @@ -0,0 +1,226 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-TransportRule cmdlet to view transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TransportRule [[-Identity] ] + [-DomainController ] + [-State ] + [-DlpPolicy ] + [-ExcludeConditionActionDetails ] + [-Filter ] + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportRule +``` + +This example returns a summary list of all rules in your organization. + +### Example 2 +```powershell +Get-TransportRule "Ethical Wall - Sales and Brokerage Departments" | Format-List +``` + +This example returns detailed information for the rule named "Ethical Wall - Sales and Brokerage Departments". + +For more information about pipelining, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +### Example 3 +```powershell +Get-TransportRule -DlpPolicy "PII (U.S.)" +``` + +In on-premises Exchange, this example returns a summary list of the rules that enforce the DLP policy named PII (U.S.) in the organization. + +### Example 4 +```powershell +Get-TransportRule | Where {$_.DlpPolicy -ne $null} +``` + +In on-premises Exchange, this example returns a summary list of all rules that enforce DLP policies in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```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 +``` + +### -State +The State parameter specifies filters the results by enabled or disabled rules. Valid values are: + +- Enabled: Only enabled rules are returned in the results. +- Disabled: Only disabled rules are returned in the results. + +If you don't use this parameter, the command returns all rules, both enabled and disabled. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPolicy +**Note**: This parameter is functional only in on-premises Exchange. + +The DlpPolicy parameter filters the results by the name of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks ("). + +DLP policies in your organization allow you to prevent unintentional disclosure of sensitive information. Each DLP policy is enforced using a set of transport rules. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeConditionActionDetails +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter filters the results by using an OPATH. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule. + +This parameter uses the syntax `"Description -like 'Text*'"`. For example, `"Description -like '192.168.1.1*'"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md b/exchange/exchange-ps/exchange/Get-TransportRuleAction.md new file mode 100644 index 0000000000..a7052dc127 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportRuleAction.md @@ -0,0 +1,84 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-TransportRuleAction cmdlet to view the actions that are available for transport rules (mail flow rules). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportRuleAction +``` + +This example returns a summary list of all actions. + +### Example 2 +```powershell +Get-TransportRuleAction -Name DeleteMessage | Format-List +``` + +This example retrieves detailed information about the action named DeleteMessage. + +For more information about pipelining, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md b/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md new file mode 100644 index 0000000000..1781b502e3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md @@ -0,0 +1,95 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-TransportRulePredicate cmdlet to view the predicates (conditions and exceptions) that are available for transport rules (mal flow rules). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TransportRulePredicate [[-Name] ] + [] +``` + +## DESCRIPTION +Collectively, the conditions and exceptions in rules are known as predicates, because for every condition, there's a corresponding exception that uses the exact same settings and syntax. The only difference is conditions specify messages to include, while exceptions specify messages to exclude. That's why the output of this cmdlet doesn't list exceptions separately. Also, the names of some of the predicates that are returned by this cmdlet are different than the corresponding parameter names in the New-TransportRule and Set-TransportRule cmdlets. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportRulePredicate +``` + +This example returns a summary list of all predicates. + +### Example 2 +```powershell +Get-TransportRulePredicate -Name SubjectMatches | Format-List +``` + +This example returns detailed information about the predicate named SubjectMatches. + +For more information about pipelining, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +### Example 3 +```powershell +Get-TransportRulePredicate | Where {$_.Name -like "*Attachment*"} +``` + +This example returns a summary list of all predicates that have Attachment in the name. + +For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportServer.md b/exchange/exchange-ps/exchange/Get-TransportServer.md new file mode 100644 index 0000000000..9e6bfd34f4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportServer.md @@ -0,0 +1,106 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TransportServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-TransportServer cmdlet to view settings that are associated with the Hub Transport server role or the Edge Transport server role. + +**Note**: In Exchange 2013 or later, use the Get-TransportService cmdlet instead. If you have scripts that use Get-TransportServer, update them to use Get-TransportService. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TransportServer [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportServer +``` + +This example provides different results depending on the server role on which it's run. When you run this command on an Edge Transport server, it provides a configuration summary for the local server. Otherwise, it displays a list of all Mailbox servers in your organization. + +### Example 2 +```powershell +Get-TransportServer Mailbox01 | Format-List +``` + +This example retrieves the detailed transport configuration information for the Transport service on the Mailbox server named Mailbox01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Transport server that you want to view. You can use any value that uniquely identifies the server. For example: + +- Name +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: TransportServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TransportService.md b/exchange/exchange-ps/exchange/Get-TransportService.md new file mode 100644 index 0000000000..de2c585879 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TransportService.md @@ -0,0 +1,106 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TransportService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-TransportService cmdlet to view the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TransportService [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TransportService +``` + +This example provides different results depending on the server role on which it's run. When you run this command on an Edge Transport server, it provides a configuration summary for the local server. Otherwise, it displays a list of all Mailbox servers in your organization. + +### Example 2 +```powershell +Get-TransportService Mailbox1 | Format-List +``` + +This example retrieves the detailed transport configuration information for the Transport service on the Mailbox server named Mailbox1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to view. You can use any value that uniquely identifies the server. For example: + +- Name +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use this parameter on an Edge Transport server. + +```yaml +Type: TransportServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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/Get-Trust.md b/exchange/exchange-ps/exchange/Get-Trust.md new file mode 100644 index 0000000000..06c4e8a053 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-Trust.md @@ -0,0 +1,75 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-Trust + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-Trust cmdlet to return external and forest trusts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Trust -DomainName Contoso.com +``` + +This example enumerates all trusts for the domain Contoso.com. + +## PARAMETERS + +### -DomainName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md new file mode 100644 index 0000000000..ad6d739107 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md @@ -0,0 +1,200 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMActiveCalls + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMActiveCalls cmdlet to return information about the calls that are active and being processed by the Mailbox server running the Microsoft Exchange Unified Messaging service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DialPlan +``` +Get-UMActiveCalls -DialPlan + [-DomainController ] + [] +``` + +### ServerInstance +``` +Get-UMActiveCalls -InstanceServer + [-DomainController ] + [] +``` + +### UMIPGateway +``` +Get-UMActiveCalls -IPGateway + [-DomainController ] + [] +``` + +### Server +``` +Get-UMActiveCalls [-Server ] + [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-UMActiveCalls cmdlet returns information about the active calls being processed. If the Get-UMActiveCalls cmdlet specifies either the UM dial plan or UM IP gateway, it looks in Active Directory to determine which Mailbox server running the Microsoft Exchange Unified Messaging service must be contacted. If the Mailbox server is specified at a command prompt, the Get-UMActiveCalls cmdlet returns the active calls being processed by the server specified. + +When a Mailbox server is process cycling, the Get-UMActiveCalls cmdlet doesn't return a list of all calls for both the discontinued process and the active process. It returns the active calls only for the new process. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMActiveCalls +``` + +This example displays the details of all active calls on the local Mailbox server. + +### Example 2 +```powershell +Get-UMActiveCalls -Server MyUMServer +``` + +This example displays the details of all active calls on the Mailbox server MyUMServer. + +### Example 3 +```powershell +Get-UMActiveCalls -IPGateway MyUMIPGateway +``` + +This example displays the details of all active calls being processed by the UM IP gateway MyUMIPGateway. + +### Example 4 +```powershell +Get-UMActiveCalls -DialPlan MyUMDialPlan +``` + +This example displays a list of active calls associated with the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -DialPlan +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. + +```yaml +Type: UMDialPlanIdParameter +Parameter Sets: DialPlan +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceServer +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. + +```yaml +Type: UMServer +Parameter Sets: ServerInstance +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPGateway +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. + +```yaml +Type: UMIPGatewayIdParameter +Parameter Sets: UMIPGateway +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter filters the results by the specified Unified Messaging server. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md new file mode 100644 index 0000000000..4ae3dced8b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMAutoAttendant + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMAutoAttendant cmdlet to retrieve the properties and the values for a Unified Messaging (UM) auto attendant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMAutoAttendant [[-Identity] ] + [-DomainController ] + [-UMDialPlan ] + [] +``` + +## DESCRIPTION +The Get-UMAutoAttendant cmdlet retrieves the properties for a single UM auto attendant or for a list of UM auto attendants. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMAutoAttendant | Format-List +``` + +This example returns a formatted list of all UM auto attendants in the Active Directory forest. + +### Example 2 +```powershell +Get-UMAutoAttendant -Identity MyUMAutoAttendant +``` + +This example displays the properties of the UM auto attendant MyUMAutoAttendant. + +### Example 3 +```powershell +Get-UMAutoAttendant -UMDialPlan MyUMDialPlan +``` + +This examples displays all the UM auto attendants associated with the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identifier for the UM auto attendant that's being viewed. This is the directory object ID for the UM auto attendant. + +```yaml +Type: UMAutoAttendantIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md new file mode 100644 index 0000000000..e469e77136 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMCallAnsweringRule + +## 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. + +For 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-UMCallAnsweringRule [[-Identity] ] + [-DomainController ] + [-Mailbox ] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith | Format-List +``` + +This example returns a formatted list of call answering rules in a user's UM-enabled mailbox. + +### Example 2 +```powershell +Get-UMCallAnsweringRule -Identity MyUMCallAnsweringRule +``` + +This example displays the properties of the call answering rule MyUMCallAnsweringRule. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the mailbox of the user who is running the command is used. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md b/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md new file mode 100644 index 0000000000..868677c8f0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md @@ -0,0 +1,118 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMCallDataRecord + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMCallDataRecord cmdlet to display Unified Messaging (UM) call data records for a specific UM-enabled user's mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMCallDataRecord -Mailbox + [-DomainController ] + [] +``` + +## DESCRIPTION +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. +- 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. +- CallingNumber: Phone number or address of the caller. +- CalledNumber: Phone number or address of the intended recipient of the call. +- Gateway: Fully qualified domain name (FQDN) of the UM IP gateway handling the call. +- Network MOS (NMOS): Mean opinion score for the network performance. +- NMOSDegradation: Total NMOS degradation, which is how far the NMOS reported value was from its top value for the corresponding audio codec. +- PercentagePacketLoss: Percentage that reflects the average network packet loss during the call. +- Jitter: Average jitter of the network. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMCallDataRecord -Mailbox tony@contoso.com +``` + +This example displays the UM call data records for the UM-enabled user Tony. + +## PARAMETERS + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md new file mode 100644 index 0000000000..44123198a3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md @@ -0,0 +1,106 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMCallRouterSettings + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMCallRouterSettings cmdlet to view the settings of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMCallRouterSettings [[-Server] ] + [-DomainController ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMCallRouterSettings +``` + +This example displays a summary list of the Microsoft Exchange Unified Messaging Call Router service settings on all Exchange servers in the Active Directory forest. + +### Example 2 +```powershell +Get-UMCallRouterSettings -Server EXCH01 | Format-List +``` + +This example displays detailed information for the Microsoft Exchange Unified Messaging Call Router service that's running on the server named EXCH01. + +## PARAMETERS + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md new file mode 100644 index 0000000000..87b5ea88f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md @@ -0,0 +1,171 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMCallSummaryReport + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMCallSummaryReport cmdlet to return statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMCallSummaryReport -GroupBy + [-DomainController ] + [-UMDialPlan ] + [-UMIPGateway ] + [] +``` + +## DESCRIPTION +The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all calls received or placed by servers running the Microsoft Exchange Unified Messaging service in an organization including voice messages, missed calls, subscriber access, auto attendant, or fax calls. The data returned by running this cmdlet includes audio quality metrics for the sample calls such as the following: + +- Date: Date in which all calls associated with the selected UM IP gateway and UM dial plan have been grouped based on the value of the GroupBy parameter: Total has the value ---, Month has the value MMM/YY and Day has the value MM/DD/YY, where MMM is the first three letters of the month and YY is the last two digits of the year. +- Voice Message: Percentage of incoming calls answered by Unified Messaging on behalf of users in which callers left a voice message. +- Missed Calls: Percentage of incoming calls answered by Unified Messaging on behalf of users in which the callers didn't leave a voice message resulting in a missed call notification. +- Outlook Voice Access: Percentage of incoming calls in which users authenticate to Unified Messaging to access their email, calendars, and voice messages. +- Outbound: Percentage of calls placed or transferred by Unified Messaging on behalf of authenticated or unauthenticated users. This property can have the value Find Me, Play On Phone, or Play On Phone Greetings. +- Automated Attendant: Percentage of incoming calls that were answered by auto attendants. +- Fax: Percentage of incoming calls that were redirected to a fax partner. +- Other: Percentage of any other incoming or placed calls that don't fall in any of the previous categories. This is provided to allow different types of calls that might be provided in the future to be accounted for as well. This category includes unauthenticated calls made to pilot numbers. +- Failed Or Rejected: Percentage of calls that either failed or were rejected by the server for that organization. +- Audio Quality: Overall audio quality for the selected period of time for the organization/user. 4.50 or higher = Excellent, 3.5 to 4.49 = Good, 2.5 to 3.49 = Average, 1.50 to 2.49 =Poor, and 1.49 or lower = Bad. +- Total Calls: If the UM IP gateway is selected, this is the total number of calls grouped for the selected UM IP gateway for the corresponding date, If the UM dial plan control is selected, this is the total number of calls grouped for the selected UM dial plan for the corresponding date, and If the user is selected, this column has the total number of calls for the user. +- Network MOS (NMOS): Average NMOS for the specific UM dial plan or UM IP gateway. +- NMOS Degradation. +- NMOS degradation for the specific UM dial plan or UM IP gateway. +- Jitter: Average jitter for the specific UM dial plan or UM IP gateway. +- Packet loss: Average packet loss for the specific UM dial plan or UM IP gateway. +- Round Trip: Round trip time (in milliseconds) for the selected UM dial plan or UM IP gateway. +- Burst loss Duration: Average duration of packet loss during bursts of losses for the selected UM dial plan or UM IP gateway. +- Number of samples: Number of calls sampled, when calculating the averages. A sample refers to any call data record that contains at least one of the audio quality metrics. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMCallSummaryReport -GroupBy Total +``` + +This example displays the statistics for all calls received or placed by Mailbox servers in the organization. + +### Example 2 +```powershell +Get-UMCallSummaryReport -GroupBy Month +``` + +This example displays the statistics for all calls received or placed by Mailbox servers in the organization over the last 12 months. + +### Example 3 +```powershell +Get-UMCallSummaryReport -GroupBy Day +``` + +This example displays the statistics for all calls received or placed by Mailbox servers in the organization over the last 90 days. + +### Example 4 +```powershell +Get-UMCallSummaryReport -GroupBy Month -UMDialPlan MyUMDialPlan +``` + +This example displays the statistics for calls received or placed by Mailbox servers for the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -GroupBy +The GroupBy parameter specifies how to return the results. Valid values are: + +- Day: Daily statistics for the last 90 days. +- Month: Monthly statistics for the last 12 months. +- Total: A summary of all call statistics for your Mailbox servers running the Microsoft Exchange Unified Messaging service in your organization. + +```yaml +Type: GroupBy +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: UMIPGatewayIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMDialPlan.md b/exchange/exchange-ps/exchange/Get-UMDialPlan.md new file mode 100644 index 0000000000..fe86e9ee42 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMDialPlan.md @@ -0,0 +1,101 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMDialPlan + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMDialPlan cmdlet to display the properties of a single Unified Messaging (UM) dial plan or to return a list of all UM dial plans associated with Mailbox servers running the Microsoft Exchange Unified Messaging service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMDialPlan [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMDialPlan +``` + +This example displays a list of all the UM dial plans in the Active Directory forest. + +### Example 2 +```powershell +Get-UMDialPlan -Identity MyUMDialPlan | Format-List +``` + +This example displays a formatted list of properties for the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md b/exchange/exchange-ps/exchange/Get-UMHuntGroup.md new file mode 100644 index 0000000000..d1a7328d41 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMHuntGroup.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMHuntGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMHuntGroup cmdlet to display the properties and values for an existing Unified Messaging (UM) hunt group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMHuntGroup [[-Identity] ] + [-DomainController ] + [-UMDialPlan ] + [] +``` + +## DESCRIPTION +The Get-UMHuntGroup cmdlet retrieves the properties for a single UM hunt group or a list of UM hunt groups. When you're using the Get-UMHuntGroup cmdlet, you can't only enter the name of the UM hunt group. You must also include the name of the UM IP gateway associated with the UM hunt group, for example, Get-UMHuntGroup -Identity MyUMIPGateway\\MyUMHuntGroup1. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMHuntGroup +``` + +This example displays all the UM hunt groups in the Active Directory forest. + +### Example 2 +```powershell +Get-UMHuntGroup -Identity MyUMIPGateway\MyUMHuntGroup | Format-List +``` + +This example displays the details of the UM hunt group MyUMHuntGroup in a formatted list. + +### Example 3 +```powershell +Get-UMHuntGroup -UMDialPlan MyUMDialPlan +``` + +This example displays all of the UM hunt groups associated with the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identifier for the UM hunt group being viewed. This is the directory object ID for the UM hunt group. + +```yaml +Type: UMHuntGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMIPGateway.md b/exchange/exchange-ps/exchange/Get-UMIPGateway.md new file mode 100644 index 0000000000..f027b0d0a4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMIPGateway.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMIPGateway + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMIPGateway cmdlet to return a list of properties and values for a specified Unified Messaging (UM) IP gateway or a list of UM IP gateways. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMIPGateway [[-Identity] ] + [-DomainController ] + [-IncludeSimulator] + [] +``` + +## DESCRIPTION +The Get-UMIPGateway cmdlet displays the properties and values for a specified UM IP gateway, such as the display name, IP address, status and outgoing calls settings. If no parameter is specified, all UM IP gateways in the Active Directory forest are returned. + +When you're using the Get-UMIPGateway cmdlet, you can't enter the IP address configured on the UM IP gateway. You must use the name of the UM IP gateway. The name specified with the Identity parameter of the Get-UMIPGateway cmdlet can be the same as or different from the host name of the UM IP gateway, for example, Get-UMIPGatewayMyUMIPGateway. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMIPGateway | Format-List +``` + +This example displays a formatted list of all the UM IP gateways in the Active Directory forest. + +### Example 2 +```powershell +Get-UMIPGateway -Identity MyUMIPGateway +``` + +This example displays the properties for the UM IP gateway MyUMIPGateway. + +### Example 3 +```powershell +Get-UMIPGateway -IncludeSimulator $true +``` + +This example displays all the UM IP gateways including IP gateway simulators in the Active Directory forest. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identifier for the UM IP gateway being viewed. This parameter is the directory object ID for the UM IP gateway. + +```yaml +Type: UMIPGatewayIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSimulator +The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. You don't need to specify a value with this switch. + +A simulator allows a client to connect to the Mailbox server. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMMailbox.md b/exchange/exchange-ps/exchange/Get-UMMailbox.md new file mode 100644 index 0000000000..215a6b501d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMMailbox.md @@ -0,0 +1,297 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMMailbox cmdlet to view existing mailboxes that are Unified Messaging (UM) enabled. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-UMMailbox [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +### Identity +``` +Get-UMMailbox [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-UMMailbox +``` + +This example displays a summary list of all the UM-enabled mailboxes in your organization. + +### Example 2 +```powershell +Get-UMMailbox -Identity tonysmith@contoso.com | Format-List +``` + +This example displays detailed information for the UM-enabled mailbox for tonysmith@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +Type: String +Parameter Sets: AnrSet +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- ServerLegacyDN + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md b/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md new file mode 100644 index 0000000000..c3eb5e4cc0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md @@ -0,0 +1,210 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMMailboxPin + +## 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. + +For 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-UMMailboxPin [[-Identity] ] + [-Credential ] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreErrors] + [-ReadFromDomainController] + [-ResultSize ] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +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 +``` + +This example displays the UM mailbox PIN-related properties for tonysmith@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreErrors +The IgnoreErrors switch specifies whether to ignore errors. You don't need to specify a value with this switch. + +When you use this switch, errors that occur are written as warnings. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md new file mode 100644 index 0000000000..d3e95a0446 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMMailboxPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMMailboxPolicy cmdlet to display the properties and values of a Unified Messaging (UM) mailbox policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMMailboxPolicy [[-Identity] ] + [-DomainController ] + [-UMDialPlan ] + [] +``` + +## DESCRIPTION +The Get-UMMailboxPolicy cmdlet retrieves the configuration properties and values for a UM mailbox policy or returns a list of UM mailbox policies. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMMailboxPolicy | Format-List +``` + +This example returns a formatted list of all UM mailbox policies in the Active Directory forest. + +### Example 2 +```powershell +Get-UMMailboxPolicy -Identity MyUMMailboxPolicy +``` + +This example returns the properties and values for the UM mailbox policy MyUMMailboxPolicy. + +### Example 3 +```powershell +Get-UMMailboxPolicy -UMDialPlan MyUMDialPlan +``` + +This examples displays all the UM mailbox policies associated with the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identifier for the UM mailbox policy being viewed. This is the directory object ID for the UM mailbox policy. + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UMService.md b/exchange/exchange-ps/exchange/Get-UMService.md new file mode 100644 index 0000000000..6551e952a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UMService.md @@ -0,0 +1,106 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UMService cmdlet to view the settings of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMService [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +When the cmdlet is used for a single Exchange server, it returns the Unified Messaging service properties, including MaxCalls, MaxFaxCalls and UMDialPlans. The properties and their values for the Exchange server are stored in the Unified Messaging section of the Exchange Server configuration object in Active Directory. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMService +``` + +This example displays a summary list of the Microsoft Exchange Unified Messaging service settings on all Exchange servers in the Active Directory forest. + +### Example 2 +```powershell +Get-UMService -Identity MBX01 | Format-List +``` + +This example displays detailed information for the Microsoft Exchange Unified Messaging service settings on the server named MBX01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to view. You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +```yaml +Type: UMServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UmServer.md b/exchange/exchange-ps/exchange/Get-UmServer.md new file mode 100644 index 0000000000..0ba48166ad --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UmServer.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UMServer + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Get-UMServer cmdlet to view settings that are associated with the Unified Messaging (UM) server role. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UMServer [[-Identity] ] + [-DomainController ] + [] +``` + +## DESCRIPTION +The Get-UMServer cmdlet retrieves the properties for a Unified Messaging server or returns a list of available UM servers from Active Directory. When the cmdlet is used for a single UM server, it returns the UM server properties including MaxCalls, MaxFaxCalls, and UMDialPlans. The properties and their values for the UM server are stored in the Unified Messaging section of the Exchange Server configuration object in Active Directory. + +The ExchangeVersion attribute that's returned is the minimum version of Microsoft Exchange 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 Management Console when you select Server Configuration. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UMServer +``` + +This example returns a summary list of Unified Messaging servers in the organization. + +### Example 2 +```powershell +Get-UMServer -Identity MyUMServer | Format-List +``` + +This example returns detailed information for the Unified Messaging server named MyUMServer. + +## PARAMETERS + +### -Identity +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 +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: UMServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md new file mode 100644 index 0000000000..07a961fcf8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md @@ -0,0 +1,139 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UnifiedAuditLogRetentionPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-UnifiedAuditLogRetentionPolicy cmdlet to view the properties of the audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UnifiedAuditLogRetentionPolicy + [-Operation ] + [-RecordType ] + [-RetentionDuration ] + [-UserId ] + [] +``` + +## DESCRIPTION +Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-UnifiedAuditLogRetentionPolicy | Sort-Object -Property Priority | Format-List Priority,Name,Description,RecordTypes,Operations,UserIds,RetentionDuration +``` + +This example lists the configurable properties for all audit log retention policies in your organization. The command also lists the policies in order of highest to lowest priority. + +### Example 2 +```powershell +Get-UnifiedAuditLogRetentionPolicy -RecordType ExchangeItem | Format-List Name,Description,RecordTypes,Operations,UserIds,RetentionDuration,Priority +``` + +This example lists the configurable properties for all audit log retention policies that apply to audit records the record type of ExchangeItem. + +## PARAMETERS + +### -Operation +The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/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"`. + +```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 +``` + +### -RecordType +The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see [AuditLogRecordType](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter filters the policy results by the retention duration specified in the policy. Valid values are: + +- ThreeMonths +- SixMonths +- NineMonths +- TwelveMonths +- TenYears + +```yaml +Type: UnifiedAuditLogRetentionDuration +Parameter Sets: (All) +Aliases: +Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +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"`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md new file mode 100644 index 0000000000..0d661079bb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md @@ -0,0 +1,346 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UnifiedGroup + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-UnifiedGroup cmdlet to view Microsoft 365 Groups in your cloud-based organization. To view members, owners and subscribers for Microsoft 365 Groups, use the Get-UnifiedGroupLinks cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-UnifiedGroup [[-Identity] ] + [-Filter ] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAllProperties] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeRejectMessagesFromSendersOrMembersWithDisplayNames] + [-IncludeSoftDeletedGroups] + [-ResultSize ] + [-SortBy ] + [] +``` + +### AnrSet +``` +Get-UnifiedGroup [-Anr ] + [-Filter ] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAllProperties] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeRejectMessagesFromSendersOrMembersWithDisplayNames] + [-IncludeSoftDeletedGroups] + [-ResultSize ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UnifiedGroup +``` + +This example returns a summary list of all Microsoft 365 Groups. + +### Example 2 +```powershell +Get-UnifiedGroup | Format-List DisplayName,EmailAddresses,Notes,ManagedBy,AccessType +``` + +This example returns the following information about all Microsoft 365 Groups: + +- Display name +- Email address +- Description +- Owners +- Privacy + +### Example 3 +```powershell +Get-UnifiedGroup -Identity "Marketing Department" | Format-List +``` + +This example returns detailed information about the Microsoft 365 Group named Marketing Department. + +### Example 4 +```powershell +Get-UnifiedGroup | Where-Object {-Not $_.ManagedBy} +``` + +This example returns Microsoft 365 Groups that do not have an owner. + +### Example 5 +```powershell +Get-UnifiedGroup -Filter {ResourceProvisioningOptions -eq "Team"} +``` + +This example returns Microsoft 365 Groups that are created when a Microsoft Team is created. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +**Note**: You can use the DisplayName value to identify the Microsoft 365 Group, but the results aren't guaranteed to be unique. If you must return a singular and unique result, use a unique identifier for the Microsoft 365 Group. + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: AnrSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAllProperties +The IncludeAllProperties switch specifies whether to include the values of all properties in the results. You don't need to specify a value with this switch. + +If you don't use this switch, the values of some properties (for example, CalendarMemberReadOnly, CalendarUrl, InboxUrl, PeopleUrl, and PhotoUrl) might appear blank. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames +The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeModeratedByWithDisplayNames +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRejectMessagesFromSendersOrMembersWithDisplayNames +The IncludeRejectMessagesFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of RejectMessagesFromSendersOrMembers recipients in the RejectMessagesFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the RejectMessagesFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSoftDeletedGroups +The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted Microsoft 365 Groups in the results. You don't need to specify a value with this switch. + +Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- Alias + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md new file mode 100644 index 0000000000..e47851e9e1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-UnifiedGroupLinks + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-UnifiedGroupLinks cmdlet to view membership and ownership information for Microsoft 365 Groups in your cloud-based organization. To view other properties for Microsoft 365 Groups, use the Get-UnifiedGroup cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UnifiedGroupLinks [-Identity] -LinkType + [-ResultSize ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UnifiedGroupLinks -Identity "Human Resources Department" -LinkType Members +``` + +This example show the members of the Microsoft 365 Group named Human Resources Department + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -LinkType +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. +- Owners: Add or remove members, delete conversations, changes Team settings, delete the Team, and full control of the connected SharePoint site. A group must have at least one owner. +- Subscribers: Members who receive conversation and calendar event notifications from the group. All subscribers are members of the group, but all members aren't necessarily subscribers (depending on the AutoSubscribeNewMembers property value of the group and when the member was added). + +```yaml +Type: LinkType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/exchange/Get-User.md new file mode 100644 index 0000000000..3cafe8aba0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-User.md @@ -0,0 +1,517 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Get-User cmdlet to view existing user objects in your organization. This cmdlet returns all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-User [-Anr ] + [-Arbitration] + [-AuditLog] + [-AuxAuditLog] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeDirectReportsWithDisplayNames] + [-IsVIP] + [-OrganizationalUnit ] + [-PublicFolder] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-Sortby ] + [-SupervisoryReviewPolicy] + [] +``` + +### Identity +``` +Get-User [[-Identity] ] + [-Arbitration] + [-AuditLog] + [-AuxAuditLog] + [-Credential ] + [-DomainController ] + [-Filter ] + [-IgnoreDefaultScope] + [-IncludeDirectReportsWithDisplayNames] + [-IsVIP] + [-OrganizationalUnit ] + [-PublicFolder] + [-ReadFromDomainController] + [-RecipientTypeDetails ] + [-ResultSize ] + [-Sortby ] + [-SupervisoryReviewPolicy] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-User -ResultSize unlimited +``` + +This example returns a summary list of all users in your organization. + +### Example 2 +```powershell +Get-User -Identity "Coy Damon" | Format-List +``` + +This example returns detailed information for the user named Coy Damon. + +### Example 3 +```powershell +Get-User -OrganizationalUnit "Marketing" +``` + +This example retrieves information about users in the Marketing OU. + +### Example 4 +```powershell +Get-User -Filter "Title -like 'Manager*'" +``` + +This example uses the Filter parameter to retrieve information about all users that have the word Manager at the end of their title. + +## PARAMETERS + +### -Identity +The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: + +- Name +- User principal name (UPN) +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Arbitration +This parameter is available only in on-premises Exchange. + +The Arbitration switch is required to return arbitration mailboxes in the results. You don't need to specify a value with this switch. + +Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow. + +To return arbitration mailboxes that are used to store audit log settings or data, don't use this switch. Instead, use the AuditLog or AuxAuditLog switches. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLog +This parameter is available only in on-premises Exchange. + +The AuditLog switch is required to return audit log mailboxes in the results. You don't need to specify a value with this switch. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To return other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxAuditLog +This parameter is available only in on-premises Exchange. + +The AuxAuditLog switch is required to return auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To return other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +This parameter is available only in the cloud-based service. + +{{ Fill IncludeDirectReportsWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsVIP +This parameter is available only in the cloud-based service. + +The IsVIP switch filters the results by priority accounts. You don't need to specify a value with this switch. + +For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +The PublicFolder switch is required to return public folder mailboxes in the results. You don't need to specify a value with this switch. + +Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +This parameter is available only in on-premises Exchange. + +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTypeDetails +The RecipientTypeDetails parameter filters the results by the specified user subtype. Valid values are: + +- DisabledUser +- DiscoveryMailbox +- EquipmentMailbox +- GuestMailUser (Exchange 2016 or later and cloud) +- GroupMailbox (Exchange 2013 only) +- LegacyMailbox +- LinkedMailbox +- LinkedRoomMailbox (Exchange 2013 or later and cloud) +- LinkedUser +- MailUser +- PublicFolderMailbox (Exchange 2013 or later and cloud) +- RemoteEquipmentMailbox +- RemoteRoomMailbox +- RemoteSharedMailbox +- RemoteTeamMailbox (Exchange 2013 or later and cloud) +- RemoteUserMailbox +- RoomMailbox +- SchedulingMailbox (Exchange 2016 or later and cloud) +- SharedMailbox +- SharedWithMailUser (cloud only) +- TeamMailbox (Exchange 2013 or later and cloud) +- User +- UserMailbox + +You can specify multiple values separated by commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Sortby +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the following properties: + +- Name +- DisplayName +- City +- FirstName +- LastName +- Office + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupervisoryReviewPolicy +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md new file mode 100644 index 0000000000..6c04f88148 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md @@ -0,0 +1,93 @@ +--- +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 +ms.author: chrisda +--- + +# Get-UserBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UserBriefingConfig -Identity + [-ResultSize ] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-UserBriefingConfig -Identity lila@contoso.com +``` + +This example returns the Briefing configuration for the user lila@contoso.com. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin) diff --git a/exchange/exchange-ps/exchange/Get-UserPhoto.md b/exchange/exchange-ps/exchange/Get-UserPhoto.md new file mode 100644 index 0000000000..5314df112d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UserPhoto.md @@ -0,0 +1,353 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-UserPhoto + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint. + +**Note**: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see [Manage user photos in Microsoft Graph PowerShell](https://learn.microsoft.com/microsoft-365/admin/add-users/change-user-profile-photos#manage-user-photos-in-microsoft-graph-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AnrSet +``` +Get-UserPhoto [-Anr ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-PhotoType ] + [-Preview] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +### Identity +``` +Get-UserPhoto [[-Identity] ] + [-Credential ] + [-DomainController ] + [-Filter ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-OrganizationalUnit ] + [-PhotoType ] + [-Preview] + [-ReadFromDomainController] + [-ResultSize ] + [-SortBy ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UserPhoto "Susan Burk" +``` + +This example displays information about the user photo configured for Susan Burk. + +### Example 2 +```powershell +Get-UserPhoto "Pilar Pinilla" -Preview +``` + +This example displays information about the user photo that was uploaded to Pilar Pinilla's account, but wasn't saved. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Anr +The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: + +- CommonName (CN) +- DisplayName +- FirstName +- LastName +- Alias + +```yaml +Type: String +Parameter Sets: AnrSet +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 +``` + +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhotoType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preview +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadFromDomainController +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. + +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. + +You can sort by the Id property. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md b/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md new file mode 100644 index 0000000000..b9afdf3095 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md @@ -0,0 +1,84 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-UserPrincipalNamesSuffix + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-UserPrincipalNamesSuffix cmdlet to view the user principal name (UPN) suffixes in the Active Directory forest. The UPN suffixes are created in Active Directory Domains and Trusts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-UserPrincipalNamesSuffix [-OrganizationalUnit ] + [] +``` + +## DESCRIPTION +UPN suffixes assigned to an organizational unit are stored in the upnSuffixes attribute in the Organizational Unit object. + +The default UPN is contained in the Canonical Name attribute on the Partitions container object in the configuration naming context. The default UPN suffix identifies the domain in which the user account is contained. When you create a user account in Active Directory, the default UPN suffix is the DNS name of the first domain in your domain tree. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-UserPrincipalNamesSuffix +``` + +This example returns all UPN suffixes for the Active Directory forest. + +## PARAMETERS + +### -OrganizationalUnit +The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```yaml +Type: ExtendedOrganizationalUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md new file mode 100644 index 0000000000..bbfd395ab1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md @@ -0,0 +1,120 @@ +--- +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 +ms.author: chrisda +--- + +# Get-VivaInsightsSettings + +## 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). + +**Note**: This cmdlet is available only in version 2.0.5 or later of the module. + +Use the Get-VivaInsightsSettings cmdlet to check whether a user has access to features in Microsoft Viva Insights in Microsoft Teams. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaInsightsSettings -Identity + [-Feature ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Teams Administrator + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com + +UserId : roy@contoso.onmicrosoft.com +IsInsightsHeadspaceEnabled : True +``` + +This example shows the configuration of Microsoft Viva Insights in Microsoft Teams for the user roy@contoso.onmicrosoft.com. The output of the command shows that the features of Headspace are available to Roy. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Feature +The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are: + +- Headspace: Represents all features of Headspace. +- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md new file mode 100644 index 0000000000..b2787501f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature +applicable: Exchange Online +title: Get-VivaModuleFeature +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeature + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. This cmdlet provides details about the features, including the feature identifiers and descriptions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaModuleFeature -ModuleId + [[-FeatureId] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. + +You can view all features in a particular Viva module that support feature access controls. To view a specific feature, you can include the FeatureId parameter. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeature -ModuleId VivaInsights +``` + +This example returns all features in Viva Insights that support feature access controls. + +### Example 2 +```powershell +Get-VivaModuleFeature -ModuleId VivaInsights -FeatureId Reflection +``` + +This example returns the details of the Reflection feature in Viva Insights. + +## PARAMETERS + +### -ModuleId +The ModuleId parameter specifies the Viva module of the features that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureId +The FeatureId parameter specifies the specific feature in the Viva module that you want to view. + +You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Positional +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md new file mode 100644 index 0000000000..8fed8e655e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeatureenablement +applicable: Exchange Online +title: Get-VivaModuleFeatureEnablement +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeatureEnablement + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. Whether or not the feature is enabled is referred to as the feature's "enablement state". The enablement state returned by this cmdlet is based on the access policies set by the admin. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaModuleFeatureEnablement -FeatureId -Identity -ModuleId + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role to run this cmdlet. + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity user@contoso.com +``` + +This example returns the enablement state of the Reflection feature in Viva Insights for the **user@contoso.com** user. + +### Example 2 +```powershell +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity group@contoso.com +``` + +This example returns the enablement state of the Reflection feature in Viva Insights for the **group@contoso.com** group. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module. + +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. + +[Mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..1e4a57e8a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeaturepolicy +applicable: Exchange Online +title: Get-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date. The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### FeaturePolicy +``` +Get-VivaModuleFeaturePolicy -FeatureId -ModuleId [[-PolicyId] ] + [-ResultSize ] + [] +``` + +### FeaturePolicyWithMembers +``` +Get-VivaModuleFeaturePolicy -ModuleId [[-FeatureId] ] [[-MemberIds] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. + +You can view all policies for a specified feature in a Viva module in Viva. To view a specific policy, you can include the PolicyId parameter. + +The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection +``` + +This example returns details about all the policies added for the Reflection feature in Viva Insights. + +### Example 2 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b +``` + +This example returns details about a specific policy added for the Reflection feature in Viva Insights. + +### Example 3 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -MemberIds user1@contoso.com +``` + +This example returns details about the policies for the Reflection feature in Viva Insights that apply to the user with the email user1@contoso.com. + +### Example 4 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId * -FeatureId * -MemberIds user1@contoso.com,group1@contoso.com +``` + +This example returns details about the policies for all features across all Viva modules that apply to the user with the email user1@contoso.com and the group with the email group1@contoso.com. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. + +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + +```yaml +Type: String +Parameter Sets: FeaturePolicy +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: FeaturePolicyWithMembers +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature policies that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. + +To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. + +```yaml +Type: String +Parameter Sets: FeaturePolicy +Aliases: +Applicable: Exchange Online + +Required: False +Position: Positional +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberIds +The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module. + +You can provide up to three member IDs. Use the \* character to specify all modules or features. + +```yaml +Type: String[] +Parameter Sets: FeaturePolicyWithMembers +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..22defddf64 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivaorginsightsdelegatedrole +title: Get-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaOrgInsightsDelegatedRole -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +Typically, you use this cmdlet with the Remove-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegate accounts. + +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaOrgInsightsDelegatedRole -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example filters the results by the specified delegator. + +## PARAMETERS + +### -Delegator +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is given to delegates. + +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md new file mode 100644 index 0000000000..1345ae232f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md @@ -0,0 +1,189 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-WebServicesVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-WebServicesVirtualDirectory cmdlet to view Exchange Web Services (EWS) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Server +``` +Get-WebServicesVirtualDirectory -Server + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +### Identity +``` +Get-WebServicesVirtualDirectory [[-Identity] ] + [-ADPropertiesOnly] + [-DomainController ] + [-ShowMailboxVirtualDirectories] + [] +``` + +## DESCRIPTION +The Get-WebServicesVirtualDirectory cmdlet can be run on a local server or run remotely if the server name is specified in the Identity or Server parameters. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Get-WebServicesVirtualDirectory -Server MBX01 +``` + +This example returns a summary list of all EWS virtual directories on the server named MBX01. + +### Example 2 +```powershell +Get-WebServicesVirtualDirectory -Identity "MBX01\EWS*" | Format-List +``` + +This example returns detailed information for the EWS virtual directory named "EWS (Default Web Site)" on the server named MBX01. + +### Example 3 +```powershell +Get-WebServicesVirtualDirectory +``` + +This example returns a summary list of all virtual directories in the client access services on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use the Server and Identity parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ADPropertiesOnly +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -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 +``` + +### -ShowMailboxVirtualDirectories +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. + +We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md new file mode 100644 index 0000000000..3be7ea0728 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md @@ -0,0 +1,92 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-X400AuthoritativeDomain + +## 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). + +For 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-X400AuthoritativeDomain [[-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). + +## EXAMPLES + +### Example 1 +```powershell +Get-X400AuthoritativeDomain "Europe Sales X.400 Domain" | Format-List +``` + +This example displays detailed information about the X.400 authoritative domain Europe Sales X.400 Domain. + +## PARAMETERS + +### -Identity +The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the remote domain. + +```yaml +Type: X400AuthoritativeDomainIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md new file mode 100644 index 0000000000..2af5f1721a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md @@ -0,0 +1,86 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Get-eDiscoveryCaseAdmin + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-eDiscoveryCaseAdmin cmdlet to view eDiscovery Administrators in the Microsoft Purview compliance portal. An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-eDiscoveryCaseAdmin [-DomainController ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-eDiscoveryCaseAdmin +``` + +This example returns a summary list of all eDiscovery Administrators. + +## PARAMETERS + +### -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 +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: 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/Import-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md new file mode 100644 index 0000000000..bdec677fd8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md @@ -0,0 +1,170 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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). + +This cmdlet is functional only in on-premises Exchange. + +Use the Import-DlpPolicyCollection cmdlet to import data loss prevention (DLP) policy collections that are based on transport rules (mail flow rules) into your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Import-DlpPolicyCollection [[-Identity] ] [-FileData] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Import-DlpPolicyCollection cmdlet imports all the settings of the DLP policies and the associated transport rules. You use the Export-DlpPolicyCollection cmdlet to export the DLP policy collection. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Import-DlpPolicyCollection -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\DLP Backup.xml')) +``` + +This example imports the DLP policy collection in the file C:\\My Documents\\DLP Backup.xml. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -FileData +The FileData parameter specifies the DLP policy collection file you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md new file mode 100644 index 0000000000..41752441f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md @@ -0,0 +1,112 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Import-DlpPolicyTemplate + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Import-DlpPolicyTemplate cmdlet to import data loss prevention (DLP) policy template files that are based on transport rules (mail flow rules) into your Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Import-DlpPolicyTemplate [-FileData] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Import-DlpPolicyTemplate -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External DLP Policy Template.xml')) +``` + +This example imports the DLP policy template file C:\\My Documents\\External DLP Policy Template.xml. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the DLP policy template file you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Import-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md new file mode 100644 index 0000000000..f9175f98ff --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md @@ -0,0 +1,317 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Import-ExchangeCertificate + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Import-ExchangeCertificate cmdlet to import certificates on Exchange servers. You use this cmdlet to install certificates that were exported from other servers, and to complete pending certification requests (also known as certificate signing requests or CSRs) from certification authorities (CAs). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### FileData +``` +Import-ExchangeCertificate -FileData + [-Confirm] + [-DomainController ] + [-FriendlyName ] + [-Password ] + [-PrivateKeyExportable ] + [-Server ] + [-WhatIf] + [] +``` + +### FileName +``` +Import-ExchangeCertificate -Instance + [-Confirm] + [-DomainController ] + [-FriendlyName ] + [-Password ] + [-PrivateKeyExportable ] + [-Server ] + [-WhatIf] + [] +``` + +### Instance +``` +Import-ExchangeCertificate -FileName + [-Confirm] + [-DomainController ] + [-FriendlyName ] + [-Password ] + [-PrivateKeyExportable ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use the Import-ExchangeCertificate cmdlet to import the following types of certificate files on an Exchange server: + +- APKCS #7 certificate or chain of certificates file (.p7b or .p7c) that was issued by a certification authority (CA). PKCS #7 is the Cryptographic Message Syntax Standard, a syntax used for digitally signing or encrypting data using public key cryptography, including certificates. For more information, see [PKCS #7 Cryptographic Messaging Syntax Concepts](https://learn.microsoft.com/windows/win32/seccrypto/pkcs--7-concepts). +- A PKCS #12 certificate file (.cer, .crt, .der, .p12, or .pfx) that contains the private key. PKCS #12 is the Personal Information Exchange Syntax Standard, a file format used to store certificates with corresponding private keys that are protected by a password. For more information, see [PKCS #12: Personal Information Exchange Syntax v1.1](https://tools.ietf.org/html/rfc7292). + +After you import a certificate on an Exchange server, you need to assign the certificate to one or more Exchange services by using the Enable-ExchangeCertificate cmdlet. + +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). + +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). 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). + +## EXAMPLES + +### Example 1 +```powershell +Import-ExchangeCertificate -Server Mailbox01 -FileName "\\FileServer01\Data\Exported Fabrikam Cert.pfx" -Password (Get-Credential).password +``` + +In **Exchange 2013**, this example imports the certificate from the PKCS #12 file from \\\\FileServer01\\Data\\Exported Fabrikam Cert.pfx to the Exchange server named Mailbox01. This file requires the password of the file. This certificate could have been exported from another server or issued by a certification authority. + +To export the certificate in Exchange 2016 or Exchange 2019, use the FileData parameter as described in Example 2. + +### Example 2 +```powershell +Import-ExchangeCertificate -Server Mailbox01 -FileData ([System.IO.File]::ReadAllBytes('\\FileServer01\Data\Exported Fabrikam Cert.pfx')) -Password (Get-Credential).password +``` + +This example imports the same certificate file from Example 1. This method is required in Exchange 2016 and Exchange 2019 because the FileName parameter is not available. + +### Example 3 +```powershell +Import-ExchangeCertificate -FileData ([System.IO.File]::ReadAllBytes('C:\Certificates\Fabrikam IssuedCert.p7b')) +``` + +This example imports a chain of certificates from the PKCS #7 file C:\\Certificates\\Fabrikam IssuedCert.p7b on the local Exchange server. + +## PARAMETERS + +### -FileData +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`). + +You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). + +When you use this parameter to import PKCS #7 text certificate files, these files contain contain: -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- or -----BEGIN PKCS7----- and -----END PKCS7----- and have .p7b or .p7c filename extensions. + +If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: Byte[] +Parameter Sets: FileData +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileName +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To import a certificate file without using the FileName parameter, use the FileData parameter. + +This parameter is available only in Exchange 2013. + +The FileName parameter specifies the certificate file that you want to import. Typically, you use this parameter for PKCS #12 binary certificate files that have .cer, .crt, .der, .p12, or .pfx filename extensions. This type of binary certificate file is protected by a password when the file contains the private key or chain of trust. + +You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). + +If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2013 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +This parameter has been deprecated and is no longer used. + +```yaml +Type: String[] +Parameter Sets: FileName +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +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. + +```yaml +Type: String +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 +``` + +### -Password +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: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: (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 +``` + +### -PrivateKeyExportable +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Import-FilePlanProperty.md b/exchange/exchange-ps/exchange/Import-FilePlanProperty.md new file mode 100644 index 0000000000..0a64f7f630 --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-FilePlanProperty.md @@ -0,0 +1,154 @@ +--- +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 +schema: 2.0.0 +--- + +# Import-FilePlanProperty + +## 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 Import-FilePlanProperty cmdlet to import file plan properties. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Import-FilePlanProperty [-RawCsv] + [-Confirm] + [-DomainController ] + [-Force] + [-ValidateOnly] + [-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 +Import-FilePlanProperty -RawCsv "C:\Data\CSV Import.csv" +``` + +This example imports the specified CSV file. + +## PARAMETERS + +### -RawCsv +The RawCsv parameter specifies the CSV file to import. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateOnly +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 +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/Import-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md new file mode 100644 index 0000000000..535e6e67f0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md @@ -0,0 +1,151 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Import-JournalRuleCollection + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Import-JournalRuleCollection cmdlet to import journal rules from an XML file. You can import a journal rule collection you previously exported as a backup, or import rules you exported from an older version of Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Import-JournalRuleCollection [[-Identity] ] [-FileData] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Import-JournalRuleCollection cmdlet imports a journal rule collection you previously exported. + +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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Import-JournalRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\JournalRules\ExportedJournalRules.xml')) +``` + +This example imports journal rules from the XML file named ExportedJournalRules.xml in the C:\\JournalRules folder. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -FileData +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`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -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/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md new file mode 100644 index 0000000000..3c8ed062fd --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md @@ -0,0 +1,211 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Import-RecipientDataProperty + +## SYNOPSIS +Use the Import-RecipientDataProperty cmdlet to add a picture or a spoken name audio file to a mailbox or mail contact. + +**Note**: Profile cards across Microsoft apps and services don't support imported pictures for mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ImportPicture +``` +Import-RecipientDataProperty [-Identity] -FileData + [-Picture] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### ImportSpokenName +``` +Import-RecipientDataProperty [-Identity] -FileData + [-SpokenName] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Import-RecipientDataProperty -Identity "Tony Smith" -SpokenName -FileData ([System.IO.File]::ReadAllBytes('M:\AudioFiles\TonySmith.wma')) +``` + +This example imports the audio file for Tony Smith's spoken name. + +### Example 2 +```powershell +Import-RecipientDataProperty -Identity Ayla -Picture -FileData ([System.IO.File]::ReadAllBytes('M:\Employee Photos\AylaKol.jpg')) +``` + +This example imports the picture file for Ayla Kol. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -FileData +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`). + +To import a picture, use the Picture switch. A valid picture file is JPEG and less than 10 kilobytes (KB). + +To import a spoken name, use the SpokenName switch. A valid spoken name file is WMA 9 and less than 32 KB. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Picture +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpokenName +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Import-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md new file mode 100644 index 0000000000..30fae12016 --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md @@ -0,0 +1,180 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Import-TransportRuleCollection + +## SYNOPSIS +This cmdlet is functional only in on-premises Exchange. + +Use the Import-TransportRuleCollection cmdlet to import a transport rule collection. You can import a rule collection you previously exported as a backup, or import rules that you've exported from an older version of Exchange. + +**Note**: For replacement import functionality in Exchange Online using a PowerShell script, see [Import or export a mail flow rule collection in Exchange Online](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/manage-mail-flow-rules#import-or-export-a-mail-flow-rule-collection-in-exchange-online). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Import-TransportRuleCollection [[-Identity] ] [-FileData] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +Importing a transport rule collection from an XML file removes or overwrites all pre-existing transport rules that were defined in your organization. Make sure that you have a backup of your current transport rule collection before you import and overwrite your current transport rules. + +For information about how to export a transport rule collection to an XML file, see [Export-TransportRuleCollection](https://learn.microsoft.com/powershell/module/exchange/export-transportrulecollection). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Import-TransportRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\TransportRules\ExportedRules.xml')) +``` + +This example imports a transport rule collection from the XML file named ExportedRules.xml in the C:\\TransportRules folder. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -FileData +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`). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Import-UMPrompt.md b/exchange/exchange-ps/exchange/Import-UMPrompt.md new file mode 100644 index 0000000000..5f34ab73ab --- /dev/null +++ b/exchange/exchange-ps/exchange/Import-UMPrompt.md @@ -0,0 +1,239 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Import-UMPrompt + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Import-UMPrompt cmdlet to copy or upload a custom audio file to be used by Unified Messaging (UM) dial plans and auto attendants. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### UploadDialPlanPrompts +``` +Import-UMPrompt -PromptFileData -PromptFileName -UMDialPlan + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### UploadAutoAttendantPrompts +``` +Import-UMPrompt -PromptFileData -PromptFileName -UMAutoAttendant + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### UploadAutoAttendantPromptsStream +``` +Import-UMPrompt -PromptFileName -PromptFileStream -UMAutoAttendant + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### UploadDialPlanPromptsStream +``` +Import-UMPrompt -PromptFileName -PromptFileStream -UMDialPlan + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Import-UMPrompt cmdlet imports custom greeting audio files into UM dial plans and auto attendants. There are many custom greetings used by UM dial plans and auto attendants including welcome greetings for dial plans and after hours welcome greetings and menus, business hours and non-business hours welcome greetings and menus, and key mappings for UM auto attendants. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Import-UMPrompt -UMDialPlan MyUMDialPlan -PromptFileName "welcomegreeting.wav" -PromptFileData ([System.IO.File]::ReadAllBytes('D:\UMPrompts\welcomegreeting.wav')) +``` + +This example imports the welcome greeting file welcomegreeting.wav from D:\\UMPrompts into the UM dial plan MyUMDialPlan. + +### Example 2 +```powershell +Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "welcomegreeting.wav" -PromptFileData ([System.IO.File]::ReadAllBytes('D:\UMPrompts\welcomegreeting.wav')) +``` + +This example imports the welcome greeting file welcomegreeting.wav from D:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. + +### Example 3 +```powershell +Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "AfterHoursWelcomeGreeting.wav" -PromptFileData ([System.IO.File]::ReadAllBytes('D:\UMPrompts\AfterHoursWelcomeGreeting.wav')) +``` + +This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav from D:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. + +## PARAMETERS + +### -PromptFileData +The PromptFileData parameter specifies the byte array of the custom prompt. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: UploadDialPlanPrompts, UploadAutoAttendantPrompts +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PromptFileName +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Stream +Parameter Sets: UploadAutoAttendantPromptsStream, UploadDialPlanPromptsStream +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMAutoAttendant +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/mail-flow/Install-TransportAgent.md b/exchange/exchange-ps/exchange/Install-TransportAgent.md similarity index 78% rename from exchange/exchange-ps/exchange/mail-flow/Install-TransportAgent.md rename to exchange/exchange-ps/exchange/Install-TransportAgent.md index 33ef519859..9e51b2aaa8 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Install-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Install-TransportAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Install-TransportAgent @@ -13,26 +16,28 @@ This cmdlet is available only in on-premises Exchange. Use the Install-TransportAgent cmdlet to register transport agents on Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Install-TransportAgent [-Name] -AssemblyPath -TransportAgentFactory [-Confirm] - [-DomainController ] [-WhatIf] - [-TransportService ] [-EscalationTeam ] +Install-TransportAgent [-Name] -AssemblyPath -TransportAgentFactory + [-Confirm] + [-DomainController ] + [-TransportService ] + [-WhatIf] [] ``` ## DESCRIPTION Transport agents have full access to all email messages that they encounter. Exchange puts no restrictions on a transport agent's behavior. Transport agents that are unstable or contain security flaws may affect the stability and security of Exchange. Therefore, you need to only install transport agents that you fully trust and that have been fully tested. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Install-TransportAgent -Name "Test App" -TransportAgentFactory "vendor.exchange.avTransportAgentfactory" -AssemblyPath "c:\Program Files\Vendor\TransportAgent\AvTransportAgentFactory.dll" -TransportService Hub ``` @@ -40,31 +45,33 @@ This example shows how a fictitious application named Test App is installed in t ## PARAMETERS -### -AssemblyPath -The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used. +### -Name +The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. +### -AssemblyPath +The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -78,6 +85,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -88,8 +96,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -97,6 +104,7 @@ 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 @@ -114,21 +122,7 @@ 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 -``` - -### -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 @@ -140,20 +134,17 @@ Accept wildcard characters: False 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. - - MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - - MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - - FrontEnd for the Front End Transport service on Mailbox servers. - - Edge on Edge Transport servers. ```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery +Type: TransportService Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -161,14 +152,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EscalationTeam -This parameter is reserved for internal Microsoft use. +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -177,20 +169,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/520bfa38-f51a-400c-9ff3-46fa50222092.aspx) diff --git a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md new file mode 100644 index 0000000000..dfc3b902a4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md @@ -0,0 +1,134 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Install-UnifiedCompliancePrerequisite + +## 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. The Compliance Policy Center is a site collection that's used by the Microsoft Purview compliance portal to store preservation policies that act on content in SharePoint sites. + +Typically, you don't need to run this cmdlet. You use this cmdlet for troubleshooting and diagnostics. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Initialize +``` +Install-UnifiedCompliancePrerequisite [-ForceInitialize] + [-PolicyCenterSiteOwner ] + [] +``` + +### LoadOnly +``` +Install-UnifiedCompliancePrerequisite [-LoadOnly] + [] +``` + +## DESCRIPTION +This cmdlet returns the following information about the Compliance Policy Center: + +- SharepointRootSiteUrl: This value is typically `https://.sharepoint.com/`. +- SharepointTenantAdminUrl: This value uses the format `https://-admin.sharepoint.com/`. +- SharepointSuccessInitializedUtc: The time that the Compliance Policy Center was last initialized in coordinated universal time (UTC). +- SharepointPolicyCenterSiteUrl: This value is typically `https://.sharepoint.com/sites/compliancepolicycenter`. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Install-UnifiedCompliancePrerequisite +``` + +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 +Install-UnifiedCompliancePrerequisite -LoadOnly +``` + +This example loads the Compliance Policy Center using the current settings. + +### Example 3 +```powershell +Install-UnifiedCompliancePrerequisite -ForceInitialize +``` + +This example recreates the Compliance Policy Center, even if the site has already been created. + +## PARAMETERS + +### -ForceInitialize +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Initialize +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadOnly +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. + +```yaml +Type: SwitchParameter +Parameter Sets: LoadOnly +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyCenterSiteOwner +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md b/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md new file mode 100644 index 0000000000..d208ed10b8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md @@ -0,0 +1,99 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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 reserved for internal Microsoft use. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Invoke-ComplianceSearchActionStep [[-Identity] ] -Parameters -Step + [] +``` + +## DESCRIPTION +This cmdlet is reserved for internal Microsoft use. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-ComplianceSearchActionStep +``` + +This cmdlet is reserved for internal Microsoft use. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Parameters +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Step +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md b/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md new file mode 100644 index 0000000000..af2ca95201 --- /dev/null +++ b/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesecurityfilteraction +applicable: Security & Compliance +title: Invoke-ComplianceSecurityFilterAction +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Invoke-ComplianceSecurityFilterAction + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Invoke-ComplianceSecurityFilterAction cmdlet to view and set compliance boundaries for Microsoft OneDrive sites in cloud-based organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Invoke-ComplianceSecurityFilterAction [-Action] [[-EmailAddress] ] [-PropertyName] [[-PropertyValue] ] [-SiteUrl] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet is useful in scenarios where the OneDrive site has fallen out of the compliance boundary due to a departed user and a corresponding inactive mailbox. + +To use this cmdlet in Security & Compliance PowerShell, you need to be a member of the Compliance Administrator role group. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Invoke-ComplianceSecurityFilterAction -Action GetStatus -PropertyName CustomAttribute1 -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx + +SiteUrlOrEmailAddress : https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx +BoundaryType : UserMailbox +BoundaryInstruction : Set via Set-Mailbox +BoundaryObjectId : SPO_f82ace6e-817e-4752-8917-67164dabde98@SPO_775ea11f-a2af-7821-b04c-9848e903ce47 +BoundaryStatus : Success +BoundaryProperty : CustomAttribute1 +BoundaryPropertyValue : +``` + +This example returns the status of a OneDrive site to indicate it's associated to a user mailbox and the CustomAttribute1 property isn't currently set. + +### Example 2 +```powershell +PS C:\> Invoke-ComplianceSecurityFi1terAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "nina@contoso.onmicrosoft.com" + +SiteUrlOrEmailAddress : nina@contoso.onmicrosoft.com +BoundaryType : UserMailbox +BoundaryInstruction : Set via Set-Mailbox +BoundaryObjectId : nina@contoso.onmicrosoft.com +BoundaryStatus : Success +BoundaryProperty : CustomAttribute3 +BoundaryPropertyVa1ue : +``` + +This example returns the status of a mailbox to indicate the mailbox is inactive, and the CustomAttribute3 property isn't currently set. + +### Example 3 +```powershell +PS C:\> Invoke-ComplianceSecurityFi1terAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "zhexuan@contoso.onmicrosoft.com" + +SiteUrlOrEmailAddress : zhexuan@contoso.onmicrosoft.com +BoundaryType : InactiveMailbox +BoundaryInstruction : Set via Invoke-ComplianceSecurityFiIterAction -Set +BoundaryObjectId : zhexuan@contoso.onmicrosoft.com +BoundaryStatus : Success +BoundaryProperty : CustomAttribute3 +BoundaryPropertyVa1ue : test33 +``` + +This example returns the status of a mailbox to indicate the mailbox is inactive, and the CustomAttribute3 property is currently set to test33. + +### Example 4 +```powershell +Invoke-ComplianceSecurityFilterAction -Action Set -PropertyName CustomAttribute1 -PropertyValue "Research and Development" -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx +``` + +This example sets the boundary of the specified OneDrive site for a user who left the company. + +### Example 5 +```powershell +PS C:\> Invoke-ComplianceSecurityFiIterAction -Action Set -PropertyName "CustomAttribute3" -PropertyValue "ProjectX" -EmailAddress "zhexuan@contoso.onmicrosoft.com" + +Set action succeeded, please use GetStatus to check the result. + +PS C:\> Invoke-ComplianceSecurityFiIterAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "zhexuan@contoso.onmicrosoft.com" + +SiteUrlOrEmailAddress : zhexuan@contoso.onmicrosoft.com +BoundaryType : InactiveMailbox +BoundaryInstruction : Set via Invoke-ComplianceSecurityFiIterAction -Set +BoundaryObjectId : zhexuan@contoso.onmicrosoft.com +BoundaryStatus : Success +BoundaryProperty : CustomAttribute3 +BoundaryPropertyVa1ue : ProjectX +``` + +This example sets the boundary of the specified OneDrive site to the specified CustomAttribute3 property value, and runs another command to review the result. + +## PARAMETERS + +### -Action +The Action parameter specifies the action for the command. Valid values are: + +- GetStatus +- Set + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +The EmailAddress parameter specifies the the affected user mailbox. You can use the following values to uniquely identify the mailbox: + +- Name +- Email address +- Alias +- ExchangeGUID + +If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyName +The PropertyName parameter specifies the name of the property of the compliance boundary for the OneDrive site that you want to view or modify. Valid values are: + +- CustomAttribute1 to CustomAttribute15 + +Use the PropertyValue parameter to set the compliance boundary. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyValue +The PropertyValue parameter specifies the value of the PropertyName value when you use the Action parameter value Set to set the compliance boundary of a OneDrive site. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteUrl +The SiteUrl parameter specifies the OneDrive site that you want to view or modify. This parameter uses the syntax `https://-my.sharepoint.com/personal/__onmicrosoft_com/_layouts/15/onedrive.aspx`. For example: `https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md b/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md new file mode 100644 index 0000000000..3579f174b8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/invoke-holdremovalaction +applicable: Security & Compliance +title: Invoke-HoldRemovalAction +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Invoke-HoldRemovalAction + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Invoke-HoldRemovalAction cmdlet to view and remove holds on mailboxes and SharePoint sites. You can also see holds that were previously removed by using this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Invoke-HoldRemovalAction -Action + [-Confirm] + [-ExchangeLocation ] + [-Force] + [-HoldId ] + [-SharePointLocation ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. Only Compliance Administrator can remove hold for Exchange or Sharepoint locations. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Invoke-HoldRemovalAction -Action RemoveHold -ExchangeLocation "KittyPetersen@contoso.onmicrosoft.com" -HoldId "UniHecbf89df-74fc-444a-a2dc-c0756c7d3503" +``` + +This example removes the specified hold on Kitty Petersen's mailbox if policy UniHecbf89df-74fc-444a-a2dc-c0756c7d3503 is not an active case hold policy. + +### Example 2 +```powershell +Invoke-HoldRemovalAction -Action GetHolds -SharePointLocation "https://contoso.sharepoint.com/sites/finance" +``` + +This example displays all hold information on the specified SharePoint site. + +### Example 3 +```powershell +Invoke-HoldRemovalAction -Action GetHoldRemovals +``` + +This example displays all hold removals that have been done using this cmdlet. + +## PARAMETERS + +### -Action +The Action parameter specifies the mode that the cmdlet operates in. Valid values are: + +- GetHoldRemovals: Shows all hold removals that were done using this cmdlet. +- GetHolds: Shows holds on the specified mailbox (the ExchangeLocation parameter) or SharePoint site (the SharePointLocation parameter). +- RemoveHold: Removes the specified hold (the HoldId parameter) from the specified mailbox (the ExchangeLocation parameter) or SharePoint site (the SharePointLocation parameter). + +```yaml +Type: HoldRemovalActionType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the email address of the mailbox that contains the holds to view or remove. + +This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to force remove the hold even when the policy is active. Instead, you should remove the hold from the case hold policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldId +The HoldId parameter specifies the hold that you want to view or remove. + +To find valid values for this parameter, use this cmdlet with the Action parameter value GetHolds and look for the HoldId property in the output. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +The SharePointLocation parameter specifies the URL of the SharePoint site that contains the holds to view or remove. + +This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Invoke-MonitoringProbe.md b/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md similarity index 81% rename from exchange/exchange-ps/exchange/server-health-and-performance/Invoke-MonitoringProbe.md rename to exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md index 509e92f3ce..858171d8c8 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Invoke-MonitoringProbe.md +++ b/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Invoke-MonitoringProbe @@ -15,24 +18,31 @@ Use the Invoke-MonitoringProbe cmdlet to run a Managed Availability probe on a s This cmdlet cannot be used to run every Managed Availability probe. Only some probes (mainly the deep test probes) can be run manually using this cmdlet. Probes that cannot be run with this cmdlet will generate an error message when Invoke-MonitoringProbe is used to run them. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Invoke-MonitoringProbe [-Identity] -Server [-Account ] - [-Endpoint ] [-ItemTargetExtension ] [-Password ] [-PropertyOverride ] - [-SecondaryAccount ] [-SecondaryEndpoint ] [-SecondaryPassword ] - [-TimeOutSeconds ] [] +Invoke-MonitoringProbe [-Identity] -Server + [-Account ] + [-Endpoint ] + [-ItemTargetExtension ] + [-Password ] + [-PropertyOverride ] + [-SecondaryAccount ] + [-SecondaryEndpoint ] + [-SecondaryPassword ] + [-TimeOutSeconds ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Invoke-MonitoringProbe -Identity ActiveSync.Protocol\ActiveSyncSelfTestProbe -Server EX1 ``` @@ -48,6 +58,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -59,15 +70,10 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN -If you don't use this parameter, the command is run on the local server. - You can't use this parameter to configure other Edge Transport servers remotely. ```yaml @@ -75,6 +81,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -90,6 +97,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -105,6 +113,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -120,6 +129,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,6 +145,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -150,6 +161,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -165,6 +177,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -180,6 +193,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -195,6 +209,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -210,6 +225,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -218,20 +234,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/932fada2-3d7a-4caa-b925-b7bfbae3ae51.aspx) diff --git a/exchange/exchange-ps/exchange/Mount-Database.md b/exchange/exchange-ps/exchange/Mount-Database.md new file mode 100644 index 0000000000..8d6dc5909a --- /dev/null +++ b/exchange/exchange-ps/exchange/Mount-Database.md @@ -0,0 +1,184 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Mount-Database + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Mount-Database cmdlet to mount mailbox databases on Exchange servers. The cmdlet mounts the database only if the Microsoft Exchange Information Store service and the Microsoft Exchange Replication service are running. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Mount-Database [-Identity] + [-AcceptDataLoss] + [-Confirm] + [-DomainController ] + [-Force] + [-NewCapacity] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Mount-Database -Identity ExchangeServer1.Contoso.com\MyDatabase +``` + +This example mounts the database MyDatabase. + +## PARAMETERS + +### -Identity +The Identity parameter specifies mailbox database that you want to mount. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptDataLoss +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -Force +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewCapacity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/database-availability-groups/Move-ActiveMailboxDatabase.md b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md similarity index 88% rename from exchange/exchange-ps/exchange/database-availability-groups/Move-ActiveMailboxDatabase.md rename to exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md index 7ce684fd8f..c59b2bf565 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Move-ActiveMailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Move-ActiveMailboxDatabase @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Move-ActiveMailboxDatabase cmdlet to perform a database or server switchover. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -22,7 +25,7 @@ For information about the parameter sets in the Syntax section below, see Exchan Move-ActiveMailboxDatabase [-ActivatePreferredOnServer] [-Confirm] [-DomainController ] - [-MountDialOverride ] + [-MountDialOverride ] [-MoveComment ] [-SkipActiveCopyChecks] [-SkipClientExperienceChecks] @@ -32,7 +35,8 @@ Move-ActiveMailboxDatabase [-ActivatePreferredOnServer] ] + [-WhatIf] + [] ``` ### Identity @@ -40,7 +44,7 @@ Move-ActiveMailboxDatabase [-ActivatePreferredOnServer] [[-ActivateOnServer] ] [-Confirm] [-DomainController ] - [-MountDialOverride ] + [-MountDialOverride ] [-MoveComment ] [-SkipActiveCopyChecks] [-SkipClientExperienceChecks] @@ -50,15 +54,17 @@ Move-ActiveMailboxDatabase [-Identity] [[-ActivateOnServer [-SkipMaximumActiveDatabasesChecks] [-SkipMoveSuppressionChecks] [-TerminateOnWarning] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Server ``` -Move-ActiveMailboxDatabase [-Server] [[-ActivateOnServer] ] [-MoveAllDatabasesOrNone] +Move-ActiveMailboxDatabase [-Server] [[-ActivateOnServer] ] + [-MoveAllDatabasesOrNone] [-Confirm] [-DomainController ] - [-MountDialOverride ] + [-MountDialOverride ] [-MoveComment ] [-SkipActiveCopyChecks] [-SkipClientExperienceChecks] @@ -68,15 +74,17 @@ Move-ActiveMailboxDatabase [-Server] [[-ActivateOnSer [-SkipMaximumActiveDatabasesChecks] [-SkipMoveSuppressionChecks] [-TerminateOnWarning] - [-WhatIf] [] + [-WhatIf] + [] ``` ### SkipAllChecks ``` -Move-ActiveMailboxDatabase [-Identity] [-ActivateOnServer] [-SkipAllChecks] +Move-ActiveMailboxDatabase [-Identity] [-ActivateOnServer] + [-SkipAllChecks] [-Confirm] [-DomainController ] - [-MountDialOverride ] + [-MountDialOverride ] [-MoveComment ] [-SkipActiveCopyChecks] [-SkipClientExperienceChecks] @@ -86,37 +94,38 @@ Move-ActiveMailboxDatabase [-Identity] [-ActivateOnServer] [-SkipMaximumActiveDatabasesChecks] [-SkipMoveSuppressionChecks] [-TerminateOnWarning] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Move-ActiveMailboxDatabase DB2 -ActivateOnServer MBX1 -MountDialOverride:None ``` This example performs a switchover of the database DB2 to the Mailbox server MBX1. When the command completes, MBX1 hosts the active copy of DB2. Because the MountDialOverride parameter is set to None, MBX1 mounts the database using its own defined database auto mount dial settings. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Move-ActiveMailboxDatabase DB1 -ActivateOnServer MBX3 -MountDialOverride:GoodAvailability ``` This example performs a switchover of the database DB1 to the Mailbox server MBX3. When the command completes, MBX3 hosts the active copy of DB1. Because the MountDialOverride parameter is specified with a value of Good Availability, MBX3 mounts the database using a database auto mount dial setting of GoodAvailability. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Move-ActiveMailboxDatabase DB3 -ActivateOnServer MBX4 ``` This example performs a switchover of the database DB3 to the Mailbox server MBX4. When the command completes, MBX4 hosts the active copy of DB3. Because the MountDialOverride parameter isn't specified, MBX4 mounts the database using a database auto mount dial setting of Lossless. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Move-ActiveMailboxDatabase -Server MBX1 ``` @@ -128,9 +137,7 @@ This example performs a server switchover for the Mailbox server MBX1. All activ 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 - - Distinguished name (DN) - - GUID You can't use this parameter with the Server parameter @@ -140,6 +147,7 @@ Type: DatabaseIdParameter Parameter Sets: Identity, SkipAllChecks Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -151,11 +159,8 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID You can't use this parameter with the Identity parameter @@ -165,6 +170,7 @@ Type: MailboxServerIdParameter Parameter Sets: Server Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -176,11 +182,8 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID You can use this parameter as part of ending maintenance mode on a Mailbox server. @@ -190,6 +193,7 @@ Type: MailboxServerIdParameter Parameter Sets: ActivatePreferred Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -197,6 +201,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ActivateOnServer +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -SkipAllChecks The SkipAllChecks switch specifies whether to skip all checks. You don't need to specify a value with this switch. @@ -209,6 +229,7 @@ Type: SwitchParameter Parameter Sets: SkipAllChecks Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -216,26 +237,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ActivateOnServer -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 -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -243,6 +248,7 @@ 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 @@ -258,6 +264,7 @@ 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 @@ -269,20 +276,17 @@ Accept wildcard characters: False 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. ```yaml -Type: None | Lossless | GoodAvailability | BestAvailability | BestEffort +Type: DatabaseMountDialOverride Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -298,6 +302,7 @@ Type: SwitchParameter Parameter Sets: Server Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -313,6 +318,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -323,13 +329,14 @@ Accept wildcard characters: False ### -SkipActiveCopyChecks 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. +**Note**: When you use this switch, you can move a database that's currently a seeding source, which cancels the seed 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 Default value: None @@ -347,6 +354,7 @@ 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 @@ -362,6 +370,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -379,6 +388,7 @@ 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 @@ -394,6 +404,7 @@ 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 @@ -411,6 +422,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -426,6 +438,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -441,6 +454,7 @@ 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 @@ -456,6 +470,7 @@ 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 @@ -464,20 +479,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/755d1ecb-95d1-45e3-9a21-56df9f196f37.aspx) diff --git a/exchange/exchange-ps/exchange/Move-AddressList.md b/exchange/exchange-ps/exchange/Move-AddressList.md new file mode 100644 index 0000000000..d2c70381c6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Move-AddressList.md @@ -0,0 +1,155 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Move-AddressList + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Move-AddressList cmdlet to move an existing address list to a new container under the root address list. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Move-AddressList [-Identity] -Target + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Move-AddressList -Identity c3fffd8e-026b-41b9-88c4-8c21697ac8ac -Target "\All Users\Sales\building4" +``` + +This example moves the address list with GUID c3fffd8e-026b-41b9-88c4-8c21697ac8ac to a new location under the parent address list \\All Users\\Sales\\building4. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +```yaml +Type: AddressListIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Target +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +```yaml +Type: AddressListIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -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/Move-DatabasePath.md b/exchange/exchange-ps/exchange/Move-DatabasePath.md new file mode 100644 index 0000000000..88ab1bea84 --- /dev/null +++ b/exchange/exchange-ps/exchange/Move-DatabasePath.md @@ -0,0 +1,228 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Move-DatabasePath + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Move-DatabasePath cmdlet to set a new path to the location of a database on the specified Mailbox server and to move the related files to that location. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Move-DatabasePath [-Identity] + [-ConfigurationOnly] + [-Confirm] + [-DomainController ] + [-EDBFilePath ] + [-Force] + [-LogFolderPath ] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you use the Move-DatabasePath cmdlet, consider the following: + +- This cmdlet fails if it's run while the database is being backed up. +- If the specified database is mounted when this cmdlet is run, the database is automatically dismounted and then remounted, and is unavailable to users while it's dismounted. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Move-DatabasePath -Identity MyDatabase01 -EdbFilePath C:\NewFolder\MyDatabase01.edb +``` + +This example sets a new path for the mailbox database specified by the mailbox database name. To perform the move operation, the database must be temporarily dismounted, making it inaccessible to all users. If the database is currently dismounted, it isn't remounted upon completion. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the database that you want to move. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConfigurationOnly +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -EDBFilePath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -LogFolderPath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### -EDBFilePath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Move-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md new file mode 100644 index 0000000000..52e6b27ad3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md @@ -0,0 +1,155 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Move-OfflineAddressBook + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Move-OfflineAddressBook cmdlet to designate a new server that's responsible for generating the offline address book (OAB) in Exchange Server 2010. This cmdlet isn't used on OABs in Exchange Server 2016 or Exchange Server 2013. To perform this task in Exchange 2016 or Exchange 2013, use the Set-OfflineAddressBook cmdlet with the GeneratingMailbox parameter. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Move-OfflineAddressBook [-Identity] + [-Confirm] + [-DomainController ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Move-OfflineAddressBook -Identity "My OAB" -Server "Server1" +``` + +This example moves OAB generation in Exchange 2010 to the server named Server1. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: OfflineAddressBookIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md new file mode 100644 index 0000000000..85953675d6 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule +applicable: Exchange Online +title: New-ATPBuiltInProtectionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ATPBuiltInProtectionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: Don't use this cmdlet. This cmdlet is used by the system to create the one and only rule for the Built-in protection preset security policy during the creation of the organization. You can't use this cmdlet if a rule for the Built-in protection preset security policy already exists. The Remove-ATPBuiltInProtectionRule cmdlet is not available to remove rules. + +Use the New-ATPBuiltInProtectionRule cmdlet to create the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ATPBuiltInProtectionRule -SafeAttachmentPolicy -SafeLinksPolicy + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ATPBuiltInProtectionRule -SafeAttachmentPolicy "Built-In Protection Policy" -SafeLinksPolicy "Built-In Protection Policy" +``` + +This cmdlet creates the rule for the Built-in protection preset security policy. This command will fail if the rule already exists. + +## PARAMETERS + +### -SafeAttachmentPolicy +The SafeAttachmentPolicy parameter specifies the Safe Attachments policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeAttachmentPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. + +The name of the default Safe Attachments policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeLinksPolicy +The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeLinksPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. + +The name of the default Safe Links policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +The name of the only rule is ATP Built-In Protection Rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..9397716f14 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule +applicable: Exchange Online +title: New-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ATPProtectionPolicyRule cmdlet to create rules for Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +**Note**: Unless you manually removed a rule using the Remove-ATPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ATPProtectionPolicyRule [-Name] -SafeAttachmentPolicy -SafeLinksPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ATPProtectionPolicyRule -Name "Standard Preset Security Policy" -SafeAttachmentPolicy "Standard Preset Security Policy1622650008019" -SafeLinksRule "Standard Preset Security Policy1622650008534" Priority 1 +``` + +This example creates the rule for the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. If the rule already exists, the command will fail. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeAttachmentPolicy +The SafeAttachmentPolicy parameter specifies the existing Safe Attachments policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650008019`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034872546`. + +You can find the Safe Attachments policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-SafeAttachmentPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-SafeAttachmentPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeLinksPolicy +The SafeLinksPolicy parameter specifies the existing Safe Links policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650008534`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034873192`. + +You can find the Safe Links policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-SafeLinksPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-SafeLinksPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. +- $false: The rule is disabled. The State value of the rule is Disabled. + +After you create the rule, you turn on or turn off the preset security policy using one of the following commands: + +- Turn off: Disable-ATPProtectionPolicyRule and Disable-EOPProtectionPolicyRule. +- Turn on: Enable-ATPProtectionPolicyRule and Enable-EOPProtectionPolicyRule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +When you create the policy, you must use the default value. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/New-AcceptedDomain.md b/exchange/exchange-ps/exchange/New-AcceptedDomain.md similarity index 81% rename from exchange/exchange-ps/exchange/mail-flow/New-AcceptedDomain.md rename to exchange/exchange-ps/exchange/New-AcceptedDomain.md index d8d73f94fb..157ffaec81 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/New-AcceptedDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-AcceptedDomain @@ -13,23 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the New-AcceptedDomain cmdlet to create an accepted domain in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AcceptedDomain [-Name] -DomainName - [-Confirm] [-DomainController ] [-DomainType ] - [-WhatIf] [] + [-Confirm] + [-DomainController ] + [-DomainType ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-AcceptedDomain -DomainName Contoso.com -DomainType Authoritative -Name Contoso ``` @@ -37,33 +43,35 @@ This example creates the new authoritative accepted domain Contoso. ## PARAMETERS -### -DomainName -The DomainName parameter specifies the SMTP domain that you want to establish as an accepted domain. Valid input for the DomainName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. - -However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string may not contain more than 256 characters. +### -Name +The Name parameter specifies a unique name for the accepted domain object. ```yaml -Type: SmtpDomainWithSubdomains +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the accepted domain object. +### -DomainName +The DomainName parameter specifies the SMTP domain that you want to establish as an accepted domain. Valid input for the DomainName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. + +However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string may not contain more than 256 characters. ```yaml -Type: String +Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -72,8 +80,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -81,6 +88,7 @@ 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 @@ -98,6 +106,7 @@ 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 @@ -113,10 +122,11 @@ In an authoritative domain, messages are delivered to a recipient that has a dom The default value is Authoritative. ```yaml -Type: Authoritative | ExternalRelay | InternalRelay +Type: AcceptedDomainType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -132,6 +142,7 @@ 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 @@ -140,20 +151,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/08bcaaec-51e3-447d-b3bf-406a705c64b4.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md similarity index 77% rename from exchange/exchange-ps/exchange/devices/New-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md index e61fc70887..136f962987 100644 --- a/exchange/exchange-ps/exchange/devices/New-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ActiveSyncDeviceAccessRule @@ -13,32 +16,34 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ActiveSyncDeviceAccessRule cmdlet to define the access levels for Exchange ActiveSync devices based on the identity of the device. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncDeviceAccessRule -AccessLevel - -Characteristic -QueryString [-Confirm] - [-DomainController ] [-WhatIf] [] +New-ActiveSyncDeviceAccessRule -AccessLevel -Characteristic -QueryString + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ActiveSyncDeviceAccessRule -Characteristic DeviceOS -QueryString "iOS 6.1 10B145" -AccessLevel Block ``` This example creates device access rules that blocks access for iPhones that are running iOS version 6.1.1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-ActiveSyncDeviceAccessRule -Characteristic UserAgent -QueryString NokiaE521/2.00()MailforExchange -AccessLevel Allow ``` @@ -50,10 +55,11 @@ This example creates a device access rule that uses the UserAgent characteristic 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: Allow | Block | Quarantine +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 Default value: None @@ -65,20 +71,17 @@ Accept wildcard characters: False The Characteristic parameter specifies the device characteristic or category that's used by the rule. Valid values for this parameter are: - DeviceModel - - DeviceType - - DeviceOS - - UserAgent - - XMSWLHeader ```yaml -Type: DeviceType | DeviceModel | DeviceOS | UserAgent +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 Default value: None @@ -96,6 +99,7 @@ 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 Default value: None @@ -106,8 +110,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -115,6 +118,7 @@ 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 Default value: None @@ -131,7 +135,8 @@ 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -147,6 +152,7 @@ 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 Default value: None @@ -155,20 +161,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a33c69d8-4d19-4e9d-b5cf-27727b7c4a8f.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/devices/New-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md index 386b9817b3..e194e62483 100644 --- a/exchange/exchange-ps/exchange/devices/New-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ActiveSyncMailboxPolicy @@ -13,45 +16,71 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ActiveSyncMailboxPolicy cmdlet to create a Microsoft Mobile Device mailbox policy object. -Note: In Exchange 2013 or later, use the New-MobileMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileMailboxPolicy. +**Note**: In Exchange 2013 or later, use the New-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileDeviceMailboxPolicy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncMailboxPolicy [-Name] [-AllowBluetooth ] - [-AllowBrowser <$true | $false>] [-AllowCamera <$true | $false>] [-AllowConsumerEmail <$true | $false>] - [-AllowDesktopSync <$true | $false>] [-AllowExternalDeviceManagement <$true | $false>] - [-AllowHTMLEmail <$true | $false>] [-AllowInternetSharing <$true | $false>] [-AllowIrDA <$true | $false>] - [-AllowMobileOTAUpdate <$true | $false>] [-AllowNonProvisionableDevices <$true | $false>] - [-AllowPOPIMAPEmail <$true | $false>] [-AllowRemoteDesktop <$true | $false>] - [-AllowSimpleDevicePassword <$true | $false>] - [-AllowSMIMEEncryptionAlgorithmNegotiation ] - [-AllowSMIMESoftCerts <$true | $false>] [-AllowStorageCard <$true | $false>] - [-AllowTextMessaging <$true | $false>] [-AllowUnsignedApplications <$true | $false>] - [-AllowUnsignedInstallationPackages <$true | $false>] [-AllowWiFi <$true | $false>] - [-AlphanumericDevicePasswordRequired <$true | $false>] - [-ApprovedApplicationList ] [-AttachmentsEnabled <$true | $false>] [-Confirm] - [-DeviceEncryptionEnabled <$true | $false>] [-DevicePasswordEnabled <$true | $false>] - [-DevicePasswordExpiration ] [-DevicePasswordHistory ] - [-DevicePolicyRefreshInterval ] [-DomainController ] [-IrmEnabled <$true | $false>] - [-IsDefaultPolicy <$true | $false>] [-MaxAttachmentSize ] - [-MaxCalendarAgeFilter ] +New-ActiveSyncMailboxPolicy [-Name] + [-AllowApplePushNotifications ] + [-AllowBluetooth ] + [-AllowBrowser ] + [-AllowCamera ] + [-AllowConsumerEmail ] + [-AllowDesktopSync ] + [-AllowExternalDeviceManagement ] + [-AllowHTMLEmail ] + [-AllowInternetSharing ] + [-AllowIrDA ] + [-AllowMobileOTAUpdate ] + [-AllowNonProvisionableDevices ] + [-AllowPOPIMAPEmail ] + [-AllowRemoteDesktop ] + [-AllowSMIMEEncryptionAlgorithmNegotiation ] + [-AllowSMIMESoftCerts ] + [-AllowSimpleDevicePassword ] + [-AllowStorageCard ] + [-AllowTextMessaging ] + [-AllowUnsignedApplications ] + [-AllowUnsignedInstallationPackages ] + [-AllowWiFi ] + [-AlphanumericDevicePasswordRequired ] + [-ApprovedApplicationList ] + [-AttachmentsEnabled ] + [-Confirm] + [-DeviceEncryptionEnabled ] + [-DevicePasswordEnabled ] + [-DevicePasswordExpiration ] + [-DevicePasswordHistory ] + [-DevicePolicyRefreshInterval ] + [-DomainController ] + [-IrmEnabled ] + [-IsDefault ] + [-IsDefaultPolicy ] + [-MaxAttachmentSize ] + [-MaxCalendarAgeFilter ] [-MaxDevicePasswordFailedAttempts ] - [-MaxEmailAgeFilter ] - [-MaxEmailBodyTruncationSize ] [-MaxEmailHTMLBodyTruncationSize ] - [-MaxInactivityTimeDeviceLock ] [-MinDevicePasswordComplexCharacters ] + [-MaxEmailAgeFilter ] + [-MaxEmailBodyTruncationSize ] + [-MaxEmailHTMLBodyTruncationSize ] + [-MaxInactivityTimeDeviceLock ] + [-MinDevicePasswordComplexCharacters ] [-MinDevicePasswordLength ] - [-MobileOTAUpdateMode ] - [-PasswordRecoveryEnabled <$true | $false>] - [-RequireDeviceEncryption <$true | $false>] [-RequireEncryptedSMIMEMessages <$true | $false>] - [-RequireEncryptionSMIMEAlgorithm ] - [-RequireManualSyncWhenRoaming <$true | $false>] [-RequireSignedSMIMEAlgorithm ] - [-RequireSignedSMIMEMessages <$true | $false>] [-RequireStorageCardEncryption <$true | $false>] - [-UnapprovedInROMApplicationList ] [-UNCAccessEnabled <$true | $false>] [-WhatIf] - [-WSSAccessEnabled <$true | $false>] [-AllowApplePushNotifications <$true | $false>] - [-IsDefault <$true | $false>] [] + [-PasswordRecoveryEnabled ] + [-RequireDeviceEncryption ] + [-RequireEncryptedSMIMEMessages ] + [-RequireEncryptionSMIMEAlgorithm ] + [-RequireManualSyncWhenRoaming ] + [-RequireSignedSMIMEAlgorithm ] + [-RequireSignedSMIMEMessages ] + [-RequireStorageCardEncryption ] + [-UNCAccessEnabled ] + [-UnapprovedInROMApplicationList ] + [-WSSAccessEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -59,26 +88,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ActiveSyncMailboxPolicy -Name:"SalesPolicy" -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -IsDefault:$false -AttachmentsEnabled:$false -AllowStorageCard:$true ``` This example creates the Mobile Device mailbox policy SalesPolicy that has several preconfigured values. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-ActiveSyncMailboxPolicy -Name:"Management" -AllowBluetooth:Allow -AllowBrowser:$true -AllowCamera:$true -AllowPOPIMAPEmail:$false -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -MaxEmailAgeFilter:OneWeek -AllowWiFi:$true -AllowStorageCard:$true ``` This example creates the Mobile Device mailbox policy Management that has several preconfigured values. Users assigned to this policy should have an Enterprise client access license (CAL) to use many of these features. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-ActiveSyncMailboxPolicy -Name:"Contoso" -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -MinDevicePasswordComplexCharacters:3 -IsDefault:$true -DevicePasswordHistory:10 ``` @@ -94,6 +123,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -101,14 +131,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowApplePushNotifications +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowBluetooth 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: Disable | HandsfreeOnly | Allow +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 Default value: None @@ -120,10 +169,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -135,10 +185,11 @@ Accept wildcard characters: False The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -150,10 +201,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -165,10 +217,11 @@ Accept wildcard characters: False The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -180,10 +233,11 @@ Accept wildcard characters: False The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the device. ```yaml -Type: $true | $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 Default value: None @@ -195,10 +249,11 @@ Accept wildcard characters: False The AllowHTMLEmail parameter specifies whether HTML email is enabled on the device. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -210,10 +265,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -225,10 +281,11 @@ Accept wildcard characters: False The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -240,10 +297,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -255,10 +313,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -270,10 +329,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -285,10 +345,11 @@ Accept wildcard characters: False The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -300,10 +361,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -315,10 +377,11 @@ Accept wildcard characters: False 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: BlockNegotiation | OnlyStrongAlgorithmNegotiation | AllowAnyAlgorithmNegotiation +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 Default value: None @@ -330,10 +393,11 @@ Accept wildcard characters: False The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -345,10 +409,11 @@ Accept wildcard characters: False The AllowStorageCard parameter specifies whether the device can access information stored on a storage card. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -360,10 +425,11 @@ Accept wildcard characters: False The AllowTextMessaging parameter specifies whether text messaging is allowed from the device. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -375,10 +441,11 @@ Accept wildcard characters: False The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the device. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -390,10 +457,11 @@ Accept wildcard characters: False The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be run on the device. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -405,10 +473,11 @@ Accept wildcard characters: False The AllowWiFi parameter specifies whether wireless Internet access is allowed on the device. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -420,10 +489,11 @@ Accept wildcard characters: False The AlphanumericDevicePasswordRequired parameter specifies whether the device password must be alphanumeric. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -439,6 +509,7 @@ 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 Default value: None @@ -450,10 +521,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -464,8 +536,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -473,6 +544,7 @@ 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 Default value: None @@ -484,10 +556,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -499,10 +572,11 @@ Accept wildcard characters: False When set to $true, the DevicePasswordEnabled parameter specifies that the user set a password for the device. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -518,6 +592,7 @@ 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 Default value: None @@ -533,6 +608,7 @@ 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 Default value: None @@ -548,6 +624,7 @@ 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 Default value: None @@ -564,7 +641,8 @@ 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -576,10 +654,27 @@ Accept wildcard characters: False The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. ```yaml -Type: $true | $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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 Default value: None @@ -591,10 +686,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -610,6 +706,7 @@ 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 Default value: None @@ -618,23 +715,20 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter -The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. Possible values are: +The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. Valid values are: - All - - TwoWeeks - - OneMonth - - ThreeMonths - - SixMonths ```yaml -Type: All | TwoWeeks | OneMonth | ThreeMonths | SixMonths +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 Default value: None @@ -650,6 +744,7 @@ 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 Default value: None @@ -663,26 +758,20 @@ The MaxEmailAgeFilter parameter specifies the maximum number of days of email it Possible values are: - All - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth - - ThreeMonths - - SixMonths ```yaml -Type: All | OneDay | ThreeDays | OneWeek | TwoWeeks | OneMonth +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 Default value: None @@ -698,6 +787,7 @@ 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 Default value: None @@ -713,6 +803,7 @@ 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 Default value: None @@ -728,6 +819,7 @@ 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 Default value: None @@ -743,6 +835,7 @@ 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 Default value: None @@ -758,23 +851,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobileOTAUpdateMode -This parameter is available or functional only in Exchange Server 2010. -The MobileOTAUpdateMode parameter specifies which updates can be seen by the devices that implemented support for this restricting functionality. It must be used in conjunction with the AllowMobileOTAUpdate parameter to function properly. - -```yaml -Type: MajorVersionUpdates | MinorVersionUpdates | BetaVersionUpdates -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named Default value: None @@ -786,10 +863,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -801,10 +879,11 @@ Accept wildcard characters: False The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -816,10 +895,11 @@ Accept wildcard characters: False The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -831,10 +911,11 @@ Accept wildcard characters: False The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. ```yaml -Type: TripleDES | DES | RC2128bit | RC264bit | RC240bit +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 Default value: None @@ -846,10 +927,11 @@ Accept wildcard characters: False The RequireManualSyncWhenRoaming parameter specifies whether the device must synchronize manually while roaming. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -861,10 +943,11 @@ Accept wildcard characters: False The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. ```yaml -Type: SHA1 | MD5 +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 Default value: None @@ -876,10 +959,11 @@ Accept wildcard characters: False The RequireSignedSMIMEMessages parameter specifies whether the device must send signed S/MIME messages. ```yaml -Type: $true | $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 Default value: None @@ -891,10 +975,11 @@ Accept wildcard characters: False The RequireStorageCardEncryption parameter specifies whether encryption of a storage card is required. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -910,6 +995,7 @@ 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 Default value: None @@ -921,10 +1007,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -940,6 +1027,7 @@ 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 Default value: None @@ -951,42 +1039,11 @@ Accept wildcard characters: False 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: $true | $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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowApplePushNotifications -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named Default value: None @@ -995,20 +1052,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/90d6872e-8e2b-4e53-9554-a2120e99cc20.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md index e6d327bc02..03c846da01 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ActiveSyncVirtualDirectory @@ -13,44 +16,55 @@ This cmdlet is available only in on-premises Exchange. Use the New-ActiveSyncVirtualDirectory cmdlet to create Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncVirtualDirectory [-ApplicationRoot ] [-AppPoolId ] [-Confirm] - [-DomainController ] [-ExtendedProtectionFlags ] - [-ExtendedProtectionSPNList ] [-ExtendedProtectionTokenChecking ] - [-ExternalAuthenticationMethods ] [-ExternalUrl ] - [-InstallProxySubDirectory <$true | $false>] [-InternalAuthenticationMethods ] - [-InternalUrl ] [-Path ] [-WebSiteName ] [-WhatIf] [-Role ] - [-Server ] [] +New-ActiveSyncVirtualDirectory [-ApplicationRoot ] + [-AppPoolId ] + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalAuthenticationMethods ] + [-ExternalUrl ] + [-InstallProxySubDirectory ] + [-InternalAuthenticationMethods ] + [-InternalUrl ] + [-Path ] + [-Role ] + [-Server ] + [-WebSiteName ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -New-ActiveSyncVirtualDirectory -WebSiteName "Default Web Site" -ExternalUrl http://www.contoso.com/Microsoft-Server-ActiveSync +### Example 1 +```powershell +New-ActiveSyncVirtualDirectory -WebSiteName "Default Web Site" -ExternalUrl https://www.contoso.com/Microsoft-Server-ActiveSync ``` This example creates an Exchange ActiveSync virtual directory and specifies the external URL used to connect to the virtual directory. -### -------------------------- Example 2 -------------------------- -``` -New-ActiveSyncVirtualDirectory -WebSiteName "Default Web Site" -ExternalUrl http://www.contoso.com/mail -InternalUrl http://contoso/mail +### Example 2 +```powershell +New-ActiveSyncVirtualDirectory -WebSiteName "Default Web Site" -ExternalUrl https://www.contoso.com/mail -InternalUrl https://contoso/mail ``` This example creates an Exchange ActiveSync virtual directory and specifies the external and internal URLs used to connect to the virtual directory. -### -------------------------- Example 3 -------------------------- -``` -New-ActiveSyncVirtualDirectory -WebSiteName "Default Web Site" -ExternalUrl "http://www.fourthcoffee.com/Microsoft-Server-ActiveSync" +### Example 3 +```powershell +New-ActiveSyncVirtualDirectory -WebSiteName "Default Web Site" -ExternalUrl "https://www.fourthcoffee.com/Microsoft-Server-ActiveSync" ``` This example creates an Exchange ActiveSync virtual directory for the company Fourth Coffee. @@ -65,6 +79,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -80,6 +95,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -90,8 +106,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -99,6 +114,7 @@ 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 @@ -114,6 +130,7 @@ 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 @@ -125,13 +142,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -139,6 +152,7 @@ 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 @@ -150,14 +164,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -169,20 +183,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -194,33 +205,19 @@ Accept wildcard characters: False 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 - - Basic - - Certificate - - Digest - - Fba - - Kerberos - - LiveIdBasic - - LiveIdFba - - LiveIdNegotiate - - NegoEx - - Negotiate - - Ntlm - - OAuth - - WindowsIntegrated - - WSSecurity You can specify multiple values separated by commas. @@ -228,7 +225,6 @@ You can specify multiple values separated by commas. Although you can specify any of these values, whether or not the authentication method actually works for external connections depends on other factors. For example: - Is the authentication method available on the virtual directory? - - Is the authentication method available, but disabled on the virtual directory? The default value is blank ($null), which means all available authentication methods are accepted. @@ -238,6 +234,7 @@ 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 @@ -253,6 +250,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -261,13 +259,14 @@ Accept wildcard characters: False ``` ### -InstallProxySubDirectory -The InstallProxySubDirectory parameter was used to create an subdirectory that was required for proxing ActiveSync connections with Exchange 2007. +The InstallProxySubDirectory parameter was used to create an subdirectory that was required for proxying ActiveSync connections with Exchange 2007. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -279,33 +278,19 @@ Accept wildcard characters: False 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 - - Basic - - Certificate - - Digest - - Fba - - Kerberos - - LiveIdBasic - - LiveIdFba - - LiveIdNegotiate - - NegoEx - - Negotiate - - Ntlm - - OAuth - - WindowsIntegrated - - WSSecurity You can specify multiple values separated by commas. @@ -313,7 +298,6 @@ You can specify multiple values separated by commas. Although you can specify any of these values, whether or not the authentication method actually works for internal connections depends on other factors. For example: - Is the authentication method available on the virtual directory? - - Is the authentication method available, but disabled on the virtual directory? The default value is blank ($null), which means all available authentication methods are accepted. @@ -323,6 +307,7 @@ 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 @@ -338,6 +323,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -353,36 +339,7 @@ Type: String 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 -``` - -### -WebSiteName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -394,16 +351,16 @@ Accept wildcard characters: False 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. - - Mailbox: Configure the virtual directory for the backend services on the Mailbox server. Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. ```yaml -Type: ClientAccess | Mailbox +Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -415,11 +372,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - ExchangeLegacyDN ```yaml @@ -427,6 +381,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -434,21 +389,51 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -WebSiteName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/30cdae85-3d72-450f-98cd-be1413e86cc0.aspx) diff --git a/exchange/exchange-ps/exchange/New-AdaptiveScope.md b/exchange/exchange-ps/exchange/New-AdaptiveScope.md new file mode 100644 index 0000000000..88433a9deb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AdaptiveScope.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-adaptivescope +applicable: Security & Compliance +title: New-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AdaptiveScope cmdlet to create adaptive scopes in your organization. Adaptive scopes (or static scopes) are used in retention policies and retention label policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-AdaptiveScope -Name -FilterConditions -LocationType + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +### AdaptiveScopeRawQuery +``` +New-AdaptiveScope -Name -LocationType -RawQuery + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +## DESCRIPTION +For more information about the properties to use in adaptive scopes, see [Configuration information for adaptive scopes](https://learn.microsoft.com/purview/retention-settings#configuration-information-for-adaptive-scopes). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AdaptiveScope -Name "Project X" -LocationType User -FilterConditions @{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"} +``` + +This example create an adaptive query scope named Project X with the following details: + +- Scope: Users +- Query: "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'". + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the adaptive scope. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterConditions +The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: + +- User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` +- Site: Indexed custom properties. For example, for the condition "'Refinable string 0' equals 'Human Resources', use the following syntax: `@{"Conditions" = @{"Value" = "Human Resources"; "Operator" = "Equals"; "Name" = "RefinableString00"}; "Conjunction" = "And"}` + +You can't use this parameter with the RawQuery parameter. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationType +The LocationType parameter specifies the location where the adaptive scope filter is defined. Valid values are: + +- User +- Group (Microsoft 365 group) +- Site + +```yaml +Type: DynamicBoundaryLocationType +Parameter Sets: (All) +Aliases: +Accepted values: Unknown, User, Group, Site +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawQuery +The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. + +You can't use this parameter with the FilterConditions parameter. + +```yaml +Type: String +Parameter Sets: AdaptiveScopeRawQuery +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministrativeUnit +{{ Fill AdministrativeUnit Description }} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md b/exchange/exchange-ps/exchange/New-AddressBookPolicy.md new file mode 100644 index 0000000000..4bade089b4 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AddressBookPolicy.md @@ -0,0 +1,213 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists that will be displayed to mailbox users who are assigned the policy. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AddressBookPolicy [-Name] -AddressLists -GlobalAddressList -OfflineAddressBook -RoomList + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AddressBookPolicy -Name "All Fabrikam ABP" -AddressLists "\All Fabrikam","\All Fabrikam Mailboxes","\All Fabrikam DLs","\All Fabrikam Contacts" -RoomList "\All Fabrikam-Rooms" -OfflineAddressBook "\Fabrikam-All-OAB" -GlobalAddressList "\All Fabrikam" +``` + +This example creates an address book policy with the following settings: + +- Name: All Fabrikam ABP +- Included address lists: All Fabrikam, All Fabrikam Mailboxes, All Fabrikam DLs, All Fabrikam Contacts +- Included room list: All Fabrikam-Rooms +- Included OAB: Fabrikam-All-OAB +- Included GAL: All Fabrikam + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +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". + +```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 +Default value: None +Accept pipeline input: False +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. + +```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 +Default value: None +Accept pipeline input: False +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomList +The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them. + +- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchange/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. +- When using experiences that aren't location specific (for example, the To or Cc fields of a calendar event), the address lists specified by the AddressLists parameter in this address book policy are applied. The address list specified by this parameter isn't used. + +A valid value for this parameter is one address list. You can use any value that uniquely identifies the address list. For example: + +- Name +- Distinguished name (DN) +- GUID + +> [!NOTE] +> There's no automatic association between this parameter and [room list distribution groups](https://learn.microsoft.com/exchange/recipients/room-mailboxes#create-a-room-list), which also use a parameter named RoomList in the New-DistributionGroup and Set-DistributionGroup cmdlets. You still need to create room list distribution groups and assign resources as group members. Location experiences are filtered to show only rooms included in the address list that's specified by the RoomList property of the address book policy that's assigned to the user (if any). + +```yaml +Type: AddressListIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-AddressList.md b/exchange/exchange-ps/exchange/New-AddressList.md new file mode 100644 index 0000000000..540855b553 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AddressList.md @@ -0,0 +1,667 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-AddressList cmdlet to create address lists and apply them to recipients. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### PrecannedFilter +``` +New-AddressList [-Name] -IncludedRecipients + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-Container ] + [-DisplayName ] + [-DomainController ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### CustomFilter +``` +New-AddressList [-Name] -RecipientFilter + [-Confirm] + [-Container ] + [-DisplayName ] + [-DomainController ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AddressList -Name MyAddressList -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))" +``` + +This example creates the address list MyAddressList. The address list includes recipients that are mailbox users and have the StateOrProvince property set to Washington or Oregon. + +### Example 2 +```powershell +New-AddressList -Name MyAddressList2 -ConditionalStateOrProvince Washington -IncludedRecipients MailboxUsers +``` + +This example creates the address list MyAddressList2 that includes mailboxes that have the ConditionalStateOrProvince parameter set to Washington. + +### Example 3 +```powershell +New-AddressList -Name "AL_AgencyB" -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and (CustomAttribute15 -like 'AgencyB*'))" +``` + +This example creates the address list AL\_AgencyB that includes mailboxes that have the value of the CustomAttribute15 parameter contains AgencyB. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientFilter +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute1 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute10 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute11 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute12 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute13 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute14 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute15 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute2 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute3 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute4 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute5 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute6 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute7 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute8 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute9 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalDepartment +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalStateOrProvince +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +If you don't use this parameter,the address list is created under the root (\\). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is the OU where the object was created. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/New-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md similarity index 87% rename from exchange/exchange-ps/exchange/mail-flow/New-AddressRewriteEntry.md rename to exchange/exchange-ps/exchange/New-AddressRewriteEntry.md index 7ee3403b8a..1c5c9541bd 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-AddressRewriteEntry @@ -13,13 +16,17 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the New-AddressRewriteEntry cmdlet to create an address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AddressRewriteEntry [-Name] -ExternalAddress -InternalAddress [-Confirm] - [-DomainController ] [-ExceptionList ] [-OutboundOnly <$true | $false>] [-WhatIf] +New-AddressRewriteEntry [-Name] -ExternalAddress -InternalAddress + [-Confirm] + [-DomainController ] + [-ExceptionList ] + [-OutboundOnly ] + [-WhatIf] [] ``` @@ -28,22 +35,22 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-AddressRewriteEntry -Name "Address rewrite entry for david@contoso.com" -InternalAddress david@contoso.com -ExternalAddress david@northwindtraders.com ``` This example creates an address rewrite entry that rewrites the email address david@contoso.com to david@northwindtraders.com in outbound mail. Because the OutboundOnly parameter is not set to $true, inbound mail sent to david@northwindtraders.com is rewritten back to david@contoso.com. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-AddressRewriteEntry -Name "Address rewrite entry for all contoso.com email addresses" -InternalAddress contoso.com -ExternalAddress northwindtraders.com ``` This example creates an address rewrite entry that rewrites all email addresses in the contoso.com domain to northwindtraders.com in outbound mail. Because the OutboundOnly parameter is not set to $true, inbound mail sent to northwindtraders.com recipients is rewritten back to contoso.com. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-AddressRewriteEntry -Name "Address rewrite entry for contoso.com and all subdomain email addresses" -InternalAddress *.contoso.com -ExternalAddress northwindtraders.com -ExceptionList research.contoso.com,corp.contoso.com -OutboundOnly $true ``` @@ -59,6 +66,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -76,6 +84,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -87,9 +96,7 @@ Accept wildcard characters: False 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 - - Single domain: contoso.com or sales.contoso.com - - Domain and all subdomains: \*.contoso.com ```yaml @@ -97,6 +104,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -107,8 +115,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -116,6 +123,7 @@ 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 @@ -133,6 +141,7 @@ 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 @@ -148,6 +157,7 @@ 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 @@ -163,10 +173,11 @@ You must set this parameter to $true if the InternalAddress parameter contains t Also, when you configure outbound-only address rewriting, you need to configure the rewritten email address as a proxy address on the affected recipients. For example, if laura@sales.contoso.com is rewritten to laura@contoso.com, the proxy address laura@contoso.com must be configured on Laura's mailbox. This allows replies and inbound messages to be delivered correctly. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -182,6 +193,7 @@ 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 @@ -190,20 +202,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b75fa347-ae84-4fe8-90be-2fe1bc6bc8d4.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md similarity index 75% rename from exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md rename to exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md index 9ede55c8fe..1059619e55 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md +++ b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md @@ -1,54 +1,63 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-AdminAuditLogSearch ## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-AdminAuditLogSearch cmdlet to search the contents of the administrator audit log and send the results to one or more mailboxes that you specify. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AdminAuditLogSearch [ -EndDate - -StartDate -StatusMailRecipients [-Cmdlets ] - [-Confirm] [-DomainController ] [-Name ] [-ObjectIds ] - [-Parameters ] [-UserIds ] [-WhatIf] - [-ExternalAccess <$true | $false>] [] +New-AdminAuditLogSearch -EndDate -StartDate -StatusMailRecipients + [-Cmdlets ] + [-Confirm] + [-DomainController ] + [-ExternalAccess ] + [-Name ] + [-ObjectIds ] + [-Parameters ] + [-UserIds ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-AdminAuditLogSearch -Name "Mailbox Quota Change Audit" -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota -StartDate 01/24/2018 -EndDate 02/12/2018 -StatusMailRecipients david@contoso.com, chris@contoso.com ``` This example finds all the administrator audit log entries that match the following criteria and sends the results to the david@contoso.com and chris@contoso.com SMTP addresses: - Cmdlets:Set-Mailbox - - Parameters:UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota - - StartDate: 01/24/2018 - - EndDate: 02/12/2018 -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-AdminAuditLogSearch -ExternalAccess $true -StartDate 07/25/2018 -EndDate 10/24/2018 -StatusMailRecipients admin@contoso.com,pilarp@contoso.com -Name "Datacenter admin audit log" ``` @@ -59,13 +68,13 @@ This example returns entries in the administrator audit log of an Exchange Onlin ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -76,13 +85,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -99,7 +108,7 @@ If you want to specify more than one recipient, separate each SMTP address with Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -116,7 +125,7 @@ If you want to specify more than one cmdlet, separate each cmdlet with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -127,15 +136,14 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +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 @@ -153,6 +161,22 @@ 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 +``` + +### -ExternalAccess +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 @@ -169,7 +193,7 @@ If the name of the report contains spaces, enclose the name in quotation marks ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -186,7 +210,7 @@ If you want to specify more than one object ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -203,7 +227,7 @@ If you want to specify more than one parameter, separate each parameter with a c Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -220,7 +244,7 @@ If you want to specify more than one user ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -229,7 +253,7 @@ Accept wildcard characters: False ``` ### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. +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. @@ -237,22 +261,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccess -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -261,20 +270,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/52a221e0-ded1-44dc-a626-ca264eca4113.aspx) diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md new file mode 100644 index 0000000000..412a2a5340 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -0,0 +1,1003 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-AntiPhishPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-AntiPhishPolicy cmdlet to create antiphish policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AntiPhishPolicy [-Name] + [-AdminDisplayName ] + [-AuthenticationFailAction ] + [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] + [-Enabled ] + [-EnableFirstContactSafetyTips ] + [-EnableMailboxIntelligence ] + [-EnableMailboxIntelligenceProtection ] + [-EnableOrganizationDomainsProtection ] + [-EnableSimilarDomainsSafetyTips ] + [-EnableSimilarUsersSafetyTips ] + [-EnableSpoofIntelligence ] + [-EnableTargetedDomainsProtection ] + [-EnableTargetedUserProtection ] + [-EnableUnauthenticatedSender ] + [-EnableUnusualCharactersSafetyTips ] + [-EnableViaTag ] + [-ExcludedDomains ] + [-ExcludedSenders ] + [-HonorDmarcPolicy ] + [-ImpersonationProtectionState ] + [-MailboxIntelligenceProtectionAction ] + [-MailboxIntelligenceProtectionActionRecipients ] + [-MailboxIntelligenceQuarantineTag ] + [-MakeDefault] + [-PhishThresholdLevel ] + [-PolicyTag ] + [-RecommendedPolicyType ] + [-SimilarUsersSafetyTipsCustomText ] + [-SpoofQuarantineTag ] + [-TargetedDomainActionRecipients ] + [-TargetedDomainProtectionAction ] + [-TargetedDomainQuarantineTag ] + [-TargetedDomainsToProtect ] + [-TargetedUserActionRecipients ] + [-TargetedUserProtectionAction ] + [-TargetedUserQuarantineTag ] + [-TargetedUsersToProtect ] + [-UnusualCharactersSafetyTipsCustomText ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Phishing messages contain fraudulent links or spoofed domains in an effort to get personal information from the recipients. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-AntiPhishPolicy -Name "Research Quarantine" -AdminDisplayName "Research department policy" -EnableOrganizationDomainsProtection $true -EnableTargetedDomainsProtection $true -TargetedDomainsToProtect fabrikam.com -TargetedDomainProtectionAction Quarantine -EnableTargetedUserProtection $true -TargetedUsersToProtect "Mai Fujito;mfujito@fabrikam.com" -TargetedUserProtectionAction Quarantine -EnableMailboxIntelligenceProtection $true -MailboxIntelligenceProtectionAction Quarantine -EnableSimilarUsersSafetyTips $true -EnableSimilarDomainsSafetyTips $true -EnableUnusualCharactersSafetyTips $true +``` + +In Microsoft Defender for Office 365, this example creates and enables an antiphish policy named Research Quarantine with the following settings: + +- The description is: Research department policy. +- Enables organization domains protection for all accepted domains, and targeted domains protection for fabrikam.com. +- Specifies Mai Fujito (mfujito@fabrikam.com) as a user to protect from impersonation. +- Enables mailbox intelligence protection, and specifies the quarantine action. +- Enables impersonation safety tips (impersonated domains, impersonated users, and unusual characters). + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationFailAction +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcQuarantineAction +This setting is part of spoof protection. + +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: + +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. This is the default value. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcQuarantineAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcRejectAction +This setting is part of spoof protection. + +The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: + +- Quarantine: Deliver the message to quarantine. +- Reject: Reject the message. This is the default value. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcRejectAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter is reserved for internal Microsoft use. + +To create a disabled anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use `-Enabled $false` on the **New-AntiPhishRule** cmdlet. + +To enable or disable an existing anti-phishing policy, use the **Enable-AntiPhishRule** or **Disable-AntiPhishRule** cmdlets. + +In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing policy is enabled or disabled is visible in the State property. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFirstContactSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMailboxIntelligence +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMailboxIntelligenceProtection +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. + +This parameter is meaningful only if the EnableMailboxIntelligence parameter is set to the value $true. + +If you set this parameter to the value $false when the value of the EnableMailboxIntelligence parameter is $true, no action is taken on messages based on mailbox intelligence results (for example, lack of communication history). But, but mailbox intelligence can still help reduce impersonation false positives based on frequent contact information. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationDomainsProtection +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSimilarDomainsSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSimilarUsersSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpoofIntelligence +This setting is part of spoof protection. + +The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: + +- $true: Antispoofing is enabled for the policy. This is the default and recommended value. Use the \*-TenantAllowBlockListSpoofItems, Get-SpoofIntelligenceInsight, and Get-SpoofMailReport cmdlets to view and specify the spoofed senders to allow or block. +- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTargetedDomainsProtection +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTargetedUserProtection +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUnauthenticatedSender +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. +- $false: A question mark is never applied to the sender's photo. + +To prevent these identifiers from being added to messages from specific senders, you have the following options: + +- Allow the sender to spoof in the spoof intelligence policy. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUnusualCharactersSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableViaTag +This setting is part of spoof protection. + +The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: + +- $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This is the default value. +- $false: The via tag is not added to the From address. + +To prevent the via tag from being added to messages from specific senders, you have the following options: + +- Allow the sender to spoof. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedDomains +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. + +The maximum number of entries is approximately 1000. + +**Note**: Domain entries don't include subdomains of the specified domain. You need to add an entry for each subdomain. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSenders +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. + +The maximum number of entries is approximately 1000. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HonorDmarcPolicy +This setting is part of spoof protection. + +The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: + +- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This is the default value. +- $false: If the message fails DMARC, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImpersonationProtectionState +This setting is part of impersonation protection and is 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. +- Off + +```yaml +Type: ImpersonationProtectionState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxIntelligenceProtectionAction +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: + +- NoAction: This is the default value. Note that this value has the same result as setting the EnableMailboxIntelligenceProtection parameter to $false when the EnableMailboxIntelligence parameter is $true. +- BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. + +This parameter is meaningful only if the EnableMailboxIntelligence and EnableMailboxIntelligenceProtection parameters are set to the value $true. + +```yaml +Type: ImpersonationAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxIntelligenceProtectionActionRecipients +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. + +A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxIntelligenceQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by mailbox intelligence impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. + +The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishThresholdLevel +This setting is part of advanced settings and is 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. +- 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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimilarUsersSafetyTipsCustomText +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpoofQuarantineTag +The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by spoof intelligence protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainActionRecipients +This setting is part of impersonation protection and is 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. + +A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainProtectionAction +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: + +- NoAction: This is the default value. +- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by domain impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainsToProtect +This setting is part of impersonation protection and is 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. + +You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUserActionRecipients +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. + +A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUserProtectionAction +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: + +- NoAction: This is the default value. +- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUserQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by user impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUsersToProtect +This setting is part of impersonation protection and is 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. + +This parameter uses the syntax: "DisplayName;EmailAddress". + +- DisplayName specifies the display name of the user that could be a target of impersonation. This value can contain special characters. +- EmailAddress specifies the internal or external email address that's associated with the display name. +- You can specify multiple values by using the syntax: `"DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN"`. The combination of DisplayName and EmailAddress needs to be unique for each value. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnusualCharactersSafetyTipsCustomText +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/exchange/New-AntiPhishRule.md new file mode 100644 index 0000000000..79afcd0346 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AntiPhishRule.md @@ -0,0 +1,342 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-AntiPhishRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-AntiPhishRule cmdlet to create antiphish rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AntiPhishRule [-Name] -AntiPhishPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to add the antiphish rule to an existing policy by using the AntiPhishPolicy parameter. You create antiphish policies by using the New-AntiPhishPolicy cmdlet. + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Common policy settings](https://learn.microsoft.com/defender-office-365/anti-phishing-policies-about#common-policy-settings). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AntiPhishRule -Name "Research Department" -AntiPhishPolicy "Research Quarantine" -SentToMemberOf "Research Department" +``` + +This example creates an antiphish rule named Research Department with the following settings: + +- The rule is associated with the antiphish policy named Research Quarantine. +- The rule applies to members of the group named Research Department. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiPhishPolicy +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 +- Distinguished name (DN) +- GUID + +You can't specify the default antiphish policy. And, you can't specify an antiphish policy that's already associated with another antiphish rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. This is the default value. +- $false: The rule is disabled. + +In the properties of the rule, the value of this parameter is visible in the State property. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/exchange/New-App.md new file mode 100644 index 0000000000..12f88e9b57 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-App.md @@ -0,0 +1,680 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-App cmdlet to install apps for Outlook. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ExtensionOfficeMarketplace +``` +New-App [-Etoken ] [-MarketplaceCorrelationID ] [-MarketplaceAssetID ] [-MarketplaceQueryMarket ] [-MarketplaceServicesUrl ] [-MarketplaceUserProfileType ] + [-AddInOverrides ] + [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] + [-Confirm] + [-DefaultStateForUser ] + [-DomainController ] + [-DownloadOnly] + [-Enabled ] + [-Identity ] + [-Mailbox ] + [-OrganizationApp] + [-PrivateCatalog] + [-ProvidedTo ] + [-UpdateAppState] + [-UserList ] + [-Version ] + [-WhatIf] + [] +``` + +### ExtensionFileData +``` +New-App [-FileData ] + [-AddInOverrides ] + [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] + [-Confirm] + [-DefaultStateForUser ] + [-DomainController ] + [-DownloadOnly] + [-Enabled ] + [-Identity ] + [-Mailbox ] + [-OrganizationApp] + [-PrivateCatalog] + [-ProvidedTo ] + [-UpdateAppState] + [-UserList ] + [-Version ] + [-WhatIf] + [] +``` + +### ExtensionFileStream +``` +New-App [-FileStream ] + [-AddInOverrides ] + [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] + [-Confirm] + [-DefaultStateForUser ] + [-DomainController ] + [-DownloadOnly] + [-Enabled ] + [-Identity ] + [-Mailbox ] + [-OrganizationApp] + [-PrivateCatalog] + [-ProvidedTo ] + [-UpdateAppState] + [-UserList ] + [-Version ] + [-WhatIf] + [] +``` + +### ExtensionPrivateURL +``` +New-App [-Url ] + [-AddInOverrides ] + [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] + [-Confirm] + [-DefaultStateForUser ] + [-DomainController ] + [-DownloadOnly] + [-Enabled ] + [-Identity ] + [-Mailbox ] + [-OrganizationApp] + [-PrivateCatalog] + [-ProvidedTo ] + [-UpdateAppState] + [-UserList ] + [-Version ] + [-WhatIf] + [] +``` + +## DESCRIPTION +If the app is enabled for the entire organization, users can activate the new app when viewing mail or calendar items within Microsoft Outlook or Outlook on the web. If an installed app isn't enabled, users can enable the app from Outlook on the web Options. Similarly, administrators can enable installed apps from the Exchange admin center or by using the Enable-App or Set-App cmdlet. + +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +### Example 2 +```powershell +New-App -OrganizationApp -Url https://Server01.Contoso.com/apps/ContosoCRMApp/manifest.xml -ProvidedTo SpecificUsers -UserList "user1,user2,user3,user4,user5" -DefaultStateForUser Enabled +``` + +This example installs the Contoso CRM app manifest.xml from a URL on the Contoso corporate network. The Exchange server must be able to reach the target URL. This app is installed as an organization app,is made available to a specific list of users, and is enabled for those users by default. + +## PARAMETERS + +### -AddInOverrides +This parameter is available only in the cloud-based service. + +{{ Fill AddInOverrides Description }} + +```yaml +Type: AddInOverrides +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowReadWriteMailbox +The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSetting +This parameter is available only in the cloud-based service. + +{{ Fill AllowSetting Description }} + +```yaml +Type: AllowSetting +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppState +This parameter is available only in the cloud-based service. + +{{ Fill AppState Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppType +This parameter is available only in the cloud-based service. + +{{ Fill AppType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultStateForUser +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. +- AlwaysEnabled: The organization app is enabled and users can't disable it. + +You need to use the OrganizationApp switch when you use this parameter. + +```yaml +Type: DefaultStateForUser +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DownloadOnly +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etoken +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileData +The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the 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: ExtensionFileData +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileStream +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter is available only in the cloud-based service. + +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -MarketplaceAssetID +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceCorrelationID +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceQueryMarket +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceServicesUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceUserProfileType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationApp +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCatalog +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvidedTo +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. + +You use this parameter with the OrganizationApp switch. + +```yaml +Type: ClientExtensionProvidedTo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateAppState +This parameter is available only in the cloud-based service. + +{{ Fill UpdateAppState Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Url +The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. + +**Note**: URLs with redirections are not supported in Exchange Server 2016, Exchange Server 2019, and Exchange Online. Use a direct URL to the manifest. + +```yaml +Type: Uri +Parameter Sets: ExtensionPrivateURL +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserList +The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You use this parameter with the OrganizationApp switch. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +This parameter is available only in the cloud-based service. + +{{ Fill Version Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..669e94235e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -0,0 +1,398 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancepolicy +applicable: Security & Compliance +title: New-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AppRetentionCompliancePolicy to create app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AdaptiveScopeLocation +``` +New-AppRetentionCompliancePolicy [-Name] -AdaptiveScopeLocation -Applications + [-Confirm] + [-Comment ] + [-Enabled ] + [-Force] + [-RestrictiveRetention ] + [-WhatIf] + [] +``` + +### Default +``` +New-AppRetentionCompliancePolicy [-Name] -Applications + [-Comment ] + [-Confirm] + [-Enabled ] + [-ExchangeLocation ] + [-ExchangeLocationException ] + [-Force] + [-ModernGroupLocation ] + [-ModernGroupLocationException ] + [-PolicyRBACScopes ] + [-RestrictiveRetention ] + [-WhatIf] + [] +``` + +## DESCRIPTION +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies in the locations described in [Retention cmdlets for newer locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-newer-locations). You can only set the list of included or excluded scopes for all included workloads, which means you likely need to create one policy per workload. + +\*-RetentionCompliance\* cmdlets continue to primarily support the locations described in [Retention cmdlets for older locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-older-locations). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AppRetentionCompliancePolicy -Name "Regulation 567 Compliance" -Applications "User:MicrosoftTeams,VivaEngage","Group:MicrosoftTeams,VivaEngage" -ExchangeLocation "Jennifer Petersen","Kitty Nakamura" +``` + +This example creates a static scope retention policy named Regulation 567 Compliance for the Viva Engage user messages of Jennifer Petersen and Kitty Nakamura. + +After you create the retention policy, use the New-AppRetentionComplianceRule cmdlet to create a retention rule and assign it the retention policy to it. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the app retention compliance policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdaptiveScopeLocation +The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Applications +The Applications parameter specifies the applications to include in the policy. + +This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: + +`LocationType` is User or Group. + +`App` is a supported value as shown in the following examples. + +- **Microsoft 365 apps**: For example: + + `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"` + +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the policy. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). +- The value All for all mailboxes. You can only use this value by itself. + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocationException +The ExchangeLocationException parameter specifies the mailboxes exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocation +The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: + +- A Microsoft 365 Group +- The value All for all Microsoft 365 Groups. You can only use this value by itself. + +To identify the Microsoft 365 Group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocationException +The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictiveRetention +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: + +- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. +- $false: Preservation Lock isn't enabled for the policy. This is the default value. + +After a policy has been locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. + +Therefore, before you lock a policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..9cf40c975c --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancerule +applicable: Security & Compliance +title: New-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AppRetentionComplianceRule to create app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-AppRetentionComplianceRule [-Name] -Policy + [-Comment ] + [-Confirm] + [-ContentMatchQuery ] + [-ExcludedItemClasses ] + [-ExpirationDateOption ] + [-RetentionComplianceAction ] + [-RetentionDuration ] + [-RetentionDurationDisplayHint ] + [-WhatIf] + [] +``` + +### ComplianceTag +``` +New-AppRetentionComplianceRule -Policy + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentMatchQuery ] + [-ExpirationDateOption ] + [-MachineLearningModelIDs ] + [-RetentionComplianceAction ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AppRetentionComplianceRule -Name RetUnlimited -Policy "Regulation 567 Compliance" -RetentionDuration Unlimited +``` + +This example creates a new retention rule named RetUnlimited and adds it to the retention policy named Regulation 567 Compliance. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the app retention compliance rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter specifies the app retention compliance policy that contains the app retention compliance policy rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: Default, ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedItemClasses +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +- IPM.Note.Microsoft.Conversation +- IPM.Note.Microsoft.Conversation.Voice +- IPM.Note.Microsoft.Missed +- IPM.Note.Microsoft.Missed.Voice +- IPM.Note.Microsoft.Voicemail +- IPM.Note.Microsoft.VoiceMessage.UA +- IPM.Note.Microsoft.Voicemail.UM +- IPM.Note.Microsoft.Voicemail.UM.CA + +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. + +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateOption +The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: + +- CreationAgeInDays +- ModificationAgeInDays + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineLearningModelIDs +{{ Fill MachineLearningModelIDs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionComplianceAction +The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDurationDisplayHint +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. + +- Days +- Months +- Years + +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. + +```yaml +Type: HoldDurationHint +Parameter Sets: Default +Aliases: +Accepted values: Days, Months, Years +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md new file mode 100644 index 0000000000..3a8139e536 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md @@ -0,0 +1,228 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ApplicationAccessPolicy + +## 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). + +## SYNTAX +``` +New-ApplicationAccessPolicy -AccessRight -AppId -PolicyScopeGroupId + [-Confirm] + [-Description ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +You can create a limited number of policies in your organization based on a fixed amount of space. If your organization runs out of space for these policies, you'll see the error: "The total size of App Access Policies exceeded the limit." To maximize the number of policies and reduce the amount of space that's consumed by the policies, set a one space character description for the policy. This method will allow approximately 300 policies (versus a previous limit of 100 policies). + +While scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read email or events within a mailbox and not do anything else, application access policies allow admins to enforce limits that are based on a list of mailboxes. For example, apps developed for one country/region shouldn't have access to data from other countries/regions. Or, or a CRM integration application should only access calendars in the Sales organization and no other departments. + +Every API request using the Outlook REST APIs or Microsoft Graph APIs to a target mailbox done by an application is verified using the following rules (in the same order): + +1. If there are multiple application access policies for the same Application and Target Mailbox pair, DenyAccess policy is prioritized over a RestrictAccess policy. +2. If a DenyAccess policy exists for the Application and Target Mailbox, then the app's access request is denied (even if there exists a RestrictAccess policy). +3. If there are any RestrictAccess policies that match the Application and Target Mailbox, then the app is granted access. +4. If there are any Restrict policies for the Application, and the Target Mailbox is not a member of those policies, then application is denied access to the target mailbox. +5. If none of the above conditions are met, then the application is granted access to the requested target mailbox. + +## EXAMPLES + +### Example 1 +```powershell +New-ApplicationAccessPolicy -AccessRight DenyAccess -AppId "3dbc2ae1-7198-45ed-9f9f-d86ba3ec35b5", "6ac794ca-2697-4137-8754-d2a78ae47d93" -PolicyScopeGroupId "Engineering Staff" -Description "Engineering Group Policy" +``` + +This example creates a new application access policy with the following settings: + +- AccessRight: DenyAccess +- AppIDs: 3dbc2ae1-7198-45ed-9f9f-d86ba3ec35b5 and 6ac794ca-2697-4137-8754-d2a78ae47d93 +- PolicyScopeGroupId: Engineering Staff +- Description: Engineering Group Policy + +### Example 2 +```powershell +New-ApplicationAccessPolicy -AccessRight RestrictAccess -AppId "e7e4dbfc-046f-4074-9b3b-2ae8f144f59b" -PolicyScopeGroupId EvenUsers@AppPolicyTest2.com -Description "Restrict this app's access to members of security group EvenUsers." +``` + +This example creates a new application access policy with the following settings: + +- AccessRight: RestrictAccess +- AppIDs: e7e4dbfc-046f-4074-9b3b-2ae8f144f59b +- PolicyScopeGroupId: EvenUsers@AppPolicyTest2.com +- Description: Restrict this app's access to members of security group EvenUsers. + +### Example 3 +```powershell +New-ApplicationAccessPolicy -AccessRight DenyAccess -AppId "e7e4dbfc-046f-4074-9b3b-2ae8f144f59b" -PolicyScopeGroupId OddUsers@AppPolicyTest2.com -Description "Deny this app access to members of security group OddUsers." +``` + +This example creates a new application access policy with the following settings: + +- AccessRight: DenyAccess +- AppIDs: e7e4dbfc-046f-4074-9b3b-2ae8f144f59b +- PolicyScopeGroupId: OddUsers@AppPolicyTest2.com +- Description: Deny this app access to members of security group OddUsers. + +## PARAMETERS + +### -AccessRight +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. +- DenyAccess: Allows the associated app to only access data that's not associated with mailboxes specified by the PolicyScopeGroupID parameter. + +```yaml +Type: ApplicationAccessPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppId +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. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PolicyScopeGroupID +The PolicyScopeGroupID parameter specifies the recipient to define in the policy. Valid recipient types are security principals in Exchange Online (users or groups, including nested groups, that can have permissions assigned to them). For example: + +- Mailboxes with associated user accounts (UserMailbox) +- Mail users, also known as mail-enabled users (MailUser) +- Mail-enabled security groups (MailUniversalSecurityGroup) + +You can use any value that uniquely identifies the recipient. For example: + +- Name +- Distinguished name (DN) +- Display name +- Email address +- GUID + +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: + +- Discovery mailboxes (DiscoveryMailbox) +- Dynamic distribution groups (DynamicDistributionGroup) +- Distribution groups (MailUniversalDistributionGroup) +- Mail contacts (MailContact) +- Mail-enabled public folders (PublicFolder) +- Microsoft 365 Groups (GroupMailbox) +- Resource mailboxes (RoomMailbox or EquipmentMailbox) +- Shared mailboxes (SharedMailbox) + +If you need to scope the policy to shared mailboxes, you can add the shared mailboxes as members of a mail-enabled security group. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AuthRedirect.md b/exchange/exchange-ps/exchange/New-AuthRedirect.md new file mode 100644 index 0000000000..d885bf6957 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AuthRedirect.md @@ -0,0 +1,148 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AuthRedirect + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-AuthRedirect cmdlet to create OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AuthRedirect -AuthScheme -TargetUrl + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-AuthRedirect -AuthScheme Bearer -TargetURL https://mbx01.contoso.com +``` + +This example creates an OAuth redirection object with the following settings: + +- AuthScheme: Bearer +- TargetURL: `https://mbx01.contoso.com` + +## PARAMETERS + +### -AuthScheme +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -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/New-AuthServer.md b/exchange/exchange-ps/exchange/New-AuthServer.md new file mode 100644 index 0000000000..5837e8cdb9 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AuthServer.md @@ -0,0 +1,266 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AuthServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-AuthServer cmdlet to create an authorization server object in Microsoft Exchange and specify its AuthMetadataUrl. Exchange honors tokens issued by the authorization server for access by a partner application. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AuthMetadataUrl +``` +New-AuthServer [-Name] -AuthMetadataUrl + [-TrustAnySSLCertificate] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-WhatIf] + [] +``` + +### NativeClientAuthServer +``` +New-AuthServer [-Name] -AuthMetadataUrl -Type + [-TrustAnySSLCertificate] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-WhatIf] + [] +``` + +### AppSecret +``` +New-AuthServer [-Name] -Type + [-ApplicationIdentifier ] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-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 need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AuthServer -Name WindowsAzureACS -AuthMetadataUrl https://accounts.accesscontrol.windows.net/contoso.onmicrosoft.com/metadata/json/1 +``` + +This command creates an authorization server object with the specified settings. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthMetadataUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Type parameter specifies the type of authorization tokens that are issued by the authorization server. Valid values are: + +- ADFS +- AzureAD +- Facebook +- LinkedIn +- MicrosoftACS + +```yaml +Type: AuthServerType +Parameter Sets: NativeClientAuthServer, AppSecret +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationIdentifier +This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchange 2019 CU15 and Exchange 2016 CU23. + +{{ Fill ApplicationIdentifier Description }} + +```yaml +Type: String +Parameter Sets: AppSecret +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +{{ Fill DomainName Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the authorization server is enabled. Valid values are: + +- $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value +- $false: Authorization tokens that are issued by the authorization server are not accepted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustAnySSLCertificate +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +We don't recommend using this switch in a production environment. + +```yaml +Type: SwitchParameter +Parameter Sets: AuthMetadataUrl, NativeClientAuthServer +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 +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/New-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md new file mode 100644 index 0000000000..4c06f72d1a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md @@ -0,0 +1,731 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-AuthenticationPolicy cmdlet to create authentication policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AuthenticationPolicy [[-Name] ] + [-AllowBasicAuthActiveSync] + [-AllowBasicAuthAutodiscover] + [-AllowBasicAuthImap] + [-AllowBasicAuthMapi] + [-AllowBasicAuthOfflineAddressBook] + [-AllowBasicAuthOutlookService] + [-AllowBasicAuthPop] + [-AllowBasicAuthPowershell] + [-AllowBasicAuthReportingWebServices] + [-AllowBasicAuthRpc] + [-AllowBasicAuthSmtp] + [-AllowBasicAuthWebServices] + [-BlockLegacyAuthActiveSync] + [-BlockLegacyAuthAutodiscover] + [-BlockLegacyAuthImap] + [-BlockLegacyAuthMapi] + [-BlockLegacyAuthOfflineAddressBook] + [-BlockLegacyAuthPop] + [-BlockLegacyAuthRpc] + [-BlockLegacyAuthWebServices] + [-BlockModernAuthActiveSync] + [-BlockModernAuthAutodiscover] + [-BlockModernAuthImap] + [-BlockModernAuthMapi] + [-BlockModernAuthOfflineAddressBook] + [-BlockModernAuthPop] + [-BlockModernAuthRpc] + [-BlockModernAuthWebServices] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AuthenticationPolicy -Name "Engineering Group" -AllowBasicAuthImap +``` + +In Exchange Online, this example creates a new authentication policy named Engineering Group that allows Basic authentication with IMAP. + +### Example 2 +```powershell +New-AuthenticationPolicy -Name "Research and Development Group" -BlockLegacyAuthActiveSync -BlockLegacyAuthAutodiscover -BlockLegacyAuthImap -BlockLegacyAuthMapi -BlockLegacyAuthOfflineAddressBook -BlockLegacyAuthPop -BlockLegacyAuthRpc -BlockLegacyAuthWebServices +``` + +In Exchange 2019, this example creates a new authentication policy named Research and Development Group that blocks legacy authentication for the specified protocols. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthActiveSync +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthAutodiscover +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthImap +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthMapi +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthOfflineAddressBook +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthOutlookService +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthPop +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthPowershell +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthReportingWebServices +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthRpc +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthSmtp +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthWebServices +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. + +By default, Basic authentication is blocked for the protocol. Use this switch to allow Basic authentication for the protocol. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthActiveSync +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. + +This switch disables the following legacy authentication methods with Exchange ActiveSync: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthAutodiscover +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. + +This switch disables the following legacy authentication methods with Autodiscover: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthImap +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. + +This switch disables the following legacy authentication methods with IMAP: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthMapi +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. + +This switch disables the following legacy authentication methods with MAPI: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthOfflineAddressBook +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. + +This switch disables the following legacy authentication methods with Offline Address Books: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthPop +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. + +This switch disables the following legacy authentication methods with POP: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthRpc +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. + +This switch disables the following legacy authentication methods with RPC: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthWebServices +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. + +This switch disables the following legacy authentication methods with EWS: + +- Basic authentication +- Digest authentication +- Windows authentication (NTLM and Kerberos) + +Before you disable the legacy authentication methods for this protocol, verify that hybrid modern authentication is enabled and working in your Exchange hybrid environment, and that your email clients support modern authentication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthActiveSync +This parameter is available only in on-premises Exchange. + +The BlockModernAuthActiveSync switch specifies whether to block modern authentication with Exchange ActiveSync in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthAutodiscover +This parameter is available only in on-premises Exchange. + +The BlockModernAuthAutodiscover switch specifies whether to block modern authentication with Autodiscover in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthImap +This parameter is available only in on-premises Exchange. + +The BlockModernAuthImap switch specifies whether to block modern authentication with IMAP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthMapi +This parameter is available only in on-premises Exchange. + +The BlockModernAuthMapi switch specifies whether to block modern authentication with MAPI in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthOfflineAddressBook +This parameter is available only in on-premises Exchange. + +The BlockModernAuthOfflineAddressBook switch specifies whether to block modern authentication with Offline Address Books in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthPop +This parameter is available only in on-premises Exchange. + +The BlockModernAuthPop switch specifies whether to block modern authentication with POP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthRpc +This parameter is available only in on-premises Exchange. + +The BlockModernAuthRpc switch specifies whether to block modern authentication with RPC in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthWebServices +This parameter is available only in on-premises Exchange. + +The BlockModernAuthWebServices switch specifies whether to block modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md new file mode 100644 index 0000000000..41c5654713 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md @@ -0,0 +1,692 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-AutoSensitivityLabelPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policies in your organization. Create auto-labeling policy rules using the New-AutoSensitivityLabelRule cmdlet and associate them with the policy to complete the policy creation. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel + [-Comment ] + [-Confirm] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] + [-ExchangeLocation ] + [-ExchangeSender ] + [-ExchangeSenderException ] + [-ExchangeSenderMemberOf ] + [-ExchangeSenderMemberOfException ] + [-ExternalMailRightsManagementOwner ] + [-Force] + [-Locations ] + [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] + [-OneDriveLocation ] + [-OneDriveLocationException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] + [-OverwriteLabel ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-Priority ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-SharePointLocation ] + [-SharePointLocationException ] + [-UnifiedAuditLogEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-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 and OneDrive locations with the label "Test". The new policy has a descriptive comment and will be in simulation mode on creation. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplySensitivityLabel +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedBy +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedByMemberOf +{{ Fill ExceptIfOneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies whether to include email messages in the policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). + +You can use this parameter in the following procedures: + +- If you use `-ExchangeLocation All` by itself, the policy applies to email for all internal users. + +- To include email of specific internal or external users in the policy, use `-ExchangeLocation All` with the ExchangeSender parameter in the same command. Only email of the specified users is included in the policy. + +- To include only email of specific group members in the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific internal users from the policy, use `-ExchangeLocation All` with the ExchangeSenderException parameter in the same command. Only email of the specified users is excluded from the policy. + +- To exclude only email of specific group members from the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSender +The ExchangeSender parameter specifies the users whose email is included in the policy. You identify the users by email address. You can specify internal or external email addresses. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderException +The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOf +The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOfException +The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMailRightsManagementOwner +The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. + +This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +{{ Fill Locations Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: + +- Enable: The policy is enabled for actions and notifications. This is the default value. +- Disable: The policy is disabled. +- TestWithNotifications: No actions are taken, but notifications are sent. +- TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent. + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocation +The OneDriveLocation parameter specifies the OneDrive sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocationException +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"`. + +```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 +``` + +### -OneDriveSharedBy +The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedByMemberOf +{{ Fill OneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteLabel +The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: + +- $true: Overwrite the manual label. +- $false: Don't overwrite the manual label. This is the default value. + +This parameter works only on Exchange locations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +The SharePointLocation parameter specifies the SharePoint 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocationException +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"`. + +```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 +``` + +### -UnifiedAuditLogEnabled +{{ Fill UnifiedAuditLogEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md new file mode 100644 index 0000000000..43a5384ec8 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -0,0 +1,1281 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-AutoSensitivityLabelRule + +## 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-AutoSensitivityLabelRule cmdlet to create auto-labeling rules and associate then with auto-labeling policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AutoSensitivityLabelRule [-Name] -Policy -Workload + [-AccessScope ] + [-ActivationDate ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-Comment ] + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentExtensionMatchesWords ] + [-ContentPropertyContainsWords ] + [-Disabled ] + [-DocumentCreatedBy ] + [-DocumentIsPasswordProtected ] + [-DocumentIsUnsupported ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] + [-ExceptIfAccessScope ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfContentContainsSensitiveInformation ] + [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentCreatedBy ] + [-ExceptIfDocumentIsPasswordProtected ] + [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfProcessingLimitExceeded ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderIPRanges ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExpiryDate ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] + [-HeaderMatchesPatterns ] + [-ImmutableId ] + [-Priority ] + [-ProcessingLimitExceeded ] + [-RecipientDomainIs ] + [-ReportSeverityLevel ] + [-RuleErrorAction ] + [-SenderDomainIs ] + [-SenderIPRanges ] + [-SentTo ] + [-SentToMemberOf ] + [-SourceType ] + [-SubjectMatchesPatterns ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-AutoSensitivityLabelRule -Name "SocialSecurityRule" -Policy "SSNPolicy" -ContentContainsSensitiveInformation @{"name"="U.S. Social Security Number (SSN)";"mincount"="1"} -Workload SharePoint +``` + +This example creates an autolabeling rule named "SocialSecurityRule" that is assigned to the policy "SSNPolicy." This rule looks for Social Security Numbers on documents with a minimum count of 1 on SharePoint sites. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter specifies the workload. Valid values are: + +- Exchange +- OneDriveForBusiness +- SharePoint + +```yaml +Type: Workload +Parameter Sets: (All) +Aliases: +Accepted values: Exchange, SharePoint, OneDriveForBusiness +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessScope +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. +- NotInOrganization: The rule is applied to content that's accessible outside the organization. +- None: The condition isn't used. + +```yaml +Type: AccessScope +Parameter Sets: (All) +Aliases: +Accepted values: InOrganization, NotInOrganization, None +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivationDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentExtensionMatchesWords +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPropertyContainsWords +The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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. + +```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 +``` + +### -DocumentCreatedBy +{{ Fill DocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsPasswordProtected +The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsUnsupported +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. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentNameMatchesWords +The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentSizeOver +The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAccessScope +The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: + +- InOrganization: The rule isn't applied to content that's accessible inside the organization. +- NotInOrganization: The rule isn't applied to content that's accessible outside the organization. +- None: The exception isn't used. + +```yaml +Type: AccessScope +Parameter Sets: (All) +Aliases: +Accepted values: InOrganization, NotInOrganization, None +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentContainsSensitiveInformation +The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentExtensionMatchesWords +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedBy +{{ Fill ExceptIfDocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsPasswordProtected +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsUnsupported +The ExceptIfDocumentIsUnsupported parameter specifies an exception for the 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. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +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"`. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfProcessingLimitExceeded +The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: + +- $true: Look for files where scanning couldn't complete. +- $false: Don't look for files where scanning couldn't complete. + +```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 +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderIPRanges +The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutableId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingLimitExceeded +The ProcessingLimitExceeded parameter specifies a condition for the 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. +- $false: Don't look for files where scanning couldn't complete. + +```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 +``` + +### -RecipientDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSeverityLevel +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. +- Medium +- High + +```yaml +Type: RuleSeverity +Parameter Sets: (All) +Aliases: +Accepted values: Low, Medium, High, None, Informational, Information +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: + +- Ignore +- RetryThenBlock +- Blank (the value $null): This is the default value. + +```yaml +Type: PolicyRuleErrorAction +Parameter Sets: (All) +Aliases: +Accepted values: Ignore, RetryThenBlock +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIPRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use this condition in auto-sensitivity policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +{{ Fill SourceType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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/client-access-servers/New-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/client-access-servers/New-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md index b8c33da3b2..d79e23f643 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-AutodiscoverVirtualDirectory @@ -13,18 +16,30 @@ This cmdlet is available only in on-premises Exchange. Use the New-AutodiscoverVirtualDirectory cmdlet to create Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AutodiscoverVirtualDirectory [-ApplicationRoot ] [-AppPoolId ] - [-BasicAuthentication <$true | $false>] [-Confirm] [-DigestAuthentication <$true | $false>] - [-DomainController ] [-ExtendedProtectionFlags ] - [-ExtendedProtectionSPNList ] [-ExtendedProtectionTokenChecking ] - [-ExternalUrl ] [-InternalUrl ] [-Path ] [-WebSiteName ] [-WhatIf] - [-WindowsAuthentication <$true | $false>] [-WSSecurityAuthentication <$true | $false>] - [-OAuthAuthentication <$true | $false>] [-Role ] [-Server ] +New-AutodiscoverVirtualDirectory [-ApplicationRoot ] + [-AppPoolId ] + [-BasicAuthentication ] + [-Confirm] + [-DigestAuthentication ] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-InternalUrl ] + [-OAuthAuthentication ] + [-Path ] + [-Role ] + [-Server ] + [-WebSiteName ] + [-WhatIf] + [-WindowsAuthentication ] + [-WSSecurityAuthentication ] [] ``` @@ -33,12 +48,12 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-AutodiscoverVirtualDirectory -WebSiteName "autodiscover.contoso.com" -WindowsAuthentication $true -DigestAuthentication $true ``` @@ -54,6 +69,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -69,6 +85,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -80,14 +97,14 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -98,8 +115,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -107,6 +123,7 @@ 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 @@ -118,14 +135,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,6 +158,7 @@ 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 @@ -152,13 +170,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -166,6 +180,7 @@ 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 @@ -177,14 +192,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -196,20 +211,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -218,7 +230,7 @@ Accept wildcard characters: False ``` ### -ExternalUrl -This parameter is available or functional only in 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. @@ -227,6 +239,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -235,7 +248,7 @@ Accept wildcard characters: False ``` ### -InternalUrl -This parameter is available or functional only in 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. @@ -244,6 +257,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -251,14 +265,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Path -The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. +### -OAuthAuthentication +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. +- $false: OAuth authentication is disabled. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -266,14 +284,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebSiteName -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. +### -Path +The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -281,14 +300,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -Role +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. +- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. + +Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. ```yaml -Type: SwitchParameter +Type: VirtualDirectoryRole Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -296,37 +321,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WindowsAuthentication -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. +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: -- $false: Integrated Windows authentication is disabled. +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml -Type: $true | $false +Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -WSSecurityAuthentication -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. - -- $false: WS-Security authentication is disabled. +### -WebSiteName +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: $true | $false +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -334,18 +358,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OAuthAuthentication -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. - -- $false: OAuth authentication is disabled. +### -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: $true | $false +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -353,20 +374,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Role -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. - -- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. +### -WindowsAuthentication +The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. +- $true: Integrated Windows authentication is enabled. This is the default value. +- $false: Integrated Windows authentication is disabled. ```yaml -Type: ClientAccess | Mailbox +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -374,44 +393,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) +### -WSSecurityAuthentication +The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: -- ExchangeLegacyDN +- $true: WS-Security authentication is enabled. This is the default value. +- $false: WS-Security authentication is disabled. ```yaml -Type: ServerIdParameter +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None -Accept pipeline input: 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/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a0e22a98-2cc1-460b-870e-bf492cda54b4.aspx) diff --git a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md new file mode 100644 index 0000000000..7019d149b7 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md @@ -0,0 +1,128 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-AvailabilityConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-AvailabilityConfig cmdlet to create the availability configuration that specifies the Microsoft 365 organizations to exchange free/busy information with. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-AvailabilityConfig + [-AllowedTenantIds ] + [-Confirm] + [-OrgWideAccount ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AvailabilityConfig -AllowedTenantIds "d6b0a40e-029b-43f2-9852-f3724f68ead9","87d5bade-cefc-4067-a221-794aea71922d" +``` + +This example creates a new availability configuration to share free/busy information with the specified Microsoft 365 organizations. + +## PARAMETERS + +### -AllowedTenantIds +The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrgWideAccount +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/New-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md similarity index 76% rename from exchange/exchange-ps/exchange/server-health-and-performance/New-AvailabilityReportOutage.md rename to exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md index b20863e25c..4c31737bf7 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/New-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-AvailabilityReportOutage @@ -13,23 +16,27 @@ This cmdlet is available only in Exchange Server 2010. Use the New-AvailabilityReportOutage cmdlet to create an outage to add unrecorded issues to availability reporting. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AvailabilityReportOutage [-SiteName] -Comment -DowntimeMinutes - -ReportDate [-Confirm] [-Force] [-ReportingDatabase ] [-ReportingServer ] [-WhatIf] +New-AvailabilityReportOutage [-SiteName] -Comment -DowntimeMinutes -ReportDate + [-Confirm] + [-Force] + [-ReportingDatabase ] + [-ReportingServer ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-AvailabilityReportOutage -ReportDate:"2009-12-02" -Site:"Site1" -DowntimeMinutes:120 -Comment:"Downtime not recorded by System Center Operations Manager 2007" ``` @@ -37,29 +44,31 @@ This example creates a timed injected outage scoped to site Site1 on the selecte ## PARAMETERS -### -Comment -The Comment parameter specifies why the outage was inserted. +### -SiteName +The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DowntimeMinutes -The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. +### -Comment +The Comment parameter specifies why the outage was inserted. ```yaml -Type: Double +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -67,14 +76,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportDate -The ReportDate parameter specifies the date to query for the outage report. +### -DowntimeMinutes +The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. ```yaml -Type: ExDateTime +Type: Double Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -82,16 +92,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteName -The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. +### -ReportDate +The ReportDate parameter specifies the date to query for the outage report. ```yaml -Type: String +Type: ExDateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -100,8 +111,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -109,6 +119,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -117,13 +128,16 @@ Accept wildcard characters: False ``` ### -Force -The Force parameter suppresses the warning or confirmation messages that appear during specific configuration changes. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -139,6 +153,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -154,6 +169,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -169,6 +185,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -177,20 +194,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2383aa16-5993-4555-8ab8-9a09eea2d8e9.aspx) diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md new file mode 100644 index 0000000000..87605314fc --- /dev/null +++ b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md @@ -0,0 +1,256 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-CaseHoldPolicy + +## 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-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**. +> +> Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to create multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-CaseHoldPolicy [-Name] -Case + [-Comment ] + [-Confirm] + [-Enabled ] + [-ExchangeLocation ] + [-Force] + [-PublicFolderLocation ] + [-SharePointLocation ] + [-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-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 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 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Case +The Case parameter specifies the eDiscovery case that you want to associate with the case hold policy. You can use the following values to identify the eDiscovery case: + +- Name +- Identity (GUID value). + +You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use the following values: + +- Name +- SMTP address. To specify an inactive mailbox, precede the address with a period (.). +- Microsoft Entra ObjectId. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) or [Get-MgGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.groups/get-mggroup) cmdlets in Microsoft Graph PowerShell to find this value. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If no mailboxes are specified, then no mailboxes are placed on hold. + +```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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +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"`. + +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 +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-CaseHoldRule.md b/exchange/exchange-ps/exchange/New-CaseHoldRule.md new file mode 100644 index 0000000000..c169c5dfff --- /dev/null +++ b/exchange/exchange-ps/exchange/New-CaseHoldRule.md @@ -0,0 +1,189 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-CaseHoldRule + +## 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-CaseHoldRule cmdlet to create new case hold rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-CaseHoldRule [-Name] -Policy + [-Comment ] + [-Confirm] + [-ContentMatchQuery ] + [-Disabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to add the case hold rule to an existing case hold policy using the Policy parameter. Only one rule can be added to each case hold policy. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-CaseHoldRule -Name "2016 Budget Spreadsheets" -Policy "Internal Company Policy" -ContentMatchQuery "filename:2016 budget filetype:xlsx" +``` + +This example creates a new case hold rule named 2016 Budget Spreadsheets and adds it to the existing case hold policy named "Internal Company Policy". The rule applies to Excel worksheets that contain the phrase 2016 budget, such as "2016 budget planning.xlsx" and "2016 budget review.xlsx" + +### Example 2 +```powershell +New-CaseHoldRule -Name "Contoso Case 07172018 Hold 1" -Policy "Contoso Case 07172018" -ContentMatchQuery "received:12/01/2017..12/31/2018" +``` + +This example places email messages received by the recipients between December 1, 2018 and December 31, 2018 on hold. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (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 +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. Use this parameter to create a query-based hold so only the content that matches the specified search query is placed on hold. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md new file mode 100644 index 0000000000..2f589a0ceb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-ClassificationRuleCollection cmdlet to import new classification rule collections into your organization. + +In tSecurity & Compliance PowerShell, use the New-DlpSensitiveInformationTypeRulePackage cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ClassificationRuleCollection [-FileData] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ClassificationRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Classification Rule Collection.xml')) +``` + +This example imports the classification rule collection file C:\\My Documents\\External Classification Rule Collection.xml. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the classification rule collection file you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access-servers/New-ClientAccessArray.md b/exchange/exchange-ps/exchange/New-ClientAccessArray.md similarity index 81% rename from exchange/exchange-ps/exchange/client-access-servers/New-ClientAccessArray.md rename to exchange/exchange-ps/exchange/New-ClientAccessArray.md index c040b269e4..93bc940c38 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessArray.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ClientAccessArray @@ -13,13 +16,16 @@ This cmdlet is available only in Exchange Server 2010. Use the New-ClientAccessArray cmdlet to create an object that represents a load balanced array of Client Access servers within a single Active Directory site. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ClientAccessArray [[-Name] ] -Fqdn -Site [-Confirm] - [-DomainController ] [-WhatIf] [] +New-ClientAccessArray [[-Name] ] -Fqdn -Site + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,19 +33,19 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ClientAccessArray -Fqdn casarray01.contoso.com -Site "Redmond" ``` This example creates the Client Access array with the FQDN casarray01.contoso.com in the Active Directory site named Redmond. Because the Name parameter isn't used, the name of the Client Access array is casarray01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-ClientAccessArray -Fqdn casarrayap.contoso.com -Site "China" -Name "China CAS Array" ``` @@ -47,6 +53,24 @@ This example creates a Client Access array named China CAS Array with the FQDN v ## PARAMETERS +### -Name +The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. + +If you don't use this parameter, the default value is the host part of the Fqdn parameter value. For example, if the Fqdn value is casarray01.contoso.com, the default name value is casarray01. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Fqdn The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers in the array. @@ -55,6 +79,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -63,12 +88,10 @@ Accept wildcard characters: False ``` ### -Site -The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: +The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name - - Distinguished name (DN) - - GUID To see a list of available sites, use the Get-ADSite cmdlet. @@ -78,6 +101,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -88,8 +112,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -97,6 +120,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -112,25 +136,9 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. -If you don't use this parameter, the default value is the host part of the Fqdn parameter value. For example, if the Fqdn value is casarray01.contoso.com, the default name value is casarray01. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -144,6 +152,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -152,20 +161,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cc0a1328-5931-4160-8310-76f17b54d074.aspx) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md new file mode 100644 index 0000000000..af5e934438 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -0,0 +1,585 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ClientAccessRule + +## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ClientAccessRule [-Name] -Action + [-AnyOfAuthenticationTypes ] + [-AnyOfClientIPAddressesOrRanges ] + [-AnyOfProtocols ] + [-AnyOfSourceTcpPortNumbers ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExceptAnyOfAuthenticationTypes ] + [-ExceptAnyOfClientIPAddressesOrRanges ] + [-ExceptAnyOfProtocols ] + [-ExceptAnyOfSourceTcpPortNumbers ] + [-ExceptUserIsMemberOf ] + [-ExceptUsernameMatchesAnyOfPatterns ] + [-Priority ] + [-Scope ] + [-UserIsMemberOf ] + [-UsernameMatchesAnyOfPatterns ] + [-UserRecipientFilter ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. + +**Note**: Not all protocols support authentication type filters, and even protocols that support authentication type filters don't support all authentication types. The supported combinations are described in the following lists. Use caution when mixing protocols and authentication types in the same rule. + +Protocols that support authentication type filters: + +- ExchangeActiveSync: BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. +- ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. +- IMAP4: BasicAuthentication and OAuthAuthentication. +- OutlookWebApp: BasicAuthentication and AdfsAuthentication. +- POP3: BasicAuthentication and OAuthAuthentication. +- RemotePowerShell: BasicAuthentication and NonBasicAuthentication. + +Protocols that don't support authentication type filters: + +- ExchangeWebServices +- OfflineAddressBook +- OutlookAnywhere +- PowerShellWebServices +- REST +- UniversalOutlook + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +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). + +### Example 2 +```powershell +New-ClientAccessRule -Name "Block ActiveSync" -Action DenyAccess -AnyOfProtocols ExchangeActiveSync -ExceptAnyOfClientIPAddressesOrRanges 192.168.10.1/24 +``` + +This example creates a new client access rule named Block ActiveSync that blocks access for Exchange ActiveSync clients, except for clients in the IP address range 192.168.10.1/24. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfAuthenticationTypes +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. + +Valid values for this parameter are: + +- AdfsAuthentication +- BasicAuthentication +- CertificateBasedAuthentication +- NonBasicAuthentication +- OAuthAuthentication + +You can enter multiple values separated by commas. Don't use quotation marks. + +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfClientIPAddressesOrRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254 or 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414. +- Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:DB8::2AA:FF:C0A8:640A/64. + +You can enter multiple values separated by commas. + +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfProtocols +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: + +- ExchangeActiveSync +- ExchangeAdminCenter +- ExchangeWebServices +- IMAP4 +- OfflineAddressBook +- OutlookAnywhere +- OutlookWebApp +- POP3 +- PowerShellWebServices +- RemotePowerShell +- REST +- UniversalOutlook (Mail and Calendar app) + +**Note**: In Exchange 2019, the only supported values are ExchangeAdminCenter and RemotePowerShell. + +You can enter multiple values separated by commas. Don't use quotation marks. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfSourceTcpPortNumbers +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfAuthenticationTypes +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. + +Valid values for this parameter are: + +- AdfsAuthentication +- BasicAuthentication +- CertificateBasedAuthentication +- NonBasicAuthentication +- OAuthAuthentication + +You can enter multiple values separated by commas. Don't use quotation marks. + +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfClientIPAddressesOrRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254 or 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414. +- Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:DB8::2AA:FF:C0A8:640A/64. + +You can enter multiple values separated by commas. + +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfProtocols +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. + +Valid values for this parameter are: + +- ExchangeActiveSync +- ExchangeAdminCenter +- ExchangeWebServices +- IMAP4 +- OfflineAddressBook +- OutlookAnywhere +- OutlookWebApp +- POP3 +- PowerShellWebServices +- RemotePowerShell +- REST +- UniversalOutlook (Mail and Calendar app) + +You can enter multiple values separated by commas. Don't use quotation marks. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfSourceTcpPortNumbers +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptUserIsMemberOf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptUsernameMatchesAnyOfPatterns +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. + +You can enter multiple values separated by commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The Scope parameter specifies the scope of the client access rule. Valid values are: + +- Users: The rule only applies to end-user connections. +- All: The rule applies to all connections (end-users and middle-tier apps). + +```yaml +Type: ClientAccessRulesScope +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIsMemberOf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsernameMatchesAnyOfPatterns +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. + +You can enter multiple values separated by commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -UserRecipientFilter +This parameter is functional only in the cloud-based service. + +The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. + +You can use the following properties with this parameter: + +- City +- Company +- CountryOrRegion (ISO 3166-1 alpha-2 country code.) +- CustomAttribute1 to CustomAttribute15 +- Department +- Office +- PostalCode +- StateOrProvince +- StreetAddress + +The basic syntax for this parameter is `"Property -ComparisonOperator 'Value'"`: + +- Property is one of the filterable properties in the list above (for example `City` or `CustomAttribute1`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. + +For example: + +- `"City -eq 'Redmond'"` +- `"CountryOrRegion -eq 'SG'"`. + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example: + +- `"CustomAttribute1 -eq 'AllowOWA' -and CountryOrRegion -eq AU'"` +- `"(CountryOrRegion -eq 'US' -and Department -eq 'Sales') -or Department -eq 'Research'"`. + +For detailed information about OPATH filter syntax in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ComplianceCase.md b/exchange/exchange-ps/exchange/New-ComplianceCase.md new file mode 100644 index 0000000000..6366bff3d0 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceCase.md @@ -0,0 +1,223 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ComplianceCase + +## 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-ComplianceCase cmdlet to create eDiscovery cases in the Microsoft Purview compliance portal. You use eDiscovery cases to place content locations on hold, perform Content Searches associated with the case, and export search results. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ComplianceCase [-Name] + [-CaseType ] + [-Confirm] + [-Description ] + [-DomainController ] + [-ExternalId ] + [-SecondaryCaseType ] + [-SourceCaseType ] + [-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-ComplianceCase -Name "Fabrikam Litigation" +``` + +This example creates a new eDiscovery Standard case named Fabrikam Litigation. + +### Example 2 +```powershell +New-ComplianceCase -Name "Coho Case 03082020" -CaseType AdvancedEdiscovery -ExternalId "SaraDavis v. Coho Winery" +``` + +This example creates a new eDiscovery Premium case named Coho Case 03082020 and specifies an optional case Id of "SaraDavis v. Coho Winery". + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaseType +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. +- ComplianceClassifier: This type of case corresponds to a trainable classifier. +- ComplianceWorkspace: This value is reserved for internal Microsoft use. +- DataInvestigation: Data investigation cases are used to investigate data spillage incidents. +- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. +- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. This is the default value. +- InsiderRisk: Insider risk cases are use to manage insider risk management cases. Typically, insider risk management cases are manually created in the Microsoft Purview compliance portal to further investigate activity based on a risk alert. +- InternalInvestigation: This value is reserved for internal Microsoft use. +- SupervisionPolicy: This type of case corresponds to communication compliance policy. + +```yaml +Type: ComplianceCaseType +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 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 +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 +``` + +### -ExternalId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCaseType +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -SourceCaseType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md new file mode 100644 index 0000000000..f1f5f46411 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md @@ -0,0 +1,269 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ComplianceRetentionEvent + +## 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-ComplianceRetentionEvent cmdlet to create compliance retention events in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ComplianceRetentionEvent -Name + [-AssetId ] + [-Comment ] + [-Confirm] + [-DomainController ] + [-EventDateTime ] + [-EventTags ] + [-EventType ] + [-ExchangeAssetIdQuery ] + [-PreviewOnly] + [-SharePointAssetIdQuery ] + [-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-ComplianceRetentionEvent -Name "Research Project Employees" -EventTag 80e0d620-13ea-4ed9-b6a6-aa883278bcca -EventType e823b782-9a07-4e30-8091-034fc01f9347 -SharePointAssetIDQuery "EmployeeNumber:123456 EmployeeNumber:456789" +``` + +This example creates a compliance retention event named Research Project Employees with the following settings: + +- EventTag: 80e0d620-13ea-4ed9-b6a6-aa883278bcca +- EventTpe: e823b782-9a07-4e30-8091-034fc01f9347 +- SharePointAssetIDQuery: EmployeeNumber:123456 EmployeeNumber:456789 + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssetId +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. +- Employee IDs that you can use to retain content for only a specific person. + +```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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -EventDateTime +The EventDateTime parameter specifies the date-time of the event. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventTags +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. + +```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 +``` + +### -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`. + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAssetIdQuery +The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see [Keyword queries and search conditions for Content Search](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewOnly +{{ Fill PreviewOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 documents to scope the compliance retention event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md new file mode 100644 index 0000000000..f8097fbf29 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md @@ -0,0 +1,121 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ComplianceRetentionEventType + +## 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-ComplianceRetentionEventType cmdlet to create retention event types in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ComplianceRetentionEventType -Name + [-Comment ] + [-Confirm] + [-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-ComplianceRetentionEventType -Name "Fabrikam Project" +``` + +This example creates a new retention event type name Fabrikam Project + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-ComplianceSearch.md b/exchange/exchange-ps/exchange/New-ComplianceSearch.md new file mode 100644 index 0000000000..bb3b8def59 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceSearch.md @@ -0,0 +1,475 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-ComplianceSearch cmdlet to create compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. You use this cmdlet to define the search criteria. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ComplianceSearch [-Name] + [-AllowNotFoundExchangeLocationsEnabled ] + [-Case ] + [-Confirm] + [-ContentMatchQuery ] + [-Description ] + [-ExchangeLocation ] + [-ExchangeLocationExclusion ] + [-Force] + [-HoldNames ] + [-IncludeOrgContent ] + [-IncludeUserAppContent ] + [-Language ] + [-LogLevel ] + [-PublicFolderLocation ] + [-RefinerNames ] + [-SharePointLocation ] + [-SharePointLocationExclusion ] + [-StatusMailRecipients ] + [-WhatIf] + [] +``` + +## DESCRIPTION +A compliance search requires at least one location. For example, mailboxes using the ExchangeLocation parameter, or SharePoint sites using the SharePointLocation parameter. + +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). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ComplianceSearch -Name "Hold Project X" -ExchangeLocation "Finance Department" +``` + +This example creates a new compliance search named Hold-Project X that searches all members of the distribution group named Finance Department. Because the search doesn't use the ContentMatchQuery parameter, all items in the mailboxes are searched. + +### Example 2 +```powershell +New-ComplianceSearch -Name "Hold-Tailspin Toys" -ExchangeLocation "Research Department" -ContentMatchQuery "'Patent' AND 'Project Tailspin Toys'" +``` + +This example creates a new compliance search named Hold-Tailspin Toys that searches all member of the distribution group named Research Department. Because the search uses the ContentMatchQuery parameter, only messages that match the query are searched. + +### Example 3 +```powershell +New-ComplianceSearch -Name "AnnBeebe-InactiveMailbox" -ExchangeLocation .annb@contoso.onmicrosoft.com -AllowNotFoundExchangeLocationsEnabled $true +``` + +This example creates a new compliance search named AnnBeebe-InactiveMailbox that searches an inactive mailbox and returns all items in the mailbox. To search inactive mailboxes, you need to use the primary SMTP address of the inactive mailbox, prepended with a period ("."). You also need to include the AllowNotFoundExchangeLocationsEnabled parameter so the search doesn't try to validate the existence of the inactive mailbox. + +## PARAMETERS + +### -Name +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNotFoundExchangeLocationsEnabled +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. + +The mailbox types that are affected by the value of this parameter include: + +- Inactive mailboxes +- Users without an Exchange Online license who use Office applications +- Microsoft 365 guest users +- On-premises users whose identity is synchronized with your Microsoft 365 organization + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Case +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. + +You can't use this parameter to create compliance searches associated with eDiscovery Premium cases. + +If the Name parameter contains spaces, the value of the ExchangeLocation parameter is cleared when you use the Case parameter. + +```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: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +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. +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). +- The value All for all mailboxes. You can only use this value by itself. + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ExchangeLocationExclusion +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: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldNames +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. + +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. + +```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 +``` + +### -IncludeOrgContent +{{ Fill IncludeOrgContent 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 +``` + +### -IncludeUserAppContent +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. + +```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 +``` + +### -Language +The Language parameter specifies the language for the compliance search. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ComplianceJobLogLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderLocation +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. + +```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 +``` + +### -RefinerNames +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +This parameter is available only in the cloud-based service. + +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"`. + +```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 +``` + +### -SharePointLocationExclusion +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -StatusMailRecipients +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, 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-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md new file mode 100644 index 0000000000..e2b6541d63 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -0,0 +1,758 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-ComplianceSearchAction cmdlet to create actions for content searches in Exchange Server and in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Export +``` +New-ComplianceSearchAction [-SearchName] + [-Export] + [-ActionName ] + [-ArchiveFormat ] + [-Confirm] + [-FileTypeExclusionsForUnindexedItems ] + [-EnableDedupe ] + [-ExchangeArchiveFormat ] + [-Force] + [-Format ] + [-IncludeCredential] + [-IncludeSharePointDocumentVersions ] + [-JobOptions ] + [-NotifyEmail ] + [-NotifyEmailCC ] + [-ReferenceActionName ] + [-Region ] + [-Report] + [-RetentionReport] + [-RetryOnError] + [-Scenario ] + [-Scope ] + [-SearchNames ] + [-SharePointArchiveFormat ] + [-ShareRootPath ] + [-Version ] + [-WhatIf] + [] +``` + +### Preview +``` +New-ComplianceSearchAction [-SearchName] + [-Preview] + [-ActionName ] + [-Confirm] + [-Force] + [-Format ] + [-IncludeCredential] + [-JobOptions ] + [-ReferenceActionName ] + [-Region ] + [-RetryOnError] + [-Scenario ] + [-SearchNames ] + [-Version ] + [-WhatIf] + [] +``` + +### Purge +``` +New-ComplianceSearchAction [-SearchName] + [-Purge] + [-PurgeType ] + [-ActionName ] + [-Confirm] + [-Force] + [-Format ] + [-IncludeCredential] + [-JobOptions ] + [-Region ] + [-ReferenceActionName ] + [-RetryOnError] + [-Scenario ] + [-SearchNames ] + [-Version ] + [-WhatIf] + [] +``` + +## DESCRIPTION +After you create a content search using the New-ComplianceSearch cmdlet and run it using the Start-ComplianceSearch cmdlet, you assign a search action to the search using the New-ComplianceSearchAction cmdlet. + +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). + +In Microsoft 365, the account that you use to run this cmdlet must have a valid Microsoft 365 license assigned. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ComplianceSearchAction -SearchName "Project X" -Preview +``` + +This example creates a preview search action for the content search named Project X. + +### Example 2 +```powershell +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. + +### Example 4 +```powershell +New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst -Format FxStream +``` + +This example exports the results returned by the content search named "Case 321 All Sites". The search results are compressed and exported to a single ZIP file. If the search included any Exchange locations, the search results are exported as one PST file per mailbox. + +**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 +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. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionName +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. + +```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 +``` + +### -ArchiveFormat +This parameter has been deprecated and is 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. + +```yaml +Type: ComplianceExportArchiveFormat +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDedupe +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: Export +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeArchiveFormat + +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. + +This parameter requires the Export role in Security & Compliance PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. + +The ExchangeArchiveFormat parameter specifies how to export Exchange search results. Valid values are: + +- 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. +- 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. + +To specify the format for SharePoint and OneDrive search results, use the SharePointArchiveFormat parameter. + +```yaml +Type: ComplianceExportArchiveFormat +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. + +This parameter requires the Export role in Security & Compliance PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. + +The Export switch specifies the action for the content search is to export the full set of results that match the search criteria. You don't need to specify a value with this switch. + +To only return the information about each detected item in a report, use the Report switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeExclusionsForUnindexedItems +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +The FileTypeExclusionsForUnindexedItems specifies the file types to exclude because they can't be indexed. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. + +The Format parameter specifies the format of the search results when you use the Export switch. Valid values are: + +- FxStream: Export to PST files. This is the only option that's available when you export search results from the Microsoft Purview compliance portal. +- Mime: Export to .eml message files. This the default value when you use cmdlets to export the search results. +- Msg: Export to .msg message files. + +```yaml +Type: ComplianceDataTransferFormat +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeCredential +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSharePointDocumentVersions +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is available only in the cloud-based service. + +The IncludeSharePointDocumentVersions parameter specifies whether to export previous versions of the document when you use the Export switch. Valid values are: + +- $true: Export all versions of the document. +- $false: Export only the current published version of the topic. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: Export +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobOptions +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmail +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +In Security & Compliance PowerShell, this parameter requires the Export role. By default, this is assigned only to the eDiscovery Manager role group. + +The NotifyEmail parameter specifies the email address target for the search results when you use the Export switch. + +The recipient you specify is in the To: field of the message. + +```yaml +Type: String +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailCC +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. + +The NotifyEmailCC parameter specifies the email address target for the search results when you use the Export switch. + +The recipient you specify is in the Cc: field of the message. + +```yaml +Type: String +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preview +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Preview +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Purge +**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. + +- A maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes. + + **Tip**: To purge more than 10 items, refer to [ediscoverySearch: purgeData](https://learn.microsoft.com/graph/api/security-ediscoverysearch-purgedata) in the Microsoft Graph API, which allows purging a maximum of 100 items per location. + +- You can remove items from a maximum of 50,000 mailboxes using a single content search. To remove items from more than 50,000 mailboxes, you'll have to create separate content searches. For more information, see [Search for and delete email messages in your Microsoft 365 organization](https://learn.microsoft.com/purview/ediscovery-search-for-and-delete-email-messages). +- Unindexed items aren't removed from mailboxes when you use this switch. +- The value of the PurgeType parameter controls how the items are removed. + +```yaml +Type: SwitchParameter +Parameter Sets: Purge +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PurgeType +**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. + +The PurgeType parameter specifies how to remove items when the action is Purge. Valid values are: + +- SoftDelete: Purged items are recoverable by users until the deleted item retention period expires. +- 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. + +```yaml +Type: ComplianceDestroyType +Parameter Sets: Purge +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReferenceActionName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. + +The Report switch specifies the action for the content search is to export a report about the results (information about each item instead of the full set of results) that match the search criteria. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionReport +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +The RetentionReport switch specifies the action for the content search is to export a retention report. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryOnError +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scenario +In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. + +The Scenario parameter specifies the scenario type. 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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +The Scope parameter specifies the items to include when the action is Export. Valid values are: + +- IndexedItemsOnly +- UnindexedItemsOnly +- BothIndexedAndUnindexedItems + +```yaml +Type: ComplianceExportScope +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchNames +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. + +You can find content search names by running the command Get-ComplianceSearch | Format-Table -Auto Name,Status. + +```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 +``` + +### -SharePointArchiveFormat +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. + +This parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. + +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. +- 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. + +To specify the format for Exchange search results, use the ExchangeArchiveFormat parameter. + +```yaml +Type: ComplianceExportArchiveFormat +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareRootPath +This parameter is available only in on-premises Exchange. + +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +{{ Fill ShareRootPath Description }} + +```yaml +Type: String +Parameter Sets: Export +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, 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-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md new file mode 100644 index 0000000000..cf258e62c7 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md @@ -0,0 +1,250 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ComplianceSecurityFilter + +## 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 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). + +## SYNTAX + +``` +New-ComplianceSecurityFilter -Action -FilterName -Users + [-Confirm] + [-Description ] + [-Filters ] + [-Region ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Compliance security filters work with compliance searches in the Microsoft Purview compliance portal (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ComplianceSecurityFilter -FilterName CountryFilter -Users annb@contoso.com -Filters "Mailbox_CountryCode -eq '124'" -Action All +``` + +This example allows the user annb to perform all compliance search actions only for mailboxes in Canada. The filter uses the ISO 3166-1 numeric country code value. + +### Example 2 +```powershell +New-ComplianceSecurityFilter -FilterName USDiscoveryManagers -Users "US Discovery Managers" -Filters "Mailbox_CountryCode -eq '840'" -Action All +``` + +This example allows members of the US Discovery Managers role group to perform all compliance search actions only on mailboxes in the United States. + +### Example 3 +```powershell +New-ComplianceSecurityFilter -FilterName EmailDateRestrictionFilter -Users donh@contoso.com -Filters "MailboxContent_Received -ge '01-01-2018' -and MailboxContent_Received -le '12-31-2018'" -Action All +``` + +This example restricts the user to performing all compliance search actions only on email messages sent during the calendar year 2018. + +### Example 4 +```powershell +New-ComplianceSecurityFilter -FilterName DocumentDateRestrictionFilter -Users donh@contoso.com -Filters "SiteContent_LastModifiedTime -ge '01-01-2018' -and SiteContent_LastModifiedTime -le '12-31-2018'" -Action All +``` + +This example restricts the user to performing all compliance search actions on documents that were last changed sometime in the calendar year 2018. + +### Example 5 +```powershell +New-ComplianceSecurityFilter -FilterName NoEXO -Users suzanf@contoso.com -Filters "Mailbox_Alias -notlike '*'" -Action All +``` + +This example prevents the user from performing any compliance search actions on any mailbox in the organization. + +## PARAMETERS + +### -Action +The Action parameter specifies that type of search action that the filter is applied to. Valid values are: + +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. +- Preview: The filter is applied when previewing search results. +- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. +- Search: The filter is applied when running a search. +- All: The filter is applied to all search actions. + +```yaml +Type: ComplianceSecurityFilterActionType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +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. +- The value All: Assigns the filter to all users. You can only use this value by itself. +- One or more role groups: Identify the role group by its name. You can specify multiple values separated by commas. + +You can't specify distribution groups with this parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filters +The Filters parameter specifies the search criteria for the compliance security filter. The filters are applied to the users specified by the Users parameter. You can create three different types of filters: + +- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `"MailboxContent_Recipients -like 'contoso.com'"` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see [Keyword queries for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions#searchable-email-properties). +- Site and site content filter: There are two SharePoint and OneDrive site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. + +You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. + +You need to create a search permissions filter to explicitly prevent users from searching any content location in a specific Microsoft 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you need to create a filter that prevents them from searching mailboxes (as described in Example 5). Similarly, to allow an Exchange admin to only search mailboxes, you need to create a filter that prevents them from searching sites. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are: + +- APC: Asia-Pacific +- AUS: Australia +- CAN: Canada +- EUR: Europe, Middle East, Africa +- FRA: France +- GBR: United Kingdom +- IND: India +- JPN: Japan +- LAM: Latin America +- NAM: North America + +If you don't use this parameter in a multi-geo tenant, eDiscovery searches are performed in the central location. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, 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-ComplianceTag.md b/exchange/exchange-ps/exchange/New-ComplianceTag.md new file mode 100644 index 0000000000..9de8c0fca4 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ComplianceTag.md @@ -0,0 +1,513 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ComplianceTag + +## 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-ComplianceTag cmdlet to create retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-ComplianceTag [-Name] + [-AutoApprovalPeriod ] + [-Comment ] + [-ComplianceTagForNextStage ] + [-Confirm] + [-EventType ] + [-FilePlanProperty ] + [-FlowId ] + [-Force] + [-IsRecordLabel ] + [-IsRecordUnlockedAsDefault ] + [-MultiStageReviewProperty ] + [-Notes ] + [-Regulatory ] + [-RetentionAction ] + [-RetentionDuration ] + [-RetentionType ] + [-ReviewerEmail ] + [-WhatIf] + [] +``` + +### PriorityCleanup +``` +New-ComplianceTag [-Name] -RetentionAction -RetentionDuration -RetentionType + -MultiStageReviewProperty [-PriorityCleanup] + [-Comment ] + [-Confirm] + [-Force] + [-Notes ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ComplianceTag -Name "HR Content" -RetentionAction Keep -RetentionDuration 1825 -RetentionType ModificationAgeInDays +``` + +This example creates a new label named HR Content with the following settings: + +- Action: Keep. +- Duration: 5 years (1825 days) +- Type: Modification age in days. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionAction +The RetentionAction parameter specifies the action for the label. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: + +- A positive integer. +- The value unlimited. + +```yaml +Type: Unlimited +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Unlimited +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionType +The RetentionType parameter specifies whether the retention duration is calculated from the content creation date, tagged date, or last modification date. Valid values are: + +- CreationAgeInDays +- EventAgeInDays +- ModificationAgeInDays +- TaggedAgeInDays + +```yaml +Type: String +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoApprovalPeriod +{{ Fill AutoApprovalPeriod Description }} + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```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 +``` + +### -ComplianceTagForNextStage +{{ Fill ComplianceTagForNextStage Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -EventType +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 +- Distinguished name (DN) +- GUID + +You can use the Get-RetentionComplianceRule cmdlet to view the available retention rules. + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePlanProperty +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` +- `Get-FilePlanPropertyCategory | Format-List Name` +- `Get-FilePlanPropertyCitation | Format-List Name` +- `Get-FilePlanPropertyDepartment | Format-List Name` +- `Get-FilePlanPropertyReferenceId | Format-List Name` +- `Get-FilePlanPropertySubCategory | Format-List Name` + +A valid value for this parameter involves two steps: + +- A variable to store the file plan properties as a PSCustomObject using the following syntax: + + `$Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}` + + For example: + + `$retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="Referen`ceA"},@{Key="FilePlanPropertyAuthority";Value="Auth1"})} + +- A second variable to convert the PSCustomObject to a JSON object using the following syntax: + + `$Variable2 = ConvertTo-Json $Variable1` + + For example: + + `$fpStr = ConvertTo-Json $retentionLabelAction` + +You use the second variable as the value for this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowId +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. + +The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. + +You can find the GUID value of the flow by using either of the following methods: + +- Navigate to the flow from the Power Automate portal. The GUID value of the flow is in the URL. +- Use the Power Automate action named 'List flows as admin'. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsRecordLabel +The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: + +- $true: The label is a record label. Once the label is applied to content, the label can't be removed. +- $false: The label isn't a record label. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsRecordUnlockedAsDefault +{{ Fill IsRecordUnlockedAsDefault 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 +``` + +### -MultiStageReviewProperty +The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: + +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` + +For example: + +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'` + +This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). + +```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 +``` + +### -Regulatory +{{ Fill Regulatory 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 +``` + +### -ReviewerEmail +The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. + +```yaml +Type: SmtpAddress[] +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-DataClassification.md b/exchange/exchange-ps/exchange/New-DataClassification.md new file mode 100644 index 0000000000..ee21f6fc1a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DataClassification.md @@ -0,0 +1,211 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-DataClassification + +## 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. + +Use the New-DataClassification cmdlet to create data classification rules that use document fingerprints. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DataClassification [-Name] -Description -Fingerprints + [-ClassificationRuleCollectionIdentity ] + [-Confirm] + [-DomainController ] + [-Locale ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +$Employee_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Employee Template.docx') + +$Employee_Fingerprint = New-Fingerprint -FileData $Employee_Template -Description "Contoso Employee Template" + +$Customer_Template = [System.IO.File]::ReadAllBytes('D:\Data\Contoso Customer Template.docx') + +$Customer_Fingerprint = New-Fingerprint -FileData $Customer_Template -Description "Contoso Customer Template" + +New-DataClassification -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint,$Customer_Fingerprint -Description "Message contains Contoso employee or customer information." +``` + +This example creates a new data classification rule named "Contoso Employee-Customer Confidential" that uses the document fingerprints of the files C:\\My Documents\\Contoso Employee Template.docx and D:\\Data\\Contoso Customer Template.docx. + +## PARAMETERS + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fingerprints +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Name +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationRuleCollectionIdentity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +The Locale parameter specifies the language that's associated with the 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). + +You can add additional language translations to the data classification rule by using the Set-DataClassification cmdlet. + +```yaml +Type: CultureInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md new file mode 100644 index 0000000000..fb8c9ddfeb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md @@ -0,0 +1,180 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DataEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-DataEncryptionPolicy cmdlet to create data encryption policies in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DataEncryptionPolicy [-Name] -AzureKeyIDs + [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Data encryption policy cmdlets are the Exchange Online part of Customer Key. For more information, see [Controlling your data in Microsoft 365 using Customer Key](https://aka.ms/customerkey). + +You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-DataEncryptionPolicy -Name "US Mailboxes" -AzureKeyIDs "https://contosowestusvault01.vault.azure.net/keys/USA_Key_01","https://contosoeastusvault01.vault.azure.net/keys/USA_Key_02" -Description "Root key for mailboxes located in US territories" +``` + +This example creates a data encryption policy named US Mailboxes with the specified Azure Key Vault keys and description. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureKeyIDs +The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, `"https://contosowestusvault01.vault.azure.net/keys/USA_Key_01","https://contosoeastusvault01.vault.azure.net/keys/USA_Key_02"`. + +To find the URI value for an Azure Key Vault, replace `` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName ).id`. For more information, see [About Azure Key Vault](https://learn.microsoft.com/azure/key-vault/general/overview). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disable the data encryption policy. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md index 93440ba1c1..8b05d74e98 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-DatabaseAvailabilityGroup @@ -13,17 +16,23 @@ This cmdlet is available only in on-premises Exchange. Use the New-DatabaseAvailabilityGroup cmdlet to create a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DatabaseAvailabilityGroup [-Name] [-Confirm] [-DatabaseAvailabilityGroupIpAddresses ] - [-DomainController ] [-ThirdPartyReplication ] [-WhatIf] - [-WitnessDirectory ] [-WitnessServer ] +New-DatabaseAvailabilityGroup [-Name] + [-ActivityState ] + [-Confirm] [-DagConfiguration ] - [-ActivityState ] - [-FileSystem ] [] + [-DatabaseAvailabilityGroupIpAddresses ] + [-DomainController ] + [-FileSystem ] + [-ThirdPartyReplication ] + [-WhatIf] + [-WitnessDirectory ] + [-WitnessServer ] + [] ``` ## DESCRIPTION @@ -32,41 +41,38 @@ When creating a DAG, you need to specify a valid computer name for the DAG no lo The requirements for the witness server are as follows: - The witness server can't be a member of the DAG. - - The witness server must be running the Windows Server 2008 operating system or later. - - A single server can serve as a witness for multiple DAGs; however, each DAG requires its own witness directory. The following combinations of options and behaviors are available: - You can specify a name for the DAG, the witness server that you want to use, and the directory you want created and shared on the witness server. - - You can specify a name for the DAG and the witness server that you want to use. In this scenario, the task creates the default directory on the specified witness server. 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. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-DatabaseAvailabilityGroup -Name DAG1 -WitnessServer SERVER1 -WitnessDirectory C:\DAG1 ``` This example creates a DAG named DAG1 that's configured to use a witness server of SERVER1, and a local directory of C:\\DAG1. This example requires Windows Server 2012 R2 or later. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-DatabaseAvailabilityGroup -Name DAG2 -WitnessServer SERVER2 -DatabaseAvailabilityGroupIpAddresses ([])::Any ``` This example creates the DAG named DAG2 with a witness server named SERVER2. The system automatically selects an Exchange server in the same site as the DAG to use as the witness server. DAG2 is configured to use DHCP for the DAG's IP address. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-DatabaseAvailabilityGroup -Name DAG3 -WitnessServer SERVER1 -WitnessDirectory C:\DAG3 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8,192.168.0.8 ``` @@ -82,6 +88,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -89,18 +96,15 @@ 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. +### -ActivityState +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: ActivityStateOption Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -108,14 +112,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseAvailabilityGroupIpAddresses -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. +### -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: IPAddress[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -123,14 +131,15 @@ 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. +### -DagConfiguration +This parameter is reserved for internal Microsoft use. ```yaml -Type: Fqdn +Type: DatabaseAvailabilityGroupConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -138,14 +147,15 @@ Accept pipeline input: False 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. +### -DatabaseAvailabilityGroupIpAddresses +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: Disabled | Enabled +Type: IPAddress[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -153,14 +163,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -168,14 +179,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WitnessDirectory -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. +### -FileSystem +The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: + +- NTFS +- ReFS ```yaml -Type: NonRootLocalLongFullPath +Type: FileSystemMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -183,14 +198,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WitnessServer -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. +### -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. ```yaml -Type: FileShareWitnessServerName +Type: ThirdPartyReplicationMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -198,14 +214,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DagConfiguration -This parameter is reserved for internal Microsoft use. +### -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: DatabaseAvailabilityGroupConfigurationIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -213,14 +230,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ActivityState -This parameter is reserved for internal Microsoft use. +### -WitnessDirectory +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: NewDeployment | DotBuildUpgrade | Decom | PendingDotBuildUpgrade | DecomRemoveMailboxes | DecomNoUpgrades | Discovered | Allocated | ReadyForAllocation | Spare +Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -228,18 +246,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSystem -The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: - -- NTFS - -- ReFS +### -WitnessServer +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: NTFS | ReFS +Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -248,20 +263,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c0cd98a9-eaaa-4cfb-845d-213e5d606d3b.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md similarity index 79% rename from exchange/exchange-ps/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md index 12ba578464..cdf95fa60f 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-DatabaseAvailabilityGroupNetwork @@ -13,24 +16,29 @@ This cmdlet is available only in on-premises Exchange. Use the New-DatabaseAvailabilityGroupNetwork cmdlet to create a database availability group (DAG) network. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DatabaseAvailabilityGroupNetwork [-Name] - [-DatabaseAvailabilityGroup] [-Confirm] [-Description ] - [-DomainController ] [-IgnoreNetwork <$true | $false>] [-ReplicationEnabled <$true | $false>] - [-Subnets ] [-WhatIf] [] +New-DatabaseAvailabilityGroupNetwork [-Name] [-DatabaseAvailabilityGroup] + [-Confirm] + [-Description ] + [-DomainController ] + [-IgnoreNetwork ] + [-ReplicationEnabled ] + [-Subnets ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-DatabaseAvailabilityGroupNetwork -DatabaseAvailabilityGroup DAG1 -Name DAG1Repl -Subnets 10.0.0.0/8 -ReplicationEnabled:$true ``` @@ -38,31 +46,33 @@ This example creates the DAG network DAG1Repl in the DAG DAG1. A subnet of 10.0. ## PARAMETERS -### -DatabaseAvailabilityGroup -The DatabaseAvailabilityGroup parameter specifies the name of the DAG that'll use the network being created. +### -Name +The Name parameter specifies the name of the DAG network being created. ```yaml -Type: DatabaseAvailabilityGroupIdParameter +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of the DAG network being created. +### -DatabaseAvailabilityGroup +The DatabaseAvailabilityGroup parameter specifies the name of the DAG that'll use the network being created. ```yaml -Type: String +Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -71,8 +81,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -80,6 +89,7 @@ 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 @@ -95,6 +105,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,6 +121,7 @@ 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 @@ -121,10 +133,11 @@ Accept wildcard characters: False The IgnoreNetwork parameter excludes the DAG network from use by the DAG. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -136,10 +149,11 @@ Accept wildcard characters: False The ReplicationEnabled parameter specifies whether the DAG network being created is enabled for continuous replication. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -155,6 +169,7 @@ Type: DatabaseAvailabilityGroupSubnetId[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,6 +185,7 @@ 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 @@ -178,20 +194,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3ef8d42f-9da0-456a-b4e8-6f7d99a1fa0f.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md similarity index 83% rename from exchange/exchange-ps/exchange/mail-flow/New-DeliveryAgentConnector.md rename to exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md index 3609ff74fc..42534c6c9d 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-DeliveryAgentConnector @@ -13,27 +16,34 @@ This cmdlet is available only in on-premises Exchange. The New-DeliveryAgentConnector cmdlet creates a delivery agent connector in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DeliveryAgentConnector [-Name] -AddressSpaces -DeliveryProtocol - [-Comment ] [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-IsScopedConnector <$true | $false>] [-MaxConcurrentConnections ] [-MaxMessageSize ] - [-MaxMessagesPerConnection ] [-SourceTransportServers ] [-WhatIf] + [-Comment ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IsScopedConnector ] + [-MaxConcurrentConnections ] + [-MaxMessageSize ] + [-MaxMessagesPerConnection ] + [-SourceTransportServers ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/dd638118.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-DeliveryAgentConnector -Name "Contoso X.400 Connector" -AddressSpaces "X400:c=US;a=Fabrikam;p=Contoso;1" -DeliveryProtocol "X.400" -SourceTransportServers Hub01,Hub02,Hub05 ``` @@ -42,9 +52,7 @@ This example creates a delivery agent connector named Contoso X.400 Connector wi The delivery agent connector is hosted on the following servers: - Hub01 - - Hub02 - - Hub05 The delivery agent connector is designed to handle X.400 connections to a company called Contoso that uses the carrier Fabrikam. @@ -53,29 +61,31 @@ The address space for the connector is c=US;a=Fabrikam;p=Contoso. ## PARAMETERS -### -AddressSpaces -The AddressSpaces parameter specifies the domain names for which this delivery agent connector is responsible. The syntax for entering an address space is as follows: \:\;\. You must enclose each address space in quotation marks ("). +### -Name +The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DeliveryProtocol -The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. +### -AddressSpaces +The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml -Type: String +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -83,16 +93,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. +### -DeliveryProtocol +The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -106,6 +117,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -116,8 +128,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -125,6 +136,7 @@ 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 @@ -142,6 +154,7 @@ 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 @@ -155,10 +168,11 @@ The Enabled parameter specifies whether the delivery agent connector is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,10 +184,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,6 +204,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -200,11 +216,8 @@ Accept wildcard characters: False 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) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) Unqualified values are treated as bytes. The valid input range for this parameter is from 65536 through 2147483647 bytes. The default value is unlimited. @@ -214,6 +227,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -229,6 +243,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -246,6 +261,7 @@ 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 @@ -261,6 +277,7 @@ 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 @@ -269,20 +286,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b09ac95b-ea07-41cf-9c69-95c215bfa02c.aspx) diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md new file mode 100644 index 0000000000..b8386092bb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md @@ -0,0 +1,169 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DeviceConditionalAccessPolicy + +## 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-DeviceConditionalAccessPolicy cmdlet to create mobile device conditional access policies in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DeviceConditionalAccessPolicy [-Name] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConditionalAccessPolicy -Identity "Human Resources" +``` + +This example creates a new mobile device conditional access policy named Human Resources + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md new file mode 100644 index 0000000000..102c007035 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md @@ -0,0 +1,1454 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DeviceConditionalAccessRule + +## 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-DeviceConditionalAccessRule cmdlet to create mobile device conditional access rules in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DeviceConditionalAccessRule -Policy -TargetGroups + [-AccountName ] + [-AccountUserName ] + [-AllowAppStore ] + [-AllowAssistantWhileLocked ] + [-AllowConvenienceLogon ] + [-AllowDiagnosticSubmission ] + [-AllowiCloudBackup ] + [-AllowiCloudDocSync ] + [-AllowiCloudPhotoSync ] + [-AllowJailbroken ] + [-AllowPassbookWhileLocked ] + [-AllowScreenshot ] + [-AllowSimplePassword ] + [-AllowVideoConferencing ] + [-AllowVoiceAssistant ] + [-AllowVoiceDialing ] + [-AntiVirusSignatureStatus ] + [-AntiVirusStatus ] + [-AppsRating ] + [-AutoUpdateStatus ] + [-BluetoothEnabled ] + [-CameraEnabled ] + [-Confirm] + [-DomainController ] + [-EmailAddress ] + [-EnableRemovableStorage ] + [-ExchangeActiveSyncHost ] + [-FirewallStatus ] + [-ForceAppStorePassword ] + [-ForceEncryptedBackup ] + [-MaxPasswordAttemptsBeforeWipe ] + [-MaxPasswordGracePeriod ] + [-MoviesRating ] + [-PasswordComplexity ] + [-PasswordExpirationDays ] + [-PasswordHistoryCount ] + [-PasswordMinComplexChars ] + [-PasswordMinimumLength ] + [-PasswordQuality ] + [-PasswordRequired ] + [-PasswordTimeout ] + [-PhoneMemoryEncrypted ] + [-RegionRatings ] + [-RequireEmailProfile ] + [-SmartScreenEnabled ] + [-SystemSecurityTLS ] + [-TVShowsRating ] + [-UserAccountControlStatus ] + [-WhatIf] + [-WLANEnabled ] + [-WorkFoldersSyncUrl ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConditionalAccessRule -Policy "Secure Email" -TargetGroups 5bff73eb-0ba7-461b-b7c9-9b4c173cc266 +``` + +This example creates a new mobile device conditional access rule with the following settings: + +- Policy: Secure Email +- TargetGroups:5bff73eb-0ba7-461b-b7c9-9b4c173cc266 + +## PARAMETERS + +### -Policy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroups +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. + +```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 +``` + +### -AccountName +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. + +```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 +``` + +### -AccountUserName +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. + +```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 +``` + +### -AllowAppStore +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ + +```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 +``` + +### -AllowAssistantWhileLocked +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowConvenienceLogon +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. + +This setting is available only on Windows 8.1 RT devices. + +```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 +``` + +### -AllowDiagnosticSubmission +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ + +```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 +``` + +### -AllowiCloudBackup +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowiCloudDocSync +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowiCloudPhotoSync +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowJailbroken +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowPassbookWhileLocked +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowScreenshot +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ + +```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 +``` + +### -AllowSimplePassword +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ + +```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 +``` + +### -AllowVideoConferencing +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowVoiceAssistant +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowVoiceDialing +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AntiVirusSignatureStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiVirusStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppsRating +The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: + +- AllowAll +- DontAllow +- Rating9plus +- Rating12plus +- Rating17plus +- $null (blank): The setting isn't configured. This is the default value. + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingAppsEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpdateStatus +The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: + +- AutomaticCheckForUpdates +- AutomaticDownloadUpdates +- AutomaticUpdatesRequired +- DeviceDefault +- NeverCheckUpdates +- $null (blank): The setting isn't configured. This is the default value. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: CAAutoUpdateStatusEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BluetoothEnabled +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. + +This setting is available only on Windows Phone 8.1 devices. + +```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 +``` + +### -CameraEnabled +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -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 +``` + +### -EmailAddress +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. + +```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 +``` + +### -EnableRemovableStorage +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. + +This setting is available only on Windows Phone 8.1 devices. + +```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 +``` + +### -ExchangeActiveSyncHost +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. + +```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 +``` + +### -FirewallStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Required +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceAppStorePassword +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -ForceEncryptedBackup +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -MaxPasswordAttemptsBeforeWipe +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -MaxPasswordGracePeriod +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. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoviesRating +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/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. + +Australia + +- AURatingG +- AURatingPG +- AURatingM +- AURatingMA15plus +- AURatingR18plus + +Canada + +- CARatingG +- CARatingPG +- CARating14A +- CARating18A +- CARatingR + +Germany + +- DERatingab0Jahren +- DERatingab6Jahren +- DERatingab12Jahren +- DERatingab16Jahren +- DERatingab18Jahren + +France + +- FRRating10minus +- FRRating12minus +- FRRating16minus +- FRRating18minus + +United Kingdom + +- GBRatingU +- GBRatingUc +- GBRatingPG +- GBRating12 +- GBRating12A +- GBRating15 +- GBRating18 + +Ireland + +- IERatingG +- IERatingPG +- IERating12 +- IERating15 +- IERating16 +- IERating18 + +Japan + +- JPRatingG +- JPRatingPG12 +- JPRatingRdash15 +- JPRatingRdash18 + +New Zealand + +- NZRatingG +- NZRatingPG +- NZRatingM +- NZRatingR13 +- NZRatingR15 +- NZRatingR16 +- NZRatingR18 +- NZRatingR + +United States + +- USRatingG +- USRatingPG +- USRatingPG13 +- USRatingR +- USRatingNC17 + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingMovieEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordComplexity +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. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordExpirationDays +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordHistoryCount +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordMinComplexChars +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. + +```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 +``` + +### -PasswordMinimumLength +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordQuality +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. + +This setting is available only on Android 4+ devices. + +```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 +``` + +### -PasswordRequired +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordTimeout +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: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneMemoryEncrypted +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 (already encrypted and can't be unencrypted) +- Android 4+ + +```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 +``` + +### -RegionRatings +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. +- au: Australia +- ca: Canada +- de: Germany +- fr: France +- gb: United Kingdom +- ie: Ireland +- jp: Japan +- nz: New Zealand +- us: United States + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingRegionEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireEmailProfile +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. + +```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 +``` + +### -SmartScreenEnabled +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. + +This setting is available only on Windows 8.1 RT devices. + +```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 +``` + +### -SystemSecurityTLS +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -TVShowsRating +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. + +Australia + +- AURatingP +- AURatingC +- AURatingG +- AURatingPG +- AURatingM +- AURatingMA15plus +- AURatingAv15plus + +Canada + +- CARatingC +- CARatingC8 +- CARatingG +- CARatingPG +- CARating14plus +- CARating18plus + +Germany + +- DERatingab0Jahren +- DERatingab6Jahren +- DERatingab12Jahren +- DERatingab16Jahren +- DERatingab18Jahren + +France + +- FRRating10minus +- FRRating12minus +- FRRating16minus +- FRRating18minus + +United Kingdom + +- GBRatingCaution + +Ireland + +- IERatingGA +- IERatingCh +- IERatingYA +- IERatingPS +- IERatingMA + +Japan + +- JPRatingExplicitAllowed + +New Zealand + +- NZRatingG +- NZRatingPGR +- NZRatingAO + +United States + +- USRatingTVY +- USRatingTVY7 +- USRatingTVG +- USRatingTVPG +- USRatingTV14 +- USRatingTVMA + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingTvShowEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAccountControlStatus +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. +- AlwaysNotify +- NeverNotify +- NotifyAppChanges +- NotifyAppChangesDoNotDimdesktop + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: CAUserAccountControlStatusEntry +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 +``` + +### -WLANEnabled +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. + +This setting is available only on Microsoft Windows Phone 8.1 devices. + +```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 +``` + +### -WorkFoldersSyncUrl +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`. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md new file mode 100644 index 0000000000..67e19df788 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md @@ -0,0 +1,169 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DeviceConfigurationPolicy + +## 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-DeviceConfigurationPolicy cmdlet to create mobile device configuration policies in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DeviceConfigurationPolicy [-Name] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConfigurationPolicy -Name "Engineering Group" +``` + +This example creates a new mobile device configuration policy named Engineering Group. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md new file mode 100644 index 0000000000..e4505ceb8f --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md @@ -0,0 +1,1428 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DeviceConfigurationRule + +## 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-DeviceConfigurationRule cmdlet to create mobile device configuration rules in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DeviceConfigurationRule -Policy -TargetGroups + [-AccountName ] + [-AccountUserName ] + [-AllowAppStore ] + [-AllowAssistantWhileLocked ] + [-AllowConvenienceLogon ] + [-AllowDiagnosticSubmission ] + [-AllowiCloudBackup ] + [-AllowiCloudDocSync ] + [-AllowiCloudPhotoSync ] + [-AllowPassbookWhileLocked ] + [-AllowScreenshot ] + [-AllowSimplePassword ] + [-AllowVideoConferencing ] + [-AllowVoiceAssistant ] + [-AllowVoiceDialing ] + [-AntiVirusSignatureStatus ] + [-AntiVirusStatus ] + [-AppsRating ] + [-AutoUpdateStatus ] + [-BluetoothEnabled ] + [-CameraEnabled ] + [-Confirm] + [-DomainController ] + [-EmailAddress ] + [-EnableRemovableStorage ] + [-ExchangeActiveSyncHost ] + [-FirewallStatus ] + [-ForceAppStorePassword ] + [-ForceEncryptedBackup ] + [-MaxPasswordAttemptsBeforeWipe ] + [-MaxPasswordGracePeriod ] + [-MoviesRating ] + [-PasswordComplexity ] + [-PasswordExpirationDays ] + [-PasswordHistoryCount ] + [-PasswordMinComplexChars ] + [-PasswordMinimumLength ] + [-PasswordQuality ] + [-PasswordRequired ] + [-PasswordTimeout ] + [-PhoneMemoryEncrypted ] + [-RegionRatings ] + [-RequireEmailProfile ] + [-SmartScreenEnabled ] + [-SystemSecurityTLS ] + [-TVShowsRating ] + [-UserAccountControlStatus ] + [-WhatIf] + [-WLANEnabled ] + [-WorkFoldersSyncUrl ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceConfigurationRule -Policy "Engineering Group" -TargetGroups 5bff73eb-0ba7-461b-b7c9-9b4c173cc266 +``` + +This example creates a new mobile device configuration rule with the following settings: + +- Policy: Engineering Group +- TargetGroups:5bff73eb-0ba7-461b-b7c9-9b4c173cc266 + +## PARAMETERS + +### -Policy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroups +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. + +```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 +``` + +### -AccountName +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. + +```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 +``` + +### -AccountUserName +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. + +```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 +``` + +### -AllowAppStore +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ + +```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 +``` + +### -AllowAssistantWhileLocked +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowConvenienceLogon +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. + +This setting is available only on Windows 8.1 RT devices. + +```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 +``` + +### -AllowDiagnosticSubmission +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ + +```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 +``` + +### -AllowiCloudBackup +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowiCloudDocSync +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowiCloudPhotoSync +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowPassbookWhileLocked +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowScreenshot +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ + +```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 +``` + +### -AllowSimplePassword +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ + +```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 +``` + +### -AllowVideoConferencing +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowVoiceAssistant +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowVoiceDialing +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AntiVirusSignatureStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiVirusStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppsRating +The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: + +- AllowAll +- DontAllow +- Rating9plus +- Rating12plus +- Rating17plus +- $null (blank): The setting isn't configured. This is the default value. + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: RatingAppsEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpdateStatus +The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: + +- AutomaticCheckForUpdates +- AutomaticDownloadUpdates +- AutomaticUpdatesRequired +- DeviceDefault +- NeverCheckUpdates +- $null (blank): The setting isn't configured. This is the default value. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: AutoUpdateStatusEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BluetoothEnabled +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. + +This setting is available only on Windows Phone 8.1 devices. + +```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 +``` + +### -CameraEnabled +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -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 +``` + +### -EmailAddress +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. + +```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 +``` + +### -EnableRemovableStorage +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. + +This setting is available only on Windows Phone 8.1 devices. + +```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 +``` + +### -ExchangeActiveSyncHost +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. + +```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 +``` + +### -FirewallStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Required +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceAppStorePassword +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -ForceEncryptedBackup +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -MaxPasswordAttemptsBeforeWipe +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -MaxPasswordGracePeriod +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. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoviesRating +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/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. + +Australia + +- AURatingG +- AURatingPG +- AURatingM +- AURatingMA15plus +- AURatingR18plus + +Canada + +- CARatingG +- CARatingPG +- CARating14A +- CARating18A +- CARatingR + +Germany + +- DERatingab0Jahren +- DERatingab6Jahren +- DERatingab12Jahren +- DERatingab16Jahren +- DERatingab18Jahren + +France + +- FRRating10minus +- FRRating12minus +- FRRating16minus +- FRRating18minus + +United Kingdom + +- GBRatingU +- GBRatingUc +- GBRatingPG +- GBRating12 +- GBRating12A +- GBRating15 +- GBRating18 + +Ireland + +- IERatingG +- IERatingPG +- IERating12 +- IERating15 +- IERating16 +- IERating18 + +Japan + +- JPRatingG +- JPRatingPG12 +- JPRatingRdash15 +- JPRatingRdash18 + +New Zealand + +- NZRatingG +- NZRatingPG +- NZRatingM +- NZRatingR13 +- NZRatingR15 +- NZRatingR16 +- NZRatingR18 +- NZRatingR + +United States + +- USRatingG +- USRatingPG +- USRatingPG13 +- USRatingR +- USRatingNC17 + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: RatingMovieEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordComplexity +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. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordExpirationDays +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordHistoryCount +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordMinComplexChars +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. + +```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 +``` + +### -PasswordMinimumLength +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordQuality +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. + +This setting is available only on Android 4+ devices. + +```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 +``` + +### -PasswordRequired +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordTimeout +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: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneMemoryEncrypted +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 (already encrypted and can't be unencrypted) +- Android 4+ + +```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 +``` + +### -RegionRatings +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. +- au: Australia +- ca: Canada +- de: Germany +- fr: France +- gb: United Kingdom +- ie: Ireland +- jp: Japan +- nz: New Zealand +- us: United States + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: RatingRegionEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireEmailProfile +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. + +```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 +``` + +### -SmartScreenEnabled +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. + +This setting is available only on Windows 8.1 RT devices. + +```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 +``` + +### -SystemSecurityTLS +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -TVShowsRating +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. + +Australia + +- AURatingP +- AURatingC +- AURatingG +- AURatingPG +- AURatingM +- AURatingMA15plus +- AURatingAv15plus + +Canada + +- CARatingC +- CARatingC8 +- CARatingG +- CARatingPG +- CARating14plus +- CARating18plus + +Germany + +- DERatingab0Jahren +- DERatingab6Jahren +- DERatingab12Jahren +- DERatingab16Jahren +- DERatingab18Jahren + +France + +- FRRating10minus +- FRRating12minus +- FRRating16minus +- FRRating18minus + +United Kingdom + +- GBRatingCaution + +Ireland + +- IERatingGA +- IERatingCh +- IERatingYA +- IERatingPS +- IERatingMA + +Japan + +- JPRatingExplicitAllowed + +New Zealand + +- NZRatingG +- NZRatingPGR +- NZRatingAO + +United States + +- USRatingTVY +- USRatingTVY7 +- USRatingTVG +- USRatingTVPG +- USRatingTV14 +- USRatingTVMA + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: RatingTvShowEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAccountControlStatus +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. +- AlwaysNotify +- NeverNotify +- NotifyAppChanges +- NotifyAppChangesDoNotDimdesktop + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: UserAccountControlStatusEntry +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 +``` + +### -WLANEnabled +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. + +This setting is available only on Microsoft Windows Phone 8.1 devices. + +```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 +``` + +### -WorkFoldersSyncUrl +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`. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md new file mode 100644 index 0000000000..13317afc2d --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md @@ -0,0 +1,152 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DeviceTenantPolicy + +## 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-DeviceTenantPolicy cmdlet to create your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DeviceTenantPolicy [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceTenantPolicy +``` + +This example creates your organization's mobile device tenant policy. You can have only one mobile device tenant policy in your organization. + +## PARAMETERS + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-DeviceTenantRule.md b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md new file mode 100644 index 0000000000..214a1d7524 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md @@ -0,0 +1,177 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DeviceTenantRule + +## 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-DeviceTenantRule cmdlet to create your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DeviceTenantRule [-ApplyPolicyTo ] + [-BlockUnsupportedDevices ] + [-Confirm] + [-DomainController ] + [-ExclusionList ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-DeviceTenantRule -ExclusionList "e10214c1-49b6-47d2-b5e6-466e918648b1","6e3931bd-a716-4bb9-9a2f-093aa2c967b4" +``` + +This example creates a new mobile device tenant rule with GUIDs of the security groups named Engineering and Research and Development on the exclusion list. Members of these groups are allowed access even if they use non-compliant devices + +You can have only one mobile device tenant rule in your organization. + +## PARAMETERS + +### -ApplyPolicyTo +The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: + +- ExchangeOnline +- SharePointOnline +- ExchangeAndSharePoint + +```yaml +Type: PolicyResourceScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockUnsupportedDevices +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. +- $false: Unsupported devices are allowed. + +```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 +``` + +### -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 +``` + +### -ExclusionList +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. + +You can specify multiple groups separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-DistributionGroup.md b/exchange/exchange-ps/exchange/New-DistributionGroup.md new file mode 100644 index 0000000000..de47db246c --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -0,0 +1,694 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-DistributionGroup cmdlet to create distribution groups and mail-enabled security groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DistributionGroup [-Name] + [-Alias ] + [-ArbitrationMailbox ] + [-BccBlocked ] + [-BypassNestedModerationEnabled ] + [-Confirm] + [-CopyOwnerToMember] + [-Description ] + [-DisplayName ] + [-DomainController ] + [-HiddenGroupMembershipEnabled] + [-IgnoreNamingPolicy] + [-ManagedBy ] + [-MemberDepartRestriction ] + [-MemberJoinRestriction ] + [-Members ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Notes ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RequireSenderAuthenticationEnabled ] + [-RoomList] + [-SamAccountName ] + [-SendModerationNotifications ] + [-Type ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use the New-DistributionGroup cmdlet to create the following types of groups: + +- Mail-enabled universal security groups (USGs) +- Universal distribution groups + +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). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. + +## EXAMPLES + +### Example 1 +```powershell +New-DistributionGroup -Name "Managers" -Type "Security" +``` + +This example creates a mail-enabled security group named Managers without specifying any members. + +You use the Add-DistributionGroupMember cmdlet to add members after you create the group. + +### Example 2 +```powershell +New-DistributionGroup -Name "ITDepartment" -Members chris@contoso.com,michelle@contoso.com,laura@contoso.com,julia@contoso.com +``` + +This example creates a distribution group named ITDepartment and specifies the members. + +## PARAMETERS + +### -Name +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -BccBlocked +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassNestedModerationEnabled +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. + +This parameter can be used only by top-level organization and tenant administrators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyOwnerToMember +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +This parameter is available only in the cloud-based service. + +{{ Fill Description Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenGroupMembershipEnabled +This parameter is available only in the cloud-based service. + +The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from users who aren't members of the group. You don't need to specify a value with this switch. + +You can use this setting to help comply with regulations that require you to hide group membership from members or outsiders (for example, a distribution group that represents students enrolled in a class). + +**Note**: If you create the group with hidden membership, you can't edit the group later to reveal the membership to the group. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreNamingPolicy +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +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 +- Add or remove group members +- Delete the group +- Approve member depart or join requests (if available) +- Approve messages sent to the group if moderation is enabled, but no moderators are specified. + +The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). + +Considerations for mail-enabled security groups as group owners: + +- If you specify a mail-enabled security group as a group owner in on-premises Exchange, the mail-enabled security group doesn't sync to the cloud object. +- Group management in Outlook doesn't work if the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. If you specify a mail-enabled security group as the owner of the group, the group isn't visible in **Distribution groups I own** for the group owners (members of the mail-enabled security group). + +You can use any value that uniquely identifies the owner. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple owners, use the following syntax: `Owner1,Owner2,...OwnerN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Owner1","Owner2",..."OwnerN"`. + +Owners that you specify with this parameter are not automatically added as group members. Use the CopyOwnerToMember switch or manually add the owners as members. + +**Note**: Group management in Outlook doesn't work when the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberDepartRestriction +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberJoinRestriction +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Members +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +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. + +The maximum number of entries for this parameter is 10000. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +For mail-enabled security groups, you need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +For distribution groups, if you set the ModerationEnabled parameter to the value $true, but you don't use this parameter to specify any moderators, the group owners that are specified by the ManagedBy parameter are responsible for approving messages sent to the group. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +The default value is $true. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomList +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +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. +- Security: A mail-enabled security group. These groups can have permissions assigned. + +The group's scope is always Universal. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/New-DkimSigningConfig.md b/exchange/exchange-ps/exchange/New-DkimSigningConfig.md similarity index 75% rename from exchange/exchange-ps/exchange/antispam-antimalware/New-DkimSigningConfig.md rename to exchange/exchange-ps/exchange/New-DkimSigningConfig.md index ac8bde754c..5bd296a8ba 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/New-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/New-DkimSigningConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-DkimSigningConfig @@ -13,25 +16,30 @@ This cmdlet is available only in the cloud-based service. Use the New-DkimSigningConfig cmdlet to create the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DkimSigningConfig [-DomainName] [-Enabled] <$true | $false> - [-AdminDisplayName ] [-BodyCanonicalization ] [-Confirm] - [-HeaderCanonicalization ] [-KeySize ] [-WhatIf] [] +New-DkimSigningConfig [-DomainName] [-Enabled] + [-AdminDisplayName ] + [-BodyCanonicalization ] + [-Confirm] + [-HeaderCanonicalization ] + [-KeySize ] + [-WhatIf] + [] ``` ## DESCRIPTION -DKIM in Microsoft Office 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. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-DkimSigningConfig -DomainName contoso.com -Enabled $true ``` @@ -51,6 +59,7 @@ Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: 1 Default value: None @@ -61,15 +70,15 @@ Accept wildcard characters: False ### -Enabled The Enabled parameter specifies whether the policy is enabled. Valid values are: -- $true: The policy is enabled. This is the default value. - +- $true: The policy is enabled. - $false: The policy is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: 2 Default value: None @@ -85,6 +94,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -96,14 +106,14 @@ Accept wildcard characters: False 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. - - Simple: Only changes in empty lines at the end of the message body are tolerated. ```yaml -Type: Simple | Relaxed +Type: CanonicalizationType Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -114,8 +124,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -123,6 +132,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -134,14 +144,14 @@ Accept wildcard characters: False 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. - - Simple: No changes to the header fields are tolerated. ```yaml -Type: Simple | Relaxed +Type: CanonicalizationType Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -150,13 +160,19 @@ Accept wildcard characters: False ``` ### -KeySize -The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. The only available value is 1024. +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) +- 2048 + +RSA keys are supported. Ed25519 keys aren't supported. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -172,6 +188,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -180,20 +197,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d33f240d-2bea-47d9-98d7-ce84bb75bc78.aspx) diff --git a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md new file mode 100644 index 0000000000..53dccb7f13 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md @@ -0,0 +1,1061 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpCompliancePolicy + +## 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-DlpCompliancePolicy cmdlet to create data loss prevention (DLP) policies in the Microsoft Purview compliance portal. DLP policies contain DLP rules that identify, monitor, and protect sensitive information. + +For 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-DlpCompliancePolicy [-Name] + [-Comment ] + [-Confirm] + [-EndpointDlpAdaptiveScopes ] + [-EndpointDlpAdaptiveScopesException ] + [-EndpointDlpExtendedLocations ] + [-EndpointDlpLocation ] + [-EndpointDlpLocationException ] + [-EnforcementPlanes ] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] + [-ExchangeLocation ] + [-ExchangeSenderMemberOf ] + [-ExchangeSenderMemberOfException ] + [-Force] + [-IsFromSmartInsights ] + [-Locations ] + [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] + [-OneDriveLocation ] + [-OneDriveLocationException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] + [-OnPremisesScannerDlpLocation ] + [-OnPremisesScannerDlpLocationException ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-PowerBIDlpLocation ] + [-PowerBIDlpLocationException ] + [-Priority ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-SharePointLocation ] + [-SharePointLocationException ] + [-TeamsAdaptiveScopes ] + [-TeamsAdaptiveScopesException ] + [-TeamsLocation ] + [-TeamsLocationException ] + [-ThirdPartyAppDlpLocation ] + [-ThirdPartyAppDlpLocationException ] + [-ValidatePolicy] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-DlpCompliancePolicy -Name "GlobalPolicy" -SharePointLocation All +``` + +This example creates a DLP policy named GlobalPolicy that will be enforced across all SharePoint locations. + +### Example 2 +```powershell +New-DlpCompliancePolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePointLocation "https://my.url/","https://my.url2/" -OneDriveLocation "https://my.url3/","https://my.url4/" -Mode Enable +``` + +This example creates a DLP policy named GlobalPolicy for the specified SharePoint and OneDrive locations. The new policy has a descriptive comment and will be enabled on creation. + +### Example 3 +```powershell +New-DlpCompliancePolicy -Name "PowerBIPolicy" -Comment "Primary policy" -PowerBIDlpLocation "All" -PowerBIDlpLocationException "workspaceID1","workspaceID2","workspaceID3" -Mode Enable +``` + +This example creates a DLP policy named PowerBIPolicy for all qualifying Power BI workspaces (that is, those hosted on Premium Gen2 capacities) except for the specified workspaces. The new policy has a descriptive comment and will be enabled on creation. + +### Example 4 +```powershell +Get-Label | Format-List Priority,ContentType,Name,DisplayName,Identity,Guid + +$guidVar = "e222b65a-b3a8-46ec-ae12-00c2c91b71c0" + +$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{Type:"Tenant", Identity:"All"}]}]" + +New-DLPCompliancePolicy -Name "Copilot Policy" -Locations $loc + +$advRule = @{ + "Version" = "1.0" + "Condition" = @{ + "Operator" = "And" + "SubConditions" = @( + @{ + "ConditionName" = "ContentContainsSensitiveInformation" + "Value" = @( + @{ + "groups" = @( + @{ + "Operator" = "Or" + "labels" = @( + @{ + "name" = $guidVar + "type" = "Sensitivity" + } + ) + "name" = "Default" + } + ) + } + ) + } + ) + } +} | ConvertTo-Json -Depth 100 + +New-DLPComplianceRule -Name "Copilot Rule" -Policy "Copilot Policy" -AdvancedRule $advrule -RestrictAccess @(@{setting="ExcludeContentProcessing";value="Block"}) +``` + +This example creates a DLP policy for Microsoft 365 Copilot (Preview) in several steps: + +- The first command returns information about all sensitivity labels. Select the GUID value of the sensitivity label that you want to use. For example, `e222b65a-b3a8-46ec-ae12-00c2c91b71c0`. + +- The second command stores the GUID value of the sensitivity label in the variable named `$guidVar`. + +- The third command stores the Microsoft 365 Copilot location (`470f2276-e011-4e9d-a6ec-20768be3a4b0`) in the variable named `$loc`. Update the `$loc` value based on the Inclusions/Exclusions scoping that you want to provide. + +- The fourth command creates the DLP policy using the `$loc` variable for the value of the Locations parameter, and "Copilot Policy" as the name of the policy (use any unique name). + +- The fifth command creates the variable named `$advRule`. The advanced rule needs to be updated depending on the grouping of labels you want to provide as input. + +- The last command creates the DLP rule with the name "Copilot Rule" (use any unique name). Use the name of the DLP policy from step four as the value of the Policy parameter. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopes +{{ Fill EndpointDlpAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopesException +{{ Fill EndpointDlpAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpExtendedLocations +{{ Fill EndpointDlpExtendedLocations Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpLocation +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The EndpointDLPLocation parameter specifies the user accounts to include in the DLP policy for Endpoint DLP when they are logged on to an onboarded device. You identify the account by name or email address. You can use the value All to include all user accounts. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpLocationException +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The EndpointDlpLocationException parameter specifies the user accounts to exclude from Endpoint DLP when you use the value All for the EndpointDlpLocation parameter. You identify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementPlanes +The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: + +`-EnforcementPlanes @("")`. + +Currently, the only supported value is Entra, for use with policies applied to an Entra-registered enterprise application in the organization. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedBy +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedByMemberOf +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: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies whether to include email messages in the DLP policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). + +You can use this parameter in the following procedures: + +- If you use `-ExchangeLocation All` by itself, the policy applies to email for all users. + +- To include email of specific group members in the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific group members from the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOf +The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSenderMemberOfException parameter. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOfException +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: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFromSmartInsights +{{ Fill IsFromSmartInsights Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The Locations parameter specifies to whom, what, and where the DLP policy applies. This parameter uses the following properties: + +- Workload: What the DLP policy applies to. Use the value `Applications`. +- Location: Where the DLP policy applies. For Microsoft 365 Copilot, (Preview), use the value `470f2276-e011-4e9d-a6ec-20768be3a4b0`. +- Inclusions: Who the DLP policy applies to. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For security groups or distribution groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group,Identity:}`. For the entire tenant, use this value: `{Type:"Tenant",Identity:"All"}`. +- Exclusions: Exclude security groups, distribution groups, or users from the scope of this DLP policy. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group, Identity:}`. + +You create and store the properties in a variable as shown in the following examples: + +DLP policy scoped to all users in the tenant: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{Type:"Tenant",Identity:"All"}]}]"` + +DLP policy scoped to the specified user and groups: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"},{"Type":"Group","Identity":"b4dc1e1d-8193-4525-b59c-6d6e0f1718d2"},{"Type":"IndividualResource","Identity":"yibing@contoso.com"}]}]"` + +DLP policy scoped to all users in the tenant except for members of the specified group: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{Type:"Tenant",Identity:"All"}]}],"Exclusions":[{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"}]}]"` + +After you create the `$loc` variable as shown in the previous examples, use the value `$loc` for this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: + +- Enable: The policy is enabled for actions and notifications. This is the default value. +- Disable: The policy is disabled. +- TestWithNotifications: Simulation mode where no actions are taken, but notifications **are** sent. +- TestWithoutNotifications: Simulation mode where no actions are taken, and no notifications are sent. + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocation +The OneDriveLocation parameter specifies whether to include OneDrive sites in the policy. A valid value for this parameter is All, which is also the default value. + +You can use this parameter in the following procedures: + +- To include sites of specific OneDrive accounts in the policy, use the OneDriveSharedBy parameter to specify the users. Only sites of the specified users are included in the policy. + +- To include sites of specific group members in the policy, use the OneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are included in the policy. + +- To exclude sites of specific OneDrive accounts from the policy, use the ExceptIfOneDriveSharedBy parameter to specify the users. Only sites of the specified users are excluded from the policy. + +- To exclude sites of specific group members from the policy, use the ExceptIfOneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are excluded from the policy. + +- If you use `-OneDriveLocation $null`, the policy does not apply to OneDrive sites. + +You can't specify inclusions and exclusions in the same policy. + +**Note**: Although this parameter accepts site URLs, don't specify site URLs values. Use the OneDriveSharedBy, ExceptIfOneDriveShareBy, OneDriveSharedByMemberOf, and ExceptIfOneDriveSharedByMemberOf parameters instead. In the DLP policy settings in the Microsoft Defender portal, you can't identify sites by URL; you specify sites only by users or groups. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocationException +Don't use this parameter. See the OneDriveLocation parameter for an explanation. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedBy +The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedByMemberOf +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: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesScannerDlpLocation +The OnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to include in the DLP policy. You can use the value All to include all on-premises file shares and SharePoint document libraries and folders. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesScannerDlpLocationException +The OnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to exclude from the DLP policy if you use the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. + +For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PowerBIDlpLocation +The PowerBIDlpLocation parameter specifies the Power BI workspace IDs to include in the DLP policy. Only workspaces hosted in Premium Gen2 capacities are permitted. You can use the value All to include all supported workspaces. + +You can find the workspace ID using any of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the **Get-PowerBIWorkspace** cmdlet. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +**Note**: You can't use this parameter if the DLP policy applies to other locations. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PowerBIDlpLocationException +The PowerBIDlpLocationException parameter specifies the Power BI workspace IDs to exclude from the DLP policy when you use the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using any of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the **Get-PowerBIWorkspace** cmdlet. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. + +Valid values and the default value depend on the number of existing policies. For example, if there are 5 existing policies: + +- Valid priority values for the existing 5 policies are from 0 through 4. +- Valid priority values for a new 6th policy are from 0 through 5. +- The default value for a new 6th policy is 5. + +If you modify the priority value of a policy, the position of the policy in the list changes to match the priority value you specify. In other words, if you set the priority value of a policy to the same value as an existing policy, the priority value of the existing policy and all other lower priority policies after it is increased by 1. + +```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 +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +The SharePointLocation parameter specifies the SharePoint 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: `"","",...""`. + +```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 +``` + +### -SharePointLocationException +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: `"","",...""`. + +```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 +``` + +### -TeamsAdaptiveScopes +{{ Fill TeamsAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAdaptiveScopesException +{{ Fill TeamsAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLocation +The TeamsLocation parameter specifies the Teams chat and channel messages to include in the DLP policy. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. You can use the value All to include all accounts, distribution groups, and mail-enabled security groups. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLocationException +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: `"","",...""`. + +```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 +``` + +### -ThirdPartyAppDlpLocation +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The ThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to include in the DLP policy. You can use the value All to include all connected apps. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyAppDlpLocationException +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The ThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to exclude from the DLP policy when you use the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidatePolicy +{{ Fill ValidatePolicy Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md new file mode 100644 index 0000000000..177d38fa19 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -0,0 +1,3634 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpComplianceRule + +## 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-DlpComplianceRule to create data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule matches. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DlpComplianceRule [-Name] -Policy + [-AccessScope ] + [-ActivationDate ] + [-AddRecipients ] + [-AdvancedRule ] + [-AlertProperties ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-ApplyBrandingTemplate ] + [-ApplyHtmlDisclaimer ] + [-AttachmentIsNotLabeled ] + [-BlockAccess ] + [-BlockAccessScope ] + [-Comment ] + [-Confirm] + [-ContentCharacterSetContainsWords ] + [-ContentContainsSensitiveInformation ] + [-ContentExtensionMatchesWords ] + [-ContentFileTypeMatches ] + [-ContentIsNotLabeled ] + [-ContentIsShared ] + [-ContentPropertyContainsWords ] + [-Disabled ] + [-DocumentContainsWords ] + [-DocumentCreatedBy ] + [-DocumentCreatedByMemberOf ] + [-DocumentIsPasswordProtected ] + [-DocumentIsUnsupported ] + [-DocumentMatchesPatterns ] + [-DocumentNameMatchesPatterns ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] + [-DomainCountOver ] + [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] + [-EndpointDlpRestrictions ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfContentCharacterSetContainsWords ] + [-ExceptIfContentContainsSensitiveInformation ] + [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentFileTypeMatches ] + [-ExceptIfContentIsShared ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentContainsWords ] + [-ExceptIfDocumentCreatedBy ] + [-ExceptIfDocumentCreatedByMemberOf ] + [-ExceptIfDocumentIsPasswordProtected ] + [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentMatchesPatterns ] + [-ExceptIfDocumentNameMatchesPatterns ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] + [-ExceptIfFromScope ] + [-ExceptIfHasSenderOverride ] + [-ExceptIfHeaderContainsWords ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] + [-ExceptIfProcessingLimitExceeded ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderADAttributeContainsWords ] + [-ExceptIfSenderADAttributeMatchesPatterns ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderIPRanges ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSubjectContainsWords ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfUnscannableDocumentExtensionIs ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] + [-FromScope ] + [-GenerateAlert ] + [-GenerateIncidentReport ] + [-HasSenderOverride ] + [-HeaderContainsWords ] + [-HeaderMatchesPatterns ] + [-ImmutableId ] + [-IncidentReportContent ] + [-MessageIsNotLabeled ] + [-MessageSizeOver ] + [-MessageTypeMatches ] + [-MipRestrictAccess ] + [-Moderate ] + [-ModifySubject ] + [-NonBifurcatingAccessScope ] + [-NotifyAllowOverride ] + [-NotifyEmailCustomSenderDisplayName ] + [-NotifyEmailCustomSubject ] + [-NotifyEmailCustomText ] + [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] + [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] + [-NotifyPolicyTipCustomText ] + [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] + [-NotifyUser ] + [-NotifyUserType ] + [-OnPremisesScannerDlpRestrictions ] + [-PrependSubject ] + [-Priority ] + [-ProcessingLimitExceeded ] + [-Quarantine ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] + [-RecipientDomainIs ] + [-RedirectMessageTo ] + [-RemoveHeader ] + [-RemoveRMSTemplate ] + [-ReportSeverityLevel ] + [-RestrictAccess ] + [-RestrictBrowserAccess ] + [-RuleErrorAction ] + [-SenderADAttributeContainsWords ] + [-SenderADAttributeMatchesPatterns ] + [-SenderAddressLocation ] + [-SenderDomainIs ] + [-SenderIPRanges ] + [-SentTo ] + [-SentToMemberOf ] + [-SetHeader ] + [-SharedByIRMUserRisk ] + [-StopPolicyProcessing ] + [-SubjectContainsWords ] + [-SubjectMatchesPatterns ] + [-SubjectOrBodyContainsWords ] + [-SubjectOrBodyMatchesPatterns ] + [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] + [-UnscannableDocumentExtensionIs ] + [-ValidateRule] + [-WhatIf] + [-WithImportance ] + [] +``` + +## DESCRIPTION +Each new rule must contain one condition filter or test, and one associated action. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-DlpComplianceRule -Name "SocialSecurityRule" -Policy "USFinancialChecks" -ContentContainsSensitiveInformation @{Name="U.S. Social Security Number (SSN)"} -BlockAccess $True +``` + +This example creates a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. + +### Example 2 +```powershell +$contains_complex_types = @{ + operator = "And" + groups = @( + @{ + operator = "Or" + name = "PII Identifiers" + sensitivetypes = @( + @{ + name = "Drug Enforcement Agency (DEA) Number" + maxconfidence = 100 + minconfidence = 75 + mincount = 1 + maxcount = -1 + } + ) + } + @{ + operator = "Or" + name = "Medical Terms" + sensitivetypes = @( + @{ + name = "International Classification of Diseases (ICD-9-CM)" + maxconfidence = 100 + minconfidence = 75 + mincount = 1 + maxcount = -1 + } + @{ + name = "International Classification of Diseases (ICD-10-CM)" + maxconfidence = 100 + minconfidence = 75 + mincount = 1 + maxcount = -1 + } + ) + } + + ) +} + +New-DLPComplianceRule -Name "Contoso Medical Information" -Policy "Contoso Medical Checks" -ContentContainsSensitiveInformation $contains_complex_types +``` + +This example creates a new DLP compliance rule named "Contoso Medical Information". The rule is assigned to the "Contoso Medical Checks" policy. It uses advanced syntax to search for the specified content. + +### Example 3 +```powershell +Contents of the file named C:\Data\Sensitive Type.txt: + +{ +"Version": "1.0", +"Condition": { + "Operator": "And", + "SubConditions": [ + { + "ConditionName": "ContentContainsSensitiveInformation", + "Value": [ + { + "groups": [ + { + "Operator": "Or", + "labels": [ + { + "name": "defa4170-0d19-0005-000a-bc88714345d2", + "type": "Sensitivity" + } + ], + "name": "Default", + "sensitivetypes": [ + { + "confidencelevel": "Low", + "name": "Credit Card Number" + } + ] + } + ] + } + ] + }, + { + "Operator": "Not", + "SubConditions": [ + { + "Operator": "OR", + "SubConditions": [ + { + "ConditionName": "FromMemberOf", + "Value": [ + "janesteam@contoso.com" + ] + }, + { + "ConditionName": "SentTo", + "Value": [ + "adele@contoso.com" + ] + } + ], + } + ] + } + ] + } +} + +$data = Get-Content -Path "C:\Data\Sensitive Type.txt" -ReadCount 0 -encoding Byte + +$string = [System.Text.Encoding]::UTF8.GetString($data) + +New-DLPComplianceRule -Name "Contoso Rule 1" -Policy "Contoso Policy 1" -AdvancedRule $string -NotifyUser +``` + +This example uses the AdvancedRule parameter to read the following complex condition from a file: "Content contains sensitive information: "Credit card number OR Highly confidential" AND (NOT (Sender is a member of "Jane's Team" OR Recipient is "adele@contoso.com")). + +### Example 4 +```powershell + +$myEntraAppId = "" + +$myEntraAppName = "" + +$locations = "[{`"Workload`":`"Applications`",`"Location`":`"$myEntraAppId`",`"LocationDisplayName`":`"$myEntraAppName`",`"LocationSource`":`"Entra`",`"LocationType`":`"Individual`",`"Inclusions`":[{`"Type`":`"Tenant`",`"Identity`":`"All`"}]}]" + +New-DlpCompliancePolicy -Name "Test Entra DLP" -Mode Enable -Locations $locations -EnforcementPlanes @("Entra") + +New-DlpComplianceRule -Name "Test Entra Rule" -Policy "Test Entra DLP" -ContentContainsSensitiveInformation @{Name = "credit card number"} -GenerateAlert $true -GenerateIncidentReport @("siteadmin") -NotifyUser @("admin@contonso.onmicrosoft.com") -RestrictAccess @(@{setting="UploadText";value="Block"}) +``` + +This is an example of applying a CCSI-based DLP rule that should be handled by an entra-registered enterprise application in the organization. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +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: + +- Name +- Distinguished name (DN) +- GUID +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessScope +The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: + +- InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule is applied to content that's accessible or delivered to a recipient outside the organization. +- None: The condition isn't used. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivationDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddRecipients +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"}`. +- `@{AddManagerAsRecipientType = ""}`. For example, `@{AddManagerAsRecipientType = "Bcc"}`. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedRule +The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. + +This parameter uses JSON syntax that's similar to the traditional advanced syntax in Example 2, but read from a file that contains additional operators and combinations that aren't traditionally supported. + +For syntax details, see Example 3. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertProperties +{{ Fill AlertProperties Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +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"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyBrandingTemplate +The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). + +Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimer +The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. + +- 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. +- Location: Specifies where to insert the HTML disclaimer text in the body of messages. Append = Add to the end of the message body. Prepend = Insert at the beginning of the message body. +- FallbackAction: Specifies what to do if the HTML disclaimer can't be added to a message. Wrap = The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. Ignore = The rule is ignored and the message is delivered without the disclaimer. Reject = The message is rejected. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsNotLabeled +{{ Fill AttachmentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockAccess +The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: + +- $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. + +```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 +``` + +### -BlockAccessScope +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. +- PerUser: Blocks access to external users. +- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -ContentCharacterSetContainsWords +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`. + +```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 +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +For an example of advanced syntax, see Example 2 in this topic. + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentExtensionMatchesWords +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFileTypeMatches +{{ Fill ContentFileTypeMatches Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsNotLabeled +The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: + +- $true: Look for attachments or documents that aren't labeled. +- $false: Don't look for unlabeled attachments or documents. + +In Exchange, this condition is matched only if both the attachment and the message body aren't labeled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsShared +The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: + +- $true: Look for attachments or documents that aren't labeled. +- $false: Don't look for unlabeled attachments or documents. + +In Exchange, this condition is matched only if both the attachment and the message body aren't labeled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPropertyContainsWords +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: + +- $true: The rule is disabled. +- $false: The rule is enabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentContainsWords +The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. + +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedBy +The DocumentCreatedBy parameter specifies a condition for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. + +This parameter applies to Sharepoint and Onedrive workloads. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedByMemberOf +The DocumentCreatedByMemberOf parameter specifies a condition for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. + +This parameter applies to Sharepoint and Onedrive workloads. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsPasswordProtected +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsUnsupported +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. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentMatchesPatterns +The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentNameMatchesPatterns +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. + +```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 +``` + +### -DocumentNameMatchesWords +The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentSizeOver +The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -DomainCountOver +The DomainCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipient domains is greater than the specified value. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -EncryptRMSTemplate +The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). + +Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. + +```yaml +Type: RmsTemplateIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpBrowserRestrictions +{{ Fill EndpointDlpBrowserRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpRestrictions +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. + +The `` value is one of the supported values. + +The available values for `` are: Audit, Block, Ignore, or Warn. + +Example values: + +- `@{"Setting"="Print"; "Value"="Block"}` +- `@{"Setting"="CopyPaste"; "Value"="Block";}` +- `@{"Setting"="ScreenCapture"; "Value"="Block";}` +- `@{"Setting"="RemovableMedia"; "Value"="Block";}` +- `@{"Setting"="NetworkShare"; "Value"="Block";}` +- `@{"Setting"="Print"; "Value"="Audit";}` +- `@{"Setting"="UnallowedApps"; "Value"="notepad"; "value2"="Microsoft Notepad"}` + +When you use the values Block or Warn in this parameter, you also need to use the NotifyUser parameter. + +You can view and configure the available restrictions with the Get-PolicyConfig and Set-PolicyConfig cmdlets. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcePortalAccess +The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: + +- $true: External recipients are required to use the encrypted message portal to view encrypted messages. +- $false: External recipients aren't required to use the encrypted message portal. Outlook can decrypt messages inline. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvaluateRulePerComponent +The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: + +- $true: A DLP rule match for conditions and exceptions must be in the same message component (for example, in the message body or in a single attachment). +- $false: A DLP rule match for conditions and exceptions can be anywhere in the message. + +For example, say a DLP rule is configured to block messages that contain three or more Social Security numbers (SSNs). When the value of this parameter is $true, a message is blocked only if there are three or more SSNs in the message body, or there are three or more SSNs in a specific attachment. The DLP rule doesn't match and the message isn't blocked if there are two SSNs in the message body, one SSN in an attachment, and two SSNs in another attachment in the same email message. + +This parameter works with the following conditions or exceptions only: + +- Content contains +- Attachment contains +- Attachment is not labeled +- File extension is + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAccessScope +The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: + +- InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule isn't applied to content that's accessible or delivered to a recipient outside the organization. +- None: The exception isn't used. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentCharacterSetContainsWords +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. + +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`. + +```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 +``` + +### -ExceptIfContentContainsSensitiveInformation +The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentExtensionMatchesWords +The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentFileTypeMatches +{{ Fill ExceptIfContentFileTypeMatches 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 +``` + +### -ExceptIfContentIsShared +The ContentIsNotLabeled parameter specifies an exception for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: + +- $true: Look for attachments or documents that aren't labeled. +- $false: Don't look for unlabeled attachments or documents. + +In Exchange, this condition is matched only if both the attachment and the message body aren't labeled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the 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"`. + +```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 +``` + +### -ExceptIfDocumentContainsWords +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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedBy +The DocumentCreatedBy parameter specifies an exception for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. + +This parameter applies to Sharepoint and Onedrive workloads. + +```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 +``` + +### -ExceptIfDocumentCreatedByMemberOf +The DocumentCreatedByMemberOf parameter specifies an exception for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. + +This parameter applies to Sharepoint and Onedrive workloads. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsPasswordProtected +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsUnsupported +The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: + +- $true: Look for unsupported files that can't be scanned. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesPatterns +The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentMatchesPatterns +The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +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"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromScope +The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: + +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasSenderOverride +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. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```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 +``` + +### -ExceptIfHeaderContainsWords +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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +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. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageSizeOver +The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageTypeMatches +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. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfProcessingLimitExceeded +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. +- $false: Don't look for files where scanning couldn't complete. + +```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 +``` + +### -ExceptIfRecipientADAttributeContainsWords +The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeMatchesPatterns +The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeContainsWords +The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeMatchesPatterns +The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +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. + +```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 +``` + +### -ExceptIfSenderIPRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +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. + +```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 +``` + +### -ExceptIfSentToMemberOf +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectContainsWords +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"` +- 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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyMatchesPatterns +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. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfUnscannableDocumentExtensionIs +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files 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. + +```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 +``` + +### -ExceptIfWithImportance +The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +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"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromScope +The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: + +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateAlert +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. +- SiteAdmin + +You can specify multiple values separated by commas. + +The email message that's generated by this action contains a link to detailed information in the Microsoft Purview compliance portal (the details aren't in the email message itself). + +```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 +``` + +### -GenerateIncidentReport +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. +- SiteAdmin + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSenderOverride +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. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```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 +``` + +### -HeaderContainsWords +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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +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. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutableId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentReportContent +The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: + +- All +- Default +- DetectionDetails +- Detections +- DocumentAuthor +- DocumentLastModifier +- MatchedItem +- OriginalContent +- RulesMatched +- Service +- Severity +- Title + +You can specify multiple values separated by commas. You can only use the value "All" by itself. If you use the value "Default", the report includes the following content: + +- DocumentAuthor +- MatchedItem +- RulesMatched +- Service +- Title + +Therefore, any additional values that you use with the value "Default" are ignored. + +```yaml +Type: ReportContentOption[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageIsNotLabeled +{{ Fill MessageIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageSizeOver +The MessageSizeOver parameter specifies a condition for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTypeMatches +The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: + +- ApprovalRequest: Moderation request messages sent to moderators. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MipRestrictAccess +{{ Fill MipRestrictAccess Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Moderate +The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifySubject +The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. + +The `ReplaceStrategy=` property uses one of the following values: + +- Replace: Replaces all regular expression matches (the `Patterns=` value) in the subject with the `SubjectText=` value. +- Append: Removes all regular expression matches (the `Patterns=` value) in the subject and inserts the `SubjectText=` value at the end of the subject. +- Prepend: Removes all regular expression matches (the `Patterns=` value) and inserts the `SubjectText=` value at the beginning of the subject. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonBifurcatingAccessScope +The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: + +- HasInternal: At least one recipient is inside the organization. +- HasExternal: At least one recipient is outside the organization. +- None: The condition isn't used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyAllowOverride +The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: + +- FalsePositive: Allows overrides in the case of false positives. +- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only) +- WithoutJustification: Allows overrides without justification. +- WithJustification: Allows overrides with justification. + +You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. + +```yaml +Type: OverrideOption[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailCustomSenderDisplayName +{{ Fill NotifyEmailCustomSenderDisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailCustomSubject +The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. + +```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 +``` + +### -NotifyEmailCustomText +The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. + +This parameter has a 5000 character limit, and supports plain text, HTML tags, and the following tokens (variables): + +- %%AppliedActions%%: The actions applied to the content. +- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive site. +- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. +- %%BlockedMessageInfo%%: The details of the message that was blocked. Use this token to inform people of the details of the message that was blocked. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailExchangeIncludeAttachment +{{ Fill NotifyEmailExchangeIncludeAttachment Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailOnedriveRemediationActions +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEndpointUser +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +{{ Fill NotifyEndpointUser Description }} + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyOverrideRequirements +{{ Fill NotifyOverrideRequirements Description }} + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomDialog +{{ Fill NotifyPolicyTipCustomDialog Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomText +The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomTextTranslations +The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. + +Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. For example: `"en:PolicyTipInEnglish","zh:警告：这个文件含有非法内容","th:คำแนะนำนโยบายในไทย"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipDisplayOption +The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: + +- Tip: Displays policy tip at the top of the mail. This is the default value. +- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipUrl +The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUser +The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: + +- An email address. +- LastModifier +- Owner +- SiteAdmin + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUserType +The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: + +- NotSet +- Email +- PolicyTip +- Email,PolicyTip + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesScannerDlpRestrictions +{{ Fill OnPremisesScannerDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrependSubject +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that you specify. If the text contains spaces, enclose the value in quotation marks ("). + +Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new 9th rule that you add to the policy are from 0 through 8. +- The default value for a new 9th rule that you add to the policy is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingLimitExceeded +The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: + +- $true: Look for files where scanning couldn't complete. +- $false: Don't look for files where scanning couldn't complete. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quarantine +This parameter specifies an action or part of an action for the rule. + +The Quarantine parameter specifies an action that quarantines messages. Valid values are: + +- $true: The message is delivered to the hosted quarantine. +- $false: The message is not quarantined. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeContainsWords +The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeMatchesPatterns +The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientCountOver +The RecipientCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipients is greater than the specified value. Groups are counted as one recipient. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```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 +``` + +### -RedirectMessageTo +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveHeader +The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. + +The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveRMSTemplate +The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $False: The messages and attachments are not decrypted. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSeverityLevel +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. +- 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 +``` + +### -RestrictAccess +{{ Fill RestrictAccess Description }} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictBrowserAccess +{{ Fill RestrictBrowserAccess Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: + +- Ignore +- RetryThenBlock +- Blank (the value $null): This is the default value. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeContainsWords +The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeMatchesPatterns +The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +Note that message envelope searching is available only for the following conditions and exceptions: + +- From and ExceptIfFrom +- FromAddressContainsWords and ExceptIfFromAddressContainsWords +- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns +- FromMemberOf and ExceptIfFromMemberOf +- SenderDomainIs and ExceptIfSenderDomainIs + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +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. + +```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 +``` + +### -SenderIPRanges +The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +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. + +```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 +``` + +### -SentToMemberOf +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetHeader +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. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedByIRMUserRisk +The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: + +- FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) +- 797C4446-5C73-484F-8E58-0CCA08D6DF6C (Moderate Risk Level) +- 75A4318B-94A2-4323-BA42-2CA6DB29AAFE (Minor Risk Level) + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopPolicyProcessing +The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: + +- $true: Stop processing more rules. +- $false: Continue processing more rules after this one. + +```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 +``` + +### -SubjectContainsWords +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"` +- 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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyContainsWords +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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyMatchesPatterns +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. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyAppDlpRestrictions +{{ Fill ThirdPartyAppDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerPowerAutomateFlow +{{ Fill TriggerPowerAutomateFlow Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnscannableDocumentExtensionIs +The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files 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. + +```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 +``` + +### -ValidateRule +{{ Fill ValidateRule Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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 +``` + +### -WithImportance +The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md new file mode 100644 index 0000000000..27c440830a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpEdmSchema + +## 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-DlpEdmSchema cmdlet to create exact data match (EDM)-based classification schemas in the Microsoft Purview compliance portal. Such schemas can be used with data loss prevention (DLP) policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DlpEdmSchema [-FileData] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For an explanation and example of the EDM schema, see [Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-DlpEdmSchema -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\edm.xml')) -Confirm:$true +``` + +This example creates a new DLP EDM schema using the file named edm.xml in the folder C:\\My Documents. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the DLP EDM schema that you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/New-DlpFingerprint.md new file mode 100644 index 0000000000..cbd457cd29 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -0,0 +1,160 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpFingerprint + +## 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-DlpFingerprint cmdlet to create document fingerprints that are used with data loss prevention (DLP) sensitive information types in the Microsoft Purview compliance portal. Because the results of New-DlpFingerprint aren't stored outside of the sensitive information type, you always run New-DlpFingerprint and New-DlpSensitiveInformationType or Set-DlpSensitiveInformationType in the same PowerShell session. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DlpFingerprint [[-FileData] ] -Description + [-IsExact ] + [-Confirm] + [-ThresholdConfig ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$Patent_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Patent Template.docx)' + +$Patent_Fingerprint = New-DlpFingerprint -FileData $Patent_Template -Description "Contoso Patent Template" +``` + +This example creates a new document fingerprint based on the file C:\\My Documents\\Contoso Patent Template.docx. You store the new fingerprint as a variable so you can use it with the New-DlpSensitiveInformationType cmdlet in the same PowerShell session. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the file to use as a document fingerprint. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter specifies a description for the document fingerprint. + +```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 +``` + +### -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 +``` + +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md new file mode 100644 index 0000000000..10ac021e60 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md @@ -0,0 +1,189 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpKeywordDictionary + +## 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-DlpKeywordDictionary cmdlet to create data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DlpKeywordDictionary -Name + [-Confirm] + [-Description ] + [-DoNotPersistKeywords] + [-FileData ] + [-Organization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +After you create a custom sensitive information type that specifies the identity (GUID value) of the DLP keyword dictionary, the dictionary will appear in your list of sensitive information types, and you can use it in policies. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$Keywords = @("Aarskog's syndrome","Abandonment","Abasia","Abderhalden-Kaufmann-Lignac","Abdominalgia","Abduction contracture","Abetalipo proteinemia","Abiotrophy","Ablatio","ablation","Ablepharia","Abocclusion","Abolition","Aborter","Abortion","Abortus","Aboulomania","Abrami's disease","Abramo") + +$EncodedKeywords = $Keywords | ForEach-Object {[System.Text.Encoding]::Unicode.GetBytes($_+"`r`n")} + +New-DlpKeywordDictionary -Name "Diseases" -Description "Names of diseases and injuries from ICD-10-CM lexicon" -FileData $EncodedKeywords +``` + +This example creates a DLP keyword dictionary named Diseases by using the specified values. + +### Example 2 +```powershell +$Keywords = Get-Content "C:\My Documents\InappropriateTerms.txt" + +$EncodedKeywords = $Keywords | ForEach-Object {[System.Text.Encoding]::Unicode.GetBytes($_+"`r`n")} + +New-DlpKeywordDictionary -Name "Inappropriate Language" -Description "Unprofessional and inappropriate terminology" -FileData $EncodedKeywords +``` + +This example creates a DLP keyword dictionary named Inappropriate Language from the file C:\\My Documents\\InappropriateTerms.txt. The file contains one term on each line. + +## PARAMETERS + +### -Name +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 +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotPersistKeywords +{{ Fill DoNotPersistKeywords Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileData +The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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/policy-and-compliance-dlp/New-DlpPolicy.md b/exchange/exchange-ps/exchange/New-DlpPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpPolicy.md rename to exchange/exchange-ps/exchange/New-DlpPolicy.md index 7bf1740007..705a5e5e46 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpPolicy.md @@ -1,51 +1,78 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-DlpPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). Use the New-DlpCompliancePolicy and New-DlpComplianceRule cmdlets instead. -Use the New-DlpPolicy cmdlet to create data loss prevention (DLP) policies in your Exchange organization. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +Use the New-DlpPolicy cmdlet to create data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -New-DlpPolicy [[-Name] ] [-Confirm] [-Description ] [-DomainController ] - [-Mode ] [-Parameters ] [-State ] - [-Template ] [-TemplateData ] [-WhatIf] [] +New-DlpPolicy [[-Name] ] + [-Confirm] + [-Description ] + [-DomainController ] + [-Mode ] + [-Parameters ] + [-State ] + [-Template ] + [-TemplateData ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-DlpPolicy -Name "Contoso PII" -Template "U.S. Personally Identifiable Information (PII) Data" ``` This example creates a new DLP policy named Contoso PII with the following values: - The DLP policy is enabled and set to audit only. - - The DLP policy is based on the existing "U.S. Personally Identifiable Information (PII) Data" DLP policy template. ## PARAMETERS +### -Name +The Name parameter specifies a descriptive name for the DLP policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -53,6 +80,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -68,6 +96,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -76,8 +105,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -85,6 +112,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -96,35 +124,19 @@ Accept wildcard characters: False 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. - - AuditAndNotify: The actions specified by the DLP policy aren't enforced when a message matches the conditions specified by the policy, but the Policy Tip is displayed to the user in a supported email client. - - Enforce: The actions specified by the DLP policy are enforced when a message matches the conditions specified by the policy, and the Policy Tip is displayed to the user in a supported email client. By default, the value of this parameter is set to Audit when you create a new DLP policy. If the State parameter is set to Disabled, the value of the Mode parameter is irrelevant. ```yaml -Type: Audit | AuditAndNotify | Enforce +Type: RuleMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a descriptive name for the DLP policy. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -133,13 +145,14 @@ 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. -Valid input for this parameter is in the format: @{\="\";\="\"...}. +This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. ```yaml Type: Hashtable Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -151,10 +164,11 @@ Accept wildcard characters: False 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: Enabled | Disabled +Type: RuleState Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -170,6 +184,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -180,13 +195,14 @@ Accept wildcard characters: False ### -TemplateData The TemplateData parameter specifies an external DLP policy template file from which you can create a new DLP policy. You can't use the TemplateData and Template parameters in the same command. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -202,6 +218,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -210,20 +227,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6fac5dca-be09-4296-aebf-b12bb55ce4d3.aspx) diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md new file mode 100644 index 0000000000..961c0d2e48 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md @@ -0,0 +1,222 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpSensitiveInformationType + +## 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-DlpSensitiveInformationType cmdlet to create sensitive information type rules that use document fingerprints. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DlpSensitiveInformationType [[-Name] ] + [-Fingerprints ] + [-Confirm] + [-Description ] + [-FileData ] + [-IsExact ] + [-Locale ] + [-ThresholdConfig ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$Employee_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Employee Template.docx') + +$Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template" + +$Customer_Template = [System.IO.File]::ReadAllBytes('D:\Data\Contoso Customer Template.docx') + +$Customer_Fingerprint = New-DlpFingerprint -FileData $Customer_Template -Description "Contoso Customer Template" + +New-DlpSensitiveInformationType -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint[0],$Customer_Fingerprint[0] -Description "Message contains Contoso employee or customer information." +``` + +This example creates a new sensitive information type rule named "Contoso Employee-Customer Confidential" that uses the document fingerprints of the files C:\\My Documents\\Contoso Employee Template.docx and D:\\Data\\Contoso Customer Template.docx. + +## PARAMETERS + +### -Name +The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. + +The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fingerprints +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Description +The Description parameter specifies a description for the sensitive information type rule. + +```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 +``` + +### -FileData +{{ Fill FileData Description }} + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +The Locale parameter specifies the language that's associated with the sensitive information type rule. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +You can add additional language translations to the sensitive information type rule by using the Set-DlpSensitiveInformationType cmdlet. + +```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 +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md new file mode 100644 index 0000000000..ff65bcc045 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-DlpSensitiveInformationTypeRulePackage + +## 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-DlpSensitiveInformationTypeConfig cmdlet to import data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-DlpSensitiveInformationTypeRulePackage [-FileData] + [-Confirm] + [-MigrationId ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-DlpSensitiveInformationTypeRulePackage -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Sensitive Info Type Rule Collection.xml')) +``` + +This example imports the sensitive information type rule package C:\\My Documents\\External Sensitive Info Type Rule Collection.xml. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the sensitive information type rule package that you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationId +{{ Fill MigrationId 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 +``` + +### -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 + +[Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits) diff --git a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md new file mode 100644 index 0000000000..548bcc5965 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md @@ -0,0 +1,851 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-DynamicDistributionGroup cmdlet to create dynamic distribution groups. A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### PrecannedFilter +``` +New-DynamicDistributionGroup [-Name] -IncludedRecipients + [-Alias ] + [-ArbitrationMailbox ] + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DirectMembershipOnly ] + [-DisplayName ] + [-DomainController ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RecipientContainer ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### CustomFilter +``` +New-DynamicDistributionGroup [-Name] -RecipientFilter + [-Alias ] + [-ArbitrationMailbox ] + [-Confirm] + [-DirectMembershipOnly ] + [-DisplayName ] + [-DomainController ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RecipientContainer ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-DynamicDistributionGroup -Name "Marketing Group" -IncludedRecipients "MailboxUsers,MailContacts" -ConditionalDepartment "Marketing","Sales" +``` + +This example creates a dynamic distribution group named Marketing Group that contains all recipients who have a Department field that equals the strings "Marketing" or "Sales". Because we didn't use the OrganizationalUnit or RecipientContainer parameters, the group looks for recipients in the default location (typically, the Users container). + +### Example 2 +```powershell +New-DynamicDistributionGroup -Name "Washington Management Team" -RecipientFilter "(RecipientTypeDetails -eq 'UserMailbox') -and (Title -like 'Director*' -or Title -like 'Manager*') -and (StateOrProvince -eq 'WA')" -RecipientContainer "North America" +``` + +This example creates a dynamic distribution group named Washington Management Team that contains all users in the organizational unit named North America from Washington State whose titles start with "Director" or "Manager". + +## PARAMETERS + +### -Name +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientFilter +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). + +The maximum length for the RecipientFilter property is 2048 characters, including internal syntax. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ConditionalCompany +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute1 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute10 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute11 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute12 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute13 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute14 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute15 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute2 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute3 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute4 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute5 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute6 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute7 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute8 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute9 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalDepartment +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalStateOrProvince +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectMembershipOnly +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is typically the Users container in the domain of the Exchange server that you're connected to (also known as the recipient scope). In on-premises Exchange, you can change the recipient scope for the current PowerShell session by using the Set-AdServerSettings cmdlet. + +If you don't use the RecipientContainer parameter, the location of the dynamic distribution group is used for the RecipientContainer property (the default location, or the value you specify for the OrganizationalUnit parameter). + +**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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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 +- Canonical name +- Distinguished name (DN) +- GUID + +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). + +**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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..0f0e180485 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md @@ -0,0 +1,386 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: New-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-EOPProtectionPolicyRule cmdlet to create rules for Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +**Note**: Unless you manually removed a rule using the Remove-EOPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-EOPProtectionPolicyRule [-Name] [-Priority ] -AntiPhishPolicy -HostedContentFilterPolicy -MalwareFilterPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-EOPProtectionPolicyRule -Name "Standard Preset Security Policy" -AntiPhishPolicy "Standard Preset Security Policy1622650005393" -HostedContentFilterPolicy "Standard Preset Security Policy1622650006407" -MalwareFilterPolicy "Standard Preset Security Policy1622650007658" Priority 1 +``` + +This example creates the rule for the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. If the rule already exists, the command will fail. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiPhishPolicy +The AntiPhishPolicy parameter specifies the existing anti-phishing policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-phishing policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650005393`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034844713`. + +You can find the anti-phishing policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-AntiPhishPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `AntiPhishPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: AntiPhishPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedContentFilterPolicy +The HostedContentFilterPolicy parameter specifies the existing anti-spam policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-spam policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650006407`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034847393`. + +You can find the anti-spam policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-HostedContentFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-HostedContentFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareFilterPolicy +The HostedContentFilterPolicy parameter specifies the existing anti-malware policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-malware policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650007658`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034871908`. + +You can find the anti-malware policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-MalwareFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-MalwareFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: MalwareFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. +- $false: The rule is disabled. The State value of the rule is Disabled. + +After you create the rule, you turn on or turn off the preset security policy using one of the following commands: + +- Turn off: Disable-EOPProtectionPolicyRule. +- Turn on: Enable-EOPProtectionPolicyRule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +When you create the policy, you must use the default value. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/client-access-servers/New-EcpVirtualDirectory.md rename to exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md index c7d560b7ae..d888a64122 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-EcpVirtualDirectory @@ -15,25 +18,34 @@ Use the New-EcpVirtualDirectory cmdlet to create Exchange Control Panel (ECP) vi The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013, and Exchange 2016 servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-EcpVirtualDirectory [-AppPoolId ] [-Confirm] [-DomainController ] - [-ExtendedProtectionFlags ] [-ExtendedProtectionSPNList ] - [-ExtendedProtectionTokenChecking ] [-ExternalUrl ] [-InternalUrl ] - [-Path ] [-Server ] [-WebSiteName ] [-WhatIf] - [-Role ] [] +New-EcpVirtualDirectory [-AppPoolId ] + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-InternalUrl ] + [-Path ] + [-Role ] + [-Server ] + [-WebSiteName ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-EcpVirtualDirectory -Server SERVER01 -ExternalURL https://mail.contoso.com/ecp -InternalURL https://mail.contoso.com/ecp ``` @@ -49,6 +61,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -59,8 +72,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -68,6 +80,7 @@ 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 @@ -83,6 +96,7 @@ 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 @@ -94,13 +108,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -108,6 +118,7 @@ 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 @@ -119,14 +130,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -138,20 +149,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -169,6 +177,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -186,6 +195,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -201,6 +211,28 @@ Type: String 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 +``` + +### -Role +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. +- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. + +Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. + +```yaml +Type: VirtualDirectoryRole +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -212,11 +244,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - ExchangeLegacyDN You can't create an ECP virtual directory remotely. You can only create an ECP virtual directory on the local computer. @@ -226,6 +255,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -241,6 +271,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -256,27 +287,7 @@ 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 -``` - -### -Role -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. - -- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. - -Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. -```yaml -Type: ClientAccess | Mailbox -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -285,20 +296,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e788e191-5159-4995-9f4c-8643c025ac37.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-EdgeSubscription.md b/exchange/exchange-ps/exchange/New-EdgeSubscription.md similarity index 75% rename from exchange/exchange-ps/exchange/mail-flow/New-EdgeSubscription.md rename to exchange/exchange-ps/exchange/New-EdgeSubscription.md index 13ec64eee6..e7c67b1d70 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-EdgeSubscription.md +++ b/exchange/exchange-ps/exchange/New-EdgeSubscription.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-EdgeSubscription @@ -13,43 +16,52 @@ This cmdlet is available only in on-premises Exchange. Use the New-EdgeSubscription cmdlet to export an Edge Subscription file from an Edge Transport server and to import the Edge Subscription file to a Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-EdgeSubscription [-AccountExpiryDuration ] [-Confirm] - [-CreateInboundSendConnector <$true | $false>] [-CreateInternetSendConnector <$true | $false>] - [-DomainController ] [-FileData ] [-FileName ] [-Force] [-Site ] - [-WhatIf] [] +New-EdgeSubscription [-AccountExpiryDuration ] + [-Confirm] + [-CreateInboundSendConnector ] + [-CreateInternetSendConnector ] + [-DomainController ] + [-FileData ] + [-FileName ] + [-Force] + [-Site ] + [-WhatIf] + [] ``` ## 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 that will be imported on a Mailbox server in the Active Directory site to which you want to subscribe this Edge Transport server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -New-EdgeSubscription -FileName "c:\EdgeServerSubscription.xml" +### Example 1 +```powershell +New-EdgeSubscription -FileName "C:\Data\EdgeSubscription.xml" ``` This example creates the Edge Subscription file. It should be run on your Edge Transport server. -### -------------------------- Example 2 -------------------------- -``` -[byte[]]$Temp = Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0; New-EdgeSubscription -FileData $Temp -Site "Default-First-Site-Name" +### Example 2 +```powershell +$Temp = [System.IO.File]::ReadAllBytes('C:\Data\EdgeSubscription.xml') + +New-EdgeSubscription -FileData $Temp -Site "Default-First-Site-Name" ``` This example imports the Edge Subscription file generated in Example 1 to the Active Directory site Default-First-Site-Name. Importing the Edge Subscription file completes the Edge Subscription process. You must run this command on the Mailbox server. The first command reads the data from the Edge Subscription file and stores it in a temporary variable as a byte-encoded data object. The second command completes the Edge subscription process. -### -------------------------- Example 3 -------------------------- -``` -New-EdgeSubscription -FileData ([byte[]]$(Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0)) -Site "Default-First-Site-Name" +### Example 3 +```powershell +New-EdgeSubscription -FileData ([System.IO.File]::ReadAllBytes('C:\Data\EdgeSubscription.xml')) -Site "Default-First-Site-Name" ``` This example also imports the Edge Subscription file generated in Example 1 to the Active Directory site Default-First-Site-Name; however, the end result is accomplished using one command. You must run this command on the Mailbox server. @@ -68,6 +80,7 @@ Type: TimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -78,8 +91,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -87,6 +99,7 @@ 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 @@ -98,10 +111,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -113,10 +127,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -134,6 +149,7 @@ 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 @@ -144,15 +160,16 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). -You can only use this parameter when you're running this command on a Mailbox server. +You can only use this parameter when you're running the command on a Mailbox server. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,6 +187,7 @@ Type: LongPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -178,15 +196,19 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +This switch is useful in the following scenarios: -This switch is useful when you use a script with the Edge Subscription command because it bypasses confirmation. Another scenario in which this switch is useful is when you have to subscribe an Edge Transport server again and you want to overwrite the existing configuration information. +- Bypassing confirmation when you script the Edge Subscription command. +- Recreating an Edge Transport server subscription and overwriting the existing configuration information. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -202,6 +224,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -217,6 +240,7 @@ 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 @@ -225,20 +249,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/94c4a829-0ef4-4623-aeb9-b362f66f4a71.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/mail-flow/New-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md index d77e11d1f5..f961f43a6f 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-EdgeSyncServiceConfig @@ -13,37 +16,46 @@ This cmdlet is available only in on-premises Exchange. Use the New-EdgeSyncServiceConfig cmdlet to create edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-EdgeSyncServiceConfig [-ConfigurationSyncInterval ] [-Confirm] - [-CookieValidDuration ] [-DomainController ] [-FailoverDCInterval ] - [-LockDuration ] [-LockRenewalDuration ] [-LogEnabled <$true | $false>] - [-LogLevel ] [-LogMaxAge ] [-LogMaxDirectorySize ] - [-LogMaxFileSize ] [-LogPath ] [-OptionDuration ] - [-RecipientSyncInterval ] [-Site ] [-WhatIf] [] +New-EdgeSyncServiceConfig [-ConfigurationSyncInterval ] + [-Confirm] + [-CookieValidDuration ] + [-DomainController ] + [-FailoverDCInterval ] + [-LockDuration ] + [-LockRenewalDuration ] + [-LogEnabled ] + [-LogLevel ] + [-LogMaxAge ] + [-LogMaxDirectorySize ] + [-LogMaxFileSize ] + [-LogPath ] + [-OptionDuration ] + [-RecipientSyncInterval ] + [-Site ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-EdgeSyncServiceConfig -LogEnabled $true -LogPath "\\Server01\EdgeSyncLog" -LogMaxFileSize 5MB -LogMaxAge 3 ``` This example creates EdgeSync service settings with the following configuration: - EdgeSync logging is enabled. - - The log files are stored in the EdgeSyncLog share on Server01. - - The maximum individual log file size is 5 megabytes (MB). - - The log files are kept for 3 days. ## PARAMETERS @@ -58,6 +70,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -68,8 +81,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -77,6 +89,7 @@ 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 @@ -94,6 +107,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -109,6 +123,7 @@ 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 @@ -126,6 +141,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,6 +159,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -160,6 +177,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -171,10 +189,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -183,13 +202,19 @@ Accept wildcard characters: False ``` ### -LogLevel -The LogLevel parameter specifies the EdgeSync logging level. Valid values for this parameter are None, Low, Medium and High. The default value is None. +The LogLevel parameter specifies the EdgeSync logging level. Valid values are: + +- None (This is the default value) +- Low +- Medium +- High ```yaml -Type: None | Low | Medium | High +Type: EdgeSyncLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -207,6 +232,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -220,13 +246,9 @@ The LogMaxDirectorySize parameter specifies the maximum amount of disk space the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -238,6 +260,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -251,13 +274,9 @@ The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyn When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -269,6 +288,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -284,6 +304,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -301,6 +322,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -318,6 +340,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -333,6 +356,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -348,6 +372,7 @@ 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 @@ -356,20 +381,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/721a0666-1830-4072-9aff-1b54ee53080b.aspx) diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md new file mode 100644 index 0000000000..966babe33d --- /dev/null +++ b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md @@ -0,0 +1,886 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-EmailAddressPolicy cmdlet to create email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AllTemplatesWithPrecannedFilter +``` +New-EmailAddressPolicy [-Name] -EnabledEmailAddressTemplates -IncludedRecipients + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DisabledEmailAddressTemplates ] + [-DomainController ] + [-Priority ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### AllTemplatesWithCustomFilter +``` +New-EmailAddressPolicy [-Name] -EnabledEmailAddressTemplates -RecipientFilter + [-Confirm] + [-DisabledEmailAddressTemplates ] + [-DomainController ] + [-Priority ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### SMTPTemplateWithPrecannedFilter +``` +New-EmailAddressPolicy [-Name] -EnabledPrimarySMTPAddressTemplate -IncludedRecipients + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DomainController ] + [-Priority ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### SMTPTemplateWithCustomFilter +``` +New-EmailAddressPolicy [-Name] -EnabledPrimarySMTPAddressTemplate -RecipientFilter + [-Confirm] + [-DomainController ] + [-Priority ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### AllTemplatesForUnifiedGroupRecipientsFilter +``` +New-EmailAddressPolicy [-Name] -EnabledEmailAddressTemplates + [-IncludeUnifiedGroupRecipients] + [-ManagedByFilter ] + [-Confirm] + [-DisabledEmailAddressTemplates ] + [-DomainController ] + [-Priority ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### SMTPTemplateForUnifiedGroupRecipientsFilter +``` +New-EmailAddressPolicy [-Name] -EnabledPrimarySMTPAddressTemplate + [-IncludeUnifiedGroupRecipients] + [-ManagedByFilter ] + [-Confirm] + [-DomainController ] + [-Priority ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +## DESCRIPTION +After you use the New-EmailAddressPolicy cmdlet to create an email address policy in an on-premises Exchange organization, you need to use the Update-EmailAddressPolicy cmdlet to apply the new policy to recipients. + +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-EmailAddressPolicy -Name "Southeast Offices" -IncludedRecipients MailboxUsers -ConditionalStateorProvince "GA","AL","LA" -EnabledEmailAddressTemplates "SMTP:%s%2g@southeast.contoso.com","smtp:%s%2g@southeast.contoso.net" +``` + +This example creates an email address policy in an on-premises Exchange organization that uses a precanned recipient filter: + +- Name: Southeast Offices +- Precanned recipient filter: All users with mailboxes where the State or province value is GA, AL, or LA (Georgia, Alabama, or Louisiana). +- Primary SMTP email address: `.@contoso.com` +- Additional proxy email addresses: `.@contoso.net` +- Priority:N+1, where N is the number of manually created email address policies that already exist (we didn't use the Priority parameter, and the default value is N+1). + +### Example 2 +```powershell +New-EmailAddressPolicy -Name "Northwest Executives" -RecipientFilter "(RecipientTypeDetails -eq 'UserMailbox') -and (Title -like '*Director*' -or Title -like '*Manager*') -and (StateOrProvince -eq 'WA' -or StateOrProvince -eq 'OR' -or StateOrProvince -eq 'ID')" -EnabledEmailAddressTemplates "SMTP:%2g%s@contoso.com" -Priority 2 +``` + +This example creates an email address policy in an on-premises Exchange organization that uses a custom recipient filter: + +- Name: Northwest Executives +- Custom recipient filter: All users with mailboxes where the Title value contains Director or Manager, and the State or province value is WA, OR, or ID (Washington, Oregon, or Idaho). +- Primary SMTP email address: `@contoso.com` +- Additional proxy email addresses: None +- Priority: 2 + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledEmailAddressTemplates +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`: + +- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. + +This parameter requires at least one template with the Type value SMTP (to define the primary SMTP email address). After that, if you don't include a Type prefix for a template, the value smtp (an SMTP proxy address) is assumed. + +You can specify multiple email address templates separated by commas: `"SMTP:PrimarySMTPEmailAddress","[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. + +You can't use this parameter with the EnabledPrimarySMTPAddressTemplate parameter. + +In Exchange Online PowerShell, you can't use variables in the email address template. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledPrimarySMTPAddressTemplate +The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. + +Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. + +You can't use this parameter with the EnabledEmailAddressTemplates parameter. + +In Exchange Online PowerShell, you can't use variables in the email address template. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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: + +- AllRecipients: This value can be used only by itself. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: WellKnownRecipientType +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUnifiedGroupRecipients +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. + +In Exchange Online PowerShell, you always need to use this switch, because email address policies in Exchange Online are only applied to Microsoft 365 groups. + +```yaml +Type: SwitchParameter +Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientFilter +This parameter is available only in on-premises Exchange. + +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). + +```yaml +Type: String +Parameter Sets: AllTemplatesWithCustomFilter, SMTPTemplateWithCustomFilter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute1 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute10 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute11 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute12 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute13 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute14 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute15 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute2 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute3 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute4 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute5 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute6 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute7 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute8 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalCustomAttribute9 +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalDepartment +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -ConditionalStateOrProvince +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. + +When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledEmailAddressTemplates +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. +- 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedByFilter +This parameter is available only in the cloud-based service. + +The ManagedByFilter parameter specifies the email address policies to apply to Microsoft 365 Groups based on the properties of the users who create the Microsoft 365 Groups. + +This parameter is an OPATH filter that's based on the value of any available recipient property (for example, `"Department -eq 'Sales'"`). You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- You can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. + +For more information, see [Choose the domain to use when creating Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/admin/create-groups/choose-domain-to-create-groups). + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can only use this parameter in Exchange Online PowerShell with the IncludeUnifiedGroupRecipients switch. + +```yaml +Type: String +Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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. + +**Note**: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is the OU where the object was created. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ExchangeCertificate.md b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md new file mode 100644 index 0000000000..5d957d9ce7 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md @@ -0,0 +1,619 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ExchangeCertificate + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-ExchangeCertificate cmdlet to create and renew self-signed certificates, and to create certificate requests (also known as certificate signing requests or CSRs) for new certificates and certificate renewals from a certification authority (CA). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Request +``` +New-ExchangeCertificate [-BinaryEncoded] [-GenerateRequest] [-RequestFile ] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Force] + [-FriendlyName ] + [-IncludeAcceptedDomains] + [-IncludeAutoDiscover] + [-IncludeServerFQDN] + [-IncludeServerNetBIOSName] + [-Instance ] + [-KeySize ] + [-PrivateKeyExportable ] + [-Server ] + [-SubjectKeyIdentifier ] + [-SubjectName ] + [-WhatIf] + [] +``` + +### Certificate +``` +New-ExchangeCertificate [-Services ] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Force] + [-FriendlyName ] + [-IncludeAcceptedDomains] + [-IncludeAutoDiscover] + [-IncludeServerFQDN] + [-IncludeServerNetBIOSName] + [-Instance ] + [-KeySize ] + [-PrivateKeyExportable ] + [-Server ] + [-SubjectKeyIdentifier ] + [-SubjectName ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Exchange uses certificates for SSL and TLS encryption. + +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). + +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out [Protecting you against the SSL 3.0 vulnerability](https://azure.microsoft.com/blog/protecting-against-the-ssl-3-0-vulnerability/). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ExchangeCertificate +``` + +This example creates a self-signed certificate with the following settings: + +- The Subject value is `CN=` (for example, CN=Mailbox01). +- The Domains (subject alternative names) value is `,` (for example, `Mailbox01,Mailbox01.contoso.com`). +- The Services value is `IMAP,POP,SMTP`. +- The Services value SMTP grants the Network Services local security group read access to the certificate's private key. +- The Services value SMTP and the Subject value that contains the server name publishes the certificate to Active Directory so that Exchange direct trust can validate the authenticity of the server for mutual TLS. + +If you don't want this certificate to replace the existing self-signed certificate that was created during Exchange setup, be sure to select "No" in the prompt that asks you overwrite the existing default SMTP certificate. + +### Example 2 +```powershell +Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate -PrivateKeyExportable $true +``` + +This example shows how to renew a certificate with a specific thumbprint value. You can find the thumbprint value in one of two ways: + +- Select the certificate in the Exchange admin center and then select Edit to view properties of the certificate. The thumbprint value is shown in the Exchange Certificate window. +- Run the Get-ExchangeCertificate cmdlet to return a list of all certificates installed on the server with their thumbprint values. + +Setting the PrivateKeyExportable parameter to the value $true allows the renewed certificate to be exported from the server (and imported on other servers). + +### Example 3 +```powershell +New-ExchangeCertificate -GenerateRequest -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com -RequestFile "C:\Cert Requests\woodgrovebank.req" +``` + +In **Exchange 2013**, this example creates a new certificate request for a certification authority that has the following settings: + +- The request is Base64 encoded. +- The Subject value is `c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com`. +- The Domains (subject alternative names) value contains the additional valuesautodiscover.woodgrovebank.com, mail.fabrikam.com, and autodiscover.fabrikam.com. +- The command output is displayed onscreen and is also written to the text file C:\\Cert Requests\\woodgrovebank.req. + +**Note**: The RequestFile parameter is available only in Exchange 2013. To create a new certificate request file in Exchange 2016 or Exchange 2019, see Example 4 and Example 5. + +After you create the certificate request, you send the output to the CA. After you receive the certificate from the CA, you install the certificate by using the Import-ExchangeCertificate cmdlet, and you assign the certificate to Exchange services by using the Enable-ExchangeCertificate cmdlet. + +If the CA requires the certificate request in a file that's encoded by DER, use the BinaryEncoding switch and save the file with the .pfx extension. + +### Example 4 +```powershell +$txtrequest = New-ExchangeCertificate -GenerateRequest -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com + +[System.IO.File]::WriteAllBytes('\\FileServer01\Data\woodgrovebank.req', [System.Text.Encoding]::Unicode.GetBytes($txtrequest)) +``` + +This example creates a new Base64 encoded certificate request for a certification authority using the same certificate settings as Example 3. + +This method is required in Exchange 2016 and Exchange 2019 because the RequestFile parameter is not available. + +### Example 5 +```PowerShell +$binrequest = New-ExchangeCertificate -GenerateRequest -BinaryEncoded -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com + +[System.IO.File]::WriteAllBytes('\\FileServer01\Data\woodgrovebank.pfx', $binrequest.FileData) +``` + +This example creates a new DER encoded (binary) certificate request for a certification authority using the same certificate settings as Example 4. + +This method is required in Exchange 2016 and Exchange 2019 because the RequestFile parameter is not available. + +### Example 6 +```powershell +Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest -RequestFile "C:\Cert Requests\fabrikam_renewal.req" +``` + +In **Exchange 2013**, this example creates a request to renew an existing certificate that was issued by a certification authority. The certificate request has the following settings: + +- The thumbprint value of the existing certificate is 8A141F7F2BBA8041973399723BD2598D2ED2D831. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. +- The request is Base64 encoded. +- The output is displayed onscreen and is also written to the text file C:\\Cert Requests\\fabrikam\_renewal.req. + +**Note**: The RequestFile parameter is available only in Exchange 2013. To create a certificate renewal request for a certification authority in Exchange 2016 or Exchange 2019, see Example 7 and Example 8. + +After you create the certificate renewal request, you send the output to the CA. After you receive the renewed certificate from the CA, you install the certificate by using the Import-ExchangeCertificate cmdlet. + +### Example 7 +```powershell +$txtrequest = Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest + +[System.IO.File]::WriteAllBytes('C:\Cert Requests\fabrikam_renewal.req', [System.Text.Encoding]::Unicode.GetBytes($txtrequest)) +``` + +This example create a Base64 encoded certificate renewal request file for a certification authority using the same certificate settings as Example 6. + +This method is required in Exchange 2016 and Exchange 2019 because the RequestFile parameter is not available. + +### Example 8 +```powershell +$binrequest = Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest + +[System.IO.File]::WriteAllBytes('C:\Cert Requests\fabrikam_renewal.pfx', $binrequest.FileData) +``` + +This example creates a new DER encoded (binary) certificate renewal request file for a certification authority using the same certificate settings as Example 7. + +## PARAMETERS + +### -BinaryEncoded +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. + +This switch is available only when you use the GenerateRequest switch. + +For Base64 encoded requests, you send the contents of the file to the certificate authority. For requests that are encoded by DER, you send the certificate file itself. + +```yaml +Type: SwitchParameter +Parameter Sets: Request +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 +``` + +### -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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +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. + +Typically, values include server names (for example, Mailbox01) and FQDNs (for example, mail.contoso.com). You can specify multiple values separated by commas. Valuescan contain the characters a through z, 0 through 9, and the hyphen (-). The length of the domain name can't exceed 255 characters. + +The default value includes the name and FQDN of the Exchange server when both of the following conditions are true: + +- You don't use this parameter. +- You don't use any of these parameters: IncludeAcceptedDomains, IncludeAutoDiscover, IncludeServerFQDN, or IncludeServerNetBIOSName. + +```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: 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. + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +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. + +```yaml +Type: String +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 +``` + +### -GenerateRequest +The GenerateRequest switch specifies that you're creating a certificate request for a certification authority (CA). You don't need to specify a value with this switch. + +Using this switch and exporting the output to a file generates a PKCS #10 certificate request that you send to the CA. How you send the information depends on the CA, but typically, for Base64 encoded requests, you paste the contents in an email message or in the request form on the CA's web site. + +After you install the certificate from the certification authority by using the Import-ExchangeCertificate cmdlet, you use the Enable-ExchangeCertficate cmdlet to enable the certificate for Exchange services. + +If you don't use this switch, the command creates a new self-signed certificate on the Exchange server. + +```yaml +Type: SwitchParameter +Parameter Sets: Request +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 +``` + +### -IncludeAcceptedDomains +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: + +- If you've already included an accepted domain in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. +- For new self-signed certificates, if you don't use the Services parameter, the certificate is only assigned to SMTP. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAutoDiscover +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: + +- autodiscover.woodgrovebank.com +- autodiscover.woodgrovebank.co.uk + +When you use this switch: + +- If you've already included the value `autodiscover.` in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. +- For new self-signed certificates, if you don't use the Services parameter, the certificate is only assigned to SMTP. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeServerFQDN +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeServerNetBIOSName +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -KeySize +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) +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateKeyExportable +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. + +```yaml +Type: Boolean +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 +``` + +### -RequestFile +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate request to a file without using the RequestFile parameter, see Example 4 and Example 5 (new) or Example 7 and Example 8 (renew). + +This parameter is available only in Exchange 2013. + +The RequestFile parameter specifies the name and path of the certificate request file. The file contains the same information that's displayed on-screen when you generate a Base64 encoded certificate request (you don't use the BinaryEncoded switch). + +You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). + +You can use this parameter only when you use the GenerateRequest switch. + +```yaml +Type: String +Parameter Sets: Request +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Services +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. +- Federation +- IIS +- IMAP: Don't enable a wildcard certificate for the IMAP4 service. Instead, use the Set-ImapSettings cmdlet to configure the FQDN that clients use to connect to the IMAP4 service. +- POP: Don't enable a wildcard certificate for the POP3 service. Instead, use the Set-PopSettings cmdlet to configure the FQDN that clients use to connect to the POP3 service. +- SMTP: When you enable a certificate for SMTP, you're prompted to replace the default Exchange self-signed certificate that's used to encrypt SMTP traffic between internal Exchange. If you want to replace the default certificate without the confirmation prompt, use the Force switch. +- UM: This value requires that the UMStartupMode parameter on the Set-UMService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value of TCP, you can't enable the certificate for the UM service. +- UMCallRouter: This value requires that the UMStartupMode parameter on the Set-UMCallRouterService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value TCP, you can't enable the certificate for the UM Call Router service. + +You can specify multiple values separated by commas. The default values are IMAP, POP, and SMTP. + +You can't use this parameter with the GenerateRequest switch. + +Once you enable a certificate for a service, you can't remove the service from the certificate. + +```yaml +Type: AllowedServices +Parameter Sets: Certificate +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 +``` + +### -SubjectKeyIdentifier +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectName +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. + +This parameter uses the syntax: `[C=CountryOrRegion,S=StateOrProvince,L=LocalityOrCity,O=Organization,OU=Department],CN=HostNameOrFQDN`. Although the only required value is `CN=HostNameOrFQDN`, you should always include `C=CountryOrRegion` for certificate requests, but other values might also be required by the certification authority. + +For example, if you want the certificate's subject to be mail.contoso.com in the United States, you can use any of the following values: + +- C=US,S=WA,L=Redmond,O=Contoso,OU=IT,CN=mail.contoso.com +- C=US,O=Contoso,CN=mail.contoso.com +- C=US,CN=mail.contoso.com + +If you don't use this parameter, the default value is the name of the Exchange server where you run the command (for example, CN=Mailbox01). + +For a subject alternative name (SAN) certificate, you should choose one of the values from the DomainName parameter to use in the SubjectName value. In fact, the CN value that you specify for SubjectName is automatically included in the DomainName values. + +For a wildcard certificate, use a SubjectName value that contains the wildcard character (\*). For example, C=US,CN=\*.contoso.com. + +```yaml +Type: X500DistinguishedName +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 +``` + +### -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/New-ExchangeSettings.md b/exchange/exchange-ps/exchange/New-ExchangeSettings.md new file mode 100644 index 0000000000..abedc962ae --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ExchangeSettings.md @@ -0,0 +1,150 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ExchangeSettings + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-ExchangeSettings cmdlet to create customized Exchange setting objects that are stored in Active Directory. Use the Set-ExchangeSettings cmdlet to configure the actual settings. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ExchangeSettings [-Name] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ExchangeSettings -Name Audit +``` + +This example creates a new Exchange settings object for the Audit configuration schema. After you create the Exchange settings object, use the Set-ExchangeSettings cmdlet to define the settings. + +## PARAMETERS + +### -Name +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 +- Audit +- Compliance +- DirectoryTasks +- LinkedRoleGroup +- MRS +- MRSScripts +- Store +- TopologyService + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 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 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..cc46098b0a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-exophishsimoverriderule +applicable: Exchange Online +title: New-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ExoPhishSimOverrideRule cmdlet to create third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-ExoPhishSimOverrideRule -Policy -SenderIpRanges + [-Comment ] + [-Confirm] + [-DomainController ] + [-Domains ] + [-Name ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ExoPhishSimOverrideRule -Policy PhishSimOverridePolicy -Domains fabrikam.com,wingtiptoys.com -SenderIpRanges 192.168.1.55 +``` + +This example creates a new phishing simulation override rule with the specified settings. Regardless of the Name value specified, the rule name will be `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +## PARAMETERS + +### -Policy +The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIpRanges +The SenderIpRanges parameter specifies the source IP address that's used by the third-party phishing simulation. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify up to 10 entries separated by commas. + +A phishing simulation entry requires at least one IP address in this parameter and at least one domain in the Domains parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domains +The Domains parameter specifies the email domain that's used by the third-party phishing simulation. You can use either of the following values: + +- The `5321.MailFrom` address (also known as the MAIL FROM address, P1 sender, or envelope sender). +- The DKIM domain. + +You can specify up to 20 values separated by commas. + +A phishing simulation requires at least one domain from this parameter and at least one IP address in the SenderIPRanges parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..7abc967735 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-exosecopsoverriderule +applicable: Exchange Online +title: New-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ExoSecOpsOverrideRule cmdlet to create SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-ExoSecOpsOverrideRule -Policy + [-Comment ] + [-Confirm] + [-DomainController ] + [-Name ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ExoSecOpsOverrideRule -Name SecOpsOverrideRule -Policy SecOpsOverridePolicy +``` + +This example creates the SecOps mailbox override rule with the specified settings. Regardless of the Name value specified, the rule name will be `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +## PARAMETERS + +### -Policy +The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977ef). + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FeatureConfiguration.md b/exchange/exchange-ps/exchange/New-FeatureConfiguration.md new file mode 100644 index 0000000000..2f093ab5f4 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FeatureConfiguration.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-featureconfiguration +applicable: Security & Compliance +title: New-FeatureConfiguration +schema: 2.0.0 +--- + +# New-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the New-FeatureConfiguration cmdlet to create Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-FeatureConfiguration [-Name] -Mode -FeatureScenario -ScenarioConfig + [-Comment ] + [-Confirm] + [-Locations ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FeatureConfiguration -Name "Collection policy for supported Copilots" -FeatureScenario KnowYourData -Mode Enable -ScenarioConfig '{"Activities":["UploadText","DownloadText"],"EnforcementPlanes":["CopilotExperiences","Browser"],"SensitiveTypeIds":["All"],"IsIngestionEnabled":true}' –Locations '[{"Workload":"Applications","Location":"52655","LocationSource":"SaaS","LocationType":"Individual","Inclusions":[{"Type":"Tenant","Identity":"All","DisplayName":"All","Name":"All"}]},{"Workload":"Applications","Location":"49baeafd-1a6b-4c58-be55-75ae6d1dff6a","LocationSource":"PurviewConfig","LocationType":"Group","Inclusions":[{"Type":"Tenant","Identity":"All","DisplayName":"All","Name":"All"}]}]' +``` + +This example creates an enabled collection policy named "Collection policy for supported Copilots" that: +- Includes UploadText & DownloadText activity for all supported classifiers +- Captures all AI prompts +- Includes Microsoft Copilot & Copilot Experiences locations, both scoped to all users & groups + +### Example 2 +```powershell +New-FeatureConfiguration -Name "Scoped browser collection policy for Microsoft Copilot" -FeatureScenario KnowYourData -Mode Enable -ScenarioConfig '{"Activities":["UploadText"],"EnforcementPlanes":["Browser"],"SensitiveTypeIds":["All"],"ExcludedSensitiveTypeIds":["50b8b56b-4ef8-44c2-a924-03374f5831ce","8548332d-6d71-41f8-97db-cc3b5fa544e6"],"IsIngestionEnabled":false}' –Locations '[{"Workload":"Applications","Location":"52655","LocationDisplayName":null,"LocationSource":"SaaS","LocationType":"Individual","Inclusions":[{"Type":"Tenant","Identity":"All","DisplayName":"All","Name":"All"}],"Exclusions":[{"Type":"Group","Identity":"db458ddb-4f56-4d88-a4f7-e29545560839","DisplayName":"Contoso Executives","Name":"Executives@contoso.com"}]}]' +``` + +This example creates an enabled collection policy named "Scoped browser collection policy for Microsoft Copilot" that: +- Includes UploadText activity for all supported classifiers except "All Full Names" and "All Physical Addresses" +- Includes Microsoft Copilot location, for all users & groups except the "Contoso Executives Group" + +### Example 3 +```powershell +New-FeatureConfiguration -Name "Scoped collection policies for browser and devices" -FeatureScenario KnowYourData -Mode Disable -ScenarioConfig '{"Activities":["UploadText","filecreated","filedeleted","filemodified"],"EnforcementPlanes":["Devices","Browser"],"SensitiveTypeIds":["a44669fe-0d48-453d-a9b1-2cc83f2cba77","cb353f78-2b72-4c3c-8827-92ebe4f69fdf"],"FileExtensions":["pdf"],"IsIngestionEnabled":false}' –Locations '[{"Workload":"EndpointDevices","Location":"","Inclusions":[{"Type":"Group","Identity":"db458ddb-4f56-4d88-a4f7-e29545560839","DisplayName":"All Company","Name":"allcompany@contoso.com"}],"Exclusions":[{"Type":"IndividualResource","Identity":"a828f25a-cede-4d0e-97e6-b0b0c913732a","DisplayName":"Alex Wilber","Name":"alex@contoso.com"}]},{"Workload":"Applications","Location":"52655","LocationSource":"SaaS","LocationType":"Individual","Inclusions":[{"Type":"IndividualResource","Identity":"84f9af2e-b224-4cb8-b9cd-bc531bb07a48","DisplayName":"Adele Vance","Name":"adele@contoso.com"}]}]' +``` + +This example creates a disabled collection policy named "Scoped collection policies for browser and devices" that: +- Includes UploadText (for browser) and filecreated, filedeleted, and filemodified activities (for devices) +- Includes "U.S. Social Security Number (SSN)" and "ABA Routing Number" classifiers only +- Detects files on devices with "pdf" file extension only +- Includes devices location, scoped to the "All company" group, excluding the user "Alex Wilber" +- Includes Microsoft Copilot location, scoped only to the user "Adele Vance" + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name for the feature configuration. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureScenario +The FeatureScenario parameter specifies the scenario for the feature configuration. Currently, the only valid values are: +- `KnowYourData` for collection policies +- `TrustContainer` for Endpoint DLP trust container + +```yaml +Type: PolicyScenario +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies feature configuration mode. Valid values are: + +- Enable: The feature configuration is enabled. +- Disable: The feature configuration is disabled. + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScenarioConfig +The ScenarioConfig parameter specifies additional information about the feature configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The locations parameter specifies where the feature configuration applies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FederationTrust.md b/exchange/exchange-ps/exchange/New-FederationTrust.md new file mode 100644 index 0000000000..b1f50c5c62 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FederationTrust.md @@ -0,0 +1,290 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-FederationTrust + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-FederationTrust cmdlet to set up a federation trust between your Exchange organization and the Microsoft Federation Gateway. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### SkipNamespaceProviderProvisioning +``` +New-FederationTrust [-Name] -Thumbprint -ApplicationUri + [-SkipNamespaceProviderProvisioning] + [-AdministratorProvisioningId ] + [-ApplicationIdentifier ] + [-Confirm] + [-DomainController ] + [-MetadataUrl ] + [-WhatIf] + [] +``` + +### FederationTrust +``` +New-FederationTrust [-Name] -Thumbprint + [-SuppressDnsWarning] + [-UseLegacyProvisioningService] + [-Confirm] + [-DomainController ] + [-MetadataUrl ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Federation trusts are trusts created between an Exchange organization and the Microsoft Federation Gateway. A federation trust is required to configure a federated organization identifier for federated sharing. + +For more information, see [Federation](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-FederationTrust -Name "Microsoft Federation Gateway" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 +``` + +This example creates the federation trust Microsoft Federation Gateway with a certificate with the thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationUri +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. + +```yaml +Type: String +Parameter Sets: SkipNamespaceProviderProvisioning +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipNamespaceProviderProvisioning +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. + +```yaml +Type: SwitchParameter +Parameter Sets: SkipNamespaceProviderProvisioning +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see [Federation](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AdministratorProvisioningId +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. + +```yaml +Type: String +Parameter Sets: SkipNamespaceProviderProvisioning +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 +``` + +### -ApplicationIdentifier +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. + +```yaml +Type: String +Parameter Sets: SkipNamespaceProviderProvisioning +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 +``` + +### -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 +``` + +### -MetadataUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressDnsWarning +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. + +This switch is used automatically by the Hybrid Configuration wizard. We don't recommend manually using this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: FederationTrust +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLegacyProvisioningService +The UseLegacyProvisioningService switch specifies that the legacy interface on the Microsoft Federation Gateway is used for managing the federation trust, including federated domains, certificates, and federation metadata. You don't need to specify a value with this switch. + +When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created using this switch. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. + +```yaml +Type: SwitchParameter +Parameter Sets: FederationTrust +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 +``` + +### -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/New-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md new file mode 100644 index 0000000000..4d11d7b876 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md @@ -0,0 +1,101 @@ +--- +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 +schema: 2.0.0 +--- + +# New-FilePlanPropertyAuthority + +## 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-FilePlanPropertyAuthority cmdlet to create file plan property authorities. + +For 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-FilePlanPropertyAuthority [-Name] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FilePlanPropertyAuthority -Name "Contoso Authority" +``` + +This example creates a new file plan property authority named Contoso Authority. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md new file mode 100644 index 0000000000..acdefd1244 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md @@ -0,0 +1,101 @@ +--- +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 +schema: 2.0.0 +--- + +# New-FilePlanPropertyCategory + +## 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-FilePlanPropertyCategory cmdlet to create file plan property categories. + +For 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-FilePlanPropertyCategory [-Name] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FilePlanPropertyCategory -Name "Contoso Category" +``` + +This example creates a new file plan property category named Contoso Category. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md new file mode 100644 index 0000000000..80625e0af9 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md @@ -0,0 +1,133 @@ +--- +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 +schema: 2.0.0 +--- + +# New-FilePlanPropertyCitation + +## 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-FilePlanPropertyCitation cmdlet to create file plan property citations. + +For 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-FilePlanPropertyCitation [-Name] [[-CitationUrl] ] [[-CitationJurisdiction] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FilePlanPropertyCitation -Name "Contoso-0001" +``` + +This example creates a new file plan property citation named Contoso-0001. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CitationUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CitationJurisdiction +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md new file mode 100644 index 0000000000..8d084f8c09 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md @@ -0,0 +1,101 @@ +--- +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 +schema: 2.0.0 +--- + +# New-FilePlanPropertyDepartment + +## 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-FilePlanPropertyDepartment cmdlet to create file plan property departments. + +For 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-FilePlanPropertyDepartment [-Name] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FilePlanPropertyDepartment -Name "Contoso HR" +``` + +This example creates a new file plan property department named Contoso HR. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md new file mode 100644 index 0000000000..f32d9f3ac4 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md @@ -0,0 +1,101 @@ +--- +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 +schema: 2.0.0 +--- + +# New-FilePlanPropertyReferenceId + +## 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-FilePlanPropertyReferenceId cmdlet to create file plan property reference IDs. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-FilePlanPropertyReferenceId [-Name] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FilePlanPropertyAuthority -Name "Contoso-0001" +``` + +This example creates a new file plan property reference ID named Contoso-0001. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md new file mode 100644 index 0000000000..ceff1b7f3e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md @@ -0,0 +1,121 @@ +--- +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 +schema: 2.0.0 +--- + +# New-FilePlanPropertySubCategory + +## 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-FilePlanPropertySubCategory cmdlet to create file plan property subcategories. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-FilePlanPropertySubCategory [-Name] -ParentId + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FilePlanPropertySubCategory -Name "US Tax" -ParentId "Contoso Category" +``` + +This example creates a new file plan property subcategory named US Tax that's a subcategory of the parent file plan property category named Contoso Category. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentId +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +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 +``` + +### -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-Fingerprint.md b/exchange/exchange-ps/exchange/New-Fingerprint.md new file mode 100644 index 0000000000..b2d1f80558 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-Fingerprint.md @@ -0,0 +1,134 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-Fingerprint + +## 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. + +Use the New-Fingerprint cmdlet to create document fingerprints that are used with data classification rules. Because the results of New-Fingerprint are not stored outside of the data classification rule, you always run New-Fingerprint and New-DataClassification or Set-DataClassification in the same PowerShell session. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-Fingerprint [[-FileData] ] -Description + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +$Patent_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Patent Template.docx') + +$Patent_Fingerprint = New-Fingerprint -FileData $Patent_Template -Description "Contoso Patent Template" +``` + +This example creates a new document fingerprint based on the file C:\\My Documents\\Contoso Patent Template.docx. You store the new fingerprint as a variable so you can use it with the New-DataClassification cmdlet in the same PowerShell session. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the file to use as a document fingerprint. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/New-ForeignConnector.md b/exchange/exchange-ps/exchange/New-ForeignConnector.md similarity index 80% rename from exchange/exchange-ps/exchange/mail-flow/New-ForeignConnector.md rename to exchange/exchange-ps/exchange/New-ForeignConnector.md index fc6b1d6ea5..07676050af 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/New-ForeignConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ForeignConnector @@ -13,85 +16,82 @@ This cmdlet is available only in on-premises Exchange. Use the New-ForeignConnector cmdlet to create a new Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ForeignConnector [-Name] -AddressSpaces [-Confirm] - [-DomainController ] [-IsScopedConnector <$true | $false>] - [-SourceTransportServers ] [-WhatIf] [] +New-ForeignConnector [-Name] -AddressSpaces + [-Confirm] + [-DomainController ] + [-IsScopedConnector ] + [-SourceTransportServers ] + [-WhatIf] + [] ``` ## DESCRIPTION A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ForeignConnector -Name "Contoso Foreign Connector" -AddressSpaces "X400:c=US;a=Fabrikam;P=Contoso;5" -SourceTransportServers Hub01,Hub02 ``` This example creates a Foreign connector with the following properties: - Connector name: Contoso Foreign Connector - - Address space: "c=US;a=Fabrikam;P=Contoso" - - Address space type: X.400 - - Address space cost: 5 - - Source transport servers: Hub01 and Hub02 ## PARAMETERS +### -Name +The Name parameter specifies the name for the Foreign connector. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is as follows: \:\;\ +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. - - 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. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("). For example, the following address space entries are equivalent: - "SMTP:contoso.com;1" - - "contoso.com;1" - - "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 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"`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name for the Foreign connector. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -100,8 +100,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -109,6 +108,7 @@ 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 @@ -126,6 +126,7 @@ 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 @@ -137,10 +138,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -151,13 +153,14 @@ Accept wildcard characters: False ### -SourceTransportServers 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. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```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 @@ -173,6 +176,7 @@ 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 @@ -181,20 +185,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/111b71d0-75f2-45b2-a9c9-b4ff51af57b7.aspx) diff --git a/exchange/exchange-ps/exchange/New-GlobalAddressList.md b/exchange/exchange-ps/exchange/New-GlobalAddressList.md new file mode 100644 index 0000000000..990ae4ba24 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-GlobalAddressList.md @@ -0,0 +1,615 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-GlobalAddressList cmdlet to create a global address list (GAL). + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### PrecannedFilter +``` +New-GlobalAddressList [-Name] -IncludedRecipients + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DomainController ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +### CustomFilter +``` +New-GlobalAddressList [-Name] -RecipientFilter + [-Confirm] + [-DomainController ] + [-RecipientContainer ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-GlobalAddressList -Name "NewGAL" +``` + +This example creates the GAL named NewGAL. + +### Example 2 +```powershell +New-GlobalAddressList -Name GAL_AgencyB -RecipientFilter "(RecipientTypeDetails -eq 'UserMailbox') -and (CustomAttribute15 -eq 'AgencyB')" +``` + +This example creates the GAL named GAL\_AgencyB by using the RecipientFilter parameter to include all mailbox users whose custom attribute 15 equals AgencyB. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientFilter +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute1 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute10 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute11 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute12 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute13 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute14 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute15 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute2 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute3 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute4 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute5 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute6 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute7 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute8 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalCustomAttribute9 +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalDepartment +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -ConditionalStateOrProvince +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. + +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). + +```yaml +Type: MultiValuedProperty +Parameter Sets: PrecannedFilter +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -RecipientContainer +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is the OU where the object was created. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md new file mode 100644 index 0000000000..68a8cdeb6a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md @@ -0,0 +1,233 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-HoldCompliancePolicy + +## 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-HoldCompliancePolicy cmdlet to create new preservation policies in the Microsoft Purview compliance portal. + +**Note**: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HoldCompliancePolicy [-Name] + [-Comment ] + [-Confirm] + [-Enabled ] + [-ExchangeLocation ] + [-Force] + [-PublicFolderLocation ] + [-SharePointLocation ] + [-WhatIf] + [] +``` + +## DESCRIPTION +New policies are not valid and will not be applied until a preservation rule is added to the policy. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +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 site. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If no mailboxes are specified, then no mailboxes are placed on hold. + +```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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +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 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 +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-HoldComplianceRule.md b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md new file mode 100644 index 0000000000..9ebebdb7c5 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md @@ -0,0 +1,258 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-HoldComplianceRule + +## 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-HoldComplianceRule cmdlet to create new preservation rules in the Microsoft Purview compliance portal. + +**Note**: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HoldComplianceRule [-Name] -Policy + [-Comment ] + [-Confirm] + [-ContentDateFrom ] + [-ContentDateTo ] + [-ContentMatchQuery ] + [-Disabled ] + [-HoldContent ] + [-HoldDurationDisplayHint ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The preservation rule must be added to an existing preservation policy using the Policy parameter. Only one rule can be added to each preservation policy. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +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. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter specifies the policy to contain the rule. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (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 +``` + +### -ContentDateFrom +The ContentDateFrom parameter specifies the start date of the date range for content to include. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateTo +The ContentDateTo parameter specifies the end date of the date range for content to include. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldContent +The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldDurationDisplayHint +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. + +```yaml +Type: HoldDurationHint +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-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md new file mode 100644 index 0000000000..ef6356928d --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -0,0 +1,1310 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-HostedContentFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-HostedContentFilterPolicy cmdlet to create spam filter policies (content filter policies) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HostedContentFilterPolicy [-Name] + [-AddXHeaderValue ] + [-AdminDisplayName ] + [-AllowedSenderDomains ] + [-AllowedSenders ] + [-BlockedSenderDomains ] + [-BlockedSenders ] + [-BulkQuarantineTag ] + [-BulkSpamAction ] + [-BulkThreshold ] + [-Confirm] + [-DownloadLink ] + [-EnableEndUserSpamNotifications ] + [-EnableLanguageBlockList ] + [-EnableRegionBlockList ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationCustomFromName ] + [-EndUserSpamNotificationCustomSubject ] + [-EndUserSpamNotificationFrequency ] + [-EndUserSpamNotificationLanguage ] + [-EndUserSpamNotificationLimit ] + [-HighConfidencePhishAction ] + [-HighConfidencePhishQuarantineTag ] + [-HighConfidenceSpamAction ] + [-HighConfidenceSpamQuarantineTag ] + [-IncreaseScoreWithBizOrInfoUrls ] + [-IncreaseScoreWithImageLinks ] + [-IncreaseScoreWithNumericIps ] + [-IncreaseScoreWithRedirectToOtherPort ] + [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] + [-LanguageBlockList ] + [-MarkAsSpamBulkMail ] + [-MarkAsSpamEmbedTagsInHtml ] + [-MarkAsSpamEmptyMessages ] + [-MarkAsSpamFormTagsInHtml ] + [-MarkAsSpamFramesInHtml ] + [-MarkAsSpamFromAddressAuthFail ] + [-MarkAsSpamJavaScriptInHtml ] + [-MarkAsSpamNdrBackscatter ] + [-MarkAsSpamObjectTagsInHtml ] + [-MarkAsSpamSensitiveWordList ] + [-MarkAsSpamSpfRecordHardFail ] + [-MarkAsSpamWebBugsInHtml ] + [-ModifySubjectValue ] + [-PhishQuarantineTag ] + [-PhishSpamAction ] + [-PhishZapEnabled ] + [-QuarantineRetentionPeriod ] + [-RecommendedPolicyType ] + [-RedirectToRecipients ] + [-RegionBlockList ] + [-SpamAction ] + [-SpamQuarantineTag ] + [-SpamZapEnabled ] + [-TestModeAction ] + [-TestModeBccToRecipients ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). + +## EXAMPLES + +### Example 1 +```powershell +New-HostedContentFilterPolicy -Name "Contoso Executives" -HighConfidenceSpamAction Quarantine -SpamAction Quarantine -BulkThreshold 6 +``` + +This example creates a spam filter policy named Contoso Executives with the following settings: + +- Quarantine messages when the spam filtering verdict is spam or high confidence spam. +- BCL 6 triggers the action for a bulk email spam filtering verdict. + +## PARAMETERS + +### -Name +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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddXHeaderValue +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 +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +The maximum length is 255 characters, and the value can't contain spaces or colons (:). + +For example, if you enter the value `X-This-is-my-custom-header`, the X-header that's added to the message is `X-This-is-my-custom-header: This message appears to be spam.` + +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedSenderDomains +The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. + +**Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedSenders +The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. + +**Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedSenderDomains +The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP domains. + +**Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedSenders +The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP email addresses. + +**Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BulkQuarantineTag +The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as bulk as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BulkSpamAction +The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: + +- AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- NoAction +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as bulk email are available to the intended recipients and admins. Or, you can use the BulkQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BulkThreshold +The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than or equal to the specified BCL value). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 7, 8, or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. + +A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://learn.microsoft.com/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLanguageBlockList +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRegionBlockList +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLanguage +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLimit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishAction +The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: + +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. +- Quarantine: Move the message to quarantine. By default, messages that are quarantined as high confidence phishing are available only to admins. Or, you can use the HighConfidencePhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. + +```yaml +Type: PhishFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidenceSpamAction +The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: + +- AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as high confidence spam are available to the intended recipients and admins. Or, you can use the HighConfidenceSpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidenceSpamQuarantineTag +The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithBizOrInfoUrls +The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: + +- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. +- Test: The action specified by the TestModeAction parameter is taken on the message. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithImageLinks +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithNumericIps +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithRedirectToOtherPort +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InlineSafetyTipsEnabled +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. +- $false: Safety tips are disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntraOrgFilterState +The IntraOrgFilterState parameter specifies whether to enable anti-spam filtering for messages sent between internal users (users in the same organization). The action that's configured in the policy for the specified spam filter verdicts is taken on messages sent between internal users. Valid values are: + +- Default: This is the default value. Currently, this value is the same as HighConfidencePhish. +- HighConfidencePhish +- Phish: Includes phishing and high confidence phishing. +- HighConfidenceSpam: Includes high confidence spam, phishing, and high confidence phishing. +- Spam: Includes spam, high confidence spam, phishing, and high confidence phishing. +- Disabled + +```yaml +Type: IntraOrgFilterState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageBlockList +The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported 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. + +A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Not all possible language codes are available as input for this parameter. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamBulkMail +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamEmbedTagsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamEmptyMessages +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamFormTagsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamFramesInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamFromAddressAuthFail +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamJavaScriptInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamNdrBackscatter +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamObjectTagsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamSensitiveWordList +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamSpfRecordHardFail +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamWebBugsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifySubjectValue +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 +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishQuarantineTag +The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishSpamAction +The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: + +- AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is available to the intended recipients (as of April, 2020) and admins. +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as phishing are available to admins and (as of April 2020) the intended recipients. Or, you can use the PhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishZapEnabled +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. +- $false: ZAP for phishing messages is disabled. + +You configure ZAP for spam with the SpamZapEnabled parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineRetentionPeriod +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 +- HighConfidencePhishAction +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +A valid value is an integer between 1 and 30. The default value is 15. + +After the time period expires, the message is deleted. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectToRecipients +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 +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegionBlockList +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. + +A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +To empty the list, use the value $null. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamAction +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). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as spam are available to the intended recipients and admins. Or, you can use the SpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamQuarantineTag +The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamZapEnabled +The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: + +- $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. +- $false: ZAP for spam is disabled. + +You configure ZAP for phishing messages with the PhishZapEnabled parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestModeAction +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. +- 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. + +```yaml +Type: SpamFilteringTestModeAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestModeBccToRecipients + +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. + +This parameter is meaningful only when the value of the TestModeAction parameter is BccMessage, and when the value of one or more IncreaseScoreWith\* or MarkAsSpam\* parameters is Test. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md new file mode 100644 index 0000000000..427202c583 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md @@ -0,0 +1,340 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-HostedContentFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-HostedContentFilterRule cmdlet to create spam filter rules (content filter rules) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HostedContentFilterRule [-Name] -HostedContentFilterPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Use the Microsoft Defender portal to create anti-spam policies](https://learn.microsoft.com/defender-office-365/anti-spam-policies-configure#use-the-microsoft-defender-portal-to-create-anti-spam-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-HostedContentFilterRule -Name "Contoso Recipients" -HostedContentFilterPolicy "Contoso Spam Filter Policy" -RecipientDomainIs contoso.com +``` + +This example creates a new spam filter rule named Contoso Recipients with the following settings: If the recipient is in the domain contoso.com, apply the spam filter policy named Contoso Spam Filter Policy. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedContentFilterPolicy +The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. + +You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can't specify the default spam filter policy, and you can't specify a spam filter policy that's already associated with another spam filter rule. + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a 9th new rule are from 0 through 8. +- The default value for the new 9th rule is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md new file mode 100644 index 0000000000..6f78d93176 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md @@ -0,0 +1,285 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-HostedOutboundSpamFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-HostedOutboundSpamFilterPolicy cmdlet to create outbound spam filter policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HostedOutboundSpamFilterPolicy [-Name] + [-ActionWhenThresholdReached ] + [-AdminDisplayName ] + [-AutoForwardingMode ] + [-BccSuspiciousOutboundAdditionalRecipients ] + [-BccSuspiciousOutboundMail ] + [-NotifyOutboundSpam ] + [-NotifyOutboundSpamRecipients ] + [-RecipientLimitExternalPerHour ] + [-RecipientLimitInternalPerHour ] + [-RecipientLimitPerDay ] + [-RecommendedPolicyType ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-HostedOutboundSpamFilterPolicy -Name "Contoso Executives" -RecipientLimitExternalPerHour 400 -RecipientLimitInternalPerHour 800 -RecipientLimitPerDay 800 -ActionWhenThresholdReached BlockUser +``` + +This example creates a new outbound spam filter policy named Contoso Executives with the following settings: + +- The recipient rate limits are restricted to smaller values that the service defaults. +- After one of the limits is reached, the user is prevented from sending messages (added to the Restricted Users portal). + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionWhenThresholdReached +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. + +```yaml +Type: OutboundRecipientLimitsExceededAction +Parameter Sets: (All) +Aliases: +Accepted values: Alert, BlockUserForToday, BlockUser +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoForwardingMode +The AutoForwardingMode specifies how the policy controls automatic email forwarding to external recipients. Valid values are: + +- Automatic: This is the default value. This 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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BccSuspiciousOutboundAdditionalRecipients +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BccSuspiciousOutboundMail +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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). + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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). + +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. + +The specified recipients receive notifications when the value of the NotifyOutboundSpam parameter is $true. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimitExternalPerHour +The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimitInternalPerHour +The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimitPerDay +The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md new file mode 100644 index 0000000000..721a9bd38a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md @@ -0,0 +1,332 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-HostedOutboundSpamFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-HostedOutboundSpamFilterRule cmdlet to create outbound spam filter rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HostedOutboundSpamFilterRule [-Name] -HostedOutboundSpamFilterPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfFrom ] + [-ExceptIfFromMemberOf ] + [-ExceptIfSenderDomainIs ] + [-From ] + [-FromMemberOf ] + [-Priority ] + [-SenderDomainIs ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-HostedOutboundSpamFilterRule -Name "Contoso Executives" -HostedOutboundSpamFilterPolicy "Contoso Executives" -FromMemberOf Executives +``` + +This example creates a new outbound spam filter rule named Contoso Executives that's associated with the outbound spam filter policy name Contoso Executives that applies to the members of the Executives group. + +## PARAMETERS + +### -Name +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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedOutboundSpamFilterPolicy +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: + +- Name +- Distinguished name (DN) +- GUID. + +You can't specify the default outbound spam filter policy, and you can't specify a policy that's already associated with another outbound spam filter rule. + +```yaml +Type: HostedOutboundSpamFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. This is the default value. +- $false: The rule is disabled. + +In the properties of the rule, the value of this parameter is visible in the State property. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-HybridConfiguration.md b/exchange/exchange-ps/exchange/New-HybridConfiguration.md new file mode 100644 index 0000000000..7d9e42ecac --- /dev/null +++ b/exchange/exchange-ps/exchange/New-HybridConfiguration.md @@ -0,0 +1,344 @@ +--- +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/New-InboundConnector.md b/exchange/exchange-ps/exchange/New-InboundConnector.md new file mode 100644 index 0000000000..ab3f7a8b2d --- /dev/null +++ b/exchange/exchange-ps/exchange/New-InboundConnector.md @@ -0,0 +1,550 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-InboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-InboundConnector cmdlet to create a new Inbound connector in your cloud-based organization. + +**Note**: Creation of inbound connectors is restricted in [Microsoft 365 E5 developer subscriptions](https://learn.microsoft.com/office/developer-program/microsoft-365-developer-program-faq#does-the-microsoft-365-e5-developer-subscription-include-the-same-capabilities-that-the-regular-microsoft-365-e5-subscription-includes-). Opening a support ticket in affected organizations won't help. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-InboundConnector [-Name] -SenderDomains + [-AssociatedAcceptedDomains ] + [-ClientHostNames ] + [-CloudServicesMailEnabled ] + [-Comment ] + [-Confirm] + [-ConnectorSource ] + [-ConnectorType ] + [-EFSkipIPs ] + [-EFSkipLastIP ] + [-EFSkipMailGateway ] + [-EFTestMode ] + [-EFUsers ] + [-Enabled ] + [-RequireTls ] + [-RestrictDomainsToCertificate ] + [-RestrictDomainsToIPAddresses ] + [-ScanAndDropRecipients ] + [-SenderIPAddresses ] + [-TlsSenderCertificateName ] + [-TreatMessagesAsInternal ] + [-TrustedOrganizations ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-InboundConnector -Name "Contoso Inbound Connector" -SenderDomains *.contoso.com -SenderIPAddresses 192.168.0.1/25 -RestrictDomainsToIPAddresses $true +``` + +This example creates the Inbound connector named Contoso Inbound Connector with the following properties: + +- It listens for incoming connections from the domain contoso.com and all subdomains. +- It only accepts mail from contoso.com, and from the IP range 192.168.0.1/25. It rejects mail from contoso.com if it originates from any other IP address. + +### Example 2 +```powershell +New-InboundConnector -Name "Contoso Inbound Secure Connector" -SenderDomains *.contoso.com -SenderIPAddresses 192.168.0.1/25 -RestrictDomainsToIPAddresses $true -RequireTLS $true -TlsSenderCertificateName *.contoso.com +``` + +This example creates the Inbound connector named Contoso Inbound Secure Connector and requires TLS transmission for all messages. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomains +The SenderDomains parameter specifies the source domains that a Partner type connector accepts messages for (limits the scope of a Partner type connector). A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, `*.contoso.com`). However, you can't embed the wildcard character (for example, `domain.*.contoso.com` isn't valid). + +You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssociatedAcceptedDomains +The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientHostNames +{{ Fill ClientHostNames Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServicesMailEnabled +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSource +The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: + +- Default: The connector is manually created. This is the default value. +- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. +- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. + +We recommended that you don't change this value. + +```yaml +Type: TenantConnectorSource +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorType +The ConnectorType parameter specifies the category for the source domains that the connector accepts messages for. Valid values are: + +- Partner: External partners or services. +- OnPremises: The connector services domains that are used by your on-premises organization. OnPremises connectors grant special rights to an email that matches the connector and additional requirements. For example: allowing relay through the tenant to internet destinations, promoting emails from on-premises or other environments as internal (in a hybrid configuration), or enabling other more complex mail flows. + +```yaml +Type: TenantConnectorType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFSkipIPs +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. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.3.1/24. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFSkipLastIP +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFSkipMailGateway +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFTestMode +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFUsers +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the connector. Valid values are: + +- $true: The connector is enabled. This is the default value. +- $false: The connector is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireTls +The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by a Partner type connector. Valid values are: + +- $true: Reject messages if they aren't sent over TLS. This is the default value +- $false: Allow messages if they aren't sent over TLS. + +**Note**: This parameter applies only to Partner type connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictDomainsToCertificate +The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the Partner type connector. Valid values are: + +- $true: Mail is allowed to use the connector only if the Subject value of the TLS certificate that the source email server uses to authenticate matches the TlsSenderCertificateName parameter value. +- $false: The Subject value of the TLS certificate that the source email server uses to authenticate doesn't control whether mail from that source uses the connector. This is the default value. + +**Note**: This parameter applies only to Partner type connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictDomainsToIPAddresses +The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses for Partner type connectors. Valid values are: + +- $true: Automatically reject mail from domains that are specified by the SenderDomains parameter if the source IP address isn't also specified by the SenderIPAddress parameter. +- $false: Don't automatically reject mail from domains that are specified by the SenderDomains parameter based on the source IP address. This is the default value. + +**Note**: This parameter applies only to Partner type connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanAndDropRecipients +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIPAddresses +The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the Partner type connector accepts messages from when the value of the RestrictDomainsToIPAddresses parameter is $true. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. Valid subnet mask values are /24 through /32. + +You can specify multiple IP addresses separated by commas. + +IPv6 addresses are not supported. + +**Note**: This parameter applies to Partner type connectors only if the value of the RestrictDomainsToIPAddresses parameter is $true. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsSenderCertificateName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatMessagesAsInternal +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. + +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). + +**Note**: You can't set this parameter to the value $true if either of the following conditions is true: + +- The CloudServicesMailEnabled parameter is set to the value $true. +- The ConnectorType parameter value is not OnPremises. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedOrganizations +The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). You can specify multiple Microsoft 365 organizations separated by commas. + +This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/mailboxes/New-InboxRule.md b/exchange/exchange-ps/exchange/New-InboxRule.md similarity index 85% rename from exchange/exchange-ps/exchange/mailboxes/New-InboxRule.md rename to exchange/exchange-ps/exchange/New-InboxRule.md index ba2d98226e..a3b0fe0e83 100644 --- a/exchange/exchange-ps/exchange/mailboxes/New-InboxRule.md +++ b/exchange/exchange-ps/exchange/New-InboxRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-InboxRule @@ -15,7 +18,7 @@ Use the New-InboxRule cmdlet to create Inbox rules in mailboxes. Inbox rules pro You must have adequate permissions on the mailbox to create an Inbox rule. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,69 +31,68 @@ New-InboxRule [-Name] [-BodyContainsWords ] [-Confirm] [-CopyToFolder ] - [-DeleteMessage <$true | $false>] + [-DeleteMessage ] [-DeleteSystemCategory ] [-DomainController ] [-ExceptIfBodyContainsWords ] [-ExceptIfFlaggedForAction ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] - [-ExceptIfFromSubscription ] - [-ExceptIfHasAttachment <$true | $false>] + [-ExceptIfHasAttachment ] [-ExceptIfHasClassification ] [-ExceptIfHeaderContainsWords ] - [-ExceptIfMessageTypeMatches ] - [-ExceptIfMyNameInCcBox <$true | $false>] - [-ExceptIfMyNameInToBox <$true | $false>] - [-ExceptIfMyNameInToOrCcBox <$true | $false>] - [-ExceptIfMyNameNotInToBox <$true | $false>] + [-ExceptIfMessageTypeMatches ] + [-ExceptIfMyNameInCcBox ] + [-ExceptIfMyNameInToBox ] + [-ExceptIfMyNameInToOrCcBox ] + [-ExceptIfMyNameNotInToBox ] [-ExceptIfReceivedAfterDate ] [-ExceptIfReceivedBeforeDate ] [-ExceptIfRecipientAddressContainsWords ] - [-ExceptIfSentOnlyToMe <$true | $false>] + [-ExceptIfSentOnlyToMe ] [-ExceptIfSentTo ] [-ExceptIfSubjectContainsWords ] [-ExceptIfSubjectOrBodyContainsWords ] - [-ExceptIfWithImportance ] + [-ExceptIfWithImportance ] [-ExceptIfWithinSizeRangeMaximum ] [-ExceptIfWithinSizeRangeMinimum ] - [-ExceptIfWithSensitivity ] + [-ExceptIfWithSensitivity ] [-FlaggedForAction ] [-Force] [-ForwardAsAttachmentTo ] [-ForwardTo ] [-From ] [-FromAddressContainsWords ] - [-FromSubscription ] - [-HasAttachment <$true | $false>] + [-HasAttachment ] [-HasClassification ] [-HeaderContainsWords ] [-Mailbox ] - [-MarkAsRead <$true | $false>] - [-MarkImportance ] - [-MessageTypeMatches ] + [-MarkAsRead ] + [-MarkImportance ] + [-MessageTypeMatches ] [-MoveToFolder ] - [-MyNameInCcBox <$true | $false>] - [-MyNameInToBox <$true | $false>] - [-MyNameInToOrCcBox <$true | $false>] - [-MyNameNotInToBox <$true | $false>] - [-PinMessage <$true | $false>] + [-MyNameInCcBox ] + [-MyNameInToBox ] + [-MyNameInToOrCcBox ] + [-MyNameNotInToBox ] + [-PinMessage ] [-Priority ] [-ReceivedAfterDate ] [-ReceivedBeforeDate ] [-RecipientAddressContainsWords ] [-RedirectTo ] [-SendTextMessageNotificationTo ] - [-SentOnlyToMe <$true | $false>] + [-SentOnlyToMe ] [-SentTo ] - [-StopProcessingRules <$true | $false>] + [-SoftDeleteMessage ] + [-StopProcessingRules ] [-SubjectContainsWords ] [-SubjectOrBodyContainsWords ] [-WhatIf] - [-WithImportance ] + [-WithImportance ] [-WithinSizeRangeMaximum ] [-WithinSizeRangeMinimum ] - [-WithSensitivity ] + [-WithSensitivity ] [] ``` @@ -105,7 +107,8 @@ New-InboxRule -FromMessageId [-Force] [-FromSubscription ] [-Mailbox ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -113,13 +116,13 @@ When you create, modify, remove, enable, or disable an Inbox rule in Exchange Po Parameters that are used for conditions also have corresponding exception parameters. When conditions specified in an exception are matched, the rule isn't applied to the message. Exception parameters begin with ExceptIf. For example, the exception parameter for SubjectOrBodyContainsWords is ExceptIfSubjectOrBodyContainsWords. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -New-InboxRule "CheckActionRequired" -MyNameInToBox $true -FlaggedForAction Any -MarkImportance "High" +### Example 1 +```powershell +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. @@ -127,13 +130,14 @@ This example raises the message importance to High if the mailbox owner is in th ## PARAMETERS ### -Name -The Name parameter specifies the name of the Inbox rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the name of the Inbox rule. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -145,15 +149,12 @@ Accept wildcard characters: False 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 - - StoreObjectId When you use this parameter to create an Inbox rule, the following message properties are used in the rule: - Subject: The message subject is added to the SubjectContainsWords condition. - - From: The message sender is added to the From condition. - - To and Cc: Recipients in the To and Cc fields are added to the SentTo condition. ```yaml @@ -161,6 +162,7 @@ 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 Default value: None @@ -176,6 +178,7 @@ 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 Default value: None @@ -184,13 +187,14 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter 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 @@ -208,6 +212,7 @@ 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 Default value: None @@ -219,51 +224,28 @@ Accept wildcard characters: False 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 - - Bills - - Document - - DocumentPlus - - Event - - Family - - File - - Flight - - FromContact - - Important - - LiveView - - Lodging - - MailingList - - Newsletter - - Photo - - Purchase - - RentalCar - - RestaurantReservation - - RetiredPromotion - - ShippingNotification - - Shopping - - SocialUpdate - - Travel - - Video You can specify multiple values separated by commas. @@ -273,6 +255,7 @@ Type: MultiValuedProperty Parameter Sets: Identity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -283,7 +266,9 @@ Accept wildcard characters: False ### -BodyContainsWords The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. @@ -292,6 +277,7 @@ 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 Default value: None @@ -302,8 +288,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -311,6 +296,7 @@ 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 Default value: None @@ -319,13 +305,29 @@ Accept wildcard characters: False ``` ### -CopyToFolder -The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal). +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Marketing` or `John:\Inbox\Reports`. ```yaml 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 Default value: None @@ -337,14 +339,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used. ```yaml -Type: $true | $false +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 Default value: None @@ -356,51 +358,28 @@ Accept wildcard characters: False 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 - - Bills - - Document - - DocumentPlus - - Event - - Family - - File - - Flight - - FromContact - - Important - - LiveView - - Lodging - - MailingList - - Newsletter - - Photo - - Purchase - - RentalCar - - RestaurantReservation - - RetiredPromotion - - ShippingNotification - - Shopping - - SocialUpdate - - Travel - - Video You can specify multiple values separated by commas. @@ -410,6 +389,7 @@ Type: MultiValuedProperty Parameter Sets: Identity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -427,6 +407,7 @@ 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 @@ -437,7 +418,9 @@ Accept wildcard characters: False ### -ExceptIfBodyContainsWords The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is BodyContainsWords. @@ -446,6 +429,7 @@ 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 Default value: None @@ -457,25 +441,15 @@ Accept wildcard characters: False The ExceptIfFlaggedForAction parameter specifies an exception for the Inbox rule that looks messages with the specified message flag. Valid values are: - Any - - Call - - DoNotForward - - FollowUp - - ForYourInformation - - Forward - - NoResponseNecessary - - Read - - Reply - - ReplyToAll - - Review The corresponding condition parameter to this exception is FlaggedForAction. @@ -485,6 +459,7 @@ 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 Default value: None @@ -495,23 +470,14 @@ Accept wildcard characters: False ### -ExceptIfFrom The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: -For example: - - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple senders 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"`. The corresponding condition parameter to this exception is From. @@ -520,6 +486,7 @@ 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 Default value: None @@ -530,7 +497,9 @@ Accept wildcard characters: False ### -ExceptIfFromAddressContainsWords The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. -You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is FromAddressContainsWords. @@ -539,25 +508,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -ExceptIfFromSubscription -This parameter is available only in the cloud-based service. - -The ExceptIfFromSubscription parameter specifies an exception for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. - -The corresponding condition parameter to this exception is FromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -569,16 +520,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is HasAttachment. ```yaml -Type: $true | $false +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 Default value: None @@ -596,6 +547,7 @@ 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 Default value: None @@ -606,7 +558,9 @@ Accept wildcard characters: False ### -ExceptIfHeaderContainsWords The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is HeaderContainsWords. @@ -615,6 +569,7 @@ 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 Default value: None @@ -626,34 +581,25 @@ Accept wildcard characters: False The ExceptIfMessageTypeMatches parameter specifies an exception for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply - - AutomaticForward - - Encrypted - - Calendaring - - CalendaringResponse - - PermissionControlled - - Voicemail - - Signed - - ApprovalRequest - - ReadReceipt - - NonDeliveryReport The corresponding condition parameter to this exception is MessageTypeMatches. ```yaml -Type: AutomaticReply | AutomaticForward | Encrypted | Calendaring | CalendaringResponse | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt | NonDeliveryReport +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 Default value: None @@ -665,16 +611,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameInCcBox. ```yaml -Type: $true | $false +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 Default value: None @@ -686,16 +632,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameInToBox. ```yaml -Type: $true | $false +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 Default value: None @@ -707,16 +653,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameInToOrCcBox. ```yaml -Type: $true | $false +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 Default value: None @@ -728,16 +674,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameNotInToBox. ```yaml -Type: $true | $false +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 Default value: None @@ -748,7 +694,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedAfterDate The ExceptIfReceivedAfterDate parameter specifies an exception for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedAfterDate. @@ -757,6 +703,7 @@ 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 Default value: None @@ -767,7 +714,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedBeforeDate The ExceptIfReceivedBeforeDate parameter specifies an exception for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedBeforeDate. @@ -776,6 +723,7 @@ 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 Default value: None @@ -786,7 +734,7 @@ Accept wildcard characters: False ### -ExceptIfRecipientAddressContainsWords The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is RecipientAddressContainsWords. @@ -795,6 +743,7 @@ 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 Default value: None @@ -806,16 +755,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is SentOnlyToMe. ```yaml -Type: $true | $false +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 Default value: None @@ -827,16 +776,13 @@ Accept wildcard characters: False The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name - +- Alias - Distinguished name (DN) - -- Display name - +- Canonical DN - Email address - - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding condition parameter to this exception is SentTo. @@ -845,6 +791,7 @@ 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 Default value: None @@ -855,7 +802,9 @@ Accept wildcard characters: False ### -ExceptIfSubjectContainsWords The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is SubjectContainsWords. @@ -864,6 +813,7 @@ 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 Default value: None @@ -874,15 +824,18 @@ Accept wildcard characters: False ### -ExceptIfSubjectOrBodyContainsWords The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. +The maximum length of this parameter is 255 characters. + +The corresponding condition parameter to this exception is SubjectOrBodyContainsWords. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -894,18 +847,17 @@ Accept wildcard characters: False The ExceptIfWithImportance parameter specifies an exception for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High - - Normal - - Low The corresponding condition parameter to this exception is WithImportance. ```yaml -Type: Low | Normal | High +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 Default value: None @@ -919,18 +871,14 @@ The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. -You need to use this parameter with the ExceptIfWithinSizeRangeMainimum parameter, and the value of this parameter must be greater than the value of ExceptIfWithinSizeRangeMinimum. +You need to use this parameter with the ExceptIfWithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of ExceptIfWithinSizeRangeMinimum. The corresponding condition parameter to this exception is WithinSizeRangeMaximum. @@ -939,6 +887,7 @@ 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 Default value: None @@ -952,13 +901,9 @@ The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -972,6 +917,7 @@ 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 Default value: None @@ -983,20 +929,18 @@ Accept wildcard characters: False The ExceptIfWithSensitivity parameter specifies an exception for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal - - Personal - - Private - - CompanyConfidential The corresponding condition parameter to this exception is WithSensitivity. ```yaml -Type: Normal | Personal | Private | CompanyConfidential +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 Default value: None @@ -1008,25 +952,15 @@ Accept wildcard characters: False The FlaggedForAction parameter specifies a condition for the Inbox rule that looks for messages with the specified message flag. Valid values are: - Any - - Call - - DoNotForward - - FollowUp - - ForYourInformation - - Forward - - NoResponseNecessary - - Read - - Reply - - ReplyToAll - - Review ```yaml @@ -1034,6 +968,7 @@ 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 Default value: None @@ -1042,7 +977,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -1051,6 +986,7 @@ 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 @@ -1059,31 +995,23 @@ Accept wildcard characters: False ``` ### -ForwardAsAttachmentTo -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple recipients separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1092,31 +1020,23 @@ Accept wildcard characters: False ``` ### -ForwardTo -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple recipients separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1125,25 +1045,16 @@ Accept wildcard characters: False ``` ### -From -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple senders 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"`. The corresponding exception parameter to this condition is ExceptIfFrom. @@ -1152,6 +1063,7 @@ 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 Default value: None @@ -1162,7 +1074,9 @@ Accept wildcard characters: False ### -FromAddressContainsWords The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. -You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. @@ -1171,25 +1085,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -FromSubscription -This parameter is available only in the cloud-based service. - -The FromSubscription parameter specifies a condition for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. - -The corresponding exception parameter to this condition is ExceptIfFromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1201,16 +1097,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfHasAttachment. ```yaml -Type: $true | $false +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 Default value: None @@ -1228,6 +1124,7 @@ 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 Default value: None @@ -1238,7 +1135,9 @@ Accept wildcard characters: False ### -HeaderContainsWords The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. @@ -1247,6 +1146,7 @@ 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 Default value: None @@ -1255,30 +1155,17 @@ Accept wildcard characters: False ``` ### -Mailbox -The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. - -For example: +The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -1286,6 +1173,7 @@ 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 Default value: None @@ -1297,14 +1185,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used. ```yaml -Type: $true | $false +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 Default value: None @@ -1316,16 +1204,15 @@ Accept wildcard characters: False The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - Low - - Normal - - High ```yaml -Type: Low | Normal | High +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 Default value: None @@ -1337,34 +1224,25 @@ Accept wildcard characters: False The MessageTypeMatches parameter specifies a condition for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply - - AutomaticForward - - Encrypted - - Calendaring - - CalendaringResponse - - PermissionControlled - - Voicemail - - Signed - - ApprovalRequest - - ReadReceipt - - NonDeliveryReport The corresponding exception parameter to this condition is ExceptIfMessageTypeMatches. ```yaml -Type: AutomaticReply | AutomaticForward | Encrypted | Calendaring | CalendaringResponse | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt | NonDeliveryReport +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 Default value: None @@ -1373,13 +1251,29 @@ Accept wildcard characters: False ``` ### -MoveToFolder -The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal). +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Marketing` or `John:\Inbox\Reports`. ```yaml 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 Default value: None @@ -1391,16 +1285,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameInCcBox. ```yaml -Type: $true | $false +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 Default value: None @@ -1412,16 +1306,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameInToBox. ```yaml -Type: $true | $false +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 Default value: None @@ -1433,16 +1327,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameInToOrCcBox. ```yaml -Type: $true | $false +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 Default value: None @@ -1454,16 +1348,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameNotInToBox. ```yaml -Type: $true | $false +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 Default value: None @@ -1475,14 +1369,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Identity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1498,6 +1392,7 @@ 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 Default value: None @@ -1508,7 +1403,7 @@ Accept wildcard characters: False ### -ReceivedAfterDate The ReceivedAfterDate parameter specifies a condition for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. @@ -1517,6 +1412,7 @@ 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 Default value: None @@ -1527,7 +1423,7 @@ Accept wildcard characters: False ### -ReceivedBeforeDate The ReceivedBeforeDate parameter specifies a condition for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. @@ -1536,6 +1432,7 @@ 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 Default value: None @@ -1546,7 +1443,7 @@ Accept wildcard characters: False ### -RecipientAddressContainsWords The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. @@ -1555,6 +1452,7 @@ 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 Default value: None @@ -1563,27 +1461,23 @@ Accept wildcard characters: False ``` ### -RedirectTo -The RedirectTo parameter specifies an action for the Inbox rule that recdirects the message to the specified recipient. You can use any value that uniquely identifies the recipient. - -For example: +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 - -- Display name - +- Alias - Distinguished name (DN) - - Canonical DN - +- Email address - GUID -You can specify multiple recipients separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1592,6 +1486,8 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo +This parameter is available only in on-premises Exchange. + The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. You can specify multiple values separated by commas. @@ -1600,7 +1496,8 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1612,16 +1509,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfSentOnlyToMe. ```yaml -Type: $true | $false +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 Default value: None @@ -1630,21 +1527,16 @@ Accept wildcard characters: False ``` ### -SentTo -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: +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 - -- Display name - +- Alias - Distinguished name (DN) - - Canonical DN - +- Email address - GUID -You can specify multiple recipients 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"`. The corresponding exception parameter to this condition is ExceptIfSentTo. @@ -1653,6 +1545,25 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteMessage +This parameter is available only in the cloud-based service. + +{{ Fill SoftDeleteMessage Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -1664,14 +1575,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used (continue processing more rules after this one). ```yaml -Type: $true | $false +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 Default value: None @@ -1682,7 +1593,9 @@ Accept wildcard characters: False ### -SubjectContainsWords The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. @@ -1691,6 +1604,7 @@ 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 Default value: None @@ -1701,7 +1615,9 @@ Accept wildcard characters: False ### -SubjectOrBodyContainsWords The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. @@ -1710,6 +1626,7 @@ 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 Default value: None @@ -1725,6 +1642,7 @@ 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 Default value: None @@ -1736,18 +1654,17 @@ Accept wildcard characters: False The WithImportance parameter specifies a condition for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High - - Normal - - Low The corresponding exception parameter to this condition is ExceptIfWithImportance. ```yaml -Type: Low | Normal | High +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 Default value: None @@ -1761,13 +1678,9 @@ The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1781,6 +1694,7 @@ 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 Default value: None @@ -1794,13 +1708,9 @@ The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1814,6 +1724,7 @@ 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 Default value: None @@ -1825,20 +1736,18 @@ Accept wildcard characters: False The WithSensitivity parameter specifies a condition for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal - - Personal - - Private - - CompanyConfidential The corresponding exception parameter to this condition is ExceptIfWithSensitivity. ```yaml -Type: Normal | Personal | Private | CompanyConfidential +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 Default value: None @@ -1847,20 +1756,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2c6b8ee8-1ff0-4353-845c-f3ea9778abc3.aspx) diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md new file mode 100644 index 0000000000..0e1826be8c --- /dev/null +++ b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md @@ -0,0 +1,293 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-InformationBarrierPolicy + +## 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-InformationBarrierPolicy cmdlet to create information barrier policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### OrganizationSegmentAllowedFilter +``` +New-InformationBarrierPolicy [-Name] -AssignedSegment -SegmentAllowedFilter + [-Comment ] + [-Confirm] + [-Force] + [-ModerationAllowed ] + [-State ] + [-WhatIf] + [] +``` + +### OrganizationSegmentsAllowed +``` +New-InformationBarrierPolicy [-Name] -AssignedSegment -SegmentsAllowed + [-Comment ] + [-Confirm] + [-Force] + [-ModerationAllowed ] + [-WhatIf] + [] +``` + +### OrganizationSegmentsBlocked +``` +New-InformationBarrierPolicy [-Name] -AssignedSegment -SegmentsBlocked + [-Comment ] + [-Confirm] + [-Force] + [-ModerationAllowed ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Information barrier policies are not in effect until you set them to active status, and then apply the policies: + +- (If needed): [Block communications between segments](https://learn.microsoft.com/purview/information-barriers-policies#scenario-1-block-communications-between-segments). +- After all of your policies are defined: [Apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). + +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-InformationBarrierPolicy -Name "Sales-Research" -AssignedSegment "Sales" -SegmentsBlocked "Research" -State Inactive +``` + +This example creates an inactive policy named *Sales-Research* for a segment named *Sales*. When active and applied, this policy prevents people in *Sales* from communicating with people in the segment named *Research*. + +### Example 2 +```powershell +New-InformationBarrierPolicy -Name "Manufacturing-HR" -AssignedSegment "Manufacturing" -SegmentsAllowed "Manufacturing","HR" -State Inactive +``` + +This example creates an inactive policy named *Manufacturing-HR* for a segment named *Manufacturing*. When active and applied, this policy allows people in *Manufacturing* to communicate only with people in the segment named *HR*. (In this example, Manufacturing can't communicate with users who aren't in HR.) + +### Example 3 +```powershell +New-InformationBarrierPolicy -Name "Research-HRManufacturing" -AssignedSegment "Research" -SegmentsAllowed "Research","HR","Manufacturing" -State Inactive +``` + +This example creates a policy that allows the *Research* segment to communicate with only *HR* and *Manufacturing*. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedSegment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SegmentAllowedFilter +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: OrganizationSegmentAllowedFilter +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SegmentsAllowed +The SegmentsAllowed parameter specifies the segments that are allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). Only these specified segments can communicate with the segment in this policy. + +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"). + +You can't use this parameter with the SegmentsBlocked parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: OrganizationSegmentsAllowed +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SegmentsBlocked +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"). + +You can't use this parameter with the SegmentsAllowed parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: OrganizationSegmentsBlocked +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch doesn't work on this cmdlet. + +```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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationAllowed +{{ Fill ModerationAllowed Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: + +- Active +- Inactive (This is the default value.) + +```yaml +Type: EopInformationBarrierPolicyState +Parameter Sets: (All) +Aliases: +Accepted values: Inactive, Active +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 + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md similarity index 78% rename from exchange/exchange-ps/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md rename to exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md index 501cccf109..4e22683783 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-IntraOrganizationConnector @@ -13,14 +16,18 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-IntraOrganizationConnector cmdlet to create an Intra-Organization connector between two on-premises Exchange forests in an organization, between an Exchange on-premises organization and an Exchange Online organization, or between two Exchange Online organizations. This connector enables feature availability and service connectivity across the organizations using a common connector and connection endpoints. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IntraOrganizationConnector [-Name] -DiscoveryEndpoint - -TargetAddressDomains [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-WhatIf] [] +New-IntraOrganizationConnector [-Name] -DiscoveryEndpoint -TargetAddressDomains + [-Confirm] + [-DomainController ] + [-Enabled ] + [-TargetSharingEpr ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -28,44 +35,46 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -New-IntraorganizationConnector -DiscoveryEndpoint http://ExternalDiscovery.Contoso.com -Name MainCloudConnector -TargetAddressDomains Cloud1.contoso.com,Cloud2.contoso.com +### Example 1 +```powershell +New-IntraOrganizationConnector -DiscoveryEndpoint https://ExternalDiscovery.Contoso.com -Name MainCloudConnector -TargetAddressDomains Cloud1.contoso.com,Cloud2.contoso.com ``` This example creates an Intra-Organization connector named "MainCloudConnector" between an on-premises Exchange organization and an Exchange Online organization containing two domains, Cloud1.contoso.com and Cloud2.contoso.com. ## PARAMETERS -### -DiscoveryEndpoint -The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector. +### -Name +The Name parameter specifies a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks. ```yaml -Type: Uri +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks. +### -DiscoveryEndpoint +The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector. ```yaml -Type: String +Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -81,6 +90,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -91,8 +101,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -100,6 +109,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -117,6 +127,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -130,10 +141,29 @@ The Enabled parameter enables or disabled the Intra-organization connector. The When you set the value to $false, you completely stop connectivity for the specific connection. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSharingEpr +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. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -149,6 +179,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -157,20 +188,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/34af9609-b018-4eee-8c77-e1f0dcd5b4a7.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-JournalRule.md b/exchange/exchange-ps/exchange/New-JournalRule.md similarity index 79% rename from exchange/exchange-ps/exchange/policy-and-compliance/New-JournalRule.md rename to exchange/exchange-ps/exchange/New-JournalRule.md index 9315a82e99..2812bcf0ef 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-JournalRule.md +++ b/exchange/exchange-ps/exchange/New-JournalRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-JournalRule @@ -13,28 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-JournalRule cmdlet to create a journal rule in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-JournalRule -Name -JournalEmailAddress [-Confirm] - [-DomainController ] [-Enabled <$true | $false>] +New-JournalRule -Name -JournalEmailAddress + [-Confirm] + [-DomainController ] + [-Enabled ] [-Recipient ] - [-Scope ] [-WhatIf] [] + [-Scope ] + [-WhatIf] + [] ``` ## 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. +By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://learn.microsoft.com/powershell/module/exchange/enable-journalrule). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-JournalRule -Name "Brokerage Communications" -JournalEmailAddress "Brokers Journal Mailbox" -Scope Global -Recipient brokers@contoso.com -Enabled $true ``` @@ -50,6 +57,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -58,13 +66,21 @@ Accept wildcard characters: False ``` ### -JournalEmailAddress -The JournalEmailAddress parameter specifies a recipient object to which journal reports are sent. +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID ```yaml 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 Default value: None @@ -75,8 +91,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -84,6 +99,7 @@ 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 Default value: None @@ -101,6 +117,7 @@ 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 @@ -112,10 +129,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -126,11 +144,14 @@ Accept wildcard characters: False ### -Recipient The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or from a recipient are journaled. +To journal messages from all recipients, don't use this parameter. + ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -142,16 +163,15 @@ Accept wildcard characters: False 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. - - Internal: Internal rules process email messages sent and received by recipients in your organization. - - External: External rules process email messages sent to recipients or from senders outside your organization. ```yaml -Type: Internal | External | Global +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 Default value: None @@ -167,6 +187,7 @@ 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 Default value: None @@ -175,20 +196,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/fcad9ef1-b3f2-442d-a1a7-cd1bbe442054.aspx) diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md new file mode 100644 index 0000000000..ccfa3a9d5e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -0,0 +1,1675 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-Label + +## 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-Label cmdlet to create sensitivity labels in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-Label [-Name] -DisplayName -Tooltip + [-AdvancedSettings ] + [-ApplyContentMarkingFooterAlignment ] + [-ApplyContentMarkingFooterEnabled ] + [-ApplyContentMarkingFooterFontColor ] + [-ApplyContentMarkingFooterFontName ] + [-ApplyContentMarkingFooterFontSize ] + [-ApplyContentMarkingFooterMargin ] + [-ApplyContentMarkingFooterText ] + [-ApplyContentMarkingHeaderAlignment ] + [-ApplyContentMarkingHeaderEnabled ] + [-ApplyContentMarkingHeaderFontColor ] + [-ApplyContentMarkingHeaderFontName ] + [-ApplyContentMarkingHeaderFontSize ] + [-ApplyContentMarkingHeaderMargin ] + [-ApplyContentMarkingHeaderText ] + [-ApplyDynamicWatermarkingEnabled ] + [-ApplyWaterMarkingEnabled ] + [-ApplyWaterMarkingFontColor ] + [-ApplyWaterMarkingFontName ] + [-ApplyWaterMarkingFontSize ] + [-ApplyWaterMarkingLayout ] + [-ApplyWaterMarkingText ] + [-ColumnAssetCondition ] + [-Comment ] + [-Conditions ] + [-Confirm] + [-ContentType ] + [-DefaultContentLabel ] + [-DynamicWatermarkDisplay ] + [-EncryptionAipTemplateScopes ] + [-EncryptionContentExpiredOnDateInDaysOrNever ] + [-EncryptionDoNotForward ] + [-EncryptionDoubleKeyEncryptionUrl ] + [-EncryptionEnabled ] + [-EncryptionEncryptOnly ] + [-EncryptionLinkedTemplateId ] + [-EncryptionOfflineAccessDays ] + [-EncryptionPromptUser ] + [-EncryptionProtectionType ] + [-EncryptionRightsDefinitions ] + [-EncryptionRightsUrl ] + [-EncryptionTemplateId ] + [-Identity ] + [-LabelActions ] + [-LocaleSettings ] + [-MigrationId ] + [-ParentId ] + [-SchematizedDataCondition ] + [-Setting ] + [-Settings ] + [-SiteAndGroupProtectionAllowAccessToGuestUsers ] + [-SiteAndGroupProtectionAllowEmailFromGuestUsers ] + [-SiteAndGroupProtectionAllowFullAccess ] + [-SiteAndGroupProtectionAllowLimitedAccess ] + [-SiteAndGroupProtectionBlockAccess ] + [-SiteAndGroupProtectionEnabled ] + [-SiteAndGroupProtectionLevel ] + [-SiteAndGroupProtectionPrivacy ] + [-SiteExternalSharingControlType ] + [-TeamsAllowedPresenters ] + [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] + [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] + [-TeamsCopyRestrictionEnforced ] + [-TeamsEndToEndEncryptionEnabled ] + [-TeamsLobbyBypassScope ] + [-TeamsLobbyRestrictionEnforced ] + [-TeamsPresentersRestrictionEnforced ] + [-TeamsProtectionEnabled ] + [-TeamsRecordAutomatically ] + [-TeamsVideoWatermark ] + [-TeamsWhoCanRecord ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-Label -DisplayName "My New label" -Name "New Label" +``` + +This example create a new label named "New Label" with a display name "My New Label". + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. + +```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 +``` + +### -Tooltip +The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). + +```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 +``` + +### -AdvancedSettings +The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. + +Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. + +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). + +Supported settings for built-in labeling: + +- **BlockContentAnalysisServices**: Specifies a privacy setting to allow or prevent content in Word, Excel, PowerPoint, and Outlook from being sent to Microsoft for content analysis. Available values are True, and False (the default). This setting impacts services such as data loss prevention policy tips, automatic and recommended labeling, and Microsoft Copilot for Microsoft 365. Example: `New-Label -Identity Confidential -AdvancedSettings @{BlockContentAnalysisServices="True"}`. For more information, see [Prevent some connected experiences that analyze content](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#prevent-some-connected-experiences-that-analyze-content). + +- **Color**: Specifies a label color as a hex triplet code for the red, green, and blue (RGB) components of the color. Example: `New-Label -DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{color="#40e0d0"}`. For more information, see [Configuring custom colors by using PowerShell](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). + +- **DefaultSharingScope**: Specifies the default sharing link type for a site when the label scope includes **Groups & sites**, and the default sharing link type for a document when the label scope includes **Files & emails**. Available values are SpecificPeople, Organization, and Anyone. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultSharingScope="SpecificPeople"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkPermission**: Specifies the permissions for the sharing link for a site when the label scope includes **Groups & sites**, and the permissions for the sharing link for a document when the label scope includes **Files & emails**. Available values are View and Edit. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultShareLinkPermission="Edit"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkToExistingAccess**: Specifies whether to override *DefaultSharingScope* and *DefaultShareLinkPermission* to instead set the default sharing link type to people with existing access with their existing permissions. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultShareLinkToExistingAccess="True"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultSubLabelId**: Specifies a default sublabel to be applied automatically when a user selects a parent label in Office apps. Example: `New-Label -DisplayName "Confidential" -Name "Confidential" -Tooltip "Confidential data that requires protection, which allows all employees full permissions. Data owners can track and revoke content." -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"}`. For more information, see [Specify a default sublabel for a parent label](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#specify-a-default-sublabel-for-a-parent-label). + +- **MembersCanShare**: For a container label, specifies how members can share for a SharePoint site. Available values are MemberShareAll, MemberShareFileAndFolder, and MemberShareNone. Example: `New-Label -DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{MembersCanShare="MemberShareFileAndFolder"}`. For more information, see [Configure site sharing permissions by using PowerShell advanced settings](https://learn.microsoft.com/purview/sensitivity-labels-teams-groups-sites#configure-site-sharing-permissions-by-using-powershell-advanced-settings). + +- **SMimeEncrypt**: Specifies S/MIME encryption for Outlook. Available values are True, and False (the default). Example: `New-Label DisplayName "Confidential" -Name "Confidential" -Tooltip "Sensitive business data that could cause damage to the business if shared with unauthorized people." -AdvancedSettings @{SMimeEncrypt="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +- **SMimeSign**: Specifies S/MIME digital signature for Outlook. Available values are True, and False (the default). Example: `New-Label DisplayName "Confidential" -Name "Confidential" -Tooltip "Sensitive business data that could cause damage to the business if shared with unauthorized people." -AdvancedSettings @{SMimeSign="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterAlignment +The ApplyContentMarkingFooterAlignment parameter specifies the footer alignment. Valid values are: + +- Left +- Center +- Right + +This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterEnabled +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. +- $false: The Apply Content Marking Footer action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterFontColor +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. + +```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 +``` + +### -ApplyContentMarkingFooterFontName +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. + +This parameter is supported only by the Azure Information Protection unified labeling client and not by Office apps and services that support built-in labeling. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterFontSize +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterMargin +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterText +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. + +```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 +``` + +### -ApplyContentMarkingHeaderAlignment +The ApplyContentMarkingHeaderAlignment parameter specifies the header alignment. Valid values are: + +- Left +- Center +- Right + +This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderEnabled +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. +- $false: The Apply Content Marking Header action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderFontColor +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. + +```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 +``` + +### -ApplyContentMarkingHeaderFontName +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. + +```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 +``` + +### -ApplyContentMarkingHeaderFontSize +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderMargin +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. + +**Note**: In Microsoft Word and PowerPoint, the specified value is used as a top margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderText +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. + +```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 +``` + +### -ApplyDynamicWatermarkingEnabled +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are: + +- $true: Enables dynamic watermarking for a specific label. +- $false: Disables dynamic watermarking for a specific label. + +You set the watermark text with the DynamicWatermarkDisplay parameter. For more information about using dynamic watermarks for supported apps, see [Dynamic watermarks](https://learn.microsoft.com/purview/encryption-sensitivity-labels#dynamic-watermarks). + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingEnabled +The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: + +- $true: The Apply Watermarking Header action is enabled. +- $false: The Apply Watermarking Header action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingFontColor +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. + +```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 +``` + +### -ApplyWaterMarkingFontName +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. + +```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 +``` + +### -ApplyWaterMarkingFontSize +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingLayout +The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: + +- Horizontal +- Diagonal + +This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingText +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. + +```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 +``` + +### -ColumnAssetCondition +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Conditions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MulitValuedProperty +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 +``` + +### -ContentType +The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: + +- File +- Email +- Site +- UnifiedGroup +- PurviewAssets +- Teamwork +- SchematizedData + +Values can be combined, for example: "File, Email, PurviewAssets". + +```yaml +Type: MipLabelContentType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultContentLabel +The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicWatermarkDisplay +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens: + +- `${Consumer.PrincipalName}`: Required. The value is the user principal name (UPN) of the user. +- `${Device.DateTime}`: Optional. The value is current date/time of the device used to view the document. + +This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled parameter value is $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAipTemplateScopes +The EncryptionAipTemplateScopes parameter specifies that the label is still published and usable in the AIP classic client. An example value is `"['allcompany@labelaction.onmicrosoft.com','admin@labelaction.onmicrosoft.com']"`. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionContentExpiredOnDateInDaysOrNever +The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: + +- An integer (number of days) +- The value `Never` + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```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 +``` + +### -EncryptionDoNotForward +The EncryptionDoNotForward parameter specifies whether the Do Not Forward template is applied. Valid values are: + +- $true: The Do Not Forward template is applied. +- $false: The Do Not Forward template is not applied. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionDoubleKeyEncryptionUrl +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. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```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 +``` + +### -EncryptionEnabled +The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: + +- $true: Encryption is enabled. +- $false: Encryption is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionEncryptOnly +The EncryptionEncryptOnly parameter specifies whether the encrypt-only template is applied. Valid values are: + +- $true: The encrypt-only template is applied. +- $false: The encrypt-only template is not applied. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionLinkedTemplateId +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -EncryptionOfflineAccessDays +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPromptUser +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. +- $false: The label is not set with user defined permissions in Word, Excel and PowerPoint. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false, and when the EncryptionProtectionType parameter value is UserDefined. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionProtectionType +The EncryptionProtectionType parameter specifies the protection type for encryption. Valid values are: + +- Template +- RemoveProtection +- UserDefined + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionRightsDefinitions +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. + +```yaml +Type: EncryptionRightsDefinitionsParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionRightsUrl +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. + +```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 +``` + +### -EncryptionTemplateId +The EncryptionTemplateId parameter lets you convert an existing protection template from Azure Information Protection to a new sensitivity label. Specify the template by its ID that you can identify by running the [Get-AipServiceTemplate](https://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. + +```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 +``` + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabelActions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocaleSettings +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"}]}` +- Label Tooltips: `{"localeKey":"Tooltip","Settings":[{"Key":"en-us","Value":"English Tooltip"},{"Key":"de-de",Value":"Deutscher Tooltip"},{"Key":"es-es","Value":"Tooltip Español"}]}` + +```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 +``` + +### -MigrationId +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -ParentId +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchematizedDataCondition +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Settings +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionAllowAccessToGuestUsers +The SiteAndGroupProtectionAllowAccessToGuestUsers parameter enables or disables access to guest users. Valid values are: + +- $true: Guest access is enabled. +- $false: Guest access is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionAllowEmailFromGuestUsers +The SiteAndGroupProtectionAllowEmailFromGuestUsers parameter enables or disables email from guest users. Valid values are: + +- $true: Email from guest users is enabled. +- $false: Email from guest users is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionAllowFullAccess +The SiteAndGroupProtectionAllowFullAccess parameter enables or disables full access. Valid values are: + +- $true: Full access is enabled. +- $false: Full access is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionAllowLimitedAccess +The SiteAndGroupProtectionAllowLimitedAccess parameter enables or disables limited access. Valid values are: + +- $true: Limited access is enabled. +- $false: Limited access is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionBlockAccess +The SiteAndGroupProtectionBlockAccess parameter blocks access. Valid values are: + +- $true: Access is blocked. +- $false: Access is allowed. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionEnabled +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. +- $false: The Site and Group Protection action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionLevel +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SiteAndGroupProtectionLevelParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionPrivacy +The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the labe. Valid values are: + +- Public +- Private + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+GroupProtectionPrivacy +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteExternalSharingControlType +The SiteExternalSharingControlType parameter specifies the external user sharing setting for the label. Valid values are: + +- ExternalUserAndGuestSharing +- ExternalUserSharingOnly +- ExistingExternalUserSharingOnly +- Disabled + +These correspond to the following settings through the admin center: + +- Anyone +- New and Existing Guests +- Existing Guests +- Only people in your organization + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowedPresenters +The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: + +- Everyone +- Organization +- Organizer +- RoleIsPresenter +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowMeetingChat +The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: + +- Enabled +- Disabled +- Limited: Chat is available only for the duration of the call. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch +{{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsBypassLobbyForDialInUsers +The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: + +- $true: Dial in users bypass the lobby when joining Teams meetings. +- $false: Dial in users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCopyRestrictionEnforced +The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: + +- $true: Chat messages can be copied to the clipboard. +- $false: Chat messages can't be copied to the clipboard. + +The value $null (blank) allows users to configure this setting in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEndToEndEncryptionEnabled +The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: + +- $true: Video stream encryption is enabled. +- $false: Video stream encryption is not enabled. +- $null (blank): Users configure this setting themselves in the Teams app. + +The value $null (blank) allows users to configure this setting in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyBypassScope +The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: + +- Everyone +- Invited +- Organization +- OrganizationAndFederated +- OrganizationExcludingGuests +- Organizer +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyRestrictionEnforced +The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: + +- $true: Users bypass the lobby when joining Teams meetings. +- $false: Users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsPresentersRestrictionEnforced +The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: + +- $true: Presenter restrictions are enabled in Teams meetings. +- $false: Presenter restrictions aren't enabled in Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsProtectionEnabled +The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: + +- $true: Teams protection is enabled in Teams meetings. +- $false: Teams protection is not enabled in Teams meetings. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsRecordAutomatically +The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: + +- $true: Teams meetings are automatically recorded after they start. +- $false: Teams meetings are not automatically recorded. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsVideoWatermark +The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: + +- None +- EnabledForContentSharing +- EnabledForVideo +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsWhoCanRecord +The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: + +- Organizer +- Coorganizers +- Presenters +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md new file mode 100644 index 0000000000..ce59ac07c5 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -0,0 +1,486 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-LabelPolicy + +## 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-LabelPolicy cmdlet to create sensitivity label policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-LabelPolicy -Name -Labels + [-AdvancedSettings ] + [-Comment ] + [-Confirm] + [-ExchangeLocation ] + [-ExchangeLocationException ] + [-Force] + [-MigrationId ] + [-ModernGroupLocation ] + [-ModernGroupLocationException ] + [-OneDriveLocation ] + [-OneDriveLocationException ] + [-PolicyRBACScopes ] + [-PublicFolderLocation ] + [-Setting ] + [-Settings ] + [-SharePointLocation ] + [-SharePointLocationException ] + [-SkypeLocation ] + [-SkypeLocationException ] + [-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-LabelPolicy -Name "Research and Development" -Labels "R and D","R and D Management" +``` + +This example creates the sensitivity label policy named Research and Development that contains sensitivity labels named R and D and R and D Management. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name for the policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Labels +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 +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedSettings +The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. + +Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. + +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). + +Supported settings for built-in labeling: + +- **AttachmentAction**: Unlabeled emails inherit the highest priority label from file attachments. Set the value to **Automatic** (to automatically apply the label) or **Recommended** (as a recommended prompt to the user. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{AttachmentAction="Automatic"}`. For more information about this configuration choice, see [Configure label inheritance from email attachments](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-label-inheritance-from-email-attachments). + +- **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. + +- **EnableRevokeGuiSupport**: Remove the Track & Revoke button from the sensitivity menu in Office clients. Supported apps: Word, Excel, and PowerPoint on Windows (version 2406+). Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableRevokeGuiSupport="False"}`. For more information about this configuration choice, see [Track and revoke document access](https://learn.microsoft.com/purview/track-and-revoke-admin). + +- **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **DisableShowSensitiveContent**: For Office apps that highlight the sensitive content that caused a label to be recommended, turn off these highlights and corresponding indications about the sensitive content. For more information, see [Sensitivity labels are automatically applied or recommended for your files and emails in Office](https://support.microsoft.com/office/sensitivity-labels-are-automatically-applied-or-recommended-for-your-files-and-emails-in-office-622e0d9c-f38c-470a-bcdb-9e90b24d71a1). Supported apps: Word for Windows (version 2311+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableShowSensitiveContent="True"}` + +- **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **TeamworkMandatory**: Outlook and Teams apps that support this setting can enable or disable mandatory labeling for meetings. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{TeamworkMandatory="True"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). + +- **teamworkdefaultlabelid**: Outlook and Teams apps that support this setting apply a default label, or no label for meetings. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{teamworkdefaultlabelid="General"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). + +- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) will be displayed. Users can't revert this setting in the app. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` + +Additionally, for Power BI: + +- **powerbimandatory**: Mandatory labeling for Power BI. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{powerbimandatory="true"}`. For more information about this configuration choice, see [Mandatory label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). + +- **powerbidefaultlabelid**: Default label for Power BI content. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{powerbidefaultlabelid="General"}`. For more information about this configuration choice, see [Default label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-label-policy). + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocationException +The ExchangeLocationException parameter specifies the mailboxes 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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationId +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -ModernGroupLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Settings +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkypeLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkypeLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..1182270b7a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,178 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-M365DataAtRestEncryptionPolicy [-Name] -AzureKeyIDs + [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy for multi-workload usage. For more information, see [Service encryption with Microsoft Purview Customer Key](https://learn.microsoft.com/purview/customer-key-overview). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-M365DataAtRestEncryptionPolicy -Name "Default_Policy" -AzureKeyIDs "https://contosowestusvault01.vault.azure.net/keys/Key_01","https://contosoeastusvault01.vault.azure.net/keys/Key_02" -Description "Tenant default policy" +``` + +This example creates a Microsoft 365 data-at-rest multi-workload encryption policy named Default_Policy with the specified Azure Key Vault keys and description for all users in your tenant. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureKeyIDs +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter specifies an optional description for the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/users-and-groups/New-MailContact.md b/exchange/exchange-ps/exchange/New-MailContact.md similarity index 79% rename from exchange/exchange-ps/exchange/users-and-groups/New-MailContact.md rename to exchange/exchange-ps/exchange/New-MailContact.md index bbd0124405..fcccb631e5 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/New-MailContact.md +++ b/exchange/exchange-ps/exchange/New-MailContact.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-MailContact @@ -13,30 +16,40 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailContact cmdlet to create mail contacts. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailContact [-Name] -ExternalEmailAddress [-Alias ] - [-ArbitrationMailbox ] [-Confirm] [-DisplayName ] [-DomainController ] - [-FirstName ] [-Initials ] [-LastName ] - [-MacAttachmentFormat ] - [-MessageBodyFormat ] [-MessageFormat ] - [-ModeratedBy ] [-ModerationEnabled <$true | $false>] +New-MailContact -Name -ExternalEmailAddress + [-Alias ] + [-ArbitrationMailbox ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Initials ] + [-LastName ] + [-MacAttachmentFormat ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-ModeratedBy ] + [-ModerationEnabled ] [-OrganizationalUnit ] - [-OverrideRecipientQuotas] [-PrimarySmtpAddress ] - [-SendModerationNotifications ] [-UsePreferMessageFormat <$true | $false>] - [-WhatIf] [-ExternalDirectoryObjectId ] [] + [-PrimarySmtpAddress ] + [-SendModerationNotifications ] + [-UsePreferMessageFormat ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-MailContact -Name "Chris Ashton" -ExternalEmailAddress "chris@tailspintoys.com" ``` @@ -44,52 +57,58 @@ This example creates a new mail contact named Chris Ashton. ## PARAMETERS -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. +### -Name +The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. +This value is also used for the DisplayName property if you don't use the DisplayName parameter. ```yaml -Type: ProxyAddress +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +### -ExternalEmailAddress +The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. -This value is also used for the DisplayName property if you don't use the DisplayName parameter. +In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. ```yaml -Type: String +Type: ProxyAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -100,6 +119,7 @@ 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 Default value: None @@ -110,30 +130,17 @@ Accept wildcard characters: False ### -ArbitrationMailbox 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: +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: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -141,6 +148,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -151,8 +159,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -160,6 +167,7 @@ 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 @@ -177,6 +185,7 @@ 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 Default value: None @@ -194,6 +203,7 @@ 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 @@ -209,6 +219,7 @@ 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 Default value: None @@ -224,6 +235,7 @@ 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 Default value: None @@ -239,6 +251,7 @@ 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 Default value: None @@ -250,24 +263,21 @@ Accept wildcard characters: False 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) - - UuEncode - - AppleSingle - - AppleDouble The MacAttachmentFormat and MessageFormat parameters are interdependent: - MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. - - MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. ```yaml -Type: BinHex | UuEncode | AppleSingle | AppleDouble +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 Default value: None @@ -279,22 +289,20 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. ```yaml -Type: Text | Html | TextAndHtml +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 Default value: None @@ -306,22 +314,20 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. ```yaml -Type: Text | Mime +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 Default value: None @@ -330,25 +336,16 @@ Accept wildcard characters: False ``` ### -ModeratedBy -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -357,6 +354,7 @@ 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 Default value: None @@ -368,16 +366,16 @@ Accept wildcard characters: False 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. You use the ModeratedBy parameter to specify the moderators. ```yaml -Type: $true | $false +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 Default value: None @@ -388,14 +386,11 @@ Accept wildcard characters: False ### -OrganizationalUnit 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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: +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 - - Canonical name - - Distinguished name (DN) - - GUID ```yaml @@ -403,21 +398,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideRecipientQuotas -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, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -428,7 +409,7 @@ Accept wildcard characters: False ### -PrimarySmtpAddress This parameter is available only in on-premises Exchange. -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. +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. @@ -439,6 +420,7 @@ Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -450,18 +432,17 @@ Accept wildcard characters: False 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. - - Internal: Notify senders in the organization when their messages aren't approved. - - Never: Don't notify anyone when a message isn't approved. This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). ```yaml -Type: Never | Internal | Always +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 Default value: None @@ -473,14 +454,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +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 Default value: None @@ -496,21 +477,7 @@ 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 -Accept pipeline input: False -Accept wildcard characters: False -``` -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -519,20 +486,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c5abe0d4-3004-4d25-bda6-cb6155a47142.aspx) diff --git a/exchange/exchange-ps/exchange/New-MailMessage.md b/exchange/exchange-ps/exchange/New-MailMessage.md new file mode 100644 index 0000000000..c016c6ef01 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailMessage.md @@ -0,0 +1,201 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MailMessage cmdlet to create an email message for the specified user mailbox and place the email message in the Drafts folder of the user's mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MailMessage + [[-Body] ] + [-BodyFormat ] + [-Confirm] + [-DomainController ] + [-Subject ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" -Mailbox tony +``` + +In Exchange Server 2010, this example creates a message in the Drafts folder of Tony's mailbox, with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. + +### Example 2 +```powershell +New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" +``` + +This example creates an email message in the Drafts folder with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. + +### Example 3 +```powershell +New-MailMessage -Mailbox tony@contoso.com +``` + +In Exchange Server 2010, this example creates an empty message in the Drafts folder of Tony's mailbox because no subject or message body is specified. + +### Example 4 +```powershell +New-MailMessage +``` + +This example creates an empty email message in the Drafts folder because no subject or message body is specified. + +### Example 5 +```powershell +New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -Mailbox tony -BodyFormat Html +``` + +In Exchange Server 2010, this example creates a message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. + +### Example 6 +```powershell +New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -BodyFormat Html +``` + +This example creates an email message in the Drafts folder with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. + +## PARAMETERS + +### -Body +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BodyFormat +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/users-and-groups/New-MailUser.md b/exchange/exchange-ps/exchange/New-MailUser.md similarity index 75% rename from exchange/exchange-ps/exchange/users-and-groups/New-MailUser.md rename to exchange/exchange-ps/exchange/New-MailUser.md index 0fb69b1ce1..27ea5d62e4 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/New-MailUser.md +++ b/exchange/exchange-ps/exchange/New-MailUser.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-MailUser @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailUser cmdlet to create mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,20 +32,21 @@ New-MailUser [-Name] -ExternalEmailAddress [-ImmutableId ] [-Initials ] [-LastName ] - [-MacAttachmentFormat ] + [-MacAttachmentFormat ] [-MailboxRegion ] - [-MessageBodyFormat ] - [-MessageFormat ] + [-MessageBodyFormat ] + [-MessageFormat ] [-ModeratedBy ] - [-ModerationEnabled <$true | $false>] + [-ModerationEnabled ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] [-SamAccountName ] - [-SendModerationNotifications ] - [-UsePreferMessageFormat <$true | $false>] - [-WhatIf] [] + [-SendModerationNotifications ] + [-UsePreferMessageFormat ] + [-WhatIf] + [] ``` ### EnabledUser @@ -57,49 +61,48 @@ New-MailUser [-Name] -ExternalEmailAddress -Password ] [-Initials ] [-LastName ] - [-MacAttachmentFormat ] + [-MacAttachmentFormat ] [-MailboxRegion ] - [-MessageBodyFormat ] - [-MessageFormat ] + [-MessageBodyFormat ] + [-MessageFormat ] [-ModeratedBy ] - [-ModerationEnabled <$true | $false>] + [-ModerationEnabled ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] [-SamAccountName ] - [-SendModerationNotifications ] - [-UsePreferMessageFormat <$true | $false>] - [-WhatIf] [] + [-SendModerationNotifications ] + [-UsePreferMessageFormat ] + [-WhatIf] + [] ``` -### MicrosoftOnlineServicesID +### EnableRoomMailboxAccount ``` -New-MailUser [-Name] -MicrosoftOnlineServicesID -Password [-ExternalEmailAddress ] +New-MailUser [-Name] [-MicrosoftOnlineServicesID ] [-Alias ] - [-ArbitrationMailbox ] [-Confirm] [-DisplayName ] - [-DomainController ] [-FirstName ] [-ImmutableId ] [-Initials ] [-LastName ] [-MailboxRegion ] [-ModeratedBy ] - [-ModerationEnabled <$true | $false>] + [-ModerationEnabled ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-SamAccountName ] - [-SendModerationNotifications ] - [-WhatIf] [] + [-RemotePowerShellEnabled ] + [-SendModerationNotifications ] + [-WhatIf] + [] ``` ### FederatedUser ``` -New-MailUser [-Name] -FederatedIdentity [-ExternalEmailAddress ] +New-MailUser [-Name] -FederatedIdentity + [-ExternalEmailAddress ] [-Alias ] [-ArbitrationMailbox ] [-Confirm] @@ -111,14 +114,58 @@ New-MailUser [-Name] -FederatedIdentity [-ExternalEmailAddress [-LastName ] [-MailboxRegion ] [-ModeratedBy ] - [-ModerationEnabled <$true | $false>] + [-ModerationEnabled ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] [-SamAccountName ] - [-SendModerationNotifications ] - [-WhatIf] [] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### HVEAccount +``` +New-MailUser [-Name] -Password [-HVEAccount] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### LOBAppAccount +``` +New-MailUser [-Name] -Password [-LOBAppAccount] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-ProgressAction ] + [-RemotePowerShellEnabled ] + [-SendModerationNotifications ] + [-WhatIf] + [] ``` ### MicrosoftOnlineServicesFederatedUser @@ -135,54 +182,55 @@ New-MailUser [-Name] -FederatedIdentity -MicrosoftOnlineServic [-LastName ] [-MailboxRegion ] [-ModeratedBy ] - [-ModerationEnabled <$true | $false>] + [-ModerationEnabled ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] [-SamAccountName ] - [-SendModerationNotifications ] - [-WhatIf] [] + [-SendModerationNotifications ] + [-WhatIf] + [] ``` -### EnableRoomMailboxAccount +### MicrosoftOnlineServicesID ``` -New-MailUser [-Name] [-MicrosoftOnlineServicesID ] +New-MailUser [-Name] -MicrosoftOnlineServicesID -Password + [-ExternalEmailAddress ] [-Alias ] + [-ArbitrationMailbox ] [-Confirm] [-DisplayName ] + [-DomainController ] [-FirstName ] [-ImmutableId ] [-Initials ] [-LastName ] [-MailboxRegion ] [-ModeratedBy ] - [-ModerationEnabled <$true | $false>] + [-ModerationEnabled ] [-OrganizationalUnit ] - [-RemotePowerShellEnabled <$true | $false>] - [-SendModerationNotifications ] - [-WhatIf] [] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -MicrosoftOnlineServicesID ed@tailspintoys -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) +### Example 1 +```powershell +New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -MicrosoftOnlineServicesID ed@contoso.com -Password (Get-Credential).password ``` This example creates a new mail user for Ed Meadows in the contoso.com cloud-based organization. The mail user gives Ed an account and email address in the contoso.com domain, but messages sent to Ed are delivered to his tailspintoys.com email address. -### -------------------------- Example 2 -------------------------- -``` -$password = Read-Host "Enter password" -AsSecureString; New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -UserPrincipalName ed@contoso.com -Password $password -``` - -This example is similar to the first, except contoso.com is now an on-premises Exchange organization, and you use a separate command to enter the password so it isn't stored in clear text. - ## PARAMETERS ### -Name @@ -195,6 +243,7 @@ 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 Default value: None @@ -212,6 +261,7 @@ Type: ProxyAddress Parameter Sets: DisabledUser, EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -221,9 +271,10 @@ Accept wildcard characters: False ```yaml Type: ProxyAddress -Parameter Sets: MicrosoftOnlineServicesID, FederatedUser +Parameter Sets: FederatedUser, MicrosoftOnlineServicesID Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -241,6 +292,7 @@ Type: String Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -256,6 +308,7 @@ Type: WindowsLiveId Parameter Sets: MicrosoftOnlineServicesID, MicrosoftOnlineServicesFederatedUser Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -268,6 +321,7 @@ Type: WindowsLiveId Parameter Sets: EnableRoomMailboxAccount Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -276,13 +330,20 @@ Accept wildcard characters: False ``` ### -Password -The Password parameter specifies the password for the user's account. Valid values for this parameter use the syntax (ConvertTo-SecureString -String '\' -AsPlainText -Force). +The Password parameter specifies the password for the user's account. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString -Parameter Sets: EnabledUser, MicrosoftOnlineServicesID +Parameter Sets: EnabledUser, HVEAccount, LOBAppAccount, MicrosoftOnlineServicesID Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -300,6 +361,7 @@ Type: String Parameter Sets: EnabledUser Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -308,17 +370,21 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -329,6 +395,7 @@ 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 Default value: None @@ -339,30 +406,17 @@ Accept wildcard characters: False ### -ArbitrationMailbox 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: +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: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -370,6 +424,7 @@ 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 Default value: None @@ -380,8 +435,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -389,6 +443,7 @@ 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 @@ -406,6 +461,7 @@ 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 Default value: None @@ -423,6 +479,7 @@ 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 Default value: None @@ -438,6 +495,7 @@ 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 Default value: None @@ -455,6 +513,7 @@ 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 Default value: None @@ -470,6 +529,7 @@ 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 Default value: None @@ -485,6 +545,43 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HVEAccount +This parameter is available only in the cloud-based service. + +The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: HVEAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Position: Named +Default value: None +Required: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LOBAppAccount +This parameter is available only in the cloud-based service. + +{{ Fill LOBAppAccount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: LOBAppAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -496,24 +593,21 @@ Accept wildcard characters: False 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) - - UuEncode - - AppleSingle - - AppleDouble The MacAttachmentFormat and MessageFormat parameters are interdependent: - MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. - - MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. ```yaml -Type: BinHex | UuEncode | AppleSingle | AppleDouble +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 Default value: None @@ -522,7 +616,7 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is avaialble only in the cloud-based service +This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -530,7 +624,8 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -542,22 +637,20 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. ```yaml -Type: Text | Html | TextAndHtml +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 Default value: None @@ -569,22 +662,21 @@ Accept wildcard characters: False 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) The MessageFormat and MessageBodyFormat parameters are interdependent: - MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - - MessageFormat is Text: MessageBodyFormat can only be Text. Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. ```yaml -Type: Text | Mime +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 Default value: None @@ -593,25 +685,16 @@ Accept wildcard characters: False ``` ### -ModeratedBy -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -620,6 +703,7 @@ 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 Default value: None @@ -631,16 +715,16 @@ Accept wildcard characters: False 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. You use the ModeratedBy parameter to specify the moderators. ```yaml -Type: $true | $false +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 Default value: None @@ -651,14 +735,11 @@ Accept wildcard characters: False ### -OrganizationalUnit 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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: +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 - - Canonical name - - Distinguished name (DN) - - GUID ```yaml @@ -666,6 +747,7 @@ 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 Default value: None @@ -674,9 +756,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress -This parameter is available only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. +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. @@ -684,9 +766,10 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address ```yaml Type: SmtpAddress -Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +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 @@ -695,17 +778,21 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user can connect to Exchange using remote PowerShell. Remote PowerShell is required to open the Exchange Management Shell on Exchange servers, or to use Windows PowerShell open and import a remote PowerShell session to Exchange. Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell on the local Exchange server. Valid values are: +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. -- $true: The user can use remote PowerShell. This is the default value. +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. -- $false: The user can't use remote PowerShell. +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. ```yaml -Type: $true | $false +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 Default value: None @@ -719,14 +806,14 @@ 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. ```yaml -Type: $true | $false +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 Default value: None @@ -737,13 +824,14 @@ Accept wildcard characters: False ### -SamAccountName 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 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 may 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 Default value: None @@ -755,18 +843,17 @@ Accept wildcard characters: False 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. - - Internal: Notify senders in the organization when their messages aren't approved. - - Never: Don't notify anyone when a message isn't approved. This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). ```yaml -Type: Never | Internal | Always +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 Default value: None @@ -778,14 +865,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +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 Default value: None @@ -801,6 +888,7 @@ 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 @@ -809,20 +897,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/128467a7-b8b8-4fa6-bca9-1131301f18ce.aspx) diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/exchange/New-Mailbox.md new file mode 100644 index 0000000000..8a4bb79a06 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-Mailbox.md @@ -0,0 +1,2231 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-Mailbox cmdlet to create mailboxes and user accounts at the same time. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### User +``` +New-Mailbox [-Name] -Password -UserPrincipalName [-InactiveMailbox ] [-RemovedMailbox ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### MicrosoftOnlineServicesID +``` +New-Mailbox [-Name] -Password -MicrosoftOnlineServicesID [-InactiveMailbox ] [-RemovedMailbox ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-Discovery] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### Arbitration +``` +New-Mailbox [-Name] [-Arbitration] [-Password ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-ProxyEmailAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### AuditLog +``` +New-Mailbox [-Name] -UserPrincipalName [-AuditLog] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### AuxAuditLog +``` +New-Mailbox [-Name] [-AuxAuditLog] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### DisabledUser +``` +New-Mailbox [-Name] [-AccountDisabled] [-Password ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemovedMailbox ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### Discovery +``` +New-Mailbox [-Name] [-Discovery] [-Password ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### EnableRoomMailboxAccount +``` +New-Mailbox [-Name] -EnableRoomMailboxAccount [-MicrosoftOnlineServicesID ] [-Room] [-RoomMailboxPassword ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### Equipment +``` +New-Mailbox [-Name] [-Equipment] [-Password ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### FederatedUser +``` +New-Mailbox [-Name] -FederatedIdentity [-RemovedMailbox ] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-OrganizationalUnit ] + [-Password ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RoleAssignmentPolicy ] + [-TargetAllMDBs] + [-WhatIf] + [] +``` + +### InactiveMailbox +``` +New-Mailbox [-Name] -InactiveMailbox [-Password ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemovedMailbox ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### Linked +``` +New-Mailbox [-Name] -LinkedDomainController -LinkedMasterAccount [-LinkedCredential ] [-Password ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemovedMailbox ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### LinkedRoomMailbox +``` +New-Mailbox [-Name] -LinkedDomainController -LinkedMasterAccount + [-LinkedCredential ] + [-LinkedRoom] + [-Office ] + [-Password ] + [-Phone ] + [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-ResourceCapacity ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### MicrosoftOnlineServicesFederatedUser +``` +New-Mailbox [-Name] -FederatedIdentity -MicrosoftOnlineServicesID [-RemovedMailbox ] + [-ActiveSyncMailboxPolicy ] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RoleAssignmentPolicy ] + [-TargetAllMDBs] + [-WhatIf] + [] +``` + +### Migration +``` +New-Mailbox [-Name] [-Arbitration] [-Migration] [-Password ] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### PublicFolder +``` +New-Mailbox [-Name] [-PublicFolder] [-HoldForMigration] [-IsExcludedFromServingHierarchy ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### RemoteArchive +``` +New-Mailbox [-Name] -ArchiveDomain -Password -UserPrincipalName [-RemoteArchive] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemovedMailbox ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### RemovedMailbox +``` +New-Mailbox [-Name] -RemovedMailbox [-Password ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxPlan ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### Room +``` +New-Mailbox [-Name] [-Password ] [-ResourceCapacity ] [-Room] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Office ] + [-OrganizationalUnit ] + [-Phone ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### Shared +``` +New-Mailbox [-Name] [-Password ] [-Shared] [-UserPrincipalName ] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArbitrationMailbox ] + [-Archive] + [-ArchiveDatabase ] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-TargetAllMDBs] + [-ThrottlingPolicy ] + [-WhatIf] + [] +``` + +### SupervisoryReviewPolicyMailbox +``` +New-Mailbox [-Name] [-SupervisoryReviewPolicy] + [-ActiveSyncMailboxPolicy ] + [-AddressBookPolicy ] + [-Alias ] + [-ArchiveDatabase ] + [-Archive] + [-Confirm] + [-Database ] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-Force] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-SamAccountName ] + [-SharingPolicy ] + [-ThrottlingPolicy ] + [-UserPrincipalName ] + [-WhatIf] + [] + ``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. + +## EXAMPLES + +### Example 1 +```powershell +$password = Read-Host "Enter password" -AsSecureString + +New-Mailbox -UserPrincipalName chris@contoso.com -Alias chris -Database "Mailbox Database 1" -Name ChrisAshton -OrganizationalUnit Users -Password $password -FirstName Chris -LastName Ashton -DisplayName "Chris Ashton" -ResetPasswordOnNextLogon $true +``` + +This example creates a user Chris Ashton in Active Directory and creates a mailbox for the user. The mailbox is located on Mailbox Database 1. The password must be reset at the next logon. To set the initial value of the password, this example creates a variable ($password), prompts you to enter a password, and assigns that password to the variable as a SecureString object. + +### Example 2 +```powershell +New-Mailbox -UserPrincipalName confmbx@contoso.com -Alias confmbx -Name ConfRoomMailbox -Database "Mailbox Database 1" -OrganizationalUnit Users -Room -ResetPasswordOnNextLogon $true +``` + +This example creates a user in Active Directory and a resource mailbox for a conference room. The resource mailbox is located in Mailbox Database 1. The password must be reset at the next logon. You are prompted for the value of the initial password because it's not specified. + +### Example 3 +```powershell +New-Mailbox -UserPrincipalName confroom1010@contoso.com -Alias confroom1010 -Name "Conference Room 1010" -Room -EnableRoomMailboxAccount $true -RoomMailboxPassword (Get-Credential).password +``` + +This example creates an enabled user account in Active Directory and a room mailbox for a conference room in an on-premises Exchange organization. The RoomMailboxPassword parameter prompts you to enter the password for the user account. + +### Example 4 +```powershell +New-Mailbox -Shared -Name "Sales Department" -DisplayName "Sales Department" -Alias Sales + +Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG + +Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All +``` + +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 assumes that you've already created a mail-enabled security group named "MarketingSG" by using the New-DistributionGroup cmdlet. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccountDisabled +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. + +The mailbox is created, and the associated account is created, but the account is disabled, so you can't log on to the mailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: DisabledUser +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +To create arbitration mailboxes that are used to store audit log settings or data, don't use this switch. Instead, use the AuditLog or AuxAuditLog switches. + +```yaml +Type: SwitchParameter +Parameter Sets: Arbitration +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: Migration +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 +``` + +### -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. + +Only use this parameter if the archive is hosted in the cloud-based service. + +```yaml +Type: SmtpDomain +Parameter Sets: RemoteArchive +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Discovery +The Discovery switch is required to create Discovery mailboxes. You don't need to specify a value with this switch. + +Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRoomMailboxAccount +This parameter is functional only in on-premises Exchange. + +The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: + +- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. The account is able to log in and access the room mailbox or other resources. +- $false: The account that's associated with the room mailbox is disabled. The account is not able to log in and access the room mailbox or other resources. In on-premises Exchange, this is the default value. + +You need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. + +You need to use this parameter with the Room switch. + +A room mailbox in Exchange Online is created with associated an account that has a random, unknown password. This account is active and visible in Microsoft Graph PowerShell and the Microsoft 365 admin center just like a regular user account, but it consumes no licenses. To prevent this account from being able to log in after you create the mailbox, use the AccountEnabled parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: Boolean +Parameter Sets: EnableRoomMailboxAccount +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Equipment +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). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InactiveMailbox +This parameter is available only in the cloud-based service. + +The InactiveMailbox 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 +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +```yaml +Type: MailboxIdParameter +Parameter Sets: User +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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. + +This parameter is required only if you're creating a linked mailbox. + +```yaml +Type: String +Parameter Sets: Linked, LinkedRoomMailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedMasterAccount +This parameter is available only in on-premises Exchange. + +The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: Linked, LinkedRoomMailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedRoom +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. + +A linked resource mailbox is useful in a scenario where you have an account in an authentication forest and you want it to be directly linked to a resource mailbox in resource forest. + +```yaml +Type: SwitchParameter +Parameter Sets: LinkedRoomMailbox +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftOnlineServicesID +This parameter is available only in the cloud-based service. + +The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter applies only to objects in the cloud-based service and is used instead of the UserPrincipalName parameter. The MicrosoftOnlineServicesID parameter isn't available in on-premises deployments. + +```yaml +Type: WindowsLiveId +Parameter Sets: MicrosoftOnlineServicesFederatedUser, MicrosoftOnlineServicesFederatedUser +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: WindowsLiveId +Parameter Sets: EnableRoomMailboxAccount +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password parameter specifies the password for the mailbox (the user account that's associated with the mailbox). This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the associated user accounts are disabled for these types of mailboxes. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: User, MicrosoftOnlineServicesID, RemoteArchive +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +The first public folder mailbox created in your Exchange organization is the primary hierarchy mailbox that contains the writeable copy of the hierarchy of public folders for the organization and public folder content. There can be only one writeable copy of the public folder hierarchy in your organization. All other public folder mailboxes are secondary public folder mailboxes that contain a read-only copy of the hierarchy and the content for public folders. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovedMailbox +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RemovedMailboxIdParameter +Parameter Sets: RemovedMailbox +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Room +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). + +When you use this switch in on-premises Exchange, a disabled account is created with the room mailbox. The account can't be used to sign in to the mailbox or anywhere in the organization. To enable the associated account, use the EnableRoomMailboxAccount and RoomMailboxPassword parameters. + +When you use this switch in Exchange Online, an account with a random, unknown password is created for the room mailbox. If the password is known or changed, the account can be used to log in to the mailbox or anywhere in the organization. To prevent this account from being able to log in after you create the room mailbox, use the AccountEnabled parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: EnableRoomMailboxAccount, Room +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +In the cloud-based service, use the MicrosoftOnlineServicesID parameter instead. + +```yaml +Type: String +Parameter Sets: User, Arbitration, AuditLog, RemoteArchive +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default mobile device mailbox policy is used. + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressBookPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). + +```yaml +Type: AddressBookMailboxPolicyIdParameter +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To create other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AuditLog +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxAuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To create other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AuxAuditLog +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstName +The FirstName parameter specifies the user's first name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -HoldForMigration +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. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutableId +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Initials +The Initials parameter specifies the user's middle initials. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: PublicFolder +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedCredential +This parameter is available only in on-premises Exchange. + +The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: Linked, LinkedRoomMailbox +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 +``` + +### -MailboxPlan +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: + +- Name +- Alias +- Display name +- Distinguished name (DN) +- GUID + +A mailbox plan specifies the permissions and features that are available to a mailbox. In Exchange Online, mailbox plans correspond to the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. + +You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: User, MicrosoftOnlineServicesID, DisabledUser, FederatedUser, InactiveMailbox, MicrosoftOnlineServicesFederatedUser, RemoteArchive, RemovedMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegion +This parameter is available only in the cloud-based service. + +The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. + +To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the following command: `Get-OrganizationConfig | Select -ExpandProperty AllowedMailboxRegions | Format-Table`. To view your central geo location, run the following command: `Get-OrganizationConfig | Select DefaultMailboxRegion`. + + For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderMailboxPolicy +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderMailboxPolicyAllowed +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. + +When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed switch is used. + +Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Office +The Office parameter specifies the user's physical office name or number. + +```yaml +Type: String +Parameter Sets: LinkedRoomMailbox, Room +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 +``` + +### -OrganizationalUnit +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +The Phone parameter specifies the user's telephone number. + +```yaml +Type: String +Parameter Sets: LinkedRoomMailbox, Room +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 +``` + +### -PrimarySmtpAddress +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyEmailAddress +This parameter is available only in the cloud-based service. + +{{ Fill ProxyEmailAddress Description }} + +```yaml +Type: Object +Parameter Sets: Arbitration +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteArchive +This parameter is available only in on-premises Exchange. + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: RemoteArchive +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 +``` + +### -RemotePowerShellEnabled +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. + +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. + +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +``` + +### -ResetPasswordOnNextLogon +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceCapacity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicy +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: + +- Name +- Distinguished Name (DN) +- GUID + +Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. + +Use the Get-RetentionPolicy cmdlet to see the available retention policies. + +If you don't use this parameter, the retention policy named Default MRM Policy is applied to the mailbox. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentPolicy +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 +- Distinguished name (DN) +- GUID + +In Exchange Online PowerShell, if you don't use this parameter, the default role assignment policy named Default Role Assignment Policy is automatically applied to the mailbox. In on-premises Exchange, no role assignment policy is automatically applied to the mailbox. + +Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomMailboxPassword +This parameter is functional only in on-premises Exchange. + +Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). + +To use this parameter in on-premises Exchange, you need to be a member of one of the following role groups: + +- The Organization Management role group via the Mail Recipients and User Options roles. +- The Recipient Management role group via the Mail Recipients role. +- The Help Desk role group via the User Options role. + +The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +To configure the password for a room mailbox account in Exchange Online, use [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: SecureString +Parameter Sets: EnableRoomMailboxAccount +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharingPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +Use the Get-SharingPolicy cmdlet to see the available sharing policies. + +If you don't use this parameter, the sharing policy named Default Sharing Policy is applied to the mailbox. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupervisoryReviewPolicy +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: SupervisoryReviewPolicyMailbox +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAllMDBs +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottlingPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies. + +By default, no throttling policy is applied to the mailbox. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MailboxAuditLogSearch.md b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md new file mode 100644 index 0000000000..38f9329045 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md @@ -0,0 +1,350 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-MailboxAuditLogSearch + +## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the New-MailboxAuditLogSearch cmdlet to search mailbox audit logs and have search results sent via email to specified recipients. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MailboxAuditLogSearch -EndDate -StartDate -StatusMailRecipients + [-Confirm] + [-DomainController ] + [-ExternalAccess ] + [-GroupMailbox] + [-HasAttachments ] + [-LogonTypes ] + [-Mailboxes ] + [-Name ] + [-Operations ] + [-ShowDetails] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-MailboxAuditLogSearch cmdlet performs an asynchronous search of mailbox audit logs for the specified mailboxes and sends the search results by email to the specified recipients. The body of the email message contains search metadata such as search parameters and the time when the search request was submitted. The results are attached in an .xml file. + +To search mailbox audit logs for a single mailbox and have the results displayed in the Exchange Management Shell window, use the Search-MailboxAuditLog cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-MailboxAuditLogSearch "Admin and Delegate Access" -Mailboxes "Ken Kwok","April Stewart" -LogonTypes Admin,Delegate -StartDate 1/1/2018 -EndDate 12/31/2018 -StatusMailRecipients auditors@contoso.com +``` + +This example creates a mailbox audit log search to search Ken Kwok and April Stewart's mailboxes for administrator and delegate logons from 1/1/2018 to 12/31/2018. Search results are sent to auditors@contoso.com by email. + +### Example 2 +```powershell +New-MailboxAuditLogSearch -ExternalAccess $true -StartDate 09/01/2018 -EndDate 10/24/2018 -StatusMailRecipients admin@contoso.com +``` + +This example returns entries from the mailbox audit logs of all users in organization for any mailbox access by Microsoft datacenter administrators between September 1, 2018 and October 24, 2018. The search results are sent to admin@contoso.com. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusMailRecipients +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAccess +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasAttachments +The HasAttachments parameter filters the search by messages that have attachments. Valid values are: + +- $true: Only messages with attachments are included in the search. +- $false: Messages with and without attachments are included in the search. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogonTypes +The LogonTypes parameter specifies the type of logons. Valid values are: + +- Admin: Audit log entries for mailbox access by administrator logons are returned. +- Delegate: Audit log entries for mailbox access by delegates are returned, including access by users with Full Mailbox Access permission. +- External: For Exchange Online mailboxes, audit log entries for mailbox access by Microsoft datacenter administrators are returned. +- Owner: Audit log entries for mailbox access by the primary mailbox owner are returned. This value requires the ShowDetails switch. + +You can enter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailboxes +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"`. + + If you don't specify a value, mailbox audit logs for all mailboxes in the organization are returned. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operations +The Operations parameter filters the search results by the operations that are logged by mailbox audit logging. Valid values are: + +- Copy +- Create +- FolderBind +- HardDelete +- MailboxLogin +- MessageBind +- Move +- MoveToDeletedItems +- SendAs +- SendOnBehalf +- SoftDelete +- Update + +You can enter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowDetails +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MailboxDatabase.md b/exchange/exchange-ps/exchange/New-MailboxDatabase.md new file mode 100644 index 0000000000..a16092d137 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxDatabase.md @@ -0,0 +1,350 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-MailboxDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-MailboxDatabase cmdlet to create a mailbox database, or a recovery database. Each database you create must have a unique name in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### NonRecovery +``` +New-MailboxDatabase [-Name] -Server + [-AutoDagExcludeFromMonitoring ] + [-IsExcludedFromProvisioning ] + [-IsExcludedFromInitialProvisioning] + [-IsSuspendedFromProvisioning ] + [-OfflineAddressBook ] + [-PublicFolderDatabase ] + [-Confirm] + [-DomainController ] + [-EdbFilePath ] + [-LogFolderPath ] + [-SkipDatabaseLogFolderCreation] + [-WhatIf] + [] +``` + +### Recovery +``` +New-MailboxDatabase [[-Name] ] -Server + [-Recovery] + [-Confirm] + [-DomainController ] + [-EdbFilePath ] + [-LogFolderPath ] + [-SkipDatabaseLogFolderCreation] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-MailboxDatabase -Server Server1 -Name "DB1" -EdbFilePath D:\ExchangeDatabases\DB1\DB1.edb +``` + +This example creates the mailbox database DB1 on the Mailbox server named Server1. This example also uses a non-default location for the database file. + +## PARAMETERS + +### -Name +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 +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Recovery +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AutoDagExcludeFromMonitoring +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -EdbFilePath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromInitialProvisioning +The IsExcludedFromInitialProvisioning switch specifies that this database is temporarily not considered by the mailbox provisioning load balancer. You don't need to specify a value with this switch. + +If you use this switch, new mailboxes aren't added automatically to this database. + +```yaml +Type: SwitchParameter +Parameter Sets: NonRecovery +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 +``` + +### -IsExcludedFromProvisioning +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsSuspendedFromProvisioning +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogFolderPath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineAddressBook +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderDatabase +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: NonRecovery +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 +``` + +### -SkipDatabaseLogFolderCreation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/mailboxes/New-MailboxExportRequest.md b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/New-MailboxExportRequest.md rename to exchange/exchange-ps/exchange/New-MailboxExportRequest.md index 4c07c0b775..56a97e1c20 100644 --- a/exchange/exchange-ps/exchange/mailboxes/New-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-MailboxExportRequest @@ -13,22 +16,22 @@ This cmdlet is available only in on-premises Exchange. Use the New-MailboxExportRequest cmdlet to begin the process of exporting contents of a primary mailbox or archive to a .pst file. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Mailbox (Default) +### Mailbox (Default) ``` New-MailboxExportRequest [-Mailbox] -FilePath [-AcceptLargeDataLoss] - [-AssociatedMessagesCopyOption ] + [-AssociatedMessagesCopyOption ] [-BadItemLimit ] [-BatchName ] [-CompletedRequestAgeLimit ] [-Confirm] - [-ConflictResolutionOption ] + [-ConflictResolutionOption ] [-ContentFilter ] [-ContentFilterLanguage ] [-DomainController ] @@ -40,7 +43,7 @@ New-MailboxExportRequest [-Mailbox] -FilePath ] [-MRSServer ] [-Name ] - [-Priority ] + [-Priority ] [-RemoteCredential ] [-RemoteHostName ] [-SkipMerging ] @@ -49,7 +52,7 @@ New-MailboxExportRequest [-Mailbox] -FilePath ] [-TargetRootFolder ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` @@ -57,12 +60,12 @@ New-MailboxExportRequest [-Mailbox] -FilePath -FilePath [-AcceptLargeDataLoss] - [-AssociatedMessagesCopyOption ] + [-AssociatedMessagesCopyOption ] [-BadItemLimit ] [-BatchName ] [-CompletedRequestAgeLimit ] [-Confirm] - [-ConflictResolutionOption ] + [-ConflictResolutionOption ] [-ContentFilter ] [-ContentFilterLanguage ] [-DomainController ] @@ -73,7 +76,7 @@ New-MailboxExportRequest [-Mailbox] -FilePath ] [-Name ] - [-Priority ] + [-Priority ] [-RemoteCredential ] [-RemoteHostName ] [-RequestExpiryInterval ] @@ -83,7 +86,7 @@ New-MailboxExportRequest [-Mailbox] -FilePath ] [-TargetRootFolder ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` @@ -102,55 +105,54 @@ New-MailboxExportRequest [-Mailbox] -ComplianceStor [-IsArchive] [-LargeItemLimit ] [-Name ] - [-PreferredMessageFormat ] - [-Priority ] + [-PreferredMessageFormat ] + [-Priority ] [-RequestExpiryInterval ] [-SkipMerging ] [-Suspend] [-SuspendComment ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` ## 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 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your 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. ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-MailboxExportRequest -Mailbox AylaKol -FilePath "\\SERVER01\PSTFileShare\Ayla_Recovered.pst" ``` This example exports the user Ayla Kol's primary mailbox to a .pst file on the network shared folder PSTFileShare on SERVER01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-MailboxExportRequest -Mailbox Kweku -FilePath "\\SERVER01\PSTFileShare\Kweku_Archive.pst" -IsArchive ``` This example exports the user Kweku's archive to a .pst file on the network shared folder PSTFileShare on SERVER01. -### -------------------------- Example 3 -------------------------- -``` -New-MailboxExportRequest -Mailbox Tony -ContentFilter {(body -like "*company*") -and (body -like "*profit*") -and (Received -lt "01/01/2018")} -FilePath "\\SERVER01\PSTFileShare\Tony_CompanyProfits.pst" +### Example 3 +```powershell +New-MailboxExportRequest -Mailbox Tony -ContentFilter "(Body -like '*company*') -and (body -like '*profit*') -and (Received -lt '01/01/2018')" -FilePath "\\SERVER01\PSTFileShare\Tony_CompanyProfits.pst" ``` This example exports messages that contain the words "company" and "profit" in the body of the message for the user Tony received before January 1, 2018. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell New-MailboxExportRequest -Mailbox Kweku -IncludeFolders "#Inbox#" -FilePath \\SERVER01\PSTFileShare\Kweku\InPlaceHold.pst ``` @@ -158,44 +160,6 @@ This example exports all messages from Kweku's Inbox to the .pst file InPlaceHol ## PARAMETERS -### -ComplianceStorePath -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: MailboxComplianceExportRequest -Aliases: -Applicable: Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -The FilePath parameter specifies the network share path of the .pst file to which data is exported, for example, \\\\SERVER01\\PST Files\\exported.pst. - -You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: - -- To import PST files from the share: Read permission - -- To save exported PST files to the share: Read/Write permission. - -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. - -```yaml -Type: LongPath -Parameter Sets: Mailbox, MailboxExportRequest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Mailbox The Mailbox parameter specifies the source mailbox where the contents are being exported from. @@ -204,25 +168,14 @@ In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParam In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdParameter, so you can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -230,6 +183,7 @@ Type: MailboxOrMailUserIdParameter Parameter Sets: Mailbox Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: True Position: 1 Default value: None @@ -242,6 +196,7 @@ Type: MailboxLocationIdParameter Parameter Sets: MailboxExportRequest, MailboxComplianceExportRequest Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -249,6 +204,45 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ComplianceStorePath +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: MailboxComplianceExportRequest +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +The FilePath parameter specifies the network share path of the .pst file to which data is exported, for example, \\\\SERVER01\\PST Files\\exported.pst. + +You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: + +- To import PST files from the share: Read permission +- To save exported PST files to the share: Read/Write permission. + +If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. + +```yaml +Type: LongPath +Parameter Sets: Mailbox, MailboxExportRequest +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoteCredential This parameter is reserved for internal Microsoft use. @@ -257,6 +251,7 @@ Type: PSCredential Parameter Sets: Mailbox, MailboxExportRequest Aliases: Applicable: Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -269,6 +264,7 @@ Type: PSCredential Parameter Sets: MailboxComplianceExportRequest Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -277,13 +273,18 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. +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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -295,18 +296,17 @@ Accept wildcard characters: False 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. - - MapByMessageClass: This option finds the corresponding 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: This option copies 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 option. Content filtering doesn't apply to associated messages. ```yaml -Type: DoNotCopy | MapByMessageClass | Copy +Type: FAICopyOption Parameter Sets: Mailbox, MailboxExportRequest Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -319,13 +319,14 @@ The BadItemLimit parameter specifies the maximum number of bad items that are al 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. -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. +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. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -341,6 +342,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -355,7 +357,8 @@ The CompletedRequestAgeLimit parameter specifies how long the request will be ke Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -366,8 +369,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -375,6 +377,7 @@ 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 @@ -386,22 +389,18 @@ Accept wildcard characters: False 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.) - - KeepTargetItem - - UpdateFromSource ```yaml -Type: KeepSourceItem | KeepLatestItem | KeepAll +Type: ConflictResolutionOption Parameter Sets: Mailbox, MailboxExportRequest Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -410,13 +409,25 @@ Accept wildcard characters: False ``` ### -ContentFilter -The ContentFilter parameter specifies message content to search for. Only contents that match the ContentFilter parameter will be exported into the .pst file. +**Important**: You can't use this parameter to export between two dates. If you try, you'll get system convert errors. You can export from a specific date, or export to a specific date, but not both. + +The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be exported into the .pst file. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -427,13 +438,14 @@ Accept wildcard characters: False ### -ContentFilterLanguage The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -449,6 +461,7 @@ 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 @@ -457,12 +470,12 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster -The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders: +The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. -- Deletions +If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: +- Deletions - Versions - - Purges ```yaml @@ -470,6 +483,7 @@ Type: SwitchParameter Parameter Sets: Mailbox, MailboxExportRequest Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -482,53 +496,40 @@ The ExcludeFolders parameter specifies the list of folders to exclude during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - - SentItems - - DeletedItems - - Calendar - - Contacts - - Drafts - - Journal - - Tasks - - Notes - - JunkEmail - - CommunicatorHistory - - Voicemail - - Fax - - Conflicts - - SyncIssues - - LocalFailures - - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. +To exclude the Recoverable Items folder, you must use the ExcludeDumpster parameter. + ```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 Default value: None @@ -541,53 +542,40 @@ The IncludeFolders parameter specifies the list of folders to include during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - - SentItems - - DeletedItems - - Calendar - - Contacts - - Drafts - - Journal - - Tasks - - Notes - - JunkEmail - -- CommunicationHistory - +- CommunicatorHistory - Voicemail - - Fax - - Conflicts - - SyncIssues - - LocalFailures - - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. +The Recoverable Items folder is always included if you don't use the ExcludeDumpster parameter, regardless of the list of folders you provide. + ```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 Default value: None @@ -602,7 +590,8 @@ 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 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -618,6 +607,7 @@ 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 @@ -630,9 +620,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) +- 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. @@ -642,7 +631,8 @@ 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -651,7 +641,7 @@ Accept wildcard characters: False ``` ### -MRSServer -This parameter is available or functional only in 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. @@ -660,6 +650,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -670,13 +661,14 @@ Accept wildcard characters: False ### -Name 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. +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`. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -688,10 +680,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: Default | Mime +Type: MessageCopyFormat Parameter Sets: MailboxComplianceExportRequest Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -703,24 +696,19 @@ Accept wildcard characters: False 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.) - - High - - Higher - - Highest - - Emergency ```yaml -Type: Normal | High +Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -736,6 +724,7 @@ Type: Fqdn Parameter Sets: Mailbox, MailboxExportRequest Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -747,7 +736,6 @@ Accept wildcard characters: False 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. - - If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -759,6 +747,7 @@ Type: Unlimited Parameter Sets: MailboxComplianceExportRequest, MailboxExportRequest Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -774,6 +763,7 @@ Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -788,7 +778,8 @@ The SourceRootFolder parameter specifies the root folder of the mailbox from whi Type: String Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -797,13 +788,16 @@ Accept wildcard characters: False ``` ### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -818,7 +812,8 @@ The SuspendComment parameter specifies a description about why the request was s Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -833,7 +828,8 @@ The TargetRootFolder parameter specifies the top-level folder in which to export Type: String Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -849,6 +845,7 @@ 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 @@ -857,13 +854,14 @@ Accept wildcard characters: False ``` ### -WorkloadType -The WorkloadType parameter is reserved for internal Microsoft use. +This parameter is reserved for internal Microsoft use. ```yaml -Type: None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport +Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -872,20 +870,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1625c25a-7cc9-459c-97ea-281ac421bbce.aspx) diff --git a/exchange/exchange-ps/exchange/New-MailboxFolder.md b/exchange/exchange-ps/exchange/New-MailboxFolder.md new file mode 100644 index 0000000000..8edb27513b --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxFolder.md @@ -0,0 +1,175 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MailboxFolder cmdlet to create folders in your own mailbox. Administrators can't use this cmdlet to create folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MailboxFolder [-Name] -Parent + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). . + +## EXAMPLES + +### Example 1 +```powershell +New-MailboxFolder -Parent :\Inbox -Name Personal +``` + +This example creates the folder named Personal under the Inbox folder of your own mailbox. + +### Example 2 +```powershell +New-MailboxFolder -Parent :\ -Name Personal +``` + +This example creates the folder named Personal in the root folder hierarchy of your own mailbox. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent +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. + +To specify the root folder hierarchy of your own mailbox, use the value `:\`. + +For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't specify the parent folder, the command creates the folder in the root folder hierarchy of the specified mailbox. + +Example values for this parameter are `john@contoso.com:`, `John:\Inbox` + +```yaml +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MailboxImportRequest.md b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md new file mode 100644 index 0000000000..f037f6aba2 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md @@ -0,0 +1,938 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MailboxImportRequest cmdlet to begin the process of importing a .pst file to a mailbox or archive. + +**Note**: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Mailbox +``` +New-MailboxImportRequest [-Mailbox] -FilePath + [-AcceptLargeDataLoss] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentCodePage ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-InternalFlags ] + [-IsArchive] + [-LargeItemLimit ] + [-MRSServer ] + [-Name ] + [-Priority ] + [-SkipMerging ] + [-SourceRootFolder ] + [-Suspend] + [-SuspendComment ] + [-TargetRootFolder ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +### MailboxLocationId +``` +New-MailboxImportRequest [-Mailbox] -FilePath + [-AcceptLargeDataLoss] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentCodePage ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-InternalFlags ] + [-IsArchive] + [-LargeItemLimit ] + [-MigrationMailbox ] + [-Name ] + [-Priority ] + [-RequestExpiryInterval ] + [-SkipMerging ] + [-SourceEndpoint ] + [-SourceRootFolder ] + [-Suspend] + [-SuspendComment ] + [-TargetRootFolder ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +### AzureImportRequest +``` +New-MailboxImportRequest [-Mailbox] -AzureBlobStorageAccountUri -AzureSharedAccessSignatureToken + [-AcceptLargeDataLoss] + [-AssociatedMessagesCopyOption ] + [-AzureStatusPublishEndpointInfo ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentCodePage ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-IsArchive] + [-LargeItemLimit ] + [-MRSContentFilterSasUri ] + [-MigrationBatch ] + [-MigrationMailbox ] + [-MigrationUser ] + [-Name ] + [-RequestExpiryInterval ] + [-SkipInitialConnectionValidation] + [-SkipMerging ] + [-SourceEndpoint ] + [-SourceRootFolder ] + [-SuspendComment ] + [-Suspend] + [-TargetRootFolder ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can create more than one mailbox import request per mailbox and each mailbox import request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox import request. However, to create more than 10 import requests for a mailbox, you need to specify a unique name when creating the import request, or you can remove existing import requests with the Remove-MailboxExportRequest cmdlet before starting a new import request with the default request `\MailboxImportX` (where X = 0-9). + +By default, the import checks for duplication of items and doesn't copy the data from the .pst file into the mailbox or archive if a matching item exists in the target mailbox or target archive. + +In on-premises Exchange, 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. + +## EXAMPLES + +### Example 1 +```powershell +New-MailboxImportRequest -Mailbox Ayla -FilePath \\SERVER01\PSTFiles\Recovered.pst -TargetRootFolder "RecoveredFiles" -IncludeFolders "#Inbox#" +``` + +This example imports a recovered .pst file on SERVER01 into the user Ayla's primary mailbox. Only data in the .pst file's Inbox is imported. The data is imported into the RecoveredFiles folder of the target mailbox for Ayla. + +### Example 2 +```powershell +New-MailboxImportRequest Kweku -FilePath \\server\share\User1.pst -IsArchive -TargetRootFolder / +``` + +This example imports a .pst file into Kweku's archive folder. The TargetRootFolder isn't specified; therefore, content is merged under existing folders and new folders are created if they don't already exist in the target folder structure. + +### Example 3 +```powershell +Dir \\SERVER01\PSTshareRO\Recovered\*.pst | %{ New-MailboxImportRequest -Name RecoveredPST -BatchName Recovered -Mailbox $_.BaseName -FilePath $_.FullName -TargetRootFolder SubFolderInPrimary} +``` + +This example imports all of the .pst files on a shared folder. Each .pst file name is named after a corresponding user's alias. The command creates an import request for all the .pst files and imports the data into the matching mailbox. + +## PARAMETERS + +### -Mailbox +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. + +In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdParameter, so you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxOrMailUserIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocationId +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AzureBlobStorageAccountUri +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Uri +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureSharedAccessSignatureToken +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +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. + +You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: + +- To import PST files from the share: Read permission +- To save exported PST files to the share: Read/Write permission. + +If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. + +```yaml +Type: LongPath +Parameter Sets: Mailbox, MailboxLocationId +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssociatedMessagesCopyOption +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. +- MapByMessageClass: This option finds the corresponding 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: This option copies 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 option. + +Content filtering doesn't apply to associated messages. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStatusPublishEndpointInfo +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchName +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionOption +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) +- KeepTargetItem (Exchange 2016 or later) +- UpdateFromSource (Exchange 2016 or later) + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentCodePage +The ContentCodePage parameter specifies the specific code page to use for an ANSI pst file. ANSI pst files are used in Outlook 97 to Outlook 2002. You can find the valid values in the [Code Page Identifiers](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDumpster +The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. + +If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: + +- Deletions +- Versions +- Purges + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFolders +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: + +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". + +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: + +- Inbox +- SentItems +- DeletedItems +- Calendar +- Contacts +- Drafts +- Journal +- Tasks +- Notes +- JunkEmail +- CommunicatorHistory +- Voicemail +- Fax +- Conflicts +- SyncIssues +- LocalFailures +- ServerFailures + +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. + +Wildcard characters can't be used in folder names. + +If the TargetRootFolder parameter isn't specified when the Recoverable Items folder is imported, the recoverable item content is placed in the Recoverable Items folder of the target mailbox or archive. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeFolders +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: + +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". + +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: + +- Inbox +- SentItems +- DeletedItems +- Calendar +- Contacts +- Drafts +- Journal +- Tasks +- Notes +- JunkEmail +- CommunicationHistory +- Voicemail +- Fax +- Conflicts +- SyncIssues +- LocalFailures +- ServerFailures + +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. + +Wildcard characters can't be used in folder names. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalFlags +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. + +```yaml +Type: InternalMrsFlag[] +Parameter Sets: Mailbox, MailboxLocationId +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 +``` + +### -IsArchive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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: + +- 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. + +If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationBatch +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use + +```yaml +Type: MigrationBatchIdParameter +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationUser +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MigrationUserIdParameter +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MRSContentFilterSasUri +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Uri +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MRSServer +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. + +```yaml +Type: Fqdn +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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. + +```yaml +Type: RequestPriority +Parameter Sets: Mailbox, MailboxLocationId +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 +``` + +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: MailboxLocationId, AzureImportRequest +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipInitialConnectionValidation +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: AzureImportRequest +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceRootFolder +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -SuspendComment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRootFolder +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### -WorkloadType +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RequestWorkloadType +Parameter Sets: Mailbox, MailboxLocationId +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md new file mode 100644 index 0000000000..b5e267cdc2 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md @@ -0,0 +1,347 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-MailboxRepairRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruption issues. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Database +``` +New-MailboxRepairRequest [-Database] -CorruptionType [[-StoreMailbox] ] + [-Confirm] + [-DetectOnly] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +### Mailbox +``` +New-MailboxRepairRequest [-Mailbox] -CorruptionType + [-Archive] + [-Confirm] + [-DetectOnly] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use this cmdlet on a specific mailbox or all mailboxes in a database. While this task is running, mailbox access is disrupted only for the mailbox that's currently being repaired. + +After you begin a repair request, you can't stop it unless you dismount the database. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-MailboxRepairRequest -Mailbox tony@contoso.com -CorruptionType FolderView +``` + +This example detects and repairs all folder views for the mailbox tony@contoso.com. + +### Example 2 +```powershell +New-MailboxRepairRequest -Mailbox ayla -CorruptionType ProvisionedFolder,SearchFolder -DetectOnly +``` + +This example only detects and reports on ProvisionedFolder and SearchFolder corruption issues to Ayla Kol's mailbox. This command doesn't repair the mailbox. + +### Example 3 +```powershell +New-MailboxRepairRequest -Database MBX-DB01 -CorruptionType AggregateCounts +``` + +This example detects and repairs AggregateCounts for all mailboxes on mailbox database MBX-DB01. + +### Example 4 +```powershell +New-MailboxRepairRequest -Mailbox ayla -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview -Archive +``` + +This example detects and repairs all corruption types for Ayla Kol's mailbox and archive. + +### Example 5 +```powershell +$Mailbox = Get-MailboxStatistics annb + +New-MailboxRepairRequest -Database $Mailbox.Database -StoreMailbox $Mailbox.MailboxGuid -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview +``` + +This example creates a variable that identifies Ann Beebe's mailbox and then uses the variable to specify the values for the Database and StoreMailbox parameters to create a request to detect and repair all corruption types. + +## PARAMETERS + +### -Database +The Database parameter repairs or detects corruption in all mailboxes in the specified database. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Mailbox parameter. + +To avoid performance issues, you're limited to one active database repair request at a time. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Database parameter. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StoreMailbox +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. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CorruptionType +The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: + +- AbandonedMoveDestination\*: Exchange 2016 or later, but only with the Database parameter, not the Mailbox parameter. +- AggregateCounts\*: Aggregate counts on folders that aren't reflecting correct values. +- BigFunnelMissingPOIs\*: Exchange 2016. +- BigFunnelPOI: Exchange 2019. +- CleanupFilesFolder\*: Exchange 2016 or later. +- CleanupGraphNodesWithPropertyError\*: Exchange 2016 or later. +- CleanupOfficeGraphFolders\*: Exchange 2016 or later. +- CleanupOfficeGraphSsc: Exchange 2016 or later. +- CleanupOrphanedIndexes\*: Exchange 2016 or later. +- CleanupTrendingAroundMe\*: Exchange 2016 or later. +- CorruptJunkRule\*: Exchange 2013 or later. +- CorruptSearchFolderCriteria\*: Exchange 2016 or later. +- CorruptedPerUserData\*: Exchange 2016 or later. +- DropAllLazyIndexes\*: Exchange 2013 or later. +- EmptyFilesFolder\*: Exchange 2016 or later. +- Extension1: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension2: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension3: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension4: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension5: Exchange 2013 or later, but reserved for internal Microsoft use. +- FocusedInboxCleanup\*: Exchange 2016 or later. +- FolderACL\*: Exchange 2013 or later. +- FolderView\*: Views on folders that aren't returning correct contents. +- ImapId\*: Exchange 2013 or later. +- LockedMoveTarget\*: Exchange 2013 or later, but only if the mailbox is locked. +- MessageId +- MessagePtagCn +- MissingSpecialFolders: Exchange 2013 or later. +- OlcFolderCleanup: Exchange 2016 or later. +- ProvisionedFolder: Provisioned folders that are incorrectly pointing into parent folders that aren't provisioned. +- ReduceRedundantAI\*: Exchange 2016 or later. +- RemovePICWFolder: Exchange 2016 or later, but reserved for internal Microsoft use. +- ReplState: Exchange 2013 or later. +- RestrictionFolder: Exchange 2013 or later. +- RuleMessageClass: Exchange 2013 or later. +- ScheduledCheck: Exchange 2013 or later. +- SearchFolder: Search folder corruption. +- SyncDefaultFolderLocalizationWithMailbox: Exchange 2016 or later. +- UniqueMidIndex: Exchange 2013 or later. + +You can specify multiple values separated by commas. + +\* You can only use this value by itself. + +```yaml +Type: MailboxStoreCorruptionType[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +The Archive switch specifies whether to repair or detect corruption the archive mailbox that's associated with the specified mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, only the primary mailbox is included. + +You can't use this switch with the Database parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: Mailbox +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 +``` + +### -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 +``` + +### -DetectOnly +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 +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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +This switch runs the command immediately without waiting to be dispatched by workload management. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md new file mode 100644 index 0000000000..43a1b13892 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -0,0 +1,1162 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MailboxRestoreRequest cmdlet to restore a soft-deleted or disconnected mailbox. This cmdlet starts the process of moving content from the soft-deleted mailbox, disabled mailbox, or any mailbox in a recovery database into a connected primary or archive mailbox. + +The properties used to find disconnected mailboxes and restore a mailbox are different in Exchange Server and Exchange Online. For more information about Exchange Online, see [Restore an inactive mailbox](https://learn.microsoft.com/purview/restore-an-inactive-mailbox). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-MailboxRestoreRequest -SourceDatabase -SourceStoreMailbox -TargetMailbox + [-AcceptLargeDataLoss] + [-AllowLegacyDNMismatch] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-Confirm] + [-ConflictResolutionOption ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-MRSServer ] + [-Name ] + [-Priority ] + [-SourceRootFolder ] + [-SuspendComment ] + [-Suspend] + [-TargetIsArchive] + [-TargetRootFolder ] + [-WhatIf] + [] +``` + +### CrossTenantRestore +``` +New-MailboxRestoreRequest -SourceEndpoint -SourceExchangeGuid -SourceTenant -TargetMailbox + [-AcceptLargeDataLoss] + [-AllowLegacyDNMismatch] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] + [-CrossTenantRestore] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-LargeItemLimit ] + [-Name ] + [-SkipMerging ] + [-SourceRootFolder ] + [-SuspendComment ] + [-Suspend] + [-TargetIsArchive] + [-TargetRootFolder ] + [-TargetType ] + [-WhatIf] + [] +``` + +### MigrationLocalMailboxRestore +``` +New-MailboxRestoreRequest -SourceDatabase -SourceStoreMailbox > + [-AcceptLargeDataLoss] + [-AllowLegacyDNMismatch] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-InternalFlags ] + [-LargeItemLimit ] + [-Name ] + [-Priority ] + [-RequestExpiryInterval ] + [-SkipMerging ] + [-SourceRootFolder ] + [-Suspend] + [-SuspendComment ] + [-TargetIsArchive] + [-TargetRootFolder ] + [-TargetType ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +### RemoteMailboxRestoreMailboxLocationId +``` +New-MailboxRestoreRequest -SourceStoreMailbox -TargetMailbox + [-AcceptLargeDataLoss] + [-AllowLegacyDNMismatch] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-InternalFlags ] + [-LargeItemLimit ] + [-Name ] + [-Priority ] + [-RequestExpiryInterval ] + [-SkipMerging ] + [-SourceRootFolder ] + [-Suspend] + [-SuspendComment ] + [-TargetIsArchive] + [-TargetRootFolder ] + [-TargetType ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +### RemoteMailboxRestoreMailboxId +``` +New-MailboxRestoreRequest -SourceStoreMailbox -TargetMailbox + [-AcceptLargeDataLoss] + [-AllowLegacyDNMismatch] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-InternalFlags ] + [-LargeItemLimit ] + [-Name ] + [-Priority ] + [-SkipMerging ] + [-SourceRootFolder ] + [-Suspend] + [-SuspendComment ] + [-TargetIsArchive] + [-TargetRootFolder ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +### SourceMailbox +``` +New-MailboxRestoreRequest -RemoteDatabaseGuid -RemoteHostName -RemoteRestoreType -RemoteCredential -SourceMailbox -TargetMailbox + [-AcceptLargeDataLoss] + [-AllowLegacyDNMismatch] + [-AssociatedMessagesCopyOption ] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] + [-DomainController ] + [-ExcludeDumpster] + [-ExcludeFolders ] + [-IncludeFolders ] + [-InternalFlags ] + [-LargeItemLimit ] + [-Name ] + [-Priority ] + [-RequestExpiryInterval ] + [-SkipMerging ] + [-SourceIsArchive] + [-SourceRootFolder ] + [-Suspend] + [-SuspendComment ] + [-TargetIsArchive] + [-TargetRootFolder ] + [-TargetType ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +## DESCRIPTION +When mailboxes are moved from one database to another, Exchange doesn't fully delete the mailbox from the source database immediately upon completion of the move. Instead, the mailbox in the source mailbox database is switched to a soft-deleted state, which allows mailbox data to be accessed during a mailbox restore operation by using the new MailboxRestoreRequest cmdlet set. The soft-deleted mailboxes are retained in the source database until either the deleted mailbox retention period expires or you use the Remove-StoreMailbox cmdlet to purge the mailbox. + +To view soft-deleted mailboxes, run the Get-MailboxStatistics cmdlet against a database and look for results that have a DisconnectReason with a value of SoftDeleted. For more information, see Example 1 later in this topic. + +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. + +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). + +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use the TargetRootFolder parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxStatistics -Database MBD01 | Where {$_.DisconnectReason -eq "SoftDeleted" -or $_.DisconnectReason -eq "Disabled"} | Format-List LegacyExchangeDN,DisplayName,MailboxGUID, DisconnectReason + +New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox 1d20855f-fd54-4681-98e6-e249f7326ddd -TargetMailbox Ayla +``` + +In on-premises Exchange, this example uses the Get-MailboxStatistics cmdlet to return the DisplayName, LegacyExchangeDN, and MailboxGUID (valid source mailbox identity values) for all mailboxes in the mailbox database named MBD01 that have a disconnect reason of SoftDeleted or Disabled. + +Using this information, the source mailbox with the MailboxGUID value 1d20855f-fd54-4681-98e6-e249f7326ddd is restored to the target mailbox that has the Alias value Ayla. + +### Example 2 +```powershell +New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox "Tony Smith" -TargetMailbox Tony@contoso.com -TargetIsArchive +``` + +In on-premises Exchange, this example restores the content of the source mailbox with the DisplayName of Tony Smith on mailbox database MBD01 to the archive mailbox for Tony@contoso.com. + +### Example 3 +```powershell +New-MailboxRestoreRequest -SourceMailbox 33948c06-c453-48be-bdb9-08eacd466f81 -TargetMailbox Tony@contoso.com -AllowLegacyDNMismatch +``` + +In Exchange Online, this example restores the content of the inactive, disconnected, or soft deleted source mailbox to the active mailbox for Tony@contoso.com: + +- The SourceMailbox value is the MailboxGUID value of an inactive, disconnected, or soft deleted mailbox. +- The TargetMailbox value is the MailboxGUID or email address of the active target mailbox. +- AllowLegacyDNMismatch allows copying data from one mailbox to another in this scenario. + +## PARAMETERS + +### -CrossTenantRestore +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: CrossTenantRestore +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteCredential +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PSCredential +Parameter Sets: SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteDatabaseGuid +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteHostName +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteRestoreType +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RemoteRestoreType +Parameter Sets: SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Default, MigrationLocalMailboxRestore +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: CrossTenantRestore +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceExchangeGuid +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: CrossTenantRestore +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceStoreMailbox +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. + +You can find the MailboxGUID by running the Get-MailboxStatistics cmdlet. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceTenant +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SmtpDomain +Parameter Sets: CrossTenantRestore +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetMailbox +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. + +In Exchange 2016 or later and Exchange Online, this parameter is the type MailboxLocationIdParameter. + +In Exchange 2013 or earlier, this parameter is the type MailboxOrMailUserIdParameter. + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: CrossTenantRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: MailboxOrMailUserIdParameter +Parameter Sets: Default, RemoteMailboxRestoreMailboxId +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptLargeDataLoss +The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. + +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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLegacyDNMismatch +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. + +**Note**: This parameter is being deprecated in the cloud-based service. To complete a mailbox restore request for mailboxes with a LegacyExchangeDN that doesn't match, you need to obtain the LegacyExchangeDN value for the source mailbox and add it to the target mailbox as an X500 proxy address. For detailed instructions, see [Restore an inactive mailbox](https://learn.microsoft.com/purview/restore-an-inactive-mailbox#restore-inactive-mailboxes). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -AssociatedMessagesCopyOption +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. + +Content filtering doesn't apply to associated messages. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompletedRequestAgeLimit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -ConflictResolutionOption +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.) +- KeepTargetItem +- UpdateFromSource + +```yaml +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 +Default value: KeepSourceItem +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilter +This parameter is available only in the cloud-based service. + +The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be restored. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilterLanguage +This parameter is available only in the cloud-based service. + +The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDumpster +The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. + +If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: + +- Deletions +- Versions +- Purges + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFolders +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: + +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". + +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: + +- Inbox +- SentItems +- DeletedItems +- Calendar +- Contacts +- Drafts +- Journal +- Tasks +- Notes +- JunkEmail +- CommunicatorHistory +- Voicemail +- Fax +- Conflicts +- SyncIssues +- LocalFailures +- ServerFailures + +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. + +Wildcard characters can't be used in folder names. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeFolders +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: + +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". + +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: + +- Inbox +- SentItems +- DeletedItems +- Calendar +- Contacts +- Drafts +- Journal +- Tasks +- Notes +- JunkEmail +- CommunicationHistory +- Voicemail +- Fax +- Conflicts +- SyncIssues +- LocalFailures +- ServerFailures + +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. + +Wildcard characters can't be used in folder names. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalFlags +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. + +```yaml +Type: InternalMrsFlag[] +Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox +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 +``` + +### -LargeItemLimit +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: + +- 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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MRSServer +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. + +```yaml +Type: Fqdn +Parameter Sets: Default +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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: + +- Lowest +- Lower +- Low +- Normal (This is the default value.) +- High +- Higher +- Highest +- Emergency + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestExpiryInterval +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: + +- The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: + +- FolderACLs +- FolderProperties +- FolderRules +- InitialConnectionValidation + +Use this parameter only if a restore request fails because of folder rules, folder access control lists (ACLs), or initial connection validation. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIsArchive +The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You don't need to specify a value with this switch. + +You can use this switch only with the SourceMailbox parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: SourceMailboxMailbox +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceRootFolder +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -SuspendComment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetIsArchive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRootFolder +The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. + +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. + +```yaml +Type: String +Parameter Sets: (All) +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 +``` + +### -TargetType +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) + +```yaml +Type: TargetTypeComponent +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkloadType +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RequestWorkloadType +Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/exchange/New-MailboxSearch.md new file mode 100644 index 0000000000..8c7db70175 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MailboxSearch.md @@ -0,0 +1,683 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MailboxSearch cmdlet to create a mailbox search and either get an estimate of search results, place search results on In-Place Hold or copy them to a Discovery mailbox. You can also place all contents in a mailbox on hold by not specifying a search query, which accomplishes similar results as Litigation Hold. + +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MailboxSearch [-Name] + [-AllPublicFolderSources ] + [-AllSourceMailboxes ] + [-Confirm] + [-Description ] + [-DomainController ] + [-DoNotIncludeArchive] + [-EndDate ] + [-EstimateOnly] + [-ExcludeDuplicateMessages ] + [-Force] + [-IncludeKeywordStatistics] + [-IncludeUnsearchableItems] + [-InPlaceHoldEnabled ] + [-InPlaceHoldIdentity ] + [-ItemHoldPeriod ] + [-Language ] + [-LogLevel ] + [-MessageTypes ] + [-Recipients ] + [-SearchDumpster] + [-SearchQuery ] + [-Senders ] + [-SourceMailboxes ] + [-StartDate ] + [-StatusMailRecipients ] + [-TargetMailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-MailboxSearch cmdlet creates an In-Place eDiscovery search or an In-Place Hold. You can stop, start, modify, or remove the search. + +By default, mailbox searches are performed across all Exchange 2013 or later Mailbox servers in an organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. + +For more information, see [In-Place eDiscovery in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-MailboxSearch -Name "Legal-ProjectX" -SourceMailboxes DG-Marketing,DG-Executives -TargetMailbox LegalDiscovery@contoso.com -StartDate "01/01/2018" -EndDate "12/31/2018" -Recipients "@contoso.com" -SearchQuery "project report hasattachments:true" -StatusMailRecipients "DG-DiscoveryTeam" +``` + +This example creates the mailbox search Legal-ProjectX. The search uses several parameters to restrict the search query: + +- SourceMailboxes: This parameter restricts the search to members of the DG-Marketing and DG-Executives distribution groups. +- Recipients: This parameter specifies that the search includes all mail sent to the domain contoso.com. +- SearchQuery: This parameter specifies a KQL query for messages with either the words project or report and for messages with attachments. +- StartDate and EndDate: These parameters specify the start date of January 1, 2018, and end date of December 31, 2018, for the search. +- TargetMailbox: This parameter specifies that search results should be copied to the discovery mailbox LegalDiscovery. +- StatusMailRecipients: This parameter specifies that the distribution group DG-DiscoveryTeam is to receive a notification when the search is complete. + +### Example 2 +```powershell +New-MailboxSearch -Name "Hold-ProjectX" -SourceMailboxes DG-Finance -InPlaceHoldEnabled $true +``` + +This example creates an In-Place Hold named Hold-ProjectX and places all members of the distribution group DG-Finance on hold. Because the search doesn't specify the SearchQuery and ItemHoldPeriod parameters, all messages in mailboxes returned are placed on indefinite In-Place Hold. + +### Example 3 +```powershell +New-MailboxSearch -Name "Hold-tailspintoys" -SourceMailboxes DG-Research -SearchQuery '"Patent" AND "Project tailspintoys"' -InPlaceHoldEnabled $true +``` + +This example creates an In-Place Hold named Hold-tailspintoys and places all members of the distribution group DG-Research on hold. Because the search specifies the SearchQuery parameter, only messages that match the search query are placed on indefinite In-Place Hold. + +### Example 4 +```powershell +New-MailboxSearch -Name "Hold for all PFs" -AllPublicFolderSources $true -InPlaceHoldEnabled $true +``` + +In on-premises Exchange, this example creates an In-Place Hold named Hold for all PFs that places all content in all public folders on In-Place hold, with an unlimited hold duration. + +## PARAMETERS + +### -Name +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllPublicFolderSources +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]). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllSourceMailboxes +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]). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotIncludeArchive +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. + +By default, archive mailboxes are included in the search. To exclude archive mailboxes, use this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +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 +``` + +### -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. + +If you don't use this switch, messages are copied to the target mailbox. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDuplicateMessages +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IncludeKeywordStatistics +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUnsearchableItems +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceHoldEnabled +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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceHoldIdentity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemHoldPeriod +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +The Language parameter specifies a locale for the search. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTypes +The MessageTypes parameter specifies the message types to include in the search query. Valid values are: + +- Contacts +- Docs +- Email +- IM +- Journals +- Meetings +- Notes +- Tasks + +You can specify multiple values separated by commas. + +The default value is blank ($null), which means all message types are included. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recipients +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchDumpster +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. + +The dumpster is a storage area in the mailbox where deleted items are temporarily stored after being deleted or removed from the Deleted Items folder, or after being hard-deleted and before being purged from the mailbox based on Deleted Item Retention settings. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchQuery +The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/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. + +The other search query parameters are: + +- EndDate +- MessageTypes +- Recipients +- Senders +- StartDate + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Senders +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 ("). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMailboxes +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To use this parameter, the AllSourceMailboxes parameter needs to be $false (the default value). + +The default value is blank ($null), which means no source mailboxes are specified. To clear the source mailboxes, use the value $null. + +To enable In-Place Hold on the search results, you need to set the AllSourceMailboxes parameter to $false (the default value) and configure one or both of the following settings: + +- Specify one ore more source mailboxes by using the SourceMailboxes parameter. +- In on-premises Exchange, set the AllPublicFolderSources parameter to $true. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +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 +``` + +### -StatusMailRecipients +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -TargetMailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md new file mode 100644 index 0000000000..0dd0822a20 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -0,0 +1,677 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MalwareFilterPolicy cmdlet to create malware filter policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MalwareFilterPolicy [-Name] + [-Action ] + [-AdminDisplayName ] + [-BypassInboundMessages ] + [-BypassOutboundMessages ] + [-Confirm] + [-CustomAlertText ] + [-CustomExternalBody ] + [-CustomExternalSubject ] + [-CustomFromAddress ] + [-CustomFromName ] + [-CustomInternalBody ] + [-CustomInternalSubject ] + [-CustomNotifications ] + [-DomainController ] + [-EnableExternalSenderAdminNotifications ] + [-EnableExternalSenderNotifications ] + [-EnableFileFilter ] + [-EnableInternalSenderAdminNotifications ] + [-EnableInternalSenderNotifications ] + [-ExternalSenderAdminAddress ] + [-FileTypeAction ] + [-FileTypes ] + [-InternalSenderAdminAddress ] + [-QuarantineTag ] + [-RecommendedPolicyType ] + [-WhatIf] + [-ZapEnabled ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-MalwareFilterPolicy -Name "Contoso Malware Filter Policy" -EnableInternalSenderAdminNotifications $true -InternalSenderAdminAddress admin@contoso.com +``` + +This example creates a new malware filter policy named Contoso Malware Filter Policy with the following settings: + +- Block messages that contain malware in on-premises Exchange, or quarantine the message in Exchange Online. +- Notify the administrator admin@contoso.com when malware is detected in a message from an internal sender. + +## PARAMETERS + +### -Name +The Name parameter specifies 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action +This parameter is available only in on-premises Exchange. + +The Action parameter specifies the action to take when malware is detected in a message. Valid values are: + +- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. +- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. + +```yaml +Type: MalwareFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassInboundMessages +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassOutboundMessages +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAlertText +This parameter is available only in on-premises Exchange. + +The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomExternalBody +The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomExternalSubject +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: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFromAddress +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: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFromName +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: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomInternalBody +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: + +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomInternalSubject +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: + +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomNotifications +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. +- $false: No customization is done to notification messages. The default values are used. + +This parameter is meaningful only when the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExternalSenderAdminNotifications +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. + +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExternalSenderNotifications +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFileFilter +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. +- $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. + +You specify the action for detected files using the FileTypeAction parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternalSenderAdminNotifications +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. + +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternalSenderNotifications +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalSenderAdminAddress +The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. + +This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeAction +This parameter is available only in the cloud-based service. + +The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: + +- Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the malware filter policy by the QuarantineTag parameter. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. + +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. + +```yaml +Type: FileTypeFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypes +This parameter is available only in the cloud-based service. + +The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: + +`ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` + +This parameter is meaningful only if the value of the EnableFileFilter parameter is $true. + +The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. For example, an exe file renamed to txt is detected as an exe file. If true-typing fails or isn't supported for the specified file type, then extension matching is used. + +To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. + +To add or remove file types without affecting the other file type entries, see the Examples section in the Set-MalwareFilterPolicy cmdlet topic. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalSenderAdminAddress +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTag +This parameter is available only in the cloud-based service. + +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +This parameter is available only in the cloud-based service. + +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZapEnabled +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. +- $false: ZAP for malware is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MalwareFilterRule.md b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md new file mode 100644 index 0000000000..ad4f6ad019 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md @@ -0,0 +1,357 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MalwareFilterRule cmdlet to create malware filter rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MalwareFilterRule [-Name] -MalwareFilterPolicy + [-Comments ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Anti-malware policies](https://learn.microsoft.com/defender-office-365/anti-malware-protection-about#anti-malware-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-MalwareFilterRule -Name "Contoso Recipients" -MalwareFilterPolicy "Contoso Malware Filter Policy" -RecipientDomainIs contoso.com +``` + +This example creates a new malware filter rule named Contoso Recipients with the following settings: If the recipient is in the domain contoso.com, apply the malware filter policy named Contoso Malware Filter Policy. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareFilterPolicy +The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. + +You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID. + +You can't specify the default malware filter policy, and you can't specify a policy that's already associated with another malware filter rule. + +```yaml +Type: MalwareFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/policy-and-compliance-retention/New-ManagedContentSettings.md b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md similarity index 82% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedContentSettings.md rename to exchange/exchange-ps/exchange/New-ManagedContentSettings.md index 8d458192e6..1d10f3fbcb 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ManagedContentSettings @@ -13,18 +16,24 @@ This cmdlet is available only in Exchange Server 2010. Use the New-ManagedContentSettings cmdlet to create managed content settings for managed folders. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ManagedContentSettings [-Name] -FolderName -MessageClass - [-AddressForJournaling ] [-AgeLimitForRetention ] [-Confirm] - [-DomainController ] [-JournalingEnabled <$true | $false>] [-LabelForJournaling ] - [-MessageFormatForJournaling ] [-MoveToDestinationFolder ] - [-Organization ] - [-RetentionAction ] - [-RetentionEnabled <$true | $false>] [-TriggerForRetention ] [-WhatIf] + [-AddressForJournaling ] + [-AgeLimitForRetention ] + [-Confirm] + [-DomainController ] + [-JournalingEnabled ] + [-LabelForJournaling ] + [-MessageFormatForJournaling ] + [-MoveToDestinationFolder ] + [-RetentionAction ] + [-RetentionEnabled ] + [-TriggerForRetention ] + [-WhatIf] [] ``` @@ -32,24 +41,23 @@ New-ManagedContentSettings [-Name] -FolderName - Managed content settings are settings that you associate with managed folders to control the lifespan of items in users' mailboxes. Lifespan is controlled in the following ways: - By controlling content retention and removing content that's no longer needed. - - By automatically journaling important content to a separate storage location outside the mailbox. -For more information about managed content settings, see Messaging Records Management. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell 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. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-ManagedContentSettings -Name CS-Exec-Calendar -FolderName Exec-Calendar -MessageClass Calendar -RetentionEnabled $true -RetentionAction MoveToDeletedItems -AgeLimitForRetention 180 ``` @@ -57,6 +65,22 @@ This example creates managed content settings CS-Exec-Calendar for the Calendar ## PARAMETERS +### -Name +The Name parameter specifies a unique name for the managed content settings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FolderName The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. @@ -65,6 +89,7 @@ Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -78,41 +103,27 @@ The MessageClass parameter specifies the message type to which any expiration an 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: - For All mailbox content, use the value \*. - - For the Calendar items message type, use the value IPM.Appointment\*. - - For the Contacts message type, use the value IPM.Contact\*. - - For the Documents message type, use the value IPM.Document\*. - - For the Faxes message type, use the value IPM.Note.Microsoft.Fax. - - For the Journalitems message type, use the value IPM.Activity. - - For the Meeting requests, responses, and cancellations message type, use the value IPM.Schedule\*. - - For the Notes message type, use the value IPM.StickyNote. - - For the Posts message type, use the value IPM.Post. - - For the RSS items message type, use the value IPM.Post.RSS. - - For the Tasks message type, use the value IPM.Task\*. - - For the Voice mail message type, use the value IPM.Note.Microsoft.Voicemail\*. Valid parameter values for custom message classes include: - A specific message class (for example, IPM.NOTE). - - The asterisk (\*) wildcard character, which indicates that the content settings apply to all message classes. - - A specific message class that has the asterisk wildcard character. The asterisk wildcard character must appear as the last character in the message class. For example, IPM.NOTE\* (includes IPM.NOTE and all subclasses) or IPM.NOTE.\* (includes the subclasses for IPM.NOTE but not IPM.NOTE itself). \*.NOTE and IPM.\*.NOTE aren't valid values. -Notes: +**Notes**: - When wildcard characters are used, these policies apply only to message classes that don't have a specific content setting. Therefore, IPM.NOTE.SMIME overrides IPM.NOTE.\*. - - Specific settings supersede general settings, for example, Voicemail supersedes AllMailboxContent. ```yaml @@ -120,30 +131,23 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Name -The Name parameter specifies a unique name for the managed content settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AddressForJournaling -The AddressForJournaling parameter specifies the journaling recipient to which journaled messages are sent. +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID This parameter is required if the JournalingEnabled parameter is set to $true. @@ -152,6 +156,7 @@ Type: RecipientIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -167,6 +172,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -177,8 +183,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -186,6 +191,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -201,6 +207,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -212,10 +219,11 @@ Accept wildcard characters: False The JournalingEnabled parameter specifies that journaling is enabled when set to $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -231,6 +239,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -242,14 +251,14 @@ Accept wildcard characters: False The MessageFormatForJournaling parameter specifies the message format that an item should be journaled in. You can use the following values: - UseMsg Outlook .msg format - - UseTnef Outlook MAPI format ```yaml -Type: UseMsg | UseTnef +Type: JournalingFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -267,21 +276,7 @@ Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Organization -The Organization parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named Default value: None @@ -293,22 +288,19 @@ Accept wildcard characters: False The RetentionAction parameter specifies one of the following actions: - Mark as past retention limit - - Move to a managed custom folder - - Move to the Deleted Items folder - - Delete and allow recovery - - Permanently delete If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml -Type: MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit | MoveToArchive +Type: RetentionAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -320,10 +312,11 @@ Accept wildcard characters: False The RetentionEnabled parameter specifies that retention is enabled when set to $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -337,7 +330,6 @@ The TriggerForRetention parameter specifies the date that's considered as the st 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. @@ -345,10 +337,11 @@ This value corresponds to the 0x4 bit of the msExchELCFlags attribute in Active If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml -Type: WhenDelivered | WhenMoved +Type: RetentionDateType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -364,6 +357,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -372,20 +366,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cbb71121-b857-4d1f-8806-952e42841a9b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedFolder.md b/exchange/exchange-ps/exchange/New-ManagedFolder.md similarity index 78% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedFolder.md rename to exchange/exchange-ps/exchange/New-ManagedFolder.md index 398b5c4681..da5d39bc23 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/New-ManagedFolder.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ManagedFolder @@ -15,71 +18,69 @@ Use the New-ManagedFolder cmdlet to create a managed folder object for messaging This command doesn't accept pipelined input. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ManagedDefaultFolder ``` -New-ManagedFolder [-Name] -DefaultFolderType - [-BaseFolderOnly <$true | $false>] +New-ManagedFolder [-Name] -DefaultFolderType + [-BaseFolderOnly ] [-Comment ] [-Confirm] [-DomainController ] [-LocalizedComment ] - [-MustDisplayCommentEnabled <$true | $false>] - [-Organization ] - [-WhatIf] [] + [-MustDisplayCommentEnabled ] + [-WhatIf] + [] ``` ### ManagedCustomFolder ``` -New-ManagedFolder [-Name] -FolderName [-LocalizedFolderName ] [-StorageQuota ] - [-BaseFolderOnly <$true | $false>] +New-ManagedFolder [-Name] -FolderName + [-LocalizedFolderName ] + [-StorageQuota ] + [-BaseFolderOnly ] [-Comment ] [-Confirm] [-DomainController ] [-LocalizedComment ] - [-MustDisplayCommentEnabled <$true | $false>] - [-Organization ] - [-WhatIf] [] + [-MustDisplayCommentEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION The New-ManagedFolder cmdlet creates a new managed folder in Active Directory. After a new managed folder object is created, the following steps need to be taken to use it for MRM: -- Create managed content settings for the folder. For information, see Create Managed Content Settings. - +- Create managed content settings for the folder. For information, see [Create Managed Content Settings](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/aa997968(v=exchg.141)). - Link the managed folder to an existing managed folder mailbox policy or create a managed folder mailbox policy and link the managed folder to it. - - Apply a managed folder mailbox policy to a user's mailbox. For information, seeApply a Managed Folder Mailbox Policy to Users. - -- Ensure the managed folder assistant is scheduled or run the managed folder assistant manually. For information about scheduling the managed folder assistant, see Configure the Managed Folder Assistant. When the managed folder assistant runs, it configures default folders as managed and creates any managed custom folders in the user's mailbox with the settings specified. - -- For more information about the steps to implement MRM in Microsoft Exchange Server 2010, see Deploying Messaging Records Management. +- Ensure the managed folder assistant is scheduled or run the managed folder assistant manually. For information about scheduling the managed folder assistant, see [Configure the Managed Folder Assistant](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123958(v=exchg.141)). When the managed folder assistant runs, it configures default folders as managed and creates any managed custom folders in the user's mailbox with the settings specified. +- For more information about the steps to implement MRM in Microsoft Exchange Server 2010, see [Deploying Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123548(v=exchg.141)). By default, managed custom folders are created with this cmdlet. However, you can also create additional copies of managed default folders using the DefaultFolderType parameter to specify which type of default folder to create (for example, an additional Inbox folder). When you create multiple copies of a managed default folder, you can assign different content settings to each one. For example, you could have two Inbox folders, one named InboxSixMonths and another named InboxOneYear. Then, you could assign a retention time of six months to the first folder and one year to the second folder with the New-ManagedContentSettings cmdlet (or using the New Managed Content Settings wizard in the Exchange Management Console). You must assign a unique name (using the Name parameter) to each of the managed default folders that you create. Users, however, always see the unaltered default folder name. In the example, whether users are assigned an InboxSixMonths folder or an InboxOneYear folder, the Inbox that they see in their mailbox is labeled Inbox. Although the folder names that users see in their mailboxes can be reassigned for managed custom folders (using the Set-ManagedFolder command FolderName parameter), the folder names seen by users for managed default folders can't be changed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ManagedFolder -Name NewFolder -FolderName "New Folder" -StorageQuota "1 MB" ``` This example creates a managed folder that has a maximum capacity of 1 MB. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-ManagedFolder -Name MyFolder -FolderName "My Folder" -LocalizedFolderName Spanish:"Mi Carpeta", French:"Mon Dossier" -Comment "My comment" -LocalizedComment Spanish:"Mi comentario", French:"Mon annotation" ``` This example creates a managed folder that has a default folder name and comment in English, localized folder name in Spanish and French, and localized comment in Spanish and French. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-ManagedFolder -Name AnotherInbox -DefaultFolderType Inbox ``` @@ -87,6 +88,24 @@ This example creates an instance of the default folder Inbox. ## PARAMETERS +### -Name +The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in clients, the Name parameter is used by Exchange administration tools to represent the managed folder object. + +The Name parameter shouldn't be confused with the FolderName parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultFolderType The DefaultFolderType parameter specifies the type of default folder to create, such as Inbox or Deleted Items. @@ -99,42 +118,28 @@ If a value isn't entered for the DefaultFolderType parameter, it's treated as a The default folder types that you can specify are: - Calendar - - Contacts - - DeletedItems - - Drafts - - Inbox - - JunkEmail - - Journal - - Notes - - Outbox - - SentItems - - Tasks - - All - - ManagedCustomFolder - - RssSubscriptions - - SyncIssues - - ConversationHistory ```yaml -Type: Calendar | Contacts | DeletedItems | Drafts | Inbox | JunkEmail | Journal | Notes | Outbox | SentItems | Tasks | All | RssSubscriptions | SyncIssues | ConversationHistory +Type: DefaultManagedFolderType Parameter Sets: ManagedDefaultFolder Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -152,25 +157,9 @@ Type: String Parameter Sets: ManagedCustomFolder Aliases: Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in clients, the Name parameter is used by Exchange administration tools to represent the managed folder object. - -The Name parameter shouldn't be confused with the FolderName parameter. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -180,10 +169,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -199,6 +189,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -209,8 +200,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -218,6 +208,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -233,6 +224,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -248,6 +240,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -263,6 +256,7 @@ Type: MultiValuedProperty Parameter Sets: ManagedCustomFolder Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -274,27 +268,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Organization -This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. - -The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named Default value: None @@ -310,6 +288,7 @@ Type: Unlimited Parameter Sets: ManagedCustomFolder Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -325,6 +304,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -333,20 +313,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fcc46b8b-0ceb-495a-b9e7-264bb96dc050.aspx) diff --git a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md new file mode 100644 index 0000000000..0a4c872b09 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md @@ -0,0 +1,148 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ManagedFolderMailboxPolicy + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the New-ManagedFolderMailboxPolicy cmdlet to create a managed folder mailbox policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ManagedFolderMailboxPolicy [-Name] + [-Confirm] + [-DomainController ] + [-ManagedFolderLinks ] + [-WhatIf] + [] +``` + +## 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). + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-ManagedFolderMailboxPolicy -Name "My Managed Folder Mailbox Policy" -ManagedFolderLinks Inbox, MyFolder +``` + +This example creates the managed folder mailbox policy My Managed Folder Mailbox Policy, with a list of managed folders to which the managed folder mailbox policy is to be linked. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderLinks +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/exchange/New-ManagementRole.md new file mode 100644 index 0000000000..84f1b34a67 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ManagementRole.md @@ -0,0 +1,265 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-ManagementRole cmdlet to create a management role based on an existing role or create an unscoped management role. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### NewDerivedRole +``` +New-ManagementRole [-Name] -Parent + [-EnabledCmdlets ] + [-Confirm] + [-Description ] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +### UnScopedTopLevelRole +``` +New-ManagementRole [-Name] + [-UnScopedTopLevel] + [-Confirm] + [-Description ] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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. + +The ability to create an unscoped management role isn't granted by default. To create an unscoped management role, you must assign the management role named Unscoped Role Management to a role group you're a member of. For more information about how to create an unscoped management role, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). + +After you create a role, you can change the management role entries on the role and assign the role with a management scope to a user or universal security group (USG). + +For more information about management roles, see [Understanding management roles](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-ManagementRole -Name "Redmond Journaling View-Only" -Parent Journaling + +Get-ManagementRoleEntry "Redmond Journaling View-Only\*" | Where { $_.Name -NotLike "Get*" } | %{Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} +``` + +This example creates the management role Redmond Journaling View-Only based on the Journaling parent role. + +After the role is created, the Remove-ManagementRoleEntry cmdlet is used along with the Where cmdlet to remove all the management role entries that aren't needed on the role. You can't add role entries to the newly created role because it already has all the role entries that exist on its parent role, Journaling. + +For more information about pipelining and the Where cmdlet, see the following topics: + +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help) + +### Example 2 +```powershell +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. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -UnScopedTopLevel +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). + +The UnScopedTopLevel switch specifies that the role new role is an unscoped top-level management role (a custom, empty role). You don't need to specify a value with this switch. + +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). + +You can't use this switch with the Parent parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: UnScopedTopLevelRole +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledCmdlets +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. + +```yaml +Type: String[] +Parameter Sets: NewDerivedRole +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md new file mode 100644 index 0000000000..9cd0581b13 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -0,0 +1,614 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-ManagementRoleAssignment cmdlet to assign a management role to a management role group, management role assignment policy, user, or universal security group (USG). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### App +``` +New-ManagementRoleAssignment [[-Name] ] -Role -App [-CustomResourceScope ] + [-Confirm] + [-Delegating] + [-Force] + [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] + [-WhatIf] + [] +``` + +### Computer +``` +New-ManagementRoleAssignment [[-Name] ] -Computer -Role + [-Confirm] + [-CustomConfigWriteScope ] + [-CustomRecipientWriteScope ] + [-DomainController ] + [-ExclusiveConfigWriteScope ] + [-ExclusiveRecipientWriteScope ] + [-Force] + [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] + [-RecipientOrganizationalUnitScope ] + [-RecipientRelativeWriteScope ] + [-UnScopedTopLevel] + [-WhatIf] + [] +``` + +### Policy +``` +New-ManagementRoleAssignment [[-Name] ] -Policy -Role + [-Confirm] + [-CustomConfigWriteScope ] + [-CustomRecipientWriteScope ] + [-DomainController ] + [-ExclusiveConfigWriteScope ] + [-ExclusiveRecipientWriteScope ] + [-Force] + [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] + [-RecipientOrganizationalUnitScope ] + [-RecipientRelativeWriteScope ] + [-UnScopedTopLevel] + [-WhatIf] + [] +``` + +### SecurityGroup +``` +New-ManagementRoleAssignment [[-Name] ] -Role -SecurityGroup + [-Delegating] + [-Confirm] + [-CustomConfigWriteScope ] + [-CustomRecipientWriteScope ] + [-DomainController ] + [-ExclusiveConfigWriteScope ] + [-ExclusiveRecipientWriteScope ] + [-Force] + [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] + [-RecipientOrganizationalUnitScope ] + [-RecipientRelativeWriteScope ] + [-UnScopedTopLevel] + [-WhatIf] + [] +``` + +### User +``` +New-ManagementRoleAssignment [[-Name] ] -Role -User + [-Delegating] + [-Confirm] + [-CustomConfigWriteScope ] + [-CustomRecipientWriteScope ] + [-DomainController ] + [-ExclusiveConfigWriteScope ] + [-ExclusiveRecipientWriteScope ] + [-Force] + [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] + [-RecipientOrganizationalUnitScope ] + [-RecipientRelativeWriteScope ] + [-UnScopedTopLevel] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you add a new role assignment, you can specify a built-in or custom role that was created using the New-ManagementRole cmdlet and specify an organizational unit (OU) or predefined or custom management scope to restrict the assignment. + +You can create custom management scopes using the New-ManagementScope cmdlet and can view a list of existing scopes using the Get-ManagementScope cmdlet. If you choose not to specify an OU, or predefined or custom scope, the implicit write scope of the role applies to the role assignment. + +For more information about management role assignments, see [Understanding management role assignments](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-ManagementRoleAssignment -Role "Mail Recipients" -SecurityGroup "Tier 2 Help Desk" +``` + +This example assigns the Mail Recipients role to the Tier 2 Help Desk role group. + +### Example 2 +```powershell +Get-ManagementRole "MyVoiceMail" | Format-Table Name, IsEndUserRole + +New-ManagementRoleAssignment -Role "MyVoiceMail" -Policy "Sales end-users" +``` + +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. + +### Example 3 +```powershell +New-ManagementRoleAssignment -Role "Eng Help Desk" -SecurityGroup "Eng HD Personnel" -RecipientOrganizationalUnitScope contoso.com/Engineering/Users +``` + +This example assigns the Eng Help Desk role to the Eng HD Personnel role group. The assignment restricts the recipient write scope of the role to the contoso.com/Engineering/Users OU. Users who are members of the Eng HD Personnel role group can only create, modify, or remove objects contained within that OU. + +### Example 4 +```powershell +New-ManagementRoleAssignment -Role "Distribution Groups" -SecurityGroup "North America Exec Assistants" -CustomRecipientWriteScope "North America Recipients" +``` + +This example assigns the Distribution Groups role to the North America Exec Assistants role group. The assignment restricts the recipient write scope of the role to the scope specified in the North America Recipients custom recipient management scope. Users who are members of the North America Exec Assistants role group can only create, modify, or remove distribution group objects that match the specified custom recipient management scope. + +### Example 5 +```powershell +New-ManagementRoleAssignment -Name "Exchange Servers_John" -Role "Exchange Servers" -User John -CustomConfigWriteScope "Sydney Servers" +``` + +This example assigns the Exchange Servers role to John. Because John should only manage the servers running Exchange located in Sydney, the role assignment restricts the configuration write scope of the role to the scope specified in the Sydney Servers custom configuration role group. John can only manage servers that match the specified custom configuration management scope. + +### Example 6 +```powershell +New-ManagementRoleAssignment -Name "Excl-Mail Recipients_Executive Administrators" -Role "Mail Recipients" -SecurityGroup "Executive Administrators" -ExclusiveRecipientWriteScope "Exclusive-Executive Recipients" +``` + +This example assigns the Mail Recipients role to the Executive Administrators role group. The assignment restricts the recipient write scope of the role to the scope specified in the Exclusive-Executive Recipients exclusive recipient management scope. Because the Exclusive-Executive Recipients scope is an exclusive scope, only users of the Executive Administrators can manage the executive recipients that match the exclusive recipient scope. No other users, unless they're also assigned an assignment that uses an exclusive scope that matches the same users, can modify the executive recipients. + +### Example 7 +```powershell +New-ManagementRoleAssignment -Name "Mail Recipients_Contoso Seattle" -Role "Mail Recipients" -SecurityGroup "Contoso Sub - Seattle" -CustomConfigWriteScope "Contoso Databases" -RecipientOrganizationalUnitScope adatum.com/Contoso/Seattle/Users +``` + +This example assigns the Mail Recipients role to the Contoso Sub - Seattle role group. The administrators in this role group should only be allowed to create and manage mail recipients in specific databases that have been allocated for use by the Contoso subsidiary, A. Datum Corporation (adatum.com). Also, this group of administrators should only be allowed to manage the Contoso employees located in the Seattle office. This is done by creating a role assignment with both a database scope, to limit management of mail recipients to only the databases in the database scope and a recipient OU scope, to limit access to only the recipient objects within the Contoso Seattle OU. + +## 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -App +This parameter is available only in the cloud-based service. + +The App parameter specifies the service principal to assign the management role to. Specifically, the ObjectId GUID value from the output of the Get-ServicePrincipal cmdlet (for example, 6233fba6-0198-4277-892f-9275bf728bcc). + +For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +You can't use this parameter with the SecurityGroup, Policy, or User cmdlets. + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: App +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Computer +This parameter is available only in on-premises Exchange. + +The Computer parameter specifies the name of the computer to assign the management role to. + +You can't use this parameter with the SecurityGroup, User, or Policy parameters. + +```yaml +Type: ComputerIdParameter +Parameter Sets: Computer +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +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. + +You can't use this parameter with the App, SecurityGroup, Computer, or User parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The Role parameter specifies the existing role to assign. You can use any value that uniquely identifies the role. For example: + +- Name +- Distinguished name (DN) +- GUID + +If the value contains spaces, enclose the value in quotation marks ("). + +If you use the App parameter, you can't specify admin or user roles; you can only specify application roles (for example, "Application Mail.Read"). + +```yaml +Type: RoleIdParameter +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SecurityGroup +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the user to assign the management role to. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +You can't use this parameter with the App, SecurityGroup, Computer, or Policy parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomConfigWriteScope +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 ("). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomRecipientWriteScope +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomResourceScope +This parameter is available only in the cloud-based service. + +The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +If the value contains spaces, enclose the value in quotation marks ("). + +You use this parameter with the App parameter to assign permissions to service principals. For more information, see For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +```yaml +Type: ManagementScopeIdParameter +Parameter Sets: App +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegating +The Delegating 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Computer, Policy, SecurityGroup, User +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 +``` + +### -ExclusiveConfigWriteScope +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 ("). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusiveRecipientWriteScope +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAdministrativeUnitScope +This parameter is functional only in the cloud-based service. + +The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the new role assignment to. + +Administrative units are Microsoft Entra containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. + +```yaml +Type: AdministrativeUnitIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientGroupScope +This parameter is available only in the cloud-based service. + +The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. + +```yaml +Type: GroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientOrganizationalUnitScope +The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientRelativeWriteScope +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnScopedTopLevel +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). + +The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. + +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ManagementScope.md b/exchange/exchange-ps/exchange/New-ManagementScope.md new file mode 100644 index 0000000000..c2fcc0e2d9 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ManagementScope.md @@ -0,0 +1,411 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-ManagementScope cmdlet to create a regular or exclusive management scope. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DatabaseList +``` +New-ManagementScope [-Name] -DatabaseList + [-Confirm] + [-DomainController ] + [-Exclusive] + [-Force] + [-WhatIf] + [] +``` + +### DatabaseFilter +``` +New-ManagementScope [-Name] -DatabaseRestrictionFilter + [-Confirm] + [-DomainController ] + [-Exclusive] + [-Force] + [-WhatIf] + [] +``` + +### RecipientFilter +``` +New-ManagementScope [-Name] -RecipientRestrictionFilter + [-Confirm] + [-DomainController ] + [-Exclusive] + [-Force] + [-RecipientRoot ] + [-WhatIf] + [] +``` + +### ServerList +``` +New-ManagementScope [-Name] -ServerList + [-Confirm] + [-DomainController ] + [-Exclusive] + [-Force] + [-WhatIf] + [] +``` + +### ServerFilter +``` +New-ManagementScope [-Name] -ServerRestrictionFilter + [-Confirm] + [-DomainController ] + [-Exclusive] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +After you create a regular or exclusive scope, you need to associate the scope with a management role assignment. To associate a scope with a role assignment, use the New-ManagementRoleAssignment cmdlet. For more information about adding new management scopes, see [Create a regular or exclusive scope](https://learn.microsoft.com/exchange/create-a-regular-or-exclusive-scope-exchange-2013-help). + +For more information about regular and exclusive scopes, see [Understanding management role scopes](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-ManagementScope -Name "Mailbox Servers 1 through 3" -ServerList MailboxServer1, MailboxServer2, MailboxServer3 +``` + +This example creates a scope that includes only the servers MailboxServer1, MailboxServer2, and MailboxServer3. Users assigned roles using management role assignments that have the scope in this example can only perform against the servers included in the scope. + +### Example 2 +```powershell +New-ManagementScope -Name "Redmond Site Scope" -ServerRestrictionFilter "ServerSite -eq 'CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com'" +``` + +This example creates the scope named Redmond Site Scope and sets a server restriction filter that matches only the servers located in the "CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com" Active Directory Domain Services (AD DS) site. + +### Example 3 +```powershell +New-ManagementScope -Name "Executive Mailboxes" -RecipientRoot "contoso.com/Executives" -RecipientRestrictionFilter "RecipientType -eq 'UserMailbox'" +``` + +This example creates the Executive Mailboxes scope. Only mailboxes located within the Executives OU in the contoso.com domain match the recipient restriction filter. + +### Example 4 +```powershell +New-ManagementScope -Name "Protected Exec Users" -RecipientRestrictionFilter "Title -like 'VP*'" -Exclusive + +New-ManagementRoleAssignment -SecurityGroup "Executive Administrators" -Role "Mail Recipients" -CustomRecipientWriteScope "Protected Exec Users" +``` + +This example creates the Protected Exec Users exclusive scope. Users that contain the string "VP" in their title match the recipient filter for the scope. When the exclusive scope is created, all users are immediately blocked from modifying the recipients that match the exclusive scope until the scope is associated with a management role assignment. If other role assignments are associated with other exclusive scopes that match the same recipients, those assignments can still modify the recipients. + +The exclusive scope is then associated with a management role assignment that assigns the Mail Recipients management role to the Executive Administrators role group. This role group contains administrators who are allowed to modify the mailboxes of high-profile executives. Only the administrators of the Executive Administrators role group can modify users with the string "VP" in their title. + +### Example 5 +```powershell +New-ManagementScope -Name "Seattle Databases" -DatabaseRestrictionFilter "Name -Like 'SEA*'" +``` + +This example creates the Seattle Databases scope and sets a database restriction filter that matches only the databases that begin with the string "SEA". + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseList +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: + +- Name +- Distinguished name (DN) +- GUID + +You can specify multiple values separated by commas. If the values contain spaces, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use this parameter with the DatabaseRestrictionFilter, ServerList, RecipientRestrictionFilter, RecipientRoot, or ServerRestrictionFilter parameters. + +```yaml +Type: DatabaseIdParameter[] +Parameter Sets: DatabaseList +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRestrictionFilter +This parameter is available only in on-premises Exchange. + +The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable database properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter with the RecipientRestrictionFilter, ServerRestrictionFilter, RecipientRoot, DatabaseList, or ServerList parameters. + +```yaml +Type: String +Parameter Sets: DatabaseFilter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientRestrictionFilter +The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerList +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can specify multiple values separated by commas. If the values contains spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use this parameter with the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerRestrictionFilter parameters. + +```yaml +Type: ServerIdParameter[] +Parameter Sets: ServerList +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerRestrictionFilter +This parameter is available only in on-premises Exchange. + +The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable server properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerList parameters. + +```yaml +Type: String +Parameter Sets: ServerFilter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Exclusive +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. + +```yaml +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 +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. + +Use this switch to create an exclusive scope without showing the warning that the exclusive scope takes effect immediately. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientRoot +The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the ServerRestrictionFilter or DatabaseRestrictionFilter parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 +Use two-letter country codes (ISO 3166-1 alpha-2) instead of the full country name in filters. For example, use `-RecipientRestrictionFilter "UsageLocation -eq 'FR'"` for France. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md new file mode 100644 index 0000000000..54765cae91 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md @@ -0,0 +1,313 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-MapiVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-MapiVirtualDirectory cmdlet to create Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-MapiVirtualDirectory + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-IISAuthenticationMethods ] + [-InternalUrl ] + [-Role ] + [-Server ] + [-WebSiteName ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-MapiVirtualDirectory -InternalUrl https://contoso.com/mapi -IISAuthenticationMethods NTLM,Negotiate,OAuth +``` + +This example creates a new MAPI virtual directory that has the following configuration: + +- Internal URL: `https://contoso.com/mapi` +- IIS authentication methods: NTLM, Negotiate and OAuth. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionFlags +The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: + +- None: This is the default setting. +- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. +- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. +- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionSPNList +The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: + +- $null: This is the default value. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionTokenChecking +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: + +- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. + +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. + +```yaml +Type: ExtendedProtectionTokenCheckingMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUrl +The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. + +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`. + +When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IISAuthenticationMethods +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 +- Negotiate +- NTLM +- OAuth + +You can specify multiple values separated by commas. + +The default values are NTLM, OAuth, and Negotiate. We recommend that you always have the virtual directory configured for OAuth. + +For more information about the different authentication methods, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication) and [What is OAuth authentication?](https://learn.microsoft.com/exchange/using-oauth-authentication-to-support-ediscovery-in-an-exchange-hybrid-deployment-exchange-2013-help#what-is-oauth-authentication). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalUrl +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`. + +When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +This parameter is available only in Exchange Server 2013. + +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. +- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. + +Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. + +```yaml +Type: VirtualDirectoryRole +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: ServerIdParameter +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 +``` + +### -WebSiteName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/New-MessageClassification.md b/exchange/exchange-ps/exchange/New-MessageClassification.md new file mode 100644 index 0000000000..2692993652 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MessageClassification.md @@ -0,0 +1,316 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MessageClassification cmdlet to create a message classification instance in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Localized +``` +New-MessageClassification [-Name] -DisplayName -Locale -SenderDescription + [-Confirm] + [-DomainController ] + [-RecipientDescription ] + [-WhatIf] + [] +``` + +### Identity +``` +New-MessageClassification [-Name] -DisplayName -SenderDescription + [-ClassificationID ] + [-Confirm] + [-DisplayPrecedence ] + [-DomainController ] + [-PermissionMenuVisible ] + [-RecipientDescription ] + [-RetainClassificationEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +After you create a new message classification, you can specify the message classification as a transport rule predicate. Before Microsoft Outlook and Outlook on the web users can apply the message classification to messages, you need to update the end-user systems with the message classification XML file created by the Export-OutlookClassification.ps1 script file. The Export-OutlookClassification.ps1 script file is located in the %ExchangeInstallPath%Scripts directory. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-MessageClassification -Name "My Message Classification" -DisplayName "New Message Classification" -SenderDescription "This is the description text" +``` + +This example creates the message classification named My Message Classification with the following properties: + +- The display name is New Message Classification. +- The sender description is "This is the description text". + +### Example 2 +```powershell +New-MessageClassification -Name "My Message Classification" -Locale es-ES -DisplayName "España Example" -SenderDescription "Este es el texto de la descripción" +``` + +In on-premises Exchange, this example creates a locale-specific (Spanish - Spain) version of an existing message classification named "My Message Classification". + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +This parameter is functional on in on-premises Exchange. + +The Locale parameter specifies a locale-specific version of an existing message classification. You use the -Name parameter to identify the existing message classification, and the SenderDescription parameter to specify the descriptive text in another language. + +A valid value for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class (for example, da-DK for Danish or ja-JP for Japanese). For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDescription +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationID +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 ""`. + +```yaml +Type: Guid +Parameter Sets: Identity +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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: + +- Highest +- Higher +- High +- MediumHigh +- Medium (This is the 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionMenuVisible +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDescription +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainClassificationEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MigrationBatch.md b/exchange/exchange-ps/exchange/New-MigrationBatch.md new file mode 100644 index 0000000000..e17cdd2090 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MigrationBatch.md @@ -0,0 +1,2018 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MigrationBatch cmdlet to submit a new migration request for a batch of users. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Abch +``` +New-MigrationBatch -Name -CSVData [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-Locale ] + [-NotificationEmails ] + [-ReportInterval ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TargetDatabases ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Analysis +``` +New-MigrationBatch -Name -CSVData [-Analyze] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-ExcludeFolders ] + [-IncludeFolders ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipDetails] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### FolderMove +``` +New-MigrationBatch -Name -CSVData + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-LargeItemLimit ] + [-MoveOptions ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### GoogleResourceOnboarding +``` +New-MigrationBatch -Name -CSVData + [-AdoptPreexisting] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-GoogleResource] + [-NotificationEmails ] + [-Partition ] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipDelegates] + [-SkipMerging ] + [-SkipProvisioning] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Local +``` +New-MigrationBatch [-Local] -Name -CSVData [-DisallowExistingUsers] [-WorkloadType ] [-WorkflowControlFlags ] + [-AdoptPreexisting] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-ArchiveOnly] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-Locale ] + [-MoveOptions ] + [-NotificationEmails ] + [-Partition ] + [-PrimaryOnly] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipMoving ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TargetArchiveDatabases ] + [-TargetDatabases ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### LocalPublicFolder +``` +New-MigrationBatch -Name -CSVData -SourcePublicFolderDatabase + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-LargeItemLimit ] + [-Locale ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipMerging ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### ManagedGmailTeams +``` +New-MigrationBatch -Name -CSVData [-ManagedGmailTeams] + [-AdoptPreexisting] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipCalendar] + [-SkipContacts] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Offboarding +``` +New-MigrationBatch -Name -CSVData [-DisallowExistingUsers] + [-AdoptPreexisting] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-ArchiveDomain ] + [-ArchiveOnly] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-LargeItemLimit ] + [-Locale ] + [-MoveOptions ] + [-NotificationEmails ] + [-Partition ] + [-PrimaryOnly] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipMerging ] + [-SkipMoving ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TargetArchiveDatabases ] + [-TargetDatabases ] + [-TargetDeliveryDomain ] + [-TargetEndpoint ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Onboarding +``` +New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [-WorkflowControlFlags ] + [-AdoptPreexisting] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-ArchiveDomain ] + [-ArchiveOnly] + [-AutoComplete] + [-AutoProvisioning] + [-AutoRetryCount ] + [-AutoStart] + [-AvoidMergeOverlap] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-ContentFilter ] + [-ContentFilterLanguage ] + [-DataFusion] + [-DomainController ] + [-ExcludeDumpsters] + [-ExcludeFolders ] + [-ForwardingDisposition ] + [-IncludeFolders ] + [-IncludeOtherContacts] + [-LargeItemLimit ] + [-Locale ] + [-MigrateTasks] + [-MoveOptions ] + [-NotificationEmails ] + [-Partition ] + [-PrimaryOnly] + [-RemoveOnCopy] + [-RenamePrimaryCalendar] + [-ReportInterval ] + [-Restore] + [-SimplifiedSwitchOver] + [-SkipCalendar] + [-SkipContacts] + [-SkipDelegates] + [-SkipMail] + [-SkipMerging ] + [-SkipMoving ] + [-SkipProvisioning] + [-SkipReports] + [-SkipRules] + [-SkipSteps ] + [-SourceEndpoint ] + [-SourcePFPrimaryMailboxGuid ] + [-StartAfter ] + [-TargetArchiveDatabases ] + [-TargetDatabases ] + [-TargetDeliveryDomain ] + [-TimeZone ] + [-WhatIf] + [-XMLData ] + [] +``` + +### PointInTimeRecovery +``` +New-MigrationBatch -Name -CSVData + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### PointInTimeRecoveryProvisionOnly +``` +New-MigrationBatch -Name -CSVData + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Preexisting +``` +New-MigrationBatch -Name [-Users] + [-AllowIncrementalSyncs ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-DisableOnCopy] + [-DomainController ] + [-Locale ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### PreexistingUserIds +``` +New-MigrationBatch -Name [-UserIds] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-DisableOnCopy] + [-DomainController ] + [-Locale ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### PreexistingUsers +``` +New-MigrationBatch [-Users] MultiValuedProperty> -Name + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-DisableOnCopy] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### PublicFolderToUnifiedGroup +``` +New-MigrationBatch -Name -CSVData [-PublicFolderToUnifiedGroup] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-LargeItemLimit ] + [-Locale ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-SkipSteps ] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### WorkflowTemplate +``` +New-MigrationBatch -Name [-WorkflowTemplate ] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-Locale ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the New-MigrationBatch cmdlet to create a migration batch to migrate mailboxes and mailbox data in one of the following migration scenarios. + +Moves in on-premises Exchange organizations + +- Local move: A local move is where you move mailboxes from one mailbox database to another. A local move occurs within a single forest. For more information, see Example 1. +- Cross-forest enterprise move: In a cross-forest enterprise move, mailboxes are moved to a different forest. Cross-forest moves are initiated either from the target forest, which is the forest that you want to move the mailboxes to, or from the source forest, which is the forest that currently hosts the mailboxes. For more information, see Example 2. + +Onboarding and offboarding in Exchange Online + +- Onboarding remote move migration: In a hybrid deployment, you can move mailboxes from an on-premises Exchange organization to Exchange Online. This is also known as an onboarding remote move migration because you on-board mailboxes to Exchange Online. For more information, see Example 3. +- Offboarding remote move migration: You can also perform an offboarding remote move migration, where you migrate Exchange Online mailboxes to your on-premises Exchange organization. For more information, see Example 4. + + 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. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +New-MigrationBatch -Local -Name LocalMove1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\LocalMove1.csv")) -TargetDatabases MBXDB2 + +Start-MigrationBatch -Identity LocalMove1 +``` + +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. + +### Example 2 +```powershell +$Credentials = Get-Credential + +$MigrationEndpointSource = New-MigrationEndpoint -ExchangeRemoteMove -Name Forest1Endpoint -Autodiscover -EmailAddress administrator@forest1.contoso.com -Credentials $Credentials + +$CrossForestBatch = New-MigrationBatch -Name CrossForestBatch1 -SourceEndpoint $MigrationEndpointSource.Identity -TargetDeliveryDomain forest2.contoso.com -TargetDatabases MBXDB1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\CrossForestBatch1.csv")) + +Start-MigrationBatch -Identity $CrossForestBatch.Identity +``` + +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. + +### Example 3 +```powershell +$Credentials = Get-Credential + +$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + +$OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) + +Start-MigrationBatch -Identity $OnboardingBatch.Identity.Name +``` + +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. + +### Example 4 +```powershell +$Credentials = Get-Credential + +$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + +$OffboardingBatch = New-MigrationBatch -Name RemoteOffBoarding1 -TargetEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain onprem.contoso.com -TargetDatabases @(MBXDB01,MBXDB02,MBXDB03) -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOffBoarding1.csv")) + +Start-MigrationBatch -Identity $OffboardingBatch.Identity +``` + +This example creates a migration batch for an offboarding remote move migration from Exchange Online to an on-premises Exchange organization. Like an onboarding remote move, it's initiated from the Exchange Online organization. First a Migration Endpoint is created that contains information about how to connect to the on-premises organization. The endpoint is used as the TargetEndpoint when creating the migration batch, which is then started with the Start-MigrationBatch cmdlet. The TargetDatabases parameter specifies multiple on-premises databases that the migration service can select as the target database to move the mailbox to. + +### Example 5 +```powershell +$credentials = Get-Credential + +$SourceEndpoint = New-MigrationEndpoint -ExchangeOutlookAnywhere -Autodiscover -Name SourceEndpoint -EmailAddress administrator@contoso.com -Credentials $credentials + +New-MigrationBatch -Name CutoverBatch -SourceEndpoint $SourceEndpoint.Identity -TimeZone "Pacific Standard Time" -AutoStart +``` + +This example creates a migration batch for the cutover Exchange migration CutoverBatch that's automatically started. The example obtains the connection settings to the on-premises Exchange server, and then uses those connection settings to create a migration endpoint. The endpoint is then used to create the migration batch. This example also includes the optional TimeZone parameter. + +### Example 6 +```powershell +$Credentials = Get-Credential + +$MigrationEndpoint = New-MigrationEndpoint -ExchangeOutlookAnywhere -Name ContosoEndpoint -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials + +$StagedBatch1 = New-MigrationBatch -Name StagedBatch1 -SourceEndpoint $MigrationEndpoint.Identity -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\StagedBatch1.csv")) + +Start-MigrationBatch -Identity $StagedBatch1.Identity +``` + +This example creates and starts a migration batch for a staged Exchange migration. The example uses the New-MigrationEndpoint cmdlet to create a migration endpoint for the on-premises Exchange server, and then uses that endpoint to create the migration batch. The migration batch is started with the Start-MigrationBatch cmdlet. + +### Example 7 +```powershell +New-MigrationEndpoint -IMAP -Name IMAPEndpoint1 -RemoteServer imap.contoso.com -Port 993 + +New-MigrationBatch -Name IMAPbatch1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\IMAPmigration_1.csv")) -SourceEndpoint IMAPEndpoint1 -ExcludeFolders "Deleted Items","Junk Email" +``` + +This example creates a migration endpoint for the connection settings to the IMAP server. Then an IMAP migration batch is created that uses the CSV migration file IMAPmigration\_1.csv and excludes the contents of the Deleted Items and Junk Email folders. This migration batch is pending until it's started with the Start-MigrationBatch cmdlet. + +### Example 8 +```powershell +$Credentials = Get-Credential + +$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + +$OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -CompleteAfter "09/01/2018 7:00 PM" + +Start-MigrationBatch -Identity $OnboardingBatch.Identity +``` + +This example is the same as Example 3, but the CompleteAfter parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (UTC). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Coordinated Universal Time. + +### Example 9 +```powershell +$Credentials = Get-Credential + +$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + +$OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -CompleteAfter "09/01/2018 7:00 PM" -TimeZone "Pacific Standard Time" + +Start-MigrationBatch -Identity $OnboardingBatch.Identity +``` + +This example is the same as Example 8, but the TimeZone parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (PST). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Pacific Standard Time. + +### Example 10 +```powershell +$MigrationEndpointGmail = New-MigrationEndpoint -Gmail -ServiceAccountKeyFileData $([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\gmailonboarding.json")) -EmailAddress admin@contoso.com -Name GmailEndpoint + +$OnboardingBatch = New-MigrationBatch -SourceEndpoint $MigrationEndpointGmail.Identity -Name GmailBatch1 -CSVData $([System.IO.File]::ReadAll +Bytes("C:\Users\Administrator\Desktop\gmail.csv")) -TargetDeliveryDomain "o365.contoso.com" -ContentFilter "Received -ge '2019/4/30'" -Inc +ludeFolders "Payment" + +Start-MigrationBatch -Identity $OnboardingBatch.Identity +``` + +A Google Workspace migration batch is created that uses the CSV migration file gmail.csv and includes the contents of the Payment label and only migrate the mails which were received after the time '2019/4/30 00:00' (local system time). This migration batch is pending until it's started with the Start-MigrationBatch cmdlet. + +## PARAMETERS + +### -UserIds +The UserIds parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify a user by email address or by their Guid property value from the Get-MigrationUser cmdlet. You can specify multiple users separated by commas. + +The users that you specify for this parameter must be defined in an existing migration batch. + +To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: PreexistingUserIds +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Users +The Users parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify the users by using the Get-MigrationUser cmdlet. For example: + +$Failed = Get-MigrationUser -Status Failed + +New-MigrationBatch -Name "Retry Failed Users" -Users $Failed + +The users that you specify for this parameter must be defined in an existing migration batch. + +To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Preexisting, PreexistingUsers +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Analyze +This parameter is available only in the cloud-based service. + +{{ Fill Analyze Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Analysis +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedGmailTeams +This parameter is available only in the cloud-based service. + +{{ Fill ManagedGmailTeams Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ManagedGmailTeams +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies an unique name for the migration batch on each system (Exchange On-premises or Exchange Online). The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CSVData +The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see [CSV files for mailbox migration](https://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. + +```yaml +Type: Byte[] +Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: Local +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePublicFolderDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: LocalPublicFolder +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdoptPreexisting +This parameter is available only in the cloud-based service. + +{{ Fill AdoptPreexisting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIncrementalSyncs +This parameter is available only in on-premises Exchange. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUnknownColumnsInCsv +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveDomain +This parameter is available only in the cloud-based service. + +{{ Fill ArchiveDomain Description }} + +```yaml +Type: String +Parameter Sets: Onboarding, Offboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveOnly +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. + +You can use the TargetArchiveDatabases parameter to specify the database to migrate the archive mailboxes to. You can also specify the target archive database in the CSV file. If you don't specify the target archive database, the cmdlet uses the automatic mailbox distribution logic to select the database. + +```yaml +Type: SwitchParameter +Parameter Sets: Local, Onboarding, Offboarding +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoComplete +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. + +If you don't use this switch, you need to run the Complete-MigrationBatch cmdlet to finalize a migration batch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoProvisioning +This parameter is available only in the cloud-based service. + +{{ Fill AutoProvisioning Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRetryCount +This parameter is available only in on-premises Exchange. + +The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoStart +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvoidMergeOverlap +This parameter is available only in the cloud-based service. + +{{ Fill AvoidMergeOverlap Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompleteAfter +This parameter is functional only in the cloud-based service. + +The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +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. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilter +This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. + +The ContentFilter parameter uses OPATH filter syntax to filter the messages by Received time. Only content that match the ContentFilter parameter will be moved to Exchange online. For example: + +- `"Received -gt '8/23/2020'"` +- `"Received -le '2019/01/01'"` +- `"Received -gt '8/23/2015' -and Received -lt '8/23/2020'"` + +You can specify the language by using the ContentFilterLanguage parameter. + +```yaml +Type: String +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilterLanguage +This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. + +The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFusion +This parameter is available only in the cloud-based service. + +{{ Fill DataFusion Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableOnCopy +The DisableOnCopy switch disables the original migration job item for a user if you're copying users from an existing batch to a new batch by using the UserIds or Users parameters. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: PreexistingUserIds, Preexisting, PreexistingUsers +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisallowExistingUsers +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. + +A validation warning is displayed for any pre-existing mailbox in the target destination. + +```yaml +Type: SwitchParameter +Parameter Sets: Local, Onboarding, Offboarding +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDumpsters +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. + +You use this switch only in public folder migrations from Exchange 2013 or later to Exchange Online. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFolders +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. + +For IMAP migration, use folder names relative to the IMAP root on the source mail server. For Google Workspace migration, use label names on the source mail server. + +Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: + +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, `MyProjects` or `MyProjects/FY2010`. + +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: + +- Root +- Inbox +- SentItems +- Outbox +- DeletedItems +- Calendar +- Contacts +- Drafts +- Journal +- Tasks +- Notes +- AllItems +- JunkEmail +- Archive + +If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a backslash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. + +Wildcard characters can't be used in folder names. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Onboarding, Analysis +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingDisposition +This parameter is available only in the cloud-based service. + +{{ Fill ForwardingDisposition Description }} + +```yaml +Type: GmailForwardingDisposition +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleResource +{{ Fill GoogleResource Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeFolders +This parameter is available only in the cloud-based service. + +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. + +For IMAP migration, use folder names relative to the IMAP root on the source mail server. For Google Workspace migration, use label names on the source mail server. + +Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: + +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, `MyProjects` or `MyProjects/FY2010`. + +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: + +- Root +- Inbox +- SentItems +- Outbox +- DeletedItems +- Calendar +- Contacts +- Drafts +- Journal +- Tasks +- Notes +- AllItems +- JunkEmail +- Archive + +If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a backslash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. + +Wildcard characters can't be used in folder names. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Onboarding, Analysis +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeOtherContacts +This parameter is available only in the cloud-based service. + +{{ Fill IncludeOtherContacts Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. + +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 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +This parameter is available only in on-premises Exchange. + +The Locale parameter specifies the language for the migration batch. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateTasks +This parameter is available only in the cloud-based service. + +{{ Fill MigrateTasks Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveOptions +The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. + +Don't use this parameter with the SkipMoving parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Onboarding, Local, Offboarding, FolderMove +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmails +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: PreexistingUserIds, Onboarding, Local, Offboarding, PublicFolderToUnifiedGroup, WorkflowTemplate, PreexistingUsers, GoogleResourceOnboarding, FolderMove, Analysis, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryOnly +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. + +**Note**: If the users don't have archive mailboxes, don't use this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Local, Onboarding, Offboarding +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderToUnifiedGroup +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. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOnCopy +This parameter is available only in the cloud-based service. + +{{ Fill RemoveOnCopy Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RenamePrimaryCalendar +This parameter is available only in the cloud-based service. + +{{ Fill RenamePrimaryCalendar Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportInterval +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. + +This parameter should only be used in the cloud-based service. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Restore +This parameter is available only in the cloud-based service. + +{{ Fill Restore Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimplifiedSwitchOver +This parameter is available only in the cloud-based service. + +{{ Fill SimplifiedSwitchOver Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCalendar +This parameter is available only in the cloud-based service. + +The SkipCalendar switch specifies that you want to skip calendar migration during Google Workspace onboarding. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, ManagedGmailTeams +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipContacts +This parameter is available only in the cloud-based service. + +The SkipContacts switch specifies that you want to skip contact migration during Google Workspace onboarding. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, ManagedGmailTeams +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDelegates +This parameter is available only in the cloud-based service. + +{{ Fill SkipDelegates Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDetails +This parameter is available only in the cloud-based service. + +{{ Fill SkipDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Analysis +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMail +This parameter is available only in the cloud-based service. + +The SkipMail switch specifies that you want to skip mail migration during Google Workspace onboarding. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMoving +This parameter has been 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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Local, Onboarding, Offboarding +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipProvisioning +This parameter is available only in the cloud-based service. + +{{ Fill SkipProvisioning Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipReports +The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipRules +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipSteps +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) +- 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +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) +- GUID + +This parameter defines the settings that are used to connect to the server where the source mailboxes are located. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePFPrimaryMailboxGuid +This parameter is available only in the cloud-based service. + +{{ Fill SourcePFPrimaryMailboxGuid Description }} + +```yaml +Type: Guid +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartAfter +The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +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. + +```yaml +Type: DateTime +Parameter Sets: Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: + +- 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"`. + +When you enter multiple values, the migration service selects one database as the target database to move the archive mailbox to. + +You can only use this parameter for local moves and remote move migrations. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Local, Onboarding, Offboarding +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabases +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 +- 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"`. + +When you enter multiple values, the migration service selects one database as the target database to move the mailbox to. + +You can only use this parameter for local moves and remote move migrations. + +If you don't use this parameter for a local move, the cmdlet uses the automatic mailbox distribution logic to select the database. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDeliveryDomain +The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the migration batch is complete. + +This parameter is required for remote move onboarding and remote offboarding migration batches + +```yaml +Type: String +Parameter Sets: Onboarding, Offboarding +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetEndpoint +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) +- GUID + +This parameter defines the settings that are used to connect to the destination server where the mailboxes will be moved. + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: Offboarding +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +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"`). + +To see the available values, run the following command: `$TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display`. + +If the value contains spaces, enclose the value in quotation marks ("). + +In on-premises Exchange, the default value is the time zone setting of the Exchange server. + +In Exchange Online, the default value is `UTC`. + +```yaml +Type: ExTimeZoneValue +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkflowControlFlags +The WorkflowControlFlags parameter specifies advanced controls for the steps that are performed in the migration. Valid values are: + +- None (This is the default value) +- InjectAndForget +- SkipSwitchover + +Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. + +```yaml +Type: MigrationWorkflowControlFlags +Parameter Sets: Local, Onboarding +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkflowTemplate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkloadType +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RequestWorkloadType +Parameter Sets: Local +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XMLData +This parameter is available only in the cloud-based service. + +{{ Fill XMLData Description }} + +```yaml +Type: Byte[] +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md new file mode 100644 index 0000000000..f7429f506d --- /dev/null +++ b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md @@ -0,0 +1,1044 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-MigrationEndpoint cmdlet to configure the connection settings for cross-forests moves, remote move migrations, cutover or staged Exchange migrations, IMAP migrations, and Google Workspace (formerly G Suite) migrations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ExchangeRemoteMoveAutoDiscover +``` +New-MigrationEndpoint -Name -Credentials -EmailAddress + [-Autodiscover] + [-ExchangeRemoteMove] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### ExchangeOutlookAnywhereAutoDiscover +``` +New-MigrationEndpoint -Name -Credentials -EmailAddress + [-Autodiscover] + [-ExchangeOutlookAnywhere] + [-AcceptUntrustedCertificates] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-SourceMailboxLegacyDN ] + [-TestMailbox ] + [-WhatIf] + [] +``` + +### ExchangeOutlookAnywhere +``` +New-MigrationEndpoint -Name -Credentials + [-EmailAddress ] + [-ExchangeOutlookAnywhere] + [-ExchangeServer ] + [-AcceptUntrustedCertificates] + [-Authentication ] + [-Confirm] + [-DomainController ] + [-MailboxPermission ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-NspiServer ] + [-Partition ] + [-RpcProxyServer ] + [-SkipVerification] + [-SourceMailboxLegacyDN ] + [-TestMailbox ] + [-WhatIf] + [] +``` + +### ExchangeRemoteMove +``` +New-MigrationEndpoint -Name -RemoteServer + [-Credentials ] + [-ExchangeRemoteMove] + [-ApplicationId ] + [-AppSecretKeyVaultUrl ] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-RemoteTenant ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### PSTImport +``` +New-MigrationEndpoint -Name -RemoteServer + [-Credentials ] + [-PSTImport] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### IMAP +``` +New-MigrationEndpoint -Name -RemoteServer + [-IMAP] + [-Port ] + [-Security ] + [-AcceptUntrustedCertificates] + [-Authentication ] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### Gmail +``` +New-MigrationEndpoint -Name -ServiceAccountKeyFileData + [-Gmail] + [-EmailAddress ] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### GoogleMarketplaceApp +``` +New-MigrationEndpoint -Name -OAuthCode [-Gmail] + [-Confirm] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-ProgressAction ] + [-RedirectUri ] + [-SkipVerification] + [-TestMailbox ] + [-WhatIf] + [] +``` + +### PublicFolder +``` +New-MigrationEndpoint -Name -Credentials -PublicFolderDatabaseServerLegacyDN -RpcProxyServer -SourceMailboxLegacyDN + [-PublicFolder] + [-Authentication ] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-TestMailbox ] + [-WhatIf] + [] +``` + +### Compliance +``` +New-MigrationEndpoint -Name -Credentials -RemoteServer + [-Compliance] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### MrsProxyPublicFolderToUnifiedGroup +``` +New-MigrationEndpoint -Name -Credentials -RemoteServer + [-PublicFolderToUnifiedGroup] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-TestMailbox ] + [-WhatIf] + [] +``` + +### MrsProxyPublicFolder +``` +New-MigrationEndpoint -Name -Credentials -RemoteServer + [-PublicFolder] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-WhatIf] + [] +``` + +### LegacyPublicFolderToUnifiedGroup +``` +New-MigrationEndpoint -Name -Credentials -PublicFolderDatabaseServerLegacyDN -RpcProxyServer -SourceMailboxLegacyDN + [-PublicFolderToUnifiedGroup] + [-Authentication ] + [-Confirm] + [-DomainController ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-SkipVerification] + [-TestMailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-MigrationEndpoint cmdlet configures the connection settings for different types of migrations: + +- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a Remote Move endpoint. +- Remote move migration: In a hybrid deployment, a remote move migration involves onboarding or offboarding migrations. Remote move migrations also require the use of an Exchange remote move endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online, and uses a remote move endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online to an on-premises Exchange organization and uses a remote move endpoint as the target endpoint of the migration batch. +- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online. A cutover Exchange migration requires the use of an Outlook Anywhere migration endpoint. +- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online. A staged Exchange migration requires the use of an Outlook Anywhere migration endpoint. +- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. +- Google Workspace migration: Migration mailbox data from a Google Workspace tenant to Exchange Online. For a Google Workspace migration, you must first create cloud-based mail users or mailboxes before you migrate mailbox data. Google Workspace migrations require the use of a Gmail endpoint. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-MigrationEndpoint -Name Endpoint1 -ExchangeRemoteMove -Autodiscover -EmailAddress tonysmith@contoso.com -Credentials (Get-Credential contoso\tonysmith) +``` + +This example creates an endpoint for remote moves by using the Autodiscover parameter to detect the settings. + +### Example 2 +```powershell +New-MigrationEndpoint -Name Endpoint2 -ExchangeRemoteMove -RemoteServer MRSServer.contoso.com -Credentials (Get-Credential Contoso.com\Administrator) +``` + +This example creates an endpoint for remote moves by specifying the settings manually. + +### Example 3 +```powershell +$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. + +### 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. + +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. + +### 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. + +### Example 6 +```powershell +New-MigrationEndpoint -IMAP -Name IMAP_TLS_Endpoint -RemoteServer imap.contoso.com -Port 143 -Security Tls -MaxConcurrentMigrations 50 -MaxConcurrentIncrementalSyncs 10 +``` + +This example creates an IMAP migration endpoint that supports 50 concurrent migrations and 10 concurrent incremental synchronizations. The endpoint is configured to use port 143 for TLS encryption. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Autodiscover +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compliance +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: PSCredential +Parameter Sets: ExchangeRemoteMove, PSTImport +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SmtpAddress +Parameter Sets: ExchangeOutlookAnywhere, Gmail +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeRemoteMove +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gmail +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Gmail +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IMAP +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. + +```yaml +Type: SwitchParameter +Parameter Sets: IMAP +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OAuthCode +This parameter is available only in the cloud-based service. + +{{ Fill OAuthCode Description }} + +```yaml +Type: SecureString +Parameter Sets: GoogleMarketplaceApp +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSTImport +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: PSTImport +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder, MrsProxyPublicFolder +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderDatabaseServerLegacyDN +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderToUnifiedGroup +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteServer +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. +- For IMAP migrations, this parameter refers to the IMAP server. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpcProxyServer +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. + +This parameter is required only when you don't use the Autodiscover parameter. + +```yaml +Type: Fqdn +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Fqdn +Parameter Sets: ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +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: Gmail +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMailboxLegacyDN +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 +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptUntrustedCertificates +This parameter is available only in the cloud-based service. + +{{ Fill AcceptUntrustedCertificates Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, IMAP +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +This parameter is available only in the cloud-based service. + +{{ Fill ApplicationId Description }} + +```yaml +Type: String +Parameter Sets: ExchangeRemoteMove +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSecretKeyVaultUrl +This parameter is available only in the cloud-based service. + +{{ Fill AppSecretKeyVaultUrl Description }} + +```yaml +Type: String +Parameter Sets: ExchangeRemoteMove +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +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. + +```yaml +Type: AuthenticationMethod +Parameter Sets: ExchangeOutlookAnywhere, IMAP, PublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeServer +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. + +This parameter is required only when you don't use the Autodiscover parameter. + +```yaml +Type: String +Parameter Sets: ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxPermission +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). + +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. + +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. + +This parameter can't be used for creating non-Outlook Anywhere migration endpoints. + +```yaml +Type: MigrationMailboxPermission +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConcurrentIncrementalSyncs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConcurrentMigrations +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NspiServer +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. + +```yaml +Type: String +Parameter Sets: ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +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. + +```yaml +Type: Int32 +Parameter Sets: IMAP +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectUri +This parameter is available only in the cloud-based service. + +{{ Fill RedirectUri Description }} + +```yaml +Type: String +Parameter Sets: GoogleMarketplaceApp +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteTenant +This parameter is available only in the cloud-based service. + +{{ Fill RemoteTenant Description }} + +```yaml +Type: String +Parameter Sets: ExchangeRemoteMove +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Security +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. + +```yaml +Type: IMAPSecurityMechanism +Parameter Sets: IMAP +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipVerification +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the migration service uses the migration arbitration mailbox in the Exchange Online organization to verify the connection. + +This parameter is only used to create Outlook Anywhere migration endpoints. + +```yaml +Type: MailboxIdParameter +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, GoogleMarketplaceApp, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/devices/New-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/devices/New-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md index eea48639e3..a091ad8d3d 100644 --- a/exchange/exchange-ps/exchange/devices/New-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MobileDeviceMailboxPolicy schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-MobileDeviceMailboxPolicy @@ -13,39 +16,70 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MobileDeviceMailboxPolicy cmdlet to create mobile device mailbox policies. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MobileDeviceMailboxPolicy [-Name] [-AllowApplePushNotifications <$true | $false>] - [-AllowBluetooth ] [-AllowBrowser <$true | $false>] - [-AllowCamera <$true | $false>] [-AllowConsumerEmail <$true | $false>] [-AllowDesktopSync <$true | $false>] - [-AllowExternalDeviceManagement <$true | $false>] [-AllowGooglePushNotifications <$true | $false>] - [-AllowHTMLEmail <$true | $false>] [-AllowInternetSharing <$true | $false>] [-AllowIrDA <$true | $false>] - [-AllowMicrosoftPushNotifications <$true | $false>] [-AllowMobileOTAUpdate <$true | $false>] - [-AllowNonProvisionableDevices <$true | $false>] [-AllowPOPIMAPEmail <$true | $false>] - [-AllowRemoteDesktop <$true | $false>] [-AllowSimplePassword <$true | $false>] - [-AllowSMIMEEncryptionAlgorithmNegotiation ] - [-AllowSMIMESoftCerts <$true | $false>] [-AllowStorageCard <$true | $false>] - [-AllowTextMessaging <$true | $false>] [-AllowUnsignedApplications <$true | $false>] - [-AllowUnsignedInstallationPackages <$true | $false>] [-AllowWiFi <$true | $false>] - [-AlphanumericPasswordRequired <$true | $false>] [-ApprovedApplicationList ] - [-AttachmentsEnabled <$true | $false>] [-Confirm] [-DeviceEncryptionEnabled <$true | $false>] - [-DevicePolicyRefreshInterval ] [-DomainController ] [-IrmEnabled <$true | $false>] - [-IsDefault <$true | $false>] [-MaxAttachmentSize ] - [-MaxCalendarAgeFilter ] - [-MaxEmailAgeFilter ] - [-MaxEmailBodyTruncationSize ] [-MaxEmailHTMLBodyTruncationSize ] - [-MaxInactivityTimeLock ] [-MaxPasswordFailedAttempts ] - [-MinPasswordComplexCharacters ] [-MinPasswordLength ] [-PasswordEnabled <$true | $false>] - [-PasswordExpiration ] [-PasswordHistory ] [-PasswordRecoveryEnabled <$true | $false>] - [-RequireDeviceEncryption <$true | $false>] [-RequireEncryptedSMIMEMessages <$true | $false>] - [-RequireEncryptionSMIMEAlgorithm ] - [-RequireManualSyncWhenRoaming <$true | $false>] [-RequireSignedSMIMEAlgorithm ] - [-RequireSignedSMIMEMessages <$true | $false>] [-RequireStorageCardEncryption <$true | $false>] - [-UnapprovedInROMApplicationList ] [-UNCAccessEnabled <$true | $false>] [-WhatIf] - [-WSSAccessEnabled <$true | $false>] [] +New-MobileDeviceMailboxPolicy [-Name] + [-AllowApplePushNotifications ] + [-AllowBluetooth ] + [-AllowBrowser ] + [-AllowCamera ] + [-AllowConsumerEmail ] + [-AllowDesktopSync ] + [-AllowExternalDeviceManagement ] + [-AllowGooglePushNotifications ] + [-AllowHTMLEmail ] + [-AllowInternetSharing ] + [-AllowIrDA ] + [-AllowMicrosoftPushNotifications ] + [-AllowMobileOTAUpdate ] + [-AllowNonProvisionableDevices ] + [-AllowPOPIMAPEmail ] + [-AllowRemoteDesktop ] + [-AllowSimplePassword ] + [-AllowSMIMEEncryptionAlgorithmNegotiation ] + [-AllowSMIMESoftCerts ] + [-AllowStorageCard ] + [-AllowTextMessaging ] + [-AllowUnsignedApplications ] + [-AllowUnsignedInstallationPackages ] + [-AllowWiFi ] + [-AlphanumericPasswordRequired ] + [-ApprovedApplicationList ] + [-AttachmentsEnabled ] + [-Confirm] + [-DeviceEncryptionEnabled ] + [-DevicePolicyRefreshInterval ] + [-DomainController ] + [-IrmEnabled ] + [-IsDefault ] + [-MaxAttachmentSize ] + [-MaxCalendarAgeFilter ] + [-MaxEmailAgeFilter ] + [-MaxEmailBodyTruncationSize ] + [-MaxEmailHTMLBodyTruncationSize ] + [-MaxInactivityTimeLock ] + [-MaxPasswordFailedAttempts ] + [-MinPasswordComplexCharacters ] + [-MinPasswordLength ] + [-PasswordEnabled ] + [-PasswordExpiration ] + [-PasswordHistory ] + [-PasswordRecoveryEnabled ] + [-RequireDeviceEncryption ] + [-RequireEncryptedSMIMEMessages ] + [-RequireEncryptionSMIMEAlgorithm ] + [-RequireManualSyncWhenRoaming ] + [-RequireSignedSMIMEAlgorithm ] + [-RequireSignedSMIMEMessages ] + [-RequireStorageCardEncryption ] + [-UnapprovedInROMApplicationList ] + [-UNCAccessEnabled ] + [-WhatIf] + [-WSSAccessEnabled ] + [] ``` ## DESCRIPTION @@ -53,26 +87,28 @@ Mobile device mailbox policies define settings for mobile devices that are used Some mobile device mailbox policy settings require the mobile device to have certain built-in features that enforce these security and device management settings. If your organization allows all devices, you need to set the AllowNonProvisionableDevices parameter to $true. This allows devices that can't enforce all policy settings to synchronize with your server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/secure-outlook-for-ios-and-android#leveraging-exchange-online-mobile-device-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-MobileDeviceMailboxPolicy -Name "Sales Policy" -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -IsDefault $false -AttachmentsEnabled $false -AllowStorageCard $true ``` This example creates the mobile device mailbox policy Sales Policy that has several preconfigured values. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-MobileDeviceMailboxPolicy -Name Management -AllowBluetooth $true -AllowBrowser $true -AllowCamera $true -AllowPOPIMAPEmail $false -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -MaxEmailAgeFilter TwoWeeks -AllowWiFi $true -AllowStorageCard $true ``` This example creates the mobile device mailbox policy Management that has several preconfigured values. Users assigned to this policy should have an Enterprise client access license (CAL) to use many of these features. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-MobileDeviceMailboxPolicy -Name "Contoso Policy" -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -MinPasswordComplexCharacters 3 -IsDefault $true -PasswordHistory 10 ``` @@ -84,9 +120,7 @@ This example creates the mobile device mailbox policy Contoso Policy that has se 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 - - Distinguished name (DN) - - GUID The name of the built-in mobile device mailbox policy is Default. @@ -96,6 +130,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -109,10 +144,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -121,13 +157,22 @@ Accept wildcard characters: False ``` ### -AllowBluetooth -The AllowBluetooth parameter specifies whether the Bluetooth capabilities of the mobile device are allowed. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. +The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: + +- Allow (this is the default value). +- Disable +- HandsfreeOnly + +The values Allow or HandsfreeOnly allow synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. + +The value Disable disables synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. Any previously synchronized data is deleted. This value does not disable Bluetooth on the Android device or the wearable device, nor does it affect other Android wearable apps. ```yaml -Type: Disable | HandsfreeOnly | Allow +Type: BluetoothType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -139,10 +184,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -154,10 +200,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -169,10 +216,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -184,10 +232,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -199,10 +248,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -216,10 +266,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -231,10 +282,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -246,10 +298,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -261,10 +314,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -278,10 +332,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -293,10 +348,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -310,10 +366,11 @@ The AllowNonProvisionableDevices parameter specifies whether all mobile devices 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -325,10 +382,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -340,10 +398,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -355,10 +414,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -370,18 +430,17 @@ Accept wildcard characters: False 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 - - BlockNegotiation - - OnlyStrongAlgorithmNegotiation The default value is AllowAnyAlgorithmNegotiation. ```yaml -Type: BlockNegotiation | OnlyStrongAlgorithmNegotiation | AllowAnyAlgorithmNegotiation +Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -393,10 +452,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -408,10 +468,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -423,10 +484,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -438,10 +500,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -453,10 +516,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -468,10 +532,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -483,10 +548,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -502,6 +568,7 @@ Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -515,10 +582,11 @@ The AttachmentsEnabled parameter specifies whether attachments can be downloaded When set to $false, this parameter blocks the user from downloading attachments on the mobile device. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -529,15 +597,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -546,15 +614,18 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled +**Note**: This setting is supported by Outlook for iOS and Android. + The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, device encryption is enabled on the mobile device. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -574,6 +645,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -591,6 +663,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -602,10 +675,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -619,10 +693,11 @@ The IsDefault parameter specifies whether this policy is the default mobile devi 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -638,9 +713,7 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo The maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2\*1024^3), so these are the maximum qualified values you can use with this parameter. - 2097151KB - - 2047.999024MB - - 1.999999047GB ```yaml @@ -648,6 +721,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -659,22 +733,19 @@ Accept wildcard characters: False 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 - - TwoWeeks - - OneMonth - - ThreeMonths - - SixMonths The default value is All. ```yaml -Type: All | TwoWeeks | OneMonth | ThreeMonths | SixMonths +Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -686,24 +757,20 @@ Accept wildcard characters: False 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 - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth The default value is All. ```yaml -Type: All | OneDay | ThreeDays | OneWeek | TwoWeeks | OneMonth +Type: EmailAgeFilterType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -721,6 +788,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -738,6 +806,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -749,7 +818,6 @@ Accept wildcard characters: False 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. ```yaml @@ -757,6 +825,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -774,6 +843,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -785,11 +855,8 @@ Accept wildcard characters: False The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are: - Lower case letters. - - Upper case letters. - - Digits 0 through 9. - - Special characters (for example, exclamation marks). A valid value for this parameter is an integer from 1 through 4. The default value is 1. @@ -799,11 +866,8 @@ For Windows Phone 8 devices, the value specifies the number of character sets th For Windows Phone 10 devices, the value specifies the following password complexity requirements: - Digits only. - - Digits and lower case letters. - - Digits, lower case letters, and upper case letters. - - Digits, lower case letters, upper case letters, and special characters. ```yaml @@ -811,6 +875,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -819,6 +884,8 @@ Accept wildcard characters: False ``` ### -MinPasswordLength +**Note**: This setting is supported by Outlook for Android. + The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. You can enter any number from 1 through 16 or the value $null. The default value is blank. The maximum password length is 16 characters. @@ -828,6 +895,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -841,10 +909,11 @@ The PasswordEnabled parameter specifies whether a password is required on the mo When set to $true, this parameter requires the user to set a password on the mobile device. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -856,7 +925,6 @@ Accept wildcard characters: False 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 ```yaml @@ -864,6 +932,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -881,6 +950,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -894,10 +964,11 @@ The PasswordRecoveryEnabled parameter specifies whether the recovery password fo 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -909,10 +980,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -924,10 +996,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -939,22 +1012,19 @@ Accept wildcard characters: False 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 - - TripleDES - - RC240bit - - RC264bit - - RC2128bit The default value is TripleDES. ```yaml -Type: TripleDES | DES | RC2128bit | RC264bit | RC240bit +Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -966,10 +1036,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -983,10 +1054,11 @@ The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to Valid values for this parameter are SHA1 or MD5. The default value is SHA1. ```yaml -Type: SHA1 | MD5 +Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -998,10 +1070,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1015,10 +1088,11 @@ The RequireStorageCardEncryption parameter specifies whether storage card encryp Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1034,6 +1108,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1045,10 +1120,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1063,7 +1139,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -1075,10 +1152,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1087,20 +1165,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/06b6aca8-46a3-4609-821e-d28df1bd2846.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/New-MoveRequest.md b/exchange/exchange-ps/exchange/New-MoveRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/move-and-migration/New-MoveRequest.md rename to exchange/exchange-ps/exchange/New-MoveRequest.md index ace56952aa..85f5f280eb 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/New-MoveRequest.md +++ b/exchange/exchange-ps/exchange/New-MoveRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-MoveRequest @@ -13,14 +16,18 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MoveRequest cmdlet to begin the process of an asynchronous mailbox or personal archive move. You can also check mailbox readiness to be moved by using the WhatIf parameter. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +**Note**: After April 15, 2020, you shouldn't use this cmdlet to manually move mailboxes within an Exchange Online organization. You can only use this cmdlet for migrating to and from Exchange Online. If you have issues with a mailbox and want to fix it by moving the mailbox within your Exchange Online organization, please open a Microsoft Support request instead. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### MigrationOutbound ``` -New-MoveRequest [-Identity] - [-Outbound] [-RemoteCredential ] [-RemoteGlobalCatalog ] -RemoteHostName +New-MoveRequest [-Identity] -RemoteHostName + [-Outbound] + [-RemoteCredential ] + [-RemoteGlobalCatalog ] [-AcceptLargeDataLoss] [-AllowLargeItems] [-ArchiveDomain ] @@ -40,7 +47,7 @@ New-MoveRequest [-Identity] [-MRSServer ] [-PreventCompletion] [-PrimaryOnly] - [-Priority ] + [-Priority ] [-Protect] [-ProxyToMailbox ] [-RemoteArchiveTargetDatabase ] @@ -48,19 +55,23 @@ New-MoveRequest [-Identity] [-RemoteTargetDatabase ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] [-SuspendWhenReadyToComplete] [-TargetDeliveryDomain ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` ### MigrationRemote ``` -New-MoveRequest [-Identity] [-Remote] [-RemoteCredential ] [-RemoteGlobalCatalog ] -RemoteHostName +New-MoveRequest [-Identity] -RemoteHostName + [-Remote] + [-RemoteCredential ] + [-RemoteGlobalCatalog ] [-AcceptLargeDataLoss] [-AllowLargeItems] [-ArchiveDomain ] @@ -81,12 +92,13 @@ New-MoveRequest [-Identity] [-Remote] [-RemoteCre [-MRSServer ] [-PreventCompletion] [-PrimaryOnly] - [-Priority ] + [-Priority ] [-Protect] [-ProxyToMailbox ] [-RemoteOrganizationName ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -94,14 +106,14 @@ New-MoveRequest [-Identity] [-Remote] [-RemoteCre [-TargetDatabase ] [-TargetDeliveryDomain ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` ### MigrationRemoteLegacy ``` -New-MoveRequest [-Identity] -RemoteCredential - -RemoteGlobalCatalog [-RemoteLegacy] +New-MoveRequest [-Identity] -RemoteCredential -RemoteGlobalCatalog + [-RemoteLegacy] [-AcceptLargeDataLoss] [-AllowLargeItems] [-BadItemLimit ] @@ -118,12 +130,13 @@ New-MoveRequest [-Identity] -RemoteCredential ] [-MRSServer ] [-PreventCompletion] - [-Priority ] + [-Priority ] [-Protect] [-ProxyToMailbox ] [-RemoteTargetDatabase ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -131,7 +144,7 @@ New-MoveRequest [-Identity] -RemoteCredential ] [-TargetDeliveryDomain ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` @@ -160,24 +173,25 @@ New-MoveRequest [-Identity] [-MRSServer ] [-PreventCompletion] [-PrimaryOnly] - [-Priority ] + [-Priority ] [-Protect] [-ProxyToMailbox ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] [-SuspendWhenReadyToComplete] [-TargetDatabase ] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` ### MigrationOutboundCrossTenant ``` -New-MoveRequest [-Identity] [-Outbound] -RemoteTenant -TargetDeliveryDomain +New-MoveRequest [-Identity] -TargetDeliveryDomain [-Outbound] [-AcceptLargeDataLoss] [-AllowLargeItems] [-BadItemLimit ] @@ -192,7 +206,7 @@ New-MoveRequest [-Identity] [-Outbound] -RemoteTe [-LargeItemLimit ] [-MoveOptions ] [-PreventCompletion] - [-Priority ] + [-Priority ] [-Protect] [-ProxyToMailbox ] [-RequestExpiryInterval ] @@ -202,13 +216,14 @@ New-MoveRequest [-Identity] [-Outbound] -RemoteTe [-SuspendComment ] [-SuspendWhenReadyToComplete] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` ### MigrationRemoteCrossTenant ``` -New-MoveRequest [-Identity] [-Remote] -RemoteTenant -TargetDeliveryDomain [-TargetDatabase ] +New-MoveRequest [-Identity] -TargetDeliveryDomain [-Remote] + [-TargetDatabase ] [-AcceptLargeDataLoss] [-AllowLargeItems] [-ArchiveTargetDatabase ] @@ -224,41 +239,42 @@ New-MoveRequest [-Identity] [-Remote] -RemoteTena [-LargeItemLimit ] [-MoveOptions ] [-PreventCompletion] - [-Priority ] + [-Priority ] [-Protect] [-ProxyToMailbox ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] [-SuspendWhenReadyToComplete] [-WhatIf] - [-WorkloadType ] + [-WorkloadType ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-MoveRequest -Identity 'tony@alpineskihouse.com' -TargetDatabase "DB01" -WhatIf ``` This example tests a mailbox's readiness to move to the new database DB01 within the same forest and for completeness of the command by using the WhatIf switch. When you use the WhatIf switch, the system performs checks on the mailbox, and if the mailbox isn't ready, you receive an error. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-MoveRequest -Identity 'tony@alpineskihouse.com' -TargetDatabase "DB01" ``` This example moves Tony Smith's mailbox to the new database DB01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-Mailbox -Database DB01 | New-MoveRequest -TargetDatabase DB02 -BatchName "DB01toDB02" ``` @@ -270,17 +286,11 @@ This example creates a batch move request for all mailboxes on the database DB01 The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID - - Distinguished name (DN) - - Domain\\Account - - User principal name (UPN) - - LegacyExchangeDN - - SMTP address - - Alias ```yaml @@ -288,6 +298,7 @@ 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 Default value: None @@ -305,6 +316,7 @@ 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 Default value: None @@ -322,6 +334,7 @@ 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 Default value: None @@ -330,15 +343,16 @@ Accept wildcard characters: False ``` ### -RemoteCredential -The RemoteCredential parameter specifies an administrator who has permission to perform the mailbox move, for example, Administrator@humongousinsurance.com. +The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in 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 Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -351,6 +365,7 @@ Type: PSCredential Parameter Sets: MigrationOutbound, MigrationRemote Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -366,6 +381,7 @@ Type: Fqdn Parameter Sets: MigrationRemoteLegacy Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -378,6 +394,7 @@ Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -393,6 +410,7 @@ 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 Default value: None @@ -410,23 +428,7 @@ Type: SwitchParameter Parameter Sets: MigrationRemoteLegacy Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -RemoteTenant -This parameter is avaialble only in the cloud-based service. - -PARAMVALUE: SmtpDomain - -```yaml -Type: SmtpDomain -Parameter Sets: MigrationOutboundCrossTenant, MigrationRemoteCrossTenant -Aliases: -Applicable: Exchange Online Required: True Position: Named Default value: None @@ -434,15 +436,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -TargetDeliveryDomain -The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote or RemoteLegacy parameter. +The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote, RemoteLegacy, or Outbound parameter. ```yaml Type: Fqdn Parameter Sets: MigrationOutboundCrossTenant, MigrationRemoteCrossTenant Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -455,6 +457,7 @@ Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -463,13 +466,18 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. +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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. ```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 Default value: None @@ -489,6 +497,7 @@ 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 @@ -504,6 +513,7 @@ 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 Default value: None @@ -512,15 +522,16 @@ Accept wildcard characters: False ``` ### -ArchiveOnly -The ArchiveOnlyswitch specifies that you're moving only the personal archive associated with the mailbox. +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 PrimaryOnlyswitch. +You can't use this switch with the PrimaryOnly switch. ```yaml 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 Default value: None @@ -531,19 +542,20 @@ Accept wildcard characters: False ### -ArchiveTargetDatabase This parameter is available only in on-premises Exchange. -The ArchiveTargetDatabase parameter specifies the Exchange target database to which you're moving the personal archive. If this parameter isn't specified, the archive is moved to the same database as the primary mailbox. - -You can use the following values for this parameter: +The ArchiveTargetDatabase parameter specifies the destination mailbox database for the personal archive. You can use any value that uniquely identifies the database. For example: -- GUID of the database +- Name +- Distinguished name (DN) +- GUID -- Database name +If you don't use this parameter, the archive is moved to the same database as the primary mailbox. ```yaml 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 Default value: None @@ -556,13 +568,16 @@ The BadItemLimit parameter specifies the maximum number of bad items that are al 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. -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. +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. ```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 Default value: None @@ -578,6 +593,7 @@ 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 Default value: None @@ -588,21 +604,21 @@ Accept wildcard characters: False ### -CompleteAfter The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). +In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -618,6 +634,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -628,8 +645,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -637,6 +653,7 @@ 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 Default value: None @@ -654,6 +671,7 @@ 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 @@ -664,7 +682,7 @@ Accept wildcard characters: False ### -DoNotPreserveMailboxSignature This parameter is available only in on-premises Exchange. -The DoNotPreserveMailboxSignatureswitch specifies that the move doesn't preserve the mailbox mapping signature. You don't need to specify a value with this switch. +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. We recommend that you use this switch only if the move request fails because the Named Property identifiers are depleted. If you use this parameter, the user must restart Outlook when the move request is complete. @@ -673,6 +691,7 @@ Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -681,7 +700,7 @@ Accept wildcard characters: False ``` ### -ForceOffline -The ForceOfflineswitch forces the mailbox move to be performed in offline mode. You don't need to specify a value with this switch. +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. @@ -690,6 +709,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -700,7 +720,7 @@ Accept wildcard characters: False ### -ForcePull This parameter is available only in on-premises Exchange. -The ForcePullswitch specifies that the type of local move should be a Pull move. You don't need to specify a value with this switch. +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. You use this parameter only for local moves. @@ -709,6 +729,7 @@ Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -719,7 +740,7 @@ Accept wildcard characters: False ### -ForcePush This parameter is available only in on-premises Exchange. -The ForcePushswitch specifies that the type of local move should be a Push move. You don't need to specify a value with this switch. +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. You use this parameter only for local moves. @@ -728,6 +749,7 @@ Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -738,13 +760,14 @@ Accept wildcard characters: False ### -IgnoreRuleLimitErrors This parameter is available only in Exchange Server 2010 or Exchange Server 2013 -The IgnoreRuleLimitErrors parameter specifies that the command doesn't move the user's rules to the target server running Exchange. +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. ```yaml Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -764,6 +787,7 @@ Type: TimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -781,6 +805,7 @@ Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -793,19 +818,21 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) +- Exchange Server: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. 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. + ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -823,6 +850,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -831,7 +859,7 @@ Accept wildcard characters: False ``` ### -MRSServer -This parameter is available or functional only in 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. @@ -840,6 +868,7 @@ Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -848,13 +877,16 @@ Accept wildcard characters: False ``` ### -PreventCompletion -The PreventCompletion switch specifies whether to run the move request, but not allow it to complete. Instead of this switch, we recommend using the CompleteAfter parameter. +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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -867,13 +899,14 @@ The PrimaryOnly switch specifies that the command should only move the primary m 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. -You can't use this parameter with the ArchiveOnly parameter. +You can't use this switch with the ArchiveOnly sitch. ```yaml 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 Default value: None @@ -887,26 +920,20 @@ 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: - Lowest - - Lower - - Low - - Normal: This is the default value. - - High - - Higher - - Highest - - Emergency ```yaml -Type: Normal | High +Type: RequestPriority Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -915,13 +942,16 @@ Accept wildcard characters: False ``` ### -Protect +This parameter is available only in on-premises Exchange. + 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -932,30 +962,17 @@ Accept wildcard characters: False ### -ProxyToMailbox 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: +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: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -963,6 +980,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -980,6 +998,7 @@ 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 Default value: None @@ -995,6 +1014,7 @@ Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1012,6 +1032,7 @@ 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 Default value: None @@ -1023,7 +1044,6 @@ Accept wildcard characters: False 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. - - If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1035,6 +1055,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1052,6 +1073,25 @@ Type: SkippableMoveComponent[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +This parameter is available only in the cloud-based service. + +{{ Fill SourceEndpoint Description }} + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal, MigrationRemoteCrossTenant +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -1062,21 +1102,21 @@ Accept wildcard characters: False ### -StartAfter The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). +In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1085,13 +1125,16 @@ Accept wildcard characters: False ``` ### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1107,6 +1150,7 @@ 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 Default value: None @@ -1115,13 +1159,16 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete -The SuspendWhenReadyToComplete switch specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this switch, we recommend that you use the CompleteAfter parameter. +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. ```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 Default value: None @@ -1132,19 +1179,20 @@ Accept wildcard characters: False ### -TargetDatabase This parameter is available only in on-premises Exchange. -The TargetDatabase parameter specifies the identity of the database that you're moving the mailbox to. If you don't use this parameter, the automatic distribution logic will select a random database from the Active Directory site where you are running the command. +The TargetDatabase parameter specifies the destination mailbox database for the mailbox. You can use any value that uniquely identifies the database. For example: -You can use the following values: - -- GUID of the database +- Name +- Distinguished name (DN) +- GUID -- Database name +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. ```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 Default value: None @@ -1162,6 +1210,7 @@ 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 Default value: None @@ -1175,10 +1224,11 @@ This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. ```yaml -Type: None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport +Type: RequestWorkloadType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1187,20 +1237,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c28ca2ce-963f-4676-81c3-cef3c290ee7b.aspx) diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md new file mode 100644 index 0000000000..8be7fb364c --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OMEConfiguration.md @@ -0,0 +1,310 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-OMEConfiguration + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-OMEConfiguration cmdlet to create a Microsoft Purview Message Encryption configuration. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-OMEConfiguration [-Identity] + [-BackgroundColor ] + [-Confirm] + [-DisclaimerText ] + [-EmailText ] + [-ExternalMailExpiryInDays ] + [-Image ] + [-IntroductionText ] + [-OTPEnabled ] + [-PortalText ] + [-PrivacyStatementUrl ] + [-ReadButtonText ] + [-SocialIdSignIn ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-OMEConfiguration -Identity "Contoso Marketing" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image ([System.IO.File]::ReadAllBytes('C:\Temp\OME Logo.gif')) +``` + +This example creates a new OME configuration named "Contoso Marketing" with the specified values specified. Unused parameters get the default values. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackgroundColor +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. + +For more information, see [Add your organization's brand to your encrypted messages](https://learn.microsoft.com/purview/add-your-organization-brand-to-encrypted-messages). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisclaimerText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMailExpiryInDays +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. + +In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is displayed in the ExternalMailExpiryInterval property. + +```yaml +Type: String +Parameter Sets: Int32 +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +- Supported file formats: .png, .jpg, .bmp, or .tiff +- Optimal size of logo file: less than 40 KB +- Optimal dimensions of logo image: 170x70 pixels + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntroductionText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OTPEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortalText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyStatementUrl +{{ Fill PrivacyStatementUrl Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadButtonText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SocialIdSignIn +The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, etc). Valid values are: + +- $true: Social network ID sign in is allowed. This is the default value. +- $false: Social network ID sign in is not allowed. Whether the recipient can use a one-time passcode or their Microsoft 365 work or school account is controlled by the OTPEnabled parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md rename to exchange/exchange-ps/exchange/New-OabVirtualDirectory.md index 1c90e413ae..7732f3db5a 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-OabVirtualDirectory @@ -13,16 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the New-OABVirtualDirectory cmdlet to create offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The OAB virtual directory configures the server as a web distribution point for an offline address book (OAB). Typically, you create virtual directories on Exchange servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OabVirtualDirectory [-Confirm] [-DomainController ] [-ExtendedProtectionFlags ] - [-ExtendedProtectionSPNList ] [-ExtendedProtectionTokenChecking ] - [-ExternalUrl ] [-InternalUrl ] [-Path ] [-PollInterval ] [-Recovery] - [-RequireSSL <$true | $false>] [-Server ] [-WebSiteName ] [-WhatIf] - [-Role ] [] +New-OabVirtualDirectory [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-InternalUrl ] + [-Path ] + [-PollInterval ] + [-Recovery] + [-RequireSSL ] + [-Role ] + [-Server ] + [-WebSiteName ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -30,12 +44,12 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-OABVirtualDirectory -Server CASServer01 -PollInterval 120 ``` @@ -46,8 +60,7 @@ This example creates an OAB virtual directory on CASServer01 and configures the ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -55,6 +68,7 @@ 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 @@ -70,6 +84,7 @@ 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 @@ -81,13 +96,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -95,6 +106,7 @@ 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 @@ -106,14 +118,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -125,20 +137,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -154,6 +163,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -169,6 +179,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -184,6 +195,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -199,6 +211,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -214,6 +227,7 @@ 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 @@ -225,14 +239,35 @@ Accept wildcard characters: False 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. - - $false: SSL encryption isn't required to connect to the virtual directory. ```yaml -Type: $true | $false +Type: Boolean 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 +``` + +### -Role +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. +- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. + +Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. + +```yaml +Type: VirtualDirectoryRole +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -244,11 +279,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - ExchangeLegacyDN ```yaml @@ -256,6 +288,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -271,6 +304,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -286,27 +320,7 @@ 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 -``` - -### -Role -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. - -- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. - -Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. -```yaml -Type: ClientAccess | Mailbox -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -315,20 +329,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8f976c83-fd98-43c9-9d50-b252bdaae0fc.aspx) diff --git a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md new file mode 100644 index 0000000000..cc267ae497 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md @@ -0,0 +1,492 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-OfflineAddressBook cmdlet to create offline address books (OABs). + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-OfflineAddressBook [-Name] -AddressLists + [-Confirm] + [-DiffRetentionPeriod ] + [-DomainController ] + [-GeneratingMailbox ] + [-GlobalWebDistributionEnabled ] + [-IsDefault ] + [-PublicFolderDatabase ] + [-PublicFolderDistributionEnabled ] + [-Schedule ] + [-Server ] + [-ShadowMailboxDistributionEnabled ] + [-SkipPublicFolderInitialization] + [-Versions ] + [-VirtualDirectories ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"} + +New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00" +``` + +In Exchange Server 2010 and 2013, this example uses two commands to create the OAB named OAB\_AgencyB that includes all address lists in which AgencyB is part of the name. By using the settings shown, an OAB is generated by myserver.contoso.com on Mondays and Wednesdays from 01:00 (1 A.M.) to 02:00 (2 A.M.). This example command also creates the default OAB for the organization. + +### Example 2 +```powershell +New-OfflineAddressBook -Name "Contoso Executives OAB" -AddressLists "Default Global Address List","Contoso Executives Address List" -GlobalWebDistributionEnabled $true +``` + +This example creates a new OAB named Contoso Executives OAB with the following properties: + +- Address lists included in the OAB: Default Global Address List and Contoso Executives Address List +- All OAB virtual directories in the organization can accept requests to download the OAB. + +The organization mailbox that's responsible for generating the OAB is SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} (we didn't use the GeneratingMailbox parameter to specify a different organization mailbox). + +The OAB isn't used by mailboxes and mailbox databases that don't have an OAB specified (we didn't use the IsDefault parameter with the value $true). + +### Example 3 +```powershell +New-OfflineAddressBook -Name "New OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -VirtualDirectories "SERVER01\OAB (Default Web Site)" +``` + +In Exchange Server 2010, this example creates the OAB New OAB that uses Web-based distribution for Microsoft Office Outlook 2007 or later clients on SERVER01 by using the default virtual directory. + +### Example 4 +```powershell +New-OfflineAddressBook -Name "Legacy OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -PublicFolderDatabase "PFDatabase" -PublicFolderDistributionEnabled $true -Versions Version1,Version2 +``` + +In Exchange Server 2010, this example creates the OAB Legacy OAB that uses public folder distribution for Outlook 2003 Service Pack 1 (SP1) and Outlook 98 Service Pack 2 (SP2) clients on SERVER01. + +If you configure OABs to use public folder distribution, but your organization doesn't have any public folder infrastructure, an error will be returned. For more information, see [Managing Public Folders](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb124411(v=exchg.141)). + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLists +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 +- 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 and global address lists by using the Get-AddressList and Get-GlobalAddressList cmdlets. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DiffRetentionPeriod +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeneratingMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +The default value for this parameter is the organization mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}. + +A single organization mailbox can generate multiple OABs (you can use the same value for this parameter in the settings of multiple OABs), but in Exchange 2013 CU5 or later, an OAB can only be generated by a single organization mailbox (this parameter doesn't accept multiple values). To have a read only copy of the OAB (also known as a shadow copy) available in other organization mailboxes, use the ShadowMailboxDistributionEnabled parameter. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalWebDistributionEnabled +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. + +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. + +```yaml +Type: Boolean +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 +``` + +### -IsDefault +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +To use this parameter, the PublicFolderDistributionEnabled parameter must be set to $true. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderDistributionEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +This parameter is available only in Exchange Server 2010. + +The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. + +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" + +```yaml +Type: Schedule +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +This parameter is available only in Exchange Server 2010. + +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ShadowMailboxDistributionEnabled +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipPublicFolderInitialization +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. + +The OAB isn't available for download until the next site folder maintenance cycle has completed. Omitting this switch might cause the task to pause while it contacts the responsible public folder server to create the necessary public folders. If the server is presently unreachable, or is otherwise costly to contact, the pause could be significant. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Versions +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: + +- Version2 (requires public folder distribution) +- Version3 (requires public folder distribution) +- Version4 (default value) + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualDirectories +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. + +You can use any value that uniquely identifies the virtual directory. For example: + +- Name or Server\\Name +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +The default value of this parameter is the Client Access services (frontend) and backend OAB virtual directories on the Mailbox server that holds the OAB generation mailbox (the GeneratingMailbox parameter or SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}). For example, Mailbox01\\OAB (Default Web Site),Mailbox01\\OAB (Exchange Back End. + +To use this parameter, the value of the GlobalWebDistributionEnabled parameter must be $false. + +In Exchange 2013 CU7 or later, we recommend that you set the GlobalWebDistributionEnabled parameter to $true, because the Client Access services on any Mailbox server can proxy incoming OAB download requests to the correct location. + +```yaml +Type: VirtualDirectoryIdParameter[] +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md new file mode 100644 index 0000000000..a8a5a4ed57 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md @@ -0,0 +1,227 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-OnPremisesOrganization + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-OnPremisesOrganization cmdlet to create an OnPremisesOrganization object in a 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). + +## SYNTAX + +``` +New-OnPremisesOrganization [-Name] -HybridDomains -InboundConnector -OrganizationGuid -OutboundConnector + [-Comment ] + [-Confirm] + [-OrganizationName ] + [-OrganizationRelationship ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-OnPremisesOrganization -Name "ExchangeMail" -OrganizationGuid "a1bc23cb-3456-bcde-abcd-feb363cacc88" -HybridDomains contoso.com, sales.contoso.com -InboundConnector "Inbound to ExchangeMail" -OutboundConnector "Outbound to ExchangeMail" +``` + +This example creates the OnPremisesOrganization object ExchangeMail in a Microsoft 365 organization for the hybrid domains contoso.com and sales.contoso.com. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +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". + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundConnector +The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. + +```yaml +Type: InboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationGuid +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundConnector +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationRelationship +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-OrganizationRelationship.md b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md new file mode 100644 index 0000000000..8fe6d28c4a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md @@ -0,0 +1,580 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-OrganizationRelationship cmdlet to create organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-OrganizationRelationship [-Name] -DomainNames + [-ArchiveAccessEnabled ] + [-Confirm] + [-DeliveryReportEnabled ] + [-DomainController ] + [-Enabled ] + [-FreeBusyAccessEnabled ] + [-FreeBusyAccessLevel ] + [-FreeBusyAccessScope ] + [-MailboxMoveCapability ] + [-MailboxMoveEnabled ] + [-MailboxMovePublishedScopes ] + [-MailTipsAccessEnabled ] + [-MailTipsAccessLevel ] + [-MailTipsAccessScope ] + [-OAuthApplicationId ] + [-OrganizationContact ] + [-PhotosEnabled ] + [-TargetApplicationUri ] + [-TargetAutodiscoverEpr ] + [-TargetOwaURL ] + [-TargetSharingEpr ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-FederationInformation -DomainName Contoso.com | New-OrganizationRelationship -Name "Contoso" -FreeBusyAccessEnabled $true -FreeBusyAccessLevel LimitedDetails +``` + +This example creates an organization relationship with Contoso. The domain name to connect to is contoso.com. The following settings are used: + +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. + +### Example 2 +```powershell +New-OrganizationRelationship -Name "Fourth Coffee" -DomainNames "mail.fourthcoffee.com" -FreeBusyAccessEnabled $true -FreeBusyAccessLevel AvailabilityOnly -TargetAutodiscoverEpr "https://mail.fourthcoffee.com/autodiscover/autodiscover.svc/wssecurity" -TargetApplicationUri "mail.fourthcoffee.com" +``` + +This example creates the organization relationship with Fourth Coffee using the following settings. In this example, the connection settings with the external organization are provided. + +The domain to connect to is mail.fourthcoffee.com. + +The Exchange Web Services application URL is mail.fourthcoffee.com. + +The Autodiscover URL is `https://mail.fourthcoffee.com/autodiscover/autodiscover.svc/wssecurity`. + +Free/busy access is enabled. + +The requesting organization only receives free/busy information with the time. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNames +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ArchiveAccessEnabled +The ArchiveAccessEnabled parameter specifies whether the organization relationship has been 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryReportEnabled +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 + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether to enable the organization relationship. Valid values are: + +- $true: The organization relationship is enabled. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FreeBusyAccessEnabled +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. + +You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FreeBusyAccessLevel +The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: + +- None: No free/busy access. +- AvailabilityOnly: Free/busy access with time only. +- LimitedDetails: Free/busy access with time, subject, and location. + +This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMoveCapability +This parameter is available only in the cloud-based service. + +The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: + +- Inbound +- Outbound +- RemoteInbound +- RemoteOutbound + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). + +```yaml +Type: MailboxMoveCapability +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMoveEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMovePublishedScopes +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAccessEnabled +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. + +You control the MailTips access level by using the MailTipsAccessLevel parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAccessLevel +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. + +This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAccessScope +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +The default value is blank ($null), which means no group is specified. + +If you use this parameter, recipient-specific MailTips are returned only for those recipients that are members of the specified group. The recipient-specific MailTips are: + +- Auto Reply +- Mailbox Full +- Custom + +If you don't use this parameter, recipient-specific MailTips are returned for all recipients in the organization. + +This restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OAuthApplicationId +This parameter is available only in the cloud-based service. + +The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationContact +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhotosEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetApplicationUri +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetAutodiscoverEpr +The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetOwaURL +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetSharingEpr +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-OrganizationSegment.md b/exchange/exchange-ps/exchange/New-OrganizationSegment.md new file mode 100644 index 0000000000..a8a7015875 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OrganizationSegment.md @@ -0,0 +1,149 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-OrganizationSegment + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-OrganizationSegment cmdlet to create organization segments for use with information barrier policies in the Microsoft Purview compliance portal. Organization Segments are not in effect until you [apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-OrganizationSegment [-Name] -UserGroupFilter + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about the filterable attributes that you can use to define segments, see [Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-OrganizationSegment -Name "HR" -UserGroupFilter "Department -eq 'HR'" +``` + +In this example, a segment called HR is defined using HR, a value in the Department attribute. + +### Example 2 +```powershell +New-OrganizationSegment -Name "NotSales" -UserGroupFilter "Department -ne 'Sales'" +``` + +In this example, we defined a segment called NotSales that includes everyone who is not in Sales. The "-ne" portion of the cmdlet refers to "not equals." + +### Example 3 +```powershell +New-OrganizationSegment -Name "LocalFTE" -UserGroupFilter "Location -eq 'Local' -and Position -ne 'Temporary'" +``` + +In this example, we defined a segment called LocalFTE that includes people who are locally located and whose positions are not listed as Temporary. + +## PARAMETERS + +### -Name +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 +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 +``` + +### -UserGroupFilter +The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information, see [Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +Use the same property for all of your segments, and verify that your segments don't overlap (a user must be assigned to only one segment). + +```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 +``` + +### -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 + +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) diff --git a/exchange/exchange-ps/exchange/New-OutboundConnector.md b/exchange/exchange-ps/exchange/New-OutboundConnector.md new file mode 100644 index 0000000000..2121c66207 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OutboundConnector.md @@ -0,0 +1,449 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-OutboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-OutboundConnector cmdlet to create a new Outbound connector in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-OutboundConnector [-Name] + [-AllAcceptedDomains ] + [-CloudServicesMailEnabled ] + [-Comment ] + [-Confirm] + [-ConnectorSource ] + [-ConnectorType ] + [-Enabled ] + [-IsTransportRuleScoped ] + [-LinkForModifiedConnector ] + [-RecipientDomains ] + [-RouteAllMessagesViaOnPremises ] + [-SenderRewritingEnabled ] + [-SmartHosts ] + [-TestMode ] + [-TlsDomain ] + [-TlsSettings ] + [-UseMXRecord ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-OutboundConnector -Name "Contoso Outbound Connector" -RecipientDomains *.contoso.com -TlsSettings DomainValidation -TlsDomain *.contoso.com +``` + +This example creates the Outbound connector named Contoso Outbound Connector with the following properties: + +- It sends messages to recipients in the contoso.com domain and all subdomains. +- It uses TLS encryption and certificate verification for mail routed to the contoso.com domain and all subdomains + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllAcceptedDomains +The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: + +- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. +- $false: The Outbound connector isn't used in hybrid organizations. This is the default value. + +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServicesMailEnabled +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSource +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. +- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. +- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. + +```yaml +Type: TenantConnectorSource +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorType +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. +- OnPremises: The connector services domains that are used by your on-premises organization. + +```yaml +Type: TenantConnectorType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: + +- $true: The connector is enabled. This is the default value. +- $false: The connector is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsTransportRuleScoped +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkForModifiedConnector +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomains +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteAllMessagesViaOnPremises +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. + +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderRewritingEnabled +The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: + +- $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. +- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This is the default value. + +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmartHosts +The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: + +- FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. +- Single IP address: For example, 10.10.1.1. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. + +This parameter is required if you use the value $false for the UseMxRecord parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestMode +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsDomain +The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. + +Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). + +This parameter meaningful only when the TlsSettings value is DomainValidation. + +```yaml +Type: SmtpDomainWithSubdomains +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsSettings +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. + +```yaml +Type: TlsAuthLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMXRecord +The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: + +- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. +- $false: The connector delivers email to one or more smart hosts. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/policy-and-compliance/New-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md similarity index 75% rename from exchange/exchange-ps/exchange/policy-and-compliance/New-OutlookProtectionRule.md rename to exchange/exchange-ps/exchange/New-OutlookProtectionRule.md index c37de1604c..871a1233f5 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md @@ -1,84 +1,98 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-OutlookProtectionRule ## 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. Use the New-OutlookProtectionRule cmdlet to create a Microsoft Outlook protection rule. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OutlookProtectionRule [-Name] -ApplyRightsProtectionTemplate [-Confirm] - [-DomainController ] [-Enabled <$true | $false>] [-Force] [-FromDepartment ] - [-Priority ] [-SentTo ] - [-SentToScope ] [-UserCanOverride <$true | $false>] [-WhatIf] [] +New-OutlookProtectionRule [-Name] -ApplyRightsProtectionTemplate + [-Confirm] + [-DomainController ] + [-Enabled ] + [-Force] + [-FromDepartment ] + [-Priority ] + [-SentTo ] + [-SentToScope ] + [-UserCanOverride ] + [-WhatIf] + [] ``` ## DESCRIPTION Outlook protection rules are administrator-created rules applied before a user sends a message using Outlook. Outlook inspects message content and protects messages by applying Active Directory Rights Management Services (AD RMS) rights templates. -For more information, see Outlook protection rules (https://technet.microsoft.com/library/dd638178.aspx). +For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-OutlookProtectionRule -Name "Project Contoso" -SentTo Joe@contoso.com -ApplyRightsProtectionTemplate "Template-Contoso" ``` -This example applies the AD RMS template Template-Contoso to messages sent to the SMTP address Joe@contoso.com. +This example applies the AD RMS template named Template-Contoso to messages sent to the SMTP address Joe@contoso.com. ## PARAMETERS -### -ApplyRightsProtectionTemplate -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. +### -Name +The Name parameter specifies a name for the rule. ```yaml -Type: RmsTemplateIdParameter +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a name for the rule. +### -ApplyRightsProtectionTemplate +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: String +Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: False +Accept 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -86,6 +100,7 @@ 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 Default value: None @@ -103,6 +118,7 @@ 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 @@ -114,10 +130,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -126,13 +143,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress the confirmation prompt used to warn the administrator when rules are created without any conditions. Rules without any conditions specified apply to all messages. The Force switch doesn't require a value. +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). ```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 Default value: None @@ -148,6 +168,7 @@ 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 Default value: None @@ -163,6 +184,7 @@ 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 Default value: None @@ -171,15 +193,29 @@ Accept wildcard characters: False ``` ### -SentTo -The SentTo parameter specifies one or more recipients as a rule condition. The identity of recipients in the organization or the SMTP address of external recipients can be specified. +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: -The SentTo parameter doesn't accept wildcard characters. When multiple recipients are specified, messages sent to any of the specified recipients are considered a match. +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can also specify the SMTP email address of an external recipient. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +When you specify multiple recipients, messages sent to any of the specified recipients are considered a match. + +This parameter doesn't accept wildcard characters. ```yaml 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 Default value: None @@ -191,14 +227,14 @@ Accept wildcard characters: False 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. - - All: This value is for messages sent to all recipients. ```yaml -Type: All | InOrganization +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 Default value: None @@ -210,10 +246,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -229,6 +266,7 @@ 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 Default value: None @@ -237,20 +275,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/fd1ca109-ff80-492a-8112-62b3e9218594.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/New-OutlookProvider.md b/exchange/exchange-ps/exchange/New-OutlookProvider.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access/New-OutlookProvider.md rename to exchange/exchange-ps/exchange/New-OutlookProvider.md index a56fadae75..8552c51259 100644 --- a/exchange/exchange-ps/exchange/client-access/New-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/New-OutlookProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-OutlookProvider @@ -13,30 +16,34 @@ This cmdlet is available only in on-premises Exchange. Use the New-OutlookProvider cmdlet to create the AutoDiscoverConfig object and then populate the object with relevant settings. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OutlookProvider [-Name] [-Confirm] [-DomainController ] [-WhatIf] [] +New-OutlookProvider [-Name] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-OutlookProvider -Name MyOABUrl ``` This example creates the AutoDiscoverConfig object MyOABUrl. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-OutlookProvider -DomainController DC1 -Name Autodiscover1 ``` @@ -52,6 +59,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -62,8 +70,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -71,6 +78,7 @@ 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 @@ -86,6 +94,7 @@ 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 @@ -101,6 +110,7 @@ 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 @@ -109,20 +119,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3e80fb04-531f-4044-b957-9ba4fc712e4b.aspx) diff --git a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md new file mode 100644 index 0000000000..b25a96ccdb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md @@ -0,0 +1,154 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-OwaMailboxPolicy cmdlet to create Outlook on the web mailbox policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-OwaMailboxPolicy [-Name] + [-Confirm] + [-DomainController ] + [-IsDefault] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Set-OwaMailboxPolicy cmdlet to configure the new policy. + +Changes to Outlook on the web mailbox policies may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-OwaMailboxPolicy -Name Corporate +``` + +This example creates the Outlook on the web mailbox policy named Corporate. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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. + +If another policy is currently set as the default, using this switch replaces the old default policy with this policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access-servers/New-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md similarity index 86% rename from exchange/exchange-ps/exchange/client-access-servers/New-OwaVirtualDirectory.md rename to exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md index d00102113a..703e02a8bd 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-OwaVirtualDirectory @@ -13,38 +16,40 @@ This cmdlet is available only in on-premises Exchange. Use the New-OwaVirtualDirectory cmdlet to create Outlook on the web virtual directories that are used in Internet Information Services on Exchange servers. Typically, you create virtual directories on Exchange servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OwaVirtualDirectory - [[-ApplicationRoot ] + [-ApplicationRoot ] [-AppPoolId ] [-Confirm] [-DomainController ] [-ExtendedProtectionFlags ] [-ExtendedProtectionSPNList ] - [-ExtendedProtectionTokenChecking ] + [-ExtendedProtectionTokenChecking ] [-ExternalAuthenticationMethods ] - [-ExternalUrl ] [-InternalUrl ] + [-ExternalUrl ] + [-InternalUrl ] [-Name ] [-Path ] - [-Role ] + [-Role ] [-Server ] [-WebSiteName ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-OwaVirtualDirectory -WebSiteName "Contoso.com" ``` @@ -52,6 +57,24 @@ This example creates the Outlook on the web virtual directory in an IIS website ## PARAMETERS +### -Name +This parameter is available only in Exchange Server 2010. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplicationRoot The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. @@ -60,6 +83,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -75,6 +99,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -85,8 +110,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -94,6 +118,7 @@ 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 @@ -109,6 +134,7 @@ 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 @@ -120,13 +146,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -134,6 +156,7 @@ 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 @@ -145,14 +168,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -164,20 +187,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,33 +209,19 @@ Accept wildcard characters: False 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 - - Basic - - Certificate - - Digest - - Fba - - Kerberos - - LiveIdBasic - - LiveIdFba - - LiveIdNegotiate - - NegoEx - - Negotiate - - Ntlm - - OAuth - - WindowsIntegrated - - WSSecurity You can specify multiple values separated by commas. @@ -223,7 +229,6 @@ You can specify multiple values separated by commas. Although you can specify any of these values, whether or not the authentication method actually works for external connections depends on other factors. For example: - Is the authentication method available on the virtual directory? - - Is the authentication method available, but disabled on the virtual directory? ```yaml @@ -231,6 +236,7 @@ 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 @@ -246,6 +252,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -261,25 +268,9 @@ Type: Uri 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 -``` - -### -Name -This parameter is available or functional only in Exchange Server 2010. -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -293,6 +284,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -304,16 +296,16 @@ Accept wildcard characters: False 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. - - Mailbox: Configure the virtual directory for the backend services on the Mailbox server. Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. ```yaml -Type: ClientAccess | Mailbox +Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -325,11 +317,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - ExchangeLegacyDN ```yaml @@ -337,6 +326,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -352,6 +342,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -367,6 +358,7 @@ 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 @@ -375,20 +367,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/90fe1e31-aa64-4101-a385-7136f3bd9582.aspx) diff --git a/exchange/exchange-ps/exchange/New-PartnerApplication.md b/exchange/exchange-ps/exchange/New-PartnerApplication.md new file mode 100644 index 0000000000..d0ef93326f --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PartnerApplication.md @@ -0,0 +1,352 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-PartnerApplication + +## SYNOPSIS +This cmdlet is functional only in on-premises Exchange. + +Use the New-PartnerApplication cmdlet to create partner application configurations in on-premises Exchange organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ACSTrustApplication +``` +New-PartnerApplication [-Name] -ApplicationIdentifier + [-Realm ] + [-AcceptSecurityIdentifierInformation ] + [-AccountType ] + [-ActAsPermissions ] + [-AppOnlyPermissions ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IssuerIdentifier ] + [-LinkedAccount ] + [-WhatIf] + [] +``` + +### AuthMetadataUrl +``` +New-PartnerApplication [-Name] -AuthMetadataUrl + [-TrustAnySSLCertificate] + [-AcceptSecurityIdentifierInformation ] + [-AccountType ] + [-ActAsPermissions ] + [-AppOnlyPermissions ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IssuerIdentifier ] + [-LinkedAccount ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-PartnerApplication -Name HRApp -ApplicationIdentifier 00000006-0000-0dd1-ac00-000000000000 +``` + +This example creates a new HRApp partner application named HRApp. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationIdentifier +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthMetadataUrl +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. + +```yaml +Type: String +Parameter Sets: AuthMetadataUrl +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptSecurityIdentifierInformation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountType +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) +- ConsumerAccount + +```yaml +Type: SupportedAccountType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActAsPermissions +This parameter is available only in Exchange Server 2013. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppOnlyPermissions +This parameter is available only in Exchange Server 2013. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssuerIdentifier +This parameter is available only in Exchange Server 2013. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedAccount +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Realm +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. + +```yaml +Type: String +Parameter Sets: ACSTrustApplication +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 +``` + +### -TrustAnySSLCertificate +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. + +We don't recommend using this switch in a production environment. + +```yaml +Type: SwitchParameter +Parameter Sets: AuthMetadataUrl +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 +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md new file mode 100644 index 0000000000..4d6de2ee03 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md @@ -0,0 +1,179 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-PhishSimOverridePolicy + +## 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). + +For 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-PhishSimOverridePolicy [-Name] + [-Comment ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-PhishSimOverridePolicy -Name PhishSimOverridePolicy +``` + +This example creates the phishing simulation override policy named PhishSimOverridePolicy. + +## 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +In Exchange Online PowerShell, the WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md new file mode 100644 index 0000000000..c32359ad77 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md @@ -0,0 +1,161 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-PolicyTipConfig cmdlet to create custom Policy Tips in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-PolicyTipConfig [-Name] -Value + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-PolicyTipConfig -Name en\NotifyOnly -Value "This message contains content that is restricted by Contoso company policy." +``` + +This example creates a custom Policy Tip with the following settings: + +- Locale: English +- Action: NotifyOnly +- Policy Tip text: "This message contains content that is restricted by Contoso company policy." + +### Example 2 +```powershell +New-PolicyTipConfig Url -Value "https://www.contoso.com/PolicyTipInformation" +``` + +This example sets the informational URL in Policy Tips to the value `https://www.contoso.com/PolicyTipInformation`. + +## PARAMETERS + +### -Name +The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: + +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- Url + +There can be only one custom Policy Tip with the value Url for the Name parameter. For the remaining Policy Tip actions, there can be only one custom Policy Tip for each combination of locale and action. For example, there can be only one custom Policy Tip with the Name value en\\NotifyOnly, but you can create additional custom Policy Tips with the values de\\NotifyOnly and fr\\NotifyOnly for the Name parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md new file mode 100644 index 0000000000..fd597096d0 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md @@ -0,0 +1,324 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-PowerShellVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-PowerShellVirtualDirectory cmdlet to create Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-PowerShellVirtualDirectory [-Name] + [-BasicAuthentication ] + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-InternalUrl ] + [-RequireSSL ] + [-Role ] + [-Server ] + [-WhatIf] + [-WindowsAuthentication ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-PowerShellVirtualDirectory -Name "Contoso Certificates Required" -BasicAuthentication $false -WindowsAuthentication $false -CertificateAuthentication $true +``` + +This example creates a Windows PowerShell virtual directory and configures it to accept only certificate authentication. + +## 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 ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BasicAuthentication +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionFlags +The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: + +- None: This is the default setting. +- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. +- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. +- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionSPNList +The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: + +- $null: This is the default value. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionTokenChecking +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: + +- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. + +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. + +```yaml +Type: ExtendedProtectionTokenCheckingMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUrl +The ExternalUrl parameter specifies the external URL that the PowerShell virtual directory points to. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSSL +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +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. +- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. + +Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. + +```yaml +Type: VirtualDirectoryRole +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: ServerIdParameter +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 +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsAuthentication +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ProtectionAlert.md b/exchange/exchange-ps/exchange/New-ProtectionAlert.md new file mode 100644 index 0000000000..5c469a4905 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ProtectionAlert.md @@ -0,0 +1,696 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-ProtectionAlert + +## 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 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). + +## SYNTAX + +``` +New-ProtectionAlert -Category -Name -NotifyUser -ThreatType + [-AggregationType ] + [-AlertBy ] + [-AlertFor ] + [-Comment ] + [-Confirm] + [-CorrelationPolicyId ] + [-Description ] + [-Disabled ] + [-Filter ] + [-LogicalOperationName ] + [-NotificationCulture ] + [-NotificationEnabled ] + [-NotifyUserOnFilterMatch ] + [-NotifyUserSuppressionExpiryDate ] + [-NotifyUserThrottleThreshold ] + [-NotifyUserThrottleWindow ] + [-Operation ] + [-PrivacyManagementScopedSensitiveInformationTypes ] + [-PrivacyManagementScopedSensitiveInformationTypesForCounting ] + [-PrivacyManagementScopedSensitiveInformationTypesThreshold ] + [-CustomProperties ] + [-Severity ] + [-Threshold ] + [-TimeWindow ] + [-UseCreatedDateTime ] + [-VolumeThreshold ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ProtectionAlert -Name "Content search deleted" -Category Others -NotifyUser admin@contoso.com -ThreatType Activity -Operation SearchRemoved -Description "Custom alert policy to track when content searches are deleted" -AggregationType None +``` + +This example creates an alert policy that triggers an alert whenever anyone in the organization deletes a Content Search in the Microsoft Purview compliance portal. + +## PARAMETERS + +### -Category +The Category parameter specifies a category for the alert policy. Valid values are: + +- AccessGovernance +- ComplianceManager +- DataGovernance +- MailFlow +- Others +- PrivacyManagement +- Supervision +- ThreatManagement + +When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting + +```yaml +Type: AlertRuleCategory +Parameter Sets: (All) +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUser +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreatType +The ThreatType parameter specifies the type of activities that are monitored by the alert policy. Valid values are: + +- Activity +- Malware + +The value that you select for this parameter determines the values you can use for the AlertBy, Filter, and Operation parameters. + +You can't change this value after you create the alert policy. + +```yaml +Type: ThreatAlertType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregationType +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. + +```yaml +Type: AlertAggregationType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertBy +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. +- Malware: Valid values are Mail.Recipient or Mail.ThreatName. + +You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). + +```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 +``` + +### -AlertFor +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationPolicyId +{{ Fill CorrelationPolicyId Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomProperties +{{ Fill CustomProperties Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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. + +```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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical `-and` operator (for example, `"Criteria1 -and Criteria2"`). + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +The filterable properties are: + +Activity + +- Activity.ClientIp +- Activity.CreationTime +- Activity.Item +- Activity.ItemType +- Activity.Operation +- Activity.ResultStatus +- Activity.Scope +- Activity.SiteUrl +- Activity.SourceFileExtension +- Activity.SourceFileName +- Activity.TargetUserOrGroupType +- Activity.UserAgent +- Activity.UserId +- Activity.UserType +- Activity.Workload + +Malware + +- Mail:AttachmentExtensions +- Mail:AttachmentNames +- Mail:CreationTime +- Mail:DeliveryStatus +- Mail:Direction +- Mail:From +- Mail:FromDomain +- Mail:InternetMessageId +- Mail:IsIntraOrgSpoof +- Mail:IsMalware +- Mail:IsSpam +- Mail:IsThreat +- Mail:Language +- Mail:Recipient +- Mail:Scl +- Mail:SenderCountry +- Mail:SenderIpAddress +- Mail:Subject +- Mail:TenantId +- Mail:ThreatName + +```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 +``` + +### -LogicalOperationName +{{ Fill LogicalOperationName 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 +``` + +### -NotificationCulture +The NotificationCulture parameter specifies the language or locale that's used for notifications. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://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 +``` + +### -NotificationEnabled +{{ Fill NotificationEnabled 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 +``` + +### -NotifyUserOnFilterMatch +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. + +You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). + +```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 +``` + +### -NotifyUserSuppressionExpiryDate +The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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: + +- An integer. +- The value $null. This is the default value (no maximum number of notifications for an alert). + +```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 +``` + +### -NotifyUserThrottleWindow +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). + +```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 +``` + +### -Operation +The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). + +Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. + +You can only use this parameter when the ThreatType parameter has the value Activity. + +```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 +``` + +### -PrivacyManagementScopedSensitiveInformationTypes +{{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesForCounting +{{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesThreshold +{{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +The Severity parameter specifies the severity of the detection. Valid values are: + +- 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 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. + +```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 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. + +```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 +``` + +### -UseCreatedDateTime +{{ Fill UseCreatedDateTime Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeThreshold +{{ Fill VolumeThreshold Description }} + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-PublicFolder.md b/exchange/exchange-ps/exchange/New-PublicFolder.md new file mode 100644 index 0000000000..71c11a5ab5 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PublicFolder.md @@ -0,0 +1,238 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-PublicFolder cmdlet to create a public folder with the specified name. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-PublicFolder [-Name] + [-Confirm] + [-DomainController ] + [-EformsLocaleId ] + [-Mailbox ] + [-Path ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-PublicFolder -Name Marketing +``` + +This example creates the public folder Marketing in the root of the public folder. + +### Example 2 +```powershell +New-PublicFolder -Name FY2010 -Path \Legal\Cases -Server MBXSVR01 +``` + +In Exchange Server 2010, this example creates the public folder FY2010 under the existing folders \\Legal\\Cases. The path to the new folder is \\Legal\\Cases\\FY2010 on the server MBXSVR01. + +### Example 3 +```powershell +New-PublicFolder -Name FY2014 -Path \Legal\Cases +``` + +This example creates the public folder FY2014 under the existing folders \\Legal\\Cases. The path to the new folder is \\Legal\\Cases\\FY2014. + +### Example 4 +```powershell +New-PublicFolder -Name Support -Mailbox North_America +``` + +This example creates the public folder Support in the North\_America hierarchy public folder mailbox. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EformsLocaleId +The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Path +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server if the server is a Mailbox server with a public folder database. If not, Exchange creates the new public folder on the closest (by site cost) Exchange 2007 or Exchange 2010 Mailbox server with a public folder database. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md new file mode 100644 index 0000000000..992f21daac --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md @@ -0,0 +1,186 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-PublicFolderDatabase + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the New-PublicFolderDatabase cmdlet to create a public folder database. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-PublicFolderDatabase [-Name] -Server + [-Confirm] + [-DomainController ] + [-EdbFilePath ] + [-LogFolderPath ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-PublicFolderDatabase -Name "My Public Folder Database" -EdbFilePath "C:\Program Files\Microsoft\Exchange Server\V14\Mailbox\PFDB01.edb" -LogFolderPath "C:\Program Files\Microsoft\Exchange Server\V14\Mailbox\PFDB01" +``` + +This example creates the public folder database PFDB01. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +A server can have only one public folder database. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdbFilePath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogFolderPath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md new file mode 100644 index 0000000000..332ac3deec --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md @@ -0,0 +1,175 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-PublicFolderDatabaseRepairRequest + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the New-PublicFolderDatabaseRepairRequest cmdlet to detect and fix replication issues in the public folder database. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-PublicFolderDatabaseRepairRequest [-Database] -CorruptionType + [-Confirm] + [-DetectOnly] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Public folders on the public folder database can still be accessed while the request is running. However, access isn't available to the public folder currently being repaired. + +After you begin the repair request, it can't be stopped unless you dismount the database. For more information, see [Dismount a Database](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-PublicFolderDatabaseRepairRequest -Database PFDB01 -CorruptionType ReplState +``` + +This example detects and repairs replication issues in the public folder database PFDB01. + +### Example 2 +```powershell +New-PublicFolderDatabaseRepairRequest -Database PFDB02 -CorruptionType ReplState -DetectOnly +``` + +This example only detects and reports on replication issues on public folder database PFDB02. + +## PARAMETERS + +### -Database +The Database parameter specifies the public folder database that you want to repair. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CorruptionType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetectOnly +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md new file mode 100644 index 0000000000..8707577d81 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md @@ -0,0 +1,460 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-PublicFolderMigrationRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-PublicFolderMigrationRequest cmdlet to start a serial public folder migration from Exchange Server 2010. + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-PublicFolderMigrationRequest [[-Name] ] -SourceDatabase + [-AcceptLargeDataLoss] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-CSVData ] + [-CSVStream ] + [-DomainController ] + [-InternalFlags ] + [-LargeItemLimit ] + [-MigrationMailbox ] + [-Priority ] + [-RequestExpiryInterval ] + [-SkipMerging ] + [-SourceEndpoint ] + [-Suspend] + [-SuspendComment ] + [-WhatIf] + [-WorkloadType ] + [] +``` + +## DESCRIPTION +Migrating public folders is a multi-step process. For more information before you attempt a public folder migration, see [Use serial migration to migrate public folders to Exchange 2013 from previous versions](https://learn.microsoft.com/previous-versions/exchange-server/exchange-150/jj150486(v=exchg.150)). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-PublicFolderMigrationRequest -SourceDatabase PFDB01 -CSVData ([System.IO.File]::ReadAllBytes('C:\PFMigration\CSVData.csv')) +``` + +This example creates a public folder migration request from the Exchange 2010 source public folder database PFDB01 and uses the CSVData.csv file that was created using the Export-PublicFolderStatistics.ps1 script. For more information, see [Use serial migration to migrate public folders to Exchange 2013 from previous versions](https://learn.microsoft.com/previous-versions/exchange-server/exchange-150/jj150486(v=exchg.150)). + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SourceDatabase +The SourceDatabase parameter specifies the target database for the public folders. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompletedRequestAgeLimit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CSVData +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`). + +You can't use this parameter with the CSVStream parameter, but you need to use it if you don't use CSVStream parameter. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CSVStream +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. + +```yaml +Type: Stream +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalFlags +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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: + +- 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. + +If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: + +- Lowest +- Lower +- Low +- Normal: This is the default value. +- High +- Higher +- Highest +- Emergency + +```yaml +Type: RequestPriority +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendComment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkloadType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md new file mode 100644 index 0000000000..435cac68b3 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md @@ -0,0 +1,431 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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. + +For 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-PublicFolderMoveRequest -Folders -TargetMailbox + [-AcceptLargeDataLoss] + [-AllowLargeItems] + [-BadItemLimit ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-DomainController ] + [-InternalFlags ] + [-Name ] + [[-Organization] ] + [-Priority ] + [-RequestExpiryInterval ] + [-Suspend] + [-SuspendComment ] + [-SuspendWhenReadyToComplete] + [-WhatIf] + [-WorkloadType ] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-PublicFolderMoveRequest -Folders \DeveloperReports\CustomerEngagements -TargetMailbox DeveloperReports01 +``` + +This example begins the move request for the public folder \\CustomerEngagements from public folder mailbox DeveloperReports to DeveloperReports01. + +### Example 2 +```powershell +New-PublicFolderMoveRequest -Folders \Dev\CustomerEngagements,\Dev\RequestsforChange,\Dev\Usability -TargetMailbox DeveloperReports01 +``` + +This example begins the move request for public folders under the \\Dev public folder branch to the target public folder mailbox DeveloperReports01. + +You can also move a branch of public folders by using the Move-PublicFolderBranch.ps1 script. + +### Example 3 +```powershell +$folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity} + +New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders +``` + +This example moves all public folders from public folder mailbox Pub1 to public folder mailbox Pub2. + +## 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. + +```yaml +Type: PublicFolderIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetMailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptLargeDataLoss +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLargeItems +The AllowLargeItems switch specifies that you can move large items only when they're encountered. You don't need to specify a value with this switch. + +Large items are email messages with a maximum of 1,023 attachments. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to 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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalFlags +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is available only in the cloud-based service. + +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: + +- Lowest +- Lower +- Low +- Normal: This is the default value. +- High +- Higher +- Highest +- Emergency + +```yaml +Type: RequestPriority +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendComment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendWhenReadyToComplete +This parameter is available only in on-premises Exchange. + +The SuspendWhenReadyToComplete switch specifies whether to suspend the request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. + +After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkloadType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-QuarantinePermissions.md b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md new file mode 100644 index 0000000000..2ce42db98f --- /dev/null +++ b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepermissions +applicable: Exchange Online, Exchange Online Protection +title: New-QuarantinePermissions +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-QuarantinePermissions + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets. + +Use the New-QuarantinePermissions cmdlet to create a variable that contains a quarantine permissions object to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-QuarantinePermissions + [[-PermissionToAllowSender] ] + [[-PermissionToBlockSender] ] + [[-PermissionToDelete] ] + [[-PermissionToDownload] ] + [[-PermissionToPreview] ] + [[-PermissionToRelease] ] + [[-PermissionToRequestRelease] ] + [[-PermissionToViewHeader] ] + [] +``` + +## DESCRIPTION +The default value for any parameters that you don't use is $false, so you only need to use parameters (permissions) that you want to set to $true. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$NoAccess = New-QuarantinePermissions +``` + +This example creates the same permissions that are used by the No access permissions group in quarantine policies. The permissions object is stored in the variable named `$NoAccess`. + +In the same PowerShell session, you can use `$NoAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +### Example 2 +```powershell +$LimitedAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true +``` + +This example creates the same permissions that are used by the Limited access permissions group in quarantine policies. The permissions object is stored in the variable named `$LimitedAccess`. + +In the same PowerShell session, you can use `$LimitedAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +### Example 3 +```powershell +$FullAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true +``` + +This example creates the same permissions that are used by the Full access permissions group in quarantine policies. The permissions object is stored in the variable named `$FullAccess`. + +In the same PowerShell session, you can use `$FullAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +## PARAMETERS + +### -PermissionToAllowSender +The PermissionToAllowSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: + +- $true: Allow sender is available for affected messages in quarantine. +- $false: Allow sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToBlockSender +The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: + +- $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. +- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDelete +The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: + +- $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. +- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDownload +The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToPreview +The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: + +- $true: Preview message is available for affected messages in quarantine. +- $false: Preview message isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRelease +The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: + +- $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. +- $false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRequestRelease +The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: + +- $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. +- $false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToViewHeader +The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md new file mode 100644 index 0000000000..1d12b70c98 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -0,0 +1,493 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepolicy +applicable: Exchange Online, Exchange Online Protection +title: New-QuarantinePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-QuarantinePolicy cmdlet to create quarantine policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-QuarantinePolicy [-Name] + [-AdminDisplayName ] + [-AdminNotificationFrequencyInDays ] + [-AdminNotificationLanguage ] + [-AdminNotificationsEnabled ] + [-AdminQuarantinePermissionsList ] + [-CustomDisclaimer ] + [-DomainController ] + [-EndUserQuarantinePermissions ] + [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] + [-EndUserSpamNotificationFrequencyInDays ] + [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] + [-ESNEnabled ] + [-IncludeMessagesFromBlockedSenderAddress ] + [-MultiLanguageCustomDisclaimer ] + [-MultiLanguageSenderName ] + [-MultiLanguageSetting ] + [-OrganizationBrandingEnabled ] + [-QuarantinePolicyType ] + [-QuarantineRetentionDays ] + [] +``` + +## DESCRIPTION +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-QuarantinePolicy -Name ContosoTag -EndUserQuarantinePermissionsValue 0 +``` + +This example creates a new quarantine policy named ContosoTag with the same permissions as the No access preset permissions group. + +To assign Limited access permissions, use the value 27. To assign Full access permissions, use the value 23. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminQuarantinePermissionsList +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissions +**Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter. + +The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command. + +For example, run the following command to store the required permissions in a variable: `$Perms = New-QuarantinePermissions `. In the same PowerShell session, use the value `$Perms` for this parameter. + +```yaml +Type: QuarantinePermissions +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissionsValue +The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. + +This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): + +- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message. +- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender +- PermissionToBlockSender +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. +- PermissionToPreview +- PermissionToDelete + +The values for the preset end-user permission groups are described in the following list: + +- No access: Binary = 0000000, so use the decimal value 0. +- Limited access: Binary = 00101011, so use the decimal value 43. +- Full access: Binary = 00100111, so use the decimal value 39. + +For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter. + +**Note**: If the value of this parameter is 0 (No access) and the value of the ESNEnabled parameter is $true, users can view their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationCustomFromAddress +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. + +If you don't use this parameter, the default sender is quarantine@messaging.microsoft.com. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +The EndUserSpamNotificationFrequency parameter specifies how often quarantine notifications are sent to users. Valid values are: + +- 04:00:00 (4 hours) +- 1.00:00:00 (1 day) +- 7.00:00:00 (7 days) + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EsnCustomSubject +The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: MultiValuedProperty +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ESNEnabled +The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: + +- $true: Quarantine notifications are enabled. +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. + +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can see their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are: + +- $true: Recipients get quarantine notifications for affected messages from blocked senders. +- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageCustomDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSenderName +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSetting +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationBrandingEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineRetentionDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantinePolicyType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: QuarantinePolicyType +Parameter Sets: (All) +Aliases: +Accepted values: QuarantinePolicy, GlobalQuarantinePolicy +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/New-ReceiveConnector.md b/exchange/exchange-ps/exchange/New-ReceiveConnector.md similarity index 78% rename from exchange/exchange-ps/exchange/mail-flow/New-ReceiveConnector.md rename to exchange/exchange-ps/exchange/New-ReceiveConnector.md index 2567ed987c..a053087232 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/New-ReceiveConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ReceiveConnector @@ -13,34 +16,35 @@ This cmdlet is available only in on-premises Exchange. Use the New-ReceiveConnector cmdlet to create Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Custom ``` -New-ReceiveConnector [-Name] -Bindings -RemoteIPRanges [-Custom] - [-AdvertiseClientSettings <$true | $false>] - [-AuthMechanism ] +New-ReceiveConnector [-Name] -Bindings -RemoteIPRanges + [-Custom] + [-AdvertiseClientSettings ] + [-AuthMechanism ] [-AuthTarpitInterval ] [-Banner ] - [-BinaryMimeEnabled <$true | $false>] - [-ChunkingEnabled <$true | $false>] + [-BinaryMimeEnabled ] + [-ChunkingEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeout ] [-ConnectionTimeout ] [-DefaultDomain ] - [-DeliveryStatusNotificationEnabled <$true | $false>] + [-DeliveryStatusNotificationEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] - [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] - [-ExtendedProtectionPolicy ] + [-DomainSecureEnabled ] + [-EightBitMimeEnabled ] + [-EnableAuthGSSAPI ] + [-Enabled ] + [-EnhancedStatusCodesEnabled ] + [-ExtendedProtectionPolicy ] [-Fqdn ] - [-LongAddressesEnabled <$true | $false>] + [-LongAddressesEnabled ] [-MaxAcknowledgementDelay ] [-MaxHeaderSize ] [-MaxHopCount ] @@ -53,52 +57,54 @@ New-ReceiveConnector [-Name] -Bindings -RemoteIPR [-MaxProtocolErrors ] [-MaxRecipientsPerMessage ] [-MessageRateLimit ] - [-MessageRateSource ] - [-OrarEnabled <$true | $false>] - [-PermissionGroups ] - [-PipeliningEnabled <$true | $false>] - [-ProtocolLoggingLevel ] - [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] - [-RequireEHLODomain <$true | $false>] - [-RequireTLS <$true | $false>] + [-MessageRateSource ] + [-OrarEnabled ] + [-PermissionGroups ] + [-PipeliningEnabled ] + [-ProtocolLoggingLevel ] + [-RejectReservedSecondLevelRecipientDomains ] + [-RejectReservedTopLevelRecipientDomains ] + [-RejectSingleLabelRecipientDomains ] + [-RequireEHLODomain ] + [-RequireTLS ] [-Server ] [-ServiceDiscoveryFqdn ] - [-SizeEnabled ] - [-SuppressXAnonymousTls <$true | $false>] + [-SizeEnabled ] + [-SuppressXAnonymousTls ] [-TarpitInterval ] [-TlsCertificateName ] [-TlsDomainCapabilities ] - [-TransportRole ] - [-WhatIf] [] + [-TransportRole ] + [-WhatIf] + [] ``` ### Internet ``` -New-ReceiveConnector [-Name] -Bindings [-Internet] +New-ReceiveConnector [-Name] -Bindings + [-Internet] [-RemoteIPRanges ] - [-AdvertiseClientSettings <$true | $false>] - [-AuthMechanism ] + [-AdvertiseClientSettings ] + [-AuthMechanism ] [-AuthTarpitInterval ] [-Banner ] - [-BinaryMimeEnabled <$true | $false>] - [-ChunkingEnabled <$true | $false>] + [-BinaryMimeEnabled ] + [-ChunkingEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeout ] [-ConnectionTimeout ] [-DefaultDomain ] - [-DeliveryStatusNotificationEnabled <$true | $false>] + [-DeliveryStatusNotificationEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] - [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] - [-ExtendedProtectionPolicy ] + [-DomainSecureEnabled ] + [-EightBitMimeEnabled ] + [-EnableAuthGSSAPI ] + [-Enabled ] + [-EnhancedStatusCodesEnabled ] + [-ExtendedProtectionPolicy ] [-Fqdn ] - [-LongAddressesEnabled <$true | $false>] + [-LongAddressesEnabled ] [-MaxAcknowledgementDelay ] [-MaxHeaderSize ] [-MaxHopCount ] @@ -111,51 +117,53 @@ New-ReceiveConnector [-Name] -Bindings [-Internet [-MaxProtocolErrors ] [-MaxRecipientsPerMessage ] [-MessageRateLimit ] - [-MessageRateSource ] - [-OrarEnabled <$true | $false>] - [-PermissionGroups ] - [-PipeliningEnabled <$true | $false>] - [-ProtocolLoggingLevel ] - [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] - [-RequireEHLODomain <$true | $false>] - [-RequireTLS <$true | $false>] + [-MessageRateSource ] + [-OrarEnabled ] + [-PermissionGroups ] + [-PipeliningEnabled ] + [-ProtocolLoggingLevel ] + [-RejectReservedSecondLevelRecipientDomains ] + [-RejectReservedTopLevelRecipientDomains ] + [-RejectSingleLabelRecipientDomains ] + [-RequireEHLODomain ] + [-RequireTLS ] [-Server ] [-ServiceDiscoveryFqdn ] - [-SizeEnabled ] - [-SuppressXAnonymousTls <$true | $false>] + [-SizeEnabled ] + [-SuppressXAnonymousTls ] [-TarpitInterval ] [-TlsCertificateName ] [-TlsDomainCapabilities ] - [-TransportRole ] - [-WhatIf] [] + [-TransportRole ] + [-WhatIf] + [] ``` ### Partner ``` -New-ReceiveConnector [-Name] -Bindings -RemoteIPRanges [-Partner] - [-AdvertiseClientSettings <$true | $false>] - [-AuthMechanism ] +New-ReceiveConnector [-Name] -Bindings -RemoteIPRanges + [-Partner] + [-AdvertiseClientSettings ] + [-AuthMechanism ] [-AuthTarpitInterval ] [-Banner ] - [-BinaryMimeEnabled <$true | $false>] - [-ChunkingEnabled <$true | $false>] + [-BinaryMimeEnabled ] + [-ChunkingEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeout ] [-ConnectionTimeout ] [-DefaultDomain ] - [-DeliveryStatusNotificationEnabled <$true | $false>] + [-DeliveryStatusNotificationEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] - [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] - [-ExtendedProtectionPolicy ] + [-DomainSecureEnabled ] + [-EightBitMimeEnabled ] + [-EnableAuthGSSAPI ] + [-Enabled ] + [-EnhancedStatusCodesEnabled ] + [-ExtendedProtectionPolicy ] [-Fqdn ] - [-LongAddressesEnabled <$true | $false>] + [-LongAddressesEnabled ] [-MaxAcknowledgementDelay ] [-MaxHeaderSize ] [-MaxHopCount ] @@ -168,51 +176,54 @@ New-ReceiveConnector [-Name] -Bindings -RemoteIPR [-MaxProtocolErrors ] [-MaxRecipientsPerMessage ] [-MessageRateLimit ] - [-MessageRateSource ] - [-OrarEnabled <$true | $false>] - [-PermissionGroups ] - [-PipeliningEnabled <$true | $false>] - [-ProtocolLoggingLevel ] - [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] - [-RequireEHLODomain <$true | $false>] - [-RequireTLS <$true | $false>] + [-MessageRateSource ] + [-OrarEnabled ] + [-PermissionGroups ] + [-PipeliningEnabled ] + [-ProtocolLoggingLevel ] + [-RejectReservedSecondLevelRecipientDomains ] + [-RejectReservedTopLevelRecipientDomains ] + [-RejectSingleLabelRecipientDomains ] + [-RequireEHLODomain ] + [-RequireTLS ] [-Server ] [-ServiceDiscoveryFqdn ] - [-SizeEnabled ] - [-SuppressXAnonymousTls <$true | $false>] + [-SizeEnabled ] + [-SuppressXAnonymousTls ] [-TarpitInterval ] [-TlsDomainCapabilities ] [-TlsCertificateName ] - [-TransportRole ] - [-WhatIf] [] + [-TransportRole ] + [-WhatIf] + [] ``` ### Internal ``` -New-ReceiveConnector [-Name] -RemoteIPRanges [-Bindings ] [-Internal] - [-AdvertiseClientSettings <$true | $false>] - [-AuthMechanism ] +New-ReceiveConnector [-Name] -RemoteIPRanges + [-Bindings ] + [-Internal] + [-AdvertiseClientSettings ] + [-AuthMechanism ] [-AuthTarpitInterval ] [-Banner ] - [-BinaryMimeEnabled <$true | $false>] - [-ChunkingEnabled <$true | $false>] + [-BinaryMimeEnabled ] + [-ChunkingEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeout ] [-ConnectionTimeout ] [-DefaultDomain ] - [-DeliveryStatusNotificationEnabled <$true | $false>] + [-DeliveryStatusNotificationEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] - [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] - [-ExtendedProtectionPolicy ] + [-DomainSecureEnabled ] + [-EightBitMimeEnabled ] + [-EnableAuthGSSAPI ] + [-Enabled ] + [-EnhancedStatusCodesEnabled ] + [-ExtendedProtectionPolicy ] [-Fqdn ] - [-LongAddressesEnabled <$true | $false>] + [-LongAddressesEnabled ] [-MaxAcknowledgementDelay ] [-MaxHeaderSize ] [-MaxHopCount ] @@ -225,51 +236,54 @@ New-ReceiveConnector [-Name] -RemoteIPRanges [-Bi [-MaxProtocolErrors ] [-MaxRecipientsPerMessage ] [-MessageRateLimit ] - [-MessageRateSource ] - [-OrarEnabled <$true | $false>] - [-PermissionGroups ] - [-PipeliningEnabled <$true | $false>] - [-ProtocolLoggingLevel ] - [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] - [-RequireEHLODomain <$true | $false>] - [-RequireTLS <$true | $false>] + [-MessageRateSource ] + [-OrarEnabled ] + [-PermissionGroups ] + [-PipeliningEnabled ] + [-ProtocolLoggingLevel ] + [-RejectReservedSecondLevelRecipientDomains ] + [-RejectReservedTopLevelRecipientDomains ] + [-RejectSingleLabelRecipientDomains ] + [-RequireEHLODomain ] + [-RequireTLS ] [-Server ] [-ServiceDiscoveryFqdn ] - [-SizeEnabled ] - [-SuppressXAnonymousTls <$true | $false>] + [-SizeEnabled ] + [-SuppressXAnonymousTls ] [-TarpitInterval ] [-TlsCertificateName ] [-TlsDomainCapabilities ] - [-TransportRole ] - [-WhatIf] [] + [-TransportRole ] + [-WhatIf] + [] ``` ### Client ``` -New-ReceiveConnector [-Name] -RemoteIPRanges [-Bindings ] [-Client] - [-AdvertiseClientSettings <$true | $false>] - [-AuthMechanism ] +New-ReceiveConnector [-Name] -RemoteIPRanges + [-Bindings ] + [-Client] + [-AdvertiseClientSettings ] + [-AuthMechanism ] [-AuthTarpitInterval ] [-Banner ] - [-BinaryMimeEnabled <$true | $false>] - [-ChunkingEnabled <$true | $false>] + [-BinaryMimeEnabled ] + [-ChunkingEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeout ] [-ConnectionTimeout ] [-DefaultDomain ] - [-DeliveryStatusNotificationEnabled <$true | $false>] + [-DeliveryStatusNotificationEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] - [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] - [-ExtendedProtectionPolicy ] + [-DomainSecureEnabled ] + [-EightBitMimeEnabled ] + [-EnableAuthGSSAPI ] + [-Enabled ] + [-EnhancedStatusCodesEnabled ] + [-ExtendedProtectionPolicy ] [-Fqdn ] - [-LongAddressesEnabled <$true | $false>] + [-LongAddressesEnabled ] [-MaxAcknowledgementDelay ] [-MaxHeaderSize ] [-MaxHopCount ] @@ -282,51 +296,54 @@ New-ReceiveConnector [-Name] -RemoteIPRanges [-Bi [-MaxProtocolErrors ] [-MaxRecipientsPerMessage ] [-MessageRateLimit ] - [-MessageRateSource ] - [-OrarEnabled <$true | $false>] - [-PermissionGroups ] - [-PipeliningEnabled <$true | $false>] - [-ProtocolLoggingLevel ] - [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] - [-RequireEHLODomain <$true | $false>] - [-RequireTLS <$true | $false>] + [-MessageRateSource ] + [-OrarEnabled ] + [-PermissionGroups ] + [-PipeliningEnabled ] + [-ProtocolLoggingLevel ] + [-RejectReservedSecondLevelRecipientDomains ] + [-RejectReservedTopLevelRecipientDomains ] + [-RejectSingleLabelRecipientDomains ] + [-RequireEHLODomain ] + [-RequireTLS ] [-Server ] [-ServiceDiscoveryFqdn ] - [-SizeEnabled ] - [-SuppressXAnonymousTls <$true | $false>] + [-SizeEnabled ] + [-SuppressXAnonymousTls ] [-TarpitInterval ] [-TlsCertificateName ] [-TlsDomainCapabilities ] - [-TransportRole ] - [-WhatIf] [] + [-TransportRole ] + [-WhatIf] + [] ``` ### UsageType ``` -New-ReceiveConnector [-Name] -Usage [-Bindings ] [-RemoteIPRanges ] - [AdvertiseClientSettings <$true | $false>] - [-AuthMechanism ] +New-ReceiveConnector [-Name] -Usage + [-Bindings ] + [-RemoteIPRanges ] + [AdvertiseClientSettings ] + [-AuthMechanism ] [-AuthTarpitInterval ] [-Banner ] - [-BinaryMimeEnabled <$true | $false>] - [-ChunkingEnabled <$true | $false>] + [-BinaryMimeEnabled ] + [-ChunkingEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeout ] [-ConnectionTimeout ] [-DefaultDomain ] - [-DeliveryStatusNotificationEnabled <$true | $false>] + [-DeliveryStatusNotificationEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] - [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] - [-ExtendedProtectionPolicy ] + [-DomainSecureEnabled ] + [-EightBitMimeEnabled ] + [-EnableAuthGSSAPI ] + [-Enabled ] + [-EnhancedStatusCodesEnabled ] + [-ExtendedProtectionPolicy ] [-Fqdn ] - [-LongAddressesEnabled <$true | $false>] + [-LongAddressesEnabled ] [-MaxAcknowledgementDelay ] [-MaxHeaderSize ] [-MaxHopCount ] @@ -339,38 +356,39 @@ New-ReceiveConnector [-Name] -Usage ] [-MaxRecipientsPerMessage ] [-MessageRateLimit ] - [-MessageRateSource ] - [-OrarEnabled <$true | $false>] - [-PermissionGroups ] - [-PipeliningEnabled <$true | $false>] - [-ProtocolLoggingLevel ] - [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] - [-RequireEHLODomain <$true | $false>] - [-RequireTLS <$true | $false>] + [-MessageRateSource ] + [-OrarEnabled ] + [-PermissionGroups ] + [-PipeliningEnabled ] + [-ProtocolLoggingLevel ] + [-RejectReservedSecondLevelRecipientDomains ] + [-RejectReservedTopLevelRecipientDomains ] + [-RejectSingleLabelRecipientDomains ] + [-RequireEHLODomain ] + [-RequireTLS ] [-Server ] [-ServiceDiscoveryFqdn ] - [-SizeEnabled ] - [-SuppressXAnonymousTls <$true | $false>] + [-SizeEnabled ] + [-SuppressXAnonymousTls ] [-TarpitInterval ] [-TlsCertificateName ] [-TlsDomainCapabilities ] - [-TransportRole ] - [-WhatIf] [] + [-TransportRole ] + [-WhatIf] + [] ``` ## DESCRIPTION On Mailbox servers, you can create Receive connectors in the Front End Transport service, and the Transport (Hub) service. On Edge Transport servers, you can create Receive connectors in the Transport service. -For more information about Receive connector usage types, permission groups, and authentication methods, see Receive connectors (https://technet.microsoft.com/library/aa996395.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ReceiveConnector -Name Test -Usage Custom -Bindings 10.10.1.1:25 -RemoteIPRanges 192.168.0.1-192.168.0.24 ``` @@ -390,6 +408,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -398,28 +417,24 @@ Accept wildcard characters: False ``` ### -Bindings -The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax "\:\","\:\". You can specify an IPv4 address and port, and 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. +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. You need to use this parameter when you use these usage type parameters: - The Internet switch (or the Usage parameter with the value Internet). - - The Partner switch (or the Usage parameter with the value Partner). - - The Custom switch (or the Usage parameter with the value Custom). You can't use this parameter when you use the following usage type parameters: - The Client switch (or the Usage parameter with the value Client. The default value is 0.0.0.0:587. - - The Internal switch (or Usage parameter with the value Internal). The default value is 0.0.0.0:25. The values for this parameter must satisfy one of the following uniqueness requirements: - The combination of IP address and TCP port doesn't conflict with the IP address and TCP port that's used on another Receive connector on the server. - - You use an existing combination of IP address and TCP port that's configured on another Receive connector on the server, but you restrict the remote IP addresses by using the RemoteIPRanges parameter. When you create a Receive connector, you can only use the RemoteIPRanges and Bindings parameters together with the Custom and Partner switches (or the Usage parameter with the value Custom or Partner). ```yaml @@ -427,6 +442,7 @@ Type: MultiValuedProperty Parameter Sets: Custom, Internet, Partner Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -439,6 +455,7 @@ Type: MultiValuedProperty Parameter Sets: Internal, Client, UsageType Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -452,7 +469,6 @@ The Client switch specifies the Client usage type for the Receive connector. You This usage type assigns the following default permission groups and authentication methods: - Permission groups:ExchangeUsers - - Authentication methods:TLS, BasicAuth, BasicAuthRequireTLS, and Integrated. When you use this switch, you also need to use the RemoteIPRanges parameter, and you can't use the Bindings parameter (the default value is 0.0.0.0:587). @@ -464,6 +480,7 @@ Type: SwitchParameter Parameter Sets: Client Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -477,7 +494,6 @@ The Internal switch specifies the Internal usage type for the Receive connector. This usage type assigns the following default permission groups and authentication methods: - Permission groups:ExchangeLegacyServers and ExchangeServers. - - Authentication methods:TLS and ExchangeServers. When you use this switch, you also need to use the RemoteIPRanges parameter, and you can't use the Bindings parameter (the default value is 0.0.0.0:25). @@ -489,6 +505,7 @@ Type: SwitchParameter Parameter Sets: Internal Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -502,7 +519,6 @@ The Internet switch specifies the Internet usage type for the Receive connector. This usage type assigns the following default permission groups and authentication methods: - Permission groups:AnonymousUsers - - Authentication methods:TLS When you use this switch, you also need to use the Bindings parameter, and you can't use the RemoteIPRanges parameter (the default value is 0.0.0.0-255.255.255.255). @@ -514,6 +530,7 @@ Type: SwitchParameter Parameter Sets: Internet Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -527,7 +544,6 @@ The Partner switch specifies the Partner usage type for the Receive connector. Y This usage type assigns the following default permission groups and authentication methods: - Permission groups:Partners - - Authentication methods:TLS When you use this switch, you also need to use the Bindings and RemoteIPRanges parameters. @@ -539,6 +555,7 @@ Type: SwitchParameter Parameter Sets: Partner Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -550,19 +567,15 @@ Accept wildcard characters: False 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. - - IP address range: For example, 192.168.1.1-192.168.1.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.1.1/24 or 2001:0DB8::CD3/60. -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.1.1/24 or 2001:0DB8::CD3/60. - -You can specify multiple value separated by commas ("\","\"...). +You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. Multiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another. For example, you can configure the following remote IP address ranges on different Receive connectors on the same server: - 0.0.0.0 - - 192.168.1.1/24 - - 192.168.1.10 When remote IP address ranges overlap, the Receive connector with the most specific match to the IP address of the connecting server is used. @@ -570,11 +583,8 @@ When remote IP address ranges overlap, the Receive connector with the most speci You need to use this parameter with the following usage type parameters: - The Client switch (or the Usage parameter with the value Client). - - The Internal switch (or the Usage parameter with the value Internal). - - The Partner switch (or the Usage parameter with the value Partner). - - The Custom switch (or the Usage parameter with the value Custom). You can't use this parameter with the Internet usage type (the default value is 0.0.0.0-255.255.255.255). @@ -584,6 +594,7 @@ Type: MultiValuedProperty Parameter Sets: Custom, Partner, Internal, Client Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -596,6 +607,7 @@ Type: MultiValuedProperty Parameter Sets: Internet, UsageType Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -607,31 +619,22 @@ Accept wildcard characters: False The Usage parameter specifies the default permission groups and authentication methods that are assigned to the Receive connector. Valid values are: - Client - - Custom - - Internal - - Internet - - Partner The following values for this parameter also require the Bindings parameter: - Internet - - Partner - - Custom The following values for this parameter also require the RemoteIPRanges parameter: - Client - - Internal - - Partner - - Custom For a description of the default permission groups and authentication methods that are assigned for each value, see the corresponding usage type switch descriptions. @@ -639,10 +642,11 @@ For a description of the default permission groups and authentication methods th You can't use this parameter with any other usage type switches (Client, Internal, Internet, Custom, or Partner). ```yaml -Type: Custom | Internet | Internal | Client | Partner +Type: UsageType Parameter Sets: UsageType Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -654,14 +658,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -673,36 +677,27 @@ Accept wildcard characters: False The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: - None - - Tls - - Integrated - - BasicAuth - - BasicAuthRequireTLS - - ExchangeServer - - ExternalAuthoritative You can specify multiple values separated by commas, but some values have dependencies and exclusions: - You can only use the value None by itself. - - The value BasicAuthRequireTLS also requires the values BasicAuth and Tls. - - The only other value that you can use with ExternalAuthoritative is Tls. - - The value Tls is required when the value of the RequireTLS parameter is $true. - - The value ExternalAuthoritative requires you to set the value of the PermissionGroups parameter to ExchangeServers. ```yaml -Type: None | Tls | Integrated | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative +Type: AuthMechanisms Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -724,6 +719,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -736,13 +732,14 @@ The Banner parameter specifies a custom SMTP 220 banner that's displayed to remo The default value of this parameter is blank ($null), which uses the following SMTP banner: -220 \ Microsoft ESMTP MAIL service ready at \\ +`220 Microsoft ESMTP MAIL service ready at ` ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -754,16 +751,16 @@ Accept wildcard characters: False 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. - - $false: BINARYMIME is disabled and isn't advertised in the EHLO response. The binary MIME extension is defined in RFC 3030. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -775,16 +772,16 @@ Accept wildcard characters: False 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. - - $false: CHUNKING is disabled and isn't advertised in the EHLO response. Chunking is defined in RFC 3030. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -800,6 +797,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -810,8 +808,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -819,6 +816,7 @@ 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 @@ -842,6 +840,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -865,6 +864,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -878,7 +878,6 @@ The Custom switch specifies the Custom usage type for the Receive connector. You This usage type assigns the following default permission groups and authentication methods: - Permission groups:None - - Authentication methods:TLS When you use this switch, you also need to use the Bindings and RemoteIPRanges parameters. @@ -892,6 +891,7 @@ Type: SwitchParameter Parameter Sets: Custom Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -903,17 +903,13 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID Although you can configure any accepted domain as the default domain, you typically specify an authoritative domain. The default domain is used by: -- The external postmaster address: postmaster@\. - +- The external postmaster address: `postmaster@`. - Encapsulated non-SMTP email addresses (Internet Mail Connector Encapsulated Address or IMCEA encapsulation). - - The primary address for all recipients in the default email address policy. If you configure another accepted domain as the default domain, the default email address policy isn't automatically updated. ```yaml @@ -921,6 +917,7 @@ Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -932,16 +929,16 @@ Accept wildcard characters: False 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. - - $false: DSN is disabled and isn't advertised in the EHLO response. Delivery status notifications are defined in RFC 3461. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -959,6 +956,7 @@ 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 @@ -970,26 +968,22 @@ Accept wildcard characters: False 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: - 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: - - The TLSReceiveDomainSecureList parameter on the Set-TransportConfig cmdlet. - - The AddressSpaces parameter on the Set-SendConnector cmdlet for the corresponding Send connector. - - The TLSSendDomainSecureList parameter on the Set-TransportConfig cmdlet. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1001,16 +995,16 @@ Accept wildcard characters: False 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. - - $false: 8BITMIME is disabled and isn't advertised in the EHLO response. 8-bit data transmission is defined in RFC 6152. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1022,16 +1016,16 @@ Accept wildcard characters: False 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. - - $false: Kerberos is disabled. The Extended SMTP keyword AUTH NTLM is advertised in the EHLO response. Clients can only use NTLM for Integrated Windows authentication. The Generic Security Services application programming interface (GSSAPI) is an IETF standard for accessing security services. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1043,14 +1037,14 @@ Accept wildcard characters: False 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. - - $false: The Receive connector is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1062,16 +1056,16 @@ Accept wildcard characters: False 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. - - $false: ENHANCEDSTATUSCODES is disabled and isn't advertised in the EHLO response. Enhanced status codes are defined in RFC 2034. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1083,18 +1077,17 @@ Accept wildcard characters: False 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. - - 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. 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. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionPolicySetting Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1106,11 +1099,8 @@ Accept wildcard characters: False 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. - - In the EHLO/HELO response of the Receive connector. - - In the most recent Received header field in the incoming message when. - - During TLS authentication. The default value is the FQDN of theExchange server that contains the Receive connector (for example edge01.contoso.com). You can specify a different FQDN (for example, mail.contoso.com). @@ -1120,6 +1110,7 @@ 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 @@ -1131,24 +1122,22 @@ Accept wildcard characters: False 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. When you set this parameter to the value $true, the following changes are made to the Receive connector: - The XLONGADDR Extended SMTP extension is enabled and is advertised in the EHLO response. - - The accepted line length of an SMTP session is increased to 8,000 characters. - - Valid long addresses are accepted by the MAIL FROM and RCPT TO SMTP commands. You can only configure this parameter on Receive connectors in the Transport service on Mailbox servers. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1157,9 +1146,9 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. -The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgement until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgement anyway. +The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgment until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgment until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgment anyway. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1170,6 +1159,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1183,15 +1173,10 @@ The MaxHeaderSize parameter specifies the maximum size of the SMTP message heade When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. A valid value is from 1 to 2147483647 bytes. @@ -1201,6 +1186,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1218,6 +1204,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1237,6 +1224,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1254,6 +1242,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1273,6 +1262,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1292,6 +1282,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1311,6 +1302,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1324,26 +1316,22 @@ The MaxMessageSize parameter specifies the maximum size of a message that's allo When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. A valid value for this parameter is from 65536 to 2147483647 bytes. -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1363,6 +1351,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1380,6 +1369,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1401,6 +1391,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1412,18 +1403,16 @@ Accept wildcard characters: False The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: - None: The message submission rate isn't calculated. - - User: The message submission rate is calculated for sending users (specified with the MAIL FROM SMTP command). - - IPAddress: The message submission rate is calculated for sending hosts. - - All: The message submission rate is calculated for both sending users and sending hosts. ```yaml -Type: None | IPAddress | User | All +Type: MessageRateSourceFlags Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1435,16 +1424,16 @@ Accept wildcard characters: False 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. 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1456,30 +1445,25 @@ Accept wildcard characters: False 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 - - AnonymousUsers - - ExchangeUsers - - ExchangeServers - - ExchangeLegacyServers - - Partners - - Custom The default permission groups that are assigned to a Receive connector depend on the connector usage type parameter that was used when the connector was created (Client, Internal, Internet, Partner, or Usage). When you use the value Custom, you need to configure individual permissions by using the Add-ADPermission cmdlet. -For more information about the default permissions and security principals for permission groups, see Receive connector permission groups (https://technet.microsoft.com/library/aa996395.aspx#PermissionGroups). +For more information about the default permissions and security principals for permission groups, see [Receive connector permission groups](https://learn.microsoft.com/Exchange/mail-flow/connectors/receive-connectors#receive-connector-permission-groups). ```yaml -Type: None | AnonymousUsers | ExchangeUsers | ExchangeServers | ExchangeLegacyServers | Partners | Custom +Type: PermissionGroups Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1491,16 +1475,16 @@ Accept wildcard characters: False 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. - - $false: PIPELINING is disabled and isn't advertised in the EHLO response. Pipelining is defined in RFC 2920. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1512,16 +1496,16 @@ Accept wildcard characters: False 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. - - Verbose: Protocol logging is enabled on the Receive connector. -For more information about protocol logging, see Protocol logging (https://technet.microsoft.com/library/aa997624.aspx). +For more information about protocol logging, see [Protocol logging](https://learn.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). ```yaml -Type: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1533,14 +1517,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1552,14 +1536,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1571,14 +1555,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1590,14 +1574,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1609,14 +1593,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1628,11 +1612,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -1642,6 +1623,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1657,6 +1639,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1668,18 +1651,17 @@ Accept wildcard characters: False 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. - - 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. SIZE is defined in RFC 1870. ```yaml -Type: Disabled | Enabled | EnabledWithoutValue +Type: SizeMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1691,16 +1673,16 @@ Accept wildcard characters: False 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. The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter contains the value ExchangeServer. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1722,6 +1704,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1730,13 +1713,14 @@ 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.500Issuer\X.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. +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 @@ -1749,23 +1733,25 @@ The TlsDomainCapabilities parameter specifies the capabilities that the Receive This parameter uses the following syntax: -"\:\,\\>"...,"\:\,\..."... +`"Domain1:Capability1,Capability2,"...,"Domain2:Capability1,Capability2,...",...` -The available \ values are: +You can only use this parameter in Exchange hybrid deployments, and the valid Capability values are: -- AcceptOorgProtocol +- AcceptCloudServicesMail (Exchange 2013 or later) +- AcceptOorgProtocol (Exchange 2010) -- AcceptOorgHeader +More Capability values are available, but there is no scenario to use them. For more information, see [Advanced Office 365 Routing](https://techcommunity.microsoft.com/t5/exchange-team-blog/advanced-office-365-routing-locking-down-exchange-on-premises/ba-p/609238). -The available \ values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. +The available Domain values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. -For example, "contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptOorgProtocol,AcceptOorgHeader" +For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServicesMail"`. ```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 @@ -1774,17 +1760,17 @@ Accept wildcard characters: False ``` ### -TransportRole -The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created.. Valid values are: +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. - - HubTransport: The Transport service where Exchange server and proxied client SMTP connections occur. ```yaml -Type: None | Cafe | Mailbox | ClientAccess | UnifiedMessaging | HubTransport | Edge | All | Monitoring | CentralAdmin | CentralAdminDatabase | DomainController | WindowsDeploymentServer | ProvisionedServer | LanguagePacks | FrontendTransport | CafeArray | FfoWebService | OSP | ARR | ManagementFrontEnd | ManagementBackEnd | SCOM | CentralAdminFrontEnd | NAT | DHCP +Type: ServerRole Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1800,6 +1786,7 @@ 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 @@ -1808,20 +1795,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/eb527447-ed68-4a55-943b-aad8c8a94d01.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-RemoteDomain.md b/exchange/exchange-ps/exchange/New-RemoteDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/mail-flow/New-RemoteDomain.md rename to exchange/exchange-ps/exchange/New-RemoteDomain.md index 42495876c9..d482738214 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/New-RemoteDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-RemoteDomain @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-RemoteDomain cmdlet to create a managed connection for a remote domain. When you create a remote domain, you can control mail flow with more precision, apply message formatting and messaging policies and specify acceptable character sets for messages sent to and received from the remote domain. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,16 +24,17 @@ For information about the parameter sets in the Syntax section below, see Exchan New-RemoteDomain [-Name] -DomainName [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-RemoteDomain -DomainName *.contoso.com -Name Contoso ``` @@ -38,33 +42,35 @@ This example creates the remote domain named Contoso for the domain contoso.com ## PARAMETERS -### -DomainName -The DomainName parameter specifies the SMTP domain that you want to establish as a remote domain. A valid value is an SMTP domain (for example, contoso.com). The maximum length is 256 characters. - -You can use the wildcard character (\*) to specify a domain and all subdomains (for example: \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com). +### -Name +The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml -Type: SmtpDomainWithSubdomains +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quoatation marks ("). +### -DomainName +The DomainName parameter specifies the SMTP domain that you want to establish as a remote domain. A valid value is an SMTP domain (for example, contoso.com). The maximum length is 256 characters. + +You can use the wildcard character (\*) to specify a domain and all subdomains (for example: \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com). ```yaml -Type: String +Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -73,8 +79,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -82,6 +87,7 @@ 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 Default value: None @@ -101,6 +107,7 @@ 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 @@ -116,6 +123,7 @@ 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 Default value: None @@ -124,20 +132,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/31442c97-1813-43d9-b9d1-da487e6b00ea.aspx) diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/exchange/New-RemoteMailbox.md new file mode 100644 index 0000000000..2647a103bb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-RemoteMailbox.md @@ -0,0 +1,753 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-RemoteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-RemoteMailbox cmdlet to create a mail user in the on-premises Active Directory and also create an associated mailbox in the cloud-based service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-RemoteMailbox [-Name] -Password -UserPrincipalName + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OnPremisesOrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemoteRoutingAddress ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### Room +``` +New-RemoteMailbox [-Name] [-Password ] [-Room] [-UserPrincipalName ] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OnPremisesOrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemoteRoutingAddress ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### Equipment +``` +New-RemoteMailbox [-Name] [-Equipment] [-Password ] [-UserPrincipalName ] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OnPremisesOrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemoteRoutingAddress ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### Shared +``` +New-RemoteMailbox [-Name] [-Shared] [-Password ] [-UserPrincipalName ] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OnPremisesOrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemoteRoutingAddress ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### AccountDisabled +``` +New-RemoteMailbox [-Name] [-AccountDisabled] [-Password ] [-UserPrincipalName ] + [-ACLableSyncedObjectEnabled] + [-Alias ] + [-Archive] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OnPremisesOrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-RemoteRoutingAddress ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-RemoteMailbox cmdlet creates an on-premises mail user. The mail user contains a specific attribute, which indicates that an associated mailbox in the service should be created when the user is synchronized to the service using directory synchronization. + +Directory synchronization must be configured correctly for a mailbox to be created in the service. Creation of the mailbox in the service isn't immediate and depends on the directory synchronization schedule. + +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). + +## EXAMPLES + +### Example 1 +```powershell +$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. + +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. + +After the new mail user is created, directory synchronization synchronizes the new mail user to the service and the associated mailbox is created. + +### Example 2 +```powershell +$Credentials = Get-Credential + +New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com -OnPremisesOrganizationalUnit "corp.contoso.com/Archive Users" -Archive +``` + +This example does the following steps: + +Creates an on-premises mail user. The mail user is placed in the contoso.com/Archive Users OU. The OU has no effect on the mailbox in the service. + +Creates the associated mailbox in the service. + +Creates an archive mailbox in the service for the mailbox. + +As in Example 1, this example assumes that mail flow and directory synchronization have been properly configured. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountDisabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Equipment +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). + +You can't use this switch with the Room switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Equipment +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +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: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: AccountDisabled, Equipment, Room, Shared +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 +``` + +```yaml +Type: SecureString +Parameter Sets: Default +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: Room +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +**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. + +You can't use this switch with the Room or Equipment switches. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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 +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 +``` + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +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 +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DisplayName +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. + +```yaml +Type: String +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 +``` + +### -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 +``` + +### -FirstName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutableId +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. + +```yaml +Type: String +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 +``` + +### -Initials +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastName +The LastName parameter specifies the user's last name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $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: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```yaml +Type: Boolean +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 +``` + +### -OnPremisesOrganizationalUnit +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +This parameter has no effect on the mailbox in the service. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -PrimarySmtpAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemotePowerShellEnabled +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. + +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. + +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +``` + +### -RemoteRoutingAddress +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. + +```yaml +Type: ProxyAddress +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 +``` + +### -ResetPasswordOnNextLogon +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. + +```yaml +Type: Boolean +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 +``` + +### -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. + +```yaml +Type: String +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +Type: TransportModerationNotificationFlags +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 +``` + +### -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/New-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..6ae7128ad5 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md @@ -0,0 +1,1029 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionpolicy +applicable: Exchange Online +title: New-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ReportSubmissionPolicy cmdlet to create the report submission policy in your cloud-based organization. The report submission policy controls most of the user reported message settings in the organization. + +**Note**: If the policy already exists (the Get-ReportSubmissionPolicy cmdlet returns output), you can't use this cmdlet. To delete the existing policy and start over with the default settings, use the Remove-ReportSubmissionPolicy cmdlet first. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ReportSubmissionPolicy + [-DisableQuarantineReportingOption ] + [-DisableUserSubmissionOptions ] + [-EnableCustomizedMsg ] + [-EnableCustomNotificationSender ] + [-EnableOrganizationBranding ] + [-EnableReportToMicrosoft ] + [-EnableThirdPartyAddress ] + [-EnableUserEmailNotification ] + [-JunkReviewResultMessage ] + [-NotificationFooterMessage ] + [-NotificationSenderAddress ] + [-NotificationsForCleanSubmissionAirInvestigationsEnabled ] + [-NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled ] + [-NotificationsForSpamSubmissionAirInvestigationsEnabled ] + [-NotificationsForSubmissionAirInvestigationsEnabled ] + [-NotJunkReviewResultMessage ] + [-OnlyShowPhishingDisclaimer ] + [-PhishingReviewResultMessage ] + [-PostSubmitMessage ] + [-PostSubmitMessageEnabled ] + [-PostSubmitMessageForJunk ] + [-PostSubmitMessageForNotJunk ] + [-PostSubmitMessageForPhishing ] + [-PostSubmitMessageTitle ] + [-PostSubmitMessageTitleForJunk ] + [-PostSubmitMessageTitleForNotJunk ] + [-PostSubmitMessageTitleForPhishing ] + [-PreSubmitMessage ] + [-PreSubmitMessageEnabled ] + [-PreSubmitMessageForJunk ] + [-PreSubmitMessageForNotJunk ] + [-PreSubmitMessageForPhishing ] + [-PreSubmitMessageTitle ] + [-PreSubmitMessageTitleForJunk ] + [-PreSubmitMessageTitleForNotJunk ] + [-PreSubmitMessageTitleForPhishing ] + [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] + [-ReportJunkAddresses ] + [-ReportJunkToCustomizedAddress ] + [-ReportNotJunkAddresses ] + [-ReportNotJunkToCustomizedAddress ] + [-ReportPhishAddresses ] + [-ReportPhishToCustomizedAddress ] + [-ThirdPartyReportAddresses ] + [-UserSubmissionOptions ] + [-UserSubmissionOptionsMessage ] + [] +``` + +## DESCRIPTION +The report submission policy controls most of the settings for user submissions in the Microsoft Defender portal at . + +The report submission rule (\*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are delivered. + +When you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: The ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses parameters. +- Microsoft integrated reporting using third-party tools in Outlook: The ThirdPartyReportAddresses parameter. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ReportSubmissionPolicy +``` + +This example creates the one and only report submission policy named DefaultReportSubmissionPolicy with the default values: reporting in Outlook is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to Microsoft (the reporting mailbox isn't used). + +### Example 2 +```powershell +$usersub = "reportedmessages@contoso.com" + +New-ReportSubmissionPolicy -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example creates the report submission policy with the following values: reporting in Outlook is on, Microsoft reporting tools in Outlook are used, and reported messages are sent to Microsoft and the specified reporting mailbox in Exchange Online. + +**Notes**: + +- The default value of the EnableReportToMicrosoft parameter is $true and the default value of the EnableThirdPartyAddress parameter is $false, so you don't need to use them. +- To create the policy, you need to specify the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. +- Like the report submission policy, you can create the report submission rule only if it doesn't already exist. If the rule already exists, you can use Set-ReportSubmissionRule to change the email address of the reporting mailbox, or Remove-ReportSubmissionRule to delete it and recreate it. + +### Example 3 +```powershell +$usersub = "userreportedmessages@fabrikam.com" + +New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub -DisableUserSubmissionOptions $false + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example creates the report submission policy with the following values: reporting in Outlook is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to the specified reporting mailbox in Exchange Online. + +### Example 4 +```powershell +$usersub = "thirdpartyreporting@wingtiptoys.com" + +New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ThirdPartyReportAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example creates the report submission policy with the following values: reporting in Outlook is on and third-party reporting tools in Outlook are used to send reported messages to the specified reporting mailbox in Exchange Online. + +### Example 5 +```powershell +New-ReportSubmissionPolicy -EnableReportToMicrosoft $false +``` + +This example creates the report submission policy with the following values: reporting in Outlook is off. Microsoft reporting tools in Outlook are not available to users and messages reported by third-party tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. + +## PARAMETERS + +### -DisableQuarantineReportingOption +The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: + +- $true: Users can't report quarantined messages from quarantine. +- $false: Users can report quarantined messages from quarantine. This is the default value. + +This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableUserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomizedMsg +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomNotificationSender +The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use a custom Microsoft 365 sender email address. +- $false: Use the default sender email address. This is the default value. + +You specify the sender email address using the NotificationSenderAddress parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use the company logo in the footer text instead of the Microsoft logo. +- $false: Don't use the company logo in the footer text. Use the Microsoft logo. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableReportToMicrosoft +The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. + +The value $true for this parameter enables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft only (the reporting mailbox isn't used)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. This is the default result. +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft and reported messages are sent to the specified reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +The value $false for this parameter disables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook, but reported messages are sent only to the reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. +- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with third-party reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. + +This parameter is required to create the report submission policy only if you set the value to $false (the default value is $true). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableThirdPartyAddress +The EnableThirdPartyAddress parameter specifies whether you're using third-party reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are: + +- $true: Reporting in Outlook is enabled, but third-party tools in Outlook send reported messages to the reporting mailbox in Exchange Online. You also need to set the EnableReportToMicrosoft parameter value to $false. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. +- $false: Third-party reporting tools in Outlook aren't used. + +This parameter is required to create the report submission policy only if you set the value to $true (the default value is $false). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUserEmailNotification +The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Customized admin review result messages are sent. +- $false: Customized admin review result messages are not sent. + +Use the JunkReviewResultMessage, NotJunkReviewResultMessage, PhishingReviewResultMessage parameters to configure the message body text that's used for each verdict. + +Use the NotificationFooterMessage parameter for the footer that's used for all verdicts (junk, not junk, and phishing). + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JunkReviewResultMessage +The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotJunkReviewResultMessage +The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationFooterMessage +The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. + +You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSenderAddress +The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForCleanSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSpamSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyShowPhishingDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishingReviewResultMessage +The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessage +The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageEnabled +{{ Fill PostSubmitMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForNotJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForPhishing +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitle +The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message text using the PostSubmitMessage parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForPhishing +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessage +The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageEnabled +{{ Fill PreSubmitMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForNotJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForPhishing +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitle +The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the pop-up message text using the PreSubmitMessage parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForPhishing +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageEnabled +{{ Fill ReportChatMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageToCustomizedAddressEnabled +{{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkAddresses +The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +This parameter is required to create the report submission policy if the ReportJunkToCustomizedAddress parameter value is $true. + +You can't use this parameter by itself. You need to specify the same email address for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +You also need to specify the same email address in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkToCustomizedAddress +The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters in the same command. + +This parameter is required to create the report submission policy if you're using reporting in Outlook (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkAddresses +The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +This parameter is required to create the report submission policy if the ReportNotJunkToCustomizedAddress parameter value is $true. + +You can't use this parameter by itself. You need to specify the same email address for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +You also need to specify the same email address in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkToCustomizedAddress +The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +This parameter is required to create the report submission policy if you're using reporting in Outlook (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishAddresses +The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +This parameter is required to create the report submission policy if the ReportPhishToCustomizedAddress parameter value is $true. + +You can't use this parameter by itself. You need to specify the same email address for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +You also need to specify the same email address in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishToCustomizedAddress +The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +This parameter is required to create the report submission policy if you're using reporting in Outlook (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyReportAddresses +Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox in Exchange Online when you're using a third-party product for user submissions instead of reporting in Outlook. + +This parameter is required to create the report submission policy if you've disabled reporting in Outlook (`-EnableReportToMicrosoft $false`) and you're using the reporting mailbox with third-party tools (`-EnableThirdPartyAddress $true`). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptionsMessage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md new file mode 100644 index 0000000000..9128905359 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionrule +applicable: Exchange Online +title: New-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ReportSubmissionRule cmdlet to create the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +**Note**: If the rule already exists (the Get-ReportSubmissionRule cmdlet returns output), you can't use this cmdlet. To delete the existing rule and start over, use the Remove-ReportSubmissionRule cmdlet first. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ReportSubmissionRule [-Name] -ReportSubmissionPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-SentTo ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use this cmdlet only if the following statements are true: + +- The report submission rule doesn't exist (the Get-ReportSubmissionRule cmdlet returns no output). +- The report submission policy exists (the Get-ReportSubmissionPolicy cmdlet returns output). + +The SentTo parameter identifies the email address of the reporting mailbox. Your organization needs a report submission rule only to send user reported messages to the reporting mailbox using Microsoft or third-party reporting tools in Outlook (reporting in Outlook is turned on). + +When you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *\-ReportSubmissionPolicy cmdlets are not updated. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo "userreportedmessages@contoso.onmicrosoft.com" +``` + +This example creates the report submission rule. The reporting mailbox is userreportedmessages@contoso.onmicrosoft.com. + +## PARAMETERS + +### -Name +The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSubmissionPolicy +The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled or disabled. Valid values are: + +- $true: The rule is enabled. This is the default value. +- $false: The rule is disabled. + +After you create the rule, use the Enable-ReportSubmissionRule and Disable-ReportSubmissionRule cmdlets to enable or disable the rule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. + +The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): + +- Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook: `-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true`. +- Microsoft integrated reporting is enabled using third-party reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. + +If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *\-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the \*-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md new file mode 100644 index 0000000000..80238a5236 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -0,0 +1,748 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-RetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-RetentionCompliancePolicy cmdlet to create new retention policies and new retention label policies in the Microsoft Purview compliance portal. Creating a new policy also requires use of the New-RetentionComplianceRule cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-RetentionCompliancePolicy [-Name] + [-Applications ] + [-Comment ] + [-Confirm] + [-Enabled ] + [-ExchangeLocation ] + [-ExchangeLocationException ] + [-Force] + [-IsSimulation] + [-ModernGroupLocation ] + [-ModernGroupLocationException ] + [-OneDriveLocation ] + [-OneDriveLocationException ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-PriorityCleanup] + [-PublicFolderLocation ] + [-RestrictiveRetention ] + [-RetainCloudAttachment ] + [-SharePointLocation ] + [-SharePointLocationException ] + [-SkipPriorityCleanupConfirmation] + [-SkypeLocation ] + [-SkypeLocationException ] + [-WhatIf] + [] +``` + +### TeamLocation +``` +New-RetentionCompliancePolicy [-Name] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-IsSimulation] + [-PriorityCleanup] + [-RestrictiveRetention ] + [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] + [-TeamsChannelLocation ] + [-TeamsChannelLocationException ] + [-TeamsChatLocation ] + [-TeamsChatLocationException ] + [-WhatIf] + [] +``` + +### AdaptiveScopeLocation +``` +New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation + [-Applications ] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-IsSimulation] + [-PriorityCleanup] + [-RestrictiveRetention ] + [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] + [-WhatIf] + [] +``` + +## DESCRIPTION +Policies are not valid until a rule is added (for retention policies) or a label is added (for retention label policies). For more information, see [New-RetentionComplianceRule](/powershell/module/exchange/new-retentioncompliancerule). In addition, at least one location parameter must be defined to create a retention policy or retention label policy. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal]/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" +``` + +This example creates a retention policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint site. + +The next step is to use the New-RetentionComplianceRule cmdlet to add a rule to the retention policy. + +### Example 2 +```powershell +New-RetentionCompliancePolicy -Name "Marketing Department" -Enabled $true -SharePointLocation https://contoso.sharepoint.com -RetainCloudAttachment $true -Comment "Regulatory compliance for Marketing Dept." +``` + +This example creates a new auto-apply label policy targeted to cloud attachments named Marketing Department with the specified details. + +The next step is to use the New-RetentionComplianceRule cmdlet to add a retention label to the retention label policy. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdaptiveScopeLocation +The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Applications +The Applications parameter specifies the 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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default, AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). +- The value All for all mailboxes. You can only use this value by itself. + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If no mailboxes are specified, then no mailboxes are placed on hold. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocationException +The ExchangeLocationException parameter specifies the mailboxes to exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsSimulation +The IsSimulation switch specifies the policy is created in simulation mode. You don't need to specify a value with this switch. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocation +The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: + +- A Microsoft 365 Group +- The value All for all Microsoft 365 Groups. You can only use this value by itself. + +To identify the Microsoft 365 Group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocationException +The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocationException +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +The PriorityCleanup switch specifies whether to create a [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup) policy to expedite the deletion of sensitive content, overriding any existing retention settings or eDiscovery holds. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderLocation +The PublicFolderLocation parameter specifies that you want to include all public folders in the retention policy. You use the value All for this parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictiveRetention +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: + +- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. +- $false: Preservation Lock isn't enabled for the policy. This is the default value. + +After a policy has been locked, no one can turn off or disable it, or remove 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. + +```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 +``` + +### -RetainCloudAttachment +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. + +The RetainCloudAttachment parameter specifies that this is a cloud attachment policy. Valid values are: + +- $true: The policy is a cloud attachment policy. +- $false: The policy is not a cloud attachment policy. This is the default value. + +For the value $true, you can only use the following location parameters: + +- SharePointLocation and SharePointLocationException +- OneDriveLocation and OneDriveLocationException +- ModernGroupLocation and ModernGroupLocationException + +A tag that uses a cloud attachment policy to create a rule can be a record label or a regulatory label. You can't use a publishing tag for a cloud attachment policy to create a rule; only apply tags are supported. + +The RetainCloudAttachment parameter is not available on the Set-RetentionCompliancePolicy cmdlet. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocationException +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipPriorityCleanupConfirmation +{{ Fill SkipPriorityCleanupConfirmation Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkypeLocation +The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy. + +You can use any value that uniquely identifies the user. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkypeLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelLocation +The TeamsChannelLocation parameter specifies the Teams to include in the policy. + +You can use any value that uniquely identifies the team. For example: + +- Name +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelLocationException +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 +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChatLocation +The TeamsChatLocation parameter specifies the Teams users to include in the policy. + +You can use any value that uniquely identifies the user. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChatLocationException +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 +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +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-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md new file mode 100644 index 0000000000..c7471abe72 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md @@ -0,0 +1,437 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-RetentionComplianceRule + +## 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-RetentionComplianceRule cmdlet to create new retention rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ComplianceTag +``` +New-RetentionComplianceRule -ApplyComplianceTag -Policy + [-ContentContainsSensitiveInformation ] + [-Confirm] + [-ContentMatchQuery ] + [-ExpirationDateOption ] + [-IRMRiskyUserProfiles ] + [-MachineLearningModelIDs ] + [-PriorityCleanup] + [-RetentionComplianceAction ] + [-WhatIf] + [] +``` + +### Default +``` +New-RetentionComplianceRule [-Name] -Policy + [-Comment ] + [-ExcludedItemClasses ] + [-RetentionDuration ] + [-RetentionDurationDisplayHint ] + [-Confirm] + [-ContentMatchQuery ] + [-ExpirationDateOption ] + [-PriorityCleanup] + [-RetentionComplianceAction ] + [-WhatIf] + [] +``` + +### PublishComplianceTag +``` +New-RetentionComplianceRule -Policy -PublishComplianceTag + [-Confirm] + [-ExpirationDateOption ] + [-PriorityCleanup] + [-RetentionComplianceAction ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The retention rule must be added to an existing retention policy using the Policy parameter. Only one rule can be added to each retention 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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +### 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. + +## PARAMETERS + +### -Name +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. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyComplianceTag +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. + +You can't use this parameter with the Name or PublishComplianceTag parameters. + +You can't use this parameter for Teams retention rules. + +```yaml +Type: String +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter specifies the policy to contain the rule. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishComplianceTag +The PublishComplianceTag parameter specifies the label that's published for the rule, which makes the label visible to users in apps (for example, Outlook, SharePoint, and OneDrive). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. + +You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. + +You can't use this parameter in the following scenarios: + +- With the Name or ApplyComplianceTag parameters. +- For Teams retention rules. +- With cloud attachment policies. + +```yaml +Type: String +Parameter Sets: PublishComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +You can use this parameter with the ApplyComplianceTag parameter. + +You can't use this parameter for Teams retention rules. + +```yaml +Type: PswsHashtable[] +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +You can't use this parameter for Teams retention rules. + +```yaml +Type: String +Parameter Sets: ComplianceTag, Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedItemClasses +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +- IPM.Note.Microsoft.Conversation +- IPM.Note.Microsoft.Conversation.Voice +- IPM.Note.Microsoft.Missed +- IPM.Note.Microsoft.Missed.Voice +- IPM.Note.Microsoft.Voicemail +- IPM.Note.Microsoft.VoiceMessage.UA +- IPM.Note.Microsoft.Voicemail.UM +- IPM.Note.Microsoft.Voicemail.UM.CA + +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. + +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use this parameter for Teams retention rules. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateOption +The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: + +- CreationAgeInDays +- ModificationAgeInDays + +You can't use this parameter for Teams retention rules. + +```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 +``` + +### -IRMRiskyUserProfiles +{{ Fill IRMRiskyUserProfiles Description }} + +```yaml +Type: String +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineLearningModelIDs +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionComplianceAction +The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +If you don't use this parameter, the retention policy is created as an "UniH" policy instead of a "mbx" policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDurationDisplayHint +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are: + +- Days +- Months +- 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. + +You can't use this parameter for Teams retention rules. + +```yaml +Type: HoldDurationHint +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicy.md b/exchange/exchange-ps/exchange/New-RetentionPolicy.md new file mode 100644 index 0000000000..a6a970985e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-RetentionPolicy.md @@ -0,0 +1,223 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-RetentionPolicy cmdlet to create a retention policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-RetentionPolicy [-Name] + [-Confirm] + [-DomainController ] + [-IsDefault] + [-IsDefaultArbitrationMailbox] + [-RetentionId ] + [-RetentionPolicyTagLinks ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-RetentionPolicy "Business General" +``` + +This example creates the retention policy Business General without associating any retention policy tags. + +### Example 2 +```powershell +New-RetentionPolicy "Business General" -RetentionPolicyTagLinks "General Business","Legal" +``` + +This example creates the retention policy Business General and uses the RetentionPolicyTagLinks parameter to associate two retention policy tags with this policy. You can enter multiple retention policy tags, separated by commas. If a tag name includes a space, enclose the name in quotation marks. + +The second retention tag, which is named Legal, is also enclosed in quotation marks for consistency. Values that don't include a space can be enclosed in quotation marks without any change to how the command is interpreted. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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. + +**Note**: Changing which retention policy is the default might or might not affect new and existing mailboxes based on the value of the RetentionPolicy parameter on all mailbox plans: + +- $null (blank): Changes to which retention policy is the default are continually reflected in new and existing mailboxes. +- A retention policy is specified: The value of the RetentionPolicy parameter for all mailbox plans should be $null (blank) or match the Exchange retention policy that's configured as default policy for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. For more information see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). + +If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. + +Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefaultArbitrationMailbox +This parameter is available only in the cloud-based service. + +The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyTagLinks +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/policy-and-compliance-retention/New-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md similarity index 82% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionPolicyTag.md rename to exchange/exchange-ps/exchange/New-RetentionPolicyTag.md index bea0381e36..a320464cfa 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-RetentionPolicyTag @@ -13,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-RetentionPolicyTag cmdlet to create a retention tag. -For more information about retention tags, see Retention tags and retention policies (https://technet.microsoft.com/library/dd297955.aspx). +For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,29 +26,32 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` New-RetentionPolicyTag [-Name] [-AddressForJournaling ] - [-AgeLimitForRetention ] + [-AgeLimitForRetention ] [-Comment ] - [-Confirm] [-DomainController ] + [-Confirm] + [-DomainController ] [-IsDefaultAutoGroupPolicyTag] [-IsDefaultModeratedRecipientsPolicyTag] [-JournalingEnabled ] - [-LabelForJournaling ] + [-LabelForJournaling ] [-LocalizedComment ] [-LocalizedRetentionPolicyTagName ] [-MessageClass ] [-MessageFormatForJournaling ] - [-MustDisplayCommentEnabled <$true | $false>] - [-RetentionAction ] - [-RetentionEnabled <$true | $false>] + [-MustDisplayCommentEnabled ] + [-RetentionAction ] + [-RetentionEnabled ] [-RetentionId ] - [-SystemTag <$true | $false>] - [-Type ] - [-WhatIf] [] + [-SystemTag ] + [-Type ] + [-WhatIf] + [] ``` ### UpgradeManagedFolder ``` -New-RetentionPolicyTag [-Name] [-ManagedFolderToUpgrade ] +New-RetentionPolicyTag [-Name] + [-ManagedFolderToUpgrade ] [-Comment ] [-Confirm] [-DomainController ] @@ -53,10 +59,11 @@ New-RetentionPolicyTag [-Name] [-ManagedFolderToUpgrade ] [-LocalizedRetentionPolicyTagName ] - [-MustDisplayCommentEnabled <$true | $false>] - [-SystemTag <$true | $false>] - [-Type ] - [-WhatIf] [] + [-MustDisplayCommentEnabled ] + [-SystemTag ] + [-Type ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -64,26 +71,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete ``` This example creates the retention policy tag Finance-DeletedItems for the Deleted Items default folder. When applied to a mailbox as a part of a retention policy, the tag permanently deletes items of all types in the Deleted Items folder in 30 days. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell 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. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete ``` @@ -99,6 +106,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -107,15 +115,16 @@ Accept wildcard characters: False ``` ### -AddressForJournaling -This parameter is available or funcational only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -131,6 +140,7 @@ 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 Default value: None @@ -146,6 +156,7 @@ 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 Default value: None @@ -156,8 +167,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -165,6 +175,7 @@ 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 Default value: None @@ -182,6 +193,7 @@ 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 @@ -190,13 +202,16 @@ Accept wildcard characters: False ``` ### -IsDefaultAutoGroupPolicyTag +This parameter is available only in the cloud-based service. + 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 +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -205,13 +220,16 @@ Accept wildcard characters: False ``` ### -IsDefaultModeratedRecipientsPolicyTag +This parameter is available only in the cloud-based service. + 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 +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -220,15 +238,16 @@ Accept wildcard characters: False ``` ### -JournalingEnabled -This parameter is available or funcational only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: Boolean Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -237,7 +256,7 @@ Accept wildcard characters: False ``` ### -LabelForJournaling -This parameter is available or funcational only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -246,6 +265,7 @@ Type: String Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -261,6 +281,7 @@ 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 Default value: None @@ -276,6 +297,7 @@ 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 Default value: None @@ -293,6 +315,7 @@ Type: ELCFolderIdParameter Parameter Sets: UpgradeManagedFolder Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -314,6 +337,7 @@ 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 Default value: None @@ -321,9 +345,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -MessageFormatForJournaling -This parameter is available or functional only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -332,6 +355,7 @@ Type: JournalingFormat Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -343,10 +367,11 @@ Accept wildcard characters: False The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -358,11 +383,8 @@ Accept wildcard characters: False 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. 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). @@ -370,10 +392,11 @@ The MoveToDeletedItems and MoveToFolder actions are available, but don't work. T If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml -Type: MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit | MoveToArchive +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 Default value: None @@ -384,15 +407,16 @@ Accept wildcard characters: False ### -RetentionEnabled 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. +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 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_`. ```yaml -Type: $true | $false +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 Default value: None @@ -408,6 +432,7 @@ 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 Default value: None @@ -419,10 +444,11 @@ Accept wildcard characters: False The SystemTag parameter specifies that the tag is created for internal Exchange functionality. ```yaml -Type: $true | $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 Default value: None @@ -434,54 +460,35 @@ Accept wildcard characters: False The Type parameter specifies the type of retention tag being created. Valid values include: - All - - Archive - - Calendar - - Clutter: Available in Exchange Online only. - - Contacts - - ConversationHistory - - DeletedItems - - Drafts - - Inbox - - Journal - - JunkEmail - - LegacyArchiveJournals - - ManagedCustomFolder - - Notes - - Outbox - - Personal - - RecoverableItems - - RssSubscriptions - - SentItems - - SyncIssues - - Tasks To create a default policy tag (DPT), specify type All. For tags of type RecoverableItems, the only valid retention action is MoveToArchive. ```yaml -Type: Calendar | Contacts | DeletedItems | Drafts | Inbox | JunkEmail | Journal | Notes | Outbox | SentItems | Tasks | All | ManagedCustomFolder | RssSubscriptions | SyncIssues | ConversationHistory | Personal | RecoverableItems +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 Default value: None @@ -497,6 +504,7 @@ 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 Default value: None @@ -505,20 +513,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3f047d2e-1171-4f53-9b7e-e1625c954325.aspx) diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md new file mode 100644 index 0000000000..37d991b855 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md @@ -0,0 +1,216 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-RoleAssignmentPolicy cmdlet to create management role assignment policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-RoleAssignmentPolicy [-Name] + [-Confirm] + [-Description ] + [-DomainController ] + [-IsDefault] + [-Roles ] + [-WhatIf] + [] +``` + +## 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). + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-RoleAssignmentPolicy -Name "End User Policy" + +Set-Mailbox -Identity Joe -RoleAssignmentPolicy "End User Policy" +``` + +This example creates an assignment policy. After the assignment policy is created, you can assign the assignment policy to a mailbox using the Set-Mailbox cmdlet. + +### Example 2 +```powershell +New-RoleAssignmentPolicy -Name "Default End User Policy" -IsDefault +``` + +This example creates an assignment policy using the IsDefault switch. + +### Example 3 +```powershell +New-RoleAssignmentPolicy -Name "Limited End User Policy" -Roles "MyPersonalInformation", "MyDistributionGroupMembership", "MyVoiceMail" -IsDefault + +Get-Mailbox -ResultSize Unlimited | Set-Mailbox -RoleAssignmentPolicy "Limited End User Policy" +``` + +This example creates an assignment policy that enables users to modify their personal information, manage their distribution group membership, and manage their voice mail. The new assignment policy is created as the new default assignment policy. Then, all existing mailboxes are configured to use the new assignment policy. + +First, the new assignment policy is created and set as the new default assignment policy. + +Because setting the new role assignment as default applies only to new mailboxes or mailboxes moved from previous versions of Exchange, the Set-Mailbox cmdlet is used to configure the new assignment policy on all existing mailboxes. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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. + +Setting an assignment policy as default doesn't change the role assignment on existing mailboxes. To change the assignment policies on existing mailboxes, use the Set-Mailbox cmdlet. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Roles +The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. + +For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). + +```yaml +Type: RoleIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-RoleGroup.md b/exchange/exchange-ps/exchange/New-RoleGroup.md new file mode 100644 index 0000000000..308719a319 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-RoleGroup.md @@ -0,0 +1,495 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-RoleGroup cmdlet to create management role groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### CrossForest +``` +New-RoleGroup [-Name] -LinkedDomainController -LinkedForeignGroup + [-LinkedCredential ] + [-Confirm] + [-CustomConfigWriteScope ] + [-CustomRecipientWriteScope ] + [-Description ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-ManagedBy ] + [-Members ] + [-RecipientOrganizationalUnitScope ] + [-Roles ] + [-SamAccountName ] + [-WellKnownObject ] + [-WhatIf] + [] +``` + +### Default +``` +New-RoleGroup [-Name] + [-Confirm] + [-CustomConfigWriteScope ] + [-CustomRecipientWriteScope ] + [-Description ] + [-DisplayName ] + [-DomainController ] + [-Force] + [-Id ] + [-ManagedBy ] + [-Members ] + [-RecipientOrganizationalUnitScope ] + [-Roles ] + [-SamAccountName ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You don't have to add members or assign management roles to the role group when you create it. However, until you add members or assign roles to the role group, the role group grants no permissions to users. You can also specify custom configuration or recipient scopes when you create a role group. These scopes are applied to the management role assignments created when the role group is created. + +When you create a role group, you can create the group and add members to it directly, or you can create a linked role group. A linked role group links the role group to a universal security group (USG) in another forest. Creating a linked role group is useful if your servers running Exchange reside in a resource forest and your users and administrators reside in a separate user forest. If you create a linked role group, you can't add members directly to it. You must add the members to the USG in the foreign forest. + +For more information about role groups, see [Understanding management role groups](https://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). + +## EXAMPLES + +### Example 1 +```powershell +New-RoleGroup -Name "Limited Recipient Management" -Roles "Mail Recipients", "Mail Enabled Public Folders" -Members Kim, Martin +``` + +This example creates a role group. The Mail Recipients and Mail Enabled Public Folders roles are assigned to the role group, and the users Kim and Martin are added as members. Because no scopes were provided, Kim and Martin can manage any recipient and reset passwords for any users in the organization. + +### Example 2 +```powershell +New-RoleGroup -Name "Seattle Limited Recipient Management" -Roles "Mail Recipients", "Mail Enabled Public Folders" -Members John, Carol -CustomRecipientWriteScope "Seattle Recipients" +``` + +This example creates a role group with a custom recipient scope. The custom recipient scope, Seattle Recipients, limits the scope of the roles assigned to the role group to recipients who have their City property set to Seattle. The Mail Recipients and Mail Enabled Public Folders roles are assigned to the role group, and the users John and Carol are added as members. + +### Example 3 +```powershell +New-RoleGroup -Name "Transport Rules Management" -Roles "Transport Rules" -Members "Compliance Group" -ManagedBy Isabel +``` + +This example creates a role group and enables Isabel to add or remove members to or from the role group by adding her to the ManagedBy property. The Transport Rules role is assigned to the role group, and the Compliance Group USG is added as a member. + +### Example 4 +```powershell +$Credentials = Get-Credential + +New-RoleGroup -Name "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Administrators" -CustomRecipientWriteScope "Toronto Recipients" -Roles "Mail Recipients" +``` + +This example creates a linked role group that enables the members of the Toronto Administrators USG in the Contoso user forest to manage recipients located in the Toronto office. The custom recipient scope, Toronto Recipients, limits the scope of the roles assigned to the role group to recipients who have their City property set to Toronto. The Mail Recipients role is assigned to the role group. + +The first command retrieves the credentials using the Get-Credential cmdlet and stores them in the $Credentials variable. Then the linked role group is created using the second command. + +### Example 5 +```powershell +$RoleGroup = Get-RoleGroup "Recipient Management" + +New-RoleGroup "Limited Recipient Management" -Roles $RoleGroup.Roles +``` + +This example takes an existing role group and copies the roles from that role group into a new custom role group. This can be useful if you want to create a role group similar to an existing role group but don't want to manually create all the role assignments. For example, you might want to create a role group that has most, but not all, of the management roles assigned to the Recipient Management role group. + +The first command stores the existing role group in a variable, and the second command creates the custom role group. + +This example uses variables to store information. For more information about variables, see [About Variables](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_variables). + +### Example 6 +```powershell +Remove-ManagementRoleAssignment "Distribution Groups-Limited Recipient Management" +``` + +This example removes the role assignment between the Distribution Groups management role and the Limited Recipient Management role group that you created in the previous example. + +## PARAMETERS + +### -Name +The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). + +**Note**: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedDomainController +This parameter is available only in on-premises Exchange. + +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. + +If you use the LinkedDomainController parameter, you must specify a foreign USG with the LinkedForeignGroup parameter and you can't use the Members parameter. + +```yaml +Type: String +Parameter Sets: CrossForest +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedForeignGroup +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 ("). + +If you use the LinkedForeignGroup parameter, you must specify a domain controller in the LinkedDomainController parameter and you can't use the Members parameter. + +```yaml +Type: UniversalSecurityGroupIdParameter +Parameter Sets: CrossForest +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomConfigWriteScope +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. + +```yaml +Type: ManagementScopeIdParameter +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 +``` + +### -CustomRecipientWriteScope +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. + +If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope parameter. + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +This parameter is available only in Security & Compliance PowerShell. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedCredential +This parameter is available only in on-premises Exchange. + +The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: CrossForest +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 +``` + +### -ManagedBy +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 ("). + +If you want to add more than one user or USG, separate them using commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Members +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. + +```yaml +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientOrganizationalUnitScope +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 ("). + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -Roles +The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. + +For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). + +```yaml +Type: RoleIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +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 +``` + +### -WellKnownObject +This parameter is available only in the cloud-based service. + +{{ Fill WellKnownObject Description }} + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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: 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/New-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md similarity index 83% rename from exchange/exchange-ps/exchange/mail-flow/New-RoutingGroupConnector.md rename to exchange/exchange-ps/exchange/New-RoutingGroupConnector.md index 783e801c00..4fd4b16fbf 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-RoutingGroupConnector @@ -13,14 +16,19 @@ This cmdlet is available only in Exchange Server 2010. Use the New-RoutingGroupConnector cmdlet to establish a connection between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group when the organization is running more than one version of Exchange. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RoutingGroupConnector [-Name] -SourceTransportServers - -TargetTransportServers [-BiDirectional <$true | $false>] [-Confirm] [-Cost ] - [-DomainController ] [-PublicFolderReferralsEnabled <$true | $false>] [-WhatIf] [] +New-RoutingGroupConnector [-Name] -SourceTransportServers -TargetTransportServers + [-BiDirectional ] + [-Confirm] + [-Cost ] + [-DomainController ] + [-PublicFolderReferralsEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -28,23 +36,20 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-RoutingGroupConnector -Name "Interop RGC" -SourceTransportServers "Hub2010.contoso.com" -TargetTransportServers "Bridgehead2003.contoso.com" -Cost 100 -Bidirectional $true ``` This example creates the routing group connector Interop RGC with the following properties: - The Exchange 2010 server is Hub2010.contoso.com. - -- The Exchange 2003 bridgehead server is Bridghead2003.contoso.com. - +- The Exchange 2003 bridgehead server is Bridgehead2003.contoso.com. - The routing group connector is a two-way connector between the Exchange 2010 routing group and the routing group associated with the specified Exchange 2003 server. - - The cost is 100. ## PARAMETERS @@ -57,6 +62,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -72,6 +78,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -87,6 +94,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -98,10 +106,11 @@ Accept wildcard characters: False The BiDirectional parameter specifies whether this is a one-way or two-way connector. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -112,8 +121,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -121,6 +129,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -136,6 +145,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -151,6 +161,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -162,10 +173,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -181,6 +193,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -189,20 +202,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6297510c-7022-4702-83e6-a213a93d46e1.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-RpcClientAccess.md b/exchange/exchange-ps/exchange/New-RpcClientAccess.md similarity index 76% rename from exchange/exchange-ps/exchange/client-access-servers/New-RpcClientAccess.md rename to exchange/exchange-ps/exchange/New-RpcClientAccess.md index 09a882830b..183a022952 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/New-RpcClientAccess.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-RpcClientAccess @@ -11,27 +14,32 @@ monikerRange: "exchserver-ps-2010" ## SYNOPSIS This cmdlet is available only in Exchange Server 2010. -Use the New-RpcClientAccess cmdlet to create configuration information for the Exchange RPC Client Access service on a Client Access server. This setup task is performed by default on new installations of the Client Access server role on Microsoft Exchange Server 2010. +Use the New-RpcClientAccess cmdlet to create configuration information for the Exchange RPC Client Access service on a Client Access server. This set up task is performed by default on new installations of the Client Access server role on Microsoft Exchange Server 2010. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RpcClientAccess -Server [-BlockedClientVersions ] [-Confirm] - [-DomainController ] [-EncryptionRequired <$true | $false>] [-MaximumConnections ] [-WhatIf] +New-RpcClientAccess -Server + [-BlockedClientVersions ] + [-Confirm] + [-DomainController ] + [-EncryptionRequired ] + [-MaximumConnections ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-RpcClientAccess -Server CAS01 ``` @@ -40,13 +48,19 @@ This example creates configuration information for the Exchange RPC Client Acces ## PARAMETERS ### -Server -The Server parameter specifies the Client Access server. +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -64,6 +78,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -74,8 +89,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -83,6 +97,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -98,6 +113,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -109,10 +125,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -132,6 +149,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -147,6 +165,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -155,20 +174,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c235645b-3361-404d-bf0d-3d8920aeb4e4.aspx) diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md new file mode 100644 index 0000000000..7bd53126c9 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -0,0 +1,281 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SafeAttachmentPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-SafeAttachmentPolicy cmdlet to create safe attachment policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SafeAttachmentPolicy [-Name] + [-Action ] + [-AdminDisplayName ] + [-Confirm] + [-Enable ] + [-MakeBuiltInProtection] + [-QuarantineTag ] + [-RecommendedPolicyType ] + [-Redirect ] + [-RedirectAddress ] + [-WhatIf] + [] +``` + +## 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). + +New safe attachment policies that you create using this cmdlet aren't applied to users and aren't visible in the Microsoft Defender portal. You need to use the SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets to associate the policy with a rule to create a complete Safe Attachments policy that's visible in the Defender portal. + +A safe attachment policy can be assigned to only one safe attachment rule. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SafeAttachmentPolicy -Name "Marketing Block Attachments" -Enable $true -Redirect $true -RedirectAddress admin@contoso.com +``` + +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. +- 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 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action +The Action parameter specifies the action for the safe attachment policy. Valid values are: + +- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the Microsoft Defender portal. +- Block: Block the email message that contains the malware attachment. This is the default value. +- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [Dynamic Delivery in Safe Attachments policies](https://learn.microsoft.com/defender-office-365/safe-attachments-about#dynamic-delivery-in-safe-attachments-policies). + +The value of this parameter is meaningful only when the value of the Enable parameter is $true (the default value is $false). + +To specify no action for the safe attachment policy (corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the Defender portal), use the value $false for the Enable parameter. + +The results of all actions are available in message trace. + +```yaml +Type: SafeAttachmentAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +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. + +To enable or disable a complete Safe Attachments policy in the Microsoft Defender portal (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeBuiltInProtection +The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTag +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware by Safe Attachments as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Redirect +The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: + +- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is meaningful only when the value of the Action parameter is Allow. +- $false: Messages that contain malware attachments aren't delivered to another email address. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectAddress +The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. + +The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md new file mode 100644 index 0000000000..373513e1c0 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md @@ -0,0 +1,347 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SafeAttachmentRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-SafeAttachmentRule cmdlet to create safe attachment rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SafeAttachmentRule [-Name] -SafeAttachmentPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to specify at least one condition for the rule. + +A safe attachment policy can be assigned only to one safe attachment rule. + +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Safe Attachments policy settings](https://learn.microsoft.com/defender-office-365/safe-attachments-about#safe-attachments-policy-settings). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SafeAttachmentRule -Name "Research Department Attachment Rule" -SafeAttachmentPolicy "Research Block Attachments" -SentToMemberOf "Research Department" -ExceptIfSentToMemberOf "Research Department Managers" +``` + +This example creates a new safe attachment rule named Research Department Attachment Rule with the following conditions: + +- The rule is associated with the safe attachment policy named Research Block Attachments. +- The rule applies to members of the group named Research Department. +- The rule doesn't apply to members of the group named Research Department Managers. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeAttachmentPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't specify a safe attachment policy that's already associated with another safe attachment rule. + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. This is the default value. +- $false: The rule is disabled. + +In the properties of the rule, the value of this parameter is visible in the State property. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md new file mode 100644 index 0000000000..07d98d9dab --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -0,0 +1,429 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SafeLinksPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-SafeLinksPolicy cmdlet to create Safe Links policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SafeLinksPolicy [-Name] + [-AdminDisplayName ] + [-AllowClickThrough ] + [-Confirm] + [-CustomNotificationText ] + [-DeliverMessageAfterScan ] + [-DisableUrlRewrite ] + [-DoNotRewriteUrls ] + [-EnableForInternalSenders ] + [-EnableOrganizationBranding ] + [-EnableSafeLinksForEmail ] + [-EnableSafeLinksForOffice ] + [-EnableSafeLinksForTeams ] + [-MakeBuiltInProtection] + [-RecommendedPolicyType ] + [-ScanUrls ] + [-TrackClicks ] + [-UseTranslatedNotificationText ] + [-WhatIf] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-SafeLinksPolicy -Name "Marketing Block URL" -EnableSafeLinksForEmail $true -AllowClickThrough $false +``` + +This example creates a new Safe Links policy named Marketing Block URL with the following options: + +- The policy is enabled. +- Users aren't allowed to click through to the original URL. +- User clicks on URLs are tracked. This is the default value of the TrackClicks parameter, so you don't need to specify it. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowClickThrough +The AllowClickThrough parameter specifies whether users are allowed to click through to the original URL on warning pages. Valid values are: + +- $true: The user is allowed to click through to the original URL. +- $false: The user isn't allowed to click through to the original URL. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomNotificationText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliverMessageAfterScan +The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: + +- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. This is the default value. +- $false: If Safe Links scanning can't complete, deliver the message anyway. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableUrlRewrite +The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: + +- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). +- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotRewriteUrls +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://learn.microsoft.com/defender-office-365/safe-links-about#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableForInternalSenders +The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: + +- $true: The policy is applied to internal and external senders. This is the default value. +- $false: The policy is applied only to external senders. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: + +- $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeLinksForEmail +The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: + +- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for email. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeLinksForOffice +The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: + +- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Office apps. + +Note that this protection applies to links in Office documents, not links in email messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeLinksForTeams +The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: + +- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Teams. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeBuiltInProtection +The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanUrls +The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: + +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $false: Real-time scanning of clicked links, including links that point to files, is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrackClicks +The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: + +- $true: User clicks messages are tracked. This is the default value. +- $false: User clicks messages aren't tracked. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseTranslatedNotificationText +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/exchange/New-SafeLinksRule.md new file mode 100644 index 0000000000..33a08f67c7 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SafeLinksRule.md @@ -0,0 +1,370 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SafeLinksRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SafeLinksRule [-Name] -SafeLinksPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to specify at least one condition for the rule. + +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Recipient filters in Safe Links policies](https://learn.microsoft.com/defender-office-365/safe-links-about#recipient-filters-in-safe-links-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SafeLinksRule -Name "Research Department URL Rule" -SafeLinksPolicy "Research Block URL" -SentToMemberOf "Research Department" -ExceptIfSentToMemberOf "Research Department Managers" +``` + +This example creates a new Safe Links rule named Research Department URL Rule with the following conditions: + +- The rule is associated with the Safe Links policy named Research Block URL. +- The rule applies to members of the group named Research Department. +- Because we aren't using the Priority parameter, the default priority is used. +- The rule doesn't apply to members of the group named Research Department Managers. +- The rule is enabled (we aren't using the Enabled parameter, and the default value is `$true`). + +### Example 2 +```powershell +New-SafeLinksRule -Name "Contoso All" -SafeLinksPolicy "Contoso All" -RecipientDomainIs (Get-AcceptedDomain).Name +``` + +This example creates a Safe Links rule named Contoso All with the following conditions: + +- The rule is associated with the Safe Links policy named Contoso All. +- The rule applies to recipients in all accepted domains in the organization. +- Because we aren't using the Priority parameter, the default priority is used. +- The rule is enabled (we aren't using the Enabled parameter, and the default value is `$true`). + +### Example 3 +```powershell +$Data = Import-Csv -Path "C:\Data\SafeLinksDomains.csv" + +$SLDomains = $Data.Domains + +New-SafeLinksRule -Name "Contoso All" -SafeLinksPolicy "Contoso All" -RecipientDomainIs $SLDomains +``` + +This example is similar to Example 2, but in this example, the rule applies to recipients in the domains specified in a .csv file. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeLinksPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't specify a Safe Links policy that's already associated with another Safe Links rule. + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. This is the default value. +- $false: The rule is disabled. + +In the properties of the rule, the value of this parameter is visible in the State property. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md similarity index 82% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md rename to exchange/exchange-ps/exchange/New-SearchDocumentFormat.md index 5782251c9e..2f54d72235 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-SearchDocumentFormat @@ -13,25 +16,28 @@ This cmdlet is available only in on-premises Exchange. Use the New-SearchDocumentFormat cmdlet to add a format-specific filter to those used by Exchange search. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SearchDocumentFormat [-Identity] -Extension -MimeType - -Name [-Confirm] [-Enabled <$true | $false>] [-Server ] [-WhatIf] +New-SearchDocumentFormat [-Identity] -Extension -MimeType -Name + [-Confirm] + [-Enabled ] + [-Server ] + [-WhatIf] [] ``` ## DESCRIPTION After running the New-SearchDocumentFormat cmdlet, your must run the following cmdlet to restart the search service. There will be a brief search outage. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-SearchDocumentFormat -Name "Proprietary SCT Formats" -MimeType text/scriptlet -Extension .sct -Identity ProprietarySCT1 ``` @@ -39,33 +45,35 @@ This example creates a new search document format with an extension of .sct and ## PARAMETERS -### -Extension -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. +### -Identity +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: String +Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -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. +### -Extension +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: SearchDocumentFormatId +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -77,6 +85,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -92,6 +101,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -102,8 +112,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -111,6 +120,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,10 +134,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -139,11 +150,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -153,6 +161,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -168,6 +177,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -176,20 +186,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0a00f1e7-15d2-4a3e-a6a6-0d1f8661ebcb.aspx) diff --git a/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md new file mode 100644 index 0000000000..e24f5206c9 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md @@ -0,0 +1,195 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SecOpsOverridePolicy + +## 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). + +For 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-SecOpsOverridePolicy [-Name] -SentTo + [-Comment ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SecOpsOverridePolicy -Name SecOpsOverridePolicy -SentTo secops@contoso.com +``` + +This example creates the SecOps mailbox override policy with the specified settings. + +## 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies the email address of the SecOps mailbox. Groups are not allowed. + +You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/New-SendConnector.md b/exchange/exchange-ps/exchange/New-SendConnector.md similarity index 76% rename from exchange/exchange-ps/exchange/mail-flow/New-SendConnector.md rename to exchange/exchange-ps/exchange/New-SendConnector.md index 1f7b4e6b20..bb0b4fa218 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-SendConnector.md +++ b/exchange/exchange-ps/exchange/New-SendConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-SendConnector @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-SendConnector cmdlet to create a new Send connector. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,113 +24,115 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` New-SendConnector -Name -AddressSpaces [-AuthenticationCredential ] - [-CloudServicesMailEnabled <$true | $false>] + [-CloudServicesMailEnabled ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeOut ] - [-ConnectorType ] + [-ConnectorType ] [-Custom] - [-DNSRoutingEnabled <$true | $false>] + [-DNSRoutingEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-Enabled <$true | $false>] - [-ErrorPolicies ] + [-DomainSecureEnabled ] + [-Enabled ] + [-ErrorPolicies ] [-Force] - [-ForceHELO <$true | $false>] + [-ForceHELO ] [-Fqdn ] - [-FrontendProxyEnabled <$true | $false>] - [-IgnoreSTARTTLS <$true | $false>] + [-FrontendProxyEnabled ] + [-IgnoreSTARTTLS ] [-Internal] [-Internet] - [-IsCoexistenceConnector <$true | $false>] - [-IsScopedConnector <$true | $false>] + [-IsCoexistenceConnector ] + [-IsScopedConnector ] [-MaxMessageSize ] [-Partner] [-Port ] - [-ProtocolLoggingLevel ] - [-RequireOorg <$true | $false>] - [-RequireTLS <$true | $false>] - [-SmartHostAuthMechanism ] + [-ProtocolLoggingLevel ] + [-RequireOorg ] + [-RequireTLS ] + [-SmartHostAuthMechanism ] [-SmartHosts ] [-SmtpMaxMessagesPerConnection ] [-SourceIPAddress ] [-SourceTransportServers ] - [-TlsAuthLevel ] + [-TlsAuthLevel ] [-TlsCertificateName ] [-TlsDomain ] - [-Usage ] - [-UseExternalDNSServersEnabled <$true | $false>] - [-WhatIf] [] + [-Usage ] + [-UseExternalDNSServersEnabled ] + [-WhatIf] + [] ``` ### LinkedReceiveConnector ``` -New-SendConnector [-Name] [-LinkedReceiveConnector ] +New-SendConnector [-Name] + [-LinkedReceiveConnector ] [-AuthenticationCredential ] [-Comment ] [-Confirm] [-ConnectionInactivityTimeOut ] [-Custom] - [-DNSRoutingEnabled <$true | $false>] + [-DNSRoutingEnabled ] [-DomainController ] - [-DomainSecureEnabled <$true | $false>] - [-Enabled <$true | $false>] - [-ErrorPolicies ] + [-DomainSecureEnabled ] + [-Enabled ] + [-ErrorPolicies ] [-Force] - [-ForceHELO <$true | $false>] + [-ForceHELO ] [-Fqdn ] - [-IgnoreSTARTTLS <$true | $false>] + [-IgnoreSTARTTLS ] [-Internal] [-Internet] - [-IsCoexistenceConnector <$true | $false>] + [-IsCoexistenceConnector ] [-MaxMessageSize ] [-Partner] [-Port ] - [-ProtocolLoggingLevel ] - [-RequireOorg <$true | $false>] - [-RequireTLS <$true | $false>] - [-SmartHostAuthMechanism ] + [-ProtocolLoggingLevel ] + [-RequireOorg ] + [-RequireTLS ] + [-SmartHostAuthMechanism ] [-SmartHosts ] [-SmtpMaxMessagesPerConnection ] [-SourceIPAddress ] [-SourceTransportServers ] - [-TlsAuthLevel ] + [-TlsAuthLevel ] [-TlsDomain ] - [-Usage ] - [-UseExternalDNSServersEnabled <$true | $false>] - [-WhatIf] [] + [-Usage ] + [-UseExternalDNSServersEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-SendConnector -Internet -Name MySendConnector -AddressSpaces contoso.com,fabrikam.com ``` This example creates the Send connector named MySendConnector with the following properties: - It sends email messages over the Internet. - - It processes messages addressed only to Contoso.com and Fabrikam.com domains. -### -------------------------- Example 2 -------------------------- -``` -$CredentialObject = Get-Credential; New-SendConnector -Name "Secure Email to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth +### Example 2 +```powershell +$CredentialObject = Get-Credential + +New-SendConnector -Name "Secure Email to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth ``` This example creates the Send connector Secure Email to Contoso.com with the following properties: - It processes messages only for the Contoso.com domain. - - It uses Basic authentication. - - It uses a specific authentication credential. -To assign a specific authentication credential for the Send connector, you must first run the Get-Credential command and store the user input in a temporary variable. When you run the Get-Credential command, the command asks for the user name and password of the account used during authentication with the Contoso.com email server. The temporary variable can then be used in the New-SendConnector cmdlet to create the new connector. +To assign a specific authentication credential for the Send connector, you must first run the Get-Credential command and store the user input in a temporary variable. When you run the Get-Credential command, the command asks for the username and password of the account used during authentication with the Contoso.com email server. The temporary variable can then be used in the New-SendConnector cmdlet to create the new connector. ## PARAMETERS @@ -139,6 +144,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -147,22 +153,17 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is as follows: \:\;\ +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. - - 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. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("). For example, the following address space entries are equivalent: - "SMTP:contoso.com;1" - - "contoso.com;1" - - "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". @@ -170,16 +171,16 @@ You may specify multiple address spaces by separating the address spaces with co 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://technet.microsoft.com/library/aa996779.aspx). +Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). ```yaml Type: MultiValuedProperty Parameter Sets: AddressSpaces Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -188,15 +189,16 @@ Accept wildcard characters: False ``` ### -AuthenticationCredential -The AuthenticationCredential parameter specifies a credential object. +The AuthenticationCredential parameter specifies the username and password that's required to use the connector. -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -205,21 +207,21 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx). +**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 Office 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. +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. - - $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: $true | $false +Type: Boolean Parameter Sets: AddressSpaces Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -235,6 +237,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -245,8 +248,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -254,6 +256,7 @@ 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 @@ -273,6 +276,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -281,17 +285,17 @@ Accept wildcard characters: False ``` ### -ConnectorType -The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Office 365. Valid values are: - -- Default: The connector isn't used to send messages to Office 365. This is the default value. +The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Microsoft 365. Valid values are: -- XPremises: The connector is used to send messages to Office 365. +- Default: The connector isn't used to send messages to Microsoft 365. This is the default value. +- XPremises: The connector is used to send messages to Microsoft 365. ```yaml -Type: Default | XPremises +Type: TenantConnectorType Parameter Sets: AddressSpaces Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -300,23 +304,23 @@ Accept wildcard characters: False ``` ### -Custom -The Custom parameter specifies the Custom usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom parameter, you can't use any of the following parameters: +The Custom switch specifies the Custom usage type. You don't need to specify a value with this switch. -- Internal +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom switch, you can't use any of the following parameters: +- Internal - Internet - - Partner - - Usage -For more information about Send connector usage types, permissions, and authentication methods, see Send connectors (https://technet.microsoft.com/library/aa998662.aspx). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -328,10 +332,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -349,6 +354,7 @@ 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 @@ -360,9 +366,7 @@ Accept wildcard characters: False 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. - - DNSRoutingEnabled is set to $true. - - IgnoreSTARTTLS is set to $false. The wildcard character (\*) isn't supported in domains configured for mutual TLS authentication. The same domain must also be defined on the corresponding Receive connector, and in the value of the TLSReceiveDomainSecureList attribute of the transport configuration. @@ -370,16 +374,16 @@ The wildcard character (\*) isn't supported in domains configured for mutual TLS The default value for the DomainSecureEnabled parameter is $false for the following types of Send connectors: - Those defined in the Transport service on a Mailbox server. - - User-created Send connectors defined on an Edge server. The default value is $true for a default Send connector defined on an Edge server. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -391,10 +395,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -406,11 +411,8 @@ Accept wildcard characters: False 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. - - DowngradeDnsFailures: All DNS errors are treated as transient. - - DowngradeCustomFailures: Particular SMTP errors are treated as transient. - - UpgradeCustomFailures Custom transient failures are upgraded and treated as permanent failures. Multiple values can be specified for this parameter, separated by commas. @@ -418,10 +420,11 @@ Multiple values can be specified for this parameter, separated by commas. Specify a value other than Default for this parameter only if this Send connector is used to send messages over a reliable and well-defined communication channel where communication errors aren't expected. For example, consider specifying a value other than Default if this Send connector is used to send messages to a partner. ```yaml -Type: Default | DowngradeAuthFailures | DowngradeDnsFailures +Type: ErrorPolicies Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -430,13 +433,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -448,10 +454,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -463,9 +470,7 @@ Accept wildcard characters: False 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 - - In the most recent Received header field added to the message by the next hop messaging server after the message leaves the Transport service on a Mailbox server or an Edge server - - During TLS authentication The default value of the Fqdn parameter is $null. This means the default FQDN value is the FQDN of the Mailbox server or Edge server that contains the Send connector. @@ -475,6 +480,7 @@ 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 @@ -486,10 +492,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: AddressSpaces Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -501,10 +508,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -513,23 +521,23 @@ Accept wildcard characters: False ``` ### -Internal -The Internal parameter specifies the Internal usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal parameter, you can't use any of the following parameters: +The Internal switch specifies the Internal usage type. You don't need to specify a value with this switch. -- Custom +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal switch, you can't use any of the following parameters: +- Custom - Internet - - Partner - - Usage -For more information about Send connector usage types, permissions, and authentication methods, see Send connectors (https://technet.microsoft.com/library/aa998662.aspx). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -538,23 +546,23 @@ Accept wildcard characters: False ``` ### -Internet -The Internet parameter specifies the Internet usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet parameter, you can't use any of the following parameters: +The Internet switch specifies the Internet usage type. You don't need to specify a value with this switch. -- Custom +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet switch, you can't use any of the following parameters: +- Custom - Internal - - Partner - - Usage -For more information about Send connector usage types, permissions, and authentication methods, see Send connectors (https://technet.microsoft.com/library/aa998662.aspx). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -563,15 +571,16 @@ Accept wildcard characters: False ``` ### -IsCoexistenceConnector -This parameter is available or functional only in 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 Office 365 organization. The default value is $false. +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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -583,10 +592,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: AddressSpaces Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -595,25 +605,20 @@ Accept wildcard characters: False ``` ### -LinkedReceiveConnector -This parameter is available or functional only in 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: - GUID - - Distinguished name (DN) - -- Servername\\ConnectorName +- ServerName\\ConnectorName When you use the LinkReceiveConnector parameter with this command, you must also use the following parameters with the specified values: -- DNSRoutingEnabled$false - -- MaxMessageSizeunlimited - -- Smarthosts \ - -- SmarthostAuthMechanism \ +- `DNSRoutingEnabled $false` +- `MaxMessageSize unlimited` +- `Smarthosts ` +- `SmarthostAuthMechanism ` When you use the LinkedReceiveConnector parameter, you can't use the AddressSpaces parameter. @@ -622,6 +627,7 @@ Type: ReceiveConnectorIdParameter Parameter Sets: LinkedReceiveConnector Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -635,13 +641,9 @@ The MaxMessageSize parameter specifies the maximum size of a message that can pa When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -653,6 +655,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -661,23 +664,23 @@ Accept wildcard characters: False ``` ### -Partner -The Partner parameter specifies the Partner usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner parameter, you can't use any of the following parameters: +The Partner switch specifies the Partner usage type. You don't need to specify a value with this switch. -- Custom +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner switch, you can't use any of the following parameters: +- Custom - Internal - - Internet - - Usage -For more information about Send connector usage types, permissions, and authentication methods, see Send connectors (https://technet.microsoft.com/library/aa998662.aspx). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -693,6 +696,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -704,10 +708,11 @@ Accept wildcard characters: False 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: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -719,10 +724,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -734,10 +740,11 @@ Accept wildcard characters: False The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -749,10 +756,11 @@ Accept wildcard characters: False 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: None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative +Type: AuthMechanisms Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -761,15 +769,16 @@ Accept wildcard characters: False ``` ### -SmartHosts -The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameteris required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. +The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart host server. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```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 @@ -785,6 +794,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -800,6 +810,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -810,13 +821,14 @@ Accept wildcard characters: False ### -SourceTransportServers 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, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```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 @@ -828,18 +840,17 @@ Accept wildcard characters: False 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. - - 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 Send connector also verifies that the FQDN of the target certificate matches the domain specified in the TlsDomain parameter. If no domain is specified in the TlsDomain parameter, the FQDN on the certificate is compared with the recipient's domain. You can't specify a value for this parameter if the IgnoreSTARTTLS parameter is set to $true, or if the RequireTLS parameter is set to $false. ```yaml -Type: EncryptionOnly | CertificateValidation | DomainValidation +Type: TlsAuthLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -848,13 +859,14 @@ 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.500Issuer\X.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. +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 Default value: None @@ -870,7 +882,6 @@ This parameter is used only if the TlsAuthLevel parameter is set to DomainValida A value for this parameter is required if: - The TLSAuthLevel parameter is set to DomainValidation. - - The DNSRoutingEnabled parameter is set to $false (smart host Send connector). ```yaml @@ -878,6 +889,7 @@ Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -891,20 +903,18 @@ The Usage parameter specifies the default permissions and authentication methods If you use the Usage parameter, you can't use any of the following parameters: - Custom - - Internal - - Internet - - Partner -For more information about Send connector usage types, permissions, and authentication methods, see Send connectors (https://technet.microsoft.com/library/aa998662.aspx). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml -Type: Custom | Internal | Internet | Partner +Type: UsageType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -916,10 +926,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -935,6 +946,7 @@ 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 @@ -943,20 +955,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7b315ab0-8778-4835-a252-fb94129d7a8e.aspx) diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md new file mode 100644 index 0000000000..6e59edbe3e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: New-ServicePrincipal +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ServicePrincipal + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ServicePrincipal cmdlet to create service principals in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ServicePrincipal -AppId -ObjectId + -ServiceId + [-Confirm] + [-DisplayName ] + [-Organization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Service principals exist in Microsoft Entra ID to define what apps can do, who can access the apps, and what resources the apps can access. In Exchange Online, service principals are references to the service principals in Microsoft Entra ID. To assign Exchange Online role-based access control (RBAC) roles to service principals in Microsoft Entra ID, you use the service principal references in Exchange Online. The **\*-ServicePrincipal** cmdlets in Exchange Online PowerShell let you view, create, and remove these service principal references. + +For more information, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ServicePrincipal -AppId 71487acd-ec93-476d-bd0e-6c8b31831053 -ObjectId 6233fba6-0198-4277-892f-9275bf728bcc +``` + +This example create a new service principal in Exchange Online with the specified AppId and ObjectId values. + +## PARAMETERS + +### -AppId +The AppId parameter specifies the unique AppId GUID value for the service principal. For example, ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. + +A valid value for this parameter is available in the following locations: + +- The AppId property in the output of the [Get-MgServicePrincipal](https://learn.microsoft.com/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) cmdlet in Microsoft Graph PowerShell. +- The Application ID property from Enterprise applications in the Microsoft Entra admin center: . + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The ObjectId parameter specifies the unique ObjectId GUID value for the service principal. For example, 7c7599b2-23af-45e3-99ff-0025d148e929. + +A valid value for this parameter is available in the following locations: + +- The Id property in the output of the [Get-MgServicePrincipal](https://learn.microsoft.com/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) cmdlet in Microsoft Graph PowerShell. +- The Object ID property from Enterprise applications in the Microsoft Entra admin center: . + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceId +This parameter is being deprecated. Use the ObjectId parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/New-SettingOverride.md b/exchange/exchange-ps/exchange/New-SettingOverride.md similarity index 79% rename from exchange/exchange-ps/exchange/organization/New-SettingOverride.md rename to exchange/exchange-ps/exchange/New-SettingOverride.md index 4af3d79e11..6ffa158c1c 100644 --- a/exchange/exchange-ps/exchange/organization/New-SettingOverride.md +++ b/exchange/exchange-ps/exchange/New-SettingOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-SettingOverride @@ -15,25 +18,31 @@ This cmdlet is available only in on-premises Exchange. Use the New-SettingOverride cmdlet to create setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SettingOverride [-Name] -Component -Parameters -Reason - -Section [-Confirm] [-DomainController ] [-FixVersion ] [-Force] - [-MaxVersion ] [-MinVersion ] [-Server ] [-WhatIf] [] +New-SettingOverride [-Name] -Component -Parameters -Reason -Section + [-Confirm] + [-DomainController ] + [-Force] + [-MaxVersion ] + [-MinVersion ] + [-Server ] + [-WhatIf] + [] ``` ## DESCRIPTION -Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-sepcific, 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. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-SettingOverride -Name "IM Override" -Component OwaServer -Section IMSettings -Parameters @("IMServerName=skype01.contoso.com","IMCertificateThumbprint=CDF34A740E9D225A1A06193A9D44B2CE22775308") -Reason "Configure IM" ``` @@ -41,65 +50,64 @@ This example creates a new setting override named IM Server Integration. This ov For more information, see the topic Configure instant messaging integration with Outlook on the web in Exchange 2016. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-SettingOverride -Name "Change OAB Generation" -Server Mailbox01 -Component TimeBasedAssistants -Section OABGeneratorAssistant -Parameters @("WorkCycle=02:00:00") -Reason "Generate OAB Every 2 hours" ``` This example creates a new setting override named Change OAB Generation. This override specifies a 2 hour OAB generation interval. Because the Server parameter is used, the override applies only to the specified server named Mailbox01. -For more information, see the topic Change the offline address book generation schedule (https://technet.microsoft.com/library/bb124719.aspx). +For more information, see the topic [Change the offline address book generation schedule in Exchange](https://learn.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). ## PARAMETERS -### -Component -The Component parameter specifies the component that the setting override is applied to. For example: - -- TimeBasedAssistants - -- OwaServer +### -Name +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: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the unique name of the setting override. If the value contains spaces, enclose the value in quotation marks ("). +### -Component +The Component parameter specifies the component that the setting override is applied to. For example: + +- TimeBasedAssistants +- OwaServer ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Parameters -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 @("\=\","\=\"...). +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: -For example: - -- @("Enabled=true") - -- @("IMServerName=\","IMCertificateThumbprint=\") +- `@("Enabled=true")` +- `@("IMServerName=","IMCertificateThumbprint=")` ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -115,6 +123,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -130,6 +139,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -140,8 +150,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -149,6 +158,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,21 +174,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -FixVersion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Version -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -187,13 +183,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -213,6 +212,7 @@ Type: Version Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -232,6 +232,7 @@ Type: Version Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -249,6 +250,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -264,6 +266,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -272,20 +275,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/29be9ee9-d9c7-4aef-b068-8ab44ceecd0a.aspx) diff --git a/exchange/exchange-ps/exchange/New-SharingPolicy.md b/exchange/exchange-ps/exchange/New-SharingPolicy.md new file mode 100644 index 0000000000..c955830dfd --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SharingPolicy.md @@ -0,0 +1,207 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation has been configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox. + +Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing policies allow users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SharingPolicy [-Name] -Domains + [-Confirm] + [-Default] + [-DomainController ] + [-Enabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SharingPolicy -Name "Contoso" -Domains 'mail.contoso.com: CalendarSharingFreeBusyDetail, ContactsSharing' +``` + +This example creates the sharing policy Contoso for the contoso.com domain, which is a domain outside the organization. This policy allows users in the contoso.com domain to see detailed free/busy information and contacts. By default, this policy is enabled. + +### Example 2 +```powershell +New-SharingPolicy -Name "SharingPolicy01" -Domains 'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusySimple' -Enabled $false -Default $true +``` + +This example creates a default sharing policy, which is applied to all mailboxes that don't implicitly have a sharing policy assigned to them. This sharing policy SharingPolicy01 applies to two different domains, and the sharing policy is disabled. + +## PARAMETERS + +### -Name +The Name parameter specifies the name of the new sharing policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domains +The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. + +You can use the following values for `Domain`: + +- A domain: For example, `mail.contoso.com`. A domain doesn't include subdomains. You must configure each subdomain separately. +- \*: Share with external federated organizations. For example, another Microsoft 365 organization or an on-premises Exchange organization. +- Anonymous: Share with external, non-federated organizations and individuals with internet access. + +You can use the following values for `SharingPolicyAction`: + +- CalendarSharingFreeBusySimple: Share free/busy hours only +- CalendarSharingFreeBusyDetail: Share free/busy hours, subject and location +- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location and the body of the message or calendar item +- ContactsSharing: Share contacts only + +You can specify multiple `'Domain: SharingPolicyAction'` values separated by commas, and you can specify multiple `SharingPolicyAction` values for the same domain separated by commas. For example, `'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Default +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-SiteMailbox.md b/exchange/exchange-ps/exchange/New-SiteMailbox.md new file mode 100644 index 0000000000..21fd001892 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SiteMailbox.md @@ -0,0 +1,253 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-SiteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +The New-SiteMailbox cmdlet is used by the Microsoft SharePoint and Microsoft Exchange user interfaces to create site mailboxes. We recommend that you don't use this cmdlet; instead use SharePoint to create the site mailbox. This cmdlet should only be used for diagnostic and troubleshooting purposes. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SiteMailbox [[-DisplayName] ] -SharePointUrl + [-Alias ] + [-Confirm] + [-Database ] + [-DomainController ] + [-Force] + [-Name ] + [-OrganizationalUnit ] + [-OverrideRecipientQuotas] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SiteMailbox +``` + +You can't run this cmdlet from the Exchange Management Shell. Use SharePoint to create a site mailbox. + +## PARAMETERS + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideRecipientQuotas +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md index 1a36a09930..2766674f44 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md @@ -1,68 +1,76 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailboxprovisioningpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SiteMailboxProvisioningPolicy schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-SiteMailboxProvisioningPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the New-SiteMailboxProvisioningPolicy cmdlet to create provisioning policies for site mailboxes. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -New-SiteMailboxProvisioningPolicy [-Name] [-AliasPrefix ] [-Confirm] - [-DefaultAliasPrefixEnabled <$true | $false>] [-DomainController ] [-IsDefault] - [-IssueWarningQuota ] [-MaxReceiveSize ] - [-ProhibitSendReceiveQuota ] [-WhatIf] [] +New-SiteMailboxProvisioningPolicy [-Name] + [-AliasPrefix ] + [-Confirm] + [-DefaultAliasPrefixEnabled ] + [-DomainController ] + [-IsDefault] + [-IssueWarningQuota ] + [-MaxReceiveSize ] + [-ProhibitSendReceiveQuota ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-SiteMailboxProvisioningPolicy -Name SM_ProvisioningPolicy -IsDefault -IssueWarningQuota 9GB -ProhibitSendReceiveQuota 10GB -MaxReceiveSize 50MB ``` This example creates the default provisioning policy named SM\_ProvisioningPolicy that has the following settings: - The warning quota for the site mailboxes is 9 GB. - - The site mailboxes are prohibited from receiving messages when the mailbox size reaches 10 GB. - - The maximum size of email messages that can be sent to site mailboxes is 50 MB. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-SiteMailboxProvisioningPolicy -Name SM_DefaultPolicy -IsDefault ``` This example creates the default provisioning policy named SM\_DefaultPolicy that uses the defaults for send and receive quotas. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell New-SiteMailboxProvisioningPolicy -Name SM_DefaultPolicy -IsDefault -AliasPrefix Project ``` -This example creates the default provisioning policy named SM\_DefaultPolicy and sets the AliasPrefixvalue to Project. When you create new site mailboxes, the prefix Project- is automatically added to the alias. +This example creates the default provisioning policy named SM\_DefaultPolicy and sets the AliasPrefix value to Project. When you create new site mailboxes, the prefix Project- is automatically added to the alias. ## PARAMETERS ### -Name -This parameter is available only in on-premises Exchange. - The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml @@ -70,6 +78,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -78,12 +87,9 @@ Accept wildcard characters: False ``` ### -AliasPrefix -This parameter is available only in on-premises Exchange. - -The AliasPrefix parameter specifies the custom text prefix to add to the aliases of newsite mailboxes. Valid values are: +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. ```yaml @@ -91,6 +97,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -101,15 +108,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,21 +125,19 @@ Accept wildcard characters: False ``` ### -DefaultAliasPrefixEnabled -This parameter is available only in on-premises Exchange. - 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 Office 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 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`). - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,8 +146,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -150,6 +153,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -158,9 +162,7 @@ Accept wildcard characters: False ``` ### -IsDefault -This parameter is available only in on-premises Exchange. - -The IsDefaultswitch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. +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. @@ -169,6 +171,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -177,20 +180,14 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota -This parameter is available only in on-premises Exchange. - The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -204,6 +201,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -212,22 +210,15 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. The default value is 36 MB. @@ -237,6 +228,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -245,20 +237,14 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota -This parameter is available only in on-premises Exchange. - The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -272,6 +258,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -286,7 +273,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -295,20 +283,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/56fed628-195d-48b3-86a0-5c780d320056.aspx) diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md new file mode 100644 index 0000000000..ed8687d950 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md @@ -0,0 +1,224 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SupervisoryReviewPolicyV2 + +## 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-SupervisoryReviewPolicyV2 cmdlet to create supervisory review policies in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SupervisoryReviewPolicyV2 [-Name] -Reviewers + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-PolicyRBACScopes ] + [-PreservationPeriodInDays ] + [-UserReportingWorkloads ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SupervisoryReviewPolicyV2 -Name "EU Brokers Policy" -Reviewers laura@contoso.com,julia@contoso.com -Comment "Created by the compliance team" +``` + +This example creates a new supervisory review policy named EU Brokers Policy. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reviewers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +{{ Fill Enabled 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreservationPeriodInDays +{{ Fill PreservationPeriodInDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserReportingWorkloads +{{ Fill UserReportingWorkloads Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md new file mode 100644 index 0000000000..c4b9d1a57f --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -0,0 +1,479 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-SupervisoryReviewRule + +## 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-SupervisoryReviewRule cmdlet to create supervisory review rules in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SupervisoryReviewRule [-Name] -Policy + [-AdvancedRule ] + [-CcsiDataModelOperator ] + [-Condition ] + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentMatchesDataModel ] + [-ContentSources ] + [-DayXInsights ] + [-ExceptIfFrom ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRevieweeIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-From ] + [-IncludeAdaptiveScopes ] + [-InPurviewFilter ] + [-Ocr ] + [-PolicyRBACScopes ] + [-SamplingRate ] + [-SentTo ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-SupervisoryReviewRule -Name "EU Brokers Rule" -Policy "EU Brokers Policy" -SamplingRate 100 -Condition "((NOT(Reviewee:US Compliance)) -AND (Reviewee:EU Brokers) -AND ((trade) -OR (insider trading)) -AND (NOT(approved by the Contoso financial team)))" +``` + +This example creates a new supervisory review rule named EU Brokers Rule with the following settings: + +- Policy: EU Brokers Policy +- Sampling rate: 100% +- Conditions: Supervise inbound and outbound communications for members of the EU Brokers group that contain the words trade or insider trading. +- Exceptions: Exclude supervision for members of the EU Compliance group, or messages that contain the phrase "approved by the Contoso financial team". + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedRule +{{ Fill AdvancedRule Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CcsiDataModelOperator +{{ Fill CcsiDataModelOperator Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: + +- User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. +- Direction: `"((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))"`. +- Message contains words: `"(() -OR ()...)"`. Exceptions use the syntax `"(NOT(() -OR ()...))"`. +- Any attachment contains words: `"((Attachment:) -OR (Attachment:)...)"`. Exceptions use the syntax `"(NOT((Attachment:) -OR (Attachment:)...))"`. +- Any attachment has the extension: `"((AttachmentName:.) -OR (AttachmentName:.)...)"`. Exceptions use the syntax `"(NOT((AttachmentName:.) -OR (AttachmentName:.)...))"`. +- Message size is larger than: `"(MessageSize:)"`. For example `"(MessageSize:300KB)"`. Exceptions use the syntax `"(NOT(MessageSize:))"`. +- Any attachment is larger than: `"(AttachmentSize:)"`. For example `"(AttachmentSize:3MB)"`. Exceptions use the syntax `"(NOT(AttachmentSize:))"`. +- Parentheses ( ) are required around the whole filter. +- Separate multiple conditions or exception types with the AND operator. For example, `"((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))"`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +{{ Fill ContentContainsSensitiveInformation Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchesDataModel +{{ Fill ContentMatchesDataModel Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSources +{{ Fill ContentSources Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DayXInsights +{{ Fill DayXInsights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +{{ Fill ExceptIfFrom Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +{{ Fill ExceptIfRecipientDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRevieweeIs +{{ Fill ExceptIfRevieweeIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +{{ Fill ExceptIfSenderDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +{{ Fill ExceptIfSentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +{{ Fill ExceptIfSubjectOrBodyContainsWords Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +{{ Fill From Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdaptiveScopes +{{ Fill IncludeAdaptiveScopes Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPurviewFilter +{{ Fill InPurviewFilter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ocr +{{ Fill Ocr Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingRate +The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. + +```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 +``` + +### -SentTo +{{ Fill SentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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/mailboxes/New-SweepRule.md b/exchange/exchange-ps/exchange/New-SweepRule.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/New-SweepRule.md rename to exchange/exchange-ps/exchange/New-SweepRule.md index e808cc63fc..6aa53c55aa 100644 --- a/exchange/exchange-ps/exchange/mailboxes/New-SweepRule.md +++ b/exchange/exchange-ps/exchange/New-SweepRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-SweepRule @@ -11,39 +14,54 @@ monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the New-SweepRule cmdlet to create Sweep rules in mailboxes. Sweep rules run a regular intervals to help keep your Inbox clean. +Use the New-SweepRule cmdlet to create Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SweepRule [-Name] -Provider [-Confirm] [-DestinationFolder ] - [-DomainController ] [-Enabled <$true | $false>] [-ExceptIfFlagged <$true | $false>] - [-ExceptIfPinned <$true | $false>] [-KeepForDays ] [-KeepLatest ] - [-Mailbox ] [-Sender ] [-SourceFolder ] - [-SystemCategory ] - [-WhatIf] [] +New-SweepRule [-Name] -Provider + [-Confirm] + [-DestinationFolder ] + [-DomainController ] + [-Enabled ] + [-ExceptIfFlagged ] + [-ExceptIfPinned ] + [-KeepForDays ] + [-KeepLatest ] + [-Mailbox ] + [-Sender ] + [-SourceFolder ] + [-SystemCategory ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-SweepRule -Name "From Michelle" -Mailbox "Felipe Apodaca" -Provider Exchange16 -Sender michelle@fabrikam.com -KeepLatest 1 ``` This example creates a new Sweep rule named "From Michelle" in Felipe Apodaca's mailbox that keeps the latest message from michelle@fabrikam.com in the Inbox folder, and moves older messages to the Deleted Items folder. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-SweepRule -Name "From Lila" -Mailbox "Felipe Apodaca" -Provider Exchange16 -Sender lila@fabrikam.com -KeepForDays 10 ``` This example creates a new Sweep rule named "From Lila" in Felipe Apodaca's mailbox that moves messages from lila@fabrikam.com in the Inbox folder that are older than 10 days to the Deleted Items folder. +### Example 3 +```powershell +New-SweepRule -Name "From Jeff" -Mailbox "Felipe Apodaca" -Provider Exchange16 -Sender jeffm@fabrikam.com -SourceFolder "Felipe:\Sent Items" -KeepForDays 10 +``` + +This example creates a new Sweep rule named "From Jeff" in Felipe Apodaca's mailbox that moves messages from jeffm@fabrikam.com in the Sent Items folder that are older than 10 days to the Deleted Items folder. ## PARAMETERS @@ -55,6 +73,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -72,6 +91,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -82,8 +102,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -91,6 +110,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -99,15 +119,29 @@ Accept wildcard characters: False ``` ### -DestinationFolder -The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder based on the conditions of the rule. +The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. -The default value is Deleted Items. +For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Unimportant` or `John:\Inbox\Misc`. The default value is `MailboxID:\Deleted Items`. ```yaml Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -125,6 +159,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -136,16 +171,16 @@ Accept wildcard characters: False 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. - - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -154,41 +189,33 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged +This parameter is available only in on-premises Exchange. + The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are: - $true: The rule action isn't applied to messages that have a message flag applied. - - $false: The exception isn't used. The typical message flag values are: - Any - - Call - - DoNotForward - - FollowUp - - ForYourInformation - - Forward - - NoResponseNecessary - - Read - - Reply - - ReplyToAll - - Review ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -197,17 +224,19 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned +This parameter is available only in on-premises Exchange. + The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are: - $true: The rule action isn't applied to messages that are pinned to the top of the Inbox. - - $false: The exception isn't used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -225,6 +254,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -242,6 +272,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -250,30 +281,17 @@ Accept wildcard characters: False ``` ### -Mailbox -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -281,6 +299,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -289,22 +308,13 @@ Accept wildcard characters: False ``` ### -Sender -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID For external senders, use their email address. @@ -314,6 +324,7 @@ Type: RecipientIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -322,15 +333,29 @@ Accept wildcard characters: False ``` ### -SourceFolder -The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. +The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. -The default value is Inbox. +For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Marketing` or `John:\Inbox\Reports`. The default value is `MailboxID:\Inbox`. ```yaml Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -342,58 +367,36 @@ Accept wildcard characters: False 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 - - Bills - - Document - - DocumentPlus - - Event - - Family - - File - - Flight - - FromContact - - Important - - LiveView - - Lodging - - MailingList - - Newsletter - - Photo - - Purchase - - RentalCar - - RestaurantReservation - - RetiredPromotion - - ShippingNotification - - Shopping - - SocialUpdate - - Travel - - Video ```yaml -Type: NotDefined | FromContact | Newsletter | Photo | SocialUpdate | Video | Document | File | MailingList | ShippingNotification | LiveView | DocumentPlus | Important | Family | Bills | Shopping | Travel | Flight | RestaurantReservation | Lodging | RentalCar | Purchase | Event | RetiredPromotion +Type: SystemCategoryType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -409,6 +412,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -417,20 +421,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9e2053be-cf79-4b49-9e0a-af16c7f4e3dc.aspx) diff --git a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md new file mode 100644 index 0000000000..8084e8b744 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md @@ -0,0 +1,834 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +The New-SyncMailPublicFolder cmdlet is used by the Import-MailPublicFoldersForMigration.ps1 and Sync-MailPublicFolders.ps1 scripts to create mail-enabled public folder recipient objects in Exchange Online (the scripts synchronize mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-SyncMailPublicFolder [-Name] [-Alias] -EntryId + [-AcceptMessagesOnlyFrom ] + [-Confirm] + [-Contacts ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-DomainController ] + [-EmailAddresses ] + [-ExternalEmailAddress ] + [-ForwardingAddress ] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-OnPremisesObjectId ] + [-OverrideRecipientQuotas] + [-RejectMessagesFrom ] + [-RequireSenderAuthenticationEnabled ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-SyncMailPublicFolder +``` + +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. + +## PARAMETERS + +### -Name +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EntryId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can specify multiple senders separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```yaml +Type: DeliveryRecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Contacts +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliverToMailboxAndForward +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. + +The default value is $false. This parameter is meaningful only if you configure a forwarding recipient by using the ForwardingAddress parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +```yaml +Type: ProxyAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalEmailAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingAddress +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. + +- DeliverToMailboxAndForward is $true: Messages are delivered to this mail-enabled public folder and forwarded to the specified recipient. +- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified recipient. Messages aren't delivered to this mail-enabled public folder. + +The default value is blank ($null), which means no forwarding recipient is configured. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this public folder. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSendSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesObjectId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideRecipientQuotas +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can specify multiple senders separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```yaml +Type: DeliveryRecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/New-SystemMessage.md b/exchange/exchange-ps/exchange/New-SystemMessage.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/New-SystemMessage.md rename to exchange/exchange-ps/exchange/New-SystemMessage.md index 4f82117026..05d97b7970 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-SystemMessage.md +++ b/exchange/exchange-ps/exchange/New-SystemMessage.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-SystemMessage @@ -13,42 +16,44 @@ This cmdlet is available only in on-premises Exchange. Use the New-SystemMessage cmdlet to create custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Dsn ``` -New-SystemMessage -DsnCode -Internal <$true | $false> -Language -Text +New-SystemMessage -DsnCode -Internal -Language -Text [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Quota ``` -New-SystemMessage -Language -QuotaMessageType -Text +New-SystemMessage -Language -QuotaMessageType -Text [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-SystemMessage -DsnCode 5.3.5 -Language en -Internal $false -Text "The recipient email system can't process this email message. Please contact your system administrator for more information." ``` This example creates a custom English NDR for the enhanced status code 5.3.5 for external senders. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-SystemMessage -QuotaMessageType WarningMailbox -Language en -Text "Your mailbox has exceeded the warning limit specified by your email administrator. Please reduce the size of your mailbox." ``` @@ -61,7 +66,7 @@ The DsnCode parameter specifies the enhanced status code for the custom system m 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. -To generate a list of default enhanced status codes that are used by Exchange, run this command: Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html \> "C:\\My Documents\\Default DSNs.html". +To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. You need to use this parameter with the Language and Internal parameters. @@ -72,6 +77,7 @@ Type: EnhancedStatusCode Parameter Sets: Dsn Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -83,7 +89,6 @@ Accept wildcard characters: False 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. - - $false: The NDR is displayed to external senders. You need to use this parameter with the DsnCode and Language parameters. @@ -91,10 +96,11 @@ You need to use this parameter with the DsnCode and Language parameters. You can't use this parameter with the QuotaMessageType parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Dsn Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -103,7 +109,7 @@ Accept wildcard characters: False ``` ### -Language -The Language parameter specifies the language of the message \(for example, en for English or ja for Japanese). For the list of supported language codes, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). +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. @@ -112,6 +118,7 @@ Type: CultureInfo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -124,50 +131,36 @@ The QuotaMessageType parameter specifies the quota for the custom system message Mailbox size quotas: -- ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - - WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - - WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. Public folder size quotas: - ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. - - WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. - - WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. Maximum number of messages in a mailbox folder: - ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. - - WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. - - WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. Maximum number of subfolders in a mailbox folder: - ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. - - WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. - - WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. - - ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. - - WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. - - WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. Maximum number of levels (depth) in a mailbox folder: - ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. - - WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. - - WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. You need to use this parameter with the Language parameter. @@ -175,10 +168,11 @@ You need to use this parameter with the Language parameter. You can't use this parameter with the DsnCode or Internal parameters. ```yaml -Type: WarningMailboxUnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | WarningPublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSendReceiveMailBox +Type: QuotaMessageType Parameter Sets: Quota Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -195,35 +189,29 @@ This parameter can contain text and HTML tags. The maximum length is 512 charact The following HTML tags are available: -- \ and \ (bold) - -- \ 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 `` (bold) +- `` 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). Use the following escape codes for these special characters: -- < for \<. - -- > for \>. - -- " for ". - -- & for &. +- `<` for \< +- `>` for \> +- `"` for " +- `&` for & Here's an example value for this parameter that uses HTML tags and special characters: -'You tried to send a message to a \disabled\ mailbox. Please visit \Internal Support\ or contact "InfoSec" for more information.' +`'You tried to send a message to a disabled mailbox. Please visit Internal Support or contact "InfoSec" for more information.'` ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -234,8 +222,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -243,6 +230,7 @@ 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 @@ -260,6 +248,7 @@ 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 @@ -275,6 +264,7 @@ 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 @@ -283,20 +273,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/77b06405-076d-43cf-89b1-aa62b6565d8d.aspx) diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md new file mode 100644 index 0000000000..18775fc30b --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicy +applicable: Exchange Online +title: New-TeamsProtectionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-TeamsProtectionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-TeamsProtectionPolicy cmdlet to create Microsoft Teams protection policies. + +**Note**: If the policy already exists (the Get-TeamsProtectionPolicy cmdlet returns output), you can't use this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-TeamsProtectionPolicy [-Name] + [-Confirm] + [-HighConfidencePhishQuarantineTag ] + [-MalwareQuarantineTag ] + [-Organization ] + [-WhatIf] + [-ZapEnabled ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-TeamsProtectionPolicy -Name "Teams Protection Policy" +``` + +This example creates the Teams protection policy with the default values. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name of the Teams protection policy. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy in an organization is Teams Protection Policy. We recommend using this value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareQuarantineTag +The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZapEnabled +The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: + +- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. +- $false: ZAP for malware and high confidence phishing messages in Teams is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md new file mode 100644 index 0000000000..b2a9f0c731 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicyrule +applicable: Exchange Online +title: New-TeamsProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-TeamsProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-TeamsProtectionPolicyRule cmdlet to create Microsoft Teams protection policy rules. + +**Note**: If the rule already exists (the Get-TeamsProtectionPolicyRule cmdlet returns output), you can't use this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-TeamsProtectionPolicyRule [-Name] -TeamsProtectionPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Organization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use this cmdlet only if the following statements are true: + +- The Teams protection policy rule doesn't exist (the Get-TeamsProtectionPolicyRule cmdlet returns no output). +- The Teams protection policy exists (the Get-TeamsProtectionPolicy cmdlet returns output). + +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Configure ZAP for Teams protection in Defender for Office 365 Plan 2](https://learn.microsoft.com/defender-office-365/mdo-support-teams-about#configure-zap-for-teams-protection-in-defender-for-office-365-plan-2). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-TeamsProtectionPolicyRule -Name "Teams Protection Policy Rule" -TeamsProtectionPolicy "Teams Protection Policy" -ExceptIfSentToMemberOf research@contoso.onmicrosoft.com +``` + +This example creates the Teams protection policy rule with members of the group named Research excluded from ZAP for Teams protection. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name of the Teams protection policy rule. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy rule in an organization is Teams Protection Policy Rule. We recommend using this value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsProtectionPolicy +The TeamsProtectionPolicy parameter specifies the Teams protection policy that's associated with this rule. The only available policy is named Teams Protection Policy. + +```yaml +Type: TeamsProtectionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for Teams messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md new file mode 100644 index 0000000000..6ef2975372 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -0,0 +1,353 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-TenantAllowBlockListItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-TenantAllowBlockListItems cmdlet to add entries to the Tenant Allow/Block List in the Microsoft Defender portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Expiration +``` +New-TenantAllowBlockListItems -Entries -ListType [-ExpirationDate ] + [-Allow] + [-Block] + [-ListSubType ] + [-LogExtraDetails] + [-Notes ] + [-OutputJson] + [-RemoveAfter ] + [-SubmissionID ] + [] +``` + +### NoExpiration +``` +New-TenantAllowBlockListItems -Entries -ListType [-NoExpiration] + [-Allow] + [-Block] + [-ListSubType ] + [-LogExtraDetails] + [-Notes ] + [-OutputJson] + [-RemoveAfter ] + [-SubmissionID ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-TenantAllowBlockListItems -ListType Url -Block -Entries ~contoso.com~ +``` + +This example adds a URL block entry for contoso.com and all subdomains (for example, contoso.com, www.contoso.com, xyz.abc.contoso.com, and www.contoso.com/b). Because we didn't use the ExpirationDate or NoExpiration parameters, the entry expires after 30 days. + +### Example 2 +```powershell +New-TenantAllowBlockListItems -ListType FileHash -Block -Entries "768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3","2c0a35409ff0873cfa28b70b8224e9aca2362241c1f0ed6f622fef8d4722fd9a" -NoExpiration +``` + +This example adds a file block entry for the specified files that never expires. + +### Example 3 +```powershell +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). + +### Example 4 +```powershell +New-TenantAllowBlockListItems -Allow -ListType Url -Entries abcd.fabrikam.com -RemoveAfter 45 +``` + +This example adds a URL allow entry for the specified domain with expiration as 45 days after last used date. This allow entry permits URLs identified as bulk, spam, high confidence spam, and phishing (not high confidence phishing). + +For URLs identified as malware or high-confidence phishing, you need to submit the URLs Microsoft to create allow entries. For instructions, see [Report good URLs to Microsoft](https://learn.microsoft.com/defender-office-365/submissions-admin#report-good-urls-to-microsoft). + +## PARAMETERS + +### -Entries +The Entries parameter specifies the values that you want to add to the Tenant Allow/Block List based on the ListType parameter value: + +- FileHash: Use the SHA256 hash value of the file. You can find the SHA256 hash value by running the following command in PowerShell: `Get-FileHash -Path "\" -Algorithm SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. +- Sender: A domain or email address value. For example, `contoso.com` or `michelle@contoso.com`. +- URL: Use IPv4 or IPv6 addresses or hostnames. Wildcards (\* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see [URL syntax for the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-urls-configure#url-syntax-for-the-tenant-allowblock-list). +- IP: IPv6 addresses only: + + • Single IPv6 addresses in colon-hexadecimal format (for example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334). + + • Single IPv6 addresses in zero-compression format (for example, 2001:db8::1 for 2001:0db8:0000:0000:0000:0000:0000:0001). + + • CIDR IPv6 ranges from 1 to 128 (for example, 2001:0db8::/32). + +To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. + +Entry limits for each list subtype (sender, URL, file, or IP address): + +- **Exchange Online Protection**: The maximum number of allow entries is 500, and the maximum number of block entries is 500. +- **Defender for Office 365 Plan 1**: The maximum number of allow entries is 1000, and the maximum number of block entries is 1000. +- **Defender for Office 365 Plan 2**: The maximum number of allow entries is 5000, and the maximum number of block entries is 10000. + +The maximum number of characters in a file entry is 64 and the maximum number of characters in a URL entry is 250. + +You can't mix value types (sender, URL, file, or IP address) or allow and block actions in the same command. + +In most cases, you can't modify the sender, URL, file, or IP address values after you create the entry. The only exception is URL allow entries for phishing simulations (ListType = URL, ListSubType = AdvancedDelivery). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDate +The ExpirationDate parameter set the expiration date of the entry in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +You can't use this parameter with the NoExpiration or RemoveAfter parameters. + +```yaml +Type: DateTime +Parameter Sets: Expiration +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListType +The ListType parameter specifies the type of entry to add. Valid values are: + +- FileHash +- Sender +- Url +- IP + +```yaml +Type: ListType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiration +The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. + +This switch is available to use in the following scenarios: + +- With the Block switch. +- With the Allow switch where the ListType parameter value is URL and the ListSubType parameter value is AdvancedDelivery. +- With the Allow switch where the ListType parameter value is IP. + +You can't use this switch with the ExpirationDate or RemoveAfter parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: NoExpiration +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Allow +The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. + +You can't use this switch with the Block switch. + +**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry. + +You can also use allow entries for third-party phishing simulation URLs with no expiration. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Allow switch specifies that you're creating a block entry. You don't need to specify a value with this switch. + +You can't use this switch with the Allow switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType parameter specifies the subtype for this entry. Valid values are: + +- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +- Tenant: This is the default value. + +```yaml +Type: ListSubType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogExtraDetails +{{ Fill LogExtraDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAfter +The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. + +The only valid value for this parameter is 45. + +You can use this parameter with the Allow switch when the ListType parameter value is Sender, FileHash, or Url. + +You can't use this parameter with the ExpirationDate or NoExpirationDate parameters. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputJson +The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. + +You use this switch to prevent the command from halting on the first entry that contains a syntax error. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubmissionID +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md new file mode 100644 index 0000000000..48976dd565 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md @@ -0,0 +1,185 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-TenantAllowBlockListSpoofItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-TenantAllowBlockListSpoofItems cmdlet to create spoofed sender entries in the Tenant Allow/Block List. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-TenantAllowBlockListSpoofItems [-Identity] -Action -SendingInfrastructure -SpoofedUser -SpoofType + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet adds a spoof pair (the combination of the spoofed user and the sending infrastructure) to the Tenant Allow/Block 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). + +## EXAMPLES + +### Example 1 +```powershell +New-TenantAllowBlockListSpoofItems -Identity Default -Action Allow -SendingInfrastructure contoso.com -SpoofedUser bob@contoso.com -SpoofType External +``` + +This example creates an allow entry for the sender bob@contoso.com from the source contoso.com. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SendingInfrastructure +The SendingInfrastructure parameter specifies the source of the messages sent by the spoofed sender that's defined in the SpoofedUser parameter. Valid values are: + +- An email domain (for example contoso.com). The domain is found in the reverse DNS lookup (PTR record) of the source email server's IP address. +- An IP address using the syntax: \/24 (for example, 192.168.100.100/24). Use the IP address if the source IP address has no PTR record. /24 is the only available and maximum subnet depth. +- A verified DKIM domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SpoofedUser +The SpoofedUser parameter specifies the email address or domain for the spoofed sender entry. + +- For domains outside your organization (cross-org), use the domain of the email address that appears in the From field of the message. +- For domains inside your organization (intra-org), use the full email address that appears in the From field of the message. + +For spoofed senders, the maximum number of entries is 1024. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SpoofType +The SpoofType parameter specifies whether this is an internal or external spoofed sender entry. Valid values are: + +- External +- Internal + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action +The Action parameter specifies whether is an allowed or blocked spoofed sender entry. Valid values are: + +- Allow +- Block + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/New-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/server-health-and-performance/New-ThrottlingPolicy.md rename to exchange/exchange-ps/exchange/New-ThrottlingPolicy.md index 7d4d0f0cda..4b540a9784 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/New-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-ThrottlingPolicy @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-ThrottlingPolicy cmdlet to create a non-default user throttling policy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -164,63 +167,64 @@ New-ThrottlingPolicy [-Name] [-SuiteMaxBurst ] [-SuiteMaxConcurrency ] [-SuiteRechargeRate ] - [-ThrottlingPolicyScope ] - [-WhatIf] [] + [-ThrottlingPolicyScope ] + [-WhatIf] + [] ``` ## DESCRIPTION -By default, there is one default throttling policy named GlobalThrottlingPolicy\_\ with a throttling scope of Global. Microsoft Exchange Setup creates a default client throttling policy as part of the Client Access server role. You should not replace, re-create, or remove the existing default throttling policy. However, you can create additional throttling policies with the scope of Organization or Regular to change your user throttling settings. You can also edit policies with the scope of Organization and Regular that you've created using the Set-ThrottlingPolicy cmdlet. +By default, there is one default throttling policy named `GlobalThrottlingPolicy_` with a throttling scope of Global. Microsoft Exchange Setup creates a default client throttling policy as part of the Client Access server role. You should not replace, re-create, or remove the existing default throttling policy. However, you can create additional throttling policies with the scope of Organization or Regular to change your user throttling settings. You can also edit policies with the scope of Organization and Regular that you've created using the Set-ThrottlingPolicy cmdlet. -For more information about how to control how resources are consumed by individual users, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-ThrottlingPolicy -Name -EWSPercentTimeInCAS 80 -EWSPercentTimeInAD $null ``` In Exchange Server 2010, this example creates a non-default throttling policy. Any parameters that you omit inherit the values from the default throttling policy. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-ThrottlingPolicy -Name ITUserPolicy -EwsMaxConcurrency 4 -ThrottlingPolicyScope Regular ``` -This example creates a non-default user throttling policy that can be associated with specific users. Any parameters that you omit inherit the values from the default throttling policy GlobalThrottlingPolicy\_\. After you create this policy, you must associate it with specific users. +This example creates a non-default user throttling policy that can be associated with specific users. Any parameters that you omit inherit the values from the default throttling policy `GlobalThrottlingPolicy_`. After you create this policy, you must associate it with specific users. -### -------------------------- Example 3 -------------------------- -``` -New-ThrottlingPolicy -Name EWSPercentTimeInCAS 80 +### Example 3 +```powershell +New-ThrottlingPolicy -Name -EWSPercentTimeInCAS 80 ``` In Exchange Server 2010, this example creates a policy for a tenant that sets the EWSPercentTimeInCAS parameter value to 80. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell New-ThrottlingPolicy -Name AllUsersEWSPolicy -EwsMaxConcurrency 4 -ThrottlingPolicyScope Organization ``` -This example creates a policy that applies to all users in your organization. Any parameters that you omit inherit the values from the default throttling policy GlobalThrottlingPolicy\_\. +This example creates a policy that applies to all users in your organization. Any parameters that you omit inherit the values from the default throttling policy `GlobalThrottlingPolicy_`. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell New-ThrottlingPolicy -Name RemoteSiteUserPolicy -PowerShellMaxConcurrency 3 -PowerShellMaxCmdletQueueDepth 12 ``` This example creates a throttling policy RemoteSiteUserPolicy that restricts the number of connections for a user to three. The users associated with this policy are only able to create three remote Exchange Management Shell sessions. This policy also restricts to three the number of Exchange admin center (EAC) operations or Exchange Web Services (EWS) operations that can be executed at the same time. -### -------------------------- Example 6 -------------------------- -``` +### Example 6 +```powershell New-ThrottlingPolicy -Name ITStaffUserPolicyCmdletMax -PowerShellMaxCmdlets 10 -PowerShellMaxCmdletsTimePeriod 5 ``` This example creates a throttling policy that restricts a user to be able to only execute 10 cmdlets in a period of five seconds. If the users associated with this policy exceed this number, the cmdlet pipeline execution is stopped with a throttling error message. The user needs to wait for and then resubmit the execution of cmdlets on the open connection. -### -------------------------- Example 7 -------------------------- -``` +### Example 7 +```powershell New-ThrottlingPolicy -Name ITStaffUserPolicyDestructiveCmdlets -PowerShellMaxDestructiveCmdlets 10 -PowerShellMaxDestructiveCmdletsTimePeriod 60 ``` @@ -229,13 +233,14 @@ This example creates a throttling policy that restricts a user to be able to onl ## PARAMETERS ### -Name -The Name parameter specifies the name of the object in Active Directory. The default policy is named DefaultThrottlingPolicy\. +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 Default value: None @@ -251,6 +256,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -266,6 +272,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -281,6 +288,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -289,7 +297,7 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInAD -This parameter is available or functional only in 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. @@ -298,6 +306,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -306,7 +315,7 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInCAS -This parameter is available or functional only in 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. @@ -315,6 +324,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -323,7 +333,7 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -332,6 +342,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -347,6 +358,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -362,6 +374,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -377,6 +390,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -392,6 +406,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -407,6 +422,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -422,6 +438,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -437,6 +454,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -447,8 +465,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -456,6 +473,7 @@ 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 @@ -471,6 +489,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -486,6 +505,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -501,6 +521,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -516,6 +537,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -531,6 +553,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -546,6 +569,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -561,6 +585,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -576,6 +601,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -584,7 +610,7 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -593,6 +619,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -608,6 +635,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -616,7 +644,7 @@ Accept wildcard characters: False ``` ### -CPUStartPercent -This parameter is available or functional only in 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. @@ -625,6 +653,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -633,13 +662,14 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxConcurrency -The DiscoveryMaxConcurrency parameter specifies the number of concurrent discovery search executions that a user can have at the same time. +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 Default value: None @@ -648,13 +678,14 @@ 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. +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -670,6 +701,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -685,6 +717,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -700,6 +733,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -715,6 +749,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -730,6 +765,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -738,13 +774,14 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes -The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx). +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 Default value: None @@ -760,6 +797,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -775,6 +813,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -792,6 +831,7 @@ 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 @@ -807,6 +847,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -822,6 +863,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -837,6 +879,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -852,6 +895,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -867,6 +911,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -882,6 +927,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -890,7 +936,7 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInAD -This parameter is available or functional only in 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. @@ -899,6 +945,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -907,7 +954,7 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInCAS -This parameter is available or functional only in 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. @@ -916,6 +963,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -924,7 +972,7 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -933,6 +981,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -948,6 +997,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -963,6 +1013,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -978,6 +1029,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -993,6 +1045,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1008,6 +1061,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1023,6 +1077,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1038,6 +1093,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1053,6 +1109,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1068,6 +1125,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1083,6 +1141,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1098,6 +1157,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1113,6 +1173,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1121,7 +1182,7 @@ Accept wildcard characters: False ``` ### -EWSFastSearchTimeoutInSeconds -This parameter is available or functional only in 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. @@ -1130,6 +1191,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1138,7 +1200,7 @@ Accept wildcard characters: False ``` ### -EWSFindCountLimit -This parameter is available or functional only in 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. @@ -1147,6 +1209,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1162,6 +1225,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1177,6 +1241,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1185,7 +1250,7 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInAD -This parameter is available or functional only in 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. @@ -1194,6 +1259,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1202,7 +1268,7 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1211,6 +1277,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1219,7 +1286,7 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1228,6 +1295,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1243,6 +1311,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1260,6 +1329,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1275,6 +1345,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1290,6 +1361,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1305,6 +1377,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1320,6 +1393,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1328,7 +1402,7 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInAD -This parameter is available or functional only in 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. @@ -1337,6 +1411,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1345,7 +1420,7 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1354,6 +1429,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1362,7 +1438,7 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1371,6 +1447,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1386,6 +1463,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1394,19 +1472,18 @@ Accept wildcard characters: False ``` ### -IsServiceAccount -The IsServiceAccount switch specifies whether you want the user accounts associated with this policy to be moderated by the per-user thresholds specified by this policy, and also by additional throttling based on the health of system resources, such as overall CPU usage. - -This value is set to $false by default. +The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. -You may want to set this value to $true if you intend to associate this policy with user accounts that require higher throttling limits. An account that might require higher throttling limits is a service account that performs a lot of non-interactive work (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). +You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). -By setting the IsServiceAccount switch to $true, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. +By using this switch, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1422,6 +1499,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1437,6 +1515,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1452,6 +1531,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1467,6 +1547,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1482,6 +1563,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1497,6 +1579,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1512,6 +1595,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1527,6 +1611,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1542,6 +1627,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1557,6 +1643,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1565,13 +1652,18 @@ Accept wildcard characters: False ``` ### -OWAMaxConcurrency -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. The OwaMaxConcurrency 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. +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. + +**Note**: We don't recommend setting this parameter to a large number or the value $null, because server performance might be negatively affected. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1580,7 +1672,7 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInAD -This parameter is available or functional only in 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. @@ -1589,6 +1681,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1597,7 +1690,7 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1606,6 +1699,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1614,7 +1708,7 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1623,6 +1717,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1638,6 +1733,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1653,6 +1749,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1668,6 +1765,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1683,6 +1781,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1698,6 +1797,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1713,6 +1813,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1728,6 +1829,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1743,6 +1845,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1751,7 +1854,7 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInAD -This parameter is available or functional only in 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. @@ -1760,6 +1863,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1768,7 +1872,7 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1777,6 +1881,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1785,7 +1890,7 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1794,6 +1899,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1809,6 +1915,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1824,6 +1931,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1839,6 +1947,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1854,6 +1963,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1869,6 +1979,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1884,6 +1995,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1895,7 +2007,6 @@ Accept wildcard characters: False 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. - - In the context of Exchange Web Services, the PowerShellMaxConcurrency parameter specifies the number of concurrent cmdlet executions that a user can have at the same time. This parameter value doesn't necessarily correlate to the number of browsers opened by the user. @@ -1905,6 +2016,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1916,21 +2028,13 @@ Accept wildcard characters: False 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: - Disable-Mailbox - - Move-ActiveMailboxDatabase - - Remove-AcceptedDomain - - Remove-Mailbox - - Remove-MailUser - - Remove-Organization - - Set-Mailbox - - Set-MailUser - - Update-MailboxDatabaseCopy The time period used for this limit is specified by the PowerShellMaxDestructiveCmdletsTimePeriod parameter. Both values should be set at the same time. This feature isn't on by default. For more information, see the "Examples" section. @@ -1940,6 +2044,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1955,6 +2060,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1970,6 +2076,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1985,6 +2092,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2000,6 +2108,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2017,6 +2126,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2032,6 +2142,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2047,6 +2158,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2064,6 +2176,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2079,6 +2192,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2094,6 +2208,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2109,6 +2224,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2124,6 +2240,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2139,6 +2256,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2154,6 +2272,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2169,6 +2288,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2184,6 +2304,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2199,6 +2320,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2214,6 +2336,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2229,6 +2352,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2248,6 +2372,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2256,7 +2381,7 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInAD -This parameter is available or functional only in 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. @@ -2265,6 +2390,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -2273,7 +2399,7 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInCAS -This parameter is available or functional only in 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. @@ -2282,6 +2408,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -2290,7 +2417,7 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -2299,6 +2426,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -2314,6 +2442,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2329,6 +2458,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2344,6 +2474,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2361,6 +2492,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2376,6 +2508,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2391,6 +2524,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2406,6 +2540,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2421,6 +2556,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2436,6 +2572,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2451,6 +2588,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2466,6 +2604,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2481,6 +2620,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2496,6 +2636,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2511,6 +2652,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2522,18 +2664,17 @@ Accept wildcard characters: False 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. - - Organization: Specifies a custom policy that applies to all users in your organization. - - Global: Reserved for the default throttling policy. -For more information about throttling policy scopes, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). +For more information about throttling policy scopes, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). ```yaml -Type: Regular | Organization | Global +Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2549,6 +2690,7 @@ 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 @@ -2557,20 +2699,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/aa6afac5-12bf-41b5-829c-a39e1d276e8b.aspx) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md new file mode 100644 index 0000000000..97c913ad9b --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -0,0 +1,5008 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. + +**Note**: + +- The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. + +- Rules that use Active Directory or Microsoft Entra ID properties as conditions or exceptions work only on senders or recipients in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-TransportRule [-Name] + [-ActivationDate ] + [-ADComparisonAttribute ] + [-ADComparisonOperator ] + [-AddManagerAsRecipientType ] + [-AddToRecipients ] + [-AnyOfCcHeader ] + [-AnyOfCcHeaderMemberOf ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-AnyOfToCcHeader ] + [-AnyOfToCcHeaderMemberOf ] + [-AnyOfToHeader ] + [-AnyOfToHeaderMemberOf ] + [-ApplyClassification ] + [-ApplyHtmlDisclaimerFallbackAction ] + [-ApplyHtmlDisclaimerLocation ] + [-ApplyHtmlDisclaimerText ] + [-ApplyOME ] + [-ApplyRightsProtectionCustomizationTemplate ] + [-ApplyRightsProtectionTemplate ] + [-AttachmentContainsWords ] + [-AttachmentExtensionMatchesWords ] + [-AttachmentHasExecutableContent ] + [-AttachmentIsPasswordProtected ] + [-AttachmentIsUnsupported ] + [-AttachmentMatchesPatterns ] + [-AttachmentNameMatchesPatterns ] + [-AttachmentProcessingLimitExceeded ] + [-AttachmentPropertyContainsWords ] + [-AttachmentSizeOver ] + [-BetweenMemberOf1 ] + [-BetweenMemberOf2 ] + [-BlindCopyTo ] + [-Comments ] + [-Confirm] + [-ContentCharacterSetContainsWords ] + [-CopyTo ] + [-DeleteMessage ] + [-DlpPolicy ] + [-Disconnect ] + [-DomainController ] + [-Enabled ] + [-ExceptIfADComparisonAttribute ] + [-ExceptIfADComparisonOperator ] + [-ExceptIfAnyOfCcHeader ] + [-ExceptIfAnyOfCcHeaderMemberOf ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfAnyOfToCcHeader ] + [-ExceptIfAnyOfToCcHeaderMemberOf ] + [-ExceptIfAnyOfToHeader ] + [-ExceptIfAnyOfToHeaderMemberOf ] + [-ExceptIfAttachmentContainsWords ] + [-ExceptIfAttachmentExtensionMatchesWords ] + [-ExceptIfAttachmentHasExecutableContent ] + [-ExceptIfAttachmentIsPasswordProtected ] + [-ExceptIfAttachmentIsUnsupported ] + [-ExceptIfAttachmentMatchesPatterns ] + [-ExceptIfAttachmentNameMatchesPatterns ] + [-ExceptIfAttachmentProcessingLimitExceeded ] + [-ExceptIfAttachmentPropertyContainsWords ] + [-ExceptIfAttachmentSizeOver ] + [-ExceptIfBetweenMemberOf1 ] + [-ExceptIfBetweenMemberOf2 ] + [-ExceptIfContentCharacterSetContainsWords ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] + [-ExceptIfFromScope ] + [-ExceptIfHasClassification ] + [-ExceptIfHasNoClassification ] + [-ExceptIfHasSenderOverride ] + [-ExceptIfHeaderContainsMessageHeader ] + [-ExceptIfHeaderContainsWords ] + [-ExceptIfHeaderMatchesMessageHeader ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfManagerAddresses ] + [-ExceptIfManagerForEvaluatedUser ] + [-ExceptIfMessageContainsDataClassifications ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] + [-ExceptIfRecipientAddressContainsWords ] + [-ExceptIfRecipientAddressMatchesPatterns ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRecipientInSenderList ] + [-ExceptIfSCLOver ] + [-ExceptIfSenderADAttributeContainsWords ] + [-ExceptIfSenderADAttributeMatchesPatterns ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderInRecipientList ] + [-ExceptIfSenderIpRanges ] + [-ExceptIfSenderManagementRelationship ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSentToScope ] + [-ExceptIfSubjectContainsWords ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] + [-FromScope ] + [-GenerateIncidentReport ] + [-GenerateNotification ] + [-HasClassification ] + [-HasNoClassification ] + [-HasSenderOverride ] + [-HeaderContainsMessageHeader ] + [-HeaderContainsWords ] + [-HeaderMatchesMessageHeader ] + [-HeaderMatchesPatterns ] + [-IncidentReportContent ] + [-IncidentReportOriginalMail ] + [-LogEventText ] + [-ManagerAddresses ] + [-ManagerForEvaluatedUser ] + [-MessageContainsDataClassifications ] + [-MessageSizeOver ] + [-MessageTypeMatches ] + [-Mode ] + [-ModerateMessageByManager ] + [-ModerateMessageByUser ] + [-NotifySender ] + [-PrependSubject ] + [-Priority ] + [-Quarantine ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientAddressContainsWords ] + [-RecipientAddressMatchesPatterns ] + [-RecipientAddressType ] + [-RecipientDomainIs ] + [-RecipientInSenderList ] + [-RedirectMessageTo ] + [-RejectMessageEnhancedStatusCode ] + [-RejectMessageReasonText ] + [-RemoveHeader ] + [-RemoveOME ] + [-RemoveOMEv2 ] + [-RemoveRMSAttachmentEncryption ] + [-RouteMessageOutboundConnector ] + [-RouteMessageOutboundRequireTls ] + [-RuleErrorAction ] + [-RuleSubType ] + [-SCLOver ] + [-SenderADAttributeContainsWords ] + [-SenderADAttributeMatchesPatterns ] + [-SenderAddressLocation ] + [-SenderDomainIs ] + [-SenderInRecipientList ] + [-SenderIpRanges ] + [-SenderManagementRelationship ] + [-SentTo ] + [-SentToMemberOf ] + [-SentToScope ] + [-SetAuditSeverity ] + [-SetHeaderName ] + [-SetHeaderValue ] + [-SetSCL ] + [-SmtpRejectMessageRejectStatusCode ] + [-SmtpRejectMessageRejectText ] + [-StopRuleProcessing ] + [-SubjectContainsWords ] + [-SubjectMatchesPatterns ] + [-SubjectOrBodyContainsWords ] + [-SubjectOrBodyMatchesPatterns ] + [-UseLegacyRegex ] + [-WhatIf] + [-WithImportance ] + [] +``` + +## 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-TransportRule "Ethical Wall - Sales and Brokerage Departments" -BetweenMemberOf1 "Sales Department" -BetweenMemberOf2 "Brokerage Department" -ExceptIfFrom "Tony Smith","Pilar Ackerman" -ExceptIfSubjectContainsWords "Press Release","Corporate Communication" -RejectMessageReasonText "Messages sent between the Sales and Brokerage departments are strictly prohibited." +``` + +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. +- 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 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivationDate +The ActivationDate parameter specifies when the rule starts processing messages. The rule won't take any action on messages until the specified date/time. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ADComparisonAttribute +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ADComparisonAttribute parameter specifies a condition that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +If you don't use the ADComparisonOperator parameter, the default comparison operator Equal is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ADComparisonOperator +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is 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) +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddManagerAsRecipientType +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The AddManagerAsRecipientType parameter specifies an action that delivers or redirects messages to the user that's defined in the sender's Manager attribute. Valid values are: + +- To: Add the sender's manager to the To field of the message. +- Cc: Add the sender's manager to the Cco field of the message. +- Bcc: Add the sender's manager to the Bcc field of the message. +- Redirect: Redirect the message to the sender's manager without notifying the sender or the recipients. + +This action only works if the sender's Manager attribute is defined. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddToRecipients +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. + +The AddToRecipients parameter specifies an action that adds recipients to the To field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfCcHeader +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfCcHeader parameter specifies a condition that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfCcHeaderMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +This parameter specifies a condition or 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. + +The AnyOfRecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +This parameter specifies a condition or 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. + +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToCcHeader +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToCcHeader parameter specifies a condition that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToCcHeaderMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToHeader +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToHeader parameter specifies a condition that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToHeaderMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyClassification +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyClassification parameter specifies an action that applies a message classification to messages. Use the Get-MessageClassification cmdlet to see the message classification objects that are available. + +The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the data loss prevention (DLP) data classification. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimerFallbackAction +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: + +- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. + + If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. + + If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. + + In Microsoft 365, don't use this value in rules that affect incoming messages from external senders. Use the value Reject instead. The effects of the value Wrap interfere with Safe Attachments scanning of messages from external senders. + +- Ignore: The rule is ignored and the original message is delivered without the disclaimer. +- Reject: The original message is returned to the sender in an NDR. + +If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimerLocation +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is 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. +- 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimerText +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. + +This parameter also supports the following tokens that use values from the sender: + +- %%City%% +- %%Company%% +- %%CountryOrRegion%% +- %%Department%% +- %%DisplayName%% +- %%Fax%% +- %%FirstName%% +- %%HomePhone%% +- %%Initials%% +- %%LastName%% +- %%Manager%% +- %%MobilePhone%% +- %%Notes%% +- %%Office%% +- %%Pager%% +- %%Phone%% +- %%PostalCode%% +- %%PostOfficeBox%% +- %%StateOrProvince%% +- %%StreetAddress%% +- %%Title%% +- %%UserPrincipalName%% +- %%WindowsEmailAddress%% + +The maximum number of characters is 5000. + +You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyOME +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The ApplyOME parameter specifies an action that encrypts messages and their attachments by using Microsoft Purview Message Encryption. Valid values are: + +- $true: The message and attachments are encrypted. +- $false: The message and attachments aren't encrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyRightsProtectionCustomizationTemplate +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The ApplyRightsProtectionCustomizationTemplate parameter specifies an action that applies a custom branding template for OME encrypted messages. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: OMEConfigurationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyRightsProtectionTemplate +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyRightsProtectionTemplate parameter specifies an action that applies rights management service (RMS) templates to messages. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). + +To use this action, you need to have an Active Directory Rights Management Services (AD RMS) server in your organization, or your organization needs to use the ILS service. + +Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. + +For more information, see [Transport protection rules](https://learn.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentContainsWords parameter specifies a condition 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentExtensionMatchesWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentExtensionMatchesWords parameter specifies a condition that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. + +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentHasExecutableContent +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentHasExecutableContent parameter specifies a condition that inspects messages where an attachment is an executable file. Valid values are: + +- $true: Look for executable content in message attachments. +- $false: Don't look for executable content in message attachments. + +The system inspects the file properties rather than relying on the file's extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsPasswordProtected +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: + +- $true: Look for password protected attachments. +- $false: Don't look for password protected attachments. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsUnsupported +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Valid values are: + +- $true: Look for unsupported file types in messages. +- $false: Don't look for unsupported file types in messages. + +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). + +```yaml +Type: Boolean +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +Only the first 150 kilobytes (KB) of the attachment is scanned when trying to match a text pattern. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentNameMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentProcessingLimitExceeded +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentProcessingLimitExceeded parameter specifies a condition that looks for messages where attachment scanning didn't complete. Valid values are: + +- $true: Look for messages where attachment scanning didn't complete. +- $false: Don't look for messages where attachment scanning didn't complete. + +You use this condition to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentPropertyContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is 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: + +- Business Impact +- Compliancy +- Confidentiality +- Department +- Impact +- Intellectual Property +- Personally Identifiable Information +- Personal Information +- Personal Use +- Required Clearance +- PHI +- PII +- Project +- Protected Health Information + +The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use leading or trailing spaces. + +When you specify multiple properties, or multiple values for the same property, the or operator is used. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentSizeOver +This parameter specifies a condition or 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. + +The AttachmentSizeOver parameter specifies a condition that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BetweenMemberOf1 +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The BetweenMemberOf1 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BetweenMemberOf2 +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The BetweenMemberOf2 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlindCopyTo +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. + +The BlindCopyTo parameter specifies an action that adds recipients to the Bcc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentCharacterSetContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ContentCharacterSetContainsWords parameter specifies a condition that looks for character set names in 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyTo +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. + +The CopyTo parameter specifies an action that adds recipients to the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteMessage +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. + +The DeleteMessage parameter specifies an action that silently drops messages without an NDR. Valid values are: + +- $true: Silently drop the message without an NDR. +- $false: Don't silently drop the message. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disconnect +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. + +The Disconnect parameter specifies an action that ends the SMTP connection between the sending server and the Edge Transport server without generating an NDR. + +- $true: Silently end the SMTP session without generating an NDR. +- $false: Don't silently end the SMTP session. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPolicy +**Note**: This parameter is functional only in on-premises Exchange. + +The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: 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 +``` + +### -Enabled +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. +- $false: The new rule is disabled. + +To enable or disable a rule after you create it, use the Enable-TransportRule and Disable-TransportRule cmdlets. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfADComparisonAttribute +This parameter specifies an exception or part of an 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 ExceptIfADComparisonAttribute parameter specifies an exception that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +If you don't use the ExceptIfADComparisonOperator parameter, the default comparison operator Equal is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfADComparisonOperator +This parameter specifies an exception or part of an 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) +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfCcHeader +This parameter specifies an exception or part of an 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 ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfCcHeaderMemberOf +This parameter specifies an exception or part of an 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 ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToCcHeader +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToCcHeaderMemberOf +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToHeader +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToHeaderMemberOf +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentContainsWords +This parameter specifies an exception or part of an 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 ExceptIfAttachmentContainsWords parameter specifies an exception 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentExtensionMatchesWords +This parameter specifies an exception or part of an 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 ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. + +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentHasExecutableContent +This parameter specifies an exception or part of an 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 ExceptIfAttachmentHasExecutableContent parameter specifies an exception that inspects messages where an attachment is an executable file. Valid values are: + +- $true: Look for executable content in message attachments. +- $false: Don't look for executable content in message attachments. + +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentIsPasswordProtected +This parameter specifies an exception or part of an 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 ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: + +- $true: Look for password protected attachments. +- $false: Don't look for password protected attachments. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentIsUnsupported +This parameter specifies an exception or part of an 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 ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Valid values are: + +- $true: Look for unsupported file types in messages. +- $false: Don't look for unsupported file types in messages. + +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the ExceptIfAttachmentIsUnsupported exception is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). + +```yaml +Type: Boolean +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +Only the first 150 KB of the attachment is scanned when trying to match a text pattern. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentNameMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentProcessingLimitExceeded +This parameter specifies an exception or part of an 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 ExceptIfAttachmentProcessingLimitExceeded parameter specifies an exception that looks for messages where attachment scanning didn't complete. Valid values are: + +- $true: Look for messages where attachment scanning didn't complete. +- $false: Don't look for messages where attachment scanning didn't complete. + +You use this exception to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentPropertyContainsWords +This parameter specifies an exception or part of an 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: + +- Business Impact +- Compliancy +- Confidentiality +- Department +- Impact +- Intellectual Property +- Personally Identifiable Information +- Personal Information +- Personal Use +- Required Clearance +- PHI +- PII +- Project +- Protected Health Information + +The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use values with leading or trailing spaces. + +When you specify multiple properties, or multiple values for the same property, the or operator is used. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentSizeOver +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfAttachmentSizeOver parameter specifies an exception that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfBetweenMemberOf1 +This parameter specifies an exception or part of an 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 ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfBetweenMemberOf2 +This parameter specifies an exception or part of an 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 ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentCharacterSetContainsWords +This parameter specifies an exception or part of an 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 ExceptIfContentCharacterSetContainsWords parameter specifies an exception that looks for character set names in 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +This parameter specifies an exception or part of an 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 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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfFromAddressContainsWords parameter specifies an exception that looks for words in the sender's email address. You can specify multiple words separated by commas. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception 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"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + +```yaml +Type: Pattern[] +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +This parameter specifies an exception or part of an 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 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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromScope +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasClassification +This parameter specifies an exception or part of an 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 ExceptIfHasClassification parameter specifies an exception that looks for messages with the specified message classification. + +You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: + +`-ExceptIfHasClassification @(Get-MessageClassification "Company Internal").Identity` + +The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP data classification. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasNoClassification +This parameter specifies an exception or part of an 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 ExceptIfHasNoClassification parameter specifies an exception that looks for messages with or without any message classifications. Valid values are: + +- $true: Look for messages that don't have a message classification. +- $false: Look for messages that have one or more message classifications. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasSenderOverride +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available only on Mailbox servers. + +The ExceptIfHasSenderOverride parameter specifies an exception that looks for messages where the sender chose to override a DLP policy. Valid values are: + +- $true: Look for messages where the sender took action to override a DLP policy. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderContainsMessageHeader +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the ExceptIfHeaderContainsWords parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderContainsWords parameter specifies an exception 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. + +You specify the header field to search by using the ExceptIfHeaderContainsMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesMessageHeader +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the ExceptIfHeaderMatchesPatterns parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderMatchesPatterns parameter specifies an exception 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 specify the header field to search by using the ExceptIfHeaderMatchesMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfManagerAddresses +This parameter specifies an exception or part of an 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 ExceptIfManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You specify if you want to look for these users as managers of senders or recipients by using the ExceptIfManagerForEvaluatedUser parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfManagerForEvaluatedUser +This parameter specifies an exception or part of an 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 ExceptIfManagerForEvaluatedUser parameter specifies an exception that looks for users in the Manager attribute of senders or recipients. Valid values are: + +- Recipient: The user is the manager of a recipient. +- Sender: The user is the manager of the sender. + +You specify the users to look for by using the ExceptIfManagerAddresses parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageContainsDataClassifications +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available only on Mailbox servers. + +The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. + +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. + +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). + +```yaml +Type: Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageSizeOver +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfMessageSizeOver parameter specifies an exception that looks for messages larger than the specified size. The size includes the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageTypeMatches +This parameter specifies an exception or part of an 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 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. +- 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). +- Voicemail: Voice mail messages forwarded by Unified Messaging service. +- Signed: Digitally signed messages. +- ApprovalRequest: Moderation request messages sent to moderators. +- ReadReceipt: Read receipts. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeContainsWords +This parameter specifies an exception or part of an 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 ExceptIfRecipientADAttributeContainsWords parameter specifies an exception that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientAddressContainsWords +This parameter specifies an exception or part of an 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 ExceptIfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientAddressMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +This parameter specifies an exception or part of an 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 ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientInSenderList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSCLOver +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: + +- -1: The message is from a trusted sender, so the message bypasses spam filtering. +- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. + +The rule looks for messages with an SCL value that's greater than or equal to the specified value. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeContainsWords +This parameter specifies an exception or part of an 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 ExceptIfSenderADAttributeContainsWords parameter specifies an exception that looks for words in Active Directory attributes of message senders. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in Active Directory attributes of message senders by using regular expressions. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +This parameter specifies an exception or part of an 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 ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. + +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderInRecipientList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderIpRanges +This parameter specifies an exception or part of an 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 ExceptIfSenderIpRanges parameter specifies an exception that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderManagementRelationship +This parameter specifies an exception or part of an 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 ExceptIfSenderManagementRelationship parameter specifies an exception that looks for the relationship between the sender and recipients in messages. Valid values are: + +- Manager: The sender is the manager of a recipient. +- DirectReport: A recipient is the manager of the sender. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +This parameter specifies an exception or part of an 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 ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +This parameter 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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToScope +This parameter specifies an exception or part of an 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 ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. + +```yaml +Type: ToUserScope +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectContainsWords parameter specifies an exception that looks for words in the Subject field of messages. + +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. + +```yaml +Type: Word[] +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectMatchesPatterns parameter specifies an exception 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception that looks for words in the Subject field or body of messages. + +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. + +```yaml +Type: Word[] +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfWithImportance +This parameter specifies an exception or part of an 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 ExceptIfWithImportance parameter specifies an exception that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDate +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +This parameter specifies a condition or 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. + +The FromAddressContainsWords parameter specifies a condition that looks for words in the sender's email address. You can specify multiple words separated by commas. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +This parameter specifies a condition or 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. + +The FromAddressMatchesPatterns parameter specifies a condition 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"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + +```yaml +Type: Pattern[] +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromScope +This parameter specifies a condition or 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. + +The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateIncidentReport +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The GenerateIncidentReport parameter specifies where to send the incident report that's defined by the IncidentReportContent parameter. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +**Note**: An incident report isn't generated for notifications or other incident reports that are generated by DLP or mail flow rules. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateNotification +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The GenerateNotification parameter specifies an action that sends a notification message to recipients that match the conditions of the rule. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. Each matched recipient receives a separate notification. + +This parameter supports plain text, HTML tags and the following keywords that use values from the original message: + +- %%From%% +- %%To%% +- %%Cc%% +- %%Subject%% +- %%Headers%% +- %%MessageDate%% + +The maximum number of characters is 5120. + +```yaml +Type: DisclaimerText +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasClassification +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The HasClassification parameter specifies a condition that looks for messages with the specified message classification. + +You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: + +`-HasClassification @(Get-MessageClassification "Company Internal").Identity` + +The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP classification. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasNoClassification +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The HasNoClassification parameter specifies a condition that looks for messages with or without any message classifications. Valid values are: + +- $true: Look for messages that don't have a message classification. +- $false: Look for messages that have one or more message classifications. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSenderOverride +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The HasSenderOverride parameter specifies a condition that looks for messages where the sender chose to override a DLP policy. Valid values are: + +- $true: Look for messages where the sender took action to override a DLP policy. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderContainsMessageHeader +This parameter specifies a condition or 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. + +The HeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the HeaderContainsWords parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderContainsWords +This parameter specifies a condition or 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. + +The HeaderContainsWords parameter specifies a condition 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. + +You specify the header field to search by using the HeaderContainsMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesMessageHeader +This parameter specifies a condition or 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. + +The HeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the HeaderMatchesPatterns parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +This parameter specifies a condition or 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. + +The HeaderMatchesPatterns parameter specifies a condition 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 specify the header field to search by using the HeaderMatchesMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentReportContent +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is 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. +- 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. +- 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. +- IdMatch: The sensitive information type that was detected, the exact matched content from the message, and the 150 characters before and after the matched sensitive information. +- AttachOriginalMail: The entire original message as an attachment. + +The message ID is always included in the incident report. + +You can specify multiple values separated by commas. + +You use this parameter with the GenerateIncidentReport parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentReportOriginalMail +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 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: + +- IncludeOriginalMail +- DoNotIncludeOriginalMail (this is the default value) + +```yaml +Type: IncidentReportOriginalMail +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogEventText +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. + +The LogEventText parameter specifies an action that creates an entry in the Application log on the local Edge Transport server. The value for this parameter specifies the text that you want to include in the event log entry. If the text contains spaces, enclose the value in quotation marks ("). + +The entry contains the following information: + +- Level: Information +- Source: MSExchange Messaging Policies +- Event ID: 4000 +- Task Category: Rules +- EventData: `The following message is logged by an action in the rules: ` + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagerAddresses +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You specify if you want to look for these users as managers of senders or recipients by using the ManagerForEvaluatedUser parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagerForEvaluatedUser +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ManagerForEvaluatedUser parameter specifies a condition that looks for users in the Manager attribute of senders or recipients. Valid values are: + +- Recipient: The user is the manager of a recipient. +- Sender: The user is the manager of the sender. + +You specify the users to look for by using the ManagerAddresses parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageContainsDataClassifications +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. + +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. + +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). + +You can specify the notification options by using the NotifySender parameter. + +```yaml +Type: Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageSizeOver +This parameter specifies a condition or 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. + +The MessageSizeOver parameter specifies a condition that looks for messages larger than the specified size. The size includes the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTypeMatches +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is 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. +- 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). +- Voicemail: Voice mail messages forwarded by Unified Messaging service. +- Signed: Digitally signed messages. +- ApprovalRequest: Moderation request messages sent to moderators. +- ReadReceipt: Read receipts. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies how the rule operates. Valid values are: + +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. +- Enforce: All actions specified in the rule are taken. This is the default value. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerateMessageByManager +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ModerateMessageByManager parameter specifies an action that forwards messages for approval to the user that's specified in the sender's Manager attribute. After the manager approves the message, it's delivered to the recipients. Valid values are: + +- $true: Moderation by the sender's manager is enabled. +- $false: Moderation by the sender's manager is disabled. + +This action only works if the sender's Manager attribute is defined. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerateMessageByUser +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ModerateMessageByUser parameter specifies an action that forwards messages for approval to the specified users. After one of the users approves the message, it's delivered to the recipients. You can use ay value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use a distribution group as a moderator. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifySender +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The NotifySender parameter specifies an action that notifies the sender when messages violate DLP policies. Valid values are: + +- NotifyOnly: The sender is notified, but the message is delivered normally. +- RejectMessage: The message is rejected, and the sender is notified. +- RejectUnlessFalsePositiveOverride: The message is rejected unless it's marked as a false positive by the sender. +- RejectUnlessSilentOverride: The message is rejected unless the sender has chosen to override the policy restriction. +- RejectUnlessExplicitOverride: This is the same as RejectUnlessSilentOverride, but the sender can also provide a justification for overriding the policy restriction. + +For all values except NotifyOnly, you can specify an enhanced status code and a rejection reason by using the RejectMessageEnhancedStatusCode and RejectMessageReasonText parameters. The default enhanced status code is 5.7.1, and the default rejection reason is Delivery not authorized, message refused. + +If you use this parameter, you also need to specify a condition that looks for sensitive information types in messages by using the MessageContainsDataClassifications parameter. + +This action is applicable to messages sent by internal users only. External senders will not receive notifications. + +```yaml +Type: NotifySenderType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrependSubject +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. + +The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). + +Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quarantine +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Edge Transport servers. + +The Quarantine parameter specifies an action that quarantines messages. + +- In on-premises Exchange, messages are delivered to the quarantine mailbox that you've configured as part of Content filtering. If the quarantine mailbox isn't configured, the message is returned to the sender in an NDR. +- In Microsoft 365, messages are delivered to the hosted quarantine. + +If this action is in a rule that's not the last rule in the list, rule evaluation stops after this rule is run. When the message is released from quarantine, the remaining rules in the list aren't evaluated. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientADAttributeContainsWords parameter specifies a condition that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddressContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddressMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddressType +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. + +```yaml +Type: RecipientAddressType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +This parameter specifies a condition or 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 RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientInSenderList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectMessageTo +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. + +The RedirectMessageTo parameter specifies a rule action that redirects messages to the specified recipients. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessageEnhancedStatusCode +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 RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999. + +You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). + +If you use this parameter with the RejectMessageReasonText parameter, the enhanced status code value is set to 5.7.1. + +To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessageReasonText +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). + +In Exchange 2013 or later, the maximum number of characters is 256. + +In the cloud-based service, the maximum number of characters is 1024. + +You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). + +If you use this parameter with the RejectMessageEnhancedStatusCode parameter, the custom explanation text value is set to "Delivery not authorized, message refused". + +To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveHeader +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. + +The RemoveHeader parameter specifies an action that removes a header field from the message header. The value of this parameter specifies the name of the header field to remove. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOME +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveOME parameter specifies an action that removes the previous version of Microsoft Purview Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $false: The message and attachments aren't decrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOMEv2 +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveOMEv2 parameter specifies an action that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $false: The message and attachments aren't decrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveRMSAttachmentEncryption +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveRMSAttachmentEncryption parameter specifies an action that removes Microsoft Purview Message Encryption from encrypted attachments in email. The attachments were already encrypted before they were attached to the message. The message itself doesn't need to be encrypted. Valid values are: + +- $true: The encrypted attachments are decrypted. +- $false: The encrypted attachments aren't decrypted. + + This parameter also requires the value $true for the RemoveOMEv2 parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteMessageOutboundConnector +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RouteMessageOutboundConnector parameter specifies an action that routes messages through the specified Outbound connector in Microsoft 365. You can use any value that uniquely identifies the connector. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: OutboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteMessageOutboundRequireTls +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The RouteMessageOutboundRequireTls parameter specifies an action that uses Transport Layer Security (TLS) encryption to deliver messages outside your organization. Valid values are: + +- $true: The messages must be delivered over a TLS encrypted channel. +- $false: A TLS encrypted channel isn't required to deliver the messages. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSubType +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SCLOver +This parameter specifies a condition or 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. + +The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: + +- -1: The message is from a trusted sender, so the message bypasses spam filtering. +- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. + +The rule looks for messages with an SCL value that's greater than or equal to the specified value. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderADAttributeContainsWords parameter specifies a condition that looks for words in Active Directory attributes of message senders. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in Active Directory attributes of message senders by using regular expressions. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers. For example, in on-premises Exchange the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +Message envelope searching is available only for the following conditions and exceptions: + +- From and ExceptIfFrom +- FromAddressContainsWords and ExceptIfFromAddressContainsWords +- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns +- FromMemberOf and ExceptIfFromMemberOf +- SenderDomainIs and ExceptIfSenderDomainIs + +```yaml +Type: SenderAddressLocation +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. + +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderInRecipientList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIpRanges +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderIpRanges parameter specifies a condition that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderManagementRelationship +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderManagementRelationship parameter specifies a condition that looks for the relationship between the sender and recipients in messages. Valid values are: + +- Manager: The sender is the manager of a recipient. +- DirectReport: A recipient is the manager of the sender. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToScope +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. + +```yaml +Type: ToUserScope +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetAuditSeverity +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The SetAuditSeverity parameter specifies an action that sets the severity level of the incident report and the corresponding entry that's written to the message tracking log when messages violate DLP policies. Valid values are: + +- DoNotAudit: No audit entry is logged. +- Low: The audit entry is assigned low severity. +- Medium: The audit entry is assigned medium severity. +- High: The audit entry is assigned high severity. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetHeaderName +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. + +The SetHeaderName parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the name of the header field that you want to add or modify. When you use this parameter, you also need to use the SetHeaderValue parameter to specify a value for the header. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetHeaderValue +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. + +The SetHeaderValue parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the value that you want to apply to the header field. When you use this parameter, you also need to use the SetHeaderName parameter to specify the name of the header field that you want to add or modify. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetSCL +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. + +The SetSCL parameter specifies an action that adds or modifies the SCL value of messages. Valid values are: + +- -1: The message is from a trusted sender, so the message bypasses spam filtering. +- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpRejectMessageRejectStatusCode +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. + +The SmtpRejectMessageRejectStatusCode parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the SMTP code that's used. Valid values are the integers 400 through 500. + +You can use this parameter with the SmtpRejectMessageRejectText parameter. If you don't use this parameter, the default SMTP code 550 is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpRejectMessageRejectText +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. + +The SmtpRejectMessageRejectText parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the explanation text that's used. If the value contains spaces, enclose the value in quotation marks ("). + +You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. If you don't use this parameter, the default text Delivery not authorized, message refused is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopRuleProcessing +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. + +The StopRuleProcessing parameter specifies an action that stops processing more rules. Valid values are: + +- $true: Stop processing more rules. +- $false: Continue processing more rules after this one. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectContainsWords +This parameter specifies a condition or 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. + +The SubjectContainsWords parameter specifies a condition that looks for words 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. + +The maximum length of this parameter is 128 characters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +This parameter specifies a condition or 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. + +The SubjectMatchesPatterns parameter specifies a condition 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyContainsWords +This parameter specifies a condition or 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. + +The SubjectOrBodyContainsWords parameter specifies a condition that looks for words 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. + +The maximum length of this parameter is 128 characters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyMatchesPatterns +This parameter specifies a condition or 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. + +The SubjectOrBodyMatchesPatterns parameter specifies a condition 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLegacyRegex +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. +- $false: Regular expression syntax that's compatible with Exchange 2013 or later. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WithImportance +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The WithImportance parameter specifies a condition that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-UMAutoAttendant.md b/exchange/exchange-ps/exchange/New-UMAutoAttendant.md new file mode 100644 index 0000000000..7f9922c4c4 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UMAutoAttendant.md @@ -0,0 +1,225 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UMAutoAttendant + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-UMAutoAttendant cmdlet to create a Unified Messaging (UM) auto attendant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UMAutoAttendant [-Name] -UMDialPlan + [-Confirm] + [-DomainController ] + [-DTMFFallbackAutoAttendant ] + [-PilotIdentifierList ] + [-SpeechEnabled ] + [-Status ] +``` + +## DESCRIPTION +The New-UMAutoAttendant cmdlet creates one or more UM auto attendants. UM auto attendants have a forest-wide scope in the configuration container in Active Directory. When you create a UM auto attendant, the auto attendant isn't speech-enabled or able to answer incoming calls by default. The auto attendant is linked to a single UM dial plan that contains a list of extension numbers. Linking the UM auto attendant to the UM dial plan enables the associated Mailbox servers to answer incoming calls using the UM auto attendant. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-UMAutoAttendant -Name MyUMAutoAttendant -UMDialPlan MyUMDialPlan -PilotIdentifierList 55000 -Status Enabled +``` + +This example creates the UM auto attendant MyUMAutoAttendant that can accept incoming calls using the extension number 55000 but isn't speech-enabled. + +### Example 2 +```powershell +New-UMAutoAttendant -Name MyUMAutoAttendant -UMDialPlan MyUMDialPlan -PilotIdentifierList 56000,56100 -SpeechEnabled $true -Status Enabled +``` + +This example creates the speech-enabled UM auto attendant MyUMAutoAttendant using the extension numbers 56000 and 56100 that can accept incoming calls. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DTMFFallbackAutoAttendant +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PilotIdentifierList +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeechEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status parameter specifies whether the UM auto attendant being created will be enabled. Valid values are: + +- Enabled +- Disabled (This is the default value) + +```yaml +Type: StatusEnum +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md new file mode 100644 index 0000000000..4fa9e1f46e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md @@ -0,0 +1,369 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UMCallAnsweringRule + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-UMCallAnsweringRule cmdlet to create a call answering rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UMCallAnsweringRule -Name + [-CallerIds ] + [-CallersCanInterruptGreeting ] + [-CheckAutomaticReplies ] + [-Confirm] + [-DomainController ] + [-ExtensionsDialed ] + [-KeyMappings ] + [-Mailbox ] + [-Priority ] + [-ScheduleStatus ] + [-TimeOfDay ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-UMCallAnsweringRule cmdlet creates a Unified Messaging (UM) call answering rule stored in a UM-enabled user's mailbox. You can run the cmdlet and create a call answering rule of the user that's logged on or use the Mailbox parameter to specify the mailbox where you want the call answering rule to be created. You can use the New-UMCallAnsweringRule cmdlet to specify the following conditions: + +- Who the incoming call is from +- Time of day +- Calendar free/busy status +- Whether automatic replies are turned on for email + +You can also specify the following actions: + +- Find me +- Transfer the caller to someone else +- Leave a voice message + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-UMCallAnsweringRule -Mailbox tonysmith -Name MyCallAnsweringRule -Priority 2 +``` + +This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith with the priority of 2. + +### Example 2 +```powershell +New-UMCallAnsweringRule -Name MyCallAnsweringRule -CallerIds "1,4255550100,,","1,4255550123,," -Priority 2 -CallersCanInterruptGreeting $true -Mailbox tonysmith +``` + +This example creates the following actions on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith: + +- Sets the call answering rule to two caller IDs. +- Sets the priority of the call answering rule to 2. +- Sets the call answering rule to allow callers to interrupt the greeting. + +### Example 3 +```powershell +New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith@contoso.com -ScheduleStatus 0x8 +``` + +This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith that sets the free/busy status to Out of Office and sets the priority to 2. + +### Example 4 +```powershell +New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -ScheduleStatus 0x4 - -KeyMappings "1,1,Receptionist,,,,,45678,","5,2,Urgent Issues,23456,23,45671,50,," +``` + +This example creates the call answering rule MyCallAnsweringRule in the mailbox tonysmith and performs the following actions: + +- 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: + +- 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. + +### Example 5 +```powershell +New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "1,0,," +``` + +This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith and performs the following actions: + +- Sets the priority of the call answering rule to 2. +- If the caller reaches voice mail during working hours, the caller is asked to call back later. + +### Example 6 +```powershell +New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "3,4,8:00,12:00" +``` + +This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith with a custom period for the time of day and performs the following actions: + +- Sets the priority of the call answering rule to 2. +- If the caller reaches voice mail and the time is between 8:00 A.M. and 12:00 P.M. on Tuesday, ask the caller to call back later. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallerIds +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallersCanInterruptGreeting +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckAutomaticReplies +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionsDialed +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyMappings +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is created. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the mailbox of the user who is running the command is used. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStatus +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 +- Free = 0x1 +- Tentative = 0x2 +- Busy = 0x4 +- OutOfOffice = 0x8 + +The default setting is $null. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeOfDay +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMDialPlan.md b/exchange/exchange-ps/exchange/New-UMDialPlan.md new file mode 100644 index 0000000000..5b47dbb7ad --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UMDialPlan.md @@ -0,0 +1,281 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UMDialPlan + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-UMDialPlan cmdlet to create a Unified Messaging (UM) dial plan to establish a link between UM IP gateways, UM hunt groups, and Mailbox servers to enable communication between Unified Messaging components. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UMDialPlan [-Name] -CountryOrRegionCode -NumberOfDigitsInExtension + [-AccessTelephoneNumbers ] + [-Confirm] + [-DefaultLanguage ] + [-DomainController ] + [-FaxEnabled ] + [-GenerateUMMailboxPolicy ] + [-URIType ] + [-VoIPSecurity ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-UMDialPlan cmdlet creates a UM dial plan in Active Directory. A UM dial plan object has an organization-wide scope and contains all configuration information related to a telephony dial plan. A UM dial plan is a required component for establishing Unified Messaging communications with Microsoft Exchange. When you create a UM dial plan, an understanding of telephony configurations and the implications of adding to or modifying a UM configuration is required. + +After the new UM dial plan is created, a UM IP gateway and a Mailbox server must be associated with the UM dial plan to enable Unified Messaging operations. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-UMDialPlan -Name MyUMDialPlan -NumberOfDigitsInExtension 4 +``` + +This example creates the UM dial plan MyUMDialPlan that uses four-digit extension numbers. + +### Example 2 +```powershell +New-UMDialPlan -Name MyUMDialPlan -URIType SipName -NumberOfDigitsInExtension 5 +``` + +This example creates the UM dial plan MyUMDialPlan that uses five-digit extension numbers that support SIP URIs. + +### Example 3 +```powershell +New-UMDialPlan -Name MyUMDialPlan -URIType E164 -NumberOfDigitsInExtension 5 -VoIPSecurity Unsecured +``` + +This example creates the unsecured UM dial plan MyUMDialPlan that supports E.164 numbers and that uses five-digit extension numbers. + +## PARAMETERS + +### -Name +The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegionCode +The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America and 44 is the code used for the United Kingdom. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfDigitsInExtension +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessTelephoneNumbers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultLanguage +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FaxEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateUMMailboxPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -URIType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoIPSecurity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMHuntGroup.md b/exchange/exchange-ps/exchange/New-UMHuntGroup.md new file mode 100644 index 0000000000..c471f60d1e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UMHuntGroup.md @@ -0,0 +1,187 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UMHuntGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-UMHuntGroup cmdlet to create a Unified Messaging (UM) hunt group used to link incoming calls to a specific UM dial plan. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UMHuntGroup [-Name] -UMDialPlan -UMIPGateway + [-Confirm] + [-DomainController ] + [-PilotIdentifier ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-UMHuntGroup cmdlet creates a UM hunt group in Active Directory. Running this cmdlet enables all Mailbox servers associated with UM dial plans to communicate with an IP gateway. A UM hunt group must be created to allow communication between a UM IP gateway and a UM dial plan. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-UMHuntGroup -Name MyUMHuntGroup -PilotIdentifier 12345 -UMDialPlan MyUMDialPlan -UMIPGateway MyUMIPGateway +``` + +This example creates the UM hunt group MyUMHuntGroup that has a pilot identifier of 12345. + +### Example 2 +```powershell +New-UMHuntGroup -Name MyUMHuntGroup -PilotIdentifier 5551234,55555 -UMDialPlan MyUMDialPlan -UMIPGateway MyUMIPGateway +``` + +This example creates the UM hunt group MyUMHuntGroup that has multiple pilot identifiers. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMIPGateway +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PilotIdentifier +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMIPGateway.md b/exchange/exchange-ps/exchange/New-UMIPGateway.md new file mode 100644 index 0000000000..3e03d94273 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UMIPGateway.md @@ -0,0 +1,201 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UMIPGateway + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-UMIPGateway cmdlet to create a Unified Messaging (UM) IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP gateway or a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UMIPGateway [-Name] -Address + [-Confirm] + [-DomainController ] + [-IPAddressFamily ] + [-UMDialPlan ] + [-WhatIf] + [] +``` + +## DESCRIPTION +A UM IP gateway has organization-wide scope and references a single physical IP gateway. The UM IP gateway that's created is used to establish a connection to an IP gateway or a SIP-enabled IP PBX. After this task is completed, a new UM IP gateway is created. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 +``` + +This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox server to start accepting calls from an IP gateway with an IP address of 10.10.10.1. + +### Example 2 +```powershell +New-UMIPGateway -Identity MyUMIPGateway -Address fe80::39bd:88f7:6969:d223%11 -IPAddressFamily Any +``` + +This example creates the UM IP gateway MyUMIPGateway with an IPv6 address and allows the UM IP gateway to use IPv4 and IPV6 addresses. + +### Example 3 +```powershell +New-UMIPGateway -Identity MyUMIPGateway -Address "MyUMIPGateway.contoso.com" +``` + +This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox server to start accepting calls from an IP gateway with an FQDN of MyUMIPGateway.contoso.com. + +## PARAMETERS + +### -Name +The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Address +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: IPAddressFamily +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md new file mode 100644 index 0000000000..3ab4d1f26f --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md @@ -0,0 +1,147 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UMMailboxPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-UMMailboxPolicy cmdlet to create a Unified Messaging (UM) mailbox policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UMMailboxPolicy [-Name] -UMDialPlan + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The New-UMMailboxPolicy cmdlet creates a UM mailbox policy that has organization-wide scope. UM mailbox policies provide a set of policy values to be applied to UM-enabled users associated with a particular UM dial plan. UM mailbox policies are directly associated with UM dial plans. Therefore, the settings contained within a UM mailbox policy apply only to UM-enabled users of the UM dial plan that the UM mailbox policy is associated with. You can also use the New-UMMailboxPolicy cmdlet to create a UM mailbox policy template that can be used to create additional UM mailbox policies. + +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). + +## EXAMPLES + +### Example 1 +```powershell +New-UMMailboxPolicy -Name MyUMMailboxPolicy -UMDialPlan MyUMDialPlan +``` + +This example creates the UM mailbox policy MyUMMailboxPolicy associated with the UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDialPlan +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md new file mode 100644 index 0000000000..2196b0f833 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md @@ -0,0 +1,232 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UnifiedAuditLogRetentionPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-UnifiedAuditLogRetentionPolicy cmdlet to create audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-UnifiedAuditLogRetentionPolicy [-Name] -Priority -RetentionDuration + [-Confirm] + [-Description ] + [-Operations ] + [-RecordTypes ] + [-UserIds ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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-UnifiedAuditLogRetentionPolicy -Name "Microsoft Teams Audit Policy" -Description "One year retention policy for all Microsoft Teams activities" -RecordTypes MicrosoftTeams -RetentionDuration TwelveMonths -Priority 100 +``` + +This example creates an audit log retention policy that retains all audit logs related to Microsoft Teams events for one year. + +### Example 2 +```powershell +New-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Description "90 day retention policy for noisy SharePoint events" -RecordTypes SharePoint -Operations SearchQueryPerformed -UserIds "app@sharepoint" -RetentionDuration ThreeMonths -Priority 10000 +``` + +This example creates an audit log retention policy that retains all audit logs for the SearchQueryPerformed activity performed by the app@sharepoint service account for 90 days. + +## PARAMETERS + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a lower priority. The value 1 is the highest priority, and the value 10000 is the lowest priority. No two policies can have the same priority value. + +This parameter is required when you create an audit log retention policy, and you must use a unique priority value. + +Any custom audit log retention policy that you create will take precedence over the default audit log retention policy. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: + +- ThreeMonths +- SixMonths +- NineMonths +- TwelveMonths +- TenYears + +```yaml +Type: UnifiedAuditLogRetentionDuration +Parameter Sets: (All) +Aliases: +Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears +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 +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operations +The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/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"`. + +If you use this parameter, you must also use the RecordTypes parameter to specify the record type. You can't use this parameter if you've specified more than one value for the RecordTypes parameter. + +```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 +``` + +### -RecordTypes +The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://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. + +```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 +``` + +### -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. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-UnifiedGroup.md b/exchange/exchange-ps/exchange/New-UnifiedGroup.md new file mode 100644 index 0000000000..7490a242d1 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-UnifiedGroup.md @@ -0,0 +1,721 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# New-UnifiedGroup + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-UnifiedGroup cmdlet to create Microsoft 365 Groups in your cloud-based organization. To add members, owners, and subscribers to Microsoft 365 Groups, use the Add-UnifiedGroupLinks cmdlet. + +**Note**: You can't use this cmdlet to create Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see [Create group](https://learn.microsoft.com/graph/api/group-post-groups). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +New-UnifiedGroup [-DisplayName ] + [-AccessType ] + [-MailboxRegion ] + [-Alias ] + [-AlwaysSubscribeMembersToCalendarEvents] + [-AutoSubscribeNewMembers] + [-Classification ] + [-Confirm] + [-DataEncryptionPolicy ] + [-EmailAddresses ] + [-ExecutingUser ] + [-ExoErrorAsWarning] + [-HiddenGroupMembershipEnabled] + [-IsMemberAllowedToEditContent ] + [-Language ] + [-ManagedBy ] + [-Members ] + [-Name ] + [-Notes ] + [-Owner ] + [-PrimarySmtpAddress ] + [-RequireSenderAuthenticationEnabled ] + [-SensitivityLabelId ] + [-SuppressWarmupMessage] + [-WhatIf] + [] +``` + +### ProvisioningOptions +``` +New-UnifiedGroup [-DisplayName ] + [-AccessType ] + [-Alias ] + [-AlwaysSubscribeMembersToCalendarEvents] + [-AutoSubscribeNewMembers] + [-Classification ] + [-Confirm] + [-DataEncryptionPolicy ] + [-EmailAddresses ] + [-ExecutingUser ] + [-ExoErrorAsWarning] + [-HiddenGroupMembershipEnabled] + [-Language ] + [-ManagedBy ] + [-Members ] + [-Name ] + [-Notes ] + [-Owner ] + [-PrimarySmtpAddress ] + [-RequireSenderAuthenticationEnabled ] + [-SensitivityLabelId ] + [-SuppressWarmupMessage] + [-WhatIf] + [] +``` + +### SegmentationOption +``` +New-UnifiedGroup [-DisplayName ] + [-SubscriptionEnabled] + [-AccessType ] + [-Alias ] + [-AlwaysSubscribeMembersToCalendarEvents] + [-AutoSubscribeNewMembers] + [-Classification ] + [-Confirm] + [-DataEncryptionPolicy ] + [-EmailAddresses ] + [-ExecutingUser ] + [-ExoErrorAsWarning] + [-HiddenGroupMembershipEnabled] + [-Language ] + [-ManagedBy ] + [-Members ] + [-Name ] + [-Notes ] + [-Owner ] + [-PrimarySmtpAddress ] + [-RequireSenderAuthenticationEnabled ] + [-SensitivityLabelId ] + [-SuppressWarmupMessage] + [-WhatIf] + [] +``` + +### DlMigration +``` +New-UnifiedGroup -DlIdentity + [-ConvertClosedDlToPrivateGroup] + [-DeleteDlAfterMigration] + [-Confirm] + [-ExecutingUser ] + [-ManagedBy ] + [-Members ] + [-Owner ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +New-UnifiedGroup -DisplayName "Engineering Department" -Alias "engineering" +``` + +This example creates a new Microsoft 365 Group named Engineering Department. + +## PARAMETERS + +### -DisplayName +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. + +```yaml +Type: String +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlIdentity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +All the properties and membership of the distribution group are copied to the Microsoft 365 Group. + +The alias and proxy addresses of the distribution group are moved to the Microsoft 365 Group, and are replaced on the distribution group by the values `DLMigrated_`. The original proxy addresses are copied to the ExtensionCustomAttribute5 property of the distribution group. + +Microsoft 365 Groups don't have ReportToManager and ReportToOriginator parameters, so the values of these parameters aren't migrated from the distribution group to the Microsoft 365 Group. The Microsoft 365 Group behaves as if the default values of these parameters were set (ReportToManager is $false and ReportToOriginator is $true). In other words, delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the message sender and not to the owner of the Microsoft 365 Group. + +```yaml +Type: DistributionGroupIdParameter +Parameter Sets: DlMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType +The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: + +- Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. This is the default value. +- Private: The group content and conversations are 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. + +**Note**: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. + +```yaml +Type: ModernGroupTypeInfo +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the 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: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +If you don't use the Alias parameter when you create a Microsoft 365 Group, the value of the DisplayName parameter is used for the Alias value. Spaces are removed, unsupported characters are converted to question marks (?), and numbers may be added to maintain the uniqueness of the Alias value. + +When you create a Microsoft 365 Group without using the EmailAddresses parameter, the Alias value is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +The Alias value is appended with the ExternalDirectoryObjectId property value and used as the Name property value for the Microsoft 365 Group (`_`). + +```yaml +Type: String +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlwaysSubscribeMembersToCalendarEvents +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. + +Group members can change their own subscription settings, which can override your intended use of this switch. + +The AutoSubscribeNewMembers switch overrides this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoSubscribeNewMembers +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConvertClosedDlToPrivateGroup +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. + +You can only use this switch with the DlIdentity parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: DlMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPolicy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: Identity, SegmentationOption, ProvisioningOptions +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteDlAfterMigration +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. + +```yaml +Type: SwitchParameter +Parameter Sets: DlMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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 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. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +```yaml +Type: ProxyAddressCollection +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutingUser +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExoErrorAsWarning +The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. + +Creating Microsoft 365 Groups involves background operations in Microsoft Entra ID and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Microsoft Entra ID is synchronized back to Exchange Online. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenGroupMembershipEnabled +The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the Microsoft 365 Group from users who aren't members of the group. You don't need to specify a value with this switch. + +You can use this setting to help comply with regulations that require you to hide group membership from outsiders (for example, a Microsoft 365 Group 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. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMemberAllowedToEditContent +{{ Fill IsMemberAllowedToEditContent Description }} + +```yaml +Type: System.Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +The Language parameter specifies the language preference for the Microsoft 365 Group. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Members +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +This parameter has been deprecated and is 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 (`_`). + +```yaml +Type: String +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Owner +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +```yaml +Type: SmtpAddress +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```yaml +Type: Boolean +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SensitivityLabelId +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. + +```yaml +Type: System.Guid +Parameter Sets: Identity, SegmentationOption, ProvisioningOptions +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressWarmupMessage +This parameter has been deprecated and is no longer used. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, ProvisioningOptions, SegmentationOption +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/client-access-servers/New-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md index ec07ff17ba..f99ae64e15 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/New-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-WebServicesVirtualDirectory @@ -15,34 +18,50 @@ Use the New-WebServicesVirtualDirectory cmdlet to create Exchange Web Services v You can create multiple virtual directories by using this cmdlet. However, you can create only one Exchange Web Services virtual directory for each website. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-WebServicesVirtualDirectory [-ApplicationRoot ] [-AppPoolId ] - [-AppPoolIdForManagement ] [-BasicAuthentication <$true | $false>] [-Confirm] - [-DigestAuthentication <$true | $false>] [-DomainController ] - [-ExtendedProtectionFlags ] [-ExtendedProtectionSPNList ] - [-ExtendedProtectionTokenChecking ] [-ExternalUrl ] [-Force] - [-GzipLevel ] [-InternalNLBBypassUrl ] [-InternalUrl ] - [-MRSProxyEnabled <$true | $false>] [-MRSProxyMaxConnections ] [-Path ] - [-WebSiteName ] [-WhatIf] [-WindowsAuthentication <$true | $false>] - [-WSSecurityAuthentication <$true | $false>] [-OAuthAuthentication <$true | $false>] - [-Role ] [-Server ] [] +New-WebServicesVirtualDirectory [-ApplicationRoot ] + [-AppPoolId ] + [-AppPoolIdForManagement ] + [-BasicAuthentication ] + [-Confirm] + [-DigestAuthentication ] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-Force] + [-GzipLevel ] + [-InternalNLBBypassUrl ] + [-InternalUrl ] + [-MRSProxyEnabled ] + [-MRSProxyMaxConnections ] + [-OAuthAuthentication ] + [-Path ] + [-Role ] + [-Server ] + [-WebSiteName ] + [-WhatIf] + [-WindowsAuthentication ] + [-WSSecurityAuthentication ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-WebServicesVirtualDirectory -WebSiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/webservices.aspx" ``` -This example creates a virtual directory under the non-default website www.contoso.com. It also sets the external URL to https://www.contoso.com/webservices.aspx. +This example creates a virtual directory under the non-default website www.contoso.com. It also sets the external URL to `https://www.contoso.com/webservices.aspx`. ## PARAMETERS @@ -54,6 +73,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -69,6 +89,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -84,6 +105,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,14 +117,14 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -113,8 +135,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -122,6 +143,7 @@ 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 @@ -133,14 +155,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -156,6 +178,7 @@ 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 @@ -167,13 +190,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -181,6 +200,7 @@ 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 @@ -192,14 +212,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -211,20 +231,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -242,6 +259,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -250,13 +268,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -268,18 +289,16 @@ Accept wildcard characters: False 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. - - 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. ```yaml -Type: Off | Low | High | Error +Type: GzipLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -297,6 +316,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -314,6 +334,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -322,13 +343,14 @@ Accept wildcard characters: False ``` ### -MRSProxyEnabled -The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Mailbox server. MRSProxy is a service that runs on Mailbox servers in a remote forest and helps to proxy a mailbox move. For more information, see Mailbox moves (https://technet.microsoft.com/library/jj150543.aspx). +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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -337,15 +359,16 @@ Accept wildcard characters: False ``` ### -MRSProxyMaxConnections -This parameter is available or functional only in 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. +The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -353,14 +376,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Path -The Path parameter sets the path of the virtual directory in the metabase. +### -OAuthAuthentication +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. +- $false: OAuth authentication is disabled. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -368,14 +395,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebSiteName -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. +### -Path +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 Default value: None @@ -383,14 +411,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -Role +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. +- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. + +Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. ```yaml -Type: SwitchParameter +Type: VirtualDirectoryRole Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -398,37 +432,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WindowsAuthentication -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. +### -Server +The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: -- $false: Integrated Windows authentication is disabled. +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml -Type: $true | $false +Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -WSSecurityAuthentication -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. - -- $false: WS-Security authentication is disabled. +### -WebSiteName +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: $true | $false +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -436,18 +469,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OAuthAuthentication -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. - -- $false: OAuth authentication is disabled. +### -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: $true | $false +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -455,20 +485,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Role -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. - -- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. +### -WindowsAuthentication +The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. +- $true: Integrated Windows authentication is enabled. This is the default value. +- $false: Integrated Windows authentication is disabled. ```yaml -Type: ClientAccess | Mailbox +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -476,44 +504,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) +### -WSSecurityAuthentication +The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: -- ExchangeLegacyDN +- $true: WS-Security authentication is enabled. This is the default value. +- $false: WS-Security authentication is disabled. ```yaml -Type: ServerIdParameter +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None -Accept pipeline input: 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/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/f16d1732-0bc9-438a-a286-05b8c42a9bab.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md similarity index 82% rename from exchange/exchange-ps/exchange/mail-flow/New-X400AuthoritativeDomain.md rename to exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md index e28b516ec2..c18e6668eb 100644 --- a/exchange/exchange-ps/exchange/mail-flow/New-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # New-X400AuthoritativeDomain @@ -13,24 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the New-X400AuthoritativeDomain cmdlet to create and specify the X.400 authoritative domain for the organization. The X.400 authoritative domain defines the standard fields for the namespace appended to the recipient identity for all mailboxes assigned an X.400 address. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-X400AuthoritativeDomain [-Name] -X400DomainName [-Confirm] [-DomainController ] - [-WhatIf] [-X400ExternalRelay <$true | $false>] [] +New-X400AuthoritativeDomain [-Name] -X400DomainName + [-Confirm] + [-DomainController ] + [-WhatIf] + [-X400ExternalRelay ] + [] ``` ## DESCRIPTION X.400 domain names can only include the following ASCII characters: - A to Z - - a to z - - 0-9 - - These punctuation and special characters: (space) ' () + , - . / : = ? You can use the following X.400 attributes (one each per address): @@ -38,46 +42,41 @@ You can use the following X.400 attributes (one each per address): country - Abbreviation: C - - Maximum character length: 2 administrative domain - Abbreviation: A - - Maximum character length: 16 private domain - Abbreviation: P - - Maximum character length: 16 organization name - Abbreviation: O - - Maximum character length: 64 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell New-X400AuthoritativeDomain -Name Sales -X400DomainName "C=US;A=Fabrikam;P=Contoso;O=Sales" ``` This example creates the X.400 authoritative domain Sales in the private domain Contoso, which is under the administrative domain Fabrikam. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell New-X400AuthoritativeDomain -Name "Sales Europe" -X400DomainName "C=US;A=Fabrikam;P=Contoso;O=Sales;OU1=Europe" -X400ExternalRelay: $true ``` @@ -93,6 +92,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -104,19 +104,12 @@ Accept wildcard characters: False 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) - - A (ADMD) - - P (PRMD) - - O (Organization) - - OU1 (Organization unit 1) - - OU2 (Organization unit 2) - - OU3 (Organization unit 3) - - OU4 (Organization unit 4) Separate the address attributes with semicolons and enclose the entire address in quotation marks (for example, "C=US;A=att;P=Contoso;O=Sales"). @@ -126,6 +119,7 @@ Type: X400Domain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -136,8 +130,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -145,6 +138,7 @@ 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 @@ -162,6 +156,7 @@ 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 @@ -177,6 +172,7 @@ 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 @@ -188,10 +184,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -200,20 +197,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/999d149b-0e68-4f19-9d40-06d21b3fb1c0.aspx) diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md new file mode 100644 index 0000000000..655b0da6f5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -0,0 +1,115 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Preview-QuarantineMessage + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization. This cmdlet doesn't work on files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Preview-QuarantineMessage -Identity + [-EntityType ] + [-RecipientAddress ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-QuarantineMessage -MessageID <5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com> | Preview-QuarantineMessage +``` + +This example previews the quarantined message with the Message-ID value `<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>`. + +### Example 2 +```powershell +Preview-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 +``` + +This example previews the quarantined message that has the specified Identity value. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: QuarantineMessageIdentity +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Redirect-Message.md b/exchange/exchange-ps/exchange/Redirect-Message.md similarity index 75% rename from exchange/exchange-ps/exchange/mail-flow/Redirect-Message.md rename to exchange/exchange-ps/exchange/Redirect-Message.md index 23bc2ad2c1..1a0354a5bc 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Redirect-Message.md +++ b/exchange/exchange-ps/exchange/Redirect-Message.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Redirect-Message @@ -13,12 +16,14 @@ This cmdlet is available only in on-premises Exchange. Use the Redirect-Message cmdlet to drain the active messages from all the delivery queues on a Mailbox server, and transfer those messages to another Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Redirect-Message -Server -Target [-Confirm] [-WhatIf] +Redirect-Message -Server -Target + [-Confirm] + [-WhatIf] [] ``` @@ -26,17 +31,15 @@ Redirect-Message -Server -Target [-Con When a message queue is drained, the active messages in the queues on the source Mailbox server are routed to the target Mailbox server. After the messages are received and queued by the target Mailbox server, the messages are made redundant. Other considerations include the following: - 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. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Redirect-Message -Server Mailbox01 -Target Mailbox02 ``` @@ -45,23 +48,19 @@ This example drains the active messages from the delivery queues on the Mailbox ## PARAMETERS ### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: +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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN -If you don't use this parameter, the command is run on the local server. - ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -77,6 +76,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -87,8 +87,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -96,6 +95,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -111,6 +111,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -119,20 +120,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/248138e5-6da4-4652-9cde-f8060c4a854c.aspx) diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md new file mode 100644 index 0000000000..17f3d5590b --- /dev/null +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -0,0 +1,369 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Release-QuarantineMessage + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Release-QuarantineMessage cmdlet to release messages from quarantine in your cloud-based organization. You can release messages to all original recipients, or to specific recipients. + +For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### OrgReleaseToUser +``` +Release-QuarantineMessage -User [-Identities ] + [-Identity ] + [-AllowSender] + [-Confirm] + [-EntityType ] + [-Force] + [-ReportFalsePositive] + [-WhatIf] + [] +``` + +### OrgReleaseToAll +``` +Release-QuarantineMessage [-Identities ] [-Identity ] + [-ReleaseToAll] + [-AllowSender] + [-Confirm] + [-EntityType ] + [-Force] + [-ReportFalsePositive] + [-WhatIf] + [] +``` + +### Identities +``` +Release-QuarantineMessage -Identities + [-Identity ] + [-ActionType ] + [-AllowSender] + [-Confirm] + [-EntityType ] + [-Force] + [-ReportFalsePositive] + [-WhatIf] + [] +``` + +### IdentityOnly +``` +Release-QuarantineMessage -Identity + [-AllowSender] + [-Confirm] + [-EntityType ] + [-Force] + [-ReportFalsePositive] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-QuarantineMessage -MessageID "<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>" | Release-QuarantineMessage -User julia@contoso.com +``` + +This example uses the Get-QuarantineMessage cmdlet to release the quarantined message with the Message-ID value `<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>` to an original recipient julia@contoso.com. + +### Example 2 +```powershell +Release-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 -ReleaseToAll +``` + +This example releases the quarantined message with the specified Identity value to all original recipients. + +### Example 3 +```powershell +Get-QuarantineMessage | Release-QuarantineMessage -ReleaseToAll +``` + +This example releases all messages to all original recipients. + +### Example 4 +```powershell +$q = Get-QuarantineMessage -QuarantineTypes SPOMalware + +$q[-1] | Release-QuarantineMessage -ReleaseToAll +``` + +This example releases a file that was quarantined as part of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. The first command stores all quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see [Accessing and Using Array Elements](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). + +## PARAMETERS + +### -Identities +The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2,...valueN`. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). + +You can find the identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. + +When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. + +```yaml +Type: QuarantineMessageIdentity[] +Parameter Sets: Identities +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: QuarantineMessageIdentity[] +Parameter Sets: OrgReleaseToAll, OrgReleaseToUser +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +```yaml +Type: QuarantineMessageIdentity +Parameter Sets: IdentityOnly +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ReleaseToAll +The ReleaseToAll switch releases the quarantined message to all original recipients. You don't need to specify a value with this switch. + +This switch is required for the quarantine type SPOMalware. + +If you previously used the User parameter or the ReleaseToAll switch to release the quarantined message to some or all of the original recipients, those recipients are skipped when you use the ReleaseToAll switch again. + +You can't use the ReleaseToAll switch and the User parameter in the same command. + +```yaml +Type: SwitchParameter +Parameter Sets: OrgReleaseToAll +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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. + +If you previously used the ReleaseToAll switch to release the quarantined message to all original recipients, and you later release the message again with the User parameter, any original recipients you specify with the User parameter are skipped. + +```yaml +Type: String[] +Parameter Sets: OrgReleaseToUser +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionType +The ActionType parameter specifies the release action type. Valid values are: + +- Deny +- Release: Use this value to release messages or approve requests to release messages. +- Request + +```yaml +Type: ReleaseActionType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSender +The AllowSender switch specifies that all future messages from the sender won't be quarantined. You don't need to specify a value with this switch. + +If the message was quarantined because of a transport rule or blocked sender, messages from the sender can still be blocked in the future. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch whenever you attempt to re-release previously released messages from quarantine. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportFalsePositive +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/active-directory/Remove-ADPermission.md b/exchange/exchange-ps/exchange/Remove-ADPermission.md similarity index 76% rename from exchange/exchange-ps/exchange/active-directory/Remove-ADPermission.md rename to exchange/exchange-ps/exchange/Remove-ADPermission.md index 9c3541952b..13ca24fb1e 100644 --- a/exchange/exchange-ps/exchange/active-directory/Remove-ADPermission.md +++ b/exchange/exchange-ps/exchange/Remove-ADPermission.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ADPermission @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ADPermission cmdlet to remove permissions from an Active Directory object. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,10 +29,11 @@ Remove-ADPermission [-Identity] -User ] [-ExtendedRights ] - [-InheritanceType ] + [-InheritanceType ] [-InheritedObjectType ] [-Properties ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Owner @@ -37,42 +41,43 @@ Remove-ADPermission [-Identity] -User [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Instance ``` -Remove-ADPermission -Instance +Remove-ADPermission [[-Identity] ] -Instance [-AccessRights ] [-ChildObjectTypes ] [-Confirm] [-Deny] [-DomainController ] [-ExtendedRights ] - [[-Identity] ] - [-InheritanceType ] + [-InheritanceType ] [-InheritedObjectType ] [-Properties ] [-User ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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. +The ADPermission cmdlets can be used to directly modify Active Directory access control lists (ACLs). Although some Microsoft Exchange features may continue to use the ADPermission cmdlets to manage permissions (for example Send and Receive connectors), Exchange 2013 and later versions no longer use customized ACLs to manage administrative permissions. If you want to grant or deny administrative permissions in Exchange 2013 or later, you need to use Role Based Access Control (RBAC). For more information about RBAC, see [Permissions in Exchange Server](https://learn.microsoft.com/Exchange/permissions/permissions). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ADPermission -Identity Administrator -User Kim -ExtendedRights "Send As" ``` This example removes the Send As permissions from user Kim on the user Administrator. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-ADPermission "IP Secured Inbound" -User "NT AUTHORITY\ANONYMOUS LOGON" -ExtendedRights ms-Exch-SMTP-Submit,ms-Exch-SMTP-Accept-Any-Recipient,ms-Exch-Bypass-Anti-Spam ``` @@ -90,6 +95,7 @@ Type: ADRawEntryIdParameter Parameter Sets: AccessRights, Owner Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -102,6 +108,7 @@ Type: ADRawEntryIdParameter Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -117,6 +124,7 @@ Type: ADAcePresentationObject Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -125,13 +133,36 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user object that will have permissions removed. +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 +- Mail users +- Security groups + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) ```yaml Type: SecurityPrincipalIdParameter Parameter Sets: AccessRights Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -144,6 +175,7 @@ Type: SecurityPrincipalIdParameter Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,51 +184,36 @@ Accept wildcard characters: False ``` ### -AccessRights -The AccessRights parameter specifies the rights needed to perform the operation. Valid values include: +The AccessRights parameter specifies the rights that you want to remove from the user on the Active Directory object. Valid values include: - CreateChild - - DeleteChild - - ListChildren - - Self - - ReadProperty - - WriteProperty - - DeleteTree - - ListObject - - ExtendedRight - - Delete - - ReadControl - - GenericExecute - - GenericWrite - - GenericRead - - WriteDacl - - WriteOwner - - GenericAll - - Synchronize - - AccessSystemSecurity +You can specify multiple values separated by commas. + ```yaml Type: ActiveDirectoryRights[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -214,6 +231,7 @@ Type: ADSchemaObjectIdParameter[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -224,8 +242,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -233,6 +250,7 @@ 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 @@ -241,13 +259,14 @@ Accept wildcard characters: False ``` ### -Deny -The Deny switch specifies whether the permission to remove is a deny permission. +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 Default value: None @@ -265,6 +284,7 @@ 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 @@ -280,6 +300,7 @@ Type: ExtendedRightIdParameter[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -288,13 +309,20 @@ Accept wildcard characters: False ``` ### -InheritanceType -The InheritanceType parameter specifies whether permissions are inherited. +The InheritanceType parameter specifies how permissions are inherited. Valid values are: + +- None +- All (this is the default value) +- Children +- Descendents [sic] +- SelfAndChildren ```yaml -Type: None | All | Descendents | SelfAndChildren | Children +Type: ActiveDirectorySecurityInheritance Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -310,6 +338,7 @@ Type: ADSchemaObjectIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -327,6 +356,7 @@ Type: ADSchemaObjectIdParameter[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -342,6 +372,7 @@ 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 @@ -350,20 +381,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0e45951a-2b5a-4aa9-a709-def61d7d4972.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..47ada3944f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ATPProtectionPolicyRule + +## SYNOPSIS +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. + +For 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-ATPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +This example removes the existing rule for Defender for Office 365 protections in the Standard preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-AcceptedDomain.md b/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md similarity index 75% rename from exchange/exchange-ps/exchange/mail-flow/Remove-AcceptedDomain.md rename to exchange/exchange-ps/exchange/Remove-AcceptedDomain.md index b96ebb6a10..5339aa412e 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-AcceptedDomain @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-AcceptedDomain cmdlet to remove an accepted domain. When you remove an accepted domain, the accepted domain object is deleted. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AcceptedDomain [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-AcceptedDomain [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-AcceptedDomain Contoso ``` @@ -44,6 +50,7 @@ Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,8 +61,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +69,7 @@ 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 @@ -80,6 +87,7 @@ 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 @@ -95,6 +103,7 @@ 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 @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/79bedc01-7b50-4127-ba54-06bf55c3f43d.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md new file mode 100644 index 0000000000..5ec58a6bb4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md @@ -0,0 +1,147 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ActiveSyncDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. + +**Note**: In Exchange 2013 or later, use the Remove-MobileDevice cmdlet instead. If you have scripts that use Remove-ActiveSyncDevice, update them to use Remove-MobileDevice. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ActiveSyncDevice [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ActiveSyncDevice -Identity WM_JeffHay +``` + +This example removes the mobile device partnership for the device named WM\_JeffHay. + +### Example 2 +```powershell +Remove-ActiveSyncDevice -Identity iPhone_TonySmith -Confirm $true +``` + +This example removes the mobile device partnership for the device named iPhone\_TonySmith after displaying the confirm prompt. + +### Example 3 +```powershell +Remove-ActiveSyncDevice -Identity Tablet_JeffHay -Confirm $true +``` + +This example removes the mobile device partnership for the device named Tablet\_JeffHay after displaying the confirm prompt. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/devices/Remove-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md similarity index 76% rename from exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md index 6e4828661e..5e56ff683d 100644 --- a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ActiveSyncDeviceAccessRule @@ -13,31 +16,34 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ActiveSyncDeviceAccessRule cmdlet to remove any existing device access rule. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncDeviceAccessRule [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-ActiveSyncDeviceAccessRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION If you've created device access rules for groups of devices, you can use the Remove-ActiveSyncDeviceAccessRule cmdlet to remove any access 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-ActiveSyncDeviceAccessRule | Remove-ActiveSyncDeviceAccessRule ``` This example removes all device access rules. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ActiveSyncDeviceAccessRule | where {$_.Name -like 'Contoso*'} | Remove-ActiveSyncDeviceAccessRule ``` @@ -53,6 +59,7 @@ 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 Default value: None @@ -63,8 +70,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -72,6 +78,7 @@ 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 Default value: None @@ -89,6 +96,7 @@ 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 @@ -104,6 +112,7 @@ 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 Default value: None @@ -112,20 +121,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8ef19f4b-c792-4410-af6c-62b0bdfb99bd.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDeviceClass.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md similarity index 77% rename from exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDeviceClass.md rename to exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md index dc9f23aded..fee0ac4e53 100644 --- a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDeviceClass.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ActiveSyncDeviceClass @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ActiveSyncDeviceClass cmdlet to clean up the list of mobile devices synchronizing with Microsoft Exchange. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncDeviceClass [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-ActiveSyncDeviceClass [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-ActiveSyncDeviceClass | RemoveActiveSyncDeviceClass ``` @@ -46,6 +52,7 @@ Type: ActiveSyncDeviceClassIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ 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 @@ -80,6 +87,7 @@ 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 @@ -95,6 +103,7 @@ 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 @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/ccfd43d1-991c-4936-adb3-fbda792ca707.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md new file mode 100644 index 0000000000..faa170542f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md @@ -0,0 +1,163 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ActiveSyncMailboxPolicy cmdlet to remove mobile device mailbox policies. + +**Note**: In Exchange 2013 or later, use the Remove-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Remove-ActiveSyncMailboxPolicy, update them to use Remove-MobileDeviceMailboxPolicy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ActiveSyncMailboxPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ActiveSyncMailboxPolicy -Identity "SalesPolicy" +``` + +This example removes the mobile device mailbox policy SalesPolicy. + +### Example 2 +```powershell +Remove-ActiveSyncMailboxPolicy -Identity "Management" -Confirm:$false -Force $true +``` + +This example removes the mobile device mailbox policy named Management and bypasses any confirmation prompts. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md new file mode 100644 index 0000000000..a45a5a2bd8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md @@ -0,0 +1,149 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ActiveSyncVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-ActiveSyncVirtualDirectory cmdlet to remove existing Exchange ActiveSync virtual directories from Internet Information Services (IIS) virtual directories on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ActiveSyncVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ActiveSyncVirtualDirectory contoso\Microsoft-Server-ActiveSync +``` + +This example removes the default Exchange ActiveSync virtual directory from the server Contoso. + +### Example 2 +```powershell +Remove-ActiveSyncVirtualDirectory contoso\Microsoft-Server-ActiveSync -Confirm $true +``` + +This example removes the default Exchange ActiveSync virtual directory from the server Contoso after confirmation is given. + +### Example 3 +```powershell +Remove-ActiveSyncVirtualDirectory contoso\EAS +``` + +This example removes a custom Exchange ActiveSync virtual directory from the server Contoso. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -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-AdaptiveScope.md b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md new file mode 100644 index 0000000000..6716aabc5e --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-adaptivescope +applicable: Security & Compliance +title: Remove-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-AdaptiveScope cmdlet to remove adaptive scopes from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AdaptiveScope [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdaptiveScope -Identity "Project X" +``` + +This example removes the adaptive scope named Project X. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the adaptive scope that you want to remove. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the adaptive scope. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md new file mode 100644 index 0000000000..f2bac7b9a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-AddressBookPolicy cmdlet to delete an address book policy. You can't remove the address book policy if it's still assigned to a user's mailbox. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AddressBookPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can't delete an address book policy if it's assigned to a user. To determine if an address book policy is assigned to a user, replace the example value Murchison's Class with the name of the ABP and run the following command: + +`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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AddressBookPolicy -Identity "Murchison's Class" +``` + +This example deletes the address book policy Murchison's Class. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/email-addresses-and-address-books/Remove-AddressList.md b/exchange/exchange-ps/exchange/Remove-AddressList.md similarity index 76% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-AddressList.md rename to exchange/exchange-ps/exchange/Remove-AddressList.md index 3432558915..a77eb38489 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-AddressList.md +++ b/exchange/exchange-ps/exchange/Remove-AddressList.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-AddressList @@ -13,30 +16,33 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-AddressList cmdlet to remove existing address lists. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AddressList [-Identity] [-Confirm] [-DomainController ] [-Recursive] - [-WhatIf] [] +Remove-AddressList [-Identity] + [-Confirm] + [-DomainController ] + [-Recursive] + [-WhatIf] + [] ``` ## DESCRIPTION -The Remove-AddressList cmdlet can be used in conjunction with the Get-AddressList cmdlet as follows: +You can use the Remove-AddressList cmdlet with the Get-AddressList cmdlet in the following scenarios: - 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-AddressList -Identity "AddressList1" -Recursive ``` @@ -48,14 +54,9 @@ This example removes the address list named AddressList1 and all of its child ad 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 - -- Display name - - Distinguished name (DN) - - GUID - -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) If the address list has child address lists that you also want to remove, you need to use the Recursive switch. @@ -64,6 +65,7 @@ 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 Default value: None @@ -74,8 +76,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -83,6 +84,7 @@ 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 Default value: None @@ -100,6 +102,7 @@ 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 @@ -117,6 +120,7 @@ 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 @@ -132,6 +136,7 @@ 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 Default value: None @@ -140,20 +145,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b628738c-ebbf-4116-ba85-b1dbd273df40.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md similarity index 79% rename from exchange/exchange-ps/exchange/mail-flow/Remove-AddressRewriteEntry.md rename to exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md index 94b47cc799..8eb9950d2e 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-AddressRewriteEntry @@ -13,13 +16,16 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-AddressRewriteEntry cmdlet to remove an existing address rewrite entry that's no longer needed on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AddressRewriteEntry [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-AddressRewriteEntry [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,24 +33,22 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-AddressRewriteEntry "Address rewrite entry for contoso.com" ``` This example removes a specific address rewrite entry. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-AddressRewriteEntry | Where {$_.InternalAddress -like '*contoso.com'} | Remove-AddressRewriteEntry ``` This example removes all address rewrite entries that include contoso.com in the domain name. It accomplishes the following: - Retrieves all address rewrite entries. - - Filters the result for entries that have contoso.com or its subdomains as the internal address. - - Removes the filtered entries. ## PARAMETERS @@ -57,6 +61,7 @@ Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -67,8 +72,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -76,6 +80,7 @@ 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 @@ -93,6 +98,7 @@ 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 @@ -108,6 +114,7 @@ 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 @@ -116,20 +123,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a588e988-3f80-42c6-aae0-8efaf2f439b3.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md new file mode 100644 index 0000000000..6bff81fad7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AntiPhishPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-AntiPhishPolicy cmdlet to remove antiphish policies from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AntiPhishPolicy [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AntiPhishPolicy -Identity "Quarantine Policy" +``` + +This example removes the antiphish policy named Quarantine Policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: AntiPhishPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md b/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md new file mode 100644 index 0000000000..77562bbd26 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AntiPhishRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-AntiPhishRule cmdlet to remove antiphish rules from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AntiPhishRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AntiPhishRule -Identity "Research Department Phishing Rule" +``` + +This examples removes the antiphish rule named Research Department Phishing Rule. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-App.md b/exchange/exchange-ps/exchange/Remove-App.md new file mode 100644 index 0000000000..c24c1658e5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-App.md @@ -0,0 +1,214 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-App cmdlet to uninstall an app. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-App [-Identity] + [-AppType ] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-OrganizationApp] + [-PrivateCatalog] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet. Apps installed by default can't be uninstalled, but they can be disabled. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-App -Identity -Mailbox Tony +``` + +This example removes the Finance Test app installed for user Tony. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AppType +This parameter is available only in the cloud-based service. + +{{ Fill AppType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -OrganizationApp +The OrganizationApp switch specifies that the scope of the app is organizational. You don't need to specify a value with this switch. + +This switch is required if the targeted app is installed for the organization. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCatalog +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..c470a3f9f2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancepolicy +applicable: Security & Compliance +title: Remove-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-AppRetentionCompliancePolicy to remove app retention compliance policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" +``` + +This example removes the app retention compliance policy named Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..724cda7063 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancerule +applicable: Security & Compliance +title: Remove-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-AppRetentionComplianceRule to remove app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AppRetentionComplianceRule [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AppRetentionComplianceRule -Identity "Contoso Viva Engage" +``` + +This example removes the app retention compliance policy rule Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance rule that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md new file mode 100644 index 0000000000..9b1bae6a1a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ApplicationAccessPolicy + +## 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. + +For 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-ApplicationAccessPolicy [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ApplicationAccessPolicy -Identity "596ade3a-1abe-4c5b-b7d5-a169c4b05d4a\7a774f0c-7a6f-11e0-85ad-07fb4824019b:S-1-5-21-724521725-2336880675-2689004279-1821338;8b6ce428-cca2-459a-ac50-d38bcc932258" +``` + +This example removes the specified policy. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md similarity index 80% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md rename to exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md index e7bbfbd080..a166c59fe8 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-AttachmentFilterEntry @@ -13,31 +16,34 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-AttachmentFilterEntry cmdlet to remove an entry from the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AttachmentFilterEntry [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-AttachmentFilterEntry [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## 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. +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-AttachmentFilterEntry -Identity FileName:*.txt ``` This example removes the attachment filter entry that filters file names with a .txt extension. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-AttachmentFilterEntry -Identity ContentType:image/jpeg ``` @@ -49,7 +55,6 @@ This example removes the attachment filter entry that filters attachments that h 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. - - FileName: This value matches the attachment filter entry against the simple file name. In Type:Name, Name can be either the file name of the attachment filter entry to be removed, or the content type of the attachment filter entry to be removed. @@ -59,6 +64,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -69,8 +75,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -78,6 +83,7 @@ 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 @@ -95,6 +101,7 @@ 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 @@ -110,6 +117,7 @@ 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 @@ -118,20 +126,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/80a97c84-2b7f-41a8-a1dd-acd791eeb8c4.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md new file mode 100644 index 0000000000..5472c1ac64 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md @@ -0,0 +1,134 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AuthRedirect + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-AuthRedirect cmdlet to remove OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AuthRedirect [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AuthRedirect -Identity AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE +``` + +This example removes the existing OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE. + +### Example 2 +```powershell +Get-AuthRedirect | Remove-AuthRedirect +``` + +This example removes all existing OAuth redirection objects from your organization. However, if you have only one object in your organization, this example has the same result as the first example. + +## PARAMETERS + +### -Identity +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 +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 +``` + +### -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-AuthServer.md b/exchange/exchange-ps/exchange/Remove-AuthServer.md new file mode 100644 index 0000000000..826c25a07f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AuthServer.md @@ -0,0 +1,131 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AuthServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-AuthServer cmdlet to remove an authorization server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AuthServer [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AuthServer AMC +``` + +This example removes the authorization server named AMC. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: AuthServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md new file mode 100644 index 0000000000..7881265a05 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md @@ -0,0 +1,164 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-AuthenticationPolicy cmdlet to remove authentication policies from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AuthenticationPolicy [-Identity] + [-Confirm] + [-AllowLegacyExchangeTokens] + [-TenantId ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AuthenticationPolicy -Identity "Engineering Group" +``` + +This example removes the authentication policy named "Engineering Group". + +### Example 2 +```powershell +Remove-AuthenticationPolicy -Identity "LegacyExchangeTokens" -AllowLegacyExchangeTokens +``` + +In Exchange Online, this example enables legacy Exchange tokens to be issued to Outlook add-ins. This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication policies can't be applied. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the authentication policy you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: AuthPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The AllowLegacyExchangeTokens switch enables legacy Exchange tokens to be issued to Outlook add-ins for your organization. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication policies can't be applied. + +**Important**: + +- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes. +- It might take up to 24 hours for the change to take effect across your entire organization. +- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire. +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is available only in the cloud-based service. + +{{ Fill TenantId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md new file mode 100644 index 0000000000..d6b2940550 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AutoSensitivityLabelPolicy + +## 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-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policies from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AutoSensitivityLabelPolicy [-Identity] + [-Confirm] + [-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-AutoSensitivityLabelPolicy -Identity "Marketing Group" +``` + +This example removes the policy named Marketing Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md new file mode 100644 index 0000000000..f779597117 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AutoSensitivityLabelRule + +## 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-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policy rules from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AutoSensitivityLabelRule [-Identity] + [-Confirm] + [-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-AutoSensitivityLabelRule -Identity "Social Security Rule" +``` + +This example removes the rule named Social Security Rule. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md new file mode 100644 index 0000000000..948dcc21f7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AutodiscoverVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-AutodiscoverVirtualDirectory cmdlet to remove an existing Autodiscover virtual directory from Internet Information Services (IIS). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AutodiscoverVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AutodiscoverVirtualDirectory -Identity "MBX01\autodiscover(autodiscover.contoso.com)" +``` + +This example removes the Autodiscover virtual directory from the site autodiscover.contoso.com on the server named MBX01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -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/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md similarity index 75% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md rename to exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md index 8e7c6317a4..97bf6ead5a 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-AvailabilityAddressSpace @@ -13,35 +16,38 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-AvailabilityAddressSpace cmdlet to remove existing availability address space objects and the associated credentials that were used to share free/busy data across Exchange organizations. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AvailabilityAddressSpace [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-AvailabilityAddressSpace [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-AvailabilityAddressSpace -Identity Contoso.com ``` -This example removes the availability address space objectnamed Contoso.com. +This example removes the availability address space object named Contoso.com. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-AvailabilityAddressSpace -Identity Contoso.com -Confirm:$false ``` -This example immediately removes the availability address space objectnamed Contoso.com without displaying the confirmation prompt. +This example immediately removes the availability address space object named Contoso.com without displaying the confirmation prompt. ## PARAMETERS @@ -49,9 +55,7 @@ This example immediately removes the availability address space objectnamed Cont 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 - - Distinguished name (DN) - - GUID ```yaml @@ -59,6 +63,7 @@ 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 Default value: None @@ -69,8 +74,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -78,6 +82,7 @@ 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 Default value: None @@ -95,6 +100,7 @@ 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 @@ -110,6 +116,7 @@ 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 Default value: None @@ -118,20 +125,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/51a1b398-3358-4e08-9175-1d804114a2a5.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md new file mode 100644 index 0000000000..f51da6fded --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AvailabilityConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-AvailabilityConfig cmdlet to remove the availability configuration that specifies the Microsoft 365 organizations to exchange free/busy information with. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AvailabilityConfig [[-Identity] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AvailabilityConfig +``` + +This example removes the existing availability configuration. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md new file mode 100644 index 0000000000..8e66eefd7a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md @@ -0,0 +1,179 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AvailabilityReportOutage + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Remove-AvailabilityReportOutage cmdlet to remove existing outages that have been added with the New-AvailabilityReportOutage cmdlet. Other outages must be modified with the Set-AvailabilityReportOutage cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AvailabilityReportOutage [-SiteName] -ReportDate + [-Confirm] + [-Force] + [-ReportingDatabase ] + [-ReportingServer ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AvailabilityReportOutage -ReportDate:"2009-12-02" -SiteName:"Site1" +``` + +This example removes a manually injected site-scoped outage for a specified day. + +## PARAMETERS + +### -SiteName +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ReportDate +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportingDatabase +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportingServer +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md b/exchange/exchange-ps/exchange/Remove-BlockedConnector.md new file mode 100644 index 0000000000..6520e630b3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-BlockedConnector.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedconnector +applicable: Exchange Online, Exchange Online Protection +title: Remove-BlockedConnector +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-BlockedConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-BlockedConnector cmdlet to unblock inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-BlockedConnector -ConnectorId [-Reason ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-BlockedConnector -ConnectorId 159eb7c4-75d7-43e2-95fe-ced44b3e0a56 +``` + +This unblocks the specified blocked connector. + +## PARAMETERS + +### -ConnectorId +The ConnectorId parameter specifies the blocked connector that you want to unblock. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). You can find this value from the output of the Get-BlockedConnector command. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +The Reason parameter specifies comments about why you're unblocking the blocked connector. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md b/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md new file mode 100644 index 0000000000..ce007bf146 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md @@ -0,0 +1,86 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-BlockedSenderAddress + +## 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. + +**Note**: There's a limit to the number of times you can unblock a Microsoft 365 account. If you exceed the unblock limit for a user, you'll receive an error, and you'll need to contact support to unblock the user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-BlockedSenderAddress -SenderAddress + [-Reason ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-BlockedSenderAddress -SenderAddress julia@contoso.com +``` + +This example unblocks the user julia@contoso.com. + +## PARAMETERS + +### -SenderAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-CalendarEvents.md b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md new file mode 100644 index 0000000000..c199b24fec --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md @@ -0,0 +1,231 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-CalendarEvents cmdlet to cancel future meetings in user or resource mailboxes. Cancelling future meetings removes them from attendee and resource calendars (for example, you're going to remove the mailbox, or the user is going on a leave of absence). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-CalendarEvents [-Identity] -QueryWindowInDays + [-CancelOrganizedMeetings] + [-Confirm] + [-PreviewOnly] + [-QueryStartDate ] + [-UseCustomRouting] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet cancels meetings in the specified mailbox where the mailbox is the meeting organizer, and the meeting has one or more attendees or resources. It doesn't cancel appointments or meetings without attendees or resources. Because meeting cancellations must be sent out, the mailbox must still be enabled to send 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-CalendarEvents -Identity chris@contoso.com -CancelOrganizedMeetings -QueryWindowInDays 120 +``` + +This example cancels every meeting in the mailbox chris@contoso.com that occurs on or 120 days after today's date. After you cancel the meetings, you can remove the mailbox. + +### Example 2 +```powershell +Remove-CalendarEvents -Identity "Angela Gruber" -CancelOrganizedMeetings -QueryStartDate 11-1-2018 -QueryWindowInDays 120 +``` + +This example cancels the meetings in Angela Gruber's calendar for the specified date range. Angela is taking a temporary leave of absence from the company, so cancelling these meetings removes them from the user and resource calendars during her absence. + +### Example 3 +```powershell +Remove-CalendarEvents -Identity "Jacob Berger" -CancelOrganizedMeetings -QueryStartDate 9-1-2018 -QueryWindowInDays 90 -PreviewOnly -Verbose +``` + +This example previews the meetings that would be cancelled in Jacob Berger's calendar for the specified date range. No changes are made to the mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -QueryWindowInDays +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). + +**Note**: The maximum window that's allowed for meeting cancellation is 1825 days (5 years). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CancelOrganizedMeetings +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewOnly +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryStartDate +The QueryStartDate parameter specifies the start date to look for meetings that you want to cancel. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +**Note**: If you don't use this parameter, today's date is used. + +You use the QueryWindowInDays parameter to specify the end date. + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md new file mode 100644 index 0000000000..0a3fbdb087 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-CaseHoldPolicy + +## 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-CaseHoldPolicy cmdlet to remove case hold policies from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-CaseHoldPolicy [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +You should also remove the case hold rule that corresponds to the removed policy by using the Remove-CaseHoldRule cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-CaseHoldPolicy -Identity "Regulation 123 Compliance" +``` + +This example removes the case hold policy named "Regulation 123 Compliance". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the case hold policy to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md new file mode 100644 index 0000000000..cb7f9417bd --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-CaseHoldRule + +## 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-CaseHoldRule cmdlet to remove case hold rules from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-CaseHoldRule [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +Removing a case hold rule causes the release of all Exchange mailbox and SharePoint site case holds that are associated with the rule. Removing a case hold rule also causes the corresponding case hold policy to become invalid, so you should remove it by using the Remove-CaseHoldPolicy cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-CaseHoldRule -Identity "One Year Standard" +``` + +This example removes the case hold rule named "One Year Standard". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the case hold rule to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md similarity index 75% rename from exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md rename to exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md index a55d54f36f..9e0c0ef4af 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ClassificationRuleCollection @@ -13,24 +16,27 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ClassificationRuleCollection to remove classification rule collections from your organization. -In the Office 365 Security & Compliance Center, use the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. +In Security & Compliance PowerShell, use the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ClassificationRuleCollection [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-ClassificationRuleCollection [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ClassificationRuleCollection "External Classification Rule Collection" ``` @@ -46,6 +52,7 @@ Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -82,6 +89,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -97,6 +105,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -105,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7e38396a-5d3d-424d-86e1-5d2f972d56a2.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-ClientAccessArray.md b/exchange/exchange-ps/exchange/Remove-ClientAccessArray.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access-servers/Remove-ClientAccessArray.md rename to exchange/exchange-ps/exchange/Remove-ClientAccessArray.md index 59053a70f8..24930a04a7 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/Remove-ClientAccessArray.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ClientAccessArray @@ -13,22 +16,25 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-ClientAccessArray cmdlet to remove RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ClientAccessArray [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-ClientAccessArray [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ClientAccessArray -Identity casarray01.contoso.com ``` @@ -40,13 +46,9 @@ This example removes the existing Client Access array with the FQDN value casarr 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) - - ExchangeLegacyDN - - Fully qualified domain name (FQDN) - - Distinguished name (DN) - - GUID ```yaml @@ -54,6 +56,7 @@ Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -64,8 +67,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +75,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -88,6 +91,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -103,6 +107,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -111,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c0e7cf59-400f-4462-95b7-984cf2e4ba4e.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md new file mode 100644 index 0000000000..df3b17ddf9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md @@ -0,0 +1,138 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ClientAccessRule + +## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ClientAccessRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ClientAccessRule "Block Client Connections from 192.168.1.0/24" +``` + +This example removes the existing client access rule named "Block Connections from 192.168.1.0/24". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ComplianceCase.md b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md new file mode 100644 index 0000000000..a636d54a72 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md @@ -0,0 +1,124 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceCase + +## 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-ComplianceCase cmdlet to remove compliance cases from the Microsoft Purview compliance portal or the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceCase [-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-ComplianceCase -Identity "Case 5150" +``` + +This example removes the compliance case named Case 5150 + +## PARAMETERS + +### -Identity +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 +- Identity (GUID value) + +```yaml +Type: ComplianceCaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/Remove-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md new file mode 100644 index 0000000000..2a22dd2318 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceCaseMember + +## 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-ComplianceCaseMember cmdlet to remove a single member from an eDiscovery search in Security & Compliance. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceCaseMember [-Case] -Member + [-Confirm] + [-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-ComplianceCaseMember -Case "Case OU812" -Member "Jan Dryml" +``` + +This example removes Jan Dryml from the eDiscovery case named Case OU812. + +## PARAMETERS + +### -Case +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Member +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```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 +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md new file mode 100644 index 0000000000..fdca44b480 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceRetentionEventType + +## 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-ComplianceRetentionEventType cmdlet to remove retention event types in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceRetentionEventType -Identity + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ComplianceRetentionEventType -Identity "Fabrikam Project" +``` + +This example remove the retention event type name Fabrikam Project + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md new file mode 100644 index 0000000000..92fdcfc7a7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md @@ -0,0 +1,117 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ComplianceSearch cmdlet to remove compliance searches from Exchange Server 2016 and from the Microsoft Purview compliance portal. The searches must be stopped or completed. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceSearch [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ComplianceSearch -Identity "Case 1234" +``` + +This example removes the compliance search named Case 1234 + +## PARAMETERS + +### -Identity +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: + +- Name +- JobRunId (GUID) + +You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status + +```yaml +Type: ComplianceSearchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, 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-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md new file mode 100644 index 0000000000..8140168e36 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md @@ -0,0 +1,107 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceSearchAction + +## 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-ComplianceSearch cmdlet to remove compliance search actions from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceSearchAction [-Identity] + [-Confirm] + [-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-ComplianceSearchAction -Identity "Case 1234_Preview" +``` + +This example removes the compliance search action named `Case 1234_Preview`. + +## PARAMETERS + +### -Identity +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"`. +- JobRunId (GUID) + +```yaml +Type: ComplianceSearchActionIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md new file mode 100644 index 0000000000..8b38b2ba8a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md @@ -0,0 +1,104 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceSecurityFilter + +## 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-ComplianceSecurityFilter cmdlet to remove compliance security filters from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceSecurityFilter -FilterName + [-Confirm] + [-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-ComplianceSecurityFilter -FilterName "HR Filter" +``` + +This example removes the compliance security filter named HR Filter. + +## PARAMETERS + +### -FilterName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, 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-ComplianceTag.md b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md new file mode 100644 index 0000000000..46c293ddf7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md @@ -0,0 +1,142 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceTag + +## 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-ComplianceTag cmdlet to remove retention labels from the Microsoft Purview compliance portal. Retention labels apply retention settings to content. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ComplianceTag [-Identity] + [-Confirm] + [-ForceDeletion] + [-PriorityCleanup] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ComplianceTag -Identity "HR Content" +``` + +This example removes the label named HR Content. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the label that you want to remove. You can use any value that uniquely identifies the tag. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: 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/antispam-antimalware/Remove-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md similarity index 80% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-ContentFilterPhrase.md rename to exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md index 42097dba4c..88836574db 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-ContentFilterPhrase.md +++ b/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ContentFilterPhrase @@ -13,15 +16,17 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ContentFilterPhrase cmdlet to remove one or all custom words that the Content Filter agent processes. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` Remove-ContentFilterPhrase [-Identity] - [-Confirm] [-DomainController ] - [-WhatIf] [] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ### Phrase @@ -29,16 +34,17 @@ Remove-ContentFilterPhrase [-Identity] Remove-ContentFilterPhrase [-Phrase ] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ContentFilterPhrase -Identity "Free credit report" ``` @@ -56,6 +62,7 @@ Type: ContentFilterPhraseIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -66,8 +73,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -75,6 +81,7 @@ 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 @@ -92,6 +99,7 @@ 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 @@ -109,6 +117,7 @@ Type: ContentFilterPhraseIdParameter Parameter Sets: Phrase Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,6 +133,7 @@ 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 @@ -132,20 +142,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e5b07af5-1d93-43e2-8046-00c39df8378c.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-DataClassification.md b/exchange/exchange-ps/exchange/Remove-DataClassification.md new file mode 100644 index 0000000000..c89fd96ca0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DataClassification.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DataClassification + +## 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. + +Use the Remove-DataClassification cmdlet to remove data classification rules that use document fingerprints. You can't use this cmdlet to remove built-in data classification rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DataClassification [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DataClassification "Contoso Confidential" +``` + +This example removes the data classification rule named "Contoso Confidential". + +## PARAMETERS + +### -Identity +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 +- LocalizedName +- Identity GUID value + +```yaml +Type: DataClassificationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/database-availability-groups/Remove-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md similarity index 75% rename from exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md index fde902ce89..2311d1505f 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-DatabaseAvailabilityGroup @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-DatabaseAvailabilityGroup cmdlet to delete an empty database availability group (DAG). Before you can delete a DAG, you must first remove all Mailbox servers from the DAG. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DatabaseAvailabilityGroup [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-DatabaseAvailabilityGroup [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-DatabaseAvailabilityGroup -Identity DAG1 ``` @@ -44,6 +50,7 @@ Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,8 +61,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +69,7 @@ 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 @@ -78,6 +85,7 @@ 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 @@ -93,6 +101,7 @@ 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 @@ -101,20 +110,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1cca1888-c27b-45af-8db7-dd182bcdf32e.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md similarity index 75% rename from exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md index 32e412316a..2a130fd882 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-DatabaseAvailabilityGroupNetwork @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-DatabaseAvailabilityGroupNetwork cmdlet to remove a database availability group (DAG) network. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DatabaseAvailabilityGroupNetwork [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-DatabaseAvailabilityGroupNetwork [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-DatabaseAvailabilityGroupNetwork -Identity DAG1\DAGNetwork04 ``` @@ -44,6 +50,7 @@ Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,8 +61,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +69,7 @@ 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 @@ -78,6 +85,7 @@ 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 @@ -93,6 +101,7 @@ 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 @@ -101,20 +110,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8da3ddc3-72e0-4c1b-8d3f-848c3ab5584e.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md new file mode 100644 index 0000000000..dfb283d873 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md @@ -0,0 +1,193 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DatabaseAvailabilityGroupServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-DatabaseAvailabilityGroupServer cmdlet to remove a Mailbox server from a database availability group (DAG). To remove a Mailbox server from a DAG, the Mailbox server must not host any replicated databases. + +For 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-DatabaseAvailabilityGroupServer [-Identity] [-MailboxServer] + [-ConfigurationOnly] + [-Confirm] + [-DomainController ] + [-SkipDagValidation] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DatabaseAvailabilityGroupServer -Identity DAG3 -MailboxServer MBX1 +``` + +This example removes the Mailbox server MBX1 from the DAG DAG3. + +### Example 2 +```powershell +Remove-DatabaseAvailabilityGroupServer -Identity DAG2 -MailboxServer MBX4 -ConfigurationOnly +``` + +This example removes the configuration settings for the Mailbox server MBX4 from the DAG DAG2. MBX4 is currently offline and expected to be offline for an extended period, so its configuration is being removed from the DAG to establish quorum for the DAG or to reduce the number of members needed for quorum by the DAG. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MailboxServer +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConfigurationOnly +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -SkipDagValidation +The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/mail-flow/Remove-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md similarity index 76% rename from exchange/exchange-ps/exchange/mail-flow/Remove-DeliveryAgentConnector.md rename to exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md index 38bc46d2f5..ff7ae195fd 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-DeliveryAgentConnector @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. The Remove-DeliveryAgentConnector cmdlet removes a specific delivery agent connector configured in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DeliveryAgentConnector [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-DeliveryAgentConnector [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/dd638118.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-DeliveryAgentConnector "Contoso Delivery Agent Connector" ``` @@ -46,6 +52,7 @@ Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ 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 @@ -82,6 +89,7 @@ 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 @@ -97,6 +105,7 @@ 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 @@ -105,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/41c4859f-0a8d-41ff-8074-e3ea7f08df69.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md new file mode 100644 index 0000000000..12423d67fd --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DeviceConditionalAccessPolicy + +## 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-DeviceConditionalAccessPolicy cmdlet to remove mobile device conditional access policies from Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DeviceConditionalAccessPolicy [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-DeviceConditionalAccessPolicy -Identity "Human Resources" +``` + +This example removes the mobile device conditional access policy named Human Resources. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md new file mode 100644 index 0000000000..08e72f3b32 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DeviceConditionalAccessRule + +## 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-DeviceConditionalAccessRule cmdlet to remove mobile device conditional access rules from Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DeviceConditionalAccessRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-DeviceConditionalAccessRule "Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}" +``` + +This example removes the mobile device conditional access rule named Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md new file mode 100644 index 0000000000..913547d5a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DeviceConfigurationPolicy + +## 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-DeviceConfigurationPolicy cmdlet to remove mobile device configuration policies from Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DeviceConfigurationPolicy [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-DeviceConfigurationPolicy -Identity "Engineering Group" +``` + +This example removes the mobile device configuration policy named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md new file mode 100644 index 0000000000..d3ab49229c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DeviceConfigurationRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-DeviceConfigurationRule cmdlet to remove mobile device configuration rules from Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DeviceConfigurationRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-DeviceConfigurationRule "Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}" +``` + +This example removes the mobile device configuration rule named Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md new file mode 100644 index 0000000000..919b43271d --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DeviceTenantPolicy + +## 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-DeviceTenantPolicy cmdlet to remove your organization's mobile device tenant policy from Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DeviceTenantPolicy [-Identity ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-DeviceTenantPolicy +``` + +This example removes your organization's mobile device tenant policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the mobile device tenant policy that you want to remove, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: `Get-DeviceTenantPolicy | Format-List Name`. + +```yaml +Type: PolicyIdParameter +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 +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md new file mode 100644 index 0000000000..0fe5232d12 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DeviceTenantRule + +## 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-DeviceTenantRule cmdlet to remove your organization's mobile device tenant rule from Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DeviceTenantRule [-Identity ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-DeviceTenantRule +``` + +This example removes the mobile device tenant rule from your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the name of the mobile device tenant rule that you want to remove, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command `Get-DeviceTenantRule | Format-List Name`. + +```yaml +Type: PolicyIdParameter +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 +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md b/exchange/exchange-ps/exchange/Remove-DistributionGroup.md new file mode 100644 index 0000000000..b35ddb9a2a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DistributionGroup.md @@ -0,0 +1,182 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-DistributionGroup cmdlet to remove distribution groups and mail-enabled security groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DistributionGroup [-Identity] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DistributionGroup -Identity "Temporary Staff" +``` + +This example removes the distribution group named Temporary Staff. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md similarity index 75% rename from exchange/exchange-ps/exchange/users-and-groups/Remove-DistributionGroupMember.md rename to exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md index ada83c925d..0f323c30da 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-DistributionGroupMember @@ -13,24 +16,29 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-DistributionGroupMember cmdlet to remove a single member from distribution groups or mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DistributionGroupMember [-Identity] [-BypassSecurityGroupManagerCheck] - [-Confirm] [-DomainController ] [-Member ] [-WhatIf] [] +Remove-DistributionGroupMember [-Identity] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController ] + [-Member ] + [-WhatIf] + [] ``` ## DESCRIPTION -You can't use the Remove-DistributionGroupMember cmdlet to remove the memberof a dynamic distribution group. A dynamic distribution group's membership is calculated from query results. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-DistributionGroupMember -Identity "Technical Support" -Member "Jan Dryml" ``` @@ -39,22 +47,13 @@ This example removes Jan Dryml from the distribution group named Technical Suppo ## PARAMETERS ### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. - -For example: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID ```yaml @@ -62,6 +61,7 @@ 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 Default value: None @@ -70,19 +70,19 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) 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 @@ -93,8 +93,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -102,6 +101,7 @@ 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 @@ -119,6 +119,7 @@ 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 @@ -127,22 +128,13 @@ Accept wildcard characters: False ``` ### -Member -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID ```yaml @@ -150,6 +142,7 @@ 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 Default value: None @@ -165,6 +158,7 @@ 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 @@ -173,20 +167,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/52d89f9c-75b2-418f-b835-da679aaec1f8.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md new file mode 100644 index 0000000000..86f93677d8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md @@ -0,0 +1,116 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpCompliancePolicy + +## 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-DlpCompliancePolicy cmdlet to remove data loss prevention (DLP) policies from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpCompliancePolicy [-Identity] + [-Confirm] + [-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-DlpCompliancePolicy -Identity 7e640345-1a7f-4f4e-9c17-681c070ed5e2 +``` + +This example removes a DLP policy specified by its GUID. + +### Example 2 +```powershell +Remove-DlpCompliancePolicy -Identity "PII Main Policy" +``` + +This example removes a DLP policy specified by its name. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md new file mode 100644 index 0000000000..cbbfa8b856 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md @@ -0,0 +1,109 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpComplianceRule + +## 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-DlpComplianceRule cmdlet to remove Data Loss Prevention (DLP) rules from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpComplianceRule [-Identity] + [-Confirm] + [-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-DlpComplianceRule -Identity "PII SS# Custom" +``` + +This example removes the DLP rule named "PII SS# Custom". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md new file mode 100644 index 0000000000..f32281feb1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md @@ -0,0 +1,109 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpEdmSchema + +## 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-DlpEdmSchema cmdlet to remove exact data match (EDM) data loss prevention (DLP) schemas from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpEdmSchema [-Identity] + [-Confirm] + [-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-DlpEdmSchema -Identity "Schema for Patient Records" +``` + +This example removes the DLP EDM schema named Schema for Patient Records. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) + +```yaml +Type: EdmStorageIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits) diff --git a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md new file mode 100644 index 0000000000..9497d5484f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md @@ -0,0 +1,111 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpKeywordDictionary + +## 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-DlpKeywordDictionary cmdlet to remove data loss prevention (DLP) keyword dictionaries from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpKeywordDictionary [-Identity] + [-Confirm] + [-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-DlpKeywordDictionary -Identity "Financial Data" +``` + +This example removes the DLP keyword dictionary named Financial Data. + +### Example 2 +```powershell +Get-DlpKeywordDictionary | Foreach-Object { Remove-DlpKeywordDictionary -Identity $_.Name -confirm:$True } +``` + +This example removes all the DLP keyword dictionaries with a Confirm on each removal. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md b/exchange/exchange-ps/exchange/Remove-DlpPolicy.md new file mode 100644 index 0000000000..e7591b41e1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpPolicy.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +This cmdlet is functional only in on-premises Exchange. + +Use the Remove-DlpPolicy cmdlet to remove existing data loss prevention (DLP) policies that are based on transport rules (mail flow rules) from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DlpPolicy "Contoso PII" +``` + +This example removes the existing DLP policy named Contoso PII. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DlpPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md new file mode 100644 index 0000000000..6ec3166bac --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md @@ -0,0 +1,127 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpPolicyTemplate + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-DlpPolicyTemplate cmdlet to remove data loss prevention (DLP) policy templates that are based on transport rules (mail flow rules) from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpPolicyTemplate [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DlpPolicyTemplate "External DLP Policy Template" +``` + +This example removes the DLP policy template named External DLP Policy Template. + +## PARAMETERS + +### -Identity +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 +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 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md new file mode 100644 index 0000000000..248e930c45 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpSensitiveInformationType + +## 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-DlpSensitiveInformationType cmdlet to remove sensitive information type rules that use document fingerprints. You can't use this cmdlet to remove built-in sensitive information type rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpSensitiveInformationType [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. + +**Note**: A "ManagementObjectNotFoundException" error means there was a synchronization problem between the Microsoft Purview compliance portal and Exchange Online. This happens when you try to remove data classifications that are being used in mail flow rules (also known as transport rules). You can remove the mail flow rule, wait for synchronization to finish, and then add the rule back. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DlpSensitiveInformationType "Contoso Confidential" +``` + +This example removes the sensitive information type rule named "Contoso Confidential". + +## PARAMETERS + +### -Identity +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 +- LocalizedName +- Identity GUID value + +```yaml +Type: DataClassificationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md new file mode 100644 index 0000000000..dcf39f5bd5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-DlpSensitiveInformationTypeRulePackage + +## 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-DlpSensitiveInformationTypeConfig cmdlet to remove data loss prevention (DLP) sensitive information type rule packages from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DlpSensitiveInformationTypeRulePackage [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$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. + +## PARAMETERS + +### -Identity +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 +- LocalizedName +- GUID (from the Identity value) + +```yaml +Type: SensitiveInformationTypeRuleCollectionIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md new file mode 100644 index 0000000000..3c76cd90a3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-DynamicDistributionGroup cmdlet to delete dynamic distribution groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DynamicDistributionGroup [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DynamicDistributionGroup -Identity "Test Users" +``` + +This example deletes the dynamic distribution group named Test Users. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..ba11d899b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Remove-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-EOPProtectionPolicyRule cmdlet to remove rules from Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +**Note**: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-EOPProtectionPolicyRule cmdlet. The affected preset security policy won't function without a corresponding rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-EOPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +This example removes the existing rule for EOP protections in the Standard preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md new file mode 100644 index 0000000000..07f4762142 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md @@ -0,0 +1,137 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-EcpVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-EcpVirtualDirectory cmdlet to remove Exchange Control Panel (ECP) virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers. The ECP virtual directory manages the Exchange admin center. + +The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-EcpVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-EcpVirtualDirectory -Identity "Server01\ecp (Default Web site)" +``` + +This example removes the ECP virtual directory named ecp located on the default IIS website on the Exchange server named Server01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +Remote removal of an ECP virtual directory isn't supported. You need run this command from the local computer. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -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-EdgeSubscription.md b/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md new file mode 100644 index 0000000000..e792a7e0b9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md @@ -0,0 +1,155 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-EdgeSubscription + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-EdgeSubscription cmdlet to remove Edge Subscription from the Exchange organization and from the subscribed Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-EdgeSubscription [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you remove an Edge Subscription, the following changes are made: + +- Synchronization of information from Active Directory to the Active Directory Lightweight Directory Services (AD LDS) instance stops. +- All the accounts stored in AD LDS are removed. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-EdgeSubscription -Identity Edge1 +``` + +This example removes Edge Subscription for the Edge Transport server named Edge1. + +## PARAMETERS + +### -Identity +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 +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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/email-addresses-and-address-books/Remove-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-EmailAddressPolicy.md rename to exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md index 05f5bacbdb..8389a40fd5 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-EmailAddressPolicy @@ -11,24 +14,27 @@ monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. +Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. In Exchange Online, email address policies are available only for Microsoft 365 Groups. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-EmailAddressPolicy [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-EmailAddressPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-EmailAddressPolicy -Identity "Southwest Executives" ``` @@ -40,9 +46,7 @@ This example removes the email address policy named Southwest Executives. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -50,6 +54,7 @@ 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 Default value: None @@ -60,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +73,7 @@ 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 Default value: None @@ -86,6 +91,7 @@ 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 @@ -101,6 +107,7 @@ 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 Default value: None @@ -109,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c36aad43-ad3f-442f-9b52-316bb1f43e82.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md similarity index 79% rename from exchange/exchange-ps/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md rename to exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md index e375cd432c..e6a35f7f1c 100644 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ExchangeCertificate @@ -13,16 +16,18 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ExchangeCertificate cmdlet to remove existing Exchange certificates or pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Thumbprint ``` -Remove-ExchangeCertificate [-Thumbprint] [-Server ] +Remove-ExchangeCertificate [-Thumbprint] + [-Server ] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Identity @@ -30,29 +35,30 @@ Remove-ExchangeCertificate [-Thumbprint] [-Server ] Remove-ExchangeCertificate [[-Identity] ] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION You can't remove the certificate that's being used. If you want to replace the default certificate for the server with another certificate that has the same fully qualified domain name (FQDN), you must create the new certificate first, and then remove the old certificate. -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see Digital certificates and encryption in Exchange 2016. +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out Protecting you against the SSL 3.0 vulnerability (https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e ``` This example removes the certificate with the specified thumbprint from the local Exchange server. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-ExchangeCertificate -Server Mailbox01 -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e ``` @@ -70,6 +76,7 @@ Type: String Parameter Sets: Thumbprint Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -77,11 +84,35 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Identity +The Identity parameter specifies the certificate that you want to remove. Valid values are: + +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` + +You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. + +You can't use this parameter with the Server parameter. + +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. + +```yaml +Type: ExchangeCertificateIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -89,6 +120,7 @@ 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 @@ -106,6 +138,7 @@ 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 @@ -117,11 +150,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -133,6 +163,7 @@ Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -148,53 +179,27 @@ 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 -``` - -### -Identity -The Identity parameter specifies the certificate that you want to remove. Valid values are: - -- \\\\ - -- \ -You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. - -You can't use this parameter with the Server parameter. - -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. - -```yaml -Type: ExchangeCertificateIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3e007b40-1ef7-4105-ba1b-d2ad33f29cc2.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..57130dbbe8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-exophishsimoverriderule +applicable: Exchange Online +title: Remove-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ExoPhishSimOverrideRule cmdlet to remove third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ExoPhishSimOverrideRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoPhishSimOverrideRule | Remove-ExoPhishSimOverrideRule +``` + +This example removes any phishing simulation override rules. + +### Example 2 +```powershell +Remove-ExoPhishSimOverrideRule -Identity "_Exe:PhishSimOverr:6fed4b63-3563-495d-a481-b24a311f8329" +``` + +This example removes the specified phishing simulation override rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The rule name syntax is `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..b127bd5c6f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-exosecopsoverriderule +applicable: Exchange Online +title: Remove-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ExoSecOpsOverrideRule cmdlet to remove SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ExoSecOpsOverrideRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoSecOpsOverrideRule| Remove-ExoSecOpsOverrideRule +``` + +This example removes any SecOps mailbox override rules. + +### Example 2 +```powershell +Remove-ExoSecOpsOverrideRule -Identity "_Exe:SecOpsOverrid:312c23cf-0377-4162-b93d-6548a9977efb" +``` + +This example removes the specified SecOps mailbox override rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the SecOps override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md b/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md new file mode 100644 index 0000000000..d6b0f82b35 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-featureconfiguration +applicable: Security & Compliance +title: Remove-FeatureConfiguration +schema: 2.0.0 +--- + +# Remove-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the Remove-FeatureConfiguration cmdlet to remove Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-FeatureConfiguration [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FeatureConfiguration -Identity "Engineering Group" +``` + +This example removes the specified feature configuration. + +## PARAMETERS + +### -Identity +The Identity policy specifies the feature configuration that you want to remove. You can use any value that uniquely identifies the configuration. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md b/exchange/exchange-ps/exchange/Remove-FederatedDomain.md new file mode 100644 index 0000000000..c0cbc63696 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FederatedDomain.md @@ -0,0 +1,168 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-FederatedDomain + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-FederatedDomain cmdlet to remove a federated domain from the federated organization identifier in the federation trust for the Exchange organization. + +If you remove a domain configured for federated sharing, federated sharing for that domain is disabled. + +For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-FederatedDomain [[-Identity] ] -DomainName + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +An Exchange organization's federated organization identifier is generally created using the organization's primary domain name. Additional domain names can be added and removed. The Remove-FederatedDomain cmdlet removes a federated domain from the federated 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FederatedDomain -DomainName contoso.co.uk +``` + +This example removes the federated domain contoso.co.uk from the federated organization identifier. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -Force +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/federation-and-hybrid/Remove-FederationTrust.md b/exchange/exchange-ps/exchange/Remove-FederationTrust.md similarity index 75% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Remove-FederationTrust.md rename to exchange/exchange-ps/exchange/Remove-FederationTrust.md index 494b6e1c5e..86132d007a 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-FederationTrust.md +++ b/exchange/exchange-ps/exchange/Remove-FederationTrust.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-FederationTrust @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-FederationTrust cmdlet to remove an existing federation trust from an Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-FederationTrust [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-FederationTrust [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-FederationTrust "Microsoft Federation Gateway" ``` @@ -46,6 +52,7 @@ Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ 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 @@ -80,6 +87,7 @@ 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 @@ -95,6 +103,7 @@ 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 @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d01fb4ba-4db4-4fbb-85ef-d14219fe0ad9.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md new file mode 100644 index 0000000000..6de6ae8679 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Remove-FilePlanPropertyAuthority + +## 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-FilePlanPropertyAuthority cmdlet to remove file plan property authorities. + +For 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-FilePlanPropertyAuthority [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FilePlanPropertyAuthority -Identity "Contoso Authority" +``` + +This example removes the custom file plan property authority named Contoso Authority. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md new file mode 100644 index 0000000000..e5e7d1c7fa --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Remove-FilePlanPropertyCategory + +## 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-FilePlanPropertyCategory cmdlet to remove file plan property categories. + +For 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-FilePlanPropertyCategory [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FilePlanPropertyCategory -Identity "Contoso Category" +``` + +This example removes the custom file plan property category named Contoso Category. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md new file mode 100644 index 0000000000..70c1f29a20 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Remove-FilePlanPropertyCitation + +## 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-FilePlanPropertyCitation cmdlet to remove file plan property citations. + +For 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-FilePlanPropertyCitation [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FilePlanPropertyCitation -Identity "Contoso Citation" +``` + +This example removes the custom file plan property citation named Contoso Citation. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md new file mode 100644 index 0000000000..630bbe64a4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Remove-FilePlanPropertyDepartment + +## 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 Removet-FilePlanPropertyDepartment cmdlet to remove file plan property departments. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-FilePlanPropertyDepartment [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FilePlanPropertyDepartment -Identity "Contoso HR" +``` + +This example removes the custom file plan property department named Contoso HR. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md new file mode 100644 index 0000000000..7548cc4cf3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Remove-FilePlanPropertyReferenceId + +## 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-FilePlanPropertyReferenceId cmdlet to remove file plan property reference IDs. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-FilePlanPropertyReferenceId [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FilePlanPropertyReferenceId -Identity "Contoso-0001" +``` + +This example removes the custom file plan property reference ID named Contoso-0001. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md new file mode 100644 index 0000000000..5e45a1faf5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Remove-FilePlanPropertySubCategory + +## 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-FilePlanPropertySubCategory cmdlet to remove file plan property subcategories. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-FilePlanPropertySubCategory [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FilePlanPropertySubCategory -Identity "US Tax" +``` + +This example removes the custom file plan property subcategory named US Tax. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the 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 +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/mail-flow/Remove-ForeignConnector.md b/exchange/exchange-ps/exchange/Remove-ForeignConnector.md similarity index 78% rename from exchange/exchange-ps/exchange/mail-flow/Remove-ForeignConnector.md rename to exchange/exchange-ps/exchange/Remove-ForeignConnector.md index e2594e996d..d43ea4b717 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/Remove-ForeignConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ForeignConnector @@ -13,13 +16,16 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ForeignConnector cmdlet to delete a Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ForeignConnector [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-ForeignConnector [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,12 +33,12 @@ The Remove-ForeignConnector cmdlet deletes the object and the configuration info Although a Foreign connector is configured on a local Mailbox server, if you delete a Foreign connector, you may affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ForeignConnector "Fax Connector" ``` @@ -48,6 +54,7 @@ Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -58,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -67,6 +73,7 @@ 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 @@ -84,6 +91,7 @@ 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 @@ -99,6 +107,7 @@ 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 @@ -107,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e0d69dab-1e9b-4e2b-b615-5d12cb24f792.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md b/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md similarity index 75% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md rename to exchange/exchange-ps/exchange/Remove-GlobalAddressList.md index 2483919cf4..2307a60bef 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-GlobalAddressList @@ -13,24 +16,27 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-GlobalAddressList cmdlet to remove an existing global address list (GAL). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-GlobalAddressList [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-GlobalAddressList [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-GlobalAddressList -Identity OldGAL ``` @@ -42,9 +48,7 @@ This example removes the GAL named OldGAL. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -52,6 +56,7 @@ 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 Default value: None @@ -62,8 +67,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -71,6 +75,7 @@ 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 Default value: None @@ -88,6 +93,7 @@ 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 @@ -103,6 +109,7 @@ 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 Default value: None @@ -111,20 +118,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b9d537c9-6a50-4f61-9cb7-bdedc7e7e0c8.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md similarity index 80% rename from exchange/exchange-ps/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md rename to exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md index 0fdec83a32..6bdf488dfa 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-GlobalMonitoringOverride @@ -13,30 +16,34 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-GlobalMonitoringOverride cmdlet to remove a managed availability global override that has been configured for a probe, monitor or responder. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-GlobalMonitoringOverride [-Identity] -ItemType - -PropertyName [-Confirm] [-DomainController ] [-WhatIf] [-BuildRange ] - [-Roles ] [] +Remove-GlobalMonitoringOverride [-Identity] -ItemType -PropertyName + [-BuildRange ] + [-Confirm] + [-DomainController ] + [-Roles ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-GlobalMonitoringOverride -Identity Exchange\ActiveDirectoryConnectivityConfigDCServerReboot -ItemType Responder -PropertyName Enabled ``` This example removes a global monitoring override of the ActiveDirectoryConnectivityConfigDCServerReboot responder in the Exchange health set. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-GlobalMonitoringOverride -Identity FrontEndTransport\OnPremisesInboundProxy -ItemType Probe -PropertyName ExtensionAttributes ``` @@ -52,6 +59,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -63,16 +71,15 @@ Accept wildcard characters: False The ItemType parameter specifies the item type that you want to remove. It can be any of the following values: - Probe - - Monitor - - Responder ```yaml -Type: Probe | Monitor | Responder | Maintenance +Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -88,6 +95,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -95,11 +103,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BuildRange +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 +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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -107,6 +130,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,21 +148,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -146,7 +156,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BuildRange +### -Roles This parameter is reserved for internal Microsoft use. ```yaml @@ -154,6 +164,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -161,14 +172,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Roles -This parameter is reserved for internal Microsoft use. +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -177,20 +189,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8f8f902a-a279-484f-a25a-1986706c9dc2.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md new file mode 100644 index 0000000000..f4e942a974 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-HoldCompliancePolicy + +## 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-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. + +For 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-HoldCompliancePolicy [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +You should also remove the preservation rule that corresponds to the removed policy by using the Remove-HoldComplianceRule cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-HoldCompliancePolicy -Identity "Regulation 123 Compliance" +``` + +This example removes the preservation policy named "Regulation 123 Compliance". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the preservation policy to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md new file mode 100644 index 0000000000..5b0fea9c47 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-HoldComplianceRule + +## 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-HoldComplianceRule cmdlet to remove preservation rules from the Microsoft Purview compliance portal. + +**Note**: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-HoldComplianceRule [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +Removing a preservation rule causes the release of all Exchange mailbox and SharePoint site preservations that are associated with the rule. Removing a preservation rule also causes the corresponding preservation policy to become invalid, so you should remove it by using the Remove-HoldCompliancePolicy cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-HoldComplianceRule -Identity "One Year Standard" +``` + +This example removes the preservation rule named "One Year Standard". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the preservation rule to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md new file mode 100644 index 0000000000..b94bb23bff --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md @@ -0,0 +1,116 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-HostedContentFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-HostedContentFilterPolicy cmdlet to remove spam filter policies (content filter policies) from your cloud-based organization. + +When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedContentFilterRule cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-HostedContentFilterPolicy [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-HostedContentFilterPolicy "Contoso Content Filter Policy" +``` + +This example removes the spam filter policy named Contoso Content Filter Policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md new file mode 100644 index 0000000000..473b44deb4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-HostedContentFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-HostedContentFilterRule cmdlet to remove spam filter rules (content filter rules) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-HostedContentFilterRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-Rule "Contoso Recipients" +``` + +This example removes the spam filter rule named Contoso Recipients. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md new file mode 100644 index 0000000000..20e3e3eb7f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md @@ -0,0 +1,92 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-HostedOutboundSpamFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-HostedOutboundSpamFilterPolicy cmdlet to remove outbound spam filter policies from your cloud-based organization. + +When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedOutboundSpamFilterRule cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-HostedOutboundSpamFilterPolicy [-Identity] + [-Force] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-HostedOutboundSpamFilterPolicy -Identity "Contoso Executives" +``` + +This example removes the outbound spam filter policy named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: HostedOutboundSpamFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md new file mode 100644 index 0000000000..cc89753dc3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-HostedOutboundSpamFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-HostedOutboundSpamFilterRule cmdlet to remove outbound spam filter rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-HostedOutboundSpamFilterRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-HostedOutboundSpamFilterRule -Identity "Contoso Executives" +``` + +This example removes the outbound spam filter rule named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-HybridConfiguration.md b/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md similarity index 78% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Remove-HybridConfiguration.md rename to exchange/exchange-ps/exchange/Remove-HybridConfiguration.md index 9732bd6a78..ed6b8d990c 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-HybridConfiguration @@ -13,23 +16,26 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-HybridConfiguration cmdlet to delete the HybridConfigurationActive Directory object for your on-premises Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-HybridConfiguration [-Confirm] [-DomainController ] [-WhatIf] [] +Remove-HybridConfiguration [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION Removing a HybridConfiguration object should typically only be performed in circumstances where the hybrid deployment state is corrupt and under the direction of Microsoft Customer Service and Support. After removing the HybridConfiguration object, your existing hybrid deployment configuration settings aren't disabled or removed. However, when the Hybrid Configuration wizard is run again after removing the HybridConfiguration object, the wizard won't have a hybrid configuration reference point for your existing feature settings. As a result, it will automatically create a HybridConfiguration object and record the new hybrid deployment configuration feature values defined in the wizard. The feature settings associated with the hybrid deployment, such as organization relationship or Send and Receive connector parameters, which were configured with the HybridConfiguration object that's removed, aren't removed or modified until the Hybrid Configuration wizard is run again. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-HybridConfiguration ``` @@ -40,8 +46,7 @@ This example removes the HybridConfiguration object for the hybrid deployment. ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -49,6 +54,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -66,6 +72,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -81,6 +88,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -89,20 +97,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d5a17572-da46-4a7c-8ce6-556b02255915.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md similarity index 78% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPAllowListEntry.md rename to exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md index 573be34ab9..07022d05d8 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-IPAllowListEntry @@ -13,12 +16,15 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPAllowListEntry cmdlet to remove IP address entries from the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPAllowListEntry [-Identity] [-Confirm] [-Server ] [-WhatIf] +Remove-IPAllowListEntry [-Identity] + [-Confirm] + [-Server ] + [-WhatIf] [] ``` @@ -27,15 +33,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-IPAllowListEntry | Where {$_.IPRange -eq '192.168.0.100'} | Remove-IPAllowListEntry ``` This example removes the IP address 192.168.0.100 from the IP Allow list. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-IPAllowListEntry | Where {$_.IPRange -eq '192.168.0.0/24'} | Remove-IPAllowListEntry ``` @@ -51,6 +57,7 @@ Type: IPListEntryIdentity Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -61,8 +68,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -70,6 +76,7 @@ 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 @@ -81,11 +88,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -97,6 +101,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -112,6 +117,7 @@ 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 @@ -120,20 +126,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b612c16f-24ba-4647-aaca-5fbda32b3c86.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md similarity index 79% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPAllowListProvider.md rename to exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md index dc0f149c13..530652a8e2 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-IPAllowListProvider @@ -13,13 +16,16 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPAllowListProvider cmdlet to remove IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPAllowListProvider [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-IPAllowListProvider [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,8 +33,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-IPAllowListProvider Contoso.com ``` @@ -40,9 +46,7 @@ This example removes the IP Allow list provider named Contoso.com. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -50,6 +54,7 @@ Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -60,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +73,7 @@ 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 @@ -86,6 +91,7 @@ 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 @@ -101,6 +107,7 @@ 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 @@ -109,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/586450e5-e481-4025-850b-75ecd65fa821.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md similarity index 78% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPBlockListEntry.md rename to exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md index d835470f61..81f9179a23 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-IPBlocklistEntry @@ -13,12 +16,15 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPBlockListEntry cmdlet to remove IP block list entries that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPBlocklistEntry [-Identity] [-Confirm] [-Server ] [-WhatIf] +Remove-IPBlocklistEntry [-Identity] + [-Confirm] + [-Server ] + [-WhatIf] [] ``` @@ -27,15 +33,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-IPBlockListEntry | Where {$_.IPRange -eq '192.168.0.100'} | Remove-IPBlockListEntry ``` This example removes the IP address 192.168.0.100 from the IP Block list. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-IPBlockListEntry | Where {$_.IPRange -eq '192.168.0.0/24'} | Remove-IPBlockListEntry ``` @@ -51,6 +57,7 @@ Type: IPListEntryIdentity Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -61,8 +68,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -70,6 +76,7 @@ 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 @@ -81,11 +88,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -97,6 +101,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -112,6 +117,7 @@ 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 @@ -120,20 +126,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c72aef06-68fd-47ba-a9ac-9984e31d13e4.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md similarity index 79% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPBlockListProvider.md rename to exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md index 46cedd0af4..27e5a41a87 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-IPBlockListProvider @@ -13,13 +16,16 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPBlockListProvider cmdlet to remove IP Block list providers that are used by the Connection Filtering agent on Edge Transport server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPBlockListProvider [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-IPBlockListProvider [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,8 +33,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-IPBlockListProvider Contoso.com ``` @@ -40,9 +46,7 @@ This example removes the IP Block list provider named Contoso.com. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -50,6 +54,7 @@ Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -60,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +73,7 @@ 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 @@ -86,6 +91,7 @@ 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 @@ -101,6 +107,7 @@ 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 @@ -109,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/9232ceb3-736a-4106-83e5-ad26bbd8cfee.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-InboundConnector.md b/exchange/exchange-ps/exchange/Remove-InboundConnector.md new file mode 100644 index 0000000000..643afa3df0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-InboundConnector.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-InboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-InboundConnector cmdlet to delete an Inbound connector from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-InboundConnector [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-InboundConnector "Contoso Inbound Connector" +``` + +This example deletes the Inbound connector named Contoso Inbound Connector. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-InboxRule.md b/exchange/exchange-ps/exchange/Remove-InboxRule.md new file mode 100644 index 0000000000..78a9af6e7b --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-InboxRule.md @@ -0,0 +1,207 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-InboxRule cmdlet to remove an Inbox rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-InboxRule [-Identity] + [-AlwaysDeleteOutlookRulesBlob] + [-Confirm] + [-DomainController ] + [-Force] + [-Mailbox ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-InboxRule -Mailbox Joe@Contoso.com -Identity "ProjectA-MoveToFolderA" +``` + +This example removes the Inbox rule ProjectA-MoveToFolderA from the mailbox Joe@Contoso.com. + +### Example 2 +```powershell +Get-InboxRule -Mailbox "Joe@Contoso.com" | Remove-InboxRule +``` + +This example removes all Inbox rules from the mailbox Joe@Contoso.com. + +## PARAMETERS + +### -Identity +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 +- RuleIdentity property (for example, 16752869479666417665). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). + +```yaml +Type: InboxRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AlwaysDeleteOutlookRulesBlob +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md new file mode 100644 index 0000000000..daac4a22b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-InformationBarrierPolicy + +## 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-InformationBarrierPolicy cmdlet to remove information barrier policies from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-InformationBarrierPolicy [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-InformationBarrierPolicy -Identity HR-Sales +``` + +This example removes the information barrier policy named HR-Sales. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the information barrier policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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 + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md similarity index 77% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md rename to exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md index 1af4b77e96..6f4cb23daa 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-IntraOrganizationConnector @@ -13,26 +16,29 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-IntraOrganizationConnector cmdlet to remove existing Intra-Organization connectors. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IntraOrganizationConnector [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-IntraOrganizationConnector [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION Intra-Organizational connectors enable features and services between divisions in your Exchange organization. It allows for the expansion of organizational boundaries for features and services across different hosts and network boundaries, such as between Active Directory forests, between on-premises and cloud-based organizations or between tenants hosted in the same or different datacenters. -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. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-IntraOrganizationConnector "Contoso On-premises-Exchange Online" ``` @@ -44,9 +50,7 @@ This example removes the existing Intra-Organization connector named "Contoso On 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 - - Distinguished name (DN) - - GUID ```yaml @@ -54,6 +58,7 @@ Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -64,8 +69,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +77,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -90,6 +95,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -105,6 +111,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -113,20 +120,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/41d1fc57-9ff8-4a4c-bdc2-1875d8996500.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-JournalRule.md b/exchange/exchange-ps/exchange/Remove-JournalRule.md similarity index 75% rename from exchange/exchange-ps/exchange/policy-and-compliance/Remove-JournalRule.md rename to exchange/exchange-ps/exchange/Remove-JournalRule.md index c2d01fe979..da555a20f0 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-JournalRule.md +++ b/exchange/exchange-ps/exchange/Remove-JournalRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-JournalRule @@ -13,24 +16,27 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-JournalRule cmdlet to remove an existing journal rule. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-JournalRule [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-JournalRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-JournalRule "Brokerage Communications" ``` @@ -46,6 +52,7 @@ 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 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ 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 Default value: None @@ -82,6 +89,7 @@ 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 @@ -97,6 +105,7 @@ 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 Default value: None @@ -105,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7cb9d691-2b0c-4f64-982d-ce69f3c3e757.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-Label.md b/exchange/exchange-ps/exchange/Remove-Label.md new file mode 100644 index 0000000000..7b1812a00e --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-Label.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-Label + +## 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-Label cmdlet to remove sensitivity labels from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-Label [-Identity] + [-Confirm] + [-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-Label -Identity "Marketing Group" +``` + +This example removes the sensitivity label named Marketing Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: 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-LabelPolicy.md b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md new file mode 100644 index 0000000000..2289247216 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-LabelPolicy + +## 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-LabelPolicies cmdlet to remove sensitivity label policies from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-LabelPolicy [-Identity] + [-Confirm] + [-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-LabelPolicy -Identity "Marketing Group" +``` + +This example removes the policy named Marketing Group. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MailContact.md b/exchange/exchange-ps/exchange/Remove-MailContact.md new file mode 100644 index 0000000000..8a14dbb711 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailContact.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MailContact cmdlet to delete existing mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailContact [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailContact -Identity contoso.com/john +``` + +This example removes the mail contact named John. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MailUser.md b/exchange/exchange-ps/exchange/Remove-MailUser.md new file mode 100644 index 0000000000..022d16da1d --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailUser.md @@ -0,0 +1,207 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MailUser cmdlet to remove existing mail users. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailUser [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-PermanentlyDelete] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailUser -Identity "Ed Meadows" +``` + +This example removes the mail user named Ed Meadows. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IgnoreLegalHold +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. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. + +After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -PermanentlyDelete +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. + +**Notes**: + +- This switch works only on mail users that have already been deleted, but are still recoverable (known as soft-deleted mail-users) that also have a blank value for the ExternalDirectoryObjectId property. +- Use the Get-MailUser cmdlet to identify the soft-deleted mail user, and then pipe the results to the Remove-MailUser cmdlet with this switch. For example, `Get-MailUser -Identity Laura -SoftDeletedMailUser | Remove-MailUser -PermanentlyDelete`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-Mailbox.md b/exchange/exchange-ps/exchange/Remove-Mailbox.md new file mode 100644 index 0000000000..27447b1e7a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-Mailbox.md @@ -0,0 +1,547 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-Mailbox cmdlet to delete mailboxes and the associated user accounts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Remove-Mailbox [-Identity] + [-Permanent ] + [-Arbitration] + [-AuditLog] + [-AuxAuditLog] + [-Confirm] + [-DomainController ] + [-Force] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-Migration] + [-PublicFolder] + [-RemoveArbitrationMailboxWithOABsAllowed] + [-RemoveLastArbitrationMailboxAllowed] + [-SupervisoryReviewPolicy] + [-WhatIf] + [] +``` + +### StoreMailboxIdentity +``` +Remove-Mailbox -Database -StoreMailboxIdentity + [-Arbitration] + [-AuditLog] + [-AuxAuditLog] + [-Confirm] + [-DomainController ] + [-Force] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-Migration] + [-PublicFolder] + [-RemoveArbitrationMailboxWithOABsAllowed] + [-RemoveLastArbitrationMailboxAllowed] + [-SupervisoryReviewPolicy] + [-WhatIf] + [] +``` + +### Default +``` +Remove-Mailbox [-Identity] [-PermanentlyDelete] + [-Confirm] + [-Force] + [-Migration] + [-PublicFolder] + [-RemoveCNFPublicFolderMailboxPermanently] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Identity parameter alone to disconnect the mailbox from the user and remove the user account. The mailbox still exists, and is retained until the deleted mailbox retention period expires. The deleted mailbox retention period is controlled by the MailboxRetention property on the mailbox database or on the mailbox itself if the UseDatabaseRetentionDefaults property is False. + +Use the Identity and Permanent parameters to disconnect the mailbox from the user, remove the user account, and immediately remove the mailbox from the mailbox database. The mailbox doesn't remain in the mailbox database as a disconnected mailbox. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-Mailbox -Identity "John Rodman" +``` + +This example removes the mailbox and the user account for the user named John Rodman. The mailbox remains in the mailbox database for the deleted mailbox retention period that's configured for the database. + +### Example 2 +```powershell +Remove-Mailbox -Identity "John Rodman" -Permanent $true +``` + +In on-premises Exchange, this example removes the mailbox and the user account for the user named John Rodman. The mailbox is immediately and permanently removed from the mailbox database. + +### Example 3 +```powershell +$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. + +### Example 4 +```powershell +Get-Mailbox -Identity Laura -SoftDeletedMailbox | Remove-Mailbox -PermanentlyDelete +``` + +In Exchange Online, this example removes the specified soft-deleted mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the mailbox that you want to remove. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Database parameter. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +When you use this parameter with the StoreMailboxIdentity parameter to identify and remove the mailbox, the mailbox is immediately and permanently deleted from the database, so you can't reconnect or restore the mailbox. You can't use either of these parameters with the Identity parameter. + +If you've disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store, use the Database and StoreMailboxIdentity parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: StoreMailboxIdentity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoreMailboxIdentity +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. + +When you use this parameter with the Database parameter to identify and remove the mailbox, the mailbox is immediately and permanently deleted from the database, so you can't reconnect or restore the mailbox. You can't either of these parameters with the Identity parameter. + +If you've disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store, use the Database and StoreMailboxIdentity parameters. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: StoreMailboxIdentity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +To remove arbitration mailboxes that are used to store audit log settings or data, don't use this switch. Instead, use the AuditLog or AuxAuditLog switches. + +```yaml +Type: SwitchParameter +Parameter Sets: StoreMailboxIdentity, Identity +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 +``` + +### -AuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To remove other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: StoreMailboxIdentity, Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxAuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To remove other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: StoreMailboxIdentity, Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: StoreMailboxIdentity, Identity +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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: StoreMailboxIdentity, Identity +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 +``` + +### -IgnoreLegalHold +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. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. + +After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, StoreMailboxIdentity +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 +``` + +### -Migration +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permanent +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -PermanentlyDelete +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. + +**Notes**: + +- This switch works only on mailboxes that have already been deleted, but are still recoverable (known as soft-deleted mailboxes). Use the Get-Mailbox cmdlet to identify the soft-deleted mailbox, and then pipe the results to the Remove-Mailbox cmdlet as shown in Example 4 in this topic. +- This switch doesn't work on soft-deleted mailboxes that are on In-Place Hold or Litigation Hold (known as inactive mailboxes). + +```yaml +Type: SwitchParameter +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveArbitrationMailboxWithOABsAllowed +This parameter is available only in on-premises Exchange. + +The RemoveArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being removed. You don't need to specify a value with this switch. + +When you use this switch, the arbitration mailbox is removed even if OABs are present in the mailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: StoreMailboxIdentity, Identity +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 +``` + +### -RemoveCNFPublicFolderMailboxPermanently +This parameter is available only in the cloud-based service. + +{{ Fill RemoveCNFPublicFolderMailboxPermanently Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveLastArbitrationMailboxAllowed +This parameter is available only in on-premises Exchange. + +The RemoveLastArbitrationMailboxAllowed switch specifies whether to remove the specified mailbox, even if it's the last arbitration mailbox in the organization. You don't need to specify a value with this switch. + +If you remove the last arbitration mailbox in the organization, you can't have user-created distribution groups or moderated recipients. + +```yaml +Type: SwitchParameter +Parameter Sets: StoreMailboxIdentity, Identity +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 +``` + +### -SupervisoryReviewPolicy +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, StoreMailboxIdentity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MailboxDatabase.md b/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md new file mode 100644 index 0000000000..3e424e0421 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-MailboxDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-MailboxDatabase cmdlet to delete a mailbox database object. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxDatabase [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +If the mailbox database has a database copy, the Remove-MailboxDatabase cmdlet also removes the copy. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxDatabase -Identity MailboxDatabase01 +``` + +This example removes the mailbox database MailboxDatabase01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -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/database-availability-groups/Remove-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md similarity index 80% rename from exchange/exchange-ps/exchange/database-availability-groups/Remove-MailboxDatabaseCopy.md rename to exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md index fb4879b0be..6fd45481ac 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Remove-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MailboxDatabaseCopy @@ -13,32 +16,34 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MailboxDatabaseCopy cmdlet to remove a passive copy of a mailbox database. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxDatabaseCopy [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-MailboxDatabaseCopy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION 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. 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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. ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MailboxDatabaseCopy -Identity DB1\MBX3 ``` @@ -54,6 +59,7 @@ Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -64,8 +70,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +78,7 @@ 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 @@ -88,6 +94,7 @@ 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 @@ -103,6 +110,7 @@ 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 @@ -111,20 +119,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/18a41719-99dd-4bf7-97af-2e9b0e39ba2d.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Remove-MailboxExportRequest.md rename to exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md index 0e766ecd95..6f850b68be 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MailboxExportRequest @@ -13,20 +16,22 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MailboxExportRequest cmdlet to remove fully or partially completed export requests. You can create multiple export requests for a specified mailbox provided that you specify a distinct name. Completed export requests aren't cleared automatically; they need to be removed by using this cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). When a partially completed export request is removed, content already exported isn't removed from the PST file. If you want to start a new export request to the same file name and start with an empty PST file, you need to rename or delete the previous PST file. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Remove-MailboxExportRequest [-Identity] [-Force] +Remove-MailboxExportRequest [-Identity] + [-Force] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### MigrationRequestQueue @@ -34,7 +39,8 @@ Remove-MailboxExportRequest [-Identity] [-Forc Remove-MailboxExportRequest -RequestGuid -RequestQueue [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -42,26 +48,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MailboxExportRequest -Identity "Ayla\MailboxExport1" ``` This example removes the second export request Ayla\\MailboxExport1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxExportRequest -Status Completed | Remove-MailboxExportRequest ``` This example removes all export requests that have the status of Completed. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Remove-MailboxExportRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f ``` @@ -70,15 +76,16 @@ This example cancels the export request by using the RequestGuid parameter for a ## PARAMETERS ### -Identity -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: \\\\. +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 in conjunction with the RequestGuid parameter. +You can't use this parameter with the RequestGuid parameter. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -87,13 +94,14 @@ Accept wildcard characters: False ``` ### -RequestGuid -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 in conjunction with the Identity parameter. +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 Default value: None @@ -104,9 +112,9 @@ Accept wildcard characters: False ### -RequestQueue 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -115,6 +123,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -125,8 +134,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -134,6 +142,7 @@ 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 @@ -149,6 +158,7 @@ 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 @@ -157,13 +167,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -179,6 +192,7 @@ 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 @@ -187,20 +201,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a5b99fcc-1f79-4a31-b04a-610ff020450d.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md new file mode 100644 index 0000000000..3dccb1d13c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md @@ -0,0 +1,273 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MailboxFolderPermission cmdlet to remove folder-level permissions for users in mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Remove-MailboxFolderPermission [-Identity] -User + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### Identity +``` +Remove-MailboxFolderPermission [-Identity] -User + [-Confirm] + [-Force] + [-SendNotificationToUser ] + [-WhatIf] + [] +``` + +### ResetDelegateUserCollection +``` +Remove-MailboxFolderPermission [-Identity] [-ResetDelegateUserCollection] + [-Confirm] + [-Force] + [-SendNotificationToUser ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxFolderPermission -Identity kim@contoso.com:\Training -User john@contoso.com +``` + +This example removes John's permissions to the Training folder in Kim's mailbox. + +### Example 2 +```powershell +Remove-MailboxFolderPermission -Identity kim@contoso.com:\Calendar -ResetDelegateUserCollection +``` + +This example will clear any corrupted delegate information from Kim's mailbox. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for the Identity parameter are `john@contoso.com:\Calendar` or `John:\Marketing\Reports`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailboxFolderUserIdParameter +Parameter Sets: Default, Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Default +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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, ResetDelegateUserCollection +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetDelegateUserCollection +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`. + +When you use this switch, the value of Identity should be the user's primary calendar folder (for example, `kim@contoso.com:\Calendar`). + +```yaml +Type: SwitchParameter +Parameter Sets: ResetDelegateUserCollection +Aliases: +Applicable: Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendNotificationToUser +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. + +This parameter only applies to calendar folders. + +```yaml +Type: Boolean +Parameter Sets: Identity, ResetDelegateUserCollection +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) + +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) + +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) + +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md new file mode 100644 index 0000000000..688966ba55 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxirmaccess +applicable: Exchange Online +title: Remove-MailboxIRMAccess +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-MailboxIRMAccess + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-MailboxIRMAccess cmdlet to allow (unblock) delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxIRMAccess [-Identity] -User + [] +``` + +## DESCRIPTION +> [!NOTE] +> This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com +``` + +This example removes the restriction from IRM-protected messages in Lynette's mailbox for delegate Chris. In other words, delegate Chris can now access IRM-protected messages in Lynette's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -User +**Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +The User parameter specifies the delegate who is no longer blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Remove-MailboxImportRequest.md rename to exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md index 8d9ceed600..e4a36d24de 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MailboxImportRequest @@ -13,20 +16,24 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxImportRequest cmdlet to remove fully or partially completed import requests. Completed import requests aren't automatically cleared. Requests need to be removed by using the Remove-MailboxImportRequest cmdlet. Multiple import requests can exist against the same mailbox if you provide a distinct import request name. -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 the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). Removing a partially completed import request removes the request from the Microsoft Exchange Mailbox Replication service (MRS) job queue. Any import progress that was made until the removal won't be reverted. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Remove-MailboxImportRequest [-Identity] [-Force] +Remove-MailboxImportRequest [-Identity] + [-Force] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### MigrationRequestQueue @@ -34,7 +41,8 @@ Remove-MailboxImportRequest [-Identity] [-Forc Remove-MailboxImportRequest -RequestGuid -RequestQueue [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -42,26 +50,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MailboxImportRequest -Identity "Ayla\MailboxImport1" ``` This example removes the second import request for Ayla's mailbox Ayla\\MailboxImport1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-MailboxImportRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f ``` This example cancels the import request by using the RequestGuid parameter for a mailbox or archive on MBXDB01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxImportRequest -Status Completed | Remove-MailboxImportRequest ``` @@ -70,7 +78,7 @@ This example removes all completed import requests. ## PARAMETERS ### -Identity -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: \\\\. +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. @@ -79,6 +87,7 @@ 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 Default value: None @@ -98,6 +107,7 @@ Type: Guid Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -110,9 +120,9 @@ 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: -- Database GUID - -- Database name +- Name +- Distinguished name (DN) +- GUID You can't use this parameter with the Identity parameter. @@ -121,6 +131,7 @@ Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -131,8 +142,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -140,6 +150,7 @@ 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 Default value: None @@ -156,7 +167,8 @@ 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -165,13 +177,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -187,6 +202,7 @@ 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 Default value: None @@ -195,20 +211,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/4e8deb88-b078-4032-a47a-702ac0efe4eb.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md new file mode 100644 index 0000000000..b6e76be563 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md @@ -0,0 +1,494 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MailboxPermission cmdlet to remove permissions from a user's mailbox or from an Exchange Server 2016, Exchange Server 2019 or Exchange Online mail user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AccessRights +``` +Remove-MailboxPermission [-Identity] -AccessRights -User + [-BypassMasterAccountSid] + [-Confirm] + [-Deny] + [-DomainController ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-InheritanceType ] + [-SoftDeletedMailbox] + [-WhatIf] + [] +``` + +### Instance +``` +Remove-MailboxPermission [[-Identity] ] -Instance + [-AccessRights ] + [-Confirm] + [-Deny] + [-DomainController ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-InheritanceType ] + [-User ] + [-WhatIf] + [] +``` + +### Owner +``` +Remove-MailboxPermission [[-Identity] ] + [-BypassMasterAccountSid] + [-Confirm] + [-DomainController ] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +### ClearAutoMapping +``` +Remove-MailboxPermission [-Identity] [-ClearAutoMapping] + [-BypassMasterAccountSid] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +### ResetDefault +``` +Remove-MailboxPermission [-Identity] [-ResetDefault] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxPermission -Identity "Yuuto Sasaki" -User "Pedro Pizarro" -AccessRights FullAccess -InheritanceType All +``` + +This example removes Pedro Pizarro's full access permission to Yuuto Sasaki's mailbox. + +### Example 2 +```powershell +Remove-MailboxPermission -Identity "HR Project" -ClearAutoMapping +``` + +In Exchange Online, this example excludes the HR Project mailbox from auto-mapping in Outlook for all users who have Full Access permission to the mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox where you are removing permissions. You can use any value that uniquely identifies the mailbox: For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: AccessRights, Owner, ClearAutoMapping, ResetDefault +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +The AccessRights parameter specifies the permission that you want to remove from the user on the mailbox. Valid values are: + +- FullAccess +- SendAs +- ExternalAccount +- DeleteItem +- ReadPermission +- ChangePermission +- ChangeOwner + +You can specify multiple values separated by commas. + +```yaml +Type: MailboxRights[] +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: 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 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: MailboxAcePresentationObject +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -User +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 +- Mail users +- Security groups + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SecurityPrincipalIdParameter +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 +``` + +### -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. + +Auto-mapping uses Autodiscover to automatically add mailboxes to a user's Outlook profile if the user has Full Access permission to the mailbox. Use this switch to exclude this mailbox from auto-mapping for all users who have Full Access permission to the mailbox. + +You can't use this switch with the User or AccessRights parameters. + +**Note**: If you use this switch in a Remove-MailboxPermission command, but the mailbox is not excluded from auto-mapping for a user, remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet with the User parameter. Then, reassign the user's Full Access permission on the mailbox using the Add-MailboxPermission cmdlet with the AutoMapping parameter set to the value $false. + +```yaml +Type: SwitchParameter +Parameter Sets: ClearAutoMapping +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetDefault +This parameter is functional only in the cloud-based service. + +The ResetDefault switch resets the default security descriptor of the mailbox. You don't need to specify a value with this switch. + +Permissions on the mailbox are reset so only the mailbox owner has Full Access permission to the mailbox. The following types of permissions are not affected: + +- Recipient permissions (for example, SendAs, SendOnBehalf and delegates). +- Mailbox folder permissions assigned using the MailboxFolderPermission cmdlets. +- Mailbox folder permissions assigned using Outlook or other MAPI clients. + +Also, because this switch removes Full Access permission from other users on the mailbox, the mailbox is no longer auto-mapped by Autodiscover into the Outlook profiles of other users. + +You can't use this switch with the User for AccessRights parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassMasterAccountSid +This parameter is available only in the cloud-based service. + +The BypassMasterAccountSid switch suppresses the following error: `Can't remove the access control entry on the object "User" for the user account because the ACE doesn't exist on the object.` You don't need to specify a value with this switch. + +Typically, you only need to use this switch in Office 365 Dedicated or ITAR legacy environments. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights, Owner, ClearAutoMapping +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -Deny +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights, Owner, Instance +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -InheritanceType +The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. Valid values are: + +- None +- All (this is the default value) +- Children +- Descendents [sic] +- SelfAndChildren + +```yaml +Type: ActiveDirectorySecurityInheritance +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedMailbox +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. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md new file mode 100644 index 0000000000..c9037afa2f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md @@ -0,0 +1,147 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-MailboxRepairRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-MailboxRepairRequest cmdlet to remove mailbox repair requests from a mailbox database that were created using the New-MailboxRepairRequest cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxRepairRequest [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: `DatabaseGuid\RequestGuid\JobGuid`. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that may contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete `DatabaseGuid\RequestGuid\JobGuid` value. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxRepairRequest -Database "EXCH-MBX-01" | Remove-MailboxRepairRequest +``` + +This example removes all mailbox repair requests for the mailbox database EXCH-MBX-01. + +### Example 2 +```powershell +Get-MailboxRepairRequest -Database "EXCH-MBX-02" | Format-List Identity + +Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5 +``` + +This example removes all related mailbox repair requests that have the same `DatabaseGuid\RequestGuid` value. The example uses the Get-MailboxRepairRequest cmdlet to display the value of the Identity parameter for all mailbox repair request for EXCH-MBX-02 mailbox database. + +### Example 3 +```powershell +Get-MailboxRepairRequest -Database "EXCH-MBX-02" | Format-List Identity + +Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\189c7852-49bd-4737-a53e-6e6caa5a183c\1d8ca58a-186f-4dc6-b481-f835b548a929 +``` + +This example deletes a specific mailbox repair request by specifying the unique `DatabaseGuid\RequestGuid\JobGuid` identity value. The example also uses the Get-MailboxRepairRequest cmdlet to display the identities of all mailbox repair request for the EXCH-MBX-02 mailbox database. + +## PARAMETERS + +### -Identity +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 +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 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/mailboxes/Remove-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md similarity index 77% rename from exchange/exchange-ps/exchange/mailboxes/Remove-MailboxRestoreRequest.md rename to exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md index cb7f5b1429..96cc00e783 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MailboxRestoreRequest @@ -13,16 +16,18 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxRestoreRequest cmdlet to remove fully or partially completed restore requests. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Remove-MailboxRestoreRequest [-Identity] [-Force] +Remove-MailboxRestoreRequest [-Identity] + [-Force] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### MigrationRequestQueue @@ -30,7 +35,8 @@ Remove-MailboxRestoreRequest [-Identity] [-Fo Remove-MailboxRestoreRequest -RequestGuid -RequestQueue [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -38,26 +44,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" ``` This example removes the second restore request Ayla\\MailboxRestore1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxRestoreRequest -Status Completed | Remove-MailboxRestoreRequest ``` This example removes all restore requests that have the status of Completed. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Remove-MailboxRestoreRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f ``` @@ -66,7 +72,7 @@ This example cancels the restore request by using the RequestGuid parameter for ## PARAMETERS ### -Identity -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: \\\\. +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). @@ -75,6 +81,7 @@ 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 Default value: None @@ -87,13 +94,14 @@ 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. -This parameter can't be used in conjunction with the Identity 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 Default value: None @@ -104,19 +112,20 @@ Accept wildcard characters: False ### -RequestQueue 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 one of the following values: - -- GUID of the database +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: -- Database name +- Name +- Distinguished name (DN) +- GUID -If you specify the RequestQueue parameter, you must also specify the RequestGuid parameter. This parameter can't be used in conjunction with the Identity parameter. +You must use this parameter with the RequestGuid parameter. You can't use this parameter with the Identity parameter. ```yaml Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -127,8 +136,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -136,6 +144,7 @@ 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 Default value: None @@ -153,6 +162,7 @@ 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 @@ -161,13 +171,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -183,6 +196,7 @@ 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 Default value: None @@ -191,20 +205,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a3d3327e-99b0-4d44-bd81-3e8f59eab41d.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md new file mode 100644 index 0000000000..eca5f3db04 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MailboxSearch cmdlet to remove a mailbox search. + +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxSearch [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxSearch -Identity "Project Contoso" +``` + +This example removes the mailbox search Project Contoso. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md new file mode 100644 index 0000000000..723d1efc08 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md @@ -0,0 +1,153 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MailboxUserConfiguration cmdlet to remove user configuration items from mailboxes. Typically, after you delete a user configuration item, it's automatically recreated the next time the user uses that feature in their mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxUserConfiguration [-Identity] -Mailbox + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxUserConfiguration -Mailbox julia@contoso.com -Identity Configuration\IPM.Configuration.Aggregated.OwaUserConfiguration +``` + +This example removes the specified user configuration item from the mailbox julia@contoso.com. + +## PARAMETERS + +### -Identity +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. +- Valid values for ItemName start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. + +```yaml +Type: MailboxUserConfigurationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md rename to exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md index 5f658e5d1d..a5c3c84db4 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MalwareFilterPolicy @@ -15,22 +18,26 @@ Use the Remove-MalwareFilterPolicy cmdlet to remove malware filter policies from When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-MalwareFilterRule cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MalwareFilterPolicy [-Identity] [-Confirm] [-DomainController ] - [-Force] [-WhatIf] [] +Remove-MalwareFilterPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MalwareFilterPolicy "Contoso Malware Filter Policy" ``` @@ -46,6 +53,7 @@ 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 Default value: None @@ -56,8 +64,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +72,7 @@ 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 Default value: None @@ -82,6 +90,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -90,13 +99,18 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -112,6 +126,7 @@ 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 Default value: None @@ -120,20 +135,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/cfc57936-1cc6-44dc-90c8-d77f37ea2661.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md similarity index 76% rename from exchange/exchange-ps/exchange/antispam-antimalware/Remove-MalwareFilterRule.md rename to exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md index 64a8d1cc15..4171ff3c01 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MalwareFilterRule @@ -13,22 +16,25 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MalwareFilterRule cmdlet to remove malware filter rules from your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MalwareFilterRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-MalwareFilterRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MalwareFilterRule "Contoso Recipients" ``` @@ -44,6 +50,7 @@ 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 Default value: None @@ -54,8 +61,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +69,7 @@ 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 Default value: None @@ -80,6 +87,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,6 +103,7 @@ 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 Default value: None @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d7dc6f9b-a44b-480e-a795-1d621c08c0e5.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md rename to exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md index 3ee97f59e3..3ec37d8684 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ManagedContentSettings @@ -13,24 +16,27 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-ManagedContentSettings cmdlet to delete managed content settings from a managed folder. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ManagedContentSettings [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-ManagedContentSettings [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ManagedContentSettings -Identity MyManagedContentSettings ``` @@ -46,6 +52,7 @@ Type: ELCContentSettingsIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -80,6 +87,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -95,6 +103,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dbf7f047-87b8-4d8d-bb9b-e2809db1d8b5.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md b/exchange/exchange-ps/exchange/Remove-ManagedFolder.md new file mode 100644 index 0000000000..7b68957f99 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ManagedFolder.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ManagedFolder + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Remove-ManagedFolder cmdlet to remove a managed folder from Active Directory. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ManagedFolder [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ManagedFolder MyManagedFolder +``` + +This example removes the managed folder MyManagedFolder. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md new file mode 100644 index 0000000000..4cd1f7a86c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md @@ -0,0 +1,148 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ManagedFolderMailboxPolicy + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Remove-ManagedFolderMailboxPolicy cmdlet to delete managed folder mailbox policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ManagedFolderMailboxPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +If you remove a managed folder mailbox policy that's applied to users' mailboxes, the affected mailboxes may no longer have retention settings. Therefore, before using this cmdlet to remove a policy, you should determine if the managed folder mailbox policy is applied to any users, and apply another policy to those users. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ManagedFolderMailboxPolicy -Identity "My Managed Folder Mailbox Policy" +``` + +This example removes the managed folder mailbox policy My Managed Folder Mailbox Policy. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +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. + +This switch hides the confirmation prompt when the managed folder mailbox policy that's being removed is assigned to a mailbox user. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRole.md b/exchange/exchange-ps/exchange/Remove-ManagementRole.md new file mode 100644 index 0000000000..60ed3913e0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ManagementRole.md @@ -0,0 +1,219 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ManagementRole cmdlet to remove custom management roles that you don't need anymore. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ManagementRole [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-Recurse] + [-UnScopedTopLevel] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ManagementRole ExampleRole1 +``` + +This example removes the single role ExampleRole1. + +### Example 2 +```powershell +Remove-ManagementRole ExampleRole2 -Recurse -WhatIf +``` + +This example runs the Remove-ManagementRole cmdlet with the WhatIf switch. The WhatIf switch lets the command run as if it were going to perform the action you specified but doesn't commit any changes. Instead, it displays the results of what would have happened, so you can verify that the actions are correct. + +If the results are as expected, remove the WhatIf switch and run the command again to remove the ExampleRole2 parent role and all its child roles. + +### Example 3 +```powershell +Get-ManagementRole *Example* | Remove-ManagementRole -WhatIf +``` + +This example uses the Get-ManagementRole cmdlet to get a list of roles that contain the string "Example" in the role name, and then pipes the list to the Remove-ManagementRole cmdlet. The Remove-ManagementRole cmdlet, because the WhatIf switch is specified, displays the roles that would have been removed but doesn't commit any changes. If the results are as expected, the command can be run again without the WhatIf switch to remove the roles. + +### Example 4 +```powershell +Remove-ManagementRole "In-house scripts" -UnScopedTopLevel +``` + +In on-premises Exchange, this example removes the In-house scripts unscoped top-level management role. Because this is an unscoped top-level role, the UnScopedTopLevel switch must be used. Note that the UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. + +For more information about unscoped top-level management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). + +## PARAMETERS + +### -Identity +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnScopedTopLevel +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). + +The UnScopedTopLevel switch specifies the role that you want to remove is an unscoped top-level role. You don't need to specify a value with this switch. + +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md new file mode 100644 index 0000000000..7540ec48ac --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md @@ -0,0 +1,161 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ManagementRoleAssignment cmdlet to remove management role assignments. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ManagementRoleAssignment [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ManagementRoleAssignment "Recipients_Seattle Recipient Management" +``` + +This example removes the Recipients\_Seattle Recipient Management role assignment. + +### Example 2 +```powershell +Get-ManagementRoleAssignment Detroit* | Remove-ManagementRoleAssignment -WhatIf +``` + +This example retrieves a list of role assignments that begin with the string "Detroit" and attempts to remove them with the Remove-ManagementRoleAssignment cmdlet. Because the WhatIf switch is included with the Remove-ManagementRoleAssignment command, the command displays the changes that would have occurred but doesn't commit any changes. + +After the list of role assignments to be removed is confirmed, remove the WhatIf switch and run the command again to remove the role assignments. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md new file mode 100644 index 0000000000..a6d8a1d54c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md @@ -0,0 +1,169 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ManagementRoleEntry cmdlet to remove existing management role entries. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ManagementRoleEntry [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-ManagementRoleEntry cmdlet removes existing role entries. However, you can't remove role entries from built-in management roles. + +For more information about management role entries, see [Understanding management roles](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ManagementRoleEntry "Tier 1 Help Desk\New-Mailbox" +``` + +This example removes the New-Mailbox role entry from the Tier 1 Help Desk role. + +### Example 2 +```powershell +Get-ManagementRoleEntry "Tier 1 Help Desk\*" | where {$_.Name -like 'New-*'} | foreach {Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} +``` + +This example removes all the role entries that have the verb New on the Tier 1 Help Desk role by piping the output of the Get-ManagementRoleEntry cmdlet to the Where-Object cmdlet which specifies the verb filter, and then these results are piped to the Remove-ManagementRoleEntry cmdlet. + +This example forces you to acknowledge the command before proceeding (we didn't use `-Confirm:$false` or `-Force`). + +**Note**: Exchange Online PowerShell requires the complex syntax as described, and the same command also works in the Exchange Management Shell in on-premises Exchange servers. The Exchange Management Shell supports much simpler syntax for the same result, but the command doesn't work in Exchange Online PowerShell: `Get-ManagementRoleEntry "Tier 1 Help Desk\New-* | Remove-ManagementRoleEntry`. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the role entry that you want to remove. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). + +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). + +If the role entry name contains spaces, enclose the name in quotation marks ("). + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-ManagementScope.md b/exchange/exchange-ps/exchange/Remove-ManagementScope.md new file mode 100644 index 0000000000..ec73842594 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ManagementScope.md @@ -0,0 +1,161 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-ManagementScope cmdlet to remove an existing management scope. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ManagementScope [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ManagementScope "Redmond Servers" +``` + +This example removes the Redmond Servers scope. + +### Example 2 +```powershell +Get-ManagementScope -Orphan | Remove-ManagementScope -WhatIf +``` + +This example retrieves a list of all the orphaned scopes using the Get-ManagementScope cmdlet and pipes the output to the Remove-ManagementScope cmdlet. Because the WhatIf switch is used with the Remove-ManagementScope cmdlet, the cmdlet only displays the scopes that would have been removed but doesn't commit any changes. + +After you verify that the scopes to be removed are correct, run the command again without the WhatIf switch. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md new file mode 100644 index 0000000000..936faaf305 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-MapiVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-MapiVirtualDirectory cmdlet to remove Message Application Programming Interface (MAPI) virtual directories from Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MapiVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" +``` + +This example removes the MAPI virtual directory from the local server named ContosoMail. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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-Message.md b/exchange/exchange-ps/exchange/Remove-Message.md new file mode 100644 index 0000000000..ecf08727f1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-Message.md @@ -0,0 +1,185 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-Message + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-Message cmdlet to delete a message from a queue on a Mailbox server or an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Remove-Message -Filter [-Server ] + [-Confirm] + [-WhatIf] + [-WithNDR ] + [] +``` + +### Identity +``` +Remove-Message [-Identity] + [-Confirm] + [-WhatIf] + [-WithNDR ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-Message -Server Server1 -Filter "FromAddress -eq 'Kweku@contoso.com'" -WithNDR $false +``` + +This example removes all messages that meet the following criteria without generating NDRs: + +- The messages are sent by the sender Kweku@contoso.com. +- The messages are queued on the server Server1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -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 +``` + +### -WithNDR +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MessageClassification.md b/exchange/exchange-ps/exchange/Remove-MessageClassification.md new file mode 100644 index 0000000000..430c30d775 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MessageClassification.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MessageClassification cmdlet to delete an existing message classification instance from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MessageClassification [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MessageClassification -Identity "My Message Classification" +``` + +This example removes the message classification named "My Message Classification". + +## PARAMETERS + +### -Identity +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 +- Identity: `Default\` or `\` (for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`). +- ClassificationID (GUID) + +```yaml +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md new file mode 100644 index 0000000000..7a3f08fc37 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md @@ -0,0 +1,182 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MigrationBatch cmdlet to delete a migration batch that either isn't running or has been completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MigrationBatch [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Force] + [-Partition ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-MigrationBatch cmdlet removes a migration batch. All subscriptions are deleted and any object related to the migration batch is also deleted. + +If you use the Force 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MigrationBatch -Identity Cutover1 +``` + +This example removes the migration batch Cutover1. + +### Example 2 +```powershell +Remove-MigrationBatch -Identity LocalMove1 -Force +``` + +This example removes the corrupted migration batch LocalMove1. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +Use this switch to remove a corrupted migration batch. Corrupted migration batches have a status of Corrupted. If you try to remove a corrupted migration batch without using this switch, you receive an error saying the migrated batch can't be found. + +If you use this switch to remove a corrupted migration batch, the individual user requests (also called job items) and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md new file mode 100644 index 0000000000..9484d7d7e2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md @@ -0,0 +1,152 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MigrationEndpoint cmdlet to remove existing migration endpoints for source or destination servers for cutover or staged Exchange migrations, IMAP migrations and remote moves. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MigrationEndpoint [-Identity] + [-Confirm] + [-DomainController ] + [-Partition ] + [-WhatIf] + [] +``` + +## 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MigrationEndpoint -Identity CrossForestME01 +``` + +This example removes the migration endpoint CrossForestME01. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MigrationUser.md b/exchange/exchange-ps/exchange/Remove-MigrationUser.md new file mode 100644 index 0000000000..61036e2269 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MigrationUser.md @@ -0,0 +1,169 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MigrationUser cmdlet to remove a migration user from a batch. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MigrationUser [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-Partition ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MigrationUser -Identity TonySmith +``` + +This example removes the migration user Tony Smith from a migration batch. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +Use this switch to work around user or data corruption issues. Specific checks and removal steps are skipped to forcibly remove the migration user. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-MobileDevice.md b/exchange/exchange-ps/exchange/Remove-MobileDevice.md new file mode 100644 index 0000000000..dc6843cec8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MobileDevice.md @@ -0,0 +1,142 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MobileDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MobileDevice [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MobileDevice -Identity JeffHay\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac +``` + +This example removes the mobile device partnership for the specified mobile device. + +### Example 2 +```powershell +Remove-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac -Confirm:$false +``` + +This example removes the mobile device partnership for the specified device and doesn't display the confirm prompt. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mobile device partnership that you want to remove. You can use the following values that uniquely identifies the mobile device: + +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) + +```yaml +Type: MobileDeviceIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/devices/Remove-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/devices/Remove-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md index 9f2df6364a..24f850cef1 100644 --- a/exchange/exchange-ps/exchange/devices/Remove-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-MobileDeviceMailboxPolicy @@ -13,38 +16,42 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MobileDeviceMailboxPolicy cmdlet to remove mobile device mailbox policies from Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MobileDeviceMailboxPolicy [-Identity] [-Confirm] [-DomainController ] - [-Force] [-WhatIf] [] +Remove-MobileDeviceMailboxPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-MobileDeviceMailboxPolicy -Identity SalesPolicy ``` This example removes the mobile device mailbox policy SalesPolicy. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-MobileDeviceMailboxPolicy -Identity Engineering -Confirm:$false ``` -This example removes the mobile device mailbox policy named Engineeringand hides the confirmation prompt. +This example removes the mobile device mailbox policy named Engineering and hides the confirmation prompt. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Remove-MobileDeviceMailboxPolicy -Identity Management -Force ``` @@ -56,9 +63,7 @@ This example removes the mobile device mailbox policy named Management and bypas 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 - - Distinguished name (DN) - - GUID ```yaml @@ -66,6 +71,7 @@ Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -76,8 +82,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -85,6 +90,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -102,6 +108,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,13 +117,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -132,6 +142,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -140,20 +151,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/62b4902a-2773-4c2e-9c11-870e24303825.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-MoveRequest.md b/exchange/exchange-ps/exchange/Remove-MoveRequest.md new file mode 100644 index 0000000000..ff8f5e3203 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MoveRequest.md @@ -0,0 +1,258 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-MoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Remove-MoveRequest [-Identity] + [-Force] + [-Confirm] + [-DomainController ] + [-ProxyToMailbox ] + [-WhatIf] + [] +``` + +### MigrationMoveRequestQueue +``` +Remove-MoveRequest -MailboxGuid -MoveRequestQueue + [-Confirm] + [-DomainController ] + [-ProxyToMailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +In coexistence environments with Exchange 2010 and newer versions of Exchange, don't run a newer version of Remove-MoveRequest to clear completed mailbox move requests between Exchange 2010 databases as documented in [Clear or Remove Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd351276(v=exchg.141)). Otherwise, you might delete the mailbox that you just moved. In coexistence environments, only use the Remove-MoveRequest cmdlet on Exchange 2010 servers to clear completed Exchange 2010 move requests. For mailbox moves from an Exchange 2010 database to an Exchange 2016 database, you can safely run Remove-MoveRequest on the Exchange 2016 server. + +In Exchange 2010, you need to use the Remove-MoveRequest cmdlet on completed move requests to clear the InTransit flag from the mailbox. This step isn't required for mailbox moves in newer versions of Exchange where the Remove-MoveRequest is only used to cancel existing move requests. + +The MoveRequestQueue and MailboxGuid parameters are for debugging purposes only. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MoveRequest -Identity 'Ayla@humongousinsurance.com' +``` + +This example removes the mailbox move request for Ayla Kol's mailbox. + +### Example 2 +```powershell +Remove-MoveRequest -MoveRequestQueue MBXDB01 -MailboxGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f +``` + +This example cancels a mailbox move for a mailbox by using the MailboxGuid parameter for a mailbox on MBXDB01. + +The MailboxGuid and MoveRequestQueue parameters are for debugging purposes only. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: + +- GUID +- Distinguished name (DN) +- Domain\\Account +- User principal name (UPN) +- Legacy Exchange DN +- SMTP address +- Alias + +You can't use this parameter with the MailboxGuid or MoveRequestQueue parameters. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MailboxGuid +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. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: Guid +Parameter Sets: MigrationMoveRequestQueue +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveRequestQueue +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: MigrationMoveRequestQueue +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyToMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md new file mode 100644 index 0000000000..20d726ee54 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OMEConfiguration + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-OMEConfiguration cmdlet to remove custom Microsoft Purview Message Encryption configurations. You can't use this cmdlet to remove the default OME configuration. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OMEConfiguration [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OMEConfiguration -Identity "Contoso Marketing" +``` + +This example removes the custom OME configuration named Contoso Marketing. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md new file mode 100644 index 0000000000..24791b7b37 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md @@ -0,0 +1,161 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OabVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-OabVirtualDirectory cmdlet to remove offline address book (OAB) virtual directories from Internet Information Services (IIS) on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OabVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OabVirtualDirectory -Identity "OAB (Default Web Site)" +``` + +This example removes the default OAB virtual directory from the local server. + +### Example 2 +```powershell +Remove-OabVirtualDirectory -Identity "Server1\OAB (Default Web Site)" +``` + +This example removes the default OAB virtual directory from Server1. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -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-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md new file mode 100644 index 0000000000..b9d780e4f5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md @@ -0,0 +1,156 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs). + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OfflineAddressBook [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OfflineAddressBook -Identity "\Contoso Executives" +``` + +This example removes the OAB named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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: 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 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md new file mode 100644 index 0000000000..a6196d357b --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md @@ -0,0 +1,116 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OnPremisesOrganization + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-OnPremisesOrganization cmdlet to remove an OnPremisesOrganization object in a Microsoft 365 tenant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OnPremisesOrganization [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Removing an OnPremisesOrganization object should only be used in circumstances where the hybrid deployment state is corrupt and under the direction and supervision of Microsoft Customer Service and Support. After removing the OnPremisesOrganization object, any related hybrid deployment configured with this object won't be functional and will need to be re-created and reconfigured. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OnPremisesOrganization -Identity ExchangeMail +``` + +This example removes the ExchangeMail OnPremisesOrganization object in a Microsoft 365 organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: + +- Canonical name +- GUID +- Name + +```yaml +Type: OnPremisesOrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md new file mode 100644 index 0000000000..0598e9d220 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-OrganizationRelationship cmdlet to remove the organization relationship with an external Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OrganizationRelationship [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-OrganizationRelationship cmdlet removes the organization relationship objects. To stop sharing information without removing the organization relationship objects, disable the organization relationship by using the Set-OrganizationRelationship cmdlet. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OrganizationRelationship -Identity Contoso +``` + +This example removes the organization relationship Contoso using the Identity parameter. + +## PARAMETERS + +### -Identity +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 +- GUID +- Name + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md b/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md new file mode 100644 index 0000000000..0d1f0c04fb --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OrganizationSegment + +## 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-OrganizationSegment cmdlet to remove organization segments from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OrganizationSegment [-Identity] + [-Confirm] + [-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-OrganizationSegment -Identity "Engineering Group" +``` + +This example removes the organization segment named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md b/exchange/exchange-ps/exchange/Remove-OutboundConnector.md new file mode 100644 index 0000000000..7cfabaff38 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OutboundConnector.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OutboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-OutboundConnector cmdlet to delete an Outbound connector from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OutboundConnector [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OutboundConnector "Contoso Outbound Connector" +``` + +This example deletes the Outbound connector named Contoso Outbound Connector. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md new file mode 100644 index 0000000000..2fd3e45e05 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md @@ -0,0 +1,140 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OutlookProtectionRule + +## 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. + +Use the Remove-OutlookProtectionRule cmdlet to remove Outlook protection rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OutlookProtectionRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OutlookProtectionRule -Identity "Project Contoso" +``` + +This example removes the Outlook protection rule named Project Contoso. + +### Example 2 +```powershell +Get-OutlookProtectionRule | Remove-OutlookProtectionRule +``` + +This example removes all Outlook protection rules from the organization. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access/Remove-OutlookProvider.md b/exchange/exchange-ps/exchange/Remove-OutlookProvider.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access/Remove-OutlookProvider.md rename to exchange/exchange-ps/exchange/Remove-OutlookProvider.md index adf5b06856..1d6410cdd9 100644 --- a/exchange/exchange-ps/exchange/client-access/Remove-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Remove-OutlookProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-OutlookProvider @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-OutlookProvider cmdlet to delete the AutoDiscoverConfig object from Active Directory. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OutlookProvider [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-OutlookProvider [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-OutlookProvider -Identity "Test Object" ``` @@ -46,6 +52,7 @@ Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ 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 @@ -80,6 +87,7 @@ 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 @@ -95,6 +103,7 @@ 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 @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b01d44c2-d9f9-4d58-9ce3-2db3e998ed25.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md new file mode 100644 index 0000000000..b9f7e4ee5e --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md @@ -0,0 +1,168 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-OwaMailboxPolicy cmdlet to remove Outlook on the web mailbox policies from the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OwaMailboxPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +Changes to Outlook on the web mailbox policies may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OwaMailboxPolicy -Identity Executives +``` + +This example removes the mailbox policy named Executives. + +### Example 2 +```powershell +Remove-OwaMailboxPolicy -Identity Fabrikam\Employees +``` + +This example removes the mailbox policy named Employees for the organization Fabrikam. + +### Example 3 +```powershell +Remove-OwaMailboxPolicy -Identity Litware\Contoso\Corporate +``` + +This example removes the mailbox policy named Corporate for the tenant Contoso in the organization Litware. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md new file mode 100644 index 0000000000..f97d5d7436 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md @@ -0,0 +1,140 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-OwaVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-OwaVirtualDirectory cmdlet to remove Outlook on the web virtual directories from Internet Information Services (IIS) on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-OwaVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You might be required to use the Remove-OwaVirtualDirectory cmdlet in the following situations: + +- The Get-OwaVirtualDirectory cmdlet detects an Outlook on the web virtual directory deleted in IIS but not deleted in Active Directory. These abandoned Outlook on the web virtual directory objects are known as Active Directory orphans. We recommend that you remove these orphans by using the Remove-OwaVirtualDirectory cmdlet. +- You are troubleshooting an Outlook on the web configuration issue that requires you to delete the existing Outlook on the web virtual directory and then re-create the Outlook on the web virtual directory. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-OwaVirtualDirectory -Identity "EXCH01\owa (Default Web site)" +``` + +This example removes the specified Outlook on the web virtual directory from the default IIS website on the Exchange server named EXCH01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -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-PartnerApplication.md b/exchange/exchange-ps/exchange/Remove-PartnerApplication.md new file mode 100644 index 0000000000..2eb9caf5e4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PartnerApplication.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-PartnerApplication cmdlet to remove a partner application configuration. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-PartnerApplication [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration if the application no longer needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PartnerApplication HRApp +``` + +This command removes the HRApp partner application. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md new file mode 100644 index 0000000000..590d704a0c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md @@ -0,0 +1,147 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-PhishSimOverridePolicy + +## 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). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-PhishSimOverridePolicy [-Identity] + [-Confirm] + [-DomainController ] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-PhishSimOverridePolicy | Remove-PhishSimOverridePolicy +``` + +This example removes the phishing simulation override policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-PhishSimOverridePolicy cmdlet to find the values. The only available policy is named PhishSimOverridePolicy. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +In Exchange Online PowerShell, the WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md new file mode 100644 index 0000000000..45d9e9b72c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md @@ -0,0 +1,141 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-PolicyTipConfig cmdlet to remove custom data loss prevention (DLP) Policy Tips from your organization. You can't remove built-in Policy Tips. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-PolicyTipConfig [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PolicyTipConfig en\NotifyOnly +``` + +This example removes the custom English Policy Tip for the action value NotifyOnly. + +### Example 2 +```powershell +Get-PolicyTipConfig -Locale ru | Remove-PolicyTipConfig +``` + +This example removes all the custom Russian Policy Tips. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: + +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- The value Url +- GUID +- Distinguished name (DN) + +```yaml +Type: PolicyTipConfigIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md new file mode 100644 index 0000000000..56801944fd --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md @@ -0,0 +1,137 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-PowerShellVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-PowerShellVirtualDirectory cmdlet to remove existing Windows PowerShell virtual directories from Internet Information Services (IIS) on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-PowerShellVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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-ProtectionAlert.md b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md new file mode 100644 index 0000000000..f4edc74c13 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ProtectionAlert + +## 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-ProtectionAlert cmdlet to remove alert policies from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ProtectionAlert [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ProtectionAlert -Identity "External User File Activities" +``` + +This example removes the specified alert policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolder.md b/exchange/exchange-ps/exchange/Remove-PublicFolder.md new file mode 100644 index 0000000000..036d6a15da --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PublicFolder.md @@ -0,0 +1,202 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-PublicFolder cmdlet to remove an existing public folder. + +The Remove-PublicFolder cmdlet removes the public folder data from all servers in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-PublicFolder [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-Recurse] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PublicFolder -Identity "\Test\Directory\My Public Folder" +``` + +This example deletes the public folder My Public Folder from the \\Test\\Directory tree. + +### Example 2 +```powershell +Remove-PublicFolder -Identity "\Test\Directory Folder" -Recurse +``` + +This example deletes the public folder Directory Folder and all its child public folders by using the Recurse switch. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Mailbox +This parameter is available only in the cloud-based service. + +{{ Fill Mailbox Description }} + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +The Recurse switch specifies whether all subfolders of the specified folder should also be removed. You don't need to specify a value with this switch. + +If you don't use this switch and the public folder has subfolders, the command doesn't run and an error message is returned. + +```yaml +Type: SwitchParameter +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 +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md similarity index 75% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md index b6fb3c345b..b1b0afb2e2 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-PublicFolderAdministrativePermission @@ -13,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-PublicFolderAdministrativePermission cmdlet to remove administrative permissions for a public folder or a public folder hierarchy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,32 +26,33 @@ Remove-PublicFolderAdministrativePermission [-Identity] ] - [-InheritanceType ] + [-InheritanceType ] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Instance ``` -Remove-PublicFolderAdministrativePermission -Instance +Remove-PublicFolderAdministrativePermission [[-Identity] ] -Instance [-AccessRights ] [-Confirm] [-Deny] [-DomainController ] - [[-Identity] ] - [-InheritanceType ] + [-InheritanceType ] [-Server ] [-User ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-PublicFolderAdministrativePermission -User Chris -Identity \MyPublicFolder -AccessRights ViewInformationStore ``` @@ -56,34 +60,46 @@ This example removes the ViewInformationStore permission from the user Chris on ## PARAMETERS +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -AccessRights The AccessRights parameter specifies the rights being removed. Valid values include: - None The administrator doesn't have any rights to modify public folder attributes. - - ModifyPublicFolderACL The administrator has the right to modify client access permissions for the specified folder. - - ModifyPublicFolderAdminACL The administrator has the right to modify administrator permissions for the specified public folder. - - ModifyPublicFolderDeletedItemRetention The administrator has the right to modify the Public Folder Deleted Item Retention attributes (RetainDeletedItemsFor or UseDatabaseRetentionDefaults). - - ModifyPublicFolderExpiry The administrator has the right to modify the Public Folder Expiration attributes (AgeLimitUseDatabaseAgeDefaults). - - ModifyPublicFolderQuotas The administrator has the right to modify the Public Folder Quota attributes (MaxItemSize, PostQuota, PostWarningQuota, or UseDatabaseQuotaDefaults). - - ModifyPublicFolderReplicaList The administrator has the right to modify the replica list attribute for the specified public folder (Replicas). - - AdministerInformationStore The administrator has the right to modify all other public folder properties not defined previously. - - ViewInformationStore The administrator has the right to view public folder properties. - - AllExtendedRights The administrator has the right to modify all public folder properties. +You can specify multiple values separated by commas. + ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -96,6 +112,7 @@ Type: MultiValuedProperty Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -103,28 +120,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ```yaml Type: PublicFolderIdParameter Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010 + Required: False Position: 1 Default value: None @@ -140,6 +141,7 @@ Type: PublicFolderAdministrativeAceObject Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -148,13 +150,31 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of the user for whom rights are being removed. +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 +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) ```yaml Type: SecurityPrincipalIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -167,6 +187,7 @@ Type: SecurityPrincipalIdParameter Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -177,8 +198,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -186,6 +206,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -194,13 +215,14 @@ Accept wildcard characters: False ``` ### -Deny -The Deny parameter specifies whether to deny the permission specified. +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 Default value: None @@ -216,6 +238,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -227,20 +250,17 @@ Accept wildcard characters: False The InheritanceType parameter specifies the type of inheritance. Valid values are: - None - -- All - -- Descendents - -- SelfAndChildren - +- All (this is the default value) - Children +- Descendents [sic] +- SelfAndChildren ```yaml -Type: None | All | Descendents | SelfAndChildren | Children +Type: ActiveDirectorySecurityInheritance Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -249,13 +269,21 @@ Accept wildcard characters: False ``` ### -Server -The Server parameter specifies the server on which to perform the selected operations. +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -271,6 +299,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -279,20 +308,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/04ebd367-7dd3-4e7b-8323-68d62c74fb07.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md new file mode 100644 index 0000000000..726354e79b --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md @@ -0,0 +1,230 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-PublicFolderClientPermission cmdlet to remove permissions from public folders. + +For 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-PublicFolderClientPermission [-Identity] -AccessRights -User + [-Confirm] + [-DomainController ] + [-Server ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PublicFolderClientPermission -Identity \"My Public Folder" -User Chris -AccessRights CreateItems -Server "My Server" +``` + +In Exchange Server 2010, this example removes permission for the user Chris to create items in the public folder My Public Folder on the server My Server. + +### Example 2 +```powershell +Remove-PublicFolderClientPermission -Identity "\My Public Folder" -User Contoso\Chris +``` + +This example removes permission for the user Chris to the public folder My Public Folder. + +## PARAMETERS + +### -Identity +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. + +```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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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. + +You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. + +The following individual permissions are available: + +- CreateItems: The user has the right to create items within the specified public folder. +- CreateSubfolders: The user has the right to create subfolders in the specified public folder. +- DeleteAllItems: The user has the right to delete all items in the specified public folder. +- DeleteOwnedItems: The user has the right to delete items that the user owns in the specified public folder. +- EditAllItems: The user has the right to edit all items in the specified public folder. +- EditOwnedItems: The user has the right to edit the items that the user owns in the specified public folder. +- FolderContact: The user is the contact for the specified public folder. +- FolderOwner: The user is the owner of the specified public folder. The user has the right to view and move the public folder and create subfolders. The user can't read items, edit items, delete items, or create items. +- FolderVisible: The user can view the specified public folder, but can't read or edit items within the specified public folder. +- ReadItems: The user has the right to read items within the specified public folder. + +In addition to the access rights, you can create rights based upon roles, which includes multiple access rights. This parameter accepts the following values for roles: + +- Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- Contributor: CreateItems, FolderVisible +- Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- None: FolderVisible +- NonEditingAuthor: CreateItems, DeleteOwnedItems, FolderVisible, ReadItems +- Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems +- PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- PublishingEditor: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- Reviewer: FolderVisible, ReadItems + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the user whose permissions are being removed. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +```yaml +Type: PublicFolderUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md new file mode 100644 index 0000000000..1da34f3a54 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md @@ -0,0 +1,150 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-PublicFolderDatabase + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Remove-PublicFolderDatabase cmdlet to delete public folder databases. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-PublicFolderDatabase [-Identity] + [-Confirm] + [-DomainController ] + [-RemoveLastAllowed] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +Removing a public folder database can have a broad range of serious consequences. (This is particularly true when removing the last public folder database in the organization.) For more information, see [Remove Public Folder Databases](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd876883(v=exchg.141)). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PublicFolderDatabase "Public Folder Database" +``` + +This example removes the database Public Folder Database after all the prerequisites for removing the database have been satisfied. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +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 Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveLastAllowed +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md new file mode 100644 index 0000000000..647e00554d --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md @@ -0,0 +1,212 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-PublicFolderMailboxMigrationRequest cmdlet to remove individual jobs from public folder migration batches that were created by using the New-MigrationBatch cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Remove-PublicFolderMailboxMigrationRequest [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +### MigrationRequestQueue +``` +Remove-PublicFolderMailboxMigrationRequest -RequestGuid -RequestQueue + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PublicFolderMailboxMigrationRequest -Identity \PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e +``` + +This example removes the specified public folder mailbox migration request. + +### Example 2 +```powershell +Get-PublicFolderMailboxMigrationRequest | ?{$_.TargetMailbox -eq $null} +``` + +This example returns public folder mailbox migration requests that don't have a target mailbox. To remove these orphaned migration requests, add ` | Remove-PublicFolderMailboxMigrationRequest` to the end of the command. + +### Example 3 +```powershell +Get-PublicFolderMailboxMigrationRequest | group TargetMailbox | ?{$_.Count -gt 1} +``` + +This example returns duplicate public folder migration requests (requests created for the same target mailbox). If the command returns no results, then there are no duplicate migration requests. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: PublicFolderMailboxMigrationRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RequestGuid +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. + +If you use this parameter, you also need to use the RequestQueue parameter. You can't use either of these parameters with the Identity parameter. + +```yaml +Type: Guid +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestQueue +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md new file mode 100644 index 0000000000..c85f9d9a62 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md @@ -0,0 +1,216 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-PublicFolderMigrationRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-PublicFolderMigrationRequest cmdlet to cancel or complete serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). You need to use this cmdlet to remove an existing serial public folder migration request before you can create another one. + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Remove-PublicFolderMigrationRequest [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +### MigrationRequestQueue +``` +Remove-PublicFolderMigrationRequest -RequestGuid -RequestQueue + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The RequestQueue and RequestGuid 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-PublicFolderMigrationRequest | Remove-PublicFolderMigrationRequest +``` + +This example cancels any public folder migration request that's actively running. + +### Example 2 +```powershell +Remove-PublicFolderMigrationRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f +``` + +This example cancels a migration request by using the RequestGuid parameter for a mailbox on MBXDB01. + +The RequestGuid and RequestQueue parameters are for debugging purposes only. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the migration request that you want to remove. You can use the following values: + +- Name +- RequestGUID + +You can't use this parameter with the RequestGuid or RequestQueue parameters. + +```yaml +Type: PublicFolderMigrationRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RequestGuid +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. + +```yaml +Type: Guid +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestQueue +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 +- Distinguished name (DN) +- GUID + +You need to use this parameter with the RequestGuid parameter. + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md new file mode 100644 index 0000000000..b32e757add --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md @@ -0,0 +1,211 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Remove-PublicFolderMoveRequest [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +### MigrationRequestQueue +``` +Remove-PublicFolderMoveRequest -RequestGuid -RequestQueue + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The RequestQueue and RequestGuid 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-PublicFolderMoveRequest -Identity \PublicFolderMove +``` + +This example removes the public folder move request \\PublicFolderMove. + +### Example 2 +```powershell +Remove-PublicFolderMoveRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f +``` + +This example cancels a public folder move by using the RequestGuid parameter for a public folder move request on MBXDB01. + +The RequestGuid and RequestQueue parameters are for debugging purposes only. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: PublicFolderMoveRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RequestGuid +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. + +```yaml +Type: Guid +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestQueue +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 +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md new file mode 100644 index 0000000000..6c828f12bb --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-QuarantinePolicy cmdlet to remove quarantine policies from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-QuarantinePolicy [-Identity] + [-DomainController ] + [] +``` + +## DESCRIPTION +You can't remove the built-in quarantine policies named AdminOnlyAccessPolicy or DefaultFullAccessPolicy. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-QuarantinePolicy -Identity "Contoso Engineering" +``` + +This example removes the quarantine policy named Contoso Engineering. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the quarantine policy you want to remove. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: QuarantineTagIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-ReceiveConnector.md b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Remove-ReceiveConnector.md rename to exchange/exchange-ps/exchange/Remove-ReceiveConnector.md index cf5bb305ca..16d1194f04 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ReceiveConnector @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ReceiveConnector cmdlet to remove Receive connectors from Mailbox servers and Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ReceiveConnector [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-ReceiveConnector [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ReceiveConnector -Identity "Contoso.com Receive Connector" ``` @@ -42,18 +48,16 @@ This example removes the Receive connector named Contoso.com Receive Connector. 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 - - Distinguished name (DN) - - GUID - -- \\\\ +- ServerName\\Name ```yaml Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -64,8 +68,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +76,7 @@ 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 @@ -90,6 +94,7 @@ 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 @@ -105,6 +110,7 @@ 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 @@ -113,20 +119,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0b1629a0-9ee1-4c4b-bc4d-37a4d3547f70.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md new file mode 100644 index 0000000000..2b1a383994 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md @@ -0,0 +1,263 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-RecipientPermission + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-RecipientPermission cmdlet to remove SendAs permission from users in a cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RecipientPermission [-Identity] -AccessRights -Trustee + [-Confirm] + [-Deny] + [-MultiTrustees ] + [-SkipDomainValidationForMailContact] + [-SkipDomainValidationForMailUser] + [-SkipDomainValidationForSharedMailbox] + [-WhatIf] + [] +``` + +## DESCRIPTION +When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RecipientPermission "Help Desk" -AccessRights SendAs -Trustee "Ayla Kol" +``` + +This example removes the SendAs permission from the user Ayla Kol for the mailbox Help Desk. Ayla can't send messages that appear to come directly from the Help Desk mailbox. + +## PARAMETERS + +### -Identity +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: + +- Mailboxes +- Mail users +- External contacts +- Distribution groups +- Dynamic distribution groups + +You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Trustee +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 +- Mail users with a Microsoft account +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Deny +{{ Fill Deny Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MultiTrustees +{{ Fill MultiTrustees Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDomainValidationForMailContact +The SkipDomainValidationForMailContact switch skips the check that confirms the proxy addresses of the external contact specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SkipDomainValidationForMailUser +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SkipDomainValidationForSharedMailbox +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-RemoteDomain.md b/exchange/exchange-ps/exchange/Remove-RemoteDomain.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Remove-RemoteDomain.md rename to exchange/exchange-ps/exchange/Remove-RemoteDomain.md index fa859eb439..bc7601b802 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Remove-RemoteDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-RemoteDomain @@ -13,22 +16,25 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RemoteDomain cmdlet to remove a remote domain. When you remove a remote domain, the remote domain object is deleted. Removing a remote domain doesn't disable mail flow to that domain. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RemoteDomain [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-RemoteDomain [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-RemoteDomain Contoso ``` @@ -40,9 +46,7 @@ This example removes the remote domain object named Contoso. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -50,6 +54,7 @@ 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 Default value: None @@ -60,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +73,7 @@ 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 Default value: None @@ -88,6 +93,7 @@ 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 @@ -103,6 +109,7 @@ 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 Default value: None @@ -111,20 +118,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7c17847a-310e-45df-8c0c-58b4297e6f8d.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md new file mode 100644 index 0000000000..1795e792f9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md @@ -0,0 +1,181 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-RemoteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-RemoteMailbox cmdlet to remove a mail-enabled user in the on-premises Active Directory and the associated mailbox in the cloud-based service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RemoteMailbox [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-IgnoreLegalHold] + [-WhatIf] + [] +``` + +## DESCRIPTION +With the Remove-RemoteMailbox cmdlet, you can remove an on-premises mail-enabled user and the mailbox from the service. If you only want to remove the mailbox from the service and keep the associated on-premises user, use the Disable-RemoteMailbox cmdlet. + +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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Legacy DN +- GUID +- Domain\\Account name +- User principal name (UPN) +- Email address +- Alias + +```yaml +Type: RemoteMailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IgnoreLegalHold +The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. + +This switch removes the instance of the remote object in the on-premises organization, and the request to remove the mailbox is synchronized to the cloud. The Microsoft Entra object is removed, but if the mailbox is on hold, the mailbox is converted into an inactive mailbox and remains on hold. + +```yaml +Type: SwitchParameter +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 +``` + +### -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-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..bdcd81de21 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionpolicy +applicable: Exchange Online +title: Remove-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ReportSubmissionPolicy cmdlet to remove the report submission policy from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ReportSubmissionPolicy [-Identity] [] +``` + +## DESCRIPTION +There's only one report submission policy in an organization, and it's named DefaultReportSubmissionPolicy. You can remove the policy and then use the New-ReportSubmissionPolicy cmdlet to recreate it with the default settings. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy +``` + +This example removes the report submission policy from your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission policy that you want to remove. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md new file mode 100644 index 0000000000..7c7b4a7d97 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionrule +applicable: Exchange Online +title: Remove-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ReportSubmissionRule cmdlet to remove the report submission rule from your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ReportSubmissionRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To disable the report submission rule without deleting it, use the Disable-ReportSubmissionRule cmdlet. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ReportSubmissionRule -Identity DefaultReportSubmissionRule +``` + +This example removes the report submission rule from your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to remove. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-ResubmitRequest.md b/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md similarity index 75% rename from exchange/exchange-ps/exchange/mail-flow/Remove-ResubmitRequest.md rename to exchange/exchange-ps/exchange/Remove-ResubmitRequest.md index fea2f94593..6b01e58449 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ResubmitRequest @@ -13,29 +16,32 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ResubmitRequest cmdlet to remove requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ResubmitRequest [-Identity] [-Confirm] [-Server ] - [-WhatIf] [] +Remove-ResubmitRequest [-Identity] + [-Confirm] + [-Server ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ResubmitRequest 5 ``` This example removes the resubmit request with the identity 5. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ResubmitRequest | Remove-ResubmitRequest ``` @@ -51,6 +57,7 @@ Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -61,8 +68,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -70,6 +76,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -81,11 +88,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -95,6 +99,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,6 +115,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,20 +124,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/9b3f460b-3853-4fa2-8d1f-4f60bb82a908.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md new file mode 100644 index 0000000000..586520eb81 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md @@ -0,0 +1,142 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-RetentionCompliancePolicy + +## 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-RetentionCompliancePolicy cmdlet to remove retention policies from the Microsoft Purview compliance portal. This cmdlet also removes the corresponding retention rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RetentionCompliancePolicy [-Identity] + [-Confirm] + [-ForceDeletion] + [-PriorityCleanup] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" +``` + +This example removes the retention policy named "Regulation 123 Compliance". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md new file mode 100644 index 0000000000..fd33677240 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md @@ -0,0 +1,144 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-RetentionComplianceRule + +## 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-RetentionComplianceRule cmdlet to remove retention rules from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RetentionComplianceRule [-Identity] + [-Confirm] + [-ForceDeletion] + [-PriorityCleanup] + [-WhatIf] + [] +``` + +## DESCRIPTION +Removing a retention rule causes the release of all Exchange mailbox and SharePoint site retentions that are associated with the rule. Removing a retention rule also causes the corresponding retention policy to become invalid, so you should remove it by using the Remove-RetentionCompliancePolicy cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RetentionComplianceRule -Identity "One Year Standard" +``` + +This example removes the retention rule named "One Year Standard". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the retention rule to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md new file mode 100644 index 0000000000..3606e9995c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md @@ -0,0 +1,166 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-RetentionPolicy cmdlet to remove a retention policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RetentionPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RetentionPolicy -Identity "Business Critical" +``` + +This example removes the retention policy Business Critical. + +### Example 2 +```powershell +Remove-RetentionPolicy -Identity "Business Critical" -Confirm:$false +``` + +This example removes the retention policy Business Critical and suppresses the confirmation prompt. + +### Example 3 +```powershell +Remove-RetentionPolicy -Identity "Business Critical" -Confirm:$false -Force +``` + +This example removes the retention policy Business Critical, which is assigned to users and suppresses the confirmation prompt. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you remove a retention policy that's assigned to users. Removing a policy that's assigned to users results in those users not having any retention policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/policy-and-compliance-retention/Remove-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionPolicyTag.md rename to exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md index f8d9b1a85f..03f3e9a59f 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-RetentionPolicyTag @@ -13,13 +16,16 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RetentionPolicyTag cmdlet to remove a retention tag. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RetentionPolicyTag [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Remove-RetentionPolicyTag [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,14 +33,14 @@ Retention tags are added to a retention policy, which is applied to a mailbox. When you use the Remove-RetentionPolicyTag cmdlet to remove a retention tag, it removes the tag definition stored in Active Directory. The next time the Managed Folder Assistant runs, it processes all items that have the removed tag applied and restamps them. Depending on the number of mailboxes and messages, this process may result in significant resource consumption on all Mailbox servers that contain mailboxes with a retention policy that includes the removed tag. -For more information about retention tags, see Retention tags and retention policies (https://technet.microsoft.com/library/dd297955.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-RetentionPolicyTag -Identity "Finance-DeletedItems" ``` @@ -50,6 +56,7 @@ 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 Default value: None @@ -60,8 +67,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +75,7 @@ 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 Default value: None @@ -86,6 +93,7 @@ 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 @@ -101,6 +109,7 @@ 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 Default value: None @@ -109,20 +118,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0db7cb8a-83aa-4843-b7fb-d562b837294a.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md new file mode 100644 index 0000000000..30fc9c2297 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md @@ -0,0 +1,155 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-RoleAssignmentPolicy cmdlet to remove existing management role assignment policies from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RoleAssignmentPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The assignment policy you want to remove can't be assigned to any mailboxes or management roles. Also, if you want to remove the default assignment policy, it must be the last assignment policy. Do the following before you attempt to remove an assignment policy: + +- Use the Set-Mailbox cmdlet to change the assignment policy for any mailbox assigned the assignment policy you want to remove. +- If the assignment policy is the default assignment policy, use the Set-RoleAssignmentPolicy cmdlet to select a new default assignment policy. You don't need to do this if you're removing the last assignment policy. +- Use the Remove-ManagementRoleAssignment cmdlet to remove any management role assignments assigned to the policy. + +For more information about assignment policies, see [Understanding management role assignment policies](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} + +Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} | Set-Mailbox -RoleAssignmentPolicy "Seattle End User" + +Get-ManagementRoleAssignment -RoleAssignee "End User" | Remove-ManagementRoleAssignment + +Remove-RoleAssignmentPolicy "End User" +``` + +This example removes the role assignment policy named End User. + +Find all mailboxes that have the End User policy assigned to them. + +Assign a different role assignment policy to the mailboxes. The example uses the policy named Seattle End User. + +Remove all management role assignments that are assigned to the End User policy. + +Remove the End User role assignment policy. + +For more information about the Where cmdlet and pipelining, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help) and [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-RoleGroup.md b/exchange/exchange-ps/exchange/Remove-RoleGroup.md new file mode 100644 index 0000000000..ed3cddf995 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RoleGroup.md @@ -0,0 +1,189 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-RoleGroup cmdlet to remove a management role group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RoleGroup [-Identity] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you remove a role group, all the management role assignments assigned management roles to the role group are also removed. The management roles aren't removed. Members of a removed role group can no longer manage a feature if the role group was the only means by which they were granted access to the feature. + +You can't remove built-in role groups. + +If the ManagedBy property has been populated with role group managers, the user removing the role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. + +For more information about role groups, see [Understanding management role groups](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RoleGroup "Training Administrators" +``` + +This example removes the Training Administrators role group. + +### Example 2 +```powershell +Remove-RoleGroup "Vancouver Recipient Administrators" -BypassSecurityGroupManagerCheck +``` + +This example removes the Vancouver Recipient Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-RoleGroupMember.md b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md new file mode 100644 index 0000000000..34807f1679 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md @@ -0,0 +1,216 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-RoleGroupMember cmdlet to remove a member of a management role group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RoleGroupMember [-Identity] -Member + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you remove a member from a role group, that member can no longer manage the features made available by the role group if the role group is the only means by which the member is granted access to the feature. + +If the ManagedBy property has been populated with role group managers, the user removing a role group member 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 Remove-RoleGroupMember cmdlet to remove members from the role group. Instead, you need to remove members from the foreign universal security group (USG) linked to the linked role group. To find the foreign USG linked to a role group, use the Get-RoleGroup cmdlet. + +For more information about role groups, see [Understanding management role groups](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RoleGroupMember "Recipient Management" -Member David +``` + +This example removes the user David from the role group Recipient Management. + +### Example 2 +```powershell +Get-User -Filter "Department -eq 'Sales' -and -RecipientType -eq 'UserMailbox'" | Get-Mailbox | Remove-RoleGroupMember "Sales and Marketing Group" -WhatIf +``` + +This example finds all the mailboxes that are part of the Sales department and removes them from the Sales and Marketing Group role group. Because we're using the WhatIf switch, the changes aren't written to the role group, so you can verify that the correct members will be removed. + +After you've verified that the correct members will be removed the role group, remove the WhatIf switch and run the command again. + +For more information about pipelining, and the WhatIf parameter, see the following topics: + +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [WhatIf, Confirm and ValidateOnly switches](https://learn.microsoft.com/exchange/whatif-confirm-and-validateonly-switches-exchange-2013-help) + +### Example 3 +```powershell +Remove-RoleGroupMember "Training Administrators" -Member "Training Assistants" -BypassSecurityGroupManagerCheck +``` + +This example removes the Training Assistants USG from the Training Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Member +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 +- Mail users +- Mail-enabled security groups +- Security groups (on-premises Exchange only) + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +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 +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Remove-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Remove-RoutingGroupConnector.md rename to exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md index 8ed80d40dd..e34b39e341 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-RoutingGroupConnector @@ -13,13 +16,16 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-RoutingGroupConnector cmdlet to remove a routing group connector between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RoutingGroupConnector [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-RoutingGroupConnector [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,12 +33,12 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-RoutingGroupConnector -Identity "Exchange Administrative Group (FYDIBOHF23SPDLT)\Exchange Routing Group (DWBGZMFD01QNBJR)\Ex2010 to Ex2003 RGC" -DomainController dc1.contoso.com ``` @@ -48,6 +54,7 @@ Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -58,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -67,6 +73,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -82,6 +89,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -97,6 +105,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -105,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/69d57b11-4c73-46f2-ace0-d47ff06beb9f.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md b/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md new file mode 100644 index 0000000000..869e6560c5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md @@ -0,0 +1,134 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-RPCClientAccess + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Remove-RpcClientAccess cmdlet to remove the configuration information that allows RPC access through the Client Access server role on Microsoft Exchange Server 2010. After you remove the configuration information, the Exchange RPC Client Access service stops and no longer starts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-RPCClientAccess -Server + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Disabling RPC client access on a server blocks all RPC access through the specified Client Access server. Therefore, RPC clients (for example, clients running Microsoft Office Outlook 2007) with mailboxes on any mailbox databases configured to use the specified Client Access server won't be able to connect. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-RpcClientAccess -Server CAS01 +``` + +This example removes the configuration information for the Exchange RPC Client Access service for the Client Access server CAS01. Performing this action also shuts down the Exchange RPC Client Access service on the Client Access server CAS01. + +## PARAMETERS + +### -Server +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md new file mode 100644 index 0000000000..857607a82b --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SafeAttachmentPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-SafeAttachmentPolicy cmdlet to remove safe attachment policies from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SafeAttachmentPolicy [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SafeAttachmentPolicy -Identity "Block Attachments Policy" +``` + +This example removes the safe attachment policy named Block Attachments Policy. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md new file mode 100644 index 0000000000..e442e79efb --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SafeAttachmentRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-SafeAttachmentRule cmdlet to remove safe attachment rules from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SafeAttachmentRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SafeAttachmentRule -Identity "Research Department Attachment Rule" +``` + +This examples removes the safe attachment rule named Research Department Attachment Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md new file mode 100644 index 0000000000..287856fcc5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md @@ -0,0 +1,133 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SafeLinksPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-SafeLinksPolicy cmdlet to remove Safe Links policies from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SafeLinksPolicy [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can't remove the default Safe Links policy (the policy where the IsDefault property is True). + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SafeLinksPolicy -Identity "Engineering Department URL Policy" +``` + +This example remove the Safe Links policy named Engineering Department URL Policy. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md new file mode 100644 index 0000000000..472e9e9324 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SafeLinksRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-SafeLinksRule cmdlet to remove Safe Links rules from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SafeLinksRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SafeLinksRule -Identity "Research Department URL Rule" +``` + +This examples removes the Safe Links rule named Research Department URL Rule. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md similarity index 76% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md rename to exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md index 9cb8127889..b15bec5d2b 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-SearchDocumentFormat @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SearchDocumentFormat cmdlet to remove a format-specific filter from those used by Exchange search. Only filters added with New-SearchDocumentFormat can be removed. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SearchDocumentFormat [-Identity] [-Confirm] [-Server ] - [-WhatIf] [] +Remove-SearchDocumentFormat [-Identity] + [-Confirm] + [-Server ] + [-WhatIf] + [] ``` ## DESCRIPTION After running the Remove-SearchDocumentFormat cmdlet, your must run the following cmdlet to restart the search service. There will be a brief search outage. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-SearchDocumentFormat -Identity sct ``` @@ -46,6 +52,7 @@ Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -56,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +71,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -76,11 +83,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -90,6 +94,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -105,6 +110,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -113,20 +119,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a476ea8b-ff7d-4209-b39d-4e3d2705d4db.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md new file mode 100644 index 0000000000..116c6c915a --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md @@ -0,0 +1,143 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SecOpsOverridePolicy + +## 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). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SecOpsOverridePolicy [-Identity] + [-Confirm] + [-DomainController ] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SecOpsOverridePolicy -Identity SecOpsOverridePolicy +``` + +This example removes the SecOps mailbox override policy. + +## PARAMETERS + +### -Identity +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 +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the SecOps override policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-SendConnector.md b/exchange/exchange-ps/exchange/Remove-SendConnector.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Remove-SendConnector.md rename to exchange/exchange-ps/exchange/Remove-SendConnector.md index d22c45fc2c..e1ce45ac63 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-SendConnector.md +++ b/exchange/exchange-ps/exchange/Remove-SendConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-SendConnector @@ -13,12 +16,15 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SendConnector cmdlet to delete a Send connector. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SendConnector [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-SendConnector [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` @@ -27,12 +33,12 @@ The Remove-SendConnector cmdlet deletes the object and the configuration setting Although a Send connector is configured locally in the Transport service on a Mailbox server or on an Edge server, deleting a Send connector may affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-SendConnector "Contoso.com Send Connector" ``` @@ -48,6 +54,7 @@ Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -58,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -67,6 +73,7 @@ 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 @@ -84,6 +91,7 @@ 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 @@ -99,6 +107,7 @@ 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 @@ -107,20 +116,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/cf131dc1-6067-4952-a6c3-7d6651a326da.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md similarity index 75% rename from exchange/exchange-ps/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md rename to exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md index 2fb0d50813..dff6213508 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-ServerMonitoringOverride @@ -13,29 +16,31 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ServerMonitoringOverride cmdlet to remove a managed availability local server override that has been configured for a probe, monitor or responder. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ServerMonitoringOverride [-Identity] -ItemType - -PropertyName -Server [-Confirm] [-WhatIf] [] +Remove-ServerMonitoringOverride [-Identity] -ItemType -PropertyName -Server + [-Confirm] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-ServerMonitoringOverride -Server EX1 -Identity Exchange\ActiveDirectoryConnectivityConfigDCServerReboot -ItemType Responder -PropertyName Enabled ``` This example removes a server monitoring override of the ActiveDirectoryConnectivityConfigDCServerReboot responder in the Exchange health set from server EX1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-ServerMonitoringOverride -Server EX2 -Identity FrontEndTransport\OnPremisesInboundProxy -ItemType Probe -PropertyName ExtensionAttributes ``` @@ -51,6 +56,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -62,16 +68,15 @@ Accept wildcard characters: False The ItemType parameter specifies the item type of the override that you want to remove. It can be any of the following values: - Probe - - Monitor - - Responder ```yaml -Type: Probe | Monitor | Responder | Maintenance +Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -87,6 +92,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -95,13 +101,19 @@ Accept wildcard characters: False ``` ### -Server -The Server parameter is used to specify the server from which the override is being removed. +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -112,8 +124,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -121,6 +132,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -136,6 +148,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,20 +157,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/dff63523-52a1-43c9-8ae2-beb93411b7e5.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md new file mode 100644 index 0000000000..855f9df7b6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ServicePrincipal + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ServicePrincipal cmdlet to remove service principals from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ServicePrincipal [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ServicePrincipal -Identity 7c7599b2-23af-45e3-99ff-0025d148e929 +``` + +This example removes the specified service principal. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to remove. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ObjectId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Remove-SettingOverride.md b/exchange/exchange-ps/exchange/Remove-SettingOverride.md similarity index 75% rename from exchange/exchange-ps/exchange/organization/Remove-SettingOverride.md rename to exchange/exchange-ps/exchange/Remove-SettingOverride.md index e69913aa2f..c3488fbb4e 100644 --- a/exchange/exchange-ps/exchange/organization/Remove-SettingOverride.md +++ b/exchange/exchange-ps/exchange/Remove-SettingOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-SettingOverride @@ -15,24 +18,27 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SettingOverride cmdlet to remove setting overrides from Active Directory. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SettingOverride [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-SettingOverride [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-sepcific, 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. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-SettingOverride -Identity "IM Server Integration" ``` @@ -44,9 +50,7 @@ This example removes the setting override named IM Server Integration. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -54,6 +58,7 @@ Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -64,8 +69,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +77,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -88,6 +93,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -103,6 +109,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -111,20 +118,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/56877b0e-f972-4c00-9822-57867811dbf4.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SharingPolicy.md b/exchange/exchange-ps/exchange/Remove-SharingPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SharingPolicy.md rename to exchange/exchange-ps/exchange/Remove-SharingPolicy.md index 11cdbee406..ac9dbb8159 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SharingPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-SharingPolicy @@ -13,29 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-SharingPolicy cmdlet to remove a sharing policy. Before you can remove a sharing policy, you must ensure that no mailbox users are provisioned to use that policy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SharingPolicy [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-SharingPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-SharingPolicy Fabrikam ``` This example removes the sharing policy Fabrikam. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-SharingPolicy -Identity Contoso -Confirm:$false ``` @@ -47,11 +53,8 @@ This example removes the sharing policy Contoso and suppresses the confirmation The Identity parameter specifies the identity of the sharing policy that you want to remove. You can use one of the following values: - ADObjectID - - Distinguished name (DN) - - Legacy DN - - GUID ```yaml @@ -59,6 +62,7 @@ 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 Default value: None @@ -69,8 +73,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -78,6 +81,7 @@ 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 Default value: None @@ -95,6 +99,7 @@ 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 @@ -110,6 +115,7 @@ 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 Default value: None @@ -118,20 +124,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b59d9faa-3418-4f4f-9f90-35cf12fde86e.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md new file mode 100644 index 0000000000..3b226be32b --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SiteMailboxProvisioningPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-SiteMailboxProvisioningPolicy cmdlet to remove site mailbox provisioning policies. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SiteMailboxProvisioningPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SiteMailboxProvisioningPolicy -Identity Default +``` + +This example deletes the site mailbox policy named Default that was created when you installed Microsoft Exchange. This example assumes that you have already designated another policy as the default. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/mailbox-databases-and-servers/Remove-StoreMailbox.md b/exchange/exchange-ps/exchange/Remove-StoreMailbox.md similarity index 76% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-StoreMailbox.md rename to exchange/exchange-ps/exchange/Remove-StoreMailbox.md index 56d152b429..4faccccab2 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-StoreMailbox.md +++ b/exchange/exchange-ps/exchange/Remove-StoreMailbox.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-StoreMailbox @@ -13,14 +16,15 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-StoreMailbox cmdlet to purge the mailbox and all of its message content from the mailbox database. This results in permanent data loss for the mailbox being purged. You can only run this cmdlet against disconnected or soft-deleted mailboxes. Running this command against an active mailbox fails, and you receive an error. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-StoreMailbox -Database -Identity -MailboxState +Remove-StoreMailbox -Database -Identity -MailboxState [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -32,26 +36,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-StoreMailbox -Database MBD01 -Identity Ayla -MailboxState SoftDeleted ``` This example purges the soft-deleted mailbox for Ayla Kol from mailbox database MBD01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Remove-StoreMailbox -Database MBD01 -Identity "2ab32ce3-fae1-4402-9489-c67e3ae173d3" -MailboxState Disabled ``` This example permanently purges the disconnected mailbox with the GUID 2ab32ce3-fae1-4402-9489-c67e3ae173d3 from mailbox database MBD01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Get-MailboxStatistics -Database MBD01 | where {$_.DisconnectReason -match "SoftDeleted"} | foreach {Remove-StoreMailbox -Database $_.Database -Identity $_.MailboxGuid -MailboxState SoftDeleted} ``` @@ -60,10 +64,10 @@ This example permanently purges all soft-deleted mailboxes from mailbox database ## PARAMETERS ### -Database -The Database parameter specifies the identity of the mailbox database on which the mailbox that you want to remove resides. This parameter accepts the following values: - -- Database name +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 +- Distinguished name (DN) - GUID ```yaml @@ -71,6 +75,7 @@ Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -79,25 +84,16 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the identity of the mailbox that you want to remove. This parameter accepts the following values: - -- GUID - -- Distinguished name (DN) +The Identity parameter specifies the identity of the mailbox that you want to remove. Use the mailbox GUID as the value for this parameter. -- User principal name (UPN) - -- LegacyExchangeDN - -- Domain\\Account Name - -- SMTP address +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. ```yaml Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -109,14 +105,14 @@ Accept wildcard characters: False The MailboxState parameter specifies the mailbox state on the source mailbox database. This parameter accepts the following values: - Disabled - - SoftDeleted ```yaml -Type: Disabled | SoftDeleted +Type: MailboxStateParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -127,8 +123,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -136,6 +131,7 @@ 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 @@ -151,6 +147,7 @@ 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 @@ -159,20 +156,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d5cb00f2-f475-45cf-b72e-0962e5eed070.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md new file mode 100644 index 0000000000..1bbb2eaf31 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SupervisoryReviewPolicyV2 + +## 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-SupervisoryReviewPolicyV2 cmdlet to remove supervisory review policies from the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SupervisoryReviewPolicyV2 [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SupervisoryReviewPolicyV2 -Identity "EU Brokers Policy" +``` + +This example removes the supervisory review policy named EU Brokers Policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SweepRule.md b/exchange/exchange-ps/exchange/Remove-SweepRule.md new file mode 100644 index 0000000000..5a20fe05fc --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SweepRule.md @@ -0,0 +1,162 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Remove-SweepRule cmdlet to remove Sweep rules from mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SweepRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" +``` + +This example removes the specified Sweep rule. + +### Example 2 +```powershell +Get-SweepRule -Mailbox laura@contoso.com | Remove-SweepRule +``` + +This example removes all Sweep rules in the specified mailbox. + +## PARAMETERS + +### -Identity +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==). +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). + +```yaml +Type: SweepRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: 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 Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md new file mode 100644 index 0000000000..b48470c51b --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md @@ -0,0 +1,130 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +The Remove-SyncMailPublicFolder cmdlet is used by the Sync-MailPublicFolders.ps1 script to remove mail-enabled public folder recipient objects from Exchange Online (the script synchronizes mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SyncMailPublicFolder [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SyncMailPublicFolder +``` + +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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mail-enabled public folder object that you want to remove from Exchange Online. For example: + +- Name +- Distinguished name (DN) +- GUID +- Path (`\\`) + +```yaml +Type: MailPublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-SystemMessage.md b/exchange/exchange-ps/exchange/Remove-SystemMessage.md new file mode 100644 index 0000000000..c61753f2b5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-SystemMessage.md @@ -0,0 +1,187 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-SystemMessage + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-SystemMessage cmdlet to remove custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-SystemMessage [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-SystemMessage En\Internal\5.7.9 +``` + +This example removes the specified custom NDR (combination of language, audience, and enhanced status code values). + +### Example 2 +```powershell +Remove-SystemMessage En\WarningMailbox +``` + +This example removes the specified custom quota message (combination of language and quota values). + +## PARAMETERS + +### -Identity +The Identity parameter specifies the custom system message that you want to remove. You can use any value that uniquely identifies the system message. For example: + +- Identity +- Distinguished name (DN) +- GUID + +The identity value of a system message uses one of these formats: + +- System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailbox`. + +\: 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). + +\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command `Get-SystemMessage`. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. + +\: Valid value are: + +Mailbox size quotas: + +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. +- ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. +- WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. +- WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. + +Public folder size quotas: + +- ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. +- WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. +- WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. + +Maximum number of messages in a mailbox folder: + +- ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. +- WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. +- WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. + +Maximum number of subfolders in a mailbox folder: + +- ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. +- WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. +- WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. +- ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. +- WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. +- WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. + +Maximum number of levels (depth) in a mailbox folder: + +- ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. +- WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. +- WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. + +```yaml +Type: SystemMessageIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md new file mode 100644 index 0000000000..131df513a6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -0,0 +1,174 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-TenantAllowBlockListItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-TenantAllowBlockListItems cmdlet to remove entries from the Tenant Allow/Block List in the Microsoft Defender portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Entries +``` +Remove-TenantAllowBlockListItems -Entries -ListType + [-ListSubType ] + [-OutputJson] + [] +``` + +### Ids +``` +Remove-TenantAllowBlockListItems -Ids -ListType + [-ListSubType ] + [-OutputJson] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0l" +``` + +This example removes the specified URL entry from the Tenant Allow/Block List. + +### Example 2 +```powershell +Remove-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery -Entries *.fabrikam.com +``` + +This example removes the URL allow entry for the specified third-party phishing simulation URL. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +## PARAMETERS + +### -Entries +The Entries parameter specifies the entries that you want to remove based on the ListType parameter value. Valid values are: + +- FileHash: The exact SHA256 file hash value. +- Sender domains and email addresses: The exact domain or email address value. +- Url: The exact URL value. +- IP: IPv6 addresses only. Single IPv6 addresses in colon-hexadecimal or zero-compression format or CIDR IPv6 ranges from 1 to 128. + +This value is shown in the Value property of the entry in the output of the Get-TenantAllowBlockListItems cmdlet. + +You can't mix value types (sender, URL, file, or IP address) or allow and block actions in the same command. + +You can't use this parameter with the Ids parameter. + +```yaml +Type: String[] +Parameter Sets: Entries +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ids +The Ids parameter specifies the entries that you want to remove. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. + +An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. + +You can't use this parameter with the Entries parameter. + +```yaml +Type: String[] +Parameter Sets: Ids +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListType +The ListType parameter specifies the type of entry that you want to remove. Valid values are: + +- FileHash +- Sender +- Url +- IP + +```yaml +Type: ListType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType specifies further specifies the type of entry that you want to remove. Valid values are: + +- AdvancedDelivery: Use this value for phishing simulation URLs. +- Tenant: This is the default value. + +```yaml +Type: ListSubType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputJson +The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. + +You use this switch to prevent the command from halting on the first entry that contains a syntax error. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md new file mode 100644 index 0000000000..dffc5da8d0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md @@ -0,0 +1,122 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-TenantAllowBlockListSpoofItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-TenantAllowBlockListSpoofItems cmdlet to remove spoofed sender entries from the Tenant Allow/Block List. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-TenantAllowBlockListSpoofItems [-Identity] -Ids + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet removes spoof pairs (the combination of the spoofed user and the sending infrastructure) from the Tenant Allow/Block 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-TenantAllowBlockListSpoofItems -Identity domain.com\Default -Ids 375e76f1-eefb-1626-c8bc-5efefd057488,f8cb0908-8533-1156-ce7b-9aebd685b0eb +``` + +This example removes the specified spoofed sender. You get the Ids parameter value from the Identity property in the output of Get-TenantAllowBlockListSpoofItems command. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Ids +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md new file mode 100644 index 0000000000..98949a3787 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md @@ -0,0 +1,167 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ThrottlingPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-ThrottlingPolicy cmdlet to remove a non-default Microsoft Exchange throttling policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ThrottlingPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can't remove the default client throttling policy. Also, you can't remove a policy associated with any users. For more information, see Example 2. + +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ThrottlingPolicy -Identity ClientThrottlingPolicy2 +``` + +This example removes the user throttling policy ClientThrottlingPolicy2. + +### Example 2 +```powershell +$policy = Get-ThrottlingPolicy ClientThrottlingPolicy2 + +$mailboxes = Get-Mailbox | where-object {$_.ThrottlingPolicy -eq $policy.Identity} + +$defaultPolicy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true} + +foreach ($mailbox in $mailboxes) {Set-Mailbox -Identity $mailbox.Identity -ThrottlingPolicy $defaultPolicy} + +Remove-ThrottlingPolicy ClientThrottlingPolicy2 +``` + +You can't remove a policy that's associated with any users. This example reassigns the users subject to ClientThrottlingPolicy2 to the default policy. Then, it removes ClientThrottlingPolicy2. + +## PARAMETERS + +### -Identity +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 +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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/policy-and-compliance/Remove-TransportRule.md b/exchange/exchange-ps/exchange/Remove-TransportRule.md similarity index 78% rename from exchange/exchange-ps/exchange/policy-and-compliance/Remove-TransportRule.md rename to exchange/exchange-ps/exchange/Remove-TransportRule.md index 0f2b3bacab..110d9f1322 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-TransportRule.md +++ b/exchange/exchange-ps/exchange/Remove-TransportRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-TransportRule @@ -13,12 +16,15 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-TransportRule cmdlet to remove transport rules (mail flow rules) from your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-TransportRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] +Remove-TransportRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` @@ -27,12 +33,12 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-TransportRule -Identity "Redirect messages from kim@contoso.com to legal@contoso.com" ``` @@ -44,9 +50,7 @@ This example removes the rule named "Redirect messages from kim@contoso.com to l The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name - - Distinguished name (DN) - - GUID ```yaml @@ -54,6 +58,7 @@ 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 Default value: None @@ -64,8 +69,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +77,7 @@ 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 @@ -92,6 +97,7 @@ 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 @@ -107,6 +113,7 @@ 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 @@ -115,20 +122,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/f4628cfd-3628-4015-8e9e-274f4a331d01.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md new file mode 100644 index 0000000000..902c636055 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UMAutoAttendant + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UMAutoAttendant cmdlet to delete a Unified Messaging (UM) auto attendant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UMAutoAttendant [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-UMAutoAttendant cmdlet deletes an existing UM auto attendant from Active Directory. The Remove-UMAutoAttendant cmdlet deletes the UM auto attendant and also deletes instances of the UM auto attendant from any associated UM dial plans. When the UM auto attendant is deleted, incoming telephone calls to the configured extensions are no longer answered by the UM auto attendant. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UMAutoAttendant -Identity MyUMAutoAttendant +``` + +This example deletes the UM auto attendant MyUMAutoAttendant. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md new file mode 100644 index 0000000000..85003d4509 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md @@ -0,0 +1,168 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UMCallAnsweringRule + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UMCallAnsweringRule cmdlet to remove an existing Unified Messaging (UM) call answering rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UMCallAnsweringRule [-Identity] + [-Confirm] + [-DomainController ] + [-Mailbox ] + [-WhatIf] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UMCallAnsweringRule -Identity MyUMCallAnsweringRule +``` + +This example removes the call answering rule MyUMCallAnsweringRule from a user's mailbox. The user's mailbox is the mailbox of the user running the cmdlet. + +### Example 2 +```powershell +Remove-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith +``` + +This example removes the call answering rule MyUMCallAnsweringRule from the mailbox of tonysmith. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the mailbox of the user who is running the command is used. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMDialPlan.md b/exchange/exchange-ps/exchange/Remove-UMDialPlan.md new file mode 100644 index 0000000000..15968a4562 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UMDialPlan.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UMDialPlan + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UMDialPlan cmdlet to delete an existing Unified Messaging (UM) dial plan. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UMDialPlan [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-UMDialPlan cmdlet deletes an existing UM dial plan from Active Directory. Make sure the UM dial plan isn't being used by other UM objects such as UM mailbox policies or UM IP gateways. When you delete an existing UM dial plan, the cmdlet verifies that the specified UM dial plan isn't referenced by a Mailbox server, UM IP gateway or UM mailbox policies. The only benefit gained from deleting an obsolete UM dial plan is to reuse the name or perform general Active Directory housekeeping. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UMDialPlan -Identity MyUMDialPlan +``` + +This example deletes the existing UM dial plan MyUMDialPlan. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMHuntGroup.md b/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md new file mode 100644 index 0000000000..0923af3a69 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UMHuntGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UMHuntGroup cmdlet to remove and delete an existing Unified Messaging (UM) hunt group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UMHuntGroup [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-UMHuntGroup cmdlet deletes an existing UM hunt group from Active Directory. When the Remove-UMHuntGroup cmdlet is used, the UM hunt group is removed from the UM IP gateway and then deleted from Active Directory. If the operation leaves the UM IP gateway without any remaining configured UM hunt groups, the IP gateway can't handle or process Unified Messaging calls. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UMHuntGroup -Identity MyUMHuntGroup +``` + +This example deletes the UM hunt group MyUMHuntGroup. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMIPGateway.md b/exchange/exchange-ps/exchange/Remove-UMIPGateway.md new file mode 100644 index 0000000000..e19873e3a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UMIPGateway.md @@ -0,0 +1,133 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UMIPGateway + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UMIPGateway cmdlet to delete a Unified Messaging (UM) IP gateway. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UMIPGateway [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-UMIPGateway cmdlet deletes a specified UM IP gateway. After the UM IP gateway is deleted, Mailbox servers no longer accept new call requests from the IP gateway. + +The Remove-UMIPGateway cmdlet should be run only by an administrator who fully understands the implications of disabling communication with a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX) or IP gateway. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UMIPGateway -Identity MyUMIPGateway +``` + +This example deletes the UM IP gateway MyUMIPGateway. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md new file mode 100644 index 0000000000..56d19d3378 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UMMailboxPolicy + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UMMailboxPolicy cmdlet to delete a Unified Messaging (UM) mailbox policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UMMailboxPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Remove-UMMailboxPolicy cmdlet deletes or removes a UM mailbox policy. If the UM mailbox policy is deleted from Active Directory, the UM mailbox policy can't be used when configuring UM-enabled users. The UM mailbox policy can't be deleted if the UM mailbox policy is referenced by any UM-enabled mailboxes. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UMMailboxPolicy -Identity MyUMMailboxPolicy +``` + +This example deletes the UM mailbox policy MyUMMailboxPolicy. + +## PARAMETERS + +### -Identity +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 +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 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md new file mode 100644 index 0000000000..ed810f1d9c --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md @@ -0,0 +1,144 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UnifiedAuditLogRetentionPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-UnifiedAuditLogRetentionPolicy cmdlet to delete audit log retention policies from the Microsoft Defender portal or the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UnifiedAuditLogRetentionPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +It might take up to 30 minutes for the policy to be completely removed. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Remove-UnifiedAuditLogRetentionPolicy -Identity "SearchQueryPerformed by app@sharepoint" +``` + +This example deletes the audit log retention policy named "SearchQueryPerformed by app@sharepoint". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md new file mode 100644 index 0000000000..8c186032fb --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md @@ -0,0 +1,134 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UnifiedGroup + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-UnifiedGroup cmdlet to remove Microsoft 365 Groups from your cloud-based organization. + +**Note**: You can't use this cmdlet to remove Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see [Delete group](https://learn.microsoft.com/graph/api/group-delete). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-UnifiedGroup [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UnifiedGroup -Identity "Research Department" +``` + +This example removes the Microsoft 365 Group named Research Department. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md new file mode 100644 index 0000000000..f6ae947e09 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md @@ -0,0 +1,167 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UnifiedGroupLinks + +## 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. + +> [!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). + +## SYNTAX + +``` +Remove-UnifiedGroupLinks [-Identity] -Links -LinkType + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UnifiedGroupLinks -Identity "Legal Department" -LinkType Members -Links laura@contoso.com,julia@contoso.com +``` + +This example removes members `laura@contoso.com` and `julia@contoso.com` from the Microsoft 365 Group named Legal Department. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Links +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkType +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: 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 Links parameter. + +```yaml +Type: LinkType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-UserPhoto.md b/exchange/exchange-ps/exchange/Remove-UserPhoto.md new file mode 100644 index 0000000000..fa074e42db --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-UserPhoto.md @@ -0,0 +1,236 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-UserPhoto + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-UserPhoto cmdlet to delete the photo associated with a user's account. The user photo feature allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint. + +**Note**: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see [Manage user photos in Microsoft Graph PowerShell](https://learn.microsoft.com/microsoft-365/admin/add-users/change-user-profile-photos#manage-user-photos-in-microsoft-graph-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Remove-UserPhoto [-Identity] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +### ClearMailboxPhoto +``` +Remove-UserPhoto [-Identity] + [-ClearMailboxPhotoRecord] + [-GroupMailbox] + [-PhotoType ] + [-Confirm] + [-DomainController ] + [-IgnoreDefaultScope] + [-WhatIf] + [] +``` + +## DESCRIPTION +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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-UserPhoto "Ann Beebe" +``` + +This example deletes the photo associated with Ann Beebe's user account. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ClearMailboxPhotoRecord +The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted. You don't need to specify a value with this switch. + +By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to: + +- Return a blank photo. +- Prevent searching Active Directory for a photo. + +Using this switch allows photo requests to search Active Directory for a photo. + +```yaml +Type: SwitchParameter +Parameter Sets: ClearMailboxPhoto +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -PhotoType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..e263889a41 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivamodulefeaturepolicy +applicable: Exchange Online +title: Remove-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX +``` +Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b +``` + +This example deletes the specified policy for the Reflection feature in Viva Insights. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. + +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove. + +To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..037e2a9216 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivaorginsightsdelegatedrole +title: Remove-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegate) so they can't view organizational insights like the leader (the delegator). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-VivaOrgInsightsDelegatedRole -Delegate -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of delegate accounts that were given the capabilities of delegator accounts. + +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Remove-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example removes the organization insights viewing capability of the specified delegator account from the specified delegate account. + +## PARAMETERS + +### -Delegate +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). + +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegator +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. + +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md new file mode 100644 index 0000000000..f4f42ba089 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md @@ -0,0 +1,154 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-WebServicesVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Remove-WebServicesVirtualDirectory cmdlet to remove existing Exchange Web Services virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-WebServicesVirtualDirectory [-Identity] + [-Confirm] + [-DomainController ] + [-Force] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Remove-WebServicesVirtualDirectory -Identity MBX01\Sales +``` + +This example removes the Exchange Web Services virtual directory named Sales from the server named MBX01. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -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/mail-flow/Remove-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Remove-X400AuthoritativeDomain.md rename to exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md index a6f3d2abb9..f6c5c5dddd 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Remove-X400AuthoritativeDomain @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-X400AuthoritativeDomain cmdlet to remove an X.400 authoritative domain. When you remove an X.400 authoritative domain, the X.400 authoritative domain object is deleted from Active Directory. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-X400AuthoritativeDomain [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Remove-X400AuthoritativeDomain [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Remove-X400AuthoritativeDomain -Identity Sales ``` @@ -44,6 +50,7 @@ Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,8 +61,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +69,7 @@ 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 @@ -80,6 +87,7 @@ 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 @@ -95,6 +103,7 @@ 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 @@ -103,20 +112,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/bb58853a-b51e-4f90-b88f-c5adda88d14d.aspx) diff --git a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md new file mode 100644 index 0000000000..828137cfb4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Remove-eDiscoveryCaseAdmin + +## 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-eDiscoveryCaseAdmin cmdlet to remove an eDiscovery Administrator from the Microsoft Purview compliance portal. To replace all eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-eDiscoveryCaseAdmin -User + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. + +When you remove a user from the list of eDiscovery Administrators, the user isn't removed from the eDiscovery Manager role group. That means the user can still view and access the eDiscovery cases they are a member of and the eDiscovery cases they created. To remove all eDiscovery permissions, you can remove the user from the eDiscovery Manager role group by running the Remove-RoleGroupMember cmdlet. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-eDiscoveryCaseAdmin -User chris@contoso.com +``` + +This example removes an eDiscovery Administrator. + +## PARAMETERS + +### -User +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +```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 +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/active-directory/Reset-ProvisioningCache.md b/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md similarity index 81% rename from exchange/exchange-ps/exchange/active-directory/Reset-ProvisioningCache.md rename to exchange/exchange-ps/exchange/Reset-ProvisioningCache.md index 3ff711ca98..0c541d75c8 100644 --- a/exchange/exchange-ps/exchange/active-directory/Reset-ProvisioningCache.md +++ b/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Reset-ProvisioningCache @@ -13,24 +16,29 @@ This cmdlet is available only in on-premises Exchange. The Reset-ProvisioningCache cmdlet clears the Windows PowerShell provisioning cache of frequently used Active Directory objects. This cmdlet is only used for diagnostic purposes. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### GlobalCache ``` -Reset-ProvisioningCache [-Server] -Application [-GlobalCache] +Reset-ProvisioningCache [-Server] -Application + [-GlobalCache] [-CacheKeys ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### OrganizationCache ``` -Reset-ProvisioningCache [-Server] -Application ] [-CurrentOrganization] [-Organizations ] +Reset-ProvisioningCache [-Server] -Application ] + [-CurrentOrganization] + [-Organizations ] [-CacheKeys ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -38,19 +46,19 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Reset-ProvisioningCache -Server EXSRV1.contoso.com -Application Powershell -GlobalCache ``` This example resets the provisioning cache for Windows PowerShell running on the server EXSRV1.contoso.com in an on-premises Exchange organization and specifies that all cache keys are cleared. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Reset-ProvisioningCache -Application Powershell-Proxy -Server datacenter1.adatum.com -GlobalCache ``` @@ -58,19 +66,30 @@ This example runs in a multi-tenant deployment by a data center administrator to ## PARAMETERS +### -Server +The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Application The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: - Powershell - - Powershell-LiveId - - Powershell-Proxy - - PowershellLiveId-Proxy - - Ecp - - Psws ```yaml @@ -78,6 +97,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -86,13 +106,14 @@ Accept wildcard characters: False ``` ### -GlobalCache -The GlobalCache switch specifies that all cache keys are cleared. +The GlobalCache switch clears all cache keys. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCache Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -100,21 +121,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Server -The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -CacheKeys The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx @@ -125,6 +131,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,8 +142,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -144,6 +150,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,13 +159,14 @@ Accept wildcard characters: False ``` ### -CurrentOrganization -The CurrentOrganization switch specifies that the provision cache is reset for this organization. +The CurrentOrganization switch resets the provision cache for the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: OrganizationCache Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -174,6 +182,7 @@ Type: MultiValuedProperty Parameter Sets: OrganizationCache Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,6 +198,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -197,20 +207,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/687309c9-150e-4cdf-9639-3247eb6608a4.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md similarity index 79% rename from exchange/exchange-ps/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md index 84334f30c0..e7ed934cf1 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Restore-DatabaseAvailabilityGroup @@ -13,43 +16,47 @@ This cmdlet is available only in on-premises Exchange. Use the Restore-DatabaseAvailabilityGroup cmdlet as part of a datacenter switchover of a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Restore-DatabaseAvailabilityGroup [-Identity] - [-ActiveDirectorySite ] [-AlternateWitnessDirectory ] - [-AlternateWitnessServer ] [-Confirm] [-DomainController ] [-WhatIf] - [-UsePrimaryWitnessServer] [] + [-ActiveDirectorySite ] + [-AlternateWitnessDirectory ] + [-AlternateWitnessServer ] + [-Confirm] + [-DomainController ] + [-UsePrimaryWitnessServer] + [-WhatIf] + [] ``` ## DESCRIPTION You can also use this cmdlet for disaster recovery purposes to restore functionality to a DAG that has lost quorum due to one or more DAG members being offline for an extended period. Before running this cmdlet, you must first run the Stop-DatabaseAvailabilityGroup cmdlet. -The Restore-DatabaseAvailabilityGroup cmdlet can be run against a DAG only when the DAG is configured with a DatacenterActivationMode parameter value of DagOnly. For more information about the DatacenterActivationMode parameter, see Datacenter Activation Coordination mode (https://technet.microsoft.com/library/dd979790.aspx). +The Restore-DatabaseAvailabilityGroup cmdlet can be run against a DAG only when the DAG is configured with a DatacenterActivationMode parameter value of DagOnly. For more information about the DatacenterActivationMode parameter, see [Datacenter Activation Coordination mode](https://learn.microsoft.com/Exchange/high-availability/database-availability-groups/dac-mode). You can use the Set-DatabaseAvailabilityGroup cmdlet to configure the value for the DatacenterActivationMode parameter. The Restore-DatabaseAvailabilityGroup cmdlet performs several operations that affect the structure and membership of the DAG's cluster. This task does the following: - 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Restore-DatabaseAvailabilityGroup -Identity DAG1 -ActiveDirectorySite Portland ``` This example activates member servers in the DAG DAG1 for the Active Directory site Portland. In this example, the values for the AlternateWitnessServer parameter and the AlternateWitnessDirectory parameter had been previously set by using the Set-DatabaseAvailabilityGroup cmdlet. Thus, there is no need to specify them here. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Restore-DatabaseAvailabilityGroup -Identity DAG1 -ActiveDirectorySite Redmond -AlternateWitnessServer CAS4 -AlternateWitnessDirectory D:\DAG1 ``` @@ -65,6 +72,7 @@ Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -80,6 +88,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,6 +104,7 @@ Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,6 +120,7 @@ Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -120,15 +131,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,6 +157,7 @@ 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 @@ -151,14 +165,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -UsePrimaryWitnessServer +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: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -166,14 +181,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsePrimaryWitnessServer -The UsePrimaryWitnessServer parameter specifies that the DAG's currently configured witness server should be used if a witness is needed by the DAG members being activated. +### -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: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -182,20 +198,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d65394ad-9680-423d-9a93-0b46906123e5.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md b/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md similarity index 76% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md rename to exchange/exchange-ps/exchange/Restore-DetailsTemplate.md index 3082f5cf02..c064436cf5 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md +++ b/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Restore-DetailsTemplate @@ -13,24 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Restore-DetailsTemplate cmdlet to restore the specified template to its default state. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Restore-DetailsTemplate [-Identity] [-Confirm] [-DomainController ] - [-WhatIf] [] +Restore-DetailsTemplate [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Restore-DetailsTemplate -Identity en-us\User ``` @@ -42,15 +48,10 @@ This example restores the default attributes to the User details template for th 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 - - Group - - PublicFolder - - SearchDialog - - MailboxAgent - - Contact ```yaml @@ -58,6 +59,7 @@ Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -68,15 +70,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -92,6 +96,7 @@ 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 @@ -107,6 +112,7 @@ 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 @@ -115,20 +121,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/f3027ef9-e7bf-4db0-b844-9e9426a5b9a8.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Restore-Mailbox.md b/exchange/exchange-ps/exchange/Restore-Mailbox.md similarity index 77% rename from exchange/exchange-ps/exchange/mailboxes/Restore-Mailbox.md rename to exchange/exchange-ps/exchange/Restore-Mailbox.md index 0ab62d9619..8e775b1697 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Restore-Mailbox.md +++ b/exchange/exchange-ps/exchange/Restore-Mailbox.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Restore-Mailbox @@ -13,52 +16,65 @@ This cmdlet is available only in Exchange Server 2010. Use the Restore-Mailbox cmdlet to extract mailbox content from a restored database. -Note: In Exchange Server 2010 Service Pack 1 (SP1) or later, use the New-MailboxRestoreRequest cmdlet instead of the Restore-Mailbox cmdlet to extract mailbox content from a restored database. +**Note**: In Exchange Server 2010 Service Pack 1 (SP1) or later, use the New-MailboxRestoreRequest cmdlet instead of the Restore-Mailbox cmdlet to extract mailbox content from a restored database. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Restore-Mailbox [-Identity] -RecoveryDatabase - -RecoveryMailbox -TargetFolder [-AllowDuplicates] - [-AllContentKeywords ] [-AttachmentFilenames ] [-BadItemLimit ] [-Confirm] - [-ContentKeywords ] [-EndDate ] [-ExcludeFolders ] - [-GlobalCatalog ] [-IncludeFolders ] [-Locale ] [-MaxThreads ] - [-RecipientKeywords ] [-SenderKeywords ] [-StartDate ] - [-SubjectKeywords ] [-ValidateOnly] [-WhatIf] [] +Restore-Mailbox [-Identity] -RecoveryDatabase -RecoveryMailbox -TargetFolder + [-AllowDuplicates] + [-AllContentKeywords ] + [-AttachmentFilenames ] + [-BadItemLimit ] + [-Confirm] + [-ContentKeywords ] + [-EndDate ] + [-ExcludeFolders ] + [-GlobalCatalog ] + [-IncludeFolders ] + [-Locale ] + [-MaxThreads ] + [-RecipientKeywords ] + [-SenderKeywords ] + [-StartDate ] + [-SubjectKeywords ] + [-ValidateOnly] + [-WhatIf] + [] ``` ## DESCRIPTION The Restore-Mailbox cmdlet copies end-user data from any server running Microsoft Exchange Server 2010 to a mailbox on an Exchange 2010 Mailbox server in the same organization that has adequate space and resources to support the mailbox. The Restore-Mailbox cmdlet can only use disconnected mailboxes on a server as a source of data, and the cmdlet can only use connected mailboxes as a target for 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Restore-Mailbox -Identity Scott -RecoveryDatabase MyRecoveryDatabase ``` This example restores a mailbox for user Scott from the database MyRecoveryDatabase. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Restore-Mailbox -Identity Scott -RecoveryDatabase MyRecoveryDatabase -RecoveryMailbox John -TargetFolder Recovery ``` This example restores John's mailbox content into Scott's mailbox under the Recovery folder. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Restore-Mailbox -Identity Scott -RecoveryDatabase MyRecoveryDatabase -SubjectKeywords "Meeting" -ContentKeywords "business" -IncludeFolders \Inbox,\Calendar ``` This example restores only the mail with the subject Meeting, with the message body containing the word business, and with the message location either in the Inbox or Calendar folder. This example assumes that the mailbox is in English. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Get-Mailbox -Database MyDatabase | Restore-Mailbox -RecoveryDatabase MyRecoveryDatabase ``` @@ -67,55 +83,25 @@ This example bulk restores all the mailboxes in the MyDatabase mailbox database ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the mailbox. - -This parameter accepts the following values: +The Identity parameter specifies the mailbox that you want to restore. You can use any value that uniquely identifies the mailbox. For example: +- Name - Alias - - Example: JPhillips - +- Distinguished name (DN) - Canonical DN - - Example: Atlanta.Corp.Contoso.Com/Users/JPhillips - -- Display Name - - Example: Jeff Phillips - -- Distinguished Name (DN) - - Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com - -- Domain\\Account - - Example: Atlanta\\JPhillips - +- Domain\\Username +- Email address - GUID - - Example: fb456636-fe7d-4d58-9d15-5af57d0354c2 - -- Immutable ID - - Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com - -- Legacy Exchange DN - - Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips - -- SMTP Address - - Example: Jeff.Phillips@contoso.com - -- User Principal Name - - Example: JPhillips@contoso.com +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -124,17 +110,18 @@ Accept wildcard characters: False ``` ### -RecoveryDatabase -The RecoveryDatabase parameter specifies the recovery database from which you're restoring the mailbox. You can use the following values: +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: -- GUID of the database - -- Database name +- Name +- Distinguished name (DN) +- GUID ```yaml Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -145,11 +132,14 @@ Accept wildcard characters: False ### -RecoveryMailbox 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. + ```yaml Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -165,6 +155,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -173,13 +164,16 @@ Accept wildcard characters: False ``` ### -AllowDuplicates -The AllowDuplicates parameter specifies whether to copy mail items without checking if they're duplicates of existing items and without removing duplicate items. We recommend that you use the AllowDuplicates parameter together with the IncludeFolders parameter. +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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -191,9 +185,7 @@ Accept wildcard characters: False The AllContentKeywords parameter specifies the filters for all of the following: - Subject - - Message body - - Attachment content This allows an OR search of all these fields. If your search criteria are part of the subject, message body, or attachment content, you get results. @@ -203,6 +195,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -218,6 +211,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -233,6 +227,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -243,8 +238,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -252,6 +246,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -267,6 +262,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -275,13 +271,14 @@ Accept wildcard characters: False ``` ### -EndDate -The EndDate parameter specifies the end date for filtering content that will be exported from the source mailbox. Only items in the mailbox whose date is prior to the end date are exported. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. +The EndDate parameter specifies the end date for filtering content that will be exported from the source mailbox. Only items in the mailbox whose date is prior to the end date are exported. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format MM/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. ```yaml Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -297,6 +294,7 @@ Type: MapiFolderPath[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -312,6 +310,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -327,6 +326,7 @@ Type: MapiFolderPath[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -342,6 +342,7 @@ Type: CultureInfo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -357,6 +358,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -372,6 +374,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -387,6 +390,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -402,6 +406,7 @@ Type: DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -417,6 +422,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -425,13 +431,16 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used. +The ValidateOnly switch tells the 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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -447,6 +456,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -455,20 +465,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f7205547-b2c5-4429-bae6-43c1bc4dce75.aspx) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md new file mode 100644 index 0000000000..5132660f97 --- /dev/null +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -0,0 +1,404 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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. + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### OnPremises +``` +Restore-RecoverableItems -Identity + [-EntryID ] + [-FilterEndTime ] + [-FilterItemType ] + [-FilterStartTime ] + [-LastParentFolderID ] + [-ResultSize ] + [-SourceFolder ] + [-SubjectContains ] + [] +``` + +### Cloud +``` +Restore-RecoverableItems -Identity + [-EntryID ] + [-FilterEndTime ] + [-FilterItemType ] + [-FilterStartTime ] + [-LastParentFolderID ] + [-MaxParallelSize ] + [-NoOutput] + [-PolicyTag ] + [-RestoreTargetFolder ] + [-ResultSize ] + [-SourceFolder ] + [-SubjectContains ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Restore-RecoverableItems -Identity laura@contoso.com -FilterItemType IPM.Note -SubjectContains "FY18 Accounting" -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM" +``` + +After using the Get-RecoverableItems cmdlet to verify the existence of the item, this example restores the specified deleted item from the specified mailbox: + +- Mailbox: laura@contoso.com +- Item type: Email message +- Message subject: FY18 Accounting +- Location: Recoverable Items\Deletions +- Date range: 2/1/2018 to 2/5/2018 + +### Example 2 +```powershell +$mailboxes = Import-CSV "C:\My Documents\RestoreMessage.csv" + +$mailboxes | foreach {Restore-RecoverableItems -Identity $_.SMTPAddress -SubjectContains "Project X" -SourceFolder DeletedItems -FilterItemType IPM.Note} +``` + +In Exchange Server, this example restores the deleted email message "Project X" for the mailboxes that are specified in the comma-separated value (CSV) file C:\\My Documents\\RestoreMessage.csv. The CSV file uses the header value SMTPAddress, and contains the email address of each mailbox on a separate line like this: + +SMTPAddress + +chris@contoso.com + +michelle@contoso.com + +laura@contoso.com + +julia@contoso.com + +The first command reads the CSV file to the variable named $mailboxes. The second command restores the specified message from the Deleted Items folder in those mailboxes. + +### Example 3 +```powershell +Restore-RecoverableItems -Identity "malik@contoso.com","lillian@contoso.com" -FilterItemType IPM.Note -SubjectContains "COGS FY17 Review" -FilterStartTime "3/15/2019 12:00:00 AM" -FilterEndTime "3/25/2019 11:59:59 PM" -MaxParallelSize 2 +``` + +In Exchange Online, after using the Get-RecoverableItems cmdlet to verify the existence of the item, this example restores the specified deleted items in the specified mailboxes: + +- Mailboxes: malik@contoso.com, lillian@contoso.com +- Item type: Email message +- Message subject: COGS FY17 Review +- Location: Recoverable Items\Deletions +- Date range: 3/15/2019 to 3/25/2019 +- Number of mailboxes processed simultaneously: 2 + +### Example 4 +```powershell +Get-RecoverableItems administrator | Restore-RecoverableItems +``` + +This example bulk restores all the recoverable items for administrator. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +In Exchange Online, you can specify multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: GeneralMailboxOrMailUserIdParameter +Parameter Sets: OnPremises +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: GeneralMailboxOrMailUserIdParameter[] +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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.). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterEndTime +The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterItemType +The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: + +- IPM.Appointment (Meetings and appointments) +- IPM.Contact +- IPM.File +- IPM.Note +- IPM.Task + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterStartTime +The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastParentFolderID +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxParallelSize +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. + +The value of this parameter has no effect when the Identity parameter specifies only one mailbox. + +```yaml +Type: Int32 +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoOutput +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTag +This parameter is available only in the cloud-based service. + +{{ Fill PolicyTag Description }} + +```yaml +Type: String[] +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTargetFolder +This parameter is available only in the cloud-based service. + +The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. + +This parameter is available only on primary mailboxes and is ignored on archive mailboxes. A destination folder will be created if it does not exist. Valid paths are: + +- `/` +- `/folder1` +- `/folder1/folder2` +- `folder1` +- `folder1/folder2` + +The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree: `/Top Of Information Store`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceFolder +The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: + +- DeletedItems: The Deleted Items folder. +- RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). +- PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). + +If you don't use this parameter, the command searches those three folders. + +- DiscoveryHoldsItems (cloud-only): The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. + +```yaml +Type: RecoverableItemsFolderType +Parameter Sets: OnPrem +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectContains +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md similarity index 77% rename from exchange/exchange-ps/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md rename to exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md index 57b1b8df44..fd5c0c4ae9 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Resume-MailboxDatabaseCopy @@ -13,42 +16,47 @@ This cmdlet is available only in on-premises Exchange. Use the Resume-MailboxDatabaseCopy cmdlet to unblock activation or resume log copying and replay for a passive mailbox database copy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Resume-MailboxDatabaseCopy [-Identity] [-ReplicationOnly] +Resume-MailboxDatabaseCopy [-Identity] + [-ReplicationOnly] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### DisableReplayLag ``` -Resume-MailboxDatabaseCopy [-Identity] [-DisableReplayLag] [-DisableReplayLagReason ] +Resume-MailboxDatabaseCopy [-Identity] + [-DisableReplayLag] + [-DisableReplayLagReason ] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Resume-MailboxDatabaseCopy -Identity DB1\MBX3 ``` This example resumes replication and replay activity for the copy of the database DB1 hosted on the Mailbox server MBX3. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Resume-MailboxDatabaseCopy -Identity DB2\MBX4 -ReplicationOnly ``` @@ -64,6 +72,7 @@ Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -74,8 +83,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -83,6 +91,7 @@ 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 @@ -90,29 +99,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -DisableReplayLag +The DisableReplayLag switch disables any configured replay lag time for the database copy when the passive copy is resumed. You don't need to specify a value with this switch. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReplicationOnly -The ReplicationOnly switch specifies whether to resume replication without affecting the activation setting (for example, the ActivationSuspended property for the database copy remains set to True). +### -DisableReplayLagReason +The DisableReplayLagReason parameter is used with the DisableReplayLag parameter to specify an administrative reason for disabling replay lag time for a passive copy. ```yaml -Type: SwitchParameter -Parameter Sets: Identity +Type: String +Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -120,14 +131,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,29 +147,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableReplayLag -The DisableReplayLag parameter specifies that any configured replay lag time for the database copy should be disabled when the passive copy is resumed. +### -ReplicationOnly +The ReplicationOnly switch resumes replication without affecting the activation setting (for example, the ActivationSuspended property for the database copy remains set to True). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: DisableReplayLag +Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True +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 ``` -### -DisableReplayLagReason -The DisableReplayLagReason parameter is used with the DisableReplayLag parameter to specify an administrative reason for disabling replay lag time for a passive copy. +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: String -Parameter Sets: DisableReplayLag -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -166,20 +180,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3d90b006-9914-415b-9a1f-730bd91c8548.aspx) diff --git a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md new file mode 100644 index 0000000000..48f67e84d6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md @@ -0,0 +1,138 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Resume-MailboxExportRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Resume-MailboxExportRequest cmdlet to resume an export request that was suspended or failed. + +This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Resume-MailboxExportRequest [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Resume-MailboxExportRequest -Identity kweku\export +``` + +This example resumes the export request kweku\\export. + +### Example 2 +```powershell +Get-MailboxExportRequest -Status Failed | Resume-MailboxExportRequest +``` + +This example resumes any failed export move requests. + +## PARAMETERS + +### -Identity +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 +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 +``` + +### -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/Resume-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md new file mode 100644 index 0000000000..f1d190bae5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md @@ -0,0 +1,142 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Resume-MailboxImportRequest cmdlet to resume an import request that was suspended or failed. + +NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). + +This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Resume-MailboxImportRequest [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Resume-MailboxImportRequest -Identity kweku\MailboxImport1 +``` + +This example resumes the second import request for Kweku's mailbox kweku\\MailboxImport1 + +### Example 2 +```powershell +Get-MailboxImportRequest -Status Failed | Resume-MailboxImportRequest +``` + +This example resumes all failed import requests. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mailboxes/Resume-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md similarity index 77% rename from exchange/exchange-ps/exchange/mailboxes/Resume-MailboxRestoreRequest.md rename to exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md index 6aa332787b..b7faf00b00 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Resume-MailboxRestoreRequest @@ -13,29 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Resume-MailboxRestoreRequest cmdlet to resume a restore request that was suspended or failed. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Resume-MailboxRestoreRequest [-Identity] [-Confirm] - [-DomainController ] [-WhatIf] [] +Resume-MailboxRestoreRequest [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Resume-MailboxRestoreRequest -Identity "kweku\RestoreFromDB01" ``` This example resumes the restore request with the identity kweku\\RestoreFromDB01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxRestoreRequest -Status Failed | Resume-MailboxRestoreRequest ``` @@ -44,7 +50,7 @@ This example resumes any restore request with the status of Failed. ## PARAMETERS ### -Identity -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: \\\\. +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). @@ -53,6 +59,7 @@ 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 Default value: None @@ -63,8 +70,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -72,6 +78,7 @@ 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 Default value: None @@ -89,6 +96,7 @@ 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 @@ -104,6 +112,7 @@ 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 Default value: None @@ -112,20 +121,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/840c4a93-8c55-4ca3-b690-ad7523235c11.aspx) diff --git a/exchange/exchange-ps/exchange/Resume-Message.md b/exchange/exchange-ps/exchange/Resume-Message.md new file mode 100644 index 0000000000..3015c97f9a --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-Message.md @@ -0,0 +1,169 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Resume-Message + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Resume-Message cmdlet to enable delivery of a previously suspended message in a queue on a Mailbox server or Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Resume-Message -Filter + [-Server ] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Resume-Message [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Resume-Message -Server Server1 -Filter "FromAddress -eq 'kweku@contoso.com' -and ExpirationTime -lt '1/5/2018 3:00 PM'" +``` + +This example resumes delivery of all messages in a suspended state and for which the following conditions are true: + +- 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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -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/Resume-MoveRequest.md b/exchange/exchange-ps/exchange/Resume-MoveRequest.md new file mode 100644 index 0000000000..81384c86be --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-MoveRequest.md @@ -0,0 +1,200 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Resume-MoveRequest cmdlet to resume a move request that has been suspended or has failed. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Resume-MoveRequest [-Identity] + [-Confirm] + [-DomainController ] + [-ProxyToMailbox ] + [-SuspendWhenReadyToComplete] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Resume-MoveRequest -Identity "Tony@contoso.com" +``` + +This example resumes the move request of Tony Smith's mailbox. + +### Example 2 +```powershell +Get-MoveRequest -MoveStatus Failed | Resume-MoveRequest +``` + +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 +``` + +This example resumes any move requests that have the suspend comment "Resume after 10 P.M." + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: + +- GUID +- Distinguished name (DN) +- Domain\\Account +- User principal name (UPN) +- LegacyExchangeDN +- SMTP address +- Alias + +```yaml +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -ProxyToMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendWhenReadyToComplete +The SuspendWhenReadyToComplete switch suspends the move request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. + +Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the CompleteAfter parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Resume-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md new file mode 100644 index 0000000000..42768b7cfb --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md @@ -0,0 +1,139 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Resume-PublicFolderMigrationRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Resume-PublicFolderMigrationRequest cmdlet to resume serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet) that have failed or have been suspended (manually or automatically). + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Resume-PublicFolderMigrationRequest [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Resume-PublicFolderMigrationRequest -Identity "PublicFolderMigration" +``` + +This example resumes the migration request PublicFolderMigration. + +### Example 2 +```powershell +Get-PublicFolderMigrationRequest -Status Failed | Resume-PublicFolderMigrationRequest +``` + +This example resumes any failed migration requests. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the migration request that you want to resume. You can use the following values: + +- Name +- RequestGUID + +```yaml +Type: PublicFolderMigrationRequestIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Resume-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md new file mode 100644 index 0000000000..af943a8370 --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md @@ -0,0 +1,141 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Resume-PublicFolderMoveRequest + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Resume-PublicFolderMoveRequest [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Resume-PublicFolderMoveRequest -Identity \PublicFolderMove +``` + +This example resumes the public folder move request \\PublicFolderMove. + +### Example 2 +```powershell +Get-PublicFolderMoveRequest -MoveStatus Failed | Resume-PublicFolderMoveRequest +``` + +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 +``` + +This example resumes a move request that has the suspend comment "Resume after 10 P.M." + +## PARAMETERS + +### -Identity +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 +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 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Resume-PublicFolderReplication.md b/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md new file mode 100644 index 0000000000..a781b34c89 --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Resume-PublicFolderReplication + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Resume-PublicFolderReplication cmdlet to resume public folder content replication when it's been stopped. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Resume-PublicFolderReplication [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Resume-PublicFolderReplication +``` + +This example resumes content replication for the entire organization. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Resume-Queue.md b/exchange/exchange-ps/exchange/Resume-Queue.md new file mode 100644 index 0000000000..43bb312d87 --- /dev/null +++ b/exchange/exchange-ps/exchange/Resume-Queue.md @@ -0,0 +1,165 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Resume-Queue + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Resume-Queue cmdlet to restart processing for a suspended queue on a Mailbox server or an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Resume-Queue -Filter + [-Server ] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Resume-Queue [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Resume-Queue -Server Server1.contoso.com -Filter "NextHopDomain -eq 'Fourthcoffee.com'" +``` + +This example resumes processing of all queues where the NextHopDomain is Fourthcoffee.com on the server Server1.contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -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/Retry-Queue.md b/exchange/exchange-ps/exchange/Retry-Queue.md new file mode 100644 index 0000000000..c34b537241 --- /dev/null +++ b/exchange/exchange-ps/exchange/Retry-Queue.md @@ -0,0 +1,187 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Retry-Queue + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Retry-Queue cmdlet to force a connection attempt for a queue on a Mailbox server or an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Retry-Queue -Filter + [-Server ] + [-Confirm] + [-Resubmit ] + [-WhatIf] + [] +``` + +### Identity +``` +Retry-Queue [-Identity] + [-Confirm] + [-Resubmit ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Retry-Queue -Filter "NextHopDomain -eq "contoso.com" -and Status -eq 'Retry'" +``` + +This example forces a connection attempt for all queues that meet the following criteria: + +- The queues are holding messages for the domain contoso.com. +- The queues have a status of Retry. +- The queues are located on the server on which the command is executed. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Resubmit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -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/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md new file mode 100644 index 0000000000..d424e6898b --- /dev/null +++ b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md @@ -0,0 +1,132 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Rotate-DkimSigningConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Rotate-DkimSigningConfig cmdlet to rotate the public and private DomainKeys Identified Mail (DKIM) signing policy keys for domains in a cloud-based organization. This cmdlet creates new DKIM keys and uses the alternate DKIM selector. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Rotate-DkimSigningConfig [-Identity] + [-Confirm] + [-KeySize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Rotate-DkimSigningConfig -Identity contoso.com +``` + +This example rotates the DKIM signing policy for the contoso.com domain. + +## PARAMETERS + +### -Identity +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). +- Distinguished name (DN) +- GUID + +```yaml +Type: DkimSigningConfigIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeySize +The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are: + +- 1024 +- 2048 + +RSA keys are supported. Ed25519 keys aren't supported. + +**Note**: Upgrading the key size to 2048 only upgrades the selector that isn't currently active. After key rotation has taken place, you need to run the command again to upgrade the key size of the other selector. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md new file mode 100644 index 0000000000..f42ad8e781 --- /dev/null +++ b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md @@ -0,0 +1,335 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Search-AdminAuditLog + +## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log. Administrator audit logging records when a user or administrator makes a change in your organization (in the Exchange admin center or by using cmdlets). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Search-AdminAuditLog + [-Cmdlets ] + [-DomainController ] + [-EndDate ] + [-ExternalAccess ] + [-IsSuccess ] + [-ObjectIds ] + [-Parameters ] + [-ResultSize ] + [-StartDate ] + [-StartIndex ] + [-UserIds ] + [] +``` + +## DESCRIPTION +If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default. + +In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. + +In Exchange Online PowerShell, data is available for the last 90 days. You can enter dates older than 90 days, but only data from the last 90 days will be returned. + +For more information about the structure and properties of the audit log, 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). + +## EXAMPLES + +### Example 1 +```powershell +Search-AdminAuditLog -Cmdlets New-RoleGroup,New-ManagementRoleAssignment +``` + +This example finds all the administrator audit log entries that contain either the New-RoleGroup or the New-ManagementRoleAssignment cmdlet. + +### Example 2 +```powershell +Search-AdminAuditLog -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults,ProhibitSendReceiveQuota,ProhibitSendQuota -StartDate 01/24/2018 -EndDate 02/12/2018 -IsSuccess $true +``` + +This example finds all the administrator audit log entries that match the following criteria: + +- Cmdlets: Set-Mailbox +- Parameters: UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota +- StartDate: 01/24/2018 +- EndDate: 02/12/2018 + +The command completed successfully + +### Example 3 +```powershell +$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog + +$LogEntries | ForEach { $_.CmdletParameters } +``` + +This example displays all the comments written to the administrator audit log by the Write-AdminAuditLog cmdlet. + +First, store the audit log entries in a temporary variable. Then, iterate through all the audit log entries returned and display the Parameters property. + +### Example 4 +```powershell +Search-AdminAuditLog -ExternalAccess $true -StartDate 09/17/2018 -EndDate 10/02/2018 +``` + +This example returns entries in the administrator audit log of an Exchange Online organization for cmdlets run by Microsoft datacenter administrators between September 17, 2018 and October 2, 2018. + +## PARAMETERS + +### -Cmdlets +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**. + +```yaml +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 +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +In the cloud-based service, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +In the results of this cmdlet, the date/time when the change was made (the cmdlet was run) is returned in the property named **RunDate**. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAccess +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. +- $false: Only return audit log entries where the change was made by an internal user. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsSuccess +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). +- $false: Only return audit log entries where the change was not successful (in other words, the cmdlet did not run successfully and resulted in an error). + +In the results of this cmdlet, this property is named **Succeeded**. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectIds +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 can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Parameters +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** + +```yaml +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. + +The maximum results to return is 250,000. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +In the cloud-based service, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +In the results of this cmdlet, the date/time when the change was made (the cmdlet was run) is returned in the property named **RunDate**. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIndex +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +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)). + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"User1","User2",..."UserN"`. + +In the results of this cmdlet, this property is named **Caller** + +```yaml +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Search-Mailbox.md b/exchange/exchange-ps/exchange/Search-Mailbox.md new file mode 100644 index 0000000000..942951ea8b --- /dev/null +++ b/exchange/exchange-ps/exchange/Search-Mailbox.md @@ -0,0 +1,449 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Search-Mailbox + +## SYNOPSIS +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. + +By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to *any* role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Search-Mailbox [-Identity] + [-Confirm] + [-DeleteContent] + [-DomainController ] + [-DoNotIncludeArchive] + [-Force] + [-IncludeUnsearchableItems] + [-SearchDumpster] + [-SearchDumpsterOnly] + [-SearchQuery ] + [-WhatIf] + [] +``` + +### EstimateResult +``` +Search-Mailbox [-Identity] + [-EstimateResultOnly] + [-Confirm] + [-DomainController ] + [-DoNotIncludeArchive] + [-Force] + [-IncludeUnsearchableItems] + [-SearchDumpster] + [-SearchDumpsterOnly] + [-SearchQuery ] + [-WhatIf] + [] +``` + +### Mailbox +``` +Search-Mailbox [-Identity] -TargetFolder -TargetMailbox + [-Confirm] + [-DeleteContent] + [-DomainController ] + [-DoNotIncludeArchive] + [-Force] + [-IncludeUnsearchableItems] + [-LogLevel ] + [-LogOnly] + [-SearchDumpster] + [-SearchDumpsterOnly] + [-SearchQuery ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use the Search-Mailbox cmdlet to search messages in a specified mailbox and perform any of the following tasks: + +- Copy messages to a specified target mailbox. +- Delete messages from the source mailbox. You have to be assigned the Mailbox Import Export management role to delete messages. +- Perform single item recovery to recover items from a user's Recoverable Items folder. +- Clean up the Recoverable Items folder for a mailbox when it has reached the Recoverable Items hard quota. + +## EXAMPLES + +### Example 1 +```powershell +Search-Mailbox -Identity "Joe Healy" -SearchQuery "Subject:Project Hamilton" -TargetMailbox "DiscoveryMailbox" -TargetFolder "JoeHealy-ProjectHamilton" -LogLevel Full +``` + +This example searches the mailbox of Joe Healy and copies the search results to the DiscoveryMailbox in the folder JoeHealy-ProjectHamilton. + +### Example 2 +```powershell +Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -TargetMailbox "administrator" -TargetFolder "SearchAndDeleteLog" -LogOnly -LogLevel Full +``` + +This example searches April Stewart's mailbox for messages that contain the phrase "Your bank statement" in the subject and logs the result in the SearchAndDeleteLog folder in the administrator's mailbox. Messages aren't copied to the target mailbox. + +### Example 3 +```powershell +Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -DeleteContent +``` + +This example searches April Stewart's mailbox for messages that contain the phrase "Your bank statement" in the subject and deletes the messages from the source mailbox. You have to be assigned the Mailbox Import Export management role to use the DeleteContent switch. + +### Example 4 +```powershell +Get-Mailbox | Search-Mailbox -SearchQuery 'election OR candidate OR vote' -TargetMailbox "Discovery Search Mailbox" -TargetFolder "AllMailboxes-Election" -LogLevel Full +``` + +This example searches all mailboxes in your organization for messages that contain the words "election", "candidate", or "vote". The search results are copied to the Discovery Search Mailbox in the folder AllMailboxes-Election. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the mailbox to search. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxOrMailUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EstimateResultOnly +The EstimateResultOnly switch returns only an estimate of the total number and size of messages. Messages aren't copied to the target mailbox. You don't need to specify a value with this switch. + +You can't use this switch with the TargetMailbox parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: EstimateResult +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetFolder +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetMailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You must use this parameter with the TargetFolder parameter. You can't use this parameter with the EstimateResultOnly switch. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -DeleteContent +**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. + +When you use this switch with the TargetMailbox parameter, messages are copied to the target mailbox and removed from the source mailbox. If you set the logging level for the search to Basic or Full, you must specify a target mailbox and a target folder to place the log in. To delete messages from the source mailbox without copying them to the target mailbox, don't specify the TargetMailbox, TargetFolder, and LogLevel parameters. + +Before you use the DeleteContent switch to delete content, we recommend that you test search parameters by using the LogOnly parameter, as shown in Example 2. + +```yaml +Type: SwitchParameter +Parameter Sets: Mailbox, Identity +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 +``` + +### -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 +``` + +### -DoNotIncludeArchive +The DoNotIncludeArchive switch specifies that the user's archive mailbox shouldn't be included in the search. You don't need to specify a value for this switch. + +By default, the archive mailbox is always searched. + +If auto-expanding archiving is enabled for an Exchange Online mailbox, only the user's primary archive mailbox is searched. Auxiliary archive mailboxes aren't included in the search. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you use the DeleteContent switch to permanently delete messages. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUnsearchableItems +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +The LogLevel parameter specifies the logging level for the search. It can have one of the following values: + +- Suppress: No logs are kept. +- Basic: Basic information about the query and who ran it is kept. +- Full: In addition to the information kept by the Basic log level, the Full log level adds a complete list of search results. + +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. + +```yaml +Type: LoggingLevel +Parameter Sets: Mailbox +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 +``` + +### -LogOnly +The LogOnly switch performs a search, but only generates a log. Messages returned by the search aren't copied to the target mailbox. You don't need to specify a value with this switch. + +The logging level is specified by using the LogLevel parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: Mailbox +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchDumpster +The SearchDumpster switch specifies whether to include the Recoverable Items folder in the search. The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. + +By default, the Recoverable Items folder is always included in the search. To exclude the Recoverable Items folder from the search, use this exact syntax: `-SearchDumpster:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchDumpsterOnly +The SearchDumpsterOnly switch specifies that only the Recoverable Items folder of the specified mailbox is searched. You don't need to specify a value with this switch. + +The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. + +You can also use this switch with the DeleteContent switch to delete messages from the Recoverable Items folder and reduce the size of the folder. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchQuery +The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). 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. + +**Note**: The Search-Mailbox cmdlet returns up to 10000 results per mailbox if a search query is specified. + +```yaml +Type: String +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 +``` + +### -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/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md new file mode 100644 index 0000000000..f6ff4a429a --- /dev/null +++ b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md @@ -0,0 +1,380 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Search-MailboxAuditLog + +## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Search-MailboxAuditLog cmdlet to search mailbox audit log entries matching the specified search terms. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Search-MailboxAuditLog [[-Identity] ] + [-ShowDetails] + [-DomainController ] + [-EndDate ] + [-ExternalAccess ] + [-GroupMailbox] + [-HasAttachments ] + [-IncludeInactiveMailbox] + [-LogonTypes ] + [-Operations ] + [-ResultSize ] + [-StartDate ] + [] +``` + +### MultipleMailboxesSearch +``` +Search-MailboxAuditLog [-Mailboxes ] + [-DomainController ] + [-EndDate ] + [-ExternalAccess ] + [-GroupMailbox] + [-HasAttachments ] + [-IncludeInactiveMailbox] + [-LogonTypes ] + [-Operations ] + [-ResultSize ] + [-StartDate ] + [] +``` + +## DESCRIPTION +The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit logs for one or more specified mailboxes and displays search results in the Exchange Management Shell window. To search mailbox audit logs for multiple mailboxes and have the results sent by email to specified recipients, use the New-MailboxAuditLogSearch cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). + +In multi-geo environments, when you run this cmdlet in a different region from the mailbox that you're trying to search, you might receive the error, "An error occurred while trying to access the audit log." In this scenario, you need to anchor the PowerShell session to a user in the same region as the mailbox as described in [Connect directly to a geo location using Exchange Online PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo#connect-directly-to-a-geo-location-using-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Search-MailboxAuditLog -Identity kwok -LogonTypes Admin,Delegate -StartDate 1/1/2018 -EndDate 12/31/2018 -ResultSize 2000 +``` + +This example retrieves mailbox audit log entries for Ken Kwok's mailbox for actions performed by Admin and Delegate logon types between 1/1/2018 and 12/31/2018. A maximum of 2,000 log entries are returned. + +### Example 2 +```powershell +Search-MailboxAuditLog -Mailboxes kwok,bsmith -LogonTypes Admin,Delegate -StartDate 1/1/2018 -EndDate 12/31/2018 -ResultSize 2000 +``` + +This example retrieves mailbox audit log entries for Ken Kwok and Ben Smith's mailboxes for actions performed by Admin and Delegate logon types between 1/1/2018 and 12/31/2018. A maximum of 2,000 log entries are returned. + +### Example 3 +```powershell +Search-MailboxAuditLog -Identity kwok -LogonTypes Owner -ShowDetails -StartDate 1/1/2017 -EndDate 3/1/2017 | Where-Object {$_.Operation -eq "HardDelete"} +``` + +This example retrieves mailbox audit log entries for Ken Kwok's mailbox for actions performed by the mailbox owner between 1/1/2017 and 3/1/2017. The results are piped to the Where-Object cmdlet and filtered to return only entries with the HardDelete action. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAccess +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasAttachments +The HasAttachments parameter filters the search by messages that have attachments. Valid values are: + +- $true: Only messages with attachments are included in the search. +- $false: Messages with and without attachments are included in the search. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeInactiveMailbox +This parameter is available only in the cloud-based service. + +{{ Fill IncludeInactiveMailbox Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogonTypes +The LogonTypes parameter specifies the type of logons. Valid values are: + +- Admin: Audit log entries for mailbox access by administrator logons are returned. +- Delegate: Audit log entries for mailbox access by delegates are returned, including access by users with Full Mailbox Access permission. +- Owner: Audit log entries for mailbox access by the primary mailbox owner are returned. This value requires the ShowDetails switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailboxes +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"`. + +You can't use this parameter with the ShowDetails switch. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operations +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.) +- ApplyRecord (Exchange Online only) +- Copy +- Create +- Default (Exchange Online only) +- FolderBind +- HardDelete +- MailboxLogin +- MailItemsAccessed (Exchange Online only and only for E5 or E5 Compliance add-on subscription users.) +- MessageBind (Although this value is accepted, these actions are no longer logged.) +- ModifyFolderPermissions (Exchange 2019 and Exchange Online only. Although this value is accepted, it's already included in the UpdateFolderPermissions action and isn't audited separately.) +- Move +- MoveToDeletedItems +- RecordDelete (Exchange Online only) +- RemoveFolderPermissions (Exchange 2019 and Exchange Online only. Although this value is accepted, it's already included in the UpdateFolderPermissions action and isn't audited separately.) +- SendAs +- SendOnBehalf +- SoftDelete +- Update +- UpdateCalendarDelegation (Exchange 2019 and Exchange Online only) +- UpdateComplianceTag (Exchange Online only) +- UpdateFolderPermissions (Exchange 2019 and Exchange Online only) +- UpdateInboxRules (Exchange 2019 and Exchange Online only) + +You can enter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowDetails +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. + +You can't use this switch with the Mailboxes parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: ExDateTime +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Search-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md similarity index 83% rename from exchange/exchange-ps/exchange/mail-flow/Search-MessageTrackingReport.md rename to exchange/exchange-ps/exchange/Search-MessageTrackingReport.md index 4124b04ffb..b56afd8580 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Search-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md @@ -1,27 +1,31 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Search-MessageTrackingReport ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. -Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see Get-MessageTrackingReport. The message tracking report cmdlets are used by the delivery reports feature. +Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### SearchAsSender ``` -Search-MessageTrackingReport [-Identity] -Sender [-BypassDelegateChecking] +Search-MessageTrackingReport [-Identity] -Sender + [-BypassDelegateChecking] [-Confirm] [-DomainController ] [-DoNotResolve] @@ -29,13 +33,15 @@ Search-MessageTrackingReport [-Identity] -Sender ] [-ResultSize ] [-Subject ] - [-TraceLevel ] - [-WhatIf] [] + [-TraceLevel ] + [-WhatIf] + [] ``` ### SearchAsRecipient ``` -Search-MessageTrackingReport [-Identity] [-Recipients ] +Search-MessageTrackingReport [-Identity] + [-Recipients ] [-BypassDelegateChecking] [-Confirm] [-DomainController ] @@ -44,24 +50,25 @@ Search-MessageTrackingReport [-Identity] [-Recipients ] [-ResultSize ] [-Subject ] - [-TraceLevel ] - [-WhatIf] [] + [-TraceLevel ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com" ``` This example searches the message tracking report for messages sent from one user to another. This example returns the message tracking report for a message that David Jones sent to Wendy Richardson. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Search-MessageTrackingReport -Identity "Cigdem Akin" -Sender "joe@contoso.com" -BypassDelegateChecking -DoNotResolve ``` @@ -72,30 +79,17 @@ This example returns the message tracking reports that the Help desk can analyze ## PARAMETERS ### -Identity -The Identity parameter scopes the search to the specified mailbox. You can use any value that uniquely identifies the mailbox. - -For example: +The Identity parameter scopes the search to the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) When you use this parameter without the Sender parameter, the specified mailbox is the message sender that's used in the search. You can specify the recipients by using the Recipients parameter. @@ -107,6 +101,7 @@ 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 Default value: None @@ -124,6 +119,7 @@ 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 Default value: None @@ -141,6 +137,7 @@ 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 @@ -151,8 +148,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -160,6 +156,7 @@ 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 Default value: None @@ -177,6 +174,7 @@ 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 @@ -194,6 +192,7 @@ 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 @@ -209,6 +208,7 @@ 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 Default value: None @@ -217,13 +217,14 @@ 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. This may include angle brackets. +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -241,6 +242,7 @@ 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 Default value: None @@ -256,6 +258,7 @@ 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 Default value: None @@ -271,6 +274,7 @@ 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 Default value: None @@ -282,18 +286,17 @@ Accept wildcard characters: False 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. - - Medium: In addition to all the data returned for the Low setting, the actual message tracking search results are also returned. - - High: Full diagnostic data is returned. You only need to use this parameter for troubleshooting message tracking issues. ```yaml -Type: Low | Medium | High +Type: TraceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -309,6 +312,7 @@ 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 Default value: None @@ -317,20 +321,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c7f17296-5489-4e93-ae15-743ba4644efd.aspx) diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md new file mode 100644 index 0000000000..9043d4d2b9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md @@ -0,0 +1,395 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Search-UnifiedAuditLog + +## 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, OneDrive, Microsoft Entra ID, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. + +**Note**: By default, this cmdlet returns a subset of results containing up to 100 records. Use SessionCommand parameter with the ReturnLargeSet value to exhaustively search up to 50,000 results. The SessionCommand parameter causes the cmdlet to return unsorted data. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Search-UnifiedAuditLog -EndDate -StartDate + [-Formatted] + [-FreeText ] + [-HighCompleteness] + [-IPAddresses ] + [-LongerRetentionEnabled ] + [-ObjectIds ] + [-Operations ] + [-RecordType ] + [-ResultSize ] + [-SessionCommand ] + [-SessionId ] + [-SiteIds ] + [-UserIds ] + [] +``` + +## DESCRIPTION +The Search-UnifiedAuditLog cmdlet presents pages of data based on repeated iterations of the same command. Use SessionId and SessionCommand to repeatedly run the cmdlet until you get zero returns, or hit the maximum number of results based on the session command. To gauge progress, look at the ResultIndex (hits in the current iteration) and ResultCount (hits for all iterations) properties of the data returned by the cmdlet. + +The Search-UnifiedAuditLog cmdlet is available in Exchange Online PowerShell. You can also view events from the unified auditing log by using the Microsoft Purview compliance portal. For more information, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). + +If you want to programmatically download data from the Microsoft 365 audit log, we recommend that you use the Microsoft 365 Management Activity API instead of using the Search-UnifiedAuditLog cmdlet in a PowerShell script. The Microsoft 365 Management Activity API is a REST web service that you can use to develop operations, security, and compliance monitoring solutions for your organization. For more information, see [Management Activity API reference](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-reference). + +This cmdlet is available in Office 365 operated by 21Vianet, but it won'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). + +## EXAMPLES + +### Example 1 +```powershell +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/2/2023 -SessionCommand ReturnLargeSet +``` + +This example searches the unified audit log for all events from May 1, 2023 12:00AM to May 2, 2023 12:00AM. + +**Note**: If you don't include a timestamp in the value for the StartDate or EndDate parameters, the default timestamp 12:00 AM (midnight) is used. + +### Example 2 +```powershell +Search-UnifiedAuditLog -StartDate "6/1/2023 8:00 AM" -EndDate "6/1/2023 6:00 PM" -RecordType ExchangeAdmin -SessionCommand ReturnLargeSet +``` + +This example searches the unified audit log for all Exchange admin events from 8:00 AM to 6:00 PM on June 1, 2023. + +**Note** If you use the same date for the StartDate and EndDate parameters, you need to include a timestamp; otherwise, no results will be returned because the date and time for the start and end dates will be the same. + +### Example 3 +```powershell +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/8/2023 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnLargeSet +``` + +This example searches the unified audit log for all events from May 1, 2023 to May 8, 2023. If you don't include a time stamp in the StartDate or EndDate parameters, The data is returned in pages as the command is rerun sequentially while using the same SessionId value. + +**Note**: Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. Otherwise, the output is limited to 10,000 results. + +### Example 4 +```powershell +Search-UnifiedAuditLog -StartDate 5/1/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 from May 1, 2023 to May 8, 2023. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. + +### Example 5 +```powershell +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/8/2023 -ObjectIDs "https://alpinehouse.sharepoint.com/sites/contoso/Departments/SM/International/Shared%20Documents/Sales%20Invoice%20-%20International.docx" -SessionCommand ReturnLargeSet +``` + +This example searches the unified audit log from May 1, 2023 to May 8, 2023 for all events relating to a specific Word document identified by its ObjectIDs value. + +## PARAMETERS + +### -EndDate +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: + +- Specify the date/time value in UTC: For example, `"2018-05-06 14:30:00z"`. +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2018 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +If you don't include a timestamp in the value for this parameter, the default timestamp is 12:00 AM (midnight) on the specified date. + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +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: + +- Specify the date/time value in UTC: For example, `"2018-05-06 14:30:00z"`. +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2018 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +If you don't include a timestamp in the value for this parameter, the default timestamp is 12:00 AM (midnight) on the specified date. + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Formatted +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FreeText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighCompleteness +**Note**: This parameter is currently in Preview, isn't available in all organizations, and is subject to change. + +The HighCompleteness switch specifies completeness instead performance in the results. You don't need to specify a value with this switch. + +When you use this switch, the query returns more complete search results but might take significantly longer to run. If you don't use this switch, the query runs faster but might have missing search results. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddresses +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LongerRetentionEnabled +{{ Fill LongerRetentionEnabled Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectIds +The ObjectIds parameter filters the log entries by object ID. The object ID is the target object that was acted upon, and depends on the RecordType and Operations values of the event. + +For example, for SharePoint operations, the object ID is the URL path to a file, folder, or site. To search logs in a site, add a wildcard (\*) in front of the site URL (for example, `"https://contoso.sharepoint.com/sites/test/*"`). + +For Microsoft Entra operations, the object ID is the account name or GUID value of the account. + +The ObjectId value appears in the AuditData (also known as Details) property of the event. + +You 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: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operations +The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/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"`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. The default value is 100, maximum is 5,000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionCommand +The SessionCommand parameter specifies how much information is returned and how it's organized. This parameter is required if you want to retrieve more than the default limit of 100 results. Valid values are: + +- ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. This is the recommended value if an ordered result is not required and has been optimized for search latency. +- ReturnNextPreviewPage: This value causes the cmdlet to return data sorted on date. The maximum number of records returned through use of either paging or the ResultSize parameter is 5,000 records. + +**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. + +```yaml +Type: UnifiedAuditSessionCommand +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteIds +The SiteIds parameter filters the log entries by the SharePoint SiteId (GUID). You can enter multiple values separated by commas: `Value1, Value2,...ValueN`. + +To obtain the SiteId for a SharePoint site, append `/_api/site/id` to the URL of the site collection you want to specify. For example, change the URL `https://contoso.sharepoint.com/sites/hr-project` to `https://contoso.sharepoint.com/sites/hr-project/_api/site/id`. An XML payload is returned and the SiteId for the site collection is displayed in the Edm.Guid property; for example: `14ab81b6-f23d-476a-8cac-ad5dbd2910f7`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +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"`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md new file mode 100644 index 0000000000..dd6524d3fd --- /dev/null +++ b/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md @@ -0,0 +1,158 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Send-TextMessagingVerificationCode cmdlet to send a text messaging verification as part of configuring text message notifications on the mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Send-TextMessagingVerificationCode [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## 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). + +This cmdlet returns an error if the user requests a verification code more than three times within a 24-hour period. + +## EXAMPLES + +### Example 1 +```powershell +Send-TextMessagingVerificationCode -Identity "TonySmith" +``` + +This example sends the text messaging verification code to Tony Smith's mobile phone. + +### Example 2 +```powershell +Send-TextMessagingVerificationCode -Identity "TonySmith" -Confirm $true +``` + +This example sends the text messaging verification code to Tony Smith's mobile phone after confirmation is given. + +### Example 3 +```powershell +Send-TextMessagingVerificationCode -Identity "tony@contoso.com" +``` + +This example sends the text messaging verification code to Tony Smith's mobile phone. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/active-directory/Set-ADServerSettings.md b/exchange/exchange-ps/exchange/Set-ADServerSettings.md similarity index 80% rename from exchange/exchange-ps/exchange/active-directory/Set-ADServerSettings.md rename to exchange/exchange-ps/exchange/Set-ADServerSettings.md index b1973804ba..fbc8c31fba 100644 --- a/exchange/exchange-ps/exchange/active-directory/Set-ADServerSettings.md +++ b/exchange/exchange-ps/exchange/Set-ADServerSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AdServerSettings @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AdServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -21,37 +24,46 @@ For information about the parameter sets in the Syntax section below, see Exchan ``` Set-AdServerSettings -RunspaceServerSettings [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### FullParams ``` -Set-AdServerSettings [-ConfigurationDomainController ] [-PreferredGlobalCatalog ] [-RecipientViewRoot ] [-SetPreferredDomainControllers ] [-ViewEntireForest <$true | $false>] +Set-AdServerSettings [-ConfigurationDomainController ] + [-PreferredGlobalCatalog ] + [-RecipientViewRoot ] + [-SetPreferredDomainControllers ] + [-ViewEntireForest ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ### SingleDC ``` -Set-AdServerSettings [[-PreferredServer] ] [-RecipientViewRoot ] [-ViewEntireForest <$true | $false>] +Set-AdServerSettings [[-PreferredServer] ] + [-RecipientViewRoot ] + [-ViewEntireForest ] [-Confirm] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell 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 -------------------------- -``` +### Example 2 +```powershell Set-AdServerSettings -ViewEntireForest $true -PreferredGlobalCatalog gc1.contoso.com ``` @@ -67,6 +79,7 @@ Type: Fqdn Parameter Sets: SingleDC Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -82,6 +95,7 @@ Type: RunspaceServerSettingsPresentationObject Parameter Sets: Instance Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -97,6 +111,7 @@ Type: Fqdn Parameter Sets: FullParams Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -107,8 +122,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -116,6 +130,7 @@ 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 @@ -131,6 +146,7 @@ Type: Fqdn Parameter Sets: FullParams Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -139,13 +155,14 @@ Accept wildcard characters: False ``` ### -RecipientViewRoot -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 \/\. +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 Default value: None @@ -161,6 +178,7 @@ Type: MultiValuedProperty Parameter Sets: FullParams Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -174,10 +192,11 @@ The ViewEntireForest parameter specifies whether all the objects in the forest a 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: SingleDC, FullParams Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -193,6 +212,7 @@ 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 @@ -201,20 +221,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/741b74a2-65ff-476f-aabf-1af42a3a2d6a.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Set-ADSite.md b/exchange/exchange-ps/exchange/Set-ADSite.md similarity index 79% rename from exchange/exchange-ps/exchange/active-directory/Set-ADSite.md rename to exchange/exchange-ps/exchange/Set-ADSite.md index bdfb70b181..b2769997e3 100644 --- a/exchange/exchange-ps/exchange/active-directory/Set-ADSite.md +++ b/exchange/exchange-ps/exchange/Set-ADSite.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AdSite @@ -13,23 +16,28 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AdSite cmdlet to configure the Exchange settings of Active Directory sites. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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] [-Confirm] [-DomainController ] - [-HubSiteEnabled <$true | $false>] [-PartnerId ] - [-WhatIf] [-InboundMailEnabled <$true | $false>] [] +Set-AdSite [-Identity] + [-Confirm] + [-DomainController ] + [-HubSiteEnabled ] + [-InboundMailEnabled ] + [-PartnerId ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-AdSite Default-First-Site-Name -HubSiteEnabled $true ``` @@ -45,6 +53,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -55,8 +64,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -64,6 +72,7 @@ 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 @@ -79,6 +88,7 @@ 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 @@ -90,10 +100,11 @@ Accept wildcard characters: False The HubSiteEnabled parameter specifies whether this site acts as a hub site. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -101,14 +112,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerId -This parameter is reserved for internal Microsoft use. +### -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. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -116,14 +130,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -PartnerId +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -131,16 +146,15 @@ Accept pipeline input: False 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. +### -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: $true | $false +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -149,20 +163,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c9bb1fab-4d0f-43e3-ad4a-36643baa6553.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md new file mode 100644 index 0000000000..cb0c15498e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule +applicable: Exchange Online +title: Set-ATPBuiltInProtectionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ATPBuiltInProtectionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ATPBuiltInProtectionRule cmdlet to modify the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ATPBuiltInProtectionRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ATPBuiltInProtectionRule -Identity "ATP Built-In Protection Rule" -ExceptIfSentToMemberOf "Test Group1","Test Group2" +``` + +This example provides exceptions to the Built-in protection preset security policy for members of the specified groups. + +### Example 2 +```powershell +Set-ATPBuiltInProtectionRule -Identity "ATP Built-In Protection Rule" -ExceptIfRecipientDomainIs (Get-AcceptedDomain).Name +``` + +This example provides exceptions to the Built-in protection preset security policy for recipients in all accepted domains. To see all of your accepted domains, run the following command: `Get-AcceptedDomain | Format-List Name,DomainName`. + +### Example 3 +```powershell +Set-ATPBuiltInProtectionRule -Identity "ATP Built-In Protection Rule" -ExceptIfRecipientDomainIs $null -ExceptIfSentTo $null -ExceptIfSentToMemberOf $null +``` + +This example remove all exceptions from the Built-in protection preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +The name of the only rule is ATP Built-In Protection Rule. + +```yaml +Type: DehydrateableRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +Dynamic distribution groups are not supported. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..a2820af421 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule +applicable: Exchange Online +title: Set-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ATPProtectionPolicyRule cmdlet to modify rules that are associated with Microsoft Defender for Office 365 protections in preset security policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ATPProtectionPolicyRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" -ExceptIfSentToMemberOf "Test Group1","Test Group2" +``` + +This example provides exceptions to Defender for Office 365 protections in the Standard preset security policy for members of the specified groups. + +### Example 2 +```powershell +Set-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" -SentTo $null -ExceptIfSentTo $null -SentToMemberOf $null -ExceptIfSentToMemberOf $null -RecipientDomainIs $null -ExceptIfRecipientDomainIs $null +``` + +This example removes all conditions and exceptions from the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +You must use the default value for the rule. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md new file mode 100644 index 0000000000..d8069d6995 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md @@ -0,0 +1,384 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-AcceptedDomain cmdlet to modify existing accepted domains in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AcceptedDomain [-Identity] + [-AddressBookEnabled ] + [-CanHaveCloudCache ] + [-Confirm] + [-DomainController ] + [-DomainType ] + [-EnableNego2Authentication ] + [-MakeDefault ] + [-MatchSubDomains ] + [-Name ] + [-OutboundOnly ] + [-PendingCompletion ] + [-PendingRemoval ] + [-SendingFromDomainDisabled ] + [-SendingToDomainDisabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AcceptedDomain -Identity Contoso -MakeDefault $true +``` + +This example makes the accepted domain Contoso the default accepted domain. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AddressBookEnabled +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: + +- $true for authoritative domains. +- $false for internal relay domains. +- $false for external relay domains. + +```yaml +Type: Boolean +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 +``` + +### -CanHaveCloudCache +This parameter is available only in the cloud-based service. + +{{ Fill CanHaveCloudCache Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainType +The DomainType parameter specifies the accepted domain type. Valid values are: + +- Authoritative: This is the default value. Your organization is completely responsible for delivering email to recipients in the domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients. +- InternalRelay: This is a type of non-authoritative domain. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external email system that's under your control. The external email system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the domain as internal messages. +- ExternalRelay: This is a type of non-authoritative domain that's available only in on-premises Exchange organizations. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external email system that's completely outside of your control. The external email system is responsible for generating NDRs for unresolved recipients. + +**Note**: For the value InternalRelay or ExternalRelay, you typically use mail users or mail contacts to relay the messages to the external email system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNego2Authentication +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +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. +- $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. + +If you don't use non-SMTP email addresses in your organization, you don't need to worry about the value of this 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchSubDomains +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 ("). + +```yaml +Type: String +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 +``` + +### -OutboundOnly +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PendingCompletion +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PendingRemoval +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendingFromDomainDisabled +This parameter is available only in the cloud-based service. + +The SendingFromDomainDisabled parameter specifies whether to allow email to be sent from addresses in the domain. Valid values are: + +- $true: Email can't be sent from addresses in the domain. +- $false: Email can be sent from addresses in the domain. + +A common scenario is addresses in a legacy domain that still need to receive email, but shouldn't be used to send email. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendingToDomainDisabled +This parameter is available only in the cloud-based service. + +The SendingToDomainDisabled specifies whether to prevent delivery of messages sent to recipients in the domain. Valid values are: + +- $true: Email sent to recipients in the domain is blocked. +- $false: Email sent to recipients in the domain isn't blocked. + +A common scenario is to prevent email delivery to recipients in your unused Micorost Online Email Routing Address (MOERA) domain (for example, contoso.onmicrosoft.com). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md new file mode 100644 index 0000000000..a8ff53f2c3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md @@ -0,0 +1,128 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AccessToCustomerDataRequest + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-AccessToCustomerDataRequest cmdlet to approve, deny, or cancel Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. + +**Note**: Customer Lockbox is included in Microsoft 365 E5, or you can buy a separate Customer Lockbox subscription with any Microsoft 365 Enterprise plan. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AccessToCustomerDataRequest -ApprovalDecision -RequestId + [-Comment ] + [-ServiceName ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AccessToCustomerDataRequest -ApprovalDecision Approve -RequestId EXSR123456 -Comment "Troubleshoot issues in Rick Hofer mailbox" +``` + +This example approves the customer lockbox request EXSR123456 with a comment. + +## PARAMETERS + +### -ApprovalDecision +The ApprovalDecision parameter specifies the approval decision for the customer lockbox request. Valid values are: + +- Approve +- Deny +- Cancel + +```yaml +Type: AccessToCustomerDataApproverDecision +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The ServiceName parameter specifies the related service. Valid values are: + +- EOP +- Exchange +- SharePoint +- Teams + +```yaml +Type: Microsoft.Exchange.Management.AccessToCustomerDataApproval.AccessToCustomerDataRequestServiceName +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md similarity index 78% rename from exchange/exchange-ps/exchange/devices/Set-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md index a3a7a36080..3649c7062d 100644 --- a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ActiveSyncDeviceAccessRule @@ -13,32 +16,35 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ActiveSyncDeviceAccessRule cmdlet to set the level of access for the rule. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncDeviceAccessRule [-Identity] - [-AccessLevel ] [-Confirm] [-DomainController ] [-WhatIf] + [-AccessLevel ] + [-Confirm] + [-DomainController ] + [-WhatIf] [] ``` ## DESCRIPTION Your rule can define multiple 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ActiveSyncDeviceAccessRule 'ContosoPhone(DeviceModel)' -AccessLevel Quarantine ``` This example changes the access level granted to phones covered by the rule ContosoPhone (DeviceModel) to Quarantine. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-ActiveSyncDeviceAccessRule | Where {$_.AccessLevel -eq 'Allow'} | Set-ActiveSyncDeviceAccessRule -AccessLevel Quarantine ``` @@ -54,6 +60,7 @@ 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 Default value: None @@ -65,10 +72,11 @@ Accept wildcard characters: False The AccessLevel parameter specifies whether the devices are allowed, blocked or quarantined. ```yaml -Type: Allow | Block | Quarantine +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 Default value: None @@ -79,8 +87,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -88,6 +95,7 @@ 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 Default value: None @@ -105,6 +113,7 @@ 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 @@ -120,6 +129,7 @@ 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 Default value: None @@ -128,20 +138,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/42db8d5c-6010-431c-97df-df91c982a511.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md similarity index 82% rename from exchange/exchange-ps/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md rename to exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md index d5626a629d..ba3b345abe 100644 --- a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ActiveSyncDeviceAutoblockThreshold @@ -13,33 +16,38 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ActiveSyncDeviceAutoblockThreshold cmdlet to change settings for autoblocking mobile devices. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncDeviceAutoblockThreshold [-Identity] - [-AdminEmailInsert ] [-BehaviorTypeIncidenceDuration ] - [-BehaviorTypeIncidenceLimit ] [-Confirm] [-DeviceBlockDuration ] - [-DomainController ] [-WhatIf] [] + [-AdminEmailInsert ] + [-BehaviorTypeIncidenceDuration ] + [-BehaviorTypeIncidenceLimit ] + [-Confirm] + [-DeviceBlockDuration ] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION Microsoft Exchange and Microsoft Exchange ActiveSync can block Exchange ActiveSync mobile devices if these devices display any of a defined list of behaviors that can potentially cause issues with the server. The Set-ActiveSyncDeviceAutoblockThreshold cmdlet can modify an existing autoblock threshold rule and change a variety of settings including the duration of blocking. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ActiveSyncDeviceAutoblockThreshold -Identity "UserAgentChanges" BehaviorTypeIncidenceLimit 2 -BehaviorTypeIncidenceDuration 1440 -DeviceBlockDuration 1440 -AdminEmailInsert "Your device has been 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 -------------------------- -``` +### Example 2 +```powershell Set-ActiveSyncDeviceAutoblockThreshold -Identity "RecentCommands" BehaviorTypeIncidenceLimit 5 -BehaviorTypeIncidenceDuration 720 -DeviceBlockDuration 720 -AdminEmailInsert "Your device has been blocked. "] ``` @@ -55,6 +63,7 @@ Type: ActiveSyncDeviceAutoblockThresholdIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -70,6 +79,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -85,6 +95,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -100,6 +111,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,8 +122,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -119,6 +130,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -134,6 +146,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -149,6 +162,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,6 +178,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -172,20 +187,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2710ccb0-9e18-4906-acd1-e97be05d57cd.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/devices/Set-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md index c0a807b095..6a74c4ad63 100644 --- a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ActiveSyncMailboxPolicy @@ -13,45 +16,72 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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. -Note: In Exchange 2013 or later, use the Set-MobileMailboxPolicy cmdlet instead. If you have scripts that use Set-ActiveSyncMailboxPolicy, update them to use Set-MobileMailboxPolicy. +**Note**: In Exchange 2013 or later, use the Set-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Set-ActiveSyncMailboxPolicy, update them to use Set-MobileDeviceMailboxPolicy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncMailboxPolicy [-Identity] - [-AllowBluetooth ] [-AllowBrowser <$true | $false>] - [-AllowCamera <$true | $false>] [-AllowConsumerEmail <$true | $false>] [-AllowDesktopSync <$true | $false>] - [-AllowExternalDeviceManagement <$true | $false>] [-AllowHTMLEmail <$true | $false>] - [-AllowInternetSharing <$true | $false>] [-AllowIrDA <$true | $false>] - [-AllowMobileOTAUpdate <$true | $false>] [-AllowNonProvisionableDevices <$true | $false>] - [-AllowPOPIMAPEmail <$true | $false>] [-AllowRemoteDesktop <$true | $false>] - [-AllowSimpleDevicePassword <$true | $false>] - [-AllowSMIMEEncryptionAlgorithmNegotiation ] - [-AllowSMIMESoftCerts <$true | $false>] [-AllowStorageCard <$true | $false>] - [-AllowTextMessaging <$true | $false>] [-AllowUnsignedApplications <$true | $false>] - [-AllowUnsignedInstallationPackages <$true | $false>] [-AllowWiFi <$true | $false>] - [-AlphanumericDevicePasswordRequired <$true | $false>] - [-ApprovedApplicationList ] [-AttachmentsEnabled <$true | $false>] [-Confirm] - [-DeviceEncryptionEnabled <$true | $false>] [-DevicePasswordEnabled <$true | $false>] - [-DevicePasswordExpiration ] [-DevicePasswordHistory ] - [-DevicePolicyRefreshInterval ] [-DomainController ] [-IrmEnabled <$true | $false>] - [-IsDefaultPolicy <$true | $false>] [-MaxAttachmentSize ] - [-MaxCalendarAgeFilter ] + [-AllowApplePushNotifications ] + [-AllowBluetooth ] + [-AllowBrowser ] + [-AllowCamera ] + [-AllowConsumerEmail ] + [-AllowDesktopSync ] + [-AllowExternalDeviceManagement ] + [-AllowHTMLEmail ] + [-AllowInternetSharing ] + [-AllowIrDA ] + [-AllowMobileOTAUpdate ] + [-AllowNonProvisionableDevices ] + [-AllowPOPIMAPEmail ] + [-AllowRemoteDesktop ] + [-AllowSimpleDevicePassword ] + [-AllowSMIMEEncryptionAlgorithmNegotiation ] + [-AllowSMIMESoftCerts ] + [-AllowStorageCard ] + [-AllowTextMessaging ] + [-AllowUnsignedApplications ] + [-AllowUnsignedInstallationPackages ] + [-AllowWiFi ] + [-AlphanumericDevicePasswordRequired ] + [-ApprovedApplicationList ] + [-AttachmentsEnabled ] + [-Confirm] + [-DeviceEncryptionEnabled ] + [-DevicePasswordEnabled ] + [-DevicePasswordExpiration ] + [-DevicePasswordHistory ] + [-DevicePolicyRefreshInterval ] + [-DomainController ] + [-IrmEnabled ] + [-IsDefault ] + [-IsDefaultPolicy ] + [-MaxAttachmentSize ] + [-MaxCalendarAgeFilter ] [-MaxDevicePasswordFailedAttempts ] - [-MaxEmailAgeFilter ] - [-MaxEmailBodyTruncationSize ] [-MaxEmailHTMLBodyTruncationSize ] - [-MaxInactivityTimeDeviceLock ] [-MinDevicePasswordComplexCharacters ] + [-MaxEmailAgeFilter ] + [-MaxEmailBodyTruncationSize ] + [-MaxEmailHTMLBodyTruncationSize ] + [-MaxInactivityTimeDeviceLock ] + [-MinDevicePasswordComplexCharacters ] [-MinDevicePasswordLength ] - [-Name ] [-PasswordRecoveryEnabled <$true | $false>] [-RequireDeviceEncryption <$true | $false>] - [-RequireEncryptedSMIMEMessages <$true | $false>] - [-RequireEncryptionSMIMEAlgorithm ] - [-RequireManualSyncWhenRoaming <$true | $false>] [-RequireSignedSMIMEAlgorithm ] - [-RequireSignedSMIMEMessages <$true | $false>] [-RequireStorageCardEncryption <$true | $false>] - [-UnapprovedInROMApplicationList ] [-UNCAccessEnabled <$true | $false>] [-WhatIf] - [-WSSAccessEnabled <$true | $false>] [-AllowApplePushNotifications <$true | $false>] - [-IsDefault <$true | $false>] [] + [-Name ] + [-PasswordRecoveryEnabled ] + [-RequireDeviceEncryption ] + [-RequireEncryptedSMIMEMessages ] + [-RequireEncryptionSMIMEAlgorithm ] + [-RequireManualSyncWhenRoaming ] + [-RequireSignedSMIMEAlgorithm ] + [-RequireSignedSMIMEMessages ] + [-RequireStorageCardEncryption ] + [-UnapprovedInROMApplicationList ] + [-UNCAccessEnabled ] + [-WhatIf] + [-WSSAccessEnabled ] + [] ``` ## DESCRIPTION @@ -59,26 +89,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ActiveSyncMailboxPolicy -Identity:SalesPolicy -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -AttachmentsEnabled:$true -MaxInactivityTimeDeviceLock:15:00 -IsDefault:$false ``` This example sets several policy settings for the Mobile Device mailbox policy SalesPolicy. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-ActiveSyncMailboxPolicy -Identity:Management -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -AllowCamera:$true -AllowWiFi:$false -AllowStorageCard:$true -AllowPOPIMAPEmail:$false ``` This example sets several policy settings for the Mobile Device mailbox policy Management. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-ActiveSyncMailboxPolicy -Identity:Default -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -MaxEmailAgeFilter:ThreeDays -AllowWiFi:$false -AllowStorageCard:$true -AllowPOPIMAPEmail:$false -IsDefault:$true -AllowTextMessaging:$true -Confirm:$true ``` @@ -94,6 +124,7 @@ 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 Default value: None @@ -101,14 +132,33 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AllowApplePushNotifications +This parameter is available only in the cloud-based service. + +The AllowApplePushNotifications parameter specifies whether push notifications are allowed to Apple mobile devices. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowBluetooth 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: Disable | HandsfreeOnly | Allow +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 Default value: None @@ -120,10 +170,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -135,10 +186,11 @@ Accept wildcard characters: False The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -150,10 +202,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -165,10 +218,11 @@ Accept wildcard characters: False The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -180,10 +234,11 @@ Accept wildcard characters: False The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile phone. ```yaml -Type: $true | $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 Default value: None @@ -195,10 +250,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -210,10 +266,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -225,10 +282,11 @@ Accept wildcard characters: False The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -240,10 +298,11 @@ Accept wildcard characters: False The AllowMobileOTAUpdate parameter specifies whether the Exchange ActiveSync mailbox policy can be sent to the mobile phone over a cellular data connection. ```yaml -Type: $true | $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 Default value: None @@ -255,10 +314,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -270,10 +330,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -285,10 +346,11 @@ Accept wildcard characters: False The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -300,10 +362,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -315,10 +378,11 @@ Accept wildcard characters: False 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: BlockNegotiation | OnlyStrongAlgorithmNegotiation | AllowAnyAlgorithmNegotiation +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 Default value: None @@ -330,10 +394,11 @@ Accept wildcard characters: False The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -345,10 +410,11 @@ Accept wildcard characters: False The AllowStorageCard parameter specifies whether the mobile phone can access information stored on a storage card. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -360,10 +426,11 @@ Accept wildcard characters: False The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile phone. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -375,10 +442,11 @@ Accept wildcard characters: False The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile phone. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -390,10 +458,11 @@ Accept wildcard characters: False The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile phone. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -405,10 +474,11 @@ Accept wildcard characters: False The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile phone. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -420,10 +490,11 @@ Accept wildcard characters: False The AlphanumericDevicePasswordRequired parameter specifies whether the password for the mobile phone must be alphanumeric. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -439,6 +510,7 @@ 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 Default value: None @@ -450,10 +522,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -464,8 +537,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -473,6 +545,7 @@ 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 Default value: None @@ -484,10 +557,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -499,10 +573,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -518,6 +593,7 @@ 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 Default value: None @@ -533,6 +609,7 @@ 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 Default value: None @@ -548,6 +625,7 @@ 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 Default value: None @@ -565,6 +643,7 @@ 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 @@ -576,10 +655,27 @@ Accept wildcard characters: False The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. ```yaml -Type: $true | $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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 Default value: None @@ -591,10 +687,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -610,6 +707,7 @@ 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 Default value: None @@ -621,22 +719,18 @@ Accept wildcard characters: False 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 - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth ```yaml -Type: All | TwoWeeks | OneMonth | ThreeMonths | SixMonths +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 Default value: None @@ -652,6 +746,7 @@ 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 Default value: None @@ -663,22 +758,18 @@ Accept wildcard characters: False 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 - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth ```yaml -Type: All | OneDay | ThreeDays | OneWeek | TwoWeeks | OneMonth +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 Default value: None @@ -694,6 +785,7 @@ 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 Default value: None @@ -709,6 +801,7 @@ 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 Default value: None @@ -724,6 +817,7 @@ 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 Default value: None @@ -739,6 +833,7 @@ 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 Default value: None @@ -754,6 +849,7 @@ 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 Default value: None @@ -769,6 +865,7 @@ 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 Default value: None @@ -780,10 +877,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -795,10 +893,11 @@ Accept wildcard characters: False The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -810,10 +909,11 @@ Accept wildcard characters: False The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -825,10 +925,11 @@ Accept wildcard characters: False The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. ```yaml -Type: TripleDES | DES | RC2128bit | RC264bit | RC240bit +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 Default value: None @@ -840,10 +941,11 @@ Accept wildcard characters: False The RequireManualSyncWhenRoaming parameter specifies whether the mobile phone must synchronize manually while roaming. The default value is $false. ```yaml -Type: $true | $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 Default value: None @@ -855,10 +957,11 @@ Accept wildcard characters: False The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. ```yaml -Type: SHA1 | MD5 +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 Default value: None @@ -870,10 +973,11 @@ Accept wildcard characters: False The RequireSignedSMIMEMessages parameter specifies whether the mobile phone must send signed S/MIME messages. ```yaml -Type: $true | $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 Default value: None @@ -885,10 +989,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -904,6 +1009,7 @@ 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 Default value: None @@ -915,10 +1021,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -934,6 +1041,7 @@ 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 Default value: None @@ -945,42 +1053,11 @@ Accept wildcard characters: False 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: $true | $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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowApplePushNotifications -This parameter is available only in the cloud-based service. - -The AllowApplePushNotifications parameter specifies whether push notifications are allowed to Apple mobile devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -IsDefault -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named Default value: None @@ -989,20 +1066,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/913c04bf-110d-465f-81c3-40887b44bf63.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md new file mode 100644 index 0000000000..78b5bcd932 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md @@ -0,0 +1,288 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-ActiveSyncOrganizationSettings cmdlet to set the Exchange ActiveSync settings for the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ActiveSyncOrganizationSettings [[-Identity] ] + [-AdminMailRecipients ] + [-AllowAccessForUnSupportedPlatform ] + [-AllowRMSSupportForUnenlightenedApps ] + [-Confirm] + [-DefaultAccessLevel ] + [-DomainController ] + [-EnableMobileMailboxPolicyWhenCAInplace ] + [-OtaNotificationMailInsert ] + [-TenantAdminPreference ] + [-UserMailInsert ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ActiveSyncOrganizationSettings -DefaultAccessLevel Quarantine -AdminMailRecipients will@contoso.com,roger@contoso.com +``` + +This example sets the default access level to quarantine and sets two administrative email addresses. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AdminMailRecipients +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -AllowAccessForUnSupportedPlatform +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRMSSupportForUnenlightenedApps +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) + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAccessLevel +The DefaultAccessLevel parameter specifies the access level for new and existing device partnerships. Valid values are: + +- Allow (This is the default value) +- Block +- Quarantine + +If you change this value from Allow to Block or Quarantine, all existing connected devices are immediately affected, unless the devices are subject to device access rules or individual allow or block list entries. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMobileMailboxPolicyWhenCAInplace +This parameter is available only in the cloud-based service. + +{{ Fill EnableMobileMailboxPolicyWhenCAInplace Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OtaNotificationMailInsert +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 ("). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantAdminPreference +This parameter is available only in the cloud-based service. + +{{ Fill TenantAdminPreference Description }} + +```yaml +Type: TenantAdminPreference +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMailInsert +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 ("). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access-servers/Set-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/client-access-servers/Set-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md index 9bc37f82d4..e46e295975 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ActiveSyncVirtualDirectory @@ -11,52 +14,67 @@ monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-ActiveSyncVirtualDirectory cmdlet to modifyexisting Microsoft Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Exchange servers. +Use the Set-ActiveSyncVirtualDirectory cmdlet to modify existing Microsoft Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ActiveSyncVirtualDirectory [-Identity] [-ActiveSyncServer ] - [-BadItemReportingEnabled <$true | $false>] [-BasicAuthEnabled <$true | $false>] - [-ClientCertAuth ] [-CompressionEnabled <$true | $false>] [-Confirm] - [-DomainController ] [-ExtendedProtectionFlags ] - [-ExtendedProtectionSPNList ] [-ExtendedProtectionTokenChecking ] - [-ExternalAuthenticationMethods ] [-ExternalUrl ] - [-InstallIsapiFilter <$true | $false>] [-InternalAuthenticationMethods ] - [-InternalUrl ] [-MobileClientCertificateAuthorityURL ] - [-MobileClientCertificateProvisioningEnabled <$true | $false>] [-MobileClientCertTemplateName ] - [-Name ] [-RemoteDocumentsActionForUnknownServers ] - [-RemoteDocumentsAllowedServers ] [-RemoteDocumentsBlockedServers ] - [-RemoteDocumentsInternalDomainSuffixList ] [-SendWatsonReport <$true | $false>] - [-WhatIf] [-WindowsAuthEnabled <$true | $false>] [] +Set-ActiveSyncVirtualDirectory [-Identity] + [-ActiveSyncServer ] + [-BadItemReportingEnabled ] + [-BasicAuthEnabled ] + [-ClientCertAuth ] + [-CompressionEnabled ] + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalAuthenticationMethods ] + [-ExternalUrl ] + [-InstallIsapiFilter ] + [-InternalAuthenticationMethods ] + [-InternalUrl ] + [-MobileClientCertificateAuthorityURL ] + [-MobileClientCertificateProvisioningEnabled ] + [-MobileClientCertTemplateName ] + [-Name ] + [-RemoteDocumentsActionForUnknownServers ] + [-RemoteDocumentsAllowedServers ] + [-RemoteDocumentsBlockedServers ] + [-RemoteDocumentsInternalDomainSuffixList ] + [-SendWatsonReport ] + [-WhatIf] + [-WindowsAuthEnabled ] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync" -BasicAuthEnabled $false +### Example 1 +```powershell +Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync (Default Web Site)" -BasicAuthEnabled $false ``` This example disables Basic authentication on the default Exchange ActiveSync virtual directory on the server Contoso. -### -------------------------- Example 2 -------------------------- -``` -Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync" -BadItemReportingEnabled $true -SendWatsonReport:$true +### Example 2 +```powershell +Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync (Default Web Site)" -BadItemReportingEnabled $true -SendWatsonReport:$true ``` This example enables bad item reporting and turns on the option to send Watson reports for errors on the server Contoso. -### -------------------------- Example 3 -------------------------- -``` -Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync" -ExternalUrl "http://contoso.com/mail" +### Example 3 +```powershell +Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync (Default Web Site)" -ExternalUrl "https://contoso.com/mail" ``` This example configures the external URL on the default Exchange ActiveSync virtual directory on the server Contoso. @@ -64,23 +82,20 @@ This example configures the external URL on the default Exchange ActiveSync virt ## PARAMETERS ### -Identity -The Identity parameter specifies the Exchange ActiveSync virtual directory that you want to modify. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \\\Name +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -96,6 +111,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -107,10 +123,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -122,14 +139,14 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,10 +158,11 @@ Accept wildcard characters: False The ClientCertAuth parameter specifies the status of client certificate authentication. By default, client certificate authentication is disabled. The default setting is Ignore. ```yaml -Type: Ignore | Accepted | Required +Type: ClientCertAuthTypes Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -156,10 +174,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,8 +189,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -179,6 +197,7 @@ 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 @@ -194,6 +213,7 @@ 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 @@ -205,13 +225,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -219,6 +235,7 @@ 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 @@ -230,14 +247,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -249,20 +266,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -274,33 +288,19 @@ Accept wildcard characters: False 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 - - Basic - - Certificate - - Digest - - Fba - - Kerberos - - LiveIdBasic - - LiveIdFba - - LiveIdNegotiate - - NegoEx - - Negotiate - - Ntlm - - OAuth - - WindowsIntegrated - - WSSecurity You can specify multiple values separated by commas. @@ -308,7 +308,6 @@ You can specify multiple values separated by commas. Although you can specify any of these values, whether or not the authentication method actually works for external connections depends on other factors. For example: - Is the authentication method available on the virtual directory? - - Is the authentication method available, but disabled on the virtual directory? ```yaml @@ -316,6 +315,7 @@ 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 @@ -331,6 +331,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -342,10 +343,11 @@ Accept wildcard characters: False The InstallIsapiFilter parameter specifies whether the Internet Server API (ISAPI) filter is installed. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -361,6 +363,7 @@ 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 @@ -376,6 +379,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -391,6 +395,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -402,10 +407,11 @@ Accept wildcard characters: False The MobileClientCertificateProvisioningEnabled parameter specifies whether the Autodiscover service returns the Certificate Services server URL in the XML file. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -421,6 +427,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -436,6 +443,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -447,10 +455,11 @@ Accept wildcard characters: False 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: Allow | Block +Type: RemoteDocumentsActions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -466,6 +475,7 @@ 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 @@ -481,6 +491,7 @@ 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 @@ -496,6 +507,7 @@ 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 @@ -507,10 +519,11 @@ Accept wildcard characters: False The SendWatsonReport parameter specifies whether a Watson report is sent for errors and events. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -526,6 +539,7 @@ 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 @@ -537,10 +551,11 @@ Accept wildcard characters: False The WindowsAuthEnabled parameter specifies whether Integrated Windows authentication is enabled. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -549,20 +564,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/899fa80c-41e9-4fc0-b28e-5ca2f55e6369.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Set-AdSiteLink.md b/exchange/exchange-ps/exchange/Set-AdSiteLink.md similarity index 82% rename from exchange/exchange-ps/exchange/active-directory/Set-AdSiteLink.md rename to exchange/exchange-ps/exchange/Set-AdSiteLink.md index 9c4a7e7831..0bdcffba25 100644 --- a/exchange/exchange-ps/exchange/active-directory/Set-AdSiteLink.md +++ b/exchange/exchange-ps/exchange/Set-AdSiteLink.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AdSiteLink @@ -13,24 +16,30 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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] [-Confirm] [-DomainController ] - [-ExchangeCost ] [-MaxMessageSize ] [-Name ] [-WhatIf] [] +Set-AdSiteLink [-Identity] + [-Confirm] + [-DomainController ] + [-ExchangeCost ] + [-MaxMessageSize ] + [-Name ] + [-WhatIf] + [] ``` ## DESCRIPTION By default, Microsoft Exchange determines the least cost routing path by using the cost assigned to the Active Directory IP site link. You can use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute used instead of the Active Directory-assigned cost to determine the least cost routing path. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-AdSiteLink DEFAULT_IP_SITE_LINK -ExchangeCost 25 -MaxMessageSize 10MB ``` @@ -46,6 +55,7 @@ Type: AdSiteLinkIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -56,8 +66,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -65,6 +74,7 @@ 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 @@ -82,6 +92,7 @@ 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 @@ -97,6 +108,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,13 +122,9 @@ The MaxMessageSize parameter specifies the maximum size of a message that can pa When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -128,6 +136,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,6 +152,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -158,6 +168,7 @@ 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 @@ -166,20 +177,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8c1853fd-e5d8-47d9-b603-33a6c7cec87c.aspx) diff --git a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md new file mode 100644 index 0000000000..6560f5f4ab --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-adaptivescope +applicable: Security & Compliance +title: Set-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-AdaptiveScope cmdlet to modify adaptive scopes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Set-AdaptiveScope [-Identity] -FilterConditions + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +### AdaptiveScopeRawQuery +``` +Set-AdaptiveScope [-Identity] -RawQuery + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +### AdministrativeUnit +``` +Set-AdaptiveScope [-Identity] -AdministrativeUnit + [-Comment ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AdaptiveScope -Identity "Project X" -FilterConditions @{"Conditions" = @{"Value" = "Redmond"; "Operator" = "Equals"; "Name" = "City"}; "Conjunction" = "And"} +``` + +This example modifies the filter in exiting adaptive scope named Project X. The new filter looks for all users in the city of Redmond. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the adaptive scope that you want to modify. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdministrativeUnit +{{ Fill AdministrativeUnit Description }} + +```yaml +Type: Guid +Parameter Sets: AdministrativeUnit +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Guid +Parameter Sets: Default, AdaptiveScopeRawQuery +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterConditions +The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: + +- User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` +- Site: Indexed custom properties. For example, for the condition "'Refinable string 0' equals 'Human Resources', use the following syntax: `@{"Conditions" = @{"Value" = "Human Resources"; "Operator" = "Equals"; "Name" = "RefinableString00"}; "Conjunction" = "And"}` + +You can't use this parameter with the RawQuery parameter. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawQuery +The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. + +You can't use this parameter with the FilterConditions parameter. + +```yaml +Type: String +Parameter Sets: AdaptiveScopeRawQuery +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md new file mode 100644 index 0000000000..6438ed69a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md @@ -0,0 +1,228 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-AddressBookPolicy cmdlet to change the settings of an address book policy. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AddressBookPolicy [-Identity] + [-AddressLists ] + [-Confirm] + [-DomainController ] + [-GlobalAddressList ] + [-Name ] + [-OfflineAddressBook ] + [-RoomList ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AddressBookPolicy -Identity "All Fabrikam ABP" -OfflineAddressBook \Fabrikam-OAB-2 -GlobalAddressList "\All Fabrikam GAL" +``` + +This example changes the OAB that the address book policy All Fabrikam ABP uses to Fabrikam-OAB-2. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomList +The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them. + +- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchange/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. +- When using experiences that aren't location specific (for example, the To or Cc fields of a calendar event), the address lists specified by the AddressLists parameter in this address book policy are applied. The address list specified by this parameter isn't used. + +A valid value for this parameter is one address list. You can use any value that uniquely identifies the address list. For example: + +- Name +- Distinguished name (DN) +- GUID + +> [!NOTE] +> There's no automatic association between this parameter and [room list distribution groups](https://learn.microsoft.com/exchange/recipients/room-mailboxes#create-a-room-list), which also use a parameter named RoomList in the New-DistributionGroup and Set-DistributionGroup cmdlets. You still need to create room list distribution groups and assign resources as group members. Location experiences are filtered to show only rooms included in the address list that's specified by the RoomList property of the address book policy that's assigned to the user (if any). + +```yaml +Type: AddressListIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AddressList.md b/exchange/exchange-ps/exchange/Set-AddressList.md new file mode 100644 index 0000000000..686f5b3185 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AddressList.md @@ -0,0 +1,700 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-AddressList cmdlet to modify existing address lists. + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AddressList [-Identity] + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-ForceUpgrade] + [-IncludedRecipients ] + [-Name ] + [-RecipientContainer ] + [-RecipientFilter ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AddressList cmdlet, piped to Format-List, to get the GUID, distinguished name (DN), or path and name of an existing address list. Or, use Get-AddressList to get a specific existing address list, and then pipe the output directly to the Set-AddressList cmdlet. + +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-AddressList -Identity "All Users\Sales\building4" -Name building9 +``` + +This example modifies the name of an existing address list. + +### Example 2 +```powershell +Set-AddressList -Identity c3fffd8e-026b-41b9-88c4-8c21697ac8ac -IncludedRecipients MailboxUsers -ConditionalDepartment Sales +``` + +This example modifies the type of recipients and the department of the recipients included in the existing address list identified by its GUID. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +```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: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute1 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute10 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute11 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute12 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute13 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute14 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute15 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute2 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute3 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute4 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute5 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute6 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute7 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute8 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute9 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalDepartment +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalStateOrProvince +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is the OU where the object was created. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -RecipientFilter +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Set-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md similarity index 86% rename from exchange/exchange-ps/exchange/mail-flow/Set-AddressRewriteEntry.md rename to exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md index 8f4bc118ed..09836f6007 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AddressRewriteEntry @@ -13,14 +16,21 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-AddressRewriteEntry cmdlet to modify an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AddressRewriteEntry [-Identity] [-Confirm] [-DomainController ] - [-ExceptionList ] [-ExternalAddress ] [-InternalAddress ] - [-Name ] [-OutboundOnly <$true | $false>] [-WhatIf] [] +Set-AddressRewriteEntry [-Identity] + [-Confirm] + [-DomainController ] + [-ExceptionList ] + [-ExternalAddress ] + [-InternalAddress ] + [-Name ] + [-OutboundOnly ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -28,8 +38,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-AddressRewriteEntry "Address rewrite entry for contoso.com" -Name "Address rewrite entry for northwindtraders.com" -InternalAddress northwindtraders.com ``` @@ -39,8 +49,8 @@ Changes the original email addresses that are affected by the address rewrite en Changes the Name value to "Address rewrite entry for northwindtraders.com". -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-AddressRewriteEntry "Address rewrite entry for all contoso.com email addresses" -OutboundOnly $true ``` @@ -56,6 +66,7 @@ Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -66,8 +77,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -75,6 +85,7 @@ 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 @@ -92,6 +103,7 @@ 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 @@ -100,13 +112,14 @@ Accept wildcard characters: False ``` ### -ExceptionList -The ExceptionList parameter specifies the domain names that should be excluded from address rewriting when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate multiple domain names included with the ExceptionList parameter with commas. For more information about how to add values to or remove values from multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). +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 Default value: None @@ -124,6 +137,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,9 +149,7 @@ Accept wildcard characters: False 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 - - Single domain: contoso.com or sales.contoso.com - - Domain and all subdomains: \*.contoso.com ```yaml @@ -145,6 +157,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -160,6 +173,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -175,10 +189,11 @@ You must set this parameter to $true if the InternalAddress parameter contains t Also, when you configure outbound-only address rewriting, you need to configure the rewritten email address as a proxy address on the affected recipients. For example, if laura@sales.contoso.com is rewritten to laura@contoso.com, the proxy address laura@contoso.com must be configured on Laura's mailbox. This allows replies and inbound messages to be delivered correctly. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -194,6 +209,7 @@ 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 @@ -202,20 +218,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2390ee56-7d46-4584-aae8-fba8455e9e04.aspx) diff --git a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md new file mode 100644 index 0000000000..6812c3cc6d --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md @@ -0,0 +1,371 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-AdminAuditLogConfig cmdlet to configure the administrator audit logging configuration settings. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AdminAuditLogConfig [[-Identity] ] + [-AdminAuditLogAgeLimit ] + [-AdminAuditLogCmdlets ] + [-AdminAuditLogEnabled ] + [-AdminAuditLogExcludedCmdlets ] + [-AdminAuditLogParameters ] + [-Confirm] + [-DomainController ] + [-Force] + [-LogLevel ] + [-Name ] + [-TestCmdletLoggingEnabled ] + [-UnifiedAuditLogIngestionEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +When audit logging is enabled, a log entry is created for each cmdlet run, excluding Get cmdlets. Log entries are stored in a hidden mailbox and accessed using the Search-AdminAuditLog or New-AdminAuditLogSearch cmdlets. + +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. + +Changes to the audit log configuration may take up to 60 minutes to be applied on computers that have the Exchange Management Shell open at the time a configuration change is made. If you want to apply the changes immediately, close and reopen the Exchange Management Shell on each computer. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AdminAuditLogConfig -AdminAuditLogEnabled $true -AdminAuditLogCmdlets * -AdminAuditLogParameters * -AdminAuditLogExcludedCmdlets Get-* +``` + +This example enables administrator audit logging for every cmdlet and every parameter in the organization, with the exception of Get cmdlets. + +### Example 2 +```powershell +Set-AdminAuditLogConfig -AdminAuditLogEnabled $true -AdminAuditLogCmdlets *Mailbox, *Management*, *TransportRule* -AdminAuditLogParameters * +``` + +This example enables administrator audit logging for specific cmdlets run in the organization. Any parameter used on the specified cmdlets is logged. Every time a specified cmdlet is run, a log entry is added to the audit log. + +### Example 3 +```powershell +Set-AdminAuditLogConfig -AdminAuditLogEnabled $true -AdminAuditLogCmdlets *Mailbox* -AdminAuditLogParameters *Address* +``` + +This example enables administrator audit logging only for specific parameters that are specified when running specific cmdlets. The parameter name and the cmdlet name must match the strings specified with the AdminAuditLogCmdlets and AdminAuditLogParameters parameters. For example, a log entry is generated only when a parameter with the string "Address" in the name is run on a cmdlet with the string "Mailbox" in its name. + +## PARAMETERS + +### -Identity +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AdminAuditLogAgeLimit +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. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +For example, to set the audit log age limit to 120 days, use the syntax 120.00:00:00. + +Setting the age limit to a value less than the current limit causes log entries older than the new limit to be deleted. + +Setting the age limit to 0 purges the audit log of all entries. + +```yaml +Type: EnhancedTimeSpan +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 +``` + +### -AdminAuditLogCmdlets +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 (\*). + +```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: False +Accept wildcard characters: False +``` + +### -AdminAuditLogEnabled +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. +- $false: Administrator audit logging is disabled. + +You must specify an administrator audit log mailbox before you enable logging. + +Changes to the administrator audit log configuration are always logged, regardless of whether audit logging is enabled or disabled. + +```yaml +Type: Boolean +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 +``` + +### -AdminAuditLogExcludedCmdlets +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. + +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. You can't specify only the wildcard character (\*). + +If you want to clear the list, specify a value of $null. + +```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: False +Accept wildcard characters: False +``` + +### -AdminAuditLogParameters +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 (\*). + +```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: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +This parameter is available only in on-premises Exchange. + +The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are: + +- None: The CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. This is the default value. +- Verbose: The ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are also included in log entries. + +```yaml +Type: AuditLogLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +This parameter is available only in on-premises Exchange. + +The Name parameter specifies the name of the AdminAuditLogConfig object. + +You don't need to specify this parameter when you configure administrator audit logging. It doesn't affect your configuration or how administrator audit logging works. + +```yaml +Type: String +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 +``` + +### -TestCmdletLoggingEnabled +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. + +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. + +```yaml +Type: Boolean +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 +``` + +### -UnifiedAuditLogIngestionEnabled +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. +- $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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md new file mode 100644 index 0000000000..a552fa50b5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -0,0 +1,957 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AntiPhishPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-AntiPhishPolicy cmdlet to modify antiphish policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AntiPhishPolicy -Identity + [-AdminDisplayName ] + [-AuthenticationFailAction ] + [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] + [-Enabled ] + [-EnableFirstContactSafetyTips ] + [-EnableMailboxIntelligence ] + [-EnableMailboxIntelligenceProtection ] + [-EnableOrganizationDomainsProtection ] + [-EnableSimilarDomainsSafetyTips ] + [-EnableSimilarUsersSafetyTips ] + [-EnableSpoofIntelligence ] + [-EnableTargetedDomainsProtection ] + [-EnableTargetedUserProtection ] + [-EnableUnauthenticatedSender ] + [-EnableUnusualCharactersSafetyTips ] + [-EnableViaTag ] + [-ExcludedDomains ] + [-ExcludedSenders ] + [-HonorDmarcPolicy ] + [-ImpersonationProtectionState ] + [-MailboxIntelligenceProtectionAction ] + [-MailboxIntelligenceProtectionActionRecipients ] + [-MailboxIntelligenceQuarantineTag ] + [-MakeDefault] + [-PhishThresholdLevel ] + [-PolicyTag ] + [-SpoofQuarantineTag ] + [-TargetedDomainActionRecipients ] + [-TargetedDomainProtectionAction ] + [-TargetedDomainQuarantineTag ] + [-TargetedDomainsToProtect ] + [-TargetedUserActionRecipients ] + [-TargetedUserProtectionAction ] + [-TargetedUserQuarantineTag ] + [-TargetedUsersToProtect ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AntiPhishPolicy -Identity "Office365 AntiPhish Default" -AuthenticationFailAction Quarantine +``` + +This example modifies the default antiphish policy named Office365 AntiPhish Default to quarantine spoofed messages from senders who aren't allowed to spoof. + +### Example 2 +```powershell +Set-AntiPhishPolicy -Identity "Office365 AntiPhish Default" -EnableOrganizationDomainsProtection $true -EnableTargetedDomainsProtection $true -TargetedDomainsToProtect fabrikam.com -TargetedDomainProtectionAction Quarantine -EnableTargetedUserProtection $true -TargetedUsersToProtect "Mai Fujito;mfujito@fabrikam.com" -TargetedUserProtectionAction Quarantine -EnableMailboxIntelligenceProtection $true -MailboxIntelligenceProtectionAction Quarantine -EnableSimilarUsersSafetyTips $true -EnableSimilarDomainsSafetyTips $true -EnableUnusualCharactersSafetyTips $true +``` + +In Microsoft Defender for Office 365, this example modifies the default antiphish policy named Office365 AntiPhish Default with the following settings: + +- Enables organization domains protection for all accepted domains, and targeted domains protection for fabrikam.com. +- Specifies Mai Fujito (mfujito@fabrikam.com) as a user to protect from impersonation. +- Enables mailbox intelligence protection, and specifies the quarantine action. +- Enables impersonation safety tips (impersonated domains, impersonated users, and unusual characters). + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: AntiPhishPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationFailAction +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcQuarantineAction +This setting is part of spoof protection. + +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: + +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. This is the default value. + +```yaml +Type: SpoofDmarcQuarantineAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcRejectAction +This setting is part of spoof protection. + +The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: + +- Quarantine: Deliver the message to quarantine. +- Reject: Reject the message. This is the default value. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcRejectAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter is reserved for internal Microsoft use. + +To enable or disable an existing anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use the **Enable-AntiPhishRule** or **Disable-AntiPhishRule** cmdlets. + +To create a disabled anti-phishing policy, use `-Enabled $false` on the **New-AntiPhishRule** cmdlet. + +In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing policy is enabled or disabled is visible in the State property. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -EnableFirstContactSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMailboxIntelligence +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMailboxIntelligenceProtection +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. + +This parameter is meaningful only if the EnableMailboxIntelligence parameter is set to the value $true. + +If you set this parameter to the value $false when the value of the EnableMailboxIntelligence parameter is $true, no action is taken on messages based on mailbox intelligence results (for example, lack of communication history). But, but mailbox intelligence can still help reduce impersonation false positives based on frequent contact information. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationDomainsProtection +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSimilarDomainsSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSimilarUsersSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpoofIntelligence +This setting is part of spoof protection. + +The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: + +- $true: Antispoofing is enabled for the policy. This is the default and recommended value. Use the \*-TenantAllowBlockListSpoofItems, Get-SpoofIntelligenceInsight, and Get-SpoofMailReport cmdlets to view and specify the spoofed senders to allow or block. +- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTargetedDomainsProtection +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTargetedUserProtection +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUnauthenticatedSender +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. +- $false: A question mark is never applied to the sender's photo. + +To prevent these identifiers from being added to messages from specific senders, you have the following options: + +- Allow the sender to spoof in the spoof intelligence policy. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUnusualCharactersSafetyTips +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableViaTag +This setting is part of spoof protection. + +The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: + +- $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This is the default value. +- $false: The via tag is not added to the From address. + +To prevent the via tag from being added to messages from specific senders, you have the following options: + +- Allow the sender to spoof. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedDomains +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. + +The maximum number of entries is approximately 1000. + +**Note**: Domain entries don't include subdomains of the specified domain. You need to add an entry for each subdomain. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSenders +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. + +The maximum number of entries is approximately 1000. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HonorDmarcPolicy +This setting is part of spoof protection. + +The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: + +- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This is the default value. +- $false: If the message fails DMARC, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImpersonationProtectionState +This setting is part of impersonation protection and is 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. +- Off + +```yaml +Type: ImpersonationProtectionState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxIntelligenceProtectionAction +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: + +- NoAction: This is the default value. Note that this value has the same result as setting the EnableMailboxIntelligenceProtection parameter to $false when the EnableMailboxIntelligence parameter is $true. +- BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. + +This parameter is meaningful only if the EnableMailboxIntelligence and EnableMailboxIntelligenceProtection parameters are set to the value $true. + +```yaml +Type: ImpersonationAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxIntelligenceProtectionActionRecipients +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. + +A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxIntelligenceQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by mailbox intelligence impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. + +The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishThresholdLevel +This setting is part of advanced settings and is 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. +- 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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpoofQuarantineTag +The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by spoof intelligence protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainActionRecipients +This setting is part of impersonation protection and is 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. + +A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainProtectionAction +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: + +- NoAction: This is the default value. +- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message, 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. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by domain impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedDomainsToProtect +This setting is part of impersonation protection and is 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. + +You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUserActionRecipients +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. + +A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUserProtectionAction +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: + +- NoAction: This is the default value. +- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. +- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUserQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by user impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetedUsersToProtect +This setting is part of impersonation protection and is 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. + +This parameter uses the syntax: "DisplayName;EmailAddress". + +- DisplayName specifies the display name of the user that could be a target of impersonation. This value can contain special characters. +- EmailAddress specifies the internal or external email address that's associated with the display name. +- You can specify multiple values that overwrite any existing values by using the syntax: `"DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN"`. The combination of DisplayName and EmailAddress needs to be unique for each value. +- You can append new values by using the syntax: `@{Add="NewDisplayName1;NewEmailAddress1","NewDisplayName2;NewEmailAddress2",..."NewDisplayNameN;NewEmailAddressN"}` or remove an existing value using the syntax: `@{Remove="OldDisplayName1;OldEmailAddress1"}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md new file mode 100644 index 0000000000..9d41dff174 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md @@ -0,0 +1,331 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AntiPhishRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-AntiPhishRule cmdlet to modify antiphish rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AntiPhishRule [-Identity] + [-AntiPhishPolicy ] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Common policy settings](https://learn.microsoft.com/defender-office-365/anti-phishing-policies-about#common-policy-settings). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AntiPhishRule -Identity "Engineering Department Phishing Rule" -ExceptIfRecipientDomainIs fabrikam.com +``` + +This example modifies the existing antiphish rule named Engineering Department Phishing Rule to exclude messages sent to the fabrikam.com domain. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiPhishPolicy +The AntiPhishPolicy parameter specifies the antiphish policy that's associated with the antiphish rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: AntiPhishPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-App.md b/exchange/exchange-ps/exchange/Set-App.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Set-App.md rename to exchange/exchange-ps/exchange/Set-App.md index 165dfec211..af5a021961 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-App.md +++ b/exchange/exchange-ps/exchange/Set-App.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-App @@ -13,14 +16,21 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-App cmdlet to modify the availability of organization apps. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-App [-Identity] [-Confirm] [-DefaultStateForUser ] - [-DomainController ] [-Enabled <$true | $false>] [-OrganizationApp] - [-ProvidedTo ] [-UserList ] [-WhatIf] [-PrivateCatalog] +Set-App [-Identity] + [-Confirm] + [-DefaultStateForUser ] + [-DomainController ] + [-Enabled ] + [-OrganizationApp] + [-PrivateCatalog] + [-ProvidedTo ] + [-UserList ] + [-WhatIf] [] ``` @@ -29,28 +39,28 @@ The Set-App cmdlet can only be used when configuring the availability of an orga Default apps in Outlook on the web and apps that you've installed for use by users in your organization are known as organization apps. Organization apps can't be removed by end users, but can be enabled or disabled. If an app is an organization app (scope default or organization), the delete control on the toolbar is disabled for end users. Administrators are able to remove organization apps. Administrators can't remove default apps, but they can disable them for the entire organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +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). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -$a= Get-DistributionGroupMember -Identity "Finance Team"; Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -ProvidedTo SpecificUsers -UserList $a.Identity -DefaultStateForUser Enabled +### Example 1 +```powershell +$a= Get-DistributionGroupMember -Identity "Finance Team" + +Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -ProvidedTo SpecificUsers -UserList $a.Identity -DefaultStateForUser Enabled ``` This example changes the organization app named FinanceTestApp, which was installed to everyone in the organization, to be provided to members of the Finance Team group and to be enabled by default. -For more information, see Manage user access to add-ins for Outlook (https://technet.microsoft.com/library/jj943757.aspx). - -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -Enabled $false ``` This example disables the organization app named FinanceTestApp across the organization and hides it from end user view. -For more information, see Manage user access to add-ins for Outlook (https://technet.microsoft.com/library/jj943757.aspx). - ## PARAMETERS ### -Identity @@ -60,7 +70,8 @@ The Identity parameter specifies the AppID (GUID value) of the app that you want Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True Position: 1 Default value: None @@ -71,15 +82,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -91,18 +102,17 @@ Accept wildcard characters: False 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. - - AlwaysEnabled: The organization app is enabled, and users can't disable it. You use this parameter with the OrganizationApp switch. ```yaml -Type: Enabled | Disabled | AlwaysEnabled +Type: DefaultStateForUser Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -120,6 +130,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -131,16 +142,16 @@ Accept wildcard characters: False 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. - - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -156,6 +167,23 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCatalog +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 Default value: None @@ -167,16 +195,16 @@ Accept wildcard characters: False 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. You use this parameter with the OrganizationApp switch. ```yaml -Type: Everyone | SpecificUsers +Type: ClientExtensionProvidedTo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -185,35 +213,22 @@ Accept wildcard characters: False ``` ### -UserList -The UserList parameter specifies who can use an organizational app. This parameter is currently limited to 1000 users. This will not change in the future as we are planning on moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). +The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). -Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. - -For example: +Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". Maximum size of the list is 1000 recipients. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. Maximum size of the list is 1000 recipients. You use this parameter with the OrganizationApp switch. @@ -222,6 +237,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -236,22 +252,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateCatalog -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. +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named Default value: None @@ -260,20 +262,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3506b2b9-dc23-4ed9-84f5-8839c4c3c974.aspx) diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..d7b88cea53 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -0,0 +1,660 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancepolicy +applicable: Security & Compliance +title: Set-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-AppRetentionCompliancePolicy to modify app retention compliance policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-AddExchangeLocation ] + [-AddExchangeLocationException ] + [-AddModernGroupLocation ] + [-AddModernGroupLocationException ] + [-Applications ] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-Force] + [-PolicyRBACScopes ] + [-RemoveExchangeLocation ] + [-RemoveExchangeLocationException ] + [-RemoveModernGroupLocation ] + [-RemoveModernGroupLocationException ] + [-RestrictiveRetention ] + [-WhatIf] + [] +``` + +### AdaptiveScopeLocation +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-AddAdaptiveScopeLocation ] + [-Applications ] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-Force] + [-RemoveAdaptiveScopeLocation ] + [-WhatIf] + [] +``` + +### DisableRestrictiveRetentionParameterSet +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-DeletedResources ] + [-WhatIf] + [] +``` + +### InformationBarrierDefault +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-DeletedResources ] + [-Force] + [-WhatIf] + [] +``` + +### OrganizationSegmentsDefault +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-DeletedResources ] + [-WhatIf] + [] +``` + +### RetryDistributionParameterSet +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-RetryDistribution] + [-WhatIf] + [] +``` + +### TeamLocation +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies in the locations described in [Retention cmdlets for newer locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-newer-locations). You can only set the list of included or excluded scopes for all included workloads, which means you likely need to create one policy per workload. + +\*-RetentionCompliance\* cmdlets continue to primarily support the locations described in [Retention cmdlets for older locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-older-locations). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,VivaEngage" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21" +``` + +This example adds a new user to the existing static scope retention policy named Regulation 563 Marketing that's set up for Teams private channels messages. + +### Example 2 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser@contoso.onmicrosoft.com' +}] +"@ +Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Policy" -AddExchangeLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` +This example excludes the specified soft-deleted mailbox or mail user from the retention policy configured for Teams private channel messages. You can identify the deleted resources using the mailbox or mail user's email address. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +Policy exclusions must remain within the supported limits for retention policies. For more information, see [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy). + +### Example 3 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com' +}, +{ + 'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com' +}] +"@ +Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example is similar to Example 2, except multiple deleted resources are specified. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RetryDistribution +The RetryDistribution switch specifies whether to redistribute the policy to all locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistributionParameterSet +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddAdaptiveScopeLocation +The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocationException +The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you're using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocation +The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocationException +The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Applications +The Applications parameter specifies the applications to include in the policy. + +This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: + +`LocationType` is User or Group. + +`App` is a supported value as shown in the following examples. + +- **Microsoft 365 apps**: For example: + + `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"` + +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` + +```yaml +Type: String[] +Parameter Sets: Identity, AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedResources +The DeletedResources parameter specifies the deleted mailbox or mail user to add as an exclusion to the respective location list. Use this parameter with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users that need to be excluded from a Teams only retention policy. + +A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. + +For information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). + +**CAUTION**: This parameter uses the SMTP address of the deleted mailbox or mail user, which might also be specified for other mailboxes or mail users. If you use this parameter without first taking additional steps, other mailboxes and mail users with the same SMTP address in the retention policy will also be excluded. To check for additional mailboxes or mail users with the same SMTP address, use the following command and replace `user@contoso.com` with the SMTP address to check: `Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted` + +To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on [Litigation Hold](https://learn.microsoft.com/purview/ediscovery-create-a-litigation-hold) before you run the command with the DeletedResources parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the policy. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation, InformationBarrierDefault +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAdaptiveScopeLocation +The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocationException +The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocation +The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocationException +The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictiveRetention +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: + +- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. +- $false: Preservation Lock isn't enabled for the policy. This is the default value. + +After a policy has been locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. + +Therefore, before you lock a policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..a6b2925a84 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule +applicable: Security & Compliance +title: Set-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-AppRetentionComplianceRule to modify app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AppRetentionComplianceRule [-Identity] + [-Comment ] + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentDateFrom ] + [-ContentDateTo ] + [-ContentMatchQuery ] + [-ExcludedItemClasses ] + [-ExpirationDateOption ] + [-RetentionComplianceAction ] + [-RetentionDuration ] + [-RetentionDurationDisplayHint ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AppRetentionComplianceRule -Identity "563 Marketing Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days +``` + +This example updates the length of the retention duration for a rule named 563 Marketing Rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance rule that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateFrom +{{ Fill ContentDateFrom Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateTo +{{ Fill ContentDateTo Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedItemClasses +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +- IPM.Note.Microsoft.Conversation +- IPM.Note.Microsoft.Conversation.Voice +- IPM.Note.Microsoft.Missed +- IPM.Note.Microsoft.Missed.Voice +- IPM.Note.Microsoft.Voicemail +- IPM.Note.Microsoft.VoiceMessage.UA +- IPM.Note.Microsoft.Voicemail.UM +- IPM.Note.Microsoft.Voicemail.UM.CA + +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. + +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateOption +The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: + +- CreationAgeInDays +- ModificationAgeInDays + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionComplianceAction +The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDurationDisplayHint +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. + +- Days +- Months +- Years + +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. + +```yaml +Type: HoldDurationHint +Parameter Sets: (All) +Aliases: +Accepted values: Days, Months, Years +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md new file mode 100644 index 0000000000..dd98f50127 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md @@ -0,0 +1,123 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-ApplicationAccessPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ApplicationAccessPolicy cmdlet to modify the description of an application access policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ApplicationAccessPolicy [-Identity] + [-Description ] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ApplicationAccessPolicy -Identity "596ade3a-1abe-4c5b-b7d5-a169c4b05d4a\7a774f0c-7a6f-11e0-85ad-07fb4824019b:S-1-5-21-724521725-2336880675-2689004279-1821338;8b6ce428-cca2-459a-ac50-d38bcc932258" -Description "Executive Assistant Policy" +``` + +This example modifies the description of the specified policy. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work on this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ArcConfig.md b/exchange/exchange-ps/exchange/Set-ArcConfig.md new file mode 100644 index 0000000000..5bf267a358 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ArcConfig.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-arcconfig +applicable: Exchange Online, Exchange Online Protection +title: Set-ArcConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ArcConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ArcConfig cmdlet to modify the list of trusted Authenticated Received Chain (ARC) sealers that are configured in the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ArcConfig [-Identity] -ArcTrustedSealers + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Services that modify message content in transit before delivery can invalidate DKIM email signatures and affect the authentication of the message. These services can use ARC to provide details of the original authentication before the modifications occurred. Your organization can then trust these details to help authenticate the message. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ArcConfig -Identity Default -ArcTrustedSealers fabrikam.com +``` + +This example configures "fabrikam.com" as the only trusted ARC sealer in the organization. + +### Example 2 +```powershell +$DomainsAdd = @(Get-ArcConfig | select -Expand ArcTrustedSealers) + +$DomainsAdd += "cohovineyard.com","tailspintoys.com" + +Set-ArcConfig -Identity Default -ArcTrustedSealers $DomainsAdd +``` + +This example adds the trusted ARC sealers "cohovineyard.com" and "tailspintoys.com" without affecting the other trusted ARC sealer entries. + +### Example 3 +```powershell +$x = @(Get-ArcConfig | select -Expand ArcTrustedSealers) + +$y = $x.Split(",") + +$DomainsRemove = [System.Collections.ArrayList]($y) + +$DomainsRemove + +$DomainsRemove.RemoveAt(6) + +Set-ArcConfig -Identity Default -ArcTrustedSealers $DomainsRemove +``` + +This example modifies the trusted ARC sealers list by removing an existing ARC sealer without affecting other ARC sealers that are already specified. + +The first four commands return the existing list of ARC sealers. The first ARC sealer in the list has the index number 0, the second has the index number 1, and so on. Use the index number to specify the ARC sealer that you want to remove. + +The last two commands remove the seventh ARC sealer that's displayed in the list. + +### Example 4 +```powershell +$arcSealer = 'fabrikam.com' +$x = @(Get-ArcConfig | Select-Object -Expand ArcTrustedSealers) + +$y = @($x.Split(",")) +$DomainsRemove = [System.Collections.ArrayList]($y) +$DomainsRemove.Remove($arcSealer) + +if ($DomainsToRemove.Count -eq 0) { + Set-ArcConfig -Identity Default -ArcTrustedSealers " " + } +else { + Set-ArcConfig -Identity Default -ArcTrustedSealers $DomainsRemove + } +``` + +This example removes the specified ARC sealer from the list (`$arcSealer`). + +If no other ARC sealers exist after removing this entry from the list, using the value `" "` for the ArcTrustedSealers parameter avoids a bind argument error if the `$DomainsToRemove` value is empty. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the trusted ARC sealers list that you want to modify. Use one of the following values: + +- Default for your own organization. +- \\Default for delegated organizations. The \ value is a GUID that's visible in many admin portal URLs in Microsoft 365 (the tid= value). For example, a32d39e2-3702-4ff5-9628-31358774c091. + +```yaml +Type: HostedConnectionFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ArcTrustedSealers +The ArcTrustedSealers parameter specifies the domain name of the ARC sealers that you want to add. + +The domain name must match the domain that's shown in the `d` tag in the **ARC-Seal** and **ARC-Message-Signature** headers in affected email messages (for example, fabrikam.com). You can use Outlook to see these headers. + +To replace the existing list of ARC sealers with the values you specify, use the syntax `Domain1,Domain2,...DomainN`. To preserve existing values, be sure to include the entries that you want to keep along with the new values that you want to add. + +To add or remove values without affecting the other entries, see the Examples section in this article. + +To empty the list, use the value `" "` (a space enclosed in double quotation marks). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md new file mode 100644 index 0000000000..bcdc6c3dd1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -0,0 +1,178 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AtpPolicyForO365 + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-AtpPolicyForO365 cmdlet to modify the settings for the following features in Microsoft Defender for Office 365: + +- Safe Links protection for supported Office 365 apps. +- Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise. +- Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AtpPolicyForO365 [[-Identity] ] + [-AllowSafeDocsOpen ] + [-Confirm] + [-EnableATPForSPOTeamsODB ] + [-EnableSafeDocs ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://learn.microsoft.com/defender-office-365/safe-links-about#safe-links-settings-for-office-apps). + +Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://learn.microsoft.com/defender-office-365/safe-documents-in-e5-plus-security-about). + +Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://learn.microsoft.com/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). + +## EXAMPLES + +### Example 1 +```powershell +Set-AtpPolicyForO365 -EnableATPForSPOTeamsODB $true +``` + +This example enables Safe Documents and Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllowSafeDocsOpen +The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents identifies a file as malicious. Valid values are: + +- $true: Users are allowed to exit the Protected View container even if the document has been 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableATPForSPOTeamsODB +The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: + +- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. +- $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeDocs +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. + +For more information about Safe Documents, see [Safe Documents in Microsoft 365 A5 or E5 Security](https://learn.microsoft.com/defender-office-365/safe-documents-in-e5-plus-security-about) + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md rename to exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md index 98261f2de0..0bc5e542b8 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AttachmentFilterListConfig @@ -13,13 +16,19 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-AttachmentFilterListConfig cmdlet to modify the configuration of the Attachment Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AttachmentFilterListConfig [-Action ] [-AdminMessage ] [-Confirm] - [-DomainController ] [-ExceptionConnectors ] [-RejectResponse ] [-WhatIf] +Set-AttachmentFilterListConfig + [-Action ] + [-AdminMessage ] + [-Confirm] + [-DomainController ] + [-ExceptionConnectors ] + [-RejectResponse ] + [-WhatIf] [] ``` @@ -30,8 +39,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-AttachmentFilterListConfig -Action Reject ``` @@ -40,19 +49,18 @@ This example modifies the action that the Attachment Filtering agent takes on an ## PARAMETERS ### -Action -The Action parameter specifies how the Attachment Filtering agent handles an attachment that matches an entry on the attachment filter list. The default value is Reject. You can use one of the following values: - -- 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. +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. - 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. ```yaml -Type: Reject | Strip | SilentDelete +Type: FilterActions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -68,6 +76,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -78,8 +87,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -87,6 +95,7 @@ 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 @@ -104,6 +113,7 @@ 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 @@ -119,6 +129,7 @@ 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 @@ -134,6 +145,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -149,6 +161,7 @@ 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 @@ -157,20 +170,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7c4796fc-54f3-407e-b11d-c51f10682dc3.aspx) diff --git a/exchange/exchange-ps/exchange/Set-AuditConfig.md b/exchange/exchange-ps/exchange/Set-AuditConfig.md new file mode 100644 index 0000000000..e2c5d20cfd --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AuditConfig.md @@ -0,0 +1,124 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AuditConfig + +## 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-AuditConfig cmdlet to configure the auditing configuration in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AuditConfig [[-Identity] ] -Workload + [-DomainController ] + [-Organization ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AuditConfig -Workload Exchange,SharePoint +``` + +This example sets the auditing configuration for Exchange and SharePoint. + +## PARAMETERS + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter specifies where auditing is allowed. Valid values are: + +- Exchange +- InTune +- OneDriveForBusiness +- SharePoint + +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 +``` + +### -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 +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Set-AuthConfig.md b/exchange/exchange-ps/exchange/Set-AuthConfig.md similarity index 77% rename from exchange/exchange-ps/exchange/organization/Set-AuthConfig.md rename to exchange/exchange-ps/exchange/Set-AuthConfig.md index 29fd5ce114..a6ffa805ac 100644 --- a/exchange/exchange-ps/exchange/organization/Set-AuthConfig.md +++ b/exchange/exchange-ps/exchange/Set-AuthConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AuthConfig @@ -13,63 +16,72 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AuthConfig cmdlet to modify the authorization configuration for your Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### CurrentCertificateParameter ``` -Set-AuthConfig -CertificateThumbprint [-SkipImmediateCertificateDeployment] +Set-AuthConfig -CertificateThumbprint + [-SkipImmediateCertificateDeployment] [-Confirm] [-DomainController ] [-Force] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### PublishAuthCertificateParameter ``` -Set-AuthConfig [-ClearPreviousCertificate] [-PublishCertificate] +Set-AuthConfig [-ClearPreviousCertificate] + [-PublishCertificate] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### NewCertificateParameter ``` -Set-AuthConfig [-NewCertificateEffectiveDate ] [-NewCertificateThumbprint ] [-SkipImmediateCertificateDeployment] +Set-AuthConfig [-NewCertificateEffectiveDate ] + [-NewCertificateThumbprint ] + [-SkipImmediateCertificateDeployment] [-Confirm] [-DomainController ] [-Force] [-Server ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### AuthConfigSettings ``` -Set-AuthConfig [-Realm ] [-ServiceName ] +Set-AuthConfig [-Realm ] + [-ServiceName ] [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-AuthConfig -NewCertificateThumbprint DB821B4FCA2A5DA9593B9DE00C86BC5EA35D0FC0 -NewCertificateEffectiveDate 4/17/2013 +### Example 1 +```powershell +Set-AuthConfig -NewCertificateThumbprint DB821B4FCA2A5DA9593B9DE00C86BC5EA35D0FC0 -NewCertificateEffectiveDate 4/17/2014 ``` This example specifies a new certificate and a date when the certificate will become effective. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-AuthConfig -PublishCertificate ``` @@ -85,6 +97,7 @@ Type: String Parameter Sets: CurrentCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -93,13 +106,14 @@ Accept wildcard characters: False ``` ### -ClearPreviousCertificate -The ClearPreviousCertificate switch clears the certificate saved as the previous certificate in the authorization configuration. +The ClearPreviousCertificate switch clears the certificate that was saved as the previous certificate in the authorization configuration. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: PublishAuthCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,8 +124,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -119,6 +132,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -134,6 +148,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -142,13 +157,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: CurrentCertificateParameter, PublishAuthCertificateParameter, NewCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,6 +182,7 @@ Type: DateTime Parameter Sets: NewCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -179,6 +198,7 @@ Type: String Parameter Sets: NewCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -187,13 +207,16 @@ Accept wildcard characters: False ``` ### -PublishCertificate -The PublishCertificate switch specifies that the specified certificate be immediately rolled over as the current certificate. The certificate is immediately deployed to all Client Access servers. +The PublishCertificate switch immediately rolls over the specified certificate as the current certificate. You don't need to specify a value with this switch. + +The certificate is immediately deployed to all Client Access servers. ```yaml Type: SwitchParameter Parameter Sets: PublishAuthCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -209,6 +232,7 @@ Type: String Parameter Sets: AuthConfigSettings Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -224,6 +248,7 @@ Type: ServerIdParameter Parameter Sets: CurrentCertificateParameter, NewCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -241,6 +266,7 @@ Type: String Parameter Sets: AuthConfigSettings Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -249,13 +275,16 @@ Accept wildcard characters: False ``` ### -SkipImmediateCertificateDeployment -The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. We recommend that you don't use this parameter in a production environment. +The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. You don't need to specify a value with this switch. + +We don't recommend using this switch in a production environment. ```yaml Type: SwitchParameter Parameter Sets: CurrentCertificateParameter, NewCertificateParameter Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -271,6 +300,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -279,20 +309,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/dfc5be21-3a9c-4888-b1e9-8a308262eb67.aspx) diff --git a/exchange/exchange-ps/exchange/Set-AuthRedirect.md b/exchange/exchange-ps/exchange/Set-AuthRedirect.md new file mode 100644 index 0000000000..e39dde30f7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AuthRedirect.md @@ -0,0 +1,151 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AuthRedirect + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-AuthRedirect cmdlet to modify the existing OAuth redirection settings for Microsoft Exchange 2010 Client Access servers in your Microsoft Exchange 2013 organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AuthRedirect [-Identity] + [-Confirm] + [-DomainController ] + [-TargetUrl ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AuthRedirect -Identity AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE -TargetUrl https://mbx01.contoso.com +``` + +This example sets the TargetURL value to `https://mbx01.contoso.com` for the existing OAuth redirection object named `AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE`. + +### Example 2 +```powershell +Get-AuthRedirect | Set-AuthRedirect -TargetUrl https://mbx01.contoso.com +``` + +This example sets the TargetURL value for all existing OAuth redirection objects in your organization. However, if you have only one object in your organization, this example has the same result as the first example. + +## PARAMETERS + +### -Identity +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 +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: True +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 +``` + +### -TargetUrl +The TargetUrl parameter specifies the FQDN of the Exchange 2013 Client Access server that will process 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Set-AuthServer.md b/exchange/exchange-ps/exchange/Set-AuthServer.md new file mode 100644 index 0000000000..7caef4d3c2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AuthServer.md @@ -0,0 +1,327 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AuthServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-AuthServer cmdlet to configure an authorization server that partner applications can use to obtain tokens recognized by Microsoft Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AuthMetadataUrl +``` +Set-AuthServer [-Identity] + [-AuthMetadataUrl ] + [-TrustAnySSLCertificate] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-Name ] + [-WhatIf] + [] +``` + +### NativeClientAuthServer +``` +Set-AuthServer [-Identity] + [-AuthMetadataUrl ] + [-IsDefaultAuthorizationEndpoint ] + [-TrustAnySSLCertificate] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-Name ] + [-WhatIf] + [] +``` + +### RefreshAuthMetadata +``` +Set-AuthServer [-Identity] + [-RefreshAuthMetadata] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-Name ] + [-WhatIf] + [] +``` + +### 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-AuthServer ACS -Enabled $false +``` + +This command disables the authorization server ACS. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: AuthServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ApplicationIdentifier +This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchange 2019 CU15 and Exchange 2016 CU23. + +{{ Fill ApplicationIdentifier Description }} + +```yaml +Type: String +Parameter Sets: AppSecret +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthMetadataUrl +The AuthMetadataUrl parameter specifies the URL of the authorization server. This can be the AuthMetadataUrl of your Exchange Online organization. + +```yaml +Type: String +Parameter Sets: AuthMetadataUrl, NativeClientAuthServer +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 +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +This parameter is available only in Exchange Server 2016 (CU18 or higher) and Exchange Server 2019 (CU7 or higher). + +The DomainName parameter specifies the tenant domain that's linked with the AuthServer object. This parameter uses the syntax: "tenantname.onmicrosoft.com". + +This parameter is used to link Tenant to the corresponding authserver object in the Multi-Tenant Exchange Hybrid. For example, if DomainName is contoso.onmicrosoft.com, then the AuthServer object will be associated with the contoso tenant. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Enabled +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 +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefaultAuthorizationEndpoint +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. + +$false: The authorization server's URL is not advertised. The default value is $false. + +```yaml +Type: Boolean +Parameter Sets: NativeClientAuthServer +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 +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshAuthMetadata +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustAnySSLCertificate +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +We don't recommend using this switch in a production environment. + +```yaml +Type: SwitchParameter +Parameter Sets: AuthMetadataUrl, NativeClientAuthServer +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 +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Set-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md new file mode 100644 index 0000000000..5f9a01b922 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md @@ -0,0 +1,793 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-AuthenticationPolicy cmdlet to modify authentication policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AuthenticationPolicy [-Identity] + [-AllowBasicAuthActiveSync] + [-AllowBasicAuthAutodiscover] + [-AllowBasicAuthImap] + [-AllowBasicAuthMapi] + [-AllowBasicAuthOfflineAddressBook] + [-AllowBasicAuthOutlookService] + [-AllowBasicAuthPop] + [-AllowBasicAuthPowershell] + [-AllowBasicAuthReportingWebServices] + [-AllowBasicAuthRpc] + [-AllowBasicAuthSmtp] + [-AllowBasicAuthWebServices] + [-AllowLegacyExchangeTokens] + [-BlockLegacyAuthActiveSync] + [-BlockLegacyAuthAutodiscover] + [-BlockLegacyAuthImap] + [-BlockLegacyAuthMapi] + [-BlockLegacyAuthOfflineAddressBook] + [-BlockLegacyAuthPop] + [-BlockLegacyAuthRpc] + [-BlockLegacyAuthWebServices] + [-BlockLegacyExchangeTokens] + [-BlockModernAuthActiveSync] + [-BlockModernAuthAutodiscover] + [-BlockModernAuthImap] + [-BlockModernAuthMapi] + [-BlockModernAuthOfflineAddressBook] + [-BlockModernAuthPop] + [-BlockModernAuthRpc] + [-BlockModernAuthWebServices] + [-Confirm] + [-TenantId ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AuthenticationPolicy -Identity "Engineering Group" -AllowBasicAuthReportingWebServices +``` + +In Exchange Online, this example modifies the authentication policy named Engineering Group to allow Basic authentication for Exchange Reporting Web Services. + +### Example 2 +```powershell +Set-AuthenticationPolicy -Identity "Research and Development Group" -BlockLegacyAuthReportingWebServices:$false +``` + +In Exchange 2019, this example re-enables Basic authentication for Exchange Reporting Web Services in the authentication policy named Research and Development Group. + +### Example 3 +```powershell +Set-AuthenticationPolicy -Identity "LegacyExchangeTokens" -BlockLegacyExchangeTokens +``` + +In Exchange Online, this example blocks legacy Exchange tokens from being issued to Outlook add-ins. The switch applies to the entire organization, and the Identity parameter must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the authentication policy you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: AuthPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthActiveSync +This parameter is available only in the cloud-based service. + +The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange Active Sync. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthActiveSync:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthAutodiscover +This parameter is available only in the cloud-based service. + +The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthAutodiscover:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthImap +This parameter is available only in the cloud-based service. + +The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthImap:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthMapi +This parameter is available only in the cloud-based service. + +The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAutMapi:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthOfflineAddressBook +This parameter is available only in the cloud-based service. + +The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthOfflineAddressBook:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthOutlookService +This parameter is available only in the cloud-based service. + +The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthOutlookService:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthPop +This parameter is available only in the cloud-based service. + +The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthPop:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthPowershell +This parameter is available only in the cloud-based service. + +The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthPowershell:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthReportingWebServices +This parameter is available only in the cloud-based service. + +The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthReportingWebServices:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthRpc +This parameter is available only in the cloud-based service. + +The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthRpc:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthSmtp +This parameter is available only in the cloud-based service. + +The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthSmtp:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBasicAuthWebServices +This parameter is available only in the cloud-based service. + +The AllowBasicAuthWebServices switch specifies whether to allow Basic authentication with Exchange Web Services (EWS). + +- To allow Basic authentication for the protocol, use this switch without a value. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthWebServices:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The AllowLegacyExchangeTokens switch specifies to allow legacy Exchange tokens to be issued to Outlook add-ins. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. + +**Important**: + +- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes. +- It might take up to 24 hours for the change to take effect across your entire organization. +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthActiveSync +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for ActiveSync, use this switch without a value. +- To allow legacy authentication methods for ActiveSync, use this exact syntax: `-BlockLegacyAuthActiveSync:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthAutodiscover +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern authentication with Autodiscover in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for Autodiscover, use this switch without a value. +- To allow legacy authentication methods for Autodiscover, use this exact syntax: `-BlockLegacyAuthAutodiscover:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthImap +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthImap switch specifies whether to allow only modern authentication with IMAP in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for IMAP, use this switch without a value. +- To allow legacy authentication methods for IMAP, use this exact syntax: `-BlockLegacyAuthImap:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthMapi +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthMapi switch specifies whether to allow only modern authentication with MAPI in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for MAPI, use this switch without a value. +- To allow legacy authentication methods for MAPI, use this exact syntax: `-BlockLegacyAuthMapi:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthOfflineAddressBook +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only modern authentication with Offline Address Books in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for Offline Address Books, use this switch without a value. +- To allow legacy authentication methods for OfflineAddressBooks, use this exact syntax: `-BlockLegacyAuthOfflineAddressBook:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthPop +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthPop switch specifies whether to allow only modern authentication with POP in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for POP, use this switch without a value. +- To allow legacy authentication methods for POP, use this exact syntax: `-BlockLegacyAuthPop:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthRpc +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthRpc switch specifies whether to allow only modern authentication with RPC in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for RPC, use this switch without a value. +- To allow legacy authentication methods for RPC, use this exact syntax: `-BlockLegacyAuthRpc:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthWebServices +This parameter is available only in on-premises Exchange. + +The BlockLegacyAuthWebServices switch specifies whether to allow only modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU2 or later hybrid environments. + +- To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for EWS, use this switch without a value. +- To allow legacy authentication methods for EWS, use this exact syntax: `-BlockLegacyAuthWebServices:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The BlockLegacyExchangeTokens switch specifies to block legacy Exchange tokens being issued to Outlook add-ins. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. + +**Important**: + +- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes. +- It might take up to 24 hours for the change to take effect across your entire organization. +- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire. +- Blocking legacy Exchange tokens might cause some Microsoft add-ins to stop working. These add-ins are being updated to no longer use legacy tokens. +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthActiveSync +This parameter is available only in on-premises Exchange. + +The BlockModernAuthActiveSync switch specifies whether to block modern authentication with Exchange ActiveSync in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthAutodiscover +This parameter is available only in on-premises Exchange. + +The BlockModernAuthAutodiscover switch specifies whether to block modern authentication with Autodiscover in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthImap +This parameter is available only in on-premises Exchange. + +The BlockModernAuthImap switch specifies whether to block modern authentication with IMAP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthMapi +This parameter is available only in on-premises Exchange. + +The BlockModernAuthMapi switch specifies whether to block modern authentication with MAPI in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthOfflineAddressBook +This parameter is available only in on-premises Exchange. + +The BlockModernAuthOfflineAddressBook switch specifies whether to block modern authentication with Offline Address Books in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthPop +This parameter is available only in on-premises Exchange. + +The BlockModernAuthPop switch specifies whether to block modern authentication with POP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthRpc +This parameter is available only in on-premises Exchange. + +The BlockModernAuthRpc switch specifies whether to block modern authentication with RPC in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthWebServices +This parameter is available only in on-premises Exchange. + +The BlockModernAuthWebServices switch specifies whether to block modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is available only in the cloud-based service. + +{{ Fill TenantId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md new file mode 100644 index 0000000000..08f50e337c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -0,0 +1,933 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AutoSensitivityLabelPolicy + +## 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-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Set-AutoSensitivityLabelPolicy [-Identity] + [-AddExchangeLocation ] + [-AddOneDriveLocation ] + [-AddOneDriveLocationException ] + [-AddSharePointLocation ] + [-AddSharePointLocationException ] + [-ApplySensitivityLabel ] + [-AutoEnableAfter ] + [-Comment ] + [-Confirm] + [-Enabled ] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] + [-ExchangeSender ] + [-ExchangeSenderException ] + [-ExchangeSenderMemberOf ] + [-ExchangeSenderMemberOfException ] + [-ExternalMailRightsManagementOwner ] + [-Force] + [-Locations ] + [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] + [-OverwriteLabel ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-Priority ] + [-RemoveExchangeLocation ] + [-RemoveOneDriveLocation ] + [-RemoveOneDriveLocationException ] + [-RemoveSharePointLocation ] + [-RemoveSharePointLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-SpoAipIntegrationEnabled ] + [-StartSimulation ] + [-WhatIf] + [] +``` + +### TeamLocation +``` +Set-AutoSensitivityLabelPolicy [-Identity] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-Mode ] + [-WhatIf] + [] +``` + +### RetryDistributionParameterSet +``` +Set-AutoSensitivityLabelPolicy [-Identity] + [-Confirm] + [-Mode ] + [-RetryDistribution] + [-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-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 and OneDrive locations for the autolabeling policy named Main PII without affecting the existing URL values. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter adds email messages to the policy if they're not already included. The valid value for this parameter is All. + +If the policy doesn't already include email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: + +- If you use `-AddExchangeLocation All` by itself, the policy applies to email for all internal users. + +- To include email of specific internal or external users in the policy, use `-AddExchangeLocation All` with the ExchangeSender parameter in the same command. Only email of the specified users is included in the policy. + +- To include email of specific group members in the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific internal users from the policy, use `-AddExchangeLocation All` with the ExchangeSenderException parameter in the same command. Only email of the specified users is excluded from the policy. + +- To exclude email of specific group members from the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplySensitivityLabel +The ApplySensitivityLabel parameter selects which label to be used for the policy. This will override the previous label on the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoEnableAfter +The AutoEnableAfter parameter allows you to automatically turn on the policy after a set time period in simulation with no modifications to the policy. You need to explicitly set this parameter after each policy edit to keep or reset the automatic turn on timeline. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +A valid value is between 1 hour and 25 days. To clear an existing AutoEnableAfter schedule that's associated with a policy, use the value $null. + +You must use this parameter with the -StartSimulation parameter. + +```yaml +Type: System.TimeSpan +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the policy. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedBy +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: + +- The policy already includes OneDrive sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedByMemberOf +{{ Fill ExceptIfOneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSender +The ExchangeSender parameter specifies the users whose email is included in the policy. You specify the users by email address. You can specify internal or external email addresses. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. + +```yaml +Type: SmtpAddress[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderException +The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-AutoSensitivityLabelPolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. + +```yaml +Type: SmtpAddress[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOf +The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-AutoSensitivityLabelPolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: SmtpAddress[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOfException +The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-AutoSensitivityLabelPolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: SmtpAddress[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMailRightsManagementOwner +The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. + +This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. + +To clear an existing email address, use the value $null. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +{{ Fill Locations Description }} + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: + +- Enable: The policy is enabled for actions and notifications. +- Disable: The policy is disabled. +- TestWithNotifications: Not supported. +- TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent (Test mode). + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedBy +The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: + +- The policy already includes OneDrive sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedByMemberOf +{{ Fill OneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteLabel +The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: + +- $true: Overwrite the manual label. +- $false: Don't overwrite the manual label. This is the default value. + +This parameter works only on Exchange locations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: + +- Valid priority values for the existing 5 policies are from 0 through 4. +- Valid priority values for a new 6th policy are from 0 through 5. +- The default value for a new 6th policy is 5. + +If you modify the priority value of a policy, the position of the policy in the list changes to match the priority value you specify. In other words, if you set the priority value of a policy to the same value as an existing policy, the priority value of the existing policy and all other lower priority policies after it is increased by 1. + +```yaml +Type: System.Int32 +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter removes email messages from the policy if they're already included. The valid value for this parameter is All. + +If the policy already includes email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. + +You can't use this parameter if email (the value Exchange) is used by any of the associated rules. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryDistribution +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. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistributionParameterSet +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpoAipIntegrationEnabled +The SpoAipIntegrationEnabled parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: + +- $true: Users can apply your sensitivity labels in Office for the web. Users see the Sensitivity button on the ribbon so they can apply labels, and they see the name of any applied label on the status bar. +- $false: Users can't apply your sensitivity labels in Office for the web. Also, coauthoring, eDiscovery, Microsoft Purview data loss prevention, search, and other collaborative features don't work for encrypted files. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartSimulation +Use the StartSimulation parameter to restart the simulation for updated results. Valid values are: + +- $true: Restart the simulation for updated results. **Any edits to an auto-labeling policy require restarting the simulation by using this value.** +- $false: This is the default value + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance 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-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md new file mode 100644 index 0000000000..f477c1b30d --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -0,0 +1,1265 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-AutoSensitivityLabelRule + +## 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-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policy rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AutoSensitivityLabelRule [-Identity] + [-AccessScope ] + [-ActivationDate ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-Comment ] + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentExtensionMatchesWords ] + [-ContentPropertyContainsWords ] + [-DefaultSpoDocLibraryHasLabel ] + [-Disabled ] + [-DocumentCreatedBy ] + [-DocumentIsPasswordProtected ] + [-DocumentIsUnsupported ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] + [-ExceptIfAccessScope ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfContentContainsSensitiveInformation ] + [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentCreatedBy ] + [-ExceptIfDocumentIsPasswordProtected ] + [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfProcessingLimitExceeded ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderIPRanges ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExpiryDate ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] + [-HeaderMatchesPatterns ] + [-Priority ] + [-ProcessingLimitExceeded ] + [-RecipientDomainIs ] + [-ReportSeverityLevel ] + [-RuleErrorAction ] + [-SenderDomainIs ] + [-SenderIPRanges ] + [-SentTo ] + [-SentToMemberOf ] + [-SourceType ] + [-SubjectMatchesPatterns ] + [-WhatIf] + [-Workload ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-AutoSensitivityLabelRule -Identity "SocialSecurityRule1" -Comment "Example" +``` + +This example changes the rule property "Comment" with the rule name "SocialSecurityRule1" to the text "Example". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AccessScope +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. +- NotInOrganization: The rule is applied to content that's accessible outside the organization. +- None: The condition isn't used. + +```yaml +Type: AccessScope +Parameter Sets: (All) +Aliases: +Accepted values: InOrganization, NotInOrganization, None +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivationDate +{{ Fill ActivationDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentExtensionMatchesWords +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPropertyContainsWords +The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSpoDocLibraryHasLabel +{{ Fill DefaultSpoDocLibraryHasLabel Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: + +- $true: The rule is disabled. +- $false: The rule is enabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedBy +{{ Fill DocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsPasswordProtected +The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsUnsupported +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. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentNameMatchesWords +The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for whole word matches in the name of message attachments. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` + +The maximum individual word length is 128 characters. The maximum number of words is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentSizeOver +The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAccessScope +The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: + +- InOrganization: The rule isn't applied to content that's accessible inside the organization. +- NotInOrganization: The rule isn't applied to content that's accessible outside the organization. +- None: The exception isn't used. + +```yaml +Type: AccessScope +Parameter Sets: (All) +Aliases: +Accepted values: InOrganization, NotInOrganization, None +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentContainsSensitiveInformation +The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentExtensionMatchesWords +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedBy +{{ Fill ExceptIfDocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsPasswordProtected +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsUnsupported +The ExceptIfDocumentIsUnsupported parameter specifies an exception for the 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. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +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"`. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfProcessingLimitExceeded +The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: + +- $true: Look for files where scanning couldn't complete. +- $false: Don't look for files where scanning couldn't complete. + +```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 +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderIPRanges +The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingLimitExceeded +The ProcessingLimitExceeded parameter specifies a condition for the 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. +- $false: Don't look for files where scanning couldn't complete. + +```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 +``` + +### -RecipientDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSeverityLevel +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. +- Medium +- High + +```yaml +Type: RuleSeverity +Parameter Sets: (All) +Aliases: +Accepted values: Low, Medium, High, None, Informational, Information +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: + +- Ignore +- RetryThenBlock +- Blank (the value $null): This is the default value. + +```yaml +Type: PolicyRuleErrorAction +Parameter Sets: (All) +Aliases: +Accepted values: Ignore, RetryThenBlock +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIPRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use this condition in auto-sensitivity policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +{{ Fill SourceType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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 +``` + +### -Workload +The Workload parameter specifies the workload. Valid values are: + +- Exchange +- OneDriveForBusiness +- SharePoint + +```yaml +Type: Workload +Parameter Sets: (All) +Aliases: +Accepted values: Exchange, SharePoint, OneDriveForBusiness +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/client-access-servers/Set-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md similarity index 78% rename from exchange/exchange-ps/exchange/client-access-servers/Set-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md index b1a8cb2288..21d6376337 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AutodiscoverVirtualDirectory @@ -13,40 +16,49 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AutodiscoverVirtualDirectory cmdlet to configure Autodiscover virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-AutodiscoverVirtualDirectory [-Identity] - [-BasicAuthentication <$true | $false>] [-Confirm] [-DigestAuthentication <$true | $false>] - [-DomainController ] [-ExtendedProtectionFlags ] - [-ExtendedProtectionSPNList ] [-ExtendedProtectionTokenChecking ] - [-ExternalUrl ] [-InternalUrl ] [-WhatIf] [-WindowsAuthentication <$true | $false>] - [-WSSecurityAuthentication <$true | $false>] [-OAuthAuthentication <$true | $false>] [] + [-BasicAuthentication ] + [-Confirm] + [-DigestAuthentication ] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-InternalUrl ] + [-OAuthAuthentication ] + [-WhatIf] + [-WindowsAuthentication ] + [-WSSecurityAuthentication ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-AutodiscoverVirtualDirectory -Identity 'Autodiscover(Default Web Site)' -WindowsAuthentication $false -BasicAuthentication $false -DigestAuthentication $true ``` This example sets the authentication method to Digest authentication for the Autodiscover virtual directory. -### -------------------------- Example 2 -------------------------- -``` -Set-AutodiscoverVirtualDirectory -Identity 'autodiscover (default Web site)' -ExternalUrl 'http://www.contoso.com/' +### Example 2 +```powershell +Set-AutodiscoverVirtualDirectory -Identity 'autodiscover (default Web site)' -ExternalUrl 'https://www.contoso.com/' ``` In Exchange Server 2010, this example sets the external URL for the Autodiscover virtual directory. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-AutodiscoverVirtualDirectory -Identity 'Autodiscover (Default Web Site)' -WindowsAuthentication $true ``` @@ -55,23 +67,20 @@ This example sets Integrated Windows authentication for the Autodiscover virtual ## PARAMETERS ### -Identity -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 \\\Name +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -83,14 +92,14 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -101,8 +110,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -110,6 +118,7 @@ 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 @@ -121,14 +130,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,6 +153,7 @@ 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 @@ -155,13 +165,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -169,6 +175,7 @@ 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 @@ -180,14 +187,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -199,20 +206,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -221,7 +225,7 @@ Accept wildcard characters: False ``` ### -ExternalUrl -This parameter is available or functional only in 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. @@ -230,6 +234,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -238,7 +243,7 @@ Accept wildcard characters: False ``` ### -InternalUrl -This parameter is available or functional only in 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. @@ -247,6 +252,26 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OAuthAuthentication +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. +- $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 Default value: None @@ -262,6 +287,7 @@ 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 @@ -273,14 +299,14 @@ Accept wildcard characters: False 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. - - $false: Integrated Windows authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -292,33 +318,14 @@ Accept wildcard characters: False 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. - - $false: WS-Security authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean 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 -``` - -### -OAuthAuthentication -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. - -- $false: OAuth authentication is disabled. -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -327,20 +334,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/66285113-25d5-4fbf-baa9-8e65778761ad.aspx) diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md new file mode 100644 index 0000000000..7fc266524e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md @@ -0,0 +1,224 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-AvailabilityConfig cmdlet to set the access level for free/busy information. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AvailabilityConfig + [-AllowedTenantIds ] + [-Confirm] + [-DomainController ] + [-OrgWideAccount ] + [-PerUserAccount ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-AvailabilityConfig cmdlet defines two accounts or security groups: a per-user free/busy proxy account or group, and an organization-wide free/busy proxy account or group. These accounts and groups are trusted by all availability services in the current organization for availability proxy requests. + +For cross-forest availability services to retrieve free/busy information in the current forest, they must be using one of the specified accounts, belong to one of the specified security groups, or have a username and password for one of the specified accounts or security groups. + +In Exchange Online, this cmdlet lets you update the set of tenant ids that free/busy information sharing is allowed with. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AvailabilityConfig -PerUserAccount exchangeserversgroup@fabrikam.com +``` + +In on-premises Exchange, this example is useful with a trusted cross-forest Availability service. If the remote forest is trusted, and a per-user free/busy proxy account or group in the remote forest is configured to use the service account, the configuration is added to the current forest to authorize the Microsoft ActiveSync request from the remote forest. + +### Example 2 +```powershell +Set-AvailabilityConfig -OrgWideAccount orgwide@contoso.com +``` + +In on-premises Exchange, this example is useful if the remote forest isn't trusted. Because this account is used for a cross-forest free/busy proxy account or group, minimize security vulnerabilities by using the credentials of a user who doesn't have an Exchange mailbox. When you're prompted, type the username and password. + +### Example 3 +```powershell +Set-AvailabilityConfig -AllowedTenantIds "d6b0a40e-029b-43f2-9852-f3724f68ead9","87d5bade-cefc-4067-a221-794aea71922d" +``` + +In Exchange Online, this example allows free/busy sharing only with the specified tenants. + +## PARAMETERS + +### -AllowedTenantIds +This parameter is available only in the cloud-based service. + +The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. + +To replace all existing tenant IDs with the values you specify, use the following syntax: `"TenantID1","TenantID2",..."TenantID25"`. + +To add or remove tenant IDs without affecting other existing values, use the following syntax: `@{Add="TenantID1","TenantID2",...; Remove="TenantID3","TenantID4",...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -OrgWideAccount +This parameter is functional only in on-premises Exchange. + +The OrgWideAccount parameter specifies who has permission to issue proxy Availability service requests on an organization-wide basis. You can specify the following types of users or groups (security principals) for this parameter: + +- Mailbox users +- Mail users +- Security groups + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerUserAccount +This parameter is available only in on-premises Exchange. + +The PerUserAccount parameter specifies an account or security group that has permission to issue proxy Availability service requests on a per-user basis. + +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/server-health-and-performance/Set-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md similarity index 75% rename from exchange/exchange-ps/exchange/server-health-and-performance/Set-AvailabilityReportOutage.md rename to exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md index 6872d235cf..051ad1654f 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Set-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-AvailabilityReportOutage @@ -13,37 +16,41 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-AvailabilityReportOutage cmdlet to set the outages that contribute to the overall reported availability for the day. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity (Default) ``` -Set-AvailabilityReportOutage [-Identity] -Comment -ReportDate [-DowntimeMinutes ] +Set-AvailabilityReportOutage [-Identity] -Comment -ReportDate + [-DowntimeMinutes ] [-Confirm] [-Force] [-ReportingDatabase ] [-ReportingServer ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### ResetToOriginal ``` -Set-AvailabilityReportOutage [-Identity] -ReportDate [-ResetToOriginal] +Set-AvailabilityReportOutage [-Identity] -ReportDate + [-ResetToOriginal] [-Confirm] [-Force] [-ReportingDatabase ] [-ReportingServer ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-AvailabilityReportOutage -ReportDate:"2009-12-02" -Identity: "OWA Service" -Comment:"Overriding particular outage" -DowntimeMinutes:40 ``` @@ -51,33 +58,35 @@ This example overrides the specified outage with a new downtime value of 40 minu ## PARAMETERS -### -Comment -The Comment parameter describes the outage that was inserted. +### -Identity +The Identity parameter specifies the outage to add to the outage reporting. ```yaml -Type: String -Parameter Sets: Identity +Type: AvailabilityReportOutageIdParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the outage to add to the outage reporting. +### -Comment +The Comment parameter describes the outage that was inserted. ```yaml -Type: AvailabilityReportOutageIdParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -89,6 +98,7 @@ Type: ExDateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -97,13 +107,14 @@ Accept wildcard characters: False ``` ### -ResetToOriginal -The ResetToOriginal parameter specifies whether to reset the previously selected outage value to the default value. +The ResetToOriginal switch resets the previously selected outage value to the default value. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ResetToOriginal Aliases: Applicable: Exchange Server 2010 + Required: True Position: Named Default value: None @@ -114,8 +125,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -123,6 +133,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -138,6 +149,7 @@ Type: Double Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -146,13 +158,16 @@ Accept wildcard characters: False ``` ### -Force -The Force parameter suppresses the warning or confirmation messages that appear during specific configuration changes. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -168,6 +183,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -183,6 +199,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -198,6 +215,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -206,20 +224,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/75b9241f-d0d8-4c31-8800-9e98188ab2b9.aspx) diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md new file mode 100644 index 0000000000..6ff7e5c704 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -0,0 +1,1314 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-CASMailbox cmdlet to configure client access settings on a mailbox. For example, you can configure settings for Exchange ActiveSync, Outlook, Outlook on the web, POP3, and IMAP4. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-CASMailbox [-Identity] + [-ActiveSyncAllowedDeviceIDs ] + [-ActiveSyncBlockedDeviceIDs ] + [-ActiveSyncDebugLogging ] + [-ActiveSyncEnabled ] + [-ActiveSyncMailboxPolicy ] + [-ActiveSyncSuppressReadReceipt ] + [-Confirm] + [-DisplayName ] + [-DomainController ] + [-ECPEnabled ] + [-EmailAddresses ] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-HasActiveSyncDevicePartnership ] + [-IgnoreDefaultScope] + [-ImapEnabled ] + [-ImapEnableExactRFC822Size ] + [-ImapMessagesRetrievalMimeFormat ] + [-ImapForceICalForCalendarRetrievalOption ] + [-ImapSuppressReadReceipt ] + [-ImapUseProtocolDefaults ] + [-IsOptimizedForAccessibility ] + [-MacOutlookEnabled ] + [-MAPIBlockOutlookExternalConnectivity ] + [-MAPIBlockOutlookNonCachedMode ] + [-MAPIBlockOutlookRpcHttp ] + [-MAPIBlockOutlookVersions ] + [-MAPIEnabled ] + [-MapiHttpEnabled ] + [-Name ] + [-OneWinNativeOutlookEnabled ] + [-OutlookMobileEnabled ] + [-OWAEnabled ] + [-OWAforDevicesEnabled ] + [-OwaMailboxPolicy ] + [-PopEnabled ] + [-PopEnableExactRFC822Size ] + [-PopForceICalForCalendarRetrievalOption ] + [-PopMessagesRetrievalMimeFormat ] + [-PopSuppressReadReceipt ] + [-PopUseProtocolDefaults ] + [-PrimarySmtpAddress ] + [-PublicFolderClientAccess ] + [-ResetAutoBlockedDevices] + [-SamAccountName ] + [-ShowGalAsDefaultView ] + [-SmtpClientAuthenticationDisabled ] + [-UniversalOutlookEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-CASMailbox adam@contoso.com -OWAEnabled $false -PopEnabled $false +``` + +This example disables Outlook on the web and POP3 access for the user adam@contoso.com. + +### Example 2 +```powershell +Set-CASMailbox adam@contoso.com -ActiveSyncDebugLogging $true -ActiveSyncMailboxPolicy Management +``` + +This example enables Exchange ActiveSync debug logging and specifies the Exchange ActiveSync mailbox policy named Management for the user adam@contoso.com. + +### Example 3 +```powershell +Set-CASMailbox tony@contoso.com -DisplayName "Tony Smith" -MAPIBlockOutlookRpcHttp $true +``` + +This example sets the display name and disables Outlook Anywhere access for the user tony@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to configure. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -ActiveSyncAllowedDeviceIDs +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +To clear the list of device IDs, use the value $null for this parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncBlockedDeviceIDs +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +To clear the list of device IDs, use the value $null for this parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncDebugLogging +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 + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncEnabled +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. +- $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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncMailboxPolicy +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 +- Distinguished name (DN) +- GUID + +The name of the default Exchange ActiveSync mailbox policy is Default. However, to reset this parameter back to the default value, use the value $null. The value $null also changes the value of the ActiveSyncMailboxPolicyIsDefaulted property to True. If you specify the value Default for the ActiveSyncMailboxPolicy parameter, the value of the ActiveSyncMailboxPolicyIsDefaulted property remains False. + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncSuppressReadReceipt +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 ("). + +```yaml +Type: String +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ECPEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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). + +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +Type: ProxyAddressCollection +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 +``` + +### -EwsAllowEntourage +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsAllowList +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsAllowMacOutlook +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. +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsAllowOutlook +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. +- $false: Access to the mailbox using EWS in Outlook client 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsApplicationAccessPolicy +The EwsApplicationAccessPolicy parameter controls access to the mailbox using Exchange Web Services applications. + +Valid values for this parameter are: + +- EnforceAllowList: Only applications specified in the EwsAllowList parameter are allowed to access the mailbox. +- EnforceBlockList: Applications specified in the EwsBlockList parameter aren't allowed to access the mailbox, but any other applications can access the mailbox. + +This parameter doesn't affect access to the mailbox using Entourage, Outlook for Mac, and Outlook. Access to the mailbox using these clients is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsBlockList +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsEnabled +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. 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: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasActiveSyncDevicePartnership +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: + +- $true: The mailbox has an ActiveSync device partnership. +- $false: The mailbox does not have an ActiveSync device partnership. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -ImapEnabled +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. +- $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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImapEnableExactRFC822Size +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. + +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. + +```yaml +Type: Boolean +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 +``` + +### -ImapForceICalForCalendarRetrievalOption +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. + +To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImapMessagesRetrievalMimeFormat +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 +- 1: HtmlOnly +- 2: HtmlAndTextAlternative +- 3: TextEnrichedOnly +- 4: TextEnrichedAndTextAlternative +- 5: BestBodyFormat (this is the default value) +- 6: Tnef + +To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImapSuppressReadReceipt +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. + +To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImapUseProtocolDefaults +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. +- $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: + +- ImapEnableExactRFC822Size +- ImapForceICalForCalendarRetrievalOption +- ImapMessagesRetrievalMimeFormat +- ImapSuppressReadReceipt + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOptimizedForAccessibility +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: + +- $true: The mailbox is configured to use the light version of Outlook on the web. +- $false: The mailbox isn't configured to use the light version of Outlook on the web. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacOutlookEnabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MAPIBlockOutlookNonCachedMode +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. + +```yaml +Type: Boolean +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 +``` + +### -MAPIBlockOutlookExternalConnectivity +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: + +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MAPIBlockOutlookRpcHttp +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. + +```yaml +Type: Boolean +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 +``` + +### -MAPIBlockOutlookVersions +This parameter is available only in on-premises Exchange. + +The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. + +For example, if you specify the value 15.0.4569, only Outlook 2013 Service Pack 1 (SP1) or later clients are allowed to access the mailbox. Earlier versions of Outlook are blocked. + +The default value is blank. To reset this parameter, use the value $null. + +```yaml +Type: String +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 +``` + +### -MAPIEnabled +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. +- $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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapiHttpEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 ("). + +```yaml +Type: String +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 +``` + +### -OneWinNativeOutlookEnabled +This parameter is available only in the cloud-based service. + +The OneWinNativeOutlookEnabled parameter enables or disables access to the mailbox using the new Outlook for Windows. +Valid values are: + +- $true: Access to the mailbox using the new Outlook for Windows is enabled. This is the default value. +- $false: Access to the mailbox using the new Outlook for Windows is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookMobileEnabled +This parameter is available only in the cloud-based service. + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAEnabled +The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: + +- $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. +- $false: Access to the mailbox using Outlook on the web 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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAforDevicesEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwaMailboxPolicy +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 +- Distinguished name (DN) +- GUID + +The name of the default Outlook on the web mailbox policy is Default. + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopEnabled +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. +- $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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopEnableExactRFC822Size +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 + +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. + +```yaml +Type: Boolean +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 +``` + +### -PopForceICalForCalendarRetrievalOption +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. + +To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopMessagesRetrievalMimeFormat +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 +- 1: HtmlOnly +- 2: HtmlAndTextAlternative +- 3: TextEnrichedOnly +- 4: TextEnrichedAndTextAlternative +- 5: BestBodyFormat (this is the default value) +- 6: Tnef + +To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopSuppressReadReceipt +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. + +To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopUseProtocolDefaults +The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. Valid values are: + +- $true: Use the protocol defaults for POP3 access to the mailbox. This is the default value. +- $false: Use custom protocol settings for POP3 access to the mailbox. + +You need to set this parameter to $false when you use any of following parameters: + +- PopEnableExactRFC822Size +- PopForceICalForCalendarRetrievalOption +- PopMessagesRetrievalMimeFormat +- PopSuppressReadReceipt + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +This parameter is available only in on-premises Exchange. + +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +```yaml +Type: SmtpAddress +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 +``` + +### -PublicFolderClientAccess +The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: + +- $true: The user can access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true (the default value is $false). +- $false: The user can't access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: $false +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetAutoBlockedDevices +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +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 +``` + +### -ShowGalAsDefaultView +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpClientAuthenticationDisabled +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: + +- POP3 and IMAP4 clients. +- Devices with scan to email capability. +- Workflow applications that send email notifications. +- Online services that send messages using internal email addresses in the organization. + +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. + +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniversalOutlookEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md new file mode 100644 index 0000000000..5901e16225 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan +applicable: Exchange Online, Exchange Online Protection +title: Set-CASMailboxPlan +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-CASMailboxPlan + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-CASMailboxPlan cmdlet to modify Client Access services (CAS) mailbox plans in cloud-based organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-CASMailboxPlan [-Identity] + [-ActiveSyncEnabled ] + [-Confirm] + [-ECPEnabled ] + [-EwsEnabled ] + [-ImapEnabled ] + [-MAPIEnabled ] + [-OWAEnabled ] + [-OwaMailboxPolicy ] + [-PopEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-CASMailboxPlan -Identity ExchangeOnlineEnterprise -ActiveSyncEnabled $false -PopEnabled $false +``` + +This example disables Exchange ActiveSync and POP3 access to mailboxes in the CAS mailbox plan named ExchangeOnlineEnterprise. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example: + +- Name +- Distinguished name (DN) +- GUID + +The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, `ExchangeOnlineEnterprise` and `ExchangeOnlineEnterprise-`, respectively). + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveSyncEnabled +The ActiveSyncEnabled parameter enables or disables access to the mailbox by using Exchange Active Sync (EAS). Valid values are: + +- $true: ActiveSync access to the mailbox is enabled. This is the default value. +- $false: ActiveSync access to the mailbox is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ECPEnabled +{{ Fill ECPEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsEnabled +{{ Fill EwsEnabled Description }} + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImapEnabled +The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. Valid values are: + +- $true: IMAP4 access to the mailbox is enabled. This is default value for all CAS mailbox plans except ExchangeOnlineDeskless. +- $false: IMAP4 access to the mailbox is disabled. This is default value for ExchangeOnlineDeskless. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MAPIEnabled +{{ Fill MAPIEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAEnabled +{{ Fill OWAEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwaMailboxPolicy +The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailbox. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +The default value is OwaMailboxPolicy-Default. + +You can use the Get-OwaMailboxPolicy cmdlet to view the available Outlook on the web mailbox policies. + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopEnabled +The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Valid values are: + +- $true: POP3 access to the mailbox is enabled. This is the default value. +- $false: POP3 access to the mailbox is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-CalendarNotification.md b/exchange/exchange-ps/exchange/Set-CalendarNotification.md new file mode 100644 index 0000000000..29fe0d712f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CalendarNotification.md @@ -0,0 +1,301 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-CalendarNotification + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +The Set-CalendarNotification cmdlet allows users to set text message notification options for calendar events in their own calendar. By default, the MyTextMessaging end-user role gives access to this cmdlet, so admins can't configure text messaging notification for calendar events in user calendars. + +**Note**: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-CalendarNotification [-Identity] + [-CalendarUpdateNotification ] + [-CalendarUpdateSendDuringWorkHour ] + [-Confirm] + [-DailyAgendaNotification ] + [-DailyAgendaNotificationSendTime ] + [-DomainController ] + [-IgnoreDefaultScope] + [-MeetingReminderNotification ] + [-MeetingReminderSendDuringWorkHour ] + [-NextDays ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-CalendarNotification -Identity "TonySmith" -CalendarUpdateNotification $true -MeetingReminderNotification $true -MeetingReminderSendDuringWorkHour $true -DailyAgendaNotification $true +``` + +This example configures the calendar in Tony's mailbox to send the following text message notifications to his mobile device: + +- Calendar updates. +- Meeting reminders during business hours. +- Daily agendas. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CalendarUpdateNotification +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. + +```yaml +Type: Boolean +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 +``` + +### -CalendarUpdateSendDuringWorkHour +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. + +```yaml +Type: Boolean +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 +``` + +### -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 +``` + +### -DailyAgendaNotification +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. + +```yaml +Type: Boolean +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 +``` + +### -DailyAgendaNotificationSendTime +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. + +The default value is 08:00:00. + +```yaml +Type: TimeSpan +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 +``` + +### -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 +``` + +### -IgnoreDefaultScope +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingReminderNotification +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. + +```yaml +Type: Boolean +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 +``` + +### -MeetingReminderSendDuringWorkHour +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. + +```yaml +Type: Boolean +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 +``` + +### -NextDays +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md new file mode 100644 index 0000000000..edc2b0bc9a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md @@ -0,0 +1,1049 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-CalendarProcessing cmdlet to modify calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant, and calendar configuration. Note that this cmdlet is effective only on resource mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-CalendarProcessing [-Identity] + [-AddAdditionalResponse ] + [-AdditionalResponse ] + [-AddNewRequestsTentatively ] + [-AddOrganizerToSubject ] + [-AllBookInPolicy ] + [-AllowConflicts ] + [-AllowRecurringMeetings ] + [-AllRequestInPolicy ] + [-AllRequestOutOfPolicy ] + [-AutomateProcessing ] + [-BookingType ] + [-BookingWindowInDays ] + [-BookInPolicy ] + [-Confirm] + [-ConflictPercentageAllowed ] + [-DeleteAttachments ] + [-DeleteComments ] + [-DeleteNonCalendarItems ] + [-DeleteSubject ] + [-DomainController ] + [-EnableAutoRelease ] + [-EnableResponseDetails ] + [-EnforceCapacity ] + [-EnforceSchedulingHorizon ] + [-ForwardRequestsToDelegates ] + [-IgnoreDefaultScope] + [-MaximumConflictInstances ] + [-MaximumDurationInMinutes ] + [-MinimumDurationInMinutes ] + [-OrganizerInfo ] + [-PostReservationMaxClaimTimeInMinutes ] + [-ProcessExternalMeetingMessages ] + [-RemoveCanceledMeetings ] + [-RemoveForwardedMeetingNotifications ] + [-RemoveOldMeetingMessages ] + [-RemovePrivateProperty ] + [-RequestInPolicy ] + [-RequestOutOfPolicy ] + [-ResourceDelegates ] + [-ScheduleOnlyDuringWorkHours ] + [-TentativePendingApproval ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-CalendarProcessing -Identity "Conf 212" -AutomateProcessing AutoAccept -DeleteComments $true -AddOrganizerToSubject $true -AllowConflicts $false +``` + +This example automates the processing of calendar requests to the resource mailbox Conf 212. + +### Example 2 +```powershell +Set-CalendarProcessing -Identity "Car 53" -AutomateProcessing None +``` + +This example disables automatic processing for the resource mailbox Car 53. + +### Example 3 +```powershell +Set-CalendarProcessing -Identity "5th Floor Conference Room" -AutomateProcessing AutoAccept -AllBookInPolicy $true +``` + +This example allows the Calendar Attendant to approve in-policy requests from all users. + +### Example 4 +```powershell +Set-CalendarProcessing -Identity "5th Floor Conference Room" -AutomateProcessing AutoAccept -AllRequestInPolicy $true -AllBookInPolicy $false -ResourceDelegates "chris@contoso.com","michelle@contoso.com" +``` + +This example allows all users to submit in-policy requests, but the request is still subject to approval by one of the specified delegates. + +### Example 5 +```powershell +Set-CalendarProcessing -Identity "Room 221" -AutomateProcessing AutoAccept -RequestOutOfPolicy DavidPelton@contoso.com -ResourceDelegates "chris@contoso.com","michelle@contoso.com" +``` + +This example allows the Calendar Attendant to accept out-of-policy requests from David Pelton. The request is still subject to approval by one of the specified delegates. + +### Example 6 +```powershell +Set-CalendarProcessing -Identity "Car 53" -AutomateProcessing AutoAccept -BookInPolicy "ayla@contoso.com","tony@contoso.com" -AllBookInPolicy $false +``` + +This example allows a list of users to submit in-policy meeting requests to the equipment mailbox for Car 53. + +The users you specify for the BookInPolicy using this syntax overwrite any existing values. + +### Example 7 +```powershell +$CurrentBIP = (Get-CalendarProcessing -Identity "Conference Room 1").BookInPolicy + +$AddToBIP = "shiraz@contoso.com","chris@contoso.com" + +$UpdatedBIP = $CurrentBIP + $AddToBIP + +Set-CalendarProcessing -Identity "Conference Room 1" -BookInPolicy $UpdatedBIP +``` + +This example adds Shiraz and Chris to the BookInPolicy of the room mailbox named Conference Room 1 without affecting any existing BookInPolicy values. + +The first command retrieves the current BookInPolicy values of Conference Room 1 and stores them in a variable. + +The next two commands identify the new users to add to the BookInPolicy, combine the old and new values, and store the updated list a variable. + +The last command updates the BookInPolicy value with the combined list. + +### Example 8 +```powershell +$group = New-DistributionGroup "Room 221 Booking Allowed" + +Update-DistributionGroupMember -Identity $group.Identity -Members karina@contoso.com,tony@contoso.com -BypassSecurityGroupManagerCheck:$true + +Set-CalendarProcessing -Identity "Room 221" -AutomateProcessing AutoAccept -BookInPolicy $group.Identity -AllBookInPolicy $false +``` + +This example rejects meeting requests from any user who isn't a member of the "Room 221 Booking Allowed" distribution group. + +### Example 9 +```powershell +Set-CalendarProcessing -Identity "Room 221" -ProcessExternalMeetingMessages $false +``` + +This example rejects meeting requests from any user who isn't a member of the Exchange organization. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -AddAdditionalResponse +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. + +This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalResponse +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddNewRequestsTentatively +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOrganizerToSubject +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. +- $false: The original Subject value is preserved. + +This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. + +**Note**: Default Calendar folder permissions use the AvailabilityOnly role, which doesn't allow viewing Subject fields in meeting requests. At a minimum, the LimitedDetails role is required to view Subject fields in meeting requests. Use the **\*-MailboxFolderPermission** cmdlets to manage mailbox folder permissions. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +``` + +### -AllBookInPolicy +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowConflicts +The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: + +- $true: Conflicts are allowed. A recurring meeting series is accepted regardless of whether any occurrences conflict with existing bookings. The values of the ConflictPercentageAllowed or MaximumConflictInstances parameters are ignored. +- $false: Conflicts aren't allowed. This is the default value. Whether an entire series is declined depends on the amount of conflicts in the series: + + • The series is declined if the number or percentage of conflicts is higher than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. + + • The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer will receive a notification email for each declined occurrence. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRecurringMeetings +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllRequestInPolicy +The AllRequestInPolicy parameter specifies whether to allow all users to submit in-policy requests to the resource mailbox. Valid values are: + +- $true: All users are allowed to submit in-policy requests to the resource mailbox. These requests require approval by a resource mailbox delegate if the AllBookInPolicy parameter is set to $false (the default value of AllBookInPolicy is $true). +- $false: All users can't submit in-policy requests to the resource mailbox. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllRequestOutOfPolicy +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomateProcessing +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. +- AutoUpdate: Only the Calendar Attendant processes meeting requests and responses. Meeting requests are tentative in the calendar until they're approved by a delegate. Meeting organizers receive only decisions from delegates. +- AutoAccept: Both the Calendar Attendant and resource booking attendant are enabled on the mailbox. This means that the Calendar Attendant updates the calendar, and then the resource booking assistant accepts the meeting based upon the policies. Eligible meeting organizers receive the decision directly without human intervention (free = accept; busy = decline). + +In on-premises Exchange, resource mailboxes created in the Exchange admin center (EAC) have the default value AutoAccept, while resource mailboxes created in PowerShell have the default value AutoUpdate. + +In Exchange Online, resource mailbox created in the EAC and resource mailboxes created in PowerShell after November 15, 2018 have the default value AutoAccept. Resource mailboxes created in PowerShell before November 15 have the default value AutoUpdate. + +The default value for user mailboxes is AutoUpdate, but you can't change the value on a user mailbox. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingType +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 +- Reserved: The resource can't be reserved. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingWindowInDays +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookInPolicy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +Query-based groups (for example, dynamic distribution groups) aren't supported. + +In delegate and principal scenarios, if the delegate or principal is specified by the BookInPolicy parameter, in-policy meeting requests to the resource mailbox are automatically approved. + +To replace the existing list of users or groups with the values you specify, use the syntax `UserOrGroup1,UserOrGroup2,...UserOrGroupN`. If the values contain spaces or otherwise require quotation marks, use the syntax `"UserOrGroup1","UserOrGroup2",..."UserOrGroupN"`. + +To add users or groups without affecting the other entries, see Example 7. + +```yaml +Type: RecipientIdParameter[] +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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictPercentageAllowed +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAttachments +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. +- $false: Preserve any attachments in incoming messages. + +This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteComments +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. +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteNonCalendarItems +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSubject +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. +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoRelease +This parameter is available only in the cloud-based service. + +{{ Fill EnableAutoRelease Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableResponseDetails +The EnableResponseDetails parameter specifies whether to include the reasons for accepting or declining a meeting in the response email message. Valid values are: + +- $true: The reasons for accepting or declining a meeting are included in the response message. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceCapacity +This parameter is available only in the cloud-based service. + +The EnforceCapacity parameter specifies whether to restrict the number of attendees to the capacity of the workspace. For example, if capacity is set to 10, then only 10 people can book the workspace. Valid values are: + +- $true: Capacity is enforced. +- $false: Capacity is not enforced. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceSchedulingHorizon +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardRequestsToDelegates +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -MaximumConflictInstances +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumDurationInMinutes +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumDurationInMinutes +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. + +For recurring meetings, the value of this parameter applies to the length of an individual meeting instance. + +This parameter only works on workspace mailboxes. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizerInfo +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostReservationMaxClaimTimeInMinutes +This parameter is available only in the cloud-based service. + +{{ Fill PostReservationMaxClaimTimeInMinutes Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessExternalMeetingMessages +The ProcessExternalMeetingMessages parameter specifies whether to process meeting requests that originate outside the Exchange organization. Valid values are: + +- $true: Meeting requests from external senders are processed. +- $false: Meeting requests from external senders are rejected. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveCanceledMeetings +This parameter is available only in the cloud-based service. + +The RemoveCanceledMeetings parameter specifies whether to automatically delete meetings that were cancelled by the organizer from the resource mailbox's calendar. Valid values are: + +- $true: Canceled meetings are deleted. +- $false: Canceled meetings aren't deleted. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveForwardedMeetingNotifications +The RemoveForwardedMeetingNotifications parameter specifies whether forwarded meeting notifications are moved to the Deleted Items folder after they're processed by the Calendar Attendant. Valid values are: + +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOldMeetingMessages +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePrivateProperty +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestInPolicy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -RequestOutOfPolicy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ResourceDelegates +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ScheduleOnlyDuringWorkHours +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. + +You configure the working hours of the resource mailbox by using the WorkDays, WorkingHoursStartTime, WorkingHoursEndTime and WorkingHoursTimeZone parameters on the Set-MailboxCalendarConfiguration cmdlet. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TentativePendingApproval +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md new file mode 100644 index 0000000000..db1f2c2ede --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -0,0 +1,333 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-CaseHoldPolicy + +## 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-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. + +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### RetryDistribution +``` +Set-CaseHoldPolicy [-Identity] + [-RetryDistribution] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Set-CaseHoldPolicy [-Identity] + [-AddExchangeLocation ] + [-AddPublicFolderLocation ] + [-AddSharePointLocation ] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-RemoveExchangeLocation ] + [-RemovePublicFolderLocation ] + [-RemoveSharePointLocation ] + [-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). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}`. + +## EXAMPLES + +### Example 1 +```powershell +Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14" +``` + +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 site `https://contoso.sharepoint.com/sites/teams/finance`. +- Removes public folders. +- Updates the comment. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RetryDistribution +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. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use the following values: + +- Name +- SMTP address. To specify an inactive mailbox, precede the address with a period (.). +- Microsoft Entra ObjectId. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) or [Get-MgGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.groups/get-mggroup) cmdlets in Microsoft Graph PowerShell to find this value. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- SMTP address. To specify an inactive mailbox, precede the address with a period (.). +- Microsoft Entra ObjectId. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) or [Get-MgGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.groups/get-mggroup) cmdlets in Microsoft Graph PowerShell to find this value. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-CaseHoldRule.md b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md new file mode 100644 index 0000000000..3935336a80 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md @@ -0,0 +1,164 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-CaseHoldRule + +## 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-CaseHoldRule cmdlet to modify existing case hold rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-CaseHoldRule [-Identity] + [-Comment ] + [-Confirm] + [-ContentMatchQuery ] + [-Disabled ] + [-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-CaseHoldRule -Identity "Internal Company Rule" -Disabled $true +``` + +This example disables the enabled case hold rule named "Internal Company Rule". + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md new file mode 100644 index 0000000000..1848e06aee --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-ClassificationRuleCollection cmdlet to update existing classification rule collections in your organization. + +In the Microsoft Purview compliance portal, use the Set-DlpSensitiveInformationTypeRulePackage cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ClassificationRuleCollection [-FileData] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ClassificationRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Classification Rule Collection.xml')) +``` + +This example imports the classification rule collection file C:\\My Documents\\External Classification Rule Collection.xml. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the classification rule collection file you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access-servers/Set-ClientAccessArray.md b/exchange/exchange-ps/exchange/Set-ClientAccessArray.md similarity index 78% rename from exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessArray.md rename to exchange/exchange-ps/exchange/Set-ClientAccessArray.md index 4d125c9126..caa657f795 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessArray.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ClientAccessArray @@ -13,36 +16,42 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ClientAccessArray cmdlet to modify RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ClientAccessArray [-Identity] [-Confirm] [-DomainController ] - [-Fqdn ] [-Name ] [-Site ] [-WhatIf] [] +Set-ClientAccessArray [-Identity] + [-Confirm] + [-DomainController ] + [-Fqdn ] + [-Name ] + [-Site ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ClientAccessArray -Identity "ContosoArray" -Name "CASArray" ``` This example changes the names the name of the existing Client Access array named ContosoArray to CASArray. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-ClientAccessArray -Identity "ContosoArray" -FQDN "casarrayeu.contoso.com" ``` This example changes the fully qualified domain name of the existing Client Access array named ContosoArray to casarrayeu.contoso.com. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-ClientAccessArray -Identity "ContosoArray" -Site "SiteEU" ``` @@ -51,16 +60,12 @@ This example associates the existing Client Access array named ContosoArray with ## PARAMETERS ### -Identity -The Identity parameter specifies the Client Access array that you want to modify. You can use these values: +The Identity parameter specifies the Client Access array that you want to modify. You can use these values: - Name (if the value doesn't contain spaces) - - Distinguished name (DN) - - ExchangeLegacyDN - - Fully qualified domain name (FQDN) - - GUID ```yaml @@ -68,6 +73,7 @@ Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -78,8 +84,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -87,6 +92,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -102,6 +108,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -117,6 +124,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -132,6 +140,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -140,12 +149,10 @@ Accept wildcard characters: False ``` ### -Site -The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: +The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name - - Distinguished name (DN) - - GUID To see a list of available sites, use the Get-ADSite cmdlet. @@ -155,6 +162,7 @@ Type: AdSiteIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -170,6 +178,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -178,20 +187,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d8682149-2822-4a6d-ac54-e4898f89a633.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md new file mode 100644 index 0000000000..9a82144d26 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md @@ -0,0 +1,606 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ClientAccessRule + +## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ClientAccessRule [-Identity] + [-Action ] + [-AnyOfAuthenticationTypes ] + [-AnyOfClientIPAddressesOrRanges ] + [-AnyOfProtocols ] + [-AnyOfSourceTcpPortNumbers ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExceptAnyOfAuthenticationTypes ] + [-ExceptAnyOfClientIPAddressesOrRanges ] + [-ExceptAnyOfProtocols ] + [-ExceptAnyOfSourceTcpPortNumbers ] + [-ExceptUserIsMemberOf ] + [-ExceptUsernameMatchesAnyOfPatterns ] + [-Name ] + [-Priority ] + [-Scope ] + [-UserIsMemberOf ] + [-UsernameMatchesAnyOfPatterns ] + [-UserRecipientFilter ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. + +**Note**: Not all protocols support authentication type filters, and even protocols that support authentication type filters don't support all authentication types. The supported combinations are described in the following lists. Use caution when mixing protocols and authentication types in the same rule. + +Protocols that support authentication type filters: + +- ExchangeActiveSync: BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. +- ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. +- IMAP4: BasicAuthentication and OAuthAuthentication. +- OutlookWebApp: BasicAuthentication and AdfsAuthentication. +- POP3: BasicAuthentication and OAuthAuthentication. +- RemotePowerShell: BasicAuthentication and NonBasicAuthentication. + +Protocols that don't support authentication type filters: + +- ExchangeWebServices +- OfflineAddressBook +- OutlookAnywhere +- PowerShellWebServices +- REST +- UniversalOutlook + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ClientAccessRule "Allow IMAP4" -AnyOfClientIPAddressesOrRanges @{Add="172.17.17.27/16"} +``` + +This example adds the IP address range 172.17.17.27/16 to the existing client access rule named Allow IMAP4 without affecting the existing IP address values. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Action +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfAuthenticationTypes +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. + +Valid values for this parameter are: + +- AdfsAuthentication +- BasicAuthentication +- CertificateBasedAuthentication +- NonBasicAuthentication +- OAuthAuthentication + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfClientIPAddressesOrRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254 or 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:DB8::2AA:FF:C0A8:640A/64. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfProtocols +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: + +- ExchangeActiveSync +- ExchangeAdminCenter +- ExchangeWebServices +- IMAP4 +- OfflineAddressBook +- OutlookAnywhere +- OutlookWebApp +- POP3 +- PowerShellWebServices +- RemotePowerShell +- REST +- UniversalOutlook (Mail and Calendar app) + +**Note**: In Exchange 2019, the only supported values are ExchangeAdminCenter and RemotePowerShell. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfSourceTcpPortNumbers +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfAuthenticationTypes +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. + +Valid values for this parameter are: + +- AdfsAuthentication +- BasicAuthentication +- CertificateBasedAuthentication +- NonBasicAuthentication +- OAuthAuthentication + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfClientIPAddressesOrRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254 or 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:DB8::2AA:FF:C0A8:640A/64. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfProtocols +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. + +Valid values for this parameter are: + +- ExchangeActiveSync +- ExchangeAdminCenter +- ExchangeWebServices +- IMAP4 +- OfflineAddressBook +- OutlookAnywhere +- OutlookWebApp +- POP3 +- PowerShellWebServices +- RemotePowerShell +- REST +- UniversalOutlook (Mail and Calendar app) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptAnyOfSourceTcpPortNumbers +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptUserIsMemberOf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptUsernameMatchesAnyOfPatterns +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. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The Scope parameter specifies the scope of the client access rule. Valid values are: + +- Users: The rule only applies to end-user connections. +- All: The rule applies to all connections (end-users and middle-tier apps). + +```yaml +Type: ClientAccessRulesScope +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIsMemberOf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsernameMatchesAnyOfPatterns +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. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserRecipientFilter +This parameter is functional only in the cloud-based service. + +The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. + +You can use the following properties with this parameter: + +- City +- Company +- CountryOrRegion (ISO 3166-1 alpha-2 country code.) +- CustomAttribute1 to CustomAttribute15 +- Department +- Office +- PostalCode +- StateOrProvince +- StreetAddress + +The basic syntax for this parameter is `"Property -ComparisonOperator 'Value'"`: + +- Property is one of the filterable properties in the list above (for example `City` or `CustomAttribute1`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. + +For example: + +- `"City -eq 'Redmond'"` +- `"CountryOrRegion -eq 'SG'"`. + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example: + +- `"CustomAttribute1 -eq 'AllowOWA' -and CountryOrRegion -eq AU'"` +- `"(CountryOrRegion -eq 'US' -and Department -eq 'Sales') -or Department -eq 'Research'"`. + +For detailed information about OPATH filter syntax in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md new file mode 100644 index 0000000000..343bf8d337 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md @@ -0,0 +1,401 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ClientAccessServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ClientAccessServer cmdlet to modify settings that are associated with the Client Access server role. + +**Note**: In Exchange 2013 or later, use the Set-ClientAccessService cmdlet instead. If you have scripts that use Set-ClientAccessServer, update them to use Set-ClientAccessService. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AlternateServiceAccount +``` +Set-ClientAccessServer [-Identity] + [-AlternateServiceAccountCredential ] + [-CleanUpInvalidAlternateServiceAccountCredentials] + [-Confirm] + [-DomainController ] + [-IrmLogEnabled ] + [-IrmLogMaxAge ] + [-IrmLogMaxDirectorySize ] + [-IrmLogMaxFileSize ] + [-IrmLogPath ] + [-IsOutOfService ] + [-RemoveAlternateServiceAccountCredentials] + [-WhatIf] + [] +``` + +### Identity +``` +Set-ClientAccessServer [-Identity] + [-Array ] + [-AutoDiscoverServiceInternalUri ] + [-AutoDiscoverSiteScope ] + [-Confirm] + [-DomainController ] + [-IrmLogEnabled ] + [-IrmLogMaxAge ] + [-IrmLogMaxDirectorySize ] + [-IrmLogMaxFileSize ] + [-IrmLogPath ] + [-IsOutOfService ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ClientAccessServer -Identity "MBX-01" -AutoDiscoverServiceInternalUri "https://mbx01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" +``` + +This example configures the internal Autodiscover URL for the Active Directory site named Mail in the client access services on the server named MBX-01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- FQDN +- GUID + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AlternateServiceAccountCredential +The AlternateServiceAccountCredential parameter specifies an alternative service account username and password that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. You can specify multiple values separated by commas. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential[] +Parameter Sets: AlternateServiceAccount +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 +``` + +### -Array +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDiscoverServiceInternalUri +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDiscoverSiteScope +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. + +To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +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 +``` + +### -CleanUpInvalidAlternateServiceAccountCredentials +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -IrmLogEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogMaxAge +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. + +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 a 15-hour interval, enter 15:00:00. The default value is 30 days (30.00:00:00). + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogMaxDirectorySize +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. + +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). + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogMaxFileSize +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. + +A valid value is a number up to 4 gigabytes (4294967296 bytes). The default value is 10 megabytes (10485760 bytes). + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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. + +```yaml +Type: ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogPath +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. + +```yaml +Type: LocalLongFullPath +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOutOfService +This parameter is available only in Exchange Server 2010. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAlternateServiceAccountCredentials +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Set-ClientAccessService.md b/exchange/exchange-ps/exchange/Set-ClientAccessService.md new file mode 100644 index 0000000000..bff2cc0183 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ClientAccessService.md @@ -0,0 +1,244 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ClientAccessService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ClientAccessService cmdlet to modify settings that are associated with the Client Access server role. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AlternateServiceAccount +``` +Set-ClientAccessService [-Identity] + [-AlternateServiceAccountCredential ] + [-CleanUpInvalidAlternateServiceAccountCredentials] + [-RemoveAlternateServiceAccountCredentials] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +### Identity +``` +Set-ClientAccessService [-Identity] + [-Array ] + [-AutoDiscoverServiceInternalUri ] + [-AutoDiscoverSiteScope ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ClientAccessService -Identity "MBX-01" -AutoDiscoverServiceInternalUri "https://mbx01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" +``` + +This example configures the internal Autodiscover URL for the Active Directory site named Mail in the Client Access service on the server named MBX-01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- FQDN +- GUID + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AlternateServiceAccountCredential +The AlternateServiceAccountCredential parameter specifies an alternative service account that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential[] +Parameter Sets: AlternateServiceAccount +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Array +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDiscoverServiceInternalUri +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDiscoverSiteScope +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. + +To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CleanUpInvalidAlternateServiceAccountCredentials +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAlternateServiceAccountCredentials +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Clutter.md b/exchange/exchange-ps/exchange/Set-Clutter.md new file mode 100644 index 0000000000..980d6d409c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-Clutter.md @@ -0,0 +1,115 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-Clutter + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-Clutter cmdlet to configure Clutter settings for mailboxes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-Clutter -Identity + [-Enable ] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-Clutter -Identity "Alexander Martinez" -Enable $false +``` + +This example disables Clutter for the user Alexander Martinez. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +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. +- $false: Clutter is disabled for the mailbox. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Set-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md similarity index 80% rename from exchange/exchange-ps/exchange/organization/Set-CmdletExtensionAgent.md rename to exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md index fcdd0e01c8..4fcef9f94d 100644 --- a/exchange/exchange-ps/exchange/organization/Set-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-CmdletExtensionAgent @@ -13,13 +16,18 @@ This cmdlet is available only in on-premises Exchange. Use the Set-CmdletExtensionAgent cmdlet to modify cmdlet extension agents. To enable or disable cmdlet extension agents, use the Enable-CmdletExtensionAgent and Disable-CmdletExtensionAgent cmdlets. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-CmdletExtensionAgent [-Identity] [-Confirm] [-DomainController ] - [-Name ] [-Priority ] [-WhatIf] [] +Set-CmdletExtensionAgent [-Identity] + [-Confirm] + [-DomainController ] + [-Name ] + [-Priority ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,12 +35,12 @@ Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and The changes that you make by using the Set-CmdletExtensionAgent cmdlet are applied to every Exchange server in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-CmdletExtensionAgent "Validation Agent" -Priority 9 ``` @@ -44,9 +52,7 @@ This example changes the priority of the fictitious "Validation Agent" cmdlet ex 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 - - Distinguished name (DN) - - GUID ```yaml @@ -54,6 +60,7 @@ Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -64,8 +71,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -73,6 +79,7 @@ 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 @@ -88,6 +95,7 @@ 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 @@ -103,6 +111,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,6 +127,7 @@ Type: Byte Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -133,6 +143,7 @@ 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 @@ -141,20 +152,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2eebd4fc-0496-46e3-a3c1-60f75d680b4d.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ComplianceCase.md b/exchange/exchange-ps/exchange/Set-ComplianceCase.md new file mode 100644 index 0000000000..2975872e51 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ComplianceCase.md @@ -0,0 +1,226 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-ComplianceCase + +## 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-ComplianceCase cmdlet to modify eDiscovery cases in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ComplianceCase [-Identity] + [-CaseType ] + [-Close] + [-Confirm] + [-Description ] + [-DomainController ] + [-ExternalId ] + [-Name ] + [-Reopen] + [-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-ComplianceCase -Identity "Fabrikam Litigation" -Description "For details, contact the Laura at the Contoso law firm" -ExternalId "Case number: 03092020" +``` + +This example adds a description and case Id to the existing eDiscovery case named Fabrikam Litigation. + +## PARAMETERS + +### -Identity +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 +- Identity (GUID value) + +```yaml +Type: ComplianceCaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CaseType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ComplianceCaseType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Close +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 +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 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 +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 +``` + +### -ExternalId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reopen +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 +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-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md new file mode 100644 index 0000000000..095fd20c7a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-ComplianceRetentionEventType + +## 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-ComplianceRetentionEventType cmdlet to modify retention event types in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ComplianceRetentionEventType -Identity + [-Comment ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ComplianceRetentionEventType -Identity "Fabrikam Project" -Comment "Case officer is Pedro Pizarro" +``` + +This example add a comment to the retention event type named Fabrikam Project + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-ComplianceSearch.md b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md new file mode 100644 index 0000000000..2f6e6859f5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md @@ -0,0 +1,631 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-ComplianceSearch cmdlet to modify non-running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ComplianceSearch [-Identity] + [-AddExchangeLocation ] + [-AddExchangeLocationExclusion ] + [-AddSharePointLocation ] + [-AddSharePointLocationExclusion ] + [-AllowNotFoundExchangeLocationsEnabled ] + [-Confirm] + [-ContentMatchQuery ] + [-Description ] + [-ExchangeLocation ] + [-ExchangeLocationExclusion ] + [-Force] + [-HoldNames ] + [-IncludeOrgContent ] + [-IncludeUserAppContent ] + [-Language ] + [-Name ] + [-PublicFolderLocation ] + [-RefinerNames ] + [-RemoveExchangeLocation ] + [-RemoveExchangeLocationExclusion ] + [-RemovePublicFolderLocation ] + [-RemoveSharePointLocation ] + [-RemoveSharePointLocationExclusion ] + [-SharePointLocation ] + [-SharePointLocationExclusion ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ComplianceSearch -Identity "Project X" -ExchangeLocation All +``` + +This example changes the existing compliance search named Project X. The scope of the Exchange search is changed to all mailboxes. + +### Example 2 +```powershell +Set-ComplianceSearch -Identity "Contoso Case Search 1" -HoldNames All -ExchangeLocation $null -SharePointLocation $null +``` + +This example changes an existing compliance search that's associated with an eDiscovery case in the Microsoft Purview compliance portal. The scope of the search is changed from searching selected mailboxes and SharePoint sites to searching all content locations that have been placed on hold in the eDiscovery case. + +### Example 3 +```powershell +Set-ComplianceSearch -Identity "China Subsidiary Search" -Language zh-CN +``` + +This example changes the language setting for an existing compliance search to Chinese. + +You might have to change the language setting if you're using non-English keywords in the search query (which is specified in the ContentMatchQuery parameter). + +## PARAMETERS + +### -Identity +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: + +- Name +- JobRunId (GUID) + +You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status + +```yaml +Type: ComplianceSearchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocationExclusion +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: + +- A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +This parameter is available only in the cloud-based service. + +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"`. + +```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 +``` + +### -AddSharePointLocationExclusion +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -AllowNotFoundExchangeLocationsEnabled +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. + +The mailbox types that are affected by the value of this parameter include: + +- Inactive mailboxes +- Users without an Exchange Online license who use Office applications +- Guest users +- On-premises users whose identity is synchronized with your Microsoft 365 organization + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +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. +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). +- The value All for all mailboxes. You can only use this value by itself. + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocationExclusion +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: + +- A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldNames +This parameter is available only in the cloud-based service. + +The HoldNames parameter specifies that the content locations that have been placed on hold in the eDiscovery case will be searched. You use the value All for this parameter. You can use this parameter only for compliance searches that are associated with an eDiscovery case. + +If the content locations in the compliance search include mailboxes, you also need to use the ExchangeLocation parameter with the value $null. Similarly, if the compliance search includes SharePoint sites, you also need to use the SharePointLocation parameter 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. + +```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 +``` + +### -IncludeOrgContent +{{ Fill IncludeOrgContent 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 +``` + +### -IncludeUserAppContent +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. + +```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 +``` + +### -Language +The Language parameter specifies the language for the compliance search. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderLocation +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. + +```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 +``` + +### -RefinerNames +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocationExclusion +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: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePublicFolderLocation +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -RemoveSharePointLocation +This parameter is available only in the cloud-based service. + +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"`. + +```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 +``` + +### -RemoveSharePointLocationExclusion +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +This parameter is available only in the cloud-based service. + +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"`. + +```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 +``` + +### -SharePointLocationExclusion +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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: Exchange Server 2016, Exchange Server 2019, 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-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md new file mode 100644 index 0000000000..a490fa06ca --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md @@ -0,0 +1,148 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ComplianceSearchAction + +## SYNOPSIS +> [!NOTE] +> After May 26, 2025, this cmdlet is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This cmdlet is functional only in on-premises Exchange. + +Use the Set-ComplianceSearchAction cmdlet to change the export key on export compliance search actions in on-premises Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ComplianceSearchAction [-Identity] + [-ChangeExportKey] + [-DomainController ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +## EXAMPLES + +### Example 1 +```powershell +Set-ComplianceSearchAction -Identity "Project X_Export" -ChangeExportKey +``` + +This example changes the export key on the export compliance search action named Project X\_Export. + +## PARAMETERS + +### -Identity +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`). +- JobRunId (GUID) + +```yaml +Type: ComplianceSearchActionIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ChangeExportKey +The ChangeExportKey switch creates a new export key for the compliance search action. You don't need to specify a value with this switch. + +This switch is meaningful only on export compliance search actions. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, 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 simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md new file mode 100644 index 0000000000..5301f61588 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md @@ -0,0 +1,237 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ComplianceSecurityFilter + +## 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 Set-ComplianceSecurityFilter cmdlet to modify compliance security filters in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ComplianceSecurityFilter -FilterName + [-Action ] + [-Confirm] + [-Description ] + [-Filters ] + [-Region ] + [-Users ] + [-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 +$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" + +$filterusers.users.add("pilarp@contoso.com") + +Set-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" -Users $filterusers.users +``` + +This example adds user pilarp@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. + +### Example 2 +```powershell +$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" + +$filterusers.users.remove("annb@contoso.com") + +Set-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" -Users $filterusers.users +``` + +This example removes user annb@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. + +## PARAMETERS + +### -FilterName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action +The Action parameter specifies that type of search action that the filter is applied to. A valid value for this parameter is All, which means the filter is applied to all search actions. + +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. +- Preview: The filter is applied when previewing search results. +- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. +- Search: The filter is applied when running a search. +- All: The filter is applied to all search actions. + +```yaml +Type: ComplianceSecurityFilterActionType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filters +The Filters parameter specifies the search criteria for the compliance security filter. You can create three different types of filters: + +- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `"MailboxContent_Recipients -like 'contoso.com'"` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see [Keyword queries for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions#searchable-email-properties). +- Site and site content filter: There are two SharePoint and OneDrive site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. + +You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are: + +- APC: Asia-Pacific +- AUS: Australia +- CAN: Canada +- EUR: Europe, Middle East, Africa +- FRA: France +- GBR: United Kingdom +- IND: India +- JPN: Japan +- LAM: Latin America +- NAM: North America + +If you don't use this parameter in a multi-geo tenant, eDiscovery searches are performed in the central location. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +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. +- The value All: Assigns the filter to all users. You can only use this value by itself. +- One or more role groups: Identify the role group by its name. You can specify multiple values separated by commas. + +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, 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-ComplianceTag.md b/exchange/exchange-ps/exchange/Set-ComplianceTag.md new file mode 100644 index 0000000000..ef1e0e1fd7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ComplianceTag.md @@ -0,0 +1,378 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-ComplianceTag + +## 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-ComplianceTag cmdlet to modify retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Set-ComplianceTag [-Identity] + [-AutoApprovalPeriod ] + [-Comment ] + [-ComplianceTagForNextStage ] + [-Confirm] + [-EventType ] + [-FilePlanProperty ] + [-FlowId ] + [-Force] + [-MultiStageReviewProperty ] + [-Notes ] + [-RetentionDuration ] + [-ReviewerEmail ] + [-WhatIf] + [] +``` + +### PriorityCleanup +``` +Set-ComplianceTag [-Identity] [-PriorityCleanup] + [-Comment ] + [-Confirm] + [-Force] + [-MultiStageReviewProperty ] + [-Notes ] + [-RetentionDuration ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ComplianceTag -Identity "HR Content" -RetentionDuration 2555 -Comment "Retain HR content for 7 years" +``` + +This example modifies the existing label named HR Content by modifying the retention duration and adding a comment. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the label that you want to modify. You can use any value that uniquely identifies the tag. 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 +``` + +### -AutoApprovalPeriod +{{ Fill AutoApprovalPeriod Description }} + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```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 +``` + +### -ComplianceTagForNextStage +{{ Fill ComplianceTagForNextStage Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -EventType +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 +- Distinguished name (DN) +- GUID + +You can use the Get-RetentionComplianceRule cmdlet to view the available retention rules. + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePlanProperty +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` +- `Get-FilePlanPropertyCategory | Format-List Name` +- `Get-FilePlanPropertyCitation | Format-List Name` +- `Get-FilePlanPropertyDepartment | Format-List Name` +- `Get-FilePlanPropertyReferenceId | Format-List Name` +- `Get-FilePlanPropertySubCategory | Format-List Name` + +A valid value for this parameter involves two steps: + +- A variable to store the file plan properties as a PSCustomObject using the following syntax: + + `$Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}` + + For example: + + `$retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="Referen`ceA"},@{Key="FilePlanPropertyAuthority";Value="Auth1"})} + +- A second variable to convert the PSCustomObject to a JSON object using the following syntax: + + `$Variable2 = ConvertTo-Json $Variable1` + + For example: + + `$fpStr = ConvertTo-Json $retentionLabelAction` + +You use the second variable as the value for this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowId +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. + +The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. + +You can find the GUID value of the flow by using either of the following methods: + +- Navigate to the flow from the Power Automate portal. The GUID value of the flow is in the URL. +- Use the Power Automate action named 'List flows as admin'. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiStageReviewProperty +The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: + +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` + +For example: + +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'` + +This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: + +- A positive integer. +- The value unlimited. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReviewerEmail +The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. + +```yaml +Type: SmtpAddress[] +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/users-and-groups/Set-Contact.md b/exchange/exchange-ps/exchange/Set-Contact.md similarity index 82% rename from exchange/exchange-ps/exchange/users-and-groups/Set-Contact.md rename to exchange/exchange-ps/exchange/Set-Contact.md index a5532b5b8c..a173246fe3 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-Contact.md +++ b/exchange/exchange-ps/exchange/Set-Contact.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-Contact @@ -13,32 +16,63 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-Contact cmdlet to modify contact object settings. If the contact is a mail contact, you can use the Set-MailContact cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Contact cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-Contact [-Identity] [-AllowUMCallsFromNonUsers ] - [-AssistantName ] [-City ] [-Company ] [-Confirm] [-CountryOrRegion ] - [-CreateDTMFMap <$true | $false>] [-Department ] [-DisplayName ] [-DomainController ] - [-Fax ] [-FirstName ] [-HomePhone ] [-IgnoreDefaultScope] [-Initials ] - [-LastName ] [-Manager ] [-MobilePhone ] [-Name ] - [-Notes ] [-Office ] [-OtherFax ] [-OtherHomePhone ] - [-OtherTelephone ] [-Pager ] [-Phone ] [-PhoneticDisplayName ] - [-PostalCode ] [-PostOfficeBox ] [-SeniorityIndex ] - [-SimpleDisplayName ] [-StateOrProvince ] [-StreetAddress ] - [-TelephoneAssistant ] [-Title ] [-UMCallingLineIds ] - [-UMDtmfMap ] [-WebPage ] [-WhatIf] [-WindowsEmailAddress ] - [-GeoCoordinates ] [] +Set-Contact [-Identity] + [-AllowUMCallsFromNonUsers ] + [-AssistantName ] + [-City ] + [-Company ] + [-Confirm] + [-CountryOrRegion ] + [-CreateDTMFMap ] + [-Department ] + [-DisplayName ] + [-DomainController ] + [-Fax ] + [-FirstName ] + [-GeoCoordinates ] + [-HomePhone ] + [-IgnoreDefaultScope] + [-Initials ] + [-LastName ] + [-Manager ] + [-MobilePhone ] + [-Name ] + [-Notes ] + [-Office ] + [-OtherFax ] + [-OtherHomePhone ] + [-OtherTelephone ] + [-Pager ] + [-Phone ] + [-PhoneticDisplayName ] + [-PostalCode ] + [-PostOfficeBox ] + [-SeniorityIndex ] + [-SimpleDisplayName ] + [-StateOrProvince ] + [-StreetAddress ] + [-TelephoneAssistant ] + [-Title ] + [-UMCallingLineIds ] + [-UMDtmfMap ] + [-WebPage ] + [-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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-Contact -Identity "contoso.com/Users/Arlene Huff" -City "Seattle" -Company "Contoso" ``` @@ -51,18 +85,11 @@ Change the Company parameter value to Contoso. ## PARAMETERS ### -Identity -The Identity parameter specifies the contact that you want to modify. You can use any value that uniquely identifies the contact. - -For example: +The Identity parameter specifies the contact that you want to modify. You can use any value that uniquely identifies the contact. For example: - Name - -- Display name - - Distinguished name (DN) - - Canonical DN - - GUID ```yaml @@ -70,6 +97,7 @@ 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 Default value: None @@ -78,13 +106,16 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers -The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from directory searches. +This parameter is available only in on-premises Exchange. + +The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from Unified Messaging directory searches. ```yaml -Type: None | SearchEnabled +Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -100,6 +131,7 @@ 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 Default value: None @@ -115,6 +147,7 @@ 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 Default value: None @@ -130,6 +163,7 @@ 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 Default value: None @@ -140,8 +174,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -149,6 +182,7 @@ 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 @@ -157,13 +191,18 @@ Accept wildcard characters: False ``` ### -CountryOrRegion -The CountryOrRegion parameter specifies the contact's country or region. +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). + +The friendly name is returned in the CountryOrRegion property value by the Get-Contact cmdlet, but you can use either the friendly name or the two-letter country code in filter operations. ```yaml Type: CountryInfo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -172,17 +211,19 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap +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. - - $false: A DTMF map isn't created for the recipient. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -198,6 +239,7 @@ 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 Default value: None @@ -208,13 +250,14 @@ Accept wildcard characters: False ### -DisplayName 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 meaninful only if the contact is mail-enabled. +This parameter is meaningful only if the contact is mail-enabled. ```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 Default value: None @@ -232,6 +275,7 @@ 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 @@ -247,6 +291,7 @@ 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 Default value: None @@ -262,6 +307,28 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoCoordinates +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" +- Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432" + +**Note**: If period separators don't work for you, use commas instead. + +```yaml +Type: GeoCoordinates +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -277,6 +344,7 @@ 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 Default value: None @@ -287,12 +355,11 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml @@ -300,6 +367,7 @@ 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 @@ -315,6 +383,7 @@ 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 Default value: None @@ -330,6 +399,7 @@ 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 Default value: None @@ -345,6 +415,7 @@ 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 Default value: None @@ -360,6 +431,7 @@ 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 Default value: None @@ -375,6 +447,7 @@ 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 Default value: None @@ -390,6 +463,7 @@ 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 Default value: None @@ -405,6 +479,7 @@ 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 Default value: None @@ -420,6 +495,7 @@ 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 Default value: None @@ -435,6 +511,7 @@ 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 Default value: None @@ -450,6 +527,7 @@ 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 Default value: None @@ -465,6 +543,7 @@ 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 Default value: None @@ -480,6 +559,7 @@ 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 Default value: None @@ -495,6 +575,7 @@ 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 Default value: None @@ -510,6 +591,7 @@ 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 Default value: None @@ -525,6 +607,7 @@ 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 Default value: None @@ -540,6 +623,7 @@ 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 Default value: None @@ -551,12 +635,10 @@ Accept wildcard characters: False 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 - - A - Z - - 0 - 9 - -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":" and "?". +- space +- `" ' ( ) + , - . / : ?` This parameter is meaningful only if the contact is mail-enabled. @@ -565,6 +647,7 @@ 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 Default value: None @@ -580,6 +663,7 @@ 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 Default value: None @@ -595,6 +679,7 @@ 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 Default value: None @@ -610,6 +695,7 @@ 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 Default value: None @@ -625,6 +711,7 @@ 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 Default value: None @@ -633,13 +720,16 @@ Accept wildcard characters: False ``` ### -UMCallingLineIds +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. ```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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -648,27 +738,28 @@ Accept wildcard characters: False ``` ### -UMDtmfMap -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: - -- emailAddress:\ +This parameter is available only in on-premises Exchange. -- lastNameFirstName:\ +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: -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -684,6 +775,7 @@ 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 Default value: None @@ -699,6 +791,7 @@ 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 @@ -710,7 +803,6 @@ Accept wildcard characters: False 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. - - In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. @@ -720,25 +812,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeoCoordinates -The GeoCoordinates parameter specifies the contact's physical location in latitude, longitude and altitude coordinates. Use this parameter to specify the global position of the contact's location. You have to specify one of the following sets of coordinates; use semicolons to separate the values: - -- Latitude and longitude: For example, "47.644125;-122.122411" - -- Latitude, longitude and altitude: For example, "47.644125;-122.122411;161.432" -```yaml -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 Default value: None @@ -747,20 +821,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c86ca5af-bb1d-4619-8af8-9f04c83d84c5.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md new file mode 100644 index 0000000000..80deb1646f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md @@ -0,0 +1,412 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ContentFilterConfig + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ContentFilterConfig cmdlet to modify the content filter configuration on a Mailbox server or an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ContentFilterConfig [-BypassedRecipients ] + [-BypassedSenderDomains ] + [-BypassedSenders ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExternalMailEnabled ] + [-InternalMailEnabled ] + [-OutlookEmailPostmarkValidationEnabled ] + [-QuarantineMailbox ] + [-RejectionResponse ] + [-SCLDeleteEnabled ] + [-SCLDeleteThreshold ] + [-SCLQuarantineEnabled ] + [-SCLQuarantineThreshold ] + [-SCLRejectEnabled ] + [-SCLRejectThreshold ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ContentFilterConfig -BypassedSenderDomains woodgrovebank.com +``` + +This example specifies the sender domain woodgrovebank.com as a bypassed domain. Messages received from that domain bypass the Content Filter agent. + +### Example 2 +```powershell +Set-ContentFilterConfig -SCLQuarantineEnabled $true -SCLRejectEnabled $true -SCLDeleteEnabled $true -SCLQuarantineThreshold 5 -SCLRejectThreshold 6 -SCLDeleteThreshold 8 -QuarantineMailbox SpamQuarantineMailbox@contoso.com -RejectionResponse "Message rejected due to content restrictions" -BypassedRecipients user1@contoso.com,user2@contoso.com +``` + +This example makes the following modifications to the Content Filter agent configuration: + +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 defines two users for whom the Content Filter won't process messages. + +## PARAMETERS + +### -BypassedRecipients +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassedSenderDomains +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassedSenders +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the Content Filter agent on the computer on which you're running the command. Valid values are: + +- $true: The Content Filter agent is enabled. This is the default value. +- $false: The Content Filter agent is disabled. + +```yaml +Type: Boolean +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 +``` + +### -ExternalMailEnabled +The ExternalMailEnabled parameter specifies whether all messages from unauthenticated connections from sources external to your Exchange organization are processed by the Content Filter agent. Valid values are: + +- $true: Messages from unauthenticated connections are processed by the Content Filter agent. This is the default value. +- $false: Messages from unauthenticated connections aren't processed by the Content Filter agent. + +```yaml +Type: Boolean +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 +``` + +### -InternalMailEnabled +The InternalMailEnabled parameter specifies whether all messages from authenticated connections and from authoritative domains in your enterprise are processed by the Content Filter agent. Valid values are: + +- $true: Messages from authenticated connections are processed by the Content Filter agent. +- $false: Messages from authenticated connections aren't processed by the Content Filter agent. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -OutlookEmailPostmarkValidationEnabled +The OutlookEmailPostmarkValidationEnabled parameter specifies whether Outlook Email Postmark validation is enabled. + +- For outbound messages, the Content Filter agent applies a computational postmark header to help destination email systems distinguish legitimate email from spam. +- For inbound messages, the Content Filter agent looks for a computational postmark header in the message. The presence of a valid, solved computational postmark header indicates the client computer that generated the message solved the computational postmark, so the Content Filter agent is likely to lower the message's spam confidence level (SCL) rating. + +Valid values are: + +- $true: Outlook Email Postmark validation is enabled. +- $false: Outlook Email Postmark validation is disabled. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -QuarantineMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectionResponse +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 +Default value: None +Accept pipeline input: False +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 values are: + +- $true: Messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. +- $false: Messages aren't deleted. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -SCLDeleteThreshold +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 +Default value: None +Accept pipeline input: False +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 values are: + +- $true: Messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. +- $false: Messages aren't quarantined. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -SCLQuarantineThreshold +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 +Default value: None +Accept pipeline input: False +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 in an NDR to the sender. Valid values are: + +- $true: Messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected in an NDR is to the sender. +- $false: Messages aren't rejected. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -SCLRejectThreshold +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Set-DataClassification.md b/exchange/exchange-ps/exchange/Set-DataClassification.md new file mode 100644 index 0000000000..a31254e845 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DataClassification.md @@ -0,0 +1,273 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DataClassification + +## 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. + +Use the Set-DataClassification cmdlet to modify data classification rules that use document fingerprints. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DataClassification [-Identity] + [-Confirm] + [-Description ] + [-DomainController ] + [-Fingerprints ] + [-IsDefault] + [-Locale ] + [-Name ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-DataClassification "Contoso Confidential" -Locale fr -Name "Contoso Confidentiel" -Description "Ce message contient des informations confidentielles." -IsDefault +``` + +This example adds a French translation to the existing data classification rule named "Contoso Confidential", and sets this French translation as the default. + +### Example 2 +```powershell +Set-DataClassification "Contoso Confidential" -Locale es -Name $null -Description $null +``` + +This example removes the existing Spanish translation from the data classification rule named "Contoso Confidential". + +### Example 3 +```powershell +$Benefits_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Benefits Template.docx') + +$Benefits_Fingerprint = New-Fingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template" + +$Contoso_Confidential = Get-DataClassification "Contoso Confidential" + +$Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints) + +$Array.Add($Benefits_FingerPrint) + +Set-DataClassification $Contoso_Confidential.Identity -FingerPrints $Array +``` + +This example modifies the existing data classification rule named "Contoso Confidential" by adding a new document fingerprint for the file C:\\My Documents\\Contoso Benefits Template.docx without affecting any existing document fingerprints that are already defined. + +### Example 4 +```powershell +$cc = Get-DataClassification "Contoso Confidential" + +$a = [System.Collections.ArrayList]($cc.Fingerprints) + +$a + +$a.RemoveAt(0) + +Set-DataClassification $cc.Identity -FingerPrints $a +``` + +This example modifies the data classification rule named "Contoso Confidential" by removing an existing document fingerprint without affecting other document fingerprints that are already defined. + +The first three commands return the list of document fingerprints in the data classification. The first document fingerprint in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the document fingerprint that you want to remove. The last two commands remove the first document fingerprint that's displayed in the list. + +## PARAMETERS + +### -Identity +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 +- LocalizedName +- Identity GUID value + +```yaml +Type: DataClassificationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fingerprints +The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +The IsDefault switch is used with the Locale parameter to specify the default language for the data classification rule. You don't need to specify a value with this switch. + +The default Locale value is stored in the DefaultCulture property. + +When you change the default Locale value, the Name value of the data classification rule changes to match the Name value that's associated with the new default locale. The original Name value when the rule was created is permanently stored the LocalizedName property. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +The Locale parameter adds or removes languages that are associated with the data classification rule. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +Typically, you use the Locale parameter with the Name and Description parameters to add or remove translated names and descriptions for the data classification rule. You can also use the Locale parameter with the IsDefault switch to designate an existing translated name and description as the default. Before you can remove the default translation, you need to set another translation as the default. + +```yaml +Type: CultureInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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. + +The value of the Name parameter is used in the Policy Tip that's presented to users in Outlook on the web. When a translated value of the Name parameter matches the client's language, the Policy Tip is displayed in the client's language. If no translated values of the Name parameter match the client's language, the default translation that's specified by the IsDefault parameter is used for the Policy Tip. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/encryption-and-certificates/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/encryption-and-certificates/Set-DataEncryptionPolicy.md rename to exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md index 924b2fbd19..729b74f9f7 100644 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-DataEncryptionPolicy @@ -13,59 +16,64 @@ This cmdlet is available only in the cloud-based service. Use the Set-DataEncryptionPolicy cmdlet to modify data encryption policies in Exchange Online. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### DCAdminPurgeKeyRequest ``` -Set-DataEncryptionPolicy [-Identity] [-PermanentDataPurgeContact ] -PermanentDataPurgeReason +Set-DataEncryptionPolicy [-Identity] -PermanentDataPurgeReason [-PermanentDataPurgeContact ] [-Confirm] [-Description ] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] [-Name ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### TenantAdminPurgeKeyRequest ``` -Set-DataEncryptionPolicy [-Identity] -PermanentDataPurgeContact -PermanentDataPurgeReason [-PermanentDataPurgeRequested] +Set-DataEncryptionPolicy [-Identity] -PermanentDataPurgeContact -PermanentDataPurgeReason + [-PermanentDataPurgeRequested] [-Confirm] [-Description ] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] [-Name ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### RefreshKey ``` -Set-DataEncryptionPolicy [-Identity] [-Refresh] +Set-DataEncryptionPolicy [-Identity] + [-Refresh] [-Confirm] [-Description ] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Name ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-DataEncryptionPolicy -Identity "US Mailboxes" -Enabled $false ``` This example disabled the data encryption policy named US Mailboxes. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-DataEncryptionPolicy -Identity "Europe Mailboxes" -Refresh ``` @@ -77,16 +85,15 @@ This example updates the data encryption policy named Europe Mailboxes after one 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 - - Distinguished name (DN) - - GUID ```yaml Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online + Required: True Position: 1 Default value: None @@ -104,6 +111,7 @@ Type: String Parameter Sets: TenantAdminPurgeKeyRequest Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -116,6 +124,7 @@ Type: String Parameter Sets: DCAdminPurgeKeyRequest Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -133,6 +142,7 @@ Type: String Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -152,6 +162,7 @@ Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: Named Default value: None @@ -166,7 +177,8 @@ Use the Refresh switch to update the data encryption policy in Exchange Online a Type: SwitchParameter Parameter Sets: RefreshKey Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online + Required: True Position: Named Default value: None @@ -177,15 +189,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -200,7 +214,8 @@ The Description parameter specifies an optional description for the data encrypt Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -216,6 +231,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -227,14 +243,14 @@ Accept wildcard characters: False The Enabled parameter enables or disable the data encryption policy. Valid values are: - $true: The policy is enabled. - - $false: The policy is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -243,13 +259,16 @@ Accept wildcard characters: False ``` ### -Force -Use the Force switch when you're trying to initiate the deletion of all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to delete all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted. ```yaml Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -264,7 +283,8 @@ The Name parameter specifies the unique name for the data encryption policy. If Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -280,6 +300,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -288,20 +309,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/55c089cd-1497-4660-94ed-847561e89734.aspx) diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md new file mode 100644 index 0000000000..d5e6a1b952 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md @@ -0,0 +1,721 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DatabaseAvailabilityGroup + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-DatabaseAvailabilityGroup cmdlet to configure properties of a database availability group (DAG). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DatabaseAvailabilityGroup [-Identity] + [-ActivityState ] + [-AllowCrossSiteRpcClientAccess] + [-AlternateWitnessDirectory ] + [-AlternateWitnessServer ] + [-AutoDagAllServersInstalled ] + [-AutoDagAutoRedistributeEnabled ] + [-AutoDagAutoReseedEnabled ] + [-AutoDagBitlockerEnabled ] + [-AutoDagDatabaseCopiesPerDatabase ] + [-AutoDagDatabaseCopiesPerVolume ] + [-AutoDagDatabasesRootFolderPath ] + [-AutoDagDiskReclaimerEnabled ] + [-AutoDagTotalNumberOfDatabases ] + [-AutoDagTotalNumberOfServers ] + [-AutoDagVolumesRootFolderPath ] + [-Confirm] + [-DagConfiguration ] + [-DatabaseAvailabilityGroupIpAddresses ] + [-DatacenterActivationMode ] + [-DiscoverNetworks] + [-DomainController ] + [-FileSystem ] + [-ManualDagNetworkConfiguration ] + [-MetaCacheDatabaseVolumesPerServer ] + [-NetworkCompression ] + [-NetworkEncryption ] + [-PreferenceMoveFrequency ] + [-ReplayLagManagerEnabled ] + [-ReplicationPort ] + [-SkipDagValidation] + [-WhatIf] + [-WitnessDirectory ] + [-WitnessServer ] + [] +``` + +## DESCRIPTION +The Set-DatabaseAvailabilityGroup cmdlet enables you to manage DAG properties that can't be managed from the Exchange admin center (EAC), such as configuring network discovery, selecting the TCP port used for replication and enabling datacenter activation coordination (DAC) mode. + +DAG property values are stored in both Active Directory and the cluster database. Because some properties are stored in the cluster database, the underlying cluster for the DAG must have quorum to set the properties for: + +- ReplicationPort +- NetworkCompression +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -WitnessDirectory C:\DAG1DIR +``` + +This example sets the witness directory to C:\\DAG1DIR for the DAG DAG1. + +### Example 2 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -AlternateWitnessDirectory C:\DAGFileShareWitnesses\DAG1.contoso.com -AlternateWitnessServer CAS3 +``` + +This example preconfigures an alternate witness server of CAS3 and an alternate witness directory of C:\\DAGFileShareWitnesses\\DAG1.contoso.com for the DAG DAG1. + +### Example 3 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 0.0.0.0 +``` + +This example configures the DAG DAG1 to use DHCP to obtain an IP address. + +### Example 4 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8 +``` + +This example configures the DAG DAG1 to use a static IP address of 10.0.0.8. + +### Example 5 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8,10.0.1.8 +``` + +This example configures the multi-subnet DAG DAG1 with multiple static IP addresses. + +### Example 6 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -ReplicationPort 63132 +``` + +This example configures TCP port 63132 as the port used by replication for the DAG DAG1. + +After changing the default replication port for a DAG, you must manually modify the Windows Firewall exceptions on each member of the DAG to allow communication to occur over the specified port. + +### Example 7 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -DatacenterActivationMode DagOnly +``` + +This example configures the DAG DAG1 for DAC mode. + +### Example 8 +```powershell +Set-DatabaseAvailabilityGroup -Identity DAG1 -AutoDagVolumesRootFolderPath C:\ExchVols -AutoDagDatabasesRootFolderPath C:\ExchDBs -AutoDagDatabaseCopiesPerVolume 4 +``` + +This example configures the DAG DAG1 for AutoReseed using custom mount point paths and 4 databases per volume. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActivityState +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCrossSiteRpcClientAccess +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlternateWitnessDirectory +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlternateWitnessServer +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagAllServersInstalled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagAutoRedistributeEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagAutoReseedEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagBitlockerEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagDatabaseCopiesPerDatabase +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagDatabaseCopiesPerVolume +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagDatabasesRootFolderPath +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagTotalNumberOfDatabases +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagTotalNumberOfServers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDagVolumesRootFolderPath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DagConfiguration +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAvailabilityGroupIpAddresses +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatacenterActivationMode +The DatacenterActivationMode parameter specifies the datacenter activation mode for the DAG. Valid values are: + +- Off: Datacenter activation mode is disabled. +- DagOnly: Datacenter activation mode is enabled. + +```yaml +Type: DatacenterActivationModeOption +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 +``` + +### -DiscoverNetworks +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -FileSystem +The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: + +- NTFS +- ReFS + +```yaml +Type: FileSystemMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManualDagNetworkConfiguration +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetaCacheDatabaseVolumesPerServer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkCompression +The NetworkCompression parameter specifies the network compression option for the DAG. Valid values are: + +- Disabled: Network compression is disabled on all networks. +- Enabled: Network compression is enabled on all networks. +- InterSubnetOnly: Network compression is enabled only for inter-subnet communication. +- SeedOnly: Network compression is enabled only for seeding. + +```yaml +Type: NetworkOption +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 +``` + +### -NetworkEncryption +The NetworkEncryption parameter specifies the network encryption option for the DAG. Valid values are: + +- Disabled: Network encryption is disabled on all networks. +- Enabled: Network encryption is enabled on all networks. +- InterSubnetOnly: Network encryption is enabled only for inter-subnet communication. +- SeedOnly: Network encryption is enabled only for seeding. + +```yaml +Type: NetworkOption +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 +``` + +### -PreferenceMoveFrequency +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. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplayLagManagerEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationPort +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDagValidation +The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### -WitnessDirectory +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: FileShareWitnessServerName +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md similarity index 80% rename from exchange/exchange-ps/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md index 1355d7cb57..1cf2e33f62 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-DatabaseAvailabilityGroupNetwork @@ -13,33 +16,39 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DatabaseAvailabilityGroupNetwork cmdlet to configure a network for a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DatabaseAvailabilityGroupNetwork [-Identity] [-Confirm] - [-Description ] [-DomainController ] [-IgnoreNetwork <$true | $false>] [-Name ] - [-ReplicationEnabled <$true | $false>] [-Subnets ] [-WhatIf] +Set-DatabaseAvailabilityGroupNetwork [-Identity] + [-Confirm] + [-Description ] + [-DomainController ] + [-IgnoreNetwork ] + [-Name ] + [-ReplicationEnabled ] + [-Subnets ] + [-WhatIf] [] ``` ## DESCRIPTION You can configure a variety of network properties, such as the name for the network, a description of the network, a list of one or more subnets that comprise the network and whether the network is enabled for replication (log shipping and seeding). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-DatabaseAvailabilityGroupNetwork -Identity DAG1\DAGNetwork01 -ReplicationEnabled:$true ``` This example enables the DAG network DAGNetwork01 in the DAG DAG1 for replication. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-DatabaseAvailabilityGroupNetwork -Identity DAG2\DAGNetwork02 -ReplicationEnabled:$false -IgnoreNetwork:$true ``` @@ -55,6 +64,7 @@ Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -65,8 +75,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -74,6 +83,7 @@ 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 @@ -89,6 +99,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -104,6 +115,7 @@ 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 @@ -115,10 +127,11 @@ Accept wildcard characters: False The IgnoreNetwork parameter indicates that the specified network should be ignored and not used by the DAG. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -134,6 +147,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -145,10 +159,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,6 +179,7 @@ Type: DatabaseAvailabilityGroupSubnetId[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -179,6 +195,7 @@ 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 @@ -187,20 +204,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5c6add57-eef9-4af5-9cf3-54fd910dfe93.aspx) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..82ecf059aa --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig +applicable: Exchange Online +title: Set-DefaultTenantBriefingConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DefaultTenantBriefingConfig -IsEnabledByDefault + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +``` +Set-DefaultTenantBriefingConfig -IsEnabledByDefault Opt-in + +This example sets the default Briefing email configuration for the organization to receive the Briefing email. +``` + +## PARAMETERS + +### -IsEnabledByDefault +The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are: + +- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. +- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value. + +This setting affects the following users: + +- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. +- New users that you create. + +This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..9c1ba06bb4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig +applicable: Exchange Online +title: Set-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DefaultTenantMyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Set-DefaultTenantMyAnalyticsFeatureConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DefaultTenantMyAnalyticsFeatureConfig + [-Feature ] + [-IsEnabled ] + [-ResultSize ] + [-SamplingRate ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true +``` + +This example enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions. + +### Example 2 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Add-in -IsEnabled $false +``` + +This example disables Viva Insight add-in feature for the organization. + +### Example 3 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Meeting-Effectiveness-Survey-Sampling-Rate -SamplingRate 0.2 +``` + +This example sets the meeting effectiveness survey sampling rate to 20%. + +## PARAMETERS + +### -Feature +The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are: + +- Add-in +- Dashboard +- Digest-email +- Meeting-effectiveness-survey +- Meeting-effectiveness-survey-sampling-rate +- Schedule-send +- All (all features) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Dashboard, Add-in, Digest-email, Meeting-effectiveness-survey, Scheduled-send, All +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are: + +- $true: The feature is enabled. +- $false: The feature is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingRate +This parameter is available only in version 3.2.0 or later. + +The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7. + +```yaml +Type: Double +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md similarity index 80% rename from exchange/exchange-ps/exchange/mail-flow/Set-DeliveryAgentConnector.md rename to exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md index b81f544394..e1280caf99 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-DeliveryAgentConnector @@ -13,27 +16,38 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DeliveryAgentConnector cmdlet to configure a specific delivery agent connector in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DeliveryAgentConnector [-Identity] - [-AddressSpaces ] [-Comment ] [-Confirm] [-DeliveryProtocol ] - [-DomainController ] [-Enabled <$true | $false>] [-Force] [-IsScopedConnector <$true | $false>] - [-MaxConcurrentConnections ] [-MaxMessageSize ] [-MaxMessagesPerConnection ] - [-Name ] [-SourceTransportServers ] [-WhatIf] [] + [-AddressSpaces ] + [-Comment ] + [-Confirm] + [-DeliveryProtocol ] + [-DomainController ] + [-Enabled ] + [-Force] + [-IsScopedConnector ] + [-MaxConcurrentConnections ] + [-MaxMessageSize ] + [-MaxMessagesPerConnection ] + [-Name ] + [-SourceTransportServers ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/dd638118.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-DeliveryAgentConnector "Contoso X.400 Connector" -MaxMessageSize 10MB -MaxMessagesPerConnection 100 -MaxConcurrentConnections 10 ``` @@ -45,9 +59,13 @@ Sets the maximum number of messages allowed per connection to 100. Sets the maximum concurrent connections to 10. -### -------------------------- Example 2 -------------------------- -``` -$ConnectorConfig = Get-DeliveryAgentConnector "Contoso X.400 Connector"; $ConnectorConfig.AddressSpaces += "X400:c=US;p=Fabrikam;a=Contoso;o=Sales;1"; $ConnectorConfig.SourceTransportServers += Hub04; Set-DeliveryAgentConnector "Contoso X.400 Connector" -AddressSpaces $ConnectorConfig.AddressSpaces -SourceTransportServers $ConnectorConfig.SourceTransportServers +### Example 2 +```powershell +$ConnectorConfig = Get-DeliveryAgentConnector "Contoso X.400 Connector" + +$ConnectorConfig.AddressSpaces += "X400:c=US;p=Fabrikam;a=Contoso;o=Sales;1" + +$ConnectorConfig.SourceTransportServers += Hub04; Set-DeliveryAgentConnector "Contoso X.400 Connector" -AddressSpaces $ConnectorConfig.AddressSpaces -SourceTransportServers $ConnectorConfig.SourceTransportServers ``` This example uses the temporary variable $ConnectorConfig to add the address space c=US;p=Fabrikam;a=Contoso;o=Sales to the delivery agent connector Contoso X.400 Connector and also adds the server Hub04 to the list of servers that host the connector. @@ -62,6 +80,7 @@ Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -70,13 +89,14 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names for which this delivery agent connector is responsible. The syntax for entering an address space is as follows: \:\;\. You must enclose each address space in quotation marks ("). +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 Default value: None @@ -92,6 +112,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -102,8 +123,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -111,6 +131,7 @@ 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 @@ -126,6 +147,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,6 +165,7 @@ 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 @@ -156,10 +179,11 @@ The Enabled parameter specifies whether the delivery agent connector is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -168,13 +192,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -188,10 +215,11 @@ The IsScopedConnector parameter specifies the availability of the connector to o The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -209,6 +237,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -220,11 +249,8 @@ Accept wildcard characters: False 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) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) Unqualified values are treated as bytes. The valid input range for this parameter is from 65536 through 2147483647 bytes. @@ -236,6 +262,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -253,6 +280,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -268,6 +296,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -285,6 +314,7 @@ 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 @@ -300,6 +330,7 @@ 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 @@ -308,20 +339,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d22cdada-08ed-487e-8e91-1a984a0c2409.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md b/exchange/exchange-ps/exchange/Set-DetailsTemplate.md similarity index 77% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md rename to exchange/exchange-ps/exchange/Set-DetailsTemplate.md index 49a8d6a553..dfeb2f1c61 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md +++ b/exchange/exchange-ps/exchange/Set-DetailsTemplate.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-DetailsTemplate @@ -13,22 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DetailsTemplate cmdlet to modify the attributes of a details template. To make changes to the details template format and layout, you need to use the Details Templates Editor in the Exchange Toolbox. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DetailsTemplate [-Identity] [-Confirm] [-DomainController ] - [-Pages ] [-WhatIf] [] +Set-DetailsTemplate [-Identity] + [-Confirm] + [-DomainController ] + [-Pages ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-DetailsTemplate -Identity en-us\User ``` @@ -40,15 +47,10 @@ This example sets attributes for the User details template for the U.S. English 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 - - Group - - PublicFolder - - SearchDialog - - MailboxAgent - - Contact ```yaml @@ -56,6 +58,7 @@ Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -66,8 +69,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -75,6 +77,7 @@ 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 @@ -90,6 +93,7 @@ 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 @@ -105,6 +109,7 @@ 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 @@ -120,6 +125,7 @@ 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 @@ -128,20 +134,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2e2ec63c-fd46-48c5-b21f-f1dc113f1b05.aspx) diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md new file mode 100644 index 0000000000..0bbba58e9e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md @@ -0,0 +1,199 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DeviceConditionalAccessPolicy + +## 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-DeviceConditionalAccessPolicy cmdlet to modify mobile device conditional access policies in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### RetryDistribution +``` +Set-DeviceConditionalAccessPolicy [-Identity] + [-RetryDistribution] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Set-DeviceConditionalAccessPolicy [-Identity] + [-Comment ] + [-Enabled ] + [-Force] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-DeviceConditionalAccessPolicy -Identity Executives -Enabled $false +``` + +This example disables the existing mobile device conditional access policy named Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RetryDistribution +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md new file mode 100644 index 0000000000..f9e793ed4e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md @@ -0,0 +1,1447 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DeviceConditionalAccessRule + +## 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-DeviceConditionalAccessRule cmdlet to modify mobile device conditional access rules in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DeviceConditionalAccessRule [-Identity] -TargetGroups + [-AccountName ] + [-AccountUserName ] + [-AllowAppStore ] + [-AllowAssistantWhileLocked ] + [-AllowConvenienceLogon ] + [-AllowDiagnosticSubmission ] + [-AllowiCloudBackup ] + [-AllowiCloudDocSync ] + [-AllowiCloudPhotoSync ] + [-AllowJailbroken ] + [-AllowPassbookWhileLocked ] + [-AllowScreenshot ] + [-AllowSimplePassword ] + [-AllowVideoConferencing ] + [-AllowVoiceAssistant ] + [-AllowVoiceDialing ] + [-AntiVirusSignatureStatus ] + [-AntiVirusStatus ] + [-AppsRating ] + [-AutoUpdateStatus ] + [-BluetoothEnabled ] + [-CameraEnabled ] + [-Confirm] + [-DomainController ] + [-EmailAddress ] + [-EnableRemovableStorage ] + [-ExchangeActiveSyncHost ] + [-FirewallStatus ] + [-ForceAppStorePassword ] + [-ForceEncryptedBackup ] + [-MaxPasswordAttemptsBeforeWipe ] + [-MaxPasswordGracePeriod ] + [-MoviesRating ] + [-PasswordComplexity ] + [-PasswordExpirationDays ] + [-PasswordHistoryCount ] + [-PasswordMinComplexChars ] + [-PasswordMinimumLength ] + [-PasswordQuality ] + [-PasswordRequired ] + [-PasswordTimeout ] + [-PhoneMemoryEncrypted ] + [-RegionRatings ] + [-RequireEmailProfile ] + [-SmartScreenEnabled ] + [-SystemSecurityTLS ] + [-TVShowsRating ] + [-UserAccountControlStatus ] + [-WhatIf] + [-WLANEnabled ] + [-WorkFoldersSyncUrl ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-DeviceConditionalAccessRule -Identity "Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}" -AllowJailbroken $false -TargetGroups 95386852-1c11-4302-8733-b9e1058333e3 +``` + +This example modifies the specified mobile device conditional access rule to block jailbroken devices. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetGroups +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. + +```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 +``` + +### -AccountName +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. + +```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 +``` + +### -AccountUserName +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. + +```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 +``` + +### -AllowAppStore +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ + +```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 +``` + +### -AllowAssistantWhileLocked +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowConvenienceLogon +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. + +This setting is available only on Windows 8.1 RT devices. + +```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 +``` + +### -AllowDiagnosticSubmission +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ + +```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 +``` + +### -AllowiCloudBackup +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowiCloudDocSync +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowiCloudPhotoSync +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowJailbroken +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -AllowPassbookWhileLocked +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowScreenshot +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ + +```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 +``` + +### -AllowSimplePassword +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ + +```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 +``` + +### -AllowVideoConferencing +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowVoiceAssistant +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AllowVoiceDialing +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -AntiVirusSignatureStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiVirusStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppsRating +The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: + +- AllowAll +- DontAllow +- Rating9plus +- Rating12plus +- Rating17plus +- $null (blank): The setting isn't configured. This is the default value. + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingAppsEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpdateStatus +The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: + +- AutomaticCheckForUpdates +- AutomaticDownloadUpdates +- AutomaticUpdatesRequired +- DeviceDefault +- NeverCheckUpdates +- $null (blank): The setting isn't configured. This is the default value. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: CAAutoUpdateStatusEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BluetoothEnabled +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. + +This setting is available only on Windows Phone 8.1 devices. + +```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 +``` + +### -CameraEnabled +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -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 +``` + +### -EmailAddress +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. + +```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 +``` + +### -EnableRemovableStorage +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. + +This setting is available only on Windows Phone 8.1 devices. + +```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 +``` + +### -ExchangeActiveSyncHost +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. + +```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 +``` + +### -FirewallStatus +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. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: Required +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceAppStorePassword +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -ForceEncryptedBackup +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. + +This setting is available on the following types of devices: + +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -MaxPasswordAttemptsBeforeWipe +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -MaxPasswordGracePeriod +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. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoviesRating +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/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. + +Australia + +- AURatingG +- AURatingPG +- AURatingM +- AURatingMA15plus +- AURatingR18plus + +Canada + +- CARatingG +- CARatingPG +- CARating14A +- CARating18A +- CARatingR + +Germany + +- DERatingab0Jahren +- DERatingab6Jahren +- DERatingab12Jahren +- DERatingab16Jahren +- DERatingab18Jahren + +France + +- FRRating10minus +- FRRating12minus +- FRRating16minus +- FRRating18minus + +United Kingdom + +- GBRatingU +- GBRatingUc +- GBRatingPG +- GBRating12 +- GBRating12A +- GBRating15 +- GBRating18 + +Ireland + +- IERatingG +- IERatingPG +- IERating12 +- IERating15 +- IERating16 +- IERating18 + +Japan + +- JPRatingG +- JPRatingPG12 +- JPRatingRdash15 +- JPRatingRdash18 + +New Zealand + +- NZRatingG +- NZRatingPG +- NZRatingM +- NZRatingR13 +- NZRatingR15 +- NZRatingR16 +- NZRatingR18 +- NZRatingR + +United States + +- USRatingG +- USRatingPG +- USRatingPG13 +- USRatingR +- USRatingNC17 + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingMovieEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordComplexity +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. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordExpirationDays +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordHistoryCount +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordMinComplexChars +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. + +```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 +``` + +### -PasswordMinimumLength +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordQuality +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. + +This setting is available only on Android 4+ devices. + +```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 +``` + +### -PasswordRequired +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 +- Apple iOS 6+ +- Android 4+ + +```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 +``` + +### -PasswordTimeout +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: + +- Windows Phone 8.1 +- Windows 8.1 RT +- Apple iOS 6+ +- Android 4+ + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneMemoryEncrypted +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. + +This setting is available on the following types of devices: + +- Windows Phone 8.1 (already encrypted and can't be unencrypted) +- Android 4+ + +```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 +``` + +### -RegionRatings +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. +- au: Australia +- ca: Canada +- de: Germany +- fr: France +- gb: United Kingdom +- ie: Ireland +- jp: Japan +- nz: New Zealand +- us: United States + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingRegionEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireEmailProfile +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. + +```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 +``` + +### -SmartScreenEnabled +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. + +This setting is available only on Windows 8.1 RT devices. + +```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 +``` + +### -SystemSecurityTLS +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. + +This setting is available only on Apple iOS 6+ devices. + +```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 +``` + +### -TVShowsRating +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. + +Australia + +- AURatingP +- AURatingC +- AURatingG +- AURatingPG +- AURatingM +- AURatingMA15plus +- AURatingAv15plus + +Canada + +- CARatingC +- CARatingC8 +- CARatingG +- CARatingPG +- CARating14plus +- CARating18plus + +Germany + +- DERatingab0Jahren +- DERatingab6Jahren +- DERatingab12Jahren +- DERatingab16Jahren +- DERatingab18Jahren + +France + +- FRRating10minus +- FRRating12minus +- FRRating16minus +- FRRating18minus + +United Kingdom + +- GBRatingCaution + +Ireland + +- IERatingGA +- IERatingCh +- IERatingYA +- IERatingPS +- IERatingMA + +Japan + +- JPRatingExplicitAllowed + +New Zealand + +- NZRatingG +- NZRatingPGR +- NZRatingAO + +United States + +- USRatingTVY +- USRatingTVY7 +- USRatingTVG +- USRatingTVPG +- USRatingTV14 +- USRatingTVMA + +This setting is available only on Apple iOS 6+ devices. + +```yaml +Type: CARatingTvShowEntry +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAccountControlStatus +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. +- AlwaysNotify +- NeverNotify +- NotifyAppChanges +- NotifyAppChangesDoNotDimdesktop + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: CAUserAccountControlStatusEntry +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 +``` + +### -WLANEnabled +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. + +This setting is available only on Microsoft Windows Phone 8.1 devices. + +```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 +``` + +### -WorkFoldersSyncUrl +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`. + +This setting is available only on Windows 8.1 RT devices. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md new file mode 100644 index 0000000000..ed19ba795f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md @@ -0,0 +1,199 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DeviceConfigurationPolicy + +## 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-DeviceConfigurationPolicy cmdlet to modify mobile device configuration policies in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### RetryDistribution +``` +Set-DeviceConfigurationPolicy [-Identity] + [-RetryDistribution] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Set-DeviceConfigurationPolicy [-Identity] + [-Comment ] + [-Enabled ] + [-Force] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-DeviceConfigurationPolicy -Identity "Engineering Group" -Enabled $false +``` + +This example disables the mobile device configuration policy named Engineering Group. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RetryDistribution +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md new file mode 100644 index 0000000000..3ea511f71e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md @@ -0,0 +1,1421 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DeviceConfigurationRule + +## 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-DeviceConfigurationRule cmdlet to modify mobile device configuration rules in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DeviceConfigurationRule [-Identity] -TargetGroups + [-AccountName ] + [-AccountUserName ] + [-AllowAppStore ] + [-AllowAssistantWhileLocked ] + [-AllowConvenienceLogon ] + [-AllowDiagnosticSubmission ] + [-AllowiCloudBackup ] + [-AllowiCloudDocSync ] + [-AllowiCloudPhotoSync ] + [-AllowPassbookWhileLocked ] + [-AllowScreenshot ] + [-AllowSimplePassword ] + [-AllowVideoConferencing ] + [-AllowVoiceAssistant ] + [-AllowVoiceDialing ] + [-AntiVirusSignatureStatus ] + [-AntiVirusStatus ] + [-AppsRating ] + [-AutoUpdateStatus ] + [-BluetoothEnabled ] + [-CameraEnabled ] + [-Confirm] + [-DomainController ] + [-EmailAddress ] + [-EnableRemovableStorage ] + [-ExchangeActiveSyncHost ] + [-FirewallStatus ] + [-ForceAppStorePassword ] + [-ForceEncryptedBackup ] + [-MaxPasswordAttemptsBeforeWipe ] + [-MaxPasswordGracePeriod ] + [-MoviesRating ] + [-PasswordComplexity ] + [-PasswordExpirationDays ] + [-PasswordHistoryCount ] + [-PasswordMinComplexChars ] + [-PasswordMinimumLength ] + [-PasswordQuality ] + [-PasswordRequired ] + [-PasswordTimeout ] + [-PhoneMemoryEncrypted ] + [-RegionRatings ] + [-RequireEmailProfile ] + [-SmartScreenEnabled ] + [-SystemSecurityTLS ] + [-TVShowsRating ] + [-UserAccountControlStatus ] + [-WhatIf] + [-WLANEnabled ] + [-WorkFoldersSyncUrl ] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-DeviceConfigurationRule -Identity "Engineering Group{914f151c-394b-4da9-9422-f5a2f65dec30}" -AllowScreenshot $false +``` + +This example modifies the specified mobile device configuration rule to block screenshots. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mobile device configuration rule that you want to modify. The name of the rule uses the syntax `] + [-RetryDistribution] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Set-DeviceTenantPolicy [-Identity ] + [-Comment ] + [-Enabled ] + [-Force] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-DeviceTenantPolicy -Enabled $false +``` + +This example disables your organization's mobile device tenant policy. + +## PARAMETERS + +### -RetryDistribution +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the name of the mobile device tenant policy that you want to 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 +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-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md new file mode 100644 index 0000000000..e931196275 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md @@ -0,0 +1,192 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DeviceTenantRule + +## 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-DeviceTenantRule cmdlet to modify your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DeviceTenantRule [-Identity] + [-ApplyPolicyTo ] + [-BlockUnsupportedDevices ] + [-Confirm] + [-DomainController ] + [-ExclusionList ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The cmdlets in Basic Mobility and Security are described in the following list: + +- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Exchange Online email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. +- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Microsoft 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in Basic Mobility and Security. +- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. +- Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). + +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-DeviceTenantRule -ExclusionList "Research and Development" +``` + +This example modifies your organization's mobile device tenant rule by replacing the current exclusion list with the security group named Research and Development. Members of this group are allowed access even if they use non-compliant devices. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ApplyPolicyTo +The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: + +- ExchangeOnline +- SharePointOnline +- ExchangeAndSharePoint + +```yaml +Type: PolicyResourceScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockUnsupportedDevices +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. +- $false: Unsupported devices are allowed. + +```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 +``` + +### -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 +``` + +### -ExclusionList +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. + +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"`. + +```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-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md new file mode 100644 index 0000000000..7d84dcf397 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -0,0 +1,1728 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-DistributionGroup cmdlet to modify the settings of existing distribution groups or mail-enabled security groups. To add or remove group members, use the Add-DistributionGroupMember, Remove-DistributionGroupMember or Update-DistributionGroupMember cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DistributionGroup [-Identity] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArbitrationMailbox ] + [-BccBlocked ] + [-BypassModerationFromSendersOrMembers ] + [-BypassNestedModerationEnabled ] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-Description ] + [-DisplayName ] + [-DomainController ] + [-EmailAddresses ] + [-EmailAddressPolicyEnabled ] + [-ExpansionServer ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HiddenGroupMembershipEnabled] + [-IgnoreDefaultScope] + [-IgnoreNamingPolicy] + [-MailTip ] + [-MailTipTranslations ] + [-ManagedBy ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MemberDepartRestriction ] + [-MemberJoinRestriction ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-PrimarySmtpAddress ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-ReportToManagerEnabled ] + [-ReportToOriginatorEnabled ] + [-RequireSenderAuthenticationEnabled ] + [-ResetMigrationToUnifiedGroup] + [-RoomList] + [-SamAccountName ] + [-SendModerationNotifications ] + [-SendOofMessageToOriginatorEnabled ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UpdateMemberCount] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-DistributionGroup -Identity "Accounting" -DisplayName "Accounting Group" +``` + +This example changes the display name of an existing distribution group from Accounting to Accounting Group. + +### Example 2 +```powershell +Set-DistributionGroup -Identity "Bldg34 Conf Rooms" -RoomList +``` + +This example converts the Bldg34 Conf Rooms distribution group to a room list. + +### Example 3 +```powershell +Set-DistributionGroup -Identity Ed_DirectReports -Name Ayla_DirectReports -IgnoreNamingPolicy +``` + +This example changes the name of an existing distribution group from Ed\_DirectReports to Ayla\_DirectReports and ignores the group naming policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: DistributionGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -BccBlocked +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassNestedModerationEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDTMFMap +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +This parameter is available only in the cloud-based service. + +The Description parameter specifies an optional description for the distribution group. If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpansionServer +This parameter is available only in on-premises Exchange. + +The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. + +You can specify the following types of servers as expansion servers: + +- An Exchange 2013 or later Mailbox server. +- An Exchange 2010 Hub Transport server. + +When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: `Get-ExchangeServer | Format-List ExchangeLegacyDN`. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". + +```yaml +Type: String +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 +``` + +### -ExtensionCustomAttribute1 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this group. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenGroupMembershipEnabled +This parameter is available only in the cloud-based service. + +The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from users who aren't members of the group. You don't need to specify a value with this switch. + +You can use this setting to help comply with regulations that require you to hide group membership from members or outsiders (for example, a distribution group that represents students enrolled in a class). + +**Note**: If you hide the membership of the group with this parameter, you can't edit the group later to reveal the membership to the group. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IgnoreNamingPolicy +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +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 +- Add or remove group members +- Delete the group +- Approve member depart or join requests (if available) +- Approve messages sent to the group if moderation is enabled, but no moderators are specified. + +The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). + +Considerations for mail-enabled security groups as group owners: + +- If you specify a mail-enabled security group as a group owner in on-premises Exchange, the mail-enabled security group doesn't sync to the cloud object. +- Group management in Outlook doesn't work if the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. If you specify a mail-enabled security group as the owner of the group, the group isn't visible in **Distribution groups I own** for the group owners (members of the mail-enabled security group). + +You can use any value that uniquely identifies the owner. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple owners and overwrite all existing entries, use the following syntax: `Owner1,Owner2,...OwnerN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Owner1","Owner2",..."OwnerN"`. + +To add or remove owners without affecting other existing entries, use the following syntax: `@{Add="Owner1","Owner2",...; Remove="Owner3","Owner4"...}`. + +Owners that you specify with this parameter are not added as group members. You need to manually add the owner as a member. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +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 +``` + +### -MaxSendSize +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. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +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 +``` + +### -MemberDepartRestriction +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberJoinRestriction +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For mail-enabled security groups, you need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +For distribution groups, if you set the ModerationEnabled parameter to the value $true, but you don't use this parameter to specify any moderators, the group owners that are specified by the ManagedBy parameter are responsible for approving messages sent to the group. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportToManagerEnabled +The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the 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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportToOriginatorEnabled +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. +- $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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetMigrationToUnifiedGroup +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomList +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendOofMessageToOriginatorEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDtmfMap +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: + +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` + +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. + +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. + +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. + +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. + +```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: False +Accept wildcard characters: False +``` + +### -UpdateMemberCount +This parameter is available only in the cloud-based service. + +{{ Fill UpdateMemberCount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/Set-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md similarity index 80% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-DkimSigningConfig.md rename to exchange/exchange-ps/exchange/Set-DkimSigningConfig.md index 8b329c638c..f2b0ed064b 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-DkimSigningConfig @@ -13,23 +16,29 @@ This cmdlet is available only in the cloud-based service. Use the Set-DkimSigningConfig cmdlet to modify the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-DkimSigningConfig [-Identity] [-AdminDisplayName ] - [-BodyCanonicalization ] [-Confirm] [-Enabled <$true | $false>] - [-HeaderCanonicalization ] [-PublishTxtRecords] [-WhatIf] [] +Set-DkimSigningConfig [-Identity] + [-AdminDisplayName ] + [-BodyCanonicalization ] + [-Confirm] + [-Enabled ] + [-HeaderCanonicalization ] + [-PublishTxtRecords] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-DkimSigningConfig -Identity contoso.com -Enabled $false ``` @@ -41,9 +50,7 @@ This example disables the DKIM signing policy for the contoso.com domain. 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). - - Distinguished name (DN) - - GUID ```yaml @@ -51,6 +58,7 @@ Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: True Position: 1 Default value: None @@ -66,6 +74,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -77,14 +86,14 @@ Accept wildcard characters: False 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. - - Simple: Only changes in empty lines at the end of the message body are tolerated. ```yaml -Type: Simple | Relaxed +Type: CanonicalizationType Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -95,8 +104,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -104,6 +112,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -115,14 +124,14 @@ Accept wildcard characters: False The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. - - $false: The policy is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -134,14 +143,14 @@ Accept wildcard characters: False 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. - - Simple: No changes to the header fields are tolerated. ```yaml -Type: Simple | Relaxed +Type: CanonicalizationType Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -150,13 +159,16 @@ Accept wildcard characters: False ``` ### -PublishTxtRecords -This parameter is reserved for internal Microsoft use. +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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -172,6 +184,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -180,20 +193,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8065e93d-3600-4fab-b72c-d783ba354c9c.aspx) diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md new file mode 100644 index 0000000000..ef3708c0cf --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -0,0 +1,1375 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DlpCompliancePolicy + +## 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-DlpCompliancePolicy cmdlet to modify data loss prevention (DLP) policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Set-DlpCompliancePolicy [-Identity] + [-AddEndpointDlpLocation ] + [-AddEndpointDlpLocationException ] + [-AddExchangeLocation ] + [-AddOneDriveLocation ] + [-AddOneDriveLocationException ] + [-AddOnPremisesScannerDlpLocation ] + [-AddOnPremisesScannerDlpLocationException ] + [-AddPowerBIDlpLocation ] + [-AddPowerBIDlpLocationException ] + [-AddSharePointLocation ] + [-AddSharePointLocationException ] + [-AddTeamsLocation ] + [-AddTeamsLocationException ] + [-AddThirdPartyAppDlpLocation ] + [-AddThirdPartyAppDlpLocationException ] + [-Comment ] + [-Confirm] + [-EndpointDlpAdaptiveScopes ] + [-EndpointDlpAdaptiveScopesException ] + [-EndpointDlpExtendedLocations ] + [-EnforcementPlanes ] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] + [-ExchangeSenderMemberOf ] + [-ExchangeSenderMemberOfException ] + [-Force] + [-IsFromSmartInsights ] + [-Locations ] + [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-Priority ] + [-RemoveEndpointDlpLocation ] + [-RemoveEndpointDlpLocationException ] + [-RemoveExchangeLocation ] + [-RemoveOneDriveLocation ] + [-RemoveOneDriveLocationException ] + [-RemoveOnPremisesScannerDlpLocation ] + [-RemoveOnPremisesScannerDlpLocationException ] + [-RemovePowerBIDlpLocation ] + [-RemovePowerBIDlpLocationException ] + [-RemoveSharePointLocation ] + [-RemoveSharePointLocationException ] + [-RemoveTeamsLocation ] + [-RemoveTeamsLocationException ] + [-RemoveThirdPartyAppDlpLocation ] + [-RemoveThirdPartyAppDlpLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-StartSimulation ] + [-TeamsLocation ] + [-TeamsLocationException ] + [-WhatIf] + [] +``` + +### RetryDistribution +``` +Set-DlpCompliancePolicy [-Identity] [-RetryDistribution] + [-Confirm] + [-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). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-DlpCompliancePolicy -Identity "Main PII" -RemoveExchangeLocation $_}`. + +## EXAMPLES + +### Example 1 +```powershell +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 and OneDrive locations for the DLP policy named Main PII without affecting the existing URL values. + +### Example 2 +```powershell +Set-DlpCompliancePolicy -Identity MainPII -Mode Disable +``` + +This example disables the "MainPII" policy. + +### Example 3 +```powershell +Set-DlpCompliancePolicy -Identity "PowerBIPolicy" -AddPowerBILocation "workspaceID1","workspaceID2","workspaceID3" +``` + +This example adds the specified workspace IDs to the Power BI location for the DLP policy named PowerBIPolicy without affecting the existing workspace IDs. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID +- Id + +```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 +``` + +### -RetryDistribution +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. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddEndpointDlpLocation +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddEndpointDLPLocation parameter specifies the user accounts to add to the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddEndpointDlpLocationException +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddEndpointDlpLocationException parameter specifies the user accounts to add to the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +If the policy doesn't already include email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: + +- If you use `-AddExchangeLocation All` by itself, the policy applies to email for all users. + +- To include email of specific group members in the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific group members from the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocation +The AddOneDriveLocation parameter adds OneDrive sites to the DLP policy if they're not already included. The valid value for this parameter is All. + +If the policy doesn't already include OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is blank), you can use this parameter in the following procedures: + +- If you use `-AddOneDriveLocation All` by itself, the policy applies to all OneDrive sites. + +- To include sites of specific OneDrive accounts in the policy, use `-AddOneDriveLocation All` and the OneDriveSharedBy parameter to specify the users. Only the sites of the specified users are included in the policy. + +- To include sites of specific group members in the policy, use `-AddOneDriveLocation All` and the OneDriveSharedByMemberOf parameter to specify the groups. Only the sites of members of the specified groups are included in the policy. + +- To exclude sites of specific OneDrive accounts from the policy, use `-AddOneDriveLocation All` and the ExceptIfOneDriveSharedBy parameter to specify the users. Only sites of the specified users are excluded from the policy. + +- To exclude sites of specific group members from the policy, use `-AddOneDriveLocation All` and the ExceptIfOneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. + +**Note**: Although this parameter accepts site URLs, don't specify site URLs values. Use the OneDriveSharedBy, ExceptIfOneDriveShareBy, OneDriveSharedByMemberOf, and ExceptIfOneDriveSharedByMemberOf parameters instead. In the DLP policy settings in the Microsoft Defender portal, you can't specify sites to include or exclude by URL; you specify sites to include or exclude only by users or groups. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocationException +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOnPremisesScannerDlpLocation +The AddOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOnPremisesScannerDlpLocationException +The AddOnPremisesScannerDlpLocationExclusion parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPowerBIDlpLocation +The AddPowerBIDlpLocation parameter specifies the Power BI workspace IDs to add to the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPowerBIDlpLocationException +The AddPowerBIDlpLocationException parameter specifies the Power BI workspace IDs to add to the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddTeamsLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddTeamsLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddThirdPartyAppDlpLocation +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to add to the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddThirdPartyAppDlpLocationException +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to add to the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity +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 +``` + +### -EndpointDlpAdaptiveScopes +{{ Fill EndpointDlpAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopesException +{{ Fill EndpointDlpAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpExtendedLocations +{{ Fill EndpointDlpExtendedLocations Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementPlanes +The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: + +`-EnforcementPlanes @("")`. + +Currently, the only supported value is Entra, for use with policies applied to an Entra-registered enterprise application in the organization. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedBy +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: + +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 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 sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOf +The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-DlpCOmpliancePolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderMemberOfException parameter. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeSenderMemberOfException +The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-DlpCOmpliancePolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderMemberOf parameter. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFromSmartInsights +{{ Fill IsFromSmartInsights Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The Locations parameter specifies to whom, what, and where the DLP policy applies. This parameter uses the following properties: + +- Workload: What the DLP policy applies to. Use the value `Applications`. +- Location: Where the DLP policy applies. For Microsoft 365 Copilot, (Preview), use the value `470f2276-e011-4e9d-a6ec-20768be3a4b0`. +- AddInclusions or RemoveInclusions: Add or remove security groups, distribution groups, or users to or from the scope of this DLP policy. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For security groups or distribution groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group,Identity:}`. +- AddExclusions or RemoveExclusions: Add or remove security groups, distribution groups, or users to or from exclusions to the scope of this DLP policy. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For security groups or distribution groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group,Identity:}`. + +You create and store the properties in a variable as shown in the following examples: + +DLP policy scoped to all users in the tenant: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","AddInclusions":[{Type:"Tenant",Identity:"All"}]}]"` + +DLP policy scoped to the specified user and groups: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","AddInclusions":[{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"},{"Type":"Group","Identity":"b4dc1e1d-8193-4525-b59c-6d6e0f1718d2"},{"Type":"IndividualResource","Identity":"yibing@contoso.com"}]}]"` + +DLP policy scoped to all users in the tenant except for members of the specified group: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","AddInclusions":[{Type:"Tenant",Identity:"All"}],"AddExclusions": [{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"},{"Type":"Group","Identity":"b4dc1e1d-8193-4525-b59c-6d6e0f1718d2"}]}]` + +After you create the `$loc` variable as shown in the previous examples, use the value `$loc` for this parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: + +- Enable: The policy is enabled for actions and notifications. This is the default value. +- Disable: The policy is disabled. +- TestWithNotifications: Simulation mode where no actions are taken, but notifications **are** sent. +- TestWithoutNotifications: Simulation mode where no actions are taken, and no notifications are sent. + +```yaml +Type: PolicyMode +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedBy +The OneDriveSharedBy parameter specifies the users to include in the 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 sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 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 sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. + +For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). + +```yaml +Type: PswsHashtable +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: + +- Valid priority values for the existing 5 policies are from 0 through 4. +- Valid priority values for a new 6th policy are from 0 through 5. +- The default value for a new 6th policy is 5. + +If you modify the priority value of a policy, the position of the policy in the list changes to match the priority value you specify. In other words, if you set the priority value of a policy to the same value as an existing policy, the priority value of the existing policy and all other lower priority policies after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveEndpointDlpLocation +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveEndpointDlpLocationException +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter removes email messages from the DLP policy if they're already included. The valid value for this parameter is All. + +If the policy already includes email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocation +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocationException +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOnPremisesScannerDlpLocation +The RemoveOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOnPremisesScannerDlpLocationException +The RemoveOnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePowerBIDlpLocation +The RemovePowerBIDlpLocation parameter specifies the Power BI workspace IDs to remove from the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePowerBIDlpLocationException +The RemovePowerBIDlpLocationException parameter specifies the Power BI workspace IDs to remove the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveTeamsLocation +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveTeamsLocationException +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: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveThirdPartyAppDlpLocation +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to remove from the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveThirdPartyAppDlpLocationException +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps tp remove from the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartSimulation +{{ Fill StartSimulation Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAdaptiveScopes +{{ Fill TeamsAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAdaptiveScopesException +{{ Fill TeamsAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md new file mode 100644 index 0000000000..4a833c4d4b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -0,0 +1,3495 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DlpComplianceRule + +## 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-DlpComplianceRule to modify data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule violations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DlpComplianceRule [-Identity] + [-AccessScope ] + [-ActivationDate ] + [-AddRecipients ] + [-AdvancedRule ] + [-AlertProperties ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-ApplyBrandingTemplate ] + [-ApplyHtmlDisclaimer ] + [-AttachmentIsNotLabeled ] + [-BlockAccess ] + [-BlockAccessScope ] + [-Comment ] + [-Confirm] + [-ContentCharacterSetContainsWords ] + [-ContentContainsSensitiveInformation ] + [-ContentExtensionMatchesWords ] + [-ContentFileTypeMatches ] + [-ContentIsNotLabeled ] + [-ContentIsShared ] + [-ContentPropertyContainsWords ] + [-Disabled ] + [-DocumentContainsWords ] + [-DocumentCreatedBy ] + [-DocumentCreatedByMemberOf ] + [-DocumentIsPasswordProtected ] + [-DocumentIsUnsupported ] + [-DocumentMatchesPatterns ] + [-DocumentNameMatchesPatterns ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] + [-DomainCountOver ] + [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] + [-EndpointDlpRestrictions ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfContentCharacterSetContainsWords ] + [-ExceptIfContentContainsSensitiveInformation ] + [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentFileTypeMatches ] + [-ExceptIfContentIsShared ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentContainsWords ] + [-ExceptIfDocumentCreatedBy ] + [-ExceptIfDocumentCreatedByMemberOf ] + [-ExceptIfDocumentIsPasswordProtected ] + [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentMatchesPatterns ] + [-ExceptIfDocumentNameMatchesPatterns ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] + [-ExceptIfFromScope ] + [-ExceptIfHasSenderOverride ] + [-ExceptIfHeaderContainsWords ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] + [-ExceptIfProcessingLimitExceeded ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderADAttributeContainsWords ] + [-ExceptIfSenderADAttributeMatchesPatterns ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderIPRanges ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSubjectContainsWords ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfUnscannableDocumentExtensionIs ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] + [-FromScope ] + [-GenerateAlert ] + [-GenerateIncidentReport ] + [-HasSenderOverride ] + [-HeaderContainsWords ] + [-HeaderMatchesPatterns ] + [-IncidentReportContent ] + [-MessageIsNotLabeled ] + [-MessageSizeOver ] + [-MessageTypeMatches ] + [-MipRestrictAccess ] + [-Moderate ] + [-ModifySubject ] + [-NonBifurcatingAccessScope ] + [-NotifyAllowOverride ] + [-NotifyEmailCustomSenderDisplayName ] + [-NotifyEmailCustomSubject ] + [-NotifyEmailCustomText ] + [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] + [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] + [-NotifyPolicyTipCustomText ] + [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] + [-NotifyUser ] + [-NotifyUserType ] + [-OnPremisesScannerDlpRestrictions ] + [-PrependSubject ] + [-Priority ] + [-ProcessingLimitExceeded ] + [-Quarantine ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] + [-RecipientDomainIs ] + [-RedirectMessageTo ] + [-RemoveHeader ] + [-RemoveRMSTemplate ] + [-ReportSeverityLevel ] + [-RestrictAccess ] + [-RestrictBrowserAccess ] + [-RuleErrorAction ] + [-SenderADAttributeContainsWords ] + [-SenderADAttributeMatchesPatterns ] + [-SenderAddressLocation ] + [-SenderDomainIs ] + [-SenderIPRanges ] + [-SentTo ] + [-SentToMemberOf ] + [-SetHeader ] + [-SharedByIRMUserRisk ] + [-StopPolicyProcessing ] + [-SubjectContainsWords ] + [-SubjectMatchesPatterns ] + [-SubjectOrBodyContainsWords ] + [-SubjectOrBodyMatchesPatterns ] + [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] + [-UnscannableDocumentExtensionIs ] + [-WhatIf] + [-WithImportance ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-DlpComplianceRule -Identity 25bf67b6-3783-4f74-bde9-98dd40333082 -AccessScope NotInOrganization -BlockAccess $true +``` + +This example modifies the access scope and blocking behavior of a DLP compliance rule that's identified by its GUID value. + +### Example 2 +```powershell +# Contents of the file named C:\Data\Sensitive Type.txt: + +{ +"Version": "1.0", +"Condition": { + "Operator": "And", + "SubConditions": [ + { + "ConditionName": "ContentContainsSensitiveInformation", + "Value": [ + { + "groups": [ + { + "Operator": "Or", + "labels": [ + { + "name": "defa4170-0d19-0005-000a-bc88714345d2", + "type": "Sensitivity" + } + ], + "name": "Default", + "sensitivetypes": [ + { + "confidencelevel": "Low", + "name": "Credit Card Number" + } + ] + } + ] + } + ] + }, + { + "Operator": "Not", + "SubConditions": [ + { + "Operator": "OR", + "SubConditions": [ + { + "ConditionName": "FromMemberOf", + "Value": [ + "janesteam@contoso.com" + ] + }, + { + "ConditionName": "SentTo", + "Value": [ + "adele@contoso.com" + ] + } + ], + } + ] + } + ] + } +} + +$data = Get-Content -Path "C:\Data\Sensitive Type.txt" -ReadCount 0 + +$AdvancedRuleString = $data | Out-string + +Set-DLPComplianceRule -Identity "Contoso Rule 1" -AdvancedRule $AdvancedRuleString +``` + +This example uses the AdvancedRule parameter to read the following complex condition from a file: "Content contains sensitive information: "Credit card number OR Highly confidential" AND (NOT (Sender is a member of "Jane's Team" OR Recipient is "adele@contoso.com")). + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Id + +```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 +``` + +### -AccessScope +The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: + +- InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule is applied to content that's accessible or delivered to a recipient outside the organization. +- None: The condition isn't used. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivationDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddRecipients +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"}`. +- `@{AddManagerAsRecipientType = ""}`. For example, `@{AddManagerAsRecipientType = "Bcc"}`. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedRule +The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. + +This parameter uses JSON syntax that's similar to the traditional advanced syntax, but is read from a file that contains additional operators and combinations that aren't traditionally supported. + +For syntax details, see Example 2. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertProperties +{{ Fill AlertProperties Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +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"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyBrandingTemplate +The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). + +Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimer +The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. + +- 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. +- Location: Specifies where to insert the HTML disclaimer text in the body of messages. Append = Add to the end of the message body. Prepend = Insert at the beginning of the message body. +- FallbackAction: Specifies what to do if the HTML disclaimer can't be added to a message. Wrap = The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. Ignore = The rule is ignored and the message is delivered without the disclaimer. Reject = The message is rejected. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsNotLabeled +{{ Fill AttachmentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockAccess +The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: + +- $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. + +```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 +``` + +### -BlockAccessScope +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. +- PerUser: Blocks access to external users. +- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentCharacterSetContainsWords +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`. + +```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 +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information 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"})})})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentExtensionMatchesWords +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFileTypeMatches +{{ Fill ContentFileTypeMatches Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsNotLabeled +{{ Fill ContentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsShared +{{ Fill ContentIsShared Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPropertyContainsWords +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: + +- $true: The rule is disabled. +- $false: The rule is enabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentContainsWords +The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. + +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedBy +{{ Fill DocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedByMemberOf +{{ Fill DocumentCreatedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsPasswordProtected +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsUnsupported +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. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentMatchesPatterns +The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentNameMatchesPatterns +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. + +```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 +``` + +### -DocumentNameMatchesWords +The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentSizeOver +The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainCountOver +The DomainCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipient domains is greater than the specified value. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptRMSTemplate +The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). + +Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. + +```yaml +Type: RmsTemplateIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpBrowserRestrictions +{{ Fill EndpointDlpBrowserRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpRestrictions +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. + +The value of `` is one of the supported values. + +The value of `` is Audit, Block, Ignore, or Warn. + +Example values: + +- `@{"Setting"="Print"; "Value"="Block"}` +- `@{"Setting"="CopyPaste"; "Value"="Block";}` +- `@{"Setting"="ScreenCapture"; "Value"="Block";}` +- `@{"Setting"="RemovableMedia"; "Value"="Block";}` +- `@{"Setting"="NetworkShare"; "Value"="Block";}` +- `@{"Setting"="Print"; "Value"="Audit";}` +- `@{"Setting"="UnallowedApps"; "Value"="notepad"; "value2"="Microsoft Notepad"}` + +When you use the values Block or Warn in this parameter, also need to use the NotifyUser parameter. + +You can view and configure the available restrictions with the Get-PolicyConfig and Set-PolicyConfig cmdlets. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcePortalAccess +The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: + +- $true: External recipients are required to use the encrypted message portal to view encrypted messages. +- $false: External recipients aren't required to use the encrypted message portal. Outlook can decrypt messages inline. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvaluateRulePerComponent +The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: + +- $true: A DLP rule match for conditions and exceptions must be in the same message component (for example, in the message body or in a single attachment). +- $false: A DLP rule match for conditions and exceptions can be anywhere in the message. + +For example, say a DLP rule is configured to block messages that contain three or more Social Security numbers (SSNs). When the value of this parameter is $true, a message is blocked only if there are three or more SSNs in the message body, or there are three or more SSNs in a specific attachment. The DLP rule doesn't match and the message isn't blocked if there are two SSNs in the message body, one SSN in an attachment, and two SSNs in another attachment in the same email message. + +This parameter works with the following conditions or exceptions only: + +- Content contains +- Attachment contains +- Attachment is not labeled +- File extension is + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAccessScope +The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: + +- InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule isn't applied to content that's accessible or delivered to a recipient outside the organization. +- None: The exception isn't used. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentCharacterSetContainsWords +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. + +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`. + +```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 +``` + +### -ExceptIfContentContainsSensitiveInformation +The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information 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"})})})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentExtensionMatchesWords +The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentFileTypeMatches +{{ Fill ExceptIfContentFileTypeMatches 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 +``` + +### -ExceptIfContentIsShared +{{ Fill ExceptIfContentIsShared 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 +``` + +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```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 +``` + +### -ExceptIfDocumentContainsWords +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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedBy +{{ Fill ExceptIfDocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedByMemberOf +{{ Fill ExceptIfDocumentCreatedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsPasswordProtected +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsUnsupported +The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: + +- $true: Look for unsupported files that can't be scanned. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentMatchesPatterns +The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesPatterns +The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +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"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromScope +The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: + +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasSenderOverride +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. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```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 +``` + +### -ExceptIfHeaderContainsWords +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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +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. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageSizeOver +The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageTypeMatches +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. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfProcessingLimitExceeded +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. +- $false: Don't look for files where scanning couldn't complete. + +```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 +``` + +### -ExceptIfRecipientADAttributeContainsWords +The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeMatchesPatterns +The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeContainsWords +The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeMatchesPatterns +The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +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. + +```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 +``` + +### -ExceptIfSenderIPRanges +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. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +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. + +```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 +``` + +### -ExceptIfSentToMemberOf +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectContainsWords +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"` +- 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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +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. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyMatchesPatterns +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. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfUnscannableDocumentExtensionIs +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of 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. + +```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 +``` + +### -ExceptIfWithImportance +The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDate +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +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"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: SmtpAddress[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromScope +The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: + +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateAlert +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. +- SiteAdmin + +You can specify multiple values separated by commas. + +The email message that's generated by this action contains a link to detailed information in the Microsoft Purview compliance portal (the details aren't in the email message itself). + +```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 +``` + +### -GenerateIncidentReport +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. +- SiteAdmin + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSenderOverride +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. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```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 +``` + +### -HeaderContainsWords +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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +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. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentReportContent +The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: + +- All +- Default +- Detections +- DocumentAuthor +- DocumentLastModifier +- MatchedItem +- RulesMatched +- Service +- Severity +- Service +- Title + +You can specify multiple values separated by commas. You can only use the value "All" by itself. If you use the value "Default", the report includes the following content: + +- DocumentAuthor +- MatchedItem +- RulesMatched +- Service +- Title + +Therefore, any additional values that you use with the value "Default" are ignored. + +```yaml +Type: ReportContentOption[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageIsNotLabeled +{{ Fill MessageIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageSizeOver +The MessageSizeOver parameter specifies a condition for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTypeMatches +The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: + +- ApprovalRequest: Moderation request messages sent to moderators. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MipRestrictAccess +{{ Fill MipRestrictAccess Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Moderate +The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifySubject +The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. + +The `ReplaceStrategy=` property uses one of the following values: + +- Replace: Replaces all regular expression matches (the `Patterns=` value) in the subject with the `SubjectText=` value. +- Append: Removes all regular expression matches (the `Patterns=` value) in the subject and inserts the `SubjectText=` value at the end of the subject. +- Prepend: Removes all regular expression matches (the `Patterns=` value) and inserts the `SubjectText=` value at the beginning of the subject. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonBifurcatingAccessScope +The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: + +- HasInternal: At least one recipient is inside the organization. +- HasExternal: At least one recipient is outside the organization. +- None: The condition isn't used. + +You can use this condition in DLP policies that are scoped only to Exchange + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyAllowOverride +The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: + +- FalsePositive: Allows overrides in the case of false positives. +- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only) +- WithoutJustification: Allows overrides without justification. +- WithJustification: Allows overrides with justification. + +You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. + +```yaml +Type: OverrideOption[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailCustomSenderDisplayName +{{ Fill NotifyEmailCustomSenderDisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailCustomSubject +The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. + +```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 +``` + +### -NotifyEmailCustomText +The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. + +This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): + +- %%AppliedActions%%: The actions applied to the content. +- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive site. +- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. +- %%BlockedMessageInfo%%: The details of the message that was blocked. Use this token to inform people of the details of the message that was blocked. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailExchangeIncludeAttachment +{{ Fill NotifyEmailExchangeIncludeAttachment Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailOnedriveRemediationActions +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEndpointUser +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +{{ Fill NotifyEndpointUser Description }} + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyOverrideRequirements +{{ Fill NotifyOverrideRequirements Description }} + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomDialog +{{ Fill NotifyPolicyTipCustomDialog Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomText +The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomTextTranslations +The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. + +Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. For example: `"en:PolicyTipInEnglish","zh:警告：这个文件含有非法内容","th:คำแนะนำนโยบายในไทย"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipDisplayOption +The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: + +- Tip: Displays policy tip at the top of the mail. This is the default value. +- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipUrl +The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUser +The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: + +- An email address. +- LastModifier +- Owner +- SiteAdmin + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUserType +The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: + +- NotSet +- Email +- PolicyTip +- Email,PolicyTip + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesScannerDlpRestrictions +{{ Fill OnPremisesScannerDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrependSubject +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is 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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new 9th rule that you add to the policy are from 0 through 8. +- The default value for a new 9th rule that you add to the policy is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it are increased by 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingLimitExceeded +The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: + +- $true: Look for files where scanning couldn't complete. +- $false: Don't look for files where scanning couldn't complete. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quarantine +This parameter specifies an action or part of an action for the rule. + +The Quarantine parameter specifies an action that quarantines messages. Valid values are: + +- $true: The message is delivered to the hosted quarantine. +- $false: The message is not quarantined. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeContainsWords +The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeMatchesPatterns +The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientCountOver +The RecipientCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipients is greater than the specified value. Groups are counted as one recipient. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```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 +``` + +### -RedirectMessageTo +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveHeader +The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. + +The maximum header name length is 64 characters, and header names can't contain spaces or colons ( : ). The maximum header value length is 128 characters. + +You can use this action in DLP policies that are scoped only to Exchange. + +```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 +``` + +### -RemoveRMSTemplate +The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $False: The messages and attachments are not decrypted. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSeverityLevel +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. +- 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 +``` + +### -RestrictAccess +{{ Fill RestrictAccess Description }} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictBrowserAccess +{{ Fill RestrictBrowserAccess Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: + +- Ignore: Ignore the failure of the rule and thereby any actions in that rule and move to the next rule. +- RetryThenBlock: Do a maximum of 5 retries of the rule with an increasing time gap of 10 min (i.e, 1st retry happens after 10 min, 2nd retry after 20 min, etc.). After the failure of the fifth retry, the message is dropped and we send a non-delivery report (also known as an NDR or bounce messages). +- Blank (the value $null): Defer the delivery of the message and keep retrying the rule. This is the default value. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeContainsWords +The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeMatchesPatterns +The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +Note that message envelope searching is available only for the following conditions and exceptions: + +- From and ExceptIfFrom +- FromAddressContainsWords and ExceptIfFromAddressContainsWords +- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns +- FromMemberOf and ExceptIfFromMemberOf +- SenderDomainIs and ExceptIfSenderDomainIs + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +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. + +```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 +``` + +### -SenderIPRanges +The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +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. + +```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 +``` + +### -SentToMemberOf +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. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetHeader +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. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedByIRMUserRisk +The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: + +- FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) +- 797C4446-5C73-484F-8E58-0CCA08D6DF6C (Moderate Risk Level) +- 75A4318B-94A2-4323-BA42-2CA6DB29AAFE (Minor Risk Level) + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: All +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopPolicyProcessing +The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: + +- $true: Stop processing more rules. +- $false: Continue processing more rules after this one. + +```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 +``` + +### -SubjectContainsWords +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"` +- 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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyContainsWords +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. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyMatchesPatterns +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. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyAppDlpRestrictions +{{ Fill ThirdPartyAppDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerPowerAutomateFlow +{{ Fill TriggerPowerAutomateFlow Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnscannableDocumentExtensionIs +The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -WithImportance +The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md new file mode 100644 index 0000000000..be8d02a43c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DlpEdmSchema + +## 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-DlpEdmSchema cmdlet to modify exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DlpEdmSchema [-FileData] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For an explanation and example of the EDM schema, see [Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-DlpEdmSchema -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\edm.xml')) -Confirm:$true +``` + +This example modifies a DLP EDM schema using the edm.xml file in the C:\\My Documents folder. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the DLP EDM schema that you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md new file mode 100644 index 0000000000..aa9f4a5616 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md @@ -0,0 +1,235 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DlpKeywordDictionary + +## 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-DlpKeywordDictionary cmdlet to modify data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DlpKeywordDictionary [-Identity] + [-Confirm] + [-Description ] + [-DoNotPersistKeywords] + [-FileData ] + [-Name ] + [-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 +$Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo" + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($keywords) + +Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords +``` + +This example replaces the existing terms in the DLP keyword dictionary named Diseases with the specified values. + +### Example 2 +```powershell +$Dictionary = Get-DlpKeywordDictionary -Name "Diseases" + +$Terms = $Dictionary.KeywordDictionary.split(',').trim() + +$Terms += "Achylia","Acidemia","Acidocytopenia","Acidocytosis","Acidopenia","Acidosis","Aciduria","Acladiosis","Aclasis" + +$Keywords = $Terms -Join ", " + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords) + +Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords +``` + +This example adds the specified terms to the DLP keyword dictionary named Diseases without affecting other existing terms. + +### Example 3 +```powershell +$Dictionary = Get-DlpKeywordDictionary -Name "Diseases" + +$Terms = $Dictionary.KeywordDictionary.split(',').trim() + +$TermsToRemove = @('abandonment', 'ablatio') + +$UpdatedTerms = $Terms | Where-Object {$_ -NotIn $TermsToRemove} + +$Keywords = $UpdatedTerms -Join ", " + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords) + +Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords +``` + +This example removes the specified terms from the DLP keyword dictionary named Diseases without affecting other existing terms. + +### Example 4 +```powershell +$Dictionary = Get-DlpKeywordDictionary -Name "Inappropriate Language" + +$Terms = $Dictionary.KeywordDictionary.split(',').trim() + +Set-Content $Terms -Path "C:\My Documents\InappropriateTerms.txt" + +$UpdatedTerms = Get-Content -Path "C:\My Documents\InappropriateTerms.txt" + +$Keywords = $UpdatedTerms -Join ", " + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords) + +Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywords +``` + +The first three commands export the terms from the existing keyword dictionary named Inappropriate Language to the file C:\\My Documents\\InappropriateTerms.txt, where each term is on a separate line. + +After you use Notepad to modify the terms and save the file, the last four commands use the file to replace the terms in the keyword dictionary. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotPersistKeywords +{{ Fill DoNotPersistKeywords Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileData +The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. + +The maximum file size is up to 1 MB of terms after compression. The organization limit for all dictionaries is also 1 MB after compression. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the 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 +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-DlpPolicy.md b/exchange/exchange-ps/exchange/Set-DlpPolicy.md new file mode 100644 index 0000000000..74002da4a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpPolicy.md @@ -0,0 +1,207 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +This cmdlet is functional only in on-premises Exchange. + +Use the Set-DlpPolicy cmdlet to modify data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DlpPolicy [-Identity] + [-Confirm] + [-Description ] + [-DomainController ] + [-Mode ] + [-Name ] + [-State ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-DlpPolicy "Employee Numbers" -State Disabled +``` + +This example disables the DLP policy named Employee Numbers. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DlpPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +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 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 +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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies the action and notification level of the DLP policy. Valid values 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. +- AuditAndNotify: When a message matches the conditions specified by the DLP policy, the actions specified by the policy aren't enforced, but notification emails are sent. +- Enforce: When a message matches the conditions specified by the DLP policy, the actions specified by the policy are enforced and notification emails are sent. + +If the State parameter is set to Disabled, the value of the Mode parameter is irrelevant. + +```yaml +Type: RuleMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md new file mode 100644 index 0000000000..e6a09ab1b6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md @@ -0,0 +1,297 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-DlpSensitiveInformationType cmdlet to modify sensitive information type rules that use document fingerprints. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DlpSensitiveInformationType [-Identity] + [-Confirm] + [-Description ] + [-FileData ] + [-Fingerprints ] + [-IsExact ] + [-Locale ] + [-Name ] + [-Threshold ] + [-ThresholdConfig ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-DlpSensitiveInformationType "Contoso Confidential" -Locale fr -Name "Contoso Confidentiel" -Description "Ce message contient des informations confidentielles." -IsDefault +``` + +This example adds a French translation to the existing sensitive information type rule named "Contoso Confidential", and sets this French translation as the default. + +### Example 2 +```powershell +Set-DlpSensitiveInformationType "Contoso Confidential" -Locale es -Name $null -Description $null +``` + +This example removes the existing Spanish translation from the sensitive information type rule named "Contoso Confidential". + +### Example 3 +```powershell +$Benefits_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Benefits Template.docx') + +$Benefits_Fingerprint = New-DlpFingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template" + +$Contoso_Confidential = Get-DlpSensitiveInformationType "Contoso Confidential" + +$Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints) + +$Array.Add($Benefits_FingerPrint[0]) + +Set-DlpSensitiveInformationType $Contoso_Confidential.Identity -FingerPrints $Array +``` + +This example modifies the existing sensitive information type rule named "Contoso Confidential" by adding a new document fingerprint for the file C:\\My Documents\\Contoso Benefits Template.docx without affecting any existing document fingerprints that are already defined. + +### Example 4 +```powershell +$cc = Get-DlpSensitiveInformationType "Contoso Confidential" + +$a = [System.Collections.ArrayList]($cc.Fingerprints) + +$a + +$a.RemoveAt(0) + +Set-DlpSensitiveInformationType $cc.Identity -FingerPrints $a +``` + +This example modifies the sensitive information type rule named "Contoso Confidential" by removing an existing document fingerprint without affecting other document fingerprints that are already defined. + +The first three commands return the list of document fingerprints in the sensitive information type. The first document fingerprint in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the document fingerprint that you want to remove. The last two commands remove the first document fingerprint that's displayed in the list. + +## PARAMETERS + +### -Identity +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 +- LocalizedName +- Identity GUID value + +```yaml +Type: SensitiveInformationTypeIdParameter +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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileData +{{ Fill FileData Description }} + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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 +``` + +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +The Locale parameter adds or removes languages that are associated with the sensitive information type rule. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +Typically, you use the Locale parameter with the Name and Description parameters to add or remove translated names and descriptions for the sensitive information type rule. You can also use the Locale parameter with the IsDefault switch to designate an existing translated name and description as the default. Before you can remove the default translation, you need to set another translation as the default. + +```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 +``` + +### -Name +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. + +The value of the Name parameter is used in the Policy Tip that's presented to users in Outlook on the web. When a translated value of the Name parameter matches the client's language, the Policy Tip is displayed in the client's language. If no translated values of the Name parameter match the client's language, the default translation that's specified by the IsDefault parameter is used for the Policy Tip. + +```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 +``` + +### -Threshold +{{ Fill Threshold Description }} + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md new file mode 100644 index 0000000000..944203816e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-DlpSensitiveInformationTypeRulePackage + +## 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-DlpSensitiveInformationTypeRulePackage cmdlet to update existing data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DlpSensitiveInformationTypeRulePackage [-FileData] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-DlpSensitiveInformationTypeRulePackage -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Sensitive Info Type Rule Collection.xml')) +``` + +This example imports the sensitive information type rule package C:\\My Documents\\External Sensitive Info Type Rule Collection.xml. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the sensitive information type rule package that you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +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-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md new file mode 100644 index 0000000000..4b26f36939 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md @@ -0,0 +1,2061 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-DynamicDistributionGroup cmdlet to modify existing dynamic distribution groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DynamicDistributionGroup [-Identity] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArbitrationMailbox ] + [-BypassModerationFromSendersOrMembers ] + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DirectMembershipOnly ] + [-DisplayName ] + [-DomainController ] + [-EmailAddresses ] + [-EmailAddressPolicyEnabled ] + [-ExpansionServer ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ForceMembershipRefresh] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-IgnoreDefaultScope] + [-IncludedRecipients ] + [-MailTip ] + [-MailTipTranslations ] + [-ManagedBy ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Notes ] + [-PhoneticDisplayName ] + [-PrimarySmtpAddress ] + [-RecipientContainer ] + [-RecipientFilter ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-ReportToManagerEnabled ] + [-ReportToOriginatorEnabled ] + [-RequireSenderAuthenticationEnabled ] + [-SendModerationNotifications ] + [-SendOofMessageToOriginatorEnabled ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UpdateMemberCount] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +## 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 a group. You can use the Set-DynamicDistributionGroup cmdlet to overwrite existing settings or to add new settings. + +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-DynamicDistributionGroup -Identity Developers -IncludedRecipients MailboxUsers -ConditionalCompany "Contoso" -ConditionalCustomAttribute1 "Internal" +``` + +This example applies the following changes to the existing dynamic distribution group named Developers: + +- Change the ConditionalCompany query filter to Contoso. +- Change the IncludedRecipients query filter to MailboxUsers. +- Add the value Internal to the ConditionalCustomAttribute1 attribute. + +### Example 2 +```powershell +$extAtrValue="Contoso" + +Set-DynamicDistributionGroup -Identity Developers -RecipientFilter "ExtensionCustomAttribute1 -eq '$extAtrValue'" +``` + +This example applies the following changes to the existing dynamic distribution group named Developers: + +- Sets the RecipientFilter custom OPATH filter using a variable based value of a specific recipient property. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute1 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute10 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute11 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute12 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute13 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute14 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute15 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute2 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute3 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute4 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute5 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute6 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute7 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute8 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute9 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalDepartment +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalStateOrProvince +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDTMFMap +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectMembershipOnly +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpansionServer +This parameter is available only in on-premises Exchange. + +The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. + +You can specify the following types of servers as expansion servers: + +- An Exchange 2013 or later Mailbox server. +- An Exchange 2010 Hub Transport server. + +When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: `Get-ExchangeServer | Format-List ExchangeLegacyDN`. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". + +```yaml +Type: String +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 +``` + +### -ExtensionCustomAttribute1 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceMembershipRefresh +This parameter is available only in the cloud-based service. + +{{ Fill ForceMembershipRefresh Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +The ForceUpgrade switch 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this group. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -IncludedRecipients +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. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +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 +- Delete the group +- Approve messages sent to the group if moderation is enabled, but no moderators are specified. + +The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +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 +``` + +### -MaxSendSize +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. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +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 +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneticDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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 +- Canonical name +- Distinguished name (DN) +- GUID + +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). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientFilter +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportToManagerEnabled +The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owners of the group (defined by the ManagedBy property). Valid values are: + +- $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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportToOriginatorEnabled +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. +- $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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendOofMessageToOriginatorEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDtmfMap +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: + +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` + +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. + +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. + +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. + +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. + +```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: False +Accept wildcard characters: False +``` + +### -UpdateMemberCount +This parameter is available only in the cloud-based service. + +{{ Fill UpdateMemberCount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..2f487200f3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Set-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-EOPProtectionPolicyRule cmdlet to modify rules that are associated with Exchange Online Protection (EOP) protections in preset security policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-EOPProtectionPolicyRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" -ExceptIfSentToMemberOf "Test Group1","Test Group2" +``` + +This example provides exceptions to EOP protections in the Standard preset security policy for members of the specified groups. + +### Example 2 +```powershell +Set-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" -SentTo $null -ExceptIfSentTo $null -SentToMemberOf $null -ExceptIfSentToMemberOf $null -RecipientDomainIs $null -ExceptIfRecipientDomainIs $null +``` + +This example removes all conditions and exceptions from the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +You must use the default value for the rule. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/client-access-servers/Set-EcpVirtualDirectory.md rename to exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md index 55c3af1ddd..3383449510 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-EcpVirtualDirectory @@ -15,63 +18,71 @@ Use the Set-EcpVirtualDirectory cmdlet to modify Exchange Control Panel (ECP) vi The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013, and Exchange 2016 servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-EcpVirtualDirectory [-Identity] [-BasicAuthentication <$true | $false>] - [-Confirm] [-DigestAuthentication <$true | $false>] [-DomainController ] - [-ExtendedProtectionFlags ] [-ExtendedProtectionSPNList ] - [-ExtendedProtectionTokenChecking ] - [-ExternalAuthenticationMethods ] [-ExternalUrl ] - [-FormsAuthentication <$true | $false>] [-GzipLevel ] [-InternalUrl ] - [-LiveIdAuthentication <$true | $false>] [-WhatIf] [-WindowsAuthentication <$true | $false>] - [-AdfsAuthentication <$true | $false>] [-AdminEnabled <$true | $false>] [-OwaOptionsEnabled <$true | $false>] +Set-EcpVirtualDirectory [-Identity] + [-AdfsAuthentication ] + [-AdminEnabled ] + [-BasicAuthentication ] + [-Confirm] + [-DigestAuthentication ] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalAuthenticationMethods ] + [-ExternalUrl ] + [-FormsAuthentication ] + [-GzipLevel ] + [-InternalUrl ] + [-OAuthAuthentication ] + [-OwaOptionsEnabled ] + [-WhatIf] + [-WindowsAuthentication ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-EcpVirtualDirectory -Identity "Server01\ecp (Default Web site)" -BasicAuthentication:$false ``` This example disables Basic authentication on the default ECP virtual directory on the server named Server01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-EcpVirtualDirectory -Identity "Server01\ecp (Default Web site)" -AdminEnabled $false ``` -This example turns off the Internet access to the EAC on server named SErver01. +This example turns off the Internet access to the EAC on server named Server01. ## PARAMETERS ### -Identity -The Identity parameter specifies the virtual directory that you want to modify. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \\\Name +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. -To manage the first ECP virtual directory created in an Exchange organization, you need touse this cmdlet on the computer that includes the first ECP virtual directory. If you create additional ECP virtual directories, you can manage those remotely. +To manage the first ECP virtual directory created in an Exchange organization, you need to use this cmdlet on the computer that includes the first ECP virtual directory. If you create additional ECP virtual directories, you can manage those remotely. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -79,20 +90,54 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AdfsAuthentication +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminEnabled +The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet. For more information, see [Turn off access to the Exchange admin center](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BasicAuthentication 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. - - $false: Basic authentication is disabled. This parameter can be used with the FormsAuthentication parameter or with the DigestAuthentication and WindowsAuthentication parameters. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -103,8 +148,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -112,6 +156,7 @@ 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 @@ -123,14 +168,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -146,6 +191,7 @@ 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 @@ -157,13 +203,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -171,6 +213,7 @@ 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 @@ -182,14 +225,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -201,20 +244,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -230,6 +270,7 @@ 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 @@ -247,6 +288,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -258,14 +300,14 @@ Accept wildcard characters: False 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. - - $false: Forms authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -277,10 +319,11 @@ Accept wildcard characters: False The GzipLevel parameter sets Gzip configuration information for the ECP virtual directory. ```yaml -Type: Off | Low | High | Error +Type: GzipLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -298,38 +341,7 @@ Type: Uri 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 -``` - -### -LiveIdAuthentication -This parameter is available or functional only in Exchange Server 2010. - -The LiveIdAuthentication parameter specifies whether Windows Live ID authentication is enabled for the Exchange Control Panel virtual directory. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -337,18 +349,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WindowsAuthentication -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. - -- $false: Integrated Windows authentication is disabled. +### -OAuthAuthentication +{{ Fill OAuthAuthentication Description }} ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2019 + Required: False Position: Named Default value: None @@ -356,16 +365,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdfsAuthentication -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. +### -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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -373,14 +381,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdminEnabled -The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet. For more information, see Turn off access to the Exchange admin center (https://technet.microsoft.com/library/jj218639.aspx). This parameter accepts $true or $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: $true | $false +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -388,14 +397,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OwaOptionsEnabled -The OwaOptionsEnabled parameter specifies that Outlook on the web Options is enabled for end users. If this parameter is set to $false, users aren't able to access Outlook on the web Options. You may want to disable access if your organization uses third-party provider tools. This parameter accepts $true or $false. +### -WindowsAuthentication +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. +- $false: Integrated Windows authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -404,20 +417,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5341a329-71db-4180-ac0e-83515035ae2f.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/mail-flow/Set-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md index a38112b5ab..e63e09bc66 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-EdgeSyncServiceConfig @@ -13,27 +16,39 @@ This cmdlet is available only in on-premises Exchange. Use the Set-EdgeSyncServiceConfig cmdlet to modify the configuration of edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-EdgeSyncServiceConfig [-Identity] - [-ConfigurationSyncInterval ] [-Confirm] [-CookieValidDuration ] - [-DomainController ] [-FailoverDCInterval ] [-LockDuration ] - [-LockRenewalDuration ] [-LogEnabled <$true | $false>] - [-LogLevel ] [-LogMaxAge ] [-LogMaxDirectorySize ] - [-LogMaxFileSize ] [-LogPath ] [-Name ] [-OptionDuration ] - [-RecipientSyncInterval ] [-WhatIf] [] + [-ConfigurationSyncInterval ] + [-Confirm] + [-CookieValidDuration ] + [-DomainController ] + [-FailoverDCInterval ] + [-LockDuration ] + [-LockRenewalDuration ] + [-LogEnabled ] + [-LogLevel ] + [-LogMaxAge ] + [-LogMaxDirectorySize ] + [-LogMaxFileSize ] + [-LogPath ] + [-Name ] + [-OptionDuration ] + [-RecipientSyncInterval ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-EdgeSyncServiceConfig "Primary EdgeSync Settings" -LogEnabled $true -LogLevel Medium -LogPath "\\Server01\EdgeSyncLog" -LogMaxFileSize 5MB -LogMaxAge 3 ``` @@ -57,6 +72,7 @@ Type: EdgeSyncServiceConfigIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -74,6 +90,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -84,8 +101,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -93,6 +109,7 @@ 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 @@ -110,6 +127,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -125,6 +143,7 @@ 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 @@ -142,6 +161,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -159,6 +179,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -176,6 +197,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -187,10 +209,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -199,13 +222,19 @@ Accept wildcard characters: False ``` ### -LogLevel -The LogLevel parameter specifies the EdgeSync logging level. Valid values for this parameter are None, Low, Medium and High. The default value is None. +The LogLevel parameter specifies the EdgeSync logging level. Valid values are: + +- None (This is the default value) +- Low +- Medium +- High ```yaml -Type: None | Low | Medium | High +Type: EdgeSyncLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -223,6 +252,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -236,13 +266,9 @@ The LogMaxDirectorySize specifies the maximum amount of disk space the EdgeSyncL When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -254,6 +280,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -267,13 +294,9 @@ The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyn When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -285,6 +308,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -300,6 +324,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -315,6 +340,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -332,6 +358,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -349,6 +376,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -364,6 +392,7 @@ 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 @@ -372,20 +401,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1cc5a98c-d828-4122-84b3-2c4eefb3d475.aspx) diff --git a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md new file mode 100644 index 0000000000..3d157d6042 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md @@ -0,0 +1,826 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-EmailAddressPolicy cmdlet to modify email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-EmailAddressPolicy [-Identity] + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DisabledEmailAddressTemplates ] + [-DomainController ] + [-EnabledEmailAddressTemplates ] + [-EnabledPrimarySMTPAddressTemplate ] + [-ForceUpgrade] + [-IncludedRecipients ] + [-Name ] + [-Priority ] + [-RecipientContainer ] + [-RecipientFilter ] + [-WhatIf] + [] +``` + +## DESCRIPTION +After you use the Set-EmailAddressPolicy cmdlet to modify an email address policy in an on-premises Exchange organization, you need to use the Update-EmailAddressPolicy cmdlet to apply the updated policy to recipients. + +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-EmailAddressPolicy -Identity "Southeast Executives" -ConditionalStateOrProvince @{Add="TX"} +``` + +In on-premises Exchange, this example modifies the existing email address policy named Southeast Executives by adding the State or province value TX (Texas) to the precanned recipient filter. + +### Example 2 +```powershell +Set-EmailAddressPolicy -Identity "Contoso Corp" -DisabledEmailAddressTemplates $null +``` + +In on-premises Exchange, this example clears the disabled email address templates from the email address policy named Contoso Corp. + +### Example 3 +```powershell +Set-EmailAddressPolicy -Identity "Office 365 Groups" -EnabledEmailAddressTemplates "SMTP:@contoso.com","smtp:@contoso.onmicrosoft.com","smtp:@contoso.microsoftonline.com" +``` + +In Exchange Online, this example modifies the existing email address policy named "Office 365 Groups" and sets the enabled email address templates to use "@contoso.com" as the primary SMTP address and "@contoso.onmicrosoft.com" and "@contoso.microsoftonline.com" as proxy addresses. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute1 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute10 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute11 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute12 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute13 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute14 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute15 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute2 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute3 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute4 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute5 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute6 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute7 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute8 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute9 +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalDepartment +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -ConditionalStateOrProvince +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. + +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. + +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"...}`. + +```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: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledEmailAddressTemplates +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. +- 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"`. + +Typically, this property is only populated by values after a migration from a previous version of Exchange. To clear these values, use the value $null for this parameter. + +```yaml +Type: ProxyAddressTemplateCollection +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledEmailAddressTemplates +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`: + +- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. + +This parameter requires at least one template with the Type value SMTP (to define the primary SMTP email address). After that, if you don't include a Type prefix for a template, the value smtp (an SMTP proxy address) is assumed. + +You can specify multiple email address templates separated by commas: `"SMTP:PrimarySMTPEmailAddress","[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. + +You can't use this parameter with the EnabledPrimarySMTPAddressTemplate parameter. + +In Exchange Online PowerShell, if you use this parameter with the IncludeUnifiedGroupRecipients, you can't use variables in the email address template. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledPrimarySMTPAddressTemplate +The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. + +Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. + +You can't use this parameter with the EnabledEmailAddressTemplates parameter. + +In Exchange Online PowerShell, if you use this parameter with the IncludeUnifiedGroupRecipients, you can't use variables in the email address template. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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: + +- AllRecipients: This value can be used only by itself. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +```yaml +Type: WellKnownRecipientType +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 +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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. + +**Note**: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is the OU where the object was created. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -RecipientFilter +This parameter is available only in on-premises Exchange. + +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- Wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md b/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md new file mode 100644 index 0000000000..795f69bb1f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-emailtenantsettings +applicable: Exchange Online +title: Set-EmailTenantSettings +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-EmailTenantSettings + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-EmailTenantSettings cmdlet to enable or disable priority account protection in your Microsoft Defender for Office 365 organization. For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-EmailTenantSettings [[-Identity] ] + [-Confirm] + [-DomainController ] + [-EnablePriorityAccountProtection ] + [-IgnoreDehydratedFlag] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-EmailTenantSettings -EnablePriorityAccountProtection $true +``` + +This example enables priority account protection in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the settings object that you want to modify. The only settings object in the organization is named Default. + +```yaml +Type: EmailTenantSettingsIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePriorityAccountProtection +The EnablePriorityAccountProtection parameter enables or disable priority account protection in the organization. Valid values are: + +- $true: Priority account protection is enabled. +- $false: Priority account protection is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDehydratedFlag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EventLogLevel.md b/exchange/exchange-ps/exchange/Set-EventLogLevel.md new file mode 100644 index 0000000000..4b819c2bb3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EventLogLevel.md @@ -0,0 +1,134 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-EventLogLevel + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-EventLogLevel cmdlet to set the event log level registry value for the specified category. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-EventLogLevel [-Identity] -Level + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-EventLogLevel -Identity "Exchange01\MSExchangeTransport\SmtpReceive" -Level High +``` + +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). + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Level +The Level parameter specifies the log level for the specific event logging category. The valid values are: + +- Lowest +- Low +- Medium +- High +- Expert + +```yaml +Type: ECIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -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/Set-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md new file mode 100644 index 0000000000..77225894de --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md @@ -0,0 +1,279 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-EventsFromEmailConfiguration + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-EventsFromEmailConfiguration cmdlet to modify the events from email settings on a mailbox. on Outlook clients and Outlook on the web. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Set-EventsFromEmailConfiguration [-Identity] + [-CreateEventsFromEmailAsPrivate ] + [-EventReservationProcessingLevel ] + [-FlightReservationProcessingLevel ] + [-FoodEstablishmentReservationProcessingLevel ] + [-InvoiceProcessingLevel ] + [-LodgingReservationProcessingLevel ] + [-ParcelDeliveryProcessingLevel ] + [-RentalCarReservationProcessingLevel ] + [-ServiceReservationProcessingLevel ] + [] +``` + +### ResetSettings +``` +Set-EventsFromEmailConfiguration [-Identity] + [-ResetSettings] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-EventsFromEmailConfiguration -Identity peter@contoso.com -InvoiceProgressingLevel Disabled +``` + +This example disables the discovery of invoices from messages for the user. + +### Example 2 +```powershell +Set-EventsFromEmailConfiguration -Identity peter@contoso.com -ServiceReservationProcessingLevel Calendar -CreateEventsFromEmailAsPrivate $true +``` + +This example enables the discovery of service reservations, automatically adds them to the user's calendar, and makes these automatically added events private. + +### Example 3 +```powershell +Set-EventsFromEmailConfiguration -Identity peter@contoso.com -ResetSettings +``` + +This example resets Events from Email settings for the user. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CreateEventsFromEmailAsPrivate +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. +- $false: The events are created as normal events. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventReservationProcessingLevel +This parameter has been deprecated and is no longer used. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlightReservationProcessingLevel +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. + +Note that these values are case sensitive. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FoodEstablishmentReservationProcessingLevel +This parameter has been deprecated and is no longer used. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvoiceProcessingLevel +This parameter has been deprecated and is no longer used. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LodgingReservationProcessingLevel +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParcelDeliveryProcessingLevel +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RentalCarReservationProcessingLevel +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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetSettings +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceReservationProcessingLevel +This parameter has been deprecated and is no longer used. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Set-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md similarity index 84% rename from exchange/exchange-ps/exchange/organization/Set-ExchangeAssistanceConfig.md rename to exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md index a1cb32403f..69e2cfccc7 100644 --- a/exchange/exchange-ps/exchange/organization/Set-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ExchangeAssistanceConfig @@ -13,44 +16,74 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ExchangeAssistanceConfig cmdlet to modify the Microsoft Exchange Help configurations for your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ExchangeAssistanceConfig [[-Identity] ] - [-CommunityLinkDisplayEnabled <$true | $false>] [-CommunityURL ] [-Confirm] - [-ControlPanelFeedbackEnabled <$true | $false>] [-ControlPanelFeedbackURL ] [-ControlPanelHelpURL ] - [-DomainController ] [-ExchangeHelpAppOnline <$true | $false>] - [-ManagementConsoleFeedbackEnabled <$true | $false>] [-ManagementConsoleFeedbackURL ] - [-ManagementConsoleHelpURL ] [-OWAFeedbackEnabled <$true | $false>] [-OWAFeedbackURL ] - [-OWAHelpURL ] [-OWALightFeedbackEnabled <$true | $false>] [-OWALightFeedbackURL ] - [-OWALightHelpURL ] [-PrivacyLinkDisplayEnabled <$true | $false>] [-PrivacyStatementURL ] [-WhatIf] + [-CommunityLinkDisplayEnabled ] + [-CommunityURL ] + [-Confirm] + [-ControlPanelFeedbackEnabled ] + [-ControlPanelFeedbackURL ] + [-ControlPanelHelpURL ] + [-DomainController ] + [-ExchangeHelpAppOnline ] + [-ManagementConsoleFeedbackEnabled ] + [-ManagementConsoleFeedbackURL ] + [-ManagementConsoleHelpURL ] + [-OWAFeedbackEnabled ] + [-OWAFeedbackURL ] + [-OWAHelpURL ] + [-OWALightFeedbackEnabled ] + [-OWALightFeedbackURL ] + [-OWALightHelpURL ] + [-PrivacyLinkDisplayEnabled ] + [-PrivacyStatementURL ] + [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-ExchangeAssistanceConfig -ExchangeHelpAppOnline $false -ManagementConsoleHelpURL 'http://exhelponline/' +### Example 1 +```powershell +Set-ExchangeAssistanceConfig -ExchangeHelpAppOnline $false -ManagementConsoleHelpURL 'https://exhelponline/' ``` This example changes the Help location for the Exchange admin center. ## PARAMETERS +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -CommunityLinkDisplayEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -66,6 +99,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -76,8 +110,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -85,6 +118,7 @@ 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 @@ -96,10 +130,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -115,6 +150,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -130,6 +166,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -147,6 +184,7 @@ 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 @@ -158,14 +196,14 @@ Accept wildcard characters: False 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. - - $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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -173,29 +211,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -ManagementConsoleFeedbackEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -211,6 +235,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -226,6 +251,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -237,10 +263,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -256,6 +283,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -271,6 +299,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -282,10 +311,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -301,6 +331,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -316,6 +347,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -327,10 +359,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -346,6 +379,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -361,6 +395,7 @@ 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 @@ -369,20 +404,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/75a38090-d854-4138-9b78-c514f85eb76c.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ExchangeFeature.md b/exchange/exchange-ps/exchange/Set-ExchangeFeature.md new file mode 100644 index 0000000000..f023153538 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExchangeFeature.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangefeature +applicable: Exchange Server 2019 +title: Set-ExchangeFeature +schema: 2.0.0 +author: lusassl-msft +ms.author: lusassl +ms.reviewer: srvar +--- + +# Set-ExchangeFeature + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ExchangeFeature cmdlet to approve or block features flighted via Feature Flighting on Exchange Server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExchangeFeature [-Identity] + [-Approve] + [-Block] + [-Confirm] + [-FeatureID ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-ExchangeFeature cmdlet lets you approve or block features flighted via Feature Flighting, a service introduced in the Exchange Server 2019 CU15 (2025H1) update. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ExchangeFeature -Identity ex01.contoso.com -FeatureID @("F1.1.1") -Approve +``` + +This example approves the feature F1.1.1 on the computer named ex01.contoso.com. + +### Example 2 +```powershell +Set-ExchangeFeature -Identity ex01.contoso.com -FeatureID @("F1.1.1", "F1.2.1", "F2.1.1") -Approve +``` + +This example approves the features F1.1.1, F1.2.1, and F2.1.1 on the computer named ex01.contoso.com. + +### Example 3 +```powershell +Set-ExchangeFeature -Identity ex01.contoso.com -FeatureID @("F1.1.1", "F1.2.1", "F2.1.1") -Block +``` + +This example blocks the features F1.1.1, F1.2.1, and F2.1.1 on the computer named ex01.contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Approve +The Approve switch approves the feature specified by the FeatureID parameter. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Block switch blocks the feature specified by the FeatureID parameter. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureID +The FeatureID parameter specifies the feature you want to control. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExchangeServer.md b/exchange/exchange-ps/exchange/Set-ExchangeServer.md new file mode 100644 index 0000000000..b010016da0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExchangeServer.md @@ -0,0 +1,421 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ExchangeServer + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ExchangeServer cmdlet to set Exchange attributes in Active Directory for a specified server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExchangeServer [-Identity] + [-Confirm] + [-CustomerFeedbackEnabled ] + [-DataCollectionEnabled ] + [-DomainController ] + [-ErrorReportingEnabled ] + [-InternetWebProxy ] + [-InternetWebProxyBypassList ] + [-MitigationsApplied ] + [-MitigationsBlocked ] + [-MitigationsEnabled ] + [-MonitoringGroup ] + [-ProductKey ] + [-RingLevel ] + [-StaticConfigDomainController ] + [-StaticDomainControllers ] + [-StaticExcludedDomainControllers ] + [-StaticGlobalCatalogs ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ExchangeServer -Identity TestServer.Contoso.com -ErrorReportingEnabled $false +``` + +This example disables error reporting on the specified server. + +### Example 2 +```powershell +Set-ExchangeServer -Identity 'SERVER01' -CustomerFeedbackEnabled $true +``` + +This example enrolls an Exchange server into the Customer Experience Improvement Program. In this example, the server name is SERVER01. + +### Example 3 +```powershell +Set-ExchangeServer -Identity 'SERVER01' -CustomerFeedbackEnabled $false +``` + +This example removes an Exchange server from the Customer Experience Improvement Program. In this example, the server name is SERVER01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 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 +``` + +### -CustomerFeedbackEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataCollectionEnabled +The DataCollectionEnabled parameter specifies whether the EM Service will collect and send diagnostic data to Microsoft using OCS. Valid values are: + +- $true: The EM Service collects and sends diagnostic data to Microsoft using OCS. +- $false: Data collection is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorReportingEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternetWebProxy +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. + +```yaml +Type: Uri +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 +``` + +### -InternetWebProxyBypassList +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"). + +The maximum number of servers you can enter with this parameter is 100. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitigationsApplied +Do not use this parameter. The EM service uses this parameter to store and track mitigation status. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitigationsBlocked +The MitigationsBlocked parameter specifies a list of mitigations that are blocked. The Mitigation IDs present in this list are not applied by EM service in its hourly run. + +To enter multiple values and overwrite any existing Mitigation entries, use the following syntax: `@("Entry1","Entry2",..."EntryN")`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitigationsEnabled +The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) automatically applies mitigations on the Exchange server. Valid values are: + +- $true: The EM Service automatically applies mitigations on the Exchange server. +- $false: Mitigations are not automatically applied on the Exchange server. + +For more information, see [Exchange Emergency Mitigation (EM) service](https://learn.microsoft.com/exchange/exchange-emergency-mitigation-service). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringGroup +The MonitoringGroup parameter specifies how to add your Exchange servers to monitoring groups. You can add your servers to an existing group or create a monitoring group based on location or deployment, or to partition monitoring responsibility among your servers. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductKey +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 +The RingLevel parameter specifies the server ring level that's used by the Feature Flighting feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticConfigDomainController +The StaticConfigDomainController parameter specifies whether to configure a domain controller to be used by the server via Directory Service Access (DSAccess). + +```yaml +Type: String +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 +``` + +### -StaticDomainControllers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticExcludedDomainControllers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticGlobalCatalogs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/organization/Set-ExchangeSettings.md b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md similarity index 81% rename from exchange/exchange-ps/exchange/organization/Set-ExchangeSettings.md rename to exchange/exchange-ps/exchange/Set-ExchangeSettings.md index 0a64dfe784..436392e2c0 100644 --- a/exchange/exchange-ps/exchange/organization/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ExchangeSettings @@ -13,17 +16,19 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ExchangeSettings cmdlet to configure Exchange setting objects that you created with the New-ExchangeSettings cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ClearHistory ``` -Set-ExchangeSettings [-Identity] [-ClearHistory] -Reason +Set-ExchangeSettings [-Identity] -Reason + [-ClearHistory] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### UpdateSetting @@ -33,7 +38,8 @@ Set-ExchangeSettings [-Identity] -ConfigName ] [-Force] [-GroupName ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### RemoveSetting @@ -43,14 +49,16 @@ Set-ExchangeSettings [-Identity] -ConfigName ] [-Force] [-GroupName ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### CreateSettingsGroup ``` -Set-ExchangeSettings [-Identity] [-CreateSettingsGroup] - -ExpirationDate -Reason [-ConfigPairs ] +Set-ExchangeSettings [-Identity] -ExpirationDate -Reason + [-ConfigPairs ] [-Confirm] + [-CreateSettingsGroup] [-Disable] [-DomainController ] [-Force] @@ -59,60 +67,77 @@ Set-ExchangeSettings [-Identity] [-CreateSettingsG [-MinVersion ] [-NameMatch ] [-Priority ] - [-Scope ] [-ScopeFilter ] - [-WhatIf] [] + [-Scope ] + [-ScopeFilter ] + [-WhatIf] + [] ``` ### CreateSettingsGroupGuid ``` -Set-ExchangeSettings [-Identity] [-CreateSettingsGroup] - -ExpirationDate -GuidMatch -Reason [-ConfigPairs ] [-Confirm] +Set-ExchangeSettings [-Identity] -ExpirationDate -GuidMatch -Reason + [-ConfigPairs ] + [-Confirm] + [-CreateSettingsGroup] [-Disable] [-DomainController ] [-Force] [-GroupName ] [-Priority ] - [-Scope ] [-WhatIf] + [-Scope ] + [-WhatIf] [] ``` ### CreateSettingsGroupAdvanced ``` -Set-ExchangeSettings [-Identity] [-CreateSettingsGroup] -Reason -SettingsGroup +Set-ExchangeSettings [-Identity] -Reason -SettingsGroup + [-CreateSettingsGroup] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### CreateSettingsGroupGeneric ``` -Set-ExchangeSettings [-Identity] [-CreateSettingsGroup] - -ExpirationDate -Reason [-ConfigPairs ] [-GenericScopeName ] [-GenericScopeValue ] [-GroupName ] +Set-ExchangeSettings [-Identity] -ExpirationDate -Reason + [-CreateSettingsGroup] + [-ConfigPairs ] + [-GenericScopeName ] + [-GenericScopeValue ] + [-GroupName ] [-Confirm] [-Disable] [-DomainController ] [-Force] [-Priority ] - [-Scope ] - [-WhatIf] [] + [-Scope ] + [-WhatIf] + [] ``` ### UpdateSettingsGroup ``` -Set-ExchangeSettings [-Identity] [-ExpirationDate ] -Reason [-GroupName ] [-UpdateSettingsGroup] +Set-ExchangeSettings [-Identity] -Reason + [-ExpirationDate ] + [-GroupName ] + [-UpdateSettingsGroup] [-Confirm] [-DomainController ] [-Force] [-Priority ] [-ScopeFilter ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### RemoveMultipleSettings ``` -Set-ExchangeSettings [-Identity] -Reason - -ConfigPairs [-GroupName ] [-RemoveSetting] +Set-ExchangeSettings [-Identity] -Reason -ConfigPairs + [-GroupName ] + [-RemoveSetting] [-Confirm] [-DomainController ] [-Force] @@ -122,49 +147,58 @@ Set-ExchangeSettings [-Identity] -Reason ### RemoveSettingsGroup ``` -Set-ExchangeSettings [-Identity] -Reason [-GroupName ] [-RemoveSettingsGroup] +Set-ExchangeSettings [-Identity] -Reason + [-GroupName ] + [-RemoveSettingsGroup] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### UpdateSettingsGroupAdvanced ``` -Set-ExchangeSettings [-Identity] -Reason -SettingsGroup [-UpdateSettingsGroup] +Set-ExchangeSettings [-Identity] -Reason -SettingsGroup + [-UpdateSettingsGroup] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### UpdateMultipleSettings ``` -Set-ExchangeSettings [-Identity] -Reason - -ConfigPairs [-GroupName ] [-UpdateSetting] +Set-ExchangeSettings [-Identity] -Reason -ConfigPairs + [-GroupName ] + [-UpdateSetting] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### EnableSettingsGroup ``` Set-ExchangeSettings [-Identity] -Reason - [-EnableGroup [-DisableGroup ] + [-EnableGroup ] + [-DisableGroup ] [-Confirm] [-DomainController ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ExchangeSettings Audit -UpdateSetting -ConfigName AuditLogPumperEnabled -ConfigValue $true -Reason "Enable Unified Audit Logging" ``` @@ -182,6 +216,7 @@ Type: ExchangeSettingsIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -197,6 +232,7 @@ Type: SwitchParameter Parameter Sets: ClearHistory Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -214,6 +250,7 @@ Type: String Parameter Sets: UpdateSetting, RemoveSetting Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -222,7 +259,7 @@ Accept wildcard characters: False ``` ### -ConfigPairs -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. +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. @@ -231,6 +268,7 @@ Type: String[] Parameter Sets: RemoveMultipleSettings, UpdateMultipleSettings Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -243,6 +281,7 @@ Type: String[] Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -260,6 +299,7 @@ Type: String Parameter Sets: UpdateSetting Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -277,6 +317,7 @@ Type: SwitchParameter Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupAdvanced, CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -287,7 +328,7 @@ Accept wildcard characters: False ### -ExpirationDate The ExpirationDate parameter specifies the end date/time of the Exchange settings that are defined by the specified Exchange settings group. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". You can only use the ExpirationDate parameter with the CreateSettingsGroup or UpdateSettings group parameters. @@ -296,6 +337,7 @@ Type: DateTime Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -308,6 +350,7 @@ Type: DateTime Parameter Sets: UpdateSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -327,6 +370,7 @@ Type: Guid Parameter Sets: CreateSettingsGroupGuid Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -342,6 +386,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -359,6 +404,7 @@ Type: SwitchParameter Parameter Sets: RemoveSetting, RemoveMultipleSettings Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -376,6 +422,7 @@ Type: SwitchParameter Parameter Sets: RemoveSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -393,6 +440,7 @@ Type: String Parameter Sets: CreateSettingsGroupAdvanced, UpdateSettingsGroupAdvanced Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -410,6 +458,7 @@ Type: SwitchParameter Parameter Sets: UpdateSetting, UpdateMultipleSettings Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -427,6 +476,7 @@ Type: SwitchParameter Parameter Sets: UpdateSettingsGroup, UpdateSettingsGroupAdvanced Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -437,15 +487,17 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -458,13 +510,14 @@ The Disable switch specifies that the Exchange settings group is disabled. You d You can only use this switch with the CreateSettingsGroup switch. -To use this switch to enable an Exchange settings group, use the syntax -Disable:$false. +To use this switch to enable an Exchange settings group, use this exact syntax `-Disable:$false`. ```yaml Type: SwitchParameter Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -482,6 +535,7 @@ Type: String Parameter Sets: EnableSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -497,6 +551,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -514,6 +569,7 @@ Type: String Parameter Sets: EnableSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -522,13 +578,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -544,6 +603,7 @@ Type: String Parameter Sets: CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -559,6 +619,7 @@ Type: String Parameter Sets: CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -570,11 +631,8 @@ Accept wildcard characters: False 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. - - Modify the ExpirationDate, Priority, and ScopeFilter values of existing Exchange settings groups. - - Remove existing Exchange settings groups. - - Add, remove, or update Exchange setting objects in existing Exchange settings groups. If the value contains spaces, enclose the value in quotation marks ("). @@ -584,6 +642,7 @@ 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 Default value: None @@ -603,6 +662,7 @@ Type: String Parameter Sets: CreateSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -622,6 +682,7 @@ Type: String Parameter Sets: CreateSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -641,6 +702,7 @@ Type: String Parameter Sets: CreateSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -656,6 +718,7 @@ Type: Int32 Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -667,26 +730,20 @@ Accept wildcard characters: False The Scope parameter specifies the scope of the Exchange settings object. Valid values are: - Dag - - Database - - Forest - - Generic - - Organization - - Process - - Server - - User ```yaml -Type: Forest | Dag | Server | Process | Database | Organization | User | Generic +Type: ExchangeSettingsScope Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -695,17 +752,27 @@ Accept wildcard characters: False ``` ### -ScopeFilter -The ScopeFilter parameter specifies the scope of an Exchange settings group based an OPATH filter (for example, ServerRole -like "Mailbox\*"). The filter that's used for this parameter is available for all Scope parameter values other than Forest. +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. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). -You use the ScopeFilter parameter only when you update Exchange settings groups by using the UpdateSettingsGroup switch with the GroupName parameter. +You can't use this parameter with the Scope parameter and the value Forest or other scope-related parameters. -You can't use this parameter with other scope-related parameters. +You use this parameter only when you update Exchange settings groups by using the UpdateSettingsGroup switch with the GroupName parameter. ```yaml Type: String Parameter Sets: CreateSettingsGroup, UpdateSettingsGroup Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -721,6 +788,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -729,20 +797,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/09882525-a579-4af6-9565-4e44a24c8786.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..2b5d969329 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-exophishsimoverriderule +applicable: Exchange Online +title: Set-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ExoPhishSimOverrideRule cmdlet to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExoPhishSimOverrideRule [-Identity] + [-AddDomains ] + [-AddSenderIpRanges ] + [-Comment ] + [-Confirm] + [-DomainController ] + [-RemoveDomains ] + [-RemoveSenderIpRanges ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoPhishSimOverrideRule | Set-ExoPhishSimOverrideRule -AddDomains blueyonderairlines.com -RemoveSenderIpRanges 192.168.1.55 +``` + +This example modifies the (presumably only) phishing simulation override rule with the specified settings. + +This example modifies the phishing simulation override rule with the specified settings. + +### Example 2 +```powershell +Set-ExoPhishSimOverrideRule -Identity "_Exe:PhishSimOverr:6fed4b63-3563-495d-a481-b24a311f8329" -AddDomains blueyonderairlines.com -RemoveSenderIpRanges 192.168.1.55 +``` + +This example modifies the specified phishing simulation override rule with the specified settings. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The name of the rule uses the following syntax: `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AddDomains +The AddDomains parameter specifies an existing entry to add to the list of email domains that are used by the third-party phishing simulation. + +You can specify multiple values separated by commas. A maximum of 20 entries are allowed in the list. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSenderIpRanges +The AddSenderIpRanges parameter specifies an existing entry to add to the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +A maximum of 10 entries are allowed in the list. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDomains +The RemoveDomains parameter specifies an existing entry to remove from the list of email domains that are used by the third-party phishing simulation. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSenderIpRanges +The RemoveSenderIpRanges parameter specifies an existing entry to remove from the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..b20f1787e3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule +applicable: Exchange Online +title: set-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ExoSecOpsOverrideRule cmdlet to modify SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +**Tip**: This cmdlet doesn't modify email addresses in the SecOps override rule. To modify the email addresses in the SecOps override rule, use the Set-SecOpsOverridePolicy cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExoSecOpsOverrideRule [-Identity] + [-Comment ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoSecOpsOverrideRule| Set-ExoSecOpsOverrideRule -Comment "Contact IT Management before modifying or removing this rule." +``` + +This example adds a comment to the (presumably only) SecOps mailbox override rule with the specified settings. + +### Example 2 +```powershell +Set-ExoSecOpsOverrideRule -Identity "_Exe:SecOpsOverrid:312c23cf-0377-4162-b93d-6548a9977efb" -Comment "Contact IT Management before modifying or removing this rule." +``` + +This example adds a comment to the specified SecOps mailbox override rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the SecOps override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md b/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md new file mode 100644 index 0000000000..83221e105b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md @@ -0,0 +1,138 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-ExternalInOutlook + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ExternalInOutlook cmdlet to modify the configuration of external sender identification that's available in Outlook, Outlook for Mac, Outlook on the web, and Outlook for iOS and Android. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExternalInOutlook [[-Identity] ] + [-AllowList ] + [-Enabled ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ExternalInOutlook -Enabled $true +``` + +This example enables external sender identification in supported versions of Outlook. + +### Example 2 +```powershell +Set-ExternalInOutlook -AllowList admin@fabrikam.com,admin@fourthcoffee.com +``` + +This example prevents the specified email addresses from receiving the External icon in the area of the subject line in supported versions of Outlook. + +### Example 3 +```powershell +Set-ExternalInOutlook -AllowList @{Add="admin@cohovineyard.com"; Remove="admin@fourthcoffee.com"} +``` + +This example adds and removes the specified email addresses from the exception list without affecting other existing entries. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowList +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). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +This parameter is meaningful only when the value of the Enabled parameter is $true. + +The maximum number of entries is 50, and the total size of all entries can't exceed one kilobyte. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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. +- $false: External sender identification in Outlook is disabled. + +After an admin enables this setting, it can take between 24 and 48 hours for users to see the External icon in messages from external senders in supported versions of Outlook. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-OrganizationConfig](https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig) diff --git a/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md b/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md new file mode 100644 index 0000000000..775dd3b86a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-featureconfiguration +applicable: Security & Compliance +title: Set-FeatureConfiguration +schema: 2.0.0 +--- + +# Set-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the Set-FeatureConfiguration cmdlet to modify Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-FeatureConfiguration [-Identity] [-Locations ] + [-Comment ] + [-Confirm] + [-Mode ] + [-ScenarioConfig ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Set-FeatureConfiguration "DSPM for AI - Capture interactions for Copilot experiences" -ScenarioConfig '{"Activities":["UploadText","DownloadText"],"EnforcementPlanes":["CopilotExperiences"],"SensitiveTypeIds":["All"],"IsIngestionEnabled":false}' +``` + +This example updates a collection policy named "DSPM for AI - Capture interactions for Copilot experiences" to disable content capture. + +### Example 2 +```powershell +Set-FeatureConfiguration "Microsoft Copilot collection policy for Contoso Sales" -Locations '[{"Workload":"Applications","Location":"52655","AddInclusions":[{"Type":"Group","Identity":"USSales@contoso.com"}]}]' +``` + +This example updates a collection policy named "Microsoft Copilot collection policy for Contoso Sales" to include the USSales@contoso.com group. + +### Example 3 +```powershell +Set-FeatureConfiguration "Microsoft Copilot collection policy for Contoso Sales" -Locations '[{"Workload":"Applications","Location":"52655","AddExclusions":[{"Type":"IndividualResource","Identity":"adele@contoso.com"}]}]' +``` + +This example updates a collection policy named "Microsoft Copilot collection policy for Contoso Sales" to exclude the adele@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the feature configuration that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The locations parameter specifies where the feature configuration applies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies feature configuration mode. Valid values are: + +- Enable: The feature configuration is enabled. +- Disable: The feature configuration is disabled. + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScenarioConfig +The ScenarioConfig parameter specifies additional information about the feature configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md similarity index 77% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md rename to exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md index fbec8b1f53..92e99bb1fe 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-FederatedOrganizationIdentifier @@ -13,16 +16,22 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization. -For more details, see Federation (https://technet.microsoft.com/library/dd335047.aspx). +For more details, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-FederatedOrganizationIdentifier [[-Identity] ] [-AccountNamespace ] - [-Confirm] [-DelegationFederationTrust ] [-DomainController ] - [-Enabled <$true | $false>] [-OrganizationContact ] [-WhatIf] [-DefaultDomain ] +Set-FederatedOrganizationIdentifier [[-Identity] ] + [-AccountNamespace ] + [-Confirm] + [-DefaultDomain ] + [-DelegationFederationTrust ] + [-DomainController ] + [-Enabled ] + [-OrganizationContact ] + [-WhatIf] [] ``` @@ -31,26 +40,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-FederatedOrganizationIdentifier -DelegationFederationTrust "Microsoft Federation Gateway" -AccountNamespace "Contoso.com" -Enabled $true ``` This example configures a federated organization identifier for the Exchange organization. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-FederatedOrganizationIdentifier -Enabled $false ``` This example temporarily disables federation for the Exchange organization. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-FederatedOrganizationIdentifier -Enabled $true ``` @@ -58,6 +67,22 @@ This example enables the organization identifier. This enables federation for th ## PARAMETERS +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -AccountNamespace The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway. @@ -65,7 +90,8 @@ The AccountNamespace parameter specifies the federated domain to be used to esta Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -76,15 +102,31 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDomain +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 Default value: None @@ -99,7 +141,8 @@ The DelegationFederationTrust parameter specifies the identity of the federation Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -117,6 +160,7 @@ 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 @@ -130,10 +174,11 @@ The Enabled parameter specifies whether the organization identifier is enabled. Setting the parameter to $false disables federation. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -141,21 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -OrganizationContact The OrganizationContact parameter specifies the SMTP address of the federation contact. @@ -163,7 +193,8 @@ The OrganizationContact parameter specifies the SMTP address of the federation c Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -178,22 +209,8 @@ 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 -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 Online, Exchange Online Protection -### -DefaultDomain -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 Required: False Position: Named Default value: None @@ -202,20 +219,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a7b8c08e-8c8c-4566-b92a-2731cca66ada.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-FederationTrust.md b/exchange/exchange-ps/exchange/Set-FederationTrust.md similarity index 80% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Set-FederationTrust.md rename to exchange/exchange-ps/exchange/Set-FederationTrust.md index 28cf45e685..5a6e6a3d8a 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-FederationTrust.md +++ b/exchange/exchange-ps/exchange/Set-FederationTrust.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-FederationTrust @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-FederationTrust cmdlet to modify an existing federation trust. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +33,8 @@ Set-FederationTrust [-Identity] -ApplicationUri [-PublishFederationCertificate] +Set-FederationTrust [-Identity] + [-PublishFederationCertificate] [-Confirm] [-DomainController ] [-Name ] @@ -47,30 +51,38 @@ Set-FederationTrust [-Identity] [-Name ] [-RefreshMetadata] [-Thumbprint ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-FederationTrust -Identity "Microsoft Federation Gateway" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 +### Example 1 +```powershell +Set-FederationTrust -Identity "Azure AD Authentication" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 ``` This example configures the federation trust Microsoft Federation Gateway to use the certificate with the thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 as the next certificate. -### -------------------------- Example 2 -------------------------- -``` -Set-FederationTrust -Identity "Microsoft Federation Gateway" -PublishFederationCertificate +### Example 2 +```powershell +Set-FederationTrust -Identity "Azure AD Authentication" -PublishFederationCertificate ``` This example configures the federation trust Microsoft Federation Gateway to use the next certificate as the current certificate. +### Example 3 +```powershell +Set-FederationTrust -Identity "Azure AD Authentication" -MetadataUrl https://nexus.microsoftonline-p.com/federationmetadata/2006-12/federationmetadata.xml +``` + +This example updates the configuration if the tenant is hosted in Microsoft 365 U.S. Government GCC High or DoD environment. + Before you configure a federation trust to use the next certificate as the current certificate, you need to use the Test-FederationTrust cmdlet to verify that the certificate is available on all Exchange servers. ## PARAMETERS @@ -78,11 +90,14 @@ Before you configure a federation trust to use the next certificate as the curre ### -Identity The Identity parameter specifies the name of the federation trust being modified. +**Note**: For Exchange Online organizations, use the value "Microsoft Entra authentication". + ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -98,6 +113,7 @@ Type: String Parameter Sets: ApplicationUri Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -117,6 +133,7 @@ Type: SwitchParameter Parameter Sets: PublishFederationCertificate Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -127,8 +144,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -136,6 +152,7 @@ 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 @@ -151,6 +168,7 @@ 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 @@ -166,6 +184,7 @@ Type: Uri Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -181,6 +200,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,13 +209,14 @@ Accept wildcard characters: False ``` ### -RefreshMetadata -The RefreshMetadata switch specifies that the metadata document and certificate is retrieved again from the Microsoft Federation Gateway. +The RefreshMetadata switch specifies that the metadata document and certificate is retrieved again from the Microsoft Federation Gateway. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -211,6 +232,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -226,6 +248,7 @@ 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 @@ -234,20 +257,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/67b2ab23-e868-448f-b5c6-f73c2136223c.aspx) diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md new file mode 100644 index 0000000000..2c6319179c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md @@ -0,0 +1,121 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-FilePlanPropertyAuthority + +## 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-FilePlanPropertyAuthority cmdlet to modify file plan property authorities. + +For 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-FilePlanPropertyAuthority [-Identity] + [-Confirm] + [-DisplayName ] + [-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-FilePlanPropertyAuthority -Identity "Contoso Authority" -DisplayName "Parent authority for Contoso" +``` + +This example modifies the display name for the custom file plan property authority named Contoso Authority. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -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 +``` + +### -DisplayName +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 +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-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md new file mode 100644 index 0000000000..c997f07927 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md @@ -0,0 +1,119 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-FilePlanPropertyCategory + +## 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-FilePlanPropertyCategory cmdlet to modify file plan property categories. + +For 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-FilePlanPropertyCategory [-Identity] [-Confirm] [-DisplayName ] + [-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-FilePlanPropertyCategory -Identity "Contoso Category" -DisplayName "Parent category for Contoso" +``` + +This example modifies the display name for the custom file plan property category named Contoso Category. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -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 +``` + +### -DisplayName +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 +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-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md new file mode 100644 index 0000000000..78ebda0733 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md @@ -0,0 +1,156 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-FilePlanPropertyCitation + +## 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-FilePlanPropertyCitation cmdlet to modify file plan property citations. + +For 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-FilePlanPropertyCitation [-Identity] + [-CitationJurisdiction ] + [-CitationUrl ] + [-Confirm] + [-DisplayName ] + [-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--FilePlanPropertyCitation -Identity "Contoso-0001" -CitationUrl https:intra.contoso.com/citation +``` + +This example modifies the citation URL for the custom file plan property citation named Contoso-0001. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CitationJurisdiction +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CitationUrl +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 +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 +``` + +### -DisplayName +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 +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-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md new file mode 100644 index 0000000000..40d312c5a8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md @@ -0,0 +1,126 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-FilePlanPropertyDepartment + +## 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-FilePlanPropertyDepartment cmdlet to modify file plan property departments. + +For 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-FilePlanPropertyDepartment [-Identity] + [-Confirm] + [-DisplayName ] + [-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). + +Use the Set-FilePlanPropertyDepartment cmdlet to + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## EXAMPLES + +### Example 1 +```powershell +Set-FilePlanPropertyDepartment -Identity "Contoso HR" -DisplayName "HR department for Contoso" +``` + +This example modifies the display name for the custom file plan property department named Contoso HR. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -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 +``` + +### -DisplayName +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 +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-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md new file mode 100644 index 0000000000..0be4986969 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-FilePlanPropertyReferenceId + +## 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-FilePlanPropertyReferenceId cmdlet to modify file plan property reference IDs. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-FilePlanPropertyReferenceId [-Identity] + [-Confirm] + [-DisplayName ] + [-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-FilePlanPropertyReferenceId -Identity "Contoso-0001" -DisplayName "Reference ID Contoso-0001" +``` + +This example modifies the display name for the custom file plan property reference ID named Contoso-0001. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -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 +``` + +### -DisplayName +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 +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-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md new file mode 100644 index 0000000000..384fa72ff4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md @@ -0,0 +1,122 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-FilePlanPropertySubCategory + +## 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-FilePlanPropertySubCategory cmdlet to modify file plan property subcategories. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-FilePlanPropertySubCategory [-Identity] + [-Confirm] + [-DisplayName ] + [-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-FilePlanPropertySubCategory -Identity "US Tax" -DisplayName "Subcategory for US Tax" +``` + +This example modifies the display name for the custom file plan property subcategory named US Tax. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- Id + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -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 +``` + +### -DisplayName +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 +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-FocusedInbox.md b/exchange/exchange-ps/exchange/Set-FocusedInbox.md new file mode 100644 index 0000000000..daebaa21e2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FocusedInbox.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-FocusedInbox + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-FocusedInbox cmdlet to enable or disable Focused Inbox for mailboxes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-FocusedInbox -Identity + [-FocusedInboxOn ] + [-UseCustomRouting] + [] +``` + +## DESCRIPTION +Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-FocusedInbox -Identity laura@contoso.com -FocusedInboxOn $false +``` + +This example disables Focused Inbox for the mailbox of laura@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FocusedInboxOn +The FocusedInboxOn parameter enables or disables Focused Inbox for the mailbox. Valid values are: + +- $true: Focused Inbox is enabled. This is the default value. +- $false: Focused Inbox is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-ForeignConnector.md b/exchange/exchange-ps/exchange/Set-ForeignConnector.md similarity index 84% rename from exchange/exchange-ps/exchange/mail-flow/Set-ForeignConnector.md rename to exchange/exchange-ps/exchange/Set-ForeignConnector.md index c77e2749c4..8ce9583a9c 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/Set-ForeignConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ForeignConnector @@ -13,27 +16,38 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ForeignConnector cmdlet to modify an existing Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ForeignConnector [-Identity] [-AddressSpaces ] - [-Comment ] [-Confirm] [-DomainController ] [-DropDirectory ] - [-DropDirectoryQuota ] [-Enabled <$true | $false>] [-Force] [-IsScopedConnector <$true | $false>] - [-MaxMessageSize ] [-Name ] [-RelayDsnRequired <$true | $false>] - [-SourceTransportServers ] [-WhatIf] [] +Set-ForeignConnector [-Identity] + [-AddressSpaces ] + [-Comment ] + [-Confirm] + [-DomainController ] + [-DropDirectory ] + [-DropDirectoryQuota ] + [-Enabled ] + [-Force] + [-IsScopedConnector ] + [-MaxMessageSize ] + [-Name ] + [-RelayDsnRequired ] + [-SourceTransportServers ] + [-WhatIf] + [] ``` ## DESCRIPTION A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ForeignConnector "Fax Connector" -MaxMessageSize 10MB ``` @@ -45,9 +59,7 @@ This example configures a 10 MB message size limit on the existing Foreign conne 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 - - Connector name - - ServerName\\ConnectorName ```yaml @@ -55,6 +67,7 @@ Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -63,33 +76,29 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is as follows: \:\;\ +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. - - 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. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("). For example, the following address space entries are equivalent: - "SMTP:contoso.com;1" - - "contoso.com;1" - - "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 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"`. -To add or remove one or more address space values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +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"...}`. ```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 @@ -105,6 +114,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -115,8 +125,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -124,6 +133,7 @@ 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 @@ -141,6 +151,7 @@ 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 @@ -152,7 +163,6 @@ Accept wildcard characters: False 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. - - 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. @@ -164,9 +174,7 @@ The Drop directory isn't created for you. Therefore, you have to manually create The Drop directory must have the following permissions assigned to it: - Network Service: Full Control - - System: Full Control - - Administrators: Full Control ```yaml @@ -174,6 +182,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -187,13 +196,9 @@ The DropDirectoryQuota parameter specifies the maximum size of all message files When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -205,6 +210,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -216,10 +222,11 @@ Accept wildcard characters: False The Enabled parameter specifies whether to enable the Foreign connector. The valid values are $true or $false. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -228,13 +235,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -246,10 +256,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -263,13 +274,9 @@ The MaxMessageSize parameter specifies the maximum size of a message that can pa When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -281,6 +288,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -296,6 +304,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -307,10 +316,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -321,15 +331,16 @@ Accept wildcard characters: False ### -SourceTransportServers 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: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -345,6 +356,7 @@ 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 @@ -353,20 +365,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/93d43160-f34a-418c-86b7-61c25fd9e847.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-FrontendTransportService.md b/exchange/exchange-ps/exchange/Set-FrontendTransportService.md similarity index 88% rename from exchange/exchange-ps/exchange/mail-flow/Set-FrontendTransportService.md rename to exchange/exchange-ps/exchange/Set-FrontendTransportService.md index ad71c5b830..1332c4a436 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-FrontendTransportService.md +++ b/exchange/exchange-ps/exchange/Set-FrontendTransportService.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-FrontendTransportService @@ -13,52 +16,74 @@ This cmdlet is available only in on-premises Exchange. Use the Get-FrontEndTransportService cmdlet to modify the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-FrontendTransportService [-Identity] - [-AgentLogEnabled <$true | $false>] [-AgentLogMaxAge ] - [-AgentLogMaxDirectorySize ] [-AgentLogMaxFileSize ] [-AgentLogPath ] - [-AntispamAgentsEnabled <$true | $false>] [-Confirm] [-ConnectivityLogEnabled <$true | $false>] - [-ConnectivityLogMaxAge ] [-ConnectivityLogMaxDirectorySize ] - [-ConnectivityLogMaxFileSize ] [-ConnectivityLogPath ] - [-DnsLogEnabled <$true | $false>] [-DnsLogMaxAge ] [-DnsLogMaxDirectorySize ] - [-DnsLogMaxFileSize ] [-DnsLogPath ] [-DomainController ] - [-ExternalDNSAdapterEnabled <$true | $false>] [-ExternalDNSAdapterGuid ] - [-ExternalDNSProtocolOption ] [-ExternalDNSServers ] - [-ExternalIPAddress ] [-InternalDNSAdapterEnabled <$true | $false>] - [-InternalDNSAdapterGuid ] [-InternalDNSProtocolOption ] - [-InternalDNSServers ] [-IntraOrgConnectorProtocolLoggingLevel ] - [-MaxConnectionRatePerMinute ] [-ReceiveProtocolLogMaxAge ] - [-ReceiveProtocolLogMaxDirectorySize ] [-ReceiveProtocolLogMaxFileSize ] - [-ReceiveProtocolLogPath ] [-ResourceLogEnabled <$true | $false>] - [-ResourceLogMaxAge ] [-ResourceLogMaxDirectorySize ] - [-ResourceLogMaxFileSize ] [-ResourceLogPath ] - [-SendProtocolLogMaxAge ] [-SendProtocolLogMaxDirectorySize ] - [-SendProtocolLogMaxFileSize ] [-SendProtocolLogPath ] - [-TransientFailureRetryCount ] [-TransientFailureRetryInterval ] [-WhatIf] - [-RoutingTableLogMaxAge ] [-RoutingTableLogMaxDirectorySize ] - [-RoutingTableLogPath ] [] + [-AgentLogEnabled ] + [-AgentLogMaxAge ] + [-AgentLogMaxDirectorySize ] + [-AgentLogMaxFileSize ] + [-AgentLogPath ] + [-AntispamAgentsEnabled ] + [-Confirm] + [-ConnectivityLogEnabled ] + [-ConnectivityLogMaxAge ] + [-ConnectivityLogMaxDirectorySize ] + [-ConnectivityLogMaxFileSize ] + [-ConnectivityLogPath ] + [-DnsLogEnabled ] + [-DnsLogMaxAge ] + [-DnsLogMaxDirectorySize ] + [-DnsLogMaxFileSize ] + [-DnsLogPath ] + [-DomainController ] + [-ExternalDNSAdapterEnabled ] + [-ExternalDNSAdapterGuid ] + [-ExternalDNSProtocolOption ] + [-ExternalDNSServers ] + [-ExternalIPAddress ] + [-InternalDNSAdapterEnabled ] + [-InternalDNSAdapterGuid ] + [-InternalDNSProtocolOption ] + [-InternalDNSServers ] + [-IntraOrgConnectorProtocolLoggingLevel ] + [-MaxConnectionRatePerMinute ] + [-ReceiveProtocolLogMaxAge ] + [-ReceiveProtocolLogMaxDirectorySize ] + [-ReceiveProtocolLogMaxFileSize ] + [-ReceiveProtocolLogPath ] + [-RoutingTableLogMaxAge ] + [-RoutingTableLogMaxDirectorySize ] + [-RoutingTableLogPath ] + [-SendProtocolLogMaxAge ] + [-SendProtocolLogMaxDirectorySize ] + [-SendProtocolLogMaxFileSize ] + [-SendProtocolLogPath ] + [-TransientFailureRetryCount ] + [-TransientFailureRetryInterval ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-FrontEndTransportService MBX01 -TransientFailureRetryCount 3 -TransientFailureRetryInterval 00:00:30 ``` This example sets the TransientFailureRetryCount parameter to 3 and sets the TransientFailureRetryInterval parameter to 30 seconds for the Front End Transport service on the Mailbox server named MBX01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-FrontEndTransportService MBX01 -ReceiveProtocolLogPath "C:\SMTP Protocol Logs\Receive.log" ``` @@ -74,6 +99,7 @@ Type: FrontendTransportServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -85,10 +111,11 @@ Accept wildcard characters: False The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -108,6 +135,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -121,13 +149,9 @@ The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent l When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -139,6 +163,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,13 +177,9 @@ The AgentLogMaxFileSize parameter specifies the maximum size of each agent log f When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -170,6 +191,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -185,6 +207,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -198,10 +221,11 @@ The AntispamAgentsEnabled parameter specifies whether anti-spam agents are insta You set this parameter by using a script. You shouldn't modify this parameter manually. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -212,8 +236,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -221,6 +244,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -232,10 +256,11 @@ Accept wildcard characters: False The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -255,6 +280,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -268,13 +294,9 @@ The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -286,6 +308,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -299,13 +322,9 @@ The ConnectivityLogMaxFileSize parameter specifies the maximum size of each conn When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -317,6 +336,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -332,6 +352,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -343,10 +364,11 @@ Accept wildcard characters: False The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -366,6 +388,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -379,13 +402,9 @@ The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -397,6 +416,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -410,13 +430,9 @@ The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -428,6 +444,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -443,6 +460,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -458,6 +476,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -469,10 +488,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -490,6 +510,7 @@ Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -501,10 +522,11 @@ Accept wildcard characters: False 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: Any | UseUdpOnly | UseTcpOnly +Type: ProtocolOption Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -522,6 +544,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -537,6 +560,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -548,10 +572,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -569,6 +594,7 @@ Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -582,10 +608,11 @@ The InternalDNSProtocolOption parameter specifies which protocol to use when you The default value is Any. ```yaml -Type: Any | UseUdpOnly | UseTcpOnly +Type: ProtocolOption Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -603,6 +630,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -611,17 +639,17 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel -The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connector In the Front End Transport servicee. Valid values are: +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. ```yaml -Type: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -637,6 +665,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -658,6 +687,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -673,13 +703,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -693,6 +719,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -708,13 +735,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -728,6 +751,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -745,6 +769,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -752,29 +777,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogEnabled -This parameter is reserved for internal Microsoft use. +### -RoutingTableLogMaxAge +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. -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. -### -ResourceLogMaxAge -This parameter is reserved for internal Microsoft use. +For example, to specify 5 days for this parameter, use 5.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting this parameter to 00:00:00 prevents the automatic removal of routing table log files because of their age. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -782,29 +797,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogMaxDirectorySize -This parameter is reserved for internal Microsoft use. +### -RoutingTableLogMaxDirectorySize +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. -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When you enter a value, qualify the value with one of the following units: -### -ResourceLogMaxFileSize -This parameter is reserved for internal Microsoft use. +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -812,14 +825,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogPath -This parameter is reserved for internal Microsoft use. +### -RoutingTableLogPath +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 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -841,6 +855,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -856,13 +871,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -876,6 +887,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -891,13 +903,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -911,6 +919,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -924,7 +933,6 @@ The SendProtocolLogPath parameter specifies the location of the protocol log dir 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: - The IntraOrgConnectorProtocolLoggingLevel parameter. - - The ProtocolLoggingLevel parameter on the Set-SendConnector cmdlet for each Send connector in the Front End Transport service. ```yaml @@ -932,6 +940,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -947,6 +956,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -966,6 +976,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -981,71 +992,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi 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 -``` - -### -RoutingTableLogMaxAge -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. - -For example, to specify 5 days for this parameter, use 5.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting this parameter to 00:00:00 prevents the automatic removal of routing table log files because of their age. -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingTableLogMaxDirectorySize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingTableLogPath -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 Default value: None @@ -1054,20 +1001,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/593be8fd-ae2d-4cd2-a98a-88c2e8c36ddd.aspx) diff --git a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md new file mode 100644 index 0000000000..b4bbb3747e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md @@ -0,0 +1,673 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-GlobalAddressList cmdlet to modify an existing global address list (GAL). + +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-GlobalAddressList [-Identity] + [-ConditionalCompany ] + [-ConditionalCustomAttribute1 ] + [-ConditionalCustomAttribute10 ] + [-ConditionalCustomAttribute11 ] + [-ConditionalCustomAttribute12 ] + [-ConditionalCustomAttribute13 ] + [-ConditionalCustomAttribute14 ] + [-ConditionalCustomAttribute15 ] + [-ConditionalCustomAttribute2 ] + [-ConditionalCustomAttribute3 ] + [-ConditionalCustomAttribute4 ] + [-ConditionalCustomAttribute5 ] + [-ConditionalCustomAttribute6 ] + [-ConditionalCustomAttribute7 ] + [-ConditionalCustomAttribute8 ] + [-ConditionalCustomAttribute9 ] + [-ConditionalDepartment ] + [-ConditionalStateOrProvince ] + [-Confirm] + [-DomainController ] + [-ForceUpgrade] + [-IncludedRecipients ] + [-Name ] + [-RecipientContainer ] + [-RecipientFilter ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: + +- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. +- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". +- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". + +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-GlobalAddressList 96d0c505-eba8-4103-ad4f-577a1bf4ad7b -Name GALwithNewName +``` + +This example assigns a new name, GALwithNewName, to the GAL with the GUID 96d0c505-eba8-4103-ad4f-577a1bf4ad7b. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConditionalCompany +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute1 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute10 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute11 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute12 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute13 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute14 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute15 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute2 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute3 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute4 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute5 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute6 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute7 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute8 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalCustomAttribute9 +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalDepartment +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalStateOrProvince +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. + +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"...}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedRecipients +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. +- MailboxUsers +- MailContacts +- MailGroups +- MailUsers +- Resources: This value indicates room or equipment mailboxes. + +You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientContainer +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: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +If you don't use this parameter, the default value is the OU where the object was created. + +```yaml +Type: OrganizationalUnitIdParameter +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 +``` + +### -RecipientFilter +The RecipientFilter parameter specifies an OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. +- In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/users-and-groups/Set-Group.md b/exchange/exchange-ps/exchange/Set-Group.md similarity index 80% rename from exchange/exchange-ps/exchange/users-and-groups/Set-Group.md rename to exchange/exchange-ps/exchange/Set-Group.md index 75f2d1db8c..25c66b6124 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-Group.md +++ b/exchange/exchange-ps/exchange/Set-Group.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-Group @@ -13,27 +16,40 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-Group cmdlet to modify group object settings. If the group is a mail-enabled security group or a distribution group, you can use the Set-DistributionGroup cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Group cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-Group [-Identity] [-BypassSecurityGroupManagerCheck] [-Confirm] [-DisplayName ] - [-DomainController ] [-IgnoreDefaultScope] [-IsHierarchicalGroup <$true | $false>] - [-ManagedBy ] [-Name ] [-Notes ] - [-PhoneticDisplayName ] [-SeniorityIndex ] [-SimpleDisplayName ] [-Universal] [-WhatIf] - [-WindowsEmailAddress ] [] +Set-Group [-Identity] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-Description ] + [-DisplayName ] + [-DomainController ] + [-IgnoreDefaultScope] + [-IsHierarchicalGroup ] + [-ManagedBy ] + [-Name ] + [-Notes ] + [-PhoneticDisplayName ] + [-SeniorityIndex ] + [-SimpleDisplayName ] + [-Universal] + [-WhatIf] + [-WindowsEmailAddress ] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-Group -Identity "Legal Department" -Universal -Notes "verified" ``` @@ -43,8 +59,8 @@ Change the group's scope to universal. Add a Notes parameter value of verified. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-Group -Identity "Human Resources" -IsHierarchicalGroup $true -SeniorityIndex 1 ``` @@ -53,18 +69,11 @@ This example specifies that the group Human Resources is a hierarchical group an ## PARAMETERS ### -Identity -The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. - -For example: +The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name - -- Display name - - Distinguished name (DN) - - Canonical DN - - GUID ```yaml @@ -72,6 +81,7 @@ 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 Default value: None @@ -80,19 +90,19 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) 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 @@ -103,8 +113,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -112,6 +121,25 @@ 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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +This parameter is available only in the cloud-based service. + +{{ Fill Description Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -129,6 +157,7 @@ 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 Default value: None @@ -148,6 +177,7 @@ 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 @@ -158,12 +188,11 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml @@ -171,6 +200,7 @@ 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 @@ -182,10 +212,11 @@ Accept wildcard characters: False 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: $true | $false +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 Default value: None @@ -197,50 +228,38 @@ Accept wildcard characters: False 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 - - Add or remove group members - - Delete the group - - Approve member depart or join requests (if available) - - Approve messages sent to the group if moderation is enabled, but no moderators are specified. The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) -To enter multiple owners and overwrite all existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple owners and overwrite all existing entries, use the following syntax: `Owner1,Owner2,...OwnerN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Owner1","Owner2",..."OwnerN"`. -To add or remove owners without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove owners without affecting other existing entries, use the following syntax: `@{Add="Owner1","Owner2",...; Remove="Owner3","Owner4"...}`. -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. +Owners that you specify with this parameter are not added as group members. You need to manually add the owners as a members. + +**Note**: Group management in Outlook doesn't work when the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. ```yaml Type: GeneralRecipientIdParameter[] Parameter Sets: (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 @@ -256,6 +275,7 @@ 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 Default value: None @@ -271,6 +291,7 @@ 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 Default value: None @@ -286,6 +307,7 @@ 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 Default value: None @@ -301,6 +323,7 @@ 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 Default value: None @@ -312,12 +335,10 @@ Accept wildcard characters: False 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 - - A - Z - - 0 - 9 - -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":" and "?". +- space +- `" ' ( ) + , - . / : ?` This parameter is meaningful only if the group is mail-enabled. @@ -326,6 +347,7 @@ 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 Default value: None @@ -334,13 +356,14 @@ Accept wildcard characters: False ``` ### -Universal -The Universal swtich changes the scope of the group from Global or DomainLocal to Universal. You don't need to specify a value with this switch. +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 Default value: None @@ -356,6 +379,7 @@ 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 @@ -367,7 +391,6 @@ Accept wildcard characters: False 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. - - In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. @@ -377,6 +400,7 @@ 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 Default value: None @@ -385,20 +409,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/924e6eb5-bb06-4e15-b122-cab414291cef.aspx) diff --git a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md new file mode 100644 index 0000000000..d1f0720b66 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md @@ -0,0 +1,335 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HoldCompliancePolicy + +## 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-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Microsoft Purview compliance portal. + +**Note**: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### RetryDistribution +``` +Set-HoldCompliancePolicy [-Identity] + [-RetryDistribution] + [-Confirm] + [-WhatIf] + [] +``` + +### Identity +``` +Set-HoldCompliancePolicy [-Identity] + [-AddExchangeLocation ] + [-AddPublicFolderLocation ] + [-AddSharePointLocation ] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-RemoveExchangeLocation ] + [-RemovePublicFolderLocation ] + [-RemoveSharePointLocation ] + [-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). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}`. + +## EXAMPLES + +### Example 1 +```powershell +Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14" +``` + +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 site `https://contoso.sharepoint.com/sites/teams/finance`. +- Removes public folders. +- Updates the comment. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RetryDistribution +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. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md new file mode 100644 index 0000000000..e86f4d51b9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md @@ -0,0 +1,244 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HoldComplianceRule + +## 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-HoldComplianceRule cmdlet to modify existing preservation rules in the Microsoft Purview compliance portal. + +**Note**: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-HoldComplianceRule [-Identity] + [-Comment ] + [-Confirm] + [-ContentDateFrom ] + [-ContentDateTo ] + [-ContentMatchQuery ] + [-Disabled ] + [-HoldContent ] + [-HoldDurationDisplayHint ] + [-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-HoldComplianceRule -Identity "Internal Company Rule" -HoldContent 180 +``` + +This example changes the hold duration for the existing preservation rule named "Internal Company Rule". + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateFrom +The ContentDateFrom parameter specifies the start date of the date range for content to include. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateTo +The ContentDateTo parameter specifies the end date of the date range for content to include. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldContent +The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldDurationDisplayHint +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. + +```yaml +Type: HoldDurationHint +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-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md new file mode 100644 index 0000000000..83888c656c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md @@ -0,0 +1,251 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HostedConnectionFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-HostedConnectionFilterPolicy cmdlet to modify the settings of connection filter policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-HostedConnectionFilterPolicy [-Identity] + [-AdminDisplayName ] + [-ConfigurationXmlRaw ] + [-Confirm] + [-EnableSafeList ] + [-IPAllowList ] + [-IPBlockList ] + [-MakeDefault] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-HostedConnectionFilterPolicy "Default" -IPAllowList 192.168.1.10,192.168.1.23 -IPBlockList 10.10.10.0/25,172.17.17.0/24 +``` + +This example modifies the connection filter policy named Default with the following settings: + +- Messages from 192.168.1.10 and 192.168.1.23 are never identified as spam. +- Messages from 10.10.10.0/25 and 172.17.17.0/24 are always identified as spam. + +### Example 2 +```powershell +Set-HostedConnectionFilterPolicy "Default" -IPAllowList @{Add="192.168.2.10","192.169.3.0/24","192.168.4.1-192.168.4.5"; Remove="192.168.1.10"} +``` + +This example modifies the connection filter policy named Default with the following settings: + +- The following IP addresses are added to the existing values in the IP allow list: 192.168.2.10, 192.169.3.0/24 and 192.168.4.1-192.168.4.5. +- The IP address 192.168.1.10 is removed from the existing values in the IP allow list. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +Typically, you only have one connection filter policy: the default policy named Default. + +```yaml +Type: HostedConnectionFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AdminDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationXmlRaw +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +$false: Don't use the safe list. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: + +- 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. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. Valid subnet mask values are /24 through /32. + +You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. + +**Note**: IPv6 ranges are not supported. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPBlockList +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. +- 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. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. Valid subnet mask values are /24 through /32. + +You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. + +**Note**: IPv6 ranges are not supported. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md new file mode 100644 index 0000000000..64de11808a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -0,0 +1,1317 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HostedContentFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-HostedContentFilterPolicy cmdlet to modify spam filter policies (content filter policies) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-HostedContentFilterPolicy [-Identity] + [-AddXHeaderValue ] + [-AdminDisplayName ] + [-AllowedSenderDomains ] + [-AllowedSenders ] + [-BlockedSenderDomains ] + [-BlockedSenders ] + [-BulkQuarantineTag ] + [-BulkSpamAction ] + [-BulkThreshold ] + [-Confirm] + [-DownloadLink ] + [-EnableEndUserSpamNotifications ] + [-EnableLanguageBlockList ] + [-EnableRegionBlockList ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationCustomFromName ] + [-EndUserSpamNotificationCustomSubject ] + [-EndUserSpamNotificationFrequency ] + [-EndUserSpamNotificationLanguage ] + [-EndUserSpamNotificationLimit ] + [-HighConfidencePhishAction ] + [-HighConfidencePhishQuarantineTag ] + [-HighConfidenceSpamAction ] + [-HighConfidenceSpamQuarantineTag ] + [-IncreaseScoreWithBizOrInfoUrls ] + [-IncreaseScoreWithImageLinks ] + [-IncreaseScoreWithNumericIps ] + [-IncreaseScoreWithRedirectToOtherPort ] + [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] + [-LanguageBlockList ] + [-MakeDefault] + [-MarkAsSpamBulkMail ] + [-MarkAsSpamEmbedTagsInHtml ] + [-MarkAsSpamEmptyMessages ] + [-MarkAsSpamFormTagsInHtml ] + [-MarkAsSpamFramesInHtml ] + [-MarkAsSpamFromAddressAuthFail ] + [-MarkAsSpamJavaScriptInHtml ] + [-MarkAsSpamNdrBackscatter ] + [-MarkAsSpamObjectTagsInHtml ] + [-MarkAsSpamSensitiveWordList ] + [-MarkAsSpamSpfRecordHardFail ] + [-MarkAsSpamWebBugsInHtml ] + [-ModifySubjectValue ] + [-PhishQuarantineTag ] + [-PhishSpamAction ] + [-PhishZapEnabled ] + [-QuarantineRetentionPeriod ] + [-RedirectToRecipients ] + [-RegionBlockList ] + [-SpamAction ] + [-SpamQuarantineTag ] + [-SpamZapEnabled ] + [-TestModeAction ] + [-TestModeBccToRecipients ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). + +## EXAMPLES + +### Example 1 +```powershell +Set-HostedContentFilterPolicy -Identity "Contoso Executives" -HighConfidenceSpamAction Quarantine -SpamAction Quarantine -BulkThreshold 6 +``` + +This example modifies the spam filter policy named Contoso Executives with the following settings: + +- Quarantine messages when the spam filtering verdict is spam or high confidence spam. +- BCL 6 triggers the action for a bulk email spam filtering verdict. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AddXHeaderValue +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 +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +The maximum length is 255 characters, and the value can't contain spaces or colons (:). + +For example, if you enter the value `This-is-my-custom-header`, the X-header that's added to the message is `This-is-my-custom-header: This message appears to be spam.` + +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedSenderDomains +The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. + +**Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedSenders +The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. + +**Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedSenderDomains +The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP domains. + +**Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedSenders +The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP email addresses. + +**Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BulkQuarantineTag +The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as bulk as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BulkSpamAction +The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: + +- AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- NoAction +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as bulk email are available to the intended recipients and admins. Or, you can use the BulkQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BulkThreshold +The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than or equal to the specified BCL value). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 7, 8, or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. + +A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://learn.microsoft.com/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLanguageBlockList +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRegionBlockList +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLanguage +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLimit +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishAction +The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: + +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. +- Quarantine: Move the message to quarantine. By default, messages that are quarantined as high confidence phishing are available only to admins. Or, you can use the HighConfidencePhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. + +```yaml +Type: PhishFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidenceSpamAction +The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: + +- AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as high confidence spam are available to the intended recipients and admins. Or, you can use the HighConfidenceSpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidenceSpamQuarantineTag +The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithBizOrInfoUrls +The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: + +- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. +- Test: The action specified by the TestModeAction parameter is taken on the message. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithImageLinks +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithNumericIps +The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: + +- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithRedirectToOtherPort +The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: + +- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InlineSafetyTipsEnabled +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. +- $false: Safety tips are disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntraOrgFilterState +The IntraOrgFilterState parameter specifies whether to enable anti-spam filtering for messages sent between internal users (users in the same organization). The action that's configured in the policy for the specified spam filter verdicts is taken on messages sent between internal users. Valid values are: + +- Default: This is the default value. Currently, HighConfidencePhish. +- HighConfidencePhish +- Phish: Includes phishing and high confidence phishing. +- HighConfidenceSpam: Includes high confidence spam, phishing, and high confidence phishing. +- Spam: Includes spam, high confidence spam, phishing, and high confidence phishing. +- Disabled + +```yaml +Type: IntraOrgFilterState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageBlockList +The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported 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. + +A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Not all possible language codes are available as input for this parameter. + +To enter multiple values and overwrite any existing entries, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +To empty the list, use the value $null. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +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). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamBulkMail +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamEmbedTagsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamEmptyMessages +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamFormTagsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamFramesInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamFromAddressAuthFail +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamJavaScriptInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamNdrBackscatter +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamObjectTagsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamSensitiveWordList +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamSpfRecordHardFail +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarkAsSpamWebBugsInHtml +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. +- 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. + +```yaml +Type: SpamFilteringOption +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifySubjectValue +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 +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishQuarantineTag +The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishSpamAction +The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: + +- AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. +- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. +- ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as phishing are available to admins and (as of April 2020) the intended recipients. Or, you can use the PhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishZapEnabled +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. +- $false: ZAP for phishing messages is disabled. + +You configure ZAP for spam with the SpamZapEnabled parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineRetentionPeriod +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 +- HighConfidencePhishAction +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +A valid value is an integer between 1 and 30. + +After the time period expires, the message is deleted. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectToRecipients +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 +- HighConfidenceSpamAction +- PhishSpamAction +- SpamAction + +You can specify multiple email addresses separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegionBlockList +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. + +A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +To empty the list, use the value $null. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamAction +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). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as spam are available to the intended recipients and admins. Or, you can use the SpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. +- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. + +```yaml +Type: SpamFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamQuarantineTag +The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamZapEnabled +The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: + +- $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. +- $false: ZAP for spam is disabled. + +You configure ZAP for phishing messages with the PhishZapEnabled parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestModeAction +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. +- 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. + +```yaml +Type: SpamFilteringTestModeAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestModeBccToRecipients +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. + +This parameter is meaningful only when the value of the TestModeAction parameter is BccMessage, and when the value of one or more IncreaseScoreWith\* or MarkAsSpam\* parameters is Test. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS + +[Safe sender and blocked sender lists in Exchange Online](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365) diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md new file mode 100644 index 0000000000..991cf73ca1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md @@ -0,0 +1,341 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HostedContentFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-HostedContentFilterRule cmdlet to modify spam filter rules (content filter rules) in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-HostedContentFilterRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-HostedContentFilterPolicy ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Use the Microsoft Defender portal to create anti-spam policies](https://learn.microsoft.com/defender-office-365/anti-spam-policies-configure#use-the-microsoft-defender-portal-to-create-anti-spam-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-HostedContentFilterRule "Contoso Recipients" -ExceptIfSentToMemberOf "Contoso Human Resources" +``` + +This example adds an exception to the spam filter rule named Contoso Recipients for members of the distribution group named Contoso Human Resources. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedContentFilterPolicy +The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. + +You can use any value that uniquely identifies the policy. For example, you can specify the name, GUID, or distinguished name (DN) of the spam filter policy. + +You can't specify the default spam filter policy. And, you can't specify a spam filter policy that's already associated with another spam filter rule. + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a 9th new rule are from 0 through 8. +- The default value for the new 9th rule is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md new file mode 100644 index 0000000000..5a570aaa15 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md @@ -0,0 +1,313 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HostedOutboundSpamFilterPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-HostedOutboundSpamFilterPolicy cmdlet to modify outbound spam filter policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-HostedOutboundSpamFilterPolicy [-Identity] + [-ActionWhenThresholdReached ] + [-AdminDisplayName ] + [-AutoForwardingMode ] + [-BccSuspiciousOutboundAdditionalRecipients ] + [-BccSuspiciousOutboundMail ] + [-Confirm] + [-NotifyOutboundSpam ] + [-NotifyOutboundSpamRecipients ] + [-RecipientLimitExternalPerHour ] + [-RecipientLimitInternalPerHour ] + [-RecipientLimitPerDay ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-HostedOutboundSpamFilterPolicy -Identity Default -RecipientLimitExternalPerHour 500 -RecipientLimitInternalPerHour 1000 -RecipientLimitPerDay 1000 -ActionWhenThresholdReached BlockUser +``` + +This example configures the following settings in the outbound spam filter policy named Default: + +- The recipient rate limits are restricted to smaller values that the service defaults. +- After one of the limits is reached, the user is prevented from sending messages (added to the Restricted Users portal). + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: HostedOutboundSpamFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActionWhenThresholdReached +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. + +```yaml +Type: OutboundRecipientLimitsExceededAction +Parameter Sets: (All) +Aliases: +Accepted values: Alert, BlockUserForToday, BlockUser +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoForwardingMode +The AutoForwardingMode specifies how the policy controls automatic email forwarding to external recipients. Valid values are: + +- Automatic: This is the default value. This 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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BccSuspiciousOutboundAdditionalRecipients +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BccSuspiciousOutboundMail +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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). + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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). + +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. + +The specified recipients receive notifications when the value of the NotifyOutboundSpam parameter is $true. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimitExternalPerHour +The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimitInternalPerHour +The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimitPerDay +The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md new file mode 100644 index 0000000000..fd8d912dd6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md @@ -0,0 +1,332 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-HostedOutboundSpamFilterRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-HostedOutboundSpamFilterRule cmdlet to modify the settings of outbound spam filter rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-HostedOutboundSpamFilterRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfFrom ] + [-ExceptIfFromMemberOf ] + [-ExceptIfSenderDomainIs ] + [-From ] + [-FromMemberOf ] + [-HostedOutboundSpamFilterPolicy ] + [-Name ] + [-Priority ] + [-SenderDomainIs ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-HostedOutboundSpamFilterRule -Identity "Contoso Executives" -ExceptIfFrom "Elizabeth Brunner" +``` + +This example adds an exception to the existing rule named Contoso Executives. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedOutboundSpamFilterPolicy +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: + +- Name +- Distinguished name (DN) +- GUID. + +You can't specify the default outbound spam filter policy, and you can't specify an outbound spam filter policy that's already associated with another outbound spam filter rule. + +```yaml +Type: HostedOutboundSpamFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md new file mode 100644 index 0000000000..5811e49d7f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md @@ -0,0 +1,375 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-HybridConfiguration + +## 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. + +For 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-HybridConfiguration + [-ClientAccessServers ] + [-Confirm] + [-DomainController ] + [-Domains ] + [-EdgeTransportServers ] + [-ExternalIPAddresses ] + [-Features ] + [-Name ] + [-OnPremisesSmartHost ] + [-ReceivingTransportServers ] + [-SecureMailCertificateThumbprint ] + [-SendingTransportServers ] + [-ServiceInstance ] + [-TlsCertificateName ] + [-TransportServers ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-HybridConfiguration cmdlet modifies the hybrid configuration features, such as enabling secure mail, designating a specific Mailbox server for hybrid functionality, or enabling or disabling free/busy information sharing and message tracking between the on-premises Exchange and Exchange Online organizations. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +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. + +### Example 2 +```powershell +Set-HybridConfiguration -Features OnlineArchive,MailTips,OWARedirection,FreeBusy,MessageTracking +``` + +This example disables the secure mail and centralized transport hybrid deployment features, but keeps the Exchange Online Archive, MailTips, Outlook on the web redirection, free/busy and message tracking features enabled between the on-premises Exchange and Exchange Online organizations. + +### Example 3 +```powershell +Set-HybridConfiguration -TlsCertificateName "CN=A. Datum Corporation CA-3, OU=www.adatum.com, O=A.Datum Corp, C=USCN=mail.contoso.com, O=Barbara Zighetti, L=Seattle, S=WA, C=US" +``` + +This example specifies that the hybrid deployment uses a defined TLS certificate, referenced by the combination of the Issuer and Subject attributes of the CA issued X.509 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: + +- 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, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 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. + +```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 +``` + +### -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 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. + +```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 +``` + +### -Name +This parameter has been deprecated and is no longer used. + +There can be only one HybridConfiguration object in an Exchange organization. + +```yaml +Type: String +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 +``` + +### -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. + +```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 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. + +```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 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. + +```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 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. + +```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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/Set-IPAllowListConfig.md b/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListConfig.md rename to exchange/exchange-ps/exchange/Set-IPAllowListConfig.md index 1b7d3ff1c9..0c7a6349a0 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IPAllowListConfig @@ -13,13 +16,18 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPAllowListConfig cmdlet to modify the IP Allow list configuration that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPAllowListConfig [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-ExternalMailEnabled <$true | $false>] [-InternalMailEnabled <$true | $false>] [-WhatIf] [] +Set-IPAllowListConfig [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExternalMailEnabled ] + [-InternalMailEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,8 +37,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IPAllowListConfig -InternalMailEnabled $true ``` @@ -41,8 +49,7 @@ This example configures connection filtering to use the IP Allow list on message ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -50,6 +57,7 @@ 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 @@ -67,6 +75,7 @@ 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 @@ -78,10 +87,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -93,10 +103,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -108,10 +119,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -127,6 +139,7 @@ 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 @@ -135,20 +148,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/bc258d2f-9a5d-4e45-a408-b31ce1260b83.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListProvider.md rename to exchange/exchange-ps/exchange/Set-IPAllowListProvider.md index bb90a2abe2..4ede592a05 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IPAllowListProvider @@ -13,15 +16,23 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPAllowListProvider cmdlet to modify IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPAllowListProvider [-Identity] [-AnyMatch <$true | $false>] - [-BitmaskMatch ] [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-IPAddressesMatch ] [-LookupDomain ] [-Name ] [-Priority ] - [-WhatIf] [] +Set-IPAllowListProvider [-Identity] + [-AnyMatch ] + [-BitmaskMatch ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IPAddressesMatch ] + [-LookupDomain ] + [-Name ] + [-Priority ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,15 +40,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IPAllowListProvider Contoso.com -AnyMatch $true ``` This example configures the IP Allow list provider named Contoso.com to allow connections from an IP address if any IP address status codes are returned. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-IPAllowListProvider Contoso.com -Priority 1 ``` @@ -49,9 +60,7 @@ This example sets the priority to 1 for the existing IP Allow list provider name 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 - - Distinguished name (DN) - - GUID ```yaml @@ -59,6 +68,7 @@ Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -70,10 +80,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -89,6 +100,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -99,8 +111,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -108,6 +119,7 @@ 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 @@ -125,6 +137,7 @@ 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 @@ -136,10 +149,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -150,15 +164,16 @@ Accept wildcard characters: False ### -IPAddressesMatch 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: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -174,6 +189,7 @@ 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 @@ -189,6 +205,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -206,6 +223,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -221,6 +239,7 @@ 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 @@ -229,20 +248,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/a89b0d3d-028e-44e6-82ed-a457a8129497.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md rename to exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md index 02b7314c43..214711a0f1 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IPAllowListProvidersConfig @@ -13,13 +16,18 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPAllowListProvidersConfig cmdlet to modify the settings that affect all IP Allow list providers that are configured on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPAllowListProvidersConfig [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-ExternalMailEnabled <$true | $false>] [-InternalMailEnabled <$true | $false>] [-WhatIf] [] +Set-IPAllowListProvidersConfig [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExternalMailEnabled ] + [-InternalMailEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,8 +37,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IPAllowListProvidersConfig -InternalMailEnabled $true ``` @@ -41,8 +49,7 @@ This example configures connection filtering to use IP Allow list providers on m ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -50,6 +57,7 @@ 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 @@ -67,6 +75,7 @@ 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 @@ -78,10 +87,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -93,10 +103,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -108,10 +119,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -127,6 +139,7 @@ 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 @@ -135,20 +148,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6253cf82-c4d4-4d30-8ea9-eab1a3ddb60a.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListConfig.md rename to exchange/exchange-ps/exchange/Set-IPBlockListConfig.md index cfd9b81e5e..af8ccda55d 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IPBlockListConfig @@ -13,14 +16,19 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPBlockListConfig cmdlet to modify the IP Block list configuration that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPBlockListConfig [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-ExternalMailEnabled <$true | $false>] [-InternalMailEnabled <$true | $false>] - [-MachineEntryRejectionResponse ] [-StaticEntryRejectionResponse ] [-WhatIf] +Set-IPBlockListConfig [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExternalMailEnabled ] + [-InternalMailEnabled ] + [-MachineEntryRejectionResponse ] + [-StaticEntryRejectionResponse ] + [-WhatIf] [] ``` @@ -31,8 +39,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IPBlockListConfig -InternalMailEnabled $true ``` @@ -43,8 +51,7 @@ This example configures connection filtering to use the IP Block list on message ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -52,6 +59,7 @@ 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 @@ -69,6 +77,7 @@ 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 @@ -80,10 +89,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,10 +105,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,10 +121,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -129,6 +141,7 @@ Type: AsciiString Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,6 +157,7 @@ Type: AsciiString Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -159,6 +173,7 @@ 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 @@ -167,20 +182,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/87e30029-0349-4d9a-a9a4-cb25686ccb7c.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md similarity index 84% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListProvider.md rename to exchange/exchange-ps/exchange/Set-IPBlockListProvider.md index 710791bdb8..f7394da090 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IPBlockListProvider @@ -13,15 +16,24 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPBlockListProvider cmdlet to modify IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPBlockListProvider [-Identity] [-AnyMatch <$true | $false>] - [-BitmaskMatch ] [-Confirm] [-DomainController ] [-Enabled <$true | $false>] - [-IPAddressesMatch ] [-LookupDomain ] [-Name ] [-Priority ] - [-RejectionResponse ] [-WhatIf] [] +Set-IPBlockListProvider [-Identity] + [-AnyMatch ] + [-BitmaskMatch ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-IPAddressesMatch ] + [-LookupDomain ] + [-Name ] + [-Priority ] + [-RejectionResponse ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,15 +41,15 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IPBlockListProvider Contoso.com -AnyMatch $true ``` This example configures connection filtering to block an IP address if any IP address status codes are returned by the IP Block list provider named Contoso.com. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-IPBlockListProvider Contoso.com -Priority 1 ``` @@ -49,9 +61,7 @@ This example sets the priority value to 1 for the IP Block list provider named C 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 - - Distinguished name (DN) - - GUID ```yaml @@ -59,6 +69,7 @@ Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -70,10 +81,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -89,6 +101,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -99,8 +112,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -108,6 +120,7 @@ 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 @@ -125,6 +138,7 @@ 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 @@ -136,10 +150,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -150,15 +165,16 @@ Accept wildcard characters: False ### -IPAddressesMatch 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: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -174,6 +190,7 @@ 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 @@ -189,6 +206,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -206,6 +224,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -223,6 +242,7 @@ Type: AsciiString Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -238,6 +258,7 @@ 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 @@ -246,20 +267,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e52a1bfa-1450-4d20-8ff6-ca26c7aaab6c.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md similarity index 80% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md rename to exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md index 40edbd8347..50419ac6d6 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IPBlockListProvidersConfig @@ -13,14 +16,19 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPBlockListProvidersConfig cmdlet to modify the settings that affect all IP Block list providers that are configured on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IPBlockListProvidersConfig [-BypassedRecipients ] [-Confirm] - [-DomainController ] [-Enabled <$true | $false>] [-ExternalMailEnabled <$true | $false>] - [-InternalMailEnabled <$true | $false>] [-WhatIf] [] +Set-IPBlockListProvidersConfig [-BypassedRecipients ] + [-Confirm] + [-DomainController ] + [-Enabled ] + [-ExternalMailEnabled ] + [-InternalMailEnabled ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -30,22 +38,21 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IPBlockListProvidersConfig -InternalMailEnabled $true -BypassedRecipients kweku@contoso.com ``` This example configures connection filtering to use IP Block list providers on messages that come from internal connections, but bypasses filtering for email messages sent to kweku@contoso.com. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-IPBlockListProvidersConfig -BypassedRecipients @{Add="chris@contoso.com","michelle@contoso.com"; Remove="laura@contoso.com","julia@contoso.com"} ``` This example makes the following changes to the list of bypassed recipients: - Adds the values chris@contoso.com and michelle@contoso.com - - Removes the values laura@contoso.com and julia@contoso.com ## PARAMETERS @@ -53,15 +60,16 @@ This example makes the following changes to the list of bypassed recipients: ### -BypassedRecipients 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: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -72,8 +80,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -81,6 +88,7 @@ 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 @@ -98,6 +106,7 @@ 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 @@ -109,10 +118,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,10 +134,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -139,10 +150,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -158,6 +170,7 @@ 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 @@ -166,20 +179,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6076c434-e162-4398-81d6-6b9e92e2bf99.aspx) diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md new file mode 100644 index 0000000000..76f288110e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md @@ -0,0 +1,579 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-IRMConfiguration cmdlet to configure Information Rights Management (IRM) features on your organization. + +Configuring and using IRM features in an on-premises Exchange organization requires Active Directory Rights Management Services (AD RMS). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-IRMConfiguration [-Identity ] + [-AutomaticServiceUpdateEnabled ] + [-AzureRMSLicensingEnabled ] + [-ClientAccessServerEnabled ] + [-Confirm] + [-DecryptAttachmentForEncryptOnly ] + [-DomainController ] + [-EDiscoverySuperUserEnabled ] + [-EnablePdfEncryption ] + [-EnablePortalTrackingLogs ] + [-ExternalLicensingEnabled ] + [-Force] + [-InternalLicensingEnabled ] + [-JournalReportDecryptionEnabled ] + [-LicensingLocation ] + [-RefreshServerCertificates] + [-RejectIfRecipientHasNoRights ] + [-RMSOnlineKeySharingLocation ] + [-SearchEnabled ] + [-SimplifiedClientAccessDoNotForwardDisabled ] + [-SimplifiedClientAccessEnabled ] + [-SimplifiedClientAccessEncryptOnlyDisabled ] + [-TransportDecryptionSetting ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-IRMConfiguration -JournalReportDecryptionEnabled $true +``` + +This example enables journal report decryption. + +### Example 2 +```powershell +Set-IRMConfiguration -TransportDecryptionSetting Mandatory +``` + +This example enables transport decryption and enforces decryption. When decryption is enforced, messages that can't be decrypted are rejected, and an NDR is returned. + +### Example 3 +```powershell +Set-IRMConfiguration -ExternalLicensingEnabled $true +``` + +This example enables licensing for external messages. + +## PARAMETERS + +### -Identity +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". + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AutomaticServiceUpdateEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureRMSLicensingEnabled +This parameter is available only in the cloud-based service. + +The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online organization can to connect directly to Azure Rights Management. Valid values are: + +- $true: The Exchange Online organization can connect directly to Azure Rights Management. This enables Microsoft Purview Message Encryption. +- $false: The Exchange Online organization can't connect directly to Azure Rights Management. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAccessServerEnabled +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). +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DecryptAttachmentForEncryptOnly +This parameter is available only in the cloud-based service. + +The DecryptAttachmentForEncryptOnly parameter specifies whether mail recipients have unrestricted rights on the attachment or not for Encrypt-only mails sent using 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. + +This parameter replaces the deprecated DecryptAttachmentFromPortal parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EDiscoverySuperUserEnabled +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. +- $false: Members of the Discovery Management role group can't access IRM-protected messages in discovery mailboxes. + +For more information about In-Place eDiscovery and IRM-protected messages, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePdfEncryption +This parameter is available only in the cloud-based service. + +The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Microsoft Purview Message Encryption. Valid values are: + +- $true: Messages that contain PDF attachments can be encrypted. +- $false: Messages that contain PDF attachments can't be encrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePortalTrackingLogs +This parameter is available only in the cloud-based service. + +**Note**: This parameter is available only in organizations with Microsoft Purview Advanced Message Encryption. For more information, see [Advanced Message Encryption](https://learn.microsoft.com/purview/ome-advanced-message-encryption). + +The EnablePortalTrackingLogs parameter specifies whether to turn on auditing for the Office 365 Message Encryption (OME) portal. Valid values are: + +- $true: Turn on auditing for activities in the OME portal. Activities are visible in the audit logs. +- $false: Turn off auditing for activities in the OME portal. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalLicensingEnabled +This parameter is available only in on-premises Exchange. + +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. + +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. + +```yaml +Type: Boolean +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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you modify the InternalLicensingEnabled parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalLicensingEnabled +**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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JournalReportDecryptionEnabled +The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: + +- $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see [Journal report decryption](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicensingLocation +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 won'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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshServerCertificates +This parameter is available only in on-premises Exchange. + +The RefreshServerCertificates switch clears all Rights Account Certificates (RACs), Computer Licensor Certificates (CLCs), and cached AD RMS templates from all Exchange servers in the organization. You don't need to specify a value with this switch. + +Clearing RACs, CLCs, and cached templates might be required during troubleshooting or after changing keys on the AD RMS cluster in your organization. For more information about RACs and CLCs, see [Understanding AD RMS Certificates](https://learn.microsoft.com/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc753886(v=ws.11)). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectIfRecipientHasNoRights +This parameter is available only in the cloud-based service. + +{{ Fill RejectIfRecipientHasNoRights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RMSOnlineKeySharingLocation +This parameter is available only in the cloud-based service. + +The RMSOnlineKeySharingLocation parameter specifies the Azure Rights Management URL that's used to get the trusted publishing domain (TPD) for the Exchange Online organization. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimplifiedClientAccessDoNotForwardDisabled +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: + +- $true: **Do not forward** is not available in Outlook on the web. +- $false: **Do not forward** is available in Outlook on the web. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimplifiedClientAccessEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimplifiedClientAccessEncryptOnlyDisabled +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: + +- $true: **Encrypt only** is not available in Outlook on the web. +- $false: **Encrypt only** is available in Outlook on the web. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportDecryptionSetting +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access/Set-ImapSettings.md b/exchange/exchange-ps/exchange/Set-ImapSettings.md similarity index 81% rename from exchange/exchange-ps/exchange/client-access/Set-ImapSettings.md rename to exchange/exchange-ps/exchange/Set-ImapSettings.md index 811b5e9cc9..d6a70cad13 100644 --- a/exchange/exchange-ps/exchange/client-access/Set-ImapSettings.md +++ b/exchange/exchange-ps/exchange/Set-ImapSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ImapSettings @@ -13,66 +16,82 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ImapSettings cmdlet to modify the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This service exists on Exchange servers that have the Client Access server role installed, and is used by IMAP4 clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ImapSettings [-AuthenticatedConnectionTimeout ] [-Banner ] - [-CalendarItemRetrievalOption ] [-Confirm] - [-DomainController ] [-EnableExactRFC822Size <$true | $false>] - [-EnableGSSAPIAndNTLMAuth <$true | $false>] [-EnforceCertificateErrors <$true | $false>] - [-ExtendedProtectionPolicy ] [-ExternalConnectionSettings ] - [-InternalConnectionSettings ] [-LogFileLocation ] - [-LogFileRollOverSettings ] - [-LoginType ] [-LogPerFileSizeQuota ] - [-MaxCommandSize ] [-MaxConnectionFromSingleIP ] [-MaxConnections ] +Set-ImapSettings [-AuthenticatedConnectionTimeout ] + [-Banner ] + [-CalendarItemRetrievalOption ] + [-Confirm] + [-DomainController ] + [-EnableExactRFC822Size ] + [-EnableGSSAPIAndNTLMAuth ] + [-EnforceCertificateErrors ] + [-ExtendedProtectionPolicy ] + [-ExternalConnectionSettings ] + [-InternalConnectionSettings ] + [-LogFileLocation ] + [-LogFileRollOverSettings ] + [-LoginType ] + [-LogPerFileSizeQuota ] + [-MaxCommandSize ] + [-MaxConnectionFromSingleIP ] + [-MaxConnections ] [-MaxConnectionsPerUser ] - [-MessageRetrievalMimeFormat ] - [-OwaServerUrl ] [-PreAuthenticatedConnectionTimeout ] - [-ProtocolLogEnabled <$true | $false>] [-ProxyTargetPort ] [-Server ] - [-ShowHiddenFoldersEnabled <$true | $false>] [-SSLBindings ] - [-SuppressReadReceipt <$true | $false>] [-UnencryptedOrTLSBindings ] [-WhatIf] - [-X509CertificateName ] [] + [-MessageRetrievalMimeFormat ] + [-OwaServerUrl ] + [-PreAuthenticatedConnectionTimeout ] + [-ProtocolLogEnabled ] + [-ProxyTargetPort ] + [-Server ] + [-ShowHiddenFoldersEnabled ] + [-SSLBindings ] + [-SuppressReadReceipt ] + [-UnencryptedOrTLSBindings ] + [-WhatIf] + [-X509CertificateName ] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ImapSettings -Server "MBX01" -UnencryptedOrTLSBindings 10.0.0.0:143 ``` This example configures the unencrypted or STARTTLS encrypted IMAP4 connection to the server named MBX01 by using the local IP address 10.0.0.0 on TCP port 143. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-ImapSettings -ProtocolLogEnabled $true -LogFileLocation "C:\Imap4Logging" ``` This example turns on IMAP4 protocol logging. It also changes the IMAP4 protocol logging directory to C:\\Imap4Logging. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-ImapSettings -LogPerFileSizeQuota 2MB ``` This example changes the IMAP4 protocol logging to create a new log file when a log file reaches 2 megabytes (MB). -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Set-ImapSettings -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly ``` This example changes the IMAP4 protocol logging to create a new log file every hour. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Set-ImapSettings -X509CertificateName mail.contoso.com ``` @@ -94,6 +113,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -109,6 +129,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -120,20 +141,18 @@ Accept wildcard characters: False The CalendarItemRetrievalOption parameter specifies how calendar items are presented to IMAP4 clients. Valid values are: - 0 or iCalendar. This is the default value. - - 1 or IntranetUrl - - 2 or InternetUrl - - 3 or Custom If you specify 3 or Custom, you need to specify a value for the OwaServerUrl parameter setting. ```yaml -Type: iCalendar | intranetUrl | InternetUrl | Custom +Type: CalendarItemRetrievalOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,8 +163,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -153,6 +171,7 @@ 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 @@ -168,6 +187,7 @@ 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 @@ -179,14 +199,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -198,14 +218,14 @@ Accept wildcard characters: False 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. - - $false: NTLM for IMAP4 connections is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -219,14 +239,14 @@ The EnforceCertificateErrors parameter specifies whether to enforce valid Secure 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -238,18 +258,17 @@ Accept wildcard characters: False 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. - - 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. Extended Protection for Authentication enhances the protection and handling of credentials by Integrated Windows authentication (also known as NTLM), so we strongly recommend that you use it if it's supported by your clients (default installations of Windows 7 or later and Windows Server 2008 R2 or later support it). ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -260,13 +279,13 @@ Accept wildcard characters: False ### -ExternalConnectionSettings 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 \:\:[\]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). The default value is blank ($null), which means no external IMAP4 connection settings are configured. -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 enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -275,6 +294,7 @@ 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 @@ -285,13 +305,13 @@ Accept wildcard characters: False ### -InternalConnectionSettings 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 \:\:[\]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). -The default value is \:993:SSL,\:143:TLS. +The default value is `:993:SSL,:143:TLS`. -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 enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -300,6 +320,7 @@ 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 @@ -317,6 +338,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -327,21 +349,19 @@ Accept wildcard characters: False ### -LogFileRollOverSettings The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file. Valid values are: -- 1 or Hourly. - -- 2 or Daily. This is the default value - +- 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. +- 2 or Daily. This is the default value in Exchange 2013 and Exchange 2010. - 3 or Weekly. - - 4 or Monthly. This parameter is only meaningful when the LogPerFileSizeQuota parameter value is 0, and the ProtocolLogEnabled parameter value is $true. ```yaml -Type: Hourly | Daily | Weekly | Monthly +Type: LogFileRollOver Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -353,16 +373,15 @@ Accept wildcard characters: False 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. ```yaml -Type: PlainTextLogin | PlainTextAuthentication | SecureLogin +Type: LoginOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -376,13 +395,9 @@ The LogPerFileSizeQuota parameter specifies the maximum size of a IMAP4 protocol When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -396,6 +411,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -404,13 +420,14 @@ Accept wildcard characters: False ``` ### -MaxCommandSize -The MaxCommandSize parameter specifies the maximum size in bytes of a single IMAP4 command. Valid values are from 40 through 1024. The default value is 512. +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 Default value: None @@ -426,6 +443,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -441,6 +459,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -456,6 +475,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -467,24 +487,19 @@ Accept wildcard characters: False The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are: - 0 or TextOnly. - - 1 or HtmlOnly. - - 2 or HtmlAndTextAlternative. - - 3 or TextEnrichedOnly. - - 4 or TextEnrichedAndTextAlternative. - - 5 or BestBodyFormat. This is the default value. - - 6 or Tnef. ```yaml -Type: TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef +Type: MimeTextFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -500,6 +515,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -519,6 +535,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -530,14 +547,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -553,6 +570,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -564,11 +582,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -578,6 +593,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -589,14 +605,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -605,19 +621,20 @@ Accept wildcard characters: False ``` ### -SSLBindings -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 \:\. +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. +The default value is `[::]:993,0.0.0.0:993`. -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 enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -629,14 +646,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -645,19 +662,20 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings -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 \:\. +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. +The default value is `[::]:143,0.0.0.0:143`. -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 enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -673,6 +691,7 @@ 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 @@ -694,6 +713,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -702,20 +722,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/58e51734-83bd-4e71-bd13-9960efaa80c3.aspx) diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md new file mode 100644 index 0000000000..285ba184d1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-InboundConnector.md @@ -0,0 +1,544 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-InboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-InboundConnector cmdlet to change an existing Inbound connector in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-InboundConnector [-Identity] + [-AssociatedAcceptedDomains ] + [-CloudServicesMailEnabled ] + [-Comment ] + [-Confirm] + [-ConnectorSource ] + [-ConnectorType ] + [-EFSkipIPs ] + [-EFSkipLastIP ] + [-EFSkipMailGateway ] + [-EFTestMode ] + [-EFUsers ] + [-Enabled ] + [-Name ] + [-RequireTls ] + [-RestrictDomainsToCertificate ] + [-RestrictDomainsToIPAddresses ] + [-ScanAndDropRecipients ] + [-SenderDomains ] + [-SenderIPAddresses ] + [-TlsSenderCertificateName ] + [-TreatMessagesAsInternal ] + [-TrustedOrganizations ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-InboundConnector "Contoso Inbound Connector" -RequireTls $true -TlsSenderCertificateName contoso.com +``` + +This example makes the following configuration changes to the existing Inbound connector named Contoso.com Inbound Connector. + +Require TLS transmission for all incoming messages on the connector. + +Require that the TLS certificate that is used to encrypt communications contain the domain name contoso.com + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AssociatedAcceptedDomains +The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServicesMailEnabled +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSource +The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: + +- Default: The connector is manually created. This is the default value. +- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. +- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. + +We recommended that you don't change this value. + +```yaml +Type: TenantConnectorSource +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorType +The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values: + +- Partner: The connector services domains that are external to your organization. +- OnPremises: The connector services domains that are used by your on-premises organization. OnPremises connectors grant special rights to an email that matches the connector and additional requirements. For example: allowing relay through the tenant to internet destinations, promoting emails from on-premises or other environments as internal (in a hybrid configuration), or enabling other more complex mail flows. + +```yaml +Type: TenantConnectorType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFSkipIPs +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. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.3.1/24. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFSkipLastIP +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFSkipMailGateway +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFTestMode +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EFUsers +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the connector. Valid values are: + +- $true: The connector is enabled. This is the default value. +- $false: The connector is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a descriptive name for the connector. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireTls +The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by a Partner type connector. Valid values are: + +- $true: Reject messages if they aren't sent over TLS. This is the default value +- $false: Allow messages if they aren't sent over TLS. + +**Note**: This parameter applies only to Partner type connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictDomainsToCertificate +The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the Partner type connector. Valid values are: + +- $true: Mail is allowed to use the connector only if the Subject value of the TLS certificate that the source email server uses to authenticate matches the TlsSenderCertificateName parameter value. +- $false: The Subject value of the TLS certificate that the source email server uses to authenticate doesn't control whether mail from that source uses the connector. This is the default value. + +**Note**: This parameter applies only to Partner type connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictDomainsToIPAddresses +The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses for Partner type connectors. Valid values are: + +- $true: Automatically reject mail from domains that are specified by the SenderDomains parameter if the source IP address isn't also specified by the SenderIPAddress parameter. +- $false: Don't automatically reject mail from domains that are specified by the SenderDomains parameter based on the source IP address. This is the default value. + +**Note**: This parameter applies only to Partner type connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanAndDropRecipients +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomains +The SenderDomains parameter specifies the source domains that a Partner type connector accepts messages for (limits the scope of a Partner type connector). A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, `*.contoso.com`). However, you can't embed the wildcard character (for example, `domain.*.contoso.com` isn't valid). + +You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIPAddresses +The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the Partner type connector accepts messages from when the value of the RestrictDomainsToIPAddresses parameter is $true. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. Valid subnet mask values are /24 through /32. +@@ -435,6 +441,8 @@ You can specify multiple IP addresses separated by commas. + +IPv6 addresses are not supported. + +**Note**: This parameter applies to Partner type connectors only if the value of the RestrictDomainsToIPAddresses parameter is $true. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsSenderCertificateName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatMessagesAsInternal +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. + +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). + +**Note**: You can't set this parameter to the value $true if either of the following conditions is true: + +- The CloudServicesMailEnabled parameter is set to the value $true. +- The ConnectorType parameter value is not OnPremises. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedOrganizations +The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/mailboxes/Set-InboxRule.md b/exchange/exchange-ps/exchange/Set-InboxRule.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Set-InboxRule.md rename to exchange/exchange-ps/exchange/Set-InboxRule.md index af7daacd0a..fbbb29f2cb 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-InboxRule.md +++ b/exchange/exchange-ps/exchange/Set-InboxRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-InboxRule @@ -13,46 +16,82 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-InboxRule cmdlet to modify existing Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-InboxRule [-Identity] [-AlwaysDeleteOutlookRulesBlob] - [-ApplyCategory ] [-BodyContainsWords ] [-Confirm] - [-CopyToFolder ] [-DeleteMessage <$true | $false>] [-DomainController ] - [-ExceptIfBodyContainsWords ] [-ExceptIfFlaggedForAction ] - [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] - [-ExceptIfFromSubscription ] [-ExceptIfHasAttachment <$true | $false>] +Set-InboxRule [-Identity] + [-AlwaysDeleteOutlookRulesBlob] + [-ApplyCategory ] + [-ApplySystemCategory ] + [-BodyContainsWords ] + [-Confirm] + [-CopyToFolder ] + [-DeleteMessage ] + [-DeleteSystemCategory ] + [-DomainController ] + [-ExceptIfBodyContainsWords ] + [-ExceptIfFlaggedForAction ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfHasAttachment ] [-ExceptIfHasClassification ] [-ExceptIfHeaderContainsWords ] - [-ExceptIfMessageTypeMatches ] - [-ExceptIfMyNameInCcBox <$true | $false>] [-ExceptIfMyNameInToBox <$true | $false>] - [-ExceptIfMyNameInToOrCcBox <$true | $false>] [-ExceptIfMyNameNotInToBox <$true | $false>] - [-ExceptIfReceivedAfterDate ] [-ExceptIfReceivedBeforeDate ] - [-ExceptIfRecipientAddressContainsWords ] [-ExceptIfSentOnlyToMe <$true | $false>] - [-ExceptIfSentTo ] [-ExceptIfSubjectContainsWords ] - [-ExceptIfSubjectOrBodyContainsWords ] [-ExceptIfWithImportance ] - [-ExceptIfWithinSizeRangeMaximum ] [-ExceptIfWithinSizeRangeMinimum ] - [-ExceptIfWithSensitivity ] [-FlaggedForAction ] - [-Force] [-ForwardAsAttachmentTo ] [-ForwardTo ] - [-From ] [-FromAddressContainsWords ] - [-FromSubscription ] [-HasAttachment <$true | $false>] - [-HasClassification ] [-HeaderContainsWords ] - [-Mailbox ] [-MarkAsRead <$true | $false>] [-MarkImportance ] - [-MessageTypeMatches ] - [-MoveToFolder ] [-MyNameInCcBox <$true | $false>] [-MyNameInToBox <$true | $false>] - [-MyNameInToOrCcBox <$true | $false>] [-MyNameNotInToBox <$true | $false>] [-Name ] - [-Priority ] [-ReceivedAfterDate ] [-ReceivedBeforeDate ] - [-RecipientAddressContainsWords ] [-RedirectTo ] - [-SendTextMessageNotificationTo ] [-SentOnlyToMe <$true | $false>] - [-SentTo ] [-StopProcessingRules <$true | $false>] - [-SubjectContainsWords ] [-SubjectOrBodyContainsWords ] [-WhatIf] - [-WithImportance ] [-WithinSizeRangeMaximum ] + [-ExceptIfMessageTypeMatches ] + [-ExceptIfMyNameInCcBox ] + [-ExceptIfMyNameInToBox ] + [-ExceptIfMyNameInToOrCcBox ] + [-ExceptIfMyNameNotInToBox ] + [-ExceptIfReceivedAfterDate ] + [-ExceptIfReceivedBeforeDate ] + [-ExceptIfRecipientAddressContainsWords ] + [-ExceptIfSentOnlyToMe ] + [-ExceptIfSentTo ] + [-ExceptIfSubjectContainsWords ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfWithImportance ] + [-ExceptIfWithinSizeRangeMaximum ] + [-ExceptIfWithinSizeRangeMinimum ] + [-ExceptIfWithSensitivity ] + [-FlaggedForAction ] + [-Force] + [-ForwardAsAttachmentTo ] + [-ForwardTo ] + [-From ] + [-FromAddressContainsWords ] + [-HasAttachment ] + [-HasClassification ] + [-HeaderContainsWords ] + [-Mailbox ] + [-MarkAsRead ] + [-MarkImportance ] + [-MessageTypeMatches ] + [-MoveToFolder ] + [-MyNameInCcBox ] + [-MyNameInToBox ] + [-MyNameInToOrCcBox ] + [-MyNameNotInToBox ] + [-Name ] + [-PinMessage ] + [-Priority ] + [-ReceivedAfterDate ] + [-ReceivedBeforeDate ] + [-RecipientAddressContainsWords ] + [-RedirectTo ] + [-SendTextMessageNotificationTo ] + [-SentOnlyToMe ] + [-SentTo ] + [-SoftDeleteMessage ] + [-StopProcessingRules ] + [-SubjectContainsWords ] + [-SubjectOrBodyContainsWords ] + [-WhatIf] + [-WithImportance ] + [-WithinSizeRangeMaximum ] [-WithinSizeRangeMinimum ] - [-WithSensitivity ] - [-ApplySystemCategory ] [-DeleteSystemCategory ] - [-PinMessage <$true | $false>] [] + [-WithSensitivity ] + [] ``` ## DESCRIPTION @@ -60,13 +99,13 @@ The Set-InboxRule cmdlet allows you to modify the rule conditions, exceptions, a When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-InboxRule ProjectContoso -MarkImportance "High" +### Example 1 +```powershell +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. @@ -77,18 +116,16 @@ This example modifies the action of the existing Inbox rule ProjectContoso. The 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 - - RuleIdentity property (for example, 16752869479666417665). - -- Exchange Online: \\\\ (for example, rzaher\\16752869479666417665. - -- On-premises Exchange: \\\\ (for example, contoso.com/Users/Rick Zaher\\16752869479666417665. +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). ```yaml Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -97,13 +134,14 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter 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 @@ -121,6 +159,52 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplySystemCategory +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 +- Bills +- Document +- DocumentPlus +- Event +- Family +- File +- Flight +- FromContact +- Important +- LiveView +- Lodging +- MailingList +- Newsletter +- Photo +- Purchase +- RentalCar +- RestaurantReservation +- RetiredPromotion +- ShippingNotification +- Shopping +- SocialUpdate +- Travel +- Video + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -131,9 +215,11 @@ Accept wildcard characters: False ### -BodyContainsWords The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. @@ -142,6 +228,7 @@ 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 Default value: None @@ -152,8 +239,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -161,6 +247,7 @@ 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 Default value: None @@ -169,13 +256,72 @@ Accept wildcard characters: False ``` ### -CopyToFolder -The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal). +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Marketing` or `John:\Inbox\Reports`. ```yaml 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSystemCategory +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 +- Bills +- Document +- DocumentPlus +- Event +- Family +- File +- Flight +- FromContact +- Important +- LiveView +- Lodging +- MailingList +- Newsletter +- Photo +- Purchase +- RentalCar +- RestaurantReservation +- RetiredPromotion +- ShippingNotification +- Shopping +- SocialUpdate +- Travel +- Video + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -187,14 +333,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used. ```yaml -Type: $true | $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 Default value: None @@ -212,6 +358,7 @@ 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 @@ -222,9 +369,11 @@ Accept wildcard characters: False ### -ExceptIfBodyContainsWords The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is BodyContainsWords. @@ -233,6 +382,7 @@ 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 Default value: None @@ -244,25 +394,15 @@ Accept wildcard characters: False The ExceptIfFlaggedForAction parameter specifies an exception for the Inbox rule that looks messages with the specified message flag. Valid values are: - Any - - Call - - DoNotForward - - FollowUp - - ForYourInformation - - Forward - - NoResponseNecessary - - Read - - Reply - - ReplyToAll - - Review The corresponding condition parameter to this exception is FlaggedForAction. @@ -272,6 +412,7 @@ 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 Default value: None @@ -282,23 +423,14 @@ Accept wildcard characters: False ### -ExceptIfFrom The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: -For example: - - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple senders 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"`. The corresponding condition parameter to this exception is From. @@ -307,6 +439,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 Default value: None @@ -317,9 +450,11 @@ Accept wildcard characters: False ### -ExceptIfFromAddressContainsWords The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is FromAddressContainsWords. @@ -328,25 +463,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromSubscription -This parameter is available only in the cloud-based service. - -The ExceptIfFromSubscription parameter specifies an exception for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. -The corresponding condition parameter to this exception is FromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -358,16 +475,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is HasAttachment. ```yaml -Type: $true | $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 Default value: None @@ -385,6 +502,7 @@ 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 Default value: None @@ -395,9 +513,11 @@ Accept wildcard characters: False ### -ExceptIfHeaderContainsWords The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is HeaderContainsWords. @@ -406,6 +526,7 @@ 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 Default value: None @@ -417,34 +538,25 @@ Accept wildcard characters: False The ExceptIfMessageTypeMatches parameter specifies an exception for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply - - AutomaticForward - - Encrypted - - Calendaring - - CalendaringResponse - - PermissionControlled - - Voicemail - - Signed - - ApprovalRequest - - ReadReceipt - - NonDeliveryReport The corresponding condition parameter to this exception is MessageTypeMatches. ```yaml -Type: AutomaticReply | AutomaticForward | Encrypted | Calendaring | CalendaringResponse | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt | NonDeliveryReport +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 Default value: None @@ -456,16 +568,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameInCcBox. ```yaml -Type: $true | $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 Default value: None @@ -477,16 +589,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameInToBox. ```yaml -Type: $true | $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 Default value: None @@ -498,16 +610,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameInToOrCcBox. ```yaml -Type: $true | $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 Default value: None @@ -519,16 +631,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is MyNameNotInToBox. ```yaml -Type: $true | $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 Default value: None @@ -539,7 +651,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedAfterDate The ExceptIfReceivedAfterDate parameter specifies an exception for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedAfterDate. @@ -548,6 +660,7 @@ 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 Default value: None @@ -558,7 +671,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedBeforeDate The ExceptIfReceivedBeforeDate parameter specifies an exception for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedBeforeDate. @@ -567,6 +680,7 @@ 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 Default value: None @@ -577,9 +691,11 @@ Accept wildcard characters: False ### -ExceptIfRecipientAddressContainsWords The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -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 enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is RecipientAddressContainsWords. @@ -588,6 +704,7 @@ 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 Default value: None @@ -599,16 +716,16 @@ Accept wildcard characters: False 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. - - $false: The exception isn't used. The corresponding condition parameter to this exception is SentOnlyToMe. ```yaml -Type: $true | $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 Default value: None @@ -620,16 +737,13 @@ Accept wildcard characters: False The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name - +- Alias - Distinguished name (DN) - -- Display name - +- Canonical DN - Email address - - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding condition parameter to this exception is SentTo. @@ -638,6 +752,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 Default value: None @@ -648,9 +763,11 @@ Accept wildcard characters: False ### -ExceptIfSubjectContainsWords The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is SubjectContainsWords. @@ -659,6 +776,7 @@ 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 Default value: None @@ -669,17 +787,20 @@ Accept wildcard characters: False ### -ExceptIfSubjectOrBodyContainsWords The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. +The maximum length of this parameter is 255 characters. + +The corresponding condition parameter to this exception is SubjectOrBodyContainsWords. ```yaml Type: MultiValuedProperty 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 @@ -691,18 +812,17 @@ Accept wildcard characters: False The ExceptIfWithImportance parameter specifies an exception for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High - - Normal - - Low The corresponding condition parameter to this exception is WithImportance. ```yaml -Type: Low | Normal | High +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 Default value: None @@ -716,18 +836,14 @@ The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. -You need to use this parameter with the ExceptIfWithinSizeRangeMainimum parameter, and the value of this parameter must be greater than the value of ExceptIfWithinSizeRangeMinimum. +You need to use this parameter with the ExceptIfWithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of ExceptIfWithinSizeRangeMinimum. The corresponding condition parameter to this exception is WithinSizeRangeMaximum. @@ -736,6 +852,7 @@ 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 Default value: None @@ -749,13 +866,9 @@ The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -769,6 +882,7 @@ 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 Default value: None @@ -780,20 +894,18 @@ Accept wildcard characters: False The ExceptIfWithSensitivity parameter specifies an exception for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal - - Personal - - Private - - CompanyConfidential The corresponding condition parameter to this exception is WithSensitivity. ```yaml -Type: Normal | Personal | Private | CompanyConfidential +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 Default value: None @@ -805,25 +917,15 @@ Accept wildcard characters: False The FlaggedForAction parameter specifies a condition for the Inbox rule that looks for messages with the specified message flag. Valid values are: - Any - - Call - - DoNotForward - - FollowUp - - ForYourInformation - - Forward - - NoResponseNecessary - - Read - - Reply - - ReplyToAll - - Review ```yaml @@ -831,6 +933,7 @@ 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 Default value: None @@ -839,7 +942,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -848,6 +951,7 @@ 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 @@ -856,31 +960,23 @@ Accept wildcard characters: False ``` ### -ForwardAsAttachmentTo -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple recipients separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] 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 @@ -889,31 +985,23 @@ Accept wildcard characters: False ``` ### -ForwardTo -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple recipients separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] 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 @@ -922,25 +1010,16 @@ Accept wildcard characters: False ``` ### -From -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple senders 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"`. The corresponding exception parameter to this condition is ExceptIfFrom. @@ -949,6 +1028,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 Default value: None @@ -959,9 +1039,11 @@ Accept wildcard characters: False ### -FromAddressContainsWords The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. @@ -970,6 +1052,7 @@ 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 Default value: None @@ -977,39 +1060,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FromSubscription -This parameter is available only in the cloud-based service. +### -HasAttachment +The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: -The FromSubscription parameter specifies a condition for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. +- $true: The rule action is applied to messages that have attachments. +- $false: The condition isn't used. -The corresponding exception parameter to this condition is ExceptIfFromSubscription. +The corresponding exception parameter to this condition is ExceptIfHasAttachment. ```yaml -Type: AggregationSubscriptionIdentity[] +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasAttachment -The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: - -- $true: The rule action is applied to messages that have attachments. - -- $false: The condition isn't used. - -The corresponding exception parameter to this condition is ExceptIfHasAttachment. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1027,6 +1091,7 @@ 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 Default value: None @@ -1037,9 +1102,11 @@ Accept wildcard characters: False ### -HeaderContainsWords The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. @@ -1048,6 +1115,7 @@ 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 Default value: None @@ -1056,30 +1124,17 @@ Accept wildcard characters: False ``` ### -Mailbox -The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. - -For example: +The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -1087,6 +1142,7 @@ 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 Default value: None @@ -1098,14 +1154,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used. ```yaml -Type: $true | $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 Default value: None @@ -1117,16 +1173,15 @@ Accept wildcard characters: False The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - Low - - Normal - - High ```yaml -Type: Low | Normal | High +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 Default value: None @@ -1138,34 +1193,25 @@ Accept wildcard characters: False The MessageTypeMatches parameter specifies a condition for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply - - AutomaticForward - - Encrypted - - Calendaring - - CalendaringResponse - - PermissionControlled - - Voicemail - - Signed - - ApprovalRequest - - ReadReceipt - - NonDeliveryReport The corresponding exception parameter to this condition is ExceptIfMessageTypeMatches. ```yaml -Type: AutomaticReply | AutomaticForward | Encrypted | Calendaring | CalendaringResponse | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt | NonDeliveryReport +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 Default value: None @@ -1174,13 +1220,29 @@ Accept wildcard characters: False ``` ### -MoveToFolder -The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal). +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Marketing` or `John:\Inbox\Reports`. ```yaml 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 Default value: None @@ -1192,16 +1254,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameInCcBox. ```yaml -Type: $true | $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 Default value: None @@ -1213,16 +1275,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameInToBox. ```yaml -Type: $true | $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 Default value: None @@ -1234,16 +1296,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameInToOrCcBox. ```yaml -Type: $true | $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 Default value: None @@ -1255,16 +1317,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfMyNameNotInToBox. ```yaml -Type: $true | $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 Default value: None @@ -1273,13 +1335,33 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies a name for the Inbox rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies a name for the Inbox rule. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String 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 +``` + +### -PinMessage +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. +- $false: The action isn't used. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1295,6 +1377,7 @@ 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 Default value: None @@ -1305,7 +1388,7 @@ Accept wildcard characters: False ### -ReceivedAfterDate The ReceivedAfterDate parameter specifies a condition for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. @@ -1314,6 +1397,7 @@ 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 Default value: None @@ -1324,7 +1408,7 @@ Accept wildcard characters: False ### -ReceivedBeforeDate The ReceivedBeforeDate parameter specifies a condition for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. @@ -1333,6 +1417,7 @@ 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 Default value: None @@ -1343,9 +1428,11 @@ Accept wildcard characters: False ### -RecipientAddressContainsWords The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -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 enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. @@ -1354,6 +1441,7 @@ 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 Default value: None @@ -1362,27 +1450,23 @@ Accept wildcard characters: False ``` ### -RedirectTo -The RedirectTo parameter specifies an action for the Inbox rule that recdirects the message to the specified recipient. You can use any value that uniquely identifies the recipient. - -For example: +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 - -- Display name - +- Alias - Distinguished name (DN) - - Canonical DN - +- Email address - GUID -You can specify multiple recipients separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] 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 @@ -1391,17 +1475,20 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo +This parameter is available only in on-premises Exchange. + The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1413,16 +1500,16 @@ Accept wildcard characters: False 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. - - $false: The condition isn't used. The corresponding exception parameter to this condition is ExceptIfSentOnlyToMe. ```yaml -Type: $true | $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 Default value: None @@ -1431,21 +1518,16 @@ Accept wildcard characters: False ``` ### -SentTo -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: +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 - -- Display name - +- Alias - Distinguished name (DN) - - Canonical DN - +- Email address - GUID -You can specify multiple recipients 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"`. The corresponding exception parameter to this condition is ExceptIfSentTo. @@ -1454,6 +1536,25 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteMessage +This parameter is available only in the cloud-based service. + +{{ Fill SoftDeleteMessage Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -1465,14 +1566,14 @@ Accept wildcard characters: False 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. - - $false: The action isn't used (continue processing more rules after this one). ```yaml -Type: $true | $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 Default value: None @@ -1483,9 +1584,11 @@ Accept wildcard characters: False ### -SubjectContainsWords The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. @@ -1494,6 +1597,7 @@ 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 Default value: None @@ -1504,9 +1608,11 @@ Accept wildcard characters: False ### -SubjectOrBodyContainsWords The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. @@ -1515,6 +1621,7 @@ 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 Default value: None @@ -1530,6 +1637,7 @@ 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 Default value: None @@ -1541,18 +1649,17 @@ Accept wildcard characters: False The WithImportance parameter specifies a condition for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High - - Normal - - Low The corresponding exception parameter to this condition is ExceptIfWithImportance. ```yaml -Type: Low | Normal | High +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 Default value: None @@ -1566,13 +1673,9 @@ The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1586,6 +1689,7 @@ 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 Default value: None @@ -1599,13 +1703,9 @@ The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1619,6 +1719,7 @@ 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 Default value: None @@ -1630,171 +1731,18 @@ Accept wildcard characters: False The WithSensitivity parameter specifies a condition for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal - - Personal - - Private - - CompanyConfidential The corresponding exception parameter to this condition is ExceptIfWithSensitivity. ```yaml -Type: Normal | Personal | Private | CompanyConfidential +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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplySystemCategory -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 - -- Bills - -- Document - -- DocumentPlus - -- Event - -- Family - -- File - -- Flight - -- FromContact - -- Important - -- LiveView - -- Lodging - -- MailingList -- Newsletter - -- Photo - -- Purchase - -- RentalCar - -- RestaurantReservation - -- RetiredPromotion - -- ShippingNotification - -- Shopping - -- SocialUpdate - -- Travel - -- Video - -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: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteSystemCategory -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 - -- Bills - -- Document - -- DocumentPlus - -- Event - -- Family - -- File - -- Flight - -- FromContact - -- Important - -- LiveView - -- Lodging - -- MailingList - -- Newsletter - -- Photo - -- Purchase - -- RentalCar - -- RestaurantReservation - -- RetiredPromotion - -- ShippingNotification - -- Shopping - -- SocialUpdate - -- Travel - -- Video - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PinMessage -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. - -- $false: The action isn't used. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named Default value: None @@ -1803,20 +1751,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/baef3e69-ff01-4e00-a4bb-e8826bbbf38b.aspx) diff --git a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md new file mode 100644 index 0000000000..2fbe4dd044 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md @@ -0,0 +1,274 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-InformationBarrierPolicy + +## 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-InformationBarrierPolicy cmdlet to modify information barrier policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### OrganizationSegmentsAllowed +``` +Set-InformationBarrierPolicy -Identity + [-SegmentsAllowed ] + [-Comment ] + [-Confirm] + [-ModerationAllowed ] + [-Force] + [-State ] + [-WhatIf] + [] +``` + +### OrganizationSegmentAllowedFilter +``` +Set-InformationBarrierPolicy -Identity + [-SegmentAllowedFilter ] + [-Comment ] + [-Confirm] + [-Force] + [-ModerationAllowed ] + [-State ] + [-WhatIf] + [] +``` + +### OrganizationSegmentsBlocked +``` +Set-InformationBarrierPolicy -Identity + [-SegmentsBlocked ] + [-Comment ] + [-Confirm] + [-Force] + [-ModerationAllowed ] + [-State ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Information barrier policies are not in effect until you set them to active status, and then apply the policies: + +- (If needed): [Block communications between segments](https://learn.microsoft.com/purview/information-barriers-policies#scenario-1-block-communications-between-segments). +- After all of your policies are defined: [Apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). + +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-InformationBarrierPolicy -Identity 43c37853-ea10-4b90-a23d-ab8c93772471 -State Active +``` + +This example activates the specified inactive information barrier policy. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationAllowed +{{ Fill ModerationAllowed Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SegmentsAllowed +The SegmentsAllowed parameter specifies the segments that are allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). Only these specified segments can communicate with the segment in this policy. + +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"). + +You can't use this parameter with the SegmentsBlocked parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: OrganizationSegmentsAllowed +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SegmentAllowedFilter +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: OrganizationSegmentAllowedFilter +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SegmentsBlocked +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"). + +You can't use this parameter with the SegmentsAllowed parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: OrganizationSegmentsBlocked +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: + +- Active +- Inactive + +```yaml +Type: EopInformationBarrierPolicyState +Parameter Sets: (All) +Aliases: +Accepted values: Inactive, Active +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 + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md similarity index 75% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md rename to exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md index 4495c71e16..5216746dff 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-IntraOrganizationConnector @@ -13,25 +16,31 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-IntraOrganizationConnector cmdlet to modify an existing Intra-Organization connector between two on-premises Exchange forests in an organization, between an on-premises Exchange organization and an Exchange Online organization or between two Exchange Online organizations. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-IntraOrganizationConnector [-Identity] [-Confirm] - [-DiscoveryEndpoint ] [-DomainController ] [-Enabled <$true | $false>] - [-TargetAddressDomains ] [-WhatIf] [] +Set-IntraOrganizationConnector [-Identity] + [-Confirm] + [-DiscoveryEndpoint ] + [-DomainController ] + [-Enabled ] + [-TargetAddressDomains ] + [-TargetSharingEpr ] + [-WhatIf] + [] ``` ## DESCRIPTION Intra-Organizational connectors enable features and services between divisions in your Exchange organization. It allows for the expansion of organizational boundaries for features and services across different hosts and network boundaries, such as between Active Directory forests, between on-premises and cloud-based organizations or between tenants hosted in the same or different datacenters. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-IntraOrganizationConnector "MainCloudConnector" -Enabled $false ``` @@ -43,16 +52,15 @@ This example disables the Intra-Organization connector named "MainCloudConnector 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 - - Distinguished name (DN) - - GUID ```yaml Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True Position: 1 Default value: None @@ -63,15 +71,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -87,6 +95,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -104,6 +113,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -117,10 +127,11 @@ The Enabled parameter enables or disabled the Intra-organization connector. The When you set the value to $false, you completely stop connectivity for the specific connection. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -136,6 +147,25 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSharingEpr +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. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -150,7 +180,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -159,20 +190,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2f8176a8-c685-4be1-a2f3-b5e4ee4ae55c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-JournalRule.md b/exchange/exchange-ps/exchange/Set-JournalRule.md similarity index 80% rename from exchange/exchange-ps/exchange/policy-and-compliance/Set-JournalRule.md rename to exchange/exchange-ps/exchange/Set-JournalRule.md index b87f153536..3c8d9f1233 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-JournalRule.md +++ b/exchange/exchange-ps/exchange/Set-JournalRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-JournalRule @@ -13,33 +16,38 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-JournalRule cmdlet to modify an existing journal rule in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-JournalRule [-Identity] [-Confirm] [-DomainController ] - [-JournalEmailAddress ] - [-Name ] [-Recipient ] [-Scope ] [-WhatIf] +Set-JournalRule [-Identity] + [-Confirm] + [-DomainController ] + [-JournalEmailAddress ] + [-Name ] + [-Recipient ] + [-Scope ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-JournalRule "Consolidated Messenger" -JournalEmailAddress "ArchiveMailbox@contoso.com" ``` This example modifies the journal email address to which journal reports are sent by the existing journal rule Consolidated Messenger. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-JournalRule | Set-JournalRule -JournalEmailAddress "Archive Mailbox" ``` @@ -57,6 +65,7 @@ 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 Default value: None @@ -67,8 +76,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -76,6 +84,7 @@ 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 Default value: None @@ -93,6 +102,7 @@ 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 @@ -101,13 +111,21 @@ Accept wildcard characters: False ``` ### -JournalEmailAddress -The JournalEmailAddress parameter specifies a journal recipient. Journal reports for the specified rule are sent to the journal recipient. +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID ```yaml 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 Default value: None @@ -123,6 +141,7 @@ 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 Default value: None @@ -133,11 +152,14 @@ Accept wildcard characters: False ### -Recipient The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or received from a recipient are journaled. +To journal messages from all recipients, use the value $null for this parameter. + ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -149,16 +171,15 @@ Accept wildcard characters: False 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. - - Internal: Internal rules process email messages sent to and received by recipients in your organization. - - External: External rules process email messages sent to recipients or from senders outside your organization. ```yaml -Type: Internal | External | Global +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 Default value: None @@ -174,6 +195,7 @@ 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 Default value: None @@ -182,20 +204,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e72562c6-64d2-43c3-81b0-062e7d7b28c9.aspx) diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md new file mode 100644 index 0000000000..8424874e92 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -0,0 +1,1665 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-Label + +## 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-Label cmdlet to modify sensitivity labels in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-Label [-Identity] + [-AdvancedSettings ] + [-ApplyContentMarkingFooterAlignment ] + [-ApplyContentMarkingFooterEnabled ] + [-ApplyContentMarkingFooterFontColor ] + [-ApplyContentMarkingFooterFontName ] + [-ApplyContentMarkingFooterFontSize ] + [-ApplyContentMarkingFooterMargin ] + [-ApplyContentMarkingFooterText ] + [-ApplyContentMarkingHeaderAlignment ] + [-ApplyContentMarkingHeaderEnabled ] + [-ApplyContentMarkingHeaderFontColor ] + [-ApplyContentMarkingHeaderFontName ] + [-ApplyContentMarkingHeaderFontSize ] + [-ApplyContentMarkingHeaderMargin ] + [-ApplyContentMarkingHeaderText ] + [-ApplyDynamicWatermarkingEnabled ] + [-ApplyWaterMarkingEnabled ] + [-ApplyWaterMarkingFontColor ] + [-ApplyWaterMarkingFontName ] + [-ApplyWaterMarkingFontSize ] + [-ApplyWaterMarkingLayout ] + [-ApplyWaterMarkingText ] + [-ColumnAssetCondition ] + [-Comment ] + [-Conditions ] + [-Confirm] + [-ContentType ] + [-DefaultContentLabel ] + [-DisplayName ] + [-DynamicWatermarkDisplay ] + [-EncryptionContentExpiredOnDateInDaysOrNever ] + [-EncryptionDoNotForward ] + [-EncryptionDoubleKeyEncryptionUrl ] + [-EncryptionEnabled ] + [-EncryptionEncryptOnly ] + [-EncryptionOfflineAccessDays ] + [-EncryptionPromptUser ] + [-EncryptionProtectionType ] + [-EncryptionRightsDefinitions ] + [-EncryptionRightsUrl ] + [-LabelActions ] + [-LocaleSettings ] + [-MigrationId ] + [-NextLabel ] + [-ParentId ] + [-PreviousLabel ] + [-Priority ] + [-SchematizedDataCondition ] + [-Setting ] + [-Settings ] + [-SiteAndGroupProtectionAllowAccessToGuestUsers ] + [-SiteAndGroupProtectionAllowEmailFromGuestUsers ] + [-SiteAndGroupProtectionAllowFullAccess ] + [-SiteAndGroupProtectionAllowLimitedAccess ] + [-SiteAndGroupProtectionBlockAccess ] + [-SiteAndGroupProtectionEnabled ] + [-SiteAndGroupProtectionLevel ] + [-SiteAndGroupProtectionPrivacy ] + [-SiteExternalSharingControlType ] + [-TeamsAllowedPresenters ] + [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] + [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] + [-TeamsCopyRestrictionEnforced ] + [-TeamsEndToEndEncryptionEnabled ] + [-TeamsLobbyBypassScope ] + [-TeamsLobbyRestrictionEnforced ] + [-TeamsPresentersRestrictionEnforced ] + [-TeamsProtectionEnabled ] + [-TeamsRecordAutomatically ] + [-TeamsVideoWatermark ] + [-TeamsWhoCanRecord ] + [-Tooltip ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-Label -Identity "Label1" -LocaleSettings '{"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"}]}','{"localeKey":"tooltip","Settings":[{"Key":"en-us","Value":"This is an example label"},{"Key":"de-de","Value":"Dies ist ein Beispieletikett"},{"Key":"es-es","Value":"Esta es una etiqueta de ejemplo"}]}' +``` + +This example sets the localized label name and label Tooltips for "Label1" in different languages (English, German, and Spanish). + +### Example 2 +```powershell +Set-Label -Identity "Label1" -LocaleSettings '{"localeKey":"DisplayName","Settings":[{"Key":"en-us","Value":""},{"Key":"de-de","Value":""},{"Key":"es-es","Value":""}]}','{"localeKey":"tooltip","Settings":[{"Key":"en-us","Value":""},{"Key":"de-de","Value":""},{"Key":"es-es","Value":""}]}' +``` + +This example removes the localized label name and label Tooltips for "Label1" in different languages (English, German, and Spanish). + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -AdvancedSettings +The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. + +Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. + +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). + +Supported settings for built-in labeling: + +- **BlockContentAnalysisServices**: Specifies a privacy setting to allow or prevent content in Word, Excel, PowerPoint, and Outlook from being sent to Microsoft for content analysis. Available values are True, and False (the default). This setting impacts services such as data loss prevention policy tips, automatic and recommended labeling, and Microsoft Copilot for Microsoft 365. Example: `Set-Label -Identity Confidential -AdvancedSettings @{BlockContentAnalysisServices="True"}`. For more information, see [Prevent some connected experiences that analyze content](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#prevent-some-connected-experiences-that-analyze-content). + +- **Color**: Specifies a label color as a hex triplet code for the red, green, and blue (RGB) components of the color. Example: `Set-Label -Identity 8faca7b8-8d20-48a3-8ea2-0f96310a848e -AdvancedSettings @{color="#40e0d0"}`. For more information, see [Configuring custom colors by using PowerShell](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). + +- **DefaultSharingScope**: Specifies the default sharing link type for a site when the label scope includes **Groups & sites**, and the default sharing link type for a document when the label scope includes **Files & emails**. Available values are SpecificPeople, Organization, and Anyone. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultSharingScope="SpecificPeople"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkPermission**: Specifies the permissions for the sharing link for a site when the label scope includes **Groups & sites**, and the permissions for the sharing link for a document when the label scope includes **Files & emails**. Available values are View and Edit. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultShareLinkPermission="Edit"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkToExistingAccess**: Specifies whether to override *DefaultSharingScope* and *DefaultShareLinkPermission* to instead set the default sharing link type to people with existing access with their existing permissions. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultShareLinkToExistingAccess="True"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultSubLabelId**: Specifies a default sublabel to be applied automatically when a user selects a parent label in Office apps. Example: `Set-Label -Identity Confidential -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"}`. For more information, see [Specify a default sublabel for a parent label](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#specify-a-default-sublabel-for-a-parent-label). + +- **MembersCanShare**: For a container label, specifies how members can share for a SharePoint site. Available values are MemberShareAll, MemberShareFileAndFolder, and MemberShareNone. Example: `Set-Label -Identity General -AdvancedSettings @{MembersCanShare="MemberShareFileAndFolder"}`. For more information, see [Configure site sharing permissions by using PowerShell advanced settings](https://learn.microsoft.com/purview/sensitivity-labels-teams-groups-sites#configure-site-sharing-permissions-by-using-powershell-advanced-settings). + +- **SMimeEncrypt**: Specifies S/MIME encryption for Outlook. Available values are True, and False (the default). Example: `Set-Label -Identity "Confidential" -AdvancedSettings @{SMimeEncrypt="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +- **SMimeSign**: Specifies S/MIME digital signature for Outlook. Available values are True, and False (the default). Example: `Set-Label -Identity "Confidential" -AdvancedSettings @{SMimeSign="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +For more information to help you configure advanced settings for a label, see [PowerShell tips for specifying the advanced settings](https://learn.microsoft.com/purview/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings). + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterAlignment +The ApplyContentMarkingFooterAlignment parameter specifies the footer alignment. Valid values are: + +- Left +- Center +- Right + +This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterEnabled +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. +- $false: The Apply Content Marking Footer action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterFontColor +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. + +```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 +``` + +### -ApplyContentMarkingFooterFontName +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. + +This parameter is supported only by the Azure Information Protection unified labeling client and not by Office apps and services that support built-in labeling. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterFontSize +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterMargin +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 (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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingFooterText +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. + +```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 +``` + +### -ApplyContentMarkingHeaderAlignment +The ApplyContentMarkingHeaderAlignment parameter specifies the header alignment. Valid values are: + +- Left +- Center +- Right + +This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderEnabled +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. +- $false: The Apply Content Marking Header action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderFontColor +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. + +```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 +``` + +### -ApplyContentMarkingHeaderFontName +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. + +```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 +``` + +### -ApplyContentMarkingHeaderFontSize +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderMargin +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. + +**Note**: In Microsoft Word and PowerPoint, the specified value is used as a top margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyContentMarkingHeaderText +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. + +```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 +``` + +### -ApplyDynamicWatermarkingEnabled +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are: + +- $true: Enables dynamic watermarking for a specific label. +- $false: Disables dynamic watermarking for a specific label. + +You set the watermark text with the DynamicWatermarkDisplay parameter. For more information about using dynamic watermarks for supported apps, see [Dynamic watermarks](https://learn.microsoft.com/purview/encryption-sensitivity-labels#dynamic-watermarks). + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingEnabled +The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: + +- $true: The Apply Watermarking Header action is enabled. +- $false: The Apply Watermarking Header action is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingFontColor +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. + +```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 +``` + +### -ApplyWaterMarkingFontName +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. + +```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 +``` + +### -ApplyWaterMarkingFontSize +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingLayout +The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: + +- Horizontal +- Diagonal + +This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyWaterMarkingText +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. + +```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 +``` + +### -ColumnAssetCondition +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Conditions +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 +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 +``` + +### -ContentType +The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: + +- File +- Email +- Site +- UnifiedGroup +- PurviewAssets +- Teamwork +- SchematizedData + +Values can be combined, for example: "File, Email, PurviewAssets". + +```yaml +Type: MipLabelContentType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultContentLabel +The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicWatermarkDisplay +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens: + +- **"\`${Consumer.PrincipalName}**": Required. The value is the user principal name (UPN) of the user. +- **"\`${Device.DateTime}**": Optional. The value is current date/time of the device used to view the document. + +**Tip** The back quotation mark character ( \` ) is required as an escape character for the dollar sign character ( $ ) in PowerShell. For more information, see [Escape characters in Exchange PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax#escape-characters-in-exchange-powershell). + +This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled parameter value is $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionContentExpiredOnDateInDaysOrNever +The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: + +- An integer (number of days) +- The value `Never` + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```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 +``` + +### -EncryptionDoNotForward +The EncryptionDoNotForward parameter specifies whether the Do Not Forward template is applied. Valid values are: + +- $true: The Do Not Forward template is applied. +- $false: The Do Not Forward template is not applied. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionDoubleKeyEncryptionUrl +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -EncryptionEnabled +The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: + +- $true: Encryption is enabled. +- $false: Encryption is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionEncryptOnly +The EncryptionEncryptOnly parameter specifies whether the encrypt-only template is applied. Valid values are: + +- $true: The encrypt-only template is applied. +- $false: The encrypt-only template is not applied. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionOfflineAccessDays +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPromptUser +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. +- $false: The label is not set with user defined permissions in Word, Excel and PowerPoint. + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false, and when the EncryptionProtectionType parameter value is UserDefined. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionProtectionType +The EncryptionProtectionType parameter specifies the protection type for encryption. Valid values are: + +- Template +- RemoveProtection +- UserDefined + +This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionRightsDefinitions +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. + +```yaml +Type: EncryptionRightsDefinitionsParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionRightsUrl +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. + +```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 +``` + +### -LabelActions +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocaleSettings +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"}]}` +- Label Tooltips: `{"localeKey":"Tooltip","Settings":[{"Key":"en-us","Value":"English Tooltip"},{"Key":"de-de","Value":"Deutscher Tooltip"},{"Key":"es-es","Value":"Tooltip Español"}]}` + +To remove a language, you need to enter an empty value for that language. + +```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 +``` + +### -MigrationId +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -NextLabel +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentId +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviousLabel +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchematizedDataCondition +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Settings +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionAllowAccessToGuestUsers +The SiteAndGroupProtectionAllowAccessToGuestUsers parameter enables or disables access to guest users. Valid values are: + +- $true: Guest access is enabled. +- $false: Guest access is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```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 +``` + +### -SiteAndGroupProtectionAllowEmailFromGuestUsers +The SiteAndGroupProtectionAllowEmailFromGuestUsers parameter enables or disables email from guest users. Valid values are: + +- $true: Email from guest users is enabled. +- $false: Email from guest users is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```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 +``` + +### -SiteAndGroupProtectionAllowFullAccess +The SiteAndGroupProtectionAllowFullAccess parameter enables or disables full access. Valid values are: + +- $true: Full access is enabled. +- $false: Full access is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```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 +``` + +### -SiteAndGroupProtectionAllowLimitedAccess +The SiteAndGroupProtectionAllowLimitedAccess parameter enables or disables limited access. Valid values are: + +- $true: Limited access is enabled. +- $false: Limited access is disabled. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```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 +``` + +### -SiteAndGroupProtectionBlockAccess +The SiteAndGroupProtectionBlockAccess parameter blocks access. Valid values are: + +- $true: Access is blocked. +- $false: Access is allowed. + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```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 +``` + +### -SiteAndGroupProtectionEnabled +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. +- $false: The Site and Group Protection action is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionLevel +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SiteAndGroupProtectionLevelParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionPrivacy +The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the labe. Valid values are: + +- Public +- Private + +This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteExternalSharingControlType +The SiteExternalSharingControlType parameter specifies the external user sharing setting for the label. Valid values are: + +- ExternalUserAndGuestSharing +- ExternalUserSharingOnly +- ExistingExternalUserSharingOnly +- Disabled + +These correspond to the following settings through the admin center: + +- Anyone +- New and Existing Guests +- Existing Guests +- Only people in your organization + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowedPresenters +The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: + +- Everyone +- Organization +- Organizer +- RoleIsPresenter +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowMeetingChat +The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: + +- Enabled +- Disabled +- Limited: Chat is available only for the duration of the call. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch +{{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsBypassLobbyForDialInUsers +The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: + +- $true: Dial in users bypass the lobby when joining Teams meetings. +- $false: Dial in users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCopyRestrictionEnforced +The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: + +- $true: Chat messages can be copied to the clipboard. +- $false: Chat messages can't be copied to the clipboard. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEndToEndEncryptionEnabled +The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: + +- $true: Video stream encryption is enabled. +- $false: Video stream encryption is not enabled. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyBypassScope +The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: + +- Everyone +- Invited +- Organization +- OrganizationAndFederated +- OrganizationExcludingGuests +- Organizer +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyRestrictionEnforced +The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: + +- $true: Users bypass the lobby when joining Teams meetings. +- $false: Users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsPresentersRestrictionEnforced +The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: + +- $true: Presenter restrictions are enabled in Teams meetings. +- $false: Presenter restrictions aren't enabled in Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsProtectionEnabled +The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: + +- $true: Teams protection is enabled in Teams meetings. +- $false: Teams protection is not enabled in Teams meetings. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsRecordAutomatically +The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: + +- $true: Teams meetings are automatically recorded after they start. +- $false: Teams meetings are not automatically recorded. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsVideoWatermark +The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: + +- None +- EnabledForContentSharing +- EnabledForVideo +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsWhoCanRecord +The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: + +- Organizer +- Coorganizers +- Presenters +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tooltip +The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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 + +[New-Label](https://learn.microsoft.com/powershell/module/exchange/new-label) diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md new file mode 100644 index 0000000000..5b190d2637 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -0,0 +1,818 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-LabelPolicy + +## 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 Set-Label cmdlet to modify sensitivity label policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### RetryDistribution +``` +Set-LabelPolicy [-Identity] -RetryDistribution + [-AddLabels ] + [-AdvancedSettings ] + [-Confirm] + [-MigrationId ] + [-NextLabelPolicy ] + [-PreviousLabelPolicy ] + [-RemoveLabels ] + [] +``` + +### Identity +``` +Set-LabelPolicy [-Identity] + [-AddExchangeLocation ] + [-AddExchangeLocationException ] + [-AddLabels ] + [-AddModernGroupLocation ] + [-AddModernGroupLocationException ] + [-AddOneDriveLocation ] + [-AddOneDriveLocationException ] + [-AddPublicFolderLocation ] + [-AddSharePointLocation ] + [-AddSharePointLocationException ] + [-AddSkypeLocation ] + [-AddSkypeLocationException ] + [-AdvancedSettings ] + [-Comment ] + [-Confirm] + [-MigrationId ] + [-NextLabelPolicy ] + [-PolicyRBACScopes ] + [-RemoveExchangeLocation ] + [-RemoveExchangeLocationException ] + [-RemoveLabels ] + [-RemoveModernGroupLocation ] + [-RemoveModernGroupLocationException ] + [-RemoveOneDriveLocation ] + [-RemoveOneDriveLocationException ] + [-RemovePublicFolderLocation ] + [-RemoveSharePointLocation ] + [-RemoveSharePointLocationException ] + [-RemoveSkypeLocation ] + [-RemoveSkypeLocationException ] + [] +``` + +### AdaptiveScopeLocation +``` +Set-LabelPolicy [-Identity] + [-AddLabels ] + [-AdvancedSettings ] + [-Comment ] + [-Confirm] + [-Force] + [-MigrationId ] + [-NextLabelPolicy ] + [-PreviousLabelPolicy ] + [-RemoveLabels ] + [-Setting ] + [-Settings ] + [-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). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-LabelPolicy -Identity "Global Policy" -RemoveExchangeLocation $_ }`. + +## EXAMPLES + +### Example 1 +```powershell +Set-LabelPolicy -Identity "Global Policy" -AdvancedSettings @{EnableCustomPermissions="False"} +``` + +This example configures the specified advanced setting for the sensitivity label policy name Global Policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RetryDistribution +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. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. A valid value is a mailbox. + +To specify the mailbox, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocationException +The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you 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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddLabels +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 +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocation +The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups. 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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPublicFolderLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSkypeLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSkypeLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedSettings +The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. + +Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. + +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). + +Supported settings for built-in labeling: + +- **AttachmentAction**: Unlabeled emails inherit the highest priority label from file attachments. Set the value to **Automatic** (to automatically apply the label) or **Recommended** (as a recommended prompt to the user. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{AttachmentAction="Automatic"}`. For more information about this configuration choice, see [Configure label inheritance from email attachments](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-label-inheritance-from-email-attachments). + +- **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. + +- **EnableRevokeGuiSupport**: Remove the Track & Revoke button from the sensitivity menu in Office clients. Supported apps: Word, Excel, and PowerPoint on Windows (version 2406+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableRevokeGuiSupport="False"}`. For more information about this configuration choice, see [Track and revoke document access](https://learn.microsoft.com/purview/track-and-revoke-admin). + +- **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **TeamworkMandatory**: Outlook and Teams apps that support this setting can enable or disable mandatory labeling for meetings. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{TeamworkMandatory="True"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). + +- **teamworkdefaultlabelid**: Outlook and Teams apps that support this setting apply a default label, or no label for meetings. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{teamworkdefaultlabelid="General"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). + +- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) will be displayed. Users can't revert this setting in the app. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` + +- **DisableShowSensitiveContent**: For Office apps that highlight the sensitive content that caused a label to be recommended, turn off these highlights and corresponding indications about the sensitive content. For more information, see [Sensitivity labels are automatically applied or recommended for your files and emails in Office](https://support.microsoft.com/office/sensitivity-labels-are-automatically-applied-or-recommended-for-your-files-and-emails-in-office-622e0d9c-f38c-470a-bcdb-9e90b24d71a1). Supported apps: Word for Windows (version 2311+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableShowSensitiveContent="True"}` + +Additionally, for Power BI: + +- **powerbimandatory**: Mandatory labeling for Power BI. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbimandatory="true"}`. For more information about this configuration choice, see [Mandatory label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). + +- **powerbidefaultlabelid**: Default label for Power BI content. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbidefaultlabelid="General"}`. For more information about this configuration choice, see [Default label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-label-policy). + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity, AdaptiveScopeLocation +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 +``` + +### -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: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationId +This parameter is reserved for internal Microsoft use. + +```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 +``` + +### -NextLabelPolicy +The NextLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is after the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviousLabelPolicy +The PreviousLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is before the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocationException +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 +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveLabels +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 +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocation +The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups. 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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePublicFolderLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSkypeLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSkypeLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Settings +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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-LinkedUser.md b/exchange/exchange-ps/exchange/Set-LinkedUser.md new file mode 100644 index 0000000000..ab7afd569b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-LinkedUser.md @@ -0,0 +1,132 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-LinkedUser + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-LinkedUser cmdlet to modify the properties of an existing linked user account. The Outlook Live Directory Sync (OLSync) service account is a linked user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-LinkedUser [-Identity] + [-CertificateSubject ] + [-Confirm] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-LinkedUser "GALSync-ServiceAccount" -CertificateSubject "X509:CN=3rdPartyCAExample.comC=US,O=Contoso Corp, CN=contoso.com" +``` + +This example modifies the certificate subject for the linked user "GALSync-ServiceAccount". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the linked user. You can use any value that uniquely identifies the linked user, for example: + +- Name +- Distinguished name (DN) + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CertificateSubject +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..db10ad8518 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,233 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-M365DataAtRestEncryptionPolicy cmdlet to modify Microsoft 365 data-at-rest encryption policies in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### TenantAdminPurgeKeyRequest +``` +Set-M365DataAtRestEncryptionPolicy [-Identity] [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-Force] + [-Name ] + [-WhatIf] + [] +``` + +### RefreshKey +``` +Set-M365DataAtRestEncryptionPolicy [-Identity] [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-Name ] + [-Refresh] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-M365DataAtRestEncryptionPolicy -Identity "Tenant Default Policy" -Enabled $false +``` + +This example disabled the Microsoft 365 data-at-rest encryption policy named Tenant Default Policy. + +### Example 2 +```powershell +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. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +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 policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: DCAdminPurgeKeyRequest, TenantAdminPurgeKeyRequest +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Refresh +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md new file mode 100644 index 0000000000..d5a82bfdda --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md @@ -0,0 +1,70 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-M365DataAtRestEncryptionPolicyAssignment + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-M365DataAtRestEncryptionPolicyAssignment cmdlet to assign a Microsoft 365 data-at-rest encryption policy at the tenant level. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy "Contoso Corporate" +``` + +This example assigns the Microsoft 365 data-at-rest encryption policy named Contoso Corporate. + +## PARAMETERS + +### -DataEncryptionPolicy +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md new file mode 100644 index 0000000000..e699c9dec7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -0,0 +1,1620 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailContact cmdlet to modify existing mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailContact [-Identity] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArbitrationMailbox ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DisplayName ] + [-DomainController ] + [-EmailAddresses ] + [-EmailAddressPolicyEnabled ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-IgnoreDefaultScope] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxRecipientPerMessage ] + [-MaxSendSize ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-PrimarySmtpAddress ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemovePicture] + [-RemoveSpokenName] + [-RequireSenderAuthenticationEnabled ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailContact -Identity "John Rodman" -ExternalEmailAddress "john@contoso.com" +``` + +This example sets John Rodman's external email address to john@contoso.com. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDTMFMap +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute1 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalEmailAddress +The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. + +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. + +When you use the ExternalEmailAddress parameter to change the external email address, the old external email address isn't kept as a proxy address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this mail contact. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -MacAttachmentFormat +The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: + +- BinHex (This is the default value) +- UuEncode +- AppleSingle +- AppleDouble + +The MacAttachmentFormat and MessageFormat parameters are interdependent: + +- MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. +- MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +This parameter is available only in on-premises Exchange. + +The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail contact. Messages larger than the maximum size are rejected. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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. + +The value unlimited indicates the maximum receive message size for the mail contact is controlled elsewhere (for example, organization, server, or connector limits). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +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 +``` + +### -MaxRecipientPerMessage +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. + +A valid value is an integer up to 2147483647 (Int32) or the value unlimited. The default value is unlimited. + +The value unlimited indicates the maximum number of recipients per message for the mail contact is controlled elsewhere (for example, organization, server, or connector limits). + +```yaml +Type: Unlimited +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 +``` + +### -MaxSendSize +This parameter is available only in on-premises Exchange. + +The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail contact. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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. + +The value unlimited indicates the maximum send message size for the mail contact is controlled elsewhere (for example, organization, server, or connector limits). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +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 +``` + +### -MessageBodyFormat +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) + +The MessageFormat and MessageBodyFormat parameters are interdependent: + +- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. +- MessageFormat is Text: MessageBodyFormat can only be Text. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageFormat +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) + +The MessageFormat and MessageBodyFormat parameters are interdependent: + +- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. +- MessageFormat is Text: MessageBodyFormat can only be Text. + +Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +This parameter is available only in on-premises Exchange. + +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. + +By default, the primary address is the same as the ExternalEmailAddress parameter value. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail contact aren't automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```yaml +Type: SmtpAddress +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 +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePicture +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. + +You can add a picture to a mail contact by using the Import-RecipientDataProperty 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSpokenName +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. + +You can add a sound file to a mail contact by using the Import-RecipientDataProperty 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryAddress +This parameter is available only in on-premises Exchange. + +The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryDialPlan +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. + +```yaml +Type: UMDialPlanIdParameter +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDtmfMap +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: + +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` + +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. + +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. + +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. + +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. + +```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: False +Accept wildcard characters: False +``` + +### -UseMapiRichTextFormat +The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: + +- Always: TNEF is used for all messages sent to the mail user or mail contact. +- Never: TNEF is never used for any messages sent to the mail user or mail contact. TNEF messages are converted to plain text. +- UseDefaultSettings: TNEF messages aren't specifically allowed or prevented for the mail user or mail contact. Whether TNEF messages are sent to the recipient depends on the remote domain TNEF settings (the default remote domain or a specific remote domain), or the Outlook Rich Text message settings specified by the sender in Outlook. + +The default value is UseDefaultSettings. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePreferMessageFormat +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCertificate +This parameter is available only in the cloud-based service. + +The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSMimeCertificate +This parameter is available only in the cloud-based service. + +The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md new file mode 100644 index 0000000000..8dd27b3503 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md @@ -0,0 +1,1513 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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. + +NOTE: The settings that you configure on a public folder mailbox might interfere with the existing settings on a public folder within in the mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailPublicFolder [-Identity] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArbitrationMailbox ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-Contacts ] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-DomainController ] + [-EmailAddresses ] + [-EmailAddressPolicyEnabled ] + [-EntryId ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-ForwardingAddress ] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-IgnoreDefaultScope] + [-IgnoreMissingFolderLink ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-OnPremisesObjectId ] + [-PhoneticDisplayName ] + [-PrimarySmtpAddress ] + [-PublicFolderType ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RequireSenderAuthenticationEnabled ] + [-SendModerationNotifications ] + [-Server ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailPublicFolder -Identity MyPublicFolder@contoso.onmicrosoft.com -EmailAddresses @{add="MyPublicFolder@contoso.com","MyPublicFolder@fabrikam.com"} +``` + +This example adds the specified secondary email addresses to the mail enabled public folder MyPublicFolder@contoso.onmicrosoft.com. + +Verify the accepted domains are present in the organization before adding email addresses in those domains. + +### Example 2 +```powershell +Set-MailPublicFolder -Identity MyPublicFolder -PrimarySmtpAddress MyPublicFolder@contoso.com -EmailAddressPolicyEnabled $false +``` + +This example sets the primary email address of the specified mail-enabled public folder to MyPublicFolder@contoso.com + +### Example 3 +```powershell +Set-MailPublicFolder -Identity MyPublicFolder -EmailAddresses @{remove="MyPublicFolder@fabrikam.com"} +``` + +This example removes the secondary email address MyPublicFolder@fabrikam.com from the specified mail-enabled public folder. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: MailPublicFolderIdParameter +Parameter Sets: (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 wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Contacts +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -CreateDTMFMap +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliverToMailboxAndForward +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. +- $false: If a forwarding recipient or email address is configured, messages are delivered only to the specified recipient or email address, and messages aren't delivered to this public folder. If no forwarding recipient or email address is configured, messages are delivered only to this public folder. + +The default value is $false. The value of this parameter is meaningful only if you configure a forwarding recipient or email address. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntryId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute1 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalEmailAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingAddress +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. + +- DeliverToMailboxAndForward is $true: Messages are delivered to this public folder and forwarded to the specified recipient. +- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified recipient. Messages aren't delivered to this public folder. + +The default value is blank ($null), which means no forwarding recipient is configured. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this public folder. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IgnoreMissingFolderLink +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSendSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesObjectId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneticDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the public folder are no longer automatically updated by email address policies. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderType +The PublicFolderType parameter specifies which of the following four types is assigned to the public folder: + +- GeneralPurpose +- Mapi +- Nntp +- NotSpecified + +```yaml +Type: PublicFolderType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDtmfMap +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md new file mode 100644 index 0000000000..45d451af6c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -0,0 +1,3051 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailUser cmdlet to modify mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Set-MailUser [-Identity] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArbitrationMailbox ] + [-ArchiveGuid ] + [-ArchiveName ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DisplayName ] + [-DomainController ] + [-EmailAddressPolicyEnabled ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-IgnoreDefaultScope] + [-ImmutableId ] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RecoverableItemsQuota ] + [-RecoverableItemsWarningQuota ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemovePicture] + [-RemoveSpokenName] + [-RequireSenderAuthenticationEnabled ] + [-SamAccountName ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-SkipDualWrite] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserPrincipalName ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### EnableLitigationHoldForMigration +``` +Set-MailUser [-Identity] [-EnableLitigationHoldForMigration] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### ExcludeFromAllOrgHolds +``` +Set-MailUser [-Identity] [-ExcludeFromAllOrgHolds] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-LOBAppAccount] + [-JournalArchiveAddress ] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### ExcludeFromOrgHolds +``` +Set-MailUser [-Identity] [-ExcludeFromOrgHolds ] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RecalculateInactiveMailUser +``` +Set-MailUser [-Identity] [-RecalculateInactiveMailUser] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveComplianceTagHoldApplied +``` +Set-MailUser [-Identity] [-RemoveComplianceTagHoldApplied] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveDelayHoldApplied +``` +Set-MailUser [-Identity] [-RemoveDelayHoldApplied] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveDelayReleaseHoldApplied +``` +Set-MailUser [-Identity] [-RemoveDelayReleaseHoldApplied] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveDisabledArchive +``` +Set-MailUser [-Identity] [-RemoveDisabledArchive] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveLitigationHoldEnabled +``` +Set-MailUser [-Identity] [-RemoveLitigationHoldEnabled] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveOrphanedHolds +``` +Set-MailUser [-Identity] [-RemoveOrphanedHolds ] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UMDtmfMap ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### 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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Default +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 +``` + +### -ArchiveGuid +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveName +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +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 +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDTMFMap +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +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, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name of the mail user. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Default +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 +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLitigationHoldForMigration +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. + +This feature is not available in hybrid tenants. + +```yaml +Type: SwitchParameter +Parameter Sets: EnableLitigationHoldForMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeGuid +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFromAllOrgHolds +This parameter is available only in the cloud-based service. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFromOrgHolds +This parameter is available only in the cloud-based service. + +{{ Fill ExcludeFromOrgHolds Description }} + +```yaml +Type: String[] +Parameter Sets: ExcludeFromOrgHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute1 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalEmailAddress +The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. + +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. + +When you use the ExternalEmailAddress parameter to change the external email address, the old external email address isn't kept as a proxy address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this mail user. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HVEAccount +This parameter is available only in the cloud-based service. + +The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Position: Named +Default value: None +Required: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: Default +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 +``` + +### -ImmutableId +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JournalArchiveAddress +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, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LOBAppAccount +This parameter is available only in the cloud-based service. + +{{ Fill LOBAppAccount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacAttachmentFormat +The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: + +- BinHex (This is the default value) +- UuEncode +- AppleSingle +- AppleDouble + +The MacAttachmentFormat and MessageFormat parameters are interdependent: + +- MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. +- MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegion +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, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSendSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageBodyFormat +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) + +The MessageFormat and MessageBodyFormat parameters are interdependent: + +- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. +- MessageFormat is Text: MessageBodyFormat can only be Text. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageFormat +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) + +The MessageFormat and MessageBodyFormat parameters are interdependent: + +- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. +- MessageFormat is Text: MessageBodyFormat can only be Text. + +Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftOnlineServicesID +This parameter is available only in the cloud-based service. + +The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter 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, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +This parameter is available only in the cloud-based service. + +The Password parameter allows users to change their own password. You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +You can't use this parameter to change another user's password (the parameter is available only via the MyBaseOptions user role). To change another user's password, use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +This parameter is functional only in on-premises Exchange. + +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +By default, the primary address is the same as the ExternalEmailAddress parameter value. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail user are no longer automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecalculateInactiveMailUser +This parameter is available only in the cloud-based service. + +{{ Fill RecalculateInactiveMailUser Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: RecalculateInactiveMailUser +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimits +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. + +A valid value is an integer or the value unlimited. The default value is unlimited. + +The value unlimited indicates the maximum number of recipients per message for the mail user is controlled elsewhere (for example, organization, server, or connector limits). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoverableItemsQuota +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. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +A valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). + +The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. + +```yaml +Type: Unlimited +Parameter Sets: Default +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 +``` + +### -RecoverableItemsWarningQuota +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. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +A valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). + +The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. + +```yaml +Type: Unlimited +Parameter Sets: Default +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 +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveComplianceTagHoldApplied +This parameter is available only in the cloud-based service. + +{{ Fill RemoveComplianceTagHoldApplied Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveComplianceTagHoldApplied +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDelayHoldApplied +This parameter is available only in the cloud-based service. + +{{ Fill RemoveDelayHoldApplied Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveDelayHoldApplied +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDelayReleaseHoldApplied +This parameter is available only in the cloud-based service. + +{{ Fill RemoveDelayReleaseHoldApplied Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveDelayReleaseHoldApplied +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDisabledArchive +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveLitigationHoldEnabled +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. + +This switch is useful in scenarios where admins can't permanently delete mail users due to litigation holds on the mail users. For more information on litigation hold, see [Create a Litigation hold](https://learn.microsoft.com/en-us/purview/ediscovery-create-a-litigation-hold). + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveLitigationHoldEnabled +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveMailboxProvisioningConstraint +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, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOrphanedHolds +This parameter is available only in the cloud-based service. + +{{ Fill RemoveOrphanedHolds Description }} + +```yaml +Type: String[] +Parameter Sets: RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePicture +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. + +You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: Default +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 +``` + +### -RemoveSpokenName +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. + +You can add a sound file to a mail user by using the Import-RecipientDataProperty cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: Default +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 +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetPasswordOnNextLogon +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. + +You can't use this parameter to require another user to change their password (the parameter is available only via the MyBaseOptions user role). You need to use the ForceChangePasswordNextSignIn value in the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +Parameter Sets: Default +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 +``` + +### -SecondaryAddress +This parameter is available only in on-premises Exchange. + +The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryDialPlan +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. + +```yaml +Type: UMDialPlanIdParameter +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDualWrite +This parameter is available only in Exchange 2016 or later. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: Default +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMDtmfMap +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: + +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` + +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. + +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. + +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. + +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +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 +``` + +### -UnblockForwardSyncPostCrossTenantMigration +This parameter is available only in the cloud-based service. + +{{ Fill UnblockForwardSyncPostCrossTenantMigration Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMapiRichTextFormat +The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: + +- Always: TNEF is used for all messages sent to the mail user or mail contact. +- Never: TNEF is never used for any messages sent to the mail user or mail contact. TNEF messages are converted to plain text. +- UseDefaultSettings: TNEF messages aren't specifically allowed or prevented for the mail user or mail contact. Whether TNEF messages are sent to the recipient depends on the remote domain TNEF settings (the default remote domain or a specific remote domain), or the Outlook Rich Text message settings specified by the sender in Outlook. + +The default value is UseDefaultSettings. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePreferMessageFormat +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCertificate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Default +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 +``` + +### -UserSMimeCertificate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md new file mode 100644 index 0000000000..f24e40f01c --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -0,0 +1,5759 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-Mailbox cmdlet to modify the settings of existing mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Set-Mailbox [-Identity] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-AntispamBypassEnabled ] + [-ApplyMandatoryProperties] + [-Arbitration] + [-ArbitrationMailbox ] + [-ArchiveDatabase ] + [-ArchiveDomain ] + [-ArchiveName ] + [-ArchiveQuota ] + [-ArchiveStatus ] + [-ArchiveWarningQuota ] + [-AttributesToClear ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLog] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-AuxAuditLog] + [-BypassModerationFromSendersOrMembers ] + [-CalendarLoggingQuota ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClientExtensions ] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-Database ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisableThrottling ] + [-DisplayName ] + [-DomainController ] + [-DowngradeHighPriorityMessagesEnabled ] + [-DumpsterMessagesPerFolderCountReceiveQuota ] + [-DumpsterMessagesPerFolderCountWarningQuota ] + [-EmailAddresses ] + [-EmailAddressPolicyEnabled ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-ExtendedPropertiesCountQuota ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-FolderHierarchyChildrenCountReceiveQuota ] + [-FolderHierarchyChildrenCountWarningQuota ] + [-FolderHierarchyDepthReceiveQuota ] + [-FolderHierarchyDepthWarningQuota ] + [-FoldersCountReceiveQuota ] + [-FoldersCountWarningQuota ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GMGen ] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-IgnoreDefaultScope] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-IsExcludedFromServingHierarchy ] + [-IsHierarchyReady ] + [-IsHierarchySyncEnabled ] + [-IssueWarningQuota ] + [-Languages ] + [-LinkedCredential ] + [-LinkedDomainController ] + [-LinkedMasterAccount ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxMessagesPerFolderCountReceiveQuota ] + [-MailboxMessagesPerFolderCountWarningQuota ] + [-MailTip ] + [-MailTipTranslations ] + [-ManagedFolderMailboxPolicy ] + [-ManagedFolderMailboxPolicyAllowed] + [-Management ] + [-MaxBlockedSenders ] + [-MaxReceiveSize ] + [-MaxSafeSenders ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageTracking ] + [-MessageTrackingReadStatusEnabled ] + [-Migration ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NewPassword ] + [-OABGen ] + [-Office ] + [-OfflineAddressBook ] + [-OldPassword ] + [-OMEncryption ] + [-OMEncryptionStore ] + [-Password ] + [-PrimarySmtpAddress ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-PstProvider ] + [-PublicFolder] + [-QueryBaseDN ] + [-RecipientLimits ] + [-RecoverableItemsQuota ] + [-RecoverableItemsWarningQuota ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoteRecipientType ] + [-RemoveManagedFolderAndPolicy] + [-RemovePicture] + [-RemoveSpokenName] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetainDeletedItemsUntilBackup ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SamAccountName ] + [-SCLDeleteEnabled ] + [-SCLDeleteThreshold ] + [-SCLJunkEnabled ] + [-SCLJunkThreshold ] + [-SCLQuarantineEnabled ] + [-SCLQuarantineThreshold ] + [-SCLRejectEnabled ] + [-SCLRejectThreshold ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-StartDateForRetentionHold ] + [-StsRefreshTokensValidFrom ] + [-SystemMessageSizeShutoffQuota ] + [-SystemMessageSizeWarningQuota ] + [-ThrottlingPolicy ] + [-Type ] + [-UMDataStorage ] + [-UMDtmfMap ] + [-UMGrammar ] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserPrincipalName ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### ExcludeFromAllOrgHolds +``` +Set-Mailbox [-Identity] + [-ExcludeFromAllOrgHolds] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-AuxAuditLog] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageTracking ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-SkipDualWrite] + [-StartDateForRetentionHold ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### ExcludeFromOrgHolds +``` +Set-Mailbox [-Identity] + [-ExcludeFromOrgHolds ] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-AuxAuditLog] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageTracking ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-SkipDualWrite] + [-StartDateForRetentionHold ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RecalculateInactiveMailbox +``` +Set-Mailbox [-Identity] + [-RecalculateInactiveMailbox] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-AuxAuditLog] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageTracking ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-SkipDualWrite] + [-StartDateForRetentionHold ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveDelayHoldApplied +``` +Set-Mailbox [-Identity] + [-RemoveDelayHoldApplied] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-AuxAuditLog] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageTracking ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-SkipDualWrite] + [-StartDateForRetentionHold ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveDelayReleaseHoldApplied +``` +Set-Mailbox [-Identity] + [-RemoveDelayReleaseHoldApplied] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-StartDateForRetentionHold ] + [-StsRefreshTokensValidFrom ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WindowsEmailAddress ] + [-Confirm] + [-WhatIf] + [] + ``` + +### RemoveDisabledArchive +``` +Set-Mailbox [-Identity] + [-RemoveDisabledArchive] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-SkipDualWrite] + [-StartDateForRetentionHold ] + [-StsRefreshTokensValidFrom ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UseDatabaseRetentionDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +### RemoveOrphanedHolds +``` +Set-Mailbox [-Identity] + [-RemoveOrphanedHolds ] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-AccountDisabled ] + [-AddressBookPolicy ] + [-Alias ] + [-ApplyMandatoryProperties] + [-ArchiveName ] + [-AuditAdmin ] + [-AuditDelegate ] + [-AuditEnabled ] + [-AuditLogAgeLimit ] + [-AuditOwner ] + [-BypassModerationFromSendersOrMembers ] + [-CalendarRepairDisabled ] + [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] + [-Confirm] + [-CreateDTMFMap ] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DefaultAuditSet ] + [-DefaultPublicFolderMailbox ] + [-DeliverToMailboxAndForward ] + [-DisplayName ] + [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] + [-EmailAddresses ] + [-EnableRoomMailboxAccount ] + [-EndDateForRetentionHold ] + [-EnforcedTimestamps ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalOofOptions ] + [-Force] + [-ForwardingAddress ] + [-ForwardingSmtpAddress ] + [-GrantSendOnBehalfTo ] + [-GroupMailbox ] + [-HiddenFromAddressListsEnabled ] + [-ImListMigrationCompleted ] + [-ImmutableId ] + [-InactiveMailbox] + [-IsExcludedFromServingHierarchy ] + [-IssueWarningQuota ] + [-JournalArchiveAddress ] + [-Languages ] + [-LitigationHoldDate ] + [-LitigationHoldDuration ] + [-LitigationHoldEnabled ] + [-LitigationHoldOwner ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageCopyForSendOnBehalfEnabled ] + [-MessageCopyForSentAsEnabled ] + [-MessageCopyForSMTPClientSubmissionEnabled ] + [-MessageRecallProcessingEnabled ] + [-MessageTrackingReadStatusEnabled ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-NonCompliantDevices ] + [-Office ] + [-Password ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-ProvisionedForOfficeGraph] + [-PublicFolder] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResourceCapacity ] + [-ResourceCustom ] + [-RetainDeletedItemsFor ] + [-RetentionComment ] + [-RetentionHoldEnabled ] + [-RetentionPolicy ] + [-RetentionUrl ] + [-RoleAssignmentPolicy ] + [-RoomMailboxPassword ] + [-RulesQuota ] + [-SchedulerAssistant ] + [-SecondaryAddress ] + [-SecondaryDialPlan ] + [-SendModerationNotifications ] + [-SharingPolicy ] + [-SimpleDisplayName ] + [-SingleItemRecoveryEnabled ] + [-SkipDualWrite] + [-StartDateForRetentionHold ] + [-StsRefreshTokensValidFrom ] + [-Type ] + [-UMDtmfMap ] + [-UpdateEnforcedTimestamp] + [-UseDatabaseQuotaDefaults ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-Mailbox -Identity "John Woods" -DeliverToMailboxAndForward $true -ForwardingSMTPAddress manuel@contoso.com +``` + +This example delivers John Woods's email messages to John's mailbox and also forwards them to Manuel Oliveira's (manuel@contoso.com) mailbox. + +### Example 2 +```powershell +Get-Mailbox -OrganizationalUnit "Marketing" | Set-Mailbox -UseDatabaseQuotaDefaults $false -IssueWarningQuota 200MB -ProhibitSendQuota 250MB -ProhibitSendReceiveQuota 280MB +``` + +This example uses the Get-Mailbox cmdlet to find all the mailboxes in the Marketing organizational unit, and then uses the Set-Mailbox cmdlet to configure these mailboxes. The custom warning, prohibit send, and prohibit send and receive limits are set to 200 megabytes (MB), 250 MB, and 280 MB respectively, and the mailbox database's default limits are ignored. + +### Example 3 +```powershell +Get-User -Filter "Department -eq 'Customer Service'" | Set-Mailbox -MaxSendSize 2MB +``` + +This example uses the Get-User command to find all users in the Customer Service department, and then uses the Set-Mailbox command to change the maximum message size for sending messages to 2 MB. + +### Example 4 +```powershell +Set-Mailbox John@contoso.com -MailTipTranslations ("FR: C'est la langue française", "CHT: 這是漢語語言") +``` + +This example sets the MailTip translation in French and Chinese. + +### Example 5 +```powershell +$password = Read-Host "Enter password" -AsSecureString + +Set-Mailbox florencef -Password $password -ResetPasswordOnNextLogon $true +``` + +In on-premises Exchange, this example resets the password for Florence Flipo's mailbox. The next time she signs in to her mailbox, she'll have to change her password. + +### Example 6 +```powershell +Set-Mailbox -Arbitration -Identity "SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}" -MessageTracking $false + +Set-Mailbox -Arbitration -Identity "SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}" -MessageTracking $true +``` + +This example removes the message tracking organization capability from the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} and assigns it to an arbitration mailbox named SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}. + +### Example 7 +```powershell +Set-Mailbox -Identity "John Woods" -EmailAddresses @{add="Jwoods@contoso.com"} +``` + +This example adds a secondary email address to John's mailbox. + +### Example 8 +```powershell +Set-Mailbox -Identity asraf@contoso.com -RemoveDelayReleaseHoldApplied +``` + +In Exchange Online, this example removes the delay hold that's applied to Asraf's mailbox so an offboarding migration (that is, a mailbox migration from Exchange Online back to on-premises Exchange) can continue successfully. For more information about delay holds, see [Managing mailboxes on delay hold](https://learn.microsoft.com/purview/ediscovery-identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountDisabled +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: + +- $true: The associated account is disabled. The user can't log in to the mailbox. +- $false: The associated account is enabled. The user can log in to the mailbox. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressBookPolicy +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 +- Distinguished name (DN) +- GUID + +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies) or [Address book policies in Exchange Online](https://learn.microsoft.com/exchange/address-books/address-book-policies/address-book-policies). + +```yaml +Type: AddressBookMailboxPolicyIdParameter +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 +``` + +### -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: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntispamBypassEnabled +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 + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -ApplyMandatoryProperties +The ApplyMandatoryProperties switch specifies whether to update the msExchVersion attribute of the mailbox. You don't need to specify a value with this switch. + +You might need to use this switch to fix inaccessible mailboxes or mailboxes that were created in previous versions of Exchange. + +```yaml +Type: SwitchParameter +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 +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +To modify arbitration mailboxes that are used to store audit log settings or data, don't use this switch. Instead, use the AuditLog or AuxAuditLog switches. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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 +``` + +### -ArbitrationMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Identity +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 +``` + +### -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. + +Only use this parameter if the archive is hosted in the cloud-based service. + +```yaml +Type: SmtpDomain +Parameter Sets: Identity +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 +``` + +### -ArchiveName +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +In on-premises Exchange, the following default values are used based on the version of Exchange: + +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Exchange Online, the default value is `In-Place Archive -`. + +In Outlook in Exchange Online, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (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 +``` + +### -ArchiveQuota +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. + +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The ArchiveQuota value must be greater than or equal to the ArchiveWarningQuota value. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -ArchiveStatus +This cmdlet is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ArchiveStatusFlags +Parameter Sets: Identity +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 +``` + +### -ArchiveWarningQuota +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. + +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The ArchiveWarningQuota value must be less than or equal to the ArchiveQuota value. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -AttributesToClear +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SetMailbox+ClearableADAttributes[] +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditAdmin +The AuditAdmin parameter specifies the mailbox operations to log for administrators as part of mailbox audit logging. Valid values are: + +- None +- AddFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- ApplyRecord (Available only in the cloud-based service.) +- Copy +- 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.) +- 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.) +- RecordDelete (Available only in the cloud-based service.) +- RemoveFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- SendAs (Enabled by default.) +- SendOnBehalf (Enabled by default.) +- SoftDelete (Enabled by default.) +- Update (Enabled by default.) +- UpdateFolderPermissions (Available only in Exchange 2019 and the cloud-based service; enabled by default.) +- UpdateCalendarDelegation (Available only in Exchange 2019 and the cloud-based service; enabled by default.) +- UpdateInboxRules (Available only in Exchange 2019 and the cloud-based service; enabled by default.) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The AuditEnabled parameter must be set to $true to enable mailbox audit logging. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditDelegate +The AuditDelegate parameter specifies the mailbox operations to log for delegate users as part of mailbox audit logging. Valid values are: + +- None +- AddFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- ApplyRecord (Available only in the cloud-based service.) +- Create (Enabled by default.) +- FolderBind +- HardDelete (Enabled by default.) +- ModifyFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- Move +- MoveToDeletedItems (Enabled by default only in the cloud-based service.) +- RecordDelete (Available only in the cloud-based service.) +- RemoveFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- SendAs (Enabled by default.) +- SendOnBehalf (Enabled by default only in the cloud-based service.) +- SoftDelete (Enabled by default only in the cloud-based service.) +- Update (Enabled by default only in the cloud-based service.) +- UpdateFolderPermissions (Available only in Exchange 2019 and the cloud-based service; enabled by default.) +- UpdateInboxRules (Available only in Exchange 2019 and the cloud-based service; enabled by default.) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The AuditEnabled parameter must be set to $true to enable mailbox audit logging. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditEnabled +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. + +**Note**: In Exchange Online, mailbox auditing on by default was enabled for all organizations in January, 2019. For more information, see [Manage mailbox auditing](https://learn.microsoft.com/purview/audit-mailboxes). + +```yaml +Type: Boolean +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 +``` + +### -AuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To modify other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLogAgeLimit +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. + +For example, to specify 60 days for this parameter, use 60.00:00:00. Setting this parameter to the value 00:00:00 removes all audit log entries for the mailbox. The entries are removed the next time the Managed Folder Assistant processes the mailbox (automatically or manually by running the Start-ManagedFolderAssistant cmdlet). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditOwner +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.) +- AddFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- ApplyRecord (Available only in the cloud-based service.) +- Create +- FolderBind (Available only in Exchange 2013.) +- HardDelete (Enabled by default in the cloud-based service.) +- MailboxLogin (Available only in Exchange 2016, Exchange 2019, and the cloud-based service.) +- MessageBind (Available only in Exchange 2013.) +- ModifyFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- Move +- MoveToDeletedItems (Enabled by default in the cloud-based service.) +- RecordDelete (Available only in the cloud-based service.) +- RemoveFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) +- SoftDelete (Enabled by default in the cloud-based service.) +- Update (Enabled by default in the cloud-based service.) +- UpdateFolderPermissions (Available only in the cloud-based service; enabled by default.) +- UpdateCalendarDelegation (Available only in the cloud-based service; enabled by default.) +- UpdateInboxRules (Available only in the cloud-based service; enabled by default.) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +The AuditEnabled parameter must be set to $true to enable mailbox audit logging. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxAuditLog +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. + +Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. + +To modify other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarLoggingQuota +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. + +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). + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The value of this parameter must be less than or equal to the value of the RecoverableItemsQuota parameter. + +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 CalendarLoggingQuota 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. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -CalendarRepairDisabled +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarVersionStoreDisabled +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClearThrottlingPolicyAssignment +This parameter is available only in the cloud-based service. + +The ClearThrottlingPolicyAssignment switch specifies whether to clear any throttling policy assignments for the mailbox. You don't need to specify a value with this switch. + +Admins can contact Microsoft Support to assign a throttling policy to a mailbox, which changes the default throttling limits for various protocols. To revert those changes, use this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientExtensions +This parameter is available only in on-premises Exchange. + +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. + +Valid values are $true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDTMFMap +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Identity +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 +``` + +### -DataEncryptionPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAuditSet +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: + +- Admin: Reverts the mailbox operations to log for administrators back to the default list of 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). + +```yaml +Type: MultiValuedProperty +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderMailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +By default, the public folder mailbox used by a user is automatically selected by an algorithm that load-balances users across all public folder mailboxes. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliverToMailboxAndForward +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. +- $false: If a forwarding recipient or email address is configured, messages are delivered only to the specified recipient or email address, and messages aren't delivered to this mailbox. If no forwarding recipient or email address is configured, messages are delivered only to this mailbox. + +The default value is $false. The value of this parameter is meaningful only if you configure a forwarding recipient or email address. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableThrottling +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Identity +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 +``` + +### -DowngradeHighPriorityMessagesEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -DumpsterMessagesPerFolderCountReceiveQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List DumpsterMessagesPerFolderCountReceiveQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -DumpsterMessagesPerFolderCountWarningQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List DumpsterMessagesPerFolderCountWarningQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -ElcProcessingDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill EmailAddressDisplayNames Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +The EmailAddresses parameter specifies all 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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRoomMailboxAccount +This parameter is functional only in on-premises Exchange. + +The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: + +- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. The account is able to log in and access the room mailbox or other resources. +- $false: The account that's associated with the room mailbox is disabled. The account is not able to log in and access the room mailbox or other resources. In on-premises Exchange, this is the default value. + +You need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. + +A room mailbox in Exchange Online is created with associated an account that has a random, unknown password. This account is active and visible in Microsoft Graph PowerShell and the Microsoft 365 admin center just like a regular user account, but it consumes no licenses. To prevent this account from being able to log in after you create the mailbox, use the AccountEnabled parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDateForRetentionHold +The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, you need to set the RetentionHoldEnabled parameter to the value $true. + +**Important**: Using this parameter does not change the _RetentionHoldEnabled_ value to $false after the specified date. The _RentionHoldEnabled_ will still be $true on the mailbox after the specified date, but MRM will start processing mailbox items as normal. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +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 +``` + +### -EnforcedTimestamps +This parameter is available only in the cloud-based service. + +{{ Fill EnforcedTimestamps Description }} + +```yaml +Type: String +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFromAllOrgHolds +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. + +When you use this switch, use the DistinguishedName or ExchangeGuid property value for the identity of the inactive mailbox (those are the only values that guarantee uniqueness). + +```yaml +Type: SwitchParameter +Parameter Sets: ExcludeFromAllOrgHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFromOrgHolds +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'. + +You can specify multiple values by using the syntax: "GUID1","GUID2",..."GUIDX". + +When you use this parameter, use the DistinguishedName or ExchangeGuid property value for the identity of the inactive mailbox (those are the values that guarantee uniqueness). + +```yaml +Type: String[] +Parameter Sets: ExcludeFromOrgHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedPropertiesCountQuota +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. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -ExtensionCustomAttribute1 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalOofOptions +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderHierarchyChildrenCountReceiveQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyChildrenCountReceiveQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -FolderHierarchyChildrenCountWarningQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyChildrenCountWarningQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -FolderHierarchyDepthReceiveQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyDepthReceiveQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -FolderHierarchyDepthWarningQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyDepthWarningQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -FoldersCountReceiveQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FoldersCountReceiveQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -FoldersCountWarningQuota +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. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FoldersCountReceiveQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ForwardingAddress +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. + +- DeliverToMailboxAndForward is $true: Messages are delivered to this mailbox and forwarded to the specified recipient. +- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified recipient. Messages aren't delivered to this mailbox. + +The default value is blank ($null), which means no forwarding recipient is configured. + +If you configure values for both the ForwardingAddress and ForwardingSmtpAddress parameters, the value of ForwardingSmtpAddress is ignored. Messages are forwarded to the recipient specified by the ForwardingAddress parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingSmtpAddress +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. + +- DeliverToMailboxAndForward is $true: Messages are delivered to this mailbox and forwarded to the specified email address. +- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified email address. Messages aren't delivered to this mailbox. + +The default value is blank ($null), which means no forwarding email address is configured. + +If you configure values for both the ForwardingAddress and ForwardingSmtpAddress parameters, the value of ForwardingSmtpAddress is ignored. Messages are forwarded to the recipient specified by the ForwardingAddress parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GMGen +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. + +Valid values are $true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -GrantSendOnBehalfTo +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this mailbox. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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. + +```yaml +Type: MailboxIdParameter +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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 +``` + +### -ImListMigrationCompleted +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. + +Valid values are: + +- $true: The user's Lync or Skype for Business contact list is stored in their Exchange 2016 mailbox. This prevents you from migrating the mailbox back to an Exchange 2010 server. +- $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This is the default value. + +Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutableId +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InactiveMailbox +This parameter is available only in the cloud-based service. + +The InactiveMailbox switch specifies that the mailbox is an inactive mailbox. 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. + +To find inactive mailboxes, run the command `Get-Mailbox -InactiveMailboxOnly | Format-List Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid` and then use the DistinguishedName or ExchangeGuid property values for the Identity parameter (values guaranteed to be unique). + +This switch is required to use the LitigationHoldEnabled and LitigationHoldDuration parameters on inactive mailboxes. + +You can't use this switch to modify other properties on inactive mailboxes. + +```yaml +Type: SwitchParameter +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +You should use this parameter only during public folder migrations. Don't use this parameter once the initial migration validation is complete. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHierarchyReady +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -IsHierarchySyncEnabled +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueWarningQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JournalArchiveAddress +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SmtpAddress +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Languages +The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -LinkedCredential +This parameter is available only in on-premises Exchange. + +The LinkedCredential parameter specifies the credentials used to access the domain controller specified by the LinkedDomainController parameter. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: Identity +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 +``` + +### -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. + +```yaml +Type: String +Parameter Sets: Identity +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 +``` + +### -LinkedMasterAccount +This parameter is available only in on-premises Exchange. + +The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LitigationHoldDate +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LitigationHoldDuration +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LitigationHoldEnabled +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. + +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. + +Placing public folder mailboxes on Litigation Hold isn't supported. To place public folder mailboxes on hold, create an In-Place Hold by using the New-MailboxSearch cmdlet with the InPlaceHoldEnabled parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LitigationHoldOwner +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMessagesPerFolderCountReceiveQuota +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. + +The MailboxMessagesPerFolderCountReceiveQuota value must be greater than or equal to the MailboxMessagesPerFolderCountWarningQuota value. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List MailboxMessagesPerFolderCountReceiveQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -MailboxMessagesPerFolderCountWarningQuota +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. + +The MailboxMessagesPerFolderCountReceiveQuota value must be greater than or equal to the MailboxMessagesPerFolderCountWarningQuota value. + +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List MailboxMessagesPerFolderCountWarningQuota`. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -MailboxRegion +This parameter is available only in the cloud-based service. + +The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. + +To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the following command: `Get-OrganizationConfig | Select -ExpandProperty AllowedMailboxRegions | Format-Table`. To view your central geo location, run the following command: `Get-OrganizationConfig | Select DefaultMailboxRegion`. + + For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). + +```yaml +Type: String +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderMailboxPolicy +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. + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderMailboxPolicyAllowed +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. + +When a managed folder mailbox policy is assigned to a mailbox by using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless you also use the ManagedFolderMailboxPolicyAllowed switch. + +Although Outlook 2003 Service Pack 3 clients are supported, they have limited MRM functionality. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Management +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. + +Valid values are $true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -MaxBlockedSenders +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. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -MaxReceiveSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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, 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. + +In on-premises Exchange, the default value unlimited indicates the maximum receive size for the mailbox is imposed elsewhere (for example, organization, server, or connector limits). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSafeSenders +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. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -MaxSendSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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, 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. + +In on-premises Exchange, the default value unlimited indicates the maximum send size for the mailbox is imposed elsewhere (for example, organization, server, or connector limits). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageCopyForSendOnBehalfEnabled +**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. + +You give users permission to send on behalf of a mailbox by using the GrantSendOnBehalfTo parameter on the mailbox. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageCopyForSentAsEnabled +**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. + +In Exchange Online, you give a user permission to send as a mailbox by running this command: `Add-RecipientPermission -AccessRights SendAs -Trustee `. + +In on-premises Exchange, you give a user permission to send as a mailbox by running this command: `Add-ADPermission -ExtendedRights "Send As" -User `. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageCopyForSMTPClientSubmissionEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTracking +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. + +Valid values are$true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: FalseNamed +Position: +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTrackingReadStatusEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftOnlineServicesID +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). + +```yaml +Type: SmtpAddress +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Migration +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). + +```yaml +Type: String +Parameter Sets: (All) +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 +``` + +### -NewPassword +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. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: Identity +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 +``` + +### -NonCompliantDevices +This parameter is available only in the cloud-based service. + +{{ Fill NonCompliantDevices Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OABGen +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. + +Valid values are $true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -Office +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineAddressBook +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: + +- Name +- Distinguished name (DN) +- GUID + +Use the Get-OfflineAddressBook cmdlet to see the available offline address books. + +```yaml +Type: OfflineAddressBookIdParameter +Parameter Sets: Identity +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 +``` + +### -OldPassword +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. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: Identity +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 +``` + +### -OMEncryption +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -OMEncryptionStore +This parameter is available only in on-premises Exchange. + +PARAMVALUE: Boolean + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password parameter resets the password of the user account that's associated with the mailbox to the value you specify. To use this parameter on a mailbox other than your own, consider the following options: + +- Exchange Online: You can't use this parameter to change another user's password. Use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. +- On-premises Exchange: You need the User Options or Reset Password role. The User Options role is assigned to the Organization Management or Help Desk role groups. The Reset Password role it isn't assigned to any role groups by default. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +This parameter is available only in on-premises Exchange. + +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mailbox are no longer automatically updated by email address policies. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```yaml +Type: SmtpAddress +Parameter Sets: Identity +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 +``` + +### -ProhibitSendQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProhibitSendReceiveQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. + +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, 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 ProhibitSendReceiveQuota 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionedForOfficeGraph +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PstProvider +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -PublicFolder +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryBaseDN +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationalUnitIdParameter +Parameter Sets: Identity +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 +``` + +### -RecalculateInactiveMailbox +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. + +An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. + +You use this switch with the InactiveMailbox switch and the Identity parameter (with DistinguishedName or ExchangeGuid property values) to force the recalculation of the hold status for the inactive mailbox, which might lead to the soft-deletion of the mailbox if all holds on the mailbox have expired. + +```yaml +Type: SwitchParameter +Parameter Sets: RecalculateInactiveMailbox +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimits +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). + +In the cloud-based service, a valid value is an integer from 1 to 1000. The default value is 500. This value does not apply to meeting messages. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -RecoverableItemsQuota +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. + +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). + +When you enter a number, you can qualify it with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. + +When the UseDatabaseQuotaDefaults parameter is set to the value $true (the default value), the value of the this parameter is ignored, and the mailbox uses the RecoverableItemsQuota 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. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -RecoverableItemsWarningQuota +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. + +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). + +When you enter a number, you can qualify it with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. + +When the UseDatabaseQuotaDefaults parameter is set to the value $true (the default value), the value of the this parameter is ignored, and the mailbox uses the RecoverableItemsWarningQuota 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. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteRecipientType +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: RemoteRecipientType +Parameter Sets: Identity +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 +``` + +### -RemoveDelayHoldApplied +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. + +The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName HoldTracking`. + +You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. +For more information, see [Managing mailboxes on delay hold](https://learn.microsoft.com/purview/ediscovery-identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveDelayHoldApplied +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDelayReleaseHoldApplied +This parameter is available only in the cloud-based service. + +The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Viva Engage) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. + +The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName SubstrateHoldTracking`. + +You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. + +For more information, see [Managing mailboxes on delay hold](https://learn.microsoft.com/purview/ediscovery-identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveDelayReleaseHoldApplied +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDisabledArchive +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. + +```yaml +Type: SwitchParameter +Parameter Sets: RemoveDisabledArchive +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveMailboxProvisioningConstraint +This parameter is available only in the cloud-based service. + +{{ Fill RemoveMailboxProvisioningConstraint Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveManagedFolderAndPolicy +This parameter is available only in on-premises Exchange. + +The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM policies and attributes from a mailbox. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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 +``` + +### -RemoveOrphanedHolds +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. + +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. + +```yaml +Type: String[] +Parameter Sets: RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePicture +This parameter is available only in on-premises Exchange. + +The RemovePicture switch specifies whether to remove the picture from the mailbox. You don't need to specify a value with this switch. + +You can add a picture to a mailbox by using the Import-RecipientDataProperty cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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 +``` + +### -RemoveSpokenName +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. + +You can add a sound file to a mailbox by using the Import-RecipientDataProperty cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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 +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetPasswordOnNextLogon +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -ResourceCapacity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceCustom +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. + +After you create custom resource properties, you use this parameter to assign one or more of those properties to a resource mailbox. Properties that begin with the prefix Room/ are available only on room mailboxes, and properties that begin with the prefix Equipment/ are available only on equipment mailboxes. When you specify a property value for this parameter, don't include the prefix. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -RetainDeletedItemsFor +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. +- Selecting the Empty Deleted Items Folder action. +- Deleting items using Shift + Delete. + +These actions move the items into the Recoverable Items\\Deletions folder. + +Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +The default value is 14 days (14.00:00:00). In Exchange Online, you can increase the value to a maximum of 30 days. + +In Exchange Online, you use this parameter to configure the deleted item retention on existing mailboxes. Use the Set-MailboxPlan cmdlet to change the RetainDeletedItemsFor value for all new mailboxes that you create in the future. + +In on-premises Exchange, 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 DeletedItemRetention value from the mailbox database. To use the RetainDeletedItemsFor parameter on the mailbox, you need to set the UseDatabaseQuotaDefaults parameter to the value $false. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainDeletedItemsUntilBackup +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. + +When the UseDatabaseRetentionDefaults parameter on the mailbox is set to the value $true (the default value), the value of the this parameter is ignored, and the mailbox uses the RetainDeletedItemsUntilBackup parameter value from the mailbox database. To use the RetainDeletedItemsUntilBackup parameter on the mailbox, you need to set the UseDatabaseRetentionDefaults parameter to the value $false. + +For more information, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -RetentionComment +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. + +In Exchange Online, this parameter is associated with Litigation Hold (the LitigationHoldEnabled parameter), so you don't need to set the RetentionHoldEnabled parameter to $true when you use this parameter. + +This comment should be localized to the user's preferred language. If the comment contains spaces, enclose the comment 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionHoldEnabled +The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: + +- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items from the mailbox isn't possible (even using MFCMapi). +- $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This is the default value. + +To set the start date for retention hold, use the StartDateForRetentionHold parameter. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicy +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 +- Distinguished Name (DN) +- GUID + +Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. + +Use the Get-RetentionPolicy cmdlet to see the available retention policies. + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionUrl +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentPolicy +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 +- Distinguished name (DN) +- GUID + +In Exchange Online, a role assignment policy must be assigned to the mailbox. In on-premises Exchange, to configure the mailbox so there's no role assignment policy assigned, use the value $null. + +Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomMailboxPassword +This parameter is functional only in on-premises Exchange. + +Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). + +To use this parameter in on-premises Exchange, you need to be a member of one of the following role groups: + +- The Organization Management role group via the Mail Recipients and User Options roles. +- The Recipient Management role group via the Mail Recipients role. +- The Help Desk role group via the User Options role. + +The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +To configure the password for a room mailbox account in Exchange Online, use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RulesQuota +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: + +- B (bytes) +- KB (kilobytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +In Exchange 2010, the default value is 64 kilobytes (65,536 bytes). + +The quota for Inbox rules applies only to enabled rules. There is no restriction on the number of disabled rules a mailbox can have. However, the total size of rules that are enabled or active can't exceed the value specified for this parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +Parameter Sets: Identity +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 +``` + +### -SchedulerAssistant +This parameter is available only in the cloud-based service. + +{{ Fill SchedulerAssistant Description }} + +```yaml +Type: Boolean +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SCLDeleteEnabled +This parameter is available only in on-premises Exchange. + +The SCLDeleteEnabled parameter specifies whether to silently delete messages that meet or exceed the spam confidence level (SCL) specified by the SCLDeleteThreshold parameter. Valid values are: + +- $true: Messages that meet or exceed the SCLDeleteThreshold value are silently deleted without sending 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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -SCLDeleteThreshold +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. + +A valid value is an integer from 0 through 9. This value should be greater than the other SCL\*Threshold values. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -SCLJunkEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -SCLJunkThreshold +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. + +A valid value is an integer from 0 through 9. This value should be less than the other SCL\*Threshold values. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -SCLQuarantineEnabled +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. + +To configure the quarantine mailbox, see [Configure a spam quarantine mailbox](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-quarantine-mailboxes). + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -SCLQuarantineThreshold +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. + +A valid value is an integer from 0 through 9. This value should be less than the SCLRejectThreshold value, but greater than the SCLJunkThreshold value. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -SCLRejectEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -SCLRejectThreshold +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. + +A valid value is an integer from 0 through 9. This value should be less than the SCLDeleteThreshold value, but greater than the SCLQuarantineThreshold value. + +```yaml +Type: Int32 +Parameter Sets: Identity +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 +``` + +### -SecondaryAddress +This parameter is available only in on-premises Exchange. + +The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryDialPlan +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. + +```yaml +Type: UMDialPlanIdParameter +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharingPolicy +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 +- Distinguished name (DN) +- GUID + +Use the Get-SharingPolicy cmdlet to see the available sharing policies. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleItemRecoveryEnabled +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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDualWrite +This parameter is available only in on-premises Exchange + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDateForRetentionHold +The StartDateForRetentionHold parameter specifies the start date for the retention hold that's placed on the mailbox. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +To use this parameter, you need to set the RetentionHoldEnabled parameter to value $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StsRefreshTokensValidFrom +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemMessageSizeShutoffQuota +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int64 +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemMessageSizeWarningQuota +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int64 +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottlingPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies. + +```yaml +Type: ThrottlingPolicyIdParameter +Parameter Sets: Identity +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 +``` + +### -Type +The Type parameter specifies the mailbox type for the mailbox. Valid values are: + +- Equipment +- Regular +- Room +- Shared +- Workspace (cloud-only) +- Desk (cloud-only): This value doesn't result in a desk that's available for booking. Instead, create the desk in Places PowerShell using the [New-Place](https://learn.microsoft.com/microsoft-365/places/powershell/new-place) cmdlet, and then link the desk to this mailbox using the [Set-PlaceV3](/microsoft-365/places/powershell/set-placev3) cmdlet. + +```yaml +Type: ConvertibleMailboxSubType +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 +``` + +### -UMDataStorage +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. + +Valid values are $true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -UMDtmfMap +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: + +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` + +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. + +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. + +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. + +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. + +```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: False +Accept wildcard characters: False +``` + +### -UMGrammar +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. + +Valid values are $true or $false. + +```yaml +Type: Boolean +Parameter Sets: Identity +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 +``` + +### -UpdateEnforcedTimestamp +This parameter is available only in the cloud-based service. + +{{ Fill UpdateEnforcedTimestamp Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDatabaseQuotaDefaults +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. +- $false: The mailbox uses its own values for the applicable quotas. Any corresponding quotas that are configured on the mailbox database are ignored. In Exchange Online, this is the default value. + +The following quotas are affected by this parameter: + +- CalendarLoggingQuota +- IssueWarningQuota +- ProhibitSendQuota +- ProhibitSendReceiveQuota +- RecoverableItemsQuota +- RecoverableItemsWarningQuota + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDatabaseRetentionDefaults +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. +- $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: + +- 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: + +- 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`. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCertificate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +Parameter Sets: Identity +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 +``` + +### -UserSMimeCertificate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md rename to exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md index cafa9cac74..bf087d92fa 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxAuditBypassAssociation schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxAuditBypassAssociation @@ -13,13 +16,16 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxAuditBypassAssociation cmdlet to configure mailbox audit logging bypass for user or computer accounts such as service accounts for applications that access mailboxes frequently. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxAuditBypassAssociation [-Identity] - -AuditBypassEnabled <$true | $false> [-Confirm] [-DomainController ] [-WhatIf] [] +Set-MailboxAuditBypassAssociation [-Identity] -AuditBypassEnabled + [-Confirm] + [-DomainController ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -27,19 +33,19 @@ When you configure a user or computer account to bypass mailbox audit logging, a If you use mailbox audit logging to audit mailbox access and actions, you must monitor mailbox audit bypass associations at regular intervals. If a mailbox audit bypass association is added for an account, the account can access any mailbox in the organization to which it has been assigned access permissions, without any mailbox audit logging entries being generated for such access, or any actions taken such as message deletions. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" -AuditBypassEnabled $true ``` This example bypasses the Svc-MyApplication account from mailbox audit logging. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" -AuditBypassEnabled $false ``` @@ -47,52 +53,53 @@ This example removes the bypass association for the Svc-MyApplication account. ## PARAMETERS -### -AuditBypassEnabled -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 - -- $false: Disables mailbox audit logging bypass +### -Identity +The Identity parameter specifies a user or computer account to be bypassed from mailbox audit logging. ```yaml -Type: $true | $false +Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies a user or computer account to be bypassed from mailbox audit logging. +### -AuditBypassEnabled +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 +- $false: Disables mailbox audit logging bypass ```yaml -Type: MailboxAuditBypassAssociationIdParameter +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -110,6 +117,7 @@ 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 @@ -124,7 +132,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -133,20 +142,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/c925a5ef-ed07-4c31-b074-7ac04aa709f6.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md rename to exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md index f7352c2650..24d0f4377e 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md @@ -1,9 +1,13 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxAutoReplyConfiguration schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +search.appverid: MET150 +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxAutoReplyConfiguration @@ -13,86 +17,75 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxAutoReplyConfiguration cmdlet to configure Automatic Replies settings for a specific mailbox. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxAutoReplyConfiguration [-Identity] - [-AutoDeclineFutureRequestsWhenOOF <$true | $false>] - [-AutoReplyState ] + [-AutoDeclineFutureRequestsWhenOOF ] + [-AutoReplyState ] [-Confirm] - [-CreateOOFEvent <$true | $false>] - [-DeclineAllEventsForScheduledOOF <$true | $false>] - [-DeclineEventsForScheduledOOF <$true | $false>] + [-CreateOOFEvent ] + [-DeclineAllEventsForScheduledOOF ] + [-DeclineEventsForScheduledOOF ] [-DeclineMeetingMessage ] [-DomainController ] [-EndTime ] [-EventsToDeleteIDs ] - [-ExternalAudience ] + [-ExternalAudience ] [-ExternalMessage ] [-IgnoreDefaultScope] [-InternalMessage ] [-OOFEventSubject ] [-StartTime ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxAutoReplyConfiguration -Identity tony -AutoReplyState Scheduled -StartTime "7/10/2018 08:00:00" -EndTime "7/15/2018 17:00:00" -InternalMessage "Internal auto-reply message" +### Example 1 +```powershell +Set-MailboxAutoReplyConfiguration -Identity tony@contoso.com -AutoReplyState Scheduled -StartTime "7/10/2018 08:00:00" -EndTime "7/15/2018 17:00:00" -InternalMessage "Internal auto-reply message" ``` -This example configures Automatic Replies for Tony's mailbox to be sent between the specified start and end dates and includes an internal message. +This example configures Automatic Replies for Tony's mailbox to be sent between the specified start and end dates and includes an internal reply. -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxAutoReplyConfiguration -Identity tony -AutoReplyState Enabled -InternalMessage "Internal auto-reply message." -ExternalMessage "External auto-reply message." +### Example 2 +```powershell +Set-MailboxAutoReplyConfiguration -Identity tony@contoso.com -AutoReplyState Enabled -InternalMessage "Internal auto-reply message." -ExternalMessage "External auto-reply message." -ExternalAudience All ``` -This example configures Automatic Replies for Tony's mailbox to be sent and includes an internal and an external message. +This example configures Automatic Replies for Tony's mailbox to be sent, specifies the reply for messages from internal and external senders, and specifies the external reply is sent to any external address. ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True Position: 1 Default value: None @@ -101,21 +94,21 @@ Accept wildcard characters: False ``` ### -AutoDeclineFutureRequestsWhenOOF -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The AutoDeclineFutureRequestsWhenOOF parameter specifies whether to automatically decline new meeting requests that are sent to the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: - $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. You can use this parameter only when the AutoReplyState parameter is set to Scheduled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -127,22 +120,20 @@ Accept wildcard characters: False 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. - - 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: - A value for the InternalMessageValue parameter. - - A value for the ExternalMessageValue parameter if the ExternalAudience parameter is set to Known or All. ```yaml -Type: Disabled | Enabled | Scheduled +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 Default value: None @@ -153,15 +144,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -170,19 +161,19 @@ Accept wildcard characters: False ``` ### -CreateOOFEvent -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The CreateOOFEvent parameter specifies whether to create a calendar event that corresponds to the scheduled time period when Automatic Replies are being sent for the mailbox. Valid values are: - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -191,12 +182,11 @@ Accept wildcard characters: False ``` ### -DeclineAllEventsForScheduledOOF -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The DeclineAllEventsForScheduledOOF parameter specifies whether to decline all existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: -- $true: Existing calendar events in the mailbox that occur during the scheduled time period are declined and removed from the calendar. - +- $true: Existing calendar events in the mailbox that occur during the scheduled time period are declined and removed from the calendar. If the mailbox is the meeting organizer, the events are cancelled for all other attendees. - $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This is the default value. You can use this parameter only when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -204,10 +194,11 @@ You can use this parameter only when the DeclineEventsForScheduledOOF parameter You can't use this parameter with the EventsToDeleteIDs parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -216,21 +207,24 @@ Accept wildcard characters: False ``` ### -DeclineEventsForScheduledOOF -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The DeclineEventsForScheduledOOF parameter specifies whether it's possible to decline existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: -- $true: Existing calendar events in the mailbox that occur during the scheduled time period can be declined and removed from the calendar. To decline specific events during the scheduled time period, use the EventsToDeleteIDs parameter. To decline all events during the scheduled time period, use the DeclineAllEventsForScheduledOOF parameter. +- $true: Existing calendar events in the mailbox that occur during the scheduled time period can be declined and removed from the calendar. If the mailbox is the meeting organizer, the events are cancelled for all other attendees. + + To decline specific events during the scheduled time period, use the EventsToDeleteIDs parameter. To decline all events during the scheduled time period, use the DeclineAllEventsForScheduledOOF parameter. - $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This is the default value. You can use this parameter only when the AutoReplyState parameter is set to Scheduled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -239,15 +233,14 @@ Accept wildcard characters: False ``` ### -DeclineMeetingMessage -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The DeclineMeetingMessage parameter specifies the text in the message when meetings requests that are sent to the mailbox are automatically declined. For example: - The AutoDeclineFutureRequestsWhenOOF parameter is set to $true. - - The DeclineEventsForScheduledOOF parameter is set to $true, and the DeclineAllEventsForScheduledOOF parameter is set to $true, or individual events are specified by using the EventsToDeleteIDs parameter. -If the value contains spaces, enclose the value in quotation marks ("). HTML tags aren't automatically added to the text, but you can use values that contain HTML tags. For example, "\\I'm on vacation.\I can't attend the meeting.\\". +If the value contains spaces, enclose the value in quotation marks ("). HTML tags aren't automatically added to the text, but you can use values that contain HTML tags. For example, `"I'm on vacation. I can't attend the meeting."`. To clear the value of this parameter, use the value $null. @@ -255,7 +248,8 @@ To clear the value of this parameter, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -273,6 +267,7 @@ 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 @@ -283,13 +278,14 @@ Accept wildcard characters: False ### -EndTime The EndTime parameter specifies the end date and time that Automatic Replies are sent for the mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime 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 @@ -298,7 +294,7 @@ Accept wildcard characters: False ``` ### -EventsToDeleteIDs -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The EventsToDeleteIDs parameter specifies the calendar events to delete from the mailbox when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -310,7 +306,8 @@ You can't use this parameter with the DeclineAllEventsForScheduledOOF parameter. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -322,18 +319,17 @@ Accept wildcard characters: False 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. The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled. ```yaml -Type: None | Known | All +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 Default value: None @@ -344,12 +340,11 @@ Accept wildcard characters: False ### -ExternalMessage 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.\\". +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."`. The value of this parameter is meaningful only when both of the following conditions are true: - The AutoReplyState parameter is set to Enabled or Scheduled. - - The ExternalAudience parameter is set to Known or All. To clear the value of this parameter when it's no longer required (for example, if you change the ExternalAudience parameter to None), use the value $null. @@ -359,6 +354,7 @@ 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 Default value: None @@ -367,12 +363,11 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml @@ -380,6 +375,7 @@ 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 @@ -390,7 +386,7 @@ Accept wildcard characters: False ### -InternalMessage 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.\\". +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."`. The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled. @@ -401,6 +397,7 @@ 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 Default value: None @@ -409,7 +406,7 @@ Accept wildcard characters: False ``` ### -OOFEventSubject -This parameter is available only in the cloud-based service. +This parameter is functional only in the cloud-based service. The OOFEventSubject parameter specifies the subject for the calendar event that's automatically created when the CreateOOFEvent parameter is set to $true. @@ -419,7 +416,8 @@ If the value contains spaces, enclose the value in quotation marks ("). To clear Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -430,13 +428,14 @@ Accept wildcard characters: False ### -StartTime The StartTime parameter specifies the start date and time that Automatic Replies are sent for the specified mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime 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 @@ -451,7 +450,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -460,20 +460,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/fda7b1fe-7f08-4711-aa91-9c270f62a8aa.aspx) diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md new file mode 100644 index 0000000000..78d43a57d3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -0,0 +1,1281 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxCalendarConfiguration cmdlet to modify mailbox calendar settings for Outlook on the web. This affects how the user's calendar looks and how reminders work in Outlook on the web. This also affects settings that define how meeting invitations, responses, and notifications are sent to the user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Set-MailboxCalendarConfiguration [-Identity] + [-AgendaMailEnabled ] + [-Confirm] + [-ConversationalSchedulingEnabled ] + [-DailyAgendaMailSchedule ] + [-DefaultMeetingDuration ] + [-DefaultReminderTime ] + [-DomainController ] + [-FirstWeekOfYear ] + [-RemindersEnabled ] + [-ReminderSoundEnabled ] + [-ShowWeekNumbers ] + [-SkipAgendaMailOnFreeDays ] + [-TimeIncrement ] + [-UseBrightCalendarColorThemeInOwa ] + [-WeekStartDay ] + [-WhatIf] + [-WorkDays ] + [-WorkingHoursEndTime ] + [-WorkingHoursStartTime ] + [-WorkingHoursTimeZone ] + [] +``` + +### Identity +``` +Set-MailboxCalendarConfiguration [-Identity] + [-AgendaMailEnabled ] + [-AgendaMailIntroductionEnabled ] + [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] + [-CalendarFeedsPreferredLanguage ] + [-CalendarFeedsPreferredRegion ] + [-CalendarFeedsRootPageId ] + [-Confirm] + [-ConversationalSchedulingEnabled ] + [-CreateEventsFromEmailAsPrivate ] + [-DailyAgendaMailSchedule ] + [-DefaultMeetingDuration ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] + [-DefaultOnlineMeetingProvider ] + [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] + [-DiningEventsFromEmailEnabled ] + [-EntertainmentEventsFromEmailEnabled ] + [-EventsFromEmailEnabled ] + [-FirstWeekOfYear ] + [-FlightEventsFromEmailEnabled ] + [-HotelEventsFromEmailEnabled ] + [-InvoiceEventsFromEmailEnabled ] + [-LocationDetailsInFreeBusy ] + [-OnlineMeetingsByDefaultEnabled ] + [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] + [-RemindersEnabled ] + [-ReminderSoundEnabled ] + [-RentalCarEventsFromEmailEnabled ] + [-ServiceAppointmentEventsFromEmailEnabled ] + [-ShortenEventScopeDefault ] + [-ShowWeekNumbers ] + [-SkipAgendaMailOnFreeDays ] + [-TimeIncrement ] + [-UseBrightCalendarColorThemeInOwa ] + [-WeatherEnabled ] + [-WeatherLocationBookmark ] + [-WeatherLocations ] + [-WeatherUnit ] + [-WeekStartDay ] + [-WhatIf] + [-WorkDays ] + [-WorkingHoursEndTime ] + [-WorkingHoursStartTime ] + [-WorkingHoursTimeZone ] + [-WorkspaceUserEnabled ] + [] +``` + +### MailboxLocation +``` +Set-MailboxCalendarConfiguration [-MailboxLocation ] + [-AgendaMailEnabled ] + [-AgendaMailIntroductionEnabled ] + [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] + [-CalendarFeedsPreferredLanguage ] + [-CalendarFeedsPreferredRegion ] + [-CalendarFeedsRootPageId ] + [-Confirm] + [-ConversationalSchedulingEnabled ] + [-CreateEventsFromEmailAsPrivate ] + [-DailyAgendaMailSchedule ] + [-DefaultMeetingDuration ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] + [-DefaultOnlineMeetingProvider ] + [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] + [-DiningEventsFromEmailEnabled ] + [-EntertainmentEventsFromEmailEnabled ] + [-EventsFromEmailEnabled ] + [-FirstWeekOfYear ] + [-FlightEventsFromEmailEnabled ] + [-HotelEventsFromEmailEnabled ] + [-InvoiceEventsFromEmailEnabled ] + [-LocationDetailsInFreeBusy ] + [-OnlineMeetingsByDefaultEnabled ] + [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] + [-RemindersEnabled ] + [-ReminderSoundEnabled ] + [-RentalCarEventsFromEmailEnabled ] + [-ServiceAppointmentEventsFromEmailEnabled ] + [-ShortenEventScopeDefault ] + [-ShowWeekNumbers ] + [-SkipAgendaMailOnFreeDays ] + [-TimeIncrement ] + [-UseBrightCalendarColorThemeInOwa ] + [-WeatherEnabled ] + [-WeatherLocationBookmark ] + [-WeatherLocations ] + [-WeatherUnit ] + [-WeekStartDay ] + [-WhatIf] + [-WorkDays ] + [-WorkingHoursEndTime ] + [-WorkingHoursStartTime ] + [-WorkingHoursTimeZone ] + [-WorkspaceUserEnabled ] + [] +``` + +## DESCRIPTION +The Set-MailboxCalendarConfiguration cmdlet primarily allows users to manage their own calendar settings in Outlook on the web Options. However, administrators who are members of the Organization Management or Recipient Management role groups can configure the calendar settings for users by using this cmdlet. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxCalendarConfiguration -Identity peter@contoso.com -RemindersEnabled $false +``` + +This example disables the calendar reminders for the calendar of the user peter@contoso.com. + +### Example 2 +```powershell +Set-MailboxCalendarConfiguration -Identity peter@contoso.com -WorkingHoursTimeZone "Pacific Standard Time" +``` + +This example sets the time zone of the work hours' start and end times to Pacific Standard Time for the calendar of the user peter@contoso.com. + +### Example 3 +```powershell +Set-MailboxCalendarConfiguration -Identity Tony -WorkingHoursStartTime 07:00:00 +``` + +This example sets the working day's starting hour to 7 A.M. for the calendar of the user Tony. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AgendaMailEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgendaMailIntroductionEnabled +This parameter is available only in the cloud-based service. + +{{ Fill AgendaMailIntroductionEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgendaPaneEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDeclineWhenBusy +This parameter is available only in the cloud-based service. + +{{ Fill AutoDeclineWhenBusy Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarFeedsPreferredLanguage +This parameter is available only in the cloud-based service. + +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). + +```yaml +Type: String +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarFeedsPreferredRegion +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). + +A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). + +```yaml +Type: String +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarFeedsRootPageId +This parameter is available only in the cloud-based service. + +The CalendarFeedsRootPageId parameter specifies the root page ID for calendar feeds. + +```yaml +Type: String +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConversationalSchedulingEnabled +The ConversationalSchedulingEnabled parameter specifies whether to enable or disable conversational scheduling. Valid values are: + +- $true: Conversational scheduling is enabled. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateEventsFromEmailAsPrivate +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. +- $false: Events from email are created as Normal (public). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DailyAgendaMailSchedule +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMeetingDuration +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMinutesToReduceLongEventsBy +This parameter is available only in the cloud-based service. + +{{ Fill DefaultMinutesToReduceLongEventsBy Description }} + +```yaml +Type: Int32 +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMinutesToReduceShortEventsBy +This parameter is available only in the cloud-based service. + +{{ Fill DefaultMinutesToReduceShortEventsBy Description }} + +```yaml +Type: Int32 +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOnlineMeetingProvider +This parameter is available only in the cloud-based service. + +The DefaultOnlineMeetingProvider parameter specifies the default provider for online meetings. Valid values are: + +- AlibabaDingTalk +- AmazonChimePrivate +- AmazonChimePublic +- AppleFacetime +- BlueJeans +- ClaroVideoconferencia +- FacebookWorkplace +- GoogleMeet +- GoToMeeting +- JioMeet +- RingCentral +- SkypeForBusiness +- SkypeForConsumer +- TeamsForBusiness (This is the default value.) +- Webex +- Zoom + +```yaml +Type: OnlineMeetingProviderType +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultReminderTime +The DefaultReminderTime parameter specifies the length of time before a meeting or appointment 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: + +- 00:00:00 +- 00:05:00 (5 minutes) +- 00:10:00 (10 minutes) +- 00:15:00 (15 minutes) This is the default value. +- 00:30:00 (30 minutes) +- 01:00:00 (1 hour) +- 02:00:00 (2 hours) +- 03:00:00 (3 hours) +- 04:00:00 (4 hours) +- 08:00:00 (8 hours) +- 12:00:00 (12 hours) +- 1.00:00:00 (1 day) +- 2.00:00:00 (2 days) +- 3.00:00:00 (3 days) +- 7.00:00:00 (7 days) +- 14.00:00:00 (14 days) + +This parameter is ignored when the RemindersEnabled parameter is set to $false. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteMeetingRequestOnRespond +This parameter is available only in the cloud-based service. + +{{ Fill DeleteMeetingRequestOnRespond Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiningEventsFromEmailEnabled +This parameter is available only in the cloud-based service. + +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Default +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 +``` + +### -EntertainmentEventsFromEmailEnabled +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsFromEmailEnabled +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. +- $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: + +- DiningEventsFromEmailEnabled +- EntertainmentEventsFromEmailEnabled +- FlightEventsFromEmailEnabled +- HotelEventsFromEmailEnabled +- PackageDeliveryEventsFromEmailEnabled +- RentalCarEventsFromEmailEnabled + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstWeekOfYear +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. +- 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. + +You configure the first day of the week by using the WeekStartDay parameter. + +```yaml +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 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + +### -FlightEventsFromEmailEnabled +This parameter is available only in the cloud-based service. + +The FlightEventsFromEmailEnabled parameter specifies whether to create flight reservation events from email messages. Valid values are: + +- $true: Create flight reservation events from email messages. This is the default value. +- $false: Don't create flight reservation events from email messages. + +This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotelEventsFromEmailEnabled +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvoiceEventsFromEmailEnabled +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. +- $false: Creating invoices from messages is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationDetailsInFreeBusy +This parameter is available only in the cloud-based service. + +The LocationDetailsInFreeBusy parameter specifies the level of work location information that's returned as part of a user's availability. Work location information is visible across several Microsoft 365 application experiences, and the level of location information that's shown to other users in the organization is controlled by this parameter. Valid values are: + +- None: No location information is returned. +- Building: Only Office or Remote are returned as work location information, if provided. +- Desk: All work location information is returned, including Building and Desk, if provided. This is the default value. + +```yaml +Type: LocationDetailsPermissionInFreeBusy +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: Desk +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlineMeetingsByDefaultEnabled +This parameter is available only in the cloud-based service. + +The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Currently, this parameter sets the default value, so if the user has already directly interacted with this setting from an Outlook client, this default value will be ignored. Eventually, this parameter will override the Outlook-configured setting. + +Valid values are: + +- $true: All meetings are online by default. +- $false: All meetings are not online by default. +- $null: The value of the OnlineMeetingsByDefaultEnabled parameter on the Set-OrganizationConfig cmdlet (the organizational setting) is used. + +Setting this parameter enables the display of the **Add online meeting to all meetings** option in **Calendar options** in Outlook for Windows. This setting allows users to enable or disable the option when Teams is used for online meetings. It does not override the organization setting that's configured by the OnlineMeetingsByDefaultEnabled parameter on the Set-OrganizationConfig cmdlet. + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageDeliveryEventsFromEmailEnabled +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. + +This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveDeclinedMeetings +This parameter is available only in the cloud-based service. + +{{ Fill PreserveDeclinedMeetings Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemindersEnabled +The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are: + +- $true: Reminders are enabled. This is the default value. +- $false: Reminders are disabled. + +When the reminder is first displayed is controlled by the DefaultReminderTime 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReminderSoundEnabled +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. +- $false: No sound is played with the reminder. + +This parameter is ignored when the RemindersEnabled parameter is set 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RentalCarEventsFromEmailEnabled +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceAppointmentEventsFromEmailEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ServiceAppointmentEventsFromEmailEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortenEventScopeDefault +This parameter is available only in the cloud-based service. + +{{ Fill ShortenEventScopeDefault Description }} + +```yaml +Type: ShortenEventScopeOption +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowWeekNumbers +The ShowWeekNumbers parameter specifies whether the week number is displayed in the Outlook on the web calendar. Valid values are: + +- $true: The week number is displayed. +- $false: The week number isn't displayed. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipAgendaMailOnFreeDays +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeIncrement +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) + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseBrightCalendarColorThemeInOwa +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeatherEnabled +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) +- Disabled: Hide weather on the calendar. +- Enabled: Show weather on the calendar. + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeatherLocationBookmark +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. + +A valid value for this parameter depends on the number of weather locations that are configured for the mailbox. For example, if there are 3 weather locations configured, you can specify the value 0, 1, or 2 for this parameter. + +```yaml +Type: Int32 +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeatherLocations +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. + +This parameter uses the syntax: `LocationId:;Name:;Latitude:;Longitude:`. For example, `LocationId:105808079;Name:Redmond, WA;Latitude:47.679;Longitude:-122.132`. + +To enter multiple values and overwrite any existing entries, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For this parameter, each Value is `LocationId:;Name:;Latitude:;Longitude:`. + +You can configure a maximum of 5 weather locations. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeatherUnit +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) +- Celsius +- Fahrenheit + +```yaml +Type: WeatherTemperatureUnit +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeekStartDay +The WeekStartDay parameter specifies the first day of the week. Valid values are: + +- Sunday (This is the default value) +- Monday +- Tuesday +- Wednesday +- Thursday +- Friday +- Saturday + +```yaml +Type: DayOfWeek +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkDays +The WorkDays parameter specifies the work days in the calendar. Valid values are: + +- None +- AllDays +- Weekdays (This is the default value) +- WeekEndDays +- Sunday +- Monday +- Tuesday +- Wednesday +- Thursday +- Friday +- Saturday + +You can specify multiple values separated by commas, but redundant values are ignored. For example, entering Weekdays,Monday results in the value Weekdays. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkingHoursEndTime +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. + +The default value is 17:00:00 (5:00 P.M.). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkingHoursStartTime +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. + +The default value is 08:00:00(8:00 A.M.). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkingHoursTimeZone +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"). + +To see the available values, run the following command: `$TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display`. + +If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceUserEnabled +This parameter is available only in the cloud-based service. + +{{ Fill WorkspaceUserEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md new file mode 100644 index 0000000000..7a30ee7341 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md @@ -0,0 +1,363 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxCalendarFolder cmdlet to configure calendar publishing or sharing settings on a mailbox for the visibility of calendar information to external users. To add or modify the permissions so internal users can access the calendar, use the Add-MailboxFolderPermission or Set-MailboxFolderPermission cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxCalendarFolder [-Identity] + [-Confirm] + [-DetailLevel ] + [-DomainController ] + [-PublishDateRangeFrom ] + [-PublishDateRangeTo ] + [-PublishEnabled ] + [-ResetUrl] + [-SearchableUrlEnabled ] + [-SetAsSharingSource] + [-SharedCalendarSyncStartDate ] + [-UseHttps] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-MailboxCalendarFolder cmdlet configures calendar publishing information. The calendar folder can be configured as follows: + +- Whether the calendar folder is enabled for publishing +- Range of start and end calendar days to publish +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxCalendarFolder -Identity kai:\Calendar -DetailLevel LimitedDetails +``` + +This example sets the level of details to publish for Kai's shared calendar to LimitedDetails, which means limited details are displayed. + +### Example 2 +```powershell +Set-MailboxCalendarFolder -Identity kai:\Calendar -SearchableUrlEnabled $true +``` + +This example enables the calendar in Kai's mailbox to be searchable on the web. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Calendar` + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailLevel +The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. Valid values are: + +- AvailabilityOnly (default) +- LimitedDetails +- FullDetails + +This parameter is meaningful only when the PublishEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishDateRangeFrom +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) +- SixMonths +- OneYear + +This parameter is meaningful only when the PublishEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishDateRangeTo +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) +- SixMonths +- OneYear + +This parameter is meaningful only when the PublishEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishEnabled +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. + +```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 +Accept pipeline input: False +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchableUrlEnabled +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. + +This parameter is meaningful only when the PublishEnabled parameter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetAsSharingSource +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedCalendarSyncStartDate +This parameter is available only in the cloud-based service. + +**Note**: This parameter is supported only for shared calendars that have been upgraded as described in [Calendar sharing in Microsoft 365](https://support.microsoft.com/office/365-b576ecc3-0945-4d75-85f1-5efafb8a37b4), and is not applicable to any other type of calendar or mailbox folder. + +The SharedCalendarSyncStartDate parameter specifies the limit for past events in the shared calendar that are visible to delegates. A copy of the shared calendar within the specified date range is stored in the delegate's mailbox. + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +**Notes**: + +- You use this parameter on the shared calendar in the delegate's mailbox. For example, `Set-MailboxCalendarFolder -Identity delegate@contoso.onmicrosoft.com:DelegateSharedCalendarFolderId" -SharedCalendarSyncStartDate (Get-Date "5/6/2023 9:30 AM").ToUniversalTime()`. DelegateSharedCalendarFolderId is the FolderId of the shared calendar in the delegate's mailbox (for example, `Get-MailboxFolderStatistics -Identity delegate@contoso.onmicrosoft.com -FolderScope Calendar | Format-List Name,FolderId`). +- Users need to have FullDetails, Editor, or Delegate access to the specified shared calendar. +- Setting this parameter might cause events in the shared calendar to briefly disappear from view while the calendar is resynchronized. +- The value of this parameter is used when initializing the calendar folder sync. After that, every new, updated, and deleted item is processed and synced, regardless of the SharedCalendarSyncStartDate parameter value. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseHttps +The UseHttps switch specifies whether to use HTTPS for the published URL of the calendar folder. You don't need to specify a value with this switch. + +This switch is meaningful only when the PublishEnabled parameter value is $true. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md new file mode 100644 index 0000000000..bf3cb3151f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md @@ -0,0 +1,961 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-MailboxDatabase + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-MailboxDatabase cmdlet to configure a variety of properties for a mailbox database. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxDatabase [-Identity] + [-AllowFileRestore ] + [-AutoDagExcludeFromMonitoring ] + [-AutoDatabaseMountDial ] + [-BackgroundDatabaseMaintenance ] + [-CalendarLoggingQuota ] + [-CircularLoggingEnabled ] + [-Confirm] + [-DatabaseGroup ] + [-DataMoveReplicationConstraint ] + [-DeletedItemRetention ] + [-DomainController ] + [-EventHistoryRetentionPeriod ] + [-IndexEnabled ] + [-IsExcludedFromInitialProvisioning ] + [-IsExcludedFromProvisioning ] + [-IsExcludedFromProvisioningByOperator ] + [-IsExcludedFromProvisioningDueToLogicalCorruption ] + [-IsExcludedFromProvisioningReason ] + [-IssueWarningQuota ] + [-IsSuspendedFromProvisioning ] + [-JournalRecipient ] + [-MailboxRetention ] + [-MaintenanceSchedule ] + [-MetaCacheDatabaseMaxCapacityInBytes ] + [-MountAtStartup ] + [-Name ] + [-OfflineAddressBook ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-PublicFolderDatabase ] + [-QuotaNotificationSchedule ] + [-RecoverableItemsQuota ] + [-RecoverableItemsWarningQuota ] + [-RetainDeletedItemsUntilBackup ] + [-RpcClientAccessServer ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxDatabase "Mailbox Database01" -DeletedItemRetention 7.00:00:00 +``` + +This example sets the length of time that deleted items are retained. If a specific mailbox has its own item retention set, that value is used instead of this value, which is set on the mailbox database. + +### Example 2 +```powershell +Set-MailboxDatabase -RpcClientAccessServer +``` + +In Exchange Server 2010, this example updates a mailbox database so that all client connections for mailboxes on the database come through the Client Access server or Client Access server array. You can also use this command to change the Client Access server or Client Access server array through which the client is connecting to the Mailbox server. + +For more information about RPC access through Client Access servers, see [Set-RpcClientAccess](https://learn.microsoft.com/powershell/module/exchange/set-rpcclientaccess) and [Set-ClientAccessArray](https://learn.microsoft.com/powershell/module/exchange/set-clientaccessarray). + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllowFileRestore +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. + +```yaml +Type: Boolean +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 +``` + +### -AutoDagExcludeFromMonitoring +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDatabaseMountDial +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackgroundDatabaseMaintenance +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarLoggingQuota +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). + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The value of this parameter must be less than or equal to the value of the RecoverableItemsQuota parameter. + +This setting applies to all mailboxes in the database that don't have their own calendar logging quota configured. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CircularLoggingEnabled +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. + +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). + +```yaml +Type: Boolean +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 +``` + +### -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 +``` + +### -DatabaseGroup +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataMoveReplicationConstraint +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). +- AllCopies (Exchange 2013 or earlier): If the database is replicated, all passive mailbox database copies must have the most recent changes synchronized. +- AllDatacenters (Exchange 2013 or earlier): If the database is replicated to multiple Active Directory sites, at least one passive mailbox database copy in each site must have the most recent changes replicated. +- 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. +- 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). + +```yaml +Type: DataMoveReplicationConstraintParameter +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 +``` + +### -DeletedItemRetention +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. + +Valid values are 00:00:00 to 24855.03:14:07. The default value is 14.00:00:00 (14 days). + +This setting applies to all mailboxes in the database that don't have their own deleted item retention 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). + +```yaml +Type: EnhancedTimeSpan +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 +``` + +### -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 +``` + +### -EventHistoryRetentionPeriod +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. + +Valid values are 00:00:01 to 30.00:00:00. The default value is 7.00:00:00 (7 days). + +```yaml +Type: EnhancedTimeSpan +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 +``` + +### -IndexEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromInitialProvisioning +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromProvisioning +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. + +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. + +```yaml +Type: Boolean +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 +``` + +### -IsExcludedFromProvisioningByOperator +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. + +Note that 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromProvisioningDueToLogicalCorruption +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. + +Note that 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. +- The IsExcludedFromProvisioning property is automatically set to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromProvisioningReason +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: + +- IsExcludedFromProvisioning +- IsExcludedFromProvisioningByOperator +- IsSuspendedFromProvisioning + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueWarningQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. + +This setting applies to all mailboxes in the database that don't have their own warning quota configured. The default value is 1.899 gigabytes (2,039,480,320 bytes). + +```yaml +Type: Unlimited +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 +``` + +### -IsSuspendedFromProvisioning +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. + +Note that 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. + +```yaml +Type: Boolean +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 +``` + +### -JournalRecipient +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +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 +``` + +### -MailboxRetention +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. + +Valid values are 00:00:00 to 24855.03:14:07. The default value is 30.00:00:00 (30 days). + +```yaml +Type: EnhancedTimeSpan +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 +``` + +### -MaintenanceSchedule +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 syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" + +```yaml +Type: Schedule +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 +``` + +### -MetaCacheDatabaseMaxCapacityInBytes +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). + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MountAtStartup +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineAddressBook +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 +- Distinguished name (DN) +- GUID + +By default, this setting is blank ($null). + +```yaml +Type: OfflineAddressBookIdParameter +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 +``` + +### -ProhibitSendQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The ProhibitSendQuota value must be less than or equal to the ProhibitSendReceiveQuota value. + +This settings applies to all mailboxes in the database that don't have their own prohibit send quota configured. The default value is 2 gigabytes (2147483648 bytes). + +```yaml +Type: Unlimited +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 +``` + +### -ProhibitSendReceiveQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. + +This setting applies to all mailboxes in the database that don't have their own prohibit send receive quota configured. The default value is 2.99804 gigabytes (2469396480 bytes) + +```yaml +Type: Unlimited +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 +``` + +### -PublicFolderDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +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 +``` + +### -QuotaNotificationSchedule +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. + +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" + +```yaml +Type: Schedule +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 +``` + +### -RecoverableItemsQuota +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). + +When you enter a number, you can qualify it with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. + +This settings applies to all mailboxes in the database that don't have their own Recoverable Items quota configured. + +```yaml +Type: Unlimited +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 +``` + +### -RecoverableItemsWarningQuota +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). + +When you enter a number, you can qualify it with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. + +This settings applies to all mailboxes in the database that don't have their own Recoverable Items warning quota configured. + +```yaml +Type: Unlimited +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 +``` + +### -RetainDeletedItemsUntilBackup +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. + +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: + +- 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`. + +```yaml +Type: Boolean +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 +``` + +### -RpcClientAccessServer +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)). + +```yaml +Type: ClientAccessServerOrArrayIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/database-availability-groups/Set-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md similarity index 83% rename from exchange/exchange-ps/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md rename to exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md index 15546782d4..7a63396766 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxDatabaseCopy @@ -13,30 +16,39 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxDatabaseCopy cmdlet to configure the properties of a database copy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxDatabaseCopy [-Identity] [-ActivationPreference ] [-Confirm] [-DatabaseCopyAutoActivationPolicy ] [-DomainController ] [-ReplayLagMaxDelay ] [-ReplayLagTime ] [-TruncationLagTime ] [-WhatIf] [] +Set-MailboxDatabaseCopy [-Identity] + [-ActivationPreference ] + [-Confirm] + [-DatabaseCopyAutoActivationPolicy ] + [-DomainController ] + [-ReplayLagMaxDelay ] + [-ReplayLagTime ] + [-TruncationLagTime ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MailboxDatabaseCopy -Identity DB2\MBX1 -ReplayLagTime 3.0:0:0 ``` This example configures the replay lag time with a value of 3 days for a copy of the database DB2 hosted on the Mailbox server MBX1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-MailboxDatabaseCopy -Identity DB1\MBX2 -ActivationPreference 3 ``` @@ -52,6 +64,7 @@ Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -67,6 +80,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -77,8 +91,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -86,6 +99,7 @@ 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 @@ -101,6 +115,7 @@ 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 @@ -122,6 +137,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,6 +157,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -156,6 +173,7 @@ 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 @@ -167,10 +185,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: Unrestricted | IntrasiteOnly | Blocked +Type: DatabaseCopyAutoActivationPolicyType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -192,6 +211,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -200,20 +220,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/839f8781-2eb1-47bd-85ff-a31c8773998a.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/mailboxes/Set-MailboxExportRequest.md rename to exchange/exchange-ps/exchange/Set-MailboxExportRequest.md index 6d16d53c12..400403f687 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxExportRequest @@ -13,19 +16,21 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxExportRequest cmdlet to change export request options after the request has been created. You can use the Set-MailboxExportRequest cmdlet to recover from failed export requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Rehome ``` -Set-MailboxExportRequest [-Identity] [-RehomeRequest] +Set-MailboxExportRequest [-Identity] + [-RehomeRequest] [-Confirm] [-DomainController ] - [-RequestExpiryInterval ] - [-WhatIf] [] + [-RequestExpiryInterval ] + [-WhatIf] + [] ``` ### Identity @@ -39,23 +44,24 @@ Set-MailboxExportRequest [-Identity] [-DomainController ] [-InternalFlags ] [-LargeItemLimit ] - [-Priority ] + [-Priority ] [-RemoteCredential ] [-RemoteHostName ] [-RequestExpiryInterval ] [-SkipMerging ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MailboxExportRequest -Identity "Ayla\MailboxExport1\" -BadItemLimit 10 ``` @@ -64,13 +70,14 @@ This example changes the second export request Ayla\\MailboxExport1 to accept up ## PARAMETERS ### -Identity -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: \\\\. +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 Default value: None @@ -79,13 +86,18 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. +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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -98,13 +110,14 @@ The BadItemLimit parameter specifies the maximum number of bad items that are al 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. -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. +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. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -120,6 +133,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -130,8 +144,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -139,6 +152,7 @@ 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 @@ -154,6 +168,7 @@ Type: Unlimited Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -169,6 +184,7 @@ 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 @@ -184,6 +200,7 @@ Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -196,9 +213,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) +- 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. @@ -209,6 +225,7 @@ Type: Unlimited Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -220,26 +237,20 @@ Accept wildcard characters: False 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. - - High - - Higher - - Highest - - Emergency ```yaml -Type: Normal | High +Type: RequestPriority Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -248,13 +259,16 @@ Accept wildcard characters: False ``` ### -RehomeRequest -The RehomeRequest parameter specifies to the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox that's being exported. This parameter is used primarily for debugging purposes. +The RehomeRequest switch tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox that's being exported. You don't need to specify a value with this switch. + +This switch is used primarily for debugging purposes. ```yaml Type: SwitchParameter Parameter Sets: Rehome Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -270,6 +284,7 @@ Type: PSCredential Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -285,6 +300,7 @@ Type: Fqdn Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -300,6 +316,7 @@ Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -311,7 +328,6 @@ Accept wildcard characters: False 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. - - If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -323,6 +339,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -338,6 +355,7 @@ 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 @@ -346,20 +364,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5a064940-f8c1-4ee7-822a-a6cfe483081e.aspx) diff --git a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md new file mode 100644 index 0000000000..52df63f5f3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md @@ -0,0 +1,323 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxFolderPermission cmdlet to modify folder-level permissions for users in mailboxes. This cmdlet differs from the Add-MailboxFolderPermission cmdlet in that it modifies existing permission entries. To configure calendar publishing or sharing settings for a mailbox so calendar information is visible to external users, use the Set-MailboxCalendarFolder cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxFolderPermission [-Identity] -AccessRights -User + [-Confirm] + [-DomainController ] + [-SendNotificationToUser ] + [-SharingPermissionFlags ] + [-WhatIf] + [] +``` + +## DESCRIPTION +In Exchange Online PowerShell, if you don't use the SendNotificationToUser or SharingPermissionFlags parameters, there are no changes to the functionality of the cmdlet. For example, if the user is an existing delegate, and you change their permissions to Editor without using the SendNotificationToUser or SharingPermissionFlags parameters, the user remains a delegate. But, if you use the SendNotificationToUser parameter ($true or $false), the SharingPermissionFlags parameter has the default value None, which can affect delegate access for existing users. For example, you change an existing delegate's permission to Editor, and you use SendNotificationToUser with the value $true. The user will no longer be a delegate and will only have Editor permissions to the folder. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxFolderPermission -Identity ayla@contoso.com:\Marketing -User ed@contoso.com -AccessRights Owner +``` + +This example overwrites Ed's existing permissions for the Marketing folder in Ayla's mailbox. Ed is now granted the Owner role on the folder. + +### Example 2 +```powershell +Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate -SendNotificationToUser $true +``` + +In Exchange Online, this example resends the sharing invitation to an existing delegate without changing their effective permissions (Ed is already a delegate with Editor permissions to Ayla's mailbox). + +### Example 3 +```powershell +Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate +``` + +In Exchange Online, this example removes access to private items for an existing delegate. + +### Example 4 +```powershell +Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SharingPermissionFlags None +``` + +In Exchange Online, this example changes an existing calendar delegate to Editor. + +### Example 5 +```powershell +Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor +``` + +In Exchange Online, this example changes an existing user's permissions to Editor without changing their current delegate status. + +### Example 6 +```powershell +Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SendNotificationToUser $false +``` + +In Exchange Online, this example changes an existing user's permissions to Editor and removes their current delegate status. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inbox\Reports`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccessRights +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. + +The following individual permissions are available: + +- None: The user has no access to view or interact with the folder or its contents. +- CreateItems: The user can create items in the specified folder. +- CreateSubfolders: The user can create subfolders in the specified folder. +- DeleteAllItems: The user can delete all items in the specified folder. +- DeleteOwnedItems: The user can only delete items that they created from the specified folder. +- EditAllItems: The user can edit all items in the specified folder. +- EditOwnedItems: The user can only edit items that they created in the specified folder. +- FolderContact: The user is the contact for the specified public folder. +- FolderOwner: The user is the owner of the specified folder. The user can view the folder, move the folder, and create subfolders. The user can't read items, edit items, delete items, or create items. +- FolderVisible: The user can view the specified folder, but can't read or edit items within the specified public folder. +- ReadItems: The user can read items within the specified folder. + +The roles that are available, along with the permissions that they assign, are described in the following list: + +- Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- Contributor: CreateItems, FolderVisible +- Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- NonEditingAuthor: CreateItems, DeleteOwnedItems, FolderVisible, ReadItems +- Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems +- PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems +- PublishingEditor: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems +- Reviewer: FolderVisible, ReadItems + +The following roles apply specifically to calendar folders: + +- AvailabilityOnly: View only availability data +- LimitedDetails: View availability data with subject and location + +When the Editor role is applied to calendar folders, delegates can accept or decline meetings by manually selecting the meeting request in the mailbox. In Exchange Online, to send meeting requests to delegates where they can accept or decline meetings, also use the SharingPermissionFlags parameter with the value Delegate. + +```yaml +Type: MailboxFolderAccessRight[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailboxFolderUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendNotificationToUser +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: + +- $true: A sharing invitation is sent. +- $false: No sharing invitation is sent. This is the default value. + +This parameter only applies to calendar folders and can only be used with the following AccessRights parameter values: + +- AvailabilityOnly +- LimitedDetails +- Reviewer +- Editor + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharingPermissionFlags +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. +- 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. + +```yaml +Type: MailboxFolderPermissionFlags +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) + +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) + +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) + +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md new file mode 100644 index 0000000000..aab760df38 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxirmaccess +applicable: Exchange Online +title: Set-MailboxIRMAccess +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-MailboxIRMAccess + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-MailboxIRMAccess cmdlet to block delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxIRMAccess -AccessLevel [-Identity] -User [] +``` + +## DESCRIPTION +> [!NOTE] +> This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com -AccessLevel Block +``` + +This example prevents delegate Chris from reading IRM-protected messages in Lynette's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AccessLevel +The AccessLevel parameter specifies what delegates can do to IRM-protected messages in the mailbox that's specified by the Identity parameter. + +The only value for this parameter is Block, which means you can only use this cmdlet to block delegate access to IRM-protected messages in the mailbox. + +To allow access to IRM-protected messages in the mailbox, use the Remove-MailboxIRMAccess cmdlet. + +```yaml +Type: IRMAccessLevel +Parameter Sets: (All) +Aliases: +Accepted values: Block +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +**Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +The User parameter specifies the delegate who is blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Set-MailboxImportRequest.md rename to exchange/exchange-ps/exchange/Set-MailboxImportRequest.md index 36c0afdcae..07b606b809 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxImportRequest @@ -13,22 +16,12 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxImportRequest cmdlet to change import request options after the request has been created. You can use the Set-MailboxImportRequest cmdlet to recover from failed import requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Rehome -``` -Set-MailboxImportRequest [-Identity] [-RehomeRequest] - [-AzureSharedAccessSignatureToken ] - [-Confirm] - [-DomainController ] - [-RequestExpiryInterval ] - [-WhatIf] [] -``` - ### Identity ``` Set-MailboxImportRequest [-Identity] @@ -41,30 +34,42 @@ Set-MailboxImportRequest [-Identity] [-DomainController ] [-InternalFlags ] [-LargeItemLimit ] - [-Priority ] - [-RemoteCredential ] - [-RemoteHostName ] + [-Priority ] [-RequestExpiryInterval ] + [-SkipInitialConnectionValidation] [-SkipMerging ] - [-WhatIf] [] + [-SkippedItemApprovalTime ] + [-WhatIf] + [] +``` + +### Rehome +``` +Set-MailboxImportRequest [-Identity] [-RehomeRequest] + [-Confirm] + [-DomainController ] + [-RehomeRequest] + [-RequestExpiryInterval ] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MailboxImportRequest -Identity "Kweku\Import" -BadItemLimit 5 ``` This example changes the import request Kweku\\Import to accept up to five corrupted mailbox items. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxImportRequest -Status Suspended | Set-MailboxImportRequest -BatchName April14 ``` @@ -73,13 +78,14 @@ This example finds all import requests that have a status of Suspended, and then ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: \\\\. +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 Default value: None @@ -87,31 +93,37 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. +### -AzureSharedAccessSignatureToken +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter -Parameter Sets: Identity +Type: String +Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False +Applicable: Exchange Online + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AzureSharedAccessSignatureToken -This parameter is available only in the cloud-based service. +### -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. -PARAMVALUE: String +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. ```yaml -Type: String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -124,13 +136,16 @@ The BadItemLimit parameter specifies the maximum number of bad items that are al 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. -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. +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. ```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 Default value: None @@ -146,6 +161,7 @@ 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 Default value: None @@ -161,6 +177,7 @@ Type: Unlimited Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -171,8 +188,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -180,6 +196,7 @@ 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 Default value: None @@ -197,6 +214,7 @@ 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 @@ -214,6 +232,7 @@ Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -226,19 +245,21 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) +- 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. 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. + ```yaml Type: Unlimited Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -252,26 +273,20 @@ 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: - Lowest - - Lower - - Low - - Normal: This is the default value. - - High - - Higher - - Highest - - Emergency ```yaml -Type: Normal | High +Type: RequestPriority Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -282,13 +297,16 @@ Accept wildcard characters: False ### -RehomeRequest This parameter is available only in on-premises Exchange. -The RehomeRequest parameter specifies to the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox being imported. This parameter is used primarily for debugging purposes. +The RehomeRequest parameter tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox being imported. You don't need to specify a value with this switch. + +This switch is used primarily for debugging purposes. ```yaml Type: SwitchParameter Parameter Sets: Rehome Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -296,16 +314,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoteCredential -This parameter is available only in on-premises Exchange. +### -RequestExpiryInterval +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 RemoteCredential parameter specifies an administrator who has permission to perform the mailbox import request. For example, Administrator@ humongousinsurance.com. +- The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. ```yaml -Type: PSCredential -Parameter Sets: Identity +Type: Unlimited +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -313,16 +337,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoteHostName -This parameter is available only in on-premises Exchange. +### -SkipInitialConnectionValidation +This parameter is available only in the cloud-based service -The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're configuring the import request. +This parameter is reserved for internal Microsoft use. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -330,22 +355,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. +### -SkipMerging +The SkipMerging parameter specifies the steps in the import that should be skipped. This parameter is used primarily for debugging purposes. ```yaml -Type: Unlimited -Parameter Sets: (All) +Type: SkippableMergeComponent[] +Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -353,14 +371,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipMerging -The SkipMerging parameter specifies the steps in the import that should be skipped. This parameter is used primarily for debugging purposes. +### -SkippedItemApprovalTime +This parameter is available only in the cloud-based service + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SkippableMergeComponent[] +Type: System.DateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -376,6 +397,7 @@ 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 Default value: None @@ -384,20 +406,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7802e75f-e7db-424f-b68f-751cdabb324b.aspx) diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md new file mode 100644 index 0000000000..7392f0f33e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md @@ -0,0 +1,372 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxJunkEmailConfiguration cmdlet to configure the junk email settings on mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxJunkEmailConfiguration [-Identity] + [-BlockedSendersAndDomains ] + [-Confirm] + [-ContactsTrusted ] + [-DomainController ] + [-Enabled ] + [-FailOnError ] + [-IgnoreDefaultScope] + [-SenderScreeningEnabled ] + [-TrustedListsOnly ] + [-TrustedRecipientsAndDomains ] + [-TrustedSendersAndDomains ] + [-WhatIf] + [] +``` + +## DESCRIPTION +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. + + Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. + +- Configure the safelist collection: The safelist collection is the Safe Senders list, the Safe Recipients list, and the Blocked Senders list. Users can configure the safelist collection on their own mailbox by using Microsoft Outlook or Outlook on the web. + +For more information, see [Configure Exchange antispam settings on mailboxes](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxJunkEmailConfiguration "David Pelton" -Enabled $false +``` + +This example disables the junk email rule for the user named David Pelton. In on-premises Exchange, messages are no longer moved between the Inbox and the Junk Email folder based on the SCL Junk Email Folder threshold (organization or mailbox) or the safelist collection of the mailbox. In Exchange Online, the safelist collection of the mailbox is unable to move messages between the Inbox and the Junk Email folder. Messages are still delivered to the Junk Email folder based on the verdict and corresponding action of anti-spam policies. + +### Example 2 +```powershell +Set-MailboxJunkEmailConfiguration "Michele Martin" -TrustedSendersAndDomains @{Add="contoso.com","fabrikam.com"} -BlockedSendersAndDomains @{Add="jane@fourthcoffee.com"} +``` + +This example makes the following configuration changes to the safelist collection for the user named Michele Martin: + +- Adds contoso.com and fabrikam.com to the Safe Senders list without affecting other existing entries. +- Adds jane@fourthcoffee.com to the Blocked senders list without affecting other existing entries. + +### Example 3 +```powershell +Get-MailboxJunkEmailConfiguration * | Where {$_.ContactsTrusted -eq $true} | Set-MailboxJunkEmailConfiguration -ContactsTrusted $false +``` + +This example identifies mailboxes where contacts are treated as trusted senders and then changes the junk email configuration to not treat contacts as trusted senders. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -BlockedSendersAndDomains +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactsTrusted +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the junk email rule on the mailbox (a hidden Inbox rule named Junk E-mail Rule). Valid values are: + +- $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This is the default value. + + In on-premises Exchange, the safelist collection of the mailbox (the Safe Senders list, Safe Recipients list, and Blocked Senders list), and the SCL Junk Email folder threshold (for the organization or the mailbox) delivers messages to the Inbox or the Junk Email folder. + + In the cloud-based service, the safelist collection of the mailbox moves delivered messages between the Inbox or the Junk Email folder. Messages are delivered to the Junk Email folder based on the verdict and corresponding action of anti-spam policies only. + +- $false: The junk email rule is disabled in the mailbox. This value corresponds to the Outlook on the web setting: Don't move email to my Junk Email folder. + + In on-premises Exchange, the safelist collection of the mailbox or the SCL Junk Email folder threshold are unable to deliver messages to the Inbox or the Junk Email folder. + + In the cloud-based service, the safelist collection of the mailbox is unable to move delivered messages between the Inbox or the Junk Email folder. Messages are still delivered to the Junk Email folder based on the verdict and corresponding action of anti-spam policies. + +You can view the status of the junk email rule by running either of the following commands to find the Enabled property value: + +- `Get-MailboxJunkEmailConfiguration -Identity ` +- On-premises Exchange only: `Get-InboxRule "Junk E-mail Rule" -Mailbox -IncludeHidden` + +The state of the junk email rule on the mailbox doesn't affect the client-side junk email settings that are available in the Outlook Junk Email Filter. Even when the junk email rule is disabled in the mailbox, Outlook can still move messages to the Junk Email folder. For example, if Outlook determines the message is spam, or the sender is defined in the Blocked Senders list, Outlook can move the message to the Junk Email folder. For more information, see [Overview of the Junk Email Filter](https://support.microsoft.com/office/5ae3ea8e-cf41-4fa0-b02a-3b96e21de089). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailOnError +This parameter is available only in the cloud-based service. + +{{ Fill FailOnError Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -SenderScreeningEnabled +This parameter is available only in the cloud-based service. + +{{ Fill SenderScreeningEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedListsOnly +The TrustedListsOnly parameter specifies that only messages from senders in the Safe Senders list are delivered to the Inbox. All other messages are treated as junk email. This parameter corresponds to the Outlook on the web setting: Don't trust email unless it comes from someone in my Safe Senders and Recipients list. Valid values are: + +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRecipientsAndDomains +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedSendersAndDomains +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +To empty the list of email addresses and domains, use the value $null. + +**Notes**: + +- You can't add sender email addresses from the same domain as the recipient's email address. All mailboxes in the global address list (GAL) are automatically considered as trusted senders. +- You can't directly modify the Safe Recipients list by using this cmdlet. You use this parameter to modify the Safe Senders list, and the email addresses and domains are synchronized to the Safe Recipients list. +- In standalone EOP with directory synchronization, domain entries aren't synchronized by default, but you can enable synchronization for domains. For more information, see [Configure Content Filtering to Use Safe Domain Data](/exchange/configure-content-filtering-to-use-safe-domain-data-exchange-2013-help). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md new file mode 100644 index 0000000000..047f4af452 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md @@ -0,0 +1,1420 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxMessageConfiguration cmdlet to configure the Outlook on the web settings that are applied to specific mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxMessageConfiguration [-Identity] + [-AfterMoveOrDeleteBehavior ] + [-AlwaysShowBcc ] + [-AlwaysShowFrom ] + [-AutoAddSignature ] + [-AutoAddSignatureOnMobile ] + [-AutoAddSignatureOnReply ] + [-CheckForForgottenAttachments ] + [-CheckForReportJunkDialog ] + [-Confirm] + [-ConversationSortOrder ] + [-DefaultFontColor ] + [-DefaultFontFlags ] + [-DefaultFontName ] + [-DefaultFontSize ] + [-DefaultFormat ] + [-DefaultSignature ] + [-DefaultSignatureOnReply ] + [-DeleteSignatureName ] + [-DisplayDensityMode ] + [-DomainController ] + [-EchoGroupMessageBackToSubscribedSender ] + [-EmailComposeMode ] + [-EmptyDeletedItemsOnLogoff ] + [-FavoritesBitFlags ] + [-GlobalReadingPanePosition ] + [-HideDeletedItems ] + [-IgnoreDefaultScope] + [-IsDarkModeTheme ] + [-IsFavoritesFolderTreeCollapsed ] + [-IsFocusedInboxEnabled ] + [-IsMailRootFolderTreeCollapsed ] + [-IsReplyAllTheDefaultResponse ] + [-LinkPreviewEnabled ] + [-MailFolderPaneExpanded ] + [-MailSendUndoInterval ] + [-ManuallyPickCertificate ] + [-NavigationBarWidth ] + [-NavigationPaneViewOption ] + [-NewEnabledPonts ] + [-NewItemNotification ] + [-PreferAccessibleContent ] + [-PreviewMarkAsReadBehavior ] + [-PreviewMarkAsReadDelaytime ] + [-ReadReceiptResponse ] + [-ReportJunkSelected ] + [-SendAddressDefault ] + [-ShowConversationAsTree ] + [-ShowInlinePreviews ] + [-ShowNotificationBar ] + [-ShowPreviewTextInListView ] + [-ShowReadingPaneOnFirstLoad ] + [-ShowSenderOnTopInListView ] + [-ShowUpNext ] + [-SignatureHtml ] + [-SignatureHtmlBody ] + [-SignatureName ] + [-SignatureText ] + [-SignatureTextOnMobile ] + [-SigningCertificateId ] + [-SigningCertificateSubject ] + [-SmimeEncrypt ] + [-SmimeSign ] + [-UseDefaultSignatureOnMobile ] + [-WebSuggestedRepliesEnabledForUser ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-MailboxMessageConfiguration cmdlet configures Outlook on the web settings for the specified mailbox. These settings include email signature, message format, message options, read receipts, reading pane, and conversations. These settings are not used in Outlook, Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxMessageConfiguration kai@contoso.com -HideDeletedItems $true +``` + +This example sets items deleted from a conversation thread to not show in the list view of the conversation in Outlook on the web for Kai's mailbox. + +### Example 2 +```powershell +Set-MailboxMessageConfiguration kai@contoso.com -AlwaysShowBcc $true +``` + +This example sets the compose email message form to always show the Bcc field in Outlook on the web for Kai's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -AfterMoveOrDeleteBehavior +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 +- OpenNextItem +- ReturnToView + +The default value is OpenNextItem. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlwaysShowBcc +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlwaysShowFrom +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAddSignature +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + +The AutoAddSignature parameter specifies whether to automatically add signatures to new email messages created in Outlook on the web. Valid values are: + +- $true: Email signatures are automatically added to new messages. +- $false: Email signatures aren't automatically added to new messages. + +The email signature specified by the SignatureText parameter is added to plain text messages. The email signature specified by the SignatureHTML parameter is added to HTML-formatted 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAddSignatureOnMobile +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + +The AutoAddSignatureOnMobile parameter automatically adds the signature specified by the SignatureTextOnMobile parameter to messages when the user creates messages in Outlook on the web for devices. + +Valid input for this parameter is $true or $false. The default value is $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAddSignatureOnReply +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. +- $false: Email signatures aren't automatically added to reply messages. + +The email signature specified by the SignatureText parameter is added to plain text messages. The email signature specified by the SignatureHTML parameter is added to HTML-formatted messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckForForgottenAttachments +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. + +For example, the user creates a message that includes the text "Please see the attached Word document", but the user doesn't attach a file, and clicks Send. If this value is set to $true, the user gets a warning prompt so they can go back to the message and attach a file. If this value is set to $false, the user doesn't get the warning prompt. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckForReportJunkDialog +This parameter is available only in the cloud-based service. + +{{ Fill CheckForReportJunkDialog Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConversationSortOrder +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 +- Tree +- NewestOnTop +- NewestOnBottom +- ChronologicalNewestOnTop +- ChronologicalNewestOnBottom +- TreeNewestOnBottom + +The default value is ChronologicalNewestOnTop. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultFontColor +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultFontFlags +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 +- Bold +- Italic +- Underline +- All + +The default value is Normal. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultFontName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultFontSize +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultFormat +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSignature +This parameter is available only in the cloud-based service. + +{{ Fill DefaultSignature Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSignatureOnReply +This parameter is available only in the cloud-based service. + +{{ Fill DefaultSignatureOnReply Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSignatureName +This parameter is available only in the cloud-based service. + +{{ Fill DeleteSignatureName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayDensityMode +This parameter is available only in the cloud-based service. + +{{ Fill DisplayDensityMode Description }} + +```yaml +Type: DisplayDensityMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -EchoGroupMessageBackToSubscribedSender +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailComposeMode +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmptyDeletedItemsOnLogoff +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FavoritesBitFlags +This parameter is available only in the cloud-based service. + +{{ Fill FavoritesBitFlags Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalReadingPanePosition +This parameter is functional only in Exchange 2016 or later. It doesn't work in Exchange Online. + +The GlobalReadingPanePosition specifies the default location of the reading pane in Outlook on the web. Valid values are: + +- Off +- Bottom +- Right (This is the default value) + +```yaml +Type: MailReadingPanePosition +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideDeletedItems +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -IsDarkModeTheme +This parameter is available only in the cloud-based service. + +{{ Fill IsDarkModeTheme Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFavoritesFolderTreeCollapsed +The IsFavoritesFolderTreeCollapsed parameter specifies whether to collapse the Favorites folder tree by default in Outlook on the web. Valid values are: + +- $true: The Favorites folder tree is collapsed by default. +- $false: The Favorites folder tree isn't collapsed by default. This is the default value + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFocusedInboxEnabled +This parameter is available only in the cloud-based service. + +{{ Fill IsFocusedInboxEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMailRootFolderTreeCollapsed +The IsMailRootFolderTreeCollapsed parameter specifies whether to collapse the Mail root folder tree by default in Outlook on the web. Valid values are: + +- $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 + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsReplyAllTheDefaultResponse +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkPreviewEnabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailFolderPaneExpanded +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailSendUndoInterval +This parameter is available only in the cloud-based service. + +{{ Fill MailSendUndoInterval Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManuallyPickCertificate +This parameter is available only in the cloud-based service. + +{{ Fill ManuallyPickCertificate Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NavigationBarWidth +This parameter is available only in the cloud-based service. + +{{ Fill NavigationBarWidth Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NavigationPaneViewOption +The NavigationPaneViewOption parameter specifies the default navigation pane view in Outlook on the web. Valid values are: + +- Default: This is the default value +- MailFolders +- PeopleFolders +- Groups +- PinnedMailFolders + +```yaml +Type: NavigationPaneView +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewEnabledPonts +This parameter is available only in the cloud-based service. + +{{ Fill NewEnabledPonts Description }} + +```yaml +Type: PontType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewItemNotification +The NewItemNotification parameter specifies how to provide notification for the arrival of new items for the user in Outlook on the web. You can use the following values: + +- Sound +- EMailToast +- VoiceMailToast +- FaxToast +- None +- All + +The default value is All. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferAccessibleContent +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewMarkAsReadBehavior +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. +- OnSelectionChange +- Never + +The default value is OnSelectionChange. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewMarkAsReadDelaytime +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. + +This parameter is meaningful only if you set the PreviewMarkAsReadBehavior parameter to the value Delayed. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadReceiptResponse +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 +- AlwaysSend +- NeverSend + +The default value is DoNotAutomaticallySend. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkSelected +This parameter is available only in the cloud-based service. + +{{ Fill ReportJunkSelected Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendAddressDefault +This parameter is available only in the cloud-based service. + +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. + +You can use one of the following values: + +- Blank, which is represented by the value $null. This indicates no default From address is specified. +- The user's primary email address. For example, bob@contoso.com. +- The GUID of a POP, IMAP, or Hotmail subscription that's configured on the user's mailbox. + +By default, no default From address is specified on the mailbox. When no default From address is specified, the default behavior is: + +- The primary email address on the mailbox is used for all new messages. +- The To address of the incoming message is used as the From address for all replies or forwarded messages. + +You can find the available values for SendAddressDefault on a mailbox by running the command: `Get-MailboxMessageConfiguration -Mailbox | Format-List SendAddressDefault`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowConversationAsTree +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInlinePreviews +This parameter is available only in the cloud-based service. + +{{ Fill ShowInlinePreviews Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowNotificationBar +This parameter is available only in the cloud-based service. + +{{ Fill ShowNotificationBar Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowPreviewTextInListView +The ShowPreviewTextInListView parameter specifies whether to show preview text for messages in list view in Outlook on the web. Valid values are: + +- $true: Show preview text for messages in list view. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowReadingPaneOnFirstLoad +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowSenderOnTopInListView +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowUpNext +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureHtml +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + +The SignatureHtml parameter specifies the email signature that's available to the user in HTML-formatted messages in Outlook on the web. You can use plain text or text with HTML tags. However, any JavaScript code is removed. + +To automatically add this email signature to HTML-formatted messages created by the user in Outlook on the web, the AutoAddSignature parameter must be set to $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureHtmlBody +This parameter is available only in the cloud-based service. + +{{ Fill SignatureHtmlBody Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureName +This parameter is available only in the cloud-based service. + +{{ Fill SignatureName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureText +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + +The SignatureText parameter specifies the email signature that's available to the user in plain text messages in Outlook on the web. This parameter supports all Unicode characters. + +To automatically add the email signature to plain text messages created by the user in Outlook on the web, the AutoAddSignature parameter must be set to the value $true. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureTextOnMobile +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + +The SignatureTextOnMobile parameter specifies the email signature that's available in messages created by the user in Outlook on the web for devices. This parameter supports all Unicode characters. + +To automatically add the email signature to messages created by the user in Outlook on the web for devices, the AutoAddSignatureOnMobile parameter must be set to the value $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SigningCertificateId +This parameter is available only in the cloud-based service. + +{{ Fill SigningCertificateId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SigningCertificateSubject +This parameter is available only in the cloud-based service. + +{{ Fill SigningCertificateSubject Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmimeEncrypt +This parameter is available only in the cloud-based service. + +{{ Fill SmimeEncrypt Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmimeSign +This parameter is available only in the cloud-based service. + +{{ Fill SmimeSign Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultSignatureOnMobile +The UseDefaultSignatureOnMobile parameter specifies whether to add the default email signature to messages created by the user in Outlook on the web for devices. The user configures the default signature in Outlook. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebSuggestedRepliesEnabledForUser +This parameter is available only in the cloud-based service. + +{{ Fill WebSuggestedRepliesEnabledForUser Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxPlan.md b/exchange/exchange-ps/exchange/Set-MailboxPlan.md new file mode 100644 index 0000000000..96b60c149b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxPlan.md @@ -0,0 +1,425 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-MailboxPlan + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-MailboxPlan cmdlet to modify the settings of mailbox plans in the cloud-based service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxPlan [-Identity] + [-Confirm] + [-Force] + [-IsDefault] + [-IssueWarningQuota ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-ProhibitSendQuota ] + [-ProhibitSendReceiveQuota ] + [-RecipientLimits ] + [-RetainDeletedItemsFor ] + [-RetentionPolicy ] + [-RoleAssignmentPolicy ] + [-WhatIf] + [] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxPlan -Identity ExchangeOnlineEnterprise -ProhibitSendReceiveQuota 40GB -ProhibitSendQuota 39.5GB -IssueWarningQuota 39GB +``` + +This example lowers the default mailbox quotas in the mailbox plan named ExchangeOnlineEnterprise. + +## PARAMETERS + +### -Identity +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 +- Alias +- Display name +- Distinguished name (DN) +- GUID + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueWarningQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) + +Unqualified values are typically treated as bytes, but small values may 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. + +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. + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSendSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) + +Unqualified values are typically treated as bytes, but small values may 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. + +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. + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProhibitSendQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProhibitSendReceiveQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. + +The maximum value is determined by the mailbox plan. You can lower 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientLimits +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainDeletedItemsFor +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. +- Selecting the Empty Deleted Items Folder action. +- Deleting items using Shift + Delete. + +These actions move the items to the Recoverable Items folder, into a subfolder named Deletions. + +Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see [Recoverable Items folder in Exchange Online](https://learn.microsoft.com/Exchange/security-and-compliance/recoverable-items-folder/recoverable-items-folder). + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +The default value is 14 days (14.00:00:00). In Exchange Online, you can increase the value to a maximum of 30 days. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicy +The RetentionPolicy parameter specifies the retention policy that's applied to new mailboxes that you create. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished Name (DN) +- GUID + +Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. Use the Get-RetentionPolicy cmdlet to see the available retention policies. + +By default, the value of this parameter is blank ($null), which means the default retention policy (the retention policy where the IsDefault property value is True) is assigned to new mailboxes. By default, the default retention policy is named Default MRM Policy. + +If you don't set a value for this parameter, existing mailboxes are also updated if you change which retention policy is the default by using the IsDefault switch on the New-RetentionPolicy or Set-RetentionPolicy cmdlets. + +**Note**: Specifying a value for this parameter has the following potential issues: + +- If the value of this parameter is not blank ($null), then the specified retention policy must be the default Exchange retention policy that's configured for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. +- If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. +- Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. + +For more information, see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentPolicy +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 +- Distinguished name (DN) +- GUID + +The default value is Default Role Assignment Policy. + +To see the available role assignment policies, use the Get-RoleAssignmentPolicy cmdlet. + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md new file mode 100644 index 0000000000..ef75fd3f02 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md @@ -0,0 +1,360 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxRegionalConfiguration cmdlet to modify the regional settings of a mailbox. You can modify the date format, time format, time zone and language of the mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Set-MailboxRegionalConfiguration [-Identity] [-DomainController ] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Identity +``` +Set-MailboxRegionalConfiguration [-Identity] [-Archive] [-UseCustomRouting] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### MailboxLocation +``` +Set-MailboxRegionalConfiguration [-MailboxLocation ] [-UseCustomRouting] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxRegionalConfiguration -Identity "Marcelo Teixeira" -Language pt-br -LocalizeDefaultFolderName +``` + +This example sets Marcelo Teixeira's mailbox language to Brazilian Portuguese, and localizes the default folder names in Portuguese. + +### Example 2 +```powershell +Set-MailboxRegionalConfiguration -Identity "Ella Lack's" -DateFormat "d/M/yyyy" +``` + +This example sets the date format for Ella Lack's mailbox. + +### Example 3 +```powershell +Set-MailboxRegionalConfiguration -Identity "Alice Jakobsen" -Language da-dk -DateFormat "dd-MM-yyyy" -LocalizeDefaultFolderName +``` + +This example sets Alice Jakobsen's mailbox language to Danish Denmark, sets the date in the day/month/year format and localizes the default folder names in Danish. + +### Example 4 +```powershell +Get-Mailbox -RecipientTypeDetails UserMailbox -ResultSize Unlimited | Set-MailboxRegionalConfiguration -Language es-es -DateFormat "dd/MM/yyyy" -TimeFormat H:mm -LocalizeDefaultFolderName +``` + +This example sets all User Mailboxes language to Spanish Spain, sets the date in the day/month/year format, sets the time in the H:mm format and localizes the default folder names in Spanish. + +### Example 5 +```powershell +Set-MailboxRegionalConfiguration -Identity "Megan Bowen" -Language es-ar -DateFormat $null -TimeFormat $null -LocalizeDefaultFolderName +``` + +This example sets Megan Bowen mailbox language to Spanish Argentina, sets the date and time format to default value for es-ar, and localizes the default folder names in Spanish. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Archive +This parameter is available only in the cloud-based service. + +{{ Fill Archive Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateFormat +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/yy +- MM/dd/yy +- MM/dd/yyyy +- yy/MM/dd +- yyyy-MM-dd +- dd-MMM-yy + +For more information about the date format strings, see [Standard Date and Time Format Strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). + +```yaml +Type: String +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Default +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 +``` + +### -Language +The Language parameter specifies the language for the mailbox. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalizeDefaultFolderName +The LocalizeDefaultFolderName switch localizes the default folder names of the mailbox in the current or specified language. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeFormat +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. +- hh:mm tt +- H:mm +- HH:mm + +For more information about the time format strings, see [Standard Date and Time Format Strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). + +```yaml +Type: String +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 +``` + +### -TimeZone +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"). + +To see the available values, run the following command: `$TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display`. + +If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md new file mode 100644 index 0000000000..a874cb3a60 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md @@ -0,0 +1,471 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxRestoreRequest cmdlet to change restore request options after the request has been created. You can use this cmdlet to recover from failed restore requests. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Set-MailboxRestoreRequest [-Identity] + [-AcceptLargeDataLoss] + [-BadItemLimit ] + [-BatchName ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-DomainController ] + [-InternalFlags ] + [-LargeItemLimit ] + [-Priority ] + [-RemoteHostName ] + [-RequestExpiryInterval ] + [-SkipInitialConnectionValidation] + [-SkipMerging ] + [-SkippedItemApprovalTime ] + [-SourceWlmLevel ] + [-TargetWlmLevel ] + [-WhatIf] + [] +``` + +### Rehome +``` +Set-MailboxRestoreRequest [-Identity] + [-Confirm] + [-DomainController ] + [-RehomeRequest] + [-RemoteHostName ] + [-RequestExpiryInterval ] + [-SkipInitialConnectionValidation] + [-SkippedItemApprovalTime ] + [-SourceWlmLevel ] + [-TargetWlmLevel ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" -BadItemLimit 10 +``` + +This example changes the second restore request for Ayla\\MailboxRestore1 to skip 10 corrupt mailbox items. + +### Example 2 +```powershell +Set-MailboxRestoreRequest -Identity "Kweku\MailboxRestore" -BadItemLimit 100 -AcceptLargeDataLoss +``` + +This example changes the first restore request for Kweku's mailbox to skip 100 corrupt items. Because the BadItemLimit is greater than 50, the AcceptLargeDataLoss parameter must be specified. + +## PARAMETERS + +### -Identity +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). + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptLargeDataLoss +The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. + +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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchName +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompletedRequestAgeLimit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -InternalFlags +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. + +```yaml +Type: InternalMrsFlag[] +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +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: + +- 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. + +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. + +```yaml +Type: Unlimited +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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: + +- Lowest +- Lower +- Low +- Normal: This is the default value. +- High +- Higher +- Highest +- Emergency + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RehomeRequest +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. + +Use this switch to edit a mailbox restore request in the case where the source mailbox database from the original move request has to be removed. + +```yaml +Type: SwitchParameter +Parameter Sets: Rehome +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteHostName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipInitialConnectionValidation +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: + +- FolderACLs +- FolderProperties +- FolderRules +- InitialConnectionValidation + +Use this parameter only if a restore request fails because of folder rules, folder access control lists (ACLs), or initial connection validation. + +```yaml +Type: SkippableMergeComponent[] +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkippedItemApprovalTime +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: DateTime +Parameter Sets: Identity, Rehome +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceWlmLevel +This parameter is available only in the cloud-based service. + +{{ Fill SourceWlmLevel Description }} + +```yaml +Type: WlmLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetWlmLevel +This parameter is available only in the cloud-based service. + +{{ Fill TargetWlmLevel Description }} + +```yaml +Type: WlmLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/policy-and-compliance-content-search/Set-MailboxSearch.md b/exchange/exchange-ps/exchange/Set-MailboxSearch.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-MailboxSearch.md rename to exchange/exchange-ps/exchange/Set-MailboxSearch.md index 292ad12c2a..ee2ec50572 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSearch.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsearch +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxSearch schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-Mailboxsearch @@ -13,53 +16,73 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxSearch cmdlet to modify an existing mailbox search. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-Mailboxsearch [-Identity] [-Confirm] [-DomainController ] - [-DoNotIncludeArchive] [-EndDate ] [-EstimateOnly] [-ExcludeDuplicateMessages <$true | $false>] - [-Force] [-IncludeUnsearchableItems <$true | $false>] [-Language ] - [-LogLevel ] [-MessageTypes ] [-Name ] - [-Recipients ] [-SearchDumpster <$true | $false>] [-SearchQuery ] [-Senders ] - [-SourceMailboxes ] [-StartDate ] - [-StatusMailRecipients ] [-TargetMailbox ] [-WhatIf] - [-AllPublicFolderSources <$true | $false>] [-AllSourceMailboxes <$true | $false>] [-Description ] - [-IncludeKeywordStatistics] [-InPlaceHoldEnabled <$true | $false>] [-ItemHoldPeriod ] - [-PublicFolderSources ] [-StatisticsStartIndex ] [] +Set-Mailboxsearch [-Identity] + [-AllPublicFolderSources ] + [-AllSourceMailboxes ] + [-Confirm] + [-Description ] + [-DomainController ] + [-DoNotIncludeArchive] + [-EndDate ] + [-EstimateOnly] + [-ExcludeDuplicateMessages ] + [-Force] + [-IncludeKeywordStatistics] + [-IncludeUnsearchableItems ] + [-InPlaceHoldEnabled ] + [-ItemHoldPeriod ] + [-Language ] + [-LogLevel ] + [-MessageTypes ] + [-Name ] + [-Recipients ] + [-SearchDumpster ] + [-SearchQuery ] + [-Senders ] + [-SourceMailboxes ] + [-StartDate ] + [-StatisticsStartIndex ] + [-StatusMailRecipients ] + [-TargetMailbox ] + [-WhatIf] + [] ``` ## DESCRIPTION -In on-premises Exchange and Exchange Online, mailbox searches are used for In-Place eDiscovery and In-Place Hold. For In-Place eDiscovery, unless specified, mailboxes on all Mailbox servers in an organization are searched. To create an In-Place Hold, you need to specify the mailboxes to place on hold using the SourceMailboxes parameter. The search can be stopped, started, modified, and removed. +In on-premises Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. For In-Place eDiscovery, unless specified, mailboxes on all Mailbox servers in an organization are searched. To create an In-Place Hold, you need to specify the mailboxes to place on hold using the SourceMailboxes parameter. The search can be stopped, started, modified, and removed. -By default, mailbox searches are performed across all Exchange 2016 and Exchange 2013 Mailbox servers in an Exchange organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. +By default, mailbox searches are performed across all Exchange 2013 or later Mailbox servers in an organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. If the In-Place eDiscovery search you want to modify is running, stop it before using the Set-MailboxSearch cmdlet. When restarting a search, any previous search results are removed from the target mailbox. -For more information, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx) and In-Place Hold and Litigation Hold (https://technet.microsoft.com/library/ff637980.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2016" +### Example 1 +```powershell +Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2017" ``` This example modifies the start date of a mailbox search. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-MailboxSearch -Identity "Legal-ProjectX" -AllPublicFolderSources $true ``` In on-premises Exchange, this example adds all public folders to the existing mailbox search named Legal-ProjectX. -Note: - -If we wanted to place the results of this search on In-Place Hold, the AllSourceMailboxes parameter must be set to $false. We could still include specific mailboxes in the search by using the SourceMailboxes parameter. +**Note**: If we wanted to place the results of this search on In-Place Hold, the AllSourceMailboxes parameter must be set to $false. We could still include specific mailboxes in the search by using the SourceMailboxes parameter. ## PARAMETERS @@ -71,6 +94,7 @@ 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 Default value: None @@ -78,18 +102,72 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AllPublicFolderSources +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]). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllSourceMailboxes +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]). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 Default value: None @@ -107,6 +185,7 @@ 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 @@ -115,15 +194,18 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive -This parameter is available or functional only in 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. -The DoNotIncludeArchive parameter specifies whether items in the user's Archive mailbox are included in mailbox searches. By default, items in the user's Archive mailbox are included in mailbox searches. If set to $true, the DoNotIncludeArchive parameter instructs Multi-Mailbox Search to exclude archive mailboxes from the search. +By default, items in the user's Archive mailbox are included in mailbox searches. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -134,7 +216,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". To clear the end date, use the value $null. @@ -143,6 +225,7 @@ 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 Default value: None @@ -151,17 +234,14 @@ Accept wildcard characters: False ``` ### -EstimateOnly -The EstimateOnly parameter specifies whether to provide only an estimate of the number of items that will be returned. Valid values are: - -- $true: Messages aren't copied to the target mailbox, and only an estimate of the number of items is returned. - -- $false: Messages are copied to the target mailbox. +The EstimateOnly switch provides only an estimate of the number of items that will be returned without copying message to the target mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter 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 @@ -173,14 +253,14 @@ Accept wildcard characters: False 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. - - $false: Copy all instances of a message if the same message exists in multiple folders or mailboxes. ```yaml -Type: $true | $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 Default value: None @@ -189,15 +269,32 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -Use this to switch suppress the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted. +Use this to switch to hide the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted. ```yaml Type: SwitchParameter 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 +``` + +### -IncludeKeywordStatistics +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 Default value: None @@ -209,16 +306,58 @@ Accept wildcard characters: False 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. 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. ```yaml -Type: $true | $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceHoldEnabled +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. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemHoldPeriod +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. + +```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 Default value: None @@ -229,13 +368,14 @@ Accept wildcard characters: False ### -Language The Language parameter specifies a locale for the mailbox search. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -247,16 +387,15 @@ Accept wildcard characters: False 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. - - 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. ```yaml -Type: Suppress | Basic | Full +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 Default value: None @@ -268,19 +407,12 @@ Accept wildcard characters: False The MessageTypes parameter specifies the message types to include in the search query. Valid values are: - Contacts - - Docs - - Email - - IM - - Journals - - Meetings - - Notes - - Tasks You can specify multiple values separated by commas. @@ -292,6 +424,7 @@ 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 Default value: None @@ -309,6 +442,7 @@ 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 Default value: None @@ -328,6 +462,7 @@ 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 Default value: None @@ -336,17 +471,18 @@ Accept wildcard characters: False ``` ### -SearchDumpster -This parameter is available or functional only in 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. -By default, items in the dumpster aren't searched. Set the value to $true to enable searching the dumpster. +Set the value to $true to enable searching the dumpster, or set to $false to disable it. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -355,20 +491,16 @@ Accept wildcard characters: False ``` ### -SearchQuery -The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). +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. The other search query parameters are: - EndDate - - MessageTypes - - Recipients - - Senders - - StartDate ```yaml @@ -376,6 +508,7 @@ 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 Default value: None @@ -395,6 +528,7 @@ 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 Default value: None @@ -403,25 +537,16 @@ Accept wildcard characters: False ``` ### -SourceMailboxes -The SourceMailboxes parameter specifies the mailboxes to be searched. You can use any value that uniquely identifies the mailbox. - -For example: +The SourceMailboxes parameter specifies the mailboxes to be searched. You can use any value that uniquely identifies the mailbox. For example: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple values 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"`. To use this parameter, the AllSourceMailboxes parameter needs to be $false (the default value). @@ -430,7 +555,6 @@ To clear the source mailboxes, use the value $null. To enable In-Place Hold on the search results, you need to set the AllSourceMailboxes parameter to $false (the default value) and configure one or both of the following settings: - Specify one or more source mailboxes by using the SourceMailboxes parameter. - - In on-premises Exchange, set the AllPublicFolderSources parameter to $true. ```yaml @@ -438,6 +562,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 Default value: None @@ -448,7 +573,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". To clear start date, use the value $null. @@ -457,6 +582,7 @@ 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 Default value: None @@ -464,32 +590,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StatusMailRecipients -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. +### -StatisticsStartIndex +The StatisticsStartIndex parameter is used by the Exchange admin center (EAC) to retrieve keyword statistics in a paged operation. -For example: +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -- Name +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- Display name +### -StatusMailRecipients +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 - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -You can specify multiple values separated by commas. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] 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 @@ -498,30 +632,17 @@ Accept wildcard characters: False ``` ### -TargetMailbox -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -529,6 +650,7 @@ 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 Default value: None @@ -543,151 +665,8 @@ 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllPublicFolderSources -This parameter is available only in on-premises Exchange. - -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]). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllSourceMailboxes -This parameter is available only in on-premises Exchange. - -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]). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeKeywordStatistics -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InPlaceHoldEnabled -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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemHoldPeriod -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. +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -- 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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderSources -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PublicFolderIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatisticsStartIndex -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 Default value: None @@ -696,20 +675,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/23201ff0-e30a-4efd-9384-ab0af5815701.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md similarity index 79% rename from exchange/exchange-ps/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md rename to exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md index 3c2cc05355..fc78cfa732 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxSentItemsConfiguration @@ -13,25 +16,29 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-MailboxSentItemsConfiguration cmdlet to modify the Sent Items settings for mailboxes in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxSentItemsConfiguration [-Confirm] [-DomainController ] [-Identity ] - [-SendAsItemsCopiedTo ] [-SendOnBehalfOfItemsCopiedTo ] [-WhatIf] +Set-MailboxSentItemsConfiguration [-Confirm] + [-DomainController ] + [-Identity ] + [-SendAsItemsCopiedTo ] + [-SendOnBehalfOfItemsCopiedTo ] + [-WhatIf] [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MailboxSentItemsConfiguration -Identity "Customer Support Feedback" -SendAsItemsCopiedTo SenderAndFrom ``` @@ -42,8 +49,7 @@ This example configures the shared mailbox named "Customer Support Feedback" so ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -51,6 +57,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -66,6 +73,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -74,30 +82,17 @@ Accept wildcard characters: False ``` ### -Identity -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 exampple: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \\\\ - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -105,6 +100,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -116,7 +112,6 @@ Accept wildcard characters: False 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. - - 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 @@ -124,6 +119,7 @@ Type: SentItemsCopiedTo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -135,7 +131,6 @@ Accept wildcard characters: False 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. - - 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 @@ -143,6 +138,7 @@ Type: SentItemsCopiedTo Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -158,6 +154,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -166,20 +163,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d0ecab5b-45db-4bc3-8ce3-8bbea1ef9033.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-MailboxServer.md b/exchange/exchange-ps/exchange/Set-MailboxServer.md similarity index 87% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-MailboxServer.md rename to exchange/exchange-ps/exchange/Set-MailboxServer.md index efa1412661..1e8ce40d3a 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-MailboxServer.md +++ b/exchange/exchange-ps/exchange/Set-MailboxServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxServer @@ -13,36 +16,36 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxServer cmdlet to modify the mailbox configuration settings and attributes of Mailbox servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxServer [-Identity] - [-AutoDagServerConfigured <$true | $false>] - [-AutoDatabaseMountDial ] + [-AutoDagServerConfigured ] + [-AutoDatabaseMountDial ] [-CalendarRepairIntervalEndWindow ] [-CalendarRepairLogDirectorySizeLimit ] - [-CalendarRepairLogEnabled <$true | $false>] + [-CalendarRepairLogEnabled ] [-CalendarRepairLogFileAgeLimit ] [-CalendarRepairLogPath ] - [-CalendarRepairLogSubjectLoggingEnabled <$true | $false>] - [-CalendarRepairMissingItemFixDisabled <$true | $false>] - [-CalendarRepairMode ] + [-CalendarRepairLogSubjectLoggingEnabled ] + [-CalendarRepairMissingItemFixDisabled ] + [-CalendarRepairMode ] [-CalendarRepairSchedule ] [-CalendarRepairWorkCycle ] [-CalendarRepairWorkCycleCheckpoint ] [-Confirm] [-DarTaskStoreTimeBasedAssistantWorkCycle ] [-DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint ] - [-DatabaseCopyActivationDisabledAndMoveNow <$true | $false>] - [-DatabaseCopyAutoActivationPolicy ] + [-DatabaseCopyActivationDisabledAndMoveNow ] + [-DatabaseCopyAutoActivationPolicy ] [-DirectoryProcessorWorkCycle ] [-DirectoryProcessorWorkCycleCheckpoint ] [-DomainController ] [-FaultZone ] - [-FolderLogForManagedFoldersEnabled <$true | $false>] - [-ForceGroupMetricsGeneration <$true | $false>] + [-FolderLogForManagedFoldersEnabled ] + [-ForceGroupMetricsGeneration ] [-GroupMailboxWorkCycle ] [-GroupMailboxWorkCycleCheckpoint ] [-GroupMetricsGenerationTime ] @@ -50,13 +53,13 @@ Set-MailboxServer [-Identity] [-InferenceDataCollectionWorkCycleCheckpoint ] [-InferenceTrainingWorkCycle ] [-InferenceTrainingWorkCycleCheckpoint ] - [-IrmLogEnabled <$true | $false>] + [-IrmLogEnabled ] [-IrmLogMaxAge ] [-IrmLogMaxDirectorySize ] [-IrmLogMaxFileSize ] [-IrmLogPath ] - [-IsExcludedFromProvisioning <$true | $false>] - [-JournalingLogForManagedFoldersEnabled <$true | $false>] + [-IsExcludedFromProvisioning ] + [-JournalingLogForManagedFoldersEnabled ] [-JunkEmailOptionsCommitterWorkCycle ] [-Locale ] [-LogDirectorySizeLimitForManagedFolders ] @@ -69,17 +72,17 @@ Set-MailboxServer [-Identity] [-ManagedFolderAssistantSchedule ] [-ManagedFolderWorkCycle ] [-ManagedFolderWorkCycleCheckpoint ] - [-MAPIEncryptionRequired <$true | $false>] + [-MAPIEncryptionRequired ] [-MaximumActiveDatabases ] [-MaximumPreferredActiveDatabases ] - [-MessageTrackingLogEnabled <$true | $false>] + [-MessageTrackingLogEnabled ] [-MessageTrackingLogMaxAge ] [-MessageTrackingLogMaxDirectorySize ] [-MessageTrackingLogMaxFileSize ] [-MessageTrackingLogPath ] - [-MessageTrackingLogSubjectLoggingEnabled <$true | $false>] + [-MessageTrackingLogSubjectLoggingEnabled ] [-MigrationLogFilePath ] - [-MigrationLogLoggingLevel ] + [-MigrationLogLoggingLevel ] [-MigrationLogMaxAge ] [-MigrationLogMaxDirectorySize ] [-MigrationLogMaxFileSize ] @@ -93,7 +96,7 @@ Set-MailboxServer [-Identity] [-ProbeTimeBasedAssistantWorkCycleCheckpoint ] [-PublicFolderWorkCycle ] [-PublicFolderWorkCycleCheckpoint ] - [-RetentionLogForManagedFoldersEnabled <$true | $false>] + [-RetentionLogForManagedFoldersEnabled ] [-SearchIndexRepairTimeBasedAssistantWorkCycle ] [-SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint ] [-SharePointSignalStoreWorkCycle ] @@ -103,6 +106,7 @@ Set-MailboxServer [-Identity] [-SharingPolicyWorkCycleCheckpoint ] [-SharingSyncWorkCycle ] [-SharingSyncWorkCycleCheckpoint ] + [-SiteMailboxWorkCycle ] [-SiteMailboxWorkCycleCheckpoint ] [-StoreDsMaintenanceWorkCycle ] [-StoreDsMaintenanceWorkCycleCheckpoint ] @@ -114,72 +118,73 @@ Set-MailboxServer [-Identity] [-StoreScheduledIntegrityCheckWorkCycleCheckpoint ] [-StoreUrgentMaintenanceWorkCycle ] [-StoreUrgentMaintenanceWorkCycleCheckpoint ] - [-SubjectLogForManagedFoldersEnabled <$true | $false>] + [-SubjectLogForManagedFoldersEnabled ] [-SubmissionServerOverrideList ] [-TopNWorkCycle ] [-TopNWorkCycleCheckpoint ] [-UMReportingWorkCycle ] [-UMReportingWorkCycleCheckpoint ] [-WacDiscoveryEndpoint ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell 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. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-MailboxServer -Identity MBX01 -CalendarRepairIntervalEndWindow 40 -CalendarRepairLogDirectorySizeLimit 750MB -CalendarRepairLogFileAgeLimit 15.00:00:00 -CalendarRepairLogPath "D:\Exchange Logs\Calendar Repair Assistant" ``` This example changes some of the default settings of the Calendar Repair Assistant on the server named MBX01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell 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. -### -------------------------- Example 4 -------------------------- -``` +### 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. -### -------------------------- Example 5 -------------------------- -``` +### 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. -### -------------------------- Example 6 -------------------------- -``` +### 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. -### -------------------------- Example 7 -------------------------- -``` +### 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. -### -------------------------- Example 8 -------------------------- -``` +### 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 ``` @@ -191,9 +196,7 @@ In Exchange 2010, this example throttles the TopN Words Assistant and the Unifie 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 - - Distinguished name (DN) - - GUID ```yaml @@ -201,6 +204,7 @@ Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -212,10 +216,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -227,18 +232,17 @@ Accept wildcard characters: False 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. ```yaml -Type: Lossless | GoodAvailability | BestAvailability +Type: AutoDatabaseMountDial Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -247,13 +251,18 @@ Accept wildcard characters: False ``` ### -CalendarRepairIntervalEndWindow -The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. The default value is 30. This means the Calendar Repair Assistant repairs meetings in calendars up to 30 days from now. Meetings that are scheduled to occur more than 30 days in the future aren't repaired. +The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. + +The default value in Exchange 2016 and Exchange 2019 is 7. This value means the Calendar Repair Assistant repairs meetings in calendars up to 7 days from now. Meetings that are scheduled to occur more than 7 days in the future aren't repaired. + +The default value in Exchange 2013 and Exchange 2010 is 30. This value means the Calendar Repair Assistant repairs meetings in calendars up to 30 days from now. Meetings that are scheduled to occur more than 30 days in the future aren't repaired. ```yaml Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -271,13 +280,9 @@ The default value is 500 megabytes (MB). When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -289,6 +294,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -304,18 +310,16 @@ Valid input for this parameter is $true or $false. The default value is $true. The value of this parameter affects the following parameters: - CalendarRepairLogDirectorySizeLimit - - CalendarRepairLogFileAgeLimit - - CalendarRepairLogPath - - CalendarRepairLogSubjectLoggingEnabled ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -335,6 +339,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -350,6 +355,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -361,10 +367,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -376,10 +383,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -391,10 +399,11 @@ Accept wildcard characters: False 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: ValidateOnly | RepairAndValidate +Type: CalendarRepairType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -403,35 +412,37 @@ Accept wildcard characters: False ``` ### -CalendarRepairSchedule -This parameter is available or functional only in Exchange Server 2010. - -The CalendarRepairSchedule parameter specifies the intervals each week during which the Calendar Repair Assistant applies checks for calendar failures. The format is StartDay.Time-EndDay.Time. You can use the following values for the start and end days: +This parameter is available only in Exchange Server 2010. -- Full name of the day +The CalendarRepairSchedule parameter specifies the intervals each week during which the Calendar Repair Assistant applies checks for calendar failures. -- Abbreviated name of the 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"`. -- Integer from 0 through 6, where 0 = Sunday +You can use the following values for days: -The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. -The following are examples: +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. -- "Sun.11:30 PM-Mon.1:30 AM" +You can mix and match date/time formats. -- 6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. -- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (The assistant will run on Monday and Wednesday mornings from 4:30 until 5:30.) +Here are some examples: +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - "Sun.1:15 AM-Monday.23:00" - -If the Calendar Repair Assistant doesn't finish processing the mailboxes on the server during the time that you've scheduled, it automatically resumes processing where it left off the next time it runs. +- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Run on Monday and Wednesday mornings from 4:30 until 5:30.) ```yaml Type: ScheduleInterval[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -440,7 +451,7 @@ Accept wildcard characters: False ``` ### -CalendarRepairWorkCycle -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -455,6 +466,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -463,7 +475,7 @@ Accept wildcard characters: False ``` ### -CalendarRepairWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -476,6 +488,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -486,8 +499,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -495,6 +507,7 @@ 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 @@ -503,7 +516,7 @@ Accept wildcard characters: False ``` ### -DarTaskStoreTimeBasedAssistantWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -512,6 +525,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -520,7 +534,7 @@ Accept wildcard characters: False ``` ### -DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -529,6 +543,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -541,13 +556,14 @@ The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prev Valid input for this parameter is $true or $false. The default value is $false. -Setting this parameter to $truewon't cause databases to move to a server that has the DatabaseCopyAutoActivationPolicy parameter set to Blocked. +Setting this parameter to $true won't cause databases to move to a server that has the DatabaseCopyAutoActivationPolicy parameter set to Blocked. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -559,16 +575,15 @@ Accept wildcard characters: False 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. - - 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. ```yaml -Type: Unrestricted | IntrasiteOnly | Blocked +Type: DatabaseCopyAutoActivationPolicyType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -577,7 +592,7 @@ Accept wildcard characters: False ``` ### -DirectoryProcessorWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -586,6 +601,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -594,7 +610,7 @@ Accept wildcard characters: False ``` ### -DirectoryProcessorWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -603,6 +619,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -618,6 +635,7 @@ 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 @@ -633,6 +651,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -650,24 +669,19 @@ If you specify $true, managed folder logging is enabled. Message activity in fol The value of this parameter affects the following parameters: - JournalingLogForManagedFoldersEnabled - - LogDirectorySizeLimitForManagedFolders - - LogFileAgeLimitForManagedFolders - - LogFileSizeLimitForManagedFolders - - LogPathForManagedFolders - - RetentionLogForManagedFoldersEnabled - - SubjectLogForManagedFoldersEnabled ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -681,10 +695,11 @@ The ForceGroupMetricsGeneration parameter specifies that group metrics informati 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -693,7 +708,7 @@ Accept wildcard characters: False ``` ### -GroupMailboxWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -702,6 +717,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -710,7 +726,7 @@ Accept wildcard characters: False ``` ### -GroupMailboxWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -719,6 +735,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -727,7 +744,7 @@ Accept wildcard characters: False ``` ### -GroupMetricsGenerationTime -This parameter is available or functional only in 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. @@ -736,6 +753,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -744,7 +762,7 @@ Accept wildcard characters: False ``` ### -InferenceDataCollectionWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -762,7 +780,7 @@ Accept wildcard characters: False ``` ### -InferenceDataCollectionWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -780,7 +798,7 @@ Accept wildcard characters: False ``` ### -InferenceTrainingWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -798,7 +816,7 @@ Accept wildcard characters: False ``` ### -InferenceTrainingWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -816,19 +834,19 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled -This parameter is available or functional only in 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: - $true Enable IRM logging - - $false Disable IRM logging ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -837,7 +855,7 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge -This parameter is available or functional only in 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. @@ -850,6 +868,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -858,18 +877,14 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize -This parameter is available or functional only in 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: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. @@ -881,6 +896,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -889,18 +905,14 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize -This parameter is available or functional only in 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: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. 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. @@ -910,6 +922,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -918,7 +931,7 @@ Accept wildcard characters: False ``` ### -IrmLogPath -This parameter is available or functional only in 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. @@ -929,6 +942,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -942,10 +956,11 @@ The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't If you specify$true, the server won't be used for provisioning a new OAB or for moving existing OABs. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -959,10 +974,11 @@ The JournalingLogForManagedFoldersEnabled parameter specifies whether journaling 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -970,9 +986,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -JunkEmailOptionsCommitterWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -981,6 +996,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -992,22 +1008,21 @@ Accept wildcard characters: False 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) - - de-AT (German - Austria) - - es-CL (Spanish - Chile) -For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=68806). +For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1020,18 +1035,14 @@ This parameter is used for coexistence with Exchange 2010. Specifically, this pa 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. -Every mailbox database on the server uses a different log file name prefix (for example, Managed\_Folder\_Assistant[Mailbox database name]). Therefore, the maximum size of the managed folder log directory is the number of mailbox databases multiplied by the value of the LogDirectorySizeLimitForManagedFolders parameter. Other files aren't counted in the total size calculation. Renaming old log files or copying other files into the managed folder log directory could cause the directory to exceed its specified maximum size. +Every mailbox database on the server uses a different log file name prefix (for example, `Managed_Folder_Assistant`). Therefore, the maximum size of the managed folder log directory is the number of mailbox databases multiplied by the value of the LogDirectorySizeLimitForManagedFolders parameter. Other files aren't counted in the total size calculation. Renaming old log files or copying other files into the managed folder log directory could cause the directory to exceed its specified maximum size. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1043,6 +1054,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1064,6 +1076,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1079,13 +1092,9 @@ The LogFileSizeLimitForManagedFolders parameter specifies the maximum size for e When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1097,6 +1106,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1114,6 +1124,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1122,7 +1133,7 @@ Accept wildcard characters: False ``` ### -MailboxAssociationReplicationWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1131,6 +1142,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1139,7 +1151,7 @@ Accept wildcard characters: False ``` ### -MailboxAssociationReplicationWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1148,6 +1160,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1156,7 +1169,7 @@ Accept wildcard characters: False ``` ### -MailboxProcessorWorkCycle -This parameter is available or functional only in 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. @@ -1167,6 +1180,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1175,25 +1189,30 @@ Accept wildcard characters: False ``` ### -ManagedFolderAssistantSchedule -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. The interval format is StartDay.Time-EndDay.Time. You can use the following values for the start and end days: +**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). -- Full name of the day +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. -- Abbreviated name of the 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"`. -- Integer from 0 through 6, where 0 = Sunday +You can use the following values for days: -The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. -The following are examples: +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. -- "Sun.11:30 PM-Mon.1:30 AM" +You can mix and match date/time formats. -- 6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. -- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (The assistant will run on Monday and Wednesday mornings from 4:30 until 5:30.) +Here are some examples: +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - "Sun.1:15 AM-Monday.23:00" +- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Run on Monday and Wednesday mornings from 4:30 until 5:30.) If the Managed Folder Assistant doesn't finish processing the mailboxes on the server during the time that you've scheduled, it automatically resumes processing where it left off the next time it runs. @@ -1202,6 +1221,7 @@ Type: ScheduleInterval[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1210,7 +1230,7 @@ Accept wildcard characters: False ``` ### -ManagedFolderWorkCycle -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -1225,6 +1245,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1233,7 +1254,7 @@ Accept wildcard characters: False ``` ### -ManagedFolderWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -1248,6 +1269,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1259,10 +1281,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1282,6 +1305,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1299,6 +1323,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1307,15 +1332,16 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled -This parameter is available or functional only in 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1324,7 +1350,7 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge -This parameter is available or functional only in 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. @@ -1337,6 +1363,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1345,7 +1372,7 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize -This parameter is available or functional only in 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. @@ -1356,13 +1383,9 @@ When the Hub Transport server role and the Mailbox server role are installed on The default value is 250 MB. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. 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. @@ -1372,6 +1395,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1380,20 +1404,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize -This parameter is available or functional only in 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: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are treated as bytes. 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). ```yaml @@ -1401,6 +1420,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1409,7 +1429,7 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath -This parameter is available or functional only in 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. @@ -1418,6 +1438,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1426,15 +1447,16 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled -This parameter is available or functional only in 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1450,6 +1472,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1461,10 +1484,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: None | Error | Warning | Information | Verbose | Instrumentation +Type: MigrationEventType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1480,6 +1504,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1495,6 +1520,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1510,6 +1536,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1518,7 +1545,7 @@ Accept wildcard characters: False ``` ### -OABGeneratorWorkCycle -This parameter is available or functional only in 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. @@ -1531,6 +1558,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1539,7 +1567,7 @@ Accept wildcard characters: False ``` ### -OABGeneratorWorkCycleCheckpoint -This parameter is available or functional only in 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. @@ -1552,6 +1580,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1560,7 +1589,7 @@ Accept wildcard characters: False ``` ### -PeopleCentricTriageWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1569,6 +1598,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1577,7 +1607,7 @@ Accept wildcard characters: False ``` ### -PeopleCentricTriageWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1586,6 +1616,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1594,7 +1625,7 @@ Accept wildcard characters: False ``` ### -PeopleRelevanceWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1603,6 +1634,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1611,7 +1643,7 @@ Accept wildcard characters: False ``` ### -PeopleRelevanceWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1629,7 +1661,7 @@ Accept wildcard characters: False ``` ### -ProbeTimeBasedAssistantWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1638,6 +1670,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1646,7 +1679,7 @@ Accept wildcard characters: False ``` ### -ProbeTimeBasedAssistantWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1655,6 +1688,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1663,7 +1697,7 @@ Accept wildcard characters: False ``` ### -PublicFolderWorkCycle -This parameter is available or functional only in 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. @@ -1674,6 +1708,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1682,7 +1717,7 @@ Accept wildcard characters: False ``` ### -PublicFolderWorkCycleCheckpoint -This parameter is available or functional only in 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. @@ -1693,6 +1728,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1708,10 +1744,11 @@ The RetentionLogForManagedFoldersEnabled parameter specifies whether retention p If you specify $true, information about messages in managed folders that have been processed because they have reached their retention limits is logged. The managed folder log directory is specified by the LogPathForManagedFolders parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1720,7 +1757,7 @@ Accept wildcard characters: False ``` ### -SearchIndexRepairTimeBasedAssistantWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1729,6 +1766,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1737,7 +1775,7 @@ Accept wildcard characters: False ``` ### -SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1746,6 +1784,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1754,7 +1793,7 @@ Accept wildcard characters: False ``` ### -SharePointSignalStoreWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1763,6 +1802,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1771,7 +1811,7 @@ Accept wildcard characters: False ``` ### -SharePointSignalStoreWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1780,6 +1820,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1788,27 +1829,35 @@ Accept wildcard characters: False ``` ### -SharingPolicySchedule -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 format is StartDay.Time-EndDay.Time. You can use the following values for the start and end days: +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"`. -- Full name of the day +You can use the following values for days: -- Abbreviated name of the day +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. -- Integer from 0 through 6, where 0 = Sunday +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. -The following are examples: +Here are some examples: - "Sun.11:30 PM-Mon.1:30 AM" - -- 6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday 10:15 PM.) +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" +- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Run on Monday and Wednesday mornings from 4:30 until 5:30.) ```yaml Type: ScheduleInterval[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1817,11 +1866,11 @@ Accept wildcard characters: False ``` ### -SharingPolicyWorkCycle -This parameter is available or functional only in Exchange Server 2010 or 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 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. @@ -1832,6 +1881,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1840,7 +1890,7 @@ Accept wildcard characters: False ``` ### -SharingPolicyWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -1855,6 +1905,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1863,7 +1914,7 @@ Accept wildcard characters: False ``` ### -SharingSyncWorkCycle -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -1878,6 +1929,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1886,7 +1938,7 @@ Accept wildcard characters: False ``` ### -SharingSyncWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -1901,6 +1953,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1909,7 +1962,7 @@ Accept wildcard characters: False ``` ### -SiteMailboxWorkCycle -This parameter is available or functional only in 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. @@ -1922,6 +1975,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1930,7 +1984,7 @@ Accept wildcard characters: False ``` ### -SiteMailboxWorkCycleCheckpoint -This parameter is available or functional only in 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. @@ -1943,6 +1997,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1951,7 +2006,7 @@ Accept wildcard characters: False ``` ### -StoreDsMaintenanceWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1960,6 +2015,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1968,7 +2024,7 @@ Accept wildcard characters: False ``` ### -StoreDsMaintenanceWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1977,6 +2033,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1985,7 +2042,7 @@ Accept wildcard characters: False ``` ### -StoreIntegrityCheckWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1994,6 +2051,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2002,7 +2060,7 @@ Accept wildcard characters: False ``` ### -StoreIntegrityCheckWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2011,6 +2069,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2019,7 +2078,7 @@ Accept wildcard characters: False ``` ### -StoreMaintenanceWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2028,6 +2087,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2036,7 +2096,7 @@ Accept wildcard characters: False ``` ### -StoreMaintenanceWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2045,6 +2105,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2053,7 +2114,7 @@ Accept wildcard characters: False ``` ### -StoreScheduledIntegrityCheckWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2062,6 +2123,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2070,7 +2132,7 @@ Accept wildcard characters: False ``` ### -StoreScheduledIntegrityCheckWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2079,6 +2141,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2087,7 +2150,7 @@ Accept wildcard characters: False ``` ### -StoreUrgentMaintenanceWorkCycle -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2096,6 +2159,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2104,7 +2168,7 @@ Accept wildcard characters: False ``` ### -StoreUrgentMaintenanceWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2113,6 +2177,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2128,10 +2193,11 @@ The SubjectLogForManagedFoldersEnabled parameter specifies whether to include th By default, the subject of messages is blank in the managed folder log. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2147,6 +2213,7 @@ 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 @@ -2155,7 +2222,7 @@ Accept wildcard characters: False ``` ### -TopNWorkCycle -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -2170,6 +2237,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2178,7 +2246,7 @@ Accept wildcard characters: False ``` ### -TopNWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -2193,6 +2261,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2201,7 +2270,7 @@ Accept wildcard characters: False ``` ### -UMReportingWorkCycle -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -2218,6 +2287,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2226,7 +2296,7 @@ Accept wildcard characters: False ``` ### -UMReportingWorkCycleCheckpoint -This parameter is available or functional only in Exchange Server 2010 or 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. @@ -2239,6 +2309,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2247,7 +2318,7 @@ Accept wildcard characters: False ``` ### -WacDiscoveryEndpoint -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. +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). @@ -2256,6 +2327,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2271,6 +2343,7 @@ 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 @@ -2279,20 +2352,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6a229126-b863-4f07-b024-a39c93b253f7.aspx) diff --git a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md new file mode 100644 index 0000000000..975a5bcb45 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md @@ -0,0 +1,239 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MailboxSpellingConfiguration cmdlet to modify Outlook on the web spelling checker options for a specified user. For example, you can set the dictionary language and configure the spelling checker to ignore mixed digits or words in all uppercase. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxSpellingConfiguration [-Identity] + [-CheckBeforeSend ] + [-Confirm] + [-DictionaryLanguage ] + [-DomainController ] + [-IgnoreMixedDigits ] + [-IgnoreUppercase ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxSpellingConfiguration -Identity kai -IgnoreUppercase $true +``` + +This example sets the spelling checker to ignore words that contain only uppercase letters for messages sent from Kai's mailbox. + +### Example 2 +```powershell +Set-MailboxSpellingConfiguration -IgnoreMixedDigits $true -Identity kai +``` + +This example sets the spelling checker to ignore words containing numbers for messages sent from Kai's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 wildcard characters: False +``` + +### -CheckBeforeSend +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DictionaryLanguage +The DictionaryLanguage parameter specifies the dictionary language to use when the spelling checker checks the spelling in messages. Valid values are: + +- Arabic +- Catalan +- Danish +- Dutch +- EnglishAustralia +- EnglishCanada +- EnglishUnitedKingdom +- EnglishUnitedStates +- Finnish +- French +- GermanPreReform +- GermanPostReform +- Hebrew +- Italian +- Korean +- NorwegianBokMal +- NorwegianNyorsk +- PortuguesePortugal +- PortugueseBrasil +- Spanish +- Swedish + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMixedDigits +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreUppercase +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Set-MailboxTransportService.md b/exchange/exchange-ps/exchange/Set-MailboxTransportService.md similarity index 94% rename from exchange/exchange-ps/exchange/mail-flow/Set-MailboxTransportService.md rename to exchange/exchange-ps/exchange/Set-MailboxTransportService.md index 70e8b6b83b..ae787b004f 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-MailboxTransportService.md +++ b/exchange/exchange-ps/exchange/Set-MailboxTransportService.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MailboxTransportService @@ -13,41 +16,41 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxTransportService cmdlet to modify the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MailboxTransportService [-Identity] [-Confirm] - [-ConnectivityLogEnabled <$true | $false>] + [-ConnectivityLogEnabled ] [-ConnectivityLogMaxAge ] [-ConnectivityLogMaxDirectorySize ] [-ConnectivityLogMaxFileSize ] [-ConnectivityLogPath ] - [-ContentConversionTracingEnabled <$true | $false>] + [-ContentConversionTracingEnabled ] [-DomainController ] - [-MailboxDeliveryAgentLogEnabled <$true | $false>] + [-MailboxDeliveryAgentLogEnabled ] [-MailboxDeliveryAgentLogMaxAge ] [-MailboxDeliveryAgentLogMaxDirectorySize ] [-MailboxDeliveryAgentLogMaxFileSize ] [-MailboxDeliveryAgentLogPath ] [-MailboxDeliveryConnectorMaxInboundConnection ] - [-MailboxDeliveryConnectorProtocolLoggingLevel ] - [-MailboxDeliveryConnectorSMTPUtf8Enabled <$true | $false>] - [-MailboxDeliveryThrottlingLogEnabled <$true | $false>] + [-MailboxDeliveryConnectorProtocolLoggingLevel ] + [-MailboxDeliveryConnectorSMTPUtf8Enabled ] + [-MailboxDeliveryThrottlingLogEnabled ] [-MailboxDeliveryThrottlingLogMaxAge ] [-MailboxDeliveryThrottlingLogMaxDirectorySize ] [-MailboxDeliveryThrottlingLogMaxFileSize ] [-MailboxDeliveryThrottlingLogPath ] - [-MailboxSubmissionAgentLogEnabled <$true | $false>] + [-MailboxSubmissionAgentLogEnabled ] [-MailboxSubmissionAgentLogMaxAge ] [-MailboxSubmissionAgentLogMaxDirectorySize ] [-MailboxSubmissionAgentLogMaxFileSize ] [-MailboxSubmissionAgentLogPath ] [-MaxConcurrentMailboxDeliveries ] [-MaxConcurrentMailboxSubmissions ] - [-PipelineTracingEnabled <$true | $false>] + [-PipelineTracingEnabled ] [-PipelineTracingPath ] [-PipelineTracingSenderAddress ] [-ReceiveProtocolLogMaxAge ] @@ -61,18 +64,19 @@ Set-MailboxTransportService [-Identity] [-SendProtocolLogMaxDirectorySize ] [-SendProtocolLogMaxFileSize ] [-SendProtocolLogPath ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MailboxTransportService Mailbox01 -ReceiveProtocolLogPath "C:\SMTP Protocol Logs\Receive.log" ``` @@ -88,6 +92,7 @@ Type: MailboxTransportServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -98,8 +103,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -107,6 +111,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,10 +123,11 @@ Accept wildcard characters: False The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,6 +147,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -154,13 +161,9 @@ The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -172,6 +175,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -185,13 +189,9 @@ The ConnectivityLogMaxFileSize parameter specifies the maximum size of each conn When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -203,6 +203,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -218,6 +219,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -229,16 +231,15 @@ Accept wildcard characters: False 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 - - Network Service: Full Control - - System: Full Control ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -254,6 +255,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -265,10 +267,11 @@ Accept wildcard characters: False The MailboxDeliveryAgentLogEnabled parameter specifies whether the agent log for the Mailbox Transport Delivery service is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -288,6 +291,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -301,13 +305,9 @@ The MailboxDeliveryAgentLogMaxDirectorySize parameter specifies the maximum size When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -319,6 +319,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -332,13 +333,9 @@ The MailboxDeliveryAgentLogMaxFileSize parameter specifies the maximum size of e When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -350,6 +347,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -365,6 +363,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -380,6 +379,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -391,14 +391,14 @@ Accept wildcard characters: False 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. - - 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: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -410,14 +410,14 @@ Accept wildcard characters: False 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 - - $false: Mail can't be delivered to local mailboxes that have international characters in email addresses. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2019 + Required: False Position: Named Default value: None @@ -429,10 +429,11 @@ Accept wildcard characters: False The MailboxDeliveryThrottlingLogEnabled parameter specifies whether the mailbox delivery throttling log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -452,6 +453,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -465,13 +467,9 @@ The MailboxDeliveryThrottlingLogMaxDirectorySize parameter specifies the maximum When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -483,6 +481,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -496,13 +495,9 @@ The MailboxDeliveryThrottlingLogMaxFileSize parameter specifies the maximum size When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -514,6 +509,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -529,6 +525,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -540,10 +537,11 @@ Accept wildcard characters: False The MailboxSubmissionAgentLogEnabled parameter specifies whether the agent log is enabled for the Mailbox Transport Submission service. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -563,6 +561,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -576,13 +575,9 @@ The MailboxSubmissionAgentLogMaxDirectorySize parameter specifies the maximum si When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -594,6 +589,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -607,13 +603,9 @@ The MailboxSubmissionAgentLogMaxFileSize parameter specifies the maximum size of When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -625,6 +617,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -640,6 +633,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -655,6 +649,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -670,6 +665,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -681,10 +677,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -693,12 +690,14 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath -The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Mailbox\\Hub\\PipelineTracing. The path must be local to the Exchange computer. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. Pipeline tracing captures the complete contents of 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: +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. -- Administrators: Full Control +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. -- Network Service: Full Control +Pipeline 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 +- Network Service: Full Control - System: Full Control ```yaml @@ -706,6 +705,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -721,6 +721,7 @@ Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -744,6 +745,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -759,13 +761,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -779,6 +777,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -794,13 +793,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -814,6 +809,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -831,6 +827,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -850,6 +847,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -863,13 +861,9 @@ The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -881,6 +875,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -896,6 +891,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -917,6 +913,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -932,13 +929,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -952,6 +945,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -967,13 +961,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -987,6 +977,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -998,7 +989,6 @@ Accept wildcard characters: False 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. - - Delivery: Protocol log files for side effect messages that are submitted after messages are delivered to mailboxes. For example, a message delivered to a mailbox triggers an Inbox rule that redirects the message to another recipient. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for the intra-organization Send connector in the Mailbox Transport Submission service. To disable protocol logging for this connector, use the value None for the IntraOrgConnectorProtocolLoggingLevel parameter on the Set-TransportService cmdlet. @@ -1008,6 +998,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1023,6 +1014,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1031,20 +1023,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/72ed234d-cd25-4070-a5b2-ae5f056cc6a0.aspx) diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md new file mode 100644 index 0000000000..97910b18d9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -0,0 +1,727 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MalwareFilterPolicy cmdlet to modify malware filter policies in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MalwareFilterPolicy [-Identity] + [-Action ] + [-AdminDisplayName ] + [-BypassInboundMessages ] + [-BypassOutboundMessages ] + [-Confirm] + [-CustomAlertText ] + [-CustomExternalBody ] + [-CustomExternalSubject ] + [-CustomFromAddress ] + [-CustomFromName ] + [-CustomInternalBody ] + [-CustomInternalSubject ] + [-CustomNotifications ] + [-DomainController ] + [-EnableExternalSenderAdminNotifications ] + [-EnableExternalSenderNotifications ] + [-EnableFileFilter ] + [-EnableInternalSenderAdminNotifications ] + [-EnableInternalSenderNotifications ] + [-ExternalSenderAdminAddress ] + [-FileTypeAction ] + [-FileTypes ] + [-InternalSenderAdminAddress ] + [-IsPolicyOverrideApplied ] + [-MakeDefault] + [-QuarantineTag ] + [-WhatIf] + [-ZapEnabled ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MalwareFilterPolicy -Identity "Contoso Malware Filter Policy" -Action DeleteMessage -EnableInternalSenderAdminNotifications $true -InternalSenderAdminAddress admin@contoso.com +``` + +In on-premises Exchange, this example modifies the malware filter policy named Contoso Malware Filter Policy with the following settings: + +- Delete messages that contain malware. +- Don't notify the message sender when malware is detected in the message. +- Notify the administrator admin@contoso.com when malware is detected in a message from an internal sender. + +### Example 2 +```powershell +$FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes + +$FileTypesAdd += "dgz","mde" + +Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd +``` + +This example enables the common attachments filter in the malware filter policy named Default and adds the file types "dgz" and "mde" without affecting the other file type entries. + +### Example 3 +```powershell +$ft = Get-MalwareFilterPolicy -Identity Default + +$a = [System.Collections.ArrayList]($ft.FileTypes) + +$a + +$a.RemoveAt(6) + +Set-MalwareFilterPolicy -Identity Default -FileTypes $a +``` + +This example modifies the malware filter policy named Default by removing an existing file type from the common attachments filter without affecting other file types that are already specified. + +The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. Use the index number to specify the file type that you want to remove. + +The last two commands remove the seventh file type that's displayed in the list. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Action +This parameter is available only in on-premises Exchange. + +The Action parameter specifies the action to take when malware is detected in a message. Valid values are: + +- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. +- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. + +```yaml +Type: MalwareFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassInboundMessages +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassOutboundMessages +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAlertText +This parameter is available only in on-premises Exchange. + +The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomExternalBody +The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomExternalSubject +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: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFromAddress +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: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFromName +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: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomInternalBody +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: + +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomInternalSubject +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: + +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomNotifications +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. +- $false: No customization is done to notification messages. The default values are used. + +This parameter is meaningful only when the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExternalSenderAdminNotifications +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. + +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExternalSenderNotifications +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFileFilter +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. +- $false: The common attachments filter is disabled. + +You specify the file types using the FileTypes parameter. + +You specify the action for detected files using the FileTypeAction parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternalSenderAdminNotifications +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. + +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternalSenderNotifications +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalSenderAdminAddress +The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. + +This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeAction +This parameter is available only in the cloud-based service. + +The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: + +- Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the malware filter policy by the QuarantineTag parameter. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. + +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. + +```yaml +Type: FileTypeFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypes +This parameter is available only in the cloud-based service. + +The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: + +`ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` + +This parameter is meaningful only if the value of the EnableFileFilter parameter is $true. + +The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. For example, an exe file renamed to txt is detected as an exe file. If true-typing fails or isn't supported for the specified file type, then extension matching is used. + +To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. + +To add or remove file types without affecting the other file type entries, see the Examples section in this topic. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalSenderAdminAddress +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsPolicyOverrideApplied +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +The MakeDefault switch makes this malware filter policy the default policy. You don't need to specify a value with this switch. + +The default malware filter policy has no recipient filters (is applied to everyone) and has the Priority value Lowest. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTag +This parameter is available only in the cloud-based service. + +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZapEnabled +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. +- $false: ZAP for malware is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md new file mode 100644 index 0000000000..9589a6fc72 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md @@ -0,0 +1,358 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MalwareFilterRule cmdlet to modify malware filter rules in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MalwareFilterRule [-Identity] + [-Comments ] + [-Confirm] + [-DomainController ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-MalwareFilterPolicy ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Anti-malware policies](https://learn.microsoft.com/defender-office-365/anti-malware-protection-about#anti-malware-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MalwareFilterRule "Contoso Recipients" -ExceptIfSentToMemberOf "Contoso Human Resources" +``` + +This example adds an exception to the malware filter rule named Contoso Recipients for members of the distribution group named Contoso Human Resources. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID, or distinguished name (DN) of the malware filter rule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: 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 wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareFilterPolicy +The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. + +You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID. + +You can't specify the default malware filter policy, and you can't specify a policy that's already associated with another malware filter rule. + +```yaml +Type: MalwareFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/Set-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md similarity index 86% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilteringServer.md rename to exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md index 99dd71d979..5766c7970f 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilteringServer.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MalwareFilteringServer @@ -13,32 +16,42 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MalwareFilteringServer cmdlet to configure the Malware agent settings in the Transport service on a Mailbox server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MalwareFilteringServer [-Identity] [-BypassFiltering <$true | $false>] - [-Confirm] [-DeferAttempts ] [-DeferWaitTime ] [-DomainController ] - [-ForceRescan <$true | $false>] [-MinimumSuccessfulEngineScans ] [-PrimaryUpdatePath ] - [-ScanErrorAction ] [-ScanTimeout ] [-SecondaryUpdatePath ] - [-UpdateFrequency ] [-UpdateTimeout ] [-WhatIf] [] +Set-MalwareFilteringServer [-Identity] + [-BypassFiltering ] + [-Confirm] + [-DeferAttempts ] + [-DeferWaitTime ] + [-DomainController ] + [-ForceRescan ] + [-MinimumSuccessfulEngineScans ] + [-PrimaryUpdatePath ] + [-ScanErrorAction ] + [-ScanTimeout ] + [-SecondaryUpdatePath ] + [-UpdateFrequency ] + [-UpdateTimeout ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MalwareFilteringServer Mailbox01 -UpdateFrequency 120 -DeferWaitTime 10 ``` This example sets the following Malware agent settings on the Mailbox server named Mailbox01: - Sets the update frequency interval to 2 hours - - Sets the time to wait between resubmit attempts to 10 minutes ## PARAMETERS @@ -47,11 +60,8 @@ This example sets the following Malware agent settings on the Mailbox server nam 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN ```yaml @@ -59,6 +69,7 @@ Type: MalwareFilteringServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -70,10 +81,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -84,8 +96,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -93,6 +104,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,6 +122,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -129,6 +142,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -146,6 +160,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -157,10 +172,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -176,6 +192,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -184,13 +201,14 @@ Accept wildcard characters: False ``` ### -PrimaryUpdatePath -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. +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 Default value: None @@ -202,10 +220,11 @@ Accept wildcard characters: False 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: Block | Allow +Type: MalwareScanErrorAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -221,6 +240,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -238,6 +258,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -253,6 +274,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -270,6 +292,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -285,6 +308,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -293,20 +317,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/54154f8c-3567-4d81-abc0-235f35f7ada8.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md similarity index 78% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md rename to exchange/exchange-ps/exchange/Set-ManagedContentSettings.md index 9264a16564..9606389193 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ManagedContentSettings @@ -11,34 +14,41 @@ monikerRange: "exchserver-ps-2010" ## SYNOPSIS This cmdlet is available only in Exchange Server 2010. -Use the Set-ManagedContentSettings cmdlet to modify existing managed content settingsfor a managed folder. +Use the Set-ManagedContentSettings cmdlet to modify existing managed content settings for a managed folder. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ManagedContentSettings [-Identity] - [-AddressForJournaling ] [-AgeLimitForRetention ] [-Confirm] - [-DomainController ] [-JournalingEnabled <$true | $false>] [-LabelForJournaling ] - [-MessageFormatForJournaling ] [-MoveToDestinationFolder ] + [-AddressForJournaling ] + [-AgeLimitForRetention ] + [-Confirm] + [-DomainController ] + [-JournalingEnabled ] + [-LabelForJournaling ] + [-MessageFormatForJournaling ] + [-MoveToDestinationFolder ] [-Name ] - [-RetentionAction ] - [-RetentionEnabled <$true | $false>] [-TriggerForRetention ] [-WhatIf] + [-RetentionAction ] + [-RetentionEnabled ] + [-TriggerForRetention ] + [-WhatIf] [] ``` ## 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. +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. +Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ManagedContentSettings -Identity MyManagedContentSettings -AddressForJournaling MySmtpAddress@contoso.com ``` @@ -54,6 +64,7 @@ Type: ELCContentSettingsIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -62,13 +73,21 @@ Accept wildcard characters: False ``` ### -AddressForJournaling -The AddressForJournaling parameter specifies the address of the journaling recipient that's the destination of journaling operations. +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -86,6 +105,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -96,8 +116,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -105,6 +124,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -120,6 +140,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -131,10 +152,11 @@ Accept wildcard characters: False The JournalingEnabled parameter specifies that journaling is enabled when it's set to $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -150,6 +172,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -161,14 +184,14 @@ Accept wildcard characters: False 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 - - UseTnef Outlook MAPI format ```yaml -Type: UseMsg | UseTnef +Type: JournalingFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -184,6 +207,7 @@ Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -199,6 +223,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -210,22 +235,19 @@ Accept wildcard characters: False 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 - - Move to a managed custom folder - - Move to the Deleted Items folder - - Delete and allow recovery - - Permanently delete If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml -Type: MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit | MoveToArchive +Type: RetentionAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -237,10 +259,11 @@ Accept wildcard characters: False The RetentionEnabled parameter specifies that retention is enabled when it's set to $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -254,16 +277,16 @@ The TriggerForRetention parameter specifies the date that's considered as the st Valid values include: - WhenDelivered The item expires based on when it was delivered. - - WhenMoved The item expires based on the date it was moved. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml -Type: WhenDelivered | WhenMoved +Type: RetentionDateType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -279,6 +302,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -287,20 +311,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/25a7d9d2-97f1-41aa-b24e-0c95cb0aded1.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedFolder.md b/exchange/exchange-ps/exchange/Set-ManagedFolder.md similarity index 82% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedFolder.md rename to exchange/exchange-ps/exchange/Set-ManagedFolder.md index 7cc8f52117..aef4960fcd 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/Set-ManagedFolder.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ManagedFolder @@ -13,15 +16,24 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ManagedFolder cmdlet to modify the settings of managed folders. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ManagedFolder [-Identity] [-BaseFolderOnly <$true | $false>] [-Comment ] - [-Confirm] [-DomainController ] [-FolderName ] [-LocalizedComment ] - [-LocalizedFolderName ] [-MustDisplayCommentEnabled <$true | $false>] [-Name ] - [-StorageQuota ] [-WhatIf] [] +Set-ManagedFolder [-Identity] + [-BaseFolderOnly ] + [-Comment ] + [-Confirm] + [-DomainController ] + [-FolderName ] + [-LocalizedComment ] + [-LocalizedFolderName ] + [-MustDisplayCommentEnabled ] + [-Name ] + [-StorageQuota ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -29,12 +41,12 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ManagedFolder MyManagedFolder -StorageQuota 100KB ``` @@ -50,6 +62,7 @@ Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -61,10 +74,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -80,6 +94,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -90,8 +105,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -99,6 +113,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -114,6 +129,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -129,6 +145,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -144,6 +161,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -159,6 +177,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -170,10 +189,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -189,6 +209,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -204,6 +225,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -219,6 +241,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -227,20 +250,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88a3c359-acf0-4757-915f-28e0dfc22605.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md index d1a0961245..4e82b118b4 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ManagedFolderMailboxPolicy @@ -13,31 +16,36 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ManagedFolderMailboxPolicy cmdlet to change the settings of a managed folder mailbox policy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ManagedFolderMailboxPolicy [-Identity] [-Confirm] [-DomainController ] - [-ManagedFolderLinks ] [-Name ] [-WhatIf] [] +Set-ManagedFolderMailboxPolicy [-Identity] + [-Confirm] + [-DomainController ] + [-ManagedFolderLinks ] + [-Name ] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ManagedFolderMailboxPolicy "PM Storage Template1" -Name "PM Storage Template2" ``` 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 Parameters (https://technet.microsoft.com/library/bb124388.aspx). +The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-ManagedFolderMailboxPolicy -Identity "My Managed Folder Mailbox Policy" -ManagedFolderLinks "Custom Folder 1", "Custom Folder 2" ``` @@ -53,6 +61,7 @@ Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -63,8 +72,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -72,6 +80,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -87,6 +96,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -102,6 +112,7 @@ Type: ELCFolderIdParameter[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -117,6 +128,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -132,6 +144,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -140,20 +153,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bc60f748-2ab6-47a2-b4af-e9b7fb9bae3f.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md similarity index 75% rename from exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementRoleAssignment.md rename to exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md index 2fe05a50dd..44d3d2ad77 100644 --- a/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ManagementRoleAssignment @@ -13,19 +16,20 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ManagementRoleAssignment cmdlet to modify existing management role assignments. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### RelativeRecipientWriteScope ``` -Set-ManagementRoleAssignment [-Identity] [-RecipientRelativeWriteScope ] +Set-ManagementRoleAssignment [-Identity] [-RecipientRelativeWriteScope ] [-Confirm] [-CustomConfigWriteScope ] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### CustomRecipientWriteScope @@ -34,9 +38,10 @@ Set-ManagementRoleAssignment [-Identity] [-CustomCon [-Confirm] [-CustomRecipientWriteScope ] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### RecipientOrganizationalUnitScope @@ -45,9 +50,10 @@ Set-ManagementRoleAssignment [-Identity] [-Recipient [-Confirm] [-CustomConfigWriteScope ] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### ExclusiveScope @@ -55,9 +61,10 @@ Set-ManagementRoleAssignment [-Identity] [-Recipient Set-ManagementRoleAssignment [-Identity] [-ExclusiveConfigWriteScope ] [-ExclusiveRecipientWriteScope ] [-Confirm] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] ``` ### RecipientAdministrativeUnitScope @@ -65,9 +72,30 @@ Set-ManagementRoleAssignment [-Identity] [-Exclusive Set-ManagementRoleAssignment [-Identity] -RecipientAdministrativeUnitScope [-Confirm] [-DomainController ] - [-Enabled <$true | $false>] + [-Enabled ] [-Force] - [-WhatIf] [] + [-WhatIf] + [] +``` + +### App +``` +Set-ManagementRoleAssignment [-Identity] [-CustomResourceScope ] + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +### RecipientGroupScope +``` +Set-ManagementRoleAssignment [-Identity] -RecipientGroupScope + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -75,35 +103,35 @@ When you modify a role assignment, you can specify a new predefined or custom ma You can create custom management scopes using the New-ManagementScope cmdlet and can view a list of existing scopes using the Get-ManagementScope cmdlet. If you choose not to specify an OU, predefined scope, or custom scope, the implicit write scope of the role applies to the role assignment. -For more information about management role assignments, see Understanding management role assignments (https://technet.microsoft.com/library/dd335131.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ManagementRoleAssignment "Mail Recipients_Denver Help Desk" -Enabled $false ``` This example disables the Mail Recipients\_Denver Help Desk role assignment. When a role assignment is disabled, the users assigned the role can no longer run cmdlets granted by the role. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-ManagementRoleAssignment "MyGAL_KimA" -RecipientRelativeWriteScope MyGAL ``` This example changes the recipient scope for the MyGAL\_KimA role assignment to MyGAL. When the recipient scope is changed to a predefined value, any previously defined OUs or custom scopes are overwritten. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-ManagementRoleAssignment "Mail Recipients_Marketing Admins" -RecipientOrganizationalUnitScope "contoso.com/North America/Marketing/Users" ``` This example restricts the Mail Recipients\_Marketing Admins role assignment to the contoso.com/North America/Marketing/Users OU. Users who are members of the Marketing Admins role group assigned the role assignment can create, modify, and remove objects only in the specified OU. When the RecipientOrganizationalUnitScope parameter is used, any predefined or custom scopes on the role assignment are overwritten. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Set-ManagementRoleAssignment "Distribution Groups_Cairns Admins" -CustomRecipientWriteScope "Cairns Recipients" ``` @@ -119,6 +147,7 @@ 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 Default value: None @@ -126,11 +155,50 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -RecipientAdministrativeUnitScope +This parameter is functional only in the cloud-based service. + +The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. + +Administrative units are Microsoft Entra containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. + +You can't use this parameter with any of the other scope parameters. + +```yaml +Type: AdministrativeUnitIdParameter +Parameter Sets: RecipientAdministrativeUnitScope +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientGroupScope +This parameter is available only in the cloud-based service. + +The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. + +```yaml +Type: GroupIdParameter +Parameter Sets: RecipientGroupScope +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -138,6 +206,7 @@ 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 @@ -159,6 +228,7 @@ 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 Default value: None @@ -178,6 +248,33 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomResourceScope +This parameter is available only in the cloud-based service. + +The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +If the value contains spaces, enclose the value in quotation marks ("). + +You use this parameter with the App parameter to assign permissions to service principals. For more information, see For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +```yaml +Type: ManagementScopeIdParameter +Parameter Sets: App +Aliases: +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -192,9 +289,10 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: RelativeRecipientWriteScope, CustomRecipientWriteScope, RecipientOrganizationalUnitScope, ExclusiveScope, RecipientAdministrativeUnitScope Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -206,10 +304,11 @@ Accept wildcard characters: False The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. ```yaml -Type: $true | $false +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 Default value: None @@ -231,6 +330,7 @@ Type: ManagementScopeIdParameter Parameter Sets: ExclusiveScope Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -250,21 +350,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -272,21 +358,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RecipientAdministrativeUnitScope +### -Force This parameter is available only in the cloud-based service. -The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - -You can't use this parameter with any of the other scope parameters. +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml -Type: AdministrativeUnitIdParameter -Parameter Sets: RecipientAdministrativeUnitScope +Type: SwitchParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -305,6 +390,7 @@ 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 Default value: None @@ -322,10 +408,11 @@ The available types are: None, Organization, MyGAL, Self and MyDistributionGroup 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're used internally by the cmdlet. ```yaml -Type: None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate +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 Default value: None @@ -341,6 +428,7 @@ 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 @@ -349,20 +437,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2e0659f9-dfb6-4d91-93fb-35a6a7f8a449.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md new file mode 100644 index 0000000000..ee811f9b5f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md @@ -0,0 +1,269 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-ManagementRoleEntry cmdlet to change the available parameters on an existing management role entry. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ManagementRoleEntry [-Identity] + [-AddParameter] + [-Confirm] + [-DomainController ] + [-Force] + [-Parameters ] + [-RemoveParameter] + [-UnScopedTopLevel] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-ManagementRoleEntry cmdlet changes the available parameters on an existing role entry. If you want to add parameters to a role entry, the parameters must exist in the role entry in the parent management role. If you want to remove parameters from a role entry, there can be no role entries in child roles that inherit those parameters from the role entry you want to change. You can't change role entries associated with built-in roles. + +For more information about management role entries, see [Understanding management roles](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ManagementRoleEntry "Help Desk Personnel\Get-Mailbox" -Parameters "Anr","Database" -RemoveParameter +``` + +This example removes the Anr and Database parameters from the Get-Mailbox role entry on the Help Desk Personnel role. + +### Example 2 +```powershell +Get-ManagementRoleEntry "Help Desk Personnel\*" | Set-ManagementRoleEntry -Parameters WhatIf -AddParameter +``` + +This example retrieves a list of role entries on the Help Desk Personnel role and adds the WhatIf switch to each role entry using the Set-ManagementRoleEntry cmdlet. + +### Example 3 +```powershell +Set-ManagementRoleEntry "Tier 1 Help Desk\Set-Mailbox" -Parameters "DisplayName","ForwardingAddress" +``` + +This example adds the DisplayName and ForwardingAddress parameters to the Set-Mailbox role entry on the Tier 1 Help Desk role and removes all other parameters from the role entry. + +### Example 4 +```powershell +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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the role entry that you want to modify. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). + +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). + +If the role entry name contains spaces, enclose it in quotation marks ("). + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AddParameter +The AddParameter switch specifies that you're adding parameters to the specified role entry. You don't need to specify a value with this switch. + +Use the Parameters parameter to specify the parameters to add. + +You can't use the AddParameter switch and the RemoveParameter switch together in the same command. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +The Parameters parameter specifies the parameters to be added to or removed from the role entry. + +The Parameters parameter has the following modes: + +- When used with the AddParameter parameter, the parameters you specify are added to the role entry. +- When used with the RemoveParameter parameter, the parameters you specify are removed from the role entry. +- When neither the AddParameter nor RemoveParameter parameters are used, only the parameters you specify are included in the role entry. If you specify a value of $Null and neither the AddParameter nor RemoveParameter parameters are used, all of the parameters on the role entry are removed. + +You can specify multiple parameters, separated with commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveParameter +The RemoveParameter switch specifies that you're removing parameters to the specified role entry. You don't need to specify a value with this switch. + +Use the Parameters parameter to specify the parameters to remove. + +You can't use the AddParameter switch and the RemoveParameter switch together in the same command. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnScopedTopLevel +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). + +The UnScopedTopLevel switch specifies the role entry that you want to modify is on an unscoped top-level role. You don't need to specify a value with this switch. + +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ManagementScope.md b/exchange/exchange-ps/exchange/Set-ManagementScope.md new file mode 100644 index 0000000000..7d84c230ae --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ManagementScope.md @@ -0,0 +1,319 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-ManagementScope cmdlet to change an existing management scope. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### DatabaseFilter +``` +Set-ManagementScope [-Identity] -DatabaseRestrictionFilter + [-Confirm] + [-DomainController ] + [-Force] + [-Name ] + [-WhatIf] + [] +``` + +### ServerFilter +``` +Set-ManagementScope [-Identity] -ServerRestrictionFilter + [-Confirm] + [-DomainController ] + [-Force] + [-Name ] + [-WhatIf] + [] +``` + +### RecipientFilter +``` +Set-ManagementScope [-Identity] + [-RecipientRestrictionFilter ] + [-RecipientRoot ] + [-Confirm] + [-DomainController ] + [-Force] + [-Name ] + [-WhatIf] + [] +``` + +## 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). + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ManagementScope "Seattle Mailboxes" -RecipientRestrictionFilter "City -eq 'Seattle' -and RecipientType -eq 'UserMailbox'" +``` + +This example changes the recipient restriction filter on the Seattle Mailboxes management scope to match all mailboxes that have Seattle in the City mailbox property. + +### Example 2 +```powershell +Set-ManagementScope "Sales Recipients" -RecipientRoot contoso.com/Sales +``` + +This example changes the recipient root for the Sales Recipients management scope to match only recipient objects contained under the contoso.com/Sales OU. + +### Example 3 +```powershell +Set-ManagementScope "Vancouver Servers" -ServerRestrictionFilter "ServerSite -eq 'NA-CDN-Vancouver,CN=Sites,CN=Configuration,DC=contoso,DC=com"}'" +``` + +This example changes the Active Directory site used in the server restriction filter for the Vancouver Servers management scope to "NA-CDN-Vancouver,CN=Sites,CN=Configuration,DC=contoso,DC=com". + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -DatabaseRestrictionFilter +This parameter is available only in on-premises Exchange. + +The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable database properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter with the RecipientRestrictionFilter, ServerRestrictionFilter, RecipientRoot, DatabaseList, or ServerList parameters. + +```yaml +Type: String +Parameter Sets: DatabaseFilter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerRestrictionFilter +This parameter is available only in on-premises Exchange. + +The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable server properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerList parameters. + +```yaml +Type: String +Parameter Sets: ServerFilter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientRestrictionFilter +The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable recipient property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientRoot +The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: + +- Name +- Canonical name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the ServerRestrictionFilter or DatabaseRestrictionFilter parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 +Use two-letter country codes (ISO 3166-1 alpha-2) instead of the full country name in filters. For example, use `-RecipientRestrictionFilter "UsageLocation -eq 'FR'"` for France. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md new file mode 100644 index 0000000000..ec322afd70 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md @@ -0,0 +1,291 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-MapiVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-MapiVirtualDirectory cmdlet to modify Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MapiVirtualDirectory [-Identity] + [-ApplyDefaults ] + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-IISAuthenticationMethods ] + [-InternalUrl ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" -InternalUrl https://contoso.com/mapi -IISAuthenticationMethods NTLM,Negotiate,OAuth +``` + +This example makes the following configuration changes to the MAPI virtual directory on the default web site of the server named ContosoMail: + +- Internal URL: `https://contoso/mapi`. +- IIS authentication methods: NTLM, Negotiate, and OAuth. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ApplyDefaults +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionFlags +The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: + +- None: This is the default setting. +- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. +- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. +- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionSPNList +The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: + +- $null: This is the default value. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionTokenChecking +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: + +- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. + +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. + +```yaml +Type: ExtendedProtectionTokenCheckingMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUrl +The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. + +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`). + +When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IISAuthenticationMethods +The IISAuthenticationMethods parameter specifies the authentication methods that are enabled on the virtual directory in Internet Information Services (IIS). Valid values are: + +- Basic +- Negotiate +- NTLM +- OAuth + +You can specify multiple values separated by commas. + +The default values are NTLM, OAuth, and Negotiate. We recommend that you always have the virtual directory configured for OAuth. + +For more information about the different authentication methods, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication) and [What is OAuth authentication?](https://learn.microsoft.com/exchange/using-oauth-authentication-to-support-ediscovery-in-an-exchange-hybrid-deployment-exchange-2013-help#what-is-oauth-authentication). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalUrl +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`). + +When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Set-MessageClassification.md b/exchange/exchange-ps/exchange/Set-MessageClassification.md new file mode 100644 index 0000000000..4c48abce78 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MessageClassification.md @@ -0,0 +1,295 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MessageClassification cmdlet to configure an existing message classification instance in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MessageClassification [-Identity] + [-ClassificationID ] + [-Confirm] + [-DisplayName ] + [-DisplayPrecedence ] + [-DomainController ] + [-Name ] + [-PermissionMenuVisible ] + [-RecipientDescription ] + [-RetainClassificationEnabled ] + [-SenderDescription ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MessageClassification -Identity "My Message Classification" -DisplayPrecedence Low -RetainClassificationEnabled $false +``` + +This example makes the following configuration changes to the message classification named My Message Classification: + +- Changes the display precedence to Low. +- Specifies that the message classification shouldn't persist with the message if the message is forwarded or replied to. + +## PARAMETERS + +### -Identity +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 +- Identity: `Default\` or `\`; for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`. +- ClassificationID (GUID) + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ClassificationID +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 ""`. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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. + +```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 +Default value: None +Accept pipeline input: False +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: + +- Highest +- Higher +- High +- MediumHigh +- Medium (This is the 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionMenuVisible +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDescription +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainClassificationEnabled +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDescription +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MigrationBatch.md b/exchange/exchange-ps/exchange/Set-MigrationBatch.md new file mode 100644 index 0000000000..17981b8c20 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MigrationBatch.md @@ -0,0 +1,559 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MigrationBatch [-Identity] + [-AddUsers] + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-ApproveSkippedItems] + [-AutoRetryCount ] + [-BadItemLimit ] + [-CSVData ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-LargeItemLimit ] + [-MoveOptions ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipMerging ] + [-SkipMoving ] + [-SkipReports ] + [-SourcePublicFolderDatabase ] + [-StartAfter ] + [-SyncNow] + [-Update] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-MigrationBatch cmdlet configures your existing migration batches to migrate mailboxes and mailbox data in one of the following scenarios: + +- Local move +- Cross-forest move +- Remote move +- Cutover Exchange migration +- Staged Exchange migration +- 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MigrationBatch -Identity MigrationBatch01 -ApproveSkippedItems +``` + +This example updates MigrationBatch01 by approving all of the skipped items for all of the users in the batch that were detected previously. + +## PARAMETERS + +### -Identity +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) +- GUID (the BatchGuid property value) + +```yaml +Type: MigrationBatchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AddUsers +This parameter is available only in the cloud-based service. + +{{ Fill AddUsers Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIncrementalSyncs +This parameter is available only in on-premises Exchange. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUnknownColumnsInCsv +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApproveSkippedItems +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. + +For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRetryCount +This parameter is available only in on-premises Exchange. + +The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors. + +```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: False +Accept wildcard characters: False +``` + +### -BadItemLimit +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 you don't use this parameter, Skipped Item approval semantics will be 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompleteAfter +This parameter is functional only in the cloud-based service. + +The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +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. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CSVData +The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +**Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes that are specified in the CSV file will be migrated, even if they are outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. + +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 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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveOptions +The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. + +Don't use this parameter with the SkipMoving parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmails +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. + +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportInterval +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. + +This parameter should only be used in the cloud-based service. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMoving +This parameter has been 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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipReports +The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePublicFolderDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartAfter +The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration will be prepared, but the actual data migration for users within the batch won't start until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +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. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncNow +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Update +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MigrationConfig.md b/exchange/exchange-ps/exchange/Set-MigrationConfig.md new file mode 100644 index 0000000000..99bb6f912b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MigrationConfig.md @@ -0,0 +1,201 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MigrationConfig cmdlet to edit migration configurations on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MigrationConfig + [-Confirm] + [-DomainController ] + [-Features ] + [-MaxConcurrentMigrations ] + [-MaxNumberOfBatches ] + [-Partition ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MigrationConfig -MaxNumberOfBatches 50 +``` + +This example sets the migration system to have a maximum of 50 batches at any time. + +### Example 2 +```powershell +Set-MigrationConfig -MaxConcurrentMigrations 100 +``` + +This example sets the migration system to only allow 100 concurrent migrations. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Features +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: + +- None +- MultiBatch +- Endpoints +- UpgradeBlock + +```yaml +Type: MigrationFeature +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConcurrentMigrations +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxNumberOfBatches +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. + +```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: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md new file mode 100644 index 0000000000..cade570874 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md @@ -0,0 +1,535 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MigrationEndpoint cmdlet to edit settings for cutover or staged Exchange migrations, IMAP migrations, Google Workspace (formerly G Suite) migrations, and remote moves. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MigrationEndpoint [-Identity] + [-AcceptUntrustedCertificates ] + [-ApplicationId ] + [-AppSecretKeyVaultUrl ] + [-Authentication ] + [-Confirm] + [-Credentials ] + [-DomainController ] + [-ExchangeServer ] + [-MailboxPermission ] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-NspiServer ] + [-Partition ] + [-Port ] + [-PublicFolderDatabaseServerLegacyDN ] + [-RemoteServer ] + [-RpcProxyServer ] + [-Security ] + [-ServiceAccountKeyFileData ] + [-SkipVerification] + [-SourceMailboxLegacyDN ] + [-TestMailbox ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Set-MigrationEndpoint cmdlet to configure settings for different types of migration: + +- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a RemoteMove endpoint. +- Remote move: In a hybrid deployment, a remote move involves onboarding or offboarding migrations. Remote moves require the use of a RemoteMove endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online, and uses a RemoteMove endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online to an on-premises Exchange organization and uses a RemoteMove endpoint as the target endpoint of the migration batch. +- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online. Cutover Exchange migration requires the use of an Exchange endpoint. +- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online. Staged Exchange migration requires the use of an Exchange endpoint. +- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. +- Gmail migration: Migration mailbox data from a Google Workspace tenant to Exchange Online. For a Google Workspace migration, you must first create the cloud-based mail users or mailboxes before you migrate mailbox data. Google Workspace migrations require the use of a Gmail endpoint. +- Local: Move mailboxes between different servers or databases within a single on-premises Exchange forest. Local moves don't require the use of an endpoint. + +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) + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MigrationEndpoint -Identity CutoverExchangeEndpoint01 -MaxConcurrentIncrementalSyncs 50 -NspiServer Server01.contoso.com +``` + +This example changes the MaxConcurrentIncrementalSyncs setting to 50 on the CutoverExchangeEndpoint01 migration endpoint using the NSPI server Server01. + +### Example 2 +```powershell +Set-MigrationEndpoint -Identity Onboardingmigrationendpoint01 -MaxConcurrentMigrations 10 -RemoteServer Server01.contoso.com +``` + +This example changes the MaxConcurrentMigrations setting to 10 on the Onboardingmigrationendpoint01 migration endpoint using the remote server, Server01. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptUntrustedCertificates +This parameter is available only in the cloud-based service. + +{{ Fill AcceptUntrustedCertificates Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +This parameter is available only in the cloud-based service. + +{{ Fill ApplicationId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSecretKeyVaultUrl +This parameter is available only in the cloud-based service. + +{{ Fill AppSecretKeyVaultUrl Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +This parameter is available only in the cloud-based service. + +The Authentication parameter specifies the authentication method used by the remote mail server. + +```yaml +Type: AuthenticationMethod +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -Credentials +The Credentials parameter specifies the username and password for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeServer +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxPermission +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. + +The account specified must have the following permissions: + +- FullAccess permission. The account has Full-Access permission to the mailboxes they want to migrate. +- Admin permission. The account is a domain administrator who can access any mailbox they want to migrate. + +```yaml +Type: MigrationMailboxPermission +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConcurrentIncrementalSyncs +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NspiServer +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderDatabaseServerLegacyDN +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteServer +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. +- IMAP moves: The FQDN of the IMAP server. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpcProxyServer +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 + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Security +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. + +```yaml +Type: IMAPSecurityMechanism +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipVerification +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMailboxLegacyDN +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestMailbox +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. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MigrationUser.md b/exchange/exchange-ps/exchange/Set-MigrationUser.md new file mode 100644 index 0000000000..9a4d3dc9f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MigrationUser.md @@ -0,0 +1,300 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-MigrationUser + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Set-MigrationUser cmdlet to modify the migration settings of a user in an existing migration batch. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MigrationUser [-Identity] + [-ApproveSkippedItems] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-LargeItemLimit ] + [-Partition ] + [-StartAfter ] + [-SyncNow] + [-WhatIf] + [] +``` + +## DESCRIPTION +Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MigrationUser -Identity laura@contoso.com -LargeItemLimit 15 -BadItemLimit 15 +``` + +This example changes the large item limit and bad item limit for the user laura@contoso.com in an existing migration batch. + +### Example 2 +```powershell +Set-MigrationUser -Identity laura@contoso.com -ApproveSkippedItems +``` + +This example approves all of the skipped items encountered for the user laura@contoso.com in an existing migration batch. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: MigrationUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ApproveSkippedItems +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. + +For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). + +You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompleteAfter +This parameter is available only in the cloud-based service. + +The CompleteAfter parameter specifies a delay before the user is completed. Data migration for the user will start, but won't complete until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. + +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 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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartAfter +This parameter is available only in the cloud-based service. + +The StartAfter parameter specifies a delay before the data migration for the user is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncNow +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/devices/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/devices/Set-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md index 1215b13e61..1a4006943c 100644 --- a/exchange/exchange-ps/exchange/devices/Set-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MobileDeviceMailboxPolicy schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-MobileDeviceMailboxPolicy @@ -13,41 +16,71 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MobileDeviceMailboxPolicy cmdlet to modify mobile device mailbox policies. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-MobileDeviceMailboxPolicy [-Identity] - [-AllowApplePushNotifications <$true | $false>] [-AllowBluetooth ] - [-AllowBrowser <$true | $false>] [-AllowCamera <$true | $false>] [-AllowConsumerEmail <$true | $false>] - [-AllowDesktopSync <$true | $false>] [-AllowExternalDeviceManagement <$true | $false>] - [-AllowGooglePushNotifications <$true | $false>] [-AllowHTMLEmail <$true | $false>] - [-AllowInternetSharing <$true | $false>] [-AllowIrDA <$true | $false>] - [-AllowMicrosoftPushNotifications <$true | $false>] [-AllowMobileOTAUpdate <$true | $false>] - [-AllowNonProvisionableDevices <$true | $false>] [-AllowPOPIMAPEmail <$true | $false>] - [-AllowRemoteDesktop <$true | $false>] [-AllowSimplePassword <$true | $false>] - [-AllowSMIMEEncryptionAlgorithmNegotiation ] - [-AllowSMIMESoftCerts <$true | $false>] [-AllowStorageCard <$true | $false>] - [-AllowTextMessaging <$true | $false>] [-AllowUnsignedApplications <$true | $false>] - [-AllowUnsignedInstallationPackages <$true | $false>] [-AllowWiFi <$true | $false>] - [-AlphanumericPasswordRequired <$true | $false>] [-ApprovedApplicationList ] - [-AttachmentsEnabled <$true | $false>] [-Confirm] [-DeviceEncryptionEnabled <$true | $false>] - [-DevicePolicyRefreshInterval ] [-DomainController ] [-IrmEnabled <$true | $false>] - [-IsDefault <$true | $false>] [-MaxAttachmentSize ] - [-MaxCalendarAgeFilter ] - [-MaxEmailAgeFilter ] - [-MaxEmailBodyTruncationSize ] [-MaxEmailHTMLBodyTruncationSize ] - [-MaxInactivityTimeLock ] [-MaxPasswordFailedAttempts ] - [-MinPasswordComplexCharacters ] [-MinPasswordLength ] [-Name ] - [-PasswordEnabled <$true | $false>] [-PasswordExpiration ] [-PasswordHistory ] - [-PasswordRecoveryEnabled <$true | $false>] [-RequireDeviceEncryption <$true | $false>] - [-RequireEncryptedSMIMEMessages <$true | $false>] - [-RequireEncryptionSMIMEAlgorithm ] - [-RequireManualSyncWhenRoaming <$true | $false>] [-RequireSignedSMIMEAlgorithm ] - [-RequireSignedSMIMEMessages <$true | $false>] [-RequireStorageCardEncryption <$true | $false>] - [-UnapprovedInROMApplicationList ] [-UNCAccessEnabled <$true | $false>] [-WhatIf] - [-WSSAccessEnabled <$true | $false>] [] + [-AllowApplePushNotifications ] + [-AllowBluetooth ] + [-AllowBrowser ] + [-AllowCamera ] + [-AllowConsumerEmail ] + [-AllowDesktopSync ] + [-AllowExternalDeviceManagement ] + [-AllowGooglePushNotifications ] + [-AllowHTMLEmail ] + [-AllowInternetSharing ] + [-AllowIrDA ] + [-AllowMicrosoftPushNotifications ] + [-AllowMobileOTAUpdate ] + [-AllowNonProvisionableDevices ] + [-AllowPOPIMAPEmail ] + [-AllowRemoteDesktop ] + [-AllowSimplePassword ] + [-AllowSMIMEEncryptionAlgorithmNegotiation ] + [-AllowSMIMESoftCerts ] + [-AllowStorageCard ] + [-AllowTextMessaging ] + [-AllowUnsignedApplications ] + [-AllowUnsignedInstallationPackages ] + [-AllowWiFi ] + [-AlphanumericPasswordRequired ] + [-ApprovedApplicationList ] + [-AttachmentsEnabled ] + [-Confirm] + [-DeviceEncryptionEnabled ] + [-DevicePolicyRefreshInterval ] + [-DomainController ] + [-IrmEnabled ] + [-IsDefault ] + [-MaxAttachmentSize ] + [-MaxCalendarAgeFilter ] + [-MaxEmailAgeFilter ] + [-MaxEmailBodyTruncationSize ] + [-MaxEmailHTMLBodyTruncationSize ] + [-MaxInactivityTimeLock ] + [-MaxPasswordFailedAttempts ] + [-MinPasswordComplexCharacters ] + [-MinPasswordLength ] + [-Name ] + [-PasswordEnabled ] + [-PasswordExpiration ] + [-PasswordHistory ] + [-PasswordRecoveryEnabled ] + [-RequireDeviceEncryption ] + [-RequireEncryptedSMIMEMessages ] + [-RequireEncryptionSMIMEAlgorithm ] + [-RequireManualSyncWhenRoaming ] + [-RequireSignedSMIMEAlgorithm ] + [-RequireSignedSMIMEMessages ] + [-RequireStorageCardEncryption ] + [-UnapprovedInROMApplicationList ] + [-UNCAccessEnabled ] + [-WhatIf] + [-WSSAccessEnabled ] + [] ``` ## DESCRIPTION @@ -55,26 +88,28 @@ Mobile device mailbox policies define settings for mobile devices that are used Some mobile device mailbox policy settings require the mobile device to have specific built-in features that enforce these security and device management settings. If your organization allows all devices, you must set the AllowNonProvisionableDevices parameter to $true. This applies to devices that can't enforce all policy settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/secure-outlook-for-ios-and-android#leveraging-exchange-online-mobile-device-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-MobileDeviceMailboxPolicy -Identity "Sales Policy" -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -AttachmentsEnabled $true -MaxInactivityTimeLock 15:00 -IsDefault $false ``` This example sets several policy settings for the mobile device mailbox policy Sales Policy. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-MobileDeviceMailboxPolicy -Identity Management -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -AllowCamera $true -AllowWiFi $false -AllowStorageCard $true -AllowPOPIMAPEmail $false ``` This example sets several policy settings for the mobile device mailbox policy Management. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-MobileDeviceMailboxPolicy -Identity Default -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -AllowWiFi $false -AllowStorageCard $true -AllowPOPIMAPEmail $false -IsDefault $true -AllowTextMessaging $true -Confirm $true ``` @@ -86,9 +121,7 @@ This example sets several policy settings for the mobile device mailbox policy D The Identity parameter specifies the mobile device mailbox policy. You can use any value that uniquely identifies the policy. For example: - Name - - Distinguished name (DN) - - GUID The name of the built-in mobile device mailbox policy is Default. @@ -98,6 +131,7 @@ Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -111,10 +145,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -123,13 +158,22 @@ Accept wildcard characters: False ``` ### -AllowBluetooth -The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. +The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: + +- Allow (this is the default value). +- Disable +- HandsfreeOnly + +The values Allow or HandsfreeOnly allow synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. + +The value Disable disables synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. Any previously synchronized data is deleted. This value does not disable Bluetooth on the Android device or the wearable device, nor does it affect other Android wearable apps. ```yaml -Type: Disable | HandsfreeOnly | Allow +Type: BluetoothType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -141,10 +185,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -156,10 +201,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -171,10 +217,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -186,10 +233,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -201,10 +249,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -218,10 +267,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -233,10 +283,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -248,10 +299,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -263,10 +315,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -280,10 +333,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -295,10 +349,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -312,10 +367,11 @@ The AllowNonProvisionableDevices parameter specifies whether all mobile devices 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -327,10 +383,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -342,10 +399,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -357,10 +415,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -372,18 +431,17 @@ Accept wildcard characters: False 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 - - BlockNegotiation - - OnlyStrongAlgorithmNegotiation The default value is AllowAnyAlgorithmNegotiation. ```yaml -Type: BlockNegotiation | OnlyStrongAlgorithmNegotiation | AllowAnyAlgorithmNegotiation +Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -395,10 +453,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -410,10 +469,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -425,10 +485,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -440,10 +501,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -455,10 +517,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -470,10 +533,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -485,10 +549,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -504,6 +569,7 @@ Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -517,10 +583,11 @@ The AttachmentsEnabled parameter specifies whether attachments can be downloaded When set to $false, this parameter blocks the user from downloading attachments on the mobile device. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -531,15 +598,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -548,15 +615,18 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled +**Note**: This setting is supported by Outlook for iOS and Android. + The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, device encryption is enabled on the mobile device. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -576,6 +646,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -593,6 +664,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -604,10 +676,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -621,10 +694,11 @@ The IsDefault parameter specifies whether this policy is the default mobile devi 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -640,9 +714,7 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo The maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2\*1024^3), so these are the maximum qualified values you can use with this parameter. - 2097151KB - - 2047.999024MB - - 1.999999047GB ```yaml @@ -650,6 +722,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -661,22 +734,19 @@ Accept wildcard characters: False 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 - - TwoWeeks - - OneMonth - - ThreeMonths - - SixMonths The default value is All. ```yaml -Type: All | TwoWeeks | OneMonth | ThreeMonths | SixMonths +Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -688,24 +758,20 @@ Accept wildcard characters: False 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 - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth The default value is All. ```yaml -Type: All | OneDay | ThreeDays | OneWeek | TwoWeeks | OneMonth +Type: EmailAgeFilterType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -723,6 +789,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -740,6 +807,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -751,7 +819,6 @@ Accept wildcard characters: False 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. ```yaml @@ -759,6 +826,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -776,6 +844,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -787,11 +856,8 @@ Accept wildcard characters: False The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are: - Lower case letters. - - Upper case letters. - - Digits 0 through 9. - - Special characters (for example, exclamation marks). A valid value for this parameter is an integer from 1 through 4. The default value is 1. @@ -801,11 +867,8 @@ For Windows Phone 8 devices, the value specifies the number of character sets th For Windows Phone 10 devices, the value specifies the following password complexity requirements: - Digits only. - - Digits and lower case letters. - - Digits, lower case letters, and upper case letters. - - Digits, lower case letters, upper case letters and special characters. ```yaml @@ -813,6 +876,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -821,6 +885,8 @@ Accept wildcard characters: False ``` ### -MinPasswordLength +**Note**: This setting is supported by Outlook for Android. + The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. You can enter any number from 1 through 16 or the value $null. The default value is blank. The maximum password length is 16 characters. @@ -830,6 +896,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -845,6 +912,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -858,10 +926,11 @@ The PasswordEnabled parameter specifies whether a password is required on the mo When set to $true, this parameter requires the user to set a password on the mobile device. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -873,7 +942,6 @@ Accept wildcard characters: False 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 ```yaml @@ -881,6 +949,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -898,6 +967,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -911,10 +981,11 @@ The PasswordRecoveryEnabled parameter specifies whether the recovery password fo 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -926,10 +997,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -941,10 +1013,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -956,22 +1029,19 @@ Accept wildcard characters: False 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 - - TripleDES - - RC240bit - - RC264bit - - RC2128bit The default value is TripleDES. ```yaml -Type: TripleDES | DES | RC2128bit | RC264bit | RC240bit +Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -983,10 +1053,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1000,10 +1071,11 @@ The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to Valid values for this parameter are SHA1 or MD5. The default value is SHA1. ```yaml -Type: SHA1 | MD5 +Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1015,10 +1087,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1032,10 +1105,11 @@ The RequireStorageCardEncryption parameter specifies whether storage card encryp Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1051,6 +1125,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1062,10 +1137,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1080,7 +1156,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -1092,10 +1169,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1104,20 +1182,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e125023b-45a6-4078-9984-27a5005cca1d.aspx) diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/exchange/Set-MoveRequest.md new file mode 100644 index 0000000000..1d1ecd41fb --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MoveRequest.md @@ -0,0 +1,685 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-MoveRequest cmdlet to change move request options after the move request has been created. You can use the Set-MoveRequest cmdlet to recover from failed move requests. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MoveRequest [-Identity] + [-AcceptLargeDataLoss] + [-ArchiveTargetDatabase ] + [-BadItemLimit ] + [-BatchName ] + [-CompleteAfter ] + [-CompletedRequestAgeLimit ] + [-Confirm] + [-DomainController ] + [-IgnoreRuleLimitErrors ] + [-IncrementalSyncInterval ] + [-InternalFlags ] + [-LargeItemLimit ] + [-MoveOptions ] + [-PreventCompletion ] + [-Priority ] + [-Protect ] + [-ProxyToMailbox ] + [-RemoteCredential ] + [-RemoteGlobalCatalog ] + [-RemoteHostName ] + [-RequestExpiryInterval ] + [-SkipMoving ] + [-SkippedItemApprovalTime ] + [-SourceEndpoint ] + [-StartAfter ] + [-SuspendWhenReadyToComplete ] + [-TargetDatabase ] + [-WhatIf] + [] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-MoveRequest -Identity Ayla@humongousinsurance.com -BadItemLimit 5 +``` + +This example changes the move request for Ayla to accept up to five corrupt mailbox items. + +### Example 2 +```powershell +Set-MoveRequest -Identity Sruthi@contoso.com -SkippedItemApprovalTime $(Get-Date).ToUniversalTime() +``` + +This example changes the move request for Sruthi to approve all skipped items encountered before the current time. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: + +- GUID +- Distinguished name (DN) +- Domain\\Account +- User principal name (UPN) +- LegacyExchangeDN +- SMTP address +- Alias + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptLargeDataLoss +The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. + +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. + +In Exchange 2010, you need to use this switch if you set the BadItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveTargetDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompleteAfter +The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompletedRequestAgeLimit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreRuleLimitErrors +The IgnoreRuleLimitErrors parameter specifies that the command won't move 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 +Default value: None +Accept pipeline input: False +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. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is 24 hours. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalFlags +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. + +```yaml +Type: InternalMrsFlag[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +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: + +- 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. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveOptions +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventCompletion +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +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: + +- Lowest +- Lower +- Low +- Normal: This is the default value. +- High +- Higher +- Highest +- Emergency + +```yaml +Type: RequestPriority +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 +``` + +### -Protect +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyToMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteCredential +The RemoteCredential parameter specifies the username and password an administrator who has permission to perform the mailbox move. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteGlobalCatalog +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteHostName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMoving +This parameter has been 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. + +```yaml +Type: SkippableMoveComponent[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +This parameter is available only in the cloud-based service. + +{{ Fill SourceEndpoint Description }} + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartAfter +The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkippedItemApprovalTime +This parameter is available only in the cloud-based service. + +The SkippedItemApprovalTime parameter marks all of the skipped items discovered prior to the specified time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. + +For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendWhenReadyToComplete +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..68c9290d33 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md @@ -0,0 +1,177 @@ +--- +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 +ms.author: chrisda +--- + +# Set-MyAnalyticsFeatureConfig + +## 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 Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user. + +**Note**: This cmdlet replaces the Set-UserAnalyticsConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MyAnalyticsFeatureConfig -Identity + [-Feature ] + [-IsEnabled ] + [-PrivacyMode ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +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 +Set-MyAnalyticsFeatureConfig -Identity vikram@contoso.com -PrivacyMode opt-in +``` + +This example makes MyAnalytics and all features available to Vikram. + +### Example 2 +```powershell +Set-MyAnalyticsFeatureConfig -Identity swathy@contoso.com -PrivacyMode opt-in -Feature digest-email -IsEnabled $false +``` + +This example makes MyAnalytics available to Swathy, but disables the digest email feature. + +### Example 3 +```powershell +Set-MyAnalyticsFeatureConfig -Identity akshath@contoso.com -Feature digest-email -IsEnabled $false +``` + +This example disables the digest email feature for Akshath. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Feature +The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are: + +- all (this is the default value) +- add-in +- dashboard +- digest-email + +To actually enable or disable a feature that's specified by this parameter, use the IsEnabled parameter in the same command. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: dashboard, add-in, digest-email, all +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +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. +- $false: The specified feature is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyMode +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. +-opt-out: MyAnalytics is disabled for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: opt-in, opt-out +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Set-Notification.md b/exchange/exchange-ps/exchange/Set-Notification.md similarity index 78% rename from exchange/exchange-ps/exchange/organization/Set-Notification.md rename to exchange/exchange-ps/exchange/Set-Notification.md index 250b84aa30..4d7ef423b7 100644 --- a/exchange/exchange-ps/exchange/organization/Set-Notification.md +++ b/exchange/exchange-ps/exchange/Set-Notification.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-Notification @@ -11,9 +14,18 @@ monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Set-Notification cmdlet to modify notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notification events are related to: +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. The classic Exchange admin center was deprecated in the cloud-based service in 2023. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +Use the Set-Notification cmdlet to modify notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notifications are related to the following events: + +- Mailbox moves and migrations. +- Expiring and expired certificates. +- Exporting mailbox content to .pst files. +- Importing mailbox content from .pst files. +- Restoring deleted mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -22,31 +34,33 @@ For information about the parameter sets in the Syntax section below, see Exchan Set-Notification [-Identity] -NotificationEmails [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ### Settings ``` -Set-Notification -NotificationEmails -ProcessType +Set-Notification -NotificationEmails -ProcessType [-Confirm] [-DomainController ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-Notification -NotificationEmails john@contoso.com,kweku@contoso.com -ProcessType CertExpiry ``` This example configures all expiring and expired certificate notification events to send notification email messages to john@contoso.com and kweku@contoso.com. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-Notification -Identity 0259ec74-3539-4195-ab4f-de93e654ceaf -NotificationEmails laura@contoso.com,julia@contoso.com ``` @@ -55,7 +69,7 @@ This example configures the specified notification event to send notification em ## PARAMETERS ### -Identity -The Identity parameter specifies the notification event that you want to modify. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command: Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. +The Identity parameter specifies the notification event that you want to modify. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command: `Get-Notification | Format-List DisplayName,AlternativeID,StartTime,Status,Type`. Typically, it only makes sense to modify notification recipients for events that haven't completed (if the event has completed, no more notification messages will be sent). @@ -66,6 +80,7 @@ Type: EwsStoreObjectIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -79,7 +94,6 @@ The NotificationEmails parameter specifies the recipients for notification email You need to use this parameter with either the ProcessType or Identity parameters: - ProcessType: The only ProcessType value that's allowed is CertExpiry. - - Identity: You can modify the notification recipients for all types of notification events (CertExpiry, ExportPST, ImportPST, MailboxRestore, and Migration). For Migration events, you can also use the NotificationEmails parameter on the New-MigrationBatch, Set-MigrationBatch and Complete-MigrationBatch cmdlets to specify the notification email recipients. @@ -89,6 +103,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: Named Default value: None @@ -104,10 +119,11 @@ The ProcessType parameter specifies the notification event type that sends notif You can't use this parameter with the Identity parameter. ```yaml -Type: Unknown | ImportPST | ExportPST | Migration | MailboxRestore | CertExpiry +Type: AsyncOperationType Parameter Sets: Settings Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -118,8 +134,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -127,6 +142,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -144,6 +160,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -159,6 +176,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -167,20 +185,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/56275c13-8c86-42e6-ab3f-2e0aa100983a.aspx) diff --git a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md b/exchange/exchange-ps/exchange/Set-OMEConfiguration.md new file mode 100644 index 0000000000..5e1079d1bc --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OMEConfiguration.md @@ -0,0 +1,333 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-OMEConfiguration + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-OMEConfiguration cmdlet to configure Microsoft Purview Message Encryption. + +For 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-OMEConfiguration [-Identity] + [-BackgroundColor ] + [-Confirm] + [-DisclaimerText ] + [-EmailText ] + [-ExternalMailExpiryInDays ] + [-Image ] + [-IntroductionText ] + [-OTPEnabled ] + [-PortalText ] + [-PrivacyStatementUrl ] + [-ReadButtonText ] + [-SocialIdSignIn ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-OMEConfiguration -Identity "OME Configuration" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image ([System.IO.File]::ReadAllBytes('C:\Temp\OME Logo.gif')) +``` + +This example configures the specified values for the default OME configuration named "OME Configuration". + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BackgroundColor +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisclaimerText +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailText +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMailExpiryInDays +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. + +You can't update the value of this parameter in the default OME configuration. You can only modify this value in a customized configuration. + +In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is displayed in the ExternalMailExpiryInterval property. + +```yaml +Type: String +Parameter Sets: Int32 +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +- Supported file formats: .png, .jpg, .bmp, or .tiff +- Optimal size of logo file: less than 40 KB +- Optimal dimensions of logo image: 170x70 pixels + +To remove an existing image and use the default image, use the value $null for this parameter. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntroductionText +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OTPEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortalText +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyStatementUrl +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadButtonText +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SocialIdSignIn +The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, and Microsoft account). Valid values are: + +- $true: Social network ID sign in is allowed. This is the default value. +- $false: Social network ID sign in is not allowed. Whether the recipient can use a one-time passcode or their Microsoft 365 work or school account is controlled by the OTPEnabled parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md b/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md new file mode 100644 index 0000000000..d08012a2ab --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md @@ -0,0 +1,92 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-OMEMessageRevocation + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft Purview Message Encryption for a message. Revoking encryption prevents the recipient from viewing the message in the OME portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +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". + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-OMEMessageRevocation -MessageId "" -Revoke $true +``` + +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, ""). + +You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Revoke +The Revoke parameter specifies whether to revoke encryption for the message. Valid values are: + +- $true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the OME portal +- $false: Encryption for the specified message isn't revoked. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md rename to exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md index cb9759524a..23e45c17c1 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-OabVirtualDirectory @@ -13,50 +16,57 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OABVirtualDirectory cmdlet to modify offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OabVirtualDirectory [-Identity] [-BasicAuthentication <$true | $false>] - [-Confirm] [-DomainController ] [-ExtendedProtectionFlags ] - [-ExtendedProtectionSPNList ] [-ExtendedProtectionTokenChecking ] - [-ExternalUrl ] [-InternalUrl ] [-PollInterval ] [-RequireSSL <$true | $false>] [-WhatIf] - [-WindowsAuthentication <$true | $false>] [-OAuthAuthentication <$true | $false>] [] +Set-OabVirtualDirectory [-Identity] + [-BasicAuthentication ] + [-Confirm] + [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] + [-ExternalUrl ] + [-InternalUrl ] + [-OAuthAuthentication ] + [-PollInterval ] + [-RequireSSL ] + [-WhatIf] + [-WindowsAuthentication ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-OABVirtualDirectory -Identity "Server1\OAB (Default Web Site)" -ExternalUrl "https://www.contoso.com/OAB" ``` -This example changes the external URL of the OAB virtual directory OAB (Default Web Site) to https://www.contoso.com/OAB. +This example changes the external URL of the OAB virtual directory OAB (Default Web Site) to `https://www.contoso.com/OAB`. ## PARAMETERS ### -Identity -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 \\\Name +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -68,16 +78,16 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. You can use this parameter with the WindowsAuthentication parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -88,8 +98,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -97,6 +106,7 @@ 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 @@ -112,6 +122,7 @@ 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 @@ -123,13 +134,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -137,6 +144,7 @@ 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 @@ -148,14 +156,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. 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. +- 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 Default value: None @@ -167,20 +175,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -196,6 +201,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -211,6 +217,23 @@ Type: Uri 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 +``` + +### -OAuthAuthentication +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 Default value: None @@ -219,6 +242,8 @@ Accept wildcard characters: False ``` ### -PollInterval +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. ```yaml @@ -226,6 +251,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -237,14 +263,14 @@ Accept wildcard characters: False 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. - - $false: SSL encryption isn't required to connect to the virtual directory. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -260,6 +286,7 @@ 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 @@ -271,31 +298,16 @@ Accept wildcard characters: False 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. - - $false: Integrated Windows authentication is disabled. You can use this parameter with the BasicAuthentication parameter. ```yaml -Type: $true | $false +Type: Boolean 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 -``` - -### -OAuthAuthentication -This parameter is reserved for internal Microsoft use. -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -304,20 +316,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/d1184716-920c-47cf-9e03-638434c16462.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md similarity index 76% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md rename to exchange/exchange-ps/exchange/Set-OfflineAddressBook.md index 7c34ee216f..b6bd614d26 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-OfflineAddressBook @@ -13,40 +16,55 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-OfflineAddressBook cmdlet to modify offline address book (OAB) settings. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OfflineAddressBook [-Identity] - [-AddressLists ] [-ApplyMandatoryProperties] - [-ConfiguredAttributes ] [-Confirm] [-DiffRetentionPeriod ] - [-DomainController ] [-GlobalWebDistributionEnabled <$true | $false>] [-IsDefault <$true | $false>] - [-MaxBinaryPropertySize ] [-MaxMultivaluedBinaryPropertySize ] - [-MaxMultivaluedStringPropertySize ] [-MaxStringPropertySize ] [-Name ] - [-PublicFolderDistributionEnabled <$true | $false>] [-Schedule ] [-UseDefaultAttributes] - [-Versions ] [-VirtualDirectories ] [-WhatIf] - [-GeneratingMailbox ] [-ShadowMailboxDistributionEnabled <$true | $false>] - [-FullOabDownloadPreventionThreshold ] [-HttpHomeMdbLastProcessedBucket ] [-UpgradeFromE14] - [-ZipOabFilesBeforeUploading <$true | $false>] [] + [-AddressLists ] + [-ApplyMandatoryProperties] + [-ConfiguredAttributes ] + [-Confirm] + [-DiffRetentionPeriod ] + [-DomainController ] + [-FullOabDownloadPreventionThreshold ] + [-GeneratingMailbox ] + [-GlobalWebDistributionEnabled ] + [-IsDefault ] + [-MaxBinaryPropertySize ] + [-MaxMultivaluedBinaryPropertySize ] + [-MaxMultivaluedStringPropertySize ] + [-MaxStringPropertySize ] + [-Name ] + [-PublicFolderDistributionEnabled ] + [-Schedule ] + [-ShadowMailboxDistributionEnabled ] + [-UpgradeFromE14] + [-UseDefaultAttributes] + [-Versions ] + [-VirtualDirectories ] + [-WhatIf] + [-ZipOabFilesBeforeUploading ] + [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-OfflineAddressBook -Identity "Default Offline Address Book" -VirtualDirectories $null -GlobalWebDistributionEnabled $true ``` This example configures the OAB named Default Offline Address Book to be available for download requests from all OAB virtual directories in the organization. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-OfflineAddressBook -Identity "\Default Offline Address Book" -GeneratingMailbox OABGen2 ``` @@ -58,9 +76,7 @@ This example changes the organization mailbox that's responsible for generating 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 - - Distinguished name (DN) - - GUID ```yaml @@ -68,6 +84,7 @@ 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 Default value: None @@ -79,12 +96,10 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can find the identify values of address lists and global address lists by using the Get-AddressList and Get-GlobalAddressList cmdlets. @@ -93,6 +108,7 @@ 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 Default value: None @@ -101,7 +117,7 @@ Accept wildcard characters: False ``` ### -ApplyMandatoryProperties -The ApplyMandatoryPropertiesswitch specifies whether to update the mandatory properties of a legacy OAB. You don't need to specify a value with this switch. +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. @@ -110,6 +126,7 @@ 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 @@ -118,11 +135,7 @@ Accept wildcard characters: False ``` ### -ConfiguredAttributes -The ConfiguredAttributes parameter specifies the recipient MAPI propertiesthat are available in the OAB. This parameter uses the syntax: "\,\","\,\"... where \ is the name of the MAPI property (for example, MobileTelephoneNumber), and \ is the value ANR (ambiguous name resolution), Value, or Indicator. - -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="\","\"...}. +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. @@ -131,6 +144,7 @@ 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 Default value: None @@ -141,8 +155,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -150,6 +163,7 @@ 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 Default value: None @@ -165,6 +179,7 @@ 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 Default value: None @@ -182,6 +197,56 @@ 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 +``` + +### -FullOabDownloadPreventionThreshold +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeneratingMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +The default value for this parameter is the organization mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}. + +A single organization mailbox can generate multiple OABs (you can use the same value for this parameter in the settings of multiple OABs), but in Exchange 2013 CU5 or later, an OAB can only be generated by a single organization mailbox (this parameter doesn't accept multiple values). To have a read only copy of the OAB (also known as a shadow copy) available in other organization mailboxes, use the ShadowMailboxDistributionEnabled parameter. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -195,16 +260,16 @@ 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. 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -216,14 +281,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -241,6 +306,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -258,6 +324,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -275,6 +342,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -292,6 +360,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -307,6 +376,7 @@ 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 Default value: None @@ -315,15 +385,16 @@ Accept wildcard characters: False ``` ### -PublicFolderDistributionEnabled -This parameter is available or functional only in 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -332,39 +403,40 @@ Accept wildcard characters: False ``` ### -Schedule -This parameter is available only in on-premises Exchange. +This parameter is functional only in Exchange 2010. -Note: 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 (https://technet.microsoft.com/library/bb124719.aspx). +In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://learn.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. -You can use the following values for the start and end days: +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. -- Full name of the day +You can use the following values for days: -- Abbreviated name of the day +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. -- Integer from 0 through 6, where 0 = Sunday +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. -The start time and end time must be at least 15 minutes apart. Minutes will be rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. +You can mix and match date/time formats. -The following are examples: +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. -- "Sun.11:30 PM-Mon.1:30 AM" - -- 6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - -- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (The assistant will run on Monday and Wednesday mornings from 4:30 until 5:30.) +Here are some examples: +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - "Sun.1:15 AM-Monday.23:00" -Note: In Office 365, the read only value of this property is displayed in Coordinated Universal Time (UTC). +**Note**: In Exchange Online, the read only value of this property is displayed in Coordinated Universal Time (UTC). ```yaml Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -372,31 +444,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultAttributes -The UseDefaultAttributesswitch 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. +### -ShadowMailboxDistributionEnabled +This parameter is available only in on-premises Exchange. -You can use this switch to undo changes that you've made to the default list by using the ConfiguredAttributes parameter. +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: -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +- $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. -### -Versions -The Versions parameter specifies the OAB versions that are generated for client download. In Exchange 2013 or later, the default and only supported value is Version4 (Version3 and Version2 require public folder distribution). +The 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. ```yaml -Type: MultiValuedProperty +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -404,32 +467,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VirtualDirectories -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. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. - -The default value of this parameter is the Client Access services (frontend) and backend OAB virtual directories on the Mailbox server that holds the OAB generation mailbox (the GeneratingMailbox parameter or SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) when you created the OAB (for example, Mailbox01\\OAB (Default Web Site),Mailbox01\\OAB (Exchange Back End). - -To use this parameter, the value of the GlobalWebDistributionEnabled parameter must be $false. - -In Exchange 2013 CU7 or later, we recommend that you set this parameter to $null, and then set the GlobalWebDistributionEnabled parameter to $true, because the Client Access services on any Mailbox server can proxy incoming OAB download requests to the correct location. +### -UpgradeFromE14 +This parameter is reserved for internal Microsoft use. ```yaml -Type: VirtualDirectoryIdParameter[] +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -437,14 +483,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -UseDefaultAttributes +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. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -452,44 +501,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GeneratingMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \\\\ - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -The default value for this parameter is the organization mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}. +### -Versions +The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: -A single organization mailbox can generate multiple OABs (you can use the same value for this parameter in the settings of multiple OABs), but in Exchange 2013 CU5 or later, an OAB can only be generated by a single organization mailbox (this parameter doesn't accept multiple values). To have a read only copy of the OAB (also known as a shadow copy) available in other organization mailboxes, use the ShadowMailboxDistributionEnabled parameter. +- Version2 (requires public folder distribution) +- Version3 (requires public folder distribution) +- Version4 (default value in Exchange 2010 or later; the only available value in Exchange 2013 or later) ```yaml -Type: MailboxIdParameter +Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -497,52 +521,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShadowMailboxDistributionEnabled +### -VirtualDirectories 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. +The VirtualDirectories parameter specifies the OAB virtual directories that accept requests to download the OAB. These locations are advertised in the Autodiscover service. -- $false: The OAB is isn't distributed to other organization mailboxes. This is the default value. +You can use any value that uniquely identifies the virtual directory. For example: -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. +- Name or Server\\Name +- Distinguished name (DN) +- GUID -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. -### -FullOabDownloadPreventionThreshold -This parameter is reserved for internal Microsoft use. +The default value of this parameter is the Client Access services (frontend) and backend OAB virtual directories on the Mailbox server that holds the OAB generation mailbox (the GeneratingMailbox parameter or SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) when you created the OAB (for example, Mailbox01\\OAB (Default Web Site),Mailbox01\\OAB (Exchange Back End). -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +To use this parameter, the value of the GlobalWebDistributionEnabled parameter must be $false. -### -HttpHomeMdbLastProcessedBucket -This parameter is reserved for internal Microsoft use. +In Exchange 2013 CU7 or later, we recommend that you set this parameter to $null, and then set the GlobalWebDistributionEnabled parameter to $true, because the Client Access services on any Mailbox server can proxy incoming OAB download requests to the correct location. ```yaml -Type: Int32 +Type: VirtualDirectoryIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -550,14 +553,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpgradeFromE14 -This parameter is reserved for internal Microsoft use. +### -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: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -569,14 +573,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -585,20 +589,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1221dda7-1923-4fec-a756-7540e18ae9f9.aspx) diff --git a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md new file mode 100644 index 0000000000..666358469d --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md @@ -0,0 +1,218 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-OnPremisesOrganization + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-OnPremisesOrganization cmdlet to modify the parameters of the OnPremisesOrganization object on the Microsoft 365 tenant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-OnPremisesOrganization [-Identity] + [-Comment ] + [-Confirm] + [-HybridDomains ] + [-InboundConnector ] + [-OrganizationName ] + [-OrganizationRelationship ] + [-OutboundConnector ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. Typically, this object is only modified and updated by the Hybrid Configuration wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-OnPremisesOrganization -Identity "ExchangeMail" -HybridDomains contoso.com, sales.contoso.com, legal.contoso.com +``` + +This example adds a third domain legal.contoso.com to the ExchangeMail OnPremisesOrganization object on the Microsoft 365 organization, which already has the contoso.com and sales.contoso.com domains. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: + +- Canonical name +- GUID +- Name + +```yaml +Type: OnPremisesOrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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". + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundConnector +The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. + +```yaml +Type: InboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationRelationship +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundConnector +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md new file mode 100644 index 0000000000..738f268b0b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -0,0 +1,4074 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-OrganizationConfig cmdlet to configure various settings of an Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ShortenEventScopeParameter +``` +Set-OrganizationConfig -ShortenEventScopeDefault + [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-AppsForOfficeEnabled ] + [-AsyncSendEnabled ] + [-AuditDisabled ] + [-AutodiscoverPartialDirSync ] + [-AutoEnableArchiveMailbox ] + [-AutoExpandingArchive] + [-AutomaticForcedReadReceiptEnabled ] + [-BlockMoveMessagesForGroupFolders ] + [-BookingsAddressEntryRestricted ] + [-BookingsAuthEnabled ] + [-BookingsBlockedWordsEnabled ] + [-BookingsCreationOfCustomQuestionsRestricted ] + [-BookingsEnabled ] + [-BookingsExposureOfStaffDetailsRestricted ] + [-BookingsMembershipApprovalRequired ] + [-BookingsNamingPolicyEnabled ] + [-BookingsNamingPolicyPrefix ] + [-BookingsNamingPolicyPrefixEnabled ] + [-BookingsNamingPolicySuffix ] + [-BookingsNamingPolicySuffixEnabled ] + [-BookingsNotesEntryRestricted ] + [-BookingsPaymentsEnabled ] + [-BookingsPhoneNumberEntryRestricted ] + [-BookingsSearchEngineIndexDisabled ] + [-BookingsSmsMicrosoftEnabled ] + [-BookingsSocialSharingRestricted ] + [-ByteEncoderTypeFor7BitCharsets ] + [-CalendarVersionStoreEnabled ] + [-ComplianceMLBgdCrawlEnabled ] + [-Confirm] + [-ConnectorsActionableMessagesEnabled ] + [-ConnectorsEnabled ] + [-ConnectorsEnabledForOutlook ] + [-ConnectorsEnabledForSharepoint ] + [-ConnectorsEnabledForTeams ] + [-ConnectorsEnabledForYammer ] + [-CustomerLockboxEnabled ] + [-DefaultAuthenticationPolicy ] + [-DefaultGroupAccessType ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] + [-DefaultPublicFolderAgeLimit ] + [-DefaultPublicFolderDeletedItemRetention ] + [-DefaultPublicFolderIssueWarningQuota ] + [-DefaultPublicFolderMaxItemSize ] + [-DefaultPublicFolderMovedItemRetention ] + [-DefaultPublicFolderProhibitPostQuota ] + [-DirectReportsGroupAutoCreationEnabled ] + [-DisablePlusAddressInRecipients ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-ElcProcessingDisabled ] + [-EnableForwardingAddressSyncForMailboxes ] + [-EnableOutlookEvents ] + [-EndUserDLUpgradeFlowsDisabled ] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-ExchangeNotificationEnabled ] + [-ExchangeNotificationRecipients ] + [-FindTimeAttendeeAuthenticationEnabled ] + [-FindTimeAutoScheduleDisabled ] + [-FindTimeLockPollForAttendeesEnabled ] + [-FindTimeOnlineMeetingOptionDisabled ] + [-FocusedInboxOn ] + [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] + [-IPListBlocked ] + [-IsAgendaMailEnabled ] + [-IsGroupFoldersAndRulesEnabled ] + [-IsGroupMemberAllowedToEditContent ] + [-LeanPopoutEnabled ] + [-LinkPreviewEnabled ] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-MaskClientIpInReceivedHeadersEnabled ] + [-MatchSenderOrganizerProperties ] + [-MessageHighlightsEnabled ] + [-MessageRecallAlertRecipientsEnabled ] + [-MessageRecallAlertRecipientsReadMessagesOnlyEnabled ] + [-MessageRecallEnabled ] + [-MessageRecallMaxRecallableAge ] + [-MessageRemindersEnabled ] + [-MobileAppEducationEnabled ] + [-OAuth2ClientProfileEnabled ] + [-OnlineMeetingsByDefaultEnabled ] + [-OutlookGifPickerDisabled ] + [-OutlookMobileGCCRestrictionsEnabled ] + [-OutlookMobileHelpShiftEnabled ] + [-OutlookMobileSingleAccountEnabled ] + [-OutlookPayEnabled ] + [-OutlookTextPredictionDisabled ] + [-PerTenantSwitchToESTSEnabled ] + [-PostponeRoamingSignaturesUntilLater ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicComputersDetectionEnabled ] + [-PublicFoldersEnabled ] + [-PublicFolderShowClientControl ] + [-ReadTrackingEnabled ] + [-RecallReadMessagesEnabled ] + [-RefreshSessionEnabled ] + [-RejectDirectSend ] + [-RemotePublicFolderMailboxes ] + [-RequiredCharsetCoverage ] + [-SendFromAliasEnabled ] + [-SharedDomainEmailAddressFlowEnabled ] + [-SiteMailboxCreationURL ] + [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] + [-UnblockUnsafeSenderPromptEnabled ] + [-VisibleMeetingUpdateProperties ] + [-WebPushNotificationsDisabled ] + [-WebSuggestedRepliesDisabled ] + [-WhatIf] + [-WorkspaceTenantEnabled ] + [] +``` + +### AdfsAuthenticationParameter +``` +Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCertificateThumbprint ] [-AdfsIssuer ] [-AdfsSignCertificateThumbprints ] + [-ACLableSyncedObjectEnabled ] + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-AppsForOfficeEnabled ] + [-AsyncSendEnabled ] + [-ByteEncoderTypeFor7BitCharsets ] + [-Confirm] + [-ConnectorsActionableMessagesEnabled ] + [-ConnectorsEnabled ] + [-CustomerFeedbackEnabled ] + [-DataClassifications ] + [-DefaultAuthenticationPolicy ] + [-DefaultPublicFolderAgeLimit ] + [-DefaultPublicFolderDeletedItemRetention ] + [-DefaultPublicFolderIssueWarningQuota ] + [-DefaultPublicFolderMaxItemSize ] + [-DefaultPublicFolderMovedItemRetention ] + [-DefaultPublicFolderProhibitPostQuota ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-DomainController ] + [-EmptyAddressBookForNonExchangeUsers] + [-EnableAuthAdminReadSession] + [-EnableDownloadDomains ] + [-EnableOrgWidePermissionOnScopedRoles] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-HierarchicalAddressBookRoot ] + [-Industry ] + [-IsAgendaMailEnabled ] + [-IsExcludedFromOffboardMigration ] + [-IsExcludedFromOnboardMigration ] + [-IsFfoMigrationInProgress ] + [-LeanPopoutEnabled ] + [-LinkPreviewEnabled ] + [-MailboxDataEncryptionEnabled] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-ManagedFolderHomepage ] + [-MapiHttpEnabled ] + [-MaxConcurrentMigrations ] + [-MicrosoftExchangeRecipientEmailAddresses ] + [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] + [-MicrosoftExchangeRecipientPrimarySmtpAddress ] + [-MicrosoftExchangeRecipientReplyRecipient ] + [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] + [-OAuth2ClientProfileEnabled ] + [-OrganizationSummary ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicComputersDetectionEnabled ] + [-PublicFolderMailboxesLockedForNewConnections ] + [-PublicFolderMailboxesMigrationComplete ] + [-PublicFolderMigrationComplete ] + [-PublicFolderShowClientControl ] + [-PublicFoldersEnabled ] + [-PublicFoldersLockedForMigration ] + [-ReadTrackingEnabled ] + [-RefreshSessionEnabled ] + [-RemotePublicFolderMailboxes ] + [-RequiredCharsetCoverage ] + [-SCLJunkThreshold ] + [-SiteMailboxCreationURL ] + [-SmtpActionableMessagesEnabled ] + [-UMAvailableLanguages ] + [-UnblockUnsafeSenderPromptEnabled ] + [-UseIcsSyncStateStreaming] + [-WACDiscoveryEndpoint ] + [-WhatIf] + [] +``` + +### AdfsAuthenticationRawConfiguration +``` +Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] + [-ACLableSyncedObjectEnabled ] + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-AppsForOfficeEnabled ] + [-AsyncSendEnabled ] + [-ByteEncoderTypeFor7BitCharsets ] + [-Confirm] + [-ConnectorsActionableMessagesEnabled ] + [-ConnectorsEnabled ] + [-CustomerFeedbackEnabled ] + [-DataClassifications ] + [-DefaultAuthenticationPolicy ] + [-DefaultPublicFolderAgeLimit ] + [-DefaultPublicFolderDeletedItemRetention ] + [-DefaultPublicFolderIssueWarningQuota ] + [-DefaultPublicFolderMaxItemSize ] + [-DefaultPublicFolderMovedItemRetention ] + [-DefaultPublicFolderProhibitPostQuota ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-DomainController ] + [-EmptyAddressBookForNonExchangeUsers] + [-EnableAuthAdminReadSession] + [-EnableDownloadDomains ] + [-EnableOrgWidePermissionOnScopedRoles] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-HierarchicalAddressBookRoot ] + [-Industry ] + [-IsAgendaMailEnabled ] + [-IsExcludedFromOffboardMigration ] + [-IsExcludedFromOnboardMigration ] + [-IsFfoMigrationInProgress ] + [-LeanPopoutEnabled ] + [-LinkPreviewEnabled ] + [-MailboxDataEncryptionEnabled] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-ManagedFolderHomepage ] + [-MapiHttpEnabled ] + [-MaxConcurrentMigrations ] + [-MicrosoftExchangeRecipientEmailAddresses ] + [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] + [-MicrosoftExchangeRecipientPrimarySmtpAddress ] + [-MicrosoftExchangeRecipientReplyRecipient ] + [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] + [-OAuth2ClientProfileEnabled ] + [-OrganizationSummary ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicComputersDetectionEnabled ] + [-PublicFolderMailboxesLockedForNewConnections ] + [-PublicFolderMailboxesMigrationComplete ] + [-PublicFolderMigrationComplete ] + [-PublicFoldersEnabled ] + [-PublicFolderShowClientControl ] + [-PublicFoldersLockedForMigration ] + [-ReadTrackingEnabled ] + [-RefreshSessionEnabled ] + [-RemotePublicFolderMailboxes ] + [-RequiredCharsetCoverage ] + [-SCLJunkThreshold ] + [-SiteMailboxCreationURL ] + [-SmtpActionableMessagesEnabled ] + [-UMAvailableLanguages ] + [-UnblockUnsafeSenderPromptEnabled ] + [-UseIcsSyncStateStreaming] + [-WACDiscoveryEndpoint ] + [-WhatIf] + [] +``` + +### DelayedDelicensingParameterSet +``` +Set-OrganizationConfig [-DelayedDelicensingEnabled ] [-EndUserMailNotificationForDelayedDelicensingEnabled ] [-TenantAdminNotificationForDelayedDelicensingEnabled ] + [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-AppsForOfficeEnabled ] + [-AsyncSendEnabled ] + [-AuditDisabled ] + [-AutodiscoverPartialDirSync ] + [-AutoEnableArchiveMailbox ] + [-AutoExpandingArchive] + [-AutomaticForcedReadReceiptEnabled ] + [-BlockMoveMessagesForGroupFolders ] + [-BookingsAddressEntryRestricted ] + [-BookingsAuthEnabled ] + [-BookingsBlockedWordsEnabled ] + [-BookingsCreationOfCustomQuestionsRestricted ] + [-BookingsEnabled ] + [-BookingsExposureOfStaffDetailsRestricted ] + [-BookingsMembershipApprovalRequired ] + [-BookingsNamingPolicyEnabled ] + [-BookingsNamingPolicyPrefix ] + [-BookingsNamingPolicyPrefixEnabled ] + [-BookingsNamingPolicySuffix ] + [-BookingsNamingPolicySuffixEnabled ] + [-BookingsNotesEntryRestricted ] + [-BookingsPaymentsEnabled ] + [-BookingsPhoneNumberEntryRestricted ] + [-BookingsSearchEngineIndexDisabled ] + [-BookingsSmsMicrosoftEnabled ] + [-BookingsSocialSharingRestricted ] + [-ByteEncoderTypeFor7BitCharsets ] + [-CalendarVersionStoreEnabled ] + [-ComplianceMLBgdCrawlEnabled ] + [-Confirm] + [-ConnectorsActionableMessagesEnabled ] + [-ConnectorsEnabled ] + [-ConnectorsEnabledForOutlook ] + [-ConnectorsEnabledForSharepoint ] + [-ConnectorsEnabledForTeams ] + [-ConnectorsEnabledForYammer ] + [-CustomerLockboxEnabled ] + [-DefaultAuthenticationPolicy ] + [-DefaultGroupAccessType ] + [-DefaultPublicFolderAgeLimit ] + [-DefaultPublicFolderDeletedItemRetention ] + [-DefaultPublicFolderIssueWarningQuota ] + [-DefaultPublicFolderMaxItemSize ] + [-DefaultPublicFolderMovedItemRetention ] + [-DefaultPublicFolderProhibitPostQuota ] + [-DirectReportsGroupAutoCreationEnabled ] + [-DisablePlusAddressInRecipients ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-ElcProcessingDisabled ] + [-EnableForwardingAddressSyncForMailboxes ] + [-EnableOutlookEvents ] + [-EndUserDLUpgradeFlowsDisabled ] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-ExchangeNotificationEnabled ] + [-ExchangeNotificationRecipients ] + [-FindTimeAttendeeAuthenticationEnabled ] + [-FindTimeAutoScheduleDisabled ] + [-FindTimeLockPollForAttendeesEnabled ] + [-FindTimeOnlineMeetingOptionDisabled ] + [-FocusedInboxOn ] + [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] + [-IPListBlocked ] + [-IsAgendaMailEnabled ] + [-IsGroupFoldersAndRulesEnabled ] + [-IsGroupMemberAllowedToEditContent ] + [-LeanPopoutEnabled ] + [-LinkPreviewEnabled ] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-MaskClientIpInReceivedHeadersEnabled ] + [-MatchSenderOrganizerProperties ] + [-MessageHighlightsEnabled ] + [-MessageRecallEnabled ] + [-MessageRemindersEnabled ] + [-MobileAppEducationEnabled ] + [-OAuth2ClientProfileEnabled ] + [-OnlineMeetingsByDefaultEnabled ] + [-OutlookGifPickerDisabled ] + [-OutlookMobileGCCRestrictionsEnabled ] + [-OutlookMobileHelpShiftEnabled ] + [-OutlookMobileSingleAccountEnabled ] + [-OutlookPayEnabled ] + [-OutlookTextPredictionDisabled ] + [-PerTenantSwitchToESTSEnabled ] + [-PostponeRoamingSignaturesUntilLater ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicComputersDetectionEnabled ] + [-PublicFoldersEnabled ] + [-PublicFolderShowClientControl ] + [-ReadTrackingEnabled ] + [-RefreshSessionEnabled ] + [-RemotePublicFolderMailboxes ] + [-RequiredCharsetCoverage ] + [-SendFromAliasEnabled ] + [-SharedDomainEmailAddressFlowEnabled ] + [-SiteMailboxCreationURL ] + [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] + [-UnblockUnsafeSenderPromptEnabled ] + [-VisibleMeetingUpdateProperties ] + [-WebPushNotificationsDisabled ] + [-WebSuggestedRepliesDisabled ] + [-WhatIf] + [-WorkspaceTenantEnabled ] + [] +``` + +### Identity +``` +Set-OrganizationConfig + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-ByteEncoderTypeFor7BitCharsets ] + [-Confirm] + [-CustomerFeedbackEnabled ] + [-DefaultAuthenticationPolicy ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-DomainController ] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-Force] + [-HierarchicalAddressBookRoot ] + [-Industry ] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-ManagedFolderHomepage ] + [-MicrosoftExchangeRecipientEmailAddresses ] + [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] + [-MicrosoftExchangeRecipientPrimarySmtpAddress ] + [-MicrosoftExchangeRecipientReplyRecipient ] + [-OabShadowDistributionOldestFileAgeLimit ] + [-OrganizationSummary ] + [-PermanentlyDeleteDisabled ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicFolderContentReplicationDisabled ] + [-PublicFolderMigrationComplete ] + [-PublicFoldersLockedForMigration ] + [-ReadTrackingEnabled ] + [-RequiredCharsetCoverage ] + [-SCLJunkThreshold ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +> [!TIP] +> The output of the **Get-OrganizationConfig** cmdlet often shows curly braces or `{}` around properties values that accept multiple comma-separated values. Don't use those extra characters in values for the corresponding parameters on this cmdlet. Use the syntax as explained in the parameter descriptions. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-OrganizationConfig -DistributionGroupDefaultOU Users\Groups -DistributionGroupNameBlockedWordsList curse,bad,offensive -DistributionGroupNamingPolicy "DL__" +``` + +This example creates a distribution group naming policy using the following configuration: + +Distribution groups will be created in the Users\\Groups container. + +The words curse, bad, and offensive will be 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. + +### Example 2 +```powershell +Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceBlockList -EwsBlockList $null +``` + +This example allows all client applications to use REST and EWS. + +### Example 3 +```powershell +Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceBlockList -EwsBlockList "OtherApps*" +``` + +This example allows all client applications to use REST and EWS, except those that are specified by the EwsBlockList parameter. + +### Example 4 +```powershell +Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceAllowList -EwsAllowList $null +``` + +This example prevents all client applications from using REST and EWS. + +### Example 5 +```powershell +Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceAllowList -EwsAllowList "CorpApp*" +``` + +This example allows only the client applications specified by the EwsAllowList parameter to use REST and EWS. + +### Example 6 +```powershell +Set-OrganizationConfig -VisibleMeetingUpdateProperties "Location,Subject,Body,AllProperties:15" +``` + +In Exchange Online, this example results in meeting updates being auto-processed (meeting update messages aren't visible in attendee Inbox folders) except any changes to meeting location, subject and body as well as any property changes within 15 minutes of the meeting start time. + +## PARAMETERS + +### -ShortenEventScopeDefault +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. +- 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. + +```yaml +Type: ShortenEventScopeMode +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptedDomainApprovedSendersEnabled +This parameter is available only in the cloud-based service. + +{{ Fill AcceptedDomainApprovedSendersEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ACLableSyncedObjectEnabled +This parameter is available only in on-premises Exchange. + +The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in hybrid environments are stamped as ACLableSyncedMailboxUser. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionableMessagesExtenalAccessTokenEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ActionableMessagesExtenalAccessTokenEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivityBasedAuthenticationTimeoutEnabled +The ActivityBasedAuthenticationTimeoutEnabled parameter enables or disables the inactivity interval for automatic logoff in Outlook on the web (formerly known as Outlook Web App). Valid values are: + +- $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes logoff in Outlook on the web. This is the default value. +- $false: Automatic logoff based on a period of inactivity in Outlook on the web is disabled. + +If you're using single sign-on, use the ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivityBasedAuthenticationTimeoutInterval +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. + +Valid values for this parameter are from 00:05:00 to 08:00:00 (5 minutes to 8 hours). The default value is 06:00:00 (6 hours). + +The value of this parameter is meaningful only if the ActivityBasedAuthenticationTimeoutEnabled or ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter value is $true. + +For more information about the activity-based timeout in Outlook on the web, see [Description of the Activity-Based Authentication Timeout for OWA in Office 365](https://support.microsoft.com/topic/0c101e1b-020e-69c1-a0b0-26532d60c0a4). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled +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. +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdfsAudienceUris +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. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For more information about configuring AD FS claims based authentication in Exchange, see [Use AD FS claims-based authentication with Outlook on the web](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/ad-fs-claims-based-auth). + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdfsAuthenticationParameter +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 +``` + +### -AdfsAuthenticationConfiguration +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: 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 +``` + +### -AdfsEncryptCertificateThumbprint +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: AdfsAuthenticationParameter +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 +``` + +### -AdfsIssuer +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. + +To get this value, open Windows PowerShell on the AD FS server and run the command Get-ADFSEndpoint -AddressPath /adfs/ls | Format-List FullUrl. + +```yaml +Type: Uri +Parameter Sets: AdfsAuthenticationParameter +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 +``` + +### -AdfsSignCertificateThumbprints +This parameter is available only in on-premises Exchange. + +The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-signing certificates that are used for AD FS claims-based authentication. This parameter uses certificate thumbprint values (GUIDs) to identify the certificates. + +To get the thumbprint values of the primary and secondary token-signing certificates, open Windows PowerShell on the AD FS server and run the command Get-ADFSCertificate -CertificateType "Token-signing". For more information, see [Get-ADFSCertificate](https://learn.microsoft.com/powershell/module/adfs/get-adfscertificate). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdfsAuthenticationParameter +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 +``` + +### -AppsForOfficeEnabled +The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsyncSendEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutodiscoverPartialDirSync +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. + +After you enable AutodiscoverPartialDirSync, it will take approximately 3 hours to fully saturate across the cloud. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoEnableArchiveMailbox +This parameter is available only in the cloud-based service. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoExpandingArchive +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. + +```yaml +Type: SwitchParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticForcedReadReceiptEnabled +This parameter is available only in the cloud-based service. + +{{ Fill AutomaticForcedReadReceiptEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockMoveMessagesForGroupFolders +This parameter is available only in the cloud-based service. + +The BlockMoveMessagesForGroupFolders parameter specifies whether to prevent group owners or group members from moving messages between folders in Microsoft 365 Groups. Valid values are: + +- $true: Group owners or group members can't move messages between folders in Microsoft 365 groups (manually or vial Inbox rules). +- $false: Group owners or group members can move messages between folders in Microsoft 365 groups. This is the default value. + +The value of this parameter is meaningful only when the value of the IsGroupFoldersAndRulesEnabled parameter is $true. + +Whether group members (not just group owners) are allowed to move messages between folders in Microsoft 365 Groups also depends on the following settings: + +- The value of the IsGroupMemberAllowedToEditContent parameter is $true. +- The group owner selected **All members will be able to create, edit, move, copy, and delete mail folders and rules within the group** in the properties of the group in Outlook on the web. + +For more information, see [Manage Folders and Rules feature in Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/enterprise/manage-folders-and-rules-feature). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsAddressEntryRestricted +This parameter is available only in the cloud-based service. + +The BookingsAddressEntryRestricted parameter specifies whether addresses can be collected from Bookings customers. Valid values are: + +- $true: Addresses can't be collected from Bookings customers. +- $false: Addresses can be collected from Bookings customers. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsAuthEnabled +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: + +- $true: All new and existing Bookings pages are forced to authenticate users before they can book the appointment. +- $false: All bookings pages are not forced to authenticate users. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsBlockedWordsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsBlockedWordsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsCreationOfCustomQuestionsRestricted +This parameter is available only in the cloud-based service. + +The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Bookings admins can add custom questions. Valid values are: + +- $true: Bookings admins can't add custom questions. +- $false: Bookings admins can add custom questions. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsEnabled +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. + +Microsoft Bookings is an online and mobile app for small businesses who provide appointment services to customers. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsExposureOfStaffDetailsRestricted +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: + +- $true: Internal Bookings staff member attributes aren't visible to external Bookings customers. +- $false: Internal Bookings staff member attributes are visible to external Bookings customers. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsMembershipApprovalRequired +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: + +- $true: Newly added staff members need to accept membership in Bookings calendars before the resources are bookable. +- $false: Newly added staff members do not need to accept membership in Bookings calendars to make the resources bookable. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicyPrefix +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyPrefix Description }} + +```yaml +Type: String +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicyPrefixEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyPrefixEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicySuffix +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicySuffix Description }} + +```yaml +Type: String +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicySuffixEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicySuffixEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNotesEntryRestricted +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: + +- $true: Appointment notes can't be collected from Bookings customers. +- $false: Appointment notes can be collected from Bookings customers. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsPaymentsEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsPhoneNumberEntryRestricted +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: + +- $true: Appointment notes can't be collected from Bookings customers. +- $false: Appointment notes can be collected from Bookings customers. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsSearchEngineIndexDisabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsSearchEngineIndexDisabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsSmsMicrosoftEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsSmsMicrosoftEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsSocialSharingRestricted +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ByteEncoderTypeFor7BitCharsets +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. +- 1: Always use QP (quoted-printable) encoding for HTML and plain text. +- 2: Always use Base64 encoding for HTML and plain text. +- 5: Use QP encoding for HTML and plain text unless line wrapping is enabled in plain text. If line wrapping is enabled, use 7-bit encoding for plain text. +- 6: Use Base64 encoding for HTML and 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. +- 13: Always use QP encoding for HTML. Always use 7-bit encoding for plain text. +- 14: Always use Base64 encoding for HTML. Always use 7-bit encoding for plain text. + +If no value is specified, Exchange always uses QP encoding for HTML and plain text. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarVersionStoreEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceMLBgdCrawlEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ComplianceMLBgdCrawlEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsActionableMessagesEnabled +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsEnabled +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. +- $false: Connectors are disabled. + +The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Viva Engage. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsEnabledForOutlook +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. +- $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. + +For more information about connectors for Outlook on the web, see [Connect apps to your inbox in Outlook on the web](https://support.microsoft.com/office/3d41b99c-bf8d-47d4-bc7a-97758b74689d). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsEnabledForSharepoint +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. +- $false: Connectors are disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsEnabledForTeams +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. +- $false: Connectors are disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsEnabledForYammer +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. +- $false: Connectors are disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerFeedbackEnabled +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerLockboxEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataClassifications +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAuthenticationPolicy +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 +- Distinguished name (DN) +- GUID + +To remove the default policy assignment for the organization, use the value $null. + +You create authentication policies with the New-AuthenticationPolicy cmdlet to block or selectively allow Basic authentication or (in Exchange 2019 CU2 or later) other legacy authentication methods. + +```yaml +Type: AuthPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultGroupAccessType +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: + +- Public +- Private (this is the default value) + +```yaml +Type: ModernGroupObjectType +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: Private +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMinutesToReduceLongEventsBy +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. + +To use this parameter, you also need to include the ShortenEventScopeDefault parameter. + +Whether long events start late or end early by the specified number of minutes depends on the value of the ShortenEventScopeDefault parameter (EndEarly or StartLate). + +```yaml +Type: Int32 +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMinutesToReduceShortEventsBy +This parameter is available only in the cloud-based service. + +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. + +To use this parameter, you also need to include the ShortenEventScopeDefault parameter. + +Whether short events start late or end early by the specified number of minutes depends on the value of the ShortenEventScopeDefault parameter (EndEarly or StartLate). + +```yaml +Type: Int32 +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderAgeLimit +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). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderDeletedItemRetention +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderIssueWarningQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderMaxItemSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderMovedItemRetention +The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. + +When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://learn.microsoft.com/powershell/module/exchange/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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPublicFolderProhibitPostQuota +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The DelayedDelicensingEnabled parameter enables or disables a 30 day grace period for Exchange Online license removals from mailboxes. Valid values are: + +- $true: Exchange Online license removals from mailboxes are delayed by 30 days. Admins can use the delay to identify potential mistakes and avoid disruptions for affected users. +- $false: Exchange Online license removals from mailboxes aren't delayed. This is the default value. + +Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on weekly Service Health advisory notifications for admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +Use the EndUserMailNotificationForDelayedDelicensingEnabled to send affected users periodic email notifications that they're going to lose access to their mailbox. + +Use the Get-PendingDelicenseUser cmdlet to view mailboxes with pending mailbox license removal requests. + +Use the Expedite-Delicensing cmdlet to end the delay for removing the Exchange Online license from the mailbox. + +When you set the value of the DelayedDelicensingEnabled parameter to $true, the TenantAdminNotificationForDelayedDelicensingEnabled and EndUserMailNotificationForDelayedDelicensingEnabled parameters are set to $true by default. + +When you set the value of the DelayedDelicensingEnabled parameter to $false, the TenantAdminNotificationForDelayedDelicensingEnabled and EndUserMailNotificationForDelayedDelicensingEnabled parameters are set to $false by default. + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectReportsGroupAutoCreationEnabled +This parameter is available only in the cloud-based service. + +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisablePlusAddressInRecipients +This parameter is available only in the cloud-based service. + +The DisablePlusAddressInRecipients parameter specifies whether to enable or disable plus addressing (also known as subaddressing) for Exchange Online mailboxes. Valid values are: + +- $true: Plus addressing is disabled. You can no longer use the plus sign in regular email addresses. The plus sign is available only for plus addressing. +- $false: Plus addressing is enabled. You can use the plus sign in regular email addresses. + +For more information about plus addressing, see [Plus addressing in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/plus-addressing-in-exchange-online). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionGroupDefaultOU +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionGroupNameBlockedWordsList +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionGroupNamingPolicy +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. + +You can use the following user attributes. The actual values are determined by the user who creates the group: + +- `` +- `` +- `` +- `` +- `` to `` +- `` +- `` to `` +- `` +- `` +- `` + +For example: `"DL_<StateOrProvince>_<GroupName>"`, `"<StateOrProvince>-<City>-<Office>-<GroupName>"` or `"<GroupName> <CustomAttribute1>"`. + +```yaml +Type: DistributionGroupNamingPolicy +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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity +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 +``` + +### -ElcProcessingDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmptyAddressBookForNonExchangeUsers +This parameter is available only in on-premises Exchange. + +{{ Fill EmptyAddressBookForNonExchangeUsers Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAuthAdminReadSession +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. + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDownloadDomains +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. + +For more information about the security vulnerability that's addressed by this parameter, and for detailed configuration instructions, see [CVE 2021 1730](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2021-1730). + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableForwardingAddressSyncForMailboxes +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrgWidePermissionOnScopedRoles +This parameter is available only in on-premises Exchange. + +{{ Fill EnableOrgWidePermissionOnScopedRoles Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOutlookEvents +This parameter is available only in the cloud-based service. + +The EnableOutlookEvents parameter specifies whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to user calendars. Valid values are: + +- $true: Discovery of events from email messages is enabled. +- $false: Discovery of events from email messages is disabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserDLUpgradeFlowsDisabled +This parameter is available only in the cloud-based service. + +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserMailNotificationForDelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The EndUserMailNotificationForDelayedDelicensingEnabled parameter enables or disables periodic email warnings to affected users that have pending Exchange Online license removal requests on their mailboxes. Valid values are: + +- $true: Affected users receive periodic email notifications about losing access to their mailbox starting ~18 days after the Exchange Online license was removed. +- $false: Affected users don't receive periodic email notifications about losing access to their mailbox. This is the default value. + +The value of this parameter is meaningful on when the value of the DelayedDelicensingEnabled parameter is $true. + +Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on weekly Service Health advisory notifications for admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsAllowEntourage +The EwsAllowEntourage parameter specifies whether to enable or disable Entourage 2008 to access Exchange Web Services (EWS) for the entire organization. The default value is $true. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsAllowList +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +**Note**: If users receive an error when they try to run "Play My Emails" in Outlook Mobile, use this parameter to add the value "Cortana" to the list of allowed applications. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +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 +``` + +### -EwsAllowMacOutlook +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsAllowOutlook +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsApplicationAccessPolicy +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsBlockList +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -EwsEnabled +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. + +This parameter has no affect on access to REST. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeNotificationEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeNotificationRecipients +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FindTimeAttendeeAuthenticationEnabled +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: + +- $true: Attendees are required to validate their identity and the meeting organizer can't turn off this setting (Always On). +- $false: By default, attendees are required to verify their identity, but the meeting organizer is allowed to turn this setting off. + +This setting overrides individual user settings. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FindTimeAutoScheduleDisabled +This parameter is available only in the cloud-based service. + +The FindTimeAutoScheduleDisabled parameter controls automatically scheduling the meeting once a consensus is reached in meeting polls using the FindTime Outlook add-in. Valid values are: + +- $true: Reaching a consensus for the meeting time doesn't automatically schedule the meeting, and the meeting organizer can't change this setting (Off). +- $false: By default, reaching a consensus for the meeting time doesn't automatically schedule the meeting, but meeting organizer is allowed to turn on this setting. + +This setting overrides individual user settings. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FindTimeLockPollForAttendeesEnabled +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). +- $false: By default, **Lock poll for attendees** is off (initial default) or on (the user saved settings from last poll), but the meeting organizer is allowed to turn the setting off or on to allow or prevent attendees from suggesting new times or editing attendees. + +This setting overrides individual user settings. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FindTimeOnlineMeetingOptionDisabled +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. +- $false: The **Online meeting** checkbox is available in the meeting poll in FindTime, so the meeting organizer can choose to select or not select this setting. + +This setting overrides individual user settings. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FocusedInboxOn +This parameter is available only in the cloud-based service. + +The FocusedInboxOn parameter enables or disables Focused Inbox for the organization. Valid values are: + +- $true: Focused Inbox is enabled. +- $false: Focused Inbox is disabled. + +To disable Focused Inbox on specific mailboxes, enable Focused Inbox for the organization, and then use the Set-FocusedInbox cmdlet. + +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HierarchicalAddressBookRoot +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +Setting a value for this parameter enables the hierarchical address book to be automatically displayed in Outlook for the organization. + +The default value is blank. To reset this parameter, use the value $null. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRSVPEnabled +This parameter is available only in the cloud-based service. + +The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organization. Hybrid RSVP allows users the option to indicate if they will attend a meeting in-person or virtually when responding to a meeting invitation on Outlook. Valid values are: + +- $true: Hybrid RSVP is enabled (this is the default value). +- $false: Hybrid RSVP is disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Industry +This parameter is available only in on-premises Exchange. + +The Industry parameter specifies the industry that best represents your organization. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPListBlocked +This parameter is available only in the cloud-based service. + +This parameter only affects Basic authentication connections. + +The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. Valid values are: + +- Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. +- IP address range: For example, 192.168.0.1-192.168.0.254 or 192.168.8.2(255.255.255.0). +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:0DB8::CD3/60. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +This parameter has a limit of approximately 1200 entries. + +Changes to this parameter might take up to 4 hours to fully propagate across the service. + +```yaml +Type: MultiValuedProperty +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAgendaMailEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromOffboardMigration +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. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExcludedFromOnboardMigration +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. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFfoMigrationInProgress +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGroupFoldersAndRulesEnabled +This parameter is available only in the cloud-based service. + +The IsGroupFoldersAndRulesEnabled specifies whether group owners (by default) can create folders and move messages (manually or by using Inbox rules) in Microsoft 365 Groups. Valid values are: + +- $true: Group owners can create folders and move messages between folders in Microsoft 365 Groups. +- $false: Group owners can't create folders or move messages between folders in Microsoft 365 Groups. This is the default value. + +To allow group owners to allow group users to create folders and moved messages in Microsoft 365 Groups, use the IsGroupMemberAllowedToEditContent parameter. + +For more information, see [Manage Folders and Rules feature in Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/enterprise/manage-folders-and-rules-feature). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGroupMemberAllowedToEditContent +This parameter is available only in the cloud-based service. + +The IsGroupMemberAllowedToEditContent parameter specifies whether group owners can allow group members to manage folders and messages in Microsoft 365 Groups. Valid values are: + +- $true: Group owners can use the **All members will be able to create, edit, move, copy, and delete mail folders and rules within the group** setting in the group properties in Outlook on the web to allow group members to do the following tasks in Microsoft 365 Groups: + + • Create, rename, move, copy, and delete folders. + + • Move, copy, and delete messages manually or via Inbox rules. + + • Create, edit, copy, and delete Inbox rules. + +- $false: Group owners can't use the **All members will be able to create, edit, move, copy, and delete mail folders and rules within the group** setting in the group properties in Outlook on the web to allow group members to manage folders and messages in Microsoft 365 Groups. Only group owners can manage folders and messages in Microsoft 365 Groups. This is the default value. + +The value of this parameter is meaningful only when the value of the IsGroupFoldersAndRulesEnabled parameter is $true. + +To prevent group owners or group members from moving messages between folders manually or vial Inbox rules in Microsoft 365 Groups, use the BlockMoveMessagesForGroupFolders parameter. + +For more information, see [Manage Folders and Rules feature in Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/enterprise/manage-folders-and-rules-feature). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LeanPopoutEnabled +The LeanPopoutEnabled parameter specifies whether to enable faster loading of pop-out messages in Outlook on the web for Internet Explorer and Microsoft Edge. Valid values are: + +- $true: Lean pop-outs are enabled. +- $false: Lean pop-outs are disabled. This is the default value. + +**Notes**: + +- Lean pop-outs aren't available for messages that contain attachments or information rights management (IRM) restrictions. +- Outlook add-ins and Skype for Business Online presence aren't available with lean pop-outs. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkPreviewEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxDataEncryptionEnabled +This parameter is available only in on-premises Exchange. + +{{ Fill MailboxDataEncryptionEnabled Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAllTipsEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsExternalRecipientsTipsEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsGroupMetricsEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsLargeAudienceThreshold +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsMailboxSourcedTipsEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedFolderHomepage +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapiHttpEnabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaskClientIpInReceivedHeadersEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MaskClientIpInReceivedHeadersEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchSenderOrganizerProperties +This parameter is available only in the cloud-based service. + +{{ Fill MatchSenderOrganizerProperties Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConcurrentMigrations +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. + +```yaml +Type: Unlimited +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 +``` + +### -MessageHighlightsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageHighlightsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsReadMessagesOnlyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsReadMessagesOnlyEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallMaxRecallableAge +{{ Fill MessageRecallMaxRecallableAge Description }} + +```yaml +Type: Microsoft.Exchange.Data.EnhancedTimeSpan +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRemindersEnabled +This parameter is available only in the cloud-based service. + +The MessageRemindersEnabled parameter enables or disables the message reminders feature in the organization. Valid values are: + +- $true: Message reminders are enabled. A message is moved to the top of the user's inbox if Outlook determines that the message requires follow-up or a reply. Only one message is moved at a time, and the user must take action on the message before another message is moved to the top of the Inbox. +- $false: Message reminders are disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftExchangeRecipientEmailAddresses +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. + +Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAddresses parameter replace any existing email addresses already configured. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftExchangeRecipientEmailAddressPolicyEnabled +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. + +If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter from $false to $true, any email addresses that you defined by using the MicrosoftExchangeRecipientEmailAddresses parameter are preserved. However, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter reverts to `MicrosoftExchange329e71ec88ae4615bbc36ab6ce41109e@<Accepted Domain in Highest Priority Email Address Policy>`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftExchangeRecipientPrimarySmtpAddress +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. + +If you modify the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter, the value is automatically added to the list of email addresses defined in the MicrosoftExchangeRecipientEmailAddresses parameter. + +The MicrosoftExchangeRecipientPrimarySmtpAddress parameter is meaningful only if the Exchange recipient has more than one defined SMTP email address. If the MicrosoftExchangeRecipientEmailAddresses parameter has only one defined SMTP email address, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter and the MicrosoftExchangeRecipientEmailAddresses parameter are the same. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftExchangeRecipientReplyRecipient +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitigationsEnabled +This parameter is available only in on-premises Exchange. + +The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) is enabled in the organization. Valid values are: + +- $true: The EM Service automatically applies mitigations on Exchange servers where the value of the _MitigationsEnabled_ parameter is $true on the **Set-ExchangeServer**. +- $false: Mitigations are not automatically applied on Exchange servers. + +For more information, see [Exchange Emergency Mitigation (EM) service](https://learn.microsoft.com/exchange/exchange-emergency-mitigation-service). + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileAppEducationEnabled +This parameter is available only in the cloud-based service. + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OabShadowDistributionOldestFileAgeLimit +This parameter is available only in on-premises Exchange. + +{{ Fill OabShadowDistributionOldestFileAgeLimit Description }} + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OAuth2ClientProfileEnabled +The OAuth2ClientProfileEnabled parameter enables or disables modern authentication in the Exchange organization. Valid values are: + +- $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. + +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). + +```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 +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlineMeetingsByDefaultEnabled +This parameter is available only in the cloud-based service. + +The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Valid values are: + +- $true: All meetings are online by default. +- $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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationSummary +This parameter is available only in on-premises Exchange. + +The OrganizationSummary parameter specifies a summarized description that best represents your organization. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookGifPickerDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookMobileGCCRestrictionsEnabled +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. +- $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 +- HelpShift and in-app support +- Any Microsoft services that are outside the Microsoft 365 US Government Community Cloud (for example, Bing and Cortana). + + For a full list of Features and services that are not FedRAMP compliant for GCC customers, see [Services and features of Outlook for iOS and Android that aren't available for Government Community Cloud users](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/outlook-for-ios-and-android-in-the-government-cloud#services-and-features-not-available). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookMobileHelpShiftEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookMobileSingleAccountEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookPayEnabled +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: + +- $true: Payments in Outlook are enabled. +- $False: Payments in Outlook are disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookTextPredictionDisabled +This parameter is available only in the cloud-based service. + +{{ Fill OutlookTextPredictionDisabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermanentlyDeleteDisabled +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 policies, block the creation of policies with the PermanentlyDelete action or notify users that thePermanentlyDelete action won't actually take effect. +- $false The PermanentlyDelete retention action is enabled. This is the default value. + +A message that's permanently deleted can't be recovered by using the Recoverable Items folder. Additionally, permanently deleted messages aren't returned by a Discovery search, unless litigation hold or single item recovery is enabled for the mailbox. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerTenantSwitchToESTSEnabled +This parameter is available only in the cloud-based service. + +This parameter has been deprecated and is no longer used. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostponeRoamingSignaturesUntilLater +This parameter is available only in the cloud-based service. + +The PostponeRoamingSignaturesUntilLater parameter controls whether roaming signatures are enabled or disabled in Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: + +- $true: Roaming signatures are disabled for Outlook on the web and the new Outlook for Windows. For Windows clients, the registry setting to disable roaming signatures still works. For more information, see [Outlook roaming signatures](https://support.microsoft.com/office/420c2995-1f57-4291-9004-8f6f97c54d15). When roaming signatures are disabled, admins can use the signature-related parameters on the Set-MailboxMessageConfiguration cmdlet (for example, AutoAddSignature, AutoAddSignatureOnReply, and SignatureHtml) to configure email signatures. + + Previously, the only way to disable roaming signatures in Outlook on the web was to open a support ticket. With the introduction of this parameter and value, admins can disable roaming signatures themselves. + +- $false: Roaming signatures are enabled for Outlook on the web and the new Outlook for Windows. This is the default value. + +We recommend that independent software vendors (ISVs) onboard to the [signature API](https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1)) based on [event-based hooks +](https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch). + +We have no plans to support roaming signature management in the Microsoft Graph API. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredInternetCodePageForShiftJis +This parameter is reserved for internal Microsoft use. + +```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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderContentReplicationDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderMailboxesLockedForNewConnections +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. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderMailboxesMigrationComplete +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) + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderMigrationComplete +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. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +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 +``` + +### -PublicFoldersEnabled +The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. Valid values are: + +- Local: The public folders are deployed locally in your organization. +- Remote: The public folders are deployed in the remote forest. +- None: No public folders are deployed for this organization. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderShowClientControl +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: $false +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFoldersLockedForMigration +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadTrackingEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecallReadMessagesEnabled +This parameter is available only in the cloud-based service. + +{{ Fill RecallReadMessagesEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshSessionEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectDirectSend +This parameter is available only in the cloud-based service. + +{{ Fill RejectDirectSend Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemotePublicFolderMailboxes +The RemotePublicFolderMailboxes parameter specifies the identities of the public folder objects (represented as mail user objects locally) corresponding to the public folder mailboxes created in the remote forest. The public folder values set here are used only if the public folder deployment is a remote deployment. + +```yaml +Type: MultiValuedProperty +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredCharsetCoverage +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SCLJunkThreshold +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendFromAliasEnabled +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. + +For more information about the availability of the feature in Outlook on the web, see the [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=59437). For Outlook for Windows, see this [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Outlook&searchterms=64123). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedDomainEmailAddressFlowEnabled +This parameter is available only in the cloud-based service. + +{{ Fill SharedDomainEmailAddressFlowEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteMailboxCreationURL +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpActionableMessagesEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantAdminNotificationForDelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The TenantAdminNotificationForDelayedDelicensingEnabled parameter enables or disables weekly admin Service Health advisory notifications that are sent to admins. Valid values are: + +- $true: Weekly Service Health advisory notifications are sent to admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. +- $false: Disable weekly Service Health advisory notifications about the number of Exchange Online delicensed users. This is the default value. + +For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +The value of this parameter is meaningful on when the value of the DelayedDelicensingEnabled parameter is $true. + +Use the EndUserMailNotificationForDelayedDelicensingEnabled to send affected users periodic email notifications that they're going to lose access to their mailbox. + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TwoClickMailPreviewEnabled +This parameter is available only in the cloud-based service. + +{{ Fill TwoClickMailPreviewEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMAvailableLanguages +This parameter is available only in on-premises Exchange. + +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnblockUnsafeSenderPromptEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseIcsSyncStateStreaming +This parameter is available only in on-premises Exchange. + +{{ Fill UseIcsSyncStateStreaming Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VisibleMeetingUpdateProperties +This parameter is available only in the cloud-based service. + +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. + +This parameter uses the syntax: `"MeetingProperty1:MeetingStartTimeWithinXMinutes1,MeetingProperty2:MeetingStartTimeWithinXMinutes2,...MeetingPropertyN:MeetingStartTimeWithinXMinutesN"`. + +The valid meeting properties to monitor for updates are: + +- Location: The meeting location field. +- Subject: The meeting subject or title. +- Sensitivity: The sensitivity (privacy) of the event. +- Body: The meeting body or description. +- OnlineMeetingLinks: The meeting join URL. +- AllowForwarding: The option to allow or prevent forwarding of meetings. +- RequestResponses: The option on whether responses are requested. +- AllowNewTimeProposals: The option to allow or prevent new time proposals. +- ShowAs: The free/busy state of the meeting: Free, Tentative, Busy, Working elsewhere, or Away/Out of office. +- 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. + +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: + +- The update contains a change to the meeting date, time, or recurrence pattern. +- The meeting message is received for a delegated shared calendar. +- The receiving attendee is @ mentioned in the meeting body. +- The attendee has not yet responded to the meeting. + +```yaml +Type: String +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WACDiscoveryEndpoint +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`. + +Office Online Server enables users to view supported file attachments in Outlook on the web (formerly known as Outlook Web App). + +```yaml +Type: String +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 +``` + +### -WebPushNotificationsDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebSuggestedRepliesDisabled +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. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceTenantEnabled +This parameter is available only in the cloud-based service. + +The WorkspaceTenantEnabled parameter enables or disables workspace booking in the organization. Valid values are: + +- $true: In Outlook for iOS and Android, the calendar setting for workspace booking is visible and is off by default. +- $false: In Outlook for iOS and Android, the calendar setting for workspace booking is hidden. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md new file mode 100644 index 0000000000..f21e2920e4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md @@ -0,0 +1,605 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-OrganizationRelationship cmdlet to modify existing organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-OrganizationRelationship [-Identity] <OrganizationRelationshipIdParameter> + [-ArchiveAccessEnabled <Boolean>] + [-Confirm] + [-DeliveryReportEnabled <Boolean>] + [-DomainController <Fqdn>] + [-DomainNames <MultiValuedProperty>] + [-Enabled <Boolean>] + [-Force] + [-FreeBusyAccessEnabled <Boolean>] + [-FreeBusyAccessLevel <FreeBusyAccessLevel>] + [-FreeBusyAccessScope <GroupIdParameter>] + [-MailboxMoveCapability <MailboxMoveCapability>] + [-MailboxMoveEnabled <Boolean>] + [-MailboxMovePublishedScopes <MultiValuedProperty>] + [-MailTipsAccessEnabled <Boolean>] + [-MailTipsAccessLevel <MailTipsAccessLevel>] + [-MailTipsAccessScope <GroupIdParameter>] + [-Name <String>] + [-OAuthApplicationId <String>] + [-OrganizationContact <SmtpAddress>] + [-PhotosEnabled <Boolean>] + [-TargetApplicationUri <Uri>] + [-TargetAutodiscoverEpr <Uri>] + [-TargetOwaURL <Uri>] + [-TargetSharingEpr <Uri>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-OrganizationRelationship -Identity "Fourth Coffee" -FreeBusyAccessLevel LimitedDetails +``` + +This example modifies the free/busy access level to LimitedDetails, which includes time, subject, and location. + +### Example 2 +```powershell +Set-OrganizationRelationship -Identity "Contoso" -Enabled $false +``` + +This example disables the organization relationship with Contoso + +## PARAMETERS + +### -Identity +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 +- Canonical name +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ArchiveAccessEnabled +The ArchiveAccessEnabled parameter specifies whether the organization relationship has been 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 + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryReportEnabled +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 + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNames +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether to enable the organization relationship. Valid values are: + +- $true: The organization relationship is enabled. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FreeBusyAccessEnabled +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. + +You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FreeBusyAccessLevel +The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: + +- None: No free/busy access. +- AvailabilityOnly: Free/busy access with time only. +- LimitedDetails: Free/busy access with time, subject, and location. + +This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMoveCapability +This parameter is available only in the cloud-based service. + +The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: + +- Inbound +- Outbound +- RemoteInbound +- RemoteOutbound + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). + +```yaml +Type: MailboxMoveCapability +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMoveEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxMovePublishedScopes +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAccessEnabled +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. + +You control the MailTips access level by using the MailTipsAccessLevel parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAccessLevel +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. + +This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipsAccessScope +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 +- Distinguished name (DN) +- Canonical DN +- GUID + +The default value is blank ($null), which means no group is specified. + +If you use this parameter, recipient-specific MailTips are returned only for those recipients that are members of the specified group. The recipient-specific MailTips are: + +- Auto Reply +- Mailbox Full +- Custom + +If you don't use this parameter, recipient-specific MailTips are returned for all recipients in the organization. + +This restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OAuthApplicationId +This parameter is available only in the cloud-based service. + +The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationContact +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhotosEnabled +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetApplicationUri +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetAutodiscoverEpr +The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetOwaURL +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TargetSharingEpr +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md new file mode 100644 index 0000000000..49cf493921 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md @@ -0,0 +1,103 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-OrganizationSegment + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-OrganizationSegment cmdlet to modify organization segments in the Microsoft Purview compliance portal. Organization Segments are not in effect until you [apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-OrganizationSegment [-Identity] <PolicyIdParameter> + [-UserGroupFilter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Segments are defined by using certain [attributes](https://learn.microsoft.com/purview/information-barriers-attributes) in Microsoft Entra ID. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-OrganizationSegment -Identity c96e0837-c232-4a8a-841e-ef45787d8fcd -UserGroupFilter "Department -eq 'HRDept'" +``` + +In this example, for the segment that has the GUID c96e0837-c232-4a8a-841e-ef45787d8fcd, we updated the department name to "HRDept". + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -UserGroupFilter +The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information, see [Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +Use the same property for all of your segments, and verify that your segments don't overlap (a user must be assigned to only one segment). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-OutboundConnector.md b/exchange/exchange-ps/exchange/Set-OutboundConnector.md new file mode 100644 index 0000000000..a73f8dfcd5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OutboundConnector.md @@ -0,0 +1,513 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-OutboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-OutboundConnector cmdlet to modify an existing Outbound connector in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-OutboundConnector [-Identity] <OutboundConnectorIdParameter> + [-AllAcceptedDomains <Boolean>] + [-CloudServicesMailEnabled <Boolean>] + [-Comment <String>] + [-Confirm] + [-ConnectorSource <TenantConnectorSource>] + [-ConnectorType <TenantConnectorType>] + [-Enabled <Boolean>] + [-IsTransportRuleScoped <Boolean>] + [-IsValidated <Boolean>] + [-LastValidationTimestamp <DateTime>] + [-Name <String>] + [-RecipientDomains <MultiValuedProperty>] + [-RouteAllMessagesViaOnPremises <Boolean>] + [-SenderRewritingEnabled <Boolean>] + [-SmartHosts <MultiValuedProperty>] + [-TestMode <Boolean>] + [-TlsDomain <SmtpDomainWithSubdomains>] + [-TlsSettings <TlsAuthLevel>] + [-UseMXRecord <Boolean>] + [-ValidationRecipients <String[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-OutboundConnector "Contoso Outbound Connector" -UseMxRecord $false -SmartHosts 192.168.0.1 +``` + +This example changes the settings of the existing Outbound connector named Contoso Outbound Connector to route to a smart host at IP address 192.168.0.1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the connector you want to modify. You can use any value that uniquely identifies the connector. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: OutboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllAcceptedDomains +The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: + +- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. +- $false: The Outbound connector isn't used in hybrid organizations. This is the default value. + +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServicesMailEnabled +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSource +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. +- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. +- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. + +```yaml +Type: TenantConnectorSource +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorType +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. +- OnPremises: The connector services domains that are used by your on-premises organization. + +```yaml +Type: TenantConnectorType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: + +- $true: The connector is enabled. This is the default value. +- $false: The connector is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsTransportRuleScoped +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +Use the Validate-OutboundConnector cmdlet to validate the connector. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastValidationTimestamp +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: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +Use the Validate-OutboundConnector cmdlet to validate the connector. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomains +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteAllMessagesViaOnPremises +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. + +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderRewritingEnabled +The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: + +- $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. +- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This is the default value. + +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmartHosts +The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: + +- FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. +- Single IP address: For example, 10.10.1.1. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. + +This parameter is required if you use the value $false for the UseMxRecord parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestMode +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsDomain +The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. + +Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). + +This parameter meaningful only when the TlsSettings value is DomainValidation. + +```yaml +Type: SmtpDomainWithSubdomains +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsSettings +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. + +```yaml +Type: TlsAuthLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMXRecord +The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: + +- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. +- $false: The connector delivers email to one or more smart hosts. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationRecipients +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/client-access-servers/Set-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md similarity index 78% rename from exchange/exchange-ps/exchange/client-access-servers/Set-OutlookAnywhere.md rename to exchange/exchange-ps/exchange/Set-OutlookAnywhere.md index 917a1e8d7f..bdc199f0c5 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-OutlookAnywhere @@ -13,59 +16,69 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OutlookAnywhere cmdlet to modify Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. Outlook Anywhere uses virtual directories that contain "rpc" in the name. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OutlookAnywhere [-Identity] <VirtualDirectoryIdParameter> - [-ClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured>] + [-ClientAuthenticationMethod <AuthenticationMethod>] [-Confirm] - [-DefaultAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured>] - [-DomainController <Fqdn>] [-ExtendedProtectionFlags <MultiValuedProperty>] - [-ExtendedProtectionSPNList <MultiValuedProperty>] [-ExtendedProtectionTokenChecking <None | Allow | Require>] - [-ExternalHostname <Hostname>] [-IISAuthenticationMethods <MultiValuedProperty>] [-Name <String>] - [-SSLOffloading <$true | $false>] [-WhatIf] [-ExternalClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-ExternalClientsRequireSsl <$true | $false>] - [-InternalClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-InternalClientsRequireSsl <$true | $false>] [-InternalHostname <String>] [<CommonParameters>] + [-DefaultAuthenticationMethod <AuthenticationMethod>] + [-DomainController <Fqdn>] + [-ExtendedProtectionFlags <MultiValuedProperty>] + [-ExtendedProtectionSPNList <MultiValuedProperty>] + [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>] + [-ExternalClientAuthenticationMethod <AuthenticationMethod>] + [-ExternalClientsRequireSsl <Boolean>] + [-ExternalHostname <Hostname>] + [-IISAuthenticationMethods <MultiValuedProperty>] + [-InternalClientAuthenticationMethod <AuthenticationMethod>] + [-InternalClientsRequireSsl <Boolean>] + [-InternalHostname <String>] + [-Name <String>] + [-SSLOffloading <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +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). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-OutlookAnywhere -Identity:CAS01\Rpc (Default Web Site) -ClientAuthenticationMethod:Ntlm ``` In Exchange 2010, this example sets the client authentication method to NTLM for the /rpc virtual directory on the Client Access server CAS01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-OutlookAnywhere -Identity: "EXCH1\rpc (Default Web Site)" -ExternalClientAuthenticationMethod NTLM ``` This example sets the client authentication method to NTLM for the Outlook Anywhere virtual directory on the server named EXCH1. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-OutlookAnywhere -Identity "EXCH1\rpc (Default Web Site)" -SSLOffloading $false -InternalClientsRequireSsl $true -ExternalClientsRequireSsl $true ``` This example sets the SSLOffloading parameter to $false for the Outlook Anywhere virtual directory on the server named EXCH1. This setting informs Outlook Anywhere to expect no SSL decryption between clients and the server, and enables the Require SSL value on the virtual directory. Because SSL is now required for Outlook Anywhere connections, we need to configure internal and external clients to use SSL. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Set-OutlookAnywhere -Identity "EXCH1\rpc (Default Web Site)" -IISAuthenticationMethods NTLM ``` This example sets the authentication method for the Outlook Anywhere virtual directory setting in IIS to NTLM. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Set-OutlookAnywhere -Identity "EXCH1\rpc (Default Web Site)" -IISAuthenticationMethods Basic,NTLM ``` @@ -74,23 +87,20 @@ In Exchange 2010 and Exchange 2013, this example sets the available authenticati ## PARAMETERS ### -Identity -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 +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -99,21 +109,21 @@ Accept wildcard characters: False ``` ### -ClientAuthenticationMethod -This parameter is available or functional only in 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: - 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. ```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured +Type: AuthenticationMethod Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -124,8 +134,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -133,6 +142,7 @@ 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 @@ -144,18 +154,17 @@ Accept wildcard characters: False 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 - - Ntlm - - Negotiate You can't use this parameter with the ExternalClientAuthenticationMethod, InternalClientAuthenticationMethod and IISAuthenticationMethods parameters. ```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured +Type: AuthenticationMethod Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -171,6 +180,7 @@ 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 @@ -182,13 +192,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -196,6 +202,7 @@ 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 @@ -207,14 +214,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \<protocol\>/\<FQDN\>. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- 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 Default value: None @@ -226,20 +233,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -247,14 +251,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalHostname -The ExternalHostname parameter specifies the external hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. +### -ExternalClientAuthenticationMethod +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) + +You can't use this parameter with the DefaultAuthenticationMethods parameter. ```yaml -Type: Hostname +Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -262,24 +273,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IISAuthenticationMethods -The IISAuthenticationMethods parameter specifies the authentication method that's used on the Outlook Anywhere virtual directory in IIS. Valid values are: - -- Basic - -- Ntlm - -- Negotiate +### -ExternalClientsRequireSsl +The ExternalClientsRequireSsl parameter specifies whether external Outlook Anywhere clients are required to use Secure Sockets Layer (SSL). Valid values are: -You can specify multiple value separated by commas. By default, all values are used. +- $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. -You can't use this parameter with the DefaultAuthenticationMethods parameter. +The value of this parameter is related to the value of the SSLOffloading parameter. ```yaml -Type: MultiValuedProperty +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -287,14 +294,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -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 ("). +### -ExternalHostname +The ExternalHostname parameter specifies the external hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. ```yaml -Type: String +Type: Hostname Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -302,24 +310,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SSLOffloading -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. - -- $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. +### -IISAuthenticationMethods +The IISAuthenticationMethods parameter specifies the authentication method that's used on the Outlook Anywhere virtual directory in IIS. Valid values are: -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. +- Basic +- Ntlm +- Negotiate -You need to use the value $true for this parameter if you don't require SSL connections for internal or external Outlook Anywhere clients. +You can specify multiple value separated by commas. By default, all values are used. -The value of this parameter is related to the values of the ExternalClientsRequireSsl and InternalClientsRequireSsl parameters. +You can't use this parameter with the DefaultAuthenticationMethods parameter. ```yaml -Type: $true | $false +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 @@ -327,14 +334,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -InternalClientAuthenticationMethod +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) +- Negotiate + +You can't use this parameter with the DefaultAuthenticationMethods parameter. ```yaml -Type: SwitchParameter +Type: AuthenticationMethod Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -342,22 +356,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalClientAuthenticationMethod -The ExternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate external Outlook Anywhere clients. Valid values are: - -- Basic - -- Ntlm +### -InternalClientsRequireSsl +The InternalClientsRequireSsl parameter specifies whether internal Outlook Anywhere clients are required to use SSL. Valid values are: -- Negotiate (This is the default value) +- $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. -You can't use this parameter with the DefaultAuthenticationMethods parameter. +The value of this parameter is related to the value of the SSLOffloading parameter. ```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -365,20 +377,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalClientsRequireSsl -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. - -The value of this parameter is related to the value of the SSLOffloading parameter. +### -InternalHostname +The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. ```yaml -Type: $true | $false +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -386,22 +393,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalClientAuthenticationMethod -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) - -- Negotiate - -You can't use this parameter with the DefaultAuthenticationMethods parameter. +### -Name +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: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured +Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -409,20 +409,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalClientsRequireSsl -The InternalClientsRequireSsl parameter specifies whether internal Outlook Anywhere clients are required to use SSL. Valid values are: +### -SSLOffloading +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: Clients connecting via Outlook Anywhere from inside the organization are required to use SSL. +- $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. +- $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. -- $false: Clients connecting via Outlook Anywhere from inside the organization aren't required to use SSL. This is the default value. +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. -The value of this parameter is related to the value of the SSLOffloading parameter. +You need to use the value $true for this parameter if you don't require SSL connections for internal or external Outlook Anywhere clients. + +The value of this parameter is related to the values of the ExternalClientsRequireSsl and InternalClientsRequireSsl parameters. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -430,14 +434,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalHostname -The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -446,20 +451,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/85806a0c-0e98-4aba-b103-8ec128dd4222.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md similarity index 81% rename from exchange/exchange-ps/exchange/policy-and-compliance/Set-OutlookProtectionRule.md rename to exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md index 74cb539483..9e222994d5 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md @@ -1,47 +1,61 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-OutlookProtectionRule ## 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. Use the Set-OutlookProtectionRule cmdlet to modify an existing Microsoft Outlook protection rule. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OutlookProtectionRule [-Identity] <RuleIdParameter> - [-ApplyRightsProtectionTemplate <RmsTemplateIdParameter>] [-Confirm] [-DomainController <Fqdn>] [-Force] - [-FromDepartment <String[]>] [-Name <String>] [-Priority <Int32>] [-SentTo <MultiValuedProperty>] - [-SentToScope <All | InOrganization>] [-UserCanOverride <$true | $false>] [-WhatIf] [<CommonParameters>] + [-ApplyRightsProtectionTemplate <RmsTemplateIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-Force] + [-FromDepartment <String[]>] + [-Name <String>] + [-Priority <Int32>] + [-SentTo <MultiValuedProperty>] + [-SentToScope <ToUserScope>] + [-UserCanOverride <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -Outlook protection rules are used to automatically rights-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see Outlook protection rules (https://technet.microsoft.com/library/dd638178.aspx). +Outlook protection rules are used to automatically rights-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). Not specifying any conditions results in an Outlook protection rule being applied to all messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-OutlookProtectionRule -Identity "OPR-DG-Finance" -SentTo "DG-Finance" ``` This example modifies the Outlook protection rule OPR-DG-Finance to apply to messages sent to the DG-Finance distribution group. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-OutlookProtectionRule -Identity "OPR-DG-Finance" -Priority 2 ``` @@ -57,6 +71,7 @@ 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 Default value: None @@ -72,6 +87,7 @@ 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 Default value: None @@ -82,8 +98,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -91,6 +106,7 @@ 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 Default value: None @@ -108,6 +124,7 @@ 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 @@ -116,13 +133,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress the confirmation prompt produced by the cmdlet when modifying a rule with no conditions, resulting in such rules being applied to all messages. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to suppress the confirmation prompt that appears when you modify a rule with no conditions (the rule applies to all messages). ```yaml Type: SwitchParameter 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 @@ -138,6 +158,7 @@ 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 Default value: None @@ -153,6 +174,7 @@ 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 Default value: None @@ -170,6 +192,7 @@ 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 Default value: None @@ -183,15 +206,10 @@ The SentTo parameter specifies one or more recipients. External recipients can b Internal recipients can be specified using any of the following values: - Alias - - Distinguished name (DN) - - ExchangeGUID - - LegacyExchangeDN - - SmtpAddress - - User principal name (UPN) ```yaml @@ -199,6 +217,7 @@ 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 Default value: None @@ -210,16 +229,16 @@ Accept wildcard characters: False The SentToScope parameter specifies the scope of messages to which the rule applies. Valid values include: - All: Applies to all messages. - - InOrganization: Applies to messages originating from inside the Exchange organization, where all recipients are also internal. If not specified, the parameter defaults to All. ```yaml -Type: All | InOrganization +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 Default value: None @@ -231,14 +250,14 @@ Accept wildcard characters: False 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. - - $false: User can't override rule action. ```yaml -Type: $true | $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 Default value: None @@ -254,6 +273,7 @@ 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 Default value: None @@ -262,20 +282,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/55878738-7045-4a38-87fe-2ecd01f8303a.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-OutlookProvider.md b/exchange/exchange-ps/exchange/Set-OutlookProvider.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access/Set-OutlookProvider.md rename to exchange/exchange-ps/exchange/Set-OutlookProvider.md index 4a514e5dd7..3d9413c338 100644 --- a/exchange/exchange-ps/exchange/client-access/Set-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-OutlookProvider @@ -13,25 +16,33 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OutlookProvider cmdlet to set specific global settings using the msExchOutlookProvider attribute on the msExchAutoDiscoverConfig object in Active Directory. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OutlookProvider [-Identity] <OutlookProviderIdParameter> [-CertPrincipalName <String>] [-Confirm] - [-DomainController <Fqdn>] [-Name <String>] [-OutlookProviderFlags <None | ServerExclusiveConnect>] - [-Server <String>] [-TTL <Int32>] [-WhatIf] [-RequiredClientVersions <String[]>] [<CommonParameters>] +Set-OutlookProvider [-Identity] <OutlookProviderIdParameter> + [-CertPrincipalName <String>] + [-Confirm] + [-DomainController <Fqdn>] + [-Name <String>] + [-OutlookProviderFlags <OutlookProviderFlags>] + [-RequiredClientVersions <String[]>] + [-Server <String>] + [-TTL <Int32>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-OutlookProvider -Identity msExchAutoDiscoverConfig -TTL 2 ``` @@ -47,6 +58,7 @@ Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -64,6 +76,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -74,8 +87,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -83,6 +95,7 @@ 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 @@ -98,6 +111,7 @@ 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 @@ -113,6 +127,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,10 +139,33 @@ Accept wildcard characters: False 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: None | ServerExclusiveConnect +Type: OutlookProviderFlags 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 +``` + +### -RequiredClientVersions +The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. This parameter uses the syntax `"MinimumVersion, ExpirationDate"`. + +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. + +An example of a valid value for this parameter is `"14.0.7012.1000, 2020-01-01T12:00:00Z"`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,6 +181,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -160,6 +199,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -175,27 +215,7 @@ 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 -``` -### -RequiredClientVersions -The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. Valid input for this parameter is "\<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. - -An example of a valid value for this parameter is "14.0.7012.1000, 2014-01-01T12:00:00Z". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -204,20 +224,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8a3d7245-528d-4501-9fc4-92ce0616cff9.aspx) diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md new file mode 100644 index 0000000000..ffb11aae40 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md @@ -0,0 +1,3015 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-OwaMailboxPolicy cmdlet to configure existing Outlook on the web mailbox policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-OwaMailboxPolicy [-Identity] <MailboxPolicyIdParameter> + [-AccountTransferEnabled <Boolean>] + [-ActionForUnknownFileAndMIMETypes <AttachmentBlockingActions>] + [-ActiveSyncIntegrationEnabled <Boolean>] + [-AdditionalAccountsEnabled <System.Boolean>] + [-AdditionalStorageProvidersAvailable <Boolean>] + [-AllAddressListsEnabled <Boolean>] + [-AllowCopyContactsToDeviceAddressBook <Boolean>] + [-AllowedFileTypes <MultiValuedProperty>] + [-AllowedMimeTypes <MultiValuedProperty>] + [-AllowedOrganizationAccountDomains <String[]>] + [-AllowOfflineOn <AllowOfflineOnEnum>] + [-BizBarEnabled <Boolean>] + [-BlockedFileTypes <MultiValuedProperty>] + [-BlockedMimeTypes <MultiValuedProperty>] + [-BookingsMailboxCreationEnabled <Boolean>] + [-BookingsMailboxDomain <String>] + [-BoxAttachmentsEnabled <Boolean>] + [-CalendarEnabled <Boolean>] + [-ChangePasswordEnabled <Boolean>] + [-ChangeSettingsAccountEnabled <System.Boolean>] + [-ClassicAttachmentsEnabled <Boolean>] + [-ConditionalAccessPolicy <PolicyEnum>] + [-Confirm] + [-ContactsEnabled <Boolean>] + [-DefaultClientLanguage <Int32>] + [-DefaultTheme <String>] + [-DelegateAccessEnabled <Boolean>] + [-DirectFileAccessOnPrivateComputersEnabled <Boolean>] + [-DirectFileAccessOnPublicComputersEnabled <Boolean>] + [-DisableFacebook] + [-DisplayPhotosEnabled <Boolean>] + [-DomainController <Fqdn>] + [-DropboxAttachmentsEnabled <Boolean>] + [-EmptyStateEnabled <Boolean>] + [-ExplicitLogonEnabled <Boolean>] + [-ExternalImageProxyEnabled <Boolean>] + [-ExternalSPMySiteHostURL <String>] + [-FeedbackEnabled <Boolean>] + [-ForceSaveAttachmentFilteringEnabled <Boolean>] + [-ForceSaveFileTypes <MultiValuedProperty>] + [-ForceSaveMimeTypes <MultiValuedProperty>] + [-ForceWacViewingFirstOnPrivateComputers <Boolean>] + [-ForceWacViewingFirstOnPublicComputers <Boolean>] + [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <Boolean>] + [-ForceWebReadyDocumentViewingFirstOnPublicComputers <Boolean>] + [-FreCardsEnabled <Boolean>] + [-GlobalAddressListEnabled <Boolean>] + [-GoogleDriveAttachmentsEnabled <Boolean>] + [-GroupCreationEnabled <Boolean>] + [-HideClassicOutlookToggleOut <System.Boolean>] + [-InstantMessagingEnabled <Boolean>] + [-InstantMessagingType <InstantMessagingTypeOptions>] + [-InterestingCalendarsEnabled <Boolean>] + [-InternalSPMySiteHostURL <String>] + [-IRMEnabled <Boolean>] + [-IsDefault] + [-ItemsToOtherAccountsEnabled <System.Boolean>] + [-JournalEnabled <Boolean>] + [-JunkEmailEnabled <Boolean>] + [-LinkedInEnabled <Boolean>] + [-LocalEventsEnabled <Boolean>] + [-LogonAndErrorLanguage <Int32>] + [-MessagePreviewsDisabled <Boolean>] + [-MonthlyUpdatesEnabled <Boolean>] + [-Name <String>] + [-NotesEnabled <Boolean>] + [-NpsSurveysEnabled <Boolean>] + [-OfflineEnabledWeb <Boolean>] + [-OfflineEnabledWin <Boolean>] + [-OneDriveAttachmentsEnabled <Boolean>] + [-OneWinNativeOutlookEnabled <System.Boolean>] + [-OnSendAddinsEnabled <Boolean>] + [-OrganizationEnabled <Boolean>] + [-OutboundCharset <OutboundCharsetOptions>] + [-OutlookBetaToggleEnabled <Boolean>] + [-OutlookDataFile <OutlookDataFileFeatureState>] + [-OutlookNewslettersAccessLevel <OutlookNewslettersAccessLevel>] + [-OutlookNewslettersReactions <OutlookNewslettersFeatureState>] + [-OutlookNewslettersShowMore <OutlookNewslettersFeatureState>] + [-OWALightEnabled <Boolean>] + [-OWAMiniEnabled <Boolean>] + [-PersonalAccountCalendarsEnabled <Boolean>] + [-PersonalAccountsEnabled <System.Boolean>] + [-PhoneticSupportEnabled <Boolean>] + [-PlacesEnabled <Boolean>] + [-PremiumClientEnabled <Boolean>] + [-PrintWithoutDownloadEnabled <Boolean>] + [-ProjectMocaEnabled <Boolean>] + [-PublicFoldersEnabled <Boolean>] + [-RecoverDeletedItemsEnabled <Boolean>] + [-ReferenceAttachmentsEnabled <Boolean>] + [-RemindersAndNotificationsEnabled <Boolean>] + [-ReportJunkEmailEnabled <Boolean>] + [-RulesEnabled <Boolean>] + [-SatisfactionEnabled <Boolean>] + [-SaveAttachmentsToCloudEnabled <Boolean>] + [-SearchFoldersEnabled <Boolean>] + [-SetPhotoEnabled <Boolean>] + [-SetPhotoURL <String>] + [-ShowOnlineArchiveEnabled <Boolean>] + [-SignaturesEnabled <Boolean>] + [-SilverlightEnabled <Boolean>] + [-SkipCreateUnifiedGroupCustomSharepointClassification <Boolean>] + [-SMimeEnabled <Boolean>] + [-SMimeSuppressNameChecksEnabled <Boolean>] + [-SpellCheckerEnabled <Boolean>] + [-TasksEnabled <Boolean>] + [-TeamSnapCalendarsEnabled <Boolean>] + [-TextMessagingEnabled <Boolean>] + [-ThemeSelectionEnabled <Boolean>] + [-ThirdPartyAttachmentsEnabled <Boolean>] + [-UMIntegrationEnabled <Boolean>] + [-UNCAccessOnPrivateComputersEnabled <Boolean>] + [-UNCAccessOnPublicComputersEnabled <Boolean>] + [-UseGB18030 <Boolean>] + [-UseISO885915 <Boolean>] + [-UserVoiceEnabled <Boolean>] + [-WacEditingEnabled <Boolean>] + [-WacExternalServicesEnabled <Boolean>] + [-WacOMEXEnabled <Boolean>] + [-WacViewingOnPrivateComputersEnabled <Boolean>] + [-WacViewingOnPublicComputersEnabled <Boolean>] + [-WeatherEnabled <Boolean>] + [-WebPartsFrameOptionsType <WebPartsFrameOptions>] + [-WebReadyDocumentViewingForAllSupportedTypes <Boolean>] + [-WebReadyDocumentViewingOnPrivateComputersEnabled <Boolean>] + [-WebReadyDocumentViewingOnPublicComputersEnabled <Boolean>] + [-WebReadyDocumentViewingSupportedFileTypes <MultiValuedProperty>] + [-WebReadyDocumentViewingSupportedMimeTypes <MultiValuedProperty>] + [-WebReadyFileTypes <MultiValuedProperty>] + [-WebReadyMimeTypes <MultiValuedProperty>] + [-WhatIf] + [-WSSAccessOnPrivateComputersEnabled <Boolean>] + [-WSSAccessOnPublicComputersEnabled <Boolean>] + [<CommonParameters>] +``` + +## 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 policies may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (`Stop-Service WAS -Force` and `Start-Service W3SVC`). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-OwaMailboxPolicy -Identity EMEA\Contoso\Corporate -CalendarEnabled $false +``` + +This example disables access to the calendar for the mailbox policy named Corporate for the tenant Contoso in the organization EMEA. + +### Example 2 +```powershell +Set-OwaMailboxPolicy -Identity Default -TasksEnabled $false +``` + +This example disables access to the Tasks folder for the default mailbox policy in an on-premises Exchange organization. + +### Example 3 +```powershell +Set-OwaMailboxPolicy -Identity OwaMailboxPolicy-Default -AllowedFileTypes '.doc', '.pdf' +``` + +This example sets the allowed file type extensions to .doc and .pdf for the default mailbox policy in an Exchange Online organization, allowing users to save files with those extensions locally or view them from a web browser. + +### Example 4 +```powershell +Set-OwaMailboxPolicy -Identity OwaMailboxPolicy-Default -UserVoiceEnabled $false +``` + +This example disables Outlook UserVoice for the default mailbox policy in Microsoft 365. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccountTransferEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionForUnknownFileAndMIMETypes +The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file types that aren't specified in the Allow, Block, and Force Save lists for file types and MIME types. Valid values are: + +- Allow (This is the default value.) +- ForceSave +- Block + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalStorageProvidersAvailable +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. +- $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 +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveSyncIntegrationEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalAccountsEnabled +This parameter is available only in the cloud-based service. + +This parameter has been deprecated and is no longer used. + +To enable or disable personal accounts in the new Outlook for Windows, use the PersonalAccountsEnabled parameter. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllAddressListsEnabled +The AllAddressListsEnabled parameter specifies which address lists are available in Outlook on the web. Valid values are: + +- $true: All address lists are visible in Outlook on the web. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCopyContactsToDeviceAddressBook +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedFileTypes +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 + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the same file types are specified in multiple lists: + +- The Block list overrides the Allow list and the Force Save list. +- The Force Save list overrides the Allow list. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedMimeTypes +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 +- image/gif +- image/jpeg +- image/png + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the same MIME types are specified in multiple lists: + +- The Allow list overrides the Block list and the Force Save list. +- The Block list overrides the Force Save list. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedOrganizationAccountDomains +This parameter is available only in the cloud-based service. + +The AllowedOrganizationAccountDomains parameter specifies domains where users can add work or school email accounts in the new Outlook for Windows. The default value is blank ($null), which allows work or school accounts from any domain. Setting this parameter to an empty list ([]) prevents any work or school accounts from being added. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOfflineOn +This parameter is functional only in on-premises Exchange. + +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. + +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). + +```yaml +Type: AllowOfflineOnEnum +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BizBarEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BizBarEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedFileTypes +The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: + +.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 + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the same file types are specified in multiple lists: + +- The Allow list overrides the Block list and the Force Save list. +- The Block list overrides the Force Save list. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedMimeTypes +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 +- application/javascript +- application/msaccess +- application/prg +- application/x-javascript +- text/javascript +- text/scriplet +- x-internet-signup + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the same MIME types are specified in multiple lists: + +- The Allow list overrides the Block list and the Force Save list. +- The Block list overrides the Force Save list. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsMailboxCreationEnabled +This parameter is available only in the cloud-based service. + +The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsMailboxDomain +This parameter is available only in the cloud-based service. + +{{ Fill BookingsMailboxDomain Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BoxAttachmentsEnabled +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChangePasswordEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChangeSettingsAccountEnabled +This parameter is available only in the cloud-based service. + +The ChangeSettingsAccountEnabled parameter specifies whether users can change the email account where app-wide settings (for example, theme and privacy settings) are associated in the new Outlook for Windows. Valid values are: + +- $true: Users can change their settings account in the new Outlook for Windows. This is the default value. +- $false: Users can't change their settings account in the new Outlook for Windows. + +**Note**: The settings account is referred to as the primary account in the new Outlook for Windows setting at Settings \> Accounts \> Email accounts \> Manage. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassicAttachmentsEnabled +The ClassicAttachmentsEnabled parameter specifies whether users can attach local files as regular email attachments in Outlook on the web. Valid values are: + +- $true: Users can attach local files to email messages in Outlook on the web. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionalAccessPolicy +This parameter is available only in the cloud-based service. + +The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Microsoft Entra admin center. + +**Note**: When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. + +Valid values are: + +- Off: No conditional access policy is applied to Outlook on the web. This is the default value. +- ReadOnly: Users can't download attachments to their local computer, and can't enable Offline Mode on non-compliant computers. They can still view attachments in the browser. This doesn't apply to in-line images. +- ReadOnlyPlusAttachmentsBlocked: All restrictions from ReadOnly apply, but users can't view attachments in the browser. This doesn't apply to in-line images. + +```yaml +Type: PolicyEnum +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -ContactsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultClientLanguage +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultTheme +The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegateAccessEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectFileAccessOnPrivateComputersEnabled +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. + +By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectFileAccessOnPublicComputersEnabled +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. + +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). + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableFacebook +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). + +The DisableFacebook switch specifies whether users can synchronize their Facebook contacts to their Contacts folder in Outlook on the web. By default, Facebook integration is enabled. + +- To disable Facebook integration, use this switch without a value. +- To enable Facebook integration after it's been disabled, use this exact syntax: `-DisableFacebook:$false`. + +The value of this switch is stored in the FacebookEnabled property in the output of the Get-OwaMailboxPolicy cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayPhotosEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DropboxAttachmentsEnabled +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmptyStateEnabled +This parameter is available only in the cloud-based service. + +{{ Fill EmptyStateEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitLogonEnabled +This parameter is functional only in on-premises Exchange. + +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalImageProxyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalSPMySiteHostURL +The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). + +This parameter is part of rich document collaboration that allows links to documents in OneDrive 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeedbackEnabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceSaveAttachmentFilteringEnabled +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceSaveFileTypes +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 + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the same file types are specified in multiple lists: + +- The Allow list overrides the Block list and the Force Save list. +- The Block list overrides the Force Save list. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceSaveMimeTypes +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 +- Application/octet-stream +- Application/x-director +- Application/x-shockwave-flash +- text/html + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the same MIME types are specified in multiple lists: + +- The Allow list overrides the Block list and the Force Save list. +- The Block list overrides the Force Save list. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceWacViewingFirstOnPrivateComputers +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. + +By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceWacViewingFirstOnPublicComputers +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. + +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceWebReadyDocumentViewingFirstOnPrivateComputers +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. + +By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceWebReadyDocumentViewingFirstOnPublicComputers +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. + +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FreCardsEnabled +This parameter is functional only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalAddressListEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleDriveAttachmentsEnabled +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupCreationEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideClassicOutlookToggleOut +This parameter is available only in the cloud-based service. + +The HideClassicOutlookToggleOut parameter specifies whether to enable or disable hiding the toggle in new Outlook that allows users to switch back to classic Outlook. Valid values are: + +- $true: The toggle to switch back to classic Outlook is hidden in new Outlook for Windows. +- $false: The toggle to switch back to classic Outlook isn't hidden in new Outlook for Windows. This is the default value. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstantMessagingEnabled +The InstantMessagingEnabled parameter specifies whether instant messaging is available in Outlook on the web. This does not affect chat capabilities provided by Skype for Business or Teams. Valid values are: + +- $true: Instant messaging is available in Outlook on the web. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstantMessagingType +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InterestingCalendarsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalSPMySiteHostURL +The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). + +This parameter is part of rich document collaboration that allows links to documents in OneDrive 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IRMEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemsToOtherAccountsEnabled +This parameter is available only in the cloud-based service. + +The ItemsToOtherAccountsEnabled parameter specifies whether users can move or copy email messages between accounts. Valid values are: + +- $true: Users can move and copy messages to and from external accounts. +- $false: Users can't move or copy messages to and from external accounts. This is the default value. + +**Note:** This policy doesn't affect moving or copying messages between Microsoft 365 Groups and shared mailboxes within the organization. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JournalEnabled +The JournalEnabled parameter specifies whether the Journal folder is available in Outlook on the web. Valid values are: + +- $true: The Journal folder is visible in Outlook on the web. This is the default value. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JunkEmailEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedInEnabled +This parameter is available only in the cloud-based service. + +LinkedIn integration is no longer supported. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalEventsEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogonAndErrorLanguage +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. + +The default value is 0, which means the logon and error language selection is undefined. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagePreviewsDisabled +This parameter is available only in the cloud-based service. + +{{ Fill MessagePreviewsDisabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlyUpdatesEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MonthlyUpdatesEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the unique name for the policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotesEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NpsSurveysEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineEnabledWeb +This parameter is available only in the cloud-based service. + +The OfflineEnabledWeb parameter specifies whether offline capabilities are available in Outlook on the web, including saving items to the local device (view items without an internet connection). Valid values are: + +- $true: Users can manage offline capabilities in Outlook on the web. This is the default value. +- $false: Users can't manage offline capabilities in Outlook on the web. No items are saved to the user's device. Previously save items are deleted. + +When offline capabilities are available, users can turn offline capabilities on or off themselves in Outlook on the web at Settings \> General \> Offline. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineEnabledWin +This parameter is available only in the cloud-based service. + +The OfflineEnabledWin parameter specifies whether offline capabilities are available in the new Outlook for Windows, including saving items to the local device (view items without an internet connection). Valid values are: + +- $true: Users can manage offline capabilities in the new Outlook for Windows. This is the default value. +- $false: Users can't manage offline capabilities in the new Outlook for Windows. No items are saved to the user's device. Previously save items are deleted. + +When offline capabilities are available, users can turn offline capabilities on or off themselves in the New Outlook for Windows at Settings \> General \> Offline. By default, offline capabilities are turned on. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAttachmentsEnabled +This parameter has been deprecated and is no longer used. + +To enable or disable personal OneDrive in Outlook on the web, use the AdditionalStorageProvidersAvailable parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneWinNativeOutlookEnabled +This parameter is available only in the cloud-based service. + +The OneWinNativeOutlookEnabled parameter controls the availability of the new Outlook for Windows App. Valid values are: + +- $true: The New Outlook for Windows App is available. This is the default value. +- $false: The new Outlook for Windows App isn't available. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnSendAddinsEnabled +The OnSendAddinsEnabled parameter specifies whether to enable or disable on send add-ins in Outlook on the web (add-ins that support events when a user clicks Send). Valid values are: + +- $true: On send add-ins are enabled. +- $false: On send add-ins are disabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundCharset +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. +- 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookBetaToggleEnabled +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. +- $false: Outlook on the web Preview is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookNewslettersAccessLevel +This parameter is available only in the cloud-based service. + +The OutlookNewslettersAccessLevelAccess parameter specifies the access level in Outlook Newsletters. Valid values are: + +- NoAccess: No access to Outlook Newsletters in the New Outlook for Windows or Outlook on the web. Users can still read email messages sent or forwarded to them. +- ReadOnly: Read newsletters and browse pages in Outlook Newsletters. +- ReadWrite: Full authoring permissions to create pages and newsletters in Outlook Newsletters. +- Undefined: This is the default value. Currently, this value is equivalent to NoAccess. + +```yaml +Type: OutlookNewslettersAccessLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookDataFile +This parameter is available only in the cloud-based service. + +The OutlookDataFile parameter specifies what users can do with .pst files in the new Outlook for Windows. Valid values are: + +- Allow: The default value. Users can open .pst files, import from a .pst file to a mailbox, export from a mailbox to a .pst file, and copy items to and from .pst files. +- NoExport: Users can't export from a mailbox to a .pst file. +- NoExportNoGrow: Users can't export from a mailbox to a .pst file, or copy items from a mailbox to a .pst file. +- NoExportNoOpen: Users can't export from a mailbox to a .pst file, or open new .pst files. +- NoExportNoOpenNoGrow: Users can't export from a mailbox to a .pst file, copy items from a mailbox to a .pst file, or open new .pst files. +- Deny: Users can't open new .pst files, import from a .pst file to a mailbox, export from a mailbox to a .pst file, or copy items to and from .pst files. + +```yaml +Type: OutlookDataFileFeatureState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: Allow +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookNewslettersReactions +This parameter is available only in the cloud-based service. + +The OutlookNewslettersReactions parameter specifies whether reactions are enabled in Outlook Newsletters. Readers can react to individual sections or the entire newsletter. They can also comment using integrated controls at the end of the newsletter. Valid values are: + +- DefaultOff: The controls are turned off. +- DefaultOn: The controls are turned on. +- Disabled: The controls are disabled for users. +- Undefined: This is the default value. + +```yaml +Type: OutlookNewslettersFeatureState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookNewslettersShowMore +This parameter is available only in the cloud-based service. + +The OutlookNewslettersShowMore parameter specifies whether recommendations to other Outlook Newsletters are included in the footer of published newsletter editions. Valid values are: + +- DefaultOff: Recommendations are turned off. +- DefaultOn: Recommendations are turned on. +- Disabled: Recommendations are disabled for users. +- Undefined: This is the default value. + +Authors can disable these recommendations for each individual newsletter edition, or admins can use this parameter to globally disable these recommendations. + +```yaml +Type: OutlookNewslettersFeatureState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWALightEnabled +The OWALightEnabled parameter controls the availability of the light version of Outlook on the web. Valid values are: + +- $true: The light version of Outlook on the web is available. This is the default value. +- $false: The light version of Outlook on the web 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAMiniEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersonalAccountCalendarsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersonalAccountsEnabled +This parameter is available only in the cloud-based service. + +The PersonalAccountsEnabled parameter specifies whether to allow users to add their personal accounts (for example, Outlook.com, Gmail, or Yahoo!) in the new Outlook for Windows. Valid values are: + +- $true: Users can add their personal accounts in the new Outlook for Windows. This is the default value. +- $false: Users can't add their personal accounts in the new Outlook for Windows. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneticSupportEnabled +The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlacesEnabled +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. +- $false: Places is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PremiumClientEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrintWithoutDownloadEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectMocaEnabled +**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. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFoldersEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoverDeletedItemsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReferenceAttachmentsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemindersAndNotificationsEnabled +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. +- $false: Notifications and reminders are disabled in Outlook on the web. + +This parameter doesn't apply to the light version of 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkEmailEnabled +**Note**: In Exchange Online, this parameter does not affect the ability of users to report messages. Whether a user is able to report messages and where is controlled in the Microsoft Defender portal as described in [User reported message settings](https://learn.microsoft.com/defender-office-365/submissions-user-reported-messages-custom-mailbox). + +The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: + +- $true: This is the default value. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RulesEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SatisfactionEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaveAttachmentsToCloudEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchFoldersEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetPhotoEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowOnlineArchiveEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ShowOnlineArchiveEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignaturesEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SilverlightEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCreateUnifiedGroupCustomSharepointClassification +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SMimeEnabled +This parameter is functional only in Exchange Server 2010. + +The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: + +- $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. +- $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. + +**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://learn.microsoft.com/Exchange/policy-and-compliance/smime). + +```yaml +Type: Boolean +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 +``` + +### -SMimeSuppressNameChecksEnabled +This parameter is available only in the cloud-based service. + +The SMimeSuppressNameChecksEnabled switch specifies whether to suppress name check in S/MIME messages. You don't need to specify a value with this switch. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpellCheckerEnabled +This parameter is 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. +- $false: Spell checking isn't available in Outlook Web App. + +This parameter doesn't apply to the light version of 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TasksEnabled +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. +- $false: The Tasks folder isn't available in Outlook Web App. + +This parameter doesn't apply to the light version of 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamSnapCalendarsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextMessagingEnabled +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. +- $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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThemeSelectionEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyAttachmentsEnabled +This parameter is available only in on-premises Exchange. + +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 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMIntegrationEnabled +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. +- $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 parameter doesn't apply to 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UNCAccessOnPrivateComputersEnabled +This parameter is available only in on-premises Exchange. + +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UNCAccessOnPublicComputersEnabled +This parameter is available only in on-premises Exchange. + +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseGB18030 +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseISO885915 +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserVoiceEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WacEditingEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WacExternalServicesEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WacOMEXEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WacViewingOnPrivateComputersEnabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WacViewingOnPublicComputersEnabled +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeatherEnabled +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. +- $false: Weather is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebPartsFrameOptionsType +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyDocumentViewingForAllSupportedTypes +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyDocumentViewingOnPrivateComputersEnabled +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyDocumentViewingOnPublicComputersEnabled +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. +- $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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyDocumentViewingSupportedFileTypes +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyDocumentViewingSupportedMimeTypes +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyFileTypes +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: + +- .doc +- .docx +- .dot +- .pdf +- .pps +- .ppt +- .pptx +- .rtf +- .xls +- .xlsx + +You can only remove or add values from within the list of supported file types (you can't add additional values). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported file types are available in WebReady Document Viewing. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebReadyMimeTypes +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: + +- application/msword +- application/pdf +- application/vnd.ms-excel +- application/vnd.ms-powerpoint +- application/vnd.openxmlformats-officedocument.presentationml.presentation +- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet +- application/vnd.openxmlformats-officedocument.wordprocessingml.document +- application/x-msexcel +- application/x-mspowerpoint + +You can only remove or add values from within the list of supported file types (you can't add additional values). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported MIME types are available in WebReady Document Viewing. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### -WSSAccessOnPrivateComputersEnabled +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WSSAccessOnPublicComputersEnabled +This parameter has been deprecated and is 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +[New-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy) + +[Get-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy) + +[Set-CASMailbox](https://learn.microsoft.com/powershell/module/exchange/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/client-access-servers/Set-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md similarity index 82% rename from exchange/exchange-ps/exchange/client-access-servers/Set-OwaVirtualDirectory.md rename to exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md index f8c2d1cb63..14358aa512 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-OwaVirtualDirectory @@ -13,169 +16,164 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OwaVirtualDirectory cmdlet to modify existing Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-OwaVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> - [-ActionForUnknownFileAndMIMETypes <Allow | ForceSave | Block>] - [-ActiveSyncIntegrationEnabled <$true | $false>] - [-AdfsAuthentication <$true | $false>] - [-AllAddressListsEnabled <$true | $false>] - [-AllowCopyContactsToDeviceAddressBook <$true | $false>] - [-AllowOfflineOn <PrivateComputersOnly | NoComputers | AllComputers>] + [-ActionForUnknownFileAndMIMETypes <AttachmentBlockingActions>] + [-ActiveSyncIntegrationEnabled <Boolean>] + [-AdfsAuthentication <Boolean>] + [-AllAddressListsEnabled <Boolean>] + [-AllowCopyContactsToDeviceAddressBook <Boolean>] + [-AllowOfflineOn <AllowOfflineOnEnum>] [-AllowedFileTypes <MultiValuedProperty>] [-AllowedMimeTypes <MultiValuedProperty>] - [-AnonymousFeaturesEnabled <$true | $false>] - [-BasicAuthentication <$true | $false>] + [-AnonymousFeaturesEnabled <Boolean>] + [-BasicAuthentication <Boolean>] [-BlockedFileTypes <MultiValuedProperty>] [-BlockedMimeTypes <MultiValuedProperty>] - [-BoxAttachmentsEnabled <$true | $false>] - [-ClassicAttachmentsEnabled <$true | $false>] - [-DropboxAttachmentsEnabled <$true | $false>] - [-CalendarEnabled <$true | $false>] - [-CalendarPublishingEnabled <$true | $false>] - [-ChangePasswordEnabled <$true | $false>] - [-ClientAuthCleanupLevel <High | Low>] + [-BoxAttachmentsEnabled <Boolean>] + [-ClassicAttachmentsEnabled <Boolean>] + [-DropboxAttachmentsEnabled <Boolean>] + [-CalendarEnabled <Boolean>] + [-CalendarPublishingEnabled <Boolean>] + [-ChangePasswordEnabled <Boolean>] + [-ClientAuthCleanupLevel <ClientAuthCleanupLevels>] [-Confirm] - [-ContactsEnabled <$true | $false>] - [-CrossSiteRedirectType <Silent | Manual>] + [-ContactsEnabled <Boolean>] + [-CrossSiteRedirectType <LegacyRedirectTypeOptions>] [-DefaultClientLanguage <Int32>] [-DefaultDomain <String>] [-DefaultTheme <String>] - [-DelegateAccessEnabled <$true | $false>] - [-DigestAuthentication <$true | $false>] - [-DirectFileAccessOnPrivateComputersEnabled <$true | $false>] - [-DirectFileAccessOnPublicComputersEnabled <$true | $false>] - [-DisplayPhotosEnabled <$true | $false>] + [-DelegateAccessEnabled <Boolean>] + [-DigestAuthentication <Boolean>] + [-DirectFileAccessOnPrivateComputersEnabled <Boolean>] + [-DirectFileAccessOnPublicComputersEnabled <Boolean>] + [-DisplayPhotosEnabled <Boolean>] [-DomainController <Fqdn>] [-Exchange2003Url <Uri>] - [-ExchwebProxyDestination <NotSpecified | MailboxServer | PublicFolderServer>] - [-ExplicitLogonEnabled <$true | $false>] + [-ExchwebProxyDestination <ExchwebProxyDestinations>] + [-ExplicitLogonEnabled <Boolean>] [-ExtendedProtectionFlags <MultiValuedProperty>] [-ExtendedProtectionSPNList <MultiValuedProperty>] - [-ExtendedProtectionTokenChecking <None | Allow | Require>] + [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalDownloadHostName <String>] [-ExternalSPMySiteHostURL <String>] [-ExternalUrl <Uri>] [-FailbackUrl <Uri>] - [-FilterWebBeaconsAndHtmlForms <UserFilterChoice | ForceFilter | DisableFilter>] - [-ForceSaveAttachmentFilteringEnabled <$true | $false>] + [-FilterWebBeaconsAndHtmlForms <WebBeaconFilterLevels>] + [-ForceSaveAttachmentFilteringEnabled <Boolean>] [-ForceSaveFileTypes <MultiValuedProperty>] [-ForceSaveMimeTypes <MultiValuedProperty>] - [-ForceWacViewingFirstOnPrivateComputers <$true | $false>] - [-ForceWacViewingFirstOnPublicComputers <$true | $false>] - [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <$true | $false>] - [-ForceWebReadyDocumentViewingFirstOnPublicComputers <$true | $false>] - [-FormsAuthentication <$true | $false>] - [-FreCardsEnabled <$true | $false>] - [-GlobalAddressListEnabled <$true | $false>] - [-GoogleDriveAttachmentsEnabled <$true | $false>] - [-GzipLevel <Off | Low | High | Error>] + [-ForceWacViewingFirstOnPrivateComputers <Boolean>] + [-ForceWacViewingFirstOnPublicComputers <Boolean>] + [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <Boolean>] + [-ForceWebReadyDocumentViewingFirstOnPublicComputers <Boolean>] + [-FormsAuthentication <Boolean>] + [-FreCardsEnabled <Boolean>] + [-GlobalAddressListEnabled <Boolean>] + [-GoogleDriveAttachmentsEnabled <Boolean>] + [-GzipLevel <GzipLevel>] [-InstantMessagingCertificateThumbprint <String>] - [-InstantMessagingEnabled <$true | $false>] + [-InstantMessagingEnabled <Boolean>] [-InstantMessagingServerName <String>] - [-InstantMessagingType <None | Ocs | Msn>] - [-IntegratedFeaturesEnabled <$true | $false>] + [-InstantMessagingType <InstantMessagingTypeOptions>] + [-IntegratedFeaturesEnabled <Boolean>] [-InternalDownloadHostName <String>] [-InternalSPMySiteHostURL <String>] [-InternalUrl <Uri>] - [-IRMEnabled <$true | $false>] - [-IsPublic <$true | $false>] - [-JournalEnabled <$true | $false>] - [-JunkEmailEnabled <$true | $false>] - [-LegacyRedirectType <Silent | Manual>] + [-IRMEnabled <Boolean>] + [-IsPublic <Boolean>] + [-JournalEnabled <Boolean>] + [-JunkEmailEnabled <Boolean>] + [-LegacyRedirectType <LegacyRedirectTypeOptions>] [-LogonAndErrorLanguage <Int32>] - [-LogonFormat <FullDomain | PrincipalName | UserName>] - [-LogonPageLightSelectionEnabled <$true | $false>] - [-LogonPagePublicPrivateSelectionEnabled <$true | $false>] - [-NotesEnabled <$true | $false>] + [-LogonFormat <LogonFormats>] + [-LogonPageLightSelectionEnabled <Boolean>] + [-LogonPagePublicPrivateSelectionEnabled <Boolean>] + [-NotesEnabled <Boolean>] [-NotificationInterval <Int32>] - [-OAuthAuthentication <$true | $false>] - [-OneDriveAttachmentsEnabled <$true | $false>] - [-OrganizationEnabled <$true | $false>] - [-OutboundCharset <AlwaysUTF8 | AutoDetect | UserLanguageChoice>] - [-OWALightEnabled <$true | $false>] - [-OWAMiniEnabled <$true | $false>] - [-PremiumClientEnabled <$true | $false>] - [-PublicFoldersEnabled <$true | $false>] - [-RecoverDeletedItemsEnabled <$true | $false>] - [-RedirectToOptimalOWAServer <$true | $false>] - [-ReferenceAttachmentsEnabled <$true | $false>] - [-RemindersAndNotificationsEnabled <$true | $false>] - [-RemoteDocumentsActionForUnknownServers <Allow | Block>] + [-OAuthAuthentication <Boolean>] + [-OneDriveAttachmentsEnabled <Boolean>] + [-OrganizationEnabled <Boolean>] + [-OutboundCharset <OutboundCharsetOptions>] + [-OWALightEnabled <Boolean>] + [-OWAMiniEnabled <Boolean>] + [-PremiumClientEnabled <Boolean>] + [-PublicFoldersEnabled <Boolean>] + [-RecoverDeletedItemsEnabled <Boolean>] + [-RedirectToOptimalOWAServer <Boolean>] + [-ReferenceAttachmentsEnabled <Boolean>] + [-RemindersAndNotificationsEnabled <Boolean>] + [-RemoteDocumentsActionForUnknownServers <RemoteDocumentsActions>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] - [-ReportJunkEmailEnabled <$true | $false>] - [-RulesEnabled <$true | $false>] - [-SaveAttachmentsToCloudEnabled <$true | $false>] - [-SearchFoldersEnabled <$true | $false>] - [-SetPhotoEnabled <$true | $false>] + [-ReportJunkEmailEnabled <Boolean>] + [-RulesEnabled <Boolean>] + [-SaveAttachmentsToCloudEnabled <Boolean>] + [-SearchFoldersEnabled <Boolean>] + [-SetPhotoEnabled <Boolean>] [-SetPhotoURL <String>] - [-SignaturesEnabled <$true | $false>] - [-SilverlightEnabled <$true | $false>] - [-SMimeEnabled <$true | $false>] - [-SpellCheckerEnabled <$true | $false>] - [-TasksEnabled <$true | $false>] - [-TextMessagingEnabled <$true | $false>] - [-ThemeSelectionEnabled <$true | $false>] - [-UMIntegrationEnabled <$true | $false>] - [-UNCAccessOnPrivateComputersEnabled <$true | $false>] - [-UNCAccessOnPublicComputersEnabled <$true | $false>] - [-UseGB18030 <$true | $false>] - [-UseISO885915 <$true | $false>] + [-SignaturesEnabled <Boolean>] + [-SilverlightEnabled <Boolean>] + [-SMimeEnabled <Boolean>] + [-SpellCheckerEnabled <Boolean>] + [-TasksEnabled <Boolean>] + [-TextMessagingEnabled <Boolean>] + [-ThemeSelectionEnabled <Boolean>] + [-UMIntegrationEnabled <Boolean>] + [-UNCAccessOnPrivateComputersEnabled <Boolean>] + [-UNCAccessOnPublicComputersEnabled <Boolean>] + [-UseGB18030 <Boolean>] + [-UseISO885915 <Boolean>] [-UserContextTimeout <Int32>] - [-VirtualDirectoryType <NotSpecified | Mailboxes | PublicFolders | Exchweb | Exadmin>] - [-WacEditingEnabled <$true | $false>] - [-WacViewingOnPrivateComputersEnabled <$true | $false>] - [-WacViewingOnPublicComputersEnabled <$true | $false>] - [-WebPartsFrameOptionsType <Deny | AllowFrom | None | SameOrigin>] - [-WebReadyDocumentViewingForAllSupportedTypes <$true | $false>] - [-WebReadyDocumentViewingOnPrivateComputersEnabled <$true | $false>] - [-WebReadyDocumentViewingOnPublicComputersEnabled <$true | $false>] + [-VirtualDirectoryType <VirtualDirectoryTypes>] + [-WacEditingEnabled <Boolean>] + [-WacViewingOnPrivateComputersEnabled <Boolean>] + [-WacViewingOnPublicComputersEnabled <Boolean>] + [-WebPartsFrameOptionsType <WebPartsFrameOptions>] + [-WebReadyDocumentViewingForAllSupportedTypes <Boolean>] + [-WebReadyDocumentViewingOnPrivateComputersEnabled <Boolean>] + [-WebReadyDocumentViewingOnPublicComputersEnabled <Boolean>] [-WebReadyDocumentViewingSupportedFileTypes <MultiValuedProperty>] [-WebReadyDocumentViewingSupportedMimeTypes <MultiValuedProperty>] [-WebReadyFileTypes <MultiValuedProperty>] [-WebReadyMimeTypes <MultiValuedProperty>] [-WhatIf] - [-WindowsAuthentication <$true | $false>] - [-WSSAccessOnPrivateComputersEnabled <$true | $false>] - [-WSSAccessOnPublicComputersEnabled <$true | $false>] [<CommonParameters>] + [-WindowsAuthentication <Boolean>] + [-WSSAccessOnPrivateComputersEnabled <Boolean>] + [-WSSAccessOnPublicComputersEnabled <Boolean>] + [<CommonParameters>] ``` ## DESCRIPTION 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. - - 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://technet.microsoft.com/library/bb684908.aspx). - +- 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-OwaVirtualDirectory -Identity "Contoso\owa (default Web site)" -DirectFileAccessOnPublicComputersEnabled $false ``` This example sets the DirectFileAccessOnPublicComputersEnabled parameter to $false on the Outlook on the web virtual directory owa on the default Internet Information Services (IIS) website on the Exchange server Contoso. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-OwaVirtualDirectory -Identity "Contoso\owa (default Web site)" -ActionForUnknownFileAndMIMETypes Block ``` @@ -184,23 +182,20 @@ This example sets the ActionForUnknownFileAndMIMETypes parameter to Block on the ## PARAMETERS ### -Identity -The Identity parameter specifies the Outlook on the web virtual directory that you want to modify. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -212,16 +207,15 @@ Accept wildcard characters: False 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.) - - ForceSave - - Block ```yaml -Type: Allow | ForceSave | Block +Type: AttachmentBlockingActions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -233,14 +227,14 @@ Accept wildcard characters: False 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. - - $false: ActiveSync isn't available in Outlook on the web ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -252,14 +246,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -271,14 +265,14 @@ Accept wildcard characters: False 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. - - $false: Only the global address list is visible in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -290,14 +284,14 @@ Accept wildcard characters: False 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. - -- $false: Contacts cann't be copied to the device's address book in Outlook on the web for devices. +- $false: Contacts can't be copied to the device's address book in Outlook on the web for devices. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -310,21 +304,21 @@ The AllowedFileTypes parameter specifies the attachment file types (file extensi .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 -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: - The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. +- The Block list overrides the Force Save 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 Default value: None @@ -333,31 +327,28 @@ Accept wildcard characters: False ``` ### -AllowedMimeTypes -The AllowedMimeTypes parameter specifies the MIME extentions of attachments that allow the attachments to be saved locally or viewed from Outlook on the web. The default values are: +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 - - image/gif - - image/jpeg - - image/png -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: - The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. +- The Block list overrides the Force Save 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 Default value: None @@ -369,18 +360,17 @@ Accept wildcard characters: False 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 is the default value. - -When offline mode is available, uers can turn offline mode on or off themselves in Outlook on the web. For more information, see [Using Outlook Web App offline](https://go.microsoft.com/fwlink/p/?linkid=267644). +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). ```yaml -Type: PrivateComputersOnly | NoComputers | AllComputers +Type: AllowOfflineOnEnum Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -392,14 +382,14 @@ Accept wildcard characters: False 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. - - $false: Features are disabled for anonymous users. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -411,16 +401,16 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. This parameter can be used with the FormsAuthentication parameter or with the DigestAuthentication and WindowsAuthentication parameters. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -431,23 +421,23 @@ Accept wildcard characters: False ### -BlockedFileTypes The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: -.ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .chm, .cmd, .com, .cpl, .csh, .exe, .fxp, .gadget, .hlp, .hta, .htc, .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, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .tmp, .url, .vb, .vbe, .vbs, .vsmacros, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh +.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 -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: - The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. +- The Block list overrides the Force Save 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 Default value: None @@ -456,39 +446,32 @@ Accept wildcard characters: False ``` ### -BlockedMimeTypes -The BlockedMimeTypes parameter specifies MIME extentions in attachments that prevent the attachments from being saved locally or viewed from Outlook on the web. The default values are: +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 - - application/javascript - - application/msaccess - - application/prg - - application/x-javascript - - text/javascript - - text/scriplet - - x-internet-signup -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: - The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. +- The Block list overrides the Force Save 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 Default value: None @@ -500,10 +483,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -515,14 +499,14 @@ Accept wildcard characters: False 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. - - $false: The Calendar isn't available in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -531,19 +515,19 @@ Accept wildcard characters: False ``` ### -CalendarPublishingEnabled -This parameter is available or functional only in 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. - - $false: Calendar publishing is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -555,14 +539,14 @@ Accept wildcard characters: False 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. - - $false: The Change password option isn't available in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -574,14 +558,14 @@ Accept wildcard characters: False 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. - - $false: Users can't attach local files to email messages in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -593,16 +577,16 @@ Accept wildcard characters: False 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) This parameter doesn't apply to the light version of Outlook on the web. ```yaml -Type: High | Low +Type: ClientAuthCleanupLevels Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -613,8 +597,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -622,6 +605,7 @@ 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 @@ -633,14 +617,14 @@ Accept wildcard characters: False 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. - - $false: Contacts aren't available in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -649,21 +633,21 @@ Accept wildcard characters: False ``` ### -CrossSiteRedirectType -This parameter is available or functional only in 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: - Silent: Users are automatically redirected when the Client Access server redirects an Outlook Web App request to Client Access server infrastructure in another Active Directory site. If using forms-based authentication, SSL is required. For redirection to occur, the target OWA virtual directory must have an ExternalURL value. - - Manual: Users receive a notification that they are accessing the wrong URL and that they must click a link to access the preferred Outlook Web App URL for their mailbox. This notification occurs only when the Client Access server determines that it must redirect an Outlook Web App request to the Client Access server infrastructure in another Active Directory site. For redirection to occur, the target OWA virtual directory must have an ExternalURL value. The default value is Manual. ```yaml -Type: Silent | Manual +Type: LegacyRedirectTypeOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -679,6 +663,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -694,6 +679,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -702,7 +688,7 @@ Accept wildcard characters: False ``` ### -DefaultTheme -The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://docs.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). +The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. @@ -711,6 +697,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -719,19 +706,19 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Web App to open folders that they have delegate access to. Valid values are: - $true: Delegates can open the mailbox in Outlook Web App. This is the default value. - - $false: Delegates can't open the mailbox in Outlook Web App. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -743,16 +730,16 @@ Accept wildcard characters: False 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. You can use this parameter with the FormsAuthentication parameter. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -764,16 +751,16 @@ Accept wildcard characters: False 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. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -785,16 +772,16 @@ Accept wildcard characters: False 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. 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). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -806,14 +793,14 @@ Accept wildcard characters: False 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. - - $false: Users don't see sender photos in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -829,6 +816,7 @@ 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 @@ -840,10 +828,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -852,7 +841,7 @@ Accept wildcard characters: False ``` ### -Exchange2003Url -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Server 2003 mailboxes. The URL must include the Outlook Web App virtual directory name, even if you're using a redirect to simplify the URL specified by the Exchange2003Url parameter. @@ -860,7 +849,8 @@ The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Ser Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -872,10 +862,11 @@ Accept wildcard characters: False This parameter has been deprecated and is no longer used. ```yaml -Type: NotSpecified | MailboxServer | PublicFolderServer +Type: ExchwebProxyDestinations Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -887,14 +878,14 @@ Accept wildcard characters: False 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. - - $false: A user with the required permissions isn't able to open someone else's mailbox in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -906,24 +897,21 @@ Accept wildcard characters: False 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. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -935,18 +923,18 @@ Accept wildcard characters: False 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. +- 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. -- 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -958,18 +946,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -981,33 +968,19 @@ Accept wildcard characters: False 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 - - Basic - - Certificate - - Digest - - Fba - - Kerberos - - LiveIdBasic - - LiveIdFba - - LiveIdNegotiate - - NegoEx - - Negotiate - - Ntlm - - OAuth - - WindowsIntegrated - - WSSecurity You can specify multiple values separated by commas. @@ -1015,7 +988,6 @@ You can specify multiple values separated by commas. Although you can specify any of these values, whether or not the authentication method actually works for external connections depends on other factors. For example: - Is the authentication method available on the virtual directory? - - Is the authentication method available, but disabled on the virtual directory? ```yaml @@ -1023,6 +995,7 @@ 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 @@ -1038,6 +1011,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1046,15 +1020,16 @@ Accept wildcard characters: False ``` ### -ExternalSPMySiteHostURL -The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, https://sp01.contoso.com). +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 Default value: None @@ -1072,6 +1047,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1089,6 +1065,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1100,16 +1077,15 @@ Accept wildcard characters: False The FilterWebBeaconsAndHtmlForms parameter specifies how web beacons are handled in Outlook on the web. Valid values are: - UserFilterChoice (This is the default value) - - ForceFilter - - DisableFilter ```yaml -Type: UserFilterChoice | ForceFilter | DisableFilter +Type: WebBeaconFilterLevels Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1121,14 +1097,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1141,21 +1117,21 @@ The ForceSaveFileTypes parameter specifies the attachment file types (file exten .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 -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: - The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. +- The Block list overrides the Force Save 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 Default value: None @@ -1164,33 +1140,29 @@ Accept wildcard characters: False ``` ### -ForceSaveMimeTypes -The ForceSaveMimeTypes parameter specifies the MIME extentions in attachments that only allow the attachments to be saved locally (not opened). The default values are: +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 - - Application/octet-stream - - Application/x-director - - Application/x-shockwave-flash - - text/html -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: - The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. +- The Block list overrides the Force Save 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 Default value: None @@ -1202,16 +1174,16 @@ Accept wildcard characters: False 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. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1223,16 +1195,16 @@ Accept wildcard characters: False 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. 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). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1246,16 +1218,16 @@ 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. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1269,16 +1241,16 @@ 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. 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). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -1289,15 +1261,15 @@ Accept wildcard characters: False ### -FormsAuthentication 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 ensabled 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 is the default value. 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1309,10 +1281,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1324,14 +1297,14 @@ Accept wildcard characters: False 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. - - $false: The global address list isn't visible in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1343,10 +1316,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1358,18 +1332,16 @@ Accept wildcard characters: False 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) - - High - - Error ```yaml -Type: Off | Low | High | Error +Type: GzipLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1385,6 +1357,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1393,17 +1366,17 @@ Accept wildcard characters: False ``` ### -InstantMessagingEnabled -The InstantMessagingEnabled parameter specifies whether instant messaging is available in Outlook on the web. Valid values are: +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. - -- $false: Instnant messaging isn't available in Outlook on the web. +- $false: Instant messaging isn't available in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1419,6 +1392,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1430,14 +1404,14 @@ Accept wildcard characters: False The InstantMessagingType parameter specifies the type of instant messaging provider in Outlook on the web. Valid values are: - None: This is the default value. - - Ocs: Lync or Skype (formerly known as Office Communication Server). ```yaml -Type: None | Ocs | Msn +Type: InstantMessagingTypeOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1448,15 +1422,15 @@ Accept wildcard characters: False ### -IntegratedFeaturesEnabled 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 featurs are enabled. For example, users logged on using Integrated Windows authentication can view and change meeting content. This is the default value. - -- $false: Itegrated features are disabled. +- $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. +- $false: Integrated features are disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1472,6 +1446,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1480,15 +1455,16 @@ Accept wildcard characters: False ``` ### -InternalSPMySiteHostURL -The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, https://sp01.contoso.com). +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 Default value: None @@ -1506,6 +1482,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1514,16 +1491,17 @@ Accept wildcard characters: False ``` ### -IRMEnabled -The IRMEnabled parameter specifies whether Information Rights Management (IRM) features are avaiable in Outlook on the web. Valid values are: +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. - - $false: IRM isn't available in Outlook on the web. + ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1535,14 +1513,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1551,17 +1529,17 @@ Accept wildcard characters: False ``` ### -JournalEnabled -The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk email management are available in Outlook on the web. +The JournalEnabled parameter specifies whether the Journal folder is 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. - -- $false: The Junk Email folder and junk email management aren't available in Outlook on the web. +- $true: The Journal folder is visible in Outlook on the web. This is the default value. +- $false: The Journal folder isn't visible in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1570,13 +1548,17 @@ Accept wildcard characters: False ``` ### -JunkEmailEnabled -The JunkEmailEnabled parameter specifies whether the Junk Email management tools are enabled. +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. +- $false: The Junk Email folder and junk email management aren't available in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1585,19 +1567,19 @@ Accept wildcard characters: False ``` ### -LegacyRedirectType -This parameter is available or functional only in 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. - - Manual: An intermediate page is displayed to show the legacy URL so that users can change their bookmarks. ```yaml -Type: Silent | Manual +Type: LegacyRedirectTypeOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1617,6 +1599,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1628,17 +1611,15 @@ Accept wildcard characters: False 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. - - 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. - ```yaml -Type: FullDomain | PrincipalName | UserName +Type: LogonFormats Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1650,16 +1631,16 @@ Accept wildcard characters: False 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. - - $false: The option to use the light version of Outlook on the web is available on the sign-in page. -This parameter is meaninful 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. +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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1671,18 +1652,18 @@ Accept wildcard characters: False 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. -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 $false. +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. When you change the value of this parameter, restart IIS (Stop-Service WAS -Force and Start-Service W3SVC). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1694,14 +1675,14 @@ Accept wildcard characters: False 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. - - $false: The Notes folder isn't visible in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1710,7 +1691,7 @@ Accept wildcard characters: False ``` ### -NotificationInterval -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The NotificationInterval parameter specifies the polling frequency in seconds that the client polls the server for new item notifications, reminder updates, and session time-out information in Outlook Web App. @@ -1723,6 +1704,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1734,10 +1716,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1749,10 +1732,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1764,10 +1748,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1779,16 +1764,15 @@ Accept wildcard characters: False 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. - -- 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. - +- 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. ```yaml -Type: AlwaysUTF8 | AutoDetect | UserLanguageChoice +Type: OutboundCharsetOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1800,14 +1784,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1816,19 +1800,19 @@ Accept wildcard characters: False ``` ### -OWAMiniEnabled -This parameter is available or functional only in 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. - - $false: The mini version of Outlook Web App isn't available. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1840,14 +1824,14 @@ Accept wildcard characters: False 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. - - $false: The full version of Outlook Web App isn't available. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1856,19 +1840,19 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: - $true: Public folders are available in Outlook Web App. This is the default value. - - $false: Public folders aren't available in Outlook Web App. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1877,19 +1861,19 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: - $true: Users can view, recover, or permanently delete items in Outlook Web App. This is the default value. - - $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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1901,14 +1885,14 @@ Accept wildcard characters: False 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. - - $false: Outlook on the web doesn't redirect clients to the optimal Mailbox server. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1920,14 +1904,14 @@ Accept wildcard characters: False 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. - - $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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1939,16 +1923,16 @@ Accept wildcard characters: False 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. - - $false: Notifications and reminders are disabled in Outlook on the web. This parameter doesn't apply to the light version of Outlook Web App. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1957,15 +1941,16 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsActionForUnknownServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. ```yaml -Type: Allow | Block +Type: RemoteDocumentsActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1974,7 +1959,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsAllowedServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1983,6 +1968,7 @@ 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 @@ -1991,7 +1977,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsBlockedServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1999,7 +1985,8 @@ This parameter has been deprecated and is no longer used. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2008,7 +1995,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsInternalDomainSuffixList -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -2016,7 +2003,8 @@ This parameter has been deprecated and is no longer used. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2025,19 +2013,19 @@ Accept wildcard characters: False ``` ### -ReportJunkEmailEnabled -The ReportJunkEmailEnabled parameter specifies whether users can report messages to Microsoft or unsubscribe from messages in Outlook on the web. Valid values are: - -- $true: The Report junk, Report phishing or Report not junk options are available after the user selects Mark as junk, Mark as phishing, or Mark as not junk. The Unsubscribe option is also available. This is the default value. +The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: -- $false: The Report junk, Report phishing, Report not junk and Unsubscribe options aren't available. +- $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. +- $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2049,14 +2037,14 @@ Accept wildcard characters: False 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. - - $false: Users can't view, create, or modify server-side rules in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2068,14 +2056,14 @@ Accept wildcard characters: False 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. - - $false: Users can only save regular email attachments locally. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2084,17 +2072,19 @@ Accept wildcard characters: False ``` ### -SearchFoldersEnabled +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. - - $false: Search Folders aren't visible in Outlook on the Web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2106,14 +2096,14 @@ Accept wildcard characters: False 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. - - $false: Users can't manage their user photo in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2129,6 +2119,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2140,14 +2131,14 @@ Accept wildcard characters: False 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. - - $false: Signatures aren't available in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2156,19 +2147,19 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: - $true: Silverlight features are available in Outlook Web App. This is the default value. - - $false: Silverlight features aren't available in Outlook Web App. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2177,21 +2168,21 @@ Accept wildcard characters: False ``` ### -SMimeEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: - $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. - - $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. -**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see {S/MIME for message signing and encryption](https://technet.microsoft.com/library/dn626158.aspx). +**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://learn.microsoft.com/Exchange/policy-and-compliance/smime). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2200,21 +2191,21 @@ Accept wildcard characters: False ``` ### -SpellCheckerEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: - $true: Spell checking is available in Outlook Web App. This is the default value. - - $false: Spell checking isn't available in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2226,16 +2217,16 @@ Accept wildcard characters: False 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. - - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2247,16 +2238,16 @@ Accept wildcard characters: False 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. - - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2268,14 +2259,14 @@ Accept wildcard characters: False 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. - - $false: Users can't specify or change the theme in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2287,7 +2278,6 @@ Accept wildcard characters: False 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. - - $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). @@ -2295,10 +2285,11 @@ This setting applies only if Unified Messaging has been enabled for a user (for This parameter doesn't apply to the light version of Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2310,10 +2301,11 @@ Accept wildcard characters: False This parameter has been deprecated and is no longer used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2325,10 +2317,11 @@ Accept wildcard characters: False This parameter has been deprecated and is no longer used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2340,14 +2333,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2359,14 +2352,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2384,6 +2377,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2395,10 +2389,11 @@ Accept wildcard characters: False This parameter has been deprecated and is no longer used. ```yaml -Type: NotSpecified | Mailboxes | PublicFolders | Exchweb | Exadmin +Type: VirtualDirectoryTypes Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2410,14 +2405,14 @@ Accept wildcard characters: False 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. - - $false: Users can't edit supported documents in Outlook on the web. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2429,16 +2424,16 @@ Accept wildcard characters: False 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. - - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2450,16 +2445,16 @@ Accept wildcard characters: False 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. - - $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). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2470,17 +2465,16 @@ Accept wildcard characters: False ### -WebPartsFrameOptionsType The WebPartsFrameOptionsType parameter specifies what sources can access web parts in IFRAME or FRAME elements in Outlook on the web. Valid values are: -- None: Tthere are no restrictions on displaying Outlook on the web content in a frame. - +- 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. - - 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: Deny | AllowFrom | None | SameOrigin +Type: WebPartsFrameOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2494,14 +2488,14 @@ This parameter is available only in Exchange Server 2010 and Exchange Server 201 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. - - $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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2514,17 +2508,17 @@ This parameter is available only in Exchange Server 2010 and Exchange Server 201 The WebReadyDocumentViewingOnPrivateComputersEnabled parameter specifies whether WebReady Document Viewing is available in private computer sessions. Valid values are: -- $true: WebReady Document Viewing is availble in private computer sessions. This is the default value. - -- $false: WebReady Document Viewing isn't availble in private computer sessions. +- $true: WebReady Document Viewing is available in private computer sessions. This is the default value. +- $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2537,17 +2531,17 @@ This parameter is available only in Exchange Server 2010 and Exchange Server 201 The WebReadyDocumentViewingOnPublicComputersEnabled parameter specifies whether WebReady Document Viewing is in public computer sessions. Valid values are: -- $true: WebReady Document Viewing is availble for public computer sessions. This is the default value. - -- $false: WebReady Document Viewing isn't availble for public computer sessions. +- $true: WebReady Document Viewing is available for public computer sessions. This is the default value. +- $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). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2565,6 +2559,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2575,13 +2570,14 @@ Accept wildcard characters: False ### -WebReadyDocumentViewingSupportedMimeTypes 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.. +This is a read-only parameter that can't be modified; use the WebReadyMimeTypes parameter instead. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2595,30 +2591,21 @@ This parameter is available only in Exchange Server 2010 and Exchange Server 201 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: - .doc - - .docx - - .dot - - .pdf - - .pps - - .ppt - - .pptx - - .rtf - - .xls - - .xlsx You can only remove or add values from within the list of supported file types (you can't add additional values). -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported file types are available in WebReady Document Viewing. @@ -2627,6 +2614,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2637,31 +2625,23 @@ Accept wildcard characters: False ### -WebReadyMimeTypes This parameter is available only in Exchange Server 2010 and Exchange Server 2013. -The WebReadyMimeTypes parameter specifies the MIME extentions 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: +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: - application/msword - - application/pdf - - application/vnd.ms-excel - - application/vnd.ms-powerpoint - - application/vnd.openxmlformats-officedocument.presentationml.presentation - - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - application/x-msexcel - - application/x-mspowerpoint You can only remove or add values from within the list of supported file types (you can't add additional values). -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported MIME types are available in WebReady Document Viewing. @@ -2670,6 +2650,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013 + Required: False Position: Named Default value: None @@ -2685,6 +2666,7 @@ 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 @@ -2696,14 +2678,14 @@ Accept wildcard characters: False 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. - -- $true: 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 is the default value. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2715,10 +2697,11 @@ Accept wildcard characters: False This parameter has been deprecated and is no longer used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2730,10 +2713,11 @@ Accept wildcard characters: False This parameter has been deprecated and is no longer used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2742,20 +2726,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7fadcc2e-6339-48b1-b15c-c89e45d4e430.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Set-PartnerApplication.md b/exchange/exchange-ps/exchange/Set-PartnerApplication.md similarity index 75% rename from exchange/exchange-ps/exchange/organization/Set-PartnerApplication.md rename to exchange/exchange-ps/exchange/Set-PartnerApplication.md index a33e33ecd3..157ce52607 100644 --- a/exchange/exchange-ps/exchange/organization/Set-PartnerApplication.md +++ b/exchange/exchange-ps/exchange/Set-PartnerApplication.md @@ -1,79 +1,90 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-partnerapplication +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-PartnerApplication schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-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 functional only in on-premises Exchange. -Use the Set-PartnerApplication cmdlet to configure partner application configurations. +Use the Set-PartnerApplication cmdlet to configure partner application configurations in on-premises Exchange organizations. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ACSTrustApplication ``` -Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter> [-ApplicationIdentifier <String>] [-Realm <String>] - [-AcceptSecurityIdentifierInformation <$true | $false>] - [-AccountType <OrganizationalAccount | ConsumerAccount>] +Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter> + [-ApplicationIdentifier <String>] + [-Realm <String>] + [-AcceptSecurityIdentifierInformation <Boolean>] + [-AccountType <SupportedAccountType>] [-ActAsPermissions <String[]>] [-AppOnlyPermissions <String[]>] [-Confirm] [-DomainController <Fqdn>] - [-Enabled <$true | $false>] + [-Enabled <Boolean>] [-IssuerIdentifier <String>] [-LinkedAccount <UserIdParameter>] [-Name <String>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### AuthMetadataUrl ``` -Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter> [-AuthMetadataUrl <String>] [-TrustAnySSLCertificate] - [-AcceptSecurityIdentifierInformation <$true | $false>] - [-AccountType <OrganizationalAccount | ConsumerAccount>] +Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter> + [-AuthMetadataUrl <String>] + [-TrustAnySSLCertificate] + [-AcceptSecurityIdentifierInformation <Boolean>] + [-AccountType <SupportedAccountType>] [-ActAsPermissions <String[]>] [-AppOnlyPermissions <String[]>] [-Confirm] [-DomainController <Fqdn>] - [-Enabled <$true | $false>] + [-Enabled <Boolean>] [-IssuerIdentifier <String>] [-LinkedAccount <UserIdParameter>] [-Name <String>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### RefreshAuthMetadata ``` -Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter> [-RefreshAuthMetadata] - [-AcceptSecurityIdentifierInformation <$true | $false>] - [-AccountType <OrganizationalAccount | ConsumerAccount>] +Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter> + [-RefreshAuthMetadata] + [-AcceptSecurityIdentifierInformation <Boolean>] + [-AccountType <SupportedAccountType>] [-ActAsPermissions <String[]>] [-AppOnlyPermissions <String[]>] [-Confirm] [-DomainController <Fqdn>] - [-Enabled <$true | $false>] + [-Enabled <Boolean>] [-IssuerIdentifier <String>] [-LinkedAccount <UserIdParameter>] [-Name <String>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/en-us/library/jj150480.aspx). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. +You can configure partner applications such as SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-PartnerApplication HRApp -RefreshAuthMetadata ``` @@ -85,18 +96,16 @@ This example refreshes the auth metadata for the HRApp partner application. 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 - - ApplicationID (GUID value) - - Distinguished name (DN) - - GUID ```yaml Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: True Position: 1 Default value: None @@ -108,10 +117,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -123,14 +133,14 @@ Accept wildcard characters: False 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 - - ConsumerAccount ```yaml -Type: OrganizationalAccount | ConsumerAccount +Type: SupportedAccountType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -146,6 +156,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -161,6 +172,25 @@ Type: String Parameter Sets: ACSTrustApplication Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppOnlyPermissions +This parameter is available only in Exchange Server 2013. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -178,6 +208,7 @@ Type: String Parameter Sets: AuthMetadataUrl Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -188,15 +219,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -214,6 +245,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -225,10 +257,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -237,7 +270,7 @@ Accept wildcard characters: False ``` ### -IssuerIdentifier -This parameter is available or functional only in Exchange Server 2013. +This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -246,6 +279,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013 + Required: False Position: Named Default value: None @@ -261,6 +295,7 @@ Type: UserIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -276,6 +311,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -293,6 +329,7 @@ Type: String Parameter Sets: ACSTrustApplication Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -303,13 +340,14 @@ Accept wildcard characters: False ### -RefreshAuthMetadata This parameter is available only in on-premises Exchange. -The RefreshAuthMetadata switch specifies that the auth metadata should be refreshed from the authorization server. +The RefreshAuthMetadata switch refreshes the auth metadata from the authorization server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshAuthMetadata Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -320,13 +358,16 @@ Accept wildcard characters: False ### -TrustAnySSLCertificate This parameter is available only in on-premises Exchange. -The TrustAnySSLCertificate switch specifies whether Exchange should trust certificates issued by a certification authority (CA) not trusted by the server. We don't recommend using this switch in a production environment. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +We don't recommend using this switch in a production environment. ```yaml Type: SwitchParameter Parameter Sets: AuthMetadataUrl Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -341,7 +382,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + Required: False Position: Named Default value: None @@ -350,20 +392,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/22550369-102f-424a-bfa3-98144695ecbe.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md b/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md similarity index 79% rename from exchange/exchange-ps/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md rename to exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md index 24d7f2333f..a823ef0913 100644 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md +++ b/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-PendingFederatedDomain @@ -15,24 +18,29 @@ The Set-PendingFederatedDomain cmdlet is used by the Exchange admin center to co The domains being added to the federation trust must exist as accepted domains in the Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-PendingFederatedDomain [[-Identity] <OrganizationIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-PendingAccountNamespace <SmtpDomain>] [-PendingDomains <SmtpDomain[]>] [-WhatIf] [<CommonParameters>] +Set-PendingFederatedDomain [[-Identity] <OrganizationIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-PendingAccountNamespace <SmtpDomain>] + [-PendingDomains <SmtpDomain[]>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-PendingFederatedDomain -PendingDomains contoso.com,sales.contoso.com ``` @@ -40,11 +48,26 @@ This example adds the pending domains contoso.com and sales.contoso.com to the e ## PARAMETERS +### -Identity +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 +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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -52,6 +75,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -67,6 +91,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -74,21 +99,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -PendingAccountNamespace The PendingAccountNamespace parameter specifies the pending domain that's used as the account namespace for the federation trust. @@ -97,6 +107,7 @@ Type: SmtpDomain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -112,6 +123,7 @@ Type: SmtpDomain[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -127,6 +139,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,20 +148,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b16b8ac2-4414-4510-a0f0-936591b2642d.aspx) diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md new file mode 100644 index 0000000000..d104c470f0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-PerimeterConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-PerimeterConfig cmdlet to modify the list of gateway server IP addresses that have been added to the cloud-based safelists. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-PerimeterConfig [[-Identity] <OrganizationIdParameter>] + [-Confirm] + [-GatewayIPAddresses <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +If you have an on-premises email system, you can use the Set-PerimeterConfig cmdlet to add the IP addresses of your gateway servers to cloud-based safelists (also known as whitelists) to make sure that messages sent from your on-premises email system aren't treated as spam. + +## EXAMPLES + +### Example 1 +```powershell +Set-PerimeterConfig -GatewayIPAddresses 123.0.0.1 +``` + +This example shows how to add an IP address to cloud-based safelists where the gateway server relays email to the cloud-based service from internal email servers only. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayIPAddresses +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md new file mode 100644 index 0000000000..95798fa9a6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md @@ -0,0 +1,182 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-PhishSimOverridePolicy + +## 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). + +For 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-PhishSimOverridePolicy [-Identity] <PolicyIdParameter> + [-Comment <String>] + [-Confirm] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-Force] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-PhishSimOverridePolicy -Identity PhishSimOverridePolicy -Enabled $false +``` + +This example disables the phishing simulation override policy. + +## PARAMETERS + +### -Identity +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 +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md new file mode 100644 index 0000000000..aeffd3882a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -0,0 +1,497 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-Place + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-Place cmdlet to update room mailboxes with additional metadata, which provides a better search and room suggestion experience. + +**Note**: In hybrid environments, this cmdlet doesn't work on the following properties on synchronized room mailboxes: City, CountryOrRegion, GeoCoordinates, Phone, PostalCode, State, or Street. To modify these properties (except GeoCoordinates on synchronized room mailboxes), use the Set-User or Set-Mailbox cmdlets in on-premises Exchange. + +**Note**: We recommend using this cmdlet with the EXO V3 module. Commands using Set-Place to change certain combinations of properties together can fail in older versions of the module. For more information about the EXO V3 module, see [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-Place [-Identity] <RecipientIdParameter> + [-AudioDeviceName <String>] + [-Building <String>] + [-Capacity <System.Int32>] + [-City <String>] + [-Confirm] + [-CountryOrRegion <CountryInfo>] + [-DisplayDeviceName <String>] + [-Floor <System.Int32>] + [-FloorLabel <String>] + [-GeoCoordinates <GeoCoordinates>] + [-IsWheelChairAccessible <Boolean>] + [-Label <String>] + [-MTREnabled <Boolean>] + [-ParentId <String>] + [-ParentType <Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType>] + [-Phone <String>] + [-PostalCode <String>] + [-State <String>] + [-Street <String>] + [-Tags <String[]>] + [-VideoDeviceName <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-Place -Identity "Conference Room 01" -IsWheelChairAccessible $true -AudioDeviceName PolyCom -DisplayDeviceName "InFocus WXGA Projector" +``` + +The example adds the specified metadata to the room mailbox named Conference Room 01. + +### Example 2 +```powershell +Set-Place -Identity "Conference Room 02" -Building "Building 02" -Capacity 5 -CountryOrRegion ES -Floor 3 -FloorLabel "Human Resources" -Label Interviews +``` + +The example adds the specified metadata to the room mailbox named Conference Room 02. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AudioDeviceName +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Building +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion +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). + +The friendly name is returned in the CountryOrRegion property value by the Get-Place cmdlet, but you can use either the friendly name or the two-letter country code in filter operations. + +```yaml +Type: CountryInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayDeviceName +The DisplayDeviceName parameter specifies the name of the display device in the room. If the value contains spaces, enclose the value in quotation marks ("). + +The default value is blank ($null). To indicate that this room has no display device, use the value $null for this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Floor +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FloorLabel +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoCoordinates +The GeoCoordinates parameter specifies the room's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: + +- Latitude and longitude: For example, "47.644125;-122.122411" +- Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432" + +**Note**: If period separators don't work for you, use commas instead. + +```yaml +Type: GeoCoordinates +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsWheelChairAccessible +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MTREnabled +**Note**: Currently, this parameter is informational only and results in no additional functionality. + +The MTREnabled parameter identifies the room as configured with a Microsoft Teams room system. You can add Teams room systems as audio sources in Teams meetings that involve the room. Valid values are: + +- $true: The room is has a Teams room system. You can add the Teams room system to Microsoft Teams meetings when selecting to join a meeting with room audio. +- $false: The room is does not have a Teams room system. Users will join Teams meetings using their PC or mobile device audio instead of using room audio. This is the default value. + +For more information about Microsoft Teams Rooms, see [Microsoft Teams Rooms](https://learn.microsoft.com/microsoftteams/rooms/). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentId +**Note**: This feature is experimental and is available only for organizations using Microsoft Places. + +The ParentId parameter specifies the ID of a Place in the parent location hierarchy in Microsoft Places. + +Organizations that are onboarding Rooms and Workspaces to Microsoft Places need to use the ParentId and ParentType parameters in a Set-Place command so Microsoft Places works properly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentType +**Note**: This feature is experimental and is available only for organizations using Microsoft Places. + +The ParentType parameter specifies the parent type of the ParentId in Microsoft Places. Valid values are: + +- Floor +- Section + +Organizations that are onboarding Rooms and Workspaces to Microsoft Places need to use the ParentId and ParentType parameters in a Set-Place command so Microsoft Places works properly. + +```yaml +Type: Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +The Phone parameter specifies the room's telephone number. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +The PostalCode parameter specifies the room's postal code. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The State parameter specifies the room's state or province. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Street +The Street parameter specifies the room's physical address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +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"`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoDeviceName +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/exchange/Set-PolicyConfig.md new file mode 100644 index 0000000000..6455c497f6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PolicyConfig.md @@ -0,0 +1,630 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-PolicyConfig + +## 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-PolicyConfig cmdlet to modify the endpoint restrictions that are configured in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-PolicyConfig [[-Identity] <OrganizationIdParameter>] + [-CaseHoldPolicyLimit <Int32>] + [-ClassificationScheme <ClassificationScheme>] + [-ComplianceUrl <String>] + [-Confirm] + [-DlpAppGroups <PswsHashtable[]>] + [-DlpAppGroupsPsws <PswsHashtable[]>] + [-DlpExtensionGroups <PswsHashtable[]>] + [-DlpNetworkShareGroups <PswsHashtable>] + [-DlpPrinterGroups <PswsHashtable>] + [-DlpRemovableMediaGroups <PswsHashtable>] + [-DocumentIsUnsupportedSeverity <RuleSeverity>] + [-EnableAdvancedRuleBuilder <Boolean>] + [-EnableLabelCoauth <Boolean>] + [-EnableSpoAipMigration <Boolean>] + [-EndpointDlpGlobalSettings <PswsHashtable[]>] + [-EndpointDlpGlobalSettingsPsws <PswsHashtable[]>] + [-ExtendTeamsDlpPoliciesToSharePointOneDrive <Boolean>] + [-InformationBarrierMode <InformationBarrierMode>] + [-InformationBarrierPeopleSearchRestriction <InformationBarrierPeopleSearchRestriction>] + [-IsDlpSimulationOptedIn <Boolean>] + [-OnPremisesWorkload <Workload>] + [-ProcessingLimitExceededSeverity <RuleSeverity>] + [-PurviewLabelConsent <Boolean>] + [-ReservedForFutureUse <Boolean>] + [-RetentionForwardCrawl <Boolean>] + [-RuleErrorAction <PolicyRuleErrorAction>] + [-SenderAddressLocation <PolicySenderAddressLocation>] + [-SiteGroups <PswsHashtable[]>] + [-SiteGroupsPsws <PswsHashtable[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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 + +### -Identity +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CaseHoldPolicyLimit +{{ Fill CaseHoldPolicyLimit Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationScheme +{{ Fill ClassificationScheme Description }} + +```yaml +Type: ClassificationScheme +Parameter Sets: (All) +Aliases: +Accepted values: Default, V0_AggregatedOnly, V1_DetailedResults +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceUrl +{{ Fill ComplianceUrl Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -DlpAppGroups +{{ Fill DlpAppGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpAppGroupsPsws +{{ Fill DlpAppGroupsPsws Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpExtensionGroups +{{ Fill DlpExtensionGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpNetworkShareGroups +{{ Fill DlpNetworkShareGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPrinterGroups +{{ Fill DlpPrinterGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpRemovableMediaGroups +{{ Fill DlpRemovableMediaGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentIsUnsupportedSeverity +{{ Fill DocumentIsUnsupportedSeverity Description }} + +```yaml +Type: RuleSeverity +Parameter Sets: (All) +Aliases: +Accepted values: Low, Medium, High, None, Informational, Information +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAdvancedRuleBuilder +{{ Fill EnableAdvancedRuleBuilder Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLabelCoauth +The EnableLabelCoauth parameter enables or disables co-authoring support in Office desktop apps for the entire organization. Valid value are: + +- $true: Co-authoring support in Office desktop apps is enabled. When documents are labeled and encrypted by sensitivity labels, multiple users can edit these documents at the same time. Labeling information for unencrypted files is no longer saved in custom properties. Don't enable co-authoring if you use any apps, services, scripts, or tools that read or write labeling metadata to the old location. +- $false: Co-authoring support in Office desktop apps is disabled. + +Disabling co-authoring support in Office desktop apps in the organization has the following consequences: + +- For apps and services that support the new labeling metadata, they now revert to the original metadata format and location when labels are read or saved. +- The new metadata format and location for Office documents that was used while the setting was enabled will not be copied to the original format and location. As a result, this labeling information for unencrypted Word, Excel, and PowerPoint files will be lost. +- Co-authoring and AutoSave no longer work in your organization for labeled and encrypted documents. +- Sensitivity labels remain enabled for Office files in OneDrive and SharePoint. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpoAipMigration +The EnableSpoAipMigration parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: + +- $true: Users can apply your sensitivity labels in Office for the web. Users will see the Sensitivity button on the ribbon so they can apply labels, and see any applied label name on the status bar. +- $false: Users can't apply your sensitivity labels in Office for the web. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpGlobalSettings +The EndpointDlpGlobalSettings parameter specifies the global endpoints. This parameter uses the following syntax: `@(@{"Setting"="<Setting>"; "Value"="<Value>}",@{"Setting"="<Setting>"; "Value"="<Value>"},...)`. + +The value of `<Setting>` is one of the supported values. + +Example values: + +- `@{"Setting"="PathExclusion"; "Value"="C:\Windows";}` +- `@{"Setting"="PathExclusion"; "Value"="%AppData%\Mozilla";}` +- `@{"Setting"="PathExclusion"; "Value"="C:\Users\*\Desktop";}` +- `@{"Setting"="UnallowedApp"="Notepad ++;"Executable"="notepad++"}` +- `@{"Setting"="UnallowedApp"="Executable"="cmd"}` +- `@{"Setting"="UnallowedBrowser"="Chrome";"Executable"="chrome"}` +- `@{"Setting"="CloudAppRestrictions"="Allow"}` +- `@{"Setting"="CloudAppRestrictionList"="1.1.2.2"}` +- `@{"Setting"="CloudAppRestrictionList"="subdomain.com"}` +- `@{"Setting"="CloudAppRestrictionList"="another.differentdomain.edu"}` +- `@{"Setting"="ShowEndpointJustificationDropdown"; "True";}` + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpGlobalSettingsPsws +{{ Fill EndpointDlpGlobalSettingsPsws Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendTeamsDlpPoliciesToSharePointOneDrive +The ExtendTeamsDlpPoliciesToSharePointOneDrive parameter enables the Teams DLP Policy to automatically extend protection to the content stored in OneDrive shared in 1:1 chats and content stored in SharePoint associated with Teams teams shared through channel chats. Valid values are: + +- $true +- $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationBarrierMode +The InformationBarrierMode parameter specifies the mode that controls the total number of segments and how many segments a user can be part of. Valid values are: + +- SingleSegment: Users in the organization can have 5000 segments but can only be assigned to one segment. +- MultiSegment: Users in the organization can have 5000 segments and can be assigned up to 10 segments. For more information, see [Use multi-segment support in information barriers](https://learn.microsoft.com/purview/information-barriers-multi-segment). + +```yaml +Type: InformationBarrierMode +Parameter Sets: (All) +Aliases: +Accepted values: SingleSegment, MultiSegment +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationBarrierPeopleSearchRestriction +{{ Fill InformationBarrierPeopleSearchRestriction Description }} + +```yaml +Type: InformationBarrierPeopleSearchRestriction +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDlpSimulationOptedIn +{{ Fill IsDlpSimulationOptedIn Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesWorkload +{{ Fill OnPremisesWorkload Description }} + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingLimitExceededSeverity +{{ Fill ProcessingLimitExceededSeverity Description }} + +```yaml +Type: RuleSeverity +Parameter Sets: (All) +Aliases: +Accepted values: Low, Medium, High, None, Informational, Information +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PurviewLabelConsent +{{ Fill PurviewLabelConsent Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedForFutureUse +{{ Fill ReservedForFutureUse Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionForwardCrawl +{{ Fill RetentionForwardCrawl Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: + +- Ignore +- RetryThenBlock (This is the default value) + +```yaml +Type: PolicyRuleErrorAction +Parameter Sets: (All) +Aliases: +Accepted values: Ignore, RetryThenBlock +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +```yaml +Type: PolicySenderAddressLocation +Parameter Sets: (All) +Aliases: +Accepted values: Header, Envelope, HeaderOrEnvelope +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteGroups +{{ Fill SiteGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteGroupsPsws +{{ Fill SiteGroupsPsws Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md new file mode 100644 index 0000000000..16cd681d3b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md @@ -0,0 +1,158 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-PolicyTipConfig cmdlet to modify custom Policy Tips in your organization. You can't modify built-in Policy Tips. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-PolicyTipConfig [-Identity] <PolicyTipConfigIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Value <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-PolicyTipConfig en\NotifyOnly "This message contains content that is restricted by Contoso company policy." +``` + +This example modifies the custom English Policy Tip with the action value NotifyOnly. The text of this custom Policy Tip is changed to the following value: "This message contains content that is restricted by Contoso company policy." + +### Example 2 +```powershell +Get-PolicyTipConfig -Locale es | Set-PolicyTipConfig -Value "Este mensaje contiene contenido que está restringida por la política de Contoso." +``` + +This example replaces the text of all custom Spanish Policy Tips with the value, "Este mensaje contiene contenido que está restringida por la política de Contoso." + +## PARAMETERS + +### -Identity +The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: + +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- The value Url +- GUID +- Distinguished name (DN) + +```yaml +Type: PolicyTipConfigIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/client-access/Set-PopSettings.md b/exchange/exchange-ps/exchange/Set-PopSettings.md similarity index 81% rename from exchange/exchange-ps/exchange/client-access/Set-PopSettings.md rename to exchange/exchange-ps/exchange/Set-PopSettings.md index 088ccbc814..a6e5d017f8 100644 --- a/exchange/exchange-ps/exchange/client-access/Set-PopSettings.md +++ b/exchange/exchange-ps/exchange/Set-PopSettings.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-PopSettings @@ -13,64 +16,80 @@ This cmdlet is available only in on-premises Exchange. Use the Set-PopSettings cmdlet to modify the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed, and is used by POP3 clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-PopSettings [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-Banner <String>] - [-CalendarItemRetrievalOption <iCalendar | intranetUrl | InternetUrl | Custom>] [-Confirm] - [-DomainController <Fqdn>] [-EnableExactRFC822Size <$true | $false>] - [-EnableGSSAPIAndNTLMAuth <$true | $false>] [-EnforceCertificateErrors <$true | $false>] - [-ExtendedProtectionPolicy <None | Allow | Require>] [-ExternalConnectionSettings <MultiValuedProperty>] - [-InternalConnectionSettings <MultiValuedProperty>] [-LogFileLocation <String>] - [-LogFileRollOverSettings <Hourly | Daily | Weekly | Monthly>] - [-LoginType <PlainTextLogin | PlainTextAuthentication | SecureLogin>] [-LogPerFileSizeQuota <Unlimited>] - [-MaxCommandSize <Int32>] [-MaxConnectionFromSingleIP <Int32>] [-MaxConnections <Int32>] +Set-PopSettings [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>] + [-Banner <String>] + [-CalendarItemRetrievalOption <CalendarItemRetrievalOptions>] + [-Confirm] + [-DomainController <Fqdn>] + [-EnableExactRFC822Size <Boolean>] + [-EnableGSSAPIAndNTLMAuth <Boolean>] + [-EnforceCertificateErrors <Boolean>] + [-ExtendedProtectionPolicy <ExtendedProtectionTokenCheckingMode>] + [-ExternalConnectionSettings <MultiValuedProperty>] + [-InternalConnectionSettings <MultiValuedProperty>] + [-LogFileLocation <String>] + [-LogFileRollOverSettings <LogFileRollOver>] + [-LoginType <LoginOptions>] + [-LogPerFileSizeQuota <Unlimited>] + [-MaxCommandSize <Int32>] + [-MaxConnectionFromSingleIP <Int32>] + [-MaxConnections <Int32>] [-MaxConnectionsPerUser <Int32>] - [-MessageRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] - [-MessageRetrievalSortOrder <Ascending | Descending>] [-OwaServerUrl <Uri>] - [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-ProtocolLogEnabled <$true | $false>] - [-ProxyTargetPort <Int32>] [-Server <ServerIdParameter>] [-SSLBindings <MultiValuedProperty>] - [-SuppressReadReceipt <$true | $false>] [-UnencryptedOrTLSBindings <MultiValuedProperty>] [-WhatIf] - [-X509CertificateName <String>] [<CommonParameters>] + [-MessageRetrievalMimeFormat <MimeTextFormat>] + [-MessageRetrievalSortOrder <SortOrder>] + [-OwaServerUrl <Uri>] + [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>] + [-ProtocolLogEnabled <Boolean>] + [-ProxyTargetPort <Int32>] + [-Server <ServerIdParameter>] + [-SSLBindings <MultiValuedProperty>] + [-SuppressReadReceipt <Boolean>] + [-UnencryptedOrTLSBindings <MultiValuedProperty>] + [-WhatIf] + [-X509CertificateName <String>] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-PopSettings -Server "MBX01" -UnencryptedOrTLSBindings 10.0.0.0:110 ``` This example configures the unencrypted or STARTTLS encrypted POP3 connection to the server named MBX01 by using the local IP address 10.0.0.0 on TCP port 110. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-PopSettings -ProtocolLogEnabled $true -LogFileLocation "C:\Pop3Logging" ``` This example turns on POP3 protocol logging. It also changes the POP3 protocol logging directory to C:\\Pop3Logging. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-PopSettings -LogPerFileSizeQuota 2MB ``` This example changes the POP3 protocol logging to create a new log file when a log file reaches 2 megabytes (MB). -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Set-PopSettings -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly ``` This example changes the POP3 protocol logging to create a new log file every hour. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Set-PopSettings -X509CertificateName mail.contoso.com ``` @@ -92,6 +111,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -107,6 +127,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -115,23 +136,21 @@ Accept wildcard characters: False ``` ### -CalendarItemRetrievalOption -The CalendarItemRetrievalOption parameter specifies how calendar items are presented to POP3 clients.. Valid values are: +The CalendarItemRetrievalOption parameter specifies how calendar items are presented to POP3 clients. Valid values are: - 0 or iCalendar. This is the default value. - - 1 or IntranetUrl. - - 2 or InternetUrl. - - 3 or Custom. If you specify 3 or Custom, you need to specify a value for the OwaServerUrl parameter. ```yaml -Type: iCalendar | intranetUrl | InternetUrl | Custom +Type: CalendarItemRetrievalOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -142,8 +161,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -151,6 +169,7 @@ 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 @@ -166,6 +185,7 @@ 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 @@ -177,14 +197,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -196,14 +216,14 @@ Accept wildcard characters: False 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. - - $false: NTLM for POP3 connections is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -215,14 +235,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -234,18 +254,17 @@ Accept wildcard characters: False 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. - - 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. Extended Protection for Authentication enhances the protection and handling of credentials by Integrated Windows authentication (also known as NTLM), so we strongly recommend that you use it if it's supported by your clients (default installations of Windows 7 or later and Windows Server 2008 R2 or later support it). ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -256,13 +275,13 @@ Accept wildcard characters: False ### -ExternalConnectionSettings 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\>:[\<TLS | SSL\>]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[<TLS | SSL>]`. The encryption method value is optional (blank indicates unencrypted connections). The default value is blank ($null), which means no external POP3 connection settings are configured. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -271,6 +290,7 @@ 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 @@ -281,13 +301,13 @@ Accept wildcard characters: False ### -InternalConnectionSettings 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\>:[\<TLS | SSL\>]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[<TLS | SSL>]`. The encryption method value is optional (blank indicates unencrypted connections). -The default value is \<ServerFQDN\>:995:SSL,\<ServerFQDN\>:110:TLS. +The default value is `<ServerFQDN>:995:SSL,<ServerFQDN>:110:TLS`. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -296,6 +316,7 @@ 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 @@ -313,6 +334,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -323,21 +345,19 @@ Accept wildcard characters: False ### -LogFileRollOverSettings The LogFileRollOverSettings parameter defines how frequently POP3 protocol logging creates a new log file. Valid values are: -- 1 or Hourly. - -- 2 or Daily. This is the default value. - +- 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. +- 2 or Daily. This is the default value in Exchange 2013 and Exchange 2010. - 3 or Weekly. - - 4 or Monthly. This parameter is only meaningful when the LogPerFileSizeQuota parameter value is 0, and the ProtocolLogEnabled parameter value is $true. ```yaml -Type: Hourly | Daily | Weekly | Monthly +Type: LogFileRollOver Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -349,16 +369,15 @@ Accept wildcard characters: False 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. ```yaml -Type: PlainTextLogin | PlainTextAuthentication | SecureLogin +Type: LoginOptions Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -372,13 +391,9 @@ The LogPerFileSizeQuota parameter specifies the maximum size of a POP3 protocol When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -392,6 +407,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -407,6 +423,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -422,6 +439,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -437,6 +455,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -452,6 +471,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -463,24 +483,19 @@ Accept wildcard characters: False The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are: - 0 or TextOnly. - - 1 or HtmlOnly. - - 2 or HtmlAndTextAlternative. - - 3 or TextEnrichedOnly. - - 4 or TextEnrichedAndTextAlternative. - - 5 or BestBodyFormat. This is the default value. - - 6 or Tnef. ```yaml -Type: TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef +Type: MimeTextFormat Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -492,14 +507,14 @@ Accept wildcard characters: False The MessageRetrievalSortOrder parameter specifies how retrieved messages are sorted. Valid values are: - 0 or Ascending. This is the default value. - - 1 or Descending. ```yaml -Type: Ascending | Descending +Type: SortOrder Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -515,6 +530,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -534,6 +550,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -545,14 +562,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -568,6 +585,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -579,11 +597,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -593,6 +608,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -601,19 +617,20 @@ Accept wildcard characters: False ``` ### -SSLBindings -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 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. +The default value is `[::]:995,0.0.0.0:995`. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -625,14 +642,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -641,19 +658,20 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings -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 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. +The default value is `[::]:110, 0.0.0.0:110`. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -669,6 +687,7 @@ 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 @@ -690,6 +709,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -698,20 +718,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/307a1dd0-3a4c-4431-bd9f-35aa5cb57aad.aspx) diff --git a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md new file mode 100644 index 0000000000..16c3da7808 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md @@ -0,0 +1,309 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-PowerShellVirtualDirectory + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-PowerShellVirtualDirectory cmdlet to modify existing Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-PowerShellVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> + [-BasicAuthentication <Boolean>] + [-CertificateAuthentication <Boolean>] + [-Confirm] + [-DomainController <Fqdn>] + [-ExtendedProtectionFlags <MultiValuedProperty>] + [-ExtendedProtectionSPNList <MultiValuedProperty>] + [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>] + [-ExternalUrl <Uri>] + [-InternalUrl <Uri>] + [-RequireSSL <Boolean>] + [-WhatIf] + [-WindowsAuthentication <Boolean>] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-PowerShellVirtualDirectory "Contoso (default Web site)" -ExternalUrl "https://www.contoso.com/powershell" +``` + +This example modifies the external URL of the Contoso Windows PowerShell virtual directory. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BasicAuthentication +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateAuthentication +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -ExtendedProtectionFlags +The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: + +- None: This is the default setting. +- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. +- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. +- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionSPNList +The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: + +- $null: This is the default value. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionTokenChecking +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: + +- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. + +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. + +```yaml +Type: ExtendedProtectionTokenCheckingMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUrl +The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. + +```yaml +Type: Uri +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 +``` + +### -InternalUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSSL +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### -WindowsAuthentication +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md new file mode 100644 index 0000000000..c1875d6ea6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -0,0 +1,612 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-ProtectionAlert + +## 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-ProtectionAlert cmdlet to modify alert policies in the Microsoft Purview compliance portal. + +**Note**: You can't use this cmdlet to edit default alert policies. You can only modify alerts that you created using the New-ProtectionAlert cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ProtectionAlert [-Identity] <ComplianceRuleIdParameter> + [-AggregationType <AlertAggregationType>] + [-AlertBy <MultiValuedProperty>] + [-AlertFor <MultiValuedProperty>] + [-Category <AlertRuleCategory>] + [-Comment <String>] + [-Confirm] + [-Description <String>] + [-Disabled <Boolean>] + [-Filter <String>] + [-NotificationCulture <CultureInfo>] + [-NotificationEnabled <Boolean>] + [-NotifyUser <MultiValuedProperty>] + [-NotifyUserOnFilterMatch <Boolean>] + [-NotifyUserSuppressionExpiryDate <DateTime>] + [-NotifyUserThrottleThreshold <Int32>] + [-NotifyUserThrottleWindow <Int32>] + [-Operation <MultiValuedProperty>] + [-PrivacyManagementScopedSensitiveInformationTypes <MultiValuedProperty>] + [-PrivacyManagementScopedSensitiveInformationTypesForCounting <MultiValuedProperty>] + [-PrivacyManagementScopedSensitiveInformationTypesThreshold <System.UInt64>] + [-Severity <RuleSeverity>] + [-Threshold <Int32>] + [-TimeWindow <Int32>] + [-VolumeThreshold <System.UInt64>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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-ProtectionAlert -Identity "Content search deleted" -Severity High +``` + +This example sets the Severity of the detection to High for the specified alert policy. + +### Example 2 +```powershell +Set-ProtectionAlert -Identity "Content search deleted" -NotifyUserOnFilterMatch:$true -AggregationType SimpleAggregation -Threshold 10 -TimeWindow 120 +``` + +This example modifies an alert so that even though it's configured for aggregated activity, a notification is triggered during a match for the activity. A threshold of 10 detections and a TimeWindow of two hours are also configured in the same command. + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -AggregationType +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. + +```yaml +Type: AlertAggregationType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertBy +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. +- Malware: Valid values are Mail.Recipient or Mail.ThreatName. + +You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). + +```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 +``` + +### -AlertFor +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category +The Category parameter specifies a category for the alert policy. Valid values are: + +- AccessGovernance +- ComplianceManager +- DataGovernance +- MailFlow +- Others +- PrivacyManagement +- Supervision +- ThreatManagement + +When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting + +```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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +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. + +```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 +``` + +### -Filter +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the `-and` logical operator (for example, `"Criteria1 -and Criteria2"`). + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +The filterable properties are: + +Activity + +- Activity.ClientIp +- Activity.CreationTime +- Activity.Item +- Activity.ItemType +- Activity.Operation +- Activity.ResultStatus +- Activity.Scope +- Activity.SiteUrl +- Activity.SourceFileExtension +- Activity.SourceFileName +- Activity.TargetUserOrGroupType +- Activity.UserAgent +- Activity.UserId +- Activity.UserType +- Activity.Workload + +Malware + +- Mail:AttachmentExtensions +- Mail:AttachmentNames +- Mail:CreationTime +- Mail:DeliveryStatus +- Mail:Direction +- Mail:From +- Mail:FromDomain +- Mail:InternetMessageId +- Mail:IsIntraOrgSpoof +- Mail:IsMalware +- Mail:IsSpam +- Mail:IsThreat +- Mail:Language +- Mail:Recipient +- Mail:Scl +- Mail:SenderCountry +- Mail:SenderIpAddress +- Mail:Subject +- Mail:TenantId +- Mail:ThreatName + +You can specify multiple criteria by using the -and comparison operator. + +```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 +``` + +### -NotificationCulture +The NotificationCulture parameter specifies the language or locale that's used for notifications. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://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 +``` + +### -NotificationEnabled +{{ Fill NotificationEnabled 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 +``` + +### -NotifyUser +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUserOnFilterMatch +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. + +You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). + +```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 +``` + +### -NotifyUserSuppressionExpiryDate +The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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: + +- An integer. +- The value $null. This is the default value (no maximum number of notifications for an alert). + +```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 +``` + +### -NotifyUserThrottleWindow +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). + +```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 +``` + +### -Operation +The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). + +Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. + +You can only use this parameter when the ThreatType parameter has the value Activity. + +```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 +``` + +### -PrivacyManagementScopedSensitiveInformationTypes +{{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesForCounting +{{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesThreshold +{{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +The Severity parameter specifies the severity of the detection. Valid values are: + +- 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 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. + +```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 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. + +```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 +``` + +### -VolumeThreshold +{{ Fill VolumeThreshold Description }} + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/sharing-and-collaboration/Set-PublicFolder.md b/exchange/exchange-ps/exchange/Set-PublicFolder.md similarity index 78% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/Set-PublicFolder.md rename to exchange/exchange-ps/exchange/Set-PublicFolder.md index e73a5f8c85..d2f0376645 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolder.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-PublicFolder @@ -13,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-PublicFolder cmdlet to set the attributes of public folders. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,49 +26,51 @@ Set-PublicFolder [-Identity] <PublicFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] [-EformsLocaleId <CultureInfo>] - [-HiddenFromAddressListsEnabled <$true | $false>] + [-Force] + [-HiddenFromAddressListsEnabled <Boolean>] [-IssueWarningQuota <Unlimited>] [-LocalReplicaAgeLimit <EnhancedTimeSpan>] [-MailRecipientGuid <Guid>] - [-MailEnabled <$true | $false>] + [-MailEnabled <Boolean>] [-MaxItemSize <Unlimited>] [-Name <String>] [-OverrideContentMailbox <MailboxIdParameter>] [-Path <PublicFolderIdParameter>] - [-PerUserReadStateEnabled <$true | $false>] + [-PerUserReadStateEnabled <Boolean>] [-ProhibitPostQuota <Unlimited>] [-Replicas <DatabaseIdParameter[]>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-Server <ServerIdParameter>] - [-UseDatabaseAgeDefaults <$true | $false>] - [-UseDatabaseQuotaDefaults <$true | $false>] - [-UseDatabaseReplicationSchedule <$true | $false>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-UseDatabaseAgeDefaults <Boolean>] + [-UseDatabaseQuotaDefaults <Boolean>] + [-UseDatabaseReplicationSchedule <Boolean>] + [-UseDatabaseRetentionDefaults <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-PublicFolder "\Customer Service Requests" -UseDatabaseReplicationSchedule $false ``` In Exchange 2010, this example changes a public folder so that it doesn't use the database default replication schedule. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-PublicFolder "\Customer Service Requests" -OverrideContentMailbox North_America ``` This example changes the content location of the public folder hierarchy mailbox to North\_America. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-PublicFolder \MyPublicFolder -ReplicationSchedule "Saturday.12:00 AM-Monday.12:00 AM" ``` @@ -74,13 +79,14 @@ In Exchange 2010, this example sets the folder to replicate only on weekends. ## PARAMETERS ### -Identity -The Identity parameter specifies the name and path of the public folder you want to modify. A valid value uses the format: \\\<Level1\>\\\<Level2\>\\...\\\<LevelN\>\\\<PublicFolder\>. For example, "\\Customer Discussion" or "\\Engineering\\Customer Discussion". +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 Default value: None @@ -98,6 +104,7 @@ 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 Default value: None @@ -108,8 +115,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -117,6 +123,7 @@ 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 Default value: None @@ -134,6 +141,7 @@ 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 @@ -142,13 +150,14 @@ Accept wildcard characters: False ``` ### -EformsLocaleId -The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). +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 Default value: None @@ -157,13 +166,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -172,15 +184,16 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled -This parameter is available or functional only in 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -196,13 +209,9 @@ The default value is unlimited, which is 2 terabytes. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -214,6 +223,7 @@ 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 Default value: None @@ -222,7 +232,7 @@ Accept wildcard characters: False ``` ### -LocalReplicaAgeLimit -This parameter is available or functional only in 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. @@ -231,6 +241,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -244,10 +255,11 @@ The MailEnabled parameter specifies that the public folder is mail-enabled. To d 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -265,6 +277,7 @@ Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -278,13 +291,9 @@ The MaxItemSize parameter specifies the maximum size for posted items. Items lar When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -296,6 +305,7 @@ 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 Default value: None @@ -311,6 +321,7 @@ 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 Default value: None @@ -321,13 +332,25 @@ Accept wildcard characters: False ### -OverrideContentMailbox This parameter is available only in on-premises Exchange. -The OverrideContentMailbox parameter specifies the identity of the public folder mailbox that you want to move this public folder's content to. +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -343,6 +366,7 @@ Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -354,10 +378,11 @@ Accept wildcard characters: False The PerUserReadStateEnabled parameter specifies whether to maintain read and unread data on a per-user basis. ```yaml -Type: $true | $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 Default value: None @@ -371,13 +396,9 @@ The ProhibitPostQuota parameter specifies the size of a public folder at which u When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -389,6 +410,7 @@ 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 Default value: None @@ -397,15 +419,22 @@ Accept wildcard characters: False ``` ### -Replicas -This parameter is available or functional only in 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: + +- Name +- Distinguished name (DN) +- GUID -The Replicas parameter specifies a list of public folder databases with which to replicate this public folder. +You can specify multiple values separated by commas. If the values contain spaces, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: DatabaseIdParameter[] Parameter Sets: Set2 Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -414,32 +443,28 @@ Accept wildcard characters: False ``` ### -ReplicationSchedule -This parameter is available or functional only in Exchange Server 2010 +This parameter is available only in Exchange Server 2010 The ReplicationSchedule parameter specifies the replication schedule for the folder. -The format is StartDay.Hour:Minute [AM/PM]-EndDay.Hour:Minute [AM/PM]. You can use the following values for the start and end days: - -- Full name of the day +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. -- Abbreviated name of the day +You can use the following values for days: -- Integer from 0 through 6, where 0 = Sunday +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. -If you prefer to use a 24-hour clock, omit AM/PM. If you use AM/PM, you must include a space between the time and AM or PM. +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. -Formats can be mixed. +You can mix and match date/time formats. -The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. -The following are examples: +Here are some examples: - "Sun.11:30 PM-Mon.1:30 AM" - -- 6.22:00-6.22:15 (Maintenance will run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - -- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Maintenance will run on Monday and Wednesday mornings from 4:30 until 5:30.) - +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - "Sun.1:15 AM-Monday.23:00" ```yaml @@ -447,6 +472,7 @@ Type: Schedule Parameter Sets: Set2 Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -464,6 +490,7 @@ 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 Default value: None @@ -472,15 +499,23 @@ Accept wildcard characters: False ``` ### -Server -This parameter is available or functional only in Exchange Server 2010 +This parameter is available only in Exchange Server 2010 -The Server parameter specifies the server on which to perform the selected operations. +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -489,15 +524,16 @@ Accept wildcard characters: False ``` ### -UseDatabaseAgeDefaults -This parameter is available or functional only in Exchange Server 2010 +This parameter is available only in Exchange Server 2010 The UseDatabaseAgeDefaults parameter specifies whether to use the database age limit. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -506,15 +542,16 @@ Accept wildcard characters: False ``` ### -UseDatabaseQuotaDefaults -This parameter is available or functional only in Exchange Server 2010 +This parameter is available only in Exchange Server 2010 The UseDatabaseQuotaDefaults parameter specifies whether to use the public store quota limits. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -523,15 +560,16 @@ Accept wildcard characters: False ``` ### -UseDatabaseReplicationSchedule -This parameter is available or functional only in Exchange Server 2010 +This parameter is available only in Exchange Server 2010 The UseDatabaseReplicationSchedule parameter specifies whether to use the public folder replication schedule. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -540,15 +578,16 @@ Accept wildcard characters: False ``` ### -UseDatabaseRetentionDefaults -This parameter is available or functional only in Exchange Server 2010 +This parameter is available only in Exchange Server 2010 The UseDatabaseRetentionDefaults parameter specifies whether to use the database retention defaults. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -564,6 +603,7 @@ 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 Default value: None @@ -572,20 +612,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/657a8e15-2587-41b5-986c-2289b2772c89.aspx) diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md new file mode 100644 index 0000000000..85ad17feda --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md @@ -0,0 +1,541 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-PublicFolderDatabase + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Set-PublicFolderDatabase cmdlet to set attributes of public folder databases. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-PublicFolderDatabase [-Identity] <DatabaseIdParameter> + [-AllowFileRestore <Boolean>] + [-BackgroundDatabaseMaintenance <Boolean>] + [-CircularLoggingEnabled <Boolean>] + [-Confirm] + [-CustomReferralServerList <MultiValuedProperty>] + [-DeletedItemRetention <EnhancedTimeSpan>] + [-DomainController <Fqdn>] + [-EventHistoryRetentionPeriod <EnhancedTimeSpan>] + [-IssueWarningQuota <Unlimited>] + [-ItemRetentionPeriod <Unlimited>] + [-MaintenanceSchedule <Schedule>] + [-MaxItemSize <Unlimited>] + [-MountAtStartup <Boolean>] + [-Name <String>] + [-ProhibitPostQuota <Unlimited>] + [-QuotaNotificationSchedule <Schedule>] + [-ReplicationMessageSize <ByteQuantifiedSize>] + [-ReplicationPeriod <UInt32>] + [-ReplicationSchedule <Schedule>] + [-RetainDeletedItemsUntilBackup <Boolean>] + [-UseCustomReferralServerList <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-PublicFolderDatabase -Identity 'PFDB01' -DeletedItemRetention '10.00:00:00' +``` + +This example sets the deleted items retention on the public folder database PFDB01 to 10 days. + +### Example 2 +```powershell +Set-PublicFolderDatabase -Identity 'PFDB01'-MaintenanceSchedule 'Sun.2:00 AM-Sun.6:00 AM, Mon.2:00 AM-Mon.6:00 AM, Tue.2:00 AM-Tue.6:00 AM, Wed.2:00 AM-Wed.6:00 AM, Thu.2:00 AM-Thu.6:00 AM, Fri.2:00 AM-Fri.6:00 AM, Sat.2:00 AM-Sat.6:00 AM' +``` + +This example sets the database maintenance schedule on PFDB01 to run daily from 02:00 (2:00 A.M.) until 06:00 (6:00 A.M.). + +### Example 3 +```powershell +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. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllowFileRestore +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackgroundDatabaseMaintenance +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CircularLoggingEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomReferralServerList +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". + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedItemRetention +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHistoryRetentionPeriod +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueWarningQuota +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemRetentionPeriod +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceSchedule +The MaintenanceSchedule parameter specifies the store maintenance schedule. + +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" + +```yaml +Type: Schedule +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxItemSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MountAtStartup +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProhibitPostQuota +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaNotificationSchedule +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]`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" + +```yaml +Type: Schedule +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +A valid value is a number up to 2 gigabytes (2147482624 bytes). The default value is 300 kilobytes (307200 bytes). + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +```yaml +Type: ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationPeriod +The ReplicationPeriod parameter specifies the interval at which replication of public folders or content updates may occur. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationSchedule +The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents may occur. + +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" + +```yaml +Type: Schedule +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainDeletedItemsUntilBackup +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomReferralServerList +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md new file mode 100644 index 0000000000..7c4de5b3bf --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md @@ -0,0 +1,366 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-PublicFolderMigrationRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-PublicFolderMigrationRequest cmdlet to modify serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). You can use this cmdlet to recover from failed migration requests. + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Set-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> + [-AcceptLargeDataLoss] + [-BadItemLimit <Unlimited>] + [-BatchName <String>] + [-CompletedRequestAgeLimit <Unlimited>] + [-Confirm] + [-DomainController <Fqdn>] + [-InternalFlags <InternalMrsFlag[]>] + [-LargeItemLimit <Unlimited>] + [-PreventCompletion <Boolean>] + [-Priority <RequestPriority>] + [-RequestExpiryInterval <Unlimited>] + [-SkipMerging <SkippableMergeComponent[]>] + [-WhatIf] + [<CommonParameters>] +``` + +### Rehome +``` +Set-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> -RehomeRequest + [-Confirm] + [-DomainController <Fqdn>] + [-PreventCompletion <Boolean>] + [-RequestExpiryInterval <Unlimited>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You can pipe output of Get-PublicFolderMigrationRequestStatistics, Get-PublicFolderMigrationRequest, or Get-PublicFolder to 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-PublicFolderMigrationRequest -Identity PublicFolderMigration -BadItemLimit 5 +``` + +This example changes the setting of the PublicFolderMigration migration request to accept up to five corrupted public folder items. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the migration request that you want to modify. You can use the following values: + +- Name +- RequestGUID + +```yaml +Type: PublicFolderMigrationRequestIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RehomeRequest +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Rehome +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +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 +``` + +### -BadItemLimit +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. + +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. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -BatchName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompletedRequestAgeLimit +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalFlags +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LargeItemLimit +The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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: + +- 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. + +If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. + +```yaml +Type: Unlimited +Parameter Sets: Identity +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 +``` + +### -PreventCompletion +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: + +- Lowest +- Lower +- Low +- Normal: This is the default value. +- High +- Higher +- Highest +- Emergency + +```yaml +Type: RequestPriority +Parameter Sets: Identity +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 +``` + +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMerging +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/move-and-migration/Set-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/move-and-migration/Set-PublicFolderMoveRequest.md rename to exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md index f6117dfbfa..f63c7353d0 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-PublicFolderMoveRequest @@ -13,28 +16,35 @@ 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. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-PublicFolderMoveRequest [-Identity] <PublicFolderMoveRequestIdParameter> [-AcceptLargeDataLoss] - [-BadItemLimit <Unlimited>] [-CompletedRequestAgeLimit <Unlimited>] [-Confirm] [-DomainController <Fqdn>] - [-InternalFlags <InternalMrsFlag[]>] [-LargeItemLimit <Unlimited>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-SuspendWhenReadyToComplete <$true | $false>] [-WhatIf] [-RequestExpiryInterval <Unlimited>] +Set-PublicFolderMoveRequest [-Identity] <PublicFolderMoveRequestIdParameter> + [-AcceptLargeDataLoss] + [-BadItemLimit <Unlimited>] + [-CompletedRequestAgeLimit <Unlimited>] + [-Confirm] + [-DomainController <Fqdn>] + [-InternalFlags <InternalMrsFlag[]>] + [-LargeItemLimit <Unlimited>] + [-Priority <RequestPriority>] + [-RequestExpiryInterval <Unlimited>] + [-SuspendWhenReadyToComplete <Boolean>] + [-WhatIf] [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-PublicFolderMoveRequest -Identity \PublicFolderMove -BadItemLimit 5 ``` @@ -50,6 +60,7 @@ Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -58,13 +69,16 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. +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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -77,13 +91,12 @@ The BadItemLimit parameter specifies the maximum number of bad items that are al 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. -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -99,6 +112,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -109,8 +123,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -118,6 +131,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -133,6 +147,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -148,6 +163,7 @@ Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -160,9 +176,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) +- 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. @@ -173,6 +188,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -184,26 +200,20 @@ Accept wildcard characters: False 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. - - High - - Higher - - Highest - - Emergency ```yaml -Type: Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency +Type: RequestPriority Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -211,14 +221,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SuspendWhenReadyToComplete -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. +### -RequestExpiryInterval +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. +- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. + +When you use the value Unlimited, the completed request isn't automatically removed. ```yaml -Type: $true | $false +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -226,14 +244,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -SuspendWhenReadyToComplete +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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -241,22 +260,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. +### -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: Unlimited +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -265,20 +277,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/491cd0a5-d22b-4430-8a22-4e9e09b7f6ce.aspx) diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md new file mode 100644 index 0000000000..124bd14378 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepermissions +applicable: Exchange Online, Exchange Online Protection +title: Set-QuarantinePermissions +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-QuarantinePermissions + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets. + +Use the Set-QuarantinePermissions cmdlet to modify quarantine permissions objects that were created by the New-QuarantinePermissions and stored as a variable in the current PowerShell session. You use the variable as a value for the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-QuarantinePermissions -QuarantinePermissionsObject <QuarantinePermissions> + [[-PermissionToAllowSender] <Boolean>] + [[-PermissionToBlockSender] <Boolean>] + [[-PermissionToDelete] <Boolean>] + [[-PermissionToDownload] <Boolean>] + [[-PermissionToPreview] <Boolean>] + [[-PermissionToRelease] <Boolean>] + [[-PermissionToRequestRelease] <Boolean>] + [[-PermissionToViewHeader] <Boolean>] + [<CommonParameters>] +``` + +## DESCRIPTION +To see the current value of the permissions object that you want to modify, run the variable name as a command. For example, run the command `$Perms` to see the quarantine policy permissions stored in the `$Perms` variable. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-QuarantinePermissions -QuarantinePermissionsObject $Perms -PermissionToRequestRelease $true -PermissionToRelease $false +``` + +This example modifies the quarantine policy permissions in the exiting `$Perms` variable that was previously created using the New-QuarantinePermissions cmdlet in the same PowerShell session (the `$Perms` variable is still available and populated). + +In the same PowerShell session, you can use `$Perms` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +## PARAMETERS + +### -QuarantinePermissionsObject +The QuarantinePermissionsObject parameter specifies the existing variable that contains quarantine permissions that you want to modify. For example if you previously ran the command `$Perms = New-QuarantinePermissions <permissions>`, use the value `$Perms` for this parameter. + +```yaml +Type: QuarantinePermissions +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToAllowSender +The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: + +- $true: Allow sender is available for affected messages in quarantine. +- $false: Allow sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToBlockSender +The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: + +- $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. +- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDelete +The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: + +- $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. +- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDownload +The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToPreview +The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: + +- $true: Preview message is available for affected messages in quarantine. +- $false: Preview message isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRelease +The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: + +- $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. +- $false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRequestRelease +The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: + +- $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. +- $false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToViewHeader +The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md new file mode 100644 index 0000000000..796d65b9a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -0,0 +1,551 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepolicy +applicable: Exchange Online, Exchange Online Protection +title: Set-QuarantinePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-QuarantinePolicy cmdlet to modify quarantine policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-QuarantinePolicy [-Identity] <QuarantineTagIdParameter> + [-AdminNotificationFrequencyInDays <Int32>] + [-AdminNotificationLanguage <EsnLanguage>] + [-AdminNotificationsEnabled <Boolean>] + [-AdminQuarantinePermissionsList <MultiValuedProperty>] + [-Confirm] + [-CustomDisclaimer <String>] + [-DomainController <Fqdn>] + [-EndUserQuarantinePermissions <QuarantinePermissions>] + [-EndUserQuarantinePermissionsValue <Int32>] + [-EndUserSpamNotificationCustomFromAddress <String>] + [-EndUserSpamNotificationFrequency <TimeSpan>] + [-EndUserSpamNotificationFrequencyInDays <Int32>] + [-EndUserSpamNotificationLanguage <EsnLanguage>] + [-EsnCustomSubject <MultiValuedProperty>] + [-ESNEnabled <Boolean>] + [-IgnoreDehydratedFlag] + [-IncludeMessagesFromBlockedSenderAddress <Boolean>] + [-MultiLanguageCustomDisclaimer <MultiValuedProperty>] + [-MultiLanguageSenderName <MultiValuedProperty>] + [-MultiLanguageSetting <MultiValuedProperty>] + [-OrganizationBrandingEnabled <Boolean>] + [-QuarantineRetentionDays <Int32>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You can't modify the built-in quarantine policies named AdminOnlyAccessPolicy, DefaultFullAccessPolicy, or DefaultFullAccessWithNotificationPolicy. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-QuarantinePolicy -Identity CustomAccess -EndUserQuarantinePermissionsValue 1 +``` + +This example configures the permissions in the quarantine policy named CustomAccess that allows users to delete quarantined messages only. + +### Example 2 +```powershell +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy -MultiLanguageSetting ('English','ChineseSimplified','French') -MultiLanguageCustomDisclaimer ('For more information, contact the Help Desk.','有关更多信息，请联系服务台','Pour plus d''informations, contactez le service d''assistance.') -ESNCustomSubject ('You have quarantined messages','您有隔离邮件','Vous avez des messages en quarantaine') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -EndUserSpamNotificationCustomFromAddress aashutosh@contso.onmicrosoft.com -OrganizationBrandingEnabled $true -EndUserSpamNotificationFrequency 04:00:00 +``` + +This example modifies the global settings for quarantine notifications (formerly known as end-user spam notification settings): + +- Quarantine notifications are customized for English, Chinese, and French. Extra quotation marks are required in the French MultiLanguageCustomDisclaimer value as escape characters for the quotation mark characters in the text. +- The existing user aashutosh@contso.onmicrosoft.com is used as the quarantine notification sender. +- The previously configured custom logo replaces the default Microsoft logo. +- The frequency of quarantine notifications is changed to 4 hours. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the quarantine policy you want to modify. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: QuarantineTagIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdminNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminQuarantinePermissionsList +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissions +**Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter. + +The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command. + +For example, run the following command to store the required permissions in a variable: `$Perms = New-QuarantinePermissions <permissions>`. In the same PowerShell session, use the value `$Perms` for this parameter. + +```yaml +Type: QuarantinePermissions +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissionsValue +The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. + +This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): + +- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message. +- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender +- PermissionToBlockSender +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. +- PermissionToPreview +- PermissionToDelete + +The values for the preset end-user permission groups are described in the following list: + +- No access: Binary = 0000000, so use the decimal value 0. +- Limited access: Binary = 00101011, so use the decimal value 43. +- Full access: Binary = 00100111, so use the decimal value 39. + +For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter. + +**Note**: If the value of this parameter is 0 (No access) and the value of the ESNEnabled parameter is $true, users can view their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationCustomFromAddress +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: + +- 04:00:00 (4 hours) +- 1.00:00:00 (1 day) +- 7.00:00:00 (7 days) + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EsnCustomSubject +The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: MultiValuedProperty +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ESNEnabled +The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: + +- $true: Quarantine notifications are enabled. +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. + +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can view their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDehydratedFlag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are: + +- $true: Recipients get quarantine notifications for affected messages from blocked senders. +- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageCustomDisclaimer +The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications. The localized text, **A disclaimer from your organization:** is always included first, followed by the text you specify for this parameter. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSenderName +The MultiLanguageSenderName parameter specifies the email sender's display name to use in quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you can specify a unique sender name. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSetting +The MultiLanguageSetting parameter specifies the language of quarantine notifications. Valid values are: + +Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. + +You can specify multiple value separated by commas using the syntax: `('value1',''value2',...'valueN')`. The default value is Default, which means quarantine notifications use the default language of the cloud-based organization. + +For each language that you specify, you can specify a unique value for the MultiLanguageCustomDisclaimer and MultiLanguageSenderName parameters. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +**Note**: The value English maps to every English language code except en-US. If you have users with en-US mailboxes only, use the value Default. If you have a mix of mailboxes with en-US and other English languages codes (en-GB, en-CA, en-AU, etc.), use the value Default in one customized quarantine notification, and the value English in another customized quarantine notification. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationBrandingEnabled +The OrganizationBrandingEnabled parameter enables or disables organization branding in the end-user quarantine notification messages. Valid values are: + +- $true: Organization branding is enabled. The default Microsoft logo that's used in quarantine notifications is replaced by your custom logo. Before you do this, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your custom logo. +- $false: Organization branding is disabled. The default Microsoft logo is used in quarantine notifications. This is the default value. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineRetentionDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/exchange/Set-RMSTemplate.md new file mode 100644 index 0000000000..807ec202d5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RMSTemplate.md @@ -0,0 +1,140 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-RMSTemplate + +## SYNOPSIS +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). + +Use the Set-RMSTemplate cmdlet to modify the properties of an existing Active Directory Rights Management Services (AD RMS) template in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-RMSTemplate [-Identity] <RmsTemplateIdParameter> -Type <RmsTemplateType> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +RMS templates exist in one or more trusted publishing domains (TPDs) that have been imported from an on-premises server running Active Directory Rights Management Services (AD RMS). + +## EXAMPLES + +### Example 1 +```powershell +Set-RMSTemplate "Contoso Confidential" -Type Archived +``` + +This example changes the RMS template Contoso Confidential from Distributed to Archived. This prevents future use of Contoso Confidential for encryption, but allows access to existing content that's rights-protected by Contoso Confidential. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the RMS template. You can use any value that uniquely identifies the RMS template, for example: + +- Name +- GUID + +You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organization. + +```yaml +Type: RmsTemplateIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Type +The Type parameter specifies the type of RMS template. You can specify one of the following values: + +- Archived +- Distributed +- All + +The default type for imported RMS templates is Archived. + +```yaml +Type: RmsTemplateType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/mail-flow/Set-ReceiveConnector.md b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md similarity index 85% rename from exchange/exchange-ps/exchange/mail-flow/Set-ReceiveConnector.md rename to exchange/exchange-ps/exchange/Set-ReceiveConnector.md index 8182b8526a..0243479192 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ReceiveConnector @@ -13,46 +16,78 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ReceiveConnector cmdlet to modify Receive connectors on Mailbox servers and Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ReceiveConnector [-Identity] <ReceiveConnectorIdParameter> [-AdvertiseClientSettings <$true | $false>] - [-AuthMechanism <None | Tls | Integrated | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>] - [-Banner <String>] [-BareLinefeedRejectionEnabled <$true | $false>] [-BinaryMimeEnabled <$true | $false>] - [-Bindings <MultiValuedProperty>] [-ChunkingEnabled <$true | $false>] [-Comment <String>] [-Confirm] - [-ConnectionInactivityTimeout <EnhancedTimeSpan>] [-ConnectionTimeout <EnhancedTimeSpan>] - [-DefaultDomain <AcceptedDomainIdParameter>] [-DeliveryStatusNotificationEnabled <$true | $false>] - [-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-EightBitMimeEnabled <$true | $false>] - [-EnableAuthGSSAPI <$true | $false>] [-Enabled <$true | $false>] - [-EnhancedStatusCodesEnabled <$true | $false>] [-ExtendedProtectionPolicy <None | Allow | Require>] - [-Fqdn <Fqdn>] [-LongAddressesEnabled <$true | $false>] - [-MaxAcknowledgementDelay <EnhancedTimeSpan>] [-MaxHeaderSize <ByteQuantifiedSize>] [-MaxHopCount <Int32>] - [-MaxInboundConnection <Unlimited>] [-MaxInboundConnectionPercentagePerSource <Int32>] - [-MaxInboundConnectionPerSource <Unlimited>] [-MaxLocalHopCount <Int32>] [-MaxLogonFailures <Int32>] - [-MaxMessageSize <ByteQuantifiedSize>] [-MaxProtocolErrors <Unlimited>] [-MaxRecipientsPerMessage <Int32>] - [-MessageRateLimit <Unlimited>] [-MessageRateSource <None | IPAddress | User | All>] [-Name <String>] - [-OrarEnabled <$true | $false>] - [-PermissionGroups <None | AnonymousUsers | ExchangeUsers | ExchangeServers | ExchangeLegacyServers | Partners | Custom>] - [-PipeliningEnabled <$true | $false>] [-ProtocolLoggingLevel <None | Verbose>] - [-RemoteIPRanges <MultiValuedProperty>] [-RequireEHLODomain <$true | $false>] [-RequireTLS <$true | $false>] - [-SizeEnabled <Disabled | Enabled | EnabledWithoutValue>] [-SuppressXAnonymousTls <$true | $false>] - [-TarpitInterval <EnhancedTimeSpan>] [-TlsDomainCapabilities <MultiValuedProperty>] [-WhatIf] - [-ServiceDiscoveryFqdn <Fqdn>] [-SmtpUtf8Enabled <$true | $false>] [-TlsCertificateName <SmtpX509Identifier>] - [-TransportRole <None | Cafe | Mailbox | ClientAccess | UnifiedMessaging | HubTransport | Edge | All | Monitoring | CentralAdmin | CentralAdminDatabase | DomainController | WindowsDeploymentServer | ProvisionedServer | LanguagePacks | FrontendTransport | CafeArray | FfoWebService | OSP | ARR | ManagementFrontEnd | ManagementBackEnd | SCOM | CentralAdminFrontEnd | NAT | DHCP>] - [-AuthTarpitInterval <EnhancedTimeSpan>] [-RejectReservedSecondLevelRecipientDomains <$true | $false>] - [-RejectReservedTopLevelRecipientDomains <$true | $false>] - [-RejectSingleLabelRecipientDomains <$true | $false>] [<CommonParameters>] +Set-ReceiveConnector [-Identity] <ReceiveConnectorIdParameter> + [-AdvertiseClientSettings <Boolean>] + [-AuthMechanism <AuthMechanisms>] + [-AuthTarpitInterval <EnhancedTimeSpan>] + [-Banner <String>] + [-BareLinefeedRejectionEnabled <Boolean>] + [-BinaryMimeEnabled <Boolean>] + [-Bindings <MultiValuedProperty>] + [-ChunkingEnabled <Boolean>] + [-Comment <String>] + [-Confirm] + [-ConnectionInactivityTimeout <EnhancedTimeSpan>] + [-ConnectionTimeout <EnhancedTimeSpan>] + [-DefaultDomain <AcceptedDomainIdParameter>] + [-DeliveryStatusNotificationEnabled <Boolean>] + [-DomainController <Fqdn>] + [-DomainSecureEnabled <Boolean>] + [-EightBitMimeEnabled <Boolean>] + [-EnableAuthGSSAPI <Boolean>] + [-Enabled <Boolean>] + [-EnhancedStatusCodesEnabled <Boolean>] + [-ExtendedProtectionPolicy <ExtendedProtectionPolicySetting>] + [-Fqdn <Fqdn>] + [-LongAddressesEnabled <Boolean>] + [-MaxAcknowledgementDelay <EnhancedTimeSpan>] + [-MaxHeaderSize <ByteQuantifiedSize>] + [-MaxHopCount <Int32>] + [-MaxInboundConnection <Unlimited>] + [-MaxInboundConnectionPerSource <Unlimited>] + [-MaxInboundConnectionPercentagePerSource <Int32>] + [-MaxLocalHopCount <Int32>] + [-MaxLogonFailures <Int32>] + [-MaxMessageSize <ByteQuantifiedSize>] + [-MaxProtocolErrors <Unlimited>] + [-MaxRecipientsPerMessage <Int32>] + [-MessageRateLimit <Unlimited>] + [-MessageRateSource <MessageRateSourceFlags>] + [-Name <String>] + [-OrarEnabled <Boolean>] + [-PermissionGroups <PermissionGroups>] + [-PipeliningEnabled <Boolean>] + [-ProtocolLoggingLevel <ProtocolLoggingLevel>] + [-RejectReservedSecondLevelRecipientDomains <Boolean>] + [-RejectReservedTopLevelRecipientDomains <Boolean>] + [-RejectSingleLabelRecipientDomains <Boolean>] + [-RemoteIPRanges <MultiValuedProperty>] + [-RequireEHLODomain <Boolean>] + [-RequireTLS <Boolean>] + [-ServiceDiscoveryFqdn <Fqdn>] + [-SizeEnabled <SizeMode>] + [-SmtpUtf8Enabled <Boolean>] + [-SuppressXAnonymousTls <Boolean>] + [-TarpitInterval <EnhancedTimeSpan>] + [-TlsCertificateName <SmtpX509Identifier>] + [-TlsDomainCapabilities <MultiValuedProperty>] + [-TransportRole <ServerRole>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ReceiveConnector -Identity "Internet Receive Connector" -Banner "220 SMTP OK" -ConnectionTimeout 00:15:00 ``` @@ -68,18 +103,16 @@ Configures the Receive connector to time out connections after 15 minutes. 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 - - Distinguished name (DN) - - GUID - -- \<ServerName\>\\\<Name\> +- ServerName\\Name ```yaml Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -91,14 +124,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -110,36 +143,49 @@ Accept wildcard characters: False The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: - None - - Tls - - Integrated - - BasicAuth - - BasicAuthRequireTLS - - ExchangeServer - - ExternalAuthoritative You can specify multiple values separated by commas, but some values have dependencies and exclusions: - You can only use the value None by itself. - - The value BasicAuthRequireTLS also requires the values BasicAuth and Tls. - - The only other value that you can use with ExternalAuthoritative is Tls. - - The value Tls is required when the value of the RequireTLS parameter is $true. - - The value ExternalAuthoritative, requires you to set the value of the PermissionGroups parameter to ExchangeServers. ```yaml -Type: None | Tls | Integrated | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative +Type: AuthMechanisms 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 +``` + +### -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. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. + +When you set the value to 00:00:00, you disable the authentication tarpit interval. Setting the value to more than a few seconds can cause timeouts and mail flow issues. + +You can configure the delay for other SMTP failure responses by using the TarpitInterval parameter. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,13 +198,14 @@ The Banner parameter specifies a custom SMTP 220 banner that's displayed to remo The default value of this parameter is blank ($null), which uses the following SMTP banner: -220 \<Servername\> Microsoft ESMTP MAIL service ready at \<RegionalDay-Date-24HourTimeFormat\>\<RegionalTimeZoneOffset\> +`220 <ServerName> Microsoft ESMTP MAIL service ready at <RegionalDay-Date-24HourTimeFormat><RegionalTimeZoneOffset>` ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,16 +217,16 @@ Accept wildcard characters: False 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. 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -191,16 +238,16 @@ Accept wildcard characters: False 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. - - $false: BINARYMIME is disabled and isn't advertised in the EHLO response. The binary MIME extension is defined in RFC 3030. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -209,14 +256,13 @@ Accept wildcard characters: False ``` ### -Bindings -The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax "\<IPv4 Address\>:\<TCP Port\>","\<IPv6 Address\>:\<TCP Port\>". You can specify an IPv4 address and port, and 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. +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. The values for this parameter must satisfy one of the following uniqueness requirements: - The combination of IP address and TCP port doesn't conflict with the IP address and TCP port that's used on another Receive connector on the server. - - You use an existing combination of IP address and TCP port that's configured on another Receive connector on the server, but you restrict the remote IP addresses by using the RemoteIPRanges parameter. When you create a Receive connector, you can only use the RemoteIPRanges and Bindings parameters together with the Custom or Partner switches (or the Usage parameter with the values Custom or Partner. ```yaml @@ -224,6 +270,7 @@ 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 @@ -235,16 +282,16 @@ Accept wildcard characters: False 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. - - $false: CHUNKING is disabled and isn't advertised in the EHLO response. Chunking is defined in RFC 3030. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -260,6 +307,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -270,8 +318,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -279,6 +326,7 @@ 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 @@ -302,6 +350,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -325,6 +374,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -336,17 +386,13 @@ Accept wildcard characters: False 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 - - Distinguished name (DN) - - GUID Although you can configure any accepted domain as the default domain, you typically specify an authoritative domain. The default domain is used by: -- The external postmaster address: postmaster@\<default domain\>. - +- The external postmaster address: `postmaster@<default domain>`. - Encapsulated non-SMTP email addresses (Internet Mail Connector Encapsulated Address or IMCEA encapsulation). - - The primary address for all recipients in the default email address policy. If you configure another accepted domain as the default domain, the default email address policy isn't automatically updated. ```yaml @@ -354,6 +400,7 @@ Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -365,22 +412,23 @@ Accept wildcard characters: False 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. - - $false: DSN is disabled and isn't advertised in the EHLO response. Delivery status notifications are defined in RFC 3461. ```yaml -Type: $true | $false +Type: Boolean 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 ``` + ### -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. @@ -391,6 +439,7 @@ 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 @@ -402,26 +451,22 @@ Accept wildcard characters: False 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: - 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: - - The TLSReceiveDomainSecureList parameter on the Set-TransportConfig cmdlet. - - The AddressSpaces parameter on the Set-SendConnector cmdlet for the corresponding Send connector. - - The TLSSendDomainSecureList parameter on the Set-TransportConfig cmdlet. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -433,16 +478,16 @@ Accept wildcard characters: False 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. - - $false: 8BITMIME is disabled and isn't advertised in the EHLO response. 8-bit data transmission is defined in RFC 6152. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -454,16 +499,16 @@ Accept wildcard characters: False 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. - - $false: Kerberos is disabled. The Extended SMTP keyword AUTH NTLM is advertised in the EHLO response. Clients can only use NTLM for Integrated Windows authentication. The Generic Security Services application programming interface (GSSAPI) is an IETF standard for accessing security services. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -475,14 +520,14 @@ Accept wildcard characters: False 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. - - $false: The Receive connector is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -494,16 +539,16 @@ Accept wildcard characters: False 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. - - $false: ENHANCEDSTATUSCODES is disabled and isn't advertised in the EHLO response. Enhanced status codes are defined in RFC 2034. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -515,18 +560,17 @@ Accept wildcard characters: False 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. 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. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionPolicySetting Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -538,22 +582,20 @@ Accept wildcard characters: False 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 - - In the EHLO/HELO response of the Receive connector - - In the most recent Received header field in the incoming message when the message enters the Transport service on a Mailbox server or an Edge server - - During TLS authentication The default value is the FQDN of theExchange server that contains the Receive connector (for example edge01.contoso.com). You can specify a different FQDN (for example, mail.contoso.com). -Don't modify this value on the default Receive connector named Default \<Server Name\> on Mailbox servers. If you have multiple Mailbox servers in your organization, internal mail flow between Mailbox servers fails if you change the FQDN value on this Receive connector. +Don't modify this value on the default Receive connector named `Default <Server Name>` on Mailbox servers. If you have multiple Mailbox servers in your organization, internal mail flow between Mailbox servers fails if you change the FQDN value on this Receive connector. ```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 @@ -565,24 +607,22 @@ Accept wildcard characters: False 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. When you set this parameter to the value $true the following changes are made to the Receive connector: - The XLONGADDR Extended SMTP extension is enabled and is advertised in the EHLO response. - - The accepted line length of an SMTP session is increased to 8,000 characters. - - Valid long addresses are accepted by the MAIL FROM and RCPT TO SMTP commands. You can only configure this parameter on Receive connectors in the Transport service on Mailbox servers. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -591,7 +631,7 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxAcknowledgementDelay parameter specifies the period the transport server delays acknowledgement when receiving messages from a host that doesn't support shadow redundancy. When receiving messages from a host that doesn't support shadow redundancy, a Microsoft Exchange Server 2010 transport server delays issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times out and issues an acknowledgement anyway. The default value is 30 seconds. @@ -602,6 +642,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -615,15 +656,10 @@ The MaxHeaderSize parameter specifies the maximum size of the SMTP message heade When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. A valid value is from 1 to 2147483647 bytes. @@ -633,6 +669,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -650,6 +687,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -669,6 +707,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -686,6 +725,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -705,6 +745,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -724,6 +765,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -743,6 +785,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -756,26 +799,23 @@ The MaxMessageSize parameter specifies the maximum size of a message that's allo When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. A valid value for this parameter is from 65536 to 2147483647 bytes. -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -795,6 +835,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -812,6 +853,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -833,6 +875,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -844,18 +887,16 @@ Accept wildcard characters: False The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: - None: No message submission rate is calculated. - - IPAddress: The message submission rate is calculated for sending hosts. - - User: The message submission rate is calculated for sending users (specified with the MAIL FROM SMTP command). - - All: The message submission rate is calculated for both the sending users and sending hosts. ```yaml -Type: None | IPAddress | User | All +Type: MessageRateSourceFlags Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -871,6 +912,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -882,16 +924,16 @@ Accept wildcard characters: False 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. 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -903,30 +945,25 @@ Accept wildcard characters: False 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 - - AnonymousUsers - - ExchangeUsers - - ExchangeServers - - ExchangeLegacyServers - - Partners - - Custom The default permission groups that are assigned to a Receive connector depend on the connector usage type parameter that was used when the connector was created (Client, Internal, Internet, Partner, or Usage). When you use the value Custom, you need to configure individual permissions by using the Add-ADPermission cmdlet. -For more information about the default permissions and security principals for permission groups, see Receive connector permission groups (https://technet.microsoft.com/library/aa996395.aspx#PermissionGroups). +For more information about the default permissions and security principals for permission groups, see [Receive connector permission groups](https://learn.microsoft.com/Exchange/mail-flow/connectors/receive-connectors#receive-connector-permission-groups). ```yaml -Type: None | AnonymousUsers | ExchangeUsers | ExchangeServers | ExchangeLegacyServers | Partners | Custom +Type: PermissionGroups Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -938,16 +975,16 @@ Accept wildcard characters: False 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. - - $false: PIPELINING is disabled and isn't advertised in the EHLO response. Pipelining is defined in RFC 2920. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -959,16 +996,16 @@ Accept wildcard characters: False 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. - - Verbose: Protocol logging is enabled on the Receive connector. -For more information about protocol logging, see Protocol logging (https://technet.microsoft.com/library/aa997624.aspx). +For more information about protocol logging, see [Protocol logging](https://learn.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). ```yaml -Type: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -976,32 +1013,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoteIPRanges -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 . - -- IP address range: For example, 192.168.1.1-192.168.1.254. - -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.1.1/24 or 2001:0DB8::CD3/60. - -You can specify multiple value separated by commas ("\<value1\>","\<value2\>"...). - -Multiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another. For example, you can configure the following remote IP address ranges on different Receive connectors on the same server: - -- 0.0.0.0 - -- 192.168.1.1/24 - -- 192.168.1.10 +### -RejectReservedSecondLevelRecipientDomains +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: -When remote IP address ranges overlap, the Receive connector with the most specific match to the IP address of the connecting server is used. +- $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. ```yaml -Type: MultiValuedProperty +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1009,18 +1032,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireEHLODomain -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. +### -RejectReservedTopLevelRecipientDomains +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: -- $false: The client isn't required to provide a domain name in the EHLO handshake. This is the default value. +- $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1028,18 +1051,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireTLS -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. +### -RejectSingleLabelRecipientDomains +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: -- $false: Inbound messages on the Receive connector don't require TLS transmission. This is the default value. +- $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1047,22 +1070,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SizeEnabled -The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: +### -RemoteIPRanges +The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. 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. +- Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. +- IP address range: For example, 192.168.1.1-192.168.1.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.1.1/24 or 2001:0DB8::CD3/60. -- Disabled: SIZE is disabled and isn't advertised in the EHLO response. +You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. -- 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. +Multiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another. For example, you can configure the following remote IP address ranges on different Receive connectors on the same server: -SIZE is defined in RFC 1870. +- 0.0.0.0 +- 192.168.1.1/24 +- 192.168.1.10 + +When remote IP address ranges overlap, the Receive connector with the most specific match to the IP address of the connecting server is used. ```yaml -Type: Disabled | Enabled | EnabledWithoutValue +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 @@ -1070,20 +1100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SuppressXAnonymousTls -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. +### -RequireEHLODomain +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: -The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter contains the value ExchangeServer. +- $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1091,20 +1119,18 @@ Accept pipeline input: False 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). - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -When you set the value to 00:00:00, you disable the tarpit interval. Setting this value to more than a few seconds can cause timeouts and mail flow issues. +### -RequireTLS +The RequireTLS parameter specifies whether to require TLS transmission for inbound messages on the Receive connector. Valid values are: -You can configure the delay for authentication failure responses by using the AuthTarpitInterval parameter. +- $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. ```yaml -Type: EnhancedTimeSpan +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1112,28 +1138,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TlsDomainCapabilities -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: - -"\<domain1\>:\<capability1\>,\<capability 2\>\>"...,"\<domain2\>:\<capability1\>,\<capability2\>..."... - -The available \<capability\> values are: - -- AcceptOorgProtocol - -- AcceptOorgHeader - -The available \<domainy\> values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. - -For example, "contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptOorgProtocol,AcceptOorgHeader" +### -ServiceDiscoveryFqdn +The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN). for the Receive connector. ```yaml -Type: MultiValuedProperty +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1141,29 +1154,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -SizeEnabled +The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: -```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 -``` +- 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. +- 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. -### -ServiceDiscoveryFqdn -The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN). for the Receive connector. +SIZE is defined in RFC 1870. ```yaml -Type: Fqdn +Type: SizeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1175,10 +1180,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1186,14 +1192,20 @@ Accept pipeline input: False 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 "\<I\>X.500Issuer\<S\>X.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 \<Thumbprint\>, run the command $TLSCertName = "\<I\>$($TLSCert.Issuer)\<S\>$($TLSCert.Subject)" and then use the value $TLSCertName for this parameter. +### -SuppressXAnonymousTls +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. + +The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter contains the value ExchangeServer. ```yaml -Type: SmtpX509Identifier +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1201,20 +1213,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportRole -The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created.. Valid values are: +### -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). -- FrontendTransport: The Front End Transport service where client or external SMTP connections occur. +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. -- HubTransport: The Transport service where Exchange server and proxied client SMTP connections occur. +When you set the value to 00:00:00, you disable the tarpit interval. Setting this value to more than a few seconds can cause timeouts and mail flow issues. -You can't use this parameter on Edge Transport servers. +You can configure the delay for authentication failure responses by using the AuthTarpitInterval parameter. ```yaml -Type: None | Cafe | Mailbox | ClientAccess | UnifiedMessaging | HubTransport | Edge | All | Monitoring | CentralAdmin | CentralAdminDatabase | DomainController | WindowsDeploymentServer | ProvisionedServer | LanguagePacks | FrontendTransport | CafeArray | FfoWebService | OSP | ARR | ManagementFrontEnd | ManagementBackEnd | SCOM | CentralAdminFrontEnd | NAT | DHCP +Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1222,20 +1235,15 @@ Accept pipeline input: False 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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -When you set the value to 00:00:00, you disable the authentication tarpit interval. Setting the value to more than a few seconds can cause timeouts and mail flow issues. - -You can configure the delay for other SMTP failure responses by using the TarpitInterval parameter. +### -TlsCertificateName +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"<I>X.500Issuer<S>X.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 <Thumbprint>`, run the command `$TLSCertName = "<I>$($TLSCert.Issuer)<S>$($TLSCert.Subject)"` and then use the value $TLSCertName for this parameter. ```yaml -Type: EnhancedTimeSpan +Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1243,18 +1251,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RejectReservedSecondLevelRecipientDomains -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: +### -TlsDomainCapabilities +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. -- $true: RCPT TO commands that contain reserved second-level domains are rejected. +This parameter uses the following syntax: -- $false: RCPT TO commands that contain reserved second-level domains aren't rejected. This is the default value. +`"Domain1:Capability1,Capability2,"...,"Domain2:Capability1,Capability2,...",...` + +You can only use this parameter in Exchange hybrid deployments, and the valid Capability values are: + +- AcceptCloudServicesMail (Exchange 2013 or later) +- AcceptOorgProtocol (Exchange 2010) + +More Capability values are available, but there is no scenario to use them. For more information, see [Advanced Office 365 Routing](https://techcommunity.microsoft.com/t5/exchange-team-blog/advanced-office-365-routing-locking-down-exchange-on-premises/ba-p/609238). + +The available Domain values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. + +For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServicesMail"`. ```yaml -Type: $true | $false +Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1262,18 +1282,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RejectReservedTopLevelRecipientDomains -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: +### -TransportRole +The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created. Valid values are: -- $true: RCPT TO commands that contain reserved TLDs are rejected. +- FrontendTransport: The Front End Transport service where client or external SMTP connections occur. +- HubTransport: The Transport service where Exchange server and proxied client SMTP connections occur. -- $false: RCPT TO commands that contain reserved TLDs aren't rejected. This is the default value. +You can't use this parameter on Edge Transport servers. ```yaml -Type: $true | $false +Type: ServerRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1281,18 +1303,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RejectSingleLabelRecipientDomains -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. +### -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: $true | $false +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1301,20 +1320,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/eb7f8960-e772-4312-9d3f-47dd27d9545c.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-RecipientFilterConfig.md rename to exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md index 50e75766f5..d1543894e3 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-RecipientFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-RecipientFilterConfig @@ -13,38 +16,43 @@ This cmdlet is available only in on-premises Exchange. Use the Set-RecipientFilterConfig cmdlet to enable and configure the Recipient Filter agent. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RecipientFilterConfig [-BlockedRecipients <MultiValuedProperty>] [-BlockListEnabled <$true | $false>] - [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExternalMailEnabled <$true | $false>] - [-InternalMailEnabled <$true | $false>] [-RecipientValidationEnabled <$true | $false>] [-WhatIf] +Set-RecipientFilterConfig [-BlockedRecipients <MultiValuedProperty>] + [-BlockListEnabled <Boolean>] + [-Confirm] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-ExternalMailEnabled <Boolean>] + [-InternalMailEnabled <Boolean>] + [-RecipientValidationEnabled <Boolean>] + [-WhatIf] [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-RecipientFilterConfig -RecipientValidationEnabled $true ``` This example modifies the Recipient Filter agent configuration so that recipient validation is enabled. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-RecipientFilterConfig -BlockListEnabled $true -BlockedRecipients user1@contoso.com,user2@contoso.com ``` This example makes the following changes to the Recipient Filter agent configuration: - Enables the Blocked Recipients list. - - Adds two users to the Blocked Recipients list. ## PARAMETERS @@ -57,6 +65,7 @@ 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 @@ -68,10 +77,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -82,8 +92,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -91,6 +100,7 @@ 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 @@ -108,6 +118,7 @@ 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 @@ -119,10 +130,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -134,10 +146,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -149,10 +162,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -164,10 +178,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -183,6 +198,7 @@ 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 @@ -191,20 +207,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/678ef60d-a2ab-4c03-9854-f43727b9123a.aspx) diff --git a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md new file mode 100644 index 0000000000..b3552f8231 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-RecordReviewNotificationTemplateConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-RecordReviewNotificationTemplateConfig cmdlet to set up the customized record review notification and reminder that's sent when an item requires review. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-RecordReviewNotificationTemplateConfig -IsCustomizedNotificationTemplate <Boolean> -IsCustomizedReminderTemplate <Boolean> + [-CustomizedNotificationDataString <String>] + [-CustomizedReminderDataString <String>] + [<CommonParameters>] +``` + +## 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-RecordReviewNotificationTemplateConfig -IsCustomizedNotificationTemplate $true -CustomizedNotificationDataString "This is the Contoso notification" -IsCustomizedReminderTemplate $true -CustomizedReminderDataString "This is the Contoso reminder" +``` + +This example configures customized review notification text and review reminder text. + +## PARAMETERS + +### -IsCustomizedNotificationTemplate +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCustomizedReminderTemplate +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomizedNotificationDataString +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. + +```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 +``` + +### -CustomizedReminderDataString +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md b/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md new file mode 100644 index 0000000000..8f4caf3d77 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md @@ -0,0 +1,69 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-RegulatoryComplianceUI + +## 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-RegulatoryComplianceUI cmdlet to display the UI option in retention label settings to mark content as a regulatory record. + +For 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-RegulatoryComplianceUI -Enabled <Boolean> + [<CommonParameters>] +``` + +## 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-RegulatoryComplianceUI -Enabled $true +``` + +This example displays the UI option in retention label settings to mark content as a regulatory record. + +## PARAMETERS + +### -Enabled +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. + +```yaml +Type: Boolean +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/mail-flow/Set-RemoteDomain.md b/exchange/exchange-ps/exchange/Set-RemoteDomain.md similarity index 81% rename from exchange/exchange-ps/exchange/mail-flow/Set-RemoteDomain.md rename to exchange/exchange-ps/exchange/Set-RemoteDomain.md index 048f59c998..8f7c3965a5 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Set-RemoteDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-RemoteDomain @@ -13,63 +16,63 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RemoteDomain cmdlet to configure a managed connection for a remote domain. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RemoteDomain [-Identity] <RemoteDomainIdParameter> - [-AllowedOOFType <External | InternalLegacy | ExternalLegacy | None>] - [-AutoForwardEnabled <$true | $false>] - [-AutoReplyEnabled <$true | $false>] - [-ByteEncoderTypeFor7BitCharsets <Use7Bit | UseQP | UseBase64 | UseQPHtmlDetectTextPlain | UseBase64HtmlDetectTextPlain | UseQPHtml7BitTextPlain | UseBase64Html7BitTextPlain | Undefined>] + [-AllowedOOFType <AllowedOOFType>] + [-AutoForwardEnabled <Boolean>] + [-AutoReplyEnabled <Boolean>] + [-ByteEncoderTypeFor7BitCharsets <ByteEncoderTypeFor7BitCharsetsEnum>] [-CharacterSet <String>] [-Confirm] - [-ContentType <MimeHtmlText | MimeText | MimeHtml>] - [-DeliveryReportEnabled <$true | $false>] - [-DisplaySenderName <$true | $false>] + [-ContentType <ContentType>] + [-DeliveryReportEnabled <Boolean>] + [-DisplaySenderName <Boolean>] [-DomainController <Fqdn>] - [-IsCoexistenceDomain <$true | $false>] - [-IsInternal <$true | $false>] + [-IsCoexistenceDomain <Boolean>] + [-IsInternal <Boolean>] [-LineWrapSize <Unlimited>] - [-MeetingForwardNotificationEnabled <$true | $false>] + [-MeetingForwardNotificationEnabled <Boolean>] [-MessageCountThreshold <Int32>] [-Name <String>] - [-NDRDiagnosticInfoEnabled <$true | $false>] - [-NDREnabled <$true | $false>] + [-NDRDiagnosticInfoEnabled <Boolean>] + [-NDREnabled <Boolean>] [-NonMimeCharacterSet <String>] - [-PreferredInternetCodePageForShiftJis <Undefined | Iso2022Jp | Esc2022Jp | Sio2022Jp>] + [-PreferredInternetCodePageForShiftJis <PreferredInternetCodePageForShiftJisEnum>] [-RequiredCharsetCoverage <Int32>] - [-TargetDeliveryDomain <$true | $false>] - [-TNEFEnabled <$true | $false>] - [-TrustedMailInboundEnabled <$true | $false>] - [-TrustedMailOutboundEnabled <$true | $false>] - [-UseSimpleDisplayName <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-SmtpDaneMandatoryModeEnabled <Boolean>] + [-TargetDeliveryDomain <Boolean>] + [-TNEFEnabled <Boolean>] + [-TrustedMailInboundEnabled <Boolean>] + [-TrustedMailOutboundEnabled <Boolean>] + [-UseSimpleDisplayName <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-RemoteDomain Contoso -AllowedOOFType None -DeliveryReportEnabled $false -TNEFEnabled $true ``` This example performs the following actions: - It disables out-of-office notifications to the remote domain. - -- It suppresses read receipts sent from clients in your organization to the remote domain. - +- It suppresses delivery receipts sent from clients in your organization to the remote domain. - It enables TNEF message data on messages sent to the remote domain. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-RemoteDomain | Where {$_.AutoReplyEnabled -eq $false} | Set-RemoteDomain -AutoForwardEnabled $false -NDREnabled $false ``` @@ -81,9 +84,7 @@ This example queries Active Directory for all remote domains for which auto repl 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 - - Distinguished name (DN) - - GUID ```yaml @@ -91,6 +92,7 @@ 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 Default value: None @@ -102,18 +104,21 @@ Accept wildcard characters: False 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. - - 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. -- InternalLegacy: Only internal automatic replies or automatic replies that aren't designated as internal or external are sent to recipients in the remote domain. +The value of this parameter is affected by the value of the IsInternal parameter, and vice-versa: -- None: No automatic replies are sent to recipients in the remote domain. +- If you change the AllowedOOFType parameter to the value InternalLegacy, the IsInternal parameter is changed to the value $true. +- If you change the IsInternal parameter to the value $false, the AllowedOOFType parameter is changed to the value ExternalLegacy. ```yaml -Type: External | InternalLegacy | ExternalLegacy | None +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 Default value: None @@ -125,14 +130,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -144,14 +149,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -163,26 +168,20 @@ Accept wildcard characters: False 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. - - UseQP: Always use QP (quoted-printable) encoding for HTML and for plain text. - - UseBase64: Always use Base64 encoding for HTML and for plain text. - - UseQPHtmlDetectTextPlain: Use QP encoding for HTML and for plain text unless line wrapping is enabled in plain text. If line wrapping is enabled, use 7-bit encoding for plain text. - - 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. ```yaml -Type: Use7Bit | UseQP | UseBase64 | UseQPHtmlDetectTextPlain | UseBase64HtmlDetectTextPlain | UseQPHtml7BitTextPlain | UseBase64Html7BitTextPlain | Undefined +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 Default value: None @@ -204,6 +203,7 @@ 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 Default value: None @@ -214,8 +214,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -223,6 +222,7 @@ 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 Default value: None @@ -234,16 +234,15 @@ Accept wildcard characters: False 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. - - MimeText: Converts all messages to MIME messages that use text formatting. - - MimeHtml: Converts all messages to MIME messages that use HTML formatting. ```yaml -Type: MimeHtmlText | MimeText | MimeHtml +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 Default value: None @@ -255,14 +254,14 @@ Accept wildcard characters: False 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. - - $false: Delivery reports aren't delivered to recipients in the remote domain. ```yaml -Type: $true | $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 Default value: None @@ -271,19 +270,19 @@ Accept wildcard characters: False ``` ### -DisplaySenderName -Note: You should only modify this parameter under the direction of Microsoft Customer Service and Support. +**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 reicpients in the remote domain. This is the default value. - -- $false. Sender names aren't displayed in messages sent to reicpients in the remote domain. +- $true: Sender names are displayed in messages sent to recipients in the remote domain. This is the default value. +- $false. Sender names aren't displayed in messages sent to recipients in the remote domain. ```yaml -Type: $true | $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 Default value: None @@ -303,6 +302,7 @@ 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 @@ -311,19 +311,19 @@ Accept wildcard characters: False ``` ### -IsCoexistenceDomain -This parameter is available or functional only in 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -334,15 +334,20 @@ Accept wildcard characters: False ### -IsInternal The IsInternal parameter specifies whether the recipients in the remote domain are considered to be internal recipients. Valid values are: -- $true: All transport components (for example, transport rules or antispam agents) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. +- $true: All transport components (for example, transport rules) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. +- $false: Recipients in the remote domain are treated as external recipients. This is the default value. + +The value of this parameter is affected by the value of the AllowedOOFType parameter, and vice-versa: -- $false: Recipients in the remote domain are treated as external recipients. This is the default value. +- If you change the AllowedOOFType parameter to the value InternalLegacy, the IsInternal parameter is changed to the value $true. +- If you change the IsInternal parameter to the value $false, the AllowedOOFType parameter is changed to the value ExternalLegacy. ```yaml -Type: $true | $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 Default value: None @@ -358,6 +363,7 @@ 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 Default value: None @@ -369,14 +375,14 @@ Accept wildcard characters: False 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. - - $false: Meeting requests forwarded to recipients in the remote domain don't generate a meeting forward notification to the meeting organizer. ```yaml -Type: $true | $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 Default value: None @@ -396,6 +402,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -404,13 +411,14 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quoatation marks ("). +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 Default value: None @@ -419,21 +427,21 @@ Accept wildcard characters: False ``` ### -NDRDiagnosticInfoEnabled -This parameter is available only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The NDRDiagnosticInfoEnabled parameter specifies whether diagnostic information is included in non-delivery reports (also known NDRs or bounce messages) that are sent to recipients the remote domain. Valid values are: - $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. - - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -442,19 +450,17 @@ Accept wildcard characters: False ``` ### -NDREnabled -This parameter is available only in on-premises Exchange. - The NDREnabled parameter specifies whether to allow non-delivery reports (also known NDRs or bounce messages) from your organization to recipients in the remote domain. Valid values are: - $true: NDRs from your organization are sent to recipients in the remote domain. This is the default value. - - $false: NDRs from your organization aren't sent to recipients in the remote domain. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -476,6 +482,7 @@ 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 Default value: None @@ -487,18 +494,16 @@ Accept wildcard characters: False 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. ```yaml -Type: Undefined | Iso2022Jp | Esc2022Jp | Sio2022Jp +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 Default value: None @@ -509,7 +514,7 @@ Accept wildcard characters: False ### -RequiredCharsetCoverage 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 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. 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. @@ -518,6 +523,25 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpDaneMandatoryModeEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -529,14 +553,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $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 Default value: None @@ -545,19 +569,18 @@ Accept wildcard characters: False ``` ### -TNEFEnabled -The TNEFEnabled parameter specifies whether Transport Neutral Encapsulation Format (TNEF) message encoding is used on messages sent to the remote domain. Valid values are-: +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 ```yaml -Type: $true | $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 Default value: None @@ -568,15 +591,15 @@ Accept wildcard characters: False ### -TrustedMailInboundEnabled 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 romte domain are considered safe and will bypass content filtering and recipient filtering. - +- $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. ```yaml -Type: $true | $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 Default value: None @@ -585,17 +608,17 @@ Accept wildcard characters: False ``` ### -TrustedMailOutboundEnabled -The TrustedMailInboundEnabled 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 romte domain are considered safe and will bypass content filtering and recipient filtering. We recommend that you use this value in cross-forest deployments. +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. ```yaml -Type: $true | $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 Default value: None @@ -606,15 +629,31 @@ Accept wildcard characters: False ### -UseSimpleDisplayName 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 \<EmailAddress\>". - +- $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 <EmailAddress>`. - $false: Simple display names aren't used in messages sent to recipients in the remote domain. This is the default value. ```yaml -Type: $true | $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -623,20 +662,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/4738bf25-39b8-4433-bd64-1d60252c2832.aspx) diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md new file mode 100644 index 0000000000..6850e91830 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md @@ -0,0 +1,1435 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-RemoteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-RemoteMailbox cmdlet to modify remote mailboxes. A remote mailbox is a mail user in Active Directory that's associated with a mailbox in the cloud-based service. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-RemoteMailbox [-Identity] <RemoteMailboxIdParameter> + [-AcceptMessagesOnlyFrom <MultiValuedProperty>] + [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] + [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] + [-ACLableSyncedObjectEnabled] + [-Alias <String>] + [-ArchiveGuid <Guid>] + [-ArchiveName <MultiValuedProperty>] + [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] + [-Confirm] + [-CustomAttribute1 <String>] + [-CustomAttribute10 <String>] + [-CustomAttribute11 <String>] + [-CustomAttribute12 <String>] + [-CustomAttribute13 <String>] + [-CustomAttribute14 <String>] + [-CustomAttribute15 <String>] + [-CustomAttribute2 <String>] + [-CustomAttribute3 <String>] + [-CustomAttribute4 <String>] + [-CustomAttribute5 <String>] + [-CustomAttribute6 <String>] + [-CustomAttribute7 <String>] + [-CustomAttribute8 <String>] + [-CustomAttribute9 <String>] + [-DisplayName <String>] + [-DomainController <Fqdn>] + [-EmailAddresses <ProxyAddressCollection>] + [-EmailAddressPolicyEnabled <Boolean>] + [-ExchangeGuid <Guid>] + [-ExtensionCustomAttribute1 <MultiValuedProperty>] + [-ExtensionCustomAttribute2 <MultiValuedProperty>] + [-ExtensionCustomAttribute3 <MultiValuedProperty>] + [-ExtensionCustomAttribute4 <MultiValuedProperty>] + [-ExtensionCustomAttribute5 <MultiValuedProperty>] + [-GrantSendOnBehalfTo <MultiValuedProperty>] + [-HiddenFromAddressListsEnabled <Boolean>] + [-IgnoreDefaultScope] + [-ImmutableId <String>] + [-MailTip <String>] + [-MailTipTranslations <MultiValuedProperty>] + [-ModeratedBy <MultiValuedProperty>] + [-ModerationEnabled <Boolean>] + [-Name <String>] + [-PrimarySmtpAddress <SmtpAddress>] + [-RecoverableItemsQuota <Unlimited>] + [-RecoverableItemsWarningQuota <Unlimited>] + [-RejectMessagesFrom <MultiValuedProperty>] + [-RejectMessagesFromDLMembers <MultiValuedProperty>] + [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] + [-RemoteRoutingAddress <ProxyAddress>] + [-RemovePicture] + [-RemoveSpokenName] + [-RequireSenderAuthenticationEnabled <Boolean>] + [-ResetPasswordOnNextLogon <Boolean>] + [-SamAccountName <String>] + [-SendModerationNotifications <TransportModerationNotificationFlags>] + [-Type <ConvertibleRemoteMailboxSubType>] + [-UserPrincipalName <String>] + [-WhatIf] + [-WindowsEmailAddress <SmtpAddress>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Set-RemoteMailbox cmdlet configures Exchange attributes for an on-premises mail user. The configuration set on the on-premises mail user is synchronized to its associated mailbox in the service. + +Some attributes on mailboxes in the service can only be configured by connecting to the service and using the Set-Mailbox cmdlet. + +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). + +## EXAMPLES + +### Example 1 +```powershell +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. + +### 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. + +## PARAMETERS + +### -Identity +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 +- GUID +- Distinguished name (DN) +- Domain\\Username +- User principal name (UPN) +- Legacy DN +- Email address +- User alias + +```yaml +Type: RemoteMailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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: False +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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: False +Accept wildcard characters: False +``` + +### -ACLableSyncedObjectEnabled +The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. + +- To enable this feature, use this switch without a value. +- To disable this feature, use this exact syntax: `-ACLableSyncedObjectEnabled:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. + +If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: + +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. +- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). + +If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). + +The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. + +```yaml +Type: String +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 +``` + +### -ArchiveGuid +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveName +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +The following default values are used based on the version of Exchange: + +- Exchange 2016 or later: `In-Place Archive -<Display Name>` +- Exchange 2013: `In-Place Archive - <Display Name>` +- Exchange 2010: `Personal Archive - <Display Name>` + +In Outlook, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - <PrimarySMTPAddress>`. + +```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: False +Accept wildcard characters: False +``` + +### -BypassModerationFromSendersOrMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. + +```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: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 +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 +``` + +### -EmailAddresses +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: + +- SMTP: The primary SMTP address. You can use this value only once in a command. +- smtp: Other SMTP email addresses. +- X400: X.400 addresses in on-premises Exchange. +- X500: X.500 addresses in on-premises Exchange. + +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +Type: ProxyAddressCollection +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 +``` + +### -EmailAddressPolicyEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeGuid +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. + +```yaml +Type: Guid +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 +``` + +### -ExtensionCustomAttribute1 +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. + +```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: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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. + +```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: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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. + +```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: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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. + +```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: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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. + +```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: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: + +- $true: The recipient isn't visible in address lists. +- $false: The recipient is visible in address lists. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ImmutableId +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. + +```yaml +Type: String +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 +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `<html><body>This mailbox is not monitored</body></html>`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:<MailTip text>`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```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: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $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: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```yaml +Type: Boolean +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 +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail user are no longer automatically updated by email address policies. + +The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. + +```yaml +Type: SmtpAddress +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 +``` + +### -RecoverableItemsQuota +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). + +When you enter a number, you can qualify it with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoverableItemsWarningQuota +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). + +When you enter a number, you can qualify it with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFrom +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. + +The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromDLMembers +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. + +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. + +The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. + +```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: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```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: False +Accept wildcard characters: False +``` + +### -RemoteRoutingAddress +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. + +```yaml +Type: ProxyAddress +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 +``` + +### -RemovePicture +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSpokenName +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetPasswordOnNextLogon +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. + +```yaml +Type: Boolean +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 +``` + +### -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. + +```yaml +Type: String +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 +``` + +### -SendModerationNotifications +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. +- Internal: Notify senders in the organization when their messages aren't approved. +- Never: Don't notify anyone when a message isn't approved. + +This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). + +The default value is Never. + +```yaml +Type: TransportModerationNotificationFlags +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 +``` + +### -Type +The Type parameter specifies the type for the mailbox in the service. Valid values are: + +- Regular +- Room +- Equipment +- Shared + +Notes on the value Shared: + +- Shared is available only in Exchange 2013 CU21 or later, Exchange 2016 CU10 or later, and Exchange 2019. In Exchange 2013 and Exchange 2016, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). +- In hybrid environments, changing the mailbox type of a migrated mailbox needs to be done on both sides: Set-Mailbox in Exchange Online and Set-RemoteMailbox in on-premises Exchange. +- If directory synchronization unexpectedly converts shared mailboxes in Exchange Online back into user mailboxes, or if you continue to receive the `remoteMailbox.RemoteRecipientType must include ProvisionMailbox` error when you use the value Shared, take the action described in Step 3 in the Resolution section in [KB2710029](https://support.microsoft.com/help/2710029). + +```yaml +Type: ConvertibleRemoteMailboxSubType +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 +``` + +### -UserPrincipalName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..9e9b525a46 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md @@ -0,0 +1,1107 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionpolicy +applicable: Exchange Online +title: Set-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ReportSubmissionPolicy cmdlet to modify the report submission policy in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ReportSubmissionPolicy [-Identity] <ReportSubmissionPolicyIdParameter> + [-Confirm] + [-DisableQuarantineReportingOption <Boolean>] + [-DisableUserSubmissionOptions <Boolean>] + [-EnableCustomizedMsg <Boolean>] + [-EnableCustomNotificationSender <Boolean>] + [-EnableOrganizationBranding <Boolean>] + [-EnableReportToMicrosoft <Boolean>] + [-EnableThirdPartyAddress <Boolean>] + [-EnableUserEmailNotification <Boolean>] + [-JunkReviewResultMessage <String>] + [-NotJunkReviewResultMessage <String>] + [-NotificationFooterMessage <String>] + [-NotificationSenderAddress <MultiValuedProperty>] + [-NotificationsForCleanSubmissionAirInvestigationsEnabled <Boolean>] + [-NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled <Boolean>] + [-NotificationsForSpamSubmissionAirInvestigationsEnabled <Boolean>] + [-NotificationsForSubmissionAirInvestigationsEnabled <Boolean>] + [-OnlyShowPhishingDisclaimer <Boolean>] + [-PhishingReviewResultMessage <String>] + [-PostSubmitMessage <String>] + [-PostSubmitMessageEnabled <Boolean>] + [-PostSubmitMessageForJunk <String>] + [-PostSubmitMessageForNotJunk <String>] + [-PostSubmitMessageForPhishing <String>] + [-PostSubmitMessageTitle <String>] + [-PostSubmitMessageTitleForJunk <String>] + [-PostSubmitMessageTitleForNotJunk <String>] + [-PostSubmitMessageTitleForPhishing <String>] + [-PreSubmitMessage <String>] + [-PreSubmitMessageEnabled <Boolean>] + [-PreSubmitMessageForJunk <String>] + [-PreSubmitMessageForNotJunk <String>] + [-PreSubmitMessageForPhishing <String>] + [-PreSubmitMessageTitle <String>] + [-PreSubmitMessageTitleForJunk <String>] + [-PreSubmitMessageTitleForNotJunk <String>] + [-PreSubmitMessageTitleForPhishing <String>] + [-ReportChatMessageEnabled <Boolean>] + [-ReportChatMessageToCustomizedAddressEnabled <Boolean>] + [-ReportJunkAddresses <MultiValuedProperty>] + [-ReportJunkToCustomizedAddress <Boolean>] + [-ReportNotJunkAddresses <MultiValuedProperty>] + [-ReportNotJunkToCustomizedAddress <Boolean>] + [-ReportPhishAddresses <MultiValuedProperty>] + [-ReportPhishToCustomizedAddress <Boolean>] + [-ThirdPartyReportAddresses <MultiValuedProperty>] + [-UserSubmissionOptions <Int32>] + [-UserSubmissionOptionsMessage <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The report submission policy controls most of the settings for user submissions in the Microsoft Defender portal at <https://security.microsoft.com/securitysettings/userSubmission>. + +The report submission rule (the SentTo parameter \*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are sent. + +When you set the email address of the reporting mailbox in the Microsoft Defender portal, the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: The ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses parameters. +- Microsoft integrated reporting using third-party tools in Outlook: The ThirdPartyReportAddresses parameter. + +Although it's not absolutely required, it makes sense to keep the email address consistent in the related parameters in the \*-ReportSubmissionPolicy and \*-ReportSubmissionRule cmdlets. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $true -EnableThirdPartyAddress $false -ThirdPartyReportAddresses $null -ReportJunkToCustomizedAddress $false -ReportJunkAddresses $null -ReportNotJunkToCustomizedAddress $false -ReportNotJunkAddresses $null -ReportPhishToCustomizedAddress $false -ReportPhishAddresses $null + +Get-ReportSubmissionRule | Remove-ReportSubmissionRule +``` + +This example turns on reporting in Outlook, uses Microsoft reporting tools in Outlook, but allows users to report messages to Microsoft only. The reporting mailbox is not used. + +**Notes**: + +- You can use this example (and the other examples) without concern for the existing values of the specified parameters. Depending on your current configuration, some of the parameters might already be set to the required values and therefore might not be required. +- If the report submission rule doesn't already exist (the Get-ReportSubmissionRule command returns no output), you don't need to run the second command to remove it. + +### Example 2 +```powershell +$usersub = "reportedmessages@contoso.com" + +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $true -EnableThirdPartyAddress $false -ThirdPartyReportAddresses $null -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example turns on reporting in Outlook, uses Microsoft reporting tools in Outlook, allows users to report messages to Microsoft, and sends reported messages to the specified reporting mailbox. + +The required third command is different based on whether you already have a report submission rule: + +- If you don't already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns nothing), run the New-ReportSubmissionRule command as described. +- If you already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns output), run the following command instead: `Set-ReportSubmissionRule -Name DefaultReportSubmissionRule -SentTo $usersub`. + +### Example 3 +```powershell +$usersub = "userreportedmessages@fabrikam.com" + +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $false -ThirdPartyReportAddresses $null -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example turns on reporting in Outlook, uses Microsoft reporting tools in Outlook, and sends reported messages to the specified reporting mailbox only (users can't report messages to Microsoft). + +The required third command is different based on whether you already have a report submission rule: + +- If you don't already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns nothing), run the New-ReportSubmissionRule command as described. +- If you already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns output), run the following command instead: `Set-ReportSubmissionRule -Name DefaultReportSubmissionRule -SentTo $usersub`. + +### Example 4 +```powershell +$usersub = "thirdpartyreporting@wingtiptoys.com" + +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ThirdPartyReportAddresses $usersub -ReportJunkToCustomizedAddress $false -ReportJunkAddresses $null -ReportNotJunkToCustomizedAddress $false -ReportNotJunkAddresses $null -ReportPhishToCustomizedAddress $false -ReportPhishAddresses $null + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example turns on reporting in Outlook, but uses third-party reporting tools in Outlook to send reported messages to the specified reporting mailbox in Exchange Online. + +The required third command is different based on whether you already have a report submission rule: + +- If you don't already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns nothing), run the New-ReportSubmissionRule command as described. +- If you already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns output), run the following command instead: `Set-ReportSubmissionRule -Name DefaultReportSubmissionRule -SentTo $usersub`. + +### Example 5 +```powershell +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ThirdPartyReportAddresses $usersub -ReportJunkToCustomizedAddress $false -ReportJunkAddresses $null -ReportNotJunkToCustomizedAddress $false -ReportNotJunkAddresses $null -ReportPhishToCustomizedAddress $false -ReportPhishAddresses $null + +Get-ReportSubmissionRule | Remove-ReportSubmissionRule +``` + +This example turns off the Microsoft integrated reporting. Microsoft reporting tools in Outlook are not available to users and messages reported by third-party tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. + +If the report submission rule doesn't already exist (the Get-ReportSubmissionRule command returns no output), you don't need to run the second command to remove it. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission policy that you want to modify. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableQuarantineReportingOption +The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: + +- $true: Users can't report quarantined messages from quarantine. +- $false: Users can report quarantined messages from quarantine. This is the default value. + +This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableUserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomizedMsg +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomNotificationSender +The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use a custom Microsoft 365 sender email address. +- $false: Use the default sender email address. This is the default value. + +You specify the sender email address using the NotificationSenderAddress parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use the company logo in the footer text instead of the Microsoft logo. +- $false: Don't use the company logo in the footer text. Use the Microsoft logo. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableReportToMicrosoft +The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. + +The value $true for this parameter enables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft only (the reporting mailbox isn't used)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft and reporting mailbox (reported messages are sent to the specified mailbox)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. This is the default configuration. +- **Using a third party add-in in Outlook for users to report to Microsoft and reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. The EnableThirdPartyAddress parameter value is $true. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. + +The value $false for this parameter disables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook, but reported messages are sent only to the reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. +- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with third-party reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableThirdPartyAddress +The EnableThirdPartyAddress parameter specifies whether you're using third-party reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are $true or $false. + +The value $true enables Microsoft to capture information about email sent to the third-party reporting mailbox. The following configurations are possible: + +- **Reported messages are sent only to the reporting mailbox**: Microsoft pulls metadata from messages sent to the Exchange Online reporting mailbox by third-party tools. Microsoft uses the metadata to populate the submissions page in the Microsoft Defender Portal and fire alerts. You also need to set the EnableReportToMicrosoft parameter value to $false. Use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. +- **Reported messages are sent to both Microsoft and reporting mailbox**: Microsoft pulls the metadata and message content from messages sent to the Exchange Online reporting mailbox by third-party tools. Microsoft uses the metadata to populate the submissions page in the Microsoft Defender Portal and fire alerts. The email is used to generate result for the submissions. You also need to set the EnableReportToMicrosoft parameter value to $true. Use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. + +The value $false means third-party reporting tools in Outlook aren't used. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUserEmailNotification +The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Customized admin review result messages are sent. This value is required when user reported messages go only to the reporting mailbox (the value of the EnableReportToMicrosoft parameter is $false). +- $false: Customized admin review result messages are not sent. + +Use the JunkReviewResultMessage, NotJunkReviewResultMessage, PhishingReviewResultMessage parameters to configure the message body text that's used for each verdict. + +Use the NotificationFooterMessage parameter for the footer that's used for all verdicts (junk, not junk, and phishing). + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JunkReviewResultMessage +The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotJunkReviewResultMessage +The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationFooterMessage +The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. + +You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSenderAddress +The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForCleanSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSpamSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyShowPhishingDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishingReviewResultMessage +The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessage +The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. + +This parameter is meaningful only when the value of the PostSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageEnabled +The PostSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see after they report messages using Microsoft reporting tools. Valid values are: + +- $true: Users receive pop-up notifications in Outlook after they report messages. This is the default value. +- $false: Users don't receive pop-up notifications in Outlook after they report messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForNotJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForPhishing +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitle +The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message text using the PostSubmitMessage parameter. + +This parameter is meaningful only when the value of the PostSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForPhishing +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessage +The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. + +This parameter is meaningful only when the value of the PreSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageEnabled +The PreSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see before they report messages using Microsoft reporting tools. Valid values are: + +- $true: Users receive pop-up notifications in Outlook before they report messages. This is the default value. +- $false: Users don't receive pop-up notifications in Outlook before they report messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForNotJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForPhishing +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitle +The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the pop-up message text using the PreSubmitMessage parameter. + +This parameter is meaningful only when the value of the PreSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForPhishing +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageToCustomizedAddressEnabled +{{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +If you change the ReportJunkToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkToCustomizedAddress +The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters in the same command. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +If you change the ReportNotJunkToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkToCustomizedAddress +The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +If you change the ReportPhishToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishToCustomizedAddress +The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyReportAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox when you're using a third-party product for user submissions instead of reporting in Outlook. + +If you change the EnableThirdPartyAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +For more information about using third-party reporting tools with or without reporting in Outlook in favor of a third-party product, see the EnableThirdPartyAddress parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptionsMessage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md new file mode 100644 index 0000000000..88878ff4a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionrule +applicable: Exchange Online +title: Set-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ReportSubmissionRule cmdlet to modify the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ReportSubmissionRule [-Identity] <RuleIdParameter> + [-Comments <String>] + [-Confirm] + [-Name <String>] + [-ReportSubmissionPolicy <ReportSubmissionPolicyIdParameter>] + [-SentTo <RecipientIdParameter[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The SentTo parameter identifies the email address of the reporting mailbox. + +If you set the email address of the reporting mailbox in the Microsoft Defender portal at <https://security.microsoft.com/securitysettings/userSubmission>, the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *\-ReportSubmissionPolicy cmdlets are not updated. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ReportSubmissionRule -Identity DefaultReportSubmissionRule -SentTo "userreportedmessages@contoso.onmicrosoft.com" +``` + +This example changes the reporting mailbox to userreportedmessages@contoso.onmicrosoft.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to modify. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSubmissionPolicy +The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. + +The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): + +- Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook: `-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true`. +- Microsoft integrated reporting is enabled using third-party reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. + +If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *\-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the \*-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ResourceConfig.md b/exchange/exchange-ps/exchange/Set-ResourceConfig.md new file mode 100644 index 0000000000..19453e4a45 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ResourceConfig.md @@ -0,0 +1,142 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-ResourceConfig cmdlet to create custom resource properties that you can add to room and equipment mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ResourceConfig [-Confirm] + [-DomainController <Fqdn>] + [-ResourcePropertySchema <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van +``` + +This example adds the custom resource properties Room/Whiteboard and Equipment/Van. These values replace any existing custom resource properties that are already configured. + +### Example 2 +```powershell +Set-ResourceConfig -ResourcePropertySchema @{Add="Room/TV"; Remove="Equipment/Laptop"} +``` + +This example adds the custom resource property Room/TV and removes Equipment/Laptop without affecting other custom resource properties that are already configured. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourcePropertySchema +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/<Text>` or `Equipment/<Text>` where the `<Text>` 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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Set-ResubmitRequest.md b/exchange/exchange-ps/exchange/Set-ResubmitRequest.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Set-ResubmitRequest.md rename to exchange/exchange-ps/exchange/Set-ResubmitRequest.md index 40b4c0fd1a..222f007a7c 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Set-ResubmitRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ResubmitRequest @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ResubmitRequest cmdlet to enable or disable requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ResubmitRequest [-Identity] <ResubmitRequestIdentityParameter> -Enabled <$true | $false> [-Confirm] - [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] +Set-ResubmitRequest [-Identity] <ResubmitRequestIdentityParameter> -Enabled <Boolean> + [-Confirm] + [-Server <ServerIdParameter>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ResubmitRequest 8 -Enabled $false ``` @@ -36,41 +42,42 @@ This example disables the resubmit request with the identity 8. ## PARAMETERS -### -Enabled -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. +### -Identity +The Identity parameter specifies the resubmit request you want to modify. Each resubmit request is identified by an incremented integer value. ```yaml -Type: $true | $false +Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the resubmit request you want to modify. Each resubmit request is identified by an incremented integer value. +### -Enabled +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: ResubmitRequestIdentityParameter +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -78,6 +85,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -89,11 +97,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -103,6 +108,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -118,6 +124,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -126,20 +133,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/cbe44cb2-bde2-49d5-823c-9aa52360393e.aspx) diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md new file mode 100644 index 0000000000..c309e308bb --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -0,0 +1,1221 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-RetentionCompliancePolicy + +## 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-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). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> + [-AddExchangeLocation <MultiValuedProperty>] + [-AddExchangeLocationException <MultiValuedProperty>] + [-AddModernGroupLocation <MultiValuedProperty>] + [-AddModernGroupLocationException <MultiValuedProperty>] + [-AddOneDriveLocation <MultiValuedProperty>] + [-AddOneDriveLocationException <MultiValuedProperty>] + [-AddPublicFolderLocation <MultiValuedProperty>] + [-AddSharePointLocation <MultiValuedProperty>] + [-AddSharePointLocationException <MultiValuedProperty>] + [-AddSkypeLocation <MultiValuedProperty>] + [-AddSkypeLocationException <MultiValuedProperty>] + [-Applications <MultiValuedProperty>] + [-Comment <String>] + [-Confirm] + [-DeletedResources <String>] + [-Enabled <Boolean>] + [-EnforceSimulationPolicy <Boolean>] + [-Force] + [-PolicyTemplateInfo <PswsHashtable>] + [-PolicyRBACScopes <MultiValuedProperty>] + [-PriorityCleanup] + [-RemoveExchangeLocation <MultiValuedProperty>] + [-RemoveExchangeLocationException <MultiValuedProperty>] + [-RemoveModernGroupLocation <MultiValuedProperty>] + [-RemoveModernGroupLocationException <MultiValuedProperty>] + [-RemoveOneDriveLocation <MultiValuedProperty>] + [-RemoveOneDriveLocationException <MultiValuedProperty>] + [-RemovePublicFolderLocation <MultiValuedProperty>] + [-RemoveSharePointLocation <MultiValuedProperty>] + [-RemoveSharePointLocationException <MultiValuedProperty>] + [-RemoveSkypeLocation <MultiValuedProperty>] + [-RemoveSkypeLocationException <MultiValuedProperty>] + [-RestrictiveRetention <Boolean>] + [-StartSimulation <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +### AdaptiveScopeLocation +``` +Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-AddAdaptiveScopeLocation <MultiValuedProperty>] + [-Applications <MultiValuedProperty>] + [-Comment <String>] + [-Confirm] + [-DeletedResources <String>] + [-Enabled <Boolean>] + [-EnforceSimulationPolicy <Boolean>] + [-Force] + [-PriorityCleanup] + [-RemoveAdaptiveScopeLocation <MultiValuedProperty>] + [-StartSimulation <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +### RetryDistribution +``` +Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] + [-Confirm] + [-DeletedResources <String>] + [-EnforceSimulationPolicy <Boolean>] + [-PriorityCleanup] + [-StartSimulation <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +### TeamLocation +``` +Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> + [-AddTeamsChannelLocation <MultiValuedProperty>] + [-AddTeamsChannelLocationException <MultiValuedProperty>] + [-AddTeamsChatLocation <MultiValuedProperty>] + [-AddTeamsChatLocationException <MultiValuedProperty>] + [-Comment <String>] + [-Confirm] + [-DeletedResources <String>] + [-Enabled <Boolean>] + [-EnforceSimulationPolicy <Boolean>] + [-Force] + [-PriorityCleanup] + [-RemoveTeamsChannelLocation <MultiValuedProperty>] + [-RemoveTeamsChannelLocationException <MultiValuedProperty>] + [-RemoveTeamsChatLocation <MultiValuedProperty>] + [-RemoveTeamsChatLocationException <MultiValuedProperty>] + [-StartSimulation <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}`. + +## EXAMPLES + +### Example 1 +```powershell +Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14" +``` + +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 site `https://contoso.sharepoint.com/sites/teams/finance`. +- Removes public folders. +- Updates the comment. + +### Example 2 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'USSales@contoso.onmicrosoft.com', + 'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +The example removes the specified deleted Microsoft 365 Group and site from the specified policy. You identify the deleted resources using the Microsoft 365 Group email address and the related site ID. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 3 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'USSales@contoso.onmicrosoft.com', + 'SiteId': '8b2a8345-b9ec-3b6a-bf31-6eaa83697c4b' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLocationException "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +The example excludes the specified deleted Microsoft 365 Group and site from the specified tenant level policy. You identify the deleted resources using the Microsoft 365 Group email address and the related site ID. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 4 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'USSales2@contoso.onmicrosoft.com', + 'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b' + }, +{ + 'EmailAddress': 'USSales2@contoso.onmicrosoft.com', + 'SiteId': '4afb7116-b9ec-4b2c-bf31-4abb83697c4b' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales2@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example is similar to Example 2, except multiple deleted resources are specified. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 5 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser@contoso.onmicrosoft.com' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example excludes the specified soft-deleted mailbox or mail user from the mentioned Teams Retention Policy. You can identify the deleted resources using the mailbox or mail user's email address. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 6 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com' +}, +{ + 'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example is similar to Example 5, except multiple deleted resources are specified. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +Policy exclusions must remain within the supported limits for retention policies: [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy) + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RetryDistribution +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistribution +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddAdaptiveScopeLocation +The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocationException +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 +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocation +The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocationException +The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOneDriveLocationException +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocation +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 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSharePointLocationException +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSkypeLocation +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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSkypeLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddTeamsChannelLocation +The AddTeamsChannelLocation parameter specifies the Teams to add to the policy. + +You can use any value that uniquely identifies the team. For example: + +- Name +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddTeamsChannelLocationException +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 +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddTeamsChatLocation +The AddTeamsChatLocation parameter specifies the Teams users to add to the policy. + +You can use any value that uniquely identifies the user. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddTeamsChatLocationException +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 +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Applications +The Applications parameter specifies the 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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedResources +The DeletedResources parameter specifies the deleted Microsoft 365 Group, mailbox, or mail user to be removed or added as an exclusion to the respective location list. Use this parameter with the AddModernGroupLocationException and RemoveModernGroupLocation parameters for deleted Microsoft 365 Groups, or with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users. + +A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. + +**CAUTION**: When you use a SMTP address with this parameter, be aware that the same address might also be in use for other mailboxes or mail users. To check for additional mailboxes or mail users with the same SMTP address, use the following command and replace `user@contoso.com` with the SMTP address to check: `Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted` + +To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on [Litigation Hold](https://learn.microsoft.com/purview/ediscovery-create-a-litigation-hold) before you run the command with the DeletedResources parameter. + +For more information about the deleted Microsoft 365 Group scenario, see [Learn more about modern group deletion under retention hold](https://learn.microsoft.com/purview/retention-settings#what-happens-if-a-microsoft-365-group-is-deleted-after-a-policy-is-applied). + +For more information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceSimulationPolicy +The EnforceSimulationPolicy parameter specifies whether to enforce a simulation policy as an active policy. Valid values are: + +- $true: Enforce the simulation policy as an active policy. +- $false: Don't enforce the simulation policy as an active policy. This is the default value. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAdaptiveScopeLocation +The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. + +You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocationException +The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. + +You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocation +The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocationException +The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOneDriveLocationException +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePublicFolderLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocation +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSharePointLocationException +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSkypeLocation +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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSkypeLocationException +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictiveRetention +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for 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. + +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveTeamsChannelLocation +The RemoveTeamsChannelLocation parameter specifies the Teams to remove from the policy. + +You can use any value that uniquely identifies the team. For example: + +- Name +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveTeamsChannelLocationException +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 +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveTeamsChatLocation +The RemoveTeamsChatLocation parameter specifies the Teams users to remove from the policy. + +You can use any value that uniquely identifies the user. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveTeamsChatLocationException +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 +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartSimulation +The StartSimulation parameter specifies whether to start the simulation for a policy that was created in simulation mode. Valid values are: + +- $true: Start the simulation. +- $false: Don't start the simulation. This is the default value. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +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-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md new file mode 100644 index 0000000000..3a544e128a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md @@ -0,0 +1,384 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-RetentionComplianceRule + +## 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-RetentionComplianceRule cmdlet to modify existing retention rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-RetentionComplianceRule [-Identity] <ComplianceRuleIdParameter> + [-ApplyComplianceTag <String>] + [-Comment <String>] + [-Confirm] + [-ContentContainsSensitiveInformation <PswsHashtable[]>] + [-ContentDateFrom <DateTime>] + [-ContentDateTo <DateTime>] + [-ContentMatchQuery <String>] + [-ExcludedItemClasses <MultiValuedProperty>] + [-ExpirationDateOption <String>] + [-IRMRiskyUserProfiles <String>] + [-PriorityCleanup] + [-RetentionComplianceAction <String>] + [-RetentionDuration <Unlimited>] + [-RetentionDurationDisplayHint <HoldDurationHint>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days +``` + +This example changes the hold duration for the existing retention rule named "Internal Company Rule". + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -ApplyComplianceTag +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. + +You can't use this parameter with the Name or PublishComplianceTag parameters. + +You can't use this parameter for Teams retention rules. + +```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 +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +You can't use this parameter for Teams retention rules. + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateFrom +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". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateTo +The ContentDateTo parameter specifies the end date of the date range for content to include. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +You can't use this parameter for Teams retention rules. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedItemClasses +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +- IPM.Note.Microsoft.Conversation +- IPM.Note.Microsoft.Conversation.Voice +- IPM.Note.Microsoft.Missed +- IPM.Note.Microsoft.Missed.Voice +- IPM.Note.Microsoft.Voicemail +- IPM.Note.Microsoft.VoiceMessage.UA +- IPM.Note.Microsoft.Voicemail.UM +- IPM.Note.Microsoft.Voicemail.UM.CA + +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. + +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use this parameter for Teams retention rules. + +```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 +``` + +### -ExpirationDateOption +The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: + +- CreationAgeInDays +- ModificationAgeInDays + +You can't use this parameter for Teams retention rules. + +```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 +``` + +### -IRMRiskyUserProfiles +{{ Fill IRMRiskyUserProfiles Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionComplianceAction +The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDurationDisplayHint +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. + +- Days +- Months +- Years + +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. + +You can't use this parameter for Teams retention rules. + +```yaml +Type: HoldDurationHint +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-RetentionPolicy.md b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md new file mode 100644 index 0000000000..14102c1ff4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md @@ -0,0 +1,254 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-RetentionPolicy cmdlet to change the properties of an existing retention policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-RetentionPolicy [-Identity] <MailboxPolicyIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Force] + [-IsDefault] + [-IsDefaultArbitrationMailbox] + [-Name <String>] + [-RetentionId <Guid>] + [-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-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). + +## PARAMETERS + +### -Identity +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you use the RetentionId parameter. + +```yaml +Type: SwitchParameter +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 +``` + +### -IsDefault +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. + +**Note**: Changing which retention policy is the default might or might not affect new and existing mailboxes based on the value of the RetentionPolicy parameter on all mailbox plans: + +- $null (blank): Changes to which retention policy is the default are continually reflected in new and existing mailboxes. +- A retention policy is specified: The value of the RetentionPolicy parameter for all mailbox plans should be $null (blank) or match the Exchange retention policy that's configured as the default policy for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. For more information see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). + +If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. + +Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefaultArbitrationMailbox +This parameter is available only in the cloud-based service. + +The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. + +This parameter isn't available in on-premises deployments. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionId +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyTagLinks +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/policy-and-compliance-retention/Set-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md similarity index 83% rename from exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md rename to exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md index 9145f11ff8..f4d7334536 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-RetentionPolicyTag @@ -13,15 +16,15 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RetentionPolicyTag cmdlet to modify the properties of a retention tag. -For more information about retention tags, see Retention tags and retention policies (https://technet.microsoft.com/library/dd297955.aspx). +For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Identity ``` -Set-RetentionPolicyTag [-Identity] <RetentionPolicyTagIdParameter> +Set-RetentionPolicyTag [-Identity] <RetentionPolicyTagIdParameter> [-AddressForJournaling <RecipientIdParameter>] [-AgeLimitForRetention <EnhancedTimeSpan>] [-Comment <String>] @@ -29,18 +32,20 @@ Set-RetentionPolicyTag [-Identity] <RetentionPolicyTagIdParameter> [-DomainController <Fqdn>] [-Force] [-JournalingEnabled <Boolean>] - [-LabelForJournaling <String>] + [-LabelForJournaling <String>] [-LegacyManagedFolder <ELCFolderIdParameter>] [-LocalizedComment <MultiValuedProperty>] [-LocalizedRetentionPolicyTagName <MultiValuedProperty>] [-MessageClass <String>] [-MessageFormatForJournaling <JournalingFormat>] - [-MustDisplayCommentEnabled <$true | $false>] + [-MustDisplayCommentEnabled <Boolean>] [-Name <String>] - [-RetentionAction <MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit | MoveToArchive>] - [-RetentionEnabled <$true | $false>] - [-RetentionId <Guid>] [-SystemTag <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-RetentionAction <RetentionAction>] + [-RetentionEnabled <Boolean>] + [-RetentionId <Guid>] + [-SystemTag <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ### MailboxTask @@ -53,30 +58,31 @@ Set-RetentionPolicyTag -Mailbox <MailboxIdParameter> [-LegacyManagedFolder <ELCFolderIdParameter>] [-LocalizedComment <MultiValuedProperty>] [-LocalizedRetentionPolicyTagName <MultiValuedProperty>] - [-MustDisplayCommentEnabled <$true | $false>] + [-MustDisplayCommentEnabled <Boolean>] [-Name <String>] [-OptionalInMailbox <RetentionPolicyTagIdParameter[]>] [-RetentionId <Guid>] - [-SystemTag <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-SystemTag <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days" ``` This example changes the comment for the AllUsers-DeletedItems retention policy tag. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB" ``` @@ -92,6 +98,7 @@ 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 Default value: None @@ -100,7 +107,18 @@ Accept wildcard characters: False ``` ### -Mailbox -The Mailbox parameter specifies a mailbox for assigning opt-in tags. +The Mailbox parameter specifies a mailbox for assigning opt-in tags. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) You must use this parameter with the OptionalInMailbox parameter. @@ -109,6 +127,7 @@ 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 Default value: None @@ -117,15 +136,16 @@ Accept wildcard characters: False ``` ### -AddressForJournaling -This parameter is available or funcational only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -141,6 +161,7 @@ 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 Default value: None @@ -156,6 +177,7 @@ 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 Default value: None @@ -166,8 +188,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -175,6 +196,7 @@ 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 Default value: None @@ -192,6 +214,7 @@ 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 @@ -200,13 +223,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you use the RetentionId parameter. ```yaml Type: SwitchParameter 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 @@ -215,15 +241,16 @@ Accept wildcard characters: False ``` ### -JournalingEnabled -This parameter is available or funcational only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: Boolean Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -232,7 +259,7 @@ Accept wildcard characters: False ``` ### -LabelForJournaling -This parameter is available or funcational only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -241,6 +268,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -256,6 +284,7 @@ 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 Default value: None @@ -271,6 +300,7 @@ 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 Default value: None @@ -286,6 +316,7 @@ 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 Default value: None @@ -307,6 +338,7 @@ 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 Default value: None @@ -315,7 +347,7 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling -This parameter is available or functional only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -324,6 +356,7 @@ Type: JournalingFormat Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -335,10 +368,11 @@ Accept wildcard characters: False The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. ```yaml -Type: $true | $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 Default value: None @@ -354,6 +388,7 @@ 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 Default value: None @@ -362,13 +397,14 @@ Accept wildcard characters: False ``` ### -OptionalInMailbox -The OptionalInMailbox parameter is used with the Mailbox parameter to specify opt-in retention tags available to the mailbox. +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 Default value: None @@ -380,11 +416,8 @@ Accept wildcard characters: False 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. 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). @@ -392,10 +425,11 @@ The MoveToDeletedItems and MoveToFolder actions are available, but don't work. T If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml -Type: MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit | MoveToArchive +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 Default value: None @@ -408,13 +442,14 @@ The RetentionEnabled parameter specifies whether the tag is enabled. When set to 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\_\<Original Name\>. +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_<Original Name>`. ```yaml -Type: $true | $false +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 Default value: None @@ -425,13 +460,14 @@ Accept wildcard characters: False ### -RetentionId 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). -It's not ordinarily required to specify or modify the RetentionId parameter for a retention tag. The parameter is populated automatically by \<scriptname\> when importing retention tags in a cross-forest or cross-premises deployment. +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. ```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 Default value: None @@ -443,10 +479,11 @@ Accept wildcard characters: False The SystemTag parameter specifies whether the retention policy tag is created for internal Exchange functionality. ```yaml -Type: $true | $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 Default value: None @@ -462,6 +499,7 @@ 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 Default value: None @@ -470,20 +508,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6ab21a02-7283-456a-a1c7-1a09b1722981.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md rename to exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md index 69c915ca76..eca66e5008 100644 --- a/exchange/exchange-ps/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-RoleAssignmentPolicy @@ -13,26 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RoleAssignmentPolicy cmdlet to modify existing management role assignment policies in your organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RoleAssignmentPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-Description <String>] - [-DomainController <Fqdn>] [-IsDefault] [-Name <String>] [-WhatIf] [<CommonParameters>] +Set-RoleAssignmentPolicy [-Identity] <MailboxPolicyIdParameter> + [-Confirm] + [-Description <String>] + [-DomainController <Fqdn>] + [-IsDefault] + [-Name <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION You can use the Set-RoleAssignmentPolicy cmdlet to change the name of an assignment policy or to set the assignment policy as the default assignment policy. -For more information about assignment policies, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-RoleAssignmentPolicy "End User Policy" -IsDefault ``` @@ -48,6 +57,7 @@ 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 Default value: None @@ -58,8 +68,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -67,6 +76,7 @@ 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 Default value: None @@ -82,6 +92,7 @@ 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 Default value: None @@ -101,6 +112,7 @@ 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 @@ -109,7 +121,7 @@ Accept wildcard characters: False ``` ### -IsDefault -The IsDefault switch makes the assignment policy the default assignment policy. You don't have to specify a value with this switch. +The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -118,6 +130,7 @@ 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 @@ -133,6 +146,7 @@ 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 Default value: None @@ -148,6 +162,7 @@ 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 Default value: None @@ -156,20 +171,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1c7a9d2a-db55-4bfb-82d2-60c859b8646c.aspx) diff --git a/exchange/exchange-ps/exchange/Set-RoleGroup.md b/exchange/exchange-ps/exchange/Set-RoleGroup.md new file mode 100644 index 0000000000..b0c9fd04a3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RoleGroup.md @@ -0,0 +1,366 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-RoleGroup cmdlet to modify who can add or remove members to or from management role groups or change the name of the role group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### CrossForest +``` +Set-RoleGroup [-Identity] <RoleGroupIdParameter> -LinkedDomainController <String> -LinkedForeignGroup <UniversalSecurityGroupIdParameter> + [-LinkedCredential <PSCredential>] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-Description <String>] + [-DisplayName <String>] + [-DomainController <Fqdn>] + [-ManagedBy <MultiValuedProperty>] + [-Name <String>] + [-WhatIf] + [<CommonParameters>] +``` + +### Default +``` +Set-RoleGroup [-Identity] <RoleGroupIdParameter> + [-Force] + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-Description <String>] + [-DisplayName <String>] + [-ManagedBy <MultiValuedProperty>] + [-Name <String>] + [-WellKnownObject <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +If you want to add or remove members to or from an existing role group, use the Add-RoleGroupMember or Remove-RoleGroupMember cmdlets. If you want to add or remove management role assignments to or from a role group, use the New-ManagementRoleAssignment or Remove-ManagementRoleAssignment cmdlets. If you want to add or remove members to or from a linked role group, you must add or remove the members to or from the foreign universal security group (USG) in the foreign forest. To find the foreign USG, use the Get-RoleGroup cmdlet. + +If the ManagedBy property is populated with role group managers, the user configuring a role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. + +For more information about role groups, see [Understanding management role groups](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Set-RoleGroup "London Recipient Administrators" -ManagedBy "David", "Christine" +``` + +This example sets the role group managers list to David and Christine on the London Recipient Administrators role group. + +### Example 2 +```powershell +Set-RoleGroup "Seattle Administrators" -ManagedBy "Seattle Role Administrators" -BypassSecurityGroupManagerCheck +``` + +This example sets the role group managers list to the Seattle Role Administrators USG on the Seattle Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. + +### Example 3 +```powershell +$Credentials = Get-Credential + +Set-RoleGroup "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Tier 2 Administrators" +``` + +This example modifies the linked foreign USG on the existing linked role group ContosoUsers: Toronto Recipient Admins. The foreign USG that should be linked is Toronto Tier 2 Administrators. + +The first command retrieves the credentials using the Get-Credential cmdlet and stores them in the $Credentials variable. The second command modifies the foreign USG on the ContosoUsers: Toronto Recipient Admins linked role group. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -LinkedDomainController +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. + +You can only use the LinkedDomainController parameter with a linked role group. + +```yaml +Type: String +Parameter Sets: CrossForest +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedForeignGroup +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 ("). + +You can only use the LinkedForeignGroup parameter to change the foreign USG linked to an existing linked role group. You can't change a standard role group to a linked role group by using the Set-RoleGroup cmdlet. You must create a role group using the New-RoleGroup cmdlet. + +If you use the LinkedForeignGroup parameter, you must specify a domain controller in the LinkedDomainController parameter. + +```yaml +Type: UniversalSecurityGroupIdParameter +Parameter Sets: CrossForest +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: CrossForest +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 +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Default +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedCredential +This parameter is available only in on-premises Exchange. + +The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +You can only use the LinkedCredential parameter with a linked role group. + +```yaml +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 +Accept wildcard characters: False +``` + +### -ManagedBy +The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see [Modifying multivalued properties](https://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 ("). + +If you want to add more than one user or USG, separate them using commas. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WellKnownObject +This parameter is available only in the cloud-based service. + +{{ Fill WellKnownObject Description }} + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch 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: 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Set-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md similarity index 81% rename from exchange/exchange-ps/exchange/mail-flow/Set-RoutingGroupConnector.md rename to exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md index 0965df2bbc..d17b041270 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-RoutingGroupConnector @@ -13,15 +16,22 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-RoutingGroupConnector cmdlet to modify the properties of an existing routing group connector between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group. You can also use this cmdlet to configure the maximum message size that can pass across a routing group connector. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-RoutingGroupConnector [-Identity] <RoutingGroupConnectorIdParameter> [-Confirm] [-Cost <Int32>] - [-DomainController <Fqdn>] [-MaxMessageSize <Unlimited>] [-Name <String>] - [-PublicFolderReferralsEnabled <$true | $false>] [-SourceTransportServers <MultiValuedProperty>] - [-TargetTransportServers <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] +Set-RoutingGroupConnector [-Identity] <RoutingGroupConnectorIdParameter> + [-Confirm] + [-Cost <Int32>] + [-DomainController <Fqdn>] + [-MaxMessageSize <Unlimited>] + [-Name <String>] + [-PublicFolderReferralsEnabled <Boolean>] + [-SourceTransportServers <MultiValuedProperty>] + [-TargetTransportServers <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -29,21 +39,19 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-RoutingGroupConnector -Identity "Exchange Administrative Group (FYDIBOHF23SPDLT)\Exchange Routing Group (DWBGZMFD01QNBJR)\Ex2010 to Ex2003 RGC" -Cost 70 -MaxMessageSize 10MB -SourceTransportServers 2010Hub1.contoso.com -TargetTransportServers 2003BH1.contoso.com ``` This example makes the following configuration changes to the routing group connector Ex2010 to Ex2003 RGC: - Sets the cost to 70. - - Sets a maximum message size limit of 10 MB. - - Specifies new source and target servers for the connector. ## PARAMETERS @@ -56,6 +64,7 @@ Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -66,8 +75,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -75,6 +83,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -90,6 +99,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -105,6 +115,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -116,11 +127,8 @@ Accept wildcard characters: False 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) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) Unqualified values are treated as bytes. The valid input range for this parameter is from 64KB through Int64. To remove the message size limit on a Send connector, enter a value of unlimited. @@ -130,6 +138,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -145,6 +154,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -156,10 +166,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -168,13 +179,14 @@ Accept wildcard characters: False ``` ### -SourceTransportServers -The SourceTransportServers parameter specifies the host name or FQDN of the transport servers that are used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see Modifying Multivalued Properties. +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 Default value: None @@ -183,13 +195,14 @@ Accept wildcard characters: False ``` ### -TargetTransportServers -The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see Modifying Multivalued Properties. +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 Default value: None @@ -205,6 +218,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -213,20 +227,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/63311a62-c2b6-46a3-91ba-c9fa9af16573.aspx) diff --git a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md new file mode 100644 index 0000000000..970b171e11 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md @@ -0,0 +1,230 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-RpcClientAccess + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-RpcClientAccess cmdlet to modify the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-RpcClientAccess -Server <ServerIdParameter> + [-BlockedClientVersions <String>] + [-Confirm] + [-DomainController <Fqdn>] + [-EncryptionRequired <Boolean>] + [-MaximumConnections <Int32>] + [-Name <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Outlook 2007 isn't supported in Exchange 2016 or later, so you shouldn't see Outlook connections at or below version 12.Y.Z. However, you should monitor the RPC Client Access log to see the client versions that are connecting to your Exchange servers before you block any client versions. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-RpcClientAccess -Server MBX01 -BlockedClientVersions 14.0.0-14.32767.65535 +``` + +This example prevents Outlook Anywhere connections by Outlook 2010 clients on the server named MBX01. + +### Example 2 +```powershell +Set-RpcClientAccess -Server MBX01 -BlockedClientVersions 15.0.0-15.4737.999 +``` + +This example prevents Outlook Anywhere connections by Outlook 2013 clients that don't have KB3054940 installed (version 15.0.4737.1000) on the server named MBX01. + +**Note**: You can determine specific client software versions by parsing the RPC Client Access log files located at %ExchangeInstallPath%Logging\\RPC Client Access. + +## PARAMETERS + +### -Server +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BlockedClientVersions +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. + +- X is the major version number. For example, Outlook 2016 is 16, Outlook 2013 is 15, and Outlook 2010 is 14. +- Y is the minor revision number, and must be less than or equal to 32767. +- Z is the build number, and must be less than or equal to 65535. + +You can specify ranges. For example, -13.32767.65535, 14.0.0-14.32767.65535, or 15.0.0-. + +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. + +```yaml +Type: String +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 +``` + +### -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 +``` + +### -EncryptionRequired +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumConnections +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. + +```yaml +Type: Int32 +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 +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md new file mode 100644 index 0000000000..fbaa17c621 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -0,0 +1,246 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SafeAttachmentPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-SafeAttachmentPolicy cmdlet to modify safe attachment policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SafeAttachmentPolicy [-Identity] <SafeAttachmentPolicyIdParameter> + [-Action <SafeAttachmentAction>] + [-AdminDisplayName <String>] + [-Confirm] + [-Enable <Boolean>] + [-QuarantineTag <String>] + [-Redirect <Boolean>] + [-RedirectAddress <SmtpAddress>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -QuarantineTag ContosoLimitedAccess +``` + +This example modifies the existing safe attachment policy named Engineering Block Attachments to set the quarantine policy to ContosoLimitedAccess. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Action +The Action parameter specifies the action for the safe attachment policy. Valid values are: + +- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the Microsoft Defender portal. +- Block: Block the email message that contains the malware attachment. This is the default value. +- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [Dynamic Delivery in Safe Attachments policies](https://learn.microsoft.com/defender-office-365/safe-attachments-about#dynamic-delivery-in-safe-attachments-policies). + +The value of this parameter is meaningful only when the value of the Enable parameter is $true (the default value is $false). + +To specify no action for the safe attachment policy (corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the Defender portal), use the value $false for the Enable parameter. + +The results of all actions are available in message trace. + +```yaml +Type: SafeAttachmentAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +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). + +To enable or disable an existing Safe Attachments policy, use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTag +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware by Safe Attachments as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Redirect +The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: + +- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is meaningful only when the value of the Action parameter is Allow. +- $false: Messages that contain malware attachments aren't delivered to another email address. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectAddress +The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. + +The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md new file mode 100644 index 0000000000..985e31a012 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md @@ -0,0 +1,343 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SafeAttachmentRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-SafeAttachmentRule cmdlet to modify safe attachment rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SafeAttachmentRule [-Identity] <RuleIdParameter> + [-Comments <String>] + [-Confirm] + [-ExceptIfRecipientDomainIs <Word[]>] + [-ExceptIfSentTo <RecipientIdParameter[]>] + [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] + [-Name <String>] + [-Priority <Int32>] + [-RecipientDomainIs <Word[]>] + [-SafeAttachmentPolicy <SafeAttachmentPolicyIdParameter>] + [-SentTo <RecipientIdParameter[]>] + [-SentToMemberOf <RecipientIdParameter[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-SafeAttachmentRule -Identity "Engineering Department Attachment Rule" -ExceptIfRecipientDomainIs fabrikam.com +``` + +This example modifies the existing safe attachment rule named Engineering Department Attachment Rule to exclude messages sent to the fabrikam.com domain. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeAttachmentPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't specify a safe attachment policy that's already associated with another safe attachment rule. + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md new file mode 100644 index 0000000000..4587cee20b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md @@ -0,0 +1,391 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SafeLinksPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-SafeLinksPolicy cmdlet to modify Safe Links policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SafeLinksPolicy [-Identity] <SafeLinksPolicyIdParameter> + [-AdminDisplayName <String>] + [-AllowClickThrough <Boolean>] + [-Confirm] + [-CustomNotificationText <String>] + [-DeliverMessageAfterScan <Boolean>] + [-DisableUrlRewrite <Boolean>] + [-DoNotRewriteUrls <MultiValuedProperty>] + [-EnableForInternalSenders <Boolean>] + [-EnableOrganizationBranding <Boolean>] + [-EnableSafeLinksForEmail <Boolean>] + [-EnableSafeLinksForOffice <Boolean>] + [-EnableSafeLinksForTeams <Boolean>] + [-ScanUrls <Boolean>] + [-TrackClicks <Boolean>] + [-UseTranslatedNotificationText <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-SafeLinksPolicy -Identity "Engineering Block URL" -AllowClickThrough $false +``` + +This example modifies the existing Safe Links policy named Engineering Block URL to not allow click through to the original URLs on warning pages. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Safe Links policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowClickThrough +The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: + +$true: The user is allowed to click through to the original URL. +$false: The user isn't allowed to click through to the original URL. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomNotificationText +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliverMessageAfterScan +The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: + +- $true: Wait until Safe Links scanning is complete before delivering the message. This is the default value. Messages that contain malicious links are not delivered. +- $false: If Safe Links scanning can't complete, deliver the message anyway. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableUrlRewrite +The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: + +- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). +- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotRewriteUrls +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"`. + +For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://learn.microsoft.com/defender-office-365/safe-links-about#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableForInternalSenders +The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: + +- $true: The policy is applied to internal and external senders. This is the default value. +- $false: The policy is applied only to external senders. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: + +- $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeLinksForEmail +The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: + +- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for email. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeLinksForOffice +The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: + +- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Office apps. + +Note that this protection applies to links in Office documents, not links in email messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSafeLinksForTeams +The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: + +- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Teams. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanUrls +The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: + +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $false: Real-time scanning of clicked links, including links that point to files, is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrackClicks +The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: + +- $true: User clicks are tracked. This is the default value. +- $false: User clicks aren't tracked. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseTranslatedNotificationText +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md new file mode 100644 index 0000000000..6db4b01eeb --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md @@ -0,0 +1,359 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SafeLinksRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SafeLinksRule [-Identity] <RuleIdParameter> + [-Comments <String>] + [-Confirm] + [-ExceptIfRecipientDomainIs <Word[]>] + [-ExceptIfSentTo <RecipientIdParameter[]>] + [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] + [-Name <String>] + [-Priority <Int32>] + [-RecipientDomainIs <Word[]>] + [-SafeLinksPolicy <SafeLinksPolicyIdParameter>] + [-SentTo <RecipientIdParameter[]>] + [-SentToMemberOf <RecipientIdParameter[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Recipient filters in Safe Links policies](https://learn.microsoft.com/defender-office-365/safe-links-about#recipient-filters-in-safe-links-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-SafeLinksRule -Identity "Engineering Department URL Rule" -ExceptIfRecipientDomainIs fabrikam.com +``` + +This example modifies the existing Safe Links rule named Engineering Department URL Rule to exclude messages sent to recipients in the fabrikam.com domain. + +### Example 2 +```powershell +Set-SafeLinksRule -Identity "Contoso All" -RecipientDomainIs (Get-AcceptedDomain).Name +``` + +This example modifies the existing Safe Links rule named Contoso All to include messages sent to recipients in all accepted domains in the organization. + +### Example 3 +```powershell +$Data = Import-Csv -Path "C:\Data\SafeLinksDomains.csv" + +$SLDomains = $Data.Domains + +Set-SafeLinksRule -Identity "Contoso All" -RecipientDomainIs $SLDomains +``` + +This example is similar to Example 2, but in this example, the Safe Links rule includes messages sent to recipients in the accepted domains specified in a .csv file. + +## PARAMETERS + +### -Identity +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: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeLinksPolicy +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't specify a Safe Attachments policy that's already associated with another Safe Attachments rule. + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md new file mode 100644 index 0000000000..4288a07794 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md @@ -0,0 +1,154 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-SearchDocumentFormat + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-SearchDocumentFormat cmdlet to enable or disable the file format for Exchange Search. + +When you disable a file format for content indexing by Exchange Search, contents of the file become unsearchable by Exchange Search clients such as Outlook on the web, Microsoft Outlook in online mode and In-Place eDiscovery. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SearchDocumentFormat [-Identity] <SearchDocumentFormatId> -Enabled <Boolean> + [-Confirm] + [-Server <ServerIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-SearchDocumentFormat ZIP -Enabled $false +``` + +This command disables the Zip file format for indexing by Exchange Search. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Enabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Set-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md new file mode 100644 index 0000000000..0c6e563991 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md @@ -0,0 +1,222 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SecOpsOverridePolicy + +## 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). + +For 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-SecOpsOverridePolicy [-Identity] <PolicyIdParameter> + [-AddSentTo <MultiValuedProperty>] + [-Comment <String>] + [-Confirm] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-Force] + [-RemoveSentTo <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-SecOpsOverridePolicy -Identity SecOpsOverridePolicy -AddSentTo secops2@contoso.com +``` + +This example modifies the SecOPs mailbox override policy with the specified settings. + +## PARAMETERS + +### -Identity +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 +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AddSentTo +The AddSentTo parameter specifies an entry to add to the existing list of SecOps mailbox email addresses. Groups are not allowed. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSentTo +The RemoveSentTo parameter specifies an entry to remove from the existing list of SecOps mailbox email addresses. Groups are not allowed. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-SendConnector.md b/exchange/exchange-ps/exchange/Set-SendConnector.md similarity index 79% rename from exchange/exchange-ps/exchange/mail-flow/Set-SendConnector.md rename to exchange/exchange-ps/exchange/Set-SendConnector.md index d776222c2e..a8e6726d37 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-SendConnector.md +++ b/exchange/exchange-ps/exchange/Set-SendConnector.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SendConnector @@ -13,44 +16,64 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SendConnector cmdlet to modify a Send connector. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SendConnector [-Identity] <SendConnectorIdParameter> [-AddressSpaces <MultiValuedProperty>] - [-AuthenticationCredential <PSCredential>] [-Comment <String>] [-Confirm] - [-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-DNSRoutingEnabled <$true | $false>] - [-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-Enabled <$true | $false>] - [-ErrorPolicies <Default | DowngradeAuthFailures | DowngradeDnsFailures>] [-Force] - [-ForceHELO <$true | $false>] [-Fqdn <Fqdn>] [-IgnoreSTARTTLS <$true | $false>] - [-IsCoexistenceConnector <$true | $false>] [-IsScopedConnector <$true | $false>] - [-LinkedReceiveConnector <ReceiveConnectorIdParameter>] [-MaxMessageSize <Unlimited>] [-Name <String>] - [-Port <Int32>] [-ProtocolLoggingLevel <None | Verbose>] [-RequireOorg <$true | $false>] - [-RequireTLS <$true | $false>] - [-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>] - [-SmartHosts <MultiValuedProperty>] [-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress <IPAddress>] +Set-SendConnector [-Identity] <SendConnectorIdParameter> + [-AddressSpaces <MultiValuedProperty>] + [-AuthenticationCredential <PSCredential>] + [-CloudServicesMailEnabled <Boolean>] + [-Comment <String>] + [-Confirm] + [-ConnectionInactivityTimeOut <EnhancedTimeSpan>] + [-ConnectorType <TenantConnectorType>] + [-DNSRoutingEnabled <Boolean>] + [-DomainController <Fqdn>] + [-DomainSecureEnabled <Boolean>] + [-Enabled <Boolean>] + [-ErrorPolicies <ErrorPolicies>] + [-Force] + [-ForceHELO <Boolean>] + [-Fqdn <Fqdn>] + [-FrontendProxyEnabled <Boolean>] + [-IgnoreSTARTTLS <Boolean>] + [-IsCoexistenceConnector <Boolean>] + [-IsScopedConnector <Boolean>] + [-LinkedReceiveConnector <ReceiveConnectorIdParameter>] + [-MaxMessageSize <Unlimited>] + [-Name <String>] + [-Port <Int32>] + [-ProtocolLoggingLevel <ProtocolLoggingLevel>] + [-RequireOorg <Boolean>] + [-RequireTLS <Boolean>] + [-SmartHostAuthMechanism <AuthMechanisms>] + [-SmartHosts <MultiValuedProperty>] + [-SmtpMaxMessagesPerConnection <Int32>] + [-SourceIPAddress <IPAddress>] [-SourceTransportServers <MultiValuedProperty>] - [-TlsAuthLevel <EncryptionOnly | CertificateValidation | DomainValidation>] - [-TlsDomain <SmtpDomainWithSubdomains>] [-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf] - [-CloudServicesMailEnabled <$true | $false>] [-FrontendProxyEnabled <$true | $false>] - [-TlsCertificateName <SmtpX509Identifier>] [-ConnectorType <Default | XPremises>] [<CommonParameters>] + [-TlsAuthLevel <TlsAuthLevel>] + [-TlsCertificateName <SmtpX509Identifier>] + [-TlsDomain <SmtpDomainWithSubdomains>] + [-UseExternalDNSServersEnabled <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SendConnector "Contoso.com Send Connector" -MaxMessageSize 10MB -ConnectionInactivityTimeOut 00:15:00 ``` This example makes the following configuration changes to the Send connector named Contoso.com Send Connector: - Sets the maximum message size limit to 10 MB. - - Changes the connection inactivity time-out to 15 minutes. ## PARAMETERS @@ -63,6 +86,7 @@ Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -71,22 +95,17 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is as follows: \<AddressSpaceType\>:\<AddressSpace\>;\<AddressSpaceCost\> +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. - - 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. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("). For example, the following address space entries are equivalent: - "SMTP:contoso.com;1" - - "contoso.com;1" - - "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". @@ -94,16 +113,16 @@ You may specify multiple address spaces by separating the address spaces with co 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://technet.microsoft.com/library/aa996779.aspx). +Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -112,13 +131,39 @@ Accept wildcard characters: False ``` ### -AuthenticationCredential -The AuthenticationCredential parameter specifies a credential object. This credential object is created by using the Get-Credential cmdlet. For more information about the Get-Credential cmdlet, enter Get-Help Get-Credential in the Exchange Management Shell. +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). ```yaml Type: PSCredential 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 +``` + +### -CloudServicesMailEnabled +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). + +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. +- $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 Default value: None @@ -134,6 +179,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -144,8 +190,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -153,6 +198,26 @@ 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 +``` + +### -ConnectorType +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. +- 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 Default value: None @@ -172,6 +237,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -183,10 +249,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -204,6 +271,7 @@ 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 @@ -215,9 +283,7 @@ Accept wildcard characters: False 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. - - The value of the DNSRoutingEnabled parameter must be $true. - - The value of the IgnoreStartTLS parameter must be $false. The wildcard character (\*) is not supported in domains that are configured for mutual TLS authentication. The same domain must also be defined on the corresponding Receive connector and in the TLSReceiveDomainSecureList attribute of the transport configuration. @@ -225,16 +291,16 @@ The wildcard character (\*) is not supported in domains that are configured for The default value for the DomainSecureEnabled parameter is $false for the following types of Send connectors: - All Send connectors defined in the Transport service on a Mailbox server. - - User-created Send connectors defined on an Edge server. The default value for the DomainSecureEnabled parameter is $true for default Send connectors defined on an Edge server. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -246,10 +312,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -261,11 +328,8 @@ Accept wildcard characters: False 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. - - DowngradeDnsFailures: All DNS errors are treated as transient. - - DowngradeCustomFailures: Particular SMTP errors are treated as transient. - - UpgradeCustomFailures Custom transient failures are upgraded and treated as permanent failures. Multiple values can be specified for this parameter, separated by commas. @@ -273,10 +337,11 @@ Multiple values can be specified for this parameter, separated by commas. Specify a value other than Default for this parameter only if this Send connector is used to send messages over a reliable and well-defined communication channel where communication errors aren't expected. For example, consider specifying a value other than Default if this Send connector is used to send messages to a partner. ```yaml -Type: Default | DowngradeAuthFailures | DowngradeDnsFailures +Type: ErrorPolicies Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -285,13 +350,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -303,10 +371,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -318,9 +387,7 @@ Accept wildcard characters: False 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 - - In the most recent Received header field added to the message by the next hop messaging server after the message leaves the Transport service on a Mailbox server or an Edge server - - During TLS authentication The default value of the Fqdn parameter is $null. This means the default FQDN value is the FQDN of the Mailbox server or Edge server that contains the Send connector. @@ -330,6 +397,23 @@ 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 +``` + +### -FrontendProxyEnabled +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 Default value: None @@ -341,10 +425,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -353,15 +438,16 @@ Accept wildcard characters: False ``` ### -IsCoexistenceConnector -This parameter is available or functional only in 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 Office 365 organization. The default value is $false. +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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -373,10 +459,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -385,33 +472,28 @@ Accept wildcard characters: False ``` ### -LinkedReceiveConnector -This parameter is available or functional only in 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: - GUID - - Distinguished name (DN) - - Servername\\ConnectorName When you use the LinkedReceiveConnector parameter with this command, you must also use the following parameters with the specified values: -- AddressSpaces$null - -- DNSRoutingEnabled$false - -- MaxMessageSizeunlimited - -- Smarthosts \<SmarthostID\> - -- SmarthostAuthMechanism \<AuthMechanism\> +- `AddressSpaces $null` +- `DNSRoutingEnabled $false` +- `MaxMessageSize unlimited` +- `Smarthosts <SmarthostID>` +- `SmarthostAuthMechanism <AuthMechanism>` ```yaml Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -425,13 +507,9 @@ The MaxMessageSize parameter specifies the maximum size of a message that can pa When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -443,6 +521,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -458,6 +537,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -473,6 +553,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -484,10 +565,11 @@ Accept wildcard characters: False 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: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -499,10 +581,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -514,10 +597,11 @@ Accept wildcard characters: False The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -529,10 +613,11 @@ Accept wildcard characters: False 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: None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative +Type: AuthMechanisms Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -541,17 +626,18 @@ Accept wildcard characters: False ``` ### -SmartHosts -The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameteris required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. +The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -567,6 +653,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -582,6 +669,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -592,15 +680,16 @@ Accept wildcard characters: False ### -SourceTransportServers 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -612,18 +701,33 @@ Accept wildcard characters: False 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. - - 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 Send connector also verifies that the FQDN of the target certificate matches the domain specified in the TlsDomain parameter. If no domain is specified in the TlsDomain parameter, the FQDN on the certificate is compared with the recipient's domain. You can't specify a value for this parameter if the IgnoreSTARTTLS parameter is set to $true, or if the RequireTLS parameter is set to $false. ```yaml -Type: EncryptionOnly | CertificateValidation | DomainValidation +Type: TlsAuthLevel 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 +``` + +### -TlsCertificateName +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"<I>X.500Issuer<S>X.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 <Thumbprint>`, run the command `$TLSCertName = "<I>$($TLSCert.Issuer)<S>$($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 @@ -639,7 +743,6 @@ This parameter is used only if the TlsAuthLevel parameter is set to DomainValida A value for this parameter is required if: - The TLSAuthLevel parameter is set to DomainValidation. - - The DNSRoutingEnabled parameter is set to $false (smart host Send connector). ```yaml @@ -647,6 +750,7 @@ Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -658,10 +762,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -677,78 +782,7 @@ 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 -``` - -### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx). - -The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendProxyEnabled -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\<I\>X.500Issuer\<S\>X.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 \<Thumbprint\>, run the command $TLSCertName = "\<I\>$($TLSCert.Issuer)\<S\>$($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: False -Accept wildcard characters: False -``` - -### -ConnectorType -The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Office 365. Valid values are: - -- Default: The connector isn't used to send messages to Office 365. This is the default value. - -- XPremises: The connector is used to send messages to Office 365. - -```yaml -Type: Default | XPremises -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -757,20 +791,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5b9cf002-848a-4f35-b51f-e1ede131b136.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderFilterConfig.md rename to exchange/exchange-ps/exchange/Set-SenderFilterConfig.md index 0e82e3972e..1b634750be 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SenderFilterConfig @@ -13,25 +16,33 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SenderFilterConfig cmdlet to modify the Sender Filter agent configuration. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SenderFilterConfig [-Action <StampStatus | Reject>] [-BlankSenderBlockingEnabled <$true | $false>] - [-BlockedDomains <MultiValuedProperty>] [-BlockedDomainsAndSubdomains <MultiValuedProperty>] - [-BlockedSenders <MultiValuedProperty>] [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>] - [-ExternalMailEnabled <$true | $false>] [-InternalMailEnabled <$true | $false>] - [-RecipientBlockedSenderAction <Reject | Delete>] [-WhatIf] [<CommonParameters>] +Set-SenderFilterConfig [-Action <BlockedSenderAction>] + [-BlankSenderBlockingEnabled <Boolean>] + [-BlockedDomains <MultiValuedProperty>] + [-BlockedDomainsAndSubdomains <MultiValuedProperty>] + [-BlockedSenders <MultiValuedProperty>] + [-Confirm] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-ExternalMailEnabled <Boolean>] + [-InternalMailEnabled <Boolean>] + [-RecipientBlockedSenderAction <RecipientBlockedSenderAction>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SenderFilterConfig -BlankSenderBlockingEnabled $true -BlockedDomainsAndSubdomains lucernepublishing.com -BlockedSenders @{Add="user1@contoso.com","user2@contoso.com"} ``` @@ -49,10 +60,11 @@ It adds user1@contoso.com and user2@contoso.com to the blocked senders list with 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: StampStatus | Reject +Type: BlockedSenderAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -64,10 +76,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -80,9 +93,9 @@ The BlockedDomains parameter specifies the domain names to block. When the Sende 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. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The maximum number of entries for this parameter is 800. @@ -91,6 +104,7 @@ 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 @@ -103,9 +117,9 @@ The BlockedDomainsAndSubdomains parameter specifies the domain names to block. W 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. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The maximum number of entries for this parameter is 800. @@ -114,6 +128,7 @@ 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 @@ -124,9 +139,9 @@ Accept wildcard characters: False ### -BlockedSenders 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The maximum number of entries for this parameter is 800. @@ -135,6 +150,7 @@ 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 @@ -145,8 +161,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -154,6 +169,7 @@ 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 @@ -171,6 +187,7 @@ 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 @@ -182,10 +199,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -197,10 +215,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -212,10 +231,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -229,10 +249,11 @@ The RecipientBlockedSenderAction parameter specifies the action that the Sender Valid input for this parameter is Delete or Reject. The default value is Reject. ```yaml -Type: Reject | Delete +Type: RecipientBlockedSenderAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -248,6 +269,7 @@ 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 @@ -256,20 +278,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2c7e6bd3-c35d-488b-9dc8-a9c36ed078f1.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderIdConfig.md b/exchange/exchange-ps/exchange/Set-SenderIdConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderIdConfig.md rename to exchange/exchange-ps/exchange/Set-SenderIdConfig.md index 3a1fac8131..eaeddca576 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderIdConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderIdConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SenderIdConfig @@ -13,31 +16,38 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SenderIdConfig cmdlet to modify the configuration of the Sender ID agent. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-SenderIdConfig [-BypassedRecipients <MultiValuedProperty>] [-BypassedSenderDomains <MultiValuedProperty>] - [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExternalMailEnabled <$true | $false>] - [-InternalMailEnabled <$true | $false>] [-SpoofedDomainAction <StampStatus | Reject | Delete>] - [-TempErrorAction <StampStatus | Reject | Delete>] [-WhatIf] [<CommonParameters>] +Set-SenderIdConfig + [-BypassedRecipients <MultiValuedProperty>] + [-BypassedSenderDomains <MultiValuedProperty>] + [-Confirm] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-ExternalMailEnabled <Boolean>] + [-InternalMailEnabled <Boolean>] + [-SpoofedDomainAction <SenderIdAction>] + [-TempErrorAction <SenderIdAction>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SenderIdConfig -SpoofedDomainAction Delete -BypassedRecipients user1@contoso.com,user2@contoso.com ``` This example makes the following modifications to the Sender ID configuration: - It sets the Sender ID agent to delete all messages sent from spoofed domains. - - It specifies two recipients for the Sender ID agent to exclude when it processes messages. ## PARAMETERS @@ -50,6 +60,7 @@ 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 @@ -65,6 +76,7 @@ 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 @@ -75,8 +87,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -84,6 +95,7 @@ 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 @@ -101,6 +113,7 @@ 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 @@ -112,10 +125,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -127,10 +141,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -142,10 +157,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -157,10 +173,11 @@ Accept wildcard characters: False 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: StampStatus | Reject | Delete +Type: SenderIdAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -172,10 +189,11 @@ Accept wildcard characters: False 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: StampStatus | Reject | Delete +Type: SenderIdAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -191,6 +209,7 @@ 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 @@ -199,20 +218,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/754e925b-bfa2-43f4-b0ac-3b51cb720e64.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderReputationConfig.md b/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderReputationConfig.md rename to exchange/exchange-ps/exchange/Set-SenderReputationConfig.md index 9c16859d34..610a9441ff 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-SenderReputationConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SenderReputationConfig @@ -13,26 +16,34 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SenderReputationConfig cmdlet to modify the sender reputation configuration on Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SenderReputationConfig [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>] - [-ExternalMailEnabled <$true | $false>] [-InternalMailEnabled <$true | $false>] - [-OpenProxyDetectionEnabled <$true | $false>] [-ProxyServerName <String>] [-ProxyServerPort <Int32>] - [-ProxyServerType <None | Socks4 | Socks5 | HttpConnect | HttpPost | Telnet | Cisco | Wingate>] - [-SenderBlockingEnabled <$true | $false>] [-SenderBlockingPeriod <Int32>] [-SrlBlockThreshold <Int32>] - [-WhatIf] [<CommonParameters>] +Set-SenderReputationConfig [-Confirm] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-ExternalMailEnabled <Boolean>] + [-InternalMailEnabled <Boolean>] + [-OpenProxyDetectionEnabled <Boolean>] + [-ProxyServerName <String>] + [-ProxyServerPort <Int32>] + [-ProxyServerType <ProxyType>] + [-SenderBlockingEnabled <Boolean>] + [-SenderBlockingPeriod <Int32>] + [-SrlBlockThreshold <Int32>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SenderReputationConfig -SrlBlockThreshold 6 -SenderBlockingPeriod 36 ``` @@ -47,8 +58,7 @@ It sets the number of hours that senders are put on the blocked senders list to ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -56,6 +66,7 @@ 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 @@ -73,6 +84,7 @@ 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 @@ -84,14 +96,14 @@ Accept wildcard characters: False 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. - - $false: Sender reputation is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -103,14 +115,14 @@ Accept wildcard characters: False 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. - - $false: Sender reputation is disabled on mail from external sources. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -122,14 +134,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,7 +153,6 @@ Accept wildcard characters: False 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. - - $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. @@ -151,10 +162,11 @@ If your organization uses a proxy server for outbound Internet access, you also 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -163,7 +175,7 @@ Accept wildcard characters: False ``` ### -ProxyServerName -The ProxyServerName parameter specifies the nameor IP address of your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. +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. @@ -172,6 +184,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -189,6 +202,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -197,29 +211,23 @@ Accept wildcard characters: False ``` ### -ProxyServerType -The ProxyServerType parameter specifiesthe 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: +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. - - Cisco - - HttpConnect - - HttpPost - - Socks4 - - Socks5 - - Telnet - - Wingate ```yaml -Type: None | Socks4 | Socks5 | HttpConnect | HttpPost | Telnet | Cisco | Wingate +Type: ProxyType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -228,10 +236,9 @@ Accept wildcard characters: False ``` ### -SenderBlockingEnabled -The SenderBlockingEnabled parameter allows or prevents sender reputation from blocking senders when theirsender reputation level (SRL) meets or exceeds the value of the SrlBlockThreshold parameter. Valid values are: +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. - - $false: Sender blocking is disabled. You can temporarily block senders for up to 48 hours when you use the SenderBlockingPeriod parameter. @@ -239,10 +246,11 @@ You can temporarily block senders for up to 48 hours when you use the SenderBloc 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -258,6 +266,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -275,6 +284,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -290,6 +300,7 @@ 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 @@ -298,20 +309,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e4e95705-01a2-43a2-9dd8-3da9014cc489.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ServerComponentState.md b/exchange/exchange-ps/exchange/Set-ServerComponentState.md new file mode 100644 index 0000000000..11c76cf3c6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ServerComponentState.md @@ -0,0 +1,258 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ServerComponentState + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ServerComponentState cmdlet to configure and update Microsoft Exchange components and endpoints on servers you specify. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ServerComponentState [-Identity] <ServerIdParameter> -Component <String> -Requester <String> -State <ServiceState> + [-Confirm] + [-DomainController <Fqdn>] + [-LocalOnly] + [-RemoteOnly] + [-TimeoutInSeconds <Int32>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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 -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 +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Component +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Requester +The Requester parameter specifies the system requesting this state change. Valid values are: + +- HealthAPI +- Maintenance +- Sidelined +- Functional +- Deployment + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The State parameter specifies the state that you want for the component. Valid values are: + +- Active +- Inactive +- Draining + +```yaml +Type: ServiceState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalOnly +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteOnly +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutInSeconds +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/server-health-and-performance/Set-ServerMonitor.md b/exchange/exchange-ps/exchange/Set-ServerMonitor.md similarity index 76% rename from exchange/exchange-ps/exchange/server-health-and-performance/Set-ServerMonitor.md rename to exchange/exchange-ps/exchange/Set-ServerMonitor.md index 136371c6d8..42b0c4a810 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Set-ServerMonitor.md +++ b/exchange/exchange-ps/exchange/Set-ServerMonitor.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ServerMonitor @@ -13,22 +16,25 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ServerMonitor cmdlet to edit or set a parameter on a single monitor on an Exchange server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-ServerMonitor [-Server] <ServerIdParameter> -Name <String> -Repairing <$true | $false> [-Confirm] - [-TargetResource <String>] [-WhatIf] [<CommonParameters>] +Set-ServerMonitor [-Server] <ServerIdParameter> -Name <String> -Repairing <Boolean> + [-Confirm] + [-TargetResource <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-ServerMonitor -Name Maintenance -Repairing $true -Server Exch01 ``` @@ -36,68 +42,65 @@ This example sets the maintenance monitor on the Exch01 server. ## PARAMETERS -### -Name -The Name parameter specifies the monitor identity. +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN ```yaml -Type: String +Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Repairing -The Repairing parameter specifies whether to set or clear the repairing property on a monitor. - -The default value is $true. +### -Name +The Name parameter specifies the monitor identity. ```yaml -Type: $true | $false +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN +### -Repairing +The Repairing parameter specifies whether to set or clear the repairing property on a monitor. -If you don't use this parameter, the command is run on the local server. +The default value is $true. ```yaml -Type: ServerIdParameter +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -105,6 +108,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -120,6 +124,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,6 +140,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,20 +149,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/91952b6e-099e-4182-95d2-da5d9001ca0b.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md new file mode 100644 index 0000000000..78b5a30bc0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md @@ -0,0 +1,129 @@ +--- +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 +ms.author: chrisda +ms.reviewer: bili1 +--- + +# Set-ServicePrincipal + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ServicePrincipal cmdlet to change service principals in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ServicePrincipal [-Identity] <ServicePrincipalIdParameter> + [-Confirm] + [-DisplayName <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to change the DisplayName only. If AppId/ObjectId is wrong, delete the service principal and create a new one. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ServicePrincipal -Identity dc873ad4-0397-4d74-b5c0-897cd3a94731 -DisplayName "Another App Name" +``` + +This example sets the service principal in Exchange Online with the specified display name. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to modify. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ObjectId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Set-SettingOverride.md b/exchange/exchange-ps/exchange/Set-SettingOverride.md similarity index 76% rename from exchange/exchange-ps/exchange/organization/Set-SettingOverride.md rename to exchange/exchange-ps/exchange/Set-SettingOverride.md index 7d7e755672..f038384c37 100644 --- a/exchange/exchange-ps/exchange/organization/Set-SettingOverride.md +++ b/exchange/exchange-ps/exchange/Set-SettingOverride.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SettingOverride @@ -15,26 +18,34 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SettingOverride cmdlet to modify setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SettingOverride [-Identity] <SettingOverrideIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-FixVersion <Version>] [-MaxVersion <Version>] [-MinVersion <Version>] [-Parameters <MultiValuedProperty>] - [-Reason <String>] [-Server <String[]>] [-WhatIf] [-Force] [<CommonParameters>] +Set-SettingOverride [-Identity] <SettingOverrideIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Force] + [-MaxVersion <Version>] + [-MinVersion <Version>] + [-Parameters <MultiValuedProperty>] + [-Reason <String>] + [-Server <String[]>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-sepcific, 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. +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-SettingOverride -Identity "Change OAB Generation" -Server Mailbox01 -Component TimeBasedAssistants -Section OABGeneratorAssistant -Parameters @("WorkCycle=03:00:00") +### Example 1 +```powershell +Set-SettingOverride -Identity "Change OAB Generation" -Server Mailbox01 -Parameters @("WorkCycle=03:00:00") ``` This example modifies the setting override named Change OAB Generation on the server named Mailbox01 by changing the OAB generation interval to 3 hours. @@ -45,9 +56,7 @@ This example modifies the setting override named Change OAB Generation on the 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 - - Distinguished name (DN) - - GUID ```yaml @@ -55,6 +64,7 @@ Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -65,8 +75,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -74,6 +83,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -89,6 +99,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -96,14 +107,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FixVersion -This parameter is reserved for internal Microsoft use. +### -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: Version +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -123,6 +137,7 @@ Type: Version Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -142,6 +157,7 @@ Type: Version Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -150,19 +166,17 @@ Accept wildcard characters: False ``` ### -Parameters -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: +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") - -- @("IMServerName=\<SkypePoolFQDN\>","IMCertificateThumbprint=\<ThumbprintGUID\>") +- `@("Enabled=true")` +- `@("IMServerName=<SkypePoolFQDN>","IMCertificateThumbprint=<ThumbprintGUID>")` ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -178,6 +192,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -195,6 +210,7 @@ Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -210,21 +226,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -233,20 +235,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eaa7f08c-cc7e-4700-8784-ebe2d586f3fb.aspx) diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/Set-SharingPolicy.md new file mode 100644 index 0000000000..5f5182f760 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SharingPolicy.md @@ -0,0 +1,237 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-SharingPolicy cmdlet to modify existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SharingPolicy [-Identity] <SharingPolicyIdParameter> + [-Confirm] + [-Default] + [-DomainController <Fqdn>] + [-Domains <MultiValuedProperty>] + [-Enabled <Boolean>] + [-Name <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing options for the mailbox. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-SharingPolicy -Identity Contoso -Domains "mail.contoso.com: CalendarSharingFreeBusySimple" +``` + +This example modifies the sharing policy Contoso for contoso.com, which is a domain outside your organization. This policy allows users in the Contoso domain to see simple free/busy information. + +### Example 2 +```powershell +Set-SharingPolicy -Identity SharingPolicy01 -Domains "contoso.com: CalendarSharingFreeBusySimple", "atlanta.contoso.com: CalendarSharingFreeBusyReviewer", "beijing.contoso.com: CalendarSharingFreeBusyReviewer" +``` + +This example adds a second domain to the sharing policy SharingPolicy01. When you're adding a domain to an existing policy, you must include any previously included domains. + +### Example 3 +```powershell +Set-SharingPolicy -Identity "SharingPolicy01" -Enabled $false +``` + +This example disables the sharing policy SharingPolicy01. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the sharing policy that you want to modify. You can use one of the following values: + +- ADObjectID +- Distinguished name (DN) +- Legacy DN +- GUID + +```yaml +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 +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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Default +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domains +The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. + +You can use the following values for `Domain`: + +- A domain: For example, `mail.contoso.com`. A domain doesn't include subdomains. You must configure each subdomain separately. +- \*: Share with external federated organizations. For example, another Microsoft 365 organization or an on-premises Exchange organization. +- Anonymous: Share with external, non-federated organizations and individuals with internet access. + +You can use the following values for `SharingPolicyAction`: + +- CalendarSharingFreeBusySimple: Share free/busy hours only +- CalendarSharingFreeBusyDetail: Share free/busy hours, subject and location +- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location and the body of the message or calendar item +- ContactsSharing: Share contacts only + +You can specify multiple `'Domain: SharingPolicyAction'` values separated by commas, and you can specify multiple `SharingPolicyAction` values for the same domain separated by commas. For example, `'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'`. + +```yaml +Type: MultiValuedProperty +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 +``` + +### -Enabled +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. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SiteMailbox.md b/exchange/exchange-ps/exchange/Set-SiteMailbox.md new file mode 100644 index 0000000000..c9c67e224a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SiteMailbox.md @@ -0,0 +1,329 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-SiteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-SiteMailbox cmdlet to change a site mailbox's settings, such as the Microsoft SharePoint URL. This cmdlet is primarily used by the SharePoint and Microsoft Exchange user interfaces, such as the SharePoint URL. This cmdlet should only be used for diagnostic and troubleshooting purposes. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SiteMailbox [-Identity] <RecipientIdParameter> + [-Active <Boolean>] + [-Confirm] + [-DisplayName <String>] + [-DomainController <Fqdn>] + [-Force] + [-Members <RecipientIdParameter[]>] + [-Owners <RecipientIdParameter[]>] + [-RemoveDuplicateMessages <Boolean>] + [-SharePointUrl <Uri>] + [-ShowInMyClient <Boolean>] + [-SyncEnabled <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-SiteMailbox -Identity "MarketingEvents 2013" -SharePointUrl "https://myserver/teams/marketing" +``` + +This example changes the SharePoint URL for the MarketingEvents 2013 site mailbox. + +### Example 2 +```powershell +Set-SiteMailbox -Identity SMO_ContosoSales -RemoveDuplicateMessages $true +``` + +This example disables the duplication of email messages in the site mailbox SMO\_ContosoSales. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the site mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Active +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name of the site mailbox. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Members +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. + +You can use any value that uniquely identifies the member. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Owners +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. + +You can use any value that uniquely identifies the owner. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointUrl +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInMyClient +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncEnabled +The SyncEnabled parameter specifies whether to enable or disable synchronization for the site mailbox. Valid values are: + +- $true: Synchronization is enabled. +- $true: Synchronization is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md index cfe64431cd..460a831c41 100644 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md @@ -1,56 +1,69 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SiteMailboxProvisioningPolicy schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SiteMailboxProvisioningPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Set-SiteMailboxProvisioningPolicy cmdlet to modify an existing site mailbox provisioning policy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-SiteMailboxProvisioningPolicy [-Identity] <MailboxPolicyIdParameter> [-AliasPrefix <String>] [-Confirm] - [-DefaultAliasPrefixEnabled <$true | $false>] [-DomainController <Fqdn>] [-IsDefault] - [-IssueWarningQuota <ByteQuantifiedSize>] [-MaxReceiveSize <ByteQuantifiedSize>] [-Name <String>] - [-ProhibitSendReceiveQuota <ByteQuantifiedSize>] [-WhatIf] [<CommonParameters>] +Set-SiteMailboxProvisioningPolicy [-Identity] <MailboxPolicyIdParameter> + [-AliasPrefix <String>] + [-Confirm] + [-DefaultAliasPrefixEnabled <Boolean>] + [-DomainController <Fqdn>] + [-IsDefault] + [-IssueWarningQuota <ByteQuantifiedSize>] + [-MaxReceiveSize <ByteQuantifiedSize>] + [-Name <String>] + [-ProhibitSendReceiveQuota <ByteQuantifiedSize>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SiteMailboxProvisioningPolicy -Identity Default -MaxReceiveSize 25MB ``` This example changes the site mailbox provisioning policy named Default to allow the maximum size of email messages that can be received by the site mailbox to 25 MB. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-SiteMailboxProvisioningPolicy -Identity Default -IssueWarningQuota 9GB -ProhibitSendReceiveQuota 10GB ``` This example changes the warning quota to 9.5 GB and the prohibit send and receive quota to 10 GB. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-SiteMailboxProvisioningPolicy -Identity SM_DefaultPolicy -AliasPrefix Project ``` -This example changes the default provisioning policy named SM\_DefaultPolicy and sets the AliasPrefix value to Project. When you create new site mailboxes, the prefix Project- is automatically added to the alias. +This example changes the default provisioning policy named SM\_DefaultPolicy and sets the AliasPrefix value to Project. When you create new site mailboxes, the prefix `Project-` is automatically added to the alias. ## PARAMETERS @@ -58,16 +71,15 @@ This example changes the default provisioning policy named SM\_DefaultPolicy and 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 - - Distinguished name (DN) - - GUID ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -79,14 +91,14 @@ Accept wildcard characters: False 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. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -97,15 +109,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -116,17 +128,17 @@ Accept wildcard characters: False ### -DefaultAliasPrefixEnabled 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 Office 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 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`). - $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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -135,8 +147,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -144,6 +154,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -152,8 +163,6 @@ Accept wildcard characters: False ``` ### -IsDefault -This parameter is available only in on-premises Exchange. - The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. You can have multiple policies, but only the default policy is followed when users create site mailboxes. @@ -163,6 +172,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -171,20 +181,14 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota -This parameter is available only in on-premises Exchange. - The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -198,6 +202,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -206,22 +211,15 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. The default value is 36 MB. @@ -231,6 +229,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -239,8 +238,6 @@ Accept wildcard characters: False ``` ### -Name -This parameter is available only in on-premises Exchange. - The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml @@ -248,6 +245,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -256,20 +254,14 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota -This parameter is available only in on-premises Exchange. - The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -283,6 +275,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -297,7 +290,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -306,20 +300,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2a53ae55-9f2c-4dbd-b476-19bacacad3bb.aspx) diff --git a/exchange/exchange-ps/exchange/Set-SmimeConfig.md b/exchange/exchange-ps/exchange/Set-SmimeConfig.md new file mode 100644 index 0000000000..3b0f0fe2bb --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SmimeConfig.md @@ -0,0 +1,666 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-SmimeConfig cmdlet to modify the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SmimeConfig [[-Identity] <OrganizationIdParameter>] + [-Confirm] + [-OWAAllowUserChoiceOfSigningCertificate <Boolean>] + [-OWAAlwaysEncrypt <Boolean>] + [-OWAAlwaysSign <Boolean>] + [-OWABCCEncryptedEmailForking <UInt32>] + [-OWACheckCRLOnSend <Boolean>] + [-OWAClearSign <Boolean>] + [-OWACopyRecipientHeaders <Boolean>] + [-OWACRLConnectionTimeout <UInt32>] + [-OWACRLRetrievalTimeout <UInt32>] + [-OWADisableCRLCheck <Boolean>] + [-OWADLExpansionTimeout <UInt32>] + [-OWAEncryptionAlgorithms <String>] + [-OWAEncryptTemporaryBuffers <Boolean>] + [-OWAForceSMIMEClientUpgrade <Boolean>] + [-OWAIncludeCertificateChainAndRootCertificate <Boolean>] + [-OWAIncludeCertificateChainWithoutRootCertificate <Boolean>] + [-OWAIncludeSMIMECapabilitiesInMessage <Boolean>] + [-OWANoSignOnReply <Boolean>] + [-OWAOnlyUseSmartCard <Boolean>] + [-OWASenderCertificateAttributesToDisplay <String>] + [-OWASignedEmailCertificateInclusion <Boolean>] + [-OWASigningAlgorithms <String>] + [-OWATripleWrapSignedEncryptedMail <Boolean>] + [-OWAUseKeyIdentifier <Boolean>] + [-OWAUseSecondaryProxiesWhenFindingCertificates <Boolean>] + [-SMIMECertificateIssuingCA <Byte[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-SmimeConfig -OWAAllowUserChoiceOfSigningCertificate $true -OWACRLRetrievalTimeout 10000 -OWAEncryptionAlgorithms 6602:128 +``` + +This example sets the S/MIME configuration to allow users the choice of signing the message, limits the Certificate Revocation List (CRL) retrieval time-out to 10 seconds, and specifies the 128 bit RC2 encryption algorithm. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAAllowUserChoiceOfSigningCertificate +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAAlwaysEncrypt +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAAlwaysSign +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWABCCEncryptedEmailForking +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. +- 1: One single encrypted message for all Bcc recipients. +- 2: One encrypted message without Bcc forking. + +This setting affects the security and privacy of Outlook on the web. Consult your organization's security policy before you change this setting. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWACheckCRLOnSend +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAClearSign +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWACopyRecipientHeaders +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWACRLConnectionTimeout +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). + +When multiple CRLs in a certificate chain must be retrieved, the time limit that's specified by this parameter applies to each connection. For example, if a certificate requires the retrieval of three CRLs, and this parameter is set to 60000 (60 seconds), each individual CRL retrieval operation has a time limit of 60 seconds. If any one of the CRLs isn't retrieved before the time limit expires, the entire operation fails. The total time limit for all the retrievals is controlled by the OWACRLRetrievalTimeout parameter. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWACRLRetrievalTimeout +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). + +If all the required CRLs are not retrieved before the time limit expires, the operation fails. Suppose the retrieval of three CRLs is required, the OWACRLConnectionTimeout value is set to 60000 (60 seconds), and the OWACRLRetrievalTimeout is set to 120000 (2 minutes). In this example, if any individual CRL retrieval takes more than 60 seconds, the operation fails. Also, if all the CRL retrievals together take more than 120 seconds, the operation fails. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWADisableCRLCheck +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWADLExpansionTimeout +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. + +When sending an encrypted message to a distribution group, Exchange expands the distribution group to retrieve the encryption certificate of each recipient. While the distribution group is being expanded, the sender receives no response from Outlook on the web. + +The timeout value that's specified by this parameter is applied to the expansion of each distribution group. For example, if an encrypted message is sent to three distribution group, and the value of this parameter is 60000 (60 seconds), the entire operation can take no more than 180 seconds. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAEncryptionAlgorithms +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) +- 6602: RC2. Supported key lengths are 40, 56, 64, and 128. RC2 is the only supported algorithm that offers multiple key lengths. +- 6603: 3DES (168-bit) +- 660E: AES128 +- 660F: AES192 +- 6610: AES256 (This is the 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,<CustomOID>`. + +This parameter uses the syntax `<AlgorithmID>` or `RC2:<KeyLength>` or `<AlgorithmID>,<CustomOID>`. 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`. + +If the parameter is not specified or is not formatted correctly, Outlook on the web uses 6610 (AES256). If the encryption algorithm or minimum key length is not available on a client, Outlook on the web does not allow encryption. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAEncryptTemporaryBuffers +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAForceSMIMEClientUpgrade +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAIncludeCertificateChainAndRootCertificate +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAIncludeCertificateChainWithoutRootCertificate +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAIncludeSMIMECapabilitiesInMessage +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWANoSignOnReply +This parameter is available only in the cloud-based service. + +{{ Fill OWANoSignOnReply Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAOnlyUseSmartCard +The OWAOnlyUseSmartCard parameter specifies whether smartcard-based certificates are required for Outlook on the web message signing and decryption. Valid values are: + +$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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWASenderCertificateAttributesToDisplay +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWASignedEmailCertificateInclusion +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. +- $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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWASigningAlgorithms +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) + +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,<CustomOID>`. + +This parameter uses the syntax `<AlgorithmID>` or `<AlgorithmID>:<KeyLength>` or `<AlgorithmID>,<CustomOID>`. You can specify multiple values separated by semicolons (;). + +For example, to set the signing algorithms to CALG\_SHA\_512, SHA1, and CALG\_MD5, use the value `800E;8004;8003`. + +If this parameter is not specified or is not formatted correctly, Outlook on the web defaults to 8004 (SHA1). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWATripleWrapSignedEncryptedMail +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. + +Triple-wrapped messages offer the highest level of security for messages under the S/MIME standard, but are larger in size. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAUseKeyIdentifier +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. + +By default, Outlook on the web encodes the asymmetrically encrypted token (sometimes called a Lockbox) that's required to decrypt the rest of the message by indicating the issuer and serial number of each recipient's certificate. The issuer and serial number can then be used to locate the certificate and private key for decrypting the message. + +This parameter causes the use of a certificate's key identifier when encoding the asymmetrically encrypted token. Because a key pair can be reused in new certificates, using the key identifier for encrypted email messages means that users need to keep only the most recent certificate and associated private key, rather than all old certificates. Because some email clients do not support finding certificates with a key identifier, Outlook on the web uses the issuer and serial number of each recipient's certificate by default. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAUseSecondaryProxiesWhenFindingCertificates +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SMIMECertificateIssuingCA +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('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). + +Each certificate is checked, and if any certificates are expired, the operation will fail. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md new file mode 100644 index 0000000000..ac5377657b --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md @@ -0,0 +1,299 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SupervisoryReviewPolicyV2 + +## 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-SupervisoryReviewPolicyV2 cmdlet to modify supervisory review policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SupervisoryReviewPolicyV2 [-Identity] <PolicyIdParameter> + [-AddReviewers <String[]>] + [-Comment <String>] + [-Confirm] + [-Enabled <Boolean>] + [-Force] + [-PolicyRBACScopes <MultiValuedProperty>] + [-PolicyTemplate <String>] + [-PreservationPeriodInDays <Int32>] + [-RemoveReviewers <String[]>] + [-RetentionPeriodInDays <Int32>] + [-Reviewers <String[]>] + [-UserReportingWorkloads <String[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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-SupervisoryReviewPolicyV2 -Identity "EU Brokers" -AddReviewers chris@contoso.com,michelle@contoso.com -Comment "Updated for new EU regulations" +``` + +This example adds reviewers and updates the comment for the supervisory review policy named EU Brokers. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AddReviewers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +{{ Fill Enabled 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All)) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplate +{{ Fill PolicyTemplate Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreservationPeriodInDays +{{ Fill PreservationPeriodInDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveReviewers +The RemoveReviewers parameter specifies the SMTP addresses of reviewers to remove from the supervisory review policy. You can specify multiple email addresses separated by commas. + +```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 +``` + +### -RetentionPeriodInDays +The RetentionPeriodInDays parameter specifies the number of days that the messages will be retained for review. + +```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 +``` + +### -Reviewers +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. + +```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 +``` + +### -UserReportingWorkloads +{{ Fill UserReportingWorkloads 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 +``` + +### -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-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md new file mode 100644 index 0000000000..3b3c0210d9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -0,0 +1,461 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-SupervisoryReviewRule + +## 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-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-SupervisoryReviewRule [-Identity] <ComplianceRuleIdParameter> + [-AdvancedRule <String>] + [-CcsiDataModelOperator <String>] + [-Condition <String>] + [-Confirm] + [-ContentContainsSensitiveInformation <PswsHashtable[]>] + [-ContentMatchesDataModel <String>] + [-ContentSources <String[]>] + [-DayXInsights <Boolean>] + [-ExceptIfFrom <MultiValuedProperty>] + [-ExceptIfRecipientDomainIs <MultiValuedProperty>] + [-ExceptIfRevieweeIs <MultiValuedProperty>] + [-ExceptIfSenderDomainIs <MultiValuedProperty>] + [-ExceptIfSentTo <MultiValuedProperty>] + [-ExceptIfSubjectOrBodyContainsWords <MultiValuedProperty>] + [-From <MultiValuedProperty>] + [-IncludeAdaptiveScopes <String[]>] + [-InPurviewFilter <String>] + [-Ocr <Boolean>] + [-PolicyRBACScopes <MultiValuedProperty>] + [-SamplingRate <Int32>] + [-SentTo <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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-SupervisoryReviewRule -Identity "EU Brokers Rule" -Conditions "((NOT(Reviewee:US Compliance)) -AND (Reviewee:EU Brokers) -AND ((trade) -OR (insider trading)) -AND (NOT(approved by the Contoso financial team)))" +``` + +This example modifies the existing rule named EU Brokers Rule with the following settings: + +- Conditions: Supervise inbound and outbound communications for members of the EU Brokers group that contain the words trade or insider trading. +- Exceptions: Exclude supervision for members of the EU Compliance group, or messages that contain the phrase "approved by the Contoso financial team". + +## PARAMETERS + +### -Identity +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 +- 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 +``` + +### -AdvancedRule +{{ Fill AdvancedRule Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CcsiDataModelOperator +{{ Fill CcsiDataModelOperator Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: + +- User or group communications to supervise: `"((Reviewee:<emailaddress1>) -OR (Reviewee:<emailaddress2>)...)"`. Exceptions use the syntax `"(NOT((Reviewee:<emailaddress1>) -OR (Reviewee:<emailaddress2>)...))"`. +- Direction: `"((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))"`. +- Message contains words: `"((<Word1orPhrase1>) -OR (<Word2orPhrase2>)...)"`. Exceptions use the syntax `"(NOT((<Word1orPhrase1>) -OR (<Word2orPhrase2>)...))"`. +- Any attachment contains words: `"((Attachment:<word1>) -OR (Attachment:<word2>)...)"`. Exceptions use the syntax `"(NOT((Attachment:<word1>) -OR (Attachment:<word2>)...))"`. +- Any attachment has the extension: `"((AttachmentName:.<extension1>) -OR (AttachmentName:.<extension2>)...)"`. Exceptions use the syntax `"(NOT((AttachmentName:.<extension1>) -OR (AttachmentName:.<extension2>)...))"`. +- Message size is larger than: `"(MessageSize:<size in B, KB, MB or GB>)"`. For example `"(MessageSize:300KB)"`. Exceptions use the syntax `"(NOT(MessageSize:<size in B, KB, MB or GB>))"`. +- Any attachment is larger than: `"(AttachmentSize:<size in B, KB, MB or GB>)"`. For example `"(AttachmentSize:3MB)"`. Exceptions use the syntax `"(NOT(AttachmentSize:<size in B, KB, MB or GB>))"`. +- Parentheses ( ) are required around the whole filter. +- Separate multiple conditions or exception types with the AND operator. For example, `"((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))"`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +{{ Fill ContentContainsSensitiveInformation Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchesDataModel +{{ Fill ContentMatchesDataModel Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSources +{{ Fill ContentSources Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DayXInsights +{{ Fill DayXInsights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +{{ Fill ExceptIfFrom Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +{{ Fill ExceptIfRecipientDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRevieweeIs +{{ Fill ExceptIfRevieweeIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +{{ Fill ExceptIfSenderDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +{{ Fill ExceptIfSentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +{{ Fill ExceptIfSubjectOrBodyContainsWords Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +{{ Fill From Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdaptiveScopes +{{ Fill IncludeAdaptiveScopes Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPurviewFilter +{{ Fill InPurviewFilter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ocr +{{ Fill Ocr Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingRate +The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. + +```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 +``` + +### -SentTo +{{ Fill SentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```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/mailboxes/Set-SweepRule.md b/exchange/exchange-ps/exchange/Set-SweepRule.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Set-SweepRule.md rename to exchange/exchange-ps/exchange/Set-SweepRule.md index bcef7b4068..184a02c1af 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-SweepRule.md +++ b/exchange/exchange-ps/exchange/Set-SweepRule.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SweepRule @@ -13,27 +16,37 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-SweepRule cmdlet to modify Sweep rules in mailboxes. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SweepRule [-Identity] <SweepRuleIdParameter> [-Confirm] [-DestinationFolder <MailboxFolderIdParameter>] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExceptIfFlagged <$true | $false>] - [-ExceptIfPinned <$true | $false>] [-KeepForDays <Int32>] [-KeepLatest <Int32>] - [-Mailbox <MailboxIdParameter>] [-Name <String>] [-Provider <String>] [-Sender <RecipientIdParameter>] +Set-SweepRule [-Identity] <SweepRuleIdParameter> + [-Confirm] + [-DestinationFolder <MailboxFolderIdParameter>] + [-DomainController <Fqdn>] + [-Enabled <Boolean>] + [-ExceptIfFlagged <Boolean>] + [-ExceptIfPinned <Boolean>] + [-KeepForDays <Int32>] + [-KeepLatest <Int32>] + [-Mailbox <MailboxIdParameter>] + [-Name <String>] + [-Provider <String>] + [-Sender <RecipientIdParameter>] [-SourceFolder <MailboxFolderIdParameter>] - [-SystemCategory <NotDefined | FromContact | Newsletter | Photo | SocialUpdate | Video | Document | File | MailingList | ShippingNotification | LiveView | DocumentPlus | Important | Family | Bills | Shopping | Travel | Flight | RestaurantReservation | Lodging | RentalCar | Purchase | Event | RetiredPromotion>] - [-WhatIf] [<CommonParameters>] + [-SystemCategory <SystemCategoryType>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SweepRule -Identity x2hlsdpGmUifjFgxxGIOJw== -KeepForDays 15 -ExceptIfPinned $true ``` @@ -45,10 +58,8 @@ This example modifies the existing rule that has the rule ID value x2hlsdpGmUifj 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==). - -- Exchange Online: \<mailbox alias\>\\\<RuleId\> (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. - -- On-premises Exchange: \<mailbox canonical name\>\\\<RuleId\> (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). You can get these identity values by using the Get-SweepRule cmdlet. @@ -57,6 +68,7 @@ Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: True Position: 1 Default value: None @@ -67,8 +79,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -76,6 +87,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -84,15 +96,29 @@ Accept wildcard characters: False ``` ### -DestinationFolder -The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder based on the conditions of the rule. +The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. -The default value is Deleted Items. +For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Unimportant` or `John:\Inbox\Misc`. The default value is `MailboxID:\Deleted Items`. ```yaml Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -110,6 +136,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -121,10 +148,11 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -133,41 +161,33 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged +This parameter is available only in on-premises Exchange. + The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are: - $true: The rule action isn't applied to messages that have a message flag applied. - - $false: The exception isn't used. The typical message flag values are: - Any - - Call - - DoNotForward - - FollowUp - - ForYourInformation - - Forward - - NoResponseNecessary - - Read - - Reply - - ReplyToAll - - Review ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -176,17 +196,19 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned +This parameter is available only in on-premises Exchange. + The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are: - $true: The rule action isn't applied to messages that are pinned to the top of the Inbox. - - $false: The exception isn't used. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -204,6 +226,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -221,6 +244,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -229,30 +253,17 @@ Accept wildcard characters: False ``` ### -Mailbox -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \<domain name\>\\\<account name\> - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -260,6 +271,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -275,6 +287,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -292,6 +305,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -300,22 +314,13 @@ Accept wildcard characters: False ``` ### -Sender -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID For external senders, use their email address. @@ -325,6 +330,7 @@ Type: RecipientIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -333,15 +339,29 @@ Accept wildcard characters: False ``` ### -SourceFolder -The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. +The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. -The default value is Inbox. +For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +Example values for this parameter are `john@contoso.com:\Marketing` or `John:\Inbox\Reports`. The default value is `MailboxID:\Inbox`. ```yaml Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -353,58 +373,36 @@ Accept wildcard characters: False 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 - - Bills - - Document - - DocumentPlus - - Event - - Family - - File - - Flight - - FromContact - - Important - - LiveView - - Lodging - - MailingList - - Newsletter - - Photo - - Purchase - - RentalCar - - RestaurantReservation - - RetiredPromotion - - ShippingNotification - - Shopping - - SocialUpdate - - Travel - - Video ```yaml -Type: NotDefined | FromContact | Newsletter | Photo | SocialUpdate | Video | Document | File | MailingList | ShippingNotification | LiveView | DocumentPlus | Important | Family | Bills | Shopping | Travel | Flight | RestaurantReservation | Lodging | RentalCar | Purchase | Event | RetiredPromotion +Type: SystemCategoryType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -420,6 +418,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -428,20 +427,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d8c929db-9ec4-4f75-b79d-f5297bf9e8e1.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-SystemMessage.md b/exchange/exchange-ps/exchange/Set-SystemMessage.md similarity index 76% rename from exchange/exchange-ps/exchange/mail-flow/Set-SystemMessage.md rename to exchange/exchange-ps/exchange/Set-SystemMessage.md index ecf9aeaf0a..0cb1bfebec 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Set-SystemMessage.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-SystemMessage @@ -13,29 +16,35 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SystemMessage cmdlet to modify custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-SystemMessage [-Identity] <SystemMessageIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Name <String>] - [-Original] [-Text <String>] [-WhatIf] [<CommonParameters>] +Set-SystemMessage [-Identity] <SystemMessageIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Name <String>] + [-Original] + [-Text <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-SystemMessage En\Internal\5.3.5 -Text "The recipient email system can't process this email message. Please contact your system administrator for more information." ``` This example modifies the text of the custom English system message for the enhanced status code 5.3.5 for internal senders. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-SystemMessage En\WarningMailbox -Text "Your mailbox has exceeded the warning limit specified by your email administrator. Please reduce the size of your mailbox." ``` @@ -47,69 +56,52 @@ This example modifies the text of the custom English WarningMailbox quota messag 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 - - Distinguished name (DN) - - GUID The identity value of a system message uses one of these formats: -- System messages for enhanced status codes: \<Language\>\\\<Internal | External\>\\\<DSNcode\>. For example, En\\Internal\\5.1.2 or Ja\\External\\5.1.2. - -- System messages for quotas: \<Language\>\\\<QuotaMessageType\>. For example, En\\ProhibitSendReceiveMailBox. +- System messages for enhanced status codes: `Language\<Internal | External>\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailbox`. -\<Language\>: For the list of supported language codes, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). +\<Language\>: For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -\<DSNcode\>: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command Get-SystemMessage. To generate a list of default enhanced status codes that are used by Exchange, run this command: Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html \> "C:\\My Documents\\Default DSNs.html". +\<DSNCode\>: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command `Get-SystemMessage`. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. \<QuotaMessageType\>: Valid value are: Mailbox size quotas: -- ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - - WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - - WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. Public folder size quotas: - ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. - - WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. - - WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. Maximum number of messages in a mailbox folder: - ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. - - WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. - - WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. Maximum number of subfolders in a mailbox folder: - ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. - - WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. - - WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. - - ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. - - WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. - - WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. Maximum number of levels (depth) in a mailbox folder: - ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. - - WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. - - WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. ```yaml @@ -117,6 +109,7 @@ Type: SystemMessageIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -127,8 +120,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -136,6 +128,7 @@ 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 @@ -153,6 +146,7 @@ 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 @@ -168,6 +162,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -187,6 +182,7 @@ 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 @@ -201,37 +197,29 @@ This parameter can contain text and HTML tags. The maximum length is 512 charact The following HTML tags are available: -- \<B\> and \</B\> (bold) - -- \<EM\> and \</EM\> (italic) - -- \<BR\> (line break) - -- \<P\> and \</P\> (paragraph) - -- \<A HREF="url"\> and \</A\> (hyperlink) - -You need to use single quotation marks (not double quotation marks) around the complete text string if you use the hyperlink tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). +- `<B>` and `</B>` (bold) +- `<EM>` and `</EM>` (italic) +- `<BR>` (line break) +- `<P>` and `</P>` (paragraph) +- `<A HREF="url">` and `</A>` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: -- < for \<. - -- > for \>. - -- " for ". - -- & for &. +- `<` for \< +- `>` for \> +- `"` for " +- `&` for & Here's an example value for this parameter that uses HTML tags and special characters: -'You tried to send a message to a \<B\>disabled\</B\> mailbox. Please visit \<A HREF="https://it.contoso.com/"\>Internal Support\</A\> or contact "InfoSec" for more information.' +`'You tried to send a message to a <B>disabled</B> mailbox. Please visit <A HREF="https://it.contoso.com/">Internal Support</A> or contact "InfoSec" for more information.'` ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -247,6 +235,7 @@ 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 @@ -255,20 +244,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/53b76641-d341-42a8-b281-018a91af6a36.aspx) diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md new file mode 100644 index 0000000000..65370a81b9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicy +applicable: Exchange Online +title: Set-TeamsProtectionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-TeamsProtectionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-TeamsProtectionPolicy cmdlet to modify Microsoft Teams protection policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TeamsProtectionPolicy [-Identity] <TeamsProtectionPolicyIdParameter> + [-AdminDisplayName <String>] + [-Confirm] + [-HighConfidencePhishQuarantineTag <String>] + [-MalwareQuarantineTag <String>] + [-WhatIf] + [-ZapEnabled <Boolean>] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-TeamsProtectionPolicy -Identity "Teams Protection Policy" -HighConfidencePhishQuarantineTag AdminOnlyWithNotifications +``` + +This example changes the quarantine policy that's used for high confidence phishing detections. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy that you want to modify. There's only one Teams protection policy in an organization named Teams Protection Policy. + +```yaml +Type: TeamsProtectionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareQuarantineTag +The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZapEnabled +The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: + +- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. +- $false: ZAP for malware and high confidence phishing messages in Teams is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md new file mode 100644 index 0000000000..859d7e7ee7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicyrule +applicable: Exchange Online +title: Set-TeamsProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-TeamsProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-TeamsProtectionPolicyRule cmdlet to modify Microsoft Teams protection policy rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TeamsProtectionPolicyRule [-Identity] <RuleIdParameter> + [-Comments <String>] + [-Confirm] + [-ExceptIfRecipientDomainIs <Word[]>] + [-ExceptIfSentTo <RecipientIdParameter[]>] + [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Configure ZAP for Teams protection in Defender for Office 365 Plan 2](https://learn.microsoft.com/defender-office-365/mdo-support-teams-about#configure-zap-for-teams-protection-in-defender-for-office-365-plan-2). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfRecipientDomainIs research.contoso.com +``` + +This example modifies the existing Teams protection policy rule by excluding recipients in the domain research.contoso.com from ZAP for Teams protection. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy rule that you want to modify. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. + +To replace all existing domains with the values you specify, use the following syntax: `Domain1,Domain2,...DomainN`. + +To add domains without affecting other existing values, use the following syntax: + +`$DomainsAdd = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" | select -Expand ExceptIfRecipientDomainIs` + +`$DomainsAdd += "Domain1","Domain2",..."DomainN"` + +`Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfRecipientDomainIs $DomainsAdd` + +To remove domains without affecting other existing values, use the following syntax: + +- Run the following commands to see the existing list of values in order: + + `$x = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule"` + + `$d = [System.Collections.ArrayList]($x.ExceptIfRecipientDomainIs)` + + `$d` + + The first value in the list has the index number 0, the second has the index number 1, and so on. + +- Use the index number to specify the value to remove. For example, to remove the seventh value in the list, run the following commands: + + `$d.RemoveAt(6)` + + `Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfRecipientDomainIs $d` + +To empty the list, use the value $null for this parameter. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To replace all existing recipients with the values you specify, use the following syntax: `"User1","User2",..."UserN"`. + +To add recipients without affecting other existing values, use the following syntax: + +`$UsersAdd = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" | select -Expand ExceptIfSentTo` + +`$UsersAdd += "User1","User2",..."UserN"` + +`Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentTo $UsersAdd` + +To remove recipients without affecting other existing values, use the following syntax: + +- Run the following commands to see the existing list of values in order: + + `$x = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule"` + + `$u = [System.Collections.ArrayList]($x.ExceptIfSentTo)` + + `$u` + + The first value in the list has the index number 0, the second has the index number 1, and so on. + +- Use the index number to specify the value to remove. For example, to remove the seventh value in the list, run the following commands: + + `$u.RemoveAt(6)` + + `Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentTo $u` + +To empty the list, use the value $null for this parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To add groups without affecting other existing values, use the following syntax: + +`$GroupsAdd = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" | select -Expand ExceptIfSentToMemberOf` + +`$GroupsAdd += "Group1","Group2",..."GroupN"` + +`Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentToMemberOf $GroupsAdd` + +To remove groups without affecting other existing values, use the following syntax: + +- Run the following commands to see the existing list of values in order: + + `$x = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule"` + + `$g = [System.Collections.ArrayList]($x.ExceptIfSentToMemberOf)` + + `$g` + + The first value in the list has the index number 0, the second has the index number 1, and so on. + +- Use the index number to specify the value to remove. For example, to remove the seventh value in the list, run the following commands: + + `$g.RemoveAt(6)` + + `Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentTo $g` + +If you remove the group after you create the rule, no exception is made for ZAP for Teams for messages that are sent to members of the group. + +To empty the list, use the value $null for this parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md new file mode 100644 index 0000000000..843a7d4d31 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -0,0 +1,306 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-TenantAllowBlockListItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-TenantAllowBlockListItems cmdlet to modify entries in the Tenant Allow/Block List in the Microsoft Defender portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Ids (Default) +``` +Set-TenantAllowBlockListItems -Ids <String[]> -ListType <ListType> + [-Allow] + [-Block] + [-ExpirationDate <DateTime>] + [-ListSubType <ListSubType>] + [-NoExpiration] + [-Notes <String>] + [-OutputJson] + [-RemoveAfter <Int32>] + [<CommonParameters>] +``` + +### Entries +``` +Set-TenantAllowBlockListItems -Entries <String[]> -ListType <ListType> + [-Allow] + [-Block] + [-ExpirationDate <DateTime>] + [-ListSubType <ListSubType>] + [-NoExpiration] + [-Notes <String>] + [-OutputJson] + [-RemoveAfter <Int32>] + [<CommonParameters>] +``` + +## 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSRAAAA" -ExpirationDate (Get-Date "5/30/2021 9:30 AM").ToUniversalTime() +``` + +This example changes the expiration date of the specified entry. + +### Example 2 +```powershell +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. + +## PARAMETERS + +### -Entries +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. +- Sender domains and email addresses: The exact domain or email address value. +- Url: The exact URL value. +- IP: IPv6 addresses only. Single IPv6 addresses in colon-hexadecimal or zero-compression format or CIDR IPv6 ranges from 1 to 128. + +This value is shown in the Value property of the entry in the output of the Get-TenantAllowBlockListItems cmdlet. + +You can't mix value types (sender, URL, file, or IP address) or allow and block actions in the same command. + +You can't use this parameter with the Ids parameter. + +```yaml +Type: String[] +Parameter Sets: Entries +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ids +The Ids parameter specifies the entries that you want to modify. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. + +An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. + +You can't use this parameter with the Entries parameter. + +```yaml +Type: String[] +Parameter Sets: Ids +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListType +The ListType parameter specifies the type of entry that you want to modify. Valid values are: + +- FileHash +- Sender +- Url +- IP + +Use the Entries or Ids parameter with this parameter to identify the entry itself. + +```yaml +Type: ListType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiration +The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. + +This switch is available to use with the following types of entries: + +- Block entries. +- URL allow entries where the ListSubType parameter value is AdvancedDelivery. +- IP address allow entries. + +You can't use this switch with the ExpirationDate parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Allow +The Allow switch specifies that you're modifying an allow entry. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Block switch specifies that you're modifying a block entry. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDate +The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +You can't use this parameter with the NoExpiration or RemoveAfter parameters. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType parameter further specifies the entry that you want to modify. Valid values are: + +- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +- Tenant: This is the default value. + +```yaml +Type: ListSubType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputJson +The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. + +You use this switch to prevent the command from halting on the first entry that contains a syntax error. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAfter +The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. + +The only valid value for this parameter is 45. + +You can't use this parameter with the ExpirationDate or NoExpirationDate parameters. + +To change the allow entry to a static expiration date/time value that doesn't depend on the LastUsedDate property, run a Set-TenantAllowBlockListItems command with the ExpirationDate parameter. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md new file mode 100644 index 0000000000..e410aa39ca --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md @@ -0,0 +1,150 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-TenantAllowBlockListSpoofItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-TenantAllowBlockListSpoofItems cmdlet to modify spoofed sender entries in the Tenant Allow/Block List. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TenantAllowBlockListSpoofItems [-Identity] <HostedConnectionFilterPolicyIdParameter> -Action <String> -Ids <String[]> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet allows or blocks spoof pairs (the combination of the spoofed user and the sending infrastructure) in the Tenant Allow/Block 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). + +## EXAMPLES + +### Example 1 +```powershell +Get-TenantAllowBlockListSpoofItems | Format-Table SpoofedUser,SendingInfrastructure,SpoofType,Action,Identity + +Set-TenantAllowBlockListSpoofItems -Identity Default -Action Block -Ids 375e76f1-eefb-1626-c8bc-5efefd057488,f8cb0908-8533-1156-ce7b-9aebd685b0eb +``` + +This example bocks the specified spoof pairs. You get the Ids parameter values from the output of Get-TenantAllowBlockListSpoofItems command (the Identity property). + +### Example 2 +```powershell +(Get-TenantAllowBlockListSpoofItems -SpoofType External | Select-Object -Property Identity).Identity | Remove-TenantAllowBlockListSpoofItems -Identity Default +``` + +This example removes all external spoof pairs from the Tenant Allow/Block List. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Action +The Action parameter specifies whether this entry is an allow or block spoofed sender entry. Valid values are: + +- Allow +- Block + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ids +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md new file mode 100644 index 0000000000..57563a2af1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md @@ -0,0 +1,246 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +The Set-TextMessagingAccount cmdlet allows a user to configure the text messaging settings on their own mailbox. An administrator can't use this cmdlet to configure the text messaging settings on another user's mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TextMessagingAccount [-Identity] <MailboxIdParameter> + [-Confirm] + [-CountryRegionId <RegionInfo>] + [-DomainController <Fqdn>] + [-IgnoreDefaultScope] + [-MobileOperatorId <Int32>] + [-NotificationPhoneNumber <E164Number>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-TextMessagingAccount -Identity 'JeffHay' -NotificationPhoneNumber 4255550100 +``` + +This example sets the notification phone number for the text messaging account for Jeff Hay. + +### Example 2 +```powershell +Set-TextMessagingAccount -Identity 'JeffHay' -CountryRegionId US -MobileOperatorId 15001 -NotificationPhoneNumber +14255550199 +``` + +This example sets the region, mobile operator and notification phone number for the text messaging account for Jeff Hay. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the target mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryRegionId +The CountryRegionId parameter specifies the country/region that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country/region selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): + +- US +- CA +- RO + +A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -MobileOperatorId +The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country/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: + +- AT&T: 15001 +- Sprint PCS: 15004 +- T-Mobile: 15005 +- Verizon Wireless: 15006 + +Canada: + +- Bell: 17001 +- Telus Mobility: 17002 + +Romania: + +- Orange Romania: 18001 + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationPhoneNumber +The NotificationPhoneNumber parameter specifies the telephone number to use for your text messaging notifications. This parameter uses the E.164 format: `+<CountryCode><CompleteTelephoneNumber>` (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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/server-health-and-performance/Set-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/server-health-and-performance/Set-ThrottlingPolicy.md rename to exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md index cf0c0777e9..aec6333325 100644 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Set-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-ThrottlingPolicy @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ThrottlingPolicy cmdlet to modify the settings for a user throttling policy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -162,37 +165,40 @@ Set-ThrottlingPolicy [-Identity] <ThrottlingPolicyIdParameter> [-SchedulesMaxBurst <Unlimited>] [-SchedulesMaxConcurrency <Unlimited>] [-SchedulesRechargeRate <Unlimited>] - [-ThrottlingPolicyScope <Regular | Organization | Global>] - [-WhatIf] [<CommonParameters>] + [-ThrottlingPolicyScope <ThrottlingPolicyScopeType>] + [-WhatIf] + [<CommonParameters>] ``` ## 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. Microsoft 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 (https://technet.microsoft.com/library/jj150503.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -$a = Get-ThrottlingPolicy RemoteSiteUserPolicy; $a | Set-ThrottlingPolicy -EwsMaxConcurrency 4 +### Example 1 +```powershell +$a = Get-ThrottlingPolicy RemoteSiteUserPolicy + +$a | Set-ThrottlingPolicy -EwsMaxConcurrency 4 ``` This example modifies a throttling policy so that users associated with this policy can have a maximum of four concurrent requests running in Exchange Web Services. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-ThrottlingPolicy RemoteSiteUserPolicy -PowerShellMaxConcurrency 3 -PowerShellMaxCmdletQueueDepth 12 ``` This example modifies a throttling policy so that it restricts the number of connections for a user to three. The users associated with this policy are only able to create three Exchange Management Shell sessions. This policy also restricts to three the number of Exchange admin center operations or Exchange Web Services operations that can be executed at the same time. In addition, the PowerShellMaxCmdletQueueDepth parameter specifies that 12 operations maximum are allowed to be executed by the user. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-ThrottlingPolicy <ThrottlingPolicyName> -PowerShellMaxDestructiveCmdlets 10 -PowerShellMaxDestructiveCmdletsTimePeriod 60 ``` @@ -208,6 +214,7 @@ Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -216,13 +223,14 @@ Accept wildcard characters: False ``` ### -AnonymousCutoffBalance -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. +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 Default value: None @@ -238,6 +246,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -253,6 +262,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -261,7 +271,7 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInAD -This parameter is available or functional only in 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. @@ -270,6 +280,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -278,7 +289,7 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInCAS -This parameter is available or functional only in 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. @@ -287,6 +298,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -295,7 +307,7 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -304,6 +316,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -319,6 +332,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -334,6 +348,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -349,6 +364,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -364,6 +380,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -379,6 +396,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -394,6 +412,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -409,6 +428,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -419,8 +439,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -428,6 +447,7 @@ 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 @@ -443,6 +463,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -458,6 +479,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -473,6 +495,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -488,6 +511,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -496,13 +520,14 @@ Accept wildcard characters: False ``` ### -CpaCutoffBalance -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. +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 Default value: None @@ -518,6 +543,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -533,6 +559,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -548,6 +575,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -556,7 +584,7 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -565,6 +593,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -580,6 +609,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -588,7 +618,7 @@ Accept wildcard characters: False ``` ### -CPUStartPercent -This parameter is available or functional only in 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. @@ -597,6 +627,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -605,13 +636,14 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxConcurrency -The DiscoveryMaxConcurrency parameter specifies the number of concurrent discovery search executions that a user can have at the same time. +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 Default value: None @@ -620,13 +652,14 @@ 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. +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -642,6 +675,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -657,6 +691,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -672,6 +707,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -687,6 +723,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -702,6 +739,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -710,13 +748,14 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes -The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx). +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 Default value: None @@ -732,6 +771,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -747,6 +787,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -764,6 +805,7 @@ 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 @@ -772,13 +814,14 @@ Accept wildcard characters: False ``` ### -EasCutoffBalance -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. +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 Default value: None @@ -794,6 +837,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -809,6 +853,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -824,6 +869,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -839,6 +885,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -854,6 +901,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -862,7 +910,7 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInAD -This parameter is available or functional only in 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. @@ -871,6 +919,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -879,7 +928,7 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInCAS -This parameter is available or functional only in 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. @@ -888,6 +937,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -896,7 +946,7 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -905,6 +955,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -920,6 +971,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -935,6 +987,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -950,6 +1003,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -965,6 +1019,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -980,6 +1035,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -995,6 +1051,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1010,6 +1067,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1025,6 +1083,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1040,6 +1099,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1055,6 +1115,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1063,13 +1124,14 @@ Accept wildcard characters: False ``` ### -EwsCutoffBalance -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. +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 Default value: None @@ -1085,6 +1147,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1093,7 +1156,7 @@ Accept wildcard characters: False ``` ### -EWSFastSearchTimeoutInSeconds -This parameter is available or functional only in 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. @@ -1102,6 +1165,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1110,7 +1174,7 @@ Accept wildcard characters: False ``` ### -EWSFindCountLimit -This parameter is available or functional only in 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. @@ -1119,6 +1183,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1134,6 +1199,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1149,6 +1215,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1157,7 +1224,7 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInAD -This parameter is available or functional only in 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. @@ -1166,6 +1233,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1174,7 +1242,7 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1183,6 +1251,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1191,7 +1260,7 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1200,6 +1269,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1215,6 +1285,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1232,6 +1303,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1240,13 +1312,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1262,6 +1337,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1270,13 +1346,14 @@ Accept wildcard characters: False ``` ### -ImapCutoffBalance -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. +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 Default value: None @@ -1292,6 +1369,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1307,6 +1385,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1315,7 +1394,7 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInAD -This parameter is available or functional only in 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. @@ -1324,6 +1403,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1332,7 +1412,7 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1341,6 +1421,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1349,7 +1430,7 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1358,6 +1439,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1373,6 +1455,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1381,19 +1464,18 @@ Accept wildcard characters: False ``` ### -IsServiceAccount -The IsServiceAccount switch specifies whether you want the user accounts associated with this policy to be moderated by the per-user thresholds specified by this policy, and also by additional throttling based on the health of system resources, such as overall CPU usage. - -This value is set to $false by default. +The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. -You may want to set this value to $true if you intend to associate this policy with user accounts that require higher throttling limits. An account that might require higher throttling limits is a service account that performs a lot of non-interactive work (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). +You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). -By setting the IsServiceAccount switch to $true, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. +By using this switch, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1409,6 +1491,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1417,13 +1500,14 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the name of the object in Active Directory. The default policy is named DefaultThrottlingPolicy\<GUID\>. +The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy<GUID>`. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1439,6 +1523,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1454,6 +1539,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1469,6 +1555,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1484,6 +1571,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1499,6 +1587,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1514,6 +1603,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1529,6 +1619,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1537,13 +1628,14 @@ Accept wildcard characters: False ``` ### -OwaCutoffBalance -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. +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 Default value: None @@ -1559,6 +1651,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1567,13 +1660,18 @@ Accept wildcard characters: False ``` ### -OWAMaxConcurrency -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. The OwaMaxConcurrency 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. +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. + +**Note**: We don't recommend setting this parameter to a large number or the value $null, because server performance might be negatively affected. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1582,7 +1680,7 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInAD -This parameter is available or functional only in 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. @@ -1591,6 +1689,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1599,7 +1698,7 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1608,6 +1707,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1616,7 +1716,7 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1625,6 +1725,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1640,6 +1741,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1648,13 +1750,14 @@ Accept wildcard characters: False ``` ### -OwaVoiceCutoffBalance -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. +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 Default value: None @@ -1670,6 +1773,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1685,6 +1789,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1700,6 +1805,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1708,13 +1814,14 @@ Accept wildcard characters: False ``` ### -PopCutoffBalance -The PopCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. +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 Default value: None @@ -1730,6 +1837,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1745,6 +1853,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1753,7 +1862,7 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInAD -This parameter is available or functional only in 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. @@ -1762,6 +1871,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1770,7 +1880,7 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInCAS -This parameter is available or functional only in 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. @@ -1779,6 +1889,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1787,7 +1898,7 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -1796,6 +1907,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -1811,6 +1923,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1819,13 +1932,14 @@ Accept wildcard characters: False ``` ### -PowerShellCutoffBalance -The PowerShellCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. +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 Default value: None @@ -1841,6 +1955,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1856,6 +1971,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1871,6 +1987,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1886,6 +2003,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1897,7 +2015,6 @@ Accept wildcard characters: False 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. - - In the context of Exchange Web Services, the PowerShellMaxConcurrency parameter specifies the number of concurrent cmdlet executions that a user can have at the same time. This parameter value doesn't necessarily correlate to the number of browsers opened by the user. @@ -1907,6 +2024,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1918,21 +2036,13 @@ Accept wildcard characters: False 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: - Disable-Mailbox - - Move-ActiveMailboxDatabase - - Remove-AcceptedDomain - - Remove-Mailbox - - Remove-MailUser - - Remove-Organization - - Set-Mailbox - - Set-MailUser - - Update-MailboxDatabaseCopy The time period used for this limit is specified by the PowerShellMaxDestructiveCmdletsTimePeriod parameter. Both values should be set at the same time. This feature isn't on by default. For more information, see the "Examples" section. @@ -1942,6 +2052,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1957,6 +2068,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1972,6 +2084,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1987,6 +2100,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2002,6 +2116,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2018,7 +2133,8 @@ 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2034,6 +2150,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2049,6 +2166,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2066,6 +2184,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2081,6 +2200,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2096,6 +2216,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2111,6 +2232,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2126,6 +2248,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2141,6 +2264,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2156,6 +2280,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2171,6 +2296,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2186,6 +2312,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2201,6 +2328,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2209,13 +2337,14 @@ Accept wildcard characters: False ``` ### -RcaCutoffBalance -The RcaCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. +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 Default value: None @@ -2231,6 +2360,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2250,6 +2380,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2258,7 +2389,7 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInAD -This parameter is available or functional only in 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. @@ -2267,6 +2398,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -2275,7 +2407,7 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInCAS -This parameter is available or functional only in 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. @@ -2284,6 +2416,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -2292,7 +2425,7 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInMailboxRPC -This parameter is available or functional only in 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. @@ -2301,6 +2434,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -2316,6 +2450,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2324,13 +2459,14 @@ Accept wildcard characters: False ``` ### -RcaSharedCutoffBalance -The RcaSharedCutoffBalance parameter specifies the resource consumption limits for all users before they're completely blocked from performing operations on a specific component. +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 Default value: None @@ -2346,6 +2482,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2363,6 +2500,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2378,6 +2516,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2393,6 +2532,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2408,6 +2548,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2423,6 +2564,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2438,6 +2580,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2453,6 +2596,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2464,18 +2608,17 @@ Accept wildcard characters: False 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. - - Organization: This scope specifies a custom policy that applies to all users in your organization. - - Global: This scope is reserved for the default throttling policy. -For more information about throttling policy scopes, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). +For more information about throttling policy scopes, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). ```yaml -Type: Regular | Organization | Global +Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2491,6 +2634,7 @@ 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 @@ -2499,20 +2643,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/80984ddd-0628-4115-92ed-6b3cef34c833.aspx) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md new file mode 100644 index 0000000000..7179fe0d72 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -0,0 +1,163 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ThrottlingPolicyAssociation + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account. + +**Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. And, if you want to apply throttling policy to a remote mailbox, first populate the remote mailbox with an ExchangeGUID by using Set-RemoteMailbox -ExchangeGUID. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ThrottlingPolicyAssociation [-Identity] <ThrottlingPolicyAssociationIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Set-ThrottlingPolicyAssociation cmdlet defines quota limits for specific objects. For example, if you notice that a user or other object is using excessive bandwidth, you can associate that object with a throttling policy that's more restrictive. + +In data center deployments, the object referred to by the Identity and ThrottlingPolicy parameters must be in the same tenant. + +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Set-ThrottlingPolicyAssociation -Identity tonysmith -ThrottlingPolicy ITStaffPolicy +``` + +This example associates a user with a username of tonysmith to the throttling policy ITStaffPolicy that has higher limits. + +### Example 2 +```powershell +$b = Get-ThrottlingPolicy ITStaffPolicy + +Set-Mailbox -Identity tonysmith -ThrottlingPolicy $b +``` + +You don't need to use the Set-ThrottlingPolicyAssociation cmdlet to associate a user with a policy. The following commands show another way to associate tonysmith with the throttling policy ITStaffPolicy. + +## PARAMETERS + +### -Identity +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 +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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottlingPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/mail-flow/Set-TransportAgent.md b/exchange/exchange-ps/exchange/Set-TransportAgent.md similarity index 78% rename from exchange/exchange-ps/exchange/mail-flow/Set-TransportAgent.md rename to exchange/exchange-ps/exchange/Set-TransportAgent.md index 817f8c7a61..65fa73a458 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Set-TransportAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-TransportAgent @@ -13,24 +16,28 @@ This cmdlet is available only in on-premises Exchange. Use the Set-TransportAgent cmdlet to modify existing transport agents. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-TransportAgent [-Identity] <TransportAgentObjectId> [-Confirm] [-DomainController <Fqdn>] - [-Priority <Int32>] [-WhatIf] - [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>] [<CommonParameters>] +Set-TransportAgent [-Identity] <TransportAgentObjectId> + [-Confirm] + [-DomainController <Fqdn>] + [-Priority <Int32>] + [-TransportService <TransportService>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-TransportAgent "Test App" -Priority 3 -TransportService -FrontEnd +### Example 1 +```powershell +Set-TransportAgent "Test App" -Priority 3 -TransportService FrontEnd ``` This example modifies the priority of a fictitious agent named Test App in the Front End Transport service. @@ -45,6 +52,7 @@ Type: TransportAgentObjectId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -55,8 +63,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -64,6 +71,7 @@ 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 @@ -81,6 +89,7 @@ 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 @@ -96,21 +105,7 @@ Type: Int32 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 -``` -### -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 @@ -122,20 +117,33 @@ Accept wildcard characters: False 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. - - MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - - MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - - FrontEnd for the Front End Transport service on Mailbox servers. - - Edge on Edge Transport servers. ```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery +Type: TransportService Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 @@ -144,20 +152,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/467ee0fb-b418-4b91-9115-2c96d97a1c55.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md similarity index 79% rename from exchange/exchange-ps/exchange/mail-flow/Set-TransportConfig.md rename to exchange/exchange-ps/exchange/Set-TransportConfig.md index 7f68f12564..57473281ff 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-TransportConfig @@ -13,40 +16,42 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-TransportConfig cmdlet to modify the transport configuration settings for the whole Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-TransportConfig [[-Identity] <OrganizationIdParameter>] - [-AddressBookPolicyRoutingEnabled <$true | $false>] - [-AgentGeneratedMessageLoopDetectionInSmtpEnabled <$true | $false>] - [-AgentGeneratedMessageLoopDetectionInSubmissionEnabled <$true | $false>] - [-ClearCategories <$true | $false>] + [-AddressBookPolicyRoutingEnabled <Boolean>] + [-AgentGeneratedMessageLoopDetectionInSmtpEnabled <Boolean>] + [-AgentGeneratedMessageLoopDetectionInSubmissionEnabled <Boolean>] + [-AllowLegacyTLSClients <System.Boolean>] + [-ClearCategories <Boolean>] [-Confirm] - [-ConvertDisclaimerWrapperToEml <$true | $false>] + [-ConvertDisclaimerWrapperToEml <Boolean>] [-DiagnosticsAggregationServicePort <Int32>] [-DomainController <Fqdn>] - [-DSNConversionMode <UseExchangeDSNs | PreserveDSNBody | DoNotConvert>] - [-ExternalDelayDsnEnabled <$true | $false>] + [-DSNConversionMode <DSNConversionOption>] + [-ExternalDelayDsnEnabled <Boolean>] [-ExternalDsnDefaultLanguage <CultureInfo>] - [-ExternalDsnLanguageDetectionEnabled <$true | $false>] + [-ExternalDsnLanguageDetectionEnabled <Boolean>] [-ExternalDsnMaxMessageAttachSize <ByteQuantifiedSize>] [-ExternalDsnReportingAuthority <SmtpDomain>] - [-ExternalDsnSendHtml <$true | $false>] + [-ExternalDsnSendHtml <Boolean>] [-ExternalPostmasterAddress <SmtpAddress>] [-Force] [-GenerateCopyOfDSNFor <MultiValuedProperty>] - [-HeaderPromotionModeSetting <NoCreate | MayCreate | MustCreate>] - [-InternalDelayDsnEnabled <$true | $false>] + [-HeaderPromotionModeSetting <HeaderPromotionMode>] + [-InternalDelayDsnEnabled <Boolean>] [-InternalDsnDefaultLanguage <CultureInfo>] - [-InternalDsnLanguageDetectionEnabled <$true | $false>] + [-InternalDsnLanguageDetectionEnabled <Boolean>] [-InternalDsnMaxMessageAttachSize <ByteQuantifiedSize>] [-InternalDsnReportingAuthority <SmtpDomain>] - [-InternalDsnSendHtml <$true | $false>] + [-InternalDsnSendHtml <Boolean>] [-InternalSMTPServers <MultiValuedProperty>] + [-JournalMessageExpirationDays <Int32>] [-JournalingReportNdrTo <SmtpAddress>] - [-LegacyJournalingMigrationEnabled <$true | $false>] + [-LegacyJournalingMigrationEnabled <Boolean>] [-MaxAllowedAgentGeneratedMessageDepth <UInt32>] [-MaxAllowedAgentGeneratedMessageDepthPerAgent <UInt32>] [-MaxDumpsterSizePerDatabase <ByteQuantifiedSize>] @@ -56,61 +61,69 @@ Set-TransportConfig [[-Identity] <OrganizationIdParameter>] [-MaxRetriesForLocalSiteShadow <Int32>] [-MaxRetriesForRemoteSiteShadow <Int32>] [-MaxSendSize <Unlimited>] - [-OrganizationFederatedMailbox <SmtpAddress>] + [-MessageExpiration <EnhancedTimeSpan>] + [-PreventDuplicateJournalingEnabled <Boolean>] [-QueueDiagnosticsAggregationInterval <EnhancedTimeSpan>] - [-RejectMessageOnShadowFailure <$true | $false>] - [-Rfc2231EncodingEnabled <$true | $false>] + [-RejectMessageOnShadowFailure <Boolean>] + [-ReplyAllStormBlockDurationHours <Int32>] + [-ReplyAllStormDetectionMinimumRecipients <Int32>] + [-ReplyAllStormDetectionMinimumReplies <Int32>] + [-ReplyAllStormProtectionEnabled <Boolean>] + [-Rfc2231EncodingEnabled <Boolean>] [-SafetyNetHoldTime <EnhancedTimeSpan>] [-ShadowHeartbeatFrequency <EnhancedTimeSpan>] [-ShadowHeartbeatRetryCount <Int32>] [-ShadowHeartbeatTimeoutInterval <EnhancedTimeSpan>] [-ShadowMessageAutoDiscardInterval <EnhancedTimeSpan>] - [-ShadowMessagePreferenceSetting <PreferRemote | LocalOnly | RemoteOnly>] - [-ShadowRedundancyEnabled <$true | $false>] + [-ShadowMessagePreferenceSetting <ShadowMessagePreference>] + [-ShadowRedundancyEnabled <Boolean>] [-ShadowResubmitTimeSpan <EnhancedTimeSpan>] - [-SmtpClientAuthenticationDisabled <$true | $false>] + [-SmtpClientAuthenticationDisabled <Boolean>] [-SupervisionTags <MultiValuedProperty>] [-TLSReceiveDomainSecureList <MultiValuedProperty>] [-TLSSendDomainSecureList <MultiValuedProperty>] [-TransportRuleAttachmentTextScanLimit <ByteQuantifiedSize>] - [-VerifySecureSubmitEnabled <$true | $false>] - [-VoicemailJournalingEnabled <$true | $false>] + [-VerifySecureSubmitEnabled <Boolean>] + [-VoicemailJournalingEnabled <Boolean>] [-WhatIf] - [-Xexch50Enabled <$true | $false>] + [-Xexch50Enabled <Boolean>] [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-TransportConfig -GenerateCopyOfDSNFor 5.7.1,5.7.2,5.7.3 ``` This example configures the Exchange organization to forward all DSN messages that have the DSN codes 5.7.1, 5.7.2, and 5.7.3 to the postmaster email account. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-TransportConfig -JournalingReportNdrTo journalingndr@contoso.com ``` This example configures the Exchange organization to redirect all journaling reports that can't be delivered to the journaling mailbox to the email account journalingndr@contoso.com. -To avoid journaling issues, we recommend that you set JournalingReportNdrTo to a dedicated mailbox without any transport rule or mailbox rule. Or, set JournalingReportNdrTo to an external address. In Exchange Online, you can configure this setting by using the Office 365 portal or Exchange Online PowerShell. In on-premises Exchange Server, you can configure this setting by using the Exchange Management Shell. For more information, see Transport and Mailbox rules in Exchange Online or in on-premises Exchange Server don't work as expected (https://go.microsoft.com/fwlink/p/?linkid=787472&clcid=0x409). +To avoid journaling issues, we recommend that you set JournalingReportNdrTo to an external address. Like the journaling mailbox, the alternate journaling mailbox can't be an Exchange Online mailbox. In Exchange Online, you can configure this setting by using the Microsoft 365 admin center or Exchange Online PowerShell. In on-premises Exchange Server, you can configure this setting by using the Exchange Management Shell. For more information, see [KB2829319](https://support.microsoft.com/help/2829319). ## PARAMETERS ### -Identity +This parameter is available only in on-premises Exchange. + 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -121,13 +134,14 @@ Accept wildcard characters: False ### -AddressBookPolicyRoutingEnabled The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients. -The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see Address book policies (https://technet.microsoft.com/library/hh529948.aspx). +The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -145,10 +159,11 @@ Valid input for this parameter is $true or $false. The default value is $false. When Exchange detects an agent-generated message loop, the loop is stopped. When this parameter is set to $true, the loop is logged in the message tracking log. When this parameter is set to $false, the message is rejected with an NDR when the loop generates the number of messages specified by the MaxAllowedAgentGeneratedMessageDepthPerAgent and MaxAllowedAgentGeneratedMessageDepth parameters. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -166,10 +181,29 @@ Valid input for this parameter is $true or $false. The default value is $false. When Exchange detects an agent-generated message loop, the loop is stopped. When this parameter is set to $false, the loop is logged in the message tracking log. When this parameter is set to $true, the message is rejected with an NDR when the loop generates the number of messages specified by the MaxAllowedAgentGeneratedMessageDepth and MaxAllowedAgentGeneratedMessageDepthPerAgent parameters. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLegacyTLSClients +This parameter is available only in the cloud-based service. + +{{ Fill AllowLegacyTLSClients Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -181,10 +215,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -195,8 +230,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -204,6 +238,7 @@ 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 Default value: None @@ -215,9 +250,7 @@ Accept wildcard characters: False 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: - Message is sent to an external user. - - The sender has signed the message. - - The message is processed by a Transport rule that adds a disclaimer. When a Transport rule that adds disclaimers to outbound messages encounters a message signed by the sender, the Transport rule can't add the disclaimer directly to the message. As a result, the disclaimer is sent to the intended recipient with the original message as an attachment. @@ -225,10 +258,11 @@ When a Transport rule that adds disclaimers to outbound messages encounters a me Valid input for this parameter is $true or $false. The default value is $false. If you set this parameter to $true, the original message is sent as an EML attachment. Otherwise, it is sent as a TNEF attachment. ```yaml -Type: $true | $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 Default value: None @@ -246,6 +280,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -265,6 +300,7 @@ 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 @@ -273,19 +309,20 @@ Accept wildcard characters: False ``` ### -DSNConversionMode -The DSNConversionMode parameter controls how Exchange handles delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) that are generated by earlier versions of Exchange or other messaging systems. Valid values are: +The DSNConversionMode parameter controls how Exchange handles delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) that are generated by earlier versions of Exchange or other email systems. Valid values are: - DoNotConvert: DSNs aren't modified. The DSN is delivered as a standard message. - -- PreserveDSNBody: DSNs are converted to the Exchange 2010 or later format, and the text in the body of the DSN message is retained. This is the default value. - +- PreserveDSNBody: DSNs are converted to the Exchange 2010 or later format, and the text in the body of the DSN message is retained. - UseExchangeDSNs: DSNs are converted to the Exchange 2010 or later format. However, any customized text or attachments that were associated with the original DSN are overwritten. +The default value in Exchange 2010 and Exchange 2013 is UseExchangeDSNs. Otherwise, the default value is PreserveDSNBody. + ```yaml -Type: UseExchangeDSNs | PreserveDSNBody | DoNotConvert +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 Default value: None @@ -297,10 +334,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -316,6 +354,7 @@ 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 Default value: None @@ -327,10 +366,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -346,13 +386,9 @@ The ExternalDsnMaxMessageAttachSize parameter specifies the maximum size of the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -364,6 +400,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -372,13 +409,14 @@ Accept wildcard characters: False ``` ### -ExternalDsnReportingAuthority -The ExternalDsnReportingAuthority parameter specifies what the server name should be in the machine-readable part of the external DSN message. The default value is the authoritative domain specified during installation. +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 Default value: None @@ -387,13 +425,17 @@ Accept wildcard characters: False ``` ### -ExternalDsnSendHtml -The ExternalDsnSendHtml parameter specifies whether external DSN messages should be sent by using HTML or whether messages should be sent in plain text. Valid input for this parameter is $true or $false.The default value is $true. +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. +- $false: External DSNs are plain text. ```yaml -Type: $true | $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 Default value: None @@ -402,13 +444,24 @@ Accept wildcard characters: False ``` ### -ExternalPostmasterAddress -The ExternalPostmasterAddress parameter specifies the email address in the From header field of an external DSN message. The default value is $null. In the Transport service on a Mailbox server, the value of the external postmaster email address is postmaster@\<defaultaccepteddomain\>. If an Edge Transport server hasn't yet been through the EdgeSync process, and the ExternalPostmasterAddress parameter is set to $null, the external postmaster email address on the Edge Transport server is postmaster@\<edgetransportserverfqdn\>. If an Edge Transport server has completed the EdgeSync process, and the ExternalPostmasterAddress parameter is set to $null, the external postmaster email address on the Edge Transport server is postmaster@\<defaultaccepteddomain\>. To override the default behavior, you can specify an email address for the ExternalPostMasterAddress parameter. +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@<DefaultAcceptedDomain>` in the following locations: + +- On Hub Transport servers or the Transport service on Mailbox servers. +- On Edge Transport servers that are subscribed to the Exchange organization. +- In Exchange Online. + +On Edge Transport servers that aren't subscribed to the Exchange organization, the default external postmaster email address is `postmaster@<EdgeTransportServerFQDN>`. + +To override the default behavior, you can specify an email address for the ExternalPostMasterAddress parameter. ```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 Default value: None @@ -417,13 +470,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -441,30 +497,26 @@ On a Mailbox server, NDRs are copied to the mailbox assigned to the Exchange rec DSN codes are entered as x.y.z and are separated by commas. By default, the following DSN codes are monitored: - 5.4.8 - - 5.4.6 - - 5.4.4 - - 5.2.4 - - 5.2.0 - - 5.1.4 -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although these DSN codes are monitored by default, the associated NDRs aren't copied to the Exchange recipient or to the external postmaster address if no mailbox is assigned to the Exchange recipient or to the external postmaster address. By default, no mailbox is assigned to the Exchange recipient or to the external postmaster address. -To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cmdlet with the MicrosoftExchangeRecipientReplyRecipient parameter. To assign a mailbox to the external postmaster address, create a new mailbox postmaster. The default email address policy of the Exchange organization should automatically add an SMTP address of postmaster@\<Authoritative domain\> to the mailbox. +To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cmdlet with the MicrosoftExchangeRecipientReplyRecipient parameter. To assign a mailbox to the external postmaster address, create a new mailbox postmaster. The default email address policy of the Exchange organization should automatically add an SMTP address of `postmaster@<AuthoritativeDomain>` to the mailbox. ```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 @@ -473,19 +525,18 @@ Accept wildcard characters: False ``` ### -HeaderPromotionModeSetting -The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received from outside the Exchange organization. You can use one of the following values: +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. +- NoCreate: Exchange won't create any named properties based on custom X-headers on incoming messages. This is the default value. ```yaml -Type: NoCreate | MayCreate | MustCreate +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 Default value: None @@ -497,10 +548,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -516,6 +568,7 @@ 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 Default value: None @@ -527,10 +580,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -546,15 +600,10 @@ The InternalDsnMaxMessageAttachSize parameter specifies the maximum size of the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. 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. @@ -564,6 +613,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -572,13 +622,14 @@ Accept wildcard characters: False ``` ### -InternalDsnReportingAuthority -The InternalDsnReportingAuthority parameter specifies what the server name should be in the internal DSN message. The default value is the authoritative domain specified during installation. +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 Default value: None @@ -587,13 +638,17 @@ Accept wildcard characters: False ``` ### -InternalDsnSendHtml -The InternalDsnSendHtml parameter specifies whether internal DSN messages should be sent by using HTML or whether messages should be sent in plain text. Valid input for this parameter is $true or $false. The default is $true. +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. +- $false: Internal DSNs are plain text. ```yaml -Type: $true | $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 Default value: None @@ -606,15 +661,34 @@ 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. -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange 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 +``` + +### -JournalMessageExpirationDays +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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -623,13 +697,14 @@ Accept wildcard characters: False ``` ### -JournalingReportNdrTo -The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox. We recommended that you use a dedicated (non-user) mailbox as the argument to JournalingReportNdrTo. +The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox. We recommended that you use a dedicated (non-user) mailbox as the value for this parameter. 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 Default value: None @@ -638,17 +713,18 @@ Accept wildcard characters: False ``` ### -LegacyJournalingMigrationEnabled -This parameter is available or functional only in 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 default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -666,6 +742,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -685,6 +762,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -695,20 +773,16 @@ Accept wildcard characters: False ### -MaxDumpsterSizePerDatabase This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxDumpsterSizePerDatabase parameter specifies the maximum size of the transport dumpster on a Hub Transport server for each database. The default value is 18 MB. The valid input range for this parameter is from 0 through 2147483647 KB. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -722,6 +796,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -732,7 +807,7 @@ Accept wildcard characters: False ### -MaxDumpsterTime This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxDumpsterTime parameter specifies how long an email message should remain in the transport dumpster on a Hub Transport server. The default value is seven days. @@ -749,6 +824,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -764,24 +840,24 @@ The MaxReceiveSize parameter specifies the maximum message size that can be rece When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. -The valid input range for this parameter is from 0 through 2097151 KB. If you enter a value of Unlimited, no limit is imposed on the message size that can be received by recipients in the organization. +A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. + +The value unlimited indicates the maximum size is imposed elsewhere (for example, server, connector, or individual recipient limits). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -790,15 +866,18 @@ Accept wildcard characters: False ``` ### -MaxRecipientEnvelopeLimit -This parameter is available only in on-premises Exchange. +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. -The MaxRecipientEnvelopeLimit parameter specifies the maximum number of recipients in a message. The default value is 5000. 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. Exchange treats an unexpanded distribution group as one recipient. +In Exchange Online, the default value is Unlimited, which means the organizational limit of 1000 is used. You can enter a custom value up to 1000. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1) in the Microsoft 365 service description. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -812,9 +891,7 @@ 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: - If ShadowMessagePreferenceSetting is set to LocalOnly, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow parameter. - - If ShadowMessagePreferenceSetting is set to PreferRemote, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow and MaxRetriesForRemoteSiteShadow parameters added together. - - If ShadowMessagePreferenceSetting is set to RemoteOnly, the value of MaxRetriesForLocalSiteShadow is 0, and the MaxRetriesForLocalSiteShadow parameter has no effect on the total number of attempts to create a shadow copy of the message. If a shadow copy of the message isn't created after the specified number of attempts, accepting or rejecting the message is controlled by the RejectMessageOnShadowFailure parameter. @@ -824,6 +901,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -837,9 +915,7 @@ 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: - If ShadowMessagePreferenceSetting is set to RemoteOnly, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForRemoteSiteShadow parameter. - - If ShadowMessagePreferenceSetting is set to PreferRemote, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow and MaxRetriesForRemoteSiteShadow parameters added together. - - If ShadowMessagePreferenceSetting is set to LocalOnly, the value of MaxRetriesForRemoteSiteShadow is 0, and the MaxRetriesForRemoteSiteShadow parameter has no effect on the total number of attempts to create a shadow copy of the message. If a shadow copy of the message isn't created after the specified number of attempts, accepting or rejecting the message is controlled by the RejectMessageOnShadowFailure parameter. @@ -849,6 +925,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -864,24 +941,24 @@ The MaxSendSize parameter specifies the maximum message size that can be sent by When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. -The valid input range for this parameter is from 0 through 2097151 KB. If you enter a value of Unlimited, no limit is imposed on the message size that can be sent by senders in the organization. +A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. + +The value unlimited indicates the maximum size is imposed elsewhere (for example, server, connector, or individual sender limits). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -889,16 +966,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrganizationFederatedMailbox -This parameter is available or functional only in Exchange Server 2010. +### -MessageExpiration +This parameter is available only in the cloud-based service. -The OrganizationFederatedMailbox parameter specifies the SMTP address of the federated mailbox used for federated delivery with other organizations. +The MessageExpiration parameter specifies the message expiration timeout interval for the organization. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +The default value is 1.00:00:00 or 1 day. + +A valid value is from 12 hours (0.12:00:00) to 24 hours (1.00:00:00). + +Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If you change this value, the NDR will be sent at the new applicable time. ```yaml -Type: SmtpAddress +Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventDuplicateJournalingEnabled +This parameter is available only in the cloud-based service. + +The PreventDuplicateJournalingEnabled parameter prevents duplicate journaling reports that can occur when messages are processed by both on-premises and cloud journaling agents. Valid values are: + +- $true: Ensure that journaling messages aren't duplicated in hybrid environments. +- $false: Journaling messages might be duplicated in hybrid environments. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -918,6 +1025,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -931,16 +1039,88 @@ 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. 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormBlockDurationHours +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormBlockDurationHours Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormDetectionMinimumRecipients +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormDetectionMinimumRecipients Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormDetectionMinimumReplies +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormDetectionMinimumReplies Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormProtectionEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormProtectionEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -952,10 +1132,11 @@ Accept wildcard characters: False 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: $true | $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 Default value: None @@ -977,6 +1158,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -998,6 +1180,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1008,7 +1191,7 @@ Accept wildcard characters: False ### -ShadowHeartbeatRetryCount This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The ShadowHeartbeatRetryCount parameter specifies the number of time-outs a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable. Valid input for this parameter is an integer between 1 and 15. The default value is 12. @@ -1019,6 +1202,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1029,7 +1213,7 @@ Accept wildcard characters: False ### -ShadowHeartbeatTimeoutInterval This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The ShadowHeartbeatTimeoutInterval parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages. @@ -1044,6 +1228,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1065,6 +1250,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1078,18 +1264,17 @@ 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: - LocalOnly: A shadow copy of the message should only be made on a server in the local Active Directory site. - - RemoteOnly: A shadow copy of the message should only be made on a server in a different Active Directory site. - - PreferRemote: Try to make a shadow copy of the message in a different Active Directory site. If the operation fails, try make a shadow copy of the message on a server in the local Active Directory site. The default value is PreferRemote. ```yaml -Type: PreferRemote | LocalOnly | RemoteOnly +Type: ShadowMessagePreference Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1103,10 +1288,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1130,6 +1316,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1143,28 +1330,25 @@ 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: - POP3 and IMAP4 clients. - - Devices with scan to email capability. - - Workflow applications that send email notifications. - - Online services that send messages using internal email addresses in the organization. Valid values for this parameter are: -- $true: Authenticated SMTP is disabled. - -- $false: Authenticated SMTP is enabled. This is the default value. +- $true: Authenticated SMTP is disabled. This is the default value 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. 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). ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Exchange Online Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -1184,6 +1368,7 @@ 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 @@ -1197,14 +1382,12 @@ 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: - Enable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified with the TLSReceiveDomainSecureList parameter. - - Specify the domains to which you want to send domain secured email by using the TLSSendDomainSecureList parameter. - - Enable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The wildcard character (\*) isn't supported in the domains listed in the TLSReceiveDomainSecureList parameter or in the TLSSendDomainSecureList parameter. The default value for both parameters is an empty list ({}). @@ -1213,6 +1396,7 @@ 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 @@ -1226,14 +1410,12 @@ 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: - Enable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList parameter. - - Specify the domains from which you want to receive domain secured email by using the TLSReceiveDomainSecureList parameter. - - Enable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified in the TLSReceiveDomainSecureList 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +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 ({}). @@ -1242,6 +1424,7 @@ 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 @@ -1252,22 +1435,19 @@ Accept wildcard characters: False ### -TransportRuleAttachmentTextScanLimit This parameter is available only in on-premises Exchange. -The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. The default value is 150 kilobytes (KB). +The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +In Exchange Online, Exchange 2019, and Exchange 2016, the default value is 1 MB (1,048,576 bytes). In Exchange 2013, the default value is 150 KB (153,600 bytes). + If the amount of text in the attachment is larger than the value of this parameter, only the specified amount of text is scanned. For example, if a 5 megabyte attachment contains 300 kilobytes of text, and the value of TransportRuleAttachmentTextScanLimit is 150 kilobytes, only the first 150 kilobytes of text are extracted and scanned. ```yaml @@ -1275,6 +1455,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1292,10 +1473,11 @@ If the VerifySecureSubmitEnabled parameter is set to $true, and Outlook 2010 or If the VerifySecureSubmitEnabled parameter is set to $false, all MAPI message submissions are marked as secure. Messages submitted from mailboxes on the Mailbox server by using any MAPI client aren't checked for encrypted MAPI submission. If you use previous Outlook versions in your Exchange organization, you should set the VerifySecureSubmitEnabled parameter to $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1304,15 +1486,16 @@ Accept wildcard characters: False ``` ### -VoicemailJournalingEnabled -This parameter is available only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voice mail messages are journaled by the Journaling agent. Valid input for this parameter is $true or $false. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -1328,6 +1511,7 @@ 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 Default value: None @@ -1341,10 +1525,11 @@ 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1353,20 +1538,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/ad3910a5-2227-47a2-8ccc-a208ce6210bb.aspx) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md new file mode 100644 index 0000000000..d5e0d7dd39 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -0,0 +1,4982 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. + +**Note**: + +- The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. + +- Rules that use Active Directory or Microsoft Entra ID properties as conditions or exceptions work only on senders or recipients in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TransportRule [-Identity] <RuleIdParameter> + [-ActivationDate <DateTime>] + [-ADComparisonAttribute <ADAttribute>] + [-ADComparisonOperator <Evaluation>] + [-AddManagerAsRecipientType <AddedRecipientType>] + [-AddToRecipients <RecipientIdParameter[]>] + [-AnyOfCcHeader <RecipientIdParameter[]>] + [-AnyOfCcHeaderMemberOf <RecipientIdParameter[]>] + [-AnyOfRecipientAddressContainsWords <Word[]>] + [-AnyOfRecipientAddressMatchesPatterns <Pattern[]>] + [-AnyOfToCcHeader <RecipientIdParameter[]>] + [-AnyOfToCcHeaderMemberOf <RecipientIdParameter[]>] + [-AnyOfToHeader <RecipientIdParameter[]>] + [-AnyOfToHeaderMemberOf <RecipientIdParameter[]>] + [-ApplyClassification <String>] + [-ApplyHtmlDisclaimerFallbackAction <DisclaimerFallbackAction>] + [-ApplyHtmlDisclaimerLocation <DisclaimerLocation>] + [-ApplyHtmlDisclaimerText <DisclaimerText>] + [-ApplyOME <Boolean>] + [-ApplyRightsProtectionCustomizationTemplate <OMEConfigurationIdParameter>] + [-ApplyRightsProtectionTemplate <RmsTemplateIdParameter>] + [-AttachmentContainsWords <Word[]>] + [-AttachmentExtensionMatchesWords <Word[]>] + [-AttachmentHasExecutableContent <Boolean>] + [-AttachmentIsPasswordProtected <Boolean>] + [-AttachmentIsUnsupported <Boolean>] + [-AttachmentMatchesPatterns <Pattern[]>] + [-AttachmentNameMatchesPatterns <Pattern[]>] + [-AttachmentProcessingLimitExceeded <Boolean>] + [-AttachmentPropertyContainsWords <Word[]>] + [-AttachmentSizeOver <ByteQuantifiedSize>] + [-BetweenMemberOf1 <RecipientIdParameter[]>] + [-BetweenMemberOf2 <RecipientIdParameter[]>] + [-BlindCopyTo <RecipientIdParameter[]>] + [-Comments <String>] + [-Confirm] + [-ContentCharacterSetContainsWords <Word[]>] + [-CopyTo <RecipientIdParameter[]>] + [-DeleteMessage <Boolean>] + [-Disconnect <Boolean>] + [-DlpPolicy <String>] + [-DomainController <Fqdn>] + [-ExceptIfADComparisonAttribute <ADAttribute>] + [-ExceptIfADComparisonOperator <Evaluation>] + [-ExceptIfAnyOfCcHeader <RecipientIdParameter[]>] + [-ExceptIfAnyOfCcHeaderMemberOf <RecipientIdParameter[]>] + [-ExceptIfAnyOfRecipientAddressContainsWords <Word[]>] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns <Pattern[]>] + [-ExceptIfAnyOfToCcHeader <RecipientIdParameter[]>] + [-ExceptIfAnyOfToCcHeaderMemberOf <RecipientIdParameter[]>] + [-ExceptIfAnyOfToHeader <RecipientIdParameter[]>] + [-ExceptIfAnyOfToHeaderMemberOf <RecipientIdParameter[]>] + [-ExceptIfAttachmentContainsWords <Word[]>] + [-ExceptIfAttachmentExtensionMatchesWords <Word[]>] + [-ExceptIfAttachmentHasExecutableContent <Boolean>] + [-ExceptIfAttachmentIsPasswordProtected <Boolean>] + [-ExceptIfAttachmentIsUnsupported <Boolean>] + [-ExceptIfAttachmentMatchesPatterns <Pattern[]>] + [-ExceptIfAttachmentNameMatchesPatterns <Pattern[]>] + [-ExceptIfAttachmentProcessingLimitExceeded <Boolean>] + [-ExceptIfAttachmentPropertyContainsWords <Word[]>] + [-ExceptIfAttachmentSizeOver <ByteQuantifiedSize>] + [-ExceptIfBetweenMemberOf1 <RecipientIdParameter[]>] + [-ExceptIfBetweenMemberOf2 <RecipientIdParameter[]>] + [-ExceptIfContentCharacterSetContainsWords <Word[]>] + [-ExceptIfFrom <RecipientIdParameter[]>] + [-ExceptIfFromAddressContainsWords <Word[]>] + [-ExceptIfFromAddressMatchesPatterns <Pattern[]>] + [-ExceptIfFromMemberOf <RecipientIdParameter[]>] + [-ExceptIfFromScope <FromUserScope>] + [-ExceptIfHasClassification <String>] + [-ExceptIfHasNoClassification <Boolean>] + [-ExceptIfHasSenderOverride <Boolean>] + [-ExceptIfHeaderContainsMessageHeader <HeaderName>] + [-ExceptIfHeaderContainsWords <Word[]>] + [-ExceptIfHeaderMatchesMessageHeader <HeaderName>] + [-ExceptIfHeaderMatchesPatterns <Pattern[]>] + [-ExceptIfManagerAddresses <RecipientIdParameter[]>] + [-ExceptIfManagerForEvaluatedUser <EvaluatedUser>] + [-ExceptIfMessageContainsDataClassifications <Hashtable[]>] + [-ExceptIfMessageSizeOver <ByteQuantifiedSize>] + [-ExceptIfMessageTypeMatches <MessageType>] + [-ExceptIfRecipientADAttributeContainsWords <Word[]>] + [-ExceptIfRecipientADAttributeMatchesPatterns <Pattern[]>] + [-ExceptIfRecipientAddressContainsWords <Word[]>] + [-ExceptIfRecipientAddressMatchesPatterns <Pattern[]>] + [-ExceptIfRecipientDomainIs <Word[]>] + [-ExceptIfRecipientInSenderList <Word[]>] + [-ExceptIfSCLOver <SclValue>] + [-ExceptIfSenderADAttributeContainsWords <Word[]>] + [-ExceptIfSenderADAttributeMatchesPatterns <Pattern[]>] + [-ExceptIfSenderDomainIs <Word[]>] + [-ExceptIfSenderInRecipientList <Word[]>] + [-ExceptIfSenderIpRanges <MultiValuedProperty>] + [-ExceptIfSenderManagementRelationship <ManagementRelationship>] + [-ExceptIfSentTo <RecipientIdParameter[]>] + [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] + [-ExceptIfSentToScope <ToUserScope>] + [-ExceptIfSubjectContainsWords <Word[]>] + [-ExceptIfSubjectMatchesPatterns <Pattern[]>] + [-ExceptIfSubjectOrBodyContainsWords <Word[]>] + [-ExceptIfSubjectOrBodyMatchesPatterns <Pattern[]>] + [-ExceptIfWithImportance <Importance>] + [-ExpiryDate <DateTime>] + [-From <RecipientIdParameter[]>] + [-FromAddressContainsWords <Word[]>] + [-FromAddressMatchesPatterns <Pattern[]>] + [-FromMemberOf <RecipientIdParameter[]>] + [-FromScope <FromUserScope>] + [-GenerateIncidentReport <RecipientIdParameter>] + [-GenerateNotification <DisclaimerText>] + [-HasClassification <String>] + [-HasNoClassification <Boolean>] + [-HasSenderOverride <Boolean>] + [-HeaderContainsMessageHeader <HeaderName>] + [-HeaderContainsWords <Word[]>] + [-HeaderMatchesMessageHeader <HeaderName>] + [-HeaderMatchesPatterns <Pattern[]>] + [-IncidentReportContent <IncidentReportContent[]>] + [-IncidentReportOriginalMail <IncidentReportOriginalMail>] + [-LogEventText <EventLogText>] + [-ManagerAddresses <RecipientIdParameter[]>] + [-ManagerForEvaluatedUser <EvaluatedUser>] + [-MessageContainsDataClassifications <Hashtable[]>] + [-MessageSizeOver <ByteQuantifiedSize>] + [-MessageTypeMatches <MessageType>] + [-Mode <RuleMode>] + [-ModerateMessageByManager <Boolean>] + [-ModerateMessageByUser <RecipientIdParameter[]>] + [-Name <String>] + [-NotifySender <NotifySenderType>] + [-PrependSubject <SubjectPrefix>] + [-Priority <Int32>] + [-Quarantine <Boolean>] + [-RecipientADAttributeContainsWords <Word[]>] + [-RecipientADAttributeMatchesPatterns <Pattern[]>] + [-RecipientAddressContainsWords <Word[]>] + [-RecipientAddressMatchesPatterns <Pattern[]>] + [-RecipientAddressType <RecipientAddressType>] + [-RecipientDomainIs <Word[]>] + [-RecipientInSenderList <Word[]>] + [-RedirectMessageTo <RecipientIdParameter[]>] + [-RejectMessageEnhancedStatusCode <RejectEnhancedStatus>] + [-RejectMessageReasonText <RejectText>] + [-RemoveHeader <HeaderName>] + [-RemoveOME <Boolean>] + [-RemoveOMEv2 <Boolean>] + [-RemoveRMSAttachmentEncryption <Boolean>] + [-RouteMessageOutboundConnector <OutboundConnectorIdParameter>] + [-RouteMessageOutboundRequireTls <Boolean>] + [-RuleErrorAction <RuleErrorAction>] + [-RuleSubType <RuleSubType>] + [-SCLOver <SclValue>] + [-SenderADAttributeContainsWords <Word[]>] + [-SenderADAttributeMatchesPatterns <Pattern[]>] + [-SenderAddressLocation <SenderAddressLocation>] + [-SenderDomainIs <Word[]>] + [-SenderInRecipientList <Word[]>] + [-SenderIpRanges <MultiValuedProperty>] + [-SenderManagementRelationship <ManagementRelationship>] + [-SentTo <RecipientIdParameter[]>] + [-SentToMemberOf <RecipientIdParameter[]>] + [-SentToScope <ToUserScope>] + [-SetAuditSeverity <String>] + [-SetHeaderName <HeaderName>] + [-SetHeaderValue <HeaderValue>] + [-SetSCL <SclValue>] + [-SmtpRejectMessageRejectStatusCode <RejectStatusCode>] + [-SmtpRejectMessageRejectText <RejectText>] + [-StopRuleProcessing <Boolean>] + [-SubjectContainsWords <Word[]>] + [-SubjectMatchesPatterns <Pattern[]>] + [-SubjectOrBodyContainsWords <Word[]>] + [-SubjectOrBodyMatchesPatterns <Pattern[]>] + [-WhatIf] + [-WithImportance <Importance>] + [<CommonParameters>] +``` + +## 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. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-TransportRule "Sales Team Disclaimer" -FromMemberOf "Sales Department" +``` + +This example modifies the existing rule named Sales Team Disclaimer transport rule by adding the condition that the sender of the message is a member of the Sales Department group. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActivationDate +The ActivationDate parameter specifies when the rule starts processing messages. The rule won't take any action on messages until the specified date/time. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ADComparisonAttribute +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ADComparisonAttribute parameter specifies a condition that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +If you don't use the ADComparisonOperator parameter, the default comparison operator Equal is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ADComparisonOperator +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is 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) +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddManagerAsRecipientType +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The AddManagerAsRecipientType parameter specifies an action that delivers or redirects messages to the user that's defined in the sender's Manager attribute. Valid values are: + +- To: Add the sender's manager to the To field of the message. +- Cc: Add the sender's manager to the Cco field of the message. +- Bcc: Add the sender's manager to the Bcc field of the message. +- Redirect: Redirect the message to the sender's manager without notifying the sender or the recipients. + +This action only works if the sender's Manager attribute is defined. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddToRecipients +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. + +The AddToRecipients parameter specifies an action that adds recipients to the To field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfCcHeader +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfCcHeader parameter specifies a condition that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfCcHeaderMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +This parameter specifies a condition or 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. + +The AnyOfRecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +This parameter specifies a condition or 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. + +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToCcHeader +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToCcHeader parameter specifies a condition that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToCcHeaderMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToHeader +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToHeader parameter specifies a condition that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfToHeaderMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyClassification +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyClassification parameter specifies an action that applies a message classification to messages. Use the Get-MessageClassification cmdlet to see the message classification objects that are available. + +The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the data loss prevention (DLP) data classification. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimerFallbackAction +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: + +- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. + + If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. + + If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. + + In Microsoft 365, don't use this value in rules that affect incoming messages from external senders. Use the value Reject instead. The effects of the value Wrap interfere with Safe Attachments scanning of messages from external senders. + +- Ignore: The rule is ignored and the original message is delivered without the disclaimer. +- Reject: The original message is returned to the sender in an NDR. + +If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimerLocation +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is 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. +- 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyHtmlDisclaimerText +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. + +This parameter also supports the following tokens that use values from the sender: + +- %%City%% +- %%Company%% +- %%CountryOrRegion%% +- %%Department%% +- %%DisplayName%% +- %%Fax%% +- %%FirstName%% +- %%HomePhone%% +- %%Initials%% +- %%LastName%% +- %%Manager%% +- %%MobilePhone%% +- %%Notes%% +- %%Office%% +- %%Pager%% +- %%Phone%% +- %%PostalCode%% +- %%PostOfficeBox%% +- %%StateOrProvince%% +- %%StreetAddress%% +- %%Title%% +- %%UserPrincipalName%% +- %%WindowsEmailAddress%% + +The maximum number of characters is 5000. + +You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyOME +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The ApplyOME parameter specifies an action that encrypts messages and their attachments by using Office 365 Message Encryption. Valid values are: + +- $true: The message and attachments are encrypted. +- $false: The message and attachments aren't encrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyRightsProtectionCustomizationTemplate +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The ApplyRightsProtectionCustomizationTemplate parameter specifies an action that applies a custom branding template for OME encrypted messages. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: OMEConfigurationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyRightsProtectionTemplate +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyRightsProtectionTemplate parameter specifies an action that applies rights management service (RMS) templates to messages. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). + +To use this action, you need to have an Active Directory Rights Management Services (AD RMS) server in your organization, or your organization needs to use the ILS service. + +Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. + +For more information, see [Transport protection rules](https://learn.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). + +```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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentContainsWords parameter specifies a condition 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentExtensionMatchesWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentExtensionMatchesWords parameter specifies a condition that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. + +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentHasExecutableContent +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentHasExecutableContent parameter specifies a condition that inspects messages where an attachment is an executable file. Valid values are: + +- $true: Look for executable content in message attachments. +- $false: Don't look for executable content in message attachments. + +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsPasswordProtected +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: + +- $true: Look for password protected attachments. +- $false: Don't look for password protected attachments. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsUnsupported +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Valid values are: + +- $true: Look for unsupported file types in messages. +- $false: Don't look for unsupported file types in messages. + +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). + +```yaml +Type: Boolean +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +Only the first 150 kilobytes (KB) of the attachment is scanned when trying to match a text pattern. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentNameMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentProcessingLimitExceeded +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The AttachmentProcessingLimitExceeded parameter specifies a condition that looks for messages where attachment scanning didn't complete. Valid values are: + +- $true: Look for messages where attachment scanning didn't complete. +- $false: Don't look for messages where attachment scanning didn't complete. + +You use this condition to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentPropertyContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is 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: + +- Business Impact +- Compliancy +- Confidentiality +- Department +- Impact +- Intellectual Property +- Personally Identifiable Information +- Personal Information +- Personal Use +- Required Clearance +- PHI +- PII +- Project +- Protected Health Information + +The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use leading or trailing spaces. + +When you specify multiple properties, or multiple values for the same property, the or operator is used. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentSizeOver +This parameter specifies a condition or 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. + +The AttachmentSizeOver parameter specifies a condition that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BetweenMemberOf1 +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The BetweenMemberOf1 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BetweenMemberOf2 +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The BetweenMemberOf2 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlindCopyTo +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. + +The BlindCopyTo parameter specifies an action that adds recipients to the Bcc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentCharacterSetContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ContentCharacterSetContainsWords parameter specifies a condition that looks for character set names in 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyTo +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. + +The CopyTo parameter specifies an action that adds recipients to the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteMessage +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. + +The DeleteMessage parameter specifies an action that silently drops messages without an NDR. Valid values are: + +- $true: Silently drop the message without an NDR. +- $false: Don't silently drop the message. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disconnect +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. + +The Disconnect parameter specifies an action that ends the SMTP connection between the sending server and the Edge Transport server without generating an NDR. + +- $true: Silently end the SMTP session without generating an NDR. +- $false: Don't silently end the SMTP session. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPolicy +**Note**: This parameter is functional only in on-premises Exchange. + +The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: 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 +``` + +### -ExceptIfADComparisonAttribute +This parameter specifies an exception or part of an 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 ExceptIfADComparisonAttribute parameter specifies an exception that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +If you don't use the ExceptIfADComparisonOperator parameter, the default comparison operator Equal is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfADComparisonOperator +This parameter specifies an exception or part of an 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) +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfCcHeader +This parameter specifies an exception or part of an 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 ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfCcHeaderMemberOf +This parameter specifies an exception or part of an 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 ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToCcHeader +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToCcHeaderMemberOf +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToHeader +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfToHeaderMemberOf +This parameter specifies an exception or part of an 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 ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. + +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentContainsWords +This parameter specifies an exception or part of an 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 ExceptIfAttachmentContainsWords parameter specifies an exception 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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentExtensionMatchesWords +This parameter specifies an exception or part of an 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 ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. + +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentHasExecutableContent +This parameter specifies an exception or part of an 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 ExceptIfAttachmentHasExecutableContent parameter specifies an exception that inspects messages where an attachment is an executable file. Valid values are: + +- $true: Look for executable content in message attachments. +- $false: Don't look for executable content in message attachments. + +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentIsPasswordProtected +This parameter specifies an exception or part of an 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 ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: + +- $true: Look for password protected attachments. +- $false: Don't look for password protected attachments. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentIsUnsupported +This parameter specifies an exception or part of an 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 ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Valid values are: + +- $true: Look for unsupported file types in messages. +- $false: Don't look for unsupported file types in messages. + +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the ExceptIfAttachmentIsUnsupported exception is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). + +```yaml +Type: Boolean +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +Only the first 150 KB of the attachment is scanned when trying to match a text pattern. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentNameMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentProcessingLimitExceeded +This parameter specifies an exception or part of an 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 ExceptIfAttachmentProcessingLimitExceeded parameter specifies an exception that looks for messages where attachment scanning didn't complete. Valid values are: + +- $true: Look for messages where attachment scanning didn't complete. +- $false: Don't look for messages where attachment scanning didn't complete. + +You use this exception to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentPropertyContainsWords +This parameter specifies an exception or part of an 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: + +- Business Impact +- Compliancy +- Confidentiality +- Department +- Impact +- Intellectual Property +- Personally Identifiable Information +- Personal Information +- Personal Use +- Required Clearance +- PHI +- PII +- Project +- Protected Health Information + +The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use values with leading or trailing spaces. + +When you specify multiple properties, or multiple values for the same property, the or operator is used. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAttachmentSizeOver +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfAttachmentSizeOver parameter specifies an exception that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfBetweenMemberOf1 +This parameter specifies an exception or part of an 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 ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfBetweenMemberOf2 +This parameter specifies an exception or part of an 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 ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentCharacterSetContainsWords +This parameter specifies an exception or part of an 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 ExceptIfContentCharacterSetContainsWords parameter specifies an exception that looks for character set names in 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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +This parameter specifies an exception or part of an 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 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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfFromAddressContainsWords parameter specifies an exception that looks for words in the sender's email address. You can specify multiple words separated by commas. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception 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"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + +```yaml +Type: Pattern[] +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromMemberOf +This parameter specifies an exception or part of an 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 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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromScope +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasClassification +This parameter specifies an exception or part of an 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 ExceptIfHasClassification parameter specifies an exception that looks for messages with the specified message classification. + +You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: + +`-ExceptIfHasClassification @(Get-MessageClassification "Company Internal").Identity` + +The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP data classification. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasNoClassification +This parameter specifies an exception or part of an 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 ExceptIfHasNoClassification parameter specifies an exception that looks for messages with or without any message classifications. Valid values are: + +- $true: Look for messages that don't have a message classification. +- $false: Look for messages that have one or more message classifications. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasSenderOverride +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available only on Mailbox servers. + +The ExceptIfHasSenderOverride parameter specifies an exception that looks for messages where the sender chose to override a DLP policy. Valid values are: + +- $true: Look for messages where the sender took action to override a DLP policy. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderContainsMessageHeader +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the ExceptIfHeaderContainsWords parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderContainsWords parameter specifies an exception 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. + +You specify the header field to search by using the ExceptIfHeaderContainsMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesMessageHeader +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the ExceptIfHeaderMatchesPatterns parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfHeaderMatchesPatterns parameter specifies an exception 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 specify the header field to search by using the ExceptIfHeaderMatchesMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfManagerAddresses +This parameter specifies an exception or part of an 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 ExceptIfManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You specify if you want to look for these users as managers of senders or recipients by using the ExceptIfManagerForEvaluatedUser parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfManagerForEvaluatedUser +This parameter specifies an exception or part of an 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 ExceptIfManagerForEvaluatedUser parameter specifies an exception that looks for users in the Manager attribute of senders or recipients. Valid values are: + +- Recipient: The user is the manager of a recipient. +- Sender: The user is the manager of the sender. + +You specify the users to look for by using the ExceptIfManagerAddresses parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageContainsDataClassifications +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available only on Mailbox servers. + +The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. + +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. + +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). + +```yaml +Type: Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageSizeOver +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfMessageSizeOver parameter specifies an exception that looks for messages larger than the specified size. The size includes the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageTypeMatches +This parameter specifies an exception or part of an 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 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. +- 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). +- Voicemail: Voice mail messages forwarded by Unified Messaging service. +- Signed: Digitally signed messages. +- ApprovalRequest: Moderation request messages sent to moderators. +- ReadReceipt: Read receipts. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeContainsWords +This parameter specifies an exception or part of an 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 ExceptIfRecipientADAttributeContainsWords parameter specifies an exception that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientAddressContainsWords +This parameter specifies an exception or part of an 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 ExceptIfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientAddressMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +This parameter specifies an exception or part of an 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 ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientInSenderList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSCLOver +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: + +- -1: The message is from a trusted sender, so the message bypasses spam filtering. +- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. + +The rule looks for messages with an SCL value that's greater than or equal to the specified value. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeContainsWords +This parameter specifies an exception or part of an 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 ExceptIfSenderADAttributeContainsWords parameter specifies an exception that looks for words in Active Directory attributes of message senders. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeMatchesPatterns +This parameter specifies an exception or part of an 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 ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in Active Directory attributes of message senders by using regular expressions. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +This parameter specifies an exception or part of an 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 ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. + +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderInRecipientList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderIpRanges +This parameter specifies an exception or part of an 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 ExceptIfSenderIpRanges parameter specifies an exception that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderManagementRelationship +This parameter specifies an exception or part of an 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 ExceptIfSenderManagementRelationship parameter specifies an exception that looks for the relationship between the sender and recipients in messages. Valid values are: + +- Manager: The sender is the manager of a recipient. +- DirectReport: A recipient is the manager of the sender. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +This parameter specifies an exception or part of an 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 ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +This parameter 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: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToScope +This parameter specifies an exception or part of an 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 ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. + +```yaml +Type: ToUserScope +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectContainsWords parameter specifies an exception that looks for words in the Subject field of messages. + +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. + +```yaml +Type: Word[] +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectMatchesPatterns parameter specifies an exception 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception that looks for words in the Subject field or body of messages. + +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. + +```yaml +Type: Word[] +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyMatchesPatterns +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. + +The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfWithImportance +This parameter specifies an exception or part of an 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 ExceptIfWithImportance parameter specifies an exception that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDate +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +This parameter specifies a condition or 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. + +The FromAddressContainsWords parameter specifies a condition that looks for words in the sender's email address. You can specify multiple words separated by commas. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +This parameter specifies a condition or 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. + +The FromAddressMatchesPatterns parameter specifies a condition 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"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + +```yaml +Type: Pattern[] +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromScope +This parameter specifies a condition or 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. + +The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateIncidentReport +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The GenerateIncidentReport parameter specifies where to send the incident report that's defined by the IncidentReportContent parameter. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +**Note**: An incident report isn't generated for notifications or other incident reports that are generated by DLP or mail flow rules. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateNotification +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The GenerateNotification parameter specifies an action that sends a notification message to recipients that match the conditions of the rule. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. Each matched recipient receives a separate notification. + +This parameter supports plain text, HTML tags and the following keywords that use values from the original message: + +- %%From%% +- %%To%% +- %%Cc%% +- %%Subject%% +- %%Headers%% +- %%MessageDate%% + +The maximum number of characters is 5120. + +```yaml +Type: DisclaimerText +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasClassification +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The HasClassification parameter specifies a condition that looks for messages with the specified message classification. + +You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: + +`-HasClassification @(Get-MessageClassification "Company Internal").Identity` + +The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP classification. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasNoClassification +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The HasNoClassification parameter specifies a condition that looks for messages with or without any message classifications. Valid values are: + +- $true: Look for messages that don't have a message classification. +- $false: Look for messages that have one or more message classifications. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSenderOverride +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The HasSenderOverride parameter specifies a condition that looks for messages where the sender chose to override a DLP policy. Valid values are: + +- $true: Look for messages where the sender took action to override a DLP policy. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderContainsMessageHeader +This parameter specifies a condition or 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. + +The HeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the HeaderContainsWords parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderContainsWords +This parameter specifies a condition or 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. + +The HeaderContainsWords parameter specifies a condition 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. + +You specify the header field to search by using the HeaderContainsMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesMessageHeader +This parameter specifies a condition or 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. + +The HeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the HeaderMatchesPatterns parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +This parameter specifies a condition or 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. + +The HeaderMatchesPatterns parameter specifies a condition 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 specify the header field to search by using the HeaderMatchesMessageHeader parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentReportContent +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is 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. +- 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. +- 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. +- IdMatch: The sensitive information type that was detected, the exact matched content from the message, and the 150 characters before and after the matched sensitive information. +- AttachOriginalMail: The entire original message as an attachment. + +The message ID is always included in the incident report. + +You can specify multiple values separated by commas. + +You use this parameter with the GenerateIncidentReport parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentReportOriginalMail +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 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: + +- IncludeOriginalMail +- DoNotIncludeOriginalMail (this is the default value) + +```yaml +Type: IncidentReportOriginalMail +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogEventText +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. + +The LogEventText parameter specifies an action that creates an entry in the Application log on the local Edge Transport server. The value for this parameter specifies the text that you want to include in the event log entry. If the text contains spaces, enclose the value in quotation marks ("). + +The entry contains the following information: + +- Level: Information +- Source: MSExchange Messaging Policies +- Event ID: 4000 +- Task Category: Rules +- EventData: `The following message is logged by an action in the rules: <text you specify>` + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagerAddresses +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You specify if you want to look for these users as managers of senders or recipients by using the ManagerForEvaluatedUser parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagerForEvaluatedUser +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The ManagerForEvaluatedUser parameter specifies a condition that looks for users in the Manager attribute of senders or recipients. Valid values are: + +- Recipient: The user is the manager of a recipient. +- Sender: The user is the manager of the sender. + +You specify the users to look for by using the ManagerAddresses parameter. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageContainsDataClassifications +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. + +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. + +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). + +You can specify the notification options by using the NotifySender parameter. + +```yaml +Type: Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageSizeOver +This parameter specifies a condition or 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. + +The MessageSizeOver parameter specifies a condition that looks for messages larger than the specified size. The size includes the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTypeMatches +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is 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. +- 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). +- Voicemail: Voice mail messages forwarded by Unified Messaging service. +- Signed: Digitally signed messages. +- ApprovalRequest: Moderation request messages sent to moderators. +- ReadReceipt: Read receipts. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies how the rule operates. Valid values are: + +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. +- Enforce: All actions specified in the rule are taken. This is the default value. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerateMessageByManager +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ModerateMessageByManager parameter specifies an action that forwards messages for approval to the user that's specified in the sender's Manager attribute. After the manager approves the message, it's delivered to the recipients. Valid values are: + +- $true: Moderation by the sender's manager is enabled. +- $false: Moderation by the sender's manager is disabled. + +This action only works if the sender's Manager attribute is defined. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerateMessageByUser +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The ModerateMessageByUser parameter specifies an action that forwards messages for approval to the specified users. After one of the users approves the message, it's delivered to the recipients. You can use ay value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use a distribution group as a moderator. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifySender +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The NotifySender parameter specifies an action that notifies the sender when messages violate DLP policies. Valid values are: + +- NotifyOnly: The sender is notified, but the message is delivered normally. +- RejectMessage: The message is rejected, and the sender is notified. +- RejectUnlessFalsePositiveOverride: The message is rejected unless it's marked as a false positive by the sender. +- RejectUnlessSilentOverride: The message is rejected unless the sender has chosen to override the policy restriction. +- RejectUnlessExplicitOverride: This is the same as RejectUnlessSilentOverride, but the sender can also provide a justification for overriding the policy restriction. + +For all values except NotifyOnly, you can specify an enhanced status code and a rejection reason by using the RejectMessageEnhancedStatusCode and RejectMessageReasonText parameters. The default enhanced status code is 5.7.1, and the default rejection reason is Delivery not authorized, message refused. + +If you use this parameter, you also need to specify a condition that looks for sensitive information types in messages by using the MessageContainsDataClassifications parameter. + +This action is applicable to messages sent by internal users only. External senders will not receive notifications. + +```yaml +Type: NotifySenderType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrependSubject +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. + +The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). + +Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new rule (the 9th rule) are from 0 through 8. +- The default value for a new rule (the 9th rule) is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quarantine +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Edge Transport servers. + +The Quarantine parameter specifies an action that quarantines messages. + +- In on-premises Exchange, messages are delivered to the quarantine mailbox that you've configured as part of Content filtering. If the quarantine mailbox isn't configured, the message is returned to the sender in an NDR. +- In Microsoft 365, messages are delivered to the hosted quarantine. + +If this action is in a rule that's not the last rule in the list, rule evaluation stops after this rule is run. When the message is released from quarantine, the remaining rules in the list aren't evaluated. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientADAttributeContainsWords parameter specifies a condition that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddressContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddressMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddressType +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. + +```yaml +Type: RecipientAddressType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +This parameter specifies a condition or 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 RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientInSenderList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectMessageTo +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. + +The RedirectMessageTo parameter specifies a rule action that redirects messages to the specified recipients. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessageEnhancedStatusCode +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 RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999. + +You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). + +If you use this parameter with the RejectMessageReasonText parameter, the enhanced status code value is set to 5.7.1. + +To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessageReasonText +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). + +In Exchange 2013 or later, the maximum number of characters is 256. + +In the cloud-based service, the maximum number of characters is 1024. + +You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). + +If you use this parameter with the RejectMessageEnhancedStatusCode parameter, the custom explanation text value is set to "Delivery not authorized, message refused". + +To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveHeader +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. + +The RemoveHeader parameter specifies an action that removes a header field from the message header. The value of this parameter specifies the name of the header field to remove. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOME +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveOME parameter specifies an action that removes the previous version of Office 365 Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $false: The message and attachments aren't decrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOMEv2 +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveOMEv2 parameter specifies an action that removes Office 365 Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $false: The message and attachments aren't decrypted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveRMSAttachmentEncryption +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveRMSAttachmentEncryption parameter specifies an action that removes Microsoft Purview Message Encryption from encrypted attachments in email. The attachments were already encrypted before they were attached to the message. The message itself doesn't need to be encrypted. Valid values are: + +- $true: The encrypted attachments are decrypted. +- $false: The encrypted attachments aren't decrypted. + + This parameter also requires the value $true for the RemoveOMEv2 parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteMessageOutboundConnector +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RouteMessageOutboundConnector parameter specifies an action that routes messages through the specified Outbound connector in Microsoft 365. You can use any value that uniquely identifies the connector. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: OutboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteMessageOutboundRequireTls +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The RouteMessageOutboundRequireTls parameter specifies an action that uses Transport Layer Security (TLS) encryption to deliver messages outside your organization. Valid values are: + +- $true: The messages must be delivered over a TLS encrypted channel. +- $false: A TLS encrypted channel isn't required to deliver the messages. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleErrorAction +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. +- 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSubType +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SCLOver +This parameter specifies a condition or 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. + +The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: + +- -1: The message is from a trusted sender, so the message bypasses spam filtering. +- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. + +The rule looks for messages with an SCL value that's greater than or equal to the specified value. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeContainsWords +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderADAttributeContainsWords parameter specifies a condition that looks for words in Active Directory attributes of message senders. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. + +For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeMatchesPatterns +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in Active Directory attributes of message senders by using regular expressions. + +You can use any of the following Active Directory attributes: + +- City +- Company +- Country +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email +- FaxNumber +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- MobileNumber +- Notes +- Office +- OtherFaxNumber +- OtherHomePhoneNumber +- OtherPhoneNumber +- PagerNumber +- PhoneNumber +- POBox +- State +- Street +- Title +- UserLogonName +- ZipCode + +This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". + +When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers. For example, in on-premises Exchange the the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +Message envelope searching is available only for the following conditions and exceptions: + +- From and ExceptIfFrom +- FromAddressContainsWords and ExceptIfFromAddressContainsWords +- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns +- FromMemberOf and ExceptIfFromMemberOf +- SenderDomainIs and ExceptIfSenderDomainIs + +```yaml +Type: SenderAddressLocation +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. + +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". + +You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderInRecipientList +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIpRanges +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderIpRanges parameter specifies a condition that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderManagementRelationship +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SenderManagementRelationship parameter specifies a condition that looks for the relationship between the sender and recipients in messages. Valid values are: + +- Manager: The sender is the manager of a recipient. +- DirectReport: A recipient is the manager of the sender. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToScope +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: + +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. + +```yaml +Type: ToUserScope +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetAuditSeverity +This parameter specifies an action or part of an action for the rule. + +In on-premises Exchange, this action is available only on Mailbox servers. + +The SetAuditSeverity parameter specifies an action that sets the severity level of the incident report and the corresponding entry that's written to the message tracking log when messages violate DLP policies. Valid values are: + +- DoNotAudit: No audit entry is logged. +- Low: The audit entry is assigned low severity. +- Medium: The audit entry is assigned medium severity. +- High: The audit entry is assigned high severity. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetHeaderName +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. + +The SetHeaderName parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the name of the header field that you want to add or modify. When you use this parameter, you also need to use the SetHeaderValue parameter to specify a value for the header. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetHeaderValue +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. + +The SetHeaderValue parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the value that you want to apply to the header field. When you use this parameter, you also need to use the SetHeaderName parameter to specify the name of the header field that you want to add or modify. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetSCL +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. + +The SetSCL parameter specifies an action that adds or modifies the SCL value of messages. Valid values are: + +- -1: The message is from a trusted sender, so the message bypasses spam filtering. +- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpRejectMessageRejectStatusCode +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. + +The SmtpRejectMessageRejectStatusCode parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the SMTP code that's used. Valid values are the integers 400 through 500. + +You can use this parameter with the SmtpRejectMessageRejectText parameter. If you don't use this parameter, the default SMTP code 550 is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpRejectMessageRejectText +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. + +The SmtpRejectMessageRejectText parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the explanation text that's used. If the value contains spaces, enclose the value in quotation marks ("). + +You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. If you don't use this parameter, the default text Delivery not authorized, message refused is used. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopRuleProcessing +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. + +The StopRuleProcessing parameter specifies an action that stops processing more rules. Valid values are: + +- $true: Stop processing more rules. +- $false: Continue processing more rules after this one. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectContainsWords +This parameter specifies a condition or 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. + +The SubjectContainsWords parameter specifies a condition that looks for words 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. + +The maximum length of this parameter is 128 characters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +This parameter specifies a condition or 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. + +The SubjectMatchesPatterns parameter specifies a condition 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyContainsWords +This parameter specifies a condition or 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. + +The SubjectOrBodyContainsWords parameter specifies a condition that looks for words 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. + +The maximum length of this parameter is 128 characters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyMatchesPatterns +This parameter specifies a condition or 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. + +The SubjectOrBodyMatchesPatterns parameter specifies a condition 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"`. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WithImportance +This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. + +In on-premises Exchange, this condition is available only on Mailbox servers. + +The WithImportance parameter specifies a condition that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mail-flow/Set-TransportServer.md b/exchange/exchange-ps/exchange/Set-TransportServer.md similarity index 85% rename from exchange/exchange-ps/exchange/mail-flow/Set-TransportServer.md rename to exchange/exchange-ps/exchange/Set-TransportServer.md index d15f001c34..f9958ab658 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-TransportServer.md +++ b/exchange/exchange-ps/exchange/Set-TransportServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-TransportServer @@ -13,89 +16,132 @@ This cmdlet is available only in on-premises Exchange. Use the Set-TransportServer cmdlet to modify settings that are associated with the Hub Transport server role or the Edge Transport server role. -Note: In Exchange 2013 or later, use the Set-TransportService cmdlet instead. If you have scripts that use Set-TransportServer, update them to use Set-TransportService. +**Note**: In Exchange 2013 or later, use the Set-TransportService cmdlet instead. If you have scripts that use Set-TransportServer, update them to use Set-TransportService. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-TransportServer [-Identity] <ServerIdParameter> [-ActiveUserStatisticsLogMaxAge <EnhancedTimeSpan>] +Set-TransportServer [-Identity] <ServerIdParameter> + [-ActiveUserStatisticsLogMaxAge <EnhancedTimeSpan>] [-ActiveUserStatisticsLogMaxDirectorySize <ByteQuantifiedSize>] - [-ActiveUserStatisticsLogMaxFileSize <ByteQuantifiedSize>] [-ActiveUserStatisticsLogPath <LocalLongFullPath>] - [-AntispamAgentsEnabled <$true | $false>] [-Confirm] [-ConnectivityLogEnabled <$true | $false>] - [-ConnectivityLogMaxAge <EnhancedTimeSpan>] [-ConnectivityLogMaxDirectorySize <Unlimited>] - [-ConnectivityLogMaxFileSize <Unlimited>] [-ConnectivityLogPath <LocalLongFullPath>] - [-ContentConversionTracingEnabled <$true | $false>] [-DelayNotificationTimeout <EnhancedTimeSpan>] - [-DeltaSyncClientCertificateThumbprint <String>] [-DomainController <Fqdn>] - [-ExternalDNSAdapterEnabled <$true | $false>] [-ExternalDNSAdapterGuid <Guid>] - [-ExternalDNSProtocolOption <Any | UseUdpOnly | UseTcpOnly>] [-ExternalDNSServers <MultiValuedProperty>] - [-ExternalIPAddress <IPAddress>] [-HttpProtocolLogEnabled <$true | $false>] - [-HttpProtocolLogFilePath <LocalLongFullPath>] [-HttpProtocolLogLoggingLevel <None | Verbose>] - [-HttpProtocolLogMaxAge <EnhancedTimeSpan>] [-HttpProtocolLogMaxDirectorySize <ByteQuantifiedSize>] - [-HttpProtocolLogMaxFileSize <ByteQuantifiedSize>] [-HttpTransportSyncProxyServer <String>] - [-InternalDNSAdapterEnabled <$true | $false>] [-InternalDNSAdapterGuid <Guid>] - [-InternalDNSProtocolOption <Any | UseUdpOnly | UseTcpOnly>] [-InternalDNSServers <MultiValuedProperty>] - [-IntraOrgConnectorProtocolLoggingLevel <None | Verbose>] - [-IntraOrgConnectorSmtpMaxMessagesPerConnection <Int32>] [-IrmLogEnabled <$true | $false>] - [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] - [-IrmLogMaxFileSize <ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>] - [-MaxActiveTransportSyncJobsPerProcessor <Int32>] [-MaxConcurrentMailboxDeliveries <Int32>] - [-MaxConcurrentMailboxSubmissions <Int32>] [-MaxConnectionRatePerMinute <Int32>] - [-MaxNumberOfTransportSyncAttempts <Int32>] [-MaxOutboundConnections <Unlimited>] - [-MaxPerDomainOutboundConnections <Unlimited>] [-MessageExpirationTimeout <EnhancedTimeSpan>] - [-MessageRetryInterval <EnhancedTimeSpan>] [-MessageTrackingLogEnabled <$true | $false>] - [-MessageTrackingLogMaxAge <EnhancedTimeSpan>] [-MessageTrackingLogMaxDirectorySize <Unlimited>] - [-MessageTrackingLogMaxFileSize <ByteQuantifiedSize>] [-MessageTrackingLogPath <LocalLongFullPath>] - [-MessageTrackingLogSubjectLoggingEnabled <$true | $false>] + [-ActiveUserStatisticsLogMaxFileSize <ByteQuantifiedSize>] + [-ActiveUserStatisticsLogPath <LocalLongFullPath>] + [-AgentLogEnabled <Boolean>] + [-AgentLogMaxAge <EnhancedTimeSpan>] + [-AgentLogMaxDirectorySize <Unlimited>] + [-AgentLogMaxFileSize <Unlimited>] + [-AgentLogPath <LocalLongFullPath>] + [-AntispamAgentsEnabled <Boolean>] + [-Confirm] + [-ConnectivityLogEnabled <Boolean>] + [-ConnectivityLogMaxAge <EnhancedTimeSpan>] + [-ConnectivityLogMaxDirectorySize <Unlimited>] + [-ConnectivityLogMaxFileSize <Unlimited>] + [-ConnectivityLogPath <LocalLongFullPath>] + [-ContentConversionTracingEnabled <Boolean>] + [-DelayNotificationTimeout <EnhancedTimeSpan>] + [-DnsLogEnabled <Boolean>] + [-DnsLogMaxAge <EnhancedTimeSpan>] + [-DnsLogMaxDirectorySize <Unlimited>] + [-DnsLogMaxFileSize <Unlimited>] + [-DnsLogPath <LocalLongFullPath>] + [-DomainController <Fqdn>] + [-ExternalDNSAdapterEnabled <Boolean>] + [-ExternalDNSAdapterGuid <Guid>] + [-ExternalDNSProtocolOption <ProtocolOption>] + [-ExternalDNSServers <MultiValuedProperty>] + [-ExternalIPAddress <IPAddress>] + [-InternalDNSAdapterEnabled <Boolean>] + [-InternalDNSAdapterGuid <Guid>] + [-InternalDNSProtocolOption <ProtocolOption>] + [-InternalDNSServers <MultiValuedProperty>] + [-IntraOrgConnectorProtocolLoggingLevel <ProtocolLoggingLevel>] + [-IntraOrgConnectorSmtpMaxMessagesPerConnection <Int32>] + [-IrmLogEnabled <Boolean>] + [-IrmLogMaxAge <EnhancedTimeSpan>] + [-IrmLogMaxDirectorySize <Unlimited>] + [-IrmLogMaxFileSize <ByteQuantifiedSize>] + [-IrmLogPath <LocalLongFullPath>] + [-MaxConcurrentMailboxDeliveries <Int32>] + [-MaxConcurrentMailboxSubmissions <Int32>] + [-MaxConnectionRatePerMinute <Int32>] + [-MaxOutboundConnections <Unlimited>] + [-MaxPerDomainOutboundConnections <Unlimited>] + [-MessageExpirationTimeout <EnhancedTimeSpan>] + [-MessageRetryInterval <EnhancedTimeSpan>] + [-MessageTrackingLogEnabled <Boolean>] + [-MessageTrackingLogMaxAge <EnhancedTimeSpan>] + [-MessageTrackingLogMaxDirectorySize <Unlimited>] + [-MessageTrackingLogMaxFileSize <ByteQuantifiedSize>] + [-MessageTrackingLogPath <LocalLongFullPath>] + [-MessageTrackingLogSubjectLoggingEnabled <Boolean>] [-OutboundConnectionFailureRetryInterval <EnhancedTimeSpan>] - [-PickupDirectoryMaxHeaderSize <ByteQuantifiedSize>] [-PickupDirectoryMaxMessagesPerMinute <Int32>] - [-PickupDirectoryMaxRecipientsPerMessage <Int32>] [-PickupDirectoryPath <LocalLongFullPath>] - [-PipelineTracingEnabled <$true | $false>] [-PipelineTracingPath <LocalLongFullPath>] - [-PipelineTracingSenderAddress <SmtpAddress>] [-PoisonMessageDetectionEnabled <$true | $false>] - [-PoisonThreshold <Int32>] [-QueueMaxIdleTime <EnhancedTimeSpan>] - [-ReceiveProtocolLogMaxAge <EnhancedTimeSpan>] [-ReceiveProtocolLogMaxDirectorySize <Unlimited>] - [-ReceiveProtocolLogMaxFileSize <Unlimited>] [-ReceiveProtocolLogPath <LocalLongFullPath>] - [-RecipientValidationCacheEnabled <$true | $false>] [-ReplayDirectoryPath <LocalLongFullPath>] - [-RootDropDirectoryPath <String>] [-RoutingTableLogMaxAge <EnhancedTimeSpan>] - [-RoutingTableLogMaxDirectorySize <Unlimited>] [-RoutingTableLogPath <LocalLongFullPath>] - [-SendProtocolLogMaxAge <EnhancedTimeSpan>] [-SendProtocolLogMaxDirectorySize <Unlimited>] - [-SendProtocolLogMaxFileSize <Unlimited>] [-SendProtocolLogPath <LocalLongFullPath>] - [-ServerStatisticsLogMaxAge <EnhancedTimeSpan>] [-ServerStatisticsLogMaxDirectorySize <ByteQuantifiedSize>] - [-ServerStatisticsLogMaxFileSize <ByteQuantifiedSize>] [-ServerStatisticsLogPath <LocalLongFullPath>] - [-TransientFailureRetryCount <Int32>] [-TransientFailureRetryInterval <EnhancedTimeSpan>] - [-UseDowngradedExchangeServerAuth <$true | $false>] - [-WhatIf] [-AgentLogEnabled <$true | $false>] - [-AgentLogMaxAge <EnhancedTimeSpan>] [-AgentLogMaxDirectorySize <Unlimited>] - [-AgentLogMaxFileSize <Unlimited>] [-AgentLogPath <LocalLongFullPath>] [-DnsLogEnabled <$true | $false>] - [-DnsLogMaxAge <EnhancedTimeSpan>] [-DnsLogMaxDirectorySize <Unlimited>] [-DnsLogMaxFileSize <Unlimited>] - [-DnsLogPath <LocalLongFullPath>] [-QueueLogMaxAge <EnhancedTimeSpan>] [-QueueLogMaxDirectorySize <Unlimited>] - [-QueueLogMaxFileSize <Unlimited>] [-QueueLogPath <LocalLongFullPath>] [-WlmLogMaxAge <EnhancedTimeSpan>] - [-WlmLogMaxDirectorySize <Unlimited>] [-WlmLogMaxFileSize <Unlimited>] [-WlmLogPath <LocalLongFullPath>] + [-PickupDirectoryMaxHeaderSize <ByteQuantifiedSize>] + [-PickupDirectoryMaxMessagesPerMinute <Int32>] + [-PickupDirectoryMaxRecipientsPerMessage <Int32>] + [-PickupDirectoryPath <LocalLongFullPath>] + [-PipelineTracingEnabled <Boolean>] + [-PipelineTracingPath <LocalLongFullPath>] + [-PipelineTracingSenderAddress <SmtpAddress>] + [-PoisonMessageDetectionEnabled <Boolean>] + [-PoisonThreshold <Int32>] + [-QueueLogMaxAge <EnhancedTimeSpan>] + [-QueueLogMaxDirectorySize <Unlimited>] + [-QueueLogMaxFileSize <Unlimited>] + [-QueueLogPath <LocalLongFullPath>] + [-QueueMaxIdleTime <EnhancedTimeSpan>] + [-ReceiveProtocolLogMaxAge <EnhancedTimeSpan>] + [-ReceiveProtocolLogMaxDirectorySize <Unlimited>] + [-ReceiveProtocolLogMaxFileSize <Unlimited>] + [-ReceiveProtocolLogPath <LocalLongFullPath>] + [-RecipientValidationCacheEnabled <Boolean>] + [-ReplayDirectoryPath <LocalLongFullPath>] + [-RootDropDirectoryPath <String>] + [-RoutingTableLogMaxAge <EnhancedTimeSpan>] + [-RoutingTableLogMaxDirectorySize <Unlimited>] + [-RoutingTableLogPath <LocalLongFullPath>] + [-SendProtocolLogMaxAge <EnhancedTimeSpan>] + [-SendProtocolLogMaxDirectorySize <Unlimited>] + [-SendProtocolLogMaxFileSize <Unlimited>] + [-SendProtocolLogPath <LocalLongFullPath>] + [-ServerStatisticsLogMaxAge <EnhancedTimeSpan>] + [-ServerStatisticsLogMaxDirectorySize <ByteQuantifiedSize>] + [-ServerStatisticsLogMaxFileSize <ByteQuantifiedSize>] + [-ServerStatisticsLogPath <LocalLongFullPath>] + [-TransientFailureRetryCount <Int32>] + [-TransientFailureRetryInterval <EnhancedTimeSpan>] + [-UseDowngradedExchangeServerAuth <Boolean>] + [-WhatIf] + [-WlmLogMaxAge <EnhancedTimeSpan>] + [-WlmLogMaxDirectorySize <Unlimited>] + [-WlmLogMaxFileSize <Unlimited>] + [-WlmLogPath <LocalLongFullPath>] [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-TransportServer Mailbox01 -DelayNotificationTimeout 13:00:00 ``` This example sets the DelayNotificationTimeout parameter to 13 hours on server named Mailbox01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-TransportServer Mailbox01 -TransientFailureRetryCount 3 -TransientFailureRetryInterval 00:00:30 ``` This example sets the TransientFailureRetryCount parameter to 3 and sets the TransientFailureRetryInterval parameter to 30 seconds on server named Mailbox01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-TransportServer Mailbox01 -ReceiveProtocolLogPath "C:\SMTP Protocol Logs\Receive.log" ``` @@ -104,13 +150,19 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity -The Identity parameter specifies the server that you want to modify. +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 +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -130,6 +182,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -143,13 +196,9 @@ The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the s When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -161,6 +210,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -174,13 +224,9 @@ The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -192,6 +238,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -200,13 +247,127 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogPath -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. +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. +- Exchange 2013 or later: 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 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 +``` + +### -AgentLogEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentLogMaxAge +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. + +Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the automatic removal of agent log files because of their age. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentLogMaxDirectorySize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentLogMaxFileSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentLogPath +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 Default value: None @@ -220,10 +381,11 @@ The AntispamAgentsEnabled parameter specifies whether anti-spam agents are insta You set this parameter by using a script. You shouldn't modify this parameter manually. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -234,8 +396,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -243,6 +404,7 @@ 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 @@ -254,10 +416,11 @@ Accept wildcard characters: False The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -277,6 +440,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -290,13 +454,9 @@ The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -308,6 +468,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -321,13 +482,9 @@ The ConnectivityLogMaxFileSize parameter specifies the maximum size of each conn When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -339,6 +496,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -347,13 +505,19 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath -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. +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 +- Exchange 2013 or later: 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -362,19 +526,18 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled -The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: +The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control - - Network Service: Full Control - - System: Full Control ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -394,6 +557,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -401,16 +565,15 @@ 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. - -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. +### -DnsLogEnabled +The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml -Type: Fqdn +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -418,14 +581,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalDNSAdapterEnabled -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. +### -DnsLogMaxAge +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. + +Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automatic removal of DNS log files because of their age. ```yaml -Type: $true | $false +Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -433,16 +601,27 @@ Accept pipeline input: False 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. +### -DnsLogMaxDirectorySize +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. -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. +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. ```yaml -Type: Guid +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -450,14 +629,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalDNSProtocolOption -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. +### -DnsLogMaxFileSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. ```yaml -Type: Any | UseUdpOnly | UseTcpOnly +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -465,20 +657,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalDNSServers -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used. +### -DnsLogPath +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: MultiValuedProperty +Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -486,14 +673,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalIPAddress -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. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: IPAddress +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 @@ -501,14 +691,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalDNSAdapterEnabled -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. +### -ExternalDNSAdapterEnabled +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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -516,16 +707,17 @@ Accept pipeline input: False 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. +### -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. -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. +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. ```yaml Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -533,16 +725,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalDNSProtocolOption -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. +### -ExternalDNSProtocolOption +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: Any | UseUdpOnly | UseTcpOnly +Type: ProtocolOption Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -550,12 +741,102 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalDNSServers -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 ({}). +### -ExternalDNSServers +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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalIPAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalDNSAdapterEnabled +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 +Default value: None +Accept pipeline input: False +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. + +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. + +```yaml +Type: Guid +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 +``` + +### -InternalDNSProtocolOption +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 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 +``` + +### -InternalDNSServers +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. 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. @@ -564,6 +845,7 @@ 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 @@ -577,10 +859,11 @@ The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP pro 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. ```yaml -Type: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -596,6 +879,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -607,14 +891,14 @@ Accept wildcard characters: False The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true: Enable IRM logging - - $false: Disable IRM logging ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -634,6 +918,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -647,13 +932,9 @@ This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -665,6 +946,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -678,13 +960,9 @@ This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -696,6 +974,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -711,6 +990,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -726,6 +1006,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -741,6 +1022,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -756,6 +1038,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -771,6 +1054,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -779,13 +1063,14 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections -The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 20. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. +The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -805,6 +1090,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -813,7 +1099,7 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval -The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 15 minutes. +The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -824,6 +1110,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -835,10 +1122,11 @@ Accept wildcard characters: False The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -858,6 +1146,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -877,13 +1166,9 @@ The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -895,6 +1180,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -908,15 +1194,10 @@ The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the me When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. 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. @@ -926,6 +1207,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -941,6 +1223,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -952,10 +1235,11 @@ Accept wildcard characters: False The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -975,6 +1259,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -988,15 +1273,10 @@ The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. The valid input range for this parameter is from 32768 through 2147483647 bytes. @@ -1006,6 +1286,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1021,6 +1302,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1029,13 +1311,14 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxRecipientsPerMessage -The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an message. The default value is 100. The valid input range for this parameter is from 1 through 10000. +The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an message. The default value is 100. The valid input range for this parameter is from 1 through 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1051,6 +1334,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1062,10 +1346,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1074,12 +1359,19 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath -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 computer. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. Pipeline tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: +The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location depends on your version of Exchange: -- Administrators: Full Control +- Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\PipelineTracing. +- Exchange 2013 or later: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\PipelineTracing. -- Network Service: Full Control +The path must be local to the Exchange server. + +Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. + +Pipeline tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: +- Administrators: Full Control +- Network Service: Full Control - System: Full Control ```yaml @@ -1087,6 +1379,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1095,13 +1388,14 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress -The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. +The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1113,10 +1407,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1132,6 +1427,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1151,6 +1447,99 @@ Type: EnhancedTimeSpan 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 +``` + +### -QueueLogMaxAge +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. + +For example, to specify 10 days for this parameter, use 10.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the QueueLogMaxAge parameter to 00:00:00 prevents the automatic removal of queue log files because of their age. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueLogMaxDirectorySize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueLogMaxFileSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueLogPath +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 Default value: None @@ -1170,6 +1559,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1183,13 +1573,9 @@ The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of t When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1201,6 +1587,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1214,13 +1601,9 @@ The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of the Re When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1232,6 +1615,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1240,13 +1624,19 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath -The ReceiveProtocolLogPath parameter specifies the path of the protocol log directory for all the Receive connectors that exist on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpReceive. Setting the value of this parameter to $null disables protocol logging for all Receive connectors on the server. However, setting this parameter to $null when the value of the ProtocolLoggingLevel attribute for any Receive connector on the server is Verbose generates event log errors. The preferred method of disabling protocol logging is to use the Set-ReceiveConnector cmdlet to set the ProtocolLoggingLevel to None on each Receive connector. +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. +- Exchange 2013 or later: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpReceive. + +Setting the value of this parameter to $null disables protocol logging for all Receive connectors on the server. However, setting this parameter to $null when the value of the ProtocolLoggingLevel attribute for any Receive connector on the server is Verbose generates event log errors. The preferred method of disabling protocol logging is to use the Set-ReceiveConnector cmdlet to set the ProtocolLoggingLevel to None on each Receive connector. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1258,10 +1648,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1277,6 +1668,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1292,6 +1684,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1311,6 +1704,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1324,13 +1718,9 @@ The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1342,6 +1732,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1350,13 +1741,19 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath -The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Routing. Setting the value of the RoutingTableLogPath parameter to $null disables routing table logging. +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. +- Exchange 2013 or later: 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1376,6 +1773,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1389,13 +1787,9 @@ The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1407,6 +1801,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1420,13 +1815,9 @@ The SendProtocolLogMaxFileSize parameter specifies the maximum size of the Send When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1438,6 +1829,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1446,13 +1838,19 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath -The SendProtocolLogPath parameter specifies the location of protocol log storage for the Send connectors. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpSend. Setting the value of this parameter to $null disables protocol logging for all Send connectors on the server. However, setting this parameter to $null when the value of the ProtocolLoggingLevel or IntraOrgConnectorProtocolLoggingLevel attribute for any Send connector on the server is Verbose generates event log errors. The preferred method of disabling protocol logging is to use the Set-SendConnector cmdlet to set the ProtocolLoggingLevel parameter to None on each Send connector and to set the IntraOrgConnectorProtocolLoggingLevel parameter to None. +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. +- Exchange 2013 or later: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpSend. + +Setting the value of this parameter to $null disables protocol logging for all Send connectors on the server. However, setting this parameter to $null when the value of the ProtocolLoggingLevel or IntraOrgConnectorProtocolLoggingLevel attribute for any Send connector on the server is Verbose generates event log errors. The preferred method of disabling protocol logging is to use the Set-SendConnector cmdlet to set the ProtocolLoggingLevel parameter to None on each Send connector and to set the IntraOrgConnectorProtocolLoggingLevel parameter to None. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1461,7 +1859,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge -This parameter has been deprecated and is no longer used. +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. @@ -1474,6 +1872,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1482,13 +1881,26 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize -This parameter has been deprecated and is no longer used. +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are treated as bytes. + +The value of the ServerStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ServerStatisticsLogMaxDirectorySize 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. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1497,13 +1909,26 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize -This parameter has been deprecated and is no longer used. +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are treated as bytes. + +The value of the ServerStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ServerStatisticsLogMaxDirectorySize 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. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1512,13 +1937,21 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath -This parameter has been deprecated and is no longer used. +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: + +- Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ServerStats. +- Exchange 2013 or later: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ServerStats. + +Setting the value of this parameter to $null disables server statistics logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1534,6 +1967,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1553,6 +1987,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1568,10 +2003,11 @@ Normally, TLS is required for connections between the Transport services on Mail 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1587,324 +2023,7 @@ 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 -``` - -### -AgentLogEnabled -The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentLogMaxAge -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. - -Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the automatic removal of agent log files because of their age. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentLogMaxDirectorySize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentLogMaxFileSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentLogPath -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsLogEnabled -The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsLogMaxAge -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. - -Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automatic removal of DNS log files because of their age. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsLogMaxDirectorySize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsLogMaxFileSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsLogPath -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueLogMaxAge -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. - -For example, to specify 10 days for this parameter, use 10.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the QueueLogMaxAge parameter to 00:00:00 prevents the automatic removal of queue log files because of their age. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueLogMaxDirectorySize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueLogMaxFileSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueLogPath -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 Default value: None @@ -1920,6 +2039,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1935,6 +2055,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1950,6 +2071,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1965,6 +2087,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1973,20 +2096,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/af25a915-79d7-4797-bac1-3ccd7f65129a.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-TransportService.md b/exchange/exchange-ps/exchange/Set-TransportService.md similarity index 88% rename from exchange/exchange-ps/exchange/mail-flow/Set-TransportService.md rename to exchange/exchange-ps/exchange/Set-TransportService.md index c32d9a45a4..c6c5a3fe45 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-TransportService.md +++ b/exchange/exchange-ps/exchange/Set-TransportService.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-TransportService @@ -13,106 +16,174 @@ This cmdlet is available only in on-premises Exchange. Use the Set-TransportService cmdlet to modify the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-TransportService [-Identity] <ServerIdParameter> [-ActiveUserStatisticsLogMaxAge <EnhancedTimeSpan>] +Set-TransportService [-Identity] <ServerIdParameter> + [-ActiveUserStatisticsLogMaxAge <EnhancedTimeSpan>] [-ActiveUserStatisticsLogMaxDirectorySize <ByteQuantifiedSize>] - [-ActiveUserStatisticsLogMaxFileSize <ByteQuantifiedSize>] [-ActiveUserStatisticsLogPath <LocalLongFullPath>] - [-AgentLogEnabled <$true | $false>] [-AgentLogMaxAge <EnhancedTimeSpan>] - [-AgentLogMaxDirectorySize <Unlimited>] [-AgentLogMaxFileSize <Unlimited>] [-AgentLogPath <LocalLongFullPath>] - [-AntispamAgentsEnabled <$true | $false>] [-Confirm] [-ConnectivityLogEnabled <$true | $false>] - [-ConnectivityLogMaxAge <EnhancedTimeSpan>] [-ConnectivityLogMaxDirectorySize <Unlimited>] - [-ConnectivityLogMaxFileSize <Unlimited>] [-ConnectivityLogPath <LocalLongFullPath>] - [-ContentConversionTracingEnabled <$true | $false>] [-DelayNotificationTimeout <EnhancedTimeSpan>] - [-DnsLogEnabled <$true | $false>] [-DnsLogMaxAge <EnhancedTimeSpan>] [-DnsLogMaxDirectorySize <Unlimited>] - [-DnsLogMaxFileSize <Unlimited>] [-DnsLogPath <LocalLongFullPath>] [-DomainController <Fqdn>] - [-ExternalDNSAdapterEnabled <$true | $false>] [-ExternalDNSAdapterGuid <Guid>] - [-ExternalDNSProtocolOption <Any | UseUdpOnly | UseTcpOnly>] [-ExternalDNSServers <MultiValuedProperty>] - [-ExternalIPAddress <IPAddress>] [-InternalDNSAdapterEnabled <$true | $false>] - [-InternalDNSAdapterGuid <Guid>] [-InternalDNSProtocolOption <Any | UseUdpOnly | UseTcpOnly>] - [-InternalDNSServers <MultiValuedProperty>] [-IntraOrgConnectorProtocolLoggingLevel <None | Verbose>] - [-IntraOrgConnectorSmtpMaxMessagesPerConnection <Int32>] [-IrmLogEnabled <$true | $false>] - [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] - [-IrmLogMaxFileSize <ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>] - [-JournalLogEnabled <$true | $false>] [-JournalLogMaxAge <EnhancedTimeSpan>] - [-JournalLogMaxDirectorySize <Unlimited>] [-JournalLogMaxFileSize <Unlimited>] - [-JournalLogPath <LocalLongFullPath>] [-MaxConcurrentMailboxDeliveries <Int32>] - [-MaxConcurrentMailboxSubmissions <Int32>] [-MaxConnectionRatePerMinute <Int32>] - [-MaxOutboundConnections <Unlimited>] [-MaxPerDomainOutboundConnections <Unlimited>] - [-MessageExpirationTimeout <EnhancedTimeSpan>] [-MessageRetryInterval <EnhancedTimeSpan>] - [-MessageTrackingLogEnabled <$true | $false>] [-MessageTrackingLogMaxAge <EnhancedTimeSpan>] - [-MessageTrackingLogMaxDirectorySize <Unlimited>] [-MessageTrackingLogMaxFileSize <ByteQuantifiedSize>] - [-MessageTrackingLogPath <LocalLongFullPath>] [-MessageTrackingLogSubjectLoggingEnabled <$true | $false>] + [-ActiveUserStatisticsLogMaxFileSize <ByteQuantifiedSize>] + [-ActiveUserStatisticsLogPath <LocalLongFullPath>] + [-AgentLogEnabled <Boolean>] + [-AgentLogMaxAge <EnhancedTimeSpan>] + [-AgentLogMaxDirectorySize <Unlimited>] + [-AgentLogMaxFileSize <Unlimited>] + [-AgentLogPath <LocalLongFullPath>] + [-AntispamAgentsEnabled <Boolean>] + [-Confirm] + [-ConnectivityLogEnabled <Boolean>] + [-ConnectivityLogMaxAge <EnhancedTimeSpan>] + [-ConnectivityLogMaxDirectorySize <Unlimited>] + [-ConnectivityLogMaxFileSize <Unlimited>] + [-ConnectivityLogPath <LocalLongFullPath>] + [-ContentConversionTracingEnabled <Boolean>] + [-DelayNotificationTimeout <EnhancedTimeSpan>] + [-DnsLogEnabled <Boolean>] + [-DnsLogMaxAge <EnhancedTimeSpan>] + [-DnsLogMaxDirectorySize <Unlimited>] + [-DnsLogMaxFileSize <Unlimited>] + [-DnsLogPath <LocalLongFullPath>] + [-DomainController <Fqdn>] + [-ExternalDNSAdapterEnabled <Boolean>] + [-ExternalDNSAdapterGuid <Guid>] + [-ExternalDNSProtocolOption <ProtocolOption>] + [-ExternalDNSServers <MultiValuedProperty>] + [-ExternalIPAddress <IPAddress>] + [-InternalDNSAdapterEnabled <Boolean>] + [-InternalDNSAdapterGuid <Guid>] + [-InternalDNSProtocolOption <ProtocolOption>] + [-InternalDNSServers <MultiValuedProperty>] + [-IntraOrgConnectorProtocolLoggingLevel <ProtocolLoggingLevel>] + [-IntraOrgConnectorSmtpMaxMessagesPerConnection <Int32>] + [-IrmLogEnabled <Boolean>] + [-IrmLogMaxAge <EnhancedTimeSpan>] + [-IrmLogMaxDirectorySize <Unlimited>] + [-IrmLogMaxFileSize <ByteQuantifiedSize>] + [-IrmLogPath <LocalLongFullPath>] + [-MaxConcurrentMailboxDeliveries <Int32>] + [-MaxConcurrentMailboxSubmissions <Int32>] + [-MaxConnectionRatePerMinute <Int32>] + [-MaxOutboundConnections <Unlimited>] + [-MaxPerDomainOutboundConnections <Unlimited>] + [-MessageExpirationTimeout <EnhancedTimeSpan>] + [-MessageRetryInterval <EnhancedTimeSpan>] + [-MessageTrackingLogEnabled <Boolean>] + [-MessageTrackingLogMaxAge <EnhancedTimeSpan>] + [-MessageTrackingLogMaxDirectorySize <Unlimited>] + [-MessageTrackingLogMaxFileSize <ByteQuantifiedSize>] + [-MessageTrackingLogPath <LocalLongFullPath>] + [-MessageTrackingLogSubjectLoggingEnabled <Boolean>] [-OutboundConnectionFailureRetryInterval <EnhancedTimeSpan>] - [-PickupDirectoryMaxHeaderSize <ByteQuantifiedSize>] [-PickupDirectoryMaxMessagesPerMinute <Int32>] - [-PickupDirectoryMaxRecipientsPerMessage <Int32>] [-PickupDirectoryPath <LocalLongFullPath>] - [-PipelineTracingEnabled <$true | $false>] [-PipelineTracingPath <LocalLongFullPath>] - [-PipelineTracingSenderAddress <SmtpAddress>] [-PoisonMessageDetectionEnabled <$true | $false>] - [-PoisonThreshold <Int32>] [-QueueLogMaxAge <EnhancedTimeSpan>] [-QueueLogMaxDirectorySize <Unlimited>] - [-QueueLogMaxFileSize <Unlimited>] [-QueueLogPath <LocalLongFullPath>] [-QueueMaxIdleTime <EnhancedTimeSpan>] - [-ReceiveProtocolLogMaxAge <EnhancedTimeSpan>] [-ReceiveProtocolLogMaxDirectorySize <Unlimited>] - [-ReceiveProtocolLogMaxFileSize <Unlimited>] [-ReceiveProtocolLogPath <LocalLongFullPath>] - [-RecipientValidationCacheEnabled <$true | $false>] [-ReplayDirectoryPath <LocalLongFullPath>] - [-ResourceLogEnabled <$true | $false>] [-ResourceLogMaxAge <EnhancedTimeSpan>] - [-ResourceLogMaxDirectorySize <Unlimited>] [-ResourceLogMaxFileSize <Unlimited>] - [-ResourceLogPath <LocalLongFullPath>] [-RootDropDirectoryPath <String>] - [-RoutingTableLogMaxAge <EnhancedTimeSpan>] [-RoutingTableLogMaxDirectorySize <Unlimited>] - [-RoutingTableLogPath <LocalLongFullPath>] [-SendProtocolLogMaxAge <EnhancedTimeSpan>] - [-SendProtocolLogMaxDirectorySize <Unlimited>] [-SendProtocolLogMaxFileSize <Unlimited>] - [-SendProtocolLogPath <LocalLongFullPath>] [-ServerStatisticsLogMaxAge <EnhancedTimeSpan>] + [-PickupDirectoryMaxHeaderSize <ByteQuantifiedSize>] + [-PickupDirectoryMaxMessagesPerMinute <Int32>] + [-PickupDirectoryMaxRecipientsPerMessage <Int32>] + [-PickupDirectoryPath <LocalLongFullPath>] + [-PipelineTracingEnabled <Boolean>] + [-PipelineTracingPath <LocalLongFullPath>] + [-PipelineTracingSenderAddress <SmtpAddress>] + [-PoisonMessageDetectionEnabled <Boolean>] + [-PoisonThreshold <Int32>] + [-QueueLogMaxAge <EnhancedTimeSpan>] + [-QueueLogMaxDirectorySize <Unlimited>] + [-QueueLogMaxFileSize <Unlimited>] + [-QueueLogPath <LocalLongFullPath>] + [-QueueMaxIdleTime <EnhancedTimeSpan>] + [-ReceiveProtocolLogMaxAge <EnhancedTimeSpan>] + [-ReceiveProtocolLogMaxDirectorySize <Unlimited>] + [-ReceiveProtocolLogMaxFileSize <Unlimited>] + [-ReceiveProtocolLogPath <LocalLongFullPath>] + [-RecipientValidationCacheEnabled <Boolean>] + [-ReplayDirectoryPath <LocalLongFullPath>] + [-RequestBrokerLogEnabled <Boolean>] + [-RequestBrokerLogMaxAge <EnhancedTimeSpan>] + [-RequestBrokerLogMaxDirectorySize <Unlimited>] + [-RequestBrokerLogMaxFileSize <Unlimited>] + [-RequestBrokerLogPath <LocalLongFullPath>] + [-ResourceLogEnabled <Boolean>] + [-ResourceLogMaxAge <EnhancedTimeSpan>] + [-ResourceLogMaxDirectorySize <Unlimited>] + [-ResourceLogMaxFileSize <Unlimited>] + [-ResourceLogPath <LocalLongFullPath>] + [-RootDropDirectoryPath <String>] + [-RoutingTableLogMaxAge <EnhancedTimeSpan>] + [-RoutingTableLogMaxDirectorySize <Unlimited>] + [-RoutingTableLogPath <LocalLongFullPath>] + [-SendProtocolLogMaxAge <EnhancedTimeSpan>] + [-SendProtocolLogMaxDirectorySize <Unlimited>] + [-SendProtocolLogMaxFileSize <Unlimited>] + [-SendProtocolLogPath <LocalLongFullPath>] + [-ServerStatisticsLogMaxAge <EnhancedTimeSpan>] [-ServerStatisticsLogMaxDirectorySize <ByteQuantifiedSize>] - [-ServerStatisticsLogMaxFileSize <ByteQuantifiedSize>] [-ServerStatisticsLogPath <LocalLongFullPath>] - [-TransientFailureRetryCount <Int32>] [-TransientFailureRetryInterval <EnhancedTimeSpan>] - [-TransportMaintenanceLogEnabled <$true | $false>] [-TransportMaintenanceLogMaxAge <EnhancedTimeSpan>] - [-TransportMaintenanceLogMaxDirectorySize <Unlimited>] [-TransportMaintenanceLogMaxFileSize <Unlimited>] - [-TransportMaintenanceLogPath <LocalLongFullPath>] [-TransportSyncAccountsPoisonAccountThreshold <Int32>] - [-TransportSyncAccountsPoisonDetectionEnabled <$true | $false>] + [-ServerStatisticsLogMaxFileSize <ByteQuantifiedSize>] + [-ServerStatisticsLogPath <LocalLongFullPath>] + [-TransientFailureRetryCount <Int32>] + [-TransientFailureRetryInterval <EnhancedTimeSpan>] + [-TransportHttpLogEnabled <Boolean>] + [-TransportHttpLogMaxAge <EnhancedTimeSpan>] + [-TransportHttpLogMaxDirectorySize <Unlimited>] + [-TransportHttpLogMaxFileSize <Unlimited>] + [-TransportHttpLogPath <LocalLongFullPath>] + [-TransportMaintenanceLogEnabled <Boolean>] + [-TransportMaintenanceLogMaxAge <EnhancedTimeSpan>] + [-TransportMaintenanceLogMaxDirectorySize <Unlimited>] + [-TransportMaintenanceLogMaxFileSize <Unlimited>] + [-TransportMaintenanceLogPath <LocalLongFullPath>] + [-TransportSyncAccountsPoisonAccountThreshold <Int32>] + [-TransportSyncAccountsPoisonDetectionEnabled <Boolean>] [-TransportSyncAccountsPoisonItemThreshold <Int32>] - [-TransportSyncAccountsSuccessivePoisonItemThreshold <Int32>] [-TransportSyncEnabled <$true | $false>] - [-TransportSyncExchangeEnabled <$true | $false>] [-TransportSyncHubHealthLogEnabled <$true | $false>] - [-TransportSyncHubHealthLogFilePath <LocalLongFullPath>] [-TransportSyncHubHealthLogMaxAge <EnhancedTimeSpan>] + [-TransportSyncAccountsSuccessivePoisonItemThreshold <Int32>] + [-TransportSyncEnabled <Boolean>] + [-TransportSyncExchangeEnabled <Boolean>] + [-TransportSyncHubHealthLogEnabled <Boolean>] + [-TransportSyncHubHealthLogFilePath <LocalLongFullPath>] + [-TransportSyncHubHealthLogMaxAge <EnhancedTimeSpan>] [-TransportSyncHubHealthLogMaxDirectorySize <ByteQuantifiedSize>] - [-TransportSyncHubHealthLogMaxFileSize <ByteQuantifiedSize>] [-TransportSyncImapEnabled <$true | $false>] - [-TransportSyncLogEnabled <$true | $false>] [-TransportSyncLogFilePath <LocalLongFullPath>] - [-TransportSyncLogLoggingLevel <None | Error | Information | Verbose | RawData | Debugging>] - [-TransportSyncLogMaxAge <EnhancedTimeSpan>] [-TransportSyncLogMaxDirectorySize <ByteQuantifiedSize>] - [-TransportSyncLogMaxFileSize <ByteQuantifiedSize>] [-TransportSyncMaxDownloadItemsPerConnection <Int32>] + [-TransportSyncHubHealthLogMaxFileSize <ByteQuantifiedSize>] + [-TransportSyncImapEnabled <Boolean>] + [-TransportSyncLogEnabled <Boolean>] + [-TransportSyncLogFilePath <LocalLongFullPath>] + [-TransportSyncLogLoggingLevel <SyncLogLoggingLevel>] + [-TransportSyncLogMaxAge <EnhancedTimeSpan>] + [-TransportSyncLogMaxDirectorySize <ByteQuantifiedSize>] + [-TransportSyncLogMaxFileSize <ByteQuantifiedSize>] + [-TransportSyncMaxDownloadItemsPerConnection <Int32>] [-TransportSyncMaxDownloadSizePerConnection <ByteQuantifiedSize>] - [-TransportSyncMaxDownloadSizePerItem <ByteQuantifiedSize>] [-TransportSyncPopEnabled <$true | $false>] - [-TransportSyncRemoteConnectionTimeout <EnhancedTimeSpan>] [-UseDowngradedExchangeServerAuth <$true | $false>] - [-WhatIf] [-WindowsLiveHotmailTransportSyncEnabled <$true | $false>] [-WlmLogMaxAge <EnhancedTimeSpan>] - [-WlmLogMaxDirectorySize <Unlimited>] [-WlmLogMaxFileSize <Unlimited>] [-WlmLogPath <LocalLongFullPath>] - [-RequestBrokerLogEnabled <$true | $false>] [-RequestBrokerLogMaxAge <EnhancedTimeSpan>] - [-RequestBrokerLogMaxDirectorySize <Unlimited>] [-RequestBrokerLogMaxFileSize <Unlimited>] - [-RequestBrokerLogPath <LocalLongFullPath>] [-TransportHttpLogEnabled <$true | $false>] - [-TransportHttpLogMaxAge <EnhancedTimeSpan>] [-TransportHttpLogMaxDirectorySize <Unlimited>] - [-TransportHttpLogMaxFileSize <Unlimited>] [-TransportHttpLogPath <LocalLongFullPath>] [<CommonParameters>] + [-TransportSyncMaxDownloadSizePerItem <ByteQuantifiedSize>] + [-TransportSyncPopEnabled <Boolean>] + [-TransportSyncRemoteConnectionTimeout <EnhancedTimeSpan>] + [-UseDowngradedExchangeServerAuth <Boolean>] + [-WhatIf] + [-WindowsLiveHotmailTransportSyncEnabled <Boolean>] + [-WlmLogMaxAge <EnhancedTimeSpan>] + [-WlmLogMaxDirectorySize <Unlimited>] + [-WlmLogMaxFileSize <Unlimited>] + [-WlmLogPath <LocalLongFullPath>] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-TransportService Mailbox01 -DelayNotificationTimeout 13:00:00 ``` This example sets the DelayNotificationTimeout parameter to 13 hours for the Transport service on a Mailbox server named Mailbox01. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-TransportService Mailbox01 -TransientFailureRetryCount 3 -TransientFailureRetryInterval 00:00:30 ``` This example sets the TransientFailureRetryCount parameter to 3 and sets the TransientFailureRetryInterval parameter to 30 seconds for the Transport service on a Mailbox server named Mailbox01. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-TransportService Mailbox01 -ReceiveProtocolLogPath "C:\SMTP Protocol Logs\Receive.log" ``` @@ -121,13 +192,21 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity -The Identity parameter specifies the server that you want to modify. +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 +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use this parameter on an Edge Transport server. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -147,6 +226,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -160,13 +240,9 @@ The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the s When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -178,6 +254,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -191,13 +268,9 @@ The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -209,6 +282,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -224,6 +298,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -235,10 +310,11 @@ Accept wildcard characters: False The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -258,6 +334,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -271,13 +348,9 @@ The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent l When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -289,6 +362,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -302,13 +376,9 @@ The AgentLogMaxFileSize parameter specifies the maximum size of each agent log f When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -320,6 +390,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -335,6 +406,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -348,10 +420,11 @@ The AntispamAgentsEnabled parameter specifies whether anti-spam agents are insta You set this parameter by using a script. You shouldn't modify this parameter manually. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -362,8 +435,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -371,6 +443,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -382,10 +455,11 @@ Accept wildcard characters: False The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -405,6 +479,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -418,13 +493,9 @@ The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -436,6 +507,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -449,13 +521,9 @@ The ConnectivityLogMaxFileSize parameter specifies the maximum size of each conn When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -467,6 +535,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -482,6 +551,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -493,16 +563,15 @@ Accept wildcard characters: False 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 - - Network Service: Full Control - - System: Full Control ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -522,6 +591,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -533,10 +603,11 @@ Accept wildcard characters: False The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -556,6 +627,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -569,13 +641,9 @@ The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -587,6 +655,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -600,13 +669,9 @@ The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -618,6 +683,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -633,6 +699,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -650,6 +717,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -661,10 +729,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -682,6 +751,7 @@ Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -693,10 +763,11 @@ Accept wildcard characters: False 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: Any | UseUdpOnly | UseTcpOnly +Type: ProtocolOption Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -707,9 +778,9 @@ Accept wildcard characters: False ### -ExternalDNSServers 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used. @@ -718,6 +789,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -733,6 +805,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -744,10 +817,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -765,6 +839,7 @@ Type: Guid Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -776,10 +851,11 @@ Accept wildcard characters: False 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: Any | UseUdpOnly | UseTcpOnly +Type: ProtocolOption Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -790,9 +866,9 @@ Accept wildcard characters: False ### -InternalDNSServers 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. 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. @@ -801,6 +877,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -812,20 +889,19 @@ Accept wildcard characters: False 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. - - The Mailbox Transport Submission service. 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. - - 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: None | Verbose +Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -843,6 +919,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -854,14 +931,14 @@ Accept wildcard characters: False The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true: Enable IRM logging - - $false: Disable IRM logging ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -881,6 +958,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -894,13 +972,9 @@ This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -912,6 +986,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -925,13 +1000,9 @@ This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -943,6 +1014,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -958,81 +1030,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalLogEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalLogMaxAge -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalLogMaxDirectorySize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalLogMaxFileSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -JournalLogPath -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 Default value: None @@ -1048,6 +1046,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1063,6 +1062,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1078,6 +1078,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1093,6 +1094,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1101,13 +1103,14 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections -The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 20. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. +The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1127,6 +1130,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1135,7 +1139,7 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval -The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 15 minutes. +The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1146,6 +1150,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1157,10 +1162,11 @@ Accept wildcard characters: False The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1180,6 +1186,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1199,13 +1206,9 @@ The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1217,6 +1220,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1230,15 +1234,10 @@ The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the me When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. 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. @@ -1248,6 +1247,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1263,6 +1263,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1274,10 +1275,11 @@ Accept wildcard characters: False The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1297,6 +1299,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1310,15 +1313,10 @@ The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) -- TB (terabytes) - Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. The valid input range for this parameter is from 32768 through 2147483647 bytes. @@ -1328,6 +1326,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1343,6 +1342,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1358,6 +1358,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1373,6 +1374,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1384,10 +1386,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1396,12 +1399,14 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath -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 computer. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. Pipeline tracing captures the complete contents of 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: +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. -- Administrators: Full Control +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. -- Network Service: Full Control +Pipeline 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 +- Network Service: Full Control - System: Full Control ```yaml @@ -1409,6 +1414,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1424,6 +1430,7 @@ Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1435,10 +1442,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1454,6 +1462,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1473,6 +1482,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1486,13 +1496,9 @@ The QueueLogMaxDirectorySize parameter specifies the maximum size of the queue l When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1504,6 +1510,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1517,13 +1524,9 @@ The QueueLogMaxFileSize parameter specifies the maximum size of the queue log fi When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1535,6 +1538,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1550,6 +1554,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1569,6 +1574,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1590,6 +1596,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1605,13 +1612,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1625,6 +1628,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1640,13 +1644,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1660,6 +1660,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1677,6 +1678,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1688,10 +1690,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1707,6 +1710,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1714,14 +1718,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogEnabled +### -RequestBrokerLogEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1729,14 +1734,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogMaxAge +### -RequestBrokerLogMaxAge 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1744,14 +1750,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogMaxDirectorySize +### -RequestBrokerLogMaxDirectorySize 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1759,14 +1766,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogMaxFileSize +### -RequestBrokerLogMaxFileSize 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1774,14 +1782,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceLogPath +### -RequestBrokerLogPath 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1789,14 +1798,95 @@ Accept pipeline input: False 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. +### -ResourceLogEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLogMaxAge +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLogMaxDirectorySize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLogMaxFileSize +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLogPath +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 +Default value: None +Accept pipeline input: False +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. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1816,6 +1906,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1829,13 +1920,9 @@ The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1847,6 +1934,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1855,13 +1943,14 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath -The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Routing. Setting the value of the RoutingTableLogPath parameter to $null disables routing table logging. +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 Default value: None @@ -1883,6 +1972,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1898,13 +1988,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1918,6 +2004,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1933,13 +2020,9 @@ A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the v When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. @@ -1953,6 +2036,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1966,7 +2050,6 @@ The SendProtocolLogPath parameter specifies the location of the protocol log dir 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: - The IntraOrgConnectorProtocolLoggingLevel parameter. - - The ProtocolLoggingLevel parameter on the Set-SendConnector cmdlet for each Send connector in the Transport service. ```yaml @@ -1974,6 +2057,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -1982,9 +2066,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge -This parameter is available or functional only in Exchange Server 2013. - -Server statistics aren't available in Exchange 2013 Cumulative Update 7 (CU7) or later, so this parameter has no effect in those versions of Exchange 2013. +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. @@ -1996,7 +2078,8 @@ 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 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2005,22 +2088,16 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize -This parameter is available or functional only in Exchange Server 2013. - -Server statistics aren't available in Exchange 2013 CU7 or later, so this parameter has no effect in those versions of Exchange 2013. +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. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. @@ -2031,7 +2108,8 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2040,22 +2118,16 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize -This parameter is available or functional only in Exchange Server 2013. - -Server statistics aren't available in Exchange 2013 CU7 or later, so this parameter has no effect in those versions of Exchange 2013. +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. When you enter a value, qualify the value with one of the following units: - B (bytes) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. @@ -2066,7 +2138,8 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2075,9 +2148,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath -This parameter is available or functional only in Exchange Server 2013. - -Server statistics aren't available in Exchange 2013 CU7 or later, so this parameter has no effect in those versions of Exchange 2013. +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. @@ -2085,7 +2156,8 @@ The ServerStatisticsLogPath parameter specifies the location of server statistic Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2101,6 +2173,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2120,6 +2193,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2127,14 +2201,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportMaintenanceLogEnabled +### -TransportHttpLogEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2142,14 +2217,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportMaintenanceLogMaxAge +### -TransportHttpLogMaxAge 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2157,14 +2233,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportMaintenanceLogMaxDirectorySize +### -TransportHttpLogMaxDirectorySize 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2172,14 +2249,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportMaintenanceLogMaxFileSize +### -TransportHttpLogMaxFileSize 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 +Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2187,29 +2265,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportMaintenanceLogPath +### -TransportHttpLogPath 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportSyncAccountsPoisonAccountThreshold -This parameter is reserved for internal Microsoft use. +Applicable: Exchange Server 2016, Exchange Server 2019 -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -2217,14 +2281,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncAccountsPoisonDetectionEnabled +### -TransportMaintenanceLogEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2232,14 +2297,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncAccountsPoisonItemThreshold +### -TransportMaintenanceLogMaxAge This parameter is reserved for internal Microsoft use. ```yaml -Type: Int32 +Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2247,14 +2313,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncAccountsSuccessivePoisonItemThreshold +### -TransportMaintenanceLogMaxDirectorySize This parameter is reserved for internal Microsoft use. ```yaml -Type: Int32 +Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2262,14 +2329,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncEnabled +### -TransportMaintenanceLogMaxFileSize This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2277,14 +2345,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncExchangeEnabled +### -TransportMaintenanceLogPath This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2292,14 +2361,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncHubHealthLogEnabled +### -TransportSyncAccountsPoisonAccountThreshold This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2307,14 +2377,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncHubHealthLogFilePath +### -TransportSyncAccountsPoisonDetectionEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: LocalLongFullPath +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2322,14 +2393,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncHubHealthLogMaxAge +### -TransportSyncAccountsPoisonItemThreshold This parameter is reserved for internal Microsoft use. ```yaml -Type: EnhancedTimeSpan +Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2337,14 +2409,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncHubHealthLogMaxDirectorySize +### -TransportSyncAccountsSuccessivePoisonItemThreshold This parameter is reserved for internal Microsoft use. ```yaml -Type: ByteQuantifiedSize +Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2352,14 +2425,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncHubHealthLogMaxFileSize +### -TransportSyncEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: ByteQuantifiedSize +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2367,14 +2441,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncImapEnabled +### -TransportSyncExchangeEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2382,14 +2457,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncLogEnabled +### -TransportSyncHubHealthLogEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2397,7 +2473,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncLogFilePath +### -TransportSyncHubHealthLogFilePath This parameter is reserved for internal Microsoft use. ```yaml @@ -2405,21 +2481,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportSyncLogLoggingLevel -This parameter is reserved for internal Microsoft use. -```yaml -Type: None | Error | Information | Verbose | RawData | Debugging -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -2427,7 +2489,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncLogMaxAge +### -TransportSyncHubHealthLogMaxAge This parameter is reserved for internal Microsoft use. ```yaml @@ -2435,6 +2497,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2442,7 +2505,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncLogMaxDirectorySize +### -TransportSyncHubHealthLogMaxDirectorySize This parameter is reserved for internal Microsoft use. ```yaml @@ -2450,6 +2513,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2457,7 +2521,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncLogMaxFileSize +### -TransportSyncHubHealthLogMaxFileSize This parameter is reserved for internal Microsoft use. ```yaml @@ -2465,6 +2529,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2472,14 +2537,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncMaxDownloadItemsPerConnection +### -TransportSyncImapEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2487,14 +2553,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncMaxDownloadSizePerConnection +### -TransportSyncLogEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: ByteQuantifiedSize +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2502,14 +2569,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncMaxDownloadSizePerItem +### -TransportSyncLogFilePath This parameter is reserved for internal Microsoft use. ```yaml -Type: ByteQuantifiedSize +Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2517,14 +2585,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncPopEnabled +### -TransportSyncLogLoggingLevel This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: SyncLogLoggingLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2532,7 +2601,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportSyncRemoteConnectionTimeout +### -TransportSyncLogMaxAge This parameter is reserved for internal Microsoft use. ```yaml @@ -2540,6 +2609,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2547,33 +2617,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDowngradedExchangeServerAuth -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. - -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. +### -TransportSyncLogMaxDirectorySize +This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -2581,14 +2633,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WindowsLiveHotmailTransportSyncEnabled +### -TransportSyncLogMaxFileSize This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2596,14 +2649,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WlmLogMaxAge +### -TransportSyncMaxDownloadItemsPerConnection This parameter is reserved for internal Microsoft use. ```yaml -Type: EnhancedTimeSpan +Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2611,14 +2665,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WlmLogMaxDirectorySize +### -TransportSyncMaxDownloadSizePerConnection This parameter is reserved for internal Microsoft use. ```yaml -Type: Unlimited +Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2626,14 +2681,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WlmLogMaxFileSize +### -TransportSyncMaxDownloadSizePerItem This parameter is reserved for internal Microsoft use. ```yaml -Type: Unlimited +Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2641,29 +2697,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WlmLogPath +### -TransportSyncPopEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: LocalLongFullPath +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestBrokerLogEnabled -This parameter is reserved for internal Microsoft use. -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -2671,14 +2713,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestBrokerLogMaxAge +### -TransportSyncRemoteConnectionTimeout This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2686,29 +2729,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestBrokerLogMaxDirectorySize -This parameter is reserved for internal Microsoft use. +### -UseDowngradedExchangeServerAuth +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. -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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. -### -RequestBrokerLogMaxFileSize -This parameter is reserved for internal Microsoft use. +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. ```yaml -Type: Unlimited +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2716,14 +2749,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestBrokerLogPath -This parameter is reserved for internal Microsoft use. +### -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: LocalLongFullPath +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2731,14 +2765,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportHttpLogEnabled +### -WindowsLiveHotmailTransportSyncEnabled This parameter is reserved for internal Microsoft use. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2746,14 +2781,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportHttpLogMaxAge +### -WlmLogMaxAge This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2761,14 +2797,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportHttpLogMaxDirectorySize +### -WlmLogMaxDirectorySize This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2776,14 +2813,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportHttpLogMaxFileSize +### -WlmLogMaxFileSize This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2791,14 +2829,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransportHttpLogPath +### -WlmLogPath This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -2807,20 +2846,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/42fb2dce-2300-45c6-ac8f-d7647ecf6d2c.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md similarity index 81% rename from exchange/exchange-ps/exchange/unified-messaging/Set-UMAutoAttendant.md rename to exchange/exchange-ps/exchange/Set-UMAutoAttendant.md index 73fe4b26fb..c224bb9dc4 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md @@ -1,68 +1,72 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-umautoattendant +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMAutoAttendant schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-UMAutoAttendant ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Set-UMAutoAttendant cmdlet to modify an existing Unified Messaging (UM) auto attendant. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-UMAutoAttendant [-Identity] <UMAutoAttendantIdParameter> [-AfterHoursKeyMapping <MultiValuedProperty>] - [-AfterHoursKeyMappingEnabled <$true | $false>] - [-AfterHoursMainMenuCustomPromptEnabled <$true | $false>] + [-AfterHoursKeyMappingEnabled <Boolean>] + [-AfterHoursMainMenuCustomPromptEnabled <Boolean>] [-AfterHoursMainMenuCustomPromptFilename <String>] - [-AfterHoursTransferToOperatorEnabled <$true | $false>] - [-AfterHoursWelcomeGreetingEnabled <$true | $false>] + [-AfterHoursTransferToOperatorEnabled <Boolean>] + [-AfterHoursWelcomeGreetingEnabled <Boolean>] [-AfterHoursWelcomeGreetingFilename <String>] - [-AllowDialPlanSubscribers <$true | $false>] + [-AllowDialPlanSubscribers <Boolean>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] - [-AllowExtensions <$true | $false>] + [-AllowExtensions <Boolean>] [-BusinessHoursKeyMapping <MultiValuedProperty>] - [-BusinessHoursKeyMappingEnabled <$true | $false>] - [-BusinessHoursMainMenuCustomPromptEnabled <$true | $false>] + [-BusinessHoursKeyMappingEnabled <Boolean>] + [-BusinessHoursMainMenuCustomPromptEnabled <Boolean>] [-BusinessHoursMainMenuCustomPromptFilename <String>] [-BusinessHoursSchedule <ScheduleInterval[]>] - [-BusinessHoursTransferToOperatorEnabled <$true | $false>] - [-BusinessHoursWelcomeGreetingEnabled <$true | $false>] + [-BusinessHoursTransferToOperatorEnabled <Boolean>] + [-BusinessHoursWelcomeGreetingEnabled <Boolean>] [-BusinessHoursWelcomeGreetingFilename <String>] [-BusinessLocation <String>] [-BusinessName <String>] - [-CallSomeoneEnabled <$true | $false>] + [-CallSomeoneEnabled <Boolean>] [-Confirm] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] - [-ContactScope <DialPlan | GlobalAddressList | AddressList>] + [-ContactScope <DialScopeEnum>] [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-ForceUpgrade] [-HolidaySchedule <MultiValuedProperty>] - [-InfoAnnouncementEnabled <True | False | Uninterruptible>] + [-InfoAnnouncementEnabled <InfoAnnouncementEnabledEnum>] [-InfoAnnouncementFilename <String>] [-Language <UMLanguage>] - [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias | InheritFromDialPlan>] + [-MatchedNameSelectionMethod <AutoAttendantDisambiguationFieldEnum>] [-Name <String>] - [-NameLookupEnabled <$true | $false>] + [-NameLookupEnabled <Boolean>] [-OperatorExtension <String>] [-PilotIdentifierList <MultiValuedProperty>] - [-SendVoiceMsgEnabled <$true | $false>] - [-SpeechEnabled <$true | $false>] + [-SendVoiceMsgEnabled <Boolean>] + [-SpeechEnabled <Boolean>] [-Timezone <String>] [-TimeZoneName <UMTimeZone>] - [-WeekStartDay <Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday>] - [-WhatIf] [<CommonParameters>] + [-WeekStartDay <DayOfWeek>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -70,26 +74,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-UMAutoAttendant -Identity MySpeechEnabledAA -DTMFFallbackAutoAttendant MyDTMFAA -OperatorExtension 50100 -AfterHoursTransferToOperatorEnabled $true -StaroutToDialPlanEnabled $true ``` This example configures the UM auto attendant MySpeechEnabledAA to fall back to the MyDTMFAA, sets the operator's extension to 50100, enables transfers to this extension number after business hours and enables a caller to press the \* button on a telephone keypad to get to the Outlook Voice Access welcome greeting when a UM auto attendant menu is being played. -### -------------------------- Example 2 -------------------------- -``` -Set-UMAutoAttendant -Identity MyUMAutoAttendant -BusinessHoursSchedule 0.10:45-0.13:15,1.09:00-1.17:00,6.09:00-6.16:30 -HolidaySchedule "New Year,newyrgrt.wav,1/2/2013","Building Closed for Construction,construction.wav,4/24/2013,4/28/2013" +### Example 2 +```powershell +Set-UMAutoAttendant -Identity MyUMAutoAttendant -BusinessHoursSchedule 0.10:45-0.13:15,1.09:00-1.17:00,6.09:00-6.16:30 -HolidaySchedule "New Year,newyrgrt.wav,1/2/2014","Building Closed for Construction,construction.wav,4/24/2014,4/28/2014" ``` -This example configures the UM auto attendant MyUMAutoAttendant that has business hours configured to be 10:45 to 13:15 (Sunday), 09:00 to 17:00 (Monday), and 09:00 to 16:30 (Saturday) and holiday times and their associated greetings configured to be "New Year" on January 2, 2013, and "Building Closed for Construction" from April 24, 2013 through April 28, 2013. +This example configures the UM auto attendant MyUMAutoAttendant that has business hours configured to be 10:45 to 13:15 (Sunday), 09:00 to 17:00 (Monday), and 09:00 to 16:30 (Saturday) and holiday times and their associated greetings configured to be "New Year" on January 2, 2014, and "Building Closed for Construction" from April 24, 2014 through April 28, 2014. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-UMAutoAttendant -Identity MyAutoAttendant -BusinessHoursKeyMappingEnabled $true -BusinessHoursKeyMapping "1,Sales,,SalesAutoAttendant","2,Support,12345","3,Directions,,,directions.wav" ``` @@ -104,7 +108,8 @@ The Identity parameter specifies the identifier for the UM auto attendant being Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: 1 Default value: None @@ -125,7 +130,8 @@ The default value is disabled. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -141,10 +147,11 @@ The following is an example for a custom table that has two entries: "Sales, 77899","Service, 78990". ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -156,10 +163,11 @@ Accept wildcard characters: False The AfterHoursMainMenuCustomPromptEnabled parameter specifies whether the after business hours custom main menu is enabled. The default value is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -174,7 +182,8 @@ The AfterHoursMainMenuCustomPromptFilename parameter specifies the .wav file to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -186,10 +195,11 @@ Accept wildcard characters: False The AfterHoursTransferToOperatorEnabled parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -201,10 +211,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -219,7 +230,8 @@ The AfterHoursWelcomeGreetingFilename parameter specifies the .wav file to be us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -231,10 +243,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -249,7 +262,8 @@ The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/re Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -264,7 +278,8 @@ The AllowedInternationalGroups parameter specifies the list of international dia Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -276,10 +291,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -300,7 +316,8 @@ The default is disabled. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -312,10 +329,11 @@ Accept wildcard characters: False The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -327,10 +345,11 @@ Accept wildcard characters: False The BusinessHoursMainMenuCustomPromptEnabled parameter specifies whether the business hours custom main menu prompt is enabled. The default value is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -345,7 +364,8 @@ The BusinessHoursMainMenuCustomPromptFilename parameter specifies the .wav file Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -356,11 +376,33 @@ Accept wildcard characters: False ### -BusinessHoursSchedule 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"`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (From Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" +- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Run on Monday and Wednesday mornings from 4:30 until 5:30.) + ```yaml Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -372,10 +414,11 @@ Accept wildcard characters: False The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -387,10 +430,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -405,7 +449,8 @@ The BusinessHoursWelcomeGreetingFilename parameter specifies the .wav file to be Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -420,7 +465,8 @@ The BusinessLocation parameter specifies what the Mailbox server should read to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -435,7 +481,8 @@ The BusinessName parameter specifies the name of the company or organization bei Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -447,10 +494,11 @@ Accept wildcard characters: False The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -461,15 +509,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -484,7 +532,8 @@ The ContactAddressList parameter specifies the identity of the address list. If Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -499,7 +548,8 @@ The ContactRecipientContainer parameter specifies the name or identity of the co Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -511,10 +561,11 @@ Accept wildcard characters: False 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: DialPlan | GlobalAddressList | AddressList +Type: DialScopeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -523,15 +574,14 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -546,7 +596,8 @@ The DTMFFallbackAutoAttendant parameter specifies the dual tone multi-frequency Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -555,13 +606,14 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM auto attendant object is upgraded. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -573,20 +625,19 @@ Accept wildcard characters: False 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 - - File name for the audio prompt, which is in the .wav format - - Day (date) of the holiday The following is an example: -"Christmas, Christmas.wav, 12/25/2013". +"Christmas, Christmas.wav, 12/25/2014". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -598,10 +649,11 @@ Accept wildcard characters: False The InfoAnnouncementEnabled parameter specifies whether to enable the informational greeting. The default setting is $true. ```yaml -Type: True | False | Uninterruptible +Type: InfoAnnouncementEnabledEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -616,7 +668,8 @@ The InfoAnnouncementFilename parameter specifies the .wav file to be used for th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -631,7 +684,8 @@ The Language parameter specifies the language used by the UM auto attendant. Thi Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -643,22 +697,18 @@ Accept wildcard characters: False 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 - - Title - - Location - - None - - Prompt for alias - - Inherited from UM dial plan ```yaml -Type: Title | Department | Location | None | PromptForAlias | InheritFromDialPlan +Type: AutoAttendantDisambiguationFieldEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -673,7 +723,8 @@ The Name parameter specifies the display name to be used for the UM auto attenda Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -685,10 +736,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -703,7 +755,8 @@ The OperatorExtension parameter specifies the extension number of the operator. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -718,7 +771,8 @@ The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -730,10 +784,11 @@ Accept wildcard characters: False The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -745,10 +800,11 @@ Accept wildcard characters: False The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -763,7 +819,8 @@ The Timezone parameter specifies the time zone used with the auto attendant. The Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -778,7 +835,8 @@ The Timezone parameter specifies the time zone used with the auto attendant. The Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -793,7 +851,8 @@ The TimeZoneName parameter specifies all or part of a MicrosoftWindows time zone Type: UMTimeZone Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -805,10 +864,11 @@ Accept wildcard characters: False 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: Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday +Type: DayOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -823,7 +883,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -832,20 +893,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/7c7dbe5a-adc0-419a-89f7-7a0ef1482790.aspx) diff --git a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md new file mode 100644 index 0000000000..f5a3f24afa --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md @@ -0,0 +1,386 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UMCallAnsweringRule + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UMCallAnsweringRule cmdlet to change properties of an existing UM call answering rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UMCallAnsweringRule [-Identity] <UMCallAnsweringRuleIdParameter> + [-CallerIds <MultiValuedProperty>] + [-CallersCanInterruptGreeting <Boolean>] + [-CheckAutomaticReplies <Boolean>] + [-Confirm] + [-DomainController <Fqdn>] + [-ExtensionsDialed <MultiValuedProperty>] + [-KeyMappings <MultiValuedProperty>] + [-Mailbox <MailboxIdParameter>] + [-Name <String>] + [-Priority <Int32>] + [-ScheduleStatus <Int32>] + [-TimeOfDay <TimeOfDay>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Set-UMCallAnsweringRule cmdlet changes the properties of an existing UM call answering rule stored in a UM enabled user's mailbox. You can use the Set-UMCallAnsweringRule cmdlet to specify the following conditions: + +- Who the incoming call is from +- Time of day +- Calendar free/busy status +- Whether automatic replies are turned on for email + +You can also specify the following actions: + +- Find me +- Transfer the caller to someone else +- Leave a voice message + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-UMCallAnsweringRule -Mailbox tonysmith -Name MyCallAnsweringRule -Priority 2 +``` + +This example sets the priority to 2 on the existing call answering rule MyCallAnsweringRule that exists in the mailbox for tonysmith. + +### Example 2 +```powershell +Set-UMCallAnsweringRule -Name MyCallAnsweringRule -CallerIds "1,4255550100,,","1,4255550123,," -Priority 2 -CallersCanInterruptGreeting $true -Mailbox tonysmith +``` + +This example performs the following actions on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith: + +- Sets the call answering rule to two caller IDs. +- Sets the priority of the call answering rule to 2. +- Sets the call answering rule to allow callers to interrupt the greeting. + +### Example 3 +```powershell +Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith@contoso.com -ScheduleStatus 0x8 +``` + +This example changes the free/busy status to Out of Office on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith and sets the priority to 2. + +### Example 4 +```powershell +Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -ScheduleStatus 0x4 -KeyMappings "1,1,Receptionist,,,,,45678,","5,2,Urgent Issues,23456,23,45671,50,," +``` + +This example performs the following actions on the call answering rule MyCallAnsweringRule in the mailbox tonysmith: + +- 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: + +- 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. + +### Example 5 +```powershell +Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "1,0,," +``` + +This example performs the following actions on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith: + +- Sets the priority of the call answering rule to 2. +- If the caller reaches voice mail during working hours, the caller is asked to call back later. + +### Example 6 +```powershell +Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "3,4,8:00,12:00" +``` + +This example sets a custom period for the time of day on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith and performs the following actions: + +- Sets the priority of the call answering rule to 2. +- If the caller reaches voice mail and the time is between 8:00 A.M. and 12:00 P.M. on Tuesday, ask the caller to call back later. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CallerIds +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallersCanInterruptGreeting +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckAutomaticReplies +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionsDialed +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyMappings +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 +Default value: None +Accept pipeline input: False +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the mailbox of the user who is running the command is used. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStatus +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 +- Free = 0x1 +- Tentative = 0x2 +- Busy = 0x4 +- OutOfOffice = 0x8 + +The default setting is $null. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeOfDay +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md new file mode 100644 index 0000000000..e2d42d19d4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md @@ -0,0 +1,269 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UMCallRouterSettings + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UMCallRouterSettings cmdlet to modify the configuration of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UMCallRouterSettings [[-Server] <ServerIdParameter>] + [-Confirm] + [-DialPlans <MultiValuedProperty>] + [-DomainController <Fqdn>] + [-IPAddressFamily <IPAddressFamily>] + [-IPAddressFamilyConfigurable <Boolean>] + [-MaxCallsAllowed <Int32>] + [-SipTcpListeningPort <Int32>] + [-SipTlsListeningPort <Int32>] + [-UMStartupMode <UMStartupMode>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-UMCallRouterSettings -DialPlans MySIPDialPlan -IPAddressFamily Any -Server MyUMCallRouter.northwindtraders.com -UMStartupMode TLS +``` + +This example creates the following configuration on the Exchange server named MyUMCallRouter: + +- Adds the server to the UM SIP dial plan MySIPDialPlan. +- Enables the Microsoft Exchange Unified Messaging Call Router service to accept both IPv4 and IPv6 data packets. +- Sets the maximum number of incoming voice, fax, auto attendant and Outlook Voice Access calls to 150. +- Enables the Microsoft Exchange Unified Messaging Call Router service to start up using TLS mode. + +### Example 2 +```powershell +Set-UMCallRouterSettings -DialPlans $null -Server UMCallRouter001.contoso.com +``` + +This example removes the Exchange server named UMCallRouter001 from all UM SIP dial plans. + +## PARAMETERS + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DialPlans +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"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: IPAddressFamily +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressFamilyConfigurable +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCallsAllowed +This parameter has been deprecated and is no longer used. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SipTcpListeningPort +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SipTlsListeningPort +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMStartupMode +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/unified-messaging/Set-UMDialPlan.md b/exchange/exchange-ps/exchange/Set-UMDialPlan.md similarity index 76% rename from exchange/exchange-ps/exchange/unified-messaging/Set-UMDialPlan.md rename to exchange/exchange-ps/exchange/Set-UMDialPlan.md index 2916f521ee..0255771570 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/Set-UMDialPlan.md @@ -1,78 +1,112 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-umdialplan +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMDialPlan schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-UMDialPlan ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. -Use the Set-UMDialplan cmdlet to set various properties on a Unified Messaging (UM) dial plan. +Use the Set-UMDialPlan cmdlet to set various properties on a Unified Messaging (UM) dial plan. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-UMDialPlan [-Identity] <UMDialPlanIdParameter> [-AccessTelephoneNumbers <MultiValuedProperty>] - [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] - [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] - [-AllowHeuristicADCallingLineIdResolution <$true | $false>] [-AudioCodec <G711 | Wma | Gsm | Mp3>] - [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringRulesEnabled <$true | $false>] - [-CallSomeoneEnabled <$true | $false>] [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>] - [-ConfiguredInternationalGroups <MultiValuedProperty>] [-Confirm] - [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] - [-ContactScope <DialPlan | GlobalAddressList | Extension | AutoAttendantLink | AddressList>] - [-CountryOrRegionCode <String>] [-DefaultLanguage <UMLanguage>] [-DefaultOutboundCallingLineId <String>] - [-DialByNamePrimary <LastFirst | FirstLast | SMTPAddress>] - [-DialByNameSecondary <LastFirst | FirstLast | SMTPAddress | None>] [-DomainController <Fqdn>] - [-EquivalentDialPlanPhoneContexts <MultiValuedProperty>] [-Extension <String>] [-FaxEnabled <$true | $false>] - [-ForceUpgrade] [-InCountryOrRegionNumberFormat <NumberFormat>] - [-InfoAnnouncementEnabled <True | False | Uninterruptible>] [-InfoAnnouncementFilename <String>] - [-InputFailuresBeforeDisconnect <Int32>] [-InternationalAccessCode <String>] - [-InternationalNumberFormat <NumberFormat>] [-LegacyPromptPublishingPoint <String>] +Set-UMDialPlan [-Identity] <UMDialPlanIdParameter> + [-AccessTelephoneNumbers <MultiValuedProperty>] + [-AllowDialPlanSubscribers <Boolean>] + [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] + [-AllowedInternationalGroups <MultiValuedProperty>] + [-AllowExtensions <Boolean>] + [-AllowHeuristicADCallingLineIdResolution <Boolean>] + [-AudioCodec <AudioCodecEnum>] + [-AutomaticSpeechRecognitionEnabled <Boolean>] + [-CallAnsweringRulesEnabled <Boolean>] + [-CallSomeoneEnabled <Boolean>] + [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>] + [-ConfiguredInternationalGroups <MultiValuedProperty>] + [-Confirm] + [-ContactAddressList <AddressListIdParameter>] + [-ContactRecipientContainer <OrganizationalUnitIdParameter>] + [-ContactScope <CallSomeoneScopeEnum>] + [-CountryOrRegionCode <String>] + [-DefaultLanguage <UMLanguage>] + [-DialByNamePrimary <DialByNamePrimaryEnum>] + [-DialByNameSecondary <DialByNameSecondaryEnum>] + [-DomainController <Fqdn>] + [-EquivalentDialPlanPhoneContexts <MultiValuedProperty>] + [-Extension <String>] + [-FaxEnabled <Boolean>] + [-ForceUpgrade] + [-InCountryOrRegionNumberFormat <NumberFormat>] + [-InfoAnnouncementEnabled <InfoAnnouncementEnabledEnum>] + [-InfoAnnouncementFilename <String>] + [-InputFailuresBeforeDisconnect <Int32>] + [-InternationalAccessCode <String>] + [-InternationalNumberFormat <NumberFormat>] + [-LegacyPromptPublishingPoint <String>] [-LogonFailuresBeforeDisconnect <Int32>] - [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias>] - [-MaxCallDuration <Int32>] [-MaxRecordingDuration <Int32>] [-Name <String>] [-NationalNumberPrefix <String>] - [-NumberingPlanFormats <MultiValuedProperty>] [-OperatorExtension <String>] [-OutsideLineAccessCode <String>] - [-PilotIdentifierList <MultiValuedProperty>] [-RecordingIdleTimeout <Int32>] - [-SendVoiceMsgEnabled <$true | $false>] [-TUIPromptEditingEnabled <$true | $false>] - [-UMAutoAttendant <UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured | Unsecured | Secured>] - [-WelcomeGreetingEnabled <$true | $false>] [-WelcomeGreetingFilename <String>] [-WhatIf] [<CommonParameters>] + [-MatchedNameSelectionMethod <DisambiguationFieldEnum>] + [-MaxCallDuration <Int32>] + [-MaxRecordingDuration <Int32>] + [-Name <String>] + [-NationalNumberPrefix <String>] + [-NumberingPlanFormats <MultiValuedProperty>] + [-OperatorExtension <String>] + [-OutsideLineAccessCode <String>] + [-PilotIdentifierList <MultiValuedProperty>] + [-RecordingIdleTimeout <Int32>] + [-SendVoiceMsgEnabled <Boolean>] + [-TUIPromptEditingEnabled <Boolean>] + [-UMAutoAttendant <UMAutoAttendantIdParameter>] + [-VoIPSecurity <UMVoIPSecurityType>] + [-WelcomeGreetingEnabled <Boolean>] + [-WelcomeGreetingFilename <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -The Set-UMDialplan cmdlet changes or modifies the properties of an existing UM dial plan. Some UM dial plan properties are required and are created by default. However, in some cases, after the UM dial plan is created, not all properties for the UM dial plan are writable. Therefore, some of the properties can't be changed unless the existing UM dial plan is deleted and a new one is created. +The Set-UMDialPlan cmdlet changes or modifies the properties of an existing UM dial plan. Some UM dial plan properties are required and are created by default. However, in some cases, after the UM dial plan is created, not all properties for the UM dial plan are writable. Therefore, some of the properties can't be changed unless the existing UM dial plan is deleted and a new one is created. UM dial plans are important to the operation of Unified Messaging. Modifications to an existing UM dial plan should be performed by an administrator who understands the implications of changes to UM dial plans. 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-UMDialplan -Identity MyDialPlan -OutsideLineAccessCode 9 +### Example 1 +```powershell +Set-UMDialPlan -Identity MyDialPlan -OutsideLineAccessCode 9 ``` This example configures the UM dial plan MyDialPlan to use 9 for the outside line access code. -### -------------------------- Example 2 -------------------------- -``` -Set-UMDialplan -Identity MyDialPlan -WelcomeGreetingEnabled $true -WelcomeGreetingFilename welcome.wav +### Example 2 +```powershell +Set-UMDialPlan -Identity MyDialPlan -WelcomeGreetingEnabled $true -WelcomeGreetingFilename welcome.wav ``` This example configures the UM dial plan MyDialPlan to use a welcome greeting. -### -------------------------- Example 3 -------------------------- -``` -$csv=import-csv "C:\MyInCountryGroups.csv"; Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryOrRegionGroups $csv; Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryOrRegionGroups "local, long distance" +### Example 3 +```powershell +$csv=import-csv "C:\MyInCountryGroups.csv" + +Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryOrRegionGroups $csv + +Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryOrRegionGroups "local, long distance" ``` This example configures the UM dial plan MyDialPlan with dialing rules. @@ -86,7 +120,8 @@ The Identity parameter specifies the UM dial plan ID. This parameter is the dire Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: 1 Default value: None @@ -101,7 +136,8 @@ The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot n Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -113,10 +149,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -131,7 +168,8 @@ The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/re Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -146,7 +184,8 @@ The AllowedInternationalGroups parameter specifies the list of international dia Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -158,10 +197,11 @@ Accept wildcard characters: False The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -173,10 +213,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -188,10 +229,11 @@ Accept wildcard characters: False The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting. ```yaml -Type: G711 | Wma | Gsm | Mp3 +Type: AudioCodecEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -203,10 +245,11 @@ Accept wildcard characters: False The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -218,10 +261,11 @@ Accept wildcard characters: False The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -233,10 +277,11 @@ Accept wildcard characters: False The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -248,18 +293,16 @@ Accept wildcard characters: False The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups that can be used. Each string consists of four parts: - Group name (up to 32 characters) - - AllowedNumberString - - DialNumberString - - TextComment ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -271,18 +314,16 @@ Accept wildcard characters: False The ConfiguredInternationalGroups parameter specifies the international groups that can be used. Each string consists of four parts: - Group name (up to 32 characters) - - AllowedNumberString - - DialNumberString - - TextComment ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -293,15 +334,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -316,7 +357,8 @@ The ContactAddressList parameter specifies the identity of the address list. If Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -331,7 +373,8 @@ The ContactRecipientContainer parameter specifies the name or identity of the co Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -343,10 +386,11 @@ Accept wildcard characters: False 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: DialPlan | GlobalAddressList | Extension | AutoAttendantLink | AddressList +Type: CallSomeoneScopeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -361,7 +405,8 @@ The CountryOrRegionCode parameter specifies the country or region code that prec Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -376,24 +421,8 @@ The DefaultLanguage parameter specifies the default language of the system. This Type: UMLanguage 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 -``` +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -### -DefaultOutboundCallingLineId -This parameter is available or functional only in Exchange Server 2010. - -The DefaultOutboundCallingLineId parameter specifies the phone number that a Unified Messaging server would use as the calling line ID when placing an outbound call. By default, this is set to $null and only the extension number of the UM-enabled user that places the outbound call is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named Default value: None @@ -405,10 +434,11 @@ Accept wildcard characters: False 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: LastFirst | FirstLast | SMTPAddress +Type: DialByNamePrimaryEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -420,10 +450,11 @@ Accept wildcard characters: False 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: LastFirst | FirstLast | SMTPAddress | None +Type: DialByNameSecondaryEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -432,15 +463,14 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -455,7 +485,8 @@ The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalen Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -470,7 +501,8 @@ The Extension parameter specifies the extension number used by the Call Someone Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -482,10 +514,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -494,13 +527,14 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM dial plan object is upgraded. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -515,7 +549,8 @@ The InCountryOrRegionNumberFormat parameter specifies the prefix string to use a Type: NumberFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -527,10 +562,11 @@ Accept wildcard characters: False 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: True | False | Uninterruptible +Type: InfoAnnouncementEnabledEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -545,7 +581,8 @@ The InfoAnnouncementFilename parameter specifies the audio file name for an info Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -560,7 +597,8 @@ The InputFailuresBeforeDisconnect parameter specifies the number of sequential u Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -575,7 +613,8 @@ The InternationalAccessCode parameter specifies the code that precedes a telepho Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -590,7 +629,8 @@ The InternationalNumberFormat parameter specifies the prefix string to use and t Type: NumberFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -605,7 +645,8 @@ The LegacyPromptPublishingPoint parameter was used to specify the location of th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -620,7 +661,8 @@ The LogonFailuresBeforeDisconnect parameter specifies the number of sequential u Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -632,20 +674,17 @@ Accept wildcard characters: False 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 - - Department - - Location - - None - - PromptForAlias ```yaml -Type: Title | Department | Location | None | PromptForAlias +Type: DisambiguationFieldEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -660,7 +699,8 @@ The MaxCallDuration parameter specifies the maximum length of time that a call c Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -675,7 +715,8 @@ The MaxRecordingDuration parameter specifies the maximum length of time that mes Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -690,7 +731,8 @@ The Name parameter specifies the display name to use for the UM dial plan. This Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -705,7 +747,8 @@ The NationalNumberPrefix parameter specifies the dialing code that precedes a te Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -720,7 +763,8 @@ The NumberingPlanFormats parameter specifies one or more phone number masks that Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -735,7 +779,8 @@ The OperatorExtension parameter specifies the extension number of the operator. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -750,7 +795,8 @@ The OutsideLineAccessCode parameter specifies the code that precedes a telephone Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -765,7 +811,8 @@ The PilotIdentifierList parameter specifies the pilot numbers configured on the Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -780,7 +827,8 @@ The RecordingIdleTimeout parameter specifies the length of time that a caller ca Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -792,10 +840,11 @@ Accept wildcard characters: False The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -807,10 +856,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -825,7 +875,8 @@ The UMAutoAttendant parameter specifies the auto attendant run when the caller p Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -834,15 +885,14 @@ Accept wildcard characters: False ``` ### -VoIPSecurity -This parameter is available only in on-premises Exchange. - 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: SIPSecured | Unsecured | Secured +Type: UMVoIPSecurityType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -854,10 +904,11 @@ Accept wildcard characters: False The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -872,7 +923,8 @@ The WelcomeGreetingFilename parameter specifies the audio file name for the welc Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -887,7 +939,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -896,20 +949,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/bf6cbfde-35aa-4a03-86b0-50e2c3664eeb.aspx) diff --git a/exchange/exchange-ps/exchange/Set-UMIPGateway.md b/exchange/exchange-ps/exchange/Set-UMIPGateway.md new file mode 100644 index 0000000000..af9d1ffda1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UMIPGateway.md @@ -0,0 +1,332 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UMIPGateway + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UMIPGateway cmdlet to modify the configuration settings for a single Unified Messaging (UM) IP gateway or to return a list of configuration settings that can be modified on a specified UM IP gateway. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UMIPGateway [-Identity] <UMIPGatewayIdParameter> + [-Address <UMSmartHost>] + [-Confirm] + [-DelayedSourcePartyInfoEnabled <Boolean>] + [-DomainController <Fqdn>] + [-ForceUpgrade] + [-IPAddressFamily <IPAddressFamily>] + [-MessageWaitingIndicatorAllowed <Boolean>] + [-Name <String>] + [-OutcallsAllowed <Boolean>] + [-Port <Int32>] + [-Simulator <Boolean>] + [-Status <GatewayStatus>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 +``` + +This example modifies the IP address of the UM IP gateway MyUMIPGateway. + +### Example 2 +```powershell +Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -Status Disabled -OutcallsAllowed $false +``` + +This example prevents the UM IP gateway from accepting incoming calls and prevents outgoing calls. + +### Example 3 +```powershell +Set-UMIPGateway -Identity MyUMIPGateway -Address fe80::39bd:88f7:6969:d223%11 -IPAddressFamily Any -Status Disabled -OutcallsAllowed $false +``` + +This example prevents the UM IP gateway MyUMIPGateway from accepting incoming calls and outgoing calls, sets an IPv6 address, and allows the UM IP gateway to use IPv4 and IPv6 addresses. + +### Example 4 +```powershell +Set-UMIPGateway -Identity MyUMIPGateway -Simulator $true +``` + +This example enables the UM IP gateway to function as an IP gateway simulator and can be used with the Test-UMConnectivity cmdlet. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +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. + +```yaml +Type: UMSmartHost +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelayedSourcePartyInfoEnabled +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: IPAddressFamily +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageWaitingIndicatorAllowed +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutcallsAllowed +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Simulator +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status parameter specifies whether to enable or disable the UM IP gateway. Valid values are: + +- Enabled +- Disabled +- NoNewCalls + +```yaml +Type: GatewayStatus +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-UMMailbox.md b/exchange/exchange-ps/exchange/Set-UMMailbox.md new file mode 100644 index 0000000000..7e179f4bc5 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UMMailbox.md @@ -0,0 +1,496 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UMMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UMMailbox cmdlet to set the Unified Messaging (UM) properties for a user who is currently UM-enabled. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UMMailbox [-Identity] <MailboxIdParameter> + [-AllowUMCallsFromNonUsers <AllowUMCallsFromNonUsersFlags>] + [-AnonymousCallersCanLeaveMessages <Boolean>] + [-AutomaticSpeechRecognitionEnabled <Boolean>] + [-CallAnsweringAudioCodec <AudioCodecEnum>] + [-CallAnsweringRulesEnabled <Boolean>] + [-Confirm] + [-DomainController <Fqdn>] + [-FaxEnabled <Boolean>] + [-IgnoreDefaultScope] + [-ImListMigrationCompleted <Boolean>] + [-MissedCallNotificationEnabled <Boolean>] + [-Name <String>] + [-OperatorNumber <String>] + [-PinlessAccessToVoiceMailEnabled <Boolean>] + [-PlayOnPhoneEnabled <Boolean>] + [-SubscriberAccessEnabled <Boolean>] + [-TUIAccessToCalendarEnabled <Boolean>] + [-TUIAccessToEmailEnabled <Boolean>] + [-UMMailboxPolicy <MailboxPolicyIdParameter>] + [-UMSMSNotificationOption <UMSMSNotificationOptions>] + [-VoiceMailAnalysisEnabled <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-UMMailbox -Identity tony@contoso.com -CallAnsweringAudioCodec Wma -CallAnsweringRulesEnabled $false -FaxEnabled $false -UMSMSNotificationOption VoiceMail +``` + +This example configures a UM-enabled user, tony@contoso.com with the following settings: + +Changes the call answering audio codec to Wma + +Disables call answering rules + +Prevents him from receiving incoming faxes + +Enables voice mail notifications but not missed call notifications using text messaging + +### Example 2 +```powershell +Set-UMMailbox -Identity tony@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false +``` + +This example prevents the user tony@contoso.com from accessing his calendar and email when he's using Outlook Voice Access. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllowUMCallsFromNonUsers +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnonymousCallersCanLeaveMessages +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticSpeechRecognitionEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallAnsweringAudioCodec +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallAnsweringRulesEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FaxEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImListMigrationCompleted +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. + +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MissedCallNotificationEnabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorNumber +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinlessAccessToVoiceMailEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlayOnPhoneEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriberAccessEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TUIAccessToCalendarEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TUIAccessToEmailEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMMailboxPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMSMSNotificationOption +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md b/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md new file mode 100644 index 0000000000..bec81a4cf6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md @@ -0,0 +1,286 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UMMailboxPIN + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UMMailboxPIN cmdlet to reset the PIN for a Unified Messaging (UM)-enabled mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UMMailboxPIN [-Identity] <MailboxIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-IgnoreDefaultScope] + [-LockedOut <Boolean>] + [-NotifyEmail <String>] + [-Pin <String>] + [-PINExpired <Boolean>] + [-SendEmail <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Set-UMMailboxPIN -Identity 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. + +### 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. + +### 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. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 Server 2010, Exchange Server 2013, Exchange Server 2016 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmail +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pin +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PINExpired +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmail +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PINExpired +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/unified-messaging/Set-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/unified-messaging/Set-UMMailboxPolicy.md rename to exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md index 761df9ee91..789aabc713 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md @@ -1,44 +1,76 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpolicy +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMMailboxPolicy schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-UMMailboxPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Set-UMMailboxPolicy cmdlet to modify a Unified Messaging (UM) mailbox policy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-UMMailboxPolicy [-Identity] <MailboxPolicyIdParameter> [-AllowAutomaticSpeechRecognition <$true | $false>] - [-AllowCallAnsweringRules <$true | $false>] [-AllowCommonPatterns <$true | $false>] - [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] - [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] - [-AllowFax <$true | $false>] [-AllowMessageWaitingIndicator <$true | $false>] - [-AllowMissedCallNotifications <$true | $false>] [-AllowPinlessVoiceMailAccess <$true | $false>] - [-AllowPlayOnPhone <$true | $false>] [-AllowSMSNotification <$true | $false>] - [-AllowSubscriberAccess <$true | $false>] [-AllowTUIAccessToCalendar <$true | $false>] - [-AllowTUIAccessToDirectory <$true | $false>] [-AllowTUIAccessToEmail <$true | $false>] - [-AllowTUIAccessToPersonalContacts <$true | $false>] [-AllowVoiceMailAnalysis <$true | $false>] - [-AllowVoiceMailPreview <$true | $false>] [-AllowVoiceResponseToOtherMessageTypes <$true | $false>] [-Confirm] - [-DomainController <Fqdn>] [-FaxMessageText <String>] [-FaxServerURI <String>] [-ForceUpgrade] - [-InformCallerOfVoiceMailAnalysis <$true | $false>] [-LogonFailuresBeforePINReset <Unlimited>] - [-MaxGreetingDuration <Int32>] [-MaxLogonAttempts <Unlimited>] [-MinPINLength <Int32>] [-Name <String>] - [-PINHistoryCount <Int32>] [-PINLifetime <Unlimited>] [-ProtectAuthenticatedVoiceMail <None | Private | All>] - [-ProtectedVoiceMailText <String>] [-ProtectUnauthenticatedVoiceMail <None | Private | All>] - [-RequireProtectedPlayOnPhone <$true | $false>] [-ResetPINText <String>] - [-SourceForestPolicyNames <MultiValuedProperty>] [-UMDialPlan <UMDialPlanIdParameter>] - [-UMEnabledText <String>] [-VoiceMailPreviewPartnerAddress <SmtpAddress>] - [-VoiceMailPreviewPartnerAssignedID <String>] [-VoiceMailPreviewPartnerMaxDeliveryDelay <Int32>] - [-VoiceMailPreviewPartnerMaxMessageDuration <Int32>] [-VoiceMailText <String>] [-WhatIf] [<CommonParameters>] +Set-UMMailboxPolicy [-Identity] <MailboxPolicyIdParameter> + [-AllowAutomaticSpeechRecognition <Boolean>] + [-AllowCallAnsweringRules <Boolean>] + [-AllowCommonPatterns <Boolean>] + [-AllowDialPlanSubscribers <Boolean>] + [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] + [-AllowedInternationalGroups <MultiValuedProperty>] + [-AllowExtensions <Boolean>] + [-AllowFax <Boolean>] + [-AllowMessageWaitingIndicator <Boolean>] + [-AllowMissedCallNotifications <Boolean>] + [-AllowPinlessVoiceMailAccess <Boolean>] + [-AllowPlayOnPhone <Boolean>] + [-AllowSMSNotification <Boolean>] + [-AllowSubscriberAccess <Boolean>] + [-AllowTUIAccessToCalendar <Boolean>] + [-AllowTUIAccessToDirectory <Boolean>] + [-AllowTUIAccessToEmail <Boolean>] + [-AllowTUIAccessToPersonalContacts <Boolean>] + [-AllowVoiceMailAnalysis <Boolean>] + [-AllowVoiceMailPreview <Boolean>] + [-AllowVoiceResponseToOtherMessageTypes <Boolean>] + [-Confirm] + [-DomainController <Fqdn>] + [-FaxMessageText <String>] + [-FaxServerURI <String>] + [-ForceUpgrade] + [-InformCallerOfVoiceMailAnalysis <Boolean>] + [-LogonFailuresBeforePINReset <Unlimited>] + [-MaxGreetingDuration <Int32>] + [-MaxLogonAttempts <Unlimited>] + [-MinPINLength <Int32>] + [-Name <String>] + [-PINHistoryCount <Int32>] + [-PINLifetime <Unlimited>] + [-ProtectAuthenticatedVoiceMail <DRMProtectionOptions>] + [-ProtectedVoiceMailText <String>] + [-ProtectUnauthenticatedVoiceMail <DRMProtectionOptions>] + [-RequireProtectedPlayOnPhone <Boolean>] + [-ResetPINText <String>] + [-SourceForestPolicyNames <MultiValuedProperty>] + [-UMDialPlan <UMDialPlanIdParameter>] + [-UMEnabledText <String>] + [-VoiceMailPreviewPartnerAddress <SmtpAddress>] + [-VoiceMailPreviewPartnerAssignedID <String>] + [-VoiceMailPreviewPartnerMaxDeliveryDelay <Int32>] + [-VoiceMailPreviewPartnerMaxMessageDuration <Int32>] + [-VoiceMailText <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -46,26 +78,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### 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." ``` This example sets the PIN settings for users associated with the UM mailbox policy MyUMMailboxPolicy. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-UMMailboxPolicy -Identity MyUMMailboxPolicy -AllowDialPlanSubscribers $true -AllowedInCountryOrRegionGroups InCountry/RegionGroup1,InCountry/RegionGroup2 -AllowedInternationalGroups InternationalGroup1,InternationalGroup2 -AllowExtensions $true ``` This example selects the in-country or region groups and international groups from those configured on the UM dial plan associated with the UM mailbox policy. UM-enabled users associated with this UM mailbox policy can place outbound calls according to the rules defined on these groups. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-UMMailboxPolicy -Identity MyUMMailboxPolicy -UMEnabledText "You have been enabled for Unified Messaging." -VoiceMailText "You have received a voice mail message from Microsoft Exchange Unified Messaging." ``` @@ -80,7 +112,8 @@ The Identity parameter specifies the identifier for the UM mailbox policy being Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: 1 Default value: None @@ -92,10 +125,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -107,10 +141,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -122,10 +157,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -137,10 +173,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -155,7 +192,8 @@ The AllowedInCountryOrRegionGroups parameter specifies whether to let subscriber Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -170,7 +208,8 @@ The AllowedInternationalGroups parameter specifies whether to let subscribers di Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -182,10 +221,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -197,10 +237,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -212,10 +253,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -229,10 +271,11 @@ The AllowMissedCallNotifications parameter specifies whether missed call notific 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -244,10 +287,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -259,10 +303,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -274,10 +319,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -289,10 +335,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -304,10 +351,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -319,10 +367,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -334,10 +383,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -349,10 +399,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -364,10 +415,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -379,10 +431,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -394,10 +447,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -408,15 +462,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -425,15 +479,14 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -448,7 +501,8 @@ The FaxMessageText parameter specifies the text included in the body part of fax Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -457,13 +511,14 @@ Accept wildcard characters: False ``` ### -FaxServerURI -The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Server 2016 Mailbox servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI will be used by Mailbox servers running UM services. +The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Unified Messaging servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI will be used by the Unified Messaging server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -472,13 +527,14 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -490,10 +546,11 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -508,7 +565,8 @@ The LogonFailuresBeforePINReset parameter specifies the number of sequential uns Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -523,7 +581,8 @@ The MaxGreetingDuration parameter specifies the maximum greeting length. The ran Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -538,7 +597,8 @@ The MaxLogonAttempts parameter specifies the number of times users can try unsuc Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -553,7 +613,8 @@ The MinPINLength parameter specifies the minimum number of digits required in a Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -568,7 +629,8 @@ The Name parameter specifies the display name for the UM mailbox policy. This se Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -583,7 +645,8 @@ The PINHistoryCount parameter specifies the number of previous PINs that are rem Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -598,7 +661,8 @@ The PINLifetime parameter specifies the number of days until a new password is r Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -610,10 +674,11 @@ Accept wildcard characters: False 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: None | Private | All +Type: DRMProtectionOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -628,7 +693,8 @@ The ProtectedVoiceMailText parameter specifies the text included in the body par Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -640,10 +706,11 @@ Accept wildcard characters: False 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: None | Private | All +Type: DRMProtectionOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -655,10 +722,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -673,7 +741,8 @@ The ResetPINText parameter specifies the text to be included in the PIN reset em Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -688,7 +757,8 @@ The SourceForestPolicyNames parameter specifies the name or names of the corresp Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -703,7 +773,8 @@ The UMDialPlan parameter specifies the UM dial plan associated with the UM mailb Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -718,7 +789,8 @@ The UMEnabledText parameter specifies the text to be included when a user is ena Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -733,7 +805,8 @@ The VoiceMailPreviewPartnerAddress parameter specifies the SMTP address of a Voi Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -748,7 +821,8 @@ The VoiceMailPreviewPartnerAssignedID parameter specifies the identification str Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -763,7 +837,8 @@ The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of se Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -778,7 +853,8 @@ The VoiceMailPreviewPartnerMaxMessageDuration parameter specifies the maximum du Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -793,7 +869,8 @@ The VoiceMailText parameter specifies the text to be included in the body part o Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -808,7 +885,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -817,20 +895,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/df67ae65-cfae-4f52-9d12-19f863808705.aspx) diff --git a/exchange/exchange-ps/exchange/Set-UMService.md b/exchange/exchange-ps/exchange/Set-UMService.md new file mode 100644 index 0000000000..51772cc547 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UMService.md @@ -0,0 +1,451 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UMService + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UMService cmdlet to modify the properties of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UMService [-Identity] <UMServerIdParameter> + [-Confirm] + [-DialPlans <MultiValuedProperty>] + [-DomainController <Fqdn>] + [-GrammarGenerationSchedule <ScheduleInterval[]>] + [-IPAddressFamily <IPAddressFamily>] + [-IPAddressFamilyConfigurable <Boolean>] + [-IrmLogEnabled <Boolean>] + [-IrmLogMaxAge <EnhancedTimeSpan>] + [-IrmLogMaxDirectorySize <Unlimited>] + [-IrmLogMaxFileSize <ByteQuantifiedSize>] + [-IrmLogPath <LocalLongFullPath>] + [-MaxCallsAllowed <Int32>] + [-SIPAccessService <ProtocolConnectionSettings>] + [-Status <ServerStatus>] + [-UMStartupMode <UMStartupMode>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-UMService -Identity MyUMServer -IPAddressFamily Any -UMStartupMode Dual +``` + +This example performs the following actions: + +- Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to accept both IPv4 and IPv6 data packets. +- Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to start up using both TCP and TLS mode. + +### Example 2 +```powershell +Set-UMService -Identity MyUMServer -DialPlans $null +``` + +This example removes the Mailbox server MyUMServer from all UM dial plans. + +### Example 3 +```powershell +Set-UMService -Identity MyUMServer -DialPlans MySIPDialPlan -MaxCallsAllowed 50 -SipAccessService northamerica.lyncpoolna.contoso.com:5061 -UMStartupMode TLS +``` + +This example performs the following actions: + +- Adds the Mailbox server MyUMServer to the UM dial plan MySIPDialPlan. +- Sets the maximum number of incoming calls to 50. +- Sets northamerica.lyncpoolna.contoso.com:5061 as the FQDN and port for the SIP access service that is used by Microsoft Lync Server or Skype for Business Server for inbound and outbound calling from remote Lync or Skype for Business clients. +- Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to start up in TLS mode. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +```yaml +Type: UMServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DialPlans +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. + +You can also use this parameter to associate Exchange 2010 Unified Messaging servers to a UM dial plan. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrammarGenerationSchedule +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"`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" +- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Run on Monday and Wednesday mornings from 4:30 until 5:30.) + +```yaml +Type: ScheduleInterval[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: IPAddressFamily +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressFamilyConfigurable +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogEnabled +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 +- $false: Disable IRM logging + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogMaxAge +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. + +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 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogMaxDirectorySize +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) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogMaxFileSize +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) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +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. + +```yaml +Type: ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IrmLogPath +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. + +```yaml +Type: LocalLongFullPath +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCallsAllowed +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SIPAccessService +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. + +You configure this parameter for each instance of the Unified Messaging service (each Exchange server) so the value identifies the closest Lync Server Front End pool or Skype for Business Server Front End pool to the Exchange server. + +```yaml +Type: ProtocolConnectionSettings +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +This parameter has been deprecated and is no longer used. + +```yaml +Type: ServerStatus +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMStartupMode +The UMStartupMode parameter specifies the startup mode for the Unified Messaging service. Valid values are: + +- TCP (This is the 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. + +If you change the value of this parameter, you need to restart the Unified Messaging service. + +```yaml +Type: UMStartupMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/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/unified-messaging/Set-UmServer.md b/exchange/exchange-ps/exchange/Set-UmServer.md similarity index 78% rename from exchange/exchange-ps/exchange/unified-messaging/Set-UmServer.md rename to exchange/exchange-ps/exchange/Set-UmServer.md index 60c54f1b3f..6fa2f340bf 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UmServer.md +++ b/exchange/exchange-ps/exchange/Set-UmServer.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-UMServer @@ -13,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-UMServer cmdlet to modify settings that are associated with the Unified Messaging (UM) server role. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,7 +27,7 @@ Set-UMServer [-Identity] <UMServerIdParameter> [-DomainController <Fqdn>] [-ExternalServiceFqdn <UMSmartHost>] [-GrammarGenerationSchedule <ScheduleInterval[]>] - [-IrmLogEnabled <$true | $false>] + [-IrmLogEnabled <Boolean>] [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] [-IrmLogMaxFileSize <ByteQuantifiedSize>] @@ -33,9 +36,10 @@ Set-UMServer [-Identity] <UMServerIdParameter> [-SIPAccessService <ProtocolConnectionSettings>] [-SipTcpListeningPort <Int32>] [-SipTlsListeningPort <Int32>] - [-Status <Enabled | Disabled | NoNewCalls>] - [-UMStartupMode <TCP | TLS | Dual>] - [-WhatIf] [<CommonParameters>] + [-Status <ServerStatus>] + [-UMStartupMode <UMStartupMode>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -43,34 +47,34 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-UMServer -Identity MyUMServer -Status NoNewCalls ``` This example prevents the Unified Messaging server MyUMServer from accepting new calls. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-UMServer -Identity MyUMServer -DialPlans $null ``` This example removes the Unified Messaging server MyUMServer from all UM dial plans. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-UMServer -Identity MyUMServer -DialPlans MyUMDialPlanName -MaxCallsAllowed 50 ``` This example adds the Unified Messaging server MyUMServer to the UM dial plan MyUMDialPlanName and also sets the maximum number of incoming voice calls to 50. -### -------------------------- Example 4 -------------------------- -``` -Set-UMServer -Identity MyUMServer -GrammarGenerationSchedule 0.02:30-1.03:00, 1.02:30-1.03:00, 2.02:30-2.03:00, 3.02:30-3.03:00, 4.02:30-4.03:00, 5.02:30-5.03:00, 6.02:30-6.03:00 +### Example 4 +```powershell +Set-UMServer -Identity MyUMServer -GrammarGenerationSchedule 0.02:30-1.03:00,1.02:30-1.03:00,2.02:30-2.03:00,3.02:30-3.03:00,4.02:30-4.03:00,5.02:30-5.03:00,6.02:30-6.03:00 ``` This example changes the grammar generation schedule to 02:30-03:00 every day on the Unified Messaging server MyUMServer. @@ -78,13 +82,19 @@ This example changes the grammar generation schedule to 02:30-03:00 every day on ## PARAMETERS ### -Identity -The Identity parameter specifies the ID for the Unified Messaging server object to be configured. This parameter specifies the directory object ID for the Unified Messaging server. +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 +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml Type: UMServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -95,8 +105,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -104,6 +113,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -119,6 +129,7 @@ Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -134,6 +145,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -149,6 +161,7 @@ Type: UMSmartHost Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -159,11 +172,33 @@ Accept wildcard characters: False ### -GrammarGenerationSchedule 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"`. + +You can use the following values for days: + +- Full name of the day. +- Abbreviated name of the day. +- Integer from 0 through 6, where 0 = Sunday. + +You can enter the time in 24 hour format and omit the AM/PM value. If you enter the time in 12 time hour format, include a space between the time and the AM/PM value. + +You can mix and match date/time formats. + +The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. + +Here are some examples: + +- "Sun.11:30 PM-Mon.1:30 AM" +- "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) +- "Sun.1:15 AM-Monday.23:00" +- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Run on Monday and Wednesday mornings from 4:30 until 5:30.) + ```yaml Type: ScheduleInterval[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -175,14 +210,14 @@ Accept wildcard characters: False 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 - - $false Disable IRM logging ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -198,6 +233,7 @@ Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -209,13 +245,9 @@ Accept wildcard characters: False 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) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. 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. @@ -225,6 +257,7 @@ Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -236,13 +269,9 @@ Accept wildcard characters: False 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) - - KB (kilobytes) - - MB (megabytes) - - GB (gigabytes) - - TB (terabytes) Unqualified values are treated as bytes. 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. @@ -252,6 +281,7 @@ Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -267,6 +297,7 @@ Type: LocalLongFullPath Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -282,6 +313,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -290,13 +322,18 @@ Accept wildcard characters: False ``` ### -SIPAccessService -The SIPAccessService parameter specifies the FQDN and Transmission Control Protocol (TCP) port of Office Communications Server A/V Edge servers used for inbound or outbound calls from remote users located outside the network. +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. + +You configure this parameter for each Unified Messaging server so the value identifies the closest Lync Server Edge pool or Skype for Business Server Edge pool to the Exchange server. ```yaml Type: ProtocolConnectionSettings Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -312,6 +349,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -327,6 +365,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -338,10 +377,11 @@ Accept wildcard characters: False The Status parameter specifies the Unified Messaging server status. The available options are Enabled, Disabled, and NoNewCalls. ```yaml -Type: Enabled | Disabled | NoNewCalls +Type: ServerStatus Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -353,10 +393,11 @@ Accept wildcard characters: False 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. ```yaml -Type: TCP | TLS | Dual +Type: UMStartupMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -372,6 +413,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -380,20 +422,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/11faf772-d000-4cf3-8c01-47a3d4196237.aspx) diff --git a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md new file mode 100644 index 0000000000..b54bb64a99 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md @@ -0,0 +1,234 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UnifiedAuditLogRetentionPolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-UnifiedAuditLogRetentionPolicy cmdlet to modify audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UnifiedAuditLogRetentionPolicy [-Identity] <PolicyIdParameter> -Priority <Int32> -RetentionDuration <UnifiedAuditLogRetentionDuration> + [-Confirm] + [-Description <String>] + [-Operations <MultiValuedProperty>] + [-RecordTypes <MultiValuedProperty>] + [-UserIds <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/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 +Set-UnifiedAuditLogRetentionPolicy -Identity "eDiscovery audit retention" -RecordTypes Discovery,AeD -UserIds admin@contoso.onmicrosoft.com -RetentionDuration SixMonths -Priority 100 +``` + +This example adds the AeD (for eDiscovery Premium events) record type to the policy. It also configures that the policy is applied only to the audit logs for activities performed only by the user admin@contoso.onmicrosoft.com. + +### Example 2 +```powershell +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. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Priority +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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: + +- ThreeMonths +- SixMonths +- NineMonths +- TwelveMonths +- TenYears + +This parameter is required when modifying an audit log retention policy. + +```yaml +Type: UnifiedAuditLogRetentionDuration +Parameter Sets: (All) +Aliases: +Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears +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 +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +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). + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordTypes +The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://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. + +```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 +``` + +### -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. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md new file mode 100644 index 0000000000..c592fda80d --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -0,0 +1,1256 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Set-UnifiedGroup + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-UnifiedGroup cmdlet to modify Microsoft 365 Groups in your cloud-based organization. To modify members, owners, and subscribers of Microsoft 365 Groups, use the Add-UnifiedGroupLinks and Remove-UnifiedGroupLinks cmdlets. + +**Important**: You can't use this cmdlet to remove all Microsoft Online Email Routing Address (MOERA) addresses from the Microsoft 365 Group. There must be at least one MOERA address attached to a group. To learn more about MOERA addresses, see [How the proxyAddresses attribute is populated in Microsoft Entra ID](https://support.microsoft.com/help/3190357). + +For 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-UnifiedGroup [-Identity] <UnifiedGroupIdParameter> + [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] + [-AccessType <ModernGroupTypeInfo>] + [-Alias <String>] + [-AlwaysSubscribeMembersToCalendarEvents] + [-AuditLogAgeLimit <EnhancedTimeSpan>] + [-AutoSubscribeNewMembers] + [-CalendarMemberReadOnly] + [-Classification <String>] + [-Confirm] + [-ConnectorsEnabled] + [-CustomAttribute1 <String>] + [-CustomAttribute10 <String>] + [-CustomAttribute11 <String>] + [-CustomAttribute12 <String>] + [-CustomAttribute13 <String>] + [-CustomAttribute14 <String>] + [-CustomAttribute15 <String>] + [-CustomAttribute2 <String>] + [-CustomAttribute3 <String>] + [-CustomAttribute4 <String>] + [-CustomAttribute5 <String>] + [-CustomAttribute6 <String>] + [-CustomAttribute7 <String>] + [-CustomAttribute8 <String>] + [-CustomAttribute9 <String>] + [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] + [-DisplayName <String>] + [-EmailAddresses <ProxyAddressCollection>] + [-ExtensionCustomAttribute1 <MultiValuedProperty>] + [-ExtensionCustomAttribute2 <MultiValuedProperty>] + [-ExtensionCustomAttribute3 <MultiValuedProperty>] + [-ExtensionCustomAttribute4 <MultiValuedProperty>] + [-ExtensionCustomAttribute5 <MultiValuedProperty>] + [-ForceUpgrade] + [-GrantSendOnBehalfTo <MultiValuedProperty>] + [-HiddenFromAddressListsEnabled <Boolean>] + [-HiddenFromExchangeClientsEnabled] + [-InformationBarrierMode <GroupInformationBarrierMode>] + [-IsMemberAllowedToEditContent <System.Boolean>] + [-Language <CultureInfo>] + [-MailboxRegion <String>] + [-MailTip <String>] + [-MailTipTranslations <MultiValuedProperty>] + [-MaxReceiveSize <Unlimited>] + [-MaxSendSize <Unlimited>] + [-ModeratedBy <MultiValuedProperty>] + [-ModerationEnabled <Boolean>] + [-Notes <String>] + [-PrimarySmtpAddress <SmtpAddress>] + [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] + [-RequireSenderAuthenticationEnabled <Boolean>] + [-SensitivityLabelId <Sustem.Guid>] + [-SubscriptionEnabled] + [-UnifiedGroupWelcomeMessageEnabled] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Microsoft 365 Groups are group objects that are available across Microsoft 365 services. + +> [!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). + +## EXAMPLES + +### Example 1 +```powershell +Set-UnifiedGroup -Identity "Marketing Department" -PrimarySmtpAddress marketing@contoso.com -RequireSenderAuthenticationEnabled $false +``` + +This example makes the following changes to the Microsoft 365 Group named Marketing Department: + +- The primary email address is changed to marketing@contoso.com. +- The Microsoft 365 Group is allowed to receive mail from unauthenticated (external) senders. + +### Example 2 +```powershell +Set-UnifiedGroup -Identity "Legal Department" -AccessType Private +``` + +This example changes the Microsoft 365 Group named Legal Department from a public group to a private group. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AcceptMessagesOnlyFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType +The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: + +- Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. +- Private: The group content and conversations are available only to members of the group, and joining the group requires approval from a group owner. + +**Note**: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. + +```yaml +Type: ModernGroupTypeInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alias +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the 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: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlwaysSubscribeMembersToCalendarEvents +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. + +Group members can change their own subscription settings, which can override your intended use of this switch. + +The AutoSubscribeNewMembers switch overrides this switch. + +**Note**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditLogAgeLimit +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. + +For example, to specify 60 days for this parameter, use 60.00:00:00. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoSubscribeNewMembers +The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Microsoft 365 Group to conversations and calendar events. Only users that are added to the group after you enable this setting are automatically subscribed to the group. + +- To subscribe new members to conversations and calendar events, use the AutoSubscribeNewMembers switch without a value. +- If you don't want to subscribe new members to conversations and calendar events, use this exact syntax: `-AutoSubscribeNewMembers:$false`. + +**Note**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarMemberReadOnly +The CalendarMemberReadOnly switch specifies whether to set read-only Calendar permissions to the Microsoft 365 Group for members of the group. + +- To set read-only Calendar permissions, use the CalendarMemberReadOnly switch without a value. +- To remove read-only Calendar permissions, use this exact syntax: `-CalendarMemberReadOnly:$false`. + +To view the current value of the CalendarMemberReadOnly property on a Microsoft 365 Group, replace `<EmailAddress>` with the email address of the group, and run this command: `Get-UnifiedGroup -Identity <EmailAddress> -IncludeAllProperties | Format-List *Calendar*`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorsEnabled +The ConnectorsEnabled specifies whether to enable the ability to use connectors for the Microsoft 365 Group. + +- To enable connectors, use the ConnectorsEnabled switch without a value. +- To disable connectors, use this exact syntax: `-ConnectorsEnabled:$false`. + +To use this switch, the value of the ConnectorsEnabled parameter on the Set-OrganizationConfig cmdlet must be set to $true (which is the default value). + +For more information about connectors for Microsoft 365 Groups, see [Connect apps to your groups in Outlook](https://support.microsoft.com/office/ed0ce547-038f-4902-b9b3-9e518ae6fbab). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute1 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute10 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute11 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute12 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute13 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute14 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute15 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute2 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute3 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute4 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute5 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute6 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute7 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute8 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAttribute9 +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPolicy +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 +- Distinguished name (DN) +- GUID + +To remove an existing policy, use the value $null. + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddresses +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 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. + +To specify the primary SMTP email address, you can use any of the following methods: + +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. +- Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. + +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. + +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. + +```yaml +Type: ProxyAddressCollection +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute1 +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"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute2 +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"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute3 +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"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute4 +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"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionCustomAttribute5 +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"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GrantSendOnBehalfTo +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 (`<Sender> on behalf of <Microsoft 365 Group>`), 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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +By default, this parameter is blank, which means no one else has permission to send on behalf of this Microsoft 365 Group. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromAddressListsEnabled +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenFromExchangeClientsEnabled +The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Group is hidden from Outlook clients connected to Microsoft 365. + +- To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't visible in the global address list (GAL). The group name doesn't resolve during the creation of a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users can't find the group by using the Discover option in Outlook on the web. The HiddenFromAddressListsEnabled property is set to the value True to prevent the group from showing in the GAL and in the Offline Address Book (OAB). +- To disable this setting, use this exact syntax: `-HiddenFromExchangeClientsEnabled:$false`. The Microsoft 365 Group isn't hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. +- If Microsoft 365 Groups are hidden from Exchange clients, users don't see the option to subscribe or unsubscribe to a Microsoft 365 Group. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationBarrierMode +The InformationBarrierMode parameter specifies the information barrier mode for the Microsoft 365 Group. Valid values are: + +- Explicit +- Implicit +- Open +- OwnerModerated + +```yaml +Type: GroupInformationBarrierMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMemberAllowedToEditContent +{{ Fill IsMemberAllowedToEditContent Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +The Language parameter specifies language preference for the Microsoft 365 Group. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTip +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: + +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `<html><body>This mailbox is not monitored</body></html>`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:<MailTip text>`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTipTranslations +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: + +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. + +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. + +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReceiveSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSendSize +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: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) + +Unqualified values are typically treated as bytes, but small values may 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). + +Base64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModeratedBy +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationEnabled +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. + +You use the ModeratedBy parameter to specify the moderators. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySmtpAddress +The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RejectMessagesFromSendersOrMembers +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. + +To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. + +To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. + +The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. + +By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireSenderAuthenticationEnabled +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. +- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SensitivityLabelId +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. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionEnabled +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**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnifiedGroupWelcomeMessageEnabled +The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disable sending system-generated welcome messages to users who are added as members to the Microsoft 365 Group. + +- To enable this setting, you don't need to specify a value with this switch. +- To disable this setting, use this exact syntax: `-UnifiedGroupWelcomeMessageEnabled:$false`. + +This setting only controls email send by the Microsoft 365 Group. It doesn't control email sent by connected products (for example, Teams or Viva Engage). + +This setting is enabled by default. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/exchange/Set-User.md new file mode 100644 index 0000000000..09606906d6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-User.md @@ -0,0 +1,1400 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Set-User cmdlet to modify user attributes. You can use this cmdlet to modify all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-User [-Identity] <UserIdParameter> + [-AllowUMCallsFromNonUsers <AllowUMCallsFromNonUsersFlags>] + [-Arbitration] + [-AssistantName <String>] + [-AuthenticationPolicy <String>] + [-BlockCloudCache <Boolean>] + [-CanHaveCloudCache <Boolean>] + [-CertificateSubject <MultiValuedProperty>] + [-City <String>] + [-ClearDataEncryptionPolicy] + [-Company <String>] + [-Confirm] + [-CountryOrRegion <CountryInfo>] + [-CreateDTMFMap <Boolean>] + [-Department <String>] + [-DesiredWorkloads <MailboxWorkloadFlags>] + [-DisplayName <String>] + [-DomainController <Fqdn>] + [-EXOModuleEnabled <Boolean>] + [-Fax <String>] + [-FirstName <String>] + [-Force] + [-GeoCoordinates <GeoCoordinates>] + [-HomePhone <String>] + [-IgnoreDefaultScope] + [-IsShadowMailbox <Boolean>] + [-Initials <String>] + [-LastName <String>] + [-LinkedCredential <PSCredential>] + [-LinkedDomainController <String>] + [-LinkedMasterAccount <UserIdParameter>] + [-MailboxRegion <String>] + [-MailboxRegionSuffix <MailboxRegionSuffixValue>] + [-ManagedOnboardingType <ManagedOnboardingType>] + [-Manager <UserContactIdParameter>] + [-MobilePhone <String>] + [-Name <String>] + [-Notes <String>] + [-Office <String>] + [-OtherFax <MultiValuedProperty>] + [-OtherHomePhone <MultiValuedProperty>] + [-OtherTelephone <MultiValuedProperty>] + [-Pager <String>] + [-PermanentlyClearPreviousMailboxInfo] + [-Phone <String>] + [-PhoneticDisplayName <String>] + [-PostalCode <String>] + [-PostOfficeBox <MultiValuedProperty>] + [-PublicFolder] + [-RemotePowerShellEnabled <Boolean>] + [-RemoveMailboxProvisioningConstraint] + [-ResetPasswordOnNextLogon <Boolean>] + [-SamAccountName <String>] + [-SeniorityIndex <Int32>] + [-SimpleDisplayName <String>] + [-SkipDualWrite] + [-StateOrProvince <String>] + [-StreetAddress <String>] + [-StsRefreshTokensValidFrom <DateTime>] + [-TelephoneAssistant <String>] + [-Title <String>] + [-UMCallingLineIds <MultiValuedProperty>] + [-UMDtmfMap <MultiValuedProperty>] + [-UserPrincipalName <String>] + [-VIP <Boolean>] + [-WebPage <String>] + [-WhatIf] + [-WindowsEmailAddress <SmtpAddress>] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Set-User -Identity Contoso\Jill -DisplayName "Jill Frank" +``` + +This example sets the display name for user Jill Frank. + +### Example 2 +```powershell +Set-User -Identity Kweku@fabrikam.com -LinkedMasterAccount $null +``` + +This example unlinks the linked mailbox Kweku@fabrikam.com and converts it to a user mailbox by setting the LinkedMasterAccount parameter to $null. + +Performing this procedure on a linked mailbox removes all permissions on the mailbox such as Send As, Full Access, folder and calendar delegation. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example: + +- Name +- User principal name (UPN) +- Distinguished name (DN) +- Canonical DN +- GUID +- UserPrincipalName + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AllowUMCallsFromNonUsers +This parameter is available only in on-premises Exchange. + +The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from Unified Messaging directory searches. + +```yaml +Type: AllowUMCallsFromNonUsersFlags +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 +``` + +### -Arbitration +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. + +Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssistantName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationPolicy +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 +- Distinguished name (DN) +- GUID + +To remove the policy assignment for the user, use the value $null. + +You create authentication policies with the New-AuthenticationPolicy cmdlet to block or selectively allow Basic authentication or (in Exchange 2019 CU2 or later) other legacy authentication methods. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockCloudCache +This parameter is available only in the cloud-based service. + +{{ Fill BlockCloudCache Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CanHaveCloudCache +This parameter is available only in the cloud-based service. + +{{ Fill CanHaveCloudCache Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSubject +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. + +```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: False +Accept wildcard characters: False +``` + +### -City +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClearDataEncryptionPolicy +This parameter is available only in the cloud-based service. + +{{ Fill ClearDataEncryptionPolicy Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Company +The Company parameter specifies the user's company. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion +The CountryOrRegion parameter specifies the user's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). + +A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). + +The friendly name is returned in the CountryOrRegion property value by the Get-User cmdlet, but you can use either the friendly name or the two-letter country code in filter operations. + +```yaml +Type: CountryInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDTMFMap +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. +- $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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Department +The Department parameter specifies the user's department. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesiredWorkloads +This parameter is available only in the cloud-based service. + +{{ Fill DesiredWorkloads Description }} + +```yaml +Type: Microsoft.Exchange.Data.MailboxWorkloadFlags +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the display name of the user. The display name is visible in the Exchange admin center and in Active Directory. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EXOModuleEnabled +This parameter is available only in the cloud-based service. + +The EXOModuleEnabled parameter specifies whether the user can connect to Exchange Online PowerShell in Microsoft 365 organizations using the Exchange Online PowerShell V3 module. Valid values are: + +- $true: The user can connect to Exchange Online PowerShell. +- $false: The user can't connect to Exchange Online PowerShell. + +The default value depends on the management roles that are assigned to the user. + + Access to Exchange Online PowerShell is also required for other features (for example, the ability to open the Exchange admin center (EAC)). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fax +The Fax parameter specifies the user's fax number. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstName +The FirstName parameter specifies the user's first name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoCoordinates +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" +- Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432" + +**Note**: If period separators don't work for you, use commas instead. + +```yaml +Type: GeoCoordinates +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomePhone +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. + +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: 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 +``` + +### -Initials +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsShadowMailbox +This parameter is available only in the cloud-based service. + +{{ Fill IsShadowMailbox Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastName +The LastName parameter specifies the user's last name. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedCredential +This parameter is available only in on-premises Exchange. + +The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +You can only use the LinkedCredential parameter with a linked user. + +```yaml +Type: PSCredential +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 +``` + +### -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 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. + +This parameter is required only if you're connecting a linked user. + +```yaml +Type: String +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 +``` + +### -LinkedMasterAccount +This parameter is available only in on-premises Exchange. + +The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if 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: + +- GUID +- DN +- Domain\\Account +- UPN +- LegacyExchangeDN +- SmtpAddress +- 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. + +This parameter is required only if you're connecting a linked user. + +```yaml +Type: UserIdParameter +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 +``` + +### -MailboxRegion +This parameter is available only in the cloud-based service. + +{{ Fill MailboxRegion Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegionSuffix +This parameter is available only in the cloud-based service. + +{{ Fill MailboxRegionSuffix Description }} + +```yaml +Type: MailboxRegionSuffixValue +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedOnboardingType +This parameter is available only in the cloud-based service. + +{{ Fill ManagedOnboardingType Description }} + +```yaml +Type: ManagedOnboardingType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Manager +The Manager parameter specifies the user's manager. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobilePhone +The MobilePhone parameter specifies the user's primary mobile phone number. + +**Note**: In Exchange Online, you can't use this parameter. Instead, use the MobilePhone parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + +```yaml +Type: String +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Office +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OtherFax +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OtherHomePhone +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OtherTelephone +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pager +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermanentlyClearPreviousMailboxInfo +This parameter is functional only in the cloud-based service. + +The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange Online mailbox attributes on a user. You don't need to specify a value with this switch. + +Clearing these attributes might be required in mailbox move and re-licensing scenarios between on-premises Exchange and Microsoft 365. For more information, see [Permanently Clear Previous Mailbox Info](https://techcommunity.microsoft.com/t5/exchange-team-blog/permanently-clear-previous-mailbox-info/ba-p/607619). + +**Caution**: This switch prevents you from reconnecting to the mailbox and prevents you from recovering content from the mailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneticDisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +The PostalCode parameter specifies the user's zip code or postal code. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostOfficeBox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemotePowerShellEnabled +**Note**: In cloud-based environments, this parameter is being deprecated, so use the EXOModuleEnabled parameter instead. + +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. + +The default value depends on the management roles that are assigned to the user. + +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. + +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveMailboxProvisioningConstraint +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetPasswordOnNextLogon +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamAccountName +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. + +```yaml +Type: String +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 +``` + +### -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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleDisplayName +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 +- A - Z +- 0 - 9 +- space +- `" ' ( ) + , - . / : ?` + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDualWrite +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StateOrProvince +The StateOrProvince parameter specifies the user's state or province. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StsRefreshTokensValidFrom +This parameter is available only in the cloud-based service. + +The StsRefreshTokensValidFrom specifies the date-time that the user's STS refresh tokens are valid from. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneAssistant +This parameter is available only in on-premises Exchange. + +The TelephoneAssistant parameter specifies the telephone number 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The Title parameter specifies the user's title. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UMCallingLineIds +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. + +```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: False +Accept wildcard characters: False +``` + +### -UMDtmfMap +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: + +- `emailAddress:<integers>` +- `lastNameFirstName:<integers>` +- `firstNameLastName:<integers>` + +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:<integers>,lastNameFirstName:<integers>,firstNameLastName:<integers>`. + +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:<integers>`, all existing lastNameFirstName and firstNameLastName values are removed. + +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:<integers>","lastNameFirstName:<integers>","firstNameLastName:<integers>"; Remove="emailAddress:<integers>","lastNameFirstName:<integers>","firstNameLastName:<integers>"}`. + +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:<integers1>","emailAddress:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. + +```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: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +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. + +```yaml +Type: String +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 +``` + +### -VIP +This parameter is available only in the cloud-based service. + +The VIP parameter specifies whether the user is a priority account. Valid values are: + +- $true: The user is a priority account. +- $false: The user is not a priority account. + +For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebPage +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work on this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsEmailAddress +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. +- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. + +The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md new file mode 100644 index 0000000000..d036882c11 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: chrisda +--- + +# Set-UserBriefingConfig + +## 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 Set-UserBriefingConfig cmdlet to enable or disable the Briefing email for a user. For more details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-UserBriefingConfig -Identity <String> -Enabled <Boolean> + [-ResultSize <Unlimited>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +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 +Set-UserBriefingConfig -Identity lila@contoso.com -Enabled $true +``` + +This example enables the Briefing email for lila@contoso.com. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin) diff --git a/exchange/exchange-ps/exchange/Set-UserPhoto.md b/exchange/exchange-ps/exchange/Set-UserPhoto.md new file mode 100644 index 0000000000..d2c06bedea --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-UserPhoto.md @@ -0,0 +1,391 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-UserPhoto + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-UserPhoto cmdlet to configure the user photos feature that allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint. + +**Note**: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see [Manage user photos in Microsoft Graph PowerShell](https://learn.microsoft.com/microsoft-365/admin/add-users/change-user-profile-photos#manage-user-photos-in-microsoft-graph-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### CancelPhoto +``` +Set-UserPhoto [-Identity] <MailboxIdParameter> + [-Cancel] + [-Confirm] + [-GroupMailbox] + [-DomainController <Fqdn>] + [-IgnoreDefaultScope] + [-PhotoType <String>] + [-UseCustomRouting] + [-WhatIf] + [<CommonParameters>] +``` + +### UploadPhotoData +``` +Set-UserPhoto [-Identity] <MailboxIdParameter> -PictureData <Byte[]> + [-Confirm] + [-DomainController <Fqdn>] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-PhotoType <String>] + [-UseCustomRouting] + [-WhatIf] + [<CommonParameters>] +``` + +### UploadPreview +``` +Set-UserPhoto [-Identity] <MailboxIdParameter> + [-PictureData <Byte[]>] + [-PictureStream <Stream>] + [-Preview] + [-Confirm] + [-DomainController <Fqdn>] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-PhotoType <String>] + [-UseCustomRouting] + [-WhatIf] + [<CommonParameters>] +``` + +### UploadPhotoStream +``` +Set-UserPhoto [-Identity] <MailboxIdParameter> -PictureStream <Stream> + [-Confirm] + [-DomainController <Fqdn>] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-PhotoType <String>] + [-UseCustomRouting] + [-WhatIf] + [<CommonParameters>] +``` + +### SavePhoto +``` +Set-UserPhoto [-Identity] <MailboxIdParameter> + [-Save] + [-Confirm] + [-DomainController <Fqdn>] + [-GroupMailbox] + [-IgnoreDefaultScope] + [-PhotoType <String>] + [-UseCustomRouting] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +**Notes**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-UserPhoto -Identity "Paul Cannon" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\PaulCannon.jpg")) +``` + +This example uploads and saves a photo to Paul Cannon's user account using a single command. + +### Example 2 +```powershell +Set-UserPhoto -Identity "Ann Beebe" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\AnnBeebe.jpg")) -Preview + +Set-UserPhoto "Ann Beebe" -Save +``` + +This example shows how to use two commands to upload and save a preview photo to Ann Beebe's user account. The first command uploads a preview photo to Ann Beebe's user account, and the second command saves the uploaded photo as the preview photo. + +### Example 3 +```powershell +Set-UserPhoto -Identity "Ann Beebe" -Cancel +``` + +This example deletes the preview photo that was uploaded in the previous example. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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. + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: CancelPhoto +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PictureData +The PictureData parameter specifies the photo file that will be uploaded 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('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: UploadPhotoData +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Stream +Parameter Sets: UploadPhotoStream +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Stream +Parameter Sets: UploadPreview +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 +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: UploadPreview +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: SavePhoto +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMailbox +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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 +``` + +### -PhotoType +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Set-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md new file mode 100644 index 0000000000..d794753e4e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: chrisda +--- + +# Set-VivaInsightsSettings + +## 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). + +**Note**: This cmdlet is available only in version 2.0.5 or later of the module. + +Use the Set-VivaInsightsSettings cmdlet to control user access to features in Viva Insights. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-VivaInsightsSettings -Identity <String> -Enabled <Boolean> -Feature <String> + [-ResultSize <Unlimited>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Teams Administrator + +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 +Set-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com -Enabled $false -Feature headspace +``` + +This example disables access to all the Headspace features in Microsoft Viva Insights in Microsoft Teams for the specified user. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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. +- $false: The specified features in Microsoft Viva Insights in Microsoft Teams are disabled for the user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Feature +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. +- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: headspace +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md similarity index 77% rename from exchange/exchange-ps/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md index 7d58a406a9..09636df6f4 100644 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-WebServicesVirtualDirectory @@ -13,43 +16,55 @@ This cmdlet is available only in on-premises Exchange. Use the Set-WebServicesVirtualDirectory cmdlet to modify existing Exchange Web Services virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-WebServicesVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> - [-BasicAuthentication <$true | $false>] [-CertificateAuthentication <$true | $false>] [-Confirm] - [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] - [-ExtendedProtectionFlags <MultiValuedProperty>] [-ExtendedProtectionSPNList <MultiValuedProperty>] - [-ExtendedProtectionTokenChecking <None | Allow | Require>] [-ExternalUrl <Uri>] [-Force] - [-GzipLevel <Off | Low | High | Error>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl <Uri>] - [-MRSProxyEnabled <$true | $false>] [-MRSProxyMaxConnections <Unlimited>] [-UpdateManagementVirtualDirectory] - [-WhatIf] [-WindowsAuthentication <$true | $false>] [-WSSecurityAuthentication <$true | $false>] - [-OAuthAuthentication <$true | $false>] [<CommonParameters>] + [-BasicAuthentication <Boolean>] + [-CertificateAuthentication <Boolean>] + [-Confirm] + [-DigestAuthentication <Boolean>] + [-DomainController <Fqdn>] + [-ExtendedProtectionFlags <MultiValuedProperty>] + [-ExtendedProtectionSPNList <MultiValuedProperty>] + [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>] + [-ExternalUrl <Uri>] + [-Force] + [-GzipLevel <GzipLevel>] + [-InternalNLBBypassUrl <Uri>] + [-InternalUrl <Uri>] + [-MRSProxyEnabled <Boolean>] + [-MRSProxyMaxConnections <Unlimited>] + [-OAuthAuthentication <Boolean>] + [-WhatIf] + [-WindowsAuthentication <Boolean>] + [-WSSecurityAuthentication <Boolean>] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-WebServicesVirtualDirectory -Identity Contoso\EWS(Default Web Site) -ExternalUrl https://www.contoso.com/EWS/exchange.asmx -BasicAuthentication $true -InternalUrl https://contoso.internal.com/EWS/exchange.asmx ``` This example sets the authentication method to Basic authentication for the virtual directory EWS on the server Contoso. This example also sets the external and internal URLs for this virtual directory. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Set-WebServicesVirtualDirectory -Identity Contoso\EWS* -ExternalUrl https://www.contoso.com/EWS/exchange.asmx ``` This example uses a wildcard character instead of "Default Web site" as was used in Example 1. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Set-WebServicesVirtualDirectory -Identity "EWS (Default Web Site)" -MRSProxyEnabled $true ``` @@ -58,23 +73,20 @@ This example enables MRSProxy on the EWS default website. MRSProxy is the servic ## PARAMETERS ### -Identity -The Identity parameter specifies the Exchange Web Services virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name +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 - Distinguished name (DN) - - GUID -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -86,14 +98,14 @@ Accept wildcard characters: False 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. - - $false: Basic authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -102,13 +114,14 @@ Accept wildcard characters: False ``` ### -CertificateAuthentication -The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the \<Servername\>/ews/management/ virtual directory. It doesn't affect the \<Servername\>/ews/ virtual directory. +The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the `<Servername>/ews/management/` virtual directory. It doesn't affect the `<Servername>/ews/` virtual directory. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -119,8 +132,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -128,6 +140,7 @@ 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 @@ -139,14 +152,14 @@ Accept wildcard characters: False 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. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -162,6 +175,7 @@ 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 @@ -173,13 +187,9 @@ Accept wildcard characters: False The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml @@ -187,6 +197,7 @@ 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 @@ -198,14 +209,14 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. - -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \<protocol\>/\<FQDN\>. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- 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 Default value: None @@ -217,20 +228,17 @@ Accept wildcard characters: False The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. - - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml -Type: None | Allow | Require +Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -248,6 +256,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -256,13 +265,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -274,18 +286,16 @@ Accept wildcard characters: False 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. - - 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. ```yaml -Type: Off | Low | High | Error +Type: GzipLevel Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -294,6 +304,8 @@ Accept wildcard characters: False ``` ### -InternalNLBBypassUrl +**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. 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. @@ -303,6 +315,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -320,6 +333,7 @@ Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -331,10 +345,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -343,15 +358,16 @@ Accept wildcard characters: False ``` ### -MRSProxyMaxConnections -This parameter is available or functional only in 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. +The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -359,16 +375,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateManagementVirtualDirectory -This parameter is available or functional only in Exchange Server 2010. +### -OAuthAuthentication +The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: -The UpdateManagementVirtualDirectory parameter makes sure that the Exchange Web Services objects in Active Directory and the respective objects in Internet Information Services (IIS) are up to date and consistent. +- $true: OAuth authentication is enabled. This is the default value. +- $false: OAuth authentication is disabled. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -384,6 +402,7 @@ 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 @@ -395,14 +414,14 @@ Accept wildcard characters: False 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. - - $false: Integrated Windows authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -414,33 +433,14 @@ Accept wildcard characters: False 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. - - $false: WS-Security authentication is disabled. ```yaml -Type: $true | $false +Type: Boolean 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 -``` -### -OAuthAuthentication -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. - -- $false: OAuth authentication is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named Default value: None @@ -449,20 +449,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/35871cc3-6e8f-48bc-86ed-8703c0e178f3.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/mail-flow/Set-X400AuthoritativeDomain.md rename to exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md index fa949922ed..30872ecd30 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Set-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Set-X400AuthoritativeDomain @@ -13,25 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Set-X400AuthoritativeDomain cmdlet to edit an existing X.400 authoritative domain for your organization. The X.400 authoritative domain defines the standard fields for the namespace appended to the recipient identity for all mailboxes assigned an X.400 address. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For 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-X400AuthoritativeDomain [-Identity] <X400AuthoritativeDomainIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-Name <String>] [-WhatIf] [-X400DomainName <X400Domain>] - [-X400ExternalRelay <$true | $false>] [<CommonParameters>] +Set-X400AuthoritativeDomain [-Identity] <X400AuthoritativeDomainIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Name <String>] + [-WhatIf] + [-X400DomainName <X400Domain>] + [-X400ExternalRelay <Boolean>] + [<CommonParameters>] ``` ## DESCRIPTION X.400 domain names can include only the following ASCII characters: - A to Z - - a to z - - 0-9 - - These punctuation marks and special characters: (space) ' () + , - . / : = ? You can use the following X.400 attributes (1 each per address): @@ -39,57 +44,49 @@ You can use the following X.400 attributes (1 each per address): country - Abbreviation: C - - Maximum character length: 2 administrative domain - Abbreviation: A - - Maximum character length: 16 private domain - Abbreviation: P - - Maximum character length: 16 organization name - Abbreviation: O - - Maximum character length: 64 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Set-X400AuthoritativeDomain Sales -X400DomainName "C=US;A=att,P=Contoso;O=Sales and Marketing" -Name "Sales and Marketing" ``` This example makes the following changes to an existing X.400 authoritative domain: - It changes the domain name from Sales to Sales and Marketing. - - It updates the organizational attribute to Sales and Marketing. ## PARAMETERS ### -Identity -The Identity parameter specifies the X.400 authoritative domain tht you want to modify. You can use any value that uniquely identifies the domain. For example: +The Identity parameter specifies the X.400 authoritative domain that you want to modify. You can use any value that uniquely identifies the domain. For example: - Name - - Distinguished name (DN) - - GUID ```yaml @@ -97,6 +94,7 @@ Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -107,8 +105,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -116,6 +113,7 @@ 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 @@ -133,6 +131,7 @@ 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 @@ -148,6 +147,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -163,6 +163,7 @@ 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 @@ -174,19 +175,12 @@ Accept wildcard characters: False 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) - - A (ADMD) - - P (PRMD) - - O (Organization) - - OU1 (Organization unit 1) - - OU2 (Organization unit 2) - - OU3 (Organization unit 3) - - OU4 (Organization unit 4) Separate the address attributes with semicolons and enclose the entire address in quotation marks (for example, "C=US;A=att;P=Contoso;O=Sales"). @@ -196,6 +190,7 @@ Type: X400Domain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -204,13 +199,14 @@ Accept wildcard characters: False ``` ### -X400ExternalRelay -The X400ExternalRelay parameter specifies whether this authoritative domain is an external relay domain. If you set the X400ExternalRelay parameter to $true, Exchange routes to the external address and doesn't treat resolution failures to this subdomain as errors. +The X400ExternalRelay parameter specifies whether this authoritative domain is an external relay domain. If you set the X400ExternalRelay parameter to $true, Exchange routes to the external address and doesn't treat resolution failures to this subdomain as errors. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -219,20 +215,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/188bd7f3-a88c-411a-a4ef-16697d7f8c7b.aspx) diff --git a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md new file mode 100644 index 0000000000..ddcb34db75 --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md @@ -0,0 +1,153 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Start-ComplianceSearch cmdlet to start stopped, completed or not started compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-ComplianceSearch [-Identity] <ComplianceSearchIdParameter> + [-Confirm] + [-Force] + [-RetryOnError] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Start-ComplianceSearch -Identity "Case 1234" +``` + +This example starts the compliance search named Case 1234 + +## PARAMETERS + +### -Identity +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: + +- Name +- JobRunId (GUID) + +You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status + +```yaml +Type: ComplianceSearchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryOnError +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, 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/database-availability-groups/Start-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/database-availability-groups/Start-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md index c0051c103d..771a794112 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Start-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Start-DatabaseAvailabilityGroup @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Start-DatabaseAvailabilityGroup cmdlet to reincorporate one or more previously failed members of a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,7 +26,8 @@ Start-DatabaseAvailabilityGroup [-Identity] <DatabaseAvailabilityGroupIdParamete [-ConfigurationOnly] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### MailboxSet @@ -32,25 +36,26 @@ Start-DatabaseAvailabilityGroup [-Identity] <DatabaseAvailabilityGroupIdParamete [-ConfigurationOnly] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION The Start-DatabaseAvailabilityGroup cmdlet is used to activate DAG members in a recovered datacenter after a datacenter switchover, as part of the switchback process to the recovered datacenter. The Start-DatabaseAvailabilityGroup cmdlet manipulates configuration and state so that the servers are incorporated into the operating DAG, and joined to the DAG's underlying cluster. The Move-ActiveMailboxDatabase cmdlet is then used to activate databases in the primary datacenter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Start-DatabaseAvailabilityGroup -Identity DAG1 -MailboxServer MBX2 ``` This example starts the Mailbox server MBX2 in the DAG DAG1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Start-DatabaseAvailabilityGroup -Identity DAG1 -ActiveDirectorySite Redmond ``` @@ -58,31 +63,33 @@ This example starts the members of the DAG DAG1 in the Active Directory site Red ## PARAMETERS -### -ActiveDirectorySite -The ActiveDirectorySite parameter specifies whether to start all DAG members in the specified site. +### -Identity +The Identity parameter specifies the name of the DAG being started. ```yaml -Type: AdSiteIdParameter -Parameter Sets: Identity +Type: DatabaseAvailabilityGroupIdParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the DAG being started. +### -ActiveDirectorySite +The ActiveDirectorySite parameter specifies whether to start all DAG members in the specified site. ```yaml -Type: DatabaseAvailabilityGroupIdParameter -Parameter Sets: (All) +Type: AdSiteIdParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False @@ -96,6 +103,7 @@ Type: MailboxServerIdParameter Parameter Sets: MailboxSet Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -104,13 +112,14 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly -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. +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 Default value: None @@ -121,8 +130,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -130,6 +138,7 @@ 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 @@ -145,6 +154,7 @@ 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 @@ -160,6 +170,7 @@ 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 @@ -168,20 +179,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0a0fdf34-d657-4875-9a97-b48014f93ed7.aspx) diff --git a/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md b/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md new file mode 100644 index 0000000000..a61cfb7896 --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md @@ -0,0 +1,176 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Start-EdgeSynchronization + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Start-EdgeSynchronization cmdlet to immediately start synchronization of configuration data from Active Directory to the subscribed Edge Transport 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 + +``` +Start-EdgeSynchronization [-Confirm] + [-ForceFullSync] + [-ForceUpdateCookie] + [-Server <ServerIdParameter>] + [-TargetServer <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Start-EdgeSynchronization -Server Mailbox01 +``` + +This example starts edge synchronization on the Mailbox server named Mailbox01. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```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 +``` + +### -ForceFullSync +The ForceFullSync switch specifies whether to initiate a full edge synchronization. You don't need to specify a value with this switch. + +If you don't use this switch, only changes since the last replication are synchronized. If you use this switch, the entire configuration information and recipient data are synchronized. + +```yaml +Type: SwitchParameter +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 +``` + +### -ForceUpdateCookie +The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. You don't need to specify a value with this switch. + +The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetServer +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. + +```yaml +Type: String +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 +``` + +### -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/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md new file mode 100644 index 0000000000..598f93159b --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -0,0 +1,497 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Start-HistoricalSearch + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Start-HistoricalSearch cmdlet to start a new historical search. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-HistoricalSearch -EndDate <DateTime> -ReportTitle <String> -ReportType <HistoricalSearchReportType> -StartDate <DateTime> + [-BlockStatus <String>] + [-CompressFile <Boolean>] + [-ConnectorType <String>] + [-DeliveryStatus <String>] + [-Direction <MessageDirection>] + [-DLPPolicy <MultiValuedProperty>] + [-EncryptionTemplate <String>] + [-EncryptionType <String>] + [-Locale <CultureInfo>] + [-MessageID <MultiValuedProperty>] + [-NetworkMessageID <MultiValuedProperty>] + [-NotifyAddress <MultiValuedProperty>] + [-OriginalClientIP <String>] + [-RecipientAddress <MultiValuedProperty>] + [-SenderAddress <MultiValuedProperty>] + [-SmtpSecurityError <String>] + [-TLSUsed <String>] + [-TransportRule <MultiValuedProperty>] + [-Url <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are aged between 1-4 hours (depending on your environment) and 90 days old. There is a limit of 250 historical searches that you can submit in a 24 hour period; you'll be warned if you're nearing the daily quota. Cancelled searches count against the daily quota. Also, in each CSV file there is a limit of 100000 results or lines. + +If you specify a distribution group, all messages might not be returned in the results. To ensure that all messages are returned, specify the individual recipient. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2023 -EndDate 1/7/2023 -ReportType MessageTrace -SenderAddress michelle@fabrikam.com -NotifyAddress chris@contoso.com +``` + +This example starts a new historical search named "Fabrikam Search" that has the following properties: + +- Date range: January 1 2023 to January 6 2023. Because we aren't specifying the time of day, the value 0:00 AM is used. In this example, the date range is equivalent to -StartDate "1/1/2023 0:00 AM" -EndDate "1/7/2023 0:00 AM" +- Report type: Message trace +- Sender address: michelle@fabrikam.com +- Internal notification email address: chris@contoso.com + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +If you don't specify the time of day, the default value 0:00 AM is used. For example, the value 12/31/2022 is really "12/31/2022 0:00 AM", which means no data from 12/31/2022 is included (only data from 12/30/2022 is included). + +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ReportTitle +The ReportTitle parameter specifies a descriptive name for the historical search. If the value contains spaces, enclose the value in quotation marks ("). + +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportType +The ReportType parameter specifies the type of historical search that you want to perform. You can use one of the following values: + +- ATPReport: Defender for Office 365 File types report and Defender for Office 365 Message disposition report +- ConnectorReport: Inbound/Outbound Message Report. +- DLP: Data Loss Prevention Report. +- MessageTrace: Message Trace Report. +- MessageTraceDetail: Message Trace Details Report. +- OutboundSecurityReport: Outbound Message in Transit Security Report. +- P2SenderAttribution: P2 Sender Attribution Report. +- SPAM: SPAM Detections Report. +- Spoof: Spoof Mail Report. +- TransportRule: Transport or Mail Flow Rules Report. +- UnifiedDLP: Unified Data Loss Prevention Report. + +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. + +```yaml +Type: HistoricalSearchReportType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BlockStatus +The BlockStatus parameter filters the results in OutboundSecurityReport reports by the status of messages sent externally, messages blocked due to security checks, or messages sent successfully. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompressFile +{{ Fill CompressFile Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorType +The ConnectorType parameter filters the results in ConnectorReport reports by the connector type. Valid values are: + +- OnPremises +- Partner +- NoConnector + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryStatus +The DeliveryStatus parameter filters the results by the delivery status of the message. You can use one of the following values: + +- Delivered +- Expanded +- Failed + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by the direction of the message. Valid values are: + +- All: Incoming and outgoing messages. +- Received: Ingoing messages only. +- Sent: Outgoing messages only. + +```yaml +Type: MessageDirection +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DLPPolicy +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionTemplate +{{ Fill EncryptionTemplate Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionType +{{ Fill EncryptionType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +The Locale parameter filters the results by the locale of the message. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageID +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyAddress +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**. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -OriginalClientIP +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. The maximum number of addresses is 100. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SenderAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmtpSecurityError +The SmtpSecurityError parameter filters the results in OutboundSecurityReport reports by the error type of blocked messages when sent externally. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TLSUsed +The TLSUsed parameter filters the results in ConnectorReport reports by the TLS version. Valid values are: + +- No Tls +- TLS1.2 +- TLS1.3 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRule +The TransportRule parameter filters the results by the name of the 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Url +{{ Fill Url Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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/Start-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md new file mode 100644 index 0000000000..2afb3f3ca7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md @@ -0,0 +1,125 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Start-InformationBarrierPoliciesApplication + +## 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 Start-InformationBarrierPoliciesApplication cmdlet to apply active information barrier policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-InformationBarrierPoliciesApplication [[-Identity] <PolicyIdParameter>] + [-CleanupGroupSegmentLink] + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## 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 +Start-InformationBarrierPoliciesApplication +``` + +This applies all active information barrier policies. + +## PARAMETERS + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CleanupGroupSegmentLink +The CleanupGroupSegmentLink switch specifies whether to remove group segment links. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md b/exchange/exchange-ps/exchange/Start-MailboxAssistant.md new file mode 100644 index 0000000000..52a05e9bcb --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-MailboxAssistant.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxassistant +applicable: Exchange Server 2019 +title: Start-MailboxAssistant +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- +# Start-MailboxAssistant + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2019 in Cumulative Update 11 (CU11) or later. + +Use the Start-MailboxAssistant cmdlet to start processing of a mailbox by the specified assistant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-MailboxAssistant [-Identity] <UserIdParameter> -AssistantName <String> + [-Confirm] + [-DomainController <Fqdn>] + [-Parameters <String>] + [-SoftDeletedMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Start-MailboxAssistant -Identity "Chris" -AssistantName BigFunnelRetryFeederTimeBasedAssistant +``` + +This example starts the `BigFunnelRetryFeederTimeBasedAssistant` assistant and lets it process the mailbox of the user "Chris". The assistant indexes the mailbox items that were not indexed previously. + +**Note**: You first need to create a setting override as described in [Incomplete search results after installing an Exchange Server 2019 update](https://support.microsoft.com/topic/incomplete-search-results-after-installing-an-exchange-server-2019-update-96ae2ef0-4569-4327-8d0c-8a3c1abdc1f6). + +## PARAMETERS + +### -Identity +The Identity parameter specifies the user whose mailbox should be processed by the Mailbox Assistant. Valid values are: + +- Distinguished name (DN) +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AssistantName +The AssistantName parameter specifies the assistant that should process the mailbox. Valid values are: + +- BigFunnelRetryFeederTimeBasedAssistant + +Values are case sensitive. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedMailbox +The SoftDeletedMailbox switch specifies that the mailbox to be processed by the assistant is a soft-deleted mailbox. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Start-MailboxSearch.md b/exchange/exchange-ps/exchange/Start-MailboxSearch.md new file mode 100644 index 0000000000..a84f5ccd78 --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-MailboxSearch.md @@ -0,0 +1,194 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped. + +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-MailboxSearch [-Identity] <SearchObjectIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Force] + [-Resume] + [-StatisticsStartIndex <Int32>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You can use In-Place eDiscovery to search one or more specified mailboxes or all mailboxes across the Exchange organization. A search is created by using the Exchange admin center (EAC) or the New-MailboxSearch cmdlet. + +When restarting a search, any previous results returned by the same search and copied to a Discovery mailbox are removed. To preserve previous search results and resume the search from the point it was stopped, use the Resume switch. + +In Exchange 2013 or later, mailbox searches are also used for In-Place Hold. However, you can't start or stop In-Place Hold using the Start-MailboxSearch and Stop-MailboxSearch cmdlets. + +For more details, see [In-Place Hold and Litigation Hold in Exchange Server](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Start-MailboxSearch -Identity "ProjectContoso" +``` + +This example starts the mailbox search ProjectContoso. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -Resume +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatisticsStartIndex +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md new file mode 100644 index 0000000000..2e90b4cf4d --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md @@ -0,0 +1,424 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Start-ManagedFolderAssistant cmdlet to immediately start messaging records management (MRM) processing of mailboxes that you specify. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-HoldCleanup] + [-AggMailboxCleanup] + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +### ComplianceBoundaryAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-AdaptiveScope] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +### ComplianceJobAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-ComplianceJob] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +### DataGovernanceAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-DataGovernance] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +### ElcB2DumpsterArchiverAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-B2DumpsterArchiver] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +### ElcB2IPMArchiverAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-B2IPMArchiver] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +### HoldCleanupParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-HoldCleanup] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +### StopHoldCleanupParameterSet +``` +Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-StopHoldCleanup] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Start-ManagedFolderAssistant -Identity "Chris" +``` + +This example processes the mailbox for a user with the alias Chris. + +### Example 2 +```powershell +Get-Mailbox -Anr Chr -DomainController DC01 | Start-ManagedFolderAssistant +``` + +This example uses the Get-Mailbox command to retrieve all the mailboxes that resolve from the ambiguous name resolution (ANR) search on the string "Chr" in the domain DC01 (for example, users such as Chris Ashton, Christian Hess, and Christa Geller), and the results are piped to the Start-ManagedFolderAssistant cmdlet for processing. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +**Note**: In the cloud-based service, if you receive an error, try using the mailbox GUID for the value of this parameter. You can get the mailbox GUID value by replacing \<UserIdentity\> with the email address of the user and running the following command: `Get-Mailbox -User <UserIdentity> | Format-List *GUID,MailboxLocations`. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AdaptiveScope +This parameter is available only in the cloud-based service. + +{{ Fill AdaptiveScope Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ComplianceBoundaryAssistantParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggMailboxCleanup +The AggMailboxCleanup switch specifies aggregate mailbox cleanup. You don't need to specify a value with this switch. + +This switch cleans up aggregate mailboxes, audits, and calendar logging. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -B2DumpsterArchiver +This parameter is available only in the cloud-based service. + +{{ Fill B2DumpsterArchiver Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -B2IPMArchiver +This parameter is available only in the cloud-based service. + +{{ Fill B2IPMArchiver Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ElcB2IPMArchiverAssistantParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceJob +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: ComplianceJobAssistantParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -DataGovernance +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: DataGovernanceAssistantParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: Identity +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 +``` + +### -FullCrawl +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. + +```yaml +Type: SwitchParameter +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldCleanup +The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, Litigation Hold, or has Single Item Recovery enabled. You don't need to specify a value with this switch. + +Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, HoldCleanupParameterSet +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InactiveMailbox +This parameter is available only in the cloud-based service. + +The InactiveMailbox switch runs the command only on inactive mailboxes. You don't need to specify a value with this switch. + +An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. + +When you use this switch, items aren't moved from the inactive mailbox to the archive mailbox. + +```yaml +Type: SwitchParameter +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopHoldCleanup +This parameter is available only in the cloud-based service. + +The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch. + +A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue. + +```yaml +Type: SwitchParameter +Parameter Sets: StopHoldCleanupParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +[Export-MailboxDiagnosticLogs](https://learn.microsoft.com/powershell/module/exchange/Export-MailboxDiagnosticLogs) diff --git a/exchange/exchange-ps/exchange/Start-MigrationBatch.md b/exchange/exchange-ps/exchange/Start-MigrationBatch.md new file mode 100644 index 0000000000..cf1d3e9731 --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-MigrationBatch.md @@ -0,0 +1,175 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Start-MigrationBatch cmdlet to start a move request or migration batch that was created with the New-MigrationBatch cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-Partition <MailboxIdParameter>] + [-Validate] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Start-MigrationBatch -Identity SEM1 +``` + +This example starts the migration batch SEM1. + +## PARAMETERS + +### -Identity +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 +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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Validate +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. + +If you use this switch, the migration performs a validation check of the mailboxes in the batch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Start-MigrationUser.md b/exchange/exchange-ps/exchange/Start-MigrationUser.md new file mode 100644 index 0000000000..be88fe1878 --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-MigrationUser.md @@ -0,0 +1,144 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Start-MigrationUser + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Start-MigrationUser cmdlet to start the migration of a user in an existing migration batch. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-MigrationUser [[-Identity] <MigrationUserIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Start-MigrationUser -Identity laura@contoso.com +``` + +This example starts the migration of the user named laura@contoso.com + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: MigrationUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md b/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md new file mode 100644 index 0000000000..3ad1a2652d --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md @@ -0,0 +1,240 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Start-RetentionAutoTagLearning + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Start-RetentionAutoTagLearning cmdlet to start auto-tagging for a specified mailbox or to cross-validate auto-tagging results for the mailbox. + +Messaging records management (MRM) must be configured before the Start-RetentionAutoTagLearning cmdlet can be used. For more information, see [Understanding Retention Tags and Retention Policies](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd297955(v=exchg.141)). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### CrossValidate +``` +Start-RetentionAutoTagLearning [-Identity] <MailboxIdParameter> + [-CrossValidate] + [-NumberOfSegments <Int32>] + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +### Train +``` +Start-RetentionAutoTagLearning [-Identity] <MailboxIdParameter> + [-Clear] + [-Train] + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Start-RetentionAutoTagLearning -Identity "Joe Healy" -Train +``` + +This example sets user Joe Healy's mailbox to train. + +### Example 2 +```powershell +Start-RetentionAutoTagLearning -Identity "Joe Healy" -CrossValidate -NumberOfSegments 15 +``` + +This example sets user Joe Healy's mailbox to cross-validate and sets the number of segments for cross-validation to 15. + +### Example 3 +```powershell +Start-RetentionAutoTagLearning -Identity "Joe Healy" -Clear +``` + +This example sets user Joe Healy's mailbox to clear all retention policy tags assigned by auto-tagging. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CrossValidate +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Clear +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfSegments +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. + +The minimum value is 2. + +You csn only use this parameter with the CrossValidate parameter. + +```yaml +Type: Int32 +Parameter Sets: CrossValidate +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Train +The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. You don't need to specify a value with this switch. + +This switch is especially useful for retraining. + +```yaml +Type: SwitchParameter +Parameter Sets: Train +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md new file mode 100644 index 0000000000..a0b52107ee --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md @@ -0,0 +1,117 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Stop-ComplianceSearch cmdlet to stop running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-ComplianceSearch [-Identity] <ComplianceSearchIdParameter> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Stop-ComplianceSearch -Identity "Case 1234" +``` + +This example stops the active compliance search named Case 1234 + +## PARAMETERS + +### -Identity +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: + +- Name +- JobRunId (GUID) + +You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status + +```yaml +Type: ComplianceSearchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, 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 Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, 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/database-availability-groups/Stop-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md similarity index 79% rename from exchange/exchange-ps/exchange/database-availability-groups/Stop-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md index f9b34966f7..c9f3ae6135 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Stop-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Stop-DatabaseAvailabilityGroup @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Stop-DatabaseAvailabilityGroup cmdlet to mark a member of a database availability group (DAG) as failed, or to mark all DAG members in a specific Active Directory site as failed. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,7 +26,8 @@ Stop-DatabaseAvailabilityGroup [-Identity] <DatabaseAvailabilityGroupIdParameter [-ConfigurationOnly] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### MailboxSet @@ -32,32 +36,33 @@ Stop-DatabaseAvailabilityGroup [-Identity] <DatabaseAvailabilityGroupIdParameter [-ConfigurationOnly] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION The Stop-DatabaseAvailabilityGroup cmdlet is used during a datacenter switchover. This cmdlet is used to mark one or members of the DAG as failed (also known as stopped).The Stop-DatabaseAvailabilityGroup cmdlet can be run against a DAG only when the DAG is configured with a DatacenterActivationMode value of DagOnly. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Stop-DatabaseAvailabilityGroup -Identity DAG1 -MailboxServer MBX2 ``` This example stops the Mailbox server MBX2 in the DAG DAG1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Stop-DatabaseAvailabilityGroup -Identity DAG1 -ActiveDirectorySite Redmond ``` This example stops all members in the DAG DAG1 in the Active Directory site Redmond. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Stop-DatabaseAvailabilityGroup -Identity DAG2 -MailboxServer MBX3 -ConfigurationOnly ``` @@ -65,31 +70,33 @@ This example stops the Mailbox server MBX3, which is currently offline, in the D ## PARAMETERS -### -ActiveDirectorySite -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). +### -Identity +The Identity parameter specifies the name of the DAG being stopped. ```yaml -Type: AdSiteIdParameter -Parameter Sets: Identity +Type: DatabaseAvailabilityGroupIdParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the DAG being stopped. +### -ActiveDirectorySite +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: DatabaseAvailabilityGroupIdParameter -Parameter Sets: (All) +Type: AdSiteIdParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False @@ -103,6 +110,7 @@ Type: MailboxServerIdParameter Parameter Sets: MailboxSet Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -111,13 +119,16 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly -The ConfigurationOnly parameter updates the Active Directory properties with the stop action, but doesn't perform a stop of the DAG or any members. This parameter must be used when the DAG member servers are offline, but Active Directory is up and accessible in the primary datacenter. +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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -128,8 +139,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -137,6 +147,7 @@ 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 @@ -152,6 +163,7 @@ 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 @@ -167,6 +179,7 @@ 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 @@ -175,20 +188,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/1e167fe5-b1c5-48d9-b3d8-4cf823d1c43c.aspx) diff --git a/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md b/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md new file mode 100644 index 0000000000..314339dd93 --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md @@ -0,0 +1,77 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Stop-HistoricalSearch + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Stop-HistoricalSearch cmdlet to stop an existing historical search that has a status value of NotStarted. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-HistoricalSearch -JobId <Guid> + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Stop-HistoricalSearch -JobId f9c66f83-b5c8-4a0c-91f4-a38376f74182 +``` + +This example stops the historical search that has the JobId value f9c66f83-b5c8-4a0c-91f4-a38376f74182. + +## PARAMETERS + +### -JobId +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md new file mode 100644 index 0000000000..00b91d2c2c --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Stop-InformationBarrierPoliciesApplication + +## 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 Stop-InformationBarrierPoliciesApplication cmdlet to stop the process of applying information barrier policies in the Microsoft Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-InformationBarrierPoliciesApplication [-Identity] <PolicyIdParameter> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## 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 +InformationBarrierPoliciesApplication -Identity 46237888-12ca-42e3-a541-3fcb7b5231d1 +``` + +This example stops the application of information barrier policies per the policy application with the specified Identity value. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) + +[Edit (or remove) information barrier policies](https://learn.microsoft.com/purview/information-barriers-edit-segments-policies) diff --git a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md new file mode 100644 index 0000000000..b78b8cb8b3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md @@ -0,0 +1,133 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Stop-MailboxSearch cmdlet to stop a mailbox search that's in progress. + +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-MailboxSearch [-Identity] <SearchObjectIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Stop-MailboxSearch -Identity "Project Contoso" +``` + +This example stops the mailbox search Project Contoso. + +## PARAMETERS + +### -Identity +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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Stop-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md new file mode 100644 index 0000000000..0b03abf051 --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md @@ -0,0 +1,143 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Stop-ManagedFolderAssistant + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Stop-ManagedFolderAssistant cmdlet to immediately stop messaging records management (MRM) from processing users' mailboxes on the specified servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-ManagedFolderAssistant [[-Identity] <ServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Stop-ManagedFolderAssistant +``` + +This example executes the Stop-ManagedFolderAssistant command without parameters. The Managed Folder Assistant is stopped as soon as processing of the current mailbox is completed on the current server. + +### Example 2 +```powershell +Stop-ManagedFolderAssistant -Identity ExchSrvr1, Exchsrvr2 +``` + +This example stops the Managed Folder Assistant on the servers ExchSrvr1 and Exchsrvr2. + +## PARAMETERS + +### -Identity +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -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/Stop-MigrationBatch.md b/exchange/exchange-ps/exchange/Stop-MigrationBatch.md new file mode 100644 index 0000000000..2c68616341 --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-MigrationBatch.md @@ -0,0 +1,157 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Stop-MigrationBatch cmdlet to stop the processing of a migration batch that's in progress. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-MigrationBatch cmdlet stops the migration batch that's being processed in your on-premises Exchange organization or by the cloud-based migration service running in Microsoft 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration won't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet won't run. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Stop-MigrationBatch +``` + +This example stops the migration batch that's currently being processed by the migration service. + +### Example 2 +```powershell +Stop-MigrationBatch -Identity MigrationBatch1 +``` + +This example stops the migration batch MigrationBatch1. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. + +```yaml +Type: MigrationBatchIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: 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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Stop-MigrationUser.md b/exchange/exchange-ps/exchange/Stop-MigrationUser.md new file mode 100644 index 0000000000..ccaca8fe4d --- /dev/null +++ b/exchange/exchange-ps/exchange/Stop-MigrationUser.md @@ -0,0 +1,144 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Stop-MigrationUser + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Stop-MigrationUser cmdlet to stop the migration of a user in an existing migration batch. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Stop-MigrationUser [[-Identity] <MigrationUserIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Stop-MigrationUser -Identity laura@contoso.com +``` + +This example stops the migration of the user laura@contoso.com. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: MigrationUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -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 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md similarity index 79% rename from exchange/exchange-ps/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md rename to exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md index b967e433c8..bbd7d1ecfa 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Suspend-MailboxDatabaseCopy @@ -13,40 +16,45 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-MailboxDatabaseCopy cmdlet to block replication and replay activities (log copying and replay) or activation for a database configured with two or more database copies. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### EnableReplayLag ``` -Suspend-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> [-EnableReplayLag] +Suspend-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> + [-EnableReplayLag] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### Identity ``` -Suspend-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> [-ActivationOnly] [-SuspendComment <String>] +Suspend-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> + [-ActivationOnly] + [-SuspendComment <String>] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Suspend-MailboxDatabaseCopy -Identity DB1\MBX3 -SuspendComment "Maintenance on MBX3" ``` This example suspends replication and replay activity for the copy of the database DB1 hosted on the Mailbox server MBX3. An optional administrative reason for the suspension is specified. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Suspend-MailboxDatabaseCopy -Identity DB3\MBX2 -ActivationOnly ``` @@ -62,6 +70,7 @@ Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -70,13 +79,14 @@ Accept wildcard characters: False ``` ### -ActivationOnly -The ActivationOnly switch specifies whether to suspend only activation for the mailbox database copy. +The ActivationOnly switch specifies whether to suspend only activation for the mailbox database copy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -87,8 +97,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -96,6 +105,7 @@ 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 @@ -111,6 +121,7 @@ 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 @@ -118,6 +129,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableReplayLag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: EnableReplayLag +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SuspendComment The SuspendComment parameter specifies the reason that the database copy is being suspended. This parameter is limited to 512 characters. @@ -126,6 +153,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -141,22 +169,8 @@ 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 -``` - -### -EnableReplayLag -This parameter is reserved for internal Microsoft use. -```yaml -Type: SwitchParameter -Parameter Sets: EnableReplayLag -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -164,20 +178,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/b6e03402-706e-40c6-b392-92e3da21b5c0.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxExportRequest.md rename to exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md index 74d6383424..5f063c4f44 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Suspend-MailboxExportRequest @@ -13,31 +16,35 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-MailboxExportRequest cmdlet to suspend an export request any time after the request was created, but before the request reaches the status of Completed. You can resume the request by using the Resume-MailboxExportRequest cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Suspend-MailboxExportRequest [-Identity] <MailboxExportRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-SuspendComment <String>] [-WhatIf] [<CommonParameters>] +Suspend-MailboxExportRequest [-Identity] <MailboxExportRequestIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Suspend-MailboxExportRequest -Identity "Ayla\MailboxExport1" ``` This example suspends the second export request for Ayla's mailbox with the identity Ayla\\MailboxExport1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxExportRequest -Status InProgress | Suspend-MailboxExportRequest -SuspendComment "Resume after 22:00 (10 P.M.)" ``` @@ -46,13 +53,14 @@ This example suspends all export requests that are in progress by using the Get- ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \<alias\>\\MailboxExportX (where X = 0-9). Use the following syntax: \<alias\>\\\<name\>. +The Identity parameter specifies the identity of the export request. By default, export requests are named `<alias>\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 Default value: None @@ -63,8 +71,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -72,6 +79,7 @@ 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 @@ -87,6 +95,7 @@ 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 @@ -102,6 +111,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -117,6 +127,7 @@ 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 @@ -125,20 +136,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/3779c7b2-a25d-4213-bd20-fb58ba9d6925.aspx) diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md new file mode 100644 index 0000000000..41e44b0123 --- /dev/null +++ b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md @@ -0,0 +1,157 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Suspend-MailboxImportRequest cmdlet to suspend an import request any time after the request was created, but before the request reaches the status of Completed. You can resume the move request by using the Resume-MailboxImportRequest cmdlet. + +NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Suspend-MailboxImportRequest [-Identity] <MailboxImportRequestIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Suspend-MailboxImportRequest -Identity "Ayla\MailboxImport1" +``` + +This example suspends the second import request for Ayla's mailbox with the identity Ayla\\MailboxImport1. + +### Example 2 +```powershell +Get-MailboxImportRequest -Status InProgress | Suspend-MailboxImportRequest -SuspendComment "Resume after 22:00 (10 P.M.)" +``` + +This example suspends all import requests that are in progress by using the Get-MailboxImportRequest cmdlet to retrieve all requests with a Status of InProgress and then pipelining the output to the Suspend-MailboxImportRequest cmdlet with the suspend comment "Resume after 22:00 (10 P.M.)". + +## PARAMETERS + +### -Identity +The Identity parameter specifies the identity of the import request. By default, import requests are named `<alias>\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 +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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 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 +``` + +### -SuspendComment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mailboxes/Suspend-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxRestoreRequest.md rename to exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md index 4aa7471094..ca7cdcbde0 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Suspend-MailboxRestoreRequest @@ -13,29 +16,33 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-MailboxRestoreRequest cmdlet to suspend a restore request any time after the request was created, but before the request reaches the status of Completed. You can resume the restore request by using the Resume-MailboxRestoreRequest cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Suspend-MailboxRestoreRequest [-Identity] <MailboxRestoreRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-SuspendComment <String>] [-WhatIf] [<CommonParameters>] +Suspend-MailboxRestoreRequest [-Identity] <MailboxRestoreRequestIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Suspend-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" ``` This example suspends the second restore request for Ayla's mailbox with the identity Ayla\\MailboxRestore1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MailboxRestoreRequest -Status InProgress | Suspend-MailboxRestoreRequest -SuspendComment "Resume after 10:00 PM" ``` @@ -44,7 +51,7 @@ This example suspends all restore requests that are in progress by using the Get ## PARAMETERS ### -Identity -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\>. +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). @@ -53,6 +60,7 @@ 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 Default value: None @@ -63,8 +71,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -72,6 +79,7 @@ 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 Default value: None @@ -89,6 +97,7 @@ 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 @@ -104,6 +113,7 @@ 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 Default value: None @@ -119,6 +129,7 @@ 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 Default value: None @@ -127,20 +138,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/620fd701-d7f8-444b-8c37-cabfcd5f0bb4.aspx) diff --git a/exchange/exchange-ps/exchange/Suspend-Message.md b/exchange/exchange-ps/exchange/Suspend-Message.md new file mode 100644 index 0000000000..e978e8d3de --- /dev/null +++ b/exchange/exchange-ps/exchange/Suspend-Message.md @@ -0,0 +1,172 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Suspend-Message + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Suspend-Message cmdlet to prevent delivery of a particular message in a queue on a Mailbox server or an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Suspend-Message -Filter <String> + [-Server <ServerIdParameter>] + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +### Identity +``` +Suspend-Message [-Identity] <MessageIdentity> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## 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 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Suspend-Message -Server Server1 -Filter "FromAddress -eq 'kweku@contoso.com'" +``` + +This example prevents delivery of all messages for which the following conditions are true: + +- The messages are sent by the sender kweku@contoso.com. +- The messages are queued on the server Server1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -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/move-and-migration/Suspend-MoveRequest.md b/exchange/exchange-ps/exchange/Suspend-MoveRequest.md similarity index 77% rename from exchange/exchange-ps/exchange/move-and-migration/Suspend-MoveRequest.md rename to exchange/exchange-ps/exchange/Suspend-MoveRequest.md index 568c53e4a7..852bd02d0b 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Suspend-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MoveRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Suspend-MoveRequest @@ -13,29 +16,34 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-MoveRequest cmdlet to suspend a move request any time after the move request was created, but before it reaches the status of CompletionInProgress. You can resume the move request by using the Resume-MoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Suspend-MoveRequest [-Identity] <MoveRequestIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-SuspendComment <String>] [-WhatIf] [-ProxyToMailbox <MailboxIdParameter>] [<CommonParameters>] +Suspend-MoveRequest [-Identity] <MoveRequestIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-ProxyToMailbox <MailboxIdParameter>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Suspend-MoveRequest -Identity "Ayla@humongousinsurance.com" ``` This example suspends the move request for Ayla's mailbox. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Get-MoveRequest -MoveStatus InProgress | Suspend-MoveRequest ``` @@ -47,17 +55,11 @@ This example suspends all move requests that are in progress by using the Get-Mo The Identity parameter specifies the identity of the mailbox or mail user. You can use one of the following values: - GUID - - Distinguished Name (DN) - - Domain\\Account - - User principal name (UPN) - - LegacyExchangeDN - - SMTP address - - Alias ```yaml @@ -65,6 +67,7 @@ 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 Default value: None @@ -75,8 +78,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -84,6 +86,7 @@ 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 Default value: None @@ -101,6 +104,7 @@ 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 @@ -108,14 +112,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SuspendComment -The SuspendComment parameter specifies a description as to why the request was suspended. +### -ProxyToMailbox +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) ```yaml -Type: String +Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online + Required: False Position: Named Default value: None @@ -123,14 +141,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -SuspendComment +The SuspendComment parameter specifies a description as to why the request was suspended. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -138,40 +157,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyToMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) +### -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: MailboxIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Online +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -180,20 +174,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/078dd2f7-2562-4a33-aa9f-e5e2fb0f908b.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md similarity index 76% rename from exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md index 0cd3d874ed..6e8a63fbb7 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Suspend-PublicFolderMailboxMigrationRequest @@ -13,22 +16,26 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-PublicFolderMailboxMigrationRequest cmdlet to suspend individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Suspend-PublicFolderMailboxMigrationRequest [-Identity] <PublicFolderMailboxMigrationRequestIdParameter> - [-Confirm] [-DomainController <Fqdn>] [-SuspendComment <String>] [-WhatIf] [<CommonParameters>] + [-Confirm] + [-DomainController <Fqdn>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Suspend-PublicFolderMailboxMigrationRequest -Identity \PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e ``` @@ -37,13 +44,14 @@ This example suspends the specified public folder mailbox migration request. ## PARAMETERS ### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to suspend. This value uses the syntax \\PublicFolderMailboxMigration\<GUID\> (for example, \\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e). +The Identity parameter specifies the public folder mailbox migration request that you want to suspend. This value uses the syntax `\PublicFolderMailboxMigration<GUID>` (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 Default value: None @@ -54,8 +62,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +70,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -80,6 +88,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -95,6 +104,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -110,6 +120,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + Required: False Position: Named Default value: None @@ -118,20 +129,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/12ef145f-14d5-4b81-b189-d5ba80b52d9c.aspx) diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md new file mode 100644 index 0000000000..824fe531ac --- /dev/null +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md @@ -0,0 +1,156 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Suspend-PublicFolderMigrationRequest + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Suspend-PublicFolderMigrationRequest cmdlet to suspend serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). You can suspend active requests before they reach the status CompletionInProgress. You resume suspended requests by using the Resume-PublicFolderMigrationRequest cmdlet. + +**Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Suspend-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Suspend-PublicFolderMigrationRequest -Identity PFMigReq1 +``` + +This example suspends the public folder migration request PFMigReq1. + +### Example 2 +```powershell +Get-PublicFolderMigrationRequest -Status InProgress | Suspend-PublicFolderMigrationRequest +``` + +This example suspends all migration requests that are in progress by using the Get-PublicFolderMigrationRequest cmdlet to retrieve all migration requests with a Status value of InProgress and then pipelining the output to the Suspend-PublicFolderMigrationRequest cmdlet. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the migration request that you want to suspend. You can use the following values: + +- Name +- RequestGUID + +```yaml +Type: PublicFolderMigrationRequestIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendComment +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/move-and-migration/Suspend-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md similarity index 77% rename from exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMoveRequest.md rename to exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md index aeadec7528..fc298d21c8 100644 --- a/exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Suspend-PublicFolderMoveRequest @@ -13,22 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-PublicFolderMoveRequest 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-PublicFolderMoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Suspend-PublicFolderMoveRequest [-Identity] <PublicFolderMoveRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-SuspendComment <String>] [-WhatIf] [<CommonParameters>] +Suspend-PublicFolderMoveRequest [-Identity] <PublicFolderMoveRequestIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-SuspendComment <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Suspend-PublicFolderMoveRequest -Identity \PublicFolderMove ``` @@ -44,6 +51,7 @@ Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -54,8 +62,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -63,6 +70,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -78,6 +86,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -93,6 +102,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -108,6 +118,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -116,20 +127,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6d15d2ae-77cf-4f4b-8d43-ef9864a797d8.aspx) diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md new file mode 100644 index 0000000000..8819989303 --- /dev/null +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Suspend-PublicFolderReplication + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Suspend-PublicFolderReplication cmdlet to stop public folder replication for the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Suspend-PublicFolderReplication [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Suspend-PublicFolderReplication +``` + +This example stops public folder replication for the organization. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Suspend-Queue.md b/exchange/exchange-ps/exchange/Suspend-Queue.md new file mode 100644 index 0000000000..14102cc59b --- /dev/null +++ b/exchange/exchange-ps/exchange/Suspend-Queue.md @@ -0,0 +1,174 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Suspend-Queue + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Suspend-Queue cmdlet to stop processing for a queue on a Mailbox server or an Edge Transport server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Filter +``` +Suspend-Queue -Filter <String> + [-Server <ServerIdParameter>] + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +### Identity +``` +Suspend-Queue [-Identity] <QueueIdentity> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Suspend-Queue -Filter "NextHopDomain -eq "contoso.com" -and Status -eq 'Retry'" +``` + +This example suspends processing on all queues holding messages for delivery to the domain contoso.com and that currently have a status of Retry. + +### Example 2 +```powershell +Suspend-Queue -Server Server1.contoso.com -Filter "MessageCount -gt 100" +``` + +This example suspends processing on all queues on the server Server1.contoso.com that have more than 100 messages in the queue. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://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 ("). + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Filter +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 +``` + +### -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/devices/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md similarity index 75% rename from exchange/exchange-ps/exchange/devices/Test-ActiveSyncConnectivity.md rename to exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md index 226ccac957..48f24eefda 100644 --- a/exchange/exchange-ps/exchange/devices/Test-ActiveSyncConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-ActiveSyncConnectivity @@ -13,18 +16,28 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ActiveSyncConnectivity cmdlet to test connectivity to Microsoft Exchange ActiveSync virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Test-ActiveSyncConnectivity [[-ClientAccessServer] <ServerIdParameter>] [[-URL] <String>] - [-AllowUnsecureAccess] [-Confirm] [-DomainController <Fqdn>] [-LightMode] [-MailboxCredential <PSCredential>] - [-MailboxServer <ServerIdParameter>] [-MonitoringContext] [-MonitoringInstance <String>] - [-ResetTestAccountCredentials] [-Timeout <UInt32>] [-TrustAnySSLCertificate] - [-UseAutodiscoverForClientAccessServer] [-WhatIf] [<CommonParameters>] + [-AllowUnsecureAccess] + [-Confirm] + [-DomainController <Fqdn>] + [-LightMode] + [-MailboxCredential <PSCredential>] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-MonitoringInstance <String>] + [-ResetTestAccountCredentials] + [-Timeout <UInt32>] + [-TrustAnySSLCertificate] + [-UseAutodiscoverForClientAccessServer] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -32,72 +45,47 @@ The Test-ActiveSyncConnectivity cmdlet tests Exchange ActiveSync connectivity by The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: -& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 +`& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1` The test results are displayed on-screen. The cmdlet returns the following information. - CasServer: The Exchange server that the client connected to. - - LocalSite: The name of the local Active Directory site. - - Scenario: The operations that are tested. Values are: Options, FolderSync, First Sync, GetItemEstimate, Sync Data, Ping, and Sync Test Item. - - Result: The values returned are typically Success, Skipped, or Failure. - - Latency(MS): The time required to complete the test in milliseconds. - - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: - -Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "C:\\My Documents\\EAS Test.html" +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAS Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-ActiveSyncConnectivity -ClientAccessServer MBX01 ``` This example tests Exchange ActiveSync client connectivity for the server named MBX01. -### -------------------------- Example 2 -------------------------- -``` -Test-ActiveSyncConnectivity -UseAutodiscoverForClientAccessServer $true -URL "http://contoso.com/mail" -MailboxCredential (Get-Credential pauls@contoso.com) +### Example 2 +```powershell +Test-ActiveSyncConnectivity -UseAutodiscoverForClientAccessServer $true -URL "https://contoso.com/mail" -MailboxCredential (Get-Credential pauls@contoso.com) ``` This example tests the Exchange ActiveSync connectivity for the mailbox PaulS using the Autodiscover URL. ## PARAMETERS -### -AllowUnsecureAccess -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ClientAccessServer The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID You can't use this parameter with the Url parameter. @@ -107,6 +95,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -114,11 +103,44 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -URL +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUnsecureAccess +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 +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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -126,6 +148,7 @@ 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 @@ -141,6 +164,7 @@ 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 @@ -160,6 +184,7 @@ 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 @@ -170,13 +195,14 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -185,16 +211,13 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. @@ -204,6 +227,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -212,13 +236,16 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -234,6 +261,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -242,13 +270,16 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -264,6 +295,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -272,7 +304,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -281,25 +313,9 @@ 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 -``` - -### -URL -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -313,6 +329,7 @@ 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 @@ -328,6 +345,7 @@ 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 @@ -336,20 +354,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/83f7b578-496e-4903-aeb7-95517a28a9f4.aspx) diff --git a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md new file mode 100644 index 0000000000..24d8280b0b --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md @@ -0,0 +1,100 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Test-ApplicationAccessPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Test-ApplicationAccessPolicy cmdlet to test access right of an application to a specific user/mailbox. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ApplicationAccessPolicy [-Identity] <RecipientIdParameter> -AppId <String> + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-ApplicationAccessPolicy -Identity "Engineering Staff" -AppID 3dbc2ae1-7198-45ed-9f9f-d86ba3ec35b5 +``` + +This example tests access to the specified app for the group "Engineering Staff". + +### Example 2 +```powershell +Test-ApplicationAccessPolicy -Identity RandomUser9911@AppPolicyTest2.com -AppId e7e4dbfc-046-4074-9b3b-2ae8f144f59b +``` + +This example tests access to the user RandomUser9911@AppPolicyTest2.com for the specified app. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the recipient to test. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Distinguished name (DN) +- Display name +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AppId +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Test-ArchiveConnectivity.md b/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md similarity index 75% rename from exchange/exchange-ps/exchange/policy-and-compliance/Test-ArchiveConnectivity.md rename to exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md index 0407fd7d3d..219f178aa0 100644 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Test-ArchiveConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-ArchiveConnectivity @@ -13,32 +16,36 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ArchiveConnectivity cmdlet to verify archive functionality for a mailbox user. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-ArchiveConnectivity [-UserSmtp] <SmtpAddress> [-Confirm] [-WhatIf] [-IncludeArchiveMRMConfiguration] - [-MessageId <String>] [<CommonParameters>] +Test-ArchiveConnectivity [-UserSmtp] <SmtpAddress> + [-Confirm] + [-IncludeArchiveMRMConfiguration] + [-MessageId <String>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-ArchiveConnectivity -UserSmtp gsingh@contoso.com ``` This example tests archive connectivity to Gurinder Singh's archive. -### -------------------------- Example 2 -------------------------- -``` -Get-Mailbox -Filter {ArchiveGuid -ne $null -and ArchiveDomain -ne $null} -ResultSize Unlimited | Test-ArchiveConnectivity +### Example 2 +```powershell +Get-Mailbox -Filter 'ArchiveGuid -ne $null -and ArchiveDomain -ne $null' -ResultSize Unlimited | Test-ArchiveConnectivity ``` This command retrieves mailboxes that have a cloud-based archive provisioned and tests archive connectivity for each mailbox. @@ -53,6 +60,7 @@ Type: SmtpAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -63,8 +71,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -72,6 +79,7 @@ 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 @@ -79,14 +87,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -IncludeArchiveMRMConfiguration +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: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -94,14 +103,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeArchiveMRMConfiguration -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. +### -MessageId +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -109,14 +119,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MessageId -This parameter is reserved for internal Microsoft use. +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -125,20 +136,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/0db98a12-8cbb-4e9a-add4-c1847b057a44.aspx) diff --git a/exchange/exchange-ps/exchange/Test-AssistantHealth.md b/exchange/exchange-ps/exchange/Test-AssistantHealth.md new file mode 100644 index 0000000000..95868838da --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-AssistantHealth.md @@ -0,0 +1,224 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-AssistantHealth + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-AssistantHealth cmdlet to verify that the Microsoft Exchange Mailbox Assistants service (MSExchangeMailboxAssistants) is healthy, to recover from health issues, and to report the status of the diagnosis or recovery action. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-AssistantHealth [[-ServerName] <ServerIdParameter>] + [-Confirm] + [-IncludeCrashDump] + [-MaxProcessingTimeInMinutes <UInt32>] + [-MonitoringContext] + [-ResolveProblems] + [-WatermarkBehindWarningThreholdInMinutes <UInt32>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Mailbox Assistants service runs on all servers that have the Mailbox server role installed. This service is responsible for scheduling and dispatching several assistants that ensure mailboxes function correctly. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Test-AssistantHealth -ServerName MBXSVR01 -IncludeCrashDump -ResolveProblems | Format-List +``` + +This example detects and repairs the mailbox assistant's health on MBXSVR01, includes the error information, and formats the output to a list. + +### Example 2 +```powershell +Test-AssistantHealth -MaxProcessingTimeInMinutes 30 | Format-List +``` + +This example detects the mailbox assistant's health on the local Mailbox server. The MaxProcessingTimeInMinutes parameter specifies 30 minutes as the maximum amount of time the service is allowed to process an event without responding, and formats the output to a list. + +## PARAMETERS + +### -ServerName +The ServerName parameter specifies the Mailbox server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -IncludeCrashDump +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxProcessingTimeInMinutes +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringContext +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). + +```yaml +Type: SwitchParameter +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 +``` + +### -ResolveProblems +This ResolveProblems switch specifies that if the command detects an issue, it attempts to fix it. You don't need to specify a value with this switch. + +This command attempts to fix the following issues: + +- Starts the Mailbox Assistants service if it isn't running. +- Restarts the Mailbox Assistants service if it detects that the service is hung or deadlocked for more than 15 minutes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +You can specify a value from 1 through 10080 minutes. The default value is 60 minutes. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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/client-access/Test-CalendarConnectivity.md b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md similarity index 77% rename from exchange/exchange-ps/exchange/client-access/Test-CalendarConnectivity.md rename to exchange/exchange-ps/exchange/Test-CalendarConnectivity.md index 535b52e094..c2836a32a6 100644 --- a/exchange/exchange-ps/exchange/client-access/Test-CalendarConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-CalendarConnectivity @@ -13,17 +16,26 @@ This cmdlet is available only in on-premises Exchange. Use the Test-CalendarConnectivity cmdlet to verify that anonymous calendar sharing is enabled and working properly. The Calendar virtual directory is a subdirectory of the Microsoft Outlook on the web virtual directories. When you run this command without any parameters, the command tests calendar connectivity against all Outlook on the web virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-CalendarConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-LightMode] [-MailboxServer <ServerIdParameter>] [-MonitoringContext] [-ResetTestAccountCredentials] - [-TestType <Internal | External>] [-Timeout <UInt32>] [-TrustAnySSLCertificate] - [-VirtualDirectoryName <String>] [-WhatIf] [<CommonParameters>] +Test-CalendarConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-LightMode] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-ResetTestAccountCredentials] + [-TestType <OwaConnectivityTestType>] + [-Timeout <UInt32>] + [-TrustAnySSLCertificate] + [-VirtualDirectoryName <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -38,27 +50,20 @@ If the server hosting the test mailbox isn't available, the command returns an e The test results are displayed on-screen. The cmdlet returns the following information. - CasServer: The Exchange server that the client connected to. - - LocalSite: The name of the local Active Directory site. - -- Scenario: The operations that are tested. Values are: Logon, CalendaICS and CalendarHTML. - +- Scenario: The operations that are tested. Values are: Logon, CalendarICS and CalendarHTML. - Result: The values returned are typically Success, Skipped or Failure. - - Latency(MS): The time required to complete the test in milliseconds. - - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: - -Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "C:\\My Documents\\Calendar Test.html" +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\Calendar Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-CalendarConnectivity -ClientAccessServer MBX01 ``` @@ -72,11 +77,8 @@ The ClientAccessServer parameter specifies the Exchange server to test. This ser You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID ```yaml @@ -84,6 +86,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -94,8 +97,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -103,6 +105,7 @@ 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 @@ -118,6 +121,7 @@ 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 @@ -133,6 +137,7 @@ 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 @@ -141,16 +146,13 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. @@ -160,6 +162,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -168,13 +171,16 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -183,13 +189,16 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -201,10 +210,11 @@ Accept wildcard characters: False The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. ```yaml -Type: Internal | External +Type: OwaConnectivityTestType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -220,6 +230,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -235,6 +246,7 @@ 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 @@ -252,6 +264,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -267,6 +280,7 @@ 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 @@ -275,20 +289,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/48e305d0-426b-455f-b160-41b199d6fdee.aspx) diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md new file mode 100644 index 0000000000..3389d80031 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md @@ -0,0 +1,251 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ClientAccessRule + +## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ClientAccessRule -AuthenticationType <ClientAccessAuthenticationMethod> -Protocol <ClientAccessProtocol> -RemoteAddress <IPAddress> -RemotePort <Int32> -User <MailboxIdParameter> + [-Confirm] + [-OAuthClaims <Hashtable>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. + +**Note**: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: + +- OutlookWebApp:BasicAuthentication and AdfsAuthentication. +- ExchangeAdminCenter:BasicAuthentication and AdfsAuthentication. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-ClientAccessRule -AuthenticationType BasicAuthentication -Protocol OutlookWebApp -RemoteAddress 172.17.17.26 -RemotePort 443 -User julia@contoso.com +``` + +This example tests client access by using the following client properties: + +- Authentication type: Basic +- Protocol:OutlookWebApp +- Remote address: 172.17.17.26 +- Remote port: 443 +- User: julia@contoso.com + +## PARAMETERS + +### -AuthenticationType +The AuthenticationType parameter specifies the client authentication type to test. + +Valid values for this parameter are: + +- AdfsAuthentication +- BasicAuthentication +- CertificateBasedAuthentication +- NonBasicAuthentication +- OAuthAuthentication + +In client access rules, authentication types are defined by the AnyOfAuthenticationTypes and ExceptAnyOfAuthenticationTypes parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +The Protocol parameter specifies the client protocol to test. + +Valid values for this parameter are: + +- ExchangeActiveSync +- ExchangeAdminCenter +- ExchangeWebServices +- IMAP4 +- OfflineAddressBook +- OutlookAnywhere +- OutlookWebApp +- POP3 +- PowerShellWebServices +- RemotePowerShell +- REST + +In client access rules, protocol types are defined by the AnyOfProtocols and ExceptAnyOfProtocols parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteAddress +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemotePort +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter specifies the user account to test. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +In client access rules, users are defined by the UsernameMatchesAnyOfPatterns, UserRecipientFilter, and ExceptUsernameMatchesAnyOfPatterns parameters. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OAuthClaims +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/exchange/Test-DataClassification.md new file mode 100644 index 0000000000..7d9109fd68 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-DataClassification.md @@ -0,0 +1,149 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Test-DataClassification cmdlet to find the confidence and count of a sensitive information type that's found in a specified text string. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-DataClassification + [-ClassificationNames <String[]>] + [-DomainController <Fqdn>] + [-FileExtension <String>] + [-TestTextExtractionResults <TestTextExtractionResult[]>] + [-TextToClassify <String>] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +$r = Test-DataClassification -TextToClassify "Credit card information Visa: xxxx xxxx xxxx xxxx. Patient Identifier or SSN: xxx-xx-xxxx" + +$r.ClassificationResults +``` + +This example lists all sensitive info types, their count, and confidence in the specified text string. + +## PARAMETERS + +### -ClassificationNames +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 +- Id (GUID value) + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is functional only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileExtension +This parameter is available only in the cloud-based service. + +{{ Fill FileExtension Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestTextExtractionResults +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 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TextToClassify +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/client-access/Test-EcpConnectivity.md b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md similarity index 76% rename from exchange/exchange-ps/exchange/client-access/Test-EcpConnectivity.md rename to exchange/exchange-ps/exchange/Test-EcpConnectivity.md index cb9e13c9ae..81cf892ecd 100644 --- a/exchange/exchange-ps/exchange/client-access/Test-EcpConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-EcpConnectivity @@ -13,17 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Test-EcpConnectivity cmdlet to test connectivity to Exchange Control Panel (ECP) virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-EcpConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-LightMode] [-MailboxServer <ServerIdParameter>] [-MonitoringContext] [-ResetTestAccountCredentials] - [-RSTEndpoint <String>] [-TestType <Internal | External>] [-Timeout <UInt32>] [-TrustAnySSLCertificate] - [-VirtualDirectoryName <String>] [-WhatIf] [<CommonParameters>] +Test-EcpConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-LightMode] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-ResetTestAccountCredentials] + [-RSTEndpoint <String>] + [-TestType <OwaConnectivityTestType>] + [-Timeout <UInt32>] + [-TrustAnySSLCertificate] + [-VirtualDirectoryName <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -36,27 +49,20 @@ The first time you use this cmdlet, you might be required to create a test user. The test results are displayed on-screen. The cmdlet returns the following information. - CasServer: The Exchange server that the client connected to. - - LocalSite: The name of the local Active Directory site. - - Scenario: The operations that are tested. Values are: Logon and Sign in. - - Result: The values returned are typically Success, Skipped or Failure. - - Latency(MS): The time required to complete the test in milliseconds. - - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: - -Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "C:\\My Documents\\EAC Test.html" +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAC Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-EcpConnectivity -ClientAccessServer Server01 ``` @@ -70,11 +76,8 @@ The ClientAccessServer parameter specifies the Exchange server to test. This ser You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID ```yaml @@ -82,6 +85,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -92,8 +96,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -101,6 +104,7 @@ 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 @@ -116,6 +120,7 @@ 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 @@ -131,6 +136,7 @@ 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 @@ -139,16 +145,13 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. @@ -158,6 +161,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -166,13 +170,16 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -181,13 +188,16 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -203,6 +213,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -214,10 +225,11 @@ Accept wildcard characters: False The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. ```yaml -Type: Internal | External +Type: OwaConnectivityTestType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -233,6 +245,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -241,7 +254,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -250,6 +263,7 @@ 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 @@ -267,6 +281,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -282,6 +297,7 @@ 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 @@ -290,20 +306,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/fbab57b0-acfc-46df-9910-06f27c002e96.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Test-EdgeSynchronization.md b/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md similarity index 76% rename from exchange/exchange-ps/exchange/mail-flow/Test-EdgeSynchronization.md rename to exchange/exchange-ps/exchange/Test-EdgeSynchronization.md index 77fb47a8af..8f9a1e1fb9 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Test-EdgeSynchronization.md +++ b/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-EdgeSynchronization @@ -13,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-EdgeSynchronization cmdlet to diagnose whether the subscribed Edge Transport servers have a current and accurate synchronization status. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -22,15 +25,21 @@ For information about the parameter sets in the Syntax section below, see Exchan Test-EdgeSynchronization -VerifyRecipient <ProxyAddress> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### Default ``` -Test-EdgeSynchronization [-ExcludeRecipientTest] [-FullCompareMode] [-MaxReportSize <Unlimited>] [-MonitoringContext <$true | $false>] [-TargetServer <String>] +Test-EdgeSynchronization [-ExcludeRecipientTest] + [-FullCompareMode] + [-MaxReportSize <Unlimited>] + [-MonitoringContext <Boolean>] + [-TargetServer <String>] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -38,19 +47,19 @@ The Test-EdgeSynchronization cmdlet is a diagnostic cmdlet that provides a repor This cmdlet compares the data stored in Active Directory and the data stored in AD LDS. Any inconsistencies in data are reported in the results output by this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-EdgeSynchronization -MaxReportSize 500 -MonitoringContext $true ``` This example diagnoses the synchronization status of subscribed Edge Transport servers, outputs only the first 500 data inconsistencies, and generates events and performance counters for use by System Center Operations Manager 2007. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Test-EdgeSynchronization -VerifyRecipient kate@contoso.com ``` @@ -66,6 +75,7 @@ Type: ProxyAddress Parameter Sets: SingleValidation Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -76,8 +86,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -85,6 +94,7 @@ 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 @@ -100,6 +110,7 @@ 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 @@ -108,13 +119,16 @@ Accept wildcard characters: False ``` ### -ExcludeRecipientTest -The ExcludeRecipientTest switch specifies whether to exclude validation of recipient data synchronization. If you include this switch, only the synchronization of configuration objects is validated. Validating that recipient data is synchronized takes longer than validating only configuration data. You don't have to include a value with this switch. +The ExcludeRecipientTest switch specifies whether to exclude validation of recipient data synchronization. You don't need to specify a value with this switch. + +If you use this switch, only the synchronization of configuration objects is validated. Validating that recipient data is synchronized takes longer than validating only configuration data. ```yaml Type: SwitchParameter Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -123,13 +137,16 @@ Accept wildcard characters: False ``` ### -FullCompareMode -The FullCompareMode switch specifies whether a full comparison of the configuration data between Active Directory and AD LDS instance on the target Edge Transport server is performed. If you don't use this switch, a full comparison of replicated configuration data is skipped and the command only tests the Edge synchronization by verifying the replication cookie. +The FullCompareMode switch specifies whether a full comparison of the configuration data between Active Directory and AD LDS instance on the target Edge Transport server is performed. You don't need to specify a value with this switch. + +If you don't use this switch, a full comparison of replicated configuration data is skipped and the command only tests the Edge synchronization by verifying the replication cookie. ```yaml Type: SwitchParameter Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -145,6 +162,7 @@ Type: Unlimited Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -153,13 +171,17 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -177,6 +199,7 @@ Type: String Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -192,6 +215,7 @@ 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 @@ -200,20 +224,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/2d6bc8d2-aa4c-497a-beaf-ec99b10a6a96.aspx) diff --git a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md b/exchange/exchange-ps/exchange/Test-ExchangeSearch.md new file mode 100644 index 0000000000..de07b2a9a7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ExchangeSearch.md @@ -0,0 +1,274 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ExchangeSearch + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-ExchangeSearch cmdlet to test that Exchange Search is currently enabled and is indexing new email messages in a timely manner. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity +``` +Test-ExchangeSearch [[-Identity] <MailboxIdParameter>] + [-Archive] + [-Confirm] + [-DomainController <Fqdn>] + [-IndexingTimeoutInSeconds <Int32>] + [-MonitoringContext] + [-WhatIf] + [<CommonParameters>] +``` + +### Database +``` +Test-ExchangeSearch [-MailboxDatabase <DatabaseIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-IndexingTimeoutInSeconds <Int32>] + [-MonitoringContext] + [-WhatIf] + [<CommonParameters>] +``` + +### Server +``` +Test-ExchangeSearch [-Server <ServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-IndexingTimeoutInSeconds <Int32>] + [-MonitoringContext] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-ExchangeSearch cmdlet creates a hidden message and an attachment in the specified mailbox that's visible only to Exchange Search. The command waits for the message to be indexed and then searches for the content. It reports success or failure depending on whether the message is found after the interval set in the IndexingTimeoutInSeconds parameter has elapsed. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Test-ExchangeSearch -Identity john@contoso.com +``` + +This example tests Exchange Search results for the mailbox database on which the specified mailbox resides. + +### Example 2 +```powershell +Test-ExchangeSearch -Identity john@contoso.com -Verbose +``` + +This example tests Exchange Search results for the mailbox database on which the specified mailbox resides. The Verbose switch is used to display detailed information. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the MailboxDatabase or Server parameters. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Archive +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -IndexingTimeoutInSeconds +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxDatabase +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: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity or Server parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MonitoringContext +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Server parameter 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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can't use this parameter with the MailboxDatabase or Identity parameters. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +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 +``` + +### -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/Test-FederationTrust.md b/exchange/exchange-ps/exchange/Test-FederationTrust.md new file mode 100644 index 0000000000..d8910cf09d --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-FederationTrust.md @@ -0,0 +1,168 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-FederationTrust + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-FederationTrust cmdlet to verify that the federation trust is properly configured and functioning as expected. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-FederationTrust [-Confirm] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-UserIdentity <RecipientIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: + +& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 + +You can run the Test-FederationTrust cmdlet from the Exchange Management Shell, or a monitoring system can run the test periodically. + +The Test-FederationTrust cmdlet runs the following series of tests to ensure that federation is working as expected: + +- A connection to the Microsoft Federation Gateway is established. This test ensures that communication between the local Exchange server and the Microsoft Federation Gateway is working correctly. +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-FederationTrust +``` + +This example validates the federation trust deployed in the Exchange organization and checks whether a security token can be retrieved from the Microsoft Federation Gateway. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```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 +``` + +### -MonitoringContext +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -UserIdentity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +If you don't specify a mailbox, the command uses the default test mailbox. + +```yaml +Type: RecipientIdParameter +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 +``` + +### -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/Test-FederationTrustCertificate.md b/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md new file mode 100644 index 0000000000..d26350dd00 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md @@ -0,0 +1,112 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-FederationTrustCertificate + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-FederationTrustCertificate cmdlet to check the status of certificates that are used for federation on all Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-FederationTrustCertificate [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-FederationTrustCertificate +``` + +This example reports the status of federation certificates. + +## PARAMETERS + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```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 +``` + +### -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/antispam-antimalware/Test-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Test-IPAllowListProvider.md rename to exchange/exchange-ps/exchange/Test-IPAllowListProvider.md index b3cbf03186..4b2de63622 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Test-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-IPAllowListProvider @@ -13,13 +16,17 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Test-IPAllowListProvider cmdlet to test IP Allow list providers on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-IPAllowListProvider [-Identity] <IPAllowListProviderIdParameter> -IPAddress <IPAddress> [-Confirm] - [-DomainController <Fqdn>] [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] +Test-IPAllowListProvider [-Identity] <IPAllowListProviderIdParameter> -IPAddress <IPAddress> + [-Confirm] + [-DomainController <Fqdn>] + [-Server <ServerIdParameter>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -29,8 +36,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-IPAllowListProvider Contoso.com -IPAddress 192.168.0.1 ``` @@ -42,9 +49,7 @@ This example tests the existing IP Allow list provider named Contoso,com by send 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 - - Distinguished name (DN) - - GUID ```yaml @@ -52,6 +57,7 @@ Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -67,6 +73,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -77,8 +84,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -86,6 +92,7 @@ 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 @@ -103,6 +110,7 @@ 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 @@ -114,11 +122,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -130,6 +135,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -145,6 +151,7 @@ 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 @@ -153,20 +160,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/921b36a2-21a5-48df-aa83-f9ea9c771787.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Test-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md similarity index 83% rename from exchange/exchange-ps/exchange/antispam-antimalware/Test-IPBlockListProvider.md rename to exchange/exchange-ps/exchange/Test-IPBlockListProvider.md index 33a3344e37..7ab51aad23 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Test-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-IPBlockListProvider @@ -13,13 +16,17 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Test-IPBlockListProvider cmdlet to test IP Block list providers on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-IPBlockListProvider [-Identity] <IPBlockListProviderIdParameter> -IPAddress <IPAddress> [-Confirm] - [-DomainController <Fqdn>] [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] +Test-IPBlockListProvider [-Identity] <IPBlockListProviderIdParameter> -IPAddress <IPAddress> + [-Confirm] + [-DomainController <Fqdn>] + [-Server <ServerIdParameter>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -29,8 +36,8 @@ On Edge Transport servers, you need to be a member of the local Administrators g ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-IPBlockListProvider Contoso.com -IPAddress 192.168.0.1 ``` @@ -42,9 +49,7 @@ This example tests the existing IP Block list provider named Contoso.com by send 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 - - Distinguished name (DN) - - GUID ```yaml @@ -52,6 +57,7 @@ Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -67,6 +73,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -77,8 +84,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -86,6 +92,7 @@ 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 @@ -103,6 +110,7 @@ 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 @@ -114,11 +122,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -130,6 +135,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -145,6 +151,7 @@ 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 @@ -153,20 +160,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e62249a5-b55c-47c9-b2d9-b77caef1c2d6.aspx) diff --git a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md b/exchange/exchange-ps/exchange/Test-IRMConfiguration.md new file mode 100644 index 0000000000..c3b0a5ae4e --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-IRMConfiguration.md @@ -0,0 +1,196 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Test-IRMConfiguration cmdlet to test Information Rights Management (IRM) configuration and functionality. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-IRMConfiguration [[-Identity] <OrganizationIdParameter>] -Sender <SmtpAddress> + [-Confirm] + [-DomainController <Fqdn>] + [-Recipient <SmtpAddress[]>] + [-RMSOnline] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-IRMConfiguration cmdlet performs a series of steps to test IRM configuration and functionality, including availability of an Active Directory Rights Management Services (AD RMS) server, prelicensing and journal report decryption. In Exchange Online organizations, it checks connectivity to RMS Online and obtains and validates the organization's Trusted Publishing Domain (TPD). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Test-IRMConfiguration -Sender adams@contoso.com +``` + +This example tests the IRM configuration in on-premises Exchange for messages sent from the sender adams@contoso.com. + +### Example 2 +```powershell +Test-IRMConfiguration -Sender chris@fabrikam.com -Recipient michell@fourthcoffee.com +``` + +This example tests the IRM configuration in the cloud-based service for messages sent from chris@fabrikam.com to michell@fourthcoffee.com. + +## PARAMETERS + +### -Identity +This parameter is available only in on-premises Exchange. + +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Sender +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recipient +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. + +In on-premises Exchange, if you don't use this parameter, the sender address that's specified by the Sender parameter is used for the value of this parameter. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RMSOnline +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Test-ImapConnectivity.md b/exchange/exchange-ps/exchange/Test-ImapConnectivity.md new file mode 100644 index 0000000000..44bf2c9053 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ImapConnectivity.md @@ -0,0 +1,363 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ImapConnectivity + +## SYNOPSIS +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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ImapConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-Confirm] + [-ConnectionType <ProtocolConnectionType>] + [-DomainController <Fqdn>] + [-LightMode] + [-MailboxCredential <PSCredential>] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-PerConnectionTimeout <Int32>] + [-PortClientAccessServer <Int32>] + [-ResetTestAccountCredentials] + [-Timeout <UInt32>] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-ImapConnectivity cmdlet tests IMAP4 connectivity by connecting to the specified mailbox, the specified Exchange server, or all Exchange servers that are available in the local Active Directory site. + +The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: + +& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 + +The test results are displayed on-screen. The cmdlet returns the following information. + +- CasServer: The Exchange server that the client connected to. +- LocalSite: The name of the local Active Directory site. +- Scenario: The operations that are tested. Test IMAP4 Connectivity connects to the server using the IMAP4 protocol, searches for the test message and deletes it along with any messages that are older than 24 hours. +- Result: The values returned are typically Success, Skipped or Failure. +- Latency(MS): The time required to complete the test in milliseconds. +- Error: Any error messages that were encountered. + +You can write the results to a file by piping the output to ConvertTo-Html 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). + +**Note**: In Exchange 2013 or later, when you run this command to test a single mailbox on an Exchange server that isn't hosting the active mailbox database copy for the mailbox, you might see the following error message: + +`Unable to create MailboxSession object to access the mailbox [user@contoso.com]. Detailed error information: [Microsoft.Exchange.Data.Storage.WrongServerException]: The user and the mailbox are in different Active Directory sites. Inner error [Microsoft.Mapi.MapiExceptionMailboxInTransit]: MapiExceptionMailboxInTransit: Detected site violation (hr=0x0, ec=1292)` + +When you receive this error, run the command again on the server that's hosting the active mailbox database copy to verify that IMAP works for the mailbox. + +## EXAMPLES + +### Example 1 +```powershell +Test-ImapConnectivity -ClientAccessServer Contoso12 -MailboxCredential (Get-Credential contoso\kweku) +``` + +This example tests the client IMAP4 connectivity for the server named Contoso12 by using the credentials for the user contoso\\kweku. + +### Example 2 +```powershell +Test-ImapConnectivity -ClientAccessServer Contoso12 +``` + +This example tests the client IMAP4 connectivity of the server named Contoso12 and tests all Exchange mailboxes. + +## PARAMETERS + +### -ClientAccessServer +The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. + +You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -ConnectionType +The ConnectionType parameter specifies the type of connection that's used to connect to the IMAP4 service. Valid values are: + +- Plaintext +- Ssl +- Tls + +```yaml +Type: ProtocolConnectionType +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 +``` + +### -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 +``` + +### -LightMode +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxCredential +The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxServer +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: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. + +```yaml +Type: ServerIdParameter +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 +``` + +### -MonitoringContext +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). + +```yaml +Type: SwitchParameter +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 +``` + +### -PerConnectionTimeout +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. + +```yaml +Type: Int32 +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 +``` + +### -PortClientAccessServer +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetTestAccountCredentials +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. + +```yaml +Type: SwitchParameter +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 +``` + +### -Timeout +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. + +```yaml +Type: UInt32 +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 +``` + +### -TrustAnySSLCertificate +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. + +```yaml +Type: SwitchParameter +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 +``` + +### -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/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..f166b0c365 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Test-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Test-M365DataAtRestEncryptionPolicy cmdlet to test an existing Microsoft 365 data-at-rest encryption policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-M365DataAtRestEncryptionPolicy [[-Identity] <DataEncryptionPolicyIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Test-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" +``` + +This example tests the Microsoft 365 data-at-rest encryption policy named Contoso Corporate. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +You can find the existing data-at-rest encryption policies by using the Get-M365DataAtRestEncryptionPolicy cmdlet. + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md b/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md new file mode 100644 index 0000000000..0b615b567c --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md @@ -0,0 +1,389 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Database +``` +Test-MAPIConnectivity -Database <DatabaseIdParameter> + [-ActiveDirectoryTimeout <Int32>] + [-AllConnectionsTimeout <Int32>] + [-Confirm] + [-CopyOnServer <ServerIdParameter>] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-PerConnectionTimeout <Int32>] + [-WhatIf] + [<CommonParameters>] +``` + +### Identity +``` +Test-MAPIConnectivity [-Identity] <MailboxIdParameter> + [-ActiveDirectoryTimeout <Int32>] + [-AllConnectionsTimeout <Int32>] + [-Archive] + [-Confirm] + [-CopyOnServer <ServerIdParameter>] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-PerConnectionTimeout <Int32>] + [-WhatIf] + [<CommonParameters>] +``` + +### Server +``` +Test-MAPIConnectivity [-Server <ServerIdParameter>] + [-ActiveDirectoryTimeout <Int32>] + [-AllConnectionsTimeout <Int32>] + [-Confirm] + [-DomainController <Fqdn>] + [-IncludePassive] + [-MonitoringContext <Boolean>] + [-PerConnectionTimeout <Int32>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-MapiConnectivity cmdlet verifies server functionality. This cmdlet logs on to the mailbox that you specify (or to the SystemMailbox if you don't specify the Identity parameter) and retrieves a list of items in the Inbox. Logging on to the mailbox tests two critical protocols used when a client connects to a Mailbox server: MAPI and LDAP. During authentication, the Test-MapiConnectivity cmdlet indirectly verifies that the MAPI server, Exchange store, and Directory Service Access (DSAccess) are working. + +The cmdlet logs on to the mailbox that you specify using the credentials of the account with which you're logged on to the local computer. After a successful authentication, the Test-MapiConnectivity cmdlet accesses the mailbox to verify that the database is working. If a successful connection to a mailbox is made, the cmdlet also determines the time that the logon attempt occurred. + +There are three distinct parameters that you can use with the command: Database, Identity and Server: + +- The Database parameter takes a database identity and tests the ability to log on to the system mailbox on the specified 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-MapiConnectivity -Server "Server01" +``` + +This example tests connectivity to the server Server01. + +### Example 2 +```powershell +Test-MapiConnectivity -Identity "midwest\john" +``` + +This example tests connectivity to a mailbox, specified as a domain name and user name. + +## PARAMETERS + +### -Identity +The Identity parameter specifies a mailbox to test. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +This cmdlet accepts pipeline input from the Get-Mailbox or Get-Recipient cmdlet. If you pipe the identify from the Get-Mailbox or Get-Recipient cmdlets, you don't need to use this parameter. + +If you don't use this parameter, the cmdlet tests the SystemMailbox on the database that you specify. + +You can't use the Identity, Database, or Server parameters in the same command. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Database +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: + +- Name +- Distinguished name (DN) +- GUID + +If you don't use this parameter or the Identity parameter, the command tests the SystemMailbox on each active database on the Exchange server (the local Exchange server or the server you specify with the Server parameter). + +You can't use the Identity, Database, or Server parameters in the same command. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveDirectoryTimeout +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. + +```yaml +Type: Int32 +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 +``` + +### -AllConnectionsTimeout +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. + +```yaml +Type: Int32 +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 +``` + +### -Archive +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. + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -CopyOnServer +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +You can only use this parameter with the Server parameter, not the Identify or Database parameters. + +```yaml +Type: ServerIdParameter +Parameter Sets: Database, Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +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 +``` + +### -IncludePassive +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. + +If you don't use this switch, the command tests MAPI connectivity from active database copies only. + +```yaml +Type: SwitchParameter +Parameter Sets: Server +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 +``` + +### -MonitoringContext +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. + +```yaml +Type: Boolean +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 +``` + +### -PerConnectionTimeout +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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't specify this parameter, the command tests the mailbox on the local server. + +You can't use the Identity, Database, or Server parameters in the same command. + +```yaml +Type: ServerIdParameter +Parameter Sets: Server +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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/mailbox-databases-and-servers/Test-MRSHealth.md b/exchange/exchange-ps/exchange/Test-MRSHealth.md similarity index 75% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-MRSHealth.md rename to exchange/exchange-ps/exchange/Test-MRSHealth.md index fb10976add..c4208ccf1f 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-MRSHealth.md +++ b/exchange/exchange-ps/exchange/Test-MRSHealth.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-MRSHealth @@ -13,32 +16,38 @@ This cmdlet is available only in on-premises Exchange. Use the Test-MRSHealth cmdlet to test the health of an instance of the Microsoft Exchange Mailbox Replication service. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-MRSHealth [[-Identity] <ServerIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-MaxQueueScanAgeSeconds <Int32>] [-MonitoringContext <$true | $false>] [-WhatIf] - [-MRSProxyCredentials <PSCredential>] [-MRSProxyServer <Fqdn>] [<CommonParameters>] +Test-MRSHealth [[-Identity] <ServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-MaxQueueScanAgeSeconds <Int32>] + [-MonitoringContext <Boolean>] + [-MRSProxyCredentials <PSCredential>] + [-MRSProxyServer <Fqdn>] + [-WhatIf] + [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Get-MailboxServer | Test-MRSHealth ``` This example tests the health of the Mailbox Replication service on all Mailbox servers. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Test-MRSHealth MBX01 ``` @@ -46,33 +55,41 @@ This example tests the health of the Mailbox Replication service on the Mailbox ## PARAMETERS -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. +### -Identity +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: -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +If you don't specify the server, the command runs on the local server. ```yaml -Type: SwitchParameter +Type: ServerIdParameter Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -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. +### -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: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -80,28 +97,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -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 - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -If you don't specify the server, the command runs on the local server. +### -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: ServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -113,6 +121,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -121,28 +130,17 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml -Type: $true | $false +Type: Boolean 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 -``` -### -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 @@ -153,13 +151,14 @@ Accept wildcard characters: False ### -MRSProxyCredentials The MRSProxyCredentials parameter specifies the credentials that are required for the MRSProxyPingCheck test on the server that's specified by the MRSProxyServer parameter. -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -173,9 +172,7 @@ The MRSProxyServer parameter specifies the fully qualified domain name (FQDN) of 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: - If you specify an MRSProxyServer value and you specify the source server by using the Identity parameter, the test is performed between that server and the target server specified by the MRSProxyServer parameter. - - If you specify an MRSProxyServer value and you don't specify a source server by using the Identity parameter, the test is performed between the local server and the target server specified by the MRSProxyServer parameter. - - If you don't specify an MRSProxyServer value or an Identity value, the test is performed between the Mailbox Replication service and the Mailbox Replication proxy service on the local server. ```yaml @@ -183,6 +180,23 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 @@ -191,20 +205,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/42de31ff-ba85-4e47-9da9-00a9a5f7a29f.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Test-Mailflow.md b/exchange/exchange-ps/exchange/Test-Mailflow.md similarity index 79% rename from exchange/exchange-ps/exchange/mail-flow/Test-Mailflow.md rename to exchange/exchange-ps/exchange/Test-Mailflow.md index e48213a57b..628848623e 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Test-Mailflow.md +++ b/exchange/exchange-ps/exchange/Test-Mailflow.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-Mailflow @@ -13,31 +16,37 @@ This cmdlet is available only in on-premises Exchange. Use the Test-Mailflow cmdlet to diagnose whether mail can be successfully sent from and delivered to the system mailbox on a Mailbox server. You can also use this cmdlet to verify that email is sent between Mailbox servers within a defined latency threshold. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### AutoDiscoverTargetMailboxServer ``` -Test-Mailflow [[-Identity] <ServerIdParameter>] [-AutoDiscoverTargetMailboxServer] +Test-Mailflow [[-Identity] <ServerIdParameter>] + [-AutoDiscoverTargetMailboxServer] [-ActiveDirectoryTimeout <Int32>] [-Confirm] [-DomainController <Fqdn>] [-ErrorLatency <Int32>] [-ExecutionTimeout <Int32>] - [-MonitoringContext <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ### CrossPremises ``` -Test-Mailflow -CrossPremises <$true | $false> [-ActiveDirectoryTimeout <Int32>] [-CrossPremisesExpirationTimeout <EnhancedTimeSpan>] [-CrossPremisesPendingErrorCount <Int32>] +Test-Mailflow -CrossPremises <Boolean> + [-ActiveDirectoryTimeout <Int32>] + [-CrossPremisesExpirationTimeout <EnhancedTimeSpan>] + [-CrossPremisesPendingErrorCount <Int32>] [-Confirm] [-DomainController <Fqdn>] [-ErrorLatency <Int32>] [-ExecutionTimeout <Int32>] - [-MonitoringContext <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ### TargetDatabase @@ -48,20 +57,23 @@ Test-Mailflow [[-Identity] <ServerIdParameter>] -TargetDatabase <DatabaseIdParam [-DomainController <Fqdn>] [-ErrorLatency <Int32>] [-ExecutionTimeout <Int32>] - [-MonitoringContext <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ### TargetEmailAddress ``` -Test-Mailflow [[-Identity] <ServerIdParameter>] -TargetEmailAddress <String> [-TargetEmailAddressDisplayName <String>] +Test-Mailflow [[-Identity] <ServerIdParameter>] -TargetEmailAddress <String> + [-TargetEmailAddressDisplayName <String>] [-ActiveDirectoryTimeout <Int32>] [-Confirm] [-DomainController <Fqdn>] [-ErrorLatency <Int32>] [-ExecutionTimeout <Int32>] - [-MonitoringContext <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ### TargetMailboxServer @@ -72,7 +84,7 @@ Test-Mailflow [[-Identity] <ServerIdParameter>] -TargetMailboxServer <ServerIdPa [-DomainController <Fqdn>] [-ErrorLatency <Int32>] [-ExecutionTimeout <Int32>] - [-MonitoringContext <$true | $false>] + [-MonitoringContext <Boolean>] [-WhatIf] [<CommonParameters>] ``` @@ -85,36 +97,36 @@ Test-Mailflow [[-Identity] <ServerIdParameter>] [-DomainController <Fqdn>] [-ErrorLatency <Int32>] [-ExecutionTimeout <Int32>] - [-MonitoringContext <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION The Test-Mailflow cmdlet tests mail submission, transport, and delivery. The cmdlet verifies that each Mailbox server can successfully send itself a message. You can also use this cmdlet to verify that the system mailbox on one Mailbox server can successfully send a message to the system mailbox on another Mailbox server. A system mailbox is required on all servers that are involved in the test. -The test messages are available in the target user or system mailbox. The message subject is Test-Mailflow \<GUID\>, and the message body contains the text This is a Test-Mailflow probe message. +The test messages are available in the target user or system mailbox. The message subject is `Test-Mailflow <GUID>`, and the message body contains the text `This is a Test-Mailflow probe message`. The Test-Mailflow results are displayed on-screen. The interesting values in the results are: - TestMailflowResult: The values returned are typically Success or \*FAILURE\*. - - MessageLatencyTime: The time required to complete the test (deliver the test message). The value uses the syntax hh:mm:ss.ffff where hh = hours, mm = minutes, ss = seconds and ffff = fractions of a second. -You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding "\> \<filename\>" to the command. For example: +You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > <filename>` 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell 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. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Test-Mailflow -TargetEmailAddress john@contoso.com ``` @@ -122,8 +134,33 @@ This example tests message flow from the local Mailbox server where you're runni ## PARAMETERS +### -Identity +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the local Mailbox server is used. + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -AutoDiscoverTargetMailboxServer -The AutoDiscoverTargetMailboxServer switch specifies whether to automatically populate a list of target Mailbox servers to which to send a test message. The task queries Active Directory to discover all Mailbox servers and then sends each server a test message. +The AutoDiscoverTargetMailboxServer switch specifies whether to automatically populate a list of target Mailbox servers to which to send a test message. You don't need to specify a value with this switch. + +The task queries Active Directory to discover all Mailbox servers and then sends each server a test message. When you use this switch, you can't use the CrossPremises, TargetDatabase, TargetEmailAddress or TargetMailboxServer parameters. @@ -132,6 +169,7 @@ Type: SwitchParameter Parameter Sets: AutoDiscoverTargetMailboxServer Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -147,10 +185,11 @@ Set this parameter to $true if your organization is using a cross-premises deplo When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, TargetDatabase, TargetEmailAddress or TargetMailboxServer parameters. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: CrossPremises Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -159,15 +198,20 @@ Accept wildcard characters: False ``` ### -TargetDatabase -The TargetDatabase parameter specifies the mailbox database to which test messages are sent. +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 +- Distinguished name (DN) +- GUID -When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, CrossPremises, TargetEmailAddress or TargetMailboxServer parameters. +You can't use this parameter with the AutoDiscoverTargetMailboxServer, CrossPremises, TargetEmailAddress or TargetMailboxServer parameters. ```yaml Type: DatabaseIdParameter Parameter Sets: TargetDatabase Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -185,6 +229,7 @@ Type: String Parameter Sets: TargetEmailAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -193,7 +238,12 @@ Accept wildcard characters: False ``` ### -TargetMailboxServer -The TargetMailboxServer parameter specifies one or more Mailbox servers in the local Exchange organization to which test messages are sent. +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, CrossPremises, TargetDatabase or TargetEmailAddress parameters. @@ -202,6 +252,7 @@ Type: ServerIdParameter Parameter Sets: TargetMailboxServer Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -217,6 +268,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -227,8 +279,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -236,6 +287,7 @@ 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 @@ -251,6 +303,7 @@ Type: EnhancedTimeSpan Parameter Sets: CrossPremises Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -266,6 +319,7 @@ Type: Int32 Parameter Sets: CrossPremises Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -281,6 +335,7 @@ 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 @@ -296,6 +351,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -311,6 +367,7 @@ Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -318,29 +375,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the source Mailbox server name from which a test message is sent. If you don't use this parameter, the local Mailbox server is used. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -358,6 +404,7 @@ Type: String Parameter Sets: TargetEmailAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -373,6 +420,7 @@ 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 @@ -381,20 +429,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/00acaba4-66ee-454a-b9db-fe6d80c13f28.aspx) diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md new file mode 100644 index 0000000000..c4b62c4ac7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/test-message +applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection +title: Test-Message +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-Message + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Test-Message cmdlet to simulate and report on the effects of mail flow rules (transport rules) and unified DLP rules on test email messages. Because this cmdlet introduces email into the DLP evaluation pipeline, actions such as Block, Moderate, etc. can take place on the test message. Related notifications will also be sent to any configured recipients. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### TransportRules +``` +Test-Message -Recipients <ProxyAddressCollection> -SendReportTo <RecipientIdParameter> [-TransportRules] + [-Confirm] + [-Force] + [-MessageFileData <Byte[]>] + [-Sender <SmtpAddress>] + [-UnifiedDlpRules] + [-WhatIf] + [<CommonParameters>] +``` + +### UnifiedDLPRules +``` +Test-Message -Recipients <ProxyAddressCollection> -SendReportTo <RecipientIdParameter> [-UnifiedDlpRules] + [-Confirm] + [-Force] + [-MessageFileData <Byte[]>] + [-Sender <SmtpAddress>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$data = [System.IO.File]::ReadAllBytes('C:\Data\test.eml') + +Test-Message -MessageFileData $data -Sender megan@contoso.com -Recipients adele@contoso.com -SendReportTo admin@contoso.com -TransportRules -UnifiedDlpRules +``` + +This example uses the test.eml message file at C:\Data to test mail flow rules and unified DLP rules for the sender megan@contoso.com to the recipient adele@contoso.com. The results report is sent to admin@contoso.com. + +## PARAMETERS + +### -Recipients +The Recipients parameter specifies the recipient email address to use for the test message. + +You can specify multiple email addresses separated by commas. + +```yaml +Type: ProxyAddressCollection +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendReportTo +The SendReportTo parameter specifies the target email address for the command results. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRules +The TransportRules switch specifies that you want to test mail flow rules. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: TransportRules +Aliases: +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnifiedDlpRules +The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: UnifiedDLPRules +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: TransportRules +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageFileData +The MessageFileData parameter specifies the .eml message file to test. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sender +The Sender parameter specifies the sender email address to use for the test message. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md new file mode 100644 index 0000000000..d37917bd9e --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md @@ -0,0 +1,807 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Test-MigrationServerAvailability cmdlet to test the availability of the target server in preparation to perform cross-forest mailbox moves, migration of on-premises mailboxes to Exchange Online, or to migrate on-premises mailbox data from an IMAP server to Exchange Online mailboxes. For all migration types, the cmdlet attempts to verify the connection settings used to connect to the target server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### ExchangeRemoteMoveAutodiscover +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Autodiscover] [-ExchangeRemoteMove] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### ExchangeOutlookAnywhereAutodiscover +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Autodiscover] [-ExchangeOutlookAnywhere] + [-AcceptUntrustedCertificates] + [-Confirm] + [-MailboxPermission <MigrationMailboxPermission>] + [-Partition <MailboxIdParameter>] + [-SourceMailboxLegacyDN <String>] + [-TestMailbox <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### PSTImport +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -RemoteServer <Fqdn> [-FilePath <String>] [-PSTImport] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### ExchangeOutlookAnywhere +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -ExchangeServer <String> -RPCProxyServer <Fqdn> [-ExchangeOutlookAnywhere] + [-AcceptUntrustedCertificates] + [-Authentication <AuthenticationMethod>] + [-EmailAddress <SmtpAddress>] + [-MailboxPermission <MigrationMailboxPermission>] + [-TestMailbox <MailboxIdParameter>] + [-SourceMailboxLegacyDN <String>] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### PublicFolder +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -PublicFolderDatabaseServerLegacyDN <String> -RPCProxyServer <Fqdn> -SourceMailboxLegacyDN <String> [-PublicFolder] + [-Authentication <AuthenticationMethod>] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-TestMailbox <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### ExchangeRemoteMove +``` +Test-MigrationServerAvailability -RemoteServer <Fqdn> + [-Credentials <PSCredential>] + [-ExchangeRemoteMove] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### TestEndpoint +``` +Test-MigrationServerAvailability -Endpoint <MigrationEndpointIdParameter> + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### IMAP +``` +Test-MigrationServerAvailability -RemoteServer <Fqdn> -Port <Int32> [-Imap] + [-AcceptUntrustedCertificates] + [-Authentication <AuthenticationMethod>] + [-Security <NIMAPSecurityMechanism] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### Gmail +``` +Test-MigrationServerAvailability -ServiceAccountKeyFileData <Byte[]> [-Gmail] + [-EmailAddress <SmtpAddress>] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-TestMailbox <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### Compliance +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Compliance] + [-RemoteServer <Fqdn>] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### MrsProxyPublicFolderToUnifiedGroup +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -RemoteServer <Fqdn> + [-PublicFolderToUnifiedGroup] + [-TestMailbox <MailboxIdParameter>] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### LegacyPublicFolderToUnifiedGroup +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -PublicFolderDatabaseServerLegacyDN <String> -RPCProxyServer <Fqdn> -SourceMailboxLegacyDN <String> + [-PublicFolderToUnifiedGroup] + [-Authentication <AuthenticationMethod>] + [-TestMailbox <MailboxIdParameter>] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +### MrsProxyPublicFolder +``` +Test-MigrationServerAvailability -Credentials <PSCredential> -RemoteServer <Fqdn> + [-PublicFolder] + [-Confirm] + [-Partition <MailboxIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-MigrationServerAvailability cmdlet verifies that you can communicate with the on-premises mail server that houses the mailbox data that you want to migrate to cloud-based mailboxes. When you run this cmdlet, you must specify the migration type. You can specify whether to communicate with an IMAP server or with an Exchange server. + +For an IMAP migration, this cmdlet uses the server's fully qualified domain name (FQDN) and a port number to verify the connection. If the verification is successful, use the same connection settings when you create a migration request with the New-MigrationBatch cmdlet. + +For an Exchange migration, this cmdlet uses one of the following settings to communicate with the on-premises server: + +- For Exchange 2003, it uses the server's FQDN and credentials for an administrator account that can access the server. +- For Exchange Server 2007 and later versions, you can connect using the Autodiscover service and the email address of an administrator account that can access the server. + +If the verification is successful, you can use the same settings to create a migration endpoint. For more information, see: + +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-MigrationServerAvailability -Imap -RemoteServer imap.contoso.com -Port 143 +``` + +For IMAP migrations, this example verifies the connection to the IMAP mail server imap.contoso.com. + +### Example 2 +```powershell +$Credentials = Get-Credential + +Test-MigrationServerAvailability -ExchangeOutlookAnywhere -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials +``` + +This example uses the Autodiscover and ExchangeOutlookAnywhere parameters to verify the connection to an on-premises Exchange server in preparation for migrating on-premises mailboxes to Exchange Online. You can use a similar example to test the connection settings for a staged Exchange migration or a cutover Exchange migration. + +### Example 3 +```powershell +$Credentials = Get-Credential + +Test-MigrationServerAvailability -ExchangeOutlookAnywhere -ExchangeServer exch2k3.contoso.com -Credentials $Credentials -RPCProxyServer mail.contoso.com -Authentication NTLM +``` + +This example verifies the connection to a server running Microsoft Exchange Server 2003 named exch2k3.contoso.com and uses NTLM for the authentication method. + +### Example 4 +```powershell +Test-MigrationServerAvailability -Endpoint endpoint.contoso.com +``` + +This example verifies the connection settings to a remote server using the settings stored in an existing migration endpoint in Exchange Online. + +### Example 5 +```powershell +$MRSEndpoints = (Get-MigrationEndpoint).Identity + +Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP} +``` + +This example tests multiple existing endpoints. + +## PARAMETERS + +### -Autodiscover +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compliance +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 +Default value: None +Accept pipeline input: False +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) 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 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: PSCredential +Parameter Sets: ExchangeRemoteMove +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SmtpAddress +Parameter Sets: ExchangeOutlookAnywhere, Gmail +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeOutlookAnywhere +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. + +Use this switch if you plan to migrate mailboxes to Exchange Online using a staged Exchange migration or a cutover Exchange migration. + +```yaml +Type: SwitchParameter +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeRemoteMove +The ExchangeRemoteMove switch specifies a migration type where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. You don't need to specify a value with this switch. + +Use this switch if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment. + +```yaml +Type: SwitchParameter +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeRemoteMove +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeServer +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. + +```yaml +Type: String +Parameter Sets: ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Imap +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. + +This switch is required when you want to migrate data from an IMAP mail server to Exchange Online mailboxes. + +```yaml +Type: SwitchParameter +Parameter Sets: IMAP +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gmail +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. + +This switch is required when you want to migrate data from a Google Workspace (formerly G Suite) tenant to Exchange Online mailboxes. + +```yaml +Type: SwitchParameter +Parameter Sets: Gmail +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +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. + +The standard is to use port 143 for unencrypted connections, port 143 for Transport Layer Security (TLS), and port 993 for Secure Sockets Layer (SSL). + +```yaml +Type: Int32 +Parameter Sets: IMAP +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSTImport +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: PSTImport +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolder +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder, MrsProxyPublicFolder +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderDatabaseServerLegacyDN +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFolderToUnifiedGroup +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteServer +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 +- Remote move (hybrid deployments) +- IMAP migration + +```yaml +Type: Fqdn +Parameter Sets: PSTImport, ExchangeRemoteMove, IMAP, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Fqdn +Parameter Sets: Compliance +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Fqdn +Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +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('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: Gmail +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMailboxLegacyDN +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. + +```yaml +Type: String +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcceptUntrustedCertificates +This parameter is available only in the cloud-based service. + +{{ Fill AcceptUntrustedCertificates Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, IMAP +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +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. + +The parameter is only used for cutover Exchange migrations and staged Exchange migrations. + +```yaml +Type: AuthenticationMethod +Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, IMAP, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange 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 +``` + +### -FilePath +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxPermission +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. + +This parameter isn't used for testing the connection to the remote server for a remote move migration or an IMAP migration. + +```yaml +Type: MigrationMailboxPermission +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partition +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Security +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. + +```yaml +Type: IMAPSecurityMechanism +Parameter Sets: IMAP +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestMailbox +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. + +```yaml +Type: MailboxIdParameter +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Test-OAuthConnectivity.md b/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md new file mode 100644 index 0000000000..69c08e2c8a --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md @@ -0,0 +1,213 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Test-OAuthConnectivity cmdlet to test OAuth authentication to partner applications for a user. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-OAuthConnectivity -Service <ModServiceType> -TargetUri <Uri> + [-AppOnly] + [-Confirm] + [-Mailbox <MailboxIdParameter>] + [-ReloadConfig] + [-UseCachedToken] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-OAuthConnectivity -Service EWS -TargetUri https://cas.contoso.com/ews/ -Mailbox "Gurinder Singh" +``` + +This example tests OAuth connectivity with Exchange for Gurinder Singh. + +## PARAMETERS + +### -Service +The Service parameter specifies the partner application. Valid values for this parameter are: + +- EWS +- AutoD +- Generic + +```yaml +Type: ModServiceType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUri +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mailbox +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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 +``` + +### -ReloadConfig +The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. + +If you don't use this switch, the cached configuration settings are used. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Test-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md new file mode 100644 index 0000000000..79352a03a2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md @@ -0,0 +1,160 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Test-OrganizationRelationship cmdlet to verify that the organization relationship is properly configured and functioning as expected. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-OrganizationRelationship [[-Identity] <OrganizationRelationshipIdParameter>] -UserIdentity <RecipientIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-OrganizationRelationship cmdlet doesn't include any functional tests of federated sharing features, such as accessing user free/busy information or moving mailboxes between organizations. It only verifies that the configuration will allow these features to work correctly. + +Before you can test an organization relationship, you must first create an organization relationship. For more information, see [Create an organization relationship](https://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). + +## EXAMPLES + +### Example 1 +```powershell +Test-OrganizationRelationship -UserIdentity katherine@fabrikam.com -Identity contoso.com -Confirm +``` + +This example validates the organization relationship deployed in the fabrikam.com on-premises Exchange organization and checks whether a delegation token can be retrieved for a mailbox in the external organization domain contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the organization relationship to be tested. You can use the following values: + +- Canonical name +- GUID +- Name + +```yaml +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -UserIdentity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md new file mode 100644 index 0000000000..2443888dbc --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md @@ -0,0 +1,640 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-OutlookConnectivity + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange organization. This includes testing for both Outlook Anywhere (RPC over HTTP) and MAPI over HTTP connections. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Probe +``` +Test-OutlookConnectivity [-ProbeIdentity] <String> + [-Credential <PSCredential>] + [-Hostname <String>] + [-MailboxId <MailboxIdParameter>] + [-RunFromServerId <ServerIdParameter>] + [-TimeOutSeconds <String>] + [<CommonParameters>] +``` + +### Protocol +``` +Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -Protocol <Protocol> + [-Archive <Boolean>] + [-Confirm] + [-MailboxCredential <PSCredential>] + [-MonitoringContext] + [-TotalTimeoutInMinutes <Int32>] + [-TrustAnySslCert] + [-WhatIf] + [<CommonParameters>] +``` + +### RpcProxyServer +``` +Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -GetDefaultsFromAutodiscover <Boolean> + [-Archive <Boolean>] + [-Confirm] + [-MailboxCredential <PSCredential>] + [-MonitoringContext] + [-RpcAuthenticationType <RpcAuthenticationType>] + [-RpcClientAccessServer <ClientAccessServerIdParameter>] + [-RpcProxyAuthenticationType <RPCProxyAuthenticationType>] + [-RpcProxyServer <ServerIdParameter>] + [-TotalTimeoutInMinutes <Int32>] + [-TrustAnySslCert] + [-WhatIf] + [<CommonParameters>] +``` + +### RpcTestType +``` +Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -RpcTestType <RpcTestType> + [-Archive <Boolean>] + [-Confirm] + [-MailboxCredential <PSCredential>] + [-MonitoringContext] + [-RpcAuthenticationType <RpcAuthenticationType>] + [-RpcClientAccessServer <ClientAccessServerIdParameter>] + [-RpcProxyAuthenticationType <RPCProxyAuthenticationType>] + [-RpcProxyTestType <RpcProxyTestType>] + [-TotalTimeoutInMinutes <Int32>] + [-TrustAnySslCert] + [-WhatIf] + [<CommonParameters>] +``` + +### WSTestType +``` +Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -WSTestType <VirtualDirectoryUriScope> + [-Archive <Boolean>] + [-Confirm] + [-MailboxCredential <PSCredential>] + [-MonitoringContext] + [-TotalTimeoutInMinutes <Int32>] + [-TrustAnySslCert] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Running the Test-OutlookConnectivity cmdlet validates an Outlook connection defined by the provided parameters. The command is able to validate a single mailbox. + +The Test-OutlookConnectivity cmdlet runs the same process as the monitoring probes. The Microsoft Exchange Health Manager (MSExchangeHM) service must be running and have created the Outlook probes on the machine that will be tested. You need to select one of the Outlook probe identities to run the test. Use the [Get-MonitoringItemIdentity](https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemidentity) cmdlet to see what probes are active. + +This example lists the probes running in the backend services on a Mailbox server: `Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook.protocol | ?{$_.Name -like '*probe'}`. + +This example lists the probes running in the client access services on a Mailbox server: `Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook | ?{$_.Name -like '*probe'}`. + +For more information on probes and the monitoring framework, see [Managed Availability](https://learn.microsoft.com/exchange/managed-availability-exchange-2013-help), [Managed Availability and Server Health](https://techcommunity.microsoft.com/t5/exchange-team-blog/managed-availability-and-server-health/ba-p/593180), and [Customizing Managed Availability](https://techcommunity.microsoft.com/t5/exchange-team-blog/customizing-managed-availability/ba-p/592164). + +By default, the cmdlet uses the test monitoring account attached to the specified probe. You may enter a different mailbox instead via the MailboxId parameter. The options and results follow. + +- MailboxId and Credential are not specified: Generic connectivity test against a test mailbox using the system's test credentials. +- MailboxId is specified, Credential is not: Connectivity test to the specific mailbox using the system's test credentials. +- MailboxId and Credential are both specified: You get a connectivity test to the specific mailbox, and also a test that the credentials provided are valid for that mailbox + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Test-OutlookConnectivity -ProbeIdentity OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe +``` + +In Exchange 2013 or later, this example runs an MAPI over HTTP OutlookRpcSelfTestProbe on the Mailbox server that you're currently connected to. + +### Example 2 +```powershell +Test-OutlookConnectivity "Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId johnd@contoso.com +``` + +In Exchange 2013 or later, this example runs the OutlookRpcDeepTestProbe from the "PrimaryMailbox" server for the mailbox "johnd@contoso.com" mounted on "Mailbox Database 1234512345". Because the Credential parameter is not specified, the probe will use the default testing credentials. + +### Example 3 +```powershell +Test-OutlookConnectivity -Protocol HTTP -GetDefaultsFromAutoDiscover $true +``` + +In Exchange 2010, this example tests the most common end-to-end Outlook connectivity scenario for Outlook Anywhere. This includes testing for connectivity through the Autodiscover service, creating a user profile, and logging on to the user mailbox. All of the required values are retrieved from the Autodiscover service. Because the Identity parameter isn't specified, the command uses the temporary test user that you've created using the New-TestCasConnectivityUser.ps1 script. This example command can be run to test TCP/IP connectivity by setting the Protocol parameter to RPC. + +### Example 4 +```powershell +Test-OutlookConnectivity -RpcProxyTestType:Internal -RpcTestType:Server +``` + +In Exchange 2010, this example tests for Outlook Anywhere connectivity using the local server as the RpcProxy endpoint as well as the RPC endpoint. Because the Identity parameter isn't specified, the command uses the temporary test user that you've created using the New-TestCasConnectivityUser.ps1 script. Modify this example to use the public external URL by setting the RpcProxyTestType parameter to External. Additionally, the example command can use the Client Access server array as the RPC endpoint by setting the RpcTestType parameter to Array. To only validate TCP/IP connectivity, omit the RpcProxyTestType parameter. + +### Example 5 +```powershell +Test-OutlookConnectivity -RpcProxyServer RpcProxySrv01 -RpcProxyAuthenticationType Basic -RpcClientAccessServer CAS01 -RpcAuthenticationType NTLM +``` + +In Exchange 2010, this example validates Outlook connectivity through RpcProxy on one server to a different server running the Client Access server role with Basic for the outer authentication layer and NTLM for the inner authentication layer. Using these parameters should allow you to validate most types of Outlook connectivity configurations. This command can also be used with the GetDefaultsFromAutoDiscover parameter set to $true if you only need to override one or two parameters. This following command is similar to running a connectivity test using the RPC Ping utility but provides stronger validation. + +## PARAMETERS + +### -Identity +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the command looks for a test user in Active Directory that you previously created by using the New-TestCasConnectivityUser.ps1 script. + +```yaml +Type: MailboxIdParameter +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ProbeIdentity +The ProbeIdentity parameter specifies the probe to use. Valid values are: + +Outlook Anywhere (RPC over HTTP) probes: + +- `Outlook.Protocol\OutlookRpcSelfTestProbe`: Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. +- `Outlook.Protocol\OutlookRpcDeepTestProbe`: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect to and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `Outlook.Protocol\OutlookRpcDeepTestProbe\<Case-sensitive Mailbox Database Name>`: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). + +MAPI over HTTP probes: + +- `OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe`: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. +- `OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe`: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\<Case-sensitive Mailbox Database Name>`: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). + +```yaml +Type: String +Parameter Sets: Probe +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetDefaultsFromAutodiscover +This parameter is available only in Exchange Server 2010. + +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. + +```yaml +Type: Boolean +Parameter Sets: RpcProxyServer +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +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. + +```yaml +Type: Protocol +Parameter Sets: Protocol +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpcTestType +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: + +- Server: The command uses the local server as the RPC endpoint. +- Array: The command looks for a ClientAccessArray object in the local Active Directory site. + +```yaml +Type: RpcTestType +Parameter Sets: RpcTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WSTestType +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.) +- Internal +- External + +```yaml +Type: VirtualDirectoryUriScope +Parameter Sets: WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archive +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. + +```yaml +Type: Boolean +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +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. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: cf +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: Probe +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 +``` + +### -Hostname +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxCredential +This parameter is available only in Exchange Server 2010. + +The MailboxCredential parameter specifies certain credentials to allow logon access to a user's mailbox. Use the parameter along with the Identity parameter to access a user's mailbox when you don't have access permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MailboxId +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: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +If you don't use this parameter, the command uses the test account. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Probe +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 +``` + +### -MonitoringContext +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. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). + +```yaml +Type: SwitchParameter +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpcAuthenticationType +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: + +- NTLM +- Kerberos +- Negotiate + +The default value is Negotiate. + +```yaml +Type: RpcAuthenticationType +Parameter Sets: RpcProxyServer, RpcTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpcClientAccessServer +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. + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: RpcProxyServer, RpcTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RpcProxyAuthenticationType +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. + +```yaml +Type: RPCProxyAuthenticationType +Parameter Sets: RpcProxyServer, RpcTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpcProxyServer +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. + +```yaml +Type: ServerIdParameter +Parameter Sets: RpcProxyServer +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -RpcProxyTestType +This parameter is available only in Exchange Server 2010. + +The RpcProxyTestType parameter specifies which HTTP endpoint the command should connect to. Valid values are: + +- Internal: Refers to the local computer name (`https://<localcomputername>`, for example, `https://CAS01`). +- External: Refers to a public namespace (the external HTTP URL on the /rpc virtual directory, for example, `https://mail.contoso.com`). + +```yaml +Type: RpcProxyTestType +Parameter Sets: RpcTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunFromServerId +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 +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: String +Parameter Sets: Probe +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 +``` + +### -TotalTimeoutInMinutes +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. + +```yaml +Type: Int32 +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustAnySslCert +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. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. + +```yaml +Type: SwitchParameter +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +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. + +```yaml +Type: SwitchParameter +Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType +Aliases: wi +Applicable: Exchange 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/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/Test-OutlookWebServices.md b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md new file mode 100644 index 0000000000..a9eae33fd1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md @@ -0,0 +1,293 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-OutlookWebServices + +## SYNOPSIS +This cmdlet is functional only in Exchange Server 2010. + +Use the Test-OutlookWebServices cmdlet to verify the Autodiscover service settings for Microsoft Outlook on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Test-OutlookWebServices [[-Identity] <RecipientIdParameter>] + [-ClientAccessServer <ClientAccessServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-TargetAddress <RecipientIdParameter[]>] + [-WhatIf] + [<CommonParameters>] +``` + +### AutoDiscoverServer +``` +Test-OutlookWebServices [[-Identity] <MailboxIdParameter>] -AutoDiscoverServer <ClientAccessServerIdParameter> + [-Confirm] + [-MailboxCredential <PSCredential>] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +### ClientAccessServer +``` +Test-OutlookWebServices [[-Identity] <MailboxIdParameter>] [-ClientAccessServer <ClientAccessServerIdParameter>] + [-Confirm] + [-MailboxCredential <PSCredential>] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +### MonitoringContext +``` +Test-OutlookWebServices [[-Identity] <MailboxIdParameter>] [-MonitoringContext] + [-Confirm] + [-MailboxCredential <PSCredential>] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-OutlookWebServices -Identity:holly@contoso.com +``` + +This example verifies the service information that's returned to the Outlook client from the Autodiscover service for the user holly@contoso.com. The code example verifies information for the following services: + +- Availability service +- Outlook Anywhere +- Offline address book +- Unified Messaging + +The example tests for a connection to each service. The example also submits a request to the Availability service for the user holly@contoso.com to determine whether the user's free/busy information is being returned correctly from the Client Access server to the Outlook client. + +## PARAMETERS + +### -Identity +The Identity parameter specifies any valid address in the forest. If you specify this parameter, incorrectly formed addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and username in the domain\\username format or an Active Directory GUID and resolves them to the SMTP address that's needed to authenticate. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AutoDiscoverServer +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: + +- Name (for example, Exchange01) +- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) +- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) + +You can't use this parameter with the ClientAccessServer parameter. + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: AutoDiscoverServer +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAccessServer +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. + +You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +You can't use this parameter with the AutoDiscoverServer parameter. + +```yaml +Type: ClientAccessServerIdParameter +Parameter Sets: Default, ClientAccessServer +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 +``` + +### -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: Default +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxCredential +The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: AutoDiscoverServer, ClientAccessServer, MonitoringContext +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 +``` + +### -MonitoringContext +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: Default +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 +``` + +### -TargetAddress +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustAnySSLCertificate +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. + +```yaml +Type: SwitchParameter +Parameter Sets: AutoDiscoverServer, ClientAccessServer, MonitoringContext +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 +``` + +### -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/client-access/Test-OwaConnectivity.md b/exchange/exchange-ps/exchange/Test-OwaConnectivity.md similarity index 78% rename from exchange/exchange-ps/exchange/client-access/Test-OwaConnectivity.md rename to exchange/exchange-ps/exchange/Test-OwaConnectivity.md index 4ce0d5977c..3f6dbf78e8 100644 --- a/exchange/exchange-ps/exchange/client-access/Test-OwaConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-OwaConnectivity.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-OwaConnectivity @@ -13,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Test-OwaConnectivity cmdlet to verify that Microsoft Office Outlook Web App is running as expected. The Test-OwaConnectivity cmdlet can be used to test Outlook Web App connectivity for all Microsoft Exchange Server 2010 virtual directories on a specified Client Access server for all mailboxes on servers running Exchange that are in the same Active Directory site. The Test-OwaConnectivity cmdlet can also be used to test the connectivity for an individual Exchange Outlook Web App URL. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,12 +30,18 @@ Test-OwaConnectivity [-URL] <String> -MailboxCredential <PSCredential> [-ResetTestAccountCredentials] [-Timeout <UInt32>] [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### Identity ``` -Test-OwaConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext] [-RSTEndpoint <String>] [-TestType <Internal | External>] [-VirtualDirectoryName <String>] +Test-OwaConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-RSTEndpoint <String>] + [-TestType <OwaConnectivityTestType>] + [-VirtualDirectoryName <String>] [-AllowUnsecureAccess] [-Confirm] [-DomainController <Fqdn>] @@ -40,7 +49,8 @@ Test-OwaConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-MailboxServer [-ResetTestAccountCredentials] [-Timeout <UInt32>] [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -58,19 +68,19 @@ If the command encounters a virtual directory that doesn't require Secure Socket The Test-OwaConnectivity cmdlet can be run as a one-time interactive task or as a scheduled task under Microsoft System Center Operations Manager 2007 control. To run the Test-OwaConnectivity cmdlet as a System Center Operations Manager 2007 task, the Client Access test mailbox must be available on the Mailbox servers that the cmdlet tests against. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-OwaConnectivity -URL:https://mail.contoso.com/owa -MailboxCredential:(get-credential contoso\kweku) ``` This example tests the connectivity for the URL https://mail.contoso.com/owa using the credentials for the user contoso\\kweku. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Test-OwaConnectivity -ClientAccessServer:Contoso12 -AllowUnsecureAccess ``` @@ -78,20 +88,23 @@ This example tests the connectivity of a specific Client Access server Contoso12 ## PARAMETERS -### -MailboxCredential -The MailboxCredential parameter specifies the mailbox credential for a single URL test. +### -ClientAccessServer +This parameter is available only in Exchange Server 2010 -The MailboxCredential parameter is required only when using the URL parameter. +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. + +Don't use this parameter with the URL parameter. ```yaml -Type: PSCredential -Parameter Sets: URL +Type: ServerIdParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 -Required: True -Position: Named + +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` @@ -107,6 +120,7 @@ Type: String Parameter Sets: URL Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -114,43 +128,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUnsecureAccess -The AllowUnsecureAccess parameter specifies whether virtual directories that don't require SSL are tested. If the AllowUnsecureAccess parameter is included, it enables virtual directories that don't require SSL to be tested. If this parameter isn't included, the command skips virtual directories that don't require SSL, and an error is generated. +### -MailboxCredential +The MailboxCredential parameter specifies the mailbox credential for a single URL test. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +The MailboxCredential parameter is required only when using the URL parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: PSCredential +Parameter Sets: URL Aliases: Applicable: Exchange Server 2010 -Required: False + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientAccessServer -The ClientAccessServer parameter specifies the name of the Client Access server to test. If this parameter is included, all Exchange Outlook Web App virtual directories on the Client Access server are tested against all Exchange Mailbox servers in the local Active Directory site. +### -AllowUnsecureAccess +The AllowUnsecureAccess switch specifies whether virtual directories that don't require SSL are tested. You don't need to specify a value with this switch. -Don't use this parameter with the URL parameter. +If you don't use this switch, the command skips virtual directories that don't require SSL, and an error is generated. ```yaml -Type: ServerIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -158,6 +177,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -173,6 +193,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -190,6 +211,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -205,6 +227,7 @@ Type: ServerIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -213,13 +236,16 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter shows you what information is returned to System Center Operations Manager 2007. When Operations Manager 2007 executes the Test-OwaConnectivity cmdlet, it requires additional information to be returned. By setting this parameter to $true, you can see exactly what would be returned to Operations Manager 2007. This parameter is informational only and has no effect on Operations Manager 2007. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -228,13 +254,16 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -250,6 +279,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -261,10 +291,11 @@ Accept wildcard characters: False 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: Internal | External +Type: OwaConnectivityTestType Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -280,6 +311,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -288,13 +320,16 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate parameter specifies whether to check an internal URL without generating an SSL certificate validation error. The TrustAnySSLCertificate parameter allows SSL certificate validation failures to not be reported. This is useful for testing internal URLs because Internet Information Services (IIS) doesn't support assigning multiple certificates for a single virtual directory. If a directory has different URLs for internal and external access and has a certificate, that certificate is usually for the external URL. This parameter lets the task check an internal URL without generating an error when the certificate doesn't match the URL. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -310,6 +345,7 @@ Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -325,6 +361,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -333,20 +370,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/44808bba-56b3-45bc-8cab-b45f52758636.aspx) diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/exchange/Test-PopConnectivity.md new file mode 100644 index 0000000000..fedc41347a --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-PopConnectivity.md @@ -0,0 +1,357 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-PopConnectivity + +## SYNOPSIS +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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-PopConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-Confirm] + [-ConnectionType <ProtocolConnectionType>] + [-DomainController <Fqdn>] + [-LightMode] + [-MailboxCredential <PSCredential>] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-PerConnectionTimeout <Int32>] + [-PortClientAccessServer <Int32>] + [-ResetTestAccountCredentials] + [-Timeout <UInt32>] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-PopConnectivity cmdlet tests POP3 connectivity by connecting to a specified mailbox, a specified Exchange server, or all Exchange servers that are available in the local Active Directory site. + +The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: + +& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 + +The test results are displayed on-screen. The cmdlet returns the following information. + +- CasServer: The Exchange server that the client connected to. +- LocalSite: The name of the local Active Directory site. +- Scenario: The operations that are tested. Test POP3 Connectivity connects to the server using the POP3 protocol, searches for the test message, and deletes the test message. +- Result: The values returned are typically Success, Skipped or Failure. +- Latency(MS): The time required to complete the test in milliseconds. +- Error: Any error messages that were encountered. + +You can write the results to a file by piping the output to ConvertTo-Html 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-PopConnectivity -ClientAccessServer Contoso12 -MailboxCredential (Get-Credential contoso\kweku) +``` + +This example tests the client POP3 connectivity for the server named Contoso12 by using the credentials for the user contoso\\kweku. + +### Example 2 +```powershell +Test-PopConnectivity -ClientAccessServer Contoso12 +``` + +This example tests the client POP3 connectivity of the specific server named Contoso12 and tests all Exchange mailboxes. + +## PARAMETERS + +### -ClientAccessServer +The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. + +You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +``` + +### -ConnectionType +The ConnectionType parameter specifies the type of connection that's used to connect to the POP3 service. Valid values are: + +- Plaintext +- Ssl +- Tls + +```yaml +Type: ProtocolConnectionType +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 +``` + +### -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 +``` + +### -LightMode +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxCredential +The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxServer +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: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. + +```yaml +Type: ServerIdParameter +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 +``` + +### -MonitoringContext +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). + +```yaml +Type: SwitchParameter +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 +``` + +### -PerConnectionTimeout +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. + +```yaml +Type: Int32 +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 +``` + +### -PortClientAccessServer +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetTestAccountCredentials +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. + +```yaml +Type: SwitchParameter +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 +``` + +### -Timeout +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. + +```yaml +Type: UInt32 +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 +``` + +### -TrustAnySSLCertificate +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. + +```yaml +Type: SwitchParameter +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 +``` + +### -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/Test-PowerShellConnectivity.md b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md new file mode 100644 index 0000000000..b418302280 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md @@ -0,0 +1,364 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-PowerShellConnectivity + +## SYNOPSIS +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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### URL +``` +Test-PowerShellConnectivity -ConnectionUri <Uri> -TestCredential <PSCredential> + [-Authentication <AuthenticationMethod>] + [-Confirm] + [-DomainController <Fqdn>] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-ResetTestAccountCredentials] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +### Identity +``` +Test-PowerShellConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-TestType <OwaConnectivityTestType>] + [-VirtualDirectoryName <String>] + [-Authentication <AuthenticationMethod>] + [-Confirm] + [-DomainController <Fqdn>] + [-MailboxServer <ServerIdParameter>] + [-MonitoringContext] + [-ResetTestAccountCredentials] + [-TrustAnySSLCertificate] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Test-PowerShellConnectivity cmdlet tests Exchange remote PowerShell connectivity by connecting to a specified remote PowerShell virtual directory, to any remote PowerShell virtual directories on a specified Exchange server, or to any remote PowerShell virtual directories that are available in the local Active Directory site. + +The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: + +& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 + +The test results are displayed on-screen. The cmdlet returns the following information. + +- CasServer: The Exchange server that the client connected to. +- LocalSite: The name of the local Active Directory site. +- Scenario: The operations that are tested. Values are: Logon User. +- Result: The values returned are typically Success, Skipped or Failure. +- Latency(MS): The time required to complete the test in milliseconds. +- Error: Any error messages that were encountered. + +You can write the results to a file by piping the output to ConvertTo-Html 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-PowerShellConnectivity -ClientAccessServer MBX2 -VirtualDirectoryName "PowerShell (Default Web Site)" -TrustAnySSLCertificate +``` + +This example tests the PowerShell (Default Web Site) virtual directory on the MBX2 server. The TrustAnySSLCertificate switch is used to skip the certificate check during connection. + +### Example 2 +```powershell +$UserCredentials = Get-Credential + +Test-PowerShellConnectivity -ConnectionUri https://contoso.com/powershell -TestCredential $UserCredentials -Authentication Basic +``` + +This example tests the remote PowerShell virtual directory that's available at `https://contoso.com/powershell`. A mismatch between the SSL certificate and the URL isn't expected, so the TrustAnySSLCertificate switch isn't used. The virtual directory is configured to use Basic authentication. + +The credentials that are used to connect to the virtual directory are stored in the $UserCredentials variable. The test is then run as previously described. + +## PARAMETERS + +### -ClientAccessServer +The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. + +You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +You can't use this parameter with the ConnectionUri parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ConnectionUri +The ConnectionUri parameter specifies the URL of the remote PowerShell virtual directory to test, for example, `https://contoso.com/powershell`. + +You can't use this parameter with the ClientAccessServer parameter. + +```yaml +Type: Uri +Parameter Sets: URL +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestCredential +The TestCredential parameter specifies the credentials to use for the test. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +You can only use this parameter with the ConnectionUri parameter. + +```yaml +Type: PSCredential +Parameter Sets: URL +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +The Authentication parameter specifies the type of authentication that's used to connect. Valid values are: + +- Default +- Basic +- Credssp +- Digest +- Kerberos +- Negotiate + +```yaml +Type: AuthenticationMethod +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 +``` + +### -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 +``` + +### -MailboxServer +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: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. + +```yaml +Type: ServerIdParameter +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 +``` + +### -MonitoringContext +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). + +```yaml +Type: SwitchParameter +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 +``` + +### -ResetTestAccountCredentials +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. + +```yaml +Type: SwitchParameter +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 +``` + +### -TestType +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. + +```yaml +Type: OwaConnectivityTestType +Parameter Sets: Identity +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 +``` + +### -TrustAnySSLCertificate +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. + +```yaml +Type: SwitchParameter +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 +``` + +### -VirtualDirectoryName +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. + +```yaml +Type: String +Parameter Sets: Identity +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 +``` + +### -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/Test-ReplicationHealth.md b/exchange/exchange-ps/exchange/Test-ReplicationHealth.md new file mode 100644 index 0000000000..384af71e00 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ReplicationHealth.md @@ -0,0 +1,230 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ReplicationHealth + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-ReplicationHealth cmdlet to check all aspects of replication and replay, or to provide status for a specific Mailbox server in a database availability group (DAG). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ReplicationHealth [[-Identity] <ServerIdParameter>] + [-ActiveDirectoryTimeout <Int32>] + [-Confirm] + [-DatabaseAvailabilityGroup <DatabaseAvailabilityGroupIdParameter>] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-OutputObjects] + [-TransientEventSuppressionWindow <UInt32>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-ReplicationHealth -Identity MBX1 +``` + +This example tests the health of replication for the Mailbox server MBX1. + +## PARAMETERS + +### -Identity +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 +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use this parameter with the DatabaseAvailabilityGroup parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveDirectoryTimeout +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DatabaseAvailabilityGroup +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 +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity parameter. + +```yaml +Type: DatabaseAvailabilityGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```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 +``` + +### -MonitoringContext +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -OutputObjects +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransientEventSuppressionWindow +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/antispam-antimalware/Test-SenderId.md b/exchange/exchange-ps/exchange/Test-SenderId.md similarity index 81% rename from exchange/exchange-ps/exchange/antispam-antimalware/Test-SenderId.md rename to exchange/exchange-ps/exchange/Test-SenderId.md index 5f0df04f81..53db8aa93a 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Test-SenderId.md +++ b/exchange/exchange-ps/exchange/Test-SenderId.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-SenderId @@ -13,25 +16,29 @@ This cmdlet is available only in on-premises Exchange. Use the Test-SenderId cmdlet to test whether a specified IP address is the legitimate sending address for a specified SMTP address. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Test-SenderId -IPAddress <IPAddress> -PurportedResponsibleDomain <SmtpDomain> [-Confirm] - [-DomainController <Fqdn>] [-HelloDomain <String>] [-Server <ServerIdParameter>] [-WhatIf] +Test-SenderId -IPAddress <IPAddress> -PurportedResponsibleDomain <SmtpDomain> + [-Confirm] + [-DomainController <Fqdn>] + [-HelloDomain <String>] + [-Server <ServerIdParameter>] + [-WhatIf] [<CommonParameters>] ``` ## 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-SenderId -IPAddress 192.168.0.1 -PurportedResponsibleDomain contoso.com ``` @@ -47,6 +54,7 @@ Type: IPAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -62,6 +70,7 @@ Type: SmtpDomain Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -72,8 +81,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -81,6 +89,7 @@ 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 @@ -98,6 +107,7 @@ 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 @@ -113,6 +123,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -124,11 +135,8 @@ Accept wildcard characters: False 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 - - FQDN - - Distinguished name (DN) - - Exchange Legacy DN If you don't use this parameter, the command is run on the local server. @@ -138,6 +146,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -153,6 +162,7 @@ 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 @@ -161,20 +171,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/66505371-f756-412f-8d74-49d7a4b73344.aspx) diff --git a/exchange/exchange-ps/exchange/Test-ServiceHealth.md b/exchange/exchange-ps/exchange/Test-ServiceHealth.md new file mode 100644 index 0000000000..1016e36a2c --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ServiceHealth.md @@ -0,0 +1,175 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ServiceHealth + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-ServiceHealth cmdlet to test whether all the Microsoft Windows services that Exchange requires on a server have started. The Test-ServiceHealth cmdlet returns an error for any service required by a configured role when the service is set to start automatically and isn't currently running. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ServiceHealth [[-Server] <ServerIdParameter>] + [-ActiveDirectoryTimeout <Int32>] + [-Confirm] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet isn't supported on Exchange 2013 Client Access servers (the cmdlet will return unexpected output). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Test-ServiceHealth +``` + +This example uses the Test-ServiceHealth command without parameters to test the services on the local server. + +## PARAMETERS + +### -Server +The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveDirectoryTimeout +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringContext +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -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/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md new file mode 100644 index 0000000000..896490cd63 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization +applicable: Exchange Online, Exchange Online Protection +title: Test-ServicePrincipalAuthorization +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ServicePrincipalAuthorization + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Test-ServicePrincipalAuthorization cmdlet to test the access granted by role-based access control (RBAC) for Applications. For more information, see [Role Based Access Control for Applications in Exchange Online](https://learn.microsoft.com/Exchange/permissions-exo/application-rbac). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ServicePrincipalAuthorization [-Identity] <ServicePrincipalIdParameter> + [-Confirm] + [-Resource <UserIdParameter>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Mailbox A" | Format-Table + +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +-------- ------------------ -------------------- --------- ------ +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope True +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit False +Application Contacts.Read Contacts.Read Organization Organization True +``` + +This example tests if this service principal (the app named "DemoB") can exercise each of its assigned permissions against the target mailbox named "Mailbox A." The membership in the scope is indicated by the InScope column. + +### Example 2 +```powershell +PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" | Format-Table + +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +-------- ------------------ -------------------- --------- ------ +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope Not Run +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit Not Run +Application Contacts.Read Contacts.Read Organization Organization Not Run +``` + +This example tests the entitlement of the app named "DemoB", including which permissions it has at which scopes. Because the command doesn't use the Resource parameter, the scope membership check is not run. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to test. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ServiceId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Resource +The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-SiteMailbox.md b/exchange/exchange-ps/exchange/Test-SiteMailbox.md new file mode 100644 index 0000000000..249202e6e8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-SiteMailbox.md @@ -0,0 +1,222 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-SiteMailbox + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-SiteMailbox cmdlet to test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-SiteMailbox [[-Identity] <RecipientIdParameter>] + [-BypassOwnerCheck] + [-Confirm] + [-RequestorIdentity <RecipientIdParameter>] + [-SharePointUrl <Uri>] + [-UseAppTokenOnly] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-SiteMailbox -BypassOwnerCheck -SharePointUrl "https://myserver/teams/edu" +``` + +The example tests a SharePoint site's connectivity only. You can use this command before creating a site mailbox or if you're having a problem creating a site mailbox. + +### Example 2 +```powershell +Test-SiteMailbox -BypassOwnerCheck -Identity mysitemailbox@contoso.com -UseAppTokenOnly +``` + +This example tests the Exchange server connectivity with an existing site mailbox using the Identity and UseAppTokenOnly parameters. The Identity parameter specifies the site mailbox and the UseAppTokenOnly parameter specifies that you want to test under the identity of the Exchange server. Run this command for troubleshooting documentation synchronization issues. + +### Example 3 +```powershell +Test-SiteMailbox -BypassOwnerCheck -RequestorIdentity "kweku@contoso.com" -SharePointUrl "https://myserver/teams/edu" +``` + +This example tests a specific user's ability to access a SharePoint site by using the RequestorIdentity parameter. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can't use this parameter with the SharePointUrl parameter. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassOwnerCheck +The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestorIdentity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can't use this parameter with the UseAppTokenOnly parameter. + +If you don't specify this parameter, the command uses the identification of the user running this command. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointUrl +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. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseAppTokenOnly +The UseAppTokenOnly switch specifies that you want to test the site mailbox by using the identity of the Exchange server. You don't need to specify a value with this switch. + +You can't use this switch with the RequestorIdentity parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Test-SmtpConnectivity.md b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md new file mode 100644 index 0000000000..68097adcaf --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md @@ -0,0 +1,176 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-SmtpConnectivity + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Test-SmtpConnectivity cmdlet to diagnose whether an SMTP connection can successfully be established to the Receive connectors on a specific server. Although you can run this cmdlet manually to verify SMTP connectivity for a specified server, it's primarily used by Microsoft System Center Operations Manager 2007 to test your transport servers' ability to receive SMTP connections to each of the bindings on all the Receive connectors on those servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-SmtpConnectivity [[-Identity] <ServerIdParameter>] + [-Confirm] + [-DomainController <Fqdn>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +When you run the Test-SmtpConnectivity cmdlet against a Mailbox server, the cmdlet attempts to establish an SMTP connection to all bindings of all Receive connectors hosted on that server. For each attempt, the cmdlet returns the following information: + +- Server: The name of the server that hosts the Receive connector. +- ReceiveConnector: The name of the Receive connector to which the SMTP connection was attempted. +- Binding: The binding that was configured on the Receive connector. +- EndPoint: The actual IP address and port to which the SMTP connection was attempted. +- StatusCode: The result of the connection attempt. This can be one of the following values: Success, Unable to connect, Transient error, Permanent error, External error. +- Details: The actual response received from the server being tested. If the connection attempt isn't successful, this field contains an error string. + +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > <filename>` 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). + +## EXAMPLES + +### Example 1 +```powershell +Test-SmtpConnectivity Mailbox01 +``` + +This example verifies SMTP connectivity for all Receive connectors on the Mailbox server named Mailbox01. + +### Example 2 +```powershell +Get-TransportService | Test-SmtpConnectivity +``` + +This example verifies SMTP connectivity for all Receive connectors on all Mailbox servers in the organization. + +## PARAMETERS + +### -Identity +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: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + + If you don't use this parameter, all Receive connectors on the local server are tested. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringContext +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. + +```yaml +Type: Boolean +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 +``` + +### -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/Test-SystemHealth.md b/exchange/exchange-ps/exchange/Test-SystemHealth.md new file mode 100644 index 0000000000..8248f8de34 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-SystemHealth.md @@ -0,0 +1,448 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Test-SystemHealth + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Test-SystemHealth cmdlet to gather data about your Microsoft Exchange system and to analyze the data according to best practices. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-SystemHealth [-ADCredentials <PSCredential>] + [-Analyze] + [-Collect] + [-ConfigurationData <Byte[]>] + [-ConfigurationFileLocation <LongPath>] + [-Confirm] + [-Description <String>] + [-DomainController <Fqdn>] + [-DownloadConfigurationUpdates] + [-ExchangeCredentials <PSCredential>] + [-Export] + [-GenerateEvents] + [-GenerateSQMData] + [-MaxThreads <Int32>] + [-MergeFileLocation <LongPath>] + [-OutData] + [-OutFileLocation <LongPath>] + [-Roles <String[]>] + [-ScanType <String>] + [-ServerList <String[]>] + [-Timeout <EnhancedTimeSpan>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Test-SystemHealth +``` + +This example gathers data about your Exchange system. + +### Example 2 +```powershell +$SysHealth = Test-SystemHealth -OutData + +[System.IO.File]::WriteAllBytes('D:\temp\SystemHealthOutData.xml', $SysHealth.FileData) +``` + +This example saves the output data as a byte stream to the variable named $SysHealth. The content is then written to the SystemHealthOutData.xml file in the D:\\temp folder. + +## PARAMETERS + +### -ADCredentials +The ADCredentials parameter specifies the username and password that's used to access Active Directory. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Analyze +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collect +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationData +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationFileLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: LongPath +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DownloadConfigurationUpdates +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeCredentials +The ExchangeCredentials parameter specifies the username and password that's used to access Exchange servers. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateEvents +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateSQMData +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxThreads +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MergeFileLocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: LongPath +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutData +The OutData switch specifies whether the output data is sent as a byte stream. You don't need to specify a value with this switch. + +For example, if you run the command: `$temp = Test-SystemHealth -OutData`, `$temp` contains the byte stream of the output data, and you can covert it back to xml by using the Set-Content command. For a code sample, see "Example 2" in this topic. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutFileLocation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Roles +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerList +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-TextExtraction.md b/exchange/exchange-ps/exchange/Test-TextExtraction.md new file mode 100644 index 0000000000..43b3808f00 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-TextExtraction.md @@ -0,0 +1,140 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-TextExtraction + +## SYNOPSIS +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Test-TextExtraction cmdlet to 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). + +## SYNTAX + +``` +Test-TextExtraction [-FileData] <Byte[]> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet doesn't work on encrypted email message files. + +The Microsoft classification engine uses the results to classify content and determine the sensitive information types in the message file. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$content = Test-TextExtraction -FileData ([System.IO.File]::ReadAllBytes('.\financial data.msg')) + +$content.ExtractedResults +``` + +This example extracts the text from the email message file named "financial data.msg" that's in the same folder where you run the command, and shows the results. + +### Example 2 +```powershell +$content = Test-TextExtraction -FileData ([System.IO.File]::ReadAllBytes('.\financial data.msg')) + +Test-DataClassification -TestTextExtractionResults $content.ExtractedResults +``` + +This example extracts the text from the email message file named "financial data.msg", stores the information in the variable named $content, and uses the variable with the Test-DataClassification cmdlet to return the sensitive information types, their confidence, and count. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the name and path of the file from which text should be extracted. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, 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/unified-messaging/Test-UMConnectivity.md b/exchange/exchange-ps/exchange/Test-UMConnectivity.md similarity index 78% rename from exchange/exchange-ps/exchange/unified-messaging/Test-UMConnectivity.md rename to exchange/exchange-ps/exchange/Test-UMConnectivity.md index 1c75d96d7c..7a6b3e9a41 100644 --- a/exchange/exchange-ps/exchange/unified-messaging/Test-UMConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-UMConnectivity.md @@ -1,9 +1,12 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-UMConnectivity @@ -13,62 +16,73 @@ This cmdlet is available only in on-premises Exchange. Use the Test-UMConnectivity cmdlet to test the operation of Unified Messaging (UM) servers. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### TuiLogonSpecific ``` -Test-UMConnectivity -Phone <String> -PIN <String> -TUILogon <$true | $false> -UMDialPlan <UMDialPlanIdParameter> +Test-UMConnectivity -Phone <String> -PIN <String> -TUILogon <Boolean> -UMDialPlan <UMDialPlanIdParameter> [-CertificateThumbprint <String>] [-Confirm] [-DomainController <Fqdn>] [-ListenPort <Int32>] - [-MediaSecured <$true | $false>] - [-MonitoringContext <$true | $false>] + [-MediaSecured <Boolean>] + [-MonitoringContext <Boolean>] [-RemotePort <Int32>] - [-Secured <$true | $false>] + [-Secured <Boolean>] [-Timeout <Int32>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### EndToEnd ``` -Test-UMConnectivity -Phone <String> -UMIPGateway <UMIPGatewayIdParameter> [-DiagDtmfDurationInMilisecs <Int32>] [-DiagDtmfSequence <String>] [-DiagInitialSilenceInMilisecs <Int32>] [-DiagInterDtmfDiffGapInMilisecs <String>] [-DiagInterDtmfGapInMilisecs <Int32>] [-From <String>] +Test-UMConnectivity -Phone <String> -UMIPGateway <UMIPGatewayIdParameter> + [-DiagDtmfDurationInMilisecs <Int32>] + [-DiagDtmfSequence <String>] + [-DiagInitialSilenceInMilisecs <Int32>] + [-DiagInterDtmfDiffGapInMilisecs <String>] + [-DiagInterDtmfGapInMilisecs <Int32>] + [-From <String>] [-CertificateThumbprint <String>] [-Confirm] [-DomainController <Fqdn>] [-ListenPort <Int32>] - [-MediaSecured <$true | $false>] - [-MonitoringContext <$true | $false>] - [-Secured <$true | $false>] + [-MediaSecured <Boolean>] + [-MonitoringContext <Boolean>] + [-Secured <Boolean>] [-Timeout <Int32>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### PinReset ``` -Test-UMConnectivity -ResetPIN <$true | $false> [-Confirm] +Test-UMConnectivity -ResetPIN <Boolean> + [-Confirm] [-DomainController <Fqdn>] - [-MonitoringContext <$true | $false>] - [-WhatIf] [<CommonParameters>] + [-MonitoringContext <Boolean>] + [-WhatIf] + [<CommonParameters>] ``` ### TuiLogonGeneral ``` -Test-UMConnectivity -TUILogonAll <$true | $false> +Test-UMConnectivity -TUILogonAll <Boolean> [-CertificateThumbprint <String>] [-Confirm] [-DomainController <Fqdn>] [-ListenPort <Int32>] - [-MediaSecured <$true | $false>] - [-MonitoringContext <$true | $false>] + [-MediaSecured <Boolean>] + [-MonitoringContext <Boolean>] [-RemotePort <Int32>] - [-Secured <$true | $false>] + [-Secured <Boolean>] [-Timeout <Int32>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### LocalLoop @@ -78,12 +92,13 @@ Test-UMConnectivity [-CallRouter] [-Confirm] [-DomainController <Fqdn>] [-ListenPort <Int32>] - [-MediaSecured <$true | $false>] - [-MonitoringContext <$true | $false>] + [-MediaSecured <Boolean>] + [-MonitoringContext <Boolean>] [-RemotePort <Int32>] - [-Secured <$true | $false>] + [-Secured <Boolean>] [-Timeout <Int32>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -95,26 +110,26 @@ When you run this cmdlet in an on-premises Unified Messaging deployment, you nee After this task is complete, the cmdlet will have tested the operation of the Mailbox server and related telephony components. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-UMConnectivity ``` This example performs connectivity and operational tests on the local Mailbox server, and then displays the Voice over IP (VoIP) connectivity information. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Test-UMConnectivity -UMIPGateway MyUMIPGateway -Phone 56780 -Secured $false ``` This example tests the ability of the local Mailbox server to use an unsecured TCP connection instead of a secured mutual TLS connection to place a call through the UM IP gateway MyUMIPGateway by using the telephone number 56780. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Test-UMConnectivity -Phone sip:sipdp.contoso.com@contoso.com -UMIPGateway MyUMIPGateway -Secured $true -From sip:user1@contoso.com -MediaSecured $true ``` @@ -129,7 +144,8 @@ The Phone parameter specifies the telephone number or Session Initiation Protoco Type: String Parameter Sets: TuiLogonSpecific, EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -144,7 +160,8 @@ The PIN parameter specifies the PIN associated with the UM-enabled mailbox. Type: String Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -156,10 +173,11 @@ Accept wildcard characters: False The ResetPIN parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: PinReset Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -171,10 +189,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -186,10 +205,11 @@ Accept wildcard characters: False 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: $true | $false +Type: Boolean Parameter Sets: TuiLogonGeneral Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -204,7 +224,8 @@ The UMDialPlan parameter specifies the UM dial plan to be tested. This parameter Type: UMDialPlanIdParameter Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -219,7 +240,8 @@ The UMIPGateway parameter specifies the name of the UM IP gateway or IP PBX to u Type: UMIPGatewayIdParameter Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: True Position: Named Default value: None @@ -234,7 +256,8 @@ The CallRouter switch specifies whether to test the Microsoft Exchange Unified M Type: SwitchParameter Parameter Sets: LocalLoop Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -249,7 +272,8 @@ The CertificateThumbprint parameter specifies the certificate thumbprint used fo Type: String Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -260,15 +284,15 @@ 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. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -283,7 +307,8 @@ The DiagDtmfDurationInMilisecs parameter specifies the duration of each digit se Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -298,7 +323,8 @@ The DiagDtmfSequence parameter specifies the sequence of digits sent. Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -313,7 +339,8 @@ The DiagInitialSilenceInMilisecs parameter specifies the time period in millisec Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -328,7 +355,8 @@ The DiagInterDtmfDiffGapInMilisecs parameter specifies whether to customize the Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -343,7 +371,8 @@ The DiagInterDtmfGapInMilisecs parameter specifies the time in milliseconds betw Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -358,7 +387,8 @@ 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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -373,7 +403,8 @@ The From parameter specifies the SIP URI or SIP address that the call originated Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -388,7 +419,8 @@ The ListenPort parameter specifies the IP port number on which to listen. If not Type: Int32 Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -400,10 +432,11 @@ Accept wildcard characters: False The MediaSecured parameter specifies whether to use Secure RTP or RTP (unsecured) mode. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -412,13 +445,17 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -433,7 +470,8 @@ The RemotePort parameter specifies the port used for the call. If not specified, Type: Int32 Parameter Sets: TuiLogonSpecific, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -445,10 +483,11 @@ Accept wildcard characters: False The Secured parameter specifies whether the test is run in SIP Secured mode. ```yaml -Type: $true | $false +Type: Boolean Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -463,7 +502,8 @@ The Timeout parameter specifies the length of time in seconds to wait for the te Type: Int32 Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -478,7 +518,8 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + Required: False Position: Named Default value: None @@ -487,20 +528,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/4e8f5561-a098-4bfe-94e1-baf7c24b01bb.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-WebServicesConnectivity.md b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md similarity index 75% rename from exchange/exchange-ps/exchange/client-access/Test-WebServicesConnectivity.md rename to exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md index dcc3fb3a8a..fba4a45320 100644 --- a/exchange/exchange-ps/exchange/client-access/Test-WebServicesConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Test-WebServicesConnectivity @@ -13,15 +16,16 @@ This cmdlet is available only in on-premises Exchange. Use the Test-WebServicesConnectivity cmdlet to test client connectivity to Exchange Web Services virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### ClientAccessServer2010 +### Default ``` -Test-WebServicesConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-AllowUnsecureAccess] +Test-WebServicesConnectivity [[-ClientAccessServer] <ServerIdParameter>] + [-AllowUnsecureAccess] [-Confirm] [-DomainController <Fqdn>] [-LightMode] @@ -31,18 +35,19 @@ Test-WebServicesConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-Allow [-Timeout <UInt32>] [-TrustAnySSLCertificate] [-UseAutodiscoverForClientAccessServer] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### AutoDiscoverServer ``` -Test-WebServicesConnectivity -AutoDiscoverServer <ClientAccessServerIdParameter> +Test-WebServicesConnectivity [[-Identity] <MailboxIdParameter>] -AutoDiscoverServer <ClientAccessServerIdParameter> [-Confirm] - [[-Identity] <MailboxIdParameter>] [-LightMode] [-MailboxCredential <PSCredential>] [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### MonitoringContext @@ -52,7 +57,8 @@ Test-WebServicesConnectivity [[-Identity] <MailboxIdParameter>] [-MonitoringCont [-LightMode] [-MailboxCredential <PSCredential>] [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### ClientAccessServer @@ -62,7 +68,8 @@ Test-WebServicesConnectivity [[-Identity] <MailboxIdParameter>] [-ClientAccessSe [-LightMode] [-MailboxCredential <PSCredential>] [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -75,62 +82,58 @@ The first time you use this cmdlet, you might be required to create a test user. The test results are displayed on-screen. The cmdlet returns the following information. - Source: Source server. - - ServiceEndpoint: Destination server. - - Scenario: The operations that are tested. Values are Autodiscover: SOAP Provider and EWS: GetFolder (full mode) or EWS: ConvertID (light mode). - - Result: The values returned are typically Success or \*FAILURE\*. - - Latency(MS): The time required to complete the test in milliseconds -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: +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"`. -Test-WebServicesConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Test-WebServicesConnectivity -AllowUnsecureAccess ``` In Exchange 2010, this example tests Exchange Web Services on the local Client Access server and allows the test to use an unsecured connection that doesn't require SSL. A default test account is used. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Test-WebServicesConnectivity -ClientAccessServer MBX01 ``` This example tests the client connection to Exchange Web Services on the server named MBX01. ## PARAMETERS -### -AutoDiscoverServer -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: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +### -Identity +The Identity parameter specifies the mailbox to use for the test. You can use any value that uniquely identifies the mailbox. For example: -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) -You can't use this parameter with the ClientAccessServer parameter. +When you use this parameter, you also need to use the MailboxCredential parameter. ```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: AutoDiscoverServer +Type: MailboxIdParameter +Parameter Sets: AutoDiscoverServer, MonitoringContext, ClientAccessServer Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named + +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` @@ -140,20 +143,18 @@ The ClientAccessServer parameter specifies the Exchange server to test. This ser You can use any value that uniquely identifies the server. For example: - Name - - Distinguished name (DN) - - ExchangeLegacyDN - - GUID You can't use this parameter with the AutoDiscoverServer parameter. ```yaml Type: ServerIdParameter -Parameter Sets: ClientAccessServer2010 +Parameter Sets: Default, ClientAccessServer Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: 1 Default value: None @@ -161,69 +162,55 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AutoDiscoverServer +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: + +- Name (for example, Exchange01) +- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) +- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) +- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) + +You can't use this parameter with the ClientAccessServer parameter. + ```yaml -Type: ServerIdParameter -Parameter Sets: ClientAccessServer +Type: ClientAccessServerIdParameter +Parameter Sets: AutoDiscoverServer Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False + +Required: True Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mailbox to use for the test. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -When you use this parameter, you also need to use the MailboxCredential parameter. - ```yaml -Type: MailboxIdParameter -Parameter Sets: AutoDiscoverServer, MonitoringContext, ClientAccessServer +Type: ServerIdParameter +Parameter Sets: ClientAccessServer Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` ### -AllowUnsecureAccess -This parameter is available or functional only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. -The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). +The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -234,8 +221,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -243,6 +229,7 @@ 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 @@ -251,7 +238,7 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available or functional only in 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. @@ -260,6 +247,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -277,6 +265,7 @@ 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 @@ -287,7 +276,7 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). This parameter is required when you use the Identity parameter. @@ -296,6 +285,7 @@ Type: PSCredential Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -311,6 +301,7 @@ Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -319,13 +310,16 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter Parameter Sets: MonitoringContext Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -334,13 +328,16 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -356,6 +353,7 @@ Type: UInt32 Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -364,7 +362,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -373,6 +371,7 @@ 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 @@ -381,15 +380,16 @@ Accept wildcard characters: False ``` ### -UseAutodiscoverForClientAccessServer -This parameter is available or functional only in Exchange Server 2010. +This parameter is available only in Exchange Server 2010. -The UseAutodiscoverForClientAccessServer parameter specifies whether the test should use the Autodiscover service to locate the Client Access server. +The UseAutodiscoverForClientAccessServer switch specifies whether the test should use the Autodiscover service to locate the Client Access server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -405,6 +405,7 @@ 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 @@ -413,20 +414,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/5e1b2b06-f24e-4f33-8ddc-fdb1c5bb7eb2.aspx) diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md new file mode 100644 index 0000000000..50c11224ce --- /dev/null +++ b/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md @@ -0,0 +1,229 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Undo-SoftDeletedMailbox + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### PublicFolder +``` +Undo-SoftDeletedMailbox [-SoftDeletedObject] <MailboxIdParameter> + [-DisplayName <String>] + [-PublicFolder] + [-Confirm] + [-Name <String>] + [-WhatIf] + [<CommonParameters>] +``` + +### SoftDeletedMailbox +``` +Undo-SoftDeletedMailbox [-SoftDeletedObject] <MailboxIdParameter> + [-Password <SecureString>] + [-WindowsLiveID <WindowsLiveId>] + [-Confirm] + [-DisplayName <String>] + [-Name <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Undo-SoftDeletedMailbox -SoftDeletedObject florencef +``` + +This example recovers the deleted mailbox for the user Florence Flipo. When this mailbox was deleted, the associated Microsoft account was also deleted. + +### Example 2 +```powershell +Undo-SoftDeletedMailbox bjohnson@contoso.edu -WindowsLiveID brianj@contoso.edu -Password (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. + +## PARAMETERS + +### -SoftDeletedObject +The SoftDeletedObject parameter specifies the deleted mailbox to recover. You can use the alias or the email address of the deleted mailbox for the value of this parameter. Use the Get-Mailbox -SoftDeletedMailbox command to get information for deleted mailboxes. + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PublicFolder +The PublicFolder switch is required to recover public folder mailboxes. You don't need to specify a value with this switch. + +Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. + +```yaml +Type: SwitchParameter +Parameter Sets: PublicFolder +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password parameter specifies a new password for the mailbox. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +You have to include the Password parameter to recover a deleted mailbox with an existing Microsoft account (formerly known as a Windows Live ID) that wasn't deleted with the mailbox. + +```yaml +Type: SecureString +Parameter Sets: SoftDeletedMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsLiveID +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. + +```yaml +Type: WindowsLiveId +Parameter Sets: SoftDeletedMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md new file mode 100644 index 0000000000..7402d91bdb --- /dev/null +++ b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md @@ -0,0 +1,123 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Undo-SoftDeletedUnifiedGroup + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Undo-SoftDeletedUnifiedGroup cmdlet to restore soft-deleted Microsoft 365 Groups in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Undo-SoftDeletedUnifiedGroup [-SoftDeletedObject] <UnifiedGroupIdParameter> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Microsoft 365 Groups are group objects that are available across Microsoft 365 services. + +Soft-deleted Microsoft 365 Groups are groups that have been deleted, but can be restored within 30 days of being deleted. All of the group contents can be restored within this period. After 30 days, soft-deleted Microsoft 365 Groups are marked for permanent deletion and can't be restored. + +To display all soft-deleted Microsoft 365 Groups in your organization, use the [Get-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). + +## EXAMPLES + +### Example 1 +```powershell +Undo-SoftDeletedUnifiedGroup -SoftDeletedObject "Marketing Department" +``` + +This example restores the soft-deleted Microsoft 365 Group named Marketing Department. + +## PARAMETERS + +### -SoftDeletedObject +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +**Note**: You might need to use the DistinguishedName or ExchangeGuid property to identify the soft-deleted Microsoft 365 Group, because it's possible for an active Microsoft 365 Group and a soft-deleted Microsoft 365 Group to have the same primary SMTP address. + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mail-flow/Uninstall-TransportAgent.md b/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md similarity index 77% rename from exchange/exchange-ps/exchange/mail-flow/Uninstall-TransportAgent.md rename to exchange/exchange-ps/exchange/Uninstall-TransportAgent.md index 945e81c683..5618a653c7 100644 --- a/exchange/exchange-ps/exchange/mail-flow/Uninstall-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Uninstall-TransportAgent @@ -13,30 +16,32 @@ This cmdlet is available only in on-premises Exchange. Use the Uninstall-TransportAgent cmdlet to unregister transport agents from Exchange servers. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Uninstall-TransportAgent [-Identity] <TransportAgentObjectId> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>] [<CommonParameters>] +Uninstall-TransportAgent [-Identity] <TransportAgentObjectId> + [-Confirm] + [-DomainController <Fqdn>] + [-TransportService <TransportService>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION You can install and uninstall transport agents in the following locations: - The Transport service on Mailbox servers. - - 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Uninstall-TransportAgent "Test App" -TransportService Hub ``` @@ -52,6 +57,7 @@ Type: TransportAgentObjectId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -62,8 +68,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -71,6 +76,7 @@ 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 @@ -88,21 +94,7 @@ 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 -``` -### -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 @@ -114,20 +106,33 @@ Accept wildcard characters: False 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. - - MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - - MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - - FrontEnd for the Front End Transport service on Mailbox servers. - - Edge on Edge Transport servers. ```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery +Type: TransportService Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 @@ -136,20 +141,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e0f9c8e5-2279-4e4d-8a32-108b8e8e9f00.aspx) diff --git a/exchange/exchange-ps/exchange/Update-AddressList.md b/exchange/exchange-ps/exchange/Update-AddressList.md new file mode 100644 index 0000000000..8c44e68434 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-AddressList.md @@ -0,0 +1,132 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-AddressList + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Update-AddressList cmdlet to update the recipients included in address lists. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-AddressList [-Identity] <AddressListIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-AddressList -Identity "All Users\Sales\building4" +``` + +This example updates the recipients of the address list named building4 that's under the container All Users\\Sales. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) + +```yaml +Type: AddressListIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -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/Update-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md new file mode 100644 index 0000000000..dfbaff31dc --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md @@ -0,0 +1,137 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Update-ComplianceCaseMember + +## 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 Update-ComplianceCaseMember cmdlet to replace all members of eDiscovery cases in the Microsoft Purview compliance portal. To add or remove existing members, use the Add-ComplianceCaseMember and Remove-ComplianceCaseMember cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-ComplianceCaseMember [-Case] <String> -Members <String[]> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You use eDiscovery cases to control who can create, access, and manage compliance searches in your organization. You use the New-ComplianceCase cmdlet to create eDiscovery cases. The eDiscovery Manager who created the case is automatically added as a member of the case. + +To add a member of an eDiscovery case, the user needs to be a member of the Reviewer or eDiscovery Manager role groups. When a member of the eDiscovery Manager role group is a member of an eDiscovery case, the user can: + +- Add and remove case members. +- Create and edit compliance searches associated with a case. +- Perform compliance actions (for example, export) on the results of a compliance search. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-ComplianceCaseMember -Case "Case 5150" -Members chris@contoso.com,michelle@contoso.com,laura@contoso.com,julia@contoso.com +``` + +This example replaces the existing members of the eDiscovery case named Case 5150 with new members. + +## PARAMETERS + +### -Case +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: String[] +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 +``` + +### -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/Update-DatabaseSchema.md b/exchange/exchange-ps/exchange/Update-DatabaseSchema.md new file mode 100644 index 0000000000..1ca485d6cb --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-DatabaseSchema.md @@ -0,0 +1,146 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-DatabaseSchema + +## 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. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-DatabaseSchema [-Identity] <DatabaseIdParameter> -MajorVersion <UInt16> -MinorVersion <UInt16> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-DatabaseSchema DB1 +``` + +This example updates the database schema for database DB1. + +## PARAMETERS + +### -Identity +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 +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -MajorVersion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinorVersion +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/users-and-groups/Update-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md similarity index 75% rename from exchange/exchange-ps/exchange/users-and-groups/Update-DistributionGroupMember.md rename to exchange/exchange-ps/exchange/Update-DistributionGroupMember.md index 2d4d0c6d3a..cc94a00944 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Update-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Update-DistributionGroupMember @@ -13,22 +16,27 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Update-DistributionGroupMember cmdlet to replace all members of distribution groups and mail-enabled security groups. To add or remove existing group members, use the Add-DistributionGroupMember and Remove-DistributionGroupMember cmdlets. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Update-DistributionGroupMember [-Identity] <DistributionGroupIdParameter> [-BypassSecurityGroupManagerCheck] - [-Confirm] [-DomainController <Fqdn>] [-Members <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] +Update-DistributionGroupMember [-Identity] <DistributionGroupIdParameter> + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController <Fqdn>] + [-Members <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Update-DistributionGroupMember -Identity "Research Reports" -Members chris@contoso.com,michelle@contoso.com,laura@contoso.com,julia@contoso.com ``` @@ -37,22 +45,13 @@ This example replaces the existing members of the distribution group name Resear ## PARAMETERS ### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. - -For example: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID ```yaml @@ -60,6 +59,7 @@ 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 Default value: None @@ -68,19 +68,19 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) 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 @@ -91,8 +91,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -100,6 +99,7 @@ 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 @@ -117,6 +117,7 @@ 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 @@ -125,33 +126,27 @@ 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: +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: - Name - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". +You 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. +The maximum number of entries for this parameter is 10000. + ```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 Default value: None @@ -167,6 +162,7 @@ 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 @@ -175,20 +171,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/010394d3-5554-42f6-b0c3-5af5881c75ff.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md rename to exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md index c04f31418b..a5ab8316da 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Update-EmailAddressPolicy @@ -13,22 +16,27 @@ This cmdlet is available only in on-premises Exchange. Use the Update-EmailAddressPolicy cmdlet to apply new or updated email address policies to the affected recipients in an on-premises Exchange organization. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Update-EmailAddressPolicy [-Identity] <EmailAddressPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-FixMissingAlias] [-WhatIf] [-UpdateSecondaryAddressesOnly] [<CommonParameters>] +Update-EmailAddressPolicy [-Identity] <EmailAddressPolicyIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-FixMissingAlias] + [-UpdateSecondaryAddressesOnly] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Update-EmailAddressPolicy -Identity "Northwest Executives" ``` @@ -40,9 +48,7 @@ This example applies the email address policy named Northwest Executives to all 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 - - Distinguished name (DN) - - GUID ```yaml @@ -50,6 +56,7 @@ Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -60,8 +67,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +75,7 @@ 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 @@ -84,6 +91,7 @@ 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 @@ -101,6 +109,7 @@ 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 @@ -108,14 +117,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +### -UpdateSecondaryAddressesOnly +The UpdateSecondaryAddressesOnly switch specifies that only the proxy email addresses are updated for the recipients. You don't need to specify a value with this switch. + +The recipient's primary email address isn't updated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -123,14 +135,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateSecondaryAddressesOnly -The UpdateSecondaryAddressesOnly switch parameter specifies that only the proxy email addresses are updated for the recipients. The recipient's primary email address isn't updated. You don't need to specify a value with this switch. +### -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: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -139,20 +152,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/283081a2-14bb-46cd-918e-e2dd168c43ab.aspx) diff --git a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md new file mode 100644 index 0000000000..01778dcf54 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md @@ -0,0 +1,79 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-ExchangeHelp + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Update-ExchangeHelp cmdlet to find, download and install the latest available help topics for the Exchange Management Shell on the local computer. If an available version is found based your installed version and languages of Exchange, the cmdlet downloads and integrates the updated version of Help in the Exchange Management Shell. This cmdlet is a required substitute for the Update-Help cmdlet that's available in Windows PowerShell. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-ExchangeHelp [-Force] + [<CommonParameters>] +``` + +## DESCRIPTION +The Update-ExchangeHelp cmdlet is available in Exchange Server 2013 or later. + +You need to run the Update-ExchangeHelp cmdlet on each Exchange server. By default, the cmdlet requires an Internet connection, but you can configure an offline mode. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-ExchangeHelp -Force +``` + +This example checks for the latest available version of Help for the Exchange Management Shell on the local computer. Because we used the Force switch, the command checks for updates even if you ran the command less than 24 hours ago and displays status and error messages. + +## PARAMETERS + +### -Force +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md b/exchange/exchange-ps/exchange/Update-FileDistributionService.md similarity index 76% rename from exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md rename to exchange/exchange-ps/exchange/Update-FileDistributionService.md index cb375a0625..869bf696a3 100644 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md +++ b/exchange/exchange-ps/exchange/Update-FileDistributionService.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Update-FileDistributionService @@ -13,13 +16,17 @@ This cmdlet is available only in Exchange Server 2010. Use the Update-FileDistributionService cmdlet to access the Microsoft Exchange File Distribution service to poll for offline address book (OAB), Group Metrics, and Unified Messaging (UM) configuration and data. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Update-FileDistributionService [-Identity] <ServerIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Type <String>] [-WhatIf] [<CommonParameters>] +Update-FileDistributionService [-Identity] <ServerIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Type <String>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -27,26 +34,26 @@ 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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Update-FileDistributionService -Identity Server1 -Type "OAB" ``` This example polls Server1 to check for updated OAB files for OABs associated with Server1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Update-FileDistributionService -Identity Server1 ``` This example polls Server1 for changes to OAB, Group Metrics, and Unified Messaging files associated with Server1. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Update-FileDistributionService -Identity Server1 -Type GM ``` @@ -55,15 +62,19 @@ This example polls Server1 for changes to Group Metrics files associated with Se ## PARAMETERS ### -Identity -The Identity parameter specifies the GUID or server name that represents a specific server. +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: -You can omit the parameter label Identity so that only the server name or GUID is supplied. +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: True Position: 1 Default value: None @@ -74,8 +85,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -83,6 +93,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -98,6 +109,7 @@ Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -111,9 +123,7 @@ The Type parameter specifies whether to reload OAB, Unified Messaging, or Group The Type parameter takes the following values: - OAB Using the OAB value forces the Exchange File Distribution service to reload its configuration and poll for new data associated with OABs. - - UM Using the UM value forces the Exchange File Distribution service to reload its configuration and poll for new data associated with Unified Messaging. - - GM Using the GM value forces the Exchange File Distribution service to reload its configuration and poll for new data associated with Group Metrics. ```yaml @@ -121,6 +131,7 @@ Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -136,6 +147,7 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: Exchange Server 2010 + Required: False Position: Named Default value: None @@ -144,20 +156,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cf98ab73-1448-455f-842d-f0d2aa3a2a79.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md b/exchange/exchange-ps/exchange/Update-GlobalAddressList.md similarity index 75% rename from exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md rename to exchange/exchange-ps/exchange/Update-GlobalAddressList.md index e76a2c1010..8fe39ea94d 100644 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Update-GlobalAddressList.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Update-GlobalAddressList @@ -11,24 +14,27 @@ monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Update-GlobalAddressList cmdlet to update the recipients included ina global address list (GAL). +Use the Update-GlobalAddressList cmdlet to update the recipients included in a global address list (GAL). -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Update-GlobalAddressList [-Identity] <GlobalAddressListIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] +Update-GlobalAddressList [-Identity] <GlobalAddressListIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Update-GlobalAddressList -Identity "Default Global Address List" ``` @@ -40,9 +46,7 @@ This example updates the recipients in the default GAL. 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 - - Distinguished name (DN) - - GUID ```yaml @@ -50,6 +54,7 @@ Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -60,8 +65,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -69,6 +73,7 @@ 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 @@ -84,6 +89,7 @@ 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 @@ -99,6 +105,7 @@ 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 @@ -107,20 +114,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/6d3ee7f3-1205-4f04-a833-c5c47f2b774c.aspx) diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md new file mode 100644 index 0000000000..bb0e1ea9e9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md @@ -0,0 +1,198 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Update-HybridConfiguration cmdlet to define the credentials that are used to update the hybrid configuration object. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-HybridConfiguration -OnPremisesCredentials <PSCredential> -TenantCredentials <PSCredential> + [-Confirm] + [-DomainController <Fqdn>] + [-ForceUpgrade] + [-SuppressOAuthWarning] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$OnPremisesCreds = Get-Credential + +$TenantCreds = Get-Credential + +Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds +``` + +This example defines the credentials that are used to update the hybrid configuration object and connect to the Microsoft 365 for enterprises organization. + +Use the first command to specify your on-premises organization credentials. For example, run this command and enter `<domain>\admin@contoso.com` and the associated password in the resulting Windows PowerShell Credential Request dialog box. + +Use the second command to specify your Microsoft 365 organization credentials. For example, run this command and then enter `admin@contoso.onmicrosoft.com` and the associated account password in the resulting Windows PowerShell Credential Request dialog box. + +Use the last command to define the credentials that are used to update the hybrid configuration object and connect to the Microsoft 365 organization. + +## PARAMETERS + +### -OnPremisesCredentials +The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantCredentials +The TenantCredentials parameter specifies the Microsoft 365 organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Microsoft 365 organization was created. This account must be a member of the Global Administrators role. + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpgrade +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressOAuthWarning +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/database-availability-groups/Update-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md similarity index 80% rename from exchange/exchange-ps/exchange/database-availability-groups/Update-MailboxDatabaseCopy.md rename to exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md index 82827712ff..b7f5614479 100644 --- a/exchange/exchange-ps/exchange/database-availability-groups/Update-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Update-MailboxDatabaseCopy @@ -13,50 +16,60 @@ This cmdlet is available only in on-premises Exchange. Use the Update-MailboxDatabaseCopy cmdlet to seed or reseed a mailbox database copy. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### CancelSeed ``` -Update-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> [-CancelSeed] +Update-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> + [-CancelSeed] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### Identity ``` -Update-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> [-BeginSeed] [-Force] [-Network <DatabaseAvailabilityGroupNetworkIdParameter>] [-SecondaryDatabasePartitionOnly] [-SourceServer <ServerIdParameter>] +Update-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> + [-BeginSeed] + [-Force] + [-Network <DatabaseAvailabilityGroupNetworkIdParameter>] + [-SecondaryDatabasePartitionOnly] + [-SourceServer <ServerIdParameter>] [-CatalogOnly] [-Confirm] [-DatabaseOnly] [-DeleteExistingFiles] [-DomainController <Fqdn>] [-ManualResume] - [-NetworkCompressionOverride <UseDagDefault | Off | On>] - [-NetworkEncryptionOverride <UseDagDefault | Off | On>] + [-NetworkCompressionOverride <UseDagDefaultOnOff>] + [-NetworkEncryptionOverride <UseDagDefaultOnOff>] [-NoThrottle] [-PrimaryDatabasePartitionOnly] [-SafeDeleteExistingFiles] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ### ExplicitServer ``` -Update-MailboxDatabaseCopy -Server <MailboxServerIdParameter> [-MaximumSeedsInParallel <Int32>] +Update-MailboxDatabaseCopy -Server <MailboxServerIdParameter> + [-MaximumSeedsInParallel <Int32>] [-CatalogOnly] [-Confirm] [-DatabaseOnly] [-DeleteExistingFiles] [-DomainController <Fqdn>] [-ManualResume] - [-NetworkCompressionOverride <UseDagDefault | Off | On>] - [-NetworkEncryptionOverride <UseDagDefault | Off | On>] + [-NetworkCompressionOverride <UseDagDefaultOnOff>] + [-NetworkEncryptionOverride <UseDagDefaultOnOff>] [-NoThrottle] [-PrimaryDatabasePartitionOnly] [-SafeDeleteExistingFiles] - [-WhatIf] [<CommonParameters>] + [-WhatIf] + [<CommonParameters>] ``` ## DESCRIPTION @@ -64,42 +77,42 @@ Seeding is the process in which a copy of a mailbox database is added to another The Update-MailboxDatabaseCopy cmdlet can also be used to seed a content index catalog for a mailbox database copy. When you do this, the MAPI network is used, regardless of the value you specify with the Network parameter. -You must suspend a database copy before you can update it using the Update-MailboxDatabaseCopy cmdlet. For detailed steps about how to suspend a database copy, see Suspend or resume a mailbox database copy (https://technet.microsoft.com/library/dd298159.aspx). +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://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Update-MailboxDatabaseCopy -Identity DB1\MBX1 ``` This example seeds a copy of the database DB1 on the Mailbox server MBX1. -### -------------------------- Example 2 -------------------------- -``` +### Example 2 +```powershell Update-MailboxDatabaseCopy -Identity DB1\MBX1 -SourceServer MBX2 ``` This example seeds a copy of the database DB1 on the Mailbox server MBX1 using MBX2 as the source Mailbox server for the seed. -### -------------------------- Example 3 -------------------------- -``` +### Example 3 +```powershell Update-MailboxDatabaseCopy -Identity DB1\MBX1 -DatabaseOnly ``` This example seeds a copy of the database DB1 on the Mailbox server MBX1 without seeding the content index catalog. -### -------------------------- Example 4 -------------------------- -``` +### Example 4 +```powershell Update-MailboxDatabaseCopy -Identity DB1\MBX1 -CatalogOnly ``` This example seeds the content index catalog for the copy of the database DB1 on the Mailbox server MBX1 without seeding the database file. The content index catalog seeding occurs over the MAPI network. -### -------------------------- Example 5 -------------------------- -``` +### Example 5 +```powershell Update-MailboxDatabaseCopy -Server MBX1 ``` @@ -107,33 +120,35 @@ This example performs a full server reseed of all of the databases on the Mailbo ## PARAMETERS -### -CancelSeed -The CancelSeed switch specifies whether to cancel an in-progress seeding operation. You don't need to specify a value with this switch. +### -Identity +The Identity parameter specifies the name or GUID of the mailbox database whose copy is being seeded. ```yaml -Type: SwitchParameter -Parameter Sets: CancelSeed +Type: DatabaseCopyIdParameter +Parameter Sets: CancelSeed, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name or GUID of the mailbox database whose copy is being seeded. +### -CancelSeed +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: DatabaseCopyIdParameter -Parameter Sets: CancelSeed, Identity +Type: SwitchParameter +Parameter Sets: CancelSeed Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -145,6 +160,7 @@ Type: MailboxServerIdParameter Parameter Sets: ExplicitServer Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: Named Default value: None @@ -162,6 +178,7 @@ Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -170,13 +187,14 @@ Accept wildcard characters: False ``` ### -CatalogOnly -The CatalogOnlyswitch 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. +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 Default value: None @@ -187,8 +205,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -196,6 +213,7 @@ 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 @@ -204,13 +222,14 @@ Accept wildcard characters: False ``` ### -DatabaseOnly -The DatabaseOnlyswitch 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. +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 Default value: None @@ -228,6 +247,7 @@ Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -243,6 +263,7 @@ 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 @@ -251,13 +272,16 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -275,6 +299,7 @@ Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -290,6 +315,7 @@ Type: Int32 Parameter Sets: ExplicitServer Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -305,6 +331,7 @@ Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -316,10 +343,11 @@ Accept wildcard characters: False The NetworkCompressionOverride parameter specifies whether to override the current DAG network compression settings. ```yaml -Type: UseDagDefault | Off | On +Type: UseDagDefaultOnOff Parameter Sets: Identity, ExplicitServer Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -331,10 +359,11 @@ Accept wildcard characters: False The NetworkEncryptionOverride parameter specifies whether to override the current DAG encryption settings. ```yaml -Type: UseDagDefault | Off | On +Type: UseDagDefaultOnOff Parameter Sets: Identity, ExplicitServer Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -350,6 +379,7 @@ Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -364,7 +394,8 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2019 + Required: False Position: Named Default value: None @@ -373,7 +404,7 @@ Accept wildcard characters: False ``` ### -SafeDeleteExistingFiles -The SafeDeleteExistingFilesswitch 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. +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. @@ -382,6 +413,7 @@ Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -396,7 +428,8 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2019 + Required: False Position: Named Default value: None @@ -405,13 +438,21 @@ Accept wildcard characters: False ``` ### -SourceServer -The SourceServer parameter specifies the name of a Mailbox server with a passive copy of the mailbox database to be used as the source for the seed operation. +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: + +- Name +- FQDN +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml Type: ServerIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -427,6 +468,7 @@ 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 @@ -435,20 +477,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/37ebb66a-382e-4fd9-81f8-795f776a87b1.aspx) diff --git a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md new file mode 100644 index 0000000000..c9dd29eb20 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md @@ -0,0 +1,148 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-OfflineAddressBook + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Update-OfflineAddressBook cmdlet to update the offline address books (OABs) used by Microsoft Outlook clients. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-OfflineAddressBook [-Identity] <OfflineAddressBookIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-Force] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-OfflineAddressBook -Identity MyOAB +``` + +This example updates the OAB MyOAB. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: OfflineAddressBookIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/Update-PublicFolder.md b/exchange/exchange-ps/exchange/Update-PublicFolder.md new file mode 100644 index 0000000000..52de562a91 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-PublicFolder.md @@ -0,0 +1,157 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Update-PublicFolder + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Update-PublicFolder cmdlet to start content synchronization of a public folder. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-PublicFolder [-Identity] <PublicFolderIdParameter> -Server <ServerIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-PublicFolder "\Legal\Cases\My Public Folder" -Server "My Server" +``` + +This example starts content replication of the public folder My Public Folder in the \\Legal\\Cases path from the server My Server to all of the servers on the replication list for My Public Folder. + +### Example 2 +```powershell +Get-PublicFolder "\Legal\Cases\My Public Folder" | Update-PublicFolder -Server "My Server" +``` + +This example also starts content replication of the public folder My Public Folder in the \\Legal\\Cases path from the server My Server to all of the servers on the replication list for My Public Folder, but uses the Get-PublicFolder cmdlet to pipeline the desired folder. + +## PARAMETERS + +### -Identity +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. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md b/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md new file mode 100644 index 0000000000..c8bcc1dc98 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md @@ -0,0 +1,132 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Update-PublicFolderHierarchy + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2010. + +Use the Update-PublicFolderHierarchy cmdlet to start content synchronization of the public folder hierarchy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-PublicFolderHierarchy -Server <ServerIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-MailboxServer -Identity Server1 | Update-PublicFolderHierarchy +``` + +This example pipes the output of the Get-MailboxServer command to the Update-PublicFolderHierarchy command to start content replication of the public folder hierarchy from Server1 to Mailbox servers with a public folder database. + +## PARAMETERS + +### -Server +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 +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010 + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md new file mode 100644 index 0000000000..cfef60bbfd --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md @@ -0,0 +1,312 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Update-PublicFolderMailbox cmdlet to update the hierarchy for public folders. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### InvokeSynchronizer +``` +Update-PublicFolderMailbox [-Identity] <MailboxIdParameter> + [-ForceOnlineSync] + [-FullSync] + [-Confirm] + [-DomainController <Fqdn>] + [-InvokeSynchronizer] + [-ReconcileFolders] + [-SuppressStatus] + [-WhatIf] + [<CommonParameters>] +``` + +### InvokeSingleFolderSynchronizer +``` +Update-PublicFolderMailbox [-Identity] <MailboxIdParameter> -FolderId <PublicFolderIdParameter> -InvokeSynchronizer + [-CreateAssociatedDumpster] + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet only needs to be used if you want to manually invoke the hierarchy synchronizer and the mailbox assistant. Both these are invoked at least once every 24 hours for each public folder mailbox in the organization. The hierarchy synchronizer is invoked every 15 minutes if any users are logged on to a secondary mailbox through Outlook or an Exchange Web Services client. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-PublicFolderMailbox -Identity PF_marketing +``` + +This example updates the public folder hierarchy on the public folder mailbox PF\_marketing. + +### Example 2 +```powershell +Get-Mailbox -PublicFolder | Update-PublicFolderMailbox +``` + +This example updates all public folder mailboxes. + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -FolderId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvokeSynchronizer +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 +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: InvokeSynchronizer +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateAssociatedDumpster +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceOnlineSync +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullSync +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 +Default value: None +Accept pipeline input: False +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. + +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 both the scenarios, public folders that were deleted or moved to LOST_AND_FOUND can be restored using Set-PublicFolder command. + +This example restores the public folder named "Marketing" from LOST_AND_FOUND to the folder named \South + +`Get-PublicFolder \NON_IPM_SUBTREE\LOST_AND_FOUND\5773ba6a-9926-4d64-97db-63a2bdd94a5b\"Pesky Pole" | Set-PublicFolder -Path "\South"` + +This example restores the public folder named "Documents" from LOST_AND_FOUND to the folder named \Engineering + +`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. + +```yaml +Type: SwitchParameter +Parameter Sets: InvokeSynchronizer +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: InvokeSynchronizer +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Update-Recipient.md b/exchange/exchange-ps/exchange/Update-Recipient.md new file mode 100644 index 0000000000..c4b96b4b18 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-Recipient.md @@ -0,0 +1,168 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Update-Recipient cmdlet to add Exchange attributes to recipient objects. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-Recipient [-Identity] <RecipientIdParameter> + [-Confirm] + [-Credential <PSCredential>] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +In on-premises Exchange, before you can run the Update-Recipient cmdlet to convert an Active Directory user object into an Exchange mailbox, you must stamp the user object with the following three mandatory Exchange attributes: + +- homeMDB +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Update-Recipient -Identity "John Smith" +``` + +This example adds Exchange attributes to the mail contact that represents John Smith's mailbox. + +### Example 2 +```powershell +Get-MailContact -OrganizationalUnit "contoso.com/fabrikam.com Users" | Update-Recipient +``` + +In on-premises Exchange, this example updates all contacts in a specific organizational unit (OU). This example assumes that recipients are synchronized between two forests, contoso.com and fabrikam.com, and all the synchronized recipients from the fabrikam.com domain are stored in a specific OU called fabrikam.com Users in the contoso.com domain. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the recipient that you want to update. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept 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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The Credential parameter specifies the username and password 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). + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +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. + +```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 +``` + +### -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, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/Update-RoleGroupMember.md b/exchange/exchange-ps/exchange/Update-RoleGroupMember.md new file mode 100644 index 0000000000..8c47b09f10 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-RoleGroupMember.md @@ -0,0 +1,202 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Update-RoleGroupMember cmdlet to modify the members of a management role group. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-RoleGroupMember [-Identity] <RoleGroupIdParameter> + [-BypassSecurityGroupManagerCheck] + [-Confirm] + [-DomainController <Fqdn>] + [-Members <MultiValuedProperty>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Update-RoleGroupMember cmdlet enables you to replace the entire membership list for a role group or perform programmatic addition or removal of multiple members at a single time. The membership list that you specify with the Members parameter on this cmdlet replaces the membership list for the specific role group. For this reason, take care when using this cmdlet so you don't mistakenly overwrite role group membership. + +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 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). + +## EXAMPLES + +### Example 1 +```powershell +Update-RoleGroupMember "Recipient Administrators" -Members "Mark", "Jane", "Mary", "Fred" +``` + +This example sets the Recipient Administrators role group membership list to Mark, Jane, Mary and Fred. + +### Example 2 +```powershell +Update-RoleGroupMember "Recipient Administrators" -Members "Mark", "Jane", "Mary", "Fred" -BypassSecurityGroupManagerCheck +``` + +This example sets the Recipient Administrators role group membership list to Mark, Jane, Mary and Fred. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. + +### Example 3 +```powershell +Update-RoleGroupMember "Organization Management" -Members @{Add=(Get-Mailbox David).Identity, (Get-Group "Help Desk Managers").Identity + +Remove=(Get-Mailbox "Christine").Identity, (Get-Mailbox "Isabel").Identity} +``` + +This example adds multiple members to, and removes multiple members from, a role group without replacing all the existing members on the role group. This example makes use of multivalued property syntax that's described in the topic [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). When you use this multivalued property syntax, you must manually retrieve the Identity of the mailbox or mail-enabled security group that you want to add to or remove from the role group. Use the syntax that matches the type of object you want to add or remove: + +Mailbox: If you want to add or remove a mailbox, use the syntax `(Get-Mailbox "<Alias or Name>").Identity`. + +Mail-enabled security group: If you want to add or remove a mail-enabled security group, use the syntax `(Get-Group "<Name>").Identity`. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassSecurityGroupManagerCheck +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: (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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 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 +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Members +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. + +```yaml +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/antispam-antimalware/Update-SafeList.md b/exchange/exchange-ps/exchange/Update-SafeList.md similarity index 77% rename from exchange/exchange-ps/exchange/antispam-antimalware/Update-SafeList.md rename to exchange/exchange-ps/exchange/Update-SafeList.md index fbd1ce5be3..9b052ebd8b 100644 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Update-SafeList.md +++ b/exchange/exchange-ps/exchange/Update-SafeList.md @@ -1,9 +1,12 @@ --- 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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" +author: chrisda +ms.author: chrisda +ms.reviewer: --- # Update-SafeList @@ -13,13 +16,18 @@ This cmdlet is available only in on-premises Exchange. Use the Update-SafeList cmdlet to update the safelist aggregation data in Active Directory. Safelist aggregation data is used in the built-in anti-spam filtering in Microsoft Exchange. EdgeSync replicates safelist aggregation data to Edge Transport servers in the perimeter network. -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Update-SafeList [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] [-EnsureJunkEmailRule] - [-IncludeDomains] [-Type <SafeSenders | SafeRecipients | Both | BlockedSenders | All>] [-WhatIf] +Update-SafeList [-Identity] <MailboxIdParameter> + [-Confirm] + [-DomainController <Fqdn>] + [-EnsureJunkEmailRule] + [-IncludeDomains] + [-Type <UpdateType>] + [-WhatIf] [<CommonParameters>] ``` @@ -28,51 +36,40 @@ The Update-SafeList cmdlet reads the safelist aggregation data stored on a Micro Be mindful of the network and replication traffic that may be generated when you run the Update-SafeList cmdlet. Running the command on multiple mailboxes where safelists are heavily used may generate a significant amount of traffic. We recommend that if you run the command on multiple mailboxes, you should run the command during off-peak, non-business hours. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` +### Example 1 +```powershell Update-Safelist kim@contoso.com ``` This example updates Safe Senders List data for the single user kim@contoso.com. -### -------------------------- Example 2 -------------------------- -``` -Set-AdServerSettings -ViewEntireForest $true; Get-Mailbox -ResultSize Unlimited -RecipientTypeDetails UserMailbox | Update-Safelist +### Example 2 +```powershell +Set-AdServerSettings -ViewEntireForest $true + +Get-Mailbox -ResultSize Unlimited -RecipientTypeDetails UserMailbox | Update-Safelist ``` -This example updates safelist data for all user mailboxes in your Exchange organization. By default, the Exchange Management Shell is configured to retrieve or modify objects that reside in the domain in which the Exchange server resides. Therefore, to retrieve all the mailboxes in your Exchange organization, you must first set the scope of the Exchange Manaagement Shell to the entire forest using the Set-AdServerSettings cmdlet. +This example updates safelist data for all user mailboxes in your Exchange organization. By default, the Exchange Management Shell is configured to retrieve or modify objects that reside in the domain in which the Exchange server resides. Therefore, to retrieve all the mailboxes in your Exchange organization, you must first set the scope of the Exchange Management Shell to the entire forest using the Set-AdServerSettings cmdlet. ## PARAMETERS ### -Identity -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: +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 - -- Display name - - Alias - - Distinguished name (DN) - - Canonical DN - -- \<domain name\>\\\<account name\> - +- Domain\\Username - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) ```yaml @@ -80,6 +77,7 @@ Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: True Position: 1 Default value: None @@ -90,8 +88,7 @@ Accept wildcard characters: False ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 @@ -99,6 +96,7 @@ 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 @@ -114,6 +112,7 @@ 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 @@ -122,7 +121,7 @@ Accept wildcard characters: False ``` ### -EnsureJunkEmailRule -The EnsureJunkEmailRule parameter specifies whether to force the junk email rule to be turned on for the mailbox if the rule isn't turned on already. +The EnsureJunkEmailRule switch forces the junk email rule to be turned on for the mailbox if the rule isn't turned on already. You don't need to specify a value with this switch. The junk email rule can only be created after the user logs on to the mailbox. If the user has never logged on to the mailbox, this parameter can't turn on the junk email rule. @@ -131,6 +130,7 @@ 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 @@ -139,7 +139,9 @@ Accept wildcard characters: False ``` ### -IncludeDomains -The IncludeDomains switch specifies whether to include the sender domains specified by users in Outlook in the safelist aggregation data. By default, domains specified by the senders aren't included. +The IncludeDomains switch specifies whether to include the sender domains specified by users in Outlook in the safelist aggregation data. You don't need to specify a value with this switch. + +By default, domains specified by the senders aren't included. In most cases, we don't recommend that you include domains because users may include the domains of large Internet service providers (ISPs), which could unintentionally provide addresses that may be used or spoofed by spammers. @@ -148,6 +150,7 @@ 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 @@ -161,10 +164,11 @@ The Type parameter specifies which user-generated list is updated to the user ob 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. ```yaml -Type: SafeSenders | SafeRecipients | Both | BlockedSenders | All +Type: UpdateType Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Required: False Position: Named Default value: None @@ -180,6 +184,7 @@ 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 @@ -188,20 +193,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/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 -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/e862c54c-4de0-4ef6-832e-ebb0cf8b2794.aspx) diff --git a/exchange/exchange-ps/exchange/Update-SiteMailbox.md b/exchange/exchange-ps/exchange/Update-SiteMailbox.md new file mode 100644 index 0000000000..e56a3a732f --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-SiteMailbox.md @@ -0,0 +1,221 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-SiteMailbox + +## 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. + +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-SiteMailbox [-Identity] <RecipientIdParameter> + [-BypassOwnerCheck] + [-Confirm] + [-FullSync] + [-Organization <OrganizationIdParameter>] + [-Server <String>] + [-Target <TargetType>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +Update-SiteMailbox -BypassOwnerCheck -Identity "MarketingEvents 2013" +``` + +This example updates the site mailbox MarketingEvents 2013. If you don't specify the target, this triggers both document and membership synchronization. Because the BypassOwnerCheck parameter is used, it isn't necessary to be an owner or member of the site mailbox to run this cmdlet. + +### Example 2 +```powershell +Update-SiteMailbox -BypassOwnerCheck -Identity WinterHoliday@tailspintoys.com -FullSync +``` + +This example updates the site mailbox WinterHoliday@tailspintoys.com and performs a full synchronization. By default, the update only occurs for synchronization from the last synchronization. This is only applicable to document synchronization + +## PARAMETERS + +### -Identity +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 +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -BypassOwnerCheck +The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +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 +- Document +- Membership + +If you don't specify this parameter when you run the cmdlet, this parameter value defaults to ALL. + +```yaml +Type: TargetType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange 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/Update-StoreMailboxState.md b/exchange/exchange-ps/exchange/Update-StoreMailboxState.md new file mode 100644 index 0000000000..d586e3c49e --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-StoreMailboxState.md @@ -0,0 +1,151 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-StoreMailboxState + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Update-StoreMailboxState cmdlet to synchronize the mailbox state for a mailbox in the Exchange mailbox store with the state of the corresponding Active Directory user account. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-StoreMailboxState -Database <DatabaseIdParameter> -Identity <StoreMailboxIdParameter> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Update-StoreMailboxState cmdlet forces the mailbox store state in the Exchange store to be synchronized with Active Directory. In some cases, it's possible that the store state for a mailbox to become out-of-sync with the state of the corresponding Active Directory user account. This can result from Active Directory replication latency. For example, if a mailbox-enabled user account is disabled in Active Directory but isn't marked as disabled in the Exchange mailbox store. In this case, running the Update-StoreMailboxState will synchronize the mailbox store state with the state of the Active Directory user account and mark the mailbox as disabled in the mailbox store. You can use this command to troubleshoot issues that may be a result when the store state for a mailbox is unexpected or if you suspect that the store state is different than the state for the corresponding Active Directory account. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Update-StoreMailboxState -Database MDB01 -Identity 4a830e3f-fd07-4629-baa1-8bce16b86d88 +``` + +This example updates the mailbox state for a mailbox located on the mailbox database MDB01 and whose GUID is 4a830e3f-fd07-4629-baa1-8bce16b86d88. + +### Example 2 +```powershell +Get-MailboxStatistics -Database MDB02 | ForEach { Update-StoreMailboxState -Database $_.Database -Identity $_.MailboxGuid -Confirm:$false } +``` + +This example updates the mailbox state for all mailboxes on the mailbox database MDB02. + +### Example 3 +```powershell +Get-MailboxStatistics -Database MDB03 | Where { $_.DisconnectReason -ne $null } | ForEach { Update-StoreMailboxState -Database $_.Database -Identity $_.MailboxGuid -Confirm:$false } +``` + +This example updates the mailbox state for all disconnected mailboxes on the mailbox database MDB03. + +## PARAMETERS + +### -Database +The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DatabaseIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 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 +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. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..f8a3ee84e0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -0,0 +1,391 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Update-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the 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 is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. +- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. + +Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX +``` +Update-VivaModuleFeaturePolicy -FeatureId <String> -ModuleId <String> -PolicyId <String> + [-Confirm] + [-Everyone <Boolean>] + [-IsFeatureEnabled <Boolean>] + [-IsUserControlEnabled <Boolean>] + [-IsUserOptedInByDefault <Boolean>] + [-GroupIds <String[]>] + [-Name <String>] + [-ResultSize <Unlimited>] + [-UserIds <String[]>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module in Viva. + +This cmdlet updates the attributes of the policy that you specify. These attributes include: + +- The policy name (Name parameter). +- Whether or not the policy enables the feature (IsFeatureEnabled parameter). +- Whether or not the policy enables user controls (IsUserControlEnabled parameter, only applicable to a feature policy). +- Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter). + +You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged. + +**Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b1 -Name NewPolicyName -IsFeatureEnabled $false +``` + +This example updates the name of the specified policy and makes it so the policy does not enable the feature. + +### Example 2 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds group1@contoso.com,group2@contoso.com +``` + +This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. + +### Example 3 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds user1@contoso.com,user2@contoso.com +``` + +This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. + +### Example 4 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureEnabled $true -GroupIds group1@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com +``` + +This example updates the name of the specified policy, makes it so the policy enables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. + +### Example 5 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false +``` + +This example updates a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the users previously added to the policy, allows user controls, and opted out users by default (Soft Disable policy). + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. + +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module of the policy that you want to update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update. + +To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Everyone +The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: + +- $true: The policy applies to all users. This is the only useful value for this parameter. +- $false: Don't use this value. + +If you don't want to update who the policy applies to, don't use this parameter. + +Don't use this parameter with the GroupIds or UserIds parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupIds +The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both [Mail-enabled and non-mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. + +If you don't want to update who the policy applies to, don't use this parameter. + +The values that you specify for this parameter or the UserIds parameter replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. + +**Note**: In v3.5.1-Preview2 or later of the module, this parameter supports security group object IDs (GUIDs). Previous versions of the module accept only email addresses for this parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: + +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. + +If you don't want to update whether the feature is enabled by the policy, don't use this parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserControlEnabled +**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. + +The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: + +- $true: User control is enabled by the policy. Users can opt out of the feature. +- $false: User control isn't enabled by the policy. Users can't opt of the feature. + +Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. + +If you don't want to update whether the user control is enabled by the policy, don't use this parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserOptedInByDefault +This parameter is available in version 3.8.0-Preview2 or later of the module. + +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: + +- $true: By default, users are opted in by the policy if the user hasn't set a preference. +- $false: By default, users are opted out by the policy if the user hasn't set a preference. + +This parameter is optional and can be used to override the default user opt-in value set in the feature metadata. + +This parameter can be set only when the IsUserControlEnabled parameter is set to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +Valid characters are English letters, numbers, commas, periods, and spaces. + +If you don't want to update the name of the policy, don't use this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas. + +If you don't want to update who the policy applies to, don't use this parameter. + +The values that you specify for this parameter or the GroupIds parameter replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md new file mode 100644 index 0000000000..bd36987193 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md @@ -0,0 +1,115 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Update-eDiscoveryCaseAdmin + +## 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 Update-eDiscoveryCaseAdmin cmdlet to replace all existing eDiscovery Administrators in the Microsoft Purview compliance portal. To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Update-eDiscoveryCaseAdmin -Users <String[]> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +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 "<UserIdentity>"`. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Update-eDiscoveryCaseAdmin -Users laura@contoso.com,julia@contoso.com +``` + +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: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: String[] +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 +``` + +### -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/Upgrade-DistributionGroup.md b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md new file mode 100644 index 0000000000..d0092da6bc --- /dev/null +++ b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md @@ -0,0 +1,122 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Upgrade-DistributionGroup + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Upgrade-DistributionGroup cmdlet to upgrade distribution groups to Microsoft 365 Groups. This cmdlet only works on distribution groups, not mail-enabled security groups. + +**Note**: Before you use this cmdlet, verify there are no email address policies that you created with the IncludeUnifiedGroupRecipients parameter; otherwise the command will fail. Remove and recreate the email address policies after you upgrade your distribution groups to Microsoft 365 Groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Upgrade-DistributionGroup [-DlIdentities] <MultiValuedProperty> + [-ActionType <String>] + [-ExecutingUser <RecipientIdParameter>] + [-Organization <OrganizationIdParameter>] + [<CommonParameters>] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Upgrade-DistributionGroup -DlIdentities hr@contoso.com,finance@contoso.com +``` + +This example upgrades the specified distribution groups to Microsoft 365 Groups. + +## PARAMETERS + +### -DlIdentities +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. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActionType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutingUser +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md new file mode 100644 index 0000000000..e096f825c2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md @@ -0,0 +1,133 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Validate-OutboundConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Validate-OutboundConnector cmdlet to test the settings of Outbound connectors in Microsoft 365. + +**Note**: This cmdlet does not set the validation status or timestamp on the connector. To set these values, run the following command: `Set-OutboundConnector -Identity "<ConnectorName>" -IsValidated $true -LastValidationTimestamp (Get-Date).ToUniversalTime()`. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Validate-OutboundConnector -Identity <OutboundConnectorIdParameter> -Recipients <MultiValuedProperty> + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Validate-OutboundConnector cmdlet performs two tests on the specified connector: + +- 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). + +## EXAMPLES + +### Example 1 +```powershell +Validate-OutboundConnector -Identity "Contoso.com Outbound Connector" -Recipients laura@contoso.com,julia@contoso.com +``` + +This example tests the Outbound connector named Contoso.com Outbound Connector. + +## PARAMETERS + +### -Identity +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 +- Distinguished name +- GUID + +```yaml +Type: OutboundConnectorIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recipients +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"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md new file mode 100644 index 0000000000..c4a8ee7175 --- /dev/null +++ b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md @@ -0,0 +1,69 @@ +--- +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 +ms.author: chrisda +ms.reviewer: +--- + +# Validate-RetentionRuleQuery + +## 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 Validate-RetentionRuleQuery cmdlet to validate the Keyword Query Language (KQL) content search filters for retention rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Validate-RetentionRuleQuery -KqlQueryString <String> + [<CommonParameters>] +``` + +## 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 +Validate-RetentionRuleQuery -KqlQueryString 'from:"Ann Beebe" AND subject:northwind' +``` + +This example validates the specified KQL content search filter. + +## PARAMETERS + +### -KqlQueryString +The KqlQueryString parameter specifies the KQL text search string that you want to validate. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, 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/Write-AdminAuditLog.md b/exchange/exchange-ps/exchange/Write-AdminAuditLog.md new file mode 100644 index 0000000000..3545297054 --- /dev/null +++ b/exchange/exchange-ps/exchange/Write-AdminAuditLog.md @@ -0,0 +1,135 @@ +--- +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 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# 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. + +Use the Write-AdminAuditLog cmdlet to write a comment to the administrator audit log. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Write-AdminAuditLog -Comment <String> + [-Confirm] + [-DomainController <Fqdn>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +When the Write-AdminAuditLog cmdlet runs, the value provided in the Comment parameter is included in the log entry. + +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). + +## EXAMPLES + +### Example 1 +```powershell +Write-AdminAuditLog -Comment "Ran custom script." +``` + +This example adds a comment to the administrator audit log. + +## PARAMETERS + +### -Comment +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 ("). + +```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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### Input types +To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. + +## OUTPUTS + +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/active-directory/Add-ADPermission.md b/exchange/exchange-ps/exchange/active-directory/Add-ADPermission.md deleted file mode 100644 index cb5bf84347..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Add-ADPermission.md +++ /dev/null @@ -1,386 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ADPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Add-ADPermission - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Add-ADPermission cmdlet to add permissions to an Active Directory object. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AccessRights -``` -Add-ADPermission [-Identity] <ADRawEntryIdParameter> -User <SecurityPrincipalIdParameter> - [-AccessRights <ActiveDirectoryRights[]>] - [-ChildObjectTypes <ADSchemaObjectIdParameter[]>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [-ExtendedRights <ExtendedRightIdParameter[]>] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-InheritedObjectType <ADSchemaObjectIdParameter>] - [-Properties <ADSchemaObjectIdParameter[]>] - [-WhatIf] [<CommonParameters>] -``` - -### Owner -``` -Add-ADPermission [-Identity] <ADRawEntryIdParameter> -Owner <SecurityPrincipalIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### Instance -``` -Add-ADPermission -Instance <ADAcePresentationObject> - [-AccessRights <ActiveDirectoryRights[]>] - [-ChildObjectTypes <ADSchemaObjectIdParameter[]>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [-ExtendedRights <ExtendedRightIdParameter[]>] - [[-Identity] <ADRawEntryIdParameter>] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-InheritedObjectType <ADSchemaObjectIdParameter>] - [-Properties <ADSchemaObjectIdParameter[]>] - [-User <SecurityPrincipalIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-ADPermission -Identity "Terry Adams" -User AaronPainter -AccessRights ExtendedRight -ExtendedRights "Send As" -``` - -This example grants Send As permissions for Aaron Painter to Terry Adams's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Add-AdPermission "IP Secured Inbound" -User "NT AUTHORITY\ANONYMOUS LOGON" -ExtendedRights ms-Exch-SMTP-Submit,ms-Exch-SMTP-Accept-Any-Recipient,ms-Exch-Bypass-Anti-Spam -``` - -This example configures the IP Secured Inbound Receive connector to accept anonymous SMTP messages. - -This example assumes that another security mechanism is used to ensure the Receive connector can't be used to send unsolicited commercial email messages. We recommend that you don't allow external clients to send messages anonymously through a Receive connector. - -## PARAMETERS - -### -Identity -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 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Owner -The Owner parameter specifies the owner of the Active Directory object. If the name of the owner contains spaces, enclose the name in quotation marks ("). - -The Owner parameter can only be used with the Identity parameter and no other parameters. - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Owner -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user that the permissions are being granted to on the object. If the name contains spaces, enclose the name in quotation marks ("). - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -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 -``` - -### -AccessRights -The AccessRights parameter specifies the rights needed to perform the operation. Valid values include: - -- AccessSystemSecurity - -- CreateChild - -- DeleteChild - -- ListChildren - -- Self - -- ReadProperty - -- WriteProperty - -- DeleteTree - -- ListObject - -- ExtendedRight - -- Delete - -- ReadControl - -- GenericExecute - -- GenericWrite - -- GenericRead - -- WriteDacl - -- WriteOwner - -- GenericAll - -- Synchronize - -```yaml -Type: ActiveDirectoryRights[] -Parameter Sets: AccessRights, Instance -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 -``` - -### -ChildObjectTypes -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Deny -The Deny switch specifies whether to deny permissions to the user on the Active Directory object. - -```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 -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedRights -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InheritanceType -The InheritanceType parameter specifies whether permissions are inherited. - -```yaml -Type: None | All | Descendents | SelfAndChildren | Children -Parameter Sets: AccessRights, Instance -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 -``` - -### -InheritedObjectType -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bef9f3db-84f6-4a40-81cb-c9cb9b9ee201.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-ADPermission.md b/exchange/exchange-ps/exchange/active-directory/Get-ADPermission.md deleted file mode 100644 index c1489988e1..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-ADPermission.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ADPermission - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ADPermission cmdlet to get permissions on an Active Directory object. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Owner -``` -Get-ADPermission [-Identity] <ADRawEntryIdParameter> [-Owner] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### AccessRights -``` -Get-ADPermission [-Identity] <ADRawEntryIdParameter> [-User <SecurityPrincipalIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ADPermission -Identity Ed -``` - -This example returns the permissions that have been applied to the user Ed. - -### -------------------------- Example 2 -------------------------- -``` -Get-ADPermission "Contoso.com" -User Chris -``` - -This example returns the permissions that have been granted to the user Chris on the Contoso.com Receive connector. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -The Owner switch specifies that the owner of the object specified in the Identity parameter should be returned. If the Owner switch is used, the User parameter can't be used. - -```yaml -Type: SwitchParameter -Parameter Sets: Owner -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 -``` - -### -User -The User parameter specifies that only the access control entries (ACEs) granted to the specified user on the object specified in the Identity parameter should be returned. If the User parameter is used, the Owner switch can't be used. - -If the name of the user contains spaces, enclose the name in quotation marks ("). - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f20251dc-ab54-4dd5-b80c-de0808fd4dc2.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-ADServerSettings.md b/exchange/exchange-ps/exchange/active-directory/Get-ADServerSettings.md deleted file mode 100644 index 3cf75299ac..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-ADServerSettings.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADServerSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdServerSettings [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdServerSettings | Format-List -``` - -This example displays the session settings for the current session. - -For more information about pipelining and the Format-List cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c09f17ff-7830-4a4e-a951-501bc44a26ab.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-ADSite.md b/exchange/exchange-ps/exchange/active-directory/Get-ADSite.md deleted file mode 100644 index e3cf918b8d..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-ADSite.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADSite -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdSite [[-Identity] <AdSiteIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdSite Default-First-Site-Name -``` - -This example displays the configuration details for the Active Directory site named Default-First-Site-Name. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/af3b6cc3-eb86-41d9-a643-171e36a3482d.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-AdSiteLink.md b/exchange/exchange-ps/exchange/active-directory/Get-AdSiteLink.md deleted file mode 100644 index 8a3cbbb8cb..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-AdSiteLink.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AdSiteLink -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdSiteLink [[-Identity] <AdSiteLinkIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ADSiteLink -``` - -This example returns a list of all IP site links in your organization. - -### -------------------------- Example 2 -------------------------- -``` -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. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7c6fe606-358c-4e61-8c13-c4e951548064.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-DomainController.md b/exchange/exchange-ps/exchange/active-directory/Get-DomainController.md deleted file mode 100644 index 0146ef9514..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-DomainController.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DomainController -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-DomainController - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-DomainController cmdlet to view a list of domain controllers that exist in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### GlobalCatalog -``` -Get-DomainController [-GlobalCatalog] [-Forest <Fqdn>] - [-Credential <NetworkCredential>] [<CommonParameters>] -``` - -### DomainController -``` -Get-DomainController [-DomainName <Fqdn>] - [-Credential <NetworkCredential>] [<CommonParameters>] -``` - -## DESCRIPTION - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$UserCredentials = Get-Credential; Get-DomainController -DomainName corp.contoso.com -Credential $UserCredentials | Format-Table -AutoSize Name, ADSite -``` - -This example retrieves a list of global catalog servers in the corp.contoso.com domain. Because a different set of credentials are required to access this domain, the Get-Credential cmdlet is used to obtain the user name and password from the user. - -The first command displays a prompt to the user that accepts the user name and password. The credentials are then stored in the $UserCredentials variable. The second command uses the $UserCredentials variable for the Credential parameter value. To make the list more readable, the output is piped to the Format-Table cmdlet and only the Name and ADSite properties are displayed. - -For more information about pipelining and the Format-Table cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -## PARAMETERS - -### -GlobalCatalog -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -If you use the Forest parameter, the credentials are used to access the forest. - -```yaml -Type: NetworkCredential -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 -``` - -### -DomainName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c90cec1b-4aa4-4f94-b547-05af263417f1.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-Trust.md b/exchange/exchange-ps/exchange/active-directory/Get-Trust.md deleted file mode 100644 index 8d82125824..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-Trust.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Trust -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-Trust - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-Trust cmdlet to return external and forest trusts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-Trust [-DomainName <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Trust -DomainName Contoso.com -``` - -This example enumerates all trusts for the domain Contoso.com. - -## PARAMETERS - -### -DomainName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3261c1bd-bb8b-479d-af4d-48fee7b4b357.aspx) diff --git a/exchange/exchange-ps/exchange/active-directory/Get-UserPrincipalNamesSuffix.md b/exchange/exchange-ps/exchange/active-directory/Get-UserPrincipalNamesSuffix.md deleted file mode 100644 index 37333951d6..0000000000 --- a/exchange/exchange-ps/exchange/active-directory/Get-UserPrincipalNamesSuffix.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UserPrincipalNamesSuffix -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-UserPrincipalNamesSuffix - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-UserPrincipalNamesSuffix cmdlet to view the user principal name (UPN) suffixes in the Active Directory forest. The UPN suffixes are created in Active Directory Domains and Trusts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UserPrincipalNamesSuffix [-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -UPN suffixes assigned to an organizational unit are stored in the upnSuffixes attribute in the Organizational Unit object. - -The default UPN is contained in the Canonical Name attribute on the Partitions container object in the configuration naming context. The default UPN suffix identifies the domain in which the user account is contained. When you create a user account in Active Directory, the default UPN suffix is the DNS name of the first domain in your domain tree. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UserPrincipalNamesSuffix -``` - -This example returns all UPN suffixes for the Active Directory forest. - -## PARAMETERS - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ExtendedOrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7d7ce148-4924-49e9-a57d-06bdc2d9f365.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-AntiPhishRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-AntiPhishRule.md deleted file mode 100644 index dad92e86b5..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-AntiPhishRule.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Disable-AntiPhishRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Disable-AntiPhishRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Disable-AntiPhishRule cmdlet to disable enabled antiphishing rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-AntiPhishRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-AntiPhishRule -Identity "Engineering Department Phishing Rule" -``` - -This example disables the antiphishing rule named Engineering Department Phishing Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/679dceee-3fa7-4ef4-8176-46cf7e6d6d7f.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md deleted file mode 100644 index 7e893f09f3..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Disable-SafeAttachmentRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Disable-SafeAttachmentRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Disable-SafeAttachmentRule cmdlet to disable enabled Safe Attachments rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-SafeAttachmentRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-SafeAttachmentRule -Identity "Engineering Department Attachment Rule" -``` - -This example disables the Safe Attachments rule named Engineering Department Attachment Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the enabled Safe Attachments rule that you want to disable. - -You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d57d90fa-1e81-4c67-85a5-77b9ae58802f.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-SafeLinksRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-SafeLinksRule.md deleted file mode 100644 index 2b12e2b73d..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Disable-SafeLinksRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Disable-SafeLinksRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Disable-SafeLinksRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Disable-SafeLinksRule cmdlet to disable enabled Safe Links rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-SafeLinksRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-SafeLinksRule -Identity "Engineering Department URL Rule" -``` - -This example disables the enabled Safe Links rule named Engineering Department URL Rule. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fd956828-b97e-466b-81c2-6121c9c9e9d3.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-AntiPhishRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-AntiPhishRule.md deleted file mode 100644 index 5f2763a966..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-AntiPhishRule.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Enable-AntiPhishRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Enable-AntiPhishRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Enable-AntiPhishRule cmdlet to enable disabled antiphishing rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-AntiPhishRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-AntiPhishRule -Identity "Marketing Department Phishing Rule" -``` - -This example enables the antiphishing rule named Marketing Department Phishing Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/5579e1ca-ed86-4bd6-8043-23bd405ccb1a.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md deleted file mode 100644 index 2b22f93c7e..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Enable-SafeAttachmentRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Enable-SafeAttachmentRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Enable-SafeAttachmentRule cmdlet to enable disabled Safe Attachments rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-SafeAttachmentRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-SafeAttachmentRule -Identity "Marketing Department Attachment Rule" -``` - -This example enables the disabled Safe Attachments rule named Marketing Department Attachment Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the disabled Safe Attachments rule that you want to enable. - -You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b77adca3-5240-40dc-9e7e-7e5b6f2058f5.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-SafeLinksRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-SafeLinksRule.md deleted file mode 100644 index 43b31623cb..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Enable-SafeLinksRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Enable-SafeLinksRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Enable-SafeLinksRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Enable-SafeLinksRule cmdlet to enable disabled Safe Links rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-SafeLinksRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-SafeLinksRule -Identity "Marketing Department URL Rule" -``` - -This example enables the disabled Safe Links rule named Marketing Department URL Rule. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/31461bc5-4da9-4f5f-b6ef-4b16aa65e8c4.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md deleted file mode 100644 index bf374d3428..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-AdvancedThreatProtectionDocumentDetail -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-AdvancedThreatProtectionDocumentDetail - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. Use the Get-AdvancedThreatProtectionDocumentDetailReport cmdlet to view the results of Office 365 Advanced Threat Protection (ATP) actions for files in SharePoint Online, OneDrive for Business and Microsoft Teams in your cloud-based organization. For more information about this feature, see article at: https://go.microsoft.com/fwlink/?linkid=857638 - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdvancedThreatProtectionDocumentDetail [-Action <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Organization <OrganizationIdParameter>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -For the reporting period and organization you specify, the cmdlet returns the following information: - -- Action - -- Document Id - -- Domain - -- Event Type - -- File Hash - -- File Name - -- File Path - -- Size - -- Timestamp - -- Workload - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdvancedThreatProtectionTrafficDetail -Organization contoso.com -StartDate "4/26/2016" -EndDate "4/28/2016" | Format-Table -``` - -This example returns the detailed report of ATP detections during the specified date range. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - -- Allow - -- BlockAccess - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. The event type you specify must correspond to the report. For example, you can only specify "Anti-malware engine" or "Advanced Threat Protection" events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -The Organization parameter specifies the organization for which the report is being presented. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/advanced-threat-protection/get-advancedthreatprotectiondocumentdetail) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md deleted file mode 100644 index 330471e0d7..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-AdvancedThreatProtectionDocumentReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-AdvancedThreatProtectionDocumentReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AdvancedThreatProtectionDocumentReport cmdlet to view the results of Office 365 Advanced Threat Protection (ATP) actions for files in SharePoint Online, OneDrive for Business and Microsoft Teams in your cloud-based organization. For more information about this feature, see article at: https://go.microsoft.com/fwlink/?linkid=857638 - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdvancedThreatProtectionDocumentReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] [-Organization <OrganizationIdParameter>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -For the reporting period and organization you specify, the cmdlet returns the following information: - - -- Action - -- Count - -- Date - -- Domain - -- Event Type - -- Workload - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdvancedThreatProtectionTrafficReport -Organization contoso.com -StartDate "4/26/2018" -EndDate "4/28/2018" | Format-Table -``` - -This example returns the aggregated report of ATP detections for the specified organization during the specified date range. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - -- Allow - -- BlockAccess - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format which is defined in the Regional Options settings on the computer where you are running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. The event type you specify must correspond to the report. For example, you can only specify "Anti-malware engine" or "Advanced Threat Protection" events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -The Organization parameter specifies the organization for which the report is being presented. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format which is defined in the Regional Options settings on the computer where you are running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/advanced-threat-protection/get-advancedthreatprotectiondocumentreport) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md deleted file mode 100644 index d6042386f4..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-AdvancedThreatProtectionTrafficReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-AdvancedThreatProtectionTrafficReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AdvancedThreatProtectionTrafficReport cmdlet to view the results of Safe Attachments and Safe Links actions in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdvancedThreatProtectionTrafficReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-Direction <MultiValuedProperty>] [-DisplayBy <String>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-MalwareName <MultiValuedProperty>] - [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - -For the reporting period you specify, the cmdlet returns the following information: - -- Domain - -- Date - -- Event Type - -- MalwareName - -- Action - -- Message Count - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdvancedThreatProtectionTrafficReport -StartDate "4/26/2016" -EndDate "4/28/2016" | Format-Table -``` - -This example returns the results of Safe Attachments and Safe Links actions during the specified date range. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - -- Allow - -- AllowRedirect - -- BlockAccess - -- BlockRedirect - -- BypassMessage - -- BypassMessageSystem - -- ContentReplaced - -- InfectedAllowed - -- ReplaceRedirect - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayBy -The DisplayBy parameter specifies how the information in the report is organized. Valid values are: - -- Action (This is the default value) - -- MalwareName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MalwareName -The MalwareName parameter filters the results by malware payload. Valid values are: - -- Excel - -- EXE - -- Flash - -- Others - -- PDF - -- PowerPoint - -- URL - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/57611e70-ed1e-46e1-8750-8c20ecf605f7.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md deleted file mode 100644 index 5115cf8e62..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-AntiPhishPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-AntiPhishPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AntiPhishPolicy cmdlet to view antiphishing policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AntiPhishPolicy [-Identity <AntiPhishPolicyIdParameter>] [-Advanced] [-Impersonation] [-Spoof] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AntiPhishPolicy -``` - -This example shows a summary list of all antiphish policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-AntiPhishPolicy -Identity Default | Format-List -``` - -This example shows detailed information about the antiphish policy named Default. - -## PARAMETERS - -### -Advanced -The Advanced switch filters the results by advanced antiphishing policies. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the antiphishing policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AntiPhishPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Impersonation -The Impersonation switch filters the results by impersonation antiphishing policies. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Spoof -The Spoof switch filters the results by spoof antiphishing policies. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/b4aa4010-5c31-4a84-8465-9c9507f38715.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AntiPhishRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AntiPhishRule.md deleted file mode 100644 index 27b4f3ef8e..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AntiPhishRule.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-AntiPhishRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-AntiPhishRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AntiPhishRule cmdlet to view antiphishing rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AntiPhishRule [[-Identity] <RuleIdParameter>] [-State <Enabled | Disabled>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AntiPhishRule -``` - -This example returns a summary list of all antiphishing rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-AntiPhishRule -Identity "Research Department Phishing Rule" | Format-List -``` - -This example returns detailed information about the antiphishing rule named Research Department Phishing Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/c546e813-d7d2-45d6-bb35-839d16e1f7ee.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md deleted file mode 100644 index 3911774ed5..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-AtpPolicyForO365 -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-AtpPolicyForO365 - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AtpPolicyForO365 cmdlet to view the Advanced Threat Protection (ATP) policy in Office 365. The ATP policy enables the following protections: - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AtpPolicyForO365 [[-Identity] <AtpPolicyForO365IdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. For more information, see ATP safe links in Office 365 (https://go.microsoft.com/fwlink/p/?linkid=846016). - -ATP can also protect files in SharePoint Online, OneDrive for Business and Microsoft Teams by preventing users from opening and downloading files that are identified as malicious. For more information, see Office 365 Advanced Threat Protection for SharePoint, OneDrive and Teams (https://go.microsoft.com/fwlink/p/?linkid=857638). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AtpPolicyForO365 -``` - -This example returns detailed information about the ATP policy named Default - -## PARAMETERS - -### -Identity -The Identity parameter specifies the ATP policy that you want to modify. There's only one policy named Default. - -```yaml -Type: AtpPolicyForO365IdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4649aa3a-e49d-42ba-84e8-ef2871fa2b58.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailDetailATPReport.md deleted file mode 100644 index 0064250a54..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailDetailATPReport.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailATPReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailDetailATPReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailDetailATPReport cmdlet to list details about Exchange Online Protection and Advanced Threat protection (ATP) detections in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailDetailATPReport [-Direction <MultiValuedProperty>] - [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] - [-Expression <Expression>] [-MalwareName <MultiValuedProperty>] [-MessageId <MultiValuedProperty>] - [-MessageTraceId <MultiValuedProperty>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] - [-RecipientAddress <MultiValuedProperty>] [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] - [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailDetailATPReport -StartDate 7/1/2018 -EndDate 7/31/2018 -``` - -This example returns the Advanced Threat Protection actions for July, 2018. - -## PARAMETERS - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- Advanced phish filter\* - -- Anti-malware engine - -- ATP safe attachments\* - -- ATP safe links\* - -- Anti-spoof: Intra-org - -- Anti-spoof: external domain\* - -- Domain impersonation\* - -- General phish filter - -- Malicious URL reputation - -- URL detonation\* - -- Message passed - -- Phish ZAP - -- User impersonation\* - -- Brand impersonation - -- ZAP - -\* These features require a standalone Office 365 ATP or E5 subscription. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MalwareName -The MalwareName parameter filters the results by malware payload. Valid values are: - -- Excel - -- EXE - -- Flash - -- Others - -- PDF - -- PowerPoint - -- URL - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/52658220-2d64-4d55-a679-fbbfd6f0c8a0.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md deleted file mode 100644 index f1191efbc5..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficATPReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailTrafficATPReport - -## 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 Advanced Threat Protection (ATP) detections in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailTrafficATPReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-Direction <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] - [-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - -For the reporting period you specify, the cmdlet returns the following information: - -- Domain - -- Date - -- Event Type - -- Direction - -- Action - -- Message Count - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailTrafficATPReport -Direction Inbound -StartDate 06/13/2018 -EndDate 06/15/2018 -``` - -This example retrieves details for incoming messages between June 13, 2018 and June 15, 2018. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailTrafficATPReport -StartDate 7/20/2018 -EndDate 7/20/2018 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example retrieves the statistics for outgoing messages on July 20, 2018 and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailTrafficATPReport -StartDate 7/20/2018 -EndDate 7/20/2018 -Direction Outbound -SummarizeBy Domain,EventType | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example is similar to the previous example, but now the results are summarized. Because EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced and values of MessageCount are correspondingly larger on each row. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- Advanced phish filter\* - -- Anti-malware engine - -- ATP safe attachments\* - -- ATP safe links\* - -- Anti-spoof: Intra-org - -- Anti-spoof: external domain\* - -- Domain impersonation\* - -- General phish filter - -- Malicious URL reputation - -- URL detonation\* - -- Message passed - -- Phish ZAP - -- User impersonation\* - -- Brand impersonation - -- ZAP - -\* These features require a standalone Office 365 ATP or E5 subscription. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -For the Get-MailTrafficATPReport cmdlet, valid values are Action, Direction, Domain, and EventType. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cc9c2cd8-0629-4aa8-bc60-bbd8b0ae9c57.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md deleted file mode 100644 index a7d6313f11..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-PhishFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-PhishFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-PhishFilterPolicy cmdlet to view the phish filter policy and detected spoofed sending activities in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PhishFilterPolicy -Detailed -SpoofAllowBlockList [-SpoofType <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-PhishFilterPolicy cmdlet returns the following information: - -- Sender/sender domain: The true sending domain that's found in the DNS record of the source messaging server. If no domain is found, the source messaging server's IP address is shown. - -- SpoofedUser: The sending email address if the domain is one of your organization's domains, or the sending domain if the domain is external. - -- MailVolume: The number of messages. - -- UserComplaints: The number of user complaints. - -- Authentication: Indicates whether the message has passed any type of authentication (explicit or implicit). - -- Last seen: The date when the sending email address or domain was last seen by Office 365. - -- Decision set by: Specifies whether Office 365 set the spoofing policy as allowed or not allowed to spoof, or if it was set by an admin. - -- AllowedToSpoof: The three possible values are Yes (messages that contain any spoofed sender email addresses in your organization are allowed from the source messaging server), No (messages that contain any spoofed sender email addresses in your organization are not allowed from the source messaging server), and Partial (messages that contain some spoofed sender email addresses in your organization are allowed from the source messaging server. - -- Spoof Type: Indicates whether the domain is internal to your organization or external. - -For more information about spoof intelligence, see Learn more about spoof intelligence (https://go.microsoft.com/fwlink/p/?linkid=869584). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PhishFilterPolicy -Detailed -SpoofAllowBlockList -SpoofType Internal - -``` - -This example returns a detailed list of senders that appear to be sending spoofed email to your organization. - -### -------------------------- Example 2 -------------------------- -``` -$file = "C:\My Documents\Summary Spoofed Internal Domains and Senders.csv"; Get-PhishFilterPolicy -Detailed -SpoofAllowBlockList -SpoofType Internal | Export-CSV $file -``` - -This example exports the list of spoofed senders to a CSV file. - -## PARAMETERS - -### -Detailed -The Detailed switch specifies whether to return 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 Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofAllowBlockList -The SpoofAllowBlockList switch specifies whether to return a summary view of detected spoof activity. 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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofType -The SpoofType parameter filters the results by the type of spoofing. Valid values are: - -- Internal - -- External - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d3ef544f-de92-4563-8603-3990b8939453.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md deleted file mode 100644 index 5c53069816..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-SafeAttachmentPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-SafeAttachmentPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SafeAttachmentPolicy cmdlet to view Safe Attachments policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SafeAttachmentPolicy [[-Identity] <SafeAttachmentPolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SafeAttachmentPolicy -``` - -This example shows a summary list of all Safe Attachments policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-SafeAttachmentPolicy -Identity Default | Format-List -``` - -This example shows detailed information about the Safe Attachments policy named Default. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Attachments policy that you want to view. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: SafeAttachmentPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/00b066b5-2066-4525-b368-d8b1815990b4.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md deleted file mode 100644 index 715e7405a6..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-SafeAttachmentRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-SafeAttachmentRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SafeAttachmentRule cmdlet to view Safe Attachments rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SafeAttachmentRule [[-Identity] <RuleIdParameter>] [-State <Enabled | Disabled>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SafeAttachmentRule -``` - -This example returns a summary list of all Safe Attachments rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-SafeAttachmentRule -Identity "Research Department Attachment Rule" | Format-List -``` - -This example returns detailed information about the Safe Attachments rule named Research Department Attachment Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Attachments rule that you want to view. - -You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -State -The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1e9ffcca-ad71-404a-8344-0c38b5cd0d34.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md deleted file mode 100644 index 95acc642b7..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-SafeLinksPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-SafeLinksPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SafeLinksPolicy cmdlet to view Safe Links policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SafeLinksPolicy [[-Identity] <SafeLinksPolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SafeLinksPolicy | Format-Table Name,IsEnabled,IsDefault -``` - -This example shows a summary list of all Safe Links policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-SafeLinksPolicy -Identity Default -``` - -This example shows detailed information about the Safe Links policy named Default. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: SafeLinksPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d847809d-bdad-4d3b-b62e-be67411a6372.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeLinksRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeLinksRule.md deleted file mode 100644 index d9dd9e5745..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SafeLinksRule.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-SafeLinksRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-SafeLinksRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SafeLinksRule cmdlet to view Safe Links rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SafeLinksRule [[-Identity] <RuleIdParameter>] [-State <Enabled | Disabled>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SafeLinksRule | Format-Table -Auto Name,State,Priority,SafeLinksPolicy,Comments -``` - -This example returns a summary list of all Safe Links rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-SafeLinksRule -Identity "Research Department URL Rule" -``` - -This example returns detailed information about the Safe Links rule named Research Department URL Rule. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -State -The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/57bed861-31c9-428d-bbd7-165ce7743ae6.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SpoofMailReport.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SpoofMailReport.md deleted file mode 100644 index 04ec067d99..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-SpoofMailReport.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-SpoofMailReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-SpoofMailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SpoofMailReport cmdlet to view information about insider spoofing in your cloud-based organization. Insider spoofing is where the sender's email address in an inbound message appears to represent your organization, but the actual identity of the sender is different. Insider spoofing is a common tactic that's used in phishing messages to obtain user credentials or steal money. - -This cmdlet is only available in Office 365 Enterprise E5, or with Advanced Threat Protection licenses. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SpoofMailReport [-Action <MultiValuedProperty>] [-Direction <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] - [-ProbeTag <String>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The spoof mail report is a feature in Advanced Threat Protection that you can use to query information about insider spoofing detections in the last 30 days. For the reporting period you specify, the Get-SpoofMailReport cmdlet returns the following information: - -- Date: Date the message was sent. - -- Event Type: Typically, this value is SpoofMail. - -- Direction: This value is Inbound. - -- Domain: The sender domain. This corresponds to one of your organization's accepted domains. - -- Action: Typically, this value is GoodMail or CaughtAsSpam. - -- Spoofed Sender: The spoofed email address or domain in your organization from which the messages appear to be coming. - -- 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. - -- Sender IP: The IP address or address range of the source messaging server. If the sending IP address does have a PTR record, this field will be blank and the True Sender column will be filled in. Both columns will not be filled in at the same time. - -- Count: The number of spoofed messages that were sent to your organization from the source messaging server during the specified time period. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SpoofMailReport -StartDate 03/01/2016 -EndDate 03/31/2016 -``` - -This example shows the insider spoofing detections in your organization during the month of March 2016. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -Common values for this report are GoodMail and CaughtAsSpam. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -The common value for this report is SpoofMail. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bda4c4d6-d28d-4741-a13b-63c95e183340.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-UrlTrace.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Get-UrlTrace.md deleted file mode 100644 index 7ca4be5cd5..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Get-UrlTrace.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-UrlTrace -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-UrlTrace - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-UrlTrace cmdlet to view the results of Safe Links actions in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UrlTrace [-ClickId <Guid>] [-EndDate <DateTime>] [-Expression <Expression>] [-Page <Int32>] - [-PageSize <Int32>] [-RecipientAddress <MultiValuedProperty>] [-StartDate <DateTime>] - [-UrlOrDomain <MultiValuedProperty>] [-Workloads <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UrlTrace -RecipientAddress "michelle@contoso.com" -StartDate "5/9/2016" -EndDate "5/11/2016" -``` - -This example returns the results of Safe Links actions during the specified time period for the user michelle@contoso.com. - -## PARAMETERS - -### -ClickId -The ClickId parameter filters the results by the ClickId GUID value. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -UrlOrDomain -The UrlOrDomain parameter filters the results by the specified URL or domain value. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Workloads -The Workloads parameter filters the results by the specified workload. Valid values are: - -- Mail - -- OfficeClient - -- Other - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/979c93e6-e3f3-44eb-b4ce-663718c19f2b.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/New-AntiPhishPolicy.md deleted file mode 100644 index 9ff9691970..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/New-AntiPhishPolicy.md +++ /dev/null @@ -1,581 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-AntiPhishPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-AntiPhishPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-AntiPhishPolicy cmdlet to create antiphishing policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AntiPhishPolicy -Name <String> [-AdminDisplayName <String>] [-AuthenticationFailAction <MoveToJmf | Quarantine>] [-Confirm] [-EnableAntispoofEnforcement <$true | $false>] [-EnableAuthenticationSafetyTip <$true | $false>] [-EnableAuthenticationSoftPassSafetyTip <$true | $false>] [-Enabled <$true | $false>] [-EnableMailboxIntelligence <$true | $false>] [-EnableOrganizationDomainsProtection <$true | $false>] [-EnableSimilarDomainsSafetyTips <$true | $false>] [-EnableSimilarUsersSafetyTips <$true | $false>] [-EnableTargetedDomainsProtection <$true | $false>] [-EnableTargetedUserProtection <$true | $false>] [-EnableUnusualCharactersSafetyTips <$true | $false>] [-ExcludedDomains <MultiValuedProperty>] [-ExcludedSenders <MultiValuedProperty>] [-PhishThresholdLevel <Int32>] [-TargetedDomainActionRecipients <MultiValuedProperty>] [-TargetedDomainProtectionAction <NoAction | MoveToJmf | Redirect | Quarantine | Delete | BccMessage>] [-TargetedDomainsToProtect <MultiValuedProperty>] [-TargetedUserActionRecipients <MultiValuedProperty>] [-TargetedUserProtectionAction <NoAction | MoveToJmf | Redirect | Quarantine | Delete | BccMessage>] [-TargetedUsersToProtect <MultiValuedProperty>] [-TreatSoftPassAsAuthenticated <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Phishing messages contain fraudulent links or spoofed domains in an effort to get personal information from the recipients. - -New antiphishing policies aren't valid and aren't applied until you add an antiphishing rule to the policy by using the New-AntiPhishRule 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AntiPhishPolicy -Name "Monitor Policy" -AdminDisplayName "Default monitoring policy" -Enabled $true -EnableOrganizationDomainsProtection $true -EnableTargetedDomainsProtection $true -TargetedDomainsToProtect fabrikam.com -TargetedUsersToProtect "Mai Fujito;mfujito@fabrikam.com" -EnableMailboxIntelligence $true -EnableSimilarUsersSafetyTips $false -EnableSimilarDomainsSafetyTips $false -TargetedDomainProtectionAction BccMessage -TargetedUserProtectionAction BccMessage -EnableTargetedUserProtection $true -TargetedDomainActionRecipients reviewer@contoso.com -TargetedUserActionRecipients reviewer@contoso.com -``` - -This example creates and enables an antiphishing policy named Monitor Policy with the following settings: -- Admin display name: Default monitoring policy - -- Enables organization domains protection for all accepted domains, and targeted domains protection for the domain fabrikam.com. - -- Specifies Mai Fujito (mfujito@fabrikam.com) as the user to protect from impersonation. - -- Enables mailbox intelligence. - -- Disables safety tips and set the notification actions to Bcc the email address reviewer@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -New-AntiPhishPolicy -Name "Test Policy" -EnableTargetedDomainsProtection $true -AdminDisplayName "Default policy for all users" -Enabled $true -EnableOrganizationDomainsProtection $true -TargetedDomainsToProtect fabrikam.com -EnableTargetedUserProtection $true -TargetedUsersToProtect "Rick Hoferrhofer@fabrikam.com" -EnableMailboxIntelligence $true -EnableSimilarUsersSafetyTips $true -EnableSimilarDomainsSafetyTips $true -TargetedDomainProtectionAction Quarantine -TargetedUserProtectionAction Quarantine -``` - -This example creates and enables an antiphishing policy named Test Policy with the following settings: - -- Admin display name: Default policy for all users - -- Enables organization domains protection for all accepted domains, and targeted domains protection for the domain fabrikam.com. - -- Specifies Rick Hofer (rhofer@fabrikam.com) as the user to protect from impersonation. - -- Enables mailbox intelligence. - -- Enables safety tips and set the notification actions to quarantine messages. - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for the antiphishing policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationFailAction -The AuthenticationFailAction parameter specifies the action to take when the message fails composite authentication. Valid values are: - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value. - -- Quarantine: Move the message to the phishing quarantine. - -```yaml -Type: Delete | MoveToJmf | Quarantine -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAntispoofEnforcement -The EnableAntispoofEnforcement parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: - -- $true: Antispoofing is enabled for the policy. This is the default value, and is recommended. - -- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAuthenticationSafetyTip -The EnableAuthenticationSafetyTip parameter specifies whether to enable safety tips that are shown to recipients when a message fails composite authentication. Valid values are: - -- $true: Safety tips are enabled for messages that fail composite authentication. This is the default value, and we strongly recommend that you don't change it. - -- $false: Safety tips are disabled for messages that fail composite authentication. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAuthenticationSoftPassSafetyTip -The EnableAuthenticationSoftPassSafetyTip parameter specifies whether to enable safety tips that are shown to recipients when a message fails composite authentication with low to medium confidence. Valid values are: - -- $true: Safety tips are enabled for messages that fail composite authentication with low to medium confidence. If you use this value, you might want to restrict the policy to a smaller number of users to avoid displaying too many of these types of safety tips to users. - -- $false: Safety tips are disabled for messages that fail composite authentication with low to medium confidence. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableMailboxIntelligence -The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (the first contact graph) in domain and user impersonation protection. Valid values are: - -- $true: Use mailbox intelligence in domain and user impersonation protection. - -- $false: Don't use mailbox intelligence in domain and user impersonation protection. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableOrganizationDomainsProtection -The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Office 365 organization. Valid values are: - -- $true: Domain impersonation protection is enabled for all registered domains in the Office 365 organization. - -- $false: Domain impersonation protection isn't enabled for all registered domains in the Office 365 organization. This is the default value. You can enable domain impersonation protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSimilarDomainsSafetyTips -The EnableSimilarDomainsSafetyTips parameter specifies whether to enable safety tips that are shown to recipients in messages 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSimilarUsersSafetyTips -The EnableSimilarUsersSafetyTips parameter specifies whether to enable safety tips that are shown to recipients in messages 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTargetedDomainsProtection -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTargetedUserProtection -The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for the users specified by the TargetedUsersToProtect parameter. Valid values are: - -- $true: User impersonation protection is enabled for the specified users. - -- $false: The TargetedUsersToProtect parameter isn't used. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUnusualCharactersSafetyTips -The EnableUnusualCharactersSafetyTips parameter specifies whether to enable safety tips that are shown to recipients in messages 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedDomains -The ExcludedDomains parameter specifies trusted domains that are excluded from scanning by antiphishing protection. You can specify multiple domains separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedSenders -The ExcludedSenders parameter specifies a list of trusted sender email addresses that are excluded from scanning by antiphishing protection. You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhishThresholdLevel -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) - -- 2: Aggressive - -- 3: More aggressive - -- 4: Most aggressive - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedDomainActionRecipients -The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. - -A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedDomainProtectionAction -The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages for the domains specified by the TargetedDomainsToProtect parameter. Valid values are: - -- NoAction (This is the default value) - -- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- MoveToJmf: Move the message to the user's Junk Email folder. - -- Quarantine: Move the message to the phishing quarantine. - -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Accepted values: NoAction, MoveToJmf, Redirect, Quarantine, Delete, BccMessage -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedDomainsToProtect -The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. - -You can specify multiple domains separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedUserActionRecipients -The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. - -A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedUserProtectionAction -The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages for the users specified by the TargetedUsersToProtect parameter. Valid values are: - -- NoAction (This is the default value) - -- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- MoveToJmf: Move the message to the user's Junk Email folder. - -- Quarantine: Move the message to the phishing quarantine. - -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Accepted values: NoAction, MoveToJmf, Redirect, Quarantine, Delete, BccMessage -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedUsersToProtect -TThe TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. - -This parameter uses the syntax "DisplayName;EmailAddress". - -- DisplayName specifies the display name of the user that could be a target of impersonation. This value can contain special characters. - -- EmailAddress specifies the internal or external email address that's associated with the display name. - -- You can specify multiple value sets by using the syntax: "DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN". The combination of DisplayName and EmailAddress needs to be unique for each value set. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatSoftPassAsAuthenticated -The TreatSoftPassAsAuthenticated parameter specifies whether or not to respect the composite authentication softpass result. Valid values are: - -- $true: This is the default value. - -- $false: Only use this value when you want to enable more restrictive antispoofing filtering, because this value might cause false positives. - -Note: This parameter corresponds to the Strict filtering value in the Office 365 admin center. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b80f94e3-9b8c-45b1-b48e-68438742255c.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/New-AntiPhishRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/New-AntiPhishRule.md deleted file mode 100644 index a40556b8bd..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/New-AntiPhishRule.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-AntiPhishRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-AntiPhishRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-AntiPhishRule cmdlet to view antiphishing rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AntiPhishRule [-Name] <String> -AntiPhishPolicy <String> [-Comments <String>] [-Confirm] - [-Enabled <$true | $false>] [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] - [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-Priority <Int32>] [-RecipientDomainIs <Word[]>] - [-SentTo <RecipientIdParameter[]>] [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to add the antiphishing rule to an existing policy by using the AntiPhishPolicy parameter. You create antiphishing policies by using the New-AntiPhishPolicy cmdlet. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AntiPhishRule -Name "Research Department Phishing Rule" -AntiPhishPolicy "Research Quarantine" -SentToMemberOf "Research Department" -ExceptIfSentToMemberOf "Research Department Managers" -``` - -This example creates an antiphishing rule named Research Department Phishing Rule with the following conditions: - -- The rule is associated with the antiphishing policy named Research Quarantine. - -- The rule applies to members of the group named Research Department. - -- The rule doesn't apply to members of the group named Research Department Managers. - -## PARAMETERS - -### -AntiPhishPolicy -The AntiPhishPolicy parameter specifies the antiphishing policy that's associated with the antiphishing rule. The rule defines the conditions, and the policy defines the actions. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the antiphishing 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -Note: -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -Note: -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/cee3f810-9895-420f-b22f-f8937d8b60df.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md deleted file mode 100644 index 9519fde13d..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-SafeAttachmentPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-SafeAttachmentPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-SafeAttachmentPolicy cmdlet to create Safe Attachments policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SafeAttachmentPolicy [-Name] <String> [-Action <Block | Replace | Allow | DynamicDelivery>] - [-ActionOnError <$true | $false>] [-AdminDisplayName <String>] [-Confirm] [-Enable <$true | $false>] - [-Redirect <$true | $false>] [-RedirectAddress <SmtpAddress>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -New Safe Attachments policies aren't valid and aren't applied until you add a Safe Attachments rule to the policy by using the New-SafeAttachmentRule cmdlet. - -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SafeAttachmentPolicy -Name "Marketing Block Attachments" -Enable $true -Redirect $true -RedirectAddress admin@contoso.com -``` - -This example creates a new Safe Attachments policy named Marketing Block Attachments with the following options: - -- The policy is enabled. - -- The action is Block. This is the default value of the Action parameter, so you don't need to specify it. - -- If Safe Attachments scanning isn't available or encounters errors, deliver the message as normal. The default value of the ActionOnError parameter is $false, so you don't need to specify it. - -- Redirect detected malware messages to admin@contoso.com. - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for the Safe Attachments 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: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Action -The Action parameter specifies the action for the Safe Attachments policy. Valid values are: - -- Allow: Deliver the email message, including the malware attachment. - -- Block: Block the email message that contains the malware attachment. This is the default value. - -- Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. - -The results of all actions are available in message trace. - -```yaml -Type: Block | Replace | Allow | DynamicDelivery -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActionOnError -The ActionOnError parameter specifies the error handling option for Safe Attachments scanning (what to do if scanning times out or an error occurs). Valid values are: - -- $true: The action specified by the Action parameter is applied to messages even when the attachments aren't successfully scanned. - -- $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Redirect -The Redirect parameter specifies whether to send detected malware attachments to another email address. Valid values are: - -- $true: Malware attachments are sent to the email address specified by the RedirectAddress parameter. - -- $false: Malware attachments aren't sent to another email address. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectAddress -The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ef3b8cad-176b-485f-833d-73cba4cfa3f3.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeAttachmentRule.md deleted file mode 100644 index d1215a8192..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeAttachmentRule.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-SafeAttachmentRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-SafeAttachmentRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-SafeAttachmentRule cmdlet to create Safe Attachments rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SafeAttachmentRule [-Name] <String> -SafeAttachmentPolicy <SafeAttachmentPolicyIdParameter> - [-Comments <String>] [-Confirm] [-Enabled <$true | $false>] [-ExceptIfRecipientDomainIs <Word[]>] - [-ExceptIfSentTo <RecipientIdParameter[]>] [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] - [-Priority <Int32>] [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] - [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to specify at least one condition for the rule. - -You need to add the Safe Attachments rule to an existing policy by using the SafeAttachmentPolicy parameter. You create Safe Attachments policies by using the New-SafeAttachmentPolicy cmdlet. - -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SafeAttachmentRule -Name "Research Department Attachment Rule" -SafeAttachmentPolicy "Research Block Attachments" -SentToMemberOf "Research Department" -ExceptIfSentToMemberOf "Research Department Managers" -``` - -This example creates a new Safe Attachments rule named Research Department Attachment Rule with the following conditions: - -- The rule is associated with the Safe Attachments policy named Research Block Attachments. - -- The rule applies to members of the group named Research Department. - -- The rule doesn't apply to members of the group named Research Department Managers. - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for the Safe Attachments 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: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeAttachmentPolicy -The SafeAttachmentPolicy parameter specifies the Safe Attachments policy that's associated with this Safe Attachments rule. The rule defines the conditions, and the policy defines the actions. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -You can't specify a Safe Attachments policy that's already associated with another Safe Attachments rule. - -```yaml -Type: SafeAttachmentPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -The default value is $true. - -In the properties of the rule, the value of this parameter is visible in the State property. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/05e1f1c0-801b-4534-b138-3a0522f36a26.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeLinksPolicy.md deleted file mode 100644 index 3dfb5b77f6..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeLinksPolicy.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-SafeLinksPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-SafeLinksPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-SafeLinksPolicy cmdlet to create Safe Links policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SafeLinksPolicy [-Name] <String> [-AdminDisplayName <String>] [-AllowClickThrough <$true | $false>] - [-Confirm] [-DoNotAllowClickThrough <$true | $false>] [-DoNotRewriteUrls <MultiValuedProperty>] - [-DoNotTrackUserClicks <$true | $false>] [-Enabled <$true | $false>] - [-EnableForInternalSenders <$true | $false>] [-ExcludedUrls <String[]>] [-IsEnabled <$true | $false>] - [-ScanUrls <$true | $false>] [-TrackClicks <$true | $false>] [-WhatIf] [-WhiteListedUrls <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SafeLinksPolicy -Name "Marketing Block URL" -IsEnabled $true -TrackClicks $true -``` - -This example creates a new Safe Links policy named Marketing Block URL with the following options: - -- The policy is enabled. - -- Users aren't allowed to click through to the original URL. This is the default value of the AllowClickThrough parameter, so you don't need to specify it. - -- User clicks on URLs are tracked in URL trace. - -## PARAMETERS - -### -Name -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, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowClickThrough -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotAllowClickThrough -The DoNotAllowClickThrough parameter specifies whether to allow users to click through to the original URL. Valid values are: - -- $true: The user isn't allowed to click through to the original URL. This is the default value. - -- $false: The user is allowed to click through to the original URL. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotRewriteUrls -The DoNotRewriteUrls parameter specifies a URL that's skipped by Safe Links scanning. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotTrackUserClicks -The DoNotTrackUserClicks parameter specifies whether to track user clicks related to links in email messages. Valid values are: - -- $true: User clicks aren't tracked. This is the default value. - -- $false: User clicks are tracked. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -The default value is $false - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableForInternalSenders -PARAMVALUE: $true | $false - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedUrls -The ExcludedUrls parameter specifies a URL that's skipped by Safe Links scanning. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsEnabled -This parameter is reserved for internal Microsoft use.. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScanUrls -The ScanUrls parameter specifies whether to enable or disable the scanning of links in email messages. Valid values are: - -- $true: Scanning links in email messages is enabled. - -- $false: Scanning links in email messages is disabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrackClicks -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhiteListedUrls -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/663f218e-c19a-4e42-9861-b192255ea3eb.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeLinksRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeLinksRule.md deleted file mode 100644 index 0ace0797c6..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/New-SafeLinksRule.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-SafeLinksRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-SafeLinksRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SafeLinksRule [-Name] <String> -SafeLinksPolicy <SafeLinksPolicyIdParameter> [-Comments <String>] - [-Confirm] [-Enabled <$true | $false>] [-ExceptIfRecipientDomainIs <Word[]>] - [-ExceptIfSentTo <RecipientIdParameter[]>] [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] - [-Priority <Int32>] [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] - [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to specify at least one condition for the rule. - -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SafeLinksRule -Name "Research Department URL Rule" -SafeAttachmentPolicy "Research Block URL" -SentToMemberOf "Research Department" -ExceptIfSentToMemberOf "Research Department Managers" -``` - -This example creates a new Safe Links rule named Research Department URL Rule with the following conditions: - -- The rule is associated with the Safe Links policy named Research Block URL. - -- The rule applies to members of the group named Research Department. - -- The rule doesn't apply to members of the group named Research Department Managers. - -## PARAMETERS - -### -Name -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, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeLinksPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -You can't specify a Safe Links policy that's already associated with another Safe Links rule. - -```yaml -Type: SafeLinksPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -The default value is $true. - -In the properties of the rule, the value of this parameter is visible in the State property. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/47a06afc-98ed-4ed7-98f5-ca8f20ef58d9.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md deleted file mode 100644 index bcaf392fd0..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-AntiPhishPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-AntiPhishPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-AntiPhishPolicy cmdlet to remove antiphishing policies from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AntiPhishPolicy [-Identity] <AntiPhishPolicyIdParameter> [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AntiPhishPolicy -Identity "Quarantine Policy" -``` - -This example removes the antiphishing policy named Quarantine Policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AntiPhishPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/5d497eed-c33c-4280-a5fe-945546ab1492.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-AntiPhishRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-AntiPhishRule.md deleted file mode 100644 index b2e2e560ee..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-AntiPhishRule.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-AntiPhishRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-AntiPhishRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-AntiPhishRule cmdlet to remove antiphishing rules from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AntiPhishRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AntiPhishRule -Identity "Research Department Phishing Rule" -``` - -This examples removes the antiphishing rule named Research Department Phishing Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/c7ca44b1-c3a5-4699-aaf8-c1b07f85d4fa.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md deleted file mode 100644 index a36ec5b545..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-SafeAttachmentPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-SafeAttachmentPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-SafeAttachmentPolicy cmdlet to remove Safe Attachments policies from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SafeAttachmentPolicy [-Identity] <SafeAttachmentPolicyIdParameter> [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You can't remove the default Safe Attachments policy (the policy where the IsDefault property is True). - -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SafeAttachmentPolicy -Identity "Block Attachments Policy" -``` - -This example removes the Safe Attachments policy named Block Attachments Policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Attachments policy that you want to remove. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: SafeAttachmentPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0d3b131c-e80f-426b-9140-7e674ab2b1ad.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md deleted file mode 100644 index 5910070b52..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-SafeAttachmentRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-SafeAttachmentRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-SafeAttachmentRule cmdlet to remove Safe Attachments rules from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SafeAttachmentRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SafeAttachmentRule -Identity "Research Department Attachment Rule" -``` - -This examples removes the Safe Attachments rule named Research Department Attachment Rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Attachments rule that you want to remove. - -You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9fe610d6-969a-4369-aa9c-8a8ef5dfd9e3.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md deleted file mode 100644 index 9d90400837..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-SafeLinksPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-SafeLinksPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-SafeLinksPolicy cmdlet to remove Safe Links policies from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SafeLinksPolicy [-Identity] <SafeLinksPolicyIdParameter> [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You can't remove the default Safe Links policy (the policy where the IsDefault property is True). - -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SafeLinksPolicy -Identity "Engineering Department URL Policy" -``` - -This example remove the Safe Links policy named Engineering Department URL Policy. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: SafeLinksPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ecc2a770-8352-4600-aa0e-3757f61b5d76.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeLinksRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeLinksRule.md deleted file mode 100644 index 2650b357a1..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Remove-SafeLinksRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-SafeLinksRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-SafeLinksRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-SafeLinksRule cmdlet to remove Safe Links rules from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SafeLinksRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SafeLinksRule -Identity "Research Department URL Rule" -``` - -This examples removes the Safe Links rule named Research Department URL Rule. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/32bd0520-7f88-4622-8686-0425f1317ec1.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md deleted file mode 100644 index 053522db19..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md +++ /dev/null @@ -1,690 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-AntiPhishPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-AntiPhishPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-AntiPhishPolicy cmdlet to modify antiphishing policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AntiPhishPolicy -Identity <AntiPhishPolicyIdParameter> - [-AdminDisplayName <Basic | High>] - [-AntiSpoofEnforcementType <AntiSpoofEnforcementType>] - [-AuthenticationFailAction <MoveToJmf | Quarantine>] - [-Confirm] - [-EnableAntispoofEnforcement <$true | $false>] - [-EnableAuthenticationSafetyTip <$true | $false>] - [-EnableAuthenticationSoftPassSafetyTip <$true | $false>] - [-Enabled <$true | $false>] - [-EnableMailboxIntelligence <$true | $false>] - [-EnableMailboxIntelligenceProtection <$true | $false>] - [-EnableOrganizationDomainsProtection <$true | $false>] - [-EnableSimilarDomainsSafetyTips <$true | $false>] - [-EnableSimilarUsersSafetyTips <$true | $false>] - [-EnableSuspiciousSafetyTip <$true | $false>] - [-EnableTargetedDomainsProtection <$true | $false>] - [-EnableTargetedUserProtection <$true | $false>] - [-EnableUnusualCharactersSafetyTips <$true | $false>] - [-ExcludedDomains <MultiValuedProperty>] - [-ExcludedSenders <MultiValuedProperty>] - [-ImpersonationProtectionState <Default | Automatic | Manual | Off>] - [-MailboxIntelligenceProtectionAction <NoAction | MoveToJmf | Redirect | Quarantine | Delete | BccMessage>] - [-MailboxIntelligenceProtectionActionRecipients <MultiValuedProperty>] - [-MakeDefault] - [-PhishThresholdLevel <Int32>] - [-TargetedDomainActionRecipients <MultiValuedProperty>] - [-TargetedDomainProtectionAction <NoAction | MoveToJmf | Redirect | Quarantine | Delete | BccMessage>] - [-TargetedDomainsToProtect <MultiValuedProperty>] - [-TargetedUserActionRecipients <MultiValuedProperty>] - [-TargetedUserProtectionAction <NoAction | MoveToJmf | Redirect | Quarantine | Delete | BccMessage>] - [-TargetedUsersToProtect <MultiValuedProperty>] - [-TreatSoftPassAsAuthenticated <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AntiPhishPolicy -Identity "Contoso Antiphish" -TargetedDomainProtectionAction BccMessage -TargetedUserProtectionAction BccMessage -EnableTargetedUserProtection $true -TargetedDomainActionRecipients reviewer@contoso.com -TargetedUserActionRecipients reviewer@contoso.com -``` - -This example modifies the existing antiphishing policy named Contoso Antiphish by changing the notification action to Bcc, and specifies reviewer@contoso.com as the recipient of the messages. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing 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: AntiPhishPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiSpoofEnforcementType -{{Fill AntiSpoofEnforcementType Description}} - -```yaml -Type: Basic | High -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationFailAction -The AuthenticationFailAction parameter specifies the action to take when the message fails composite authentication. Valid values are: - -- Delete: Delete the message during filtering. Use caution with this value, because the deleted messages are not recoverable. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value. - -- Quarantine: Move the message to the phishing quarantine. - -```yaml -Type: Delete | MoveToJmf | Quarantine -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAntispoofEnforcement -The EnableAntispoofEnforcement parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: - -- $true: Antispoofing is enabled for the policy. This is the default value, and is recommended. - -- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAuthenticationSafetyTip -The EnableAuthenticationSafetyTip parameter specifies whether to enable safety tips that are shown to recipients when a message fails composite authentication. Valid values are: - -- $true: Safety tips are enabled for messages that fail composite authentication. This is the default value, and we strongly recommend that you don't change it. - -- $false: Safety tips are disabled for messages that fail composite authentication. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAuthenticationSoftPassSafetyTip -The EnableAuthenticationSoftPassSafetyTip parameter specifies whether to enable safety tips that are shown to recipients when a message fails composite authentication with low to medium confidence. Valid values are: - -- $true: Safety tips are enabled for messages that fail composite authentication with low to medium confidence. If you use this value, you might want to restrict the policy to a smaller number of users to avoid displaying too many of these types of safety tips to users. - -- $false: Safety tips are disabled for messages that fail composite authentication with low to medium confidence. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -```yaml -Type: -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -EnableMailboxIntelligence -The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (the first contact graph) in domain and user impersonation protection. Valid values are: - -- $true: Use mailbox intelligence in domain and user impersonation protection. This is the default value. - -- $false: Don't use mailbox intelligence in domain and user impersonation protection. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableMailboxIntelligenceProtection -{{Fill EnableMailboxIntelligenceProtection Description}} - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableOrganizationDomainsProtection -The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Office 365 organization. Valid values are: - -- $true: Domain impersonation protection is enabled for all registered domains in the Office 365 organization. - -- $false: Domain impersonation protection isn't enabled for all registered domains in the Office 365 organization. This is the default value. You can enable domain impersonation protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSimilarDomainsSafetyTips -The EnableSimilarDomainsSafetyTips parameter specifies whether to enable safety tips that are shown to recipients in messages 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSimilarUsersSafetyTips -The EnableSimilarUsersSafetyTips parameter specifies whether to enable safety tips that are shown to recipients in messages 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSuspiciousSafetyTip -{{Fill EnableSuspiciousSafetyTip Description}} - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTargetedDomainsProtection -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTargetedUserProtection -The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for the users specified by the TargetedUsersToProtect parameter. Valid values are: - -- $true: User impersonation protection is enabled for the specified users. - -- $false: The TargetedUsersToProtect parameter isn't used. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUnusualCharactersSafetyTips -The EnableUnusualCharactersSafetyTips parameter specifies whether to enable safety tips that are shown to recipients in messages 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedDomains -The ExcludedDomains parameter specifies trusted domains that are excluded from scanning by antiphishing protection. You can specify multiple domains separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedSenders -The ExcludedSenders parameter specifies a list of trusted sender email addresses that are excluded from scanning by antiphishing protection. You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImpersonationProtectionState -{{Fill ImpersonationProtectionState Description}} - -```yaml -Type: Default | Automatic | Manual | Off -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxIntelligenceProtectionAction -{{Fill MailboxIntelligenceProtectionAction Description}} - -```yaml -Type: NoAction | MoveToJmf | Redirect | Quarantine | Delete | BccMessage -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxIntelligenceProtectionActionRecipients -{{Fill MailboxIntelligenceProtectionActionRecipients Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeDefault -{{Fill MakeDefault Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhishThresholdLevel -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) - -- 2: Aggressive - -- 3: More aggressive - -- 4: Most aggressive - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedDomainActionRecipients -The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. - -A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedDomainProtectionAction -The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages for the domains specified by the TargetedDomainsToProtect parameter. Valid values are: - -- NoAction (This is the default value) - -- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- MoveToJmf: Move the message to the user's Junk Email folder. - -- Quarantine: Move the message to the phishing quarantine. - -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Accepted values: NoAction, MoveToJmf, Redirect, Quarantine, Delete, BccMessage -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedDomainsToProtect -The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. - -You can specify multiple domains separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedUserActionRecipients -The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. - -A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedUserProtectionAction -The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages for the users specified by the TargetedUsersToProtect parameter. Valid values are: - -- NoAction (This is the default value) - -- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- MoveToJmf: Move the message to the user's Junk Email folder. - -- Quarantine: Move the message to the phishing quarantine. - -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Accepted values: NoAction, MoveToJmf, Redirect, Quarantine, Delete, BccMessage -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetedUsersToProtect -The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. - -This parameter uses the syntax "DisplayName;EmailAddress". - -- DisplayName specifies the display name of the user that could be a target of impersonation. This value can contain special characters. - -- EmailAddress specifies the internal or external email address that's associated with the display name. - -- You can specify multiple value sets by using the syntax: "DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN". The combination of DisplayName and EmailAddress needs to be unique for each value set. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatSoftPassAsAuthenticated -The TreatSoftPassAsAuthenticated parameter specifies whether or not to respect the composite authentication softpass result. Valid values are: - -- $true: This is the default value. - -- $false: Only use this value when you want to enable more restrictive antispoofing filtering, because this value might cause false positives. - -Note: This parameter corresponds to the Strict filtering value in the Office 365 admin center. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bb2aca7b-69e9-4767-afaf-0b59f14a448a.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AntiPhishRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AntiPhishRule.md deleted file mode 100644 index 67015e1e17..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AntiPhishRule.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-AntiPhishRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-AntiPhishRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-AntiPhishRule cmdlet to modify antiphishing rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AntiPhishRule [-Identity] <RuleIdParameter> [-AntiPhishPolicy <AntiPhishPolicyIdParameter>] - [-Comments <String>] [-Confirm] [-ExceptIfRecipientDomainIs <Word[]>] - [-ExceptIfSentTo <RecipientIdParameter[]>] [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-Name <String>] - [-Priority <Int32>] [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] - [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AntiPhishRule -Identity "Engineering Department Phishing Rule" -ExceptIfRecipientDomainIs fabrikam.com -``` - -This example modifies the existing antiphishing rule named Engineering Department Phishing Rule to exclude messages sent to the fabrikam.com domain. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the antiphishing rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiPhishPolicy -The AntiPhishPolicy parameter specifies the antiphishing policy that's associated with the antiphishing rule. The rule defines the conditions, and the policy defines the actions. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AntiPhishPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the antiphishing 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -```yaml -Type: -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/b9bbb572-f8d9-4a3c-9471-19b91a07acba.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md deleted file mode 100644 index 1ac5f50a84..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-AtpPolicyForO365 -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-AtpPolicyForO365 - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-AtpPolicyForO365 cmdlet to modify the Advanced Threat Protection (ATP) policy in Office 365. The ATP policy enables the following protections: - -- Safe Links for Office 365 ProPlus desktop clients and Office Mobile apps. - -- ATP to protect files in SharePoint Online, OneDrive for Business and Microsoft Teams. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AtpPolicyForO365 [[-Identity] <AtpPolicyForO365IdParameter>] [-AllowClickThrough <$true | $false>] - [-BlockUrls <MultiValuedProperty>] [-Confirm] [-EnableATPForSPOTeamsODB <$true | $false>] - [-EnableSafeLinksForClients <$true | $false>] [-EnableSafeLinksForWebAccessCompanion <$true | $false>] - [-TrackClicks <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. For more information, see ATP safe links in Office 365 (https://go.microsoft.com/fwlink/p/?linkid=857638). - -ATP can also protect files in SharePoint Online, OneDrive for Business and Microsoft Teams by preventing users from opening and downloading files that are identified as malicious. For more information, see Office 365 Advanced Threat Protection for SharePoint, OneDrive and Teams (https://go.microsoft.com/fwlink/p/?linkid=857638). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AtpPolicyForO365 -EnableSafeLinksForClients $true -EnableATPForSPOTeamsODB $true -``` - -This example enables Safe Links for Office 365 ProPlus clients and ATP for SharePoint Online, OneDrive for Business and Microsoft Teams. - -## PARAMETERS - -### -AllowClickThrough -The AllowClickThrough parameter specifies whether to allow users to click through to the original blocked URL in Office 365 ProPlus. Valid values are: - -- $true: Users are allowed to click through to the original URL. This is the default value. - -- $false: Users aren't allowed to click through to the original URL. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockUrls -The BlockUrls parameter specifies the URLs that are always blocked by Safe Links scanning. You can specify multiple values separated by semicolons. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableATPForSPOTeamsODB -The EnableATPForSPOTeamsODB parameter specifies whether ATP is enabled for SharePoint Online, OneDrive for Business and Microsoft Teams. Valid values are: - -- $true: ATP is enabled for SharePoint Online, OneDrive for Business and Microsoft Teams. - -- $false: ATP is disabled for SharePoint Online, OneDrive for Business and Microsoft Teams. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSafeLinksForClients - -The EnableSafeLinksForClients parameter specifies whether Safe Links is enabled for Office 365 ProPlus clients. Valid values are: - -- $true: Safe Links are enabled for Office clients. - -- $false: Safe Links are disabled for Office clients. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSafeLinksForWebAccessCompanion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the ATP policy that you want to modify. There's only one policy named Default. - -```yaml -Type: AtpPolicyForO365IdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TrackClicks -The TrackClicks parameter specifies whether to track user clicks related to blocked URLs. Valid values are: - -- $true: User clicks are tracked. This is the default value. - -- $false: User clicks aren't tracked. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/60b0d121-2060-4f29-be3f-e1e4ad7805b8.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md deleted file mode 100644 index 573b9c11d6..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-PhishFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-PhishFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-PhishFilterPolicy cmdlet to configure the phish filter policy in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-PhishFilterPolicy [-Identity] <HostedConnectionFilterPolicyIdParameter> -SpoofAllowBlockList <String> - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -For more information about spoof intelligence, see Learn more about spoof intelligence (https://go.microsoft.com/fwlink/p/?linkid=869584). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PhishFilterPolicy -Detailed -SpoofAllowBlockList | Export-CSV "C:\My Documents\Spoofed Senders.csv"; $UpdateSpoofedSenders = Get-Content -Raw "C:\My Documents\Spoofed Senders.csv"; Set-PhishFilterPolicy -Identity Default -SpoofAllowBlockList $UpdateSpoofedSenders -``` - -This configures the phish filter policy to block or allow all spoofed email messages from a source messaging server. - -- Step 1: Write the output of the Get-PhishFilterPolicy cmdlet to a CSV file. - -- Step 2: Add or modify the SpoofedUser, and AllowedToSpoof values in the CSV file, save the file, and then read the file and store it as a variable named $UpdateSpoofedSenders. - -- Step 3: Use the $UpdateSpoofedSenders variable to configure the phish filter policy. - -### -------------------------- Example 2 -------------------------- -``` -Get-PhishFilterPolicy -Detailed -SpoofAllowBlockList | Export-CSV "C:\My Documents\Spoofed Senders.csv"; $UpdateSpoofedSenders = Get-Content -Raw "C:\My Documents\Spoofed Senders.csv"; Set-PhishFilterPolicy -Identity Default -SpoofAllowBlockList $UpdateSpoofedSenders -``` - -This example configures the phish filter policy to selectively block or allow some spoofed email messages from a source messaging server. - -- Step 1: Write the output of the Get-PhishFilterPolicy cmdlet to a CSV file. - -- Step 2: Add or modify the Sender, SpoofedUser, and AllowedToSpoof values in the CSV file, save the file, and then read the CSV file and store it as a variable named $UpdateSpoofedSenders. - -- Step 3: Use the $UpdateSpoofedSenders variable to configure the phish filter policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the phish filter policy that you want to modify. The only available value is Default. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SpoofAllowBlockList -The SpoofAllowBlockList parameter specifies the CSV file that you want to use to configure the phish filter policy. - -A valid value for this parameter reads the CSV file and stores it as a variable. For example, run the command $SpoofedUsers = Get-Content -Raw \<PathAndFileName\>.csv, and then use the value $SpoofedUsers for this parameter. - -There are two basic options for the CSV file: - -- Block or allow all spoofed mail from the source: You want to block or allow any and all spoofed messages from the specified message source, regardless of the spoofed email address. You can get the CSV file by running the command Get-PhishFilterPolicy -SpoofAllowBlockList | Export-CSV "\<PathAndFileName\>.csv". The important header fields (column headers) are Sender (the domain of the source messaging server from DNS records, or the IP address if there aren't any DNS records) and AllowedToSpoof (indicates whether the message source is allowed to send spoofed messages. Valid values are Yes or No). - -- Block or allow some spoofed mail from the source: You want to block or allow some spoofed messages from the specified message source, but not others. You can get the CSV file by running the command Get-PhishFilterPolicy -Detailed -SpoofAllowBlockList | Export-CSV "\<PathAndFileName\>.csv". The important header fields (column headers) are: - -- Sender: The domain of the source messaging server from DNS records, or the IP address if there aren't any DNS records. - -- SpoofedUser: The spoofed email address in your organization that the messages appear to be coming from. - -- AllowedToSpoof: Indicates whether messages that contain the spoofed sender from the source messaging server are allowed. Valid values are Yes or No. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ed0f903a-6b05-4e84-a362-c10d0e9117c4.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md deleted file mode 100644 index 966fd18495..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-SafeAttachmentPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-SafeAttachmentPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-SafeAttachmentPolicy cmdlet to modify Safe Attachments policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SafeAttachmentPolicy [-Identity] <SafeAttachmentPolicyIdParameter> - [-Action <Block | Replace | Allow | DynamicDelivery>] [-ActionOnError <$true | $false>] - [-AdminDisplayName <String>] [-Confirm] [-Enable <$true | $false>] [-Redirect <$true | $false>] - [-RedirectAddress <SmtpAddress>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -Redirect $true -RedirectAddress admin@contoso.com -``` - -This example modifies the existing Safe Attachments policy named Engineering Block Attachments to redirect detected malware attachments to admin@contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Attachments 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: SafeAttachmentPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Action -The Action parameter specifies the action for the Safe Attachments policy. Valid values are: - -- Allow: Deliver the email message, including the malware attachment. - -- Block: Block the email message that contains the malware attachment. This is the default value. - -- Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. - -The results of all actions are available in message trace. - -```yaml -Type: Block | Replace | Allow | DynamicDelivery -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActionOnError -The ActionOnError parameter specifies the error handling option for Safe Attachments scanning (what to do if attachment scanning times out or an error occurs). Valid values are: - -- $true: The action specified by the Action parameter is applied to messages even when the attachments aren't successfully scanned. - -- $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Redirect -The Redirect parameter specifies whether to send detected malware attachments to another email address. Valid values are: - -- $true: Malware attachments are sent to the email address specified by the RedirectAddress parameter. - -- $false: Malware attachments aren't sent to another email address. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectAddress -The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8f116c29-438d-45f7-bc43-d73e9d16057b.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md deleted file mode 100644 index 5ffce46332..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-SafeAttachmentRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-SafeAttachmentRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-SafeAttachmentRule cmdlet to modify Safe Attachments rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SafeAttachmentRule [-Identity] <RuleIdParameter> [-Comments <String>] [-Confirm] - [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] - [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-Name <String>] [-Priority <Int32>] - [-RecipientDomainIs <Word[]>] [-SafeAttachmentPolicy <SafeAttachmentPolicyIdParameter>] - [-SentTo <RecipientIdParameter[]>] [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SafeAttachmentRule -Identity "Engineering Department Attachment Rule" -ExceptIfRecipientDomainIs fabrikam.com -``` - -This example modifies the existing Safe Attachments Rule named Engineering Department Attachment Rule to exclude messages sent to the fabrikam.com domain. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Attachments rule that you want to modify. - -You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the Safe Attachments 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeAttachmentPolicy -The SafeAttachmentPolicy parameter specifies the Safe Attachments policy that's associated with this Safe Attachments rule. The rule defines the conditions, and the policy defines the actions. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -You can't specify a Safe Attachments policy that's already associated with another Safe Attachments rule. - -```yaml -Type: SafeAttachmentPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6fd1cf1a-bbf7-4480-a896-06e2ed9a5c1b.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md deleted file mode 100644 index a86a6a6821..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-SafeLinksPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-SafeLinksPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-SafeLinksPolicy cmdlet to modify Safe Links policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SafeLinksPolicy [-Identity] <SafeLinksPolicyIdParameter> [-AdminDisplayName <String>] - [-AllowClickThrough <$true | $false>] [-Confirm] [-DoNotAllowClickThrough <$true | $false>] - [-DoNotRewriteUrls <MultiValuedProperty>] [-DoNotTrackUserClicks <$true | $false>] [-Enabled <$true | $false>] - [-EnableForInternalSenders <$true | $false>] [-ExcludedUrls <String[]>] [-IsEnabled <$true | $false>] - [-ScanUrls <$true | $false>] [-TrackClicks <$true | $false>] [-WhatIf] [-WhiteListedUrls <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SafeAttachmentsPolicy -Identity "Engineering Block URL" -TrackClicks $true -``` - -This example modifies the existing Safe Links policy named Engineering Block URL to track user clicks on URLs in URL trace. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Safe Links policy that you want to modify. - -You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: SafeLinksPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowClickThrough -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotAllowClickThrough -The DoNotAllowClickThrough parameter specifies whether to allow users to click through to the original URL. Valid values are: - -- $true: The user isn't allowed to click through to the original URL. This is the default value. - -- $false: The user is allowed to click through to the original URL. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotRewriteUrls -The DoNotRewriteUrls parameter specifies a URL that's skipped by Safe Links scanning. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotTrackUserClicks -The DoNotTrackUserClicks parameter specifies whether to track user clicks related to links in email messages. Valid values are: - -- $true: User clicks aren't tracked. This is the default value. - -- $false: User clicks are tracked. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableForInternalSenders -PARAMVALUE: $true | $false - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedUrls -The ExcludedUrls parameter specifies a URL that's skipped by Safe Links scanning. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsEnabled -This parameter specifies whether the rule or policy is enabled. Valid values are: - -- $true: The rule or policy is enabled. - -- $false: The rule or policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScanUrls -The ScanUrls parameter specifies whether to enable or disable the scanning of links in email messages. Valid values are: - -- $true: Scanning links in email messages is enabled. - -- $false: Scanning links in email messages is disabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrackClicks -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhiteListedUrls -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3fd35540-61a3-4ad3-b66f-2d5a1aeda6dc.aspx) diff --git a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeLinksRule.md deleted file mode 100644 index 5f8f4e81b7..0000000000 --- a/exchange/exchange-ps/exchange/advanced-threat-protection/Set-SafeLinksRule.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-SafeLinksRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-SafeLinksRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SafeLinksRule [-Identity] <RuleIdParameter> [-Comments <String>] [-Confirm] - [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] - [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-Name <String>] [-Priority <Int32>] - [-RecipientDomainIs <Word[]>] [-SafeLinksPolicy <SafeLinksPolicyIdParameter>] - [-SentTo <RecipientIdParameter[]>] [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SafeLinksRule -Identity "Engineering Department URL Rule" -ExceptIfRecipientDomainIs fabrikam.com -``` - -This example modifies the existing Safe Links Rule named Engineering Department URL Rule to exclude messages sent to the fabrikam.com domain. - -## PARAMETERS - -### -Identity -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: - -- Name - -- Distinguised name (DN) - -- GUID - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the Safe Links 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeLinksPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -You can't specify a Safe Attachments policy that's already associated with another Safe Attachments rule. - -```yaml -Type: SafeLinksPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eb658430-ac2e-4c5b-89a3-acfb3bed1b69.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md deleted file mode 100644 index 8e5ca6a676..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-AttachmentFilterEntry -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Add-AttachmentFilterEntry - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Add-AttachmentFilterEntry cmdlet to add an entry to the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-AttachmentFilterEntry -Name <String> -Type <ContentType | FileName> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-AttachmentFilterEntry -Name *.txt -Type FileName -``` - -This example adds an attachment filter entry based on a file name. After running this command, the Attachment Filtering agent filters all attachments that have a .txt extension. - -### -------------------------- Example 2 -------------------------- -``` -Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType -``` - -This example adds an attachment filter entry based on the MIME content type image/jpeg, which is a JPEG image binary file. After running this command, the Attachment Filtering agent filters all attachments of the MIME content type image/jpeg. - -## PARAMETERS - -### -Name -The Name parameter specifies the MIME content type or file name of the attachment. If the Type parameter is set to FileName, the Name parameter can take any exact file name, such as BadFile.exe, or file name extension, such as \*.exe. If the Type parameter is set to ContentType, the Name parameter can take any valid MIME content type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies what type of attachment the attachment filter entry blocks. Valid values are ContentType and FileName: - -- ContentType: This value matches the attachment filter entry against the MIME content type specified in the Name parameter. - -- FileName: This value matches the attachment filter entry against the simple file name specified in the Name parameter. - -```yaml -Type: ContentType | FileName -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9c9d35c8-2833-443f-ab50-c7232be4aba4.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/antispam-antimalware/Delete-QuarantineMessage.md deleted file mode 100644 index 235ba624cd..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Delete-QuarantineMessage.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Delete-QuarantineMessage -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Delete-QuarantineMessage - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Delete-QuarantineMessage cmdlet to delete quarantine messages from your cloud-based organization - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identities -``` -Delete-QuarantineMessage -Identities <QuarantineMessageIdentity[]> [-Identity <QuarantineMessageIdentity>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### IdentityOnly -``` -Delete-QuarantineMessage -Identity <QuarantineMessageIdentity> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Delete-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 -``` - -This example deletes the quarantined message with the specified Identity value. - -### -------------------------- Example 2 -------------------------- -``` -$ids = Get-QuarantineMessage | select -ExpandProperty Identity; Delete-QuarantineMessage -Identity $ids[4] -``` - -This example deletes the 5th quarantined message in the list of results from Get-QuarantineMessage. The first message has the index number 0, the second has the index number 1 and so on). - -### -------------------------- Example 3 -------------------------- -``` -$ids = Get-QuarantineMessage | select -ExpandProperty Identity; Delete-QuarantineMessage -Identities $ids -Identity 000 -``` - -This example deletes all quarantined messages. The Identity parameter is required, but the value 000 is ignored. - -## PARAMETERS - -### -Identities -The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: value1,value2...valueN. The value is a unique quarantined message identifier in the format GUID1\\GUID2 (for example c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7. - -You can find the identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. - -When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. - -```yaml -Type: QuarantineMessageIdentity[] -Parameter Sets: Identities -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9f54e202-2a8a-4e98-a7ab-a944d6dde6d5.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md deleted file mode 100644 index d089ebf4f0..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Disable-HostedContentFilterRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Disable-HostedContentFilterRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Disable-HostedContentFilterRule cmdlet to disable content filter rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-HostedContentFilterRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-HostedContentFilterRule "Contoso Recipients" -``` - -This example disables the enabled content filter rule named Contoso Recipients. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example, you can specify the name, GUID or distinguished name (DN) of the content filter rule. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c1f8dafc-ef5d-47e3-b0fb-71a88e145fc5.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Enable-AntispamUpdates.md b/exchange/exchange-ps/exchange/antispam-antimalware/Enable-AntispamUpdates.md deleted file mode 100644 index b8d1df0db9..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Enable-AntispamUpdates.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-AntispamUpdates -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-AntispamUpdates - -## SYNOPSIS -The Enable-AntispamUpdates cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-AntispamUpdates [[-Identity] <ServerIdParameter>] [-Confirm] - [-SpamSignatureUpdatesEnabled <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-AntispamUpdates -``` - -This cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. - -## PARAMETERS - -### -Confirm -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SpamSignatureUpdatesEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -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 -``` - -### -WhatIf -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/52626c5d-d455-4c6f-a875-418ba007a501.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md deleted file mode 100644 index db066b6780..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Enable-HostedContentFilterRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Enable-HostedContentFilterRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Enable-HostedContentFilterRule cmdlet to enable content filter rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-HostedContentFilterRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-HostedContentFilterRule "Contoso Recipients" -``` - -This example enables the disabled content filter rule named Contoso Recipients. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example, you can specify the name, GUID or distinguished name (DN) of the content filter rule. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/354ece28-dcde-4b5f-88ed-475115e7ea78.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/antispam-antimalware/Export-QuarantineMessage.md deleted file mode 100644 index 9f001423b3..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Export-QuarantineMessage.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Export-QuarantineMessage -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Export-QuarantineMessage - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Export-QuarantineMessage cmdlet to export quarantined messages and files from your cloud-based organization. Messages are exported to .eml message files so you can open them in Outlook. - -For files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the files are exported in Base64 format. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-QuarantineMessage -Identity <QuarantineMessageIdentity> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$e = Export-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7; $e.BodyEncoding; $e | select -ExpandProperty Eml | Out-File "C:\My Documents\Export1_ascii.eml" -Encoding ascii -``` - -This example exports the quarantined message with the specified Identity value. - -The first two commands determine the message encoding (the value of the BodyEncoding property in the output; for example, ascii). - -The third command exports the message to the specified file using the message encoding that you found in the previous commands. - -Notes: - -- The "| select -ExpandProperty Eml" part of the command specifies the whole message, including attachments. - -- You need to use the Out-File cmdlet to write the .eml message file with the required encoding. If you use the default PowerShell redirection operator ">" to write the output file, the default encoding is Unicode, which might not match the actual message encoding. - -### -------------------------- Example 2 -------------------------- -``` -$e = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111; $bytes = [Convert]::FromBase64String($e.eml); [IO.File]::WriteAllBytes("C:\My Documents\Export1.txt", $bytes) -``` - -This example exports the quarantined file with the specified Identity value. The first command exports the file to a Base 64 string. The next two commands convert the string to byte format and write it to the output file. - -## PARAMETERS - -### -Identity -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: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/91de3a29-120c-4332-a670-e078ba8d20e2.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-AgentLog.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-AgentLog.md deleted file mode 100644 index 12c53cecbf..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-AgentLog.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AgentLog -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AgentLog - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-AgentLog cmdlet to parse log files that you specify as parameters and collect raw statistics from the filtering that anti-spam agents apply during a time period that you specify. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AgentLog [-EndDate <DateTime>] [-Location <LocalLongFullPath>] [-StartDate <DateTime>] - [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AgentLog -StartDate "01/04/2018 9:00:00 AM" -EndDate "01/08/2018 6:00:00 PM" -TransportService FrontEnd -``` - -This example returns a report that has statistics collected between 09:00 (9 A.M.), January 4, 2018 and 18:00 (6 P.M.), January 8, 2018 in the Front End Transport service. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Location -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -TransportService -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. - -- MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - -- MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - -- FrontEnd for the Front End Transport service on Mailbox servers. - -- Edge on Edge Transport servers. - -```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0e3fcbd0-8f76-44e0-91ce-788a224e1e82.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md deleted file mode 100644 index 9216cc45a5..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AttachmentFilterEntry -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AttachmentFilterEntry - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-AttachmentFilterEntry cmdlet to view the list of attachment filter entries that are used by the Attachment Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AttachmentFilterEntry [[-Identity] <String>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AttachmentFilterEntry -``` - -This example returns all attachment filter entries. - -### -------------------------- Example 2 -------------------------- -``` -Get-AttachmentFilterEntry FileName:*.txt -``` - -This example returns only the attachment filter entries that filter file names with a .txt extension. - -### -------------------------- Example 3 -------------------------- -``` -Get-AttachmentFilterEntry ContentType:image/jpeg -``` - -This example returns only the attachment filter entries that filter attachments that have the MIME content type image/jpeg. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies 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. - -- FileName: This value matches the attachment filter entry against the simple file name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c181b910-b2a3-4e68-8a10-7bb3d2b92ddb.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md deleted file mode 100644 index 597a79fa2e..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AttachmentFilterListConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AttachmentFilterListConfig - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-AttachmentFilterListConfig cmdlet to view the configuration of the Attachment Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AttachmentFilterListConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type or the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AttachmentFilterListConfig | Format-List -``` - -This example returns detailed information about the Attachment Filtering agent configuration for the Exchange server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8c228427-2c67-44c0-bf76-5596a93ed112.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-ContentFilterConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-ContentFilterConfig.md deleted file mode 100644 index 29819cd908..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-ContentFilterConfig.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ContentFilterConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ContentFilterConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ContentFilterConfig cmdlet to view the content filter configuration for the computer on which the cmdlet is run. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ContentFilterConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ContentFilterConfig | Format-List -``` - -This example returns detailed information about the content filter configuration for the Exchange server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d5aed4a-4d61-4723-831c-32da949bc6c4.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-ContentFilterPhrase.md deleted file mode 100644 index 87e557d6ba..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-ContentFilterPhrase.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ContentFilterPhrase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ContentFilterPhrase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ContentFilterPhrase cmdlet to view one or all custom words that the Content Filter agent processes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-ContentFilterPhrase [[-Identity] <ContentFilterPhraseIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Phrase -``` -Get-ContentFilterPhrase [-Phrase <ContentFilterPhraseIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ContentFilterPhrase -``` - -This example returns all custom words stored on the computer where the command is being run. - -### -------------------------- Example 2 -------------------------- -``` -Get-ContentFilterPhrase -Phrase "Free credit report" -``` - -This example returns a specific custom word specified by the Phrase parameter. In this example, the custom word is the phrase Free credit report. - -### -------------------------- Example 3 -------------------------- -``` -Get-ContentFilterPhrase | Where {$_.Phrase -like '*free offer*'} -``` - -This example returns all custom words and phrases that contain the words free offer. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies 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. - -```yaml -Type: ContentFilterPhraseIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Phrase -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. - -```yaml -Type: ContentFilterPhraseIdParameter -Parameter Sets: Phrase -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/22af0f6c-00f7-4fe5-9ff8-c63305adb9bc.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-DkimSigningConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-DkimSigningConfig.md deleted file mode 100644 index 9536dc180e..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-DkimSigningConfig.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-DkimSigningConfig -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-DkimSigningConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-DkimSigningConfig cmdlet to view the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DkimSigningConfig [[-Identity] <DkimSigningConfigIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -DKIM in Microsoft Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DkimSigningConfig -``` - -This example shows a summary list of all DKIM signing policies in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DkimSigningConfig -Identity contoso.com | Format-List -``` - -This example shows detailed information for the DKIM signing policy for contoso.com. - -## PARAMETERS - -### -Identity -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). - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DkimSigningConfigIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e8b68bd9-d14b-4fd4-8736-1681f4ee0457.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md deleted file mode 100644 index 37b418ee60..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-HostedConnectionFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-HostedConnectionFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HostedConnectionFilterPolicy cmdlet to view the settings of connection filter policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HostedConnectionFilterPolicy [[-Identity] <HostedConnectionFilterPolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HostedConnectionFilterPolicy -``` - -This example shows a summary list of all the connection filter policies in your cloud-based organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-HostedConnectionFilterPolicy Default | Format-List -``` - -This example retrieves details about the connection filter policy named Default. - -## PARAMETERS - -### -Identity -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, you can specify the name, GUID or distinguished name (DN) of the connection filter policy. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bd751db2-3f26-495b-8e5a-4fcab53b17fd.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md deleted file mode 100644 index 8a939be66b..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-HostedContentFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-HostedContentFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HostedContentFilterPolicy cmdlet to view the settings of content filter policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HostedContentFilterPolicy [[-Identity] <HostedContentFilterPolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HostedContentFilterPolicy -``` - -This example shows a summary list of all the content filter policies in your cloud-based organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-HostedContentFilterPolicy Default | Format-List -``` - -This example retrieves details about the content filter policy named Default. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content 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 content filter policy. - -```yaml -Type: HostedContentFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d510471a-dda5-4df7-b3f8-2ee7a1948436.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedContentFilterRule.md deleted file mode 100644 index 4cbbf52959..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedContentFilterRule.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-HostedContentFilterRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-HostedContentFilterRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HostedContentFilterRule cmdlet to view content filter rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HostedContentFilterRule [[-Identity] <RuleIdParameter>] [-DomainController <Fqdn>] - [-State <Enabled | Disabled>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HostedContentFilterRule -``` - -This example shows a summary list of all the content filter rules in your cloud-based organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-HostedContentFilterRule "Contoso Recipients" | Format-List -``` - -This example retrieves details about the content filter rule named Contoso Recipients. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the content filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can specify the name, GUID, or distinguished name (DN) of the content filter rule. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -State -The State parameter filters the results by enabled or disabled content filter rules. Valid input for this parameter is Enabled or Disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/969cd73d-05b2-4fc9-8a07-282d4108dae2.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md deleted file mode 100644 index 603335eb13..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-HostedOutboundSpamFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-HostedOutboundSpamFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HostedOutboundSpamFilterPolicy cmdlet to view the settings of the outbound spam filter policy in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HostedOutboundSpamFilterPolicy [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HostedOutboundSpamFilterPolicy | Format-List -``` - -This example retrieves details about the outbound spam filter policy. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8f15c83c-c10a-4d9d-b135-35321430bdc2.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListConfig.md deleted file mode 100644 index ac8a5ac523..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListConfig.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-IPAllowListConfig - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-IPAllowListConfig cmdlet to view the configuration information for the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IPAllowListConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, the Connection Filtering agent acts on the IP address of the incoming SMTP connection to determine what action, if any, to take on an incoming message. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IPAllowListConfig | Format-List -``` - -This example returns detailed information about the IP Allow list configuration on the local Edge Transport server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/66ce04e1-0170-4554-af72-a4bc5030ec74.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListProvider.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListProvider.md deleted file mode 100644 index a97c0dcbe4..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListProvider.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListProvider -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-IPAllowListProvider - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-IPAllowListProvider cmdlet to view IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IPAllowListProvider [[-Identity] <IPAllowListProviderIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IPAllowListProvider -``` - -This example returns a summary list of all IP Allow list providers. - -### -------------------------- Example 2 -------------------------- -``` -Get-IPAllowListProvider Contoso.com | Format-List -``` - -This example returns detailed information for the IP Allow list provider named Contoso.com. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: IPAllowListProviderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/966bbf6d-5ca9-4888-be64-0bb83913e5b1.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md deleted file mode 100644 index 5f863b3ff0..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListProvidersConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-IPAllowListProvidersConfig - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-IPAllowListProvidersConfig cmdlet to view the settings that affect all IP Allow list providers that are configured on an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IPAllowListProvidersConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, IP Allow list providers are used by the Connection Filtering agent. The Connection Filtering agent acts on the IP address of the incoming SMTP connection to determine what action, if any, to take on an incoming message. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IPAllowListProvidersConfig | Format-List -``` - -This example returns detailed information about the IP Allow list providers configuration on the local Edge Transport server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fd780535-4f41-48ce-8477-576ccb0acddf.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListConfig.md deleted file mode 100644 index 9ec4d82fa8..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListConfig.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-IPBlockListConfig - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-IPBlockListConfig cmdlet to view the IP Block list configuration information that's used by the Connection Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IPBlockListConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, the Connection Filtering agent acts on the incoming SMTP connection to determine what action, if any, to take on an incoming message. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IPBlockListConfig | Format-List -``` - -This example returns detailed information about the IP Block list configuration on the local Edge Transport server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7c2b9f46-00a0-4303-b19d-dbae010205e0.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListProvider.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListProvider.md deleted file mode 100644 index 4677e2593c..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListProvider.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListProvider -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-IPBlockListProvider - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-IPBlockListProvider cmdlet to view IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IPBlockListProvider [[-Identity] <IPBlockListProviderIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IPBlockListProvider -``` - -This example returns a summary list of all IP Block list providers configured on the local Edge Transport server. - -### -------------------------- Example 2 -------------------------- -``` -Get-IPBlockListProvider -Identity Contoso.com -``` - -This example returns detailed information for the existing IP Block list provider named Contoso.com. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: IPBlockListProviderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1dc8521f-df9b-4408-8acf-9a31d9f4151b.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md deleted file mode 100644 index 36c3b18804..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListProvidersConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-IPBlockListProvidersConfig - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-IPBlockListProvidersConfig cmdlet to view the settings that affect all IP Block list providers that are configured on an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IPBlockListProvidersConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, IP Block list providers are used by the Connection Filtering agent. The Connection Filtering agent acts on the IP address of the incoming SMTP connection to determine what action, if any, to take on an incoming message. - -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IPBlockListProvidersConfig | Format-List -``` - -This example returns detailed information about the IP Block list providers on the local Edge Transport server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/983ca201-bacc-4658-92ed-9a604350405e.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md deleted file mode 100644 index 7e7d4a3e9c..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxJunkEmailConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MaillboxJunkEmailConfiguration cmdlet to view the junk email settings on mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxJunkEmailConfiguration [-Identity] <MailboxIdParameter> [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -The junk email settings on the mailbox are: - -- Enable or disable the junk email rule: The junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. - -- Configure the safelist collection: The safelist collection is the Safe Senders list, the Safe Recipients list, and the Blocked Senders list. Users can configure the safelist collection on their own mailbox by using Microsoft Outlook or Outlook on the web. - -Administrators can enable or disable the junk email rule, and configure the safelist collection on a mailbox by using the Set-MailboxJunkEmailConfiguration cmdlet. For more information, see Configure Exchange antispam settings on mailboxes (https://technet.microsoft.com/library/bb123559.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxJunkEmailConfiguration -Identity "David Pelton" -``` - -This example returns the junk email configuration for the user named David Pelton. - -### -------------------------- Example 2 -------------------------- -``` -$AllUsers = Get-Mailbox -ResultSize unlimited -RecipientTypeDetails UserMailbox; $AllUsers | foreach {Get-MailboxJunkEmailConfiguration -Identity $_.UserPrincipalName} | Where {$_.Enabled -eq $false} | Format-Table -Auto Identity,Enabled -``` - -This example returns a summary list of all mailboxes in your organization where the junk email rule is disabled. The first command stores all user mailboxes in a variable. The second command parses through the mailboxes and returns the FQDN of the mailboxes where the junk email rule is disabled. - -To return all mailboxes where the junk email rule is enabled, change the value $false to $true. To return a mixed list of mailboxes where the junk email rule is enabled and disabled, remove the "| Where {$\_.Enabled -eq $false " part of the second command. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -You can use the wildcard character (\*) to identify multiple mailboxes. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: True -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3d7e3a0a-bf1f-4a88-9807-03e4ea9987b5.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md deleted file mode 100644 index 2f50f6fbf1..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MalwareFilterPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-MalwareFilterPolicy cmdlet to view the malware filter policies in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MalwareFilterPolicy [[-Identity] <MalwareFilterPolicyIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MalwareFilterPolicy -``` - -This example retrieves a summary list of all malware filter policies in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MalwareFilterPolicy Default | Format-List -``` - -This example retrieves detailed configuration information for the malware filter policy named Default. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/560a6958-c940-4c26-9a54-3f78965df32a.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilterRule.md deleted file mode 100644 index ee140f67c8..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilterRule.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MalwareFilterRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Enable-MalwareFilterRule cmdlet to view malware filter rules in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MalwareFilterRule [[-Identity] <RuleIdParameter>] [-DomainController <Fqdn>] [-State <Enabled | Disabled>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MalwareFilterRule -``` - -This example retrieves a summary list of all malware filter rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MalwareFilterRule "Contoso Recipients" | Format-List -``` - -This example retrieves detailed configuration information for the malware filter rule named Contoso Recipients. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -State -The State parameter filters the results by enabled or disabled malware filter rules. Valid input for this parameter is Enabled or Disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7036d1ac-e9ef-437d-9035-79449e6572d6.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilteringServer.md deleted file mode 100644 index b15680c0be..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-MalwareFilteringServer.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MalwareFilteringServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MalwareFilteringServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MalwareFilteringServer cmdlet to view the Malware agent settings in the Transport service on a Mailbox server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MalwareFilteringServer [[-Identity] <MalwareFilteringServerIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MalwareFilteringServer -``` - -This example displays a summary of the Exchange Malware agent settings on all Mailbox servers in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MalwareFilteringServer Mailbox01 | Format-List -``` - -This example returns the detailed Exchange Malware agent settings on a Mailbox server named Mailbox01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -```yaml -Type: MalwareFilteringServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/337ad811-fbae-4dff-9608-3abf5e1cc431.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessage.md deleted file mode 100644 index e1a8dd1815..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessage.md +++ /dev/null @@ -1,394 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-QuarantineMessage -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-QuarantineMessage - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization. - -**Not**: Quarantined files are files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Details -``` -Get-QuarantineMessage -Identity <QuarantineMessageIdentity> [-SenderAddress <String[]>] [<CommonParameters>] -``` - -### Summary -``` -Get-QuarantineMessage [-Direction <Inbound | Outbound>] [-Domain <String[]>] [-EndExpiresDate <DateTime>] - [-EndReceivedDate <DateTime>] [-MessageId <String>] [-MyItems] [-Page <Int32>] [-PageSize <Int32>] - [-QuarantineTypes <QuarantineMessageTypeEnum[]>] [-RecipientAddress <String[]>] [-Reported <$true | $false>] - [-SenderAddress <String[]>] [-StartExpiresDate <DateTime>] [-StartReceivedDate <DateTime>] [-Subject <String>] - [-Type <Spam | TransportRule | Bulk | Phish | Malware>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-QuarantineMessage -StartReceivedDate 06/13/2016 -EndReceivedDate 06/15/2016 -``` - -This example returns a summary list of messages quarantined between June 13, 2016 and June 15, 2016. - -### -------------------------- Example 2 -------------------------- -``` -Get-QuarantineMessage -PageSize 50 -Page 3 -``` - -This example presents 50 quarantined messages per page, and returns the third page of results. - -### -------------------------- Example 3 -------------------------- -``` -Get-QuarantineMessage -MessageID <5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com> -``` - -This example returns the quarantined message with the Message-ID value \<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com\>. - -### -------------------------- Example 4 -------------------------- -``` -Get-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 | Format-List -``` - -This example returns detailed information for the quarantined message with the specified Identity value. - -### -------------------------- Example 5 -------------------------- -``` -Get-QuarantineMessage -QuarantineTypes SPOMalware | Format-List -``` - -This example returns detailed information for the files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams. - -## PARAMETERS - -### -Identity -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 \<Identity\> | Format-List. - -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: Details -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: Inbound | Outbound -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by sender or recipient domain. You can specify multiple domain values separated by commas. - -```yaml -Type: String[] -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndExpiresDate -The EndExpiresDate parameter specifies the latest messages that will automatically be deleted from the quarantine. Use this parameter with the StartExpiresDate parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. - -```yaml -Type: DateTime -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndReceivedDate -The EndReceivedDate parameter specifies the latest messages to return in the results. Use this parameter with the StartReceivedDate parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: String -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MyItems -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 100. - -```yaml -Type: Int32 -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuarantineTypes -The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - -- Bulk - -- Phish - -- Spam - -- SPOMalware - -- TransportRule - -You can specify multiple values separated by commas. - -You don't need to use this parameter with the Type parameter. - -For files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the detection information can be found in CustomData field in the output. - -```yaml -Type: QuarantineMessageTypeEnum[] -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: String[] -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reported -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. - -- $false: The command only returns quarantined messages that haven't been reported as false positives. - -```yaml -Type: $true | $false -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartExpiresDate -The StartExpiresDate parameter specifies the earliest messages that will automatically be deleted from the quarantine. Use this parameter with the EndExpiresDate parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. - -```yaml -Type: DateTime -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartReceivedDate -The StartReceivedDate parameter specifies the earliest messages to return in the results. Use this parameter with the EndReceivedDate parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subject -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - -- Bulk - -- Phish - -- Spam - -- TransportRule - -You don't need to use this parameter with the QuarantineTypes parameter. - -```yaml -Type: Spam | TransportRule | Bulk | Phish | Malware -Parameter Sets: Summary -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88026da1-8dbc-49e7-80e8-112a32773c34.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md deleted file mode 100644 index 4795a9522b..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-QuarantineMessageHeader -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-QuarantineMessageHeader - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-QuarantineMessageHeader -Identity <QuarantineMessageIdentity> [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-QuarantineMessageHeader 65ab8c7d-dcd3-4067-7c60-08d116c001c3\8b677327-0ef3-166b-e108-ff6cb380d191 -``` - -This example displays the message header of the quarantined message that has the specified Identity value. - -### -------------------------- Example 2 -------------------------- -``` -$qMessages = Get-QuarantineMessage; Get-QuarantineMessageHeader $qMessages[0].Identity -``` - -This example displays the message header of the first message that's returned by Get-QuarantineMessage cmdlet. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1ac639ba-97e5-4433-b2eb-c8386946a978.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-RecipientFilterConfig.md deleted file mode 100644 index a46e0a3da7..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-RecipientFilterConfig.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RecipientFilterConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-RecipientFilterConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-RecipientFilterConfig cmdlet to view the recipient filter configuration information for the Exchange server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RecipientFilterConfig [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RecipientFilterConfig | Format-List -``` - -This example returns detailed information about the recipient filter configuration for the Exchange server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4c8dfaf1-721f-4f5a-9a85-4ff63cac3534.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderFilterConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderFilterConfig.md deleted file mode 100644 index 5b4aa56a4f..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderFilterConfig.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderFilterConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-SenderFilterConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-SenderFilterConfig cmdlet to view the Sender Filter configuration information for the Exchange server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SenderFilterConfig [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SenderFilterConfig | Format-List -``` - -This example returns detailed information about the Sender Filter configuration for the Exchange server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/99912b8e-9abd-48d9-904b-1b7719f51dfa.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderIdConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderIdConfig.md deleted file mode 100644 index 098c252338..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderIdConfig.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderIdConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-SenderIdConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-SenderIdConfig cmdlet to view the Sender ID configuration information for the Exchange server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SenderIdConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SenderIdConfig | Format-List -``` - -This example returns detailed information about the Sender ID configuration on the Exchange server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88191407-e739-4913-8170-4bd951f63f58.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderReputationConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderReputationConfig.md deleted file mode 100644 index c2ffaa9932..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Get-SenderReputationConfig.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderReputationConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-SenderReputationConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-SenderReputationConfig cmdlet to view the configuration information for sender reputation on the computer on which the command is run. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SenderReputationConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SenderReputationConfig | Format-List -``` - -This example returns detailed information about the sender reputation configuration for the Exchange server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/38350efb-35cc-421c-b5fc-c253a83e56e4.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md deleted file mode 100644 index f31b065ade..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md +++ /dev/null @@ -1,977 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-HostedContentFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-HostedContentFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-HostedContentFilterPolicy cmdlet to create content filter policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-HostedContentFilterPolicy [-Name] <String> [-AddXHeaderValue <String>] [-AdminDisplayName <String>] - [-AllowedSenderDomains <MultiValuedProperty>] [-AllowedSenders <MultiValuedProperty>] - [-BlockedSenderDomains <MultiValuedProperty>] [-BlockedSenders <MultiValuedProperty>] - [-BulkSpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | c>] - [-BulkThreshold <Int32>] [-Confirm] [-DownloadLink <$true | $false>] - [-EnableEndUserSpamNotifications <$true | $false>] [-EnableLanguageBlockList <$true | $false>] - [-EnableRegionBlockList <$true | $false>] [-EndUserSpamNotificationCustomFromAddress <SmtpAddress>] - [-EndUserSpamNotificationCustomFromName <String>] [-EndUserSpamNotificationCustomSubject <String>] - [-EndUserSpamNotificationFrequency <Int32>] - [-EndUserSpamNotificationLanguage <Default | English | French | German | Italian | Japanese | Spanish | Korean | Portuguese | Russian | ChineseSimplified | ChineseTraditional | Amharic | Arabic | Bulgarian | BengaliIndia | Catalan | Czech | Cyrillic | Danish | Greek | Estonian | Basque | Farsi | Finnish | Filipino | Galician | Gujarati | Hebrew | Hindi | Croatian | Hungarian | Indonesian | Icelandic | Kazakh | Kannada | Lithuanian | Latvian | Malayalam | Marathi | Malay | Dutch | NorwegianNynorsk | Norwegian | Oriya | Polish | PortuguesePortugal | Romanian | Slovak | Slovenian | SerbianCyrillic | Serbian | Swedish | Swahili | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Vietnamese>] - [-EndUserSpamNotificationLimit <Int32>] [-Group <String>] - [-HighConfidenceSpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-IncreaseScoreWithBizOrInfoUrls <Off | On | Test>] [-IncreaseScoreWithImageLinks <Off | On | Test>] - [-IncreaseScoreWithNumericIps <Off | On | Test>] [-IncreaseScoreWithRedirectToOtherPort <Off | On | Test>] - [-InlineSafetyTipsEnabled <$true | $false>] [-LanguageBlockList <MultiValuedProperty>] - [-MarkAsSpamBulkMail <Off | On | Test>] [-MarkAsSpamEmbedTagsInHtml <Off | On | Test>] - [-MarkAsSpamEmptyMessages <Off | On | Test>] [-MarkAsSpamFormTagsInHtml <Off | On | Test>] - [-MarkAsSpamFramesInHtml <Off | On | Test>] [-MarkAsSpamFromAddressAuthFail <Off | On | Test>] - [-MarkAsSpamJavaScriptInHtml <Off | On | Test>] [-MarkAsSpamNdrBackscatter <Off | On | Test>] - [-MarkAsSpamObjectTagsInHtml <Off | On | Test>] [-MarkAsSpamSensitiveWordList <Off | On | Test>] - [-MarkAsSpamSpfRecordHardFail <Off | On | Test>] [-MarkAsSpamWebBugsInHtml <Off | On | Test>] - [-MatchSubDomains] [-ModifySubjectValue <String>] - [-PhishSpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-QuarantineRetentionPeriod <Int32>] [-RedirectToRecipients <MultiValuedProperty>] - [-RegionBlockList <MultiValuedProperty>] - [-SpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-TestModeAction <None | AddXHeader | BccMessage>] [-TestModeBccToRecipients <MultiValuedProperty>] [-WhatIf] - [-ZapEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-HostedContentFilterPolicy -Name "Contoso Content Filter Policy" -HighConfidenceSpamAction Redirect -SpamAction Redirect -RedirectToRecipients chris@contoso.com -FalsePositiveAdditionalRecipients michelle@contoso.com -``` - -This example creates a content filter policy named Contoso Content Filter Policy with the following settings: - -- Redirect messages that are definitely spam or that may be spam to chris@contoso.com. - -- Send copies of spam quarantine false positive submissions to michelle@contoso.com. - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for the content filter policy. If the value contains spaces, enclose the value in quotation marks ("). - -The value itself can't contain the following characters: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double-quotation mark ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddXHeaderValue -The AddXHeaderValue parameter specifies the X-header value to add to spam messages when an action parameter is set to the value AddXHeader. The action parameters that use the value of this parameter are: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -The value that you specify for this parameter must contain less than 256 characters, and can't contain spaces. - -Note that when the TestModeAction parameter is set to AddXHeader, the following X-header value is automatically added to the message: X-CustomSpam: This message was filtered by the custom spam filter option. - -An X-header is a user-defined, unofficial header field that exists in the message header. X-headers aren't specifically mentioned in RFC 2822, but the use of an undefined header field starting with X- has become an accepted way to add unofficial header fields to a message. The value you specify must contain less than 256 characters, and it can't contain spaces. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedSenderDomains -The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedSenders -The AllowedSenders parameter specifies a list of trusted senders that aren't processed by the spam filter. 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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedSenderDomains -The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with SFV:SKB in the X-Forefront-Antispam-Report header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP domains. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedSenders -The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with SFV:SKB in the X-Forefront-Antispam-Report header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP email addresses. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BulkSpamAction -The BulkSpamAction parameter specifies the action to take on messages that are classified as bulk email (also known as gray mail). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BulkThreshold -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DownloadLink -The DownloadLink parameter shows or hides a link in end-user spam notification messages to download the Junk Email Reporting Tool plugin for Outlook. Valid input for this parameter is $true or $false. The default value is $false. - -This parameter is only useful if the EnableEndUserSpamNotifications parameter is set to $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableEndUserSpamNotifications -The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notification messages. Valid input for this parameter is $true or $false. The default value is $false. - -End-user spam notification messages periodically alert users when they have messages in the quarantine. When you enable end-user spam notifications, you may also specify values for the EndUserSpamNotificationCustomFromAddress, EndUserSpamNotificationCustomFromName, and EndUserSpamNotificationCustomSubject parameters. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableLanguageBlockList -The EnableLanguageBlockList parameter enables or disables blocking email messages that are written in specific languages, regardless of the message contents. Valid input for this parameter is $true or $false. The default value is $false. - -When you enable the language block list, you may specify one or more languages by using the LanguageBlockList parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRegionBlockList -The EnableRegionBlockList parameter enables or disables blocking email messages that are sent from specific countries or regions, regardless of the message contents. Valid input for this parameter is $true or $false. The default value is $false. - -When you enable the region block list, you may specify one or more regions by using the RegionBlockList parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationCustomFromAddress -The EndUserSpamNotificationCustomFromAddress parameter specifies a custom From address for end-user spam notification messages. Valid input for this parameter is an SMTP email address. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationCustomFromName -The EndUserSpamNotificationCustomFromName parameter specifies a custom display name in the From field for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationCustomSubject -The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationFrequency -The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam notification messages are sent. Valid input for this parameter is an integer between 1 and 15. The default value is 3. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationLanguage -The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam notification messages. The default value is Default. This means the default language of end-user spam notification messages is the default language of the cloud-based organization. - -```yaml -Type: Default | English | French | German | Italian | Japanese | Spanish | Korean | Portuguese | Russian | ChineseSimplified | ChineseTraditional | Amharic | Arabic | Bulgarian | BengaliIndia | Catalan | Czech | Cyrillic | Danish | Greek | Estonian | Basque | Farsi | Finnish | Filipino | Galician | Gujarati | Hebrew | Hindi | Croatian | Hungarian | Indonesian | Icelandic | Kazakh | Kannada | Lithuanian | Latvian | Malayalam | Marathi | Malay | Dutch | NorwegianNynorsk | Norwegian | Oriya | Polish | PortuguesePortugal | Romanian | Slovak | Slovenian | SerbianCyrillic | Serbian | Swedish | Swahili | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Vietnamese -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationLimit -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HighConfidenceSpamAction -The HighConfidenceSpamAction parameter specifies the action to take on messages that are classified as high confidence spam. Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithBizOrInfoUrls -The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithImageLinks -The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithNumericIps -The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithRedirectToOtherPort -The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to other TCP ports. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InlineSafetyTipsEnabled -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. - -- $false: Safety tips are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LanguageBlockList -The LanguageBlockList parameter specifies the languages to block when messages are blocked based on their language. Valid input for this parameter is a supported ISO 639-1 lowercase two-letter language code. You can specify multiple values separated by commas. This parameter is only use when the EnableRegionBlockList parameter is set to $true. - -A reference for two-letter language codes is available at the Library of Congress website: ISO 639-2 Code (https://www.loc.gov/standards/iso639-2/php/code\_list.php). Note that not all possible language codes are available as input for this parameter. - -```yaml -Type: 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 -``` - -### -MarkAsSpamBulkMail -The MarkAsSpamBulkMail parameter classifies the message as spam when the message is identified as a bulk email message. Valid values for this parameter are Off, On or Test. The default value is On. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamEmbedTagsInHtml -The MarkAsSpamEmbedTagsInHtml parameter classifies the message as spam when the message contains HTML \<embed\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamEmptyMessages -The MarkAsSpamEmptyMessages parameter classifies the message as spam when the message is empty. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamFormTagsInHtml -The MarkAsSpamFormTagsInHtml parameter classifies the message as spam when the message contains HTML \<form\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamFramesInHtml -The MarkAsSpamFramesInHtml parameter classifies the message as spam when the message contains HTML \<frame\> or \<iframe\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamFromAddressAuthFail -The MarkAsSpamFromAddressAuthFail parameter classifies the message as spam when Sender ID filtering encounters a hard fail. Valid values for this parameter are Off or On. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamJavaScriptInHtml -The MarkAsSpamJavaScriptInHtml parameter classifies the message as spam when the message contains JavaScript or VBScript. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamNdrBackscatter -The MarkAsSpamNdrBackscatter parameter classifies the message as spam when the message is a non-delivery report (NDR) to a forged sender. Valid values for this parameter are Off or On. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamObjectTagsInHtml -The MarkAsSpamObjectTagsInHtml parameter classifies the message as spam when the message contains HTML \<object\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamSensitiveWordList -The MarkAsSpamSensitiveWordList parameter classifies the message as spam when the message contains words from the sensitive words list. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamSpfRecordHardFail -The MarkAsSpamSpfRecordHardFail parameter classifies the message as spam when Sender Policy Framework (SPF) record checking encounters a hard fail. Valid values for this parameter are Off or On. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamWebBugsInHtml -The MarkAsSpamWebBugsInHtml parameter classifies the message as spam when the message contains web bugs. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchSubDomains -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModifySubjectValue -The ModifySubjectValue parameter specifies the text to prepend to the existing subject of spam messages when an action parameter is set to the value ModifySubject. The action parameters that use the value of this parameter are: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -The value that you specify for this parameter must contain less than 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhishSpamAction -The PhishSpamAction parameter specifies the action to take on messages that are classified as phishing (messages that use fraudulent links or spoofed domains to get personal information). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuarantineRetentionPeriod -The QuarantineRetentionPeriod parameter specifies the length of time in days that spam messages remain in the quarantine. Valid input for this parameter is an integer between 1 and 15. The default value is 15. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectToRecipients -The RedirectToRecipients parameter specifies the replacement recipients in spam messages when an action parameter is set to the value Redirect. The action parameters that use the value of RedirectToRecipients are HighConfidenceSpamAction and SpamAction. - -Valid input for this parameter is an email address. Separate multiple email addresses with commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionBlockList -The RegionBlockList parameter specifies the region to block when messages are blocked based on their source region. Valid input for this parameter is a supported ISO 3166-1 uppercase two-letter country code. You can specify multiple values separated by commas. This parameter is only used when the EnableRegionBlockList parameter is set to $true. - -A reference for two-letter country codes is available at the International Organization for Standardization (ISO) website: ISO 3166-1 decoding table (https://www.iso.org/iso/country\_codes/iso-3166-1\_decoding\_table.htm). Note that not all possible country codes are available as input for this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpamAction -The SpamAction parameter specifies the action to take on messages that are classified as spam (not high confidence spam, bulk email, or phishing). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestModeAction -The TestModeAction parameter specifies the additional action to take on messages that match any of the IncreaseScoreWith or MarkAsSpam parameters that are set to the value Test. Valid values are: - -- None (This is the default value) - -- 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. - -```yaml -Type: None | AddXHeader | BccMessage -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestModeBccToRecipients -The TestModeBccToRecipients parameter specifies the blind carbon copy recipients to add to spam messages when the TestModeAction action parameter is set to the value BccMessage. - -Valid input for this parameter is an email address. Separate multiple email addresses with commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZapEnabled -The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for spam. ZAP detects unread spam messages that have already been delivered to the user's Inbox. Valid values are: - -- $true: ZAP for spam is enabled. Unread spam messages that are detected in the user's Inbox are automatically moved to the Junk Email folder. This is the default value. - -- $false: ZAP for spam is disabled. - -Note: ZAP for spam requires that the following action parameters are set to the value MoveToJmf: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4d15128d-9e16-42a1-8ac5-36f07d4bbbf0.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/New-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/New-HostedContentFilterRule.md deleted file mode 100644 index fbf383b10a..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/New-HostedContentFilterRule.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-HostedContentFilterRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-HostedContentFilterRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-HostedContentFilterRule cmdlet to create content filter rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-HostedContentFilterRule [-Name] <String> -HostedContentFilterPolicy <HostedContentFilterPolicyIdParameter> - [-Comments <String>] [-Confirm] [-Enabled <$true | $false>] [-ExceptIfRecipientDomainIs <Word[]>] - [-ExceptIfSentTo <RecipientIdParameter[]>] [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] - [-Priority <Int32>] [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] - [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-HostedContentFilterRule -Name "Contoso Recipients" -HostedContentFilterPolicy "Contoso Content Filter Policy" -RecipientDomainIs contoso.com -``` - -This example creates a new content filter rule named Contoso Recipients with the following settings: If the recipient is in the domain contoso.com, apply the content filter policy named Contoso Content Filter Policy. - -## PARAMETERS - -### -HostedContentFilterPolicy -The HostedContentFilterPolicy parameter specifies the content filter policy to apply to messages that match the conditions defined by this content filter 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 content filter policy. - -You can't specify the default content filter policy. And, you can't specify a content filter policy that's already associated with another content filter rule. - -```yaml -Type: HostedContentFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the content filter rule. If the value contains spaces, enclose the value in quotation marks ("). - -The value itself can't contain the following characters: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double-quotation mark ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter enables or disables the rule. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2df13ba9-1eb0-4da3-bd72-a79d5fa15e26.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/New-MalwareFilterPolicy.md deleted file mode 100644 index 456dd4fa86..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/New-MalwareFilterPolicy.md +++ /dev/null @@ -1,510 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MalwareFilterPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-MalwareFilterPolicy cmdlet to create malware filter policies in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MalwareFilterPolicy [-Name] <String> - [-Action <DeleteMessage | DeleteAttachmentAndUseDefaultAlertText | DeleteAttachmentAndUseCustomAlertText>] - [-AdminDisplayName <String>] [-BypassInboundMessages <$true | $false>] - [-BypassOutboundMessages <$true | $false>] [-Confirm] [-CustomAlertText <String>] - [-CustomExternalBody <String>] [-CustomExternalSubject <String>] [-CustomFromAddress <SmtpAddress>] - [-CustomFromName <String>] [-CustomInternalBody <String>] [-CustomInternalSubject <String>] - [-CustomNotifications <$true | $false>] [-DomainController <Fqdn>] - [-EnableExternalSenderAdminNotifications <$true | $false>] - [-EnableExternalSenderNotifications <$true | $false>] - [-EnableInternalSenderAdminNotifications <$true | $false>] - [-EnableInternalSenderNotifications <$true | $false>] [-ExternalSenderAdminAddress <SmtpAddress>] - [-InternalSenderAdminAddress <SmtpAddress>] [-WhatIf] [-EnableFileFilter <$true | $false>] - [-FileTypes <String[]>] [-ZapEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MalwareFilterPolicy -Name "Contoso Malware Filter Policy" -EnableInternalSenderAdminNotifications $true -InternalSenderAdminAddress admin@contoso.com -``` - -This example creates a new malware filter policy named Contoso Malware Filter Policy with the following settings: - -- Block messages that contain malware. - -- Don't notify the message sender when malware is detected in the message. - -- Notify the administrator admin@contoso.com when malware is detected in a message from an internal sender. - -## PARAMETERS - -### -Name -The Name parameter specifies a name for the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Action -The Action parameter specifies the action to take when malware is detected in a message. Valid values are: - -- DeleteMessage: Deletes the message. This is the default value. - -- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces the message contents with the default alert text. - -- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces the message contents with the custom alert text specified by the AlertText parameter. - -Note: For Exchange Online Protection, any of these actions result in the message and any attachments being routed to quarantine. For more information about quarantined messages, see https://go.microsoft.com/fwlink/p/?linkid=874388. - -```yaml -Type: DeleteMessage | DeleteAttachmentAndUseDefaultAlertText | DeleteAttachmentAndUseCustomAlertText -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassInboundMessages -This parameter is available only in on-premises Exchange. - -The BypassInboundMessages parameter skips or enforces malware scanning on incoming messages. Valid input for this parameter is $true or $false. The default value is $false. This means malware scanning occurs on incoming messages by default. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassOutboundMessages -This parameter is available only in on-premises Exchange. - -The BypassOutboundMessages parameter skips or enforces malware scanning on outgoing messages. Valid input for this parameter is $true or $false. The default value is $false. This means malware scanning occurs on outgoing messages by default. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAlertText -The CustomAlertText parameter specifies the custom alert text to insert in the message when malware is detected and the value of the Action parameter is set to ReplaceWithCustomAlert. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomExternalBody -The CustomExternalBody parameter specifies the body of the custom notification message that's sent to an external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomExternalSubject -The CustomExternalSubject parameter specifies the subject of the custom notification message that's sent to an external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomFromAddress -The CustomFromAddress parameter specifies the From address of the custom notification message that's sent to an internal or external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomFromName -The CustomExternalFromName parameter specifies the From name of the custom notification message that's sent to internal or external senders when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomInternalBody -The CustomInternalBody parameter specifies the body of the custom notification message that's sent to an internal sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomInternalSubject -The CustomInternalSubject parameter specifies the subject of the custom notification message that's sent to an internal sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomNotifications -The CustomNotifications parameter enables or disables the custom notification message to the sender when the message contains malware. Valid input for this parameter is $true or $false. The default value is $false. - -If you enable custom notification messages by setting this parameter to $true, you specify the details of the custom notification message using the CustomFromAddress,CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableExternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator when malware is detected in messages from external senders. Valid input for this parameter is $true or $false. The default value is $false. - -Specify the administrator to receive the notification messages by using the ExternalSenderAdminAddress parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableExternalSenderNotifications -The EnableExternalSenderNotifications parameter enables or disables sending notification messages to senders when malware is detected in messages from external senders. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator when malware is detected in messages from internal senders. Valid input for this parameter is $true or $false. The default value is $false. - -Specify the administrator to receive the notification messages by using the InternalSenderAdminAddress parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInternalSenderNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to senders when malware is detected in messages from internal senders. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalSenderAdminAddress -The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableExternalSenderAdminNotifications parameter is set to $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalSenderAdminAddress -The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableInternalSenderAdminNotifications parameter is set to $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFileFilter -The EnableFileFilter parameter enables or disables common attachment blocking. Valid values are: - -- $true: Common attachment blocking is enabled. - -- $false: Common attachment blocking is disabled. - -To configure the blocked file types, use the FileTypes parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileTypes -The FileTypes parameter specifies the file types that are blocked by common attachment blocking. The default values are: - -- ace - -- ani - -- app - -- docm - -- exe - -- jar - -- reg - -- scr - -- vbe - -- vbs - -You enable or disable common attachment blocking by using the EnableFileFilter parameter. - -Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, ps1 files are Windows PowerShell scripts, but their true type is text. - -To replace the existing list of file types with the values you specify, use the syntax \<FileType1\>,\<FileType2\>,...\<FileTypeN\>. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. - -To add or remove file types without affecting the other file type entries, see the Examples section in the Set-MalwareFilterPolicy cmdlet topic. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZapEnabled -The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware. 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. - -- $false: ZAP for malware is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3f2cf682-e2c9-41e3-8f30-88f6cccf7c57.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/New-MalwareFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/New-MalwareFilterRule.md deleted file mode 100644 index a4ef1bc3bb..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/New-MalwareFilterRule.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MalwareFilterRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-MalwareFilterRule cmdlet to create malware filter rules in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MalwareFilterRule [-Name] <String> -MalwareFilterPolicy <MalwareFilterPolicyIdParameter> - [-Comments <String>] [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>] - [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] - [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-Priority <Int32>] [-RecipientDomainIs <Word[]>] - [-SentTo <RecipientIdParameter[]>] [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MalwareFilterRule -Name "Contoso Recipients" -MalwareFilterPolicy "Contoso Malware Filter Policy" -RecipientDomainIs contoso.com -``` - -This example creates a new malware filter rule named Contoso Recipients with the following settings: If the recipient is in the domain contoso.com, apply the malware filter policy named Contoso Malware Filter Policy. - -## PARAMETERS - -### -MalwareFilterPolicy -The MalwareFilterPolicy parameter specifies the malware filter policy to apply to messages that match the conditions defined by this malware filter 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 content filter policy. - -You can't specify the default malware filter policy. And, you can't specify a malware filter policy that's already associated with another malware filter rule. - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6097959b-7504-48b2-b8ef-c1237b29a94a.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/antispam-antimalware/Preview-QuarantineMessage.md deleted file mode 100644 index c7acdef0ee..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Preview-QuarantineMessage.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Preview-QuarantineMessage -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Preview-QuarantineMessage - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization. - -**Note**: This cmdlet isn't available for files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business, and Microsoft Teams. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Preview-QuarantineMessage -Identity <QuarantineMessageIdentity> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-QuarantineMessage -MessageID <5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com> | Preview-QuarantineMessage -``` - -This example previews the quarantined message with the Message-ID value \<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com\>. - -### -------------------------- Example 2 -------------------------- -``` -Preview-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 -``` - -This example previews the quarantined message that has the specified Identity value. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0719a273-dc7e-4768-b83e-ec11c3acf833.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/antispam-antimalware/Release-QuarantineMessage.md deleted file mode 100644 index 50eb3b3ff3..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Release-QuarantineMessage.md +++ /dev/null @@ -1,318 +0,0 @@ - - ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Release-QuarantineMessage -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Release-QuarantineMessage - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Release-QuarantineMessage cmdlet to release messages from quarantine in your cloud-based organization. You can release messages to all original recipients, or to specific recipients. - -For files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### OrgReleaseToUser -``` -Release-QuarantineMessage [-Identities <QuarantineMessageIdentity[]>] [-Identity <QuarantineMessageIdentity>] -User <String[]> - [-AllowSender] - [-Confirm] - [-Force] - [-ReportFalsePositive] - [-WhatIf] [<CommonParameters>] -``` - -### OrgReleaseToAll -``` -Release-QuarantineMessage [-Identities <QuarantineMessageIdentity[]>] [-Identity <QuarantineMessageIdentity>] [-ReleaseToAll] -[-AllowSender] [-Confirm] - [-Delete] - [-Force] - [-ReportFalsePositive] - [-WhatIf] [<CommonParameters>] -``` - -### Identitities -``` -Release-QuarantineMessage -Identities <QuarantineMessageIdentity[]> [-Identity <QuarantineMessageIdentity>] - [-AllowSender] - [-Confirm] - [-Force] - [-ReportFalsePositive] - [-WhatIf] [<CommonParameters>] -``` - -### IdentityOnly -``` -Release-QuarantineMessage -Identity <QuarantineMessageIdentity> - [-AllowSender] - [-Confirm] - [-Force] - [-ReportFalsePositive] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-QuarantineMessage -MessageID "<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>" | Release-QuarantineMessage -User julia@contoso.com -``` - -This example uses the Get-QuarantineMessage cmdlet to release the quarantined message with the Message-ID value \<5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com\> to an original recipient julia@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Release-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 -ReleaseToAll -``` - -This example releases the quarantined message with the specified Identity value to all original recipients. - -### -------------------------- Example 3 -------------------------- -``` -Get-QuarantineMessage | Release-QuarantineMessage -ReleaseToAll -``` - -This example releases all messages to all original recipients. - -### -------------------------- Example 4 -------------------------- -``` -$q = Get-QuarantineMessage -QuarantineTypes SPOMalware; $q[-1] | Release-QuarantineMessage -Organization -ReleaseToAll -``` - -This example releases a file that was quaranantined as part of Office 365 Advanced Threat Protection. The first command stores all SharePoint Online, OneDrive for Business and Microsoft Teams quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see Accessing and Using Array Elements (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). - -## PARAMETERS - -### -Identities -The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: value1,value2,...valueN. The value is a unique quarantined message identifier in the format GUID1\\GUID2 (for example c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7). - -You can find the identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. - -When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. - -```yaml -Type: QuarantineMessageIdentity[] -Parameter Sets: Identitities -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: QuarantineMessageIdentity[] -Parameter Sets: OrgReleaseToAll, OrgReleaseToUser -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: Identitities, OrgReleaseToAll, OrgReleaseToUser -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ReleaseToAll -The ReleaseToAll switch releases the quarantined message to all original recipients. You don't have to specify a value with this switch. - -This parameter is required for the quarantine type SPOMalware. - -If you previously used the User parameter or the ReleaseToAll switch to release the quarantined message to some or all of the original recipients, those recipients are skipped when you use the ReleaseToAll parameter again. You don't have to specify a value with the ReleaseToAll switch. - -You can't use the ReleaseToAll switch and the User parameter in the same command. - -```yaml -Type: SwitchParameter -Parameter Sets: OrgReleaseToAll -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -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. - -If you previously used the ReleaseToAll switch to release the quarantined message to all original recipients, and you later release the message again with the User parameter, any original recipients you specify with the User parameter are skipped. - -```yaml -Type: String[] -Parameter Sets: OrgReleaseToUser -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSender -The AllowSender switch specifies that all future messages from the sender won't be quarantined. You don't need to specify a value with this switch. - -If the message was quarantined because of a transport rule or blocked sender, messages from the sender can still be blocked in the future. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delete -This parameter has been deprecated and is no longer used. - -To delete quarantined messages, use the Delete-QuarantineMessage cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: OrgReleaseToAll -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to attempt the re-release of previously released messages from quarantine. You don't need to specify a value with this switch. - -You need to use this switch whenever you attempt to re-release previously released messages from quarantine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFalsePositive -The ReportFalsePositive switch sends a notification message indicating the specified message was not spam. You don't need to specify a value with this switch. - -This switch is only available for quarantined spam messages. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4a3aa05c-238f-46f2-b8dd-b0e3c38eab3e.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md deleted file mode 100644 index d78b788159..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedContentFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-HostedContentFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-HostedContentFilterPolicy cmdlet to remove content filter policies from your cloud-based organization. - -When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedContentFilterRule cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-HostedContentFilterPolicy [-Identity] <HostedContentFilterPolicyIdParameter> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-HostedContentFilterPolicy "Contoso Content Filter Policy" -``` - -This example removes the content filter policy named Contoso Content Filter Policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content 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 content filter policy. - -```yaml -Type: HostedContentFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9fe1fe03-8f83-41e3-9bf5-084a392784d6.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md deleted file mode 100644 index a3e44bfd8b..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedContentFilterRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-HostedContentFilterRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-HostedContentFilterRule cmdlet to remove content filter rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-HostedContentFilterRule [-Identity] <RuleIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-Rule "Contoso Recipients" -``` - -This example removes the content filter rule named Contoso Recipients. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example, you can specify the name, GUID or distinguished name (DN) of the content filter rule. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/82d1d389-8d19-4b3c-9e4d-de84b67396b7.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md deleted file mode 100644 index cc918269ae..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Rotate-DkimSigningConfig -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Rotate-DkimSigningConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Rotate-DkimSigningConfig cmdlet to rotate the public and private DomainKeys Identified Mail (DKIM) signing policy keys for domains in a cloud-based organization. This cmdlet creates new DKIM keys and uses the alternate DKIM selector. Typically, you don't need to use this cmdlet, because Microsoft Office 365 automatically rotates your DKIM keys. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Rotate-DkimSigningConfig [-Identity] <DkimSigningConfigIdParameter> [-Confirm] [-KeySize <UInt16>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Rotate-DkimSigningConfig -Identity contoso.com -``` - -This example rotates the DKIM signing policy for the contoso.com domain. - -## PARAMETERS - -### -Identity -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). - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DkimSigningConfigIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeySize -The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. The only available value is 1024. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88ba21af-c860-4106-b305-c30f9b4697e1.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-ContentFilterConfig.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-ContentFilterConfig.md deleted file mode 100644 index 06cee62c17..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-ContentFilterConfig.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ContentFilterConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-ContentFilterConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ContentFilterConfig cmdlet to modify the content filter configuration on a Mailbox server or an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ContentFilterConfig [-BypassedRecipients <MultiValuedProperty>] - [-BypassedSenderDomains <MultiValuedProperty>] [-BypassedSenders <MultiValuedProperty>] [-Confirm] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExternalMailEnabled <$true | $false>] - [-InternalMailEnabled <$true | $false>] [-OutlookEmailPostmarkValidationEnabled <$true | $false>] - [-QuarantineMailbox <SmtpAddress>] [-RejectionResponse <AsciiString>] [-SCLDeleteEnabled <$true | $false>] - [-SCLDeleteThreshold <Int32>] [-SCLQuarantineEnabled <$true | $false>] [-SCLQuarantineThreshold <Int32>] - [-SCLRejectEnabled <$true | $false>] [-SCLRejectThreshold <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ContentFilterConfig -BypassedSenderDomains woodgrovebank.com -``` - -This example specifies the sender domain woodgrovebank.com as a bypassed domain. Messages received from that domain bypass the Content Filter agent. - -### -------------------------- Example 2 -------------------------- -``` -Set-ContentFilterConfig -SCLQuarantineEnabled $true -SCLRejectEnabled $true -SCLDeleteEnabled $true -SCLQuarantineThreshold 5 -SCLRejectThreshold 6 -SCLDeleteThreshold 8 -QuarantineMailbox SpamQuarantineMailbox@contoso.com -RejectionResponse "Message rejected due to content restrictions" -BypassedRecipients user1@contoso.com,user2@contoso.com -``` - -This example makes the following modifications to the Content Filter agent configuration: - -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 defines two users for whom the Content Filter won't process messages. - -## PARAMETERS - -### -BypassedRecipients -The BypassedRecipients parameter specifies the SMTP address values of recipients in your organization. The Content Filter agent doesn't process any content filtering for messages bound to the addresses listed on this parameter. To enter multiple SMTP addresses, separate the addresses by using a comma, for example: recipient1@contoso.com,recipient2@contoso.com. The maximum number of recipients you can input is 100. - -```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: False -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. - -```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: False -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. - -```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: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: $true | $false -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 -``` - -### -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. - -```yaml -Type: $true | $false -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 -``` - -### -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. - -```yaml -Type: $true | $false -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 -``` - -### -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. - -```yaml -Type: $true | $false -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 -``` - -### -QuarantineMailbox -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 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectionResponse -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SCLDeleteEnabled -The SCLDeleteEnabled parameter specifies whether all messages that 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 exceed the value set in the SCLDeleteThreshold parameter are deleted. - -```yaml -Type: $true | $false -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 -``` - -### -SCLDeleteThreshold -The SCLDeleteThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SCLQuarantineEnabled -The SCLQuarantineEnabled parameter specifies whether all messages that 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 exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. - -```yaml -Type: $true | $false -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 -``` - -### -SCLQuarantineThreshold -The SCLQuarantineThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SCLRejectEnabled -The SCLRejectEnabled parameter specifies whether all messages that 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 exceed the value set in the SCLRejectThreshold parameter are rejected, and an NDR is sent to the sender. - -```yaml -Type: $true | $false -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 -``` - -### -SCLRejectThreshold -The SCLRejectThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must 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 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/23900d4c-2b88-466e-9746-3f5c5b80f267.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md deleted file mode 100644 index 37c5083eda..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-HostedConnectionFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-HostedConnectionFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HostedConnectionFilterPolicy cmdlet to modify the settings of connection filter policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HostedConnectionFilterPolicy [-Identity] <HostedConnectionFilterPolicyIdParameter> - [-AdminDisplayName <String>] [-ConfigurationXmlRaw <String>] [-Confirm] [-EnableSafeList <$true | $false>] - [-IPAllowList <MultiValuedProperty>] [-IPBlockList <MultiValuedProperty>] [-MakeDefault] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HostedConnectionFilterPolicy "Contoso Connection Filter Policy" -IPAllowList 192.168.1.10,192.168.1.23 -IPBlockList 10.10.10.0/25,172.17.17.0/24 -``` - -This example modifies the connection filter policy named Contoso Connection Filter Policy with the following settings: - -- Messages from 192.168.1.10 and 192.168.1.23 are never identified as spam. - -- Messages from 10.10.10.0/25 and 172.17.17.0/24 are always identified as spam. - -### -------------------------- Example 2 -------------------------- -``` -Set-HostedConnectionFilterPolicy "Contoso Connection Filter Policy" -IPAllowList @{Add="192.168.2.10","192.169.3.0/24","192.168.4.1-192.168.4.5";Remove="192.168.1.10"} -``` - -This example modifies the connection filter policy named Contoso Connection Filter Policy with the following settings: - -- The following IP addresses are added to the existing values in the IP allow list: 192.168.2.10, 192.169.3.0/24 and 192.168.4.1-192.168.4.5. - -- The IP address 192.168.1.10 is removed from the existing values in the IP allow list. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the connection filter policy you want to modify. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the hosted connection filter policy. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationXmlRaw -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -You enter the IP addresses using the following syntax: - -- Single IP: For example, 192.168.1.1. - -- IP range: You can use an IP address range, for example, 192.168.0.1-192.168.0.254. - -- CIDR IP: You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. Valid network mask values are /24 through /32. - -You can specify multiple IP addresses of the same type separated by commas. For example, \<single IP1\>, \<single IP2\> or \<CIDR IP1\>, \<CIDR IP2\>. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: @{Add="\<single IP1\>","\<IP range1\>",\<CIDR IP1\>...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPBlockList -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. - -You enter the IP addresses using the following syntax: - -- Single IP: For example, 192.168.1.1. - -- IP range: You can use an IP address range, for example, 192.168.0.1-192.168.0.254. - -- CIDR IP: You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. Valid network mask values are /24 through /32. - -You can specify multiple IP addresses of the same type separated by commas. For example, \<single IP1\>, \<single IP2\> or \<CIDR IP1\>, \<CIDR IP2\>. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: @{Add="\<single IP1\>","\<IP range1\>",\<CIDR IP1\>...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeDefault -The MakeDefault switch makes the specified policy the default connection filter policy. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ccb5731b-3fca-4d69-a91f-5049ea963fac.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md deleted file mode 100644 index 78be1008fd..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md +++ /dev/null @@ -1,1007 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-HostedContentFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-HostedContentFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HostedContentFilterPolicy cmdlet to modify the settings of content filter policies in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HostedContentFilterPolicy [-Identity] <HostedContentFilterPolicyIdParameter> [-AddXHeaderValue <String>] - [-AdminDisplayName <String>] [-AllowedSenderDomains <MultiValuedProperty>] - [-AllowedSenders <MultiValuedProperty>] [-BlockedSenderDomains <MultiValuedProperty>] - [-BlockedSenders <MultiValuedProperty>] - [-BulkSpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-BulkThreshold <Int32>] [-Confirm] [-DownloadLink <$true | $false>] - [-EnableEndUserSpamNotifications <$true | $false>] [-EnableLanguageBlockList <$true | $false>] - [-EnableRegionBlockList <$true | $false>] [-EndUserSpamNotificationCustomFromAddress <SmtpAddress>] - [-EndUserSpamNotificationCustomFromName <String>] [-EndUserSpamNotificationCustomSubject <String>] - [-EndUserSpamNotificationFrequency <Int32>] - [-EndUserSpamNotificationLanguage <Default | English | French | German | Italian | Japanese | Spanish | Korean | Portuguese | Russian | ChineseSimplified | ChineseTraditional | Amharic | Arabic | Bulgarian | BengaliIndia | Catalan | Czech | Cyrillic | Danish | Greek | Estonian | Basque | Farsi | Finnish | Filipino | Galician | Gujarati | Hebrew | Hindi | Croatian | Hungarian | Indonesian | Icelandic | Kazakh | Kannada | Lithuanian | Latvian | Malayalam | Marathi | Malay | Dutch | NorwegianNynorsk | Norwegian | Oriya | Polish | PortuguesePortugal | Romanian | Slovak | Slovenian | SerbianCyrillic | Serbian | Swedish | Swahili | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Vietnamese>] - [-EndUserSpamNotificationLimit <Int32>] [-Group <String>] - [-HighConfidenceSpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-IncreaseScoreWithBizOrInfoUrls <Off | On | Test>] [-IncreaseScoreWithImageLinks <Off | On | Test>] - [-IncreaseScoreWithNumericIps <Off | On | Test>] [-IncreaseScoreWithRedirectToOtherPort <Off | On | Test>] - [-InlineSafetyTipsEnabled <$true | $false>] [-LanguageBlockList <MultiValuedProperty>] [-MakeDefault] - [-MarkAsSpamBulkMail <Off | On | Test>] [-MarkAsSpamEmbedTagsInHtml <Off | On | Test>] - [-MarkAsSpamEmptyMessages <Off | On | Test>] [-MarkAsSpamFormTagsInHtml <Off | On | Test>] - [-MarkAsSpamFramesInHtml <Off | On | Test>] [-MarkAsSpamFromAddressAuthFail <Off | On | Test>] - [-MarkAsSpamJavaScriptInHtml <Off | On | Test>] [-MarkAsSpamNdrBackscatter <Off | On | Test>] - [-MarkAsSpamObjectTagsInHtml <Off | On | Test>] [-MarkAsSpamSensitiveWordList <Off | On | Test>] - [-MarkAsSpamSpfRecordHardFail <Off | On | Test>] [-MarkAsSpamWebBugsInHtml <Off | On | Test>] - [-MatchSubDomains] [-ModifySubjectValue <String>] - [-PhishSpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-QuarantineRetentionPeriod <Int32>] [-RedirectToRecipients <MultiValuedProperty>] - [-RegionBlockList <MultiValuedProperty>] - [-SpamAction <MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction>] - [-TestModeAction <None | AddXHeader | BccMessage>] [-TestModeBccToRecipients <MultiValuedProperty>] [-WhatIf] - [-ZapEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HostedContentFilterPolicy -Identity "Contoso Content Filter Policy" -HighConfidenceSpamAction Redirect -SpamAction Redirect -RedirectToRecipients chris@contoso.com -FalsePositiveAdditionalRecipients michelle@contoso.com -``` - -This example modifies the content filter policy named Contoso Content Filter Policy with the following settings: - -Redirect messages that are definitely spam or that may be spam to chris@contoso.com. - -Send copies of spam quarantine false positive submissions to michelle@contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content filter policy you want to modify. You can use any value that uniquely identifies the policy. For example, you can specify the name, GUID or distinguished name (DN) of the content filter policy. - -```yaml -Type: HostedContentFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddXHeaderValue -The AddXHeaderValue parameter specifies the X-header value to add to spam messages when an action parameter is set to the value AddXHeader. The action parameters that use the value of this parameter are: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -The value that you specify for this parameter must contain less than 256 characters, and can't contain spaces. - -Note that when the TestModeAction parameter is set to AddXHeader, the following X-header value is automatically added to the message: X-CustomSpam: This message was filtered by the custom spam filter option. - -An X-header is a user-defined, unofficial header field that exists in the message header. X-headers aren't specifically mentioned in RFC 2822, but the use of an undefined header field starting with X- has become an accepted way to add unofficial header fields to a message. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedSenderDomains -The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedSenders -The AllowedSenders parameter specifies a list of trusted senders that aren't processed by the spam filter. 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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedSenderDomains -The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with SFV:SKB in the X-Forefront-Antispam-Report header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP domains. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedSenders -The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with SFV:SKB in the X-Forefront-Antispam-Report header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP email addresses. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BulkSpamAction -The BulkSpamAction parameter specifies the action to take on messages that are classified as bulk email (also known as gray mail). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BulkThreshold -The BulkThreshold parameter allows you to configure a bulk email threshold setting. You can choose a threshold setting, based on the bulk complaint levels, from 1 - 9, where 1 marks most bulk email as spam, and 9 allows the most bulk email to be delivered. The default value is 7. For more information, check out Configure your spam filter policies (https://technet.microsoft.com/library/jj200684.aspx). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DownloadLink -The DownloadLink parameter shows or hides a link in end-user spam notification messages to download the Junk Email Reporting Tool plugin for Outlook. Valid input for this parameter is $true or $false. The default value is $false. - -This parameter is only useful if the EnableEndUserSpamNotifications parameter is set to $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableEndUserSpamNotifications -The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notification messages. Valid input for this parameter is $true or $false. The default value is $false. - -End-user spam notification messages periodically alert users when they have messages in the quarantine. When you enable end-user spam notifications, you may also specify values for the EndUserSpamNotificationCustomFromAddress, EndUserSpamNotificationCustomFromName, and EndUserSpamNotificationCustomSubject parameters. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableLanguageBlockList -The EnableLanguageBlockList parameter enables or disables blocking email messages that are written in specific languages, regardless of the message contents. Valid input for this parameter is $true or $false. The default value is $false. - -When you enable the language block list, you may specify one or more languages by using the LanguageBlockList parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRegionBlockList -The EnableRegionBlockList parameter enables or disables blocking email messages that are sent from specific countries or regions, regardless of the message contents. Valid input for this parameter is $true or $false. The default value is $false. - -When you enable the region block list, you may specify one or more regions by using the RegionBlockList parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationCustomFromAddress -This parameter has been deprecated and is no longer used. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationCustomFromName -This parameter has been deprecated and is no longer used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationCustomSubject -The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationFrequency -The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam notification messages are sent. Valid input for this parameter is an integer between 1 and 15. The default value is 3. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationLanguage -The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam notification messages. The default value is Default. This means the default language of end-user spam notification messages is the default language of the cloud-based organization. - -```yaml -Type: Default | English | French | German | Italian | Japanese | Spanish | Korean | Portuguese | Russian | ChineseSimplified | ChineseTraditional | Amharic | Arabic | Bulgarian | BengaliIndia | Catalan | Czech | Cyrillic | Danish | Greek | Estonian | Basque | Farsi | Finnish | Filipino | Galician | Gujarati | Hebrew | Hindi | Croatian | Hungarian | Indonesian | Icelandic | Kazakh | Kannada | Lithuanian | Latvian | Malayalam | Marathi | Malay | Dutch | NorwegianNynorsk | Norwegian | Oriya | Polish | PortuguesePortugal | Romanian | Slovak | Slovenian | SerbianCyrillic | Serbian | Swedish | Swahili | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Vietnamese -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserSpamNotificationLimit -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HighConfidenceSpamAction -The HighConfidenceSpamAction parameter specifies the action to take on messages that are classified as high confidence spam (not spam, bulk email, or phishing). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithBizOrInfoUrls -The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithImageLinks -The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithNumericIps -The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncreaseScoreWithRedirectToOtherPort -The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to other TCP ports. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InlineSafetyTipsEnabled -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. - -- $false: Safety tips are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LanguageBlockList -The LanguageBlockList parameter specifies the languages to block when messages are blocked based on their language. Valid input for this parameter is a supported ISO 639-1 lowercase two-letter language code. You can specify multiple values separated by commas. This parameter is only used when the EnableRegionBlockList parameter is set to $true. - -A reference for two-letter language codes is available at the Library of Congress website: ISO 639-2 Code (https://www.loc.gov/standards/iso639-2/php/code\_list.php). Note that not all possible language codes are available as input for this parameter. - -```yaml -Type: 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 -``` - -### -MakeDefault -The MakeDefault switch makes the specified content filter policy the default content filter policy. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamBulkMail -The MarkAsSpamBulkMail parameter classifies the message as spam when the message is identified as a bulk email message (also known as gray mail). Valid values for this parameter are Off, On or Test. The default value is On. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamEmbedTagsInHtml -The MarkAsSpamEmbedTagsInHtml parameter classifies the message as spam when the message contains HTML \<embed\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamEmptyMessages -The MarkAsSpamEmptyMessages parameter classifies the message as spam when the message is empty. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamFormTagsInHtml -The MarkAsSpamFormTagsInHtml parameter classifies the message as spam when the message contains HTML \<form\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamFramesInHtml -The MarkAsSpamFramesInHtml parameter classifies the message as spam when the message contains HTML \<frame\> or \<iframe\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamFromAddressAuthFail -The MarkAsSpamFromAddressAuthFail parameter classifies the message as spam when Sender ID filtering encounters a hard fail. Valid values for this parameter are Off or On. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamJavaScriptInHtml -The MarkAsSpamJavaScriptInHtml parameter classifies the message as spam when the message contains JavaScript or VBScript. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamNdrBackscatter -The MarkAsSpamNdrBackscatter parameter classifies the message as spam when the message is a non-delivery report (NDR) to a forged sender. Valid values for this parameter are Off or On. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamObjectTagsInHtml -The MarkAsSpamObjectTagsInHtml parameter classifies the message as spam when the message contains HTML \<object\> tags. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamSensitiveWordList -The MarkAsSpamSensitiveWordList parameter classifies the message as spam when the message contains words from the sensitive words list. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamSpfRecordHardFail -The MarkAsSpamSpfRecordHardFail parameter classifies the message as spam when Sender Policy Framework (SPF) record checking encounters a hard fail. Valid values for this parameter are Off or On. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkAsSpamWebBugsInHtml -The MarkAsSpamWebBugsInHtml parameter classifies the message as spam when the message contains web bugs. Valid values for this parameter are Off, On or Test. The default value is Off. - -```yaml -Type: Off | On | Test -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchSubDomains -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModifySubjectValue -The ModifySubjectValue parameter specifies the text to prepend to the existing subject of messages when an action parameter is set to the value ModifySubject. The action parameters that use the value of this parameter are: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -The value you specify must contain less than 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhishSpamAction -The PhishSpamAction parameter specifies the action to take on messages that are classified as phishing (messages that use fraudulent links or spoofed domains to get personal information). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuarantineRetentionPeriod -The QuarantineRetentionPeriod parameter specifies the length of time in days that spam messages remain in the quarantine. Valid input for this parameter is an integer between 1 and 15. The default value is 15. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectToRecipients -The RedirectToRecipients parameter specifies the email addresses of replacement recipients when an action parameter is set to the value Redirect. The action parameters that use the email addresses in this parameter are: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -You can specify multiple email addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionBlockList -The RegionBlockList parameter specifies the region to block when messages are blocked based on their source region. Valid input for this parameter is a supported ISO 3166-1 uppercase two-letter country code. You can specify multiple values separated by commas. This parameter is only used when the EnableRegionBlockList parameter is set to $true. - -A reference for two-letter country codes is available at the International Organization for Standardization (ISO) website: ISO 3166-1 decoding table (https://www.iso.org/iso/country\_codes/iso-3166-1\_decoding\_table.htm). Note that not all possible country codes are available as input for this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpamAction -The SpamAction parameter specifies the action to take on messages that are classified as spam (not high confidence spam, bulk email, or phishing)). Valid values are: - -- AddXHeader: The value specified by the AddXHeaderValue parameter is added to the message. - -- Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - -- ModifySubject: The value specified by the ModifySubjectValue parameter is prepended to the subject of the message. - -- MoveToJmf: Move the message to the user's Junk Email folder. This is the default value, and is required by zero-hour auto purge (ZAP) for spam. - -- Quarantine: Move the message to the quarantine. - -- Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - -```yaml -Type: MoveToJmf | AddXHeader | ModifySubject | Redirect | Delete | Quarantine | NoAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestModeAction -The TestModeAction parameter specifies the additional action to take on messages when the IncreaseScoreWith or MarkAsSpam parameters that are set to the value Test. Valid values are: - -- None (This is the default value) - -- 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. - -```yaml -Type: None | AddXHeader | BccMessage -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestModeBccToRecipients -The TestModeBccToRecipients parameter specifies the blind carbon copy recipients to add to spam messages when the TestModeAction action parameter is set to the value BccMessage. - -Valid input for this parameter is an email address. Separate multiple email addresses with commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZapEnabled -The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for spam. ZAP detects unread spam messages that have already been delivered to the user's Inbox. Valid values are: - -- $true: ZAP for spam is enabled. Unread spam messages that are detected in the user's Inbox are automatically moved to the Junk Email folder. This is the default value. - -- $false: ZAP for spam is disabled. - -Note: ZAP for spam requires that the following action parameters are set to the value MoveToJmf: - -- BulkSpamAction - -- HighConfidenceSpamAction - -- PhishSpamAction - -- SpamAction - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f597aa65-baa7-49d0-8832-2a300073f211.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedContentFilterRule.md deleted file mode 100644 index 3e8ab42be3..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedContentFilterRule.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-HostedContentFilterRule -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-HostedContentFilterRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HostedContentFilterRule cmdlet to modify the settings of content filter rules in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HostedContentFilterRule [-Identity] <RuleIdParameter> [-Comments <String>] [-Confirm] - [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] - [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] - [-HostedContentFilterPolicy <HostedContentFilterPolicyIdParameter>] [-Name <String>] [-Priority <Int32>] - [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] [-SentToMemberOf <RecipientIdParameter[]>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HostedContentFilterRule "Contoso Recipients" -ExceptIfSentToMemberOf "Contoso Human Resources" -``` - -This example adds an exception to the content filter rule named Contoso Recipients for members of the distribution group named Contoso Human Resources. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the content filter rule that you want to modify. You can use any value that uniquely identifies the rule. For example, you can specify the name, GUID, or distinguished name (DN) of the content filter rule. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostedContentFilterPolicy -The HostedContentFilterPolicy parameter specifies the content filter policy to apply to messages that match the conditions defined by this content filter 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 content filter policy. - -You can't specify the default content filter policy. And, you can't specify a content filter policy that's already associated with another content filter rule. - -```yaml -Type: HostedContentFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the content filter rule. If the value contains spaces, enclose the value in quotation marks ("). - -The value itself can't contain the following characters: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double-quotation mark ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ba259260-ffd3-43f3-8ef4-9d8659679d02.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md deleted file mode 100644 index ec9819dfb0..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-HostedOutboundSpamFilterPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-HostedOutboundSpamFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HostedOutboundSpamFilterPolicy cmdlet to modify the settings of the outbound spam filter policy in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HostedOutboundSpamFilterPolicy [-Identity] <HostedOutboundSpamFilterPolicyIdParameter> - [-AdminDisplayName <String>] [-BccSuspiciousOutboundAdditionalRecipients <MultiValuedProperty>] - [-BccSuspiciousOutboundMail <$true | $false>] [-Confirm] [-NotifyOutboundSpam <$true | $false>] - [-NotifyOutboundSpamRecipients <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HostedOutboundSpamFilterPolicy Default -NotifyOutboundSpam $true -NotifyOutboundSpamRecipients chris@contoso.com -``` - -This example configures the following settings in the outbound spam filter policy named Default: - -- Notification messages are sent when an outgoing message is determined to be spam. - -- Notification messages are sent to chris@contoso.com. - -## PARAMETERS - -### -Identity -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, you can specify the name, GUID or distinguished name (DN) of the outbound spam filter policy. - -```yaml -Type: HostedOutboundSpamFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BccSuspiciousOutboundAdditionalRecipients -The BccSuspiciousOutboundAdditionalRecipients parameter specifies the recipients to add to the Bcc field of outgoing spam messages. Valid input for this parameter is an email address. Separate multiple email addresses with commas. - -The specified recipients are added to the Bcc field of outgoing spam messages when the value of the BccSuspiciousOutboundMail parameter is $true. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BccSuspiciousOutboundMail -The BccSuspiciousOutboundMail parameter enables or disables adding recipients to the Bcc field of outgoing spam messages. Valid input for this parameter is $true or $false. The default value is $false. You specify the additional recipients using the BccSuspiciousOutboundAdditionalRecipients parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOutboundSpam -The NotifyOutboundSpam parameter enables or disables sending notification messages to administrators when an outgoing message is determined to be spam. Valid input for this parameter is $true or $false. The default value is $false. You specify the administrators to notify by using the NotifyOutboundSpamRecipients parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOutboundSpamRecipients -The NotifyOutboundSpamRecipients parameter specifies the administrators to notify when an outgoing message is determined to be spam. Valid input for this parameter is an email address. Separate multiple email addresses with commas. - -The specified recipients receive notifications when the value of the NotifyOutboundSpam parameter is $true. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/665d1b04-d4b5-4a0e-811a-4e37096ccbfd.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md deleted file mode 100644 index 8538eb4045..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxJunkEmailConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxJunkEmailConfiguration cmdlet to configure the junk email settings on mailboxes. - -You can only use this cmdlet on a mailbox that's been opened in Outlook (in Cached Exchange mode) or Outlook on the web. If the mailbox hasn't been opened, you'll receive the error: The Junk Email configuration couldn't be set. The user needs to sign in to Outlook Web App before they can modify their Safe Senders and Recipients or Blocked Senders lists. If you want to suppress this error for bulk operations, you can add -ErrorAction SlientlyContinue to the end of the command. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxJunkEmailConfiguration [-Identity] <MailboxIdParameter> - [-BlockedSendersAndDomains <MultiValuedProperty>] [-Confirm] [-ContactsTrusted <$true | $false>] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-IgnoreDefaultScope] - [-TrustedListsOnly <$true | $false>] [-TrustedSendersAndDomains <MultiValuedProperty>] [-WhatIf] - [-TrustedRecipientsAndDomains <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet controls the following junk email settings on the mailbox: - -- Enable or disable the junk email rule: The junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. - -- Configure the safelist collection: The safelist collection is the Safe Senders list, the Safe Recipients list, and the Blocked Senders list. Users can configure the safelist collection on their own mailbox by using Microsoft Outlook or Outlook on the web. - -For more information, see Configure Exchange antispam settings on mailboxes (https://technet.microsoft.com/library/bb123559.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxJunkEmailConfiguration "David Pelton" -Enabled $false -``` - -This example disables the junk email rule configuration for the user named David Pelton. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxJunkEmailConfiguration "Michele Martin" -TrustedSendersAndDomains @{Add="contoso.com","fabrikam.com"} -BlockedSendersAndDomains @{Add="jane@fourthcoffee.com"} -``` - -This example makes the following configuration changes to the safelist collection for the user named Michele Martin: - -- Adds contoso.com and fabrikam.com to the Safe Senders list without affecting other existing entries. - -- Adds jane@fourthcoffee.com to the Blocked senders list without affecting other existing entries. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxJunkEmailConfiguration * | Where {$_.ContactsTrusted -eq $true} | Set-MailboxJunkEmailConfiguration -ContactsTrusted $false -``` - -This example identifies mailboxes where contacts are treated as trusted senders and then changes the junk email configuration to not treat contacts as trusted senders. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BlockedSendersAndDomains -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -ContactsTrusted -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. - -```yaml -Type: $true | $false -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter enables or disables the junk email rule on the mailbox (a hidden Inbox rule named Junk E-mail Rule). Valid values are: - -- $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This is the default value. Exchange use the safelist collection of the mailbox (the Safe Senders list, Safe Recipients list, and Blocked Senders list), and the SCL Junk Email folder threshold (for the organization or the mailbox) to deliver messages to the Inbox or the Junk Email folder. - -- $false: The junk email rule is disabled in the mailbox. This value corresponds to the Outlook on the web setting: Don't move email to my Junk Email folder. Exchange doesn't use the safelist collection of the mailbox or the SCL Junk Email folder threshold to deliver messages to the Inbox or the Junk Email folder. - -You can view the status of the junk email rule by running either of the following commands to find the Enabled property value: - -- Get-MailboxJunkEmailConfiguration \<MailboxIdentity\> - -- Get-InboxRule "Junk E-mail Rule" -Mailbox \<MailboxIdentity\> -IncludeHidden - -You use the JunkEmailEnabled parameter on the Set-OwaMailboxPolicy or Set-OwaVirtualDirectory cmdlets to control the availability of the junk email settings in Outlook on the web. - -The state of the junk email rule on the mailbox doesn't affect the client-side junk email settings that are available in the Outlook Junk Email Filter. Even when the junk email rule is disabled in the mailbox, Outlook can still move messages to the Junk Email folder. For example, if Outlook determines the message is spam, or the sender is defined in the Blocked Senders list, Outlook can move the message to the Junk Email folder. For more information, see Configure junk email settings in Outlook 2013 (https://go.microsoft.com/fwlink/p/?LinkID=797542). - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedListsOnly -The TrustedListsOnly parameter specifies that only messages from senders in the Safe Senders list are delivered to the Inbox. All other messages are treated as junk email. This parameter corresponds to the Outlook on the web setting: Don't trust email unless it comes from someone in my Safe Senders and Recipients list. Valid values are: - -- $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. - -```yaml -Type: $true | $false -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 -``` - -### -TrustedSendersAndDomains -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -To empty the list of email addresses and domains, use the value $null. - -Notes: - -- All email addresses in the global address list (GAL) are automatically considered as trusted senders, so you don't need to add them to the list. - -- You can't directly modify the Safe Recipients list by using this cmdlet. You use this parameter to modify the Safe Senders list, and the email addresses and domains are synchronized to the Safe Recipients list. - -- Safe domains aren't recognized in Exchange Online and Exchange Online Protection. For more information, see Domains on the Outlook Safe Senders list aren't recognized by Exchange Online or Exchange Online Protection (https://go.microsoft.com/fwlink/p/?linkid=859868). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -TrustedRecipientsAndDomains -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0450fbfd-c38d-48df-ba42-fe16014631b8.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md deleted file mode 100644 index 29a2278852..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md +++ /dev/null @@ -1,568 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MalwareFilterPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-MalwareFilterPolicy cmdlet to modify malware filter policies in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MalwareFilterPolicy [-Identity] <MalwareFilterPolicyIdParameter> - [-Action <DeleteMessage | DeleteAttachmentAndUseDefaultAlertText | DeleteAttachmentAndUseCustomAlertText>] - [-AdminDisplayName <String>] [-BypassInboundMessages <$true | $false>] - [-BypassOutboundMessages <$true | $false>] [-Confirm] [-CustomAlertText <String>] - [-CustomExternalBody <String>] [-CustomExternalSubject <String>] [-CustomFromAddress <SmtpAddress>] - [-CustomFromName <String>] [-CustomInternalBody <String>] [-CustomInternalSubject <String>] - [-CustomNotifications <$true | $false>] [-DomainController <Fqdn>] - [-EnableExternalSenderAdminNotifications <$true | $false>] - [-EnableExternalSenderNotifications <$true | $false>] - [-EnableInternalSenderAdminNotifications <$true | $false>] - [-EnableInternalSenderNotifications <$true | $false>] [-ExternalSenderAdminAddress <SmtpAddress>] - [-InternalSenderAdminAddress <SmtpAddress>] [-MakeDefault] [-WhatIf] [-EnableFileFilter <$true | $false>] - [-FileTypes <String[]>] [-ZapEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MalwareFilterPolicy -Identity "Contoso Malware Filter Policy" -Action DeleteMessage -EnableInternalSenderAdminNotifications $true -InternalSenderAdminAddress admin@contoso.com -``` - -This example modifies the malware filter policy named Contoso Malware Filter Policy with the following settings: - -Delete messages that contain malware. - -Don't notify the message sender when malware is detected in the message. - -Notify the administrator admin@contoso.com when malware is detected in a message from an internal sender. - -### -------------------------- Example 2 -------------------------- -``` -$FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes; $FileTypesAdd += "com","bat"; Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd -``` - -This example enables common attachment blocking in the malware filter policy named Default and adds the file types "com" and "bat" without affecting the other file type entries. - -### -------------------------- Example 3 -------------------------- -``` -$ft = Get-MalwareFilterPolicy -Identity Default; $a = [System.Collections.ArrayList]($ft.FileTypes); $a; $a.RemoveAt(6); Set-MalwareFilterPolicy -Identity Default -FileTypes $a -``` - -This example modifies the malware filter policy named Default by removing an existing file type from common attachment blocking without affecting other file types that are already defined. - -The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the file type that you want to remove. - -The last two commands remove the seventh file type that's displayed in the list. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the malware filter policy you want to modify. 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Action -The Action parameter specifies the action to take when malware is detected in a message. Valid values are: - -- DeleteMessage: Deletes the message. This is the default value. - -- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces the message contents with the default alert text. - -- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces the message contents with the custom alert text specified by the AlertText parameter. - -Note: For Exchange Online Protection, any of these actions results in the message and any attachments being routed to quarantine. For more information about quarantined messages, see https://go.microsoft.com/fwlink/p/?linkid=874388. - - -```yaml -Type: DeleteMessage | DeleteAttachmentAndUseDefaultAlertText | DeleteAttachmentAndUseCustomAlertText -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminDisplayName -The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassInboundMessages -This parameter is available only in on-premises Exchange. - -The BypassInboundMessages parameter skips or enforces malware scanning on incoming messages. Valid input for this parameter is $true or $false. The default value is $false. This means malware scanning occurs on incoming messages by default. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassOutboundMessages -This parameter is available only in on-premises Exchange. - -The BypassOutboundMessages parameter skips or enforces malware scanning on outgoing messages. Valid input for this parameter is $true or $false. The default value is $false. This means malware scanning occurs on outgoing messages by default. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAlertText -The CustomAlertText parameter specifies the custom alert text to insert in the message when malware is detected and the value of the Action parameter is set to ReplaceWithCustomAlert. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomExternalBody -The CustomExternalBody parameter specifies the body of the custom notification message that's sent to an external sender when a message contains malware. This parameter is required when any of the following parameters are set to $true: - -- CustomNotifications - -- EnableExternalSenderAdminNotifications - -- EnableExternalSenderNotifications - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomExternalSubject -The CustomExternalSubject parameter specifies the subject of the custom notification message that's sent to an external sender when a message contains malware. This parameter is required when any of the following parameters are set to $true: - -- CustomNotifications - -- EnableExternalSenderAdminNotifications - -- EnableExternalSenderNotifications - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomFromAddress -The CustomFromAddress parameter specifies the From address of the custom notification message that's sent to an internal or external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomFromName -The CustomFromName parameter specifies the From name of the custom notification message that's sent to internal or external senders when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomInternalBody -The CustomInternalBody parameter specifies the body of the custom notification message that's sent to an internal sender when a message contains malware. This parameter is required when any of the following parameters are set to $true: - -- CustomNotifications - -- EnableExternalSenderAdminNotifications - -- EnableExternalSenderNotifications - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomInternalSubject -The CustomInternalSubject parameter specifies the subject of the custom notification message that's sent to an internal sender when a message contains malware. This parameter is required when any of the following parameters are set to $true: - -- CustomNotifications - -- EnableExternalSenderAdminNotifications - -- EnableExternalSenderNotifications - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomNotifications -The CustomNotifications parameter enables or disables the custom notification message to the sender when the message contains malware. Valid input for this parameter is $true or $false. The default value is $false. - -If you enable custom notification messages by setting this parameter to $true, you specify the details of the custom notification message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableExternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator when malware is detected in messages from external senders. Valid input for this parameter is $true or $false. The default value is $false. - -Specify the administrator to receive the notification messages by using the ExternalSenderAdminAddress parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableExternalSenderNotifications -The EnableExternalSenderNotifications parameter enables or disables sending notification messages to senders when malware is detected in messages from external senders. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator when malware is detected in messages from internal senders. Valid input for this parameter is $true or $false. The default value is $false. - -Specify the administrator to receive the notification messages by using the InternalSenderAdminAddress parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInternalSenderNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to senders when malware is detected in messages from internal senders. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalSenderAdminAddress -The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableExternalSenderAdminNotifications parameter is set to $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalSenderAdminAddress -The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableInternalSenderAdminNotifications parameter is set to $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeDefault -The MakeDefault switch makes this the default malware filter 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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFileFilter -The EnableFileFilter parameter enables or disables common attachment blocking. Valid values are: - -- $true: Common attachment blocking is enabled. - -- $false: Common attachment blocking is disabled. - -To configure the blocked file types, use the FileTypes parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileTypes -The FileTypes parameter specifies the file types that are blocked by common attachment blocking. The default values are: - -- ace - -- ani - -- app - -- docm - -- exe - -- jar - -- reg - -- scr - -- vbe - -- vbs - -You enable or disable common attachment blocking by using the EnableFileFilter parameter. - -Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, ps1 files are Windows PowerShell scripts, but their true type is text. - -To replace the existing list of file types with the values you specify, use the syntax \<FileType1\>,\<FileType2\>,...\<FileTypeN\>. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. - -To add or remove file types without affecting the other file type entries, see the Examples section. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZapEnabled -The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware. 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. - -- $false: ZAP for malware is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/52d1ecdd-56fc-456a-8de7-4b31521ce2a5.aspx) diff --git a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilterRule.md b/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilterRule.md deleted file mode 100644 index 1290f35df0..0000000000 --- a/exchange/exchange-ps/exchange/antispam-antimalware/Set-MalwareFilterRule.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MalwareFilterRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-MalwareFilterRule cmdlet to modify malware filter rules in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MalwareFilterRule [-Identity] <RuleIdParameter> [-Comments <String>] [-Confirm] [-DomainController <Fqdn>] - [-ExceptIfRecipientDomainIs <Word[]>] [-ExceptIfSentTo <RecipientIdParameter[]>] - [-ExceptIfSentToMemberOf <RecipientIdParameter[]>] [-MalwareFilterPolicy <MalwareFilterPolicyIdParameter>] - [-Name <String>] [-Priority <Int32>] [-RecipientDomainIs <Word[]>] [-SentTo <RecipientIdParameter[]>] - [-SentToMemberOf <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MalwareFilterRule "Contoso Recipients" -ExceptIfSentToMemberOf "Contoso Human Resources" -``` - -This example adds an exception to the malware filter rule named Contoso Recipients for members of the distribution group named Contoso Human Resources. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID, or distinguished name (DN) of the malware filter rule. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: 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 wildcard characters: False -``` - -### -Comments -The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MalwareFilterPolicy -The MalwareFilterPolicy parameter specifies the malware filter policy to apply to messages that match the conditions defined by this malware filter 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 content filter policy. - -You can't specify the default malware filter policy. And, you can't specify a malware filter policy that's already associated with another malware filter rule. - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f5d6be2b-25c4-427a-9d09-6ed55858c891.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Disable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/client-access-servers/Disable-OutlookAnywhere.md deleted file mode 100644 index a01de39781..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Disable-OutlookAnywhere.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010 -title: Disable-OutlookAnywhere -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Disable-OutlookAnywhere - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Disable-OutlookAnywhere cmdlet to disable Outlook Anywhere on a computer running Exchange Server 2010 that has the Client Access server role installed. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Disable-OutlookAnywhere [-Identity] <VirtualDirectoryIdParameter> - [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### Server -``` -Disable-OutlookAnywhere [-Server <ServerIdParameter>] - [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-OutlookAnywhere cmdlet disables Outlook Anywhere on the Exchange 2010 Client Access server. This prevents the server from accepting requests from Microsoft Office Outlook 2007 and Outlook 2003 clients from the Internet by using Outlook Anywhere. - -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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-OutlookAnywhere -Server:CAS01 -``` - -This example disables Outlook Anywhere on the Client Access server CAS01. - -### -------------------------- Example 2 -------------------------- -``` -Disable-OutlookAnywhere -Identity: "exch01\rpc (Default Web Site)" -Confirm:$false -``` - -This example disables Outlook Anywhere on the Client Access server exch01 by specifying the Identity and Confirm parameters. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the virtual directory that you want to disable. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -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 Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the name of the Client Access server to be disabled for Outlook Anywhere. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d345ef5-771e-43d5-8a15-28ac7c597d1f.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md deleted file mode 100644 index 5f373019a1..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ActiveSyncVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ActiveSyncVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ActiveSyncVirtualDirectory cmdlet to view Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-ActiveSyncVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-ActiveSyncVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncVirtualDirectory -Server "MBX01" -``` - -This example returns a summary list of all Exchange ActiveSync virtual directories on the server named MBX01. - -### -------------------------- Example 2 -------------------------- -``` -Get-ActiveSyncVirtualDirectory -Identity "MBX01\Microsoft-Server-ActiveSync*" | Format-List -``` - -This example returns detailed information for the Exchange ActiveSync virtual directory named "Microsoft-Server-ActiveSync (Default Web Site)" on the server named MBX01. - -### -------------------------- Example 3 -------------------------- -``` -Get-ActiveSyncVirtualDirectory -``` - -This example returns a summary list of all Exchange ActiveSync virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0e3f22ce-75d2-4e15-90ef-061dcc1ac7c9.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-AuthRedirect.md b/exchange/exchange-ps/exchange/client-access-servers/Get-AuthRedirect.md deleted file mode 100644 index 3bd13dcdf1..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-AuthRedirect.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AuthRedirect -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AuthRedirect - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-AuthRedirect cmdlet to view OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuthRedirect [[-Identity] <AuthRedirectIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuthRedirect -``` - -This example shows a summary list of all the OAuth redirection objects. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE | Format-List -``` - -This example shows detailed information about the OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/531fc365-3b67-4fd8-abd2-d9795c82decb.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md deleted file mode 100644 index 315edacd7c..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AutodiscoverVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AutodiscoverVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-AutodiscoverVirtualDirectory cmdlet to view Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-AutodiscoverVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-AutodiscoverVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AutodiscoverVirtualDirectory -Server MBX01 -``` - -This example returns a summary list of all Autodiscover virtual directories on the server named MBX01. - -### -------------------------- Example 2 -------------------------- -``` -Get-AutodiscoverVirtualDirectory -Identity "MBX01\Autodiscover*" | Format-List -``` - -This example returns detailed information for the Autodiscover virtual directory named "Autodiscover (Default Web Site)" on the server named MBX01. - -### -------------------------- Example 3 -------------------------- -``` -Get-AutodiscoverVirtualDirectory -``` - -This example returns a summary list of all Autodiscover virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/241011bb-e9d7-43ae-9e79-e47206a35010.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessServer.md b/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessServer.md deleted file mode 100644 index 320570204e..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessServer.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ClientAccessServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ClientAccessServer cmdlet to view settings that are associated with the Client Access server role. - -Note: In Exchange 2013 or later, use the Get-ClientAccessService cmdlet instead. If you have scripts that use Get-ClientAccessServer, update them to use Get-ClientAccessService. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ClientAccessServer [[-Identity] <ClientAccessServerIdParameter>] [-DomainController <Fqdn>] - [-IncludeAlternateServiceAccountCredentialPassword] [-IncludeAlternateServiceAccountCredentialStatus] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ClientAccessServer -``` - -This example returns a summary list of all Exchange servers in your organization that have the Client Access server role installed. - -### -------------------------- Example 2 -------------------------- -``` -Get-ClientAccessServer -Identity mail.contoso.com | Format-List -``` - -This example returns detailed information for the server mail.contoso.com. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeAlternateServiceAccountCredentialPassword -The IncludeAlternateServiceAccountCredentialPasswordswitch 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 \<ServerIdentity\> | Format-List AlternateServiceAccountConfiguration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAlternateServiceAccountCredentialStatus -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 \<ServerIdentity\> | Format-List AlternateServiceAccountConfiguration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/db492f66-cd67-420d-9479-a9499e9301b2.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessService.md b/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessService.md deleted file mode 100644 index 6f22a6135e..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-ClientAccessService.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessService -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ClientAccessService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ClientAccessService cmdlet to view settings that are associated with the Client Access server role. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ClientAccessService [[-Identity] <ClientAccessServerIdParameter>] [-DomainController <Fqdn>] - [-IncludeAlternateServiceAccountCredentialPassword] [-IncludeAlternateServiceAccountCredentialStatus] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ClientAccessService | Format-Table Name -``` - -This example returns a summary list of all Exchange servers in your organization that have theClient Access server role installed. - -### -------------------------- Example 2 -------------------------- -``` -Get-ClientAccessService -Identity mail.contoso.com | Format-List -``` - -This example returns detailed information for the server mail.contoso.com. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeAlternateServiceAccountCredentialPassword -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 \<ServerIdentity\> | Format-List AlternateServiceAccountConfiguration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAlternateServiceAccountCredentialStatus -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 \<ServerIdentity\> | Format-List AlternateServiceAccountConfiguration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b46d6c59-6e46-4089-a984-09b280dcb1ba.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-EcpVirtualDirectory.md deleted file mode 100644 index 085b54ca2c..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-EcpVirtualDirectory.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EcpVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-EcpVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-EcpVirtualDirectory cmdlet to view Exchange Control Panel (ECP) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The Exchange admin center (EAC) uses the ECP virtual directories. - -The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-EcpVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-EcpVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-EcpVirtualDirectory -Server Server01 -``` - -This example returns a summary list of all Exchange Control Panel virtual directories on the server named Server01. - -### -------------------------- Example 2 -------------------------- -``` -Get-EcpVirtualDirectory -Identity "Server01\ecp*" | Format-List -``` - -This example returns detailed information for the Exchange Control Panel virtual directory named "ecp (Default Web Site)" on the server named Server01. - -### -------------------------- Example 3 -------------------------- -``` -Get-EcpVirtualDirectory -``` - -This example returns a summary list of all Exchange Control Panel virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/afa04216-965d-4a6c-949c-170f916e8f4c.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-MapiVirtualDirectory.md deleted file mode 100644 index fc77b97290..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-MapiVirtualDirectory.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MapiVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MapiVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MapiVirtualDirectory cmdlet to view Message Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-MapiVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-MapiVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MapiVirtualDirectory -Server ContosoMail -``` - -This example returns a summary list of the MAPI virtual directories on the server named ContosoMail. - -### -------------------------- Example 2 -------------------------- -``` -Get-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" | Format-List; Get-MapiVirtualDirectory "ContosoMail\mapi (Default Web Site)" | Format-List; Get-MapiVirtualDirectory ContosoMai\mapi* | Format-List -``` - -These examples return detailed information for the MAPI virtual directory named "mapi (Default Web Site)" on the server named ContosoMail. All three commands do the same thing. - -### -------------------------- Example 3 -------------------------- -``` -Get-MapiVirtualDirectory -``` - -This example returns a summary list of all MAPI virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6837cb55-6734-4a28-9062-7227f57dafb2.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-OutlookAnywhere.md b/exchange/exchange-ps/exchange/client-access-servers/Get-OutlookAnywhere.md deleted file mode 100644 index 6ef260f4aa..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-OutlookAnywhere.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OutlookAnywhere -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-OutlookAnywhere - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-OutlookAnywhere cmdlet to view Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-OutlookAnywhere -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-OutlookAnywhere [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OutlookAnywhere -Server MBX01 -``` - -This example returns all Outlook Anywhere virtual directories on the server named MBX01. - -### -------------------------- Example 2 -------------------------- -``` -Get-OutlookAnywhere -Identity "EXCH01\Rpc (Default Web Site)" -``` - -This example returns information about the Outlook Anywhere virtual directory named Rpc on the default web siteof the server named EXCH01. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b160bc1d-7691-4b58-b85c-09759362fa99.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-OwaVirtualDirectory.md deleted file mode 100644 index aa0fa8e61d..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-OwaVirtualDirectory.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OwaVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-OwaVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-OwaVirtualDirectory cmdlet to view Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-OwaVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-OwaVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-OwaVirtualDirectory cmdlet can be run on a local server or run remotely if the server name is specified in the Identity or Server parameters. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OwaVirtualDirectory -Server Contoso -``` - -This example returns a summary list of all Outlook on the web virtual directories on the server named Contoso. - -### -------------------------- Example 2 -------------------------- -``` -Get-OwaVirtualDirectory -Identity "Contoso\owa*" | Format-List -``` - -This example returns detailed information for the Outlook on the web virtual directory named "owa (Default Web site)" on the server named Contoso. - -### -------------------------- Example 3 -------------------------- -``` -Get-OwaVirtualDirectory -``` - -This example returns a summary list of all Outlook on the web virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/63c48908-1116-4bab-8e5a-6c4dccbf3574.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md deleted file mode 100644 index 7ee5729df8..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PowerShellVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-PowerShellVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-PowerShellVirtualDirectory cmdlet to view Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-PowerShellVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-PowerShellVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PowerShellVirtualDirectory -Server Server01 -``` - -This example retrieves a summary list of all PowerShell virtual directories on the server named Server01. - -### -------------------------- Example 2 -------------------------- -``` -Get-PowerShellVirtualDirectory -Identity "Server01\PowerShell*" | Format-List -``` - -This example returns detailed information for the PowerShell virtual directory named "PowerShell (Default Web site)" on the server named Server01. - -### -------------------------- Example 3 -------------------------- -``` -Get-PowerShellVirtualDirectory -``` - -This example returns a summary list of all PowerShell virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e7c0ce81-abc3-43e8-bee6-f66656965f15.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-RpcClientAccess.md b/exchange/exchange-ps/exchange/client-access-servers/Get-RpcClientAccess.md deleted file mode 100644 index 9e93a06bf2..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-RpcClientAccess.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RpcClientAccess -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-RpcClientAccess - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-RpcClientAccess cmdlet to view the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RpcClientAccess [-DomainController <Fqdn>] [-Server <ServerIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RpcClientAccess -``` - -This example displays a summary list of the RPC Client Access service settings on all the servers in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-RpcClientAccess -Server ENT01 | Format-List -``` - -This example returns detailed information for the RPC Client Access service on the server named ENT01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server that you want to view. - -You can use any value that uniquely identifies the server. For example: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -```yaml -Type: ServerIdParameter -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3462fe0b-929d-4106-840e-99d7d1e12f40.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md deleted file mode 100644 index eeece7b407..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-WebServicesVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-WebServicesVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-WebServicesVirtualDirectory cmdlet to view Exchange Web Services (EWS) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-WebServicesVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-WebServicesVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-WebServicesVirtualDirectory cmdlet can be run on a local server or run remotely if the server name is specified in the Identity or Server parameters. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-WebServicesVirtualDirectory -ServerMBX01 -``` - -This example returns a summary list of all EWS virtual directories on the server named MBX01. - -### -------------------------- Example 2 -------------------------- -``` -Get-WebServicesVirtualDirectory -Identity "MBX01\EWS*" | Format-List -``` - -This example returns detailed information for the EWS virtual directory named "EWS (Default Web Site)" on the server named MBX01. - -### -------------------------- Example 3 -------------------------- -``` -Get-WebServicesVirtualDirectory -``` - -This example returns a summary list of all virtual directories in the client access services on all Mailbox servers in the organization. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d8babcc-ed3f-4f6a-9b34-e332996dc74a.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-AuthRedirect.md b/exchange/exchange-ps/exchange/client-access-servers/New-AuthRedirect.md deleted file mode 100644 index ed61143f99..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/New-AuthRedirect.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AuthRedirect -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-AuthRedirect - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-AuthRedirect cmdlet to create OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AuthRedirect -AuthScheme <Unknown | Bearer> -TargetUrl <String> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AuthRedirect -AuthScheme Bearer -TargetURL http://mbx01.contoso.com -``` - -This example creates an OAuth redirection object with the following settings: - -- AuthScheme: Bearer - -- TargetURL: http://mbx01.contoso.com - -## PARAMETERS - -### -AuthScheme -The AuthScheme parameter specifies the authentication scheme that's used by the authentication redirection object. Typically, this value is Bearer. - -```yaml -Type: Unknown | Bearer -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -The TargetUrl parameter specifies the FQDN of the Exchange 2013 or later server that has the Client Access server role installed that's responsible for processing the redirected OAuth authentication requests. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/66fc6568-469f-4f06-9864-841cdbf7d367.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/New-MapiVirtualDirectory.md deleted file mode 100644 index 5bf8246c69..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/New-MapiVirtualDirectory.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MapiVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-MapiVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-MapiVirtualDirectory cmdlet to create Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MapiVirtualDirectory [-Confirm] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-IISAuthenticationMethods <MultiValuedProperty>] [-InternalUrl <Uri>] [-Server <ServerIdParameter>] [-WhatIf] [-WebSiteName <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MapiVirtualDirectory -InternalUrl https://contoso.com/mapi -IISAuthenticationMethods NTLM,Negotiate,OAuth -``` - -This example creates a new MAPI virtual directory that has the following configuration: - -- Internal URL: https://contoso.com/mapi - -- IIS authentication methods: NTLM, Negotiate and OAuth. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalUrl -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://\<Domain Name\>/mapi. - -When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IISAuthenticationMethods -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 - -- Negotiate - -- NTLM - -- OAuth - -You can specify multiple values separated by commas. - -The default values are NTLM, OAuth, and Negotiate. We recommend that you always have the virtual directory configured for OAuth. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalUrl -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://\<Domain Name\>/mapi. - -When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -```yaml -Type: ServerIdParameter -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 -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebSiteName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/acb5be3d-f42b-4685-ba2a-680731281edf.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/New-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/New-PowerShellVirtualDirectory.md deleted file mode 100644 index 8ea64272ff..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/New-PowerShellVirtualDirectory.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-PowerShellVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-PowerShellVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-PowerShellVirtualDirectory cmdlet to create Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PowerShellVirtualDirectory [-Name] <String> [-BasicAuthentication <$true | $false>] [-Confirm] - [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-RequireSSL <$true | $false>] - [-Role <ClientAccess | Mailbox>] [-Server <ServerIdParameter>] [-WhatIf] - [-WindowsAuthentication <$true | $false>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PowerShellVirtualDirectory -Name "Contoso Certificates Required" -BasicAuthentication $false -WindowsAuthentication $false -CertificateAuthentication $true -``` - -This example creates a Windows PowerShell virtual directory and configures it to accept only certificate authentication. - -## 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 ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BasicAuthentication -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalUrl -The ExternalUrl parameter specifies the 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalUrl -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSSL -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -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. - -- Mailbox: Configure the virtual directory for the backend services on the Mailbox server. - -Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services. - -```yaml -Type: ClientAccess | Mailbox -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -```yaml -Type: ServerIdParameter -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 -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsAuthentication -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0310d606-eb30-45b0-ae4b-14fa9ab19cc0.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md deleted file mode 100644 index 0f8b7b3428..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ActiveSyncVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-ActiveSyncVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-ActiveSyncVirtualDirectory cmdlet to remove existing Exchange ActiveSync virtual directories from Internet Information Services (IIS) virtual directories on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ActiveSyncVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ActiveSyncVirtualDirectory contoso\Microsoft-Server-ActiveSync -``` - -This example removes the default Exchange ActiveSync virtual directory from the server Contoso. - -### -------------------------- Example 2 -------------------------- -``` -Remove-ActiveSyncVirtualDirectory contoso\Microsoft-Server-ActiveSync -Confirm $true -``` - -This example removes the default Exchange ActiveSync virtual directory from the server Contoso after confirmation is given. - -### -------------------------- Example 3 -------------------------- -``` -Remove-ActiveSyncVirtualDirectory contoso\EAS -``` - -This example removes a custom Exchange ActiveSync virtual directory from the server Contoso. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2c46293a-7703-48cc-872a-6a7065ab26db.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-AuthRedirect.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-AuthRedirect.md deleted file mode 100644 index 8e3a21d5c8..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-AuthRedirect.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AuthRedirect -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-AuthRedirect - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-AuthRedirect cmdlet to remove OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AuthRedirect [-Identity] <AuthRedirectIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE -``` - -This example removes the existing OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuthRedirect | Remove-AuthRedirect -``` - -This example removes all existing OAuth redirection objects from your organization. However, if you have only one object in your organization, this example has the same result as the first example. - -## PARAMETERS - -### -Identity -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 -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a2b95e01-1adb-4707-b1bb-99131f05ae8b.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md deleted file mode 100644 index f34eff3366..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AutodiscoverVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-AutodiscoverVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-AutodiscoverVirtualDirectory cmdlet to remove the an existing Autodiscover virtual directory from Internet Information Services (IIS). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AutodiscoverVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AutodiscoverVirtualDirectory -Identity "MBX01\autodiscover(autodiscover.contoso.com)" -``` - -This example removes the Autodiscover virtual directory from the site autodiscover.contoso.com on the server named MBX01. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/aa76264c-249c-4999-8a00-a3704a21d7f4.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-EcpVirtualDirectory.md deleted file mode 100644 index 7d513a756f..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-EcpVirtualDirectory.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-EcpVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-EcpVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-EcpVirtualDirectory cmdlet to remove Exchange Control Panel (ECP) virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers. The ECP virtual directory manages the Exchange admin center. - -The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-EcpVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-EcpVirtualDirectory -Identity "Server01\ecp (Default Web site)" -``` - -This example removes the ECP virtual directory named ecp located on the default IIS website on the Exchange server named Server01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the virtual directory that you want to remove. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -Remote removal of an ECP virtual directory isn't supported. You need run this command from the local computer. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cbf3d4ae-1a73-4bb3-9c20-47880d84f18f.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-MapiVirtualDirectory.md deleted file mode 100644 index b600d19da8..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-MapiVirtualDirectory.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MapiVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-MapiVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-MapiVirtualDirectory cmdlet to remove Message Application Programming Interface (MAPI) virtual directories from Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MapiVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" -``` - -This example removes the MAPI virtual directory from the local server named ContosoMail. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eff7df8c-3c92-4004-89dd-0a06511e8668.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-OwaVirtualDirectory.md deleted file mode 100644 index 3c0ef74c45..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-OwaVirtualDirectory.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OwaVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-OwaVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-OwaVirtualDirectory cmdlet to remove Outlook on the web virtual directories from Internet Information Services (IIS) on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OwaVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You might be required to use the Remove-OwaVirtualDirectory cmdlet in the following situations: - -- The Get-OwaVirtualDirectory cmdlet detects an Outlook on the web virtual directory deleted in IIS but not deleted in Active Directory. These abandoned Outlook on the web virtual directory objects are known as Active Directory orphans. We recommend that you remove these orphans by using the Remove-OwaVirtualDirectory cmdlet. - -- You are troubleshooting an Outlook on the web configuration issue that requires you to delete the existing Outlook on the web virtual directory and then re-create the Outlook on the web virtual directory. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OwaVirtualDirectory -Identity "EXCH01\owa (Default Web site)" -``` - -This example removes the specified Outlook on the web virtual directory from the default IIS website on the Exchange server named EXCH01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Outlook on the web virtual directory that you want to remove. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5842b6a4-aa87-4ca2-94db-87b36fd90e7e.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md deleted file mode 100644 index 4cf95c18c5..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PowerShellVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-PowerShellVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-PowerShellVirtualDirectory cmdlet to remove existing Windows PowerShell virtual directories from Internet Information Services (IIS) on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-PowerShellVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Windows 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 - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0bd826ae-e0a4-4f7a-a0f6-d861a7b8a16d.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-RpcClientAccess.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-RpcClientAccess.md deleted file mode 100644 index cc2605d2e4..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-RpcClientAccess.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010 -title: Remove-RpcClientAccess -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Remove-RPCClientAccess - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Remove-RpcClientAccess cmdlet to remove the configuration information that allows RPC access through the Client Access server role on Microsoft Exchange Server 2010. After you remove the configuration information, the Exchange RPC Client Access service stops and no longer starts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RPCClientAccess -Server <ServerIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Disabling RPC client access on a server blocks all RPC access through the specified Client Access server. Therefore, RPC clients (for example, clients running Microsoft Office Outlook 2007) with mailboxes on any mailbox databases configured to use the specified Client Access server won't be able to connect. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RpcClientAccess -Server CAS01 -``` - -This example removes the configuration information for the Exchange RPC Client Access service for the Client Access server CAS01. Performing this action also shuts down the Exchange RPC Client Access service on the Client Access server CAS01. - -## PARAMETERS - -### -Server -The Server parameter specifies the Client Access server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/92da5f1f-e65b-4995-96fe-47f53df34b48.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md deleted file mode 100644 index 084a437f21..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-WebServicesVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-WebServicesVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-WebServicesVirtualDirectory cmdlet to remove existing Exchange Web Services virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-WebServicesVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-WebServicesVirtualDirectory -Identity MBX01\Sales -``` - -This example removes the Exchange Web Services virtual directory named Sales from the server named MBX01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies Exchange Web Services virtual directory that you want to remove. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ae2ac9a4-1951-4176-baa6-06839cdd64a0.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-AuthRedirect.md b/exchange/exchange-ps/exchange/client-access-servers/Set-AuthRedirect.md deleted file mode 100644 index 7a41ce312a..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-AuthRedirect.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthRedirect -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-AuthRedirect - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-AuthRedirect cmdlet to modify the existing OAuth redirection settings for Microsoft Exchange 2010 Client Access servers in your Microsoft Exchange 2013 organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AuthRedirect [-Identity] <AuthRedirectIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-TargetUrl <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE -TargetUrl http://mbx01.contoso.com -``` - -This example sets the TargetURL value to http://mbx01.contoso.com for the existing OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuthRedirect | Set-AuthRedirect -TargetUrl http://mbx01.contoso.com -``` - -This example sets the TargetURL value for all existing OAuth redirection objects in your organization. However, if you have only one object in your organization, this example has the same result as the first example. - -## PARAMETERS - -### -Identity -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 -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: True -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 -``` - -### -TargetUrl -The TargetUrl parameter specifies the FQDN of the Exchange 2013 Client Access server that will process 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/73b1fd66-2783-4b8c-a704-9dc8ec810f29.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessServer.md b/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessServer.md deleted file mode 100644 index ed15bd3fa8..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessServer.md +++ /dev/null @@ -1,365 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ClientAccessServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-ClientAccessServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ClientAccessServer cmdlet to modify settings that are associated with the Client Access server role. - -Note: In Exchange 2013 or later, use the Set-ClientAccessService cmdlet instead. If you have scripts that use Set-ClientAccessServer, update them to use Set-ClientAccessService. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AlternateServiceAccount -``` -Set-ClientAccessServer [-Identity] <ClientAccessServerIdParameter> - [-AlternateServiceAccountCredential <PSCredential[]>] - [-CleanUpInvalidAlternateServiceAccountCredentials] - [-Confirm] - [-DomainController <Fqdn>] - [-IrmLogEnabled <$true | $false>] - [-IrmLogMaxAge <EnhancedTimeSpan>] - [-IrmLogMaxDirectorySize <Unlimited>] - [-IrmLogMaxFileSize <ByteQuantifiedSize>] - [-IrmLogPath <LocalLongFullPath>] - [-IsOutOfService <$true | $false>] - [-RemoveAlternateServiceAccountCredentials] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-ClientAccessServer [-Identity] <ClientAccessServerIdParameter> - [-Array <ClientAccessArrayIdParameter>] - [-AutoDiscoverServiceInternalUri <Uri>] - [-AutoDiscoverSiteScope <MultiValuedProperty>] - [-Confirm] - [-DomainController <Fqdn>] - [-IrmLogEnabled <$true | $false>] - [-IrmLogMaxAge <EnhancedTimeSpan>] - [-IrmLogMaxDirectorySize <Unlimited>] - [-IrmLogMaxFileSize <ByteQuantifiedSize>] - [-IrmLogPath <LocalLongFullPath>] - [-IsOutOfService <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ClientAccessServer -Identity "MBX-01" -AutoDiscoverServiceInternalUri "https://mbx01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" -``` - -This example configures the internal Autodiscover URL for the Active Directory site named Mail in the client access services on the server named MBX-01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- FQDN - -- GUID - -```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AlternateServiceAccountCredential -The AlternateServiceAccountCredential parameter specifies a credential an alternative service account that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential[] -Parameter Sets: AlternateServiceAccount -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 -``` - -### -Array -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDiscoverServiceInternalUri -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDiscoverSiteScope -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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -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 -``` - -### -CleanUpInvalidAlternateServiceAccountCredentials -The CleanUpInvalidAlternateServiceAccountCredentialsswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -IrmLogEnabled -This parameter is available or functional only in Exchange Server 2010. - -The IrmLogEnabled parameter specifies whether logging is enabled for Information Rights Management (IRM). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogMaxAge -This parameter is available or functional only in Exchange Server 2010. - -The IrmLogMaxAge parameter specifies the max age for IRM logs. Logs older than the specified value are deleted. - -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 a 15-hour interval, enter 15:00:00. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogMaxDirectorySize -This parameter is available or functional 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. - -A value of unlimited means no limit for the maximum directory size for the IRM logs. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogMaxFileSize -This parameter is available or functional 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. - -```yaml -Type: ByteQuantifiedSize -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogPath -This parameter is available or functional only in Exchange Server 2010. - -The IrmLogPath parameter specifies the path to the log file. - -```yaml -Type: LocalLongFullPath -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsOutOfService -This parameter is available or functional only in Exchange Server 2010. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAlternateServiceAccountCredentials -The RemoveAlternateServiceAccountCredentialsswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ee636e80-7111-4d99-8d48-db200d1f78d3.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessService.md b/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessService.md deleted file mode 100644 index 58b5536823..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-ClientAccessService.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019 -title: Set-ClientAccessService -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-ClientAccessService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ClientAccessService cmdlet to modify settings that are associated with the Client Access server role. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AlternateServiceAccount -``` -Set-ClientAccessService [-Identity] <ClientAccessServerIdParameter> [-AlternateServiceAccountCredential <PSCredential[]>] [-CleanUpInvalidAlternateServiceAccountCredentials] [-RemoveAlternateServiceAccountCredentials] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-ClientAccessService [-Identity] <ClientAccessServerIdParameter> [-Array <ClientAccessArrayIdParameter>] [-AutoDiscoverServiceInternalUri <Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ClientAccessService -Identity "MBX-01" -AutoDiscoverServiceInternalUri "https://mbx01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" -``` - -This example configures the internal Autodiscover URL for the Active Directory site named Mail in the Client Access service on the server named MBX-01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- FQDN - -- GUID - -```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AlternateServiceAccountCredential -The AlternateServiceAccountCredential parameter specifies an alternative service account that'stypically used for Kerberos authentication in Exchange Server 2010 coexistence environments. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential[] -Parameter Sets: AlternateServiceAccount -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Array -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDiscoverServiceInternalUri -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDiscoverSiteScope -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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CleanUpInvalidAlternateServiceAccountCredentials -The CleanUpInvalidAlternateServiceAccountCredentialsswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAlternateServiceAccountCredentials -The RemoveAlternateServiceAccountCredentialsswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/59440ef8-8ea4-4168-9b75-8f4d7aa6652d.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Set-MapiVirtualDirectory.md deleted file mode 100644 index 255e831bb0..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-MapiVirtualDirectory.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MapiVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-MapiVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-MapiVirtualDirectory cmdlet to modify Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MapiVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-ApplyDefaults <$true | $false>] [-Confirm] - [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-IISAuthenticationMethods <MultiValuedProperty>] [-InternalUrl <Uri>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" -InternalUrl https://contoso.com/mapi -IISAuthenticationMethods NTLM,Negotiate,OAuth -``` - -This example makes the following configuration changes to the MAPI virtual directory on the default web site of the server named ContosoMail: - -- Internal URL: https://contoso/mapi. - -- IIS authentication methods: NTLM, Negotiate, and OAuth. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the MAPI virtual directory that you want to configure. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ApplyDefaults -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalUrl -The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. - -This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax https://\<Domain Name\>/mapi. - -When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IISAuthenticationMethods -The IISAuthenticationMethods parameter specifies the authentication methods that are enabled on the virtual directory in Internet Information Services (IIS). Valid values are: - -- Basic - -- Negotiate - -- NTLM - -- OAuth - -You can specify multiple values separated by commas. - -The default values are NTLM, OAuth, and Negotiate. We recommend that you always have the virtual directory configured for OAuth. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalUrl -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://\<Domain Name\>/mapi. - -When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c9308fe6-3b61-4d99-a5f2-ef47abbc7656.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md deleted file mode 100644 index c6fba04fa0..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PowerShellVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-PowerShellVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-PowerShellVirtualDirectory cmdlet to modify existing Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-PowerShellVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> - [-BasicAuthentication <$true | $false>] [-CertificateAuthentication <$true | $false>] [-Confirm] - [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] - [-RequireSSL <$true | $false>] [-WhatIf] [-WindowsAuthentication <$true | $false>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-PowerShellVirtualDirectory "Contoso (default Web site)" -ExternalUrl "http://www.contoso.com/powershell" -``` - -This example modifies the external URL of the Contoso Windows PowerShell virtual directory. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Windows PowerShell virtual directory that you want to modify. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BasicAuthentication -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. - -- $false: Basic authentication is disabled. - -```yaml -Type: $true | $false -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 -``` - -### -CertificateAuthentication -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: $true | $false -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 -``` - -### -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 -``` - -### -ExternalUrl -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalUrl -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSSL -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: $true | $false -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 -``` - -### -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 -``` - -### -WindowsAuthentication -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. - -- $false: Integrated Windows authentication is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8546bd54-892f-422e-9fc9-2c4293e2fd01.aspx) diff --git a/exchange/exchange-ps/exchange/client-access-servers/Set-RpcClientAccess.md b/exchange/exchange-ps/exchange/client-access-servers/Set-RpcClientAccess.md deleted file mode 100644 index bf2c43c335..0000000000 --- a/exchange/exchange-ps/exchange/client-access-servers/Set-RpcClientAccess.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RpcClientAccess -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-RpcClientAccess - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-RpcClientAccess cmdlet to modify the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-RpcClientAccess -Server <ServerIdParameter> [-BlockedClientVersions <String>] [-Confirm] - [-DomainController <Fqdn>] [-EncryptionRequired <$true | $false>] [-MaximumConnections <Int32>] - [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Outlook 2007 isn't supported in Exchange 2016, so you shouldn't see Outlook connections at or below version 12.Y.Z. However, you should monitor the RPC Client Access log to see the client versions that are connecting to your Exchange servers before you block any client versions. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RpcClientAccess -Server MBX01 -BlockedClientVersions 14.0.0-14.32767.65535 -``` - -This example prevents Outlook Anywhere connections by Outlook 2010 clients on the server named MBX01. - -### -------------------------- Example 2 -------------------------- -``` -Set-RpcClientAccess -Server MBX01 -BlockedClientVersions 15.0.0-15.4737.999 -``` - -This example prevents Outlook Anywhere connections by Outlook 2013 clients that don't have KB3054940 installed (version 15.0.4737.1000) on the server named MBX01. - -Note: You can determine specific client software versions by parsing the RPC Client Access log files located at %ExchangeInstallPath%Logging\\RPC Client Access. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that you want to modify. - -You can use any value that uniquely identifies the server. For example: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BlockedClientVersions -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. - -- X is the major version number. For example, Outlook 2016 is 16, Outlook 2013 is 15, and Outlook 2010 is 14. - -- Y is the minor revision number, and must be less than or equal to 32767. - -- Z is the build number, and must be less than or equal to 65535. - -You can specify ranges. For example, -13.32767.65535, 14.0.0-14.32767.65535, or 15.0.0-. - -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. - -```yaml -Type: String -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 -``` - -### -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 -``` - -### -EncryptionRequired -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. - -- $false: Unencrypted RPC client connections are allowed. - -```yaml -Type: $true | $false -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 -``` - -### -MaximumConnections -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. - -```yaml -Type: Int32 -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b606d241-aecd-4bb9-a34f-6dd6b02a712c.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Clear-TextMessagingAccount.md b/exchange/exchange-ps/exchange/client-access/Clear-TextMessagingAccount.md deleted file mode 100644 index f73d6ce968..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Clear-TextMessagingAccount.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-TextMessagingAccount -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -The Clear-TextMessagingAccount cmdlet allows a user to remove the text messaging settings from their own mailbox. An administrator can't use this cmdlet to remove the text messaging settings from another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Clear-TextMessagingAccount [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Clear-TextMessagingAccount -Identity tony@contoso.com -``` - -This example clears the text messaging account settings and notification settings from Tony's mailbox. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the target mailbox. You can any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ebc17689-0c30-4d0b-9a53-d81a909458d3.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Compare-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/client-access/Compare-TextMessagingVerificationCode.md deleted file mode 100644 index 6289895ad3..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Compare-TextMessagingVerificationCode.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Compare-TextMessagingVerificationCode -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Compare-TextMessagingVerificationCode cmdlet to verify the text messaging verification code that the user specified. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Compare-TextMessagingVerificationCode [[-Identity] <MailboxIdParameter>] -VerificationCode <String> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Compare-TextMessagingVerificationCode cmdlet returns true if the code matches the stored code generated by the Send-TextMessagingVerificationCode 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Compare-TextMessagingVerificationCode -Identity TonySmith -VerificationCode 111555 -``` - -This example compares the verification code 111555 to the code sent to Tony Smith's mobile phone. - -### -------------------------- Example 2 -------------------------- -``` -Compare-TextMessagingVerificationCode -Identity tony@contoso.com -VerificationCode 123456 -``` - -This example compares the verification code 123456 to the code sent to Tony Smith's mobile phone. - -### -------------------------- Example 3 -------------------------- -``` -Compare-TextMessagingVerificationCode -Identity TonySmith -VerificationCode 111555 -Confirm $true -``` - -This example compares the verification code 111555 to the code sent to Tony Smith's mobile phone after confirmation is given. - -## PARAMETERS - -### -VerificationCode -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox ID for the user. - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/aef03828-bd6b-4bd4-9aaf-56d4fc5872d5.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Disable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/client-access/Disable-PushNotificationProxy.md deleted file mode 100644 index 96b8d7e679..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Disable-PushNotificationProxy.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-PushNotificationProxy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-PushNotificationProxy - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-PushNotificationProxy cmdlet to disable the push notification proxy that's configured between an on-premises Microsoft Exchange organization and a Microsoft Office 365 organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-PushNotificationProxy [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The push notification proxy relays event notifications (for example, new email or calendar updates) for on-premises mailboxes through Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-PushNotificationProxy -``` - -This example disables the push notification proxy in the on-premises Exchange organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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 -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/917432cc-85d6-4505-9608-51ce0608eb6e.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Enable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/client-access/Enable-PushNotificationProxy.md deleted file mode 100644 index 7266d2d4e7..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Enable-PushNotificationProxy.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-PushNotificationProxy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-PushNotificationProxy - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-PushNotificationProxy cmdlet to enable a push notification proxy between an on-premises Microsoft Exchange organization and a Microsoft Office 365 organization. - -In order for event notifications to be successfully delivered, you also need to configure OAuth authentication between your on-premises Exchange organization and your Office 365 organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-PushNotificationProxy [-Confirm] [-Organization <String>] [-Uri <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The push notification proxy relays event notifications (for example, new email or calendar updates) for on-premises mailboxes through Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-PushNotificationProxy -WhatIf -``` - -This example displays the status of the push notification proxy in the on-premises Exchange organization. - -### -------------------------- Example 2 -------------------------- -``` -Enable-PushNotificationProxy -Organization contoso.com -``` - -This example enables the push notification proxy in the on-premises Exchange organization by using the Office 365 organization contoso.com. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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 -``` - -### -Organization -The Organization parameter specifies the domain name of the Office 365 organization. For example, contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -The Uri parameter specifies the push notification service endpoint in Office 365. The default value is https://outlook.office365.com/PushNotifications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fe3df1ee-a02c-4b9d-ab7a-706cfa7f765c.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Export-AutoDiscoverConfig.md b/exchange/exchange-ps/exchange/client-access/Export-AutoDiscoverConfig.md deleted file mode 100644 index 25033d5100..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Export-AutoDiscoverConfig.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-AutoDiscoverConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Export-AutoDiscoverConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Export-AutoDiscoverConfig cmdlet to create or update a service connection point for an Autodiscover service pointer in a target Exchange forest on an Exchange Server 2016 server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-AutoDiscoverConfig -TargetForestDomainController <String> [-Confirm] [-DeleteConfig <$true | $false>] - [-DomainController <Fqdn>] [-MultipleExchangeDeployments <$true | $false>] [-PreferredSourceFqdn <Fqdn>] - [-SourceForestCredential <PSCredential>] [-TargetForestCredential <PSCredential>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Autodiscover service connection point pointer resides in Active Directory and contains the names of the Exchange Web Services URLs. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Export-AutoDiscoverConfig -TargetForestDomainController targetForestName -``` - -This example creates a service connection point object to connect to another Active Directory forest so that Outlook 2010 clients can automatically connect to their mailbox without having to set up a profile. - -### -------------------------- Example 2 -------------------------- -``` -Export-AutoDiscoverConfig -TargetForestDomainController targetForestName -MultipleExchangeDeployments $true -``` - -This example specifies that Exchange 2016 is deployed in more than one Active Directory forest while establishing an Autodiscover service connection point to the target domain controller in another Active Directory forest. - -## PARAMETERS - -### -TargetForestDomainController -The TargetForestDomainController parameter specifies the domain controller that you want to export the Autodiscover configuration to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -DeleteConfig -The DeleteConfig parameter causes the command to delete your configuration settings on the service connection point object. - -```yaml -Type: $true | $false -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 -``` - -### -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 -``` - -### -MultipleExchangeDeployments -The MultipleExchangeDeployments parameter specifies whether multiple Exchange deployments exist. This setting should be set to $true only if Exchange 2016 is deployed in more than one Active Directory forest, and the forests are connected. If set to $true, the list of authoritative accepted domains for the source forest is written to the Autodiscover service connection point object. Outlook 2010 clients use this object to select the most appropriate forest to search for the Autodiscover service. - -```yaml -Type: $true | $false -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 -``` - -### -PreferredSourceFqdn -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceForestCredential -The SourceForestCredential parameter specifies the credentials to use when connecting to the source forest. - -```yaml -Type: PSCredential -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 -``` - -### -TargetForestCredential -The TargetForestCredential parameter specifies the credentials to use to connect to the target forest. - -```yaml -Type: PSCredential -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/70733d70-7e35-4c60-b0f8-47a00b894fd1.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-CASMailbox.md b/exchange/exchange-ps/exchange/client-access/Get-CASMailbox.md deleted file mode 100644 index 3cdfd26be7..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-CASMailbox.md +++ /dev/null @@ -1,519 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CASMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-CASMailbox cmdlet to view the Client Access settings that are configured on mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-CASMailbox [-Anr <String>] - [-ActiveSyncDebugLogging] - [-ActiveSyncSuppressReadReceipt] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ProtocolSettings] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-ReadIsOptimizedForAccessibility] - [-RecalculateHasActiveSyncDevicePartnership] [<CommonParameters>] -``` - -### Identity -``` -Get-CASMailbox [[-Identity] <MailboxIdParameter>] - [-ActiveSyncDebugLogging] - [-ActiveSyncSuppressReadReceipt] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ProtocolSettings] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-ReadIsOptimizedForAccessibility] - [-RecalculateHasActiveSyncDevicePartnership] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CASMailbox "Jeff Hay" -``` - -This example returns the values of the following client access settings for the user named Jeff Hay. - -- ActiveSyncEnabled - -- OWAEnabled - -- PopEnabled - -- ImapEnabled - -- MapiEnabled - -### -------------------------- Example 2 -------------------------- -``` -Get-CASMailbox tony@contoso.com | Format-List Imap* -``` - -This example returns all IMAP4 settings for the user tony@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Get-CASMailbox chris@contoso.com | Format-List Ews* -``` - -This example returns all Exchange Web Services settings for the user chris@contoso.com. - -## PARAMETERS - -### -ActiveSyncDebugLogging -The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. If you don't use this switch, the value always appears as $false. - -To see this value, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncSuppressReadReceipt -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- ActiveSyncAllowedDeviceIDs - -- ActiveSyncBlockedDeviceIDs - -- ActiveSyncDebugLogging - -- ActiveSyncEnabled - -- ActiveSyncMailboxPolicy - -- ActiveSyncSuppressReadReceipt - -- DisplayName - -- DistinguishedName - -- ECPEnabled - -- EmailAddresses - -- EwsApplicationAccessPolicy - -- EwsEnabled - -- ExchangeVersion - -- Guid - -- HasActiveSyncDevicePartnership - -- Id - -- ImapEnabled - -- LegacyExchangeDN - -- MAPIEnabled - -- Name - -- ObjectCategory - -- ObjectClass - -- OWAEnabled - -- OWAforDevicesEnabled - -- OwaMailboxPolicy - -- PopEnabled - -- PrimarySmtpAddress - -- SamAccountName - -- ServerLegacyDN - -- ServerName - -- WhenChanged - -- WhenChangedUTC - -- WhenCreated - -- WhenCreatedUTC - -For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Monitoring -This parameter is available only in on-premises Exchange. - -The Monitoring switch includes mailboxes that were created by monitoring accounts in the results. By default, these mailboxes aren't included in the results. You don't have 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtocolSettings -The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: - -- ExternalImapSettings - -- InternalImapSettings - -- ExternalPopSettings - -- InternalPopSettings - -- ExternalSmtpSettings - -- InternalSmtpSettings - -To see these values, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadIsOptimizedForAccessibility -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecalculateHasActiveSyncDevicePartnership -The RecalculateHasActiveSyncDevicePartnership switch recalculates the value of the HasActiveSyncDevicePartnership property on the mailbox. The value is automatically updated if it's found to be incorrect. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- ServerLegacyDN - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d80a5990-9106-4eb8-bba8-b3975805c325.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-CASMailboxPlan.md b/exchange/exchange-ps/exchange/client-access/Get-CASMailboxPlan.md deleted file mode 100644 index 73bcb97aa4..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-CASMailboxPlan.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Get-CASMailboxPlan -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CASMailboxPlan - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-CASMailboxPlan cmdlet to view Client Access services (CAS) mailbox plans in the cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CASMailboxPlan [[-Identity] <MailboxPlanIdParameter>] [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope] - [-ResultSize <Unlimited>] [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -CAS mailbox plans control client access settings for all mailboxes that have the plans assigned to them (for example, Exchange ActiveSync, POP, IMAP, and Outlook on the web 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CASMailboxPlan | Format-Table -Auto DisplayName,ActiveSyncEnabled,ImapEnabled,PopEnabled,OwaMailboxPolicy -``` - -This example returns a summary list of all CAS mailbox plans in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CASMailboxPlan -Identity ExchangeOnlineEnterprise -``` - -This example returns detailed information about the CAS mailbox plan named ExchangeOnlineEnterprise. - -## PARAMETERS - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the CAS mailbox plan that you want to view. You can use any value that uniquely identifies the CAS mailbox plan. For example: - -- Name - -- Display Name - -- Distinguished name (DN) - -- GUID - -Typically, the name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise). - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following attributes: - -- Display name - -- Name - -The results are sorted in ascending order. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c8df374b-db7c-4dbc-b6d5-3ffcbbe4274b.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-ClientAccessRule.md b/exchange/exchange-ps/exchange/client-access/Get-ClientAccessRule.md deleted file mode 100644 index eb6a41f4a9..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-ClientAccessRule.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2019, Exchange Online -title: Get-ClientAccessRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2019 || exchonline-ps" ---- - -# Get-ClientAccessRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ClientAccessRule [[-Identity] <ClientAccessRuleIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ClientAccessRule -``` - -This example shows a summary list of all client access rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-ClientAccessRule "Block Client Connections from 192.168.1.0/24" | Format-List -``` - -This example retrieves details about the client access rule named "Block Client Connections from 192.168.1.0/24". - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ClientAccessRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4787d6dc-d38b-427a-83f8-7c57d604dff0.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-ImapSettings.md b/exchange/exchange-ps/exchange/client-access/Get-ImapSettings.md deleted file mode 100644 index e8443559b6..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-ImapSettings.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ImapSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ImapSettings - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ImapSettings cmdlet to view the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This is the client access (frontend) IMAP4 service that clients connect to. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ImapSettings [-DomainController <Fqdn>] [-Server <ServerIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IMAPSettings -Server MBX01 -``` - -This example displays the settings and values of the Microsoft Exchange IMAP4 service that's running on the server named MBX01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/172e1a14-bd90-4010-abd9-e4878b4213a2.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/client-access/Get-MailboxCalendarConfiguration.md deleted file mode 100644 index 35a47afdfa..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-MailboxCalendarConfiguration.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxCalendarConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxCalendarConfiguration cmdlet to show the calendar settings for a specified mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxCalendarConfiguration [-Identity] <MailboxIdParameter> [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-MailboxCalendarConfiguration cmdlet returns settings for the calendar of the specified mailbox, including the following: - -- Workdays: Days that appear in the calendar as work days in Outlook on the web - -- WorkingHoursStartTime: Time that the calendar work day starts - -- WorkingHoursEndTime: Time that the calendar work day ends - -- WorkingHoursTimeZone: Time zone set on the mailbox for the working hours start and end times - -- WeekStartDay: First day of the calendar work week - -- ShowWeekNumbers: Number for each week ranging from 1 through 52 for the calendar while in month view in Outlook on the web - -- TimeIncrement: Increments in minutes in which the calendar displays time in Outlook on the web - -- RemindersEnabled: Whether Outlook on the web provides a visual cue when a calendar reminder is due - -- ReminderSoundEnabled: Whether a sound is played when a calendar reminder is due - -- DefaultReminderTime: Length of time before each meeting or appointment that the calendar in Outlook on the web shows the reminder - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxCalendarConfiguration -Identity kai | Format-List -``` - -This example retrieves all the calendar settings for Kai's mailbox where the Identity parameter is specified in the alias format. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxCalendarConfiguration -Identity contoso\tony -``` - -This example uses the Identity parameter specified in the domain\\account format and returns the calendar settings for Tony's mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxCalendarConfiguration -Identity kai -DomainController DC1 -``` - -This example requests that the domain controller DC1 retrieves calendar settings for Kai's mailbox from Active Directory. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2a794a69-3029-49df-920c-5d91ecdb057e.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/client-access/Get-MailboxMessageConfiguration.md deleted file mode 100644 index c1e1387f48..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-MailboxMessageConfiguration.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxMessageConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxMessageConfiguration cmdlet to view the Outlook on the web settings that are applied to specific mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxMessageConfiguration [-Identity] <MailboxIdParameter> [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-MailboxMessageConfiguration cmdlet shows Outlook on the web settings for the specified mailbox. These settings are not used in Microsoft Outlook, Microsoft Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. Settings that contain the word Mobile are applied in Microsoft Outlook on the web for devices only. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxMessageConfiguration tony@contoso.com -``` - -This example returns the Outlook on the web settings for Tony's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxMessageConfiguration tony@contoso.com -DomainController DC1 -``` - -This example returns the Outlook on the web settings for Tony's mailbox and specifies the domain controller that's used to get those settings. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name and password to use to access the mailbox. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c9929748-cd71-43c0-b1d9-a7f6cd2da99a.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/client-access/Get-MailboxRegionalConfiguration.md deleted file mode 100644 index 7ebb069ce1..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-MailboxRegionalConfiguration.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRegionalConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxRegionalConfiguration cmdlet to view the regional settings of a mailbox. You can view the date format, time format, time zone, and language of the mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxRegionalConfiguration [-Identity] <MailboxIdParameter> [-DomainController <Fqdn>] - [-VerifyDefaultFolderNameLanguage] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxRegionalConfiguration -Identity "Marcelo Teixeira" -``` - -This example returns the regional settings for Marcelo Teixeira's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxRegionalConfiguration -Identity "Ella Lack" -DomainController dc01.contoso.com -``` - -In on-premises Exchange, this example returns the regional settings for Ella Lack's mailbox by using the specified domain controller. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxRegionalConfiguration -Identity "Alice Jakobsen" -VerifyDefaultFolderNameLanguage | Format-List -``` - -This example returns the regional settings for Alice Jakobsen's mailbox and also indicates whether the default folder names of the mailbox are localized in the locale that's specified for the mailbox. The important properties are Language and DefaultFolderNameMatchingUserLanguage. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VerifyDefaultFolderNameLanguage -The VerifyDefaultFolderNameLanguage switch verifies that the default folder names are localized in the language that's specified for the mailbox (the Language property value). You don't need to specify a value with this switch. - -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: - -- Get-MailboxRegionalConfiguration -Identity \<MailboxIdentity\> -VerifyDefaultFolderNameLanguage | Format-List - -Or - -- Get-MailboxRegionalConfiguration -Identity \<MailboxIdentity\> -VerifyDefaultFolderNameLanguage | Format-Table Language,DefaultFolderNameMatchingUserLanguage - -If you view the DefaultFolderNameMatchingUserLanguage property without using the VerifyDefaultFolderNameLanguage switch, the value is always $false, even if the default folder names are localized in the language that's specified for the mailbox. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2a50a165-5830-4771-8968-a13ab057532a.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/client-access/Get-MailboxSpellingConfiguration.md deleted file mode 100644 index 606f479f86..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-MailboxSpellingConfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxSpellingConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxSpellingConfiguration cmdlet to retrieve the Outlook on the web spelling checker settings of a specified user. For example, users can set their dictionary language and configure the spelling checker to ignore mixed digits and words in all uppercase. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxSpellingConfiguration [-Identity] <MailboxIdParameter> [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-MailboxSpellingConfiguration cmdlet is primarily used to populate the spelling checker settings for end users in Outlook on the web. Administrators can also view users' settings by running this cmdlet. The following spelling checker settings are retrieved by the cmdlet for the specified mailbox: - -- Identity: This setting specifies the mailbox identity. - -- CheckBeforeSend: This setting specifies whether Outlook on the web checks the spelling of every message when the user clicks Send in the new message form. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxSpellingConfiguration -Identity Tony -``` - -This example retrieves the Outlook on the web options of user Tony. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxSpellingConfiguration -Identity Tony -DomainController DC1 -``` - -This example returns the Outlook on the web spelling checker options for Tony's mailbox by specifying domain controller DC1 to get the information from Active Directory. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxSpellingConfiguration -Identity contoso\tony -``` - -This example returns the Outlook on the web spelling checker options for Tony's mailbox by specifying the identity of the mailbox in the format domain\\account. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7695cde3-71d2-4523-8300-ada77cb8e7d4.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-OutlookProvider.md b/exchange/exchange-ps/exchange/client-access/Get-OutlookProvider.md deleted file mode 100644 index e85ccb8aae..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-OutlookProvider.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OutlookProvider -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-OutlookProvider - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-OutlookProvider cmdlet to obtain the global settings from the AutoDiscoverConfig object under the Global Settings object in Active Directory. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OutlookProvider [[-Identity] <OutlookProviderIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OutlookProvider -``` - -This example returns a summary list of all available Outlook providers. - -### -------------------------- Example 2 -------------------------- -``` -Get-OutlookProvider -Identity WEB | Format-List -``` - -This example returns detailed information for the Outlook provider named WEB. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the ADIDParameter value of the MAPI protocol that you want to view. Typical values are: - -- EXCH - -- EXPR - -- WEB - -```yaml -Type: OutlookProviderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cb46009b-ee6c-4c84-8534-4fb74c32d2eb.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/client-access/Get-OwaMailboxPolicy.md deleted file mode 100644 index 5b7d08a2a0..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-OwaMailboxPolicy.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OwaMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-OwaMailboxPolicy cmdlet to view Outlook on the web mailbox policies in the organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OwaMailboxPolicy [[-Identity] <MailboxPolicyIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OwaMailboxPolicy -``` - -This example retrieves a summary list of all mailbox policies in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-OwaMailboxPolicy -Identity Executives | Format-List -``` - -This example retrieves detailed information for the mailbox policy named Executives. - -### -------------------------- Example 3 -------------------------- -``` -Get-OwaMailboxPolicy -Identity Proseware\Contoso\Corporate -``` - -This example retrieves the information for the mailbox policy named Corporate for the tenant Contoso in the organization Proseware. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bdd580d3-8812-4b4a-93e8-c6401b0d2f0f.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-PopSettings.md b/exchange/exchange-ps/exchange/client-access/Get-PopSettings.md deleted file mode 100644 index 3498044159..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-PopSettings.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PopSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-PopSettings - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-POPSettings cmdlet to view the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed and is used by POP3 clients to connect to Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PopSettings [-DomainController <Fqdn>] [-Server <ServerIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-POPSettings -``` - -This example returns a summary list of the configuration of the Microsoft Exchange POP3 service on the local server. - -### -------------------------- Example 2 -------------------------- -``` -Get-POPSettings -Server MBX01 | Format-List -``` - -This example returns detailed information for the Microsoft Exchange POP3 service on the server named MBX01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/30bd001f-d923-4936-a997-f005a392302e.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Get-TextMessagingAccount.md b/exchange/exchange-ps/exchange/client-access/Get-TextMessagingAccount.md deleted file mode 100644 index 886daa1a33..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Get-TextMessagingAccount.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-TextMessagingAccount -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-TextMessagingAccount cmdlet to return a user's Short Message Service (SMS) settings. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TextMessagingAccount [-Identity] <MailboxIdParameter> [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-TextMessagingAccount cmdlet displays the SMS settings for a specific user. These settings include whether Exchange ActiveSync is enabled, the user's country or region ID, mobile operator ID, service provider ID and notification phone number. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TextMessagingAccount -Identity tony@contoso.com -``` - -This example returns the text messaging settings for Tony's mailbox. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2d692e94-1b64-4bdf-b486-31f11110fb31.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/client-access/New-ClientAccessRule.md deleted file mode 100644 index a0693e23d0..0000000000 --- a/exchange/exchange-ps/exchange/client-access/New-ClientAccessRule.md +++ /dev/null @@ -1,507 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2019, Exchange Online -title: New-ClientAccessRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2019 || exchonline-ps" ---- - -# New-ClientAccessRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ClientAccessRule [-Name] <String> -Action <AllowAccess | DenyAccess> - [-AnyOfAuthenticationTypes <MultiValuedProperty>] [-AnyOfClientIPAddressesOrRanges <MultiValuedProperty>] - [-AnyOfProtocols <MultiValuedProperty>] [-Confirm] [-DatacenterAdminsOnly <$true | $false>] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExceptAnyOfAuthenticationTypes <MultiValuedProperty>] - [-ExceptAnyOfClientIPAddressesOrRanges <MultiValuedProperty>] [-ExceptAnyOfProtocols <MultiValuedProperty>] - [-ExceptUsernameMatchesAnyOfPatterns <MultiValuedProperty>] [-Priority <Int32>] [-Scope <All | Users>] - [-UsernameMatchesAnyOfPatterns <MultiValuedProperty>] [-UserRecipientFilter <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. - -Note: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: - -- OutlookWebApp: BasicAuthentication and AdfsAuthentication. - -- ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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). - -### -------------------------- Example 2 -------------------------- -``` -New-ClientAccessRule -Name "Block ActiveSync" -Action DenyAccess -AnyOfProtocols ExchangeActiveSync -ExceptAnyOfClientIPAddressesOrRanges 192.168.10.1/24 -``` - -This example creates a new client access rule named Block ActiveSync that blocks access for Exchange ActiveSync clients, except for clients in the IP address range 192.168.10.1/24. - -## PARAMETERS - -### -Action -The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. - -```yaml -Type: AllowAccess | DenyAccess -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the client access rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfAuthenticationTypes -This parameter is available 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. - -Valid values for this parameter are: - -- AdfsAuthentication - -- BasicAuthentication - -- CertificateBasedAuthentication - -- NonBasicAuthentication - -- OAuthAuthentication - -You can enter multiple values separated by commas. Don't use quotation marks. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfClientIPAddressesOrRanges -The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IP address. Valid values for this parameter are: - -- A single IP address: For example, 192.168.1.1. - -- An IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24. - -You can enter multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfProtocols -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: - -- ExchangeActiveSync - -- ExchangeAdminCenter - -- ExchangeWebServices - -- IMAP4 - -- OfflineAddressBook - -- OutlookAnywhere - -- OutlookWebApp - -- POP3 - -- PowerShellWebServices - -- RemotePowerShell - -- REST - -- UniversalOutlook (Mail and Calendar app) - -**Note**: In Exchange 2019, the only supported values are ExchangeAdminCenter and RemotePowerShell. - -You can enter multiple values separated by commas. Don't use quotation marks. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatacenterAdminsOnly -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptAnyOfAuthenticationTypes -This parameter is available 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. - -Valid values for this parameter are: - -- AdfsAuthentication - -- BasicAuthentication - -- CertificateBasedAuthentication - -- NonBasicAuthentication - -- OAuthAuthentication - -You can enter multiple values separated by commas. Don't use quotation marks. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptAnyOfClientIPAddressesOrRanges -The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IP address. Valid values for this parameter are: - -- A single IP address: For example, 192.168.1.1. - -- An IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24. - -You can enter multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptAnyOfProtocols -This parameter is available 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. - -Valid values for this parameter are: - -- ExchangeActiveSync - -- ExchangeAdminCenter - -- ExchangeWebServices - -- IMAP4 - -- OfflineAddressBook - -- OutlookAnywhere - -- OutlookWebApp - -- POP3 - -- PowerShellWebServices - -- RemotePowerShell - -- REST - -- UniversalOutlook (Mail and Calendar app) - -You can enter multiple values separated by commas. Don't use quotation marks. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptUsernameMatchesAnyOfPatterns -This parameter is available 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 \<Domain\>\\\<UserName\> (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. - -You can enter multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -The Scope parameter specifies the scope of the client access rule. Valid values are: - -- Users: The rule only applies to end-user connections. - -- All: The rule applies to all connections (end-users and middle-tier apps). - -```yaml -Type: All | Users -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsernameMatchesAnyOfPatterns -This parameter is available 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 \<Domain\>\\\<UserName\> (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. - -You can enter multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -UserRecipientFilter -This parameter is available 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. For example, {City -eq "Redmond"}. The filterable attributes that you can use with this parameter are: - -- City - -- Company - -- CountryOrRegion - -- CustomAttribute1-15 - -- Department - -- Office - -- PostalCode - -- StateOrProvince - -- StreetAddress - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f397cd16-dcd7-4929-8c9f-35415ca6b009.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/New-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/client-access/New-OwaMailboxPolicy.md deleted file mode 100644 index f1082d285e..0000000000 --- a/exchange/exchange-ps/exchange/client-access/New-OwaMailboxPolicy.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OwaMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-OwaMailboxPolicy cmdlet to create Outlook on the web mailbox policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-OwaMailboxPolicy [-Name] <String> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [-IsDefault] [<CommonParameters>] -``` - -## 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). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-OwaMailboxPolicy -Name Corporate -``` - -This example creates the Outlook on the web mailbox policy named Corporate. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -This parameter is available only in the cloud-based service. - -The IsDefaultswitch specifies whether the policy is the default policy. You don't need to specify a value with this switch. - -If another policy is currently set as the default, using this switch replaces the old default policy with this policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b2e46c22-7e99-4d04-b5ef-81ef64bf7445.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Remove-ClientAccessRule.md b/exchange/exchange-ps/exchange/client-access/Remove-ClientAccessRule.md deleted file mode 100644 index 4ba286201b..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Remove-ClientAccessRule.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2019, Exchange Online -title: Remove-ClientAccessRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-ClientAccessRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ClientAccessRule [-Identity] <ClientAccessRuleIdParameter> [-Confirm] [-DatacenterAdminsOnly] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ClientAccessRule "Block Client Connections from 192.168.1.0/24" -``` - -This example removes the existing client access rule named "Block Connections from 192.168.1.0/24". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ClientAccessRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatacenterAdminsOnly -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2ef2eabd-08bf-4f0d-879c-4e9a4c707903.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/client-access/Remove-OwaMailboxPolicy.md deleted file mode 100644 index 7970e6e413..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Remove-OwaMailboxPolicy.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OwaMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-OwaMailboxPolicy cmdlet to remove Outlook on the web mailbox policies from the organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OwaMailboxPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## 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). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OwaMailboxPolicy -Identity Executives -``` - -This example removes the mailbox policy named Executives. - -### -------------------------- Example 2 -------------------------- -``` -Remove-OwaMailboxPolicy -Identity Fabrikam\Employees -``` - -This example removes the mailbox policy named Employees for the organization Fabrikam. - -### -------------------------- Example 3 -------------------------- -``` -Remove-OwaMailboxPolicy -Identity Litware\Contoso\Corporate -``` - -This example removes the mailbox policy named Corporate for the tenant Contoso in the organization Litware. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/834bee7a-1044-4628-9d0d-1601e88a73f8.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Send-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/client-access/Send-TextMessagingVerificationCode.md deleted file mode 100644 index f16c49677a..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Send-TextMessagingVerificationCode.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Send-TextMessagingVerificationCode -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Send-TextMessagingVerificationCode cmdlet to send a text messaging verification code to the user's mobile phone. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Send-TextMessagingVerificationCode [[-Identity] <MailboxIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet returns an error if the user requests a verification code more than three times within a 24-hour period. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Send-TextMessagingVerificationCode -Identity "TonySmith" -``` - -This example sends the text messaging verification code to Tony Smith's mobile phone. - -### -------------------------- Example 2 -------------------------- -``` -Send-TextMessagingVerificationCode -Identity "TonySmith" -Confirm $true -``` - -This example sends the text messaging verification code to Tony Smith's mobile phone after confirmation is given. - -### -------------------------- Example 3 -------------------------- -``` -Send-TextMessagingVerificationCode -Identity "tony@contoso.com" -``` - -This example sends the text messaging verification code to Tony Smith's mobile phone. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox ID for the user. - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2807693e-cc82-44bc-a670-e8ae4dd7429b.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-CASMailbox.md b/exchange/exchange-ps/exchange/client-access/Set-CASMailbox.md deleted file mode 100644 index 3372e5eb23..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-CASMailbox.md +++ /dev/null @@ -1,1260 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-CASMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-CASMailbox cmdlet to configure client access settings on a mailbox. For example, you can configure settings for Exchange ActiveSync, Outlook, Outlook on the web, POP3, and IMAP4. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-CASMailbox [-Identity] <MailboxIdParameter> - [-ActiveSyncAllowedDeviceIDs <MultiValuedProperty>] - [-ActiveSyncBlockedDeviceIDs <MultiValuedProperty>] - [-ActiveSyncDebugLogging <$true | $false>] - [-ActiveSyncEnabled <$true | $false>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-ActiveSyncSuppressReadReceipt <$true | $false>] - [-Confirm] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-ECPEnabled <$true | $false>] - [-EmailAddresses <ProxyAddressCollection>] - [-EmwsEnabled <$true | $false>] - [-EwsAllowEntourage <$true | $false>] - [-EwsAllowList <MultiValuedProperty>] - [-EwsAllowMacOutlook <$true | $false>] - [-EwsAllowOutlook <$true | $false>] - [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] - [-EwsBlockList <MultiValuedProperty>] - [-EwsEnabled <$true | $false>] - [-HasActiveSyncDevicePartnership <$true | $false>] - [-IgnoreDefaultScope] - [-ImapEnabled <$true | $false>] - [-ImapEnableExactRFC822Size <$true | $false>] - [-ImapMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] - [-ImapForceICalForCalendarRetrievalOption <$true | $false>] - [-ImapSuppressReadReceipt <$true | $false>] - [-ImapUseProtocolDefaults <$true | $false>] - [-IsOptimizedForAccessibility <$true | $false>] - [-MAPIBlockOutlookExternalConnectivity <$true | $false>] - [-MAPIBlockOutlookNonCachedMode <$true | $false>] - [-MAPIBlockOutlookRpcHttp <$true | $false>] - [-MAPIBlockOutlookVersions <String>] - [-MAPIEnabled <$true | $false>] - [-MapiHttpEnabled <$true | $false>] - [-Name <String>] - [-OWAEnabled <$true | $false>] - [-OWAforDevicesEnabled <$true | $false>] - [-OwaMailboxPolicy <MailboxPolicyIdParameter>] - [-PopEnabled <$true | $false>] - [-PopEnableExactRFC822Size <$true | $false>] - [-PopForceICalForCalendarRetrievalOption <$true | $false>] - [-PopMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] - [-PopSuppressReadReceipt <$true | $false>] - [-PopUseProtocolDefaults <$true | $false>] - [-PrimarySmtpAddress <SmtpAddress>] - [-PublicFolderClientAccess <$true | $false>] - [-ResetAutoBlockedDevices] - [-SamAccountName <String>] - [-ShowGalAsDefaultView <$true | $false>] - [-SmtpClientAuthenticationDisabled <$true | $false>] - [-UniversalOutlookEnabled <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CASMailbox adam@contoso.com -OWAEnabled $false -PopEnabled $false -``` - -This example disables Outlook on the web and POP3 access for the user adam@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Set-CASMailbox adam@contoso.com -ActiveSyncDebugLogging $true -ActiveSyncMailboxPolicy Management -``` - -This example enables Exchange ActiveSync debug logging and specifies the Exchange ActiveSync mailbox policy named Management for the user adam@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Set-CASMailbox tony@contoso.com -DisplayName "Tony Smith" -MAPIBlockOutlookRpcHttp $true -``` - -This example sets the display name and disables Outlook Anywhere access for the user tony@contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to configure. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActiveSyncAllowedDeviceIDs -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -To clear the list of device IDs, use the value $null for this parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncBlockedDeviceIDs -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -To clear the list of device IDs, use the value $null for this parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncDebugLogging -The ActiveSyncDebugLogging parameter enables or disables Exchange ActiveSync debug logging for the mailbox. Valid input for this parameter is $true or $false. The default value is $false. - -This parameter is primarily for troubleshooting and will revert to $false in 48 hours for Exchange Online, and in 72 hours for Exchange Server. - -```yaml -Type: $true | $false -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 -``` - -### -ActiveSyncEnabled -The ActiveSyncEnabled parameter enables or disables Exchange ActiveSync for the mailbox. Valid input for this parameter is $true or $false. The default value is $true. When you set this parameter to $false, the other Exchange ActiveSync settings in this cmdlet are ignored. - -```yaml -Type: $true | $false -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 -``` - -### -ActiveSyncMailboxPolicy -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 - -- Distinguished name (DN) - -- GUID - -The name of the default Exchange ActiveSync mailbox policy is Default. - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncSuppressReadReceipt -The ActiveSyncSuppressReadReceipt parameter controls the behavior of read receipts for Exchange ActiveSync 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 ("). - -```yaml -Type: String -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ECPEnabled -This parameter is available only in on-premises Exchange. - -The ECPEnabled parameter enables or disables access to the Exchange admin center (EAC) for the specified user. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -EmailAddresses -This parameter is available only in on-premises Exchange. - -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -Type: ProxyAddressCollection -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 -``` - -### -EmwsEnabled -This parameter is available or functional only in Exchange Server 2010. - -The EmwsEnabled parameter specifies whether the Exchange Management Web Service is enabled on this Client Access server. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowEntourage -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). - -Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -EwsAllowList -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowMacOutlook -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 input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -EwsAllowOutlook -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. - -```yaml -Type: $true | $false -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 -``` - -### -EwsApplicationAccessPolicy -The EwsApplicationAccessPolicy parameter controls access to the mailbox by using Exchange Web Services applications. - -Valid values for this parameter are: - -- EnforceAllowList: Only applications specified in the EwsAllowList parameter are allowed to access the mailbox. - -- EnforceBlockList: Applications specified in the EwsBlockList parameter aren't allowed to access the mailbox, but any other applications can access the mailbox. - -This parameter doesn't affect access to the mailbox by using Entourage, Outlook for Mac, and Outlook. Access to the mailbox by using these clients is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters. - -```yaml -Type: EnforceAllowList | EnforceBlockList -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 -``` - -### -EwsBlockList -The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox by 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsEnabled -The EwsEnabled parameter enables or disables access to the mailbox by using Exchange Web Services clients. - -Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Exchange Web Services settings in this cmdlet are ignored. - -```yaml -Type: $true | $false -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 -``` - -### -HasActiveSyncDevicePartnership -This parameter is available or functional only in Exchange Server 2010. - -The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has an ActiveSync device partnership established. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapEnabled -The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. - -Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other IMAP4 settings in this cmdlet are ignored. - -```yaml -Type: $true | $false -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 -``` - -### -ImapEnableExactRFC822Size -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 for this parameter are: - -- $true: Calculate the exact message size. - -- $false: Use an estimated message size. - -The default value is $false. - -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. - -```yaml -Type: $true | $false -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 -``` - -### -ImapForceICalForCalendarRetrievalOption -The ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox. - -Valid values for this parameter are: - -- $true: All meeting requests are in the iCal format. - -- $false: All meeting requests appear as Outlook on the web links. - -The default value is $false. - -To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapMessagesRetrievalMimeFormat -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 - -- 1: HtmlOnly - -- 2: HtmlAndTextAlternative - -- 3: TextEnrichedOnly - -- 4: TextEnrichedAndTextAlternative - -- 5: BestBodyFormat - -- 6: Tnef - -The default value is BestBodyFormat. - -To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. - -```yaml -Type: TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef -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 -``` - -### -ImapSuppressReadReceipt -The ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox. - -Valid values for this parameter 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. - -The default value is $false. - -To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. - -```yaml -Type: $true | $false -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 -``` - -### -ImapUseProtocolDefaults -The ImapUseProtocolDefaults parameter specifies whether to use the IMAP4 protocol defaults for the mailbox. Valid input for this parameter is $true or $false. The default value is $true. - -You need to set the ImapUseProtocolDefaults parameter to $false when you use any of the following IMAP4 parameters: - -- ImapEnableExactRFC822Size - -- ImapForceICalForCalendarRetrievalOption - -- ImapMessagesRetrievalMimeFormat - -- ImapSuppressReadReceipt - -```yaml -Type: $true | $false -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 -``` - -### -IsOptimizedForAccessibility -The IsOptimizedForAccessibility parameter specifies whether the mailbox is configured to use the light version of Outlook on the web. Valid values are: - -- $true: The mailbox is configured to use the light version of Outlook on the web. - -- $false: The mailbox isn't configured to use the light version of Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MAPIBlockOutlookNonCachedMode -This parameter is available only in on-premises Exchange. - -The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox by using Outlook in online or offline mode. - -Valid values for this parameter 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). - -The default value is $false. - -```yaml -Type: $true | $false -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 -``` - -### -MAPIBlockOutlookExternalConnectivity -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: - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MAPIBlockOutlookRpcHttp -This parameter is available only in on-premises Exchange. - -The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook by using Outlook Anywhere. Valid values are: - -- $true: Access to the mailbox by using Outlook Anywhere is disabled. - -- $false: Access to the mailbox by using Outlook Anywhere is enabled. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -MAPIBlockOutlookVersions -This parameter is available only in on-premises Exchange. - -The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. - -For example, if you specify the value 15.0.4569.1503, only Outlook 2013 Service Pack 1 (SP1) or later clients are allowed to access the mailbox. Earlier versions of Outlook are blocked. - -The default value is blank. To reset this parameter, use the value $null. - -```yaml -Type: String -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 -``` - -### -MAPIEnabled -The MAPIEnabled parameter enables or disables access to the mailbox by using MAPI clients (for example, Outlook). - -Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other MAPI settings in this cmdlet are ignored. - -```yaml -Type: $true | $false -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 -``` - -### -MapiHttpEnabled -This parameter is available only in on-premises Exchange. - -The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook by using MAPI over HTTP. Valid values are: - -- $true: Access to the mailbox by using MAPI over HTTP is enabled. - -- $false: Access to the mailbox by 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 ("). - -```yaml -Type: String -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 -``` - -### -OWAEnabled -The OWAEnabled parameter enables or disables access to the mailbox by using Outlook on the web. - -Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Outlook on the web settings in this cmdlet are ignored. - -```yaml -Type: $true | $false -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 -``` - -### -OWAforDevicesEnabled -The OWAforDevicesEnabled parameter enables or disables access to the mailbox by using Outlook on the web for devices. - -Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwaMailboxPolicy -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 - -- Distinguished name (DN) - -- GUID - -The name of the default Outlook on the web mailbox policy is Default. - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopEnabled -The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. - -Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other POP3 settings in this cmdlet are ignored. - -```yaml -Type: $true | $false -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 -``` - -### -PopEnableExactRFC822Size -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 for this parameter are: - -- $true: Calculate the exact message size. - -- $false: Use an estimated message size. - -The default value is $false. - -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. - -```yaml -Type: $true | $false -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 -``` - -### -PopForceICalForCalendarRetrievalOption -The PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox. - -Valid values for this parameter are: - -- $true: All meeting requests are in the iCal format. - -- $false: All meeting requests appear as Outlook on the web links. - -The default value is $false. - -To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopMessagesRetrievalMimeFormat -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 - -- 1: HtmlOnly - -- 2: HtmlAndTextAlternative - -- 3: TextEnrichedOnly - -- 4: TextEnrichedAndTextAlternative - -- 5: BestBodyFormat - -- 6: Tnef - -The default value is BestBodyFormat. - -To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. - -```yaml -Type: TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef -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 -``` - -### -PopSuppressReadReceipt -The PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox. - -Valid values for this parameter 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. - -The default value is $false. - -To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. - -```yaml -Type: $true | $false -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 -``` - -### -PopUseProtocolDefaults -The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. - -Valid input for this parameter is $true or $false. The default value is $true. You need to set the PopUseProtocolDefaults parameter to $false when you use any of following parameters: - -- PopEnableExactRFC822Size - -- PopForceICalForCalendarRetrievalOption - -- PopMessagesRetrievalMimeFormat - -- PopSuppressReadReceipt - -```yaml -Type: $true | $false -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 -``` - -### -PrimarySmtpAddress -This parameter is available only in on-premises Exchange. - -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```yaml -Type: SmtpAddress -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 -``` - -### -PublicFolderClientAccess -This parameter is available only in the cloud-based service. - -The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - -- $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the value $true (the default value is $false). - -- $false: The user can't access public folders in Outlook. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetAutoBlockedDevices -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -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 -``` - -### -ShowGalAsDefaultView -The ShowGalAsDefaultView parameter shows the global address list (GAL) as the default recipient picker for messages. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -SmtpClientAuthenticationDisabled -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: - -- POP3 and IMAP4 clients. - -- Devices with scan to email capability. - -- Workflow applications that send email notifications. - -- Online services that send messages using internal email addresses in the organization. - -Valid values for this parameter are: - -- $true: Authenticated SMTP is disabled for the mailbox. - -- $false: Authenticated SMTP is enaled 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. By default, authenticated SMTP is enabled for the organization ($false), which means authenticated SMTP is also enabled for the mailbox. - -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). - -```yaml -Type:$true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniversalOutlookEnabled -This parameter is available only in the cloud-based service. - -The UniversalOutlookEnabled parameter enables or disables access to the mailbox by using Mail and Calendar. Valid values are: - -- $true: Access to the mailbox in Mail and Calendar is enabled. This is the default value. - -- $false: Access to the mailbox in Mail and Calendar is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ff7d4dc5-755e-4005-a0a3-631eed3f9b3b.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/client-access/Set-ClientAccessRule.md deleted file mode 100644 index 86421f67ee..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-ClientAccessRule.md +++ /dev/null @@ -1,527 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2019, Exchange Online -title: Set-ClientAccessRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2019 || exchonline-ps" ---- - -# Set-ClientAccessRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ClientAccessRule [-Identity] <ClientAccessRuleIdParameter> [-Action <AllowAccess | DenyAccess>] - [-AnyOfAuthenticationTypes <MultiValuedProperty>] [-AnyOfClientIPAddressesOrRanges <MultiValuedProperty>] - [-AnyOfProtocols <MultiValuedProperty>] [-Confirm] [-DatacenterAdminsOnly] [-DomainController <Fqdn>] - [-Enabled <$true | $false>] [-ExceptAnyOfAuthenticationTypes <MultiValuedProperty>] - [-ExceptAnyOfClientIPAddressesOrRanges <MultiValuedProperty>] [-ExceptAnyOfProtocols <MultiValuedProperty>] - [-ExceptUsernameMatchesAnyOfPatterns <MultiValuedProperty>] [-Name <String>] [-Priority <Int32>] - [-Scope <All | Users>] [-UsernameMatchesAnyOfPatterns <MultiValuedProperty>] [-UserRecipientFilter <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. - -Note: Not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: - -- OutlookWebApp: BasicAuthentication and AdfsAuthentication. - -- ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ClientAccessRule "Allow IMAP4" -AnyOfClientIPAddressesOrRanges @{Add="172.17.17.27/16"} -``` - -This example adds the IP address range 172.17.17.27/16 to the existing client access rule named Allow IMAP4 without affecting the existing IP address values. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ClientAccessRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Action -The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. - -```yaml -Type: AllowAccess | DenyAccess -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfAuthenticationTypes -This parameter is available 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. - -Valid values for this parameter are: - -- AdfsAuthentication - -- BasicAuthentication - -- CertificateBasedAuthentication - -- NonBasicAuthentication - -- OAuthAuthentication - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfClientIPAddressesOrRanges -The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IP address. Valid values for this parameter are: - -- A single IP address: For example, 192.168.1.1. - -- An IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfProtocols -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: - -- ExchangeActiveSync - -- ExchangeAdminCenter - -- ExchangeWebServices - -- IMAP4 - -- OfflineAddressBook - -- OutlookAnywhere - -- OutlookWebApp - -- POP3 - -- PowerShellWebServices - -- RemotePowerShell - -- REST - -- UniversalOutlook (Mail and Calendar app) - -**Note**: In Exchange 2019, the only supported values are ExchangeAdminCenter and RemotePowerShell. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatacenterAdminsOnly -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptAnyOfAuthenticationTypes -This parameter is available 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. - -Valid values for this parameter are: - -- AdfsAuthentication - -- BasicAuthentication - -- CertificateBasedAuthentication - -- NonBasicAuthentication - -- OAuthAuthentication - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptAnyOfClientIPAddressesOrRanges -The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IP address. Valid values for this parameter are: - -- A single IP address: For example, 192.168.1.1. - -- An IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptAnyOfProtocols -This parameter is available 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. - -Valid values for this parameter are: - -- ExchangeActiveSync - -- ExchangeAdminCenter - -- ExchangeWebServices - -- IMAP4 - -- OfflineAddressBook - -- OutlookAnywhere - -- OutlookWebApp - -- POP3 - -- PowerShellWebServices - -- RemotePowerShell - -- REST - -- UniversalOutlook (Mail and Calendar app) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptUsernameMatchesAnyOfPatterns -This parameter is available 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 \<Domain\>\\\<UserName\> (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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the client access rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the 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 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -The Scope parameter specifies the scope of the client access rule. Valid values are: - -- Users: The rule only applies to end-user connections. - -- All: The rule applies to all connections (end-users and middle-tier apps). - -```yaml -Type: All | Users -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsernameMatchesAnyOfPatterns -This parameter is available 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 \<Domain\>\\\<UserName\> (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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRecipientFilter -This parameter is available 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. For example, {City -eq "Redmond"}. The filterable attributes that you can use with this parameter are: - -- City - -- Company - -- CountryOrRegion - -- CustomAttribute1-15 - -- Department - -- Office - -- PostalCode - -- StateOrProvince - -- StreetAddress - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a4ba8627-b774-460f-9793-3d741c115b2e.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/client-access/Set-MailboxCalendarConfiguration.md deleted file mode 100644 index 8f72157206..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-MailboxCalendarConfiguration.md +++ /dev/null @@ -1,989 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxCalendarConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxCalendarConfiguration cmdlet to modify mailbox calendar settings for Outlook on the web. This affects how the user's calendar looks and how reminders work in Outlook on the web. This also affects settings that define how meeting invitations, responses, and notifications are sent to the user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxCalendarConfiguration [-Identity] <MailboxIdParameter> [-Confirm] [-DefaultReminderTime <TimeSpan>] - [-DomainController <Fqdn>] [-RemindersEnabled <$true | $false>] [-ReminderSoundEnabled <$true | $false>] - [-ShowWeekNumbers <$true | $false>] [-TimeIncrement <FifteenMinutes | ThirtyMinutes>] - [-WeekStartDay <Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday>] [-WhatIf] - [-WorkDays <None | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Weekdays | WeekendDays | AllDays>] - [-WorkingHoursEndTime <TimeSpan>] [-WorkingHoursStartTime <TimeSpan>] - [-WorkingHoursTimeZone <ExTimeZoneValue>] - [-FirstWeekOfYear <LegacyNotSet | FirstDay | FirstFourDayWeek | FirstFullWeek>] - [-WeatherEnabled <$true | $false>] [-WeatherLocations <MultiValuedProperty>] - [-WeatherUnit <Default | Celsius | Fahrenheit>] [-AgendaMailEnabled <$true | $false>] - [-AgendaPaneEnabled <$true | $false>] [-CalendarFeedsPreferredLanguage <String>] - [-CalendarFeedsPreferredRegion <String>] [-CalendarFeedsRootPageId <String>] - [-ConversationalSchedulingEnabled <$true | $false>] [-CreateEventsFromEmailAsPrivate <$true | $false>] - [-DailyAgendaMailSchedule <Default | AM | PM>] [-DefaultMeetingDuration <Int32>] - [-DiningEventsFromEmailEnabled <$true | $false>] [-EntertainmentEventsFromEmailEnabled <$true | $false>] - [-EventsFromEmailEnabled <$true | $false>] [-FlightEventsFromEmailEnabled <$true | $false>] - [-HotelEventsFromEmailEnabled <$true | $false>] [-InvoiceEventsFromEmailEnabled <$true | $false>] - [-LocalEventsEnabled <FirstRun | Disabled | Enabled>] [-LocalEventsLocation <LocalEventsLocation>] - [-PackageDeliveryEventsFromEmailEnabled <$true | $false>] [-RentalCarEventsFromEmailEnabled <$true | $false>] - [-SkipAgendaMailOnFreeDays <$true | $false>] [-UseBrightCalendarColorThemeInOwa <$true | $false>] - [-WeatherLocationBookmark <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-MailboxCalendarConfiguration cmdlet primarily allows users to manage their own calendar settings in Outlook on the web Options. However, administrators who have the Organization Management or Recipient Management management roles may configure the calendar settings for users by using this cmdlet. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxCalendarConfiguration -Identity peter@contoso.com -RemindersEnabled $false -``` - -This example disables the calendar reminders for the calendar of the user peter@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxCalendarConfiguration -Identity peter@contoso.com -WorkingHoursTimeZone "Pacific Standard Time" -``` - -This example sets the time zone of the work hours' start and end times to Pacific Standard Time for the calendar of the user peter@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Set-MailboxCalendarConfiguration -Identity Tony -WorkingHoursStartTime 07:00:00 -``` - -This example sets the working day's starting hour to 7 A.M. for the calendar of the user Tony. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultReminderTime -The DefaultReminderTime parameter specifies the length of time before a meeting or appointment whenthe reminder is first displayed. - -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: - -- 00:00:00 - -- 00:05:00 (5 minutes) - -- 00:10:00 (10 minutes) - -- 00:15:00 (15 minutes) This is the default value. - -- 00:30:00 (30 minutes) - -- 01:00:00 (1 hour) - -- 02:00:00 (2 hours) - -- 03:00:00 (3 hours) - -- 04:00:00 (4 hours) - -- 08:00:00 (8 hours) - -- 12:00:00 (12 hours) - -- 1.00:00:00 (1 day) - -- 2.00:00:00 (2 days) - -- 3.00:00:00 (3 days) - -- 7.00:00:00 (7 days) - -- 14.00:00:00 (14 days) - -This parameter is ignored when the RemindersEnabled parameter is set to $false. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstWeekOfYear -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. - -- 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. - -You configure the first day of the week by using the WeekStartDay parameter. - -```yaml -Type: -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 -``` - -### -RemindersEnabled -The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are: - -- $true: Reminders are enabled. This is the default value. - -- $false: Reminders are disabled. - -When the reminder is first displayed is controlled by the DefaultReminderTime parameter. - -```yaml -Type: $true | $false -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 -``` - -### -ReminderSoundEnabled -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. - -- $false: No sound is played with the reminder. - -This parameter is ignored when the RemindersEnabled parameter is set to $false. - -```yaml -Type: $true | $false -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 -``` - -### -ShowWeekNumbers -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. - -```yaml -Type: $true | $false -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 -``` - -### -TimeIncrement -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) - -```yaml -Type: FifteenMinutes | ThirtyMinutes -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 -``` - -### -WeekStartDay -The WeekStartDay parameter specifies the first day of the week. Valid values are: - -- Sunday (This is the default value) - -- Monday - -- Tuesday - -- Wednesday - -- Thursday - -- Friday - -- Saturday - -```yaml -Type: Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkDays -The WorkDays parameter specifies the work days in the calendar. Valid values are: - -- None - -- AllDays - -- Weekdays (This is the default value) - -- WeekEndDays - -- Sunday - -- Monday - -- Tuesday - -- Wednesday - -- Thursday - -- Friday - -- Saturday - -You can specify multiple values separated by commas, but redundant values are ignored. For example, entering Weekdays,Monday results in the value Weekdays. - -```yaml -Type: None | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Weekdays | WeekendDays | AllDays -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 -``` - -### -WorkingHoursEndTime -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. - -The default value is 17:00:00 (5:00 P.M.). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkingHoursStartTime -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. - -The default value is 08:00:00(8:00 A.M.). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkingHoursTimeZone -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"). - -To see the available values, run the following command: $TimeZone = Get-ChildItem "HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Time zones" | foreach {Get-ItemProperty $\_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display - -If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeatherEnabled -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) - -- Disabled: Hide weather on the calendar. - -- Enabled: Show weather on the calendar. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeatherLocations -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. - -This parameter uses the syntax: LocationId:\<LocationID\>;Name:\<Name\>;Latitude:\<Latitude\>;Longitude:\<Longitude\>. For example, LocationId:105808079;Name:Redmond, WA;Latitude:47.679;Longitude:-122.132. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -For this parameter, "\<value1\>" is "LocationId:\<LocationID1\>;Name:\<Name1\>;Latitude:\<Latitude1\>;Longitude:\<Longitude1\>", and "\<value2\>" is "LocationId:\<LocationID2\>;Name:\<Name2\>;Latitude:\<Latitude2\>;Longitude:\<Longitude2\>" - -You can configure a maximum of 5 weather locations. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeatherUnit -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) - -- Celsius - -- Fahrenheit - -```yaml -Type: Default | Celsius | Fahrenheit -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgendaMailEnabled -This parameter is available only in the cloud-based service. - -The AgendaMailEnabled parameter specifies whether to enable or disable the daily agenda email message. Valid values are: - -- $true: Agenda mail is enabled. - -- $false: Agenda mail is disabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgendaPaneEnabled -This parameter is available only in the cloud-based service. - -The AgendaPaneEnabled parameter specifies whether to enable the agenda pane in Outlook on the web. Valid values are: - -- $true: The Agenda pane enabled. - -- $false: The Agenda pane is disabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarFeedsPreferredLanguage -This parameter is available only in the cloud-based service. - -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). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarFeedsPreferredRegion -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 uppercase two-letter country code (for example, US for the United States). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarFeedsRootPageId -This parameter is available only in the cloud-based service. - -The CalendarFeedsRootPageId parameter specifies the root page ID for calendar feeds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConversationalSchedulingEnabled -The ConversationalSchedulingEnabled parameter specifies whether to enable or disable conversational scheduling. Valid values are: - -- $true: Conversational scheduling is enabled. This is the default value. - -- $false: Conversational scheduling is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateEventsFromEmailAsPrivate -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. - -- $false: Events from email are created as Normal (public). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DailyAgendaMailSchedule -The DailyAgendaMailSchedule parameter specifies whether to receive a daily or nightly edition of the daily agenda message. Valid values are: - -- Default: The agenda email message is delivered at 03:00 (3:00 AM). This is the default value. - -- AM - -- PM - -```yaml -Type: Default | AM | PM -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultMeetingDuration -The DefaultMeetingDuration parameter specifies the default duration in minutes for new meetings. The default value is 30 minutes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiningEventsFromEmailEnabled -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. - -- $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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntertainmentEventsFromEmailEnabled -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. - -- $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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventsFromEmailEnabled -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. - -- $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: - -- DiningEventsFromEmailEnabled - -- EntertainmentEventsFromEmailEnabled - -- FlightEventsFromEmailEnabled - -- HotelEventsFromEmailEnabled - -- PackageDeliveryEventsFromEmailEnabled - -- RentalCarEventsFromEmailEnabled - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FlightEventsFromEmailEnabled -This parameter is available only in the cloud-based service. - -The FlightEventsFromEmailEnabled parameter specifies whether to create flight reservation events from email messages. Valid values are: - -- $true: Create flight reservation events from email messages. This is the default value. - -- $false: Don't create flight reservation events from email messages. - -This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HotelEventsFromEmailEnabled -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. - -- $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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InvoiceEventsFromEmailEnabled -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. - -- $false: Creating invoices from messages is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalEventsEnabled -PARAMVALUE: FirstRun | Disabled | Enabled - -```yaml -Type: FirstRun | Disabled | Enabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalEventsLocation -PARAMVALUE: LocalEventsLocation - -```yaml -Type: LocalEventsLocation -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageDeliveryEventsFromEmailEnabled -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. - -This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RentalCarEventsFromEmailEnabled -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. - -- $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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAgendaMailOnFreeDays -The SkipAgendaMailOnFreeDays parameter specifies whether to skip sending the daily agenda email message on days with no events or tasks. Valid values are: - -- $true: Don't send the daily agenda email message on free days. This is the default value. - -- $false: Send the daily agenda email message every day. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseBrightCalendarColorThemeInOwa -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeatherLocationBookmark -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. - -A valid value for this parameter depends on the number of weather locations that are configured for the mailbox. For example, if there are 3 weather locations configured, you can specify the value 0, 1, or 2 for this parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/092aa4db-3f0f-4b17-b7b1-1987a8268760.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/client-access/Set-MailboxMessageConfiguration.md deleted file mode 100644 index 44e380a629..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-MailboxMessageConfiguration.md +++ /dev/null @@ -1,958 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxMessageConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxMessageConfiguration cmdlet to configure the Outlook on the web settings that are applied to specific mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxMessageConfiguration [-Identity] <MailboxIdParameter> - [-AfterMoveOrDeleteBehavior <OpenPreviousItem | OpenNextItem | ReturnToView>] - [-AlwaysShowBcc <$true | $false>] [-AlwaysShowFrom <$true | $false>] [-AutoAddSignature <$true | $false>] - [-Confirm] - [-ConversationSortOrder <Chronological | Tree | NewestOnTop | NewestOnBottom | ChronologicalNewestOnTop | ChronologicalNewestOnBottom | TreeNewestOnBottom>] - [-DefaultFontColor <String>] [-DefaultFontFlags <Normal | Bold | Italic | Underline | All>] - [-DefaultFontName <String>] [-DefaultFontSize <Int32>] [-DefaultFormat <Html | PlainText>] - [-DomainController <Fqdn>] [-EmptyDeletedItemsOnLogoff <$true | $false>] [-HideDeletedItems <$true | $false>] - [-IgnoreDefaultScope] [-NewItemNotification <None | Sound | EMailToast | VoiceMailToast | FaxToast | All>] - [-PreviewMarkAsReadBehavior <Delayed | OnSelectionChange | Never>] [-PreviewMarkAsReadDelaytime <Int32>] - [-ReadReceiptResponse <DoNotAutomaticallySend | AlwaysSend | NeverSend>] [-SendAddressDefault <String>] - [-ShowConversationAsTree <$true | $false>] [-SignatureHtml <String>] [-SignatureText <String>] [-WhatIf] - [-AutoAddSignatureOnMobile <$true | $false>] [-CheckForForgottenAttachments <$true | $false>] - [-EmailComposeMode <Inline | SeparateForm>] [-SignatureTextOnMobile <String>] - [-UseDefaultSignatureOnMobile <$true | $false>] [-AutoAddSignatureOnReply <$true | $false>] - [-GlobalReadingPanePosition <Off | Right | Bottom>] [-IsFavoritesFolderTreeCollapsed <$true | $false>] - [-IsMailRootFolderTreeCollapsed <$true | $false>] [-IsReplyAllTheDefaultResponse <$true | $false>] - [-LinkPreviewEnabled <$true | $false>] [-MailFolderPaneExpanded <$true | $false>] - [-NavigationPaneViewOption <Default | MailFolders | PeopleFolders | Groups | PinnedMailFolders>] - [-PreferAccessibleContent <$true | $false>] [-ShowPreviewTextInListView <$true | $false>] - [-ShowReadingPaneOnFirstLoad <$true | $false>] [-ShowSenderOnTopInListView <$true | $false>] - [-ShowUpNext <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-MailboxMessageConfiguration cmdlet configures Outlook on the web settings for the specified mailbox. These settings include email signature, message format, message options, read receipts, reading pane, and conversations. These settings are not used in Outlook, Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. Settings that contain the word Mobile are applied in Outlook on the web for devices only. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxMessageConfiguration kai@contoso.com -HideDeletedItems $true -``` - -This example sets items deleted from a conversation thread to not show in the list view of the conversation in Outlook on the web for Kai's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxMessageConfiguration kai@contoso.com -AlwaysShowBcc $true -``` - -This example sets the compose email message form to always show the Bcc field in Outlook on the web for Kai's mailbox. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AfterMoveOrDeleteBehavior -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 - -- OpenNextItem - -- ReturnToView - -The default value is OpenNextItem. - -```yaml -Type: OpenPreviousItem | OpenNextItem | ReturnToView -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 -``` - -### -AlwaysShowBcc -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. - -```yaml -Type: $true | $false -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 -``` - -### -AlwaysShowFrom -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. - -```yaml -Type: $true | $false -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 -``` - -### -AutoAddSignature -The AutoAddSignature parameter specifies whether to automatically add signatures to new email messages created in Outlook on the web. Valid values are: - -- $true: Email signatures are automatically added to new messages. - -- $false: Email signatures aren't automatically added to new messages. - -The email signature specified by the SignatureText parameter is added to plain text messages. The email signature specified by the SignatureHTML parameter is added to HTML-formatted messages. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConversationSortOrder -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 - -- Tree - -- NewestOnTop - -- NewestOnBottom - -- ChronologicalNewestOnTop - -- ChronologicalNewestOnBottom - -- TreeNewestOnBottom - -The default value is ChronologicalNewestOnTop. - -```yaml -Type: Chronological | Tree | NewestOnTop | NewestOnBottom | ChronologicalNewestOnTop | ChronologicalNewestOnBottom | TreeNewestOnBottom -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 -``` - -### -DefaultFontColor -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultFontFlags -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 - -- Bold - -- Italic - -- Underline - -- All - -The default value is Normal. - -```yaml -Type: Normal | Bold | Italic | Underline | All -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 -``` - -### -DefaultFontName -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultFontSize -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultFormat -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: Html | PlainText -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmptyDeletedItemsOnLogoff -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. - -```yaml -Type: $true | $false -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 -``` - -### -HideDeletedItems -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. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewItemNotification -The NewItemNotification parameter specifies how to provide notification for the arrival of new items for the user in Outlook on the web. You can use the following values: - -- Sound - -- EMailToast - -- VoiceMailToast - -- FaxToast - -- None - -- All - -The default value is All. - -```yaml -Type: None | Sound | EMailToast | VoiceMailToast | FaxToast | All -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 -``` - -### -PreviewMarkAsReadBehavior -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. - -- OnSelectionChange - -- Never - -The default value is OnSelectionChange. - -```yaml -Type: Delayed | OnSelectionChange | Never -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 -``` - -### -PreviewMarkAsReadDelaytime -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. - -This parameter is meaningful only if you set the PreviewMarkAsReadBehavior parameter to the value Delayed. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadReceiptResponse -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 - -- AlwaysSend - -- NeverSend - -The default value is DoNotAutomaticallySend. - -```yaml -Type: DoNotAutomaticallySend | AlwaysSend | NeverSend -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 -``` - -### -SendAddressDefault -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. - -You can use one of the following values: - -- Blank, which is represented by the value $null. This indicates no default From address is specified. - -- The user's primary email address. For example, bob@contoso.com. - -- The GUID of a POP, IMAP, or Hotmail subscription that's configured on the user's mailbox. - -By default, no default From address is specified on the mailbox. When no default From address is specified, the default behavior is: - -- The primary email address on the mailbox is used for all new messages. - -- The To address of the incoming message is used as the From address for all replies or forwarded messages. - -You can find the available values for SendAddressDefault on a mailbox by running the command Get-SendAddress -Mailbox \<mailbox\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowConversationAsTree -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. - -```yaml -Type: $true | $false -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 -``` - -### -SignatureHtml -The SignatureHtml parameter specifies the email signature that's available to the user in HTML-formatted messages in Outlook on the web. You can use plain text or text with HTML tags. However, any JavaScript code is removed. - -To automatically add this email signature to HTML-formatted messages created by the user in Outlook on the web, the AutoAddSignature parameter must be set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignatureText -The SignatureText parameter specifies the email signature that's available to the user in plain text messages in Outlook on the web. This parameter supports all Unicode characters. - -To automatically add the email signature to plain text messages created by the user in Outlook on the web, the AutoAddSignature parameter must be set to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -AutoAddSignatureOnMobile -The AutoAddSignatureOnMobile parameter automatically adds the signature specified by the SignatureTextOnMobile parameter to messages when the user creates messages in Outlook on the web for devices. - -Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CheckForForgottenAttachments -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. - -For example, the user creates a message that includes the text "Please see the attached Word document", but the user doesn't attach a file, and clicks Send. If this value is set to $true, the user gets a warning prompt so they can go back to the message and attach a file. If this value is set to $false, the user doesn't get the warning prompt. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailComposeMode -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. - -- SeparateForm: New messages and replies are created in a new browser window. - -```yaml -Type: Inline | SeparateForm -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignatureTextOnMobile -The SignatureTextOnMobile parameter specifies the email signature that's available in messages created by the user in Outlook on the web for devices. This parameter supports all Unicode characters. - -To automatically add the email signature to messages created by the user in Outlook on the web for devices, the AutoAddSignatureOnMobile parameter must be set to the value $true. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultSignatureOnMobile -The UseDefaultSignatureOnMobile parameter specifies whether to add the default email signature to messages created by the user in Outlook on the web for devices. The user configures the default signature in Outlook. - -Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoAddSignatureOnReply -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. - -- $false: Email signatures aren't automatically added to reply messages. - -The email signature specified by the SignatureText parameter is added to plain text messages. The email signature specified by the SignatureHTML parameter is added to HTML-formatted messages. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalReadingPanePosition -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) - -```yaml -Type: Off | Right | Bottom -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsFavoritesFolderTreeCollapsed -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 - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMailRootFolderTreeCollapsed -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 - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsReplyAllTheDefaultResponse -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. - -- $false: Reply All isn't the default response option for messages in the reading pane. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkPreviewEnabled -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. - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailFolderPaneExpanded -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. - -- $false: The Mail folder pane isn't expanded by default. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NavigationPaneViewOption -The NavigationPaneViewOption parameter specifies the default navigation pane view in Outlook on the web. Valid values are: - -- Default: This is the default value - -- MailFolders - -- PeopleFolders - -- Groups - -- PinnedMailFolders - -```yaml -Type: Default | MailFolders | PeopleFolders | Groups | PinnedMailFolders -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferAccessibleContent -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowPreviewTextInListView -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. - -- $false: Don't show preview text for messages in list view. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowReadingPaneOnFirstLoad -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowSenderOnTopInListView -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. - -- $false: Don't show the message sender on top in list view. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowUpNext -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. - -- $false: Don't show the next upcoming event above the mail list view. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/380aea89-c38e-4651-bf18-990032a04f04.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/client-access/Set-MailboxRegionalConfiguration.md deleted file mode 100644 index d3e0cbdb3e..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-MailboxRegionalConfiguration.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxRegionalConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxRegionalConfiguration cmdlet to modify the regional settings of a mailbox. You can modify the date format, time format, time zone and language of the mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxRegionalConfiguration [-Identity] <MailboxIdParameter> [-Confirm] [-DateFormat <String>] - [-DomainController <Fqdn>] [-Language <CultureInfo>] [-LocalizeDefaultFolderName] [-TimeFormat <String>] - [-TimeZone <ExTimeZoneValue>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxRegionalConfiguration -Identity "Marcelo Teixeira" -Language pt-br -LocalizeDefaultFolderName -``` - -This example sets Marcelo Teixeira's mailbox language to Brazilian Portuguese, and localizes the default folder names in Portuguese. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxRegionalConfiguration -Identity "Ella Lack's" -DateFormat "d/m/yyyy" -``` - -This example sets the date format for Ella Lack's mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Set-MailboxRegionalConfiguration -Identity "Alice Jakobsen" -Language da-dk -DateFormat "dd-mm-yyyy" -LocalizeDefaultFolderName -``` - -This example sets Alice Jakobsen's mailbox language to Danish Denmark, sets the date in the day/month/year format and localizes the default folder names in Danish. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateFormat -The DateFormat parameter specifies the 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/yy - -- MM/dd/yy - -- MM/dd/yyyy - -- yy/MM/dd - -- yyyy-MM-dd - -- dd-MMM-yy - -For more information about the date format strings, see Standard Date and Time Format Strings (https://go.microsoft.com/fwlink/p/?LinkId=784852). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -The Language parameter specifies the language for the mailbox. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalizeDefaultFolderName -The LocalizeDefaultFolderName switch localizes the default folder names of the mailbox in the current or specified language. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeFormat -The TimeFormat parameter specifies the 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. - -- hh:mm tt - -- H:mm - -- HH:mm - -For more information about the time format strings, see Standard Date and Time Format Strings (https://go.microsoft.com/fwlink/p/?LinkId=784852). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -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"). - -To see the available values, run the following command: $TimeZone = Get-ChildItem "HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Time zones" | foreach {Get-ItemProperty $\_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display - -If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bf47b2e4-2aba-4df5-a444-5b187328482d.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/client-access/Set-MailboxSpellingConfiguration.md deleted file mode 100644 index 7cfe84c63e..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-MailboxSpellingConfiguration.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxSpellingConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxSpellingConfiguration cmdlet to modify Outlook on the web spelling checker options for a specified user. For example, you can set the dictionary language and configure the spelling checker to ignore mixed digits or words in all uppercase. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxSpellingConfiguration [-Identity] <MailboxIdParameter> [-CheckBeforeSend <$true | $false>] - [-Confirm] - [-DictionaryLanguage <Spanish | Arabic | Danish | Dutch | EnglishAustralia | EnglishCanada | EnglishUnitedKingdom | EnglishUnitedStates | Finnish | French | GermanPostReform | GermanPreReform | Hebrew | Italian | Korean | NorwegianBokmal | NorwegianNynorsk | PortuguesePortugal | PortugueseBrasil | Swedish | Catalan>] - [-DomainController <Fqdn>] [-IgnoreMixedDigits <$true | $false>] [-IgnoreUppercase <$true | $false>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxSpellingConfiguration -Identity Peter -IgnoreUppercase $true -``` - -This example sets the spelling checker of user Peter to ignore words in all uppercase letters. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxSpellingConfiguration -Identity kai -IgnoreUppercase $true -``` - -This example sets the spelling checker to ignore words that contain only uppercase letters for messages sent from Kai's mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Set-MailboxSpellingConfiguration -IgnoreMixedDigits $true -Identity kai -``` - -This example sets the spelling checker to ignore words containing numbers for messages sent from Kai's mailbox. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CheckBeforeSend -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: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DictionaryLanguage -The DictionaryLanguage parameter specifies the dictionary language to use when the spelling checker checks the spelling in messages. Valid values are: - -- Arabic - -- Catalan - -- Danish - -- Dutch - -- EnglishAustralia - -- EnglishCanada - -- EnglishUnitedKingdom - -- EnglishUnitedStates - -- Finnish - -- French - -- GermanPreReform - -- GermanPostReform - -- Hebrew - -- Italian - -- Korean - -- NorwegianBokMal - -- NorwegianNyorsk - -- PortuguesePortugal - -- PortugueseBrasil - -- Spanish - -- Swedish - -```yaml -Type: Spanish | Arabic | Danish | Dutch | EnglishAustralia | EnglishCanada | EnglishUnitedKingdom | EnglishUnitedStates | Finnish | French | GermanPostReform | GermanPreReform | Hebrew | Italian | Korean | NorwegianBokmal | NorwegianNynorsk | PortuguesePortugal | PortugueseBrasil | Swedish | Catalan -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreMixedDigits -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: $true | $false -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 -``` - -### -IgnoreUppercase -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/63447637-44f7-4857-9606-f9c71287ca49.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/client-access/Set-OwaMailboxPolicy.md deleted file mode 100644 index 5984c5823b..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-OwaMailboxPolicy.md +++ /dev/null @@ -1,2345 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OwaMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-OwaMailboxPolicy cmdlet to configure existing Outlook on the web mailbox policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-OwaMailboxPolicy [-Identity] <MailboxPolicyIdParameter> - [-ActionForUnknownFileAndMIMETypes <Allow | ForceSave | Block>] - [-ActiveSyncIntegrationEnabled <$true | $false>] - [-AllAddressListsEnabled <$true | $false>] - [-AllowCopyContactsToDeviceAddressBook <$true | $false>] - [-AllowedFileTypes <MultiValuedProperty>] - [-AllowedMimeTypes <MultiValuedProperty>] - [-AllowOfflineOn <PrivateComputersOnly | NoComputers | AllComputers>] - [-BlockedFileTypes <MultiValuedProperty>] - [-BlockedMimeTypes <MultiValuedProperty>] - [-CalendarEnabled <$true | $false>] - [-ChangePasswordEnabled <$true | $false>] - [-ClassicAttachmentsEnabled <$true | $false>] - [-ConditionalAccessPolicy <Off | ReadOnly | ReadOnlyPlusAttachmentsBlocked>] - [-Confirm] - [-ContactsEnabled <$true | $false>] - [-DefaultClientLanguage <Int32>] - [-DefaultTheme <String>] - [-DelegateAccessEnabled <$true | $false>] - [-DirectFileAccessOnPrivateComputersEnabled <$true | $false>] - [-DirectFileAccessOnPublicComputersEnabled <$true | $false>] - [-DisableFacebook] - [-DisplayPhotosEnabled <$true | $false>] - [-DomainController <Fqdn>] - [-ExplicitLogonEnabled <$true | $false>] - [-ExternalSPMySiteHostURL <String>] - [-ForceSaveAttachmentFilteringEnabled <$true | $false>] - [-ForceSaveFileTypes <MultiValuedProperty>] - [-ForceSaveMimeTypes <MultiValuedProperty>] - [-ForceWacViewingFirstOnPrivateComputers <$true | $false>] - [-ForceWacViewingFirstOnPublicComputers <$true | $false>] - [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <$true | $false>] - [-ForceWebReadyDocumentViewingFirstOnPublicComputers <$true | $false>] - [-FreCardsEnabled <$true | $false>] - [-GlobalAddressListEnabled <$true | $false>] - [-GroupCreationEnabled <$true | $false>] - [-InstantMessagingEnabled <$true | $false>] - [-InstantMessagingType <None | Ocs | Msn>] - [-InterestingCalendarsEnabled <$true | $false>] - [-InternalSPMySiteHostURL <String>] - [-IRMEnabled <$true | $false>] - [-IsDefault] - [-JournalEnabled <$true | $false>] - [-JunkEmailEnabled <$true | $false>] - [-LinkedInEnabled <$true | $false>] - [-LocalEventsEnabled <$true | $false>] - [-LogonAndErrorLanguage <Int32>] - [-Name <String>] - [-NotesEnabled <$true | $false>] - [-OrganizationEnabled <$true | $false>] - [-OneDriveAttachmentsEnabled <$true | $false>] - [-OnSendAddinsEnabled <$true | $false>] - [-OutboundCharset <AlwaysUTF8 | AutoDetect | UserLanguageChoice>] - [-OutlookBetaToggleEnabled <$true | $false>] [<CommonParameters>] - [-OWALightEnabled <$true | $false>] - [-OWAMiniEnabled <$true | $false>] - [-PhoneticSupportEnabled <$true | $false>] - [-PlacesEnabled <$true | $false>] - [-PremiumClientEnabled <$true | $false>] - [-PrintWithoutDownloadEnabled <$true | $false>] - [-PublicFoldersEnabled <$true | $false>] - [-RecoverDeletedItemsEnabled <$true | $false>] - [-ReferenceAttachmentsEnabled <$true | $false>] - [-RemindersAndNotificationsEnabled <$true | $false>] - [-ReportJunkEmailEnabled <$true | $false>] - [-RulesEnabled <$true | $false>] - [-SatisfactionEnabled <$true | $false>] - [-SaveAttachmentsToCloudEnabled <$true | $false>] - [-SearchFoldersEnabled <$true | $false>] - [-SetPhotoEnabled <$true | $false>] - [-SetPhotoURL <String>] - [-SignaturesEnabled <$true | $false>] - [-SilverlightEnabled <$true | $false>] - [-SkipCreateUnifiedGroupCustomSharepointClassification <$true | $false>] - [-SMimeEnabled <$true | $false>] [-SpellCheckerEnabled <$true | $false>] - [-TasksEnabled <$true | $false>] - [-TextMessagingEnabled <$true | $false>] - [-ThemeSelectionEnabled <$true | $false>] - [-ThirdPartyAttachmentsEnabled <$true | $false>] - [-ThirdPartyFileProvidersEnabled <$true | $false>] - [-UMIntegrationEnabled <$true | $false>] - [-UNCAccessOnPrivateComputersEnabled <$true | $false>] - [-UNCAccessOnPublicComputersEnabled <$true | $false>] - [-UseGB18030 <$true | $false>] - [-UseISO885915 <$true | $false>] - [-UserVoiceEnabled <$true | $false>] - [-WacEditingEnabled <$true | $false>] - [-WacExternalServicesEnabled <$true | $false>] - [-WacOMEXEnabled <$true | $false>] - [-WacViewingOnPrivateComputersEnabled <$true | $false>] - [-WacViewingOnPublicComputersEnabled <$true | $false>] - [-WeatherEnabled <$true | $false>] - [-WebPartsFrameOptionsType <Deny | AllowFrom | None | SameOrigin>] - [-WebReadyDocumentViewingForAllSupportedTypes <$true | $false>] - [-WebReadyDocumentViewingOnPrivateComputersEnabled <$true | $false>] - [-WebReadyDocumentViewingOnPublicComputersEnabled <$true | $false>] - [-WebReadyDocumentViewingSupportedFileTypes <MultiValuedProperty>] - [-WebReadyDocumentViewingSupportedMimeTypes <MultiValuedProperty>] - [-WebReadyFileTypes <MultiValuedProperty>] - [-WebReadyMimeTypes <MultiValuedProperty>] - [-WhatIf] - [-WSSAccessOnPrivateComputersEnabled <$true | $false>] - [-WSSAccessOnPublicComputersEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -In on-premises Exchange, the default Outlook on the web mailbox policy is named Default. In Office 365, 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). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-OwaMailboxPolicy -Identity EMEA\Contoso\Corporate -CalendarEnabled $false -``` - -This example disables access to the calendar for the mailbox policy named Corporate for the tenant Contoso in the organization EMEA. - -### -------------------------- Example 2 -------------------------- -``` -Set-OwaMailboxPolicy -Identity Default -TasksEnabled $false -``` - -This example disables access to the Tasks folder for the default mailbox policy in an on-premises Exchange organization. - -### -------------------------- Example 3 -------------------------- -``` -Set-OwaMailboxPolicy -Identity OwaMailboxPolicy-Default -AllowedFileTypes '.doc', '.pdf' -``` - -This example sets the allowed file type extensions to .doc and .pdf for the default mailbox policy in an Office 365 organization, allowing users to save files with those extensions locally or view them from a web browser. - -### -------------------------- Example 4 -------------------------- -``` -Set-OwaMailboxPolicy -Identity OwaMailboxPolicy-Default -UserVoiceEnabled $false -``` - -This example disables Outlook UserVoice for the default mailbox policy in Office 365. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActionForUnknownFileAndMIMETypes -The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file types that aren't specified in the Allow, Block, and Force Save lists for file types and MIME types. Valid values are: - -- Allow (This is the default value.) - -- ForceSave - -- Block - -```yaml -Type: Allow | ForceSave | Block -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 -``` - -### -ActiveSyncIntegrationEnabled -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. - -- $false: ActiveSync isn't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -AllAddressListsEnabled -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. - -- $false: Only the global address list is visible in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -AllowCopyContactsToDeviceAddressBook -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. - -- $false: Contacts cann't be copied to the device's address book in Outlook on the web for devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedFileTypes -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 - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the same file types are specified in multiple lists: - -- The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedMimeTypes -The AllowedMimeTypes parameter specifies the MIME extentions of attachments that allow the attachments to be saved locally or viewed from Outlook on the web. The default values are: - -- image/bmp - -- image/gif - -- image/jpeg - -- image/png - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the same MIME types are specified in multiple lists: - -- The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOfflineOn -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 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. - -When offline mode is available, uers can turn offline mode on or off themselves in Outlook on the web. For more information, see [Using Outlook Web App offline](https://go.microsoft.com/fwlink/p/?linkid=267644). - -```yaml -Type: PrivateComputersOnly | NoComputers | AllComputers -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedFileTypes -The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: - -.ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .chm, .cmd, .com, .cpl, .csh, .exe, .fxp, .gadget, .hlp, .hta, .htc, .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, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .tmp, .url, .vb, .vbe, .vbs, .vsmacros, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the same file types are specified in multiple lists: - -- The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedMimeTypes -The BlockedMimeTypes parameter specifies MIME extentions in attachments that prevent the attachments from being saved locally or viewed from Outlook on the web. The default values are: - -- application/hta - -- application/javascript - -- application/msaccess - -- application/prg - -- application/x-javascript - -- text/javascript - -- text/scriplet - -- x-internet-signup - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the same MIME types are specified in multiple lists: - -- The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarEnabled -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. - -- $false: The Calendar isn't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -ChangePasswordEnabled -This parameter is available or 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. - -- $false: The Change password option isn't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -ClassicAttachmentsEnabled -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. - -- $false: Users can't attach local files to email messages in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalAccessPolicy -This parameter is available only in the cloud-based service. - -The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to properly work, you will need to additioanlly configure a Conditional Access policy in the Azure Active Directory Portal. - -Valid values are: - -- Off: No conditional access policy is applied to Outlook on the web. This is the default value. - -- ReadOnly: Users can't download attachments to their local computer, and can't enable Offline Mode on non-compliant computers. They can still view attachments in the browser. - -- ReadOnlyPlusAttachmentsBlocked: All restrictions from ReadOnly apply, but users can't view attachments in the browser. - -```yaml -Type: Off | ReadOnly | ReadOnlyPlusAttachmentsBlocked -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -ContactsEnabled -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. - -- $false: Contacts aren't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -DefaultClientLanguage -This parameter has been deprecated and is 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultTheme -The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://docs.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). - -Note that 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegateAccessEnabled -This parameter is available or 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. - -- $false: Delegates can't open the mailbox in Outlook Web App. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectFileAccessOnPrivateComputersEnabled -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. - -By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. - -```yaml -Type: $true | $false -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 -``` - -### -DirectFileAccessOnPublicComputersEnabled -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. - -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). - -```yaml -Type: $true | $false -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 -``` - -### -DisableFacebook -This parameter is available only in the cloud-based service. - -The DisableFacebook switch specifies whether users can synchronize their Facebook contacts to their Contacts folder in Outlook on the web. By default, Facebook integration is enabled. - -- To disable Facebook integration, use this switch without a value. - -- To enable Facebook ingetration after it's been disabled, use this exact syntax: -DisableFacebook:$false. - -Note that the value of this parameter is stored in the FacebookEnabled property in the output of the Get-OwaMailboxPolicy cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayPhotosEnabled -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. - -- $false: Users don't see sender photos in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExplicitLogonEnabled -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. - -- $false: A user with the required permissions isn't able to open someone else's mailbox in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -ExternalSPMySiteHostURL -The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, https://sp01.contoso.com). - -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceSaveAttachmentFilteringEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -ForceSaveFileTypes -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 - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the same file types are specified in multiple lists: - -- The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceSaveMimeTypes -The ForceSaveMimeTypes parameter specifies the MIME extentions in attachments that only allow the attachments to be saved locally (not opened). The default values are: - -- Application/futuresplash - -- Application/octet-stream - -- Application/x-director - -- Application/x-shockwave-flash - -- text/html - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -If the same MIME types are specified in multiple lists: - -- The Allow list overrides the Block list and the Force Save list. - -- The Block list overrides the Force Save list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceWacViewingFirstOnPrivateComputers -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. - -By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceWacViewingFirstOnPublicComputers -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. - -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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceWebReadyDocumentViewingFirstOnPrivateComputers -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. - -By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceWebReadyDocumentViewingFirstOnPublicComputers -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. - -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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FreCardsEnabled -This parameter is available only in the cloud-based service. - -The FreCardsEnabled parameter specifies whether the theme, signature, and phone cards are available in Outlook on the web. Valid values are: - -- $true: The theme, signature, and phone cards are visible in Outlook on the web. This is the default value. - -- $false: The theme, signature, and phone cards aren't visible in Outlook on the web. Only the introduction, time zone, and final cards are visible. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalAddressListEnabled -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. - -- $false: The global address list isn't visible in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -GroupCreationEnabled -This parameter is available or functional only in the cloud-based service. - -The GroupCreationEnabled parameter specifies whether Office 365 group creation is available in Outlook on the web. Valid values are: - -- $true: Users can create Office 365 groups in Outlook on the web. This is the default value. - -- $false: Users can't create Office 365 groups in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstantMessagingEnabled -The InstantMessagingEnabled parameter specifies whether instant messaging is available in Outlook on the web. Valid values are: - -- $true: Instant messaging is available in Outlook on the web. This is the default value. - -- $false: Instnant messaging isn't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -InstantMessagingType -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. - -```yaml -Type: None | Ocs | Msn -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 -``` -### -InterestingCalendarsEnabled -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. - -- $false: Interesting calendars aren't available in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalSPMySiteHostURL -The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, https://sp01.contoso.com). - -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IRMEnabled -The IRMEnabled parameter specifies whether Information Rights Management (IRM) features are avaiable in Outlook on the web. Valid values are: - -- $true: IRM is available in Outlook on the web. This is the default value. - -- $false: IRM isn't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -IsDefault -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalEnabled -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. - -- $false: The Journal folder isn't visible in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -JunkEmailEnabled -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. - -- $true: The Junk Email folder and junk email management are available in Outlook on the web. This is the default value. - -- $false: The Junk Email folder and junk email management aren't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -LinkedInEnabled -This parameter is available only in the cloud-based service. - -The LinkedInEnabled parameter specifies whether users can synchronize their LinkedIn contacts to their Contacts folder. Valid values are: - -- $true: LinkedIn integration is enabled. This is the default value. - -- $false: LinkedIn integration is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalEventsEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogonAndErrorLanguage -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. - -The default value is 0, which means the logon and error language selection is undefined. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name for the policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotesEnabled -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. - -- $false: The Notes folder isn't visible in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -OneDriveAttachmentsEnabled -The OneDriveAttachmentsEnabled parameter specifies whether to allow OneDrive attachments in Outlook on the web. Valid values are: - -- $true: OneDrive attachments are enabled. This is the default value. - -- $false: OneDrive attachments are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnSendAddinsEnabled -This parameter is available or functional only in the cloud-based service. - -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: - -- $true: On send add-ins are enabled. - -- $false: On send add-ins are disabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationEnabled -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: $true | $false -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 -``` - -### -OutboundCharset -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. - -- 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. - -```yaml -Type: AlwaysUTF8 | AutoDetect | UserLanguageChoice -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 -``` - -### -OutlookBetaToggleEnabled -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. - -- $false: Outlook on the web Preview is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWALightEnabled -The OWALightEnabled parameter controls the availability of the light version of Outlook on the web. Valid values are: - -- $true: The light version of Outlook on the web is available. This is the default value. - -- $false: The light version of Outlook on the web is isn't available. This setting prevents access to Outlook on the web for unsupported browsers that can only use the light version of Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -OWAMiniEnabled -This parameter is available or functional 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. - -- $false: The mini version of Outlook Web App isn't available. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneticSupportEnabled -The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. - -```yaml -Type: $true | $false -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 -``` - -### -PlacesEnabled -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. - -- $false: Places is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PremiumClientEnabled -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. - -- $false: The full version of Outlook Web App isn't available. - -```yaml -Type: $true | $false -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 -``` - -### -PrintWithoutDownloadEnabled -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 web app. This is the default value. - -- $false: Supported files must be downloaded before they can be printed in Outlook web app. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFoldersEnabled -This parameter is available or 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. - -- $false: Public folders aren't available in Outlook Web App. - -```yaml -Type: $true | $false -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 -``` - -### -RecoverDeletedItemsEnabled -This parameter is available or 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. - -- $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: $true | $false -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 -``` - -### -ReferenceAttachmentsEnabled -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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemindersAndNotificationsEnabled -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. - -- $false: Notifications and reminders are disabled in Outlook on the web. - -This parameter doesn't apply to the light version of Outlook Web App. - -```yaml -Type: $true | $false -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 -``` - -### -ReportJunkEmailEnabled -The ReportJunkEmailEnabled parameter specifies whether users can report messages to Microsoft or unsubscribe from messages in Outlook on the web. Valid values are: - -- $true: The Report junk, Report phishing or Report not junk options are available after the user selects Mark as junk, Mark as phishing, or Mark as not junk. The Unsubscribe option is also available. This is the default value. - -- $false: The Report junk, Report phishing, Report not junk and Unsubscribe options aren't available. - -This parameter is meaningful only when the JunkEmailEnabled parameter is set to $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RulesEnabled -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. - -- $false: Users can't view, create, or modify server-side rules in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -SatisfactionEnabled -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. - -- $false: The satisfaction survey is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SaveAttachmentsToCloudEnabled -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. - -- $false: Users can only save regular email attachments locally. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchFoldersEnabled -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. - -- $false: Search Folders aren't visible in Outlook on the Web. - -```yaml -Type: $true | $false -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 -``` - -### -SetPhotoEnabled -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. - -- $false: Users can't manage their user photo in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetPhotoURL -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignaturesEnabled -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. - -- $false: Signatures aren't available in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -SilverlightEnabled -This parameter is available or 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. - -- $false: Silverlight features aren't available in Outlook Web App. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipCreateUnifiedGroupCustomSharepointClassification -This parameter is available only in the cloud-based service. - -The SkipCreateUnifiedGroupCustomSharepointClassification parameter specifies whether to skip a custom Sharepoint page during the creation of Office 365 Groups in Outlook web app. Valid values are: - -- $true: The custom SharePoint page is skipped when a user creates an Office 365 group in Outlook on the web. This is the default value. - -- $false: The custom SharePoint page is shown when a user creates an Office 365 group in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SMimeEnabled -This parameter is available or functional only in Exchange Server 2010. - -The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: - -- $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. - -- $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. - -**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see {S/MIME for message signing and encryption](https://technet.microsoft.com/library/dn626158.aspx). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpellCheckerEnabled -This parameter is available or functional only in Exchange Server 2010. - -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. - -- $false: Spell checking isn't available in Outlook Web App. - -This parameter doesn't apply to the light version of Outlook Web App. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TasksEnabled -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. - -- $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. - -```yaml -Type: $true | $false -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 -``` - -### -TextMessagingEnabled -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. - -- $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. - -```yaml -Type: $true | $false -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 -``` - -### -ThemeSelectionEnabled -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. - -- $false: Users can't specify or change the theme in Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -ThirdPartyAttachmentsEnabled -This parameter is available only in the cloud-based service. - -This parameter has been deprecated and is no longer used. - -To enable or disable third party attachments in Outlook on the web, use the ThirdPartyFileProvidersEnabled parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThirdPartyFileProvidersEnabled -This parameter is available only in the cloud-based service. - -The ThirdPartyFileProvidersEnabled parameter specifies whether to allow third-party (for example, Box, Dropbox, and Egnyte) attachments in Outlook on the web. Valid values are: - -- $true: Third-party attachments are enabled in Outlook on the web. Users can connect their third-party file sharing accounts and share files over emailp. - -- $false: Third-party attachments are disabled in Outlook on the web. Users can't connect their third-party file sharing accounts or share files over email. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMIntegrationEnabled -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. - -- $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 parameter doesn't apply to the light version of Outlook on the web. - -```yaml -Type: $true | $false -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 -``` - -### -UNCAccessOnPrivateComputersEnabled -This parameter is available only in on-premises Exchange. - -This parameter has been deprecated and is no longer used. - -```yaml -Type: $true | $false -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 -``` - -### -UNCAccessOnPublicComputersEnabled -This parameter is available only in on-premises Exchange. - -This parameter has been deprecated and is no longer used. - -```yaml -Type: $true | $false -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 -``` - -### -UseGB18030 -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. - -```yaml -Type: $true | $false -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 -``` - -### -UseISO885915 -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. - -```yaml -Type: $true | $false -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 -``` - -### -UserVoiceEnabled -This parameter is available 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 Office 365. Valid values are: - -- $true: Outlook UserVoice is enabled. This is the default value. - -- $false: Outlook UserVoice is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WacEditingEnabled -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. - -- $false: Users can't edit supported documents in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WacExternalServicesEnabled -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. - -- $false: External services are disabled when viewing supported documents in Outlook on the web. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WacOMEXEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WacViewingOnPrivateComputersEnabled -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. - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WacViewingOnPublicComputersEnabled -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. - -- $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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeatherEnabled -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. - -- $false: Weather is disabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebPartsFrameOptionsType -The WebPartsFrameOptionsType parameter specifies what sources can access web parts in IFRAME or FRAME elements in Outlook on the web. Valid values are: - -- None: Tthere 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. - -- 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: Deny | AllowFrom | None | SameOrigin -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyDocumentViewingForAllSupportedTypes -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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyDocumentViewingOnPrivateComputersEnabled -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 availble in private computer sessions. This is the default value. - -- $false: WebReady Document Viewing isn't availble in private computer sessions. - -By default in Exchange 2013, all Outlook on the web sessions are considered to be on private computers. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyDocumentViewingOnPublicComputersEnabled -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 availble for public computer sessions. This is the default value. - -- $false: WebReady Document Viewing isn't availble 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). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyDocumentViewingSupportedFileTypes -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyDocumentViewingSupportedMimeTypes -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyFileTypes -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: - -- .doc - -- .docx - -- .dot - -- .pdf - -- .pps - -- .ppt - -- .pptx - -- .rtf - -- .xls - -- .xlsx - -You can only remove or add values from within the list of supported file types (you can't add additional values). - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported file types are available in WebReady Document Viewing. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebReadyMimeTypes -This parameter is available only in Exchange Server 2010 and Exchange Server 2013. - -The WebReadyMimeTypes parameter specifies the MIME extentions 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: - -- application/msword - -- application/pdf - -- application/vnd.ms-excel - -- application/vnd.ms-powerpoint - -- application/vnd.openxmlformats-officedocument.presentationml.presentation - -- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - -- application/vnd.openxmlformats-officedocument.wordprocessingml.document - -- application/x-msexcel - -- application/x-mspowerpoint - -You can only remove or add values from within the list of supported file types (you can't add additional values). - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported MIME types are available in WebReady Document Viewing. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WSSAccessOnPrivateComputersEnabled -This parameter has been deprecated and is no longer used. - -```yaml -Type: $true | $false -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 -``` - -### -WSSAccessOnPublicComputersEnabled -This parameter has been deprecated and is no longer used. - -```yaml -Type: $true | $false -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/530166f7-ab42-4609-ba73-9b5a39b567be.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Set-TextMessagingAccount.md b/exchange/exchange-ps/exchange/client-access/Set-TextMessagingAccount.md deleted file mode 100644 index 8b5145107d..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Set-TextMessagingAccount.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-TextMessagingAccount -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -The Set-TextMessagingAccount cmdlet allows a user to configure the text messaging settings on their own mailbox. An administrator can't use this cmdlet to configure the text messaging settings on another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-TextMessagingAccount [-Identity] <MailboxIdParameter> [-Confirm] [-CountryRegionId <RegionInfo>] - [-DomainController <Fqdn>] [-IgnoreDefaultScope] [-MobileOperatorId <Int32>] - [-NotificationPhoneNumber <E164Number>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-TextMessagingAccount cmdlet configures a user's account for text messaging notifications. You can configure several settings, including the mobile phone number and country or region ID. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TextMessagingAccount -Identity 'JeffHay' -NotificationPhoneNumber 4255550100 -``` - -This example sets the notification phone number for the text messaging account for Jeff Hay. - -### -------------------------- Example 2 -------------------------- -``` -Set-TextMessagingAccount -Identity 'JeffHay' -CountryRegionId US -MobileOperatorId 15001 -NotificationPhoneNumber +14255550199 -``` - -This example sets the region, mobile operator and notification phone number for the text messaging account for Jeff Hay. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the target mailbox. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryRegionId -The CountryRegionId parameter specifies the country or region in which the user's mobile operator resides. - -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://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobileOperatorId -The MobileOperatorId parameter specifies the mobile operator ID for the user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationPhoneNumber -The NotificationPhoneNumber parameter specifies the telephone number to use for text messaging notifications. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dea91ccf-5572-40f1-a133-859c6aa58095.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/client-access/Test-ClientAccessRule.md deleted file mode 100644 index 9856a0d6d4..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Test-ClientAccessRule.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2019, Exchange Online -title: Test-ClientAccessRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2019 || exchonline-ps" ---- - -# Test-ClientAccessRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-ClientAccessRule - -AuthenticationType <BasicAuthentication | NonBasicAuthentication | AdfsAuthentication | CertificateBasedAuthentication | OAuthAuthentication> - -Protocol <ExchangeWebServices | RemotePowerShell | OutlookAnywhere | POP3 | IMAP4 | OutlookWebApp | ExchangeAdminCenter | ExchangeActiveSync | OfflineAddressBook | PowerShellWebServices | REST> -RemoteAddress <IPAddress> -RemotePort <Int32> -User <MailboxIdParameter> [-Confirm] - [-OAuthClaims <Hashtable>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. - -Note: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: - -- OutlookWebApp:BasicAuthentication and AdfsAuthentication. - -- ExchangeAdminCenter:BasicAuthentication and AdfsAuthentication. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-ClientAccessRule -AuthenticationType BasicAuthentication -Protocol OutlookWebApp -RemoteAddress 172.17.17.26 -RemotePort 443 -User julia@contoso.com -``` - -This example tests client access by using the following client properties: - -- Authentication type: Basic - -- Protocol:OutlookWebApp - -- Remote address: 172.17.17.26 - -- Remote port: 443 - -- User: julia@contoso.com - -## PARAMETERS - -### -AuthenticationType -The AuthenticationType parameter specifies the client authentication type to test. - -Valid values for this parameter are: - -- AdfsAuthentication - -- BasicAuthentication - -- CertificateBasedAuthentication - -- NonBasicAuthentication - -- OAuthAuthentication - -In client access rules, authentication types are defined by the AnyOfAuthenticationTypes and ExceptAnyOfAuthenticationTypes parameters. - -```yaml -Type: BasicAuthentication | NonBasicAuthentication | AdfsAuthentication | CertificateBasedAuthentication | OAuthAuthentication -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -The Protocol parameter specifies the client protocol to test. - -Valid values for this parameter are: - -- ExchangeActiveSync - -- ExchangeAdminCenter - -- ExchangeWebServices - -- IMAP4 - -- OfflineAddressBook - -- OutlookAnywhere - -- OutlookWebApp - -- POP3 - -- PowerShellWebServices - -- RemotePowerShell - -- REST - -In client access rules, protocol types are defined by the AnyOfProtocols and ExceptAnyOfProtocols parameters. - -```yaml -Type: ExchangeWebServices | RemotePowerShell | OutlookAnywhere | POP3 | IMAP4 | OutlookWebApp | ExchangeAdminCenter | ExchangeActiveSync | OfflineAddressBook | PowerShellWebServices | REST -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteAddress -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. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemotePort -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 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user account to test. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -In client access rules, users are defined by the UsernameMatchesAnyOfPatterns, UserRecipientFilter, and ExceptUsernameMatchesAnyOfPatterns parameters. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OAuthClaims -The OAuthClaims parameter specifies the OAuth claims token of a middle-tier app. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d17ee6d8-e5f4-4b5d-977c-85e8dadeaf48.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-ImapConnectivity.md b/exchange/exchange-ps/exchange/client-access/Test-ImapConnectivity.md deleted file mode 100644 index 2f84e4d040..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Test-ImapConnectivity.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ImapConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-ImapConnectivity - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-ImapConnectivity cmdlet to verify that connectivity to the Microsoft Exchange IMAP4 service is working as expected. - -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-ImapConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-Confirm] - [-ConnectionType <Plaintext | Tls | Ssl>] [-DomainController <Fqdn>] [-LightMode] - [-MailboxCredential <PSCredential>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext] - [-PerConnectionTimeout <Int32>] [-PortClientAccessServer <Int32>] [-ResetTestAccountCredentials] - [-Timeout <UInt32>] [-TrustAnySSLCertificate] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-ImapConnectivity cmdlet tests IMAP4 connectivity by connecting to the specified mailbox, the specified Exchange server, or all Exchange servers that are available in the local Active Directory site. - -The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: - -& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 - -The test results are displayed on-screen. The cmdlet returns the following information. - -- CasServer: The Exchange server that the client connected to. - -- LocalSite: The name of the local Active Directory site. - -- Scenario: The operations that are tested. Test IMAP4 Connectivity connects to the server using the IMAP4 protocol, searches for the test message and deletes it along with any messages that are older than 24 hours. - -- Result: The values returned are typically Success, Skipped or Failure. - -- Latency(MS): The time required to complete the test in milliseconds. - -- Error: Any error messages that were encountered. - -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: - -Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "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://technet.microsoft.com/library/mt432940.aspx). - -**Important Note**: In Exchange 2013 or later, when you run this command to test a single mailbox on an Exchange server that isn't hosting the active maildbox database copy for the mailbox, you might see the following error message: - -Unable to create MailboxSession object to access the mailbox \[user@consoto.com\]. Detailed error information: \[Microsoft.Exchange.Data.Storage.WrongServerException\]: The user and the mailbox are in different Active Directory sites. Inner error \[Microsoft.Mapi.MapiExceptionMailboxInTransit\]: MapiExceptionMailboxInTransit: Detected site violation \(hr=0x0, ec=1292\) - -When you receive this error, run the command again on the server that's hosting the active mailbox database copy to verify that IMAP works for the mailbox. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-ImapConnectivity -ClientAccessServer Contoso12 -MailboxCredential (Get-Credential contoso\kweku) -``` - -This example tests the client IMAP4 connectivity for the server named Contoso12 by using the credentials for the user contoso\\kweku. - -### -------------------------- Example 2 -------------------------- -``` -Test-ImapConnectivity -ClientAccessServer Contoso12 -``` - -This example tests the client IMAP4 connectivity of the server named Contoso12 and tests all Exchange mailboxes. - -## PARAMETERS - -### -ClientAccessServer -The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. - -You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 -``` - -### -ConnectionType -The ConnectionType parameter specifies the type of connection that's used to connect to the IMAP4 service. Valid values are: - -- Plaintext - -- Ssl - -- Tls - -```yaml -Type: Plaintext | Tls | Ssl -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 -``` - -### -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 -``` - -### -LightMode -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxCredential -The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. - -You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. - -```yaml -Type: ServerIdParameter -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 -``` - -### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerConnectionTimeout -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. - -```yaml -Type: Int32 -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 -``` - -### -PortClientAccessServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -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. - -```yaml -Type: UInt32 -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 -``` - -### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. - -This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. - -```yaml -Type: SwitchParameter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/273690c8-4e0d-4f05-8786-11d71868dae0.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-OutlookConnectivity.md b/exchange/exchange-ps/exchange/client-access/Test-OutlookConnectivity.md deleted file mode 100644 index ca7a33f630..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Test-OutlookConnectivity.md +++ /dev/null @@ -1,579 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-OutlookConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-OutlookConnectivity - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange organization. This includes testing for both Outlook Anywhere (RPC over HTTP) and MAPI over HTTP connections. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Probe -``` -Test-OutlookConnectivity [-ProbeIdentity] <String> [-Credential <PSCredential>] [-Hostname <String>] - [-MailboxId <MailboxIdParameter>] [-RunFromServerId <ServerIdParameter>] [-TimeOutSeconds <String>] - [<CommonParameters>] -``` - -### Protocol -``` -Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -Protocol <HTTP | TCP | WS> - [-Archive <$true | $false>] - [-Confirm] - [-MailboxCredential <PSCredential>] - [-MonitoringContext] - [-TotalTimeoutInMinutes <Int32>] - [-TrustAnySslCert] - [-WhatIf] [<CommonParameters>] -``` - -### RpcProxyServer -``` -Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -GetDefaultsFromAutodiscover <$true | $false> - [-Archive <$true | $false>] - [-Confirm] - [-MailboxCredential <PSCredential>] - [-RpcAuthenticationType <Negotiate | NTLM | Kerberos>] - [-RpcClientAccessServer <ClientAccessServerIdParameter>] - [-RpcProxyAuthenticationType <Basic | NTLM | Negotiate>] - [-RpcProxyServer <ServerIdParameter>] - [-TotalTimeoutInMinutes <Int32>] - [-TrustAnySslCert] - [-WhatIf] [<CommonParameters>] - - [-MonitoringContext] -``` - -### RpcTestType -``` -Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -RpcTestType <Array | Server> - [-Archive <$true | $false>] - [-Confirm] - [-MailboxCredential <PSCredential>] - [-MonitoringContext] - [-RpcAuthenticationType <Negotiate | NTLM | Kerberos>] - [-RpcClientAccessServer <ClientAccessServerIdParameter>] - [-RpcProxyAuthenticationType <Basic | NTLM | Negotiate>] - [-RpcProxyTestType <External | Internal>] - [-TotalTimeoutInMinutes <Int32>] - [-TrustAnySslCert] - [-WhatIf] [<CommonParameters>] -``` - -### WSTestType -``` -Test-OutlookConnectivity [[-Identity] <MailboxIdParameter>] -WSTestType <Unknown | Internal | External> - [-Archive <$true | $false>] - [-Confirm] - [-MailboxCredential <PSCredential>] - [-MonitoringContext] - [-TotalTimeoutInMinutes <Int32>] - [-TrustAnySslCert] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Running the Test-OutlookConnectivity cmdlet validates an Outlook connection defined by the provided parameters. The command is able to validate a single mailbox. - -The Test-OutlookConnectivity cmdlet runs the same process as the monitoring probes. The Microsoft Exchange Health Manager (MSExchangeHM) service must be running and have created the Outlook probes on the machine that will be tested. You need to select one of the Outlook probe identities to run the test. Use the Get-MonitoringItemIdentity (https://go.microsoft.com/fwlink/p/?LinkId=510841) cmdlet to see what probes are active. - -This example lists the probes running in the backend services on a Mailbox server. - -This example lists the probes running in the client access services on a Mailbox server. - -For more information on probes and the monitoring framework, see Managed Availability (https://go.microsoft.com/fwlink/p/?LinkId=510838), Managed Availability and Server Health (https://go.microsoft.com/fwlink/p/?LinkId=510839), and Customizing Managed Availability (https://go.microsoft.com/fwlink/p/?LinkId=510840) - -By default, the cmdlet uses the test monitoring account attached to the specifed probe. You may enter a different mailbox instead via the MailboxId parameter. The options and results follow. - -- MailboxId and Credential are not specified: Generic connectivity test against a test mailbox using the system's test credentials. - -- MailboxId is specified, Credential is not: Connectivity test to the specific mailbox using the system's test credentials. - -- MailboxId and Credential are both specified: You get a connectivity test to the specific mailbox, and also a test that the credentials provided are valid for that 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-OutlookConnectivity -Protocol:HTTP -GetDefaultsFromAutoDiscover:$true -``` - -In Exchange 2010, this example tests the most common end-to-end Outlook connectivity scenario for Outlook Anywhere. This includes testing for connectivity through the Autodiscover service, creating a user profile, and logging on to the user mailbox. All of the required values are retrieved from the Autodiscover service. Because the Identity parameter isn't specified, the command uses the temporary test user that you've created using the New-TestCasConnectivityUser.ps1 script. This example command can be run to test TCP/IP connectivity by setting the Protocol parameter to RPC. - -### -------------------------- Example 2 -------------------------- -``` -Test-OutlookConnectivity -ProbeIdentity "OutlookRpcSelfTestProbe" -``` - -In Exchange 2013 or later, this example runs an OutlookRpcSelfTestProbe on the mailbox server that you're currently connected to. - -### -------------------------- Example 3 -------------------------- -``` -Test-OutlookConnectivity -RpcProxyTestType:Internal -RpcTestType:Server -``` - -In Exchange 2010, this example tests for Outlook Anywhere connectivity using the local server as the RpcProxy endpoint as well as the RPC endpoint. Because the Identity parameter isn't specified, the command uses the temporary test user that you've created using the New-TestCasConnectivityUser.ps1 script. Modify this example to use the public external URL by setting the RpcProxyTestType parameter to External. Additionally, the example command can use the Client Access server array as the RPC endpoint by setting the RpcTestType parameter to Array. To only validate TCP/IP connectivity, omit the RpcProxyTestType parameter. - -### -------------------------- Example 4 -------------------------- -``` -Test-OutlookConnectivity "OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId johnd@contoso.com -``` - -In Exchange 2013 or later, this example runs the OutlookRpcDeepTestProbe from the "PrimaryMailbox" server for the mailbox "johnd@contoso.com" mounted on "Mailbox Database 1234512345". Because the Credential parameter is not specified, the probe will use the default testing credentials. - -### -------------------------- Example 5 -------------------------- -``` -Test-OutlookConnectivity -RpcProxyServer:RpcProxySrv01 -RpcProxyAuthenticationType:Basic -RpcClientAccessServer:CAS01 -RpcAuthenticationType:NTLM -``` - -In Exchange 2010, this example validates Outlook connectivity through RpcProxy on one server to a different server running the Client Access server role with Basic for the outer authentication layer and NTLM for the inner authentication layer. Using these parameters should allow you to validate most types of Outlook connectivity configurations. This command can also be used with the GetDefaultsFromAutoDiscover parameter set to $true if you only need to override one or two parameters. This following command is similar to running a connectivity test using the RPC Ping utility but provides stronger validation. - -### -------------------------- Example 6 -------------------------- -``` -$TestCredentials = Get-Credential; -Test-OutlookConnectivity -ProbeIdentity OutlookRpcCtpProbe -MailboxId johnd@contoso.com -Credential $TestCredentials -``` - -In Exchange 2013 or later, this example runs the OutlookRpcCtpProbe and verifies the log-on credentials for the "johnd@contoso.com" mailbox. - -### -------------------------- Example 7 -------------------------- -``` -Test-OutlookConnectivity -ProbeIdentity "OutlookRpcCTPProbe" -MailboxID johnd@contoso.com -``` - -In Exchange 2013 or later, this example runs a logon test from the client access services on a Mailbox server for the mailbox johnd@contoso.com. - -## PARAMETERS - -### -Identity -This parameter is available or functional only in Exchange Server 2010. - -The Identity parameter specifies a target user mailbox. This value can be the mailbox GUID or can be the domain name\\user, for example, contoso.com\\erin. If the parameter isn't specified, the command looks for a test user in Active Directory. You need to create the test user with the New-TestCasConnectivityUser.ps1 script. - -```yaml -Type: MailboxIdParameter -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -GetDefaultsFromAutodiscover -This parameter is available or functional 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. - -```yaml -Type: $true | $false -Parameter Sets: RpcProxyServer -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -This parameter is available or functional 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. - -```yaml -Type: HTTP | TCP | WS -Parameter Sets: Protocol -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcTestType -This parameter is available or functional only in Exchange Server 2010. - -The RpcTestType parameter specifies which type of RPC endpoint the command should test. Valid values are Server or Array. If Server is specified, the command uses the local server as the RPC endpoint. If Array is specified, the command looks for a ClientAccessArray object in the same Active Directory site where the command is being run. - -```yaml -Type: Array | Server -Parameter Sets: RpcTestType -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WSTestType -This parameter is available or functional 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 - -- Internal - -- External - -- The default value is Unknown. - -```yaml -Type: Unknown | Internal | External -Parameter Sets: WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Archive -This parameter is available or functional only in Exchange Server 2010. - -The Archive parameter specifies whether tests should be performed to connect to the user's on-premises archive mailbox. You don't need to specify a value for this parameter. - -```yaml -Type: $true | $false -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -This parameter is available or functional 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. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: cf -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default. This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: Probe -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 -``` - -### -Hostname -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxCredential -This parameter is available or functional 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. - -```yaml -Type: PSCredential -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MailboxId -The MailboxID parameter specifies the target mailbox. IF not specified, this uses the test account. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Probe -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 -``` - -### -MonitoringContext -This parameter is available or functional only in Exchange Server 2010. - -The MonitoringContext parameter specifies whether the command returns additional information that can be used with Microsoft System Center Operations Manager 2007. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeIdentity -The ProbeIdentity parameter specifies the probe to use. - -- RPC over HTTP (Outlook Anywhere) probes - -- MAPI over HTTP probes - -```yaml -Type: String -Parameter Sets: Probe -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcAuthenticationType -This parameter is available or functional 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: - -- NTLM - -- Kerberos - -- Negotiate - -The default value is Negotiate. - -```yaml -Type: Negotiate | NTLM | Kerberos -Parameter Sets: RpcProxyServer, RpcTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcClientAccessServer -This parameter is available or functional 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. - -```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: RpcProxyServer, RpcTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RpcProxyAuthenticationType -This parameter is available or functional 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. - -```yaml -Type: Basic | NTLM | Negotiate -Parameter Sets: RpcProxyServer, RpcTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcProxyServer -This parameter is available or functional 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. - -```yaml -Type: ServerIdParameter -Parameter Sets: RpcProxyServer -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RpcProxyTestType -This parameter is available or functional only in Exchange Server 2010. - -The RpcProxyTestType parameter specifies which HTTP endpoint the command should connect to. The value can be Internal or External. The Internal value refers to the local computer name (http://\<localcomputername\>, for example, http://CAS01). The External value refers to a public namespace (the external HTTP URL on the /rpc virtual directory, for example, http://mail.contoso.com). - -```yaml -Type: External | Internal -Parameter Sets: RpcTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFromServerId -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: String -Parameter Sets: Probe -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 -``` - -### -TotalTimeoutInMinutes -This parameter is available or functional 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. - -```yaml -Type: Int32 -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustAnySslCert -This parameter is available or functional only in Exchange Server 2010. - -The TrustAnySslCert parameter can be set to $true to ignore any Secure Sockets Layer (SSL) certificate warnings. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is available or functional 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. - -```yaml -Type: SwitchParameter -Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType -Aliases: wi -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/09d810f1-0550-4cd3-8feb-f524018a5d6b.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-OutlookWebServices.md b/exchange/exchange-ps/exchange/client-access/Test-OutlookWebServices.md deleted file mode 100644 index 77e4aa60c0..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Test-OutlookWebServices.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010 -title: Test-OutlookWebServices -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Test-OutlookWebServices - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Test-OutlookWebServices cmdlet to verify the Autodiscover service settings for Microsoft Outlook on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-OutlookWebServices [[-Identity] <RecipientIdParameter>] - [-ClientAccessServer <ClientAccessServerIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-MonitoringContext <$true | $false>] [-TargetAddress <RecipientIdParameter[]>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-OutlookWebServices -Identity:holly@contoso.com -``` - -This example verifies the service information that's returned to the Outlook client from the Autodiscover service for the user holly@contoso.com. The code example verifies information for the following services: - -- Availability service - -- Outlook Anywhere - -- Offline address book - -- Unified Messaging - -The example tests for a connection to each service. The example also submits a request to the Availability service for the user holly@contoso.com to determine whether the user's free/busy information is being returned correctly from the Client Access server to the Outlook client. - -## PARAMETERS - -### -ClientAccessServer -This parameter is available or functional only in Exchange Server 2010. - -The ClientAccessServer parameter specifies the Client Access server that the client accesses. - -```yaml -Type: ClientAccessServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies any valid address in the forest. If you specify this parameter, incorrectly formed addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and user name in the domain\\user name 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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MonitoringContext -The MonitoringContext parameter specifies whether the results of the command include monitoring events and performance counters. The two possible values for this parameter are $true or $false. If you specify $true, the results include monitoring events and performance counters, in addition to information about the MAPI transaction. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAddress -The TargetAddress parameter specifies the recipient that's used to test whether Availability service data can be retrieved. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c41152b0-b304-4b13-b8ea-a24e2c2c3ea8.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-PopConnectivity.md b/exchange/exchange-ps/exchange/client-access/Test-PopConnectivity.md deleted file mode 100644 index d40a9f42f3..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Test-PopConnectivity.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-PopConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-PopConnectivity - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-PopConnectivity cmdlet to verify that the Microsoft Exchange POP3 service is working as expected. - -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-PopConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-Confirm] - [-ConnectionType <Plaintext | Tls | Ssl>] [-DomainController <Fqdn>] [-LightMode] - [-MailboxCredential <PSCredential>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext] - [-PerConnectionTimeout <Int32>] [-PortClientAccessServer <Int32>] [-ResetTestAccountCredentials] - [-Timeout <UInt32>] [-TrustAnySSLCertificate] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-PopConnectivity cmdlet tests POP3 connectivity by connecting to a specified mailbox, a specified Exchange server, or all Exchange servers that are available in the local Active Directory site. - -The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: - -& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 - -The test results are displayed on-screen. The cmdlet returns the following information. - -- CasServer: The Exchange server that the client connected to. - -- LocalSite: The name of the local Active Directory site. - -- Scenario: The operations that are tested. Test POP3 Connectivity connects to the server using the POP3 protocol, searches for the test message, and deletes the test message. - -- Result: The values returned are typically Success, Skipped or Failure. - -- Latency(MS): The time required to complete the test in milliseconds. - -- Error: Any error messages that were encountered. - -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: - -Test-PopConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-PopConnectivity -ClientAccessServer Contoso12 -MailboxCredential (Get-Credential contoso\kweku) -``` - -This example tests the client POP3 connectivity for the server named Contoso12 by using the credentials for the user contoso\\kweku. - -### -------------------------- Example 2 -------------------------- -``` -Test-PopConnectivity -ClientAccessServer Contoso12 -``` - -This example tests the client POP3 connectivity of the specific server named Contoso12 and tests all Exchange mailboxes. - -## PARAMETERS - -### -ClientAccessServer -The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. - -You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 -``` - -### -ConnectionType -The ConnectionType parameter specifies the type of connection that's used to connect to the POP3 service. Valid values are: - -- Plaintext - -- Ssl - -- Tls - -```yaml -Type: Plaintext | Tls | Ssl -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 -``` - -### -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 -``` - -### -LightMode -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 sending and receiving a message using the POP3 protocol. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxCredential -The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. - -You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. - -```yaml -Type: ServerIdParameter -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 -``` - -### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerConnectionTimeout -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. - -```yaml -Type: Int32 -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 -``` - -### -PortClientAccessServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -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. - -```yaml -Type: UInt32 -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 -``` - -### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. - -This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. - -```yaml -Type: SwitchParameter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/73f0ce87-e723-43e5-a32c-29cd2d899ff9.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/Test-PowerShellConnectivity.md b/exchange/exchange-ps/exchange/client-access/Test-PowerShellConnectivity.md deleted file mode 100644 index e5559cfb3c..0000000000 --- a/exchange/exchange-ps/exchange/client-access/Test-PowerShellConnectivity.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-PowerShellConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-PowerShellConnectivity - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-PowerShellConnectivity cmdlet to test client connectivity to Exchange remote PowerShell virtual directories. - -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### URL -``` -Test-PowerShellConnectivity -ConnectionUri <Uri> -TestCredential <PSCredential> - [-Authentication <Default | Basic | Negotiate | NegotiateWithImplicitCredential | Credssp | Digest | Kerberos>] - [-Confirm] - [-DomainController <Fqdn>] - [-MailboxServer <ServerIdParameter>] - [-MonitoringContext] - [-ResetTestAccountCredentials] - [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Test-PowerShellConnectivity [[-ClientAccessServer] <ServerIdParameter>] [-TestType <Internal | External>] [-VirtualDirectoryName <String>] - [-Authentication <Default | Basic | Negotiate | NegotiateWithImplicitCredential | Credssp | Digest | Kerberos>] - [-Confirm] - [-DomainController <Fqdn>] - [-MailboxServer <ServerIdParameter>] - [-MonitoringContext] - [-ResetTestAccountCredentials] - [-TrustAnySSLCertificate] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-PowerShellConnectivity cmdlet tests Exchange remote PowerShell connectivity by connecting to a specified remote PowerShell virtual directory, to any remote PowerShell virtual directories on a specified Exchange server, or to any remote PowerShell virtual directories that are available in the local Active Directory site. - -The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: - -& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 - -The test results are displayed on-screen. The cmdlet returns the following information. - -- CasServer: The Exchange server that the client connected to. - -- LocalSite: The name of the local Active Directory site. - -- Scenario: The operations that are tested. Values are: Logon User. - -- Result: The values returned are typically Success, Skipped or Failure. - -- Latency(MS): The time required to complete the test in milliseconds. - -- Error: Any error messages that were encountered. - -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \<filename\> to the command. For example: - -Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html \> "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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-PowerShellConnectivity -ClientAccessServer MBX2 -VirtualDirectoryName "PowerShell (Default Web Site)" -TrustAnySSLCertificate -``` - -This example tests the PowerShell (Default Web Site) virtual directory on the MBX2 server. The TrustAnySSLCertificate switch is used to skip the certificate check during connection. - -### -------------------------- Example 2 -------------------------- -``` -$UserCredentials = Get-Credential; Test-PowerShellConnectivity -ConnectionUri https://contoso.com/powershell -TestCredential $UserCredentials -Authentication Basic -``` - -This example tests the remote PowerShell virtual directory that's available at https://contoso.com/powershell. A mismatch between the SSL certificate and the URL isn't expected, so the TrustAnySSLCertificate switch isn't used. The virtual directoryis configured to use Basic authentication. - -The credentials that are used to connect to the virtual directory are stored in the $UserCredentials variable. The test is then run as previously described. - -## PARAMETERS - -### -ConnectionUri -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. - -```yaml -Type: Uri -Parameter Sets: URL -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestCredential -The TestCredential parameter specifies the credentials to use for the test. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -You can only use this parameter with the ConnectionUri parameter. - -```yaml -Type: PSCredential -Parameter Sets: URL -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -The Authentication parameter specifies the type of authentication that's used to connect. Valid values are: - -- Default - -- Basic - -- Credssp - -- Digest - -- Kerberos - -- Negotiate - -```yaml -Type: Default | Basic | Negotiate | NegotiateWithImplicitCredential | Credssp | Digest | Kerberos -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 -``` - -### -ClientAccessServer -The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. - -You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -You can't use this parameter with the ConnectionUri parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 -``` - -### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. - -You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -If you don't use this parameter, connections to all Mailbox servers in the local Active Directory site are tested. - -```yaml -Type: ServerIdParameter -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 -``` - -### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestType -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. - -```yaml -Type: Internal | External -Parameter Sets: Identity -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 -``` - -### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. - -This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. - -```yaml -Type: SwitchParameter -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 -``` - -### -VirtualDirectoryName -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. - -```yaml -Type: String -Parameter Sets: Identity -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2a876f48-9431-47fa-b65a-f3ea57c7f220.aspx) diff --git a/exchange/exchange-ps/exchange/client-access/set-CASMailboxPlan.md b/exchange/exchange-ps/exchange/client-access/set-CASMailboxPlan.md deleted file mode 100644 index 40cbd2b100..0000000000 --- a/exchange/exchange-ps/exchange/client-access/set-CASMailboxPlan.md +++ /dev/null @@ -1,679 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Set-CASMailboxPlan -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-CASMailboxPlan - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-CASMailboxPlan cmdlet to modify Client Access services (CAS) mailbox plans in the cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-CASMailboxPlan [-Identity] <MailboxPlanIdParameter> [-ActiveSyncDebugLogging <$true | $false>] - [-ActiveSyncEnabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Confirm] - [-DisplayName <String>] [-DomainController <Fqdn>] [-ECPEnabled <$true | $false>] - [-EwsAllowEntourage <$true | $false>] [-EwsAllowList <MultiValuedProperty>] - [-EwsAllowMacOutlook <$true | $false>] [-EwsAllowOutlook <$true | $false>] - [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] [-EwsBlockList <MultiValuedProperty>] - [-EwsEnabled <$true | $false>] [-IgnoreDefaultScope] [-ImapEnabled <$true | $false>] - [-ImapEnableExactRFC822Size <$true | $false>] [-ImapForceICalForCalendarRetrievalOption <$true | $false>] - [-ImapMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] - [-ImapProtocolLoggingEnabled <$true | $false>] [-ImapSuppressReadReceipt <$true | $false>] - [-ImapUseProtocolDefaults <$true | $false>] [-MAPIBlockOutlookNonCachedMode <$true | $false>] - [-MAPIBlockOutlookRpcHttp <$true | $false>] [-MAPIBlockOutlookVersions <String>] - [-MAPIEnabled <$true | $false>] [-OWAEnabled <$true | $false>] [-OWAforDevicesEnabled <$true | $false>] - [-OwaMailboxPolicy <MailboxPolicyIdParameter>] [-PopEnabled <$true | $false>] - [-PopEnableExactRFC822Size <$true | $false>] [-PopForceICalForCalendarRetrievalOption <$true | $false>] - [-PopMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] - [-PopProtocolLoggingEnabled <$true | $false>] [-PopSuppressReadReceipt <$true | $false>] - [-PopUseProtocolDefaults <$true | $false>] [-RemotePowerShellEnabled <$true | $false>] - [<CommonParameters>] -``` - -## DESCRIPTION -CAS mailbox plans control client access settings for all mailboxes that have the plans assigned to them (for example, Exchange ActiveSync, POP, IMAP, and Outlook on the web 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CASMailboxPlan -Identity ExchangeOnlineEnterprise -ActiveSyncEnabled $false -PopEnabled $false -``` - -This example disables Exchange ActiveSync and POP3 access to mailboxes in the CAS mailbox plan named ExchangeOnlineEnterprise. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example: - -- Name - -- Display Name - -- Distinguished name (DN) - -- GUID - -Typically, the name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise). - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActiveSyncDebugLogging -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncEnabled -The ActiveSyncEnabled parameter specifies whether to enable or disable Exchange ActiveSync access to mailboxes that have the CAS mailbox plan applied to them. Valid values are: - -- $true: ActiveSync access to mailboxes is enabled. - -- $false: ActiveSync access to mailboxes is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncMailboxPolicy -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ECPEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowEntourage -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowList -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowMacOutlook -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowOutlook -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsApplicationAccessPolicy -This parameter is reserved for internal Microsoft use. - -```yaml -Type: EnforceAllowList | EnforceBlockList -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsBlockList -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapEnabled -The ImapEnabled parameter specifies whether to enable or disable IMAP4 access to mailboxes that have the CAS mailbox plan applied to them. Valid values are: - -- $true: IMAP4 access to mailboxes is enabled. - -- $false: IMAP4 access to mailboxes is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapEnableExactRFC822Size -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapForceICalForCalendarRetrievalOption -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapMessagesRetrievalMimeFormat -This parameter is reserved for internal Microsoft use. - -```yaml -Type: TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapProtocolLoggingEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapSuppressReadReceipt -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapUseProtocolDefaults -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MAPIBlockOutlookNonCachedMode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MAPIBlockOutlookRpcHttp -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MAPIBlockOutlookVersions -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MAPIEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAforDevicesEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwaMailboxPolicy -The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy that you want applied to mailboxes that have the CAS mailbox plan applied to them. You can use any value that uniquely identifies the Outlook on the web mailbox policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -You can use the Get-OwaMailboxPolicy cmdlet to view the avaliable Outlook on the web mailbox policies. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopEnabled -The PopEnabled parameter specifies whether to enable or disable POP3 access to mailboxes that have the mailbox plan applied to them. Valid values are: - -- $true: POP3 access to mailboxes is enabled. - -- $false: POP3 access to mailboxes is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopEnableExactRFC822Size -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopForceICalForCalendarRetrievalOption -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopMessagesRetrievalMimeFormat -This parameter is reserved for internal Microsoft use. - -```yaml -Type: TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopProtocolLoggingEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopSuppressReadReceipt -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopUseProtocolDefaults -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemotePowerShellEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1f9070cd-cae6-4e16-93d7-301abac8cab5.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Get-ConnectSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Get-ConnectSubscription.md deleted file mode 100644 index 48eebc9899..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Get-ConnectSubscription.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-ConnectSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-ConnectSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-ConnectSubscription cmdlet to view information about the people subscriptions that have been set up between the users in your organization and a supported networking service (for example, Facebook and LinkedIn). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ConnectSubscription [[-Identity] <AggregationSubscriptionIdParameter>] - [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm] [-IncludeReport] - [-Mailbox <MailboxIdParameter>] [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Users can set up people subscriptions between supported networking services and their cloud-based mailbox. Currently, only LinkedIn people connections are supported. The Get-ConnectSubscription cmdlet returns the list of connections that have been set up in your organization. It can also return additional information such as the current connection status of each connection and the time of the most recent successful synchronization. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ConnectSubscription -Mailbox "Kim Akers" | Format-List -``` - -This example shows detailed information for all the contact subscriptions that are configured in the mailbox of the user Kim Akers. - -### -------------------------- Example 2 -------------------------- -``` -Get-ConnectSubscription -Mailbox "Kim Akers" -IncludeReport | Export-CSV C:\KimAkersConnectReport -``` - -This example returns additional information about the contact subscriptions that are configured in the mailbox of the user Kim Akers. - -## PARAMETERS - -### -AggregationType -The AggregationType parameter filters the results by type. The acceptable values for this parameter are: - -- All - -- Aggregation - -- Migration - -- Mirrored - -- PeopleConnection - -```yaml -Type: Aggregation | Mirrored | Migration | PeopleConnection | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies a unique value that identifies a connection between a cloud-based mailbox and a contact subscription. This value is generated by the provider after a successful connection is made. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox that contains the subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89f2566b-cf64-437b-af09-4d495e52b25b.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Get-HotmailSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Get-HotmailSubscription.md deleted file mode 100644 index beb062c12a..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Get-HotmailSubscription.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-HotmailSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-HotmailSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HotmailSubscription cmdlet to view information about Hotmail subscriptions configured in cloud-based mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HotmailSubscription [[-Identity] <AggregationSubscriptionIdParameter>] - [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm] [-IncludeReport] - [-Mailbox <MailboxIdParameter>] [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can view the properties of the Hotmail subscription, such as the connection status and the last time a successful synchronization occurred. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HotmailSubscription -Mailbox "Brian Johnson" -``` - -This example lists all the Hotmail subscriptions configured in the mailbox of the user Brian Johnson. - -### -------------------------- Example 2 -------------------------- -``` -Get-HotmailSubscription -Mailbox "Kim Akers" -IncludeReport | Export-CSV C:\KimAkersHotmailReport -``` - -This example returns additional information about the Hotmail subscriptions configured in the mailbox of the user Kim Akers. - -## PARAMETERS - -### -AggregationType -The AggregationType parameter filters the results by type. The acceptable values for this parameter are: - -- All - -- Aggregation - -- Migration - -- Mirrored - -- PeopleConnection - -```yaml -Type: Aggregation | Mirrored | Migration | PeopleConnection | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Hotmail subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for a Hotmail subscription, such as Identity and Name, by running this command: Get-HotmailSubscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the Hotmail subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the total number of subscriptions to return. If no value is specified, the parameter returns all results that match the filter. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/61e79b8f-2806-4c15-bdc3-74b181482d8f.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Get-ImapSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Get-ImapSubscription.md deleted file mode 100644 index eb94f85fa2..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Get-ImapSubscription.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-ImapSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-ImapSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-ImapSubscription cmdlet to view information about IMAP subscriptions configured in cloud-based mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ImapSubscription [[-Identity] <AggregationSubscriptionIdParameter>] - [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm] [-IncludeReport] - [-Mailbox <MailboxIdParameter>] [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can view the properties of the IMAP subscription, such as the IMAP server, authentication method, connection status, and the last time a successful synchronization occurred. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ImapSubscription -Mailbox "Kim Akers" | Format-List -``` - -This example shows detailed information for all the IMAP subscriptions configured in the mailbox of the user Kim Akers. - -### -------------------------- Example 2 -------------------------- -``` -Get-ImapSubscription -Mailbox "Kim Akers" -IncludeReport | Export-CSV C:\KimAkersImapReport -``` - -This example returns additional information about the IMAP subscriptions configured in the mailbox of the user Kim Akers. - -## PARAMETERS - -### -AggregationType -The AggregationType parameter filters the results by type. The acceptable values for this parameter are: - -- All - -- Aggregation - -- Migration - -- Mirrored - -- PeopleConnection - -```yaml -Type: Aggregation | Mirrored | Migration | PeopleConnection | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the IMAP subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for an IMAP subscription, such as Identity and Name, by running this command: Get-ImapSubscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the IMAP subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e13a9ab2-8cca-4b98-b304-837d13fd4a60.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Get-PopSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Get-PopSubscription.md deleted file mode 100644 index c25133807f..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Get-PopSubscription.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-PopSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-PopSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-PopSubscription cmdlet to view information about POP subscriptions configured in cloud-based mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PopSubscription [[-Identity] <AggregationSubscriptionIdParameter>] - [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm] [-IncludeReport] - [-Mailbox <MailboxIdParameter>] [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can view the properties of the POP subscription, such as the POP server, authentication method, connection status, and the last time a successful synchronization occurred. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PopSubscription -Mailbox "Kim Akers" | Format-List -``` - -This example shows detailed information for all the POP subscriptions configured in the mailbox of the user Kim Akers. - -### -------------------------- Example 2 -------------------------- -``` -Get-PopSubscription -Mailbox "Kim Akers" -IncludeReport | Export-CSV C:\KimAkersPopReport -``` - -This example returns additional information about the POP subscriptions configured in the mailbox of the user Kim Akers and exports the results to a .csv file. - -## PARAMETERS - -### -AggregationType -The AggregationType parameter filters the results by type. The acceptable values for this parameter are: - -- All - -- Aggregation - -- Migration - -- Mirrored - -- PeopleConnection - -```yaml -Type: Aggregation | Mirrored | Migration | PeopleConnection | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the POP subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for a POP subscription, such as Identity and Name, by running this command: Get-PopSubscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the POP subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the total number of subscriptions to return. If no value is specified, the parameter returns all results that match the filter. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/961266ab-21f2-4410-896b-9ede09ba20cd.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Get-SendAddress.md b/exchange/exchange-ps/exchange/connected-accounts/Get-SendAddress.md deleted file mode 100644 index 58641f28f1..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Get-SendAddress.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-SendAddress -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SendAddress - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SendAddress cmdlet to view the email addresses on a user's mailbox that can be configured as the default From address. This cmdlet is primarily used by the Outlook on the web \> Options \> Connected Accounts user interface. Typically, you don't need to run this cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### LookUpId -``` -Get-SendAddress [-AddressId <String>] [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -### Identity -``` -Get-SendAddress [[-Identity] <SendAddressIdParameter>] [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -Configuring a default From address only makes sense if the user has POP, IMAP, or Hotmail subscriptions configured on the mailbox. If you don't specify a value for the default From address, the default behavior is: - -- The primary email address on the user's mailbox is used for all new messages. - -- The To address of the incoming message is used as the From address for all replies or forwarded messages. - -The only email addresses that can be configured as the default From address are: - -- The user's primary email address. - -- The email addresses of a user's POP, IMAP, or Hotmail subscription. - -You set the user's default From address in the SendAddressDefault parameter on the Set-MailboxMessageConfiguration cmdlet. Users can override the default From address when they create an email message in Outlook on the web. - -The Get-SendAddress and Set-MailboxMessageConfiguration cmdlets represent the email addresses of POP, IMAP, or Hotmail subscriptions as a GUID. It's easier to configure a user's default From address in Outlook on the web \> Options \> Account \> Connected Accounts. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SendAddress -Mailbox "Diane Prescott" -``` - -This example lists all the email addresses of the user Diane Prescott that can be used as the default From address. - -## PARAMETERS - -### -AddressId -The AddressId parameter specifies the email address. The value of AddressId is in the following formats: - -- The user's primary email address is displayed as an email address, for example, bob@contoso.com. - -- The email address of a POP, IMAP, or Hotmail subscription is displayed as a GUID. - -- No default From address is set. This is represented by the value $null. - -You can find the values of the AddressId parameter on a user's mailbox by running the command Get-SendAddress -Mailbox \<mailbox\>. - -If you use the AddressId parameter, you must also use the Mailbox parameter. If you use the AddressId parameter, you can't use the Identity parameter. - -```yaml -Type: String -Parameter Sets: LookUpId -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox and the email address. The value of the Identity parameter is in the format \<mailbox\>\\\<address\>. The \<mailbox\> part is any value that uniquely identifies the mailbox. The \<address\> part is in one following formats: - -- The user's primary email address is displayed as an email address, for example, bob@contoso.com. - -- The email address of a POP, IMAP, or Hotmail subscription is displayed as a GUID. - -- No default From address is set. This is represented by a blank value. - -You can find the values of the Identity parameter on a user's mailbox by running the command Get-SendAddress -Mailbox \<mailbox\>. - -If you use the Identity parameter, you can't use the AddressId parameter. - -```yaml -Type: SendAddressIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b2c57a7e-bd6d-461d-8a9d-5384a715344b.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Get-Subscription.md b/exchange/exchange-ps/exchange/connected-accounts/Get-Subscription.md deleted file mode 100644 index 29d7de69e8..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Get-Subscription.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-Subscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-Subscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-Subscription cmdlet to view the properties of an existing subscription configured in a user's cloud-based mailbox. This cmdlet is used by Microsoft Outlook on the web Options to display the list of email subscriptions that the end user has, such as POP, IMAP, Facebook, and LinkedIn. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-Subscription [[-Identity] <AggregationSubscriptionIdParameter>] - [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm] [-IncludeReport] - [-Mailbox <MailboxIdParameter>] [-ResultSize <Unlimited>] - [-SubscriptionType <Unknown | Pop | DeltaSyncMail | IMAP | AllEMail | Facebook | LinkedIn | SinaWeibo | Google | Yahoo | Twitter | Skype | AbchType | AllThatSupportSendAs | AllThatSupportPolicyInducedDeletion | AllThatSupportSendAsAndPeopleConnect | All>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can view the properties of the subscription, such as the remote server, authentication method, connection status, and the last time a successful synchronization occurred. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Subscription -Mailbox "Ayla Kol" -``` - -This example lists all the subscriptions configured in the mailbox of the user Ayla Kol. - -## PARAMETERS - -### -AggregationType -The AggregationType parameter filters the results by type. The acceptable values for this parameter are: - -- All - -- Aggregation - -- Migration - -- Mirrored - -- PeopleConnection - -```yaml -Type: Aggregation | Mirrored | Migration | PeopleConnection | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for a subscription, such as Identity and Name, by running this command: Get-Subscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionType -The SubscriptionType parameter filters the results based on the type of subscription. Valid values for this parameter are: - -- All - -- AllEmail - -- AllThatSupportPolicyInducedDeletion - -- AllThatSupportSendAs - -- AllThatSupportSendAsAndPeopleConnect - -- DeltaSyncMail - -- Facebook - -- IMAP - -- LinkedIn - -- Pop - -- Unknown - -```yaml -Type: Unknown | Pop | DeltaSyncMail | IMAP | AllEMail | Facebook | LinkedIn | SinaWeibo | Google | Yahoo | Twitter | Skype | AbchType | AllThatSupportSendAs | AllThatSupportPolicyInducedDeletion | AllThatSupportSendAsAndPeopleConnect | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a9c74996-557b-4437-9aeb-658449d4d012.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/New-ConnectSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/New-ConnectSubscription.md deleted file mode 100644 index add7890a94..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/New-ConnectSubscription.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: New-ConnectSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-ConnectSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -The New-ConnectSubscription cmdlet allows a user to create contact integration subscriptions between supported services (for example, Facebook or LinkedIn) and their own cloud-based mailbox. An administrator can't use this cmdlet to create subscriptions in another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Facebook -``` -New-ConnectSubscription -AppAuthorizationCode <String> [-Facebook] -Mailbox <MailboxIdParameter> -RedirectUri <String> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### LinkedIn -``` -New-ConnectSubscription [-LinkedIn] -Mailbox <MailboxIdParameter> -OAuthVerifier <String> -RequestSecret <String> -RequestToken <String> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you set up a contact subscription, contacts from the external networking service are integrated into your cloud-based 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ConnectSubscription -LinkedIn $true -OAuthVerifier <OAuthVerifyer value> -RequestSecret <Request Secret value> -RequestToken <Request Token value> -``` - -This example modifies a people connection to LinkedIn. - -## PARAMETERS - -### -AppAuthorizationCode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: Facebook -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Facebook -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: Facebook -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedIn -The LinkedIn parameter specifies whether you want to edit a LinkedIn subscription. - -```yaml -Type: SwitchParameter -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that will contain the subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OAuthVerifier -The OAuthVerifier parameter specifies the verification code associated with the request token. You must provide a value for the OAuthVerifier parameter and the RequestToken parameter values in exchange for an access token. - -```yaml -Type: String -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectUri -The RedirectUri parameter specifies the host name used to connect to the Exchange server from outside the firewall. - -```yaml -Type: String -Parameter Sets: Facebook -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestSecret -The RequestSecret parameter specifies the secret associated with the access token. - -```yaml -Type: String -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestToken -The RequestToken parameter specifies the access token that provides access to protected resources accessible through LinkedIn. You must provide a value for the OAuthVerifier parameter and the RequestToken parameter values in exchange for an access token. - -```yaml -Type: String -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3c2ea368-e6c0-41f8-9509-8a54c268e0a3.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/New-HotmailSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/New-HotmailSubscription.md deleted file mode 100644 index c9af016caf..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/New-HotmailSubscription.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: New-HotmailSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-HotmailSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -The New-HotmailSubscription cmdlet allows a user to create Hotmail account subscriptions in their own cloud-based mailbox. An administrator can't use this cmdlet to create subscriptions in another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-HotmailSubscription [-Name] <String> -EmailAddress <SmtpAddress> -Password <SecureString> [-Confirm] - [-DisplayName <String>] [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-HotmailSubscription cmdlet creates a connection between a user's mailbox in the cloud-based service and a remote Hotmail mailbox. The cloud-based mailbox periodically polls the Hotmail mailbox for new 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-HotmailSubscription -Name "Ayla's Hotmail" -EmailAddress ayla@fabrikam.com -Password (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -``` - -This example creates the Hotmail subscription Ayla's Hotmail in the mailbox of the user Ayla Kol. The Hotmail account has the following details: - -- Email address: ayla@fabrikam.com - -- Password: Pa$$word1 - -## PARAMETERS - -### -EmailAddress -The EmailAddress parameter specifies the email address of the Hotmail mailbox. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the Hotmail subscription. The name of the subscription doesn't have to be globally unique. The name must be unique compared to other subscriptions that exist in the same mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password used to sign in to the Hotmail mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the Hotmail subscription. If you don't specify a value for the DisplayName parameter, the value of the EmailAddress parameter is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that will contain the Hotmail subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/04990a05-da71-43e7-9ba8-859a088891d4.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/New-ImapSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/New-ImapSubscription.md deleted file mode 100644 index a89086c33f..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/New-ImapSubscription.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: New-ImapSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-ImapSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -The New-ImapSubscription cmdlet allows a user to create IMAP subscriptions in their own cloud-based mailbox. An administrator can't use this cmdlet to create subscriptions in another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ImapSubscription [-Name] <String> -EmailAddress <SmtpAddress> -IncomingPassword <SecureString> - -IncomingServer <Fqdn> -IncomingUserName <String> [-Confirm] [-DisplayName <String>] [-Force] - [-IncomingAuth <Basic | Ntlm>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-ImapSubscription cmdlet creates a connection between a user's cloud-based mailbox and a remote IMAP mailbox. The cloud-based mailbox periodically polls the IMAP mailbox for new 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ImapSubscription -Name "Contoso IMAP" -EmailAddress kakers@contoso.com -IncomingUserName kakers -IncomingPassword (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -IncomingServer imap.contoso.com -IncomingSecurity Ssl -IncomingPort 993 -``` - -This example creates the IMAP subscription Contoso IMAP in the mailbox of the user Kim Akers. The remote IMAP mailbox has the following details: - -- Email address: kakers@contoso.com - -- User name: kakers - -- Password: Pa$$word1 - -- IMAP server: imap.contoso.com - -- Authentication method: SSL - -- TCP port: 993 - -## PARAMETERS - -### -EmailAddress -The EmailAddress parameter specifies the email address of the IMAP mailbox. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPassword -The IncomingPassword parameter specifies the password used to sign in to the IMAP mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingServer -The IncomingServer parameter specifies the fully qualified domain name (FQDN) of the IMAP server, for example, incoming.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingUserName -The IncomingUserName parameter specifies the user name used to sign in to the IMAP mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the IMAP subscription. The name of the subscription doesn't have to be globally unique. The name must be unique compared to other subscriptions that exist in the same mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the IMAP subscription. If you don't specify a value for the DisplayName parameter, the value of the EmailAddress parameter is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter instructs the command to create the subscription even if those settings can't be verified by the remote IMAP server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingAuth -The IncomingAuth parameter sets the authentication method used by IMAP clients to access the IMAP server. Valid values are Basic or Ntlm. If you don't specify a value for the IncomingAuth parameter, the value Basic is used. - -```yaml -Type: Basic | Ntlm -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPort -The IncomingPort parameter specifies the TCP port number used by IMAP clients to connect to the IMAP server. Typical values are 143 for unencrypted connections and 993 for encrypted connections. By default, the value of the IncomingPort parameter is set to 143 if you don't set the IncomingSecurity parameter to Ssl or Tls. If you set the IncomingSecurity parameter to Ssl or Tls, the value of the IncomingPort parameter is set to 993. You can override the default values by specifying an integer for the IncomingPort parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingSecurity -The IncomingSecurity parameter specifies the encryption method used by IMAP clients to connect to the IMAP server. Valid values are None, Ssl, or Tls. If you don't specify a value for the IncomingSecurity parameter, the value None is used. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that will contain the IMAP subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cb002b53-c307-40a6-aca2-a7f29dc740d8.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/New-PopSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/New-PopSubscription.md deleted file mode 100644 index 31ead560d5..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/New-PopSubscription.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: New-PopSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-PopSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -The New-PopSubscription cmdlet allows a user to create POP subscriptions in their own cloud-based mailbox. An administrator can't use this cmdlet to create subscriptions in another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PopSubscription [-Name] <String> -EmailAddress <SmtpAddress> -IncomingPassword <SecureString> - -IncomingServer <Fqdn> -IncomingUserName <String> [-Confirm] [-DisplayName <String>] [-Force] - [-IncomingAuth <Basic | Spa>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] - [-LeaveOnServer <$true | $false>] [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-PopSubscription cmdlet creates a connection between a user's cloud-based mailbox and a remote POP mailbox. The cloud-based mailbox periodically polls the POP mailbox for new 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PopSubscription -Name "Contoso POP" -EmailAddress bjohnson@contoso.com -IncomingUserName bjohnson -IncomingPassword (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -IncomingServer pop.contoso.com -IncomingSecurity Ssl -IncomingPort 995 -``` - -This example creates the POP subscription Contoso POP in the mailbox of the user Brian Johnson. The remote POP mailbox has the following details: - -- Email address: bjohnson@contoso.com - -- User name: bjohnson - -- Password: Pa$$word1 - -- POP server: pop.contoso.com - -- Authentication method: SSL - -- TCP port: 995 - -## PARAMETERS - -### -EmailAddress -The EmailAddress parameter specifies the email address of the POP mailbox. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPassword -The IncomingPassword parameter specifies the password used to sign in to the POP mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingServer -The IncomingServer parameter specifies the fully qualified domain name (FQDN) of the POP server, for example, incoming.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingUserName -The IncomingUserName parameter specifies the user name used to sign in to the POP mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the POP subscription. The name of the subscription doesn't have to be globally unique. The name must be unique compared to other subscriptions that exist in the same mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the POP subscription. If you don't specify a value for the DisplayName parameter, the value of the EmailAddress parameter is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter instructs the command to create the subscription even if those settings can't be verified by the remote POP server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingAuth -The IncomingAuth parameter sets the authentication method used by POP clients to access the POP server. Valid values are Basic or Spa, which is secure password authentication. If you don't specify a value for the IncomingAuth parameter, the value Basic is used. - -```yaml -Type: Basic | Spa -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPort -The IncomingPort parameter specifies the TCP port number used by POP clients to connect to the POP server. Typical values are 110 for unencrypted connections and 995 for encrypted connections. By default, the value of the IncomingPort parameter is set to 110 if you don't set the IncomingSecurity parameter to Ssl or Tls. If you set the IncomingSecurity parameter to Ssl or Tls, the value of the IncomingPort parameter is set to 995. You can override the default values by specifying an integer for the IncomingPort parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingSecurity -The IncomingSecurity parameter specifies the encryption method used by POP clients to connect to the POP server. Valid values are None, Ssl, or Tls. If you don't specify a value for the IncomingSecurity parameter, the value None is used. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LeaveOnServer -The LeaveOnServer parameter configures the behavior of retrieved messages in the POP mailbox. When the LeaveOnServer parameter is set to the value $true, the retrieved messages are left in the POP mailbox. When it's set to the value $false, retrieved messages are removed from the POP mailbox. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the POP subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a8405b09-04aa-4b31-866a-3361bb1ad8b4.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/New-Subscription.md b/exchange/exchange-ps/exchange/connected-accounts/New-Subscription.md deleted file mode 100644 index 0c389b5ae9..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/New-Subscription.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: New-Subscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-Subscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -The New-Subscription cmdlet allows a user to create Hotmail, POP, or IMAP subscriptions in their own cloud-based mailbox. An administrator can't use this cmdlet to create subscriptions in another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-Subscription [-Name] <String> -EmailAddress <SmtpAddress> -Password <SecureString> [-Confirm] - [-DisplayName <String>] [-Force] [-Hotmail] [-Imap] [-Mailbox <MailboxIdParameter>] [-Pop] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-Subscription cmdlet creates a connection between a user's cloud-based mailbox and a remote Hotmail, POP, or IMAP mailbox. The cloud-based mailbox periodically polls the remote mailbox for new messages. If you don't specify the type of remote mailbox, the cmdlet automatically tries to configure the subscription by using all of the available subscription types. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-Subscription -Name Contoso -EmailAddress brian@contoso.com -Password (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -``` - -This example creates the subscription Contoso in the mailbox of the user Brian Johnson. The remote mailbox has the following details: - -- Email address: brian@contoso.com - -- Password: Pa$$word1 - -## PARAMETERS - -### -EmailAddress -The EmailAddress parameter specifies the email address of the subscription. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the subscription. The name of the subscription doesn't have to be globally unique. The name must be unique compared to other subscriptions that exist in the same mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password used to sign in to the mailbox. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the subscription. If you don't specify a value for the DisplayName parameter, the value of the EmailAddress parameter is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Hotmail -The Hotmail switch specifies the subscription is a Hotmail subscription. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Imap -The Imap switch specifies the subscription is an IMAP subscription. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Pop -The Pop switch specifies the subscription is a POP subscription. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/25da87cf-f0bc-4de5-b03a-51bb77263c18.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Remove-ConnectSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Remove-ConnectSubscription.md deleted file mode 100644 index b38f711339..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Remove-ConnectSubscription.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Remove-ConnectSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-ConnectSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-ConnectSubscription cmdlet to remove a previously configured contact aggregation subscription between a supported service (for example, Facebook or LinkedIn) and a cloud-based mailbox. An administrator can't use this cmdlet to remove subscriptions from another user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ConnectSubscription [-Identity] <AggregationSubscriptionIdParameter> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -When you remove a contact aggregation subscription, all contacts from the supported services are removed from Outlook on the web. You can't delete a mailbox that has a subscription with a contact aggregation provider until the subscription is removed. If you try to delete a mailbox that has a subscription with a contact aggregation provider, an error message is displayed that the contact subscription must be removed before the mailbox can be deleted. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ConnectSubscription -Identity <Aggregation subscription identity> -``` - -This example removes the all previously configured contact aggregation subscriptions and removes all contacts that were aggregated from the previously configured contact aggregation subscription from Outlook on the web. You can find the subscription identity by using the Get-ConnectSubscription cmdlet. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID of the contact aggregation subscription you want to remove. You can find the subscription identity by using the Get-ConnectSubscription cmdlet. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6a4e7267-e3e9-42ec-b1be-7d1d9e2ea40c.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Remove-Subscription.md b/exchange/exchange-ps/exchange/connected-accounts/Remove-Subscription.md deleted file mode 100644 index a317dffbb4..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Remove-Subscription.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Remove-Subscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-Subscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-Subscription cmdlet to remove a Hotmail, POP, or IMAP subscription from a user's cloud-based mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-Subscription [-Identity] <AggregationSubscriptionIdParameter> [-Confirm] [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-Subscription cmdlet removes a Hotmail, POP, or IMAP subscription from a user's cloud-based mailbox. It doesn't remove the email messages or contacts previously downloaded to the cloud-based mailbox by the subscription. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-Subscription Contoso -Mailbox "Kim Akers" -``` - -This example removes the subscription Contoso from the mailbox of the user Kim Akers. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for a subscription, such as Identity and Name, by running this command: Get-Subscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a1463ac7-6874-4b6a-92b6-4a7a044c344f.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Set-ConnectSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Set-ConnectSubscription.md deleted file mode 100644 index 6c7ca17613..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Set-ConnectSubscription.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-ConnectSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-ConnectSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-ConnectSubscription cmdlet to reauthorize or change the settings for any contact integration subscription that you've set up between an external networking service (for example Facebook and LinkedIn), and your cloud-based mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Facebook -``` -Set-ConnectSubscription -AppAuthorizationCode <String> [-Facebook] -Identity <AggregationSubscriptionIdParameter> -RedirectUri <String> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### LinkedIn -``` -Set-ConnectSubscription -Identity <AggregationSubscriptionIdParameter> [-LinkedIn] -OAuthVerifier <String> - -RequestSecret <String> -RequestToken <String> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you set up a contact subscription, contacts from the external networking service are integrated into your cloud-based 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ConnectSubscription -LinkedIn $true -OAuthVerifier <OAuthVerifier value> -RequestSecret <Request Secret value> -RequestToken <RequestToken value> -``` - -This example modifies a people connection to LinkedIn. - -## PARAMETERS - -### -AppAuthorizationCode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: Facebook -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Facebook -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: Facebook -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the provider identification number that uniquely identifies the provider network. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -LinkedIn -The LinkedIn parameter specifies whether you want to edit a LinkedIn subscription. - -```yaml -Type: SwitchParameter -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OAuthVerifier -The OAuthVerifier parameter specifies the verification code associated with the request token. You must provide a value for the OAuthVerifier parameter and the RequestToken parameter values in exchange for an access token. - -```yaml -Type: String -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectUri -The RedirectUri parameter specifies the host name used to connect to the server running Exchange from outside the firewall. - -```yaml -Type: String -Parameter Sets: Facebook -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestSecret -The RequestSecret parameter specifies the secret associated with the access token. - -```yaml -Type: String -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestToken -The RequestToken parameter specifies the access token that provides access to protected resources accessible through LinkedIn. You must provide a value for the OAuthVerifier parameter and the RequestToken parameter values in exchange for an access token. - -```yaml -Type: String -Parameter Sets: LinkedIn -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a13fdafb-1ad8-47ee-b57f-2377d67c01ae.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Set-HotmailSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Set-HotmailSubscription.md deleted file mode 100644 index bb76e01f9d..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Set-HotmailSubscription.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-HotmailSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-HotmailSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HotmailSubscription cmdlet to modify the properties of an existing Hotmail subscription configured in a user's cloud-based mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HotmailSubscription [-Identity] <AggregationSubscriptionIdParameter> [-Confirm] [-DisplayName <String>] - [-Enabled <$true | $false>] [-Mailbox <MailboxIdParameter>] [-Password <SecureString>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You can set properties for the Hotmail subscription, such as the display name and password. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HotmailSubscription "Contoso Hotmail" -Mailbox "Ayla Kol" -DisplayName "Ayla's Contoso Subscription" -``` - -This example modifies the display name of the Hotmail subscription Contoso Hotmail that's configured in the cloud-based mailbox of the user Ayla Kol. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Hotmail subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for a Hotmail subscription, such as Identity and Name, by running this command: Get-HotmailSubscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the subscription. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the Hotmail subscription is enabled. This parameter accepts $true or $false values. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the Hotmail subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password used to sign in to the Hotmail mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d9139ac-1e96-439d-86f3-7e2ea4d8d914.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Set-ImapSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Set-ImapSubscription.md deleted file mode 100644 index cad9344160..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Set-ImapSubscription.md +++ /dev/null @@ -1,362 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-ImapSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-ImapSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-ImapSubscription cmdlet to modify the properties of an existing IMAP subscription configured in a user's cloud-based mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### SubscriptionModification -``` -Set-ImapSubscription [-Identity] <AggregationSubscriptionIdParameter> [-DisplayName <String>] [-EmailAddress <SmtpAddress>] [-Enabled <$true | $false>] [-Force] [-IncomingAuth <Basic | Ntlm>] [-IncomingPassword <SecureString>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] [-IncomingServer <Fqdn>] [-IncomingUserName <String>] - [-Confirm] - [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ResendVerificationEmail -``` -Set-ImapSubscription [-Identity] <AggregationSubscriptionIdParameter> [-ResendVerification] - [-Confirm] - [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ValidateSendAs -``` -Set-ImapSubscription [-Identity] <AggregationSubscriptionIdParameter> [-ValidateSecret <String>] - [-Confirm] - [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can set properties for the IMAP subscription, such as the IMAP server, TCP port number, encryption method, and authentication method. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ImapSubscription "Fabrikam IMAP" -Mailbox "Kim Akers" -DisplayName "Kim's Fabrikam Mail" -``` - -This example modifies the display name of the IMAP subscription Fabrikam IMAP that's configured in the cloud-based mailbox of the user Kim Akers. - -### -------------------------- Example 2 -------------------------- -``` -Set-ImapSubscription "Brian Contoso Mail" -Mailbox "Brian Johnson" -IncomingServer imap.contoso.com -Force -``` - -This example changes the IMAP server value to imap.contoso.com for the IMAP subscription Brian Contoso Mail that's configured in the cloud-based mailbox of the user Brian Johnson". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the IMAP subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for an IMAP subscription, such as Identity and Name, by running this command: Get-ImapSubscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the subscription. - -```yaml -Type: String -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -The EmailAddress parameter specifies the email address of the IMAP mailbox. - -```yaml -Type: SmtpAddress -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the IMAP subscription is enabled. This parameter accepts $true or $false values. The default is $true. - -```yaml -Type: $true | $false -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter instructs the command to modify the specified subscription settings even if those settings can't be verified by the remote IMAP server. - -```yaml -Type: SwitchParameter -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingAuth -The IncomingAuth parameter sets the authentication method used by IMAP clients to access the IMAP server. The values are Basic or Ntlm. The default value is Basic. - -```yaml -Type: Basic | Ntlm -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPassword -The IncomingPassword parameter specifies the password used to sign in to the IMAP mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). - -```yaml -Type: SecureString -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPort -The IncomingPort parameter specifies the TCP port number used by IMAP clients to connect to the IMAP server. Typical values are 143 for unencrypted connections and 993 for encrypted connections. By default, the value of the IncomingPort parameter is set to 143 if you don't set the IncomingSecurity parameter to Ssl or Tls. If you set the IncomingSecurity parameter to Ssl or Tls, the value of the IncomingPort parameter is set to 993. You can override the default values by specifying an integer for the IncomingPort parameter. - -```yaml -Type: Int32 -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingSecurity -The IncomingSecurity parameter specifies the encryption method used by IMAP clients to connect to the IMAP server. The values are None, Ssl, or Tls. The default value is None. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingServer -The IncomingServer parameter specifies the fully qualified domain name (FQDN) of the IMAP server, for example, incoming.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingUserName -The IncomingUserName parameter specifies the user name used to sign in to the IMAP mailbox. - -```yaml -Type: String -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the IMAP subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResendVerification -The ResendVerification parameter generates verification data for the IMAP subscription. This test is part of the verification process that allows the user to send messages from their cloud-based mailbox using the From address of the subscribed IMAP mailbox. - -The ResendVerification parameter can't be specified with any other parameters that modify the settings of the subscription. Also, the ResendVerification and ValidateSecret parameters are mutually exclusive. - -```yaml -Type: SwitchParameter -Parameter Sets: ResendVerificationEmail -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidateSecret -The ValidateSecret parameter validates verification data for the IMAP subscription. This test is part of the verification process that allows the user to send messages from their cloud-based mailbox using the From address of the subscribed IMAP mailbox. - -The ValidateSecret parameter can't be specified with any other parameters that modify the settings of the subscription. Also, the ResendVerification and ValidateSecret parameters are mutually exclusive. - -```yaml -Type: String -Parameter Sets: ValidateSendAs -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2d7f36c8-38db-4318-879c-8f77cfd09b06.aspx) diff --git a/exchange/exchange-ps/exchange/connected-accounts/Set-PopSubscription.md b/exchange/exchange-ps/exchange/connected-accounts/Set-PopSubscription.md deleted file mode 100644 index 5da1980d61..0000000000 --- a/exchange/exchange-ps/exchange/connected-accounts/Set-PopSubscription.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-PopSubscription -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-PopSubscription - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-PopSubscription cmdlet to modify the properties of an existing POP subscription that's configured in a user's cloud-based mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### SubscriptionModification -``` -Set-PopSubscription [-Identity] <AggregationSubscriptionIdParameter> [-DisplayName <String>] [-EmailAddress <SmtpAddress>] [-Enabled <$true | $false>] [-Force] [-IncomingAuth <Basic | Spa>] [-IncomingPassword <SecureString>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] [-IncomingServer <Fqdn>] [-IncomingUserName <String>] [-LeaveOnServer <$true | $false>] - [-Confirm] - [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ResendVerificationEmail -``` -Set-PopSubscription [-Identity] <AggregationSubscriptionIdParameter> [-ResendVerification] - [-Confirm] - [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ValidateSendAs -``` -Set-PopSubscription [-Identity] <AggregationSubscriptionIdParameter> [-ValidateSecret <String>] - [-Confirm] - [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can set properties for the POP subscription, such as the POP server, TCP port number, encryption method, and authentication method. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-PopSubscription "Ayla Contoso" -Mailbox "Ayla Kol" -LeaveOnServer $false -``` - -This example modifies the value of the LeaveOnServer parameter for the POP subscription Ayla Contoso that's configured in the cloud-based mailbox of the user Ayla Kol. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the POP subscription. You can identify the subscription by using one of the following methods: - -- Specify the globally unique identifier of the subscription, which is its canonical name (CN). - -- Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription. - -You can find the identifying values for a POP subscription, such as Identity and Name, by running this command: Get-PopSubscription -Mailbox \<mailbox\>. - -```yaml -Type: AggregationSubscriptionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the subscription. - -```yaml -Type: String -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -The EmailAddress parameter specifies the email address of the POP mailbox. - -```yaml -Type: SmtpAddress -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the POP subscription is enabled. This parameter accepts $true or $false values. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter instructs the command to modify the specified subscription settings even if those settings can't be verified by the remote POP server. - -```yaml -Type: SwitchParameter -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingAuth -The IncomingAuth parameter sets the authentication method used by POP clients to access the POP server. Valid values are Basic or Spa, which is secure password authentication. If you don't specify a value for the IncomingAuth parameter, the value Basic is used. - -```yaml -Type: Basic | Spa -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPassword -The IncomingPassword parameter specifies the password used to sign in to the POP mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). - -```yaml -Type: SecureString -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingPort -The Incoming Port parameter specifies the TCP port number used by POP clients to connect to the POP server. Typical values are 110 for unencrypted connections and 995 for encrypted connections. By default, the value of the IncomingPort parameter is set to 110 if you don't set the IncomingSecurity parameter to Ssl or Tls. If you set the IncomingSecurity parameter to Ssl or Tls, the value of the IncomingPort parameter is set to 995. You can override the default values by specifying an integer for the IncomingPort parameter. - -```yaml -Type: Int32 -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingSecurity -The IncomingSecurity parameter specifies the encryption method used by POP clients to connect to the POP server. Valid values are None, Ssl, or Tls. If you don't specify a value for the IncomingSecurity parameter, the value None is used. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingServer -The IncomingServer parameter specifies the fully qualified domain name (FQDN) of the POP server, for example, incoming.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingUserName -The IncomingUserName parameter specifies the user name used to sign in to the POP mailbox. - -```yaml -Type: String -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LeaveOnServer -The LeaveOnServer parameter configures the behavior of retrieved messages in the POP mailbox. When the LeaveOnServer parameter is set to the value $true, the retrieved messages are left in the POP mailbox. When it's set to the value $false, retrieved messages are removed from the POP mailbox. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: SubscriptionModification -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the cloud-based mailbox that contains the POP subscription. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResendVerification -The ResendVerification parameter generates verification data for the POP subscription. This is part of the verification process that allows the user to send messages from their cloud-based mailbox using the From address of the subscribed POP mailbox. - -The ResendVerification parameter can't be specified with any other parameters that modify the settings of the subscription. Also, the ResendVerification and ValidateSecret parameters are mutually exclusive. - -```yaml -Type: SwitchParameter -Parameter Sets: ResendVerificationEmail -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidateSecret -The ValidateSecret parameter validates verification data for the POP subscription. This is part of the verification process that allows the user to send messages from their cloud-based mailbox using the From address of the subscribed POP mailbox. - -The ValidateSecret parameter can't be specified with any other parameters that modify the settings of the subscription. Also, the ResendVerification and ValidateSecret parameters are mutually exclusive. - -```yaml -Type: String -Parameter Sets: ValidateSendAs -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3ec02987-7404-47fa-a6b0-43239344b6c8.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md deleted file mode 100644 index 0560da65de..0000000000 --- a/exchange/exchange-ps/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-DatabaseAvailabilityGroupServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Add-DatabaseAvailabilityGroupServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Add-DatabaseAvailabilityGroupServer cmdlet to add a Mailbox server to a database availability group (DAG). A DAG is a set of Mailbox servers that use continuous replication and managed availability to provide automatic database-level recovery from database, server, or network failures. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-DatabaseAvailabilityGroupServer [-Identity] <DatabaseAvailabilityGroupIdParameter> - [-MailboxServer] <ServerIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [-SkipDagValidation] - [-SkipInstallCluster] [-SpareServer] [<CommonParameters>] -``` - -## DESCRIPTION -A computer object for a DAG is created in Active Directory when the first server is added to the DAG. This object is used to authenticate servers to each other within a DAG. - -To add a Mailbox server to a DAG, the Mailbox server must be running the Windows Server 2008 R2 Enterprise or Datacenter operating system, the Windows Server 2012 Standard or Datacenter operating system, or the Windows Server 2012 R2 operating system, and it must not belong to any other DAG. The Mailbox server must be running the same versions of the Windows operating system and Microsoft Exchange, and be in the same Active Directory domain as all other Mailbox servers in the DAG. In addition, the Mailbox server must not be configured as an Active Directory domain controller or global catalog server. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-DatabaseAvailabilityGroupServer -Identity DAG1 -MailboxServer MBX1 -``` - -This example adds the Mailbox server MBX1 to the DAG DAG1. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MailboxServer -The MailboxServer parameter specifies the name of the Mailbox server being added to the DAG. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 2 -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 -``` - -### -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 -``` - -### -SkipDagValidation -The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when adding members to the DAG. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipInstallCluster -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpareServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6bd0a3fe-dec6-47c2-b9a3-8dffb60e4aad.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md deleted file mode 100644 index ae9e47ec57..0000000000 --- a/exchange/exchange-ps/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DatabaseAvailabilityGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-DatabaseAvailabilityGroup - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-DatabaseAvailabilityGroup cmdlet to obtain a variety of configuration settings, status and other information about a database availability group (DAG). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DatabaseAvailabilityGroup [[-Identity] <DatabaseAvailabilityGroupIdParameter>] [-DomainController <Fqdn>] - [-Status] [<CommonParameters>] -``` - -## DESCRIPTION -In addition to obtaining a list of DAG members, the Get-DatabaseAvailabilityGroup cmdlet can also be used to view real-time status information about a DAG, such as: - -- OperationalServers - -- PrimaryActiveManager - -- ReplicationPort - -- NetworkNames - -- WitnessShareInUse - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DatabaseAvailabilityGroup DAG1 | Format-List -``` - -This example displays the basic properties of the DAG DAG1. The output for the command is formatted as a list. - -### -------------------------- Example 2 -------------------------- -``` -Get-DatabaseAvailabilityGroup DAG2 -Status | Format-List -``` - -This example displays the properties of the DAG DAG2. Because it includes the Status parameter, the task also displays real-time status information for DAG2, such as the current list of operational servers and the server currently holding the Primary Active Manager role. In addition, several properties of the DAG, such as the witness server and directory configuration information are also displayed. The output for the command is formatted as a list. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Status -The Status parameter instructs the command to query Active Directory for additional information and to include real-time status information in the output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ea64d731-55ae-4a39-9eec-a72aa36d6dad.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md deleted file mode 100644 index 2b0fa3c957..0000000000 --- a/exchange/exchange-ps/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroupServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-DatabaseAvailabilityGroupServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-DatabaseAvailabilityGroupServer cmdlet to remove a Mailbox server from a database availability group (DAG). To remove a Mailbox server from a DAG, the Mailbox server must not host any replicated databases. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DatabaseAvailabilityGroupServer [-Identity] <DatabaseAvailabilityGroupIdParameter> - [-MailboxServer] <ServerIdParameter> [-ConfigurationOnly] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [-SkipDagValidation] [-SpareServer] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DatabaseAvailabilityGroupServer -Identity DAG3 -MailboxServer MBX1 -``` - -This example removes the Mailbox server MBX1 from the DAG DAG3. - -### -------------------------- Example 2 -------------------------- -``` -Remove-DatabaseAvailabilityGroupServer -Identity DAG2 -MailboxServer MBX4 -ConfigurationOnly -``` - -This example removes the configuration settings for the Mailbox server MBX4 from the DAG DAG2. MBX4 is currently offline and expected to be offline for an extended period, so its configuration is being removed from the DAG to establish quorum for the DAG or to reduce the number of members needed for quorum by the DAG. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MailboxServer -The MailboxServer parameter specifies the name of the Mailbox server being removed from the DAG. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ConfigurationOnly -The ConfigurationOnly switch should only be used 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. When used, it removes the Mailbox server from the DAG object in Active Directory. 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -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 -``` - -### -SkipDagValidation -The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when removing members from the DAG. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpareServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/49290be7-9d3d-4bc3-80ea-f1992fdd1d12.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md deleted file mode 100644 index 330ebd5f33..0000000000 --- a/exchange/exchange-ps/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md +++ /dev/null @@ -1,912 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DatabaseAvailabilityGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-DatabaseAvailabilityGroup - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-DatabaseAvailabilityGroup cmdlet to configure properties of a database availability group (DAG). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DatabaseAvailabilityGroup [-Identity] <DatabaseAvailabilityGroupIdParameter> - [-AllowCrossSiteRpcClientAccess] [-AlternateWitnessDirectory <NonRootLocalLongFullPath>] - [-AlternateWitnessServer <FileShareWitnessServerName>] [-Confirm] - [-DatabaseAvailabilityGroupIpAddresses <IPAddress[]>] [-DatacenterActivationMode <Off | DagOnly>] - [-DiscoverNetworks] [-DomainController <Fqdn>] - [-NetworkCompression <Disabled | Enabled | InterSubnetOnly | SeedOnly>] - [-NetworkEncryption <Disabled | Enabled | InterSubnetOnly | SeedOnly>] [-ReplicationPort <UInt16>] [-WhatIf] - [-WitnessDirectory <NonRootLocalLongFullPath>] [-WitnessServer <FileShareWitnessServerName>] - [-AutoDagAllServersInstalled <$true | $false>] [-AutoDagAutoReseedEnabled <$true | $false>] - [-AutoDagBitlockerEnabled <$true | $false>] [-AutoDagDatabaseCopiesPerDatabase <Int32>] - [-AutoDagDatabaseCopiesPerVolume <Int32>] [-AutoDagDatabasesRootFolderPath <NonRootLocalLongFullPath>] - [-AutoDagDiskReclaimerEnabled <$true | $false>] [-AutoDagFIPSCompliant <$true | $false>] - [-AutoDagTotalNumberOfDatabases <Int32>] [-AutoDagTotalNumberOfServers <Int32>] - [-AutoDagVolumesRootFolderPath <NonRootLocalLongFullPath>] - [-DagConfiguration <DatabaseAvailabilityGroupConfigurationIdParameter>] - [-MailboxLoadBalanceEnabled <$true | $false>] [-MailboxLoadBalanceOverloadedThreshold <Int32>] [-MailboxLoadBalanceRelativeLoadCapacity <Int32>] - [-MailboxLoadBalanceUnderloadedThreshold <Int32>] [-ManualDagNetworkConfiguration <$true | $false>] - [-ReplayLagManagerEnabled <$true | $false>] [-SkipDagValidation] - [-ActivityState <NewDeployment | DotBuildUpgrade | Decom | PendingDotBuildUpgrade | DecomRemoveMailboxes | DecomNoUpgrades | Discovered | Allocated | ReadyForAllocation | Spare>] - [-AutoDagAutoRedistributeEnabled <$true | $false>] [-AutoDagSIPEnabled <$true | $false>] - [-DistributedStoreMembershipConfigOverride <String>] [-DxStoreSpareServers <String>] - [-DxStoreWitnessServers <String>] [-FileSystem <NTFS | ReFS>] [-ForceSyncDistributedStoreSettings] - [-IgnoreClusterErrors] [-MailboxLoadBalanceComputeCapacity <Int32>] - [-MailboxLoadBalanceSellableStorage <ByteQuantifiedSize>] [-MetaCacheDatabaseVolumesPerServer <Int32>] - [-PreferenceMoveFrequency <TimeSpan>] [-RequestedDistributedStoreConfig <String>] [-SiloName <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-DatabaseAvailabilityGroup cmdlet enables you to manage DAG properties that can't be managed from the Exchange admin center (EAC), such as configuring network discovery, selecting the TCP port used for replication and enabling datacenter activation coordination (DAC) mode. - -DAG property values are stored in both Active Directory and the cluster database. Because some properties are stored in the cluster database, the underlying cluster for the DAG must have quorum to set the properties for: - -- ReplicationPort - -- NetworkCompression - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -WitnessDirectory C:\DAG1DIR -``` - -This example sets the witness directory to C:\\DAG1DIR for the DAG DAG1. - -### -------------------------- Example 2 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -AlternateWitnessDirectory C:\DAGFileShareWitnesses\DAG1.contoso.com -AlternateWitnessServer CAS3 -``` - -This example preconfigures an alternate witness server of CAS3 and an alternate witness directory of C:\\DAGFileShareWitnesses\\DAG1.contoso.com for the DAG DAG1. - -### -------------------------- Example 3 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 0.0.0.0 -``` - -This example configures the DAG DAG1 to use DHCP to obtain an IP address. - -### -------------------------- Example 4 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8 -``` - -This example configures the DAG DAG1 to use a static IP address of 10.0.0.8. - -### -------------------------- Example 5 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8,10.0.1.8 -``` - -This example configures the multi-subnet DAG DAG1 with multiple static IP addresses. - -### -------------------------- Example 6 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -ReplicationPort 63132 -``` - -This example configures TCP port 63132 as the port used by replication for the DAG DAG1. - -After changing the default replication port for a DAG, you must manually modify the Windows Firewall exceptions on each member of the DAG to allow communication to occur over the specified port. - -### -------------------------- Example 7 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -DatacenterActivationMode DagOnly -``` - -This example configures the DAG DAG1 for DAC mode. - -### -------------------------- Example 8 -------------------------- -``` -Set-DatabaseAvailabilityGroup -Identity DAG1 -AutoDagVolumesRootFolderPath C:\ExchVols -AutoDagDatabasesRootFolderPath C:\ExchDBs -AutoDagDatabaseCopiesPerVolume 4 -``` - -This example configures the DAG DAG1 for AutoReseed using custom mount point paths and 4 databases per volume. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllowCrossSiteRpcClientAccess -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlternateWitnessDirectory -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlternateWitnessServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DatabaseAvailabilityGroupIpAddresses -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatacenterActivationMode -The DatacenterActivationMode parameter specifies the datacenter activation mode for the DAG. Valid values are: - -- Off: Datacenter activation mode is disabled. - -- DagOnly: Datacenter activation mode is enabled. - -```yaml -Type: Off | DagOnly -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 -``` - -### -DiscoverNetworks -The DiscoverNetworksswitch 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 DiscoverNetworksswitch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -NetworkCompression -The NetworkCompression parameter specifies the network compression option for the DAG. Valid values are: - -- Disabled: Network compression is disabled on all networks. - -- Enabled: Network compression is enabled on all networks. - -- InterSubnetOnly: Network compression is enabled only for inter-subnet communication. - -- SeedOnly: Network compression is enabled only for seeding. - -```yaml -Type: Disabled | Enabled | InterSubnetOnly | SeedOnly -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 -``` - -### -NetworkEncryption -The NetworkEncryption parameter specifies the network encryption option for the DAG. Valid values are: - -- Disabled: Network encryption is disabled on all networks. - -- Enabled: Network encryption is enabled on all networks. - -- InterSubnetOnly: Network encryption is enabled only for inter-subnet communication. - -- SeedOnly: Network encryption is enabled only for seeding. - -```yaml -Type: Disabled | Enabled | InterSubnetOnly | SeedOnly -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 -``` - -### -ReplicationPort -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WitnessDirectory -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: FileShareWitnessServerName -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 -``` - -### -AutoDagAllServersInstalled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagAutoReseedEnabled -The AutoDagAutoReseedEnabled is used to enable or disable Autoreseed. The default value is $true (enabled). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagBitlockerEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagDatabaseCopiesPerDatabase -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagDatabaseCopiesPerVolume -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagDatabasesRootFolderPath -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagFIPSCompliant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagTotalNumberOfDatabases -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagTotalNumberOfServers -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagVolumesRootFolderPath -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DagConfiguration -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceOverloadedThreshold -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceRelativeLoadCapacity -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceUnderloadedThreshold -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManualDagNetworkConfiguration -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplayLagManagerEnabled -The ReplayLagManagerEnabled parameter specifies whether to disable the automatic playdown of log files for a lagged database copy. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDagValidation -The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivityState -This parameter is reserved for internal Microsoft use. - -```yaml -Type: NewDeployment | DotBuildUpgrade | Decom | PendingDotBuildUpgrade | DecomRemoveMailboxes | DecomNoUpgrades | Discovered | Allocated | ReadyForAllocation | Spare -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagAutoRedistributeEnabled -The AutoDagAutoRedistributeEnabled parameter specifies whether automatic DAG redistribution is enabled or disabled during AutoReseed. The default value is $true (enabled). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDagSIPEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributedStoreMembershipConfigOverride -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DxStoreSpareServers -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DxStoreWitnessServers -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileSystem -The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: - -- NTFS - -- ReFS - -```yaml -Type: NTFS | ReFS -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceSyncDistributedStoreSettings -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreClusterErrors -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceComputeCapacity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceSellableStorage -This parameter is reserved for internal Microsoft use. - -```yaml -Type: ByteQuantifiedSize -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetaCacheDatabaseVolumesPerServer -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferenceMoveFrequency -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). - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedDistributedStoreConfig -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiloName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4353c3ab-75b7-485e-89ae-d4b09b44b646.aspx) diff --git a/exchange/exchange-ps/exchange/database-availability-groups/Test-ReplicationHealth.md b/exchange/exchange-ps/exchange/database-availability-groups/Test-ReplicationHealth.md deleted file mode 100644 index 0fdc7fc1c3..0000000000 --- a/exchange/exchange-ps/exchange/database-availability-groups/Test-ReplicationHealth.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ReplicationHealth -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-ReplicationHealth - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-ReplicationHealth cmdlet to check all aspects of replication and replay, or to provide status for a specific Mailbox server in a database availability group (DAG). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-ReplicationHealth [[-Identity] <ServerIdParameter>] [-ActiveDirectoryTimeout <Int32>] [-Confirm] - [-DomainController <Fqdn>] [-MonitoringContext <$true | $false>] [-OutputObjects] - [-TransientEventSuppressionWindow <UInt32>] [-WhatIf] - [-DatabaseAvailabilityGroup <DatabaseAvailabilityGroupIdParameter>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-ReplicationHealth -Identity MBX1 -``` - -This example tests the health of replication for the Mailbox server MBX1. - -## PARAMETERS - -### -ActiveDirectoryTimeout -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). - -```yaml -Type: $true | $false -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 -``` - -### -OutputObjects -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransientEventSuppressionWindow -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Mailbox server that you want to test. - -You can use any value that uniquely identifies the server. For example: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -You can't use this parameter with the DatabaseAvailabilityGroup parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DatabaseAvailabilityGroup -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 - -- Distinguished name (DN) - -- GUID - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseAvailabilityGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/da55fa0f-e100-44b1-b9b4-bf14e55a5b4d.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Clear-MobileDevice.md b/exchange/exchange-ps/exchange/devices/Clear-MobileDevice.md deleted file mode 100644 index 34eba1f888..0000000000 --- a/exchange/exchange-ps/exchange/devices/Clear-MobileDevice.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-MobileDevice -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Clear-MobileDevice cmdlet to delete all data from a mobile phone. This action is often called a remote device wipe. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Clear-MobileDevice [-Identity] <MobileDeviceIdParameter> [-Cancel] [-Confirm] [-DomainController <Fqdn>] - [-NotificationEmailAddresses <MultiValuedProperty>] [-WhatIf] [-AccountOnly] [<CommonParameters>] -``` - -## DESCRIPTION -The Clear-MobileDevice cmdlet deletes all user data from a mobile device the next time that the device receives data from the Microsoft Exchange server. This cmdlet sets the DeviceWipeStatus parameter to $true. The mobile device acknowledges the cmdlet and records the time stamp in the DeviceWipeAckTime parameter. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Clear-MobileDevice -Identity WM_JeffHay -``` - -This example clears all data from the mobile device with the Identity WM\_JeffHay. - -### -------------------------- Example 2 -------------------------- -``` -Clear-MobileDevice -Identity WM_TonySmith -NotificationEmailAddresses "tony@contoso.com" -``` - -This example clears all data from the mobile device for Tony Smith and sends a confirmation email message to tony@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Clear-MobileDevice -Identity WM_TonySmith -Cancel -``` - -This example cancels a previously sent Clear-MobileDevice command request for Tony Smith's mobile device. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the device that you want to reset. - -```yaml -Type: MobileDeviceIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Cancel -The Cancelswitchcancels a pending remote device wipe request. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEmailAddresses -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountOnly -The AccountOnly switch specifies whether to perform an account-only remote device wipe where only Exchange mailbox data is removed from the device. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6a1d971d-923d-41cf-9612-ab466bb2bcbf.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDevice.md deleted file mode 100644 index ed821d1b8a..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDevice.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDevice -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your organization that have active Exchange ActiveSync partnerships. - -Note: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Mailbox -``` -Get-ActiveSyncDevice -Mailbox <MailboxIdParameter> - [-DomainController <Fqdn>] - [-Filter <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [-Monitoring] [<CommonParameters>] -``` - -### Identity -``` -Get-ActiveSyncDevice [[-Identity] <ActiveSyncDeviceIdParameter>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [-Monitoring] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncDevice -Identity "TonySmith" -``` - -This example returns all the Exchange ActiveSync mobile devices that Tony Smith has used that are associated with his mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-ActiveSyncDevice -Mailbox "Redmond\TonySmith" -``` - -This example returns all the Exchange ActiveSync mobile devices that Tony Smith has used that are associated with his mailbox. - -## PARAMETERS - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- ClientType - -- DeviceAccessControlRule - -- DeviceAccessState - -- DeviceAccessStateReason - -- DeviceActiveSyncVersion - -- DeviceId - -- DeviceImei - -- DeviceMobileOperator - -- DeviceModel - -- DeviceOS - -- DeviceOSLanguage - -- DeviceTelephoneNumber - -- DeviceType - -- DeviceUserAgent - -- FirstSyncTime - -- FriendlyName - -- ProvisioningFlags - -- UserDisplayName - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- DeviceIdentity - -- Multi-TenantID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Monitoring -This parameter is available only in on-premises Exchange. - -The Monitoring parameter specifies whether mobile devices created by monitoring accounts are included in the Get-ActiveSyncDevice cmdlet output. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- DeviceAccessControlRule - -- DeviceAccessState - -- DeviceAccessStateReason - -- DeviceId - -- DeviceImei - -- DeviceMobileOperator - -- DeviceModel - -- DeviceOS - -- DeviceOSLanguage - -- DeviceTelephoneNumber - -- DeviceType - -- DeviceUserAgent - -- FirstSyncTime - -- FriendlyName - -- UserDisplayName - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/06a82fdc-9bf7-43c7-8471-d977034d3560.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceAccessRule.md deleted file mode 100644 index d6240a7f74..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceAccessRule.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceAccessRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ActiveSyncDeviceAccessRule cmdlet to retrieve an access group of Exchange mobile devices along with their access level. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ActiveSyncDeviceAccessRule [[-Identity] <ActiveSyncDeviceAccessRuleIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You can create multiple groups of devices: allowed devices, blocked devices, and quarantined devices with the New-ActiveSyncDeviceAccessRule cmdlet. The Get-ActiveSyncDeviceAccessRule cmdlet retrieves the settings for any existing 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncDeviceAccessRule | where {$_.AccessLevel -eq 'Block'} -``` - -This example lists all the rules currently blocking mobile phones. - -### -------------------------- Example 2 -------------------------- -``` -Get-ActiveSyncDeviceAccessRule | Format-List Characteristic, QueryString, AccessLevel -``` - -This example lists all device access rules set up on the server. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f9bcb8d8-1239-43b8-9885-b655cbe8b4bc.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md deleted file mode 100644 index 9cc5f917b5..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ActiveSyncDeviceAutoblockThreshold -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ActiveSyncDeviceAutoblockThreshold - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ActiveSyncDeviceAutoblockThreshold cmdlet to obtain the Autoblock settings for Microsoft Exchange ActiveSync mobile devices.. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ActiveSyncDeviceAutoblockThreshold [[-Identity] <ActiveSyncDeviceAutoblockThresholdIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -Microsoft Exchange and Exchange ActiveSync have the capability to block Exchange ActiveSync mobile devices if these devices display any of a defined list of behaviors that have the capability to cause issues with the server. The Get-ActiveSyncDeviceAutoblockThreshold cmdlet returns the settings for the requested threshold 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncDeviceAutoblockThreshold -Identity "UserAgentChanges" -``` - -This example retrieves the threshold settings for the Autoblock threshold rule for UserAgentChanges. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1dc9974b-de67-47d2-a177-c358c9fe366b.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceClass.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceClass.md deleted file mode 100644 index feed938ced..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceClass.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceClass -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ActiveSyncDeviceClass [[-Identity] <ActiveSyncDeviceClassIdParameter>] [-DomainController <Fqdn>] - [-Filter <String>] [-SortBy <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncDeviceClass -Filter {DeviceType -eq "WP"} -``` - -This example returns a list of all Windows Phones. - -### -------------------------- Example 2 -------------------------- -``` -Get-ActiveSyncDeviceClass | group-object -property DeviceType -``` - -This example lists all device types within the organization along with a count of the number of devices of each type present. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- DeviceModel - -- DeviceType - -- LastUpdateTime - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- DeviceModel - -- DeviceType - -- LastUpdateTime - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f87f0260-b1f3-4315-b71b-e381bd0ebc15.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceStatistics.md deleted file mode 100644 index 9f18db9eeb..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncDeviceStatistics.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ActiveSyncDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. - -Note: In Exchange 2013 or later, use the Get-MobileDeviceStatistics cmdlet instead. If you have scripts that use Get-ActiveSyncDeviceStatistics, update them to use Get-MobileDeviceStatistics. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-ActiveSyncDeviceStatistics [-Identity] <ActiveSyncDeviceIdParameter> - [-DomainController <Fqdn>] - [-GetMailboxLog] - [-NotificationEmailAddresses <MultiValuedProperty>] - [-ShowRecoveryPassword] [<CommonParameters>] -``` - -### Mailbox -``` -Get-ActiveSyncDeviceStatistics -Mailbox <MailboxIdParameter> - [-DomainController <Fqdn>] - [-GetMailboxLog] - [-NotificationEmailAddresses <MultiValuedProperty>] - [-ShowRecoveryPassword] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncDeviceStatistics -Mailbox TonySmith -``` - -This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -$UserList = Get-CASMailbox -Filter {HasActiveSyncDevicePartnership -eq $true -and -not DisplayName -like "CAS_{*"} | Get-Mailbox $UserList | foreach {Get-ActiveSyncDeviceStatistics -Mailbox $_} -``` - -This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. - -### -------------------------- Example 3 -------------------------- -``` -Get-ActiveSyncDeviceStatistics -Mailbox TonySmith -GetMailboxLog $true -NotificationEmailAddresses "admin@contoso.com" -``` - -This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. It also outputs the Exchange ActiveSync log file and sends it to the System Administrator at admin@contoso.com. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the user mailbox for which you want to retrieve the mobile phone statistics. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GetMailboxLog -The GetMailboxLog parameter specifies whether to send the mailbox logs via email to the administrator running the task. If the parameter is set to $true, the command sends the mailbox logs via email to the administrator running the task. The default value of this parameter is $false. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEmailAddresses -The NotificationEmailAddresses parameter specifies an optional list of comma-separated aliases or email addresses where the mailbox logs are sent. If the GetMailboxLog parameter is set to $false, this parameter is ignored. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowRecoveryPassword -The ShowRecoveryPassword parameter specifies whether to return the recovery password for the mobile phone as one of the displayed statistics. If this parameter is set to $true, the command returns the recovery password for the mobile phone as one of the displayed statistics. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2b6160ef-ab82-49e7-a5be-fd7cae92dabb.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncMailboxPolicy.md deleted file mode 100644 index d0bc143141..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncMailboxPolicy.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ActiveSyncMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. - -Note: In Exchange 2013 or later, use the Get-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Get-ActiveSyncMailboxPolicy, update them to use Get-MobileDeviceMailboxPolicy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ActiveSyncMailboxPolicy [[-Identity] <MailboxPolicyIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncMailboxPolicy -Identity "SalesPolicy" -``` - -This example returns the policy settings for the Mobile Device mailbox policy named SalesPolicy. - -### -------------------------- Example 2 -------------------------- -``` -Get-ActiveSyncMailboxPolicy -Identity "Default" -``` - -This example returns the policy settings for the Mobile Device mailbox policy named Default. - -### -------------------------- Example 3 -------------------------- -``` -Get-ActiveSyncMailboxPolicy -Identity "Management" -``` - -This example returns the policy settings for the Mobile Device mailbox policy named Management. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/deffb9df-6326-44dc-862b-424085d14d00.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/devices/Get-ActiveSyncOrganizationSettings.md deleted file mode 100644 index af0dbbe860..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-ActiveSyncOrganizationSettings.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncOrganizationSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ActiveSyncOrganizationSettings cmdlet to view the Microsoft Exchange ActiveSync settings for your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ActiveSyncOrganizationSettings [[-Identity] <ActiveSyncOrganizationSettingsIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActiveSyncOrganizationSettings -``` - -This example retrieves the ActiveSync organization settings. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a7f7f110-4951-4c9b-8373-cf6a1d1ff426.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/devices/Get-DeviceConditionalAccessPolicy.md deleted file mode 100644 index 26e92bcb5f..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DeviceConditionalAccessPolicy.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DeviceConditionalAccessPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DeviceConditionalAccessPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DeviceConditionalAccessPolicy cmdlet to view mobile device conditional access policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeviceConditionalAccessPolicy [[-Identity] <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeviceConditionalAccessPolicy | Format-Table Name,Enabled,Priority -``` - -This example shows summary information for all mobile device conditional access policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-DeviceConditionalAccessPolicy -Identity "Human Resources" -``` - -This example shows details about the mobile device conditional access policy named Human Resources. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ce78b63e-885e-4888-9b08-33f8affb50a9.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/devices/Get-DeviceConditionalAccessRule.md deleted file mode 100644 index 8270a56649..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DeviceConditionalAccessRule.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DeviceConditionalAccessRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DeviceConditionalAccessRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DeviceConditionalAccessRule cmdlet to view mobile device conditional access rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeviceConditionalAccessRule [[-Identity] <ComplianceRuleIdParameter>] [-CompareToWorkload] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeviceConditionalAccessRule | Format-List Name,Disabled,Priority -``` - -This example shows a summary list of all mobile device conditional access rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-DeviceConditionalAccessRule -Identity "Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}" -``` - -This example shows details for the mobile device conditional access rule named Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. - -## PARAMETERS - -### -CompareToWorkload -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax \<Mobile device conditional access policy name\>{\<GUID value\>}. For example, Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/840dc154-bcf1-40de-a207-5d87213420d0.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/devices/Get-DeviceConfigurationPolicy.md deleted file mode 100644 index 575a566184..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DeviceConfigurationPolicy.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DeviceConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DeviceConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DeviceConfigurationPolicy cmdlet to view mobile device configuration policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeviceConfigurationPolicy [[-Identity] <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeviceConfigurationPolicy | Format-Table Name,Enabled,Priority -``` - -This example shows summary information for all mobile device configuration policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-DeviceConfigurationPolicy -Identity "Engineering Group" -``` - -This example shows details about the mobile device configuration policy named Engineering Group. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/821cd39f-5bd5-4568-b154-eaff712fa658.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/devices/Get-DeviceConfigurationRule.md deleted file mode 100644 index dd015362b1..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DeviceConfigurationRule.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DeviceConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DeviceConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DeviceConfigurationRule cmdlet to view mobile device configuration rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeviceConfigurationRule [[-Identity] <ComplianceRuleIdParameter>] [-CompareToWorkload] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeviceConfigurationRule | Format-List Name,Disabled,Priority -``` - -This example shows summary information for all mobile device configuration rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-DeviceConfigurationRule -Identity "Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}" -``` - -This example shows details about the mobile device configuration rule named Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136} - -## PARAMETERS - -### -CompareToWorkload -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax \<Mobile device configuration policy name\>{\<GUID value\>}. For example, Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e1c9741e-b926-4656-b171-bf974034f76e.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DevicePolicy.md b/exchange/exchange-ps/exchange/devices/Get-DevicePolicy.md deleted file mode 100644 index f6045bc024..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DevicePolicy.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DevicePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DevicePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DevicePolicy cmdlet to view mobile device polices (regardless of type) in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DevicePolicy [[-Identity] <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DevicePolicy | Format-Table Name,Type,Enabled,Priority -``` - -This example shows summary information for all mobile device policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-DevicePolicy -Identity "Engineering Group" -``` - -This example shows details about the mobile device policy named Engineering Group. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2bbcb1ef-f86f-46ff-aff0-33b875c1f88e.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/devices/Get-DeviceTenantPolicy.md deleted file mode 100644 index e89b060a61..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DeviceTenantPolicy.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DeviceTenantPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DeviceTenantPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DeviceTenantPolicy cmdlet to view your organization's mobile device tenant policy in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeviceTenantPolicy [[-Identity] <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeviceTenantPolicy -``` - -This example shows information for your organization's mobile device tenant policy. - -## PARAMETERS - -### -Identity -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: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eeaa034a-5e6f-4c4c-ac4c-37130b0a6843.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-DeviceTenantRule.md b/exchange/exchange-ps/exchange/devices/Get-DeviceTenantRule.md deleted file mode 100644 index 8097541061..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-DeviceTenantRule.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DeviceTenantRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DeviceTenantRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DeviceTenantRule cmdlet to view your organization's mobile device tenant rule in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeviceTenantRule [[-Identity] <ComplianceRuleIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeviceTenantRule -``` - -This example shows information for your organization's mobile device tenant rule. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the mobile device tenant rule that you want to 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: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/66b8d3d6-ae5a-4a31-b69d-c974d475a6ce.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-MobileDevice.md b/exchange/exchange-ps/exchange/devices/Get-MobileDevice.md deleted file mode 100644 index 11664192d7..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-MobileDevice.md +++ /dev/null @@ -1,400 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDevice -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MobileDevice cmdlet to get the list of devices in your organization that have active Exchange ActiveSync partnerships. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Mailbox -``` -Get-MobileDevice -Mailbox <MailboxIdParameter> - [-ActiveSync] - [-DomainController <Fqdn>] - [-Filter <String>] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-OWAforDevices] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-RestApi] - [-UniversalOutlook] [<CommonParameters>] -``` - -### Identity -``` -Get-MobileDevice [[-Identity] <MobileDeviceIdParameter>] - [-ActiveSync] - [-DomainController <Fqdn>] - [-Filter <String>] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-OWAforDevices] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-RestApi] - [-UniversalOutlook] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MobileDevice -Identity "TonySmith" -``` - -This example returns all the Exchange ActiveSync mobile devices that Tony Smith has used that are associated with his mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-MobileDevice -ResultSize -unlimited | Format-Table -Auto DeviceModel,Identity -``` - -This example returns a summary list of all mobile devices in the organization. - - -### -------------------------- Example 3 -------------------------- -``` -Get-MobileDevice -Identity lila\ExchangeActiveSyncDevices\Android§android94732903 | Format-List -``` - -This example returns detailed information about the specified device on Lila's mailbox. - -## PARAMETERS - -### -Mailbox -The Mailbox parameter filters the results by mailbox. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActiveSync -The ActiveSync switch specifies whether to include mobile devices that synchronize with Exchange ActiveSync. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- ClientType - -- DeviceAccessControlRule - -- DeviceAccessState - -- DeviceAccessStateReason - -- DeviceActiveSyncVersion - -- DeviceId - -- DeviceImei - -- DeviceMobileOperator - -- DeviceModel - -- DeviceOS - -- DeviceOSLanguage - -- DeviceTelephoneNumber - -- DeviceType - -- DeviceUserAgent - -- FirstSyncTime - -- FriendlyName - -- ProvisioningFlags - -- UserDisplayName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example: - -- GUID - -- DeviceIdentity - -- Multi-TenantID - -```yaml -Type: MobileDeviceIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Monitoring -This parameter is available only in on-premises Exchange. - -The Monitoring parameter specifies whether mobile devices that are created by monitoring accounts are exposed by the Get-MobileDevice cmdlet. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAforDevices -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- DeviceAccessControlRule - -- DeviceAccessState - -- DeviceAccessStateReason - -- DeviceId - -- DeviceImei - -- DeviceMobileOperator - -- DeviceModel - -- DeviceOS - -- DeviceOSLanguage - -- DeviceTelephoneNumber - -- DeviceType - -- DeviceUserAgent - -- FirstSyncTime - -- FriendlyName - -- UserDisplayName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestApi -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniversalOutlook -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ce8a4142-23c1-47d5-89c5-961bd6e9d162.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/devices/Get-MobileDeviceMailboxPolicy.md deleted file mode 100644 index 26a1f83e98..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-MobileDeviceMailboxPolicy.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDeviceMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MobileDeviceMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MobileDeviceMailboxPolicy [[-Identity] <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -A Mobile Device mailbox policy is a group of settings that specifies how mobile devices enabled for Exchange ActiveSync connect to the computer running 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MobileDeviceMailboxPolicy -Identity "SalesPolicy" -``` - -This example returns the policy settings for the Mobile Device mailbox policy SalesPolicy. - -### -------------------------- Example 2 -------------------------- -``` -Get-MobileDeviceMailboxPolicy -Identity "Default" -``` - -This example returns the policy settings for the Mobile Device mailbox policy Default. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5f0564eb-0219-4b4e-a400-8a771fb3f002.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/exchange/devices/Get-MobileDeviceStatistics.md deleted file mode 100644 index e9c4dde477..0000000000 --- a/exchange/exchange-ps/exchange/devices/Get-MobileDeviceStatistics.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDeviceStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-MobileDeviceStatistics [-Identity] <MobileDeviceIdParameter> - [-ActiveSync] - [-DomainController <Fqdn>] - [-GetMailboxLog] - [-NotificationEmailAddresses <MultiValuedProperty>] - [-OWAforDevices] - [-ShowRecoveryPassword] - [-RestApi] - [-UniversalOutlook] [<CommonParameters>] -``` - -### Mailbox -``` -Get-MobileDeviceStatistics -Mailbox <MailboxIdParameter> - [-ActiveSync] - [-DomainController <Fqdn>] - [-GetMailboxLog] - [-NotificationEmailAddresses <MultiValuedProperty>] - [-OWAforDevices] - [-ShowRecoveryPassword] - [-RestApi] - [-UniversalOutlook] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MobileDeviceStatistics -Identity TonySmith -``` - -This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -$UserList = Get-CASMailbox -Filter {HasActiveSyncDevicePartnership -eq $true -and -not DisplayName -like "CAS_{*"} | Get-Mailbox; $UserList | foreach {Get-MobileDeviceStatistics -Mailbox $_} -``` - -This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. - -### -------------------------- Example 3 -------------------------- -``` -Get-MobileDeviceStatistics -Mailbox TonySmith -GetMailboxLog $true -NotificationEmailAddresses "admin@contoso.com" -``` - -This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. It also outputs the Exchange ActiveSync log file and sends it to the System Administrator at admin@contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user's device ID. If the Mailbox parameter is specified, the Identity parameter is disabled. - -```yaml -Type: MobileDeviceIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the user mailbox for which you want to retrieve the mobile phone statistics. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActiveSync -The ActiveSync switch specifies whether to return statistics for Microsoft Exchange ActiveSync or other mobile device synchronization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GetMailboxLog -The GetMailboxLog parameter specifies whether to send the mailbox logs via email to the administrator running the task. If the parameter is set to $true, the command sends the mailbox logs via email to the administrator running the task. The default value of this parameter is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEmailAddresses -The NotificationEmailAddresses parameter specifies an optional list of comma-separated aliases or email addresses where the mailbox logs are sent. If the GetMailboxLog parameter is set to $false, this parameter is ignored. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAforDevices -The OWAforDevices parameter specifies whether Outlook on the web for devices is enabled for the mobile device. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowRecoveryPassword -The ShowRecoveryPassword parameter specifies whether to return the recovery password for the mobile phone as one of the displayed statistics. If this parameter is set to $true, the command returns the recovery password for the mobile phone as one of the displayed statistics. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestApi -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniversalOutlook -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6a74c20a-d4e5-40f8-8921-9e416125c305.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/devices/New-DeviceConditionalAccessPolicy.md deleted file mode 100644 index 7a00e2168a..0000000000 --- a/exchange/exchange-ps/exchange/devices/New-DeviceConditionalAccessPolicy.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DeviceConditionalAccessPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DeviceConditionalAccessPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DeviceConditionalAccessPolicy cmdlet to create mobile device conditional access policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DeviceConditionalAccessPolicy [-Name] <String> [-Comment <String>] [-Confirm] [-Enabled <$true | $false>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DeviceConditionalAccessPolicy -Identity "Human Resources" -``` - -This example creates a new mobile device conditional access policy named Human Resources - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/744c4c5a-a47e-4413-9e3f-50969519328b.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/devices/New-DeviceConditionalAccessRule.md deleted file mode 100644 index f9a721794d..0000000000 --- a/exchange/exchange-ps/exchange/devices/New-DeviceConditionalAccessRule.md +++ /dev/null @@ -1,1578 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DeviceConditionalAccessRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DeviceConditionalAccessRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DeviceConditionalAccessRule cmdlet to create mobile device conditional access rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DeviceConditionalAccessRule -Policy <PolicyIdParameter> -TargetGroups <MultiValuedProperty> - [-AccountName <String>] [-AccountUserName <String>] [-AllowAppStore <$true | $false>] - [-AllowAssistantWhileLocked <$true | $false>] [-AllowConvenienceLogon <$true | $false>] - [-AllowDiagnosticSubmission <$true | $false>] [-AllowiCloudBackup <$true | $false>] - [-AllowiCloudDocSync <$true | $false>] [-AllowiCloudPhotoSync <$true | $false>] - [-AllowJailbroken <$true | $false>] [-AllowPassbookWhileLocked <$true | $false>] - [-AllowScreenshot <$true | $false>] [-AllowSimplePassword <$true | $false>] - [-AllowVideoConferencing <$true | $false>] [-AllowVoiceAssistant <$true | $false>] - [-AllowVoiceDialing <$true | $false>] [-AntiVirusSignatureStatus <Int64>] [-AntiVirusStatus <Int64>] - [-AppsRating <DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll>] - [-AutoUpdateStatus <AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault>] - [-BluetoothEnabled <$true | $false>] [-CameraEnabled <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-EmailAddress <String>] [-EnableRemovableStorage <$true | $false>] [-ExchangeActiveSyncHost <String>] - [-FirewallStatus <Required>] [-ForceAppStorePassword <$true | $false>] - [-ForceEncryptedBackup <$true | $false>] [-MaxPasswordAttemptsBeforeWipe <Int32>] - [-MaxPasswordGracePeriod <TimeSpan>] - [-MoviesRating <DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18>] - [-PasswordComplexity <Int64>] [-PasswordExpirationDays <Int32>] [-PasswordHistoryCount <Int32>] - [-PasswordMinComplexChars <Int32>] [-PasswordMinimumLength <Int32>] [-PasswordQuality <Int32>] - [-PasswordRequired <$true | $false>] [-PasswordTimeout <TimeSpan>] [-PhoneMemoryEncrypted <$true | $false>] - [-RegionRatings <us | au | ca | de | fr | ie | jp | nz | gb>] [-RequireEmailProfile <$true | $false>] - [-SmartScreenEnabled <$true | $false>] [-SystemSecurityTLS <$true | $false>] - [-TVShowsRating <DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution>] - [-UserAccountControlStatus <AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify>] - [-WhatIf] [-WLANEnabled <$true | $false>] [-WorkFoldersSyncUrl <String>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DeviceConditionalAccessRule -Policy "Secure Email" -TargetGroups 5bff73eb-0ba7-461b-b7c9-9b4c173cc266 -``` - -This example creates a new mobile device conditional access rule with the following settings: - -- Policy: Secure Email - -- TargetGroups:5bff73eb-0ba7-461b-b7c9-9b4c173cc266 - -## PARAMETERS - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGroups -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountUserName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAppStore -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAssistantWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowConvenienceLogon -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDiagnosticSubmission -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudDocSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudPhotoSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowJailbroken -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPassbookWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowScreenshot -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSimplePassword -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVideoConferencing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceAssistant -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceDialing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusSignatureStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppsRating -The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - -- AllowAll - -- DontAllow - -- Rating9plus - -- Rating12plus - -- Rating17plus - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateStatus -The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - -- AutomaticCheckForUpdates - -- AutomaticDownloadUpdates - -- AutomaticUpdatesRequired - -- DeviceDefault - -- NeverCheckUpdates - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BluetoothEnabled -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CameraEnabled -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRemovableStorage -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeActiveSyncHost -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Required -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceAppStorePassword -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceEncryptedBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordAttemptsBeforeWipe -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordGracePeriod -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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingR18plus - -Canada - -- CARatingG - -- CARatingPG - -- CARating14A - -- CARating18A - -- CARatingR - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingU - -- GBRatingUc - -- GBRatingPG - -- GBRating12 - -- GBRating12A - -- GBRating15 - -- GBRating18 - -Ireland - -- IERatingG - -- IERatingPG - -- IERating12 - -- IERating15 - -- IERating16 - -- IERating18 - -Japan - -- JPRatingG - -- JPRatingPG12 - -- JPRatingRdash15 - -- JPRatingRdash18 - -New Zealand - -- NZRatingG - -- NZRatingPG - -- NZRatingM - -- NZRatingR13 - -- NZRatingR15 - -- NZRatingR16 - -- NZRatingR18 - -- NZRatingR - -United States - -- USRatingG - -- USRatingPG - -- USRatingPG13 - -- USRatingR - -- USRatingNC17 - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordComplexity -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. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordExpirationDays -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinComplexChars -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinimumLength -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordQuality -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. - -This setting is available only on Android 4+ devices. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordRequired -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordTimeout -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: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneMemoryEncrypted -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 (already encrypted and can't be unencrypted) - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. - -Valid values for the RegionRating parameter are: - -- $null (blank): The setting isn't configured. This is the default value. - -- au: Australia - -- ca: Canada - -- de: Germany - -- fr: France - -- gb: United Kingdom - -- ie: Ireland - -- jp: Japan - -- nz: New Zealand - -- us: United States - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: us | au | ca | de | fr | ie | jp | nz | gb -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireEmailProfile -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartScreenEnabled -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemSecurityTLS -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingP - -- AURatingC - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingAv15plus - -Canada - -- CARatingC - -- CARatingC8 - -- CARatingG - -- CARatingPG - -- CARating14plus - -- CARating18plus - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingCaution - -Ireland - -- IERatingGA - -- IERatingCh - -- IERatingYA - -- IERatingPS - -- IERatingMA - -Japan - -- JPRatingExplicitAllowed - -New Zealand - -- NZRatingG - -- NZRatingPGR - -- NZRatingAO - -United States - -- USRatingTVY - -- USRatingTVY7 - -- USRatingTVG - -- USRatingTVPG - -- USRatingTV14 - -- USRatingTVMA - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccountControlStatus -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. - -- AlwaysNotify - -- NeverNotify - -- NotifyAppChanges - -- NotifyAppChangesDoNotDimdesktop - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WLANEnabled -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. - -This setting is available only on Microsoft Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkFoldersSyncUrl -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5b41bd8c-bb38-4c57-b98d-37cf609f7400.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/devices/New-DeviceConfigurationPolicy.md deleted file mode 100644 index c56f98583b..0000000000 --- a/exchange/exchange-ps/exchange/devices/New-DeviceConfigurationPolicy.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DeviceConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DeviceConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DeviceConfigurationPolicy cmdlet to create mobile device configuration policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DeviceConfigurationPolicy [-Name] <String> [-Comment <String>] [-Confirm] [-Enabled <$true | $false>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DeviceConfigurationPolicy -Name "Engineering Group" -``` - -This example creates a new mobile device configuration policy named Engineering Group. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d286fd8f-7695-4b4c-a24f-51975d939a60.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/devices/New-DeviceConfigurationRule.md deleted file mode 100644 index c799b2143e..0000000000 --- a/exchange/exchange-ps/exchange/devices/New-DeviceConfigurationRule.md +++ /dev/null @@ -1,1551 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DeviceConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DeviceConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DeviceConfigurationRule cmdlet to create mobile device configuration rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DeviceConfigurationRule -Policy <PolicyIdParameter> -TargetGroups <MultiValuedProperty> - [-AccountName <String>] [-AccountUserName <String>] [-AllowAppStore <$true | $false>] - [-AllowAssistantWhileLocked <$true | $false>] [-AllowConvenienceLogon <$true | $false>] - [-AllowDiagnosticSubmission <$true | $false>] [-AllowiCloudBackup <$true | $false>] - [-AllowiCloudDocSync <$true | $false>] [-AllowiCloudPhotoSync <$true | $false>] - [-AllowPassbookWhileLocked <$true | $false>] [-AllowScreenshot <$true | $false>] - [-AllowSimplePassword <$true | $false>] [-AllowVideoConferencing <$true | $false>] - [-AllowVoiceAssistant <$true | $false>] [-AllowVoiceDialing <$true | $false>] - [-AntiVirusSignatureStatus <Int64>] [-AntiVirusStatus <Int64>] - [-AppsRating <DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll>] - [-AutoUpdateStatus <AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault>] - [-BluetoothEnabled <$true | $false>] [-CameraEnabled <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-EmailAddress <String>] [-EnableRemovableStorage <$true | $false>] [-ExchangeActiveSyncHost <String>] - [-FirewallStatus <Required>] [-ForceAppStorePassword <$true | $false>] - [-ForceEncryptedBackup <$true | $false>] [-MaxPasswordAttemptsBeforeWipe <Int32>] - [-MaxPasswordGracePeriod <TimeSpan>] - [-MoviesRating <DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18>] - [-PasswordComplexity <Int64>] [-PasswordExpirationDays <Int32>] [-PasswordHistoryCount <Int32>] - [-PasswordMinComplexChars <Int32>] [-PasswordMinimumLength <Int32>] [-PasswordQuality <Int32>] - [-PasswordRequired <$true | $false>] [-PasswordTimeout <TimeSpan>] [-PhoneMemoryEncrypted <$true | $false>] - [-RegionRatings <us | au | ca | de | fr | ie | jp | nz | gb>] [-RequireEmailProfile <$true | $false>] - [-SmartScreenEnabled <$true | $false>] [-SystemSecurityTLS <$true | $false>] - [-TVShowsRating <DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution>] - [-UserAccountControlStatus <AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify>] - [-WhatIf] [-WLANEnabled <$true | $false>] [-WorkFoldersSyncUrl <String>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DeviceConfigurationRule -Policy "Engineering Group" -TargetGroups 5bff73eb-0ba7-461b-b7c9-9b4c173cc266 -``` - -This example creates a new mobile device configuration rule with the following settings: - -- Policy: Engineering Group - -- TargetGroups:5bff73eb-0ba7-461b-b7c9-9b4c173cc266 - -## PARAMETERS - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGroups -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountUserName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAppStore -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAssistantWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowConvenienceLogon -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDiagnosticSubmission -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudDocSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudPhotoSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPassbookWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowScreenshot -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSimplePassword -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVideoConferencing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceAssistant -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceDialing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusSignatureStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppsRating -The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - -- AllowAll - -- DontAllow - -- Rating9plus - -- Rating12plus - -- Rating17plus - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateStatus -The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - -- AutomaticCheckForUpdates - -- AutomaticDownloadUpdates - -- AutomaticUpdatesRequired - -- DeviceDefault - -- NeverCheckUpdates - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BluetoothEnabled -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CameraEnabled -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRemovableStorage -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeActiveSyncHost -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Required -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceAppStorePassword -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceEncryptedBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordAttemptsBeforeWipe -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordGracePeriod -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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingR18plus - -Canada - -- CARatingG - -- CARatingPG - -- CARating14A - -- CARating18A - -- CARatingR - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingU - -- GBRatingUc - -- GBRatingPG - -- GBRating12 - -- GBRating12A - -- GBRating15 - -- GBRating18 - -Ireland - -- IERatingG - -- IERatingPG - -- IERating12 - -- IERating15 - -- IERating16 - -- IERating18 - -Japan - -- JPRatingG - -- JPRatingPG12 - -- JPRatingRdash15 - -- JPRatingRdash18 - -New Zealand - -- NZRatingG - -- NZRatingPG - -- NZRatingM - -- NZRatingR13 - -- NZRatingR15 - -- NZRatingR16 - -- NZRatingR18 - -- NZRatingR - -United States - -- USRatingG - -- USRatingPG - -- USRatingPG13 - -- USRatingR - -- USRatingNC17 - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordComplexity -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. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordExpirationDays -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinComplexChars -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinimumLength -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordQuality -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. - -This setting is available only on Android 4+ devices. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordRequired -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordTimeout -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: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneMemoryEncrypted -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 (already encrypted and can't be unencrypted) - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. - -Valid values for the RegionRating parameter are: - -- $null (blank): The setting isn't configured. This is the default value. - -- au: Australia - -- ca: Canada - -- de: Germany - -- fr: France - -- gb: United Kingdom - -- ie: Ireland - -- jp: Japan - -- nz: New Zealand - -- us: United States - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: us | au | ca | de | fr | ie | jp | nz | gb -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireEmailProfile -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartScreenEnabled -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemSecurityTLS -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingP - -- AURatingC - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingAv15plus - -Canada - -- CARatingC - -- CARatingC8 - -- CARatingG - -- CARatingPG - -- CARating14plus - -- CARating18plus - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingCaution - -Ireland - -- IERatingGA - -- IERatingCh - -- IERatingYA - -- IERatingPS - -- IERatingMA - -Japan - -- JPRatingExplicitAllowed - -New Zealand - -- NZRatingG - -- NZRatingPGR - -- NZRatingAO - -United States - -- USRatingTVY - -- USRatingTVY7 - -- USRatingTVG - -- USRatingTVPG - -- USRatingTV14 - -- USRatingTVMA - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccountControlStatus -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. - -- AlwaysNotify - -- NeverNotify - -- NotifyAppChanges - -- NotifyAppChangesDoNotDimdesktop - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WLANEnabled -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. - -This setting is available only on Microsoft Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkFoldersSyncUrl -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/426ab6b0-8c66-4ec0-9120-0128c8ca5232.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/devices/New-DeviceTenantPolicy.md deleted file mode 100644 index c93891b6d3..0000000000 --- a/exchange/exchange-ps/exchange/devices/New-DeviceTenantPolicy.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DeviceTenantPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DeviceTenantPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DeviceTenantPolicy cmdlet to create your organization's mobile device tenant policy in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DeviceTenantPolicy [-Comment <String>] [-Confirm] [-Enabled <$true | $false>] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DeviceTenantPolicy -``` - -This example creates your organization's mobile device tenant policy. You can have only one mobile device tenant policy in your organization. - -## PARAMETERS - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e45d4d65-a7d1-4b65-8a55-9bea54f63328.aspx) diff --git a/exchange/exchange-ps/exchange/devices/New-DeviceTenantRule.md b/exchange/exchange-ps/exchange/devices/New-DeviceTenantRule.md deleted file mode 100644 index f2f3d833e7..0000000000 --- a/exchange/exchange-ps/exchange/devices/New-DeviceTenantRule.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DeviceTenantRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DeviceTenantRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DeviceTenantRule cmdlet to create your organization's mobile device tenant rule in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DeviceTenantRule [-ApplyPolicyTo <None | ExchangeOnline | SharepointOnline | ExchangeAndSharepoint>] - [-BlockUnsupportedDevices <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-ExclusionList <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DeviceTenantRule -ExclusionList -``` - -This example creates a new mobile device tenant rule with the security groups named Engineering and Research and Development on the exclusion list. Members of these groups are allowed access even if they use non-compliant devices - -You can have only one mobile device tenant rule in your organization. - -## PARAMETERS - -### -ApplyPolicyTo -The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - -- ExchangeOnline - -- SharePointOnline - -- ExchangeAndSharePoint - -```yaml -Type: None | ExchangeOnline | SharepointOnline | ExchangeAndSharepoint -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockUnsupportedDevices -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. - -- $false: Unsupported devices are allowed. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExclusionList -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. - -You can specify multiple groups separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0d83cff9-087f-492e-8320-734257e72bce.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDevice.md deleted file mode 100644 index f81570fd3a..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncDevice.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncDevice -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-ActiveSyncDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. - -Note: In Exchange 2013 or later, use the Remove-MobileDevice cmdlet instead. If you have scripts that use Remove-ActiveSyncDevice, update them to use Remove-MobileDevice. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ActiveSyncDevice [-Identity] <ActiveSyncDeviceIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ActiveSyncDevice -Identity WM_JeffHay -``` - -This example removes the mobile device partnership for the device named WM\_JeffHay. - -### -------------------------- Example 2 -------------------------- -``` -Remove-ActiveSyncDevice -Identity iPhone_TonySmith -Confirm $true -``` - -This example removes the mobile device partnership for the device named iPhone\_TonySmith after displaying the confirm prompt. - -### -------------------------- Example 3 -------------------------- -``` -Remove-ActiveSyncDevice -Identity Tablet_JeffHay -Confirm $true -``` - -This example removes the mobile device partnership for the device named Tablet\_JeffHay after displaying the confirm prompt. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e84728e4-7948-459f-8151-5e5fc156bf19.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncMailboxPolicy.md deleted file mode 100644 index 6266fba452..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-ActiveSyncMailboxPolicy.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-ActiveSyncMailboxPolicy cmdlet to remove mobile device mailbox policies. - -Note: In Exchange 2013 or later, use the Remove-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Remove-ActiveSyncMailboxPolicy, update them to use Remove-MobileDeviceMailboxPolicy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ActiveSyncMailboxPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ActiveSyncMailboxPolicy -Identity "SalesPolicy" -``` - -This example removes the mobile device mailbox policy SalesPolicy. - -### -------------------------- Example 2 -------------------------- -``` -Remove-ActiveSyncMailboxPolicy -Identity "Management" -Confirm:$false -Force $true -``` - -This example removes the mobile device mailbox policy named Management and bypasses any confirmation prompts. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/acfe84cc-acb1-4840-9986-d6dc07e16620.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/devices/Remove-DeviceConditionalAccessPolicy.md deleted file mode 100644 index a3caab4692..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-DeviceConditionalAccessPolicy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DeviceConditionalAccessPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DeviceConditionalAccessPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DeviceConditionalAccessPolicy cmdlet to remove mobile device conditional access policies from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DeviceConditionalAccessPolicy [-Identity] <PolicyIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DeviceConditionalAccessPolicy -Identity "Human Resources" -``` - -This example removes the mobile device conditional access policy named Human Resources. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/72f09025-da9c-447e-8d86-2e2ca591abb0.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/devices/Remove-DeviceConditionalAccessRule.md deleted file mode 100644 index 8e896ea46b..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-DeviceConditionalAccessRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DeviceConditionalAccessRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DeviceConditionalAccessRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DeviceConditionalAccessRule cmdlet to remove mobile device conditional access rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DeviceConditionalAccessRule [-Identity] <PolicyIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DeviceConditionalAccessRule "Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}" -``` - -This example removes the mobile device conditional access rule named Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax \<Mobile device conditional access policy name\>{\<GUID value\>}. 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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bf943a1a-2fc8-4636-ac36-74acbf3f7640.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/devices/Remove-DeviceConfigurationPolicy.md deleted file mode 100644 index eb72d47ef8..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-DeviceConfigurationPolicy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DeviceConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DeviceConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DeviceConfigurationPolicy cmdlet to remove mobile device configuration policies from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DeviceConfigurationPolicy [-Identity] <PolicyIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DeviceConfigurationPolicy -Identity "Engineering Group" -``` - -This example removes the mobile device configuration policy named Engineering Group. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/27fa336b-c627-414e-b2c9-6415a8183388.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/devices/Remove-DeviceConfigurationRule.md deleted file mode 100644 index 2fb19973f7..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-DeviceConfigurationRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DeviceConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DeviceConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-DeviceConfigurationRule cmdlet to remove mobile device configuration rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DeviceConfigurationRule [-Identity] <PolicyIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DeviceConfigurationRule "Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}" -``` - -This example removes the mobile device configuration rule named Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax \<Mobile device configuration policy name\>{\<GUID value\>}. 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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1c50327e-1bba-44df-ba06-dda384382e15.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/devices/Remove-DeviceTenantPolicy.md deleted file mode 100644 index a25e1699a6..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-DeviceTenantPolicy.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DeviceTenantPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DeviceTenantPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DeviceTenantPolicy cmdlet to remove your organization's mobile device tenant policy from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DeviceTenantPolicy [-Confirm] [-Identity <PolicyIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DeviceTenantPolicy -``` - -This example removes your organization's mobile device tenant policy. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the mobile device tenant policy that you want to remove, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: Get-DeviceTenantPolicy | Format-List Name. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c8e32152-2e47-4532-bcbe-824e200d99e8.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-DeviceTenantRule.md b/exchange/exchange-ps/exchange/devices/Remove-DeviceTenantRule.md deleted file mode 100644 index f62d4ad9ef..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-DeviceTenantRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DeviceTenantRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DeviceTenantRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DeviceTenantRule cmdlet to remove your organization's mobile device tenant rule from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DeviceTenantRule [-Confirm] [-Identity <PolicyIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DeviceTenantRule -``` - -This example removes the mobile device tenant rule from your organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the mobile device tenant rule that you want to remove, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command Get-DeviceTenantRule | Format-List Name. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/76a9b59d-d00b-4e12-a1a5-280a654a8083.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Remove-MobileDevice.md b/exchange/exchange-ps/exchange/devices/Remove-MobileDevice.md deleted file mode 100644 index 03c7c6dd94..0000000000 --- a/exchange/exchange-ps/exchange/devices/Remove-MobileDevice.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MobileDevice -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MobileDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MobileDevice [-Identity] <MobileDeviceIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MobileDevice -Identity WM_JeffHay -``` - -This example removes the mobile device partnership for the device named WM\_JeffHay. - -### -------------------------- Example 2 -------------------------- -``` -Remove-MobileDevice -Identity iPhone_TonySmith -Confirm:$false -``` - -This example removes the mobile device partnership for the device named iPhone\_TonySmith and doesn't display the confirm prompt. - -## PARAMETERS - -### -Identity -The Identity parameter uniquely identifies the specific device partnership to be removed. - -```yaml -Type: MobileDeviceIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8b3ddb29-03d3-4269-8a61-73db15adaa24.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/devices/Set-ActiveSyncOrganizationSettings.md deleted file mode 100644 index 838225bd83..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-ActiveSyncOrganizationSettings.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncOrganizationSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-ActiveSyncOrganizationSettings cmdlet to set the Exchange ActiveSync settings for the organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ActiveSyncOrganizationSettings [[-Identity] <ActiveSyncOrganizationSettingsIdParameter>] [-AdminMailRecipients <MultiValuedProperty>] [-AllowAccessForUnSupportedPlatform <$true | $false>] [-AllowRMSSupportForUnenlightenedApps <$true | $false>] [-Confirm] [-DefaultAccessLevel <Allow | Block | Quarantine>] [-DomainController <Fqdn>] [-OtaNotificationMailInsert <String>] [-UserMailInsert <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ActiveSyncOrganizationSettings -DefaultAccessLevel Quarantine -AdminMailRecipients will@contoso.com,roger@contoso.com -``` - -This example sets the default access level to quarantine and sets two administrative email addresses. - -## PARAMETERS - -### -AdminMailRecipients -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAccessForUnSupportedPlatform -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowRMSSupportForUnenlightenedApps -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) - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultAccessLevel -The DefaultAccessLevel parameter specifies the access level for new devices. Valid values are Allow,Block or Quarantine. The default value is Allow. - -```yaml -Type: Allow | Block | Quarantine -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OtaNotificationMailInsert -The OtaNotificationMailInsert parameter specifies thetext 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 ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserMailInsert -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 ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a447bf51-fcdc-4f8d-8d06-533d299c11fe.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/devices/Set-DeviceConditionalAccessPolicy.md deleted file mode 100644 index 5e9a941e0b..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-DeviceConditionalAccessPolicy.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DeviceConditionalAccessPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DeviceConditionalAccessPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DeviceConditionalAccessPolicy cmdlet to modify mobile device conditional access policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-DeviceConditionalAccessPolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-DeviceConditionalAccessPolicy [-Identity] <PolicyIdParameter> [-Comment <String>] [-Enabled <$true | $false>] [-Force] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DeviceConditionalAccessPolicy -Identity Executives -Enabled $false -``` - -This example disables the existing mobile device conditional access policy named Executives. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RetryDistribution -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a4365cf4-8ac5-4cee-97ee-28232c191a51.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/devices/Set-DeviceConditionalAccessRule.md deleted file mode 100644 index 4aa4c04687..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-DeviceConditionalAccessRule.md +++ /dev/null @@ -1,1568 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DeviceConditionalAccessRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DeviceConditionalAccessRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DeviceConditionalAccessRule cmdlet to modify mobile device conditional access rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DeviceConditionalAccessRule [-Identity] <ComplianceRuleIdParameter> -TargetGroups <MultiValuedProperty> - [-AccountName <String>] [-AccountUserName <String>] [-AllowAppStore <$true | $false>] - [-AllowAssistantWhileLocked <$true | $false>] [-AllowConvenienceLogon <$true | $false>] - [-AllowDiagnosticSubmission <$true | $false>] [-AllowiCloudBackup <$true | $false>] - [-AllowiCloudDocSync <$true | $false>] [-AllowiCloudPhotoSync <$true | $false>] - [-AllowJailbroken <$true | $false>] [-AllowPassbookWhileLocked <$true | $false>] - [-AllowScreenshot <$true | $false>] [-AllowSimplePassword <$true | $false>] - [-AllowVideoConferencing <$true | $false>] [-AllowVoiceAssistant <$true | $false>] - [-AllowVoiceDialing <$true | $false>] [-AntiVirusSignatureStatus <Int64>] [-AntiVirusStatus <Int64>] - [-AppsRating <DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll>] - [-AutoUpdateStatus <AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault>] - [-BluetoothEnabled <$true | $false>] [-CameraEnabled <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-EmailAddress <String>] [-EnableRemovableStorage <$true | $false>] [-ExchangeActiveSyncHost <String>] - [-FirewallStatus <Required>] [-ForceAppStorePassword <$true | $false>] - [-ForceEncryptedBackup <$true | $false>] [-MaxPasswordAttemptsBeforeWipe <Int32>] - [-MaxPasswordGracePeriod <TimeSpan>] - [-MoviesRating <DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18>] - [-PasswordComplexity <Int64>] [-PasswordExpirationDays <Int32>] [-PasswordHistoryCount <Int32>] - [-PasswordMinComplexChars <Int32>] [-PasswordMinimumLength <Int32>] [-PasswordQuality <Int32>] - [-PasswordRequired <$true | $false>] [-PasswordTimeout <TimeSpan>] [-PhoneMemoryEncrypted <$true | $false>] - [-RegionRatings <us | au | ca | de | fr | ie | jp | nz | gb>] [-RequireEmailProfile <$true | $false>] - [-SmartScreenEnabled <$true | $false>] [-SystemSecurityTLS <$true | $false>] - [-TVShowsRating <DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution>] - [-UserAccountControlStatus <AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify>] - [-WhatIf] [-WLANEnabled <$true | $false>] [-WorkFoldersSyncUrl <String>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DeviceConditionalAccessRule -Identity "Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}" -AllowJailbroken $false -``` - -This example modifies the specified mobile device conditional access rule to block jailbroken devices. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mobile device conditional access rule that you want to modify. The name of the rule uses the syntax \<Mobile device conditional access policy name\>{\<GUID value\>}. 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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetGroups -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountUserName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAppStore -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAssistantWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowConvenienceLogon -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDiagnosticSubmission -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudDocSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudPhotoSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowJailbroken -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPassbookWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowScreenshot -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSimplePassword -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVideoConferencing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceAssistant -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceDialing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusSignatureStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppsRating -The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - -- AllowAll - -- DontAllow - -- Rating9plus - -- Rating12plus - -- Rating17plus - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateStatus -The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - -- AutomaticCheckForUpdates - -- AutomaticDownloadUpdates - -- AutomaticUpdatesRequired - -- DeviceDefault - -- NeverCheckUpdates - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BluetoothEnabled -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CameraEnabled -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRemovableStorage -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeActiveSyncHost -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Required -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceAppStorePassword -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceEncryptedBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordAttemptsBeforeWipe -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordGracePeriod -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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingR18plus - -Canada - -- CARatingG - -- CARatingPG - -- CARating14A - -- CARating18A - -- CARatingR - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingU - -- GBRatingUc - -- GBRatingPG - -- GBRating12 - -- GBRating12A - -- GBRating15 - -- GBRating18 - -Ireland - -- IERatingG - -- IERatingPG - -- IERating12 - -- IERating15 - -- IERating16 - -- IERating18 - -Japan - -- JPRatingG - -- JPRatingPG12 - -- JPRatingRdash15 - -- JPRatingRdash18 - -New Zealand - -- NZRatingG - -- NZRatingPG - -- NZRatingM - -- NZRatingR13 - -- NZRatingR15 - -- NZRatingR16 - -- NZRatingR18 - -- NZRatingR - -United States - -- USRatingG - -- USRatingPG - -- USRatingPG13 - -- USRatingR - -- USRatingNC17 - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordComplexity -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. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordExpirationDays -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinComplexChars -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinimumLength -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordQuality -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. - -This setting is available only on Android 4+ devices. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordRequired -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordTimeout -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: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneMemoryEncrypted -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 (already encrypted and can't be unencrypted) - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. - -Valid values for the RegionRating parameter are: - -- $null (blank): The setting isn't configured. This is the default value. - -- au: Australia - -- ca: Canada - -- de: Germany - -- fr: France - -- gb: United Kingdom - -- ie: Ireland - -- jp: Japan - -- nz: New Zealand - -- us: United States - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: us | au | ca | de | fr | ie | jp | nz | gb -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireEmailProfile -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartScreenEnabled -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemSecurityTLS -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingP - -- AURatingC - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingAv15plus - -Canada - -- CARatingC - -- CARatingC8 - -- CARatingG - -- CARatingPG - -- CARating14plus - -- CARating18plus - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingCaution - -Ireland - -- IERatingGA - -- IERatingCh - -- IERatingYA - -- IERatingPS - -- IERatingMA - -Japan - -- JPRatingExplicitAllowed - -New Zealand - -- NZRatingG - -- NZRatingPGR - -- NZRatingAO - -United States - -- USRatingTVY - -- USRatingTVY7 - -- USRatingTVG - -- USRatingTVPG - -- USRatingTV14 - -- USRatingTVMA - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccountControlStatus -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. - -- AlwaysNotify - -- NeverNotify - -- NotifyAppChanges - -- NotifyAppChangesDoNotDimdesktop - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WLANEnabled -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. - -This setting is available only on Microsoft Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkFoldersSyncUrl -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c545d9ea-af01-4ca1-87bb-3b6ec1da9166.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/devices/Set-DeviceConfigurationPolicy.md deleted file mode 100644 index 22414e7a7a..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-DeviceConfigurationPolicy.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DeviceConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DeviceConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DeviceConfigurationPolicy cmdlet to modify mobile device configuration policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-DeviceConfigurationPolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-DeviceConfigurationPolicy [-Identity] <PolicyIdParameter> [-Comment <String>] [-Enabled <$true | $false>] [-Force] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DeviceConfigurationPolicy -Identity "Engineering Group" -Enabled $false -``` - -This example disables the mobile device configuration policy named Engineering Group. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RetryDistribution -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ef963f3d-8d4e-4dfe-b93e-f0e6343307ee.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/devices/Set-DeviceConfigurationRule.md deleted file mode 100644 index 5e4a4181ca..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-DeviceConfigurationRule.md +++ /dev/null @@ -1,1541 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DeviceConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DeviceConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DeviceConfigurationRule cmdlet to modify mobile device configuration rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DeviceConfigurationRule [-Identity] <ComplianceRuleIdParameter> -TargetGroups <MultiValuedProperty> - [-AccountName <String>] [-AccountUserName <String>] [-AllowAppStore <$true | $false>] - [-AllowAssistantWhileLocked <$true | $false>] [-AllowConvenienceLogon <$true | $false>] - [-AllowDiagnosticSubmission <$true | $false>] [-AllowiCloudBackup <$true | $false>] - [-AllowiCloudDocSync <$true | $false>] [-AllowiCloudPhotoSync <$true | $false>] - [-AllowPassbookWhileLocked <$true | $false>] [-AllowScreenshot <$true | $false>] - [-AllowSimplePassword <$true | $false>] [-AllowVideoConferencing <$true | $false>] - [-AllowVoiceAssistant <$true | $false>] [-AllowVoiceDialing <$true | $false>] - [-AntiVirusSignatureStatus <Int64>] [-AntiVirusStatus <Int64>] - [-AppsRating <DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll>] - [-AutoUpdateStatus <AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault>] - [-BluetoothEnabled <$true | $false>] [-CameraEnabled <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-EmailAddress <String>] [-EnableRemovableStorage <$true | $false>] [-ExchangeActiveSyncHost <String>] - [-FirewallStatus <Required>] [-ForceAppStorePassword <$true | $false>] - [-ForceEncryptedBackup <$true | $false>] [-MaxPasswordAttemptsBeforeWipe <Int32>] - [-MaxPasswordGracePeriod <TimeSpan>] - [-MoviesRating <DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18>] - [-PasswordComplexity <Int64>] [-PasswordExpirationDays <Int32>] [-PasswordHistoryCount <Int32>] - [-PasswordMinComplexChars <Int32>] [-PasswordMinimumLength <Int32>] [-PasswordQuality <Int32>] - [-PasswordRequired <$true | $false>] [-PasswordTimeout <TimeSpan>] [-PhoneMemoryEncrypted <$true | $false>] - [-RegionRatings <us | au | ca | de | fr | ie | jp | nz | gb>] [-RequireEmailProfile <$true | $false>] - [-SmartScreenEnabled <$true | $false>] [-SystemSecurityTLS <$true | $false>] - [-TVShowsRating <DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution>] - [-UserAccountControlStatus <AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify>] - [-WhatIf] [-WLANEnabled <$true | $false>] [-WorkFoldersSyncUrl <String>] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DeviceConfigurationRule -Identity "Engineering Group{914f151c-394b-4da9-9422-f5a2f65dec30}" -AllowScreenshot $false -``` - -This example modifies the specified mobile device configuration rule to block screenshots. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mobile device configuration rule that you want to modify. The name of the rule uses the syntax \<Mobile device configuration policy name\>{\<GUID value\>}. For example, Engineering Group{914f151c-394b-4da9-9422-f5a2f65dec30}.. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetGroups -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountUserName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAppStore -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAssistantWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowConvenienceLogon -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDiagnosticSubmission -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudDocSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowiCloudPhotoSync -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPassbookWhileLocked -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowScreenshot -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSimplePassword -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVideoConferencing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceAssistant -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoiceDialing -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusSignatureStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntiVirusStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppsRating -The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - -- AllowAll - -- DontAllow - -- Rating9plus - -- Rating12plus - -- Rating17plus - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | Rating4plus | Rating9plus | Rating12plus | Rating17plus | AllowAll -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateStatus -The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - -- AutomaticCheckForUpdates - -- AutomaticDownloadUpdates - -- AutomaticUpdatesRequired - -- DeviceDefault - -- NeverCheckUpdates - -- $null (blank): The setting isn't configured. This is the default value. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AutomaticUpdatesRequired | AutomaticCheckForUpdates | AutomaticDownloadUpdates | NeverCheckUpdates | DeviceDefault -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BluetoothEnabled -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CameraEnabled -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRemovableStorage -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. - -This setting is available only on Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeActiveSyncHost -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallStatus -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: Required -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceAppStorePassword -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceEncryptedBackup -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. - -This setting is available on the following types of devices: - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordAttemptsBeforeWipe -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordGracePeriod -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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingR18plus - -Canada - -- CARatingG - -- CARatingPG - -- CARating14A - -- CARating18A - -- CARatingR - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingU - -- GBRatingUc - -- GBRatingPG - -- GBRating12 - -- GBRating12A - -- GBRating15 - -- GBRating18 - -Ireland - -- IERatingG - -- IERatingPG - -- IERating12 - -- IERating15 - -- IERating16 - -- IERating18 - -Japan - -- JPRatingG - -- JPRatingPG12 - -- JPRatingRdash15 - -- JPRatingRdash18 - -New Zealand - -- NZRatingG - -- NZRatingPG - -- NZRatingM - -- NZRatingR13 - -- NZRatingR15 - -- NZRatingR16 - -- NZRatingR18 - -- NZRatingR - -United States - -- USRatingG - -- USRatingPG - -- USRatingPG13 - -- USRatingR - -- USRatingNC17 - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingG | USRatingPG | USRatingPG13 | USRatingR | USRatingNC17 | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingR18plus | CARatingG | CARatingPG | CARating14A | CARating18A | CARatingR | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingG | IERatingPG | IERating12 | IERating15 | IERating16 | IERating18 | JPRatingG | JPRatingPG12 | JPRatingRdash15 | JPRatingRdash18 | NZRatingG | NZRatingPG | NZRatingM | NZRatingR13 | NZRatingR15 | NZRatingR16 | NZRatingR18 | NZRatingR | NZRatingRP16 | GBRatingU | GBRatingUc | GBRatingPG | GBRating12 | GBRating12A | GBRating15 | GBRating18 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordComplexity -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. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordExpirationDays -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinComplexChars -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordMinimumLength -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordQuality -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. - -This setting is available only on Android 4+ devices. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordRequired -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 - -- Apple iOS 6+ - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordTimeout -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: - -- Windows Phone 8.1 - -- Windows 8.1 RT - -- Apple iOS 6+ - -- Android 4+ - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneMemoryEncrypted -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. - -This setting is available on the following types of devices: - -- Windows Phone 8.1 (already encrypted and can't be unencrypted) - -- Android 4+ - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. - -Valid values for the RegionRating parameter are: - -- $null (blank): The setting isn't configured. This is the default value. - -- au: Australia - -- ca: Canada - -- de: Germany - -- fr: France - -- gb: United Kingdom - -- ie: Ireland - -- jp: Japan - -- nz: New Zealand - -- us: United States - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: us | au | ca | de | fr | ie | jp | nz | gb -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireEmailProfile -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartScreenEnabled -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemSecurityTLS -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. - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. - -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. - -Australia - -- AURatingP - -- AURatingC - -- AURatingG - -- AURatingPG - -- AURatingM - -- AURatingMA15plus - -- AURatingAv15plus - -Canada - -- CARatingC - -- CARatingC8 - -- CARatingG - -- CARatingPG - -- CARating14plus - -- CARating18plus - -Germany - -- DERatingab0Jahren - -- DERatingab6Jahren - -- DERatingab12Jahren - -- DERatingab16Jahren - -- DERatingab18Jahren - -France - -- FRRating10minus - -- FRRating12minus - -- FRRating16minus - -- FRRating18minus - -- - -United Kingdom - -- GBRatingCaution - -Ireland - -- IERatingGA - -- IERatingCh - -- IERatingYA - -- IERatingPS - -- IERatingMA - -Japan - -- JPRatingExplicitAllowed - -New Zealand - -- NZRatingG - -- NZRatingPGR - -- NZRatingAO - -United States - -- USRatingTVY - -- USRatingTVY7 - -- USRatingTVG - -- USRatingTVPG - -- USRatingTV14 - -- USRatingTVMA - -This setting is available only on Apple iOS 6+ devices. - -```yaml -Type: DontAllow | AllowAll | USRatingTVY | USRatingTVY7 | USRatingTVG | USRatingTVPG | USRatingTV14 | USRatingTVMA | AURatingP | AURatingC | AURatingG | AURatingPG | AURatingM | AURatingMA15plus | AURatingAv15plus | CARatingC | CARatingC8 | CARatingG | CARatingPG | CARating14plus | CARating18plus | DERatingab0Jahren | DERatingab6Jahren | DERatingab12Jahren | DERatingab16Jahren | DERatingab18Jahren | FRRating10minus | FRRating12minus | FRRating16minus | FRRating18minus | IERatingGA | IERatingCh | IERatingYA | IERatingPS | IERatingMA | JPRatingExplicitAllowed | NZRatingG | NZRatingPGR | NZRatingAO | GBRatingCaution -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccountControlStatus -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. - -- AlwaysNotify - -- NeverNotify - -- NotifyAppChanges - -- NotifyAppChangesDoNotDimdesktop - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: AlwaysNotify | NotifyAppChanges | NotifyAppChangesDoNotDimdesktop | NeverNotify -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WLANEnabled -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. - -This setting is available only on Microsoft Windows Phone 8.1 devices. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkFoldersSyncUrl -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. - -This setting is available only on Windows 8.1 RT devices. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/27cc86c5-8835-41fa-a880-cfe14f615f3b.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/devices/Set-DeviceTenantPolicy.md deleted file mode 100644 index b7d41072e1..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-DeviceTenantPolicy.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DeviceTenantPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DeviceTenantPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DeviceTenantPolicy cmdlet to modify your organization's mobile device tenant policy in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-DeviceTenantPolicy [-Identity <PolicyIdParameter>] [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-DeviceTenantPolicy [-Identity <PolicyIdParameter>] [-Comment <String>] [-Enabled <$true | $false>] [-Force] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DeviceTenantPolicy -Enabled $false -``` - -This example disables your organization's mobile device tenant policy. - -## PARAMETERS - -### -RetryDistribution -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the mobile device tenant policy that you want to 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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b78bc86e-343a-4f0c-ae17-1fb2dcb1f080.aspx) diff --git a/exchange/exchange-ps/exchange/devices/Set-DeviceTenantRule.md b/exchange/exchange-ps/exchange/devices/Set-DeviceTenantRule.md deleted file mode 100644 index 09b58c222c..0000000000 --- a/exchange/exchange-ps/exchange/devices/Set-DeviceTenantRule.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DeviceTenantRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DeviceTenantRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DeviceTenantRule cmdlet to modify your organization's mobile device tenant rule in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DeviceTenantRule [-Identity] <ComplianceRuleIdParameter> - [-ApplyPolicyTo <None | ExchangeOnline | SharepointOnline | ExchangeAndSharepoint>] - [-BlockUnsupportedDevices <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-ExclusionList <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -These are the cmdlets that are used for mobile device management in the Security & Compliance Center: - -- DeviceTenantPolicy and DeviceTenantRule cmdlets: A policy that defines whether to block or allow mobile device access to Office 365 email by unsupported devices that use Exchange ActiveSync only. This setting applies to all users in your organization. Both allow and block scenarios allow reporting for unsupported devices, and you can specify exceptions to the policy based on security groups. - -- DeviceConditionalAccessPolicy and DeviceConditionalAccessRule cmdlets: Policies that control mobile device access to Office 365 for supported devices. These policies are applied to security groups. Unsupported devices are not allowed to enroll in mobile device management. - -- DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - -- Get-DevicePolicy: Returns all mobile device management policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DeviceTenantRule -ExclusionList "Research and Development" -``` - -This example modifies your organization's mobile device tenant rule by replacing the current exclusion list with the security group named Research and Development. Members of this group are allowed access even if they use non-compliant devices. - -## PARAMETERS - -### -Identity -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ApplyPolicyTo -The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - -- ExchangeOnline - -- SharePointOnline - -- ExchangeAndSharePoint - -```yaml -Type: None | ExchangeOnline | SharepointOnline | ExchangeAndSharepoint -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockUnsupportedDevices -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. - -- $false: Unsupported devices are allowed. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExclusionList -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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ba2f9de2-a2a5-4973-9feb-4d90d07e6025.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md deleted file mode 100644 index e2e2e9d3ce..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-AddressListPaging -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-AddressListPaging - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-AddressListPaging cmdlet to disable Active Directory virtual list view for address lists. Virtual list view displays address lists in your organization as pages instead of loading and viewing the entire directory. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-AddressListPaging [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-AddressListPaging -``` - -This example disables virtual list view for address lists in your organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6120be91-33df-4edc-80be-9c346de57bea.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md deleted file mode 100644 index 119ed11b2a..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-AddressListPaging -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-AddressListPaging - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-AddressListPaging cmdlet to enable Active Directory virtual list view for address lists. Virtual list view allows you to display the address lists in your organization as pages instead of loading and viewing the entire directory. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-AddressListPaging [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-AddressListPaging -``` - -This example enables virtual list view for your organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d20e96a9-8742-4f6b-8acc-6433e79a23db.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md deleted file mode 100644 index 76f21a3441..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AddressBookPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-AddressBookPolicy cmdlet to return address book policies that match the specified conditions. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AddressBookPolicy [[-Identity] <MailboxPolicyIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AddressBookPolicy | Format-List -``` - -This example returns detailed information about all address book policies in your organization by pipelining the Format-List cmdlet. - -### -------------------------- Example 2 -------------------------- -``` -Get-AddressBookPolicy -Identity "All Fabrikam" -``` - -This example returns default information about the address book policy All Fabrikam - -### -------------------------- Example 3 -------------------------- -``` -Get-AddressBookPolicy | where {$_.OfflineAddressBook eq "\Fabrikam All OAB"} -``` - -This example returns information about all address book policies for which the offline address book (OAB) that the address book policy uses is named Fabrikam All OAB. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a5ec362f-a941-454f-ba93-cecada3411db.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-AddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-AddressList.md deleted file mode 100644 index 267e021c7b..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-AddressList.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-AddressList cmdlet to view address lists. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Container -``` -Get-AddressList -Container <AddressListIdParameter> - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-AddressList [[-Identity] <AddressListIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### SearchSet -``` -Get-AddressList [-SearchText <String>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AddressList -``` - -This example returns a summary list of all the address lists. - -### -------------------------- Example 2 -------------------------- -``` -Get-AddressList -Identity "All Users\Sales\building4" | Format-List -``` - -This example returns detailed information for the address list named building4that's located under the All Users\\Sales\\ address list. - -## PARAMETERS - -### -Container -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 - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -You can't use this parameter with the Identity or SearchText parameters. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the address list that you want to view. You can use any value that uniquely identifies the address list. For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -You can't use this parameter with the Container or SearchText parameters. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SearchText -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. - -```yaml -Type: String -Parameter Sets: SearchSet -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/21eae768-0a94-4d55-809f-a9b7062092de.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md deleted file mode 100644 index 6ad8a90e3a..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-EmailAddressPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-EmailAddressPolicy cmdlet to view email address policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-EmailAddressPolicy [[-Identity] <EmailAddressPolicyIdParameter>] [-DomainController <Fqdn>] - [-IncludeMailboxSettingOnlyPolicy] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-EmailAddressPolicy -``` - -This example returns a summary list of all email address policies in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-EmailAddressPolicy -Identity "Contoso Employees" -``` - -This example returns detailed information for the email address policy named Contoso Employees. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the email address policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: EmailAddressPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeMailboxSettingOnlyPolicy -This parameter is available or functional only in Exchange Server 2010. - -The IncludeMailboxSettingOnlyPolicy parameter retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. Microsoft Exchange Server 2010 supports both policies that contain only address policy settings and policies that contain address policy settings and mailbox management configuration. Exchange 2010 doesn't support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. The IncludeMailboxSettingOnlyPolicy parameter is required to retrieve these policies. - -The attributes of address policies that contain only mailbox management configuration can't be modified in Exchange 2010. These policies can only be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ab3c08f2-31d7-4711-a1ec-6e7135c9fdfa.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md deleted file mode 100644 index 3927402cc5..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-GlobalAddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-GlobalAddressList cmdlet to view a global address list (GAL) or a set of GALs. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### DefaultOnly -``` -Get-GlobalAddressList [-DefaultOnly] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-GlobalAddressList [[-Identity] <GlobalAddressListIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-GlobalAddressList -``` - -This example returns a summary list of all GALs. - -### -------------------------- Example 2 -------------------------- -``` -Get-GlobalAddressList -Identity GAL_AgencyB | Format-List -``` - -This example returns detailed information about the GAL named GAL\_AgencyB. - -## PARAMETERS - -### -DefaultOnly -The DefaultOnly switch filters the results so only the default GAL is returned. You don't need to use a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the global address list that you want to view. You can use any value that uniquely identifies the GAL. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: GlobalAddressListIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1cf4684c-0347-488e-aa04-04d11dd5661c.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md deleted file mode 100644 index dc984ff643..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OabVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-OabVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-OabVirtualDirectory cmdlet to view offline address book (OAB) virtual directories(OAB distribution points) that are used in Internet Information Services (IIS) on Microsoft Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-OabVirtualDirectory -Server <ServerIdParameter> - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -### Identity -``` -Get-OabVirtualDirectory [[-Identity] <VirtualDirectoryIdParameter>] - [-ADPropertiesOnly] - [-DomainController <Fqdn>] - [-ShowMailboxVirtualDirectories] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OabVirtualDirectory -``` - -This example returns all OAB virtual directory web distribution points. - -### -------------------------- Example 2 -------------------------- -``` -Get-OabVirtualDirectory -Server MBX-01-007 -``` - -This example returns all OAB virtual directory web distribution points on the server named MBX-01-007. - -### -------------------------- Example 3 -------------------------- -``` -Get-OabVirtualDirectory -Identity "MBX-01-007\OAB*" | Format-List -``` - -This example returns detailed information for the OAB virtual directory named "OAB (Default Web Site)" on the server named MBX-01-007. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- ExchangeLegacyDN - -You can't use the Server and Identity parameters in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the virtual directory that you want to view. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ShowMailboxVirtualDirectories -The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. - -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. - -We recommend that you use this parameter only under the direction of Microsoft Customer Service and Support. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4ca17b2b-73c4-41f2-86fe-a52fb8d89d73.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md deleted file mode 100644 index 6fa28d8c53..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OfflineAddressBook -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-OfflineAddressBook cmdlet to view offline address books (OABs). - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-OfflineAddressBook -Server <ServerIdParameter> -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-OfflineAddressBook [[-Identity] <OfflineAddressBookIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OfflineAddressBook -``` - -This example returns a summary list of all existing OABs. - -### -------------------------- Example 2 -------------------------- -``` -Get-OfflineAddressBook -Identity "\Default Offline Address Book" | Format-List -``` - -This example returns detailed information about the OAB named Default Offline Address Book. - -### -------------------------- Example 3 -------------------------- -``` -Get-OfflineAddressBook | Format-List Name,AddressLists,GeneratingMailbox,GUID -``` - -This example returns specific properties for all existing OABs, including the GeneratingMailbox property that specifies the arbitration mailbox that's responsible for generating the OAB. - -## PARAMETERS - -### -Server -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. - -The Server parameter returns all of the OABs that are generated by the specified Exchange 2010 or earlier server. You can use any value that uniquely identifies the server. For example: - -- Name - -- Distinguished name (DN) - -- FQDN - -- ExchangeLegacyDN - -- GUID - -You can't use this parameter with the Identity parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example: - -- Name or \\Name - -- Distinguished name (DN) - -- GUID - -You can't use this parameter with the Server parameter. - -```yaml -Type: OfflineAddressBookIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4f865c2b-21c6-46cc-9c77-a3fc98538a40.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Move-AddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Move-AddressList.md deleted file mode 100644 index 3199b7836d..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Move-AddressList.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-AddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Move-AddressList - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Move-AddressList cmdlet to move an existing address list to a new container under the root address list. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Move-AddressList [-Identity] <AddressListIdParameter> -Target <AddressListIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Move-AddressList -Identity c3fffd8e-026b-41b9-88c4-8c21697ac8ac -Target "\All Users\Sales\building4" -``` - -This example moves the address list with GUID c3fffd8e-026b-41b9-88c4-8c21697ac8ac to a new location under the parent address list \\All Users\\Sales\\building4. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -```yaml -Type: AddressListIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Target -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 - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -```yaml -Type: AddressListIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c5db411c-bfc7-4baa-b5ca-015b9e6ffa11.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md deleted file mode 100644 index a1e80db408..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-OfflineAddressBook -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Move-OfflineAddressBook - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Move-OfflineAddressBook cmdlet to designate a new server responsible for generating the offline address book (OAB) in Exchange Server 2010. This cmdlet isn't used on OABs in Exchange Server 2016 or Exchange Server 2013. To perform this task in Exchange 2016 or Exchange 2013, use the Set-OfflineAddressBook cmdlet with the GeneratingMailbox parameter. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Move-OfflineAddressBook [-Identity] <OfflineAddressBookIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Move-OfflineAddressBook -Identity "My OAB" -Server "Server1" -``` - -This example moves OAB generation in Exchange 2010 to the server named Server1. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: OfflineAddressBookIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/54ddf362-af4f-402f-8d70-aaf81d074b16.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md deleted file mode 100644 index 3c13e9ff81..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-AddressBookPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists that will be displayed to mailbox users who are assigned the policy. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AddressBookPolicy [-Name] <String> -AddressLists <AddressListIdParameter[]> - -GlobalAddressList <GlobalAddressListIdParameter> -OfflineAddressBook <OfflineAddressBookIdParameter> - -RoomList <AddressListIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AddressBookPolicy -Name "All Fabrikam ABP" -AddressLists "\All Fabrikam","\All Fabrikam Mailboxes","\All Fabrikam DLs","\All Fabrikam Contacts" -RoomList "\All Fabrikam-Rooms" -OfflineAddressBook "\Fabrikam-All-OAB" -GlobalAddressList "\All Fabrikam" -``` - -This example creates an address book policy with the following settings: - -- Name: All Fabrikam ABP - -- Included address lists: All Fabrikam, All Fabrikam Mailboxes, All Fabrikam DLs, All Fabrikam Contacts - -- Included room list: All Fabrikam-Rooms - -- Included OAB: Fabrikam-All-OAB - -- Included GAL: All Fabrikam - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -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". - -```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 -Default value: None -Accept pipeline input: False -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. - -```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 -Default value: None -Accept pipeline input: False -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomList -The RoomList parameter specifies the room address list that will be used by mailbox users who are assigned this address book policy. You can specify only one room list for each address book policy. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/07133bd2-ed6d-4a4b-8c3a-bd0c016f68eb.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-AddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-AddressList.md deleted file mode 100644 index d104475735..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-AddressList.md +++ /dev/null @@ -1,652 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-AddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-AddressList cmdlet to create address lists and apply them to recipients. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### PrecannedFilter -``` -New-AddressList [-Name] <String> [-IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients>] - [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] - [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] - [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] - [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] - [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] - [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] - [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] - [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] - [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] - [-Confirm] - [-Container <AddressListIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### CustomFilter -``` -New-AddressList [-Name] <String> [-RecipientFilter <String>] - [-Confirm] - [-Container <AddressListIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AddressList -Name MyAddressList -RecipientFilter {((RecipientType -eq 'MailboxUser') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))} -``` - -This example creates the address list MyAddressList. The address list includes recipients that are mailbox users and have the StateOrProvince property set to Washington or Oregon. - -### -------------------------- Example 2 -------------------------- -``` -New-AddressList -Name MyAddressList2 -ConditionalStateOrProvince Washington -IncludedRecipients MailboxUsers -``` - -This example creates the address list MyAddressList2 that includes mailboxes that have the ConditionalStateOrProvince parameter set to Washington. - -### -------------------------- Example 3 -------------------------- -``` -New-AddressList -Name "AL_AgencyB" -RecipientFilter {((RecipientType -eq 'MailboxUser') -and (CustomAttribute15 -like *AgencyB*))} -``` - -This example creates the address list AL\_AgencyB that includes mailboxes that have the value of the CustomAttribute15 parameter contains AgencyB. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCompany -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Container -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 - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -If you don't use this parameter,the address list is created under the root (\\). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -Parameter Sets: PrecannedFilter -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 -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is the OU where the object was created. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```yaml -Type: String -Parameter Sets: CustomFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2bcee6db-01d4-40ad-9595-33356a4025c5.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md deleted file mode 100644 index 85f0947b19..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md +++ /dev/null @@ -1,863 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-EmailAddressPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-EmailAddressPolicy cmdlet to create email address policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AllTemplatesWithPrecannedFilter -``` -New-EmailAddressPolicy [-Name] <String> -EnabledEmailAddressTemplates <ProxyAddressTemplateCollection> -IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients> - [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] - [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] - [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] - [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] - [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] - [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] - [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] - [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] - [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] - [-Confirm] - [-DisabledEmailAddressTemplates <ProxyAddressTemplateCollection>] - [-DomainController <Fqdn>] - [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AllTemplatesWithCustomFilter -``` -New-EmailAddressPolicy [-Name] <String> -EnabledEmailAddressTemplates <ProxyAddressTemplateCollection> -RecipientFilter <String> - [-Confirm] - [-DisabledEmailAddressTemplates <ProxyAddressTemplateCollection>] - [-DomainController <Fqdn>] - [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### SMTPTemplateWithPrecannedFilter -``` -New-EmailAddressPolicy [-Name] <String> -EnabledPrimarySMTPAddressTemplate <String> -IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients> - [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] - [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] - [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] - [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] - [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] - [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] - [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] - [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] - [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] - [-Confirm] - [-DomainController <Fqdn>] - [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### SMTPTemplateWithCustomFilter -``` -New-EmailAddressPolicy [-Name] <String> -EnabledPrimarySMTPAddressTemplate <String> -RecipientFilter <String> - [-Confirm] - [-DomainController <Fqdn>] - [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AllTemplatesForUnifiedGroupRecipientsFilter -``` -New-EmailAddressPolicy [-Name] <String> -EnabledEmailAddressTemplates <ProxyAddressTemplateCollection> [-IncludeUnifiedGroupRecipients] [-ManagedByFilter <String>] - [-Confirm] - [-DisabledEmailAddressTemplates <ProxyAddressTemplateCollection>] - [-DomainController <Fqdn>] - [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] - [<CommonParameters>] -``` - -### SMTPTemplateForUnifiedGroupRecipientsFilter -``` -New-EmailAddressPolicy [-Name] <String> -EnabledPrimarySMTPAddressTemplate <String> [-IncludeUnifiedGroupRecipients] [-ManagedByFilter <String>] - [-Confirm] - [-DomainController <Fqdn>] - [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you use the New-EmailAddressPolicy cmdlet to create an email address policy in an on-premises Exchange organization, you need to use the Update-EmailAddressPolicy cmdlet to apply the new policy to recipients. - -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-EmailAddressPolicy -Name "Southeast Offices" -IncludedRecipients MailboxUsers -ConditionalStateorProvince "GA","AL","LA" -EnabledEmailAddressTemplates "SMTP:%s%2g@southeast.contoso.com","smtp:%s%2g@southeast.contoso.net" -``` - -This example creates an email address policy in an on-premises Exchange organization that uses a precanned recipient filter: - -- Name: Southeast Offices - -- Precanned recipient filter: All users with mailboxes where the State or province value is GA, AL, or LA (Georgia, Alabama, or Louisiana). - -- Primary SMTP email address: \<last name\>.\<first two letters of the first name\>@contoso.com - -- Additional proxy email addresses: \<last name\>.\<first two letters of the first name\>@contoso.net - -- Priority:N+1, where N is the number of manually created email address policies that already exist (we didn't use the Priority parameter, and the default value is N+1). - -### -------------------------- Example 2 -------------------------- -``` -New-EmailAddressPolicy -Name "Northwest Executives" -RecipientFilter {(RecipientType -eq 'UserMailbox') -and (Title -like '*Director*' -or Title -like '*Manager*') -and (StateOrProvince -eq 'WA' -or StateOrProvince -eq 'OR' -or StateOrProvince -eq 'ID')} -EnabledEmailAddressTemplates "SMTP:%2g%s@contoso.com" -Priority 2 -``` - -This example creates an email address policy in an on-premises Exchange organization that uses a custom recipient filter: - -- Name: Northwest Executives - -- Custom recipient filter: All users with mailboxes where the Title value contains Director or Manager, and the State or province value is WA, OR, or ID (Washington, Oregon, or Idaho). - -- Primary SMTP email address: \<first two letters of the first name\>\<last name\>@contoso.com - -- Additional proxy email addresses: None - -- Priority: 2 - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledEmailAddressTemplates -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\>: - -- \<Type\>: A valid email address type as described in "Address types" section in Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example, SMTP for the primary email address, and smtp for proxy addresses. - -- \<AddressFormat\>: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example: \<alias\>@contoso.com requires the value %m@contoso.com, and \<firstname\>.\<lastname\>@contoso.com requires the value %g.%s@contoso.com. - -This parameter requires at least one template with the \<Type\> value SMTP (to define the primary SMTP email address). After that, if you don't include a \<Type\> prefix for a template, the value smtp (an SMTP proxy address) is assumed. - -You can specify multiple email address templates separated by commas: "SMTP:\<PrimarySMTPEmailAddress\>","[\<Type1\>]:\<EmailAddress1\>","[\<Type2\>]:\<EmailAddress2\>",..."[\<TypeN\>]:\<EmailAddressN\>". - -You can't use this parameter with the EnabledPrimarySMTPAddressTemplate parameter. - -In Office 365, if you use this parameter with the IncludeUnifiedGroupRecipients, you can't use variables in the email address template. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledPrimarySMTPAddressTemplate -The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. - -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 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example: \<alias\>@contoso.com requires the value %m@contoso.com, and \<firstname\>.\<lastname\>@contoso.com requires the value %g.%s@contoso.com. - -You can't use this parameter with the EnabledEmailAddressTemplates parameter. - -In Office 365, if you use this parameter with the IncludeUnifiedGroupRecipients, you can't use variables in the email address template. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -This parameter is available only in on-premises Exchange. - -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUnifiedGroupRecipients -This parameter is available only in the cloud-based service. - -The IncludeUnifiedGroupRecipients switch specifies that the email address policy applies to Office 365 groups. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientFilter -This parameter is available only in on-premises Exchange. - -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. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```yaml -Type: String -Parameter Sets: AllTemplatesWithCustomFilter, SMTPTemplateWithCustomFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCompany -This parameter is available only in on-premises Exchange. - -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute1 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute10 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute11 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute12 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute13 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute14 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute15 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute2 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute3 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute4 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute5 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute6 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute7 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute8 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalCustomAttribute9 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalDepartment -This parameter is available only in on-premises Exchange. - -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -ConditionalStateOrProvince -This parameter is available only in on-premises Exchange. - -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledEmailAddressTemplates -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 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. - -- \<AddressFormat\>: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedByFilter -This parameter is available only in the cloud-based service. - -The ManagedByFilter parameter specifies the email address policies to apply to Office 365 groups based on the properties of the users who create the Office 365 groups. - -This parameter is an OPath filter that's based on the value of any available recipient property (for example, {Department -eq 'Sales'}). You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- You can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Multi-domain support for Office 365 groups - Admin help (https://go.microsoft.com/fwlink/p/?linkid=838413). - -For a list of the filterable properties, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You need to use this parameter with the IncludeUnifiedGroupRecipients switch. - -```yaml -Type: String -Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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. - -Note: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is the OU where the object was created. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/23b6e364-b56e-4c5a-bc71-ff5652d7e42b.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-GlobalAddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-GlobalAddressList.md deleted file mode 100644 index d18946c564..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-GlobalAddressList.md +++ /dev/null @@ -1,598 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-GlobalAddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-GlobalAddressList cmdlet to create a global address list (GAL). - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### PrecannedFilter -``` -New-GlobalAddressList [-Name] <String> [-IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients>] - [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] - [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] - [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] - [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] - [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] - [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] - [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] - [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] - [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] - [-Confirm] - [-DomainController <Fqdn>] - - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### CustomFilter -``` -New-GlobalAddressList [-Name] <String> [-RecipientFilter <String>] - [-Confirm] - [-DomainController <Fqdn>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-GlobalAddressList -Name "NewGAL" -``` - -This example creates the GAL named NewGAL. - -### -------------------------- Example 2 -------------------------- -``` -New-GlobalAddressList -Name GAL_AgencyB -RecipientFilter {((RecipientType -eq "UserMailbox") -and (CustomAttribute15 -eq "AgencyB"))} -``` - -This example creates the GAL named GAL\_AgencyB by using the RecipientFilter parameter to include all mailbox users whose custom attribute 15 equals AgencyB. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCompany -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -Parameter Sets: PrecannedFilter -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 -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is the OU where the object was created. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```yaml -Type: String -Parameter Sets: CustomFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9349a281-f92f-40f9-bf29-2a2e138c2783.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md deleted file mode 100644 index ddd5aef861..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md +++ /dev/null @@ -1,455 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OfflineAddressBook -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-OfflineAddressBook cmdlet to create offline address books (OABs). - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-OfflineAddressBook [-Name] <String> -AddressLists <AddressBookBaseIdParameter[]> [-Confirm] - [-DiffRetentionPeriod <Unlimited>] [-DomainController <Fqdn>] [-GlobalWebDistributionEnabled <$true | $false>] - [-IsDefault <$true | $false>] [-PublicFolderDatabase <DatabaseIdParameter>] [-PublicFolderDistributionEnabled <$true | $false>] - [-Schedule <Schedule>] [-Server <ServerIdParameter>] [-SkipPublicFolderInitialization] - [-Versions <MultiValuedProperty>] [-VirtualDirectories <VirtualDirectoryIdParameter[]>] [-WhatIf] - [-GeneratingMailbox <MailboxIdParameter>] [-ShadowMailboxDistributionEnabled <$true | $false>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"}; New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00" -``` - -In Exchange Server 2010 and 2013, this example uses two commands to create the OAB named OAB\_AgencyB that includes all address lists in which AgencyB is part of the name. By using the settings shown, an OAB is generated by myserver.contoso.com on Mondays and Wednesdays from 01:00 (1 A.M.) to 02:00 (2 A.M.). This example command also creates the default OAB for the organization. - -### -------------------------- Example 2 -------------------------- -``` -New-OfflineAddressBook -Name "Contoso Executives OAB" -AddressLists "Default Global Address List","Contoso Executives Address List" -GlobalWebDistributionEnabled $true -``` - -This example creates a new OAB named Contoso Executives OAB with the following properties: - -- Address lists included in the OAB: Default Global Address List and Contoso Executives Address List - -- All OAB virtual directories in the organization can accept requests to download the OAB. - -The organization mailbox that's responsible for generating the OAB is SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} (we didn't use the GeneratingMailbox parameter to specify a different organization mailbox). - -The OAB isn't used by mailboxes and mailbox databases that don't have an OAB specified (we didn't use the IsDefault parameter with the value $true). - -### -------------------------- Example 3 -------------------------- -``` -New-OfflineAddressBook -Name "New OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -VirtualDirectories "SERVER01\OAB (Default Web Site)" -``` - -In Exchange Server 2010, this example creates the OAB New OAB that uses Web-based distribution for Microsoft Office Outlook 2007 or later clients on SERVER01 by using the default virtual directory. - -### -------------------------- Example 4 -------------------------- -``` -New-OfflineAddressBook -Name "Legacy OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -PublicFolderDatabase "PFDatabase" -PublicFolderDistributionEnabled $true -Versions Version1,Version2 -``` - -In Exchange Server 2010, this example creates the OAB Legacy OAB that uses public folder distribution for Outlook 2003 Service Pack 1 (SP1) and Outlook 98 Service Pack 2 (SP2) clients on SERVER01. - -If you configure OABs to use public folder distribution, but your organization doesn't have any public folder infrastructure, an error will be returned. For more information, see Managing Public Folders. - -## PARAMETERS - -### -AddressLists -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 - -- Distinguished name (DN) - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can find the identify values of address lists and global address lists by using the Get-AddressList and Get-GlobalAddressList cmdlets. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DiffRetentionPeriod -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalWebDistributionEnabled -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. - -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. - -```yaml -Type: $true | $false -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 -``` - -### -IsDefault -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. - -```yaml -Type: $true | $false -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 -``` - -### -PublicFolderDatabase -This parameter is available or functional only in Exchange Server 2010. - -The PublicFolderDatabase parameter specifies the identity of the public folder database being used to distribute the OAB. To use this parameter, the PublicFolderDistributionEnabled parameter must be set to $true. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderDistributionEnabled -This parameter is available or functional 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -This parameter is available or functional only in Exchange Server 2010. - -The Schedule parameter specifies the interval scheduled for generating the new OAB. - -The Schedule parameter takes the following format and must include a range: Weekday.Hour:Minute[AM/PM]-Weekday.Hour:Minute[AM/PM]. - -```yaml -Type: Schedule -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies which server the new OAB is created on. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SkipPublicFolderInitialization -This parameter is available or functional only in Exchange Server 2010. - -The SkipPublicFolderInitialization parameter specifies whether to skip the immediate creation of the OAB public folders if you're creating an OAB that uses public folder distribution. The OAB isn't available for download until the next site folder maintenance cycle has completed. You don't have to specify a value with the SkipPublicFolderInitialization parameter. Omitting this parameter may cause the task to pause while it contacts the responsible public folder server to create the necessary public folders. If the server is presently unreachable, or is otherwise costly to contact, the pause could be significant. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Versions -This parameter is available or functional only in Exchange Server 2010. - -The Versions parameter specifies what version of OAB to generate. The allowed values are: - -- Version1 - -- Version2 - -- Version3 - -- Version4 - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualDirectories -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. - -You can use any value that uniquely identifies the virtual directory. For example: - -- Name or \<Server\>\\Name - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -The default value of this parameter is the Client Access services (frontend) and backend OAB virtual directories on the Mailbox server that holds the OAB generation mailbox (the GeneratingMailbox parameter or SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}). For example, Mailbox01\\OAB (Default Web Site),Mailbox01\\OAB (Exchange Back End. - -To use this parameter, the value of the GlobalWebDistributionEnabled parameter must be $false. - -In Exchange 2013 CU7 or later, we recommend that you set the GlobalWebDistributionEnabled parameter to $true, because the Client Access services on any Mailbox server can proxy incoming OAB download requests to the correct location. - -```yaml -Type: VirtualDirectoryIdParameter[] -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeneratingMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -The default value for this parameter is the organization mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}. - -A single organization mailbox can generate multiple OABs (you can use the same value for this parameter in the settings of multiple OABs), but in Exchange 2013 CU5 or later, an OAB can only be generated by a single organization mailbox (this parameter doesn't accept multiple values). To have a read only copy of the OAB (also known as a shadow copy) available in other organization mailboxes, use the ShadowMailboxDistributionEnabled parameter. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShadowMailboxDistributionEnabled -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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8b9a3931-90c3-4b36-9dcb-5e2e65cd7e5e.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md deleted file mode 100644 index 875ebc4a3a..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AddressBookPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-AddressBookPolicy cmdlet to delete an address book policy. You can't remove the address book policy if it's still assigned to a user's mailbox. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AddressBookPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You can't delete an address book policy if it's assigned to a user. To determine if an address book policy is assigned to a user, run the following command: - -Get-Mailbox | where $._AddressBookPolicy -eq "Murchison's Class"} - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AddressBookPolicy -Identity "Murchison's Class" -``` - -This example deletes the address book policy Murchison's Class. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/57ff215a-cba5-46d1-a7f7-ab2512ce4b6f.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md deleted file mode 100644 index 7bccb1ad57..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OabVirtualDirectory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-OabVirtualDirectory - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-OabVirtualDirectory cmdlet to remove offline address book (OAB) virtual directories from Internet Information Services (IIS) on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OabVirtualDirectory [-Identity] <VirtualDirectoryIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OabVirtualDirectory -Identity "OAB (Default Web Site)" -``` - -This example removes the default OAB virtual directory from the local server. - -### -------------------------- Example 2 -------------------------- -``` -Remove-OabVirtualDirectory -Identity "Server1\OAB (Default Web Site)" -``` - -This example removes the default OAB virtual directory from Server1. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -The Name value uses the syntax "\<VirtualDirectoryName\> (\<WebsiteName\>)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \<VirtualDirectoryName\>\*. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/077d03e7-363d-4ba4-9cfc-5585a73689bc.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md deleted file mode 100644 index b5f1854960..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OfflineAddressBook -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs). - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OfflineAddressBook [-Identity] <OfflineAddressBookIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OfflineAddressBook -Identity "\Contoso Executives" -``` - -This example removes the OAB named Contoso Executives. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```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: 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 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88a8f173-34b9-4e75-8f1a-26ad6f972e98.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md deleted file mode 100644 index 8132e1a5bb..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AddressBookPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-AddressBookPolicy cmdlet to change the settings of an address book policy. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AddressBookPolicy [-Identity] <MailboxPolicyIdParameter> [-AddressLists <AddressListIdParameter[]>] - [-Confirm] [-DomainController <Fqdn>] [-GlobalAddressList <GlobalAddressListIdParameter>] [-Name <String>] - [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-RoomList <AddressListIdParameter>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AddressBookPolicy -Identity "All Fabrikam ABP" -OfflineAddressBook \Fabrikam-OAB-2 -GlobalAddressList "\All Fabrikam GAL" -``` - -This example changes the OAB that the address book policy All Fabrikam ABP uses to Fabrikam-OAB-2. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomList -The RoomList parameter specifies the name of the room address list. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c0dc5fff-af06-4008-9173-629d1f901c69.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-AddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-AddressList.md deleted file mode 100644 index 1de2c4e7fe..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-AddressList.md +++ /dev/null @@ -1,637 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-AddressList cmdlet to modify existing address lists. - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AddressList [-Identity] <AddressListIdParameter> [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-ForceUpgrade] - [-IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients>] - [-Name <String>] [-RecipientContainer <OrganizationalUnitIdParameter>] [-RecipientFilter <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-AddressList cmdlet, piped to Format-List, to get the GUID, distinguished name (DN), or path and name of an existing address list. Or, use Get-AddressList to get a specific existing address list, and then pipe the output directly to the Set-AddressList cmdlet. - -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AddressList -Identity "All Users\Sales\building4" -Name building9 -``` - -This example modifies the name of an existing address list. - -### -------------------------- Example 2 -------------------------- -``` -Set-Addresslist -Identity c3fffd8e-026b-41b9-88c4-8c21697ac8ac -IncludedRecipients MailboxUsers -ConditionalDepartment Sales -``` - -This example modifies the type of recipients and the department of the recipients included in the existing address list identified by its GUID. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -```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: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ConditionalCompany -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -This parameter is available only in on-premises Exchange. - -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is the OU where the object was created. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/72f87402-659c-4ae0-966b-42e1098e0fee.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md deleted file mode 100644 index b5b9552a34..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md +++ /dev/null @@ -1,813 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-EmailAddressPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-EmailAddressPolicy cmdlet to modify email address policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-EmailAddressPolicy [-Identity] <EmailAddressPolicyIdParameter> [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] [-Confirm] - [-DisabledEmailAddressTemplates <ProxyAddressTemplateCollection>] [-DomainController <Fqdn>] - [-EnabledEmailAddressTemplates <ProxyAddressTemplateCollection>] [-EnabledPrimarySMTPAddressTemplate <String>] - [-ForceUpgrade] - [-IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients>] - [-Name <String>] [-Priority <EmailAddressPolicyPriority>] - [-RecipientContainer <OrganizationalUnitIdParameter>] [-RecipientFilter <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -After you use the Set-EmailAddressPolicy cmdlet to modify an email address policy in an on-premises Exchange organization, you need to use the Update-EmailAddressPolicy cmdlet to apply the updated policy to recipients. - -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-EmailAddressPolicy -Identity "Southeast Executives" -ConditionalStateOrProvince @{Add="TX"} -``` - -In on-premises Exchange, this example modifies the existing email address policy named Southeast Executives by adding the State or province value TX (Texas) to the precanned recipient filter. - -### -------------------------- Example 2 -------------------------- -``` -Set-EmailAddressPolicy -Identity "Contoso Corp" -DisabledEmailAddressTemplates $null -``` - -In on-premises Exchange, this example clears the disabled email address templates from the email address policy named Contoso Corp. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ConditionalCompany -This parameter is available only in on-premises Exchange. - -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter is available only in on-premises Exchange. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -This parameter is available only in on-premises Exchange. - -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -This parameter is available only in on-premises Exchange. - -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DisabledEmailAddressTemplates -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 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. - -- \<AddressFormat\>: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). 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\>". - -Typically, this property is only populated by values after a migration from a previous version of Exchange. To clear these values, use the value $null for this parameter. - -```yaml -Type: ProxyAddressTemplateCollection -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledEmailAddressTemplates -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\>: - -- \<Type\>: A valid email address type as described in "Address types" section in Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example, SMTP for the primary email address, and smtp for proxy addresses. - -- \<AddressFormat\>: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example: \<alias\>@contoso.com requires the value %m@contoso.com, and \<firstname\>.\<lastname\>@contoso.com requires the value %g.%s@contoso.com. - -This parameter requires at least one template with the \<Type\> value SMTP (to define the primary SMTP email address). After that, if you don't include a \<Type\> prefix for a template, the value smtp (an SMTP proxy address) is assumed. - -You can specify multiple email address templates separated by commas: "SMTP:\<PrimarySMTPEmailAddress\>","[\<Type1\>]:\<EmailAddress1\>","[\<Type2\>]:\<EmailAddress2\>",..."[\<TypeN\>]:\<EmailAddressN\>". - -You can't use this parameter with the EnabledPrimarySMTPAddressTemplate parameter. - -In Office 365, if you use this parameter with the IncludeUnifiedGroupRecipients, you can't use variables in the email address template. - -```yaml -Type: ProxyAddressTemplateCollection -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 -``` - -### -EnabledPrimarySMTPAddressTemplate -The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. - -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 2016 (https://technet.microsoft.com/library/bb232171.aspx). For example: \<alias\>@contoso.com requires the value %m@contoso.com, and \<firstname\>.\<lastname\>@contoso.com requires the value %g.%s@contoso.com. - -You can't use this parameter with the EnabledEmailAddressTemplates parameter. - -In Office 365, if you use this parameter with the IncludeUnifiedGroupRecipients, you can't use variables in the email address template. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -This parameter is available only in on-premises Exchange. - -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -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 -``` - -### -Name -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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. - -Note: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is the OU where the object was created. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -RecipientFilter -This parameter is available only in on-premises Exchange. - -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. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```yaml -Type: String -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c5829edd-8b7d-4437-b17f-bae76ea237e8.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md deleted file mode 100644 index 032257ff2f..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md +++ /dev/null @@ -1,608 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-GlobalAddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-GlobalAddressList cmdlet to modify an existing global address list (GAL). - -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-GlobalAddressList [-Identity] <GlobalAddressListIdParameter> [-ConditionalCompany <MultiValuedProperty>] - [-ConditionalCustomAttribute1 <MultiValuedProperty>] [-ConditionalCustomAttribute10 <MultiValuedProperty>] - [-ConditionalCustomAttribute11 <MultiValuedProperty>] [-ConditionalCustomAttribute12 <MultiValuedProperty>] - [-ConditionalCustomAttribute13 <MultiValuedProperty>] [-ConditionalCustomAttribute14 <MultiValuedProperty>] - [-ConditionalCustomAttribute15 <MultiValuedProperty>] [-ConditionalCustomAttribute2 <MultiValuedProperty>] - [-ConditionalCustomAttribute3 <MultiValuedProperty>] [-ConditionalCustomAttribute4 <MultiValuedProperty>] - [-ConditionalCustomAttribute5 <MultiValuedProperty>] [-ConditionalCustomAttribute6 <MultiValuedProperty>] - [-ConditionalCustomAttribute7 <MultiValuedProperty>] [-ConditionalCustomAttribute8 <MultiValuedProperty>] - [-ConditionalCustomAttribute9 <MultiValuedProperty>] [-ConditionalDepartment <MultiValuedProperty>] - [-ConditionalStateOrProvince <MultiValuedProperty>] [-Confirm] [-DomainController <Fqdn>] [-ForceUpgrade] - [-IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients>] - [-Name <String>] [-RecipientContainer <OrganizationalUnitIdParameter>] [-RecipientFilter <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-GlobalAddressList 96d0c505-eba8-4103-ad4f-577a1bf4ad7b -Name GALwithNewName -``` - -This example assigns a new name, GALwithNewName, to the GAL with the GUID 96d0c505-eba8-4103-ad4f-577a1bf4ad7b. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```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: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ConditionalCompany -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -This parameter is available only in on-premises Exchange. - -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is the OU where the object was created. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/96bf236f-0fb8-44db-9b22-ddc0933db951.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-AddressList.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-AddressList.md deleted file mode 100644 index 7938a7c46c..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-AddressList.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-AddressList -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Update-AddressList - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Update-AddressList cmdlet to update the recipients included in address lists. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-AddressList [-Identity] <AddressListIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-AddressList -Identity "All Users\Sales\building4" -``` - -This example updates the recipients of the address list named building4 that's under the container All Users\\Sales. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<Name\>) or [\<Container\>\\\<Name\>) - -```yaml -Type: AddressListIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/50bf30ea-48cf-4cc9-b0fb-ce332da5bf16.aspx) diff --git a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md b/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md deleted file mode 100644 index 7a06c782a7..0000000000 --- a/exchange/exchange-ps/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-OfflineAddressBook -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Update-OfflineAddressBook - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Update-OfflineAddressBook cmdlet to update the offline address books (OABs) used by Microsoft Outlook clients. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-OfflineAddressBook [-Identity] <OfflineAddressBookIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-OfflineAddressBook -Identity MyOAB -``` - -This example updates the OAB MyOAB. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: OfflineAddressBookIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/08ee5bd7-1c23-492e-8952-d37b2a61c022.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Export-ExchangeCertificate.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Export-ExchangeCertificate.md deleted file mode 100644 index 667d6d4fb4..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Export-ExchangeCertificate.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-ExchangeCertificate -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Export-ExchangeCertificate - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Export-ExchangeCertificate cmdlet to export existing certificates and pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Thumbprint -``` -Export-ExchangeCertificate [-Thumbprint] <String> [-Server <ServerIdParameter>] - [-BinaryEncoded] - [-Confirm] - [-DomainController <Fqdn>] - [-FileName <String>] - [-Password <SecureString>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Export-ExchangeCertificate [[-Identity] <ExchangeCertificateIdParameter>] - [-BinaryEncoded] - [-Confirm] - [-DomainController <Fqdn>] - [-FileName <String>] - [-Password <SecureString>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-ExchangeCertificate cmdlet creates the following types of files: - -- Certificate files: When you export a certificate, the command creates a PKCS #12 file. PKCS #12 is the Personal Information Exchange Syntax standard specified by RSA Laboratories. For more information, see PKCS #12: Personal Information Exchange Syntax Standard (https://www.emc.com/emc-plus/rsa-labs/standards-initiatives/pkcs12-personal-information-exchange-syntax-standard.htm). - - To export a certificate from an Exchange server, the certificate's PrivateKeyExportable property needs to have the value True. To import an exported certificate on another Exchange server, you need to export the certificate by using the Password parameter to include the private key or chain of trust in the certificate file. The default Microsoft Exchange self-signed certificate or new self-signed certificates that you create in the Exchange admin center or by using the default settings of the New-ExchangeCertificate cmdlet aren't exportable, because the private key isn't exportable (the default value of the PrivateKeyExportable parameter is $false). - -- Certificate request files: When you export a certificate request, the command creates a PKCS #10 file. PKCS #10 is the Certification Request Syntax standard specified by RFC 2314. For more information, see PKCS #10: Certification Request Syntax (https://www.ietf.org/rfc/rfc2314.txt). - - 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Export-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -FileName "C:\Data\HT cert.pfx" -BinaryEncoded -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) -``` - -This example exports a certificate from the local Exchange server to a file with the following settings: - -The certificate that has the thumbprint value 5113ae0233a72fccb75b1d0198628675333d010e is exported to the file C:\\Data\\HT cert.pfx. - -The exported certificate file is encoded by DER (not Base64). - -The password for the certificate file is P@ssw0rd1. - -### -------------------------- Example 2 -------------------------- -``` -Export-ExchangeCertificate -Thumbprint 72570529B260E556349F3403F5CF5819D19B3B58 -Server Mailbox01 -FileName "\\FileServer01\Data\Fabrikam.req" -``` - -This example exports a pending certificate request to a file with the following settings: - -The pending certificate request that has the thumbprint value 72570529B260E556349F3403F5CF5819D19B3B58 on the Exchange server named Mailbox01 is exported to the file \\\\FileServer01\\Data\\Fabrikam.req. - -The exported certificate request file is Base64 encoded, so the information that's written to the file is also displayed onscreen. - -## PARAMETERS - -### -Thumbprint -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. - -```yaml -Type: String -Parameter Sets: Thumbprint -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BinaryEncoded -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password for the private key or chain of trust in the exported certificate file. To import the exported certificate file on another server, you need to know the password. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can't use this parameter with the Identity parameter, but you can use it with the Thumbprint parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Thumbprint -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 -``` - -### -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 -``` - -### -FileName -The FileName parameter specifies the name and path of the exported certificate or certificate request file. You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (\\\\\<Server\>\\\<Share\>). If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the certificate or certificate request that you want to export. Valid values are: - -- \<ServerNameorFQDN\>\\\<Thumbprint\> - -- \<Thumbprint\> - -You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. - -You can't use this parameter with the Server parameter. - -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. - -```yaml -Type: ExchangeCertificateIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0fffc597-7b46-4bc3-915c-f00c9eb56b40.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md deleted file mode 100644 index 021ea59393..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Online -title: Get-DataEncryptionPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-DataEncryptionPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-DataEncryptionPolicy cmdlet to view data encryption policies in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DataEncryptionPolicy [[-Identity] <DataEncryptionPolicyIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Data encryption policy cmdlets are the Exchange Online part of service encryption with Customer Key in Office 365. For more information, see Controlling your data in Office 365 using Customer Key (https://aka.ms/customerkey). - -You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DataEncryptionPolicy -``` - -This example returns a summary list of all data encryption policies in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DataEncryptionPolicy -Identity "Europe Mailboxes" -``` - -The example returns detailed information for the data encryption policy named Europe Mailboxes. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the data encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DataEncryptionPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/198d07a9-6163-4230-9b34-523a6a2107ea.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-IRMConfiguration.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Get-IRMConfiguration.md deleted file mode 100644 index e2758a354b..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-IRMConfiguration.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-IRMConfiguration cmdlet to view the Information Rights Management (IRM) configuration in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IRMConfiguration [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IRMConfiguration -``` - -This example retrieves the IRM configuration in your organization. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e1821219-fe18-4642-a9c2-58eb0aadd61a.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-OMEConfiguration.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Get-OMEConfiguration.md deleted file mode 100644 index 72368db792..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-OMEConfiguration.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Online -title: Get-OMEConfiguration -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-OMEConfiguration - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-OMEConfiguration cmdlet to view the Microsoft Office 365 Message Encryption (OME) configuration. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OMEConfiguration [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OMEConfiguration -``` - -This example returns the OME configuration. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/48814519-35a5-4202-906a-9ce37e075fca.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-RMSTemplate.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Get-RMSTemplate.md deleted file mode 100644 index ce6ce194bc..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-RMSTemplate.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RMSTemplate -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RMSTemplate [[-Identity] <RmsTemplateIdParameter>] [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] [-TrustedPublishingDomain <RmsTrustedPublishingDomainIdParameter>] - [-Type <Archived | Distributed | All>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RMSTemplate -ResultSize unlimited -``` - -This example retrieves all RMS templates available from the RMS deployment. - -### -------------------------- Example 2 -------------------------- -``` -Get-RMSTemplate -Identity "Company Confidential" -``` - -This example retrieves the Company Confidential RMS template. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the RMS template. - -```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: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -TrustedPublishingDomain -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -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: - -- All - -- Archived - -- Distributed - -```yaml -Type: Archived | Distributed | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4a5066e8-b770-4aa2-b464-0d2190914f71.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md deleted file mode 100644 index 0a6442bfaa..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-RMSTrustedPublishingDomain -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-RMSTrustedPublishingDomain cmdlet to view the settings of an existing trusted publishing domain (TPD) in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RMSTrustedPublishingDomain [[-Identity] <RmsTrustedPublishingDomainIdParameter>] [-Default] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -A trusted publishing domain contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RMSTrustedPublishingDomain | Format-List -``` - -This example lists all the trusted publishing domains that are configured in your organization and shows detailed information for each trusted publishing domain. - -## PARAMETERS - -### -Default -The Default switch filters the results by the default trusted publishing domain. The default trusted publishing domain displays RMS templates and provides rights protection to all new content. There can be only one default trusted publishing domain in an organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the trusted publishing domain. You can use any value that uniquely identifies the trusted publishing domain, for example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/69499195-f08f-41bd-b0ed-443688410b12.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-SmimeConfig.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Get-SmimeConfig.md deleted file mode 100644 index 7c258a8b9e..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Get-SmimeConfig.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-SmimeConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-SmimeConfig cmdlet to view the S/MIME configuration for Outlook on the web. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SmimeConfig [[-Identity] <OrganizationIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SmimeConfig -``` - -This example shows the S/MIME configuration that's used with Outlook on the web. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4b29fa89-0840-4fe9-8885-019fcef2e02b.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Import-ExchangeCertificate.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Import-ExchangeCertificate.md deleted file mode 100644 index a2af41f549..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Import-ExchangeCertificate.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-ExchangeCertificate -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Import-ExchangeCertificate - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Import-ExchangeCertificate cmdlet to import certificates on Exchange servers. You use this cmdlet to install certificates that were exported from other servers, and to complete pending certification requests (also known as certificate signing requests or CSRs) from certification authorities (CAs). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### FileData -``` -Import-ExchangeCertificate -FileData <Byte[]> - [-Confirm] - [-DomainController <Fqdn>] - [-FriendlyName <String>] - [-Password <SecureString>] - [-PrivateKeyExportable <$true | $false>] - [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### FileName -``` -Import-ExchangeCertificate -Instance <String[]> - [-Confirm] - [-DomainController <Fqdn>] - [-FriendlyName <String>] - [-Password <SecureString>] - [-PrivateKeyExportable <$true | $false>] - [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Instance -``` -Import-ExchangeCertificate -FileName <String> - [-Confirm] - [-DomainController <Fqdn>] - [-FriendlyName <String>] - [-Password <SecureString>] - [-PrivateKeyExportable <$true | $false>] - [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Import-ExchangeCertificate cmdlet to import the following types of certificate files on an Exchange server: - -- APKCS #7 certificate or chain of certificates file (.p7b or .p7c) that was issued by a certification authority (CA). PKCS #7 is the Cryptographic Message Syntax Standard, a syntax used for digitally signing or encrypting data using public key cryptography, including certificates. For more information, see PKCS #7: Cryptographic Message Syntax Standard (https://go.microsoft.com/fwlink/p/?LinkID=510681). - -- A PKCS #12 certificate file (.cer, .crt, .der, .p12, or .pfx) that contains the private key. PKCS #12 is the Personal Information Exchange Syntax Standard, a file format used to store certificates with corresponding private keys that are protected by a password. The standard is specified by RSA Laboratories. For more information, see the PKCS #12: Personal Information Exchange Syntax Standard (https://go.microsoft.com/fwlink/p/?LinkID=90249) website. - -After you import a certificate on an Exchange server, you need to assign the certificate to one or more Exchange services by using the Enable-ExchangeCertificate cmdlet. - -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see Digital certificates and encryption in Exchange 2016. - -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out Protecting you against the SSL 3.0 vulnerability (https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-ExchangeCertificate -Server Mailbox01 -FileName" \\FileServer01\Data\Exported Fabrikam Cert.pfx" -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) -``` - -This example imports the certificate from the PKCS #12 file from \\\\FileServer01\\Data\\Exported Fabrikam Cert.pfx to the Exchange server named Mailbox01. This file requires the password P@ssw0rd1. This certificate could have been exported from another server, or issued by a certification authority. - -### -------------------------- Example 2 -------------------------- -``` -Import-ExchangeCertificate -FileData ([Byte[]](Get-Content -Path "C:\Certificates\Fabrikam IssuedCert.p7b" -Encoding byte -ReadCount 0)) -``` - -This example imports a chain of certificates from the PKCS #7 file C:\\Certificates\\Fabrikam IssuedCert.p7b on the local Exchange server. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the contents of the certificate file that you want to import. Typically, you use this parameter for PKCS #7 text certificate files that have .p7b or .p7c filename extensions. These text files contain the text: -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- or -----BEGIN PKCS7----- and -----END PKCS7-----. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (\\\\\<Server\>\\\<Share\>). - -If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: Byte[] -Parameter Sets: FileData -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -This parameter has been deprecated and is 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 -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -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. - -```yaml -Type: String -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 -``` - -### -Password -The Password parameter specifies the password that's required to import the certificate. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -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 -``` - -### -PrivateKeyExportable -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -FileName -The FileName parameter specifies the certificate file that you want to import. Typically, you use this parameter for PKCS #12 binary certificate files that have .cer, .crt, .der, .p12, or .pfx filename extensions. This type of binary certificate file is protected by a password when the file contains the private key or chain of trust. - -You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (\\\\\<Server\>\\\<Share\>). - -If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c1a98e97-e58a-49c8-a44d-948b2fc07876.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md deleted file mode 100644 index f816835fab..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Import-RMSTrustedPublishingDomain -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Import-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Import-RMSTrustedPublishingDomain cmdlet to import a trusted publishing domain (TPD) from an on-premises server running Active Directory Rights Management Services (AD RMS) or from RMS Online into your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### IntranetLicensingUrl -``` -Import-RMSTrustedPublishingDomain [-Name] <String> -ExtranetLicensingUrl <Uri> -FileData <Byte[]> -IntranetLicensingUrl <Uri> -Password <SecureString> - [-Confirm] - [-Default] - [-WhatIf] [<CommonParameters>] -``` - -### ImportFromFile -``` -Import-RMSTrustedPublishingDomain [-Name] <String> -ExtranetLicensingUrl <Uri> -FileData <Byte[]> -IntranetLicensingUrl <Uri> -Password <SecureString> [-ExtranetCertificationUrl <Uri>] [-IntranetCertificationUrl <Uri>] - [-Confirm] - [-Default] - [-WhatIf] [<CommonParameters>] -``` - -### RefreshTemplates -``` -Import-RMSTrustedPublishingDomain [-Name] <String> -FileData <Byte[]> -Password <SecureString> [-RefreshTemplates] - [-Confirm] - [-Default] - [-WhatIf] [<CommonParameters>] -``` - -### RMSOnline -``` -Import-RMSTrustedPublishingDomain [-Name] <String> [-RMSOnline] [-RefreshTemplates] - [-Confirm] - [-Default] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. After you export the TPD from an on-premises AD RMS server to an XML file, you can import the XML file into your cloud-based organization. - -If the InternalLicensingEnabled parameter value is $true on the Set-IRMConfiguration cmdlet, all TPDs require a private key. If the InternalLicensingEnabled parameter value is $false, TPDs don't require a private key. However, the only RMS feature available to the organization is Outlook protection rules. Typically, TPDs without private keys are created when the AD RMS server uses a hardware-based cryptographic service provider (CSP) or a custom CSP. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-RMSTrustedPublishingDomain -Name "Contoso TPD" -FileData $([byte[]](Get-Content -Encoding byte -Path "C:\My Documents\Contoso.xml" -ReadCount 0)) -Password (ConvertTo-SecureString -String 'Pa$$word1' -AstPlainText -Force)-ExtranetLicensingUrl https://rms.contoso.com/_wmcs/licensing -IntranetLicensingUrl https://RMS01/_wmcs/licensing -``` - -This example imports a TPD from an AD RMS server into a cloud-based organization. The TPD uses the following values: - -- Path to exported XML file: C:\\My Documents\\Contoso.xml - -- Password of exported XML file: Pa$$word1 - -- External licensing URL: https://rms.contoso.com/\_wmcs/licensing - -- Internal licensing URL: https://RMS01/\_wmcs/licensing - -- TPD name: Contoso TPD - -## PARAMETERS - -### -ExtranetLicensingUrl -The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -By default, the value of the ExtranetLicensingUrl parameter is https://\<FQDN\>/\_wmcs/licensing. - -```yaml -Type: Uri -Parameter Sets: IntranetLicensingUrl, ImportFromFile -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the XML file you want to import. The XML file contains the TPD you exported from the on-premises AD RMS server. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: IntranetLicensingUrl, ImportFromFile, RefreshTemplates -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetLicensingUrl -The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -By default, the value of the IntranetLicensingUrl parameter is https://\<server name\>/\_wmcs/licensing. - -```yaml -Type: Uri -Parameter Sets: IntranetLicensingUrl, ImportFromFile -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the TPD. If you use the RefreshTemplates switch, the value must match the name of the previously imported TPD. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password of the TPD that you want to import. The password value must match the password in the XML file when you exported the TPD from the on-premises AD RMS server. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: IntranetLicensingUrl, ImportFromFile, RefreshTemplates -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RMSOnline -The RMSOnline switch specifies that the TPD is imported from RMS Online. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RMSOnline -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -The Default switch specifies that this is the default TPD. You don't need to specify a value with this switch. - -The default TPD displays RMS templates and provides rights protection to all new content. There can be only one default TPD in an organization. - -The first TPD you import into your organization is automatically set as the default. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtranetCertificationUrl -The ExtranetCertificationUrl parameter specifies the external certification URL of the on-premises AD RMS server that's stamped into the Rights Account Certificate (RAC). The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content. - -By default, the value of the ExtranetCertificationUrl parameter is https://\<FQDN\>/\_wmcs/certification/servercertification.asmx. - -```yaml -Type: Uri -Parameter Sets: ImportFromFile -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetCertificationUrl -The IntranetCertificationUrl parameter specifies the internal certification URL of the on-premises AD RMS server that's stamped into the RAC. The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content. - -By default, the value of the IntranetCertificationUrl parameter is https://\<server name\>/\_wmcs/certification/servercertification.asmx. - -```yaml -Type: Uri -Parameter Sets: ImportFromFile -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshTemplates -The RefreshTemplates switch specifies whether to update the RMS templates in a previously imported TPD. You don't need to specify a value with this switch. - -When you add, modify, or remove RMS templates in a TPD on the AD RMS server, you export the updated TPD to a new XML file, and import the new XML file in your cloud-based organization. The RefreshTemplates switch uses the following rules: - -- Only the FileData, Password, and Name parameters are required. The value of the Name parameter must match the name of the previously imported TPD. - -- If the new XML file doesn't contain an RMS template that was defined in the previously imported TPD, the RMS template is removed from the cloud-based organization. - -- If the new XML file contains an updated RMS template that was defined in the previously imported TPD, the RMS template settings are updated in the cloud-based organization. However, the RMS template isn't changed from Archived to Distributed or vice versa. - -- If the new XML file contains an RMS template that wasn't imported in the original TPD, the RMS template is added to the cloud-based organization in the Archived state. To make the new RMS template usable, you must change its state from Archived to Distributed using the Set-RMSTemplate cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: RefreshTemplates, RMSOnline -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7c5e7a0f-9c9d-4863-bab8-bcc729cc16a6.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md deleted file mode 100644 index 6fe6f48c28..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Online -title: New-DataEncryptionPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-DataEncryptionPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-DataEncryptionPolicy cmdlet to create data encryption policies in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DataEncryptionPolicy [-Name] <String> -AzureKeyIDs <MultiValuedProperty> [-Confirm] [-Description <String>] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Data encryption policy cmdlets are the Exchange Online part of service encryption with Customer Key in Office 365. For more information, see Controlling your data in Office 365 using Customer Key (https://aka.ms/customerkey). - -You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DataEncryptionPolicy -Name "US Mailboxes" -AzureKeyIDs "https://contosowestusvault01.vault.azure.net/keys/USA_Key_01","https://contosoeastusvault01.vault.azure.net/keys/USA_Key_02" -Description "Root key for mailboxes located in US territories" -``` - -This example creates a data encryption policy named US Mailboxes with the specified Azure Key Vault keys and description. - -## PARAMETERS - -### -AzureKeyIDs -The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, "https://contosowestusvault01.vault.azure.net/keys/USA/_Key/_01","https://contosoeastusvault01.vault.azure.net/keys/USA/_Key/_02" - -To find the URI value for an Azure Key Vault, replace \<ValutName\> with the name of the vault, and run this command in Azure Rights Management PowerShell: Get-AzureKeyVaultKey -VaultName \<VaultName\>).id. For more information, see Get started with Azure Key Vault (https://go.microsoft.com/fwlink/p/?linkid=521402). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter enables or disable the data encryption policy. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b6965214-8df9-4024-98bf-0ae92c676950.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/New-ExchangeCertificate.md b/exchange/exchange-ps/exchange/encryption-and-certificates/New-ExchangeCertificate.md deleted file mode 100644 index 6c494bd4d7..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/New-ExchangeCertificate.md +++ /dev/null @@ -1,583 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ExchangeCertificate -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-ExchangeCertificate - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-ExchangeCertificate cmdlet to create and renew self-signed certificates, and to create certificate requests (also known as certificate signing requests or CSRs) for new certificates and certificate renewals from a certification authority (CA). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Request -``` -New-ExchangeCertificate [-BinaryEncoded] [-GenerateRequest] [-RequestFile <String>] - [-Confirm] - [-DomainController <Fqdn>] - [-DomainName <MultiValuedProperty>] - [-Force] - [-FriendlyName <String>] - [-IncludeAcceptedDomains] - [-IncludeAutoDiscover] - [-IncludeServerFQDN] - [-IncludeServerNetBIOSName] - [-Instance <X509Certificate2>] - [-KeySize <Int32>] - [-PrivateKeyExportable <$true | $false>] - [-Server <ServerIdParameter>] - [-SubjectKeyIdentifier <String>] - [-SubjectName <X500DistinguishedName>] - [-WhatIf] [<CommonParameters>] -``` - -### Certificate -``` -New-ExchangeCertificate [-Services <None | IMAP | POP | UM | IIS | SMTP | Federation>] - [-Confirm] - [-DomainController <Fqdn>] - [-DomainName <MultiValuedProperty>] - [-Force] - [-FriendlyName <String>] - [-IncludeAcceptedDomains] - [-IncludeAutoDiscover] - [-IncludeServerFQDN] - [-IncludeServerNetBIOSName] - [-Instance <X509Certificate2>] - [-KeySize <Int32>] - [-PrivateKeyExportable <$true | $false>] - [-Server <ServerIdParameter>] - [-SubjectKeyIdentifier <String>] - [-SubjectName <X500DistinguishedName>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Exchange uses certificates for SSL and TLS encryption. - -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see Digital certificates and encryption in Exchange 2016. - -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out Protecting you against the SSL 3.0 vulnerability (https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ExchangeCertificate -``` - -This example creates a self-signed certificate with the following settings: - -The Subject value is CN=\<ServerName\> (for example, CN=Mailbox01). - -The Domains (subject alternative names) value is \<ServerName\>, \<ServerFQDN\> (for example, Mailbox01,Mailbox01.contoso.com). - -The Services value is IMAP,POP,SMTP - -The Services value SMTP grants the Network Services local security group read access to the certificate's private key. - -The Services value SMTP and the Subject value that contains the server name publishes the certificate to Active Directory so that Exchange direct trust can validate the authenticity of the server for mutual TLS. - -If you don't want this certificate to replace the existing self-signed certificate that was created during Exchange setup, be sure to select "No" in the prompt that asks you overwrite the existing default SMTP certificate. - -### -------------------------- Example 2 -------------------------- -``` -New-ExchangeCertificate -GenerateRequest -RequestFile "C:\Cert Requests\woodgrovebank.req" -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com -``` - -This example creates a new certificate request for a certification authority that has the following settings: - -The request is Base64 encoded. - -The output is displayed onscreen and is also written to the text file C:\\Cert Requests\\woodgrovebank.req. - -The Subject value is c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com - -The Domains (subject alternative names) value contains the additional valuesautodiscover.woodgrovebank.com,mail.fabrikam.com, and autodiscover.fabrikam.com. - -After you create the certificate request, you send the output to the CA. After you receive the certificate from the CA, you install the certificate by using the Import-ExchangeCertificate cmdlet, and you assign the certificate to Exchange services by using the Enable-ExchangeCertificate cmdlet. - -If the CA requires the certificate request in a file that's encoded by DER, use the BinaryEncoding switch. - -### -------------------------- Example 3 -------------------------- -``` -Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate -PrivateKeyExportable $true -``` - -This example renewsthe existing self-signed certificate that has the thumbprint value c4248cd7065c87cb942d60f7293feb7d533a4afc. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. Setting the PrivateKeyExportable parameter to the value $true allows the renewed self-signed certificate to be exported from the server (and imported on other servers). - -### -------------------------- Example 4 -------------------------- -``` -Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest -RequestFile "C:\Cert Requests\fabrikam_renewal.req" -``` - -This example creates a request to renew an existing certificate that was issued by a certification authority. The certificate request has the following settings: - -The thumbprint value of the existing certificate is 8A141F7F2BBA8041973399723BD2598D2ED2D831. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. - -The request is Base64 encoded. - -The output is displayed onscreen and is also written to the text file C:\\Cert Requests\\fabrikam\_renewal.req. - -After you create the certificate renewal request, you send the output to the CA. After you receive the renewed certificate from the CA, you install the certificate by using the Import-ExchangeCertificate cmdlet. - -### -------------------------- Example 5 -------------------------- -``` -Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate -``` - -This example shows how to renew a self-signed certificate with a specific thumbprint value. You can obtain the thumbprint value in one of two ways. - -Select the certificate in the Exchange Administration Center and then select Edit to view properties of the certificate. The thumbprint value is shown in the Exchange Certificate window. - -Run the Get-ExchangeCertificate cmdlet to return a list of all certificates installed on the server with their thumbprint values. - -## PARAMETERS - -### -BinaryEncoded -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. - -This switch is available only when you use the GenerateRequest switch. - -For Base64 encoded requests, you send the contents of the file to the certificate authority. For requests that are encoded by DER, you send the certificate file itself. - -```yaml -Type: SwitchParameter -Parameter Sets: Request -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 -``` - -### -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The DomainName parameter specifies one or more FQDNs or server names for theSubject Alternative Namefield (also known as the Subject Alt Name or SAN field) of the certificate request or self-signed certificate. - -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. - -Typically, values include server names (for example, Mailbox01) and FQDNs (for example, mail.contoso.com). You can specify multiple values separated by commas. Valuescan contain the characters a through z, 0 through 9, and the hyphen (-). The length of the domain name can't exceed 255 characters. - -The default value includes the name and FQDN of the Exchange server when both of the following conditions are true: - -- You don't use this parameter. - -- You don't use any of these parameters: IncludeAcceptedDomains, IncludeAutoDiscover, IncludeServerFQDN, or IncludeServerNetBIOSName. - -```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: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -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. - -```yaml -Type: String -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 -``` - -### -GenerateRequest -The GenerateRequest switch specifies that you're creating a certificate request for a certification authority (CA). You don't need to specify a value with this switch. - -This switch, together with the RequestFile parameter, generates a PKCS #10 certificate request that you send to the CA. How you send the information depends on the CA, but typically, for Base64 encoded requests, you paste the contents in an email message or in the request form on the CA's web site. - -After you install the certificate from the certification authority by using the Import-ExchangeCertificate cmdlet, you use the Enable-ExchangeCertficate cmdlet to enable the certificate for Exchange services. - -If you don't use this switch,thecommand creates a new self-signed certificate on the Exchange server. - -```yaml -Type: SwitchParameter -Parameter Sets: Request -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 -``` - -### -IncludeAcceptedDomains -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: - -- If you've already included an accepted domain in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. - -- For new self-signed certificates, if you don't use the Services parameter, the certificate is only assigned to SMTP. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAutoDiscover -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: - -- autodiscover.woodgrovebank.com - -- autodiscover.woodgrovebank.co.uk - -When you use this switch: - -- If you've already included the value autodiscover.\<AcceptedDomain\> in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. - -- For new self-signed certificates, if you don't use the Services parameter, the certificate is only assigned to SMTP. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeServerFQDN -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeServerNetBIOSName -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -This parameter has been deprecated and is 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -KeySize -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) - -- 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateKeyExportable -The PrivateKeyExportable parameter specifies whether the new self-signed certificate has an exportable private key, and controls whether you can export the certificate from the server (and import the certificate on other servers). Valid values are: - -- $true: The private key is exportable, so you can export the certificate from the server. - -- $false: The private key isn't exportable, so you can't export the certificate. This is the default value. - -This parameter is only meaningful for new self-signed certificates. - -```yaml -Type: $true | $false -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 -``` - -### -RequestFile -The RequestFile parameter specifies the name and path of the certificate request file. The file contains the same information that's displayed on-screen when you generate a Base64 encoded certificate request (you don't use the BinaryEncoded switch). - -You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (\\\\\<Server\>\\\<Share\>). If the value contains spaces, enclose the value in quotation marks ("). - -You can use this parameter only when you use the GenerateRequest switch. - -```yaml -Type: String -Parameter Sets: Request -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 -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Services -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. - -- Federation - -- IIS - -- IMAP: Don't enable a wildcard certificate for the IMAP4 service. Instead, use the Set-ImapSettings cmdlet to configure the FQDN that clients use to connect to the IMAP4 service. - -- POP: Don't enable a wildcard certificate for the POP3 service. Instead, use the Set-PopSettings cmdlet to configure the FQDN that clients use to connect to the POP3 service. - -- SMTP: When you enable a certificate for SMTP, you're prompted to replace the default Exchange self-signed certificate that's used to encrypt SMTP traffic between internal Exchange. If you want to replace the default certificate without the confirmation prompt, use the Force switch. - -- UM: This value requires that the UMStartupMode parameter on the Set-UMService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value of TCP, you can't enable the certificate for the UM service. - -- UMCallRouter: This value requires that the UMStartupMode parameter on the Set-UMCallRouterService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value TCP, you can't enable the certificate for the UM Call Router service. - -You can specify multiple values separated by commas. The default values are IMAP,POP, and SMTP. - -You can't use this parameter with the GenerateRequest switch. - -Once you enable a certificate for a service, you can't remove the service from the certificate. - -```yaml -Type: None | IMAP | POP | UM | IIS | SMTP | Federation -Parameter Sets: Certificate -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 -``` - -### -SubjectKeyIdentifier -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectName -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. - -This parameter uses the syntax: [C=\<CountryOrRegion\>,S=\<StateOrProvince\>,L=LocalityOrCity,O=\<Organization\>,OU=\<Department\>],CN=\<HostNameOrFQDN\>. Although the only required value is CN=\<HostNameOrFQDN\>, you should always include C=\<CountryOrRegion\> for certificate requests, but other values might also be required by the certification authority. - -For example, if you want the certificate's subject to be mail.contoso.com in the United States, you can use any of the following values: - -- C=US,S=WA,L=Redmond,O=Contoso,OU=IT,CN=mail.contoso.com - -- C=US,O=Contoso,CN=mail.contoso.com - -- C=US,CN=mail.contoso.com - -If you don't use this parameter, the default value is the name of the Exchange server where you run the command (for example, CN=Mailbox01). - -For a subject alternative name (SAN) certificate, you should choose one of the values from the DomainName parameter to use in the SubjectName value. In fact, the CN value that you specify for SubjectName is automatically included in the DomainName values. - -For a wildcard certificate, use a SubjectName value that contains the wildcard character (\*). For example, C=US,CN=\*.contoso.com. - -```yaml -Type: X500DistinguishedName -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5e0b61b0-ece6-4d9b-949a-f6a032dd0fb9.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md deleted file mode 100644 index 40fcbb960a..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Remove-RMSTrustedPublishingDomain -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-RMSTrustedPublishingDomain cmdlet to remove an existing trusted publishing domain (TPD) from your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RMSTrustedPublishingDomain [-Identity] <RmsTrustedPublishingDomainIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -A trusted publishing domain contains the settings needed to use Rights Management Services (RMS) features in your organization. When you delete a trusted publishing domain, all existing content that's protected by the RMS templates in the trusted publishing domain becomes unreadable. Instead of deleting the trusted publishing domain, you can archive the RMS templates using the Set-RMSTemplate cmdlet. Archiving the RMS template prevents future use for encryption, but allows access to existing rights-protected content. - -If you delete the only trusted publishing domain, all RMS features are disabled in the organization. If multiple trusted publishing domains exist in your organization, you can't delete the default trusted publishing domain. You must first designate another trusted publishing domain as the default. You can change the default trusted publishing domain using the Set-RMSTrustedPublishingDomain cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RMSTrustedPublishingDomain "Contoso TPD" -``` - -This example removes the trusted publishing domain Contoso TPD from your organization. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the trusted publishing domain. You can use any value that uniquely identifies the trusted publishing domain, for example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter forces the command to execute without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/778b4b91-0079-462b-b58d-3b3507ed8f69.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-IRMConfiguration.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Set-IRMConfiguration.md deleted file mode 100644 index 27717cb5fb..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-IRMConfiguration.md +++ /dev/null @@ -1,476 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-IRMConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-IRMConfiguration cmdlet to configure Information Rights Management (IRM) features on your organization. - -Configuring and using IRM features in an on-premises Exchange organization requires Active Directory Rights Management Services (AD RMS). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-IRMConfiguration [-AutomaticServiceUpdateEnabled <$true | $false>] [-AzureRMSLicensingEnabled <$true | $false>] - [-ClientAccessServerEnabled <$true | $false>] [-Confirm] [-DecryptAttachmentForEncryptOnly <$true | $false>] - [-DecryptAttachmentFromPortal <$true | $false>] [-DomainController <Fqdn>] - [-EDiscoverySuperUserEnabled <$true | $false>] [-ExternalLicensingEnabled <$true | $false>] [-Force] - [-InternalLicensingEnabled <$true | $false>] [-JournalReportDecryptionEnabled <$true | $false>] - [-LicensingLocation <MultiValuedProperty>] [-PublishingLocation <Uri>] [-RefreshServerCertificates] - [-RMSOnlineKeySharingLocation <Uri>] [-SearchEnabled <$true | $false>] [-ServiceLocation <Uri>] - [-SimplifiedClientAccessEnabled <$true | $false>] - [-TransportDecryptionSetting <Disabled | Optional | Mandatory>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-IRMConfiguration -JournalReportDecryptionEnabled $true -``` - -This example enables journal report decryption. - -### -------------------------- Example 2 -------------------------- -``` -Set-IRMConfiguration -TransportDecryptionSetting Mandatory -``` - -This example enables transport decryption and enforces decryption. When decryption is enforced, messages that can't be decrypted are rejected, and an NDR is returned. - -### -------------------------- Example 3 -------------------------- -``` -Set-IRMConfiguration -ExternalLicensingEnabled $true -``` - -This example enables licensing for external messages. - -## PARAMETERS - -### -AutomaticServiceUpdateEnabled -This parameter is available only in the cloud-based service. - -The AutomaticServiceUpdateEnabled parameter specifies whether to automatically enable the protection features in Azure Information Protection for your cloud-based organization. Valid values are: - -- $true: Starting July 1, 2018, the protection features in Azure Information Protection will be automatically enabled in your cloud-based organization. This means you can start using the new Office 365 Message Encryption capabilities without additional set up steps. This is the default value. - -- $false: If you're using Active Directory Rights Management Services (AD RMS) in your on-premises environment, you must use this value to prevent the automatic enabling of the protection features in Azure Information Protection for your cloud-based organization. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureRMSLicensingEnabled -This parameter is available only in the cloud-based service. - -The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online organization can to connect directly to Azure Rights Management. Valid values are: - -- $true: The Exchange Online organization can connect directly to Azure Rights Management. This enables Office 365 Message Encryption. - -- $false: The Exchange Online organization can't connect directly to Azure Rights Management. Do not configure this value unless you're directed to do so by Microsoft Customer Service and Support. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAccessServerEnabled -The ClientAccessServerEnabled parameter specifies whether to enable IRM for Outlook on the web (formerly known as Outlook Web App) and Exchange ActiveSync. Valid values are: - -- $true: IRM is enabled for Outlook on the web and Exchange ActiveSync. 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://technet.microsoft.com/library/dd876891.aspx). - -- $false: IRM is disabled for Outlook on the web and Exchange ActiveSync. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -EDiscoverySuperUserEnabled -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. - -- $false: Members of the Discovery Management role group can't access IRM-protected messages in discovery mailboxes. - -For more information about In-Place eDiscovery and IRM-protected messages, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx). - -```yaml -Type: $true | $false -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 -``` - -### -DecryptAttachmentForEncryptOnly -This parameter is available only in the cloud-based service. - -The DecryptAttachmentForEncryptOnly parameter specifies whether mail recipients have unrestricted rights on the attachment or not for Encrypt-only mails sent using new Office 365 Message Encryption capabilities. Valid values are: - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecryptAttachmentFromPortal -This parameter is available only in the cloud-based service. - -The DecryptAttachmentFromPortal parameter specifies whether Office attachments are protected for recipients outside of Office 365 when Encrypt-only policy is used for sending mails using new Office 365 Message Encryption capabilities. Use this option when you don't need to retain the original protection for the attachment upon download. Valid values are: - -- $true: The recipients will have permissions to download Encrypt-only attachments without protection. - -- $false: The recipients will continue to have Encrypt-only attachments protected even after download. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalLicensingEnabled -The ExternalLicensingEnabled parameter specifies whether to enable IRM features for messages that are sent to external recipients. Valid values are: - -- $true: IRM features are enabled for external messages. This is the default value in Exchange Online. - -- $false: IRM features are disabled for external messages. This is the default value in on-premises Exchange. - -```yaml -Type: $true | $false -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 -``` - -### -Force -The Force switch specifies whether to suppress the confirmation prompt that appears when you modify the InternalLicensingEnabled parameter. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalLicensingEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -JournalReportDecryptionEnabled -The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: - -- $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see Journal report decryption (https://technet.microsoft.com/library/dd876936.aspx). - -- $false: Journal report decryption is disabled. - -```yaml -Type: $true | $false -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 -``` - -### -LicensingLocation -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishingLocation -This parameter is available only in the cloud-based service. - -The PublishingLocation parameter specifies the AD RMS publishing URL. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshServerCertificates -This parameter is available only in on-premises Exchange. - -The RefreshServerCertificates switch clears all Rights Account Certificates (RACs), Computer Licensor Certificates (CLCs), and cached AD RMS templates from all Exchange servers in the organization. You don't need to specify a value with this switch. - -Clearing RACs, CLCs, and cached templates might be required during troubleshooting or after changing keys on the AD RMS cluster in your organization. For more information about RACs and CLCs, see Understanding AD RMS Certificates (https://go.microsoft.com/fwlink/p/?linkId=197118). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RMSOnlineKeySharingLocation -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. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchEnabled -The SearchEnabled parameter specifies whether to enable searching of IRM-encrypted messages in Outlook on the web. Valid values are: - -- $true: Searching IRM-encrypted messages in Outlook on the web is enabled. This is the default value. - -- $false: Searching IRM-encrypted messages in Outlook on the web is disabled. - -```yaml -Type: $true | $false -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 -``` - -### -ServiceLocation -This parameter is available only in the cloud-based service. - -The ServiceLocation parameter specifies the AD RMS service URL. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimplifiedClientAccessEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportDecryptionSetting -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. - -```yaml -Type: Disabled | Optional | Mandatory -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5df0b56a-7bcc-4be2-b4b8-4de16720476c.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-OMEConfiguration.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Set-OMEConfiguration.md deleted file mode 100644 index 04b29afcbe..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-OMEConfiguration.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Online -title: Set-OMEConfiguration -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-OMEConfiguration - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-OMEConfiguration cmdlet to configure Microsoft Office 365 Message Encryption (OME). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-OMEConfiguration [-Identity] <OMEConfigurationIdParameter> [-BackgroundColor <String>] [-DisclaimerText <String>] - [-EmailText <String>] [-Image <Byte[]>] [-IntroductionText <String>] [-OTPEnabled <$true | $false>] - [-PortalText <String>] [-ReadButtonText <String>] [-SocialIdSignIn <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-OMEConfiguration -Identity "OME Configuration" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image (Get-Content "C:\Temp\OME Logo.gif" -Encoding byte) -``` - -This example uses the Set-OMEConfiguration cmdlet to set all the parameters. Note the use of the Get-Content command to provide the input for the Image parameter. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the OME configuration that you want to modify. The default OME configuration has the Identity value "OME Configuration". You can also use "default". - -```yaml -Type: OMEConfigurationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BackgroundColor -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. - -For the list of available hex and text values, see Background colors for Office 365 Message Encryption (https://support.office.com/article/1508cb35-c5ff-4523-b579-947b21d5515f). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisclaimerText -The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. - -To remove existing text and use the default value, use the value $null for this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailText -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. - -To remove existing text and use the default value, use the value $null for this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -The Image parameter identifies and uploads an image that will be displayed in the email message and in the Office 365 portal. - -You need to read the file to a byte-encoded object using the Get-Content cmdlet, for example, -Image (Get-Content "C:\\Temp\\OME Logo.gif" -Encoding byte) - -- Supported file formats: .png, .jpg, .bmp, or .tiff - -- Optimal size of logo file: less than 40 KB - -- Optimal dimensions of logo image: 170x70 pixels - -To remove an existing image and use the default image, use the value $null for this parameter. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntroductionText - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OTPEnabled -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. - -- $false: Recipients can't use a one-time passcode to view encrypted messages. The recipient is required to sign in using an Office 365 work or school account. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortalText -The PortalText parameter specifies the text that appears at the top of the encrypted mail viewing portal. The maximum length is 128 characters. - -To remove existing text and use the default value, use the value $null for this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadButtonText - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialIdSignIn - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3ef0aec0-ce28-411d-abe8-7236f082af1b.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-RMSTemplate.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Set-RMSTemplate.md deleted file mode 100644 index 01bac191c5..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-RMSTemplate.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-RMSTemplate -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-RMSTemplate - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-RMSTemplate cmdlet to modify the properties of an existing Rights Management Services (RMS) template in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-RMSTemplate [-Identity] <RmsTemplateIdParameter> -Type <Archived | Distributed | All> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -RMS templates exist in one or more trusted publishing domains (TPDs) that have been imported from an on-premises server running Active Directory Rights Management Services (AD RMS). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RMSTemplate "Contoso Confidential" -Type Archived -``` - -This example changes the RMS template Contoso Confidential from Distributed to Archived. This prevents future use of Contoso Confidential for encryption, but allows access to existing content that's rights-protected by Contoso Confidential. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the RMS template. You can use any value that uniquely identifies the RMS template, for example: - -- Name - -- GUID - -You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organization. - -```yaml -Type: RmsTemplateIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the type of RMS template. You can specify one of the following values: - -- Archived - -- Distributed - -- All - -The default type for imported RMS templates is Archived. - -```yaml -Type: Archived | Distributed | All -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4637f6b8-751a-4f5e-8869-428250230382.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md deleted file mode 100644 index 1950ceaede..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-RMSTrustedPublishingDomain -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-RMSTrustedPublishingDomain cmdlet to configure a trusted publishing domain (TPD) in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-RMSTrustedPublishingDomain [-Identity] <RmsTrustedPublishingDomainIdParameter> [-Confirm] [-Default] - [-DomainController <Fqdn>] [-ExtranetCertificationUrl <Uri>] [-ExtranetLicensingUrl <Uri>] - [-IntranetCertificationUrl <Uri>] [-IntranetLicensingUrl <Uri>] [-Name <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RMSTrustedPublishingDomain "Contoso TPD" -Default -ExtranetLicensingUrl https://rms.contoso.com/_wmcs/licensing -ExtranetCertificationUrl https://rms.contoso.com/_wmcs/certification/servercertification.asmx -``` - -This example makes the following changes to the existing TPD Contoso TPD: - -- Sets Contoso TPD as the default TPD for the organization. - -- Sets the external licensing URL to https://rms.contoso.com/\_wmcs/licensing. - -- Sets the external certification URL to https://rms.contoso.com/\_wmcs/certification/servercertification.asmx - -## PARAMETERS - -### -Identity -The Identity parameter specifies the TPD. You can use any value that uniquely identifies the TPD, for example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -The Default parameter specifies this is the default TPD. The default TPD displays RMS templates and provides rights protection to all new content. There can be only one default TPD in an organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtranetCertificationUrl -The ExtranetCertificationUrl parameter specifies the external certification URL of the on-premises AD RMS server that's stamped into the Rights Account Certificate (RAC). The RAC establishes a user's identity in the AD RMS system and is used to decrypt content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtranetLicensingUrl -The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetCertificationUrl -The IntranetCertificationUrl parameter specifies the internal certification URL of the on-premises AD RMS server that's stamped into the RAC. The RAC establishes a user's identity in the AD RMS system and is used to decrypt content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetLicensingUrl -The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the TPD. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89af98c7-b6cb-4aa5-8ffa-d438579b7aa2.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-SmimeConfig.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Set-SmimeConfig.md deleted file mode 100644 index b3dd8bf41d..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Set-SmimeConfig.md +++ /dev/null @@ -1,619 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SmimeConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-SmimeConfig cmdlet to modify the S/MIME configuration for Microsoft Outlook on the web. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SmimeConfig [[-Identity] <OrganizationIdParameter>] [-Confirm] - [-OWAAllowUserChoiceOfSigningCertificate <$true | $false>] [-OWAAlwaysEncrypt <$true | $false>] - [-OWAAlwaysSign <$true | $false>] [-OWABCCEncryptedEmailForking <UInt32>] - [-OWACheckCRLOnSend <$true | $false>] [-OWAClearSign <$true | $false>] - [-OWACopyRecipientHeaders <$true | $false>] [-OWACRLConnectionTimeout <UInt32>] - [-OWACRLRetrievalTimeout <UInt32>] [-OWADisableCRLCheck <$true | $false>] [-OWADLExpansionTimeout <UInt32>] - [-OWAEncryptionAlgorithms <String>] [-OWAEncryptTemporaryBuffers <$true | $false>] - [-OWAForceSMIMEClientUpgrade <$true | $false>] - [-OWAIncludeCertificateChainAndRootCertificate <$true | $false>] - [-OWAIncludeCertificateChainWithoutRootCertificate <$true | $false>] - [-OWAIncludeSMIMECapabilitiesInMessage <$true | $false>] [-OWAOnlyUseSmartCard <$true | $false>] - [-OWASenderCertificateAttributesToDisplay <String>] [-OWASignedEmailCertificateInclusion <$true | $false>] - [-OWASigningAlgorithms <String>] [-OWATripleWrapSignedEncryptedMail <$true | $false>] - [-OWAUseKeyIdentifier <$true | $false>] [-OWAUseSecondaryProxiesWhenFindingCertificates <$true | $false>] - [-SMIMECertificateIssuingCA <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SmimeConfig -OWAAllowUserChoiceOfSigningCertificate $true -OWACRLRetrievalTimeout 10000 -OWAEncryptionAlgorithms 6602:128 -``` - -This example sets the S/MIME configuration to allow users the choice of signing the message, limits the Certificate Revocation List (CRL) retrieval time-out to 10 seconds, and specifies the 128 bit RC2 encryption algorithm. - -## PARAMETERS - -### -Confirm -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OWAAllowUserChoiceOfSigningCertificate -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAAlwaysEncrypt -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAAlwaysSign -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWABCCEncryptedEmailForking -The OWABCCEncryptedEmailForking parameter specifies how Bcc messages are encrypted in Outlook on the web. This parameter uses the following values: - -- 0 = One encrypted message per Bcc recipient. - -- 1 = One single encrypted message for all Bcc recipients. - -- 2 = One encrypted message without Bcc forking. - -The default value is 0. - -This setting affects the security and privacy of Outlook on the web. Consult your organization's security policy before you change this setting. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWACheckCRLOnSend -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 input for this parameter is $true or $false. The default value is $false. - -When this parameter is set to $false and the CRL distribution point is inaccessible, Outlook on the web allows signed or encrypted messages to be sent. When this parameter is set to $true, Outlook on the web displays a warning dialog box and prevents signed or encrypted messages from being sent. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAClearSign -The OWAClearSign parameter specifies how email messages are signed in Outlook on the web. - -Valid input for this parameter is $true or $false. The default is $true. - -When this parameter is set to $true, digitally signed messages are clear-signed. When this parameter is set to $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWACopyRecipientHeaders -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWACRLConnectionTimeout -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. - -Valid input for this parameter is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds). - -When multiple CRLs in a certificate chain must be retrieved, the time limit that's specified by this parameter applies to each connection. For example, if a certificate requires the retrieval of three CRLs, and this parameter is set to 60000 (60 seconds), each individual CRL retrieval operation has a time limit of 60 seconds. If any one of the CRLs isn't retrieved before the time limit expires, the entire operation fails. The total time limit for all the retrievals is controlled by the OWACRLRetrievalTimeout parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWACRLRetrievalTimeout -The OWACRLRetrievalTimeout parameter specifies the time in milliseconds that Outlook on the web waits to retrieve all CRLs when validating a certificate. - -Valid input for this parameter is an integer between 0 and 4294967295 (UInt32). The default value is 10000 (10 seconds). - -If all the required CRLs are not retrieved before the time limit expires, the operation fails. Suppose the retrieval of three CRLs is required, the OWACRLConnectionTimeout value is set to 60000 (60 seconds), and the OWACRLRetrievalTimeout is set to 120000 (2 minutes). In this example, if any individual CRL retrieval takes more than 60 seconds, the operation fails. Also, if all the CRL retrievals together take more than 120 seconds, the operation fails. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWADisableCRLCheck -The OWADisableCRLCheck parameter enables or disables CRL checking in Outlook on the web. - -Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter disables CRL checks when validating certificates. Disabling CRL checking can decrease the time that's required to validate the signatures of signed email messages, but it also validates email messages signed with revoked certificates. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWADLExpansionTimeout -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. - -Valid input for this parameter 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. - -When sending an encrypted message to a distribution group, Exchange expands the distribution group to retrieve the encryption certificate of each recipient. While the distribution group is being expanded, the sender receives no response from Outlook on the web. - -The timeout value that's specified by this parameter is applied to the expansion of each distribution group. For example, if an encrypted message is sent to three distribution group, and the value of this parameter is 60000 (60 seconds), the entire operation can take no more than 180 seconds. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAEncryptionAlgorithms -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) - -- 6602: RC2. Supported key lengths are 40, 56, 64, and 128. RC2 is the only supported algorithm that offers multiple key lengths. - -- 6603: 3DES (168-bit) - -- 660E: AES128 - -- 660F: AES192 - -- 6610: AES256 (This is the 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,\<CustomOID\>. - -This parameter uses the sytax <AlgorithmID> or RC2:<KeyLength> or <AlgorithmID>,<CustomOID>. 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. - -If the parameter is not specified or is not formatted correctly, Outlook on the web uses 6610 (AES256). If the encryption algorithm or minimum key length is not available on a client, Outlook on the web does not allow encryption. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAEncryptTemporaryBuffers -The OWAEncryptTemporaryBuffers parameter specifies whether the Outlook on the web client-side temporary message storage buffers are encrypted. - -Valid input for this parameter is $true or $false. The default value is $true. - -By default, all client-side temporary buffers that store message data are encrypted using an ephemeral key and the 3DES algorithm. Setting this parameter to $false disables temporary buffer encryption. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAForceSMIMEClientUpgrade -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. - -Valid input for this parameter is $true or $false. The default is $true. - -If the parameter is set to $true, users need to download and install the new control before they can use S/MIME. If this parameter is set to $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAIncludeCertificateChainAndRootCertificate -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAIncludeCertificateChainWithoutRootCertificate -The OWAIncludeCertificateChainWithoutRootCertificate parameter specifies whether the certificate chains of the signing or encryption certificates are included in messages in Outlook on the web. - -Valid input for this parameter is $true or $false. The default is $false. - -By default, Outlook on the web includes only the signing and encrypting certificates, not their corresponding certificate chains. When this parameter is set to $true, signed or encrypted messages include the full certificate chain, but not the root certificate. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAIncludeSMIMECapabilitiesInMessage -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAOnlyUseSmartCard -The OWAOnlyUseSmartCard parameter specifies whether smartcard-based certificates are required for Outlook on the web message signing and decryption. - -Valid input for this parameter is $true or $false. The default is $false - -When this parameter is set to $true, the use of smartcard-based certificates for signing and decryption is required when you use Outlook on the web and the S/MIME control. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWASenderCertificateAttributesToDisplay -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWASignedEmailCertificateInclusion -The OWASignedEmailCertificateInclusion parameter specifies whether the sender's encryption certificate is excluded from a signed email message in Outlook on the web. - -Valid input for this parameter is $true or $false. The default is $true. - -By default, Outlook on the web and the S/MIME control include both signing and encrypting certificates with signed email messages. When this parameter is set to $false, 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWASigningAlgorithms -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) - -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,\<CustomOID\>. - -This parameter uses the sytax <AlgorithmID> or <AlgorithmID>:<KeyLength> or <AlgorithmID>,<CustomOID>. You can specify multiple values separated by semicolons (;). - -For example, to set the signing algorithms to CALG\_SHA\_512, SHA1, and CALG\_MD5, use the value 800E;8004;8003. - -If this parameter is not specified or is not formatted correctly, Outlook on the web defaults to 8004 (SHA1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWATripleWrapSignedEncryptedMail -The OWATripleWrapSignedEncryptedMail parameter specifies whether signed and encrypted email messages in Outlook on the web are triple-wrapped. - -Valid input for this parameter is $true or $false. The default is $false. - -A triple-wrapped message is a signed message that is encrypted, and then the encrypted message is signed (signed-encrypted-signed). When this parameter is set to $false, the signed message is encrypted only (there is no additional signing of the encrypted message). Triple-wrapped messages offer the highest level of security for messages under the S/MIME standard, but are larger in size. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAUseKeyIdentifier -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. - -By default, Outlook on the web encodes the asymmetrically encrypted token (sometimes called a lockbox) that's required to decrypt the rest of the message by indicating the issuer and serial number of each recipient's certificate. The issuer and serial number can then be used to locate the certificate and private key for decrypting the message. - -This parameter causes the use of a certificate's key identifier when encoding the asymmetrically encrypted token. Because a key pair can be reused in new certificates, using the key identifier for encrypted email messages means that users need to keep only the most recent certificate and associated private key, rather than all old certificates. Because some email clients do not support finding certificates with a key identifier, Outlook on the web uses the issuer and serial number of each recipient's certificate by default. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OWAUseSecondaryProxiesWhenFindingCertificates -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SMIMECertificateIssuingCA -The SMIMECertificateIssuingCA parameter specifies the serialized certificate store (SST) that contains the Certificate Authority (CA) signing and intermediate certificate information. - -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For example: -SMIMECertificateIssuingCA $\(\[byte\[\]\]\(Get-Content -Encoding byte -Path "C:\\Temp\\CACertificateSerializedStore.sst" -ReadCount 0\) - -Each certificate is checked, and if any certificates are expired, the operation will fail. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/de357ce0-8143-4c36-8032-026292fc63f0.aspx) diff --git a/exchange/exchange-ps/exchange/encryption-and-certificates/Test-IRMConfiguration.md b/exchange/exchange-ps/exchange/encryption-and-certificates/Test-IRMConfiguration.md deleted file mode 100644 index f50e3de149..0000000000 --- a/exchange/exchange-ps/exchange/encryption-and-certificates/Test-IRMConfiguration.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-IRMConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Test-IRMConfiguration cmdlet to test Information Rights Management (IRM) configuration and functionality. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-IRMConfiguration [[-Identity] <OrganizationIdParameter>] -Sender <SmtpAddress> [-Confirm] - [-DomainController <Fqdn>] [-Recipient <SmtpAddress[]>] [-WhatIf] [-RMSOnline] - [-RMSOnlineAuthCertThumbprintOverride <String>] [-RMSOnlineOrgOverride <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-IRMConfiguration cmdlet performs a series of steps to test IRM configuration and functionality, including availability of an Active Directory Rights Management Services (AD RMS) server, prelicensing and journal report decryption. In Exchange Online organizations, it checks connectivity to RMS Online and obtains and validates the organization's Trusted Publishing Domain (TPD). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-IRMConfiguration -Sender adams@contoso.com -``` - -This example tests the IRM configuration for messages sent from the sender adams@contoso.com. - -## PARAMETERS - -### -Sender -The Sender parameter specifies the SMTP address of the sender to be tested. The cmdlet tests prelicensing and journal report decryption for the sender. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -This parameter is available only in on-premises Exchange. - -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Recipient -The Recipient parameter specifies the SMTP address of one or more recipients. The cmdlet tests prelicensing for the specified recipients. You can specify multiple recipient addresses separated by commas. - -If no recipient is specified, the sender address is used as the recipient. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -RMSOnline -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RMSOnlineAuthCertThumbprintOverride -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RMSOnlineOrgOverride -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a730e7ff-a67f-4360-b5ff-70d171bb5e1d.aspx) diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md new file mode 100644 index 0000000000..8ead57cb12 --- /dev/null +++ b/exchange/exchange-ps/exchange/exchange.md @@ -0,0 +1,2854 @@ +--- +Module Name: Exchange PowerShell +Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +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 Server PowerShell (Exchange Management Shell)](https://learn.microsoft.com/powershell/exchange/exchange-management-shell) +- [Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell) +- [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell) +- [Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-online-protection-powershell) + +> [!NOTE] +> For Exchange Online, Security & Compliance, and Exchange Online Protection, the module from the PowerShell Gallery that you use to connect is [ExchangeOnlineManagement](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/). For more information, see [About the Exchange Online PowerShell module](../../docs-conceptual/exchange-online-powershell-v2.md). +> +> For Exchange Server, there is no Microsoft-provided module in the PowerShell Gallery. Instead, to use PowerShell in Exchange, you have the following options: +> +> - Use the Exchange Management Shell on an Exchange server or that you've installed locally on your own computer using a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](../../docs-conceptual/open-the-exchange-management-shell.md). +> - Use remote PowerShell from a Windows PowerShell session. For more information, see [Connect to Exchange servers using remote PowerShell](../../docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md). + +## active-directory Cmdlets +### [Add-ADPermission](Add-ADPermission.md) + +### [Dump-ProvisioningCache](Dump-ProvisioningCache.md) + +### [Get-ADPermission](Get-ADPermission.md) + +### [Get-ADServerSettings](Get-ADServerSettings.md) + +### [Get-ADSite](Get-ADSite.md) + +### [Get-AdSiteLink](Get-AdSiteLink.md) + +### [Get-DomainController](Get-DomainController.md) + +### [Get-OrganizationalUnit](Get-OrganizationalUnit.md) + +### [Get-Trust](Get-Trust.md) + +### [Get-UserPrincipalNamesSuffix](Get-UserPrincipalNamesSuffix.md) + +### [Remove-ADPermission](Remove-ADPermission.md) + +### [Reset-ProvisioningCache](Reset-ProvisioningCache.md) + +### [Set-ADServerSettings](Set-ADServerSettings.md) + +### [Set-ADSite](Set-ADSite.md) + +### [Set-AdSiteLink](Set-AdSiteLink.md) + +## defender-for-office-365 Cmdlets +### [Disable-AntiPhishRule](Disable-AntiPhishRule.md) + +### [Disable-ATPProtectionPolicyRule](Disable-ATPProtectionPolicyRule.md) + +### [Disable-SafeAttachmentRule](Disable-SafeAttachmentRule.md) + +### [Disable-SafeLinksRule](Disable-SafeLinksRule.md) + +### [Enable-AntiPhishRule](Enable-AntiPhishRule.md) + +### [Enable-ATPProtectionPolicyRule](Enable-ATPProtectionPolicyRule.md) + +### [Enable-SafeAttachmentRule](Enable-SafeAttachmentRule.md) + +### [Enable-SafeLinksRule](Enable-SafeLinksRule.md) + +### [Get-AntiPhishPolicy](Get-AntiPhishPolicy.md) + +### [Get-AntiPhishRule](Get-AntiPhishRule.md) + +### [Get-ATPBuiltInProtectionRule](Get-ATPBuiltInProtectionRule.md) + +### [Get-AtpPolicyForO365](Get-AtpPolicyForO365.md) + +### [Get-ATPProtectionPolicyRule](Get-ATPProtectionPolicyRule.md) + +### [Get-ATPTotalTrafficReport](Get-ATPTotalTrafficReport.md) + +### [Get-ContentMalwareMdoAggregateReport](Get-ContentMalwareMdoAggregateReport.md) + +### [Get-ContentMalwareMdoDetailReport](Get-ContentMalwareMdoDetailReport.md) + +### [Get-EmailTenantSettings](Get-EmailTenantSettings.md) + +### [Get-MailDetailATPReport](Get-MailDetailATPReport.md) + +### [Get-MailTrafficATPReport](Get-MailTrafficATPReport.md) + +### [Get-SafeAttachmentPolicy](Get-SafeAttachmentPolicy.md) + +### [Get-SafeAttachmentRule](Get-SafeAttachmentRule.md) + +### [Get-SafeLinksAggregateReport](Get-SafeLinksAggregateReport.md) + +### [Get-SafeLinksDetailReport](Get-SafeLinksDetailReport.md) + +### [Get-SafeLinksPolicy](Get-SafeLinksPolicy.md) + +### [Get-SafeLinksRule](Get-SafeLinksRule.md) + +### [Get-SpoofIntelligenceInsight](Get-SpoofIntelligenceInsight.md) + +### [Get-SpoofMailReport](Get-SpoofMailReport.md) + +### [New-AntiPhishPolicy](New-AntiPhishPolicy.md) + +### [New-AntiPhishRule](New-AntiPhishRule.md) + +### [New-ATPBuiltInProtectionRule](New-ATPBuiltInProtectionRule.md) + +### [New-ATPProtectionPolicyRule](New-ATPProtectionPolicyRule.md) + +### [New-SafeAttachmentPolicy](New-SafeAttachmentPolicy.md) + +### [New-SafeAttachmentRule](New-SafeAttachmentRule.md) + +### [New-SafeLinksPolicy](New-SafeLinksPolicy.md) + +### [New-SafeLinksRule](New-SafeLinksRule.md) + +### [Remove-AntiPhishPolicy](Remove-AntiPhishPolicy.md) + +### [Remove-AntiPhishRule](Remove-AntiPhishRule.md) + +### [Remove-ATPProtectionPolicyRule](Remove-ATPProtectionPolicyRule.md) + +### [Remove-SafeAttachmentPolicy](Remove-SafeAttachmentPolicy.md) + +### [Remove-SafeAttachmentRule](Remove-SafeAttachmentRule.md) + +### [Remove-SafeLinksPolicy](Remove-SafeLinksPolicy.md) + +### [Remove-SafeLinksRule](Remove-SafeLinksRule.md) + +### [Set-AntiPhishPolicy](Set-AntiPhishPolicy.md) + +### [Set-AntiPhishRule](Set-AntiPhishRule.md) + +### [Set-ATPBuiltInProtectionRule](Set-ATPBuiltInProtectionRule.md) + +### [Set-AtpPolicyForO365](Set-AtpPolicyForO365.md) + +### [Set-ATPProtectionPolicyRule](Set-ATPProtectionPolicyRule.md) + +### [Set-EmailTenantSettings](Set-EmailTenantSettings.md) + +### [Set-SafeAttachmentPolicy](Set-SafeAttachmentPolicy.md) + +### [Set-SafeAttachmentRule](Set-SafeAttachmentRule.md) + +### [Set-SafeLinksPolicy](Set-SafeLinksPolicy.md) + +### [Set-SafeLinksRule](Set-SafeLinksRule.md) + +## antispam-antimalware Cmdlets +### [Add-AttachmentFilterEntry](Add-AttachmentFilterEntry.md) + +### [Add-ContentFilterPhrase](Add-ContentFilterPhrase.md) + +### [Add-IPAllowListEntry](Add-IPAllowListEntry.md) + +### [Add-IPAllowListProvider](Add-IPAllowListProvider.md) + +### [Add-IPBlockListEntry](Add-IPBlockListEntry.md) + +### [Add-IPBlockListProvider](Add-IPBlockListProvider.md) + +### [Delete-QuarantineMessage](Delete-QuarantineMessage.md) + +### [Disable-EOPProtectionPolicyRule](Disable-EOPProtectionPolicyRule.md) + +### [Disable-HostedContentFilterRule](Disable-HostedContentFilterRule.md) + +### [Disable-HostedOutboundSpamFilterRule](Disable-HostedOutboundSpamFilterRule.md) + +### [Disable-MalwareFilterRule](Disable-MalwareFilterRule.md) + +### [Disable-ReportSubmissionRule](Disable-ReportSubmissionRule.md) + +### [Enable-AntispamUpdates](Enable-AntispamUpdates.md) + +### [Enable-EOPProtectionPolicyRule](Enable-EOPProtectionPolicyRule.md) + +### [Enable-HostedContentFilterRule](Enable-HostedContentFilterRule.md) + +### [Enable-HostedOutboundSpamFilterRule](Enable-HostedOutboundSpamFilterRule.md) + +### [Enable-MalwareFilterRule](Enable-MalwareFilterRule.md) + +### [Export-QuarantineMessage](Export-QuarantineMessage.md) + +### [Enable-ReportSubmissionRule](Enable-ReportSubmissionRule.md) + +### [Get-AgentLog](Get-AgentLog.md) + +### [Get-AggregateZapReport](Get-AggregateZapReport.md) + +### [Get-ArcConfig](Get-ArcConfig.md) + +### [Get-AttachmentFilterEntry](Get-AttachmentFilterEntry.md) + +### [Get-AttachmentFilterListConfig](Get-AttachmentFilterListConfig.md) + +### [Get-BlockedConnector](Get-BlockedConnector.md) + +### [Get-BlockedSenderAddress](Get-BlockedSenderAddress.md) + +### [Get-ConfigAnalyzerPolicyRecommendation](Get-ConfigAnalyzerPolicyRecommendation.md) + +### [Get-ContentFilterConfig](Get-ContentFilterConfig.md) + +### [Get-ContentFilterPhrase](Get-ContentFilterPhrase.md) + +### [Get-DetailZapReport](Get-DetailZapReport.md) + +### [Get-DkimSigningConfig](Get-DkimSigningConfig.md) + +### [Get-EOPProtectionPolicyRule](Get-EOPProtectionPolicyRule.md) + +### [Get-ExoPhishSimOverrideRule](Get-ExoPhishSimOverrideRule.md) + +### [Get-ExoSecOpsOverrideRule](Get-ExoSecOpsOverrideRule.md) + +### [Get-HostedConnectionFilterPolicy](Get-HostedConnectionFilterPolicy.md) + +### [Get-HostedContentFilterPolicy](Get-HostedContentFilterPolicy.md) + +### [Get-HostedContentFilterRule](Get-HostedContentFilterRule.md) + +### [Get-HostedOutboundSpamFilterPolicy](Get-HostedOutboundSpamFilterPolicy.md) + +### [Get-HostedOutboundSpamFilterRule](Get-HostedOutboundSpamFilterRule.md) + +### [Get-IPAllowListConfig](Get-IPAllowListConfig.md) + +### [Get-IPAllowListEntry](Get-IPAllowListEntry.md) + +### [Get-IPAllowListProvider](Get-IPAllowListProvider.md) + +### [Get-IPAllowListProvidersConfig](Get-IPAllowListProvidersConfig.md) + +### [Get-IPBlockListConfig](Get-IPBlockListConfig.md) + +### [Get-IPBlockListEntry](Get-IPBlockListEntry.md) + +### [Get-IPBlockListProvider](Get-IPBlockListProvider.md) + +### [Get-IPBlockListProvidersConfig](Get-IPBlockListProvidersConfig.md) + +### [Get-MailboxJunkEmailConfiguration](Get-MailboxJunkEmailConfiguration.md) + +### [Get-MalwareFilteringServer](Get-MalwareFilteringServer.md) + +### [Get-MalwareFilterPolicy](Get-MalwareFilterPolicy.md) + +### [Get-MalwareFilterRule](Get-MalwareFilterRule.md) + +### [Get-PhishSimOverridePolicy](Get-PhishSimOverridePolicy.md) + +### [Get-QuarantineMessage](Get-QuarantineMessage.md) + +### [Get-QuarantineMessageHeader](Get-QuarantineMessageHeader.md) + +### [Get-QuarantinePolicy](Get-QuarantinePolicy.md) + +### [Get-RecipientFilterConfig](Get-RecipientFilterConfig.md) + +### [Get-ReportSubmissionPolicy](Get-ReportSubmissionPolicy.md) + +### [Get-ReportSubmissionRule](Get-ReportSubmissionRule.md) + +### [Get-SecOpsOverridePolicy](Get-SecOpsOverridePolicy.md) + +### [Get-SenderFilterConfig](Get-SenderFilterConfig.md) + +### [Get-SenderIdConfig](Get-SenderIdConfig.md) + +### [Get-SenderReputationConfig](Get-SenderReputationConfig.md) + +### [Get-TeamsProtectionPolicy](Get-TeamsProtectionPolicy.md) + +### [Get-TeamsProtectionPolicyRule](Get-TeamsProtectionPolicyRule.md) + +### [Get-TenantAllowBlockListItems](Get-TenantAllowBlockListItems.md) + +### [Get-TenantAllowBlockListSpoofItems](Get-TenantAllowBlockListSpoofItems.md) + +### [New-DkimSigningConfig](New-DkimSigningConfig.md) + +### [New-EOPProtectionPolicyRule](New-EOPProtectionPolicyRule.md) + +### [New-ExoPhishSimOverrideRule](New-ExoPhishSimOverrideRule.md) + +### [New-ExoSecOpsOverrideRule](New-ExoSecOpsOverrideRule.md) + +### [New-HostedContentFilterPolicy](New-HostedContentFilterPolicy.md) + +### [New-HostedContentFilterRule](New-HostedContentFilterRule.md) + +### [New-HostedOutboundSpamFilterPolicy](New-HostedOutboundSpamFilterPolicy.md) + +### [New-HostedOutboundSpamFilterRule](New-HostedOutboundSpamFilterRule.md) + +### [New-MalwareFilterPolicy](New-MalwareFilterPolicy.md) + +### [New-MalwareFilterRule](New-MalwareFilterRule.md) + +### [New-PhishSimOverridePolicy](New-PhishSimOverridePolicy.md) + +### [New-QuarantinePermissions](New-QuarantinePermissions.md) + +### [New-QuarantinePolicy](New-QuarantinePolicy.md) + +### [New-ReportSubmissionPolicy](New-ReportSubmissionPolicy.md) + +### [New-ReportSubmissionRule](New-ReportSubmissionRule.md) + +### [New-SecOpsOverridePolicy](New-SecOpsOverridePolicy.md) + +### [New-TeamsProtectionPolicy](New-TeamsProtectionPolicy.md) + +### [New-TeamsProtectionPolicyRule](New-TeamsProtectionPolicyRule.md) + +### [New-TenantAllowBlockListItems](New-TenantAllowBlockListItems.md) + +### [New-TenantAllowBlockListSpoofItems](New-TenantAllowBlockListSpoofItems.md) + +### [Preview-QuarantineMessage](Preview-QuarantineMessage.md) + +### [Release-QuarantineMessage](Release-QuarantineMessage.md) + +### [Remove-AttachmentFilterEntry](Remove-AttachmentFilterEntry.md) + +### [Remove-BlockedConnector](Remove-BlockedConnector.md) + +### [Remove-BlockedSenderAddress](Remove-BlockedSenderAddress.md) + +### [Remove-ContentFilterPhrase](Remove-ContentFilterPhrase.md) + +### [Remove-EOPProtectionPolicyRule](Remove-EOPProtectionPolicyRule.md) + +### [Remove-ExoPhishSimOverrideRule](Remove-ExoPhishSimOverrideRule.md) + +### [Remove-ExoSecOpsOverrideRule](Remove-ExoSecOpsOverrideRule.md) + +### [Remove-HostedContentFilterPolicy](Remove-HostedContentFilterPolicy.md) + +### [Remove-HostedContentFilterRule](Remove-HostedContentFilterRule.md) + +### [Remove-HostedOutboundSpamFilterPolicy](Remove-HostedOutboundSpamFilterPolicy.md) + +### [Remove-HostedOutboundSpamFilterRule](Remove-HostedOutboundSpamFilterRule.md) + +### [Remove-IPAllowListEntry](Remove-IPAllowListEntry.md) + +### [Remove-IPAllowListProvider](Remove-IPAllowListProvider.md) + +### [Remove-IPBlockListEntry](Remove-IPBlockListEntry.md) + +### [Remove-IPBlockListProvider](Remove-IPBlockListProvider.md) + +### [Remove-MalwareFilterPolicy](Remove-MalwareFilterPolicy.md) + +### [Remove-MalwareFilterRule](Remove-MalwareFilterRule.md) + +### [Remove-PhishSimOverridePolicy](Remove-PhishSimOverridePolicy.md) + +### [Remove-QuarantinePolicy](Remove-QuarantinePolicy.md) + +### [Remove-ReportSubmissionPolicy](Remove-ReportSubmissionPolicy.md) + +### [Remove-ReportSubmissionRule](Remove-ReportSubmissionRule.md) + +### [Remove-SecOpsOverridePolicy](Remove-SecOpsOverridePolicy.md) + +### [Remove-TenantAllowBlockListItems](Remove-TenantAllowBlockListItems.md) + +### [Remove-TenantAllowBlockListSpoofItems](Remove-TenantAllowBlockListSpoofItems.md) + +### [Rotate-DkimSigningConfig](Rotate-DkimSigningConfig.md) + +### [Set-ArcConfig](Set-ArcConfig.md) + +### [Set-AttachmentFilterListConfig](Set-AttachmentFilterListConfig.md) + +### [Set-ContentFilterConfig](Set-ContentFilterConfig.md) + +### [Set-DkimSigningConfig](Set-DkimSigningConfig.md) + +### [Set-EOPProtectionPolicyRule](Set-EOPProtectionPolicyRule.md) + +### [Set-ExoPhishSimOverrideRule](Set-ExoPhishSimOverrideRule.md) + +### [Set-ExoSecOpsOverrideRule](Remove-ExoSecOpsOverrideRule.md) + +### [Set-HostedConnectionFilterPolicy](Set-HostedConnectionFilterPolicy.md) + +### [Set-HostedContentFilterPolicy](Set-HostedContentFilterPolicy.md) + +### [Set-HostedContentFilterRule](Set-HostedContentFilterRule.md) + +### [Set-HostedOutboundSpamFilterPolicy](Set-HostedOutboundSpamFilterPolicy.md) + +### [Set-HostedOutboundSpamFilterRule](Set-HostedOutboundSpamFilterRule.md) + +### [Set-IPAllowListConfig](Set-IPAllowListConfig.md) + +### [Set-IPAllowListProvider](Set-IPAllowListProvider.md) + +### [Set-IPAllowListProvidersConfig](Set-IPAllowListProvidersConfig.md) + +### [Set-IPBlockListConfig](Set-IPBlockListConfig.md) + +### [Set-IPBlockListProvider](Set-IPBlockListProvider.md) + +### [Set-IPBlockListProvidersConfig](Set-IPBlockListProvidersConfig.md) + +### [Set-MailboxJunkEmailConfiguration](Set-MailboxJunkEmailConfiguration.md) + +### [Set-MalwareFilteringServer](Set-MalwareFilteringServer.md) + +### [Set-MalwareFilterPolicy](Set-MalwareFilterPolicy.md) + +### [Set-MalwareFilterRule](Set-MalwareFilterRule.md) + +### [Set-PhishSimOverridePolicy](Set-PhishSimOverridePolicy.md) + +### [Set-QuarantinePermissions](Set-QuarantinePermissions.md) + +### [Set-QuarantinePolicy](Set-QuarantinePolicy.md) + +### [Set-RecipientFilterConfig](Set-RecipientFilterConfig.md) + +### [Set-ReportSubmissionPolicy](Set-ReportSubmissionPolicy.md) + +### [Set-ReportSubmissionRule](Set-ReportSubmissionRule.md) + +### [Set-SecOpsOverridePolicy](Set-SecOpsOverridePolicy.md) + +### [Set-SenderFilterConfig](Set-SenderFilterConfig.md) + +### [Set-SenderIdConfig](Set-SenderIdConfig.md) + +### [Set-SenderReputationConfig](Set-SenderReputationConfig.md) + +### [Set-TeamsProtectionPolicy](Set-TeamsProtectionPolicy.md) + +### [Set-TeamsProtectionPolicyRule](Set-TeamsProtectionPolicyRule.md) + +### [Set-TenantAllowBlockListItems](Set-TenantAllowBlockListItems.md) + +### [Set-TenantAllowBlockListSpoofItems](Set-TenantAllowBlockListSpoofItems.md) + +### [Test-IPAllowListProvider](Test-IPAllowListProvider.md) + +### [Test-IPBlockListProvider](Test-IPBlockListProvider.md) + +### [Test-SenderId](Test-SenderId.md) + +### [Update-SafeList](Update-SafeList.md) + +## client-access Cmdlets +### [Clear-TextMessagingAccount](Clear-TextMessagingAccount.md) + +### [Compare-TextMessagingVerificationCode](Compare-TextMessagingVerificationCode.md) + +### [Disable-PushNotificationProxy](Disable-PushNotificationProxy.md) + +### [Enable-PushNotificationProxy](Enable-PushNotificationProxy.md) + +### [Export-AutoDiscoverConfig](Export-AutoDiscoverConfig.md) + +### [Get-CASMailbox](Get-CASMailbox.md) + +### [Get-CASMailboxPlan](Get-CASMailboxPlan.md) + +### [Get-ClientAccessRule](Get-ClientAccessRule.md) + +### [Get-ImapSettings](Get-ImapSettings.md) + +### [Get-MailboxCalendarConfiguration](Get-MailboxCalendarConfiguration.md) + +### [Get-MailboxMessageConfiguration](Get-MailboxMessageConfiguration.md) + +### [Get-MailboxRegionalConfiguration](Get-MailboxRegionalConfiguration.md) + +### [Get-MailboxSpellingConfiguration](Get-MailboxSpellingConfiguration.md) + +### [Get-OutlookProvider](Get-OutlookProvider.md) + +### [Get-OwaMailboxPolicy](Get-OwaMailboxPolicy.md) + +### [Get-PopSettings](Get-PopSettings.md) + +### [Get-TextMessagingAccount](Get-TextMessagingAccount.md) + +### [New-ClientAccessRule](New-ClientAccessRule.md) + +### [New-OutlookProvider](New-OutlookProvider.md) + +### [New-OwaMailboxPolicy](New-OwaMailboxPolicy.md) + +### [Remove-ClientAccessRule](Remove-ClientAccessRule.md) + +### [Remove-OutlookProvider](Remove-OutlookProvider.md) + +### [Remove-OwaMailboxPolicy](Remove-OwaMailboxPolicy.md) + +### [Send-TextMessagingVerificationCode](Send-TextMessagingVerificationCode.md) + +### [Set-CASMailbox](Set-CASMailbox.md) + +### [Set-CASMailboxPlan](Set-CASMailboxPlan.md) + +### [Set-ClientAccessRule](Set-ClientAccessRule.md) + +### [Set-ImapSettings](Set-ImapSettings.md) + +### [Set-MailboxCalendarConfiguration](Set-MailboxCalendarConfiguration.md) + +### [Set-MailboxMessageConfiguration](Set-MailboxMessageConfiguration.md) + +### [Set-MailboxRegionalConfiguration](Set-MailboxRegionalConfiguration.md) + +### [Set-MailboxSpellingConfiguration](Set-MailboxSpellingConfiguration.md) + +### [Set-OutlookProvider](Set-OutlookProvider.md) + +### [Set-OwaMailboxPolicy](Set-OwaMailboxPolicy.md) + +### [Set-PopSettings](Set-PopSettings.md) + +### [Set-TextMessagingAccount](Set-TextMessagingAccount.md) + +### [Test-CalendarConnectivity](Test-CalendarConnectivity.md) + +### [Test-ClientAccessRule](Test-ClientAccessRule.md) + +### [Test-EcpConnectivity](Test-EcpConnectivity.md) + +### [Test-ImapConnectivity](Test-ImapConnectivity.md) + +### [Test-OutlookConnectivity](Test-OutlookConnectivity.md) + +### [Test-OutlookWebServices](Test-OutlookWebServices.md) + +### [Test-OwaConnectivity](Test-OwaConnectivity.md) + +### [Test-PopConnectivity](Test-PopConnectivity.md) + +### [Test-PowerShellConnectivity](Test-PowerShellConnectivity.md) + +### [Test-WebServicesConnectivity](Test-WebServicesConnectivity.md) + +## client-access-servers Cmdlets +### [Disable-OutlookAnywhere](Disable-OutlookAnywhere.md) + +### [Enable-OutlookAnywhere](Enable-OutlookAnywhere.md) + +### [Get-ActiveSyncVirtualDirectory](Get-ActiveSyncVirtualDirectory.md) + +### [Get-AuthRedirect](Get-AuthRedirect.md) + +### [Get-AutodiscoverVirtualDirectory](Get-AutodiscoverVirtualDirectory.md) + +### [Get-ClientAccessArray](Get-ClientAccessArray.md) + +### [Get-ClientAccessServer](Get-ClientAccessServer.md) + +### [Get-ClientAccessService](Get-ClientAccessService.md) + +### [Get-EcpVirtualDirectory](Get-EcpVirtualDirectory.md) + +### [Get-MapiVirtualDirectory](Get-MapiVirtualDirectory.md) + +### [Get-OutlookAnywhere](Get-OutlookAnywhere.md) + +### [Get-OwaVirtualDirectory](Get-OwaVirtualDirectory.md) + +### [Get-PowerShellVirtualDirectory](Get-PowerShellVirtualDirectory.md) + +### [Get-RpcClientAccess](Get-RpcClientAccess.md) + +### [Get-WebServicesVirtualDirectory](Get-WebServicesVirtualDirectory.md) + +### [New-ActiveSyncVirtualDirectory](New-ActiveSyncVirtualDirectory.md) + +### [New-AuthRedirect](New-AuthRedirect.md) + +### [New-AutodiscoverVirtualDirectory](New-AutodiscoverVirtualDirectory.md) + +### [New-ClientAccessArray](New-ClientAccessArray.md) + +### [New-EcpVirtualDirectory](New-EcpVirtualDirectory.md) + +### [New-MapiVirtualDirectory](New-MapiVirtualDirectory.md) + +### [New-OwaVirtualDirectory](New-OwaVirtualDirectory.md) + +### [New-PowerShellVirtualDirectory](New-PowerShellVirtualDirectory.md) + +### [New-RpcClientAccess](New-RpcClientAccess.md) + +### [New-WebServicesVirtualDirectory](New-WebServicesVirtualDirectory.md) + +### [Remove-ActiveSyncVirtualDirectory](Remove-ActiveSyncVirtualDirectory.md) + +### [Remove-AuthRedirect](Remove-AuthRedirect.md) + +### [Remove-AutodiscoverVirtualDirectory](Remove-AutodiscoverVirtualDirectory.md) + +### [Remove-ClientAccessArray](Remove-ClientAccessArray.md) + +### [Remove-EcpVirtualDirectory](Remove-EcpVirtualDirectory.md) + +### [Remove-MapiVirtualDirectory](Remove-MapiVirtualDirectory.md) + +### [Remove-OwaVirtualDirectory](Remove-OwaVirtualDirectory.md) + +### [Remove-PowerShellVirtualDirectory](Remove-PowerShellVirtualDirectory.md) + +### [Remove-RpcClientAccess](Remove-RpcClientAccess.md) + +### [Remove-WebServicesVirtualDirectory](Remove-WebServicesVirtualDirectory.md) + +### [Set-ActiveSyncVirtualDirectory](Set-ActiveSyncVirtualDirectory.md) + +### [Set-AuthRedirect](Set-AuthRedirect.md) + +### [Set-AutodiscoverVirtualDirectory](Set-AutodiscoverVirtualDirectory.md) + +### [Set-ClientAccessArray](Set-ClientAccessArray.md) + +### [Set-ClientAccessServer](Set-ClientAccessServer.md) + +### [Set-ClientAccessService](Set-ClientAccessService.md) + +### [Set-EcpVirtualDirectory](Set-EcpVirtualDirectory.md) + +### [Set-MapiVirtualDirectory](Set-MapiVirtualDirectory.md) + +### [Set-OutlookAnywhere](Set-OutlookAnywhere.md) + +### [Set-OwaVirtualDirectory](Set-OwaVirtualDirectory.md) + +### [Set-PowerShellVirtualDirectory](Set-PowerShellVirtualDirectory.md) + +### [Set-RpcClientAccess](Set-RpcClientAccess.md) + +### [Set-WebServicesVirtualDirectory](Set-WebServicesVirtualDirectory.md) + +## database-availability-groups Cmdlets +### [Add-DatabaseAvailabilityGroupServer](Add-DatabaseAvailabilityGroupServer.md) + +### [Add-MailboxDatabaseCopy](Add-MailboxDatabaseCopy.md) + +### [Get-DatabaseAvailabilityGroup](Get-DatabaseAvailabilityGroup.md) + +### [Get-DatabaseAvailabilityGroupNetwork](Get-DatabaseAvailabilityGroupNetwork.md) + +### [Get-MailboxDatabaseCopyStatus](Get-MailboxDatabaseCopyStatus.md) + +### [Move-ActiveMailboxDatabase](Move-ActiveMailboxDatabase.md) + +### [New-DatabaseAvailabilityGroup](New-DatabaseAvailabilityGroup.md) + +### [New-DatabaseAvailabilityGroupNetwork](New-DatabaseAvailabilityGroupNetwork.md) + +### [Remove-DatabaseAvailabilityGroup](Remove-DatabaseAvailabilityGroup.md) + +### [Remove-DatabaseAvailabilityGroupNetwork](Remove-DatabaseAvailabilityGroupNetwork.md) + +### [Remove-DatabaseAvailabilityGroupServer](Remove-DatabaseAvailabilityGroupServer.md) + +### [Remove-MailboxDatabaseCopy](Remove-MailboxDatabaseCopy.md) + +### [Restore-DatabaseAvailabilityGroup](Restore-DatabaseAvailabilityGroup.md) + +### [Resume-MailboxDatabaseCopy](Resume-MailboxDatabaseCopy.md) + +### [Set-DatabaseAvailabilityGroup](Set-DatabaseAvailabilityGroup.md) + +### [Set-DatabaseAvailabilityGroupNetwork](Set-DatabaseAvailabilityGroupNetwork.md) + +### [Set-MailboxDatabaseCopy](Set-MailboxDatabaseCopy.md) + +### [Start-DatabaseAvailabilityGroup](Start-DatabaseAvailabilityGroup.md) + +### [Stop-DatabaseAvailabilityGroup](Stop-DatabaseAvailabilityGroup.md) + +### [Suspend-MailboxDatabaseCopy](Suspend-MailboxDatabaseCopy.md) + +### [Test-ReplicationHealth](Test-ReplicationHealth.md) + +### [Update-MailboxDatabaseCopy](Update-MailboxDatabaseCopy.md) + +## devices Cmdlets +### [Clear-ActiveSyncDevice](Clear-ActiveSyncDevice.md) + +### [Clear-MobileDevice](Clear-MobileDevice.md) + +### [Export-ActiveSyncLog](Export-ActiveSyncLog.md) + +### [Get-ActiveSyncDevice](Get-ActiveSyncDevice.md) + +### [Get-ActiveSyncDeviceAccessRule](Get-ActiveSyncDeviceAccessRule.md) + +### [Get-ActiveSyncDeviceAutoblockThreshold](Get-ActiveSyncDeviceAutoblockThreshold.md) + +### [Get-ActiveSyncDeviceClass](Get-ActiveSyncDeviceClass.md) + +### [Get-ActiveSyncDeviceStatistics](Get-ActiveSyncDeviceStatistics.md) + +### [Get-ActiveSyncMailboxPolicy](Get-ActiveSyncMailboxPolicy.md) + +### [Get-ActiveSyncOrganizationSettings](Get-ActiveSyncOrganizationSettings.md) + +### [Get-DeviceConditionalAccessPolicy](Get-DeviceConditionalAccessPolicy.md) + +### [Get-DeviceConditionalAccessRule](Get-DeviceConditionalAccessRule.md) + +### [Get-DeviceConfigurationPolicy](Get-DeviceConfigurationPolicy.md) + +### [Get-DeviceConfigurationRule](Get-DeviceConfigurationRule.md) + +### [Get-DevicePolicy](Get-DevicePolicy.md) + +### [Get-DeviceTenantPolicy](Get-DeviceTenantPolicy.md) + +### [Get-DeviceTenantRule](Get-DeviceTenantRule.md) + +### [Get-MobileDevice](Get-MobileDevice.md) + +### [Get-MobileDeviceMailboxPolicy](Get-MobileDeviceMailboxPolicy.md) + +### [Get-MobileDeviceStatistics](Get-MobileDeviceStatistics.md) + +### [New-ActiveSyncDeviceAccessRule](New-ActiveSyncDeviceAccessRule.md) + +### [New-ActiveSyncMailboxPolicy](New-ActiveSyncMailboxPolicy.md) + +### [New-DeviceConditionalAccessPolicy](New-DeviceConditionalAccessPolicy.md) + +### [New-DeviceConditionalAccessRule](New-DeviceConditionalAccessRule.md) + +### [New-DeviceConfigurationPolicy](New-DeviceConfigurationPolicy.md) + +### [New-DeviceConfigurationRule](New-DeviceConfigurationRule.md) + +### [New-DeviceTenantPolicy](New-DeviceTenantPolicy.md) + +### [New-DeviceTenantRule](New-DeviceTenantRule.md) + +### [New-MobileDeviceMailboxPolicy](New-MobileDeviceMailboxPolicy.md) + +### [Remove-ActiveSyncDevice](Remove-ActiveSyncDevice.md) + +### [Remove-ActiveSyncDeviceAccessRule](Remove-ActiveSyncDeviceAccessRule.md) + +### [Remove-ActiveSyncDeviceClass](Remove-ActiveSyncDeviceClass.md) + +### [Remove-ActiveSyncMailboxPolicy](Remove-ActiveSyncMailboxPolicy.md) + +### [Remove-DeviceConditionalAccessPolicy](Remove-DeviceConditionalAccessPolicy.md) + +### [Remove-DeviceConditionalAccessRule](Remove-DeviceConditionalAccessRule.md) + +### [Remove-DeviceConfigurationPolicy](Remove-DeviceConfigurationPolicy.md) + +### [Remove-DeviceConfigurationRule](Remove-DeviceConfigurationRule.md) + +### [Remove-DeviceTenantPolicy](Remove-DeviceTenantPolicy.md) + +### [Remove-DeviceTenantRule](Remove-DeviceTenantRule.md) + +### [Remove-MobileDevice](Remove-MobileDevice.md) + +### [Remove-MobileDeviceMailboxPolicy](Remove-MobileDeviceMailboxPolicy.md) + +### [Set-ActiveSyncDeviceAccessRule](Set-ActiveSyncDeviceAccessRule.md) + +### [Set-ActiveSyncDeviceAutoblockThreshold](Set-ActiveSyncDeviceAutoblockThreshold.md) + +### [Set-ActiveSyncMailboxPolicy](Set-ActiveSyncMailboxPolicy.md) + +### [Set-ActiveSyncOrganizationSettings](Set-ActiveSyncOrganizationSettings.md) + +### [Set-DeviceConditionalAccessPolicy](Set-DeviceConditionalAccessPolicy.md) + +### [Set-DeviceConditionalAccessRule](Set-DeviceConditionalAccessRule.md) + +### [Set-DeviceConfigurationPolicy](Set-DeviceConfigurationPolicy.md) + +### [Set-DeviceConfigurationRule](Set-DeviceConfigurationRule.md) + +### [Set-DeviceTenantPolicy](Set-DeviceTenantPolicy.md) + +### [Set-DeviceTenantRule](Set-DeviceTenantRule.md) + +### [Set-MobileDeviceMailboxPolicy](Set-MobileDeviceMailboxPolicy.md) + +### [Test-ActiveSyncConnectivity](Test-ActiveSyncConnectivity.md) + +## email-addresses-and-address-books Cmdlets +### [Disable-AddressListPaging](Disable-AddressListPaging.md) + +### [Enable-AddressListPaging](Enable-AddressListPaging.md) + +### [Get-AddressBookPolicy](Get-AddressBookPolicy.md) + +### [Get-AddressList](Get-AddressList.md) + +### [Get-DetailsTemplate](Get-DetailsTemplate.md) + +### [Get-EmailAddressPolicy](Get-EmailAddressPolicy.md) + +### [Get-GlobalAddressList](Get-GlobalAddressList.md) + +### [Get-OabVirtualDirectory](Get-OabVirtualDirectory.md) + +### [Get-OfflineAddressBook](Get-OfflineAddressBook.md) + +### [Move-AddressList](Move-AddressList.md) + +### [Move-OfflineAddressBook](Move-OfflineAddressBook.md) + +### [New-AddressBookPolicy](New-AddressBookPolicy.md) + +### [New-AddressList](New-AddressList.md) + +### [New-EmailAddressPolicy](New-EmailAddressPolicy.md) + +### [New-GlobalAddressList](New-GlobalAddressList.md) + +### [New-OabVirtualDirectory](New-OabVirtualDirectory.md) + +### [New-OfflineAddressBook](New-OfflineAddressBook.md) + +### [Remove-AddressBookPolicy](Remove-AddressBookPolicy.md) + +### [Remove-AddressList](Remove-AddressList.md) + +### [Remove-EmailAddressPolicy](Remove-EmailAddressPolicy.md) + +### [Remove-GlobalAddressList](Remove-GlobalAddressList.md) + +### [Remove-OabVirtualDirectory](Remove-OabVirtualDirectory.md) + +### [Remove-OfflineAddressBook](Remove-OfflineAddressBook.md) + +### [Restore-DetailsTemplate](Restore-DetailsTemplate.md) + +### [Set-AddressBookPolicy](Set-AddressBookPolicy.md) + +### [Set-AddressList](Set-AddressList.md) + +### [Set-DetailsTemplate](Set-DetailsTemplate.md) + +### [Set-EmailAddressPolicy](Set-EmailAddressPolicy.md) + +### [Set-GlobalAddressList](Set-GlobalAddressList.md) + +### [Set-OabVirtualDirectory](Set-OabVirtualDirectory.md) + +### [Set-OfflineAddressBook](Set-OfflineAddressBook.md) + +### [Update-AddressList](Update-AddressList.md) + +### [Update-EmailAddressPolicy](Update-EmailAddressPolicy.md) + +### [Update-GlobalAddressList](Update-GlobalAddressList.md) + +### [Update-OfflineAddressBook](Update-OfflineAddressBook.md) + +## encryption-and-certificates Cmdlets +### [Enable-ExchangeCertificate](Enable-ExchangeCertificate.md) + +### [Export-ExchangeCertificate](Export-ExchangeCertificate.md) + +### [Get-DataEncryptionPolicy](Get-DataEncryptionPolicy.md) + +### [Get-ExchangeCertificate](Get-ExchangeCertificate.md) + +### [Get-IRMConfiguration](Get-IRMConfiguration.md) + +### [Get-M365DataAtRestEncryptionPolicy](Get-M365DataAtRestEncryptionPolicy.md) + +### [Get-M365DataAtRestEncryptionPolicyAssignment](Get-M365DataAtRestEncryptionPolicyAssignment.md) + +### [Get-MailboxIRMAccess](Get-MailboxIRMAccess.md) + +### [Get-OMEConfiguration](Get-OMEConfiguration.md) + +### [Get-OMEMessageStatus](Get-OMEMessageStatus.md) + +### [Get-RMSTemplate](Get-RMSTemplate.md) + +### [Get-SmimeConfig](Get-SmimeConfig.md) + +### [Import-ExchangeCertificate](Import-ExchangeCertificate.md) + +### [New-DataEncryptionPolicy](New-DataEncryptionPolicy.md) + +### [New-ExchangeCertificate](New-ExchangeCertificate.md) + +### [New-M365DataAtRestEncryptionPolicy](New-M365DataAtRestEncryptionPolicy.md) + +### [New-OMEConfiguration](New-OMEConfiguration.md) + +### [Remove-ExchangeCertificate](Remove-ExchangeCertificate.md) + +### [Remove-MailboxIRMAccess](Remove-MailboxIRMAccess.md) + +### [Remove-OMEConfiguration](Remove-OMEConfiguration.md) + +### [Set-DataEncryptionPolicy](Set-DataEncryptionPolicy.md) + +### [Set-IRMConfiguration](Set-IRMConfiguration.md) + +### [Set-M365DataAtRestEncryptionPolicy](Set-M365DataAtRestEncryptionPolicy.md) + +### [Set-M365DataAtRestEncryptionPolicyAssignment](Set-M365DataAtRestEncryptionPolicyAssignment.md) + +### [Set-MailboxIRMAccess](Set-MailboxIRMAccess.md) + +### [Set-OMEConfiguration](Set-OMEConfiguration.md) + +### [Set-OMEMessageRevocation](Set-OMEMessageRevocation.md) + +### [Set-RMSTemplate](Set-RMSTemplate.md) + +### [Set-SmimeConfig](Set-SmimeConfig.md) + +### [Test-IRMConfiguration](Test-IRMConfiguration.md) + +## federation-and-hybrid Cmdlets +### [Add-FederatedDomain](Add-FederatedDomain.md) + +### [Disable-RemoteMailbox](Disable-RemoteMailbox.md) + +### [Enable-RemoteMailbox](Enable-RemoteMailbox.md) + +### [Get-FederatedDomainProof](Get-FederatedDomainProof.md) + +### [Get-FederatedOrganizationIdentifier](Get-FederatedOrganizationIdentifier.md) + +### [Get-FederationInformation](Get-FederationInformation.md) + +### [Get-FederationTrust](Get-FederationTrust.md) + +### [Get-HybridConfiguration](Get-HybridConfiguration.md) + +### [Get-HybridMailflowDatacenterIPs](Get-HybridMailflowDatacenterIPs.md) + +### [Get-IntraOrganizationConfiguration](Get-IntraOrganizationConfiguration.md) + +### [Get-IntraOrganizationConnector](Get-IntraOrganizationConnector.md) + +### [Get-OnPremisesOrganization](Get-OnPremisesOrganization.md) + +### [Get-PendingFederatedDomain](Get-PendingFederatedDomain.md) + +### [Get-RemoteMailbox](Get-RemoteMailbox.md) + +### [New-FederationTrust](New-FederationTrust.md) + +### [New-HybridConfiguration](New-HybridConfiguration.md) + +### [New-IntraOrganizationConnector](New-IntraOrganizationConnector.md) + +### [New-OnPremisesOrganization](New-OnPremisesOrganization.md) + +### [New-RemoteMailbox](New-RemoteMailbox.md) + +### [Remove-FederatedDomain](Remove-FederatedDomain.md) + +### [Remove-FederationTrust](Remove-FederationTrust.md) + +### [Remove-HybridConfiguration](Remove-HybridConfiguration.md) + +### [Remove-IntraOrganizationConnector](Remove-IntraOrganizationConnector.md) + +### [Remove-OnPremisesOrganization](Remove-OnPremisesOrganization.md) + +### [Remove-RemoteMailbox](Remove-RemoteMailbox.md) + +### [Set-FederatedOrganizationIdentifier](Set-FederatedOrganizationIdentifier.md) + +### [Set-FederationTrust](Set-FederationTrust.md) + +### [Set-HybridConfiguration](Set-HybridConfiguration.md) + +### [Set-IntraOrganizationConnector](Set-IntraOrganizationConnector.md) + +### [Set-OnPremisesOrganization](Set-OnPremisesOrganization.md) + +### [Set-PendingFederatedDomain](Set-PendingFederatedDomain.md) + +### [Set-RemoteMailbox](Set-RemoteMailbox.md) + +### [Test-FederationTrust](Test-FederationTrust.md) + +### [Test-FederationTrustCertificate](Test-FederationTrustCertificate.md) + +### [Update-HybridConfiguration](Update-HybridConfiguration.md) + +### [Update-Recipient](Update-Recipient.md) + +## mailbox-databases-and-servers Cmdlets +### [Clean-MailboxDatabase](Clean-MailboxDatabase.md) + +### [Disable-MailboxQuarantine](Disable-MailboxQuarantine.md) + +### [Disable-MetaCacheDatabase](Disable-MetaCacheDatabase.md) + +### [Dismount-Database](Dismount-Database.md) + +### [Enable-MailboxQuarantine](Enable-MailboxQuarantine.md) + +### [Enable-MetaCacheDatabase](Enable-MetaCacheDatabase.md) + +### [Get-FailedContentIndexDocuments](Get-FailedContentIndexDocuments.md) + +### [Get-MailboxDatabase](Get-MailboxDatabase.md) + +### [Get-MailboxRepairRequest](Get-MailboxRepairRequest.md) + +### [Get-MailboxServer](Get-MailboxServer.md) + +### [Get-SearchDocumentFormat](Get-SearchDocumentFormat.md) + +### [Get-StoreUsageStatistics](Get-StoreUsageStatistics.md) + +### [Mount-Database](Mount-Database.md) + +### [Move-DatabasePath](Move-DatabasePath.md) + +### [New-MailboxDatabase](New-MailboxDatabase.md) + +### [New-MailboxRepairRequest](New-MailboxRepairRequest.md) + +### [New-SearchDocumentFormat](New-SearchDocumentFormat.md) + +### [Remove-MailboxDatabase](Remove-MailboxDatabase.md) + +### [Remove-MailboxRepairRequest](Remove-MailboxRepairRequest.md) + +### [Remove-SearchDocumentFormat](Remove-SearchDocumentFormat.md) + +### [Remove-StoreMailbox](Remove-StoreMailbox.md) + +### [Set-MailboxDatabase](Set-MailboxDatabase.md) + +### [Set-MailboxServer](Set-MailboxServer.md) + +### [Set-SearchDocumentFormat](Set-SearchDocumentFormat.md) + +### [Start-MailboxAssistant](Start-MailboxAssistant.md) + +### [Test-AssistantHealth](Test-AssistantHealth.md) + +### [Test-ExchangeSearch](Test-ExchangeSearch.md) + +### [Test-MRSHealth](Test-MRSHealth.md) + +### [Update-DatabaseSchema](Update-DatabaseSchema.md) + +### [Update-FileDistributionService](Update-FileDistributionService.md) + +### [Update-StoreMailboxState](Update-StoreMailboxState.md) + +## mailboxes Cmdlets +### [Add-MailboxFolderPermission](Add-MailboxFolderPermission.md) + +### [Add-MailboxPermission](Add-MailboxPermission.md) + +### [Add-RecipientPermission](Add-RecipientPermission.md) + +### [Connect-Mailbox](Connect-Mailbox.md) + +### [Disable-App](Disable-App.md) + +### [Disable-InboxRule](Disable-InboxRule.md) + +### [Disable-Mailbox](Disable-Mailbox.md) + +### [Disable-ServiceEmailChannel](Disable-ServiceEmailChannel.md) + +### [Disable-SweepRule](Disable-SweepRule.md) + +### [Enable-App](Enable-App.md) + +### [Enable-InboxRule](Enable-InboxRule.md) + +### [Enable-Mailbox](Enable-Mailbox.md) + +### [Enable-ServiceEmailChannel](Enable-ServiceEmailChannel.md) + +### [Enable-SweepRule](Enable-SweepRule.md) + +### [Expedite-Delicensing](Expedite-Delicensing.md) + +### [Export-MailboxDiagnosticLogs](Export-MailboxDiagnosticLogs.md) + +### [Export-RecipientDataProperty](Export-RecipientDataProperty.md) + +### [Get-App](Get-App.md) + +### [Get-CalendarDiagnosticAnalysis](Get-CalendarDiagnosticAnalysis.md) + +### [Get-CalendarDiagnosticLog](Get-CalendarDiagnosticLog.md) + +### [Get-CalendarDiagnosticObjects](Get-CalendarDiagnosticObjects.md) + +### [Get-CalendarNotification](Get-CalendarNotification.md) + +### [Get-CalendarProcessing](Get-CalendarProcessing.md) + +### [Get-Clutter](Get-Clutter.md) + +### [Get-EventsFromEmailConfiguration](Get-EventsFromEmailConfiguration.md) + +### [Get-ExternalInOutlook](Get-ExternalInOutlook.md) + +### [Get-FocusedInbox](Get-FocusedInbox.md) + +### [Get-InboxRule](Get-InboxRule.md) + +### [Get-Mailbox](Get-Mailbox.md) + +### [Get-MailboxAutoReplyConfiguration](Get-MailboxAutoReplyConfiguration.md) + +### [Get-MailboxCalendarFolder](Get-MailboxCalendarFolder.md) + +### [Get-MailboxExportRequest](Get-MailboxExportRequest.md) + +### [Get-MailboxExportRequestStatistics](Get-MailboxExportRequestStatistics.md) + +### [Get-MailboxFolder](Get-MailboxFolder.md) + +### [Get-MailboxFolderPermission](Get-MailboxFolderPermission.md) + +### [Get-MailboxFolderStatistics](Get-MailboxFolderStatistics.md) + +### [Get-MailboxImportRequest](Get-MailboxImportRequest.md) + +### [Get-MailboxImportRequestStatistics](Get-MailboxImportRequestStatistics.md) + +### [Get-MailboxLocation](Get-MailboxLocation.md) + +### [Get-MailboxPermission](Get-MailboxPermission.md) + +### [Get-MailboxPlan](Get-MailboxPlan.md) + +### [Get-MailboxRestoreRequest](Get-MailboxRestoreRequest.md) + +### [Get-MailboxRestoreRequestStatistics](Get-MailboxRestoreRequestStatistics.md) + +### [Get-MailboxSentItemsConfiguration](Get-MailboxSentItemsConfiguration.md) + +### [Get-MailboxStatistics](Get-MailboxStatistics.md) + +### [Get-MailboxUserConfiguration](Get-MailboxUserConfiguration.md) + +### [Get-MessageCategory](Get-MessageCategory.md) + +### [Get-PendingDelicenseUser](Get-PendingDelicenseUser.md) + +### [Get-Place](Get-Place.md) + +### [Get-RecipientPermission](Get-RecipientPermission.md) + +### [Get-RecoverableItems](Get-RecoverableItems.md) + +### [Get-ResourceConfig](Get-ResourceConfig.md) + +### [Get-SweepRule](Get-SweepRule.md) + +### [Get-UserPhoto](Get-UserPhoto.md) + +### [Import-RecipientDataProperty](Import-RecipientDataProperty.md) + +### [New-App](New-App.md) + +### [New-InboxRule](New-InboxRule.md) + +### [New-Mailbox](New-Mailbox.md) + +### [New-MailboxExportRequest](New-MailboxExportRequest.md) + +### [New-MailboxFolder](New-MailboxFolder.md) + +### [New-MailboxImportRequest](New-MailboxImportRequest.md) + +### [New-MailboxRestoreRequest](New-MailboxRestoreRequest.md) + +### [New-MailMessage](New-MailMessage.md) + +### [New-SiteMailbox](New-SiteMailbox.md) + +### [New-SweepRule](New-SweepRule.md) + +### [Remove-App](Remove-App.md) + +### [Remove-CalendarEvents](Remove-CalendarEvents.md) + +### [Remove-InboxRule](Remove-InboxRule.md) + +### [Remove-Mailbox](Remove-Mailbox.md) + +### [Remove-MailboxExportRequest](Remove-MailboxExportRequest.md) + +### [Remove-MailboxFolderPermission](Remove-MailboxFolderPermission.md) + +### [Remove-MailboxImportRequest](Remove-MailboxImportRequest.md) + +### [Remove-MailboxPermission](Remove-MailboxPermission.md) + +### [Remove-MailboxRestoreRequest](Remove-MailboxRestoreRequest.md) + +### [Remove-MailboxUserConfiguration](Remove-MailboxUserConfiguration.md) + +### [Remove-RecipientPermission](Remove-RecipientPermission.md) + +### [Remove-SweepRule](Remove-SweepRule.md) + +### [Remove-UserPhoto](Remove-UserPhoto.md) + +### [Restore-Mailbox](Restore-Mailbox.md) + +### [Restore-RecoverableItems](Restore-RecoverableItems.md) + +### [Resume-MailboxExportRequest](Resume-MailboxExportRequest.md) + +### [Resume-MailboxImportRequest](Resume-MailboxImportRequest.md) + +### [Resume-MailboxRestoreRequest](Resume-MailboxRestoreRequest.md) + +### [Search-Mailbox](Search-Mailbox.md) + +### [Set-App](Set-App.md) + +### [Set-CalendarNotification](Set-CalendarNotification.md) + +### [Set-CalendarProcessing](Set-CalendarProcessing.md) + +### [Set-Clutter](Set-Clutter.md) + +### [Set-EventsFromEmailConfiguration](Set-EventsFromEmailConfiguration.md) + +### [Set-ExternalInOutlook](Set-ExternalInOutlook.md) + +### [Set-FocusedInbox](Set-FocusedInbox.md) + +### [Set-InboxRule](Set-InboxRule.md) + +### [Set-Mailbox](Set-Mailbox.md) + +### [Set-MailboxAutoReplyConfiguration](Set-MailboxAutoReplyConfiguration.md) + +### [Set-MailboxCalendarFolder](Set-MailboxCalendarFolder.md) + +### [Set-MailboxExportRequest](Set-MailboxExportRequest.md) + +### [Set-MailboxFolderPermission](Set-MailboxFolderPermission.md) + +### [Set-MailboxImportRequest](Set-MailboxImportRequest.md) + +### [Set-MailboxPlan](Set-MailboxPlan.md) + +### [Set-MailboxRestoreRequest](Set-MailboxRestoreRequest.md) + +### [Set-MailboxSentItemsConfiguration](Set-MailboxSentItemsConfiguration.md) + +### [Set-Place](Set-Place.md) + +### [Set-ResourceConfig](Set-ResourceConfig.md) + +### [Set-SweepRule](Set-SweepRule.md) + +### [Set-UserPhoto](Set-UserPhoto.md) + +### [Suspend-MailboxExportRequest](Suspend-MailboxExportRequest.md) + +### [Suspend-MailboxImportRequest](Suspend-MailboxImportRequest.md) + +### [Suspend-MailboxRestoreRequest](Suspend-MailboxRestoreRequest.md) + +### [Test-MAPIConnectivity](Test-MAPIConnectivity.md) + +### [Undo-SoftDeletedMailbox](Undo-SoftDeletedMailbox.md) + +## mail-flow Cmdlets +### [Add-ResubmitRequest](Add-ResubmitRequest.md) + +### [Disable-DnssecForVerifiedDomain](Disable-DnssecForVerifiedDomain.md) + +### [Disable-IPv6ForAcceptedDomain](Disable-IPv6ForAcceptedDomain.md) + +### [Disable-SmtpDaneInbound](Disable-SmtpDaneInbound.md) + +### [Disable-TransportAgent](Disable-TransportAgent.md) + +### [Enable-DnssecForVerifiedDomain](Enable-DnssecForVerifiedDomain.md) + +### [Enable-IPv6ForAcceptedDomain](Enable-IPv6ForAcceptedDomain.md) + +### [Enable-SmtpDaneInbound](Enable-SmtpDaneInbound.md) + +### [Enable-TransportAgent](Enable-TransportAgent.md) + +### [Export-Message](Export-Message.md) + +### [Get-AcceptedDomain](Get-AcceptedDomain.md) + +### [Get-AddressRewriteEntry](Get-AddressRewriteEntry.md) + +### [Get-DeliveryAgentConnector](Get-DeliveryAgentConnector.md) + +### [Get-DnssecStatusForVerifiedDomain](Get-DnssecStatusForVerifiedDomain.md) + +### [Get-EdgeSubscription](Get-EdgeSubscription.md) + +### [Get-EdgeSyncServiceConfig](Get-EdgeSyncServiceConfig.md) + +### [Get-ForeignConnector](Get-ForeignConnector.md) + +### [Get-FrontendTransportService](Get-FrontendTransportService.md) + +### [Get-InboundConnector](Get-InboundConnector.md) + +### [Get-IPv6StatusForAcceptedDomain](Get-IPv6StatusForAcceptedDomain.md) + +### [Get-MailboxTransportService](Get-MailboxTransportService.md) + +### [Get-Message](Get-Message.md) + +### [Get-MessageTrace](Get-MessageTrace.md) + +### [Get-MessageTraceDetail](Get-MessageTraceDetail.md) + +### [Get-MessageTrackingLog](Get-MessageTrackingLog.md) + +### [Get-MessageTrackingReport](Get-MessageTrackingReport.md) + +### [Get-NetworkConnectionInfo](Get-NetworkConnectionInfo.md) + +### [Get-OutboundConnector](Get-OutboundConnector.md) + +### [Get-Queue](Get-Queue.md) + +### [Get-QueueDigest](Get-QueueDigest.md) + +### [Get-ReceiveConnector](Get-ReceiveConnector.md) + +### [Get-RemoteDomain](Get-RemoteDomain.md) + +### [Get-ResubmitRequest](Get-ResubmitRequest.md) + +### [Get-RoutingGroupConnector](Get-RoutingGroupConnector.md) + +### [Get-SendConnector](Get-SendConnector.md) + +### [Get-SmtpDaneInboundStatus](Get-SmtpDaneInboundStatus.md) + +### [Get-SystemMessage](Get-SystemMessage.md) + +### [Get-TransportAgent](Get-TransportAgent.md) + +### [Get-TransportConfig](Get-TransportConfig.md) + +### [Get-TransportPipeline](Get-TransportPipeline.md) + +### [Get-TransportServer](Get-TransportServer.md) + +### [Get-TransportService](Get-TransportService.md) + +### [Get-X400AuthoritativeDomain](Get-X400AuthoritativeDomain.md) + +### [Install-TransportAgent](Install-TransportAgent.md) + +### [New-AcceptedDomain](New-AcceptedDomain.md) + +### [New-AddressRewriteEntry](New-AddressRewriteEntry.md) + +### [New-DeliveryAgentConnector](New-DeliveryAgentConnector.md) + +### [New-EdgeSubscription](New-EdgeSubscription.md) + +### [New-EdgeSyncServiceConfig](New-EdgeSyncServiceConfig.md) + +### [New-ForeignConnector](New-ForeignConnector.md) + +### [New-InboundConnector](New-InboundConnector.md) + +### [New-OutboundConnector](New-OutboundConnector.md) + +### [New-ReceiveConnector](New-ReceiveConnector.md) + +### [New-RemoteDomain](New-RemoteDomain.md) + +### [New-RoutingGroupConnector](New-RoutingGroupConnector.md) + +### [New-SendConnector](New-SendConnector.md) + +### [New-SystemMessage](New-SystemMessage.md) + +### [New-X400AuthoritativeDomain](New-X400AuthoritativeDomain.md) + +### [Redirect-Message](Redirect-Message.md) + +### [Remove-AcceptedDomain](Remove-AcceptedDomain.md) + +### [Remove-AddressRewriteEntry](Remove-AddressRewriteEntry.md) + +### [Remove-DeliveryAgentConnector](Remove-DeliveryAgentConnector.md) + +### [Remove-EdgeSubscription](Remove-EdgeSubscription.md) + +### [Remove-ForeignConnector](Remove-ForeignConnector.md) + +### [Remove-InboundConnector](Remove-InboundConnector.md) + +### [Remove-Message](Remove-Message.md) + +### [Remove-OutboundConnector](Remove-OutboundConnector.md) + +### [Remove-ReceiveConnector](Remove-ReceiveConnector.md) + +### [Remove-RemoteDomain](Remove-RemoteDomain.md) + +### [Remove-ResubmitRequest](Remove-ResubmitRequest.md) + +### [Remove-RoutingGroupConnector](Remove-RoutingGroupConnector.md) + +### [Remove-SendConnector](Remove-SendConnector.md) + +### [Remove-SystemMessage](Remove-SystemMessage.md) + +### [Remove-X400AuthoritativeDomain](Remove-X400AuthoritativeDomain.md) + +### [Resume-Message](Resume-Message.md) + +### [Resume-Queue](Resume-Queue.md) + +### [Retry-Queue](Retry-Queue.md) + +### [Search-MessageTrackingReport](Search-MessageTrackingReport.md) + +### [Set-AcceptedDomain](Set-AcceptedDomain.md) + +### [Set-AddressRewriteEntry](Set-AddressRewriteEntry.md) + +### [Set-DeliveryAgentConnector](Set-DeliveryAgentConnector.md) + +### [Set-EdgeSyncServiceConfig](Set-EdgeSyncServiceConfig.md) + +### [Set-ForeignConnector](Set-ForeignConnector.md) + +### [Set-FrontendTransportService](Set-FrontendTransportService.md) + +### [Set-InboundConnector](Set-InboundConnector.md) + +### [Set-MailboxTransportService](Set-MailboxTransportService.md) + +### [Set-OutboundConnector](Set-OutboundConnector.md) + +### [Set-ReceiveConnector](Set-ReceiveConnector.md) + +### [Set-RemoteDomain](Set-RemoteDomain.md) + +### [Set-ResubmitRequest](Set-ResubmitRequest.md) + +### [Set-RoutingGroupConnector](Set-RoutingGroupConnector.md) + +### [Set-SendConnector](Set-SendConnector.md) + +### [Set-SystemMessage](Set-SystemMessage.md) + +### [Set-TransportAgent](Set-TransportAgent.md) + +### [Set-TransportConfig](Set-TransportConfig.md) + +### [Set-TransportServer](Set-TransportServer.md) + +### [Set-TransportService](Set-TransportService.md) + +### [Set-X400AuthoritativeDomain](Set-X400AuthoritativeDomain.md) + +### [Start-EdgeSynchronization](Start-EdgeSynchronization.md) + +### [Start-HistoricalSearch](Start-HistoricalSearch.md) + +### [Stop-HistoricalSearch](Stop-HistoricalSearch.md) + +### [Suspend-Message](Suspend-Message.md) + +### [Suspend-Queue](Suspend-Queue.md) + +### [Test-EdgeSynchronization](Test-EdgeSynchronization.md) + +### [Test-Mailflow](Test-Mailflow.md) + +### [Test-SmtpConnectivity](Test-SmtpConnectivity.md) + +### [Uninstall-TransportAgent](Uninstall-TransportAgent.md) + +### [Validate-OutboundConnector](Validate-OutboundConnector.md) + +## move-and-migration Cmdlets +### [Complete-MigrationBatch](Complete-MigrationBatch.md) + +### [Export-MigrationReport](Export-MigrationReport.md) + +### [Get-MigrationBatch](Get-MigrationBatch.md) + +### [Get-MigrationConfig](Get-MigrationConfig.md) + +### [Get-MigrationEndpoint](Get-MigrationEndpoint.md) + +### [Get-MigrationStatistics](Get-MigrationStatistics.md) + +### [Get-MigrationUser](Get-MigrationUser.md) + +### [Get-MigrationUserStatistics](Get-MigrationUserStatistics.md) + +### [Get-MoveRequest](Get-MoveRequest.md) + +### [Get-MoveRequestStatistics](Get-MoveRequestStatistics.md) + +### [Get-PublicFolderMailboxMigrationRequest](Get-PublicFolderMailboxMigrationRequest.md) + +### [Get-PublicFolderMailboxMigrationRequestStatistics](Get-PublicFolderMailboxMigrationRequestStatistics.md) + +### [Get-PublicFolderMigrationRequest](Get-PublicFolderMigrationRequest.md) + +### [Get-PublicFolderMigrationRequestStatistics](Get-PublicFolderMigrationRequestStatistics.md) + +### [Get-PublicFolderMoveRequest](Get-PublicFolderMoveRequest.md) + +### [Get-PublicFolderMoveRequestStatistics](Get-PublicFolderMoveRequestStatistics.md) + +### [New-MigrationBatch](New-MigrationBatch.md) + +### [New-MigrationEndpoint](New-MigrationEndpoint.md) + +### [New-MoveRequest](New-MoveRequest.md) + +### [New-PublicFolderMigrationRequest](New-PublicFolderMigrationRequest.md) + +### [New-PublicFolderMoveRequest](New-PublicFolderMoveRequest.md) + +### [Remove-MigrationBatch](Remove-MigrationBatch.md) + +### [Remove-MigrationEndpoint](Remove-MigrationEndpoint.md) + +### [Remove-MigrationUser](Remove-MigrationUser.md) + +### [Remove-MoveRequest](Remove-MoveRequest.md) + +### [Remove-PublicFolderMailboxMigrationRequest](Remove-PublicFolderMailboxMigrationRequest.md) + +### [Remove-PublicFolderMigrationRequest](Remove-PublicFolderMigrationRequest.md) + +### [Remove-PublicFolderMoveRequest](Remove-PublicFolderMoveRequest.md) + +### [Resume-MoveRequest](Resume-MoveRequest.md) + +### [Resume-PublicFolderMigrationRequest](Resume-PublicFolderMigrationRequest.md) + +### [Resume-PublicFolderMoveRequest](Resume-PublicFolderMoveRequest.md) + +### [Set-MigrationBatch](Set-MigrationBatch.md) + +### [Set-MigrationConfig](Set-MigrationConfig.md) + +### [Set-MigrationEndpoint](Set-MigrationEndpoint.md) + +### [Set-MigrationUser](Set-MigrationUser.md) + +### [Set-MoveRequest](Set-MoveRequest.md) + +### [Set-PublicFolderMigrationRequest](Set-PublicFolderMigrationRequest.md) + +### [Set-PublicFolderMoveRequest](Set-PublicFolderMoveRequest.md) + +### [Start-MigrationBatch](Start-MigrationBatch.md) + +### [Start-MigrationUser](Start-MigrationUser.md) + +### [Stop-MigrationBatch](Stop-MigrationBatch.md) + +### [Stop-MigrationUser](Stop-MigrationUser.md) + +### [Suspend-MoveRequest](Suspend-MoveRequest.md) + +### [Suspend-PublicFolderMailboxMigrationRequest](Suspend-PublicFolderMailboxMigrationRequest.md) + +### [Suspend-PublicFolderMigrationRequest](Suspend-PublicFolderMigrationRequest.md) + +### [Suspend-PublicFolderMoveRequest](Suspend-PublicFolderMoveRequest.md) + +### [Test-MigrationServerAvailability](Test-MigrationServerAvailability.md) + +## organization Cmdlets +### [Disable-CmdletExtensionAgent](Disable-CmdletExtensionAgent.md) + +### [Enable-CmdletExtensionAgent](Enable-CmdletExtensionAgent.md) + +### [Enable-OrganizationCustomization](Enable-OrganizationCustomization.md) + +### [Get-AccessToCustomerDataRequest](Get-AccessToCustomerDataRequest.md) + +### [Get-ApplicationAccessPolicy](Get-ApplicationAccessPolicy.md) + +### [Get-AuthConfig](Get-AuthConfig.md) + +### [Get-AuthenticationPolicy](Get-AuthenticationPolicy.md) + +### [Get-AuthServer](Get-AuthServer.md) + +### [Get-CmdletExtensionAgent](Get-CmdletExtensionAgent.md) + +### [Get-ExchangeAssistanceConfig](Get-ExchangeAssistanceConfig.md) + +### [Get-ExchangeDiagnosticInfo](Get-ExchangeDiagnosticInfo.md) + +### [Get-ExchangeServer](Get-ExchangeServer.md) + +### [Get-ExchangeServerAccessLicense](Get-ExchangeServerAccessLicense.md) + +### [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) + +### [Get-PartnerApplication](Get-PartnerApplication.md) + +### [Get-PerimeterConfig](Get-PerimeterConfig.md) + +### [Get-ServicePrincipal](Get-ServicePrincipal.md) + +### [Get-SettingOverride](Get-SettingOverride.md) + +### [New-ApplicationAccessPolicy](New-ApplicationAccessPolicy.md) + +### [New-AuthenticationPolicy](New-AuthenticationPolicy.md) + +### [New-AuthServer](New-AuthServer.md) + +### [New-ExchangeSettings](New-ExchangeSettings.md) + +### [New-FeatureConfiguration](New-FeatureConfiguration.md) + +### [New-PartnerApplication](New-PartnerApplication.md) + +### [New-ServicePrincipal](New-ServicePrincipal.md) + +### [New-SettingOverride](New-SettingOverride.md) + +### [Remove-ApplicationAccessPolicy](Remove-ApplicationAccessPolicy.md) + +### [Remove-AuthenticationPolicy](Remove-AuthenticationPolicy.md) + +### [Remove-AuthServer](Remove-AuthServer.md) + +### [Remove-FeatureConfiguration](Remove-FeatureConfiguration.md) + +### [Remove-PartnerApplication](Remove-PartnerApplication.md) + +### [Remove-ServicePrincipal](Remove-ServicePrincipal.md) + +### [Remove-SettingOverride](Remove-SettingOverride.md) + +### [Set-AccessToCustomerDataRequest](Set-AccessToCustomerDataRequest.md) + +### [Set-ApplicationAccessPolicy](Set-ApplicationAccessPolicy.md) + +### [Set-AuthConfig](Set-AuthConfig.md) + +### [Set-AuthenticationPolicy](Set-AuthenticationPolicy.md) + +### [Set-AuthServer](Set-AuthServer.md) + +### [Set-CmdletExtensionAgent](Set-CmdletExtensionAgent.md) + +### [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) + +### [Set-PartnerApplication](Set-PartnerApplication.md) + +### [Set-PerimeterConfig](Set-PerimeterConfig.md) + +### [Set-ServicePrincipal](Set-ServicePrincipal.md) + +### [Set-SettingOverride](Set-SettingOverride.md) + +### [Test-ApplicationAccessPolicy](Test-ApplicationAccessPolicy.md) + +### [Test-OAuthConnectivity](Test-OAuthConnectivity.md) + +### [Test-ServicePrincipalAuthorization](Test-ServicePrincipalAuthorization.md) + +### [Test-SystemHealth](Test-SystemHealth.md) + +### [Update-ExchangeHelp](Update-ExchangeHelp.md) + +## policy-and-compliance Cmdlets +### [Disable-JournalArchiving](Disable-JournalArchiving.md) + +### [Disable-JournalRule](Disable-JournalRule.md) + +### [Disable-OutlookProtectionRule](Disable-OutlookProtectionRule.md) + +### [Disable-TransportRule](Disable-TransportRule.md) + +### [Enable-JournalRule](Enable-JournalRule.md) + +### [Enable-OutlookProtectionRule](Enable-OutlookProtectionRule.md) + +### [Enable-TransportRule](Enable-TransportRule.md) + +### [Execute-AzureADLabelSync](Execute-AzureADLabelSync.md) + +### [Export-JournalRuleCollection](Export-JournalRuleCollection.md) + +### [Export-TransportRuleCollection](Export-TransportRuleCollection.md) + +### [Get-AdministrativeUnit](Get-AdministrativeUnit.md) + +### [Get-AutoSensitivityLabelPolicy](Get-AutoSensitivityLabelPolicy.md) + +### [Get-AutoSensitivityLabelRule](Get-AutoSensitivityLabelRule.md) + +### [Get-EtrLimits](Get-EtrLimits.md) + +### [Get-ExoInformationBarrierPolicy](Get-ExoInformationBarrierPolicy.md) + +### [Get-ExoInformationBarrierSegment](Get-ExoInformationBarrierSegment.md) + +### [Get-ExoInformationBarrierRelationship](Get-ExoInformationBarrierRelationship.md) + +### [Get-InformationBarrierPoliciesApplicationStatus](Get-InformationBarrierPoliciesApplicationStatus.md) + +### [Get-InformationBarrierPolicy](Get-InformationBarrierPolicy.md) + +### [Get-InformationBarrierRecipientStatus](Get-InformationBarrierRecipientStatus.md) + +### [Get-JournalRule](Get-JournalRule.md) + +### [Get-Label](Get-Label.md) + +### [Get-LabelPolicy](Get-LabelPolicy.md) + +### [Get-MessageClassification](Get-MessageClassification.md) + +### [Get-OrganizationSegment](Get-OrganizationSegment.md) + +### [Get-OutlookProtectionRule](Get-OutlookProtectionRule.md) + +### [Get-ProtectionAlert](Get-ProtectionAlert.md) + +### [Get-ReviewItems](Get-ReviewItems.md) + +### [Get-SupervisoryReviewPolicyV2](Get-SupervisoryReviewPolicyV2.md) + +### [Get-SupervisoryReviewRule](Get-SupervisoryReviewRule.md) + +### [Get-TransportRule](Get-TransportRule.md) + +### [Get-TransportRuleAction](Get-TransportRuleAction.md) + +### [Get-TransportRulePredicate](Get-TransportRulePredicate.md) + +### [Import-JournalRuleCollection](Import-JournalRuleCollection.md) + +### [Import-TransportRuleCollection](Import-TransportRuleCollection.md) + +### [Install-UnifiedCompliancePrerequisite](Install-UnifiedCompliancePrerequisite.md) + +### [Invoke-ComplianceSecurityFilterAction](Invoke-ComplianceSecurityFilterAction.md) + +### [New-AutoSensitivityLabelPolicy](New-AutoSensitivityLabelPolicy.md) + +### [New-AutoSensitivityLabelRule](New-AutoSensitivityLabelRule.md) + +### [New-InformationBarrierPolicy](New-InformationBarrierPolicy.md) + +### [New-JournalRule](New-JournalRule.md) + +### [New-Label](New-Label.md) + +### [New-LabelPolicy](New-LabelPolicy.md) + +### [New-MessageClassification](New-MessageClassification.md) + +### [New-OrganizationSegment](New-OrganizationSegment.md) + +### [New-OutlookProtectionRule](New-OutlookProtectionRule.md) + +### [New-ProtectionAlert](New-ProtectionAlert.md) + +### [New-SupervisoryReviewPolicyV2](New-SupervisoryReviewPolicyV2.md) + +### [New-SupervisoryReviewRule](New-SupervisoryReviewRule.md) + +### [New-TransportRule](New-TransportRule.md) + +### [Remove-AutoSensitivityLabelPolicy](Remove-AutoSensitivityLabelPolicy.md) + +### [Remove-AutoSensitivityLabelRule](Remove-AutoSensitivityLabelRule.md) + +### [Remove-InformationBarrierPolicy](Remove-InformationBarrierPolicy.md) + +### [Remove-JournalRule](Remove-JournalRule.md) + +### [Remove-Label](Remove-Label.md) + +### [Remove-LabelPolicy](Remove-LabelPolicy.md) + +### [Remove-MessageClassification](Remove-MessageClassification.md) + +### [Remove-OrganizationSegment](Remove-OrganizationSegment.md) + +### [Remove-OutlookProtectionRule](Remove-OutlookProtectionRule.md) + +### [Remove-ProtectionAlert](Remove-ProtectionAlert.md) + +### [Remove-SupervisoryReviewPolicyV2](Remove-SupervisoryReviewPolicyV2.md) + +### [Remove-TransportRule](Remove-TransportRule.md) + +### [Set-AutoSensitivityLabelPolicy](Set-AutoSensitivityLabelPolicy.md) + +### [Set-AutoSensitivityLabelRule](Set-AutoSensitivityLabelRule.md) + +### [Set-InformationBarrierPolicy](Set-InformationBarrierPolicy.md) + +### [Set-JournalRule](Set-JournalRule.md) + +### [Set-Label](Set-Label.md) + +### [Set-LabelPolicy](Set-LabelPolicy.md) + +### [Set-MessageClassification](Set-MessageClassification.md) + +### [Set-OrganizationSegment](Set-OrganizationSegment.md) + +### [Set-OutlookProtectionRule](Set-OutlookProtectionRule.md) + +### [Set-ProtectionAlert](Set-ProtectionAlert.md) + +### [Set-SupervisoryReviewPolicyV2](Set-SupervisoryReviewPolicyV2.md) + +### [Set-SupervisoryReviewRule](Set-SupervisoryReviewRule.md) + +### [Set-TransportRule](Set-TransportRule.md) + +### [Start-InformationBarrierPoliciesApplication](Start-InformationBarrierPoliciesApplication.md) + +### [Stop-InformationBarrierPoliciesApplication](Stop-InformationBarrierPoliciesApplication.md) + +### [Test-ArchiveConnectivity](Test-ArchiveConnectivity.md) + +## policy-and-compliance-audit Cmdlets +### [Get-AdminAuditLogConfig](Get-AdminAuditLogConfig.md) + +### [Get-AuditConfig](Get-AuditConfig.md) + +### [Get-AuditLogSearch](Get-AuditLogSearch.md) + +### [Get-MailboxAuditBypassAssociation](Get-MailboxAuditBypassAssociation.md) + +### [Get-UnifiedAuditLogRetentionPolicy](Get-UnifiedAuditLogRetentionPolicy.md) + +### [New-AdminAuditLogSearch](New-AdminAuditLogSearch.md) + +### [New-MailboxAuditLogSearch](New-MailboxAuditLogSearch.md) + +### [New-UnifiedAuditLogRetentionPolicy](New-UnifiedAuditLogRetentionPolicy.md) + +### [Remove-UnifiedAuditLogRetentionPolicy](Remove-UnifiedAuditLogRetentionPolicy.md) + +### [Search-AdminAuditLog](Search-AdminAuditLog.md) + +### [Search-MailboxAuditLog](Search-MailboxAuditLog.md) + +### [Search-UnifiedAuditLog](Search-UnifiedAuditLog.md) + +### [Set-AdminAuditLogConfig](Set-AdminAuditLogConfig.md) + +### [Set-AuditConfig](Set-AuditConfig.md) + +### [Set-MailboxAuditBypassAssociation](Set-MailboxAuditBypassAssociation.md) + +### [Set-UnifiedAuditLogRetentionPolicy](Set-UnifiedAuditLogRetentionPolicy.md) + +### [Write-AdminAuditLog](Write-AdminAuditLog.md) + +## policy-and-compliance-content-search Cmdlets +### [Get-ComplianceSearch](Get-ComplianceSearch.md) + +### [Get-ComplianceSearchAction](Get-ComplianceSearchAction.md) + +### [Get-ComplianceSecurityFilter](Get-ComplianceSecurityFilter.md) + +### [Get-MailboxSearch](Get-MailboxSearch.md) + +### [Invoke-ComplianceSearchActionStep](Invoke-ComplianceSearchActionStep.md) + +### [New-ComplianceSearch](New-ComplianceSearch.md) + +### [New-ComplianceSearchAction](New-ComplianceSearchAction.md) + +### [New-ComplianceSecurityFilter](New-ComplianceSecurityFilter.md) + +### [New-MailboxSearch](New-MailboxSearch.md) + +### [Remove-ComplianceSearch](Remove-ComplianceSearch.md) + +### [Remove-ComplianceSearchAction](Remove-ComplianceSearchAction.md) + +### [Remove-ComplianceSecurityFilter](Remove-ComplianceSecurityFilter.md) + +### [Remove-MailboxSearch](Remove-MailboxSearch.md) + +### [Set-ComplianceSearch](Set-ComplianceSearch.md) + +### [Set-ComplianceSearchAction](Set-ComplianceSearchAction.md) + +### [Set-ComplianceSecurityFilter](Set-ComplianceSecurityFilter.md) + +### [Set-MailboxSearch](Set-MailboxSearch.md) + +### [Start-ComplianceSearch](Start-ComplianceSearch.md) + +### [Start-MailboxSearch](Start-MailboxSearch.md) + +### [Stop-ComplianceSearch](Stop-ComplianceSearch.md) + +### [Stop-MailboxSearch](Stop-MailboxSearch.md) + +## policy-and-compliance-dlp Cmdlets +### [Export-ActivityExplorerData](Export-ActivityExplorerData.md) + +### [Export-DlpPolicyCollection](Export-DlpPolicyCollection.md) + +### [Get-ClassificationRuleCollection](Get-ClassificationRuleCollection.md) + +### [Get-DataClassification](Get-DataClassification.md) + +### [Get-DataClassificationConfig](Get-DataClassificationConfig.md) + +### [Get-DlpCompliancePolicy](Get-DlpCompliancePolicy.md) + +### [Get-DlpComplianceRule](Get-DlpComplianceRule.md) + +### [Get-DlpDetailReport](Get-DlpDetailReport.md) + +### [Get-DlpDetectionsReport](Get-DlpDetectionsReport.md) + +### [Get-DlpEdmSchema](Get-DlpEdmSchema.md) + +### [Get-DlpIncidentDetailReport](Get-DlpIncidentDetailReport.md) + +### [Get-DlpKeywordDictionary](Get-DlpKeywordDictionary.md) + +### [Get-DlpPolicy](Get-DlpPolicy.md) + +### [Get-DlpPolicyTemplate](Get-DlpPolicyTemplate.md) + +### [Get-DlpSensitiveInformationType](Get-DlpSensitiveInformationType.md) + +### [Get-DlpSensitiveInformationTypeRulePackage](Get-DlpSensitiveInformationTypeRulePackage.md) + +### [Get-DlpSiDetectionsReport](Get-DlpSiDetectionsReport.md) + +### [Get-PolicyConfig](Get-PolicyConfig.md) + +### [Get-PolicyTipConfig](Get-PolicyTipConfig.md) + +### [Import-DlpPolicyCollection](Import-DlpPolicyCollection.md) + +### [Import-DlpPolicyTemplate](Import-DlpPolicyTemplate.md) + +### [New-ClassificationRuleCollection](New-ClassificationRuleCollection.md) + +### [New-DataClassification](New-DataClassification.md) + +### [New-DlpCompliancePolicy](New-DlpCompliancePolicy.md) + +### [New-DlpComplianceRule](New-DlpComplianceRule.md) + +### [New-DlpEdmSchema](New-DlpEdmSchema.md) + +### [New-DlpFingerprint](New-DlpFingerprint.md) + +### [New-DlpKeywordDictionary](New-DlpKeywordDictionary.md) + +### [New-DlpPolicy](New-DlpPolicy.md) + +### [New-DlpSensitiveInformationType](New-DlpSensitiveInformationType.md) + +### [New-DlpSensitiveInformationTypeRulePackage](New-DlpSensitiveInformationTypeRulePackage.md) + +### [New-Fingerprint](New-Fingerprint.md) + +### [New-PolicyTipConfig](New-PolicyTipConfig.md) + +### [Remove-ClassificationRuleCollection](Remove-ClassificationRuleCollection.md) + +### [Remove-DataClassification](Remove-DataClassification.md) + +### [Remove-DlpCompliancePolicy](Remove-DlpCompliancePolicy.md) + +### [Remove-DlpComplianceRule](Remove-DlpComplianceRule.md) + +### [Remove-DlpEdmSchema](Remove-DlpEdmSchema.md) + +### [Remove-DlpKeywordDictionary](Remove-DlpKeywordDictionary.md) + +### [Remove-DlpPolicy](Remove-DlpPolicy.md) + +### [Remove-DlpPolicyTemplate](Remove-DlpPolicyTemplate.md) + +### [Remove-DlpSensitiveInformationType](Remove-DlpSensitiveInformationType.md) + +### [Remove-DlpSensitiveInformationTypeRulePackage](Remove-DlpSensitiveInformationTypeRulePackage.md) + +### [Remove-PolicyTipConfig](Remove-PolicyTipConfig.md) + +### [Set-ClassificationRuleCollection](Set-ClassificationRuleCollection.md) + +### [Set-DataClassification](Set-DataClassification.md) + +### [Set-DlpCompliancePolicy](Set-DlpCompliancePolicy.md) + +### [Set-DlpComplianceRule](Set-DlpComplianceRule.md) + +### [Set-DlpEdmSchema](Set-DlpEdmSchema.md) + +### [Set-DlpKeywordDictionary](Set-DlpKeywordDictionary.md) + +### [Set-DlpPolicy](Set-DlpPolicy.md) + +### [Set-DlpSensitiveInformationType](Set-DlpSensitiveInformationType.md) + +### [Set-DlpSensitiveInformationTypeRulePackage](Set-DlpSensitiveInformationTypeRulePackage.md) + +### [Set-PolicyConfig](Set-PolicyConfig.md) + +### [Set-PolicyTipConfig](Set-PolicyTipConfig.md) + +### [Test-DataClassification](Test-DataClassification.md) + +### [Test-TextExtraction](Test-TextExtraction.md) + +## policy-and-compliance-ediscovery Cmdlets +### [Add-ComplianceCaseMember](Add-ComplianceCaseMember.md) + +### [Add-eDiscoveryCaseAdmin](Add-eDiscoveryCaseAdmin.md) + +### [Get-CaseHoldPolicy](Get-CaseHoldPolicy.md) + +### [Get-CaseHoldRule](Get-CaseHoldRule.md) + +### [Get-ComplianceCase](Get-ComplianceCase.md) + +### [Get-ComplianceCaseMember](Get-ComplianceCaseMember.md) + +### [Get-eDiscoveryCaseAdmin](Get-eDiscoveryCaseAdmin.md) + +### [New-CaseHoldPolicy](New-CaseHoldPolicy.md) + +### [New-CaseHoldRule](New-CaseHoldRule.md) + +### [New-ComplianceCase](New-ComplianceCase.md) + +### [Remove-CaseHoldPolicy](Remove-CaseHoldPolicy.md) + +### [Remove-CaseHoldRule](Remove-CaseHoldRule.md) + +### [Remove-ComplianceCase](Remove-ComplianceCase.md) + +### [Remove-ComplianceCaseMember](Remove-ComplianceCaseMember.md) + +### [Remove-eDiscoveryCaseAdmin](Remove-eDiscoveryCaseAdmin.md) + +### [Set-CaseHoldPolicy](Set-CaseHoldPolicy.md) + +### [Set-CaseHoldRule](Set-CaseHoldRule.md) + +### [Set-ComplianceCase](Set-ComplianceCase.md) + +### [Update-ComplianceCaseMember](Update-ComplianceCaseMember.md) + +### [Update-eDiscoveryCaseAdmin](Update-eDiscoveryCaseAdmin.md) + +## policy-and-compliance-retention Cmdlets +### [Enable-ComplianceTagStorage](Enable-ComplianceTagStorage.md) + +### [Export-ContentExplorerData](Export-ContentExplorerData.md) + +### [Export-FilePlanProperty](Export-FilePlanProperty.md) + +### [Get-AdaptiveScope](Get-AdaptiveScope.md) + +### [Get-AppRetentionCompliancePolicy](Get-AppRetentionCompliancePolicy.md) + +### [Get-AppRetentionComplianceRule](Get-AppRetentionComplianceRule.md) + +### [Get-ComplianceRetentionEvent](Get-ComplianceRetentionEvent.md) + +### [Get-ComplianceRetentionEventType](Get-ComplianceRetentionEventType.md) + +### [Get-ComplianceTag](Get-ComplianceTag.md) + +### [Get-ComplianceTagStorage](Get-ComplianceTagStorage.md) + +### [Get-DataRetentionReport](Get-DataRetentionReport.md) + +### [Get-FilePlanPropertyAuthority](Get-FilePlanPropertyAuthority.md) + +### [Get-FilePlanPropertyCategory](Get-FilePlanPropertyCategory.md) + +### [Get-FilePlanPropertyCitation](Get-FilePlanPropertyCitation.md) + +### [Get-FilePlanPropertyDepartment](Get-FilePlanPropertyDepartment.md) + +### [Get-FilePlanPropertyReferenceId](Get-FilePlanPropertyReferenceId.md) + +### [Get-FilePlanPropertyStructure](Get-FilePlanPropertyStructur.md) + +### [Get-FilePlanPropertySubCategory](Get-FilePlanPropertySubCategory.md) + +### [Get-HoldCompliancePolicy](Get-HoldCompliancePolicy.md) + +### [Get-HoldComplianceRule](Get-HoldComplianceRule.md) + +### [Get-ManagedContentSettings](Get-ManagedContentSettings.md) + +### [Get-ManagedFolder](Get-ManagedFolder.md) + +### [Get-ManagedFolderMailboxPolicy](Get-ManagedFolderMailboxPolicy.md) + +### [Get-RecordReviewNotificationTemplateConfig](Get-RecordReviewNotificationTemplateConfig.md) + +### [Get-RegulatoryComplianceUI](Get-RegulatoryComplianceUI.md) + +### [Get-RetentionCompliancePolicy](Get-RetentionCompliancePolicy.md) + +### [Get-RetentionComplianceRule](Get-RetentionComplianceRule.md) + +### [Get-RetentionEvent](Get-RetentionEvent.md) + +### [Get-RetentionPolicy](Get-RetentionPolicy.md) + +### [Get-RetentionPolicyTag](Get-RetentionPolicyTag.md) + +### [Import-FilePlanProperty](Import-FilePlanProperty.md) + +### [Invoke-HoldRemovalAction](Invoke-HoldRemovalAction.md) + +### [New-AdaptiveScope](New-AdaptiveScope.md) + +### [New-AppRetentionCompliancePolicy](New-AppRetentionCompliancePolicy.md) + +### [New-AppRetentionComplianceRule](New-AppRetentionComplianceRule.md) + +### [New-ComplianceRetentionEvent](New-ComplianceRetentionEvent.md) + +### [New-ComplianceRetentionEventType](New-ComplianceRetentionEventType.md) + +### [New-ComplianceTag](New-ComplianceTag.md) + +### [New-FilePlanPropertyAuthority](New-FilePlanPropertyAuthority.md) + +### [New-FilePlanPropertyCategory](New-FilePlanPropertyCategory.md) + +### [New-FilePlanPropertyCitation](New-FilePlanPropertyCitation.md) + +### [New-FilePlanPropertyDepartment](New-FilePlanPropertyDepartment.md) + +### [New-FilePlanPropertyReferenceId](New-FilePlanPropertyReferenceId.md) + +### [New-FilePlanPropertySubCategory](New-FilePlanPropertySubCategory.md) + +### [New-HoldCompliancePolicy](New-HoldCompliancePolicy.md) + +### [New-HoldComplianceRule](New-HoldComplianceRule.md) + +### [New-ManagedContentSettings](New-ManagedContentSettings.md) + +### [New-ManagedFolder](New-ManagedFolder.md) + +### [New-ManagedFolderMailboxPolicy](New-ManagedFolderMailboxPolicy.md) + +### [New-RetentionCompliancePolicy](New-RetentionCompliancePolicy.md) + +### [New-RetentionComplianceRule](New-RetentionComplianceRule.md) + +### [New-RetentionPolicy](New-RetentionPolicy.md) + +### [New-RetentionPolicyTag](New-RetentionPolicyTag.md) + +### [Remove-AdaptiveScope](Remove-AdaptiveScope.md) + +### [Remove-AppRetentionCompliancePolicy](Remove-AppRetentionCompliancePolicy.md) + +### [Remove-AppRetentionComplianceRule](Remove-AppRetentionComplianceRule.md) + +### [Remove-ComplianceRetentionEventType](Remove-ComplianceRetentionEventType.md) + +### [Remove-ComplianceTag](Remove-ComplianceTag.md) + +### [Remove-FilePlanPropertyAuthority](Remove-FilePlanPropertyAuthority.md) + +### [Remove-FilePlanPropertyCategory](Remove-FilePlanPropertyCategory.md) + +### [Remove-FilePlanPropertyCitation](Remove-FilePlanPropertyCitation.md) + +### [Remove-FilePlanPropertyDepartment](Remove-FilePlanPropertyDepartment.md) + +### [Remove-FilePlanPropertyReferenceId](Remove-FilePlanPropertyReferenceId.md) + +### [Remove-FilePlanPropertySubCategory](Remove-FilePlanPropertySubCategor.md) + +### [Remove-HoldCompliancePolicy](Remove-HoldCompliancePolicy.md) + +### [Remove-HoldComplianceRule](Remove-HoldComplianceRule.md) + +### [Remove-ManagedContentSettings](Remove-ManagedContentSettings.md) + +### [Remove-ManagedFolder](Remove-ManagedFolder.md) + +### [Remove-ManagedFolderMailboxPolicy](Remove-ManagedFolderMailboxPolicy.md) + +### [Remove-RetentionCompliancePolicy](Remove-RetentionCompliancePolicy.md) + +### [Remove-RetentionComplianceRule](Remove-RetentionComplianceRule.md) + +### [Remove-RetentionPolicy](Remove-RetentionPolicy.md) + +### [Remove-RetentionPolicyTag](Remove-RetentionPolicyTag.md) + +### [Set-AdaptiveScope](Set-AdaptiveScope.md) + +### [Set-AppRetentionCompliancePolicy](Set-AppRetentionCompliancePolicy.md) + +### [Set-AppRetentionComplianceRule](Set-AppRetentionComplianceRule.md) + +### [Set-ComplianceRetentionEventType](Set-ComplianceRetentionEventType.md) + +### [Set-ComplianceTag](Set-ComplianceTag.md) + +### [Set-FilePlanPropertyAuthority](Set-FilePlanPropertyAuthorit.md) + +### [Set-FilePlanPropertyCategory](Set-FilePlanPropertyCategory.md) + +### [Set-FilePlanPropertyCitation](Set-FilePlanPropertyCitation.md) + +### [Set-FilePlanPropertyDepartment](Set-FilePlanPropertyDepartment.md) + +### [Set-FilePlanPropertyReferenceId](Set-FilePlanPropertyReferenceId.md) + +### [Set-FilePlanPropertySubCategory](Set-FilePlanPropertySubCategory.md) + +### [Set-HoldCompliancePolicy](Set-HoldCompliancePolicy.md) + +### [Set-HoldComplianceRule](Set-HoldComplianceRule.md) + +### [Set-ManagedContentSettings](Set-ManagedContentSettings.md) + +### [Set-ManagedFolder](Set-ManagedFolder.md) + +### [Set-ManagedFolderMailboxPolicy](Set-ManagedFolderMailboxPolicy.md) + +### [Set-RecordReviewNotificationTemplateConfig](Set-RecordReviewNotificationTemplateConfig.md) + +### [Set-RegulatoryComplianceUI](Set-RegulatoryComplianceUI.md) + +### [Set-RetentionCompliancePolicy](Set-RetentionCompliancePolicy.md) + +### [Set-RetentionComplianceRule](Set-RetentionComplianceRule.md) + +### [Set-RetentionPolicy](Set-RetentionPolicy.md) + +### [Set-RetentionPolicyTag](Set-RetentionPolicyTag.md) + +### [Start-ManagedFolderAssistant](Start-ManagedFolderAssistant.md) + +### [Start-RetentionAutoTagLearning](Start-RetentionAutoTagLearning.md) + +### [Stop-ManagedFolderAssistant](Stop-ManagedFolderAssistant.md) + +### [Validate-RetentionRuleQuery](Validate-RetentionRuleQuery.md) + +## powershell-v3-module Cmdlets +### [Add-VivaModuleFeaturePolicy](Add-VivaModuleFeaturePolicy.md) + +### [Add-VivaOrgInsightsDelegatedRole](Add-VivaOrgInsightsDelegatedRole.md) + +### [Connect-ExchangeOnline](Connect-ExchangeOnline.md) + +### [Connect-IPPSSession](Connect-IPPSSession.md) + +### [Disconnect-ExchangeOnline](Disconnect-ExchangeOnline.md) + +### [Get-ConnectionInformation](Get-ConnectionInformation.md) + +### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) + +### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) + +### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) + +### [Get-EXOMailbox](Get-EXOMailbox.md) + +### [Get-EXOMailboxFolderPermission](Get-EXOMailboxFolderPermission.md) + +### [Get-EXOMailboxFolderStatistics](Get-EXOMailboxFolderStatistics.md) + +### [Get-EXOMailboxPermission](Get-EXOMailboxPermission.md) + +### [Get-EXOMailboxStatistics](Get-EXOMailboxStatistics.md) + +### [Get-EXOMobileDeviceStatistics](Get-EXOMobileDeviceStatistics.md) + +### [Get-EXORecipient](Get-EXORecipient.md) + +### [Get-EXORecipientPermission](Get-EXORecipientPermission.md) + +### [Get-MyAnalyticsFeatureConfig](Get-MyAnalyticsFeatureConfig.md) + +### [Get-UserBriefingConfig](Get-UserBriefingConfig.md) + +### [Get-VivaInsightsSettings](Get-VivaInsightsSettings.md) + +### [Get-VivaModuleFeature](Get-VivaModuleFeature.md) + +### [Get-VivaModuleFeatureEnablement](Get-VivaModuleFeatureEnablement.md) + +### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) + +### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md) + +### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) + +### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md) + +### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) + +### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) + +### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) + +### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) + +### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) + +### [Update-VivaModuleFeaturePolicy](Update-VivaModuleFeaturePolicy.md) + +## reporting Cmdlets +### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) + +### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) + +### [Get-HistoricalSearch](Get-HistoricalSearch.md) + +### [Get-LogonStatistics](Get-LogonStatistics.md) + +### [Get-MailDetailDlpPolicyReport](Get-MailDetailDlpPolicyReport.md) + +### [Get-MailDetailEncryptionReport](Get-MailDetailEncryptionReport.md) + +### [Get-MailDetailTransportRuleReport](Get-MailDetailTransportRuleReport.md) + +### [Get-MailFilterListReport](Get-MailFilterListReport.md) + +### [Get-MailflowStatusReport](Get-MailflowStatusReport.md) + +### [Get-MailTrafficEncryptionReport](Get-MailTrafficEncryptionReport.md) + +### [Get-MailTrafficPolicyReport](Get-MailTrafficPolicyReport.md) + +### [Get-MailTrafficSummaryReport](Get-MailTrafficSummaryReport.md) + +### [Get-MxRecordReport](Get-MxRecordReport.md) + +### [Get-OutboundConnectorReport](Get-OutboundConnectorReport.md) + +### [Get-RecipientStatisticsReport](Get-RecipientStatisticsReport.md) + +### [Get-ReportExecutionInstance](Get-ReportExecutionInstance.md) + +### [Get-SCInsights](Get-SCInsights.md) + +### [Get-ServiceDeliveryReport](Get-ServiceDeliveryReport.md) + +### [Get-SupervisoryReviewActivity](Get-SupervisoryReviewActivity.md) + +### [Get-SupervisoryReviewOverallProgressReport](Get-SupervisoryReviewOverallProgressReport.md) + +### [Get-SupervisoryReviewPolicyReport](Get-SupervisoryReviewPolicyReport.md) + +### [Get-SupervisoryReviewReport](Get-SupervisoryReviewReport.md) + +### [Get-SupervisoryReviewTopCasesReport](Get-SupervisoryReviewTopCasesReport.md) + +### [Test-Message](Test-Message.md] + +## role-based-access-control Cmdlets +### [Add-ManagementRoleEntry](Add-ManagementRoleEntry.md) + +### [Add-RoleGroupMember](Add-RoleGroupMember.md) + +### [Get-ManagementRole](Get-ManagementRole.md) + +### [Get-ManagementRoleAssignment](Get-ManagementRoleAssignment.md) + +### [Get-ManagementRoleEntry](Get-ManagementRoleEntry.md) + +### [Get-ManagementScope](Get-ManagementScope.md) + +### [Get-RoleAssignmentPolicy](Get-RoleAssignmentPolicy.md) + +### [Get-RoleGroup](Get-RoleGroup.md) + +### [Get-RoleGroupMember](Get-RoleGroupMember.md) + +### [New-ManagementRole](New-ManagementRole.md) + +### [New-ManagementRoleAssignment](New-ManagementRoleAssignment.md) + +### [New-ManagementScope](New-ManagementScope.md) + +### [New-RoleAssignmentPolicy](New-RoleAssignmentPolicy.md) + +### [New-RoleGroup](New-RoleGroup.md) + +### [Remove-ManagementRole](Remove-ManagementRole.md) + +### [Remove-ManagementRoleAssignment](Remove-ManagementRoleAssignment.md) + +### [Remove-ManagementRoleEntry](Remove-ManagementRoleEntry.md) + +### [Remove-ManagementScope](Remove-ManagementScope.md) + +### [Remove-RoleAssignmentPolicy](Remove-RoleAssignmentPolicy.md) + +### [Remove-RoleGroup](Remove-RoleGroup.md) + +### [Remove-RoleGroupMember](Remove-RoleGroupMember.md) + +### [Set-ManagementRoleAssignment](Set-ManagementRoleAssignment.md) + +### [Set-ManagementRoleEntry](Set-ManagementRoleEntry.md) + +### [Set-ManagementScope](Set-ManagementScope.md) + +### [Set-RoleAssignmentPolicy](Set-RoleAssignmentPolicy.md) + +### [Set-RoleGroup](Set-RoleGroup.md) + +### [Update-RoleGroupMember](Update-RoleGroupMember.md) + +## server-health-and-performance Cmdlets +### [Add-GlobalMonitoringOverride](Add-GlobalMonitoringOverride.md) + +### [Add-ServerMonitoringOverride](Add-ServerMonitoringOverride.md) + +### [Get-AvailabilityReportOutage](Get-AvailabilityReportOutage.md) + +### [Get-EventLogLevel](Get-EventLogLevel.md) + +### [Get-GlobalMonitoringOverride](Get-GlobalMonitoringOverride.md) + +### [Get-HealthReport](Get-HealthReport.md) + +### [Get-MonitoringItemHelp](Get-MonitoringItemHelp.md) + +### [Get-MonitoringItemIdentity](Get-MonitoringItemIdentity.md) + +### [Get-ServerComponentState](Get-ServerComponentState.md) + +### [Get-ServerHealth](Get-ServerHealth.md) + +### [Get-ServerMonitoringOverride](Get-ServerMonitoringOverride.md) + +### [Get-ThrottlingPolicy](Get-ThrottlingPolicy.md) + +### [Get-ThrottlingPolicyAssociation](Get-ThrottlingPolicyAssociation.md) + +### [Invoke-MonitoringProbe](Invoke-MonitoringProbe.md) + +### [New-AvailabilityReportOutage](New-AvailabilityReportOutage.md) + +### [New-ThrottlingPolicy](New-ThrottlingPolicy.md) + +### [Remove-AvailabilityReportOutage](Remove-AvailabilityReportOutage.md) + +### [Remove-GlobalMonitoringOverride](Remove-GlobalMonitoringOverride.md) + +### [Remove-ServerMonitoringOverride](Remove-ServerMonitoringOverride.md) + +### [Remove-ThrottlingPolicy](Remove-ThrottlingPolicy.md) + +### [Set-AvailabilityReportOutage](Set-AvailabilityReportOutage.md) + +### [Set-EventLogLevel](Set-EventLogLevel.md) + +### [Set-ServerComponentState](Set-ServerComponentState.md) + +### [Set-ServerMonitor](Set-ServerMonitor.md) + +### [Set-ThrottlingPolicy](Set-ThrottlingPolicy.md) + +### [Set-ThrottlingPolicyAssociation](Set-ThrottlingPolicyAssociation.md) + +### [Test-ServiceHealth](Test-ServiceHealth.md) + +## sharing-and-collaboration Cmdlets +### [Add-AvailabilityAddressSpace](Add-AvailabilityAddressSpace.md) + +### [Add-PublicFolderAdministrativePermission](Add-PublicFolderAdministrativePermission.md) + +### [Add-PublicFolderClientPermission](Add-PublicFolderClientPermission.md) + +### [Disable-MailPublicFolder](Disable-MailPublicFolder.md) + +### [Enable-MailPublicFolder](Enable-MailPublicFolder.md) + +### [Get-AvailabilityAddressSpace](Get-AvailabilityAddressSpace.md) + +### [Get-AvailabilityConfig](Get-AvailabilityConfig.md) + +### [Get-MailPublicFolder](Get-MailPublicFolder.md) + +### [Get-OrganizationRelationship](Get-OrganizationRelationship.md) + +### [Get-PublicFolder](Get-PublicFolder.md) + +### [Get-PublicFolderAdministrativePermission](Get-PublicFolderAdministrativePermission.md) + +### [Get-PublicFolderClientPermission](Get-PublicFolderClientPermission.md) + +### [Get-PublicFolderDatabase](Get-PublicFolderDatabase.md) + +### [Get-PublicFolderItemStatistics](Get-PublicFolderItemStatistics.md) + +### [Get-PublicFolderMailboxDiagnostics](Get-PublicFolderMailboxDiagnostics.md) + +### [Get-PublicFolderStatistics](Get-PublicFolderStatistics.md) + +### [Get-SharingPolicy](Get-SharingPolicy.md) + +### [Get-SiteMailbox](Get-SiteMailbox.md) + +### [Get-SiteMailboxDiagnostics](Get-SiteMailboxDiagnostics.md) + +### [Get-SiteMailboxProvisioningPolicy](Get-SiteMailboxProvisioningPolicy.md) + +### [New-AvailabilityConfig](New-AvailabilityConfig.md) + +### [New-OrganizationRelationship](New-OrganizationRelationship.md) + +### [New-PublicFolder](New-PublicFolder.md) + +### [New-PublicFolderDatabase](New-PublicFolderDatabase.md) + +### [New-PublicFolderDatabaseRepairRequest](New-PublicFolderDatabaseRepairRequest.md) + +### [New-SharingPolicy](New-SharingPolicy.md) + +### [New-SiteMailboxProvisioningPolicy](New-SiteMailboxProvisioningPolicy.md) + +### [New-SyncMailPublicFolder](New-SyncMailPublicFolder.md) + +### [Remove-AvailabilityAddressSpace](Remove-AvailabilityAddressSpace.md) + +### [Remove-AvailabilityConfig](Remove-AvailabilityConfig.md) + +### [Remove-OrganizationRelationship](Remove-OrganizationRelationship.md) + +### [Remove-PublicFolder](Remove-PublicFolder.md) + +### [Remove-PublicFolderAdministrativePermission](Remove-PublicFolderAdministrativePermission.md) + +### [Remove-PublicFolderClientPermission](Remove-PublicFolderClientPermission.md) + +### [Remove-PublicFolderDatabase](Remove-PublicFolderDatabase.md) + +### [Remove-SharingPolicy](Remove-SharingPolicy.md) + +### [Remove-SiteMailboxProvisioningPolicy](Remove-SiteMailboxProvisioningPolicy.md) + +### [Remove-SyncMailPublicFolder](Remove-SyncMailPublicFolder.md) + +### [Resume-PublicFolderReplication](Resume-PublicFolderReplication.md) + +### [Set-AvailabilityConfig](Set-AvailabilityConfig.md) + +### [Set-MailPublicFolder](Set-MailPublicFolder.md) + +### [Set-OrganizationRelationship](Set-OrganizationRelationship.md) + +### [Set-PublicFolder](Set-PublicFolder.md) + +### [Set-PublicFolderDatabase](Set-PublicFolderDatabase.md) + +### [Set-SharingPolicy](Set-SharingPolicy.md) + +### [Set-SiteMailbox](Set-SiteMailbox.md) + +### [Set-SiteMailboxProvisioningPolicy](Set-SiteMailboxProvisioningPolicy.md) + +### [Suspend-PublicFolderReplication](Suspend-PublicFolderReplication.md) + +### [Test-OrganizationRelationship](Test-OrganizationRelationship.md) + +### [Test-SiteMailbox](Test-SiteMailbox.md) + +### [Update-PublicFolder](Update-PublicFolder.md) + +### [Update-PublicFolderHierarchy](Update-PublicFolderHierarchy.md) + +### [Update-PublicFolderMailbox](Update-PublicFolderMailbox.md) + +### [Update-SiteMailbox](Update-SiteMailbox.md) + +## unified-messaging Cmdlets +### [Disable-UMAutoAttendant](Disable-UMAutoAttendant.md) + +### [Disable-UMCallAnsweringRule](Disable-UMCallAnsweringRule.md) + +### [Disable-UMIPGateway](Disable-UMIPGateway.md) + +### [Disable-UMMailbox](Disable-UMMailbox.md) + +### [Disable-UMServer](Disable-UMServer.md) + +### [Disable-UMService](Disable-UMService.md) + +### [Enable-UMAutoAttendant](Enable-UMAutoAttendant.md) + +### [Enable-UMCallAnsweringRule](Enable-UMCallAnsweringRule.md) + +### [Enable-UMIPGateway](Enable-UMIPGateway.md) + +### [Enable-UMMailbox](Enable-UMMailbox.md) + +### [Enable-UMServer](Enable-UMServer.md) + +### [Enable-UMService](Enable-UMService.md) + +### [Export-UMCallDataRecord](Export-UMCallDataRecord.md) + +### [Export-UMPrompt](Export-UMPrompt.md) + +### [Get-OnlineMeetingConfiguration](Get-OnlineMeetingConfiguration.md) + +### [Get-UMActiveCalls](Get-UMActiveCalls.md) + +### [Get-UMAutoAttendant](Get-UMAutoAttendant.md) + +### [Get-UMCallAnsweringRule](Get-UMCallAnsweringRule.md) + +### [Get-UMCallDataRecord](Get-UMCallDataRecord.md) + +### [Get-UMCallRouterSettings](Get-UMCallRouterSettings.md) + +### [Get-UMCallSummaryReport](Get-UMCallSummaryReport.md) + +### [Get-UMDialPlan](Get-UMDialPlan.md) + +### [Get-UMHuntGroup](Get-UMHuntGroup.md) + +### [Get-UMIPGateway](Get-UMIPGateway.md) + +### [Get-UMMailbox](Get-UMMailbox.md) + +### [Get-UMMailboxPIN](Get-UMMailboxPIN.md) + +### [Get-UMMailboxPolicy](Get-UMMailboxPolicy.md) + +### [Get-UmServer](Get-UmServer.md) + +### [Get-UMService](Get-UMService.md) + +### [Import-UMPrompt](Import-UMPrompt.md) + +### [New-UMAutoAttendant](New-UMAutoAttendant.md) + +### [New-UMCallAnsweringRule](New-UMCallAnsweringRule.md) + +### [New-UMDialPlan](New-UMDialPlan.md) + +### [New-UMHuntGroup](New-UMHuntGroup.md) + +### [New-UMIPGateway](New-UMIPGateway.md) + +### [New-UMMailboxPolicy](New-UMMailboxPolicy.md) + +### [Remove-UMAutoAttendant](Remove-UMAutoAttendant.md) + +### [Remove-UMCallAnsweringRule](Remove-UMCallAnsweringRule.md) + +### [Remove-UMDialPlan](Remove-UMDialPlan.md) + +### [Remove-UMHuntGroup](Remove-UMHuntGroup.md) + +### [Remove-UMIPGateway](Remove-UMIPGateway.md) + +### [Remove-UMMailboxPolicy](Remove-UMMailboxPolicy.md) + +### [Set-UMAutoAttendant](Set-UMAutoAttendant.md) + +### [Set-UMCallAnsweringRule](Set-UMCallAnsweringRule.md) + +### [Set-UMCallRouterSettings](Set-UMCallRouterSettings.md) + +### [Set-UMDialPlan](Set-UMDialPlan.md) + +### [Set-UMIPGateway](Set-UMIPGateway.md) + +### [Set-UMMailbox](Set-UMMailbox.md) + +### [Set-UMMailboxPIN](Set-UMMailboxPIN.md) + +### [Set-UMMailboxPolicy](Set-UMMailboxPolicy.md) + +### [Set-UmServer](Set-UmServer.md) + +### [Set-UMService](Set-UMService.md) + +### [Test-UMConnectivity](Test-UMConnectivity.md) + +## users-and-groups Cmdlets +### [Add-DistributionGroupMember](Add-DistributionGroupMember.md) + +### [Add-UnifiedGroupLinks](Add-UnifiedGroupLinks.md) + +### [Disable-DistributionGroup](Disable-DistributionGroup.md) + +### [Disable-MailContact](Disable-MailContact.md) + +### [Disable-MailUser](Disable-MailUser.md) + +### [Enable-DistributionGroup](Enable-DistributionGroup.md) + +### [Enable-MailContact](Enable-MailContact.md) + +### [Enable-MailUser](Enable-MailUser.md) + +### [Get-Contact](Get-Contact.md) + +### [Get-DistributionGroup](Get-DistributionGroup.md) + +### [Get-DistributionGroupMember](Get-DistributionGroupMember.md) + +### [Get-DynamicDistributionGroup](Get-DynamicDistributionGroup.md) + +### [Get-DynamicDistributionGroupMember](Get-DynamicDistributionGroupMember.md) + +### [Get-EligibleDistributionGroupForMigration](Get-EligibleDistributionGroupForMigration.md) + +### [Get-Group](Get-Group.md) + +### [Get-LinkedUser](Get-LinkedUser.md) + +### [Get-MailContact](Get-MailContact.md) + +### [Get-MailUser](Get-MailUser.md) + +### [Get-Recipient](Get-Recipient.md) + +### [Get-SecurityPrincipal](Get-SecurityPrincipal.md) + +### [Get-UnifiedGroup](Get-UnifiedGroup.md) + +### [Get-UnifiedGroupLinks](Get-UnifiedGroupLinks.md) + +### [Get-User](Get-User.md) + +### [New-DistributionGroup](New-DistributionGroup.md) + +### [New-DynamicDistributionGroup](New-DynamicDistributionGroup.md) + +### [New-MailContact](New-MailContact.md) + +### [New-MailUser](New-MailUser.md) + +### [New-UnifiedGroup](New-UnifiedGroup.md) + +### [Remove-DistributionGroup](Remove-DistributionGroup.md) + +### [Remove-DistributionGroupMember](Remove-DistributionGroupMember.md) + +### [Remove-DynamicDistributionGroup](Remove-DynamicDistributionGroup.md) + +### [Remove-MailContact](Remove-MailContact.md) + +### [Remove-MailUser](Remove-MailUser.md) + +### [Remove-UnifiedGroup](Remove-UnifiedGroup.md) + +### [Remove-UnifiedGroupLinks](Remove-UnifiedGroupLinks.md) + +### [Set-Contact](Set-Contact.md) + +### [Set-DistributionGroup](Set-DistributionGroup.md) + +### [Set-DynamicDistributionGroup](Set-DynamicDistributionGroup.md) + +### [Set-Group](Set-Group.md) + +### [Set-LinkedUser](Set-LinkedUser.md) + +### [Set-MailContact](Set-MailContact.md) + +### [Set-MailUser](Set-MailUser.md) + +### [Set-UnifiedGroup](Set-UnifiedGroup.md) + +### [Set-User](Set-User.md) + +### [Undo-SoftDeletedUnifiedGroup](Undo-SoftDeletedUnifiedGroup.md) + +### [Update-DistributionGroupMember](Update-DistributionGroupMember.md) + +### [Upgrade-DistributionGroup](Upgrade-DistributionGroup.md) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Disable-RemoteMailbox.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Disable-RemoteMailbox.md deleted file mode 100644 index 5b389db45f..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Disable-RemoteMailbox.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-RemoteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-RemoteMailbox - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-RemoteMailbox cmdlet to remove mailboxes from the cloud-based service but keepthe associated user objects in the on-premises Active Directory. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-RemoteMailbox [-Identity] <RemoteMailboxIdParameter> [-Archive] [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-IgnoreLegalHold] [-WhatIf] [<CommonParameters>] -``` - -## 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. - -- 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. - -Directory synchronization must be configured correctly for a mailbox to be removed from the cloud. Removal of the cloud-based mailbox 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-RemoteMailbox "Kim Akers" -``` - -This example removes the cloud-based mailbox that's associated with the on-premises mail usernamed 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. - -### -------------------------- Example 2 -------------------------- -``` -Disable-RemoteMailbox "David Strome" -Archive -``` - -This example removes thecloud-based archive mailbox but keeps the cloud-based mailbox that's associated with the on-premises mail usernamed David Strome. This example assumes directory synchronization has been configured. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the cloud-based mailbox. Valid values are: - -- ADObjectID - -- GUID - -- Distinguished name (DN) - -- Domain\\SamAccountName - -- User principal name (UPN) - -- LegacyExchangeDN - -- Email address - -- User alias - -```yaml -Type: RemoteMailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Archive -The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox. - -The on-premises mail user and its associated cloud-based mailbox aren't removed if you use 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLegalHold -The IgnoreLegalHold switch ignores the legal hold status of the mailbox user and allows you to disable a cloud-based mailbox that's on legal hold. - -When you disable a mailbox, the mailbox is disconnected from the user account. After you disable a mailbox, you can't include it in a discovery search. Disconnected mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. Check with your organization's legal or Human Resources department before disabling a mailbox that's on legal hold. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/28f5ea7e-bab0-4a57-aa8b-0fbca3b56ffe.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Enable-RemoteMailbox.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Enable-RemoteMailbox.md deleted file mode 100644 index e1af610213..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Enable-RemoteMailbox.md +++ /dev/null @@ -1,364 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-RemoteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-RemoteMailbox - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-RemoteMailbox cmdlet to create a mailbox in the cloud-based service for an existing user in the on-premises Active Directory. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Default -``` -Enable-RemoteMailbox [-Identity] <UserIdParameter> [-RemoteRoutingAddress <ProxyAddress>] [-ACLableSyncedObjectEnabled] - [-Alias <String>] [-DisplayName <String>] [-DomainController <Fqdn>] [-PrimarySmtpAddress <SmtpAddress>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Room -``` -Enable-RemoteMailbox [-Identity] <UserIdParameter> [-Room] [-ACLableSyncedObjectEnabled] [-Alias <String>] - [-DisplayName <String>] [-DomainController <Fqdn>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemoteRoutingAddress <ProxyAddress>] [-Confirm] [-WhatIf] [<CommonParameters>] - -``` - -### Equipment -``` -Enable-RemoteMailbox [-Identity] <UserIdParameter> [-Equipment] [-ACLableSyncedObjectEnabled] [-Alias <String>] - [-DisplayName <String>] [-DomainController <Fqdn>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemoteRoutingAddress <ProxyAddress>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### Archive -``` -Enable-RemoteMailbox [-Identity] <UserIdParameter> [-Archive] [-ArchiveName <MultiValuedProperty>] - [-ACLableSyncedObjectEnabled] [-Alias <String>] [-DisplayName <String>] [-DomainController <Fqdn>] - [-PrimarySmtpAddress <SmtpAddress>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### Shared -``` -Enable-RemoteMailbox [-Identity] <UserIdParameter> [-Shared] [-ACLableSyncedObjectEnabled [-Alias <String>] - [-DisplayName <String>] [-DomainController <Fqdn>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemoteRoutingAddress <ProxyAddress>] [-Confirm] [-WhatIf]] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-RemoteMailbox cmdlet mail-enables an existing on-premises user. The mail-enabled user contains a specific attribute that indicates that an associated mailbox in the service should be created when the user is synchronized to the service using directory synchronization. - -Directory synchronization must be configured correctly for a mailbox to be created in the service. Creation of the mailbox in the service isn't immediate and depends on the directory synchronization schedule. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-RemoteMailbox "Kim Akers" -RemoteRoutingAddress "kima@contoso.mail.onmicrosoft.com" -``` - -This example mail-enables an existing on-premises user and creates an associated mailbox in the service. - -To mail-enable an existing user and create an associated mailbox in the service, run the New-RemoteMailbox cmdlet and specify the identity of the existing user. - -After the user is mail-enabled, directory synchronization synchronizes the mail-enabled user to the service and the associated mailbox is created. - -### -------------------------- Example 2 -------------------------- -``` -Enable-RemoteMailbox "Kim Akers" -RemoteRoutingAddress "kima@contoso.mail.onmicrosoft.com" -Archive -``` - -This example does the following: - -Mail-enables an existing on-premises user. - -Creates the associated mailbox in the service. - -Creates an archive mailbox in the service for the mailbox. - -To mail-enable an on-premises user, create the associated mailbox in the service, enable the archive mailbox in the service and include the Archive switch with the Enable-RemoteMailbox cmdlet. - -## PARAMETERS - -### -Identity -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 - -- GUID - -- Distinguished name (DN) - -- Domain\\SamAccountName - -- User principal name (UPN) - -- LegacyExchangeDN - -- User alias - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Equipment -The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. - -You can't use this switch with the Room or Shared switches. - -```yaml -Type: SwitchParameter -Parameter Sets: Equipment, Shared -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 this switch with the Equipment or Shared switches. - -```yaml -Type: SwitchParameter -Parameter Sets: Room -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -**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/cmdlets-to-create-modify-remote-shared-mailbox-in-on-premises-exchange). - -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. - -You can't use this switch with the Room or Equipment switches. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ACLableSyncedObjectEnabled -The ACLableSyncedObjectEnabled switch specfies 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -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 -``` - -### -Archive -The Archive switch specifies whether to create an archive mailbox in the service in addition to the mailbox created in the service. - -You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Archive -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 -``` - -### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. Use this parameter to change the name of the archive. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Archive -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 -``` - -### -DisplayName -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 -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 -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```yaml -Type: SmtpAddress -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 -``` - -### -RemoteRoutingAddress -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/63a504e5-c1ee-4812-921f-d461e24afa1b.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederatedDomainProof.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederatedDomainProof.md deleted file mode 100644 index a632bbb6f4..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederatedDomainProof.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-FederatedDomainProof -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-FederatedDomainProof - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-FederatedDomainProof cmdlet to generate a cryptographically secure string for the domain used for federated sharing in your Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-FederatedDomainProof -DomainName <SmtpDomain> [-DomainController <Fqdn>] [-Thumbprint <String>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FederatedDomainProof -DomainName "contoso.com" -``` - -This example generates a cryptographically secure string for the domain contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-FederatedDomainProof -DomainName "contoso.com" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 -``` - -This example uses a specific certificate for the domain contoso.com. - -## PARAMETERS - -### -DomainName -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### -Thumbprint -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ef27cb75-e894-46c7-8f31-cb6af04ab3f1.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md deleted file mode 100644 index d55c0b85b3..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-FederatedOrganizationIdentifier -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-FederatedOrganizationIdentifier cmdlet to retrieve the Exchange organization's federated organization identifier and related details, such as federated domains, organization contact and status. - -For more information, see Federation (https://technet.microsoft.com/library/dd335047.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-FederatedOrganizationIdentifier [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] - [-IncludeExtendedDomainInfo] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FederatedOrganizationIdentifier -``` - -This example retrieves the Exchange organization's federated organization identifier. - -### -------------------------- Example 2 -------------------------- -``` -Get-FederatedOrganizationIdentifier -IncludeExtendedDomainInfo -``` - -This example retrieves the Exchange organization's federated organization identifier. The IncludeExtendedDomainInfo switch is used to return the status of federated domains from the Microsoft Federation Gateway. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the organization ID. - -```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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeExtendedDomainInfo -The IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. The status is returned with each domain in the Domains property. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/922052b7-0aec-46a3-a2be-32ed6d0628fa.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederationInformation.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederationInformation.md deleted file mode 100644 index 4277d52b5b..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederationInformation.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-FederationInformation -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-FederationInformation cmdlet to get federation information, including federated domain names and target URLs, from an external Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-FederationInformation -DomainName <SmtpDomain> [-BypassAdditionalDomainValidation] [-Force] - [-TrustedHostnames <MultiValuedProperty>] [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FederationInformation -DomainName contoso.com -``` - -This example gets federation information from the domain contoso.com. - -## PARAMETERS - -### -DomainName -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 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassAdditionalDomainValidation -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedHostnames -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e7e948c8-453d-49e2-97da-45fd2a7853ba.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederationTrust.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederationTrust.md deleted file mode 100644 index 405debdf36..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-FederationTrust.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-FederationTrust -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-FederationTrust cmdlet to view the federation trust configured for the Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-FederationTrust [[-Identity] <FederationTrustIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FederationTrust | Format-List -``` - -This example retrieves properties of the federation trust configured for the Exchange organization. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies 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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f6c81c31-491a-48ca-a547-f938a31f433f.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridConfiguration.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridConfiguration.md deleted file mode 100644 index 3571909beb..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridConfiguration.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-HybridConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-HybridConfiguration - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-HybridConfiguration cmdlet to view the hybrid configuration for the Microsoft Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HybridConfiguration [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HybridConfiguration -``` - -This example returns detailed information about the hybrid deployment configuration. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/13cc4246-80db-4de4-abc3-6139b65faf03.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridMailflow.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridMailflow.md deleted file mode 100644 index 41fd1e3f01..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridMailflow.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-HybridMailflow -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-HybridMailflow - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HybridMailflow cmdlet to view the message transport settings for a hybrid deployment. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HybridMailflow [<CommonParameters>] -``` - -## DESCRIPTION -The Get-HybridMailflow cmdlet is used to view the configuration of message transport settings for hybrid deployments that were created with the Hybrid Configuration wizard. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HybridMailflow -``` - -This example returns the message transport settings for the hybrid deployment. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/751fe9b7-7529-4bbf-a20e-3defff6cfb16.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md deleted file mode 100644 index 60c5e992eb..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Get-HybridMailflowDatacenterIPs -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-HybridMailflowDatacenterIPs - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HybridMailflowDatacenterIPs cmdlet to retrieve the IP addresses of the Microsoft Exchange Online Protection (EOP) service data centers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HybridMailflowDatacenterIPs [<CommonParameters>] -``` - -## DESCRIPTION -The Get-HybridMailflowDatacenterIPs cmdlet supports hybrid deployments and lists the IP addresses of EOP service data centers that support hybrid deployments. The list isn't specific to any on-premises 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HybridMailflowDatacenterIPs -``` - -This example returns IP address information for EOP service data centers that support hybrid deployments. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d055d1e1-7f5d-4233-bd68-d449937fb674.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md deleted file mode 100644 index 14342e8a9a..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-IntraOrganizationConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-IntraOrganizationConfiguration cmdlet to view the component settings of a hybrid Exchange deployment. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IntraOrganizationConfiguration [[-OrganizationGuid] <OnPremisesOrganizationIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -A hybrid Exchange deployment results in one logical organization made up of a number of physical Exchange instances. Hybrid Exchange environments contain more than one Exchange instance and support topologies like two on-premises Microsoft Exchange forests in an organization, an Exchange on-premises organization and an Exchange Online organization or two Exchange Online organizations. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IntraOrganizationConfiguration -``` - -This example returns the settings of the intra-organization configuration. - -## PARAMETERS - -### -OrganizationGuid -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. - -```yaml -Type: OnPremisesOrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 2 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/774d9f77-ecde-4c6f-ac4f-8068dcb4fb90.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md deleted file mode 100644 index 1b777926f8..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-IntraOrganizationConnector -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-IntraOrganizationConnector cmdlet to view the settings of Intra-Organization connectors. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-IntraOrganizationConnector [[-Identity] <IntraOrganizationConnectorIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -Intra-Organizational connectors enable features and services between divisions in your Exchange organization. It allows for the expansion of organizational boundaries for features and services across different hosts and network boundaries, such as between Active Directory forests, between on-premises and cloud-based organizations, or between tenants hosted in the same or different datacenters. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-IntraOrganizationConnector -``` - -This example returns a summary list of all Intra-Organization connectors. - -### -------------------------- Example 2 -------------------------- -``` -Get-IntraOrganizationConnector "MainCloudConnector" | Format-List -``` - -This example returns details about the Intra-Organization connector named "MainCloudConnector". - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Intra-Organization connector that you want to view. You can use any value that uniquely identifies the connector. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: IntraOrganizationConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/213b31c9-71b5-452e-9ead-401b87f6ce4e.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md deleted file mode 100644 index 3113a22b9d..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-OnPremisesOrganization -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-OnPremisesOrganization - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OnPremisesOrganization [[-Identity] <OnPremisesOrganizationIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft Office 365 tenant 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 Office 365 tenant. - -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 Office 365 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OnPremisesOrganization -Identity ExchangeMail | Format-List -``` - -This example retrieves the on-premises organization settings for ExchangeMail using the Identity parameter. - -### -------------------------- Example 2 -------------------------- -``` -Get-OnPremisesOrganization -DomainController 'mail.contoso.com' | Format-List -``` - -This example retrieves the on-premises organization settings by using the FQDN of the domain controller. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - -- Canonical name - -- GUID - -- Name - -```yaml -Type: OnPremisesOrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c58eedcf-2b80-4022-971d-fce6365b6e75.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md deleted file mode 100644 index 1b5d98fe78..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PendingFederatedDomain -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-PendingFederatedDomain - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -The Get-PendingFederatedDomain cmdlet is used by the Exchange admin center to display a list of pending federated domains for the federation trust for your Exchange organization. You shouldn't use this cmdlet to attempt to manually configure a federation trust. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PendingFederatedDomain [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PendingFederatedDomain -``` - -This example retrieves the pending federated domain information for the federation trust for your Exchange organization. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/32855b1a-2cda-4a8e-8eea-7ff7cba1b66e.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-RemoteMailbox.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Get-RemoteMailbox.md deleted file mode 100644 index 1ddab9fc79..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Get-RemoteMailbox.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RemoteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-RemoteMailbox - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-RemoteMailbox cmdlet to retrieve the mail-related attributes of users in the on-premises organization that have associated mailboxes in the cloud-based service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-RemoteMailbox [-Anr <String>] - [-Archive] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-RemoteMailbox [[-Identity] <RemoteMailboxIdParameter>] - [-Archive] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## 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 cloub-based service, or use remote PowerShell to 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RemoteMailbox -``` - -This example returns a summary list of all remote mailboxes in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-RemoteMailbox -Identity laura@contoso.com | Format-List -``` - -This example returns a detailed information for the remote mailbox for the user laura@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -$Credentials = Get-Credential; Get-RemoteMailbox -Credential $Credentials -``` - -This example uses alternate credentials to retrieve a list of one or more mail-enabled users with mailboxes in the service. This is useful if the account you typically use doesn't have administrative permissions. The credentials are used to access the on-premises Active Directory domain controllers. - -First, run the following command to prompt you for your credentials and then store them in a variable. Then retrieve a list of remote mailboxes using the credentials you provided by using the second command. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -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 -``` - -### -Archive -The Archive switch specifies whether to return information about the recipient's archive mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -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 -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: RemoteMailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnPremisesOrganizationalUnit -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8a668da4-9582-470f-a7fd-27b72e748b47.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/New-FederationTrust.md b/exchange/exchange-ps/exchange/federation-and-hybrid/New-FederationTrust.md deleted file mode 100644 index b0234b93b4..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/New-FederationTrust.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-FederationTrust -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-FederationTrust - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-FederationTrust cmdlet to set up a federation trust between your Exchange organization and the Microsoft Federation Gateway. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### SkipNamespaceProviderProvisioning -``` -New-FederationTrust [-Name] <String> -Thumbprint <String> -ApplicationUri <String> [-SkipNamespaceProviderProvisioning] [-AdministratorProvisioningId <String>] [-ApplicationIdentifier <String>] - [-Confirm] - [-DomainController <Fqdn>] - [-MetadataUrl <Uri>] - [-WhatIf] [<CommonParameters>] -``` - -### FederationTrust -``` -New-FederationTrust [-Name] <String> -Thumbprint <String> [-SuppressDnsWarning] [-UseLegacyProvisioningService] - [-Confirm] - [-DomainController <Fqdn>] - [-MetadataUrl <Uri>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Federation trusts are trusts created between an Exchange organization and the Microsoft Federation Gateway. A federation trust is required to configure a federated organization identifier for federated sharing. - -For more information, see Federation (https://technet.microsoft.com/library/dd335047.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-FederationTrust -Name "Microsoft Federation Gateway" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 -``` - -This example creates the federation trust Microsoft Federation Gateway with a certificate with the thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationUri -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. - -```yaml -Type: String -Parameter Sets: SkipNamespaceProviderProvisioning -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipNamespaceProviderProvisioning -The SkipNamespaceProviderProvisioning switch specifies that the trust and federated organization identifier are provisioned externally without using federation functionality in Microsoft Exchange. - -If you use this switch, you must specify the ApplicationIdentifier, ApplicationUri and AdministratorProvisioningId parameters. - -```yaml -Type: SwitchParameter -Parameter Sets: SkipNamespaceProviderProvisioning -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see Federation (https://technet.microsoft.com/library/dd335047.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AdministratorProvisioningId -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. - -```yaml -Type: String -Parameter Sets: SkipNamespaceProviderProvisioning -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 -``` - -### -ApplicationIdentifier -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. - -```yaml -Type: String -Parameter Sets: SkipNamespaceProviderProvisioning -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 -``` - -### -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 -``` - -### -MetadataUrl -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressDnsWarning -This parameter is available or functional only in Exchange Server 2010. - -The SuppressDNSWarning parameter specifies whether to display the DNS warning message for creating TXT records in your public DNS when running the New-FederationTrust cmdlet. Valid values are $true or $false. The default value is $false. However, this parameter is automatically set to $true when used by the Hybrid Configuration wizard. It's not recommended that you use this parameter when using the New-FederationTrust cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: FederationTrust -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLegacyProvisioningService -The UseLegacyProvisioningService parameter specifies if the legacy interface on the Microsoft Federation Gateway will be used for managing the federation trust, including federated domains, certificates, and federation metadata. Valid input for this parameter is $true or $false. The default value is $false. When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created with the parameter set to $true. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. We recommend you always use the default value of $false. - -```yaml -Type: SwitchParameter -Parameter Sets: FederationTrust -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ab3bb2d0-c346-480d-93b2-be563aebc261.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/New-HybridConfiguration.md b/exchange/exchange-ps/exchange/federation-and-hybrid/New-HybridConfiguration.md deleted file mode 100644 index b67b50e494..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/New-HybridConfiguration.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-HybridConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# 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 Office 365 for enterprises organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-HybridConfiguration [-ClientAccessServers <MultiValuedProperty>] [-Confirm] [-DomainController <Fqdn>] - [-Domains <MultiValuedProperty>] [-ExternalIPAddresses <MultiValuedProperty>] - [-Features <MultiValuedProperty>] [-OnPremisesSmartHost <SmtpDomain>] - [-SecureMailCertificateThumbprint <String>] [-TransportServers <MultiValuedProperty>] [-WhatIf] - [-EdgeTransportServers <MultiValuedProperty>] [-ReceivingTransportServers <MultiValuedProperty>] - [-SendingTransportServers <MultiValuedProperty>] [-ServiceInstance <Int32>] - [-TlsCertificateName <SmtpX509Identifier>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/jj200581.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-HybridConfiguration -``` - -This example creates the hybrid configuration Hybrid Configuration with the default hybrid configuration settings. - -## PARAMETERS - -### -ClientAccessServers -This parameter is available or functional 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 -``` - -### -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 -``` - -### -SecureMailCertificateThumbprint -This parameter is available or functional 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 -``` - -### -TransportServers -This parameter is available or functional 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 -``` - -### -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 -``` - -### -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 Office 365 for enterprises 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. - -```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 -``` - -### -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 Office 365 for enterprises tenant. 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 Office 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 "\<I\>X.500Issuer\<S\>X.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 \<Thumbprint\>, run the command $TLSCertName = "\<I\>$($TLSCert.Issuer)\<S\>$($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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1992d120-5c0f-4191-9d94-ecd58ebdff9d.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/New-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/federation-and-hybrid/New-OnPremisesOrganization.md deleted file mode 100644 index 6502837a3d..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/New-OnPremisesOrganization.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: New-OnPremisesOrganization -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-OnPremisesOrganization - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-OnPremisesOrganization cmdlet to create an OnPremisesOrganization object in a Microsoft Office 365 tenant. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-OnPremisesOrganization [-Name] <String> -HybridDomains <MultiValuedProperty> - -InboundConnector <InboundConnectorIdParameter> -OrganizationGuid <Guid> - -OutboundConnector <OutboundConnectorIdParameter> [-Comment <String>] [-Confirm] [-OrganizationName <String>] - [-OrganizationRelationship <OrganizationRelationshipIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with an Office 365 tenant 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 Office 365 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-OnPremisesOrganization -Name "ExchangeMail" -OrganizationGuid "a1bc23cb-3456-bcde-abcd-feb363cacc88" -HybridDomains contoso.com, sales.contoso.com -InboundConnector "Inbound to ExchangeMail" -OutboundConnector "Outbound to ExchangeMail" -``` - -This example creates the OnPremisesOrganization object ExchangeMail in an Office 365 tenant for the hybrid domains contoso.com and sales.contoso.com. - -## PARAMETERS - -### -HybridDomains -The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between an Office 365 tenant and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InboundConnector -The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. - -```yaml -Type: InboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Office 365 tenant. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationGuid -The OrganizationGuid parameter specifies the globally unique identifier (GUID) of the on-premises Exchange organization object in the Office 365 tenant. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutboundConnector -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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationRelationship -The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Office 365 tenant as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Office 365 tenant. - -```yaml -Type: OrganizationRelationshipIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/38f16e33-605c-4a4d-87a8-559845f32b50.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/New-RemoteMailbox.md b/exchange/exchange-ps/exchange/federation-and-hybrid/New-RemoteMailbox.md deleted file mode 100644 index a94d5f8250..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/New-RemoteMailbox.md +++ /dev/null @@ -1,679 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-RemoteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-RemoteMailbox - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-RemoteMailbox cmdlet to create a mail user in the on-premises Active Directory and also create an associated mailbox in the cloud-based service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Default -``` -New-RemoteMailbox [-Name] <String> -Password <SecureString> -UserPrincipalName <String> [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] [-Archive] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-FirstName <String>] [-ImmutableId <String>] [-Initials <String>] - [-LastName <String>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] [-RemoteRoutingAddress <ProxyAddress>] - [-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] [-WhatIf] [-ACLableSyncedObjectEnabled] - [<CommonParameters>] -``` - -### Room -``` -New-RemoteMailbox [-Name] <String> [-Password <SecureString>] [-Room] [-UserPrincipalName <String>] - [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-Archive] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-FirstName <String>] [-ImmutableId <String>] [-Initials <String>] - [-LastName <String>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] [-RemoteRoutingAddress <ProxyAddress>] - [-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] [-WhatIf] [-ACLableSyncedObjectEnabled] - [<CommonParameters>] -``` - -### Equipment -``` -New-RemoteMailbox [-Name] <String> [-Equipment] [-Password <SecureString>] [-UserPrincipalName <String>] - [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-Archive] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-FirstName <String>] [-ImmutableId <String>] [-Initials <String>] - [-LastName <String>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] [-RemoteRoutingAddress <ProxyAddress>] - [-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] [-WhatIf] [-ACLableSyncedObjectEnabled] - [<CommonParameters>] -``` - -### Shared -``` -New-RemoteMailbox [-Name] <String> [-Shared] [-Password <SecureString>] [-UserPrincipalName <String>] - [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-Archive] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-FirstName <String>] [-ImmutableId <String>] [-Initials <String>] - [-LastName <String>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] [-RemoteRoutingAddress <ProxyAddress>] - [-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] [-WhatIf] [-ACLableSyncedObjectEnabled] - [<CommonParameters>] -``` - -### AccountDisabled -``` -New-RemoteMailbox [-Name] <String> [-AccountDisabled] [-Password <SecureString>] [-UserPrincipalName <String>] - [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-Archive] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-FirstName <String>] [-ImmutableId <String>] [-Initials <String>] - [-LastName <String>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] - [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] [-RemoteRoutingAddress <ProxyAddress>] - [-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] [-WhatIf] [-ACLableSyncedObjectEnabled] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-RemoteMailbox cmdlet creates an on-premises mail user. The mail user contains a specific attribute, which indicates that an associated mailbox in the service should be created when the user is synchronized to the service using directory synchronization. - -Directory synchronization must be configured correctly for a mailbox to be created in the service. Creation of the mailbox in the service isn't immediate and depends on the directory synchronization schedule. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$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. - -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. - -After the new mail user is created, directory synchronization synchronizes the new mail user to the service and the associated mailbox is created. - -### -------------------------- Example 2 -------------------------- -``` -$Credentials = Get-Credential; New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com -OnPremisesOrganizationalUnit "corp.contoso.com/Archive Users" -Archive -``` - -This example does the following steps: - -Creates an on-premises mail user. The mail user is placed in the contoso.com/Archive Users OU. The OU has no effect on the mailbox in the service. - -Creates the associated mailbox in the service. - -Creates an archive mailbox in the service for the mailbox. - -As in Example 1, this example assumes that mail flow and directory synchronization have been properly configured. - -## PARAMETERS - -### -AccountDisabled -The AccountDisabled switch specifies whether to create the mail user in a disabled state. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: AccountDisabled -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Equipment -The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. - -You can't use the Equipment switch if you specified the Room switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Equipment -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password used by the mail user to secure his or her account and associated mailbox in the service. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: AccountDisabled, Equipment, Room, Shared -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 -``` - -```yaml -Type: SecureString -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Room -The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. - -You can't use the Room switch if you specified the Equipment switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Room -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -**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/cmdlets-to-create-modify-remote-shared-mailbox-in-on-premises-exchange). - -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. - -You can't use this switch with the Room or Equipment switches. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -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 -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 -``` - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -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 -``` - -### -ArbitrationMailbox -This parameter is available or functional only in Exchange Server 2010. - -The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Archive -The Archive switch specifies whether to create an archive mailbox in the service in addition to the mailbox that's created in the service. - -You don't have 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DisplayName -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. - -```yaml -Type: String -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 -``` - -### -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 -``` - -### -FirstName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -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. - -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 that's 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 identifier based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You must 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-premise Exchange deployment scenario. - -```yaml -Type: String -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 -``` - -### -Initials -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The LastName parameter specifies the user's last name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $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: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -OnPremisesOrganizationalUnit -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -This parameter has no effect on the mailbox in the service. - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```yaml -Type: SmtpAddress -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 -``` - -### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user can connect to Exchange using remote PowerShell. Remote PowerShell is required to open the Exchange Management Shell on Exchange servers, or to use Windows PowerShell open and import a remote PowerShell session to Exchange. Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell on the local Exchange server. Valid values are: - -- $true: The user can use remote PowerShell. This is the default value. - -- $false: The user can't use remote PowerShell. - -```yaml -Type: $true | $false -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 -``` - -### -RemoteRoutingAddress -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 \<your domain\>.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. - -```yaml -Type: ProxyAddress -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 -``` - -### -ResetPasswordOnNextLogon -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. - -```yaml -Type: $true | $false -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 -``` - -### -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 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. - -```yaml -Type: String -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -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 -``` - -### -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 -``` - -### -ACLableSyncedObjectEnabled -The ACLableSyncedObjectEnabled switch specfies 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f9e000c3-5f77-494b-8caf-05176aa75c8a.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-FederatedDomain.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-FederatedDomain.md deleted file mode 100644 index b5345b593b..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-FederatedDomain.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-FederatedDomain -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-FederatedDomain - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-FederatedDomain cmdlet to remove a federated domain from the federated organization identifier in the federation trust for the Exchange organization. - -If you remove a domain configured for federated sharing, federated sharing for that domain is disabled. - -For more information, see Federation (https://technet.microsoft.com/library/dd335047.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-FederatedDomain [[-Identity] <OrganizationIdParameter>] -DomainName <SmtpDomain> [-Confirm] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -An Exchange organization's federated organization identifier is generally created using the organization's primary domain name. Additional domain names can be added and removed. The Remove-FederatedDomain cmdlet removes a federated domain from the federated 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-FederatedDomain -DomainName contoso.co.uk -``` - -This example removes the federated domain contoso.co.uk from the federated organization identifier. - -## PARAMETERS - -### -DomainName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages when removing a federated domain. This parameter can be used when the removal of the federated domain from Windows Live fails, but the configuration of this domain as a federated domain in Exchange should be removed regardless. The result of running this task with the Force switch is that the Exchange configuration is removed but the domain may not be released in Windows Live. We recommend that you not use the Force switch unless the release of the domain from Windows Live continues to fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8cd3096e-79ca-4af8-bfb2-48bb8cee5208.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md deleted file mode 100644 index 842d068573..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Remove-OnPremisesOrganization -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-OnPremisesOrganization - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-OnPremisesOrganization cmdlet to remove an OnPremisesOrganization object in a Microsoft Office 365 tenant. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OnPremisesOrganization [-Identity] <OnPremisesOrganizationIdParameter> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Removing an OnPremisesOrganization object should only be used in circumstances where the hybrid deployment state is corrupt and under the direction and supervision of Microsoft Customer Service and Support. After removing the OnPremisesOrganization object, any related hybrid deployment configured with this object won't be functional and will need to be re-created and reconfigured. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OnPremisesOrganization -Identity ExchangeMail -``` - -This example removes the ExchangeMail OnPremisesOrganization object in an Office 365 tenant. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - -- Canonical name - -- GUID - -- Name - -```yaml -Type: OnPremisesOrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d6362891-3ea6-4994-ab90-08b0a23802c1.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-RemoteMailbox.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-RemoteMailbox.md deleted file mode 100644 index 78afebff12..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Remove-RemoteMailbox.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-RemoteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-RemoteMailbox - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-RemoteMailbox cmdlet to remove a mail-enabled user in the on-premises Active Directory and the associated mailbox in the cloud-based service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RemoteMailbox [-Identity] <RemoteMailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-IgnoreLegalHold] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -With the Remove-RemoteMailbox cmdlet, you can remove an on-premises mail-enabled user and the mailbox from the service. If you only want to remove the mailbox from the service and keep the associated on-premises user, use the Disable-RemoteMailbox cmdlet. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- Legacy DN - -- GUID - -- Domain\\Account name - -- User principal name (UPN) - -- Email address - -- Alias - -```yaml -Type: RemoteMailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLegalHold -The IgnoreLegalHold switch ignores the legal hold status of the mailbox user and allows you to remove the cloud-based mailbox on legal hold. - -After you remove a mailbox, you can't include it in a discovery search. Depending on the command parameters you use, removed mailboxes are either purged immediately or when the deleted mailbox retention period expires. Check with your organization's legal or Human Resources department before disabling a mailbox that's on legal hold. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1fce0235-9a87-44ba-a3c1-7305bd73626a.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-HybridConfiguration.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Set-HybridConfiguration.md deleted file mode 100644 index 77a171cf74..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-HybridConfiguration.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-HybridConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-HybridConfiguration - -## 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 Office 365 for enterprises organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HybridConfiguration [-ClientAccessServers <MultiValuedProperty>] [-Confirm] [-DomainController <Fqdn>] - [-Domains <MultiValuedProperty>] [-ExternalIPAddresses <MultiValuedProperty>] - [-Features <MultiValuedProperty>] [-Name <String>] [-OnPremisesSmartHost <SmtpDomain>] - [-SecureMailCertificateThumbprint <String>] [-TransportServers <MultiValuedProperty>] [-WhatIf] - [-EdgeTransportServers <MultiValuedProperty>] [-ReceivingTransportServers <MultiValuedProperty>] - [-SendingTransportServers <MultiValuedProperty>] [-ServiceInstance <Int32>] - [-TlsCertificateName <SmtpX509Identifier>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-HybridConfiguration cmdlet modifies the hybrid configuration features, such as enabling secure mail, designating a specific Mailbox server for hybrid functionality, or enabling or disabling free/busy information sharing and message tracking between the on-premises Exchange and Exchange Online organizations. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -### -------------------------- Example 2 -------------------------- -``` -Set-HybridConfiguration -Features OnlineArchive,MailTips,OWARedirection,FreeBusy,MessageTracking -``` - -This example disables the secure mail and centralized transport hybrid deployment features, but keeps the Exchange Online Archive, MailTips, Outlook on the web redirection, free/busy and message tracking features enabled between the on-premises Exchange and Exchange Online organizations. - -### -------------------------- Example 3 -------------------------- -``` -Set-HybridConfiguration -TlsCertificateName "<I>CN=A. Datum Corporation CA-3, OU=www.adatum.com, O=A.Datum Corp, C=US<S>CN=mail.contoso.com, O=Barbara Zighetti, L=Seattle, S=WA, C=US" -``` - -This example specifies that the hybrid deployment uses a defined TLS certificate, referenced by the combination of the Issuer and Subject attributes of the CA issued X.509 certificate. - -## PARAMETERS - -### -ClientAccessServers -This parameter is available or functional 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, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 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. - -```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 -``` - -### -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 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. - -```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 -``` - -### -Name -This parameter has been deprecated and is no longer used. - -There can be only one HybridConfiguration object in an Exchange organization. - -```yaml -Type: String -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 -``` - -### -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. - -```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 -``` - -### -SecureMailCertificateThumbprint -This parameter is available or functional 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 -``` - -### -TransportServers -This parameter is available or functional 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. - -```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 -``` - -### -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 -``` - -### -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 Office 365 for enterprises 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. - -```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 -``` - -### -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 Office 365 for enterprises 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. - -```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 Office 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 "\<I\>X.500Issuer\<S\>X.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 \<Thumbprint\>, run the command $TLSCertName = "\<I\>$($TLSCert.Issuer)\<S\>$($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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/64bd673d-0f1c-4ed5-91dc-f19328942d71.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-HybridMailflow.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Set-HybridMailflow.md deleted file mode 100644 index 46c0318d36..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-HybridMailflow.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Set-HybridMailflow -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-HybridMailflow - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HybridMailflow cmdlet to configure the message transport settings for the Microsoft Exchange Online Protection (EOP) service in a hybrid deployment. - -The Set-HybridMailflow cmdlet is only used to support hybrid deployments configured with the Hybrid Configuration wizard offered in Microsoft Exchange Server 2010 Service Pack 2 (SP2). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HybridMailflow [-CentralizedTransportEnabled <$true | $false>] [-CertificateSubject <String>] [-Confirm] - [-InboundIPs <IPRange[]>] [-OnPremisesFQDN <Fqdn>] [-OutboundDomains <SmtpDomainWithSubdomains[]>] - [-SecureMailEnabled <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-HybridMailflow cmdlet supports the configuration of message transport settings for hybrid deployments created with the Hybrid Configuration wizard offered in Exchange 2010 SP2. This cmdlet isn't typically used by administrators; therefore, we strongly recommend that it only be used as part of the hybrid configuration process using the Hybrid Configuration wizard. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HybridMailflow -``` - -This example configures the message transport settings in the EOP service for a hybrid deployment. - -## PARAMETERS - -### -CentralizedTransportEnabled -The CentralizedTransportEnabled parameter specifies that the Exchange Online organization routes all outbound mail messages to external recipients to the on-premises Exchange organization. The on-premises Exchange organization then routes the messages to the external recipients. The valid input for the CentralizedTransportEnabled parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CertificateSubject -The CertificateSubject parameter specifies the principal name of the certificate used for secure mail flow between the on-premises Exchange and Exchange Online organizations. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InboundIPs -The InboundIPs parameter specifies the IP addresses of the on-premises mail transport servers configured as part of the hybrid deployment. These must point to either Exchange 2010 SP2 Hub Transport or Edge Transport servers. - -```yaml -Type: IPRange[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OnPremisesFQDN -The OnPremisesFQDN parameter specifies the fully qualified domain name (FQDN) of the outbound smart host in the on-premises Exchange organization to use for centralized transport. This is either an on-premises Exchange 2010 SP2 Hub Transport or Edge Transport server. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OutboundDomains -The OutboundDomains parameter specifies SMTP domains configured for the hybrid deployment. - -```yaml -Type: SmtpDomainWithSubdomains[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SecureMailEnabled -The SecureMailEnabled parameter specifies that all messages sent between the on-premises Exchange and the Exchange Online organizations must use the Transport Layer Security (TLS) protocol and the assigned digital certificate. The valid input for the SecureMailEnabled parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/69d01866-50ff-4ddf-9e7c-d448ff24da69.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md deleted file mode 100644 index 4147962623..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-OnPremisesOrganization -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-OnPremisesOrganization - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-OnPremisesOrganization cmdlet to modify the parameters of the OnPremisesOrganization object on the Microsoft Office 365 tenant. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-OnPremisesOrganization [-Identity] <OnPremisesOrganizationIdParameter> [-Comment <String>] [-Confirm] - [-HybridDomains <MultiValuedProperty>] [-InboundConnector <InboundConnectorIdParameter>] - [-OrganizationName <String>] [-OrganizationRelationship <OrganizationRelationshipIdParameter>] - [-OutboundConnector <OutboundConnectorIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with an Office 365 tenant organization. It's used in conjunction with the Hybrid Configuration wizard and is typically only modified and updated 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 Office 365 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-OnPremisesOrganization -Identity "ExchangeMail" -HybridDomains contoso.com, sales.contoso.com, legal.contoso.com -``` - -This example adds a third domain legal.contoso.com to the ExchangeMail OnPremisesOrganization object on the Office 365 tenant, which already has the contoso.com and sales.contoso.com domains. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - -- Canonical name - -- GUID - -- Name - -```yaml -Type: OnPremisesOrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridDomains -The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between an Office 365 tenant 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". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InboundConnector -The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. - -```yaml -Type: InboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationRelationship -The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Office 365 tenant as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Office 365 tenant. - -```yaml -Type: OrganizationRelationshipIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutboundConnector -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/71b1d984-c710-4898-843b-bb21b8a194c4.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Set-RemoteMailbox.md deleted file mode 100644 index 757f3984a4..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Set-RemoteMailbox.md +++ /dev/null @@ -1,1434 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RemoteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-RemoteMailbox - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-RemoteMailbox cmdlet to modify remote mailboxes. A remote mailbox is a mail user in Active Directory that's associated with a mailbox in the cloud-based service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-RemoteMailbox [-Identity] <RemoteMailboxIdParameter> - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-ACLableSyncedObjectEnabled] - [-Alias <String>] - [-ArchiveGuid <Guid>] - [-ArchiveName <MultiValuedProperty>] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-Confirm] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-EmailAddresses <ProxyAddressCollection>] - [-EmailAddressPolicyEnabled <$true | $false>] - [-ExchangeGuid <Guid>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-IgnoreDefaultScope] - [-ImmutableId <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RecoverableItemsQuota <Unlimited>] - [-RecoverableItemsWarningQuota <Unlimited>] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RemoteRoutingAddress <ProxyAddress>] - [-RemovePicture] - [-RemoveSpokenName] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-Type <Regular | Room | Equipment | Shared>] - [-UserPrincipalName <String>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-RemoteMailbox cmdlet configures Exchange attributes for an on-premises mail user. The configuration set on the on-premises mail user is synchronized to its associated mailbox in the service. - -Some attributes on mailboxes in the service can only be configured by connecting to the service and using the Set-Mailbox cmdlet. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RemoteMailbox 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. - -### -------------------------- Example 2 -------------------------- -``` -Set-RemoteMailbox 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. - -## PARAMETERS - -### -Identity -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 - -- GUID - -- Distinguished name (DN) - -- Domain\\SamAccountName - -- User principal name (UPN) - -- Legacy DN - -- Email address - -- User alias - -```yaml -Type: RemoteMailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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: False -Accept wildcard characters: False -``` - -### -ACLableSyncedObjectEnabled -The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. To enable this, use this switch without a value. To disable this, use this exact syntax: -ACLableSyncedObjectEnabled:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -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 -``` - -### -ArchiveGuid -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. Use this parameter to change the name of the archive. - -```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: False -Accept wildcard characters: False -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -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 -``` - -### -DisplayName -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 -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 -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -Type: ProxyAddressCollection -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 -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -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 -``` - -### -ExchangeGuid -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. - -```yaml -Type: Guid -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 -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -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. - -```yaml -Type: String -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 -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $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: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```yaml -Type: SmtpAddress -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 -``` - -### -RecoverableItemsQuota -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). - -When you enter a number, you can qualify it with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoverableItemsWarningQuota -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). - -When you enter a number, you can qualify it with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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: False -Accept wildcard characters: False -``` - -### -RemoteRoutingAddress -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. - -```yaml -Type: ProxyAddress -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 -``` - -### -RemovePicture -The RemovePicture switch specifies whether to remove the picture from the mail user. You don't need to specify a value with this switch. - -You can add a picture to a mail user by using the Import-RecipientDataProperty 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSpokenName -The RemoveSpokenName switch specifies whether to remove the spoken name from the mail user. You don't need to specify a value with this switch. - -You can add a picture to a mail user by using the Import-RecipientDataProperty 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -The default value is $false. - -```yaml -Type: $true | $false -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 -``` - -### -ResetPasswordOnNextLogon -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. - -```yaml -Type: $true | $false -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 -``` - -### -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 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. - -```yaml -Type: String -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -The default value is Never. - -```yaml -Type: Never | Internal | Always -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 -``` - -### -Type -The Type parameter specifies the type for the mailbox in the service. Valid values are: - -- Regular - -- Room - -- Equipment - -- Shared - -Notes on the value Shared: - -- Shared is available only in Exchange 2013 CU21 or later and Exchange 2016 CU10 or later. To use this value, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605/cmdlets-to-create-modify-remote-shared-mailbox-in-on-premises-exchange). - -- You can only use Shared on a mailbox that was originally created in Exchange Online. If the mailbox was originally created in on-premises Exchange and then migrated to Exchange Online, you need to migrate the mailbox back to on-premises Exchange, convert the mailbox to a shared mailbox in on-premises Exchange, and then migrate the shared mailbox to Exchange Online. Or, you can change the RemoteRecipientType property value of the on-premises mailbox to "ProvisionMailbox, Migrated, DeprovisionArchive" by running the following command on an Exchange server: Set-ADUser -Identity "\<UserName\>" -Replace @{msExchRemoteRecipientTYpe="21"}. - -```yaml -Type: Regular | Room | Equipment -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 -``` - -### -UserPrincipalName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/20bdcdc4-5a7c-4cef-9e7c-cef17e470efd.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Test-FederationTrust.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Test-FederationTrust.md deleted file mode 100644 index 0aadd6b66f..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Test-FederationTrust.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-FederationTrust -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-FederationTrust - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-FederationTrust cmdlet to verify that the federation trust is properly configured and functioning as expected. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-FederationTrust [-Confirm] [-DomainController <Fqdn>] [-MonitoringContext <$true | $false>] - [-UserIdentity <RecipientIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: - -& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 - -You can run the Test-FederationTrust cmdlet from the Exchange Management Shell, or a monitoring system can run the test periodically. - -The Test-FederationTrust cmdlet runs the following series of tests to ensure that federation is working as expected: - -- A connection to the Microsoft Federation Gateway is established. This test ensures that communication between the local Exchange server and the Microsoft Federation Gateway is working correctly. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-FederationTrust -``` - -This example validates the federation trust deployed in the Exchange organization and checks whether a security token can be retrieved from the Microsoft Federation Gateway. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). - -```yaml -Type: $true | $false -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 -``` - -### -UserIdentity -The UserIdentity parameter specifies a mailbox user to request a token for. If a mailbox user isn't specified, the command uses the default test mailbox. - -```yaml -Type: RecipientIdParameter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4af0c419-2302-4b67-a460-237e90425354.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md deleted file mode 100644 index d034cc5667..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-FederationTrustCertificate -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-FederationTrustCertificate - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-FederationTrustCertificate cmdlet to check the status of certificates that are used for federation on all Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-FederationTrustCertificate [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-FederationTrustCertificate -``` - -This example reports the status of federation certificates. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/40622dd1-5ed0-4ec2-8ade-370fac02c605.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Update-HybridConfiguration.md deleted file mode 100644 index 8d5525d775..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Update-HybridConfiguration.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-HybridConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Update-HybridConfiguration cmdlet to define the credentials that are used to update the hybrid configuration object. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-HybridConfiguration -OnPremisesCredentials <PSCredential> -TenantCredentials <PSCredential> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [-ForceUpgrade] [-SuppressOAuthWarning] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$OnPremisesCreds = Get-Credential; $TenantCreds = Get-Credential; Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds -``` - -This example defines the credentials that are used to update the hybrid configuration object and connect to the Microsoft Office 365 for enterprises organization. - -Use the first command to specify your on-premises organization credentials. For example, run this command and enter \<domain\>\\admin@contoso.com and the associated password in the resulting Windows PowerShell Credential Request dialog box. - -Use the second command to specify your Office 365 for enterprises organization credentials. For example, run this command and then enter admin@contoso.onmicrosoft.com and the associated account password in the resulting Windows PowerShell Credential Request dialog box. - -Use the last command to define the credentials that are used to update the hybrid configuration object and connect to the Office 365 for enterprises organization. - -## PARAMETERS - -### -OnPremisesCredentials -The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantCredentials -The TenantCredentials parameter specifies the Office 365 for enterprises organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Office 365 organization was created. This account must be a member of the Office 365 Global admin role. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -This confirmation prompt is only displayed when the existing HybridConfiguration Active Directory object version is Exchange 2010. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressOAuthWarning -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a26f3af3-96a2-4ce8-bc6b-c7109325f321.aspx) diff --git a/exchange/exchange-ps/exchange/federation-and-hybrid/Update-Recipient.md b/exchange/exchange-ps/exchange/federation-and-hybrid/Update-Recipient.md deleted file mode 100644 index ed260a3875..0000000000 --- a/exchange/exchange-ps/exchange/federation-and-hybrid/Update-Recipient.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-Recipient -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Update-Recipient - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Update-Recipient cmdlet to add Microsoft Exchange attributes to recipient objects created by the global address list (GAL) synchronization management agent in Microsoft Forefront Identity Manager (FIM) 2010. The recipient objects you modify using this cmdlet must reside on a server running Microsoft Exchange Server 2010 or later. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-Recipient [-Identity] <RecipientIdParameter> [-Confirm] [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Because of mergers, acquisitions, or legal requirements, customers may need to deploy Exchange in a multiple Exchange forest topology. These deployments require the synchronization of recipient objects across disparate Active Directory forests. - -Microsoft provides the GAL synchronization management agent for synchronizing recipient objects. The version of the GAL synchronization management agent included in Microsoft Identity Integration Server (MIIS) 2003 was designed to work with Exchange Server 2003 and relied on the Recipient Update Service. Because the Recipient Update Service is a deprecated feature and is no longer required, the new GAL synchronization management agent included in FIM 2010 is designed to function without the Recipient Update Service. - -As part of the synchronization process, the FIM 2010 GAL synchronization management agent creates recipient objects in both Active Directory forests. After the recipients are created, the management agent uses the Update-Recipient cmdlet to add the attributes required by Microsoft Exchange to complete the provisioning of these recipients. - -In Exchange, before you can run the Update-Recipient cmdlet to convert an Active Directory user object into an Exchange mailbox, you must stamp the user object with the following three mandatory Exchange attributes: - -- homeMDB - -- mailNickname - -- msExchHomeServerName - -If you're using MIIS 2003, you must run various cmdlets to complete the provisioning process of the mail contacts created by the GAL synchronization management agent. The Update-Recipient cmdlet provides an alternate and more efficient method to do this. You can run the Update-Recipient cmdlet against the recipient objects created by the MIIS 2003 GAL synchronization management agent to complete the provisioning process. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-Recipient -Identity "John Smith" -``` - -This example adds Exchange attributes to the mail contact that represents John Smith's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailContact -OrganizationalUnit "contoso.com/fabrikam.com Users" | Update-Recipient -``` - -This example updates all contacts in a specific organizational unit (OU). This example assumes that recipients are synchronized between two forests, contoso.com and fabrikam.com, and all the synchronized recipients from the fabrikam.com domain are stored in a specific OU called fabrikam.com Users in the contoso.com domain. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the recipient that you want to update. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name and password to use to access Active Directory. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/969b33b6-5165-4f9c-bcca-08923df4add6.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Export-Message.md b/exchange/exchange-ps/exchange/mail-flow/Export-Message.md deleted file mode 100644 index bb464355b3..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Export-Message.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-Message -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Export-Message - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Export-Message cmdlet to copy a message from a queue on a Mailbox server or an Edge Transport server to a specified file path in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-Message [-Identity] <MessageIdentity> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Export-Message ExchSrv1\contoso.com\1234 | AssembleMessage -Path "c:\exportfolder\filename.eml" -``` - -This example exports a single message to the specified file path. Because the Export-Message cmdlet returns a binary object, you must use the AssembleMessage filter to be able to save the message content into a specified location. - -### -------------------------- Example 2 -------------------------- -``` -Get-Message -Queue "Server1\contoso.com" -ResultSize Unlimited | ForEach-Object {Suspend-Message $_.Identity -Confirm:$False; $Temp="C:\ExportFolder\"+$_.InternetMessageID+".eml"; $Temp=$Temp.Replace("<","_"); $Temp=$Temp.Replace(">","_"); Export-Message $_.Identity | AssembleMessage -Path $Temp} -``` - -This example retrieves all messages from the specified queue. The query results are then piped to the Export-Message command, and all the messages are copied to individual .eml files. The Internet Message IDs of each message are used as the file names. To accomplish this, the command does the following: - -- Retrieves all messages in a specific queue using the Get-Message cmdlet. - -- The result is pipelined into the ForEach-Object cmdlet, which prepares a file name including full path using the temporary variable $Temp that consists of the Internet Message ID with .eml extension. The Internet Message ID field contains angled brackets ("\>" and "\<") which need to be removed as they are invalid file names. This is done using the Replace method of the temporary variable. - -- The ForEach-Object cmdlet also exports the message using the file name prepared. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see the "Message identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: MessageIdentity -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/34036966-9014-4096-9e2d-82a01889dbe4.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-AcceptedDomain.md b/exchange/exchange-ps/exchange/mail-flow/Get-AcceptedDomain.md deleted file mode 100644 index 7d041fc91b..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-AcceptedDomain.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-AcceptedDomain cmdlet to view the configuration information for the accepted domains in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AcceptedDomain [[-Identity] <AcceptedDomainIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AcceptedDomain -``` - -This example lists all the accepted domains in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-AcceptedDomain | Where{$_.DomainType -eq 'Authoritative'} -``` - -This example lists all the authoritative accepted domains in your organization. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e0c2366a-eda9-4152-bd3e-3a2d1953562d.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/mail-flow/Get-AddressRewriteEntry.md deleted file mode 100644 index 72f1fc34a8..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-AddressRewriteEntry.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AddressRewriteEntry -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AddressRewriteEntry - -## SYNOPSIS -This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. - -Use the Get-AddressRewriteEntry cmdlet to view an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AddressRewriteEntry [[-Identity] <AddressRewriteEntryIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AddressRewriteEntry -``` - -This example returns a summary listing of all address rewrite entries. - -### -------------------------- Example 2 -------------------------- -``` -Get-AddressRewriteEntry "Address rewrite entry for contoso.com" | Format-List -``` - -This example returns the detailed configuration of a single address rewrite entry by piping the results to the Format-List command. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/633abc53-1719-42cb-bf56-077f38dd942e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-DeliveryAgentConnector.md deleted file mode 100644 index 089083cdb2..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-DeliveryAgentConnector.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DeliveryAgentConnector -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-DeliveryAgentConnector - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-DeliveryAgentConnector cmdlet to retrieve information about a specific delivery agent connector in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DeliveryAgentConnector [[-Identity] <DeliveryAgentConnectorIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd638118.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DeliveryAgentConnector "Contoso X.400 Connector" | Format-List -``` - -This example reads the configuration of the delivery agent connector named Contoso X.400 Connector from Active Directory and displays all of its properties in a list format. - -### -------------------------- Example 2 -------------------------- -``` -Get-DeliveryAgentConnector | Format-Table Name,DeliveryProtocol -``` - -This example retrieves a list of all delivery agent connectors in your organization and displays their names and delivery protocols in a table format. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c7b369b6-fce1-4e60-ba6b-183fec700660.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-EdgeSubscription.md b/exchange/exchange-ps/exchange/mail-flow/Get-EdgeSubscription.md deleted file mode 100644 index 008f87b991..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-EdgeSubscription.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EdgeSubscription -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-EdgeSubscription - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-EdgeSubscription cmdlet to retrieve information about Edge Subscriptions in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-EdgeSubscription [[-Identity] <TransportServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-EdgeSubscription | Format-List -``` - -This example retrieves detailed Edge Subscription information for all Edge Transport servers subscribed to your Exchange organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-EdgeSubscription Edge1 -DomainController DC1.contoso.com -``` - -This example retrieves the Edge Subscription information for the Edge Transport server name Edge1 from the domain controller named DC1. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dc05b43c-ddc3-468b-97ff-5e915f56c751.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/mail-flow/Get-EdgeSyncServiceConfig.md deleted file mode 100644 index 815db23318..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-EdgeSyncServiceConfig.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EdgeSyncServiceConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-EdgeSyncServiceConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-EdgeSyncServiceConfig cmdlet to retrieve the edge synchronization services settings that control the general synchronization behavior shared by all Microsoft Exchange EdgeSync services. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-EdgeSyncServiceConfig [[-Identity] <EdgeSyncServiceConfigIdParameter>] [-DomainController <Fqdn>] - [-Site <AdSiteIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-EdgeSyncServiceConfig "Primary EdgeSync Settings" | Format-List -``` - -This example reads the configuration of the Microsoft Exchange EdgeSync service settings named Primary EdgeSync Settings from Active Directory and displays all its properties in a list format. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### -Site -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0864f701-484d-4a57-9291-ea63e25c1f1b.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-ForeignConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-ForeignConnector.md deleted file mode 100644 index 765c0413b2..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-ForeignConnector.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ForeignConnector -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ForeignConnector - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ForeignConnector cmdlet to view the configuration information for a Foreign connector in the Transport service of a Mailbox server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ForeignConnector [[-Identity] <ForeignConnectorIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ForeignConnector -``` - -This example lists all Foreign connectors in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-ForeignConnector "Fax Connector" | Format-List -``` - -This example displays detailed configuration information for the Foreign connector named Fax Connector. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Foreign connector that you want to examine. The Identity parameter can take any of the following values for the Foreign connector object: - -- GUID - -- Connector name - -- ServerName\\ConnectorName - -```yaml -Type: ForeignConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8b52f3f7-187d-4171-80f2-ba5b56862e46.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-FrontendTransportService.md b/exchange/exchange-ps/exchange/mail-flow/Get-FrontendTransportService.md deleted file mode 100644 index 54a9e1beeb..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-FrontendTransportService.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-FrontendTransportService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-FrontendTransportService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-FrontEndTransportService cmdlet to view the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-FrontendTransportService [[-Identity] <FrontendTransportServerIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FrontEndTransportService -``` - -This example returns a list of all Exchange servers that have the Client Access server role installed. - -### -------------------------- Example 2 -------------------------- -``` -Get-FrontEndTransportService MBX01 | Format-List -``` - -This example retrieves the detailed configuration information for the Front End Transport service on the server named MBX01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Exchange server with the Client Access server role installed that you want to view. - -You can use any value that uniquely identifies the server. For example: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -```yaml -Type: FrontendTransportServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/12908079-b1ef-4a8b-82ba-fc92a342032e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-InboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-InboundConnector.md deleted file mode 100644 index dbf315a751..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-InboundConnector.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-InboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-InboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-InboundConnector cmdlet to view the settings for an Inbound connector in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-InboundConnector [[-Identity] <InboundConnectorIdParameter>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-InboundConnector "Inbound Connector for Contoso.com" | Format-List -``` - -This example displays detailed configuration information for the Inbound connector named Inbound Connector for Contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-InboundConnector -``` - -This example lists all the Inbound connectors configured in your cloud-based organization. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ad72a9d6-4bac-4dd5-ae22-3246e05aac4e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-MailboxTransportService.md b/exchange/exchange-ps/exchange/mail-flow/Get-MailboxTransportService.md deleted file mode 100644 index eac7fd378d..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-MailboxTransportService.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxTransportService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MailboxTransportService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MailboxTransportService cmdlet to view the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxTransportService [[-Identity] <MailboxTransportServerIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxTransportService -``` - -This example displays a list of all Mailbox servers in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxTransportService Mailbox01 | Format-List -``` - -This example retrieves the detailed transport configuration information for the Mailbox Transport service on the Mailbox server named Mailbox01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/54f1d3b1-a1d6-4438-900b-c77e94f1f6d7.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-Message.md b/exchange/exchange-ps/exchange/mail-flow/Get-Message.md deleted file mode 100644 index 397aec05b6..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-Message.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Message -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-Message - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-Message cmdlet to view the details of one or more messages in queues on Mailbox servers or Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - - -### Filter -``` -Get-Message [-Filter <String>] - [-BookmarkIndex <Int32>] - [-BookmarkObject <ExtensibleMessageInfo>] - [-IncludeBookmark <$true | $false>] - [-IncludeComponentLatencyInfo] - [-IncludeRecipientInfo] - [-ResultSize <Unlimited>] - [-ReturnPageInfo <$true | $false>] - [-SearchForward <$true | $false>] - [-Server <ServerIdParameter>] - [-SortOrder <QueueViewerSortOrderEntry[]>] [<CommonParameters>] -``` - -### Identity -``` -Get-Message [[-Identity] <MessageIdentity>] - [-BookmarkIndex <Int32>] - [-BookmarkObject <ExtensibleMessageInfo>] - [-IncludeBookmark <$true | $false>] - [-IncludeComponentLatencyInfo] - [-IncludeRecipientInfo] - [-ResultSize <Unlimited>] - [-ReturnPageInfo <$true | $false>] - [-SearchForward <$true | $false>] - [-SortOrder <QueueViewerSortOrderEntry[]>] [<CommonParameters>] -``` -### Queue -``` -Get-Message [-Queue <QueueIdentity>] - [-BookmarkIndex <Int32>] - [-BookmarkObject <ExtensibleMessageInfo>] - [-IncludeBookmark <$true | $false>] - [-IncludeComponentLatencyInfo] - [-IncludeRecipientInfo] - [-ResultSize <Unlimited>] - [-ReturnPageInfo <$true | $false>] - [-SearchForward <$true | $false>] - [-SortOrder <QueueViewerSortOrderEntry[]>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Message -Filter {FromAddress -like "*@contoso.com"} | Format-List -``` - -This example displays detailed information about all messages queued on the local server and received from any sender at the contoso.com domain. - -### -------------------------- Example 2 -------------------------- -``` -Get-Message -Filter {FromAddress -like "*@contoso.com" -and SCL -gt 3} -``` - -This example lists all messages queued on the local server, received from any sender at the contoso.com domain and that have an SCL value greater than 3. - -### -------------------------- Example 3 -------------------------- -``` -Get-Message -Server Server01.contoso.com -SortOrder: +FromAddress,-Size -``` - -This example displays all messages queued on the server named Server01. The results are sorted first in ascending order by sender address and then in descending order of size. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see the "Message identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: MessageIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookmarkIndex -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookmarkObject -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value, for example, {FromAddress -like "\*@contoso.com"}. For details about filterable message properties and comparison operators, see Properties of messages in queues (https://technet.microsoft.com/library/bb123714.aspx) and https://technet.microsoft.com/library/aa998047.aspx (Find queues and messages in queues in the Exchange Management Shell). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -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 -``` - -### -IncludeBookmark -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: $true | $false -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 -``` - -### -IncludeComponentLatencyInfo -The IncludeComponentLatencyInfo switch specifies whether the information about component latency is included in the message properties. If you include this switch, the message objects returned will include latency measurements for each Transport component that has contributed to the local server latency for each queued message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeRecipientInfo -The IncludeRecipientInfo switch specifies whether to display the message recipients in the Recipients field. If you don't include the IncludeRecipientInfo switch, the Recipients field is blank. - -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. - -- FinalDestination: The distinguished name (DN) of the object used to route the message. - -- Status: The recipient status may be Complete, Ready or Retry. - -- LastError: The SMTP response after the last delivery attempt or a localized error message if the message is placed in the unreachable queue. - -For example, to store the recipient information of a message in the contoso.com remote delivery queue that has the MessageIdentity value of 1234 to a variable named $x, use the following command: $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo. - -To display the extended recipient properties that are now stored in the $x variable, use the following command : $x.Recipients. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax \<Server\>\\\<Queue\> or \<Queue\>, 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. - -If you use the Queue parameter, you can't use the Identity, Filter or Server parameters. - -```yaml -Type: QueueIdentity -Parameter Sets: Queue -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 -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -ReturnPageInfo -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: $true | $false -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 -``` - -### -SearchForward -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -SortOrder -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. - -```yaml -Type: QueueViewerSortOrderEntry[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d6020f77-c852-46f6-b7c5-5ca6feae0fdf.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrace.md b/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrace.md deleted file mode 100644 index b505d978d5..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTrace.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MessageTrace -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MessageTrace - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MessageTrace [-EndDate <DateTime>] [-Expression <Expression>] [-FromIP <String>] - [-MessageId <MultiValuedProperty>] [-MessageTraceId <Guid>] [-Page <Int32>] [-PageSize <Int32>] - [-ProbeTag <String>] [-RecipientAddress <MultiValuedProperty>] [-SenderAddress <MultiValuedProperty>] - [-StartDate <DateTime>] [-Status <MultiValuedProperty>] [-ToIP <String>] [<CommonParameters>] -``` - -## 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 time period that's older than 10 days, you won't receive an error, but the command will return no results. To search for message data that's between 10 and 90 days old, use the Start-HistoricalSearch and Get-HistoricalSearch cmdlets. - -This cmdlet returns a maximum of 1000000 results, and will timeout on very large queries. If your query returns too many results, consider splitting it up using smaller StartDate and EndDate intervals. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MessageTrace -SenderAddress john@contoso.com -StartDate 06/13/2018 -EndDate 06/15/2018 -``` - -This example retrieves message trace information for messages sent by john@contoso.com between June 13, 2018 and June 15, 2018. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromIP -The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. For outgoing messages from Exchange Online, the value is blank. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Status -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. - -- Failed: Message delivery was attempted and it failed or the message was filtered as spam or malware, or by transport rules. - -- Pending: Message delivery is underway or was deferred and is being retried. - -- 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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToIP -The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5e5134f2-b887-4840-9dff-cea9ec8fde72.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/mail-flow/Get-MessageTraceDetail.md deleted file mode 100644 index 7d238d0829..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-MessageTraceDetail.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-MessageTraceDetail -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MessageTraceDetail - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MessageTraceDetail [-Action <MultiValuedProperty>] [-EndDate <DateTime>] [-Event <MultiValuedProperty>] - [-Expression <Expression>] [-MessageId <String>] [-MessageTraceId <Guid>] [-Page <Int32>] [-PageSize <Int32>] - [-ProbeTag <String>] [-RecipientAddress <String>] [-SenderAddress <String>] [-StartDate <DateTime>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MessageTrace -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress john@contoso.com -StartDate 06/13/2018 -EndDate 06/15/2018 | Get-MessageTraceDetail -``` - -This example uses the Get-MessageTrace cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f send by john@contoso.com between June 13, 2018 and June 15, 2018, and pipelines the results to the Get-MessageTraceDetail cmdlet. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Event -The Event parameter filters the report by the message event. The following are examples of common events: - -- RECEIVE: The message was received by the service. - -- SEND: The message was sent by the service. - -- FAIL: The message failed to be delivered. - -- DELIVER: The message was delivered to a mailbox. - -- EXPAND: The message was sent to a distribution group that was expanded. - -- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. - -- DEFER: The message delivery was postponed and may be re-attempted later. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/27e9b80c-66db-4038-b93e-edd68fe86a12.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-NetworkConnectionInfo.md b/exchange/exchange-ps/exchange/mail-flow/Get-NetworkConnectionInfo.md deleted file mode 100644 index ba16021441..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-NetworkConnectionInfo.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-NetworkConnectionInfo -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-NetworkConnectionInfo - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-NetworkConnectionInfo cmdlet to view the network configuration information for all network adapters configured on the local server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-NetworkConnectionInfo [[-Identity] <ServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the following configuration information for each network adapter configured on the server: - -- Name: This field displays the name of the network adapter. This name indicates the manufacturer and model of the network adapter or the administrator-specified name of the network adapter. - -- DnsServers: This field displays the DNS servers used by the network adapter. The server names are separated by commas. - -- IPAddresses: This field displays the IP addresses used by the network adapter. The IP addresses are separated by commas. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-NetworkConnectionInfo Mailbox01 -``` - -This example retrieves network configuration information for all network adapters on the server named Mailbox01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the server you want to query. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use the Identity parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/72b8e608-1c1a-4e6f-a2db-27a812f185f3.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-OutboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-OutboundConnector.md deleted file mode 100644 index 9d5bb39d50..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-OutboundConnector.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-OutboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-OutboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-OutboundConnector cmdlet to view the configuration information for an Outbound connector in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OutboundConnector [[-Identity] <OutboundConnectorIdParameter>] - [-IncludeTestModeConnectors <$true | $false>] [-IsTransportRuleScoped <$true | $false>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OutboundConnector "Contoso Outbound Connector" | Format-List -``` - -This example displays detailed information about the Outbound connector named Contoso Outbound Connector. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OutboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeTestModeConnectors -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. - -You configure an Outbound connector in test mode by using the TestMode parameter on the New-OutboundConnector or Set-OutboundConnector cmdlets. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsTransportRuleScoped -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. - -You scope a transport rule to a specific Outbound connector by using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f9140086-9f74-4446-b1e7-b195300da122.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-QueueDigest.md b/exchange/exchange-ps/exchange/mail-flow/Get-QueueDigest.md deleted file mode 100644 index 3fc70b5165..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-QueueDigest.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-QueueDigest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-QueueDigest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-QueueDigest cmdlet to view information about message delivery queues across database availability groups (DAGs) Active Directory sites, or Active Directory forests in your organization. - -By default, the Get-QueueDigest cmdlet displays delivery queues that contain ten or more messages, and the results are between one and two minutes old. For instructions on how to change these default values, see Configure Get-QueueDigest. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Dag -``` -Get-QueueDigest -Dag <MultiValuedProperty> - [-DetailsLevel <None | Normal | Verbose>] - [-Filter <String>] - [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>] - [-IncludeE14Servers] - [-ResultSize <Unlimited>] - [-Timeout <EnhancedTimeSpan>] [<CommonParameters>] -``` - -### Forest -``` -Get-QueueDigest [-Forest] - [-DetailsLevel <None | Normal | Verbose>] - [-Filter <String>] - [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>] - [-IncludeE14Servers] - [-ResultSize <Unlimited>] - [-Timeout <EnhancedTimeSpan>] [<CommonParameters>] -``` - -### Server -``` -Get-QueueDigest -Server <MultiValuedProperty> - [-DetailsLevel <None | Normal | Verbose>] - [-Filter <String>] - [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>] - [-IncludeE14Servers] - [-ResultSize <Unlimited>] - [-Timeout <EnhancedTimeSpan>] [<CommonParameters>] -``` - -### Site -``` -Get-QueueDigest -Site <MultiValuedProperty> - [-DetailsLevel <None | Normal | Verbose>] - [-Filter <String>] - [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>] - [-IncludeE14Servers] - [-ResultSize <Unlimited>] - [-Timeout <EnhancedTimeSpan>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-QueueDigest -Forest -``` - -This example returns information about all queues in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-QueueDigest -Dag DAG01 -``` - -This example returns information about all queues in the DAG named DAG01. - -## PARAMETERS - -### -Dag -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Dag -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Forest -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Forest -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Site -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Site -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DetailsLevel -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: None | Normal | Verbose -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value, for example, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue properties (https://technet.microsoft.com/library/bb125237.aspx) and Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -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 ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupBy -The GroupedBy parameter sorts the messages in the delivery queue results. Valid values for this parameter are: - -- DeliveryType - -- LastError - -- NextHopCategory - -- NextHopDomain - -- NextHopKey - -- RiskLevel - -- Status - -- ServerName - -- OutboundIPPool - -The default value is NextHopDomain. - -```yaml -Type: NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeE14Servers -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -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. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/64a6d710-0297-453b-aa35-3ae0a65bd81e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-ReceiveConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-ReceiveConnector.md deleted file mode 100644 index 138210a0c7..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-ReceiveConnector.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ReceiveConnector -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ReceiveConnector - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ReceiveConnector cmdlet to view Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-ReceiveConnector [[-Identity] <ReceiveConnectorIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Server -``` -Get-ReceiveConnector [-Server <ServerIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ReceiveConnector -Server Exchange01 -``` - -This example returns a summary list of all Receive connectors on the server named Exchange01. - -### -------------------------- Example 2 -------------------------- -``` -Get-ReceiveConnector -Identity "Receive Connector for Contoso.com" | Format-List -``` - -This example displays detailed information for the Receive connector named Receive Connector for Contoso.com on the local server. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Receive connector that you want to view. You can use any value that uniquely identifies the Receive connector. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- \<ServerName\>\\\<Name\> - -You can't use this parameter with the Server parameter. - -```yaml -Type: ReceiveConnectorIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameter filters the results by the specified Mailbox server or Edge Transport server. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -You can't use this parameter with the Identity parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6801411c-6faf-449f-aa8b-f4c105791d89.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-RemoteDomain.md b/exchange/exchange-ps/exchange/mail-flow/Get-RemoteDomain.md deleted file mode 100644 index 1e8a115fa1..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-RemoteDomain.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RemoteDomain -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-RemoteDomain cmdlet to view the configuration information for the remote domains configured in your organization. You can view the remote domain configuration from inside the Exchange organization or from an Edge Transport server in the perimeter network. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RemoteDomain [[-Identity] <RemoteDomainIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RemoteDomain -``` - -This example returns a summary list of all remote domains in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-RemoteDomain -Identity Contoso | Format-List -``` - -This example returns detailed information for the remote domain named Contoso. - -### -------------------------- Example 3 -------------------------- -``` -Get-RemoteDomain | Where {$_.TNEFEnabled -eq $false} -``` - -This example returns all domains where Transport Neutral Encapsulation Format (TNEF) encoding isn't used. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: RemoteDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/183b2f07-4225-4ef3-96c8-d29269730d18.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-ResubmitRequest.md b/exchange/exchange-ps/exchange/mail-flow/Get-ResubmitRequest.md deleted file mode 100644 index 0721a5a134..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-ResubmitRequest.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ResubmitRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ResubmitRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ResubmitRequest cmdlet to view requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ResubmitRequest [[-Identity] <ResubmitRequestIdentityParameter>] [-Server <ServerIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ResubmitRequest -``` - -This example returns the details of all resubmit requests. - -### -------------------------- Example 2 -------------------------- -``` -Get-ResubmitRequest 1 -``` - -This example returns details about the resubmit request with the identity 1. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0233fee8-f61b-4ccd-9793-ecf6743abc3e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-RoutingGroupConnector.md deleted file mode 100644 index f5d0f5fab1..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-RoutingGroupConnector.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010 -title: Get-RoutingGroupConnector -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-RoutingGroupConnector - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-RoutingGroupConnector cmdlet to view the configuration details of the routing group connectors in a Microsoft Exchange Server 2010 organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RoutingGroupConnector [[-Identity] <RoutingGroupConnectorIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RoutingGroupConnector -Identity "Exchange Administrative Group (FYDIBOHF23SPDLT)\Exchange Routing Group (DWBGZMFD01QNBJR)\Ex2010 to Ex2003 RGC" -``` - -This example displays detailed configuration information for the routing group connector Ex2010 to Ex2003 RGC. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. You can use the wildcard character (\*) as part of the administrative group or routing group name. - -```yaml -Type: RoutingGroupConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2d68242a-8aaf-43c8-a1ae-eab561391a72.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-SendConnector.md b/exchange/exchange-ps/exchange/mail-flow/Get-SendConnector.md deleted file mode 100644 index ef232d48b7..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-SendConnector.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SendConnector -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-SendConnector - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-SendConnector cmdlet to view the settings for a Send connector. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SendConnector [[-Identity] <SendConnectorIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SendConnector "Contoso.com Send Connector" | Format-List -``` - -This example displays detailed information about the Send connector named Contoso.com Send Connector. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ca71bbd3-14db-4196-a265-0938efead108.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-SystemMessage.md b/exchange/exchange-ps/exchange/mail-flow/Get-SystemMessage.md deleted file mode 100644 index 3c672875ae..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-SystemMessage.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SystemMessage -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-SystemMessage - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-SystemMessage cmdlet to view default or custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-SystemMessage [[-Identity] <SystemMessageIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Original -``` -Get-SystemMessage [-Original] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SystemMessage -``` - -This example displays a summary list of all custom system messages in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-SystemMessage En\Internal\5.3.2 | Format-List -``` - -This example displays detailed information for the specified custom NDR (combination of language, audience, and enhanced status code values). - -### -------------------------- Example 3 -------------------------- -``` -Get-SystemMessage En\WarningMailbox | Format-List -``` - -This example displays detailed information for the specified custom quota message (combination of language and quota values). - -### -------------------------- Example 4 -------------------------- -``` -Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html > "C:\My Documents\Default System Messages.html" -``` - -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. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -TheIdentity parameter specifies the custom system message that you want to view. You can use any value that uniquely identifies the system message. For example: - -- Identity - -- Distinguished name (DN) - -- GUID - -You can't use this parameter with the Original switch. - -The identity value of a system message uses one of these formats: - -- System messages for enhanced status codes:\<Language\>\\\<Internal | External\>\\\<DSNcode\>. For example, En\\Internal\\5.1.2 or Ja\\External\\5.1.2. - -- System messages for quotas:\<Language\>\\\<QuotaMessageType\>. For example, En\\ProhibitSendReceiveMailBox. - -\<Language\>: For the list of supported language codes, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). - -\<DSNcode\>: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. - -\<QuotaMessageType\>: Valid value are: - -Mailbox size quotas: - -- ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - -- ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - -- WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - -- WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - -Public folder size quotas: - -- ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. - -- WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. - -- WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. - -Maximum number of messages in a mailbox folder: - -- ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. - -- WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. - -- WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. - -Maximum number of subfolders in a mailbox folder: - -- ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. - -- WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. - -- WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. - -- ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. - -- WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. - -- WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. - -Maximum number of levels (depth) in a mailbox folder: - -- ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. - -- WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. - -- WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. - -```yaml -Type: SystemMessageIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Original -The Original switch filters the results by the default system messages that are included with Exchange. You don't need to specify a value with this switch. - -You can't use this switch with the Identity parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Original -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/54d3650c-fd80-43c0-a64f-41d57673ff8b.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-TransportAgent.md b/exchange/exchange-ps/exchange/mail-flow/Get-TransportAgent.md deleted file mode 100644 index 19a7864b47..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-TransportAgent.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportAgent -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-TransportAgent - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-TransportAgent cmdlet to view the configuration of a transport agent. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportAgent [[-Identity] <TransportAgentObjectId>] [-DomainController <Fqdn>] - [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportAgent -``` - -This example displays a summary list of all transport agents installed on all Exchange servers in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportAgent "Transport Rule Agent" -TransportService Hub | Format-List -``` - -This example displays detailed information about the Transport Rule agent that's installed in the Transport service on a Mailbox server. The output of the Get-TransportAgent command is piped to the Format-List command to display the detailed configuration of the transport agent. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TransportService -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. - -- MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers. - -- MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers. - -- FrontEnd for the Front End Transport service on Mailbox servers. - -- Edge on Edge Transport servers. - -```yaml -Type: Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/83417504-5d52-43b2-8cf5-e48acae72e3a.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-TransportConfig.md b/exchange/exchange-ps/exchange/mail-flow/Get-TransportConfig.md deleted file mode 100644 index 830263f815..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-TransportConfig.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-TransportConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-TransportConfig cmdlet to view organization-wide transport configuration settings. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportConfig [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportConfig -``` - -This example lists the organization-wide transport settings on Mailbox server, or the local transport settings on an Edge Transport server. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportConfig | Format-List *DSN* -``` - -This example lists all delivery status notification-related (DSN) configuration settings for your organization when run on a Mailbox server. When run on an Edge Transport server, it displays the DSN-related settings configured on that Edge Transport server. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8f54a77c-7a5c-446f-b661-022c7e53f5c0.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-TransportPipeline.md b/exchange/exchange-ps/exchange/mail-flow/Get-TransportPipeline.md deleted file mode 100644 index 2f91c8ff04..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-TransportPipeline.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportPipeline -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-TransportPipeline - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-TransportPipeline cmdlet to view transport agents and the SMTP event where the transport agent is registered. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportPipeline [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-TransportPipeline cmdlet enables you to view all the transport agents that are configured in the following locations: - -- In the Transport service on Mailbox servers. - -- In the Front End Transport service on Mailbox servers. - -- On Edge Transport server in the perimeter network. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportPipeline -``` - -This example returns a summary list of all agents in the transport pipeline that were involved in processing email messages since the last server or service restart. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportPipeline | Format-List -``` - -This example returns a list of agents registered in the transport pipeline, with full details for each transport event. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b5741539-21d0-475d-b4a7-c6355d7b1c0b.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-TransportServer.md b/exchange/exchange-ps/exchange/mail-flow/Get-TransportServer.md deleted file mode 100644 index 6b1f03141f..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-TransportServer.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-TransportServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-TransportServer cmdlet to view settings that are associated with the Hub Transport server role or the Edge Transport server role. - -Note: In Exchange 2013 or later, use the Get-TransportService cmdlet instead. If you have scripts that use Get-TransportServer, update them to use Get-TransportService. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportServer [[-Identity] <TransportServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportServer -``` - -This example provides different results depending on the server role on which it's run. When you run this command on an Edge Transport server, it provides a configuration summary for the local server. Otherwise, it displays a list of all Mailbox servers in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportServer Mailbox01 | Format-List -``` - -This example retrieves the detailed transport configuration information for the Transport service on the Mailbox server named Mailbox01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the server you want to view. When you use this parameter on a Mailbox server, the parameter returns the transport configuration of the Transport service on specified server. You can't use this parameter on an Edge Transport server. - -```yaml -Type: TransportServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fd4f9f4a-338d-44de-b5e8-e91bae697d4f.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-TransportService.md b/exchange/exchange-ps/exchange/mail-flow/Get-TransportService.md deleted file mode 100644 index fd867d476f..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-TransportService.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-TransportService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-TransportService cmdlet to view the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportService [[-Identity] <TransportServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportService -``` - -This example provides different results depending on the server role on which it's run. When you run this command on an Edge Transport server, it provides a configuration summary for the local server. Otherwise, it displays a list of all Mailbox servers in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportService Mailbox1 | Format-List -``` - -This example retrieves the detailed transport configuration information for the Transport service on the Mailbox server named Mailbox1. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the server you want to view. When you use this parameter on a Mailbox server, the parameter returns the transport configuration of the Transport service on the specified server. You can't use this parameter on an Edge Transport server. - -```yaml -Type: TransportServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bcedb558-4caf-482f-8be3-30e1793ba103.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Get-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/mail-flow/Get-X400AuthoritativeDomain.md deleted file mode 100644 index 787c83ca51..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Get-X400AuthoritativeDomain.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-X400AuthoritativeDomain -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-X400AuthoritativeDomain - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-X400AuthoritativeDomain [[-Identity] <X400AuthoritativeDomainIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-X400AuthoritativeDomain "Europe Sales X.400 Domain" | Format-List -``` - -This example displays detailed information about the X.400 authoritative domain Europe Sales X.400 Domain. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a14fa481-2d32-4031-bc9b-098bd4108118.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-InboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/New-InboundConnector.md deleted file mode 100644 index 03edb6b03f..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/New-InboundConnector.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-InboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-InboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-InboundConnector cmdlet to create a new Inbound connector in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-InboundConnector [-Name] <String> -SenderDomains <MultiValuedProperty> - [-AssociatedAcceptedDomains <MultiValuedProperty>] [-CloudServicesMailEnabled <$true | $false>] - [-Comment <String>] [-Confirm] [-ConnectorSource <Default | Migrated | HybridWizard | AdminUI>] - [-ConnectorType <OnPremises | Partner>] [-Enabled <$true | $false>] [-RequireTls <$true | $false>] - [-RestrictDomainsToCertificate <$true | $false>] [-RestrictDomainsToIPAddresses <$true | $false>] - [-SenderIPAddresses <MultiValuedProperty>] [-TlsSenderCertificateName <TlsCertificate>] - [-TreatMessagesAsInternal <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-InboundConnector -Name "Contoso Inbound Connector" -SenderDomains *.contoso.com -SenderIPAddresses 192.168.0.1/25 -RestrictDomainstoIPAddresses $true -``` - -This example creates the Inbound connector named Contoso Inbound Connector with the following properties: - -- It listens for incoming connections from the domain contoso.com and all subdomains. - -- It only accepts mail from contoso.com, and from the IP range 192.168.0.1/25. It rejects mail from contoso.com if it originates from any other IP address. - -### -------------------------- Example 2 -------------------------- -``` -New-InboundConnector -Name "Contoso Inbound Secure Connector" -SenderDomains *.contoso.com -SenderIPAddresses 192.168.0.1/25 -RestrictDomainstoIPAddresses $true -RequireTLS $true -TlsSenderCertificateName *.contoso.com -``` - -This example creates the Inbound connector named Contoso Inbound Secure Connector and requires TLS transmission for all messages. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderDomains -The SenderDomains parameter specifies the remote domains from which this connector accepts messages, thereby limiting its scope. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. You can specify multiple domains separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssociatedAcceptedDomains -The AssociatedAcceptedDomains parameter specifies the accepted domains that the connector applies to, thereby limiting its scope. For example, you can apply the connector to a specific accepted domain in your organization, such as contoso.com. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx). - -The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSource -The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: - -- Default: The connector is manually created. - -- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - -- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. - -The default value for connectors you create yourself is Default. It isn't recommended that you change this value. - -```yaml -Type: Default | Migrated | HybridWizard | AdminUI -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorType -The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values: - -- Partner: The connector services domains that are external to your organization. - -- OnPremises: The connector services domains that are used by your on-premises organization. Use this value for accepted domains in your cloud-based organization that are also specified by the SenderDomains parameter. - -```yaml -Type: OnPremises | Partner -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireTls -The RequireTLS parameter specifies that all messages received by this connector require TLS transmission. Valid values for this parameter are $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictDomainsToCertificate -The RestrictDomainsToCertificate parameter specifies that Office 365 should identify incoming messages that are eligible for this connector by verifying that the remote server authenticates using a TLS certificate that has the TlsSenderCertificateName in the Subject. Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictDomainsToIPAddresses -The RestrictDomainsToIPAddresses parameter, when set to $true, automatically rejects mail from the domains specified by the SenderDomains parameter if the mail originates from an IP address that isn't specified by the SenderIPAddresses parameter. - -Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderIPAddresses -The SenderIPAddresses parameter specifies the remote IP addresses from which this connector accepts messages. You enter the IP addresses using the following syntax: - -- Single IP: For example, 192.168.1.1. - -- CIDR IP: You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. - -You can specify multiple IP addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsSenderCertificateName -The TlsSenderCertificateName parameter specifies the certificate used by the sender's domain when the RequireTls parameter is set to $true. Valid input for the TlsSenderCertificateName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. - -You can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. - -```yaml -Type: TlsCertificate -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatMessagesAsInternal -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 Office 365. This setting allows internal mail flow between Office 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. - -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 Office 365 and the Send connector in the on-premises Exchange organization (the CloudServicesMailEnabled parameter). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c8d0cba8-a8cb-41dc-b3fe-11d5882e425b.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/New-OutboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/New-OutboundConnector.md deleted file mode 100644 index 822584ba4b..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/New-OutboundConnector.md +++ /dev/null @@ -1,396 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: New-OutboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# New-OutboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-OutboundConnector cmdlet to create a new Outbound connector in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-OutboundConnector [-Name] <String> [-AllAcceptedDomains <$true | $false>] - [-CloudServicesMailEnabled <$true | $false>] [-Comment <String>] [-Confirm] - [-ConnectorSource <Default | Migrated | HybridWizard | AdminUI>] [-ConnectorType <OnPremises | Partner>] - [-Enabled <$true | $false>] [-IsTransportRuleScoped <$true | $false>] [-LinkForModifiedConnector <Guid>] - [-RecipientDomains <MultiValuedProperty>] [-RouteAllMessagesViaOnPremises <$true | $false>] - [-SmartHosts <MultiValuedProperty>] [-TestMode <$true | $false>] [-TlsDomain <SmtpDomainWithSubdomains>] - [-TlsSettings <EncryptionOnly | CertificateValidation | DomainValidation>] [-UseMXRecord <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-OutboundConnector -Name "Contoso Outbound Connector" -RecipientDomains *.contoso.com -TlsSettings DomainValidation -TlsDomain *.contoso.com -``` - -This example creates the Outbound connector named Contoso Outbound Connector with the following properties: - -- It sends messages to recipients in the contoso.com domain and all subdomains. - -- It uses TLS encryption and certificate verification for mail routed to the contoso.com domain and all subdomains - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllAcceptedDomains -The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: - -- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. You can only use this value when the ConnectorType parameter value is OnPremises. - -- $false: The Outbound connector isn't used in hybrid organizations. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx). - -The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSource -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. - -- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - -- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. - -```yaml -Type: Default | Migrated | HybridWizard | AdminUI -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorType -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. - -- OnPremises: The connector services domains that are used by your on-premises organization. - -```yaml -Type: OnPremises | Partner -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: - -- $true: The connector is enabled. This is the default value. - -- $false: The connector is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsTransportRuleScoped -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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkForModifiedConnector -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomains -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteAllMessagesViaOnPremises -The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises messaging system in hybrid organizations. Valid values are: - -- $true: Messages are routed through the on-premises messaging system. This setting requires you to set the ConnectorType parameter to the value OnPremises in the same command. - -- $false: Messages aren't routed through the on-premises messaging system. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartHosts -The SmartHosts parameter specifies the smart hosts the Outbound connector uses to route mail. This parameter is required if you set the UseMxRecord parameter to $false and 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. Separate each value by using a comma. If you enter an IP address, you may enter the IP address as a literal, for example: 10.10.1.1, or using Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. The smart host identity can be the FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestMode -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsDomain -The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsSettings parameter is set to DomainValidation. Valid input for the TlsDomain parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com - -```yaml -Type: SmtpDomainWithSubdomains -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsSettings -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. - -```yaml -Type: EncryptionOnly | CertificateValidation | DomainValidation -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMXRecord -The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: - -- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. - -- $false: The connector delivers email to one or more smart hosts. When you use this value, you also need to specifiy the smart hosts by using the SmartHosts parameter in the same command. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ca73d195-542f-4acf-b2ff-84275e26a79a.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-EdgeSubscription.md b/exchange/exchange-ps/exchange/mail-flow/Remove-EdgeSubscription.md deleted file mode 100644 index 831641838c..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-EdgeSubscription.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-EdgeSubscription -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-EdgeSubscription - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-EdgeSubscription cmdlet to remove Edge Subscription from the Exchange organization and from the subscribed Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-EdgeSubscription [-Identity] <TransportServerIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you remove an Edge Subscription, the following changes are made: - -- Synchronization of information from Active Directory to the Active Directory Lightweight Directory Services (AD LDS) instance stops. - -- All the accounts stored in AD LDS are removed. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-EdgeSubscription -Identity Edge1 -``` - -This example removes Edge Subscription for the Edge Transport server named Edge1. - -## PARAMETERS - -### -Identity -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 -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -If you don't specify the Force switch, the command will inform you that the removal of the replicated recipient data from AD LDS can take a long time and will give you the option to cancel the operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dce6cec3-9fb5-4c5e-b80c-9f9c40de3177.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-InboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Remove-InboundConnector.md deleted file mode 100644 index f4dc81bc08..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-InboundConnector.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-InboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-InboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-InboundConnector cmdlet to delete an Inbound connector from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-InboundConnector [-Identity] <InboundConnectorIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-InboundConnector "Contoso Inbound Connector" -``` - -This example deletes the Inbound connector named Contoso Inbound Connector. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b96b4003-7c16-4039-a1f4-560ba6034cef.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-Message.md b/exchange/exchange-ps/exchange/mail-flow/Remove-Message.md deleted file mode 100644 index 5d71e7723a..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-Message.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-Message -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-Message - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-Message cmdlet to delete a message from a queue on a Mailbox server or an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filter -``` -Remove-Message -Filter <String> [-Server <ServerIdParameter>] - [-Confirm] - [-WhatIf] - [-WithNDR <$true | $false>] [<CommonParameters>] -``` - -### Identity -``` -Remove-Message [-Identity] <MessageIdentity> - [-Confirm] - [-WhatIf] - [-WithNDR <$true | $false>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-Message -Server Server1 -Filter {FromAddress -eq "Kweku@contoso.com"} -WithNDR $false -``` - -This example removes all messages that meet the following criteria without generating NDRs: - -- The messages are sent by the sender Kweku@contoso.com. - -- The messages are queued on the server Server1. - -## PARAMETERS - -### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value, for example, {FromAddress -like "\*@contoso.com"}. For details about filterable message properties and comparison operators, see Properties of messages in queues (https://technet.microsoft.com/library/bb123714.aspx) and https://technet.microsoft.com/library/aa998047.aspx (Find queues and messages in queues in the Exchange Management Shell). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see the "Message identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: MessageIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -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 -``` - -### -WithNDR -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/15d5987b-bedd-437e-b86a-6b0e80619fde.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-OutboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Remove-OutboundConnector.md deleted file mode 100644 index 8c8806b619..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-OutboundConnector.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Remove-OutboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Remove-OutboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-OutboundConnector cmdlet to delete an Outbound connector from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OutboundConnector [-Identity] <OutboundConnectorIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OutboundConnector "Contoso Outbound Connector" -``` - -This example deletes the Outbound connector named Contoso Outbound Connector. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/08834e46-f181-4d9d-95f4-0d5157e75f2a.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Remove-SystemMessage.md b/exchange/exchange-ps/exchange/mail-flow/Remove-SystemMessage.md deleted file mode 100644 index ecf95208f4..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Remove-SystemMessage.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SystemMessage -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-SystemMessage - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-SystemMessage cmdlet to remove custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SystemMessage [-Identity] <SystemMessageIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SystemMessage En\Internal\5.7.9 -``` - -This example removes the specified custom NDR (combination of language, audience, and enhanced status code values). - -### -------------------------- Example 2 -------------------------- -``` -Remove-SystemMessage En\WarningMailbox -``` - -This example removes the specified custom quota message (combination of language and quota values). - -## PARAMETERS - -### -Identity -TheIdentity parameter specifies the custom system message that you want to remove. You can use any value that uniquely identifies the system message. For example: - -- Identity - -- Distinguished name (DN) - -- GUID - -The identity value of a system message uses one of these formats: - -- System messages for enhanced status codes: \<Language\>\\\<Internal | External\>\\\<DSNcode\>. For example, En\\Internal\\5.1.2 or Ja\\External\\5.1.2. - -- System messages for quotas: \<Language\>\\\<QuotaMessageType\>. For example, En\\ProhibitSendReceiveMailBox. - -\<Language\>: For the list of supported language codes, see Supported languages for system messages (https://technet.microsoft.com/library/bb124759.aspx). - -\<DSNcode\>: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system code values that are currently used by custom system messages, run the command Get-SystemMessage. - -\<QuotaMessageType\>: Valid value are: - -Mailbox size quotas: - -ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - -ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - -WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - -WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - -Public folder size quotas: - -ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. - -WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. - -WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. - -Maximum number of messages in a mailbox folder: - -ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. - -WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. - -WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. - -Maximum number of subfolders in a mailbox folder: - -ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. - -WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. - -WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. - -ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. - -WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. - -WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. - -Maximum number of levels (depth) in a mailbox folder: - -ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. - -WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. - -WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. - -```yaml -Type: SystemMessageIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1566222b-407a-4e78-a0df-5190b23d53da.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Resume-Message.md b/exchange/exchange-ps/exchange/mail-flow/Resume-Message.md deleted file mode 100644 index 716a060a2c..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Resume-Message.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-Message -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Resume-Message - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Resume-Message cmdlet to enable delivery of a previously suspended message in a queue on a Mailbox server or Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filter -``` -Resume-Message -Filter <String> [-Server <ServerIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Resume-Message [-Identity] <MessageIdentity> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-Message -Server Server1 -Filter {FromAddress -eq "kweku@contoso.com" -and ExpirationTime -lt "1/5/2013 3:00 PM"} -``` - -This example resumes delivery of all messages in a suspended state and for which the following conditions are true: - -- 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, 2013. - -## PARAMETERS - -### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value, for example, {FromAddress -like "\*@contoso.com"}. For details about filterable message properties and comparison operators, see Properties of messages in queues (https://technet.microsoft.com/library/bb123714.aspx) and https://technet.microsoft.com/library/aa998047.aspx (Find queues and messages in queues in the Exchange Management Shell). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see the "Message identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: MessageIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c15f872c-af1b-48ca-b95d-cca1b0a78977.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Resume-Queue.md b/exchange/exchange-ps/exchange/mail-flow/Resume-Queue.md deleted file mode 100644 index 9505f2b418..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Resume-Queue.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-Queue -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Resume-Queue - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Resume-Queue cmdlet to restart processing for a suspended queue on a Mailbox server or an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filter -``` -Resume-Queue -Filter <String> [-Server <ServerIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Resume-Queue [-Identity] <QueueIdentity> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-Queue -Server Server1.contoso.com -Filter {NextHopDomain -eq "Fourthcoffee.com"} -``` - -This example resumes processing of all queues where the NextHopDomain is Fourthcoffee.com on the server Server1.contoso.com. - -## PARAMETERS - -### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value, for example, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue properties (https://technet.microsoft.com/library/bb125237.aspx) and Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: QueueIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ca3da195-5f4f-45b4-9941-ee6aec79ea3d.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Retry-Queue.md b/exchange/exchange-ps/exchange/mail-flow/Retry-Queue.md deleted file mode 100644 index 1d45a80d24..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Retry-Queue.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Retry-Queue -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Retry-Queue - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Retry-Queue cmdlet to force a connection attempt for a queue on a Mailbox server or an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filter -``` -Retry-Queue -Filter <String> [-Server <ServerIdParameter>] - [-Confirm] - [-Resubmit <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Retry-Queue [-Identity] <QueueIdentity> - [-Confirm] - [-Resubmit <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Retry-Queue -Filter {NextHopDomain -eq "contoso.com" -and Status -eq "Retry"} -``` - -This example forces a connection attempt for all queues that meet the following criteria: - -- The queues are holding messages for the domain contoso.com. - -- The queues have a status of Retry. - -- The queues are located on the server on which the command is executed. - -## PARAMETERS - -### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value, for example, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue properties (https://technet.microsoft.com/library/bb125237.aspx) and Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: QueueIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 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 -``` - -### -Resubmit -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a75a524b-2491-47b2-83e6-922cd0887c6d.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/mail-flow/Set-AcceptedDomain.md deleted file mode 100644 index 8558d174b6..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Set-AcceptedDomain.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-AcceptedDomain cmdlet to modify existing accepted domains in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AcceptedDomain [-Identity] <AcceptedDomainIdParameter> [-AddressBookEnabled <$true | $false>] - [-Confirm] [-DomainController <Fqdn>] - [-DomainType <Authoritative | ExternalRelay | InternalRelay>] - [-MakeDefault <$true | $false>] [-Name <String>] - [-OutboundOnly <$true | $false>] [-PendingRemoval <$true | $false>] [-WhatIf] - [-EnableNego2Authentication <$true | $false>] [-MatchSubDomains <$true | $false>] - [-PendingCompletion <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AcceptedDomain -Identity Contoso -MakeDefault $true -``` - -This example makes the accepted domain Contoso the default accepted domain. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddressBookEnabled -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: - -- $true for authoritative domains. - -- $false for internal relay domains. - -- $false for external relay domains. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainType -The DomainType parameter specifies the accepted domain type. Valid values are: - -- Authoritative: This is the default value. Your organization is completely responsible for delivering email to recipients in the domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients. - -- InternalRelay: This is a type of non-authoritative domain. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external messaging system that's under your control. The external messaging system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the domain as internal messages. - -- ExternalRelay: This is a type of non-authoritative domain that's available only in on-premises Exchange organizations. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external messaging system that's completely outside of your control. The external messaging system is responsible for generating NDRs for unresolved recipients. - -Note: - -For the value InternalRelay or ExternalRelay you typically use mail users or mail contacts to relay the messages to the external messaging system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations. - -```yaml -Type: Authoritative | ExternalRelay | InternalRelay -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeDefault -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. - -- $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. - -If you don't use non-SMTP email addresses in your organization, you don't need to worry about the value of this parameter. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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 ("). - -```yaml -Type: String -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 -``` - -### -OutboundOnly -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PendingRemoval -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableNego2Authentication -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchSubDomains -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PendingCompletion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2ef9a20b-0974-45d0-9dae-23bab22d736e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-InboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Set-InboundConnector.md deleted file mode 100644 index f0eccaad7d..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Set-InboundConnector.md +++ /dev/null @@ -1,365 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-InboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-InboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-InboundConnector cmdlet to change an existing Inbound connector in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-InboundConnector [-Identity] <InboundConnectorIdParameter> - [-AssociatedAcceptedDomains <MultiValuedProperty>] [-CloudServicesMailEnabled <$true | $false>] - [-Comment <String>] [-Confirm] [-ConnectorSource <Default | Migrated | HybridWizard | AdminUI>] - [-ConnectorType <OnPremises | Partner>] [-Enabled <$true | $false>] [-Name <String>] - [-RequireTls <$true | $false>] [-RestrictDomainsToCertificate <$true | $false>] - [-RestrictDomainsToIPAddresses <$true | $false>] [-SenderDomains <MultiValuedProperty>] - [-SenderIPAddresses <MultiValuedProperty>] [-TlsSenderCertificateName <TlsCertificate>] - [-TreatMessagesAsInternal <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-InboundConnector "Contoso Inbound Connector" -RequireTls $true -TlsSenderCertificateName contoso.com -``` - -This example makes the following configuration changes to the existing Inbound connector named Contoso.com Inbound Connector. - -Require TLS transmission for all incoming messages on the connector. - -Require that the TLS certificate that is used to encrypt communications contain the domain name contoso.com - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AssociatedAcceptedDomains -The AssociatedAcceptedDomains parameter specifies the accepted domains that the connector applies to, thereby limiting its scope. For example, you can apply the connector to a specific accepted domain in your organization, such as contoso.com. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx). - -The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSource -The ConnectorSource parameter specifies how the connector was created. Valid input for this parameter includes the following values: - -- Default: The connector is manually created. - -- HybridWizard: The connector is created automatically by the Hybrid Configuration Wizard. - -- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. - -The default value for connectors you create is Default. It isn't recommended that you change this value. - -```yaml -Type: Default | Migrated | HybridWizard | AdminUI -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorType -The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values: - -- Partner: The connector services domains that are external to your organization. - -- OnPremises: The connector services domains that are used by your on-premises organization. Use this value for accepted domains in your cloud-based organization that are also specified by the SenderDomains parameter. - -```yaml -Type: OnPremises | Partner -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a descriptive name for the connector. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireTls -The RequireTLS parameter specifies that all messages received by this connector require TLS transmission. Valid values for this parameter are $true or $false. The default value is $false. When the RequireTLS parameter is set to $true, all messages received by this connector require TLS transmission. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictDomainsToCertificate -The RestrictDomainsToCertificate parameter specifies that Office 365 should identify incoming messages that are eligible for this connector by verifying that the remote server authenticates using a TLS certificate that has the TlsSenderCertificateName in the Subject. Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictDomainsToIPAddresses -The RestrictDomainsToIPAddresses parameter, when set to $true, automatically rejects mail from the domains specified by the SenderDomains parameter if the mail originates from an IP address that isn't specified by the SenderIPAddresses parameter. - -Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderDomains -The SenderDomains parameter specifies the remote domains from which this connector accepts messages, thereby limiting its scope. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. - -You can specify multiple domains separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderIPAddresses -The SenderIPAddresses parameter specifies the remote IP addresses from which this connector accepts messages. You enter the IP addresses using the following syntax: - -- Single IP: For example, 192.168.1.1. - -- CIDR IP: You can use Classless InterDomain Routing (CIDR). For example, 192.168.0.1/25. - -You can specify multiple IP addresses separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsSenderCertificateName -The TlsSenderCertificateName parameter specifies the certificate used by the sender's domain when the RequireTls parameter is set to $true. Valid input for the TlsSenderCertificateName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. - -You can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. - -```yaml -Type: TlsCertificate -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatMessagesAsInternal -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 Office 365. This setting allows internal mail flow between Office 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. - -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 Office 365 and the Send connector in the on-premises Exchange organization (the CloudServicesMailEnabled parameter). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d21f091-def4-49a8-ab44-d36b9a12499d.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Set-OutboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Set-OutboundConnector.md deleted file mode 100644 index dab7c02b97..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Set-OutboundConnector.md +++ /dev/null @@ -1,454 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Set-OutboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Set-OutboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-OutboundConnector cmdlet to modify an existing Outbound connector in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-OutboundConnector [-Identity] <OutboundConnectorIdParameter> [-AllAcceptedDomains <$true | $false>] - [-CloudServicesMailEnabled <$true | $false>] [-Comment <String>] [-Confirm] - [-ConnectorSource <Default | Migrated | HybridWizard | AdminUI>] [-ConnectorType <OnPremises | Partner>] - [-Enabled <$true | $false>] [-IsTransportRuleScoped <$true | $false>] [-IsValidated <$true | $false>] - [-LastValidationTimestamp <DateTime>] [-Name <String>] [-RecipientDomains <MultiValuedProperty>] - [-RouteAllMessagesViaOnPremises <$true | $false>] [-SmartHosts <MultiValuedProperty>] - [-TestMode <$true | $false>] [-TlsDomain <SmtpDomainWithSubdomains>] - [-TlsSettings <EncryptionOnly | CertificateValidation | DomainValidation>] [-UseMXRecord <$true | $false>] - [-ValidationRecipients <String[]>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-OutboundConnector "Contoso Outbound Connector" -UseMxRecord $false -SmartHosts 192.168.0.1 -``` - -This example changes the settings of the existing Outbound connector named Contoso Outbound Connector to route to a smart host at IP address 192.168.0.1. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the connector you want to modify. You can use any value that uniquely identifies the connector. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OutboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllAcceptedDomains -The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: - -- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. You can only use this value when the ConnectorType parameter value is OnPremises. - -- $false: The Outbound connector isn't used in hybrid organizations. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx). - -The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSource -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. - -- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - -- Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. - -```yaml -Type: Default | Migrated | HybridWizard | AdminUI -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorType -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. - -- OnPremises: The connector services domains that are used by your on-premises organization. - -```yaml -Type: OnPremises | Partner -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: - -- $true: The connector is enabled. This is the default value. - -- $false: The connector is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsTransportRuleScoped -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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastValidationTimestamp -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: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomains -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteAllMessagesViaOnPremises -The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises messaging system. Valid values are: - -- $true: Messages are routed through the on-premises messaging system. This setting requires you to set the ConnectorType parameter to the value OnPremises in the same command. - -- $false: Messages aren't routed through the on-premises messaging system. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartHosts -The SmartHosts parameter specifies the smart hosts the Outbound connector uses to route mail. This parameter is required if you set the UseMxRecord parameter to $false and 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. Separate each value by using a comma. If you enter an IP address, you may enter the IP address as a literal, for example: 10.10.1.1, or using Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. The smart host identity can be the FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestMode -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsDomain -The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsSettings parameter is set to DomainValidation. Valid input for the TlsDomain parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com - -```yaml -Type: SmtpDomainWithSubdomains -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TlsSettings -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. - -```yaml -Type: EncryptionOnly | CertificateValidation | DomainValidation -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMXRecord -The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: - -- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. - -- $false: The connector delivers email to one or more smart hosts. When you use this value, you also need to specifiy the smart hosts by using the SmartHosts parameter in the same command. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidationRecipients -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/beba3ca3-6f93-49c5-9ddf-505260655bed.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Start-EdgeSynchronization.md b/exchange/exchange-ps/exchange/mail-flow/Start-EdgeSynchronization.md deleted file mode 100644 index baf28e696e..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Start-EdgeSynchronization.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Start-EdgeSynchronization -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Start-EdgeSynchronization - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Start-EdgeSynchronization cmdlet to immediately start synchronization of configuration data from Active Directory to the subscribed Edge Transport servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-EdgeSynchronization [-Confirm] [-ForceFullSync] [-ForceUpdatecookie] [-Server <ServerIdParameter>] - [-TargetServer <String>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-EdgeSynchronization -Server Mailbox01 -``` - -This example starts edge synchronization on the Mailbox server named Mailbox01. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -ForceFullSync -The ForceFullSync switch specifies whether to initiate a full edge synchronization. If you run the command without this switch, only changes since the last replication are synchronized. If you use this switch, the entire configuration information and recipient data are synchronized. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpdatecookie -The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetServer -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. - -```yaml -Type: String -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 -``` - -### -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 -``` - -### -ForceUpdatecookie -The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7f8240bb-05fa-47c5-adcf-c843dbced0e8.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/mail-flow/Start-HistoricalSearch.md deleted file mode 100644 index 4d9a4341c7..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Start-HistoricalSearch.md +++ /dev/null @@ -1,336 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Start-HistoricalSearch -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Start-HistoricalSearch - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Start-HistoricalSearch cmdlet to start a new historical search. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-HistoricalSearch -EndDate <DateTime> -ReportTitle <String> -ReportType <MessageTrace | MessageTraceDetail | DLP | TransportRule | SPAM | Malware | UnifiedDLP | ATPReport | Spoof | ATPV2> - -StartDate <DateTime> [-DeliveryStatus <String>] - [-Direction <All | Sent | Received>] - [-DLPPolicy <MultiValuedProperty>] - [-Locale <CultureInfo>] - [-MessageID <MultiValuedProperty>] - [-NotifyAddress <MultiValuedProperty>] - [-OriginalClientIP <String>] - [-RecipientAddress <MultiValuedProperty>] - [-SenderAddress <MultiValuedProperty>] - [-TransportRule <MultiValuedProperty>] - [<CommonParameters>] -``` - -## DESCRIPTION -A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are aged between 1-4 hours (depending on your environment) and 90 days old. There is a limit of 250 historical searches that you can submit in a 24 hour period; you'll be warned if you're nearing the daily quota. Cancelled searches count against the daily quota. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2018 -EndDate 1/7/2018 -ReportType MessageTrace -SenderAddress michelle@fabrikam.com -NotifyAddress chris@contoso.com -``` - -This example starts a new historical search named "Fabirkam Search" that has the following properties: - -- Date range: January 1, 2018 to January 7, 2018 - -- Report type: Message trace - -- Sender address: michelle@fabrikam.com - -- Internal notification email address: chris@contoso.com - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ReportTitle -The ReportTitle parameter specifies a descriptive name for the historical search. If the value contains spaces, enclose the value in quotation marks ("). - -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter specifies the type of historical search that you want to perform. You can use one of the following values: - -- ATPReport: Advanced Threat Protection File Types Report and Advanced Threat Protection Message Disposition Report - -- ATPV2: Exchange Online Protection and Advanced Threat Protection E-mail Malware Report. - -- ATPDocument: Advanced Threat Protection Content Malware Report for files in SharePoint, OneDrive and Microsoft Teams. - -- DLP: Data Loss Prevention Report. - -- Malware: Malware Detections Report. - -- MessageTrace: Message Trace Report. - -- MessageTraceDetail: Message Trace Details Report. - -- Phish: Exchange Online Protection and Advanced Threat Protection E-mail Phish Report. - -- SPAM: SPAM Detections Report. - -- Spoof: Spoof Mail Report. - -- TransportRule: Transport or Mail FLow Rules Report. - -- UnifiedDLP: Unified Data Loss Prevention Report. - -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. - -```yaml -Type: MessageTrace | MessageTraceDetail | DLP | TransportRule | SPAM | Malware | UnifiedDLP | ATPReport | Spoof | ATPV2 | Phish | ATPDocument -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DeliveryStatus -The DeliveryStatus parameter filters the results by the delivery status of the message. You can use one of the following values: - -- Delivered - -- Expanded - -- Failed - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by the direction of the message. Valid values are: - -- All: Incoming and outgoing messages. - -- Received: Ingoing messages only. - -- Sent: Outgoing messages only. - -```yaml -Type: All | Sent | Received -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DLPPolicy -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter filters the results by the locale of the message. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageID -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyAddress -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OriginalClientIP -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportRule -The TransportRule parameter filters the results by the name of the transport rule that acted on the message. You can specify multiple transport rules separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9688689c-2953-49de-bb38-eeea10b7f08e.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Stop-HistoricalSearch.md b/exchange/exchange-ps/exchange/mail-flow/Stop-HistoricalSearch.md deleted file mode 100644 index 04b549038b..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Stop-HistoricalSearch.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Stop-HistoricalSearch -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Stop-HistoricalSearch - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Stop-HistoricalSearch cmdlet to stop an existing historical search that has a status value of NotStarted. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Stop-HistoricalSearch -JobId <Guid> [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Stop-HistoricalSearch -JobId f9c66f83-b5c8-4a0c-91f4-a38376f74182 -``` - -This example stops the historical search that has the JobId value f9c66f83-b5c8-4a0c-91f4-a38376f74182. - -## PARAMETERS - -### -JobId -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8868372f-842b-417d-acb2-8c08a914a779.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Suspend-Message.md b/exchange/exchange-ps/exchange/mail-flow/Suspend-Message.md deleted file mode 100644 index 8f4c1e2385..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Suspend-Message.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-Message -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Suspend-Message - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Suspend-Message cmdlet to prevent delivery of a particular message in a queue on a Mailbox server or an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filter -``` -Suspend-Message -Filter <String> [-Server <ServerIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Suspend-Message [-Identity] <MessageIdentity> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## 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 Submission queue or 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Suspend-Message -Server Server1 -Filter {FromAddress -eq "kweku@contoso.com"} -``` - -This example prevents delivery of all messages for which the following conditions are true: - -- The messages are sent by the sender kweku@contoso.com. - -- The messages are queued on the server Server1. - -## PARAMETERS - -### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value, for example, {FromAddress -like "\*@contoso.com"}. For details about filterable message properties and comparison operators, see Properties of messages in queues (https://technet.microsoft.com/library/bb123714.aspx) and https://technet.microsoft.com/library/aa998047.aspx (Find queues and messages in queues in the Exchange Management Shell). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see the "Message identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: MessageIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3c35583b-8691-4ec8-83e3-daa3090a4185.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Suspend-Queue.md b/exchange/exchange-ps/exchange/mail-flow/Suspend-Queue.md deleted file mode 100644 index 94f2aae64d..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Suspend-Queue.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-Queue -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Suspend-Queue - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Suspend-Queue cmdlet to stop processing for a queue on a Mailbox server or an Edge Transport server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filter -``` -Suspend-Queue -Filter <String> [-Server <ServerIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Suspend-Queue [-Identity] <QueueIdentity> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Suspend-Queue -Filter {NextHopDomain -eq "contoso.com" -and Status -eq "Retry"} -``` - -This example suspends processing on all queues holding messages for delivery to the domain contoso.com and that currently have a status of Retry. - -### -------------------------- Example 2 -------------------------- -``` -Suspend-Queue -Server Server1.contoso.com -Filter {MessageCount -gt 100} -``` - -This example suspends processing on all queues on the server Server1.contoso.com that have more than 100 messages in the queue. - -## PARAMETERS - -### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value, for example, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue properties (https://technet.microsoft.com/library/bb125237.aspx) and Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -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 ("). - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx). - -```yaml -Type: QueueIdentity -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command. - -```yaml -Type: ServerIdParameter -Parameter Sets: Filter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7dca48c4-69a1-4157-a50e-88907dd32d04.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Test-SmtpConnectivity.md b/exchange/exchange-ps/exchange/mail-flow/Test-SmtpConnectivity.md deleted file mode 100644 index d373cd9e73..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Test-SmtpConnectivity.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SmtpConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-SmtpConnectivity - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-SmtpConnectivity cmdlet to diagnose whether an SMTP connection can successfully be established to the Receive connectors on a specific server. Although you can run this cmdlet manually to verify SMTP connectivity for a specified server, it's primarily used by Microsoft System Center Operations Manager 2007 to test your transport servers' ability to receive SMTP connections to each of the bindings on all the Receive connectors on those servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-SmtpConnectivity [[-Identity] <ServerIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-MonitoringContext <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you run the Test-SmtpConnectivity cmdlet against a Mailbox server, the cmdlet attempts to establish an SMTP connection to all bindings of all Receive connectors hosted on that server. For each attempt, the cmdlet returns the following information: - -- Server: The name of the server that hosts the Receive connector. - -- ReceiveConnector: The name of the Receive connector to which the SMTP connection was attempted. - -- Binding: The binding that was configured on the Receive connector. - -- EndPoint: The actual IP address and port to which the SMTP connection was attempted. - -- StatusCode: The result of the connection attempt. This can be one of the following values: Success, Unable to connect, Transient error, Permanent error, External error. - -- Details: The actual response received from the server being tested. If the connection attempt isn't successful, this field contains an error string. - -The Test-SmtpConnectivity results are displayed on-screen. You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding "\> \<filename\>" to the command. For example: - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-SmtpConnectivity Mailbox01 -``` - -This example verifies SMTP connectivity for all Receive connectors on the Mailbox server named Mailbox01. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportService | Test-SmtpConnectivity -``` - -This example verifies SMTP connectivity for all Receive connectors on all Mailbox servers in the organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the transport server for which the cmdlet verifies SMTP connectivity. The cmdlet verifies SMTP connectivity for all Receive connectors hosted on the specified server. If no server is specified, the cmdlet attempts to perform the SMTP connectivity test against all Receive connectors on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). - -```yaml -Type: $true | $false -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/40e81fee-c9ce-472d-8626-b1d3fa85d365.aspx) diff --git a/exchange/exchange-ps/exchange/mail-flow/Validate-OutboundConnector.md b/exchange/exchange-ps/exchange/mail-flow/Validate-OutboundConnector.md deleted file mode 100644 index 14cbf062bf..0000000000 --- a/exchange/exchange-ps/exchange/mail-flow/Validate-OutboundConnector.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Validate-OutboundConnector -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Validate-OutboundConnector - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Validate-OutboundConnector cmdlet to test the settings of Outbound connectors in Office 365. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Validate-OutboundConnector -Identity <OutboundConnectorIdParameter> -Recipients <MultiValuedProperty> - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Validate-OutboundConnector cmdlet performs two tests on the specified connector: - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Validate-OutboundConnector -Identity "Contoso.com Outbound Connector" -Recipients laura@contoso.com,julia@contoso.com -``` - -This example tests the Outbound connector named Contoso.com Outbound Connector. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name - -- GUID - -```yaml -Type: OutboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recipients -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/49bbc944-c55d-4c85-bf6b-63669a601621.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md deleted file mode 100644 index 1e590cdd98..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2019 -title: Disable-MetaCacheDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2019" ---- - -# Disable-MetaCacheDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-MetaCacheDatabase cmdlet to disable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-MetaCacheDatabase -Server <String[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### Example 1 -``` -Disable-MetaCacheDatabase -Server Mailbox01 -``` - -This example disables the metacache database on the Exchange server named Mailbox01. - -## PARAMETERS - - -### -Server -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 - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). For example, "Server1","Server2"..."ServerN". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version][Online Version](https://docs.microsoft.com/powershell/module/exchange/mailbox-databases-and-servers/disable-metacachedatabase) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md deleted file mode 100644 index 2c359575b9..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2019 -title: Enable-MetaCacheDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2019" ---- - -# Enable-MetaCacheDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-MetaCacheDatabase cmdlet to enable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-MetaCacheDatabase -Server <String[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### Example 1 -``` -Disable-MetaCacheDatabase -Server Mailbox01 -``` - -This example enables the metacache database on the Exchange server named Mailbox01. - -## PARAMETERS - -### -Server -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 - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). For example, "Server1","Server2"..."ServerN". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version][Online Version](https://docs.microsoft.com/powershell/module/exchange/mailbox-databases-and-servers/enable-metacachedatabase) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md deleted file mode 100644 index 360332fcff..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MailboxDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MailboxDatabase cmdlet to retrieve one or more mailbox database objects from a server or organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-MailboxDatabase -Server <ServerIdParameter> - [-DomainController <Fqdn>] - [-DumpsterStatistics] - [-IncludeCorrupted] - [-IncludePreExchange2010] - [-IncludePreExchange2013] - [-Status] [<CommonParameters>] -``` - -### Identity -``` -Get-MailboxDatabase [[-Identity] <DatabaseIdParameter>] - [-DomainController <Fqdn>] - [-DumpsterStatistics] - [-IncludeCorrupted] - [-IncludePreExchange2010] - [-IncludePreExchange2013] - [-Status] [<CommonParameters>] -``` - -## DESCRIPTION -If you use the Get-MailboxDatabase cmdlet with no parameters, it retrieves information about all mailbox databases in the Exchange organization. If you use the Get-MailboxDatabase cmdlet with the Server parameter, it retrieves information about all mailbox databases on the server that you specify. - -The following list describes the properties that are returned in the results. - -- Name: Name of the database. - -- Server: Server hosting the database. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxDatabase -IncludePreExchange2010 -``` - -In Exchange Server 2010, this example retrieves information about all the mailbox databases in the Exchange organization, including the mailbox databases that reside on computers running Exchange 2010 and earlier versions of Exchange. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxDatabase -IncludePreExchange2013 -``` - -This example retrieves information about all the mailbox databases in the Exchange organization, including Exchange 2010 mailbox databases. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxDatabase -Identity MailboxDatabase01 -Server Server01 -Status | Format-List -``` - -This example retrieves information about MailboxDatabase01 on Server01. This example also retrieves the status information, and pipes the output to the Format-List cmdlet so that you can view all the information about the mailbox database. - -## PARAMETERS - -### -Server -The Server parameter specifies the name of the server from which to retrieve mailbox database information. If you specify this parameter, the command retrieves information about all of the mailbox databases on the server that you specify. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 -``` - -### -DumpsterStatistics -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies a mailbox database. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Database name - -If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeCorrupted -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePreExchange2010 -This parameter is available or functional 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePreExchange2013 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -The Status switch specifies whether to retrieve the available free space in the database root and information about the following attributes: - -- BackupInProgress - -- Mounted - -- OnlineMaintenanceInProgress - -You don't need to specify a value with this switch. - -If you specify this switch, you should format the output in such a way that you can view the additional attributes, for example, pipe the output to the Format-List 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e12bd6d3-3793-49cb-9ab6-948d42dd409e.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md deleted file mode 100644 index ad0296a920..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxRepairRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MailboxRepairRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MailboxRepairRequest cmdlet to display information about current mailbox repair requests. Mailbox repair requests are created using the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruptions. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Database -``` -Get-MailboxRepairRequest [-Database] <DatabaseIdParameter> [[-StoreMailbox] <StoreMailboxIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-MailboxRepairRequest [-Identity] <StoreIntegrityCheckJobIdParameter> [-Detailed] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Mailbox -``` -Get-MailboxRepairRequest [-Mailbox] <MailboxIdParameter> [-Archive] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-MailboxRepairRequest cmdlet displays information about mailbox repair requests. This information includes: - -- The mailbox GUID. - -- The type of corruption that was specified when the mailbox repair request was created. - -- The progress of the repair request in percentage of completion. - -- The number of corruptions detected and fixed. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxDatabase | Get-MailboxRepairRequest | Format-Table Identity; Get-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5\374289de-b899-42dc-8391-4f8579935f1f | Format-List -``` - -This example displays the value of the Identity property for all mailbox repair requests for all mailbox servers in your organization; the second command displays information about a specific mailbox repair request that was returned by the first command. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxRepairRequest -Mailbox "Ann Beebe" | Format-List -``` - -This example displays repair request information for the mailbox of Ann Beebe using the Mailbox parameter. - -### -------------------------- Example 3 -------------------------- -``` -$MailboxGuid = Get-MailboxStatistics annb; Get-MailboxRepairRequest -Database $MailboxGuid.Database -StoreMailbox $MailboxGuid.MailboxGuid | Format-List Identity -``` - -This example uses the Database and StoreMailbox parameters to display the Identity property of the repair request for the mailbox of Ann Beebe. - -## PARAMETERS - -### -Database -The Database parameter specifies the database on which you run this command. If you use this parameter, all mailboxes on the database are searched for corruptions. You can use the following values: - -- GUID of the database - -- Database name - -You can't use this parameter with the Mailbox parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is \<DatabaseGuid\>\\\<RequestGuid\>\\\<JobGuid\>. - -```yaml -Type: StoreIntegrityCheckJobIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox that you want to get mailbox repair request information about. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SMTP address - -- Alias - -You can't use this parameter with the Database parameter. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Archive -If the associated archive mailbox was included when the mailbox repair request was created, use the Archive parameter to display information about the archive mailbox. If you don't specify this parameter, only information about the primary mailbox is returned. - -You can't use this parameter with the Database parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Mailbox -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 -``` - -### -Detailed -Use the Detailed parameter to display mailbox-level repair tasks associated with the repair request. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoreMailbox -The StoreMailbox parameter specifies the mailbox GUID of the mailbox that you want to get mailbox repair request information about. Use this parameter with the Database parameter. - -Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1b9d3047-8e4c-4847-af01-ce7513b7aa7b.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxServer.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxServer.md deleted file mode 100644 index 66ca0d9367..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-MailboxServer.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MailboxServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MailboxServer cmdlet to view information about Mailbox servers in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxServer [[-Identity] <MailboxServerIdParameter>] [-DomainController <Fqdn>] [-Status] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxServer -``` - -This example returns a summary list of all the Mailbox servers in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxServer -Identity Server1 | Format-List -``` - -This example returns detailed information about the Mailbox server named Server1. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Mailbox server that you want to view. You can use any value that uniquely identifies the Mailbox server. For example: - -- Name - -- GUID - -- Distinguished name (DN) - -```yaml -Type: MailboxServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Status -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/838bc72a-e3bb-4583-934f-d93a7c93252c.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md deleted file mode 100644 index 9726c13d07..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SearchDocumentFormat -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-SearchDocumentFormat cmdlet to retrieve details of file formats supported by Exchange Search. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SearchDocumentFormat [[-Identity] <SearchDocumentFormatId>] [-Server <ServerIdParameter>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SearchDocumentFormat -``` - -This example retrieves a list of all file formats supported by Exchange Search. - -### -------------------------- Example 2 -------------------------- -``` -Get-SearchDocumentFormat docx | Format-List * -``` - -This example retrieves all properties of the docx file format. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -This parameter is available only in on-premises Exchange. - -The Server parameter specifies the name of the server against which the command is executed. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7e966dba-82ea-416f-b859-1ffb7bd7c713.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md deleted file mode 100644 index 83702fe335..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-StoreUsageStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-StoreUsageStatistics - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-StoreUsageStatistics cmdlet to aid in diagnosing performance issues with your servers or databases. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Database -``` -Get-StoreUsageStatistics -Database <DatabaseIdParameter> [-CopyOnServer <ServerIdParameter>] - [-DomainController <Fqdn>] - [-Filter <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-StoreUsageStatistics [-Identity] <GeneralMailboxIdParameter> [-CopyOnServer <ServerIdParameter>] - [-DomainController <Fqdn>] - [-Filter <String>] [<CommonParameters>] -``` - -### Server -``` -Get-StoreUsageStatistics -Server <ServerIdParameter> [-IncludePassive] - [-DomainController <Fqdn>] - [-Filter <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-StoreUsageStatistics -Server EX1 | ft -auto -``` - -This example retrieves store usage statistics for all active databases on server EX1. - -### -------------------------- Example 2 -------------------------- -``` -Get-StoreUsageStatistics -Server EX1 -IncludePassive | ft -auto -``` - -This example retrieves store usage statistics for all active and passive databases on server EX1. - -### -------------------------- Example 3 -------------------------- -``` -Get-StoreUsageStatistics -Database DB1 | Sort-Object LogRecordBytes -desc | Select-Object -First 10 | ft DigestCategory, *guid, LogRecordBytes, *time* -auto -``` - -This example retrieves store usage statistics for database DB1 and sorts the output by the 10 highest log file generators. - -## PARAMETERS - -### -Database -The Database parameter specifies the name of the mailbox database to get usage statistics from (the top 25 largest mailboxes on the specified mailbox database). You can use any value that uniquely identifies the mailbox database. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -You can't use this parameter with the Identity or Server parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity - -The Identity parameter specifies the mailbox to get usage statistics from. You can use one of the following values to identify the mailbox: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -The command returns results for the mailbox only if it's one of the top 25 users of store resources. - -You can't use this parameter with the Database or Server parameters. - -```yaml -Type: GeneralMailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Mailbox server to get usage statistics from (the top 25 mailboxes on all active databases on the specified server). You can use one of the following values to identify the server: - -- Fully qualified domain name (FQDN) - -- NetBIOS name - -You can't use this parameter with the Database or Identity parameters. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CopyOnServer -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 - -- Distinguished name (DN) - -- GUID - -You use this parameter with the Server or Identity parameters. - -```yaml -Type: ServerIdParameter -Parameter Sets: Database, Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -```yaml -Type: String -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 -``` - -### -IncludePassive -The IncludePassive switch specifies whether to include usage statistics from active and passive copies of mailbox databases on the Mailbox server you specified with the Server parameter. You don't need to specify a value with this switch. - -To only include statistics from active copies of mailbox databases on the specified Mailbox server, don't use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0fd00fe0-de0e-48d2-b9fd-44220455cb8e.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Mount-Database.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Mount-Database.md deleted file mode 100644 index d560c12c4e..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Mount-Database.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Mount-Database -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Mount-Database - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Mount-Database cmdlet to mount mailbox databases on Exchange servers. The cmdlet mounts the database only if the Microsoft Exchange Information Store service and the Microsoft Exchange Replication service are running. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Mount-Database [-Identity] <DatabaseIdParameter> [-AcceptDataLoss] [-Confirm] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-NewCapacity] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Mount-Database -Identity ExchangeServer1.Contoso.com\MyDatabase -``` - -This example mounts the database MyDatabase. - -## PARAMETERS - -### -Identity -The Identity parameter specifies mailbox database that you want to mount. You can use any value that uniquely identifies the database. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptDataLoss -The AcceptDataLossswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -Use this parameter to mount an empty database, or to override any errors or warnings that are encountered during the database mount. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -NewCapacity -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/76a57f6a-a6c6-4c65-abf8-190522d47037.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Move-DatabasePath.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Move-DatabasePath.md deleted file mode 100644 index ebafb566e4..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Move-DatabasePath.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-DatabasePath -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Move-DatabasePath - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Move-DatabasePath cmdlet to set a new path to the location of a database on the specified Mailbox server and to move the related files to that location. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Move-DatabasePath [-Identity] <DatabaseIdParameter> [-ConfigurationOnly] [-Confirm] [-DomainController <Fqdn>] - [-EDBFilePath <EdbFilePath>] [-Force] [-LogFolderPath <NonRootLocalLongFullPath>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -When you use the Move-DatabasePath cmdlet, consider the following: - -- This cmdlet fails if it's run while the database is being backed up. - -- If the specified database is mounted when this cmdlet is run, the database is automatically dismounted and then remounted, and is unavailable to users while it's dismounted. - -- This cmdlet normally can be run on the affected Mailbox server only. An exception is that this cmdlet can be run on an administrator's workstation when using the ConfigurationOnly parameter with a value of $true. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Move-DatabasePath -Identity MyDatabase01 -EdbFilePath C:\NewFolder\MyDatabase01.edb -``` - -This example sets a new path for the mailbox database specified by the mailbox database name. To perform the move operation, the database must be temporarily dismounted, making it inaccessible to all users. If the database is currently dismounted, it isn't remounted upon completion. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID, distinguished name (DN) or name of the database. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ConfigurationOnly -The ConfigurationOnly switch specifies whether the configuration of the database changes without moving any files. A value of $true changes the configuration. A value of $false changes the configuration and moves the files. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -EDBFilePath -The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is \<ExchangeInstallDirectory\>\\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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -LogFolderPath -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -EDBFilePath -The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is \<ExchangeInstallDirectory\>\\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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d6873ded-d521-428f-821f-d10ea2c44b7e.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md deleted file mode 100644 index 4327cb0363..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md +++ /dev/null @@ -1,331 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-MailboxDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-MailboxDatabase cmdlet to create a mailbox database, or a recovery database. Each database you create must have a unique name in the organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### NonRecovery -``` -New-MailboxDatabase [-Name] <String> -Server <ServerIdParameter> [-AutoDagExcludeFromMonitoring <$true | $false>] [-IsExcludedFromProvisioning <$true | $false>] [-IsExcludedFromInitialProvisioning] [-IsSuspendedFromProvisioning <$true | $false>] [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-PublicFolderDatabase <DatabaseIdParameter>] - [-Confirm] - [-DomainController <Fqdn>] - [-EdbFilePath <EdbFilePath>] - [-LogFolderPath <NonRootLocalLongFullPath>] - [-MailboxProvisioningAttributes <MailboxProvisioningAttributes>] - [-SkipDatabaseLogFolderCreation] - [-WhatIf] [<CommonParameters>] -``` - -### Recovery -``` -New-MailboxDatabase [[-Name] <String>] -Server <ServerIdParameter> [-Recovery] - [-Confirm] - [-DomainController <Fqdn>] - [-EdbFilePath <EdbFilePath>] - [-LogFolderPath <NonRootLocalLongFullPath>] - [-MailboxProvisioningAttributes <MailboxProvisioningAttributes>] - [-SkipDatabaseLogFolderCreation] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailboxDatabase -Name "DB1" -EdbFilePath D:\ExchangeDatabases\DB1\DB1.edb -``` - -This example creates the mailbox database DB1. This example also uses a non-default location for the database file. - -## PARAMETERS - -### -Name -The Name parameter specifies the name of the new mailbox database. - -```yaml -Type: String -Parameter Sets: NonRecovery -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Recovery -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recovery -The Recovery parameter specifies that the new database is designated as a recovery database. - -```yaml -Type: SwitchParameter -Parameter Sets: Recovery -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the server on which you want to create the database. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AutoDagExcludeFromMonitoring -The AutoDagExcludeFromMonitoring parameter specifies that the database being created should not be monitored by managed availability. - -```yaml -Type: $true | $false -Parameter Sets: NonRecovery -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 -``` - -### -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 -``` - -### -EdbFilePath -The EdbFilePath parameter specifies the path to the database files. The default value is %programfiles%\\Microsoft\\Exchange Server\\V15\\Mailbox\\\<Database name\>.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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsExcludedFromInitialProvisioning -The IsExcludedFromInitialProvisioning parameter specifies that this database is temporarily not considered by the mailbox provisioning load balancer. If the IsExcludedFromInitialProvisioning parameter is enabled, new mailboxes aren't added automatically to this database. - -```yaml -Type: SwitchParameter -Parameter Sets: NonRecovery -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 -``` - -### -IsExcludedFromProvisioning -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: $true | $false -Parameter Sets: NonRecovery -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 -``` - -### -IsSuspendedFromProvisioning -The IsSuspendedFromProvisioning parameter specifies whether this database is temporarily considered by the mailbox provisioning load balancer. - -```yaml -Type: $true | $false -Parameter Sets: NonRecovery -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 -``` - -### -LogFolderPath -The LogFolderPath parameter specifies the folder location for log files. - -```yaml -Type: NonRootLocalLongFullPath -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 -``` - -### -MailboxProvisioningAttributes -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxProvisioningAttributes -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OfflineAddressBook -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderDatabase -The PublicFolderDatabase parameter specifies the associated public folder database for the new mailbox database. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: NonRecovery -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 -``` - -### -SkipDatabaseLogFolderCreation -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5008090b-e776-4ff6-807c-208e00f4daab.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md deleted file mode 100644 index 6294508e22..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxRepairRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-MailboxRepairRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruptions. You can run this command against a specific mailbox or against a database. While this task is running, mailbox access is disrupted only for the mailbox being repaired. If you're running this command against a database, only the mailbox being repaired is disrupted. All other mailboxes on the database remain operational. - -After you begin the repair request, it can't be stopped unless you dismount the database. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Database -``` -New-MailboxRepairRequest [-Database] <DatabaseIdParameter> -CorruptionType <MailboxStoreCorruptionType[]> - [-Confirm] - [-DetectOnly] - [-DomainController <Fqdn>] - [-Force] [<CommonParameters>] - [-WhatIf] [[-StoreMailbox] <StoreMailboxIdParameter>] -``` - -### Mailbox -``` -New-MailboxRepairRequest [-Mailbox] <MailboxIdParameter> -CorruptionType <MailboxStoreCorruptionType[]> [-Archive] - [-Confirm] - [-DetectOnly] - [-DomainController <Fqdn>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -To avoid any performance problems, there are limits placed on the number of simultaneous repair requests that can be submitted per server. Only one request can be active for a database-level repair, or up to 100 requests can be active for a mailbox-level repair per server. - -The New-MailboxRepairRequest cmdlet detects and fixes the following types of mailbox corruptions: - -- Search folder corruptions (SearchFolder) - -- Aggregate counts on folders that aren't reflecting correct values (AggregateCounts) - -- Views on folders that aren't returning correct contents (FolderView) - -- Provisioned folders that are incorrectly pointing into parent folders that aren't provisioned (ProvisionedFolder) - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailboxRepairRequest -Mailbox tony@contoso.com -CorruptionType FolderView -``` - -This example detects and repairs all folder views for the mailbox tony@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -New-MailboxRepairRequest -Mailbox ayla -CorruptionType ProvisionedFolder,SearchFolder -DetectOnly -``` - -This example only detects and reports on ProvisionedFolder and SearchFolder corruption issues to Ayla Kol's mailbox. This command doesn't repair the mailbox. - -### -------------------------- Example 3 -------------------------- -``` -New-MailboxRepairRequest -Database MBX-DB01 -CorruptionType AggregateCounts -``` - -This example detects and repairs AggregateCounts for all mailboxes on mailbox database MBX-DB01. - -### -------------------------- Example 4 -------------------------- -``` -New-MailboxRepairRequest -Mailbox ayla -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview -Archive -``` - -This example detects and repairs all corruption types for Ayla Kol's mailbox and archive. - -### -------------------------- Example 5 -------------------------- -``` -$Mailbox = Get-MailboxStatistics annb; New-MailboxRepairRequest -Database $Mailbox.Database -StoreMailbox $Mailbox.MailboxGuid -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview -``` - -This example creates a variable that identifies Ann Beebe's mailbox and then uses the variable to specify the values for the Database and StoreMailbox parameters to create a request to detect and repair all corruption types. - -## PARAMETERS - -### -CorruptionType -The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: - -- SearchFolder - -- AggregateCounts - -- ProvisionedFolder - -- FolderView - -You can search for multiple corruption types at a time. Separate multiple types with a comma, for example, SearchFolder,AggregateCounts. - -```yaml -Type: MailboxStoreCorruptionType[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -The Database parameter specifies the database on which you run this command. If you use this parameter, all mailboxes on the database are searched for corruptions. To avoid performance issues, you're limited to one active database repair request at a time. You can use the following values: - -- GUID of the database - -- Database name - -You can't use this parameter in conjunction with the Mailbox parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox on which you run this command. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SMTP address - -- Alias - -You can't use this parameter in conjunction with the Database parameter. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Archive -The Archive parameter specifies whether to detect corruptions or repair the archive mailbox associated with the specified mailbox. If you don't specify this parameter, only the primary mailbox is repaired. - -You can't use this parameter in conjunction with the Database parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Mailbox -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 -``` - -### -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 -``` - -### -DetectOnly -The DetectOnly parameter specifies that you want this command to report errors, but not fix them. You don't have to specify a value with this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Force -The Force switch specifies that the cmdlet should run immediately and not wait to be dispatched by workload management. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoreMailbox -The StoreMailbox parameter specifies the mailbox GUID of the mailbox you want to repair. Use this parameter with the Database parameter. - -Run the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5fd53ecb-1445-489d-91ac-1e771f41eb01.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md deleted file mode 100644 index 32a19b1d01..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-MailboxDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-MailboxDatabase cmdlet to delete a mailbox database object. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailboxDatabase [-Identity] <DatabaseIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -If the mailbox database has a database copy, the Remove-MailboxDatabase cmdlet also removes the copy. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailboxDatabase -Identity MailboxDatabase01 -``` - -This example removes the mailbox database MailboxDatabase01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox database to remove. You can use one of the following values: - -- GUID - -- Distinguished name (DN) - -- Name of the mailbox database - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4d07d736-1dd7-43af-9f54-37d7c648572e.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md deleted file mode 100644 index 12b8b9a4b4..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxRepairRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-MailboxRepairRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-MailboxRepairRequest cmdlet to remove mailbox repair requests from a mailbox database that were created using the New-MailboxRepairRequest cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailboxRepairRequest [-Identity] <StoreIntegrityCheckJobIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: \<DatabaseGuid\>\\\<RequestGuid\>\\\<JobGuid\>. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that may contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete \<DatabaseGuid\>\\\<RequestGuid\>\\\<JobGuid\> value. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxDatabase -Identity "EXCH-MBX-01" | Get-MailboxRepairRequest | Remove-MailboxRepairRequest -``` - -This example removes all mailbox repair requests for the mailbox database EXCH-MBX-01. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity; Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5 -``` - -This example removes all related mailbox repair requests that have the same \<DatabaseGuid\>\\\<RequestGuid\>. The example uses the Get-MailboxRepairRequest cmdlet to display the value of the Identity parameter for all mailbox repair request for EXCH-MBX-02 mailbox database. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity; Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\189c7852-49bd-4737-a53e-6e6caa5a183c\1d8ca58a-186f-4dc6-b481-f835b548a929 -``` - -This example deletes a specific mailbox repair request by specifying the unique \<DatabaseGuid\>\\\<RequestGuid\>\\\<JobGuid\> identity value. The example also uses the Get-MailboxRepairRequest cmdlet to display the identities of all mailbox repair request for the EXCH-MBX-02 mailbox database. - -## PARAMETERS - -### -Identity -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 -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 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7f5e19bb-4d3e-4454-b4cf-b530c797cfa4.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md deleted file mode 100644 index f5c8f42b93..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md +++ /dev/null @@ -1,1461 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-MailboxDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-MailboxDatabase cmdlet to configure a variety of properties for a mailbox database. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxDatabase [-Identity] <DatabaseIdParameter> -[-AllowFileRestore <$true | $false>] -[-AutoDagExcludeFromMonitoring <$true | $false>] -[-AutoDatabaseMountDial <Lossless | GoodAvailability | BestAvailability>] -[-BackgroundDatabaseMaintenance <$true | $false>] -[-BackgroundDatabaseMaintenanceDelay <Int32>] -[-BackgroundDatabaseMaintenanceSerialization <$true | $false>] -[-CachedClosedTables <Int32>] -[-CachePriority <Int32>] -[-CafeEndpoints <String[]>] -[-CalendarLoggingQuota <Unlimited>] -[-CircularLoggingEnabled <$true | $false>] -[-Confirm] -[-DatabaseExtensionSize <Int32>] -[-DatabaseGroup <String>] -[-DataMoveReplicationConstraint <None | SecondCopy | SecondDatacenter | AllDatacenters | AllCopies>] -[-DeletedItemRetention <EnhancedTimeSpan>] -[-DomainController <Fqdn>] -[-EventHistoryRetentionPeriod <EnhancedTimeSpan>] -[-IndexEnabled <$true | $false>] -[-IsExcludedFromInitialProvisioning <$true | $false>] -[-IsExcludedFromProvisioning <$true | $false>] -[-IsExcludedFromProvisioningByOperator <$true | $false>] -[-IsExcludedFromProvisioningDueToLogicalCorruption <$true | $false>] -[-IsExcludedFromProvisioningReason <String>] -[-IssueWarningQuota <Unlimited>] -[-IsSuspendedFromProvisioning <$true | $false>] -[-JournalRecipient <RecipientIdParameter>] -[-LogBuffers <Int32>] -[-LogCheckpointDepth <Int32>] -[-MailboxLoadBalanceEnabled <$true | $false>] -[-MailboxLoadBalanceMaximumEdbFileSize <ByteQuantifiedSize>] -[-MailboxLoadBalanceOverloadedThreshold <Int32>] -[-MailboxLoadBalanceRelativeLoadCapacity <Int32>] -[-MailboxLoadBalanceUnderloadedThreshold <Int32>] -[-MailboxProvisioningAttributes <MailboxProvisioningAttributes>] -[-MailboxRetention <EnhancedTimeSpan>] -[-MaintenanceSchedule <Schedule>] -[-MasterDatabaseAvailabilityGroup <DatabaseAvailabilityGroupIdParameter>] -[-MasterServer <ServerIdParameter>] -[-MaximumBackgroundDatabaseMaintenanceInterval <Int32>] -[-MaximumCursors <Int32>] -[-MaximumOpenTables <Int32>] -[-MaximumPreReadPages <Int32>] -[-MaximumReplayPreReadPages <Int32>] -[-MaximumSessions <Int32>] -[-MaximumTemporaryTables <Int32>] -[-MaximumVersionStorePages <Int32>] -[-MetaCacheDatabaseMaxCapacityInBytes <Int64>] -[-MimimumBackgroundDatabaseMaintenanceInterval <Int32>] -[-MountAtStartup <$true | $false>] -[-Name <String>] -[-OfflineAddressBook <OfflineAddressBookIdParameter>] -[-PreferredVersionStorePages <Int32>] -[-ProhibitSendQuota <Unlimited>] -[-ProhibitSendReceiveQuota <Unlimited>] -[-PublicFolderDatabase <DatabaseIdParameter>] -[-QuotaNotificationSchedule <Schedule>] -[-RecoverableItemsQuota <Unlimited>] -[-RecoverableItemsWarningQuota <Unlimited>] -[-ReplayBackgroundDatabaseMaintenance <$true | $false>] -[-ReplayBackgroundDatabaseMaintenanceDelay <Int32>] -[-ReplayCachePriority <Int32>] -[-ReplayCheckpointDepth <Int32>] -[-RetainDeletedItemsUntilBackup <$true | $false>] -[-RpcClientAccessServer <ClientAccessServerOrArrayIdParameter>] -[-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxDatabase "Mailbox Database01" -DeletedItemRetention 7.00:00:00 -``` - -This example sets the length of time that deleted items are retained. If a specific mailbox has its own item retention set, that value is used instead of this value, which is set on the mailbox database. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxDatabase <Mailbox Database Name> -RpcClientAccessServer <ClientAccessServer or ClientAccessServerArrayID> -``` - -In Exchange Server 2010, this example updates a mailbox database so that all client connections for mailboxes on the database come through the Client Access server or Client Access server array. You can also use this command to change the Client Access server or Client Access server array through which the client is connecting to the Mailbox server. - -For more information about RPC access through Client Access servers, see Set-RpcClientAccess and Set-ClientAccessArray. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllowFileRestore -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. - -```yaml -Type: $true | $false -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 -``` - -### -AutoDagExcludeFromMonitoring -The AutoDagExcludedFromMonitoringparameter 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDatabaseMountDial -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Lossless | GoodAvailability | BestAvailability -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackgroundDatabaseMaintenance -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. - -- $false: The mailbox database reads the object during database mount and initializes the database without the option to perform background maintenance. - -```yaml -Type: $true | $false -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 -``` - -### -BackgroundDatabaseMaintenanceDelay -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackgroundDatabaseMaintenanceSerialization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CachedClosedTables -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CachePriority -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CafeEndpoints -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarLoggingQuota -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). - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The value of this parameter must be less than or equal to the value of the RecoverableItemsQuota parameter. - -This setting applies to all mailboxes in the database that don't have their own calendar logging quota configured. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CircularLoggingEnabled -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. - -For more information about circular logging, see Exchange Native Data Protection (https://technet.microsoft.com/library/dd876874.aspx#ENDP). - -```yaml -Type: $true | $false -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 -``` - -### -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 -``` - -### -DatabaseExtensionSize -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseGroup -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataMoveReplicationConstraint -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). - -- 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. - -- 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://technet.microsoft.com/library/dd776123.aspx). - -```yaml -Type: None | SecondCopy | SecondDatacenter | AllDatacenters | AllCopies -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 -``` - -### -DeletedItemRetention -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. - -Valid values are 00:00:00 to 24855.03:14:07. The default value is 14.00:00:00 (14 days). - -This setting applies to all mailboxes in the database that don't have their own deleted item retention value configured. - -For more information, see Recoverable Items folder in Exchange 2016 (https://technet.microsoft.com/library/ee364755.aspx). - -```yaml -Type: EnhancedTimeSpan -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 -``` - -### -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 -``` - -### -EventHistoryRetentionPeriod -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. - -Valid values are 00:00:01 to 30.00:00:00. The default value is 7.00:00:00 (7 days). - -```yaml -Type: EnhancedTimeSpan -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 -``` - -### -IndexEnabled -This parameter isn't avaialble in Exchange Server 2019. - -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. - -- $false: Exchange Search doesn't index the mailbox database. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsExcludedFromInitialProvisioning -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsExcludedFromProvisioning -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. - -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. - -```yaml -Type: $true | $false -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 -``` - -### -IsExcludedFromProvisioningByOperator -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. - -Note that 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsExcludedFromProvisioningDueToLogicalCorruption -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. - -Note that 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. - -- The IsExcludedFromProvisioning property is automatically set to $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsExcludedFromProvisioningReason -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: - -- IsExcludedFromProvisioning - -- IsExcludedFromProvisioningByOperator - -- IsSuspendedFromProvisioning - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssueWarningQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. - -This setting applies to all mailboxes in the database that don't have their own warning quota configured. The default value is 1.899 gigabytes (2,039,480,320 bytes). - -```yaml -Type: Unlimited -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 -``` - -### -IsSuspendedFromProvisioning -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. - -Note that 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. - -```yaml -Type: $true | $false -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 -``` - -### -JournalRecipient -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: - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -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 -``` - -### -LogBuffers -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogCheckpointDepth -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceMaximumEdbFileSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceOverloadedThreshold -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceRelativeLoadCapacity -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLoadBalanceUnderloadedThreshold -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxProvisioningAttributes -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxProvisioningAttributes -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxRetention -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. - -Valid values are 00:00:00 to 24855.03:14:07. The default value is 30.00:00:00 (30 days). - -```yaml -Type: EnhancedTimeSpan -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 -``` - -### -MaintenanceSchedule -This parameter is available or 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 format is StartDay.Hour:Minute [AM/PM]-EndDay.Hour:Minute [AM/PM]. You can use the following values for the start and end days: - -- Full name of the day - -- Abbreviated name of the day - -- Integer from 0 through 6, where 0 = Sunday - -If you prefer to use a 24-hour clock, omit AM/PM. If you use AM/PM, you must include a space between the time and AM or PM. - -Formats can be mixed. - -The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. - -The following are examples: - -- "Sun.11:30 PM-Mon.1:30 AM" - -- 6.22:00-6.22:15 (Maintenance will run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - -- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Maintenance will run on Monday and Wednesday mornings from 4:30 until 5:30.) - -- "Sun.1:15 AM-Monday.23:00" - -```yaml -Type: Schedule -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterDatabaseAvailabilityGroup -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DatabaseAvailabilityGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterServer -This parameter is reserved for internal Microsoft use. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumBackgroundDatabaseMaintenanceInterval -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumCursors -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumOpenTables -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumPreReadPages -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumReplayPreReadPages -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumSessions -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumTemporaryTables -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumVersionStorePages -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetaCacheDatabaseMaxCapacityInBytes -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). - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MimimumBackgroundDatabaseMaintenanceInterval -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MountAtStartup -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. - -- $false: The database isn't mounted when the service starts. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OfflineAddressBook -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 - -- Distinguished name (DN) - -- GUID - -By default, this setting is blank ($null). - -```yaml -Type: OfflineAddressBookIdParameter -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 -``` - -### -PreferredVersionStorePages -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitSendQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The ProhibitSendQuota value must be less than or equal to the ProhibitSendReceiveQuota value. - -This settings applies to all mailboxes in the database that don't have their own prohibit send quota configured. The default value is 2 gigabytes (2147483648 bytes). - -```yaml -Type: Unlimited -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 -``` - -### -ProhibitSendReceiveQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. - -This setting applies to all mailboxes in the database that don't have their own prohibit send receive quota configured. The default value is 2.99804 gigabytes (2469396480 bytes) - -```yaml -Type: Unlimited -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 -``` - -### -PublicFolderDatabase -This parameter is available or functional only in Exchange Server 2010. - -The PublicFolderDatabase parameter specifies the associated public folder database for this mailbox database. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Name of the public folder database - -- Database name - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuotaNotificationSchedule -This parameter is available or 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. - -The format is StartDay.Hour:Minute [AM/PM]-EndDay.Hour:Minute [AM/PM]. You can use the following values for the start and end days: - -- Full name of the day - -- Abbreviated name of the day - -- Integer from 0 through 6, where 0 = Sunday - -If you prefer to use a 24-hour clock, omit AM/PM. - -Formats can be mixed. - -The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval. - -The following are examples: - -- "Sun.11:30 PM-Mon.1:30 AM" - -- 6.22:00-6.22:15 (Notification will run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - -- "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Notification will run on Monday and Wednesday mornings from 4:30 until 5:30.) - -- "Sun.1:15 AM-Monday.23:00" - -```yaml -Type: Schedule -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoverableItemsQuota -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). - -When you enter a number, you can qualify it with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. - -This settings applies to all mailboxes in the database that don't have their own Recoverable Items quota configured. - -```yaml -Type: Unlimited -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 -``` - -### -RecoverableItemsWarningQuota -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). - -When you enter a number, you can qualify it with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. - -This settings applies to all mailboxes in the database that don't have their own Recoverable Items warning quota configured. - -```yaml -Type: Unlimited -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 -``` - -### -RetainDeletedItemsUntilBackup -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 deleted item retention and recoverable items quota values. - -- $false: Retention of deleted items doesn't depend on a backup of the mailbox database. This is the default value. - -For more information, see Recoverable Items folder in Exchange 2016 (https://technet.microsoft.com/library/ee364755.aspx). - -This settings applies to all mailboxes in the database that don't have this value specifically configured. - -```yaml -Type: $true | $false -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 -``` - -### -ReplayBackgroundDatabaseMaintenance -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplayBackgroundDatabaseMaintenanceDelay -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplayCachePriority -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplayCheckpointDepth -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcClientAccessServer -This parameter is available or 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. - -```yaml -Type: ClientAccessServerOrArrayIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a01edc66-bc10-4f65-9df4-432cb9e88f58.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md deleted file mode 100644 index f8115342eb..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SearchDocumentFormat -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-SearchDocumentFormat - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-SearchDocumentFormat cmdlet to enable or disable the file format for Exchange Search. - -When you disable a file format for content indexing by Exchange Search, contents of the file become unsearchable by Exchange Search clients such as Outlook on the web, Microsoft Outlook in online mode and In-Place eDiscovery. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SearchDocumentFormat [-Identity] <SearchDocumentFormatId> -Enabled <$true | $false> [-Confirm] - [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## 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 (https://technet.microsoft.com/library/dd298021.aspx) search and you select the option to include unsearchable items, only items that are actually unsearchable are returned. Items that weren't searched because the associated file format is set as unsearchable aren't returned. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SearchDocumentFormat ZIP -Enabled $false -``` - -This command disables the Zip file format for indexing by Exchange Search. - -## PARAMETERS - -### -Enabled -The Enabled parameter specifies whether the file format is enabled. Set the parameter to $false to disable the format for content indexing. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d4aa8525-32de-4816-82d5-dfa3396d5006.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md deleted file mode 100644 index 112ccd0a55..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-AssistantHealth -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-AssistantHealth - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-AssistantHealth cmdlet to verify that the Microsoft Exchange Mailbox Assistants service (MSExchangeMailboxAssistants) is healthy, to recover from health issues, and to report the status of the diagnosis or recovery action. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-AssistantHealth [[-ServerName] <ServerIdParameter>] [-Confirm] [-IncludeCrashDump] - [-MaxProcessingTimeInMinutes <UInt32>] [-MonitoringContext] [-ResolveProblems] [-WhatIf] - [-WatermarkBehindWarningThreholdInMinutes <UInt32>] [<CommonParameters>] -``` - -## DESCRIPTION -The Mailbox Assistants service runs on all servers that have the Mailbox server role installed. This service is responsible for scheduling and dispatching several assistants that ensure mailboxes function correctly. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-AssistantHealth -ServerName MBXSVR01 -IncludeCrashDump -ResolveProblems | Format-List -``` - -This example detects and repairs the mailbox assistant's health on MBXSVR01, includes the error information, and formats the output to a list. - -### -------------------------- Example 2 -------------------------- -``` -Test-AssistantHealth -MaxProcessingTimeInMinutes 30 | Format-List -``` - -This example detects the mailbox assistant's health on the local Mailbox server. The MaxProcessingTimeInMinutes parameter specifies 30 minutes as the maximum amount of time the service is allowed to process an event without responding, and formats the output to a list. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -IncludeCrashDump -The IncludeCrashDump parameter specifies that the command should take an error report prior to taking any recovery actions. This parameter should only be used if running from a local computer. If you use the parameter while connected remotely, the command fails. - -The default value for this parameter is $false. - -You don't have to specify a value with this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxProcessingTimeInMinutes -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResolveProblems -This ResolveProblems parameter specifies that if the command detects an issue, it attempts to fix it. This command attempts to fix the following issues: - -- Starts the Mailbox Assistants service if it isn't running. - -- Restarts the Mailbox Assistants service if it detects that the service is hung or deadlocked for more than 15 minutes. - -You don't have to specify a value with this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -``` - -### -ServerName -The ServerName parameter specifies the identity of the Mailbox server on which the mailbox assistant that's being tested resides. - -If this parameter isn't specified, the command runs on the local server. If the local server isn't a Mailbox server, the command fails. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 -``` - -### -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. - -You can specify a value from 1 through 10080 minutes. The default value is 60 minutes. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b220cb2b-2206-42c7-8699-1f93300c45a7.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md deleted file mode 100644 index 85567d00c9..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ExchangeSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-ExchangeSearch - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-ExchangeSearch cmdlet to test that Exchange Search is currently enabled and is indexing new email messages in a timely manner. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Test-ExchangeSearch [[-Identity] <MailboxIdParameter>] [-Archive] - [-Confirm] - [-DomainController <Fqdn>] - [-IndexingTimeoutInSeconds <Int32>] - [-MonitoringContext] - [-WhatIf] [<CommonParameters>] -``` - -### Database -``` -Test-ExchangeSearch [-MailboxDatabase <DatabaseIdParameter>] - [-Confirm] - [-DomainController <Fqdn>] - [-IndexingTimeoutInSeconds <Int32>] - [-MonitoringContext] - [-WhatIf] [<CommonParameters>] -``` - -### Server -``` -Test-ExchangeSearch [-Server <ServerIdParameter>] - [-Confirm] - [-DomainController <Fqdn>] - [-IndexingTimeoutInSeconds <Int32>] - [-MonitoringContext] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-ExchangeSearch cmdlet creates a hidden message and an attachment in the specified mailbox that's visible only to Exchange Search. The command waits for the message to be indexed and then searches for the content. It reports success or failure depending on whether the message is found after the interval set in the IndexingTimeoutInSeconds parameter has elapsed. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-ExchangeSearch -Identity john@contoso.com -``` - -This example tests Exchange Search results for the mailbox database on which the specified mailbox resides. - -### -------------------------- Example 2 -------------------------- -``` -Test-ExchangeSearch -Identity john@contoso.com -Verbose -``` - -This example tests Exchange Search results for the mailbox database on which the specified mailbox resides. The Verbose switch is used to display detailed information. - -## PARAMETERS - -### -Archive -The Archive switch specifies that the test be run against the archive mailbox for the mailbox user specified in the Identity parameter. When the Archive switch is used, you must also use the Identity parameter to specify the mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -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 -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies the mailbox that you want to test Exchange Search against. - -You can't use this parameter with the MailboxDatabase or Server parameters. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IndexingTimeoutInSeconds -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxDatabase -This parameter is available or functional only in Exchange Server 2010 and 2013. - -The MailboxDatabase parameter specifies the mailbox database to test Exchange Search against. - -You can't use this parameter with the Identity or Server parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server for the recipient that you want to test Exchange Search against. - -You can't use this parameter with the MailboxDatabase or Identity parameters. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d50b8f0b-7b79-45d5-b1a4-8a5bc84d0724.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md deleted file mode 100644 index 827823dcb4..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-DatabaseSchema -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Update-DatabaseSchema - -## 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 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://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-DatabaseSchema [-Identity] <DatabaseIdParameter> -MajorVersion <UInt16> -MinorVersion <UInt16> - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-DatabaseSchema DB1 -``` - -This example updates the database schema for database DB1. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox database for which you want to set one or more attributes. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Name of the mailbox database - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MajorVersion -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinorVersion -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2759a44b-d7ae-4ac3-8c79-6f019cecca45.aspx) diff --git a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md b/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md deleted file mode 100644 index fdf50f69c9..0000000000 --- a/exchange/exchange-ps/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-StoreMailboxState -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Update-StoreMailboxState - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Update-StoreMailboxState cmdlet to synchronize the mailbox state for a mailbox in the Exchange mailbox store with the state of the corresponding Active Directory user account. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-StoreMailboxState -Database <DatabaseIdParameter> -Identity <StoreMailboxIdParameter> [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-StoreMailboxState cmdlet forces the mailbox store state in the Exchange store to be synchronized with Active Directory. In some cases, it's possible that the store state for a mailbox to become out-of-sync with the state of the corresponding Active Directory user account. This can result from Active Directory replication latency. For example, if a mailbox-enabled user account is disabled in Active Directory but isn't marked as disabled in the Exchange mailbox store. In this case, running the Update-StoreMailboxState will synchronize the mailbox store state with the state of the Active Directory user account and mark the mailbox as disabled in the mailbox store. You can use this command to troubleshoot issues that may be a result when the store state for a mailbox is unexpected or if you suspect that the store state is different than the state for the corresponding Active Directory account. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-StoreMailboxState -Database MDB01 -Identity 4a830e3f-fd07-4629-baa1-8bce16b86d88 -``` - -This example updates the mailbox state for a mailbox located on the mailbox database MDB01 and whose GUID is 4a830e3f-fd07-4629-baa1-8bce16b86d88. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxStatistics -Database MDB02 | ForEach { Update-StoreMailboxState -Database $_.Database -Identity $_.MailboxGuid -Confirm:$false } -``` - -This example updates the mailbox state for all mailboxes on the mailbox database MDB02. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxStatistics -Database MDB03 | Where { $_.DisconnectReason -ne $null } | ForEach { Update-StoreMailboxState -Database $_.Database -Identity $_.MailboxGuid -Confirm:$false } -``` - -This example updates the mailbox state for all disconnected mailboxes on the mailbox database MDB03. - -## PARAMETERS - -### -Database -The Database parameter specifies the identity of the mailbox database that contains the mailbox that you want to update the store state for. This parameter accepts the following values: - -- Database name - -- GUID - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the mailbox that you want to update the store state for. 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. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5e24a849-4961-4a7b-840e-0aede87a2bf1.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Add-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/mailboxes/Add-MailboxFolderPermission.md deleted file mode 100644 index de21c21ce5..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Add-MailboxFolderPermission.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-MailboxFolderPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Add-MailboxFolderPermission cmdlet to add folder-level permissions for users in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-MailboxFolderPermission [-Identity] <MailboxFolderIdParameter> -AccessRights <MailboxFolderAccessRight[]> - -User <MailboxFolderUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [-SendNotificationToUser <$true | $false>] [-SharingPermissionFlags <None | Delegate | CanViewPrivateItems>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-MailboxFolderPermission -Identity ayla@contoso.com:\Marketing -User ed@contoso.com -AccessRights Owner -``` - -This example grants the Owner role to Ed on the Marketing folder in Ayla's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Add-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User julia@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate -``` - -In Office 365, this example adds Julia as a calendar delegate to Ayla's mailbox, but without access to private items. - -### -------------------------- Example 3 -------------------------- -``` -Add-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User laura@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate,CanViewPrivateItems -``` - -In Office 365, this example adds Laura as a calendar delegate to Ayla's mailbox with access to private items. - -## PARAMETERS - -### -AccessRights -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. - -The following individual permissions are available: - -- CreateItems: The user can create items within the specified folder. - -- CreateSubfolders: The user can create subfolders in the specified folder. - -- DeleteAllItems: The user can delete all items in the specified folder. - -- DeleteOwnedItems: The user can only delete items that they created from the specified folder. - -- EditAllItems: The user can edit all items in the specified folder. - -- EditOwnedItems: The user can only edit items that they created in the specified folder. - -- FolderContact: The user is the contact for the specified public folder. - -- FolderOwner: The user is the owner of the specified folder. The user can view the folder, move the folder and create subfolders. The user can't read items, edit items, delete items or create items. - -- FolderVisible: The user can view the specified folder, but can't read or edit items within the specified public folder. - -- ReadItems: The user can read items within the specified folder. - -The roles that are available, along with the permissions that they assign, are described in the following list: - -- Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems - -- Contributor: CreateItems, FolderVisible - -- Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems - -- None: FolderVisible - -- NonEditingAuthor: CreateItems, FolderVisible, ReadItems - -- Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems - -- PublishingEditor: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems - -- PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems - -- Reviewer: FolderVisible, ReadItems - -The following roles apply specifically to calendar folders: - -- AvailabilityOnly: View only availability data - -- LimitedDetails: View availability data with subject and location - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Example values for the Identity parameter are john@contoso.com:\\Calendar or John:\\Marketing\\Reports. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -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 - -- Mail users - -- Mail-enabled security groups - -You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailboxFolderUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendNotificationToUser -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: - -- $true: A sharing invitation is sent. - -- $false: No sharing invitation is sent. This is the default value. - -This parameter only applies to calendar folders and can only be used with the following AccessRights parameter values: - -- AvailabilityOnly - -- LimitedDetails - -- Reviewer - -- Editor - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingPermissionFlags -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. - -- 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. - -```yaml -Type: None | Delegate | CanViewPrivateItems -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/73f4e8e8-1673-4f58-8353-2f7a597a0a23.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Add-MailboxPermission.md b/exchange/exchange-ps/exchange/mailboxes/Add-MailboxPermission.md deleted file mode 100644 index f1d12c1f6b..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Add-MailboxPermission.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-MailboxPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Add-MailboxPermission cmdlet to add permissions to a mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AccessRights -``` -Add-MailboxPermission [-Identity] <MailboxIdParameter> -AccessRights <MailboxRights[]> -User <SecurityPrincipalIdParameter> - [-AutoMapping <$true | $false>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-WhatIf] [<CommonParameters>] -``` - -### Owner -``` -Add-MailboxPermission [-Identity] <MailboxIdParameter> -Owner <SecurityPrincipalIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-WhatIf] [<CommonParameters>] -``` - -### Instance -``` -Add-MailboxPermission -Instance <MailboxAcePresentationObject> - [-AccessRights <MailboxRights[]>] - [-User <SecurityPrincipalIdParameter>] - [-AutoMapping <$true | $false>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [[-Identity] <MailboxIdParameter>] - [-IgnoreDefaultScope] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the mailbox object that's specified by the Identity 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-MailboxPermission -Identity "Terry Adams" -User "Kevin Kelly" -AccessRights FullAccess -InheritanceType All -``` - -This example assigns the user Kevin Kelly Full Access permission to Terry Adams's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Add-MailboxPermission -Identity "Room 222" -Owner "Tony Smith" -``` - -This example sets the user Tony Smith as the owner of the resource mailbox named Room 222. - -### -------------------------- Example 3 -------------------------- -``` -Add-MailboxPermission -Identity "Jeroen Cool" -User "Mark Steele" -AccessRights FullAccess -InheritanceType All -AutoMapping $false -``` - -This example assigns the user Mark Steele Full Access permission to Jeroen Cool's mailbox, prevents Outlook from opening Jeroen Cool's mailbox when Mark Steele opens Outlook. - -### -------------------------- Example 4 -------------------------- -``` -Get-Mailbox -ResultSize unlimited -Filter {(RecipientTypeDetails -eq 'UserMailbox') -and (Alias -ne 'Admin')} | Add-MailboxPermission -User admin@contoso.com -AccessRights FullAccess -InheritanceType All -``` - -In Office 365, this example assigns the administrator account admin@contoso.com Full Access permission to all user mailboxes in the contoso.com Office 365 organization. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: AccessRights, Owner -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept 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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AccessRights -The AccessRights parameter specifies the permission that you want to assign to the user on the mailbox. Valid values are: - -- ChangeOwner - -- ChangePermission - -- DeleteItem - -- ExternalAccount - -- FullAccess - -- ReadPermission - -You can specify multiple values separated by commas. - -```yaml -Type: MailboxRights[] -Parameter Sets: AccessRights -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: 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 -``` - -### -Instance -This parameter has been deprecated and is no longer used. - -```yaml -Type: MailboxAcePresentationObject -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Owner -The Owner parameter specifies the owner of the mailbox object. The default mailbox owner is NT AUTHORITY\\SELF. - -The owner 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 owner. For example: - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user that you're assigning the permission to. - -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: - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SecurityPrincipalIdParameter -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 -``` - -### -AutoMapping -The AutoMapping parameter specifies whether to enable or disable the auto-mapping feature in Microsoft Outlook that uses Autodiscover to automatically open other mailboxes for the user. Valid values are: - -- $true: Outlook automatically opens the mailbox where the user is assigned Full Access permission. This is the default value. - -- $false: Outlook doesn't automatically open the mailbox where the user is assigned Full Access permission. - -If you've already assign the user Full Access to the mailbox, and you want to prevent the mailbox from automatically opening in the user's Outlook, you need to remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet, and then assign the permission to the user on the mailbox again, but this time include -AutoMapping $false in the command. - -```yaml -Type: $true | $false -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: $true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Deny -The Deny switch specifies whether to deny the specified permissions to the user on the mailbox. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InheritanceType -The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: - -- All - -- Children - -- Descendents[sic] - -- SelfAndChildren - -```yaml -Type: None | All | Descendents | SelfAndChildren | Children -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a9aacbf5-5e6c-47ef-95d6-e24547e95d01.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Add-RecipientPermission.md b/exchange/exchange-ps/exchange/mailboxes/Add-RecipientPermission.md deleted file mode 100644 index 8b25832e19..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Add-RecipientPermission.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Add-RecipientPermission -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Add-RecipientPermission - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Add-RecipientPermission cmdlet to add SendAs permission to users in a cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-RecipientPermission [-Identity] <RecipientIdParameter> -AccessRights <MultiValuedProperty> - -Trustee <SecurityPrincipalIdParameter> [-SkipDomainValidationForMailContact] [-SkipDomainValidationForMailUser] [-SkipDomainValidationForSharedMailbox] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -SendAs permission allows a user or group members to send messages that apear to come from the specified mailbox, mail contact, mail user, or group. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-RecipientPermission "Help Desk" -AccessRights SendAs -Trustee "Ayla Kol" -``` - -This example gives the user Ayla Kol SendAs permission for the mailbox Help Desk. Ayla can send messages that appear to come directly from the Help Desk mailbox. - -## PARAMETERS - -### -AccessRights -The AccessRights parameter specifies the permission. The only value for this parameter is SendAs. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -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: - -- Mailboxes - -- Mail users - -- External contacts - -- Distribution groups - -- Dynamic distribution groups - -You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Trustee -The Trustee parameter specifies the user or group that receives SendAs perimission 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 - -- Mail users with a Microsoft account (formerly known as a Windows Live ID) - -- Security groups - -You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SkipDomainValidationForMailContact -The SkipDomainValidationForMailContact switch skips the check that confirms the proxy addresses of the external contact specified by the Identity parameter are in the accepted domains 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDomainValidationForMailUser -The SkipDomainValidationForMailUser switch skips the check that confirms the proxy addresses of the mail user specified by the Identity parameter are in the accepted domains 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDomainValidationForSharedMailbox -The SkipDomainValidationForSharedMailbox switch skips the check that confirms the proxy addresses of the shared mailbox specified by the Identity parameter are in the accepted domains 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0740023b-47df-4f36-bcb9-ce3b0707a6d4.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Disable-App.md b/exchange/exchange-ps/exchange/mailboxes/Disable-App.md deleted file mode 100644 index 2a509f3a16..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Disable-App.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-App -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Disable-App cmdlet to disable (turn off) a specific app for a specific user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-App [-Identity] <AppIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## 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). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b -Mailbox Tony -``` - -This example disables the Bing Maps app for user Tony. - -For more information, see Manage user access to add-ins for Outlook (https://technet.microsoft.com/library/jj943757.aspx). - -### -------------------------- Example 2 -------------------------- -``` -Disable-App -Identity <GUID for FinanceTestApp> -Mailbox Tony -``` - -This example disables the administrator-installed app FinanceTestApp for user Tony. - -For more information, see Manage user access to add-ins for Outlook (https://technet.microsoft.com/library/jj943757.aspx). - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the mailbox or mail user. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1e78ce38-eebf-4460-92d1-1296edb81983.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Disable-InboxRule.md b/exchange/exchange-ps/exchange/mailboxes/Disable-InboxRule.md deleted file mode 100644 index 9602b58648..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Disable-InboxRule.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-InboxRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Disable-InboxRule cmdlet to disable existing Inbox rules in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-InboxRule [-Identity] <InboxRuleIdParameter> [-AlwaysDeleteOutlookRulesBlob] [-Confirm] - [-DomainController <Fqdn>] [-Force] [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-InboxRule -Identity "MoveAnnouncements" -Mailbox "Joe@Contoso.com" -``` - -This example disables the Inbox rule MoveAnnoncements in the mailbox Joe@Contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the name of the Inbox rule to be disabled. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89ac946b-575e-460c-8a9f-a775d22c87e9.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Disable-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Disable-Mailbox.md deleted file mode 100644 index 59a0826e4d..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Disable-Mailbox.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Disable-Mailbox cmdlet to disable the mailbox of existing users who already have mailboxes. For this cmdlet, a user could also be a public folder mailbox or an InetOrgPerson object. The user account that's associated with the mailbox remains, but it's no longer associated with a mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Arbitration -``` -Disable-Mailbox [-Identity] <MailboxIdParameter> [-Arbitration] [-DisableLastArbitrationMailboxAllowed] [-DisableArbitrationMailboxWithOABsAllowed] - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-IgnoreLegalHold] - [-WhatIf] [<CommonParameters>] -``` - -### Archive -``` -Disable-Mailbox [-Identity] <MailboxIdParameter> [-Archive] [-PermanentlyDisable] - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-IgnoreLegalHold] - [-WhatIf] [<CommonParameters>] -``` - -### PublicFolder -``` -Disable-Mailbox [-Identity] <MailboxIdParameter> [-Confirm] [-PublicFolder] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-IgnoreLegalHold] - [-WhatIf] [<CommonParameters>] -``` - -### RemoteArchive -``` -Disable-Mailbox [-Identity] <MailboxIdParameter> [-RemoteArchive] - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-IgnoreLegalHold] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-Mailbox cmdlet removes the mailbox's Exchange attributes from Active Directory. The mailbox isn't deleted and can be reconnected to its user at a later date by using the Connect-Mailbox cmdlet. - -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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-Mailbox -Identity "John Woods" -``` - -This example disables the mailbox of the user named John Woods and removes all mailbox attributes from John's user account.. - -### -------------------------- Example 2 -------------------------- -``` -Disable-Mailbox -Identity "John Woods" -RemoteArchive -``` - -This example disables the remote archive for the on-premises user named John Woods. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to mailbox-disable. You can use any value that uniquely identifies the mailbox. For example: - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -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 -``` - -### -Archive -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Archive -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableArbitrationMailboxWithOABsAllowed -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -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 -``` - -### -DisableLastArbitrationMailboxAllowed -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. - -After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -``` - -### -PermanentlyDisable -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. - -You can only use this switch on user mailboxes that aren't licensed and aren't on hold. - -```yaml -Type: SwitchParameter -Parameter Sets: Archive -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -This parameter is available only in on-premises Exchange. - -The PublicFolderswitch specifies that the mailbox to mailbox-disable is a public folder mailbox. You need to use this switch to mailbox-disable a public folder mailbox. You don't need to specify a value with this switch. - -Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder -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 -``` - -### -RemoteArchive -This parameter is available only in on-premises Exchange. - -The RemoteArchiveswitch specifies whether to disconnect the remote archive for this mailbox. A remote archive exists 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. - -You can't use this switch with the Archive switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoteArchive -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/33be55a3-1880-437d-a631-c1cca1736421.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Disable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/mailboxes/Disable-ServiceEmailChannel.md deleted file mode 100644 index 52a35fef85..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Disable-ServiceEmailChannel.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-ServiceEmailChannel -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-ServiceEmailChannel - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-ServiceEmailChannel cmdlet to disable the .NET service channel for a specific user. The .NET service channel enables Microsoft Exchange to store information that it later forwards to applications or devices that aren't permanently connected to the server running Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-ServiceEmailChannel [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-ServiceEmailChannel -Identity JeffHay -``` - -This example disables the .NET service channel for the user Jeff Hay. - -### -------------------------- Example 2 -------------------------- -``` -Disable-ServiceEmailChannel -Identity JeffHay -Confirm $true -``` - -This example disables the .NET service channel for the user Jeff Hay after confirmation is given. - -### -------------------------- Example 3 -------------------------- -``` -Disable-ServiceEmailChannel -Identity JeffHay -Confirm $false -``` - -This example disables the .NET service channel for the user Jeff Hay without requiring confirmation. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dbaf487e-c303-4e16-b0ad-12e1321b00a5.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Disable-SweepRule.md b/exchange/exchange-ps/exchange/mailboxes/Disable-SweepRule.md deleted file mode 100644 index ce38e70d35..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Disable-SweepRule.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-SweepRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Disable-SweepRule cmdlet to disable Sweep rules in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-SweepRule [-Identity] <SweepRuleIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" -``` - -This example disables the specified Sweep rule. - -### -------------------------- Example 2 -------------------------- -``` -Get-SweepRule -Mailbox laura@contoso.com | Disable-SweepRule -``` - -This example disables all Sweep rules in the specified mailbox. - -## PARAMETERS - -### -Identity -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==). - -- Exchange Online: \<mailbox alias\>\\\<RuleId\> (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. - -- On-premises Exchange: \<mailbox canonical name\>\\\<RuleId\> (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. - -```yaml -Type: SweepRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: 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 Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a78c3b98-8fcf-40b9-95c0-0e27cbc5c7d5.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Enable-App.md b/exchange/exchange-ps/exchange/mailboxes/Enable-App.md deleted file mode 100644 index e6d53dee02..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Enable-App.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-App -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Enable-App cmdlet to enable (turn on) a specific app for a specific user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-App [-Identity] <AppIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Mailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## 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). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b -Mailbox Tony -``` - -This example enables the default Bing Maps app installed for user Tony. - -For more information, see Manage user access to add-ins for Outlook (https://technet.microsoft.com/library/jj943757.aspx). - -### -------------------------- Example 2 -------------------------- -``` -Enable-App -Identity <GUID for FinanceTestApp> -Mailbox Tony -``` - -This example enables the administrator-installed app FinanceTestApp for user Tony. - -For more information, see Manage user access to add-ins for Outlook (https://technet.microsoft.com/library/jj943757.aspx). - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the mailbox or mail user. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/616079e2-3cbd-43e9-8e71-098374943cf0.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Enable-InboxRule.md b/exchange/exchange-ps/exchange/mailboxes/Enable-InboxRule.md deleted file mode 100644 index 2215b1b32c..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Enable-InboxRule.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-InboxRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Enable-InboxRule cmdlet to enable an Inbox rule. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-InboxRule [-Identity] <InboxRuleIdParameter> [-AlwaysDeleteOutlookRulesBlob] [-Confirm] - [-DomainController <Fqdn>] [-Force] [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-InboxRule "Move To Junk Mail" -Mailbox "User 1" -``` - -This example enables the Inbox rule named Move To Junk Mail in the mailbox that belongs to User 1. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the display name or GUID of the Inbox rule. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e5c09ede-71eb-42d1-9767-c572d6839c47.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Enable-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Enable-Mailbox.md deleted file mode 100644 index 980e8186d4..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Enable-Mailbox.md +++ /dev/null @@ -1,980 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Enable-Mailbox cmdlet to create mailboxes for existing users who don't already have mailboxes. You can also use this cmdlet to create In-Place archives for existing mailboxes. - -Note: In Exchange Online, this cmdlet doesn't activate/enable a mailbox the same way it does in on-premises Exchange. To add a mailbox for an existing Azure AD account, you can simply add a license to the account by using the Set-MsolUserLicense cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Arbitration -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-Arbitration] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### RemoteArchive -``` -Enable-Mailbox [-Identity] <UserIdParameter> -ArchiveDomain <SmtpDomain> - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemoteArchive] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Discovery -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-Discovery] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Equipment -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-Equipment] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### LinkedRoomMailbox -``` -Enable-Mailbox [-Identity] <UserIdParameter> -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-LinkedCredential <PSCredential>] [-LinkedRoom] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-ArchiveGuid <Guid>] - [-ArchiveName <MultiValuedProperty>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Linked -``` -Enable-Mailbox [-Identity] <UserIdParameter> -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-LinkedCredential <PSCredential>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### PublicFolder -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-PublicFolder] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-HoldForMigration] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Room -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-Room] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Shared -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-Shared] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### User -``` -Enable-Mailbox [-Identity] <UserIdParameter> - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Archive -``` -Enable-Mailbox [-Identity] <UserIdParameter>] [-Archive] [-ArchiveDatabase <DatabaseIdParameter> [-ArchiveGuid <Guid>] [-ArchiveName <MultiValuedProperty>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String> - [-Confirm] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AuditLog -``` -Enable-Mailbox [-Identity] <UserIdParameter> [AuditLog] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-PrimarySmtpAddress <SmtpAddress>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AutoExpandingArchive -``` -Enable-Mailbox [-Identity] <UserIdParameter> [-AutoExpandingArchive] - [-Confirm] - [-Force] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-Mailbox cmdlet mailbox-enables existing users, public folders, or InetOrgPerson objects by adding the mailbox attributes that are required by Exchange. When the user logs on to the mailbox or receives email messages, the mailbox object is actually created in the Exchange database. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-Mailbox -Identity Ayla -``` - -This example creates a mailbox for the existing user named Ayla. - -### -------------------------- Example 2 -------------------------- -``` -Enable-Mailbox -Identity Ayla -Archive -``` - -This example creates an In-Place archive for the existing user name Ayla who already has a mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Enable-Mailbox -Identity ayla@contoso.com -RemoteArchive -ArchiveDomain "archive.contoso.com" -``` - -This example creates a remote archive for the existing on-premises user named Ayla. The archive is created in the cloud-based organization that uses the domain archive.contoso.com. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -Only use this parameter if the archive is hosted in the cloud-based service. - -```yaml -Type: SmtpDomain -Parameter Sets: RemoteArchive -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Discovery -The Discoveryswitch specifies that the mailbox is a Discovery mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a Discovery mailbox. - -Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be converted to another type of mailbox. For more information, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Equipment -This parameter is available only in on-premises Exchange. - -The Equipment parameter specifies that the resource mailbox is an equipment mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling an equipment resource mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Equipment -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -This parameter is required only if you're enabling a linked mailbox. - -```yaml -Type: String -Parameter Sets: LinkedRoomMailbox, Linked -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedMasterAccount -This parameter is available only in on-premises Exchange. - -The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -This parameter is required only if you're enabling a linked mailbox. - -```yaml -Type: UserIdParameter -Parameter Sets: LinkedRoomMailbox, Linked -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedRoom -This parameter is available only in on-premises Exchange. - -The LinkedRoomswitchspecifies that the mailbox is a linked resource mailbox. You don't need to specify a value with this switch. - -A linked resource mailbox is useful in a scenario where you have an account in an authentication forest and you want it to be directly linked to a resource mailbox in resource forest. - -```yaml -Type: SwitchParameter -Parameter Sets: LinkedRoomMailbox -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -This parameter is available only in on-premises Exchange. - -The PublicFolderswitch specifies that the mailbox is a public folder mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a public folder mailbox. - -Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Room -This parameter is available only in on-premises Exchange. - -The Roomswitch specifies that the resource mailbox is a room mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a room resource mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Room -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -This parameter is available only in on-premises Exchange. - -The Sharedswitch specifies that the mailbox is a shared mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a shared mailbox. - -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveSyncMailboxPolicy -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:. - -- Name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default mobile device mailbox policy is applied to the mailbox. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddressBookPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -For more information about address book policies, see Address book policies (https://technet.microsoft.com/library/hh529948.aspx). - -```yaml -Type: AddressBookMailboxPolicyIdParameter -Parameter Sets: User -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 -``` - -### -Alias -This parameter is available only in on-premises Exchange. - -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Archive -The Archiveswitchcreates 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveDatabase -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Archive -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 -``` - -### -ArchiveGuid -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: Archive -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 -``` - -### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook and Outlook Web App. - -If you don't use this parameter, the default value is In-Place Archive - \<Mailbox User's Display Name\>. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Archive -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 -``` - -### -AuditLog -This parameter is availble only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: AuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoExpandingArchive -This parameter is available only in the cloud-based service. - -The AutoExpandingArchive switch enables the unlimited archiving feature (called auto-expanding archiving) for the specified mailbox. You don't need to specify a value with this switch. - -After you enable auto-expanding archiving, additional storage space is automatically added to the user's archive mailbox when it approaches the storage limit. - -Notes: - -- The user's archive mailbox has to be enabled before auto-expanding archiving can be enabled. - -- After you enable auto-expanding archiving for the user's mailbox, it can't be disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: AutoExpandingArchive -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -Database -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 ("). - -If you don't use DisplayName parameter, the value of the Name property is used for the display name. - -```yaml -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -HoldForMigration -This parameter is available only in on-premises Exchange. - -The HoldForMigrationswitch 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. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder -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 -``` - -### -LinkedCredential -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. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: LinkedRoomMailbox, Linked -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 -``` - -### -ManagedFolderMailboxPolicy -This parameter is available or functional 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. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedFolderMailboxPolicyAllowed -This parameter is available or functional only in Exchange Server 2010. - -The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Outlook earlier than Office Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used. - -Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -This parameter is available only in on-premises Exchange. - -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteArchive -This parameter is available only in on-premises Exchange. - -The RemoteArchiveswitch 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. - -You need to use this parameter with the ArchiveDomain parameter, and you can't use this parameter with the Archive parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoteArchive -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 -``` - -### -RetentionPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoleAssignmentPolicy -The RoleAssignmentPolicy parameter specifies the management role assignment policy that's assign to the mailbox. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default role assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of $null. For more information about assignment policies, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/58de5b3c-05c3-4a1f-84c6-f082d990f22b.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Enable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/mailboxes/Enable-ServiceEmailChannel.md deleted file mode 100644 index ae80cc185b..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Enable-ServiceEmailChannel.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-ServiceEmailChannel -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-ServiceEmailChannel - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-ServiceEmailChannel cmdlet to enable the .NET service channel for a specific user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-ServiceEmailChannel [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-ServiceEmailChannel -Identity "fourthcoffee\tony" -``` - -This example enables the .NET service channel for the user Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -Enable-ServiceEmailChannel -Identity "tony@contoso.com" -``` - -This example enables the .NET service channel for the user Tony Smith. - -### -------------------------- Example 3 -------------------------- -``` -Enable-ServiceEmailChannel -Identity "TonySmith" -``` - -This example enables the .NET service channel for the user Tony Smith. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e1cdca04-2d84-49dd-8a64-e19b8ab52ca3.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Enable-SweepRule.md b/exchange/exchange-ps/exchange/mailboxes/Enable-SweepRule.md deleted file mode 100644 index 396ac0a6ec..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Enable-SweepRule.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-SweepRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Enable-SweepRule cmdlet to enable Sweep rules in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-SweepRule [-Identity] <SweepRuleIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" -``` - -This example enables the specified Sweep rule. - -### -------------------------- Example 2 -------------------------- -``` -Get-SweepRule -Mailbox laura@contoso.com | Enable-SweepRule -``` - -This example enables all Sweep rules in the specified mailbox. - -## PARAMETERS - -### -Identity -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==). - -- Exchange Online: \<mailbox alias\>\\\<RuleId\> (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. - -- On-premises Exchange: \<mailbox canonical name\>\\\<RuleId\> (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. - -```yaml -Type: SweepRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: 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 Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ce918d8d-448b-4e67-927f-6aaa35581882.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/mailboxes/Export-MailboxDiagnosticLogs.md deleted file mode 100644 index ac1e6aa201..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Export-MailboxDiagnosticLogs.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-MailboxDiagnosticLogs -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Export-MailboxDiagnosticLogs cmdlet to export diagnostic data from user and system mailboxes in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MailboxLog -``` -Export-MailboxDiagnosticLogs [-Identity] <GeneralMailboxIdParameter> -ComponentName <String> - [-Archive] - [-Confirm] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-WhatIf] [<CommonParameters>] -``` - -### ExtendedProperties -``` -Export-MailboxDiagnosticLogs [-Identity] <GeneralMailboxIdParameter> [-ExtendedProperties] - [-Archive] - [-Confirm] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Export-MailboxDiagnosticLogs -ComponentName OOF -Identity JohnSmith -``` - -In Exchange Server 2010 and 2013, this example retrieves the out-of-office diagnostic log for the user John Smith. - -### -------------------------- Example 2 -------------------------- -``` -Export-MailboxDiagnosticLogs -ComponentName CalendarPermissions -Identity "Yuuto Sasaki" -``` - -This example retrieves the calendar permissions diagnostic log for the mailbox named Yuuto Sasaki. - -## PARAMETERS - -### -ComponentName -The ComponentName parameter specifies the component that you want to retrieve the diagnostic logs for. Valid values depend on the type and location of the mailbox (on-premises or Exchange Online). Possible values are: - -- BirthdayAssistant - -- CalendarPermissions - -- CalendarSharingLocalFolder - -- DefaultViewIndexer - -- FreeBusyPublishingAssistantQuickLog - -- HoldTracking - -- InternetCalendar - -- MRM - -- OOFRules - -- RemindersAssistant - -- SharingMigrationAssistant - -- SharingSyncAssistant - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedProperties -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Archive -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/28191e78-1cbb-4d90-a909-80a2a9883173.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Export-RecipientDataProperty.md b/exchange/exchange-ps/exchange/mailboxes/Export-RecipientDataProperty.md deleted file mode 100644 index d39c649d69..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Export-RecipientDataProperty.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-RecipientDataProperty -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Export-RecipientDataProperty - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Export-RecipientDataProperty cmdlet to download a user's picture or spoken name sound file. The picture and audio files display in the Global Address List property dialog box, contact card, reading pane, and meeting requests in Microsoft Outlook and Outlook on the web. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ExportPicture -``` -Export-RecipientDataProperty [-Identity] <MailboxUserContactIdParameter> [-Picture] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### ExportSpokenName -``` -Export-RecipientDataProperty [-Identity] <MailboxUserContactIdParameter> [-SpokenName] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Export-RecipientDataProperty -Identity tony@contoso.com -SpokenName | ForEach { $_.FileData | Add-Content C:\tonysmith.wma -Encoding Byte} -``` - -This example exports Tony Smith's spoken name audio file and saves it to the local computer. - -### -------------------------- Example 2 -------------------------- -``` -Export-RecipientDataProperty -Identity "Ayla" -Picture | ForEach { $_.FileData | Add-Content C:\aylakol.jpg -Encoding Byte} -``` - -This example exports Ayla Kol's picture file to the local computer. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailboxUserContactIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -Picture -The Picture switch specifies that the file you're exporting is the user's picture file. You don't need to specify a value with this switch. - -You can't use this switch with the SpokenName switch. You can only export one file type at a time. - -```yaml -Type: SwitchParameter -Parameter Sets: ExportPicture -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 -``` - -### -SpokenName -The SpokenName switch specifies that the file you're exporting is the user's audio file. You don't need to specify a value with this switch. - -This cmdlet exports the WMA 9-voice format. You can't use this switch with the Picture switch. You can only export one file type at a time. - -```yaml -Type: SwitchParameter -Parameter Sets: ExportSpokenName -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/95ad02a9-8874-455e-b697-e39a47b4a032.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-App.md b/exchange/exchange-ps/exchange/mailboxes/Get-App.md deleted file mode 100644 index 2f1c8dadd3..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-App.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-App -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-App cmdlet to view installed apps. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-App [[-Identity] <AppIdParameter>] [-DomainController <Fqdn>] [-Mailbox <MailboxIdParameter>] - [-OrganizationApp] [-PrivateCatalog] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-App -Mailbox Tony -``` - -This example returns the summary list of apps installed for user Tony. The command returns the name of the app, whether the app is enabled, and the app version number. - -### -------------------------- Example 2 -------------------------- -``` -Get-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b | Format-List -``` - -This example displays detailed information for the Bing Maps app for the currently logged on user. - -### -------------------------- Example 3 -------------------------- -``` -Get-App -OrganizationApp -``` - -This example displays the summary list of apps installed by administrators for the entire organization. - -For information about installing or removing apps for Outlook, see Install or remove add-ins for Outlook for your organization (https://technet.microsoft.com/library/jj943752.aspx). - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -You can't use this parameter with the Identity parameter. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationApp -The OrganizationAppswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateCatalog -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/85dfb69d-d637-410e-931c-36685dda84c7.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md deleted file mode 100644 index d3236b1eb4..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarDiagnosticAnalysis -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-CalendarDiagnosticAnalysis - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-CalendarDiagnosticAnalysis cmdlet to troubleshoot calendar-related reliability issues. You can use this cmdlet to analyze calendar item data that's recorded in the Calendar Diagnostic logs. You provide the calendar item data to this cmdlet by using the Get-CalendarDiagnosticLog cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### DefaultSet -``` -Get-CalendarDiagnosticAnalysis -CalendarLogs <CalendarLog[]> - [-DetailLevel <Basic | Advanced>] - [-GlobalObjectId <String>] - [-OutputAs <HTML | CSV | XML>] - [<CommonParameters>] -``` - -### LocationSet -``` -Get-CalendarDiagnosticAnalysis -LogLocation <String[]> - [-DetailLevel <Basic | Advanced>] - [-GlobalObjectId <String>] - [-OutputAs <HTML | CSV | XML>] - [<CommonParameters>] -``` - -## DESCRIPTION -The following properties of the calendar item are returned in the default output of the cmdlet (when the DetailLevel parameter is set to Basic): - -- Local Log Time - -- ItemId - -- NormalizedSubject - -- StartTime - -- EndTime - -- CalendarLogTriggerAction - -- ClientInfoString - -- OriginalLastModifiedTime - -- ClientIntent - -- CleanGlobalObjectId - -- ItemClass - -- ParentDisplay - -- Duration - -- AppointmentRecurring - -- SentRepresentingEmailAddress - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$logs = Get-CalendarDiagnosticLog -Identity oevans -MeetingID 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F; Get-CalendarDiagnosticAnalysis -CalendarLogs $logs -DetailLevel Advanced> "C:\My Documents\Oscar Evans Analysis.csv" -``` - -This example gets the specified calendar item from Oscar Evans' mailbox, stores the item as a variable and writes the advanced analysis of the item to a CSV file. - -For basic analysis of the item, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. - -### -------------------------- Example 2 -------------------------- -``` -Get-CalendarDiagnosticAnalysis -LogLocation "C:\My Documents\Exported Calendar Logs\jkozma@contoso.com" -DetailLevel Advanced -OutputAs HTML > "C:\My Documents\Jasen Kozma Analysis.html" -``` - -This example analyzes the calendar items that were exported from Jasen Kozma's mailbox by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter and writes the advanced analysis of the items to an HTML file. - -For basic analysis of the items, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. - -## PARAMETERS - -### -CalendarLogs -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. - -Note that you can't use this parameter to analyze multiple calendar items. The value that you use for this parameter must identify a single item. - -You can't use this parameter with the LogLocation parameter. - -```yaml -Type: CalendarLog[] -Parameter Sets: DefaultSet -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLocation -The LogLocation parameter specifies the location of the exported calendar items that you want to analyze. You can specify a local path, or a UNC path (\\\\\<Server\>\\\<Share\>\\\<User\>). If the value contains spaces, enclose the value in quotation marks ("). - -You export the calendar items to .msg files by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter. If the path contains multiple .msg files, all of those files are analyzed when you run Get-CalendarDiagnosticAnalysis. - -You can't use this parameter with the CalendarLogs parameter. - -```yaml -Type: String[] -Parameter Sets: LocationSet -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailLevel -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. - -- Advanced: 37 additional calendar item properties are returned. You should use this value only for detailed debugging information. - -```yaml -Type: Basic | Advanced -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalObjectId -The GlobalObjectId parameter specifies the identity of the calendar item you want to analyze. You can use this parameter with the LogLocation parameter to specify the calendar item if the location contains multiple exported .msg files. - -The GlobalObjectId 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). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputAs -The OutputAs parameter specifies the output format of the command. Valid values are: - -- CSV (This is the default value) - -- HTML - -- XML - -```yaml -Type: HTML | CSV | XML -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1ccb3442-1101-45c5-8508-599af6e56076.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticLog.md deleted file mode 100644 index 820d6f1dbb..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticLog.md +++ /dev/null @@ -1,413 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarDiagnosticLog -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-CalendarDiagnosticLog - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-CalendarDiagnosticLog cmdlet to collect a range of calendar logs. The Calendar Diagnostic logs track all calendar items and meeting requests in mailboxes. You can use this information to troubleshoot calendar issues that occur in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MeetingId -``` -Get-CalendarDiagnosticLog [-Identity] <MailboxIdParameter> -MeetingID <String> [-EndDate <ExDateTime>] [-Latest] [-StartDate <ExDateTime>] [-Subject <String>] [-EntryId <String>] [-ExactMatch <$true | $false>] [-ItemClass <String[]>] [-ItemIds <String[]>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-LogLocation <String>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -### MeetingSubject -``` -Get-CalendarDiagnosticLog [-Identity] <MailboxIdParameter> -Subject <String> - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-LogLocation <String>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## 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. - -- 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CalendarDiagnosticLog -Identity "Shannon Steele" -Subject "Weekly development meeting" -ExactMatch $true -``` - -This example retrieves the Calendar Diagnostic log entries for Shannon Steele's mailbox by using the subject Weekly development meeting. - -### -------------------------- Example 2 -------------------------- -``` -Get-CalendarDiagnosticLog -Identity oevans -StartDate "6/1/2018 6:00:00 AM" -EndDate "6/30/2018 5:00:00 PM" -``` - -This example retrieves the Calendar Diagnostic log entries for Oscar Evans' mailbox from 6/1/2018 to 6/30/2018. - -### -------------------------- Example 3 -------------------------- -``` -Get-CalendarDiagnosticLog -Identity jkozma@contoso.com -Subject "Weekly development meeting" -Latest -``` - -This example retrieves the Calendar Diagnostic log data only for the most recent calendar item in Jasen Kozma's mailbox with a message subject of "Weekly development meeting". - -### -------------------------- Example 4 -------------------------- -``` -Get-CalendarDiagnosticLog -Identity "Jasen Kozma" -Subject "Budget Meeting" -ExactMatch $true -LogLocation "C:\My Documents\Calendar Diagnostic Export" -``` - -This example exports all calendar items in the Calendar Diagnostic log for Jasen Kozma's mailbox that have "Budget Meeting" anywhere in the subject to the specified folder. - -Notes: - -- In this example, the message files are written to C:\\My Documents\\Calendar Diagnostic Export\\jkozma@contoso.com. - -- In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that contains the calendar items. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MeetingID -The MeetingID parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGloablObjectId 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 CleanGloablObjectId value for the MeetingID parameter in future commands. - -Don't use this parameter with the Subject parameter, because the value of the MeetingID parameter takes precedence. - -```yaml -Type: String -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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: MeetingId -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: String -Parameter Sets: MeetingSubject -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryId -The EntryId parameter filters the results by entry ID. You can specify multiple values separated by commas. - -```yaml -Type: String -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExactMatch -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. - -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. - -You only use this parameter with the Subject parameter. - -The value of this parameter is ignored when you use the MeetingId parameter. - -```yaml -Type: $true | $false -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemClass -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. - -```yaml -Type: String[] -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemIds -The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. - -```yaml -Type: String[] -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Latest -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: MeetingId -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLocation -The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (\\\\\<Server\>\\\<Share\>). If the value contains spaces, enclose the value in quotation marks ("). - -In the location you specify, a subfolder is automatically created for the specified mailbox that holds the exported calendar items. For example, if you specify the value "C:\\My Documents\\Calendar Export" to export calendar items from the mailbox of Shannon Steele, the .msg files are actually stored in C:\\My Documents\\Calendar Export\\ssteele@contoso.com. - -In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files. - -Note: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (\> "C:\\My Documents\\Calendar Export") or substitute the output to a PowerShell variable. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: MeetingId -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/25b0fe23-6b15-4e02-b451-ea90442d54ed.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticObjects.md deleted file mode 100644 index cabe39b3db..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticObjects.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: Get-CalendarDiagnosticObjects -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CalendarDiagnosticObjects - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-CalendarDiagnosticObjects cmdlet to collect a range of calendar logs. The calendar diagnostic logs track important calendar-related event data for each mailbox, and can be used to troubleshoot calendar issues that occur in mailboxes. The logs track all calendar items and meeting messages. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CalendarDiagnosticObjects [-Identity] <UnifiedGroupOrUserMailboxIdParameter> [-Credential <PSCredential>] - [-CustomPropertyNames <String[]>] [-DomainController <Fqdn>] [-EndDate <ExDateTime>] [-EntryId <String>] - [-ExactMatch <$true | $false>] [-ItemClass <String[]>] [-ItemIds <String[]>] [-MeetingId <String>] - [-ReadFromDomainController] [-ResultSize <Unlimited>] [-ShouldBindToItem <$true | $false>] - [-ShouldFetchRecurrenceExceptions <$true | $false>] [-StartDate <ExDateTime>] [-Subject <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -Some of the more interesting properties that are returned in the results are: - -- 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;\<AdditionalDetails\>, Client=WebServices;\<AdditionalDetails\>;, or Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;). - -- OriginalLastModifiedTime: Used as the primary sort field to order the events. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true -``` - -This example retrieves the calendar diagnostic logs from Pedro Pizarro's mailbox for all items where the Subject is an exact match for Team Meeting. - -### -------------------------- Example 2 -------------------------- -``` -$A = Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true; $A | Select-Object *,@{n='OLMT'; e={[DateTime]::Parse($_.OriginalLastModifiedTime.ToString())}} | sort OLMT | Format-Table OriginalLastModifiedTime,CalendarLogTriggerAction,ItemClass,ClientInfoString -``` - -This is the same as the previous example, but now the results are sorted by original last modified time. - -### -------------------------- Example 3 -------------------------- -``` -Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -MeetingID 40000008200E00074C5B7101A82E00800000000693ADAA3B5FCD201000000000000000010000000FF760A70460EAA4096B879872DF24F49 -``` - -This example retrieves the calendar diagnostic logs for Pedro Pizarro's mailbox for a meeting with the specified unique global object ID (GOID). - -### -------------------------- Example 4 -------------------------- -``` -Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Lunch" -StartDate 7/1/2018 -EndDate 7/31/2018 | Export-Csv "C:\My Documents\Team Lunch Meeting.csv" -NoTypeInformation -``` - -This example returns diagnostic information for meetings with the subject Team Lunch in Pedro Pizarro's mailbox in the month of July, 2018, and exports the results to the file C:\\My Documents\\Team Lunch Meeting.csv. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox or Office 365 Group whose calendar you want to view. You can use any value that uniquely identifies the mailbox or Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: UnifiedGroupOrUserMailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomPropertyNames -The CustomPropertyNames parameter returns the specified calendar item custom property in the results. You can specify multiple values separated by commas. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExactMatch -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. - -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. - -You only use this parameter with the Subject parameter. - -The value of this parameter is ignored when you use the MeetingId parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemClass -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemIds -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingId -The MeetingId parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGloablObjectId 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShouldBindToItem -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShouldFetchRecurrenceExceptions -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0a867365-3c95-441a-96ce-c5a8413572a0.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarNotification.md b/exchange/exchange-ps/exchange/mailboxes/Get-CalendarNotification.md deleted file mode 100644 index d39f3e58eb..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarNotification.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarNotification -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-CalendarNotification - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-CalendarNotification cmdlet to return a list of all calendar notification settings for a user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CalendarNotification [-Identity] <MailboxIdParameter> [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CalendarNotification cmdlet retrieves and displays the rules used to trigger the calendar agenda notification, reminder notification, or update notification. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CalendarNotification -Identity "TonySmith" -``` - -This example returns the calendar notification settings for the user Tony Smith using the user's alias. - -### -------------------------- Example 2 -------------------------- -``` -Get-CalendarNotification -Identity tony@contoso.com -ReadFromDomainController -``` - -This example returns the calendar notification settings for the user Tony Smith. - -### -------------------------- Example 3 -------------------------- -``` -Get-CalendarNotification -Identity "contoso\tonysmith" -``` - -This example returns the calendar notification settings for the user Tony Smith using the user's domain and name. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox ID for the user's mailbox. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user credentials used to run the command. This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController parameter specifies whether the command should return data from the domain controller. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the amount of data returned. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/62a20bc1-1e3c-43c5-8a33-94781e24baed.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarProcessing.md b/exchange/exchange-ps/exchange/mailboxes/Get-CalendarProcessing.md deleted file mode 100644 index d0d5be03f3..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-CalendarProcessing.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarProcessing -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-CalendarProcessing cmdlet to view the calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant and calendar configuration. Note that the settings returned by this cmdlet are editable only on resource mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CalendarProcessing [-Identity] <MailboxIdParameter> [-DomainController <Fqdn>] [-ReadFromDomainController] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -For details about the properties that are returned in the output of this cmdlet, see Set-CalendarProcessing (https://docs.microsoft.com/powershell/module/exchange/mailboxes/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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CalendarProcessing -Identity "Room 212" | Format-List -``` - -This example shows the calendar processing options for the resource mailbox Room 212. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8ffece5d-acc9-4061-822e-e452479c03e9.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-Clutter.md b/exchange/exchange-ps/exchange/mailboxes/Get-Clutter.md deleted file mode 100644 index 4c753c46d5..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-Clutter.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: -applicable: Exchange Online -title: Get-Clutter -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-Clutter - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-Clutter cmdlet to view Clutter settings for mailboxes in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-Clutter -Identity <MailboxIdParameter> [<CommonParameters>]``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Clutter -Identity "Constancia Pena" -``` - -This example returns the Clutter settings for the user Constancia Pena. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name>\\\<account name> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/e9dbe496-f4f5-4632-893a-2a6b83aaf2dc.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-FocusedInbox.md b/exchange/exchange-ps/exchange/mailboxes/Get-FocusedInbox.md deleted file mode 100644 index c33f7c91f6..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-FocusedInbox.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: -applicable: Exchange Online -title: Get-FocusedInbox -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-FocusedInbox - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-FocusedInbox cmdlet to view the Focused Inbox configuration for mailboxes in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-FocusedInbox -Identity <MailboxIdParameter> [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FocusedInbox -Identity julia@contoso.com -``` - -This example returns the Focused Inbox configuration for the mailbox of julia@contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name>\\\<account name> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/752ea258-b6e7-41bd-89cc-88eb368d3838.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-InboxRule.md b/exchange/exchange-ps/exchange/mailboxes/Get-InboxRule.md deleted file mode 100644 index 94614aadb1..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-InboxRule.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-InboxRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-InboxRule cmdlet to view Inbox rule properties. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-InboxRule [[-Identity] <InboxRuleIdParameter>] [-DescriptionTimeFormat <String>] - [-DescriptionTimeZone <ExTimeZoneValue>] [-DomainController <Fqdn>] [-Mailbox <MailboxIdParameter>] - [-IncludeHidden] [-BypassScopeCheck] [-SweepRules] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-InboxRule -Mailbox Joe@Contoso.com -``` - -This example retrieves all Inbox rules for the mailbox Joe@Contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "mm/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time" -``` - -This example retrieves the Inbox rule ReceivedLastYear from the mailbox joe@contoso.com on which the ReceivedBeforeDate parameter was set when the rule was created. The DescriptionTimeFormat and DescriptionTimeZone parameters are used in this example to specify formatting of the time and the time zone used in the rule's Description property. - -## PARAMETERS - -### -DescriptionTimeFormat -The DescriptionTimeFormat parameter specifies the format for time values in the rule description. For example: - -mm/dd/yyyy, where mm is the 2-digit month, dd is the 2-digit day and yyyy is the 4-digit year. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DescriptionTimeZone -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"). - -To see the available values, run the following command: $TimeZone = Get-ChildItem "HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Time zones" | foreach {Get-ItemProperty $\_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display - -If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name - -- RuleIdentity property (for example, 16752869479666417665). - -- Exchange Online: \<mailbox alias\>\\\<RuleIdentity\> (for example, rzaher\\16752869479666417665. - -- On-premises Exchange: \<mailbox canonical name\>\\\<RuleIdentity\> (for example, contoso.com/Users/Rick Zaher\\16752869479666417665. - -```yaml -Type: InboxRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -This parameter is available only in on-premises Exchange. - -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassScopeCheck -The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SweepRules -The SweepRules switch specifies whether to return only Sweep rules in the results. You don't need to specify a value with this switch. - -Sweep rules run at regular intervals to help keep your Inbox clean. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b02ad57a-460a-4dc2-a521-788cd893c269.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md deleted file mode 100644 index 6f5226e8e4..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md +++ /dev/null @@ -1,849 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-Mailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-Mailbox [-Anr <String>] - [-Arbitration] - [-Archive] - [-AuditLog] - [-AuxAuditLog] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-InactiveMailboxOnly] - [-IncludeInactiveMailbox] - [-Migration] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-RemoteArchive] - [-ResultSize <Unlimited>] - [-SoftDeletedMailbox] - [-SortBy <String>] - [<CommonParameters>] -``` - -### DatabaseSet -``` -Get-Mailbox [-Database <DatabaseIdParameter>] - [-Arbitration] - [-Archive] - [-AuditLog] - [-AuxAuditLog] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-Migration] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-RemoteArchive] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [<CommonParameters>] -``` - -### Identity -``` -Get-Mailbox [[-Identity] <MailboxIdParameter>] - [-Arbitration] - [-Archive] - [-AuditLog] - [-AuxAuditLog] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-InactiveMailboxOnly] - [-IncludeInactiveMailbox] - [-Migration] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-RemoteArchive] - [-ResultSize <Unlimited>] - [-SoftDeletedMailbox] - [-SortBy <String>] - [<CommonParameters>] -``` - -### ServerSet -``` -Get-Mailbox [-Server <ServerIdParameter>] - [-Arbitration] - [-Archive] - [-AuditLog] - [-AuxAuditLog] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-Migration] - [-Monitoring] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-RemoteArchive] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [<CommonParameters>] -``` - -### MailboxPlanSet -``` -Get-Mailbox [-MailboxPlan <MailboxPlanIdParameter>] - [-Archive] - [-Filter <String>] - [-GroupMailbox] - [-InactiveMailboxOnly] - [-IncludeInactiveMailbox] - [-Migration] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SoftDeletedMailbox] - [-SortBy <String>] [<CommonParameters>] -``` - -### AsyncParameterSet -``` -Get-Mailbox [-Async] -Properties <String[]> - [-Archive] - [-Filter <String>] - [-GroupMailbox] - [-InactiveMailboxOnly] - [-IncludeInactiveMailbox] - [-Migration] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <>] - [-SoftDeletedMailbox] - [-SortBy <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Mailbox -ResultSize unlimited -``` - -This example returns a summary list of all the mailboxes in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-Mailbox -OrganizationalUnit Users -``` - -This example returns a list of all the mailboxes in your organization in the Users OU. - -### -------------------------- Example 3 -------------------------- -``` -Get-Mailbox -Anr Chr -``` - -This example returns all the mailboxes that resolve from the ambiguous name resolution search on the string "Chr". This example returns mailboxes for users such as Chris Ashton, Christian Hess, and Christa Geller. - -### -------------------------- Example 4 -------------------------- -``` -Get-Mailbox -Archive -Server Mailbox01 -``` - -This example returns a summary list of all archive mailboxes on the Mailbox server named Mailbox01. - -### -------------------------- Example 5 -------------------------- -``` -Get-Mailbox -Identity ed@contoso.com -RemoteArchive -``` - -This example returns information about the remote archive mailbox for the user ed@contoso.com. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration switch filters the results by arbitration mailboxes. You don't need to specify a value with this switch. - -Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. - -Notes: - -- If you don't use this switch, the command can't find arbitration mailboxes. - -- To return arbitration mailboxes that are used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration switch. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Archive -The Archive switch specifies whether to include only archive mailboxes in the results. You don't need to specify a value with this switch. - -This switch is required to return archive mailboxes. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Async -This parameter is available only in the cloud-based service. - -{{Fill Async Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: AsyncParameterSet -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -This parameter is available only in the cloud-based service. - -{{Fill Properties Description}} - -```yaml -Type: String[] -Parameter Sets: AsyncParameterSet -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditLog -This parameter is available only in on-premises Exchange. - -The AuxAuditLog switch filters the results by arbitration mailboxes that are used to store audit log settings. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't return this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuxAuditLog -This parameter is available only in on-premises Exchange. - -The AuxAuditLog switch filters the results by arbitration mailboxes that are used to store audit log data. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't return this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -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: - -- Name - -- Distinguished name (DN) - -- GUID - -You can't use this parameter with the Anr, Identity, or Server parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: DatabaseSet -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet -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 -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMailbox -The GroupMailbox switch specifies whether to include only Office 365 groups in the results. You don't need to specify a value with this switch. - -This switch is required to return Office 365 groups. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -You can't use this parameter with the Anr, Database, MailboxPlan or Server parameters. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InactiveMailboxOnly -This parameter is available only in the cloud-based service. - -The InactiveMailboxOnly switch specifies whether to include only inactive mailboxes in the results. You don't need to specify a value with this switch. - -When you use this switch, only inactive mailboxes are included in the results. - -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. - -```yaml -Type: SwitchParameter -Parameter Sets: AnrSet, Identity, MailboxPlanSet, AsyncParameterSet -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeInactiveMailbox -This parameter is available only in the cloud-based service. - -The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. - -When you use this switch, active and inactive mailboxes are included in the results. - -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. - -```yaml -Type: SwitchParameter -Parameter Sets: AnrSet, Identity, MailboxPlanSet, AsyncParameterSet -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxPlan -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: - -- Name - -- Alias - -- Display name - -- Distinguished name (DN) - -- GUID - -A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. - -You can't use this parameter with the Anr or Identity parameters. - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: MailboxPlanSet -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Migration -The Migration switch specifies whether to include only migration mailboxes in the results. You don't need to specify a value with this switch. - -This switch is required to return migration mailboxes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Monitoring -This parameter is available only in on-premises Exchange. - -The Monitoringswitch specifies whether to include only monitoring mailboxes in the results. You don't need to specify a value with this switch. - -This switch is required to return monitoring mailboxes. - -Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet -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 -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -The PublicFolder switch specifies whether to include only public folder mailboxes in the results. You don't need to specify a value with this switch. - -This switch is required to return public folder mailboxes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: - -- DiscoveryMailbox - -- EquipmentMailbox - -- GroupMailbox - -- LegacyMailbox - -- LinkedMailbox - -- LinkedRoomMailbox - -- RoomMailbox - -- SchedulingMailbox - -- SharedMailbox - -- TeamMailbox - -- UserMailbox - -You can specify multiple values separated by commas. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteArchive -This parameter is available only in on-premises Exchange. - -The RemoteArchive switch specifies whether to include only remote archive mailboxes in the results. You don't need to specify a value with this switch. - -This switch is required to return remote archive mailboxes. - -Remote archive mailboxes are archive mailboxes in the cloud-based service that are associated with mailbox users in on-premises Exchange organizations. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Server -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. - -You can use any value that uniquely identifies the server. For example: - -- Name (for example, Exchange01) - -- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com) - -- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01) - -- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942) - -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 \<Identity\> | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN. - -```yaml -Type: ServerIdParameter -Parameter Sets: ServerSet -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 -``` - -### -SoftDeletedMailbox -This parameter is available only in the cloud-based service. - -The SoftDeletedMailbox switch specifies whether to include only soft-deleted mailboxes in the results. You don't need to specify a value with this switch. - -This switch is required to return soft-deleted mailboxes. - -Soft-deleted mailboxes are deleted mailboxes that are still recoverable. - -```yaml -Type: SwitchParameter -Parameter Sets: AnrSet, Identity, MailboxPlanSet, AsyncParameterSet -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -- Office - -- ServerLegacyDN - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8a5a6eb9-4a75-47f9-ae3b-a3ba251cf9a8.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md deleted file mode 100644 index fe1842069e..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxAutoReplyConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve Automatic Replies settings for a specific mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxAutoReplyConfiguration [-Identity] <MailboxIdParameter> [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve all the mailboxes enabled for Automatic Replies. When run, the cmdlet returns Automatic Replies settings for the specified mailbox that include the following: - -- 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 - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Mailbox | Get-MailboxAutoReplyConfiguration -``` - -This example returns Automatic Replies settings for all mailboxes in the Exchange organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxAutoReplyConfiguration -Identity 'contoso.com/Users/Tony Smith' -``` - -This example retrieves Automatic Replies settings for Tony's mailbox at contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Get-Mailbox | Get-MailboxAutoReplyConfiguration -ResultSize unlimited -``` - -This example retrieves all Automatic Replies settings for all mailboxes in the Exchange organization. - -## PARAMETERS - -### -Identity -The Identity parameter specifies a unique identifier associated with a mailbox. Accepted values for the mailbox are as follows: - -- GUID - -- ADObjectID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest and if you don't use this parameter, it's possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information. - -By default, the recipient scope is set to the domain that hosts your servers that run Microsoft Exchange. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0963eab0-8bc8-4f06-b6f7-7dd88b1559f5.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxCalendarFolder.md deleted file mode 100644 index d7fb66055b..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxCalendarFolder.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxCalendarFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxCalendarFolder cmdlet to retrieve the publishing or sharing settings for a specified mailbox calendar folder. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxCalendarFolder [-Identity] <MailboxFolderIdParameter> [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxCalendarFolder -Identity kai:\Calendar -``` - -This example returns all provided publishing information for the specified calendar folder in Kai's mailbox. In this example, the Identity parameter specifies the mailbox with the alias format. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxCalendarFolder -Identity kai:\Calendar -DomainController DC1 -``` - -This example returns all provided publishing information for the specified calendar folder in Kai's mailbox. This example also specifies DC1 as the domain controller to retrieve this information from Active Directory. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxCalendarFolder -Identity contoso\kai:\Calendar -``` - -This example returns all provided publishing information for the specified calendar folder in Kai's mailbox. In this example, the Identity parameter specifies the mailbox with the domain\\account format. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox and folder path or folder name to the calendar folder that has the publishing settings configured. You can use the following values: - -- GUID - -- ADObjectID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dba2cebb-3c37-40ce-8ac0-93ec8d79ce0d.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolder.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolder.md deleted file mode 100644 index ead9f7c8b3..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolder.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxFolder cmdlet to view folders in your own mailbox. Administrators can't use this cmdlet to view folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### GetChildren -``` -Get-MailboxFolder [[-Identity] <MailboxFolderIdParameter>] [-GetChildren] - [-DomainController <Fqdn>] - [-MailFolderOnly] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -### Recurse -``` -Get-MailboxFolder [[-Identity] <MailboxFolderIdParameter>] [-Recurse] - [-DomainController <Fqdn>] - [-MailFolderOnly] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxFolder -Identity Tony:\Inbox -``` - -This example retrieves the Inbox folder in Tony's mailbox. The Identity parameter is supplied in the format of \<Mailbox Identity\>:\<Folder\>. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxFolder -Identity Tony -``` - -This example returns the root folders in Tony's mailbox. The Identity parameter is supplied in the format of \<Mailbox Identity\>. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxFolder -Identity Tony -GetChildren -MailFolderOnly -``` - -This example returns the first level of mail folders in Tony's mailbox. - -### -------------------------- Example 4 -------------------------- -``` -Get-MailboxFolder -Identity Tony:\Inbox -GetChildren -``` - -This example returns information about all the subfolders under Inbox in Tony's mailbox. - -### -------------------------- Example 5 -------------------------- -``` -Get-MailboxFolder -Identity Tony:\Inbox -Recurse -``` - -This example returns all levels of folders under Inbox in Tony's mailbox. - -## PARAMETERS - -### -GetChildren -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recurse -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox and the folder that you want to view. If you don't specify the folder, the command returns information about folders in the root hierarchy of the specified mailbox. You specify values for this parameter by using the syntax: \<Mailbox Identity\>:\<Parent\>. - -Valid values for \<Mailbox Identity\> are unique identifiers for the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Values for \<Parent\> can be both the store object ID and a path string such as \\Inbox\\Personal. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MailFolderOnly -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d519b3de-2118-4007-a556-51c01d1ba931.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderPermission.md deleted file mode 100644 index 9c526a44ab..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderPermission.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolderPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxFolderPermission [-Identity] <MailboxFolderIdParameter> [-DomainController <Fqdn>] - [-User <MailboxFolderUserIdParameter>] [-GroupMailbox] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -``` - -This example returns the current list of user permissions for the Reports subfolder in the Marketing folder in John's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -User Ayla@contoso.com -``` - -This example returns the permissions for the same folder in John's mailbox, but only for the user Ayla. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: \<Mailbox\>:\\\<Folder\>. For the value of \<Mailbox\>, you can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Example values for this parameter are john@contoso.com:\\Calendar or John:\\Marketing\\Reports. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailboxFolderUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMailbox -The GroupMailbox switch specifies that you want to use this cmdlet on an Office 365 Group. You don't need to specify a value with this switch. - -This switch is required when you use this cmdlet on an Office 365 Group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/048000f2-70ce-4630-985f-b3902903ae67.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderStatistics.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderStatistics.md deleted file mode 100644 index 63698345a6..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderStatistics.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolderStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-MailboxFolderStatistics [-Identity] <GeneralMailboxOrMailUserIdParameter> [-Archive] [-DiagnosticInfo <String>] - [-DomainController <Fqdn>] [-FolderScope <Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType>] - [-IncludeAnalysis] [-IncludeOldestAndNewestItems] [-IncludeSoftDeletedRecipients] [<CommonParameters>] -``` - -### AuditLog -``` -Get-MailboxFolderStatistics [-AuditLog] [-DomainController <Fqdn>] - [-FolderScope <Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType>] - [[-Identity] <GeneralMailboxOrMailUserIdParameter>] [-IncludeAnalysis] - [-IncludeOldestAndNewestItems] [-DiagnosticInfo <String>] [-IncludeSoftDeletedRecipients] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -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. - -The Get-MailboxFolderStatistics cmdlet shouldn't be confused with the Get-MailboxStatistics cmdlet. For more information, see Get-MailboxStatistics. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxFolderStatistics -Identity contoso\chris -``` - -This example doesn't specify the FolderScope parameter and retrieves all the information about the user Chris in the Contoso domain. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxFolderStatistics -Identity Chris -FolderScope Calendar -``` - -This example uses the FolderScope parameter to view the statistics for calendar folders for the user Chris. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxFolderStatistics -Identity Ayla@contoso.com -Archive -``` - -This example uses the Archiveswitch to view the statistics for Ayla's archive. - -### -------------------------- Example 4 -------------------------- -``` -Get-MailboxFolderStatistics -Identity "Tony" -FolderScope RecoverableItems -IncludeAnalysis -``` - -This example uses the IncludeAnalysisswitch to view the statistics of Tony's Recoverable Items folder. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - - -```yaml -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 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: AuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Archive -The Archiveswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditLog -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: AuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticInfo -This parameter is available only in the cloud-based service. - -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -FolderScope -The FolderScope parameter specifies the scope of the search by folder type. Valid parameter values include: - -- All - -- Archive - -- Calendar - -- Contacts - -- ConversationHistory - -- DeletedItems - -- Drafts - -- Inbox - -- JunkEmail - -- Journal - -- LegacyArchiveJournals - -- ManagedCustomFolder - -- NonIpmRoot - -- Notes - -- Outbox - -- Personal - -- RecoverableItems - -- RssSubscriptions - -- SentItems - -- SyncIssues - -- Tasks - -The ManagedCustomFolder value returns output for all managed custom folders. The RecoverableItems value returns output for the Recoverable Items folder and the Deletions, DiscoveryHolds, Purges, and Versions subfolders. - -```yaml -Type: Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType -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 -``` - -### -IncludeAnalysis -The IncludeAnalysisswitch 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeOldestAndNewestItems -The IncludeOldestAndNewestItemsswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSoftDeletedRecipients -This parameter is available only in the cloud-based service. - -{{Fill IncludeSoftDeletedRecipients Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/212ca564-435e-4af6-8673-5564732bf118.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxLocation.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxLocation.md deleted file mode 100644 index e922244247..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxLocation.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-MailboxLocation -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MailboxLocation - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailboxLocation cmdlet to view mailbox location information in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### DatabaseSet -``` -Get-MailboxLocation -Database <DatabaseIdParameter> [-Confirm] - [-MailboxLocationType <Primary | MainArchive | AuxArchive | Aggregated | AuxPrimary | ComponentShared>] - [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Get-MailboxLocation -Identity <MailboxLocationIdParameter> [-Confirm] - [-MailboxLocationType <Primary | MainArchive | AuxArchive | Aggregated | AuxPrimary | ComponentShared>] - [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -### User -``` -Get-MailboxLocation -User <UserIdParameter> [-Confirm] - [-MailboxLocationType <Primary | MainArchive | AuxArchive | Aggregated | AuxPrimary | ComponentShared>] - [-ResultSize <Unlimited>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxLocation -User chris@contoso.com -``` - -This example returns the mailbox location for the user chris@contoso.com. - -## PARAMETERS - -### -Database -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: DatabaseSet -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox location object that you want to view. The value uses the syntax \<GUID1\>\\\<GUID2\>. Typically, you can only find this value after you run Get-MailboxLocation with the User parameter. - -You can't use this parameter with the User parameter. - -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -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: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -You can't use this parameter with the Identity parameter. - -```yaml -Type: UserIdParameter -Parameter Sets: User -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxLocationType -The MailboxLocationType filters the results by the type of mailbox. Valid values are: - -- Aggregated - -- AuxArchive - -- AuxPrimary - -- ComponentShared - -- MainArchive - -- Primary - -- RemotePrimary - -```yaml -Type: Primary | MainArchive | AuxArchive | Aggregated | AuxPrimary | ComponentShared -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/get-mailboxlocation) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxPermission.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxPermission.md deleted file mode 100644 index 0deba567fb..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxPermission.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxPermission cmdlet to retrieve permissions on a mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Owner -``` -Get-MailboxPermission [-Identity] <MailboxIdParameter> [-Owner] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -### AccessRights -``` -Get-MailboxPermission [-Identity] <MailboxIdParameter> [-User <SecurityPrincipalIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## DESCRIPTION -The output of this cmdlet shows the following information: - -- Identity: The mailbox in question. - -- User: The security principal (user, security group, Exchange management role group, etc.) that has permission to the mailbox. - -- AccessRights: The permission that the security principal has on the mailbox. The available values are ChangeOwner (change the owner of the mailbox), ChangePermission (change the permissions on the mailbox), DeleteItem (delete the mailbox), ExternalAccount (indicates the account isn't in the same domain), FullAccess (open the mailbox, access its contents, but can't send mail) and ReadPermission (read the permissions on the mailbox). Whether the permissions are allowed or denied is indicated in the Deny column. - -- IsInherited: Whether the permission is inherited (True) or directly assigned to the mailbox (False). Permissions are inherited from the mailbox database and/or Active Directory. Typically, directly assigned permissions override inherited permissions. - -- Deny: Whether the permission is allowed (False) or denied (True). Typically, deny permissions override allow permissions. - -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. - -- 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 Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxPermission -Identity john@contoso.com | Format-List -``` - -This example returns permissions on the mailbox by its SMTP address john@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxPermission -Identity john@contoso.com -User "Ayla" -``` - -This example returns permissions that the user Ayla has on John's mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxPermission -Identity Room222 -Owner -``` - -This example returns the owner information for the resource mailbox Room222. - -## PARAMETERS - -### -Identity -The Identity parameter identifies the mailbox. You can use one of the following values: - -- GUID - -- ADObjectID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name and password to use to access Active Directory. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -The Owner parameter returns the owner information for the mailbox identified in the Identity parameter. - -This parameter can't be used with the User parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. - -If you set the recipient scope to include all recipients in the forest, and if you don't use this parameter, it's possible that the user information is read from a global catalog with outdated information. - -If you use this parameter, multiple reads might be necessary to get the information. - -By default, the recipient scope is set to the domain that hosts your servers that run Exchange. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of recipient objects returned. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the UPN, domain\\user, or the alias of the user. - -This parameter can't be used with the Owner parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/56bcc678-1598-4c9b-8b4f-4fa11c89ec41.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxPlan.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxPlan.md deleted file mode 100644 index dbf2cab266..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxPlan.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Get-MailboxPlan -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MailboxPlan - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailboxPlan cmdlet to view information about mailbox plans in the cloud-based service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxPlan [[-Identity] <MailboxPlanIdParameter>] [-AllMailboxPlanReleases] [-Credential <PSCredential>] - [-Filter <String>] [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ResultSize <Unlimited>] [-SortBy <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -A mailbox plan is a template that automatically configures properties on new mailboxes. Mailbox plans correspond to Microsoft Office 365 license types. The availability of a mailbox plan is determined by the selections you make when you enroll your domain in Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxPlan -``` - -This example returns a summary list of all mailbox plans in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxPlan -Identity ExchangeOnlineEnterprise | Format-List -``` - -This example returns detailed information for the mailbox plan that has the display name ExchangeOnlineEnterprise. - -## PARAMETERS - -### -AllMailboxPlanReleases -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 displays 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 cloud-based service. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox plan that you want to view. You can use any value that uniquely identifies the mailbox plan. For example: - -- Name - -- Alias - -- Display name - -- Distinguished name (DN) - -- GUID - -- LegacyExchangeDN - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following attributes: - -- Alias - -- DisplayName - -- Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/aeb5189b-e4ca-4e85-a8d4-5c08924a4a68.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md deleted file mode 100644 index 706efaa8e6..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010 -title: Get-MailboxSentItemsConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-MailboxSentItemsConfiguration - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-MailboxSentItemsConfiguration cmdlet to view the Sent Items settings on mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxSentItemsConfiguration [-DomainController <Fqdn>] [-Identity <MailboxIdParameter>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxSentItemsConfiguration -Identity "Customer Support Feedback" -``` - -This example returns the Sent Items configuration for the shared mailbox named "Customer Support Feedback". - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/40da2911-2503-4655-a92b-78deec069cb0.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxStatistics.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxStatistics.md deleted file mode 100644 index e12620b682..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxStatistics.md +++ /dev/null @@ -1,432 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxStatistics cmdlet to obtain 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Database -``` -Get-MailboxStatistics -Database <DatabaseIdParameter> [[-StoreMailboxIdentity] <StoreMailboxIdParameter>] - [-CopyOnServer <ServerIdParameter>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IncludeMoveHistory] - [-IncludeMoveReport] - [-IncludeQuarantineDetails] - [-NoADLookup] [<CommonParameters>] -``` - -### Identity -``` -Get-MailboxStatistics [-Identity] <GeneralMailboxOrMailUserIdParameter> [-Archive] - [-CopyOnServer <ServerIdParameter>] - [-DomainController <Fqdn>] - [-IncludeMoveHistory] - [-IncludeMoveReport] - [-IncludeQuarantineDetails] - [-IncludeSoftDeletedRecipients] - [-NoADLookup] - [<CommonParameters>] -``` - -### Server -``` -Get-MailboxStatistics -Server <ServerIdParameter> - [-DomainController <Fqdn>] - [-Filter <String>] - [-IncludeMoveHistory] - [-IncludeMoveReport] - [-IncludePassive] - [-IncludeQuarantineDetails] - [-NoADLookup] [<CommonParameters>] -``` - -## DESCRIPTION -On Mailbox servers only, you can use the Get-MailboxStatistics cmdlet without parameters. In this case, the cmdlet returns the statistics for all mailboxes on all databases on the local server. - -The Get-MailboxStatistics cmdlet requires at least one of the following parameters to complete successfully: Server, Database or Identity. - -You can use the Get-MailboxStatistics cmdlet to return detailed move history and a move report for completed move requests to troubleshoot a move request. To view the move history, you must pass this cmdlet as an object. Move histories are retained in the mailbox database and are numbered incrementally and the last executed move request is always numbered 0. For more information, see "Example 7," "Example 8," and "Example 9" in this topic. - -You can only see move reports and move history for completed move requests. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxStatistics -Identity AylaKol -``` - -This example retrieves the mailbox statistics for the mailbox of the user Ayla Kol by using its associated alias AylaKol. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxStatistics -Server MailboxServer01 -``` - -This example retrieves the mailbox statistics for all mailboxes on the server MailboxServer01. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailboxStatistics -Identity contoso\chris -``` - -This example retrieves the mailbox statistics for the specified mailbox. - -### -------------------------- Example 4 -------------------------- -``` -Get-MailboxStatistics -Database "Mailbox Database" -``` - -This example retrieves the mailbox statistics for all mailboxes in the specified mailbox database. - -### -------------------------- Example 5 -------------------------- -``` -Get-MailboxDatabase | Get-MailboxStatistics -Filter 'DisconnectDate -ne $null' -``` - -This example retrieves the mailbox statistics for the disconnected mailboxes for all mailbox databases in the organization. The -ne operator means not equal. - -### -------------------------- Example 6 -------------------------- -``` -Get-MailboxStatistics -Database "Mailbox Database" -StoreMailboxIdentity 3b475034-303d-49b2-9403-ae022b43742d -``` - -This example retrieves the mailbox statistics for a single disconnected mailbox. The value for the StoreMailboxIdentity parameter is the mailbox GUID of the disconnected mailbox. You can also use the LegacyDN. - -### -------------------------- Example 7 -------------------------- -``` -Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory | Format-List -``` - -This example returns the summary move history for the completed move request for Ayla Kol's mailbox. If you don't pipeline the output to the Format-List cmdlet, the move history doesn't display. - -### -------------------------- Example 8 -------------------------- -``` -$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]. - -### -------------------------- Example 9 -------------------------- -``` -$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveReport; $temp.MoveHistory[0] | Export-CSV C:\MoveReport_AylaKol.csv -``` - -This example returns the detailed move history and a verbose detailed move report for Ayla Kol's mailbox. This example uses a temporary variable to store the move request statistics object and outputs the move report to a CSV file. - -## PARAMETERS - -### -Database -This parameter is available only in on-premises Exchange. - -The Database parameter specifies the name of the mailbox database. When you specify a value for the Database parameter, the Exchange Management Shell returns statistics for all the mailboxes on the database specified. - -You can use the following values: - -- GUID - -- Database - -This parameter accepts pipeline input from the Get-MailboxDatabase cmdlet. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox that you want to return statistics for. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -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: - -- Fully qualified domain name (FQDN) - -- NetBIOS name - -When you specify a value for the Server parameter, the command returns statistics for all the mailboxes on all the databases, including recovery databases, on the specified server. If you don't specify this parameter, the command returns logon statistics for the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Archive -The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. - -You don't have to specify a value with this parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyOnServer -This parameter is available only in on-premises Exchange. - -The CopyOnServer parameter is used to retrieve statistics from a specific database copy on the server specified with the Server parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Database, Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -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 -``` - -### -Filter -This parameter is available only in on-premises Exchange. - -The Filter parameter specifies a filter to filter the results of the Get-MailboxStatistics cmdlet. For example, to display all disconnected mailboxes on a specific mailbox database, use the following syntax for this parameter: -Filter 'DisconnectDate -ne $null' - -```yaml -Type: String -Parameter Sets: Database, Server -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 -``` - -### -IncludeMoveHistory -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeMoveReport -The IncludeMoveReport switch specifies whether to return a verbose detailed move report for a completed move request, such as server connections and move stages. - -Because the output of this command is verbose, you should send the output to a .CSV file for easier analysis. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePassive -This parameter is available only in on-premises Exchange. - -Without the IncludePassive parameter, the cmdlet retrieves statistics from active database copies only. Using the IncludePassive parameter, you can have the cmdlet return statistics from all active and passive database copies. - -```yaml -Type: SwitchParameter -Parameter Sets: Server -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 -``` - -### -IncludeSoftDeletedRecipients -This parameter is available only in the cloud-based service. - -{{Fill IncludeSoftDeletedRecipients Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQuarantineDetails -This parameter is available only in on-premises Exchange. - -The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. - -Specifically, this switch returns the values of the QuarantineDescription, QuarantineLastCrash and QuarantineEnd properties on the mailbox. To see these values, you need use a formatting cmdlet. For example, Get-MailboxStatistics \<MailboxIdentity\> -IncludeQuarantineDetails | Format-List Quarantine\*. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoADLookup -This parameter is available only in on-premises Exchange. - -The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. This helps improve cmdlet performance when querying a mailbox database that contains a large number of mailboxes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoreMailboxIdentity -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: - -- MailboxGuid - -- LegacyDN - -Use this syntax to retrieve information about disconnected mailboxes, which don't have a corresponding Active Directory object or that has a corresponding Active Directory object that doesn't point to the disconnected mailbox in the mailbox database. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cec76f70-941f-4bc9-b949-35dcc7671146.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/mailboxes/Get-MailboxUserConfiguration.md deleted file mode 100644 index 03175f68b1..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MailboxUserConfiguration.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxUserConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxUserConfiguration cmdlet to view user configuration items in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxUserConfiguration [-Identity] <MailboxUserConfigurationIdParameter> -Mailbox <MailboxIdParameter> - [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxUserConfiguration -Mailbox laura@contoso.com -Identity Configuration\* | Format-Table -Auto Identity -``` - -This example returns a summary list of all user configuration items in the Configuration folder in the mailbox laura@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxUserConfiguration -Mailbox julia@contoso.com -Identity Configuration\IPM.Configuration.Aggregated.OwaUserConfiguration -``` - -This example returns detailed information for the specified user configuration item in the mailbox julia@contoso.com. - -## PARAMETERS - -### -Identity -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. - -- Valid values for \<ItemName\> start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. - -```yaml -Type: MailboxUserConfigurationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d54dcb7d-e989-463f-aaf0-950ba3ed0c65.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-MessageCategory.md b/exchange/exchange-ps/exchange/mailboxes/Get-MessageCategory.md deleted file mode 100644 index 2532d9e3cc..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-MessageCategory.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageCategory -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MessageCategory cmdlet to retrieve a message category from the specified mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MessageCategory [[-Identity] <MessageCategoryIdParameter>] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MessageCategory -Mailbox "User1" -``` - -This example retrieves message categories from the mailbox User1. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of a mailbox user to retrieve the message category from. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/62d403c8-d1cf-4507-a0d7-342bdfb17a9a.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-RecipientPermission.md b/exchange/exchange-ps/exchange/mailboxes/Get-RecipientPermission.md deleted file mode 100644 index 77941c90f3..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-RecipientPermission.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Get-RecipientPermission -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-RecipientPermission - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-RecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RecipientPermission [[-Identity] <RecipientIdParameter>] [-AccessRights <MultiValuedProperty>] - [-ReadFromDomainController] [-ResultSize <Unlimited>] [-Trustee <SecurityPrincipalIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RecipientPermission -Trustee "Kim Akers" -``` - -This example lists the recipients for whom the user Kim Akers has SendAs permission. Kim can send messages that appear to come directly from the recipients. - -### -------------------------- Example 2 -------------------------- -``` -Get-RecipientPermission "Help Desk" -``` - -This example lists the users who have SendAs permission on the mailbox Help Desk. The users listed can send messages that appear to come directly from the Help Desk mailbox. - -## PARAMETERS - -### -AccessRights -The AccessRights parameter filters the results by permission. - -Valid input for this parameter is SendAs. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter filters the results by the target recipient. The user or group specified by the Trustee parameter can operate on this recipient. - -You can specify any type of recipient, for example: - -- Mailboxes - -- Mail users - -- External contacts - -- Distribution groups - -- Dynamic distribution groups - -You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Trustee -The Trustee parameter filters the results by the user or group to whom you're granting the permission. The user or group can operate on the recipient specified by the Identity parameter. - -You can specify the following types of users or groups: - -- Mailbox users - -- Mail users with a Microsoft account (formerly known as a Windows Live ID) - -- Security groups - -You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a80d1ec7-2504-44f1-b6b4-2e65310b4c6e.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md deleted file mode 100644 index 4b20e97975..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Online -title: Get-RecoverableItems -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- -# 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. - -Use the Get-RecoverableItems items cmdlet to view deleted items in the Recoverable Items folder in mailboxes. After you find the deleted items, you use the Restore-RecoverableItems cmdlet to restore them. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RecoverableItems -Identity <GeneralMailboxOrMailUserIdParameter> -[-EntryID <String>] -[-FilterEndTime <DateTime>] -[-FilterItemType <String>] -[-FilterStartTime <DateTime>] -[-LastParentFolderID <String>] -[-ResultSize <Unlimited>] -[-SourceFolder <DeletedItems | RecoverableItems>] -[-SubjectContains <String>] -[<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RecoverableItems -Identity laura@contoso.com -Subject -SubjectContains "FY17 Accounting" -FilterItemType IPM.Note -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM" -``` - -This example returns all of the available recoverable deleted messages with the specified subject in the mailbox laura@contoso.com for the specified date/time range. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that contains the Recoverable Items folder that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name>\<account name> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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-ReoverableItems cmdlet (subject, date range, etc.). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterEndTime -The FilterEndTime specifies the end date/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". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterItemType -The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: - -- IPM.Appointment (Meetings and appointments) - -- IPM.Contact - -- IPM.File - -- IPM.Note - -- IPM.Task - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterStartTime -The FilterStartTime specifies the start date/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". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastParentFolderID -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 Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFolder -The SourceFolder parameter specifies the folder in the mailbox to search for deleted items. Valid values are: - -- DeletedItems: The Deleted Items folder. - -- RecoverableItems: Recoverable items that have been deleted from the Deleted Items folder. - -If you don't use this parameter, the command will search both locations. - -```yaml -Type: DeletedItems | RecoverableItems -Parameter Sets: (All) -Aliases: -Accepted values: DeletedItems, RecoverableItems -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectContains -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/Get-RecoverableItems) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-ResourceConfig.md b/exchange/exchange-ps/exchange/mailboxes/Get-ResourceConfig.md deleted file mode 100644 index 52a8407b18..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-ResourceConfig.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ResourceConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ResourceConfig cmdlet to view custom room and equipment mailbox properties that you've configured by using the Set-ResourceConfig cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ResourceConfig [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ResourceConfig -``` - -This example returns all of the available custom room and equipment mailbox properties. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9af19559-7b44-47b9-af1c-f293e93d245d.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-SweepRule.md b/exchange/exchange-ps/exchange/mailboxes/Get-SweepRule.md deleted file mode 100644 index 1ee7dcc78b..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-SweepRule.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SweepRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run a regular intervals to help keep your Inbox clean. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SweepRule [[-Identity] <SweepRuleIdParameter>] [-BypassScopeCheck] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-Provider <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SweepRule -``` - -This example returns a summary list of all Sweep rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-SweepRule -Mailbox julia@contoso.com -``` - -This example returns a summary list of all Sweep rules in the specified mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Get-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" -``` - -This example returns detailed information for the Sweep rule with the specified RuleId property value. - -## PARAMETERS - -### -BypassScopeCheck -The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). - -- Exchange Online: \<mailbox alias\>\\\<RuleId\> (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. - -- On-premises Exchange: \<mailbox canonical name\>\\\<RuleId\> (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. - -```yaml -Type: SweepRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter filters the results by the specified mailbox. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3893ff38-931d-49f8-b34d-d7666b629d54.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-UserPhoto.md b/exchange/exchange-ps/exchange/mailboxes/Get-UserPhoto.md deleted file mode 100644 index ae68e65ca9..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Get-UserPhoto.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UserPhoto -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UserPhoto - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business and SharePoint. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-UserPhoto [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PhotoType <String>] - [-Preview] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-UserPhoto [[-Identity] <MailboxIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PhotoType <String>] - [-Preview] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UserPhoto "Susan Burk" -``` - -This example displays information about the user photo configured for Susan Burk. - -### -------------------------- Example 2 -------------------------- -``` -Get-UserPhoto "Pilar Pinilla" -Preview -``` - -This example displays information about the user photo that was uploaded to Pilar Pinilla's account, but wasn't saved. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMailbox -The GroupMailbox switch indicates the specified user is an Office 365 Group. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhotoType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preview -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the Id property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a9b22e66-a511-4a47-ba50-a0fc9c204fcc.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Import-ContactList.md b/exchange/exchange-ps/exchange/mailboxes/Import-ContactList.md deleted file mode 100644 index e2bf940192..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Import-ContactList.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Online -title: Import-ContactList -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Import-ContactList - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Import-ContactList cmdlet and a .csv file to import a user's mail contacts to a cloud-based mailbox. Users can use an email client to export their contacts to a .csv file that is formatted for Microsoft Office Outlook. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Data -``` -Import-ContactList [-Identity] <MailboxIdParameter> [-CSV] -CSVData <Byte[]> - [-DateCultureName] <String> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Stream -``` -Import-ContactList [-Identity] <MailboxIdParameter> [-CSV] -CSVStream <Stream> - [-DateCultureName] <String> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-ContactList cmdlet submits a request to import a list of mail contacts that are contained in a .csv file to a cloud-based mailbox. Many MAPI and Web-based email clients allow users to export contacts to a Microsoft Office Outlook .csv format. Users can then provide that .csv file to you to import contacts to their cloud-based mailbox. During the import process, Microsoft Exchange matches the column names in the header row of the .csv file to the property names of an Exchange contact. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-ContactList -CSV -CSVData ([System.IO.File]::ReadAllBytes("D:\Users\Administrator\Desktop\TerryAdams.csv")) -DateCultureName "en-GB" -Identity terrya@contoso.edu -``` - -This example imports a list of contacts in a .csv file named TerryAdams.csv to a mailbox for a user whose email address is terrya@contoso.edu. The date fields are parsed using the date format of "en-GB" locale (dd/MM/YYYY). - -## PARAMETERS - -### -CSV -The CSV parameter simply specifies that the contacts will be imported from a .csv file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVData -The CSVData parameter specifies the .csv file you want to import. Use the following syntax for this parameter: ([System.IO.File]::ReadAllBytes("\<file name and path\>")). For example, ([System.IO.File]::ReadAllBytes("C:\\My Documents\\Contacts.csv")). - -```yaml -Type: Byte[] -Parameter Sets: Data -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVStream -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Stream -Parameter Sets: Stream -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateCultureName -The DateCultureName parameter specifies the culture to use for parsing date fields (e.g. Birthday and Anniversary). For example, setting the parameter to "en-GB" would lead to 01/02/2018 being parsed as February 1st, 2018, whereas setting it to "en-US" would lead to the same date being parsed as January 2nd, 2018. If the parameter is not provided, the culture of the current user is assumed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the target mailbox to which the contacts are imported. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2a354fe4-34ed-4f8a-bc21-e092b27e133d.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/mailboxes/Import-RecipientDataProperty.md deleted file mode 100644 index 09c7bcda32..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Import-RecipientDataProperty.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-RecipientDataProperty -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Import-RecipientDataProperty - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Import-RecipientDataProperty cmdlet to add a picture or an audio file of a spoken name to a mailbox or contact. The picture and audio files display on the Global Address List property dialog box, contact card, reading pane, and meeting requests in Microsoft Outlook and Outlook on the web. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ImportPicture -``` -Import-RecipientDataProperty [-Identity] <MailboxUserContactIdParameter> -FileData <Byte[]> [-Picture] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### ImportSpokenName -``` -Import-RecipientDataProperty [-Identity] <MailboxUserContactIdParameter> -FileData <Byte[]> [-SpokenName] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Importing and exporting files require a specific syntax because importing and exporting use Remote PowerShell. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-RecipientDataProperty -Identity "Tony Smith" -SpokenName -FileData ([Byte[]]$(Get-Content -Path "M:\AudioFiles\TonySmith.wma" -Encoding Byte -ReadCount 0)) -``` - -This example imports the audio file for Tony Smith's spoken name. - -### -------------------------- Example 2 -------------------------- -``` -Import-RecipientDataProperty -Identity Ayla -Picture -FileData ([Byte[]]$(Get-Content -Path "M:\Employee Photos\AylaKol.jpg" -Encoding Byte -ReadCount 0)) -``` - -This example imports the picture file for Ayla Kol. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the location and file name of the picture or audio file. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -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 -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, Exchange Online -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Picture -The Picture switch specifies that the file you're importing is a picture file. You don't need to specify a value with this switch. - -The picture must be a JPEG file and shouldn't be larger than 10 kilobytes (KB). You can't use this switch with the SpokenName switch. You can only import one file type at a time. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpokenName -The SpokenName switch specifies that the file you're importing is an audio file. You don't need to specify a value with this switch. - -The maximum file size should be less than 32 KB. You can use one of the following formats: - -- WMA 9-voice - -- PCM 8-KHz, 16-bits, mono format - -You can't use this switch with the Picture switch. You can only import one file type at a time. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f3baf354-3d7d-4909-b4fa-754d1e44bf1f.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-App.md b/exchange/exchange-ps/exchange/mailboxes/New-App.md deleted file mode 100644 index 0d0bae9cba..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-App.md +++ /dev/null @@ -1,528 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-App -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-App cmdlet to install apps for Outlook. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ExtensionOfficeMarketplace -``` -New-App [-Etoken <String>] [-Mailbox <MailboxIdParameter>] [-MarketplaceCorrelationID <String>] [-MarketplaceAssetID <String>] [-MarketplaceQueryMarket <String>] [-MarketplaceServicesUrl <String>] [-MarketplaceUserProfileType <String>] - [-AllowReadWriteMailbox] - [-Confirm] - [-DefaultStateForUser <Enabled | Disabled | AlwaysEnabled>] - [-DomainController <Fqdn>] - [-DownloadOnly] - [-Enabled <$true | $false>] - [-OrganizationApp] - [-PrivateCatalog] - [-ProvidedTo <Everyone | SpecificUsers>] - [-UserList <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### ExtensionFileData -``` -New-App [-FileData <Byte[]>] - [-AllowReadWriteMailbox] - [-Confirm] - [-DefaultStateForUser <Enabled | Disabled | AlwaysEnabled>] - [-DomainController <Fqdn>] - [-DownloadOnly] - [-Enabled <$true | $false>] - [-Mailbox <MailboxIdParameter>] - [-OrganizationApp] - [-PrivateCatalog] - [-ProvidedTo <Everyone | SpecificUsers>] - [-UserList <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### ExtensionFileStream -``` -New-App [-FileStream <Stream>] - [-AllowReadWriteMailbox] - [-Confirm] - [-DefaultStateForUser <Enabled | Disabled | AlwaysEnabled>] - [-DomainController <Fqdn>] - [-DownloadOnly] - [-Enabled <$true | $false>] - [-Mailbox <MailboxIdParameter>] - [-OrganizationApp] - [-PrivateCatalog] - [-ProvidedTo <Everyone | SpecificUsers>] - [-UserList <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### ExtensionPrivateURL -``` -New-App [-Url <Uri>] - [-AllowReadWriteMailbox] - [-Confirm] - [-DefaultStateForUser <Enabled | Disabled | AlwaysEnabled>] - [-DomainController <Fqdn>] - [-DownloadOnly] - [-Enabled <$true | $false>] - [-Mailbox <MailboxIdParameter>] - [-OrganizationApp] - [-PrivateCatalog] - [-ProvidedTo <Everyone | SpecificUsers>] - [-UserList <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -If the app is enabled for the entire organization, users can activate the new app when viewing mail or calendar items within Microsoft Outlook or Outlook on the web. If an installed app isn't enabled, users can enable the app from Outlook on the web Options. Similarly, administrators can enable installed apps from the Exchange admin center or by using the Enable-App or Set-App cmdlet. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-App -FileData ([Byte[]](Get-Content -Encoding Byte -Path "C:\Apps\FinanceTestApp.xml" -ReadCount 0)) -``` - -This example installs the Finance Test app manifest file that has been copied to the local hard disk. - -For more information, see Install or remove add-ins for Outlook for your organization (https://technet.microsoft.com/library/jj943752.aspx). - -### -------------------------- Example 2 -------------------------- -``` -New-App -OrganizationApp -Url https://Server01.Contoso.com/apps/ContosoCRMApp/manifest.xml -ProvidedTo SpecificUsers -UserList "user1,user2,user3,user4,user5" -DefaultStateForUser Enabled -``` - -This example installs the Contoso CRM app manifest.xml from a URL on the Contoso corporate network. The Exchange server must be able to reach the target URL. This app is installed as an organization app,is made available to a specific list of users, and is enabled for those users by default. - -For more information, see Install or remove add-ins for Outlook for your organization (https://technet.microsoft.com/library/jj943752.aspx). - -## PARAMETERS - -### -AllowReadWriteMailbox -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStateForUser -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. - -- AlwaysEnabled: The organization app is enabled and users can't disable it. - -You need to use the OrganizationApp switch when you use this parameter. - -```yaml -Type: Enabled | Disabled | AlwaysEnabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DownloadOnly -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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. - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etoken -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: ExtensionFileData -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileStream -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarketplaceAssetID -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarketplaceCorrelationID -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarketplaceQueryMarket -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 isen-US. - -```yaml -Type: String -Parameter Sets: ExtensionOfficeMarketplace -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarketplaceServicesUrl -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarketplaceUserProfileType -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationApp -The OrganizationAppswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateCatalog -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvidedTo -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. - -You use this parameter with the OrganizationApp switch. - -```yaml -Type: Everyone | SpecificUsers -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. - -```yaml -Type: Uri -Parameter Sets: ExtensionPrivateURL -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserList -The UserList parameter specifies who can usean organizational app. Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You use this parameter with the OrganizationApp switch. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f05951d8-1e49-42b6-a341-66eb67b2870f.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-MailMessage.md b/exchange/exchange-ps/exchange/mailboxes/New-MailMessage.md deleted file mode 100644 index 26a30e0cf5..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-MailMessage.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailMessage -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-MailMessage cmdlet to create an email message for the specified user mailbox and place the email message in the Drafts folder of the user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MailMessage [[-Body] <String>] -Mailbox <MailboxIdParameter> [-BodyFormat <PlainText | Html | Rtf>] - [-Confirm] [-DomainController <Fqdn>] [-Subject <String>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" -Mailbox tony -``` - -In Exchange Server 2010, this example creates an message in the Drafts folder of Tony's mailbox, with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. - -### -------------------------- Example 2 -------------------------- -``` -New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" -``` - -This example creates an email message in the Drafts folder with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. - -### -------------------------- Example 3 -------------------------- -``` -New-MailMessage -Mailbox tony@contoso.com -``` - -In Exchange Server 2010, this example creates an empty message in the Drafts folder of Tony's mailbox because no subject or message body is specified. - -### -------------------------- Example 4 -------------------------- -``` -New-MailMessage -``` - -This example creates an empty email message in the Drafts folder because no subject or message body is specified. - -### -------------------------- Example 5 -------------------------- -``` -New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -Mailbox tony -BodyFormat Html -``` - -In Exchange Server 2010, this example creates an message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. - -### -------------------------- Example 6 -------------------------- -``` -New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -BodyFormat Html -``` - -This example creates an email message in the Drafts folder with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. - -## PARAMETERS - -### -Mailbox -This parameter is available or functional only in Exchange Server 2010. - -The Mailbox parameter specifies a unique identifier for the destination mailbox where the message is being created. You can use any of the following values for this parameter: - -- Alias - -- Display name - -- Domain\\Account - -- SMTP address - -- Distinguished name (DN) - -- Object GUID - -- User principal name (UPN) - -- LegacyExchangeDN - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BodyFormat -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: PlainText | Html | Rtf -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -Subject -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3a3fbff6-a202-4d3e-b1df-dfd16ae95a44.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md deleted file mode 100644 index a6e3030cf1..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md +++ /dev/null @@ -1,2299 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-Mailbox cmdlet to create mailboxes and user accounts at the same time. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### User -``` -New-Mailbox [-Name] <String> -Password <SecureString> -UserPrincipalName <String> [-InactiveMailbox <MailboxIdParameter>] [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### MicrosoftOnlineServicesID -``` -New-Mailbox [-Name] <String> -Password <SecureString> -MicrosoftOnlineServicesID <WindowsLiveId> [-InactiveMailbox <MailboxIdParameter>] [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-Discovery] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Arbitration -``` -New-Mailbox [-Name] [-Arbitration] <String> [-OfficeGraph] [-Password <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-ProvisionedForMicrosoftGraph] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AuditLog -``` -New-Mailbox [-Name] <String> -UserPrincipalName <String> [-AuditLog] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AuxAuditLog -``` -New-Mailbox [-Name] <String> [-AuxAuditLog] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### DisabledUser -``` -New-Mailbox [-Name] <String> [-AccountDisabled] [-Password <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Discovery -``` -New-Mailbox [-Name] <String> [-Discovery] [-Password <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### EnableRoomMailboxAccount -``` -New-Mailbox [-Name] <String> -EnableRoomMailboxAccount <$true | $false> [-MicrosoftOnlineServicesID <WindowsLiveId> [-Room] [-RoomMailboxPassword <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Equipment -``` -New-Mailbox [-Name] <String> [-Equipment] [-Password <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### FederatedUser -``` -New-Mailbox [-Name] <String> -FederatedIdentity <String> [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-Confirm] - [-DisplayName <String>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-Password <SecureString>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-WhatIf] [<CommonParameters>] -``` - -### InactiveMailbox -``` -New-Mailbox [-Name] <String> -InactiveMailbox <MailboxIdParameter> [-Password <SecureString>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Linked -``` -New-Mailbox [-Name] <String> -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-LinkedCredential <PSCredential>] [-Password <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### LinkedRoomMailbox -``` -New-Mailbox [-Name] <String> -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-LinkedCredential <PSCredential>] [-LinkedRoom] [-Office <String>] [-Password <SecureString>] [-Phone <String>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-ResourceCapacity <Int32>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### MicrosoftOnlineServicesFederatedUser -``` -New-Mailbox [-Name] <String> -FederatedIdentity <String> -MicrosoftOnlineServicesID <WindowsLiveId> [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-Confirm] - [-DisplayName <String>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-WhatIf] [<CommonParameters>] -``` - -### Migration -``` -New-Mailbox [-Name] <String> [-Arbitration] [-Migration] [-Password <SecureString>] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### PublicFolder -``` -New-Mailbox [-Name] <String> [-PublicFolder] [-HoldForMigration] [-IsExcludedFromServingHierarchy <$true | $false>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### RemoteArchive -``` -New-Mailbox [-Name] <String> -ArchiveDomain <SmtpDomain> -Password <SecureString> -UserPrincipalName <String> [-RemoteArchive] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-RemovedMailbox <RemovedMailboxIdParameter>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### RemovedMailbox -``` -New-Mailbox [-Name] <String> -RemovedMailbox <RemovedMailboxIdParameter> [-Password <SecureString>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxPlan <MailboxPlanIdParameter>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Room -``` -New-Mailbox [-Name] <String> [-Password <SecureString>] [-ResourceCapacity <Int32>] [-Room] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Office <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-Phone <String>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Scheduling -``` -New-Mailbox [-Name] <String> [-Password <SecureString>] [-UserPrincipalName <String>] [-Scheduling] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Shared -``` -New-Mailbox [-Name] <String> [-Password <SecureString>] [-Shared] [-UserPrincipalName <String>] - [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Archive] - [-ArchiveDatabase <DatabaseIdParameter>] - [-Confirm] - [-Database <DatabaseIdParameter>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-FirstName <String>] - [-Force] - [-ImmutableId <String>] - [-Initials <String>] - [-LastName <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] - [-MailboxRegion <String>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RemotePowerShellEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SkipMailboxProvisioningConstraintValidation] - [-TargetAllMDBs] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$password = Read-Host "Enter password" -AsSecureString; New-Mailbox -UserPrincipalName chris@contoso.com -Alias chris -Database "Mailbox Database 1" -Name ChrisAshton -OrganizationalUnit Users -Password $password -FirstName Chris -LastName Ashton -DisplayName "Chris Ashton" -ResetPasswordOnNextLogon $true -``` - -This example creates a user Chris Ashton in Active Directory and creates a mailbox for the user. The mailbox is located on Mailbox Database 1. The password must be reset at the next logon. To set the initial value of the password, this example creates a variable ($password), prompts you to enter a password, and assigns that password to the variable as a SecureString object. - -### -------------------------- Example 2 -------------------------- -``` -New-Mailbox -UserPrincipalName confmbx@contoso.com -Alias confmbx -Name ConfRoomMailbox -Database "Mailbox Database 1" -OrganizationalUnit Users -Room -ResetPasswordOnNextLogon $true -``` - -This example creates a user in Active Directory and a resource mailbox for a conference room. The resource mailbox is located in Mailbox Database 1. The password must be reset at the next logon. You are prompted for the value of the initial password because it's not specified. - -### -------------------------- Example 3 -------------------------- -``` -New-Mailbox -UserPrincipalName confroom1010@contoso.com -Alias confroom1010 -Name "Conference Room 1010" -Room -EnableRoomMailboxAccount $true -RoomMailboxPassword (ConvertTo-SecureString -String P@ssw0rd -AsPlainText -Force) -``` - -This example creates an enabled user account in Active Directory and a room mailbox for a conference room in an on-premises Exchange organization. The RoomMailboxPassword parameter specifies the password for the user account. - -### -------------------------- Example 4 -------------------------- -``` -New-Mailbox -Shared -Name "Sales Department" -DisplayName "Sales Department" -Alias Sales; Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG; Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All -``` - -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 assumes that you've already created a mail-enabled security group named "MarketingSG" by using the New-DistributionGroup cmdlet. - -## PARAMETERS - -### -Name -The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AccountDisabled -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. - -The mailbox is created, and the associated account is created, but the account is disabled, so you can't log on to the mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: DisabledUser -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration switch specifies that the mailbox you're creating is an arbitration mailbox. You don't need to specify a value with this switch. - -Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. - -Note: To create an arbitration mailbox that's used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: Migration -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 -``` - -### -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. - -Only use this parameter if the archive is hosted in the cloud-based service. - -```yaml -Type: SmtpDomain -Parameter Sets: RemoteArchive -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Discovery -The Discoveryswitch specifies that the mailbox is a Discovery mailbox. You don't need to specify a value with this switch. - -This switch is required only if you're creating a Discovery mailbox. - -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 (https://technet.microsoft.com/library/dd298021.aspx). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableRoomMailboxAccount -The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: - -- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox. - -- $false: The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value. - -You need to use this parameter with the Room switch. - -Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Lync Room System or the Skype for Business Room System. - -In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. - -```yaml -Type: $true | $false -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Equipment -The Equipment switch specifies that the resource mailbox is an equipment mailbox. You don't need to specify a value with this switch. - -This switch is required only if you're creating an equipment mailbox. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: String -Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InactiveMailbox -This parameter is available only in the cloud-based service. - -The InactiveMailbox parameter specifies the inactive mailbox that you want to recover. To find inactive mailboxes, run the command Get-Mailbox -InactiveMailboxOnly | FL Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid and then use the DistinguishedName or ExchangeGuid property values to identify the inactive mailbox for this parameter (values guaranteed to be unique). - -```yaml -Type: MailboxIdParameter -Parameter Sets: InactiveMailbox -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: MailboxIdParameter -Parameter Sets: User -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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. - -This parameter is required only if you're creating a linked mailbox. - -```yaml -Type: String -Parameter Sets: Linked, LinkedRoomMailbox -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedMasterAccount -The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: Linked, LinkedRoomMailbox -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedRoom -This parameter is available only in on-premises Exchange. - -The LinkedRoom switch specifies that the mailbox is a linked resource mailbox. You don't need to specify a value with this switch. - -A linked resource mailbox is useful in a scenario where you have an account in an authentication forest and you want it to be directly linked to a resource mailbox in resource forest. - -```yaml -Type: SwitchParameter -Parameter Sets: LinkedRoomMailbox -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftOnlineServicesID -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: WindowsLiveId -Parameter Sets: MicrosoftOnlineServicesFederatedUser, MicrosoftOnlineServicesFederatedUser -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: WindowsLiveId -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Migration -The Migration switch specifies that the mailbox is a migration mailbox. You don't need to specify a value with this switch. - -This switch is required only if you're creating a migration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Migration -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password for the mailbox (the user account that's associated with the mailbox). This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the associated user accounts are disabled for these types of mailboxes. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: User, MicrosoftOnlineServicesID, RemoteArchive -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SecureString -Parameter Sets: Arbitration, DisabledUser, Discovery, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -PublicFolder -The PublicFolder switch specifies that the mailbox is a public folder mailbox. You don't need to specify a value with this switch. - -This switch is required only if you're creating a public folder mailbox. - -Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. The first public folder mailbox created in your Exchange organization is called the primary hierarchy mailbox. It contains the writeable copy of the hierarchy of public folders for the organization and public folder content. There can be only one writeable copy of the public folder hierarchy in your organization. All other public folder mailboxes are called secondary public folder mailboxes and contain a read-only copy of the hierarchy and the content for public folders. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovedMailbox -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: RemovedMailboxIdParameter -Parameter Sets: RemovedMailbox -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: RemovedMailboxIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, FederatedUser, MicrosoftOnlineServicesFederatedUser, RemoteArchive, RemovedMailbox -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Room -The Room switch specifies that the resource mailbox is a room mailbox. You don't need to specify a value with this switch. - -This switch is required only if you're creating a room mailbox. - -When you use this switch, a logon-disabled account is created with the room mailbox, which prevents users from signing in to the mailbox. When you use the EnableRoomMailboxAccount and RoomMailboxPassword parameters, you can mail-enable the associated account. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -The Shared parameter specifies that the mailbox is a shared mailbox. You don't need to specify a value with this switch. - -This switch is required only if you're creating a shared mailbox. - -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -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. - -```yaml -Type: String -Parameter Sets: User, Arbitration, AuditLog, RemoteArchive -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: AuxAuditLog, DisabledUser,Discovery, EnableRoomMailboxAccount, Equipment, Linked, LinkedRoomMailbox, Migration, Room, Scheduling, Shared -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 -``` - -### -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 - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default mobile device mailbox policy is used. - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddressBookPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -For more information about address book policies, see Address book policies (https://technet.microsoft.com/library/hh529948.aspx). - -```yaml -Type: AddressBookMailboxPolicyIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -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 value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Archive -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveDatabase -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DatabaseIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -AuditLog -The AuditLog switch specifies the mailbox is an arbitration mailbox that's used to store audit log settings. You don't need to specify a value with this switch. - -Notes: - -- This switch is required only if you're creating this type of arbitration mailbox. - -- The Arbitration switch doesn't work for creating this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: AuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuxAuditLog -The AuxAuditLog switch specifies the mailbox is an arbitration mailbox that's used to store audit log data. You don't need to specify a value with this switch. - -Notes: - -- This switch is required only if you're creating this type of arbitration mailbox. - -- The Arbitration switch doesn't work for creating this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: AuxAuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -DisplayName -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared - -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 -``` - -### -FirstName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -HoldForMigration -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. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -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. - -```yaml -Type: $true | $false -Parameter Sets: PublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedCredential -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. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: Linked, LinkedRoomMailbox -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 -``` - -### -MailboxPlan -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: - -- Name - -- Alias - -- Display name - -- Distinguished name (DN) - -- GUID - -A mailbox plan specifies the permissions and features that are available to a mailbox. In Office 365, mailbox plans correspond to the subscriptions and licenses that administrators purchase and assign in the Office 365 admin center. - -You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, DisabledUser, FederatedUser, InactiveMailbox, MicrosoftOnlineServicesFederatedUser, RemoteArchive, RemovedMailbox -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxProvisioningConstraint -This parameter is only available in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxProvisioningConstraint -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxProvisioningPreferences -This parameter is only available in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxRegion -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedFolderMailboxPolicy -This parameter is available or functional only in Exchange Server 2010. - -The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedFolderMailboxPolicyAllowed -This parameter is available or functional only in Exchange Server 2010. - -The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Microsoft Outlook earlier than Office Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used. - -Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM. - -```yaml -Type: SwitchParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office -The Office parameter specifies the user's physical office name or number. - -```yaml -Type: String -Parameter Sets: LinkedRoomMailbox, Room -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 -``` - -### -OfficeGraph -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Phone -The Phone parameter specifies the user's telephone number. - -```yaml -Type: String -Parameter Sets: LinkedRoomMailbox, Room -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 -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvisionedForOfficeGraph -This parameter is only available in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: Arbitration -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteArchive -This parameter is available only in on-premises Exchange. - -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. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoteArchive -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 -``` - -### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user has access to remote PowerShell. Valid values are: - -- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. - -- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. - -Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. - -A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. - -```yaml -Type: $true | $false -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 -``` - -### -ResetPasswordOnNextLogon -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. - -```yaml -Type: $true | $false -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 -``` - -### -ResourceCapacity -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPolicy -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: - -- Name - -- Distinguished Name (DN) - -- GUID - -Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. - -Use the Get-RetentionPolicy cmdlet to see the available retention policies. - -If you don't use this parameter, the retention policy named Default MRM Policy is applied to the mailbox. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -RoleAssignmentPolicy -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 - -- Distinguished name (DN) - -- GUID - -In Office 365, if you don't use this parameter, the default role assignment policy named Default Role Assignment Policy is automatically applied to the mailbox. In on-premises Exchange, no role assignment policy is automatically applied to the mailbox. - -Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information about assignment policies, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomMailboxPassword -Use the RoomMailboxPassword parameter to configure the password for a room mailbox that has a logon-enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - -To use this parameter, you need to be a member of one of the following role groups: - -- Office 365: The Organization Management role group via the Mail Recipients, Reset Password, and User Options roles, the Help Desk role group via the Reset Password and User Options roles, or the Recipient Management role group via the Mail Recipients and Reset Password roles. - -- On-premises Exchange: The Organization Management role group via the Mail Recipients and User Options roles, the Recipient Management role group via the Mail Recipients role, or the Help Desk role group via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -Scheduling -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: Scheduling -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Use the Get-SharingPolicy cmdlet to see the available sharing policies. - -If you don't use this parameter, the sharing policy named Default Sharing Policy is applied to the mailbox. - -```yaml -Type: SharingPolicyIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -SkipMailboxProvisioningConstraintValidation -This parameter is only available in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAllMDBs -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottlingPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies. - -By default, no throttling policy is applied to the mailbox. - -```yaml -Type: ThrottlingPolicyIdParameter -Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Scheduling, Shared -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/42dbb25a-0b23-4775-ae15-7af62c089565.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-MailboxFolder.md b/exchange/exchange-ps/exchange/mailboxes/New-MailboxFolder.md deleted file mode 100644 index 1676fdf4a5..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-MailboxFolder.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-MailboxFolder cmdlet to create folders in your own mailbox. Administrators can't use this cmdlet to create folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MailboxFolder [-Name] <String> -Parent <MailboxFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). . - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailboxFolder -Parent Tony:\Inbox -Name Personal -``` - -This example creates the folder Personal under the Inbox folder of Tony's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -New-MailboxFolder -Parent Tony -Name Personal -``` - -This example creates the folder Personal in the root folder hierarchy of Tony's mailbox. - -### -------------------------- Example 3 -------------------------- -``` -New-MailboxFolder -Parent :\Inbox -Name Personal -``` - -This example creates the folder Personal under the Inbox folder in the mailbox for Tony who's running the command. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -The Parent parameter specifies values of the mailbox identity and the parent folder under which the new folder is to be created. If the parent folder isn't specified, the cmdlet creates the folder in the root folder hierarchy of the specified mailbox. You specify values for this parameter by using the syntax: \<Mailbox Identity\>:\<Parent\> - -Valid values for \<Mailbox Identity\> are unique identifiers for the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Values for \<Parent\> can be both the store object ID and a path string such as "\\Inbox\\Personal". - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1666ee72-6e8e-4d07-b71a-fe6ddbc0c2ef.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-MailboxImportRequest.md b/exchange/exchange-ps/exchange/mailboxes/New-MailboxImportRequest.md deleted file mode 100644 index 72c1d88baa..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-MailboxImportRequest.md +++ /dev/null @@ -1,989 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxImportRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-MailboxImportRequest cmdlet to begin the process of importing a .pst file to a mailbox or archive. You can create more than one mailbox import request per mailbox and each mailbox import request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox import request. However, to create more than 10 import requests for a mailbox, you need to specify a unique name when creating the import request, or you can remove existing import requests with the Remove-MailboxExportRequest cmdlet before starting a new import request with the default request \<Alias\>\\MailboxImportX (where X = 0-9). - -By default, the import checks for duplication of items and doesn't copy the data from the .pst file into the mailbox or archive if a matching item exists in the target mailbox or target archive. - -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 the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Mailbox -``` -New-MailboxImportRequest [-Mailbox] <MailboxOrMailUserIdParameter> -FilePath <LongPath> - [-AcceptLargeDataLoss] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] - [-ContentCodePage <Int32>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-IsArchive] - [-LargeItemLimit <Unlimited>] - [-MRSServer <Fqdn>] - [-Name <String>] - [-Priority <Normal | High>] - [-RemoteCredential <PSCredential>] - [-RemoteHostName <Fqdn>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetRootFolder <String>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [<CommonParameters>] -``` - -### MailboxImportRequest -``` -New-MailboxImportRequest [-Mailbox] <MailboxLocationIdParameter> -FilePath <LongPath> - [-AcceptLargeDataLoss] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll | UpdateFromSource | ForceCopy | KeepTargetItem>] - [-ContentCodePage <Int32>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-IsArchive] - [-LargeItemLimit <Unlimited>] - [-MigrationMailbox <MailboxIdParameter>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceEndpoint <MigrationEndpointIdParameter>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetRootFolder <String>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport | XO1Migration | CrossResourceForest | ShadowSync | XrmSharing | ThirdPartyContactSync>] - [<CommonParameters>] -``` - -### AzureImportRequest -``` -New-MailboxImportRequest [-Mailbox] <MailboxLocationIdParameter> -AzureBlobStorageAccountUri <Uri> -AzureSharedAccessSignatureToken <String> - [-AcceptLargeDataLoss] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-AzureStatusPublishEndpointInfo <String>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll | UpdateFromSource | ForceCopy | KeepTargetItem>] - [-ContentCodePage <Int32>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-IsArchive] - [-LargeItemLimit <Unlimited>] - [-MigrationMailbox <MailboxIdParameter>] - [-MRSContentFilterSasUri <Uri>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceEndpoint <MigrationEndpointIdParameter>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetRootFolder <String>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport | XO1Migration | CrossResourceForest | ShadowSync | XrmSharing | ThirdPartyContactSync>] - [<CommonParameters>] -``` - -### RemoteRequest -``` -New-MailboxImportRequest [-Mailbox] <MailboxLocationIdParameter> -RemoteFilePath <LongPath> -RemoteHostName <Fqdn> - [-AcceptLargeDataLoss] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll | UpdateFromSource | ForceCopy | KeepTargetItem>] - [-ContentCodePage <Int32>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-IsArchive] - [-LargeItemLimit <Unlimited>] - [-MigrationMailbox <MailboxIdParameter>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RemoteCredential <PSCredential>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceEndpoint <MigrationEndpointIdParameter>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetRootFolder <String>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport | XO1Migration | CrossResourceForest | ShadowSync | XrmSharing | ThirdPartyContactSync>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -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. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailboxImportRequest -Mailbox Ayla -FilePath \\SERVER01\PSTFiles\Recovered.pst -TargetRootFolder "RecoveredFiles" -IncludeFolders "#Inbox#" -``` - -This example imports a recovered .pst file on SERVER01 into the user Ayla's primary mailbox. Only data in the .pst file's Inbox is imported. The data is imported into the RecoveredFiles folder of the target mailbox for Ayla. - -### -------------------------- Example 2 -------------------------- -``` -New-MailboxImportRequest User2 -FilePath \\server\share\User1.pst -IsArchive -TargetRootFolder / -``` - -This example imports a .pst file into Kweku's archive folder. The TargetRootFolder isn't specified; therefore, content is merged under existing folders and new folders are created if they don't already exist in the target folder structure. - -### -------------------------- Example 3 -------------------------- -``` -Dir \\SERVER01\PSTshareRO\Recovered\*.pst | %{ New-MailboxImportRequest -Name RecoveredPST -BatchName Recovered -Mailbox $_.BaseName -FilePath $_.FullName -TargetRootFolder SubFolderInPrimary} -``` - -This example imports all of the .pst files on a shared folder. Each .pst file name is named after a corresponding user's alias. The command creates an import request for all the .pst files and imports the data into the matching mailbox. - -## PARAMETERS - -### -FilePath -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. - -You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: - -- To import PST files from the share: Read permission - -- To save exported PST files to the share: Read/Write permission. - -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. - -```yaml -Type: LongPath -Parameter Sets: Mailbox, MailboxImportRequest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the destination mailbox where the content is being imported to. - -In Exchange 2016 CU7 or later and Exchange Online, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. - -In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdParameter, so you can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxOrMailUserIdParameter -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxImportRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RemoteFilePath -This parameter is reserved for internal Microsoft use. - -```yaml -Type: LongPath -Parameter Sets: RemoteRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHostName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: RemoteRequest -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Fqdn -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssociatedMessagesCopyOption -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. - -- MapByMessageClass: This option finds the corresponding 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: This option copies 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 option. - -Content filtering doesn't apply to associated messages. - -```yaml -Type: DoNotCopy | MapByMessageClass | Copy -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 -``` - -### -AzureBlobStorageAccountUri -This parameter is available only in the cloud-based service. - -PARAMVALUE: Uri - -```yaml -Type: Uri -Parameter Sets: AzureImportRequest -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureSharedAccessSignatureToken -This parameter is available only in the cloud-based service. - -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: AzureImportRequest -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureStatusPublishEndpointInfo -This parameter is available only in the cloud-based service. - -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: AzureImportRequest -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchName -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConflictResolutionOption -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.) - -- KeepTargetItem - -- UpdateFromSource - -```yaml -Type: KeepSourceItem | KeepLatestItem | KeepAll -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 -``` - -### -ContentCodePage -The ContentCodePage parameter specifies the specific code page to use for an ANSI pst file. ANSI pst filesare used in Outlook 97 to Outlook 2002. You can find the valid values in the Code Page Identifiers (https://go.microsoft.com/fwlink/p/?linkId=328514) topic. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDumpster -The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders: - -- Deletions - -- Versions - -- Purges - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFolders -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: - -\<FolderName\>/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". - -\#\<FolderName\>\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - -- Inbox - -- SentItems - -- DeletedItems - -- Calendar - -- Contacts - -- Drafts - -- Journal - -- Tasks - -- Notes - -- JunkEmail - -- CommunicatorHistory - -- Voicemail - -- Fax - -- Conflicts - -- SyncIssues - -- LocalFailures - -- ServerFailures - -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. - -Wildcard characters can't be used in folder names. - -If the TargetRootFolder parameter isn't specified when the Recoverable Items folder is imported, the recoverable item content is placed in the Recoverable Items folder of the target mailbox or archive. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeFolders -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: - -\<FolderName\>/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". - -\#\<FolderName\>\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - -- Inbox - -- SentItems - -- DeletedItems - -- Calendar - -- Contacts - -- Drafts - -- Journal - -- Tasks - -- Notes - -- JunkEmail - -- CommunicationHistory - -- Voicemail - -- Fax - -- Conflicts - -- SyncIssues - -- LocalFailures - -- ServerFailures - -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. - -Wildcard characters can't be used in folder names. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalFlags -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. - -```yaml -Type: InternalMrsFlag[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsArchive -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationMailbox -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: AzureImportRequest, MailboxImportRequest, RemoteRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MRSContentFilterSasUri -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Uri -Parameter Sets: AzureImportRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MRSServer -This parameter is available or functional 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. - -```yaml -Type: Fqdn -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 \<alias\>\\MailboxImportX. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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. - -```yaml -Type: Normal | High -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 -``` - -### -RemoteCredential -This parameter is available only in on-premises Exchange. - -The RemoteCredential parameter specifies the credentials of an administrator who has permission to perform the mailbox import request. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: Mailbox, RemoteRequest -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 -``` - -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: AzureImportRequest, MailboxImportRequest, RemoteRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceEndpoint -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: AzureImportRequest, MailboxImportRequest, RemoteRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceRootFolder -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendComment -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetRootFolder -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WorkloadType -This parameter is available only in on-premises Exchange. - -The WorkloadType parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4ca9af1a-33fa-4d53-a765-f46a1b7f2d3a.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/mailboxes/New-MailboxRestoreRequest.md deleted file mode 100644 index e06b44fb4b..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-MailboxRestoreRequest.md +++ /dev/null @@ -1,999 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxRestoreRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MailboxLocationIDMigrationLocalMailboxRestore -``` -New-MailboxRestoreRequest -SourceDatabase <DatabaseIdParameter> -SourceStoreMailbox <StoreMailboxIdParameter> -TargetMailbox <MailboxLocationIdParameter> - [-AcceptLargeDataLoss] - [-AllowLegacyDNMismatch] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetIsArchive] - [-TargetRootFolder <String>] - [-TargetType <Primary | Archive | MailboxLocation>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [<CommonParameters>] -``` - -### MailboxIDMigrationLocalMailboxRestore -``` -New-MailboxRestoreRequest -SourceDatabase <DatabaseIdParameter> -SourceStoreMailbox <StoreMailboxIdParameter> -TargetMailbox <MailboxOrMailUserIdParameter> - [-AcceptLargeDataLoss] - [-AllowLegacyDNMismatch] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-MRSServer <Fqdn>] - [-Name <String>] - [-Priority <Normal | High>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetIsArchive] - [-TargetRootFolder <String>] - [-TargetType <Primary | Archive | MailboxLocation>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [<CommonParameters>] -``` - -### MailboxLocationIDRemoteMailboxRestore -``` -New-MailboxRestoreRequest -RemoteCredential <PSCredential> -RemoteDatabaseGuid <Guid> -RemoteHostName <Fqdn> -RemoteRestoreType <None | RecoveryDatabase | DisconnectedMailbox | SoftDeletedRecipient> -SourceStoreMailbox <StoreMailboxIdParameter> -TargetMailbox <MailboxLocationIdParameter> - [-AcceptLargeDataLoss] - [-AllowLegacyDNMismatch] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetIsArchive] - [-TargetRootFolder <String>] - [-TargetType <Primary | Archive | MailboxLocation>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [<CommonParameters>] -``` - -### MailboxIDRemoteMailboxRestore -``` -New-MailboxRestoreRequest -SourceStoreMailbox <StoreMailboxIdParameter> -TargetMailbox <MailboxOrMailUserIdParameter> - [-AcceptLargeDataLoss] - [-AllowLegacyDNMismatch] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetIsArchive] - [-TargetRootFolder <String>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [<CommonParameters>] -``` - -### SourceMailbox -``` -New-MailboxRestoreRequest -SourceMailbox <MailboxLocationIdParameter> -TargetMailbox <MailboxLocationIdParameter> - [-AcceptLargeDataLoss] - [-AllowLegacyDNMismatch] - [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll | UpdateFromSource | ForceCopy | KeepTargetItem>] - [-DomainController <Fqdn>] - [-ExcludeDumpster] - [-ExcludeFolders <String[]>] - [-IncludeFolders <String[]>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceIsArchive] - [-SourceRootFolder <String>] - [-Suspend] - [-SuspendComment <String>] - [-TargetIsArchive] - [-TargetRootFolder <String>] - [-TargetType <Primary | Archive | MailboxLocation>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport | XO1Migration | CrossResourceForest | ShadowSync | XrmSharing | ThirdPartyContactSync>] - [<CommonParameters>] -``` - -## DESCRIPTION -When mailboxes are moved from one database to another, Exchange doesn't fully delete the mailbox from the source database immediately upon completion of the move. Instead, the mailbox in the source mailbox database is switched to a soft-deleted state, which allows mailbox data to be accessed during a mailbox restore operation by using the new MailboxRestoreRequest cmdlet set. The soft-deleted mailboxes are retained in the source database until either the deleted mailbox retention period expires or you use the Remove-StoreMailbox cmdlet to purge the mailbox. - -To view soft-deleted mailboxes, run the Get-MailboxStatistics cmdlet against a database and look for results that have a DisconnectReason with a value of SoftDeleted. For more information, see Example 1 later in this topic. - -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. - -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 Example 1 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxStatistics -Database MBD01 | Where {$_.DisconnectReason -eq "SoftDeleted" -or $_.DisconnectReason -eq "Disabled"} | Format-List LegacyDN, DisplayName, MailboxGUID, DisconnectReason -``` - -To create a restore request, you must provide the DisplayName, LegacyDN, or MailboxGUID for the soft-deleted or disabled mailbox. - -This example uses the Get-MailboxStatistics cmdlet to return the DisplayName, LegacyDN, MailboxGUID, and DisconnectReason for all mailboxes on mailbox database MBD01 that have a disconnect reason of SoftDeleted or Disabled. - -### -------------------------- Example 2 -------------------------- -``` -New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox 1d20855f-fd54-4681-98e6-e249f7326ddd -TargetMailbox Ayla -``` - -This example restores the source mailbox with the MailboxGUID 1d20855f-fd54-4681-98e6-e249f7326ddd on mailbox database MBD01 to the target mailbox with the alias Ayla. - -### -------------------------- Example 3 -------------------------- -``` -New-MaiboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox "Tony Smith" -TargetMailbox Tony@contoso.com -TargetIsArchive -``` - -This example restores the content of the source mailbox with the DisplayName of Tony Smith on mailbox database MBD01 to the archive mailbox for Tony@contoso.com. - -## PARAMETERS - -### -RemoteCredential -This parameter is avaialble only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PSCredential -Parameter Sets: MailboxLocationIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteDatabaseGuid -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: MailboxLocationIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHostName -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: MailboxLocationIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteRestoreType -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: None | RecoveryDatabase | DisconnectedMailbox | SoftDeletedRecipient -Parameter Sets: MailboxLocationIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabase -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. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MailboxLocationIDMigrationLocalMailboxRestore, MailboxIDMigrationLocalMailboxRestore -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceMailbox -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceStoreMailbox -This parameter is available only in on-premises Exchange. - -The SourceStoreMailbox parameter specifies the MailboxGUID of the source mailbox that you want to restore content from. - -You can find the MailboxGUID by running the Get-MailboxStatistics cmdlet. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: MailboxLocationIDMigrationLocalMailboxRestore, MailboxIDMigrationLocalMailboxRestore, MailboxLocationIDRemoteMailboxRestore, MailboxIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetMailbox -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. - -In Exchange 2016 or later and Exchange Online, this parameter is the type MailboxLocationIdParameter. - -In Exchange 2013 or earlier, this parameter is the type MailboxOrMailUserIdParameter. - -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationIDMigrationLocalMailboxRestore, MailboxLocationIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: MailboxOrMailUserIdParameter -Parameter Sets: MailboxIDMigrationLocalMailboxRestore, MailboxIDRemoteMailboxRestore -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowLegacyDNMismatch -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssociatedMessagesCopyOption -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. This is the default option. - -- MapByMessageClass: This option finds the corresponding 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: This option copies 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. - -Content filtering doesn't apply to associated messages. - -```yaml -Type: DoNotCopy | MapByMessageClass | Copy -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 -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompletedRequestAgeLimit -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: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConflictResolutionOption -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.) - -- KeepTargetItem - -- UpdateFromSource - -```yaml -Type: KeepSourceItem | KeepLatestItem | KeepAll -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDumpster -The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders: - -- Deletions - -- Versions - -- Purges - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFolders -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: - -\<FolderName\>/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". - -\#\<FolderName\>\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - -- Inbox - -- SentItems - -- DeletedItems - -- Calendar - -- Contacts - -- Drafts - -- Journal - -- Tasks - -- Notes - -- JunkEmail - -- CommunicatorHistory - -- Voicemail - -- Fax - -- Conflicts - -- SyncIssues - -- LocalFailures - -- ServerFailures - -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. - -Wildcard characters can't be used in folder names. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeFolders -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: - -\<FolderName\>/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". - -\#\<FolderName\>\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - -- Inbox - -- SentItems - -- DeletedItems - -- Calendar - -- Contacts - -- Drafts - -- Journal - -- Tasks - -- Notes - -- JunkEmail - -- CommunicationHistory - -- Voicemail - -- Fax - -- Conflicts - -- SyncIssues - -- LocalFailures - -- ServerFailures - -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. - -Wildcard characters can't be used in folder names. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalFlags -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. - -```yaml -Type: InternalMrsFlag[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -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: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MRSServer -This parameter is available or functional 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. - -```yaml -Type: Fqdn -Parameter Sets: MailboxIDMigrationLocalMailboxRestore -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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: - -- Lowest - -- Lower - -- Low - -- Normal (This is the default value.) - -- High - -- Higher - -- Highest - -- Emergency - -```yaml -Type: Normal | High -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 -``` - -### -RequestExpiryInterval -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: - -- The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: MailboxLocationIDMigrationLocalMailboxRestore, MailboxLocationIDRemoteMailboxRestore, SourceMailbox -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -This parameter is available only in on-premises Exchange. - -The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - -- FolderRules - -- FolderACLs - -- InitialConnectionValidation - -Use this parameter only if a restore request fails because of folder rules, folder access control lists (ACLs), or initial connection validation. - -```yaml -Type: SkippableMergeComponent[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceIsArchive -The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You can use this switch only with the SourceMailbox parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: SourceMailbox -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceRootFolder -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendComment -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIsArchive -The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetRootFolder -The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -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) - -```yaml -Type: Primary | Archive | MailboxLocation -Parameter Sets: MailboxLocationIDMigrationLocalMailboxRestore, MailboxLocationIDRemoteMailboxRestore, SourceMailbox -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkloadType -This parameter is available only in on-premises Exchange. - -The WorkloadType parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0b67defd-3c6c-4470-acfa-7f22a6c1d2bd.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/New-SiteMailbox.md b/exchange/exchange-ps/exchange/mailboxes/New-SiteMailbox.md deleted file mode 100644 index cc38d0fa5f..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/New-SiteMailbox.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SiteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-SiteMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -The New-SiteMailbox cmdlet is used by Microsoft SharePoint and Microsoft Exchange user interfaces to create site mailboxes. We recommend that you don't use this cmdlet in the Exchange Management Shell; instead use SharePoint to create the site mailbox. This cmdlet should only be used for diagnostic and troubleshooting purposes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SiteMailbox [[-DisplayName] <String>] -SharePointUrl <Uri> [-Alias <String>] [-Confirm] - [-Database <DatabaseIdParameter>] [-DomainController <Fqdn>] [-Force] [-Name <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-OverrideRecipientQuotas] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SiteMailbox -``` - -You can't run this cmdlet from the Exchange Management Shell. Use SharePoint to create a site mailbox. - -## PARAMETERS - -### -SharePointUrl -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -This parameter is available only in on-premises Exchange. - -The Database parameter specifies the identity of the mailbox database on which the mailbox data for the site mailbox resides. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -This parameter specifies whether to test that the site mailbox provisioning is working independently of the SharePoint deployment. We recommend that you never use this parameter for production site mailboxes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideRecipientQuotas -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/90a1639f-b5d1-4512-a506-a4c3953865ae.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-App.md b/exchange/exchange-ps/exchange/mailboxes/Remove-App.md deleted file mode 100644 index 9ae23f666f..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-App.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-App -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-App cmdlet to uninstall an app. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-App [-Identity] <AppIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Mailbox <MailboxIdParameter>] - [-OrganizationApp] [-WhatIf] [-PrivateCatalog] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet. Apps installed by default can't be uninstalled, but they can be disabled. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-App -Identity <GUID for FinanceTestApp> -Mailbox Tony -``` - -This example removes the Finance Test app installed for user Tony. - -For more information, see Install or remove add-ins for Outlook for your organization (https://technet.microsoft.com/library/jj943752.aspx). - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the mailbox or mail user. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationApp -The OrganizationApp parameter specifies that the scope of the app is organizational. This is set to $false by default. This parameter is required if the targeted app is installed for the organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateCatalog -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cfd1245f-dcd2-48c1-b753-a7ebedd2803f.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-CalendarEvents.md b/exchange/exchange-ps/exchange/mailboxes/Remove-CalendarEvents.md deleted file mode 100644 index 0b5e19338c..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-CalendarEvents.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: Remove-CalendarEvents -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-CalendarEvents - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-CalendarEvents cmdlet to cancel future meetings in user or resource mailboxes in Office 365. Cancelling future meetings removes them from attendee and resource calendars (for example, you're going to remove the mailbox, or the user is going on a leave of absence). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-CalendarEvents [-Identity] <MailboxIdParameter> [-CancelOrganizedMeetings] [-Confirm] [-PreviewOnly] - [-QueryStartDate <ExDateTime>] [-QueryWindowInDays <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet cancels meetings in the specified mailbox where the mailbox is the meeting organizer, and the meeting has one or more attendees or resources. It doesn't cancel appointments or meetings without attendees or resources. Because meeting cancellations must be sent out, the mailbox must still be enabled to send 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CalendarEvents -Identity chris@contoso.com -CancelOrganizedMeetings -``` - -This example cancels every meeting in the mailbox chris@contoso.com that occurs on or after today's date. After you cancel the meetings, you can remove the mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Remove-CalendarEvents -Identity "Angela Gruber" -CancelOrganizedMeetings -QueryStartDate 11-1-2018 -QueryWindowInDays 120 -``` - -This example cancels the meetings in Angela Gruber's calendar for the specified date range. Angela is taking a temporary leave of absence from the company, so cancelling these meetings removes them from the user and resource calendars during her absence. - -### -------------------------- Example 3 -------------------------- -``` -Remove-CalendarEvents -Identity "Jacob Berger" -CancelOrganizedMeetings -QueryStartDate 9-1-2018 -QueryWindowInDays 90 -PreviewOnly -Verbose -``` - -This example previews the meetings that would be cancelled in Jacob Berger's calendar for the specified date range. No changes are made to the mailbox. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CancelOrganizedMeetings -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewOnly -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryStartDate -The QueryStartDate parameter specifies the start date to look for meetings that you want to cancel. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -If you don't use this parameter, today's date is used. - -You use the QueryWindowInDays parameter to specify the end date. - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryWindowInDays -The QueryWindowInDays parameter specifies the number of days after the QueryStartDate parameter value to look for meetings that you want to cancel. - -If you don't use this parameter, all future meetings on or after the specified start date will be cancelled. - -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). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bf188d1c-d6e5-4c82-9508-35f9b788ff82.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-InboxRule.md b/exchange/exchange-ps/exchange/mailboxes/Remove-InboxRule.md deleted file mode 100644 index 64fe576478..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-InboxRule.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-InboxRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-InboxRule cmdlet to remove an Inbox rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-InboxRule [-Identity] <InboxRuleIdParameter> [-AlwaysDeleteOutlookRulesBlob] [-Confirm] - [-DomainController <Fqdn>] [-Force] [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-InboxRule -Mailbox Joe@Contoso.com -Identity "ProjectA-MoveToFolderA" -``` - -This example removes the Inbox rule ProjectA-MoveToFolderA from the mailbox Joe@Contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-InboxRule -Mailbox "Joe@Contoso.com" | Remove-InboxRule -``` - -This example removes all Inbox rules from the mailbox Joe@Contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the name of the Inbox rule to be removed. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f9748fab-1740-460b-9df6-4b438007dd48.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md deleted file mode 100644 index 75cbe7f867..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md +++ /dev/null @@ -1,494 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-Mailbox cmdlet to delete mailboxes and the associated user accounts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Remove-Mailbox [-Identity] <MailboxIdParameter> [-Permanent <$true | $false>] - [-Arbitration] - [-AuditLog] - [-AuxAuditLog] - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-IgnoreDefaultScope] - [-IgnoreLegalHold] - [-Migration] - [-PublicFolder] - [-RemoveArbitrationMailboxWithOABsAllowed] - [-RemoveLastArbitrationMailboxAllowed] - [-WhatIf] [<CommonParameters>] -``` - -### StoreMailboxIdentity -``` -Remove-Mailbox -Database <DatabaseIdParameter> -StoreMailboxIdentity <StoreMailboxIdParameter> - [-Arbitration] - [-AuditLog] - [-AuxAuditLog] - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-IgnoreDefaultScope] - [-IgnoreLegalHold] - [-Migration] - [-PublicFolder] - [-RemoveArbitrationMailboxWithOABsAllowed] - [-RemoveLastArbitrationMailboxAllowed] - [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -Remove-Mailbox [-Identity] <MailboxIdParameter> [-PermanentlyDelete] - [-Confirm] - [-Force] - [-IgnoreLegalHold] - [-Migration] - [-PublicFolder] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Identity parameter alone to disconnect the mailbox from the user and remove the user account. The mailbox still exists, and is retained until the deleted mailbox retention period expires. The deleted mailbox retention period is controlled by the MailboxRetention property on the mailbox database or on the mailbox itself if the UseDatabaseRetentionDefaults property is False. - -Use the Identity and Permanent parameters to disconnect the mailbox from the user, remove the user account, and immediately remove the mailbox from the mailbox database. The mailbox doesn't remain in the mailbox database as a disconnected mailbox. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-Mailbox -Identity "John Rodman" -``` - -This example removes the mailbox and the user account for the user named John Rodman. The mailbox remains in the mailbox database for the deleted mailbox retention period that's configured for the database. - -### -------------------------- Example 2 -------------------------- -``` -Remove-Mailbox -Identity "John Rodman" -Permanent $true -``` - -This example removes the mailbox and the user account for the user named John Rodman. The mailbox is immediately and permanently removed from the mailbox database. - -### -------------------------- Example 3 -------------------------- -``` -$Temp = Get-Mailbox | Where {$_.DisplayName -eq 'John Rodman'}; Remove-Mailbox -Database Server01\Database01 -StoreMailboxIdentity $Temp.MailboxGuid -``` - -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. - -## PARAMETERS - -### -Identity -The Identity parameter identifies the mailbox that you want to remove. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -You can't use this parameter with the Database parameter. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Database -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: - -- Name - -- Distinguished name (DN) - -- GUID - -When you use this parameter with the StoreMailboxIdentity parameter to identify and remove the mailbox, the mailbox is immediately and permanently deleted from the database, so you can't reconnect or restore the mailbox. You can't use either of these parameters with the Identity parameter. - -If you've disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store, use the Database and StoreMailboxIdentity parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: StoreMailboxIdentity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoreMailboxIdentity -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 GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. - -When you use this parameter with the Database parameter to identify and remove the mailbox, the mailbox is immediately and permanently deleted from the database, so you can't reconnect or restore the mailbox. You can't either of these parameters with the Identity parameter. - -If you've disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store, use the Database and StoreMailboxIdentity parameters. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: StoreMailboxIdentity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration switch specifies that the mailbox you're removing is an arbitration mailbox. You don't need to specify a value with this switch. - -Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. - -Notes: - -- If you don't use this switch, the command can't find the arbitration mailbox to remove. - -- To remove an arbitration mailbox that's used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration switch. - -```yaml -Type: SwitchParameter -Parameter Sets: StoreMailboxIdentity, Identity -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 -``` - -### -AuditLog -This parameter is available only in on-premises Exchange. - -The AuditLog switch specifies the mailbox you're removing is an arbitration mailbox that's used to store audit log settings. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't work for removing this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: StoreMailboxIdentity, Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuxAuditLog -This parameter is available only in on-premises Exchange. - -The AuxAuditLog switch specifies the mailbox you're removing is an arbitration mailbox that's used to store audit log data. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't work for removing this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: StoreMailboxIdentity, Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: StoreMailboxIdentity, Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: StoreMailboxIdentity, Identity -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 -``` - -### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. - -After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -``` - -### -Migration -{{Fill Migration Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permanent -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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -PermanentlyDelete -This parameter is available only in the cloud-based service. - -The PermanentlyDelete switch specifies whether to immediately and permanently delete (purge) the mailbox, which prevents you from recovering or restoring the mailbox. You don't need to specify a value with this switch. - -Notes: - -- This switch works only on mailboxes that have already been deleted, but are still recoverable (known as soft-deleted mailboxes). - -- This switch doesn't work on soft-deleted mailboxes that are on In-Place Hold or Litigation Hold (known as inactive mailboxes). - -Use the Get-Mailbox cmdlet to identify the soft-deleted mailbox, and then pipe the results to the Remove-Mailbox cmdlet with this switch. For example, Get-Mailbox -Identity Laura -SoftDeleted | Remove-Mailbox -PermanentlyDelete. - -```yaml -Type: SwitchParameter -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -The PublicFolderswitch specifies that the mailbox to remove is a public folder mailbox. You don't need to specify a value with this switch. You need to use this switch to remove public folder mailboxes. - -Public folder mailboxes are specially designed mailboxes to store the hierarchy and content of public folders. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveArbitrationMailboxWithOABsAllowed -This parameter is available only in on-premises Exchange. - -The RemoveArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being removed. When you use this switch, the arbitration mailbox is removed even if OABs are present in the mailbox. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: StoreMailboxIdentity, Identity -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 -``` - -### -RemoveLastArbitrationMailboxAllowed -This parameter is available only in on-premises Exchange. - -The RemoveLastArbitrationMailboxAllowed switch specifies whether to remove the specified mailbox, even if it's the last arbitration mailbox in the organization. If you remove the last arbitration mailbox in the organization, you can't have user-created distribution groups or moderated recipients. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: StoreMailboxIdentity, Identity -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0477708c-768c-4040-bad2-8f980606fcf4.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxFolderPermission.md deleted file mode 100644 index 54af071690..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxFolderPermission.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxFolderPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MailboxFolderPermission cmdlet to remove folder-level permissions for users in mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailboxFolderPermission [-Identity] <MailboxFolderIdParameter> -User <MailboxFolderUserIdParameter> - [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailboxFolderPermission -Identity kim@contoso.com:\Training -User john@contoso.com -``` - -This example removes John's permissions to the Training folder in Kim's mailbox. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Example values for the Identity parameter are john@contoso.com:\\Calendar or John:\\Marketing\\Reports. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailboxFolderUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendNotificationToUser -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. - -This parameter only applies to calendar folders. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/da9b68c7-0261-4a41-b64d-d9f279c853e7.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxPermission.md b/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxPermission.md deleted file mode 100644 index 870cfac511..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxPermission.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MailboxPermission cmdlet to remove permissions from a user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AccessRights -``` -Remove-MailboxPermission [-Identity] <MailboxIdParameter> -AccessRights <MailboxRights[]> -User <SecurityPrincipalIdParameter> - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-WhatIf] [<CommonParameters>] -``` - -### Instance -``` -Remove-MailboxPermission -Instance <MailboxAcePresentationObject> - [-AccessRights <MailboxRights[]>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] [-IgnoreDefaultScope] - [[-Identity] <MailboxIdParameter>] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-ResetDefault] - [-User <SecurityPrincipalIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Owner -``` -Remove-MailboxPermission [[-Identity] <MailboxIdParameter>] - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-WhatIf] [<CommonParameters>] -``` - -### ClearAutoMapping -``` -Remove-MailboxPermission [-Identity] <MailboxIdParameter> [-ClearAutoMapping] - [-AccessRights <MailboxRights[]>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-User <SecurityPrincipalIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ResetDefault -``` -Remove-MailboxPermission [-Identity] <MailboxIdParameter> [-ResetDefault] - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailboxPermission -Identity Test1 -User Test2 -AccessRights FullAccess -InheritanceType All -``` - -This example removes user Test2's full access rights to Test1's mailbox. - -## PARAMETERS - -### -AccessRights -The AccessRights parameter specifies the rights required to perform the operation. You can use the following values: - -- FullAccess - -- SendAs - -- ExternalAccount - -- DeleteItem - -- ReadPermission - -- ChangePermission - -- ChangeOwner - -```yaml -Type: MailboxRights[] -Parameter Sets: AccessRights -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: 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 -``` - -### -Identity -The Identity parameter specifies the mailbox where you are removing permissions. You can use any value that uniquely identifies the mailbox: - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: MailboxAcePresentationObject -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user mailbox that will get permissions removed. - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SecurityPrincipalIdParameter -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 -``` - -### -ClearAutoMapping -This parameter is available only in the cloud-based service. - -The ClearAutoMapping switch specifies that the mailbox is automatically mapped (auto-mapped) by Autodiscover only into the mailbox owner's Outlook profile. The mailbox isn't auto-mapped to other users who have FullAccess permission to the mailbox. - -To re-add auto-mapping capability on the mailbox for other users, run the command: Add-MailboxPermission -Identity \<Mailbox\> -AccessRights FullAccess -AutoMapping $true. - -```yaml -Type: SwitchParameter -Parameter Sets: ClearAutoMapping -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -Deny -The Deny parameter denies permissions to the user on the Active Directory object. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InheritanceType -The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. - -```yaml -Type: None | All | Descendents | SelfAndChildren | Children -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetDefault -This parameter is available only in the cloud-based service. - -The ResetDefault switch resets the default security descriptor of the mailbox. Permissions on the mailbox are reset so only the mailbox owner has FullAccess permission to the mailbox. The following types of permissions are not affected: - -- Recipient permissions (for example, SendAs, SendOnBehalf and delegates). - -- Mailbox folder permissions assigned using the MailboxFolderPermission cmdlets. - -- Mailbox folder permissions assigned using Outlook or other MAPI clients. - -Also, because this switch removes FullAccess permission from other users on the mailbox, the mailbox is no longer auto-mapped by Autodiscover into the Outlook profiles of other users. - -```yaml -Type: SwitchParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eda30705-6070-413a-88c5-db262fbad8d3.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxUserConfiguration.md deleted file mode 100644 index 78460d1bad..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-MailboxUserConfiguration.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxUserConfiguration -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MailboxUserConfiguration cmdlet to remove user configuration items from mailboxes. Typically, after you delete a user configuration item, it's automatically recreated the next time the user uses that feature in their mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailboxUserConfiguration [-Identity] <MailboxUserConfigurationIdParameter> -Mailbox <MailboxIdParameter> - [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailboxUserConfiguration -Mailbox julia@contoso.com -Identity Configuration\IPM.Configuration.Aggregated.OwaUserConfiguration -``` - -This example removes the specified user configuration item from the mailbox lila@contoso.com. - -## PARAMETERS - -### -Identity -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. - -- Valid values for \<ItemName\> start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. - -```yaml -Type: MailboxUserConfigurationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5b85049e-1437-4308-9694-c412bc835bcf.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-RecipientPermission.md b/exchange/exchange-ps/exchange/mailboxes/Remove-RecipientPermission.md deleted file mode 100644 index 64936a106e..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-RecipientPermission.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Remove-RecipientPermission -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-RecipientPermission - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-RecipientPermission cmdlet to remove SendAs permission from users in a cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RecipientPermission [-Identity] <RecipientIdParameter> -AccessRights <MultiValuedProperty> - -Trustee <SecurityPrincipalIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RecipientPermission "Help Desk" -AccessRights SendAs -Trustee "Ayla Kol" -``` - -This example removes the SendAs permission from the user Ayla Kol for the mailbox Help Desk. Ayla can't send messages that appear to come directly from the Help Desk mailbox. - -## PARAMETERS - -### -AccessRights -The AccessRights parameter specifies the permission. - -Valid input for this parameter is SendAs. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -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: - -- Mailboxes - -- Mail users - -- External contacts - -- Distribution groups - -- Dynamic distribution groups - -You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Trustee -The Trustee parameter specifies the user or group from whom you're removing the permission. This prevents the user or group from operating on the recipients specified by the Identity parameter. - -You can specify the following types of users or groups: - -- Mailbox users - -- Mail users with a cloud-based account - -- Security groups - -You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5a772687-ca3b-4753-8dea-bf4c571e9e16.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-SweepRule.md b/exchange/exchange-ps/exchange/mailboxes/Remove-SweepRule.md deleted file mode 100644 index 983a890d02..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-SweepRule.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SweepRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-SweepRule cmdlet to remove Sweep rules from mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SweepRule [-Identity] <SweepRuleIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" -``` - -This example removess the specified Sweep rule. - -### -------------------------- Example 2 -------------------------- -``` -Get-SweepRule -Mailbox laura@contoso.com | Remove-SweepRule -``` - -This example removes all Sweep rules in the specified mailbox. - -## PARAMETERS - -### -Identity -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==). - -- Exchange Online: \<mailbox alias\>\\\<RuleId\> (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. - -- On-premises Exchange: \<mailbox canonical name\>\\\<RuleId\> (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. - -```yaml -Type: SweepRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: 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 Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c0b08f89-a570-40d0-a409-5d3e49c1dd99.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-UserPhoto.md b/exchange/exchange-ps/exchange/mailboxes/Remove-UserPhoto.md deleted file mode 100644 index 6c972776db..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-UserPhoto.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UserPhoto -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UserPhoto - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UserPhoto cmdlet to delete the photo associated with a user's account. The user photo feature allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business and SharePoint. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Remove-UserPhoto [-Identity] <MailboxIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-WhatIf] [<CommonParameters>] -``` - -### ClearMailboxPhoto -``` -Remove-UserPhoto [-Identity] <MailboxIdParameter> [-ClearMailboxPhotoRecord] [-GroupMailbox] [-PhotoType <String>] - [-Confirm] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-UserPhoto cmdlet to delete the user photo currently associated with a user's account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox, both of which are deleted when you run this cmdlet. Administrators can also use the Exchange admin center (EAC) to delete user photos by accessing the user's Outlook on the web Options page. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UserPhoto "Ann Beebe" -``` - -This example deletes the photo associated with Ann Beebe's user account. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ClearMailboxPhotoRecord -The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted. - -By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to: - -- Return a blank photo. - -- Prevent searching Active Directory for a photo. - -Using this switch allows photo requests to search Active Directory for a photo. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: ClearMailboxPhoto -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMailbox -The GroupMailbox switch indicates the specified user is an Office 365 Group. 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhotoType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: ClearMailboxPhoto -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/016a380d-435b-4c5a-bd7c-f14c3ab2de98.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md deleted file mode 100644 index d594d8b051..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Online -title: Restore-RecoverableItems -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Restore-RecoverableItems items cmdlet to restore deleted items in the Recoverable Items folder in mailboxes. You use the Get-RecoverableItems cmdlet to find the deleted items to recover. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Restore-RecoverableItems -Identity <GeneralMailboxOrMailUserIdParameter> [-EntryID <String>] [-FilterEndTime <DateTime>] [-FilterItemType <String>] [-FilterStartTime <DateTime>] [-LastParentFolderID <String>] [-ResultSize <Unlimited>] [-SourceFolder <DeletedItems | RecoverableItems>] [-SubjectContains <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Restore-RecoverableItems -Identity laura@contoso.com -FilterItemType IPM.Note -SubjectContains "FY17 Accounting" -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM" -``` - -After using the Get-RecoverableItems cmdlet to verify the existence of the item, this example restores the specified deleted item from the specified mailbox: - -- Mailbox: laura@contoso.com - -- Item type: Email message - -- Message subject: FY17 Accounting - -- Location: Recoverable Items\Deletions - -- Date range: 2/1/2018 to 2/5/2018 - -### -------------------------- Example 2 -------------------------- -``` -$mailboxes = Import-CSV "C:\My Documents\RestoreMessage.csv"; $mailboxes | foreach {Restore-RecoverableItems -Identity $_.SMTPAddress -SubjectContains Project X" -SourceFolder DeletedItems -FilterItemType IPM.Note} -``` - -This example restores the deleted email message "Project X" for the mailboxes that are specified in the comma-separated value (CSV) file C:\\My Documents\\RestoreMessage.csv. The CSV file uses the header value SMTPAddress, and contains the email address of each mailbox on a separate line like this: - -SMTPAddress - -chris@contoso.com - -michelle@contoso.com - -laura@contoso.com - -julia@contoso.com - -The first command reads the CSV file and writes the information to the variable $mailboxes. The second command restores the specified message from the Deleted Items folder in those mailboxes. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that contains the Recoverable Items folder where you want to restore items from. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name>\<account name> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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-ReoverableItems cmdlet (subject, date range, etc.). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterEndTime -The FilterEndTime specifies the end date/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". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterItemType -The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: - -- IPM.Appointment (Meetings and appointments) - -- IPM.Contact - -- IPM.File - -- IPM.Note - -- IPM.Task - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterStartTime -The FilterStartTime specifies the start date/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". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastParentFolderID -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 Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFolder -The SourceFolder parameter specifies the folder in the mailbox to search for deleted items. Valid values are: - -- DeletedItems: The Deleted Items folder. - -- RecoverableItems: Recoverable items that have been deleted from the Deleted Items folder. - -If you don't use this parameter, the command will search both locations. - -```yaml -Type: DeletedItems | RecoverableItems -Parameter Sets: (All) -Aliases: -Accepted values: DeletedItems, RecoverableItems -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectContains -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 Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/Restore-RecoverableItems) diff --git a/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxExportRequest.md b/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxExportRequest.md deleted file mode 100644 index 1abedf3650..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxExportRequest.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-MailboxExportRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Resume-MailboxExportRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Resume-MailboxExportRequest cmdlet to resume an export request that was suspended or failed. - -This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Resume-MailboxExportRequest [-Identity] <MailboxExportRequestIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-MailboxExportRequest -Identity kweku\export -``` - -This example resumes the export request kweku\\export. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxExportRequest -Status Failed | Resume-MailboxExportRequest -``` - -This example resumes any failed export move requests. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \<alias\>\\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 -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dba2880f-ac7c-40d4-8792-1bf30262142e.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxImportRequest.md b/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxImportRequest.md deleted file mode 100644 index d78f75d7eb..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Resume-MailboxImportRequest.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MailboxImportRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Resume-MailboxImportRequest cmdlet to resume an import request that was suspended or failed. - -This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Resume-MailboxImportRequest [-Identity] <MailboxImportRequestIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-MailboxImportRequest -Identity kweku\MailboxImport1 -``` - -This example resumes the second import request for Kweku's mailbox kweku\\MailboxImport1 - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxImportRequest -Status Failed | Resume-MailboxImportRequest -``` - -This example resumes all failed import requests. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \<alias\>\\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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4175a9af-6651-4094-bb6b-ef292d753107.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Search-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Search-Mailbox.md deleted file mode 100644 index 2a7060d31e..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Search-Mailbox.md +++ /dev/null @@ -1,441 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Search-Mailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### EstimateResult -``` -Search-Mailbox [-Identity] <MailboxOrMailUserIdParameter> [-EstimateResultOnly] - [-Confirm] - [-DomainController <Fqdn>] - [-DoNotIncludeArchive] - [-Force] - [-IncludeUnsearchableItems] - [-SearchDumpster] - [-SearchDumpsterOnly] - [-SearchQuery <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Mailbox -``` -Search-Mailbox [-Identity] <MailboxOrMailUserIdParameter> -TargetFolder <String> -TargetMailbox <MailboxIdParameter> - [-Confirm] - [-DeleteContent] - [-DomainController <Fqdn>] - [-DoNotIncludeArchive] - [-Force] - [-IncludeUnsearchableItems] - [-LogLevel <Suppress | Basic | Full>] - [-LogOnly] - [-SearchDumpster] - [-SearchDumpsterOnly] - [-SearchQuery <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Search-Mailbox [-Identity] <MailboxOrMailUserIdParameter> - [-Confirm] - [-DeleteContent] - [-DomainController <Fqdn>] - [-DoNotIncludeArchive] - [-Force] - [-IncludeUnsearchableItems] - [-SearchDumpster] - [-SearchDumpsterOnly] - [-SearchQuery <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Search-Mailbox cmdlet to search messages in a specified mailbox and perform any of the following tasks: - -- Copy messages to a specified target mailbox. - -- Delete messages from the source mailbox. You have to be assigned the Mailbox Import Export management role to delete messages. - -- Perform single item recovery to recover items from a user's Recoverable Items folder. - -- Clean up the Recoverable Items folder for a mailbox when it has reached the Recoverable Items hard quota. - -In Exchange Online, we recommend that you don't use the `Search-Mailbox -DeleteContent` command to delete messages in mailboxes that have auto-expanding archiving enabled. Unexpected data loss may occur. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - - -**Note**: 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 the "Add a role to a role group" section in [Manage role groups](https://technet.microsoft.com/library/jj657480.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Search-Mailbox -Identity "Joe Healy" -SearchQuery "Subject:Project Hamilton" -TargetMailbox "DiscoveryMailbox" -TargetFolder "JoeHealy-ProjectHamilton" -LogLevel Full -``` - -This example searches the mailbox of Joe Healy and copies the search results to the DiscoveryMailbox in the folder JoeHealy-ProjectHamilton. - -### -------------------------- Example 2 -------------------------- -``` -Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -TargetMailbox "administrator" -TargetFolder "SearchAndDeleteLog" -LogOnly -LogLevel Full -``` - -This example searches April Stewart's mailbox for messages that contain the phrase "Your bank statement" in the subject and logs the result in the SearchAndDeleteLog folder in the administrator's mailbox. Messages aren't copied to the target mailbox. - -### -------------------------- Example 3 -------------------------- -``` -Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -DeleteContent -``` - -This example searches April Stewart's mailbox for messages that contain the phrase "Your bank statement" in the subject and deletes the messages from the source mailbox. You have to be assigned the Mailbox Import Export management role to use the DeleteContent switch. - -### -------------------------- Example 4 -------------------------- -``` -Get-Mailbox | Search-Mailbox -SearchQuery 'election OR candidate OR vote' -TargetMailbox "Discovery Search Mailbox" -TargetFolder "AllMailboxes-Election" -LogLevel Full -``` - -This example searches all mailboxes in your organization for messages that contain the words "election", "candidate", or "vote". The search results are copied to the Discovery Search Mailbox in the folder AllMailboxes-Election. - -## PARAMETERS - -### -EstimateResultOnly -The EstimateResultOnly switch specifies that only an estimate of the total number and size of messages returned by the search be provided. Messages aren't copied to the target mailbox. You can't use this switch with the TargetMailbox parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: EstimateResult -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the mailbox to search. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetFolder -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, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetMailbox -The TargetMailbox parameter specifies the identity of the destination mailbox where search results are copied. You can use the following values: - -- Alias - -- Display name - -- Domain\\Account - -- SMTP address - -- DN - -- Object GUID - -- UPN - -- LegacyExchangeDN - -When you specify a value for the TargetMailbox parameter, you must also specify the TargetFolder parameter. You can't use this parameter with the EstimateResultOnly switch. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DeleteContent -The DeleteContent switch specifies that the messages returned by the search be permanently deleted from the source mailbox. When used with the TargetMailbox parameter, messages are copied to the target mailbox and removed from the source mailbox. If you set the logging level for the search to Basic or Full, you must specify a target mailbox and a target folder to place the log in. To delete messages from the source mailbox without copying them to the target mailbox, don't specify the TargetMailbox, TargetFolder, and LogLevel parameters. - -As previously stated, we recommend that you don't use the DeleteContent switch to delete messages in Exchange Online mailboxes that have auto-expanding archiving enabled because unexpected data loss may occur. - -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. Typically, you assign a role to a built-in or custom role group. Or you can assign a role to a user, or a universal security group. - -Before you use the DeleteContent switch to delete content, we recommend that you test search parameters by using the LogOnly parameter, as shown in Example 2. - -```yaml -Type: SwitchParameter -Parameter Sets: Mailbox, Identity -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotIncludeArchive -The DoNotIncludeArchive switch specifies that the user's archive mailbox shouldn't be included in the search. You don't need to specify a value for this switch. By default, the archive mailbox is always searched. - -If auto-expanding archiving is enabled for an Exchange Online mailbox, only the user's primary archive mailbox is searched. Auxiliary archive mailboxes aren't included in the search. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch overrides the confirmation prompt displayed when your use the DeleteContent switch to permanently delete messages. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUnsearchableItems -The IncludeUnsearchableItems switch specifies whether to include items that couldn't be indexed by Exchange Search. When set to $true, the IncludeUnsearchableItems switch specifies that items that couldn't be indexed by Exchange Search should be included in the search results. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -The LogLevel parameter specifies the logging level for the search. It can have one of the following values: - -- Suppress: No logs are kept. - -- Basic: Basic information about the query and who ran it is kept. - -- Full: In addition to the information kept by the Basic log level, the Full log level adds a complete list of search results. - -The default log level is Basic. - -```yaml -Type: Suppress | Basic | Full -Parameter Sets: Mailbox -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 -``` - -### -LogOnly -The LogOnly switch specifies that a search be performed and only a log be generated. Messages returned by the search aren't copied to the target mailbox. The logging level is specified by using the LogLevel parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchDumpster -The SearchDumpster parameter specifies whether to search the Recoverable Items folder, which is the storage location in which items deleted from the Deleted Items folder or hard-deleted items are stored until they're purged from the mailbox database. By default, the Recoverable Items folder is always searched. To exclude the folder from the search, set the SearchDumpster switch to $false, for example,-SearchDumpster:$false - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchDumpsterOnly -The SearchDumpsterOnly switch specifies that only the Recoverable Items folder of the specified mailbox be searched. You can also use this switch with the DeleteContent switch to delete messages from the Recoverable Items folder and reduce the size of the folder. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchQuery -The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more information about KQL in Exchange, see Message properties and search operators for In-Place eDiscovery(https://docs.microsoft.com/exchange/security-and-compliance/in-place-ediscovery/message-properties-and-search-operators). - -If this parameter is empty, all messages are returned. - -**Note**: The Search-Mailbox cmdlet returns up to 10000 results per mailbox if a search query is 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9ee3b02c-d343-4816-a583-a90b1fad4b26.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-CalendarNotification.md b/exchange/exchange-ps/exchange/mailboxes/Set-CalendarNotification.md deleted file mode 100644 index 111c3c51b4..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-CalendarNotification.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-CalendarNotification -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-CalendarNotification - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-CalendarNotification cmdlet to set text message notifications for calendar events for a user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-CalendarNotification [-Identity] <MailboxIdParameter> [-CalendarUpdateNotification <$true | $false>] - [-CalendarUpdateSendDuringWorkHour <$true | $false>] [-Confirm] [-DailyAgendaNotification <$true | $false>] - [-DailyAgendaNotificationSendTime <TimeSpan>] [-DomainController <Fqdn>] [-IgnoreDefaultScope] - [-MeetingReminderNotification <$true | $false>] [-MeetingReminderSendDuringWorkHour <$true | $false>] - [-NextDays <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Users can receive text message notifications of changes to calendar events and daily agendas. Use the Set-CalendarNotification cmdlet to configure these notifications for a 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CalendarNotification -Identity "tony@contoso.com" -CalendarUpdateNotification $true -``` - -This example enables calendar updates to be sent in text messages to the user Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -Set-CalendarNotification -Identity "TonySmith" -CalendarUpdateNotification $true -MeetingReminderNotification $true -MeetingReminderSendDuringWorkHour $true -``` - -This example enables calendar updates and meeting reminders to be sent in text messages to the user Tony Smith. - -### -------------------------- Example 3 -------------------------- -``` -Set-CalendarNotification -Identity contoso\tonysmith -DailyAgendaNotification $true -``` - -This example enables a daily agenda to be sent in text messages to the user Tony Smith. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox ID for the user. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CalendarUpdateNotification -The CalendarUpdateNotification parameter specifies whether calendar notifications are enabled for the user. - -```yaml -Type: $true | $false -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 -``` - -### -CalendarUpdateSendDuringWorkHour -The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar notifications are sent during working hours. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DailyAgendaNotification -The DailyAgendaNotification parameter specifies whether a daily agenda should be sent to the user's mobile phone. - -```yaml -Type: $true | $false -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 -``` - -### -DailyAgendaNotificationSendTime -The DailyAgendaNotificationSendTime parameter specifies the time to send the daily agenda. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -For example, a time span of 2 days and 8 hours is shown: 02.08:00:00. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope parameter isn't implemented yet. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingReminderNotification -The MeetingReminderNotification parameter specifies whether meeting reminders are sent to the user's mobile phone. - -```yaml -Type: $true | $false -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 -``` - -### -MeetingReminderSendDuringWorkHour -The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminders are only sent during working hours. - -```yaml -Type: $true | $false -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 -``` - -### -NextDays -The NextDays parameter specifies how many days should be sent in the daily agenda. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fc595e4d-abaa-450e-8803-6982b8a039ac.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/mailboxes/Set-CalendarProcessing.md deleted file mode 100644 index 90a6a9f109..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-CalendarProcessing.md +++ /dev/null @@ -1,861 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-CalendarProcessing -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-CalendarProcessing cmdlet to modify calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant, and calendar configuration. Note that this cmdlet is effective only on resource mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-CalendarProcessing [-Identity] <MailboxIdParameter> [-AddAdditionalResponse <$true | $false>] - [-AdditionalResponse <String>] [-AddNewRequestsTentatively <$true | $false>] - [-AddOrganizerToSubject <$true | $false>] [-AllBookInPolicy <$true | $false>] - [-AllowConflicts <$true | $false>] [-AllowRecurringMeetings <$true | $false>] - [-AllRequestInPolicy <$true | $false>] [-AllRequestOutOfPolicy <$true | $false>] - [-AutomateProcessing <None | AutoUpdate | AutoAccept>] [-BookingType <Standard | Reserved>] [-BookingWindowInDays <Int32>] - [-BookInPolicy <RecipientIdParameter[]>] [-Confirm] [-ConflictPercentageAllowed <Int32>] - [-DeleteAttachments <$true | $false>] [-DeleteComments <$true | $false>] - [-DeleteNonCalendarItems <$true | $false>] [-DeleteSubject <$true | $false>] [-DomainController <Fqdn>] - [-EnableResponseDetails <$true | $false>] [-EnforceSchedulingHorizon <$true | $false>] - [-ForwardRequestsToDelegates <$true | $false>] [-IgnoreDefaultScope] [-MaximumConflictInstances <Int32>] - [-MaximumDurationInMinutes <Int32>] [-OrganizerInfo <$true | $false>] - [-ProcessExternalMeetingMessages <$true | $false>] [-RemoveForwardedMeetingNotifications <$true | $false>] - [-RemoveOldMeetingMessages <$true | $false>] [-RemovePrivateProperty <$true | $false>] - [-RequestInPolicy <RecipientIdParameter[]>] [-RequestOutOfPolicy <RecipientIdParameter[]>] - [-ResourceDelegates <RecipientIdParameter[]>] [-ScheduleOnlyDuringWorkHours <$true | $false>] - [-TentativePendingApproval <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CalendarProcessing -Identity "Conf 212" -AutomateProcessing AutoAccept -DeleteComments $true -AddOrganizerToSubject $true -AllowConflicts $false -``` - -This example automates the processing of calendar requests to the resource mailbox Conf 212. - -### -------------------------- Example 2 -------------------------- -``` -Set-CalendarProcessing -Identity "Car 53" -AutomateProcessing None -``` - -This example disables automatic processing for the resource mailbox Car 53. - -### -------------------------- Example 3 -------------------------- -``` -Set-CalendarProcessing -Identity "5th Floor Conference Room" -AutomateProcessing AutoAccept -AllBookInPolicy $true -``` - -This example allows the Calendar Attendant to approve in-policy requests from all users. - -### -------------------------- Example 4 -------------------------- -``` -Set-CalendarProcessing -Identity "5th Floor Conference Room" -AutomateProcessing AutoAccept -AllRequestInPolicy $true -AllBookInPolicy $false -ResourceDelegates "chris@contoso.com","michelle@contoso.com" -``` - -This example allows all users to submit in-policy requests, but the request is still subject to approval by one of the specified delegates. - -### -------------------------- Example 5 -------------------------- -``` -Set-CalendarProcessing -Identity "Room 221" -AutomateProcessing AutoAccept -RequestOutOfPolicy DavidPelton@contoso.com -ResourceDelegates "chris@contoso.com","michelle@contoso.com" -``` - -This example allows the Calendar Attendant to accept out-of-policy requests from David Pelton. The request is still subject to approval by one of the specified delegates. - -### -------------------------- Example 6 -------------------------- -``` -Set-CalendarProcessing -Identity "Car 53" -AutomateProcessing AutoAccept -BookInPolicy "ayla@contoso.com","tony@contoso.com" -AllBookInPolicy $false -``` - -This example allows a list of users to submit in-policy meeting requests to the equipment mailbox for Car 53. - -### -------------------------- Example 7 -------------------------- -``` -Set-CalendarProcessing -Identity "Room 221" -ProcessExternalMeetingMessages $false -``` - -This example rejects meeting requests from any user who isn't a member of the Exchange organization. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddAdditionalResponse -The AddAdditionalResponse parameter specifies whether additional information would be sent from the resource mailbox when responding to meeting requests. Valid input for this parameter is $true or $false. The default value is $false. - -This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. - -```yaml -Type: $true | $false -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 -``` - -### -AdditionalResponse -The AdditionalResponse parameter specifies the additional information to be included in responses to meeting requests. This parameter is meaningful only when the AddAdditionalResponse parameter is set to $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddNewRequestsTentatively -The AddNewRequestsTentatively parameter specifies whether to have the Calendar Attendant put new calendar items tentatively on the calendar. If the AddNewRequestsTentatively parameter is set to $false, only existing calendar items are updated by the Calendar Attendant - -Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -AddOrganizerToSubject -The AddOrganizerToSubject parameter specifies whether the meeting organizer's name is used as the subject of the meeting request. Valid input for this parameter is $true or $false. The default value is $true. - -This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. - -```yaml -Type: $true | $false -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 -``` - -### -AllBookInPolicy -The AllBookInPolicy parameter specifies whether to automatically approve in-policy requests from all users. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -AllowConflicts -The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowRecurringMeetings -The AllowRecurringMeetings parameter specifies whether to allow recurring meetings. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -AllRequestInPolicy -The AllRequestInPolicy parameter specifies whether to allow all users to submit in-policy requests. Valid input for this parameter is $true or $false. The default value is $false. - -These requests are subject to approval by a resource mailbox delegate unless the AllBookInPolicy parameter is set to $true. - -```yaml -Type: $true | $false -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 -``` - -### -AllRequestOutOfPolicy -The AllRequestOutOfPolicy parameter specifies whether to allow all users to submit out-of-policy requests. Valid input for this parameter is $true or $false. The default value is $false. - -Out-of-policy requests are subject to approval by a resource mailbox delegate. - -```yaml -Type: $true | $false -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 -``` - -### -AutomateProcessing -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. - -- AutoUpdate: Only the Calendar Attendant processes meeting requests and responses. Meeting requests are tentative in the calendar until they're approved by a delegate. Meeting organizers receive only decisions from delegates. - -- AutoAccept: Both the Calendar Attendant and resource booking attendant are enabled on the mailbox. This means that the Calendar Attendant updates the calendar, and then the resource booking assistant accepts the meeting based upon the policies. Eligible meeting organizers receive the decision directly without human intervention (free = accept; busy = decline). - -In on-premises Exchange, resource mailboxes created in the Exchange admin center (EAC) have the default value AutoAccept, while resource mailboxes created in PowerShell have the default value AutoUpdate. - -In Exchange Online, resource mailbox created in the EAC and resource mailboxes created in PowerShell after November 15, 2018 have the default value AutoAccept. Resource mailboxes created in PowerShell before November 15 have the default value AutoUpdate. - -The default value for user mailboxes is AutoUpdate, but you can't change the value on a user mailbox. - -```yaml -Type: None | AutoUpdate | AutoAccept -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 -``` - -### -BookingType -Description of this parameter - -```yaml -Type: -Parameter Sets: () -Aliases: -Applicable: -Required: -Position: -Default value: -Accept pipeline input: -Accept wildcard characters: -``` - -### -BookingWindowInDays -The BookingWindowInDays parameter specifies the maximum number of days in advance that the resource can be reserved. Valid input 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookInPolicy -The BookInPolicy parameter specifies a comma-separated list of users who are allowed to submit in-policy meeting requests to the resource mailbox. Any in-policy meeting requests from these users are automatically approved. - -You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -ConflictPercentageAllowed -The ConflictPercentageAllowed parameter specifies the maximum percentage of meeting conflicts for new recurring meeting requests. Valid input for this parameter 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteAttachments -The DeleteAttachments parameter specifies whether to remove attachments from all incoming messages. Valid input for this parameter is $true or $false. The default value is $true. - -This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. - -```yaml -Type: $true | $false -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 -``` - -### -DeleteComments -The DeleteComments parameter specifies whether to remove or keep any text in the message body of incoming meeting requests. - -Valid input for this parameter is $true or $false. - -This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. - -```yaml -Type: $true | $false -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 -``` - -### -DeleteNonCalendarItems -The DeleteNonCalendarItems parameter specifies whether to remove or keep all non-calendar items received by the resource mailbox. Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -DeleteSubject -The DeleteSubject parameter specifies whether to remove or keep the subject of incoming meeting requests. Valid input for this parameter is $true or $false. The default value is $true. - -This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. - -```yaml -Type: $true | $false -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableResponseDetails -The EnableResponseDetails parameter specifies whether to include the reasons for accepting or declining a meeting in the response email message. Valid input for this parameter is $true or $false. The default value is $true. - -By default, the reasons for accepting or declining a meeting in the response email message are included. - -```yaml -Type: $true | $false -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 -``` - -### -EnforceSchedulingHorizon -The EnforceSchedulingHorizon parameter controls the behavior of recurring meetings that extend beyond the date specified by the BookingWindowInDays parameter. - -Valid values for this parameter 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. - -- $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. - -The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -ForwardRequestsToDelegates -The ForwardRequestsToDelegates parameter specifies whether to forward incoming meeting requests to the delegates defined for the resource mailbox. - -Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumConflictInstances -The MaximumConflictInstances parameter specifies the maximum number of conflicts for new recurring meeting requests when the AllowRecurringMeetings parameter is set to $true. Valid input for this parameter 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumDurationInMinutes -The MaximumDurationInMinutes parameter specifies the maximum duration in minutes for meeting requests. Valid input for this parameter 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizerInfo -The OrganizerInfo parameter specifies whether to have mailboxes send organizer information when a meeting request is declined because of conflicts. - -Valid input for this parameter is $true or $false. The default value is $true. - -By default, resource mailboxes send organizer information when a meeting request is declined because of conflicts. - -```yaml -Type: $true | $false -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 -``` - -### -ProcessExternalMeetingMessages -The ProcessExternalMeetingMessages parameter specifies whether to process meeting requests that originate outside the Exchange organization. Valid input for this parameter is $true or $false. The default value is $false. - -By default, meeting requests that originate outside of the organization are rejected. - -```yaml -Type: $true | $false -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 -``` - -### -RemoveForwardedMeetingNotifications -The RemoveForwardedMeetingNotifications parameter specifies whether forwarded meeting notifications are moved to the Deleted Items folder after they're processed by the Calendar Attendant. - -Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -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 -``` - -### -RemoveOldMeetingMessages -The RemoveOldMeetingMessages parameter specifies whether the Calendar Attendant removes old and redundant updates and responses. - -Valid input for this parameter is $true or $false. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -RemovePrivateProperty -The RemovePrivateProperty parameter specifies whether to clear the private flag for incoming meeting requests. Valid input for this parameter is $true or $false. The default value is $true. - -By default, the private flag for incoming meeting requests is cleared. To ensure the private flag that was sent by the organizer in the original request remains as specified, set tthis parameter to $false. - -```yaml -Type: $true | $false -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 -``` - -### -RequestInPolicy -The RequestInPolicy parameter specifies a comma-separated list of users who are allowed to submit in-policy meeting requests to the resource mailbox. All in-policy meeting requests from these users are subject to approval by a resource mailbox delegate. - -You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestOutOfPolicy -The RequestOutOfPolicy parameter specifies a comma-separated list of users who are allowed to submit out-of-policy requests. - -You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -Out-of-policy requests are subject to approval by a resource mailbox delegate. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceDelegates -The ResourceDelegates parameter specifies a comma-separated list of users who are resource mailbox delegates. Resource mailbox delegates can approve or reject requests sent to the resource mailbox. - -You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleOnlyDuringWorkHours -The ScheduleOnlyDuringWorkHours parameter specifies whether to allow meetings to be scheduled outside of the working hours that are defined for the resource mailbox. - -Valid input for this parameter is $true or $false. The default value is $false. - -If set to $true, meeting requests for times outside the working hours of the resource mailbox will be rejected. - -You configure the working hours of the resource mailbox by using the WorkDays, WorkingHoursStartTime, WorkingHoursEndTime and WorkingHoursTimeZone parameters on the Set-MailboxCalendarConfiguration cmdlet. - -```yaml -Type: $true | $false -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 -``` - -### -TentativePendingApproval -The TentativePendingApproval parameter specifies whether to mark pending requests as tentative on the calendar. Valid input for this parameter is $true or $false. The default value is $true. - -If set to $false, pending requests are marked as free. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/000bc90f-1d00-4384-ab59-d6cf6f674825.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-Clutter.md b/exchange/exchange-ps/exchange/mailboxes/Set-Clutter.md deleted file mode 100644 index 58700fb8ac..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-Clutter.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -applicable: Exchange Online -title: Set-Clutter -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-Clutter - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-Clutter cmdlet to configure Clutter settings for mailboxes in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-Clutter -Identity <MailboxIdParameter> [-Enable <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-Clutter -Identity "Alexander Martinez" -Enable $false -``` - -This example disables Clutter for the user Alexander Martinez. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name>\\\<account name> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -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. - -- $false: Clutter is disabled for the mailbox. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/0c91b858-5bbe-4d2f-abff-d1503bcd6864.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-FocusedInbox.md b/exchange/exchange-ps/exchange/mailboxes/Set-FocusedInbox.md deleted file mode 100644 index 09558d311e..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-FocusedInbox.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -applicable: Exchange Online -title: Set-FocusedInbox -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-FocusedInbox - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-FocusedInbox cmdlet to enable or disable Focused Inbox for mailboxes in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-FocusedInbox -Identity <MailboxIdParameter> [-FocusedInboxOn <$true | $false>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-FocusedInbox -Identity laura@contoso.com -FocusedInboxOn $false -``` - -This example disables Focused Inbox for the mailbox of laura@contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name>\\\<account name> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FocusedInboxOn -The FocusedInboxOn parameter enables or disables Focused Inbox for the mailbox. Valid values are: - -- $true: Focused Inbox is enabled. This is the default value. - -- $false: Focused Inbox is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online version](https://technet.microsoft.com/library/29f40631-f393-47ec-8081-464aacb1eb14.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md deleted file mode 100644 index 3b45c0edda..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md +++ /dev/null @@ -1,5124 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-Mailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-Mailbox cmdlet to modify the settings of existing mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity (Default) -``` -Set-Mailbox [-Identity] <MailboxIdParameter> - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccountDisabled <$true | $false>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-AntispamBypassEnabled <$true | $false>] - [-ApplyMandatoryProperties] - [-Arbitration] - [-ArbitrationMailbox <MailboxIdParameter>] - [-ArchiveDatabase <DatabaseIdParameter>] - [-ArchiveDomain <SmtpDomain>] - [-ArchiveName <MultiValuedProperty>] - [-ArchiveQuota <Unlimited>] - [-ArchiveStatus <None | Active>] - [-ArchiveWarningQuota <Unlimited>] - [-AttributesToClear <SetMailbox+ClearableADAttributes[]>] - [-AuditAdmin <MultiValuedProperty>] - [-AuditDelegate <MultiValuedProperty>] - [-AuditEnabled <$true | $false>] - [-AuditLog] - [-AuditLogAgeLimit <EnhancedTimeSpan>] - [-AuditOwner <MultiValuedProperty>] - [-AuxAuditLog] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-CalendarLoggingQuota <Unlimited>] - [-CalendarRepairDisabled <$true | $false>] - [-CalendarVersionStoreDisabled <$true | $false>] - [-ClientExtensions <$true | $false>] - [-Confirm] - [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-Database <DatabaseIdParameter>] - [-DefaultPublicFolderMailbox <RecipientIdParameter>] - [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-DowngradeHighPriorityMessagesEnabled <$true | $false>] - [-DumpsterMessagesPerFolderCountReceiveQuota <Int32>] - [-DumpsterMessagesPerFolderCountWarningQuota <Int32>] - [-EmailAddresses <ProxyAddressCollection>] - [-EmailAddressPolicyEnabled <$true | $false>] - [-EnableRoomMailboxAccount <$true | $false>] - [-EndDateForRetentionHold <DateTime>] - [-ExtendedPropertiesCountQuota <Int32>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ExternalOofOptions <InternalOnly | External>] - [-FolderHierarchyChildrenCountReceiveQuota <Int32>] - [-FolderHierarchyChildrenCountWarningQuota <Int32>] - [-FolderHierarchyDepthReceiveQuota <Int32>] - [-FolderHierarchyDepthWarningQuota <Int32>] - [-FoldersCountReceiveQuota <Int32>] - [-FoldersCountWarningQuota <Int32>] - [-Force] - [-ForwardingAddress <RecipientIdParameter>] - [-ForwardingSmtpAddress <ProxyAddress>] - [-GMGen <$true | $false>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-IgnoreDefaultScope] - [-ImListMigrationCompleted <$true | $false>] - [-ImmutableId <String>] - [-IsExcludedFromServingHierarchy <$true | $false>] - [-IsHierarchyReady <$true | $false>] - [-IsHierarchySyncEnabled <$true | $false>] - [-IssueWarningQuota <Unlimited>] - [-Languages <MultiValuedProperty>] - [-LinkedCredential <PSCredential>] - [-LinkedDomainController <String>] - [-LinkedMasterAccount <UserIdParameter>] - [-LitigationHoldDate <DateTime>] - [-LitigationHoldDuration <Unlimited>] - [-LitigationHoldEnabled <$true | $false>] - [-LitigationHoldOwner <String>] - [-MailboxMessagesPerFolderCountReceiveQuota <Int32>] - [-MailboxMessagesPerFolderCountWarningQuota <Int32>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] - [-ManagedFolderMailboxPolicyAllowed] - [-Management <$true | $false>] - [-MaxBlockedSenders <Int32>] - [-MaxReceiveSize <Unlimited>] - [-MaxSafeSenders <Int32>] - [-MaxSendSize <Unlimited>] - [-MessageCopyForSendOnBehalfEnabled <$true | $false>] - [-MessageCopyForSentAsEnabled <$true | $false>] - [-MessageTracking <$true | $false>] - [-MessageTrackingReadStatusEnabled <$true | $false>] - [-Migration <$true | $false>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-NewPassword <SecureString>] - [-OABGen <$true | $false>] - [-Office <String>] - [-OfflineAddressBook <OfflineAddressBookIdParameter>] - [-OldPassword <SecureString>] - [-OMEncryption <$true | $false>] - [-OMEncryptionStore <$true | $false>] - [-Password <SecureString>] - [-PrimarySmtpAddress <SmtpAddress>] - [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] - [-PstProvider <$true | $false>] - [-PublicFolder] - [-QueryBaseDN <OrganizationalUnitIdParameter>] - [-RecipientLimits <Unlimited>] - [-RecoverableItemsQuota <Unlimited>] - [-RecoverableItemsWarningQuota <Unlimited>] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RemoteRecipientType <None | ProvisionMailbox | ProvisionArchive | Migrated | DeprovisionMailbox | DeprovisionArchive | RoomMailbox | EquipmentMailbox | SharedMailbox>] - [-RemoveManagedFolderAndPolicy] - [-RemovePicture] - [-RemoveSpokenName] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResetPasswordOnNextLogon <$true | $false>] - [-ResourceCapacity <Int32>] - [-ResourceCustom <MultiValuedProperty>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] - [-RetainDeletedItemsUntilBackup <$true | $false>] - [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RetentionUrl <String>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-RoomMailboxPassword <SecureString>] - [-RulesQuota <ByteQuantifiedSize>] - [-SamAccountName <String>] - [-SCLDeleteEnabled <$true | $false>] - [-SCLDeleteThreshold <Int32>] - [-SCLJunkEnabled <$true | $false>] - [-SCLJunkThreshold <Int32>] - [-SCLQuarantineEnabled <$true | $false>] - [-SCLQuarantineThreshold <Int32>] - [-SCLRejectEnabled <$true | $false>] - [-SCLRejectThreshold <Int32>] - [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SimpleDisplayName <String>] - [-SingleItemRecoveryEnabled <$true | $false>] - [-StartDateForRetentionHold <DateTime>] - [-StsRefreshTokensValidFrom <DateTime>] - [-SystemMessageSizeShutoffQuota <Int64>] - [-SystemMessageSizeWarningQuota <Int64>] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] - [-Type <Regular | Room | Equipment | Shared>] - [-UMDataStorage <$true | $false>] - [-UMDtmfMap <MultiValuedProperty>] - [-UMGrammar <$true | $false>] - [-UseDatabaseQuotaDefaults <$true | $false>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-UserCertificate <MultiValuedProperty>] - [-UserPrincipalName <String>] - [-UserSMimeCertificate <MultiValuedProperty>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -### RecalculateInactiveMailbox -``` -Set-Mailbox [-Identity] <MailboxIdParameter> [-RecalculateInactiveMailbox] - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccountDisabled <$true | $false>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ApplyMandatoryProperties] - [-ArchiveName <MultiValuedProperty>] - [-AuditAdmin <MultiValuedProperty>] - [-AuditDelegate <MultiValuedProperty>] - [-AuditEnabled <$true | $false>] - [-AuditLogAgeLimit <EnhancedTimeSpan>] - [-AuditOwner <MultiValuedProperty>] - [-AuxAuditLog] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-CalendarRepairDisabled <$true | $false>] - [-CalendarVersionStoreDisabled <$true | $false>] - [-Confirm] - [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DefaultPublicFolderMailbox <RecipientIdParameter>] - [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] - [-ElcProcessingDisabled <$true | $false>] - [-EmailAddresses <ProxyAddressCollection>] - [-EnableRoomMailboxAccount <$true | $false>] - [-EndDateForRetentionHold <DateTime>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ExternalOofOptions <InternalOnly | External>] - [-Force] - [-ForwardingAddress <RecipientIdParameter>] - [-ForwardingSmtpAddress <ProxyAddress>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-ImListMigrationCompleted <$true | $false>] - [-ImmutableId <String>] - [-InactiveMailbox] - [-IsExcludedFromServingHierarchy <$true | $false>] - [-IssueWarningQuota <Unlimited>] - [-JournalArchiveAddress <SmtpAddress>] - [-Languages <MultiValuedProperty>] - [-LitigationHoldDate <DateTime>] - [-LitigationHoldDuration <Unlimited>] - [-LitigationHoldEnabled <$true | $false>] - [-LitigationHoldOwner <String>] - [-MailboxRegion <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-MaxReceiveSize <Unlimited>] - [-MaxSendSize <Unlimited>] - [-MessageCopyForSendOnBehalfEnabled <$true | $false>] - [-MessageCopyForSentAsEnabled <$true | $false>] - [-MessageTracking <$true | $false>] - [-MessageTrackingReadStatusEnabled <$true | $false>] - [-MicrosoftOnlineServicesID <SmtpAddress>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-Office <String>] - [-Password <SecureString>] - [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] - [-ProvisionedForOfficeGraph] - [-PublicFolder] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResourceCapacity <Int32>] - [-ResourceCustom <MultiValuedProperty>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] - [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RetentionUrl <String>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-RoomMailboxPassword <SecureString>] - [-RulesQuota <ByteQuantifiedSize>] - [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SimpleDisplayName <String>] - [-SingleItemRecoveryEnabled <$true | $false>] - [-SkipDualWrite] - [-StartDateForRetentionHold <DateTime>] - [-Type <Regular | Room | Equipment | Shared>] - [-UMDtmfMap <MultiValuedProperty>] - [-UseDatabaseQuotaDefaults <$true | $false>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-UserCertificate <MultiValuedProperty>] - [-UserSMimeCertificate <MultiValuedProperty>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -### RemoveDelayHoldApplied -``` -Set-Mailbox [-Identity] <MailboxIdParameter> [-RemoveDelayHoldApplied] - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccountDisabled <$true | $false>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ApplyMandatoryProperties] - [-ArchiveName <MultiValuedProperty>] - [-AuditAdmin <MultiValuedProperty>] - [-AuditDelegate <MultiValuedProperty>] - [-AuditEnabled <$true | $false>] - [-AuditLogAgeLimit <EnhancedTimeSpan>] - [-AuditOwner <MultiValuedProperty>] - [-AuxAuditLog] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-CalendarRepairDisabled <$true | $false>] - [-CalendarVersionStoreDisabled <$true | $false>] - [-Confirm] - [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DefaultPublicFolderMailbox <RecipientIdParameter>] - [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] - [-ElcProcessingDisabled <$true | $false>] - [-EmailAddresses <ProxyAddressCollection>] - [-EnableRoomMailboxAccount <$true | $false>] - [-EndDateForRetentionHold <DateTime>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ExternalOofOptions <InternalOnly | External>] - [-Force] - [-ForwardingAddress <RecipientIdParameter>] - [-ForwardingSmtpAddress <ProxyAddress>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-ImListMigrationCompleted <$true | $false>] - [-ImmutableId <String>] - [-InactiveMailbox] - [-IsExcludedFromServingHierarchy <$true | $false>] - [-IssueWarningQuota <Unlimited>] - [-JournalArchiveAddress <SmtpAddress>] - [-Languages <MultiValuedProperty>] - [-LitigationHoldDate <DateTime>] - [-LitigationHoldDuration <Unlimited>] - [-LitigationHoldEnabled <$true | $false>] - [-LitigationHoldOwner <String>] - [-MailboxRegion <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-MaxReceiveSize <Unlimited>] - [-MaxSendSize <Unlimited>] - [-MessageCopyForSendOnBehalfEnabled <$true | $false>] - [-MessageCopyForSentAsEnabled <$true | $false>] - [-MessageTracking <$true | $false>] - [-MessageTrackingReadStatusEnabled <$true | $false>] - [-MicrosoftOnlineServicesID <SmtpAddress>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-Office <String>] - [-Password <SecureString>] - [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] - [-ProvisionedForOfficeGraph] - [-PublicFolder] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResourceCapacity <Int32>] - [-ResourceCustom <MultiValuedProperty>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] - [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RetentionUrl <String>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-RoomMailboxPassword <SecureString>] - [-RulesQuota <ByteQuantifiedSize>] - [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SimpleDisplayName <String>] - [-SingleItemRecoveryEnabled <$true | $false>] - [-SkipDualWrite] - [-StartDateForRetentionHold <DateTime>] - [-Type <Regular | Room | Equipment | Shared>] - [-UMDtmfMap <MultiValuedProperty>] - [-UseDatabaseQuotaDefaults <$true | $false>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-UserCertificate <MultiValuedProperty>] - [-UserSMimeCertificate <MultiValuedProperty>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -### RemoveDisabledArchive -``` -Set-Mailbox [-Identity] <MailboxIdParameter> [-RemoveDisabledArchive] - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccountDisabled <$true | $false>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ApplyMandatoryProperties] - [-ArchiveName <MultiValuedProperty>] - [-AuditAdmin <MultiValuedProperty>] - [-AuditDelegate <MultiValuedProperty>] - [-AuditEnabled <$true | $false>] - [-AuditLogAgeLimit <EnhancedTimeSpan>] - [-AuditOwner <MultiValuedProperty>] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-CalendarRepairDisabled <$true | $false>] - [-CalendarVersionStoreDisabled <$true | $false>] - [-Confirm] - [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DefaultPublicFolderMailbox <RecipientIdParameter>] - [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] - [-ElcProcessingDisabled <$true | $false>] - [-EmailAddresses <ProxyAddressCollection>] - [-EnableRoomMailboxAccount <$true | $false>] - [-EndDateForRetentionHold <DateTime>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ExternalOofOptions <ExternalOofOptions>] - [-Force] - [-ForwardingAddress <RecipientIdParameter>] - [-ForwardingSmtpAddress <ProxyAddress>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-ImListMigrationCompleted <$true | $false>] - [-ImmutableId <String>] - [-InactiveMailbox] - [-IsExcludedFromServingHierarchy <$true | $false>] - [-IssueWarningQuota <Unlimited>] - [-JournalArchiveAddress <SmtpAddress>] - [-Languages <MultiValuedProperty>] - [-LitigationHoldDate <DateTime>] - [-LitigationHoldDuration <Unlimited>] - [-LitigationHoldEnabled <$true | $false>] - [-LitigationHoldOwner <String>] - [-MailboxRegion <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-MaxReceiveSize <Unlimited>] - [-MaxSendSize <Unlimited>] - [-MessageCopyForSendOnBehalfEnabled <$true | $false>] - [-MessageCopyForSentAsEnabled <$true | $false>] - [-MessageTrackingReadStatusEnabled <$true | $false>] - [-MicrosoftOnlineServicesID <SmtpAddress>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-Office <String>] - [-Password <SecureString>] - [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] - [-ProvisionedForOfficeGraph] - [-PublicFolder] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResourceCapacity <Int32>] - [-ResourceCustom <MultiValuedProperty>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] - [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RetentionUrl <String>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-RoomMailboxPassword <SecureString>] - [-RulesQuota <ByteQuantifiedSize>] - [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <TransportModerationNotificationFlags>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SimpleDisplayName <String>] - [-SingleItemRecoveryEnabled <$true | $false>] - [-SkipDualWrite] - [-StartDateForRetentionHold <DateTime>] - [-StsRefreshTokensValidFrom <DateTime>] - [-Type <ConvertibleMailboxSubType>] - [-UMDtmfMap <MultiValuedProperty>] - [-UseDatabaseQuotaDefaults <Boolean>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-UserCertificate <MultiValuedProperty>] - [-UserSMimeCertificate <MultiValuedProperty>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -### ExcludeFromAllOrgHolds -``` -Set-Mailbox [-Identity] <MailboxIdParameter> [-ExcludeFromAllOrgHolds] - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccountDisabled <$true | $false>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ApplyMandatoryProperties] - [-ArchiveName <MultiValuedProperty>] - [-AuditAdmin <MultiValuedProperty>] - [-AuditDelegate <MultiValuedProperty>] - [-AuditEnabled <$true | $false>] - [-AuditLogAgeLimit <EnhancedTimeSpan>] - [-AuditOwner <MultiValuedProperty>] - [-AuxAuditLog] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-CalendarRepairDisabled <$true | $false>] - [-CalendarVersionStoreDisabled <$true | $false>] - [-Confirm] - [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DefaultPublicFolderMailbox <RecipientIdParameter>] - [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] - [-ElcProcessingDisabled <$true | $false>] - [-EmailAddresses <ProxyAddressCollection>] - [-EnableRoomMailboxAccount <$true | $false>] - [-EndDateForRetentionHold <DateTime>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ExternalOofOptions <InternalOnly | External>] - [-Force] - [-ForwardingAddress <RecipientIdParameter>] - [-ForwardingSmtpAddress <ProxyAddress>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-ImListMigrationCompleted <$true | $false>] - [-ImmutableId <String>] - [-InactiveMailbox] - [-IsExcludedFromServingHierarchy <$true | $false>] - [-IssueWarningQuota <Unlimited>] - [-JournalArchiveAddress <SmtpAddress>] - [-Languages <MultiValuedProperty>] - [-LitigationHoldDate <DateTime>] - [-LitigationHoldDuration <Unlimited>] - [-LitigationHoldEnabled <$true | $false>] - [-LitigationHoldOwner <String>] - [-MailboxRegion <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-MaxReceiveSize <Unlimited>] - [-MaxSendSize <Unlimited>] - [-MessageCopyForSendOnBehalfEnabled <$true | $false>] - [-MessageCopyForSentAsEnabled <$true | $false>] - [-MessageTracking <$true | $false>] - [-MessageTrackingReadStatusEnabled <$true | $false>] - [-MicrosoftOnlineServicesID <SmtpAddress>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-Office <String>] - [-Password <SecureString>] - [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] - [-ProvisionedForOfficeGraph] - [-PublicFolder] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResourceCapacity <Int32>] - [-ResourceCustom <MultiValuedProperty>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] - [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RetentionUrl <String>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-RoomMailboxPassword <SecureString>] - [-RulesQuota <ByteQuantifiedSize>] - [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SimpleDisplayName <String>] - [-SingleItemRecoveryEnabled <$true | $false>] - [-SkipDualWrite] - [-StartDateForRetentionHold <DateTime>] - [-Type <Regular | Room | Equipment | Shared>] - [-UMDtmfMap <MultiValuedProperty>] - [-UseDatabaseQuotaDefaults <$true | $false>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-UserCertificate <MultiValuedProperty>] - [-UserSMimeCertificate <MultiValuedProperty>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -### ExcludeFromOrgHolds -``` -Set-Mailbox [-Identity] <MailboxIdParameter> [-ExcludeFromOrgHolds <String>] - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccountDisabled <$true | $false>] - [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] - [-Alias <String>] - [-ApplyMandatoryProperties] - [-ArchiveName <MultiValuedProperty>] - [-AuditAdmin <MultiValuedProperty>] - [-AuditDelegate <MultiValuedProperty>] - [-AuditEnabled <$true | $false>] - [-AuditLogAgeLimit <EnhancedTimeSpan>] - [-AuditOwner <MultiValuedProperty>] - [-AuxAuditLog] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-CalendarRepairDisabled <$true | $false>] - [-CalendarVersionStoreDisabled <$true | $false>] - [-Confirm] - [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DefaultPublicFolderMailbox <RecipientIdParameter>] - [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] - [-ElcProcessingDisabled <$true | $false>] - [-EmailAddresses <ProxyAddressCollection>] - [-EnableRoomMailboxAccount <$true | $false>] - [-EndDateForRetentionHold <DateTime>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ExternalOofOptions <InternalOnly | External>] - [-Force] - [-ForwardingAddress <RecipientIdParameter>] - [-ForwardingSmtpAddress <ProxyAddress>] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-ImListMigrationCompleted <$true | $false>] - [-ImmutableId <String>] - [-InactiveMailbox] - [-IsExcludedFromServingHierarchy <$true | $false>] - [-IssueWarningQuota <Unlimited>] - [-JournalArchiveAddress <SmtpAddress>] - [-Languages <MultiValuedProperty>] - [-LitigationHoldDate <DateTime>] - [-LitigationHoldDuration <Unlimited>] - [-LitigationHoldEnabled <$true | $false>] - [-LitigationHoldOwner <String>] - [-MailboxRegion <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-MaxReceiveSize <Unlimited>] - [-MaxSendSize <Unlimited>] - [-MessageCopyForSendOnBehalfEnabled <$true | $false>] - [-MessageCopyForSentAsEnabled <$true | $false>] - [-MessageTracking <$true | $false>] - [-MessageTrackingReadStatusEnabled <$true | $false>] - [-MicrosoftOnlineServicesID <SmtpAddress>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-Name <String>] - [-Office <String>] - [-Password <SecureString>] - [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] - [-ProvisionedForOfficeGraph] - [-PublicFolder] - [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-ResourceCapacity <Int32>] - [-ResourceCustom <MultiValuedProperty>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] - [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] - [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RetentionUrl <String>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] - [-RoomMailboxPassword <SecureString>] - [-RulesQuota <ByteQuantifiedSize>] - [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SharingPolicy <SharingPolicyIdParameter>] - [-SimpleDisplayName <String>] - [-SingleItemRecoveryEnabled <$true | $false>] - [-SkipDualWrite] - [-StartDateForRetentionHold <DateTime>] - [-Type <Regular | Room | Equipment | Shared>] - [-UMDtmfMap <MultiValuedProperty>] - [-UseDatabaseQuotaDefaults <$true | $false>] - [-UseDatabaseRetentionDefaults <$true | $false>] - [-UserCertificate <MultiValuedProperty>] - [-UserSMimeCertificate <MultiValuedProperty>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-Mailbox -Identity "John Woods" -DeliverToMailboxAndForward $true -ForwardingSMTPAddress manuel@contoso.com -``` - -This example delivers John Woods's email messages to John's mailbox and also forwards them to Manuel Oliveira's (manuel@contoso.com) mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-Mailbox -OrganizationalUnit "Marketing" | Set-Mailbox -UseDatabaseQuotaDefaults $false -IssueWarningQuota 200MB -ProhibitSendQuota 250MB -ProhibitSendReceiveQuota 280MB -``` - -This example uses the Get-Mailbox cmdlet to find all the mailboxes in the Marketing organizational unit, and then uses the Set-Mailbox cmdlet to configure these mailboxes. The custom warning, prohibit send, and prohibit send and receive limits are set to 200 megabytes (MB), 250 MB, and 280 MB respectively, and the mailbox database's default limits are ignored. - -### -------------------------- Example 3 -------------------------- -``` -Get-User -Filter "Department -eq 'Customer Service'" | Set-Mailbox -MaxSendSize 2MB -``` - -This example uses the Get-User command to find all users in the Customer Service department, and then uses the Set-Mailbox command to change the maximum message size for sending messages to 2 MB. - -### -------------------------- Example 4 -------------------------- -``` -Set-Mailbox John@contoso.com -MailTipTranslations ("FR: C'est la langue française", "CHT: 這是漢語語言") -``` - -This example sets the MailTip translation in French and Chinese. - -### -------------------------- Example 5 -------------------------- -``` -$password = Read-Host "Enter password" -AsSecureString; Set-Mailbox florencef -Password $password -ResetPasswordOnNextLogon $true -``` - -In on-premises Exchange, this example resets the password for Florence Flipo's mailbox. The next time she signs in to her mailbox, she'll have to change her password. - -### -------------------------- Example 6 -------------------------- -``` -Set-Mailbox -Arbitration -Identity "SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}" -MessageTracking $false; Set-Mailbox -Arbitration -Identity "SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}" -MessageTracking $true -``` - -This example removes the message tracking organization capability from the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} and assigns it to an arbitration mailbox named SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountDisabled -The AccountDisabled parameter specifies whether to disable the account that's associated with the mailbox. Valid values are: - -- $true: The associated account is disabled. The user can't log in to the mailbox. - -- $false: The associated account is enabled. The user can log in to the mailbox. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddressBookPolicy -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 - -- Distinguished name (DN) - -- GUID - -For more information about address book policies, see Address book policies (https://technet.microsoft.com/library/hh529948.aspx). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AntispamBypassEnabled -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 - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -ApplyMandatoryProperties -The ApplyMandatoryProperties switch specifies whether to update the msExchVersion attribute of the mailbox. You may need to use this switch to fix inaccessible mailboxes or mailboxes that were created in previous versions of Exchange. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration switch specifies that the mailbox you're modifying is an arbitration mailbox. You don't need to specify a value with this switch. - -Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. - -Notes: - -- If you don't use this switch, the command can't find the arbitration mailbox to modify. - -- To modify an arbitration mailbox that's used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveDatabase -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: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Identity -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 -``` - -### -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. - -Only use this parameter if the archive is hosted in the cloud-based service. - -```yaml -Type: SmtpDomain -Parameter Sets: Identity -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 -``` - -### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook and Outlook Web App. - -If you don't use this parameter, the default value is In-Place Archive - \<Mailbox User's Display Name\>. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveQuota -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. - -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The ArchiveQuota value must be greater than or equal to the ArchiveWarningQuota value. - -```yaml -Type: Unlimited -Parameter Sets: Identity -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 -``` - -### -ArchiveStatus -This parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Active -Parameter Sets: Identity -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 -``` - -### -ArchiveWarningQuota -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. - -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The ArchiveWarningQuota value must be less than or equal to the ArchiveQuota value. - -```yaml -Type: Unlimited -Parameter Sets: Identity -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 -``` - -### -AttributesToClear -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SetMailbox+ClearableADAttributes[] -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditAdmin -The AuditAdmin parameter specifies the mailbox operations to log for administrators as part of mailbox audit logging. Valid values are: - -- None - -- Copy - -- Create - -- FolderBind - -- HardDelete - -- MessageBind - -- Move - -- MoveToDeletedItems - -- SendAs - -- SendOnBehalf - -- SoftDelete - -- Update - -- UpdateFolderPermissions (cloud-based service only) - -- UpdateCalendarDelegation (cloud-based service only) - -- UpdateInboxRules (cloud-based service only) - -By default, the Update, Move, MoveToDeletedItems, SoftDelete, HardDelete, FolderBind, SendAs, SendOnBehalf, Create, UpdateFolderPermissions, UpdateCalendarDelegation, and UpdateInboxRules actions performed by administrators are logged. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -The AuditEnabled parameter must be set to $true to enable mailbox audit logging. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditDelegate -The AuditDelegate parameter specifies the mailbox operations to log for delegate users as part of mailbox audit logging. Valid values are: - -- None - -- Create - -- FolderBind - -- HardDelete - -- Move - -- MoveToDeletedItems - -- SendAs - -- SendOnBehalf - -- SoftDelete - -- Update - -- UpdateFolderPermissions (cloud-based service only) - -- UpdateInboxRules (cloud-based service only) - -By default, the Update, SoftDelete, HardDelete, SendAs, Create, UpdateFolderPermissions, and UpdateInboxRules actions performed by delegates are logged. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -The AuditEnabled parameter must be set to $true to enable mailbox audit logging. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -AuditLog -This parameter is available only in on-premises Exchange. - -The AuditLog switch specifies the mailbox you're modifying is an arbitration mailbox that's used to store audit log settings. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't work for modifying this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -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 -``` - -### -AuditLogAgeLimit -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. - -For example, to specify 60 days for this parameter, use 60.00:00:00. Setting this parameter to the value 00:00:00 removes all audit log entries for the mailbox. The entries are removed the next time the Managed Folder Assistant processes the mailbox (automatically or manually by running the Start-ManagedFolderAssistant cmdlet). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditOwner -The AuditOwner parameter specifies the mailbox operations to log for mailbox owners as part of mailbox audit logging. Valid values include: - -- None - -- Create - -- HardDelete - -- MailboxLogin - -- Move - -- MoveToDeletedItems - -- SoftDelete - -- Update - -- UpdateFolderPermissions (cloud-based service only) - -- UpdateCalendarDelegation (cloud-based service only) - -- UpdateInboxRules (cloud-based service only) - -In on-premises Exchange, mailbox access by the owner isn't logged by default. In the cloud-based service, only the UpdateFolderPermissions, UpdateCalendarDelegation, and UpdateInboxRules actions performed by the owner are logged by default. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -The AuditEnabled parameter must be set to $true to enable mailbox audit logging. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuxAuditLog -This parameter is available only in on-premises Exchange. - -The AuxAuditLog switch specifies the mailbox you're modifying is an arbitration mailbox that's used to store audit log data. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't work for modifying this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarLoggingQuota -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. - -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). - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The value of this parameter must be less than or equal to the value of the RecoverableItemsQuota parameter. - -When the UseDatabaseQuotaDefaults parameter is set to the value $true, the value of the this parameter is ignored, and the mailbox uses the CalendarLoggingQuota value on 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. - -```yaml -Type: Unlimited -Parameter Sets: Identity -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 -``` - -### -CalendarRepairDisabled -The CalendarRepairDisabled parameter specifies whetherto 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. - -```yaml -Type: $true | $false -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 -``` - -### -CalendarVersionStoreDisabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -ClientExtensions -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. - -Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDTMFMap -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. - -- $false: A DTMF map isn't created for the recipient. - -```yaml -Type: $true | $false -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 -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Identity -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 -``` - -### -DataEncryptionPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. - -```yaml -Type: DataEncryptionPolicyIdParameter -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderMailbox -The DefaultPublicFolderMailbox parameter assigns a specific public folder mailbox to the user. By default, the public folder mailbox used by a user is automatically selected by an algorithm that load-balances users across all public folder mailboxes. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliverToMailboxAndForward -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. - -- $false: If a forwarding recipient or email address is configured, messages are delivered only to the specified recipient or email address, and messages aren't delivered to this mailbox. If no forwarding recipient or email address is configured, messages are delivered only to this mailbox. - -The default value is $false. The value of this parameter is meaningful only if you configure a forwarding recipient or email address. - -```yaml -Type: $true | $false -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 -``` - -### -DisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: Identity -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 -``` - -### -DowngradeHighPriorityMessagesEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -DumpsterMessagesPerFolderCountReceiveQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List DumpsterMessagesPerFolderCountReceiveQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -DumpsterMessagesPerFolderCountWarningQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List DumpsterMessagesPerFolderCountWarningQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -ElcProcessingDisabled -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. - -```yaml -Type: $true | $false -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -EnableRoomMailboxAccount -The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: - -- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox. - -- $false: The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value. - -You need to use this parameter with the Room switch. - -Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Lync Room System or the Skype for Business Room System. - -In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. - -In an on-premises Exchange organization, you also need to enable the corresponding user account in Active Directory Users and Computers or by running the Enable-ADAccount cmdlet in Windows PowerShell. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDateForRetentionHold -The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, you need to set the RetentionHoldEnabled parameter to the value $true. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFromAllOrgHolds -This parameter is available only in Exchange Online. - -The ExcludeFromAllOrgHolds switch excludes the mailbox from all organization-wide Office 365 retention policies. This switch can only be used for inactive mailboxes. You don't need to specify a value with this switch. - -When you use this switch, use the DistinguishedName or ExchangeGuid property value for the identity of the inactive mailbox (those are the only values that guarantee uniqueness). - -```yaml -Type: SwitchParameter -Parameter Sets: ExcludeFromAllOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFromOrgHolds -This parameter is available only in Exchange Online. - -The ExcludeFromOrgHolds parameter excludes the mailbox from one or more organization-wide Office 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 Office 365 retention policy that the inactive mailbox is excluded from. To find the GUID values of organization-wide Office 365 retention policies, run the command Get-OrganizationConfig | Format-List InplaceHolds. Note that retention policies assigned to mailboxes are prefaced by 'mbx'. - -You can specify multiple values for this parameter by using the syntax "GUID1","GUID2",…"GUIDX". - -When you use this parameter, use the DistinguishedName or ExchangeGuid property value for the identity of the inactive mailbox (those are the values that guarantee uniqueness). - -```yaml -Type: String[] -Parameter Sets: ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedPropertiesCountQuota -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. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalOofOptions -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. - -- InternalOnly: Automatic replies can be configured only for internal senders. - -```yaml -Type: InternalOnly | External -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 -``` - -### -FolderHierarchyChildrenCountReceiveQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List FolderHierarchyChildrenCountReceiveQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -FolderHierarchyChildrenCountWarningQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List FolderHierarchyChildrenCountWarningQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -FolderHierarchyDepthReceiveQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List FolderHierarchyDepthReceiveQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -FolderHierarchyDepthWarningQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List FolderHierarchyDepthWarningQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -FoldersCountReceiveQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List FoldersCountReceiveQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -FoldersCountWarningQuota -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. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List FoldersCountReceiveQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -ForwardingAddress -The ForwardingAddress parameter specifies a forwarding address for messages that are sent to this mailbox. 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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. - -- DeliverToMailboxAndForward is $true: Messages are delivered to this mailbox and forwarded to the specified recipient. - -- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified recipient. Messages aren't delivered to this mailbox. - -The default value is blank ($null), which means no forwarding recipient is configured. - -If you configure values for both the ForwardingAddress and ForwardingSmtpAddress parameters, the value of ForwardingSmtpAddress is ignored. Messages are forwarded to the recipient specified by the ForwardingAddress parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingSmtpAddress -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. - -- DeliverToMailboxAndForward is $true: Messages are delivered to this mailbox and forwarded to the specified email address. - -- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified email address. Messages aren't delivered to this mailbox. - -The default value is blank ($null), which means no forwarding email address is configured. - -If you configure values for both the ForwardingAddress and ForwardingSmtpAddress parameters, the value of ForwardingSmtpAddress is ignored. Messages are forwarded to the recipient specified by the ForwardingAddress parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GMGen -This parameter is available only in on-premises Exchange. - -The GMGen parameter specifies whether the arbitration mailbox (also called anorganization 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. - -Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<Mailbox\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this mailbox. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -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 -``` - -### -ImListMigrationCompleted -The ImListMigrationCompleted parameter specifies whether a 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. - -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://go.microsoft.com/fwlink/p/?LinkID=313550). - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InactiveMailbox -This parameter is available only in the cloud-based service. - -The InactiveMailboxswitch specifies that the mailbox is an inactive mailbox. 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. - -To find inactive mailboxes, run the command Get-Mailbox -InactiveMailboxOnly | FL Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid and then use the DistinguishedName or ExchangeGuid property values for the Identity parameter (values guaranteed to be unique). - -This switch is required to use the LitigationHoldEnabled and LitigationHoldDuration parameters on inactive mailboxes. - -You can't use this switch to modify other properties on inactive mailboxes. - -```yaml -Type: SwitchParameter -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -You should use this parameter only during public folder migrations. Don't use this parameter once the initial migration validation is complete. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsHierarchyReady -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -IsHierarchySyncEnabled -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssueWarningQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. - -In Office 365, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Office 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 Office 365, 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 is set to $true, the value of the this parameter is ignored, and the mailbox uses the IssueWarningQuota value on 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalArchiveAddress -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Languages -The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedCredential -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. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: Identity -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 -``` - -### -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. - -```yaml -Type: String -Parameter Sets: Identity -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 -``` - -### -LinkedMasterAccount -This parameter is available only in on-premises Exchange. - -The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LitigationHoldDate -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LitigationHoldDuration -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LitigationHoldEnabled -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. - -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. - -Placing public folder mailboxes on Litigation Hold isn't supported. To place public folder mailboxes on hold, create an In-Place Hold by using the New-MailboxSearch cmdlet with the InPlaceHoldEnabled parameter. - -```yaml -Type: $true | $false -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 -``` - -### -LitigationHoldOwner -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxMessagesPerFolderCountReceiveQuota -This parameter is a 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. - -The MailboxMessagesPerFolderCountReceiveQuota value must be greater than or equal to the MailboxMessagesPerFolderCountWarningQuota value. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List MailboxMessagesPerFolderCountReceiveQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxMessagesPerFolderCountWarningQuota -This parameter is a 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. - -The MailboxMessagesPerFolderCountReceiveQuota value must be greater than or equal to the MailboxMessagesPerFolderCountWarningQuota value. - -To see the current value of this property, run the command Get-MailboxStatistics \<MailboxIdentity\> | Format-List MailboxMessagesPerFolderCountWarningQuota - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxRegion -This parameter is avaialble only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedFolderMailboxPolicy -This parameter is available or 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. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedFolderMailboxPolicyAllowed -This parameter is available or functional only in Exchange Server 2010. - -The ManagedFolderMailboxPolicyAllowed parameter bypasses the warning that MRM features aren't supported for clients running versions of Outlook earlier than Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox by using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used. - -Although Outlook 2003 Service Pack 3 clients are supported, they have limited MRM functionality. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Management -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. - -Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -MaxBlockedSenders -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. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - -The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. - -In Office 365, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Office 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 Office 365, 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. - -In on-premises Exchange, the default value unlimited indicates the maximum receive size for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MaxSafeSenders -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. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -MaxSendSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. - -In Office 365, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Office 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 Office 365, 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. - -In on-premises Exchange, the default value unlimited indicates the maximum send size for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageCopyForSendOnBehalfEnabled -**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. - -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. - -You give users permission to send on behalf of a mailbox by using the GrantSendOnBehalfTo parameter on the mailbox. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageCopyForSentAsEnabled -**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. - -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. - -In Exchange Online, you give a user permission to send as a mailbox by running this command: `Add-RecipientPermission <Mailbox> -AccessRights SendAs -Trustee <User>`. - -In on-premises Exchange, you give a user permission to send as a mailbox by running this command: `Add-ADPermission <Mailbox> -ExtendedRights "Send As" -User <User>`. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTracking -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. - -Valid values are$true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: FalseNamed -Position: -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTrackingReadStatusEnabled -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. - -- $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: $true | $false -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 -``` - -### -MicrosoftOnlineServicesID -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). - -```yaml -Type: SmtpAddress -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Migration -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -Name -The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPassword -This parameter is available only in on-premises Exchange. - -The NewPassword parameter is used with the OldPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: Identity -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 -``` - -### -OABGen -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. - -Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -Office -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OfflineAddressBook -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Use the Get-OfflineAddressBook cmdlet to see the available offline address books. - -```yaml -Type: OfflineAddressBookIdParameter -Parameter Sets: Identity -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 -``` - -### -OldPassword -This parameter is available only in on-premises Exchange. - -The OldPassword parameter is used with the NewPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators typically use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: Identity -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 -``` - -### -OMEncryption -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -OMEncryptionStore -This parameter is available only in on-premises Exchange. - -PARAMVALUE: $true | $false - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter resets the password of the user account that's associated with the mailbox to the value you specify. To use this parameter on a mailbox other than your own, you need to be a member of one of the following role groups: - -- Office 365: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Office 365 (Azure AD) PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://go.microsoft.com/fwlink/p/?LinkId=614839). To change a another user's password in the Office 365 admin center, see Reset a user's password (https://go.microsoft.com/fwlink/p/?LinkId=614837). - -- On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -This parameter is available only in on-premises Exchange. - -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - -```yaml -Type: SmtpAddress -Parameter Sets: Identity -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 -``` - -### -ProhibitSendQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The ProhibitSendQuota value must be less than or equal to the ProhibitSendReceiveQuota value. - -In Office 365, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Office 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 Office 365, 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 is set to the value $true, the value of the this parameter is ignored, and the mailbox uses the ProhibitSendQuota value on 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitSendReceiveQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. - -In Office 365, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Office 365 admin center. You can lower the quota value, but you can't exceed the maximum value that's allowed by the subscription or license. In Office 365, 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 is set to the value $true, the value of the this parameter is ignored, and the mailbox uses the ProhibitSendReceiveQuota value on 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvisionedForOfficeGraph -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PstProvider -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -PublicFolder -The PublicFolder switch specifies that the mailbox is a public folder mailbox. This switch is required only when you 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryBaseDN -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: Identity -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 -``` - -### -RecalculateInactiveMailbox -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. - -An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. - -You use this switch with the InactiveMailbox switch and the Identity parameter (with DistinguishedName or ExchangeGuid property values) to force the recalculation of the hold status for the inactive mailbox, which might lead to the soft-deletion of the mailbox if all holds on the mailbox have expired. - -```yaml -Type: SwitchParameter -Parameter Sets: RecalculateInactiveMailbox -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientLimits -This parameter is available only in on-premises Exchange. - -The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mailbox. - -A valid value is an integer or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum number of recipients per message for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). - -```yaml -Type: Unlimited -Parameter Sets: Identity -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 -``` - -### -RecoverableItemsQuota -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. - -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). - -When you enter a number, you can qualify it with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. - -When the UseDatabaseQuotaDefaults parameter is set to the value $true, the value of the this parameter is ignored, and the mailbox uses the RecoverableItemsQuota value on 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. - -```yaml -Type: Unlimited -Parameter Sets: Identity -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 -``` - -### -RecoverableItemsWarningQuota -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. - -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). - -When you enter a number, you can qualify it with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. - -When the UseDatabaseQuotaDefaults parameter is set to the value $true, the value of the this parameter is ignored, and the mailbox uses the RecoverableItemsWarningQuota value on 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. - -```yaml -Type: Unlimited -Parameter Sets: Identity -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 -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteRecipientType -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: None | ProvisionMailbox | ProvisionArchive | Migrated | DeprovisionMailbox | DeprovisionArchive | RoomMailbox | EquipmentMailbox | SharedMailbox -Parameter Sets: Identity -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 -``` - -### -RemoveDelayHoldApplied -This parameter is available only in the cloud-based service. - -The RemoveDelayHoldApplied switch specifies whether to remove delay holds from the mailbox. You don't need to specify a value with this switch. - -The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace \<MailboxIdentity\> with the name, email address, or alias of the mailbox, and run this command: Export-MailboxDiagnosticLogs -Identity \<MailboxIdentity\> -ComponentName HoldTracking. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveDelayHoldApplied -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDisabledArchive -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. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveDisabledArchive -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveManagedFolderAndPolicy -This parameter is available only in on-premises Exchange. - -The RemoveManagedFolderAndPolicyswitch specifies whether to remove all MRM 1.0 policies and attributes from a mailbox. If you use this switch, MRM 1.0 policies and MRM 1.0 properties from any managed folders that were created as part of any MRM 1.0 policies are removed. Managed folders that are empty are also removed from the mailbox, and managed folders that contain items are converted to standard folders. - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePicture -This parameter is available only in on-premises Exchange. - -The RemovePicture switch specifies whether to remove the picture from the mailbox. You don't need to specify a value with this switch. - -You can add a picture to a mailbox by using the Import-RecipientDataProperty cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -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 -``` - -### -RemoveSpokenName -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. - -You can add a sound file to a mailbox by using the Import-RecipientDataProperty cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -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 -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -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 -``` - -### -ResetPasswordOnNextLogon -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. - -In Office 365, administrators can require users to reset their password the next time they log on by using the ResetPasswordOnNextLogon parameter on the Set-User cmdlet. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -ResourceCapacity -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceCustom -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. - -After you create custom resource properties, you use this parameter to assign one or more of those properties to a resource mailbox. Properties that begin with the prefix Room/ are available only on room mailboxes, and properties that begin with the prefix Equipment/ are available only on equipment mailboxes. When you specify a property value for this parameter, don't include the prefix. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDeletedItemsFor -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. - -- Selecting the Empty Deleted Items Folder action. - -- Deleting items using Shift + Delete. - -These actions move the items to the Recoverable Items folder, into a subfolder named Deletions. - -Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see Recoverable Items folder in Exchange 2016 (https://technet.microsoft.com/library/ee364755.aspx). - -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 14 days (14.00:00:00). In Office 365, you can increase the value to a maximum of 30 days. - -In Office 365, you use this parameter to configure the RetainDeletedItemsFor value on existing mailboxes. Use the Set-MailboxPlan cmdlet to change the RetainDeletedItemsFor value for all new mailboxes that you create in the future. - -In on-premises Exchange, the default value is configured by the value of the DeletedItemRetention parameter on mailbox database. To override the default value, enter a value for the RetainDeletedItemsFor parameter on the mailbox. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDeletedItemsUntilBackup -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 deleted item retention and recoverable items quota values. - -- $false: Retention of deleted items doesn't depend on a backup of the mailbox database. This is the default value. - -For more information, see Recoverable Items folder in Exchange 2016 (https://technet.microsoft.com/library/ee364755.aspx). - -The default value is configured by the value of the DeletedItemRetention parameter on mailbox database. To override the default value, enter a value for the RetainDeletedItemsFor parameter on the mailbox. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -RetentionComment -The RetentionComment parameter specifies a comment that's displayed in Outlook regarding the user's retention hold status. - -This comment can only be set if the RetentionHoldEnabled parameter is set to $true. This comment should be localized to the user's preferred language. If the comment contains spaces, enclose the comment 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionHoldEnabled -The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: - -- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox. - -- $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This is the default value. - -To set the start date for retention hold, use the StartDateForRetentionHold parameter. - -```yaml -Type: $true | $false -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 -``` - -### -RetentionPolicy -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 - -- Distinguished Name (DN) - -- GUID - -Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. - -Use the Get-RetentionPolicy cmdlet to see the available retention policies. - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionUrl -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoleAssignmentPolicy -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 - -- Distinguished name (DN) - -- GUID - -In Office 365, a role assignment policy must be assigned to the mailbox. In on-premises Exchange, to configure the mailbox so there's no role assignment policy assigned, use the value $null. - -Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomMailboxPassword -Use the RoomMailboxPassword parameter to changethe password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RulesQuota -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: - -- B (bytes) - -- KB (kilobytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The default value is 64 kilobytes (65536 bytes). - -The quota for Inbox rules applies only to enabled rules. There is no restriction on the number of disabled rules a mailbox can have. However, the total size of rules that are enabled or active can't exceed the value specified for this parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -Parameter Sets: Identity -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 -``` - -### -SCLDeleteEnabled -This parameter is available only in on-premises Exchange. - -The SCLDeleteEnabled parameter specifies whether to silently delete messages that meet or exceed the spam confidence level (SCL) specified by the SCLDeleteThreshold parameter. Valid values are: - -- $true: Messages that meet or exceed the SCLDeleteThreshold value are silently deleted without sending an non-delivery report (NDR). - -- $false: Messages that meet or exceed the SCLDeleteThreshold value aren't deleted. - -- $null (blank): The value isn't configured. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -SCLDeleteThreshold -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 aresilently deleted. - -A valid value is an integer from 0 through 9. This value should be greater than the other SCL\*Threshold values. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -SCLJunkEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -SCLJunkThreshold -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. - -A valid value is an integer from 0 through 9. This value should be less than the other SCL\*Threshold values. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -SCLQuarantineEnabled -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. - -To configure the quarantine mailbox, see Configure a spam quarantine mailbox (https://technet.microsoft.com/library/bb123746.aspx). - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -SCLQuarantineThreshold -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. - -A valid value is an integer from 0 through 9. This value should be less than the SCLRejectThreshold value, but greater than the SCLJunkThreshold value. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -SCLRejectEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -SCLRejectThreshold -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, messageswith an SCL greater than or equal to the specified value are rejected, and an NDR is sent to the sender. - -A valid value is an integer from 0 through 9. This value should be less than the SCLDeleteThreshold value, but greater than the SCLQuarantineThreshold value. - -```yaml -Type: Int32 -Parameter Sets: Identity -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 -``` - -### -SecondaryAddress -The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryDialPlan -The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - -```yaml -Type: UMDialPlanIdParameter -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -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 -``` - -### -SharingPolicy -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 - -- Distinguished name (DN) - -- GUID - -Use the Get-SharingPolicy cmdlet to see the available sharing policies. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SingleItemRecoveryEnabled -The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recovery Items folder from being purged. Valid values are: - -- $true: Single item recovery is enabled. The Recovery Items folder can't be purged. and items that have been deleted or edited can't be removed. - -- $false: Single item recovery isn't enabled. The Recovery Items folder can be purged, and, items that have been deleted or edited can be removed. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -SkipDualWrite -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDateForRetentionHold -The StartDateForRetentionHold parameter specifies the start date for the retention hold that's placed on the mailbox. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -To use this parameter, you need to set the RetentionHoldEnabled parameter to value $true. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -StsRefreshTokensValidFrom -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemMessageSizeShutoffQuota -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int64 -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemMessageSizeWarningQuota -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int64 -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottlingPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies. - -```yaml -Type: ThrottlingPolicyIdParameter -Parameter Sets: Identity -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 -``` - -### -Type -The Type parameter specifies the mailbox type for the mailbox. Valid values are: - -- Regular - -- Room - -- Equipment - -- Shared - -```yaml -Type: Regular | Room | Equipment | Shared -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 -``` - -### -UMDataStorage -This parameter is available only in on-premises Exchange. - -The UMDataStorage parameter specifies whether the arbitration mailbox (also called anorganization 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. - -Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -UMDtmfMap -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: - -- emailAddress:\<integers\> - -- lastNameFirstName:\<integers\> - -- firstNameLastName:\<integers\> - -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\<integers\>,lastNameFirstName:\<integers\>,firstNameLastName:\<integers\>. - -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\<integers\>, all existing lastNameFirstName and firstNameLastName values are removed. - -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"; Remove="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"}. - -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\<integers1\>","emailAddress:\<intgers2\>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMGrammar -This parameter is available only in on-premises Exchange. - -The UMGrammar parameter specifies whether the arbitration mailbox (also called anorganization 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. - -Valid values are $true or $false. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -UseDatabaseQuotaDefaults -This parameter is available only in on-premises Exchange. - -The UseDatabaseQuotaDefaults parameter specifies whether the mailbox uses the applicable quota values configured on the mailbox database or configured on the mailbox. Valid values are: - -- $true: The mailbox uses the applicable quota values that are configured on the mailbox database. Any of those quota values configured directly on the mailbox are ignored. - -- $false: The mailbox uses its own values for the applicable quota values. Any of those quota values on the mailbox database are ignored. - -In Office 365, the default value is $false. In on-premises Exchange, the default value is $true. - -The applicable quota values are: - -- CalendarLoggingQuota - -- IssueWarningQuota - -- ProhibitSendQuota - -- ProhibitSendReceiveQuota - -- RecoverableItemsQuota - -- RecoverableItemsWarningQuota - -```yaml -Type: $true | $false -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 -``` - -### -UseDatabaseRetentionDefaults -This parameter is available only in on-premises Exchange. - -The UseDatabaseRetentionDefaults parameter specifies whether the mailbox uses the MailboxRetention attribute value that's configured on the mailbox database. This value controls how long deleted mailboxes are kept in the database before they are permanently removed (purged). The default value is 30 days. Valid values are: - -- $true: The mailbox uses the MailboxRetention value that's configured on the mailbox database. This is the default value. - -- $false: When the mailbox is deleted, it's retained indefinitely. - -```yaml -Type: $true | $false -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 -``` - -### -UserCertificate -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -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. - -```yaml -Type: String -Parameter Sets: Identity -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 -``` - -### -UserSMimeCertificate -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a0d413b9-d949-4df6-ba96-ac0906dedae2.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/mailboxes/Set-MailboxCalendarFolder.md deleted file mode 100644 index d43191ebbc..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxCalendarFolder.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxCalendarFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxCalendarFolder cmdlet to configure calendar publishing or sharing settings on a mailbox for the visibility of calendar information to external users. To add or modify the permissions so internal users can access the calendar, use the Add-MailboxFolderPermission or Set-MailboxFolderPermission cmdlets. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxCalendarFolder [-Identity] <MailboxFolderIdParameter> [-Confirm] - [-DetailLevel <AvailabilityOnly | LimitedDetails | FullDetails>] [-DomainController <Fqdn>] - [-PublishDateRangeFrom <OneDay | ThreeDays | OneWeek | OneMonth | ThreeMonths | SixMonths | OneYear>] - [-PublishDateRangeTo <OneDay | ThreeDays | OneWeek | OneMonth | ThreeMonths | SixMonths | OneYear>] - [-PublishEnabled <$true | $false>] [-ResetUrl] [-SearchableUrlEnabled <$true | $false>] [-WhatIf] - [-SetAsSharingSource] [-UseHttps] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-MailboxCalendarFolder cmdlet configures publishing information. The calendar folder can be configured as follows: - -- Whether the calendar folder is enabled for publishing - -- Range of start and end calendar days to publish - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxCalendarFolder -Identity kai:\Calendar -DetailLevel LimitedDetails -``` - -This example sets the level of details to publish for Kai's shared calendar to LimitedDetails, which means limited details are displayed. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxCalendarFolder -Identity kai:\Calendar -SearchableUrlEnabled $true -``` - -This example enables the calendar in Kai's mailbox to be searchable on the web. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox and folder path or folder name to the calendar folder that has the publishing settings configured. You can use the following values: - -- GUID - -- ADObjectID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailLevel -The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. You can use the following values: - -- AvailabilityOnly - -- LimitedDetails - -- FullDetails - -- Editor - -The default value is AvailabilityOnly. - -```yaml -Type: AvailabilityOnly | LimitedDetails | FullDetails -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishDateRangeFrom -The PublishDateRangeFrom parameter specifies the number of days of calendar information to publish before the current date. You can use the following values: - -- OneDay - -- ThreeDays - -- OneWeek - -- OneMonth - -- ThreeMonths - -- SixMonths - -- OneYear - -The default value is ThreeMonths. - -```yaml -Type: OneDay | ThreeDays | OneWeek | OneMonth | ThreeMonths | SixMonths | OneYear -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 -``` - -### -PublishDateRangeTo -The PublishDateRangeTo parameter specifies the number of days of calendar information to publish after the current date. You can use the following values: - -- OneDay - -- ThreeDays - -- OneWeek - -- OneMonth - -- ThreeMonths - -- SixMonths - -- OneYear - -The default value is ThreeMonths. - -```yaml -Type: OneDay | ThreeDays | OneWeek | OneMonth | ThreeMonths | SixMonths | OneYear -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 -``` - -### -PublishEnabled -The PublishEnabled parameter specifies whether the specified calendar should be enabled for publishing. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -ResetUrl -The ResetUrl parameter replaces the existing non-public URL with a new URL for a calendar that has been published without being publicly searchable. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchableUrlEnabled -The SearchableUrlEnabled parameter specifies whether the published calendar URL can be searched on the web. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetAsSharingSource -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseHttps -The UseHttps switch specifies whether to use HTTPS for the published URL of the calendar folder. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8afa2ed8-43aa-4cb4-9907-93144c976427.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/mailboxes/Set-MailboxFolderPermission.md deleted file mode 100644 index 401a355a85..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxFolderPermission.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxFolderPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxFolderPermission cmdlet to modify folder-level permissions for users in mailboxes. This cmdlet differs from the Add-MailboxFolderPermission cmdlet in that it modifies existing permission entries. To configure calendar publishing or sharing settings for a mailbox so calendar information is visible to external users, use the Set-MailboxCalendarFolder cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxFolderPermission [-Identity] <MailboxFolderIdParameter> -AccessRights <MailboxFolderAccessRight[]> - -User <MailboxFolderUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [-SendNotificationToUser <$true | $false>] [-SharingPermissionFlags <None | Delegate | CanViewPrivateItems>] - [<CommonParameters>] -``` - -## DESCRIPTION -In Office 365, if you don't use the SendNotificationToUser or SharingPermissionFlags parameters, there are no changes to the functionality of the cmdlet. For example, if the user is an existing delegate, and you change their permissions to Editor without using the SendNotificationToUser or SharingPermissionFlags parameters, the user remains a delegate. But, if you use the SendNotificationToUser parameter ($true or $false), the SharingPermissionFlags parameter has the default value None, which can affect delegate access for existing users. For example, you change an existing delegate's permission to Editor, and you use SendNotificationToUser with the value $true. The user will no longer be a delegate and will only have Editor permissions to the folder. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxFolderPermission -Identity ayla@contoso.com:\Marketing -User ed@contoso.com -AccessRights Owner -``` - -This example overwrites Ed's existing permissions for the Marketing folder in Ayla's mailbox. Ed is now granted the Owner role on the folder. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate -SendNotificationToUser $true -``` - -In Office 365, this example resends the sharing invitation to an existing delegate without changing their effective permissions (Ed is already a delegate with Editor permissions to Ayla's mailbox). - -### -------------------------- Example 3 -------------------------- -``` -Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SharingPermissionFlags Delegate -``` - -In Office 365, this example removes access to private items for an existing delegate. - -### -------------------------- Example 4 -------------------------- -``` -Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SharingPermissionFlags None -``` - -In Office 365, this example changes an existing calendar delegate to Editor. - -### -------------------------- Example 5 -------------------------- -``` -Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -``` - -In Office 365, this example changes an existing user's permissions to Editor without changing their current delegate status. - -### -------------------------- Example 6 -------------------------- -``` -Set-MailboxFolderPermission -Identity ayla@contoso.com:\Calendar -User ed@contoso.com -AccessRights Editor -SendNotificationToUser $false -``` - -In Office 365, this example changes an existing user's permissions to Editor and removes their current delegate status. - -## PARAMETERS - -### -AccessRights -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. - -The following individual permissions are available: - -- CreateItems: The user can create items in the specified folder. - -- CreateSubfolders: The user can create subfolders in the specified folder. - -- DeleteAllItems: The user can delete all items in the specified folder. - -- DeleteOwnedItems: The user can only delete items that they created from the specified folder. - -- EditAllItems: The user can edit all items in the specified folder. - -- EditOwnedItems: The user can only edit items that they created in the specified folder. - -- FolderContact: The user is the contact for the specified public folder. - -- FolderOwner: The user is the owner of the specified folder. The user can view the folder, move the move the folder, and create subfolders. The user can't read items, edit items, delete items, or create items. - -- FolderVisible: The user can view the specified folder, but can't read or edit items within the specified public folder. - -- ReadItems: The user can read items within the specified folder. - -The roles that are available, along with the permissions that they assign, are described in the following list: - -- Author:CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems - -- Contributor:CreateItems, FolderVisible - -- Editor:CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems - -- None:FolderVisible - -- NonEditingAuthor:CreateItems, FolderVisible, ReadItems - -- Owner:CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems - -- PublishingEditor:CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems - -- PublishingAuthor:CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems - -- Reviewer:FolderVisible, ReadItems - -The following roles apply specifically to calendar folders: - -- AvailabilityOnly: View only availability data - -- LimitedDetails: View availability data with subject and location - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Example values for the Identity parameter are john@contoso.com:\\Calendar or John:\\Marketing\\Reports. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailboxFolderUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendNotificationToUser -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: - -- $true: A sharing invitation is sent. - -- $false: No sharing invitation is sent. This is the default value. - -This parameter only applies to calendar folders and can only be used with the following AccessRights parameter values: - -- AvailabilityOnly - -- LimitedDetails - -- Reviewer - -- Editor - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingPermissionFlags -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. - -- 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. - -```yaml -Type: None | Delegate | CanViewPrivateItems -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ca5dc7ba-5aa7-4fbc-945a-c5d06b9a1065.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxPlan.md b/exchange/exchange-ps/exchange/mailboxes/Set-MailboxPlan.md deleted file mode 100644 index 6b1d98798d..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxPlan.md +++ /dev/null @@ -1,404 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Set-MailboxPlan -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-MailboxPlan - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-MailboxPlan cmdlet to modify the settings of mailbox plans in the cloud-based service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailboxPlan [-Identity] <MailboxPlanIdParameter> [-Confirm] [-Force] [-IsDefault] - [-IssueWarningQuota <Unlimited>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] - [-ProhibitSendQuota <Unlimited>] [-ProhibitSendReceiveQuota <Unlimited>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-RetentionPolicy <MailboxPolicyIdParameter>] - [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -A mailbox plan is a template that automatically configures properties on new mailboxes. Mailbox plans correspond to Microsoft Office 365 license types. The availability of a mailbox plan is determined by the selections you make when you enroll your domain in Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxPlan -Identity ExchangeOnlineEnterprise -ProhibitSendReceiveQuota 40GB -ProhibitSendQuota 39.5GB -IssueWarningQuota 39GB -``` - -This example lowers the default mailbox quotas in the mailbox plan named ExchangeOnlineEnterprise. - -## PARAMETERS - -### -Identity -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 - -- Alias - -- Display name - -- Distinguished name (DN) - -- GUID - -- LegacyExchangeDN - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -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 enabled mailboxes receive the settings in the default mailbox plan. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssueWarningQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReceiveSize -The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to created or enabled mailboxes that have the mailbox plan applied to them. Messages larger than the maximum size are rejected. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 150MB. The default value is 36MB. - -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. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSendSize -The MaxSendSize parameter specifies the maximum size of a message that can be sent by created or enabled mailboxes that have the mailbox plan applied to them. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 150MB. The default value is 35MB. - -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. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitSendQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitSendReceiveQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. - -The maximum value is determined by the mailbox plan. You can lower 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDeletedItemsFor -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. - -- Selecting the Empty Deleted Items Folder action. - -- Deleting items using Shift + Delete. - -These actions move the items to the Recoverable Items folder, into a subfolder named Deletions. - -Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see Recoverable Items folder in Exchange 2016 (https://technet.microsoft.com/library/ee364755.aspx). - -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 14 days (14.00:00:00). In Office 365, you can increase the value to a maximum of 30 days. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPolicy -The RetentionPolicy parameter specifies the retention policy that you want applied to mailboxes that have the mailbox plan applied to them. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished Name (DN) - -- GUID - -Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. - -Use the Get-RetentionPolicy cmdlet to see the available retention policies. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoleAssignmentPolicy -The RoleAssignmentPolicy parameter specifies the management role assignment policy that's associated with the mailbox plan. This role assignment policy is assigned to all created or enabled mailboxes that have the mailbox plan assigned to them. - -The default value is blank ($null). This value means that new mailboxes receive the default role assignment policy that's configured for the organization. By default, the default role assignment policy is named Default Role Assignment Policy. - -To associate a role assignment policy with the mailbox plan, you use any value that uniquely identifies the role assignment policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -To see the available role assignment policies, use the Get-RoleAssignmentPolicy cmdlet. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/16812582-1dba-4b58-8400-bda0dc730a04.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/mailboxes/Set-MailboxRestoreRequest.md deleted file mode 100644 index fbbe5a6484..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-MailboxRestoreRequest.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxRestoreRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailboxRestoreRequest cmdlet to change restore request options after the request has been created. You can use this cmdlet to recover from failed restore requests. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Rehome -``` -Set-MailboxRestoreRequest [-Identity] <MailboxRestoreRequestIdParameter> [-RehomeRequest] - [-Confirm] - [-DomainController <Fqdn>] - [-RemoteHostName <Fqdn>] - [-RequestExpiryInterval <Unlimited>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-MailboxRestoreRequest [-Identity] <MailboxRestoreRequestIdParameter> - [-AcceptLargeDataLoss] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-DomainController <Fqdn>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RemoteHostName <Fqdn>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" -BadItemLimit 10 -``` - -This example changes the second restore request for Ayla\\MailboxRestore1 to skip 10 corrupt mailbox items. - -### -------------------------- Example 2 -------------------------- -``` -Set-MailboxRestoreRequest -Identity "Kweku\MailboxRestore" -BadItemLimit 100 -AcceptLargeDataLoss -``` - -This example changes the first restore request for Kweku's mailbox to skip 100 corrupt items. Because the BadItemLimit is greater than 50, the AcceptLargeDataLoss parameter must be specified. - -## PARAMETERS - -### -Identity -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). - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchName -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompletedRequestAgeLimit -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalFlags -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. - -```yaml -Type: InternalMrsFlag[] -Parameter Sets: Identity -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 -``` - -### -LargeItemLimit -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: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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: - -- Lowest - -- Lower - -- Low - -- Normal: This is the default value. - -- High - -- Higher - -- Highest - -- Emergency - -```yaml -Type: Normal | High -Parameter Sets: Identity -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 -``` - -### -RehomeRequest -This parameter is available only in on-premises Exchange. - -The RehomeRequest switch specifies that the mailbox restore request be moved to a different mailbox database. Use this parameter to edit a mailbox restore request in the case where the source mailbox database from the original move request has to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: Rehome -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHostName -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - -- FolderRules - -- FolderACLs - -- InitialConnectionValidation - -Use this parameter only if a restore request fails because of folder rules, folder access control lists (ACLs), or initial connection validation. - -```yaml -Type: SkippableMergeComponent[] -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9290eac1-2701-499f-a7a3-f150d28945c3.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-ResourceConfig.md b/exchange/exchange-ps/exchange/mailboxes/Set-ResourceConfig.md deleted file mode 100644 index 94421b0d52..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-ResourceConfig.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ResourceConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-ResourceConfig cmdlet to create custom resource properties that you can add to room and equipment mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ResourceConfig [-Confirm] [-DomainController <Fqdn>] [-ResourcePropertySchema <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van -``` - -This example adds the custom resource properties Room/Whiteboard and Equipment/Van. These values replace any existing custom resource properties that are already configured. - -### -------------------------- Example 2 -------------------------- -``` -Set-ResourceConfig -ResourcePropertySchema @{Add="Room/TV"; Remove="Equipment/Laptop"} -``` - -This example adds the custom resource property Room/TV and removes Equipment/Laptop without affecting other custom resource properties that are already configured. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePropertySchema -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/\<Text\> or Equipment/\<Text\> where the \<Text\> 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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7570aaf0-2cbe-46b6-92ea-cdd704f4eecc.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-UserPhoto.md b/exchange/exchange-ps/exchange/mailboxes/Set-UserPhoto.md deleted file mode 100644 index 0413f1d6d8..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Set-UserPhoto.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-UserPhoto -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-UserPhoto - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-UserPhoto cmdlet to configure the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business, and SharePoint. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### CancelPhoto -``` -Set-UserPhoto [-Identity] <MailboxIdParameter> [-Cancel] - [-Confirm] - [-GroupMailbox] - [-DomainController <Fqdn>] - [-IgnoreDefaultScope] - [-PhotoType <String>] - [-WhatIf] [<CommonParameters>] -``` - -### UploadPhotoData -``` -Set-UserPhoto [-Identity] <MailboxIdParameter> -PictureData <Byte[]> - [-Confirm] - [-DomainController <Fqdn>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-PhotoType <String>] - [-WhatIf] [<CommonParameters>] -``` - -### UploadPreview -``` -Set-UserPhoto [-Identity] <MailboxIdParameter> [-PictureData <Byte[]>] [-PictureStream <Stream>] [-Preview] - [-Confirm] - [-DomainController <Fqdn>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-PhotoType <String>] - [-WhatIf] [<CommonParameters>] -``` - -### UploadPhotoStream -``` -Set-UserPhoto [-Identity] <MailboxIdParameter> -PictureStream <Stream> - [-Confirm] - [-DomainController <Fqdn>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-PhotoType <String>] - [-WhatIf] [<CommonParameters>] -``` - -### SavePhoto -``` -Set-UserPhoto [-Identity] <MailboxIdParameter> [-Save] - [-Confirm] - [-DomainController <Fqdn>] - [-GroupMailbox] - [-IgnoreDefaultScope] - [-PhotoType <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. Administrators use the Set-UserPhoto cmdlet to configure user photos. Users can upload, preview, and save a user photo to their account by using the Outlook on the web Options page. When a user uploads a photo, a preview of the photo is displayed on the Outlook on the web Options page. This is the preview state, and creates the same result as running the Set-UserPhoto cmdlet using the Preview parameter. If the user clicks Save, the preview photo is saved as the user's photo. This is the same result as running the Set-UserPhoto -Save command or running both the Set-UserPhoto -Preview and Set-UserPhoto -Save commands. If the user cancels the preview photo on the Outlook on the web Options page, then the Set-UserPhoto -Cancel command is called. - -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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UserPhoto -Identity "Paul Cannon" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\PaulCannon.jpg")) -``` - -This example uploads and saves a photo to Paul Cannon's user account using a single command. - -### -------------------------- Example 2 -------------------------- -``` -Set-UserPhoto -Identity "Ann Beebe" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\AnnBeebe.jpg")) -Preview; Set-UserPhoto "Ann Beebe" -Save -``` - -This example shows how to use two commands to upload and save a preview photo to Ann Beebe's user account. The first command uploads a preview photo to Ann Beebe's user account, and the second command saves the uploaded photo as the preview photo. - -### -------------------------- Example 3 -------------------------- -``` -Set-UserPhoto -Identity "Ann Beebe" -Cancel -``` - -This example deletes the preview photo that was uploaded in the previous example. - -## PARAMETERS - -### -Cancel -The Cancelswitch parameter deletes the photo that's currently uploaded as the preview photo. You don't need to specify a value with this switch. - -To delete the photo that's currently associated with a user's account, use the Remove-UserPhotocmdlet. The Cancelswitch only deletes the preview photo. - -```yaml -Type: SwitchParameter -Parameter Sets: CancelPhoto -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -PictureData -The PictureData parameter specifies the photo file that will be uploaded to the user's account. - -This parameter uses the syntax ([System.IO.File]::ReadAllBytes("\<file name and path\>")). The following is an example. ([System.IO.File]::ReadAllBytes("C:\\Documents\\Pictures\\MyPhoto.jpg")). - -```yaml -Type: Byte[] -Parameter Sets: UploadPhotoData -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Byte[] -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: Stream -Parameter Sets: UploadPhotoStream -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Stream -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preview -The Previewswitch 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 Previewswitch to upload a preview photo, you need to run the command Set-UserPhoto -Save to save it as the user's photo. - -```yaml -Type: SwitchParameter -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Save -The Saveswitch 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. - -```yaml -Type: SwitchParameter -Parameter Sets: SavePhoto -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMailbox -The GroupMailbox switch indicates the specified user is an Office 365 Group. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhotoType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b4990d83-79c1-4b75-9271-4fa69757195e.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxImportRequest.md deleted file mode 100644 index 6a6dda5d99..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Suspend-MailboxImportRequest.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MailboxImportRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -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 the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Suspend-MailboxImportRequest [-Identity] <MailboxImportRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-SuspendComment <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Suspend-MailboxImportRequest -Identity "Ayla\MailboxImport1" -``` - -This example suspends the second import request for Ayla's mailbox with the identity Ayla\\MailboxImport1. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxImportRequest -Status InProgress | Suspend-MailboxImportRequest -SuspendComment "Resume after 22:00 (10 P.M.)" -``` - -This example suspends all import requests that are in progress by using the Get-MailboxImportRequest cmdlet to retrieve all requests with a Status of InProgress and then pipelining the output to the Suspend-MailboxImportRequest cmdlet with the suspend comment "Resume after 22:00 (10 P.M.)". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \<alias\>\\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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -SuspendComment -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/49836c94-b353-49e8-a1f1-ca59e4a37443.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Test-MAPIConnectivity.md b/exchange/exchange-ps/exchange/mailboxes/Test-MAPIConnectivity.md deleted file mode 100644 index 7679b087c2..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Test-MAPIConnectivity.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-MAPIConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Database -``` -Test-MAPIConnectivity -Database <DatabaseIdParameter> - [-ActiveDirectoryTimeout <Int32>] - [-AllConnectionsTimeout <Int32>] - [-Confirm] - [-CopyOnServer <ServerIdParameter>] - [-DomainController <Fqdn>] - [-MonitoringContext <$true | $false>] - [-PerConnectionTimeout <Int32>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Test-MAPIConnectivity [-Identity] <MailboxIdParameter> - [-ActiveDirectoryTimeout <Int32>] - [-AllConnectionsTimeout <Int32>] - [-Archive] - [-Confirm] - [-CopyOnServer <ServerIdParameter>] - [-DomainController <Fqdn>] - [-MonitoringContext <$true | $false>] - [-PerConnectionTimeout <Int32>] - [-WhatIf] [<CommonParameters>] -``` - -### Server -``` -Test-MAPIConnectivity [-Server <ServerIdParameter>] - [-ActiveDirectoryTimeout <Int32>] - [-AllConnectionsTimeout <Int32>] - [-Confirm] - [-DomainController <Fqdn>] - [-IncludePassive] - [-MonitoringContext <$true | $false>] - [-PerConnectionTimeout <Int32>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-MapiConnectivity cmdlet verifies server functionality. This cmdlet logs on to the mailbox that you specify (or to the SystemMailbox if you don't specify the Identity parameter) and retrieves a list of items in the Inbox. Logging on to the mailbox tests two critical protocols used when a client connects to a Mailbox server: MAPI and LDAP. During authentication, the Test-MapiConnectivity cmdlet indirectly verifies that the MAPI server, Exchange store, and Directory Service Access (DSAccess) are working. - -The cmdlet logs on to the mailbox that you specify using the credentials of the account with which you're logged on to the local computer. After a successful authentication, the Test-MapiConnectivity cmdlet accesses the mailbox to verify that the database is working. If a successful connection to a mailbox is made, the cmdlet also determines the time that the logon attempt occurred. - -There are three distinct parameters that you can use with the command: Database, Identity and Server: - -- The Database parameter takes a database identity and tests the ability to log on to the system mailbox on the specified 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-MapiConnectivity -Server "Server01" -``` - -This example tests connectivity to the server Server01. - -### -------------------------- Example 2 -------------------------- -``` -Test-MapiConnectivity -Identity "midwest\john" -``` - -This example tests connectivity to a mailbox, specified as a domain name and user name. - -## PARAMETERS - -### -Database -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. If you don't specify this parameter or the Identity parameter, the command tests the SystemMailbox on each active database on the server that you specify, or on the local server if you don't specify the Server parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies a mailbox to test. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -This parameter accepts pipeline input from the Get-Mailbox or Get-Recipient cmdlet. If an object is piped from the Get-Mailbox cmdlet or Get-Recipient cmdlet, this parameter isn't required. - -If you don't specify this parameter, the cmdlet tests the SystemMailbox on the database that you specify. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActiveDirectoryTimeout -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. - -```yaml -Type: Int32 -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 -``` - -### -AllConnectionsTimeout -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. - -```yaml -Type: Int32 -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 -``` - -### -Archive -The Archive parameter specifies whether to test the MAPI connectivity of the personal archive associated with the specified mailbox. If you don't specify this parameter, only the primary mailbox is tested. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -CopyOnServer -This parameter is available only in on-premises Exchange. - -The CopyOnServer parameter is used to test MAPI connectivity to a specific database copy on the servers specified with the Server parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Database, Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -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 -``` - -### -IncludePassive -This parameter is available only in on-premises Exchange. - -Without the IncludePassive parameter, the cmdlet tests MAPI connectivity from active database copies only. Using the IncludePassive parameter, you can have the cmdlet test MAPI connectivity from all active and passive database copies. - -```yaml -Type: SwitchParameter -Parameter Sets: Server -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 -``` - -### -MonitoringContext -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 for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). - -```yaml -Type: $true | $false -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 -``` - -### -PerConnectionTimeout -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -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. - -If you don't specify this parameter, the command tests the mailbox on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89c5b599-0a92-4857-880c-aea5f1e6c8bd.aspx) diff --git a/exchange/exchange-ps/exchange/mailboxes/Undo-SoftDeletedMailbox.md b/exchange/exchange-ps/exchange/mailboxes/Undo-SoftDeletedMailbox.md deleted file mode 100644 index 52f0a3c35a..0000000000 --- a/exchange/exchange-ps/exchange/mailboxes/Undo-SoftDeletedMailbox.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Undo-SoftDeletedMailbox -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Undo-SoftDeletedMailbox - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### PublicFolder -``` -Undo-SoftDeletedMailbox [-SoftDeletedObject] <MailboxIdParameter> [-DisplayName <String>] [-PublicFolder] - [-Confirm] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -### SoftDeletedMailbox -``` -Undo-SoftDeletedMailbox [-SoftDeletedObject] <MailboxIdParameter> [-Password <SecureString>] [-WindowsLiveID <WindowsLiveId>] - [-Confirm] [-DisplayName <String>] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that has been deleted. When a mailbox is deleted with the Remove-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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Undo-SoftDeletedMailbox -SoftDeletedObject florencef -``` - -This example recovers the deleted mailbox for the user Florence Flipo. When this mailbox was deleted, the associated Windows Live ID was also deleted. - -### -------------------------- Example 2 -------------------------- -``` -Undo-SoftDeletedMailbox bjohnson@contoso.edu -WindowsLiveID brianj@contoso.edu -Password (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -``` - -This example recovers the deleted mailbox for the user Brian Johnson. When this mailbox was deleted, the associated Microsoft account (formerly known as a Windows Live ID) wasn't deleted. Note that a new Microsoft account and password have to be created to recover this mailbox. In the scenario, the old Microsoft account is retained as a proxy address for the mailbox. - -## PARAMETERS - -### -PublicFolder -The PublicFolder switch specifies that the deleted mailbox you want to recover is a public folder mailbox. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SoftDeletedObject -The SoftDeletedObject parameter specifies the identity of 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies a new password for the mailbox. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -You have to include the Password parameter to recover a deleted mailbox with an existing Microsoft account (formerly known as a Windows Live ID) that wasn't deleted with the mailbox. - -```yaml -Type: SecureString -Parameter Sets: SoftDeletedMailbox -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveID -The WindowsLiveID parameter specifies a new Microsoft account (formerly known as a Windows Live ID) and primary SMTP for the mailbox. The previous Microsoft account is retained as a proxy address for the mailbox. - -You have to include the WindowsLiveID parameter to recover a deleted mailbox with an existing Microsoft account that wasn't deleted with the mailbox. - -```yaml -Type: WindowsLiveId -Parameter Sets: SoftDeletedMailbox -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e12b0c43-06c7-45f9-9890-eaac56745573.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationBatch.md b/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationBatch.md deleted file mode 100644 index 029ccc9c00..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationBatch.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationBatch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MigrationBatch cmdlet to retrieve status information about the current migration batch. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### BatchesFromEndpoint -``` -Get-MigrationBatch [-Diagnostic] [-DiagnosticArgument <String>] [-DiagnosticInfo <String>] - [-DomainController <Fqdn>] [-Endpoint <MigrationEndpointIdParameter>] [-IncludeReport] - [-Status <Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus>] [-Partition <MailboxIdParameter>] - [<CommonParameters>] -``` - -### Identity -``` -Get-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Diagnostic] [-DiagnosticArgument <String>] - [-DiagnosticInfo <String>] [-DomainController <Fqdn>] [-IncludeReport] - [-Status <Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus>] [-Partition <MailboxIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-MigrationBatch cmdlet displays status information about the current migration batch. This information includes the following information: - -- Status of the migration batch - -- Total number of mailboxes being migrated - -- Number of successfully completed migrations - -- Migration errors - -- Date and time when the migration was started - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MigrationBatch -Identity LocalMove2 -``` - -This example displays status information for the migration batch LocalMove2. - -### -------------------------- Example 2 -------------------------- -``` -Get-MigrationBatch -Endpoint exsrv1.contoso.com -``` - -This example displays information about all migration batches associated with the migration endpoint exsrv1.contoso.com. - -## PARAMETERS - -### -Diagnostic -This parameter is available only in on-premises Exchange. - -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticArgument -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -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 -``` - -### -DiagnosticInfo -This parameter is available only in the cloud-based service. - -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. - -If you use this parameter, you can't include the Identity parameter. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: BatchesFromEndpoint -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. - -If you use this parameter, you can't include the Endpoint parameter. - -```yaml -Type: MigrationBatchIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeReport -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -The Status parameter returns a list of migration batches that have the specified status state. Use one of the following values: - -- Completed - -- CompletedWithErrors - -- Completing - -- Corrupted - -- Created - -- Failed - -- IncrementalSyncing - -- Removing - -- Starting - -- Stopped - -- Syncing - -- Stopping - -- Synced - -- SyncedwithErrors - -- Waiting - -```yaml -Type: Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3a4d27c4-712b-40e8-b5a8-a4f1b8e5a3c6.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationConfig.md b/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationConfig.md deleted file mode 100644 index 7b259d28d0..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationConfig.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MigrationConfig cmdlet to retrieve migration configuration settings on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MigrationConfig [-DomainController <Fqdn>] [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MigrationConfig -``` - -This example retrieves the settings for the migration configuration. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fdf3e9f5-df3d-454d-9117-0565e3b430d2.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationEndpoint.md b/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationEndpoint.md deleted file mode 100644 index d5c57e77fe..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationEndpoint.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationEndpoint -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MigrationEndpoint cmdlet to retrieve migration endpoint settings for source or destination servers for cutover or staged Exchange migrations, IMAP migrations, and remote moves. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ConnectionSettingsFilter -``` -Get-MigrationEndpoint -ConnectionSettings <ExchangeConnectionSettings> [-Diagnostic] - [-DiagnosticArgument <String>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### TypeFilter -``` -Get-MigrationEndpoint -Type <MigrationType> [-Diagnostic] [-DiagnosticArgument <String>] - [-DomainController <Fqdn>] [-Partition <MailboxIdParameter>] [-DiagnosticInfo <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-MigrationEndpoint [[-Identity] <MigrationEndpointIdParameter>] [-Diagnostic] [-DiagnosticArgument <String>] - [-DomainController <Fqdn>] [-Partition <MailboxIdParameter>] [-DiagnosticInfo <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-MigrationEndpoint cmdlet retrieves settings for different types of migration: - -- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a RemoteMove endpoint. - -- Remote move: In a hybrid deployment, a remote move involves onboarding or offboarding migrations. Remote moves require the use of a RemoteMove endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online in Office 365, and uses a RemoteMove endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online in Office 365 to an on-premises Exchange organization and uses a RemoteMove endpoint as the target endpoint of the migration batch. - -- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online in Office 365. Cutover Exchange migration requires the use of an Exchange endpoint. - -- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online in Office 365. Staged Exchange migration requires the use of an Exchange endpoint. - -- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online in Office 365. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. - -- Local: Move mailboxes between different servers or databases within a single on-premises Exchange forest. Local moves don't require the use of an endpoint. - -For more information about the different move and migration scenarios, see: - -- Mailbox moves (https://technet.microsoft.com/library/jj150543.aspx) - -- Manage on-premises mailbox moves (https://technet.microsoft.com/library/jj150487.aspx) - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MigrationEndpoint -Identity OnboardingME01 -``` - -This example retrieves the settings for the migration endpoint, OnboardingME01. - -## PARAMETERS - -### -ConnectionSettings -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. - -```yaml -Type: ExchangeConnectionSettings -Parameter Sets: ConnectionSettingsFilter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Diagnostic -This parameter is available only in on-premises Exchange. - -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticArgument -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticInfo -This parameter is available only in the cloud-based service. - -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter filters the results by the type of migration. Valid values for this parameter are: - -- ExchangeOutlookAnywhere: Cutover or staged Exchange migrations - -- ExchangeRemoteMove: Remote moves and migrations - -- IMAP: IMAP migrations - -- PublicFolder: Public folder migrations - -```yaml -Type: MigrationType -Parameter Sets: TypeFilter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3576e65b-4b64-46a5-a95a-7045daf4893e.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationStatistics.md b/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationStatistics.md deleted file mode 100644 index 8138fadd80..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationStatistics.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MigrationStatistics cmdlet to view detailed information about migration requests. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MigrationStatistics [-Diagnostic] [-DiagnosticArgument <String>] [-DiagnosticInfo <String>] [-DomainController <Fqdn>] - [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MigrationStatistics -``` - -This example returns the default statistics for the migration batches. - -## PARAMETERS - -### -Diagnostic -This parameter is available only in on-premises Exchange. - -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticArgument -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticInfo -This parameter is available only in the cloud-based service. - -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bf5d6d30-e3cf-46c1-b821-36b156e4a9d4.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationUser.md b/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationUser.md deleted file mode 100644 index 860c8ef70c..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-MigrationUser.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationUser -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MigrationUser cmdlet to view information about move and migration users. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MailboxGuid -``` -Get-MigrationUser -MailboxGuid <Guid> - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -### StatusAndBatchId -``` -Get-MigrationUser [-BatchId <MigrationBatchIdParameter>] [-Status <Queued | Syncing | Failed | Synced | IncrementalFailed | Completing | Completed | CompletionFailed | Corrupted | Provisioning | ProvisionUpdating | CompletionSynced | Validating | IncrementalSyncing | IncrementalSynced | CompletedWithWarnings | Stopped | IncrementalStopped | Starting | Stopping | Removing>] [-StatusSummary <Active | Failed | Synced | Completed | Stopped>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -### Identity -``` -Get-MigrationUser [[-Identity] <MigrationUserIdParameter>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MigrationUser -Identity TonySmith@contoso.com -``` - -This example retrieves status information about the recently migrated user, Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -Get-MigrationUser -MailboxGuid b6a6795c-a010-4f67-aaaa-da372d56fcb9 | Get-MigrationUserStatistics -``` - -This example retrieves more detailed information about any ongoing migration for the user with the specified mailbox GUID. - -## PARAMETERS - -### -MailboxGuid -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the particular user that you want to retrieve information about. The Identity parameter is represented as an email address. - -```yaml -Type: MigrationUserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Status -The Status parameter returns information about migration users that have the specified status state. Use one of the following values: - -- Completed - -- CompletedWithWarnings - -- Completing - -- CompletionFailed - -- CompletionSynced - -- Corrupted - -- Failed - -- IncrementalFailed - -- IncrementalStopped - -- IncrementalSynced - -- IncrementalSyncing - -- Provisioning - -- ProvisionUpdating - -- Queued - -- Removing - -- Starting - -- Stopped - -- Stopping - -- Synced - -- Syncing - -- Validating - -```yaml -Type: Queued | Syncing | Failed | Synced | IncrementalFailed | Completing | Completed | CompletionFailed | Corrupted | Provisioning | ProvisionUpdating | CompletionSynced | Validating | IncrementalSyncing | IncrementalSynced | CompletedWithWarnings | Stopped | IncrementalStopped | Starting | Stopping | Removing -Parameter Sets: StatusAndBatchId -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusSummary -The StatusSummary parameter returns abbreviated information about migration users that have the specified status value. Use one of the following values: - -- Active - -- Completed - -- Failed - -- Stopped - -- Synced - -```yaml -Type: Active | Failed | Synced | Completed | Stopped -Parameter Sets: StatusAndBatchId -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ca5cbd36-fde3-41f4-8ddf-0b7c4d71fd31.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md deleted file mode 100644 index dfb5985e40..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-PublicFolderMigrationRequest - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-PublicFolderMigrationRequest cmdlet to view the detailed status of on-going public folder migration requests that were initiated by using the New-PublicFolderMigrationRequest cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filtering -``` -Get-PublicFolderMigrationRequest [-BatchName <String>] - [-DomainController <Fqdn>] - [-HighPriority <$true | $false>] - [-Name <String>] - [-RequestQueue <DatabaseIdParameter>] - [-ResultSize <Unlimited>] - [-Status <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed>] - [-Suspend <$true | $false>] - [<CommonParameters>] -``` - -### Identity -``` -Get-PublicFolderMigrationRequest [[-Identity] <PublicFolderMigrationRequestIdParameter>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderMigrationRequest -``` - -This example returns the status of in-progress migration requests. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMigrationRequest -Identity "PFMigrate10_11_12" | Format-List Suspended,AutoSuspended -``` - -This example returns all migration requests that have the name PFMigrate10\_11\_12 and the request has been suspended. - -## PARAMETERS - -### -BatchName -The BatchName parameter specifies the name that was given to a batch migration request. - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: String -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HighPriority -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: - -- $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. - -- $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. - -You can't use this parameter with the Identity parameter. - -```yaml -Type: $true | $false -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the public folder. You can use the following values: - -- GUID - -- Name - -You can't use this parameter in conjunction with the following parameters: - -- BatchName - -- RequestQueue - -- Status - -- Suspend - -```yaml -Type: PublicFolderMigrationRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the public folder migration request. - -```yaml -Type: String -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestQueue -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Filtering -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 -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Status -The Status parameter filters the results based on status. You can use the following values: - -- AutoSuspended - -- Completed - -- CompletedWithWarning - -- CompletionInProgress - -- Failed - -- InProgress - -- Queued - -- Retrying - -- Suspended - -- Synced - -You can't use this parameter with the Identity parameter. - -```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Suspend -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. - -```yaml -Type: $true | $false -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/df474db6-7408-4aac-b703-424c9f36560e.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md b/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md deleted file mode 100644 index 647529980d..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMigrationRequestStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-PublicFolderMigrationRequestStatistics - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-PublicFolderMigrationRequestStatistics cmdlet to view detailed information about migration requests. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### IdentityOnPremises -``` -Get-PublicFolderMigrationRequestStatistics [-Identity] <PublicFolderMigrationRequestIdParameter> - [-Diagnostic] - [-DiagnosticArgument <String>] - [-DiagnosticInfo <String>] - [-DomainController <Fqdn>] - [-IncludeReport] - [-ReportOnly] [<CommonParameters>] -``` - -### IdentityCloud -``` -Get-PublicFolderMigrationRequestStatistics [-Identity] <PublicFolderMigrationRequestIdParameter> - [-DiagnosticInfo <String>] - [-IncludeReport] - [-ReportOnly] - [<CommonParameters>] -``` - -### MigrationRequestQueue -``` -Get-PublicFolderMigrationRequestStatistics -RequestQueue <DatabaseIdParameter> - [-Diagnostic] - [-DiagnosticArgument <String>] - [-DomainController <Fqdn>] - [-IncludeReport] - [-ReportOnly] - [-RequestGuid <Guid>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderMigrationRequestStatistics -RequestQueue "MBXDB02" -``` - -This example returns default statistics for all migration requests that are in progress or haven't been cleared for the database MBXDB02. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMigrationRequestStatistics -Identity "PFMigrate_MarketingReports" -IncludeReport | Export-CSV C:\PFMigstats.csv -``` - -This example returns additional information about the migration request and exports the report to a CSV file. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the public folder migration request. You can use one of the following values: - -- GUID - -- Name - -This parameter can't be used in conjunction with the RequestQueue or RequestGuid parameter. - -```yaml -Type: PublicFolderMigrationRequestIdParameter -Parameter Sets: IdentityOnPremises, IdentityCloud -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RequestQueue -This parameter is available only in on-premises Exchange. - -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Diagnostic -This parameter is available only in on-premises Exchange. - -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: SwitchParameter -Parameter Sets: IdentityOnPremises, MigrationRequestQueue -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 -``` - -### -DiagnosticArgument -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. - -```yaml -Type: String -Parameter Sets: IdentityOnPremises, MigrationRequestQueue -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 -``` - -### -DiagnosticInfo -This parameter is available only in the cloud-based service. - -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: String -Parameter Sets: IdentityCloud -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: IdentityOnPremises, MigrationRequestQueue -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 -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportOnly -The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestGuid -This parameter is available only in on-premises Exchange. - -The RequestGuid parameter specifies the GUID of a migration request. - -This parameter can't be used in conjunction with the Identity parameter. - -```yaml -Type: Guid -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bfbcc746-b259-471b-97a4-0cf87f3cb2a6.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMoveRequest.md deleted file mode 100644 index 92b5575fa1..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMoveRequest.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderMoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-PublicFolderMoveRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-PublicFolderMoveRequest cmdlet to view the detailed status of an ongoing public folder move that was initiated using the New-PublicFolderMoveRequest cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filtering -``` -Get-PublicFolderMoveRequest [-BatchName <String>] - [-DomainController <Fqdn>] - [-HighPriority <$true | $false>] - [-Name <String>] - [-RequestQueue <DatabaseIdParameter>] - [-ResultSize <Unlimited>] - [-Status <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed>] - [-Suspend <$true | $false>] - [<CommonParameters>] -``` - -### Identity -``` -Get-PublicFolderMoveRequest [[-Identity] <PublicFolderMoveRequestIdParameter>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderMoveRequest -Identity \PublicFolderMove -``` - -This example returns the status of an in-progress public folder move request with the identity \\PublicFolderMove, which is the default name assigned to public folder moves. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMoveRequest -RequestQueue MBD01 -``` - -This example returns the status of in-progress and queued requests that are on the source database MBD01. - -## PARAMETERS - -### -BatchName -The BatchName parameter specifies the name that was given to a batch public folder move request. - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: String -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HighPriority -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. - -- $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest. - -You can't use this parameter with the Identity parameter. - -```yaml -Type: $true | $false -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the public folder move request. The default identity assigned to public folder move requests is \\PublicFolderMove. - -This parameter can't be used in conjunction with the following parameters: - -- BatchName - -- HighPriority - -- Name - -- RequestQueue - -- Suspend - -- Status - -```yaml -Type: PublicFolderMoveRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the public folder move request. If you didn't specify a name when creating the move request, PublicFolderMove will be the default name assigned to the request. - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: String -Parameter Sets: Filtering -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 -``` - -### -RequestQueue -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Filtering -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 -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -The Status parameter filters the results based on status. You can use the following values: - -- AutoSuspended - -- Completed - -- CompletedWithWarning - -- CompletionInProgress - -- Failed - -- InProgress - -- Queued - -- Retrying - -- Suspended - -- Synced - -You can't use this parameter with the Identity parameter. - -```yaml -Type: None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed -Parameter Sets: Filtering -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 -``` - -### -Suspend -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. - -```yaml -Type: $true | $false -Parameter Sets: Filtering -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2bcadd33-e520-498b-8551-9ef38d6d5f54.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md b/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md deleted file mode 100644 index c598781f66..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderMoveRequestStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-PublicFolderMoveRequestStatistics - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-PublicFolderMoveRequestStatistics cmdlet to view detailed information about public folder move requests. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-PublicFolderMoveRequestStatistics [-Identity] <PublicFolderMoveRequestIdParameter> - [-Diagnostic] - [-DiagnosticArgument <String>] - [-DomainController <Fqdn>] - [-IncludeReport] - [-ReportOnly] [<CommonParameters>] -``` - -### MigrationRequestQueue -``` -Get-PublicFolderMoveRequestStatistics -RequestQueue <DatabaseIdParameter> [-RequestGuid <Guid>] - [-Diagnostic] - [-DiagnosticArgument <String>] - [-DomainController <Fqdn>] - [-IncludeReport] - [-ReportOnly] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderMoveRequestStatistics -Identity \PublicFolderMove -``` - -This example returns the default statistics for the public folder move request \\PublicFolderMove. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMoveRequestStatistics -Identity \PublicFolderMove | Format-List -``` - -This example returns the detailed statistics for the move request \\PublicFolderMove by pipelining the results to the Format-List command. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: PublicFolderMoveRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RequestQueue -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticArgument -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 -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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestGuid -The RequestGuid parameter specifies the GUID of the public folder move request for which you want to view the request statistics. - -This parameter can't be used with the Identity parameter. - -```yaml -Type: Guid -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportOnly -The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/71358f53-8827-4405-94cd-dc6841fd93d2.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/New-MigrationBatch.md b/exchange/exchange-ps/exchange/move-and-migration/New-MigrationBatch.md deleted file mode 100644 index 79fa6fb45c..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/New-MigrationBatch.md +++ /dev/null @@ -1,1198 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MigrationBatch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-MigrationBatch cmdlet to submit a new migration request for a batch of users. You use this cmdlet to: - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Local -``` -New-MigrationBatch [-Local] -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers] [-WorkloadType <Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType>] [-WorkflowControlFlags <MigrationWorkflowControlFlags>] - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-ArchiveOnly] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-Locale <CultureInfo>] - [-MoveOptions <MultiValuedProperty>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-PrimaryOnly] - [-ReportInterval <Timespan>] - [-SkipMoving <MultiValuedProperty>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TargetArchiveDatabases <MultiValuedProperty>] - [-TargetDatabases <MultiValuedProperty>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### LocalPublicFolder -``` -New-MigrationBatch -Name <String> -CSVData <Byte[]> -SourcePublicFolderDatabase <DatabaseIdParameter> - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-LargeItemLimit <Unlimited>] - [-Locale <CultureInfo>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-ReportInterval <Timespan>] - [-SkipMerging <MultiValuedProperty>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### PreexistingUserIds -``` -New-MigrationBatch <MultiValuedProperty> -Name <String> [-UserIds] - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DisableOnCopy] - [-DomainController <Fqdn>] - [-Locale <CultureInfo>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-ReportInterval <Timespan>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### Preexisting -``` -New-MigrationBatch -Name <String> [-Users] <MultiValuedProperty> - [-AllowIncrementalSyncs <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DisableOnCopy] - [-DomainController <Fqdn>] - [-Locale <CultureInfo>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-ReportInterval <Timespan>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### Onboarding -``` -New-MigrationBatch -Name <String> [-CSVData <Byte[]>] [-DisallowExistingUsers] [-WorkflowControlFlags <MigrationWorkflowControlFlags>] - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-ArchiveOnly] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-ExcludeDumpsters] - [-ExcludeFolders <MultiValuedProperty>] - [-LargeItemLimit <Unlimited>] - [-Locale <CultureInfo>] - [-MoveOptions <MultiValuedProperty>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-PrimaryOnly] - [-ReportInterval <Timespan>] - [-SkipMerging <MultiValuedProperty>] - [-SkipMoving <MultiValuedProperty>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-SourceEndpoint <MigrationEndpointIdParameter>] - [-StartAfter <DateTime>] - [-TargetArchiveDatabases <MultiValuedProperty>] - [-TargetDatabases <MultiValuedProperty>] - [-TargetDeliveryDomain <String>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### Offboarding -``` -New-MigrationBatch -Name <String> -CSVData <Byte[]> [-DisallowExistingUsers] - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-ArchiveOnly] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-LargeItemLimit <Unlimited>] - [-Locale <CultureInfo>] - [-MoveOptions <MultiValuedProperty>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-PrimaryOnly] - [-ReportInterval <Timespan>] - [-SkipMerging <MultiValuedProperty>] - [-SkipMoving <MultiValuedProperty>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TargetArchiveDatabases <MultiValuedProperty>] - [-TargetDatabases <MultiValuedProperty>] - [-TargetDeliveryDomain <String>] - [-TargetEndpoint <MigrationEndpointIdParameter>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### XO1 -``` -New-MigrationBatch -Name <String> -CSVData <Byte[]> - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-Locale <CultureInfo>] - [-NotificationEmails <MultiValuedProperty>] - [-ReportInterval <Timespan>] - [-SkipMerging <MultiValuedProperty>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <System.DateTime>] - [-TargetDatabases <MultiValuedProperty>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] - [-WorkflowControlFlags <MigrationWorkflowControlFlags>] - [<CommonParameters>] -``` - -### PublicFolderToUnifiedGroup -``` -New-MigrationBatch -Name <String> -CSVData <Byte[]> [-PublicFolderToUnifiedGroup] - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-LargeItemLimit <Unlimited>] - [-Locale <CultureInfo>] - [-NotificationEmails <MultiValuedProperty>] - [-Partition <MailboxIdParameter>] - [-ReportInterval <Timespan>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-SourceEndpoint <MigrationEndpointIdParameter>] - [-StartAfter <DateTime>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### Abch -``` -New-MigrationBatch -Name <String> -CSVData <Byte[]> - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-Locale <CultureInfo>] - [-NotificationEmails <MultiValuedProperty>] - [-ReportInterval <Timespan>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TargetDatabases <MultiValuedProperty>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -### WorkflowTemplate -``` -New-MigrationBatch -Name <String> [-WorkflowTemplate <String>] - [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] - [-AutoComplete] - [-AutoRetryCount <Int32>] - [-AutoStart] - [-CompleteAfter <DateTime>] - [-Confirm] - [-DomainController <Fqdn>] - [-Locale <CultureInfo>] - [-NotificationEmails <>] - [-Partition <MailboxIdParameter>] - [-ReportInterval <Timespan>] - [-SkipReports] - [-SkipSteps <SkippableMigrationSteps[]>] - [-StartAfter <DateTime>] - [-TimeZone <ExTimeZoneValue>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-MigrationBatch cmdlet to create a migration batch to migrate mailboxes and mailbox data in one of the following migration scenarios. - -Moves in on-premises Exchange organizations - -- Local move: A local move is where you move mailboxes from one mailbox database to another. A local move occurs within a single forest. For more information, see Example 1. - -- Cross-forest enterprise move: In a cross-forest enterprise move, mailboxes are moved to a different forest. Cross-forest moves are initiated either from the target forest, which is the forest that you want to move the mailboxes to, or from the source forest, which is the forest that currently hosts the mailboxes. For more information, see Example 2. - -Onboarding and offboarding in Exchange Online - -- Onboarding remote move migration: In a hybrid deployment, you can move mailboxes from an on-premises Exchange organization to Exchange Online. This is also known as an onboarding remote move migration because you on-board mailboxes to Exchange Online. For more information, see Example 3. - -- Offboarding remote move migration: You can also perform an offboarding remote move migration, where you migrate Exchange Online mailboxes to your on-premises Exchange organization. For more information, see Example 4. - - 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. - -- 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MigrationBatch -Local -Name LocalMove1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\LocalMove1.csv")) -TargetDatabases MBXDB2; 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. - -### -------------------------- Example 2 -------------------------- -``` -$Credentials = Get-Credential; $MigrationEndpointSource = New-MigrationEndpoint -ExchangeRemoteMove -Name Forest1Endpoint -Autodiscover -EmailAddress administrator@forest1.contoso.com -Credentials $Credentials; $CrossForestBatch = New-MigrationBatch -Name CrossForestBatch1 -SourceEndpoint $MigrationEndpointSource.Identity -TargetDeliveryDomain forest2.contoso.com -TargetDatabases MBXDB1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\CrossForestBatch1.csv")); Start-MigrationBatch -Identity $CrossForestBatch.Identity -``` - -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. - -### -------------------------- Example 3 -------------------------- -``` -$Credentials = Get-Credential; $MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials; $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain cloud.contoso.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")); Start-MigrationBatch -Identity $OnboardingBatch.Identity -``` - -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. - -### -------------------------- Example 4 -------------------------- -``` -$Credentials = Get-Credential; $MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials; $OffboardingBatch = New-MigrationBatch -Name RemoteOffBoarding1 -TargetEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain onprem.contoso.com -TargetDatabases @(MBXDB01,MBXDB02,MBXDB03) -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOffBoarding1.csv")); Start-MigrationBatch -Identity $OffboardingBatch.Identity -``` - -This example creates a migration batch for an offboarding remote move migration from Exchange Online to an on-premises Exchange organization. Like an onboarding remote move, it's initiated from the Exchange Online organization. First a Migration Endpoint is created that contains information about how to connect to the on-premises organization. The endpoint is used as the TargetEndpoint when creating the migration batch, which is then started with the Start-MigrationBatch cmdlet. The TargetDatabases parameter specifies multiple on-premises databases that the migration service can select as the target database to move the mailbox to. - -### -------------------------- Example 5 -------------------------- -``` -$credentials = Get-Credential; $SourceEndpoint = New-MigrationEndpoint -ExchangeOutlookAnywhere -Autodiscover -Name SourceEndpoint -EmailAddress administrator@contoso.com -Credentials $credentials; New-MigrationBatch -Name CutoverBatch -SourceEndpoint $SourceEndpoint.Identity -TimeZone "Pacific Standard Time" -AutoStart -``` - -This example creates a migration batch for the cutover Exchange migration CutoverBatch that's automatically started. The example obtains the connection settings to the on-premises Exchange server, and then uses those connection settings to create a migration endpoint. The endpoint is then used to create the migration batch. This example also includes the optional TimeZone parameter. - -### -------------------------- Example 6 -------------------------- -``` -$Credentials = Get-Credential; $MigrationEndpoint = New-MigrationEndpoint -ExchangeOutlookAnywhere -Name ContosoEndpoint -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials; $StagedBatch1 = New-MigrationBatch -Name StagedBatch1 -SourceEndpoint $MigrationEndpoint.Identity -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\StagedBatch1.csv")); Start-MigrationBatch -Identity $StagedBatch1.Identity -``` - -This example creates and starts a migration batch for a staged Exchange migration. The example uses the New-MigrationEndpoint cmdlet to create a migration endpoint for the on-premises Exchange server, and then uses that endpoint to create the migration batch. The migration batch is started with the Start-MigrationBatch cmdlet. - -### -------------------------- Example 7 -------------------------- -``` -New-MigrationEndpoint -IMAP -Name IMAPEndpoint1 -RemoteServer imap.contoso.com -Port 993; New-MigrationBatch -Name IMAPbatch1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\IMAPmigration_1.csv")) -SourceEndpoint IMAPEndpoint1 -ExcludeFolders "Deleted Items","Junk Email" -``` - -This example creates a migration endpoint for the connection settings to the IMAP server. Then an IMAP migration batch is created that uses the CSV migration file IMAPmigration\_1.csv and excludes the contents of the Deleted Items and Junk Email folders. This migration batch is pending until it's started with the Start-MigrationBatch cmdlet. - -## PARAMETERS - -### -Name -The Name parameter specifies an unique name for the migration batch. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVData -The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://technet.microsoft.com/library/dn170437.aspx). - -Use the following format for the value of this parameter: ([System.IO.File]::ReadAllBytes(\<path of the CSV migration file\>)). For example: -CSVData ([System.IO.File]::ReadAllBytes("C:\\Users\\Administrator\\Desktop\\MigrationBatch\_1.csv")) - -```yaml -Type: Byte[] -Parameter Sets: Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, Abch -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Byte[] -Parameter Sets: Onboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 Directoryforest). You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Local -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePublicFolderDatabase -This parameter is available only in on-premises Exchange. - -The SourcePublicFolderDatabase parameter specifies the name of the source public folder database that's used in a public folder migration. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: LocalPublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserIds -The UserIds parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify a user by email address or by their Guid property value from the Get-MigrationUser cmdlet. You can specify multiple users separated by commas. - -The users that you specify for this parameter must be defined in an existing migration batch. - -To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: PreexistingUserIds -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Users -The Users parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify the users by using the Get-MigrationUser cmdlet. For example: - -$Failed = Get-MigrationUser -Status Failed - -New-MigrationBatch -Name "Retry Failed Users" -Users $Failed - -The users that you specify for this parameter must be defined in an existing migration batch. - -To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Preexisting -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllowIncrementalSyncs -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUnknownColumnsInCsv -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 columnswithmisspelledcolumn 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveOnly -The ArchiveOnlyswitchspecifies 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. - -You can use the TargetArchiveDatabases parameter to specify the database to migrate the archive mailboxes to. You can also specify the target archive database in the CSV file. If you don't specify the target archive database, the cmdlet uses the automatic mailbox distribution logic to select the database. - -```yaml -Type: SwitchParameter -Parameter Sets: Local, Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoComplete -The AutoCompleteswitch 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. - -If you don't use this switch, you need to run the Complete-MigrationBatch cmdlet to finalize a migration batch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoRetryCount -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. - -```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: False -Accept wildcard characters: False -``` - -### -AutoStart -The AutoStartswitch 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -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. - -```yaml -Type: Unlimited -Parameter Sets: Local, LocalPublicFolder, Onboarding, Offboarding, XO1, PublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompleteAfter -This parameter is available only in the could-based service. - -The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but won't complete until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -This parameter should only be used in the cloud-based service. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOnCopy -The DisableOnCopyswitch 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 -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisallowExistingUsers -This parameter is available only in on-premises Exchange. - -The DisallowExistingUsersswitch 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. - -A validation warning is displayed for any pre-existing mailbox in the target destination. - -```yaml -Type: SwitchParameter -Parameter Sets: Local, Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -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 -``` - -### -ExcludeDumpsters -This parameter is available only in the cloud-based service. - -The ExcludeDumpsters switch specifies whether to migrate 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. - -```yaml -Type: SwitchParameter -Parameter Sets: Onboarding -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFolders -This parameter is available only in the cloud-based service. - -For an IMAP migration, the ExcludeFolders parameter specifies mailbox folders that you don't want to migrate from the on-premises messaging system to the cloud-based mailboxes. Use folder names relative to the IMAP root on the on-premises mail server. Specify the value as a string array and separate multiple folder names with commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Onboarding -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. - -For more information about maximum message size values, see the following topics: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -```yaml -Type: Unlimited -Parameter Sets: LocalPublicFolder, Onboarding, Offboarding, PublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -This parameter is available only in on-premises Exchange. - -The Locale parameter specifies the language for the migration batch. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveOptions -The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. - -Don't use this parameter with the SkipMoving parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Local, Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEmails -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Local, LocalPublicFolder, PreexistingUserIds, Preexisting, Onboarding, Offboarding, PublicFolderToUnifiedGroup, WorkflowTemplate -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryOnly -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. - -Note : If the users don't have archive mailboxes, don't use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Local, Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderToUnifiedGroup -This parameter is available only in the cloud-based service. - -The PublicFolderToUnifiedGroup switch specifies a migration from public folders to Office 365 groups. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportInterval -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. - -This parameter should only be used in the cloud-based service. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -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: LocalPublicFolder, Onboarding, Offboarding, XO1 -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMoving -This parameter has been 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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Local, Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipReports -The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSteps -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) - -- 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. - -```yaml -Type: SkippableMigrationSteps[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceEndpoint -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) - -- GUID - -This parameter defines the settings that are used to connect to the server where the source mailboxes are located. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: Onboarding, PublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartAfter -This parameter is available only in the cloud-based service. - -The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 also specify multiple databases for the value of this parameter. The migration service selects one database as the target database to move the archive mailbox to. For example: -TargetArchiveDatabases @(MBXDB01,MBXDB02,MBXDB03) - -You can only use this parameter for local moves and remote move migrations. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Local, Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDatabases -The TargetDatabases parameter specifies the identity of the database that you're moving mailboxes to. You can use the following values: - -- Database GUID - -- Database name - -If you don't specify the TargetDatabases parameter for a local move, the cmdlet uses the automatic mailbox distribution logic to select the database. - -You can also specify multiple databases for the value of this parameter. The migration service will select one as the target database to move the mailbox to. For example: -TargetDatabases @(MBXDB01,MBXDB02,MBXDB03) - -You can only use this parameter for local moves and remote move migrations. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Local, Onboarding, Offboarding, XO1, Abch -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDeliveryDomain -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 - -```yaml -Type: String -Parameter Sets: Onboarding, Offboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetEndpoint -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) - -- GUID - -This parameter defines the settings that are used to connect to the destination server where the mailboxes will be moved. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: Offboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -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"). - -To see the available values, run the following command: $TimeZone = Get-ChildItem "HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Time zones" | foreach {Get-ItemProperty $\_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display - -If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. - -```yaml -Type: ExTimeZoneValue -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkflowControlFlags -The WorkflowControlFlags parameter specifies advanced controls for the steps that are performed in the migration. Valid values are: - -- None (This is the default value) - -- InjectAndForget - -- SkipSwitchover - -Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. - -```yaml -Type: MigrationWorkflowControlFlags -Parameter Sets: Local, Onboarding, XO1 -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkflowTemplate -The WorkflowControlFlags 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkloadType -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType -Parameter Sets: Local -Aliases: -Applicable: 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4f797f11-e4ef-48f9-83ab-dda8a3f61e2b.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/New-MigrationEndpoint.md b/exchange/exchange-ps/exchange/move-and-migration/New-MigrationEndpoint.md deleted file mode 100644 index 25339068ef..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/New-MigrationEndpoint.md +++ /dev/null @@ -1,799 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MigrationEndpoint -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-MigrationEndpoint cmdlet to configure the connection settings for cross-forests moves, remote move migrations, cutover or staged Exchange migrations and IMAP migrations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ExchangeRemoteMoveAutoDiscover -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Autodiscover] [-ExchangeRemoteMove] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-WhatIf] [<CommonParameters>] -``` - -### ExchangeOutlookAnywhereAutoDiscover -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Autodiscover] [-ExchangeOutlookAnywhere] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-SourceMailboxLegacyDN <String>] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ExchangeOutlookAnywhere -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> [-EmailAddress <SmtpAddress>] [-ExchangeOutlookAnywhere] [-ExchangeServer <String>] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] - [-DomainController <Fqdn>] - [-MailboxPermission <Admin | FullAccess>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-NspiServer <String>] - [-Partition <MailboxIdParameter>] - [-RpcProxyServer <Fqdn>] - [-SkipVerification] - [-SourceMailboxLegacyDN <String>] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ExchangeRemoteMove -``` -New-MigrationEndpoint -Name <String> -RemoteServer <Fqdn> [-Credentials <PSCredential>] [-ExchangeRemoteMove] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-WhatIf] [<CommonParameters>] -``` - -### PSTImport -``` -New-MigrationEndpoint -Name <String> -RemoteServer <Fqdn> [-Credentials <PSCredential>] [-PSTImport] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-WhatIf] [<CommonParameters>] -``` - -### IMAP -``` -New-MigrationEndpoint -Name <String> -RemoteServer <Fqdn> [-IMAP] [-Port <Int32>] [-Security <None | Ssl | Tls>] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-WhatIf] [<CommonParameters>] -``` - -### PublicFolder -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -PublicFolderDatabaseServerLegacyDN <String> -RpcProxyServer <Fqdn> -SourceMailboxLegacyDN <String> [-PublicFolder] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Compliance -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -RemoteServer <Fqdn> [-Compliance] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-WhatIf] [<CommonParameters>] -``` - -### MrsProxyPublicFolderToUnifiedGroup -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -RemoteServer <Fqdn> [-PublicFolderToUnifiedGroup] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### MrsProxyPublicFolder -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -RemoteServer <Fqdn> [-PublicFolder] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-WhatIf] [<CommonParameters>] -``` - -### LegacyPublicFolderToUnifiedGroup -``` -New-MigrationEndpoint -Name <String> -Credentials <PSCredential> -PublicFolderDatabaseServerLegacyDN <String> -RpcProxyServer <Fqdn> -SourceMailboxLegacyDN <String> [-PublicFolderToUnifiedGroup] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] - [-DomainController <Fqdn>] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Other -``` -New-MigrationEndpoint -Name <String> [-EmailAddress <SmtpAddress>] - [-Confirm] - [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] - [-Partition <MailboxIdParameter>] - [-SkipVerification] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-MigrationEndpoint cmdlet configures the connection settings for different types of migrations: - -- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a Remote Move endpoint. - -- Remote move migration: In a hybrid deployment, a remote move migration involves onboarding or offboarding migrations. Remote move migrations also require the use of an Exchange remote move endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online in Office 365, and uses a remote move endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online in Office 365 to an on-premises Exchange organization and uses a remote move endpoint as the target endpoint of the migration batch. - -- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online in Office 365. A cutover Exchange migration requires the use of an Outlook Anywhere migration endpoint. - -- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online in Office 365. A staged Exchange migration requires the use of an Outlook Anywhere migration endpoint. - -- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online in Office 365. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MigrationEndpoint -Name Endpoint1 -ExchangeRemoteMove -Autodiscover -EmailAddress tonysmith@contoso.com -Credentials (Get-Credential contoso\tonysmith) -``` - -This example creates an endpoint for remote moves by using the Autodiscover parameter to detect the settings. - -### -------------------------- Example 2 -------------------------- -``` -New-MigrationEndpoint -Name Endpoint2 -ExchangeRemoteMove -RemoteServer MRSServer.contoso.com -Credentials (Get-Credential Contoso.com\Administrator) -``` - -This example creates an endpoint for remote moves by specifying the settings manually. - -### -------------------------- Example 3 -------------------------- -``` -$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\\user name format for the administrator account. This account can be the same one that is specified by the EmailAddress parameter. - -### -------------------------- Example 4 -------------------------- -``` -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. - -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. - -### -------------------------- Example 5 -------------------------- -``` -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. - -### -------------------------- Example 6 -------------------------- -``` -New-MigrationEndpoint -IMAP -Name IMAP_TLS_Endpoint -RemoteServer imap.contoso.com -Port 143 -Security Tls -MaxConcurrentMigrations 50 -MaxConcurrentIncrementalSyncs 10 -``` - -This example creates an IMAP migration endpoint that supports 50 concurrent migrations and 10 concurrent incremental synchronizations. The endpoint is configured to use port 143 for TLS encryption. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Autodiscover -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Compliance -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMove, PSTImport -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SmtpAddress -Parameter Sets: ExchangeOutlookAnywhere, Other -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: SwitchParameter -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeRemoteMove -The ExchangeRemoteMoveswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IMAP -This parameter is available only in the cloud-based service. - -The IMAPswitch specifies the type of endpoint for IMAP migrations. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: IMAP -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PSTImport -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: PSTImport -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder, MrsProxyPublicFolder -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderDatabaseServerLegacyDN -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderToUnifiedGroup -The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Office 365 groups. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteServer -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. - -- For IMAP migrations, this parameter refers to the IMAP server. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcProxyServer -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. - -This parameter is required only when you don't use the Autodiscover parameter. - -```yaml -Type: Fqdn -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Fqdn -Parameter Sets: ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceMailboxLegacyDN -This parameter is available only in the cloud-based service. - -The SourceMailboxLegacyDN parameter specifies the LegacyExchangeDNvalue 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 -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -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. - -```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured -Parameter Sets: ExchangeOutlookAnywhere, IMAP, PublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, ExchangeRemoteMove, PSTImport, IMAP, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup -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 -``` - -### -ExchangeServer -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. - -This parameter is required only when you don't use the Autodiscover parameter. - -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxPermission -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). - -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. - -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. - -This parameter can't be used for creating non-Outlook Anywhere migration endpoints. - -```yaml -Type: Admin | FullAccess -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxConcurrentIncrementalSyncs -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxConcurrentMigrations -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NspiServer -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. - -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -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. - -```yaml -Type: Int32 -Parameter Sets: IMAP -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Security -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. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: IMAP -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipVerification -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestMailbox -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. If this parameter isn't specified, the migration service uses the migration arbitration mailbox in the Exchange Online organization to verify the connection. - -This parameter is only used to create Outlook Anywhere migration endpoints. - -```yaml -Type: MailboxIdParameter -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, Other -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0383b4ea-10df-4e1d-9470-2eeb9fd1ea68.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/New-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/New-PublicFolderMigrationRequest.md deleted file mode 100644 index b0324244c1..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/New-PublicFolderMigrationRequest.md +++ /dev/null @@ -1,564 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PublicFolderMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-PublicFolderMigrationRequest - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-PublicFolderMigrationRequest cmdlet to begin the process of migrating public folders from Exchange Server 2010. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MigrationOutlookAnywherePublicFolder -``` -New-PublicFolderMigrationRequest [[-Name] <String>] -OutlookAnywhereHostName <Fqdn> -RemoteCredential <PSCredential> -RemoteMailboxLegacyDN <String> -RemoteMailboxServerLegacyDN <String> - [-AcceptLargeDataLoss] - [-AuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-CSVData <Byte[]>] - [-CSVStream <Stream>] - [-LargeItemLimit <Unlimited>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-Suspend] - [-SuspendComment <String>] - [-WhatIf] - [<CommonParameters>] -``` - -### Default -``` -New-PublicFolderMigrationRequest [[-Name] <String>] -SourceDatabase <DatabaseIdParameter> - [-AcceptLargeDataLoss] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-CSVData <Byte[]>] - [-CSVStream <Stream>] - [-DomainController <Fqdn>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-MigrationMailbox <MailboxIdParameter>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-SourceEndpoint <MigrationEndpointIdParameter>] - [-Suspend] - [-SuspendComment <String>] - [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [<CommonParameters>] -``` - -## DESCRIPTION -Migrating public folders is a multi-step process. For more information before you attempt a public folder migration, see Use serial migration to migrate public folders to Exchange 2013 from previous versions (https://technet.microsoft.com/library/jj150486.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PublicFolderMigrationRequest -SourceDatabase PFDB01 -CSVData (Get-Content C:\PFMigration\CSVData.csv -Encoding Byte) -``` - -This example creates a public folder migration request from the Exchange 2010 source public folder database PFDB01 and uses the CSVData.csv file that was created using the Export-PublicFolderStatistics.ps1 script. For more information, see Use serial migration to migrate public folders to Exchange 2013 from previous versions (https://technet.microsoft.com/library/jj150486.aspx). - -## PARAMETERS - -### -OutlookAnywhereHostName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteCredential -This parameter is available only in the cloud-based service. - -The RemoteCredential parameter specifies an administrator who has permission to perform the migration request, for example, Administrator@humongousinsurance.com. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -You must use this parameter in conjunction with the RemoteMailboxServerLegacyDN parameter. - -```yaml -Type: PSCredential -Parameter Sets: MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteMailboxLegacyDN -This parameter is available only in the cloud-based service. - -The RemoteMailboxLegacyDN parameter specifies the mailbox of the remote credentials specified in the RemoteCredential parameter. - -You must use this parameter in conjunction with the RemoteMailboxServerLegacyDN parameter. - -```yaml -Type: String -Parameter Sets: MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteMailboxServerLegacyDN -This parameter is available only in the cloud-based service. - -The RemoteMailboxServerLegacyDN parameter specifies the server legacy distinguished name (DN) of the back-end server. To find the LegacyExchangeServerDN property, run the following command: Get-ExchangeServer \<Identity\> | Format-List LegacyExchangeServerDN. - -```yaml -Type: String -Parameter Sets: MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabase -This parameter is available only in on-premises Exchange. - -The SourceDatabase parameter specifies the identity of the database on which the public folders that are being migrated resides. You can use the following values: - -- GUID of the database - -- Database name - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationMethod -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured -Parameter Sets: MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchName -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompletedRequestAgeLimit -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVData -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 Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -You can't use this parameter with the CSVStream parameter, but you need to use it if you don't use CSVStream parameter. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVStream -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. - -```yaml -Type: Stream -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: Default -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 -``` - -### -InternalFlags -The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. - -```yaml -Type: InternalMrsFlag[] -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -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: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationMailbox -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the public folder migration request. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Priority -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: - -- Lowest - -- Lower - -- Low - -- Normal: This is the default value. - -- High - -- Higher - -- Highest - -- Emergency - -```yaml -Type: Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency -Parameter Sets: Default -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 -``` - -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceEndpoint -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendComment -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkloadType -This parameter is available only in on-premises Exchange. - -The WorkloadType parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4537bb70-8806-4e23-b596-6dbf9f85e84d.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/New-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/New-PublicFolderMoveRequest.md deleted file mode 100644 index 5028a559c7..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/New-PublicFolderMoveRequest.md +++ /dev/null @@ -1,388 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-PublicFolderMoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-PublicFolderMoveRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-PublicFolderMoveRequest cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the Remove-PublicFolderMoveRequest cmdlet to remove the request or wait until the time specified in the CompletedRequestAgeLimit parameter has passed. The request must be removed before you can run another move request. - -Be aware that the target public folder mailbox will be locked while the move request is active. See the Detailed Description section below for more details. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PublicFolderMoveRequest -Folders <PublicFolderIdParameter[]> -TargetMailbox <MailboxIdParameter> - [-AcceptLargeDataLoss] [-AllowLargeItems] [-BadItemLimit <Unlimited>] [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] [-DomainController <Fqdn>] [-InternalFlags <InternalMrsFlag[]>] [-Name <String>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] [-Suspend] - [-SuspendComment <String>] [-SuspendWhenReadyToComplete] [-WhatIf] - [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport>] - [-RequestExpiryInterval <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-PublicFolderMoveRequest cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox will be locked. As a result, public folders already residing in the target public folder mailbox will be inaccessible until the move request is complete. Therefore, before you begin the move request, you should make sure no users are accessing public folder data in that target public folder mailbox. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PublicFolderMoveRequest -Folders \DeveloperReports\CustomerEngagements -TargetMailbox DeveloperReports01 -``` - -This example begins the move request for the public folder \\CustomerEngagements from public folder mailbox DeveloperReports to DeveloperReports01. - -### -------------------------- Example 2 -------------------------- -``` -New-PublicFolderMoveRequest -Folders \Dev\CustomerEngagements,\Dev\RequestsforChange,\Dev\Usability -TargetMailbox DeveloperReports01 -``` - -This example begins the move request for public folders under the \\Dev public folder branch to the target public folder mailbox DeveloperReports01. - -You can also move a branch of public folders by using the Move-PublicFolderBranch.ps1 script. - -### -------------------------- Example 3 -------------------------- -``` -$folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity};New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders -``` - -This example moves all public folders from public folder mailbox Pub1 to public folder mailbox Pub2. - -## PARAMETERS - -### -Folders -The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability. - -```yaml -Type: PublicFolderIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetMailbox -The TargetMailbox parameter specifies the target public folder mailbox that you want to move the public folders to. This parameter accepts the following: - -- Alias - -- Canonical DN - -- Display name - -- Distinguished name (DN) - -- Domain\\Account - -- GUID - -- ImmutableId - -- SMTP address - -- User principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowLargeItems -The AllowLargeItems parameter specifies that you can move large items only when large items are encountered. Large items are email messages with a maximum of 1,023 attachments. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalFlags -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - -- Lowest - -- Lower - -- Low - -- Normal: This is the default value. - -- High - -- Higher - -- Highest - -- Emergency - -```yaml -Type: Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendComment -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendWhenReadyToComplete -The SuspendWhenReadyToComplete switch specifies whether to suspend the request before it reaches the status of CompletionInProgress. After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkloadType -The WorkloadType parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation | RemotePstExport -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d046e950-ac45-4cfd-99ae-d09b8d725615.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationBatch.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationBatch.md deleted file mode 100644 index fe2ca94a34..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationBatch.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationBatch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MigrationBatch cmdlet to delete a migration batch that either isn't running or has been completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Confirm] [-DomainController <Fqdn>] [-Force] [-Partition <MailboxIdParameter> - [-WhatIf]] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-MigrationBatch cmdlet removes a migration batch. All subscriptions are deleted and any object related to the migration batch is also deleted. - -If you use the Force parameter with this cmdlet, the individual user requests and subscriptions that were part of the removed migration batch aren't removed. You have to remove the individual migration user requests with the Remove-MigrationUser \<Identity\> -Force 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MigrationBatch -Identity Cutover1 -``` - -This example removes the migration batch Cutover1. - -### -------------------------- Example 2 -------------------------- -``` -Remove-MigrationBatch -Identity LocalMove1 -Force -``` - -This example removes the corrupted migration batch LocalMove1. - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is available only in on-premises Exchange. - -The Force switch specifies whether to remove a corrupted migration batch. Corrupted migration batches have a status of Corrupted. If you try to remove a corrupted migration batch without using this switch, you receive an error saying the migrated batch can't be found. - -If you use this parameter to remove a corrupted migration batch, the individual user requests (also called job items) and subscriptions that were part of the removed migration batch aren't removed. You have to remove the individual migration user requests with the Remove-MigrationUser \<Identity\> -Force command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/59eb82ed-8210-41c1-a74b-8d783af3c391.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationEndpoint.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationEndpoint.md deleted file mode 100644 index 21957bab21..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationEndpoint.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationEndpoint -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MigrationEndpoint cmdlet to remove existing migration endpoints for source or destination servers for cutover or staged Exchange migrations, IMAP migrations and remote moves. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MigrationEndpoint [-Identity] <MigrationEndpointIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-MigrationEndpoint cmdlet to remove an existing migration endpoint. - -For more information about migration endpoints, see Set-MigrationEndpoint and 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MigrationEndpoint -Identity CrossForestME01 -``` - -This example removes the migration endpoint CrossForestME01. - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/11e5d978-5e9f-4694-b29a-e63314f626c4.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationUser.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationUser.md deleted file mode 100644 index a213f8db0a..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-MigrationUser.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationUser -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MigrationUser cmdlet to remove a migration user from a batch. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MigrationUser [-Identity] <MigrationUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] [-Partition <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MigrationUser -Identity TonySmith -``` - -This example removes the migration user Tony Smith from a migration batch. - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is available only in on-premises Exchange. - -The Force switch specifies that some specific checks and removal steps should be skipped and that the migration user should be forcibly removed. This parameter is used to work around issues where the migration user needs to be removed to fix issues when the user or data is corrupted, or to prevent such issues from occurring. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/db6a2233-c413-42a0-a264-f65a2733ad09.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-MoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-MoveRequest.md deleted file mode 100644 index 10921a1849..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-MoveRequest.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Remove-MoveRequest [-Identity] <MoveRequestIdParameter> [-Force] - [-Confirm] - [-DomainController <Fqdn>] - [-ProxyToMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### MigrationMoveRequestQueue -``` -Remove-MoveRequest -MailboxGuid <Guid> -MoveRequestQueue <DatabaseIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-ProxyToMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -In coexistence environments with Exchange 2010 and newer versions of Exchange, don't run newer versions of Remove-MoveRequest to clear completed Exchange 2010 move requests as documented in Clear or Remove Move Requests (https://technet.microsoft.com/library/dd351276.aspx). If you do, you could delete the mailbox that you just moved. Instead, only use the Exchange 2010 version of Remove-MoveRequest to clear completed Exchange 2010 move requests in coexistence environments. - -In Exchange 2010, you need to use the Remove-MoveRequest cmdlet on completed move requests to clear the InTransit flag from the mailbox. This step isn't required for mailbox moves in newer versions of Exchange where the Remove-MoveRequest is only used to cancel existing move requests. - -The MoveRequestQueue and MailboxGuid parameters are for debugging purposes only. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MoveRequest -Identity 'Ayla@humongousinsurance.com' -``` - -This example removes the mailbox move request for Ayla Kol's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Remove-MoveRequest -MoveRequestQueue MBXDB01 -MailboxGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f -``` - -This example cancels a mailbox move for a mailbox by using the MailboxGuid parameter for a mailbox on MBXDB01. - -The MailboxGuid and MoveRequestQueue parameters are for debugging purposes only. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -You can't use this parameter in conjunction with the MailboxGuid or MoveRequestQueue parameters. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MailboxGuid -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. - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: Guid -Parameter Sets: MigrationMoveRequestQueue -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveRequestQueue -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 the following values: - -- GUID of the database - -- Database name - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MigrationMoveRequestQueue -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -ProxyToMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/25e0eaf2-6cc2-4353-b83e-5cb7b72d441f.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md deleted file mode 100644 index ae335cbf35..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PublicFolderMailboxMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-PublicFolderMailboxMigrationRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-PublicFolderMailboxMigrationRequest cmdlet to remove individual jobs from public folder migration batches that were created by using the New-MigrationBatch cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Remove-PublicFolderMailboxMigrationRequest [-Identity] <PublicFolderMailboxMigrationRequestIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### MigrationRequestQueue -``` -Remove-PublicFolderMailboxMigrationRequest -RequestGuid <Guid> -RequestQueue <DatabaseIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-PublicFolderMailboxMigrationRequest cmdlet is intended for troubleshooting and should be used under the direction 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PublicFolderMailboxMigrationRequest -Identity \PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e -``` - -This example removes the specified public folder mailbox migration request. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to remove. This value uses the syntax \\PublicFolderMailboxMigration\<GUID\> (for example, \\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e). - -You can't use this parameter with the RequestGuid or RequestQueue parameters. - -```yaml -Type: PublicFolderMailboxMigrationRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RequestGuid -The RequestGuid parameter specifies the unique RequestGuid identifier of the request. To find the RequestGuid value, use the Get-PublicFolderMailboxMigrationRequest cmdlet. - -If you use this parameter, you also need to use the RequestQueue parameter. You can't use either of these parameters with the Identity parameter. - -```yaml -Type: Guid -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestQueue -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3921f9da-77c9-4943-b184-436a1a9875b3.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md deleted file mode 100644 index 4dd63685ac..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-PublicFolderMigrationRequest - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-PublicFolderMigrationRequest cmdlet to cancel or complete a migration request that was initiated using the New-PublicFolderMigrationRequest cmdlet. You use must this cmdlet to remove the public folder migration request before you can create another public folder migration request. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Remove-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### MigrationRequestQueue -``` -Remove-PublicFolderMigrationRequest -RequestGuid <Guid> -RequestQueue <DatabaseIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The RequestQueue and RequestGuid 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderMigrationRequest | Remove-PublicFolderMigrationRequest -``` - -This example cancels any public folder migration request that's actively running. - -### -------------------------- Example 2 -------------------------- -``` -Remove-PublicFolderMigrationRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f -``` - -This example cancels a migration request by using the RequestGuid parameter for a mailbox on MBXDB01. - -The RequestGuid and RequestQueue parameters are for debugging purposes only. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the public folder migration request. - -You can't use this parameter in conjunction with the RequestGuid or RequestQueue parameters. - -```yaml -Type: PublicFolderMigrationRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RequestGuid -This parameter is available only in on-premises Exchange. - -The RequestGuid parameter specifies the GUID of the migration request. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. - -You can't use this parameter in conjunction with the Identity parameter. - -```yaml -Type: Guid -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestQueue -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2f884fb1-2b00-428c-994a-66b8d82deea4.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md deleted file mode 100644 index 2a8c5e27ea..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PublicFolderMoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-PublicFolderMoveRequest - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Remove-PublicFolderMoveRequest [-Identity] <PublicFolderMoveRequestIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### MigrationRequestQueue -``` -Remove-PublicFolderMoveRequest -RequestGuid <Guid> -RequestQueue <DatabaseIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The RequestQueue and RequestGuid 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PublicFolderMoveRequest -Identity \PublicFolderMove -``` - -This example removes the public folder move request \\PublicFolderMove. - -### -------------------------- Example 2 -------------------------- -``` -Remove-PublicFolderMoveRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f -``` - -This example cancels a public folder move by using the RequestGuid parameter for a public folder move request on MBXDB01. - -The RequestGuid and RequestQueue parameters are for debugging purposes only. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. - -You can't use this parameter in conjunction with the RequestGuid or RequestQueue parameter. - -```yaml -Type: PublicFolderMoveRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RequestGuid -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 in conjunction with the Identity parameter. - -```yaml -Type: Guid -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestQueue -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: - -- Database GUID - -- Database name - -You can't use this parameter with the Identity parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: MigrationRequestQueue -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4b32356b-c893-41ad-80ab-4a7dbce54bbc.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Resume-MoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Resume-MoveRequest.md deleted file mode 100644 index d7c594394d..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Resume-MoveRequest.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Resume-MoveRequest cmdlet to resume a move request that has been suspended or has failed. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Resume-MoveRequest [-Identity] <MoveRequestIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [-ProxyToMailbox <MailboxIdParameter>] [-SuspendWhenReadyToComplete] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-MoveRequest -Identity "Tony@contoso.com" -``` - -This example resumes the move request of Tony Smith's mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-MoveRequest -MoveStatus Failed | Resume-MoveRequest -``` - -This example resumes any failed move requests. - -### -------------------------- Example 3 -------------------------- -``` -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." - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SMTP address - -- Alias - -```yaml -Type: MoveRequestIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyToMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendWhenReadyToComplete -The SuspendWhenReadyToCompleteswitch specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the CompleteAfter parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2e8143b6-0c47-4afa-92ac-e6a251088345.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md deleted file mode 100644 index a572e68912..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-PublicFolderMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Resume-PublicFolderMigrationRequest - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Resume-PublicFolderMigrationRequest cmdlet to resume a migration request that failed or has been suspended or auto-suspended. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Resume-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-PublicFolderMigrationRequest -Identity "PublicFolderMigration" -``` - -This example resumes the migration request PublicFolderMigration. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMigrationRequest -Status Failed | Resume-PublicFolderMigrationRequest -``` - -This example resumes any failed migration requests. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the migration request. This parameter accepts the following values: - -- GUID - -- Name - -```yaml -Type: PublicFolderMigrationRequestIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/af8602ce-0dba-4f89-b993-0ba02624e567.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md deleted file mode 100644 index 6490f34060..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-PublicFolderMoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Resume-PublicFolderMoveRequest - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Resume-PublicFolderMoveRequest [-Identity] <PublicFolderMoveRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-PublicFolderMoveRequest -Identity \PublicFolderMove -``` - -This example resumes the public folder move request \\PublicFolderMove. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMoveRequest -MoveStatus Failed | Resume-PublicFolderMoveRequest -``` - -This example resumes failed public folder move requests. - -### -------------------------- Example 3 -------------------------- -``` -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." - -## PARAMETERS - -### -Identity -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 -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 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/14d01726-06e9-4706-b8ab-4cdd17457911.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationBatch.md b/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationBatch.md deleted file mode 100644 index 42d06ff27e..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationBatch.md +++ /dev/null @@ -1,488 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationBatch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see New-MigrationBatch. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MigrationBatch [-Identity] <MigrationBatchIdParameter> [-AllowIncrementalSyncs <$true | $false>] - [-AllowUnknownColumnsInCsv <$true | $false>] [-AutoRetryCount <Int32>] [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] [-Confirm] [-CSVData <Byte[]>] [-DomainController <Fqdn>] - [-LargeItemLimit <Unlimited>] [-NotificationEmails <MultiValuedProperty>] [-ReportInterval <TimeSpan>] - [-SourcePublicFolderDatabase <DatabaseIdParameter>] [-StartAfter <DateTime>] [-WhatIf] - [-MoveOptions <MultiValuedProperty>] [-Partition <MailboxIdParameter>] [-SkipMerging <MultiValuedProperty>] - [-SkipMoving <MultiValuedProperty>] [-SkipReports <$true | $false>] [-SyncNow] [-Update] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-MigrationBatch cmdlet configures your existing migration batches to migrate mailboxes and mailbox data in one of the following scenarios: - -- Local move - -- Cross-forest move - -- Remote move - -- Cutover Exchange migration - -- Staged Exchange migration - -- IMAP 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MigrationBatch -Identity MigrationBatch01 -AutoRetryCount 5 -AllowIncrementalSyncs $true -``` - -This example updates MigrationBatch01 with new AutoRetryCount and AllowIncrementalSyncs parameter settings. - -## PARAMETERS - -### -Identity -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) - -- GUID (the BatchGuid property value) - -```yaml -Type: MigrationBatchIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllowIncrementalSyncs -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUnknownColumnsInCsv -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoRetryCount -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. - -```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: False -Accept wildcard characters: False -``` - -### -BadItemLimit -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompleteAfter -This parameter is available 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 won't complete until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVData -This parameter is available only in on-premises Exchange. - -The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. Use the following format for the value of this parameter: ([System.IO.File]::ReadAllBytes(\<path of the CSV migration file\>)). For example: -CSVData ([System.IO.File]::ReadAllBytes("C:\\Users\\Administrator\\Desktop\\MigrationBatch\_1.csv")) - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -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 -``` - -### -LargeItemLimit -The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. - -For more information about maximum message size values, see the following topics: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveOptions -The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. - -Don't use this parameter with the SkipMoving parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEmails -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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportInterval -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. - -This parameter should only be used in the cloud-based service. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMoving -This parameter has been 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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipReports -The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePublicFolderDatabase -This parameter is available only in on-premises Exchange. - -The SourcePublicFolderDatabase parameter specifies the name of the source public folder database that's used in a public folder migration. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartAfter -This parameter is available only in the cloud-based service. - -The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration will be prepared, but the actual data migration for users within the batch won't start until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -This parameter should only be used in the cloud-based service. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -SyncNow -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Update -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/730ebc07-298f-46a1-b424-dc404ef21fdf.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationConfig.md b/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationConfig.md deleted file mode 100644 index 802c3a55f9..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationConfig.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-MigrationConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-MigrationConfig cmdlet to edit migration configurations on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MigrationConfig [-Confirm] [-DomainController <Fqdn>] - [-Features <None | MultiBatch | Endpoints | UpgradeBlock | PAW>] [-MaxConcurrentMigrations <Unlimited>] - [-MaxNumberOfBatches <Int32>] [-WhatIf] [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MigrationConfig -MaxNumberOfBatches 50 -``` - -This example sets the migration system to have a maximum of 50 batches at any time. - -### -------------------------- Example 2 -------------------------- -``` -Set-MigrationConfig -MaxConcurrentMigrations 100 -``` - -This example sets the migration system to only allow 100 concurrent migrations. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Features -The Features parameter specifies the set of features to enable for the migration system. Use one of the following values: - -- None - -- MultiBatch - -- Endpoints - -- UpgradeBlock - -```yaml -Type: None | MultiBatch | Endpoints | UpgradeBlock | PAW -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxConcurrentMigrations -The MaxConcurrentMigrations parameter specifies the maximum number of active migrations that your organization can run at any specific time. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxNumberOfBatches -The MaxNumberOfBatches parameter specifies the maximum number of batches that your organization can migrate at any time. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/641aaeb0-3a1b-4cc8-9092-07c9013d77e5.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationEndpoint.md b/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationEndpoint.md deleted file mode 100644 index de1015bf02..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationEndpoint.md +++ /dev/null @@ -1,427 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationEndpoint -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MigrationEndpoint cmdlet to edit settings for cutover or staged Exchange migrations, IMAP migrations and remote moves. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MigrationEndpoint [-Identity] <MigrationEndpointIdParameter> - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] [-Credentials <PSCredential>] [-DomainController <Fqdn>] [-ExchangeServer <String>] - [-MailboxPermission <Admin | FullAccess>] [-MaxConcurrentIncrementalSyncs <Unlimited>] - [-MaxConcurrentMigrations <Unlimited>] [-NspiServer <String>] - [-Port <Int32>] [-RemoteServer <Fqdn>] [-RpcProxyServer <Fqdn>] [-Security <None | Ssl | Tls>] - [-SkipVerification] [-SourceMailboxLegacyDN <String>] [-TestMailbox <MailboxIdParameter>] [-WhatIf] - [-Partition <MailboxIdParameter>] [-PublicFolderDatabaseServerLegacyDN <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-MigrationEndpoint cmdlet to configure settings for different types of migration: - -- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a RemoteMove endpoint. - -- Remote move: In a hybrid deployment, a remote move involves onboarding or offboarding migrations. Remote moves require the use of a RemoteMove endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online in Office 365, and uses a RemoteMove endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online in Office 365 to an on-premises Exchange organization and uses a RemoteMove endpoint as the target endpoint of the migration batch. - -- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online in Office 365. Cutover Exchange migration requires the use of an Exchange endpoint. - -- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online in Office 365. Staged Exchange migration requires the use of an Exchange endpoint. - -- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online in Office 365. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. - -- Local: Move mailboxes between different servers or databases within a single on-premises Exchange forest. Local moves don't require the use of an endpoint. - -For more information about the different move and migration scenarios, see: - -- Mailbox moves (https://technet.microsoft.com/library/jj150543.aspx) - -- Manage on-premises mailbox moves (https://technet.microsoft.com/library/jj150487.aspx) - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MigrationEndpoint -Identity CutoverExchangeEndpoint01 -MaxConcurrentIncrementalSyncs 50 -NspiServer Server01.contoso.com -``` - -This example changes the MaxConcurrentIncrementalSyncs setting to 50 on the CutoverExchangeEndpoint01 migration endpoint using the NSPI server Server01. - -### -------------------------- Example 2 -------------------------- -``` -Set-MigrationEndpoint -Identity Onboardingmigrationendpoint01 -MaxConcurrentMigrations 10 -RemoteServer Server01.contoso.com -``` - -This example changes the MaxConcurrentMigrations setting to 10 on the Onboardingmigrationendpoint01 migration endpoint using the remote server, Server01. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Authentication -This parameter is available only in the cloud-based service. - -The Authentication parameter specifies the authentication method used by the remote mail server. - -```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -Credentials -The Credentials parameter specifies the credentials to use for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeServer -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxPermission -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. - -The account specified must have the following permissions: - -- FullAccess permission. The account has Full-Access permission to the mailboxes they want to migrate. - -- Admin permission. The account is a domain administrator who can access any mailbox they want to migrate. - -```yaml -Type: Admin | FullAccess -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxConcurrentIncrementalSyncs -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NspiServer -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteServer -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. - -- IMAP moves: The FQDN of the IMAP server. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RpcProxyServer -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 - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Security -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. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipVerification -The SkipVerification switch specifies whether to skip verifying that the remote server is reachable when creating a migration endpoint. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceMailboxLegacyDN -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestMailbox -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. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderDatabaseServerLegacyDN -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bebd0d6e-0bae-416b-a596-81dba35b4bab.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationUser.md b/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationUser.md deleted file mode 100644 index f91edec122..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-MigrationUser.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Set-MigrationUser -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-MigrationUser - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-MigrationUser cmdlet to modify the migration settings of a user in an existing migration batch. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MigrationUser [-Identity] <MigrationUserIdParameter> [-BadItemLimit <Unlimited>] - [-CompleteAfter <DateTime>] [-Confirm] [-DomainController <Fqdn>] [-LargeItemLimit <Unlimited>] - [-Partition <MailboxIdParameter>] [-StartAfter <DateTime>] [-SyncNow] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MigrationUser -Identity laura@contoso.com -LargeItemLimit 15 -BadItemLimit 15 -``` - -This example changes the large item limit and bad item limit for the user laura@contoso.com in an existing migration batch. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: MigrationUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BadItemLimit -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompleteAfter -This parameter is available only in the cloud-based service. - -The CompleteAfter parameter specifies a delay before the user is completed. Data migration for the user will start, but won't complete until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. - -For more information about maximum message size values, see the following topics: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartAfter -This parameter is available only in the cloud-based service. - -The StartAfter parameter specifies a delay before the data migration for the user is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncNow -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4c8642ad-0844-457a-af41-45feec280906.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Set-MoveRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Set-MoveRequest.md deleted file mode 100644 index 5ab3c5cef7..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-MoveRequest.md +++ /dev/null @@ -1,640 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MoveRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MoveRequest cmdlet to change move request options after the move request has been created. You can use the Set-MoveRequest cmdlet to recover from failed move requests. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MoveRequest [-Identity] <MoveRequestIdParameter> [-AcceptLargeDataLoss] [-BadItemLimit <Unlimited>] - [-BatchName <String>] [-Confirm] [-DomainController <Fqdn>] [-IgnoreRuleLimitErrors <$true | $false>] - [-Priority <Normal | High>] [-Protect <$true | $false>] [-RemoteCredential <PSCredential>] - [-RemoteGlobalCatalog <Fqdn>] [-RemoteHostName <Fqdn>] [-SuspendWhenReadyToComplete <$true | $false>] - [-WhatIf] [-ArchiveTargetDatabase <DatabaseIdParameter>] [-CompleteAfter <DateTime>] - [-CompletedRequestAgeLimit <Unlimited>] [-IncrementalSyncInterval <TimeSpan>] - [-InternalFlags <InternalMrsFlag[]>] [-LargeItemLimit <Unlimited>] [-PreventCompletion <$true | $false>] - [-SkipMoving <SkippableMoveComponent[]>] [-StartAfter <DateTime>] [-TargetDatabase <DatabaseIdParameter>] - [-MigrationMailbox <MailboxIdParameter>] [-MoveOptions <MultiValuedProperty>] - [-ProxyToMailbox <MailboxIdParameter>] [-RequestExpiryInterval <Unlimited>] - [-SourceEndpoint <MigrationEndpointIdParameter>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MoveRequest -Identity Ayla@humongousinsurance.com -BadItemLimit 5 -``` - -This example changes the move request for Ayla to accept up to five corrupt mailbox items. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SMTP address - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreRuleLimitErrors -The IgnoreRuleLimitErrors parameter specifies that the command won't move the user's rules to the target server running Microsoft Exchange. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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: - -- Lowest - -- Lower - -- Low - -- Normal: This is the default value. - -- High - -- Higher - -- Highest - -- Emergency - -```yaml -Type: Normal | High -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 -``` - -### -Protect -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -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 -``` - -### -RemoteCredential -The RemoteCredential parameter specifies an administrator who has permission to perform the mailbox move, for example, Administrator@ humongousinsurance.com. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteGlobalCatalog -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHostName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendWhenReadyToComplete -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveTargetDatabase -This parameter is available only in on-premises Exchange. - -The ArchiveTargetDatabase parameter specifies the Exchange target database to which you're moving the personal archive. You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued. - -You can use the following values to specify the target database: - -- GUID of the database - -- Database name - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompleteAfter -The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompletedRequestAgeLimit -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 -Default value: None -Accept pipeline input: False -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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is 24 hours. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalFlags -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. - -```yaml -Type: InternalMrsFlag[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -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: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventCompletion -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMoving -This parameter has been 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. - -```yaml -Type: SkippableMoveComponent[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartAfter -The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDatabase -This parameter is available only in on-premises Exchange. - -The TargetDatabase parameter specifies the identity of the database that you're moving the mailbox to. You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued. - -You can use the following values: - -- GUID of the database - -- Database name - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationMailbox -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveOptions -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyToMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceEndpoint -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1a668f96-e924-4698-9387-ee71f8d9b136.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md deleted file mode 100644 index aaf92727ad..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md +++ /dev/null @@ -1,461 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-PublicFolderMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-PublicFolderMigrationRequest - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-PublicFolderMigrationRequest cmdlet to change migration request options after the request has been created. You can use the Set-PublicFolderMigrationRequest cmdlet to recover from failed migration requests. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Rehome -``` -Set-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> [-RehomeRequest] - [-Confirm] - [-DomainController <Fqdn>] - [-PreventCompletion <$true | $false>] - [-RequestExpiryInterval <Unlimited>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> [-AcceptLargeDataLoss] - [-AuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-BadItemLimit <Unlimited>] - [-BatchName <String>] - [-CompletedRequestAgeLimit <Unlimited>] - [-Confirm] - [-DomainController <Fqdn>] - [-InternalFlags <InternalMrsFlag[]>] - [-LargeItemLimit <Unlimited>] - [-OutlookAnywhereHostName <Fqdn>] - [-PreventCompletion <$true | $false>] - [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] - [-RemoteMailboxLegacyDN <String>] - [-RemoteMailboxServerLegacyDN <String>] - [-RequestExpiryInterval <Unlimited>] - [-SkipMerging <SkippableMergeComponent[]>] - [-WhatIf] [<CommonParameters>] -``` - -### MigrationOutlookAnywherePublicFolder -``` -Set-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> -RemoteCredential <PSCredential> - [-AuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] - [-OutlookAnywhereHostName <Fqdn>] - [-PreventCompletion <$true | $false>] - [-RemoteMailboxLegacyDN <String>] - [-RemoteMailboxServerLegacyDN <String>] - [-RequestExpiryInterval <Unlimited>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can pipeline the Set-PublicFolderMigrationRequest cmdlet from the Get-PublicFolderMigrationRequestStatistics, Get-PublicFolderMigrationRequst, or the Get-PublicFolder 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-PublicFolderMigrationRequest -Identity PublicFolderMigration -BadItemLimit 5 -``` - -This example changes the setting of the PublicFolderMigration migration request to accept up to five corrupted public folder items. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the public folder migration request. - -```yaml -Type: PublicFolderMigrationRequestIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RehomeRequest -This parameter is available only in on-premises Exchange. - -The RehomeRequest parameter specifies to the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the public folder being migrated. This parameter is used primarily for debugging purposes. - -```yaml -Type: SwitchParameter -Parameter Sets: Rehome -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteCredential -This parameter is available only in the cloud-based service. - -The RemoteCredential parameter specifies an administrator who has permission to perform the migration request, for example, Administrator@humongousinsurance.com. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationMethod -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured -Parameter Sets: Identity, MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchName -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompletedRequestAgeLimit -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: Rehome, Identity -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 -``` - -### -InternalFlags -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeItemLimit -The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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: - -- Exchange 2016: Message size limits in Exchange 2016 (https://technet.microsoft.com/library/bb124345.aspx) - -- Exchange Online: Exchange Online Limits (https://go.microsoft.com/fwlink/p/?LinkId=524926) - -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. - -If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. - -```yaml -Type: Unlimited -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutlookAnywhereHostName -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: Identity, MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventCompletion -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -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: - -- Lowest - -- Lower - -- Low - -- Normal: This is the default value. - -- High - -- Higher - -- Highest - -- Emergency - -```yaml -Type: Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency -Parameter Sets: Identity -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 -``` - -### -RemoteMailboxLegacyDN -This parameter is available only in the cloud-based service. - -The RemoteMailboxLegacyDN parameter specifies the ExchangeLegacyDN of the remote mailbox. - -```yaml -Type: String -Parameter Sets: Identity, MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteMailboxServerLegacyDN -This parameter is available only in the cloud-based service. - -The RemoteMailboxServerLegacyDN parameter specifies the server legacy DN of the back-end server. To find the LegacyExchangeServerDN value, run the following command: Get-ExchangeServer \<Identity\> | Format-List LegacyExchangeServerDN. - -```yaml -Type: String -Parameter Sets: Identity, MigrationOutlookAnywherePublicFolder -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestExpiryInterval -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. - -- If the request fails, you need to manually remove it by using the corresponding Remove-\*Request cmdlet. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. - -When you use the value Unlimited, the completed request isn't automatically removed. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMerging -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/44fbc2af-e9a4-4fa7-9b04-709ab1bdda2c.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Start-MigrationBatch.md b/exchange/exchange-ps/exchange/move-and-migration/Start-MigrationBatch.md deleted file mode 100644 index 3918f63ad5..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Start-MigrationBatch.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MigrationBatch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Start-MigrationBatch cmdlet to start a move request or migration batch that was created with the New-MigrationBatch cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-Validate] [-WhatIf] [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-MigrationBatch -Identity SEM1 -``` - -This example starts the migration batch SEM1. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Validate -The Validate parameter specifies whether to start the migration batch in the validation stage of the migration process. If you include this parameter, the migration performs a validation check of the mailboxes in the batch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4c0758cc-754e-49cc-b236-7b3ad83e1048.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Start-MigrationUser.md b/exchange/exchange-ps/exchange/move-and-migration/Start-MigrationUser.md deleted file mode 100644 index f3f4676158..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Start-MigrationUser.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Start-MigrationUser -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Start-MigrationUser - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Start-MigrationUser cmdlet to start the migration of a user in an existing migration batch. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-MigrationUser [[-Identity] <MigrationUserIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-Partition <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-MigrationUser -Identity laura@contoso.com -``` - -This example starts the migration of the user named laura@contoso.com - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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. - -```yaml -Type: MigrationUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ab1b0e0f-cbda-4724-863f-04a944c1a7dd.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Stop-MigrationBatch.md b/exchange/exchange-ps/exchange/move-and-migration/Stop-MigrationBatch.md deleted file mode 100644 index 93689fd7c3..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Stop-MigrationBatch.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MigrationBatch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Stop-MigrationBatch cmdlet to stop the processing of a migration batch that's in progress. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Stop-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [-Partition <MailboxIdParameter>] [<CommonParameters>] -``` - -## 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 Office 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration won't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet won't run. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Stop-MigrationBatch -``` - -This example stops the migration batch that's currently being processed by the migration service. - -### -------------------------- Example 2 -------------------------- -``` -Stop-MigrationBatch -Identity MigrationBatch1 -``` - -This example stops the migration batch MigrationBatch1. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter 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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/92d2f432-2bc0-469d-86b3-b82de8d3241c.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Stop-MigrationUser.md b/exchange/exchange-ps/exchange/move-and-migration/Stop-MigrationUser.md deleted file mode 100644 index 1f9feaeb12..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Stop-MigrationUser.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Online -title: Stop-MigrationUser -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Stop-MigrationUser - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Stop-MigrationUser cmdlet to stop the migration of a user in an existing migration batch. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Stop-MigrationUser [[-Identity] <MigrationUserIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-Partition <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Stop-MigrationUser -Identity laura@contoso.com -``` - -This example stops the migration of the user laura@contoso.com. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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. - -```yaml -Type: MigrationUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Partition -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ad058a5c-b114-4e64-bc1f-dc627ef8c08c.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md deleted file mode 100644 index a757aba942..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-PublicFolderMigrationRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Suspend-PublicFolderMigrationRequest - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Suspend-PublicFolderMigrationRequest cmdlet to suspend a migration request any time after the request was created, but before it reaches the status of CompletionInProgress. You can resume the migration request by using the Resume-PublicFolderMigrationRequest cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Suspend-PublicFolderMigrationRequest [-Identity] <PublicFolderMigrationRequestIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-SuspendComment <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Suspend-PublicFolderMigrationRequest -Identity PFMigReq1 -``` - -This example suspends the public folder migration request PFMigReq1. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMigrationRequest -Status InProgress | Suspend-PublicFolderMigrationRequest -``` - -This example suspends all migration requests that are in progress by using the Get-PublicFolderMigrationRequest cmdlet to retrieve all migration requests with a Status value of InProgress and then pipelining the output to the Suspend-PublicFolderMigrationRequest cmdlet. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the migration request. This parameter accepts the following values: - -- GUID - -- Name - -```yaml -Type: PublicFolderMigrationRequestIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuspendComment -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ccb89e00-a90d-4324-b066-15bd733a78db.aspx) diff --git a/exchange/exchange-ps/exchange/move-and-migration/Test-MigrationServerAvailability.md b/exchange/exchange-ps/exchange/move-and-migration/Test-MigrationServerAvailability.md deleted file mode 100644 index 18bac22202..0000000000 --- a/exchange/exchange-ps/exchange/move-and-migration/Test-MigrationServerAvailability.md +++ /dev/null @@ -1,649 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-MigrationServerAvailability -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Test-MigrationServerAvailability cmdlet to test the availability of the target server in preparation to perform cross-forest mailbox moves, migration of on-premises mailboxes to Exchange Online, or to migrate on-premises mailbox data from an IMAP server to Exchange Online mailboxes. For all migration types, the cmdlet attempts to verify the connection settings used to connect to the target server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ExchangeRemoteMoveAutodiscover -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Autodiscover] [-ExchangeRemoteMove] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### ExchangeOutlookAnywhereAutodiscover -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Autodiscover] [-ExchangeOutlookAnywhere] - [-Confirm] - [-MailboxPermission <Admin | FullAccess>] - [-SourceMailboxLegacyDN <String>] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### PSTImport -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -RemoteServer <Fqdn> [-FilePath <String>] [-PSTImport] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### ExchangeOutlookAnywhere -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -ExchangeServer <String> -RPCProxyServer <Fqdn> [-ExchangeOutlookAnywhere] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-EmailAddress <SmtpAddress>] - [-MailboxPermission <Admin | FullAccess>] [-TestMailbox <MailboxIdParameter>] - [-SourceMailboxLegacyDN <String>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### PublicFolder -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -PublicFolderDatabaseServerLegacyDN <String> -RPCProxyServer <Fqdn> -SourceMailboxLegacyDN <String> [-PublicFolder] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-Confirm] - [-TestMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ExchangeRemoteMove -``` -Test-MigrationServerAvailability -RemoteServer <Fqdn> [-Credentials <PSCredential>] [-ExchangeRemoteMove] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### TestEndpoint -``` -Test-MigrationServerAvailability -Endpoint <MigrationEndpointIdParameter> - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### IMAP -``` -Test-MigrationServerAvailability -RemoteServer <Fqdn> -Port <Int32> [-Imap] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] [-Security <None | Ssl | Tls>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Compliance -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -EmailAddress <SmtpAddress> [-Compliance] [-RemoteServer <Fqdn>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### MrsProxyPublicFolderToUnifiedGroup -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -RemoteServer <Fqdn>[-PublicFolderToUnifiedGroup] [-TestMailbox <MailboxIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### LegacyPublicFolderToUnifiedGroup -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -PublicFolderDatabaseServerLegacyDN <String> -RPCProxyServer <Fqdn> -SourceMailboxLegacyDN <String> [-PublicFolderToUnifiedGroup] - [-Authentication <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] - [-TestMailbox <MailboxIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### MrsProxyPublicFolder -``` -Test-MigrationServerAvailability -Credentials <PSCredential> -RemoteServer <Fqdn> [-PublicFolder] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Other -``` -Test-MigrationServerAvailability [-EmailAddress <SmtpAddress>] [-TestMailbox <MailboxIdParameter>] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-MigrationServerAvailability cmdlet verifies that you can communicate with the on-premises mail server that houses the mailbox data that you want to migrate to cloud-based mailboxes. When you run this cmdlet, you must specify the migration type. You can specify whether to communicate with an IMAP server or with an Exchange server. - -For an IMAP migration, this cmdlet uses the server's fully qualified domain name (FQDN) and a port number to verify the connection. If the verification is successful, use the same connection settings when you create a migration request with the New-MigrationBatch cmdlet. - -For an Exchange migration, this cmdlet uses one of the following settings to communicate with the on-premises server: - -- For Exchange 2003, it uses the server's FQDN and credentials for an administrator account that can access the server. - -- For Exchange Server 2007 and later versions, you can connect using the Autodiscover service and the email address of an administrator account that can access the server. - -If the verification is successful, you can use the same settings to create a migration endpoint. For more information, see: - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-MigrationServerAvailability -Imap -RemoteServer imap.contoso.com -Port 143 -``` - -For IMAP migrations, this example verifies the connection to the IMAP mail server imap.contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -$Credentials = Get-Credential; Test-MigrationServerAvailability -ExchangeOutlookAnywhere -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials -``` - -This example uses the Autodiscover and ExchangeOutlookAnywhere parameters to verify the connection to an on-premises Exchange server in preparation for migrating on-premises mailboxes to Exchange Online. You can use a similar example to test the connection settings for a staged Exchange migration or a cutover Exchange migration. - -### -------------------------- Example 3 -------------------------- -``` -$Credentials = Get-Credential; Test-MigrationServerAvailability -ExchangeOutlookAnywhere -ExchangeServer exch2k3.contoso.com -Credentials $Credentials -RPCProxyServer mail.contoso.com -Authentication NTLM -``` - -This example verifies the connection to a server running Microsoft Exchange Server 2003 named exch2k3.contoso.com and uses NTLM for the authentication method. - -### -------------------------- Example 4 -------------------------- -``` -Test-MigrationServerAvailability -Endpoint endpoint.contoso.com -``` - -This example verifies the connection settings to a remote server using the settings stored in an existing migration endpoint in Exchange Online. - -### -------------------------- Example 5 -------------------------- -``` -$MRSEndpoints = (Get-MigrationEndpoint).RemoteServer; Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP} -``` - -This example tests multiple existing endpoints. - -## PARAMETERS - -### -Autodiscover -The Autodiscover parameter specifies that the cmdlet should use the Autodiscover service to obtain the connection settings for the target server. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscove -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Compliance -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -The Credentials parameter specifies the logon credentials 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. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, PSTImport, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, MrsProxyPublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMove -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SmtpAddress -Parameter Sets: ExchangeOutlookAnywhere, Other -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeOutlookAnywhere -This parameter is available only in the cloud-based service. - -The ExchangeOutlookAnywhere parameter specifies a migration type for migrating on-premises mailboxes to Exchange Online. Use this parameter if you plan to migrate mailboxes to Exchange Online using a staged Exchange migration or a cutover Exchange migration. - -```yaml -Type: SwitchParameter -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeRemoteMove -The ExchangeRemoteMove parameter specifies a type of migration where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. Use this parameter if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment. - -```yaml -Type: SwitchParameter -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeRemoteMove -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeServer -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. - -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Imap -This parameter is available only in the cloud-based service. - -The Imap parameter specifies an IMAP migration as the migration type. This parameter is required when you want to migrate data from an IMAP mail server to Exchange Online mailboxes. - -```yaml -Type: SwitchParameter -Parameter Sets: IMAP -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -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. - -The standard is to use port 143 for unencrypted connections, port 143 for Transport Layer Security (TLS), and port 993 for Secure Sockets Layer (SSL). - -```yaml -Type: Int32 -Parameter Sets: IMAP -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PSTImport -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: PSTImport -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder, MrsProxyPublicFolder -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderDatabaseServerLegacyDN -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderToUnifiedGroup -The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Office 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteServer -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 - -- Remote move (hybrid deployments) - -- IMAP migration - -```yaml -Type: Fqdn -Parameter Sets: PSTImport, ExchangeRemoteMove, IMAP, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Fqdn -Parameter Sets: Compliance -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: Fqdn -Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceMailboxLegacyDN -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. - -```yaml -Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -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. - -The parameter is only used for cutover Exchange migrations and staged Exchange migrations. - -```yaml -Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured -Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, IMAP, LegacyPublicFolderToUnifiedGroup -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -FilePath -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxPermission -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. - -This parameter isn't used for testing the connection to the remote server for a remote move migration or an IMAP migration. - -```yaml -Type: Admin | FullAccess -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Security -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. - -```yaml -Type: None | Ssl | Tls -Parameter Sets: IMAP -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestMailbox -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. - -```yaml -Type: MailboxIdParameter -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, Other -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a0959dbe-94ae-4f2e-8e2c-e5d5bd5e1521.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Enable-OrganizationCustomization.md b/exchange/exchange-ps/exchange/organization/Enable-OrganizationCustomization.md deleted file mode 100644 index 126239e08c..0000000000 --- a/exchange/exchange-ps/exchange/organization/Enable-OrganizationCustomization.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Enable-OrganizationCustomization -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Enable-OrganizationCustomization - -## 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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-OrganizationCustomization [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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. - -Here are some examples of when you might see this: - -- Creating a new role group or creating a new management role assignment. - -- Creating a new role assignment policy or modifying a built-in role assignment policy. - -- Creating a new Outlook on the web mailbox policy or modifying a built-in Outlook on the web mailbox policy. - -- Creating a new sharing policy or modifying a built-in sharing policy. - -- Creating a new retention policy or modifying a built-in retention policy. - -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 need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-OrganizationCustomization -``` - -This example runs the command as required. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/04b39afc-74c9-4644-97e6-8df216b8985d.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/organization/Get-AccessToCustomerDataRequest.md deleted file mode 100644 index f49213975b..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-AccessToCustomerDataRequest.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-AccessToCustomerDataRequest -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-AccessToCustomerDataRequest - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AccessToCustomerDataRequest cmdlet to view Office 365 customer lockbox requests that control access to your data by Microsoft support engineers. - -Note: Customer lockbox is included in the Office 365 E5 plan. If you don't have an Office 365 E5 plan, you can buy a separate customer lockbox subscription with any Office 365 Enterprise plan. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AccessToCustomerDataRequest [-ApprovalStatus <String>] [-CreatedAfter <ExDateTime>] [-RequestId <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AccessToCustomerDataRequest -``` - -This example returns a summary list of all customer lockbox request. - -### -------------------------- Example 2 -------------------------- -``` -Get-AccessToCustomerDataRequest -ApprovalStatus Pending -``` - -This example returns a summary list of all customer lockbox requests that have the status value Pending. - -### -------------------------- Example 3 -------------------------- -``` -Get-AccessToCustomerDataRequest -RequestId EXSR123456 | Format-List -``` - -This example returns detailed information the customer lockbox request EXSR123456. - -## PARAMETERS - -### -ApprovalStatus -The ApprovalStatus parameter filters the results by approval status. Valid values are: - -- Approved - -- Canceled - -- Denied - -- Pending - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreatedAfter -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: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestId -The RequestId parameter filters the results by reference number (for example, EXSR123456). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2ad3b776-f81b-4fdc-895b-a1ac98832286.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-AuthConfig.md b/exchange/exchange-ps/exchange/organization/Get-AuthConfig.md deleted file mode 100644 index b2477da563..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-AuthConfig.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AuthConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-AuthConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-AuthConfig cmdlet to get the authorization configuration for partner applications. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuthConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuthConfig | Format-List -``` - -This example retrieves the authorization configuration for the Exchange organization and pipes the results to the Format-List command. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cef1b36e-78d8-4937-bdc3-7d99b1f349a4.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-AuthServer.md b/exchange/exchange-ps/exchange/organization/Get-AuthServer.md deleted file mode 100644 index a13b996fcf..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-AuthServer.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AuthServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-AuthServer cmdlet to view the settings of authorization servers in the Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuthServer [[-Identity] <AuthServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuthServer | Format-List * -``` - -This example retrieves all settings for all authorization servers in the Exchange organization. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of an authorization server. - -```yaml -Type: AuthServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/077acd5a-7af0-48f8-bc68-123aef416a93.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/organization/Get-AuthenticationPolicy.md deleted file mode 100644 index 46b39f6890..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-AuthenticationPolicy.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-AuthenticationPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-AuthenticationPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AuthenticationPolicy cmdlet to view authentication policies in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuthenticationPolicy [[-Identity] <AuthPolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuthenticationPolicy | Format-Table -Auto Name -``` - -This example returns a summary list of all authentication policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuthenticationPolicy -Identity "Engineering Group" -``` - -This example returns detailed information for the authentication policy named Engineering Group. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the authentication policy you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AuthPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/organization/get-authenticationpolicy) diff --git a/exchange/exchange-ps/exchange/organization/Get-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/organization/Get-CmdletExtensionAgent.md deleted file mode 100644 index 8a23e5a16c..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-CmdletExtensionAgent.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-CmdletExtensionAgent -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-CmdletExtensionAgent - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-CmdletExtensionAgent cmdlet to view cmdlet extension agents. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Filters -``` -Get-CmdletExtensionAgent [-Assembly <String>] [-Enabled <$true | $false>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-CmdletExtensionAgent [[-Identity] <CmdletExtensionAgentIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CmdletExtensionAgent | Format-Table -Auto Name,Enabled,Priority -``` - -This example displays a summary list of all the cmdlet extension agents in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CmdletExtensionAgent "Mailbox Creation Time Agent" -``` - -This example displays detailed information for the Exchange cmdlet extension agent named Mailbox Creation Time Agent. - -## PARAMETERS - -### -Assembly -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 -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 -``` - -### -Enabled -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. - -- $false: Only disabled agents are included in the results. - -If you don't use this parameter, enabled and disabled agents are included in the results. - -```yaml -Type: $true | $false -Parameter Sets: Filters -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the cmdlet extension agent that you want to view. You can use any value that uniquely identifies the agent. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: CmdletExtensionAgentIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/46cc31dd-3799-45e4-bcce-0d0699a61dd6.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/organization/Get-ExchangeAssistanceConfig.md deleted file mode 100644 index 9d4b07608f..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-ExchangeAssistanceConfig.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeAssistanceConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ExchangeAssistanceConfig - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ExchangeAssistanceConfig cmdlet to view the configuration information for the URLs that Microsoft Exchange Help uses to connect to the source of the documentation. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ExchangeAssistanceConfig [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ExchangeAssistanceConfig -Identity Contoso.com -``` - -This example shows the configuration information that the web management interface uses to locate the source of the documentation for Contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-ExchangeAssistanceConfig | Format-Table -``` - -This example shows the configuration information for all organizations and formats the information into a table. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5b060db2-edaf-40ff-9ae3-1d36c65a3234.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/exchange/organization/Get-ExchangeDiagnosticInfo.md deleted file mode 100644 index a177a435e9..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-ExchangeDiagnosticInfo.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeDiagnosticInfo -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ExchangeDiagnosticInfo - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ExchangeDiagnosticInfo cmdlet to return information about processes that are running on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ExchangeDiagnosticInfo [-Argument <String>] [-Component <String>] [-Process <String>] - [-Server <ServerIdParameter>] [-Unlimited] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ExchangeDiagnosticInfo -``` - -This example returns a summary list of all Exchange processes that are running on the server. - -### -------------------------- Example 2 -------------------------- -``` -[xml]$edi = Get-ExchangeDiagnosticInfo; $edi.Diagnostics.Processlocator.Process | Format-Table -Auto Name,ID,Guid -``` - -This example display the XML output of the command in format that's easier to read. - -## PARAMETERS - -### -Argument -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. - -To see the Argument values that are available for a given Component value, run the command Get-ExchangeDiagnosticInfo -Process \<ProcessName\> -Component \<ComponentName\> -Argument Help - -```yaml -Type: String -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 -``` - -### -Component -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. - -```yaml -Type: String -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 -``` - -### -Process -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Unlimited -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/organization/Get-ExchangeServerAccessLicense.md b/exchange/exchange-ps/exchange/organization/Get-ExchangeServerAccessLicense.md deleted file mode 100644 index 35a9f7e59b..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-ExchangeServerAccessLicense.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServerAccessLicense -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ExchangeServerAccessLicense - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ExchangeServerAccessLicense cmdlet to return a list of licenses in use in your Exchange organization. This refers to the specific legal name of the license, as defined in the Microsoft Product List and is representative of your licenses when you run this cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ExchangeServerAccessLicense [<CommonParameters>] -``` - -## DESCRIPTION -The Get-ExchangeServerAccessLicense cmdlet returns a collection of these license names: - -- Exchange Server 2016 Standard CAL - -- Exchange Server 2016 Enterprise CAL - -- Exchange Server 2016 Standard Edition - -- Exchange Server 2016 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ExchangeServerAccessLicense -``` - -This example retrieves a list of Exchange 2016 licenses in your organization. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fbe3cf4a-167c-47b4-9074-a4561711be6e.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/exchange/organization/Get-ExchangeServerAccessLicenseUser.md deleted file mode 100644 index 25b057d428..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-ExchangeServerAccessLicenseUser.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServerAccessLicenseUser -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ExchangeServerAccessLicenseUser - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ExchangeServerAccessLicenseUser cmdlet to return a list of unique users for the specified license name. Each object contains the FQDN or primary SMTP address of the mailbox and the license that's associated with it. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ExchangeServerAccessLicenseUser -LicenseName <String> [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ExchangeServerAccessLicenseUser -LicenseName "Exchange Server 2016 Standard Edition" -``` - -This example returns the unique users for the license named Exchange Server 2016 Standard Edition. - -## PARAMETERS - -### -LicenseName -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 2016 Standard CAL - -- Exchange Server 2016 Enterprise CAL - -- Exchange Server 2016 Standard Edition - -- Exchange Server 2016 Enterprise Edition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/de51a293-5c86-4767-9add-1b32f0a1ccd3.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-Notification.md b/exchange/exchange-ps/exchange/organization/Get-Notification.md deleted file mode 100644 index 3b2b0a6e8a..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-Notification.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-Notification -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-Notification cmdlet to view notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notification events are related to: - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Settings -``` -Get-Notification [-Settings] -ProcessType <Unknown | ImportPST | ExportPST | Migration | MailboxRestore | CertExpiry> - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-Notification [[-Identity] <EwsStoreObjectIdParameter>] [-Summary] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Filter -``` -Get-Notification [-ProcessType <Unknown | ImportPST | ExportPST | Migration | MailboxRestore | CertExpiry>] [-ResultSize <Unlimited>] [-StartDate <ExDateTime>] [-Summary] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Notification -``` - -This example displays a summary list of all notification events. - -### -------------------------- Example 2 -------------------------- -``` -Get-Notification -ProcessType Migration -``` - -This example displays a summary list of all mailbox move and migration notification events. - -### -------------------------- Example 3 -------------------------- -``` -Get-Notification -Identity 0259ec74-3539-4195-ab4f-de93e654ceaf | Format-List -``` - -This example displays detailed information for the specified notification event. - -## PARAMETERS - -### -Settings -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. - -You can only use this switch with the ProcessType parameter value CertExpiry. - -You can't use this switch with the Summary switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Settings -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the notification event that you want to view. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. - -```yaml -Type: EwsStoreObjectIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ProcessType -The ProcessType parameter filters the results by the type of notification event. Valid values are: - -- CertExpiry - -- ExportPST - -- ImportPST - -- MailboxRestore - -- Migration - -```yaml -Type: Unknown | ImportPST | ExportPST | Migration | MailboxRestore | CertExpiry -Parameter Sets: Settings -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Unknown | ImportPST | ExportPST | Migration | MailboxRestore | CertExpiry -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Summary -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, Filter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/702ee419-4521-4c89-a3ff-75b1f01dd037.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-OrganizationConfig.md b/exchange/exchange-ps/exchange/organization/Get-OrganizationConfig.md deleted file mode 100644 index da736a75e0..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-OrganizationConfig.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-OrganizationConfig cmdlet to get configuration data for an Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OrganizationConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OrganizationConfig -DomainController ContosoDC -``` - -This example gets the organization configuration information for the domain controller ContosoDC. - -### -------------------------- Example 2 -------------------------- -``` -Get-OrganizationConfig | Export-CliXML C:\Data\MyFile.xml -``` - -This example gets the configuration information for the tenant organization. - -For more information, see Troubleshoot a hybrid deployment (https://technet.microsoft.com/library/jj659053.aspx). - -### -------------------------- Example 3 -------------------------- -``` -Get-OrganizationConfig | Format-List EwsApplicationAccessPolicy,Ews*List -``` - -This example shows the applications that are allowed access to EWS and REST. - -If the value of EwsApplicationAccessPolicy is EnforceAllowList, only the applications specified in EwsAllowList are allowed to access EWS and REST. - -If the value of EwsApplicationAccessPolicy is EnforceBlockList, all applications are allowed to access EWS and REST, except those specified in EwsBlockList. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3e07e5cc-5066-40e7-8642-845ad080f9a9.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-PartnerApplication.md b/exchange/exchange-ps/exchange/organization/Get-PartnerApplication.md deleted file mode 100644 index 18ee67776f..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-PartnerApplication.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PartnerApplication -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-PartnerApplication cmdlet to retrieve settings for a partner application. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PartnerApplication [[-Identity] <PartnerApplicationIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/en-us/library/jj150480.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PartnerApplication | Format-List * -``` - -This example retrieves settings for all partner applications configured in Exchange and pipes them to the Format-List cmdlet to display all properties in a list view. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e6ce8128-f174-4bca-91e6-004fc94cf0f8.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-PerimeterConfig.md b/exchange/exchange-ps/exchange/organization/Get-PerimeterConfig.md deleted file mode 100644 index 0d0eda8076..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-PerimeterConfig.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online -title: Get-PerimeterConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-PerimeterConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-PerimeterConfig cmdlet to view the list of gateway server and internal mail server IP addresses that have been added to the cloud-based safelists. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PerimeterConfig [[-Identity] <OrganizationIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -If you have an on-premises email system, you can use the Set-PerimeterConfig cmdlet to add the IP addresses of your gateway servers to cloud-based safelists (also known as whitelists) to make sure that messages sent from your on-premises email system aren't treated as spam. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PerimeterConfig -``` - -This example returns the list of gateway servers and internal email servers in your organization that have been added to cloud-based safelists. - -## PARAMETERS - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/34ef07d4-b055-4f33-bb88-15e41e0386db.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Get-SettingOverride.md b/exchange/exchange-ps/exchange/organization/Get-SettingOverride.md deleted file mode 100644 index 0ce9b55aa4..0000000000 --- a/exchange/exchange-ps/exchange/organization/Get-SettingOverride.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SettingOverride -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-SettingOverride - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -**Caution**: Incorrect usage of the setting override cmdlets can cause serious damage to your Exchange organization. This damage could require you to reinstall Exchange. Only use these cmdlets as instructed by product documentation or under the direction of Microsoft Customer Service and Support. - -Use the Get-SettingOverride cmdlet to view existing setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SettingOverride [[-Identity] <SettingOverrideIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-sepcific, 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SettingOverride | Format-List Name,Reason,ComponentName,SectionName,Parameters,Server -``` - -This example displays a summary list of all setting override objects. - -### -------------------------- Example 2 -------------------------- -``` -Get-SettingOverride -Identity "IM Server Integration" -``` - -This example displays a detailed information for the setting override object named IM Server Integration. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the setting override that you want to view. You can use any value that uniquely identifies the override. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: SettingOverrideIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3052da37-a77c-423b-a4ce-3022a6dbf19e.aspx) diff --git a/exchange/exchange-ps/exchange/organization/New-AuthServer.md b/exchange/exchange-ps/exchange/organization/New-AuthServer.md deleted file mode 100644 index 0b4a55c669..0000000000 --- a/exchange/exchange-ps/exchange/organization/New-AuthServer.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AuthServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-AuthServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-AuthServer cmdlet to create an authorization server object in Microsoft Exchange and specify its AuthMetadataUrl. Exchange honors tokens issued by the authorization server for access by a partner application. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AuthMetadataUrl -``` -New-AuthServer [-Name] <String> -AuthMetadataUrl <String> [-TrustAnySSLCertificate] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -### NativeClientAuthServer -``` -New-AuthServer [-Name] <String> -AuthMetadataUrl <String> -Type <Unknown | MicrosoftACS | Facebook | LinkedIn | ADFS | AzureAD> [-TrustAnySSLCertificate] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -### AppSecret -``` -New-AuthServer [-Name] <String> -Type <Unknown | MicrosoftACS | Facebook | LinkedIn | ADFS | AzureAD> - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -The New-AuthServer cmdlet creates a trusted authorization server object in Exchange, which allows it to trust tokens issued by the authorization 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AuthServer HRAppAuth -AuthMetadataUrl http://hrappauth.contoso.com/metadata/json/1 -``` - -This command creates an authorization server. - -## PARAMETERS - -### -AuthMetadataUrl -The AuthMetadataUrl parameter specifies the URL for the Office 365 authorization server for your cloud-based organization. For details, see the Office 365 documentation. - -```yaml -Type: String -Parameter Sets: AuthMetadataUrl, NativeClientAuthServer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a name for the authorization server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Unknown | MicrosoftACS | Facebook | LinkedIn | ADFS | AzureAD -Parameter Sets: NativeClientAuthServer, AppSecret -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the authorization server is enabled. Set the parameter to $false to prevent authorization tokens issued by this authorization server from being accepted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustAnySSLCertificate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: AuthMetadataUrl, NativeClientAuthServer -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 -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/67539efd-309f-4155-8b8f-c370fe7681b6.aspx) diff --git a/exchange/exchange-ps/exchange/organization/New-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/organization/New-AuthenticationPolicy.md deleted file mode 100644 index fefee70f04..0000000000 --- a/exchange/exchange-ps/exchange/organization/New-AuthenticationPolicy.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: New-AuthenticationPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-AuthenticationPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-AuthenticationPolicy cmdlet to create authentication policies in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AuthenticationPolicy [[-Name] <String>] [-AllowBasicAuthActiveSync] [-AllowBasicAuthAutodiscover] [-AllowBasicAuthImap] [-AllowBasicAuthMapi] [-AllowBasicAuthOfflineAddressBook] [-AllowBasicAuthOutlookService] [-AllowBasicAuthPop] [-AllowBasicAuthPowershell] [-AllowBasicAuthReportingWebServices] [-AllowBasicAuthRest] [-AllowBasicAuthRpc] [-AllowBasicAuthSmtp] [-AllowBasicAuthWebServices] [-Confirm] [-WhatIf] [<CommonParameters>] - -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### Example 1 -``` -New-AuthenticationPolicy -Name "Engineering Group" -``` - -This example creates a new authentication policy named Engineering Group - -## PARAMETERS - -### -Name -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 Online -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthActiveSync -The AllowBasicAuthActiveSync switch specifies whther to allow Basic authentication with Exchange Active Sync. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthAutodiscover -The AllowBasicAuthAutodiscover switch specifies whther to allow Basic authentication with Autodiscover. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthImap -The AllowBasicAuthImap switch specifies whther to allow Basic authentication with IMAP. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthMapi -The AllowBasicAuthMapi switch specifies whther to allow Basic authentication with MAPI. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthOfflineAddressBook -The AllowBasicAuthOfflineAddressBook switch specifies whther to allow Basic authentication with Offline Address Books. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthOutlookService -The AllowBasicAuthOutlookService switch specifies whther to allow Basic authentication with the Outlook service. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthPop -The AllowBasicAuthPop switch specifies whther to allow Basic authentication with POP. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthPowershell -The AllowBasicAuthPowerShell switch specifies whther to allow Basic authentication with PowerShell. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthReportingWebServices -The AllowBasicAuthReporting Web Services switch specifies whther to allow Basic authentication with reporting web services. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthRest -The AllowBasicAuthRest switch specifies whther to allow Basic authentication with REST. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthRpc -The AllowBasicAuthRpc switch specifies whther to allow Basic authentication with RPC. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthSmtp -The AllowBasicAuthSmtp switch specifies whther to allow Basic authentication with SMTP. You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthWebServices -The AllowBasicAuthWebServices switch specifies whther to allow Basic authentication with Exchange Web Services (EWS). You don't need to specify a value with this switch. - -The default value is $false. Use this switch to set the value $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -SThe WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/organization/new-authenticationpolicy) diff --git a/exchange/exchange-ps/exchange/organization/New-ExchangeSettings.md b/exchange/exchange-ps/exchange/organization/New-ExchangeSettings.md deleted file mode 100644 index 66065d5671..0000000000 --- a/exchange/exchange-ps/exchange/organization/New-ExchangeSettings.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019 -title: New-ExchangeSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-ExchangeSettings - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-ExchangeSettings cmdlet to create customized Exchange setting objects that are stored in Active Directory. Use the Set-ExchangeSettings cmdlet to configure the actual settings. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ExchangeSettings [-Name] <String> [-Confirm] [-DomainController <Fqdn>] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ExchangeSettings -Name Audit -``` - -This example creates a new Exchange settings object for the Audit configuration schema. After you create the Exchange settings object, use the Set-ExchangeSettings cmdlet to define the settings. - -## PARAMETERS - -### -Name -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 - -- Audit - -- Compliance - -- DirectoryTasks - -- LinkedRoleGroup - -- MRS - -- MRSScripts - -- Store - -- TopologyService - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 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 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dcf2aed0-7906-4272-adc4-8ae0ea20c43e.aspx) diff --git a/exchange/exchange-ps/exchange/organization/New-PartnerApplication.md b/exchange/exchange-ps/exchange/organization/New-PartnerApplication.md deleted file mode 100644 index 7621372450..0000000000 --- a/exchange/exchange-ps/exchange/organization/New-PartnerApplication.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PartnerApplication -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-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. - -Use the New-PartnerApplication cmdlet to create a partner application configuration. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ACSTrustApplication -``` -New-PartnerApplication [-Name] <String> -ApplicationIdentifier <String> [-Realm <String>] - [-AcceptSecurityIdentifierInformation <$true | $false>] - [-AccountType <OrganizationalAccount | ConsumerAccount>] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-LinkedAccount <UserIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### AuthMetadataUrl -``` -New-PartnerApplication [-Name] <String> -AuthMetadataUrl <String> [-TrustAnySSLCertificate] - [-AcceptSecurityIdentifierInformation <$true | $false>] - [-AccountType <OrganizationalAccount | ConsumerAccount>] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-LinkedAccount <UserIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business (https://technet.microsoft.com/en-us/library/jj150480.aspx). - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PartnerApplication -Name HRApp -ApplicationIdentifier 00000006-0000-0dd1-ac00-000000000000 -``` - -This example creates a new HRApp partner application named HRApp. - -## PARAMETERS - -### -ApplicationIdentifier -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthMetadataUrl -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. - -```yaml -Type: String -Parameter Sets: AuthMetadataUrl -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptSecurityIdentifierInformation -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountType -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 - -- ConsumerAccount - -```yaml -Type: OrganizationalAccount | ConsumerAccount -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedAccount -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Realm -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. - -```yaml -Type: String -Parameter Sets: ACSTrustApplication -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 -``` - -### -TrustAnySSLCertificate -This parameter is available only in on-premises Exchange. - -The TrustAnySSLCertificate switch specifies whether Exchange should trust certificates issued by a certification authority (CA) not trusted by the server. - -We don't recommend using this switch in a production environment. - -```yaml -Type: SwitchParameter -Parameter Sets: AuthMetadataUrl -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 -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e7cce1f0-d4f1-4eb9-a136-551725a35599.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Remove-AuthServer.md b/exchange/exchange-ps/exchange/organization/Remove-AuthServer.md deleted file mode 100644 index 4b663438c0..0000000000 --- a/exchange/exchange-ps/exchange/organization/Remove-AuthServer.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AuthServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-AuthServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-AuthServer cmdlet to remove an authorization server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AuthServer [-Identity] <AuthServerIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AuthServer AMC -``` - -This example removes the authorization server AMC. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the authorization server. - -```yaml -Type: AuthServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ec5971e8-7340-4584-9916-7a93d0096832.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Remove-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/organization/Remove-AuthenticationPolicy.md deleted file mode 100644 index 88e4304692..0000000000 --- a/exchange/exchange-ps/exchange/organization/Remove-AuthenticationPolicy.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Remove-AuthenticationPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-AuthenticationPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-AuthenticationPolicy cmdlet to remove authentication policies from Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AuthenticationPolicy [-Identity] <AuthPolicyIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### Example 1 -``` -Remove-AuthenticationPolicy -Identity "Engineering Group" -``` - -This example remove the authentication policy named "Engineering Group" - -## PARAMETERS - - -### -Identity -The Identity parameter specifies the authentication policy you want to remove. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AuthPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/organization/remove-authenticationpolicy) diff --git a/exchange/exchange-ps/exchange/organization/Remove-PartnerApplication.md b/exchange/exchange-ps/exchange/organization/Remove-PartnerApplication.md deleted file mode 100644 index 6a89e79809..0000000000 --- a/exchange/exchange-ps/exchange/organization/Remove-PartnerApplication.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PartnerApplication -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-PartnerApplication cmdlet to remove a partner application configuration. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-PartnerApplication [-Identity] <PartnerApplicationIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration if the application no longer needs to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business (https://technet.microsoft.com/en-us/library/jj150480.aspx). - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PartnerApplication HRApp -``` - -This command removes the HRApp partner application. - -## PARAMETERS - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1ab9c702-0547-46da-8c4d-a10b5ab91339.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/organization/Set-AccessToCustomerDataRequest.md deleted file mode 100644 index b69de39142..0000000000 --- a/exchange/exchange-ps/exchange/organization/Set-AccessToCustomerDataRequest.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-AccessToCustomerDataRequest -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-AccessToCustomerDataRequest - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-AccessToCustomerDataRequest cmdlet to approve, deny, or cancel Office 365 customer lockbox requests that control access to your data by Microsoft support engineers. - -Note: Customer lockbox is included in the Office 365 E5 plan. If you don't have an Office 365 E5 plan, you can buy a separate customer lockbox subscription with any Office 365 Enterprise plan. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AccessToCustomerDataRequest -ApprovalDecision <Approve | Deny | Cancel> -RequestId <String> - [-Comment <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AccessToCustomerDataRequest -ApprovalDecision Approve -RequestId EXSR123456 -Comment "Troubleshoot issues in Rick Hofer mailbox" -``` - -This example approves the customer lockbox request EXSR123456 with a comment. - -## PARAMETERS - -### -ApprovalDecision -The ApprovalDecision parameter specifies the approval decision for the customer lockbox request. Valid values are: - -- Approve - -- Deny - -- Cancel - -```yaml -Type: Approve | Deny | Cancel -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestId -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 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b3d866b1-628f-4d66-8114-1798934a2fcf.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Set-AuthServer.md b/exchange/exchange-ps/exchange/organization/Set-AuthServer.md deleted file mode 100644 index e8619c31b9..0000000000 --- a/exchange/exchange-ps/exchange/organization/Set-AuthServer.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-AuthServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-AuthServer cmdlet to configure an authorization server that partner applications can use to obtain tokens recognized by Microsoft Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AuthMetadataUrl -``` -Set-AuthServer [-Identity] <AuthServerIdParameter> [-AuthMetadataUrl <String>] [-TrustAnySSLCertificate] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -### NativeClientAuthServer -``` -Set-AuthServer [-Identity] <AuthServerIdParameter> [-AuthMetadataUrl <String>] [-IsDefaultAuthorizationEndpoint <$true | $false>] [-TrustAnySSLCertificate] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -### RefreshAuthMetadata -``` -Set-AuthServer [-Identity] <AuthServerIdParameter> [-RefreshAuthMetadata] - [-Confirm] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AuthServer ACS -Enabled $false -``` - -This command disables the authorization server ACS. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of authorization server. - -```yaml -Type: AuthServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AuthMetadataUrl -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefaultAuthorizationEndpoint -The IsDefaultAuthorizationEndpoint parameter specifies whether this server is the default authorization endpoint. This server's authorization URL is advertised to calling partner applications and applications need to get their OAuth access tokens from this authorization server. - -Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: NativeClientAuthServer -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 -``` - -### -Name -The Name parameter specifies a name for the authorization server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshAuthMetadata -The RefreshAuthMetadata switch specifies whether Exchange should refresh the auth metadata from the specified URL. - -```yaml -Type: SwitchParameter -Parameter Sets: RefreshAuthMetadata -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 -``` - -### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether Exchange should accept certificates from an untrusted certification authority. We don't recommend using this switch in a production environment. - -```yaml -Type: SwitchParameter -Parameter Sets: AuthMetadataUrl, NativeClientAuthServer -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 -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0f0c328e-0316-4040-a54a-5efe2071edb5.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Set-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/organization/Set-AuthenticationPolicy.md deleted file mode 100644 index 8dcb72b823..0000000000 --- a/exchange/exchange-ps/exchange/organization/Set-AuthenticationPolicy.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-AuthenticationPolicy -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-AuthenticationPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-AuthenticationPolicy cmdlet to modify authentication policies in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AuthenticationPolicy [-Identity] <AuthPolicyIdParameter> [-AllowBasicAuthActiveSync] [-AllowBasicAuthAutodiscover] [-AllowBasicAuthImap] [-AllowBasicAuthMapi] [-AllowBasicAuthOfflineAddressBook] [-AllowBasicAuthOutlookService] [-AllowBasicAuthPop] [-AllowBasicAuthPowershell] [-AllowBasicAuthReportingWebServices] [-AllowBasicAuthRest] [-AllowBasicAuthRpc] [-AllowBasicAuthSmtp] [-AllowBasicAuthWebServices] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### Example 1 -``` -Set-AuthenticationPolicy -Identity "Engineering Group" -AllowBasicAuthReportingWebServices -``` - -This example modifies the authentication policy named Engineering Group to all Basic authentication for Exchange Reporting Web Services. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the authentication policy you want to modify. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AuthPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthActiveSync -The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange Active Sync. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthActiveSync:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthAutodiscover -The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthAutodiscover:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthImap -The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthImap:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthMapi -The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAutMapi:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthOfflineAddressBook -The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthOfflineAddressBook:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthOutlookService -The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthOutlookService:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthPop -The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthPop:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthPowershell -The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthPowershell:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthReportingWebServices -The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthReportingWebServices:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthRest -The AllowBasicAuthRest switch specifies whether to allow Basic authentication with REST. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthRest:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthRpc -The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthRpc:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthSmtp -The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthSmtp:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBasicAuthWebServices -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. - -- To change the value to $true, use this switch without a value. - -- To change the value to $false, use this exact syntax: -AllowBasicAuthWebServices:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -SThe WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/organization/set-authenticationpolicy) diff --git a/exchange/exchange-ps/exchange/organization/Set-ExchangeServer.md b/exchange/exchange-ps/exchange/organization/Set-ExchangeServer.md deleted file mode 100644 index b47136165a..0000000000 --- a/exchange/exchange-ps/exchange/organization/Set-ExchangeServer.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-ExchangeServer - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ExchangeServer cmdlet to set Exchange attributes in Active Directory for a specified server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ExchangeServer [-Identity] <ServerIdParameter> [-Confirm] [-CustomerFeedbackEnabled <$true | $false>] - [-DomainController <Fqdn>] [-ErrorReportingEnabled <$true | $false>] [-InternetWebProxy <Uri>] - [-ProductKey <ProductKey>] [-StaticConfigDomainController <String>] - [-StaticDomainControllers <MultiValuedProperty>] [-StaticExcludedDomainControllers <MultiValuedProperty>] - [-StaticGlobalCatalogs <MultiValuedProperty>] [-WhatIf] - [-MailboxProvisioningAttributes <MailboxProvisioningAttributes>] [-MonitoringGroup <String>] - [-InternetWebProxyBypassList <MultiValuedProperty>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ExchangeServer -Identity TestServer.Contoso.com -ErrorReportingEnabled $false -``` - -This example disables error reporting on the specified server. - -### -------------------------- Example 2 -------------------------- -``` -Set-ExchangeServer -Identity 'SERVER01' -CustomerFeedbackEnabled $true -``` - -This example enrolls an Exchange server into the Customer Experience Improvement Program. In this example, the server name is SERVER01. - -### -------------------------- Example 3 -------------------------- -``` -Set-ExchangeServer -Identity 'SERVER01' -CustomerFeedbackEnabled $false -``` - -This example removes an Exchange server from the Customer Experience Improvement Program. In this example, the server name is SERVER01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID, distinguished name (DN), or name of the server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -CustomerFeedbackEnabled -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: $true | $false -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 -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorReportingEnabled -The ErrorReportingEnabled parameter specifies whether error reporting is enabled. - -```yaml -Type: $true | $false -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 -``` - -### -InternetWebProxy -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. - -```yaml -Type: Uri -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 -``` - -### -ProductKey -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 -``` - -### -StaticConfigDomainController -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticDomainControllers -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticExcludedDomainControllers -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticGlobalCatalogs -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -MailboxProvisioningAttributes -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxProvisioningAttributes -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringGroup -The MonitoringGroup parameter specifies how to add your Exchange servers to monitoring groups. You can add your servers to an existing group or create a monitoring group based on location or deployment, or to partition monitoring responsibility among your servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternetWebProxyBypassList -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: \<FQDN1\>,\<FQDN2\>,...\<FQDNX\>. - -To add or remove one or more values without affecting any existing FQDN entries, use the following syntax: @{Add="\<FQDN1\>","\<FQDN2\>"...; Remove="\<FQDN1\>","\<FQDN\>"...}. - -The maximum number of servers you can enter with this parameter is 100. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8e8d3fca-59b3-4355-a637-28bf5e5ca4cf.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/organization/Set-OrganizationConfig.md deleted file mode 100644 index 0d75e2ebe0..0000000000 --- a/exchange/exchange-ps/exchange/organization/Set-OrganizationConfig.md +++ /dev/null @@ -1,2339 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OrganizationConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-OrganizationConfig cmdlet to configure various settings of an Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Default -``` -Set-OrganizationConfig - [-ActivityBasedAuthenticationTimeoutEnabled <$true | $false>] - [-ActivityBasedAuthenticationTimeoutInterval <EnhancedTimeSpan>] - [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled <$true | $false>] - [-AppsForOfficeEnabled <$true | $false>] - [-AsyncSendEnabled <$true | $false>] - [-AuditDisabled <$true | $false>] - [-AutoExpandingArchive] - [-BookingsEnabled <$true | $false>] - [-BookingsPaymentsEnabled <$true | $false>] - [-BookingsSocialSharingRestricted <$true | $false>] - [-ByteEncoderTypeFor7BitCharsets <Int32>] - [-CalendarVersionStoreEnabled <$true | $false>] - [-Confirm] - [-ConnectorsActionableMessagesEnabled <$true | $false>] - [-ConnectorsEnabled <$true | $false>] - [-ConnectorsEnabledForOutlook <$true | $false>] - [-ConnectorsEnabledForSharepoint <$true | $false>] - [-ConnectorsEnabledForTeams <$true | $false>] - [-ConnectorsEnabledForYammer <$true | $false>] - [-CustomerLockboxEnabled <$true | $false>] - [-DefaultGroupAccessType <Private | Public>] - [-DefaultPublicFolderAgeLimit <EnhancedTimeSpan>] - [-DefaultPublicFolderDeletedItemRetention <EnhancedTimeSpan>] - [-DefaultPublicFolderIssueWarningQuota <Unlimited>] - [-DefaultPublicFolderMaxItemSize <Unlimited>] - [-DefaultPublicFolderMovedItemRetention <EnhancedTimeSpan>] - [-DefaultPublicFolderProhibitPostQuota <Unlimited>] - [-DirectReportsGroupAutoCreationEnabled <$true | $false>] - [-DistributionGroupDefaultOU <OrganizationalUnitIdParameter>] - [-DistributionGroupNameBlockedWordsList <MultiValuedProperty>] - [-DistributionGroupNamingPolicy <DistributionGroupNamingPolicy>] - [-ElcProcessingDisabled <$true | $false>] - [-EndUserDLUpgradeFlowsDisabled <$true | $false>] - [-EwsAllowEntourage <$true | $false>] - [-EwsAllowList <MultiValuedProperty>] - [-EwsAllowMacOutlook <$true | $false>] - [-EwsAllowOutlook <$true | $false>] - [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] - [-EwsBlockList <MultiValuedProperty>] - [-EwsEnabled <$true | $false>] - [-ExchangeNotificationEnabled <$true | $false>] - [-ExchangeNotificationRecipients <MultiValuedProperty>] - [-FocusedInboxOn <$true | $false>] - [-HierarchicalAddressBookRoot <UserContactGroupIdParameter>] - [-IPListBlocked <MultiValuedProperty>] - [-IsAgendaMailEnabled <$true | $false>] - [-LeanPopoutEnabled <$true | $false>] - [-LinkPreviewEnabled <$true | $false>] - [-MailTipsAllTipsEnabled <$true | $false>] - [-MailTipsExternalRecipientsTipsEnabled <$true | $false>] - [-MailTipsGroupMetricsEnabled <$true | $false>] - [-MailTipsLargeAudienceThreshold <UInt32>] - [-MailTipsMailboxSourcedTipsEnabled <$true | $false>] - [-OAuth2ClientProfileEnabled <$true | $false>] - [-OutlookMobileHelpShiftEnabled <$true | $false>] - [-PerTenantSwitchToESTSEnabled <$true | $false>] - [-PreferredInternetCodePageForShiftJis <Int32>] - [-PublicComputersDetectionEnabled <$true | $false>] - [-PublicFoldersEnabled <None | Local | Remote>] - [-PublicFolderShowClientControl <$true | $false>] - [-ReadTrackingEnabled <$true | $false>] - [-RefreshSessionEnabled <$true | $false>] - [-RemotePublicFolderMailboxes <MultiValuedProperty>] - [-RequiredCharsetCoverage <Int32>] - [-SiteMailboxCreationURL <Uri>] - [-SmtpActionableMessagesEnabled <$true | $false>] - [-UnblockUnsafeSenderPromptEnabled <$true | $false>] - [-VisibleMeetingUpdateProperties <String>] - [-WebSuggestedRepliesDisabled <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -### AdfsAuthenticationRawConfiguration -``` -Set-OrganizationConfig [-AdfsAuthenticationConfiguration <String>] - [-ACLableSyncedObjectEnabled <$true | $false>] - [-ActivityBasedAuthenticationTimeoutEnabled <$true | $false>] - [-ActivityBasedAuthenticationTimeoutInterval <EnhancedTimeSpan>] - [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled <$true | $false>] - [-AppsForOfficeEnabled <$true | $false>] - [-AsyncSendEnabled <$true | $false>] - [-ByteEncoderTypeFor7BitCharsets <Int32>] - [-Confirm] - [-ConnectorsActionableMessagesEnabled <$true | $false>] - [-ConnectorsEnabled <$true | $false>] - [-CustomerLockboxEnabled <$true | $false>] - [-CustomerFeedbackEnabled <$true | $false>] - [-DataClassifications <String>] - [-DefaultPublicFolderAgeLimit <EnhancedTimeSpan>] - [-DefaultPublicFolderDeletedItemRetention <EnhancedTimeSpan>] - [-DefaultPublicFolderIssueWarningQuota <Unlimited>] - [-DefaultPublicFolderMaxItemSize <Unlimited>] - [-DefaultPublicFolderMovedItemRetention <EnhancedTimeSpan>] - [-DefaultPublicFolderProhibitPostQuota <Unlimited>] - [-DistributionGroupDefaultOU <OrganizationalUnitIdParameter>] - [-DistributionGroupNameBlockedWordsList <MultiValuedProperty>] - [-DistributionGroupNamingPolicy <DistributionGroupNamingPolicy>] - [-DomainController <Fqdn>] - [-EwsAllowEntourage <$true | $false>] - [-EwsAllowList <MultiValuedProperty>] - [-EwsAllowMacOutlook <$true | $false>] - [-EwsAllowOutlook <$true | $false>] - [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] - [-EwsBlockList <MultiValuedProperty>] - [-EwsEnabled <$true | $false>] - [-Force] - [-HierarchicalAddressBookRoot <UserContactGroupIdParameter>] - [-Industry <NotSpecified | Agriculture | Finance | BusinessServicesConsulting | Communications | ComputerRelatedProductsServices | Construction | Education | EngineeringArchitecture | Government | Healthcare | Hospitality | Legal | Manufacturing | MediaMarketingAdvertising | Mining | NonProfit | PersonalServices | PrintingPublishing | RealEstate | Retail | Transportation | Utilities | Wholesale | Other>] - [-IsAgendaMailEnabled <$true | $false>] - [-IsExcludedFromOffboardMigration <$true | $false>] - [-IsExcludedFromOnboardMigration <$true | $false>] - [-IsFfoMigrationInProgress <$true | $false>] - [-LeanPopoutEnabled <$true | $false>] - [-LinkPreviewEnabled <$true | $false>] - [-MailTipsAllTipsEnabled <$true | $false>] - [-MailTipsExternalRecipientsTipsEnabled <$true | $false>] - [-MailTipsGroupMetricsEnabled <$true | $false>] - [-MailTipsLargeAudienceThreshold <UInt32>] - [-MailTipsMailboxSourcedTipsEnabled <$true | $false>] - [-ManagedFolderHomepage <String>] - [-MapiHttpEnabled <$true | $false>] - [-MaxConcurrentMigrations <Unlimited>] - [-MicrosoftExchangeRecipientEmailAddresses <ProxyAddressCollection>] - [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled <$true | $false>] - [-MicrosoftExchangeRecipientPrimarySmtpAddress <SmtpAddress>] - [-MicrosoftExchangeRecipientReplyRecipient <RecipientIdParameter>] - [-OAuth2ClientProfileEnabled <$true | $false>] - [-OrganizationSummary <MultiValuedProperty>] - [-PermanentlyDeleteDisabled <$true | $false>] - [-PreferredInternetCodePageForShiftJis <Int32>] - [-PublicComputersDetectionEnabled <$true | $false>] - [-PublicFolderContentReplicationDisabled <$true | $false>] - [-PublicFolderMailboxesLockedForNewConnections <$true | $false>] - [-PublicFolderMailboxesMigrationComplete <$true | $false>] - [-PublicFolderMigrationComplete <$true | $false>] - [-PublicFoldersEnabled <None | Local | Remote>] - [-PublicFoldersLockedForMigration <$true | $false>] - [-ReadTrackingEnabled <$true | $false>] - [-RefreshSessionEnabled <$true | $false>] - [-RemotePublicFolderMailboxes <MultiValuedProperty>] - [-RequiredCharsetCoverage <Int32>] - [-SCLJunkThreshold <Int32>] - [-SiteMailboxCreationURL <Uri>] - [-SmtpActionableMessagesEnabled <$true | $false>] - [-UMAvailableLanguages <MultiValuedProperty>] - [-UnblockUnsafeSenderPromptEnabled <$true | $false>] - [-WACDiscoveryEndpoint <String>] - [-WhatIf] [<CommonParameters>] -``` - -### AdfsAuthenticationParameter -``` -Set-OrganizationConfig [-AdfsAudienceUris <MultiValuedProperty>] [-AdfsEncryptCertificateThumbprint <String>] [-AdfsIssuer <Uri>] [-AdfsSignCertificateThumbprints <MultiValuedProperty>] - [-ACLableSyncedObjectEnabled <true | $false>] - [-ActivityBasedAuthenticationTimeoutEnabled <$true | $false>] - [-ActivityBasedAuthenticationTimeoutInterval <EnhancedTimeSpan>] - [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled <$true | $false>] - [-AppsForOfficeEnabled <$true | $false>] - [-AsyncSendEnabled <$true | $false>] - [-ByteEncoderTypeFor7BitCharsets <Int32>] - [-Confirm] - [-ConnectorsActionableMessagesEnabled <$true | $false>] - [-ConnectorsEnabled <$true | $false>] - [-CustomerFeedbackEnabled <$true | $false>] - [-DataClassifications <String>] - [-DefaultPublicFolderAgeLimit <EnhancedTimeSpan>] - [-DefaultPublicFolderDeletedItemRetention <EnhancedTimeSpan>] - [-DefaultPublicFolderIssueWarningQuota <Unlimited>] - [-DefaultPublicFolderMaxItemSize <Unlimited>] - [-DefaultPublicFolderMovedItemRetention <EnhancedTimeSpan>] - [-DefaultPublicFolderProhibitPostQuota <Unlimited>] - [-DistributionGroupDefaultOU <OrganizationalUnitIdParameter>] - [-DistributionGroupNameBlockedWordsList <MultiValuedProperty>] - [-DistributionGroupNamingPolicy <DistributionGroupNamingPolicy>] - [-DomainController <Fqdn>] - [-EwsAllowEntourage <$true | $false>] - [-EwsAllowList <MultiValuedProperty>] - [-EwsAllowMacOutlook <$true | $false>] - [-EwsAllowOutlook <$true | $false>] - [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] - [-EwsBlockList <MultiValuedProperty>] - [-EwsEnabled <$true | $false>] - [-ExchangeNotificationEnabled <$true | $false>] - [-ExchangeNotificationRecipients <MultiValuedProperty>] - [-Force] - [-HierarchicalAddressBookRoot <UserContactGroupIdParameter>] - [-Industry <NotSpecified | Agriculture | Finance | BusinessServicesConsulting | Communications | ComputerRelatedProductsServices | Construction | Education | EngineeringArchitecture | Government | Healthcare | Hospitality | Legal | Manufacturing | MediaMarketingAdvertising | Mining | NonProfit | PersonalServices | PrintingPublishing | RealEstate | Retail | Transportation | Utilities | Wholesale | Other>] - [-IsAgendaMailEnabled <$true | $false>] - [-IsExcludedFromOffboardMigration <$true | $false>] - [-IsExcludedFromOnboardMigration <$true | $false>] - [-IsFfoMigrationInProgress <$true | $false>] - [-LeanPopoutEnabled <$true | $false>] - [-LinkPreviewEnabled <$true | $false>] - [-MailTipsAllTipsEnabled <$true | $false>] - [-MailTipsExternalRecipientsTipsEnabled <$true | $false>] - [-MailTipsGroupMetricsEnabled <$true | $false>] - [-MailTipsLargeAudienceThreshold <UInt32>] - [-MailTipsMailboxSourcedTipsEnabled <$true | $false>] - [-ManagedFolderHomepage <String>] - [-MapiHttpEnabled <$true | $false>] - [-MaxConcurrentMigrations <Unlimited>] - [-MicrosoftExchangeRecipientEmailAddresses <ProxyAddressCollection>] - [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled <$true | $false>] - [-MicrosoftExchangeRecipientPrimarySmtpAddress <SmtpAddress>] - [-MicrosoftExchangeRecipientReplyRecipient <RecipientIdParameter>] - [-OAuth2ClientProfileEnabled <$true | $false>] - [-OrganizationSummary <MultiValuedProperty>] - [-PermanentlyDeleteDisabled <$true | $false>] - [-PreferredInternetCodePageForShiftJis <Int32>] - [-PublicComputersDetectionEnabled <$true | $false>] - [-PublicFolderContentReplicationDisabled <$true | $false>] - [-PublicFolderMailboxesLockedForNewConnections <$true | $false>] - [-PublicFolderMailboxesMigrationComplete <$true | $false>] - [-PublicFolderMigrationComplete <$true | $false>] - [-PublicFoldersEnabled <None | Local | Remote>] - [-PublicFoldersLockedForMigration <$true | $false>] - [-ReadTrackingEnabled <$true | $false>] - [-RefreshSessionEnabled <$true | $false>] - [-RemotePublicFolderMailboxes <MultiValuedProperty>] - [-RequiredCharsetCoverage <Int32>] - [-SCLJunkThreshold <Int32>] - [-SiteMailboxCreationURL <Uri>] - [-SmtpActionableMessagesEnabled <$true | $false>] - [-UMAvailableLanguages <MultiValuedProperty>] - [-UnblockUnsafeSenderPromptEnabled <$true | $false>] - [-WACDiscoveryEndpoint <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-OrganizationConfig -DistributionGroupDefaultOU Users\Groups -DistributionGroupNameBlockedWordsList curse,bad,offensive -DistributionGroupNamingPolicy "DL_<GroupName>_<Department><CountryCode>" -``` - -This example creates a distribution group naming policy using the following configuration: - -Distribution groups will be created in the Users\\Groups container. - -The words curse, bad, and offensive will be 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. - -### -------------------------- Example 2 -------------------------- -``` -Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceBlockList -EwsBlockList $null -``` - -This example allows all client applications to use REST and EWS. - -### -------------------------- Example 3 -------------------------- -``` -Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceBlockList -EwsBlockList "OtherApps*" -``` - -This example allows all client applications to use REST and EWS, except those that are specified by the EwsBlockList parameter. - -### -------------------------- Example 4 -------------------------- -``` -Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceAllowList -EwsAllowList $null -``` - -This example prevents all client applications from using REST and EWS. - -### -------------------------- Example 5 -------------------------- -``` -Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceAllowList -EwsAllowList "CorpApp*" -``` - -This example allows only the client applications specified by the EwsAllowList parameter to use REST and EWS. - -### -------------------------- Example 6 -------------------------- -``` -Set-OrganizationConfig -VisibleMeetingUpdateProperties Location:15 -``` - -In Exchange Online, this example results in meeting updates being auto-processed (meeting update messages aren't visible in attendee Inbox folders) except if the meeting location changes within 15 minutes of the meeting start time. - -## PARAMETERS - - -### -ACLableSyncedObjectEnabled -This parameter is available only in on-premises Exchange. - -The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in hybrid environments are stamped as ACLableSyncedMailboxUser. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -ActivityBasedAuthenticationTimeoutEnabled -The ActivityBasedAuthenticationTimeoutEnabled parameter specifies whether the timed logoff feature is enabled. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -ActivityBasedAuthenticationTimeoutInterval -The ActivityBasedAuthenticationTimeoutInterval parameter specifies the time span for logoff. - -You enter this value as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds. - -Valid values for this parameter are from 00:05:00 to 08:00:00 (5 minutes to 8 hours). The default value is 06:00:00 (6 hours). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled -The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter specifies whether to keep single sign-on enabled. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -AdfsAudienceUris -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. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -For more information about configuring AD FS claims based authentication in Exchange, see Use AD FS claims-based authentication with Outlook on the web (https://technet.microsoft.com/library/dn635116.aspx). - -```yaml -Type: MultiValuedProperty -Parameter Sets: AdfsAuthenticationParameter -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 -``` - -### -AdfsAuthenticationConfiguration -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: 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 -``` - -### -AdfsEncryptCertificateThumbprint -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: AdfsAuthenticationParameter -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 -``` - -### -AdfsIssuer -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. - -To get this value, open Windows PowerShell on the AD FS server and run the command Get-ADFSEndpoint -AddressPath /adfs/ls | Format-List FullUrl. - -```yaml -Type: Uri -Parameter Sets: AdfsAuthenticationParameter -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 -``` - -### -AdfsSignCertificateThumbprints -This parameter is available only in on-premises Exchange. - -The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-signing certificates that are used for AD FS claims-based authentication. This parameter uses certificate thumbprint values (GUIDs) to identify the certificates. - -To get the thumbprint values of the primary and secondary token-signing certificates, open Windows PowerShell on the AD FS server and run the command Get-ADFSCertificate -CertificateType "Token-signing". For more information, see Get-ADFSCertificate (https://go.microsoft.com/fwlink/p/?linkid=392706). - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AdfsAuthenticationParameter -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 -``` - -### -AppsForOfficeEnabled -The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsyncSendEnabled -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. - -- $false: Async send is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditDisabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoExpandingArchive -This parameter is available only in the cloud-based service. - -The AutoExpandingArchive switch enables the unlimited archiving feature (called auto-expanding archiving) in an Exchange Online organization. You don't need to specify a value with this switch. - -After you enable auto-expanding archiving, additional storage space is automatically added to a user's archive mailbox when it approaches the storage limit. Note that a user's archive mailbox has to be enabled before auto-expanding archiving can take effect. Also note that after you enable auto-expanding archiving for your organization, it can't be disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookingsEnabled -This parameter is available only in the cloud-based service. - -The BookingsEnabled parameter specifies whether to enable Microsoft Bookings in an Exchange Online organization. Valid values are: - -- $true: Bookings are enabled. - -- $false: Bookings are disabled. This is the default value. - -Microsoft Bookings is an online and mobile app for small businesses who provide services to customers on an appointment basis. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookingsPaymentsEnabled -This parameter is available only in the cloud-based service. - -{{Fill BookingsPaymentsEnabled Description}} - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookingsSocialSharingRestricted -This parameter is available only in the cloud-based service. - -{{Fill BookingsSocialSharingRestricted Description}} - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ByteEncoderTypeFor7BitCharsets -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. - -- 1: Always use QP (quoted-printable) encoding for HTML and plain text. - -- 2: Always use Base64 encoding for HTML and plain text. - -- 5: Use QP encoding for HTML and plain text unless line wrapping is enabled in plain text. If line wrapping is enabled, use 7-bit encoding for plain text. - -- 6: Use Base64 encoding for HTML and 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. - -- 13: Always use QP encoding for HTML. Always use 7-bit encoding for plain text. - -- 14: Always use Base64 encoding for HTML. Always use 7-bit encoding for plain text. - -If no value is specified, Exchange always uses QP encoding for HTML and plain text. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarVersionStoreEnabled -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -ConnectorsActionableMessagesEnabled -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. - -- $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://go.microsoft.com/fwlink/p/?LinkId=845310). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorsEnabled -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. - -- $false: Connectors are disabled. - -The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Yammer. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorsEnabledForOutlook -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. - -- $false: Connectors are disabled. - -To enable and disable the ability to use connectors on specific Office 365 groups, set the value of this parameter to $true, and then use the ConnectorsEnabled switch on the Set-UnifiedGroup cmdlet. - -For more information about connectors for Outlook on the web, see Connect apps to your inbox in Outlook on the web (https://go.microsoft.com/fwlink/p/?LinkId=845310). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorsEnabledForSharepoint -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. - -- $false: Connectors are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorsEnabledForTeams -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. - -- $false: Connectors are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorsEnabledForYammer -This parameter is available only in the cloud-based service. - -The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Yammer. Valid values are: - -- $true: Connectors are enabled. This is the default value. - -- $false: Connectors are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomerFeedbackEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -CustomerLockboxEnabled -This parameter is available only in the cloud-based service. - -The CustomerLockboxEnabled specifies whether Customer Lockbox requests are enabled or disabled for the organization. Valid values are: - -- $true: Customer Lockbox requests are enabled. Requests by Microsoft support engineers to access your data appear in the Office 365 admin center for you to approve or reject. - -- $false: Customer Lockbox are disabled. - -Customer Lockbox is included in the Office 365 E5 plan. For more information about Customer Lockbox, see Office 365 Customer Lockbox Requests (https://go.microsoft.com/fwlink/p/?LinkId=624318). - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataClassifications -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultGroupAccessType -This parameter is available only in the cloud-based service. - -The DefaultGroupAccessType parameter specifies the default access type for Office 365 groups. Valid values are: - -- Public - -- Private (this is the default value) - -```yaml -Type: Private | Public -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: Private -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderAgeLimit -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). - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderDeletedItemRetention -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: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderIssueWarningQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderMaxItemSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderMovedItemRetention -The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. - -When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see Set-PublicFolder. - -```yaml -Type: EnhancedTimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultPublicFolderProhibitPostQuota -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectReportsGroupAutoCreationEnabled -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 Office 365 groups. Valid values are: - -- $true: The automatic creation of direct report Office 365 groups is enabled. This is the default value. - -- $false: The automatic creation of direct report Office 365 groups is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionGroupDefaultOU -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionGroupNameBlockedWordsList -The DistributionGroupNameBlockedWordsList parameter specifies words that can't be included in the names of distribution groups. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionGroupNamingPolicy -The DistributionGroupNamingPolicy parameter specifies the template applied to the name of distribution groups that are created in the organization. You can enforce that a prefix or suffix be applied to all distribution groups. Prefixes and suffixes can be either a string or an attribute, and you can combine strings and attributes. When creating a naming policy, use the following syntax: - -"prefix\<GroupName\>suffix" - -Don't set the \<GroupName\>. Users create the name when they create the distribution group. You can have multiple prefixes and suffixes. - -You can use the following attributes that will be gathered from the user who's creating the distribution group mailbox settings: - -- Department - -- Company - -- Office - -- StateOrProvince - -- CountryOrRegion - -- CountryCode - -- Title - -- CustomAttribute1 to CustomAttribute15 - -To create a naming policy using an attribute, use the following syntax: "\<PrefixAttribute\>\<GroupName\>\<SuffixAttribute\>". - -For example, to create a naming policy using the Department as a prefix and CustomAttribute1 as the suffix: - -"\<Department\>\<GroupName\>\<CustomAttribute1\>". - -To create a naming policy using strings, use the following syntax "string\<GroupName\>string". For example to create a naming policy using the string "DL\_" as the prefix use the following syntax: "DL\_\<GroupName\>". - -```yaml -Type: DistributionGroupNamingPolicy -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -ElcProcessingDisabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndUserDLUpgradeFlowsDisabled -This parameter is available only in the cloud-based service. - -The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users from upgrading their own distribution groups to Office 365 groups in an Exchange Online organization. Valid values are: - -- $true: Users can upgrade distribution groups that they own to Office 365 groups. - -- $false: Users can't upgrade distribution groups that they own to Office 365 groups. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowEntourage -The EwsAllowEntourage parameter specifies whether to enable or disable Entourage 2008 to access Exchange Web Services (EWS) for the entire organization. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -EwsAllowList -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsAllowMacOutlook -The EwsAllowMacOutlook parameter specifies whether to enable or disable Microsoft Outlook for Mac 2011 to access EWS for the entire organization. - -```yaml -Type: $true | $false -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 -``` - -### -EwsAllowOutlook -The EwsAllowOutlook parameter enables or disables Microsoft Office Outlook 2007 to access EWS for the entire organization. Outlook 2007 uses EWS for free and busy information, out-of-office settings, and calendar sharing. - -```yaml -Type: $true | $false -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 -``` - -### -EwsApplicationAccessPolicy -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 this parameter doesn't affect access to EWS by Entourage, Mac Outlook, and Outlook. Access to EWS by these applications is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters. - -```yaml -Type: EnforceAllowList | EnforceBlockList -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 -``` - -### -EwsBlockList -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EwsEnabled -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 releated EWS parameters (for example EwsAllowEntourage). This is the default value. - -This parameter has no affect on access to REST. - -```yaml -Type: $true | $false -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 -``` - -### -ExchangeNotificationEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeNotificationRecipients -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FocusedInboxOn -This parameter is available only in the cloud-based service. - -The FocusedInboxOn parameter enables or disables Focused Inbox for the organization. Valid values are: - -- $true: Focused Inbox is enabled. - -- $false: Focused Inbox is disabled. - -To disable Focused Inbox on specific mailboxes, enable Focused Inbox for the organization, and then use the Set-FocusedInbox cmdlet. - -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. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is available or functional only in Exchange Server 2010. - -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HierarchicalAddressBookRoot -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -Setting a value for this parameter enables the hierarchical address book to be automatically displayed in Outlook for the organization. - -The default value is blank. To reset this parameter, use the value $null. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Industry -This parameter is available only in on-premises Exchange. - -The Industry parameter specifies the industry that best represents your organization. - -```yaml -Type: NotSpecified | Agriculture | Finance | BusinessServicesConsulting | Communications | ComputerRelatedProductsServices | Construction | Education | EngineeringArchitecture | Government | Healthcare | Hospitality | Legal | Manufacturing | MediaMarketingAdvertising | Mining | NonProfit | PersonalServices | PrintingPublishing | RealEstate | Retail | Transportation | Utilities | Wholesale | Other -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -IPListBlocked -This parameter is available only in the cloud-based service. - -The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. These settings affect client connections that use Basic authentication where on-premises Active Directory Federation Services (ADFS) servers federate authentication with Azure Active Directory. Note that the new settings might take up to 4 hours to fully propagate across the service. - -This parameter accepts IPv4 or IPv6 addresses in the following formats: - -- Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. - -- IP address range high-low: For example, 192.168.0.1-192.168.0.254. - -- IP address range with subnet mask: For example, 192.168.8.2(255.255.255.0). - -- Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24 or 2001:0DB8::CD3/60. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAgendaMailEnabled -The IsAgendaMailEnabled parameter specifies whether to enable or disable daily agenda messages. Valid values are: - -- $true: Users receive a daily agenda message in their Inbox from the Microsoft Outlook Calendar. This is the default value. - -- $false: The daily agenda message is disabled for all users. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsExcludedFromOffboardMigration -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -IsExcludedFromOnboardMigration -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -IsFfoMigrationInProgress -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - - -### -LeanPopoutEnabled -The LeanPopoutEnabled parameter specifies whether to enable faster loading of pop-out messages in Outlook on the web for Internet Explorer and Microsoft Edge. Valid values are: - -- $true: Lean pop-outs are enabled. - -- $false: Lean pop-outs are disabled. This is the default value. - -Notes: - -- Lean pop-outs aren't available for messages that contain attachments or information rights management (IRM) restrictions. - -- Outlook add-ins and Skype for Business Online presence aren't available with lean pop-outs. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkPreviewEnabled -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. - -- $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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipsAllTipsEnabled -The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsExternalRecipientsTipsEnabled -The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsGroupMetricsEnabled -The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsLargeAudienceThreshold -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipsMailboxSourcedTipsEnabled -The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. - -```yaml -Type: $true | $false -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 -``` - -### -ManagedFolderHomepage -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. - -```yaml -Type: String -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -MapiHttpEnabled -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. - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -MaxConcurrentMigrations -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. - -```yaml -Type: Unlimited -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -MicrosoftExchangeRecipientEmailAddresses -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. - -Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAddresses parameter replace any existing email addresses already configured. - -```yaml -Type: ProxyAddressCollection -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -MicrosoftExchangeRecipientEmailAddressPolicyEnabled -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. - -If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter from $false to $true, any email addresses that you defined by using the MicrosoftExchangeRecipientEmailAddresses parameter are preserved. However, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter reverts to MicrosoftExchange329e71ec88ae4615bbc36ab6ce41109e@\<Accepted Domain in Highest Priority Email Address Policy\>. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -MicrosoftExchangeRecipientPrimarySmtpAddress -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. - -If you modify the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter, the value is automatically added to the list of email addresses defined in the MicrosoftExchangeRecipientEmailAddresses parameter. - -The MicrosoftExchangeRecipientPrimarySmtpAddress parameter is meaningful only if the Exchange recipient has more than one defined SMTP email address. If the MicrosoftExchangeRecipientEmailAddresses parameter has only one defined SMTP email address, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter and the MicrosoftExchangeRecipientEmailAddresses parameter are the same. - -```yaml -Type: SmtpAddress -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -MicrosoftExchangeRecipientReplyRecipient -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -OAuth2ClientProfileEnabled -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. - -When you enable modern authentication in Exchange Online, we recommend that you also enable it in Skype for Business Online. For more information, see https://aka.ms/SkypeModernAuth (https://aka.ms/SkypeModernAuth). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationSummary -This parameter is available only in on-premises Exchange. - -The OrganizationSummary parameter specifies a summarized description that best represents your organization. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -OutlookMobileHelpShiftEnabled -This parameter is available only in the cloud-based service. - -{{Fill OutlookMobileHelpShiftEnabled Description}} - -```yaml -Type: Boolean -Parameter Sets: $true | $false -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermanentlyDeleteDisabled -This parameter is available or functional 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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerTenantSwitchToESTSEnabled -This parameter is available only in the cloud-based service. - -This parameter has been deprecated and is no longer used. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredInternetCodePageForShiftJis -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderContentReplicationDisabled -This parameter is available or functional 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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderMailboxesLockedForNewConnections -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -PublicFolderMailboxesMigrationComplete -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) - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -PublicFolderMigrationComplete -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -PublicFoldersEnabled -The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. This parameter uses one of the following values. - -- Local: The public folders are deployed locally in your organization. - -- Remote: The public folders are deployed in the remote forest. - -- None: No public folders are deployed for this organization. - -```yaml -Type: None | Local | Remote -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderShowClientControl -This parameter is available only in the cloud-based service. - -The PublicFolderShowClientControl parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - -- $true: Users can access public folders in Outlook if the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is set to the value $true (the default value is $false). - -- $false: User can't access public folders in Outlook. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFoldersLockedForMigration -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. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -ReadTrackingEnabled -The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. - -```yaml -Type: $true | $false -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 -``` - -### -RefreshSessionEnabled -The RefreshSessionEnabled parameter specifies whether to enable or disable the use of refresh tokens when using OpenID Connect for authentication. Valid values are: - -- $true: Refresh tokens are enabled. - -- $false: Refresh tokens are disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemotePublicFolderMailboxes -The RemotePublicFolderMailboxes parameter specifies the identities of the public folder objects (represented as mail user objects locally) corresponding to the public folder mailboxes created in the remote forest. The public folder values set here are used only if the public folder deployment is a remote deployment. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredCharsetCoverage -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SCLJunkThreshold -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. - -```yaml -Type: Int32 -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -SiteMailboxCreationURL -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: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmtpActionableMessagesEnabled -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. - -- $false: Action buttons in email messages are disabled. - -```yaml -Type: $true | $false -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMAvailableLanguages -This parameter is available only in on-premises Exchange. - -This parameter has been deprecated and is no longer used. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -UnblockUnsafeSenderPromptEnabled -The UnblockUnsafeSenderPromptEnabled parameter specifies whether to enable or disable the prompt to unblock unsafe senders in Outlook on the web. Valid values are: - -- $true: The prompt to unblock unsafe senders is enabled. This is the default value. - -- $false: The prompt to unblock unsafe senders is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisibleMeetingUpdateProperties -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. - -This parameter uses the syntax: MeetingProperty1:MeetingStartTimeWithinXMinutes1,MeetingProperty2:MeetingStartTimeWithinXMinutes2,...MeetingPropertyN:MeetingStartTimeWithinXMinutesN. - -The valid meeting properties to monitor for updates are: - -- Location: The meeting location field. - -- Subject: The meeting subject or title. - -- Sensitivity: The sensitivity (privacy) of the event. - -- Body: The meeting body or description. - -- OnlineMeetingLinks: The meeting join URL. - -- AllowForwarding: The option to allow or prevent forwarding of meetings. - -- RequestResponses: The option on whether responses are requested. - -- AllowNewTimeProposals: The option to allow or prevent new time proposals. - -- ShowAs: The free/busy state of the meeting: Free, Tentative, Busy, Working elsewhere, or Away/Out of office. - -- 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. - -The default value is `Location,AllProperties:15`: changes to the meeting location at any time, or changes to other meeting properties within 15 minutes of the meeting start time results in visible meeting update messages. - -There are three scenarios where meeting update messages are not auto-processed regardless of the values specified in this parameter (in these scenarios, attendees will always see meeting update messages in their Inbox): - -- The update contains a change to the meeting date, time, or recurrence pattern. - -- The meeting message is received for a delegated shared calendar. - -- The receiving attendee is @ mentioned in the meeting body. - -- The attendee has not yet responded to the meeting. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WACDiscoveryEndpoint -This parameter is available only in on-premises Exchange. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter -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 -``` - -### -WebSuggestedRepliesDisabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Default -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3b6df0fe-27c8-415f-ad0c-8b265f234c1a.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Set-PerimeterConfig.md b/exchange/exchange-ps/exchange/organization/Set-PerimeterConfig.md deleted file mode 100644 index 9ec1b08a90..0000000000 --- a/exchange/exchange-ps/exchange/organization/Set-PerimeterConfig.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online -title: Set-PerimeterConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-PerimeterConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-PerimeterConfig cmdlet to modify the list of gateway server IP addresses that have been added to the cloud-based safelists. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-PerimeterConfig [-Confirm] [-GatewayIPAddresses <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -If you have an on-premises email system, you can use the Set-PerimeterConfig cmdlet to add the IP addresses of your gateway servers to cloud-based safelists (also known as whitelists) to make sure that messages sent from your on-premises email system aren't treated as spam. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-PerimeterConfig -GatewayIPAddresses 123.0.0.1 -``` - -This example shows how to add an IP address to cloud-based safelists where the gateway server relays email to the cloud-based service from internal email servers only. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayIPAddresses -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4f40a5fc-3275-42a0-b12f-a199bd42c8d5.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Test-OAuthConnectivity.md b/exchange/exchange-ps/exchange/organization/Test-OAuthConnectivity.md deleted file mode 100644 index 4f0fe5e0ee..0000000000 --- a/exchange/exchange-ps/exchange/organization/Test-OAuthConnectivity.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-OAuthConnectivity -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Test-OAuthConnectivity cmdlet to test OAuth authentication to partner applications for a user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-OAuthConnectivity -Service <EWS | AutoD | Generic> -TargetUri <Uri> [-AppOnly] [-Confirm] - [-Mailbox <MailboxIdParameter>] [-OrganizationDomain <String>] [-ReloadConfig] [-UseCachedToken] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -SharePoint, Lync and Skype for Business partner applications are automatically created in on-premises Exchange deployments. For the Test-OAuthConnectivity cmdlet to succeed for other partner applications, you first need to create the partner application by using the Configure-EnterpriseApplication.ps1 script. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-OAuthConnectivity -Service EWS -TargetUri https://cas.contoso.com/ews/ -Mailbox "Gurinder Singh" -``` - -This example tests OAuth connectivity with Exchange for Gurinder Singh. - -## PARAMETERS - -### -Service -The Service parameter specifies the partner application. Valid values for this parameter are: - -- EWS - -- AutoD - -- Generic - -```yaml -Type: EWS | AutoD | Generic -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUri -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 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the mailbox for which you want to test OAuth connectivity to the specified partner application. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationDomain -This parameter is available only in the cloud-based service. - -The OrganizationDomain parameter specifies the domain name of the Office 365 organization. For example, contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReloadConfig -The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. If you don't use this switch, the cached configuration settings are used. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/26aa9772-aa31-4765-b2a4-d0dd78d77fc8.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Test-SystemHealth.md b/exchange/exchange-ps/exchange/organization/Test-SystemHealth.md deleted file mode 100644 index 7d62d4ac3e..0000000000 --- a/exchange/exchange-ps/exchange/organization/Test-SystemHealth.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010 -title: Test-SystemHealth -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Test-SystemHealth - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Test-SystemHealth cmdlet to gather data about your Microsoft Exchange system and to analyze the data according to best practices. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-SystemHealth [-ADCredentials <PSCredential>] [-Analyze] [-Collect] [-ConfigurationData <Byte[]>] - [-ConfigurationFileLocation <LongPath>] [-Confirm] [-Description <String>] [-DomainController <Fqdn>] - [-DownloadConfigurationUpdates] [-ExchangeCredentials <PSCredential>] [-Export] [-GenerateEvents] - [-GenerateSQMData] [-MaxThreads <Int32>] [-MergeFileLocation <LongPath>] [-OutData] - [-OutFileLocation <LongPath>] [-Roles <String[]>] [-ScanType <String>] [-ServerList <String[]>] - [-Timeout <EnhancedTimeSpan>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-SystemHealth -``` - -This example gathers data about your Exchange system. - -### -------------------------- Example 2 -------------------------- -``` -$temp=Test-SystemHealth -OutData; Set-Content -Value $temp.FileData -Path d:\temp\SystemHealthOutData.xml -Encoding Byte -``` - -This example saves the output data as a byte stream to the temporary variable $temp. Then the content is written to the file SystemHealthOutData.xml using the Set-Content cmdlet. - -## PARAMETERS - -### -ADCredentials -The ADCredentials parameter specifies the credentials used to access Active Directory. The default value is the current user's credentials. - -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://go.microsoft.com/fwlink/p/?linkid=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Analyze -The Analyze parameter specifies whether to enable analysis on the data gathered. A value of $true enables analysis. The default value is $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Collect -The Collect parameter specifies whether to enable data collection. A value of $true enables data collection. The default value is $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationData -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationFileLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: LongPath -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DownloadConfigurationUpdates -The DownloadConfigurationUpdates parameter checks for and downloads newer versions of the configuration file. The default value is $true, which checks for and downloads newer versions of the configuration file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeCredentials -The ExchangeCredentials parameter identifies the credentials to apply for accessing servers running Exchange. - -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://go.microsoft.com/fwlink/p/?linkid=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Export -The Export parameter causes sensitive data to be removed from the output file specified. A value of $true causes data removal. The default value is $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateEvents -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateSQMData -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxThreads -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MergeFileLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: LongPath -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutData -The OutData switch specifies whether the output data is sent as a byte stream. For example, if you run $temp=Test-SystemHealth -OutData, $temp contains the byte stream of the output data, and you can covert it back to xml by using the Set-Content command. For a code sample, see "Example 2" later in this topic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutFileLocation -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Roles -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScanType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerList -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/65ceedf4-796d-4dda-a126-c7cd4d509f67.aspx) diff --git a/exchange/exchange-ps/exchange/organization/Update-ExchangeHelp.md b/exchange/exchange-ps/exchange/organization/Update-ExchangeHelp.md deleted file mode 100644 index 2715fa3911..0000000000 --- a/exchange/exchange-ps/exchange/organization/Update-ExchangeHelp.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-ExchangeHelp -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Update-ExchangeHelp - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Update-ExchangeHelp cmdlet to find, download and install the latest available help topics for the Exchange Management Shell on the local computer. If an available version is found based your installed version and languages of Exchange, the cmdlet downloads and integrates the updated version of Help in the Exchange Management Shell. This cmdlet is a required substitute for the Update-Help cmdlet that's available in Windows PowerShell. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-ExchangeHelp [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-ExchangeHelp cmdlet is available in Exchange Server 2013 or later. - -You need to run the Update-ExchangeHelp cmdlet on each Exchange server. By default, the cmdlet requires an Internet connection, but you can configure an offline mode. For more information, see Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers (https://technet.microsoft.com/library/mt588490.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-ExchangeHelp -Force -``` - -This example checks for the latest available version of Help for the Exchange Management Shell on the local computer. Because we used the Force switch, the command checks for updates even if you ran the command less than 24 hours ago and displays status and error messages. - -## PARAMETERS - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3ab76294-cde8-4a15-9949-eb744713dd65.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md deleted file mode 100644 index f56c01bffb..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AdminAuditLogConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-AdminAuditLogConfig cmdlet to view the administrator audit logging configuration settings. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdminAuditLogConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -When audit logging is enabled, a log entry is created for each cmdlet that's run, excluding Get 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdminAuditLogConfig | Format-List -``` - -This example displays the administrator audit logging settings. The output of the Get-AdminAuditLogConfig cmdlet is piped to the Format-List cmdlet. For more information about piping and the Format-List cmdlet, see the following topics: - -- Pipelining (https://technet.microsoft.com/library/aa998260.aspx) - -- Working with command output (https://technet.microsoft.com/library/bb123533.aspx) - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/775f7985-19f0-4681-afef-ac1db324784e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfig.md deleted file mode 100644 index e3bd16b771..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfig.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-AuditConfig -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-AuditConfig - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-AuditConfig cmdlet to view the auditing configuration in the Security & Compliance Center. The auditing configuration specifies where auditing is allowed in Microsoft Office 365. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuditConfig [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuditConfig -``` - -This example shows the auditing configuration in the Security & Compliance Center. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/251598e2-fd69-4b78-816c-d0e60ee9bede.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md deleted file mode 100644 index 8975708c45..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-AuditConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-AuditConfigurationPolicy cmdlet to view audit configuration policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuditConfigurationPolicy [[-Identity] <PolicyIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuditConfigurationPolicy | Format-List Name,Enabled,Workload,Priority,*Location -``` - -This example lists summary information about all audit configuration policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuditConfigurationPolicy -Identity 8d4d2060-ee8e-46a8-8d72-24922956fba5 -``` - -This examples lists details about the audit configuration policy named 8d4d2060-ee8e-46a8-8d72-24922956fba5. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9f594d2a-8bdc-48b7-90f0-b355948f2e27.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md deleted file mode 100644 index 75409c03ed..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-AuditConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-AuditConfigurationRule cmdlet to view audit configuration rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuditConfigurationRule [[-Identity] <ComplianceRuleIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuditConfigurationRule | Format-List Name,Workload,AuditOperation,Policy -``` - -This example lists summary information about all audit configuration rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 -``` - -This example lists details about the audit configuration rule named 989a3a6c-dc40-4fa4-8307-beb3ece992e9. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7a1cdf79-8e70-41c8-85fd-7c359c9e8f91.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md deleted file mode 100644 index bed9d9d8ef..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AuditLogSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-AuditLogSearch cmdlet to return a list of current audit log searches that were created with the New-AdminAuditLogSearch or New-MailboxAuditLogSearch cmdlets. The Get-AuditLogSearch cmdlet also returns audit log searches that are initiated whenever an administrator uses the Exchange admin center (EAC) to export audit logs. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AuditLogSearch [[-Identity] <AuditLogSearchIdParameter>] [-CreatedAfter <ExDateTime>] - [-CreatedBefore <ExDateTime>] [-ResultSize <Int32>] [-Type <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Run the Get-AuditLogSearch cmdlet to return a list of pending audit log searches. If an audit log search has been completed, it won't be displayed in the list of audit log searches. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AuditLogSearch | FL -``` - -This example displays detailed information for all current audit log searches. - -### -------------------------- Example 2 -------------------------- -``` -Get-AuditLogSearch -Type admin -``` - -This example returns a list of current administrator audit log searches. - -## PARAMETERS - -### -CreatedAfter -The CreatedAfter parameter filters the results to audit log searches that were created after the specified date. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreatedBefore -The CreatedBefore parameter filters the results to audit log searches that were created before the specified date. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5550b2c9-cb38-41cd-82a5-41d2125ad2d5.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md deleted file mode 100644 index a77a968a35..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxAuditBypassAssociation -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve user or computer accounts configured to bypass mailbox audit logging. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxAuditBypassAssociation [[-Identity] <MailboxAuditBypassAssociationIdParameter>] - [-DomainController <Fqdn>] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -When you configure a user or computer account to bypass mailbox audit logging, access or actions taken by the user or computer account to any mailbox isn't logged. By bypassing trusted user or computer accounts that need to access mailboxes frequently, you can reduce the noise in mailbox audit logs. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxAuditBypassAssociation -ResultSize unlimited -``` - -This example retrieves all user or computer accounts configured for mailbox audit logging bypass. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" -``` - -This example retrieves the mailbox audit bypass association for the Svc-MyApplication account. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies a user or computer account to retrieve audit logging bypass association for. - -```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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2e3d8264-0636-419d-8677-2be456c3551b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md deleted file mode 100644 index 46c14f2d4c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-AuditConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-AuditConfigurationPolicy cmdlet to create audit configuration policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AuditConfigurationPolicy - -Workload <None | Exchange | SharePoint | Intune | OneDriveForBusiness | PublicFolder | SharePointOnPremises | ExchangeOnPremises | AuditAlerting | Skype | ModernGroup> - [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AuditConfigurationPolicy -Workload SharePoint -``` - -This example creates an audit configuration policy for Microsoft SharePoint Online. - -## PARAMETERS - -### -Workload -The Workload parameter specifies where auditing is allowed. Valid values are: - -- Exchange - -- InTune - -- OneDriveForBusiness - -- SharePoint - -```yaml -Type: None | Exchange | SharePoint | Intune | OneDriveForBusiness | PublicFolder | SharePointOnPremises | ExchangeOnPremises | AuditAlerting | Skype | ModernGroup -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7f06779c-d643-40d1-8709-e949356e4412.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md deleted file mode 100644 index 6d298477a3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-AuditConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-AuditConfigurationRule cmdlet to create audit configuration rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AuditConfigurationRule -AuditOperation <MultiValuedProperty> - -Workload <None | Exchange | SharePoint | Intune | OneDriveForBusiness | PublicFolder | SharePointOnPremises | ExchangeOnPremises | AuditAlerting | Skype | ModernGroup> - [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workload -The Workload parameter specifies where the audit configuration policy applies. Valid values are: - -- Exchange - -- InTune - -- OneDriveForBusiness - -- SharePoint - -```yaml -Type: None | Exchange | SharePoint | Intune | OneDriveForBusiness | PublicFolder | SharePointOnPremises | ExchangeOnPremises | AuditAlerting | Skype | ModernGroup -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b9184a6b-6a5e-400f-926e-96f6e0a166fa.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md deleted file mode 100644 index 257e6f3aa3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxAuditLogSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-MailboxAuditLogSearch - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-MailboxAuditLogSearch cmdlet to search mailbox audit logs and have search results sent via email to specified recipients. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MailboxAuditLogSearch [-EndDate <ExDateTime> - -StartDate <ExDateTime> -StatusMailRecipients <MultiValuedProperty> [-Confirm] [-DomainController <Fqdn>] - [-ExternalAccess <$true | $false>] [-LogonTypes <MultiValuedProperty>] [-Mailboxes <MultiValuedProperty>] - [-Name <String>] [-ShowDetails] [-WhatIf] [-Operations <MultiValuedProperty>] - [-HasAttachments <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-MailboxAuditLogSearch cmdlet performs an asynchronous search of mailbox audit logs for the specified mailboxes and sends the search results by email to the specified recipients. The body of the email message contains search metadata such as search parameters and the time when the search request was submitted. The results are attached in an .xml file. - -To search mailbox audit logs for a single mailbox and have the results displayed in the Exchange Management Shell window, use the Search-MailboxAuditLog cmdlet instead. To learn more about mailbox audit logging, see Mailbox audit logging (https://technet.microsoft.com/library/ff459237.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailboxAuditLogSearch "Admin and Delegate Access" -Mailboxes "Ken Kwok","April Stewart" -LogonTypes Admin,Delegate -StartDate 1/1/2018 -EndDate 12/31/2018 -StatusMailRecipients auditors@contoso.com -``` - -This example creates a mailbox audit log search to search Ken Kwok and April Stewart's mailboxes for administrator and delegate logons from 1/1/2018 to 12/31/2018. Search results are sent to auditors@contoso.com by email. - -### -------------------------- Example 2 -------------------------- -``` -New-MailboxAuditLogSearch -ExternalAccess $true -StartDate 09/01/2018 -EndDate 10/24/2018 -StatusMailRecipients admin@contoso.com -``` - -This example returns entries from the mailbox audit logs of all users in organization for any mailbox access by Microsoft datacenter administrators between September 1, 2018 and October 24, 2018. The search results are sent to admin@contoso.com. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusMailRecipients -The StatusMailRecipients parameter specifies the email address of one or more recipients to whom search results are sent by email. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccess -The ExternalAccess parameter returns only audit log entries for mailbox access by a user outside of your organization. In Exchange Online, use this parameter to return audit log entries for access to a mailbox by Microsoft datacenter administrators. - -```yaml -Type: $true | $false -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 -``` - -### -LogonTypes -The LogonTypes parameter specifies the type of logons. Valid values include: - -- Admin: Audit log entries for mailbox access by administrator logons are returned. - -- Delegate: Audit log entries for mailbox access by delegates are returned, including access by users with Full Mailbox Access permission. - -- External: For Exchange Online mailboxes, audit log entries for mailbox access by Microsoft datacenter administrators are returned. - -- Owner: Audit log entries for mailbox access by the primary mailbox owner are returned. This value is available only in Exchange 2016 and also requires the ShowDetails switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailboxes -The Mailboxes parameter specifies one or more mailboxes for which to retrieve mailbox audit log entries. If you don't specify a value, mailbox audit logs for all mailboxes in the Exchange organization are returned. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a name for the search. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetails -The ShowDetails switch specifies that details of each log entry be 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -Operations -The Operations parameter filters the search results by the operations that are logged by mailbox audit logging. Valid values for this parameter are: - -- Copy - -- Create - -- FolderBind - -- HardDelete - -- MailboxLogin - -- MessageBind - -- Move - -- MoveToDeletedItems - -- SendAs - -- SendOnBehalf - -- SoftDelete - -- Update - -You can enter 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasAttachments -The HasAttachments parameter filters the search by messages that have attachments. Valid values are: - -- $true: Only messages with attachments are included in the search. - -- $false: Messages with and without attachments are included in the search. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/95365cab-bbb2-4a64-8e8f-1c89fa9e0352.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md deleted file mode 100644 index 33de4854b5..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-AuditConfigurationPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-AuditConfigurationPolicy cmdlet to remove audit configuration policies from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AuditConfigurationPolicy [-Identity] <PolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/36f1ea77-1e8b-4174-a10d-b6d6b910d1b6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md deleted file mode 100644 index dbea99e8cf..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-AuditConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-AuditConfigurationRule cmdlet to remove audit configuration rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AuditConfigurationRule [-Identity] <PolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6ae51088-7037-4380-81c0-33ea562c995a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md deleted file mode 100644 index 9afcaaba48..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-AdminAuditLog -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Search-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. - -Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Search-AdminAuditLog [[-Cmdlets <MultiValuedProperty>] - [-DomainController <Fqdn>] [-EndDate <ExDateTime>] [-IsSuccess <$true | $false>] - [-ObjectIds <MultiValuedProperty>] [-Parameters <MultiValuedProperty>] [-ResultSize <Int32>] - [-StartDate <ExDateTime>] [-StartIndex <Int32>] [-UserIds <MultiValuedProperty>] - [-ExternalAccess <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default. - -Note: In Exchange Online, if you don't use the StartDate or EndDate parameters, only results from the last 14 days 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Search-AdminAuditLog -Cmdlets New-RoleGroup, New-ManagementRoleAssignment -``` - -This example finds all the administrator audit log entries that contain either the New-RoleGroup or the New-ManagementRoleAssignment cmdlet. - -### -------------------------- Example 2 -------------------------- -``` -Search-AdminAuditLog -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota -StartDate 01/24/2018 -EndDate 02/12/2018 -IsSuccess $true -``` - -This example finds all the administrator audit log entries that match the following criteria: - -- Cmdlets: Set-Mailbox - -- Parameters: UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota - -- StartDate: 01/24/2018 - -- EndDate: 02/12/2018 - -The command completed successfully - -### -------------------------- Example 3 -------------------------- -``` -$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog; $LogEntries | ForEach { $_.CmdletParameters } -``` - -This example displays all the comments written to the administrator audit log by the Write-AdminAuditLog cmdlet. - -First, store the audit log entries in a temporary variable. Then, iterate through all the audit log entries returned and display the Parameters property. - -### -------------------------- Example 4 -------------------------- -``` -Search-AdminAuditLog -ExternalAccess $true -StartDate 09/17/2018 -EndDate 10/02/2018 -``` - -This example returns entries in the administrator audit log of an Exchange Online organization for cmdlets run by Microsoft datacenter administrators between September 17, 2018 and October 2, 2018. - -## PARAMETERS - -### -Cmdlets -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. - -```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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsSuccess -The IsSuccess parameter specifies whether only administrator audit log entries that indicated a success or failure should be returned. Valid values are $true and $false. - -```yaml -Type: $true | $false -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 -``` - -### -ObjectIds -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 mailbox aliases, Send connector names, and so on. - -If you want to specify more than one object ID, separate each ID with a comma. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. -The maximum results to return is 250,000. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -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 -``` - -### -StartIndex -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserIds -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccess -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/87a0cd2d-dd59-4098-b740-75f0cc7bf8e7.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md deleted file mode 100644 index f9e3dc14fb..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-MailboxAuditLog -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Search-MailboxAuditLog - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Search-MailboxAuditLog cmdlet to search mailbox audit log entries matching the specified search terms. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Search-MailboxAuditLog [[-Identity] <MailboxIdParameter>] [-ShowDetails] - [-DomainController <Fqdn>] - [-EndDate <ExDateTime>] - [-ExternalAccess <$true | $false>] - [-HasAttachments <$true | $false>] - [-LogonTypes <MultiValuedProperty>] - [-Operations <MultiValuedProperty>] - [-ResultSize <Int32>] - [-StartDate <ExDateTime>] - [<CommonParameters>] -``` - -### MultipleMailboxesSearch -``` -Search-MailboxAuditLog [-Mailboxes <MultiValuedProperty>] - [-DomainController <Fqdn>] - [-EndDate <ExDateTime>] - [-ExternalAccess <$true | $false>] - [-HasAttachments <$true | $false>] - [-LogonTypes <MultiValuedProperty>] - [-Operations <MultiValuedProperty>] - [-ResultSize <Int32>] - [-StartDate <ExDateTime>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit logs for one or more specified mailboxes and displays search results in the Exchange Management Shell window. To search mailbox audit logs for multiple mailboxes and have the results sent by email to specified recipients, use the New-MailboxAuditLogSearch cmdlet instead. To learn more about mailbox audit logging, see Mailbox audit logging (https://technet.microsoft.com/library/ff459237.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Search-MailboxAuditLog -Identity kwok -LogonTypes Admin,Delegate -StartDate 1/1/2018 -EndDate 12/31/2018 -ResultSize 2000 -``` - -This example retrieves mailbox audit log entries for Ken Kwok's mailbox for actions performed by Admin and Delegate logon types between 1/1/2018 and 12/31/2018. A maximum of 2,000 log entries are returned. - -### -------------------------- Example 2 -------------------------- -``` -Search-MailboxAuditLog -Mailboxes kwok,bsmith -LogonTypes Admin,Delegate -StartDate 1/1/2018 -EndDate 12/31/2018 -ResultSize 2000 -``` - -This example retrieves mailbox audit log entries for Ken Kwok and Ben Smith's mailboxes for actions performed by Admin and Delegate logon types between 1/1/2018 and 12/31/2018. A maximum of 2,000 log entries are returned. - -### -------------------------- Example 3 -------------------------- -``` -Search-MailboxAuditLog -Identity kwok -LogonTypes Owner -ShowDetails -StartDate 1/1/2016 -EndDate 3/1/2016 | Where-Object {$_.Operation -eq "HardDelete"} -``` - -This example retrieves mailbox audit log entries for Ken Kwok's mailbox for actions performed by the mailbox owner between 1/1/2016 and 3/1/2016. The results are piped to the Where-Object cmdlet and filtered to return only entries with the HardDelete action. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccess -The ExternalAccess parameter returns only mailbox audit log entries for mailbox access by users outside of your organization. In Exchange Online, use this parameter to return audit log entries for mailbox access by Microsoft datacenter administrators. - -```yaml -Type: $true | $false -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 -``` - -### -HasAttachments -The HasAttachments parameter filters the search by messages that have attachments. Valid values are: - -- $true: Only messages with attachments are included in the search. - -- $false: Messages with and without attachments are included in the search. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox for which to retrieve mailbox audit log entries. You can use this parameter to search a single mailbox. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -LogonTypes -The LogonTypes parameter specifies the type of logons. Valid values include: - -- Admin: Audit log entries for mailbox access by administrator logons are returned. - -- Delegate: Audit log entries for mailbox access by delegates are returned, including access by users with Full Mailbox Access permission. - -- External: For Exchange Online mailboxes, audit log entries for mailbox access by Microsoft datacenter administrators are returned. - -- Owner: Audit log entries for mailbox access by the primary mailbox owner are returned. This value is available only in Exchange 2016 and also requires the ShowDetails switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailboxes -The Mailboxes parameter specifies the mailboxes for which to retrieve mailbox audit log entries. You can use this parameter to search audit logs for multiple mailboxes. You can't use the ShowDetails switch with the Mailboxes parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operations -The Operations parameter filters the search results by the operations that are logged by mailbox audit logging. Valid values for this parameter are: - -- Copy - -- Create - -- FolderBind - -- HardDelete - -- MailboxLogin - -- MessageBind - -- Move - -- MoveToDeletedItems - -- SendAs - -- SendOnBehalf - -- SoftDelete - -- Update - -- UpdateCalendarDelegation (cloud-based service only) - -- UpdateFolderPermissions (cloud-based service only) - -- UpdateInboxRules (cloud-based service only) - -You can enter 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetails -The ShowDetails switch specifies that details of each log entry be retrieved. By default, all fields for each returned log entry are displayed in a list view. - -You can't use the Mailboxes parameter with the ShowDetails 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2cc4598a-8a8c-45a0-901c-73e1079d193e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md deleted file mode 100644 index 7ab1425ba5..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Online -title: Search-UnifiedAuditLog -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Search-UnifiedAuditLog - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint Online, OneDrive for Business, Azure Active Directory, Microsoft Teams, Power BI, Sway, and other Office 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Search-UnifiedAuditLog -EndDate <ExDateTime> -StartDate <ExDateTime> [-Formatted] [-FreeText <String>] - [-IPAddresses <String[]>] [-ObjectIds <String[]>] [-Operations <String[]>] - [-RecordType <ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence>] - [-ResultSize <Int32>] [-SessionCommand <Initialize | ReturnLargeSet | ReturnNextPreviewPage>] - [-SessionId <String>] [-SiteIds <String[]>] [-UserIds <String[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The Search-UnifiedAuditLog cmdlet presents pages of data based on repeated iterations of the same command. Use SessionId and SessionCommand to repeatedly run the cmdlet until you get zero returns, or hit the maximum number of results based on the session command. To gauge progress, look at the ResultIndex (hits in the current iteration) and ResultCount (hits for all iterations) properties of the data returned by the cmdlet. - -The Search-UnifiedAuditLog cmdlet is available in Exchange Online PowerShell. You can also view events from the unified auditing log by using the Office 365 Security & Compliance Center. For more information, see Search the audit log in the Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=708432). - -If you want to programmatically download data from the Office 365 audit log, we recommend that you use the Office 365 Management Activity API instead of using the Search-UnifiedAuditLog cmdlet in a PowerShell script. The Office 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 Office 365 Management Activity API reference (https://go.microsoft.com/fwlink/p/?linkid=852309). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/2/2018 -``` - -This example searches the unified audit log for all events from May 1, 201812:00AM to May 2, 2018 12:00AM. - -Note: If you don't include a timestamp in the value for the StartDate or EndDate parameters, the default timestamp 12:00 AM (midnight) is used. - -### -------------------------- Example 2 -------------------------- -``` -Search-UnifiedAuditLog -StartDate "6/1/2018 8:00 AM" -EndDate "6/1/2018 6:00 PM" -RecordType ExchangeAdmin -``` - -This example searches the unified audit log for all Exchange admin events from 8:00 AM to 6:00 PM on June 1, 2018. - ->[!NOTE] -> If you use the same date for the StartDate and EndDate parameters, you have to include a timestamp; otherwise, no results will be returned because the date and time for the start and end dates will be the same. - -### -------------------------- Example 3 -------------------------- -``` -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnNextPreviewPage -``` - -This example searches the unified audit log for all events from May 1, 2018 to May 8, 2018. If you don't include a time stamp in the StartDate or EndDate parameters, The data is returned in pages as the command is rerun sequentially while using the same SessionId value. - -> [!NOTE] -> If you use the SessionCommand value ReturnLargeSet, and then you use the value ReturnNextPreviewPage for the same session ID, the results are limited to 10,000 records (not 50,000). - -### -------------------------- Example 4 -------------------------- -``` -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews"-SessionCommand ReturnNextPreviewPage -``` - -This example searches the unified audit log for any files accessed in SharePoint Online from May 1, 2018 to May 8, 2018. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. - -### -------------------------- Example 5 -------------------------- -``` -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -ObjectIDs "https://alpinehouse.sharepoint.com/sites/contoso/Departments/SM/International/Shared%20Documents/Sales%20Invoice%20-%20International.docx" -``` - -This example searches the unified audit log from May 1, 2018 to May 8, 2018 for all events relating to a specific Word document identified by its ObjectIDs value. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -If you don't include a timestamp in the value for this parameter, the default timestamp is 12:00 AM (midnight) on the specified date. - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -If you don't include a timestamp in the value for this parameter, the default timestamp is 12:00 AM (midnight) on the specified date. - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Formatted -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FreeText -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddresses -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectIds -The ObjectIds parameter filters the log entries by object ID. The object ID is the target object that was acted upon, and depends on the RecordType and Operations values of the event. For example, for SharePoint operations, the object ID is the URL path to a file, folder, or site. For Azure Active Directory operations, the object ID is the account name or GUID value of the account. - -The ObjectId value appears in the AuditData (also known as Details) property of the event. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operations -The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see Search the audit log in the Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=708432). - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -The RecordType parameter filters the log entries by record type. - -Valid values are: - -- AzureActiveDirectory - -- AzureActiveDirectoryAccountLogon - -- AzureActiveDirectoryStsLogon - -- ComplianceDLPExchange - -- ComplianceDLPSharePoint - -- CRM - -- DataCenterSecurityCmdlet - -- Discovery - -- ExchangeAdmin - -- ExchangeAggregatedOperation - -- ExchangeItem - -- ExchangeItemGroup - -- MicrosoftTeams - -- MicrosoftTeamsAddOns - -- MicrosoftTeamsSettingsOperation - -- OneDrive - -- PowerBIAudit - -- SecurityComplianceCenterEOPCmdlet - -- SharePoint - -- SharePointFileOperation - -- SharePointSharingOperation - -- SkypeForBusinessCmdlets - -- SkypeForBusinessPSTNUsage - -- SkypeForBusinessUsersBlocked - -- Sway - -- ThreatIntelligence - -- Yammer - -```yaml -Type: ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. The default value is 100, maximum is 5,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionCommand -The SessionCommand parameter specifies how much information is returned and how it's organized. Valid values are: - -- 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. - -- ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. - -- Initialize: This value is for Microsoft Internal use only. - -> [!NOTE] -> Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. - -```yaml -Type: Initialize | ReturnLargeSet | ReturnNextPreviewPage -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteIds -The SiteIds parameter filters the log entries by site ID. You can specify multiple values separated by commas. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserIds -The UserIds parameter filters the log entries by the ID of the user who performed the action. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -> [!NOTE] `-OutVariable` accepts objects of `ArrayList` list type. -> Below is a quick example of how `-OutVariable` can be used: -> ``` -> $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 -> ``` -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/08cb17bb-0fcd-4664-b6f5-000b7f668336.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md deleted file mode 100644 index d63f466d63..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AdminAuditLogConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-AdminAuditLogConfig cmdlet to configure the administrator audit logging configuration settings. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AdminAuditLogConfig [[-Identity] <OrganizationIdParameter>] [-AdminAuditLogAgeLimit <EnhancedTimeSpan>] - [-AdminAuditLogCmdlets <MultiValuedProperty>] [-AdminAuditLogEnabled <$true | $false>] - [-AdminAuditLogExcludedCmdlets <MultiValuedProperty>] [-AdminAuditLogParameters <MultiValuedProperty>] - [-Confirm] [-DomainController <Fqdn>] [-Force] [-Name <String>] [-TestCmdletLoggingEnabled <$true | $false>] - [-WhatIf] [-LogLevel <None | Verbose>] [-LoadBalancerCount <Int32>] [-RefreshInterval <Int32>] - [-UnifiedAuditLogIngestionEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -When audit logging is enabled, a log entry is created for each cmdlet run, excluding Get cmdlets. Log entries are stored in a hidden mailbox and accessed using the Search-AdminAuditLog or New-AdminAuditLogSearch cmdlets. - -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. - -Changes to the audit log configuration may take up to 60 minutes to be applied on computers that have the Exchange Management Shell open at the time a configuration change is made. If you want to apply the changes immediately, close and reopen the Exchange Management Shell on each computer. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AdminAuditLogConfig -AdminAuditLogEnabled $true -AdminAuditLogCmdlets * -AdminAuditLogParameters * -``` - -This example enables administrator audit logging for every cmdlet and every parameter in the organization, with the exception of Get cmdlets. - -### -------------------------- Example 2 -------------------------- -``` -Set-AdminAuditLogConfig -AdminAuditLogEnabled $true -AdminAuditLogCmdlets *Mailbox, *Management*, *TransportRule* -AdminAuditLogParameters * -``` - -This example enables administrator audit logging for specific cmdlets run in the organization. Any parameter used on the specified cmdlets is logged. Every time a specified cmdlet is run, a log entry is added to the audit log. - -### -------------------------- Example 3 -------------------------- -``` -Set-AdminAuditLogConfig -AdminAuditLogEnabled $true -AdminAuditLogCmdlets *Mailbox* -AdminAuditLogParameters *Address* -``` - -This example enables administrator audit logging only for specific parameters that are specified when running specific cmdlets. The parameter name and the cmdlet name must match the strings specified with the AdminAuditLogCmdlets and AdminAuditLogParameters parameters. For example, a log entry is generated only when a parameter with the string "Address" in the name is run on a cmdlet with the string "Mailbox" in its name. - -## PARAMETERS - -### -AdminAuditLogAgeLimit -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. - -To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - -For example, to set the audit log age limit to 120 days, use the syntax 120.00:00:00. - -Setting the age limit to a value less than the current limit causes log entries older than the new limit to be deleted. - -Setting the age limit to 0 purges the audit log of all entries. - -```yaml -Type: EnhancedTimeSpan -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 -``` - -### -AdminAuditLogCmdlets -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 (\*). - -```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: False -Accept wildcard characters: False -``` - -### -AdminAuditLogEnabled -This parameter is available only in on-premises Exchange. - -The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. The default value is $false. The valid values are $true and $false. You must specify an administrator audit log mailbox before you enable logging. - -Changes to the administrator audit log configuration are always logged, regardless of whether audit logging is enabled or disabled. - -```yaml -Type: $true | $false -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 -``` - -### -AdminAuditLogExcludedCmdlets -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. - -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. You can't specify only the wildcard character (\*). - -If you want to clear the list, specify a value of $null. - -```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: False -Accept wildcard characters: False -``` - -### -AdminAuditLogParameters -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 (\*). - -```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: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Identity -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, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Name -This parameter is available only in on-premises Exchange. - -The Name parameter specifies the name of the AdminAuditLogConfig object. - -You don't need to specify this parameter when you configure administrator audit logging. It doesn't affect your configuration or how administrator audit logging works. - -```yaml -Type: String -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 -``` - -### -TestCmdletLoggingEnabled -This parameter is available only in on-premises Exchange. - -The TestCmdletLoggingEnabled parameter specifies whether the execution of test cmdlets should be logged. Test cmdlets begin with the verb Test. Valid values are $true and $false. The default value is $false. - -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. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -This parameter is available only in on-premises Exchange. - -The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are None and Verbose. - -By default, the CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. When the Verbose value is used, the ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are included in the log entries. - -```yaml -Type: None | Verbose -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerCount -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshInterval -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnifiedAuditLogIngestionEnabled -This parameter is available only in the cloud-based service. - -The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Office 365 audit log. Valid values are: - -- $true: User and admin activities are recorded in the Office 365 audit log, and you can search the Office 365 audit log. - -- $false: User and admin activities aren't recorded in the Office 365 audit log, and you can't search the Office 365 audit log. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9d77294d-a501-4af6-8c3b-753235c741a7.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AuditConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AuditConfig.md deleted file mode 100644 index 132130b2b7..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AuditConfig.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-AuditConfig -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-AuditConfig - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-AuditConfig cmdlet to configure the auditing configuration in the Security & Compliance Center. The auditing configuration specifies where auditing is allowed in Microsoft Office 365. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AuditConfig [[-Identity] <PolicyIdParameter>] -Workload <MultiValuedProperty> [-DomainController <Fqdn>] - [-Organization <OrganizationIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AuditConfig -Workload Exchange,SharePoint -``` - -This example sets the auditing configuration for Exchange and SharePoint. - -## PARAMETERS - -### -Workload -The Workload parameter specifies where auditing is allowed. Valid values are: - -- Exchange - -- InTune - -- OneDriveForBusiness - -- SharePoint - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Organization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2b9b8795-2f4d-496a-bb36-e3b8511c7e1c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md deleted file mode 100644 index fb6a50f5df..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-AuditConfigurationRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-AuditConfigurationRule cmdlet to modify audit configuration rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AuditConfigurationRule [-Identity] <ComplianceRuleIdParameter> -AuditOperation <MultiValuedProperty> - [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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 - -### -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89056720-7dfb-4738-9033-918f9ef51d39.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md b/exchange/exchange-ps/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md deleted file mode 100644 index e5fccc9d02..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Write-AdminAuditLog -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Write-AdminAuditLog cmdlet to write a comment to the administrator audit log. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Write-AdminAuditLog -Comment <String> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When the Write-AdminAuditLog cmdlet runs, the value provided in the Comment parameter is included in the log entry. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Write-AdminAuditLog -Comment "Ran custom script." -``` - -This example adds a comment to the administrator audit log. - -## PARAMETERS - -### -Comment -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 ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/58732728-40b6-4a44-a39e-9cf47e59090e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md deleted file mode 100644 index 94a448c742..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: Get-ComplianceSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the Get-ComplianceSearch cmdlet to view estimate compliance searches in Exchange Server 2016 and in the Office 365 Security & Compliance Center. After you use the New-ComplianceSearchAction cmdlet to define a preview action for the compliance search, use the Get-ComplianceSearchAction cmdlet to view the results of the compliance search. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceSearch [[-Identity] <ComplianceSearchIdParameter>] [-Case <String>] [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceSearch -``` - -This example shows a summary list of all compliance searches. - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceSearch -Identity "Case 1234" | Format-List -``` - -This examples show details of the compliance search named Case 1234. - -## PARAMETERS - -### -Case -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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: - -- Name - -- JobRunId (GUID) - -You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status - -To improve the performance of this cmdlet, some compliance search properties aren't returned if you don't specify the identity of the compliance search. These properties are: - -- Items - -- Size - -- SuccessResults - -- NumBindings - -- ExchangeLocation - -- SharePointLocation - -- OneDriveLocation - -To view these properties, you need to use the Identity parameter in the command. - -```yaml -Type: ComplianceSearchIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3bf7edeb-7674-464e-abad-4b1b8858114d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md deleted file mode 100644 index 994a0f018f..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: Get-ComplianceSearchAction -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the Get-ComplianceSearchAction cmdlet to view information about compliance search actions in Exchange Server 2016 and in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-ComplianceSearchAction [[-Identity] <ComplianceSearchActionIdParameter>] - [-Case <String>] - [-Details] - [-DomainController <Fqdn>] - [-IncludeCredential] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -### Preview -``` -Get-ComplianceSearchAction [-Preview] - [-Case <String>] - [-Details] - [-DomainController <Fqdn>] - [-IncludeCredential] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -### Purge -``` -Get-ComplianceSearchAction [-Purge] - [-Case <String>] - [-Details] - [-DomainController <Fqdn>] - [-IncludeCredential] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -### Export -``` -Get-ComplianceSearchAction [-Export] - [-Case <String>] - [-Details] - [-DomainController <Fqdn>] - [-IncludeCredential] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceSearchAction -``` - -This example shows a summary list of all compliance search actions. - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List -``` - -This example shows details about the compliance search action named "Case 1234\_Preview" - -## PARAMETERS - -### -Case -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Details -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Export -The Export switch filters the results by Export compliance search actions. 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example: - -- Name: The compliance search action name uses the syntax \<Compliance Search Name\>\_\<Action\> . For example, Case 1234\_Preview. - -- JobRunId (GUID) - -```yaml -Type: ComplianceSearchActionIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeCredential -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preview -The Preview switch filters the results by Preview compliance search actions. - -```yaml -Type: SwitchParameter -Parameter Sets: Preview -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Purge -The Purge switch filters the results by Purge compliance search actions. - -```yaml -Type: SwitchParameter -Parameter Sets: Purge -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d28d2ac9-4c15-4813-9c63-385533d64e99.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md deleted file mode 100644 index 587e8763a9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ComplianceSecurityFilter -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ComplianceSecurityFilter - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceSecurityFilter cmdlet to view compliance security filters in the Security & Compliance Center. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Office 365 organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceSecurityFilter [-Action <Unknown | Preview | Export | Purge | Search | All>] [-Confirm] - [-FilterName <String>] [-User <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Compliance security filters work with compliance searches in the Security & Compliance Center (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceSecurityFilter | Format-Table -Auto FilterName,Action -``` - -This example returns a summary list of all compliance security filters. - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceSecurityFilter -FilterName "HR Filter" -``` - -This example returns detailed information about the compliance security filter named HR Filter. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the type of search action that a filter is applied to. Valid values are: - -- All - -- Export - -- Preview - -- Purge - -- Search - -```yaml -Type: Unknown | Preview | Export | Purge | Search | All -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterName -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -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. - -- The value All. - -- The name of a role group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5e1f0433-c062-4c58-8832-0ff0021cdc99.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md deleted file mode 100644 index 91d8e30bc4..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete or stopped. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### SearchObjectIdentity -``` -Get-MailboxSearch [[-Identity] <SearchObjectIdParameter>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -### EwsStoreObjectIdentity -``` -Get-MailboxSearch [[-Identity] <EwsStoreObjectIdParameter>] [-ShowDeletionInProgressSearches] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -### InPlaceHoldIdentity -``` -Get-MailboxSearch -InPlaceHoldIdentity <String> [-ShowDeletionInProgressSearches] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## DESCRIPTION -In on-premises Exchange and Exchange Online, 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxSearch -ResultSize "unlimited" -``` - -This example retrieves a list of all mailbox searches. - -### -------------------------- Example 2 -------------------------- -``` -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 Parameters (https://technet.microsoft.com/library/bb124388.aspx). - -### -------------------------- Example 3 -------------------------- -``` -(Get-Mailbox Mark).InPlaceHolds; Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb -``` - -This example retrieves the In-Place Holds that a user is placed on. The first command outputs GUIDs of In-Place Holds. The last command retrieves a mailbox search based on the GUID of the In-Place Hold that the user is placed on. - -## PARAMETERS - -### -InPlaceHoldIdentity -The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet. - -```yaml -Type: String -Parameter Sets: InPlaceHoldIdentity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the search query. If a name isn't provided, all mailbox search queries are returned. - -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: - -- SourceMailboxes - -- Sources - -- SearchQuery - -- ResultsLink - -- PreviewResultsLink - -- Errors - -To view these properties, you have to provide the name of a mailbox search. - -```yaml -Type: SearchObjectIdParameter -Parameter Sets: EwsStoreObjectIdentity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: SearchObjectIdParameter -Parameter Sets: SearchObjectIdentity -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -ShowDeletionInProgressSearches -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a2f3ab70-6ec6-4c06-b862-f32d498c3ef8.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md deleted file mode 100644 index c3b848d985..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Invoke-ComplianceSearchActionStep -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# 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. - -Use the Invoke-ComplianceSearchActionStep cmdlet to export specific pages from export compliance search actions in on-premises Exchange and in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Invoke-ComplianceSearchActionStep [[-Identity] <ComplianceSearchActionIdParameter>] -Parameters <PSObject> - -Step <Int32> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -Parameters -The Parameters parameter specifies the parameters that you want to search for. Only the pages that contain the parameters you specify are returned. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Step -The Step parameter specifies the step number. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter filters the results by the compliance search action. 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. - -- JobRunId (GUID) - -```yaml -Type: ComplianceSearchActionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ec43ec77-ae00-4873-afb9-6ec17cb1b3f2.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md deleted file mode 100644 index 4c65c11d0a..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md +++ /dev/null @@ -1,497 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: New-ComplianceSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the New-ComplianceSearch cmdlet to create compliance searches in Exchange Server 2016 and in the Office 365 Security & Compliance Center. You use this cmdlet to define the search criteria. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ComplianceSearch [-Name] <String> [-AllowNotFoundExchangeLocationsEnabled <$true | $false>] - [-Case <String>] [-Confirm] [-ContentMatchQuery <String>] [-Description <String>] - [-ExchangeLocation <String[]>] [-ExchangeLocationExclusion <String[]>] [-Force] [-HoldNames <String[]>] [-IncludeUserAppContent <$true | $false>] - [-Language <CultureInfo>] [-LogLevel <Suppressed | Basic | Full>] [-OneDriveLocation <String[]>] - [-OneDriveLocationExclusion <String[]>] [-PublicFolderLocation <String[]>] - [-PublicFolderLocationExclusion <String[]>] [-RefinerNames <String[]>] [-SearchNames <String[]>] - [-SharePointLocation <String[]>] [-SharePointLocationExclusion <String[]>] [-StatusMailRecipients <String[]>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -A compliance search requires at least one location. For example, mailboxes using the ExchangeLocation parameter, or SharePoint sites using the SharePointLocation parameter. - -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://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ComplianceSearch -Name "Hold Project X" -ExchangeLocation "Finance Department" -``` - -This example creates a new compliance search named Hold-Project X that searches all members of the distribution group named Finance Department. Because the search doesn't use the ContentMatchQuery parameter, all items in the mailboxes are searched. - -### -------------------------- Example 2 -------------------------- -``` -New-ComplianceSearch -Name "Hold-Tailspin Toys" -ExchangeLocation "Research Department" -ContentMatchQuery "'Patent' AND 'Project Tailspin Toys'" -``` - -This example creates a new compliance search named Hold-Tailspin Toys that searches all member of the distribution group named Research Department. Because the search uses the ContentMatchQuery parameter, only messages that match the query are searched. - -### -------------------------- Example 3 -------------------------- -``` -New-ComplianceSearch -Name "AnnBeebe-InactiveMailbox" -ExchangeLocation .annb@contoso.onmicrosoft.com -AllowNotFoundExchangeLocationsEnabled $true -``` - -This example creates a new compliance search named AnnBeebe-InactiveMailbox that searches an inactive mailbox and returns all items in the mailbox. To search inactive mailboxes, you need to use the primary SMTP address of the inactive mailbox, prepended with a period ("."). You also need to include the AllowNotFoundExchangeLocationsEnabled parameter so the search doesn't try to validate the existence of the inactive mailbox. - -## PARAMETERS - -### -Name -The Name parameter specifies the name of 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, Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowNotFoundExchangeLocationsEnabled -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. - -The mailbox types that are affected by the value of this parameter include: - -- Inactive mailboxes - -- Users without an Exchange Online license who use Office applications - -- Office 365 guest users - -- On-premises users whose identity is synchronized with your Office 365 organization - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Case -The Case parameter specifies the name of an eDiscovery case that the new compliance search will be associated with. 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter specifies an optional description for the 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocation -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 Office 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -- The value All for all mailboxes. You can only use this value by itself. - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ExchangeLocationExclusion -This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HoldNames -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. - -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. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUserAppContent -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 Office 365 user account in your organization. These types of users include users without an Exchange Online license who use Office applications, Office 365 guest users, and on-premises users whose identity is synchronized with your Office 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -The Language parameter specifies the language for the compliance search. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Suppressed | Basic | Full -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocation -The PublicFolderLocation parameter specifies that you want to include all public folders in the search. You use the value All for this parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefinerNames -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchNames -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocationExclusion -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusMailRecipients -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/433d1602-a026-4d63-be5e-605dd6b7b0d0.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md deleted file mode 100644 index e2c3120f37..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md +++ /dev/null @@ -1,727 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: New-ComplianceSearchAction -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the New-ComplianceSearchAction cmdlet to create actions for content searches in Exchange Server and in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Export -``` -New-ComplianceSearchAction [-SearchName] <String[]> [-Export] - [-ActionName <String>] - [-ArchiveFormat <ComplianceExportArchiveFormat>] - [-Confirm] - [-FileTypeExclusionsForUnindexedItems <String[]>] - [-EnableDedupe <$true | $false>] - [-ExchangeArchiveFormat <ComplianceExportArchiveFormat>] - [-Force] - [-Format <ComplianceDataTransferFormat>] - [-IncludeCredential] - [-IncludeSharePointDocumentVersions <$true | $false>] - [-JobOptions <Int32>] - [-NotifyEmail <String>] - [-NotifyEmailCC <String>] - [-ReferenceActionName <String>] - [-Region <String>] - [-Report] - [-RetentionReport] - [-RetryOnError] - [-Scenario <ComplianceSearchActionScenario>] - [-Scope <ComplianceExportScope>] - [-SearchNames <String[]>] - [-SharePointArchiveFormat <ComplianceExportArchiveFormat>] - [-Version <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Preview -``` -New-ComplianceSearchAction [-SearchName] <String[]> [-Preview] - [-ActionName <String>] - [-Confirm] - [-Force] - [-Format <ComplianceDataTransferFormat>] - [-IncludeCredential] [-JobOptions <Int32>] - [-ReferenceActionName <String>] - [-Region <String>] - [-RetryOnError] - [-Scenario <ComplianceSearchActionScenario>] - [-SearchNames <String[]>] - [-Version <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Purge -``` -New-ComplianceSearchAction [-SearchName] <String[]> [-Purge] [-PurgeType <ComplianceDestroyType>] - [-ActionName <String>] - [-Confirm] - [-Force] - [-Format <ComplianceDataTransferFormat>] - [-IncludeCredential] - [-JobOptions <Int32>] - [-Region <String>] - [-ReferenceActionName <String>] - [-RetryOnError] - [-Scenario <ComplianceSearchActionScenario>] - [-SearchNames <String[]>] - [-Version <String>] - [-WhatIf]] [<CommonParameters>] -``` - -## DESCRIPTION -After you create a content search using the New-ComplianceSearch cmdlet and run it using the Start-ComplianceSearch cmdlet, you assign a search action to the search using the New-ComplianceSearchAction cmdlet. - -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, and not to the Organization 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://technet.microsoft.com/library/mt432940.aspx). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ComplianceSearchAction -SearchName "Project X" -Preview -``` - -This example creates a preview search action for the content search named Project X. - -### -------------------------- Example 2 -------------------------- -``` -New-ComplianceSearchAction -SearchName "Project X" -Export -``` - -This example creates an export search action for the content search named Project X. - -### -------------------------- Example 3 -------------------------- -``` -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. - -### -------------------------- Example 4 -------------------------- - -``` -New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -``` - -This example exports the results returned by the content search named "Case 321 All Sites". The search results are compressed and exported to a single ZIP file. If the search included any Exchange locations, the search results are exported as one PST file per mailbox (the default value of the ExchangeArchiveFormat parameter). - -## PARAMETERS - -### -SearchName -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. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActionName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveFormat -This parameter is available only in the cloud-based service. - -This parameter requires the Export role in the Security & Compliance Center. By default, the Export role is assigned only to the eDiscovery Manager role group. - -This parameter has been deprecated and is 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. - -```yaml -Type: ComplianceExportArchiveFormat -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableDedupe -This parameter is available only in the cloud-based service. - -The EnableDedupe parameter eliminates duplication of messages when you export content search results. Valid values are: - -- $true: Export a single copy of a message if the same message exists in multiple folders or mailboxes. - -- $false: Export all copies of a message if the same message exists in multiple folders or mailboxes. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeArchiveFormat -This parameter is available only in the cloud-based service. - -This parameter requires the Export role in the Security & Compliance Center. By default, the Export role is assigned only to the eDiscovery Manager role group. - -The ExchangeArchiveFormat parameter specifies how to export Exchange search results. Valid values are: - -- PerUserPst: One PST file for each mailbox. This is the default value. - -- 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. - -- PerUserZip: One ZIP file for each mailbox. Each ZIP file contains the exported .msg message files from the mailbox. This value corresponds to the "export files in a compressed folder" checkbox in the Security & Compliance Center. - -- SingleZip: One ZIP file for all mailboxes. The ZIP file contains all exported .msg message files from all mailboxes. This output setting is only available in PowerShell. - -To specify the format for SharePoint and OneDrive search results, use the SharePointArchiveFormat parameter. - -```yaml -Type: ComplianceExportArchiveFormat -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Export -This parameter is available only in the cloud-based service. - -This parameter requires the Export role in the Security & Compliance Center. By default, the Export role is assigned only to the eDiscovery Manager role group. - -The Export switch specifies the action for the content search is to export the full set of results that match the search criteria. You don't need to specify a value with this switch. - -To only return the information about each detected item in a report, use the Report switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileTypeExclusionsForUnindexedItems -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role is assigned only to the eDiscovery Manager role group. - -The Format parameter specifies the format of the search results when you use the Export switch. Valid values are: - -- FxStream: Export to PST files. This is the only option that's available when you export search results from the Security & Compliance Center. - -- Mime: Export to .eml message files. This the default value when you use cmdlets to export the search results. - -- Message: Export to .msg message files. - -- BodyText: Export to .txt files. - -```yaml -Type: ComplianceDataTransferFormat -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeCredential -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSharePointDocumentVersions -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. - -```yaml -Type: $true | $false -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobOptions -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyEmail -In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role 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. - -The recipient you specify is in the To: field of the message. - -```yaml -Type: String -Parameter Sets: Export -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyEmailCC -In the Security & Compliance Center, this parameter requires the Export role. By default, the Export 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. - -The recipient you specify is in the Cc: field of the message. - -```yaml -Type: String -Parameter Sets: Export -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preview -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. - -In the Security & Compliance Center, this parameter requires the Preview role. By default, the Preview role is assigned only to the eDiscovery Manager role group. - -```yaml -Type: SwitchParameter -Parameter Sets: Preview -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Purge -The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. - -Notes: - -- A maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes. - -- You can remove items from a maximum of 50,000 mailboxes using a single content search. To remove items from more than 50,000 mailboxes, you'll have to create separate content searches. For more information, see Search for and delete email messages in your Office 365 organization (https://docs.microsoft.com/office365/securitycompliance/search-for-and-delete-messages-in-your-organization). - -- Unindexed items aren't removed from mailboxes when you use this switch. - -- The value of the PurgeType parameter controls how the items are removed. - -```yaml -Type: SwitchParameter -Parameter Sets: Purge -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PurgeType -The PurgeType parameter specifies how to remove items when the action is Purge. - -The valid value for this parameter is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. - -Note: To hard delete items, use the Search-Mailbox cmdlet with the DeleteContent switch. For more information, see Search for and delete messages (https://docs.microsoft.com/office365/SecurityCompliance/search-for-and-delete-messagesadmin-help). - -```yaml -Type: ComplianceDestroyType -Parameter Sets: Purge -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReferenceActionName -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Report -This parameter is available 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. - -```yaml -Type: SwitchParameter -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionReport -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryOnError -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scenario -In the Security & Compliance Center, this parameter requires the Preview role. By default, the Preview 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: - -- AnalyzeWithZoom: Prepare the search results for processing in Office 365 Advanced eDiscovery. - -- General: Exports the search results to the local computer. Emails are exported to .pst files. SharePoint and OneDrive for Business documents are exported in their native Office formats. - -- GenerateReportsOnly: - -- Inventory: - -- RetentionReports: - -- TriagePreview: - -```yaml -Type: ComplianceSearchActionScenario -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -The Scope parameter specifies the items to include when the action is Export. Valid values are: - -- IndexedItemsOnly - -- UnindexedItemsOnly - -- BothIndexedAndUnindexedItems - -This parameter is only meaningful for content searches where the IncludeUnindexedItemsEnabled parameter is set to $true. - -```yaml -Type: ComplianceExportScope -Parameter Sets: Export -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeDetails -This parameter is available only in the cloud-based service. - -This parameter requires the Export or Compliance Search roles in the Security & Compliance Center. By default, these roles are assigned only to the eDiscovery Manager role group. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: ComplianceScopeDetail[] -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchNames -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. - -You can find content search names by running the command Get-ComplianceSearch | Format-Table -Auto Name,Status. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointArchiveFormat -This parameter is available only in the cloud-based service. - -This parameter requires the Export role in the Office 365 Security & Compliance Center. By default, the Export 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. - -- PerUserZip: One ZIP file for each user. Each ZIP file contains the exported files for the user. This value corresponds to the "export files in a compressed folder" checkbox in the Security & Compliance Center. - -- SingleZip: One ZIP file for all users. The ZIP file contains all exported files from all users. This output setting is only available in PowerShell. - -To specify the format for Exchange search results, use the ExchangeArchiveFormat parameter. - -```yaml -Type: ComplianceExportArchiveFormat -Parameter Sets: Export -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a3a2897c-07a8-41d6-99cd-f2440613fbce.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md deleted file mode 100644 index a8c7627ad8..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ComplianceSecurityFilter -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ComplianceSecurityFilter - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Security & Compliance Center. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Office 365 organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ComplianceSecurityFilter -Action <Unknown | Preview | Export | Purge | Search | All> -FilterName <String> - -Users <MultiValuedProperty> [-Confirm] [-Description <String>] [-Filters <MultiValuedProperty>] - [-Region <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Compliance security filters work with compliance searches in the Security & Compliance Center (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName CountryFilter -Users annb@contoso.com -Filters "Mailbox_CountryCode -eq '124'" -Action All -``` - -This example allows the user annb to perform all compliance search actions only for mailboxes in Canada. The filter uses the ISO 3166-1 numeric country code value. - -### -------------------------- Example 2 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName MarketingFilter -Users donh,suzanf -Filters "Mailbox_CustomAttribute1 -eq 'Marketing'" -Action Search -``` - -This example allows the users donh and suzanf to search only the mailboxes that have the value Marketing for the CustomAttribute1 mailbox property. - -### -------------------------- Example 3 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName USDiscoveryManagers -Users "US Discovery Managers" -Filters "Mailbox_CountryCode -eq 'US'" -Action All -``` - -This example allows members of the US Discovery Managers role group to perform all compliance search actions only on mailboxes in the United States. - -### -------------------------- Example 4 -------------------------- -``` -$DG = Get-DistributionGroup "Ottawa Users"; New-ComplianceSecurityFilter -FilterName DGFilter -Users eDiscoveryManager -Filters "Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'" -Action Search -``` - -This example assigns allows members of the eDiscovery Manager role group to only search the mailboxes of members of the Ottawa Users distribution group. - -This example requires you to connect to Security & Compliance Center PowerShell and Exchange Online PowerShell in the same remote PowerShell session. For instructions, see Configure permissions filtering for Compliance Search (https://technet.microsoft.com/library/mt171557.aspx). - -### -------------------------- Example 5 -------------------------- -``` -$DG = Get-DistributionGroup "Executive Team"; New-ComplianceSecurityFilter -FilterName NoExecutivesPreview -Users all -Filters "Mailbox_MemberOfGroup -ne '$($DG.DistinguishedName)'" -Action Purge -``` - -This example prevents any user from deleting content from the mailboxes of members of the Executive Team distribution group. - -This example requires you to connect to Security & Compliance Center PowerShell and Exchange Online PowerShell in the same remote PowerShell session. For instructions, see Configure permissions filtering for Compliance Search (https://technet.microsoft.com/library/mt171557.aspx). - -### -------------------------- Example 6 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName EmailDateRestrictionFilter -Users donh@contoso.com -Filters "MailboxContent_Received -ge '01-01-2018' -and MailboxContent_Received -le '12-31-2018'" -Action All -``` - -This example restricts the user to performing all compliance search actions only on email messages sent during the calendar year 2018. - -### -------------------------- Example 7 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName OneDriveOnly -Users "OneDrive eDiscovery Managers" -Filters "Site_Path -like 'https://contoso-my.sharepoint.com/personal*'" -Action Search -``` - -This example allows members of the OneDrive eDiscovery Managers custom role group to only search for content in OneDrive for Business locations in the organization. - -### -------------------------- Example 8 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName DocumentDateRestrictionFilter -Users donh@contoso.com -Filters "SiteContent_LastModifiedTime -ge '01-01-2018' -and SiteContent_LastModifiedTime -le '12-31-2018'" -Action All -``` - -This example restricts the user to performing all compliance search actions on documents that were last changed sometime in the calendar year 2018. - -### -------------------------- Example 9 -------------------------- -``` -New-ComplianceSecurityFilter -FilterName NoEXO -Users suzanf@contoso.com -Filters "Mailbox_Alias -notlike '*'" -Action All -``` - -This example prevents the user from performing any compliance search actions on any mailbox in the organization. - -## PARAMETERS - -### -Action -The Action parameter specifies that type of search action that the filter is applied to. Valid values are: - -- Export: The filter is applied when exporting search results, or preparing them for analysis in Office 365 Advanced eDiscovery. - -- Preview: The filter is applied when previewing search results. - -- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. - -- Search: The filter is applied when running a search. - -- All: The filter is applied to all search actions. - -```yaml -Type: Unknown | Preview | Export | Purge | Search | All -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterName -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -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. - -- The value All: Assigns the filter to all users. You can only use this value by itself. - -- One or more role groups: Identify the role group by its name. You can specify multiple values separated by commas. - -You can't specify distribution groups with this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filters -The Filters parameter specifies the search criteria for the compliance security filter. The filters are applied to the users specified by the Users parameter. You can create three different types of filters: - -- Mailbox filter: Specifies mailboxes that can be searched by the assigned users. Valid syntax is Mailbox\_\<MailboxPropertyName\>, where \<MailboxPropertyName\> 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://technet.microsoft.com/library/bb738157.aspx). - -- Mailbox content filter: Specifies mailbox content that the assigned users can search for. Valid syntax is MailboxContent\_\<SearchablePropertyName\>:\<value\>, where \<SearchablePropertyName\> specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, MailboxContent\_recipients:contoso.com allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable message properties, see Keyword queries for Compliance Search (https://technet.microsoft.com/library/ms.o365.cc.searchquerylearnmore.aspx). - -- Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create. Site\_\<SearchableSiteProperty\> 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. SiteContent\_\<SearchableSiteProperty\> 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 (https://go.microsoft.com/fwlink/p/?LinkId=331599). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. - -You can specify multiple filters of the same type. For example, "Mailbox\_CustomAttribute10 -eq 'FTE' -and Mailbox\_MemberOfGroup -eq '$($DG.DistinguishedName)'". - -You have to create a search permissions filter to explicitly prevent users from searching any content location in a specific Office 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you have to create a create a filter that prevents them from mailboxes (see Example 9). Similarly, to allow an Exchange admin to only search mailboxes, you have to create a create a filter that prevents them from searching sites. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ff60106c-5974-4367-80df-f48406e419fe.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-MailboxSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-MailboxSearch.md deleted file mode 100644 index 5e63228a55..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-MailboxSearch.md +++ /dev/null @@ -1,724 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -On July 1, 2018, you'll no longer be able to use the New-MailboxSearch cmdlet to create In-Place eDiscovery searches and In-Place Holds in Exchange Online. To create eDiscovery searches and eDiscovery case holds, please start using New-ComplianceSearch and New-CaseHoldPolicy in the Office 365 Security & Compliance Center. You'll still be able to use Set-MailboxSearch to modify existing In-Place eDiscovery searches and In-Place Holds. Creating new searches and holds in Exchange Server 2013 will still be supported, and searches run from your on-premises organization in an Exchange hybrid deployment aren't affected by this change. - -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. - -By default, mailbox searches are performed across all Exchange 2016 and Exchange 2013 Mailbox servers in an Exchange organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. - -For more information, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx) and In-Place Hold and Litigation Hold (https://technet.microsoft.com/library/ff637980.aspx). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-MailboxSearch [-Name] <String> - [-AllPublicFolderSources <$true | $false>] - [-AllSourceMailboxes <$true | $false>] - [-Confirm] - [-Description <String>] - [-DomainController <Fqdn>] - [-DoNotIncludeArchive] - [-EndDate <ExDateTime>] - [-EstimateOnly] - [-ExcludeDuplicateMessages <$true | $false>] - [-Force] - [-IncludeKeywordStatistics] - [-IncludeUnsearchableItems] - [-InPlaceHoldEnabled <$true | $false>] - [-InPlaceHoldIdentity <String>] - [-ItemHoldPeriod <Unlimited>] - [-Language <CultureInfo>] - [-LogLevel <Suppress | Basic | Full>] - [-MessageTypes <KindKeyword[]>] - [-PublicFolderSources <PublicFolderIdParameter[]>] - [-Recipients <String[]>] - [-SearchDumpster] - [-SearchQuery <String>] - [-Senders <String[]>] - [-SourceMailboxes <RecipientIdParameter[]>] - [-StartDate <ExDateTime>] - [-StatusMailRecipients <RecipientIdParameter[]>] - [-TargetMailbox <MailboxIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-MailboxSearch cmdlet creates an In-Place eDiscovery search or an In-Place Hold. Unless specified, mailboxes on all Mailbox servers in an organization are searched. You can stop, start, modify, or remove the 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MailboxSearch -Name "Legal-ProjectX" -SourceMailboxes DG-Marketing,DG-Executives -TargetMailbox LegalDiscovery@contoso.com -StartDate "01/01/2018" -EndDate "12/31/2018" -Recipients "@contoso.com" -SearchQuery "project report hasattachments:true" -StatusMailRecipients "DG-DiscoveryTeam" -``` - -This example creates the mailbox search Legal-ProjectX. The search uses several parameters to restrict the search query: - -SourceMailboxes: This parameter restricts the search to members of the DG-Marketing and DG-Executives distribution groups. - -Recipients: This parameter specifies that the search includes all mail sent to the domain contoso.com. - -SearchQuery: This parameter specifies a KQL query for messages with either the words project or report and for messages with attachments. - -StartDate and EndDate: These parameters specify the start date of January 1, 2018, and end date of December 31, 2018, for the search. - -TargetMailbox: This parameter specifies that search results should be copied to the discovery mailbox LegalDiscovery. - -StatusMailRecipeints: This parameter specifies that the distribution group DG-DiscoveryTeam is to receive a notification when the search is complete. - -### -------------------------- Example 2 -------------------------- -``` -New-MailboxSearch -Name "Hold-ProjectX" -SourceMailboxes DG-Finance -InPlaceHoldEnabled $true -``` - -This example creates an In-Place Hold Hold-ProjectX and places all members of the distribution group DG-Finance on hold. Because the search doesn't specify the SearchQuery and ItemHoldPeriod parameters, all messages in mailboxes returned are placed on indefinite In-Place Hold. - -### -------------------------- Example 3 -------------------------- -``` -New-MailboxSearch -Name "Hold-tailspintoys" -SourceMailboxes DG-Research -SearchQuery "'Patent' AND 'Project tailspintoys'" -InPlaceHoldEnabled $true -``` - -This example creates an In-Place Hold Hold-tailspintoys and places all members of the distribution group DG-Research on hold. Because the search specifies the SearchQuery parameter, only messages that match the search query are placed on indefinite In-Place Hold. - -### -------------------------- Example 4 -------------------------- -``` -New-MailboxSearch -Name "Hold for all PFs" -AllPublicFolderSources $true -InPlaceHoldEnabled $true -``` - -In on-premises Exchange, this example creates an In-Place Hold named Hold for all PFs that places all content in all public folders on In-Place hold, with an unlimited hold duration. - -## PARAMETERS - -### -Name -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllPublicFolderSources -This parameter is available only in on-premises Exchange. - -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]). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllSourceMailboxes -This parameter is available only in on-premises Exchange. - -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]). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotIncludeArchive -This parameter is available or functional only in Exchange Server 2010. - -The DoNotIncludeArchive parameter specifies whether archive mailboxes are included in the search. By default, archive mailboxes are included in the search. To exclude archive mailboxes, set the DoNotIncludeArchive parameter to $true. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -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 -``` - -### -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. - -If you don't use this switch, messages are copied to the target mailbox. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDuplicateMessages -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. - -- $false: Copy all instances of a message if the same message exists in multiple folders or mailboxes. - -```yaml -Type: $true | $false -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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -IncludeKeywordStatistics -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUnsearchableItems -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InPlaceHoldEnabled -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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InPlaceHoldIdentity -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemHoldPeriod -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -The Language parameter specifies a locale for the search. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -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. - -- 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: Suppress | Basic | Full -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 -``` - -### -MessageTypes -The MessageTypes parameter specifies the message types to include in the search query. Valid values are: - -- Contacts - -- Docs - -- Email - -- IM - -- Journals - -- Meetings - -- Notes - -- Tasks - -You can specify multiple values separated by commas. - -The default value is blank ($null), which means all message types are included. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderSources -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PublicFolderIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -Recipients -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchDumpster -This parameter is available or functional only in Exchange Server 2010. - -The SearchDumpster parameter enables searching the dumpster, which is a storage location where items deleted from the Deleted Items folder are located until they are purged from the mailbox database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchQuery -The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. - -The other search query parameters are: - -- EndDate - -- MessageTypes - -- Recipients - -- Senders - -- StartDate - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Senders -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 ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceMailboxes -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can specify multiple values separated by commas. - -To use this parameter, the AllSourceMailboxes parameter needs to be $false (the default value). - -The default value is blank ($null), which means no source mailboxes are specified. To clear the source mailboxes, use the value $null. - -To enable In-Place Hold on the search results, you need to set the AllSourceMailboxes parameter to $false (the default value) and configure one or both of the following settings: - -- Specify one ore more source mailboxes by using the SourceMailboxes parameter. - -- In on-premises Exchange, set the AllPublicFolderSources parameter to $true. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: ExDateTime -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 -``` - -### -StatusMailRecipients -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can specify multiple values separated by commas. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetMailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/74303b47-bb49-407c-a43b-590356eae35c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md deleted file mode 100644 index 53f4c634d7..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: Remove-ComplianceSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the Remove-ComplianceSearch cmdlet to remove compliance searches from Exchange Server 2016 and from the Office 365 Security & Compliance Center. The searches must be stopped or completed. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceSearch [-Identity] <ComplianceSearchIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ComplianceSearch -Identity "Case 1234" -``` - -This example removes the compliance search named Case 1234 - -## PARAMETERS - -### -Identity -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: - -- Name - -- JobRunId (GUID) - -You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status - -```yaml -Type: ComplianceSearchIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6f952437-7ddd-42f8-b10b-5ab4e5562141.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md deleted file mode 100644 index 54101af9a1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ComplianceSearchAction -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ComplianceSearchAction - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ComplianceSearch cmdlet to remove compliance search actions from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceSearchAction [-Identity] <ComplianceSearchActionIdParameter> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ComplianceSearchAction -Identity "Case 1234_Preview" -``` - -This example the compliance search action named "Case 1234\_Preview" - -## PARAMETERS - -### -Identity -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. - -- JobRunId (GUID) - -```yaml -Type: ComplianceSearchActionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2c335517-bd10-4d0b-98b7-366a8de22cc1.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md deleted file mode 100644 index 452e02d6a5..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ComplianceSecurityFilter -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ComplianceSecurityFilter - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ComplianceSecurityFilter cmdlet to remove compliance security filters from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceSecurityFilter -FilterName <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ComplianceSecurityFilter -FilterName "HR Filter" -``` - -This example removes the compliance security filter named HR Filter. - -## PARAMETERS - -### -FilterName -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fa62d1f1-22a5-4cfa-b1ca-0120b3bb2564.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md deleted file mode 100644 index a8cc3fbbec..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MailboxSearch cmdlet to remove a mailbox search. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailboxSearch [-Identity] <SearchObjectIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -In on-premises Exchange and Exchange Online, 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailboxSearch -Identity "Project Contoso" -``` - -This example removes the mailbox search Project Contoso. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8d97c7d0-da13-492c-9efc-3646b7bf173a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md deleted file mode 100644 index 6a21e68ebd..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md +++ /dev/null @@ -1,796 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: Set-ComplianceSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the Set-ComplianceSearch cmdlet to modify non-running compliance searches in Exchange Server 2016 and in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ComplianceSearch [-Identity] <ComplianceSearchIdParameter> [-AddExchangeLocation <String[]>] - [-AddExchangeLocationExclusion <String[]>] [-AddOneDriveLocation <String[]>] - [-AddOneDriveLocationExclusion <String[]>] [-AddPublicFolderLocation <String[]>] - [-AddPublicFolderLocationExclusion <String[]>] [-AddSharePointLocation <String[]>] - [-AddSharePointLocationExclusion <String[]>] [-AllowNotFoundExchangeLocationsEnabled <$true | $false>] - [-Confirm] [-ContentMatchQuery <String>] [-Description <String>] [-ExchangeLocation <String[]>] - [-ExchangeLocationExclusion <String[]>] [-Force] [-HoldNames <String[]>] [-IncludeUserAppContent <$true | $false>] [-Language <CultureInfo>] - [-Name <String>] [-OneDriveLocation <String[]>] [-OneDriveLocationExclusion <String[]>] - [-PublicFolderLocation <String[]>] [-PublicFolderLocationExclusion <String[]>] [-RefinerNames <String[]>] - [-RemoveExchangeLocation <String[]>] [-RemoveExchangeLocationExclusion <String[]>] - [-RemoveOneDriveLocation <String[]>] [-RemoveOneDriveLocationExclusion <String[]>] - [-RemovePublicFolderLocation <String[]>] [-RemovePublicFolderLocationExclusion <String[]>] - [-RemoveSharePointLocation <String[]>] [-RemoveSharePointLocationExclusion <String[]>] - [-SearchNames <String[]>] [-SharePointLocation <String[]>] [-SharePointLocationExclusion <String[]>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ComplianceSearch -Identity "Project X" -ExchangeLocation All -``` - -This example changes the existing compliance search named Project X. The scope of the Exchange search is changed to all mailboxes. - -### -------------------------- Example 2 -------------------------- -``` -Set-ComplianceSearch -Identity "Contoso Case Search 1" -HoldNames All -ExchangeLocation $null -SharePointLocation $null -``` - -This example changes an existing compliance search that's associated with an eDiscovery case in the Office 365 Security & Compliance Center. The scope of the search is changed from searching selected mailboxes and SharePoint sites to searching all content locations that have been placed on hold in the eDiscovery case. - -### -------------------------- Example 3 -------------------------- -``` -Set-ComplianceSearch -Identity "China Subsidiary Search" -Language zh-CN -``` - -This example changes the language setting for an existing compliance search to Chinese. - -You might have to change the language setting if you're using non-English keywords in the search query (which is specified in the ContentMatchQuery parameter). - -## PARAMETERS - -### -Identity -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: - -- Name - -- JobRunId (GUID) - -You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status - -```yaml -Type: ComplianceSearchIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddExchangeLocation -The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - -- A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Office 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddExchangeLocationExclusion -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 regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Office 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddOneDriveLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddOneDriveLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddPublicFolderLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddPublicFolderLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddSharePointLocationExclusion -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowNotFoundExchangeLocationsEnabled -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. - -The mailbox types that are affected by the value of this parameter include: - -- Inactive mailboxes - -- Users without an Exchange Online license who use Office applications - -- Office 365 guest users - -- On-premises users whose identity is synchronized with your Office 365 organization - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocation -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 Office 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -- The value All for all mailboxes. You can only use this value by itself. - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocationExclusion -This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: - -- A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Office 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HoldNames -The HoldNames parameter specifies that the content locations that have been placed on hold in the eDiscovery case will be searched. You use the value All for this parameter. You can use this parameter only for compliance searches that are associated with an eDiscovery case. - -If the content locations in the compliance search include mailboxes, you also need to use the ExchangeLocation parameter with the value $null. Similarly, if the compliance search includes SharePoint sites, you also need to use the SharePointLocation parameter withthe value $null. - -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. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUserAppContent -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 Office 365 user account in your organization. These types of users include users without an Exchange Online license who use Office applications, Office 365 guest users, and on-premises users whose identity is synchronized with your Office 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -The Language parameter specifies the language for the compliance search. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocation -The PublicFolderLocation parameter specifies that you want to include all public folders in the search. You use the value All for this parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefinerNames -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocation -The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocationExclusion -This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveOneDriveLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveOneDriveLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePublicFolderLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePublicFolderLocationExclusion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSharePointLocationExclusion -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchNames -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocationExclusion -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/49464588-9e57-442f-97ec-ab9d9927983a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md deleted file mode 100644 index de10c6fd32..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ComplianceSearchAction -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ComplianceSearchAction - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ComplianceSearchAction cmdlet to change the export key on export compliance search actions in on-premises Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ComplianceSearchAction [-Identity] <ComplianceSearchActionIdParameter> [-ChangeExportKey] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ComplianceSearchAction -Identity "Project X_Export" -ChangeExportKey -``` - -This example changes the export key on the export compliance search action named Project X\_Export. - -## PARAMETERS - -### -Identity -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). - -- JobRunId (GUID) - -```yaml -Type: ComplianceSearchActionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ChangeExportKey -The ChangeExportKey switch creates a new export key for the compliance search action. You don't need to specify a value with this switch. - -This parameter is only meaningful on export compliance search actions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cadf2068-ed32-49a3-98f1-da5a516689cc.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md deleted file mode 100644 index 2b7d65ce40..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ComplianceSecurityFilter -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ComplianceSecurityFilter - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-ComplianceSecurityFilter cmdlet to modify compliance security filters in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ComplianceSecurityFilter -FilterName <String> [-Action <Unknown | Preview | Export | Purge | Search | All>] - [-Confirm] [-Description <String>] [-Filters <MultiValuedProperty>] [-Region <String>] - [-Users <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter"; $filterusers.users.add("pilarp@contoso.com"); Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users -``` - -This example adds user pilarp@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. - -### -------------------------- Example 2 -------------------------- -``` -$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter"; $filterusers.users.remove("annb@contoso.com"); Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users -``` - -This example removes user annb@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. - -## PARAMETERS - -### -FilterName -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Action -The Action parameter specifies that type of search action that the filter is applied to. Valid values are: - -- Export: The filter is applied when exporting search results, or preparing them for analysis in Office 365 Advanced eDiscovery. - -- Preview: The filter is applied when previewing search results. - -- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. - -- Search: The filter is applied when running a search. - -- All: The filter is applied to all search actions. - -```yaml -Type: Unknown | Preview | Export | Purge | Search | All -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filters -The Filters parameter specifies the search criteria for the compliance security filter. You can create three different types of filters: - -- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is Mailbox\_\<MailboxPropertyName\>, where \<MailboxPropertyName\> 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://technet.microsoft.com/library/bb738157.aspx). - -- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is MailboxContent\_\<SearchablePropertyName\>:\<value\>, where \<SearchablePropertyName\> specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, MailboxContent\_recipients:contoso.com allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable message properties, see Keyword queries for Compliance Search (https://technet.microsoft.com/library/ms.o365.cc.searchquerylearnmore.aspx). - -- Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create: Site\_\<SearchableSiteProperty\> (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\_\<SearchableSiteProperty\> (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 (https://go.microsoft.com/fwlink/p/?LinkId=331599). 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)'". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -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. - -- The value All: Assigns the filter to all users. You can only use this value by itself. - -- One or more role groups: Identify the role group by its name. You can specify multiple values separated by commas. - -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9e47c29a-abbe-4e9a-8e3f-cd210793273b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md deleted file mode 100644 index 410025e227..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: Start-ComplianceSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the Start-ComplianceSearch cmdlet to start stopped, completed or not started compliance searches in Exchange Server 2016 and in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-ComplianceSearch [-Identity] <ComplianceSearchIdParameter> [-Confirm] [-Force] [-RetryOnError] - [-UseBigFunnel] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-ComplianceSearch -Identity "Case 1234" -``` - -This example starts the compliance search named Case 1234 - -## PARAMETERS - -### -Identity -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: - -- Name - -- JobRunId (GUID) - -You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status - -```yaml -Type: ComplianceSearchIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryOnError -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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseBigFunnel -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/17ef8cc9-d716-446c-a8b9-b9109a6cab5a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md deleted file mode 100644 index 0883dfb5ab..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MailboxSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-MailboxSearch [-Identity] <SearchObjectIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-Resume] [-WhatIf] [-StatisticsStartIndex <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use In-Place eDiscovery to search one or more specified mailboxes or all mailboxes across the Exchange organization. A search is created by using the Exchange admin center (EAC) or the New-MailboxSearch cmdlet. - -When restarting a search, any previous results returned by the same search and copied to a Discovery mailbox are removed. To preserve previous search results and resume the search from the point it was stopped, use the Resume switch. - -In Exchange 2013 or later, mailbox searches are also used for In-Place Hold. However, you can't start or stop In-Place Hold using the Start-MailboxSearch and Stop-MailboxSearch cmdlets. - -For more details, see In-Place Hold and Litigation Hold (https://technet.microsoft.com/library/ff637980.aspx) and In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-MailboxSearch -Identity "ProjectContoso" -``` - -This example starts the mailbox search ProjectContoso. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Resume -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -StatisticsStartIndex -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f0c4e047-7eca-4310-bfad-1ecfe1420ceb.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md deleted file mode 100644 index c03cacefff..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -title: Stop-ComplianceSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || o365scc-ps" ---- - -# 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. - -Use the Stop-ComplianceSearch cmdlet to stop running compliance searches in Exchange Server 2016 and in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Stop-ComplianceSearch [-Identity] <ComplianceSearchIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group and not to the Organization Management role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Stop-ComplianceSearch -Identity "Case 1234" -``` - -This example stops the active compliance search named Case 1234 - -## PARAMETERS - -### -Identity -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: - -- Name - -- JobRunId (GUID) - -You can find these values by running the command Get-ComplianceSearch | Format-Table -Auto Name,JobRunId,Status - -```yaml -Type: ComplianceSearchIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying 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, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/675934e6-8a55-4615-8c46-a20bc656afdc.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md b/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md deleted file mode 100644 index af382f5d43..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MailboxSearch -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Stop-MailboxSearch cmdlet to stop a mailbox search that's in progress. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Stop-MailboxSearch [-Identity] <SearchObjectIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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 (https://technet.microsoft.com/library/dd298021.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Stop-MailboxSearch -Identity "Project Contoso" -``` - -This example stops the mailbox search Project Contoso. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b718688e-261e-45b5-947e-4d34abcb568c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md deleted file mode 100644 index 11cfe13d37..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-DlpPolicyCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Export-DlpPolicyCollection - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Export-DlpPolicyCollection cmdlet to export data loss prevention (DLP) policy collections from your organization to a file. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-DlpPolicyCollection [[-Identity] <DlpPolicyIdParameter>] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$file = Export-DlpPolicyCollection; Set-Content -Path "C:\My Documents\Contoso PII.xml" -Value $file.FileData -Encoding Byte -``` - -This example exports all the elements of the existing DLP policies to the file C:\\My Documents\\Contoso PII.xml. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f6a0aedc-8aac-4c0a-9a4d-09a4823604b6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md deleted file mode 100644 index 5313701aec..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ClassificationRuleCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-ClassificationRuleCollection cmdlet to view the classification rule collections in your organization. - -In the Office 365 Security & Compliance Center, use the Get-DlpSensitiveInformationTypeRulePackage cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ClassificationRuleCollection [[-Identity] <ClassificationRuleCollectionIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ClassificationRuleCollection -``` - -This example returns a summary list of all classification rule collections. - -### -------------------------- Example 2 -------------------------- -``` -Get-ClassificationRuleCollection "Microsoft Rule Pack" | Format-List -``` - -This example returns detailed information about the classification rule collection named Microsoft Rule Pack. The command is piped to the Format-List cmdlet to display the detailed configuration of the specified classification rule collection. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bb740ed7-6af4-4053-ad9c-6688ca42b481.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DataClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DataClassification.md deleted file mode 100644 index 54e948b083..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DataClassification.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DataClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-DataClassification - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -In Exchange Online, this cmdlet has been replaced by the [Get-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-dlp/get-dlpsensitiveinformationtype) cmdlet in Office 365 Security & Compliance Center PowerShell. - -Use the Get-DataClassification cmdlet to view the data classification rules in your organization. This cmdlet shows built-in data classification rules and rules that you created that use document fingerprints. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RuleCollectionIdentity -``` -Get-DataClassification [[-ClassificationRuleCollectionIdentity] <ClassificationRuleCollectionIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-DataClassification [[-Identity] <DataClassificationIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DataClassification -``` - -This example returns a summary list of all data classification rules in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DataClassification -ClassificationRuleCollectionIdentity "Fingerprint Classification Collection" -``` - -This example returns a summary list of all new data classification rules based on document fingerprints that you created. - -### -------------------------- Example 3 -------------------------- -``` -Get-DataClassification "SWIFT Code" | Format-List -``` - -This example returns details of the built-in data classification rule named SWIFT Code. - -## PARAMETERS - -### -ClassificationRuleCollectionIdentity -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 -Required: False -Position: 1 -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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the data classification rule that you want to view. You can use any value that uniquely identifies the data classification rule. For example: - -- Name - -- LocalizedName - -- Identity GUID value - -```yaml -Type: DataClassificationIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7f1daf42-8805-4313-831c-f473ddfd6371.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md deleted file mode 100644 index aea6ac55d9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-DataClassificationConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-DataClassificationConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-DataClassificationConfig cmdlet to view the data classification configuration for your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DataClassificationConfig [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DataClassificationConfig -``` - -This example returns the data classification configuration for your organization. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2d6b5b26-37f6-44d9-b8d8-80ece8cfff32.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md deleted file mode 100644 index 8cfb41a156..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DlpCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DlpCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpCompliancePolicy to view Data Loss Prevention (DLP) policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpCompliancePolicy [[-Identity] <PolicyIdParameter>] [-DistributionDetail] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpCompliancePolicy -``` - -This example displays summary information for all DLP policies in the Security & Compliance Center. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpCompliancePolicy -Identity "PII Limited" | Format-List -``` - -This example displays detailed information for the DLP policy named "PII Limited". - -## PARAMETERS - -### -DistributionDetail -The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a03a2ec9-f80a-403e-bc3d-e169484e28eb.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md deleted file mode 100644 index 7fb58b9cb3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DlpComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DlpComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpComplianceRule to view Data Loss Prevention (DLP) rules in the Security & Compliance Center. DLP rules identify and protect sensitive information. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpComplianceRule [[-Identity] <ComplianceRuleIdParameter>] [-DomainController <Fqdn>] - [-Policy <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpComplianceRule -``` - -This example displays summary information for all DLP rules in the Security & Compliance Center. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpComplianceRule -Identity "PII SS# Custom" | Format-List -``` - -This example displays detailed information for the DLP rule named "PII SS# Custom". - -### -------------------------- Example 3 -------------------------- -``` -Get-DlpComplianceRule -Policy "PII Limited" -``` - -This example lists all the rules included in the DLP compliance policy named "PII Limited". - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fd3d6c2f-618b-4a01-9d52-344f7a89daac.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md deleted file mode 100644 index f01d9bb870..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DlpComplianceRuleV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DlpComplianceRuleV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpComplianceRuleV2 to view Data Loss Prevention (DLP) rules in the Security & Compliance Center. DLP rules identify and protect sensitive information. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpComplianceRuleV2 [[-Identity] <ComplianceRuleIdParameter>] [-DomainController <Fqdn>] - [-Policy <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpComplianceRuleV2 -``` - -This example displays summary information for all DLP rules in the Security & Compliance Center. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpComplianceRuleV2 -Identity "PII SS# Custom" | Format-List -``` - -This example displays detailed information for the DLP rule named "PII SS# Custom". - -### -------------------------- Example 3 -------------------------- -``` -Get-DlpComplianceRuleV2 -Policy "PII Limited" -``` - -This example lists all the rules included in the DLP compliance policy named "PII Limited". - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4566b601-104e-4843-b1d0-110b33ba1311.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md deleted file mode 100644 index afe0241872..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-DlpDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-DlpDetailReport - -## SYNOPSIS -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 information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpDetailReport [-Action <MultiValuedProperty>] [-Actor <MultiValuedProperty>] - [-DlpCompliancePolicy <MultiValuedProperty>] [-DlpComplianceRule <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] - [-Source <MultiValuedProperty>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-DlpDetailReport cmdlet returns detailed information about specific DLP rule matches for the last 7 days. Although the cmdlet accepts date ranges older than 7 days, only information about the last 7 days are returned. The properties returned include: - -- Date - -- Title - -- Location - -- Severity - -- Size - -- Source - -- Actor - -- DLPPolicy - -- UserAction - -- Justification - -- SensitiveInformationType - -- SensitiveInformationCount - -- SensitiveInformationConfidence - -- EventType - -- Action - -- ObjectId - -To see DLP detection data that's aggregated per day, use the 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpDetailReport -StartDate 11/01/2018 -EndDate 11/07/2018 -``` - -The following example lists the details of all the DLP policy activities defined in your organization between the dates specified. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies. Valid values are: - -- BlockAccess - -- GenerateIncidentReport - -- NotifyUser - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Actor -The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpCompliancePolicy -The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpComplianceRule -The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- DLPActionHits - -- DLPPolicyFalsePositive - -- DLPPolicyHits - -- DLPPolicyOverride - -- DLPRuleHits - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -The Source parameter filters the report by workload. Valid values are: - -- EXCH: Exchange Online - -- ODB: OneDrive for Business - -- SPO: SharePoint Online - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/241165c2-7488-4e82-bdd1-4e580b2e381f.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md deleted file mode 100644 index 04ef805dcc..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-DlpDetectionsReport -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-DlpDetectionsReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-DlpDetectionsReport cmdlet to list a summary of Data Loss Prevention (DLP) rule matches for Exchange Online, SharePoint Online and OneDrive for Business in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpDetectionsReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-DlpCompliancePolicy <MultiValuedProperty>] [-DlpComplianceRule <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] - [-Source <MultiValuedProperty>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-DlpDetectionsReport cmdlet returns general DLP detection data that's aggregated per day. The properties returned include: - -- Date - -- DlpPolicy - -- TransportRule - -- Action - -- EventType - -- MessageCount - -- Source - -- StartDate - -- EndDate - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpDetectionsReport -StartDate 11/01/2018 -EndDate 11/30/2018 -``` - -This example lists the DLP activities for November, 2018. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies. Valid values are: - -- BlockAccess - -- GenerateIncidentReport - -- NotifyUser - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpCompliancePolicy -The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpComplianceRule -The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- DLPActionHits - -- DLPPolicyFalsePositive - -- DLPPolicyHits - -- DLPPolicyOverride - -- DLPRuleHits - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -The Source parameter filters the report by workload. Valid values are: - -- EXCH: Exchange Online - -- ODB: OneDrive for Business - -- SPO: SharePoint Online - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -For the Get-DLPDetectionsReport cmdlet, the SummarizeBy parameter accepts the following values: - -- Action - -- DLPPolicy - -- Domain - -- EventType - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/063edb32-476f-41e7-a232-2b08276eb331.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md deleted file mode 100644 index 5cc1b3aab3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DlpKeywordDictionary -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DlpKeywordDictionary - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpKeywordDictionary cmdlet to view data loss prevention (DLP) keyword dictionaries in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpKeywordDictionary [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpKeywordDictionary | Format-Table -Auto Name,Description -``` - -This example returns a summary list of all DLP keyword dictionaries. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpKeywordDictionary -Name "Financial Data" -``` - -This example returns detailed information about the DLP keyword dictionary named Financial Data. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b6e1fd1a-7766-4bd5-b842-ada59c8c941c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md deleted file mode 100644 index 352c1072ca..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DlpPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-DlpPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-DlpPolicy cmdlet to view information about existing data loss prevention (DLP) policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpPolicy [[-Identity] <DlpPolicyIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpPolicy -``` - -This example returns a summary list of all DLP policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpPolicy "Employee Numbers" | Format-List -``` - -This example returns detailed information about the DLP policy named Employee Numbers. The command is piped to the Format-List cmdlet to display the detailed configuration of the specified DLP policy. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the DLP policy you want to remove. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. - -```yaml -Type: DlpPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cfb850c5-efb2-4fb5-a5c3-3fb6aba11008.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md deleted file mode 100644 index 8cfcc19c36..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DlpPolicyTemplate -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-DlpPolicyTemplate - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-DlpPolicyTemplate cmdlet to view existing data loss prevention (DLP) policy templates in your Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpPolicyTemplate [[-Identity] <DlpPolicyIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpPolicyTemplate -``` - -This example returns a summary list of all DLP policy templates. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpPolicyTemplate GLBA | Format-List -``` - -This example returns detailed information about the DLP policy template named GLBA. The command is piped to the Format-List cmdlet to display the detailed configuration of the specified DLP policy template. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/05615b24-f9c6-4e52-926b-6ecee810d115.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md deleted file mode 100644 index 3e4755b263..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-DlpSensitiveInformationType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-DlpSensitiveInformationType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpSensitiveInformationType cmdlet to list the sensitive information types that are defined for your organization in the Security & Compliance Center. Sensitive information types are used by Data Loss Prevention (DLP) rules to check for sensitive information such as social security, passport, or credit card numbers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpSensitiveInformationType [[-Identity] <SensitiveInformationTypeIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The RecommendedConfidence property of the returned objects contains a value that represents the default (or recommended) confidence level that should be used with the corresponding sensitive information type. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpSensitiveInformationType -``` - -This example lists all the sensitive information types defined for your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpSensitiveInformationType -Identity "Credit Card Number" | Format-List -``` - -This example lists all the properties of the sensitive information type named "Credit Card Number". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the sensitive information type that you want to view. Valid values are: - -- Name - -- Id (GUID value) - -```yaml -Type: SensitiveInformationTypeIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2ac12437-1463-45e1-9da5-f306ae07e1af.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md deleted file mode 100644 index 3c440231b6..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-DlpSensitiveInformationTypeRulePackage - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpSensitiveInformationTypeConfig cmdlet to view data loss prevention (DLP) sensitive information type rule packages in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpSensitiveInformationTypeRulePackage [[-Identity] <SensitiveInformationTypeRuleCollectionIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DlpSensitiveInformationTypeRulePackage -``` - -This example returns a summary list of all sensitive information type rule packages in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DlpSensitiveInformationTypeRulePackage - Identity "Microsoft Rule Package" | Format-List -``` - -This example returns detailed information for the sensitive information type rule package named Microsoft Rule Package. - -## PARAMETERS - -### -Identity -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 - -- LocalizedName - -- GUID (from the Identity value) - -```yaml -Type: SensitiveInformationTypeRuleCollectionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/18453823-70f8-409d-a165-0581b796895c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md deleted file mode 100644 index 9a71e84fd3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-DlpSiDetectionsReport -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-DlpSiDetectionsReport - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DlpSiDetectionsReport [-EndDate <DateTime>] [-SensitiveType <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -### -------------------------- Example 2 -------------------------- -``` -Insert example commands for example 2. -``` - -Insert descriptive text for example 2. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SensitiveType -The SensitiveType parameter filters the results by the detected sensitive information type. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4d8a40d2-95f7-48cf-9193-2ee0087079c6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md deleted file mode 100644 index 5dd1d57fab..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PolicyTipConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-PolicyTipConfig cmdlet to view the data loss prevention (DLP) Policy Tips in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Paramters -``` -Get-PolicyTipConfig [-Action <NotifyOnly | RejectOverride | Reject | Url>] [-Locale <CultureInfo>] [-Original] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-PolicyTipConfig [[-Identity] <PolicyTipConfigIdParameter>] - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PolicyTipConfig -Action NotifyOnly -``` - -This example returns a summary list of the custom Policy Tips in all languages that have the action value NotifyOnly. - -### -------------------------- Example 2 -------------------------- -``` -Get-PolicyTipConfig -Original -Locale fr -``` - -This example returns a summary list of all built-in French Policy Tips. - -### -------------------------- Example 3 -------------------------- -``` -Get-PolicyTipConfig en\RejectOverride | Format-List -``` - -This example returns details about the custom English Policy Tip for the action value RejectOverride. - -## PARAMETERS - -### -Action -The Action parameter filters the Policy Tips by action. Valid values for this parameter are: - -- NotifyOnly - -- RejectOverride - -- Reject - -You can't use the value Url with the Action parameter. Instead, use command: Get-PolicyTipConfig Url. - -You can't use the Action parameter with the Identity parameter. - -```yaml -Type: NotifyOnly | RejectOverride | Reject | Url -Parameter Sets: Paramters -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - -- The value Url - -- GUID - -- Distinguished name (DN) - -You can't use the Identity parameter with the Action, Locale or Original parameters. - -```yaml -Type: PolicyTipConfigIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter specifies a locale-specific version of the Policy Tip. - -Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). - -You can't use the Locale parameter with the Identity parameter. - -```yaml -Type: CultureInfo -Parameter Sets: Paramters -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Original -The Original switch includes built-in Policy Tips in the results. You don't specify a value with the Original switch. You can't use the Original switch with the Identity parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Paramters -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/103ad92b-d56d-4568-9b30-35aea82cf0eb.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md deleted file mode 100644 index a32e52fc92..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-DlpPolicyCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Import-DlpPolicyCollection - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Import-DlpPolicyCollection cmdlet to import data loss prevention (DLP) policy collections into your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Import-DlpPolicyCollection [-FileData] <Byte[]> [[-Identity] <DlpPolicyIdParameter>] [-Confirm] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-DlpPolicyCollection cmdlet imports all the settings of the DLP policies and the associated transport rules. You use the Export-DlpPolicyCollection cmdlet to export the DLP policy collection. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-DlpPolicyCollection -FileData ([Byte[]]$(Get-Content -Path " C:\My Documents\DLP Backup.xml " -Encoding Byte -ReadCount 0)) -``` - -This example imports the DLP policy collection in the file C:\\My Documents\\DLP Backup.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the DLP policy collection file you want to import. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Identity -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 -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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5a110133-35f3-4d45-8437-b8fed1218ac2.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md deleted file mode 100644 index b224585a31..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-DlpPolicyTemplate -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Import-DlpPolicyTemplate - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Import-DlpPolicyTemplate cmdlet to import a data loss prevention (DLP) policy template file into your Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Import-DlpPolicyTemplate [-FileData] <Byte[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-DlpPolicyTemplate -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External DLP Policy Template.xml" -Encoding Byte -ReadCount 0)) -``` - -This example imports the DLP policy template file C:\\My Documents\\External DLP Policy Template.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the DLP policy template file you want to import. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1e508447-a322-4a31-a80c-ab0471422fe2.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md deleted file mode 100644 index 9d482ba2b1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ClassificationRuleCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-ClassificationRuleCollection cmdlet to import new classification rule collections into your organization. - -In the Office 365 Security & Compliance Center, use the New-DlpSensitiveInformationTypeRulePackage cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ClassificationRuleCollection [-FileData] <Byte[]> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ClassificationRuleCollection -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Classification Rule Collection.xml" -Encoding Byte -ReadCount 0)) -``` - -This example imports the classification rule collection file C:\\My Documents\\External Classification Rule Collection.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the classification rule collection file you want to import. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1e4fe132-1d80-4053-8db2-8dd6a3710fcf.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DataClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DataClassification.md deleted file mode 100644 index f0f4e7a5bb..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DataClassification.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DataClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-DataClassification - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -In Exchange Online, this cmdlet has been replaced by the [New-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-dlp/new-dlpsensitiveinformationtype) cmdlet in Office 365 Security & Compliance Center PowerShell. - -Use the New-DataClassification cmdlet to create data classification rules that use document fingerprints. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DataClassification [-Name] <String> -Description <String> -Fingerprints <MultiValuedProperty> - [-ClassificationRuleCollectionIdentity <ClassificationRuleCollectionIdParameter>] [-Confirm] - [-DomainController <Fqdn>] [-Locale <CultureInfo>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte; $Employee_Fingerprint = New-Fingerprint -FileData $Employee_Template -Description "Contoso Employee Template"; $Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte; $Customer_Fingerprint = New-Fingerprint -FileData $Customer_Template -Description "Contoso Customer Template"; New-DataClassification -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint,$Customer_Fingerprint -Description "Message contains Contoso employee or customer information." -``` - -This example creates a new data classification rule named "Contoso Employee-Customer Confidential" that uses the document fingerprints of the files C:\\My Documents\\Contoso Employee Template.docx and D:\\Data\\Contoso Customer Template.docx. - -## PARAMETERS - -### -Description -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 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see New-Fingerprint or the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Name -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClassificationRuleCollectionIdentity -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter specifies the language that's associated with the 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://go.microsoft.com/fwlink/p/?linkId=184859). - -You can add additional language translations to the data classification rule by using the Set-DataClassification cmdlet. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3c1e90e7-cf49-4a8b-a0c4-c189ab8ab166.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md deleted file mode 100644 index af3f24fc04..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpCompliancePolicy cmdlet to create Data Loss Prevention (DLP) policies in the Security & Compliance Center. DLP policies contain DLP rules that identify, monitor, and protect sensitive information. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpCompliancePolicy [-Name] <String> [-Comment <String>] [-Confirm] - [-ExchangeLocation <MultiValuedProperty>] [-ExchangeOnPremisesLocation <MultiValuedProperty>] [-Force] - [-Mode <Enable | TestWithNotifications | TestWithoutNotifications | Disable | PendingDeletion>] - [-OneDriveLocation <MultiValuedProperty>] [-OneDriveLocationException <MultiValuedProperty>] - [-SharePointLocation <MultiValuedProperty>] [-SharePointLocationException <MultiValuedProperty>] - [-SharePointOnPremisesLocationException <MultiValuedProperty>] - [-SharePointServerLocation <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DlpCompliancePolicy -Name "GlobalPolicy" -SharePointLocation All -``` - -This example creates a DLP policy named GlobalPolicy that will be enforced across all SharePoint Online locations. - -### -------------------------- Example 2 -------------------------- -``` -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. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocation -The ExchangeLocation parameter specifies Exchange Online mailboxes to include in the DLP policy. You can only use the value All for this parameter to include all mailboxes. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeOnPremisesLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: - -- Enable: The policy is enabled for actions and notifications. This is the default value. - -- Disable: The policy is disabled. - -- TestWithNotifications: No actions are taken, but notifications are sent. - -- TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent. - -```yaml -Type: Enable | TestWithNotifications | TestWithoutNotifications | Disable | PendingDeletion -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". SharePoint Online sites can't be added to a policy until they have been indexed. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointOnPremisesLocationException -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointServerLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4a1d614a-08cf-4495-83c0-d0ed797d202a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md deleted file mode 100644 index 57b2d15b19..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md +++ /dev/null @@ -1,740 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpComplianceRule to create Data Loss Prevention (DLP) rules in the Security & Compliance Center. DLP rules define sensitive information to be protected and the actions to take on rule matches. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter> - [-AccessScope <InOrganization | NotInOrganization | None>] [-AccessTimeControl <PswsHashtable>] - [-ActivationDate <DateTime>] [-BlockAccess <$true | $false>] [-BlockAccessScope <$true | $false>] - [-Comment <String>] [-Confirm] [-ContentContainsSensitiveInformation <PswsHashtable[]>] - [-ContentPropertyContainsWords <MultiValuedProperty>] - [-Disabled <$true | $false>] [-DocumentIsUnsupported <$true | $false>] - [-ExceptIfAccessScope <InOrganization | NotInOrganization | None>] - [-ExceptIfContentContainsSensitiveInformation <PswsHashtable[]>] - [-ExceptIfContentPropertyContainsWords <MultiValuedProperty>] - [-ExceptIfDocumentIsUnsupported <$true | $false>] [-ExceptIfFrom <SmtpAddress[]>] - [-ExceptIfFromMemberOf <SmtpAddress[]>] [-ExceptIfProcessingLimitExceeded <$true | $false>] - [-ExpiryDate <DateTime>] [-From <SmtpAddress[]>] [-FromMemberOf <SmtpAddress[]>] - [-GenerateAlert <MultiValuedProperty>] [-GenerateIncidentReport <MultiValuedProperty>] [-ImmutableId <Guid>] - [-IncidentReportContent <ReportContentOption[]>] [-NotifyAllowOverride <OverrideOption[]>] - [-NotifyEmailCustomText <String>] [-NotifyPolicyTipCustomText <String>] - [-NotifyPolicyTipCustomTextTranslations <MultiValuedProperty>] [-NotifyUser <MultiValuedProperty>] - [-ProcessingLimitExceeded <$true | $false>] [-ReportSeverityLevel <Low | Medium | High | None>] - [-RuleErrorAction <Ignore | RetryThenBlock>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Each new rule must contain one condition filter or test, and one associated action. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DlpComplianceRule -Name "SocialSecurityRule" -Policy "USFinancialChecks" -ContentContainsSensitiveInformation @{Name="U.S. Social Security Number (SSN)"} -BlockAccess $True -``` - -This example create a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the existing DLP policy that will contain the DLP rule. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessScope -The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - -- InOrganization: The rule is applied to content that's accessible inside the organization. - -- NotInOrganization: The rule is applied to content that's accessible outside the organization. - -- None: The condition isn't used. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessTimeControl -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivationDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccess -The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccessScope -The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - -- All: Block access to everyone except the owner and the last modifier. - -- PerUser: Block access to external users. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. - -This parameter uses the basic syntax @(@{Name="\<SensitiveInformationType1\>";[minCount="\<Value\>"],@{Name="\<SensitiveInformationType2\>";[minCount="\<Value\>"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). - -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see Sensitive information types inventory (https://go.microsoft.com/fwlink/p/?LinkId=529420). - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentPropertyContainsWords -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\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - -- $true: The rule is disabled. - -- $false: The rule is enabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAccessScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentContainsSensitiveInformation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentPropertyContainsWords -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfDocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFrom -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateAlert -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -The email message that's generated by this action contains a link to detailed information in the Security & Compliance Center (the details aren't in the email message itself). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateIncidentReport -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportContent -The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - -- All - -- Default - -- Detections - -- DocumentAuthor - -- DocumentLastModifier - -- MatchedItem - -- RulesMatched - -- Service - -- Severity - -- Service - -- Title - -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: - -- DocumentAuthor - -- MatchedItem - -- RulesMatched - -- Service - -- Title - -Therefore, if you use any of these redundant values with the value Default, they will be ignored. - -```yaml -Type: ReportContentOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyAllowOverride -The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - -- FalsePositive: Allows overrides in the case of false positives. - -- WithoutJustification: Allows overrides without justification. - -- WithJustification: Allows overrides with justification. - -You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. - -```yaml -Type: OverrideOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyEmailCustomText -The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. - -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. - -- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomTextTranslations -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - -- An email address. - -- LastModifier - -- Owner - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportSeverityLevel -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. - -- Medium - -- High - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleErrorAction -The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - -- Ignore - -- RetryThenBlock - -- Blank (the value $null): This is the default value. - -```yaml -Type: Ignore | RetryThenBlock -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/57238e53-a9d8-495a-9b47-ef5020ec18a3.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md deleted file mode 100644 index 856b9dac4e..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md +++ /dev/null @@ -1,723 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpComplianceRuleV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpComplianceRuleV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpComplianceRuleV2 to create Data Loss Prevention (DLP) rules in the Security & Compliance Center. DLP rules define sensitive information to be protected and the actions to take on rule matches. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpComplianceRuleV2 [-Name] <String> -Policy <PolicyIdParameter> - [-AccessScope <InOrganization | NotInOrganization | None>] [-AccessTimeControl <PswsHashtable>] - [-ActivationDate <DateTime>] [-BlockAccess <$true | $false>] [-BlockAccessScope <All | PerUser>] - [-Comment <String>] [-Confirm] [-ContentContainsSensitiveInformation <PswsHashtable[]>] - [-ContentPropertyContainsWords <MultiValuedProperty>] [-Disabled <$true | $false>] - [-DocumentIsUnsupported <$true | $false>] [-ExceptIfAccessScope <InOrganization | NotInOrganization | None>] - [-ExceptIfContentContainsSensitiveInformation <PswsHashtable[]>] - [-ExceptIfContentPropertyContainsWords <MultiValuedProperty>] - [-ExceptIfDocumentIsUnsupported <$true | $false>] [-ExceptIfFrom <SmtpAddress[]>] - [-ExceptIfFromMemberOf <SmtpAddress[]>] [-ExceptIfProcessingLimitExceeded <$true | $false>] - [-ExpiryDate <DateTime>] [-From <SmtpAddress[]>] [-FromMemberOf <SmtpAddress[]>] - [-GenerateAlert <MultiValuedProperty>] [-GenerateIncidentReport <MultiValuedProperty>] [-ImmutableId <Guid>] - [-IncidentReportContent <ReportContentOption[]>] [-NotifyAllowOverride <OverrideOption[]>] - [-NotifyEmailCustomText <String>] [-NotifyPolicyTipCustomText <String>] - [-NotifyPolicyTipCustomTextTranslations <MultiValuedProperty>] [-NotifyUser <MultiValuedProperty>] - [-ProcessingLimitExceeded <$true | $false>] [-ReportSeverityLevel <Low | Medium | High | None>] - [-RuleErrorAction <Ignore | RetryThenBlock>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DlpComplianceRuleV2 -Name "SocialSecurityRule" -Policy "USFinancialChecks" -ContentContainsSensitiveInformation @{Name="U.S. Social Security Number (SSN)"} -BlockAccess $True -``` - -This example create a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the existing DLP policy that will contain the DLP rule. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessScope -The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - -- InOrganization: The rule is applied to content that's accessible inside the organization. - -- NotInOrganization: The rule is applied to content that's accessible outside the organization. - -- None: The condition isn't used. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessTimeControl -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivationDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccess -The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccessScope -The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - -- All: Block access to everyone except the owner and the last modifier. - -- PerUser: Block access to external users. - -```yaml -Type: All | PerUser -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. - -This parameter uses the basic syntax @(@{Name="\<SensitiveInformationType1\>";[minCount="\<Value\>"],@{Name="\<SensitiveInformationType2\>";[minCount="\<Value\>"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). - -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see Sensitive information types inventory (https://go.microsoft.com/fwlink/p/?LinkId=529420). - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentPropertyContainsWords -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\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - -- $true: The rule is disabled. - -- $false: The rule is enabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAccessScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentContainsSensitiveInformation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentPropertyContainsWords -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfDocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFrom -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateAlert -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -The email message that's generated by this action contains a link to detailed information in the Security & Compliance Center (the details aren't in the email message itself). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateIncidentReport -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportContent -The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - -- All - -- Default - -- Detections - -- DocumentAuthor - -- DocumentLastModifier - -- MatchedItem - -- RulesMatched - -- Service - -- Severity - -- Service - -- Title - -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: - -- DocumentAuthor - -- MatchedItem - -- RulesMatched - -- Service - -- Title - -Therefore, if you use any of these redundant values with the value Default, they will be ignored. - -```yaml -Type: ReportContentOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyAllowOverride -The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - -- FalsePositive: Allows overrides in the case of false positives. - -- WithoutJustification: Allows overrides without justification. - -- WithJustification: Allows overrides with justification. - -You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. - -```yaml -Type: OverrideOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyEmailCustomText -The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. - -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. - -- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomTextTranslations -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - -- An email address. - -- LastModifier - -- Owner - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportSeverityLevel -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleErrorAction -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Ignore | RetryThenBlock -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ece2e71a-e464-4140-b038-8cf2a2285275.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md deleted file mode 100644 index 3e56d25b21..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpFingerprint -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpFingerprint - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpFingerprint cmdlet to create document fingerprints that are used with data loss prevention (DLP) sensitive information types in the Security & Compliance Center. Because the results of New-DlpFingerprint aren't stored outside of the sensitive information type, you always run New-DlpFingerprint and New-DlpSensitiveInformationType or Set-DlpSensitiveInformationType in the same PowerShell session. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpFingerprint [[-FileData] <Byte[]>] -Description <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte; $Patent_Fingerprint = New-DlpFingerprint -FileData $Patent_Template -Description "Contoso Patent Template" -``` - -This example creates a new document fingerprint based on the file C:\\My Documents\\Contoso Patent Template.docx. You store the new fingerprint as a variable so you can use it with the New-DlpSensitiveInformationType cmdlet in the same PowerShell session. - -## PARAMETERS - -### -Description -The Description parameter specifies a description for the document fingerprint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the file to use as a document fingerprint. - -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For details, see the Examples section in this topic. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b579682a-9922-4db0-b524-bcea0d2cef9b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md deleted file mode 100644 index a25181fecc..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpKeywordDictionary -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpKeywordDictionary - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpKeywordDictionary cmdlet to create data loss prevention (DLP) keyword dictionaries in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpKeywordDictionary -Name <String> [-Confirm] [-Description <String>] [-FileData <Byte[]>] [-WhatIf] - [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo"; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); New-DlpKeywordDictionary -Name "Diseases" -Description "Names of diseases and injuries from ICD-10-CM lexicon" -FileData $EncodedKeywords -``` - -This example creates a DLP keyword dictionary named Diseases by using the specified values. - -### -------------------------- Example 2 -------------------------- -``` -$Terms = Get-Content "C:\My Documents\InappropriateTerms.txt"; $Keywords = $Terms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); New-DlpKeywordDictionary -Name "Inappropriate Language" -Description "Unprofessional and inappropriate terminology" -FileData $EncodedKeywords -``` - -This example creates a DLP keyword dictionary named Inappropriate Language from the file C:\\My Documents\\InappropriateTerms.txt. The file contains one term on each line. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF8. For more information, see the examples in this topic. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0d9a4cd6-f140-4ddb-90c8-bee1db2148e2.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md deleted file mode 100644 index 9261b22d2c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpSensitiveInformationType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpSensitiveInformationType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpSensitiveInformationType cmdlet to create sensitive information type rules that use document fingerprints. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpSensitiveInformationType [-Name] <String> -Description <String> -Fingerprints <MultiValuedProperty> - [-SensitiveInformationTypeRuleCollectionIdentity <SensitiveInformationTypeRuleCollectionIdParameter>] [-Confirm] - [-Locale <CultureInfo>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte -ReadCount 0; $Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template"; $Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte; $Customer_Fingerprint = New-DlpFingerprint -FileData $Customer_Template -Description "Contoso Customer Template"; New-DlpSensitiveInformationType -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint[0],$Customer_Fingerprint[0] -Description "Message contains Contoso employee or customer information." -``` - -This example creates a new sensitive information type rule named "Contoso Employee-Customer Confidential" that uses the document fingerprints of the files C:\\My Documents\\Contoso Employee Template.docx and D:\\Data\\Contoso Customer Template.docx. - -## PARAMETERS - -### -Description -The Description parameter specifies a description for the sensitive information type rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see New-DlpFingerprint or the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. - -The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SensitiveInformationTypeRuleCollectionIdentity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: ClassificationRuleCollectionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter specifies the language that's associated with the sensitive information type rule. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -You can add additional language translations to the sensitive information type rule by using the Set-DlpSensitiveInformationType cmdlet. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3c1e90e7-cf49-4a8b-a0c4-c189ab8ab166.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md deleted file mode 100644 index 8023577ea1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-DlpSensitiveInformationTypeRulePackage - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-DlpSensitiveInformationTypeConfig cmdlet to import data loss prevention (DLP) sensitive information type rule packages in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DlpSensitiveInformationTypeRulePackage [-FileData] <Byte[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -New-DlpSensitiveInformationTypeRulePackage -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Sensitive Info Type Rule Collection.xml" -Encoding Byte -ReadCount 0)) -``` - -This example imports the sensitive information type rule package C:\\My Documents\\External Sensitive Info Type Rule Collection.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the sensitive information type rule package that you want to import. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6a581c6b-e3ac-4c56-ada8-4e66c8891def.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-Fingerprint.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-Fingerprint.md deleted file mode 100644 index 18a2ed2077..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-Fingerprint.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-Fingerprint -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-Fingerprint - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -**Note**: In Exchange Online, this cmdlet has been replaced by the [New-DlpFingerPrint](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-dlp/new-dlpfingerprint) cmdlet in Office 365 Security & Compliance Center PowerShell. - -Use the New-Fingerprint cmdlet to create document fingerprints that are used with data classification rules. Because the results of New-Fingerprint are not stored outside of the data classification rule, you always run New-Fingerprint and New-DataClassification or Set-Dataclassification in the same PowerShell session. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-Fingerprint [[-FileData] <Byte[]>] -Description <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte; $Patent_Fingerprint = New-Fingerprint -FileData $Patent_Template -Description "Contoso Patent Template" -``` - -This example creates a new document fingerprint based on the file C:\\My Documents\\Contoso Patent Template.docx. You store the new fingerprint as a variable so you can use it with the New-DataClassification cmdlet in the same PowerShell session. - -## PARAMETERS - -### -Description -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 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the file to use as a document fingerprint. - -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For details, see the section. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b579682a-9922-4db0-b524-bcea0d2cef9b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md deleted file mode 100644 index 8be908c490..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PolicyTipConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-PolicyTipConfig cmdlet to create custom Policy Tips in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PolicyTipConfig [-Name] <String> -Value <String> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PolicyTipConfig -Name en\NotifyOnly -Value "This message contains content that is restricted by Contoso company policy." -``` - -This example creates a custom Policy Tip with the following settings: - -- Locale: English - -- Action: NotifyOnly - -- Policy Tip text: "This message contains content that is restricted by Contoso company policy." - -### -------------------------- Example 2 -------------------------- -``` -New-PolicyTipConfig Url -Value "http://www.contoso.com/PolicyTipInformation" -``` - -This example sets the informational URL in Policy Tips to the value http://www.contoso.com/PolicyTipInformation. - -## PARAMETERS - -### -Name -The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: - -- \<Locale\>\\\<Action\>: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - -- Url - -There can be only one custom Policy Tip with the value Url for the Name parameter. For the remaining Policy Tip actions, there can be only one custom Policy Tip for each combination of locale and action. For example, there can be only one custom Policy Tip with the Name value en\\NotifyOnly, but you can create additional custom Policy Tips with the values de\\NotifyOnly and fr\\NotifyOnly for the Name parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0882bc55-0297-4d22-a141-1eb7187f5ea2.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DataClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DataClassification.md deleted file mode 100644 index 0c17fecb54..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DataClassification.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DataClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-DataClassification - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -In Exchange Online, this cmdlet has been replaced by the [Remove-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-dlp/remove-dlpsensitiveinformationtype) cmdlet in Office 365 Security & Compliance Center PowerShell. - -Use the Remove-DataClassification cmdlet to remove data classification rules that use document fingerprints. You can't use this cmdlet to remove built-in data classification rules. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DataClassification [-Identity] <DataClassificationIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DataClassification "Contoso Confidential" -``` - -This example removes the data classification rule named "Contoso Confidential". - -## PARAMETERS - -### -Identity -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 - -- LocalizedName - -- Identity GUID value - -```yaml -Type: DataClassificationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/52a9908f-1814-4a64-ba74-a6fdcaf0d1a1.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md deleted file mode 100644 index 2c8e5bdd4e..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DlpCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DlpCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DlpCompliancePolicy cmdlet to remove Data Loss Prevention (DLP) policies from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpCompliancePolicy [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpCompliancePolicy -Identity 7e640345-1a7f-4f4e-9c17-681c070ed5e2 -``` - -This example removes a DLP policy specified by its GUID. - -### -------------------------- Example 2 -------------------------- -``` -Remove-DlpCompliancePolicy -Identity "PII Main Policy" -``` - -This example removes a DLP policy specified by its name. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ec054c7f-f5b9-44b9-91e6-674bfc5b845c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md deleted file mode 100644 index db5d30ad3d..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DlpComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DlpComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DlpComplianceRule cmdlet to remove Data Loss Prevention (DLP) rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpComplianceRule [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpComplianceRule -Identity "PII SS# Custom" -``` - -This example removes the DLP rule named "PII SS# Custom". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1e09f210-e067-4455-a0ed-852bb4a87dec.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md deleted file mode 100644 index 235b78bed5..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DlpComplianceRuleV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DlpComplianceRuleV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DlpComplianceRuleV2 cmdlet to remove Data Loss Prevention (DLP) rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpComplianceRuleV2 [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpComplianceRuleV2 -Identity "PII SS# Custom" -``` - -This example removes the DLP rule named "PII SS# Custom". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a4d5a6c0-f042-4d3a-a519-6f8c766ca99f.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md deleted file mode 100644 index a092aec78b..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DlpKeywordDictionary -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DlpKeywordDictionary - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DlpKeywordDictionary cmdlet to remove data loss prevention (DLP) keyword dictionaries from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpKeywordDictionary [-Identity] <SensitiveInformationTypeIdParameter> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpKeywordDictionary -Identity "Financial Data" -``` - -This example remove the DLP keyword dictionary named Financial Data. - -## PARAMETERS - -### -Identity -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/525e3c6d-a315-4f0b-88f6-5704eb09e31c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md deleted file mode 100644 index 62f4247b8e..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-DlpPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-DlpPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-DlpPolicy cmdlet to remove an existing data loss prevention (DLP) policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpPolicy [-Identity] <DlpPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpPolicy "Contoso PII" -``` - -This example removes the existing DLP policy named Contoso PII. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the DLP policy you want to remove. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. - -```yaml -Type: DlpPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3631df19-fe68-44f6-9e91-4363e608263b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md deleted file mode 100644 index b0bd9b06cf..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DlpPolicyTemplate -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-DlpPolicyTemplate - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-DlpPolicyTemplate cmdlet to remove a data loss prevention (DLP) policy template from your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpPolicyTemplate [[-Identity] <DlpPolicyIdParameter>] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpPolicyTemplate "External DLP Policy Template" -``` - -This example removes the DLP policy template named External DLP Policy Template. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -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 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b247f29c-868e-4a4e-a6ad-626715dbf2fc.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md deleted file mode 100644 index ce39806793..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DlpSensitiveInformationType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DlpSensitiveInformationType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DlpSensitiveInformationType cmdlet to remove sensitive information type rules that use document fingerprints. You can't use this cmdlet to remove built-in sensitive information type rules. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpSensitiveInformationType [-Identity] <DataClassificationIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DlpSensitiveInformationType "Contoso Confidential" -``` - -This example removes the sensitive information type rule named "Contoso Confidential". - -## PARAMETERS - -### -Identity -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 - -- LocalizedName - -- Identity GUID value - -```yaml -Type: DataClassificationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/52a9908f-1814-4a64-ba74-a6fdcaf0d1a1.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md deleted file mode 100644 index dbe1040bc7..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-DlpSensitiveInformationTypeRulePackage - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-DlpSensitiveInformationTypeConfig cmdlet to remove data loss prevention (DLP) sensitive information type rule packages from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DlpSensitiveInformationTypeRulePackage [-Identity] <SensitiveInformationTypeRuleCollectionIdParameter> - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$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. - -## PARAMETERS - -### -Identity -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 - -- LocalizedName - -- GUID (from the Identity value) - -```yaml -Type: SensitiveInformationTypeRuleCollectionIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b908e2ed-88ef-4259-a06b-499ad08c7498.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md deleted file mode 100644 index 663f474f19..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PolicyTipConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-PolicyTipConfig cmdlet to remove custom data loss prevention (DLP) Policy Tips from your organization. You can't remove built-in Policy Tips. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-PolicyTipConfig [-Identity] <PolicyTipConfigIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PolicyTipConfig en\NotifyOnly -``` - -This example removes the custom English Policy Tip for the action value NotifyOnly. - -### -------------------------- Example 2 -------------------------- -``` -Get-PolicyTipConfig -Locale ru | Remove-PolicyTipConfig -``` - -This example removes all the custom Russian Policy Tips. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: - -- \<Locale\>\\\<Action\>: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - -- The value Url - -- GUID - -- Distinguished name (DN) - -```yaml -Type: PolicyTipConfigIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4487f346-1e42-41d9-9fd1-c741cc54ea41.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md deleted file mode 100644 index e8b81275cf..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ClassificationRuleCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-ClassificationRuleCollection cmdlet to update existing classification rule collections in your organization. - -In the Office 365 Security & Compliance Center, use the Set-DlpSensitiveInformationTypeRulePackage cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ClassificationRuleCollection [-FileData] <Byte[]> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ClassificationRuleCollection -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Classification Rule Collection.xml" -Encoding Byte -ReadCount 0)) -``` - -This example imports the classification rule collection file C:\\My Documents\\External Classification Rule Collection.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the classification rule collection file you want to import. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d0058d0e-7f9c-4dba-b358-fb9adf21c1e3.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DataClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DataClassification.md deleted file mode 100644 index 1f099a1135..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DataClassification.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DataClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-DataClassification - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -In Exchange Online, this cmdlet has been replaced by the [Set-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-dlp/set-dlpsensitiveinformationtype) cmdlet in Office 365 Security & Compliance Center PowerShell. - -Use the Set-DataClassification cmdlet to modify data classification rules that use document fingerprints. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DataClassification [-Identity] <DataClassificationIdParameter> [-Confirm] [-Description <String>] - [-DomainController <Fqdn>] [-Fingerprints <MultiValuedProperty>] [-IsDefault] [-Locale <CultureInfo>] - [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DataClassification "Contoso Confidential" -Locale fr -Name "Contoso Confidentiel" -Description "Ce message contient des informations confidentielles." -IsDefault -``` - -This example adds a French translation to the existing data classification rule named "Contoso Confidential", and sets this French translation as the default. - -### -------------------------- Example 2 -------------------------- -``` -Set-DataClassification "Contoso Confidential" -Locale es -Name $null -Description $null -``` - -This example removes the existing Spanish translation from the data classification rule named "Contoso Confidential". - -### -------------------------- Example 3 -------------------------- -``` -$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte; $Benefits_Fingerprint = New-Fingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template"; $Contoso_Confidential = Get-DataClassification "Contoso Confidential"; $Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints); $Array.Add($Benefits_FingerPrint); Set-DataClassification $Contoso_Confidential.Identity -FingerPrints $Array -``` - -This example modifies the existing data classification rule named "Contoso Confidential" by adding a new document fingerprint for the file C:\\My Documents\\Contoso Benefits Template.docx without affecting any existing document fingerprints that are already defined. - -### -------------------------- Example 4 -------------------------- -``` -$cc = Get-DataClassification "Contoso Confidential"; $a = [System.Collections.ArrayList]($cc.Fingerprints); $a; $a.RemoveAt(0); Set-DataClassification $cc.Identity -FingerPrints $a -``` - -This example modifies the data classification rule named "Contoso Confidential" by removing an existing document fingerprint without affecting other document fingerprints that are already defined. - -The first three commands return the list of document fingerprints in the data classification. The first document fingerprint in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the document fingerprint that you want to remove. The last two commands remove the first document fingerprint that's displayed in the list. - -## PARAMETERS - -### -Identity -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 - -- LocalizedName - -- Identity GUID value - -```yaml -Type: DataClassificationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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 -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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -The IsDefault switch is used with the Locale parameter to specify the default language for the data classification rule. The default Locale value is stored in the DefaultCulture property. - -When you change the default Locale value, the Name value of the data classification rule changes to match the Name value that's associated with the new default locale. The original Name value when the rule was created is permanently stored the LocalizedName property. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter adds or removes languages that are associated with the data classification rule. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -Typically, you use the Locale parameter with the Name and Description parameters to add or remove translated names and descriptions for the data classification rule. You can also use the Locale parameter with the IsDefault switch to designate an existing translated name and description as the default. Before you can remove the default translation, you need to set another translation as the default. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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. - -The value of the Name parameter is used in the Policy Tip that's presented to users in Outlook on the web. When a translated value of the Name parameter matches the client's language, the Policy Tip is displayed in the client's language. If no translated values of the Name parameter match the client's language, the default translation that's specified by the IsDefault parameter is used for the Policy Tip. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d40df36-18c7-46f5-b373-69c840a5599b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md deleted file mode 100644 index 09d9c6708a..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md +++ /dev/null @@ -1,393 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DlpCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DlpCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DlpCompliancePolicy cmdlet to modify Data Loss Prevention (DLP) policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-DlpCompliancePolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-DlpCompliancePolicy [-Identity] <PolicyIdParameter> - [-AddExchangeLocation <MultiValuedProperty>] - [-AddOneDriveLocation <MultiValuedProperty>] - [-AddOneDriveLocationException <MultiValuedProperty>] - [-AddSharePointLocation <MultiValuedProperty>] - [-AddSharePointLocationException <MultiValuedProperty>] - [-Comment <String>] - [-Confirm] - [-Force] - [-Mode <Enable | TestWithNotifications | TestWithoutNotifications | Disable | PendingDeletion>] - [-RemoveExchangeLocation <MultiValuedProperty>] - [-RemoveOneDriveLocation <MultiValuedProperty>] - [-RemoveOneDriveLocationException <MultiValuedProperty>] - [-RemoveSharePointLocation <MultiValuedProperty>] - [-RemoveSharePointLocationException <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -### -------------------------- Example 2 -------------------------- -``` -Set-DlpCompliancePolicy -Identity MainPII -Mode Disable -``` - -This example disables the "MainPII" policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RetryDistribution -The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddExchangeLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -SharePoint Online sites can't be added to the policy until they have been indexed. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: - -- Enable: The policy is enabled for actions and notifications. This is the default value. - -- Disable: The policy is disabled. - -- TestWithNotifications: No actions are taken, but notifications are sent. - -- TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent. - -```yaml -Type: Enable | TestWithNotifications | TestWithoutNotifications | Disable | PendingDeletion -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d62d4466-5a16-4206-8105-aed442b6fa9e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md deleted file mode 100644 index dba7025761..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md +++ /dev/null @@ -1,723 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DlpComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DlpComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DlpComplianceRule to modify Data Loss Prevention (DLP) rules in the Security & Compliance Center. DLP rules define sensitive information to be protected and the actions to take on rule violations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DlpComplianceRule [-Identity] <ComplianceRuleIdParameter> - [-AccessScope <InOrganization | NotInOrganization | None>] [-AccessTimeControl <PswsHashtable>] - [-ActivationDate <DateTime>] [-BlockAccess <$true | $false>] [-BlockAccessScope <$true | $false>] - [-Comment <String>] [-Confirm] [-ContentContainsSensitiveInformation <PswsHashtable[]>] - [-ContentPropertyContainsWords <MultiValuedProperty>] - [-Disabled <$true | $false>] [-DocumentIsUnsupported <$true | $false>] - [-ExceptIfAccessScope <InOrganization | NotInOrganization | None>] - [-ExceptIfContentContainsSensitiveInformation <PswsHashtable[]>] - [-ExceptIfContentPropertyContainsWords <MultiValuedProperty>] - [-ExceptIfDocumentIsUnsupported <$true | $false>] [-ExceptIfFrom <SmtpAddress[]>] - [-ExceptIfFromMemberOf <SmtpAddress[]>] [-ExceptIfProcessingLimitExceeded <$true | $false>] - [-ExpiryDate <DateTime>] [-From <SmtpAddress[]>] [-FromMemberOf <SmtpAddress[]>] - [-GenerateAlert <MultiValuedProperty>] [-GenerateIncidentReport <MultiValuedProperty>] - [-IncidentReportContent <ReportContentOption[]>] [-Name <String>] [-NotifyAllowOverride <OverrideOption[]>] - [-NotifyEmailCustomText <String>] [-NotifyPolicyTipCustomText <String>] - [-NotifyPolicyTipCustomTextTranslations <MultiValuedProperty>] [-NotifyUser <MultiValuedProperty>] - [-ProcessingLimitExceeded <$true | $false>] [-ReportSeverityLevel <Low | Medium | High | None>] - [-RuleErrorAction <Ignore | RetryThenBlock>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DlpComplianceRule -Identity 25bf67b6-3783-4f74-bde9-98dd40333082 -AccessScope NotInOrganization -BlockAccess $true -``` - -This example modifies the access scope and blocking behavior of a DLP compliance rule that's identified by its GUID value. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AccessScope -The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - -- InOrganization: The rule is applied to content that's accessible inside the organization. - -- NotInOrganization: The rule is applied to content that's accessible outside the organization. - -- None: The condition isn't used. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessTimeControl -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivationDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccess -The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccessScope -The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - -- All: Block access to everyone except the owner and the last modifier. - -- PerUser: Block access to external users. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. - -This parameter uses the basic syntax @(@{Name="\<SensitiveInformationType1\>";[minCount="\<Value\>"],@{Name="\<SensitiveInformationType2\>";[minCount="\<Value\>"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). - -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see Sensitive information types inventory (https://go.microsoft.com/fwlink/p/?LinkId=529420). - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentPropertyContainsWords -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\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - -- $true: The rule is disabled. - -- $false: The rule is enabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAccessScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentContainsSensitiveInformation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentPropertyContainsWords -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfDocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFrom -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateAlert -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -The email message that's generated by this action contains a link to detailed information in the Security & Compliance Center (the details aren't in the email message itself). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateIncidentReport -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportContent -The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - -- All - -- Default - -- Detections - -- DocumentAuthor - -- DocumentLastModifier - -- MatchedItem - -- RulesMatched - -- Service - -- Severity - -- Service - -- Title - -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: - -- DocumentAuthor - -- MatchedItem - -- RulesMatched - -- Service - -- Title - -Therefore, if you use any of these redundant values with the value Default, they will be ignored. - -```yaml -Type: ReportContentOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyAllowOverride -The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - -- FalsePositive: Allows overrides in the case of false positives. - -- WithoutJustification: Allows overrides without justification. - -- WithJustification: Allows overrides with justification. - -You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. - -```yaml -Type: OverrideOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyEmailCustomText -The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. - -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. - -- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomTextTranslations -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - -- An email address. - -- LastModifier - -- Owner - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportSeverityLevel -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. - -- Medium - -- High - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleErrorAction -The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - -- Ignore - -- RetryThenBlock - -- Blank (the value $null): This is the default value. - -```yaml -Type: Ignore | RetryThenBlock -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7c819665-e1cb-4097-90b7-2530bea69c1c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md deleted file mode 100644 index 8320518f29..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md +++ /dev/null @@ -1,708 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DlpComplianceRuleV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DlpComplianceRuleV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DlpComplianceRuleV2 to modify Data Loss Prevention (DLP) rules in the Security & Compliance Center. DLP rules define sensitive information to be protected and the actions to take on rule violations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DlpComplianceRuleV2 [-Identity] <ComplianceRuleIdParameter> - [-AccessScope <InOrganization | NotInOrganization | None>] [-AccessTimeControl <PswsHashtable>] - [-ActivationDate <DateTime>] [-BlockAccess <$true | $false>] [-BlockAccessScope <All | PerUser>] - [-Comment <String>] [-Confirm] [-ContentContainsSensitiveInformation <PswsHashtable[]>] - [-ContentPropertyContainsWords <MultiValuedProperty>] [-Disabled <$true | $false>] - [-DocumentIsUnsupported <$true | $false>] [-ExceptIfAccessScope <InOrganization | NotInOrganization | None>] - [-ExceptIfContentContainsSensitiveInformation <PswsHashtable[]>] - [-ExceptIfContentPropertyContainsWords <MultiValuedProperty>] - [-ExceptIfDocumentIsUnsupported <$true | $false>] [-ExceptIfFrom <SmtpAddress[]>] - [-ExceptIfFromMemberOf <SmtpAddress[]>] [-ExceptIfProcessingLimitExceeded <$true | $false>] - [-ExpiryDate <DateTime>] [-From <SmtpAddress[]>] [-FromMemberOf <SmtpAddress[]>] - [-GenerateAlert <MultiValuedProperty>] [-GenerateIncidentReport <MultiValuedProperty>] - [-IncidentReportContent <ReportContentOption[]>] [-Name <String>] [-NotifyAllowOverride <OverrideOption[]>] - [-NotifyEmailCustomText <String>] [-NotifyPolicyTipCustomText <String>] - [-NotifyPolicyTipCustomTextTranslations <MultiValuedProperty>] [-NotifyUser <MultiValuedProperty>] - [-ProcessingLimitExceeded <$true | $false>] [-ReportSeverityLevel <Low | Medium | High | None>] - [-RuleErrorAction <Ignore | RetryThenBlock>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DlpComplianceRuleV2 -Identity 25bf67b6-3783-4f74-bde9-98dd40333082 -AccessScope NotInOrganization -BlockAccess $true -``` - -This example modifies the access scope and blocking behavior of a DLP compliance rule that's identified by its GUID value. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -- Id - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AccessScope -The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - -- InOrganization: The rule is applied to content that's accessible inside the organization. - -- NotInOrganization: The rule is applied to content that's accessible outside the organization. - -- None: The condition isn't used. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessTimeControl -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivationDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccess -The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockAccessScope -The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - -- All: Block access to everyone except the owner and the last modifier. - -- PerUser: Block access to external users. - -```yaml -Type: All | PerUser -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. - -This parameter uses the basic syntax @(@{Name="\<SensitiveInformationType1\>";[minCount="\<Value\>"],@{Name="\<SensitiveInformationType2\>";[minCount="\<Value\>"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). - -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see Sensitive information types inventory (https://go.microsoft.com/fwlink/p/?LinkId=529420). - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentPropertyContainsWords -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\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - -- $true: The rule is disabled. - -- $false: The rule is enabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAccessScope -This parameter is reserved for internal Microsoft use. - -```yaml -Type: InOrganization | NotInOrganization | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentContainsSensitiveInformation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentPropertyContainsWords -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfDocumentIsUnsupported -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFrom -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromMemberOf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateAlert -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -The email message that's generated by this action contains a link to detailed information in the Security & Compliance Center (the details aren't in the email message itself). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateIncidentReport -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. - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportContent -The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - -- All - -- Default - -- Detections - -- DocumentAuthor - -- DocumentLastModifier - -- MatchedItem - -- RulesMatched - -- Service - -- Severity - -- Service - -- Title - -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: - -- DocumentAuthor - -- MatchedItem - -- RulesMatched - -- Service - -- Title - -Therefore, if you use any of these redundant values with the value Default, they will be ignored. - -```yaml -Type: ReportContentOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyAllowOverride -The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - -- FalsePositive: Allows overrides in the case of false positives. - -- WithoutJustification: Allows overrides without justification. - -- WithJustification: Allows overrides with justification. - -You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. - -```yaml -Type: OverrideOption[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyEmailCustomText -The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. - -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. - -- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyPolicyTipCustomTextTranslations -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - -- An email address. - -- LastModifier - -- Owner - -- SiteAdmin - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessingLimitExceeded -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportSeverityLevel -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleErrorAction -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Ignore | RetryThenBlock -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2ad9af88-a8c9-460e-9d1e-af23bd5b7ca7.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md deleted file mode 100644 index e7e0b5c0c9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DlpKeywordDictionary -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DlpKeywordDictionary - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DlpKeywordDictionary cmdlet to modify data loss prevention (DLP) keyword dictionaries in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DlpKeywordDictionary [-Identity] <SensitiveInformationTypeIdParameter> [-Confirm] [-Description <String>] - [-FileData <Byte[]>] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo"; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($keywords); Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords -``` - -This example replaces the existing terms in the DLP keyword dictionary named Diseases with the specified values. - -### -------------------------- Example 2 -------------------------- -``` -$Dictionary = Get-DlpKeywordDictionary -Name "Diseases"; $Terms = $Dictionary.KeywordDictionary.split(',').trim(); $Terms += "Achylia","Acidemia","Acidocytopenia","Acidocytosis","Acidopenia","Acidosis","Aciduria","Acladiosis","Aclasis"; $Keywords = $Terms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords -``` - -This example adds the specified terms to the DLP keyword dictionary named Diseases without affecting other existing terms. - -### -------------------------- Example 3 -------------------------- -``` -$Dictionary = Get-DlpKeywordDictionary -Name "Diseases"; $Terms = $Dictionary.KeywordDictionary.split(',').trim(); $TermsToRemove = @('abandonment', 'ablatio'); $UpdatedTerms = $Terms | Where-Object {$_ -NotIn $TermsToRemove}; $Keywords = $UpdatedTerms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords -``` - -This example removes the specified terms from the DLP keyword dictionary named Diseases without affecting other existing terms. - -### -------------------------- Example 4 -------------------------- -``` -$Dictionary = Get-DlpKeywordDictionary -Name "Inappropriate Language"; $Terms = $Dictionary.KeywordDictionary.split(',').trim(); Set-Content $Terms -Path "C:\My Documents\InappropriateTerms.txt"; $UpdatedTerms = Get-Content -Path "C:\My Documents\InappropriateTerms.txt"; $Keywords = $UpdatedTerms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywords -``` - -The first three commands export the terms from the existing keyword dictionary named Inappropriate Language to the file C:\\My Documents\\InappropriateTerms.txt, where each term is on a separate line. - -After you use Notepad to modify the terms and save the file, the last four commands use the file to replace the terms in the keyword dictionary. - -## PARAMETERS - -### -Identity -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF8. For more information, see the examples in this topic. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b1a010ed-ebfe-4300-97b7-5fc55f21169a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md deleted file mode 100644 index 5af2611eba..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-DlpPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-DlpPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-DlpPolicy cmdlet to modify data loss prevention (DLP) policies in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DlpPolicy [-Identity] <DlpPolicyIdParameter> [-Confirm] [-Description <String>] [-DomainController <Fqdn>] - [-Mode <Audit | AuditAndNotify | Enforce>] [-Name <String>] [-State <Enabled | Disabled>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DlpPolicy "Employee Numbers" -State Disabled -``` - -This example disables the DLP policy named Employee Numbers. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the DLP policy you want to modify. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. - -```yaml -Type: DlpPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -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 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The Mode parameter specifies the action and notification level of the DLP policy. Valid values 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. - -- AuditAndNotify: When a message matches the conditions specified by the DLP policy, the actions specified by the policy aren't enforced, but notification emails are sent. - -- Enforce: When a message matches the conditions specified by the DLP policy, the actions specified by the policy are enforced and notification emails are sent. - -If the State parameter is set to Disabled, the value of the Mode parameter is irrelevant. - -```yaml -Type: Audit | AuditAndNotify | Enforce -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f44e276c-b9cb-4bfc-a815-ab866446ffdd.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md deleted file mode 100644 index 70343be8ce..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DlpSensitiveInformationType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# 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. - -Use the Set-DlpSensitiveInformationType cmdlet to modify sensitive information type rules that use document fingerprints. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DlpSensitiveInformationType [-Identity] <SensitiveInformationTypeIdParameter> [-Confirm] [-Description <String>] - [-DomainController <Fqdn>] [-Fingerprints <MultiValuedProperty>] [-IsDefault] [-Locale <CultureInfo>] - [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DlpSensitiveInformationType "Contoso Confidential" -Locale fr -Name "Contoso Confidentiel" -Description "Ce message contient des informations confidentielles." -IsDefault -``` - -This example adds a French translation to the existing sensitive information type rule named "Contoso Confidential", and sets this French translation as the default. - -### -------------------------- Example 2 -------------------------- -``` -Set-DlpSensitiveInformationType "Contoso Confidential" -Locale es -Name $null -Description $null -``` - -This example removes the existing Spanish translation from the sensitive information type rule named "Contoso Confidential". - -### -------------------------- Example 3 -------------------------- -``` -$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte -ReadCount 0; $Benefits_Fingerprint = New-DlpFingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template"; $Contoso_Confidential = Get-DlpSensitiveInformationType "Contoso Confidential"; $Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints); $Array.Add($Benefits_FingerPrint[0]); Set-DlpSensitiveInformationType $Contoso_Confidential.Identity -FingerPrints $Array -``` - -This example modifies the existing sensitive information type rule named "Contoso Confidential" by adding a new document fingerprint for the file C:\\My Documents\\Contoso Benefits Template.docx without affecting any existing document fingerprints that are already defined. - -### -------------------------- Example 4 -------------------------- -``` -$cc = Get-DlpSensitiveInformationType "Contoso Confidential"; $a = [System.Collections.ArrayList]($cc.Fingerprints); $a; $a.RemoveAt(0); Set-DlpSensitiveInformationType $cc.Identity -FingerPrints $a -``` - -This example modifies the sensitive information type rule named "Contoso Confidential" by removing an existing document fingerprint without affecting other document fingerprints that are already defined. - -The first three commands return the list of document fingerprints in the sensitive information type. The first document fingerprint in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the document fingerprint that you want to remove. The last two commands remove the first document fingerprint that's displayed in the list. - -## PARAMETERS - -### -Identity -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 - -- LocalizedName - -- Identity GUID value - -```yaml -Type: SensitiveInformationTypeIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see New-DlpFingerprint 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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -The IsDefault switch is used with the Locale parameter to specify the default language for the sensitive information type rule. The default Locale value is stored in the DefaultCulture property. - -When you change the default Locale value, the Name value of the sensitive information type rule changes to match the Name value that's associated with the new default locale. The original Name value when the rule was created is permanently stored the LocalizedName property. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter adds or removes languages that are associated with the sensitive information type rule. - -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://go.microsoft.com/fwlink/p/?linkId=184859). - -Typically, you use the Locale parameter with the Name and Description parameters to add or remove translated names and descriptions for the sensitive information type rule. You can also use the Locale parameter with the IsDefault switch to designate an existing translated name and description as the default. Before you can remove the default translation, you need to set another translation as the default. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. - -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. - -The value of the Name parameter is used in the Policy Tip that's presented to users in Outlook on the web. When a translated value of the Name parameter matches the client's language, the Policy Tip is displayed in the client's language. If no translated values of the Name parameter match the client's language, the default translation that's specified by the IsDefault parameter is used for the Policy Tip. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6d40df36-18c7-46f5-b373-69c840a5599b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md deleted file mode 100644 index 0915583a18..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-DlpSensitiveInformationTypeRulePackage - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-DlpSensitiveInformationTypeRulePackage cmdlet to update existing data loss prevention (DLP) sensitive information type rule packages in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DlpSensitiveInformationTypeRulePackage [-FileData] <Byte[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DlpSensitiveInformationTypeRulePackage -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Sensitive Info Type Rule Collection.xml" -Encoding Byte -ReadCount 0)) -``` - -This example imports the sensitive information type rule package C:\\My Documents\\External Sensitive Info Type Rule Collection.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the sensitive information type rule package that you want to import. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0a3f71cf-7799-4e39-9209-6a38aefd6d06.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md b/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md deleted file mode 100644 index 6fa1f7a954..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-PolicyTipConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-PolicyTipConfig cmdlet to modify custom Policy Tips in your organization. You can't modify built-in Policy Tips. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-PolicyTipConfig [-Identity] <PolicyTipConfigIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Value <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-PolicyTipConfig en\NotifyOnly "This message contains content that is restricted by Contoso company policy." -``` - -This example modifies the custom English Policy Tip with the action value NotifyOnly. The text of this custom Policy Tip is changed to the following value: "This message contains content that is restricted by Contoso company policy." - -### -------------------------- Example 2 -------------------------- -``` -Get-PolicyTipConfig -Locale es | Set-PolicyTipConfig -Value "Este mensaje contiene contenido que está restringida por la política de Contoso." -``` - -This example replaces the text of all custom Spanish Policy Tips with the value, "Este mensaje contiene contenido que está restringida por la política de Contoso." - -## PARAMETERS - -### -Identity -The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: - -- \<Locale\>\\\<Action\>: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://technet.microsoft.com/library/aa996803.aspx#NDRLanguages). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - -- The value Url - -- GUID - -- Distinguished name (DN) - -```yaml -Type: PolicyTipConfigIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1c643de6-e485-4f42-a202-40960764faeb.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md deleted file mode 100644 index ebe0b3b4dd..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Add-ComplianceCaseMember -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Add-ComplianceCaseMember - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Add-ComplianceCaseMember cmdlet to add an individual member to an eDiscovery case in the Security & Compliance Center. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-ComplianceCaseMember [-Case] <String> -Member <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You use eDiscovery cases to control who can create, access, and manage compliance searches in your organization. You use the New-ComplianceCase cmdlet to create eDiscovery cases. The eDiscovery Manager who created the case is automatically added as a member of the case. - -To add a member of an eDiscovery case, the user needs to be a member of the Reviewer or eDiscovery Manager role groups. When a member of the eDiscovery Manager role group is a member of an eDiscovery case, the user can: - -- Add and remove case members. - -- Create and edit compliance searches associated with a case. - -- Perform compliance actions (for example, export) on the results of a compliance search. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-ComplianceCaseMember -Case "Case 2112" -Member johnevans@contoso.com -``` - -This example adds John Evans to the eDiscovery case named Case 2112. - -## PARAMETERS - -### -Case -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Member -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ebb6a18d-6a8a-49ad-92b9-bdb582cd6fb0.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md deleted file mode 100644 index bc60dd1a26..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Add-eDiscoveryCaseAdmin -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Add-eDiscoveryCaseAdmin - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Add-eDiscoveryCaseAdmin cmdlet to add an eDiscovery Administrator in the Security & Compliance Center. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-eDiscoveryCaseAdmin -User <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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, the user must be assigned the Case Management role. By default, this role is assigned to the Organization Management and eDiscovery Manager role groups. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-eDiscoveryCaseAdmin -User michelle@contoso.com -``` - -This example adds an eDiscovery Administrator. - -## PARAMETERS - -### -User -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ffa9ff06-96da-43e2-997f-c0c49fbcdf4d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md deleted file mode 100644 index 7e66bffe01..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-CaseHoldPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-CaseHoldPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-CaseHoldPolicy to view existing case hold policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CaseHoldPolicy [[-Identity] <PolicyIdParameter>] [-Case <String>] [-DistributionDetail] [-IncludeBindings] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CaseHoldPolicy -Case "Contoso Legal" -``` - -This example displays detailed information for the policy that's associated with the eDiscovery case named Contoso Legal. - -### -------------------------- Example 2 -------------------------- -``` -Get-CaseHoldPolicy -Identity "Regulation 123 Compliance" -``` - -This example displays detailed information for the policy named "Regulation 123 Compliance". - -## PARAMETERS - -### -Case -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 - -- Identity (GUID value). - -You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionDetail -The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeBindings -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ea8d4be5-bb31-4db3-a49e-08861561f402.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md deleted file mode 100644 index 6d63c202c4..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-CaseHoldRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-CaseHoldRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-CaseHoldRule to view case hold rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CaseHoldRule [[-Identity] <ComplianceRuleIdParameter>] [-Policy <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CaseHoldRule -Identity "30 Day Rule" -``` - -This example displays detailed information for the case hold rule named "30 Day Rule". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -You can use this parameter with the Identity parameter in the same command. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/54cf2ae2-5bde-4630-a4cc-3e730b0d5a41.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md deleted file mode 100644 index e714e7f8a9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ComplianceCase -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ComplianceCase - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceCase cmdlet to view eDiscovery cases and DSR (data subject request) cases in the Security & Compliance Center. You use eDiscovery cases to control who can create, access, and manage compliance searches in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceCase [-Identity] <ComplianceCaseIdParameter>] [-CaseType <eDiscovery | DSR>] [-DomainController <Fqdn>] [-RoleGroup <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceCase -``` - -This example returns a summary list of all eDiscovery cases in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceCase -Identity "Contoso Legal" | Format-List -``` - -This example returns detailed information for the eDiscovery case named Contoso Legal. - -## PARAMETERS - -### -CaseType -The CaseType parameter specifies the type of eDiscovery case that you want to view. Valid values are: - -- eDiscovery: eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, eDiscovery cases are displayed under Search & investigation \> eDiscovery. This is the default value. - -- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Security & Compliance Center, DSR cases are displayed under Data privacy \> DSR cases. - -```yaml -Type: eDiscovery | DSR -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: eDiscovery -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the eDiscovery case that you want to view. You can use any value that uniquely identifies the eDiscovery case. For example: - -- Name - -- Identity (GUID value) - -```yaml -Type: ComplianceCaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RoleGroup -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/899cba6c-7709-4861-8f5f-e1c9d614d5c5.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md deleted file mode 100644 index 1a544bb6f0..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ComplianceCaseMember -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ComplianceCaseMember - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceCaseMember cmdlet to view the members of eDiscovery cases in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceCaseMember -Case <String> [-DomainController <Fqdn>] [-ResultSize <Unlimited>] [-ShowCaseAdmin] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceCaseMember -Case "Fabrikam Litigation" -``` - -This examples shows the members of the eDiscovery case named Fabrikam Litigation. - -## PARAMETERS - -### -Case -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: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowCaseAdmin -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: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/385f31c1-2d3a-4c8b-870c-6cd645c12745.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md deleted file mode 100644 index 5730ff2763..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-eDiscoveryCaseAdmin -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-eDiscoveryCaseAdmin - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-eDiscoveryCaseAdmin cmdlet to view eDiscovery Administrators in the Security & Compliance Center. An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-eDiscoveryCaseAdmin [-DomainController <Fqdn>] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-eDiscoveryCaseAdmin -``` - -This example returns a summary list of all eDiscovery Administrators. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/08a3674b-9f9d-4633-82bf-9b78d2a18ae6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md deleted file mode 100644 index 7273e83db2..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-CaseHoldPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-CaseHoldPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-CaseHoldPolicy cmdlet to create new case hold policies in the Security & Compliance Center. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-CaseHoldPolicy [-Name] <String> -Case <String> [-Comment <String>] [-Confirm] [-Enabled <$true | $false>] - [-ExchangeLocation <MultiValuedProperty>] [-Force] [-PublicFolderLocation <MultiValuedProperty>] - [-SharePointLocation <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CaseHoldPolicy -Name "Regulation 123 Compliance" -Case "123 Compliance Case" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "http://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". - -Remember, after you create the policy, you need to create a rule for the policy by using the New-CaseHoldRule cmdlet. - -## PARAMETERS - -### -Case -The Case parameter specifies the eDiscovery case that you want to associate with the case hold policy. You can use the following values to identify the eDiscovery case: - -- Name - -- Identity (GUID value). - -You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocation -The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If no mailboxes are specified, then no mailboxes are placed on hold. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocation -The PublicFolderLocation parameter specifies that you want to include all public folders in the case hold policy. You use the value All for this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/22daa8d4-9800-4b64-a085-95fac12df5b0.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md deleted file mode 100644 index 7186a7f819..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-CaseHoldRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-CaseHoldRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-CaseHoldRule cmdlet to create new case hold rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-CaseHoldRule [-Name] <String> -Policy <PolicyIdParameter> [-Comment <String>] [-Confirm] [-ContentMatchQuery <String>] [-Disabled <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to add the case hold rule to an existing case hold policy using the Policy parameter. Only one rule can be added to each case hold policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CaseHoldRule -Name "2016 Budget Spreadsheets" -Policy "Internal Company Policy" -ContentMatchQuery "filename:2016 budget filetype:xlsx" -``` - -This example creates a new case hold rule named 2016 Budget Spreadsheets and adds it to the existing case hold policy named "Internal Company Policy". The rule applies to Excel worksheets that contain the phrase 2016 budget, such as "2016 budget planning.xlsx" and "2016 budget review.xlsx" - -### -------------------------- Example 2 -------------------------- -``` -New-CaseHoldRule -Name "Contoso Case 07172018 Hold 1" -Policy "Contoso Case 07172018" -ContentMatchQuery "received:12/01/2016..12/31/2018" -``` - -This example places email messages received by the recipients between December 1, 2016 and December 31, 2018 on hold. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the case holdpolicy that contains the rule. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. Use this parameter to create a query-based hold so only the content that matches the specified search query is placed on hold. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f477b3fe-a293-4803-9af5-ae451b24057f.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md deleted file mode 100644 index 02dbaab618..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ComplianceCase -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ComplianceCase - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ComplianceCase cmdlet to create eDiscovery cases in the Security & Compliance Center. You use eDiscovery cases to place content locations on hold, perform Content Searches associated with the case, and export search results. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ComplianceCase [-Name] <String> [-Confirm] [-Description <String>] [-DomainController <Fqdn>] - [-Sources <Object[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ComplianceCase -Name "Fabrikam Litigation" -``` - -This example creates a new eDiscovery case named Fabrikam Litigation. - -## PARAMETERS - -### -Name -The Name parameter specifies the unique name of the eDiscovery 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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter specifies a description for the eDiscovery 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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sources -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Object[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f7f39f50-65d6-4a14-a26a-0d36f42e99a7.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md deleted file mode 100644 index a164d62980..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-CaseHoldPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-CaseHoldPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-CaseHoldPolicy cmdlet to remove case hold policies from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-CaseHoldPolicy [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You should also remove the case hold rule that corresponds to the removed policy by using the Remove-CaseHoldRule cmdlet. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CaseHoldPolicy -Identity "Regulation 123 Compliance" -``` - -This example removes the case hold policy named "Regulation 123 Compliance". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the case hold policy to remove. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d0a97d1a-b1e2-42f9-9eef-c1071cf0c999.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md deleted file mode 100644 index 6655df92b2..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-CaseHoldRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-CaseHoldRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-CaseHoldRule cmdlet to remove case hold rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-CaseHoldRule [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Removing a case hold rule causes the release of all Exchange mailbox and SharePoint site case holds that are associated with the rule. Removing a case hold rule also causes the corresponding case hold policy to become invalid, so you should remove it by using the Remove-CaseHoldPolicy cmdlet. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CaseHoldRule -Identity "One Year Standard" -``` - -This example removes the case hold rule named "One Year Standard". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the case hold rule to remove. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e8c1cb76-248f-419e-9457-32c0656cb37a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md deleted file mode 100644 index f10327c2a2..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ComplianceCase -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ComplianceCase - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ComplianceCase cmdlet to remove eDiscovery cases from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceCase [-Identity] <ComplianceCaseIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ComplianceCase -Identity "Case 5150" -``` - -This example removes the eDiscovery case named Case 5150 - -## PARAMETERS - -### -Identity -The Identity parameter specifies the eDiscovery case that you want to remove. You can use any value that uniquely identifies the eDiscovery case. For example: - -- Name - -- Identity (GUID value) - -```yaml -Type: ComplianceCaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d170738b-2c5c-4adf-8e96-22bdd1dae378.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md deleted file mode 100644 index 7fb9d7e1e9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ComplianceCaseMember -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ComplianceCaseMember - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ComplianceCaseMember cmdlet to remove a single member from an eDiscovery search in Security & Compliance Center. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceCaseMember [-Case] <String> -Member <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ComplianceCaseMember -Case "Case OU812" -Member "Jan Dryml" -``` - -This example removes Jan Dryml from the eDiscovery case named Case OU812. - -## PARAMETERS - -### -Case -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Member -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4af77b17-e758-4577-bb7d-575a6cd77350.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md deleted file mode 100644 index bc64a03836..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-eDiscoveryCaseAdmin -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-eDiscoveryCaseAdmin - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-eDiscoveryCaseAdmin cmdlet to remove an eDiscovery Administrator from the Security & Compliance Center. To replace all eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-eDiscoveryCaseAdmin -User <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. - -When you remove an eDiscovery Administrator, the user isn't removed from the eDiscovery Manager role group. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-eDiscoveryCaseAdmin -User chris@contoso.com -``` - -This example removes an eDiscovery Administrator. - -## PARAMETERS - -### -User -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b419dc9c-a5fd-446f-988f-ac2de4d633fb.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md deleted file mode 100644 index 66f4822a4c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-CaseHoldPolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-CaseHoldPolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-CaseHoldPolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-UpdateStatistics] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-CaseHoldPolicy [-Identity] <PolicyIdParameter> - [-AddExchangeLocation <MultiValuedProperty>] - [-AddPublicFolderLocation <MultiValuedProperty>] - [-AddSharePointLocation <MultiValuedProperty>] - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] [-Force] - [-RemoveExchangeLocation <MultiValuedProperty>] - [-RemovePublicFolderLocation <MultiValuedProperty>] - [-RemoveSharePointLocation <MultiValuedProperty>] - [-UpdateStatistics] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "http://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14" -``` - -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 http://contoso.sharepoint.com/sites/teams/finance. - -- Removes public folders. - -- Updates the comment. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddExchangeLocation -The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddPublicFolderLocation -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -SharePoint Online sites can't be added to the policy until they have been indexed. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocation -The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePublicFolderLocation -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateStatistics -The UpdateStatistics switch specifies whether you want to update the search results for the hold. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/54995117-7af8-4a6f-b2e7-be8eb78d34a4.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md deleted file mode 100644 index 6c92a7f9c9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-CaseHoldRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-CaseHoldRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-CaseHoldRule cmdlet to modify existing case hold rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-CaseHoldRule [-Identity] <ComplianceRuleIdParameter> [-Comment <String>] [-Confirm] - [-ContentDateFrom <DateTime>] [-ContentDateTo <DateTime>] [-ContentMatchQuery <String>] - [-Disabled <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CaseHoldRule -Identity "Internal Company Rule" -Disabled $true -``` - -This example disables the enabled case hold rule named "Internal Company Rule". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateFrom -The ContentDateFrom parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateTo -The ContentDateTo parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/42021435-189d-44f6-99b9-3a171bd3f667.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md deleted file mode 100644 index 67e238c0f1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ComplianceCase -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ComplianceCase - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-ComplianceCase cmdlet to modify eDiscovery cases in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ComplianceCase [-Identity] <ComplianceCaseIdParameter> [-AddOrUpdateSources] [-Close] [-Confirm] - [-Description <String>] [-DomainController <Fqdn>] [-Name <String>] [-RemoveSources] [-Reopen] - [-Sources <Object[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ComplianceCase -Identity "Fabrikam Litigation" -Description "For details, contact the Laura at the Contoso law firm" -``` - -This example adds a description to the existing eDiscovery case named Fabrikam Litigation. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the eDiscovery case that you want to modify. You can use any value that uniquely identifies the eDiscovery case. For example: - -- Name - -- Identity (GUID value) - -```yaml -Type: ComplianceCaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddOrUpdateSources -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Close -The Close switch specifies that you want to close the eDiscovery case. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name of the eDiscovery 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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSources -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reopen -The Reopen switch specifies that you want to re-open a closed eDiscovery case. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sources -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Object[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/de2b0b79-9ab1-4a77-bf93-206ff5d83055.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md deleted file mode 100644 index cefa8e0344..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Update-ComplianceCaseMember -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Update-ComplianceCaseMember - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Update-ComplianceCaseMember cmdlet to replace all members of eDiscovery cases in the Security & Compliance Center. To add or remove existing members, use the Add-ComplianceCaseMember and Remove-ComplianceCaseMember cmdlets. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-ComplianceCaseMember [-Case] <String> -Members <String[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You use eDiscovery cases to control who can create, access, and manage compliance searches in your organization. You use the New-ComplianceCase cmdlet to create eDiscovery cases. The eDiscovery Manager who created the case is automatically added as a member of the case. - -To add a member of an eDiscovery case, the user needs to be a member of the Reviewer or eDiscovery Manager role groups. When a member of the eDiscovery Manager role group is a member of an eDiscovery case, the user can: - -- Add and remove case members. - -- Create and edit compliance searches associated with a case. - -- Perform compliance actions (for example, export) on the results of a compliance search. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-ComplianceCaseMember -Case "Case 5150" -Members chris@contoso.com,michelle@contoso.com,laura@contoso.com,julia@contoso.com -``` - -This example replaces the existing members of the eDiscovery case named Case 5150 with new members. - -## PARAMETERS - -### -Case -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -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: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/00690cc1-5bde-4fcb-bc8f-87372504359d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md deleted file mode 100644 index f270f48fdc..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Office 365 Security & Compliance Center -title: Update-eDiscoveryCaseAdmin -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Update-eDiscoveryCaseAdmin - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Update-eDiscoveryCaseAdmin cmdlet to replace all existing eDiscovery Administrators in the Security & Compliance Center. To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-eDiscoveryCaseAdmin -Users <String[]> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## 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, the user must be assigned the Case Management role. By default, this role is assigned to the Organization Management and eDiscovery Manager role groups. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-eDiscoveryCaseAdmin -Users laura@contoso.com,julia@contoso.com -``` - -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: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5c35b360-6438-4d4f-9e94-e7efa6838c5a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md deleted file mode 100644 index ed14e802ca..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Enable-ComplianceTagStorage -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Enable-ComplianceTagStorage - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Enable-ComplianceTagStorage cmdlet to create the label policy in the Security & Compliance Center. This is a one-time operation. Labels apply retention settings to content. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-ComplianceTagStorage [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -If you run this cmdlet more than once, you'll get an error that says a policy already exists. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-ComplianceTagStorage -``` - -This example creates the label policy in the Security & Compliance Center. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c85eeadf-7d63-4e23-b1ff-07af5811b703.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md deleted file mode 100644 index 544687a8e5..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ComplianceRetentionEvent -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ComplianceRetentionEvent - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceRetentionEvent [-Identity <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceRetentionEvent -``` - -The example returns a summary list of all compliance retention events. - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceRetentionEvent -Identity "Case 1234" -``` - -This example returns detailed information about the compliance retention event named Case 1234. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md deleted file mode 100644 index 5450e34e40..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ComplianceRetentionEventType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ComplianceRetentionEventType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceRetentionEventType cmdlet to view retention event types in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceRetentionEventType [-Identity <ComplianceRuleIdParameter>] [-LoadTag] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceRetentionEventType | Format-Table Name,Priority -``` - -This example returns a summary list of all retention event types - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceRetentionEventType -Identity "Fabrikam Project" -LoadTag -``` - -This example returns detailed information for the retention event type named Fabrikam Project, including the associated compliance tags. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -LoadTag -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceTag.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceTag.md deleted file mode 100644 index 71f6333969..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceTag.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-ComplianceTag -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-ComplianceTag - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceTag cmdlet to view labels in the Security & Compliance Center. Labels apply retention settings to content. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceTag [[-Identity] <ComplianceRuleIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceTag | Format-Table -Auto Name,Priority,RetentionAction,RetentionDuration,Workload -``` - -This example returns a summary list of all labels. - -### -------------------------- Example 2 -------------------------- -``` -Get-ComplianceTag -Identity "HR Content" -``` - -This example returns detailed information about the label named HR Content. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the label that you want to view. You can use any value that uniquely identifies the tag. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/101c1af9-202a-43a9-ad3d-bde116b01889.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md deleted file mode 100644 index f1df4cb99d..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-ComplianceTagStorage -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-ComplianceTagStorage - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ComplianceTagStorage cmdlet to confirm that you've created the label policy by using the Enable-ComplianceTagStorage cmdlet. Labels apply retention settings to content. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ComplianceTagStorage [[-Identity] <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ComplianceTagStorage -``` - -This example confirms that you've created the label policy in your organization. - -## PARAMETERS - -### -Identity -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) - -- Distinguished name (DN) - -- GUID (a different value than Name) - -However, there can be only one label policy in your organization. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/18d8ecc1-8084-4905-bc6a-a1f5199d280b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md deleted file mode 100644 index b38454a4b9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-DataRetentionReport -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-DataRetentionReport - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-DataRetentionReport cmdlet to view information about data retention in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DataRetentionReport [[-Organization] <OrganizationIdParameter>] [-EndDate <DateTime>] [-Page <Int32>] - [-PageSize <Int32>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The following properties are returned by this cmdlet: - -- Organization - -- Date - -- Action - -- DataSource - -- MessageCount - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DataRetentionReport -StartDate 04/01/2018 -EndDate 04/30/2018 -``` - -This example lists the data detections for April, 2018. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/69b3a80d-17ae-4d2c-9d71-5833a9013b17.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md deleted file mode 100644 index 6c3522c5b7..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-HoldCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-HoldCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-HoldCompliancePolicy to view existing preservation policies in the Security & Compliance Center. - -Note: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HoldCompliancePolicy [[-Identity] <PolicyIdParameter>] [-DistributionDetail] [<CommonParameters>] -``` - -## DESCRIPTION -This list describes the properties displayed by default. - -- Name: The unique name of the policy. - -- Workload: Where the policy is applied. For example, SharePoint or Exchange. - -- 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). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HoldCompliancePolicy -``` - -This example displays summary information for all preservation policies in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-HoldCompliancePolicy -Identity "Regulation 123 Compliance" | Format-List -``` - -This example displays detailed information for the policy named "Regulation 123 Compliance". - -## PARAMETERS - -### -DistributionDetail -The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the preservation policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e408a718-5b70-43e2-bca4-7645df4bc83a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md deleted file mode 100644 index ecf85d1add..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-HoldComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-HoldComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-HoldComplianceRule to view preservation rules in the Security & Compliance Center. - -Note: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HoldComplianceRule [[-Identity] <ComplianceRuleIdParameter>] [-Policy <PolicyIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -This list describes the properties that are displayed by default in the summary information. - -- Name: The unique name of the rule. - -- Disabled: The enabled or disabled status of the rule. - -- Mode: The current operating mode of the rule (for example, Enforce). - -- Comment: An administrative comment. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HoldComplianceRule -``` - -This example displays summary information for all preservation rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-HoldComplianceRule -Identity "30DayRule" | Format-List -``` - -This example displays detailed information for the preservation rule named "30 Day Rule". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the preservation rule you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -You can use this parameter with the Identity parameter in the same command. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bbdee91a-a0e7-40fc-9439-7beae5218e5a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md deleted file mode 100644 index b757093bfb..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: Get-ManagedContentSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-ManagedContentSettings - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-ManagedContentSettings cmdlet to retrieve managed content settings associated with managed folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### FolderName -``` -Get-ManagedContentSettings [-FolderName <ELCFolderIdParameter>] - [-DomainController <Fqdn>] - [-Organization <OrganizationIdParameter>] - [<CommonParameters>] -``` - -### Identity -``` -Get-ManagedContentSettings [[-Identity] <ELCContentSettingsIdParameter>] - [-DomainController <Fqdn>] - [-Organization <OrganizationIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-ManagedContentSettings cmdlet retrieves from one to all of the managed content settings. You can also retrieve only the managed content settings associated with a specified managed folder. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ManagedContentSettings | Format-List -``` - -This example uses the Get-ManagedContentSettings cmdlet without parameters to obtain all managed content settings. The output of the Get-ManagedContentSettings cmdlet is piped to the Format-List cmdlet so that all the available information is displayed in the result. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagedContentSettings -Identity "Inbox Settings" -``` - -This example retrieves the managed content settings Inbox Settings. - -### -------------------------- Example 3 -------------------------- -``` -Get-ManagedContentSettings -FolderName "Inbox" -``` - -This example retrieves the managed content settings for the managed folder Inbox. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderName -The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. When used, this command retrieves all the policies that apply to that folder. - -This parameter can't be used with the Identity parameter. - -```yaml -Type: ELCFolderIdParameter -Parameter Sets: FolderName -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name, distinguished name (DN), or GUID of the set of managed content settings. When used, this command retrieves the folder content settings and all associated attributes. - -This parameter can't be used with the FolderName parameter. - -```yaml -Type: ELCContentSettingsIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Organization -The Organization parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/08082cfe-b820-493e-bddd-a0befb465972.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedFolder.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedFolder.md deleted file mode 100644 index 7c9c59d618..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedFolder.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: Get-ManagedFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-ManagedFolder - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-ManagedFolder cmdlet to retrieve the attributes of one or more managed folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-ManagedFolder [[-Identity] <ELCFolderIdParameter>] - [-DomainController <Fqdn>] - [-Organization <OrganizationIdParameter>] [<CommonParameters>] -``` - -### Mailbox -``` -Get-ManagedFolder [-Mailbox <MailboxIdParameter>] - [-DomainController <Fqdn>] - [-Organization <OrganizationIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-ManagedFolder cmdlet retrieves the specified managed folder attributes: - -- If only an Identity parameter value is present, the command retrieves the specified folder and all associated attributes. - -- If a Mailbox parameter value is present, the command retrieves all managed folders that apply to that user by means of a managed folder mailbox policy applied by an administrator. Managed folders that users add by means of an organization's managed folder opt-in Web site aren't displayed by this command. - -- If no parameter values are specified, the command retrieves all the folder objects and their associated 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ManagedFolder MyManagedFolder | Format-List -``` - -This example retrieves information about the managed folder MyManagedFolder. The output of the Get-ManagedFolder cmdlet is piped to the Format-List cmdlet so that all the available information is displayed in the result. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the mailbox. Valid values include SMTP address, domain name, and alias. The command retrieves all the folders that apply to the specified user. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Mailbox -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. - -The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a30939b7-1291-48d8-b19a-512a0a031121.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md deleted file mode 100644 index 0452405792..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: Get-ManagedFolderMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-ManagedFolderMailboxPolicy - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-ManagedFolderMailboxPolicy cmdlet to return all attributes of one or more managed folder mailbox policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ManagedFolderMailboxPolicy [[-Identity] <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] - [-Organization <OrganizationIdParameter>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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 Parameters (https://technet.microsoft.com/library/bb124388.aspx). - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Organization -This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. - -The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3a151aa9-ff32-46a9-a3b8-8fbd043cedc3.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md deleted file mode 100644 index 4d64d2ce15..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-RetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-RetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-RetentionCompliancePolicy to view existing retention policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RetentionCompliancePolicy [[-Identity] <PolicyIdParameter>] [-DistributionDetail] [-ExcludeTeamsPolicy] [-RetentionRuleTypes] [-TeamsPolicyOnly] - [<CommonParameters>] -``` - -## DESCRIPTION -This list describes the properties that are displayed by default. - -- Name: The unique name of the policy. - -- Workload: Where the policy is applied. For example, SharePoint or Exchange. - -- 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). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RetentionCompliancePolicy -``` - -This example displays summary information for all retention policies in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -DistributionDetail | Format-List -``` - -This example displays detailed information for the policy named "Regulation 123 Compliance", including accurate values for the DistributionStatus and \*Location properties. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DistributionDetail -The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - -If you don't use this switch, the values of the DistributionStatus and \*Location property values will be inaccurate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeTeamsPolicy -{{Fill ExcludeTeamsPolicy Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionRuleTypes -The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. - -To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, Get-RetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes. If you don't use the RetentionRuleTypes switch, the value appears blank. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsPolicyOnly -{{Fill TeamsPolicyOnly Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e9f861b8-481a-49e0-884d-6617ff9852a1.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md deleted file mode 100644 index c102777f33..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-RetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-RetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-RetentionComplianceRule to view retention rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RetentionComplianceRule [[-Identity] <ComplianceRuleIdParameter>] [-Policy <PolicyIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -This list describes the properties that are displayed by default in the summary information. - -- Name: The unique name of the rule. - -- Disabled: The enabled or disabled status of the rule. - -- Mode: The current operating mode of the rule (for example, Enforce). - -- Comment: An administrative comment. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RetentionComplianceRule -``` - -This example displays summary information for all retention rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-RetentionComplianceRule -Identity "30 Day Rule" | Format-List -``` - -This example displays detailed information for the retention rule named "30 Day Rule". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the retention rule you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -You can use this parameter with the Identity parameter in the same command. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9eabf25a-8519-4c40-8977-b1d46e6acb3e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionEvent.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionEvent.md deleted file mode 100644 index 6e0b8b6df9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionEvent.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online -title: Get-RetentionEvent -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-RetentionEvent - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-RetentionEvent cmdlet to view retention events in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RetentionEvent [[-Identity] <EwsStoreObjectIdParameter>] [-AllStatus] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RetentionEvent -``` - -This example returns a summary list of all retention events. - -### -------------------------- Example 2 -------------------------- -``` -Get-RetentionEvent -Identity x | Format-List -``` - -This example returns detailed information about retention the specified retention event. - -## PARAMETERS - -### -AllStatus -The AllStatus switch specifies whether to include zero count events in the results. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the retention event that you want to view. - -```yaml -Type: EwsStoreObjectIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/32aced21-3693-490a-a9ca-64cb766d15ed.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md deleted file mode 100644 index d17670505f..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RetentionPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-RetentionPolicy cmdlet to retrieve the settings for retention policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RetentionPolicy [[-Identity] <MailboxPolicyIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy may contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RetentionPolicy -Identity "RP Finance" | Format-List -``` - -This example returns all the properties of the retention policy RP Finance. The output is piped to the Format-List cmdlet to format the results as a list of properties. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7a05203e-894b-4109-9647-ca7afc44a08f.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md deleted file mode 100644 index 1bf252b8f7..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RetentionPolicyTag -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-RetentionPolicyTag cmdlet to retrieve settings for a retention tag. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-RetentionPolicyTag [[-Identity] <RetentionPolicyTagIdParameter>] - [-DomainController <Fqdn>] - [-IncludeSystemTags] - [-Types <ElcFolderType[]>] [<CommonParameters>] -``` - -### Mailbox -``` -Get-RetentionPolicyTag [-Mailbox <MailboxIdParameter>] [-OptionalInMailbox] - [-DomainController <Fqdn>] - [-IncludeSystemTags] - [-Types <ElcFolderType[]>] [<CommonParameters>] -``` - -## DESCRIPTION -Retention tags are used to apply message retention settings to messages or folders. There are three types of retention tags: - -- Retention policy tags - -- Default policy tags - -- Personal tags - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RetentionPolicyTag -``` - -This example returns all retention tags. - -### -------------------------- Example 2 -------------------------- -``` -Get-RetentionPolicyTag -IncludeSystemTags -``` - -This example returns system tags in addition to personal and default tags. - -### -------------------------- Example 3 -------------------------- -``` -Get-RetentionPolicyTag "Consolidated Messenger" -``` - -This example returns the settings for the tag Consolidated Messenger. - -### -------------------------- Example 4 -------------------------- -``` -Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize -``` - -This example returns all retention tags of Inbox and All types and pipes the results to the Format-Table command to display the Name, Type, RetentionEnabled, AgeLimitForRetention and RetentionAction properties. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeSystemTags -The IncludeSystemTags switch specifies whether to return any system tags. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter isn't available in this release. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionalInMailbox -The OptionalInMailbox parameter isn't available in this release. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Types -The Types parameter specifies the type of retention tag to return. Valid values include: - -- Calendar - -- Contacts - -- DeletedItems - -- Drafts - -- Inbox - -- JunkEmail - -- Journal - -- Notes - -- Outbox - -- SentItems - -- Tasks - -- All - -- RssSubscriptions - -- ConversationHistory - -- Personal - -The parameter accepts multiple values separated by a comma. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5cddcfea-6f67-4481-9c00-5b13c11d5ced.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md deleted file mode 100644 index 359ced152f..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-TeamsRetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-TeamsRetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-TeamsRetentionCompliancePolicy cmdlet to view retention policies for Microsoft Teams in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TeamsRetentionCompliancePolicy [[-Identity] <Object>] [-DistributionDetail] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -This list describes the properties that are displayed by default. - -- Name: The unique name of the policy. - -- 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). - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamsRetentionCompliancePolicy -``` - -This example displays summary information for all retention policies for Microsoft Teams in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-TeamsRetentionCompliancePolicy -Identity "Teams - Regulation 123 Compliance" -DistributionDetail | Format-List -``` - -This example displays detailed information for the policy named "Teams - Regulation 123 Compliance", including accurate values for the DistributionStatus and \*Location properties. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionDetail -The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - -If you don't use this switch, the values of the DistributionStatus and \*Location property values will be inaccurate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the retention policy for Microsoft Teams that you want to modify. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md deleted file mode 100644 index 8d6acd05df..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-TeamsRetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-TeamsRetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-TeamsRetentionComplianceRule cmdlet to view retention rules for Microsoft Teams in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TeamsRetentionComplianceRule [[-Identity] <ComplianceRuleIdParameter>] [-Policy <PolicyIdParameter>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamsRetentionComplianceRule -``` - -This example displays summary information for all retention rules for Microsoft Teams in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-TeamsRetentionComplianceRule -Identity "Teams - 30 Day Rule" | Format-List -``` - -This example displays detailed information for the retention rule for Microsoft Teams named "Teams - 30 Day Rule". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the retention rule for Microsoft Teams that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter filters the retention rule for Microsoft Teams results by the associated retention policy. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -You can use this parameter with the Identity parameter in the same command. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md deleted file mode 100644 index 8481dd4b30..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ComplianceRetentionEvent -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ComplianceRetentionEvent - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ComplianceRetentionEvent cmdlet to create compliance retention events in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ComplianceRetentionEvent -Name <String> [-AssetId <String>] [-Comment <String>] [-Confirm] [-EventDateTime <DateTime>] [-EventTags <MultiValuedProperty>] [-EventType <ComplianceRuleIdParameter>] [-ExchangeAssetIdQuery <String>] [-SharePointAssetIdQuery <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -### -------------------------- Example 2 -------------------------- -``` -Insert example commands for example 2. -``` - -Insert descriptive text for example 2. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssetId -The AssetId parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventDateTime -The EventDateTime parameter specifies the date-time of the event. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventTags -The EventTags parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeAssetIdQuery -The ExchangeAssetIdQuery parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointAssetIdQuery -The SharePointAssetIdQuery parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md deleted file mode 100644 index 092f4464a3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ComplianceRetentionEventType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ComplianceRetentionEventType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ComplianceRetentionEventType cmdlet to create retention event types in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ComplianceRetentionEventType -Name <String> [-Comment <String>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ComplianceRetentionEventType -Name "Fabrikam Project" -``` - -This example creates a new retention event type name Fabrikam Project - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceTag.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceTag.md deleted file mode 100644 index 295e7b131b..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceTag.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ComplianceTag -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ComplianceTag - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ComplianceTag cmdlet to create labels in the Security & Compliance Center. Labels apply retention settings to content. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ComplianceTag [-Name] <String> [-Comment <String>] [-Confirm] [-EventType <ComplianceRuleIdParameter>] - [-IsRecordLabel <$true | $false>] [-RetentionAction <String>] [-RetentionDuration <Unlimited>] - [-RetentionType <String>] [-ReviewerEmail <SmtpAddress[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ComplianceTag -Name "HR Content" -RetentionAction Keep -RetentionDuration 1825 -RetentionType ModificationAgeInDays -``` - -This example creates a new label named HR Content with the following settings: - -- Action: Keep. - -- Duration: 5 years (1825 days) - -- Type: Modification age in days. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -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 - -- Distinguished name (DN) - -- GUID - -You can use the Get-RetentionComplianceRule cmdlet to view the available retention rules. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsRecordLabel -The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: - -- $true: The label is a record label. Once the label is applied to content, the label can't be removed. - -- $false: The label isn't a record label. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionAction -The RetentionAction parameter specifies the action for the label. Valid values are: - -- Delete - -- Keep - -- KeepAndDelete - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - -- A positive integer. - -- The value unlimited. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionType -The RetentionType parameter specifies whether the retention duration is calculated from the content creation date, tagged date, or last modification date. Valid values are: - -- CreationAgeInDays - -- EventAgeInDays - -- ModificationAgeInDays - -- TaggedAgeInDays - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReviewerEmail -The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2414a7c4-57d2-4f90-a1bc-3dc14643155d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md deleted file mode 100644 index efc8aa6ef3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-HoldCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-HoldCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-HoldCompliancePolicy cmdlet to create new preservation policies in the Security & Compliance Center. - -Note: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-HoldCompliancePolicy [-Name] <String> [-Comment <String>] [-Confirm] [-Enabled <$true | $false>] - [-ExchangeLocation <MultiValuedProperty>] [-Force] [-PublicFolderLocation <MultiValuedProperty>] - [-SharePointLocation <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -New policies are not valid and will not be applied until a preservation rule is added to the policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-HoldCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "http://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. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocation -The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If no mailboxes are specified, then no mailboxes are placed on hold. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocation -The PublicFolderLocation parameter specifies that you want to include all public folders in the preservation policy. You use the value All for this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c064ff2b-27b3-49ca-a05a-a213db6d6f55.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md deleted file mode 100644 index 7949f2e441..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-HoldComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-HoldComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-HoldComplianceRule cmdlet to create new preservation rules in the Security & Compliance Center. - -Note: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-HoldComplianceRule [-Name] <String> -Policy <PolicyIdParameter> [-Comment <String>] [-Confirm] - [-ContentDateFrom <DateTime>] [-ContentDateTo <DateTime>] [-ContentMatchQuery <String>] - [-Disabled <$true | $false>] [-HoldContent <Unlimited>] [-HoldDurationDisplayHint <Days | Months | Years>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The preservation rule must be added to an existing preservation policy using the Policy parameter. Only one rule can be added to each preservation policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the policy to contain the rule. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateFrom -The ContentDateFrom parameter specifies the start date of the date range for content to include. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateTo -The ContentDateTo parameter specifies the end date of the date range for content to include. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the preservation rule is enabled or disabled. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HoldContent -The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: - -- An integer: The hold duration in days. - -- Unlimited: The content is held indefinitely. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HoldDurationDisplayHint -The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Security & Compliance Center. 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 Security & Compliance Center will display 1 year as the content hold duration. - -```yaml -Type: Days | Months | Years -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e177cc45-e29a-4352-8c4d-dfcc6f9d3b75.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md deleted file mode 100644 index a5124966fb..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: New-ManagedFolderMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# New-ManagedFolderMailboxPolicy - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the New-ManagedFolderMailboxPolicy cmdlet to create a managed folder mailbox policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ManagedFolderMailboxPolicy [-Name] <String> [-Confirm] [-DomainController <Fqdn>] - [-ManagedFolderLinks <ELCFolderIdParameter[]>] [-Organization <OrganizationIdParameter>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -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). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ManagedFolderMailboxPolicy -Name "My Managed Folder Mailbox Policy" -ManagedFolderLinks Inbox, MyFolder -``` - -This example creates the managed folder mailbox policy My Managed Folder Mailbox Policy, with a list of managed folders to which the managed folder mailbox policy is to be linked. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedFolderLinks -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. - -The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/14423cb5-b93a-466f-b7b2-7f37f14fb896.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md deleted file mode 100644 index 8fbb6e4d94..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md +++ /dev/null @@ -1,540 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-RetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-RetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-RetentionCompliancePolicy cmdlet to create new retention policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Default -``` -New-RetentionCompliancePolicy [-Name] <String> - [-Comment <String>] - [-Confirm] - [-DynamicScopeLocation <MultiValuedProperty>] - [-Enabled <$true | $false>] - [-ExchangeLocation <MultiValuedProperty>] - [-ExchangeLocationException <MultiValuedProperty>] - [-Force] - [-ModernGroupLocation <MultiValuedProperty>] - [-ModernGroupLocationException <MultiValuedProperty>] - [-OneDriveLocation <MultiValuedProperty>] - [-OneDriveLocationException <MultiValuedProperty>] - [-PublicFolderLocation <MultiValuedProperty>] - [-RestrictiveRetention <$true | $false>] - [-SharePointLocation <MultiValuedProperty>] - [-SharePointLocationException <MultiValuedProperty>] - [-SkypeLocation <MultiValuedProperty>] - [-SkypeLocationException <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### TeamLocation -``` -New-RetentionCompliancePolicy [-Name] <String> - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] - [-Force] - [-RestrictiveRetention <$true | $false>] - [-TeamsChannelLocation <MultiValuedProperty>] - [-TeamsChannelLocationException <MultiValuedProperty>] - [-TeamsChatLocation <MultiValuedProperty>] - [-TeamsChatLocationException <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -New policies are not valid and will not be applied until a retention rule is added to the policy. In addition, at least one location parameter must be defined to create a retention policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "http://contoso.sharepoint.com/sites/teams/finance" -``` - -This example creates a retention policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicScopeLocation -{{Fill DynamicScopeLocation Description}} - -```yaml -Type: -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -Enabled -The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocation -The ExchangeLocation parameter specifies the mailboxes to include. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -- The value All for all mailboxes. You can only use this value by itself. - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If no mailboxes are specified, then no mailboxes are placed on hold. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExchangeLocationException -This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModernGroupLocation -The ModernGroupLocation parameter specifies the Office 365 groups to include in the policy. Valid values are: - -- An Office 365 Group - -- The value All for all Office 365 groups. You can only use this value by itself. - -To identify the Office 365 Group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModernGroupLocationException -The ModernGroupLocationException parameter specifies the Office 365 groups to exclude when you're using the value All for the ModernGroupLocation parameter. - -You can use any value that uniquely identifies the Office 365 Group. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderLocation -The PublicFolderLocation parameter specifies that you want to include all public folders in the retention policy. You use the value All for this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictiveRetention -The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - -- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. - -- $false: Preservation Lock isn't enabled for the policy. This is the default value. - -After a policy has been locked, no one can turn off or disable it, or remove 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkypeLocation -The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy. - -You can use any value that uniquely identifies the user. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkypeLocationException -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChannelLocation -{{Fill TeamsChannelLocation Description}} - -```yaml -Type: -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChannelLocationException -{{Fill TeamsChannelLocationException Description}} - -```yaml -Type: -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChatLocation -{{Fill TeamsChatLocation Description}} - -```yaml -Type: -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChatLocationException -{{Fill TeamsChatLocationException Description}} - -```yaml -Type: -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2711442f-22bb-4a35-9938-575d24608e43.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md deleted file mode 100644 index d3c72026a8..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-RetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-RetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-RetentionComplianceRule cmdlet to create new retention rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### ComplianceTag -``` -New-RetentionComplianceRule -ApplyComplianceTag <String> -Policy <PolicyIdParameter> [-ContentContainsSensitiveInformation <PswsHashtable[]>] - [-Confirm] - [-ContentMatchQuery <String>] - [-ExpirationDateOption <String>] - [-RetentionComplianceAction <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -New-RetentionComplianceRule [-Name] <String> -Policy <PolicyIdParameter> [-Comment <String>] [-ExcludedItemClasses <MultiValuedProperty>] [-RetentionDuration <Unlimited>] [-RetentionDurationDisplayHint <Days | Months | Years>] - [-Confirm] - [-ContentMatchQuery <String>] - [-ExpirationDateOption <String>] - [-RetentionComplianceAction <String>] - [-WhatIf] [<CommonParameters>] -``` - -### PublishComplianceTag -``` -New-RetentionComplianceRule -Policy <PolicyIdParameter> -PublishComplianceTag <String> [-Confirm] - [-ExpirationDateOption <String>] - [-RetentionComplianceAction <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The retention rule must be added to an existing retention policy using the Policy parameter. Only one rule can be added to each retention policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration Unlimited -``` - -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 indefinitely. - -## PARAMETERS - -### -ApplyComplianceTag -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. - -You can't use this parameter with the Name or PublishComplianceTag parameters. - -```yaml -Type: String -Parameter Sets: ComplianceTag -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the policy to contain the rule. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishComplianceTag -The PublishComplianceTag parameter specifies the label that's published for the rule, which makes the label visible to users in apps (for example, Outlook, SharePoint, and OneDrive). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. - -You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. - -You can't use this parameter with the Name or ApplyComplianceTag parameters. - -```yaml -Type: String -Parameter Sets: PublishComplianceTag -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. - -This parameter uses the basic syntax @(@{Name="\<SensitiveInformationType1\>";[minCount="\<Value\>"],@{Name="\<SensitiveInformationType2\>";[minCount="\<Value\>"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). - -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see Sensitive information types inventory (https://go.microsoft.com/fwlink/p/?LinkId=529420). - -You can use this parameter with the ApplyComplianceTag parameter. - -```yaml -Type: PswsHashtable[] -Parameter Sets: ComplianceTag -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: ComplianceTag, Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedItemClasses -The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: - -- IPM.Note.Microsoft.Conversation - -- IPM.Note.Microsoft.Conversation.Voice - -- IPM.Note.Microsoft.Missed - -- IPM.Note.Microsoft.Missed.Voice - -- IPM.Note.Microsoft.Voicemail - -- IPM.Note.Microsoft.VoiceMessage.UA - -- IPM.Note.Microsoft.Voicemail.UM - -- IPM.Note.Microsoft.Voicemail.UM.CA - -You can specify multiple item class values by using the syntax "Value1","Value2",..."ValueN". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpirationDateOption -The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - -- CreationAgeInDays - -- ModificationAgeInDays - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionComplianceAction -The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - -- Delete - -- Keep - -- KeepAndDelete - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - -- An integer: The hold duration in days. - -- Unlimited: The content is held indefinitely. - -```yaml -Type: Unlimited -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDurationDisplayHint -The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Security & Compliance Center. 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 Security & Compliance Center will display 1 year as the content hold duration. - -```yaml -Type: Days | Months | Years -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9ad613ff-dbb4-4a86-9f4c-ab212e68603a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionPolicy.md deleted file mode 100644 index b260a4ac31..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-RetentionPolicy.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RetentionPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-RetentionPolicy cmdlet to create a retention policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-RetentionPolicy [-Name] <String> [-Confirm] [-DomainController <Fqdn>] - [-RetentionId <Guid>] [-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>] - [-WhatIf] [-IsDefault] [-IsDefaultArbitrationMailbox] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-RetentionPolicy "Business General" -``` - -This example creates the retention policy Business General without associating any retention policy tags. - -### -------------------------- Example 2 -------------------------- -``` -New-RetentionPolicy "Business General" -RetentionPolicyTagLinks "General Business","Legal" -``` - -This example creates the retention policy Business General and uses the RetentionPolicyTagLinks parameter to associate two retention policy tags with this policy. You can enter multiple retention policy tags, separated by commas. If a tag name includes a space, enclose the name in quotation marks. - -The second retention tag, which is named Legal, is also enclosed in quotation marks for consistency. Values that don't include a space can be enclosed in quotation marks without any change to how the command is interpreted. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPolicyTagLinks -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -IsDefault -This parameter is reserved for internal Microsoft use. - -To set the default retention policy for new mailboxes, use the RetentionPolicy parameter on the Set-MailboxPlan cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefaultArbitrationMailbox -This parameter is available only in the cloud-based service. - -The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4cdd6f20-5bca-4269-ac21-0a4cde0d54d6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md deleted file mode 100644 index 4b410f9a28..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-TeamsRetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-TeamsRetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-TeamsRetentionCompliancePolicy cmdlet to create new retention policies for Microsoft Teams in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-TeamsRetentionCompliancePolicy [-Name] <String>] [-Comment <String>] [-Enabled <$true | $false>] [-Force] [-RestrictiveRetention <$true | $false>] [-TeamsChannelLocation <MultiValuedProperty>] [-TeamsChatLocationException <MultiValuedProperty>] [-TeamsChatLocation <MultiValuedProperty>] [-TeamsChannelLocationException <MultiValuedProperty>] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -New policies are not valid and will not be applied until a retention rule for Microsoft Teams is added to the policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-TeamsRetentionCompliancePolicy -Name "Teams - Regulation 123 Compliance" -TeamsChannelLocation "Engineering Team", "UX Design Team" -TeamsChatLocation "Kitty Petersen", "Scott Nakamura" -``` - -This example creates a retention policy named "Teams - Regulation 123 Compliance" for the Teams channel messages in the teams by the names of Engineering Team and UX Design Team and Teams chats in the mailboxes of Kitty Petersen and Scott Nakamura. - - -## PARAMETERS - -### -Name -The Name parameter specifies the unique name of the retention policy for Microsoft Teams. If the value contains spaces, enclose the value in quotation marks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -he Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictiveRetention -The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - -- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. - -- $false: Preservation Lock isn't enabled for the policy. This is the default value. - -After a policy has been locked, no one can turn off or disable it, or remove 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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChannelLocation -The TeamsChannelLocation parameter specifies the Team (group) mailbox for the team whose channel messages you want to include in the policy. You identify the channels by the parent team's (group) mailbox, or you can use the value All to include all Teams in the tenant. - -You can use any value that uniquely identifies the group (team) mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChannelLocationException -The TeamsChannelLocationException parameter specifies the Team (group) mailbox for the team whose channel messages you want to exclude in the policy when you use the value All in the TeamsChannelLocation parameter. You can use any value that uniquely identifies the group (team) mailbox. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChatLocation -The TeamsChatLocation parameter specifies the Microsoft Teams chats to include in the policy. You identify the chat by the user mailbox, or you can use the value All to include all chats for all users from all user mailboxes. - -You can use any value that uniquely identifies the user mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsChatLocationException -The TeamsChatLocationException parameter specifies the Microsoft Teams chat locations to exclude when you use the value All for the TeamsChatLocation parameter. You identify the chat by the user mailbox. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md deleted file mode 100644 index 5b1272e17c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-TeamsRetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-TeamsRetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-TeamsRetentionComplianceRule cmdlet to create retention rules for Microsoft Teams in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-TeamsRetentionComplianceRule [-Name] <String> -Policy <PolicyIdParameter> -RetentionComplianceAction <String> -RetentionDuration <Unlimited> - [-Comment <String>] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-TeamsRetentionComplianceRule -Name "Teams - SeptOneYear" -Policy "Teams - Internal Company Policy" -RetentionComplianceAction Keep -RetentionDuration Unlimited -``` - -This example creates a new retention rule for Microsoft Teams named "Teams - SeptOneYear" and adds it to the existing retention policy for Microsoft Teams named "Teams - Internal Company Policy". Content will be held indefinitely. - -## PARAMETERS - -### -Name -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the policy to contain the rule. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionComplianceAction -The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - -- Delete - -- Keep - -- KeepAndDelete - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - -- An integer: The hold duration in days. - -- Unlimited: The content is held indefinitely. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md deleted file mode 100644 index 7bb5879724..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ComplianceRetentionEventType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ComplianceRetentionEventType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ComplianceRetentionEventType cmdlet to remove retention event types in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceRetentionEventType -Identity <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ComplianceRetentionEventType -Identity "Fabrikam Project" -``` - -This example remove the retention event type name Fabrikam Project - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md deleted file mode 100644 index 93ab30ca0b..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ComplianceTag -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ComplianceTag - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ComplianceTag cmdlet to remove labels from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ComplianceTag [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -IRemove-ComplianceTag -Identity "HR Content" -``` - -This example removes the label named HR Content. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the label that you want to remove. You can use any value that uniquely identifies the tag. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7a1012fe-ca84-483f-b7c9-80e8605f090b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md deleted file mode 100644 index 727270ff48..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-HoldCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-HoldCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-HoldCompliancePolicy cmdlet to remove preservation policies from the Security & Compliance Center. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-HoldCompliancePolicy [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You should also remove the preservation rule that corresponds to the removed policy by using the Remove-HoldComplianceRule cmdlet. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -``` - -This example removes the preservation policy named "Regulation 123 Compliance". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the preservation policy to remove. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/669e2cdb-a140-49c2-b262-e68fe61f7f37.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md deleted file mode 100644 index 92e6d94f90..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-HoldComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-HoldComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-HoldComplianceRule cmdlet to remove preservation rules from the Security & Compliance Center. - -Note: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-HoldComplianceRule [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Removing a preservation rule causes the release of all Exchange mailbox and SharePoint site preservations that are associated with the rule. Removing a preservation rule also causes the corresponding preservation policy to become invalid, so you should remove it by using the Remove-HoldCompliancePolicy cmdlet. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-HoldComplianceRule -Identity "One Year Standard" -``` - -This example removes the preservation rule named "One Year Standard". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the preservation rule to remove. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eb136136-3334-4e2b-b442-5664e22c1dbf.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md deleted file mode 100644 index e6e4196560..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: Remove-ManagedFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Remove-ManagedFolder - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Remove-ManagedFolder cmdlet to remove a managed folder from Active Directory. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ManagedFolder [-Identity] <ELCFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ManagedFolder MyManagedFolder -``` - -This example removes the managed folder MyManagedFolder. - -## PARAMETERS - -### -Identity -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 -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 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ac283dcf-0fc9-4f79-97ef-484f1aacf29c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md deleted file mode 100644 index 37b7008045..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: Remove-ManagedFolderMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Remove-ManagedFolderMailboxPolicy - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Remove-ManagedFolderMailboxPolicy cmdlet to delete managed folder mailbox policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ManagedFolderMailboxPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -If you remove a managed folder mailbox policy that's applied to users' mailboxes, the affected mailboxes may no longer have retention settings. Therefore, before using this cmdlet to remove a policy, you should determine if the managed folder mailbox policy is applied to any users, and apply another policy to those users. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ManagedFolderMailboxPolicy -Identity "My Managed Folder Mailbox Policy" -``` - -This example removes the managed folder mailbox policy My Managed Folder Mailbox Policy. - -## PARAMETERS - -### -Identity -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 -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 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch overrides the confirmation prompt displayed by the cmdlet when the managed folder mailbox policy being removed is assigned to a mailbox user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/439967b5-7297-4d39-a962-0e9d0eda16c4.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md deleted file mode 100644 index b04694b84f..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-RetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-RetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-HoldCompliancePolicy cmdlet to remove retention policies from the Security & Compliance Center. This cmdlet also removes the corresponding retention rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -New policies are not valid and will not be applied until a retention rule is added to the policy. In addition, at least one location parameter must be defined to create a retention policy. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -``` - -This example removes the retention policy named "Regulation 123 Compliance". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the retention policy. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89463548-6484-43f0-8a85-2605e38d430d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md deleted file mode 100644 index 2332a868f2..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-RetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-RetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-RetentionComplianceRule cmdlet to remove retention rules from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RetentionComplianceRule [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Removing a retention rule causes the release of all Exchange mailbox and SharePoint site retentions that are associated with the rule. Removing a retention rule also causes the corresponding retention policy to become invalid, so you should remove it by using the Remove-RetentionCompliancePolicy cmdlet. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RetentionComplianceRule -Identity "One Year Standard" -``` - -This example removes the retention rule named "One Year Standard". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the retention rule to remove. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the retention rule. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/20a3d391-fdd7-40cd-89f6-03649c65ee00.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md deleted file mode 100644 index b2449e4635..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RetentionPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-RetentionPolicy cmdlet to remove a retention policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RetentionPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RetentionPolicy -Identity "Business Critical" -``` - -This example removes the retention policy Business Critical. - -### -------------------------- Example 2 -------------------------- -``` -Remove-RetentionPolicy -Identity "Business Critical" -Confirm:$false -``` - -This example removes the retention policy Business Critical and suppresses the confirmation prompt. - -### -------------------------- Example 3 -------------------------- -``` -Remove-RetentionPolicy -Identity "Business Critical" -Confirm:$false -Force -``` - -This example removes the retention policy Business Critical, which is assigned to users and suppresses the confirmation prompt. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -Force -The Force switch specifies whether to override the confirmation prompt that appears when removing a retention policy that's assigned to users. Removing a policy that's assigned to users results in those users not having any retention policy. You don't have to specify a value with the Force switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4af0ae71-cdfa-4db4-9473-21c25fd6e351.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md deleted file mode 100644 index c68337bbd2..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-TeamsRetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-TeamsRetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-TeamsRetentionCompliancePolicy cmdlet to remove retention policies for Microsoft Teams from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-TeamsRetentionCompliancePolicy [-WhatIf] [-Confirm] [[-Identity] <Object>] [-ForceDeletion] [-AsJob] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-TeamsRetentionCompliancePolicy -Identity "Teams - Regulation 123 Compliance" -``` - -This example removes the retention policy for Microsoft Teams named "Teams - Regulation 123 Compliance". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the retention policy for Microsoft Teams that you want to remove. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the retention policy. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md deleted file mode 100644 index 400087b14c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-TeamsRetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-TeamsRetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-TeamsRetentionComplianceRule cmdlet to remove retention rules for Microsoft Teams from your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-TeamsRetentionComplianceRule [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-TeamsRetentionComplianceRule -Identity "Teams - One Year Standard" -``` - -This example removes the retention rule for Microsoft Teams named "Teams - One Year Standard" - -## PARAMETERS - -### -Identity -The Identity parameter specified the retention rule for Microsoft Teams that you want to remove. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 0 -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md deleted file mode 100644 index 7d733c1b44..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ComplianceRetentionEventType -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ComplianceRetentionEventType - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-ComplianceRetentionEventType cmdlet to modify retention event types in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ComplianceRetentionEventType -Identity <ComplianceRuleIdParameter> [-Comment <String>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ComplianceRetentionEventType -Identity "Fabrikam Project" -Comment "Case officer is Pedro Pizarro" -``` - -This example add a comment to the retention event type named Fabrikam Project - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ComplianceTag.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ComplianceTag.md deleted file mode 100644 index 01e4ddc642..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-ComplianceTag.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ComplianceTag -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ComplianceTag - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-ComplianceTag cmdlet to modify labels in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ComplianceTag [-Identity] <ComplianceRuleIdParameter> [-Comment <String>] [-Confirm] - [-RetentionDuration <Unlimited>] [-ReviewerEmail <SmtpAddress[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ComplianceTag -Identity "HR Content" -RetentionDuration 2555 -Comment "Retain HR content for 7 years" -``` - -This example modifies the existing label named HR Content by modifying the retention duration and adding a comment. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the label that you want to modify. You can use any value that uniquely identifies the tag. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - -- A positive integer. - -- The value unlimited. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReviewerEmail -The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. - -```yaml -Type: SmtpAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/76d2fc0e-676d-4005-9ce8-c1cdb274a7e6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md deleted file mode 100644 index 758dd53753..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-HoldCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-HoldCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Security & Compliance Center. - -Note: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-HoldCompliancePolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-HoldCompliancePolicy [-Identity] <PolicyIdParameter> - [-AddExchangeLocation <MultiValuedProperty>] - [-AddPublicFolderLocation <MultiValuedProperty>] - [-AddSharePointLocation <MultiValuedProperty>] - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] [-Force] - [-RemoveExchangeLocation <MultiValuedProperty>] - [-RemovePublicFolderLocation <MultiValuedProperty>] - [-RemoveSharePointLocation <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "http://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14" -``` - -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 http://contoso.sharepoint.com/sites/teams/finance. - -- Removes public folders. - -- Updates the comment. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddExchangeLocation -The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddPublicFolderLocation -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -SharePoint Online sites can't be added to the policy until they have been indexed. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocation -The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePublicFolderLocation -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/32731a42-6c45-4574-bc1a-538a91013189.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md deleted file mode 100644 index 2d18a149b8..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-HoldComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-HoldComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-HoldComplianceRule cmdlet to modify existing preservation rules in the Security & Compliance Center. - -Note: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-HoldComplianceRule [-Identity] <ComplianceRuleIdParameter> [-Comment <String>] [-Confirm] - [-ContentDateFrom <DateTime>] [-ContentDateTo <DateTime>] [-ContentMatchQuery <String>] - [-Disabled <$true | $false>] [-HoldContent <Unlimited>] [-HoldDurationDisplayHint <Days | Months | Years>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-HoldComplianceRule -Identity "Internal Company Rule" -HoldContent 180 -``` - -This example changes the hold duration for the existing preservation rule named "Internal Company Rule". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateFrom -The ContentDateFrom parameter specifies the start date of the date range for content to include. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateTo -The ContentDateTo parameter specifies the end date of the date range for content to include. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the preservation rule is enabled or disabled. Valid input for this parameter is $true or $false. The default value is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HoldContent -The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: - -- An integer: The hold duration in days. - -- Unlimited: The content is held indefinitely. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HoldDurationDisplayHint -The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Security & Compliance Center. 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 Security & Compliance Center will display 1 year as the content hold duration. - -```yaml -Type: Days | Months | Years -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/12a4397c-3369-43d2-9c52-a6e39956e7e4.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md deleted file mode 100644 index 9d3f34572a..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md +++ /dev/null @@ -1,895 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-RetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-RetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-RetentionCompliancePolicy cmdlet to modify existing retention policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### RetryDistribution -``` -Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> - [-AddDynamicScopeLocation <MultiValuedProperty>] - [-AddExchangeLocation <MultiValuedProperty>] - [-AddExchangeLocationException <MultiValuedProperty>] - [-AddModernGroupLocation <MultiValuedProperty>] - [-AddModernGroupLocationException <MultiValuedProperty>] - [-AddOneDriveLocation <MultiValuedProperty>] - [-AddOneDriveLocationException <MultiValuedProperty>] - [-AddPublicFolderLocation <MultiValuedProperty>] - [-AddSharePointLocation <MultiValuedProperty>] - [-AddSharePointLocationException <MultiValuedProperty>] - [-AddSkypeLocation <MultiValuedProperty>] - [-AddSkypeLocationException <MultiValuedProperty>] - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] - [-Force] - [-RemoveDynamicScopeLocation <MultiValuedProperty>] - [-RemoveExchangeLocation <MultiValuedProperty>] - [-RemoveExchangeLocationException <MultiValuedProperty>] - [-RemoveModernGroupLocation <MultiValuedProperty>] - [-RemoveModernGroupLocationException <MultiValuedProperty>] - [-RemoveOneDriveLocation <MultiValuedProperty>] - [-RemoveOneDriveLocationException <MultiValuedProperty>] - [-RemovePublicFolderLocation <MultiValuedProperty>] - [-RemoveSharePointLocation <MultiValuedProperty>] - [-RemoveSharePointLocationException <MultiValuedProperty>] - [-RemoveSkypeLocation <MultiValuedProperty>] - [-RemoveSkypeLocationException <MultiValuedProperty>] - [-RestrictiveRetention <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -### TeamLocation -``` -Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> - [-AddTeamsChannelLocation <MultiValuedProperty>] - [-AddTeamsChannelLocationException <MultiValuedProperty>] - [-AddTeamsChatLocation <MultiValuedProperty>] - [-AddTeamsChatLocationException <MultiValuedProperty>] - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] - [-Force] - [-RemoveTeamsChannelLocation <MultiValuedProperty>] - [-RemoveTeamsChannelLocationException <MultiValuedProperty>] - [-RemoveTeamsChatLocation <MultiValuedProperty>] - [-RemoveTeamsChatLocationException <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "http://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14" -``` - -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 http://contoso.sharepoint.com/sites/teams/finance. - -- Removes public folders. - -- Updates the comment. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddDynamicScopeLocation -{{Fill AddDynamicScopeLocation Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddExchangeLocation -The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddExchangeLocationException -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 - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddModernGroupLocation -The AddModernGroupLocation parameter specifies the Office 365 groups to add to the list of included Office 365 groups when you aren't using the value All for the ModernGroupLocation parameter. - -You can use any value that uniquely identifies the Office 365 Group. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddModernGroupLocationException -The AddModernGroupLocationException parameter specifies the Office 365 groups to add to the list of excluded Office 365 groups when you're using the value All for the ModernGroupLocation parameter. - -You can use any value that uniquely identifies the Office 365 Group. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddPublicFolderLocation -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -SharePoint Online sites can't be added to the policy until they have been indexed. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddSkypeLocation -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: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddSkypeLocationException -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChannelLocation -{{Fill AddTeamsChannelLocation Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChannelLocationException -{{Fill AddTeamsChannelLocationException Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChatLocation -{{Fill AddTeamsChatLocation Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChatLocationException -{{Fill AddTeamsChatLocationException Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Identity, TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: Identity, TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDynamicScopeLocation -{{Fill RemoveDynamicScopeLocation Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocation -The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveExchangeLocationException -This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox - -- A distribution group or mail-enabled security group - -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveModernGroupLocation -The RemoveModernGroupLocation parameter specifies the Office 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 Office 365 Group. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveModernGroupLocationException -The RemoveModernGroupLocationException parameter specifies the Office 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 Office 365 Group. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePublicFolderLocation -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSkypeLocation -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: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSkypeLocationException -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictiveRetention -The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - -- $true: Preservation Lock is enabled for the policy. No one (including an administrator) can turn off the policy or make it less restrictive. - -- $false: Preservation Lock isn't enabled for the policy. This is the default value. - -After a policy has been locked, no one can turn off or disable it, or remove 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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChannelLocation -{{Fill RemoveTeamsChannelLocation Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChannelLocationException -{{Fill RemoveTeamsChannelLocationException Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChatLocation -{{Fill RemoveTeamsChatLocation Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChatLocationException -{{Fill RemoveTeamsChatLocationException Description}} - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/17c199c0-a714-4ae2-b916-f77c90829cca.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md deleted file mode 100644 index cff8a45df9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md +++ /dev/null @@ -1,342 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-RetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-RetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-RetentionComplianceRule cmdlet to modify existing retention rules in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-RetentionComplianceRule [-Identity] <ComplianceRuleIdParameter> - [-ApplyComplianceTag <String>] - [-Comment <String>] - [-Confirm] - [-ContentContainsSensitiveInformation <PswsHashtable[]>] - [-ContentDateFrom <DateTime>] - [-ContentDateTo <DateTime>] - [-ContentMatchQuery <String>] - [-ExcludedItemClasses <MultiValuedProperty>] - [-ExpirationDateOption <String>] - [-RetentionComplianceAction <String>] - [-RetentionDuration <Unlimited>] - [-RetentionDurationDisplayHint <Days | Months | Years>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 RetentionDurationDisplayHint Days -``` - -This example changes the hold duration for the existing retention rule named "Internal Company Rule". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ApplyComplianceTag -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. - -You can't use this parameter with the Name or PublishComplianceTag parameters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. - -This parameter uses the basic syntax @(@{Name="\<SensitiveInformationType1\>";[minCount="\<Value\>"],@{Name="\<SensitiveInformationType2\>";[minCount="\<Value\>"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). - -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see Sensitive information types inventory (https://go.microsoft.com/fwlink/p/?LinkId=529420). - -```yaml -Type: PswsHashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateFrom -The ContentDateFrom parameter specifies the start date of the date range for content to include. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDateTo -The ContentDateTo parameter specifies the end date of the date range for content to include. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMatchQuery -The ContentMatchQuery parameter specifies a content search filter. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedItemClasses -The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: - -- IPM.Note.Microsoft.Conversation - -- IPM.Note.Microsoft.Conversation.Voice - -- IPM.Note.Microsoft.Missed - -- IPM.Note.Microsoft.Missed.Voice - -- IPM.Note.Microsoft.Voicemail - -- IPM.Note.Microsoft.VoiceMessage.UA - -- IPM.Note.Microsoft.Voicemail.UM - -- IPM.Note.Microsoft.Voicemail.UM.CA - -You can specify multiple item class values by using the syntax "Value1","Value2",..."ValueN". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpirationDateOption -The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - -- CreationAgeInDays - -- ModificationAgeInDays - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionComplianceAction -The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - -- Delete - -- Keep - -- KeepAndDelete - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - -- An integer: The hold duration in days. - -- Unlimited: The content is held indefinitely. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDurationDisplayHint -The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Security & Compliance Center. 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 Security & Compliance Center will display 1 year as the content hold duration. - -```yaml -Type: Days | Months | Years -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ad2b541a-4168-4b5b-868d-3e2e42042e2d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md deleted file mode 100644 index 18e624cefb..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RetentionPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-RetentionPolicy cmdlet to change the properties of an existing retention policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-RetentionPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-Name <String>] [-RetentionId <Guid>] [-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>] [-WhatIf] - [-IsDefault] [-IsDefaultArbitrationMailbox] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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 Parameters (https://technet.microsoft.com/library/bb124388.aspx). - -## PARAMETERS - -### -Identity -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 -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 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionId -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPolicyTagLinks -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -IsDefault -This parameter is reserved for internal Microsoft use. - -To set the default retention policy for new mailboxes, use the RetentionPolicy parameter on the Set-MailboxPlan cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefaultArbitrationMailbox -This parameter is available only in the cloud-based service. - -The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. - -This parameter isn't available in on-premises deployments. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/34fbc099-4f41-4f57-867c-ad1e08513c51.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md deleted file mode 100644 index 421d501e84..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md +++ /dev/null @@ -1,446 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-TeamsRetentionCompliancePolicy -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-TeamsRetentionCompliancePolicy - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-TeamsRetentionCompliancePolicy cmdlet to modify retention policies for Microsoft Teams in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### TeamLocation -``` -Set-TeamsRetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-AddTeamsChannelLocation <MultiValuedProperty>] [-AddTeamsChannelLocationException <MultiValuedProperty>] [-AddTeamsChatLocation <MultiValuedProperty>] [-AddTeamsChatLocationException <MultiValuedProperty>] [-RemoveTeamsChannelLocation <MultiValuedProperty>] [-RemoveTeamsChannelLocationException <MultiValuedProperty>] [-RemoveTeamsChatLocation <MultiValuedProperty>] [-RemoveTeamsChatLocationException <MultiValuedProperty>] - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Set-TeamsRetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-RestrictiveRetention <$true | $false>] - [-Comment <String>] - [-Confirm] - [-Enabled <$true | $false>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### RetryDistribution -``` -Set-TeamsRetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-RetryDistribution] - [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RetentionCompliancePolicy -Identity "Teams - Regulation 123 Compliance" -AddTeamsChannelLocation "Build and Quality" -AddTeamsChatLocation "Kitty Petersen" -RemoveTeamsChannelLocation "UX Design" -RemoveTeamsChatLocation "Scott Nakamura" -Comment "Added new counsel, 4/24/18" -``` - -This example makes the following changes to the existing retention policy named "Teams - Regulation 123 Compliance": - -- Adds the mailbox for the user named Kitty Petersen to Microsoft Teams chat locations - -- Removes the mailbox for the user named Scott Nakamura from Microsoft Teams chat locations - -- Adds the group (team) mailbox named Build and Quality to Microsoft Teams channel locations - -- Removes the group (team) mailbox named UX Design from Microsoft Teams channel locations - -- Updates the comment. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the retention policy for Microsoft Teams that you want to modify. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RestrictiveRetention -The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - -- $true: Preservation Lock is enabled for the policy. No one (including an administrator) can turn off the policy or make it less restrictive. - -- $false: Preservation Lock isn't enabled for the policy. This is the default value. - -After a policy has been locked, no one can turn off or disable it, or remove 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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Microsoft Teams locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RetryDistribution -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChannelLocation -The AddTeamsChannelLocation parameter specifies the teams (group mailboxes) to add to the list of included teams whose channel messages are targeted by this policy, when you aren't using the value All for the TeamsChannelLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChannelLocationException -The AddTeamsChannelLocationException parameter specifies the teams (group mailboxes) to add to the list of excluded teams whose channel messages are targeted by this policy, when you aren't using the value All for the TeamsChannelLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChatLocation -The AddTeamsChatLocation parameter specifies the Microsoft Teams chats (mailboxes) to add to the list of included chats when you aren't using the value All for the TeamsChatLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddTeamsChatLocationException -The AddTeamsChatLocationException parameter specifies the Microsoft Teams chats (mailboxes) to add to the list of excluded chats when you're using the value All for the TeamsChatLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: TeamLocation, Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: - -- $true: The policy is enabled. This is the default value. - -- $false: The policy is disabled. - -```yaml -Type: $true | $false -Parameter Sets: TeamLocation, Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: TeamLocation, Identity -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChannelLocation -The RemoveTeamChannelLocation parameter specifies the teams (group mailboxes) to remove from the list of included teams whose channel messages are targeted by this policy, when you aren't using the value All for the TeamsChannelLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChannelLocationException -The RemoveTeamsChannelLocationException parameter specifies the teams (group mailboxes) to remove from the list of excluded teams whose channel messages are targeted by this policy, when you aren't using the value All for the TeamsChannelLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChatLocation -The RemoveTeamChatLocation parameter specifies the Microsft Teams chats (mailboxes) to remove from the list of included chats when you aren't using the value All for the TeamsChannelLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTeamsChatLocationException -The RemoveTeamsChatLocationException parameter specifies the Microsoft Teams chats (mailboxes) to remove from the list of excluded chats when you're using the value All for the TeamsChannelLocation parameter. - -You can use any value that uniquely identifies the mailbox. For example: - -- Name - -- Distinguished name (DN) - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: TeamLocation -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md deleted file mode 100644 index ae73a91f5c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-TeamsRetentionComplianceRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-TeamsRetentionComplianceRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-TeamsRetentionComplianceRule cmdlet to modify retention rules for Microsoft Teams in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-TeamsRetentionComplianceRule [-Identity] <ComplianceRuleIdParameter> [-Comment <Object>] [-RetentionComplianceAction <String>] [-RetentionDuration <Unlimited>] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### Example 1 -``` -Set-TeamsRetentionComplianceRule -Identity "Teams - Internal Company Rule" -RetentionDuration 180 -``` - -This example changes the hold duration for the existing retention rule for Microsoft Teams named "Teams - Internal Company Rule". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the retention rule for Microsoft Teams that you want to modify. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionComplianceAction -The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - -- Delete - -- Keep - -- KeepAndDelete - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - -- An integer: The hold duration in days. - -- Unlimited: The content is held indefinitely. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md deleted file mode 100644 index 5b538c7299..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-ManagedFolderAssistant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Start-ManagedFolderAssistant cmdlet to immediately start messaging records management (MRM) processing of mailboxes that you specify. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [-HoldCleanup] [-InactiveMailbox] [-AggMailboxCleanup] [<CommonParameters>] -``` - -## 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. - -If you use these parameters in scheduled commands or scripts, we recommend that you review them and make any necessary 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-ManagedFolderAssistant -Identity "Chris" -``` - -This example processes the mailbox for a user with the alias Chris. - -### -------------------------- Example 2 -------------------------- -``` -Get-Mailbox -Anr Chr -DomainController DC01 | Start-ManagedFolderAssistant -``` - -This example uses the Get-Mailbox command to retrieve all the mailboxes that resolve from the ambiguous name resolution (ANR) search on the string "Chr" in the domain DC01 (for example, users such as Chris Ashton, Christian Hess, and Christa Geller), and the results are piped to the Start-ManagedFolderAssistant cmdlet for processing. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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 2016 (https://technet.microsoft.com/library/ee364755.aspx). - -```yaml -Type: -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InactiveMailbox -This parameter is available only in the cloud-based service. - -The InactiveMailbox specifies whether the command runs only on inactive mailboxes. You don't need to specify a value with this switch.. - -An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed - -When you use this switch, items aren't moved from the inactive mailbox to the archive mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggMailboxCleanup -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/75d840ea-5abc-44bb-b361-e81561fa1b04.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md deleted file mode 100644 index fefb9b22af..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010 -title: Start-RetentionAutoTagLearning -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Start-RetentionAutoTagLearning - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Start-RetentionAutoTagLearning cmdlet to start auto-tagging for a specified mailbox or to cross-validate auto-tagging results for the mailbox. - -Messaging records management (MRM) must be configured before the Start-RetentionAutoTagLearning cmdlet can be used. For more information, see Understanding Retention Tags and Retention Policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### CrossValidate -``` -Start-RetentionAutoTagLearning [-Identity] <MailboxIdParameter> [-CrossValidate] [-NumberOfSegments <Int32>] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### Train -``` -Start-RetentionAutoTagLearning [-Identity] <MailboxIdParameter> [-Clear] [-Train] - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Start-RetentionAutoTagLearning -Identity "Joe Healy" -Train -``` - -This example sets user Joe Healy's mailbox to train. - -### -------------------------- Example 2 -------------------------- -``` -Start-RetentionAutoTagLearning -Identity "Joe Healy" -CrossValidate -NumberOfSegments 15 -``` - -This example sets user Joe Healy's mailbox to cross-validate and sets the number of segments for cross-validation to 15. - -### -------------------------- Example 3 -------------------------- -``` -Start-RetentionAutoTagLearning -Identity "Joe Healy" -Clear -``` - -This example sets user Joe Healy's mailbox to clear all retention policy tags assigned by auto-tagging. - -## PARAMETERS - -### -CrossValidate -The CrossValidate switch specifies whether items in the specified mailbox are being auto-tagged. - -```yaml -Type: SwitchParameter -Parameter Sets: CrossValidate -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter identifies the mailbox. You can use one of the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Clear -The Clear switch specifies whether to clear auto-tags from the specified mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: Train -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfSegments -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. - -The minimum value is 2. - -The NumberOfSegments parameter can be used only in conjunction with the CrossValidate parameter. - -```yaml -Type: Int32 -Parameter Sets: CrossValidate -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Train -The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. This switch is especially useful for retraining. No values are required with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Train -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b760ee59-89f0-4d73-94e4-ac816584b13c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md deleted file mode 100644 index b5e401b7ff..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Stop-ManagedFolderAssistant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Stop-ManagedFolderAssistant - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Stop-ManagedFolderAssistant cmdlet to immediately stop messaging records management (MRM) from processing users' mailboxes on the specified servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Stop-ManagedFolderAssistant [[-Identity] <ServerIdParameter>] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Stop-ManagedFolderAssistant -``` - -This example executes the Stop-ManagedFolderAssistant command without parameters. The Managed Folder Assistant is stopped as soon as processing of the current mailbox is completed on the current server. - -### -------------------------- Example 2 -------------------------- -``` -Stop-ManagedFolderAssistant -Identity ExchSrvr1, Exchsrvr2 -``` - -This example stops the Managed Folder Assistant on the servers ExchSrvr1 and Exchsrvr2. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -Identity -The Identity parameter specifies the names of servers on which the Managed Folder Assistant is to be stopped. If a server isn't specified, the Managed Folder Assistant on the local server is stopped. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/82c2215b-88ec-4c20-a2e8-245b915d8394.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md deleted file mode 100644 index b6bc790276..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Validate-RetentionRuleQuery -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Validate-RetentionRuleQuery - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Validate-RetentionRuleQuery cmdlet to validate the Keword Query Language (KQL) content search filters for retention rules. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Validate-RetentionRuleQuery -KqlQueryString <String> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Validate-RetentionRuleQuery -KqlQueryString 'from:"Ann Beebe" AND subject:northwind' -``` - -This example validates the specified KQL content search filter. - -## PARAMETERS - -### -KqlQueryString -The KqlQueryString parameter specifies the KQL text search string that you want to validate. - -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7e630b2a-d199-495e-91f7-349d426f6e8c.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-JournalArchiving.md b/exchange/exchange-ps/exchange/policy-and-compliance/Disable-JournalArchiving.md deleted file mode 100644 index e517a21e5b..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-JournalArchiving.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Disable-JournalArchiving -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Disable-JournalArchiving - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Disable-JournalArchiving cmdlet to disable journal archiving for specific users. Microsoft Office 365 journal archiving uses mailboxes in Exchange Online to record or journal messages for mailboxes in on-premises organizations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-JournalArchiving [-Identity] <MailboxIdParameter> [-Confirm] [-PreserveMailUser] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -For each on-premise mailbox that's configured for journal archiving in Office 365, a mail user (also known as a mail-enabled user) and a journal archive mailbox are created in Exchange Online. The mail user routes the incoming journaled messages from the on-premises organization, and the journal archive mailbox stores the journaled messages in the cloud. - -The Disable-JournalArchiving cmdlet removes the mail user and converts the journal archive mailbox into an inactive mailbox. The inactive mailbox remains fully available for In-place eDiscovery. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-JournalArchiving -Identity TimothyAmaral_Archive -``` - -This example disables the journal archiving for the user named Timothy Amaral. Timothy's journal archive mailbox in Exchange Online is named TimothyAmaral\_Archive. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreserveMailUser -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4425a74d-f63e-413f-b42d-8c3ae8d53791.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md deleted file mode 100644 index 6db652e041..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-OutlookProtectionRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Disable-OutlookProtectionRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Disable-OutlookProtectionRule cmdlet to disable an existing Microsoft Outlook protection rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-OutlookProtectionRule [-Identity] <RuleIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Outlook protection rules are administrator-created rules applied before a user sends a message using Outlook. Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. - -For more information, see Outlook protection rules (https://technet.microsoft.com/library/dd638178.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-OutlookProtectionRule -Identity "Project Contoso" -``` - -This example disables the Outlook protection rule Project Contoso. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f6be04e8-bd1c-41ee-b410-e832de66048f.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Enable-JournalRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Enable-JournalRule.md deleted file mode 100644 index a639360c03..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Enable-JournalRule.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-JournalRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Enable-JournalRule cmdlet to enable an existing journal rule on a Mailbox server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-JournalRule [-Identity] <RuleIdParameter> [-Confirm] [-DomainController <Fqdn>] -[-WhatIf] [<CommonParameters>] -``` - -## 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 (https://technet.microsoft.com/library/aa998649.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-JournalRule "Brokerage Communications" -``` - -This example enables the existing journal rule Brokerage Communications. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9a4b01b9-27d4-41e6-9573-86e27e82de2d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md deleted file mode 100644 index cb7c67e848..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-OutlookProtectionRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Enable-OutlookProtectionRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Enable-OutlookProtectionRule cmdlet to enable an existing Outlook protection rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-OutlookProtectionRule [-Identity] <RuleIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd638178.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-OutlookProtectionRule -Identity "Project Contoso" -``` - -This example enables the Outlook protection rule Project Contoso. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/30344629-5705-4827-b3d1-d56b036d0eac.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Export-JournalRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance/Export-JournalRuleCollection.md deleted file mode 100644 index 6672fdaa25..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Export-JournalRuleCollection.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-JournalRuleCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Export-JournalRuleCollection - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Export-JournalRuleCollection cmdlet to export the journal rules in your organization to an XML file. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-JournalRuleCollection [[-Identity] <RuleIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-ExportLegacyRules] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$file = Export-JournalRuleCollection; Set-Content -Path "C:\MyDocs\JournalRules.xml" -Value $file.FileData -Encoding Byte -``` - -This example exports journal rules in a two-step process. In the first step, the Export-JournalRuleCollection cmdlet exports journal rules to the variable $file. In the second step, the Set-Content cmdlet saves the exported data to the XML file JournalRules.xml. - -### -------------------------- Example 2 -------------------------- -``` -$file = Export-JournalRuleCollection -ExportLegacyRules; Set-Content -Path "C:\MyDocs\Ex2007-JournalRules.xml" -Value $file.FileData -Encoding Byte -``` - -In Exchange Server 2010, this example exports legacy journal rules to an XML file using the two-step process similar to the preceding example. In the first step, the Export-JournalRuleCollection cmdlet is used with the ExportLegacyRules switch to export legacy rules to the array $file. In the second step, the exported data is saved to the XML file Ex2007-JournallRules.xml. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```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 -``` - -### -ExportLegacyRules -This parameter is available or functional only in Exchange Server 2010. - -The ExportLegacyRules switch specifies whether to export Exchange 2007 journal rules. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c6309ab0-77fe-4feb-b2ac-4844de841996.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Export-TransportRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance/Export-TransportRuleCollection.md deleted file mode 100644 index 8cfa187506..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Export-TransportRuleCollection.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Export-TransportRuleCollection cmdlet to export the transport rules in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-TransportRuleCollection [[-Identity] <RuleIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-ExportLegacyRules] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-TransportRuleCollection cmdlet can be used to export the transport rule collection in your organization. The format of the exported transport rule collection changed in Exchange Server 2013. The new format can't be imported into Exchange Server 2010. - -Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see Set-Content (https://go.microsoft.com/fwlink/p/?linkId=156132). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$file = Export-TransportRuleCollection; Set-Content -Path "C:\MyDocs\Rules.xml" -Value $file.FileData -Encoding Byte -``` - -This example exports transport rules. Rule data is first exported to the variable $file, and then written to the XML file Rules.xml in the C:\\MyDocs folder. - -### -------------------------- Example 2 -------------------------- -``` -$file = Export-TransportRuleCollection -ExportLegacyRules; Set-Content -Path "C:\MyDocs\LegacyRules.xml" -Value $file.FileData -Encoding Byte -``` - -In Exchange Server 2010, this example exports legacy transport rules created in Exchange 2007 using the ExportLegacyRules switch. The cmdlet should be run from an Exchange 2010 Hub Transport server. The exported rules collection can then be imported to Exchange 2010 using the Import-TransportRuleCollection cmdlet. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportLegacyRules -This parameter is available or functional only in Exchange Server 2010. - -The ExportLegacyRules switch is used to export legacy transport rules. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -This cmdlet is available only in on-premises Exchange, and is functional only in Exchange Server 2010. - -The Identity parameter specifies the name or GUID of a transport rule to be exported. - -```yaml -Type: RuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bfdb6ced-cd81-49f1-a929-4d76dbaf5590.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-ActivityAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-ActivityAlert.md deleted file mode 100644 index d215c77776..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-ActivityAlert.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ActivityAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ActivityAlert cmdlet to view activity alerts in the Security & Compliance Center. Activity alerts send you email notifications when users perform specific activities in Office 365. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ActivityAlert [[-Identity] <ComplianceRuleIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ActivityAlert | Format-List Disabled,Name,Description,Operation,UserId,NotifyUser -``` - -This example returns a summary list of all activity alerts. - -### -------------------------- Example 2 -------------------------- -``` -Get-ActivityAlert -Identity "All Mailbox Activities" -``` - -This example returns detailed information about the activity alert named All Mailbox Activities. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3ae133df-cd0e-4782-b41a-973ca9578776.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-AdministrativeUnit.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-AdministrativeUnit.md deleted file mode 100644 index 9263c1d363..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-AdministrativeUnit.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-AdministrativeUnit -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-AdministrativeUnit - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Azure Active Directory containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users. - -Note: Administrative units are only available in Azure Active Directory Premium. You create and manage administrative units in Azure AD PowerShell. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AdministrativeUnit [[-Identity] <AdministrativeUnitIdParameter>] [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AdministrativeUnit -``` - -This example returns a summary list of all Azure Active Directory administrative units. - -### -------------------------- Example 2 -------------------------- -``` -Get-AdministrativeUnit -Identity "West Coast" | Format-List -``` - -This example returns detailed information about the administrative unit with the display name West Coast. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the administrative unit that you want to view. You can use any value that uniquely identifies the administrative unit. For example: - -- Display name (this value is the same in Azure AD PowerShell) - -- ExternalDirectoryObjectId (this GUID value is the same as the ObjectId property in Azure AD PowerShell) - -- Name (GUID value) - -- Distinguished name (DN) - -- GUID (different value than Name) - -```yaml -Type: AdministrativeUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cadcbb11-66a3-4f22-a169-161c15f1e315.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-JournalRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-JournalRule.md deleted file mode 100644 index 599de59eb0..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-JournalRule.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-JournalRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-JournalRule cmdlet to view the journal rules in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-JournalRule [[-Identity] <RuleIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-JournalRule -``` - -This example retrieves all journal rules configured in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-JournalRule "Brokerage Communications" | Format-List -``` - -This example retrieves the specific journal rule Brokerage Communications and pipes the output to the Format-List cmdlet to view all the parameters of the rule. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7620913f-cf28-4e82-983f-61a79f0b6e5a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-MessageClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-MessageClassification.md deleted file mode 100644 index 99940c6e6d..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-MessageClassification.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MessageClassification cmdlet to view existing message classifications in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MessageClassification [[-Identity] <MessageClassificationIdParameter>] -[-DomainController <Fqdn>] [-IncludeLocales] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MessageClassification -``` - -This example lists all message classifications in your organization. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the message classification instance that you want to view. When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Administrative Name". - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeLocales -The IncludeLocales switch specifies whether the command output includes the message classification locale data. When you use the IncludeLocales switch, the output includes the message classification locale data. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2bc71c83-4d16-4c16-9ce6-751f4e60b991.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-OutlookProtectionRule.md deleted file mode 100644 index 1c3f5cea14..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-OutlookProtectionRule.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OutlookProtectionRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-OutlookProtectionRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-OutlookProtectionRule cmdlet to retrieve Microsoft Outlook protection rules configured in an organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OutlookProtectionRule [[-Identity] <RuleIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd638178.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OutlookProtectionRule -``` - -This example gets details of all Outlook protection rules configured in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-OutlookProtectionRule ProjectContoso | Format-List -``` - -This example gets all properties of the Outlook protection rule ProjectContoso. - -The Identity parameter is positional. When used after the cmdlet name, the parameter value can be specified without providing the parameter label. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5a5197f2-a219-4dd2-abe3-d0e8722f414a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-ProtectionAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-ProtectionAlert.md deleted file mode 100644 index fcff62cb7c..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-ProtectionAlert.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-ProtectionAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-ProtectionAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-ProtectionAlert cmdlet to view alert policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ProtectionAlert [[-Identity] <ComplianceRuleIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ProtectionAlert | Format-List Name,Category,Comment,NotifyUser -``` - -This example returns a summary list of all alert policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-ProtectionAlert -Identity "Malicious Email Campaign" -``` - -This example returns detailed information about the alert policy named Malicious Email Campaign. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/82b4af4c-2ea5-4f0f-854f-4811f4072043.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md deleted file mode 100644 index 96628ee7e1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-SupervisoryReviewPolicyV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-SupervisoryReviewPolicyV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-SupervisoryReviewPolicyV2 cmdlet to view supervisory review policies in the Office 365 Security & Compliance Center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SupervisoryReviewPolicyV2 [[-Identity] <PolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SupervisoryReviewPolicyV2 -``` - -This example returns a summary list of all supervisory review policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-SupervisoryReviewPolicyV2 -Identity "EU Brokers Policy" | Format-List -``` - -This example returns detailed information for the supervisory review policy named EU Brokers Policy. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ce966c7e-a0ba-4c7b-afc7-d9a0a7f3f831.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md deleted file mode 100644 index 982c7ebfc9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-SupervisoryReviewRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-SupervisoryReviewRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Office 365 Security & Compliance Center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SupervisoryReviewRule [[-Identity] <ComplianceRuleIdParameter>] [-Policy <PolicyIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SupervisoryReviewRule -``` - -This example returns a summary list of all supervisory review rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-SupervisoryReviewRule -Identity "EU Brokers Rule" | Format-List -``` - -This example returns detailed information for the supervisory review rule named EU Brokers Rule. - -### -------------------------- Example 3 -------------------------- -``` -Get-SupervisoryReviewRule -Policy "EU Brokers Policy" -``` - -This example returns the rule that assigned to the supervisory review policy named EU Brokers Policy. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter filters the results by supervisory review policy that's assigned to the rule. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ea53db29-829e-4a5d-9874-a0e135a26720.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRule.md deleted file mode 100644 index 30a7d56af2..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRule.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-TransportRule cmdlet to view transport rules (mail flow rules) in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportRule [[-Identity] <RuleIdParameter>] [-DomainController <Fqdn>] - [-State <Enabled | Disabled>] [-DlpPolicy <String>] - [-Filter <String>] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportRule -``` - -This example returns a summary list of all rules in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportRule "Ethical Wall - Sales and Brokerage Departments" | Format-List -``` - -This example returns detailed information for the rule named "Ethical Wall - Sales and Brokerage Departments". - -For more information about pipelining, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx). For more information about how to work with the output of a command, see Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -### -------------------------- Example 3 -------------------------- -``` -Get-TransportRule -DlpPolicy "PII (U.S.)" -``` - -This example returns a summary list of the rules that enforce the DLP policy named PII (U.S.) in your organization. - -### -------------------------- Example 4 -------------------------- -``` -Get-TransportRule | Where {$_.DlpPolicy -ne $null} -``` - -This example returns a summary list of all rules that enforce DLP policies in your organization. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -State -The State parameter specifies filters the results by enabled or disabled rules. Valid values are: - -- Enabled: Only enabled rules are returned in the results. - -- Disabled: Only disabled rules are returned in the results. - -If you don't use this parameter, the command returns all rules, both enabled and disabled. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpPolicy -The DlpPolicy parameter filters the results by the named of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks ("). - -DLP policies in your organization allow you to prevent unintentional disclosure of sensitive information. Each DLP policy is enforced using a set of transport rules. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter filters the results by using an OPath. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule. - -This parameter uses the syntax -Filter "Description -like '\*\<text\>\*'". For example, -Filter "Description -like \*192.168.1.1\*'". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/63a14c30-331d-458b-91d1-71d28a6e3d5a.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRuleAction.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRuleAction.md deleted file mode 100644 index c47dc0cd1a..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRuleAction.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-TransportRuleAction cmdlet to view the actions that are available for transport rules (mail flow rules). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportRuleAction [[-Name] <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportRuleAction -``` - -This example returns a summary list of all actions. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportRuleAction -Name DeleteMessage | Format-List -``` - -This example retrieves detailed information about the action named DeleteMessage. - -For more information about pipelining, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx). For more information about how to work with the output of a command, see Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/60829f04-94a0-4228-a66c-f467aaca438b.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRulePredicate.md b/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRulePredicate.md deleted file mode 100644 index d6aabc56ad..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Get-TransportRulePredicate.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-TransportRulePredicate cmdlet to view the predicates (conditions and exceptions) that are available for transport rules (mal flow rules). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TransportRulePredicate [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Collectively, the conditions and exceptions in rules are known as predicates, because for every condition, there's a corresponding exception that uses the exact same settings and syntax. The only difference is conditions specify messages to include, while exceptions specify messages to exclude. That's why the output of this cmdlet doesn't list exceptions separately. Also, the names of some of the predicates that are returned by this cmdlet are different than the corresponding parameter names in the New-TransportRule and Set-TransportRule cmdlets. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TransportRulePredicate -``` - -This example returns a summary list of all predicates. - -### -------------------------- Example 2 -------------------------- -``` -Get-TransportRulePredicate -Name SubjectMatches | Format-List -``` - -This example returns detailed information about the predicate named SubjectMatches. - -For more information about pipelining, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx). For more information about how to work with the output of a command, see Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -### -------------------------- Example 3 -------------------------- -``` -Get-TransportRulePredicate | Where {$_.Name -like "*Attachment*"} -``` - -This example returns a summary list of all predicates that have Attachment in the name. - -For more information about how to work with the output of a command, see Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3054220d-0973-4832-840e-b9ef9e7c9064.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Import-JournalRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance/Import-JournalRuleCollection.md deleted file mode 100644 index 4e742c14a1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Import-JournalRuleCollection.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-JournalRuleCollection -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Import-JournalRuleCollection - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Import-JournalRuleCollection cmdlet to import journal rules from an XML file. You can import a journal rule collection you previously exported as a backup, or import rules you exported from an older version of Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Import-JournalRuleCollection [-FileData] <Byte[]> [[-Identity] <RuleIdParameter>] [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-JournalRuleCollection cmdlet imports a journal rule collection you previously exported. - -Importing a journal rule collection from an XML file removes or overwrites all pre-existing journal rules in your organization. Make sure that you have a backup of your current journal rule collection before you import and overwrite your current journal rules. - -Importing file data is a two-step process. First you must load the data to a variable using the Get-Content cmdlet, and then use that variable to transmit the data to the cmdlet. - -For more information about how to export a journal rule collection to an XML file, see Export-JournalRuleCollection. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -[Byte[]]$Data = Get-Content -Path "C:\JournalRules\ExportedJournalRules.xml" -Encoding Byte -ReadCount 0; Import-JournalRuleCollection -FileData $Data -``` - -This example imports journal rules from the XML file ExportedJournalRules.xml in a two-step process. - -The first step retrieves journal rules from the previously exported XML file ExportedJournalRules.xml using the Get-Content cmdlet, and then stores the results in the variable $Data. The second step retrieves data from the variable $Data and imports journal rules to your organization, overwriting existing journal rules. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the variable name that contains the content of the XML file. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\<filename\>" -ReadCount 0\)\). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 -``` - -### -Identity -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 -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89ecb780-0998-4c61-ba43-7d17b49df363.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Import-TransportRuleCollection.md b/exchange/exchange-ps/exchange/policy-and-compliance/Import-TransportRuleCollection.md deleted file mode 100644 index a6ae054ba9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Import-TransportRuleCollection.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# Import-TransportRuleCollection - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Import-TransportRuleCollection cmdlet to import a transport rule collection. You can import a rule collection you previously exported as a backup, or import rules that you've exported from an older version of Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Import-TransportRuleCollection [-FileData] <Byte[]> [[-Identity] <RuleIdParameter>] [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Importing a transport rule collection from an XML file removes or overwrites all pre-existing transport rules that were defined in your organization. Make sure that you have a backup of your current transport rule collection before you import and overwrite your current transport rules. - -Importing file data is a two-step process. First you must load the data to a variable using the Get-Content cmdlet, and then use that variable to transmit the data to the cmdlet. - -For information about how to export a transport rule collection to an XML file, see Export-TransportRuleCollection. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -[Byte[]]$Data = Get-Content -Path "C:\TransportRules\ExportedRules.xml" -Encoding Byte -ReadCount 0; Import-TransportRuleCollection -FileData $Data -``` - -This example imports a transport rule collection from the XML file ExportedRules.xml. - -## PARAMETERS - -### -FileData -The FileData parameter specifies the variable name that contains the content of the XML file. The content is retrieved using the Get-Content cmdlet. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -This cmdlet is available only in on-premises Exchange, and is only functional in Exchange Server 2010. - -The Identity parameter specifies the transport rule to be imported. Use either the GUID or the name of the 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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter specifies that the command will override any errors or warnings encountered during the import operation. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/880b3124-76c5-4212-a8b9-8f4523f8cbe6.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md deleted file mode 100644 index fe2f95bc7f..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Install-UnifiedCompliancePrerequisite -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Install-UnifiedCompliancePrerequisite - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -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 Security & Compliance Center to store preservation policies that act on content in SharePoint Online sites. - -Typically, you don't need to run this cmdlet. You use this cmdlet for troubleshooting and diagnostics. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Initialize -``` -Install-UnifiedCompliancePrerequisite [-ForceInitialize] [-PolicyCenterSiteOwner <SmtpAddress>] - [<CommonParameters>] -``` - -### LoadOnly -``` -Install-UnifiedCompliancePrerequisite [-LoadOnly] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the following information about the Compliance Policy Center: - -- SharepointRootSiteUrl: This value is typically https://\<domain\>.onmicrosoft.com/. - -- SharepointTenantAdminUrl: This value uses the format https://\<domain\>-admin.onmicrosoft.com/. - -- SharepointSuccessInitializedUtc: The time that the Compliance Policy Center was last initialized in coordinated universal time (UTC). - -- SharepointPolicyCenterSiteUrl: This value is typically https://\<domain\>.onmicrosoft.com/sites/compliancepolicycenter. - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -### -------------------------- Example 2 -------------------------- -``` -Install-UnifiedCompliancePrerequisite -LoadOnly -``` - -This example loads the Compliance Policy Center using the current settings. - -### -------------------------- Example 3 -------------------------- -``` -Install-UnifiedCompliancePrerequisite -ForceInitialize -``` - -This example recreates the Compliance Policy Center, even if the site has already been created. - -## PARAMETERS - -### -ForceInitialize -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Initialize -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadOnly -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. - -```yaml -Type: SwitchParameter -Parameter Sets: LoadOnly -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyCenterSiteOwner -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bd658b86-a548-4172-8a76-36c1508b72b5.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-ActivityAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/New-ActivityAlert.md deleted file mode 100644 index 3c84f9e5c7..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-ActivityAlert.md +++ /dev/null @@ -1,554 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ActivityAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ActivityAlert cmdlet to create activity alerts in the Security & Compliance Center. Activity alerts send you email notifications when users perform specific activities in Office 365. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnomalousOperationAuditAlert -``` -New-ActivityAlert -Multiplier <Double> -Name <String> -NotifyUser <MultiValuedProperty> [-Operation <MultiValuedProperty>] -Type <Custom | ElevationOfPrivilege | SimpleAggregation | AnomalousAggregation> - [-Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others>] - [-Condition <String>] - [-Confirm] - [-Description <String>] - [-Disabled <$true | $false>] - [-DomainController <Fqdn>] - [-EmailCulture <CultureInfo>] - [-RecordType <ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence>] - [-ScopeLevel <SingleUser | AllUsers>] - [-Severity <Low | Medium | High | None>] - [-UserId <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -New-ActivityAlert -Name <String> -NotifyUser <MultiValuedProperty> -Operation <MultiValuedProperty> [-Type <Custom | ElevationOfPrivilege | SimpleAggregation | AnomalousAggregation>] - [-Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others>] - [-Confirm] - [-Description <String>] - [-Disabled <$true | $false>] - [-DomainController <Fqdn>] - [-EmailCulture <CultureInfo>] - [-RecordType <ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence>] - [-Severity <Low | Medium | High | None>] - [-UserId <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### SimpleAggregationAuditAlert -``` -New-ActivityAlert -Name <String> -NotifyUser <MultiValuedProperty> [-Operation <MultiValuedProperty>] -Threshold <Int32> -TimeWindow <Int32> -Type <Custom | ElevationOfPrivilege | SimpleAggregation | AnomalousAggregation> - [-Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others>] - [-Condition <String>] - [-Confirm] - [-Description <String>] - [-Disabled <$true | $false>] - [-DomainController <Fqdn>] - [-EmailCulture <CultureInfo>] - [-RecordType <ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence>] - [-ScopeLevel <SingleUser | AllUsers>] - [-Severity <Low | Medium | High | None>] - [-UserId <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -### ElevationOfPrivilegeAuditAlert -``` -New-ActivityAlert -Name <String> -NotifyUser <MultiValuedProperty> -Type <Custom | ElevationOfPrivilege | SimpleAggregation | AnomalousAggregation> - [-Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others>] - [-Confirm] - [-Description <String>] - [-Disabled <$true | $false>] - [-DomainController <Fqdn>] - [-EmailCulture <CultureInfo>] - [-RecordType <ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence>] - [-Severity <Low | Medium | High | None>] - [-UserId <MultiValuedProperty>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ActivityAlert -Name "External Sharing Alert" -Operation sharingset,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: sharingset and 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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name of the activity alert. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -The Operation parameter specifies the activitiesthat trigger activity alerts. - -A valid value for this parameter is an activity that's available in the Office 365 audit log. For a description of these activities, see Search the audit log in the Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=824986). - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can't use this parameter if the Type parameter value is ElevationOfPrivilege. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: MultiValuedProperty -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -The Threshold parameter specifies the number of events that trigger an activity alert in the time interval that's specified by the TimeWindow parameter. The minimum value for this parameter is 3. - -You can only use this parameter with the Type parameter value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: SimpleAggregationAuditAlert -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeWindow -The TimeWindow parameter specifies the time window in minutes that's used by the Threshold parameter. - -You can only use this parameter with the Type parameter value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: SimpleAggregationAuditAlert -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the type alert. Valid values are: - -- Custom: An alert is created for the activities you specify with the Operation parameter. Typically, you don't need to use this value (if you don't use the Type parameter, and you specify the activities with the Operations parameter, the value Custom is automatically added to the Type property). - -- ElevationOfPrivilege: An alert is created for a predefined list of elevation of privilege activities (Operation parameter values). The activities are Add-RoleGroupMember, New-ManagementRoleAssignment, Add member to role., Update-RoleGroupMember, New-RoleGroup, Set-RoleGroup, Set-Mailbox, and Set-ManagementRoleEntry. You can't use the Operation parameter when you use the ElevationOfPrivilege value (on the New-ActivityAlert or Set-ActivityAlert cmdlets). - -- 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: Custom | ElevationOfPrivilege | SimpleAggregation | AnomalousAggregation -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert, ElevationOfPrivilegeAuditAlert -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Custom | ElevationOfPrivilege | SimpleAggregation | AnomalousAggregation -Parameter Sets: Default -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Category -The Category parameter specifies a category for the activity alert. Valid values are: - -- None (This is the default value) - -- DataLossPrevention - -- ThreatManagement - -- DataGovernance - -- AccessGovernance - -- Others - -```yaml -Type: None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -The Condition parameter specifies filter conditions for event aggregation. - -```yaml -Type: String -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the activity alert is enabled or disabled. Valid values are: - -- $true: The activity alert is disabled. - -- $false: The activity alert is enabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailCulture -The EmailCulture parameter specifies the language of the notification email message. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -The RecordType parameter specifies a record type label for the activity alert. - -Valid values are: - -- AzureActiveDirectory - -- AzureActiveDirectoryAccountLogon - -- AzureActiveDirectoryStsLogon - -- ComplianceDLPExchange - -- ComplianceDLPSharePoint - -- CRM - -- DataCenterSecurityCmdlet - -- Discovery - -- ExchangeAdmin - -- ExchangeAggregatedOperation - -- ExchangeItem - -- ExchangeItemGroup - -- MicrosoftTeams - -- MicrosoftTeamsAddOns - -- MicrosoftTeamsSettingsOperation - -- OneDrive - -- PowerBIAudit - -- SecurityComplianceCenterEOPCmdlet - -- SharePoint - -- SharePointFileOperation - -- SharePointSharingOperation - -- SkypeForBusinessCmdlets - -- SkypeForBusinessPSTNUsage - -- SkypeForBusinessUsersBlocked - -- Sway - -- ThreatIntelligence - -- Yammer - -You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - -```yaml -Type: ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeLevel -The ScopeLevel parameter specifies the scope for activity alerts that use the Type parameter values SimpleAggregation or AnomalousAggregation. Valid values are: - -- SingleUser (This is the default value) - -- AllUsers - -```yaml -Type: SingleUser | AllUsers -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Severity -The Severity parameter specifies a severity level for the activity alert. Valid values are: - -- None - -- Low (This is the default value) - -- Medium - -- High - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The UserId parameter specifies who you want to monitor. - -- If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. - -- If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. - -You can only use this parameter with the Type parameter values Custom or ElevationOfPrivilege. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c84fb3ae-c608-4ff2-9d1b-3c423a815d9e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-MessageClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance/New-MessageClassification.md deleted file mode 100644 index 023043710a..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-MessageClassification.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MessageClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-MessageClassification cmdlet to create a message classification instance in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Localized -``` -New-MessageClassification [-Name] <String> -DisplayName <String> -Locale <CultureInfo> -SenderDescription <String> - [-Confirm] - [-DomainController <Fqdn>] - [-RecipientDescription <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -New-MessageClassification [-Name] <String> -DisplayName <String> -SenderDescription <String> - [-ClassificationID <Guid>] - [-Confirm] - [-DisplayPrecedence <Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest>] - [-DomainController <Fqdn>] - [-PermissionMenuVisible <$true | $false>] - [-RecipientDescription <String>] - [-RetainClassificationEnabled <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you create a new message classification, you can specify the message classification as a transport rule predicate. Before Microsoft Outlook and Outlook on the web users can apply the message classification to messages, you need to update the end-user systems with the message classification XML file created by the Export-OutlookClassification.ps1 script file. The Export-OutlookClassification.ps1 script file is located in the %ExchangeInstallPath%Scripts directory. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-MessageClassification -Name MyMessageClassification -DisplayName "New Message Classification" -SenderDescription "This is the description text" -``` - -This example creates the message classification named MyMessageClassification with the following properties: - -- The display name is New Message Classification. - -- The sender description is "This is the description text". - -### -------------------------- Example 2 -------------------------- -``` -New-MessageClassification MyMessageClassification -Locale es-ES -DisplayName "España Example" -SenderDescription "Este es el texto de la descripción" -``` - -This example creates a locale-specific (Spanish - Spain) version of an existing message classification MyMessageClassification. - -## PARAMETERS - -### -DisplayName -The DisplayName parameter specifies the display name for the message classification instance. The display name is used by Outlook users to select the appropriate message classification before they send a message. - -The message classification XML file must be present on the sender's computer for the display name to be displayed. - -If the UserDisplayEnabled parameter is set to $true, the display name is displayed for the recipient, even if no message classification XML file is installed. - -When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Display Name". The DisplayName parameter can contain a maximum of 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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale -The Locale parameter specifies a locale-specific version of the message classification. You must also pass the Identity parameter of the default existing message classification when you create a new locale-specific version. - -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://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the administrative name for the message classification instance. The name is used to administer the message classification instance. When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Adminstrative Name". The Name parameter can contain a maximum 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 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderDescription -The SenderDescription parameter specifies the purpose of the message classification to the sender. The value of this parameter is used by Outlook users to select the appropriate message classification before they send a message. Enclose the value in quotation marks ("), for example, "This is the sender description that explains when to use this message classification". The SenderDescription parameter can contain a maximum of 1,024 characters. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClassificationID -The ClassificationID parameter specifies a classification ID 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 enterprise. - -```yaml -Type: Guid -Parameter Sets: Identity -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. Although Outlook only lets a user specify a single classification per 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. - -Valid input for the DisplayPrecedence parameter is Highest, Higher, High, MediumHigh, Medium, MediumLow, Low, Lower and Lowest. - -The default value is Medium. - -```yaml -Type: Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest -Parameter Sets: Identity -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: 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 -``` - -### -PermissionMenuVisible -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. - -If you set the PermissionMenuVisible parameter to $false, users won't be able to assign this message classification to the messages they are composing. However, messages received with this message classification still display the classification information. - -The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: Identity -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 -``` - -### -RecipientDescription -The RecipientDescription parameter specifies the purpose of the message classification to the recipient. The value of this parameter is shown to Outlook users when they receive a message that has this message classification. Enclose the value in quotation marks ("), for example, "This is the recipient description that explains how to treat the message that has been classified". The RecipientDescription parameter can contain a maximum of 1,024 characters. - -If you don't enter a value for this parameter, the description that you enter for the SenderDescription parameter is used. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainClassificationEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/be73fade-7071-41f0-aa51-458bc215f90e.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-ProtectionAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/New-ProtectionAlert.md deleted file mode 100644 index ddcb723ea5..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-ProtectionAlert.md +++ /dev/null @@ -1,542 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-ProtectionAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-ProtectionAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-ProtectionAlert cmdlet to create alert policies in the Security & Compliance Center. Alert policies contain conditions that define the user activities to monitor, and the notification options for email alerts and entries in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-ProtectionAlert - -Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others> - -Name <String> -NotifyUser <MultiValuedProperty> -ThreatType <None | Malware | Phish | Activity> - [-AggregationType <None | SimpleAggregation | AnomalousAggregation>] [-AlertBy <MultiValuedProperty>] - [-AlertFor <MultiValuedProperty>] [-Comment <String>] [-Confirm] [-Description <String>] - [-Disabled <$true | $false>] [-Filter <String>] [-NotificationCulture <CultureInfo>] - [-NotifyUserOnFilterMatch <$true | $false>] [-NotifyUserSuppressionExpiryDate <DateTime>] - [-NotifyUserThrottleThreshold <Int32>] [-NotifyUserThrottleWindow <Int32>] [-Operation <MultiValuedProperty>] - [-Severity <Low | Medium | High | None>] [-Threshold <Int32>] [-TimeWindow <Int32>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ProtectionAlert -Name "Content search deleted" -Category Others -NotifyUser admin@contoso.com -ThreatType Activity -Operation SearchRemoved -Description "Custom alert policy to track when content searches are deleted" -AggregationType None -``` - -This example creates an alert policy that triggers an alert whenever anyone in the organization deletes a Content Search in the Office 365 Security & Compliance Center. - -## PARAMETERS - -### -Category -The Category parameter specifies a category for the alert policy. Valid values are: - -- AccessGovernance - -- DataGovernance - -- DataLossPrevention - -- ThreatManagement - -- Others - -When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting - -```yaml -Type: None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThreatType -The ThreatType parameter specifies the type of activities that are monitored by the alert policy. Valid values are: - -- Activity - -- Malware - -The value that you select for this parameter determines the values you can use for the AlertBy, Filter, and Operation parameters. - -You can't change this value after you create the alert policy. - -```yaml -Type: None | Malware | Phish | Activity -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregationType -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 Office 365 to establish the baseline. During the baseline calculation period, no alerts are generated for the activity. - -```yaml -Type: None | SimpleAggregation | AnomalousAggregation -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlertBy -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. - -- Malware: Valid values are Mail.Recipient or Mail.ThreatName. - -You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlertFor -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter specifies part of the conditions for the alert policy by using OPath filter syntax. The OPath filter includes a property name followed by a comparison operator and value. For example, {Mail:Direction -eq 'Inbound'}. The filterable properties are: - -Activity - -- Activity.ClientIp - -- Activity.CreationTime - -- Activity.Item - -- Activity.ItemType - -- Activity.Operation - -- Activity.ResultStatus - -- Activity.Scope - -- Activity.SiteUrl - -- Activity.SourceFileExtension - -- Activity.SourceFileName - -- Activity.TargetUserOrGroupType - -- Activity.UserAgent - -- Activity.UserId - -- Activity.UserType - -- Activity.Workload - -Malware - -- Mail:AttachmentExtensions - -- Mail:AttachmentNames - -- Mail:CreationTime - -- Mail:DeliveryStatus - -- Mail:Direction - -- Mail:From - -- Mail:FromDomain - -- Mail:InternetMessageId - -- Mail:IsIntraOrgSpoof - -- Mail:IsMalware - -- Mail:IsSpam - -- Mail:IsThreat - -- Mail:Language - -- Mail:Recipient - -- Mail:Scl - -- Mail:SenderCountry - -- Mail:SenderIpAddress - -- Mail:Subject - -- Mail:TenantId - -- Mail:ThreatName - -You can specify multiple criteria by using the -and comparison operator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationCulture -The NotificationCulture parameter specifies the language or locale that's used for notifications. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUserOnFilterMatch -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. - -You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUserSuppressionExpiryDate -The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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: - -- An integer. - -- The value $null. This is the default value (no maximum number of notifications for an alert). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUserThrottleWindow -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). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at Search the audit log in the Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?linkid=824986). - -You can specify multiple values separated by commas. - -You can only use this parameter when the ThreatType parameter has the value Activity. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Severity -The Severity parameter specifies the severity of the detection. Valid values are: - -- Low (This is the default value) - -- Medium - -- High - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -The Threshold parameter specifies the number of 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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeWindow -The TimeWindow parameter specifies the time 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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/48bd261f-8aa3-4f6a-9552-c94756025450.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md deleted file mode 100644 index 1713904d87..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-SupervisoryReviewPolicyV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-SupervisoryReviewPolicyV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-SupervisoryReviewPolicyV2 cmdlet to create supervisory review policies in the Office 365 Security & Compliance Center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SupervisoryReviewPolicyV2 [-Name] <String> -Reviewers <String[]> [-Comment <String>] [-Confirm] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SupervisoryReviewPolicyV2 -Name "EU Brokers Policy" -Reviewers laura@contoso.com,julia@contoso.com -Comment "Created by the compliance team" -``` - -This example creates a new supervisory review policy named EU Brokers Policy. - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reviewers -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: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5296dc8c-0412-4b10-a464-fe6d403ff3a3.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/New-SupervisoryReviewRule.md deleted file mode 100644 index 5b8420e6b1..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-SupervisoryReviewRule.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: New-SupervisoryReviewRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# New-SupervisoryReviewRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the New-SupervisoryReviewRule cmdlet to create supervisory review rules in the Office 365 Security & Compliance Center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SupervisoryReviewRule [-Name] <String> -Policy <PolicyIdParameter> [-Condition <String>] [-Confirm] - [-SamplingRate <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SupervisoryReviewRule -Name "EU Brokers Rule" -Policy "EU Brokers Policy" -SamplingRate 100 -Conditions "((NOT(Reviewee:US Compliance)) -AND (Reviewee:EU Brokers) -AND ((trade) -OR (insider trading)) -AND (NOT(approved by the Contoso financial team)))" -``` - -This example creates a new supervisory review rule named EU Brokers Rule with the following settings: - -- Policy: EU Brokers Policy - -- Sampling rate: 100% - -- Conditions: Supervise inbound and outbound communications for members of the EU Brokers group that contain the words trade or insider trading. - -- Exceptions: Exclude supervision for members of the EU Compliance group, or messages that contain the phrase "approved by the Contoso financial team". - -## PARAMETERS - -### -Name -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: - -- User or group communications to supervise: "((Reviewee:\<emailaddress1\>) -OR (Reviewee:\<emailaddress2\>)...)". Exceptions use the syntax "(NOT((Reviewee:\<emailaddress1\>) -OR (Reviewee:\<emailaddress2\>)...))". - -- Direction: "((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))". - -- Message contains words: "((\<Word1orPhrase1\>) -OR (\<Word2orPhrase2\>)...)". Exceptions use the syntax "(NOT((\<Word1orPhrase1\>)-OR (\<Word2orPhrase2\>)...))". - -- Any attachment contains words: "((Attachment:\<word1\>) -OR (Attachment:\<word2\>)...)". Exceptions use the syntax "(NOT((Attachment:\<word1\>)-OR (Attachment:\<word2\>)...))". - -- Any attachment has the extension: "((AttachmentName:.\<extension1\>) -OR (AttachmentName:.\<extension2\>)...)". Exceptions use the syntax "(NOT((AttachmentName:.\<extension1\>)-OR (AttachmentName:.\<extension2\>)...))". - -- Message size is larger than: "(MessageSize:\<size in B, KB, MB or GB\>)". For example "(MessageSize:300KB)". Exceptions use the syntax "(NOT(MessageSize:\<size in B, KB, MB or GB\>))". - -- Any attachment is larger than: "(AttachmentSize:\<size in B, KB, MB or GB\>)". For example "(AttachmentSize:3MB)". Exceptions use the syntax "(NOT(AttachmentSize:\<size in B, KB, MB or GB\>))". - -- Parentheses ( ) are required around the whole filter. - -- Separate multiple conditions or exception types with the -AND operator. For example, "((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamplingRate -The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b10216c9-0052-47bb-8da3-4ff9e9ecf9b0.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/New-TransportRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/New-TransportRule.md deleted file mode 100644 index 6b30c45541..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/New-TransportRule.md +++ /dev/null @@ -1,5386 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-TransportRule [-Name] <String> - [-ActivationDate <DateTime>] - [-ADComparisonAttribute <DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15>] - [-ADComparisonOperator <Equal | NotEqual>] - [-AddManagerAsRecipientType <To | Cc | Bcc | Redirect>] - [-AddToRecipients <RecipientIdParameter []>] - [-AnyOfCcHeader <RecipientIdParameter []>] - [-AnyOfCcHeaderMemberOf <RecipientIdParameter []>] - [-AnyOfRecipientAddressContainsWords <Word []>] - [-AnyOfRecipientAddressMatchesPatterns <Pattern []>] - [-AnyOfToCcHeader <RecipientIdParameter []>] - [-AnyOfToCcHeaderMemberOf <RecipientIdParameter []>] - [-AnyOfToHeader <RecipientIdParameter []>] - [-AnyOfToHeaderMemberOf <RecipientIdParameter []>] - [-ApplyClassification <String>] - [-ApplyHtmlDisclaimerFallbackAction <Wrap | Ignore | Reject>] - [-ApplyHtmlDisclaimerLocation <Append | Prepend>] - [-ApplyHtmlDisclaimerText <DisclaimerText>] - [-ApplyOME <$true | $false>] - [-ApplyRightsProtectionTemplate <RmsTemplateIdParameter>] - [-AttachmentContainsWords <Word []>] - [-AttachmentExtensionMatchesWords <Word []>] - [-AttachmentHasExecutableContent <$true | $false>] - [-AttachmentIsPasswordProtected <$true | $false>] - [-AttachmentIsUnsupported <$true | $false>] - [-AttachmentMatchesPatterns <Pattern []>] - [-AttachmentNameMatchesPatterns <Pattern []>] - [-AttachmentProcessingLimitExceeded <$true | $false>] - [-AttachmentPropertyContainsWords <Word []>] - [-AttachmentSizeOver <ByteQuantifiedSize>] - [-BetweenMemberOf1 <RecipientIdParameter []>] - [-BetweenMemberOf2 <RecipientIdParameter []>] - [-BlindCopyTo <RecipientIdParameter []>] - [-Comments <String>] - [-Confirm] - [-ContentCharacterSetContainsWords <Word []>] - [-CopyTo <RecipientIdParameter []>] - [-DeleteMessage <$true | $false>] - [-Disconnect <$true | $false>] - [-DlpPolicy <String>] - [-DomainController <Fqdn>] - [-Enabled <$true | $false>] - [-ExceptIfADComparisonAttribute <DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15>] - [-ExceptIfADComparisonOperator <Equal | NotEqual>] - [-ExceptIfAnyOfCcHeader <RecipientIdParameter []>] - [-ExceptIfAnyOfCcHeaderMemberOf <RecipientIdParameter []>] - [-ExceptIfAnyOfRecipientAddressContainsWords <Word []>] - [-ExceptIfAnyOfRecipientAddressMatchesPatterns <Pattern []>] - [-ExceptIfAnyOfToCcHeader <RecipientIdParameter []>] - [-ExceptIfAnyOfToCcHeaderMemberOf <RecipientIdParameter []>] - [-ExceptIfAnyOfToHeader <RecipientIdParameter []>] - [-ExceptIfAnyOfToHeaderMemberOf <RecipientIdParameter []>] - [-ExceptIfAttachmentContainsWords <Word []>] - [-ExceptIfAttachmentExtensionMatchesWords <Word []>] - [-ExceptIfAttachmentHasExecutableContent <$true | $false>] - [-ExceptIfAttachmentIsPasswordProtected <$true | $false>] - [-ExceptIfAttachmentIsUnsupported <$true | $false>] - [-ExceptIfAttachmentMatchesPatterns <Pattern []>] - [-ExceptIfAttachmentNameMatchesPatterns <Pattern []>] - [-ExceptIfAttachmentProcessingLimitExceeded <$true | $false>] - [-ExceptIfAttachmentPropertyContainsWords <Word []>] - [-ExceptIfAttachmentSizeOver <ByteQuantifiedSize>] - [-ExceptIfBetweenMemberOf1 <RecipientIdParameter []>] - [-ExceptIfBetweenMemberOf2 <RecipientIdParameter []>] - [-ExceptIfContentCharacterSetContainsWords <Word []>] - [-ExceptIfFrom <RecipientIdParameter []>] - [-ExceptIfFromAddressContainsWords <Word []>] - [-ExceptIfFromAddressMatchesPatterns <Pattern []>] - [-ExceptIfFromMemberOf <RecipientIdParameter []>] - [-ExceptIfFromScope <InOrganization | NotInOrganization>] - [-ExceptIfHasClassification <String>] - [-ExceptIfHasNoClassification <$true | $false>] - [-ExceptIfHasSenderOverride <$true | $false>] - [-ExceptIfHeaderContainsMessageHeader <HeaderName>] - [-ExceptIfHeaderContainsWords <Word []>] - [-ExceptIfHeaderMatchesMessageHeader <HeaderName>] - [-ExceptIfHeaderMatchesPatterns <Pattern []>] - [-ExceptIfManagerAddresses <RecipientIdParameter []>] - [-ExceptIfManagerForEvaluatedUser <Sender | Recipient>] - [-ExceptIfMessageContainsAllDataClassifications <Hashtable []>] - [-ExceptIfMessageContainsDataClassifications <Hashtable []>] - [-ExceptIfMessageSizeOver <ByteQuantifiedSize>] - [-ExceptIfMessageTypeMatches <OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt>] - [-ExceptIfRecipientADAttributeContainsWords <Word []>] - [-ExceptIfRecipientADAttributeMatchesPatterns <Pattern []>] - [-ExceptIfRecipientAddressContainsWords <Word []>] - [-ExceptIfRecipientAddressMatchesPatterns <Pattern []>] - [-ExceptIfRecipientDomainIs <Word []>] - [-ExceptIfRecipientInSenderList <Word []>] - [-ExceptIfSCLOver <SclValue>] - [-ExceptIfSenderADAttributeContainsWords <Word []>] - [-ExceptIfSenderADAttributeMatchesPatterns <Pattern []>] - [-ExceptIfSenderDomainIs <Word []>] - [-ExceptIfSenderInRecipientList <Word []>] - [-ExceptIfSenderIpRanges <MultiValuedProperty>] - [-ExceptIfSenderManagementRelationship <Manager | DirectReport>] - [-ExceptIfSentTo <RecipientIdParameter []>] - [-ExceptIfSentToMemberOf <RecipientIdParameter []>] - [-ExceptIfSentToScope <InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner>] - [-ExceptIfSubjectContainsWords <Word []>] - [-ExceptIfSubjectMatchesPatterns <Pattern []>] - [-ExceptIfSubjectOrBodyContainsWords <Word []>] - [-ExceptIfSubjectOrBodyMatchesPatterns <Pattern []>] - [-ExceptIfWithImportance <Low | Normal | High>] - [-ExpiryDate <DateTime>] - [-From <RecipientIdParameter []>] - [-FromAddressContainsWords <Word []>] - [-FromAddressMatchesPatterns <Pattern []>] - [-FromMemberOf <RecipientIdParameter []>] - [-FromScope <InOrganization | NotInOrganization>] - [-GenerateIncidentReport <RecipientIdParameter>] - [-GenerateNotification <DisclaimerText>] - [-HasClassification <String>] - [-HasNoClassification <$true | $false>] - [-HasSenderOverride <$true | $false>] - [-HeaderContainsMessageHeader <HeaderName>] - [-HeaderContainsWords <Word []>] - [-HeaderMatchesMessageHeader <HeaderName>] - [-HeaderMatchesPatterns <Pattern []>] - [-IncidentReportContent <IncidentReportContent []>] - [-IncidentReportOriginalMail <IncludeOriginalMail | DoNotIncludeOriginalMail>] - [-LogEventText <EventLogText>] - [-ManagerAddresses <RecipientIdParameter []>] - [-ManagerForEvaluatedUser <Sender | Recipient>] - [-MessageContainsAllDataClassifications <Hashtable []>] - [-MessageContainsDataClassifications <Hashtable []>] - [-MessageSizeOver <ByteQuantifiedSize>] - [-MessageTypeMatches <OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt>] - [-Mode <Audit | AuditAndNotify | Enforce>] - [-ModerateMessageByManager <$true | $false>] - [-ModerateMessageByUser <RecipientIdParameter []>] - [-NotifySender <NotifyOnly | RejectMessage | RejectUnlessFalsePositiveOverride | RejectUnlessSilentOverride | RejectUnlessExplicitOverride>] - [-PrependSubject <SubjectPrefix>] - [-Priority <Int32>] - [-Quarantine <$true | $false>] - [-RecipientADAttributeContainsWords <Word []>] - [-RecipientADAttributeMatchesPatterns <Pattern []>] - [-RecipientAddressContainsWords <Word []>] - [-RecipientAddressMatchesPatterns <Pattern []>] - [-RecipientDomainIs <Word []>] - [-RecipientInSenderList <Word []>] - [-RedirectMessageTo <RecipientIdParameter []>] - [-RejectMessageEnhancedStatusCode <RejectEnhancedStatus>] - [-RejectMessageReasonText <RejectText>] - [-RemoveHeader <HeaderName>] - [-RemoveOME <$true | $false>] - [-RemoveOMEv2 <$true | $false>] - [-RouteMessageOutboundConnector <OutboundConnectorIdParameter>] - [-RouteMessageOutboundRequireTls <$true | $false>] - [-RuleErrorAction <Ignore | Defer>] - [-RuleSubType <None | Dlp>] - [-SCLOver <SclValue>] - [-SenderADAttributeContainsWords <Word []>] - [-SenderADAttributeMatchesPatterns <Pattern []>] - [-SenderAddressLocation <Header | Envelope | HeaderOrEnvelope>] - [-SenderDomainIs <Word []>] - [-SenderInRecipientList <Word []>] - [-SenderIpRanges <MultiValuedProperty>] - [-SenderManagementRelationship <Manager | DirectReport>] - [-SentTo <RecipientIdParameter []>] - [-SentToMemberOf <RecipientIdParameter []>] - [-SentToScope <InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner>] - [-SetAuditSeverity <String>] - [-SetHeaderName <HeaderName>] - [-SetHeaderValue <HeaderValue>] - [-SetSCL <SclValue>] - [-SmtpRejectMessageRejectStatusCode <RejectStatusCode>] - [-SmtpRejectMessageRejectText <RejectText>] - [-StopRuleProcessing <$true | $false>] - [-SubjectContainsWords <Word []>] - [-SubjectMatchesPatterns <Pattern []>] - [-SubjectOrBodyContainsWords <Word []>] - [-SubjectOrBodyMatchesPatterns <Pattern []>] - [-UseLegacyRegex <$true | $false>] - [-WhatIf] - [-WithImportance <Low | Normal | High>] - [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-TransportRule "Ethical Wall - Sales and Brokerage Departments" -BetweenMemberOf1 "Sales Department" -BetweenMemberOf2 "Brokerage Department" -ExceptIfFrom "Tony Smith","Pilar Ackerman" -ExceptIfSubjectContainsWords "Press Release","Corporate Communication" -RejectMessageReasonText "Messages sent between the Sales and Brokerage departments are strictly prohibited." -``` - -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. - -- Exceptions: The Subject field contains the phrases Press Release or Corporate Communicationor the message was sent by Tony Smith or Pilar Ackerman. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivationDate -The ActivationDate parameter specifies when the rule starts processing messages. The rule won't take any action on messages until the specified date/time. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADComparisonAttribute -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ADComparisonAttribute parameter specifies a condition that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -If you don't use the ADComparisonOperator parameter, the default comparison operator Equal is used. - -```yaml -Type: DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15 -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADComparisonOperator -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ADComparisonOperator parameter specifies the comparison operator for the ADComparisonAttribute parameter. Valid values are: - -- Equal (This is the default value) - -- NotEqual - -```yaml -Type: Equal | NotEqual -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddManagerAsRecipientType -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The AddManagerAsRecipientType parameter specifies an action that delivers or redirects messages to the user that's defined in the sender's Manager attribute. Valid values are: - -- To: Add the sender's manager to the To field of the message. - -- Cc: Add the sender's manager to the Cco field of the message. - -- Bcc: Add the sender's manager to the Bcc field of the message. - -- Redirect: Redirect the message to the sender's manager without notifying the sender or the recipients. - -This action only works if the sender's Manager attribute is defined. - -```yaml -Type: To | Cc | Bcc | Redirect -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddToRecipients -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. - -The AddToRecipients parameter specifies an action that adds recipients to the To field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfCcHeader -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfCcHeader parameter specifies a condition that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfCcHeaderMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfRecipientAddressContainsWords -This parameter specifies a condition or 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. - -The AnyOfRecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfRecipientAddressMatchesPatterns -This parameter specifies a condition or 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. - -The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToCcHeader -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToCcHeader parameter specifies a condition that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToCcHeaderMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToHeader -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToHeader parameter specifies a condition that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToHeaderMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyClassification -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyClassification parameter specifies an action that applies a message classification to messages. Use the Get-MessageClassification cmdlet to see the message classification objects that are available. - -The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the data loss prevention (DLP) data classification. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyHtmlDisclaimerFallbackAction -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be added to a message. Valid values are: - -- Wrap: The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. This is the default value. Subsequent mail flow rules are applied to the new message envelope, not to the original message. Therefore, configure a rule with this action at a lower priority (a higher priority number) than other rules. If the original message can't be wrapped in a new message envelope, the original message isn't delivered. The message is returned to the sender in an non-delivery report (also known as an NDR or bounce message). - -- Ignore: The rule is ignored and the message is delivered without the disclaimer. - -- Reject: The message is rejected. - -If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. - -```yaml -Type: Wrap | Ignore | Reject -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyHtmlDisclaimerLocation -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -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. - -- Prepend: The disclaimer is inserted to the beginning of the message body. - -If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. - -```yaml -Type: Append | Prepend -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyHtmlDisclaimerText -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. - -You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyOME -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The ApplyOME parameter specifies an action that encrypts messages and their attachments by using Office 365 Message Encryption. Valid values are: - -- $true: The message and attachments are encrypted. - -- $false: The message and attachments aren't encrypted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyRightsProtectionTemplate -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyRightsProtectionTemplate parameter specifies an action that applies rights management service (RMS) templates to messages. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). - -To use this action, you need to have an Active Directory Rights Management Services (AD RMS) server in your organization, or your organization needs to use the ILS service. - -Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. - -For more information, see Transport protection rules (https://technet.microsoft.com/library/dd298166.aspx). - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentContainsWords parameter specifies a condition 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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentExtensionMatchesWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentExtensionMatchesWords parameter specifies a condition that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentHasExecutableContent -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentHasExecutableContent parameter specifies a condition that looks for executable content in message attachments. Valid values are: - -- $true: Look for executable content in message attachments. - -- $false: Don't look for executable content in message attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentIsPasswordProtected -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - -- $true: Look for password protected attachments. - -- $false: Don't look for password protected attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentIsUnsupported -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: - -- $true: Look for unsupported file types in messages. - -- $false: Don't look for unsupported file types in messages. - -For more information, see Register Filter Pack IFilters with Exchange (https://technet.microsoft.com/library/jj837174.aspx). - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. - -You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -Only the first 150 kilobytes (KB) of the attachment is scanned when trying to match a text pattern. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentNameMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentProcessingLimitExceeded -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentProcessingLimitExceeded parameter specifies a condition that looks for messages where attachment scanning didn't complete. Valid values are: - -- $true: Look for messages where attachment scanning didn't complete. - -- $false: Don't look for messages where attachment scanning didn't complete. - -You use this condition to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentPropertyContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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: - -- Business Impact - -- Compliancy - -- Confidentiality - -- Department - -- Impact - -- Intellectual Property - -- Personally Identifiable Information - -- Personal Information - -- Personal Use - -- Required Clearance - -- PHI - -- PII - -- Project - -- Protected Health Information - -The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use leading or trailing spaces. - -When you specify multiple properties, or multiple values for the same property, the or operator is used. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentSizeOver -This parameter specifies a condition or 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. - -The AttachmentSizeOver parameter specifies a condition that looks for messages where any attachment is greater than the specified size. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BetweenMemberOf1 -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The BetweenMemberOf1 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BetweenMemberOf2 -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The BetweenMemberOf2 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlindCopyTo -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. - -The BlindCopyTo parameter specifies an action that adds recipients to the Bcc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentCharacterSetContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ContentCharacterSetContainsWords parameter specifies a condition that looks for character set names in 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyTo -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. - -The CopyTo parameter specifies an action that adds recipients to the Cc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteMessage -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. - -The DeleteMessage parameter specifies an action that silently drops messages without an NDR. Valid values are: - -- $true: Silently drop the message without an NDR. - -- $false: Don't silently drop the message. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disconnect -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The Disconnect parameter specifies an action that ends the SMTP connection between the sending server and the Edge Transport server without generating an NDR. - -- $true: Silently end the SMTP session without generating an NDR. - -- $false: Don't silently end the SMTP session. - -```yaml -Type: $true | $false -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 -``` - -### -DlpPolicy -The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see Data loss prevention (https://technet.microsoft.com/library/jj150527.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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. - -- $false: The new rule is disabled. - -To enable or disable a rule after you create it, use the Enable-TransportRule and Disable-TransportRule cmdlets. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfADComparisonAttribute -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfADComparisonAttribute parameter specifies an exception that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -If you don't use the ExceptIfADComparisonOperator parameter, the default comparison operator Equal is used. - -```yaml -Type: DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15 -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfADComparisonOperator -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfADComparisonOperator parameter specifies the comparison operator for the ExceptIfADComparisonAttribute parameter. Valid values are: - -- Equal (This is the default value) - -- NotEqual - -```yaml -Type: Equal | NotEqual -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentContainsWords parameter specifies an exception 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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentExtensionMatchesWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentHasExecutableContent -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that looks for executable content in message attachments. Valid values are: - -- $true: Look for executable content in message attachments. - -- $false: Don't look for executable content in message attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentIsPasswordProtected -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - -- $true: Look for password protected attachments. - -- $false: Don't look for password protected attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentIsUnsupported -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: - -- $true: Look for unsupported file types in messages. - -- $false: Don't look for unsupported file types in messages. - -For more information, see Register Filter Pack IFilters with Exchange (https://technet.microsoft.com/library/jj837174.aspx). - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. - -You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -Only the first 150 KB of the attachment is scanned when trying to match a text pattern. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentNameMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentProcessingLimitExceeded -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentProcessingLimitExceeded parameter specifies an exception that looks for messages where attachment scanning didn't complete. Valid values are: - -- $true: Look for messages where attachment scanning didn't complete. - -- $false: Don't look for messages where attachment scanning didn't complete. - -You use this exception to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentPropertyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available 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: - -- Business Impact - -- Compliancy - -- Confidentiality - -- Department - -- Impact - -- Intellectual Property - -- Personally Identifiable Information - -- Personal Information - -- Personal Use - -- Required Clearance - -- PHI - -- PII - -- Project - -- Protected Health Information - -The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use values with leading or trailing spaces. - -When you specify multiple properties, or multiple values for the same property, the or operator is used. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfAttachmentSizeOver parameter specifies an exception that looks for messages where any attachment is greater than the specified size. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfBetweenMemberOf1 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfBetweenMemberOf2 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentCharacterSetContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfContentCharacterSetContainsWords parameter specifies an exception that looks for character set names in 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFrom -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfFromAddressContainsWords parameter specifies an exception that looks for words in the sender's email address. You can specify multiple words separated by commas. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfFromAddressMatchesPatterns parameter specifies an exception 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\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: - -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. - -```yaml -Type: InOrganization | NotInOrganization -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHasClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfHasClassification parameter specifies an exception that looks for messages with the specified message classification. - -You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: - --ExceptIfHasClassification @(Get-MessageClassification "Company Internal").Identity - -The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP data classification. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHasNoClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfHasNoClassification parameter specifies an exception that looks for messages with or without any message classifications. Valid values are: - -- $true: Look for messages that don't have a message classification. - -- $false: Look for messages that have one or more message classifications. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHasSenderOverride -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfHasSenderOverride parameter specifies an exception that looks for messages where the sender chose to override a DLP policy. Valid values are: - -- $true: Look for messages where the sender took action to override a DLP policy. - -- $false: Don't look for messages where the sender took action to override a DLP policy. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderContainsMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the ExceptIfHeaderContainsWords parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderContainsWords parameter specifies an exception 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. - -You specify the header field to search by using the ExceptIfHeaderContainsMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderMatchesMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the ExceptIfHeaderMatchesPatterns parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderMatchesPatterns parameter specifies an exception 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 specify the header field to search by using the ExceptIfHeaderMatchesMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfManagerAddresses -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You specify if you want to look for these users as managers of senders or recipients by using the ExceptIfManagerForEvaluatedUser parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfManagerForEvaluatedUser -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfManagerForEvaluatedUser parameter specifies an exception that looks for users in the Manager attribute of senders or recipients. Valid values are: - -- Recipient: The user is the manager of a recipient. - -- Sender: The user is the manager of the sender. - -You specify the users to look for by using the ExceptIfManagerAddresses parameter. - -```yaml -Type: Sender | Recipient -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageContainsAllDataClassifications -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageContainsDataClassifications -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. - -This parameter uses the syntax @{\<SensitiveInformationType1\>},@{\<SensitiveInformationType2\>},...@{\<SensitiveInformationTypeN\>}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. - -For a list of sensitive information types available, see Sensitive information types (https://technet.microsoft.com/library/jj150541.aspx). - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfMessageSizeOver parameter specifies an exception that looks for messages larger than the specified size. The size includes the message and all attachments. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageTypeMatches -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - -- OOF: Auto-reply messages configured by the user. - -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook or Outlook). - -- Encrypted: Encrypted messages. - -- Calendaring: Meeting requests and responses. - -- PermissionControlled: Messages that have specific permissions configured. - -- Voicemail: Voice mail messages forwarded by Unified Messaging service. - -- Signed: Digitally signed messages. - -- ApprovalRequest: Moderations request messages sent to moderators. - -- ReadReceipt: Read receipts. - -```yaml -Type: OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the ExceptIfRecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientInSenderList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSCLOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: - -- -1: The message is from a trusted sender, so the message bypasses spam filtering. - -- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. - -The rule looks for messages with an SCL value that's greater than or equal to the specified value. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderADAttributeContainsWords parameter specifies an exception that looks for words in Active Directory attributes of message senders. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in Active Directory attributes of message senders by using regular expressions. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderInRecipientList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderIpRanges -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderIpRanges parameter specifies an exception that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - -- Single IP address: For example, 192.168.1.1. - -- IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify multiple IP addresses or ranges separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderManagementRelationship -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderManagementRelationship parameter specifies an exception that looks for the relationship between the sender and recipients in messages. Valid values are: - -- Manager: The sender is the manager of a recipient. - -- DirectReport: A recipient is the manager of the sender. - -```yaml -Type: Manager | DirectReport -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -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 - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: - -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. - -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. - -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. - -```yaml -Type: InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectContainsWords parameter specifies an exception that looks for words in the Subject field of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectMatchesPatterns parameter specifies an exception 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectOrBodyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception that looks for words in the Subject field or body of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectOrBodyMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfWithImportance -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfWithImportance parameter specifies an exception that looks for messages with the specified importance level. Valid values are: - -- Low - -- Normal - -- High - -```yaml -Type: Low | Normal | High -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDate -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromAddressContainsWords -This parameter specifies a condition or 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. - -The FromAddressContainsWords parameter specifies a condition that looks for words in the sender's email address. You can specify multiple words separated by commas. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromAddressMatchesPatterns -This parameter specifies a condition or 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. - -The FromAddressMatchesPatterns parameter specifies a condition 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\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromScope -This parameter specifies a condition or 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. - -The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: - -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. - -```yaml -Type: InOrganization | NotInOrganization -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateIncidentReport -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The GenerateIncidentReport parameter specifies where to send the incident report that's defined by the IncidentReportContent parameter. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -An incident report is generated for messages that violate a DLP policy in your organization. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateNotification -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The GenerateNotification parameter specifies an action that sends a notification message to recipients. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. - -This parameter supports plain text, HTML tags and the following keywords that use values from the original message: - -- %%From%% - -- %%To%% - -- %%Cc%% - -- %%Subject%% - -- %%Headers%% - -- %%MessageDate%% - -```yaml -Type: DisclaimerText -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasClassification -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The HasClassification parameter specifies a condition that looks for messages with the specified message classification. - -You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: - --HasClassification @(Get-MessageClassification "Company Internal").Identity - -The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP classification. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasNoClassification -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The HasNoClassification parameter specifies a condition that looks for messages with or without any message classifications. Valid values are: - -- $true: Look for messages that don't have a message classification. - -- $false: Look for messages that have one or more message classifications. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasSenderOverride -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The HasSenderOverride parameter specifies a condition that looks for messages where the sender chose to override a DLP policy. Valid values are: - -- $true: Look for messages where the sender took action to override a DLP policy. - -- $false: Don't look for messages where the sender took action to override a DLP policy. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderContainsMessageHeader -This parameter specifies a condition or 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. - -The HeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the HeaderContainsWords parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderContainsWords -This parameter specifies a condition or 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. - -The HeaderContainsWords parameter specifies a condition 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. - -You specify the header field to search by using the HeaderContainsMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderMatchesMessageHeader -This parameter specifies a condition or 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. - -The HeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the HeaderMatchesPatterns parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderMatchesPatterns -This parameter specifies a condition or 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. - -The HeaderMatchesPatterns parameter specifies a condition 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 specify the header field to search by using the HeaderMatchesMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportContent -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The IncidentReportContent parameter specifies the message properties that are included in the incident report that's generated when a message violates a DLP policy. Valid values are: - -- 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. - -- 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. - -- Severity: The audit severity of the rule that was triggered. If the message was processed by more than one rule, the highest severity is displayed. - -- Override: The override if the sender chose to override a PolicyTip. If the sender provided a justification, the first 100 characters of the justification is also included. - -- RuleDetections: The list of rules that the message triggered. - -- FalsePositive: The false positive if the sender marked the message as a false positive for a PolicyTip. - -- DataClassifications: The list of sensitive information types that were detected in the message. - -- IdMatch: The sensitive information type that was detected, the exact matched content from the message, and the 150 characters before and after the matched sensitive information. - -- AttachOriginalMail: The entire original message as an attachment. - -The message ID is always included in the incident report. - -You can specify multiple values separated by commas. - -You use this parameter with the GenerateIncidentReport parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportOriginalMail -This parameter is available or functional 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 specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available 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: - -- IncludeOriginalMail - -- DoNotIncludeOriginalMail (this is the default value) - -```yaml -Type: IncludeOriginalMail | DoNotIncludeOriginalMail -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogEventText -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The LogEventText parameter specifies an action that creates an entry in the Application log on the local Edge Transport server. The value for this parameter specifies the text that you want to include in the event log entry. If the text contains spaces, enclose the value in quotation marks ("). - -The entry contains the following information: - -- Level: Information - -- Source: MSExchange Messaging Policies - -- Event ID: 4000 - -- Task Category: Rules - -- EventData: The following message is logged by an action in the rules: \<text you specify\> - -```yaml -Type: EventLogText -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 -``` - -### -ManagerAddresses -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You specify if you want to look for these users as managers of senders or recipients by using the ManagerForEvaluatedUser parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagerForEvaluatedUser -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ManagerForEvaluatedUser parameter specifies a condition that looks for users in the Manager attribute of senders or recipients. Valid values are: - -- Recipient: The user is the manager of a recipient. - -- Sender: The user is the manager of the sender. - -You specify the users to look for by using the ManagerAddresses parameter. - -```yaml -Type: Sender | Recipient -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageContainsAllDataClassifications -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageContainsDataClassifications -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. - -This parameter uses the syntax @{\<SensitiveInformationType1\>},@{\<SensitiveInformationType2\>},...@{\<SensitiveInformationTypeN\>}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. - -For a list of sensitive information types available, see Sensitive information types (https://technet.microsoft.com/library/jj150541.aspx). - -You can specify the notification options by using the NotifySender parameter. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageSizeOver -This parameter specifies a condition or 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. - -The MessageSizeOver parameter specifies a condition that looks for messages larger than the specified size. The size includes the message and all attachments. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTypeMatches -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - -- OOF: Auto-reply messages configured by the user. - -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook or Outlook). - -- Encrypted: Encrypted messages. - -- Calendaring: Meeting requests and responses. - -- PermissionControlled: Messages that have specific permissions configured. - -- Voicemail: Voice mail messages forwarded by Unified Messaging service. - -- Signed: Digitally signed messages. - -- ApprovalRequest: Moderations request messages sent to moderators. - -- ReadReceipt: Read receipts. - -```yaml -Type: OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The Mode parameter specifies how the rule operates. Valid values are: - -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. - -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. - -- Enforce: All actions specified in the rule are taken. This is the default value. - -```yaml -Type: Audit | AuditAndNotify | Enforce -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerateMessageByManager -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ModerateMessageByManager parameter specifies an action that forwards messages for approval to the user that's specified in the sender's Manager attribute. After the manager approves the message, it's delivered to the recipients. Valid values are: - -- $true: Moderation by the sender's manager is enabled. - -- $false: Moderation by the sender's manager is disabled. - -This action only works if the sender's Manager attribute is defined. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerateMessageByUser -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ModerateMessageByUser parameter specifies an action that forwards messages for approval to the specified users. After one of the users approves the message, it's delivered to the recipients. You can use ay value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can't use a distribution group as a moderator. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifySender -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The NotifySender parameter specifies an action that notifies the sender when messages violate DLP policies. Valid values are: - -- NotifyOnly: The sender is notified, but the message is delivered normally. - -- RejectMessage: The message is rejected, and the sender is notified. - -- RejectUnlessFalsePositiveOverride: The message is rejected unless it's marked as a false positive by the sender. - -- RejectUnlessSilentOverride: The message is rejected unless the sender has chosen to override the policy restriction. - -- RejectUnlessExplicitOverride: This is the same as RejectUnlessSilentOverride, but the sender can also provide a justification for overriding the policy restriction. - -For all values except NotifyOnly, you can specify an enhanced status code and a rejection reason by using the RejectMessageEnhancedStatusCode and RejectMessageReasonText parameters. The default enhanced status code is 5.7.1, and the default rejection reason is Delivery not authorized, message refused. - -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. - -```yaml -Type: NotifyOnly | RejectMessage | RejectUnlessFalsePositiveOverride | RejectUnlessSilentOverride | RejectUnlessExplicitOverride -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrependSubject -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. - -The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks (")\> - -Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quarantine -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The Quarantine parameter specifies an action that quarantines messages. - -- In on-premises Exchange, messages are delivered to the quarantine mailbox that you've configured as part of Content filtering. If the quarantine mailbox isn't configured, the message is returned to the sender in an NDR. - -- In Office 365, messages are delivered to the hosted quarantine. - -```yaml -Type: $true | $false -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 -``` - -### -RecipientADAttributeContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientADAttributeContainsWords parameter specifies a condition that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientADAttributeMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddressContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddressMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the RecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientInSenderList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectMessageTo -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. - -The RedirectMessageTo parameter specifies a rule action that redirects messages to the specified recipients. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessageEnhancedStatusCode -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999. - -You can use this parameter with the NotifySender and RejectMessageReasonText parameters to specify the custom enhanced status code that's used. If you don't use this parameter, the default value 5.7.1 is used. - -To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessageReasonText -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). - -You can use this parameter with the NotifySender and RejectMessageEnhancedStatusCode parameters to specify the custom explanation text that's used. If you don't use this parameter, the default value Delivery not authorized, message refused is used. - -To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveHeader -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. - -The RemoveHeader parameter specifies an action that removes a header field from the message header. The value of this parameter specifies the name of the header field to remove. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveOME -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The RemoveOME parameter specifies an action that removes the previous version of Office 365 Message Encryption from messages and their attachments. Valid values are: - -- $true: The message and attachments are decrypted. - -- $false: The message and attachments aren't decrypted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveOMEv2 -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The RemoveOMEv2 parameter specifies an action that removes Office 365 Message Encryption from messages and their attachments. Valid values are: - -- $true: The message and attachments are decrypted. - -- $false: The message and attachments aren't decrypted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteMessageOutboundConnector -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The RouteMessageOutboundConnector parameter specifies an action that routes messages through the specified Outbound connector in Office 365. You can use any value that uniquely identifies the connector. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OutboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteMessageOutboundRequireTls -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The RouteMessageOutboundRequireTls parameter specifies an action that uses Transport Layer Security (TLS) encryption to deliver messages outside your organization. Valid values are: - -- $true: The messages must be delivered over a TLS encrypted channel. - -- $false: A TLS encrypted channel isn't required to deliver the messages. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleErrorAction -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. - -- Defer: The message is deferred so the rules engine can attempt to process the message again. - -```yaml -Type: Ignore | Defer -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSubType -The RuleSubType parameter specifies the rule type. Valid values are: - -- Dlp: The rule is associated with a DLP policy. - -- None: The rule is a regular rule that isn't associated with a DLP policy. - -```yaml -Type: None | Dlp -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SCLOver -This parameter specifies a condition or 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. - -The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: - -- -1: The message is from a trusted sender, so the message bypasses spam filtering. - -- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. - -The rule looks for messages with an SCL value that's greater than or equal to the specified value. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderADAttributeContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderADAttributeContainsWords parameter specifies a condition that looks for words in Active Directory attributes of message senders. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderADAttributeMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in Active Directory attributes of message senders by using regular expressions. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddressLocation -The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - -- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - -- HeaderOrEnvelope: Examine senders in the message header and the message envelope. - -Note that message envelope searching is only available for the following conditions and exceptions: - -- From and ExceptIfFrom - -- FromAddressContainsWords and ExceptIfFromAddressContainsWords - -- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns - -- FromMemberOf and ExceptIfFromMemberOf - -- SenderDomainIs and ExceptIfSenderDomainIs - -```yaml -Type: Header | Envelope | HeaderOrEnvelope -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderDomainIs -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderInRecipientList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderIpRanges -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderIpRanges parameter specifies a condition that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - -- Single IP address: For example, 192.168.1.1. - -- IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify multiple IP addresses or ranges separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderManagementRelationship -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderManagementRelationship parameter specifies a condition that looks for the relationship between the sender and recipients in messages. Valid values are: - -- Manager: The sender is the manager of a recipient. - -- DirectReport: A recipient is the manager of the sender. - -```yaml -Type: Manager | DirectReport -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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 - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToScope -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: - -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. - -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. - -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. - -```yaml -Type: InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetAuditSeverity -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The SetAuditSeverity parameter specifies an action that sets the severity level of the incident report and the corresponding entry that's written to the message tracking log when messages violate DLP policies. Valid values are: - -- DoNotAudit: No audit entry is logged. - -- Low: The audit entry is assigned low severity. - -- Medium: The audit entry is assigned medium severity. - -- High: The audit entry is assigned high severity. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetHeaderName -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. - -The SetHeaderName parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the name of the header field that you want to add or modify. When you use this parameter, you also need to use the SetHeaderValue parameter to specify a value for the header. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetHeaderValue -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. - -The SetHeaderValue parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the value that you want to apply to the header field. When you use this parameter, you also need to use the SetHeaderName parameter to specify the name of the header field that you want to add or modify. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetSCL -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. - -The SetSCL parameter specifies an action that adds or modifies the SCL value of messages. Valid values are: - -- -1: The message is from a trusted sender, so the message bypasses spam filtering. - -- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmtpRejectMessageRejectStatusCode -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The SmtpRejectMessageRejectStatusCode parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the SMTP code that's used. Valid values are the integers 400 through 500. - -You can use this parameter with the SmtpRejectMessageRejectText parameter. If you don't use this parameter, the default SMTP code 550 is used. - -```yaml -Type: RejectStatusCode -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 -``` - -### -SmtpRejectMessageRejectText -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The SmtpRejectMessageRejectText parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the explanation text that's used. If the value contains spaces, enclose the value in quotation marks ("). - -You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. If you don't use this parameter, the default text Delivery not authorized, message refused is used. - -```yaml -Type: RejectText -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 -``` - -### -StopRuleProcessing -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. - -The StopRuleProcessing parameter specifies an action that stops processing more rules. Valid values are: - -- $true: Stop processing more rules. - -- $false: Continue processing more rules after this one. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectContainsWords -This parameter specifies a condition or 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. - -The SubjectContainsWords parameter specifies a condition that looks for words in the Subject field of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectMatchesPatterns -This parameter specifies a condition or 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. - -The SubjectMatchesPatterns parameter specifies a condition 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectOrBodyContainsWords -This parameter specifies a condition or 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. - -The SubjectOrBodyContainsWords parameter specifies a condition that looks for words in the Subject field or body of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectOrBodyMatchesPatterns -This parameter specifies a condition or 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. - -The SubjectOrBodyMatchesPatterns parameter specifies a condition 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLegacyRegex -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. - -- $false: Regular expression syntax that's compatible with Exchange 2013 or later. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WithImportance -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The WithImportance parameter specifies a condition that looks for messages with the specified importance level. Valid values are: - -- Low - -- Normal - -- High - -```yaml -Type: Low | Normal | High -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eb3546bf-ca37-474e-9c22-962fe95af276.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-ActivityAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/Remove-ActivityAlert.md deleted file mode 100644 index 89f5acb76d..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-ActivityAlert.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ActivityAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ActivityAlert cmdlet to remove activity alerts from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ActivityAlert [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ActivityAlert -Identity "All Mailbox Activities" -``` - -This example removes the activity alert named All Mailbox Activities. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the activity alert that you want to remove. You can use any value that uniquely identifies the activity alert. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/96a444f0-ee9a-4da3-952d-4ad0deac0bcd.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-MessageClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance/Remove-MessageClassification.md deleted file mode 100644 index 87c65d57b3..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-MessageClassification.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MessageClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-MessageClassification cmdlet to delete an existing message classification instance from your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MessageClassification [-Identity] <MessageClassificationIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- - -```powershell -Remove-MessageClassification MyMessageClassification -``` - -This example removes the message classification named MyMessageClassification. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the name of the message classification instance that you want to remove. When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Administrative Name". - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6a8b067b-a070-4c82-80c3-95b267a734c1.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md deleted file mode 100644 index 69d2622adf..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OutlookProtectionRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-OutlookProtectionRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-OutlookProtectionRule cmdlet to remove Outlook protection rules. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OutlookProtectionRule [-Identity] <RuleIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd638178.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OutlookProtectionRule -Identity "Project Contoso" -``` - -This example removes the Outlook protection rule named Project Contoso. - -### -------------------------- Example 2 -------------------------- -``` -Get-OutlookProtectionRule | Remove-OutlookProtectionRule -``` - -This example removes all Outlook protection rules from the organization. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4a7df5b7-6380-4c2d-9a35-8d310bb6801d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-ProtectionAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/Remove-ProtectionAlert.md deleted file mode 100644 index 649033a157..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-ProtectionAlert.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-ProtectionAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-ProtectionAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-ProtectionAlert cmdlet to remove alert policies from the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ProtectionAlert [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ProtectionAlert -Identity "External User File Activities" -``` - -This example removes the alert policy named External User File Activities. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/212f2994-16e0-477e-9cc1-8d5a611b5521.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md deleted file mode 100644 index 0e04fbc00b..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Remove-SupervisoryReviewPolicyV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Remove-SupervisoryReviewPolicyV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Remove-SupervisoryReviewPolicyV2 cmdlet to remove supervisory review policies from the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SupervisoryReviewPolicyV2 [-Identity] <PolicyIdParameter> [-Confirm] [-ForceDeletion] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SupervisoryReviewPolicyV2 -Identity "EU Brokers Policy" -``` - -This example removes the supervisory review policy named EU Brokers Policy. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/79ded575-edac-49bc-b47e-df1ee5503a18.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-ActivityAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/Set-ActivityAlert.md deleted file mode 100644 index 43f99a6d55..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-ActivityAlert.md +++ /dev/null @@ -1,480 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ActivityAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-ActivityAlert cmdlet to modify activity alerts in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ActivityAlert [-Identity] <ComplianceRuleIdParameter> - [-Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others>] - [-Condition <String>] [-Confirm] [-Description <String>] [-Disabled <$true | $false>] - [-DomainController <Fqdn>] [-EmailCulture <CultureInfo>] [-Multiplier <Double>] [-Name <String>] - [-NotifyUser <MultiValuedProperty>] [-Operation <MultiValuedProperty>] - [-RecordType <ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence>] - [-ScopeLevel <SingleUser | AllUsers>] [-Severity <Low | Medium | High | None>] [-Threshold <Int32>] - [-TimeWindow <Int32>] [-UserId <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$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 -------------------------- -``` -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: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Category -The Category parameter specifies a category for the activity alert. Valid values are: - -- None (This is the default value) - -- DataLossPrevention - -- ThreatManagement - -- DataGovernance - -- AccessGovernance - -- Others - -```yaml -Type: None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -The Condition parameter specifies filter conditions for event aggregation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the activity alert is enabled or disabled. Valid values are: - -- $true: The activity alert is disabled. - -- $false: The activity alert is enabled. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailCulture -The EmailCulture parameter specifies the language of the notification email message. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Multiplier -The Multiplier parameter specifies the number of events that trigger an activity alert. The value of this parameter indicates a multiplier from a baseline value. - -You can only use this parameter on activity alerts that have the Type property value AnomalousAggregation. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies the email address of the recipients who will receive the notification emails. You can specify internal and external email addresses. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -To modify the existing list of recipients, see the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -The Operation parameter specifies the activitiesthat trigger activity alerts. - -A valid value for this parameter is an activity that's available in the Office 365 audit log. For a description of these activities, see Search the audit log in the Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=824986). - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -The RecordType parameter specifies a record type label for the activity alert. - -Valid values are: - -- AzureActiveDirectory - -- AzureActiveDirectoryAccountLogon - -- AzureActiveDirectoryStsLogon - -- ComplianceDLPExchange - -- ComplianceDLPSharePoint - -- CRM - -- DataCenterSecurityCmdlet - -- Discovery - -- ExchangeAdmin - -- ExchangeAggregatedOperation - -- ExchangeItem - -- ExchangeItemGroup - -- MicrosoftTeams - -- MicrosoftTeamsAddOns - -- MicrosoftTeamsSettingsOperation - -- OneDrive - -- PowerBIAudit - -- SecurityComplianceCenterEOPCmdlet - -- SharePoint - -- SharePointFileOperation - -- SharePointSharingOperation - -- SkypeForBusinessCmdlets - -- SkypeForBusinessPSTNUsage - -- SkypeForBusinessUsersBlocked - -- Sway - -- ThreatIntelligence - -- Yammer - -You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - -```yaml -Type: ExchangeAdmin | ExchangeItem | ExchangeItemGroup | SharePoint | SyntheticProbe | SharePointFileOperation | OneDrive | AzureActiveDirectory | AzureActiveDirectoryAccountLogon | DataCenterSecurityCmdlet | ComplianceDLPSharePoint | Sway | ComplianceDLPExchange | SharePointSharingOperation | AzureActiveDirectoryStsLogon | SkypeForBusinessPSTNUsage | SkypeForBusinessUsersBlocked | SecurityComplianceCenterEOPCmdlet | ExchangeAggregatedOperation | PowerBIAudit | CRM | Yammer | SkypeForBusinessCmdlets | Discovery | MicrosoftTeams | MicrosoftTeamsAddOns | MicrosoftTeamsSettingsOperation | ThreatIntelligence -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeLevel -The ScopeLevel parameter specifies the scope for activity alerts that use the Type parameter values SimpleAggregation or AnomalousAggregation. Valid values are: - -- SingleUser (This is the default value) - -- AllUsers - -```yaml -Type: SingleUser | AllUsers -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Severity -The Severity parameter specifies a severity level for the activity alert. Valid values are: - -- None - -- Low (This is the default value) - -- Medium - -- High - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -The Threshold parameter specifies the number of events that trigger an activity alert in the time interval that's specified by the TimeWindow parameter. The minimum value for this parameter is 3. - -You can only use this parameter on activity alerts that have the Type property value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeWindow -The TimeWindow parameter specifies the time window in minutes that's used by the Threshold parameter. - -You can only use this parameter on activity alerts that have the Type property value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The UserId parameter specifies who you want to monitor. - -- If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. - -- If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/798baa99-ff27-45e2-a19a-8c3d7b288a3d.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-MessageClassification.md b/exchange/exchange-ps/exchange/policy-and-compliance/Set-MessageClassification.md deleted file mode 100644 index f88322f545..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-MessageClassification.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MessageClassification -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MessageClassification cmdlet to configure an existing message classification instance in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MessageClassification [-Identity] <MessageClassificationIdParameter> [-ClassificationID <Guid>] [-Confirm] - [-DisplayName <String>] - [-DisplayPrecedence <Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest>] - [-DomainController <Fqdn>] [-Name <String>] [-PermissionMenuVisible <$true | $false>] - [-RecipientDescription <String>] [-RetainClassificationEnabled <$true | $false>] [-SenderDescription <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MessageClassification MyMessageClassification -DisplayPrecedence Low -RetainClassificationEnabled $false -``` - -This example makes the following configuration changes to the message classification named MyMessageClassification: - -Changes the display precedence to Low. - -Specifies that the message classification shouldn't persist with the message if the message is forwarded or replied to. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the name or GUID of the message classification you want to modify. - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ClassificationID -The ClassificationID parameter specifies the GUID of an existing message classification that you want to use in your Exchange organization. Use this parameter if you're configuring message classifications to span two Exchange forests in the same organization. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DisplayName -The DisplayName parameter specifies the display name for the message classification instance. The display name appears in the Microsoft Office and is used by Outlook users to select the appropriate message classification before they send a message. - -When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Display Name". The DisplayName parameter can contain a maximum of 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 -Default value: None -Accept pipeline input: False -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. Although Outlook only lets a user specify a single classification for each 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. - -Valid input for the DisplayPrecedence parameter is Highest, Higher, High, MediumHigh, Medium, MediumLow, Low, Lower, and Lowest. - -The default value is Medium. - -```yaml -Type: Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: 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 -``` - -### -Name -The Name parameter specifies the administrative name for the message classification instance. The name is used to administer the message classification instance. When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Administrative Name". The Name parameter can contain a maximum 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionMenuVisible -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. - -If you set the PermissionMenuVisible parameter to $false, users won't be able to assign this message classification to the messages they're composing. However, messages received with this message classification still display the classification information. - -The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -RecipientDescription -The RecipientDescription parameter specifies the purpose of the message classification to the recipient. The value of this parameter is shown to Outlook users when they receive a message that has this message classification. Enclose the value in quotation marks ("), for example, "This is the recipient description that explains how to treat the message that has been classified". The RecipientDescription parameter can contain a maximum of 1,024 characters. - -If you don't enter a value for this parameter, the description that you enter for SenderDescription is used. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainClassificationEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -SenderDescription -The SenderDescription parameter specifies the purpose of the message classification to the sender. The value of this parameter is used by Outlook users to select the appropriate message classification before they send a message. Enclose the value in quotation marks ("), for example, "This is the sender description that explains when to use this message classification". The SenderDescription parameter can contain a maximum of 1,024 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fdbe9e1d-6e92-4ab7-9a77-88814c0eda68.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/policy-and-compliance/Set-ProtectionAlert.md deleted file mode 100644 index a061c559e9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-ProtectionAlert.md +++ /dev/null @@ -1,547 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-ProtectionAlert -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-ProtectionAlert - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-ProtectionAlert cmdlet to modify alert policies in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ProtectionAlert [-Identity] <ComplianceRuleIdParameter> - [-AggregationType <None | SimpleAggregation | AnomalousAggregation>] [-AlertBy <MultiValuedProperty>] - [-AlertFor <MultiValuedProperty>] - [-Category <None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others>] - [-Comment <String>] [-Confirm] [-Description <String>] [-Disabled <$true | $false>] [-Filter <String>] - [-Name <String>] [-NotificationCulture <CultureInfo>] [-NotifyUser <MultiValuedProperty>] - [-NotifyUserOnFilterMatch <$true | $false>] [-NotifyUserSuppressionExpiryDate <DateTime>] - [-NotifyUserThrottleThreshold <Int32>] [-NotifyUserThrottleWindow <Int32>] [-Operation <MultiValuedProperty>] - [-Severity <Low | Medium | High | None>] [-Threshold <Int32>] [-TimeWindow <Int32>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -### -------------------------- Example 2 -------------------------- -``` -Insert example commands for example 2. -``` - -Insert descriptive text for example 2. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AggregationType -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 Office 365 to establish the baseline. During the baseline calculation period, no alerts are generated for the activity. - -```yaml -Type: None | SimpleAggregation | AnomalousAggregation -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlertBy -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. - -- Malware: Valid values are Mail.Recipient or Mail.ThreatName. - -You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlertFor -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Category -The Category parameter specifies a category for the alert policy. Valid values are: - -- AccessGovernance - -- DataGovernance - -- DataLossPrevention - -- ThreatManagement - -- Others - -When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting - -```yaml -Type: None | DataLossPrevention | ThreatManagement | DataGovernance | AccessGovernance | Others -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter specifies part of the conditions for the alert policy by using OPath filter syntax. The OPath filter includes a property name followed by a comparison operator and value. For example, {Mail:Direction -eq 'Inbound'}. The filterable properties are: - -Activity - -- Activity.ClientIp - -- Activity.CreationTime - -- Activity.Item - -- Activity.ItemType - -- Activity.Operation - -- Activity.ResultStatus - -- Activity.Scope - -- Activity.SiteUrl - -- Activity.SourceFileExtension - -- Activity.SourceFileName - -- Activity.TargetUserOrGroupType - -- Activity.UserAgent - -- Activity.UserId - -- Activity.UserType - -- Activity.Workload - -Malware - -- Mail:AttachmentExtensions - -- Mail:AttachmentNames - -- Mail:CreationTime - -- Mail:DeliveryStatus - -- Mail:Direction - -- Mail:From - -- Mail:FromDomain - -- Mail:InternetMessageId - -- Mail:IsIntraOrgSpoof - -- Mail:IsMalware - -- Mail:IsSpam - -- Mail:IsThreat - -- Mail:Language - -- Mail:Recipient - -- Mail:Scl - -- Mail:SenderCountry - -- Mail:SenderIpAddress - -- Mail:Subject - -- Mail:TenantId - -- Mail:ThreatName - -You can specify multiple criteria by using the -and comparison operator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationCulture -The NotificationCulture parameter specifies the language or locale that's used for notifications. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUserOnFilterMatch -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. - -You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUserSuppressionExpiryDate -The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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: - -- An integer. - -- The value $null. This is the default value (no maximum number of notifications for an alert). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUserThrottleWindow -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). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at Search the audit log in the Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?linkid=824986). - -You can specify multiple values separated by commas. - -You can only use this parameter when the ThreatType parameter has the value Activity. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Severity -The Severity parameter specifies the severity of the detection. Valid values are: - -- Low (This is the default value) - -- Medium - -- High - -```yaml -Type: Low | Medium | High | None -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -The Threshold parameter specifies the number of 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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeWindow -The TimeWindow parameter specifies the time 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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/413f0a8f-50ca-4649-ae41-7e7fccb82655.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md deleted file mode 100644 index 53ac6648c9..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-SupervisoryReviewPolicyV2 -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-SupervisoryReviewPolicyV2 - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-SupervisoryReviewPolicyV2 cmdlet to modify supervisory review policies in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SupervisoryReviewPolicyV2 [-Identity] <PolicyIdParameter> [-AddReviewers <String[]>] [-Comment <String>] - [-Confirm] [-Force] [-RemoveReviewers <String[]>] [-RetentionPeriodInDays <Int32>] [-Reviewers <String[]>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SupervisoryReviewPolicyV2 -Identity "EU Brokers" -AddReviewers chris@contoso.com,michelle@contoso.com -Comment "Updated for new EU regulations" -``` - -This example adds reviewers and updates the comment for the supervisory review policy named EU Brokers. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddReviewers -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: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveReviewers -The RemoveReviewers parameter specifies the SMTP addresses of reviewers to remove from the supervisory review policy. You can specify multiple email addresses separated by commas. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPeriodInDays -The RetentionPeriodInDays parameter specifies the number of days that the messages will be retained for review. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reviewers -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. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ab911602-5108-4b96-9aa1-343d31102261.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md deleted file mode 100644 index 6866650674..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -applicable: Office 365 Security & Compliance Center -title: Set-SupervisoryReviewRule -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Set-SupervisoryReviewRule - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Set-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Office 365 Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SupervisoryReviewRule [-Identity] <ComplianceRuleIdParameter> [-Condition <String>] [-Confirm] - [-SamplingRate <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SupervisoryReviewRule -Identity "EU Brokers Rule" -Conditions "((NOT(Reviewee:US Compliance)) -AND (Reviewee:EU Brokers) -AND ((trade) -OR (insider trading)) -AND (NOT(approved by the Contoso financial team)))" -``` - -This example modifies the existing rule named EU Brokers Rule with the following settings: - -- Conditions: Supervise inbound and outbound communications for members of the EU Brokers group that contain the words trade or insider trading. - -- Exceptions: Exclude supervision for members of the EU Compliance group, or messages that contain the phrase "approved by the Contoso financial team". - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Condition -The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: - -- User or group communications to supervise: "((Reviewee:\<emailaddress1\>) -OR (Reviewee:\<emailaddress2\>)...)". Exceptions use the syntax "(NOT((Reviewee:\<emailaddress1\>) -OR (Reviewee:\<emailaddress2\>)...))". - -- Direction: "((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))". - -- Message contains words: "((\<Word1orPhrase1\>) -OR (\<Word2orPhrase2\>)...)". Exceptions use the syntax "(NOT((\<Word1orPhrase1\>) -OR (\<Word2orPhrase2\>)...))". - -- Any attachment contains words: "((Attachment:\<word1\>) -OR (Attachment:\<word2\>)...)". Exceptions use the syntax "(NOT((Attachment:\<word1\>) -OR (Attachment:\<word2\>)...))". - -- Any attachment has the extension: "((AttachmentName:.\<extension1\>) -OR (AttachmentName:.\<extension2\>)...)". Exceptions use the syntax "(NOT((AttachmentName:.\<extension1\>) -OR (AttachmentName:.\<extension2\>)...))". - -- Message size is larger than: "(MessageSize:\<size in B, KB, MB or GB\>)". For example "(MessageSize:300KB)". Exceptions use the syntax "(NOT(MessageSize:\<size in B, KB, MB or GB\>))". - -- Any attachment is larger than: "(AttachmentSize:\<size in B, KB, MB or GB\>)". For example "(AttachmentSize:3MB)". Exceptions use the syntax "(NOT(AttachmentSize:\<size in B, KB, MB or GB\>))". - -- Parentheses ( ) are required around the whole filter. - -- Separate multiple conditions or exception types with the -AND operator. For example, "((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamplingRate -The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in the Office 365 Security & Compliance Center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8ed4a806-ffab-497a-bfea-22aaf05870bb.aspx) diff --git a/exchange/exchange-ps/exchange/policy-and-compliance/Set-TransportRule.md b/exchange/exchange-ps/exchange/policy-and-compliance/Set-TransportRule.md deleted file mode 100644 index 331b2a068a..0000000000 --- a/exchange/exchange-ps/exchange/policy-and-compliance/Set-TransportRule.md +++ /dev/null @@ -1,5362 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. - -If you delete all conditions and exceptions from a rule, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-TransportRule [-Identity] <RuleIdParameter> - [-ActivationDate <DateTime>] - [-ADComparisonAttribute <DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15>] - [-ADComparisonOperator <Equal | NotEqual>] - [-AddManagerAsRecipientType <To | Cc | Bcc | Redirect>] - [-AddToRecipients <RecipientIdParameter []>] - [-AnyOfCcHeader <RecipientIdParameter []>] - [-AnyOfCcHeaderMemberOf <RecipientIdParameter []>] - [-AnyOfRecipientAddressContainsWords <Word []>] - [-AnyOfRecipientAddressMatchesPatterns <Pattern []>] - [-AnyOfToCcHeader <RecipientIdParameter []>] - [-AnyOfToCcHeaderMemberOf <RecipientIdParameter []>] - [-AnyOfToHeader <RecipientIdParameter []>] - [-AnyOfToHeaderMemberOf <RecipientIdParameter []>] - [-ApplyClassification <String>] - [-ApplyHtmlDisclaimerFallbackAction <Wrap | Ignore | Reject>] - [-ApplyHtmlDisclaimerLocation <Append | Prepend>] - [-ApplyHtmlDisclaimerText <DisclaimerText>] - [-ApplyOME <$true | $false>] - [-ApplyRightsProtectionTemplate <RmsTemplateIdParameter>] - [-AttachmentContainsWords <Word []>] - [-AttachmentExtensionMatchesWords <Word []>] - [-AttachmentHasExecutableContent <$true | $false>] - [-AttachmentIsPasswordProtected <$true | $false>] - [-AttachmentIsUnsupported <$true | $false>] - [-AttachmentMatchesPatterns <Pattern []>] - [-AttachmentNameMatchesPatterns <Pattern []>] - [-AttachmentProcessingLimitExceeded <$true | $false>] - [-AttachmentPropertyContainsWords <Word []>] - [-AttachmentSizeOver <ByteQuantifiedSize>] - [-BetweenMemberOf1 <RecipientIdParameter []>] - [-BetweenMemberOf2 <RecipientIdParameter []>] - [-BlindCopyTo <RecipientIdParameter []>] - [-Comments <String>] - [-Confirm] - [-ContentCharacterSetContainsWords <Word []>] - [-CopyTo <RecipientIdParameter []>] - [-DeleteMessage <$true | $false>] - [-Disconnect <$true | $false>] - [-DlpPolicy <String>] - [-DomainController <Fqdn>] - [-ExceptIfADComparisonAttribute <DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15>] - [-ExceptIfADComparisonOperator <Equal | NotEqual>] - [-ExceptIfAnyOfCcHeader <RecipientIdParameter []>] - [-ExceptIfAnyOfCcHeaderMemberOf <RecipientIdParameter []>] - [-ExceptIfAnyOfRecipientAddressContainsWords <Word []>] - [-ExceptIfAnyOfRecipientAddressMatchesPatterns <Pattern []>] - [-ExceptIfAnyOfToCcHeader <RecipientIdParameter []>] - [-ExceptIfAnyOfToCcHeaderMemberOf <RecipientIdParameter []>] - [-ExceptIfAnyOfToHeader <RecipientIdParameter []>] - [-ExceptIfAnyOfToHeaderMemberOf <RecipientIdParameter []>] - [-ExceptIfAttachmentContainsWords <Word []>] - [-ExceptIfAttachmentExtensionMatchesWords <Word []>] - [-ExceptIfAttachmentHasExecutableContent <$true | $false>] - [-ExceptIfAttachmentIsPasswordProtected <$true | $false>] - [-ExceptIfAttachmentIsUnsupported <$true | $false>] - [-ExceptIfAttachmentMatchesPatterns <Pattern []>] - [-ExceptIfAttachmentNameMatchesPatterns <Pattern []>] - [-ExceptIfAttachmentProcessingLimitExceeded <$true | $false>] - [-ExceptIfAttachmentPropertyContainsWords <Word []>] - [-ExceptIfAttachmentSizeOver <ByteQuantifiedSize>] - [-ExceptIfBetweenMemberOf1 <RecipientIdParameter []>] - [-ExceptIfBetweenMemberOf2 <RecipientIdParameter []>] - [-ExceptIfContentCharacterSetContainsWords <Word []>] - [-ExceptIfFrom <RecipientIdParameter []>] - [-ExceptIfFromAddressContainsWords <Word []>] - [-ExceptIfFromAddressMatchesPatterns <Pattern []>] - [-ExceptIfFromMemberOf <RecipientIdParameter []>] - [-ExceptIfFromScope <InOrganization | NotInOrganization>] - [-ExceptIfHasClassification <String>] - [-ExceptIfHasNoClassification <$true | $false>] - [-ExceptIfHasSenderOverride <$true | $false>] - [-ExceptIfHeaderContainsMessageHeader <HeaderName>] - [-ExceptIfHeaderContainsWords <Word []>] - [-ExceptIfHeaderMatchesMessageHeader <HeaderName>] - [-ExceptIfHeaderMatchesPatterns <Pattern []>] - [-ExceptIfManagerAddresses <RecipientIdParameter []>] - [-ExceptIfManagerForEvaluatedUser <Sender | Recipient>] - [-ExceptIfMessageContainsAllDataClassifications <Hashtable []>] - [-ExceptIfMessageContainsDataClassifications <Hashtable []>] - [-ExceptIfMessageSizeOver <ByteQuantifiedSize>] - [-ExceptIfMessageTypeMatches <OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt>] - [-ExceptIfRecipientADAttributeContainsWords <Word []>] - [-ExceptIfRecipientADAttributeMatchesPatterns <Pattern []>] - [-ExceptIfRecipientAddressContainsWords <Word []>] - [-ExceptIfRecipientAddressMatchesPatterns <Pattern []>] - [-ExceptIfRecipientDomainIs <Word []>] - [-ExceptIfRecipientInSenderList <Word []>] - [-ExceptIfSCLOver <SclValue>] - [-ExceptIfSenderADAttributeContainsWords <Word []>] - [-ExceptIfSenderADAttributeMatchesPatterns <Pattern []>] - [-ExceptIfSenderDomainIs <Word []>] - [-ExceptIfSenderInRecipientList <Word []>] - [-ExceptIfSenderIpRanges <MultiValuedProperty>] - [-ExceptIfSenderManagementRelationship <Manager | DirectReport>] - [-ExceptIfSentTo <RecipientIdParameter []>] - [-ExceptIfSentToMemberOf <RecipientIdParameter []>] - [-ExceptIfSentToScope <InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner>] - [-ExceptIfSubjectContainsWords <Word []>] - [-ExceptIfSubjectMatchesPatterns <Pattern []>] - [-ExceptIfSubjectOrBodyContainsWords <Word []>] - [-ExceptIfSubjectOrBodyMatchesPatterns <Pattern []>] - [-ExceptIfWithImportance <Low | Normal | High>] - [-ExpiryDate <DateTime>] - [-From <RecipientIdParameter []>] - [-FromAddressContainsWords <Word []>] - [-FromAddressMatchesPatterns <Pattern []>] - [-FromMemberOf <RecipientIdParameter []>] - [-FromScope <InOrganization | NotInOrganization>] - [-GenerateIncidentReport <RecipientIdParameter>] - [-GenerateNotification <DisclaimerText>] - [-HasClassification <String>] - [-HasNoClassification <$true | $false>] - [-HasSenderOverride <$true | $false>] - [-HeaderContainsMessageHeader <HeaderName>] - [-HeaderContainsWords <Word []>] - [-HeaderMatchesMessageHeader <HeaderName>] - [-HeaderMatchesPatterns <Pattern []>] - [-IncidentReportContent <IncidentReportContent []>] - [-IncidentReportOriginalMail <IncludeOriginalMail | DoNotIncludeOriginalMail>] - [-LogEventText <EventLogText>] - [-ManagerAddresses <RecipientIdParameter []>] - [-ManagerForEvaluatedUser <Sender | Recipient>] - [-MessageContainsAllDataClassifications <Hashtable []>] - [-MessageContainsDataClassifications <Hashtable []>] - [-MessageSizeOver <ByteQuantifiedSize>] - [-MessageTypeMatches <OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt>] - [-Mode <Audit | AuditAndNotify | Enforce>] - [-ModerateMessageByManager <$true | $false>] - [-ModerateMessageByUser <RecipientIdParameter []>] - [-Name <String>] - [-NotifySender <NotifyOnly | RejectMessage | RejectUnlessFalsePositiveOverride | RejectUnlessSilentOverride | RejectUnlessExplicitOverride>] - [-PrependSubject <SubjectPrefix>] - [-Priority <Int32>] - [-Quarantine <$true | $false>] - [-RecipientADAttributeContainsWords <Word []>] - [-RecipientADAttributeMatchesPatterns <Pattern []>] - [-RecipientAddressContainsWords <Word []>] - [-RecipientAddressMatchesPatterns <Pattern []>] - [-RecipientDomainIs <Word []>] - [-RecipientInSenderList <Word []>] - [-RedirectMessageTo <RecipientIdParameter []>] - [-RejectMessageEnhancedStatusCode <RejectEnhancedStatus>] - [-RejectMessageReasonText <RejectText>] - [-RemoveHeader <HeaderName>] - [-RemoveOME <$true | $false>] - [-RemoveOMEv2 <$true | $false>] - [-RouteMessageOutboundConnector <OutboundConnectorIdParameter>] - [-RouteMessageOutboundRequireTls <$true | $false>] - [-RuleErrorAction <Ignore | Defer>] - [-RuleSubType <None | Dlp>] - [-SCLOver <SclValue>] - [-SenderADAttributeContainsWords <Word []>] - [-SenderADAttributeMatchesPatterns <Pattern []>] - [-SenderAddressLocation <Header | Envelope | HeaderOrEnvelope>] - [-SenderDomainIs <Word []>] - [-SenderInRecipientList <Word []>] - [-SenderIpRanges <MultiValuedProperty>] - [-SenderManagementRelationship <Manager | DirectReport>] - [-SentTo <RecipientIdParameter []>] - [-SentToMemberOf <RecipientIdParameter []>] - [-SentToScope <InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner>] - [-SetAuditSeverity <String>] - [-SetHeaderName <HeaderName>] - [-SetHeaderValue <HeaderValue>] - [-SetSCL <SclValue>] - [-SmtpRejectMessageRejectStatusCode <RejectStatusCode>] - [-SmtpRejectMessageRejectText <RejectText>] - [-StopRuleProcessing <$true | $false>] - [-SubjectContainsWords <Word []>] - [-SubjectMatchesPatterns <Pattern []>] - [-SubjectOrBodyContainsWords <Word []>] - [-SubjectOrBodyMatchesPatterns <Pattern []>] - [-WhatIf] - [-WithImportance <Low | Normal | High>] - [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TransportRule "Sales Team Disclaimer" -FromMemberOf "Sales Department" -``` - -This example modifies the existing rule named Sales Team Disclaimer transport rule by adding the condition that the sender of the message is a member of the Sales Department group. - -This example sets the FromMemberOf parameter to a value of Sales-Group, which specifies that the rule is applied if the sender of the message is a member of the Sales-Group distribution group. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActivationDate -The ActivationDate parameter specifies when the rule starts processing messages. The rule won't take any action on messages until the specified date/time. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADComparisonAttribute -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ADComparisonAttribute parameter specifies a condition that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -If you don't use the ADComparisonOperator parameter, the default comparison operator Equal is used. - -```yaml -Type: DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15 -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADComparisonOperator -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ADComparisonOperator parameter specifies the comparison operator for the ADComparisonAttribute parameter. Valid values are: - -- Equal (This is the default value) - -- NotEqual - -```yaml -Type: Equal | NotEqual -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddManagerAsRecipientType -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The AddManagerAsRecipientType parameter specifies an action that delivers or redirects messages to the user that's defined in the sender's Manager attribute. Valid values are: - -- To: Add the sender's manager to the To field of the message. - -- Cc: Add the sender's manager to the Cco field of the message. - -- Bcc: Add the sender's manager to the Bcc field of the message. - -- Redirect: Redirect the message to the sender's manager without notifying the sender or the recipients. - -This action only works if the sender's Manager attribute is defined. - -```yaml -Type: To | Cc | Bcc | Redirect -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddToRecipients -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. - -The AddToRecipients parameter specifies an action that adds recipients to the To field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfCcHeader -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfCcHeader parameter specifies a condition that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfCcHeaderMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfRecipientAddressContainsWords -This parameter specifies a condition or 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. - -The AnyOfRecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfRecipientAddressMatchesPatterns -This parameter specifies a condition or 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. - -The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToCcHeader -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToCcHeader parameter specifies a condition that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToCcHeaderMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToHeader -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToHeader parameter specifies a condition that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnyOfToHeaderMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyClassification -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyClassification parameter specifies an action that applies a message classification to messages. Use the Get-MessageClassification cmdlet to see the message classification objects that are available. - -The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the data loss prevention (DLP) data classification. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyHtmlDisclaimerFallbackAction -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be added to a message. Valid values are: - -- Wrap: The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. This is the default value. Subsequent mail flow rules are applied to the new message envelope, not to the original message. Therefore, configure a rule with this action at a lower priority (a higher priority number) than other rules. If the original message can't be wrapped in a new message envelope, the original message isn't delivered. The message is returned to the sender in an non-delivery report (also known as an NDR or bounce message). - -- Ignore: The rule is ignored and the message is delivered without the disclaimer. - -- Reject: The message is rejected. - -If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. - -```yaml -Type: Wrap | Ignore | Reject -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyHtmlDisclaimerLocation -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -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. - -- Prepend: The disclaimer is inserted to the beginning of the message body. - -If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. - -```yaml -Type: Append | Prepend -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyHtmlDisclaimerText -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. - -You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyOME -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The ApplyOME parameter specifies an action that encrypts messages and their attachments by using Office 365 Message Encryption. Valid values are: - -- $true: The message and attachments are encrypted. - -- $false: The message and attachments aren't encrypted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyRightsProtectionTemplate -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ApplyRightsProtectionTemplate parameter specifies an action that applies rights management service (RMS) templates to messages. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). - -To use this action, you need to have an Active Directory Rights Management Services (AD RMS) server in your organization, or your organization needs to use the ILS service. - -Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. - -For more information, see Transport protection rules (https://technet.microsoft.com/library/dd298166.aspx). - -```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: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentContainsWords parameter specifies a condition 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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentExtensionMatchesWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentExtensionMatchesWords parameter specifies a condition that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentHasExecutableContent -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentHasExecutableContent parameter specifies a condition that looks for executable content in message attachments. Valid values are: - -- $true: Look for executable content in message attachments. - -- $false: Don't look for executable content in message attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentIsPasswordProtected -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - -- $true: Look for password protected attachments. - -- $false: Don't look for password protected attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentIsUnsupported -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: - -- $true: Look for unsupported file types in messages. - -- $false: Don't look for unsupported file types in messages. - -For more information, see Register Filter Pack IFilters with Exchange (https://technet.microsoft.com/library/jj837174.aspx). - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. - -You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -Only the first 150 kilobytes (KB) of the attachment is scanned when trying to match a text pattern. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentNameMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentProcessingLimitExceeded -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The AttachmentProcessingLimitExceeded parameter specifies a condition that looks for messages where attachment scanning didn't complete. Valid values are: - -- $true: Look for messages where attachment scanning didn't complete. - -- $false: Don't look for messages where attachment scanning didn't complete. - -You use this condition to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentPropertyContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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: - -- Business Impact - -- Compliancy - -- Confidentiality - -- Department - -- Impact - -- Intellectual Property - -- Personally Identifiable Information - -- Personal Information - -- Personal Use - -- Required Clearance - -- PHI - -- PII - -- Project - -- Protected Health Information - -The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use leading or trailing spaces. - -When you specify multiple properties, or multiple values for the same property, the or operator is used. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentSizeOver -This parameter specifies a condition or 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. - -The AttachmentSizeOver parameter specifies a condition that looks for messages where any attachment is greater than the specified size. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BetweenMemberOf1 -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The BetweenMemberOf1 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BetweenMemberOf2 -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The BetweenMemberOf2 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlindCopyTo -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. - -The BlindCopyTo parameter specifies an action that adds recipients to the Bcc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentCharacterSetContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ContentCharacterSetContainsWords parameter specifies a condition that looks for character set names in 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyTo -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. - -The CopyTo parameter specifies an action that adds recipients to the Cc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteMessage -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. - -The DeleteMessage parameter specifies an action that silently drops messages without an NDR. Valid values are: - -- $true: Silently drop the message without an NDR. - -- $false: Don't silently drop the message. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disconnect -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The Disconnect parameter specifies an action that ends the SMTP connection between the sending server and the Edge Transport server without generating an NDR. - -- $true: Silently end the SMTP session without generating an NDR. - -- $false: Don't silently end the SMTP session. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpPolicy -The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see Data loss prevention (https://technet.microsoft.com/library/jj150527.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfADComparisonAttribute -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfADComparisonAttribute parameter specifies an exception that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -If you don't use the ExceptIfADComparisonOperator parameter, the default comparison operator Equal is used. - -```yaml -Type: DisplayName | FirstName | Initials | LastName | Office | PhoneNumber | OtherPhoneNumber | Email | Street | POBox | City | State | ZipCode | Country | UserLogonName | HomePhoneNumber | OtherHomePhoneNumber | PagerNumber | MobileNumber | FaxNumber | OtherFaxNumber | Notes | Title | Department | Company | Manager | CustomAttribute1 | CustomAttribute2 | CustomAttribute3 | CustomAttribute4 | CustomAttribute5 | CustomAttribute6 | CustomAttribute7 | CustomAttribute8 | CustomAttribute9 | CustomAttribute10 | CustomAttribute11 | CustomAttribute12 | CustomAttribute13 | CustomAttribute14 | CustomAttribute15 -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfADComparisonOperator -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfADComparisonOperator parameter specifies the comparison operator for the ExceptIfADComparisonAttribute parameter. Valid values are: - -- Equal (This is the default value) - -- NotEqual - -```yaml -Type: Equal | NotEqual -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAnyOfToHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. - -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentContainsWords parameter specifies an exception 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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentExtensionMatchesWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentHasExecutableContent -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that looks for executable content in message attachments. Valid values are: - -- $true: Look for executable content in message attachments. - -- $false: Don't look for executable content in message attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentIsPasswordProtected -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - -- $true: Look for password protected attachments. - -- $false: Don't look for password protected attachments. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentIsUnsupported -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: - -- $true: Look for unsupported file types in messages. - -- $false: Don't look for unsupported file types in messages. - -For more information, see Register Filter Pack IFilters with Exchange (https://technet.microsoft.com/library/jj837174.aspx). - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. - -You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -Only the first 150 KB of the attachment is scanned when trying to match a text pattern. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentNameMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentProcessingLimitExceeded -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfAttachmentProcessingLimitExceeded parameter specifies an exception that looks for messages where attachment scanning didn't complete. Valid values are: - -- $true: Look for messages where attachment scanning didn't complete. - -- $false: Don't look for messages where attachment scanning didn't complete. - -You use this exception to create rules that work together with other attachment processing rules to handle messages where the content can't be fully scanned. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentPropertyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available 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: - -- Business Impact - -- Compliancy - -- Confidentiality - -- Department - -- Impact - -- Intellectual Property - -- Personally Identifiable Information - -- Personal Information - -- Personal Use - -- Required Clearance - -- PHI - -- PII - -- Project - -- Protected Health Information - -The syntax for this parameter is "PropertyName:Word". To specify multiple properties, or multiple words for the same property, use the following syntax: "PropertyName1:Word1,Phrase with spaces,word2,...","PropertyName2:Word3,Phrase with spaces,word4,...". Don't use values with leading or trailing spaces. - -When you specify multiple properties, or multiple values for the same property, the or operator is used. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfAttachmentSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfAttachmentSizeOver parameter specifies an exception that looks for messages where any attachment is greater than the specified size. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfBetweenMemberOf1 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfBetweenMemberOf2 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfContentCharacterSetContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfContentCharacterSetContainsWords parameter specifies an exception that looks for character set names in 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFrom -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfFromAddressContainsWords parameter specifies an exception that looks for words in the sender's email address. You can specify multiple words separated by commas. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfFromAddressMatchesPatterns parameter specifies an exception 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\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfFromScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: - -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. - -```yaml -Type: InOrganization | NotInOrganization -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHasClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfHasClassification parameter specifies an exception that looks for messages with the specified message classification. - -You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: - --ExceptIfHasClassification @(Get-MessageClassification "Company Internal").Identity - -The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP data classification. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHasNoClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfHasNoClassification parameter specifies an exception that looks for messages with or without any message classifications. Valid values are: - -- $true: Look for messages that don't have a message classification. - -- $false: Look for messages that have one or more message classifications. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHasSenderOverride -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfHasSenderOverride parameter specifies an exception that looks for messages where the sender chose to override a DLP policy. Valid values are: - -- $true: Look for messages where the sender took action to override a DLP policy. - -- $false: Don't look for messages where the sender took action to override a DLP policy. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderContainsMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the ExceptIfHeaderContainsWords parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderContainsWords parameter specifies an exception 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. - -You specify the header field to search by using the ExceptIfHeaderContainsMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderMatchesMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the ExceptIfHeaderMatchesPatterns parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfHeaderMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfHeaderMatchesPatterns parameter specifies an exception 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 specify the header field to search by using the ExceptIfHeaderMatchesMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfManagerAddresses -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You specify if you want to look for these users as managers of senders or recipients by using the ExceptIfManagerForEvaluatedUser parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfManagerForEvaluatedUser -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfManagerForEvaluatedUser parameter specifies an exception that looks for users in the Manager attribute of senders or recipients. Valid values are: - -- Recipient: The user is the manager of a recipient. - -- Sender: The user is the manager of the sender. - -You specify the users to look for by using the ExceptIfManagerAddresses parameter. - -```yaml -Type: Sender | Recipient -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageContainsAllDataClassifications -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageContainsDataClassifications -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. - -This parameter uses the syntax @{\<SensitiveInformationType1\>},@{\<SensitiveInformationType2\>},...@{\<SensitiveInformationTypeN\>}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. - -For a list of sensitive information types available, see Sensitive information types (https://technet.microsoft.com/library/jj150541.aspx). - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfMessageSizeOver parameter specifies an exception that looks for messages larger than the specified size. The size includes the message and all attachments. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfMessageTypeMatches -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - -- OOF: Auto-reply messages configured by the user. - -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook or Outlook). - -- Encrypted: Encrypted messages. - -- Calendaring: Meeting requests and responses. - -- PermissionControlled: Messages that have specific permissions configured. - -- Voicemail: Voice mail messages forwarded by Unified Messaging service. - -- Signed: Digitally signed messages. - -- ApprovalRequest: Moderations request messages sent to moderators. - -- ReadReceipt: Read receipts. - -```yaml -Type: OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the ExceptIfRecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfRecipientInSenderList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSCLOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: - -- -1: The message is from a trusted sender, so the message bypasses spam filtering. - -- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. - -The rule looks for messages with an SCL value that's greater than or equal to the specified value. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderADAttributeContainsWords parameter specifies an exception that looks for words in Active Directory attributes of message senders. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in Active Directory attributes of message senders by using regular expressions. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderInRecipientList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderIpRanges -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderIpRanges parameter specifies an exception that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - -- Single IP address: For example, 192.168.1.1. - -- IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify multiple IP addresses or ranges separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSenderManagementRelationship -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSenderManagementRelationship parameter specifies an exception that looks for the relationship between the sender and recipients in messages. Valid values are: - -- Manager: The sender is the manager of a recipient. - -- DirectReport: A recipient is the manager of the sender. - -```yaml -Type: Manager | DirectReport -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentTo -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -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 - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSentToScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: - -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. - -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. - -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. - -```yaml -Type: InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectContainsWords parameter specifies an exception that looks for words in the Subject field of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectMatchesPatterns parameter specifies an exception 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectOrBodyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception that looks for words in the Subject field or body of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfSubjectOrBodyMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. - -The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExceptIfWithImportance -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -In on-premises Exchange, this exception is only available on Mailbox servers. - -The ExceptIfWithImportance parameter specifies an exception that looks for messages with the specified importance level. Valid values are: - -- Low - -- Normal - -- High - -```yaml -Type: Low | Normal | High -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDate -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromAddressContainsWords -This parameter specifies a condition or 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. - -The FromAddressContainsWords parameter specifies a condition that looks for words in the sender's email address. You can specify multiple words separated by commas. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromAddressMatchesPatterns -This parameter specifies a condition or 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. - -The FromAddressMatchesPatterns parameter specifies a condition 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\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromScope -This parameter specifies a condition or 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. - -The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: - -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. - -```yaml -Type: InOrganization | NotInOrganization -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateIncidentReport -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The GenerateIncidentReport parameter specifies where to send the incident report that's defined by the IncidentReportContent parameter. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -An incident report is generated for messages that violate a DLP policy in your organization. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateNotification -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The GenerateNotification parameter specifies an action that sends a notification message to recipients. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. - -This parameter supports plain text, HTML tags and the following keywords that use values from the original message: - -- %%From%% - -- %%To%% - -- %%Cc%% - -- %%Subject%% - -- %%Headers%% - -- %%MessageDate%% - -```yaml -Type: DisclaimerText -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasClassification -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The HasClassification parameter specifies a condition that looks for messages with the specified message classification. - -You use the Get-MessageClassification cmdlet to identify the message classification. For example, to find messages with the Company Internal classification, use the following syntax: - --HasClassification @(Get-MessageClassification "Company Internal").Identity - -The message classification referred to in this parameter is the custom message classification that you can create in your organization by using the New-MessageClassification cmdlet. It isn't related to the DLP classification. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasNoClassification -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The HasNoClassification parameter specifies a condition that looks for messages with or without any message classifications. Valid values are: - -- $true: Look for messages that don't have a message classification. - -- $false: Look for messages that have one or more message classifications. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasSenderOverride -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The HasSenderOverride parameter specifies a condition that looks for messages where the sender chose to override a DLP policy. Valid values are: - -- $true: Look for messages where the sender took action to override a DLP policy. - -- $false: Don't look for messages where the sender took action to override a DLP policy. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderContainsMessageHeader -This parameter specifies a condition or 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. - -The HeaderContainsMessageHeader parameter specifies the name of header field in the message header when searching for the words specified by the HeaderContainsWords parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderContainsWords -This parameter specifies a condition or 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. - -The HeaderContainsWords parameter specifies a condition 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. - -You specify the header field to search by using the HeaderContainsMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderMatchesMessageHeader -This parameter specifies a condition or 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. - -The HeaderMatchesMessageHeader parameter specifies the name of header field in the message header when searching for the text patterns specified by the HeaderMatchesPatterns parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeaderMatchesPatterns -This parameter specifies a condition or 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. - -The HeaderMatchesPatterns parameter specifies a condition 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 specify the header field to search by using the HeaderMatchesMessageHeader parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportContent -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The IncidentReportContent parameter specifies the message properties that are included in the incident report that's generated when a message violates a DLP policy. Valid values are: - -- 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. - -- 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. - -- Severity: The audit severity of the rule that was triggered. If the message was processed by more than one rule, the highest severity is displayed. - -- Override: The override if the sender chose to override a PolicyTip. If the sender provided a justification, the first 100 characters of the justification is also included. - -- RuleDetections: The list of rules that the message triggered. - -- FalsePositive: The false positive if the sender marked the message as a false positive for a PolicyTip. - -- DataClassifications: The list of sensitive information types that were detected in the message. - -- IdMatch: The sensitive information type that was detected, the exact matched content from the message, and the 150 characters before and after the matched sensitive information. - -- AttachOriginalMail: The entire original message as an attachment. - -The message ID is always included in the incident report. - -You can specify multiple values separated by commas. - -You use this parameter with the GenerateIncidentReport parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncidentReportOriginalMail -This parameter is available or functional 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 specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available 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: - -- IncludeOriginalMail - -- DoNotIncludeOriginalMail (this is the default value) - -```yaml -Type: IncludeOriginalMail | DoNotIncludeOriginalMail -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogEventText -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The LogEventText parameter specifies an action that creates an entry in the Application log on the local Edge Transport server. The value for this parameter specifies the text that you want to include in the event log entry. If the text contains spaces, enclose the value in quotation marks ("). - -The entry contains the following information: - -- Level: Information - -- Source: MSExchange Messaging Policies - -- Event ID: 4000 - -- Task Category: Rules - -- EventData: The following message is logged by an action in the rules: \<text you specify\> - -```yaml -Type: EventLogText -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 -``` - -### -ManagerAddresses -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You specify if you want to look for these users as managers of senders or recipients by using the ManagerForEvaluatedUser parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagerForEvaluatedUser -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The ManagerForEvaluatedUser parameter specifies a condition that looks for users in the Manager attribute of senders or recipients. Valid values are: - -- Recipient: The user is the manager of a recipient. - -- Sender: The user is the manager of the sender. - -You specify the users to look for by using the ManagerAddresses parameter. - -```yaml -Type: Sender | Recipient -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageContainsAllDataClassifications -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageContainsDataClassifications -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. - -This parameter uses the syntax @{\<SensitiveInformationType1\>},@{\<SensitiveInformationType2\>},...@{\<SensitiveInformationTypeN\>}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. - -For a list of sensitive information types available, see Sensitive information types (https://technet.microsoft.com/library/jj150541.aspx). - -You can specify the notification options by using the NotifySender parameter. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageSizeOver -This parameter specifies a condition or 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. - -The MessageSizeOver parameter specifies a condition that looks for messages larger than the specified size. The size includes the message and all attachments. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTypeMatches -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - -- OOF: Auto-reply messages configured by the user. - -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook or Outlook). - -- Encrypted: Encrypted messages. - -- Calendaring: Meeting requests and responses. - -- PermissionControlled: Messages that have specific permissions configured. - -- Voicemail: Voice mail messages forwarded by Unified Messaging service. - -- Signed: Digitally signed messages. - -- ApprovalRequest: Moderations request messages sent to moderators. - -- ReadReceipt: Read receipts. - -```yaml -Type: OOF | AutoForward | Encrypted | Calendaring | PermissionControlled | Voicemail | Signed | ApprovalRequest | ReadReceipt -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The Mode parameter specifies how the rule operates. Valid values are: - -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. - -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. - -- Enforce: All actions specified in the rule are taken. This is the default value. - -```yaml -Type: Audit | AuditAndNotify | Enforce -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerateMessageByManager -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ModerateMessageByManager parameter specifies an action that forwards messages for approval to the user that's specified in the sender's Manager attribute. After the manager approves the message, it's delivered to the recipients. Valid values are: - -- $true: Moderation by the sender's manager is enabled. - -- $false: Moderation by the sender's manager is disabled. - -This action only works if the sender's Manager attribute is defined. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerateMessageByUser -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The ModerateMessageByUser parameter specifies an action that forwards messages for approval to the specified users. After one of the users approves the message, it's delivered to the recipients. You can use ay value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You can't use a distribution group as a moderator. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifySender -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The NotifySender parameter specifies an action that notifies the sender when messages violate DLP policies. Valid values are: - -- NotifyOnly: The sender is notified, but the message is delivered normally. - -- RejectMessage: The message is rejected, and the sender is notified. - -- RejectUnlessFalsePositiveOverride: The message is rejected unless it's marked as a false positive by the sender. - -- RejectUnlessSilentOverride: The message is rejected unless the sender has chosen to override the policy restriction. - -- RejectUnlessExplicitOverride: This is the same as RejectUnlessSilentOverride, but the sender can also provide a justification for overriding the policy restriction. - -For all values except NotifyOnly, you can specify an enhanced status code and a rejection reason by using the RejectMessageEnhancedStatusCode and RejectMessageReasonText parameters. The default enhanced status code is 5.7.1, and the default rejection reason is Delivery not authorized, message refused. - -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. - -```yaml -Type: NotifyOnly | RejectMessage | RejectUnlessFalsePositiveOverride | RejectUnlessSilentOverride | RejectUnlessExplicitOverride -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrependSubject -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. - -The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks (")\> - -Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: - -- Valid priority values for the existing 8 rules are from 0 through 7. - -- Valid priority values for a new rule (the 9th rule) are from 0 through 8. - -- The default value for a new rule (the 9th rule) is 8. - -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. - -```yaml -Type: 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quarantine -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The Quarantine parameter specifies an action that quarantines messages. - -- In on-premises Exchange, messages are delivered to the quarantine mailbox that you've configured as part of Content filtering. If the quarantine mailbox isn't configured, the message is returned to the sender in an NDR. - -- In Office 365, messages are delivered to the hosted quarantine. - -```yaml -Type: $true | $false -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 -``` - -### -RecipientADAttributeContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientADAttributeContainsWords parameter specifies a condition that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientADAttributeMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddressContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddressMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\<regular expression1\>","\<regular expression2\>",..."\<regular expressionN\>". - -This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientDomainIs -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the RecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientInSenderList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectMessageTo -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. - -The RedirectMessageTo parameter specifies a rule action that redirects messages to the specified recipients. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessageEnhancedStatusCode -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999. - -You can use this parameter with the NotifySender and RejectMessageReasonText parameters to specify the custom enhanced status code that's used. If you don't use this parameter, the default value 5.7.1 is used. - -To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessageReasonText -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). - -You can use this parameter with the NotifySender and RejectMessageEnhancedStatusCode parameters to specify the custom explanation text that's used. If you don't use this parameter, the default value Delivery not authorized, message refused is used. - -To further customize the NDR (for example, multiple languages), you need to create a custom message by using the New-SystemMessage cmdlet. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveHeader -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. - -The RemoveHeader parameter specifies an action that removes a header field from the message header. The value of this parameter specifies the name of the header field to remove. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveOME -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The RemoveOME parameter specifies an action that removes the previous version of Office 365 Message Encryption from messages and their attachments. Valid values are: - -- $true: The message and attachments are decrypted. - -- $false: The message and attachments aren't decrypted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveOMEv2 -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The RemoveOMEv2 parameter specifies an action that removes Office 365 Message Encryption from messages and their attachments. Valid values are: - -- $true: The message and attachments are decrypted. - -- $false: The message and attachments aren't decrypted. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteMessageOutboundConnector -This parameter is available only in the cloud-based service. - -This parameter specifies an action or part of an action for the rule. - -The RouteMessageOutboundConnector parameter specifies an action that routes messages through the specified Outbound connector in Office 365. You can use any value that uniquely identifies the connector. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OutboundConnectorIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteMessageOutboundRequireTls -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The RouteMessageOutboundRequireTls parameter specifies an action that uses Transport Layer Security (TLS) encryption to deliver messages outside your organization. Valid values are: - -- $true: The messages must be delivered over a TLS encrypted channel. - -- $false: A TLS encrypted channel isn't required to deliver the messages. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleErrorAction -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. - -- Defer: The message is deferred so the rules engine can attempt to process the message again. - -```yaml -Type: Ignore | Defer -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSubType -The RuleSubType parameter specifies the rule type. Valid values are: - -- Dlp: The rule is associated with a DLP policy. - -- None: The rule is a regular rule that isn't associated with a DLP policy. - -```yaml -Type: None | Dlp -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SCLOver -This parameter specifies a condition or 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. - -The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: - -- -1: The message is from a trusted sender, so the message bypasses spam filtering. - -- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. - -The rule looks for messages with an SCL value that's greater than or equal to the specified value. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderADAttributeContainsWords -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderADAttributeContainsWords parameter specifies a condition that looks for words in Active Directory attributes of message senders. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Word". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Word1,Phrase with spaces,word2...","AttributeName2:Word3,Phrase with spaces,word4...". Don't use words with leading or trailing spaces. - -For example, "City:San Francisco,Palo Alto" or "City:San Francisco,Palo Alto","Department:Sales,Finance". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderADAttributeMatchesPatterns -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in Active Directory attributes of message senders by using regular expressions. - -You can check against any of the following Active Directory attributes: - -- City - -- Company - -- Country - -- CustomAttribute1 - CustomAttribute15 - -- Department - -- DisplayName - -- Email - -- FaxNumber - -- FirstName - -- HomePhoneNumber - -- Initials - -- LastName - -- Manager - -- MobileNumber - -- Notes - -- Office - -- OtherFaxNumber - -- OtherHomePhoneNumber - -- OtherPhoneNumber - -- PagerNumber - -- PhoneNumber - -- POBox - -- State - -- Street - -- Title - -- UserLogonName - -- ZipCode - -This parameter uses the syntax: "AttributeName:Regular Expression". To specify multiple attributes, or multiple words for the same attribute, use the following syntax: "AttributeName1:Regular Expression1,Regular Expression2...","AttributeName2:Regular Expression3,Regular Expression4...". - -When you specify multiple attributes, or multiple values for the same attribute, the or operator is used. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddressLocation -The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - -- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - -- HeaderOrEnvelope: Examine senders in the message header and the message envelope. - -Note that message envelope searching is only available for the following conditions and exceptions: - -- From and ExceptIfFrom - -- FromAddressContainsWords and ExceptIfFromAddressContainsWords - -- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns - -- FromMemberOf and ExceptIfFromMemberOf - -- SenderDomainIs and ExceptIfSenderDomainIs - -```yaml -Type: Header | Envelope | HeaderOrEnvelope -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderDomainIs -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. - -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. - -You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderInRecipientList -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Word[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderIpRanges -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderIpRanges parameter specifies a condition that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - -- Single IP address: For example, 192.168.1.1. - -- IP address range: For example, 192.168.0.1-192.168.0.254. - -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify multiple IP addresses or ranges separated by commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderManagementRelationship -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SenderManagementRelationship parameter specifies a condition that looks for the relationship between the sender and recipients in messages. Valid values are: - -- Manager: The sender is the manager of a recipient. - -- DirectReport: A recipient is the manager of the sender. - -```yaml -Type: Manager | DirectReport -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -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 - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToMemberOf -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - -- Name - -- Distinguished name (DN) - -- Display name - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentToScope -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: - -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. - -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. - -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. - -```yaml -Type: InOrganization | NotInOrganization | ExternalPartner | ExternalNonPartner -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetAuditSeverity -This parameter specifies an action or part of an action for the rule. - -In on-premises Exchange, this action is only available on Mailbox servers. - -The SetAuditSeverity parameter specifies an action that sets the severity level of the incident report and the corresponding entry that's written to the message tracking log when messages violate DLP policies. Valid values are: - -- DoNotAudit: No audit entry is logged. - -- Low: The audit entry is assigned low severity. - -- Medium: The audit entry is assigned medium severity. - -- High: The audit entry is assigned high severity. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetHeaderName -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. - -The SetHeaderName parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the name of the header field that you want to add or modify. When you use this parameter, you also need to use the SetHeaderValue parameter to specify a value for the header. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetHeaderValue -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. - -The SetHeaderValue parameter specifies an action that adds or modifies a header field in the message header. The value of this parameter is the value that you want to apply to the header field. When you use this parameter, you also need to use the SetHeaderName parameter to specify the name of the header field that you want to add or modify. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetSCL -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. - -The SetSCL parameter specifies an action that adds or modifies the SCL value of messages. Valid values are: - -- -1: The message is from a trusted sender, so the message bypasses spam filtering. - -- Integers 0 through 9: A higher value indicates that a message is more likely to be spam. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmtpRejectMessageRejectStatusCode -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The SmtpRejectMessageRejectStatusCode parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the SMTP code that's used. Valid values are the integers 400 through 500. - -You can use this parameter with the SmtpRejectMessageRejectText parameter. If you don't use this parameter, the default SMTP code 550 is used. - -```yaml -Type: RejectStatusCode -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 -``` - -### -SmtpRejectMessageRejectText -This parameter specifies an action or part of an action for the rule. - -This action is available only on Edge Transport servers in on-premises Exchange. - -The SmtpRejectMessageRejectText parameter specifies an action that disconnects the sending server from the Edge Transport server. The value of this parameter is the explanation text that's used. If the value contains spaces, enclose the value in quotation marks ("). - -You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. If you don't use this parameter, the default text Delivery not authorized, message refused is used. - -```yaml -Type: RejectText -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 -``` - -### -StopRuleProcessing -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. - -The StopRuleProcessing parameter specifies an action that stops processing more rules. Valid values are: - -- $true: Stop processing more rules. - -- $false: Continue processing more rules after this one. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectContainsWords -This parameter specifies a condition or 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. - -The SubjectContainsWords parameter specifies a condition that looks for words in the Subject field of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectMatchesPatterns -This parameter specifies a condition or 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. - -The SubjectMatchesPatterns parameter specifies a condition 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectOrBodyContainsWords -This parameter specifies a condition or 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. - -The SubjectOrBodyContainsWords parameter specifies a condition that looks for words in the Subject field or body of messages. - -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectOrBodyMatchesPatterns -This parameter specifies a condition or 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. - -The SubjectOrBodyMatchesPatterns parameter specifies a condition 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\>". - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WithImportance -This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. - -In on-premises Exchange, this condition is only available on Mailbox servers. - -The WithImportance parameter specifies a condition that looks for messages with the specified importance level. Valid values are: - -- Low - -- Normal - -- High - -```yaml -Type: Low | Normal | High -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8328125b-e166-436f-95e6-1afafdbdb89a.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md deleted file mode 100644 index 1c0223a638..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-ConnectionByClientTypeDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-ConnectionByClientTypeDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-ConnectionByClientTypeDetailReport cmdlet to view details about the different types of clients that connected to mailboxes in your organization. The client types indicate different protocols, for example, Outlook on the web, MAPI, POP3, IMAP4, Exchange ActiveSync, and Exchange Web Services. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ConnectionByClientTypeDetailReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ConnectionByClientTypeDetailReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves details about the different types of clients used to connect to mailboxes between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cfb0abba-0cc1-4a6a-9b38-55c4eef5805e.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-ConnectionByClientTypeReport.md b/exchange/exchange-ps/exchange/reporting/Get-ConnectionByClientTypeReport.md deleted file mode 100644 index 84fb0af386..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-ConnectionByClientTypeReport.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-ConnectionByClientTypeReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-ConnectionByClientTypeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-ConnectionByClientTypeReport cmdlet to view a summary of the different types of clients that connected to all mailboxes in your organization. The client types indicate different protocols, for example, Outlook on the web, MAPI, POP3, IMAP4, Exchange ActiveSync, and Exchange Web Services. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ConnectionByClientTypeReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -Note: There's a 7-day lag in the client connection information that's returned by this cmdlet. For example, if you run the cmdlet on June 18, 2018, you can't retrieve information about connections made to mailboxes between June 13, 2018 and June 15, 2018. To get connection information for that date range, you need to run the cmdlet on June 22, 2018 or later. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ConnectionByClientTypeReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves a summary of the different types of clients used to connect to all mailboxes between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f5e9bb82-1fc5-46df-aaa3-41db6dc64e22.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsAVConferenceTimeReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsAVConferenceTimeReport.md deleted file mode 100644 index ab4d6f2c68..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsAVConferenceTimeReport.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsAVConferenceTimeReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsAVConferenceTimeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsAVConferenceTimeReport cmdlet to view statistics about the time in minutes that was used during audio and video conferences that were held by Skype for Business Online users in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsAVConferenceTimeReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsAVConferenceTimeReport to query information about the length of audio and video conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- AVConferenceMinutes - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsAVConferenceTimeReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows the time in minutes that was used during all audio and video conferences that were held by Skype for Business Online users for the month of June 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9bed5675-2cdd-4ebb-a555-8d83afa66659.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsActiveUserReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsActiveUserReport.md deleted file mode 100644 index 1f7e924c14..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsActiveUserReport.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsActiveUserReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsActiveUserReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsActiveUserReport cmdlet to view statistics about Skype for Business Online users in your cloud-based organization. The cmdlet shows the total number of unique users that signed in and took part in at least one peer-to-peer session or conference during the specified time period. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsActiveUserReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsActiveUserReport to query information about the activities of Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- ActiveUsers - -- ActiveIMUsers - -- ActiveAudioUsers - -- ActiveVideoUsers - -- ActiveApplicationSharingUsers - -- ActiveFileTransferUsers - -- ActivePSTNConferencingUsers - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsActiveUserReport -ReportType Monthly -StartDate 04/01/2015 -EndDate 04/30/2015 -``` - -This example shows information about Skype for Business Online users for the month of April, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5668eadd-31ce-4aa9-bbda-f6aacde92de7.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsClientDeviceDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsClientDeviceDetailReport.md deleted file mode 100644 index c8d0cb4494..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsClientDeviceDetailReport.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsClientDeviceDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsClientDeviceDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsClientDeviceDetailReport cmdlet to view statistics about the number of peer-to-peer sessions and conferences by users and devices that connected to Skype for Business Online in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsClientDeviceDetailReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [-UserName <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsClientDeviceDetailReport cmdlet returns the number of peer-to-peer sessions and conferences that a user participated in, and a count of what type of device they used. You can query this information for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- UserName - -- WindowsActivities: Note that this includes activity using both Skype for Business and Skype for Business Web App clients. - -- WindowsPhoneActivities - -- AndroidActivities - -- iPhoneActivities - -- iPadActivities - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsClientDeviceDetailReport -StartDate 01/01/2015 -EndDate 01/31/2015 -``` - -This example shows activity by device for all users for the month of January. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5b52cbc6-8fe3-4c1f-8218-2a8848e79459.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsClientDeviceReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsClientDeviceReport.md deleted file mode 100644 index 7a6435f78f..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsClientDeviceReport.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsClientDeviceReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsClientDeviceReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsClientDeviceReport cmdlet to view statistics about the client devices that connected to Skype for Business Online in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsClientDeviceReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsClientDeviceReport cmdlet returns the monthly total of unique users that connected to the Skype for Business Online service using different types of client devices. For the reporting period you specify, the cmdlet returns the following information: - -- WindowsUsers - -- WindowsPhoneUsers - -- AndroidUsers - -- iPhoneUsers - -- iPadUsers - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get- CsClientDeviceReport -StartDate 10/01/2015 -EndDate 10/31/2015 -``` - -This example gets a report of the device usage by platform for the month of October. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8080fa7d-9c9d-45af-b11d-22e92cf02b62.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsConferenceReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsConferenceReport.md deleted file mode 100644 index ec672655e4..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsConferenceReport.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsConferenceReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsConferenceReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsConferenceReport cmdlet to view statistics about the conferences that were held by Skype for Business Online users in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsConferenceReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsConferenceReport to query information about the type and number of conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- TotalConferences - -- AVConferences - -- IMConferences - -- ApplicationSharingConferences - -- WebConferences - -- TelephonyConferences - -- PSTNConferences - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsConferenceReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows information about conferences held by Skype for Business Online users for the month of June 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4b46de5b-9d1c-44eb-86bb-70d5e8339fdf.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsP2PAVTimeReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsP2PAVTimeReport.md deleted file mode 100644 index ac4491aa7a..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsP2PAVTimeReport.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsP2PAVTimeReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsP2PAVTimeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsP2PAVTimeReport cmdlet to view statistics about the audio and video time in minutes that was used during peer-to-peer (P2P) sessions that were held by Skype for Business Online users in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsP2PAVTimeReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsP2PAVTimeReport to query information about the length of audio and video conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- TotalAudioMinutes - -- TotalVideoMinutes - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsP2PAVTimeReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows information about the number of audio and video minutes used during P2P sessions that were held by Skype for Business Online users for the month of June 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/679b91cf-769d-4158-81a6-e97570d98408.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsP2PSessionReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsP2PSessionReport.md deleted file mode 100644 index 6fbf4fd219..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsP2PSessionReport.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsP2PSessionReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsP2PSessionReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsP2PSessionReport cmdlet to view statistics about the peer-to-peer (P2P) sessions held by Skype for Business Online users in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsP2PSessionReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsP2PSessionReport to query information about the number and type of P2P sessions held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- TotalP2PSessions - -- P2PIMSessions - -- P2PAudioSessions - -- P2PVideoSessions - -- P2PApplicationSharingSessions - -- P2PFileTransferSessions - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsP2PSessionReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows information about the P2P sessions used by Skype for Business Online users for the month of June 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b40efbe0-d1f1-427b-97a7-c5c304962914.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsPSTNConferenceTimeReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsPSTNConferenceTimeReport.md deleted file mode 100644 index 101b2360dc..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsPSTNConferenceTimeReport.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsPSTNConferenceTimeReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsPSTNConferenceTimeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsPSTNConferenceTimeReport cmdlet to show the number of minutes that Skype for Business Online users spent in dial-in or dial-out conferences. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsPSTNConferenceTimeReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsPSTNUsageDetailReport to query information about length of time spent in dial-in and dial-out conferences by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- PSTNConferenceDialInMinutes - -- PSTNConferenceDialOutMinutes - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsPSTNConferenceTimeReport -ReportType Monthly 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the number of minutes per month that users spent in PSTN conferences for the months of November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0da2890d-c4cc-4402-b689-122b6dd7fbd3.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsPSTNUsageDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsPSTNUsageDetailReport.md deleted file mode 100644 index 35f570b8de..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsPSTNUsageDetailReport.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsPSTNUsageDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsPSTNUsageDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsPSTNUsageDetailReport cmdlet to view public switched telephone network (PSTN) usage details for Skype for Business Online users. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsPSTNUsageDetailReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsPSTNUsageDetailReport to query information about PSTN usage details in Skype for Business Online for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- SipUri - -- DateTimeOfCall - -- TelephoneNumber - -- CallID - -- CallType - -- Location - -- CallDuration - -- Currency - -- CallCharge - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsPSTNUsageDetailReport -StartDate 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the PSTN usage detail for users in November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f0b3d5e7-fa3f-4a3b-8a42-5750b7544cfc.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsUserActivitiesReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsUserActivitiesReport.md deleted file mode 100644 index 5bdfb2962c..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsUserActivitiesReport.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsUserActivitiesReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsUserActivitiesReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsUserActivitiesReport cmdlet to view number and type of activities that a use participated in while connected to Skype for Business Online in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsUserActivitiesReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [-UserName <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsUserActivitiesReport to query information about activities in Skype for Business Online by all users or a specified user for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- UserName - -- LastLogonTime - -- LastActivityTime - -- TotalP2PSessions - -- TotalP2PIMSessions - -- TotalP2PAudioSessions - -- TotalP2PVideoSessions - -- TotalP2PApplicationSharingSessions - -- TotalP2PAudioSessionMinutes - -- TotalP2PVideoSessionMinutes - -- TotalOrganizedConferences - -- TotalOrganizedIMConferences - -- TotalOrganizedAVConferences - -- TotalOrganizedApplicationSharingConferences - -- TotalOrganizedWebConferences - -- TotalOrganizedDialInConferences - -- TotalOrganizedAVConferenceMinutes - -- TotalParticipatedConferences - -- TotalParticipatedIMConferences - -- TotalParticipatedAVConferences - -- TotalParticipatedApplicationSharingConferences - -- TotalParticipatedWebConferences - -- TotalParticipatedDialInConferences - -- TotalParticipatedAVConferenceMinutes - -- TotalPlacedPSTNCalls - -- TotalReceivedPSTNCalls - -- TotalPlacedPSTNCallMinutes - -- TotalReceivedPSTNCallMinutes - -- TotalMessages - -- TotalTransferredFiles - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsUserActivitiesReport -StartDate 01/01/2015 -EndDate 01/31/2015 -``` - -This example shows the activity for all users for the month of January. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/75814871-1959-475d-b10d-d43775ac65e4.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-CsUsersBlockedReport.md b/exchange/exchange-ps/exchange/reporting/Get-CsUsersBlockedReport.md deleted file mode 100644 index 267461cbc6..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-CsUsersBlockedReport.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-CsUsersBlockedReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-CsUsersBlockedReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-CsUsersBlockedReport cmdlet to view Skype for Business Online users who have been blocked due to fraudulent call activities. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-CsUsersBlockedReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the Get-CsUsersBlockedReport to query information about blocked users in Skype for Business Online for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- ActionDate - -- SIPURI - -- ActionType - -- TelephoneNumber - -- Reason - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsUsersBlockedReport -StartDate 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the list of blocked users for November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/643cc434-6ce4-4b25-b18a-91e8e30e808b.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-GroupActivityReport.md b/exchange/exchange-ps/exchange/reporting/Get-GroupActivityReport.md deleted file mode 100644 index c6a15cccde..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-GroupActivityReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-GroupActivityReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-GroupActivityReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-GroupActivityReport cmdlet to view the number of distribution groups that were created and deleted in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-GroupActivityReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-GroupActivityReport -ReportType Monthly -StartDate 05/01/2015 -EndDate 05/31/2015 -``` - -This example shows the number of distribution groups created and deleted for the month of May, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f152968e-0b43-4fbf-930e-1050a01a35dd.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-HistoricalSearch.md b/exchange/exchange-ps/exchange/reporting/Get-HistoricalSearch.md deleted file mode 100644 index 45b892e0c8..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-HistoricalSearch.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-HistoricalSearch -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-HistoricalSearch - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-HistoricalSearch cmdlet to view information about historical searches that have been performed within the last ten days. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HistoricalSearch [-JobId <Guid>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HistoricalSearch -``` - -The example returns a summary list of all historical searches that have been performed in the last ten days. - -### -------------------------- Example 2 -------------------------- -``` -Get-HistoricalSearch -JobId f9c66f83-b5c8-4a0c-91f4-a38376f74182 | Format-List -``` - -This example returns detailed information about the historical search that's in progress that has the identity value f9c66f83-b5c8-4a0c-91f4-a38376f74182. - -## PARAMETERS - -### -JobId -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/70f2ec73-2733-4f87-ac89-1665d575a4dc.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-LicenseVsUsageSummaryReport.md b/exchange/exchange-ps/exchange/reporting/Get-LicenseVsUsageSummaryReport.md deleted file mode 100644 index 7ea4b47cf0..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-LicenseVsUsageSummaryReport.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-LicenseVsUsageSummaryReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-LicenseVsUsageSummaryReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-LicenseVsUsageSummaryReport cmdlet to retrieve a report that identifies the number of active users for installed software licenses (workloads). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-LicenseVsUsageSummaryReport [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet produces a report that is intended to enable clients to track and manage the use of contracted software licenses. The output contains the following properties. - -- Date: The period being measured. - -- TenantGuid: The unique identifier for the Exchange Online tenant. - -- Workload: The workload whose users are being counted. The current workloads include: Exchange Online, SharePoint Online, Skype for Business Online, and Microsoft Yammer. - -- NonTrialEntitlements: The number of entitled users for the workload. - -- TrialEntitlements: The number of provisionally entitled (trial) users for the workload. - -- ActiveUsers: The count of active users for the workload. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-LicenseVsUsageSummaryReport -``` - -This example gets a report of the active workload users. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/500b5bf7-d1f3-42d6-85de-232f701421f9.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-LogonStatistics.md b/exchange/exchange-ps/exchange/reporting/Get-LogonStatistics.md deleted file mode 100644 index 36b4206851..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-LogonStatistics.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013 -title: Get-LogonStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013" ---- - -# Get-LogonStatistics - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange and is only functional in Exchange Server 2010. - -The Get-LogonStatistics cmdlet has been deprecated and is no longer used. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Database -``` -Get-LogonStatistics -Database <DatabaseIdParameter> - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-LogonStatistics [-Identity] <LogonableObjectIdParameter> - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Server -``` -Get-LogonStatistics -Server <ServerIdParameter> - [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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. - -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. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-LogonStatistics -Server Server01 -``` - -This example returns logon statistics for all users connected to the server Server01. - -## PARAMETERS - -### -Database -The Database parameter specifies the mailbox database to get logon statistics from (all mailboxes in the specified database). You can use any value that uniquely identifies the mailbox database. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -This parameter accepts pipeline input from the Get-MailboxDatabase command. - -You can't use this parameter with the Identity or Server parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox to get logon statistics from. You can use one of the following values to identify the mailbox: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SmtpAddress - -- Alias - -This parameter accepts pipeline input from the Get-Mailbox command. - -You can't use this parameter with the Database or Server parameters. - -```yaml -Type: LogonableObjectIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Mailbox server to get logon statistics from (all mailboxes on all databases, including recovery databases, on the specified server). You can use one of the following values to identify the server: - -- Fully qualified domain name (FQDN) - -- NetBIOS name - -This parameter accepts pipeline input from the Get-ExchangeServer and Get-MailboxServer commands. - -You can't use this parameter with the Database or Identity parameters. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c06f202e-2302-4122-a514-9d11b6ad2c47.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailDetailDlpPolicyReport.md deleted file mode 100644 index bfe3f1a4f5..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailDetailDlpPolicyReport.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-MailDetailDlpPolicyReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MailDetailDlpPolicyReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailDetailDlpPolicyReport cmdlet to view the details of messages that matched the conditions defined by any data loss prevention (DLP) policies. This cmdlet works on messages that were sent within the last seven days. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailDetailDlpPolicyReport [-Action <MultiValuedProperty>] [-Direction <MultiValuedProperty>] - [-DlpPolicy <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-MessageId <MultiValuedProperty>] - [-MessageTraceId <MultiValuedProperty>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] - [-RecipientAddress <MultiValuedProperty>] [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] - [-TransportRule <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailDetailDlpPolicyReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com -``` - -This example retrieves the details of messages sent by john@contoso.com that matched the conditions defined by a DLP policy between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpPolicy -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportRule -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3eb34454-65f8-4741-9c9b-bba087bc9cb2.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailDetailMalwareReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailDetailMalwareReport.md deleted file mode 100644 index d1323d7ecd..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailDetailMalwareReport.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailMalwareReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailDetailMalwareReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailDetailMalwareReport cmdlet to view the details of messages that contained malware. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailDetailMalwareReport [-Action <MultiValuedProperty>] [-Direction <MultiValuedProperty>] - [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] - [-Expression <Expression>] [-MalwareName <MultiValuedProperty>] [-MessageId <MultiValuedProperty>] - [-MessageTraceId <MultiValuedProperty>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] - [-RecipientAddress <MultiValuedProperty>] [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailDetailMalwareReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com -``` - -This example retrieves the details of messages sent by john@contoso.com that contained malware between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MalwareName -The MalwareName parameter filters the report by the name of the malware. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5840a6ab-1b24-4f8e-b22c-8ffe44378ed7.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailDetailSpamReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailDetailSpamReport.md deleted file mode 100644 index 7f8a8f70c2..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailDetailSpamReport.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailSpamReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailDetailSpamReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailDetailSpamReport cmdlet to view the details of spam messages. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailDetailSpamReport [-Action <MultiValuedProperty>] [-Direction <MultiValuedProperty>] - [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] - [-Expression <Expression>] [-MessageId <MultiValuedProperty>] [-MessageTraceId <MultiValuedProperty>] - [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-RecipientAddress <MultiValuedProperty>] - [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailDetailSpamReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com -``` - -This example retrieves the details of spam messages sent by john@contoso.com between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4ef5c903-03a4-4461-a8c8-930e424bbcf5.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailDetailTransportRuleReport.md deleted file mode 100644 index 463f9447ec..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailDetailTransportRuleReport.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailTransportRuleReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailDetailTransportRuleReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailDetailTransportRuleReport cmdlet to view the details of messages that matched the conditions defined by any transport rules. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailDetailTransportRuleReport [-Action <MultiValuedProperty>] [-Direction <MultiValuedProperty>] - [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] - [-Expression <Expression>] [-MessageId <MultiValuedProperty>] [-MessageTraceId <MultiValuedProperty>] - [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-RecipientAddress <MultiValuedProperty>] - [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] [-TransportRule <MultiValuedProperty>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailDetailTransportRuleReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com -``` - -This example retrieves the details of messages sent by john@contoso.com that matched the conditions defined by a transport rule between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportRule -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/26484f90-7063-4c95-a1c2-3792926b3e79.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailFilterListReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailFilterListReport.md deleted file mode 100644 index 032c57de54..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailFilterListReport.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-MailFilterListReport -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps || eop-ps" ---- - -# Get-MailFilterListReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailFilterListReport cmdlet to obtain values for various parameters that can be supplied to other reporting cmdlets. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailFilterListReport [-Domain <MultiValuedProperty>] [-Expression <Expression>] [-ProbeTag <String>] - [-SelectionTarget <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailFilterListReport -SelectionTarget TransportRule -``` - -This example uses the Get-MailFilterListReport cmdlet to return information about transport rules. - -## PARAMETERS - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelectionTarget -The SelectionTarget parameter filters the report information by object type. Valid values for this parameter are: Actions, DlpPolicy, DlpRule, Domain, EventTypes, FindOnPremConnector or TransportRule. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e295ac9a-3ecf-405a-b81c-c77e3067126a.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailTrafficPolicyReport.md deleted file mode 100644 index 7d73c6a04f..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficPolicyReport.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficPolicyReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailTrafficPolicyReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailTrafficPolicyReport cmdlet to view statistics about messages that were affected by data loss prevention (DLP) policies and transport rules. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailTrafficPolicyReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-Direction <MultiValuedProperty>] [-DlpPolicy <MultiValuedProperty>] [-Domain <MultiValuedProperty>] - [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] - [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] - [-TransportRule <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailTrafficPolicyReport -Direction Outbound -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves the statics for outgoing messages between June 13, 2015 and June 15, 2015 that were affected by DLP policies and transport rules. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailTrafficPolicyReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example retrieves the statics for outgoing messages on December 12, 2015 and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailTrafficPolicyReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy Domain,DlpPolicy,TransportRule,EventType | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example is similar to the previous example, but now the results are summarized. Because the EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced, and values of MessageCount are correspondingly larger on each row. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpPolicy -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -For the Get-MailTrafficPolicyReport cmdlet, the SummarizeBy parameter accepts the values Action, DLPPolicy, Domain, EventType, and TransportRule. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportRule -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1f26abdf-ac82-4792-965c-9b839d7e2231.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailTrafficReport.md deleted file mode 100644 index 9920e99361..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficReport.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailTrafficReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailTrafficReport cmdlet to view details about message traffic in your organization for the last 180 days. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailTrafficReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-Direction <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] - [-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -You can use the EventTypes values from the Get-MailTrafficReport cmdlet to analyze what happened to messages when they were filtered by the service. The following list describes all possible event types for messages. - -Mail traffic summary - -- GoodMail: Messages that were delivered after passing through the malware and spam filters. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. - -- Malware: Messages that were marked as malware. - -- TransportRuleHits: Messages that matched a rule. If a message matched multiple rules, this event type would show each of the rule matches. - -Spam detections - -- SpamIPBlock: Messages that were blocked based on the sender IP. - -- SpamDBEBFilter: Messages that were blocked based on checking the recipient against the directory. This happens when a message is addressed to an unknown recipient. - -- SpamEnvelopeBlock: Messages that were blocked based on SMTP. - -- SpamContentFiltered: Messages that passed the initial IP and SMTP filters and were filtered based on content, rules or other spam configurations. - -Spam analysis - content-filtered spam - -- Spam\_AdditionalSpamFiltered: Messages filtered based on advanced spam filters that have been enabled. For details about the advanced spam filter, see Advanced spam filtering \(ASF\) options (https://technet.microsoft.com/library/jj200750.aspx) Options. - -- Spam\_BlockList: Messages that were filtered because the sender was on a spam filter block list. For more details on how to configure these lists, see Configure your spam filter policies (https://technet.microsoft.com/library/jj200684.aspx). - -- Spam\_BulkFiltered: Messages that were filtered as bulk mail. See message volume breakdown by Bulk Complaint Level (BCL) for further analysis of bulk mail. For more information about bulk mail processing, see What's the difference between junk email and bulk email? (https://technet.microsoft.com/library/dn720441.aspx) - -- Spam\_ContentScanFiltered: Messages that were filtered based on the message content. - -- Spam\_ETRFiltered: Messages that were filtered due to a transport rule. - -- Spam\_SenderBlocked: Messages that were filtered because the sender was on a block list. - -Spam analysis - non-spam messages - -- NonSpam\_AdditionalSpamFilterPassed: Messages that were passed based on advanced spam filters that have been enabled. For details about the advanced spam filters, see Advanced spam filtering \(ASF\) options (https://technet.microsoft.com/library/jj200750.aspx) Options. - -- NonSpam\_AllowList: Messages that were passed because the sender was on a spam filter allow list. For more details on how to configure these lists, see Configure your spam filter policies (https://technet.microsoft.com/library/jj200684.aspx). - -- NonSpam\_BulkPassed: Messages that were determined not to be bulk mail. - -- NonSpam\_ContentScanPassed: Messages that were passed by the content scan. - -- NonSpam\_ETRPassed: Messages that passed based on a transport rule. - -- NonSpam\_IntraOrg: Messages that were deemed as low risk of spam based on factors such as intra-organizational mail. - -- NonSpam\_IPAllowed: Messages that were passed because the sending IP was on the IP allow list. - -- NonSpam\_SafeSender: Messages that were passed because the sender was marked as safe. - -Bulk mail - -- BCL0: Messages that are not bulk mail are marked with Bulk Complaint Level (BCL) value of 0. For details on how to use BCL to mark messages as spam, see Use transport rules to configure bulk email filtering (https://technet.microsoft.com/library/dn720438.aspx). - -- BCL1 through BCL9: Messages with BCL rating of 1 through 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailTrafficReport -Direction Inbound -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves details for incoming messages between June 13, 2015 and June 15, 2015. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailTrafficReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example retrieves the statistics for outgoing messages on December 12, 2015, and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailTrafficReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy Domain,EventType | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example is similar to the previous example, but now the results are summarized. Because the EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced, and values of MessageCount are correspondingly larger on each row. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -If you don't use the Domain parameter, the message count for your entire organization is returned. This includes messages that were sent from or to unregistered domains that are attributed to your organization. Unregistered domains can be attributed to your organization in hybrid or EOP standalone configurations. - -Notes: - -- Messages that are sent to recipients in multiple domains are counted differently at the domain level versus the organizational level. At the domain level, the message is counted for each different domain. At the organizational level, the message is counted only once. Therefore, if you add up the total number of received messages for each domain, the value might not match the total number of received messages for the organization. - -- The Domain value is Others for messages that were sent from or to unregistered domains that are attributed to your organization (messages in domains that aren't configured as accepted domains in your organization). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -For the Get-MailTrafficReport cmdlet, the SummarizeBy parameter accepts the values Action, Domain, and EventType. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/28988896-893c-46c9-a174-8ab6f834d0c9.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficSummaryReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailTrafficSummaryReport.md deleted file mode 100644 index 641e8336bf..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficSummaryReport.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficSummaryReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailTrafficSummaryReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailTrafficSummaryReport cmdlet to view summary information about message traffic in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailTrafficSummaryReport [-Category <String>] [-DlpPolicy <MultiValuedProperty>] - [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-Expression <Expression>] [-Page <Int32>] - [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [-TransportRule <MultiValuedProperty>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailTrafficSummaryReport -Category TopSpamRecipient -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example shows the top spam recipient statistics between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Category -The Category parameter filters the report by category. Value values for this parameter are: InboundDLPHits, OutboundDLPHits, InboundTransportRuleHits, OutboundTransportRuleHits, InboundDLPPolicyRuleHits, OutboundDLPPolicyRuleHits, TopSpamRecipient, TopMailSender, TopMailRecipient, TopMalwareRecipient or TopMalware. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DlpPolicy -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransportRule -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/58c279cd-d548-46b2-90b9-d7be69241421.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficTopReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailTrafficTopReport.md deleted file mode 100644 index ddeb958344..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailTrafficTopReport.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficTopReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MailTrafficTopReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailTrafficTopReport cmdlet to view a report of the highest volume senders, recipients, malware recipients and spam recipients in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailTrafficTopReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] - [-Direction <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] - [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] - [-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailTrafficTopReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example shows the highest volume senders, recipients, malware recipients and spam recipients between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -For the Get-MailTopTrafficeReport cmdlet, the SummarizeBy parameter accepts the values Domain and EventType. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5357cc82-3224-4df5-ac0b-24b1afc90713.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailboxActivityReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailboxActivityReport.md deleted file mode 100644 index 81164b978f..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailboxActivityReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-MailboxActivityReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MailboxActivityReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-MailboxActivityReport cmdlet to view the number of mailboxes created and deleted in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxActivityReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxActivityReport -ReportType Monthly -StartDate 05/01/2015 -EndDate 05/31/2015 -``` - -This example shows the number of mailboxes created and deleted for the month of May, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7704f42d-51bf-4e39-bebf-b1ee0f698f8f.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailboxUsageDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailboxUsageDetailReport.md deleted file mode 100644 index 9bd5509806..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailboxUsageDetailReport.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-MailboxUsageDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MailboxUsageDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-MailboxUsageDetailReport cmdlet to view usage details about mailboxes in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxUsageDetailReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxUsageDetailReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves details for mailboxes that were near or over the maximum mailbox size between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3900e919-0404-452f-9cef-2a80bc7af77c.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MailboxUsageReport.md b/exchange/exchange-ps/exchange/reporting/Get-MailboxUsageReport.md deleted file mode 100644 index 5ee76502ee..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MailboxUsageReport.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-MailboxUsageReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-MailboxUsageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-MailboxUsageReport cmdlet to view the number of mailboxes in your organization that are within 25% of the maximum mailbox size, and the number of mailboxes that are over the maximum size for your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MailboxUsageReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxUsageReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves the number of mailboxes that were near or over the maximum mailbox size between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b77a73f5-7cf2-4adb-bcdf-02f86f1a1666.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-MxRecordReport.md b/exchange/exchange-ps/exchange/reporting/Get-MxRecordReport.md deleted file mode 100644 index 1094608801..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-MxRecordReport.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-MxRecordReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-MxRecordReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MxRecordReport cmdlet to view information about the mail exchanger (MX) records that are configured for a specified domain. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MxRecordReport [-Domain <Fqdn>] [-Expression <Expression>] [-ProbeTag <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MxRecordReport -Domain contoso.com -``` - -This example shows the MX record information for the contoso.com domain. - -## PARAMETERS - -### -Domain -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/41cc58a9-25c2-4e04-b404-4e3afa71f79c.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-O365ClientBrowserDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-O365ClientBrowserDetailReport.md deleted file mode 100644 index 1906f828da..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-O365ClientBrowserDetailReport.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-O365ClientBrowserDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-O365ClientBrowserDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-O365ClientBrowserDetailReport cmdlet to get a detailed report of client browser use. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-O365ClientBrowserDetailReport [-Browser <String>] [-BrowserVersion <String>] [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [-WindowsLiveID <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This report provides browser details for all active users. The data contains a maximum of four browsers per user, and are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list. - -- TenantGuid: Unique identifier of the tenant. - -- TenantName: Tenant name. - -- Date: The timestamp for the connection for the browser and version combination. - -- WindowsLiveID: User ID in the format user@domain. - -- DisplayName: User name. - -- LastAccessTime: Last date the user connected with this browser and version combination. - -- ObjectId: User object ID. - -- Browser: Browser name. - -- BrowserVersion: Browser version. - -- BrowserUsageCount: Number of days this browser and version combination was used during the period of the report - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-O365ClientBrowserDetailReport -WindowsLiveID john@contoso.com -StartDate 05/01/2016 -EndDate 05/03/2016 -``` - -This example retrieves the browser details for the user john@contoso.com between May 1, 2016 and May 3, 2016. - -### -------------------------- Example 2 -------------------------- -``` -Get-O365ClientBrowserDetailReport -Browser Chrome -``` - -This example retrieves the details for the Chrome browser for the current 5 day retention period (no start and end date are specified). - -## PARAMETERS - -### -Browser -The Browser parameter filters the report by browser. If you don't use this parameter, all browsers will be included. The accepted values for this parameter are: - -- IE - -- Firefox - -- Chrome - -- Safari - -- Opera - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BrowserVersion -The BrowserVersion parameter filters the report by browser version. If you don't use this parameter, all browser versions will be included in the results. This parameter accepts version numbers up to the first minor version. For example, use 11 or 11.0, not 11.0.9600.17105. Wildcards are not accepted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveID -The WindowsLiveID parameter filters the report by user ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/71c11ba9-e0bf-4540-ae00-146a44286f2e.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-O365ClientBrowserReport.md b/exchange/exchange-ps/exchange/reporting/Get-O365ClientBrowserReport.md deleted file mode 100644 index ecb58711f0..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-O365ClientBrowserReport.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-O365ClientBrowserReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-O365ClientBrowserReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-O365ClientBrowserReport cmdlet to get a summary report of client browser use. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-O365ClientBrowserReport [-Browser <String>] [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The report displays the client use statistics for the five most recent versions of the browsers named in the Browser parameter description. All previous browser versions are combined into a sixth category named Others. The following list describes the properties that are returned in the results. - -- TenantGuid: Unique identifier of the tenant. - -- TenantName: Tenant name. - -- Date: Last time the line item data was aggregated. - -- Browser: Browser name. - -- Version: Browser version. - -- TotalBrowserCount: Number of times a given browser and version combination connected to the service during the reporting period. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-O365ClientBrowserReport -Browser IE -``` - -This example gets the summary report of client Internet Explorer use for the 366 day data retention period (no start and end date are specified). - -### -------------------------- Example 2 -------------------------- -``` -Get-O365ClientBrowserReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves the client browser information for all browsers between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Browser -The Browser parameter filters the report by browser. If you don't use this parameter, all browsers will be included. The accepted values for this parameter are: - -- IE - -- Firefox - -- Chrome - -- Safari - -- Opera - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0b7e1883-b9d1-41d4-b521-9481270299fc.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-O365ClientOSDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-O365ClientOSDetailReport.md deleted file mode 100644 index e35ef0e758..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-O365ClientOSDetailReport.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-O365ClientOSDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-O365ClientOSDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-O365ClientOSDetailReport cmdlet to get a detailed report of client operating system use. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-O365ClientOSDetailReport [-EndDate <DateTime>] [-OperatingSystem <String>] [-OperatingSystemVersion <String>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [-WindowsLiveID <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This report provides operating system details for all active users. The data contains a maximum of four operating systems per user, are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list. - -- TenantGuid: Unique identifier of the tenant. - -- TenantName: Tenant name. - -- Date: The timestamp for the connection for the operating system and version combination. - -- WindowsLiveID: User ID in the format user@domain. - -- DisplayName: User name. - -- LastAccessTime: Last date the user connected with this operating system and version combination. - -- ObjectId: User object ID. - -- OperatingSystem: Operating system name. - -- Version: Operating system version. - -- OperatingSystemUsageCount: Number of days this operating system and version combination was used during the period of the report - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-O365ClientOSDetailReport -WindowsLiveID john@contoso.com -StartDate 05/01/2016 -EndDate 05/03/2016 -``` - -This example retrieves the operating system details for user John between May 1, 2016 and May 3, 2016. - -### -------------------------- Example 2 -------------------------- -``` -Get-O365ClientOSDetailReport -OperatingSystem Android -``` - -This example retrieves the operating system details for the Android operating system for the current 5 day retention period (no start and end date are specified). - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystem -The OS parameter filters the report by operating system. If you don't use this parameter, all operating systems will be included. The accepted values for this parameter are: - -- Windows - -- Android - -- iOS - -- "Mac OS" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystemVersion -The OperatingSystermVersion parameter filters the report by operating system version. If you don't use this parameter, all operating system versions will be included. The parameter accepts version numbers up to the first minor version. For example, use 6 or 6.1, not 6.1.9600. Wildcards are not accepted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveID -The WindowsLiveID filters the report by user ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eaa592ac-cfd0-41e2-aeb2-6f17eccf5642.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-O365ClientOSReport.md b/exchange/exchange-ps/exchange/reporting/Get-O365ClientOSReport.md deleted file mode 100644 index 353ad01bc1..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-O365ClientOSReport.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-O365ClientOSReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-O365ClientOSReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-O365ClientOSReport cmdlet to get a summary report of client operating system use. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-O365ClientOSReport [-EndDate <DateTime>] [-OS <String>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The report displays the client use statistics for the five most recent versions of the operating systems named in the OS parameter description. All previous operating system versions are combined into a sixth category named Others. The following list describes the properties that are returned in the results. - -- TenantGuid: Unique identifier of the tenant. - -- TenantName: Tenant name. - -- Date: Last time the line item data was aggregated. - -- OperatingSystem: Operating system name. - -- Version: Operating system version. - -- OperatingSystemUsageCount: Number of times a given operating system and version combination connected to the service during the reporting period. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-O365ClientOSReport -OS Windows -``` - -This example gets the summary report of client Windows use for the 366 day data retention period (no start and end date are specified). - -### -------------------------- Example 2 -------------------------- -``` -Get-O365ClientOSReport -StartDate 06/13/2013 -EndDate 06/15/2013 -``` - -This example retrieves the client operating system information between June 13, 2013 and June 15, 2013. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OS -The OS parameter filters the report by operating system. If you don't use this parameter, all operating systems will be included. The accepted values for this parameter are: - -- Windows - -- Android - -- iOS - -- "Mac OS" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a0266b64-2455-4037-bbc5-34730691247b.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-OutboundConnectorReport.md b/exchange/exchange-ps/exchange/reporting/Get-OutboundConnectorReport.md deleted file mode 100644 index 5e10dd2f31..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-OutboundConnectorReport.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-OutboundConnectorReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-OutboundConnectorReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-OutboundConnectorReport cmdlet to view the Outbound connectors that are used to deliver mail to specific domains. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OutboundConnectorReport [-Domain <Fqdn>] [-Expression <Expression>] [-ProbeTag <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OutboundConnectorReport -Domain contoso.com -``` - -This example shows the Outbound connector that's used to deliver mail to the contoso.com domain. - -## PARAMETERS - -### -Domain -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/097223da-2189-4125-acab-f03cb1de4be2.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-RecipientStatisticsReport.md b/exchange/exchange-ps/exchange/reporting/Get-RecipientStatisticsReport.md deleted file mode 100644 index 25389da23c..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-RecipientStatisticsReport.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-RecipientStatisticsReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-RecipientStatisticsReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-RecipientStatisticsReport cmdlet to view the recipient statistics report. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RecipientStatisticsReport [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RecipientStatisticsReport -``` - -This example displays the recipient statistics report for the organization. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1c6f788c-349d-41aa-a0b0-b931e8588791.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-ReportExecutionInstance.md b/exchange/exchange-ps/exchange/reporting/Get-ReportExecutionInstance.md deleted file mode 100644 index 5b6d394dfb..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-ReportExecutionInstance.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-ReportExecutionInstance -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-ReportExecutionInstance - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-ReportExecutionInstance cmdlet to review the report execution instance in Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ReportExecutionInstance [-Identity <InstanceIdParameter>] [-ScheduleId <MultiValuedProperty>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ReportExecutionInstance | Format-Table -Auto Identity,ScheduleId,ReportStartDate,ReportEndDate -``` - -This example returns a summary list of all report execution instances. - -### -------------------------- Example 2 -------------------------- -``` -Get-ReportExecutionInstance -Identity 277df7c3-5b73-4409-6264-08d4a8052836 -``` - -This example returns detailed information for the specified report execution instance. - -## PARAMETERS - -### -Identity -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -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. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/55a0227e-633a-4e4b-b68e-e05f60f84c83.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SCInsights.md b/exchange/exchange-ps/exchange/reporting/Get-SCInsights.md deleted file mode 100644 index 5783870d80..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SCInsights.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-SCInsights -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-SCInsights - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-SCInsights cmdlet to view Office 365 insights information. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SCInsights [-EndDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the following output: - -- Organization: The Office 365 domain. - -- Date: The date of the even in Coordinated Universal Time (UTC). - -- InsightType - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SCInsights -``` - -This example returns all insights data. - -### -------------------------- Example 2 -------------------------- -``` -Get-SCInsights -EndDate (Get-Date "3/3/2018 9:30 AM").ToUniversalTime() -``` - -This example return insights data for March 15, 2018. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -To specify a date/time value for this parameter, use either of the following options: - -- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z". - -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e237daae-d2a7-4668-98a7-6c599f4a6545.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SPOActiveUserReport.md b/exchange/exchange-ps/exchange/reporting/Get-SPOActiveUserReport.md deleted file mode 100644 index c8f6d0bb1e..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SPOActiveUserReport.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-SPOActiveUserReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SPOActiveUserReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-SpoActiveUserReport cmdlet to view statistics about Microsoft SharePoint Online users in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SPOActiveUserReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] - [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SpoActiveUserReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about SharePoint Online users for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8e97b2f5-6dce-4bcc-845c-b31566f22870.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SPOSkyDriveProDeployedReport.md b/exchange/exchange-ps/exchange/reporting/Get-SPOSkyDriveProDeployedReport.md deleted file mode 100644 index b999856caa..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SPOSkyDriveProDeployedReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-SPOSkyDriveProDeployedReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SPOSkyDriveProDeployedReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-SPOSkyDriveProDeployedReport cmdlet to view the number of My Site sites in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SPOSkyDriveProDeployedReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get- SPOSkyDriveProDeployedReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example displays the number of My Sites as of November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bf1569b0-51a1-4468-ba99-6cfaf18eab5d.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SPOSkyDriveProStorageReport.md b/exchange/exchange-ps/exchange/reporting/Get-SPOSkyDriveProStorageReport.md deleted file mode 100644 index 1c17cb1230..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SPOSkyDriveProStorageReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-SPOSkyDriveProStorageReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SPOSkyDriveProStorageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-SPOSkyDriveProStorageReport cmdlet to view statistics about the space taken up (in MB) by My Sites in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SPOSkyDriveProStorageReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SPOSkyDriveProStorageReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the space (in MB) taken up by My Sites for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5eb2b347-871c-40fc-bb42-5c4fd69af7cf.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SPOTeamSiteDeployedReport.md b/exchange/exchange-ps/exchange/reporting/Get-SPOTeamSiteDeployedReport.md deleted file mode 100644 index f4ac99bbfb..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SPOTeamSiteDeployedReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-SPOTeamSiteDeployedReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SPOTeamSiteDeployedReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-SPOTeamSiteDeployedReport cmdlet to view statistics about the number of team sites in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SPOTeamSiteDeployedReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SPOTeamSiteDeployedReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the number of team sites in the month of November, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7717d439-ca5a-490e-84e4-765dad859ae3.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SPOTeamSiteStorageReport.md b/exchange/exchange-ps/exchange/reporting/Get-SPOTeamSiteStorageReport.md deleted file mode 100644 index 686dd1e93d..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SPOTeamSiteStorageReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-SPOTeamSiteStorageReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SPOTeamSiteStorageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-SPOTeamSiteStorageReport cmdlet to view statistics about the space taken up (in MB) by team sites in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SPOTeamSiteStorageReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SPOTeamSiteStorageReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the space taken up (in MB) by team sites for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2b46faee-568b-4a61-810e-b2876b9d736e.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SPOTenantStorageMetricReport.md b/exchange/exchange-ps/exchange/reporting/Get-SPOTenantStorageMetricReport.md deleted file mode 100644 index 7a98949e55..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SPOTenantStorageMetricReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-SPOTenantStorageMetricReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-SPOTenantStorageMetricReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-SPOTenantStorageMetricReport cmdlet to view statistics about the space taken up (in MB) by all sites in for your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SPOTenantStorageMetricReport [-EndDate <DateTime>] [-ReportType <Daily | Weekly | Monthly | Yearly>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SpoActiveUserReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the space taken up (in MB) by all sites for your cloud-based organization for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: Daily | Weekly | Monthly | Yearly -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/add2ac19-8c31-405b-9196-3eab6d5ff544.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-ServiceDeliveryReport.md b/exchange/exchange-ps/exchange/reporting/Get-ServiceDeliveryReport.md deleted file mode 100644 index 3a479d3270..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-ServiceDeliveryReport.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Get-ServiceDeliveryReport -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Get-ServiceDeliveryReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-ServiceDeliveryReport cmdlet to view information about the message delivery path for a specified recipient. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ServiceDeliveryReport [-Expression <Expression>] [-ProbeTag <String>] [-Recipient <SmtpAddress>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ServiceDeliveryReport -Recipient chris@contoso.com -``` - -This example shows the delivery path information for the recipient chris@contoso.com. - -## PARAMETERS - -### -Expression -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Expression -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recipient -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/27b11891-b4de-465f-88de-6357bcdbf86a.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-StaleMailboxDetailReport.md b/exchange/exchange-ps/exchange/reporting/Get-StaleMailboxDetailReport.md deleted file mode 100644 index e3635f1eb2..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-StaleMailboxDetailReport.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-StaleMailboxDetailReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-StaleMailboxDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-StaleMailboxDetailReport cmdlet to view mailboxes that haven't been accessed for at least 30 days. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-StaleMailboxDetailReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-StaleMailboxDetailReport -``` - -This example retrieves all the mailboxes that haven't been accessed for at least 30 days. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. - -This cmdlet returns a maximum of 50000 results, even when you use the value unlimited. If your organization has more than 50000 mailboxes, you can use the Select-Object and Sort-Object cmdlets in multiple commands to return all of the results. For example, if your organization has 90000 mailboxes, run the following commands: - -Get-StaleMailboxDetailReport -ResultSize unlimited | Sort-Object UserName -Unique | Select-Object TenantName,UserName,WindowsLiveID,LastLogin,DaysInactive -First 45000 | Export-Csv "C:\\Data\\First45k Stale.csv" - -Get-StaleMailboxDetailReport -ResultSize unlimited | Sort-Object UserName -Unique | Select-Object TenantName,UserName,WindowsLiveID,LastLogin,DaysInactive -Last 45000 | Export-Csv "C:\\Data\\Last45k Stale.csv" - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/661c1652-b9ff-44fb-a465-9e3e9ee307f9.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-StaleMailboxReport.md b/exchange/exchange-ps/exchange/reporting/Get-StaleMailboxReport.md deleted file mode 100644 index 4bcf9dcec8..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-StaleMailboxReport.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online -title: Get-StaleMailboxReport -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-StaleMailboxReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Office 365, see the subtopics of Working with Office 365 usage reports in Microsoft Graph (https://go.microsoft.com/fwlink/p/?LinkID=865135). - -Use the Get-StaleMailboxReport cmdlet to view the number of mailboxes that haven't been accessed for at least 30 days. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-StaleMailboxReport [-EndDate <DateTime>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-StaleMailboxReport -``` - -This example retrieves the number of mailboxes that haven't been accessed for at least 30 days. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cb42b081-092c-4239-ad93-eb8beee4c68a.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SupervisoryReviewPolicyReport.md b/exchange/exchange-ps/exchange/reporting/Get-SupervisoryReviewPolicyReport.md deleted file mode 100644 index 84ef35d852..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SupervisoryReviewPolicyReport.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Online, Office 365 Security & Compliance Center -title: Get-SupervisoryReviewPolicyReport -schema: 2.0.0 -monikerRange: "exchonline-ps || o365scc-ps" ---- - -# Get-SupervisoryReviewPolicyReport - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-SupervisoryReviewPolicyReport cmdlet to view supervisory review policy events in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SupervisoryReviewPolicyReport [-EndDate <DateTime>] [-Page <Int32>] [-PageSize <Int32>] - [-Policies <MultiValuedProperty>] [-StartDate <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -For the reporting period you specify, the Get-SupervisoryReviewPolicyReport cmdlet returns the following information: - -- Organization - -- Date - -- Policy - -- Message Type - -- Tag Type: Messages that are eligible for evaluation by the policy are `InPurview`. Messages that match the conditions of the policy are `HitPolicy`. Classifications that are manually assigned to messages by the designated reviewers using the Supervision add-in for Outlook web app are `Compliant`, `Non-compliant`, `Questionable`, and `Resolved`. Messages that match the conditions of a policy but haven't been reviewed by a designated reviewer are `Not-Reviewed`. Messages that match the conditions of a policy and have been reviewed by a designated reviewer are `New-Reviewed`. - -- Item Count - -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SupervisoryReviewPolicyReport -StartDate 03/01/2018 -EndDate 03/31/2018 -``` - -This example returns the supervisory review policy events for the month of March, 2018. - -### -------------------------- Example 2 -------------------------- -``` -Get-SupervisoryReviewPolicyReport -Policies "EU Brokers Policy" -``` - -This example returns the supervisory review policy events for the policy named EU Brokers Policy. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policies -The Policies parameter filters the results by the supervisory review policy. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cdd3cf55-6319-47ef-bcf8-12b6d4dc29e7.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-SupervisoryReviewReport.md b/exchange/exchange-ps/exchange/reporting/Get-SupervisoryReviewReport.md deleted file mode 100644 index 082e486270..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-SupervisoryReviewReport.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Office 365 Security & Compliance Center -title: Get-SupervisoryReviewReport -schema: 2.0.0 -monikerRange: "o365scc-ps" ---- - -# Get-SupervisoryReviewReport - -## SYNOPSIS -This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). - -Use the Get-SupervisoryReviewReport cmdlet to view supervisory review events in the Security & Compliance Center. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SupervisoryReviewReport [-EndDate <DateTime>] [-Page <Int32>] [-PageSize <Int32>] - [-Policies <MultiValuedProperty>] [-Reviewers <MultiValuedProperty>] [-StartDate <DateTime>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SupervisoryReviewReport -StartDate 03/01/2018 -EndDate 03/31/2018 -``` - -This example returns the supervisory review events for the month of March, 2018. - -### -------------------------- Example 2 -------------------------- -``` -Get-SupervisoryReviewPolicyReport -Policies "US Brokers Policy" -``` - -This example returns the supervisory review events for the policy named US Brokers Policy. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policies -The Policies parameter filters the results by the supervisory review policy. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reviewers -The Reviewers parameter filters the results by the reviewers of the supervisory review policy. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Office 365 Security & Compliance Center -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a871ed0a-30fe-4b53-9084-1d45d0d70b75.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-TenantAnalyticsConfig.md b/exchange/exchange-ps/exchange/reporting/Get-TenantAnalyticsConfig.md deleted file mode 100644 index 472e030e5a..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-TenantAnalyticsConfig.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-TenantAnalyticsConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-TenantAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-TenantAnalyticsConfig cmdlet to view the minimum number of recipients that are required for MyAnalytics to show email statistics. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-TenantAnalyticsConfig [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TenantAnalyticsConfig -``` - -This example returns the minimum number of recipients that are required for MyAnalytics to show email statistics. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9df5ec50-6b91-4801-9221-0a5985b8af3a.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Get-UserAnalyticsConfig.md b/exchange/exchange-ps/exchange/reporting/Get-UserAnalyticsConfig.md deleted file mode 100644 index ee8fcd0906..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Get-UserAnalyticsConfig.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-UserAnalyticsConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-UserAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-TenantAnalyticsConfig cmdlet to view the MyAnalytics privacy settings for cloud-based users. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UserAnalyticsConfig -Identity <RecipientIdParameter> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UserAnalyticsConfig -Identity KathleenReiter@Contoso.com -``` - -This example returns the MyAnalytics privacy setting for the user with email address KathleenReiter@Contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the email address of the user that you want to view. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c10fd535-627a-4e9e-be13-5dda9820979e.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Set-TenantAnalyticsConfig.md b/exchange/exchange-ps/exchange/reporting/Set-TenantAnalyticsConfig.md deleted file mode 100644 index 5123dc2063..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Set-TenantAnalyticsConfig.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-TenantAnalyticsConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-TenantAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-TenantAnalyticsConfig cmdlet to modify the minimum number of recipients that are required for MyAnalytics to show email statistics. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MyAnalytics -``` -Set-TenantAnalyticsConfig -MinRecipients <Int32> - [<CommonParameters>] -``` - -### TeamAnalytics -``` -Set-TenantAnalyticsConfig -MinTeamSize <Int32> -TeamAnalyticsEnabled <$true | $false> - [-MinRecipients <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TenantAnalyticsConfig -MinRecipients 10 -``` - -This example configures the minimum number of recipients required by MyAnalytics to 10 recipients. - -## PARAMETERS - -### -MinRecipients -The MinRecipients parameter specifies the minimum number of recipients required for MyAnalytics to show email statistics. The default value is 5. - -```yaml -Type: Int32 -Parameter Sets: MyAnalytics -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: Int32 -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MinTeamSize -PARAMVALUE: Int32 - -```yaml -Type: Int32 -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamAnalyticsEnabled -PARAMVALUE: $true | $false - -```yaml -Type: $true | $false -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3f34a5c1-350f-4f1f-92dd-d16587a0097b.aspx) diff --git a/exchange/exchange-ps/exchange/reporting/Set-UserAnalyticsConfig.md b/exchange/exchange-ps/exchange/reporting/Set-UserAnalyticsConfig.md deleted file mode 100644 index 6488d47452..0000000000 --- a/exchange/exchange-ps/exchange/reporting/Set-UserAnalyticsConfig.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-UserAnalyticsConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-UserAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-UserAnalyticsConfig cmdlet to modify the MyAnalytics privacy settings for cloud-based users. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### MyAnalytics -``` -Set-UserAnalyticsConfig -Identity <RecipientIdParameter> -PrivacyMode <String> - [<CommonParameters>] -``` - -### TeamAnalytics -``` -Set-UserAnalyticsConfig -Identity <RecipientIdParameter> -TeamAnalyticsEnabled <$true | $false> - [-PrivacyMode <String>] - [-TeamAnalyticsManagerViewEnabled <$true | $false>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UserAnalyticsConfig -Identity "Kathleen Reiter" -PrivacyMode OptIn -``` - -This example sets the MyAnalytics privacy setting to OptIn for the user named Kathleen Reiter. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example: - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -PrivacyMode -The PrivacyMode parameter specifies the MyAnalytics privacy setting for the user. Valid values are: - -- Exclude - -- OptIn - -- OptOut - -```yaml -Type: String -Parameter Sets: MyAnalytics -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TeamAnalyticsEnabled -PARAMVALUE: $true | $false - -```yaml -Type: $true | $false -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamAnalyticsManagerViewEnabled -PARAMVALUE: $true | $false - -```yaml -Type: $true | $false -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f8f0b66c-dcd2-43ef-88f0-0cc760ce7602.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Add-RoleGroupMember.md b/exchange/exchange-ps/exchange/role-based-access-control/Add-RoleGroupMember.md deleted file mode 100644 index e10d58eb2d..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Add-RoleGroupMember.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Add-RoleGroupMember -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Add-RoleGroupMember cmdlet to add members to a management role group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-RoleGroupMember [-Identity] <RoleGroupIdParameter> -Member <SecurityPrincipalIdParameter> - [-BypassSecurityGroupManagerCheck] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you add a member to a role group, that mailbox, universal security group (USG), or computer is given the effective permissions provided by the management roles assigned to the role group. - -If the ManagedBy property has been populated with role group managers, the user adding a role group member 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 Add-RoleGroupMember cmdlet to add members to the role group. Instead, you need to add members to the foreign 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://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-RoleGroupMember "Recipient Management" -Member David -``` - -This example adds the user David to the role group Recipient Management. - -### -------------------------- Example 2 -------------------------- -``` -Get-User -Filter { Department -Eq "Sales" -And RecipientType -Eq "UserMailbox" } | Get-Mailbox | Add-RoleGroupMember "Sales and Marketing Group" -WhatIf -``` - -This example finds all the mailboxes that are part of the Sales department and adds them to the Sales and Marketing Group role group. Because we're using the WhatIf switch, the changes aren't written to the role group, so you can verify that the correct members will be added. - -After you've verified that the correct members will be added to the role group, remove the WhatIf switch and run the command again. - -For more information about pipelining and the WhatIf parameter, see the following topics: - -- Pipelining (https://technet.microsoft.com/library/aa998260.aspx) - -- WhatIf, Confirm and ValidateOnly switches - -### -------------------------- Example 3 -------------------------- -``` -Add-RoleGroupMember "Training Administrators" -Member "Training Assistants" -BypassSecurityGroupManagerCheck -``` - -This example adds the Training Assistants USG to the Training Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. - -## PARAMETERS - -### -Identity -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Member -The Member parameter specifies the mailbox, USG, or computer to add to a role group. You can only specify one member at a time. If the member name contains spaces, enclose the name in quotation marks ("). - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to add a member to a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ed53e269-a855-4066-88a7-1ba36086bd72.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRole.md b/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRole.md deleted file mode 100644 index 8ef00dd364..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRole.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-ManagementRole -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Get-ManagementRole cmdlet to view management roles that have been created in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### GetChildren -``` -Get-ManagementRole [-Identity] <RoleIdParameter> [-GetChildren] - [-DomainController <Fqdn>] - [-RoleType <RoleType>] [<CommonParameters>] -``` - -### Recurse -``` -Get-ManagementRole [-Identity] <RoleIdParameter> [-Recurse] - [-DomainController <Fqdn>] - [-RoleType <RoleType>] [<CommonParameters>] -``` - -### Identity -``` -Get-ManagementRole [[-Identity] <RoleIdParameter>] [-Cmdlet <String>] [-CmdletParameters <String[]>] - [-DomainController <Fqdn>] - [-RoleType <RoleType>] [<CommonParameters>] -``` - -### Script -``` -Get-ManagementRole [[-Identity] <RoleIdParameter>] [-Script <String>] [-ScriptParameters <String[]>] - [-DomainController <Fqdn>] - [-RoleType <RoleType>] - [<CommonParameters>] -``` - -## DESCRIPTION -You can view management roles in several ways, from listing all the roles in your organization to listing only the child roles of a specified parent role. You can also view the details of a specific role by piping the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. - -For more information about management roles, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ManagementRole -``` - -This example lists all the roles that have been created in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementRole "Mail Recipients" -Recurse -``` - -This example lists all the roles that are children of the Mail Recipients management role. The command performs a recursive query of all the child roles of the specified parent role. This recursive query finds every child role from the immediate children of the parent to the last child role in the hierarchy. In a recursive list, the parent role is also returned in the list. - -### -------------------------- Example 3 -------------------------- -``` -Get-ManagementRole -CmdletParameters Identity, Database -``` - -This example lists all the roles that contain both the Identity and Database parameters. Roles that contain only one parameter or the other aren't returned. - -### -------------------------- Example 4 -------------------------- -``` -Get-ManagementRole -RoleType UnScopedTopLevel -``` - -This example lists all the roles that have a type of UnScopedTopLevel. These roles contain custom scripts or non-Exchange cmdlets. - -### -------------------------- Example 5 -------------------------- -``` -Get-ManagementRole "Transport Rules" | Format-List Name, RoleType -``` - -This example retrieves only the Transport Rules role and passes the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. The Format-List cmdlet then shows only the Name and RoleType properties of the Transport Rules role. For more information about pipelining and the Format-List cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -### -------------------------- Example 6 -------------------------- -``` -Get-ManagementRole "Mail Recipients" -GetChildren -``` - -This example lists the immediate children of the Mail Recipients role. Only the child roles that hold the Mail Recipients role as their parent role are returned. The Mail Recipients role isn't returned in the list. - -## PARAMETERS - -### -Identity -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 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -GetChildren -The GetChildren parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. Only the immediate child roles of the parent role are included. The GetChildren parameter can only be used with the Identity and RoleType parameters. - -```yaml -Type: SwitchParameter -Parameter Sets: GetChildren -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recurse -The Recurse parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. The role specified in the Identity parameter, its child roles, and their children are returned. The Recurse parameter can only be used with the Identity and RoleType parameters. - -```yaml -Type: SwitchParameter -Parameter Sets: Recurse -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cmdlet -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CmdletParameters -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -RoleType -The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -```yaml -Type: RoleType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Script -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptParameters -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c3a48baa-ee7d-4615-88e3-5798443dee35.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRoleEntry.md deleted file mode 100644 index 88ee6ffdce..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementRoleEntry.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-ManagementRoleEntry cmdlet to retrieve management role entries that have been configured on management roles. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ManagementRoleEntry [-Identity] <RoleEntryIdParameter> [-DomainController <Fqdn>] [-Parameters <String[]>] - [-PSSnapinName <String>] [-Type <ManagementRoleEntryType[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-ManagementRoleEntry cmdlet retrieves role entries that have been configured on roles. You can retrieve specific role entries that match specific criteria such as role name, cmdlet name, parameter name, or a combination of each, or role entry type or the associated Windows PowerShell snap-in. - -For more information about management role entries, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ManagementRoleEntry "Transport Rules\*" -``` - -This example retrieves a list of all the role entries that exist on the Transport Rules management role. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementRoleEntry *\Get-Recipient -``` - -This example retrieves a list of all the role entries that contain the Get-Recipient cmdlet. - -### -------------------------- Example 3 -------------------------- -``` -Get-ManagementRoleEntry "Tier 2 Help Desk\Set-Mailbox" | Format-List Name, Parameters, Role, Type -``` - -This example retrieves the Tier 2 Help Desk\\Set-Mailbox role entry and pipes the output of the Get-ManagementRoleEntry cmdlet to the Format-List cmdlet. The Format-List cmdlet then outputs only the Name, Parameters, Role and Type properties from the role entry. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the role entry to retrieve. You must specify the value of the Identity parameter in the format, \<management role\>\\\<role entry name\>, for example, ExampleRole\\Set-Mailbox. - -For more information about how management role entries work, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -You can use the wildcard character (\*) instead of the role, cmdlet name or both. - -If the role entry name contains spaces, enclose the name in quotation marks ("). - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PSSnapinName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the type of role entry to return. The valid values for the Type parameter are any combination of the following parameters, separated by commas: Cmdlet, Script and ApplicationPermission. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3b58e5dc-0e57-4998-82cb-94dc081f6420.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementScope.md b/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementScope.md deleted file mode 100644 index 613c5da748..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-ManagementScope.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-ManagementScope cmdlet to return a list of management scopes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ManagementScope [[-Identity] <ManagementScopeIdParameter>] [-DomainController <Fqdn>] - [-Exclusive <$true | $false>] [-Orphan] [<CommonParameters>] -``` - -## DESCRIPTION -You can retrieve one scope or many, retrieve only scopes that aren't associated with management role assignments, or retrieve scopes that are exclusive or regular scopes. - -For more information about regular and exclusive scopes, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ManagementScope Redmond* -``` - -This example retrieves all the management scopes that start with the string Redmond. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementScope "Redmond Servers Scope" | Format-List -``` - -This example retrieves the Redmond Servers Scope using the Get-ManagementScope cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -### -------------------------- Example 3 -------------------------- -``` -Get-ManagementScope -Orphan -``` - -This example retrieves a list of management scopes that aren't associated with any role assignments. - -### -------------------------- Example 4 -------------------------- -``` -Get-ManagementScope -Exclusive $True -``` - -This example retrieves a list of exclusive scopes. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### -Exclusive -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: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the management scope to return. If the management scope name contains spaces, enclose it in quotation marks ("). - -```yaml -Type: ManagementScopeIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Orphan -The Orphan parameter returns only the management scopes that aren't associated with role assignments. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a14e4ca3-2035-4959-a55f-efc50685a224.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md deleted file mode 100644 index 4465a38c52..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RoleAssignmentPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-RoleAssignmentPolicy cmdlet to view existing management role assignment policies in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RoleAssignmentPolicy [[-Identity] <MailboxPolicyIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -For more information about assignment policies, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RoleAssignmentPolicy -``` - -This example returns a list of all the existing role assignment policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-RoleAssignmentPolicy "End User Policy" | Format-List -``` - -This example returns the details of the specified assignment policy. The output of the Get-RoleAssignmentPolicy cmdlet is piped to the Format-List cmdlet. - -For more information about pipelining and the Format-List cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -### -------------------------- Example 3 -------------------------- -``` -Get-RoleAssignmentPolicy | Where { $_.IsDefault -eq $True } -``` - -This example returns the default assignment policy. - -The output of the Get-RoleAssignmentPolicy cmdlet is piped to the Where cmdlet. The Where cmdlet filters out all of the policies except the policy that has the IsDefault property set to $True. - -For more information about pipelining and the Format-List cmdlet, see Pipelining (https://technet.microsoft.com/library/aa998260.aspx) and Working with command output (https://technet.microsoft.com/library/bb123533.aspx). - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the 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 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/da0ecaa3-ce67-4ea2-aca3-56e056555900.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleGroup.md b/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleGroup.md deleted file mode 100644 index aff2a5be35..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleGroup.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-RoleGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Get-RoleGroup cmdlet to retrieve a list of management role groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RoleGroup [[-Identity] <RoleGroupIdParameter>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-ShowPartnerLinked] - [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -For more information about role groups, see Understanding management role groups (https://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RoleGroup -``` - -This example retrieves a list of role groups. - -### -------------------------- Example 2 -------------------------- -``` -Get-RoleGroup "Recipient Administrators" | Format-List -``` - -This example retrieves the details for the Recipient Administrators role group. - -### -------------------------- Example 3 -------------------------- -``` -Get-RoleGroup -ReadFromDomainController -``` - -This example retrieves a list of role groups as seen by the domain controller closest to the user. - -### -------------------------- Example 4 -------------------------- -``` -Get-RoleGroup -Filter { RoleGroupType -Eq "Linked" } | Format-Table Name, LinkedGroup -``` - -This example retrieves a list of all linked role groups and the Active Directory security identifier (SID) of the foreign universal security groups (USG) that are linked to each of them. You can then use the SIDs to find the USGs so you can modify their members. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: RoleGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Filter -The Filter parameter specifies the property to be used to filter the role groups. Only the role groups that match the criteria you specify are returned. - -You can filter on the LinkedGroup, ManagedBy, Members, Name, RoleGroupType and DisplayName properties. If you create a filter using the RoleGroupType property, the only values you can use in the filter are Standard and Linked. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowPartnerLinked -This parameter is available only in the cloud-based service. - -This ShowPartnerLinked switch specifies whether to return built-in role groups that are of type PartnerRoleGroup. Role groups of this type are used in the cloud-based services to allow partner service providers to manage their customer organizations. These role groups can't be edited and are therefore not shown by default. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/369800ff-fced-4d1c-adb0-1ddbe798670d.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleGroupMember.md b/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleGroupMember.md deleted file mode 100644 index 28b1e11e98..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Get-RoleGroupMember.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-RoleGroupMember -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Get-RoleGroupMember cmdlet to retrieve a list of members of a management role group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-RoleGroupMember [-Identity] <RoleGroupMemberIdParameter> [-DomainController <Fqdn>] - [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -For more information about role groups, see Understanding management role groups (https://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-RoleGroupMember "Recipient Administrators" -``` - -This example retrieves a list of all the members of the Recipient Administrators role group. - -### -------------------------- Example 2 -------------------------- -``` -Get-RoleGroupMember "Organization Administrators" -ReadFromDomainController -``` - -This example retrieves a list of all the members of the Organization Administrators role group as seen by the domain controller closest to the user running the command. - -## PARAMETERS - -### -Identity -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1ff116aa-1a62-4283-bc8e-5963d12958e1.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementRole.md b/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementRole.md deleted file mode 100644 index 3f579f5c67..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementRole.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-ManagementRole cmdlet to create a management role based on an existing role or create an unscoped management role. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### NewDerivedRole -``` -New-ManagementRole [-Name] <String> -Parent <RoleIdParameter> [-EnabledCmdlets <String[]>] - [-Confirm] - [-Description <String>] - [-DomainController <Fqdn>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### UnScopedTopLevelRole -``` -New-ManagementRole [-Name] <String> [-UnScopedTopLevel] - [-Confirm] - [-Description <String>] - [-DomainController <Fqdn>] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -The ability to create an unscoped management role isn't granted by default. To create an unscoped management role, you must assign the Unscoped Role Management management role to a role group you're a member of. For more information about how to create an unscoped management role, see Create an unscoped role (https://technet.microsoft.com/library/dd876886.aspx). - -After you create a role, you can change the management role entries on the role and assign the role with a management scope to a user or universal security group (USG). - -For more information about management roles, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ManagementRole -Name "Redmond Journaling View-Only" -Parent Journaling; Get-ManagementRoleEntry "Redmond Journaling View-Only\*" | Where { $_.Name -NotLike "Get*" } | Remove-ManagementRoleEntry -WhatIf -``` - -This example creates the management role Redmond Journaling View-Only based on the Journaling parent role. - -After the role is created, the Remove-ManagementRoleEntry cmdlet is used along with the Where cmdlet to remove all the management role entries that aren't needed on the role. You can't add role entries to the newly created role because it already has all the role entries that exist on its parent role, Journaling. The WhatIf switch is used to verify that the correct role entries are removed. - -After confirmation that the command removes the correct role entries, the second command is run again without the WhatIf switch. - -For more information about pipelining and the Where cmdlet, see the following topics: - -- Pipelining (https://technet.microsoft.com/library/aa998260.aspx) - -- Working with command output (https://technet.microsoft.com/library/bb123533.aspx) - -### -------------------------- Example 2 -------------------------- -``` -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. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. - -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -The UnScopedTopLevel switch specifies that the role new role is an unscoped top-level management role (a custom, empty role). You don't need to specify a value with this switch. - -You can only add custom scripts or non-Exchange cmdlets to an unscoped top-level management role. For more information, see Create an unscoped role(https://technet.microsoft.com/library/dd876886.aspx). - -You can't use this switch with the Parent parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: UnScopedTopLevelRole -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledCmdlets -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. - -```yaml -Type: String[] -Parameter Sets: NewDerivedRole -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Force -This parameter is available only in the cloud-based service. - -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/76367e39-a387-430f-b3a5-1df20dd31201.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementRoleAssignment.md deleted file mode 100644 index fe63ad6c2f..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementRoleAssignment.md +++ /dev/null @@ -1,487 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-ManagementRoleAssignment cmdlet to assign a management role to a management role group, management role assignment policy, user, or universal security group (USG). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Computer -``` -New-ManagementRoleAssignment [[-Name] <String>] -Computer <ComputerIdParameter> -Role <RoleIdParameter> - [-Confirm] - [-CustomConfigWriteScope <ManagementScopeIdParameter>] - [-CustomRecipientWriteScope <ManagementScopeIdParameter>] - [-DomainController <Fqdn>] - [-ExclusiveConfigWriteScope <ManagementScopeIdParameter>] - [-ExclusiveRecipientWriteScope <ManagementScopeIdParameter>] - [-RecipientAdministrativeUnitScope <AdministrativeUnitIdParameter>] - [-RecipientOrganizationalUnitScope <OrganizationalUnitIdParameter>] - [-RecipientRelativeWriteScope <None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate>] - [-UnScopedTopLevel] - [-WhatIf] [<CommonParameters>] -``` - -### Policy -``` -New-ManagementRoleAssignment [[-Name] <String>] -Policy <MailboxPolicyIdParameter> -Role <RoleIdParameter> - [-Confirm] - [-CustomConfigWriteScope <ManagementScopeIdParameter>] - [-CustomRecipientWriteScope <ManagementScopeIdParameter>] - [-DomainController <Fqdn>] - [-ExclusiveConfigWriteScope <ManagementScopeIdParameter>] - [-ExclusiveRecipientWriteScope <ManagementScopeIdParameter>] - [-Force] - [-RecipientAdministrativeUnitScope <AdministrativeUnitIdParameter>] - [-RecipientOrganizationalUnitScope <OrganizationalUnitIdParameter>] - [-RecipientRelativeWriteScope <None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate>] - [-UnScopedTopLevel] - [-WhatIf] [<CommonParameters>] -``` - -### SecurityGroup -``` -New-ManagementRoleAssignment [[-Name] <String>] -Role <RoleIdParameter> -SecurityGroup <SecurityGroupIdParameter> [-Delegating] - [-Confirm] - [-CustomConfigWriteScope <ManagementScopeIdParameter>] - [-CustomRecipientWriteScope <ManagementScopeIdParameter>] - [-DomainController <Fqdn>] - [-ExclusiveConfigWriteScope <ManagementScopeIdParameter>] - [-ExclusiveRecipientWriteScope <ManagementScopeIdParameter>] - [-Force] - [-RecipientAdministrativeUnitScope <AdministrativeUnitIdParameter>] - [-RecipientOrganizationalUnitScope <OrganizationalUnitIdParameter>] - [-RecipientRelativeWriteScope <None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate>] - [-UnScopedTopLevel] - [-WhatIf] [<CommonParameters>] -``` - -### User -``` -New-ManagementRoleAssignment [[-Name] <String>] -Role <RoleIdParameter> -User <UserIdParameter> [-Delegating] - [-Confirm] - [-CustomConfigWriteScope <ManagementScopeIdParameter>] - [-CustomRecipientWriteScope <ManagementScopeIdParameter>] - [-DomainController <Fqdn>] - [-ExclusiveConfigWriteScope <ManagementScopeIdParameter>] - [-ExclusiveRecipientWriteScope <ManagementScopeIdParameter>] - [-Force] - [-RecipientAdministrativeUnitScope <AdministrativeUnitIdParameter>] - [-RecipientOrganizationalUnitScope <OrganizationalUnitIdParameter>] - [-RecipientRelativeWriteScope <None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate>] - [-UnScopedTopLevel] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you add a new role assignment, you can specify a built-in or custom role that was created using the New-ManagementRole cmdlet and specify an organizational unit (OU) or predefined or custom management scope to restrict the assignment. - -You can create custom management scopes using the New-ManagementScope cmdlet and can view a list of existing scopes using the Get-ManagementScope cmdlet. If you choose not to specify an OU, or predefined or custom scope, the implicit write scope of the role applies to the role assignment. - -For more information about management role assignments, see Understanding management role assignments (https://technet.microsoft.com/library/dd335131.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ManagementRoleAssignment -Role "Mail Recipients" -SecurityGroup "Tier 2 Help Desk" -``` - -This example assigns the Mail Recipients role to the Tier 2 Help Desk role group. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementRole "MyVoiceMail" | Format-Table Name, IsEndUserRole; 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. - -### -------------------------- Example 3 -------------------------- -``` -New-ManagementRoleAssignment -Role "Eng Help Desk" -SecurityGroup "Eng HD Personnel" -RecipientOrganizationalUnitScope contoso.com/Engineering/Users -``` - -This example assigns the Eng Help Desk role to the Eng HD Personnel role group. The assignment restricts the recipient write scope of the role to the contoso.com/Engineering/Users OU. Users who are members of the Eng HD Personnel role group can only create, modify, or remove objects contained within that OU. - -### -------------------------- Example 4 -------------------------- -``` -New-ManagementRoleAssignment -Role "Distribution Groups" -SecurityGroup "North America Exec Assistants" -CustomRecipientWriteScope "North America Recipients" -``` - -This example assigns the Distribution Groups role to the North America Exec Assistants role group. The assignment restricts the recipient write scope of the role to the scope specified in the North America Recipients custom recipient management scope. Users who are members of the North America Exec Assistants role group can only create, modify, or remove distribution group objects that match the specified custom recipient management scope. - -### -------------------------- Example 5 -------------------------- -``` -New-ManagementRoleAssignment -Name "Exchange Servers_John" -Role "Exchange Servers" -User John -CustomConfigWriteScope "Sydney Servers" -``` - -This example assigns the Exchange Servers role to John. Because John should only manage the servers running Exchange located in Sydney, the role assignment restricts the configuration write scope of the role to the scope specified in the Sydney Servers custom configuration role group. John can only manage servers that match the specified custom configuration management scope. - -### -------------------------- Example 6 -------------------------- -``` -New-ManagementRoleAssignment -Name "Excl-Mail Recipients_Executive Administrators" -Role "Mail Recipients" -SecurityGroup "Executive Administrators" -ExclusiveRecipientWriteScope "Exclusive-Executive Recipients" -``` - -This example assigns the Mail Recipients role to the Executive Administrators role group. The assignment restricts the recipient write scope of the role to the scope specified in the Exclusive-Executive Recipients exclusive recipient management scope. Because the Exclusive-Executive Recipients scope is an exclusive scope, only users of the Executive Administrators can manage the executive recipients that match the exclusive recipient scope. No other users, unless they're also assigned an assignment that uses an exclusive scope that matches the same users, can modify the executive recipients. - -### -------------------------- Example 7 -------------------------- -``` -New-ManagementRoleAssignment -Name "Mail Recipients_Contoso Seattle" -Role "Mail Recipients" -SecurityGroup "Contoso Sub - Seattle" -CustomConfigWriteScope "Contoso Databases" -RecipientOrganizationalUnitScope adatum.com/Contoso/Seattle/Users -``` - -This example assigns the Mail Recipients role to the Contoso Sub - Seattle role group. The administrators in this role group should only be allowed to create and manage mail recipients in specific databases that have been allocated for use by the Contoso subsidiary, A. Datum Corporation (adatum.com). Also, this group of administrators should only be allowed to manage the Contoso employees located in the Seattle office. This is done by creating a role assignment with both a database scope, to limit management of mail recipients to only the databases in the database scope and a recipient OU scope, to limit access to only the recipient objects within the Contoso Seattle OU. - -## 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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Computer -This parameter is available only in on-premises Exchange. - -The Computer parameter specifies the name of the computer to assign the management role to. - -If you specify the Computer parameter, you can't specify the SecurityGroup, User, or Policy parameters. - -```yaml -Type: ComputerIdParameter -Parameter Sets: Computer -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the name of the management role assignment policy to assign the management role to. - -The IsEndUserRole property of the role you specify using the Role parameter must be set to $true. - -If you specify the Policy parameter, you can't specify the SecurityGroup, Computer, or User parameters. If the policy name contains spaces, enclose the name in quotation marks ("). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks ("). - -```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: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SecurityGroup -The SecurityGroup parameter specifies the name of the management role group or universal USG to assign the management role to. - -If you specify the SecurityGroup parameter, you can't specify the Policy, Computer, or User parameters. If the role group or USG name contains spaces, enclose the name in quotation marks ("). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the name or alias of the user to assign the management role to. - -If you specify the User parameter, you can't specify the SecurityGroup, Computer, or Policy parameters. If the value contains spaces, enclose the name in quotation marks ("). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomConfigWriteScope -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 ("). - -```yaml -Type: ManagementScopeIdParameter -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 -``` - -### -CustomRecipientWriteScope -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: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delegating -The Delegating parameter specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't have to specify a value with the Delegating parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExclusiveConfigWriteScope -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 ("). - -```yaml -Type: ManagementScopeIdParameter -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 -``` - -### -ExclusiveRecipientWriteScope -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: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is available only in the cloud-based service. - -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Policy, SecurityGroup, User -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAdministrativeUnitScope -The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the new role assignment to. - -Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - -```yaml -Type: AdministrativeUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientOrganizationalUnitScope -The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientRelativeWriteScope -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. - -```yaml -Type: None | NotApplicable | Organization | MyGAL | Self | MyDirectReports | OU | CustomRecipientScope | MyDistributionGroups | MyExecutive | ExclusiveRecipientScope | MailboxICanDelegate -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. - -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. - -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role(https://technet.microsoft.com/library/dd876886.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/34d4f2e3-f2c5-49e1-a6a9-1366da65a78c.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementScope.md b/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementScope.md deleted file mode 100644 index 64009cae0b..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/New-ManagementScope.md +++ /dev/null @@ -1,332 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-ManagementScope cmdlet to create a regular or exclusive management scope. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### DatabaseList -``` -New-ManagementScope [-Name] <String> -DatabaseList <DatabaseIdParameter[]> - [-Confirm] - [-DomainController <Fqdn>] - [-Exclusive] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### DatabaseFilter -``` -New-ManagementScope [-Name] <String> -DatabaseRestrictionFilter <String> - [-Confirm] - [-DomainController <Fqdn>] - [-Exclusive] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### RecipientFilter -``` -New-ManagementScope [-Name] <String> -RecipientRestrictionFilter <String> - [-Confirm] - [-DomainController <Fqdn>] - [-Exclusive] - [-Force] - [-RecipientRoot <OrganizationalUnitIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### ServerList -``` -New-ManagementScope [-Name] <String> -ServerList <ServerIdParameter[]> - [-Confirm] - [-DomainController <Fqdn>] - [-Exclusive] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### ServerFilter -``` -New-ManagementScope [-Name] <String> -ServerRestrictionFilter <String> - [-Confirm] - [-DomainController <Fqdn>] - [-Exclusive] - [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you create a regular or exclusive scope, you need to associate the scope with a management role assignment. To associate a scope with a role assignment, use the New-ManagementRoleAssignment cmdlet. For more information about adding new management scopes, see Create a regular or exclusive scope (https://technet.microsoft.com/library/dd351083.aspx). - -For more information about regular and exclusive scopes, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-ManagementScope -Name "Mailbox Servers 1 through 3" -ServerList MailboxServer1, MailboxServer2, MailboxServer3 -``` - -This example creates a scope that includes only the servers MailboxServer1, MailboxServer2, and MailboxServer3. Users assigned roles using management role assignments that have the scope in this example can only perform against the servers included in the scope. - -### -------------------------- Example 2 -------------------------- -``` -New-ManagementScope -Name "Redmond Site Scope" -ServerRestrictionFilter {ServerSite -eq "CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com"} -``` - -This example creates the Redmond Site Scope scope and sets a server restriction filter that matches only the servers located in the "CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com" Active Directory Domain Services (AD DS) site. - -### -------------------------- Example 3 -------------------------- -``` -New-ManagementScope -Name "Executive Mailboxes" -RecipientRoot "contoso.com/Executives" -RecipientRestrictionFilter {RecipientType -eq "UserMailbox"} -``` - -This example creates the Executive Mailboxes scope. Only mailboxes located within the Executives OU in the contoso.com domain match the recipient restriction filter. - -### -------------------------- Example 4 -------------------------- -``` -New-ManagementScope -Name "Protected Exec Users" -RecipientRestrictionFilter { Title -Like "*VP*" } -Exclusive; New-ManagementRoleAssignment -SecurityGroup "Executive Administrators" -Role "Mail Recipients" -CustomRecipientWriteScope "Protected Exec Users" -``` - -This example creates the Protected Exec Users exclusive scope. Users that contain the string "VP" in their title match the recipient filter for the scope. When the exclusive scope is created, all users are immediately blocked from modifying the recipients that match the exclusive scope until the scope is associated with a management role assignment. If other role assignments are associated with other exclusive scopes that match the same recipients, those assignments can still modify the recipients. - -The exclusive scope is then associated with a management role assignment that assigns the Mail Recipients management role to the Executive Administrators role group. This role group contains administrators who are allowed to modify the mailboxes of high-profile executives. Only the administrators of the Executive Administrators role group can modify users with the string "VP" in their title. - -### -------------------------- Example 5 -------------------------- -``` -New-ManagementScope -Name "Seattle Databases" -DatabaseRestrictionFilter {Name -Like "SEA*" } -``` - -This example creates the Seattle Databases scope and sets a database restriction filter that matches only the databases that begin with the string "SEA". - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseList -This parameter is available only in on-premises Exchange. - -The DatabaseList parameter specifies a list of databases to which the scope should be applied. Multiple databases can be specified, separated by commas. If you use the DatabaseList parameter, you can't use the DatabaseRestrictionFilter, ServerList, RecipientRestrictionFilter, RecipientRoot, or ServerRestrictionFilter parameters. - -```yaml -Type: DatabaseIdParameter[] -Parameter Sets: DatabaseList -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseRestrictionFilter -This parameter is available only in on-premises Exchange. - -The DatabaseRestrictionFilter parameter specifies the filter to apply to database objects. Only database objects that match the filter are included in the scope. If you use the DatabaseRestrictionFilter parameter, you can't use the RecipientRestrictionFilter, ServerRestrictionFilter, RecipientRoot, DatabaseList, or ServerList parameters. For a list of filterable database properties, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -```yaml -Type: String -Parameter Sets: DatabaseFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientRestrictionFilter -The RecipientRestrictionFilter parameter specifies the filter to apply to recipient objects. Only recipient objects that match the filter are included in the scope. If you use the RecipientRestrictionFilter parameter, you can't use the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerList -This parameter is available only in on-premises Exchange. - -The ServerList parameter specifies a list of servers to which the scope should be applied. Multiple servers can be specified, separated by commas. If you use the ServerList parameter, you can't use the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerRestrictionFilter parameters. - -```yaml -Type: ServerIdParameter[] -Parameter Sets: ServerList -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerRestrictionFilter -This parameter is available only in on-premises Exchange. - -The ServerRestrictionFilter parameter specifies the filter to apply to server objects. Only server objects that match the filter are included in the scope. If you use the ServerRestrictionFilter parameter, you can't use the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerList parameters. For a list of filterable server properties, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -```yaml -Type: String -Parameter Sets: ServerFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Exclusive -The Exclusive switch specifies that the role should be an exclusive scope. - -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientRoot -The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. If you use the RecipientRoot parameter, you can't use the DatabaseRestrictionFilter, DatabaseList, ServerList or ServerRestrictionFilter parameters. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1ea1f474-69d6-48c0-9beb-bfa4442c5dab.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/role-based-access-control/New-RoleAssignmentPolicy.md deleted file mode 100644 index 33ccaeb85d..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/New-RoleAssignmentPolicy.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RoleAssignmentPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-RoleAssignmentPolicy cmdlet to create management role assignment policies in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-RoleAssignmentPolicy [-Name] <String> [-Confirm] [-Description <String>] [-DomainController <Fqdn>] - [-IsDefault] [-Roles <RoleIdParameter[]>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/jj657511.aspx). - -For more information about assignment policies, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-RoleAssignmentPolicy -Name "End User Policy"; Set-Mailbox -Identity Joe -RoleAssignmentPolicy "End User Policy" -``` - -This example creates an assignment policy. After the assignment policy is created, you can assign the assignment policy to a mailbox using the Set-Mailbox cmdlet. - -### -------------------------- Example 2 -------------------------- -``` -New-RoleAssignmentPolicy -Name "Default End User Policy" -IsDefault -``` - -This example creates an assignment policy using the IsDefault switch. - -### -------------------------- Example 3 -------------------------- -``` -New-RoleAssignmentPolicy -Name "Limited End User Policy" -Roles "MyPersonalInformation", "MyDistributionGroupMembership", "MyVoiceMail" -IsDefault; Get-Mailbox -ResultSize Unlimited | Set-Mailbox -RoleAssignmentPolicy "Limited End User Policy" -``` - -This example creates an assignment policy that enables users to modify their personal information, manage their distribution group membership, and manage their voice mail. The new assignment policy is created as the new default assignment policy. Then, all existing mailboxes are configured to use the new assignment policy. - -First, the new assignment policy is created and set as the new default assignment policy. - -Because setting the new role assignment as default applies only to new mailboxes or mailboxes moved from previous versions of Exchange, the Set-Mailbox cmdlet is used to configure the new assignment policy on all existing mailboxes. - -## PARAMETERS - -### -Name -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 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -Description -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -The IsDefault switch makes the assignment policy the default assignment policy. You don't have to specify a value with this switch. - -New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. - -Setting an assignment policy as default doesn't change the role assignment on existing mailboxes. To change the assignment policies on existing mailboxes, use the Set-Mailbox 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Roles -The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. - -For a list of built-in management roles that you can assign to a role group, see Built-in management roles (https://technet.microsoft.com/library/dd638077.aspx). - -```yaml -Type: RoleIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/25a56027-2e25-4f98-842f-c671a1bf56f9.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/New-RoleGroup.md b/exchange/exchange-ps/exchange/role-based-access-control/New-RoleGroup.md deleted file mode 100644 index 49071c438e..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/New-RoleGroup.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: New-RoleGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the New-RoleGroup cmdlet to create management role groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### CrossForest -``` -New-RoleGroup [-Name] <String> -LinkedDomainController <String> -LinkedForeignGroup <UniversalSecurityGroupIdParameter> [-LinkedCredential <PSCredential>] - [-Confirm] - [-CustomConfigWriteScope <ManagementScopeIdParameter>] - [-CustomRecipientWriteScope <ManagementScopeIdParameter>] - [-Description <String>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedBy <MultiValuedProperty>] - [-Members <MultiValuedProperty>] - [-RecipientOrganizationalUnitScope <OrganizationalUnitIdParameter>] - [-Roles <RoleIdParameter[]>] - [-SamAccountName <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -New-RoleGroup [-Name] <String> - [-Confirm] - [-CustomConfigWriteScope <ManagementScopeIdParameter>] - [-CustomRecipientWriteScope <ManagementScopeIdParameter>] - [-Description <String>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Force] - [-ManagedBy <MultiValuedProperty>] - [-Members <MultiValuedProperty>] - [-RecipientOrganizationalUnitScope <OrganizationalUnitIdParameter>] - [-Roles <RoleIdParameter[]>] - [-SamAccountName <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You don't have to add members or assign management roles to the role group when you create it. However, until you add members or assign roles to the role group, the role group grants no permissions to users. You can also specify custom configuration or recipient scopes when you create a role group. These scopes are applied to the management role assignments created when the role group is created. - -When you create a role group, you can create the group and add members to it directly, or you can create a linked role group. A linked role group links the role group to a universal security group (USG) in another forest. Creating a linked role group is useful if your servers running Exchange reside in a resource forest and your users and administrators reside in a separate user forest. If you create a linked role group, you can't add members directly to it. You must add the members to the USG in the foreign forest. - -For more information about role groups, see Understanding management role groups (https://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-RoleGroup -Name "Limited Recipient Management" -Roles "Mail Recipients", "Mail Enabled Public Folders" -Members Kim, Martin -``` - -This example creates a role group. The Mail Recipients and Mail Enabled Public Folders roles are assigned to the role group, and the users Kim and Martin are added as members. Because no scopes were provided, Kim and Martin can manage any recipient and reset passwords for any users in the organization. - -### -------------------------- Example 2 -------------------------- -``` -New-RoleGroup -Name "Seattle Limited Recipient Management" -Roles "Mail Recipients", "Mail Enabled Public Folders" -Members John, Carol -CustomRecipientWriteScope "Seattle Recipients" -``` - -This example creates a role group with a custom recipient scope. The custom recipient scope, Seattle Recipients, limits the scope of the roles assigned to the role group to recipients who have their City property set to Seattle. The Mail Recipients and Mail Enabled Public Folders roles are assigned to the role group, and the users John and Carol are added as members. - -### -------------------------- Example 3 -------------------------- -``` -New-RoleGroup -Name "Transport Rules Management" -Roles "Transport Rules" -Members "Compliance Group" -ManagedBy Isabel -``` - -This example creates a role group and enables Isabel to add or remove members to or from the role group by adding her to the ManagedBy property. The Transport Rules role is assigned to the role group, and the Compliance Group USG is added as a member. - -### -------------------------- Example 4 -------------------------- -``` -$Credentials = Get-Credential; New-RoleGroup -Name "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Administrators" -CustomRecipientWriteScope "Toronto Recipients" -Roles "Mail Recipients" -``` - -This example creates a linked role group that enables the members of the Toronto Administrators USG in the Contoso user forest to manage recipients located in the Toronto office. The custom recipient scope, Toronto Recipients, limits the scope of the roles assigned to the role group to recipients who have their City property set to Toronto. The Mail Recipients role is assigned to the role group. - -The first command retrieves the credentials using the Get-Credential cmdlet and stores them in the $Credentials variable. Then the linked role group is created using the second command. - -### -------------------------- Example 5 -------------------------- -``` -$RoleGroup = Get-RoleGroup "Recipient Management"; New-RoleGroup "Limited Recipient Management" -Roles $RoleGroup.Roles -``` - -This example takes an existing role group and copies the roles from that role group into a new custom role group. This can be useful if you want to create a role group similar to an existing role group but don't want to manually create all the role assignments. For example, you might want to create a role group that has most, but not all, of the management roles assigned to the Recipient Management role group. - -The first command stores the existing role group in a variable, and the second command creates the custom role group. - -This example uses variables to store information. For more information about variables, see User-defined variables (https://technet.microsoft.com/library/bb123690.aspx). - -### -------------------------- Example 6 -------------------------- -``` -Remove-ManagementRoleAssignment "Distribution Groups-Limited Recipient Management" -``` - -This example removes the role assignment between the Distribution Groups management role and the Limited Recipient Management role group that you created in the previous example. - -## PARAMETERS - -### -LinkedDomainController -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. - -If you use the LinkedDomainController parameter, you must specify a foreign USG with the LinkedForeignGroup parameter and you can't use the Members parameter. - -```yaml -Type: String -Parameter Sets: CrossForest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedForeignGroup -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 ("). - -If you use the LinkedForeignGroup parameter, you must specify a domain controller in the LinkedDomainController parameter and you can't use the Members parameter. - -```yaml -Type: UniversalSecurityGroupIdParameter -Parameter Sets: CrossForest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). - -Note: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomConfigWriteScope -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. - -```yaml -Type: ManagementScopeIdParameter -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 -``` - -### -CustomRecipientWriteScope -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. - -If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope parameter. - -```yaml -Type: ManagementScopeIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter can have 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedCredential -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 requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: CrossForest -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 -``` - -### -ManagedBy -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 ("). - -If you want to add more than one user or USG, separate them using commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the mailboxes or USGs to add as a member of the role group. You can use the 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 ("). If you want to add more than one user or USG, separate them using commas. - -If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDomainController or LinkedCredential parameters. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientOrganizationalUnitScope -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 ("). - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -Roles -The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. - -For a list of built-in management roles that you can assign to a role group, see Built-in management roles (https://technet.microsoft.com/library/dd638077.aspx). - -```yaml -Type: RoleIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -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 -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c59f596d-cbdd-459e-b31f-99d03e684299.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRole.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRole.md deleted file mode 100644 index ae5c0b2f9e..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRole.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-ManagementRole cmdlet to remove custom management roles that you don't need anymore. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ManagementRole [-Identity] <RoleIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] [-Recurse] - [-UnScopedTopLevel] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd335178.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ManagementRole ExampleRole1 -``` - -This example removes the single role ExampleRole1. - -### -------------------------- Example 2 -------------------------- -``` -Remove-ManagementRole ExampleRole2 -Recurse -WhatIf -``` - -This example runs the Remove-ManagementRole cmdlet with the WhatIf switch. The WhatIf switch lets the command run as if it were going to perform the action you specified but doesn't commit any changes. Instead, it displays the results of what would have happened, so you can verify that the actions are correct. - -If the results are as expected, remove the WhatIf switch and run the command again to remove the ExampleRole2 parent role and all its child roles. - -### -------------------------- Example 3 -------------------------- -``` -Get-ManagementRole *Example* | Remove-ManagementRole -WhatIf -``` - -This example uses the Get-ManagementRole cmdlet to get a list of roles that contain the string "Example" in the role name, and then pipes the list to the Remove-ManagementRole cmdlet. The Remove-ManagementRole cmdlet, because the WhatIf switch is specified, displays the roles that would have been removed but doesn't commit any changes. If the results are as expected, the command can be run again without the WhatIf switch to remove the roles. - -### -------------------------- Example 4 -------------------------- -``` -Remove-ManagementRole "In-house scripts" -UnScopedTopLevel -``` - -In on-premises Exchange, this example removes the In-house scripts unscoped top-level management role. Because this is an unscoped top-level role, the UnScopedTopLevel switch must be used. Note that the UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. - -For more information about unscoped top-level management roles, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -## PARAMETERS - -### -Identity -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 -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -This parameter is available only in the cloud-based service. - -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recurse -The Recurse parameter removes all child roles of the role specified with the Identity parameter, and then removes the specified role. - -The Recurse parameter removes all child roles of the specified role. We recommend that you first use the command with the WhatIf switch to confirm that the action to be taken is correct. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. - -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -The UnScopedTopLevel switch specifies the role that you want to remove is an unscoped top-level role. You don't need to specify a value with this switch. - -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. - -You must use this switch if you want to remove an unscoped top-level role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d67099bd-bb7e-4ad7-8d8a-9d4909d59dba.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md deleted file mode 100644 index 7191cb768a..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-ManagementRoleAssignment cmdlet to remove management role assignments. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ManagementRoleAssignment [-Identity] <RoleAssignmentIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd335131.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ManagementRoleAssignment "Recipients_Seattle Recipient Management" -``` - -This example removes the Recipients\_Seattle Recipient Management role assignment. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementRoleAssignment Detroit* | Remove-ManagementRoleAssignment -WhatIf -``` - -This example retrieves a list of role assignments that begin with the string "Detroit" and attempts to remove them with the Remove-ManagementRoleAssignment cmdlet. Because the WhatIf switch is included with the Remove-ManagementRoleAssignment command, the command displays the changes that would have occurred but doesn't commit any changes. - -After the list of role assignments to be removed is confirmed, remove the WhatIf switch and run the command again to remove the role assignments. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e2fd10e1-c0ae-48a6-992d-5b34bc73880b.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRoleEntry.md deleted file mode 100644 index c3459bd8fc..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementRoleEntry.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-ManagementRoleEntry cmdlet to remove existing management role entries. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ManagementRoleEntry [-Identity] <RoleEntryIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-ManagementRoleEntry cmdlet removes existing role entries. However, you can't remove role entries from built-in management roles. - -For more information about management role entries, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ManagementRoleEntry "Tier 1 Help Desk\New-Mailbox" -``` - -This example removes the New-Mailbox role entry from the Tier 1 Help Desk role. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementRoleEntry "Tier 1 Help Desk\New-*" | Remove-ManagementRoleEntry -WhatIf -``` - -This example removes all the role entries that have the verb New on the Tier 1 Help Desk role by piping the output of the Get-ManagementRoleEntry cmdlet to the Remove-ManagementRoleEntry cmdlet. Because the WhatIf switch has been specified along with the Remove-ManagementRoleEntry cmdlet, the cmdlet lists what changes would have been made but doesn't commit any changes. - -After you verify that the correct role entries will be removed, run the same command without the WhatIf switch to remove the role entries. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the role entry to remove. You must specify the value of the Identity parameter in the format, \<management role\>\\\<role entry name\>, for example, ExampleRole\\Set-Mailbox. - -For more information about how management role entries work, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -If the role entry name contains spaces, enclose the name in quotation marks ("). - -```yaml -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 -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dcd62514-a541-4385-859a-c8503a33d2e5.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementScope.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementScope.md deleted file mode 100644 index 23632beb3b..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-ManagementScope.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-ManagementScope cmdlet to remove an existing management scope. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ManagementScope [-Identity] <ManagementScopeIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd335146.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ManagementScope "Redmond Servers" -``` - -This example removes the Redmond Servers scope. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementScope -Orphan | Remove-ManagementScope -WhatIf -``` - -This example retrieves a list of all the orphaned scopes using the Get-ManagementScope cmdlet and pipes the output to the Remove-ManagementScope cmdlet. Because the WhatIf switch is used with the Remove-ManagementScope cmdlet, the cmdlet only displays the scopes that would have been removed but doesn't commit any changes. - -After you verify that the scopes to be removed are correct, run the command again without the WhatIf switch. - -## PARAMETERS - -### -Identity -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 -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b00abbf3-4554-4c9b-b887-e53d9f02713a.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md deleted file mode 100644 index 06db2419b0..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RoleAssignmentPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-RoleAssignmentPolicy cmdlet to remove existing management role assignment policies from your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RoleAssignmentPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The assignment policy you want to remove can't be assigned to any mailboxes or management roles. Also, if you want to remove the default assignment policy, it must be the last assignment policy. Do the following before you attempt to remove an assignment policy: - -- Use the Set-Mailbox cmdlet to change the assignment policy for any mailbox assigned the assignment policy you want to remove. - -- If the assignment policy is the default assignment policy, use the Set-RoleAssignmentPolicy cmdlet to select a new default assignment policy. You don't need to do this if you're removing the last assignment policy. - -- Use the Remove-ManagementRoleAssignment cmdlet to remove any management role assignments assigned to the policy. - -For more information about assignment policies, see Understanding management role assignment policies (https://technet.microsoft.com/library/dd638100.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"}; Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} | Set-Mailbox -RoleAssignmentPolicy "Seattle End User"; Get-ManagementRoleAssignment -RoleAssignee "End User" | Remove-ManagementRoleAssignment; Remove-RoleAssignmentPolicy "End User" -``` - -This example removes the role assignment policy named End User. - -Find all mailboxes that have the End User policy assigned to them. - -Assign a different role assignment policy to the mailboxes. The example uses the policy named Seattle End User. - -Remove all management role assignments that are assigned to the End User policy. - -Remove the End User role assignment policy. - -For more information about the Where cmdlet and pipelining, see Working with command output (https://technet.microsoft.com/library/bb123533.aspx) and Pipelining (https://technet.microsoft.com/library/aa998260.aspx). - -## PARAMETERS - -### -Identity -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cfcfe435-cd52-4d40-a298-0c1ca11b8995.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleGroup.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleGroup.md deleted file mode 100644 index 8a6ddd9333..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleGroup.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Remove-RoleGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Remove-RoleGroup cmdlet to remove a management role group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RoleGroup [-Identity] <RoleGroupIdParameter> [-BypassSecurityGroupManagerCheck] [-Confirm] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you remove a role group, all the management role assignments assigned management roles to the role group are also removed. The management roles aren't removed. Members of a removed role group can no longer manage a feature if the role group was the only means by which they were granted access to the feature. - -You can't remove built-in role groups. - -If the ManagedBy property has been populated with role group managers, the user removing the role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. - -For more information about role groups, see Understanding management role groups (https://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RoleGroup "Training Administrators" -``` - -This example removes the Training Administrators role group. - -### -------------------------- Example 2 -------------------------- -``` -Remove-RoleGroup "Vancouver Recipient Administrators" -BypassSecurityGroupManagerCheck -``` - -This example removes the Vancouver Recipient Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. - -## PARAMETERS - -### -Identity -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to remove a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6fe6975b-bc0f-4920-b0b0-6da245429f64.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleGroupMember.md b/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleGroupMember.md deleted file mode 100644 index 6a7761c274..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Remove-RoleGroupMember.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Remove-RoleGroupMember -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Remove-RoleGroupMember cmdlet to remove a member of a management role group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-RoleGroupMember [-Identity] <RoleGroupIdParameter> -Member <SecurityPrincipalIdParameter> - [-BypassSecurityGroupManagerCheck] [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you remove a member from a role group, that member can no longer manage the features made available by the role group if the role group is the only means by which the member is granted access to the feature. - -If the ManagedBy property has been populated with role group managers, the user removing a role group member 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 Remove-RoleGroupMember cmdlet to remove members from the role group. Instead, you need to remove members from the foreign universal security group (USG) linked to the linked role group. To find the foreign USG linked to a role group, use the Get-RoleGroup cmdlet. - -For more information about role groups, see Understanding management role groups (https://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-RoleGroupMember "Recipient Management" -Member David -``` - -This example removes the user David from the role group Recipient Management. - -### -------------------------- Example 2 -------------------------- -``` -Get-User -Filter { Department -Eq "Sales" -And -RecipientType -Eq "UserMailbox" } | Get-Mailbox | Remove-RoleGroupMember "Sales and Marketing Group" -WhatIf -``` - -This example finds all the mailboxes that are part of the Sales department and removes them from the Sales and Marketing Group role group. Because we're using the WhatIf switch, the changes aren't written to the role group, so you can verify that the correct members will be removed. - -After you've verified that the correct members will be removed the role group, remove the WhatIf switch and run the command again. - -For more information about pipelining, and the WhatIf parameter, see the following topics: - -- Pipelining (https://technet.microsoft.com/library/aa998260.aspx) - -- WhatIf, Confirm and ValidateOnly switches - -### -------------------------- Example 3 -------------------------- -``` -Remove-RoleGroupMember "Training Administrators" -Member "Training Assistants" -BypassSecurityGroupManagerCheck -``` - -This example removes the Training Assistants USG from the Training Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. - -## PARAMETERS - -### -Identity -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Member -The Member parameter specifies the mailbox or USG to remove from a role group. You can only specify one member at a time. If the member name contains spaces, enclose the name in quotation marks ("). - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to remove a member from a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/eed5ec30-471f-4c60-b377-bdf4a249b3d5.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementRoleEntry.md deleted file mode 100644 index 4911b0d295..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementRoleEntry.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-ManagementRoleEntry cmdlet to change the available parameters on an existing management role entry. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ManagementRoleEntry [-Identity] <RoleEntryIdParameter> [-AddParameter] [-Confirm] - [-DomainController <Fqdn>] [-Parameters <String[]>] [-RemoveParameter] [-UnScopedTopLevel] [-WhatIf] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-ManagementRoleEntry cmdlet changes the available parameters on an existing role entry. If you want to add parameters to a role entry, the parameters must exist in the role entry in the parent management role. If you want to remove parameters from a role entry, there can be no role entries in child roles that inherit those parameters from the role entry you want to change. You can't change role entries associated with built-in roles. - -For more information about management role entries, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ManagementRoleEntry "Help Desk Personnel\Get-Mailbox" -Parameters "Anr","Database" -RemoveParameter -``` - -This example removes the Anr and Database parameters from the Get-Mailbox role entry on the Help Desk Personnel role. - -### -------------------------- Example 2 -------------------------- -``` -Get-ManagementRoleEntry "Help Desk Personnel\*" | Set-ManagementRoleEntry -Parameters WhatIf -AddParameter -``` - -This example retrieves a list of role entries on the Help Desk Personnel role and adds the WhatIf switch to each role entry using the Set-ManagementRoleEntry cmdlet. - -### -------------------------- Example 3 -------------------------- -``` -Set-ManagementRoleEntry "Tier 1 Help Desk\Set-Mailbox" -Parameters "DisplayName","ForwardingAddress" -``` - -This example adds the DisplayName and ForwardingAddress parameters to the Set-Mailbox role entry on the Tier 1 Help Desk role and removes all other parameters from the role entry. - -### -------------------------- Example 4 -------------------------- -``` -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. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the role entry to change. You must specify the value of the Identity parameter in the format, \<management role\>\\\<role entry name\>, for example, ExampleRole\\Set-Mailbox. - -For more information about how management role entries work, see Understanding management roles (https://technet.microsoft.com/library/dd298116.aspx). - -If the role entry name contains spaces, enclose it in quotation marks ("). - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AddParameter -The AddParameter parameter adds the specified parameters to the specified role entry. Use the Parameters parameter to specify the parameters to add. You can't use the AddParameter parameter in the same command as the RemoveParameter parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -The Parameters parameter specifies the parameters to be added to or removed from the role entry. - -The Parameters parameter has the following modes: - -- When used with the AddParameter parameter, the parameters you specify are added to the role entry. - -- When used with the RemoveParameter parameter, the parameters you specify are removed from the role entry. - -- When neither the AddParameter nor RemoveParameter parameters are used, only the parameters you specify are included in the role entry. If you specify a value of $Null and neither the AddParameter nor RemoveParameter parameters are used, all of the parameters on the role entry are removed. - -You can specify multiple parameters, separated with commas. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveParameter -The RemoveParameter parameter removes the specified parameters from the specified role entry. Use the Parameters parameter to specify the parameters to remove. You can't use the RemoveParameter parameter in the same command as the AddParameter parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. - -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx). - -The UnScopedTopLevel switch specifies the role entry that you want to modify is on an unscoped top-level role. You don't need to specify a value with this switch. - -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role(https://technet.microsoft.com/library/dd876886.aspx). - -You must use this switch to modify role entries on unscoped top level roles. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is available only in the cloud-based service. - -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d4438459-d8b6-4214-b0d0-e374ef75c29e.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementScope.md b/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementScope.md deleted file mode 100644 index 1fd5f83fb3..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Set-ManagementScope.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-ManagementScope cmdlet to change an existing management scope. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### DatabaseFilter -``` -Set-ManagementScope [-Identity] <ManagementScopeIdParameter> -DatabaseRestrictionFilter <String> - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -### ServerFilter -``` -Set-ManagementScope [-Identity] <ManagementScopeIdParameter> -ServerRestrictionFilter <String> - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -### RecipientFilter -``` -Set-ManagementScope [-Identity] <ManagementScopeIdParameter> [-RecipientRestrictionFilter <String>] [-RecipientRoot <OrganizationalUnitIdParameter>] - [-Confirm] - [-DomainController <Fqdn>] - [-Force] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/dd298145.aspx). - -For more information about regular and exclusive scopes, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ManagementScope "Seattle Mailboxes" -RecipientRestrictionFilter { City -Eq "Seattle" -And RecipientType -Eq "UserMailbox" } -``` - -This example changes the recipient restriction filter on the Seattle Mailboxes management scope to match all mailboxes that have Seattle in the City mailbox property. - -### -------------------------- Example 2 -------------------------- -``` -Set-ManagementScope "Sales Recipients" -RecipientRoot contoso.com/Sales -``` - -This example changes the recipient root for the Sales Recipients management scope to match only recipient objects contained under the contoso.com/Sales OU. - -### -------------------------- Example 3 -------------------------- -``` -Set-ManagementScope "Vancouver Servers" -ServerRestrictionFilter {ServerSite -Eq "NA-CDN-Vancouver,CN=Sites,CN=Configuration,DC=contoso,DC=com"} -``` - -This example changes the Active Directory site used in the server restriction filter for the Vancouver Servers management scope to "NA-CDN-Vancouver,CN=Sites,CN=Configuration,DC=contoso,DC=com". - -## PARAMETERS - -### -DatabaseRestrictionFilter -This parameter is available only in on-premises Exchange. - -The DatabaseRestrictionFilter parameter specifies the filter to apply to database objects. When the DatabaseRestrictionFilter parameter is specified, only database objects that match the filter are included in the scope. If you use the DatabaseRestrictionFilter parameter, you can't use the ServerRestrictionFilter, RecipientRestrictionFilter or RecipientRoot parameters. For a list of filterable database properties, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -```yaml -Type: String -Parameter Sets: DatabaseFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ServerRestrictionFilter -This parameter is available only in on-premises Exchange. - -The ServerRestrictionFilter parameter specifies the filter to apply to server objects. When the ServerRestrictionFilter parameter is specified, only recipient objects that match the filter are included in the scope. If you use the ServerRestrictionFilter parameter, you can't use the DatabaseRestrictionFilter, RecipientRestrictionFilter, or RecipientRoot parameters. For a list of filterable server properties, see Understanding management role scopes (https://technet.microsoft.com/library/dd335146.aspx). - -```yaml -Type: String -Parameter Sets: ServerFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientRestrictionFilter -The RecipientRestrictionFilter parameter specifies the filter to apply to recipient objects. When the RecipientRestrictionFilter parameter is specified, only server objects that match the filter are included in the scope. If you use the RecipientRestrictionFilter parameter, you can't use the DatabaseRestrictionFilter or ServerRestrictionFilter parameters. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientRoot -The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. If you use the RecipientRoot parameter, you can't use the ServerRestrictionFilter or DatabaseRestrictionFilter parameters. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/568aa7c5-4b59-4e10-9139-782d49cd0969.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Set-RoleGroup.md b/exchange/exchange-ps/exchange/role-based-access-control/Set-RoleGroup.md deleted file mode 100644 index c8c71518b7..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Set-RoleGroup.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Set-RoleGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Set-RoleGroup cmdlet to modify who can add or remove members to or from management role groups or change the name of the role group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### CrossForest -``` -Set-RoleGroup [-Identity] <RoleGroupIdParameter> -LinkedDomainController <String> -LinkedForeignGroup <UniversalSecurityGroupIdParameter> [-LinkedCredential <PSCredential>] - [-BypassSecurityGroupManagerCheck] - [-Confirm] - [-Description <String>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-ManagedBy <MultiValuedProperty>] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -Set-RoleGroup [-Identity] <RoleGroupIdParameter> [-Force] - [-BypassSecurityGroupManagerCheck] - [-Confirm] - [-Description <String>] - [-DisplayName <String>] - [-ManagedBy <MultiValuedProperty>] - [-Name <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -If you want to add or remove members to or from an existing role group, use the Add-RoleGroupMember or Remove-RoleGroupMember cmdlets. If you want to add or remove management role assignments to or from a role group, use the New-ManagementRoleAssignment or Remove-ManagementRoleAssignment cmdlets. If you want to add or remove members to or from a linked role group, you must add or remove the members to or from the foreign universal security group (USG) in the foreign forest. To find the foreign USG, use the Get-RoleGroup cmdlet. - -If the ManagedBy property is populated with role group managers, the user configuring a role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. - -For more information about role groups, see Understanding management role groups (https://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-RoleGroup "London Recipient Administrators" -ManagedBy "David", "Christine" -``` - -This example sets the role group managers list to David and Christine on the London Recipient Administrators role group. - -### -------------------------- Example 2 -------------------------- -``` -Set-RoleGroup "Seattle Administrators" -ManagedBy "Seattle Role Administrators" -BypassSecurityGroupManagerCheck -``` - -This example sets the role group managers list to the Seattle Role Administrators USG on the Seattle Administrators role group. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. - -### -------------------------- Example 3 -------------------------- -``` -$Credentials = Get-Credential; Set-RoleGroup "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Tier 2 Administrators" -``` - -This example modifies the linked foreign USG on the existing linked role group ContosoUsers: Toronto Recipient Admins. The foreign USG that should be linked is Toronto Tier 2 Administrators. - -The first command retrieves the credentials using the Get-Credential cmdlet and stores them in the $Credentials variable. The second command modifies the foreign USG on the ContosoUsers: Toronto Recipient Admins linked role group. - -## PARAMETERS - -### -Identity -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -LinkedDomainController -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. - -You can only use the LinkedDomainController parameter with a linked role group. - -```yaml -Type: String -Parameter Sets: CrossForest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedForeignGroup -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 ("). - -You can only use the LinkedForeignGroup parameter to change the foreign USG linked to an existing linked role group. You can't change a standard role group to a linked role group by using the Set-RoleGroup cmdlet. You must create a role group using the New-RoleGroup cmdlet. - -If you use the LinkedForeignGroup parameter, you must specify a domain controller in the LinkedDomainController parameter. - -```yaml -Type: UniversalSecurityGroupIdParameter -Parameter Sets: CrossForest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to modify a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter can have 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: CrossForest -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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedCredential -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. - -You can only use the LinkedCredential parameter with a linked role group. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -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 ("). - -If you want to add more than one user or USG, separate them using commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c66ee1a2-cec7-4b76-a592-a5e626f4f9d3.aspx) diff --git a/exchange/exchange-ps/exchange/role-based-access-control/Update-RoleGroupMember.md b/exchange/exchange-ps/exchange/role-based-access-control/Update-RoleGroupMember.md deleted file mode 100644 index 0abd98649a..0000000000 --- a/exchange/exchange-ps/exchange/role-based-access-control/Update-RoleGroupMember.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Update-RoleGroupMember -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Update-RoleGroupMember cmdlet to modify the members of a management role group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-RoleGroupMember [-Identity] <RoleGroupIdParameter> [-BypassSecurityGroupManagerCheck] [-Confirm] - [-DomainController <Fqdn>] [-Members <MultiValuedProperty>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-RoleGroupMember cmdlet enables you to replace the entire membership list for a role group or perform programmatic addition or removal of multiple members at a single time. The membership list that you specify with the Members parameter on this cmdlet replaces the membership list for the specific role group. For this reason, take care when using this cmdlet so you don't mistakenly overwrite role group membership. - -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 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://technet.microsoft.com/library/dd638105.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-RoleGroupMember "Recipient Administrators" -Members "Mark", "Jane", "Mary", "Fred" -``` - -This example sets the Recipient Administrators role group membership list to Mark, Jane, Mary and Fred. - -### -------------------------- Example 2 -------------------------- -``` -Update-RoleGroupMember "Recipient Administrators" -Members "Mark", "Jane", "Mary", "Fred" -BypassSecurityGroupManagerCheck -``` - -This example sets the Recipient Administrators role group membership list to Mark, Jane, Mary and Fred. Because the user running the command wasn't added to the ManagedBy property of the role group, the BypassSecurityGroupManagerCheck switch must be used. The user is assigned the Role Management role, which enables the user to bypass the security group manager check. - -### -------------------------- Example 3 -------------------------- -``` -Update-RoleGroupMember "Organization Management" -Members @{Add=(Get-Mailbox David).Identity, (Get-Group "Help Desk Managers").Identity; Remove=(Get-Mailbox "Christine").Identity, (Get-Mailbox "Isabel").Identity} -``` - -This example adds multiple members to, and removes multiple members from, a role group without replacing all the existing members on the role group. This example makes use of multivalued property syntax that's described in the topic Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). When you use this multivalued property syntax, you must manually retrieve the Identity of the mailbox or security group that you want to add to or remove from the role group. Use the syntax that matches the type of object you want to add or remove: - -Mailbox: If you want to add or remove a mailbox, use the syntax (Get-Mailbox "\<Alias or Name\>").Identity - -Security Group: If you want to add or remove a security group, use the syntax (Get-Group "\<Name\>").Identity - -## PARAMETERS - -### -Identity -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - -- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. - -You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -Members -The Members parameter specifies the mailboxes or USG that should be members of a security group. If the member name contains spaces, enclose the name in quotation marks ("). Separate multiple members using commas. - -The list that you specify using the Members parameter overwrites the existing membership list of the role group. If you want to add or remove individual members to or from a role group, use the Add-RoleGroupMember or Remove-RoleGroupMember cmdlets. - -If you want to add or remove multiple members without replacing the entire membership list, see the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter doesn't work in the Office 365 Security & Compliance Center. - -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value 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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/37f82792-aaf1-4306-a563-37d6de3a8ee8.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md deleted file mode 100644 index f52b383482..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010 -title: Get-AvailabilityReportOutage -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-AvailabilityReportOutage - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-AvailabilityReportOutage cmdlet to return the daily downtime (if any) for each service entity and its overridden value (if set) to the overall reported availability for the day. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AvailabilityReportOutage [[-Identity] <AvailabilityReportOutageIdParameter>] [-ReportDate <ExDateTime>] - [-ReportingDatabase <String>] [-ReportingServer <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AvailabilityReportOutage -``` - -This example returns all outages that occurred the previous day. This cmdlet always returns outages for one day. - -### -------------------------- Example 2 -------------------------- -``` -Get-AvailabilityReportOutage -ReportDate:"2009-12-05" -Identity:"Outlook*" -``` - -This example returns all outages reported for Microsoft Outlook services at all sites on the selected day. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the outage. - -```yaml -Type: AvailabilityReportOutageIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ReportDate -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingDatabase -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6fe8a74c-743d-462f-8720-9d8a79b69014.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-EventLogLevel.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-EventLogLevel.md deleted file mode 100644 index eabe90ba94..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-EventLogLevel.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EventLogLevel -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-EventLogLevel - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-EventLogLevel cmdlet to display a list of Exchange event categories and the corresponding log levels on Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-EventLogLevel -Server <ServerIdParameter> [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Identity -``` -Get-EventLogLevel [[-Identity] <ECIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-EventLogLevel -Server "Exchange01" -``` - -This example displays the event categories and log levels for the server Exchange01. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can't use this parameter with the Identity parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter filters the results by the name of the event category. To see the available event categories, run the following command: Get-EventLogLevel. - -You can't use this parameter with the Server parameter. - -```yaml -Type: ECIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ea6a0956-c3b8-49fb-98ed-6570a06ce782.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md deleted file mode 100644 index 48ac3a92f9..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-GlobalMonitoringOverride -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-GlobalMonitoringOverride - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-GlobalMonitoringOverride cmdlet to view the overrides of the thresholds and parameters of the managed availability probes, monitors and responders that are configured for all Exchange 2013 or later servers in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-GlobalMonitoringOverride [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-GlobalMonitoringOverride -``` - -This example returns a summary list of all global monitoring overrides that are configured in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-GlobalMonitoringOverride | Format-List -``` - -This example returns detailed information for the global monitoring overrides that are configured in your organization: - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/34e6e29d-e10b-4ed0-8393-d9f89c78fd9c.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-HealthReport.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-HealthReport.md deleted file mode 100644 index 80241f6fae..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-HealthReport.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-HealthReport -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-HealthReport - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-HealthReport cmdlet to return health information for the Exchange server that you specify. You can use the health values to determine the state of the server. The cmdlet also returns an alert value that provides the specific state of your server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-HealthReport [-Identity] <ServerIdParameter> [-GroupSize <Int32>] [-HaImpactingOnly] [-HealthSet <String>] - [-MinimumOnlinePercent <Int32>] [-RollupGroup] [<CommonParameters>] -``` - -## DESCRIPTION -The following list contains the health values that are returned: - -- Online - -- Partially Online - -- Offline - -- Sidelined - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-HealthReport -Identity Mailbox01-RollupGroup -``` - -This example retrieves health information for the server named Mailbox01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Exchange server that you want to view. You can use the following values to identify the server: - -- Name - -- Distinguished name (DN) - -- FQDN - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -GroupSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HaImpactingOnly -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthSet -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumOnlinePercent -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RollupGroup -The RollupGroupswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f33fbed5-0e01-4d7e-a252-121b2afb6864.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-MonitoringItemHelp.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-MonitoringItemHelp.md deleted file mode 100644 index e37d631403..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-MonitoringItemHelp.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MonitoringItemHelp -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MonitoringItemHelp - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MonitoringItemHelp cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. Monitoring items are preconfigured to help you with your server health and monitoring. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MonitoringItemHelp [-Identity] <String> -Server <ServerIdParameter> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MonitoringItemHelp -Server Exch01 -Identity OutlookMapiHttp.Proxy\CrashEvent.msexchangemapifrontendapppoolEscalate\msexchangemapifrontendapppool | Format-List -``` - -This example retrieves health set information for a monitoring item on the server named Exch01 and displays the output without truncating the results.. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the monitoring item. The parameter uses the syntax \<HealthSet\>\\\<MonitoringItemName\>[\\\<TargetResource\>]. 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4e0bfa98-4c3d-46a5-bb18-8f64a2108c0a.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md deleted file mode 100644 index 7cdba58bf5..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MonitoringItemIdentity -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-MonitoringItemIdentity - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-MonitoringItemIdentity cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-MonitoringItemIdentity [-Identity] <String> -Server <ServerIdParameter> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MonitoringItemIdentity -Identity OutlookMapiHttp.Proxy -Server ExchSrv01 -``` - -This example returns information about the health set named OutlookMapiHttp.Proxy on the server named ExchSrv01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the health setthat 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7a4da080-0fe6-4dd7-85a2-cceeb68f95e0.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerComponentState.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerComponentState.md deleted file mode 100644 index fef561e4a3..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerComponentState.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerComponentState -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ServerComponentState - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ServerComponentState cmdlet to retrieve configuration settings for Microsoft Exchange components and endpoints. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ServerComponentState [-Identity] <ServerIdParameter> [-Component <String>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ServerComponentState -Identity Mailbox01 -``` - -This example returns a summary list of all component and endpoint states on the server named Mailbox01. - -### -------------------------- Example 2 -------------------------- -``` -Get-ServerComponentState -Identity Mailbox01 -Component UnifiedMessaging | Format-List -``` - -This example returns detailed information for the component state of the Unified Messaging component on the server named Mailbox01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Exchange server where you want to view the configuration settings. You can use the following values: - -- Name - -- Distinguished name (DN) - -- FQDN - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Component -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 \<ServerName\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/da7214fe-c641-4c6a-a479-df95a4136929.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerHealth.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerHealth.md deleted file mode 100644 index f6cd374410..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerHealth.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerHealth -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ServerHealth - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ServerHealth cmdlet to return health information related to the server you specify. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ServerHealth [-Identity] <ServerIdParameter> [-HaImpactingOnly] [-HealthSet <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -The cmdlet returns health values that you can use to determine the state of the server. See Server health and performance (https://technet.microsoft.com/library/jj150551.aspx) for related information. - -The cmdlet also returns an alert value that provides the specific state of your server. The following values may be returned: - -- Degraded - -- Unhealthy - -- Repairing - -- Disabled - -- Unavailable - -- UnInitialized - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ServerHealth -Identity Server01 -``` - -This example returns the server health for server Server01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the server you want health information for. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -HaImpactingOnly -The HaImpactingOnly switch specifies whether the cmdlet must roll up only the monitors that have HaImpacting set to True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthSet -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ca9cff3a-ecda-422d-abd7-b7d8da71a6c7.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md deleted file mode 100644 index 91b1836dfd..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerMonitoringOverride -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ServerMonitoringOverride - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ServerMonitoringOverride cmdlet to return all overrides created on the specified server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ServerMonitoringOverride -Server <ServerIdParameter> [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ServerMonitoringOverride -Server Exch01 -``` - -This example retrieves all monitoring overrides for the Exch01 server. - -## PARAMETERS - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -You can't use this parameter to configure other Edge Transport servers remotely. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/77f630fb-6711-459c-b073-843615863322.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-ThrottlingPolicy.md deleted file mode 100644 index d44ad33256..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ThrottlingPolicy.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ThrottlingPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ThrottlingPolicy - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ThrottlingPolicy cmdlet to view the user throttling settings for one or more throttling policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-ThrottlingPolicy [[-Identity] <ThrottlingPolicyIdParameter>] [-DomainController <Fqdn>] - [-Diagnostics] [-Explicit] [-ThrottlingPolicyScope <Regular | Organization | Global>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-ThrottlingPolicy cmdlet returns the client throttling settings for one or more throttling policies. If you use the Identity parameter, the cmdlet returns the settings for the identified throttling policy. If you don't use the Identity parameter, the cmdlet returns the settings for all throttling policies. - -For more information about how to control the resources consumed by individual users, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ThrottlingPolicy | Format-List -``` - -This example returns the settings for all throttling policies. - -### -------------------------- Example 2 -------------------------- -``` -Get-ThrottlingPolicy -Identity ThrottlingPolicy2 | Format-List -``` - -This example displays the parameters and values for throttling policy ThrottlingPolicy2. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Diagnostics -The Diagnostics switch specifies whether you want the output to include the diagnostics string. To return diagnostics information, use the syntax Get-ThrottlingPolicy -Diagnostics. You don't specify a value for this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Explicit -The Explicit switch specifies whether you only want to return the policy settings that have been directly assigned using this policy. By default, this parameter is set to $false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottlingPolicyScope -The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values: - -- Global - -- Organization - -- Regular - -For information about each of these policy scopes, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). - -```yaml -Type: Regular | Organization | Global -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f7490b98-20e0-46ee-b369-6f77538da689.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md deleted file mode 100644 index aea442114e..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ThrottlingPolicyAssociation -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-ThrottlingPolicyAssociation - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-ThrottlingPolicyAssociation cmdlet to view existing throttling policy associations in your organization. Throttling policies can be associated with mailboxes, user accounts, mail contacts, mail users, and Exchange server computer accounts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-ThrottlingPolicyAssociation [-Anr <String>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] [<CommonParameters>] -``` - -### Identity -``` -Get-ThrottlingPolicyAssociation [[-Identity] <ThrottlingPolicyAssociationIdParameter>] - [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -For more information about how to control the resources consumed by individual users, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-ThrottlingPolicyAssociation -OrganizationalUnit Users -``` - -In Exchange Server 2010 and 2013, this example returns a list of all the mailboxes in your organization in the Users OU. - -### -------------------------- Example 2 -------------------------- -``` -Get-ThrottlingPolicyAssociation -ResultSize unlimited -``` - -This example retrieves a summary list of all throttling policy associations in your organization. - -### -------------------------- Example 3 -------------------------- -``` -Get-ThrottlingPolicyAssociation -Anr Chr -DomainController DC01 -``` - -In Exchange Server 2010 and 2013, this example returns all the mailboxes that resolve from the ambiguous name resolution search on the string "Chr" that are in the domain DC01. This example returns mailboxes for users such as Chris Ashton, Christian Hess, and Christa Geller. - -### -------------------------- Example 4 -------------------------- -``` -Get-Group -Identity "Courtney Sweet" | Format-List -``` - -This example returns detailed information for the throttling policy association named Courtney Sweet that's associated with the user's mailbox. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -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 -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the throttling policy association that you want to view. You can use any value that uniquely identifies the throttling policy association. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: ThrottlingPolicyAssociationIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottlingPolicy -The ThrottlingPolicy parameter filters the results by throttling policy. You can use any value that uniquely identifies the throttling policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ThrottlingPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/45e1248f-89c2-467c-8d5d-de1367111e08.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md deleted file mode 100644 index 0e117705a5..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010 -title: Remove-AvailabilityReportOutage -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Remove-AvailabilityReportOutage - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Remove-AvailabilityReportOutage cmdlet to remove existing outages that have been added with the New-AvailabilityReportOutage cmdlet. Other outages must be modified with the Set-AvailabilityReportOutage cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AvailabilityReportOutage [-SiteName] <String> -ReportDate <ExDateTime> [-Confirm] [-Force] - [-ReportingDatabase <String>] [-ReportingServer <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AvailabilityReportOutage -ReportDate:"2009-12-02" -SiteName:"Site1" -``` - -This example removes a manually injected site-scoped outage for a specified day. - -## PARAMETERS - -### -ReportDate -The ReportDate parameter specifies the date to query for the outage report. - -```yaml -Type: ExDateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SiteName -The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -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 Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter suppresses the warning or confirmation messages that appear during specific configuration changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingDatabase -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingServer -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ef11332e-dfbf-464e-9174-ef24129b72e9.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md deleted file mode 100644 index 4e655dff75..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ThrottlingPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-ThrottlingPolicy - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-ThrottlingPolicy cmdlet to remove a non-default Microsoft Exchange throttling policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-ThrottlingPolicy [-Identity] <ThrottlingPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -You can't remove the default client throttling policy. Also, you can't remove a policy associated with any users. For more information, see Example 2. - -For more information about how to control the resources consumed by individual users, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-ThrottlingPolicy -Identity ClientThrottlingPolicy2 -``` - -This example removes the user throttling policy ClientThrottlingPolicy2. - -### -------------------------- Example 2 -------------------------- -``` -$policy = Get-ThrottlingPolicy ClientThrottlingPolicy2; $mailboxes = Get-Mailbox | where-object {$_.ThrottlingPolicy -eq $policy.Identity}; $defaultPolicy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true}; foreach ($mailbox in $mailboxes) {Set-Mailbox -Identity $mailbox.Identity -ThrottlingPolicy $defaultPolicy}; Remove-ThrottlingPolicy ClientThrottlingPolicy2 -``` - -You can't remove a policy that's associated with any users. This example reassigns the users subject to ClientThrottlingPolicy2 to the default policy. Then, it removes ClientThrottlingPolicy2. - -## PARAMETERS - -### -Identity -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 -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d98b709b-672e-42ad-afc4-c6e860d33bc9.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Set-EventLogLevel.md b/exchange/exchange-ps/exchange/server-health-and-performance/Set-EventLogLevel.md deleted file mode 100644 index 018a8168e0..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Set-EventLogLevel.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EventLogLevel -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-eventloglevel - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-EventLogLevel cmdlet to set the event log level registry value for the specified category. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-eventloglevel [-Identity] <ECIdParameter> -Level <Lowest | Low | Medium | High | Expert> [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-EventLogLevel -Identity "Exchange01\MSExchangeTransport\SmtpReceive" -Level High -``` - -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. - -## PARAMETERS - -### -Identity -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Level -The Level parameter specifies the log level for the specific event logging category. The valid values are: - -- Lowest - -- Low - -- Medium - -- High - -- Expert - -```yaml -Type: Lowest | Low | Medium | High | Expert -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/797f1691-32b7-4752-bb01-fea54cc28e1c.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Set-ServerComponentState.md b/exchange/exchange-ps/exchange/server-health-and-performance/Set-ServerComponentState.md deleted file mode 100644 index 9e1112ba3d..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Set-ServerComponentState.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ServerComponentState -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-ServerComponentState - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ServerComponentState cmdlet to configure and update Microsoft Exchange components and endpoints on servers you specify. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ServerComponentState [-Identity] <ServerIdParameter> -Component <String> -Requester <String> - -State <Inactive | Active | Draining> [-Confirm] [-DomainController <Fqdn>] [-LocalOnly] [-RemoteOnly] - [-TimeoutInSeconds <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ServerComponentState -Component UMCallRouter -Identity MailboxServer01 -Requester Maintenance -State Active -``` - -This example sets the Unified Messaging (UM) component state to Active, as requested by maintenance mode. - -## PARAMETERS - -### -Component -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the server you want to configure. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Requester -The Requester parameter specifies the system requesting this state change. Valid values are: - -- HealthAPI - -- Maintenance - -- Sidelined - -- Functional - -- Deployment - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -The State parameter specifies the state that you want for the component. Valid values are: - -- Active - -- Inactive - -- Draining - -```yaml -Type: Inactive | Active | Draining -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalOnly -The LocalOnlyswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteOnly -The RemoteOnlyswitch 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutInSeconds -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bf0a92ce-9bcf-476e-b92b-8279c141f361.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md deleted file mode 100644 index 36d34dea7a..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ThrottlingPolicyAssociation -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-ThrottlingPolicyAssociation - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact or a computer account. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-ThrottlingPolicyAssociation [-Identity] <ThrottlingPolicyAssociationIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-IgnoreDefaultScope] [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-ThrottlingPolicyAssociation cmdlet defines quota limits for specific objects. For example, if you notice that a user or other object is using excessive bandwidth, you can associate that object with a throttling policy that's more restrictive. - -In data center deployments, the object referred to by the Identity and ThrottlingPolicy parameters must be in the same tenant. - -For more information about how to control the resources consumed by individual users, see User workload management (https://technet.microsoft.com/library/jj150503.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-ThrottlingPolicyAssociation -Identity tonysmith -ThrottlingPolicy ITStaffPolicy -``` - -This example associates a user with a user name of tonysmith to the throttling policy ITStaffPolicy that has higher limits. - -### -------------------------- Example 2 -------------------------- -``` -$b = Get-ThrottlingPolicy ITStaffPolicy; -Set-Mailbox -Identity tonysmith -ThrottlingPolicy $b -``` - -You don't need to use the Set-ThrottlingPolicyAssociation cmdlet to associate a user with a policy. The following commands show another way to associate tonysmith to the throttling policy ITStaffPolicy. - -## PARAMETERS - -### -Identity -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 -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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available or functional only in Exchange Server 2010. - -The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the distinguished name (DN) for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottlingPolicy -The ThrottlingPolicy parameter specifies the throttling policy that you want to be associated with the object specified by the Identity parameter. - -```yaml -Type: ThrottlingPolicyIdParameter -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1d007408-e00d-48da-89aa-5994f490fbae.aspx) diff --git a/exchange/exchange-ps/exchange/server-health-and-performance/Test-ServiceHealth.md b/exchange/exchange-ps/exchange/server-health-and-performance/Test-ServiceHealth.md deleted file mode 100644 index 12aa72852b..0000000000 --- a/exchange/exchange-ps/exchange/server-health-and-performance/Test-ServiceHealth.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ServiceHealth -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Test-ServiceHealth - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Test-ServiceHealth cmdlet to test whether all the Microsoft Windows services that Exchange requires on a server have started. The Test-ServiceHealth cmdlet returns an error for any service required by a configured role when the service is set to start automatically and isn't currently running. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-ServiceHealth [[-Server] <ServerIdParameter>] [-ActiveDirectoryTimeout <Int32>] [-Confirm] - [-DomainController <Fqdn>] [-MonitoringContext <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-ServiceHealth -``` - -This example uses the Test-ServiceHealth command without parameters to test the services on the local server. - -## PARAMETERS - -### -ActiveDirectoryTimeout -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the server on which to check that the required services are running. If you don't specify this parameter, the command checks the services on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/73afc45e-e09b-4e27-b295-696894b53261.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md deleted file mode 100644 index 1d612d78c3..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-AvailabilityAddressSpace -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Add-AvailabilityAddressSpace cmdlet to create availability address space objects that are used to share free/busy data across Exchange organizations. - -The maximum number off Availability address spaces returned by Active Directory to Exchange is 100. We recommend using 100 or fewer address spaces in order for Availability lookups to work properly. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-AvailabilityAddressSpace -AccessMethod <PerUserFB | OrgWideFB | PublicFolder | InternalProxy> - -ForestName <String> [-Confirm] [-Credentials <PSCredential>] [-DomainController <Fqdn>] [-ProxyUrl <Uri>] - [-UseServiceAccount <$true | $false>] [-WhatIf] [-TargetAutodiscoverEpr <Uri>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-AvailabilityAddressSpace -ForestName example.contoso.com -AccessMethod OrgWideFB -Credentials (Get-Credential) -``` - -This example is useful with an untrusted cross-forest Availability service, or if detailed cross-forest free/busy service isn't desired. Enter a user name and password when you're prompted by the command. For an untrusted cross-forest configuration, make sure that the user doesn't have a mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Add-AvailabilityAddressSpace -ForestName example.contoso.com -AccessMethod PerUserFB -Credentials (Get-Credential) -``` - -This example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest, and the specified account connects to the contoso.com forest. The specified account must be an existing account in the contoso.com forest. - -### -------------------------- Example 3 -------------------------- -``` -Add-AvailabilityAddressSpace -ForestName example.contoso.com -AccessMethod PerUserFB -UseServiceAccount $true -``` - -This example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest and uses the service account (typically the local system account or the computer account) to connect to the contoso.com forest. Because the service is trusted, there is no issue with authorization when the current forest tries to retrieve free/busy information from contoso.com. - -## PARAMETERS - -### -AccessMethod -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: This value is reserved for internal Microsoft use. - -- InternalProxy: The request is proxied to an Exchange in the site that has a later version of Exchange. - -- PublicFolder: This value was used to access free/busy data on Exchange Server 2003 servers. - -```yaml -Type: PerUserFB | OrgWideFB | PublicFolder | InternalProxy -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForestName -The ForestName parameter specifies the SMTP domain name of the target forest for users whose free/busy data must be retrieved. If your users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Credentials -The Credentials parameter specifies the credentials for an account that has permission to access the Availability services in the target forest. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUrl -This parameter is available only in on-premises Exchange. - -The ProxyUrl parameter was used to specify the URL that directed an Exchange 2007 Client Access server to proxy its free/busy requests through an Exchange 2010 or Exchange 2013 Client Access server when requesting federated free/busy data for a user in another organization. When you used this parameter, you needed to set the value of the AccessMethod parameter to InternalProxy. - -This parameter required that you created the proper trust relationships and sharing relationships between the Exchange organizations. For more information, see 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseServiceAccount -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 - -- $true: The local Availability service account is used for authorization. - -- $false: The local Availability service account isn't used for authorization. You need to use the Credentials parameter. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAutodiscoverEpr -The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, https://contoso.com/autodiscover/autodiscover.xml. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/abbd48f3-adf6-40ed-9a52-36800d8429ef.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md deleted file mode 100644 index c4cd416705..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Add-PublicFolderAdministrativePermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Add-PublicFolderAdministrativePermission - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Add-PublicFolderAdministrativePermission cmdlet to add administrative permissions to a public folder or a public folder hierarchy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Add-PublicFolderAdministrativePermission [-Identity] <PublicFolderIdParameter> -AccessRights <MultiValuedProperty> -User <SecurityPrincipalIdParameter> - [-Confirm] [-Deny] - [-DomainController <Fqdn>] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Instance -``` -Add-PublicFolderAdministrativePermission -Instance <PublicFolderAdministrativeAceObject> - [-AccessRights <MultiValuedProperty>] - [-User <SecurityPrincipalIdParameter>] - [-Confirm] - [-Deny] - [-DomainController <Fqdn>] - [[-Identity] <PublicFolderIdParameter>] - [-InheritanceType <None | All | Descendents | SelfAndChildren | Children>] - [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -### Owner -``` -Add-PublicFolderAdministrativePermission [-Identity] <PublicFolderIdParameter> -Owner <SecurityPrincipalIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-PublicFolderAdministrativePermission -User Chris -Identity \MyPublicFolder -AccessRights ViewInformationStore -``` - -This example grants the user Chris the ViewInformationStore permission on the public folder MyPublicFolder. - -### -------------------------- Example 2 -------------------------- -``` -Add-PublicFolderAdministrativePermission -User Chris -Identity \MyPublicFolder -AccessRights ViewInformationStore -Deny -``` - -This example denies the user Chris the ViewInformationStore permission. - -## PARAMETERS - -### -AccessRights -The AccessRights parameter specifies the rights that are being added. Valid values include: - -- None The administrator has no rights to modify public folder attributes. - -- ModifyPublicFolderACL The administrator has the right to modify client access permissions for the specified folder. - -- ModifyPublicFolderAdminACL The administrator has the right to modify administrator permissions for the specified public folder. - -- ModifyPublicFolderDeletedItemRetention The administrator has the right to modify the Public Folder Deleted Item Retention attributes (RetainDeletedItemsFor and UseDatabaseRetentionDefaults). - -- ModifyPublicFolderExpiry The administrator has the right to modify the Public Folder Expiration attributes (AgeLimit and UseDatabaseAgeDefaults). - -- ModifyPublicFolderQuotas The administrator has the right to modify the Public Folder Quota attributes (MaxItemSize, PostQuota, PostWarningQuota, and UseDatabaseQuotaDefaults) - -- ModifyPublicFolderReplicaList The administrator has the right to modify the replica list attribute for the specified public folder (Replicas). - -- AdministerInformationStore The administrator has the right to modify all other public folder properties that aren't defined previously. - -- ViewInformationStore The administrator has the right to view public folder properties. - -- AllExtendedRights The administrator has the right to modify all public folder properties. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -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 -``` - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Identity, Owner -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Owner -The Owner parameter specifies the NT Owner access control list (ACL) on the object. Valid values are the user principal name (UPN), domain\\user, or alias. - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Owner -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the UPN, domain\\user, or alias of the user for whom rights are being added. - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Deny -The Deny switch specifies whether to deny the permission specified. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, Instance -Aliases: -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InheritanceType -The InheritanceType parameter specifies the type of inheritance. Valid values are: - -- None - -- All - -- Descendents - -- SelfAndChildren - -- Children - -```yaml -Type: None | All | Descendents | SelfAndChildren | Children -Parameter Sets: Identity, Instance -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifes the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/50f2ce6f-599d-43b9-83e6-447165385771.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md deleted file mode 100644 index ba621938ed..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-PublicFolderClientPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Add-PublicFolderClientPermission cmdlet to add permissions to public folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-PublicFolderClientPermission [-Identity] <PublicFolderIdParameter> -AccessRights <MultiValuedProperty> - -User <PublicFolderUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-PublicFolderClientPermission -Identity "\My Public Folder" -User Chris -AccessRights CreateItems -Server "My Server" -``` - -In Exchange 2010, this example adds permission for the user Chris to create items in the public folder My Public Folder on the server My Server. - -### -------------------------- Example 2 -------------------------- -``` -Add-PublicFolderClientPermission -Identity "\My Public Folder" -User Chris -AccessRights CreateItems -``` - -This example adds permission for the user Chris to create items in the public folder My Public Folder. - -## PARAMETERS - -### -AccessRights -The AccessRights parameter specifies the rights being added. This parameter accepts the following values: - -- ReadItems: The user has the right to read items within the specified public folder. - -- CreateItems: The user has the right to create items within the specified public folder. - -- EditOwnedItems: The user has the right to edit the items that the user owns in the specified public folder. - -- DeleteOwnedItems: The user has the right to delete items that the user owns in the specified public folder. - -- EditAllItems: The user has the right to edit all items in the specified public folder. - -- DeleteAllItems: The user has the right to delete all items in the specified public folder. - -- CreateSubfolders: The user has the right to create subfolders in the specified public folder. - -- FolderOwner: The user is the owner of the specified public folder. The user has the right to view and move the public folder and create subfolders. The user can't read items, edit items, delete items, or create items. - -- FolderContact: The user is the contact for the specified public folder. - -- FolderVisible: The user can view the specified public folder, but can't read or edit items within the specified public folder. - -In addition to access rights, you can create rights based upon roles, which includes multiple access rights. This parameter accepts the following values for roles: - -- None: FolderVisible - -- Owner: CreateItems, ReadItems, CreateSubfolders, FolderOwner, FolderContact, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems - -- PublishingEditor: CreateItems, ReadItems, CreateSubfolders, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems - -- Editor: CreateItems, ReadItems, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems - -- PublishingAuthor: CreateItems, ReadItems, CreateSubfolders, FolderVisible, EditOwnedItems, DeleteOwnedItems - -- Author: CreateItems, ReadItems, FolderVisible, EditOwnedItems, DeleteOwnedItems - -- NonEditingAuthor: CreateItems, ReadItems, FolderVisible - -- Reviewer: ReadItems, FolderVisible - -- Contributor: CreateItems, FolderVisible - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of the user for whom rights are being added. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available only in on-premises Exchange 2010. - -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifes the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d68ad7a9-daa0-4e6d-b819-5cca891c8fd9.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md deleted file mode 100644 index a313c5be56..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-MailPublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Disable-MailPublicFolder cmdlet to mail-disable a public folder. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-MailPublicFolder [-Identity] <PublicFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-MailPublicFolder -Identity "\Help Desk" -``` - -This example mail-disables the public folder Help Desk. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label Identity so that only the public folder name or GUID is supplied. - -```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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies the Mailbox server with the public folder database on which to perform the operation. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/92d6c890-a96a-469a-b864-99d9656b12e0.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md deleted file mode 100644 index 5b1fe82290..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-MailPublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Enable-MailPublicFolder cmdlet to mail-enable public folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-MailPublicFolder [-Identity] <PublicFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-HiddenFromAddressListsEnabled <$true | $false>] [-Server <ServerIdParameter>] [-WhatIf] - [-OverrideRecipientQuotas] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-MailPublicFolder "\My Public Folder" -``` - -This example mail-enables the top-level public folder My Public Folder. - -### -------------------------- Example 2 -------------------------- -``` -Enable-MailPublicFolder "\Marketing\Reports" -``` - -This example mail-enables the public folder Reports that's in the parent folder Marketing. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -HiddenFromAddressListsEnabled -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: $true | $false -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 -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies the identity of the server to perform the operation from. If a server isn't specified, the command checks whether the local server is a Mailbox server running with a public folder store. If it is, the folder is created locally. If it isn't, the command finds the closest (by site cost) Mailbox server that has a mounted public folder store. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -OverrideRecipientQuotas -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6fc7ba9a-62a8-4f41-811f-608363aa1397.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md deleted file mode 100644 index 491a186a6b..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AvailabilityAddressSpace -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-AvailabilityAddressSpace cmdlet to view existing availability address space objects that are used to share free/busy data across Exchange organizations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AvailabilityAddressSpace [[-Identity] <AvailabilityAddressSpaceIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AvailabilityAddressSpace -``` - -This example returns a summary list of all availability address space objects that are configured in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-AvailabilityAddressSpace -Identity Contoso.com | Format-List -``` - -This example returns details information for the availability address space object named Contoso.com. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the availability address space that you want to view. You can use any value that uniquely identifies the object. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: AvailabilityAddressSpaceIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/46777869-f5b1-4eee-8ce6-68c3a9002be4.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md deleted file mode 100644 index 53063f92aa..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AvailabilityConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-AvailabilityConfig cmdlet to retrieve the accounts that are trusted in the cross-forest exchange of free/busy information. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-AvailabilityConfig [[-Identity] <OrganizationIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AvailabilityConfig cmdlet lists the accounts that have permissions to issue proxy availability service requests on an organizational or per-user basis. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-AvailabilityConfig -``` - -This example retrieves the accounts that are trusted in the cross-forest exchange of free/busy information. - -### -------------------------- Example 2 -------------------------- -``` -Get-AvailabilityConfig -Identity <AvailabilityConfig Value> -``` - -This example retrieves the accounts that are trusted in the cross-forest exchange of free/busy information. This example is scoped to return only the results of the specified Identity parameter. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the availability configuration to be retrieved. - -```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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/c78ced9b-f202-4045-9a1a-916ca8d57738.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-MailPublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-MailPublicFolder.md deleted file mode 100644 index 6590cce4a8..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-MailPublicFolder.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailPublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders. If you want information about the basic (not mail-related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-MailPublicFolder [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-Server <ServerIdParameter>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-MailPublicFolder [[-Identity] <MailPublicFolderIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-Server <ServerIdParameter>] - [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailPublicFolder -ResultSize 100 | Format-List -``` - -This example returns the information for up to 100 mail-enabled public folders. In this example, the output of the Get-MailPublicFolder command is piped to the Format-List command so that all the available information is displayed in the result. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailPublicFolder -Identity \Marketing\Reports -``` - -This example returns information for the mail-enabled public folder Reports that resides in the Marketing top-level public folder. - -### -------------------------- Example 3 -------------------------- -``` -Get-MailPublicFolder -Anr Marketing* -``` - -This example returns all mail-enabled public folders that begin with the word Marketing by using the Anr parameter. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: MailPublicFolderIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies the identity of the server to perform the operation from. If a server isn't specified, the command checks whether the local server is a Mailbox server with a public folder store. If it is, the folder is created locally. If it isn't, the command finds the closest (by site cost) computer running Microsoft Exchange Server 2010 that has the Mailbox server role installed and that has a mounted public folder store. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -- Id - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/da05e6cb-8ab1-4ba9-ae42-d0f631daec85.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md deleted file mode 100644 index 13a9a47f1c..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OrganizationRelationship -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-OrganizationRelationship cmdlet to retrieve settings for an organization relationship that has been created for federated sharing with other federated Exchange organizations or for hybrid deployments with Exchange Online. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OrganizationRelationship [[-Identity] <OrganizationRelationshipIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OrganizationRelationship -Identity Contoso -``` - -This example retrieves the organization relationship settings for Contoso using the Identity parameter. - -### -------------------------- Example 2 -------------------------- -``` -Get-OrganizationRelationship -DomainController 'mail.contoso.com' -``` - -This example retrieves the organization relationship settings by using the FQDN of the domain controller. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the organizational relationship. You can use the following values: - -- Canonical name - -- GUID - -- Name - -```yaml -Type: OrganizationRelationshipIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b689bf46-437b-4ac4-89ce-dcffc3a388f5.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md deleted file mode 100644 index 560c522832..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Get-PublicFolderAdministrativePermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-PublicFolderAdministrativePermission - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-PublicFolderAdministrativePermission cmdlet to get the administrative permissions for a public folder or a public folder hierarchy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity (Default) -``` -Get-PublicFolderAdministrativePermission [-Identity] <PublicFolderIdParameter> [-User <SecurityPrincipalIdParameter>] - [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] [<CommonParameters>] -``` - -### Owner -``` -Get-PublicFolderAdministrativePermission [-Identity] <PublicFolderIdParameter> [-Owner] - [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderAdministrativePermission -Identity "\My Public Folder" -``` - -This example retrieves the administrative permissions for all users of the public folder My Public Folder. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderAdministrativePermission -Identity "\My Public Folder" -User Chris -Server "My Server" | Format-List -``` - -This example retrieves the administrative permissions for the public folder My Public Folder, for the user Chris, on the server My Server. In this example, the output of the Get-PublicFolderAdministrativePermission command is piped to the Format-List command so that all the available information is displayed in the result. - -### -------------------------- Example 3 -------------------------- -``` -Get-PublicFolderAdministrativePermission -Identity "\My Public Folder" -Owner -``` - -This example retrieves the owner of the public folder My Public Folder. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -The Owner parameter specifies that the command should return only the owner of the public folder. - -```yaml -Type: SwitchParameter -Parameter Sets: Owner -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the server on which to perform the selected operations. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of the user for whom administrative permissions are sought. - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e0d52900-ee08-4f7e-bb13-a0fabee1d26f.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md deleted file mode 100644 index 0bd552e7ad..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderClientPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-PublicFolderClientPermission cmdlet to retrieve the user permissions for a public folder. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PublicFolderClientPermission [-Identity] <PublicFolderIdParameter> [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] [-User <PublicFolderUserIdParameter>] [-Mailbox <MailboxIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderClientPermission "\My Public Folder" -``` - -This example retrieves the permissions for all users of \\My Public Folder. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderClientPermission -Identity "\My Public Folder" -User Chris | Format-List -``` - -This example retrieves the permissions for the public folder My Public Folder, for the user Chris. In this example, the output of the Get-PublicFolderClientPermission command is piped to the Format-List command so that all available information is displayed in the result. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies the server on which to perform the selected operations. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of a specific user for whom you want to view the permissions on the public folder. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the public folder mailbox for which you want to view the permissions. By default, the permissions are returned for the primary public folder mailbox. Using the Mailbox parameter allows you to specify a different public folder mailbox. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b991d477-e48c-4cf9-a4d0-6f1d5696991e.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md deleted file mode 100644 index 48febc9561..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-PublicFolderDatabase - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-PublicFolderDatabase cmdlet to view public folder database settings for Microsoft Exchange Server 2010 or earlier public folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Server -``` -Get-PublicFolderDatabase -Server <ServerIdParameter> - [-DomainController <Fqdn>] - [-IncludePreExchange2010] - [-Status] - [-IncludeCorrupted] [<CommonParameters>] -``` - -### Identity -``` -Get-PublicFolderDatabase [[-Identity] <DatabaseIdParameter>] - [-DomainController <Fqdn>] - [-IncludePreExchange2010] - [-Status] - [-IncludeCorrupted] [<CommonParameters>] -``` - -## DESCRIPTION -You can specify either the Server or Identity parameter, but not both. Only the Server and Identity parameters can be piped. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderDatabase | Format-List -``` - -This example returns all the attributes of all the public folder databases in the organization by piping the results of the Get-PublicFolderDatabase command to the Format-List command. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderDatabase -Identity "Server01\PFDatabase" -``` - -This example returns information about the public folder database PFDatabase that resides on Server01. - -### -------------------------- Example 3 -------------------------- -``` -Get-PublicFolderDatabase -Server Server01 -``` - -This example returns information about all public folders on Server01. - -## PARAMETERS - -### -Server -The Server parameter specifies the name of a server that contains a public folder database. If specified, only the public folder database on the specified server is returned. This parameter can't be used with the Identity parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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 -``` - -### -Identity -The Identity parameter specifies a public folder database. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Database name - -If you don't specify the server name, the cmdlet searches for databases on the local server. If you have multiple databases with the same name, the cmdlet retrieves all databases with the same name in the specified scope. This parameter can't be used with the Server parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludePreExchange2010 -This parameter is available or functional only in Exchange Server 2010. - -The IncludePreExchange2010 parameter specifies whether information about all the public folder databases in the organization is returned, including versions of Microsoft Exchange prior to Exchange Server 2010. If the IncludePreExchange2010 parameter is included in the command, information about all of the public folder databases in the organization is returned. This parameter isn't necessary when the Server or Identity parameter is included in the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -The Status parameter specifies whether additional backup and mount status information is included for servers running Exchange 2010. If the Status parameter is included, additional backup and mount status information is included for Exchange 2010 servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeCorrupted -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e2c9e769-ddfb-4981-906f-085834bc790f.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md deleted file mode 100644 index 3f5074df85..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderItemStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-PublicFolderItemStatistics cmdlet to view information about items within a specified public folder. Information returned includes subject, last modification time, last access time, creation time, attachments, message size, and the type of item. You can use this raw information to better understand the distribution of items and item characteristics across public folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PublicFolderItemStatistics [-Identity] <PublicFolderIdParameter> [-DomainController <Fqdn>] - [-Server <ServerIdParameter>] [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderItemStatistics -Identity "\Marketing\2013\Pamphlets" -``` - -This example returns default statistics for all items in the Pamphlets public folder under the \\Marketing\\2013 path. Default information includes item identity, creation time and subject. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderItemStatistics -Identity "\Marketing\2013\Pamphlets" | Format-List -``` - -This example returns additional information about the items within the public folder, such as subject, last modification time, creation time, attachments, message size and the type of item by piping the results of the Get-PublicFolderItemStatistics command to the Format-List command. - -### -------------------------- Example 3 -------------------------- -``` -Get-PublicFolderItemStatistics -Identity "\Marketing\Reports" | Select Subject,LastModificationTime,HasAttachments,ItemType,MessageSize | Export-CSV C:\PFItemStats.csv -``` - -This example exports the output of the Get-PublicFolderItemStatistics command to the PFItemStats.csv file that includes the following information for all items within the public folder \\Marketing\\Reports: - -- Subject of the message (Subject) - -- Date and time when the item was last modified (LastModificationTime) - -- If the item has attachments (HasAttachments) - -- Type of item (ItemType) - -- Size of the item (MessageSize) - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the 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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies the server on which to perform the selected operations. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b978c72d-6c0d-428f-a4ea-b17e39aef408.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md deleted file mode 100644 index 90de530758..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxDiagnostics -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-PublicFolderMailboxDiagnostics cmdlet to view event-level information about a public folder mailbox. This information can be used to troubleshoot public folder issues. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PublicFolderMailboxDiagnostics [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IncludeDumpsterInfo] [-IncludeHierarchyInfo] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderMailboxDiagnostics -Identity "Customer Escalations" -``` - -This example returns the diagnostic information for the public folder mailbox Customer Escalations. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolderMailboxDiagnostics -Identity "Sales Forecasts" | Export-CSV C:\Diagnostics\SalesForecasts.csv -``` - -This example returns the diagnostic information for the public folder mailbox Sales Forecasts and exports the report to a CSV file. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the public folder mailbox. The public folder mailbox is where the content of the public folder resides. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDumpsterInfo -The IncludeDumpsterInfo parameter specifies that diagnostic information for the \\NON\_IPM\_TREE\\DUMPSTER\_ROOT folder, which serves as the dumpster for public folder mailboxes, is included in the returned information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHierarchyInfo -The IncludeHierarchyInfo switch specifies whether to include folder hierarchy information in the results. This includes the following information: - -- TotalFolderCount: The total number of public folders in the specified public folder mailbox. - -- MaxFolderChildCount: The largest number of child folders in the public folder hierarchy. - -- HierarchyDepth: The depth of the public folder hierarchy. The root folder is 0. - -- CalendarFolderCount: The number of calendar public folders. - -- ContactFolderCount: The number of calendar public folders. - -- MailPublicFolderCount: The number of mail-enabled public folders. - -- NoteFolderCount: The number of note public folders. - -- StickyNoteFolderCount: The number of sticky note public folders. - -- TaskFolderCount: The number of task public folders. - -- OtherFolderCount: The number of public folders that don't match any of the previously defined public folder types. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e780d809-a408-4799-8175-46946835bee4.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md deleted file mode 100644 index de7ce305cd..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderStatistics -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-PublicFolderStatistics cmdlet to retrieve statistical information about public folders, such as folder size and last logon time. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-PublicFolderStatistics [[-Identity] <PublicFolderIdParameter>] [-DomainController <Fqdn>] - [-ResultSize <Unlimited>] [-Server <ServerIdParameter>] - [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-PublicFolderStatistics -Identity "\Marketing\2013\Pamphlets" | Format-List -``` - -This example retrieves statistics about the public folder Marketing\\2013\\Pamphlets. The output of the Get-PublicFolderStatistics command is piped to the Format-List command so that all the available information is displayed in the result. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies which server to check. If a server isn't specified, the command uses the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6b435b2e-749f-47fd-9a20-9a7edaed96fb.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SharingPolicy.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SharingPolicy.md deleted file mode 100644 index 45d881b5e7..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SharingPolicy.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SharingPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-SharingPolicy cmdlet to view existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SharingPolicy [[-Identity] <SharingPolicyIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing settings for the mailbox. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SharingPolicy -Identity FourthCoffee -``` - -This example retrieves the default information for the sharing policy FourthCoffee. - -### -------------------------- Example 2 -------------------------- -``` -Get-SharingPolicy Fabrikam | Format List -``` - -This example retrieves the full information for the sharing policy Fabrikam. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the sharing policy that you want to view. You can use one of the following values: - -- ADObjectID - -- Distinguished name (DN) - -- Legacy DN - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0ad91f5b-aaf4-4df0-90a1-a00ac83546ac.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailbox.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailbox.md deleted file mode 100644 index bf3a0ea341..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailbox.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SiteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-SiteMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SiteMailbox [[-Identity] <RecipientIdParameter>] [-Anr <String>] [-BypassOwnerCheck] [-DeletedSiteMailbox] - [-DomainController <Fqdn>] [-ReadFromDomainController] [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite -``` - -This example returns the default information about the site mailbox ContentSite, which includes the site name, when the site mailbox was closed, and the SharePoint URL. - -### -------------------------- Example 2 -------------------------- -``` -Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite | Format-List -``` - -This example returns the full information about the site mailbox ContentSite. - -### -------------------------- Example 3 -------------------------- -``` -Get-SiteMailbox -BypassOwnerCheck -DeletedSiteMailbox | Remove-Mailbox -Confirm:$false -``` - -This example queries for site mailboxes that are marked for deletion and removes them from the mailbox database by pipelining the Remove-Mailbox cmdlet. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassOwnerCheck -The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. - -If you run the command without this parameter, and you aren't a member or owner of the site mailbox, then the command will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeletedSiteMailbox -This parameter is available only in on-premises Exchange. - -The DeletedSiteMailboxswitch 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the site mailbox. You can use one of the following values: - -- GUID - -- Distinguished name (DN) - -- Display name - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/51d2ee4b-4065-4328-86fd-6ca3c9c6912e.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md deleted file mode 100644 index 485bb0993f..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SiteMailboxDiagnostics -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-SiteMailboxDiagnostics - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SiteMailboxDiagnostics [-Identity] <RecipientIdParameter> [-BypassOwnerCheck] [-Confirm] [-SendMeEmail] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SiteMailboxDiagnostics -BypassOwnerCheck -Identity "Marketing Events 2015" -``` - -This example returns the event information for the site mailbox by using its display name Marketing Events 2015. - -### -------------------------- Example 2 -------------------------- -``` -Get-SiteMailboxDiagnostics -BypassOwnerCheck -Identity events2015@contoso.com -SendMeEmail -``` - -This example returns the event information for the Marketing Events 2015 site mailbox and sends an email to the primary SMTP address of the user running this command. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the site mailbox. You can use the following values: - -- Alias - -- Display name - -- Domain\\Account - -- SMTP address - -- Distinguished name (DN) - -- Object GUID - -- User principal name (UPN) - -- LegacyExchangeDN - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassOwnerCheck -The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. - -If you run the command without this parameter and you aren't a member or owner of the site mailbox, then the command will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendMeEmail -The SendMeEmailswitch 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4d6c7fb2-8b5c-44c8-add2-f862240b9da0.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md deleted file mode 100644 index 67678af165..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SiteMailboxProvisioningPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-SiteMailboxProvisioningPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-SiteMailboxProvisioningPolicy cmdlet to view site mailbox provisioning policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SiteMailboxProvisioningPolicy [[-Identity] <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SiteMailboxProvisioningPolicy -``` - -This example returns a summary list of all site mailbox provisioning policies in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-SiteMailboxProvisioningPolicy -Identity SM_NewPolicy | Format-List -``` - -This example returns detailed information about the site mailbox provisioning policy named SM\_NewPolicy - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the site mailbox provisioning policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/159f050b-c015-4fc5-b6b0-2aceaecb71ac.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-AvailabilityConfig.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-AvailabilityConfig.md deleted file mode 100644 index d2a281ff49..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-AvailabilityConfig.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: New-AvailabilityConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-AvailabilityConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-AvailabilityConfig cmdlet to create an availability configuration. An availability configuration specifies an existing account that's used to exchange free/busy information between organizations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-AvailabilityConfig -OrgWideAccount <SecurityPrincipalIdParameter> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-AvailabilityConfig -OrgWideAccount "Tony Smith" -``` - -This example creates a new availability configuration. The existing account named Tony Smith will be used to exchange free/busy information between organizations. - -## PARAMETERS - -### -OrgWideAccount -The OrgWideAccount parameter specifies an account or security group that has permission to issue proxy Availability service requests on an organization-wide basis. - -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/67feaf57-e066-4f4b-867c-5d02323d61f0.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-OrganizationRelationship.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-OrganizationRelationship.md deleted file mode 100644 index 53fc4b5013..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-OrganizationRelationship.md +++ /dev/null @@ -1,518 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OrganizationRelationship -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-OrganizationRelationship cmdlet to create organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-OrganizationRelationship [-Name] <String> -DomainNames <MultiValuedProperty> - [-ArchiveAccessEnabled <$true | $false>] [-Confirm] [-DeliveryReportEnabled <$true | $false>] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-FreeBusyAccessEnabled <$true | $false>] - [-FreeBusyAccessLevel <None | AvailabilityOnly | LimitedDetails>] [-FreeBusyAccessScope <GroupIdParameter>] - [-MailboxMoveEnabled <$true | $false>] [-MailTipsAccessEnabled <$true | $false>] - [-MailTipsAccessLevel <None | Limited | All>] [-MailTipsAccessScope <GroupIdParameter>] - [-OrganizationContact <SmtpAddress>] [-TargetApplicationUri <Uri>] - [-TargetAutodiscoverEpr <Uri>] [-TargetOwaURL <Uri>] [-TargetSharingEpr <Uri>] [-WhatIf] - [-PhotosEnabled <$true | $false>] [-MailboxMoveDirection <None | Inbound | Outbound>] [<CommonParameters>] -``` - -## DESCRIPTION -Before you can create an organization relationship, you must first create a federation trust. For more information, see Federation (https://technet.microsoft.com/library/dd335047.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-FederationInformation -DomainName Contoso.com | New-OrganizationRelationship -Name "Contoso" -FreeBusyAccessEnabled $true -FreeBusyAccessLevel LimitedDetails -``` - -This example creates an organization relationship with Contoso. The domain name to connect to is contoso.com. The following settings are used: - -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. - -### -------------------------- Example 2 -------------------------- -``` -New-OrganizationRelationship -Name "Fourth Coffee" -DomainNames "mail.fourthcoffee.com" -FreeBusyAccessEnabled $true -FreeBusyAccessLevel AvailabilityOnly -TargetAutodiscoverEpr "https://mail.fourthcoffee.com/autodiscover/autodiscover.svc/wssecurity" -TargetApplicationUri "mail.fourthcoffee.com" -``` - -This example creates the organization relationship with Fourth Coffee using the following settings. In this example, the connection settings with the external organization are provided. - -The domain to connect to is mail.fourthcoffee.com. - -The Exchange Web Services application URL is mail.fourthcoffee.com. - -The Autodiscover URL is https://mail.fourthcoffee.com/autodiscover/autodiscover.svc/wssecurity. - -Free/busy access is enabled. - -The requesting organization only receives free/busy information with the time. - -## PARAMETERS - -### -Name -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 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNames -This parameter is available only in on-premises Exchange. - -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 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ArchiveAccessEnabled -The ArchiveAccessEnabled parameter specifies whether the organization relationship has been 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. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliveryReportEnabled -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 - -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. - -```yaml -Type: $true | $false -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether to enable the organization relationship. Valid values are: - -- $true: The organization relationship is enabled. This is the default value. - -- $false: The organization relationship is disabled. This value completely stops sharing for the organization relationship. - -```yaml -Type: $true | $false -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 -``` - -### -FreeBusyAccessEnabled -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. - -You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters. - -```yaml -Type: $true | $false -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 -``` - -### -FreeBusyAccessLevel -The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: - -- None: No free/busy access. - -- AvailabilityOnly: Free/busy access with time only. - -- LimitedDetails: Free/busy access with time, subject, and location. - -This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. - -```yaml -Type: None | AvailabilityOnly | LimitedDetails -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 -``` - -### -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: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. - -```yaml -Type: GroupIdParameter -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 -``` - -### -MailboxMoveEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsAccessEnabled -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. - -You control the MailTips access level by using the MailTipsAccessLevel parameter. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsAccessLevel -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. - -This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true. - -```yaml -Type: None | Limited | All -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 -``` - -### -MailTipsAccessScope -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -The default value is blank ($null), which means no group is specified. - -If you use this parameter, recipient-specific MailTips are returned only for those recipients that are members of the specified group. The recipient-specific MailTips are: - -- Auto Reply - -- Mailbox Full - -- Custom - -If you don't use this parameter, recipient-specific MailTips are returned for all recipients in the organization. - -This restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups. - -```yaml -Type: GroupIdParameter -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 -``` - -### -OrganizationContact -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetApplicationUri -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetAutodiscoverEpr -The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, https://contoso.com/autodiscover/autodiscover.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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetOwaURL -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetSharingEpr -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. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhotosEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxMoveDirection -This parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Inbound | Outbound -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ec35c7ed-6f91-435e-8c9f-9dbc53c993fe.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolder.md deleted file mode 100644 index 8885486f06..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolder.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-PublicFolder cmdlet to create a public folder with the specified name. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PublicFolder [-Name] <String> [-Confirm] [-DomainController <Fqdn>] [-EformsLocaleId <CultureInfo>] - [-Path <PublicFolderIdParameter>] [-Server <ServerIdParameter>] - [-WhatIf] [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PublicFolder -Name Marketing -``` - -This example creates the public folder Marketing in the root of the public folder. - -### -------------------------- Example 2 -------------------------- -``` -New-PublicFolder -Name FY2010 -Path \Legal\Cases -Server MBXSVR01 -``` - -In Exchange Server 2010, this example creates the public folder FY2010 under the existing folders \\Legal\\Cases. The path to the new folder is \\Legal\\Cases\\FY2010 on the server MBXSVR01. - -### -------------------------- Example 3 -------------------------- -``` -New-PublicFolder -Name FY2013 -Path \Legal\Cases -``` - -This example creates the public folder FY2013 under the existing folders \\Legal\\Cases. The path to the new folder is \\Legal\\Cases\\FY2013. - -### -------------------------- Example 4 -------------------------- -``` -New-PublicFolder -Name Support -Mailbox North_America -``` - -This example creates the public folder Support in the North\_America hierarchy public folder mailbox. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EformsLocaleId -The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameterspecifies the server on which to create the public folder. - -If a server isn't specified, the command checks whether the local server is running Microsoft Exchange Server 2010 or Exchange Server 2007 with the Mailbox server role installed and with a public folder database. If it is, the public folder is created locally. If it isn't, Exchange finds the closest (by site cost) Exchange 2010 or Exchange 2007 Mailbox server with a public folder database on which to create the public folder. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -Mailbox -The Mailbox parameter specifies the identity of the hierarchy public folder mailbox in which you want this public folder created. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SMTP address - -- Alias - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/18b837bf-9ef7-4edf-8728-7f6bd346e75d.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md deleted file mode 100644 index 851ca4f8d8..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: New-PublicFolderDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# New-PublicFolderDatabase - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the New-PublicFolderDatabase cmdlet to create a public folder database. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PublicFolderDatabase [-Name] <String> -Server <ServerIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-EdbFilePath <EdbFilePath>] [-LogFolderPath <NonRootLocalLongFullPath>] - [-Organization <OrganizationIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The new database must be mounted after it's created. For more information about mounting databases, see Mount a 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PublicFolderDatabase -Name "My Public Folder Database" -EdbFilePath "C:\Program Files\Microsoft\Exchange Server\V14\Mailbox\PFDB01.edb" -LogFolderPath "C:\Program Files\Microsoft\Exchange Server\V14\Mailbox\PFDB01" -``` - -This example creates the public folder database PFDB01. - -## PARAMETERS - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the server that you want to create the database on. - -A server can have only one public folder database. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EdbFilePath -The EdbFilePath parameter specifies the full path of the public folder database files. - -```yaml -Type: EdbFilePath -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogFolderPath -The LogFolderPath parameter specifies the folder location for log files. The default path is \<ExchangeInstallPath\>V14\\Mailbox. - -```yaml -Type: NonRootLocalLongFullPath -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -The Organization parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88e7257d-d219-44e6-a23e-ba78c84545ac.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md deleted file mode 100644 index 7991ef44a2..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010 -title: New-PublicFolderDatabaseRepairRequest -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# New-PublicFolderDatabaseRepairRequest - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the New-PublicFolderDatabaseRepairRequest cmdlet to detect and fix replication issues in the public folder database. Public folders on the public folder database can still be accessed while the request is running. However, access isn't available to the public folder currently being repaired. - -After you begin the repair request, it can't be stopped unless you dismount the database. For more information, see Dismount a Database. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-PublicFolderDatabaseRepairRequest [-Database] <DatabaseIdParameter> - -CorruptionType <PublicFolderDatabaseCorruptionType[]> [-Confirm] [-DetectOnly] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-PublicFolderDatabaseRepairRequest -Database PFDB01 -CorruptionType ReplState -``` - -This example detects and repairs replication issues in the public folder database PFDB01. - -### -------------------------- Example 2 -------------------------- -``` -New-PublicFolderDatabaseRepairRequest -Database PFDB02 -CorruptionType ReplState -DetectOnly -``` - -This example only detects and reports on replication issues on public folder database PFDB02. - -## PARAMETERS - -### -CorruptionType -The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: - -ReplState - -```yaml -Type: PublicFolderDatabaseCorruptionType[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -The Database parameter specifies the database on which you want to run this command. You can use the following values: - -- GUID of the database - -- Database name - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -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 Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetectOnly -The DetectOnly parameter specifies that you want this command to report errors, but not fix them. You don't have to specify a value with this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9ad7ebc3-4a12-4af7-bbdf-ae1a6c2a7a84.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SharingPolicy.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SharingPolicy.md deleted file mode 100644 index 2b91eac0a5..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SharingPolicy.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SharingPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SharingPolicy [-Name] <String> -Domains <MultiValuedProperty> [-Confirm] [-Default] - [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SharingPolicy -Name "Contoso" -Domains 'mail.contoso.com: CalendarSharingFreeBusyDetail, ContactsSharing' -``` - -This example creates the sharing policy Contoso for the contoso.com domain, which is a domain outside the organization. This policy allows users in the contoso.com domain to see detailed free/busy information and contacts. By default, this policy is enabled. - -### -------------------------- Example 2 -------------------------- -``` -New-SharingPolicy -Name "SharingPolicy01" -Domains 'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusySimple' -Enabled $false -Default $true -``` - -This example creates a default sharing policy, which is applied to all mailboxes that don't implicitly have a sharing policy assigned to them. This sharing policy SharingPolicy01 applies to two different domains, and the sharing policy is disabled. - -## PARAMETERS - -### -Domains -The Domains parameter specifies the domains to which this sharing policy applies and the sharing policy actions. Values for this parameter take the format: 'Domain: SharingPolicyAction'. - -The following sharing policy action values can be used: - -- CalendarSharingFreeBusySimple: Share free/busy hours only - -- CalendarSharingFreeBusyDetail: Share free/busy hours, subject and location - -- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location and the body of the message or calendar item - -- ContactsSharing: Share contacts only - -Separate multiple domains with a comma, for example, 'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'. - -A domain doesn't include subdomains. You must configure each subdomain separately. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the new sharing policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -The Default switch specifies that this sharing policy is the default sharing policy for all mailboxes. If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy as disabled. - -You don't have 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ffca8853-3429-448f-ad5e-5435dc44f9d0.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md deleted file mode 100644 index 15a282e889..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md +++ /dev/null @@ -1,845 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SyncMailPublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# 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. - -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 Azure Active Directory in Office 365 (the scripts synchronize mail-enabled public folder objects from the source on-premises Exchange organization to Office 365). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-SyncMailPublicFolder [-Alias] <String> [-Name] <String> -EntryId <String> [-Confirm] - [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddress[]>] [-ExternalEmailAddress <SmtpAddress>] - [-HiddenFromAddressListsEnabled] [-OverrideRecipientQuotas] [-WhatIf] [-WindowsEmailAddress <SmtpAddress>] - [-AcceptMessagesOnlyFrom <DeliveryRecipientIdParameter[]>] [-Contacts <RecipientIdParameter[]>] - [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] - [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] - [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <RecipientIdParameter[]>] - [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-OnPremisesObjectId <Guid>] - [-RejectMessagesFrom <DeliveryRecipientIdParameter[]>] [-RequireSenderAuthenticationEnabled <$true | $false>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-SyncMailPublicFolder -``` - -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. - -## PARAMETERS - -### -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 value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EntryId -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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -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 -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To enter multiple proxy email addresses, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -```yaml -Type: ProxyAddress[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideRecipientQuotas -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders, use the following syntax: \<sender1\>,\<sender2\>,...\<senderX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderX\>". - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```yaml -Type: DeliveryRecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Contacts -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliverToMailboxAndForward -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. - -The default value is $false. This parameter is meaningful only if you configure a forwarding recipient by using the ForwardingAddress parameter. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingAddress -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. - -- DeliverToMailboxAndForward is $true: Messages are delivered to this mail-enabled public folder and forwarded to the specified recipient. - -- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified recipient. Messages aren't delivered to this mail-enabled public folder. - -The default value is blank ($null), which means no forwarding recipient is configured. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<PublicFolder\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -By default, this parameter is blank, which means no one else has permission to send on behalf of this public folder. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReceiveSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSendSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnPremisesObjectId -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 Office 365. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders, use the following syntax: \<sender1\>,\<sender2\>,...\<senderX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderX\>". - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```yaml -Type: DeliveryRecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/93c537dd-5769-4307-abe1-aab2c71f7397.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md deleted file mode 100644 index 7a6ac9247c..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: Remove-AvailabilityConfig -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-AvailabilityConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-AvailabilityConfig cmdlet to remove an availability configuration. An availability configuration specifies an existing account that's used to exchange free/busy information between organizations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-AvailabilityConfig [[-Identity] <AvailabilityConfigIdParameter>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-AvailabilityConfig -``` - -This example removes the existing availability configuration. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the availability configuration that you want to remove. The default name of the availability configuration you create by using the New-AvailabilityConfig is Availability Configuration. - -```yaml -Type: AvailabilityConfigIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/77b521f2-384b-42e0-8839-78ed921a0810.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md deleted file mode 100644 index c04ed12077..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OrganizationRelationship -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-OrganizationRelationship cmdlet to remove the organization relationship with an external Exchange organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-OrganizationRelationship [-Identity] <OrganizationRelationshipIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-OrganizationRelationship cmdlet removes the organization relationship objects. To stop sharing information without removing the organization relationship objects, disable the organization relationship by using the Set-OrganizationRelationship 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-OrganizationRelationship -Identity Contoso -``` - -This example removes the organization relationship Contoso using the Identity parameter. - -## PARAMETERS - -### -Identity -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 - -- GUID - -- Name - -```yaml -Type: OrganizationRelationshipIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fd646344-c783-45b2-b666-f50e823cba58.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolder.md deleted file mode 100644 index 2bab91a7eb..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolder.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-PublicFolder cmdlet to remove an existing public folder. - -The Remove-PublicFolder cmdlet removes the public folder data from all servers in your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-PublicFolder [-Identity] <PublicFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Recurse] - [-Server <ServerIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PublicFolder -Identity "\Test\Directory\My Public Folder" -``` - -This example deletes the public folder My Public Folder from the \\Test\\Directory tree. - -### -------------------------- Example 2 -------------------------- -``` -Remove-PublicFolder -Identity "\Test\Directory Folder" -Recurse -``` - -This example deletes the public folder Directory Folder and all its child public folders by using the Recurse switch. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the name and path of the public folder you want to remove. A valid value uses the syntax: \\\<Level1\>\\\<Level2\>\\...\\\<LevelN\>\\\<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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -Recurse -The Recurse switch specifies whether all subfolders of the specified folder should be removed. If the Recurse switch isn't specified and the public folder has subfolders, the command doesn't run and an error message is returned. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional only in Exchange Server 2010. - -The Server parameter specifies the identity of the server from which to remove the public folder. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dda460e0-2601-49ae-a43f-c75c69719196.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md deleted file mode 100644 index 862a121ccf..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderClientPermission -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-PublicFolderClientPermission cmdlet to remove permissions from public folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-PublicFolderClientPermission [-Identity] <PublicFolderIdParameter> -AccessRights <MultiValuedProperty> - -User <PublicFolderUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Server <ServerIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PublicFolderClientPermission -Identity \"My Public Folder" -User Chris -AccessRights CreateItems -Server "My Server" -``` - -In Exchange Server 2010, this example removes permission for the user Chris to create items in the public folder My Public Folder on the server My Server. - -### -------------------------- Example 2 -------------------------- -``` -Remove-PublicFolderClientPermission -Identity "\My Public Folder" -User Contoso\Chris -``` - -This example removes permission for the user Chris to the public folder My Public Folder. - -## PARAMETERS - -### -AccessRights -This parameter is available or functional only in Exchange Server 2010. - -The AccessRights parameter specifies the rights being removed. This parameter accepts the following values: - -- ReadItems: The user has the right to read items within the specified public folder. - -- CreateItems: The user has the right to create items within the specified public folder. - -- EditOwnedItems: The user has the right to edit the items that the user owns in the specified public folder. - -- DeleteOwnedItems: The user has the right to delete items that the user owns in the specified public folder. - -- EditAllItems: The user has the right to edit all items in the specified public folder. - -- DeleteAllItems: The user has the right to delete all items in the specified public folder. - -- CreateSubfolders: The user has the right to create subfolders in the specified public folder. - -- FolderOwner: The user is the owner of the specified public folder. The user has the right to view and move the public folder and create subfolders. The user can't read items, edit items, delete items, or create items. - -- FolderContact: The user is the contact for the specified public folder. - -- FolderVisible: The user can view the specified public folder, but can't read or edit items within the specified public folder. - -In addition to the access rights, you can create rights based upon roles, which includes multiple access rights. This parameter accepts the following values for roles: - -- None: FolderVisible - -- Owner: CreateItems, ReadItems, CreateSubfolders, FolderOwner, FolderContact, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems - -- PublishingEditor: CreateItems, ReadItems, CreateSubfolders, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems - -- Editor: CreateItems, ReadItems, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems - -- PublishingAuthor: CreateItems, ReadItems, CreateSubfolders, FolderVisible, EditOwnedItems, DeleteOwnedItems - -- Author: CreateItems, ReadItems, FolderVisible, EditOwnedItems, DeleteOwnedItems - -- NonEditingAuthor: CreateItems, ReadItems, FolderVisible - -- Reviewer: ReadItems, FolderVisible - -- Contributor: CreateItems, FolderVisible - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path by 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: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of the user whose permissions are being removed. - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available or functional 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 identifes the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cc35b182-d90d-4f0a-9e4c-cd97bd81b4f3.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md deleted file mode 100644 index 536f438a39..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Remove-PublicFolderDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Remove-PublicFolderDatabase - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Remove-PublicFolderDatabase cmdlet to delete public folder databases. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-PublicFolderDatabase [-Identity] <DatabaseIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-RemoveLastAllowed] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -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. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-PublicFolderDatabase "Public Folder Database" -``` - -This example removes the database Public Folder Database after all the prerequisites for removing the database have been satisfied. - -## PARAMETERS - -### -Identity -The Identity parameter specifies a public folder database. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Database name - -If you don't specify the server name, the command searches for databases on the local server. If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -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 Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveLastAllowed -The RemoveLastAllowed parameter specifies whether to enable removal of the last public folder database in the organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/11289582-170b-445e-94a4-8f73df6ccb13.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md deleted file mode 100644 index b3add09904..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SiteMailboxProvisioningPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Remove-SiteMailboxProvisioningPolicy - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Remove-SiteMailboxProvisioningPolicy cmdlet to remove site mailbox provisioning policies. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SiteMailboxProvisioningPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SiteMailboxProvisioningPolicy -Identity Default -``` - -This example deletes the site mailbox policy named Default that was created when you installed Microsoft Exchange. This example assumes that you have already designated another policy as the default. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- GUID - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8430cadd-def3-408b-ab1c-c3d8a10f64f7.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md deleted file mode 100644 index 93c68e7e88..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2016, Exchange Server 2019 -title: Remove-SyncMailPublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2016 || exchserver-ps-2019" ---- - -# 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. - -The Remove-SyncMailPublicFolder cmdlet is used by the Sync-MailPublicFolders.ps1 script to remove mail-enabled public folder recipient objects from Azure Active Directory in Office 365 (the script synchronizes mail-enabled public folder objects from the source on-premises Exchange organization to Office 365). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-SyncMailPublicFolder [-Identity] <MailPublicFolderIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-SyncMailPublicFolder -``` - -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. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mail-enabled public folder object that you want to remove from Azure Active Directory in Office 365. - -For example: - -- Name - -- Distinguished name (DN) - -- GUID - -- Path: (\\\<TopLevelPublicFolderName\>\\\<PublicFolderName\> - -```yaml -Type: MailPublicFolderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -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 Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/76e31311-9aed-4734-9179-80c6f7959e6d.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md deleted file mode 100644 index 72af7404e2..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Resume-PublicFolderReplication -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Resume-PublicFolderReplication - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Resume-PublicFolderReplication cmdlet to resume public folder content replication when it's been stopped. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Resume-PublicFolderReplication [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Resume-PublicFolderReplication -``` - -This example resumes content replication for the entire organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e98b5421-ba21-44f9-990b-992afa7c5b29.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md deleted file mode 100644 index f7e9e4e872..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AvailabilityConfig -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-AvailabilityConfig cmdlet to set the access level for free/busy information. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-AvailabilityConfig [-Confirm] [-DomainController <Fqdn>] [-OrgWideAccount <SecurityPrincipalIdParameter>] - [-PerUserAccount <SecurityPrincipalIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AvailabilityConfig cmdlet defines two accounts or security groups: a per-user free/busy proxy account or group, and an organization-wide free/busy proxy account or group. These accounts and groups are trusted by all availability services in the current organization for availability proxy requests. - -For cross-forest availability services to retrieve free/busy information in the current forest, they must be using one of the specified accounts, belong to one of the specified security groups, or have a user name and password for one of the specified accounts or security groups. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-AvailabilityConfig -PerUserAccount <> -``` - -This example is useful with a trusted cross-forest Availability service. If the remote forest is trusted, and a per-user free/busy proxy account or group in the remote forest is configured to use the service account, the configuration is added to the current forest to authorize the Microsoft ActiveSync request from the remote forest. - -### -------------------------- Example 2 -------------------------- -``` -Set-AvailabilityConfig -OrgWideAccount <ExampleCredentials> -``` - -This example is useful if the remote forest isn't trusted. Because this account is used for a cross-forest free/busy proxy account or group, minimize security vulnerabilities by using the credentials of a user who doesn't have an Exchange mailbox. When you're prompted, type the user name and password. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrgWideAccount -The OrgWideAccount parameter specifies an account or security group that has permission to issue proxy Availability service requests on an organization-wide basis. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerUserAccount -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. - -```yaml -Type: SecurityPrincipalIdParameter -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/aa3c55f3-d29a-443e-b248-e1779516dfe1.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-MailPublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-MailPublicFolder.md deleted file mode 100644 index 1dbb01d9b8..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-MailPublicFolder.md +++ /dev/null @@ -1,1472 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailPublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -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. - -NOTE: The settings that you configure on a public folder mailbox might interfere with the existing settings on a public folder within in the mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailPublicFolder [-Identity] <MailPublicFolderIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-Confirm] [-Contacts <RecipientIdParameter[]>] [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-DeliverToMailboxAndForward <$true | $false>] - [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] - [-EmailAddressPolicyEnabled <$true | $false>] [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope] [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] - [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] - [-PhoneticDisplayName <String>] [-PrimarySmtpAddress <SmtpAddress>] - [-PublicFolderType <GeneralPurpose | Mapi | Nntp | NotSpecified>] [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-SendModerationNotifications <Never | Internal | Always>] [-Server <ServerIdParameter>] - [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [-EntryId <String>] [-ExternalEmailAddress <ProxyAddress>] - [-ExternalDirectoryObjectId <Guid>] [-IgnoreMissingFolderLink <$true | $false>] [-OnPremisesObjectId <Guid>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailPublicFolder -Identity MyPublicFolder@contoso.com -PrimarySmtpAddress MyPublicFolder@fabrikam.com -``` - -This example sets the primary SMTP address of the mail-enabled public folder MyPublicFolder@contoso.com to MyPublicFolder@fabrikam.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. - -You can omit the parameter label so that only the public folder name or GUID is supplied. - -```yaml -Type: MailPublicFolderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -This parameter is available or functional only in Exchange Server 2010. - -The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -Contacts -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. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDTMFMap -The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliverToMailboxAndForward -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. - -- $false: If a forwarding recipient or email address is configured, messages are delivered only to the specified recipient or email address, and messages aren't delivered to this public folder. If no forwarding recipient or email address is configured, messages are delivered only to this public folder. - -The default value is $false. The value of this parameter is meaningful only if you configure a forwarding recipient or email address. - -```yaml -Type: $true | $false -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 -``` - -### -DisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -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 -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingAddress -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. - -- DeliverToMailboxAndForward is $true: Messages are delivered to this public folder and forwarded to the specified recipient. - -- DeliverToMailboxAndForward is $false: Messages are only forwarded to the specified recipient. Messages aren't delivered to this public folder. - -The default value is blank ($null), which means no forwarding recipient is configured. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<Public folder\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this public folder. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReceiveSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum receive size for the public folder is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSendSize -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: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum send size for the public folder is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneticDisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolderType -The PublicFolderType parameter specifies which of the following four types is assigned to the public folder: - -- GeneralPurpose - -- Mapi - -- Nntp - -- NotSpecified - -```yaml -Type: GeneralPurpose | Mapi | Nntp | NotSpecified -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -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 -``` - -### -Server -The Server parameter specifies the identity of the server to perform the operation from. If a server isn't specified, the command checks if the local server is a Mailbox server that is running Microsoft Exchange Server 2010 with a public folder database. If it is, the folder is created locally. If it isn't, the command finds the closest (by site cost) Exchange 2010 Mailbox server that has a mounted public folder database. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDtmfMap -The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WindowsEmailAddress -The WindowsEmailAddress parameter specifies an email address in the format EmailAddress@contoso.com. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreMissingFolderLink -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnPremisesObjectId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types (also known as "output types") that this cmdlet accepts, see Cmdlet Input and 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 - -[Online Version](https://technet.microsoft.com/library/8db48034-24cd-43d8-9133-1c8226616be5.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md deleted file mode 100644 index f196d87232..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md +++ /dev/null @@ -1,535 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OrganizationRelationship -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-OrganizationRelationship cmdlet to modify existing organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-OrganizationRelationship [-Identity] <OrganizationRelationshipIdParameter> - [-ArchiveAccessEnabled <$true | $false>] [-Confirm] [-DeliveryReportEnabled <$true | $false>] - [-DomainController <Fqdn>] [-DomainNames <MultiValuedProperty>] [-Enabled <$true | $false>] [-Force] - [-FreeBusyAccessEnabled <$true | $false>] [-FreeBusyAccessLevel <None | AvailabilityOnly | LimitedDetails>] - [-FreeBusyAccessScope <GroupIdParameter>] [-MailboxMoveEnabled <$true | $false>] - [-MailTipsAccessEnabled <$true | $false>] [-MailTipsAccessLevel <None | Limited | All>] - [-MailTipsAccessScope <GroupIdParameter>] [-Name <String>] [-OrganizationContact <SmtpAddress>] - [-TargetApplicationUri <Uri>] [-TargetAutodiscoverEpr <Uri>] [-TargetOwaURL <Uri>] [-TargetSharingEpr <Uri>] - [-WhatIf] [-PhotosEnabled <$true | $false>] [-MailboxMoveDirection <None | Inbound | Outbound>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-OrganizationRelationship -Identity "Fourth Coffee" -FreeBusyAccessLevel LimitedDetails -``` - -This example modifies the free/busy access level to LimitedDetails, which includes time, subject, and location. - -### -------------------------- Example 2 -------------------------- -``` -Set-OrganizationRelationship -Identity "Contoso" -Enabled $false -``` - -This example disables the organization relationship with Contoso - -## PARAMETERS - -### -Identity -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 - -- Canonical name - -- GUID - -```yaml -Type: OrganizationRelationshipIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ArchiveAccessEnabled -The ArchiveAccessEnabled parameter specifies whether the organization relationship has been 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 - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliveryReportEnabled -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 - -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. - -```yaml -Type: $true | $false -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNames -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Enabled -The Enabled parameter specifies whether to enable the organization relationship. Valid values are: - -- $true: The organization relationship is enabled. This is the default value. - -- $false: The organization relationship is disabled. This value completely stops sharing for the organization relationship. - -```yaml -Type: $true | $false -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 -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -FreeBusyAccessEnabled -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. - -You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters. - -```yaml -Type: $true | $false -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 -``` - -### -FreeBusyAccessLevel -The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: - -- None: No free/busy access. - -- AvailabilityOnly: Free/busy access with time only. - -- LimitedDetails: Free/busy access with time, subject, and location. - -This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. - -```yaml -Type: None | AvailabilityOnly | LimitedDetails -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 -``` - -### -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: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true. - -```yaml -Type: GroupIdParameter -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 -``` - -### -MailboxMoveEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsAccessEnabled -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. - -You control the MailTips access level by using the MailTipsAccessLevel parameter. - -```yaml -Type: $true | $false -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 -``` - -### -MailTipsAccessLevel -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. - -This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true. - -```yaml -Type: None | Limited | All -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 -``` - -### -MailTipsAccessScope -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -The default value is blank ($null), which means no group is specified. - -If you use this parameter, recipient-specific MailTips are returned only for those recipients that are members of the specified group. The recipient-specific MailTips are: - -- Auto Reply - -- Mailbox Full - -- Custom - -If you don't use this parameter, recipient-specific MailTips are returned for all recipients in the organization. - -This restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups. - -```yaml -Type: GroupIdParameter -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 -``` - -### -Name -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationContact -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetApplicationUri -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetAutodiscoverEpr -The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, https://contoso.com/autodiscover/autodiscover.svc/wssecurity. Exchange uses Autodiscover to automatically detect the correct Exchangeserver 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetOwaURL -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TargetSharingEpr -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. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhotosEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxMoveDirection -This parameter is reserved for internal Microsoft use. - -```yaml -Type: None | Inbound | Outbound -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4e3b9d1d-cf41-4fd0-97e3-a0bbc816cf87.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md deleted file mode 100644 index 1d2bd450fc..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md +++ /dev/null @@ -1,439 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Set-PublicFolderDatabase -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Set-PublicFolderDatabase - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Set-PublicFolderDatabase cmdlet to set attributes of public folder databases. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-PublicFolderDatabase [-Identity] <DatabaseIdParameter> [-AllowFileRestore <$true | $false>] - [-BackgroundDatabaseMaintenance <$true | $false>] [-CircularLoggingEnabled <$true | $false>] [-Confirm] - [-CustomReferralServerList <MultiValuedProperty>] [-DeletedItemRetention <EnhancedTimeSpan>] - [-DomainController <Fqdn>] [-EventHistoryRetentionPeriod <EnhancedTimeSpan>] [-IssueWarningQuota <Unlimited>] - [-ItemRetentionPeriod <Unlimited>] [-MaintenanceSchedule <Schedule>] [-MaxItemSize <Unlimited>] - [-MountAtStartup <$true | $false>] [-Name <String>] [-ProhibitPostQuota <Unlimited>] - [-QuotaNotificationSchedule <Schedule>] [-ReplicationMessageSize <ByteQuantifiedSize>] - [-ReplicationPeriod <UInt32>] [-ReplicationSchedule <Schedule>] - [-RetainDeletedItemsUntilBackup <$true | $false>] [-UseCustomReferralServerList <$true | $false>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-PublicFolderDatabase -Identity 'PFDB01' -DeletedItemRetention '10.00:00:00' -``` - -This example sets the deleted items retention on the public folder database PFDB01 to 10 days. - -### -------------------------- Example 2 -------------------------- -``` -Set-PublicFolderDatabase -Identity 'PFDB01'-MaintenanceSchedule 'Sun.2:00 AM-Sun.6:00 AM, Mon.2:00 AM-Mon.6:00 AM, Tue.2:00 AM-Tue.6:00 AM, Wed.2:00 AM-Wed.6:00 AM, Thu.2:00 AM-Thu.6:00 AM, Fri.2:00 AM-Fri.6:00 AM, Sat.2:00 AM-Sat.6:00 AM' -``` - -This example sets the database maintenance schedule on PFDB01 to run daily from 02:00 (2:00 A.M.) until 06:00 (6:00 A.M.). - -### -------------------------- Example 3 -------------------------- -``` -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. - -## PARAMETERS - -### -Identity -The Identity parameter specifies a public folder database. You can use the following values: - -- GUID - -- Distinguished name (DN) - -- Database name - -If you don't specify the server name, the command searches for databases on the local server. If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllowFileRestore -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackgroundDatabaseMaintenance -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CircularLoggingEnabled -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomReferralServerList -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". - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeletedItemRetention -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 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHistoryRetentionPeriod -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssueWarningQuota -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemRetentionPeriod -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaintenanceSchedule -The MaintenanceSchedule parameter specifies the store maintenance schedule. - -```yaml -Type: Schedule -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxItemSize -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MountAtStartup -The MountAtStartup parameter specifies whether the database should be mounted when the store starts. The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitPostQuota -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuotaNotificationSchedule -The QuotaNotificationSchedule parameter specifies the interval at which warning messages are sent when public folders exceed their specified size limit. - -```yaml -Type: Schedule -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: ByteQuantifiedSize -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationPeriod -The ReplicationPeriod parameter specifies the interval at which replication of public folders or content updates may occur. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSchedule -The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents may occur. - -```yaml -Type: Schedule -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDeletedItemsUntilBackup -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseCustomReferralServerList -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/34ec3385-778a-43b8-9bf2-707fbf60ac23.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SharingPolicy.md deleted file mode 100644 index d9ede71aa3..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SharingPolicy.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SharingPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-SharingPolicy cmdlet to modify existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SharingPolicy [-Identity] <SharingPolicyIdParameter> [-Confirm] [-Default] [-DomainController <Fqdn>] - [-Domains <MultiValuedProperty>] [-Enabled <$true | $false>] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## 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 lsharing 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SharingPolicy -Identity Contoso -Domains "mail.contoso.com: CalendarSharingFreeBusySimple" -``` - -This example modifies the sharing policy Contoso for contoso.com, which is a domain outside your organization. This policy allows users in the Contoso domain to see simple free/busy information. - -### -------------------------- Example 2 -------------------------- -``` -Set-SharingPolicy -Identity SharingPolicy01 -Domains "contoso.com: CalendarSharingFreeBusySimple", "atlanta.contoso.com: CalendarSharingFreeBusyReviewer", "beijing.contoso.com: CalendarSharingFreeBusyReviewer" -``` - -This example adds a second domain to the sharing policy SharingPolicy01. When you're adding a domain to an existing policy, you must include any previously included domains. - -### -------------------------- Example 3 -------------------------- -``` -Set-SharingPolicy -Identity "SharingPolicy01" -Enabled $false -``` - -This example disables the sharing policy SharingPolicy01. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the sharing policy that you want to modify. You can use one of the following values: - -- ADObjectID - -- Distinguished name (DN) - -- Legacy DN - -- GUID - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domains -The Domains parameter specifies domains to which this policy applies and the sharing policy action. Values for this parameter use the format \<Domain\>: \<SharingPolicyAction\>. - -The following sharing policy action values can be used: - -- CalendarSharingFreeBusySimple: Share free/busy hours only. - -- CalendarSharingFreeBusyDetail: Share free/busy hours, subject, and location. - -- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location, and the body of the message or calendar item. - -- ContactsSharing: Share contacts only. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -A domain doesn't include subdomains. You need to configure each subdomain separately. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/42bab80c-62af-4b37-bb41-fa0173b27d86.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SiteMailbox.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SiteMailbox.md deleted file mode 100644 index be2d14ab08..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Set-SiteMailbox.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SiteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-SiteMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-SiteMailbox cmdlet to change a site mailbox's settings, such as the Microsoft SharePoint URL. This cmdlet is primarily used by the SharePoint and Microsoft Exchange user interfaces, such as the SharePoint URL. This cmdlet should only be used for diagnostic and troubleshooting purposes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-SiteMailbox [-Identity] <RecipientIdParameter> [-Active <$true | $false>] [-Confirm] - [-DisplayName <String>] [-DomainController <Fqdn>] [-Force] [-Members <RecipientIdParameter[]>] - [-Owners <RecipientIdParameter[]>] [-RemoveDuplicateMessages <$true | $false>] [-SharePointUrl <Uri>] - [-ShowInMyClient <$true | $false>] [-WhatIf] [-SyncEnabled <$true | $false>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-SiteMailbox -Identity "MarketingEvents 2013" -SharePointUrl "https://myserver/teams/marketing" -``` - -This example changes the SharePoint URL for the MarketingEvents 2013 site mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Set-SiteMailbox -Identity SMO_ContosoSales -RemoveDuplicateMessages $true -``` - -This example disables the duplication of email messages in the site mailbox SMO\_ContosoSales. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the site mailbox. You can use any of the following values: - -- Distinguished name (DN) - -- GUID - -- Name - -- Display name - -- Alias - -- Primary SMTP address - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Active -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the site mailbox. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -Members -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. This is a multivalued parameter and multiple recipients should be separated by a comma. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owners -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 site mailbox's owners. This is a multivalued field and multiple recipients should be separated by commas. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointUrl -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowInMyClient -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncEnabled -The SyncEnabled parameter specifies whether to enable or disable synchronization for the site mailbox. Valid values are: - -- $true: Synchronization is enabled. - -- $true: Synchronization is disabled. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7e4482c0-8ff6-40ab-a315-c460a6f7eeec.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md deleted file mode 100644 index bd040fff2b..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Suspend-PublicFolderReplication -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Suspend-PublicFolderReplication - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Suspend-PublicFolderReplication cmdlet to stop public folder replication for the organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Suspend-PublicFolderReplication [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Suspend-PublicFolderReplication -``` - -This example stops public folder replication for the organization. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ce2a7c81-1884-4b4a-8382-8a8b5f0862ff.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md deleted file mode 100644 index 572864a87e..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-OrganizationRelationship -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Test-OrganizationRelationship cmdlet to verify that the organization relationship is properly configured and functioning as expected. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-OrganizationRelationship [[-Identity] <OrganizationRelationshipIdParameter>] - -UserIdentity <RecipientIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-OrganizationRelationship cmdlet doesn't include any functional tests of federated sharing features, such as accessing user free/busy information or moving mailboxes between organizations. It only verifies that the configuration will allow these features to work correctly. - -Before you can test an organization relationship, you must first create an organization relationship. For more information, see Create an organization relationship (https://technet.microsoft.com/library/jj657451.aspx). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-OrganizationRelationship -UserIdentity katherine@contoso.com -Identity contoso.com -Confirm -``` - -This example validates the organization relationship deployed in the Exchange organization and checks whether a delegation token can be retrieved for a mailbox for the external organization domain contoso.com. - -## PARAMETERS - -### -UserIdentity -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 of the following values: - -- Distinguished name (DN) - -- Canonical name - -- GUID - -- Name - -- Display name - -- Alias - -- Exchange DN - -- Primary SMTP email address - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the organization relationship to be tested. You can use the following values: - -- Canonical name - -- GUID - -- Name - -```yaml -Type: OrganizationRelationshipIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/80be049b-61f2-4751-906a-7de5fb63e4f3.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Test-SiteMailbox.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Test-SiteMailbox.md deleted file mode 100644 index d3efbadf59..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Test-SiteMailbox.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-SiteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Test-SiteMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Test-SiteMailbox cmdlet to test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Test-SiteMailbox [[-Identity] <RecipientIdParameter>] [-BypassOwnerCheck] [-Confirm] - [-RequestorIdentity <RecipientIdParameter>] [-SharePointUrl <Uri>] [-UseAppTokenOnly] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-SiteMailbox -BypassOwnerCheck -SharePointUrl "https://myserver/teams/edu" -``` - -The example tests a SharePoint site's connectivity only. You can use this command before creating a site mailbox or if you're having a problem creating a site mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Test-SiteMailbox -BypassOwnerCheck -Identity mysitemailbox@contoso.com -UseAppTokenOnly -``` - -This example tests the Exchange server connectivity with an existing site mailbox using the Identity and UseAppTokenOnly parameters. The Identity parameter specifies the site mailbox and the UseAppTokenOnly parameter specifies that you want to test under the identity of the Exchange server. Run this command for troubleshooting documentation synchronization issues. - -### -------------------------- Example 3 -------------------------- -``` -Test-SiteMailbox -BypassOwnerCheck -RequestorIdentity "kweku@contoso.com" -SharePointUrl "https://myserver/teams/edu" -``` - -This example tests a specific user's ability to access a SharePoint site by using the RequestorIdentity parameter. - -## PARAMETERS - -### -BypassOwnerCheck -The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. - -If you run the command without this parameter and you aren't a member or owner of the site mailbox, then the command will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identity of the site mailbox. You can use any of the following values: - -- Distinguished name (DN) - -- GUID - -- Name - -- Display name - -- Alias - -- Primary SMTP address - -You can't use this parameter with the SharePointUrl parameter. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -RequestorIdentity -The RequestorIdentity parameter specifies the identity of a user for whom you want to test to make sure that they have the correct permissions to connect to the SharePoint site mailbox. If you don't specify this parameter, the command uses the identification of the user running this command. You can use any of the following values: - -- DN - -- GUID - -- Name - -- Display name - -- Alias - -- Primary SMTP address - -You can't use this parameter with the UseAppTokenOnly parameter. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharePointUrl -This parameter is available only in on-premises Exchange. - -The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". - -You can't use this parameter with the Identity parameter. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseAppTokenOnly -The UseAppTokenOnlyswitch specifies that you want to test the site mailbox by using the identity of the Exchange server. You don't need to specify a value with this switch. - -You can't use this parameter with the RequestorIdentity parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a0b6ebfd-f424-44a3-a971-1790f8e5d643.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolder.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolder.md deleted file mode 100644 index 4f2c00f2e5..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolder.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Update-PublicFolder -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Update-PublicFolder - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Update-PublicFolder cmdlet to start content synchronization of a public folder. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-PublicFolder [-Identity] <PublicFolderIdParameter> -Server <ServerIdParameter> [-Confirm] - [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-PublicFolder "\Legal\Cases\My Public Folder" -Server "My Server" -``` - -This example starts content replication of the public folder My Public Folder in the \\Legal\\Cases path from the server My Server to all of the servers on the replication list for My Public Folder. - -### -------------------------- Example 2 -------------------------- -``` -Get-PublicFolder "\Legal\Cases\My Public Folder" | Update-PublicFolder -Server "My Server" -``` - -This example also starts content replication of the public folder My Public Folder in the \\Legal\\Cases path from the server My Server to all of the servers on the replication list for My Public Folder, but uses the Get-PublicFolder cmdlet to pipeline the desired folder. - -## PARAMETERS - -### -Identity -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. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -The Server parameterspecifies the identity of a Mailbox server with a public folder database that's the source of the replication. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3c04f37a-bee1-4d3e-b673-843f8fa0c337.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md deleted file mode 100644 index 34ad615014..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2010 -title: Update-PublicFolderHierarchy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Update-PublicFolderHierarchy - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Update-PublicFolderHierarchy cmdlet to start content synchronization of the public folder hierarchy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-PublicFolderHierarchy -Server <ServerIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailboxServer -Identity Server1 | Update-PublicFolderHierarchy -``` - -This example pipes the output of the Get-MailboxServer command to the Update-PublicFolderHierarchy command to start content replication of the public folder hierarchy from Server1 to Mailbox servers with a public folder database. - -## PARAMETERS - -### -Server -The Server parameter specifies the identity of a Mailbox server with a public folder database that's the source of the replication. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010 -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d6816843-1d65-43b5-927c-7447cbcebb80.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md deleted file mode 100644 index 210148d94e..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -external help file: Microsoft.Exchange.WebClient-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-PublicFolderMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Update-PublicFolderMailbox cmdlet to update the hierarchy for public folders. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### InvokeSynchronizer -``` -Update-PublicFolderMailbox [-Identity] <MailboxIdParameter> [-ForceOnlineSync] [-FullSync] [-ReconcileFolders] [-SuppressStatus] - [-Confirm] - [-DomainController <Fqdn>] - [-InvokeSynchronizer] - [-WhatIf] [<CommonParameters>] -``` - -### InvokeSingleFolderSynchronizer -``` -Update-PublicFolderMailbox [-Identity] <MailboxIdParameter> -FolderId <PublicFolderIdParameter> [-CreateAssociatedDumpster] - [-Confirm] - [-DomainController <Fqdn>] - [-InvokeSynchronizer] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet only needs to be used if you want to manually invoke the hierarchy synchronizer and the mailbox assistant. Both these are invoked at least once every 24 hours for each public folder mailbox in the organization. The hierarchy synchronizer is invoked every 15 minutes if any users are logged on to a secondary mailbox through Outlook or a Exchange Web Services client. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-PublicFolderMailbox -Identity PF_marketing -SuppressStatus -``` - -This example updates the public folder hierarchy on the public folder mailbox PF\_marketing and suppresses the command's output. - -### -------------------------- Example 2 -------------------------- -``` -Get-Mailbox -PublicFolder | Update-PublicFolderMailbox -SuppressStatus -``` - -This example updates all public folder mailboxes and suppresses the command's output. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the public folder mailbox. This parameter accepts the following values: - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- Legacy Exchange DN - -- SMTP address - -- Alias - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -FolderId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InvokeSynchronizer -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. - -This switch should only be used for troubleshooting purposes. - -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSingleFolderSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateAssociatedDumpster -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceOnlineSync -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullSync -The FullSync switch specifies that you want to perform a full synchronization of the public folder mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. Folders that exist in the secondary public folder mailbox and not in the primary will be deleted. - -This switch should only be used 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. - -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -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 that instance of the Exchange Management Shell. - -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/36a24f50-89d9-4976-884d-f46eacd0f4d4.aspx) diff --git a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-SiteMailbox.md b/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-SiteMailbox.md deleted file mode 100644 index fd6059b62d..0000000000 --- a/exchange/exchange-ps/exchange/sharing-and-collaboration/Update-SiteMailbox.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-SiteMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Update-SiteMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You may need to perform this action when troubleshooting document or membership synchronization issues. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-SiteMailbox [-Identity] <RecipientIdParameter> [-BypassOwnerCheck] [-Confirm] [-FullSync] - [-Server <String>] - [-Target <All | Document | Membership | Maintenance>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-SiteMailbox -BypassOwnerCheck -Identity "MarketingEvents 2013" -``` - -This example updates the site mailbox MarketingEvents 2013. If you don't specify the target, this triggers both document and membership synchronization. Because the BypassOwnerCheck parameter is used, it isn't necessary to be an owner or member of the site mailbox to run this cmdlet. - -### -------------------------- Example 2 -------------------------- -``` -Update-SiteMailbox -BypassOwnerCheck -Identity WinterHoliday@tailspintoys.com -FullSync -``` - -This example updates the site mailbox WinterHoliday@tailspintoys.com and performs a full synchronization. By default, the update only occurs for synchronization from the last synchronization. This is only applicable to document synchronization - -## PARAMETERS - -### -Identity -The Identity parameter specifies the identity of the site mailbox. This parameter accepts the following values: - -- DisplayName - -- SMTP address - -- Name - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassOwnerCheck -The BypassOwnerCheck parameter specifies that the user running the command in the Exchange Management Shell isn't a site mailbox owner or member. If you run the command without this parameter and you aren't the site mailbox owner or member, the command doesn't run or return any information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullSync -The FullSync parameter specifies full sync is expensive and will have a performance impact on the Exchange system. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -This parameter is available only in on-premises Exchange. - -The Server parameter specifies the fully qualified domain name (FQDN) or the Microsoft SharePoint server on which the site mailbox is located. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -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 - -- Document - -- Membership - -If you don't specify this parameter when you run the cmdlet, this parameter value defaults to ALL. - -```yaml -Type: All | Document | Membership | Maintenance -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b0b73d6f-be39-4c36-8eeb-7774d08c19cb.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/unified-messaging/Disable-UMAutoAttendant.md deleted file mode 100644 index ccf53309e8..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMAutoAttendant.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-UMAutoAttendant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Disable-UMAutoAttendant - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Disable-UMAutoAttendant cmdlet to disable an existing Unified Messaging (UM) auto attendant that's enabled. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-UMAutoAttendant [-Identity] <UMAutoAttendantIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## 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. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-UMAutoAttendant -Identity MyUMAutoAttendant -``` - -This example disables the UM auto attendant MyUMAutoAttendant. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3da890b5-8985-48a0-a5eb-2667394fe788.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/unified-messaging/Disable-UMCallAnsweringRule.md deleted file mode 100644 index b0bf335006..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMCallAnsweringRule.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-UMCallAnsweringRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Disable-UMCallAnsweringRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Disable-UMCallAnsweringRule cmdlet to disable a call answering rule that has been created within a UM-enabled mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-UMCallAnsweringRule [-Identity] <UMCallAnsweringRuleIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-UMCallAnsweringRule cmdlet disables the call answering rule by modifying its status variable. Disabling a call answering rule prevents it from being retrieved and processed when an incoming call is received. With this cmdlet, you can disable an existing call answering rule that's enabled. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable -UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -``` - -This example disables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -Disable -UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -WhatIf -``` - -This example uses the WhatIf switch to test whether the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith is ready to be disabled and if there are any errors within the command. - -### -------------------------- Example 3 -------------------------- -``` -Disable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -Confirm -``` - -This example disables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith and prompts the user logged on to confirm that they're disabling the call answering rule. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. The default is the user's mailbox running the cmdlet. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0368911a-7c22-4182-9a9b-921a48cafa7c.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMIPGateway.md b/exchange/exchange-ps/exchange/unified-messaging/Disable-UMIPGateway.md deleted file mode 100644 index 70ff000bfe..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMIPGateway.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-UMIPGateway -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Disable-UMIPGateway - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Disable-UMIPGateway cmdlet to disable a Unified Messaging (UM) IP gateway. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-UMIPGateway [-Identity] <UMIPGatewayIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Immediate <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-UMIPGateway -Identity MyUMIPGateway -``` - -This example disables the UM IP gateway MyUMIPGateway and stops it from accepting incoming calls from the IP gateway. - -### -------------------------- Example 2 -------------------------- -``` -Disable-UMIPGateway -Identity MyUMIPGateway -Immediate $true -``` - -This example disables the UM IP gateway MyUMIPGateway and disconnects all current calls immediately. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Immediate -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b6e0627a-0063-4e1d-bff0-0b35e8d146a2.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMMailbox.md b/exchange/exchange-ps/exchange/unified-messaging/Disable-UMMailbox.md deleted file mode 100644 index 5e05f1952d..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMMailbox.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-UMMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Disable-UMMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Disable-UMMailbox cmdlet to disable Unified Messaging (UM) for UM-enabled mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-UMMailbox [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] [-IgnoreDefaultScope] - [-KeepProperties <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-UMMailbox -Identity tonysmith@contoso.com -``` - -This example disables Unified Messaging on the mailbox for tonysmith@contoso.com. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepProperties -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. - -- $false: The UM properties are removed from the mailbox. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/369cdc8d-468d-4aed-99ec-1a8ab624f072.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMService.md b/exchange/exchange-ps/exchange/unified-messaging/Disable-UMService.md deleted file mode 100644 index 89e01799bd..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Disable-UMService.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-UMService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-UMService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-UMService cmdlet to set the status of an Exchange Server 2010 Unified Messaging server to disabled. This prevents the UM server from processing UM incoming calls. - -You can run this cmdlet on an Exchange Server 2016 Mailbox server, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to disable the UM service on an Exchange 2016 Mailbox server. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-UMService [-Identity] <UMServerIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Immediate <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## 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. - -After this task is completed, the UM server can no longer: - -- Answer any incoming calls. - -- Respond to Play on Phone requests from a UM server. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-UMService -Identity MyUMServer -``` - -This example disables Unified Messaging on the UM server MyUMServer but doesn't disconnect calls that are being processed. - -### -------------------------- Example 2 -------------------------- -``` -Disable-UMService -Identity MyUMServer -Immediate $true -``` - -This example disables Unified Messaging on the UM server MyUMServer and disconnects all calls being processed. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -```yaml -Type: UMServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Immediate -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: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/16e5df98-4875-42a2-a429-2c66ac6a2e32.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/unified-messaging/Enable-UMAutoAttendant.md deleted file mode 100644 index 5ce8455387..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMAutoAttendant.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-UMAutoAttendant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Enable-UMAutoAttendant - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Enable-UMAutoAttendant cmdlet to enable an existing Unified Messaging (UM) auto attendant that's disabled. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-UMAutoAttendant [-Identity] <UMAutoAttendantIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-UMAutoAttendant -Identity MyUMAutoAttendant -``` - -This example enables the UM auto attendant MyUMAutoAttendant. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4286a209-077f-4413-a3aa-48c4a2af0aa5.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/unified-messaging/Enable-UMCallAnsweringRule.md deleted file mode 100644 index d1d5af9a44..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMCallAnsweringRule.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-UMCallAnsweringRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Enable-UMCallAnsweringRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Enable-UMCallAnsweringRule cmdlet to enable a call answering rule that has been created within a UM-enabled mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-UMCallAnsweringRule [-Identity] <UMCallAnsweringRuleIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-UMCallAnsweringRule cmdlet enables the call answering rule by modifying its status variable. When the call answering rule is created, it's enabled. This cmdlet allows you to enable a previously disabled call answering rule. Enabling a call answering rule enables the cmdlet to retrieve the call answering rule including the conditions and actions for a specified call answering rule. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -``` - -This example enables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith. - -### -------------------------- Example 2 -------------------------- -``` -Enable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -WhatIf -``` - -The example uses the WhatIf switch to test whether the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith is ready to be enabled and if there are any errors within the command. - -### -------------------------- Example 3 -------------------------- -``` -Enable-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -Confirm -``` - -This example enables the call answering rule MyUMCallAnsweringRule in the mailbox for Tony Smith and prompts the logged-on user to confirm that the call answering rule is to be enabled. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. The default is the user's mailbox running the cmdlet. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/23b31348-7055-4328-887e-46e7792b0e25.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMIPGateway.md b/exchange/exchange-ps/exchange/unified-messaging/Enable-UMIPGateway.md deleted file mode 100644 index 587fef2bd1..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMIPGateway.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-UMIPGateway -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Enable-UMIPGateway - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Enable-UMIPGateway cmdlet to enable a Unified Messaging (UM) IP gateway. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-UMIPGateway [-Identity] <UMIPGatewayIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The status variable for a UM IP gateway can be used to enable or disable call answering destined for the IP gateway. The Enable-UMIPGateway cmdlet enables a UM IP gateway in Active Directory by modifying its status variable. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-UMIPGateway -Identity MyUMIPGateway -``` - -This example enables the UM IP gateway MyUMIPGateway. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4a94d6a0-0eb3-4426-b263-58b3db0de7e2.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMService.md b/exchange/exchange-ps/exchange/unified-messaging/Enable-UMService.md deleted file mode 100644 index 6c15901edd..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Enable-UMService.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-UMService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-UMService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-UMService cmdlet to set the status of an Exchange Server 2010 Unified Messaging (UM) server to enabled. This setting enables the Unified Messaging server to process UM calls. - -You can run this cmdlet in Exchange 2013 or later, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to enable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-UMService [-Identity] <UMServerIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-UMService -Identity MyUMServer -``` - -This example enables Unified Messaging on the UM server MyUMServer. - -## PARAMETERS - -### -Identity -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 - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -```yaml -Type: UMServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange 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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/88f457c7-92bc-4f59-b0cf-c0b79f46a7a1.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Export-UMCallDataRecord.md b/exchange/exchange-ps/exchange/unified-messaging/Export-UMCallDataRecord.md deleted file mode 100644 index cfa3a28e8e..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Export-UMCallDataRecord.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-UMCallDataRecord -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Export-UMCallDataRecord - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Export-UMCallDataRecord cmdlet to export Unified Messaging (UM) call data records for UM dial plans and UM IP gateways for a date that you've specified. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Export-UMCallDataRecord -ClientStream <Stream> -Date <ExDateTime> [-Confirm] [-DomainController <Fqdn>] - [-UMDialPlan <UMDialPlanIdParameter>] [-UMIPGateway <UMIPGatewayIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-UMCallDataRecord cmdlet exports Unified Messaging call data records for a specified date to a comma-separated value (CSV) file. You can filter call data records for specific UM dial plans or UM IP gateways. However, if you don't specify a UM IP gateway, all call data records are returned. - -The Export-UMCallDataRecord cmdlet is available when you're using the Exchange Administration Center. You can't use the cmdlet from the Exchange Management Shell. - -After this task is completed, a report is generated that contains Unified Messaging call data records. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Export-UMCallDataRecord -Date 02/01/12 -``` - -This example returns all Unified Messaging call data records on February 1, 2018, and exports them to a CSV file. - -### -------------------------- Example 2 -------------------------- -``` -Export-UMCallDataRecord -Date 02/01/12 -UMDialPlan MyUMDialPlan -``` - -This example exports all Unified Messaging call data records for February 1, 2018, for the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -ClientStream -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMIPGateway -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/974bfc60-6c9c-4452-877b-3a302f39dd95.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Export-UMPrompt.md b/exchange/exchange-ps/exchange/unified-messaging/Export-UMPrompt.md deleted file mode 100644 index 4f15841fc6..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Export-UMPrompt.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-UMPrompt -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Export-UMPrompt - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Export-UMPrompt cmdlet to export an audio file being used as a greeting prompt for Unified Messaging (UM) dial plans and auto attendants. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AACustomGreeting -``` -Export-UMPrompt -PromptFileName <String> -UMAutoAttendant <UMAutoAttendantIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-ExportAsWav <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -### DPCustomGreeting -``` -Export-UMPrompt -PromptFileName <String> -UMDialPlan <UMDialPlanIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-ExportAsWav <$true | $false>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-UMPrompt cmdlet exports prompts that belong to existing UM dial plan and UM auto attendant objects. After the Export-UMPrompt cmdlet exports a prompt, you can save a copy of the prompt to a local drive as an audio file. You can then play the audio file using a media player. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$prompt = Export-UMPrompt -PromptFileName "customgreeting.mp3" -UMDialPlan MyUMDialPlan; Set-Content -Path "d:\DialPlanPrompts\welcomegreeting.mp3" -Value $prompt.AudioData -Encoding Byte -``` - -This example exports the welcome greeting for the UM dial plan MyUMDialPlan and saves it as the file welcomegreeting.mp3. - -### -------------------------- Example 2 -------------------------- -``` -Export-UMPrompt -PromptFileName "welcomegreeting.mp3" -UMAutoAttendant MyUMAutoAttendant; Set-Content -Path "e:\UMPromptsBackup\welcomegreetingbackup.mp3" -Value $prompt.AudioData -Encoding Byte -``` - -This example exports a custom greeting for the UM auto attendant MyUMAutoAttendant and saves it to the file welcomegreetingbackup.mp3. - - -## PARAMETERS - -### -PromptFileName -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMAutoAttendant -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportAsWav -This parameter is only available in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4bf35665-1643-4fec-bdb5-3aa27ff9984f.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md b/exchange/exchange-ps/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md deleted file mode 100644 index 2ebeeb9640..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: Get-OnlineMeetingConfiguration -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-OnlineMeetingConfiguration - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-OnlineMeetingConfiguration cmdlet to view status and usage information about Skype Meetings and Skype for Business Online for mailboxes. Skype Meetings automatically includes Skype for Business Online conference join information in Exchange Online meeting invitations. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-OnlineMeetingConfiguration [-Identity] <MailboxIdParameter> [<CommonParameters>] -``` - -## DESCRIPTION -Exchange Online maintains a per-user cache of Skype for Business Online meeting information that's updated every 24 hours. The Get-OnlineMeetingConfiguration cmdlet provides the following information about the Skype Meetings configuration and the Skype for Business Online meeting information for the user: - -- IsAutoOnlineMeetingEnabled: Indicates if Skype Meetings is enabled for the mailbox. - -- OnlineMeetingInfo: Skype for Business Online meeting coordinates. - -- 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. - -To enable and disable Skype Meetings for an Office 365 organization, you use the EnableAutoSchedule parameter on the Set-CsCloudMeetingConfiguration cmdlet in Skype for Business Online PowerShell. After you enable Skype Meetings in the organization, you can enable or disable it on specific users by using the Grant-CsCloudMeetingPolicy cmdlet in Skype for Business Online PowerShell. For more information, see the following Skype for Business Online PowerShell topics: - -- Set-CsCloudMeetingConfiguration (https://go.microsoft.com/fwlink/p/?LinkId=826065) - -- Grant-CsCloudMeetingPolicy (https://go.microsoft.com/fwlink/p/?LinkId=826066) - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-OnlineMeetingConfiguration -Identity carlam@fourthcoffee.com -``` - -This example gets the Skype Meetings configuration for the specified mailbox. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/76c698d3-7b0c-444e-bfdd-da4ecd906300.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMActiveCalls.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMActiveCalls.md deleted file mode 100644 index 666c481916..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMActiveCalls.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UMActiveCalls -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-UMActiveCalls - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-UMActiveCalls cmdlet to return information about the calls that are active and being processed by the Mailbox server running the Microsoft Exchange Unified Messaging service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### DialPlan -``` -Get-UMActiveCalls -DialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### ServerInstance -``` -Get-UMActiveCalls -InstanceServer <UMServer> [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### UMIPGateway -``` -Get-UMActiveCalls -IPGateway <UMIPGatewayIdParameter> [-DomainController <Fqdn>] [<CommonParameters>] -``` - -### Server -``` -Get-UMActiveCalls [-Server <ServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMActiveCalls cmdlet returns information about the active calls being processed. If the Get-UMActiveCalls cmdlet specifies either the UM dial plan or UM IP gateway, it looks in Active Directory to determine which Mailbox server running the Microsoft Exchange Unified Messaging service must be contacted. If the Mailbox server is specified at a command prompt, the Get-UMActiveCalls cmdlet returns the active calls being processed by the server specified. - -When a Mailbox server is process cycling, the Get-UMActiveCalls cmdlet doesn't return a list of all calls for both the discontinued process and the active process. It returns the active calls only for the new process. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMActiveCalls -``` - -This example displays the details of all active calls on the local Mailbox server. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMActiveCalls -Server MyUMServer -``` - -This example displays the details of all active calls on the Mailbox server MyUMServer. - -### -------------------------- Example 3 -------------------------- -``` -Get-UMActiveCalls -IPGateway MyUMIPGateway -``` - -This example displays the details of all active calls being processed by the UM IP gateway MyUMIPGateway. - -### -------------------------- Example 4 -------------------------- -``` -Get-UMActiveCalls -DialPlan MyUMDialPlan -``` - -This example displays a list of active calls associated with the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -DialPlan -The DialPlan parameter specifies the UM dial plan for which you want to retrieve active calls. - -```yaml -Type: UMDialPlanIdParameter -Parameter Sets: DialPlan -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceServer -The InstanceServer parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls. - -```yaml -Type: UMServer -Parameter Sets: ServerInstance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPGateway -The IPGateway parameter specifies the UM IP gateway for which you want to retrieve active calls. - -```yaml -Type: UMIPGatewayIdParameter -Parameter Sets: UMIPGateway -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Server -The Server parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls. - -```yaml -Type: ServerIdParameter -Parameter Sets: Server -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4c7418a5-783c-4db7-82da-49ceaa3d534f.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMAutoAttendant.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMAutoAttendant.md deleted file mode 100644 index b3971b4bf3..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMAutoAttendant.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMAutoAttendant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMAutoAttendant - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMAutoAttendant cmdlet to retrieve the properties and the values for a Unified Messaging (UM) auto attendant. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMAutoAttendant [[-Identity] <UMAutoAttendantIdParameter>] [-DomainController <Fqdn>] - [-UMDialPlan <UMDialPlanIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMAutoAttendant cmdlet retrieves the properties for a single UM auto attendant or for a list of UM auto attendants. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMAutoAttendant | Format-List -``` - -This example returns a formatted list of all UM auto attendants in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMAutoAttendant -Identity MyUMAutoAttendant -``` - -This example displays the properties of the UM auto attendant MyUMAutoAttendant. - -### -------------------------- Example 3 -------------------------- -``` -Get-UMAutoAttendant -UMDialPlan MyUMDialPlan -``` - -This examples displays all the UM auto attendants associated with the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7e577b3a-184d-4533-b1c9-c2c8884a442a.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallAnsweringRule.md deleted file mode 100644 index bbf6e79b8f..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallAnsweringRule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMCallAnsweringRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMCallAnsweringRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMCallAnsweringRule cmdlet to view the properties of a Unified Messaging (UM) call answering rule that has been created within a UM-enabled mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMCallAnsweringRule [[-Identity] <UMCallAnsweringRuleIdParameter>] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith | Format-List -``` - -This example returns a formatted list of call answering rules in a user's UM-enabled mailbox. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -``` - -This example displays the properties of the call answering rule MyUMCallAnsweringRule. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the identifier for a call answering rule being viewed. - -```yaml -Type: UMCallAnsweringRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. The default is the user's mailbox running the cmdlet. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a6e08530-97b8-4a27-b84f-d362f274ce37.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallDataRecord.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallDataRecord.md deleted file mode 100644 index e0d68b16a6..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallDataRecord.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMCallDataRecord -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMCallDataRecord - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMCallDataRecord cmdlet to display Unified Messaging (UM) call data records for a specific UM-enabled user's mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMCallDataRecord -Mailbox <MailboxIdParameter> [-DomainController <Fqdn>] - [<CommonParameters>] -``` - -## DESCRIPTION -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. - -- 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. - -- CallingNumber: Phone number or address of the caller. - -- CalledNumber: Phone number or address of the intended recipient of the call. - -- Gateway: Fully qualified domain name (FQDN) of the UM IP gateway handling the call. - -- Network MOS (NMOS): Mean opinion score for the network performance. - -- NMOSDegradation: Total NMOS degradation, which is how far the NMOS reported value was from its top value for the corresponding audio codec. - -- PercentagePacketLoss: Percentage that reflects the average network packet loss during the call. - -- Jitter: Average jitter of the network. - -- 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMCallDataRecord -Mailbox tony@contoso.com -``` - -This example displays the UM call data records for the UM-enabled user Tony. - -## PARAMETERS - -### -Mailbox -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7b75c817-820e-4863-9865-e17ad9ade903.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallRouterSettings.md deleted file mode 100644 index eb2293d465..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallRouterSettings.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UMCallRouterSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-UMCallRouterSettings - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-UMCallRouterSettings cmdlet to view the settings of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMCallRouterSettings [[-Server] <ServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMCallRouterSettings -``` - -This example displays a summary list of the Microsoft Exchange Unified Messaging Call Router service settings on all Exchange servers in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMCallRouterSettings -Server EXCH01 | Format-List -``` - -This example displays detailed information for the Microsoft Exchange Unified Messaging Call Router service that's running on the server named EXCH01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dbd22f09-4a97-4738-903d-f2760c15c101.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallSummaryReport.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallSummaryReport.md deleted file mode 100644 index 299a7f88b6..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMCallSummaryReport.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMCallSummaryReport -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMCallSummaryReport - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMCallSummaryReport cmdlet to return statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMCallSummaryReport -GroupBy <Day | Month | Total> [-DomainController <Fqdn>] - [-UMDialPlan <UMDialPlanIdParameter>] - [-UMIPGateway <UMIPGatewayIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization including voice messages, missed calls, subscriber access, auto attendant, or fax calls. The data returned by running this cmdlet includes audio quality metrics for the sample calls such as the following: - -- Date: Date in which all calls associated with the selected UM IP gateway and UM dial plan have been grouped based on the value of the GroupBy parameter: Total has the value ---, Month has the value MMM/YY and Day has the value MM/DD/YY, where MMM is the first three letters of the month and YY is the last two digits of the year. - -- Voice Message: Percentage of incoming calls answered by Unified Messaging on behalf of users in which callers left a voice message. - -- Missed Calls: Percentage of incoming calls answered by Unified Messaging on behalf of users in which the callers didn't leave a voice message resulting in a missed call notification. - -- Outlook Voice Access: Percentage of incoming calls in which users authenticate to Unified Messaging to access their email, calendars, and voice messages. - -- Outbound: Percentage of calls placed or transferred by Unified Messaging on behalf of authenticated or unauthenticated users. This property can have the value Find Me, Play On Phone, or Play On Phone Greetings. - -- Automated Attendant: Percentage of incoming calls that were answered by auto attendants. - -- Fax: Percentage of incoming calls that were redirected to a fax partner. - -- Other: Percentage of any other incoming or placed calls that don't fall in any of the previous categories. This is provided to allow different types of calls that might be provided in the future to be accounted for as well. This category includes unauthenticated calls made to pilot numbers. - -- Failed Or Rejected: Percentage of calls that either failed or were rejected by the Mailbox server for that organization. - -- Audio Quality: Overall audio quality for the selected period of time for the organization/user. 4.50 or higher = Excellent, 3.5 to 4.49 = Good, 2.5 to 3.49 = Average, 1.50 to 2.49 =Poor, and 1.49 or lower = Bad. - -- Total Calls: If the UM IP gateway is selected, this is the total number of calls grouped for the selected UM IP gateway for the corresponding date, If the UM dial plan control is selected, this is the total number of calls grouped for the selected UM dial plan for the corresponding date, and If the user is selected, this column has the total number of calls for the user. - -- Network MOS (NMOS): Average NMOS for the specific UM dial plan or UM IP gateway. - -- NMOS Degradation: - -- NMOS degradation for the specific UM dial plan or UM IP gateway.: - -- Jitter: Average jitter for the specific UM dial plan or UM IP gateway. - -- Packet loss: Average packet loss for the specific UM dial plan or UM IP gateway. - -- Round Trip: Round trip time (in milliseconds) for the selected UM dial plan or UM IP gateway. - -- Burst loss Duration: Average duration of packet loss during bursts of losses for the selected UM dial plan or UM IP gateway. - -- Number of samples: Number of calls sampled, when calculating the averages. A sample refers to any call data record that contains at least one of the audio quality metrics. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMCallSummaryReport -GroupBy Total -``` - -This example displays the statistics for all calls received or placed by Mailbox servers in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMCallSummaryReport -GroupBy Month -``` - -This example displays the statistics for all calls received or placed by Mailbox servers in the organization over the last 12 months. - -### -------------------------- Example 3 -------------------------- -``` -Get-UMCallSummaryReport -GroupBy Day -``` - -This example displays the statistics for all calls received or placed by Mailbox servers in the organization over the last 90 days. - -### -------------------------- Example 4 -------------------------- -``` -Get-UMCallSummaryReport -GroupBy Month -UMDialplan MyUMDialPlan -``` - -This example displays the statistics for calls received or placed by Mailbox servers for the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -GroupBy -The GroupBy parameter specifies how to return the results. Valid values are: - -- Day: Daily statistics for the last 90 days. - -- Month: Monthly statistics for the last 12 months. - -- Total: A summary of all call statistics for your Mailbox servers running the Microsoft Exchange Unified Messaging service in your organization. - -```yaml -Type: Day | Month | Total -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: UMIPGatewayIdParameter -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fb22cc49-03b7-47f1-9cfb-e05acdcc93d6.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMDialPlan.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMDialPlan.md deleted file mode 100644 index 20807ef56f..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMDialPlan.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMDialPlan -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMDialPlan - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMDialplan cmdlet to display the properties of a single Unified Messaging (UM) dial plan or to return a list of all UM dial plans associated with Mailbox servers running the Microsoft Exchange Unified Messaging service. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMDialPlan [[-Identity] <UMDialPlanIdParameter>] -[-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMDialplan -``` - -This example displays a list of all the UM dial plans in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMDialplan -Identity MyUMDialPlan | Format-List -``` - -This example displays a formatted list of properties for the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the UM dial plan ID. - -```yaml -Type: UMDialPlanIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/23a33037-1572-424e-adc8-3edc26e1a895.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMHuntGroup.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMHuntGroup.md deleted file mode 100644 index c8892eaf60..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMHuntGroup.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMHuntGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMHuntGroup - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMHuntGroup cmdlet to display the properties and values for an existing Unified Messaging (UM) hunt group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMHuntGroup [[-Identity] <UMHuntGroupIdParameter>] [-DomainController <Fqdn>] - [-UMDialPlan <UMDialPlanIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMHuntGroup cmdlet retrieves the properties for a single UM hunt group or a list of UM hunt groups. When you're using the Get-UMHuntGroup cmdlet, you can't only enter the name of the UM hunt group. You must also include the name of the UM IP gateway associated with the UM hunt group, for example, Get-UMHuntGroup -Identity MyUMIPGateway\\MyUMHuntGroup1. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMHuntGroup -``` - -This example displays all the UM hunt groups in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMHuntGroup -Identity MyUMIPGateway\MyUMHuntGroup | Format-List -``` - -This example displays the details of the UM hunt group MyUMHuntGroup in a formatted list. - -### -------------------------- Example 3 -------------------------- -``` -Get-UMHuntGroup -UMDialPlan MyUMDialPlan -``` - -This example displays all of the UM hunt groups associated with the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89471543-4fae-42b0-a807-fd15bec97307.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMIPGateway.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMIPGateway.md deleted file mode 100644 index 7f0146da55..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMIPGateway.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMIPGateway -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMIPGateway - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMIPGateway cmdlet to return a list of properties and values for a specified Unified Messaging (UM) IP gateway or a list of UM IP gateways. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMIPGateway [[-Identity] <UMIPGatewayIdParameter>] [-DomainController <Fqdn>] -[-IncludeSimulator] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMIPGateway cmdlet displays the properties and values for a specified UM IP gateway, such as the display name, IP address, status and outgoing calls settings. If no parameter is specified, all UM IP gateways in the Active Directory forest are returned. - -When you're using the Get-UMIPGateway cmdlet, you can't enter the IP address configured on the UM IP gateway. You must use the name of the UM IP gateway. The name specified with the Identity parameter of the Get-UMIPGateway cmdlet can be the same as or different from the host name of the UM IP gateway, for example, Get-UMIPGatewayMyUMIPGateway. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMIPGateway | Format-List -``` - -This example displays a formatted list of all the UM IP gateways in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMIPGateway -Identity MyUMIPGateway -``` - -This example displays the properties for the UM IP gateway MyUMIPGateway. - -### -------------------------- Example 3 -------------------------- -``` -Get-UMIPGateway -IncludeSimulator $true -``` - -This example displays all the UM IP gateways including IP gateway simulators in the Active Directory forest. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeSimulator -The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. A simulator allows a client to connect to the Mailbox server. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d7f8c7d0-6ed7-4b74-91de-8b0ed2377946.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailbox.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailbox.md deleted file mode 100644 index f8f98de6db..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailbox.md +++ /dev/null @@ -1,368 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMMailbox cmdlet to view existing mailboxes that are Unified Messaging (UM) enabled. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-UMMailbox [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-UMMailbox [[-Identity] <MailboxIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMMailbox -``` - -This example displays a summary list of all the UM-enabled mailboxes in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMMailbox -Identity tonysmith@contoso.com | Format-List -``` - -This example displays detailed information for the UM-enabled mailbox for tonysmith@contoso.com. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- AllowUMCallsFromNonUsers - -- DisplayName - -- DistinguishedName - -- EmailAddresses - -- ExchangeVersion - -- Guid - -- Id - -- LegacyExchangeDN - -- Name - -- ObjectCategory - -- ObjectClass - -- OperatorNumber - -- PhoneProviderId - -- PrimarySmtpAddress - -- SamAccountName - -- ServerLegacyDN - -- ServerName - -- UMAddresses - -- UMDtmfMap - -- UMEnabled - -- UMMailboxPolicy - -- WhenChanged - -- WhenChangedUTC - -- WhenCreated - -- WhenCreatedUTC - -For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -This parameter is available only in on-premises Exchange. - -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 - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -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 -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- ServerLegacyDN - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4c652c1a-2f0e-45ff-99ca-d194057f1550.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailboxPIN.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailboxPIN.md deleted file mode 100644 index 665637da22..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailboxPIN.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMMailboxPIN -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMMailboxPin - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-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://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMMailboxPin [[-Identity] <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-IgnoreErrors] [-ReadFromDomainController] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMMailboxPIN -``` - -This example displays the UM mailbox PIN-related properties for all UM-enabled users. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMMailboxPIN -Identity tonysmith@contoso.com -``` - -This example displays the UM mailbox PIN-related properties for tonysmith@contoso.com. - -## PARAMETERS - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreErrors -The IgnoreErrors switch specifies whether errors that may occur when running this cmdlet are written as warnings. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/93924584-5955-4e54-8b74-bf00cf269317.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailboxPolicy.md deleted file mode 100644 index 57008f0499..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMMailboxPolicy.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-UMMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Get-UMMailboxPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Get-UMMailboxPolicy cmdlet to display the properties and values of a Unified Messaging (UM) mailbox policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMMailboxPolicy [[-Identity] <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] - [-UMDialPlan <UMDialPlanIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMMailboxPolicy cmdlet retrieves the configuration properties and values for a UM mailbox policy or returns a list of UM mailbox policies. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMMailboxPolicy | Format-List -``` - -This example returns a formatted list of all UM mailbox policies in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMMailboxPolicy -Identity MyUMMailboxPolicy -``` - -This example returns the properties and values for the UM mailbox policy MyUMMailboxPolicy. - -### -------------------------- Example 3 -------------------------- -``` -Get-UMMailboxPolicy -UMDialPlan MyUMDialPlan -``` - -This examples displays all the UM mailbox policies associated with the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the 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, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/f3a09cda-c1b9-4d7c-b1a5-eefc3603ebe7.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UMService.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UMService.md deleted file mode 100644 index 51cb324e1e..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UMService.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UMService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Get-UMService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Get-UMService cmdlet to view the settings of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMService [[-Identity] <UMServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -When the cmdlet is used for a single Exchange server, it returns the Unified Messaging service properties, including MaxCalls, MaxFaxCalls and UMDialPlans. The properties and their values for the Exchange server are stored in the Unified Messaging section of the Exchange Server configuration object in Active Directory. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMService -``` - -This example displays a summary list of the Microsoft Exchange Unified Messaging service settings on all Exchange servers in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMService -Identity MBX01 | Format-List -``` - -This example displays detailed information for the Microsoft Exchange Unified Messaging service settings on the server named MBX01. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The 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 - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: UMServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/180f9243-719a-4c2b-ab4e-7c69c857473e.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Get-UmServer.md b/exchange/exchange-ps/exchange/unified-messaging/Get-UmServer.md deleted file mode 100644 index fb00f1a503..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Get-UmServer.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010 -title: Get-UmServer -schema: 2.0.0 -monikerRange: "exchserver-ps-2010" ---- - -# Get-UMServer - -## SYNOPSIS -This cmdlet is available only in Exchange Server 2010. - -Use the Get-UMServer cmdlet to view settings that are associated with the Unified Messaging (UM) server role. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UMServer [[-Identity] <UMServerIdParameter>] [-DomainController <Fqdn>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-UMServer cmdlet retrieves the properties for a Unified Messaging server or returns a list of available UM servers from Active Directory. When the cmdlet is used for a single UM server, it returns the UM server properties including MaxCalls, MaxFaxCalls, and UMDialPlans. The properties and their values for the UM server are stored in the Unified Messaging section of the Exchange Server configuration object in Active Directory. - -The ExchangeVersion attribute that's returned is the minimum version of Microsoft Exchange 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 Management Console when you select Server Configuration. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UMServer -``` - -This example displays a list of all the Unified Messaging servers in the Active Directory forest. - -### -------------------------- Example 2 -------------------------- -``` -Get-UMServer -Identity MyUMServer | Format-List -``` - -This example displays a formatted list of properties for the Unified Messaging server named MyUMServer. - -## PARAMETERS - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the name of the Unified Messaging server. If this parameter isn't supplied, a list of all Unified Messaging servers is returned. - -```yaml -Type: UMServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/af1f90d6-a2b1-437b-aeaa-f1324bfd0731.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Import-UMPrompt.md b/exchange/exchange-ps/exchange/unified-messaging/Import-UMPrompt.md deleted file mode 100644 index 7687464ead..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Import-UMPrompt.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-UMPrompt -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Import-UMPrompt - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Import-UMPrompt cmdlet to copy or upload a custom audio file to be used by Unified Messaging (UM) dial plans and auto attendants. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### UploadDialPlanPrompts -``` -Import-UMPrompt -PromptFileData <Byte[]> -PromptFileName <String> -UMDialPlan <UMDialPlanIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### UploadAutoAttendantPrompts -``` -Import-UMPrompt -PromptFileData <Byte[]> -PromptFileName <String> -UMAutoAttendant <UMAutoAttendantIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### UploadAutoAttendantPromptsStream -``` -Import-UMPrompt -PromptFileName <String> -PromptFileStream <Stream> -UMAutoAttendant <UMAutoAttendantIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -### UploadDialPlanPromptsStream -``` -Import-UMPrompt -PromptFileName <String> -PromptFileStream <Stream> -UMDialPlan <UMDialPlanIdParameter> - [-Confirm] - [-DomainController <Fqdn>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-UMPrompt cmdlet imports custom greeting audio files into UM dial plans and auto attendants. There are many custom greetings used by UM dial plans and auto attendants including welcome greetings for dial plans and after hours welcome greetings and menus, business hours and non-business hours welcome greetings and menus, and key mappings for UM auto attendants. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0; Import-UMPrompt -UMDialPlan MyUMDialPlan -PromptFileName "welcomegreeting.wav" -PromptFileData $c -``` - -This example imports the welcome greeting file welcomegreeting.wav from d:\\UMPrompts into the UM dial plan MyUMDialPlan. - -### -------------------------- Example 2 -------------------------- -``` -[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0; Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "welcomegreeting.wav" -PromptFileData $c -``` - -This example imports the welcome greeting file welcomegreeting.wav from d:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. - -### -------------------------- Example 3 -------------------------- -``` -[byte[]]$c = Get-content -Path "d:\UMPrompts\AfterHoursWelcomeGreeting.wav" -Encoding Byte -ReadCount 0; Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "AfterHoursWelcomeGreeting.wav" -PromptFileData $c -``` - -This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav from d:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. - -## PARAMETERS - -### -PromptFileData -The PromptFileData parameter specifies the byte array of the custom prompt. - -```yaml -Type: Byte[] -Parameter Sets: UploadDialPlanPrompts, UploadAutoAttendantPrompts -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PromptFileName -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: Stream -Parameter Sets: UploadAutoAttendantPromptsStream, UploadDialPlanPromptsStream -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMAutoAttendant -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/6a91a841-a054-4b30-a899-2c51c997f527.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/New-UMAutoAttendant.md b/exchange/exchange-ps/exchange/unified-messaging/New-UMAutoAttendant.md deleted file mode 100644 index 00f5686fc4..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/New-UMAutoAttendant.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-UMAutoAttendant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-UMAutoAttendant - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-UMAutoAttendant cmdlet to create a Unified Messaging (UM) auto attendant. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-UMAutoAttendant [-Name] <String> -UMDialPlan <UMDialPlanIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-PilotIdentifierList <MultiValuedProperty>] [-SpeechEnabled <$true | $false>] [-Status <Enabled | Disabled>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-UMAutoAttendant cmdlet creates one or more UM auto attendants. UM auto attendants have a forest-wide scope in the configuration container in Active Directory. When you create a UM auto attendant, the auto attendant isn't speech-enabled or able to answer incoming calls by default. The auto attendant is linked to a single UM dial plan that contains a list of extension numbers. Linking the UM auto attendant to the UM dial plan enables the associated Mailbox servers to answer incoming calls using the UM auto attendant. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UMAutoAttendant -Name MyUMAutoAttendant -UMDialPlan MyUMDialPlan -PilotIdentifierList 55000 -Status Enabled -``` - -This example creates the UM auto attendant MyUMAutoAttendant that can accept incoming calls using the extension number 55000 but isn't speech-enabled. - -### -------------------------- Example 2 -------------------------- -``` -New-UMAutoAttendant -Name MyUMAutoAttendant -UMDialPlan MyUMDialPlan -PilotIdentifierList 56000,56100 -SpeechEnabled $true -Status Enabled -``` - -This example creates the speech-enabled UM auto attendant MyUMAutoAttendant using the extension numbers 56000 and 56100 that can accept incoming calls. - -## PARAMETERS - -### -Name -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DTMFFallbackAutoAttendant -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PilotIdentifierList -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpeechEnabled -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: $true | $false -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 -``` - -### -Status -The Status parameter specifies whether the UM auto attendant being created will be enabled. If this parameter isn't supplied, the UM auto attendant is created but left in a disabled state. - -```yaml -Type: Enabled | Disabled -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d439154c-eba7-4783-a7a3-0e73556eedef.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/New-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/unified-messaging/New-UMCallAnsweringRule.md deleted file mode 100644 index a2a97f8e5a..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/New-UMCallAnsweringRule.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-UMCallAnsweringRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-UMCallAnsweringRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-UMCallAnsweringRule cmdlet to create a call answering rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-UMCallAnsweringRule -Name <String> [-CallerIds <MultiValuedProperty>] - [-CallersCanInterruptGreeting <$true | $false>] [-CheckAutomaticReplies <$true | $false>] [-Confirm] - [-DomainController <Fqdn>] [-ExtensionsDialed <MultiValuedProperty>] [-KeyMappings <MultiValuedProperty>] - [-Mailbox <MailboxIdParameter>] [-Priority <Int32>] [-ScheduleStatus <Int32>] [-TimeOfDay <TimeOfDay>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-UMCallAnsweringRule cmdlet creates a Unified Messaging (UM) call answering rule stored in a UM-enabled user's mailbox. You can run the cmdlet and create a call answering rule of the user that's logged on or use the Mailbox parameter to specify the mailbox where you want the call answering rule to be created. You can use the New-UMCallAnsweringRule cmdlet to specify the following conditions: - -- Who the incoming call is from - -- Time of day - -- Calendar free/busy status - -- Whether automatic replies are turned on for email - -You can also specify the following actions: - -- Find me - -- Transfer the caller to someone else - -- Leave a voice message - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UMCallAnsweringRule -Mailbox tonysmith -Name MyCallAnsweringRule -Priority 2 -``` - -This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith with the priority of 2. - -### -------------------------- Example 2 -------------------------- -``` -New-UMCallAnsweringRule -Name MyCallAnsweringRule -CallerIds "1,4255550100,,","1,4255550123,," -Priority 2 -CallersCanInterruptGreeting $true -Mailbox tonysmith -``` - -This example creates the following actions on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith: - -- Sets the call answering rule to two caller IDs. - -- Sets the priority of the call answering rule to 2. - -- Sets the call answering rule to allow callers to interrupt the greeting. - -### -------------------------- Example 3 -------------------------- -``` -New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith@contoso.com -ScheduleStatus 0x8 -``` - -This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith that sets the free/busy status to Out of Office and sets the priority to 2. - -### -------------------------- Example 4 -------------------------- -``` -New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -ScheduleStatus 0x4 - -KeyMappings "1,1,Receptionist,,,,,45678,","5,2,Urgent Issues,23456,23,45671,50,," -``` - -This example creates the call answering rule MyCallAnsweringRule in the mailbox tonysmith and performs the following actions: - -- 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: - -- 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. - -### -------------------------- Example 5 -------------------------- -``` -New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "1,0,," -``` - -This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith and performs the following actions: - -- Sets the priority of the call answering rule to 2. - -- If the caller reaches voice mail during working hours, the caller is asked to call back later. - -### -------------------------- Example 6 -------------------------- -``` -New-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "3,4,8:00,12:00" -``` - -This example creates the call answering rule MyCallAnsweringRule in the mailbox for tonysmith with a custom period for the time of day and performs the following actions: - -- Sets the priority of the call answering rule to 2. - -- If the caller reaches voice mail and the time is between 8:00 A.M. and 12:00 P.M. on Tuesday, ask the caller to call back later. - -## PARAMETERS - -### -Name -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerIds -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallersCanInterruptGreeting -The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CheckAutomaticReplies -The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionsDialed -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyMappings -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is created. The default is the user's mailbox that's running the cmdlet. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleStatus -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 - -- Free = 0x1 - -- Tentative = 0x2 - -- Busy = 0x4 - -- OutOfOffice = 0x8 - -The default setting is $null. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeOfDay -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/79547dbf-1fb3-43ed-a788-03e4907e68a3.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/New-UMDialPlan.md b/exchange/exchange-ps/exchange/unified-messaging/New-UMDialPlan.md deleted file mode 100644 index 5af8d7a108..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/New-UMDialPlan.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-UMDialPlan -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-UMDialPlan - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-UMDialplan cmdlet to create a Unified Messaging (UM) dial plan to establish a link between UM IP gateways, UM hunt groups, and Mailbox servers to enable communication between Unified Messaging components. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-UMDialPlan [-Name] <String> -CountryOrRegionCode <String> -NumberOfDigitsInExtension <Int32> - [-AccessTelephoneNumbers <MultiValuedProperty>] - [-Confirm] - [-DefaultLanguage <UMLanguage>] - [-DefaultOutboundCallingLineId <String>] - [-DomainController <Fqdn>] - [-FaxEnabled <$true | $false>] - [-GenerateUMMailboxPolicy <$true | $false>] - [-URIType <TelExtn | E164 | SipName>] - [-VoIPSecurity <SIPSecured | Unsecured | Secured>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-UMDialplan cmdlet creates a UM dial plan in Active Directory. A UM dial plan object has an organization-wide scope and contains all configuration information related to a telephony dial plan. A UM dial plan is a required component for establishing Unified Messaging communications with Microsoft Exchange. When you create a UM dial plan, an understanding of telephony configurations and the implications of adding to or modifying a UM configuration is required. - -After the new UM dial plan is created, a UM IP gateway and a Mailbox server must be associated with the UM dial plan to enable Unified Messaging operations. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UMDialplan -Name MyUMDialPlan -NumberOfDigitsInExtension 4 -``` - -This example creates the UM dial plan MyUMDialPlan that uses four-digit extension numbers. - -### -------------------------- Example 2 -------------------------- -``` -New-UMDialplan -Name MyUMDialPlan -URIType SipName -NumberOfDigitsInExtension 5 -``` - -This example creates the UM dial plan MyUMDialPlan that uses five-digit extension numbers that support SIP URIs. - -### -------------------------- Example 3 -------------------------- -``` -New-UMDialplan -Name MyUMDialPlan -URIType E164 -NumberOfDigitsInExtension 5 -VoIPSecurity Unsecured -``` - -This example creates the unsecured UM dial plan MyUMDialPlan that supports E.164 numbers and that uses five-digit extension numbers. - -## PARAMETERS - -### -CountryOrRegionCode -The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America and 44 is the code used for the United Kingdom. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfDigitsInExtension -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessTelephoneNumbers -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DefaultLanguage -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultOutboundCallingLineId -This parameter is available or functional only in Exchange Server 2010. - -The DefaultOutboundCallingLineId parameter specifies the phone number that a Unified Messaging server would use as the calling line ID when placing an outbound call. By default, this is set to $null and only the extension number of the UM-enabled user that places the outbound call is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -FaxEnabled -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: $true | $false -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 -``` - -### -GenerateUMMailboxPolicy -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: $true | $false -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 -``` - -### -URIType -The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX). - -```yaml -Type: TelExtn | E164 | SipName -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 -``` - -### -VoIPSecurity -This parameter is available only in on-premises Exchange. - -The VoIPSecurity parameter specifies whether the signaling channel is encrypted using mutual Transport Layer Security (TLS). The default setting is Unsecured. - -```yaml -Type: SIPSecured | Unsecured | Secured -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/21b8a099-92d0-49cf-b492-a052e0f23135.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/New-UMHuntGroup.md b/exchange/exchange-ps/exchange/unified-messaging/New-UMHuntGroup.md deleted file mode 100644 index 82ac5914db..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/New-UMHuntGroup.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-UMHuntGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-UMHuntGroup - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-UMHuntGroup cmdlet to create a Unified Messaging (UM) hunt group used to link incoming calls to a specific UM dial plan. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-UMHuntGroup [-Name] <String> -UMDialPlan <UMDialPlanIdParameter> -UMIPGateway <UMIPGatewayIdParameter> - [-Confirm] [-DomainController <Fqdn>] [-PilotIdentifier <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-UMHuntGroup cmdlet creates a UM hunt group in Active Directory. Running this cmdlet enables all Mailbox servers associated with UM dial plans to communicate with an IP gateway. A UM hunt group must be created to allow communication between a UM IP gateway and a UM dial plan. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UMHuntGroup -Name MyUMHuntGroup -PilotIdentifier 12345 -UMDialPlan MyUMDialPlan -UMIPGateway MyUMIPGateway -``` - -This example creates the UM hunt group MyUMHuntGroup that has a pilot identifier of 12345. - -### -------------------------- Example 2 -------------------------- -``` -New-UMHuntGroup -Name MyUMHuntGroup -PilotIdentifier 5551234,55555 -UMDialPlan MyUMDialPlan -UMIPGateway MyUMIPGateway -``` - -This example creates the UM hunt group MyUMHuntGroup that has multiple pilot identifiers. - -## PARAMETERS - -### -Name -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMIPGateway -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PilotIdentifier -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4aaad0e7-7125-42d5-a51c-78f872f56594.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/New-UMIPGateway.md b/exchange/exchange-ps/exchange/unified-messaging/New-UMIPGateway.md deleted file mode 100644 index ac9694560e..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/New-UMIPGateway.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-UMIPGateway -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# New-UMIPGateway - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-UMIPGateway cmdlet to create a Unified Messaging (UM) IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP gateway or a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-UMIPGateway [-Name] <String> -Address <UMSmartHost> - [-Confirm] - [-DomainController <Fqdn>] - [-GlobalCallRoutingScheme <None | E164 | GatewayGuid | Reserved1 | Reserved2 | Reserved3>] - [-IPAddressFamily <IPv4Only | IPv6Only | Any>] - [-UMDialPlan <UMDialPlanIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -A UM IP gateway has organization-wide scope and references a single physical IP gateway. The UM IP gateway that's created is used to establish a connection to an IP gateway or a SIP-enabled IP PBX. After this task is completed, a new UM IP gateway is created. - -This cmdlet was removed from Exchange Online in October, 2018. For more information, see the announcement in the Exchange EHLO blog (https://blogs.technet.microsoft.com/exchange/2018/04/24/new-date-for-discontinuation-of-support-for-session-border-controllers-in-exchange-online-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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -``` - -This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox server to start accepting calls from an IP gateway with an IP address of 10.10.10.1. - -### -------------------------- Example 2 -------------------------- -``` -New-UMIPGateway -Identity MyUMIPGateway -Address fe80::39bd:88f7:6969:d223%11 -IPAddressFamily Any -Status Disabled -OutcallsAllowed $false -``` - -This example creates the UM IP gateway MyUMIPGateway and prevents it from accepting incoming calls and outgoing calls, sets an IPv6 address and allows the UM IP gateway to use IPv4 and IPV6 addresses. - -### -------------------------- Example 3 -------------------------- -``` -New-UMIPGateway -Identity MyUMIPGateway -Address "MyUMIPGateway.contoso.com" -``` - -This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox server to start accepting calls from an IP gateway with an FQDN of MyUMIPGateway.contoso.com. - -## PARAMETERS - -### -Address -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, Exchange Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a 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 -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -GlobalCallRoutingScheme -This parameter is available or functional only in Exchange Server 2010. - -The GlobalCallRoutingScheme parameter specifies whether the IP gateway can accept calls for UM-enabled users and auto attendant numbers included in the global routing database. If the setting is E.164, the IP gateway accepts the call. - -```yaml -Type: None | E164 | GatewayGuid | Reserved1 | Reserved2 | Reserved3 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressFamily -The IPAddressFamily parameter specifies whether the UM IP gateway uses 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 will be used first, and then, if necessary, it will fallback to IPv4. The default is IPv4Only. - -```yaml -Type: IPv4Only | IPv6Only | Any -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/598774bf-2a38-4779-be5a-9955c6b5ef4b.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/New-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/unified-messaging/New-UMMailboxPolicy.md deleted file mode 100644 index 5350d6cb7a..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/New-UMMailboxPolicy.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-UMMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# New-UMMailboxPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the New-UMMailboxPolicy cmdlet to create a Unified Messaging (UM) mailbox policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-UMMailboxPolicy [-Name] <String> -UMDialPlan <UMDialPlanIdParameter> [-Confirm] -[-DomainController <Fqdn>] [-SharedUMDialPlan] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-UMMailboxPolicy cmdlet creates a UM mailbox policy that has organization-wide scope. UM mailbox policies provide a set of policy values to be applied to UM-enabled users associated with a particular UM dial plan. UM mailbox policies are directly associated with UM dial plans. Therefore, the settings contained within a UM mailbox policy apply only to UM-enabled users of the UM dial plan that the UM mailbox policy is associated with. You can also use the New-UMMailboxPolicy cmdlet to create a UM mailbox policy template that can be used to create additional UM mailbox policies. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UMMailboxPolicy -Name MyUMMailboxPolicy -UMDialPlan MyUMDialPlan -``` - -This example creates the UM mailbox policy MyUMMailboxPolicy associated with the UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -Name -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDialPlan -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, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedUMDialPlan -This parameter is available or functional only in Exchange Server 2010. - -The SharedUMDialPlan parameter specifies whether the new UM mailbox policy being created is linked or associated with a dial plan outside the scope of the organization. If you specify this parameter, the UM mailbox policy can be linked with another tenant's dial plan. This parameter is used during tenant provisioning and is only used in a data center. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5c183eda-11e4-4e4e-a43e-7972eb899cec.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMAutoAttendant.md b/exchange/exchange-ps/exchange/unified-messaging/Remove-UMAutoAttendant.md deleted file mode 100644 index 0f939133dd..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMAutoAttendant.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UMAutoAttendant -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UMAutoAttendant - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UMAutoAttendant cmdlet to delete a Unified Messaging (UM) auto attendant. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UMAutoAttendant [-Identity] <UMAutoAttendantIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-UMAutoAttendant cmdlet deletes an existing UM auto attendant from Active Directory. The Remove-UMAutoAttendant cmdlet deletes the UM auto attendant and also deletes instances of the UM auto attendant from any associated UM dial plans. When the UM auto attendant is deleted, incoming telephone calls to the configured extensions are no longer answered by the UM auto attendant. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UMAutoAttendant -Identity MyUMAutoAttendant -``` - -This example deletes the UM auto attendant MyUMAutoAttendant. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1fc33dc2-df0f-451e-b6a1-5ca0a20bef5e.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/unified-messaging/Remove-UMCallAnsweringRule.md deleted file mode 100644 index 203c3eb6b6..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMCallAnsweringRule.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UMCallAnsweringRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UMCallAnsweringRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UMCallAnsweringRule cmdlet to remove an existing Unified Messaging (UM) call answering rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UMCallAnsweringRule [-Identity] <UMCallAnsweringRuleIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-Mailbox <MailboxIdParameter>] [-WhatIf] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -``` - -This example removes the call answering rule MyUMCallAnsweringRule from a user's mailbox. The user's mailbox is the mailbox of the user running the cmdlet. - -### -------------------------- Example 2 -------------------------- -``` -Remove-UMCallAnsweringRule -Identity MyUMCallAnsweringRule -Mailbox tonysmith -``` - -This example removes the call answering rule MyUMCallAnsweringRule from the mailbox of tonysmith. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is changed. The default is the user's mailbox running the cmdlet. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e438298f-aa96-473e-9f21-03b4ef9bc796.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMDialPlan.md b/exchange/exchange-ps/exchange/unified-messaging/Remove-UMDialPlan.md deleted file mode 100644 index eed34ae57f..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMDialPlan.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UMDialPlan -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UMDialPlan - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UMDialplan cmdlet to delete an existing Unified Messaging (UM) dial plan. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UMDialPlan [-Identity] <UMDialPlanIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-UMDialplan cmdlet deletes an existing UM dial plan from Active Directory. Make sure the UM dial plan isn't being used by other UM objects such as UM mailbox policies or UM IP gateways. When you delete an existing UM dial plan, the cmdlet verifies that the specified UM dial plan isn't referenced by a Mailbox server, UM IP gateway or UM mailbox policies. The only benefit gained from deleting an obsolete UM dial plan is to reuse the name or perform general Active Directory housekeeping. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UMDialplan -Identity MyUMDialPlan -``` - -This example deletes the existing UM dial plan MyUMDialPlan. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b513bb62-ed81-4f90-bff4-39d4e6d3dfaf.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMHuntGroup.md b/exchange/exchange-ps/exchange/unified-messaging/Remove-UMHuntGroup.md deleted file mode 100644 index 9ca94d1905..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMHuntGroup.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UMHuntGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UMHuntGroup - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UMHuntGroup cmdlet to remove and delete an existing Unified Messaging (UM) hunt group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UMHuntGroup [-Identity] <UMHuntGroupIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-UMHuntGroup cmdlet deletes an existing UM hunt group from Active Directory. When the Remove-UMHuntGroup cmdlet is used, the UM hunt group is removed from the UM IP gateway and then deleted from Active Directory. If the operation leaves the UM IP gateway without any remaining configured UM hunt groups, the IP gateway can't handle or process Unified Messaging calls. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UMHuntGroup -Identity MyUMHuntGroup -``` - -This example deletes the UM hunt group MyUMHuntGroup. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1d6ea6f3-d3ba-4b65-a46c-cfd3d0868e62.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMIPGateway.md b/exchange/exchange-ps/exchange/unified-messaging/Remove-UMIPGateway.md deleted file mode 100644 index 0d47aa5f02..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMIPGateway.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UMIPGateway -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UMIPGateway - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UMIPGateway cmdlet to delete a Unified Messaging (UM) IP gateway. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UMIPGateway [-Identity] <UMIPGatewayIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-UMIPGateway cmdlet deletes a specified UM IP gateway. After the UM IP gateway is deleted, Mailbox servers no longer accept new call requests from the IP gateway. - -The Remove-UMIPGateway cmdlet should be run only by an administrator who fully understands the implications of disabling communication with a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX) or IP gateway. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UMIPGateway -Identity MyUMIPGateway -``` - -This example deletes the UM IP gateway MyUMIPGateway. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/8f49a018-e49b-40ed-ad4a-40e89fbafa89.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/unified-messaging/Remove-UMMailboxPolicy.md deleted file mode 100644 index d6e324af03..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Remove-UMMailboxPolicy.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-UMMailboxPolicy -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Remove-UMMailboxPolicy - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Remove-UMMailboxPolicy cmdlet to delete a Unified Messaging (UM) mailbox policy. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UMMailboxPolicy [-Identity] <MailboxPolicyIdParameter> [-Confirm] [-DomainController <Fqdn>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-UMMailboxPolicy cmdlet deletes or removes a UM mailbox policy. If the UM mailbox policy is deleted from Active Directory, the UM mailbox policy can't be used when configuring UM-enabled users. The UM mailbox policy can't be deleted if the UM mailbox policy is referenced by any UM-enabled mailboxes. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UMMailboxPolicy -Identity MyUMMailboxPolicy -``` - -This example deletes the UM mailbox policy MyUMMailboxPolicy. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange 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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ac387332-c110-4540-b550-86467ddc91b6.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/unified-messaging/Set-UMCallAnsweringRule.md deleted file mode 100644 index 0030721b28..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMCallAnsweringRule.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-UMCallAnsweringRule -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-UMCallAnsweringRule - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-UMCallAnsweringRule cmdlet to change properties of an existing UM call answering rule. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UMCallAnsweringRule [-Identity] <UMCallAnsweringRuleIdParameter> [-CallerIds <MultiValuedProperty>] - [-CallersCanInterruptGreeting <$true | $false>] [-CheckAutomaticReplies <$true | $false>] [-Confirm] - [-DomainController <Fqdn>] [-ExtensionsDialed <MultiValuedProperty>] [-KeyMappings <MultiValuedProperty>] - [-Mailbox <MailboxIdParameter>] [-Name <String>] [-Priority <Int32>] [-ScheduleStatus <Int32>] - [-TimeOfDay <TimeOfDay>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-UMCallAnsweringRule cmdlet changes the properties of an existing UM call answering rule stored in a UM enabled user's mailbox. You can use the Set-UMCallAnsweringRule cmdlet to specify the following conditions: - -- Who the incoming call is from - -- Time of day - -- Calendar free/busy status - -- Whether automatic replies are turned on for email - -You can also specify the following actions: - -- Find me - -- Transfer the caller to someone else - -- Leave a voice message - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UMCallAnsweringRule -Mailbox tonysmith -Name MyCallAnsweringRule -Priority 2 -``` - -This example sets the priority to 2 on the existing call answering rule MyCallAnsweringRule that exists in the mailbox for tonysmith. - -### -------------------------- Example 2 -------------------------- -``` -Set-UMCallAnsweringRule -Name MyCallAnsweringRule -CallerIds "1,4255550100,,","1,4255550123,," -Priority 2 -CallersCanInterruptGreeting $true -Mailbox tonysmith -``` - -This example performs the following actions on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith: - -- Sets the call answering rule to two caller IDs. - -- Sets the priority of the call answering rule to 2. - -- Sets the call answering rule to allow callers to interrupt the greeting. - -### -------------------------- Example 3 -------------------------- -``` -Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith@contoso.com -ScheduleStatus 0x8 -``` - -This example changes the free/busy status to Out of Office on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith and sets the priority to 2. - -### -------------------------- Example 4 -------------------------- -``` -Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -ScheduleStatus 0x4 -KeyMappings "1,1,Receptionist,,,,,45678,","5,2,Urgent Issues,23456,23,45671,50,," -``` - -This example performs the following actions on the call answering rule MyCallAnsweringRule in the mailbox tonysmith: - -- 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: - -- 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. - -### -------------------------- Example 5 -------------------------- -``` -Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "1,0,," -``` - -This example performs the following actions on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith: - -- Sets the priority of the call answering rule to 2. - -- If the caller reaches voice mail during working hours, the caller is asked to call back later. - -### -------------------------- Example 6 -------------------------- -``` -Set-UMCallAnsweringRule -Name MyCallAnsweringRule -Priority 2 -Mailbox tonysmith -TimeOfDay "3,4,8:00,12:00" -``` - -This example sets a custom period for the time of day on the call answering rule MyCallAnsweringRule in the mailbox for tonysmith and performs the following actions: - -- Sets the priority of the call answering rule to 2. - -- If the caller reaches voice mail and the time is between 8:00 A.M. and 12:00 P.M. on Tuesday, ask the caller to call back later. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CallerIds -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallersCanInterruptGreeting -The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CheckAutomaticReplies -The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionsDialed -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyMappings -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule will be changed. The default is the user's mailbox that's running the cmdlet. - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleStatus -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 - -- Free = 0x1 - -- Tentative = 0x2 - -- Busy = 0x4 - -- OutOfOffice = 0x8 - -The default setting is $null. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeOfDay -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/82f55e63-5770-433b-9a14-38f350aa5405.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/unified-messaging/Set-UMCallRouterSettings.md deleted file mode 100644 index e8c30fe3c3..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMCallRouterSettings.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-UMCallRouterSettings -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-UMCallRouterSettings - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-UMCallRouterSettings cmdlet to modify the configuration of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UMCallRouterSettings [[-Server] <ServerIdParameter>] [-Confirm] [-DialPlans <MultiValuedProperty>] - [-DomainController <Fqdn>] [-IPAddressFamily <IPv4Only | IPv6Only | Any>] - [-IPAddressFamilyConfigurable <$true | $false>] [-MaxCallsAllowed <Int32>] [-SipTcpListeningPort <Int32>] - [-SipTlsListeningPort <Int32>] [-UMStartupMode <TCP | TLS | Dual>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UMCallRouterSettings -DialPlans MySIPDialPlan -IPAddressFamily Any -Server MyUMCallRouter.northwindtraders.com -UMStartupMode TLS -``` - -This example creates the following configuration on the Exchange server named MyUMCallRouter: - -- Adds the server to the UM SIP dial plan MySIPDialPlan. - -- Enables the Microsoft Exchange Unified Messaging Call Router service to accept both IPv4 and IPv6 data packets. - -- Sets the maximum number of incoming voice, fax, auto attendant and Outlook Voice Access calls to 150. - -- Enables the Microsoft Exchange Unified Messaging Call Router service to start up using TLS mode. - -### -------------------------- Example 2 -------------------------- -``` -Set-UMCallRouterSettings -DialPlans $null -Server UMCallRouter001.contoso.com -``` - -This example removes the Exchange server named UMCallRouter001 from all UM SIP dial plans. - -## PARAMETERS - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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 -``` - -### -DialPlans -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: IPv4Only | IPv6Only | Any -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressFamilyConfigurable -The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCallsAllowed -This parameter has been deprecated and is no longer used. - -```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: False -Accept wildcard characters: False -``` - -### -Server -The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name - -- FQDN - -- Distinguished name (DN) - -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SipTcpListeningPort -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, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SipTlsListeningPort -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, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMStartupMode -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: TCP | TLS | Dual -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d7436ccb-4efd-465f-981a-f487e158cbf3.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMIPGateway.md b/exchange/exchange-ps/exchange/unified-messaging/Set-UMIPGateway.md deleted file mode 100644 index 63b2b52658..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMIPGateway.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-UMIPGateway -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-UMIPGateway - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-UMIPGateway cmdlet to modify the configuration settings for a single Unified Messaging (UM) IP gateway or to return a list of configuration settings that can be modified on a specified UM IP gateway. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UMIPGateway [-Identity] <UMIPGatewayIdParameter> [-Address <UMSmartHost>] [-Confirm] - [-DelayedSourcePartyInfoEnabled <$true | $false>] [-DomainController <Fqdn>] [-ForceUpgrade] - [-MessageWaitingIndicatorAllowed <$true | $false>] [-Name <String>] [-OutcallsAllowed <$true | $false>] - [-Port <Int32>] [-Simulator <$true | $false>] [-Status <Enabled | Disabled | NoNewCalls>] [-WhatIf] - [-IPAddressFamily <IPv4Only | IPv6Only | Any>] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -``` - -This example modifies the IP address of the UM IP gateway MyUMIPGateway. - -### -------------------------- Example 2 -------------------------- -``` -Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -Status Disabled -OutcallsAllowed $false -``` - -This example prevents the UM IP gateway from accepting incoming calls and prevents outgoing calls. - -### -------------------------- Example 3 -------------------------- -``` -Set-UMIPGateway -Identity MyUMIPGateway -Address fe80::39bd:88f7:6969:d223%11 -IPAddressFamily Any -Status Disabled -OutcallsAllowed $false -``` - -This example prevents the UM IP gateway MyUMIPGateway from accepting incoming calls and outgoing calls, sets an IPv6 address, and allows the UM IP gateway to use IPv4 and IPv6 addresses. - -### -------------------------- Example 4 -------------------------- -``` -Set-UMIPGateway -Identity MyUMIPGateway -Simulator $true -``` - -This example enables the UM IP gateway to function as an IP gateway simulator and can be used with the Test-UMConnectivity cmdlet. - -## PARAMETERS - -### -Identity -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, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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. - -```yaml -Type: UMSmartHost -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelayedSourcePartyInfoEnabled -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: $true | $false -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -This parameter is available only in on-premises Exchange. - -The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM IP gateway object is upgraded. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageWaitingIndicatorAllowed -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: $true | $false -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 -``` - -### -Name -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutcallsAllowed -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: $true | $false -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 -``` - -### -Port -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Simulator -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: $true | $false -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 -``` - -### -Status -The Status parameter specifies whether to enable or disable the UM IP gateway. - -```yaml -Type: Enabled | Disabled | NoNewCalls -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -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 will only use IPv4 to communicate. If set to IPv6Only, the UM IP gateway will only use IPv6. If set to Any, IPv6 will be used first, and then if necessary, it will fall back to IPv4. The default is IPv4Only. - -```yaml -Type: IPv4Only | IPv6Only | Any -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1c9ecde5-36ec-42af-be9e-10eacdc98458.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailbox.md b/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailbox.md deleted file mode 100644 index 8a62b9dd4a..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailbox.md +++ /dev/null @@ -1,539 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-UMMailbox -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-UMMailbox - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-UMMailbox cmdlet to set the Unified Messaging (UM) properties for a user who is currently UM-enabled. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UMMailbox [-Identity] <MailboxIdParameter> [-AirSyncNumbers <MultiValuedProperty>] - [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] - [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm | Mp3>] - [-CallAnsweringRulesEnabled <$true | $false>] [-Confirm] [-DomainController <Fqdn>] - [-FaxEnabled <$true | $false>] [-IgnoreDefaultScope] [-MissedCallNotificationEnabled <$true | $false>] - [-Name <String>] [-OperatorNumber <String>] [-PhoneNumber <String>] [-PhoneProviderId <String>] - [-PinlessAccessToVoiceMailEnabled <$true | $false>] [-PlayOnPhoneEnabled <$true | $false>] - [-SubscriberAccessEnabled <$true | $false>] [-TUIAccessToCalendarEnabled <$true | $false>] - [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <MailboxPolicyIdParameter>] - [-UMSMSNotificationOption <None | VoiceMail | VoiceMailAndMissedCalls>] [-VerifyGlobalRoutingEntry] [-WhatIf] - [-ImListMigrationCompleted <$true | $false>] [-VoiceMailAnalysisEnabled <$true | $false>] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UMMailbox -Identity tony@contoso.com -CallAnsweringAudioCodec Wma -CallAnsweringRulesEnabled $false -FaxEnabled $false -UMSMSNotificationOption VoiceMail -``` - -This example configures a UM-enabled user, tony@contoso.com with the following settings: - -Changes the call answering audio codec to Wma - -Disables call answering rules - -Prevents him from receiving incoming faxes - -Enables voice mail notifications but not missed call notifications using text messaging - -### -------------------------- Example 2 -------------------------- -``` -Set-UMMailbox -Identity tony@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false -``` - -This example prevents the user tony@contoso.com from accessing his calendar and email when he's using Outlook Voice Access. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user to enable for Unified Messaging. The values for this parameter include the following: - -- ADObjectID - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- User principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AirSyncNumbers -This parameter is available or functional only in Exchange Server 2010. - -The AirSyncNumbers parameter specifies whether to register a mobile phone number with a hosted voice mail service. Each UM mailbox can have up to three numbers defined and numbers must be in E.164 format. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUMCallsFromNonUsers -The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from directory searches. - -```yaml -Type: None | SearchEnabled -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 -``` - -### -AnonymousCallersCanLeaveMessages -The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message. - -```yaml -Type: $true | $false -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 -``` - -### -AutomaticSpeechRecognitionEnabled -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: $true | $false -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 -``` - -### -CallAnsweringAudioCodec -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: G711 | Wma | Gsm | Mp3 -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 -``` - -### -CallAnsweringRulesEnabled -The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -FaxEnabled -The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MissedCallNotificationEnabled -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. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatorNumber -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -This parameter is available only in the cloud-based service. - -The PhoneNumber parameter specifies whether to assign a phone number to a UM-enabled user. This is only used for E.164 consumer dial plans. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneProviderId -This parameter is available only in the cloud-based service. - -The PhoneProviderId parameter specifies the user's phone number and mobile service provider. This information is used to provide custom call forwarding and cancelling voice mail setup instructions based on the mobile phone provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PinlessAccessToVoiceMailEnabled -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: $true | $false -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 -``` - -### -PlayOnPhoneEnabled -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: $true | $false -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 -``` - -### -SubscriberAccessEnabled -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: $true | $false -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 -``` - -### -TUIAccessToCalendarEnabled -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: $true | $false -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 -``` - -### -TUIAccessToEmailEnabled -The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true. - -```yaml -Type: $true | $false -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 -``` - -### -UMMailboxPolicy -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMSMSNotificationOption -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: None | VoiceMail | VoiceMailAndMissedCalls -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 -``` - -### -VerifyGlobalRoutingEntry -This parameter is available only in the cloud-based service. - -The VerifyGlobalRoutingEntry parameter specifies the phone number has been successfully registered in the global routing database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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 -``` - -### -ImListMigrationCompleted -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. - -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://go.microsoft.com/fwlink/p/?LinkID=313550). - -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/dd7b429d-53a8-46dd-b16b-3a8ca8424bbc.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailboxPIN.md b/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailboxPIN.md deleted file mode 100644 index 76b7c8b90b..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMMailboxPIN.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-UMMailboxPIN -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# Set-UMMailboxPIN - -## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Use the Set-UMMailboxPIN cmdlet to reset the PIN for a Unified Messaging (UM)-enabled mailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UMMailboxPIN [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] [-IgnoreDefaultScope] - [-LockedOut <$true | $false>] [-NotifyEmail <String>] [-Pin <String>] [-PINExpired <$true | $false>] - [-SendEmail <$true | $false>] [-WhatIf] [<CommonParameters>] -``` - -## 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. - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UMMailboxPIN -Identity tonysmith@contoso.com -``` - -This example resets the PIN on the UM-enabled mailbox for tonysmith@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -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. - -### -------------------------- Example 3 -------------------------- -``` -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. - -### -------------------------- Example 4 -------------------------- -``` -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. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the UM-enabled user PIN being set. The values for this parameter include the following: - -- ADObjectID - -- GUID - -- Distinguished name (DN) - -- Domain\\Account - -- user principal name (UPN) - -- LegacyExchangeDN - -- SmtpAddress - -- Alias - -```yaml -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 -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: $true | $false -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 -``` - -### -NotifyEmail -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pin -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, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PINExpired -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: $true | $false -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 -``` - -### -SendEmail -The SendEmail parameter specifies whether to send a PIN to the user in an email message. The default is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PINExpired -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: $true | $false -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bd068710-2375-4ce4-96ee-79e76608ebaa.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Set-UMService.md b/exchange/exchange-ps/exchange/unified-messaging/Set-UMService.md deleted file mode 100644 index cfbd38726d..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Set-UMService.md +++ /dev/null @@ -1,422 +0,0 @@ ---- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-UMService -schema: 2.0.0 -monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Set-UMService - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Set-UMService cmdlet to modify the properties of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UMService [-Identity] <UMServerIdParameter> [-Confirm] [-DialPlans <MultiValuedProperty>] - [-DomainController <Fqdn>] [-GrammarGenerationSchedule <ScheduleInterval[]>] - [-IPAddressFamily <IPv4Only | IPv6Only | Any>] [-IPAddressFamilyConfigurable <$true | $false>] - [-IrmLogEnabled <$true | $false>] [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] - [-IrmLogMaxFileSize <ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>] [-MaxCallsAllowed <Int32>] - [-SIPAccessService <ProtocolConnectionSettings>] [-Status <Enabled | Disabled | NoNewCalls>] - [-UMStartupMode <TCP | TLS | Dual>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UMService -Identity MyUMServer -IPAddressFamily Any -UMStartupMode Dual -``` - -This example performs the following actions: - -- Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to accept both IPv4 and IPv6 data packets. - -- Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to start up using both TCP and TLS mode. - -### -------------------------- Example 2 -------------------------- -``` -Set-UMService -Identity MyUMServer -DialPlans $null -``` - -This example removes the Mailbox server MyUMServer from all UM dial plans. - -### -------------------------- Example 3 -------------------------- -``` -Set-UMService -Identity MyUMServer -DialPlans MySIPDialPlan -MaxCallsAllowed 50 -SipAccessService northamerica.lyncpoolna.contoso.com -UMStartupMode TLS -``` - -This example performs the following actions: - -- Adds the Mailbox server MyUMServer to the UM dial plan MySIPDialPlan. - -- Sets the maximum number of incoming calls to 50. - -- Sets northamerica.lyncpoolna.contoso.com as the FQDN for the SIP access service that is used by Microsoft Lync Server or Skype for Business Server for inbound and outbound calling from remote Lync or Skype for Business clients. - -- Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to start up in TLS mode. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Exchange server that hosts the Unified Messaging service that you want to modify. For example: - -You can use any value that uniquely identifies the Exchange server. For example: - -- Name - -- Distinguished name (DN) - -- ExchangeLegacyDN - -- GUID - -```yaml -Type: UMServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DialPlans -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. - -You can also use this parameter to associate Exchange 2010 Unified Messaging servers to a UM dial plan. - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrammarGenerationSchedule -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. - -```yaml -Type: ScheduleInterval[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: IPv4Only | IPv6Only | Any -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressFamilyConfigurable -The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogEnabled -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 - -- $false: Disable IRM logging - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogMaxAge -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. - -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 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogMaxDirectorySize -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) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogMaxFileSize -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) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -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. - -```yaml -Type: ByteQuantifiedSize -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmLogPath -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 IrmLogEnabledparameter is $true, generates errors in 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCallsAllowed -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, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SIPAccessService -The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server pool or Skype for Business Server pool location for inbound and outbound calls from remote Lync or Skype for Business users located outside of the network. When this parameter isn't set, the Microsoft Exchange Unified Messaging service may select a Lync Server pool or Skype for Business Server pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user. - -This parameter is optional when you're configuring Unified Messaging with single Lync Server pool or Skype for Business Server pool deployments. However, for Lync Server or Skype for Business Server deployments that span multiple geographic regions, it's recommended that you specify this parameter. This parameter is set on a per-Unfined Messaging service basis and must point to the Lync Server pool or Skype for Business Server pool that is located the closest geographically to the Exchange server. - -```yaml -Type: ProtocolConnectionSettings -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -This parameter has been deprecated and is no longer used. - -```yaml -Type: Enabled | Disabled | NoNewCalls -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMStartupMode -The UMStartupMode parameter specifies the startup mode for the Unified Messaging service. Valid values are: - -- TCP (This is the 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. - -If you change the value of this parameter, you need to restart the Unified Messaging service. - -```yaml -Type: TCP | TLS | Dual -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2013, Exchange 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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/daa3a3f4-fff6-407e-b83e-496728f0f1e4.aspx) diff --git a/exchange/exchange-ps/exchange/unified-messaging/Test-ExchangeUMCallFlow.md b/exchange/exchange-ps/exchange/unified-messaging/Test-ExchangeUMCallFlow.md deleted file mode 100644 index 5921df753f..0000000000 --- a/exchange/exchange-ps/exchange/unified-messaging/Test-ExchangeUMCallFlow.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Exchange.UM.TroubleshootingTool.dll-Help.xml -Module Name: Microsoft.Exchange.UM.TroubleshootingTool.dll -online version: https://technet.microsoft.com/library/2616c271-82cb-495e-97dc-d789a5f7a41f.aspx -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016" ---- - -# Test-UMConnectivity - -## SYNOPSIS -**Note**: The Test-ExchangeUMCallFlow cmdlet (the Exchange UM Troubleshooting Tool) isn't included in Microsoft Exchange. You need to download the Exchange UM Troubleshooting Tool from the Microsoft Download Center. For more information, see [Unified Messaging Troubleshooting Tool](https://go.microsoft.com/fwlink/p/?linkId=182625). - -Use the Test-ExchangeUMCallFlow cmdlet to test call flow between the Microsoft Exchange Unified Messaging Call Router service (frontend), the Microsoft Exchange Unified Messaging service (backend), VoIP gateways, IP PBXs, Session Initiation Protocol (SIP) servers and Lync Server or Skype for Business servers. The Test-ExchangeUMCallFlow cmdlet can be used to diagnose configuration errors found in telephony components, Unified Messaging settings in Exchange 2010 SP1 or later, and connectivity issues between on-premises and hybrid Unified Messaging deployments. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Set1 -``` -Test-ExchangeUMCallFlow -Mode <Gateway> -Diversion <String> -NextHop <String> [-CertificateThumbprint <String>] [-HuntGroup <String>] [-VoIPSecurity <Unsecured | SIPSecured | Secured> - <CommonParameters>] -``` - -### Set2 -``` -Test-ExchangeUMCallFlow -Mode <SIPClient> -CalledParty <String> -CallingParty <String> -NextHop <String> [-Credential <PSCredential>] - [<CommonParameters>] -``` - -## DESCRIPTION -The UM Troubleshooting Tool is an Exchange Management Shell cmdlet named Test-ExchangeUMCallFlow. You can use this cmdlet to diagnose configuration errors specific to call answering scenarios to test whether voice mail is functioning correctly in both on-premises and hybrid UM deployments. The Test-ExchangeUMCallFlow cmdlet only supports testing of call answering scenarios; however, it can’t currently be used to test the following incoming call scenarios: - -- Incoming calls to a UM auto attendant. - -- Incoming calls to an Outlook Voice Access number as an unauthenticated user. - -- Incoming calls to an Outlook Voice Access number as an authenticated Outlook Voice Access user. - -You can use this cmdlet in deployments with Lync Server or Skype for Business Server in UM deployments with VoIP gateways or IP PBXs. - -When you run the cmdlet, it states the reason and possible solutions for issues that have been detected. It also outputs general audio quality metrics for diagnosing audio quality issues related to network connectivity such as jitter and average packet loss. The Test-ExchangeUMCallFlow cmdlet supports testing UM components and services in Secured, SIP Secured, and Unsecured calls, and it can be run either in Gateway or SIPClient modes. - -**Important**: You use the Test-ExchangeUMCallFlow cmdlet to test only the voice mail functionality of an Exchange server. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-ExchangeUMCallFlow -Mode Gateway -VoIPSecurity Unsecured -NextHop 10.1.1.1 -Diversion 12345 -``` - -This example uses Gateway mode and tests the call flow in a non-Skype for Business environment. This example sets the VoIP security mode to Unsecured, uses the IP address 10.1.1.1 as the next hop, and includes an extension number in the diversion information. - -### -------------------------- Example 2 -------------------------- -``` -Test-ExchangeUMCallFlow -Mode SIPClient -CallingParty tony@contoso.com -CalledParty david@contoso.com -Credential $get -``` - -This example uses SIPClient mode and tests the call flow with a Secured UM dial plan in an environment that contains servers running Skype for Business. By default, when you run the cmdlet, the cmdlet uses the credentials of the user currently logged onto the computer. - -### -------------------------- Example 3 -------------------------- -``` -Test-ExchangeUMCallFlow -Mode Gateway -VoIPSecurity Secured -CertificateThumbprint a909502dd82ae41433e6f83886b00d4277a32a7b -NextHop gateway.contoso.com -HuntGroup 10000 -Diversion "History-Info: <sip:10001@10.176.10.194;user=phone?Reason=SIP%3Bcause%3D487%3Btext%3DTimeout>;index=1,<sip:10000@10.176.10.194;user=phone?Reason=SIP>;index=1.1" -``` - -This example uses Gateway mode and tests the call flow in a non-Skype for Business environment. This example sets the VoIP security mode to Secured, uses the IP address 10.176.10.194 as the next hop, and includes diversion information. - -## PARAMETERS - -### -Mode -The Mode parameter specifies whether the deployment being tested includes VoIP gateways, IP PBX, or Lync or Skype for Business servers. Valid values are: - -- Gateway: The UM deployment includes VoIP gateways or IP PBXs. - -- SIPClient: The UM deployment includes Lync or Skype for Business server. - -```yaml -Type: Gateway | SIPClient -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalledParty -The CalledParty parameter specifies the SIP URI of the Lync or Skype for Business user that has been enabled for the Enterprise Voice user that the Test-ExchangeUMCallFlow cmdlet will make the voice call to, for example: -CalledParty tonysmith@contoso.com. Use this parameter if you're running the tool in SIPClient mode. - -```yaml -Type: String -Parameter Sets: Set2 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingParty -The CallingParty parameter specifies the SIP URI of the Lync or Skype for Business user that has been enabled for the Enterprise Voice user who's making the incoming call, for example: -CallingParty tonysmith@contoso.com. Use this parameter if you're running the tool in SIPClient mode. - -```yaml -Type: String -Parameter Sets: Set2 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Diversion -The Diversion parameter specifies the string that should be sent as diversion information for the incoming call. This can be in the form of a Diversion or History-Info header. The diversion information can be either an extension number or also include additional diversion information. - -When you provide diversion information as a History-Info header, verify the following: - -- There are at least two different entries with different user parts. - -- The last entry should contain the user's associated UM dial plan pilot number. - -- The second to last entry should include the UM-enabled user's extension number. This entry must also include the appropriate Reason text. This text must be properly escaped in accordance with standard URL parameter escaping rules. - -```yaml -Type: String -Parameter Sets: Set1 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHop -The NextHop parameter specifies the IP address or fully qualified domain name (FQDN) and can also include the TCP port of the next hop that the Test-ExchangeUMCallFlow cmdlet connects to while emulating the VoIP gateway or IP PBX. When you include the TCP port, you need to include either port 5060 for Unsecured mode or port 5061 for Secured or SIPSecured mode, for example: gateway.contoso.com:5061. - -If you're using the cmdlet in a hybrid environment, you need to enter the FQDN of the Session Border Controller (SBC). - -If you're using the cmdlet in an on-premises environment, you need to use the FQDN of one of the following types of servers: - -- An Exchange 2013 or later Mailbox server that's running the Unified Messaging service. - -- An Exchange 2010 SP1 or later Unified Messaging server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -The CertificateThumbprint parameter specifies the thumbprint of the certificate used for Transport Layer Security (TLS). This is required if either the SIPSecured or Secured mode is configured on the UM dial plan. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. - -This certificate thumbprint is the certificate that was exported from the VoIP gateway, IP Private Branch eXchange (PBX), or Session Border Controller (SBC). Also, the computer that has the UM Troubleshooting Tool installed and is being used to test for call flow must trust the next hop's certificate of authority. - -```yaml -Type: String -Parameter Sets: Set1 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the credentials that will be used to run the cmdlet. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: Set2 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HuntGroup -The HuntGroup parameter specifies the UM hunt group associated with the VoIP gateway being emulated. This is typically an extension number. Use this parameter if you're running the tool in Gateway mode. - -```yaml -Type: String -Parameter Sets: Set1 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VoIPSecurity -The VoIPSecurity parameter specifies the security mode when using the cmdlet in Gateway mode. You can use one of the following Voice over IP (VoIP) security modes: - -- Unsecured (TCP/RTP) (default) - -- SIPSecured (TLS/RTP) - -- Secured (TLS/SRTP) - -```yaml -Type: Unsecured | SIPSecured | Secured -Parameter Sets: Set1 -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2616c271-82cb-495e-97dc-d789a5f7a41f.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Add-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/users-and-groups/Add-UnifiedGroupLinks.md deleted file mode 100644 index fe9746b4b2..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Add-UnifiedGroupLinks.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online, Exchange Online Protection -title: Add-UnifiedGroupLinks -schema: 2.0.0 -monikerRange: "exchonline-ps || eop-ps" ---- - -# Add-UnifiedGroupLinks - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Add-UnifiedGroupLinks cmdlet to add members, owners and subscribers to Office 365 groups in your cloud-based organization. To remove members, owners and subscribers, use the Remove-UnifiedGroupLinks cmdlet. To modify other properties of Office 365 groups, use the Set-UnifiedGroup cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Add-UnifiedGroupLinks [-Identity] <UnifiedGroupIdParameter> -Links <RecipientIdParameter[]> - -LinkType <Members | Owners | Subscribers | Aggregators | EventSubscribers> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 groups are group objects that are available across Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-UnifiedGroupLinks -Identity "Legal Department" -LinkType Members -Links chris@contoso.com,michelle@contoso.com -``` - -This example adds members chris@contoso.com and michelle@contoso.com to the Office 365 Group named Legal Department. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Office 365 Group that you want to modify. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Links -The Links parameter specifies the recipients to add to the Office 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkType -The LinkType parameter specifies the Office 365 Group property that you want to modify. Valid values are: - -- EventSubscribers - -- Members - -- Owners - -- Subscribers - -```yaml -Type: Members | Owners | Subscribers | Aggregators | EventSubscribers -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0d7e03d4-b2dc-4a0b-865a-9ff33e53e221.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Disable-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Disable-DistributionGroup.md deleted file mode 100644 index 5772c0c2c6..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Disable-DistributionGroup.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-DistributionGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-DistributionGroup - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-DistributionGroup cmdlet to remove email capabilities from existing mail-enabled security groups and distribution groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-DistributionGroup [-Identity] <DistributionGroupIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-DistributionGroup -Identity "Distribution Group1" -``` - -This example mail-disables the distribution group named Distribution Group1. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4e042d49-0cec-4b7d-aa64-fc9605077714.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Disable-MailContact.md b/exchange/exchange-ps/exchange/users-and-groups/Disable-MailContact.md deleted file mode 100644 index 61b7ec276e..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Disable-MailContact.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailContact -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-MailContact - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-MailContact cmdlet to remove email capabilities from existing mail contacts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-MailContact [-Identity] <MailContactIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-MailContact -Identity "EdMeadows" -``` - -This example mail-disables the mail contact named Ed Meadows. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailContactIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/3c957be4-d13e-45c3-8730-3be45ffad19a.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Disable-MailUser.md b/exchange/exchange-ps/exchange/users-and-groups/Disable-MailUser.md deleted file mode 100644 index e96dfdbfdb..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Disable-MailUser.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailUser -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Disable-MailUser - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Disable-MailUser cmdlet to remove email capabilities from existing mail users. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Disable-MailUser [-Identity] <MailUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-IgnoreDefaultScope] - [-IgnoreLegalHold] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Disable-MailUser -Identity markus@contoso.com -``` - -This example mail-disables an existing mail user. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 -``` - -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. - -After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/62ebb096-f227-4dbe-a158-791577a79b23.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Enable-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Enable-DistributionGroup.md deleted file mode 100644 index 4ba416572e..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Enable-DistributionGroup.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-DistributionGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019" ---- - -# Enable-DistributionGroup - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Enable-DistributionGroup cmdlet to mail-enable existing universal security groups and universal distribution groups that aren't already mail-enabled. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Enable-DistributionGroup [-Identity] <GroupIdParameter> [-Alias <String>] [-Confirm] [-DisplayName <String>] - [-DomainController <Fqdn>] [-PrimarySmtpAddress <SmtpAddress>] [-WhatIf] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Enable-DistributionGroup -Identity "Distribution Group1" -``` - -This example mail-enables the universal distribution group named Distribution Group1. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: GroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -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 -``` - -### -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 -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -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 -``` - -### -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 -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of this group won't be automatically updated by email address policies. - -```yaml -Type: SmtpAddress -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 -``` - -### -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 - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7a218aaf-5858-48d6-885d-5eed12885c44.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-Contact.md b/exchange/exchange-ps/exchange/users-and-groups/Get-Contact.md deleted file mode 100644 index 2ce2ad400f..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-Contact.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-Contact cmdlet to view existing contact objects in your organization. This cmdlet returns contacts and mail contacts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-Contact [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-Contact [[-Identity] <ContactIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Contact -``` - -This example returns a summary list of all contacts in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-Contact -Identity MarkusBreyer | Format-List -``` - -This example returns detailed information for the contact named Markus Breyer. - -### -------------------------- Example 3 -------------------------- -``` -Get-Contact -Anr Markus* -RecipientTypeDetails MailContact -``` - -This example uses the Anr parameter to retrieve all mail-enabled contacts whose names start with Markus. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the contact that you want to view. You can use any value that uniquely identifies the contact. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: ContactIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified contact subtype. Valid values are: - -- Contact - -- MailContact - -- MailForestContact - -You can specify multiple values separated by commas. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- City - -- FirstName - -- LastName - -- Office - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/59315afb-fab5-4984-b3a1-ba1f82df8a10.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Get-DistributionGroup.md deleted file mode 100644 index bc17afb0d6..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-DistributionGroup.md +++ /dev/null @@ -1,385 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-DistributionGroup cmdlet to view existing distribution groups or mail-enabled security groups. To view the members of a group, use the Get-DistributionGroupMember cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-DistributionGroup [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-DistributionGroup [[-Identity] <DistributionGroupIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### ManagedBySet -``` -Get-DistributionGroup [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-ManagedBy <GeneralRecipientIdParameter>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DistributionGroup -``` - -This examples returns a summary list of all distribution groups and mail-enabled security groups in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DistributionGroup -Identity "Marketing Reports" | Format-List -``` - -This example returns detailed information about the distribution group named Marketing Reports. - -### -------------------------- Example 3 -------------------------- -``` -Get-DistributionGroup -Anr marketing | Format-Table Name, ManagedBy -Auto -``` - -This example returns all distribution groups and mail-enabled security groups whose names contain the string "marketing" and shows the group owners. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to view. You can use any values that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified distribution group subtype. Valid values are: - -- MailNonUniversalGroup - -- MailUniversalDistributionGroup - -- MailUniversalSecurityGroup - -- RoomList - -You can specify multiple values separated by commas. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -- City - -- FirstName - -- LastName - -- Office - -- ServerLegacyDN - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d84f5670-f3ac-4d63-a6ac-af9de67677c5.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-DistributionGroupMember.md b/exchange/exchange-ps/exchange/users-and-groups/Get-DistributionGroupMember.md deleted file mode 100644 index 45b5a773b2..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-DistributionGroupMember.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-DistributionGroupMember [-Identity] <DistributionGroupMemberIdParameter> [-Credential <PSCredential>] - [-DomainController <Fqdn>] [-IgnoreDefaultScope] [-ReadFromDomainController] [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## DESCRIPTION -If your organization has multiple Active Directory domains, you may need to run the Set-ADServerSettings cmdlet with the ViewEntireForest parameter set to $true before running the Get-DistributionGroupMember cmdlet to view the entire forest. For more information, see Example 2. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DistributionGroupMember -Identity "Marketing USA" -``` - -This example returns the existing distribution group members for the distribution group named Marketing USA. - -### -------------------------- Example 2 -------------------------- -``` -Set-ADServerSettings -ViewEntireForest $true; Get-DistributionGroupMember -Identity "Marketing Worldwide" -``` - -This example sets the scope of the search to the entire forest by running the Set-ADServerSettings cmdlet, then the Get-DistributionGroupMember cmdlet searches the entire forest for the distribution group members in the Marketing Worldwide distribution group. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/15c71bc5-4246-44ac-8b34-8ccd585294b5.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Get-DynamicDistributionGroup.md deleted file mode 100644 index de0dfa5126..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-DynamicDistributionGroup.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DynamicDistributionGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Get-DynamicDistributionGroup cmdlet to view existing dynamic distribution groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-DynamicDistributionGroup [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-IncludeSystemObjects] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-DynamicDistributionGroup [[-Identity] <DynamicGroupIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-IncludeSystemObjects] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### ManagedBySet -``` -Get-DynamicDistributionGroup [-ManagedBy <GeneralRecipientIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-IncludeSystemObjects] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] [-ResultSize <Unlimited>] - [-SortBy <String>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-DynamicDistributionGroup -``` - -This example returns a summary list of all dynamic distribution groups in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-DynamicDistributionGroup -Identity "Marketing Department" | Format-List -``` - -This example returns detailed information about the dynamic distribution group named Marketing Department. - -### -------------------------- Example 3 -------------------------- -``` -Get-DynamicDistributionGroup -Anr *research* | Format-Table Name, ManagedBy -Auto -``` - -This example returns all dynamic distribution groups whose names contain the string "research" and shows the group owners. - -### -------------------------- Example 4 -------------------------- -``` -$FTE = Get-DynamicDistributionGroup "Full Time Employees"; Get-Recipient -RecipientPreviewFilter $FTE.RecipientFilter -OrganizationalUnit $FTE.RecipientContainer -``` - -This example returns the members for the dynamic distribution group named Full Time Employees. The first command stores the dynamic distribution group object in the variable $FTE. The second command uses the Get-Recipient cmdlet to list the recipients that match the criteria defined for the dynamic distribution group. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DynamicGroupIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSystemObjects -This parameter is available only in on-premises Exchange. - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -ManagedBy -The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: GeneralRecipientIdParameter -Parameter Sets: ManagedBySet -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 -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d97ee738-dfa1-464b-855a-4242e8065473.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md deleted file mode 100644 index 1ec7bab592..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: Get-EligibleDistributionGroupForMigration -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-EligibleDistributionGroupForMigration - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-EligibleDistributionGroupForMigration cmdlet to identify distribution groups that can be upgraded to Office 365 groups. You can't upgrade mail-enabled security groups to Office 365 groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity -``` -Get-EligibleDistributionGroupForMigration [[-Identity] <DistributionGroupIdParameter>] - [-Organization <OrganizationIdParameter>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -### ManagedBy -``` -Get-EligibleDistributionGroupForMigration [-ManagedBy <GeneralRecipientIdParameter>] - [-Organization <OrganizationIdParameter>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ResultSize <Unlimited>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-EligibleDistributionGroupForMigration -ResultSize unlimited -``` - -This example returns a summary list of all distribution groups that can be upgraded to Office 365 groups. - -## PARAMETERS - -### -Identity -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 an Office 365 Group. - -You can't use this parameter with the ManagedBy parameter. - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ManagedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can't use this parameter with the Identity parameter. - -```yaml -Type: GeneralRecipientIdParameter -Parameter Sets: ManagedBy -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/ae182f13-dacb-471b-a5a3-9bedb58d3b44.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-Group.md b/exchange/exchange-ps/exchange/users-and-groups/Get-Group.md deleted file mode 100644 index 6d9ace2347..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-Group.md +++ /dev/null @@ -1,388 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-Group -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Get-Group cmdlet to view existing group objects in your organization. This cmdlet returns security groups, mail-enabled security groups, distribution groups, and role groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-Group [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-Group [[-Identity] <GroupIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Group -``` - -This example returns a summary list of all groups in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-Group -Identity "Marketing Reports" | Format-List -``` - -This example returns detailed information for the group named Marketing Reports. - -### -------------------------- Example 3 -------------------------- -``` -Get-Group -Anr Mar* -``` - -This example uses the Anr parameter to return all groups that begin with "Mar". - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- AdministrativeUnits - -- DisplayName - -- DistinguishedName - -- ExchangeVersion - -- GroupType - -- Guid - -- Id - -- IsDirSynced - -- ManagedBy - -- Name - -- Notes - -- ObjectCategory - -- ObjectClass - -- PhoneticDisplayName - -- RecipientType - -- RecipientTypeDetails - -- SamAccountName - -- Sid - -- SidHistory - -- SimpleDisplayName - -- WhenChanged - -- WhenChangedUTC - -- WhenCreated - -- WhenCreatedUTC - -- WindowsEmailAddress - -For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: GroupIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified group subtype. Valid values are: - -- MailNonUniversalGroup - -- MailUniversalDistributionGroup - -- MailUniversalSecurityGroup - -- RoomList - -You can specify multiple values separated by commas. - -```yaml -Type: RecipientTypeDetails[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/1dff448b-e4ac-45b8-9a60-2ab3b5859559.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-LinkedUser.md b/exchange/exchange-ps/exchange/users-and-groups/Get-LinkedUser.md deleted file mode 100644 index 8bb96dc0c6..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-LinkedUser.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-LinkedUser -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-LinkedUser - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-LinkedUser cmdlet to view existing linked user accounts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-LinkedUser [-Anr <String>] - [-Filter <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-LinkedUser [[-Identity] - <UserIdParameter>] - [-Filter <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-LinkedUser -``` - -This example lists all linked users in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-RemoteMailbox -Identity laura@contoso.com | Format-List -``` - -This example returns a detailed information for the linked for the user laura@contoso.com. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OrganizationalUnit -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- City - -- FirstName - -- LastName - -- Office - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7c425c78-f2eb-4971-b0d7-cfb7f67ddb17.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-MailContact.md b/exchange/exchange-ps/exchange/users-and-groups/Get-MailContact.md deleted file mode 100644 index 834e5be5f1..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-MailContact.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-MailContact cmdlet to view existing mail contacts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-MailContact [-ANR <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### Identity -``` -Get-MailContact [[-Identity] <MailContactIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailContact -``` - -This example returns a summary list of all mail contacts. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailContact -Identity Arlene | Format-List -``` - -This example retrieves detailed information for the mail contact named Arlene. - -## PARAMETERS - -### -ANR -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mail contact that you want to view. You can use any value that uniquely identifies the mail contact. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailContactIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified mail contact subtype. Valid values are: - -- MailContact - -- MailForestContact - -You can specify multiple values separated by commas. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/d254bdd5-d497-424c-97ad-d7e8f7e73c27.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-MailUser.md b/exchange/exchange-ps/exchange/users-and-groups/Get-MailUser.md deleted file mode 100644 index abc688eb99..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-MailUser.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Get-MailUser cmdlet to view mail users and also guest users for Office 365 groups in cloud environments. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-MailUser [-Anr <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SoftDeletedMailUser] - [-SortBy <String>] - [<CommonParameters>] -``` - -### Identity -``` -Get-MailUser [[-Identity] <MailUserIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-ReadFromDomainController] - [-ResultSize <Unlimited>] - [-SoftDeletedMailUser] - [-SortBy <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-MailUser -``` - -This example returns a summary list of all mail users in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-MailUser -Identity Ed | Format-List -``` - -This example returnsdetailed information for the mail user named Ed. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: -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 -Default value: None -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: -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 -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: -Parameter Sets: (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 -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: -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 -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: -Parameter Sets: (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 -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: -Parameter Sets: (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 -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -```yaml -Type: -Parameter Sets: (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 -Accept pipeline input: false -Accept wildcard characters: False -``` - -### -SoftDeletedMailUser -This parameter is available only in the cloud-based service. - -The SoftDeletedMailUser switch specifies whether to include only soft-deleted mail users in the results. You don't need to specify a value with this switch. - -This switch is required to return soft-deleted mail users. - -Soft-deleted mail users are deleted mail users that are still recoverable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/37b36f1c-95ec-4896-a08a-985ef4aa23b7.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-Recipient.md b/exchange/exchange-ps/exchange/users-and-groups/Get-Recipient.md deleted file mode 100644 index b3bf5d0eae..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-Recipient.md +++ /dev/null @@ -1,627 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-Recipient -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -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). - -In cloud environments, to return Office 365 groups, you need to use the RecipientTypeDetails parameter with the value GroupMailbox. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-Recipient [-Anr <String>] - [-AuthenticationType <Managed | Federated>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] - [-ReadFromDomainController] - [-RecipientType <RecipientType[]>] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-Capabilities <MultiValuedProperty>] - [-Database <DatabaseIdParameter>] - [-Properties <String[]>] - [-IncludeSoftDeletedRecipients] [<CommonParameters>] -``` - -### Identity -``` -Get-Recipient [[-Identity] <RecipientIdParameter>] - [-AuthenticationType <Managed | Federated>] - [-BookmarkDisplayName <String>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-IncludeBookmarkObject <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] - [-ReadFromDomainController] - [-RecipientType <RecipientType[]>] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-Capabilities <MultiValuedProperty>] - [-Properties <String[]>] - [-IncludeSoftDeletedRecipients] [<CommonParameters>] -``` - -### DatabaseSet -``` -Get-Recipient [-Database <DatabaseIdParameter>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-Properties <String[]>] - [-PropertySet <PropertySet>] - [-ReadFromDomainController] - [-RecipientType <RecipientType[]>] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-SortBy <String>] - [-IncludeSoftDeletedRecipients] [<CommonParameters>] - [<CommonParameters>] -``` - -### RecipientPreviewFilterSet -``` -Get-Recipient [-RecipientPreviewFilter <String>] - [-AuthenticationType <AuthenticationType>] - [-Capabilities <MultiValuedProperty>] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-IncludeSoftDeletedRecipients] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-Properties <String[]>] - [-PropertySet <PropertySet>] - [-ReadFromDomainController] - [-RecipientType <RecipientType[]>] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-Recipient cmdlet may not return all object-specific properties for a recipient. To view the object-specific properties for a recipient, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox, Get-MailUser, or Get-DistributionGroup). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-Recipient -ResultSize unlimited -``` - -This example retrieves as summary list of all recipients in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-Recipient -Identity "Marketing Department" | Format-List -``` - -This example returns detailed information for the recipient named Marketing Department. - -### -------------------------- Example 3 -------------------------- -``` -Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name -``` - -This example retrieves information about all the mail contacts in your organization and sorts them by office. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -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: - -- Federated - -- Managed - -```yaml -Type: Managed | Federated -Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet -Aliases: -Applicable: Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BookmarkDisplayName -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Capabilities -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -Database -This parameter is available only in on-premises Exchange. - -The Database parameter specifies a mailbox database. Use this parameter to return all recipients stored on a specific mailbox database. Use the mailbox database Name property as the value for this parameter. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: DatabaseSet -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the recipient object that you want to view. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeBookmarkObject -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False - -``` -### -IncludeSoftDeletedRecipients -The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. - -This switch is required to return soft-deleted recipients. - -Soft-deleted recipients are deleted recipients that are still recoverable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertySet -This parameter is reserved for internal Microsoft use. - -```yaml -Type: All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientPreviewFilter -The RecipientPreviewFilter parameter specifies a recipient filter that would define the recipients returned by this command. You can create a custom recipient filter for a dynamic distribution group, an address list, or an email address policy. To verify that the recipient filter you specified will return the recipients you want, you can pass the OPATH filter specified in the RecipientFilter property for that dynamic distribution group, address list, or email address policy to the RecipientPreviewFilter parameter and preview the list of recipients. - -```yaml -Type: String -Parameter Sets: RecipientPreviewFilterSet -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientType -The RecipientType parameter filters the results by the specified recipient type. Valid values are: - -- DynamicDistributionGroup - -- MailContact - -- MailNonUniversalGroup - -- MailUniversalDistributionGroup - -- MailUniversalSecurityGroup - -- MailUser - -- PublicFolder - -- UserMailbox - -You can specify multiple values separated by commas. - -```yaml -Type: RecipientType[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: - -- DiscoveryMailbox - -- DynamicDistributionGroup - -- EquipmentMailbox - -- GroupMailbox - -- GuestMailUser - -- LegacyMailbox - -- LinkedMailbox - -- LinkedRoomMailbox - -- MailContact - -- MailForestContact - -- MailNonUniversalGroup - -- MailUniversalDistributionGroup - -- MailUniversalSecurityGroup - -- MailUser - -- PublicFolder - -- PublicFolderMailbox - -- RemoteEquipmentMailbox - -- RemoteRoomMailbox - -- RemoteSharedMailbox - -- RemoteTeamMailbox - -- RemoteUserMailbox - -- RoomList - -- RoomMailbox - -- SchedulingMailbox - -- SharedMailbox - -- TeamMailbox - -- UserMailbox - -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. - -```yaml -Type: RecipientTypeDetails[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -- City - -- FirstName - -- LastName - -- Office - -- ServerLegacyDN - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2ce6250f-0ad3-4b29-870c-e1d6e1e154bc.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-SecurityPrincipal.md b/exchange/exchange-ps/exchange/users-and-groups/Get-SecurityPrincipal.md deleted file mode 100644 index 6c2c92db03..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-SecurityPrincipal.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-SecurityPrincipal -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Get-SecurityPrincipal cmdlet to return a list of security principals. Security principals are entities, such as users or security groups, which can be assigned permissions and user rights. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-SecurityPrincipal [[-Identity] <ExtendedSecurityPrincipalIdParameter>] [-DomainController <Fqdn>] - [-Filter <String>] [-IncludeDomainLocalFrom <SmtpDomain>] - [-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>] [-ResultSize <Unlimited>] [-RoleGroupAssignable] - [-Types <MultiValuedProperty>] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com -``` - -This example retrieves security principals from the People OU. - -### -------------------------- Example 2 -------------------------- -``` -Get-SecurityPrincipal -Filter {Department -eq "Legal"} -``` - -This example retrieves security principals from the Legal department by using the Filter parameter. Only security principals matching the filter condition are retrieved. - -### -------------------------- Example 3 -------------------------- -``` -Get-SecurityPrincipal -Identity Administrator -``` - -This example retrieves a single security principal explicitly specified by using the Identity parameter. - -### -------------------------- Example 4 -------------------------- -``` -Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize -``` - -This example retrieves well-known security principals and displays only the Name and SID properties in the results. - -## PARAMETERS - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```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 -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -You can filter by the following properties: - -- AdminDisplayName - -- DisplayName - -- DistinguishedName - -- ExchangeVersion - -- Guid - -- Id - -- Name - -- ObjectCategory - -- ObjectClass - -- RecipientType - -- RecipientTypeDetails - -- Sid - -- WhenChanged - -- WhenChangedUTC - -- WhenCreated - -- WhenCreatedUTC - -For more information, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned. - -```yaml -Type: ExtendedSecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeDomainLocalFrom -This parameter is available only in on-premises Exchange. - -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. - -Don't use this parameter with the Filter or Identity parameters. - -```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: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: ExtendedOrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoleGroupAssignable -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Types -The Types parameter filters the results by object type. Valid values are: - -- Computer - -- GlobalSecurityGroup - -- Group - -- UniversalSecurityGroup - -- User - -- WellknownSecurityPrincipal - -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, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/98d70e10-6972-4317-88d0-59f99845cf15.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Get-UnifiedGroup.md deleted file mode 100644 index 0a832c09d6..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-UnifiedGroup.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-UnifiedGroup -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-UnifiedGroup - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-UnifiedGroup cmdlet to view Office 365 Groups in your cloud-based organization. To view members, owners and subscribers for Office 365 Groups, use the Get-UnifiedGroupLinks cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity (Default) -``` -Get-UnifiedGroup [[-Identity] <UnifiedGroupIdParameter>] - [-Filter <String>] - [-IncludeAllProperties] - [-IncludeSoftDeletedGroups] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -### AnrSet -``` -Get-UnifiedGroup [-Anr <String>] - [-Filter <String>] - [-IncludeAllProperties] - [-IncludeSoftDeletedGroups] - [-ResultSize <Unlimited>] - [-SortBy <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 Groups are group objects that are available across Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UnifiedGroup -``` - -This example returns a summary list of all Office 365 Groups. - -### -------------------------- Example 2 -------------------------- -``` -Get-UnifiedGroup | Format-List DisplayName,EmailAddresses,Notes,ManagedBy,AccessType -``` - -This example returns the following information about all Office 365 Groups: - -- Display name - -- Email address - -- Description - -- Owners - -- Privacy - -### -------------------------- Example 3 -------------------------- -``` -Get-UnifiedGroup -Identity "Marketing Department" | Format-List -``` - -This example returns detailed information about the Office 365 Group named Marketing Department. - -## PARAMETERS - -### -Anr -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: AnrSet -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}. - -- \<Property\> is a filterable property. - -- -\<Comparison Operator\> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about\_Comparison\_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712). - -- \<Value\> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('\<Value\>'). Don't use quotation marks with integers or the system values $true, $false, or $null. - -You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the Office 365 Group that you want to view. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IncludeAllProperties -The IncludeAllProperties switch specifies whether to include the values of all properties in the results. You don't need to specify a value with this switch. - -If you don't use this switch, the values of some properties (for example, CalendarMemeberReadOnly, CalendarUrl, InboxUrl, PeopleUrl, and PhotoUrl) might appear blank. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSoftDeletedGroups -The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted Office 365 Groups in the results. You don't need to specify a value with this switch. - -This switch is required to return soft-deleted Office 365 Groups. - -Soft-deleted Office 365 Groups are deleted groups that are still recoverable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortBy -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- Alias - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9ff9204a-cc18-4e39-9159-1d16314217cd.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/users-and-groups/Get-UnifiedGroupLinks.md deleted file mode 100644 index fcf5ff2a7d..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-UnifiedGroupLinks.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Get-UnifiedGroupLinks -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Get-UnifiedGroupLinks - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-UnifiedGroupLinks cmdlet to view membership and ownership information for Office 365 groups in your cloud-based organization. To view other properties for Office 365 groups, use the Get-UnifiedGroup cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Get-UnifiedGroupLinks [-Identity] <UnifiedGroupIdParameter> - -LinkType <Members | Owners | Subscribers | Aggregators> [-ResultSize <Unlimited>] - [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 groups are group objects that are available across Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-UnifiedGroupLinks -Identity "Human Resources Department" -LinkType Members -``` - -This example show the members of the Office 365 Group named Human Resources Department - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Office 365 Group that you want to view. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -LinkType -The LinkType parameter specifies the Office 365 Group property that you want to view. Valid values are: - -- Members - -- Owners - -- Subscribers - -```yaml -Type: Members | Owners | Subscribers | Aggregators | EventSubscribers -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/b7f00aad-61ae-4ca8-8a3d-9efd28bbbbd0.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-User.md b/exchange/exchange-ps/exchange/users-and-groups/Get-User.md deleted file mode 100644 index 016570a0e8..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-User.md +++ /dev/null @@ -1,473 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -title: Get-User -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || o365scc-ps || eop-ps" ---- - -# 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. - -Use the Get-User cmdlet to view existing user objects in your organization. This cmdlet returns all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### AnrSet -``` -Get-User [-Anr <String>] - [-Arbitration] - [-AuditLog] - [-AuxAuditLog] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-Sortby <String>] - [<CommonParameters>] -``` - -### Identity -``` -Get-User [[-Identity] <UserIdParameter>] - [-Arbitration] - [-AuditLog] - [-AuxAuditLog] - [-Credential <PSCredential>] - [-DomainController <Fqdn>] - [-Filter <String>] - [-IgnoreDefaultScope] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PublicFolder] - [-ReadFromDomainController] - [-RecipientTypeDetails <RecipientTypeDetails[]>] - [-ResultSize <Unlimited>] - [-Sortby <String>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-User -ResultSize unlimited -``` - -This example returns a summary list of all users in your organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-User -Identity "Coy Damon" | Format-List -``` - -This example returns detailed information for the user named Coy Damon. - -### -------------------------- Example 3 -------------------------- -``` -Get-User -OrganizationalUnit "Marketing" -``` - -This example retrieves information about users in the Marketing OU. - -### -------------------------- Example 4 -------------------------- -``` -Get-User -Filter "Title -like '*Manager'" -``` - -This example uses the Filter parameter to retrieve information about all users that have the word Manager at the end of their title. - -## PARAMETERS - -### -Anr -The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - -- CommonName (CN) - -- DisplayName - -- FirstName - -- LastName - -- Alias - -```yaml -Type: String -Parameter Sets: AnrSet -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration switch filters the results by arbitration mailboxes. You don't need to specify a value with this switch. - -Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. - -Notes: - -- If you don't use this switch, the command can't find arbitration mailboxes. - -- To return arbitration mailboxes that are used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditLog -This parameter is available only in on-premises Exchange. - -The AuditLog switch filters the results by arbitration mailboxes that are used to store audit log settings. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't return this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuxAuditLog -This parameter is available only in on-premises Exchange. - -The AuxAuditLog switch filters the results by arbitration mailboxes that are used to store audit log data. You don't need to specify a value with this switch. - -Notes: - -- If you don't use this switch, the command can't find this type of arbitration mailbox. - -- The Arbitration switch doesn't return this type of arbitration mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter is available only in on-premises Exchange. - -The Credential parameter specifies the user name 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://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The Filter parameter indicates the OPath filter used to filter recipients. - -For more information about the filterable properties, see Filterable properties for the -Filter parameter (https://technet.microsoft.com/library/bb738155.aspx). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```yaml -Type: OrganizationalUnitIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -The PublicFolder switch specifies that the user object for which you're executing the command is a public folder mailbox. You don't need to specify a value with this switch. - -Public folder mailboxes are specially designed mailboxes to store the hierarchy and content of public folders. This switch is required to retrieve information for a public folder mailbox. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadFromDomainController -This parameter is available only in on-premises Exchange. - -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. - -By default, the recipient scope is set to the domain that hosts your Exchange servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientTypeDetails -The RecipientTypeDetails parameter filters the results by the specified user subtype. Valid values are: - -- DisabledUser - -- DiscoveryMailbox - -- EquipmentMailbox - -- GuestMailUser - -- LegacyMailbox - -- LinkedMailbox - -- LinkedUser - -- MailUser - -- PublicFolderMailbox - -- RemoteEquipmentMailbox - -- RemoteRoomMailbox - -- RemoteSharedMailbox - -- RemoteTeamMailbox - -- RemoteUserMailbox - -- RoomMailbox - -- SchedulingMailbox - -- SharedMailbox - -- TeamMailbox - -- User - -- UserMailbox - -You can specify multiple values separated by commas. - -```yaml -Type: RecipientTypeDetails[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sortby -The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. - -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. - -You can sort by the following properties: - -- Name - -- DisplayName - -- City - -- FirstName - -- LastName - -- Office - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/2a33c9e6-33da-438c-912d-28ce3f4c9afb.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/New-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/New-DistributionGroup.md deleted file mode 100644 index 36e74b5cf2..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/New-DistributionGroup.md +++ /dev/null @@ -1,664 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the New-DistributionGroup cmdlet to create distribution groups and mail-enabled security groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-DistributionGroup [-Name] <String> [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] - [-BypassNestedModerationEnabled <$true | $false>] [-Confirm] [-CopyOwnerToMember] [-DisplayName <String>] - [-DomainController <Fqdn>] [-IgnoreNamingPolicy] [-ManagedBy <MultiValuedProperty>] - [-MemberDepartRestriction <Closed | Open | ApprovalRequired>] - [-MemberJoinRestriction <Closed | Open | ApprovalRequired>] [-Members <MultiValuedProperty>] - [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Notes <String>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-OverrideRecipientQuotas] [-PrimarySmtpAddress <SmtpAddress>] [-RoomList] [-SamAccountName <String>] - [-SendModerationNotifications <Never | Internal | Always>] [-Type <Distribution | Security>] [-WhatIf] - [-ExternalDirectoryObjectId <String>] [-RequireSenderAuthenticationEnabled <$true | $false>] - [<CommonParameters>] -``` - -## DESCRIPTION -You can use the New-DistributionGroup cmdlet to create the following types of groups: - -- Mail-enabled universal security groups (USGs) - -- Universal distribution groups - -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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DistributionGroup -Name "Managers" -Type "Security" -``` - -This example creates a mail-enabled security group named Managers without specifying any members. - -You use the Add-DistributionGroupMember cmdlet to add members after you create the group. - -### -------------------------- Example 2 -------------------------- -``` -New-DistributionGroup -Name "ITDepartment" -Members chris@contoso.com,michelle@contoso.com,laura@contoso.com,julia@contoso.com -``` - -This example creates a distribution group named ITDepartment and specifies the members. - -## PARAMETERS - -### -Name -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. - -If a group naming policy is enforced, you need to follow the naming constraints specified in the DistributionGroupNameBlockedWordList and the DistributionGroupNamingPolicy parameters on the Set-OrganizationConfig cmdlet. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -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 -``` - -### -BypassNestedModerationEnabled -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. - -This parameter can be used only by top-level organization and tenant administrators. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyOwnerToMember -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - -If you don't use the DisplayName parameter, the value of the Name parameter is used for the display 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNamingPolicy -The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's distribution group naming policy. The policy is defined by the DistributionGroupNamingPolicy parameter on the Set-OrganizationConfig cmdlet. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -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 - -- Add or remove group members - -- Delete the group - -- Approve member depart or join requests (if available) - -- Approve messages sent to the group if moderation is enabled, but no moderators are specified. - -The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. - -Alternatively, you can use the CopyOwnerToMember switch so the owners are automatically made members of the group. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberDepartRestriction -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. - -```yaml -Type: Closed | Open | ApprovalRequired -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberJoinRestriction -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. - -- 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: Closed | Open | ApprovalRequired -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -For mail-enabled security groups, you need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -For distribution groups, if you set the ModerationEnabled parameter to the value $true, but you don't use this parameter to specify any moderators, the group owners that are specified by the ManagedBy parameter are responsible for approving messages sent to the group. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnit -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideRecipientQuotas -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomList -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -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. - -- Security: A mail-enabled security group. These groups can have permissions assigned. - -The group's scope is always Universal. - -```yaml -Type: Distribution | Security -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -The default value is $true. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/7446962a-cf07-47a1-90d8-45df44057065.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/New-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/New-DynamicDistributionGroup.md deleted file mode 100644 index a44e92d0bd..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/New-DynamicDistributionGroup.md +++ /dev/null @@ -1,812 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-DynamicDistributionGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the New-DynamicDistributionGroup cmdlet to create dynamic distribution groups. A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### PrecannedFilter -``` -New-DynamicDistributionGroup [-Name] <String> -IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients> - [-ConditionalCompany <MultiValuedProperty>] [-ConditionalCustomAttribute1 <MultiValuedProperty>] [-ConditionalCustomAttribute10 <MultiValuedProperty>] [-ConditionalCustomAttribute11 <MultiValuedProperty>] [-ConditionalCustomAttribute12 <MultiValuedProperty>] [-ConditionalCustomAttribute13 <MultiValuedProperty>] [-ConditionalCustomAttribute14 <MultiValuedProperty>] [-ConditionalCustomAttribute15 <MultiValuedProperty>] [-ConditionalCustomAttribute2 <MultiValuedProperty>] [-ConditionalCustomAttribute3 <MultiValuedProperty>] [-ConditionalCustomAttribute4 <MultiValuedProperty>] [-ConditionalCustomAttribute5 <MultiValuedProperty>] [-ConditionalCustomAttribute6 <MultiValuedProperty>] [-ConditionalCustomAttribute7 <MultiValuedProperty>] [-ConditionalCustomAttribute8 <MultiValuedProperty>] [-ConditionalCustomAttribute9 <MultiValuedProperty>] [-ConditionalDepartment <MultiValuedProperty>] [-ConditionalStateOrProvince <MultiValuedProperty>] - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Confirm] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-WhatIf] [<CommonParameters>] -``` - -### CustomFilter -``` -New-DynamicDistributionGroup [-Name] <String> -RecipientFilter <String> - [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] - [-Confirm] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] - [-OrganizationalUnit <OrganizationalUnitIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RecipientContainer <OrganizationalUnitIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-DynamicDistributionGroup -Name "Marketing Group" -IncludedRecipients "MailboxUsers,MailContacts" -ConditionalDepartment "Marketing","Sales" -``` - -This example creates a dynamic distribution group named Marketing Group that contains all recipients who have a Department field that equals the strings "Marketing" or "Sales". Because we didn't use the OrganizationalUnit or RecipientContainer parameters, the group looks for recipients in the default location (typically, the Users container). - -### -------------------------- Example 2 -------------------------- -``` -New-DynamicDistributionGroup -Name "Washington Management Team" -RecipientFilter {(RecipientType -eq 'UserMailbox') -and (Title -like 'Director*' -or Title -like 'Manager*') -and (StateOrProvince -eq 'WA')} -RecipientContainer "North America" -``` - -This example creates a dynamic distribution group named Washington Management Team that contains all users in the organizational unit named North America from Washington State whose titles start with "Director" or "Manager". - -## PARAMETERS - -### -IncludedRecipients -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -Parameter Sets: PrecannedFilter -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -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 -``` - -### -ConditionalCompany -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -DisplayName -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -OrganizationalUnit -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -If you don't use this parameter, the default value is typically the Users container in the domain of the Exchange server that you're connected to (also known as the recipient scope). You can change the recipient scope for the current PowerShell session by using the Set-AdServerSettings cmdlet. - -If you don't use the RecipientContainer parameter, the location of the dynamic distribution group is used for the RecipientContainer property (the default location, or the value you specify for the OrganizationalUnit parameter). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -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). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e9920bd1-06c1-4f75-992f-dd7fc98a5c2b.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/New-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/New-EOPDistributionGroup.md deleted file mode 100644 index 872c7ce3cd..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/New-EOPDistributionGroup.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: New-EOPDistributionGroup -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# New-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the New-EOPDistributionGroup cmdlet to create distribution groups or mail-enabled security groups in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the New-DistributionGroup cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-EOPDistributionGroup -Name <String> [-Alias <String>] [-DisplayName <String>] [-ManagedBy <String[]>] - [-Members <String[]>] [-Notes <String>] [-PrimarySmtpAddress <SmtpAddress>] [-Type <Distribution | Security>] - [<CommonParameters>] -``` - -## DESCRIPTION -You can use the New-EOPDistributionGroup cmdlet to create the following types of groups: - -- Mail-enabled universal security group (USG) - -- Universal distribution group - -Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Security groups are used to grant permissions to multiple users. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-EOPDistributionGroup -Name Managers -Type Security -ManagedBy "Kitty Petersen" -``` - -This example creates a mail-enabled universal security group named Managers that's managed by Kitty Petersen. - -### -------------------------- Example 2 -------------------------- -``` -New-EOPDistributionGroup -Name "Security Team" -ManagedBy "Tyson Fawcett" -Alias SecurityTeamThree -DisplayName "Security Team" -Notes "Security leads from each division" -PrimarySmtpAddress SecTeamThree@contoso.com -Type Distribution -Members @("Tyson Fawcett","Kitty Petersen") -``` - -This example creates a distribution group named "Security Team" and adds two users to the group. - -## PARAMETERS - -### -Name -The Name parameter specifies the name of the distribution group object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified. - -The Name parameter value can't exceed 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the email alias of the distribution group. The Alias parameter value is used to generate the primary SMTP email address if you don't use the PrimarySmtpAddress parameter. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). If the DisplayName parameter isn't specified, the value of the Name parameter is used for the DisplayName parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies a user who owns the group. In Exchange Online Protection, you need to use this parameter to specify at least one group owner. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can specify multiple owners by using the following syntax: @("\<user1\>","\<user2\>"...). - -The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the initial list of recipients (mail-enabled objects) in the distribution group. In Exchange Online Protection, the valid recipient types are: - -- Mail users - -- Distribution groups - -- Mail-enabled security groups - -You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can specify multiple recipients by using the following syntax: @("\<recipient1\>","\<recipient2\>"...). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the group type. Valid values are Distribution or Security. - -```yaml -Type: Distribution | Security -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/4610dfe5-fca8-4ba8-be3c-535d1753e0f4.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/New-EOPMailUser.md b/exchange/exchange-ps/exchange/users-and-groups/New-EOPMailUser.md deleted file mode 100644 index 814d1f0c22..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/New-EOPMailUser.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: New-EOPMailUser -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# New-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the New-EOPMailUser cmdlet to create mail users, also known as mail-enabled users, in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the New-MailUser cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -New-EOPMailUser -MicrosoftOnlineServicesID <WindowsLiveId> -Name <String> -Password <String> [-Alias <String>] - [-DisplayName <String>] [-ExternalEmailAddress <ProxyAddress>] [-FirstName <String>] [-Initials <String>] - [-LastName <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-EOPMailUser -Name EdMeadows -MicrosoftOnlineServicesID EdMeadows@Contoso.onmicrosoft.com -ExternalEmailAddress EdMeadows@tailspintoys.com -Password (ConvertTo-SecureString -String 'Pa$$w0rd' -AsPlainText -Force) -FirstName Ed -LastName Meadows -DisplayName "Ed Meadows" -Alias edm -``` - -This example creates a mail user object for Ed Meadows while specifying several additional optional parameters and using an in-line method of password encryption. - -## PARAMETERS - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. - -```yaml -Type: WindowsLiveId -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the mail user object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified. - -The Name parameter value can't exceed 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter the password for the mail user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the mail user. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the mail user in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the user's email address that's outside of the Exchange Online Protection organization. Email messages sent to the mail user are relayed to this external address. - -```yaml -Type: ProxyAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The LastName parameter specifies the user's last name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/0520cf33-4ad0-44e4-99a3-1b485739fc05.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/New-UnifiedGroup.md b/exchange/exchange-ps/exchange/users-and-groups/New-UnifiedGroup.md deleted file mode 100644 index 3ae7e28d31..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/New-UnifiedGroup.md +++ /dev/null @@ -1,698 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: New-UnifiedGroup -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# New-UnifiedGroup - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the New-UnifiedGroup cmdlet to create Office 365 Groups in your cloud-based organization. To add members, owners, and subscribers to Office 365 Groups, use the Add-UnifiedGroupLinks cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -### Identity (Default) -``` -New-UnifiedGroup [-AccessType <Public | Private>] [-MailboxRegion <String>] - [-Alias <String>] - [-AlwaysSubscribeMembersToCalendarEvents] - [-AutoSubscribeNewMembers] - [-Classification <String>] - [-Confirm] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DisplayName <String>] - [-EmailAddresses <ProxyAddressCollection>] - [-ExecutingUser <RecipientIdParameter>] - [-ExoErrorAsWarning] - [-HiddenGroupMembershipEnabled] - [-Language <CultureInfo>] - [-ManagedBy <RecipientIdParameter[]>] - [-Members <RecipientIdParameter[]>] - [-Name <String>] - [-Notes <String>] - [-Owner <RecipientIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-SuppressWarmupMessage] - [-WhatIf] [<CommonParameters>] -``` - -### ProvisioningOptions -``` -New-UnifiedGroup [-AccessType <Public | Private>] - [-Alias <String>] - [-AlwaysSubscribeMembersToCalendarEvents] - [-AutoSubscribeNewMembers] - [-Classification <String>] - [-Confirm] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DisplayName <String>] - [-EmailAddresses <ProxyAddressCollection>] - [-ExecutingUser <RecipientIdParameter>] - [-ExoErrorAsWarning] - [-HiddenGroupMembershipEnabled] - [-Language <CultureInfo>] - [-ManagedBy <RecipientIdParameter[]>] - [-Members <RecipientIdParameter[]>] - [-Name <String>] - [-Notes <String>] - [-Owner <RecipientIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-SuppressWarmupMessage] - [-WhatIf] [<CommonParameters>] -``` - -### SegmentationOption -``` -New-UnifiedGroup [-AccessType <Public | Private>] [-SubscriptionEnabled] - [-Alias <String>] - [-AlwaysSubscribeMembersToCalendarEvents] - [-AutoSubscribeNewMembers] - [-Classification <String>] - [-Confirm] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DisplayName <String>] - [-EmailAddresses <ProxyAddressCollection>] - [-ExecutingUser <RecipientIdParameter>] - [-ExoErrorAsWarning] - [-HiddenGroupMembershipEnabled] - [-Language <CultureInfo>] - [-ManagedBy <RecipientIdParameter[]>] - [-Members <RecipientIdParameter[]>] - [-Name <String>] - [-Notes <String>] - [-Owner <RecipientIdParameter>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-SuppressWarmupMessage] - [-WhatIf] [<CommonParameters>] -``` - -### DlMigration -``` -New-UnifiedGroup -DlIdentity <DistributionGroupIdParameter> [-ConvertClosedDlToPrivateGroup] [-DeleteDlAfterMigration] - [-Confirm] - [-ExecutingUser <RecipientIdParameter>] - [-ManagedBy <RecipientIdParameter[]>] - [-Members <RecipientIdParameter[]>] - [-Owner <RecipientIdParameter>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 Groups are group objects that are available across Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-UnifiedGroup -DisplayName "Engineering Department" -Alias engineering -``` - -This example creates a new Office 365 Group named Engineering Department. - -## PARAMETERS - -### -DlIdentity -The DlIdentity parameter specifies the distribution group (also known as a distribution list or DL) that you want to migrate to an Office 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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -All the properties and membership of the distribution group are copied to the Office 365 Group. - -The alias and proxy addresses of the distribution group are moved to the Office 365 Group, and are replaced on the distribution group by the values DLMigrated\_\<GUID\>. The original proxy addresses are copied to the ExtensionCustomAttribute5 attribute of the distribution group. - -Office 365 Groups don't have ReportToManager and ReportToOriginator parameters, so the values of these parameters aren't migrated from the distribution group to the Office 365 Group. The Office 365 Group behaves as if the default values of these parameters were set (ReportToManager is $false and ReportToOriginator is $true). In other words, delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the message sender and not to the owner of the Office 365 Group. - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: DlMigration -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -The AccessType parameter specifies the privacy type for the Office 365 Group. Valid values are: - -- Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. This is the default value. - -- Private: The group content and conversations are only available to members of the group, and joining the group requires approval from a group owner. - -You can change the privacy type at any point in the lifecycle of the group. - -Note: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. - -```yaml -Type: Public | Private -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Office 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 value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create an Office 365 Group without using the EmailAddresses parameter, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create an Office 365 Group, the value of the DisplayName parameter is used. Spaces are removed, unsupported characters are converted to question marks (?), and numbers may be added to maintain the uniqueness of the Alias value. - -The Alias value is appended with the ExternalDirectoryObjectId property value and used as the Name property value for the Office 365 Group ("Alias\_\<ExternalDirectoryObjectId\>"\). - -```yaml -Type: String -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlwaysSubscribeMembersToCalendarEvents -The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Office 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. - -Group members can change their own subscription settings, which can override your intended use of this switch. - -The AutoSubscribeNewMembers switch overrides this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoSubscribeNewMembers -The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Office 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. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConvertClosedDlToPrivateGroup -The ConvertClosedDlToPrivateGroup switch specifies whether to migrate the closed distribution group to a private Office 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 Office 365 Group. For open distribution groups, the migrated Office 365 Group is always public, not private. - -You can only use this switch with the DlIdentity parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: DlMigration -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionPolicy -The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the Office 365 Group. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - - -```yaml -Type: DataEncryptionPolicyIdParameter -Parameter Sets: Identity, SegmentationOption, ProvisioningOptions -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteDlAfterMigration -The DeleteDlAfterMigration switch specifies whether to delete the distribution group after it's migrated to an Office 365 Group. You don't need to specify a value with this switch. - -You can only use this switch with the DlIdentity parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: DlMigration -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the Office 365 Group. 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 ("). - -For Office 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. - -```yaml -Type: String -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To enter multiple proxy email addresses, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -```yaml -Type: ProxyAddressCollection -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutingUser -This parameter is reserved for internal Microsoft use. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExoErrorAsWarning -The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Office 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. - -Creating Office 365 Groups involves background operations in Azure Active Directory and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Azure Active Directory is synchronized back to Exchange Online. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenGroupMembershipEnabled -The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the Office 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, an Office 365 Group 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. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -The Language parameter specifies the language preference for the Office 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://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxRegion -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -This parameter is reserved for internal Microsoft use. - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the recipients (mail-enabled objects) that are members of the Office 365 Group. You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter has been deprecated and is 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 Office 365 Group \("Name\_\<RandomGUID\>"\). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value ("Alias\_\<ExternalDirectoryObjectId\>"\). - -```yaml -Type: String -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameter specifies the description of the Office 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -The Owner parameter specifies one or more owners for the Office 365 Group. Owners are group members who have 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: - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -You can specify multiple owners separated by commas - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionEnabled -The SubscriptionEnabled switch specifies whether subscriptions to conversations and calendar events are enabled for the Office 365 Group. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressWarmupMessage -This parameter has been deprecated and is no longer used. - -```yaml -Type: SwitchParameter -Parameter Sets: Identity, ProvisioningOptions, SegmentationOption -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/187acc17-10de-4f38-8efc-7c95d2b3df00.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-DistributionGroup.md deleted file mode 100644 index 4ae38675bb..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-DistributionGroup.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-DistributionGroup cmdlet to remove distribution groups and mail-enabled security groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DistributionGroup [-Identity] <DistributionGroupIdParameter> [-BypassSecurityGroupManagerCheck] - [-Confirm] [-DomainController <Fqdn>] [-IgnoreDefaultScope] [-WhatIf] [-ForReconciliation] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DistributionGroup -Identity "Temporary Staff" -``` - -This example removes the distribution group named Temporary Staff. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - -- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. - -You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForReconciliation -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/40f2ae97-409e-481e-b92d-f6bc6e19b140.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-DynamicDistributionGroup.md deleted file mode 100644 index 74b6f373e7..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-DynamicDistributionGroup.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-DynamicDistributionGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Remove-DynamicDistributionGroup cmdlet to delete dynamic distribution groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-DynamicDistributionGroup [-Identity] <DynamicGroupIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-DynamicDistributionGroup -Identity "Test Users" -``` - -This example deletes the dynamic distribution group named Test Users. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DynamicGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e86f4313-aaeb-42ad-8bac-6add2ca79762.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-EOPDistributionGroup.md deleted file mode 100644 index fada780947..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-EOPDistributionGroup.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Remove-EOPDistributionGroup -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Remove-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Remove-EOPDistributionGroup cmdlet to delete distribution groups or mail-enabled security groups in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Remove-DistributionGroup cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-EOPDistributionGroup [-ExternalDirectoryObjectId <String>] [-Identity <DistributionGroupIdParameter>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-EOPDistributionGroup -Identity "Security Team" -``` - -This example removes the existing Exchange Online Protection distribution group named Security Team. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a17b1307-3187-40b0-a438-c7b35a34c002.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-EOPMailUser.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-EOPMailUser.md deleted file mode 100644 index dc645d9daf..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-EOPMailUser.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Remove-EOPMailUser -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Remove-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Remove-EOPMailUser cmdlet to remove Exchange Online Protection mail users, also known as mail-enabled users, from Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Remove-MailUser cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-EOPMailUser [-ExternalDirectoryObjectId <String>] [-Identity <MailUserIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-EOPMailUser -Identity "Ed Meadows" -``` - -This example removes the mail-enabled user named Ed Meadows. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mail user that you want to delete. You can use any value that uniquely identifies the mail user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/cb91dc26-ed22-4d3c-9f64-df9df1754edb.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-MailContact.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-MailContact.md deleted file mode 100644 index 95ec57cc43..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-MailContact.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-MailContact cmdlet to delete existing mail contacts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailContact [-Identity] <MailContactIdParameter> [-Confirm] [-DomainController <Fqdn>] - [-IgnoreDefaultScope] [-WhatIf] [-ForReconciliation] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailContact -Identity contoso.com/john -``` - -This example removes the mail contact named John. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForReconciliation -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/86b8ea84-5111-489e-a320-003b429d8131.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-MailUser.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-MailUser.md deleted file mode 100644 index cc2ae82d32..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-MailUser.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Remove-MailUser cmdlet to remove existing mail users. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-MailUser [-Identity] <MailUserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-IgnoreDefaultScope] - [-IgnoreLegalHold] [-KeepWindowsLiveID] [-WhatIf] [-ForReconciliation] [-Permanent <$true | $false>] - [-PermanentlyDelete] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-MailUser -Identity "Ed Meadows" -``` - -This example removes the mail user named Ed Meadows. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the 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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. - -After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepWindowsLiveID -This parameter is available only in the cloud-based service. - -The KeepWindowsLiveID switch specifies whether to preserve the Microsoft account (formerly known as a Windows Live ID) that's associated with the deleted mail user. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForReconciliation -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permanent -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermanentlyDelete -This parameter is available only in the cloud-based service. - -The PermanentlyDelete switch specifies whether to immediately and permanently delete (purge) the mail user, which prevents you from recovering or restoring the mail user. You don't need to specify a value with this switch. - -This switch works only on mail users that have already been deleted, but are still recoverable (known as soft-deleted mail-users), that also have a blank value for the ExternalObjectId property. - -Use the Get-MailUser cmdlet to identify the soft-deleted mail user, and then pipe the results to the Remove-MailUser cmdlet with this switch. For example, Get-MailUser -Identity Laura -SoftDeleted | Remove-MailUser -PermanentlyDelete. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/fed40622-ed94-4d71-a244-bf3331addc05.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-UnifiedGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-UnifiedGroup.md deleted file mode 100644 index 80c33aec82..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-UnifiedGroup.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Remove-UnifiedGroup -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-UnifiedGroup - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-UnifiedGroup cmdlet to remove Office 365 groups from your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UnifiedGroup [-Identity] <UnifiedGroupIdParameter> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 groups are group objects that are available across Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UnifiedGroup -Identity "Research Department" -``` - -This example removes the Office 365 Group named Research Department. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Office 365 Group that you want to remove. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/24bab7be-de39-40b3-bbdc-a4baea999180.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/users-and-groups/Remove-UnifiedGroupLinks.md deleted file mode 100644 index 8b1b16dae1..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Remove-UnifiedGroupLinks.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Remove-UnifiedGroupLinks -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Remove-UnifiedGroupLinks - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-UnifiedGroupLinks cmdlet to remove members, owners and subscribers from Office 365 groups in your cloud-based organization. To add members, owners and subscribers, use the Add-UnifiedGroupLinks cmdlet. To modify other properties of Office 365 groups, use the Set-UnifiedGroup cmdlet. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Remove-UnifiedGroupLinks [-Identity] <UnifiedGroupIdParameter> -Links <RecipientIdParameter[]> - -LinkType <Members | Owners | Subscribers | Aggregators | EventSubscribers> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 groups are group objects that are available across Office 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-UnifiedGroupLinks -Identity "Legal Department" -LinkType Members -Links laura@contoso.com,julia@contoso.com -``` - -This example removes members laura@contoso.com and julia@contoso.com from the Office 365 Group named Legal Department. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Office 365 Group that you want to modify. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Links -The Links parameter specifies the recipients to remove from the Office 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>". - -```yaml -Type: RecipientIdParameter[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkType -The LinkType parameter specifies the Office 365 Group property that you want to modify. Valid values are: - -- EventSubscribers - -- Members - -- Owners - -- Subscribers - -```yaml -Type: Members | Owners | Subscribers | Aggregators | EventSubscribers -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5c2b4a0e-a8cb-4b29-a771-e6ebd13957a3.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Set-DistributionGroup.md deleted file mode 100644 index 9c6f54aeda..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-DistributionGroup.md +++ /dev/null @@ -1,1670 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-DistributionGroup cmdlet to modify the settings of existing distribution groups or mail-enabled security groups. To add or remove group members, use the Add-DistributionGroupMember, Remove-DistributionGroupMember or Update-DistributionGroupMember cmdlets. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DistributionGroup [-Identity] <DistributionGroupIdParameter> - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-BypassNestedModerationEnabled <$true | $false>] [-BypassSecurityGroupManagerCheck] [-Confirm] - [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] [-DisplayName <String>] [-DomainController <Fqdn>] - [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] - [-ExpansionServer <String>] [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ForceUpgrade] [-GrantSendOnBehalfTo <MultiValuedProperty>] [-HiddenFromAddressListsEnabled <$true | $false>] - [-IgnoreDefaultScope] [-IgnoreNamingPolicy] [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] - [-ManagedBy <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] - [-MemberDepartRestriction <Closed | Open | ApprovalRequired>] - [-MemberJoinRestriction <Closed | Open | ApprovalRequired>] [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] [-Name <String>] [-PrimarySmtpAddress <SmtpAddress>] - [-RejectMessagesFrom <MultiValuedProperty>] [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-ReportToManagerEnabled <$true | $false>] - [-ReportToOriginatorEnabled <$true | $false>] [-RequireSenderAuthenticationEnabled <$true | $false>] - [-RoomList] [-SamAccountName <String>] [-SendModerationNotifications <Never | Internal | Always>] - [-SendOofMessageToOriginatorEnabled <$true | $false>] [-SimpleDisplayName <String>] - [-UMDtmfMap <MultiValuedProperty>] [-WhatIf] [-WindowsEmailAddress <SmtpAddress>] - [-GenerateExternalDirectoryObjectId] [-ResetMigrationToUnifiedGroup] [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DistributionGroup -Identity "Accounting" -DisplayName "Accounting Group" -``` - -This example changes the display name of an existing distribution group from Accounting to Accounting Group. - -### -------------------------- Example 2 -------------------------- -``` -Set-DistributionGroup -Identity "Bldg34 Conf Rooms" -RoomList -``` - -This example converts the Bldg34 Conf Rooms distribution group to a room list. - -### -------------------------- Example 3 -------------------------- -``` -Set-DistributionGroup -Identity Ed_DirectReports -Name Ayla_DirectReports -IgnoreNamingPolicy -``` - -This example changes the name of an existing distribution group from Ed\_DirectReports to Ayla\_DirectReports and ignores the group naming policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -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 -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassNestedModerationEnabled -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. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - -- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - -- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. - -You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDTMFMap -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. - -- $false: A DTMF map isn't created for the recipient. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -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 -``` - -### -ExpansionServer -This parameter is available only in on-premises Exchange. - -The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. - -You can specify the following types of servers as expansion servers: - -- An Exchange 2013 or later Mailbox server. - -- An Exchange 2010 Hub Transport server. - -When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: Get-ExchangeServer \<ServerName\> | Format-List ExchangeLegacyDN. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". - -```yaml -Type: String -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 -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<Group\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this group. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNamingPolicy -The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's distribution group naming policy. The policy is defined by the DistributionGroupNamingPolicy parameter on the Set-OrganizationConfig cmdlet. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -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 - -- Add or remove group members - -- Delete the group - -- Approve member depart or join requests (if available) - -- Approve messages sent to the group if moderation is enabled, but no moderators are specified. - -The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -To enter multiple owners and overwrite all existing entries, use the following syntax: \<owner1\>,\<owner2\>,...\<ownerN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<owner1\>","\<owner2\>",..."\<ownerN\>". - -To add or remove owners without affecting other existing entries, use the following syntax: @{Add="\<owner1\>","\<owner2\>"...; Remove="\<owner3\>","\<owner4\>"...}. - -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReceiveSize -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. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -Valid values are from 0 through 2147482624 bytes. - -By default, the MaxReceiveSize parameter is set to the value unlimited. This indicates the maximum message size for the group is controlled by other message size limits in the organization. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MaxSendSize -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. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -Valid values are from 0 through 2147482624 bytes. - -By default, the MaxSendSize parameter is set to the value unlimited. This indicates the maximum message size for the group is controlled by other message size limits in the organization. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MemberDepartRestriction -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. - -```yaml -Type: Closed | Open | ApprovalRequired -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberJoinRestriction -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. - -- 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: Closed | Open | ApprovalRequired -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -For mail-enabled security groups, you need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -For distribution groups, if you set the ModerationEnabled parameter to the value $true, but you don't use this parameter to specify any moderators, the group owners that are specified by the ManagedBy parameter are responsible for approving messages sent to the group. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 ("). - -If a group naming policy is enforced, you need to follow the naming constraints specified in the DistributionGroupNameBlockedWordList and DistributionGroupNamingPolicy parameters on the Set-OrganizationConfig cmdlet. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportToManagerEnabled -The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owners of the group (defined by the ManagedBy property). Valid values are: - -- $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. - -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. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportToOriginatorEnabled -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. - -- $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. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomList -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendOofMessageToOriginatorEnabled -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. - -- $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: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDtmfMap -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: - -- emailAddress:\<integers\> - -- lastNameFirstName:\<integers\> - -- firstNameLastName:\<integers\> - -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\<integers\>,lastNameFirstName:\<integers\>,firstNameLastName:\<integers\>. - -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\<integers\>, all existing lastNameFirstName and firstNameLastName values are removed. - -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"; Remove="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"}. - -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\<integers1\>","emailAddress:\<intgers2\>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateExternalDirectoryObjectId -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetMigrationToUnifiedGroup -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 an Office 365 Group is in progress. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e3a8c709-770a-4900-9a57-adcf0d98ff68.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Set-DynamicDistributionGroup.md deleted file mode 100644 index 178d3f20ff..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-DynamicDistributionGroup.md +++ /dev/null @@ -1,1973 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-DynamicDistributionGroup -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-DynamicDistributionGroup cmdlet to modify existing dynamic distribution groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-DynamicDistributionGroup [-Identity] <DynamicGroupIdParameter> - [-AcceptMessagesOnlyFrom <MultiValuedProperty>] [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-ConditionalCompany <MultiValuedProperty>] [-ConditionalCustomAttribute1 <MultiValuedProperty>] - [-ConditionalCustomAttribute10 <MultiValuedProperty>] [-ConditionalCustomAttribute11 <MultiValuedProperty>] - [-ConditionalCustomAttribute12 <MultiValuedProperty>] [-ConditionalCustomAttribute13 <MultiValuedProperty>] - [-ConditionalCustomAttribute14 <MultiValuedProperty>] [-ConditionalCustomAttribute15 <MultiValuedProperty>] - [-ConditionalCustomAttribute2 <MultiValuedProperty>] [-ConditionalCustomAttribute3 <MultiValuedProperty>] - [-ConditionalCustomAttribute4 <MultiValuedProperty>] [-ConditionalCustomAttribute5 <MultiValuedProperty>] - [-ConditionalCustomAttribute6 <MultiValuedProperty>] [-ConditionalCustomAttribute7 <MultiValuedProperty>] - [-ConditionalCustomAttribute8 <MultiValuedProperty>] [-ConditionalCustomAttribute9 <MultiValuedProperty>] - [-ConditionalDepartment <MultiValuedProperty>] [-ConditionalStateOrProvince <MultiValuedProperty>] [-Confirm] - [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] [-DisplayName <String>] [-DomainController <Fqdn>] - [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] - [-ExpansionServer <String>] [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ForceUpgrade] [-GrantSendOnBehalfTo <MultiValuedProperty>] [-HiddenFromAddressListsEnabled <$true | $false>] - [-IgnoreDefaultScope] - [-IncludedRecipients <None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients>] - [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-ManagedBy <GeneralRecipientIdParameter>] - [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-ModeratedBy <MultiValuedProperty>] - [-ModerationEnabled <$true | $false>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] - [-PrimarySmtpAddress <SmtpAddress>] [-RecipientContainer <OrganizationalUnitIdParameter>] - [-RecipientFilter <String>] [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-ReportToManagerEnabled <$true | $false>] - [-ReportToOriginatorEnabled <$true | $false>] [-RequireSenderAuthenticationEnabled <$true | $false>] - [-SendModerationNotifications <Never | Internal | Always>] - [-SendOofMessageToOriginatorEnabled <$true | $false>] [-SimpleDisplayName <String>] - [-UMDtmfMap <MultiValuedProperty>] [-WhatIf] [-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>] -``` - -## 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 a group. You can use the Set-DynamicDistributionGroup cmdlet to overwrite existing settings or to add new settings. - -The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations: - -- The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported. - -- The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - -- The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". - -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-DynamicDistributionGroup -Identity Developers -IncludedRecipients MailboxUsers -ConditionalCompany "Contoso" -ConditionalCustomAttribute1 "Internal" -``` - -This example applies the following changes to the existing dynamic distribution group named Developers: - -Change the ConditionalCompany query filter to Contoso. - -Change the IncludedRecipients query filter to MailboxUsers. - -Add the value Internal to the ConditionalCustomAttribute1 attribute. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DynamicGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -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 -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCompany -The ConditionalCompany parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute1 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute10 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute11 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute12 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute13 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute14 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute15 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute2 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute3 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute4 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute5 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute6 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute7 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute8 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalCustomAttribute9 -This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalDepartment -The ConditionalDepartment parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalStateOrProvince -The ConditionalStateOrProvince parameter specifies a 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. - -You can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -CreateDTMFMap -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. - -- $false: A DTMF map isn't created for the recipient. - -```yaml -Type: $true | $false -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 -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -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 -``` - -### -ExpansionServer -This parameter is available only in on-premises Exchange. - -The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange 2016 Mailbox server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. Therefore, you should consider implementing a high availability solution for an expansion server. - -You can specify the following types of servers as expansion servers: - -- An Exchange 2016 Mailbox server. - -- An Exchange 2013 Mailbox server. - -- An Exchange 2010 Hub Transport server. - -When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: Get-ExchangeServer \<ServerName\> | Format-List ExchangeLegacyDN. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". - -```yaml -Type: String -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 -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<Group\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this group. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedRecipients -The IncludedRecipients parameter specifies a filter that's based on the recipient type. Valid values are: - -- AllRecipients: This value can be used only by itself. - -- MailboxUsers - -- MailContacts - -- MailGroups - -- MailUsers - -- Resources: This value indicates room or equipment mailboxes. - -You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. - -You need to use this parameter when you use any of the Conditional parameters. You can't use this parameter with the RecipientFilter parameter. - -```yaml -Type: None | MailboxUsers | Resources | MailContacts | MailGroups | MailUsers | AllRecipients -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 -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -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 - -- Add or remove group members - -- Delete the group - -- Approve member depart or join requests (if available) - -- Approve messages sent to the group if moderation is enabled, but no moderators are specified. - -The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -To enter multiple owners and overwrite all existing entries, use the following syntax: \<owner1\>,\<owner2\>,...\<ownerN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<owner1\>","\<owner2\>",..."\<ownerN\>". - -To add or remove owners without affecting other existing entries, use the following syntax: @{Add="\<owner1\>","\<owner2\>"...; Remove="\<owner3\>","\<owner4\>"...}. - -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. - -```yaml -Type: GeneralRecipientIdParameter -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 -``` - -### -MaxReceiveSize -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. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -Valid values are from 0 through 2147482624 bytes. - -By default, the MaxReceiveSize parameter is set to the value unlimited. This indicates the maximum message size for this group is controlled by other message size limits in the organization. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MaxSendSize -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. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -Valid values are from 0 through 2147482624 bytes. - -By default, the MaxSendSize parameter is set to the value unlimited. This indicates the maximum message size for this group is controlled by other message size limits in the organization. - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -Name -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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 -``` - -### -PhoneticDisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientContainer -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 visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - -- Name - -- Canonical name - -- Distinguished name (DN) - -- GUID - -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). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. When you use this parameter, remember the following OPath filter rules: - -- Use braces { } around the whole OPath syntax string. - -- Include a hyphen before all operators. - -- In cloud-based environments, you can't use a wildcard as the first character. For example, Sales\* is allowed, but \*Sales isn't allowed. Wildcards are valid only at the end for cloud-based environments and only at the front or back of words for on-prem environments. - -For more information, see Filterable properties for the -RecipientFilter parameter (https://technet.microsoft.com/library/bb738157.aspx). - -You can't use this parameter with the IncludedRecipients parameter or any of the Conditional parameters. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportToManagerEnabled -The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owners of the group (defined by the ManagedBy property). Valid values are: - -- $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. - -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. - -```yaml -Type: $true | $false -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 -``` - -### -ReportToOriginatorEnabled -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. - -- $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. - -```yaml -Type: $true | $false -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 -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -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 -``` - -### -SendOofMessageToOriginatorEnabled -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. - -- $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: $true | $false -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 -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDtmfMap -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: - -- emailAddress:\<integers\> - -- lastNameFirstName:\<integers\> - -- firstNameLastName:\<integers\> - -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\<integers\>,lastNameFirstName:\<integers\>,firstNameLastName:\<integers\>. - -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\<integers\>, all existing lastNameFirstName and firstNameLastName values are removed. - -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"; Remove="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"}. - -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\<integers1\>","emailAddress:\<intgers2\>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 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 -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/943626ad-8455-4867-ab9a-855bab62c9c3.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Set-EOPDistributionGroup.md deleted file mode 100644 index 2784c36913..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPDistributionGroup.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Set-EOPDistributionGroup -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Set-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPDistributionGroup cmdlet to modify the settings of distribution groups or mail-enabled security groups in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Set-DistributionGroup cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-EOPDistributionGroup [-Alias <String>] [-DisplayName <String>] [-ExternalDirectoryObjectId <String>] - [-Identity <DistributionGroupIdParameter>] [-ManagedBy <String[]>] [-PrimarySmtpAddress <SmtpAddress>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-EOPDistributionGroup -Identity "Security Team" -PrimarySmtpAddress NewSecTeamId@Contoso.com -``` - -This example changes the current SMTP address of the Security Team EOP distribution group to "NewSecTeamId@Contoso.com". - -## PARAMETERS - -### -Alias -The Alias parameter specifies the alias of the distribution group. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies one or more group owners. A group must have at least one owner. You can use any value that uniquely identifies the owner. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -You can specify multiple owners by using the following syntax: @("\<user1\>","\<user2\>"...). The values that you specify will overwrite the current list of owners. - -The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/689a66c5-a524-4870-88f3-091fd6eae3b7.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Set-EOPGroup.md deleted file mode 100644 index 50ff3a6248..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPGroup.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Set-EOPGroup -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Set-EOPGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPGroup cmdlet to modify general group object attributes in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Set-Group cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-EOPGroup [-ExternalDirectoryObjectId <String>] [-Identity <GroupIdParameter>] [-ManagedBy <String[]>] - [-Notes <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-Group -Identity "Legal Department" -Notes "Group members updated June 1, 2018" -``` - -This example sets the Notes property to indicate the last time that the group was updated. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: GroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies a user who owns the group. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can specify multiple owners by using the following syntax: @("\<user1\>","\<user2\>"...). The values that you specify will overwrite the current list of owners. - -The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/bed90147-4ff9-4b9d-b9fc-3e7843397818.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPMailUser.md b/exchange/exchange-ps/exchange/users-and-groups/Set-EOPMailUser.md deleted file mode 100644 index 4333a9743d..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPMailUser.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Set-EOPMailUser -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Set-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPMailUser cmdlet to modify mail users, also known as mail-enabled users, in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Set-MailUser cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-EOPMailUser [-Alias <String>] [-DisplayName <String>] [-EmailAddresses <ProxyAddressCollection>] - [-ExternalDirectoryObjectId <String>] [-Identity <MailUserIdParameter>] - [-MicrosoftOnlineServicesID <SmtpAddress>] [-Password <String>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-EOPMailUser -Identity "Edward Meadows" -DisplayName "Ed Meadows" -``` - -This example changes the display name for the mail user Edward Meadows to "Ed Meadows." - -## PARAMETERS - -### -Alias -The Alias parameter specifies the alias of the mail user. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the mail user in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies the primary email address and other proxy addresses for the mail user. This parameter uses the syntax SMTP:\<PrimaryEmailAddress\>,\<ProxyAddress\>. - -The values that you specify for this parameter overwrite any existing values. - -```yaml -Type: ProxyAddressCollection -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/834c3de6-1485-4d50-bb96-262a2c0c8619.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPUser.md b/exchange/exchange-ps/exchange/users-and-groups/Set-EOPUser.md deleted file mode 100644 index fc9cce4311..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-EOPUser.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Set-EOPUser -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Set-EOPUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPUser cmdlet to modify general user object attributes in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Set-User cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-EOPUser [-City <String>] [-Company <String>] [-CountryOrRegion <CountryInfo>] [-Department <String>] - [-DisplayName <String>] [-ExternalDirectoryObjectId <String>] [-Fax <String>] [-FirstName <String>] - [-HomePhone <String>] [-Identity <UserIdParameter>] [-Initials <String>] [-LastName <String>] - [-MobilePhone <String>] [-Notes <String>] [-Office <String>] [-Phone <String>] [-PostalCode <String>] - [-StateOrProvince <String>] [-StreetAddress <String>] [-Title <String>] [-WebPage <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-EOPUser -Identity "Kitty Petersen" -Company Contoso -DisplayName "Kitty Petersen" -Title "Vice President" -``` - -This example sets the company, display name, and title properties for the user Kitty Petersen. - -## PARAMETERS - -### -City -The City parameter specifies the user's city. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Company -The Company parameter specifies the user's company. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -The CountryOrRegion parameter specifies the user's country or region. - -```yaml -Type: CountryInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Department -The Department parameter specifies the user's department. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the user's display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Fax -The Fax parameter specifies the user's fax number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePhone -The HomePhone parameter specifies the user's home telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the user object that you want to modify. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobilePhone -The MobilePhone parameter specifies the user's primary mobile phone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office -The Office parameter specifies the user's physical office name or number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Phone -The Phone parameter specifies the user's telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -The PostalCode parameter specifies the user's zip code or postal code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -The StateOrProvince parameter specifies the user's state or province. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetAddress -The StreetAddress parameter specifies the user's physical address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The Title parameter specifies the user's title. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebPage -The WebPage parameter specifies the user's Web page. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/497785d1-c2ae-4ddd-af28-a96cb3e62332.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-LinkedUser.md b/exchange/exchange-ps/exchange/users-and-groups/Set-LinkedUser.md deleted file mode 100644 index bf8d8362e1..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-LinkedUser.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-LinkedUser -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-LinkedUser - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-LinkedUser cmdlet to modify the properties of an existing linked user account. The Outlook Live Directory Sync (OLSync) service account is a linked user. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-LinkedUser [-Identity] <UserIdParameter> [-CertificateSubject <MultiValuedProperty>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-LinkedUser "GALSync-ServiceAccount" -CertificateSubject "X509:<I>CN=3rdPartyCAExample.com<S>C=US,O=Contoso Corp, CN=contoso.com" -``` - -This example modifies the certificate subject for the linked user "GALSync-ServiceAccount". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the linked user. You can use any value that uniquely identifies the linked user, for example: - -- Name - -- Distinguished name (DN) - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CertificateSubject -The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate. The syntax of the CertificateSubject value is X509:\<I\>Issuer\<S\>Subject. 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/9252ba30-a3b3-484f-9750-6103f246cbbf.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-MailContact.md b/exchange/exchange-ps/exchange/users-and-groups/Set-MailContact.md deleted file mode 100644 index e33ba6fcef..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-MailContact.md +++ /dev/null @@ -1,1578 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailContact -schema: 2.0.0 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps" ---- - -# 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. - -Use the Set-MailContact cmdlet to modify existing mail contacts. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailContact [-Identity] <MailContactIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] - [-Confirm] [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] [-DisplayName <String>] [-DomainController <Fqdn>] - [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] [-ExternalEmailAddress <ProxyAddress>] [-ForceUpgrade] - [-GrantSendOnBehalfTo <MultiValuedProperty>] [-HiddenFromAddressListsEnabled <$true | $false>] - [-IgnoreDefaultScope] [-MacAttachmentFormat <BinHex | UuEncode | AppleSingle | AppleDouble>] - [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] - [-MaxRecipientPerMessage <Unlimited>] [-MaxSendSize <Unlimited>] - [-MessageBodyFormat <Text | Html | TextAndHtml>] [-MessageFormat <Text | Mime>] - [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] - [-PrimarySmtpAddress <SmtpAddress>] [-RejectMessagesFrom <MultiValuedProperty>] - [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-RemovePicture] [-RemoveSpokenName] - [-RequireSenderAuthenticationEnabled <$true | $false>] [-SecondaryAddress <String>] - [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] - [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] - [-UseMapiRichTextFormat <Never | Always | UseDefaultSettings>] [-UsePreferMessageFormat <$true | $false>] - [-WhatIf] [-WindowsEmailAddress <SmtpAddress>] [-GenerateExternalDirectoryObjectId] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-MailContact -Identity "John Rodman" -ExternalEmailAddress "john@contoso.com" -``` - -This example sets John Rodman's external email address to john@contoso.com. - -## PARAMETERS - -### -Identity -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: MailContactIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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. - -```yaml -Type: MailboxIdParameter -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 -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 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 -``` - -### -CreateDTMFMap -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. - -- $false: A DTMF map isn't created for the recipient. - -```yaml -Type: $true | $false -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 -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 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 -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -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 -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. - -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. - -When you use the ExternalEmailAddress parameter to change the external email address, the old external email address isn't kept as a proxy address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<Mail contact\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this mail contact. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -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 -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacAttachmentFormat -The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: - -- BinHex (This is the default value) - -- UuEncode - -- AppleSingle - -- AppleDouble - -The MacAttachmentFormat and MessageFormat parameters are interdependent: - -- MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. - -- MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. - -```yaml -Type: BinHex | UuEncode | AppleSingle | AppleDouble -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 -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - -The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail contact. Messages larger than the maximum size are rejected. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 2 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum receive size for the mail contact is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MaxRecipientPerMessage -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. - -A valid value is an integer up to 2147483647 (Int32) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum number of recipients per message for the mail contact is controlled elsewhere (for example, organization, server, or connector limits). - -```yaml -Type: Unlimited -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 -``` - -### -MaxSendSize -This parameter is available only in on-premises Exchange. - -The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail contact. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is number up to 2 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum send size for the mail contact is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MessageBodyFormat -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) - -The MessageFormat and MessageBodyFormat parameters are interdependent: - -- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - -- MessageFormat is Text: MessageBodyFormat can only be Text. - -```yaml -Type: Text | Html | TextAndHtml -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 -``` - -### -MessageFormat -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) - -The MessageFormat and MessageBodyFormat parameters are interdependent: - -- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - -- MessageFormat is Text: MessageBodyFormat can only be Text. - -Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. - -```yaml -Type: Text | Mime -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 -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -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 -``` - -### -Name -The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -This parameter is available only in on-premises Exchange. - -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -By default, the primary address is the same as the ExternalEmailAddress parameter value. - -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, which means the email addresses of the mail contact aren't automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. - -```yaml -Type: SmtpAddress -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 -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePicture -This parameter is available only in on-premises Exchange. - -The RemovePictureswitch specifies whether to remove the picture from the mail contact. You don't need to specify a value with this switch. - -You can add a picture to a mail contact by using the Import-RecipientDataProperty cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSpokenName -This parameter is available only in on-premises Exchange. - -The RemoveSpokenName parameter specifies whether to remove the spoken name from the mail contact. You don't need to specify a value with this switch. - -You can add a sound file to a mail contact by using the Import-RecipientDataProperty 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -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 -``` - -### -SecondaryAddress -The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryDialPlan -The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - -```yaml -Type: UMDialPlanIdParameter -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 -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -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 -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDtmfMap -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: - -- emailAddress:\<integers\> - -- lastNameFirstName:\<integers\> - -- firstNameLastName:\<integers\> - -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\<integers\>,lastNameFirstName:\<integers\>,firstNameLastName:\<integers\>. - -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\<integers\>, all existing lastNameFirstName and firstNameLastName values are removed. - -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"; Remove="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"}. - -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\<integers1\>","emailAddress:\<intgers2\>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMapiRichTextFormat -The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: - -- Always: TNEF is used for all messages sent to the mail user or mail contact. - -- Never: TNEF is never used for any messages sent to the mail user or mail contact. TNEF messages are converted to plain text. - -- UseDefaultSettings: TNEF messages aren't specifically allowed or prevented for the mail user or mail contact. Whether TNEF messages are sent to the recipient depends on the remote domain TNEF settings (the default remote domain or a specific remote domain), or the Outlook Rich Text message settings specified by the sender in Outlook. - -The default value is UseDefaultSettings. - -```yaml -Type: Never | Always | UseDefaultSettings -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 -``` - -### -UsePreferMessageFormat -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. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateExternalDirectoryObjectId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/04c4e889-8546-4395-9d26-31af08264e45.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-MailUser.md b/exchange/exchange-ps/exchange/users-and-groups/Set-MailUser.md deleted file mode 100644 index bf76d1f012..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-MailUser.md +++ /dev/null @@ -1,2339 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-MailUser cmdlet to modify mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-MailUser [-Identity] <MailUserIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>] - [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] - [-ArbitrationMailbox <MailboxIdParameter>] [-ArchiveGuid <Guid>] [-ArchiveName <MultiValuedProperty>] - [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] [-Confirm] [-CreateDTMFMap <$true | $false>] - [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-DisplayName <String>] - [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] - [-EmailAddressPolicyEnabled <$true | $false>] [-ExchangeGuid <Guid>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] [-ExternalEmailAddress <ProxyAddress>] - [-FederatedIdentity <String>] [-ForceUpgrade] [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope] [-ImmutableId <String>] - [-MacAttachmentFormat <BinHex | UuEncode | AppleSingle | AppleDouble>] [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] - [-MessageBodyFormat <Text | Html | TextAndHtml>] [-MessageFormat <Text | Mime>] - [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] - [-Password <SecureString>] [-PrimarySmtpAddress <SmtpAddress>] [-RecipientLimits <Unlimited>] - [-RejectMessagesFrom <MultiValuedProperty>] [-RejectMessagesFromDLMembers <MultiValuedProperty>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-RemovePicture] [-RemoveSpokenName] - [-RequireSenderAuthenticationEnabled <$true | $false>] [-ResetPasswordOnNextLogon <$true | $false>] - [-SamAccountName <String>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] - [-SendModerationNotifications <Never | Internal | Always>] [-SimpleDisplayName <String>] - [-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat <Never | Always | UseDefaultSettings>] - [-UsePreferMessageFormat <$true | $false>] [-UserPrincipalName <String>] [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] [-AddOnSKUCapability <MultiValuedProperty>] [-ArchiveQuota <Unlimited>] - [-ArchiveWarningQuota <Unlimited>] [-BypassLiveId] [-CalendarVersionStoreDisabled <$true | $false>] - [-EndDateForRetentionHold <DateTime>] [-JournalArchiveAddress <SmtpAddress>] [-LitigationHoldDate <DateTime>] - [-LitigationHoldEnabled <$true | $false>] [-LitigationHoldOwner <String>] - [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] - [-MailboxProvisioningPreferences <MultiValuedProperty>] [-MicrosoftOnlineServicesID <SmtpAddress>] - [-NetID <NetID>] [-RecoverableItemsQuota <Unlimited>] [-RecoverableItemsWarningQuota <Unlimited>] - [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-RetentionComment <String>] - [-RetentionHoldEnabled <$true | $false>] [-RetentionUrl <String>] - [-SingleItemRecoveryEnabled <$true | $false>] [-SKUAssigned <$true | $false>] - [-SKUCapability <None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | BPOS_B_CustomDomain | BPOS_S_MidSize | BPOS_S_ArchiveAddOn | BPOS_S_EopStandardAddOn | BPOS_S_EopPremiumAddOn | BPOS_Unmanaged | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence | OrganizationCapabilityUMGrammar | OrganizationCapabilityUMDataStorage | OrganizationCapabilityOABGen | OrganizationCapabilityGMGen | OrganizationCapabilityClientExtensions | BEVDirLockdown | OrganizationCapabilityUMGrammarReady | OrganizationCapabilityMailRouting | OrganizationCapabilityManagement | OrganizationCapabilityTenantUpgrade | OrganizationCapabilityScaleOut | OrganizationCapabilityMessageTracking | OrganizationCapabilityPstProvider | OrganizationCapabilitySuiteServiceStorage | OrganizationCapabilityOfficeMessageEncryption | OrganizationCapabilityMigration>] - [-StartDateForRetentionHold <DateTime>] [-UsageLocation <CountryInfo>] - [-UserCertificate <MultiValuedProperty>] [-UserSMimeCertificate <MultiValuedProperty>] - [-WindowsLiveID <SmtpAddress>] [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-IssueWarningQuota <Unlimited>] [-MailboxRegion <String>] [-ProhibitSendQuota <Unlimited>] - [-ProhibitSendReceiveQuota <Unlimited>] [-SkipDualWrite] [-SkipMailboxProvisioningConstraintValidation] - [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -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. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. - -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\<alias\>@\<domain\>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. - -If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: - -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. - -- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). - -If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). - -The Alias parameter never generates or updates the primary email address of a mail contact or a mail user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArbitrationMailbox -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -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 -``` - -### -ArchiveGuid -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveName -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassModerationFromSendersOrMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple senders and overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender3\>","\<sender4\>"...}. - -This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDTMFMap -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. - -- $false: A DTMF map isn't created for the recipient. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddressPolicyEnabled -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. - -- $false: Email address policies aren't applied to this recipient. - -```yaml -Type: $true | $false -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 -``` - -### -ExchangeGuid -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. - -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. - -When you use the ExternalEmailAddress parameter to change the external email address, the old external email address isn't kept as a proxy address. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -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 (\<Sender\> on behalf of \<Mail user\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this mail user. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. - -- $false: The recipient is visible in address lists. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutableId -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacAttachmentFormat -The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: - -- BinHex (This is the default value) - -- UuEncode - -- AppleSingle - -- AppleDouble - -The MacAttachmentFormat and MessageFormat parameters are interdependent: - -- MessageFormat is Text: MacAttachmentFormat can be BinHex or UuEncode. - -- MessageFormat is Mime: MacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble. - -```yaml -Type: BinHex | UuEncode | AppleSingle | AppleDouble -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - -The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail user. Messages larger than the maximum size are rejected. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum receive size for the mail user is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MaxSendSize -This parameter is available only in on-premises Exchange. - -The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail user. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum send size for the mail user is controlled elsewhere (for example, organization, server, or connector limits). - -For any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB. - -```yaml -Type: Unlimited -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 -``` - -### -MessageBodyFormat -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) - -The MessageFormat and MessageBodyFormat parameters are interdependent: - -- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - -- MessageFormat is Text: MessageBodyFormat can only be Text. - -```yaml -Type: Text | Html | TextAndHtml -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageFormat -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) - -The MessageFormat and MessageBodyFormat parameters are interdependent: - -- MessageFormat is Mime: MessageBodyFormat can be Text, Html, or TextAndHtml. - -- MessageFormat is Text: MessageBodyFormat can only be Text. - -Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. - -```yaml -Type: Text | Mime -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModeratedBy -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 - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModerationEnabled -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. - -You use the ModeratedBy parameter to specify the moderators. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -This parameter is available only in the cloud-based service. - -The Password parameter allows users to change their own password. - -This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter. - -You can't use this parameter to change another user's password (the parameter is available only via the MyBaseOptions user role). To change another user's password, use the NewPassword parameter on the Set-MsolUserPassword cmdlet in Office 365 (Azure AD) PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://go.microsoft.com/fwlink/p/?LinkId=614839). - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -This parameter is available only in on-premises Exchange. - -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -By default, the primary address is the same as the ExternalEmailAddress parameter value. - -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user are no longer automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. - -```yaml -Type: SmtpAddress -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 -``` - -### -RecipientLimits -This parameter is available only in on-premises Exchange. - -The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mail user. - -A valid value is an integer or the value unlimited. The default value is unlimited. - -The value unlimited indicates the maximum number of recipients per message for the mail user is controlled elsewhere (for example, organization, server, or connector limits). - -```yaml -Type: Unlimited -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 -``` - -### -RejectMessagesFrom -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\<sender1\>","\<sender2\>"...; Remove="\<sender1\>","\<sender2\>"...}. - -The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromDLMembers -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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \<group1\>,\<group2\>,...\<groupN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<group1\>","\<group2\>",..."\<groupN\>". - -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\<group1\>","\<group2\>"...; Remove="\<group1\>","\<group2\>"...}. - -The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all groups. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePicture -This parameter is available only in on-premises Exchange. - -The RemovePicture switch specifies whether to remove the picture from the mail user. You don't need to specify a value with this switch. - -You can add a picture to a mail user by using the Import-RecipientDataProperty 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSpokenName -This parameter is available only in on-premises Exchange. - -The RemoveSpokenName parameter specifies whether to remove the spoken name from the mail user. You don't need to specify a value with this switch. - -You can add a sound file to a mail user by using the Import-RecipientDataProperty 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetPasswordOnNextLogon -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. - -You can't use this parameter to require another user to change their password (the parameter is available only via the MyBaseOptions user role). You need to use the ForceChangePassword parameter on the Set-MsolUserPassword cmdlet in Office 365 (Azure AD) PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://go.microsoft.com/fwlink/p/?LinkId=614839). - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -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 -``` - -### -SecondaryAddress -The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryDialPlan -The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - -```yaml -Type: UMDialPlanIdParameter -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendModerationNotifications -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. - -- Internal: Notify senders in the organization when their messages aren't approved. - -- Never: Don't notify anyone when a message isn't approved. - -This parameter is only meaningful when moderation is enabled (the ModerationEnabled parameter has the value $true). - -```yaml -Type: Never | Internal | Always -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMDtmfMap -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: - -- emailAddress:\<integers\> - -- lastNameFirstName:\<integers\> - -- firstNameLastName:\<integers\> - -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\<integers\>,lastNameFirstName:\<integers\>,firstNameLastName:\<integers\>. - -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\<integers\>, all existing lastNameFirstName and firstNameLastName values are removed. - -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"; Remove="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"}. - -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\<integers1\>","emailAddress:\<intgers2\>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMapiRichTextFormat -The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: - -- Always: TNEF is used for all messages sent to the mail user or mail contact. - -- Never: TNEF is never used for any messages sent to the mail user or mail contact. TNEF messages are converted to plain text. - -- UseDefaultSettings: TNEF messages aren't specifically allowed or prevented for the mail user or mail contact. Whether TNEF messages are sent to the recipient depends on the remote domain TNEF settings (the default remote domain or a specific remote domain), or the Outlook Rich Text message settings specified by the sender in Outlook. - -The default value is UseDefaultSettings. - -```yaml -Type: Never | Always | UseDefaultSettings -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsePreferMessageFormat -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. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -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. - -```yaml -Type: String -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 -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddOnSKUCapability -This parameter is reserved for internal Microsoft use. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveQuota -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveWarningQuota -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassLiveId -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarVersionStoreDisabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDateForRetentionHold -This parameter is reserved for internal Microsoft use. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalArchiveAddress -This parameter is reserved for internal Microsoft use. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LitigationHoldDate -This parameter is reserved for internal Microsoft use. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LitigationHoldEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LitigationHoldOwner -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxProvisioningConstraint -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MailboxProvisioningConstraint -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxProvisioningPreferences -This parameter is reserved for internal Microsoft use. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetID -This parameter is reserved for internal Microsoft use. - -```yaml -Type: NetID -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoverableItemsQuota -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. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). - -The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoverableItemsWarningQuota -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. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) - -- KB (kilobytes) - -- MB (megabytes) - -- GB (gigabytes) - -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -A valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). - -The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDeletedItemsFor -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionComment -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionHoldEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionUrl -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, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SingleItemRecoveryEnabled -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SKUAssigned -This parameter is reserved for internal Microsoft use. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SKUCapability -This parameter is reserved for internal Microsoft use. - -```yaml -Type: None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | BPOS_B_CustomDomain | BPOS_S_MidSize | BPOS_S_ArchiveAddOn | BPOS_S_EopStandardAddOn | BPOS_S_EopPremiumAddOn | BPOS_Unmanaged | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence | OrganizationCapabilityUMGrammar | OrganizationCapabilityUMDataStorage | OrganizationCapabilityOABGen | OrganizationCapabilityGMGen | OrganizationCapabilityClientExtensions | BEVDirLockdown | OrganizationCapabilityUMGrammarReady | OrganizationCapabilityMailRouting | OrganizationCapabilityManagement | OrganizationCapabilityTenantUpgrade | OrganizationCapabilityScaleOut | OrganizationCapabilityMessageTracking | OrganizationCapabilityPstProvider | OrganizationCapabilitySuiteServiceStorage | OrganizationCapabilityOfficeMessageEncryption | OrganizationCapabilityMigration -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDateForRetentionHold -This parameter is reserved for internal Microsoft use. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsageLocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: CountryInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCertificate -This parameter is reserved for internal Microsoft use. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSMimeCertificate -This parameter is reserved for internal Microsoft use. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveID -This parameter is available only in the cloud-based service. - -The WindowsLiveID parameter renames the Microsoft account that's associated with the mail user. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionPolicy -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: - -- Name - -- Distinguished name (DN) - -- GUID - -You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. - -```yaml -Type: DataEncryptionPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssueWarningQuota -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxRegion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitSendQuota -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProhibitSendReceiveQuota -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDualWrite -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipMailboxProvisioningConstraintValidation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/087a55a2-ee8d-41a8-9c8f-d86e32ce8448.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Set-UnifiedGroup.md deleted file mode 100644 index 9943d72b8a..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-UnifiedGroup.md +++ /dev/null @@ -1,1045 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Set-UnifiedGroup -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Set-UnifiedGroup - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-UnifiedGroup cmdlet to modify Office 365 Groups in your cloud-based organization. To modify members, owners, and subscribers of Office 365 Groups, use the Add-UnifiedGroupLinks and Remove-UnifiedGroupLinks cmdlets. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-UnifiedGroup [-Identity] <UnifiedGroupIdParameter> - [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] - [-AccessType <Public | Private>] - [-Alias <String>] - [-AlwaysSubscribeMembersToCalendarEvents] - [-AutoSubscribeNewMembers] - [-CalendarMemberReadOnly] - [-Classification <String>] - [-Confirm] - [-ConnectorsEnabled] - [-CustomAttribute1 <String>] - [-CustomAttribute10 <String>] - [-CustomAttribute11 <String>] - [-CustomAttribute12 <String>] - [-CustomAttribute13 <String>] - [-CustomAttribute14 <String>] - [-CustomAttribute15 <String>] - [-CustomAttribute2 <String>] - [-CustomAttribute3 <String>] - [-CustomAttribute4 <String>] - [-CustomAttribute5 <String>] - [-CustomAttribute6 <String>] - [-CustomAttribute7 <String>] - [-CustomAttribute8 <String>] - [-CustomAttribute9 <String>] - [-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>] - [-DisplayName <String>] - [-EmailAddresses <ProxyAddressCollection>] - [-ExtensionCustomAttribute1 <MultiValuedProperty>] - [-ExtensionCustomAttribute2 <MultiValuedProperty>] - [-ExtensionCustomAttribute3 <MultiValuedProperty>] - [-ExtensionCustomAttribute4 <MultiValuedProperty>] - [-ExtensionCustomAttribute5 <MultiValuedProperty>] - [-ForceUpgrade] - [-GrantSendOnBehalfTo <MultiValuedProperty>] - [-HiddenFromAddressListsEnabled <$true | $false>] - [-HiddenFromExchangeClientsEnabled] - [-Language <CultureInfo>] - [-MailboxRegion <String>] - [-MailTip <String>] - [-MailTipTranslations <MultiValuedProperty>] - [-Notes <String>] - [-PrimarySmtpAddress <SmtpAddress>] - [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] - [-RequireSenderAuthenticationEnabled <$true | $false>] - [-UnifiedGroupWelcomeMessageEnabled] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 Groups are group objects that are available across Office 365 services. - -The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. You can't change this setting on an existing Office 365 Group 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-UnifiedGroup -Identity "Marketing Department" -PrimarySmtpAddress marketing@contoso.com -RequireSenderAuthenticationEnabled $false -``` - -This example makes the following changes to the Office 365 Group named Marketing Department: - -- The primary email address is changed to marketing@contoso.com. - -- The Office 365 Group is allowed to receive mail from unauthenticated (external) senders. - -### -------------------------- Example 2 -------------------------- -``` -Set-UnifiedGroup -Identity "Legal Department" -AccessType Private -``` - -This example changes the Office 365 Group named Legal Department from a public group to a private group. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the Office 365 Group that you want to modify. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AcceptMessagesOnlyFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -The AccessType parameter specifies the privacy type for the Office 365 Group. Valid values are: - -- Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. - -- Private: The group content and conversations are only available to members of the group, and joining the group requires approval from a group owner. - -Note: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. - -```yaml -Type: Public | Private -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Office 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 value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlwaysSubscribeMembersToCalendarEvents -The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Office 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. - -- If you use this exact syntax: -AlwaysSubscribeMembersToCalendarEvents:$false, all future members that are added to the group will have their subscriptions set to ReplyOnly. - -Group members can change their own subscription settings, which can override your intended use of this switch. - -The AutoSubscribeNewMembers switch overrides this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoSubscribeNewMembers -The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Office 365 Group to conversations and calendar events. Only users that are added to the group after you enable this setting are automatically subscribed to the group.. - -- To subscribe new members to conversations and calendar events, use the AutoSubscribeNewMembers switch without a value. - -- If you don't want to subscribe new members to conversations and calendar events, use this exact syntax: -AutoSubscribeNewMembers:$false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarMemberReadOnly -The CalendarMemberReadOnly switch specifies whether to set read-only Calendar permissions to the Office 365 Group for members of the group. - -- To set read-only Calendar permissions, use the CalendarMemberReadOnly switch without a value. - -- To remove read-only Calendar permissions, use this exact syntax: -CalendarMemberReadOnly:$false. - -To view the current value of the CalendarMemberReadOnly property on an Office 365 Group, replace \<EmailAddress\> with the email address of the group, and run this command: Get-UnifiedGroup -Identity \<EmailAddress\> -IncludeAllProperties | Format-List \*Calendar\*. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification -The Classification parameter specifies the classification for the Office 365 Group. You need to configure the list of available classifications in Azure Active Directory before you can specify a value for this parameter. For more information, see Azure Active Directory cmdlets for configuring group settings (https://go.microsoft.com/fwlink/p/?LinkId=827484). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorsEnabled -The ConnectorsEnabled specifies whether to enable the ability to use connectors for the Office 365 Group. - -- To enable connectors, use the ConnectorsEnabled switch without a value. - -- To disable connectors, use this exact syntax: -ConnectorsEnabled:$false. - -To use this switch, the value of the ConnectorsEnabled parameter on the Set-OrganizationConfig cmdlet must be set to $true (which is the default value). - -For more information about connectors for Office 365 Groups, see Connect apps to your groups (https://go.microsoft.com/fwlink/p/?LinkId=787545). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute1 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute10 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute11 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute12 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute13 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute14 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute15 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute2 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute3 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute4 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute5 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute6 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute7 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute8 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAttribute9 -The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionPolicy -The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the Office 365 Group. You can use any value that uniquely identifies the policy. For example: - -- Name - -- Distinguished name (DN) - -- GUID - -To remove an existing policy, use the value $null. - -```yaml -Type: DataEncryptionPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the Office 365 Group. 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 Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016 (https://technet.microsoft.com/library/bb232171.aspx). - -Valid syntax for this parameter is \<Type\>:\<emailaddress1\>,\<Type\>:\<emailaddress2\>,...\<Type\>:\<emailaddressN\>. The optional \<Type\> value specifies the type of email address. Some examples of valid values include: - -- SMTP: The primary SMTP address. You can use this value only once in a command. - -- smtp: Other SMTP email addresses. - -- X400: X.400 addresses in on-premises Exchange. - -- X500: X.500 addresses in on-premises Exchange. - -If you don't include a \<Type\> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - -To specify the primary SMTP email address, you can use any of the following methods: - -- Use the \<Type\> value SMTP on the address. - -- The first email address when you don't use any \<Type\> values, or when you use multiple \<Type\> values of smtp. - -- If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. - -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",..."\<Type\>:\<emailaddressN\>". - -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\<Type\>:\<emailaddress1\>","\<Type\>:\<emailaddress2\>",...; Remove="\<Type\>:\<emailaddress2\>","\<Type\>:\<emailaddress2\>",...}. - -```yaml -Type: ProxyAddressCollection -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute1 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute2 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute3 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute4 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionCustomAttribute5 -The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. - -For more information about custom attributes, see Custom attributes (https://technet.microsoft.com/library/ee423541.aspx). - -For more information about using multivalued properties, see Modifying multivalued properties (https://technet.microsoft.com/library/bb684908.aspx). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this Office 365 Group. Although messages that are sent on behalf of the group clearly show the sender in the From field (\<Sender\> on behalf of \<Office365Group\>), 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: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -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, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">. - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}. - -By default, this parameter is blank, which means no one else has permission to send on behalf of this Office 365 Group group. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether the Office 365 Group appears in the global address list (GAL) and other address lists in your organization. Valid values are: - -- $true: The Office 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 Office 365 Group, the group will still appear in the navigation pane in Outlook and Outlook on the web. - -- $false: The Office 365 Group is visible in the GAL and other address lists. This is the default value. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenFromExchangeClientsEnabled -The HiddenFromExchangeClientsEnabled switch specifies whether the Office 365 Group is hidden from Outlook clients connected to Office 365. - -- To enable this setting, you don't need to specify a value with this switch. The Office 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't be visible in the global address list (GAL). The group name won't resolve during the creation a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. Additionally, the HiddenFromAddressListsEnabled property will also be set to true to prevent the group from showing in the GAL and in the Offline Address Book (OAB). - -- To disable this setting, use this exact syntax: -HiddenFromExchangeClientsEnabled:$false. The Office 365 Group is not hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -The Language parameter specifies language preference for the Office 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://go.microsoft.com/fwlink/p/?linkId=184859). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailboxRegion -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTip -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: - -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. - -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTipTranslations -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: - -@{Add="\<culture 1\>:\<localized text 1\>","\<culture 2\>:\<localized text 2\>"...; Remove="\<culture 3\>:\<localized text 3\>","\<culture 4\>:\<localized text 4\>"...} - -\<culture\> is a valid ISO 639 two-letter culture code that's associated with the language. - -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameter specifies the description of the Office 365 Group. If the value contains spaces, enclose the value in quotation marks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RejectMessagesFromSendersOrMembers -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. - -To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \<sender1\>,\<sender2\>,...\<senderN\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<sender1\>","\<sender2\>",..."\<senderN\>". - -To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. - -The individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command. - -By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSenderAuthenticationEnabled -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. - -- $false: Messages are accepted from authenticated (internal) and unauthenticated (external) senders. - -```yaml -Type: $true | $false -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnifiedGroupWelcomeMessageEnabled -The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disable sending system-generated welcome messages to users who are added as members to the Office 365 Group. - -- To enable this setting, you don't need to specify a value with this switch. - -- To disable this setting, use this exact syntax: -UnifiedGroupWelcomeMessageEnabled:$false. - -This setting is enabled by default. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/e120e5c5-8643-4623-a15d-f97811f58e99.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Set-User.md b/exchange/exchange-ps/exchange/users-and-groups/Set-User.md deleted file mode 100644 index 3a05873e36..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Set-User.md +++ /dev/null @@ -1,1106 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -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 -monikerRange: "exchserver-ps-2010 || exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps || eop-ps" ---- - -# 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. - -Use the Set-User cmdlet to modify user attributes. You can use this cmdlet to modify all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Set-User [-Identity] <UserIdParameter> - [-AllowUMCallsFromNonUsers <None | SearchEnabled>] - [-Arbitration] - [-AssistantName <String>] - [-CertificateSubject <MultiValuedProperty>] - [-City <String>] - [-Company <String>] - [-Confirm] - [-CountryOrRegion <CountryInfo>] - [-CreateDTMFMap <$true | $false>] - [-Department <String>] - [-DisplayName <String>] - [-DomainController <Fqdn>] - [-Fax <String>] - [-FirstName <String>] - [-Force] - [-GeoCoordinates <GeoCoordinates>] - [-HomePhone <String>] - [-IgnoreDefaultScope] - [-Initials <String>] - [-LastName <String>] - [-LinkedCredential <PSCredential>] - [-LinkedDomainController <String>] - [-LinkedMasterAccount <UserIdParameter>] - [-Manager <UserContactIdParameter>] - [-MobilePhone <String>] - [-Name <String>] - [-Notes <String>] - [-Office <String>] - [-OtherFax <MultiValuedProperty>] - [-OtherHomePhone <MultiValuedProperty>] - [-OtherTelephone <MultiValuedProperty>] - [-Pager <String>] - [-PermanentlyClearPreviousMailboxInfo] - [-Phone <String>] - [-PhoneticDisplayName <String>] - [-PostalCode <String>] - [-PostOfficeBox <MultiValuedProperty>] - [-PublicFolder] - [-RemotePowerShellEnabled <$true | $false>] - [-RemoveMailboxProvisioningConstraint] - [-ResetPasswordOnNextLogon <$true | $false>] - [-SamAccountName <String>] - [-SeniorityIndex <Int32>] - [-SimpleDisplayName <String>] - [-SkipDualWrite] - [-StateOrProvince <String>] - [-StreetAddress <String>] - [-StsRefreshTokensValidFrom <DateTime>] - [-TelephoneAssistant <String>] - [-Title <String>] - [-UMCallingLineIds <MultiValuedProperty>] - [-UMDtmfMap <MultiValuedProperty>] - [-UserPrincipalName <String>] - [-WebPage <String>] - [-WhatIf] - [-WindowsEmailAddress <SmtpAddress>] - [<CommonParameters>] -``` - -## 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://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-User -Identity Contoso\Jill -DisplayName "Jill Frank" -``` - -This example sets the display name for user Jill Frank. - -### -------------------------- Example 2 -------------------------- -``` -Set-User -Identity Kweku@fabrikam.com -LinkedMasterAccount $null -``` - -This example unlinks the linked mailbox Kweku@fabrikam.com and converts it to a user mailbox by setting the LinkedMasterAccount parameter to $null. - -Performing this procedure on a linked mailbox removes all permissions on the mailbox such as Send As, Full Access, folder and calendar delegation. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. - -For example: - -- Name - -- Display name - -- Distinguished name (DN) - -- Canonical DN - -- GUID - -```yaml -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 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AllowUMCallsFromNonUsers -The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from directory searches. - -```yaml -Type: None | SearchEnabled -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Arbitration -This parameter is available only in on-premises Exchange. - -The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssistantName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateSubject -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. - -```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: False -Accept wildcard characters: False -``` - -### -City -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Company -The Company parameter specifies the user's company. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -The CountryOrRegion parameter specifies the user's country or region. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDTMFMap -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. - -- $false: A DTMF map isn't created for the recipient. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Department -The Department parameter specifies the user's department. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the user. The display name is visible in the Exchange admin center and in Active Directory. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fax -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is available only in the cloud-based service. - -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeoCoordinates -The GeoCoordinates parameter specifies the user's physical location in latitude, longitude and altitude coordinates. Use this parameter to specify the global position of physical resources, such as conference rooms. You have to specify one of the following sets of coordinates; use semicolons to separate the values. - -- Latitude and longitude; for example, "47.644125;-122.122411" - -- Latitude, longitude and altitude; for example, "47.644125;-122.122411;161.432" - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePhone -The HomePhone parameter specifies the user's home telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. - -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The LastName parameter specifies the user's last name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedCredential -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. - -You can only use the LinkedCredential parameter with a linked user. - -This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122). - -```yaml -Type: PSCredential -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 -``` - -### -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 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. - -This parameter is required only if you're connecting a linked user. - -```yaml -Type: String -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 -``` - -### -LinkedMasterAccount -This parameter is available only in on-premises Exchange. - -The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if 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: - -- GUID - -- DN - -- Domain\\Account - -- UPN - -- LegacyExchangeDN - -- SmtpAddress - -- 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. - -This parameter is required only if you're connecting a linked user. - -```yaml -Type: UserIdParameter -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 -``` - -### -Manager -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobilePhone -The MobilePhone parameter specifies the user's primary mobile phone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OtherFax -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OtherHomePhone -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OtherTelephone -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pager -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermanentlyClearPreviousMailboxInfo -The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange mailbox attributes on a user. You don't need to specify a value with this switch. - -Clearing these attributes might be required in mailbox move and re-licensing scenarios between on-premises Exchange and Office 365. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Phone -The Phone parameter specifies the user'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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneticDisplayName -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -The PostalCode parameter specifies the user's zip code or postal code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostOfficeBox -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicFolder -The PublicFolder switch specifies that the user is a public folder mailbox. This switch is required to only when you change the settings of public folder mailboxes. You don't need to specify a value with this switch. - -Public folder mailboxes are specially designed mailboxes to store the hierarchy and content of public folders. - -```yaml -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user has access to remote PowerShell. Remote PowerShell access is required to open the Exchange Management Shell or the Exchange admin center (EAC), even if you're trying to open the Exchange Management Shell or the EAC on the local Mailbox server. Valid values are: - -- $true: The user has access to remote PowerShell. - -- $false: The user doesn't have access to remote PowerShell. - -The default value depends on the management roles that are assigned to the user. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveMailboxProvisioningConstraint -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetPasswordOnNextLogon -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. - -```yaml -Type: $true | $false -Parameter Sets: (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 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -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 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. - -```yaml -Type: String -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 -``` - -### -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. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleDisplayName -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 - -- A - Z - -- 0 - 9 - -- "\<space\>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDualWrite -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetAddress -The StreetAddress parameter specifies the user's physical address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StsRefreshTokensValidFrom -This parameter is available only in the cloud-based service. - -The StsRefreshTokensValidFrom specifies the date-time that the user's STS refresh tokens are valid from. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneAssistant -This parameter is available only in on-premises Exchange. - -The TelephoneAssistant parameter specifies the telephone number 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The Title parameter specifies the user's title. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UMCallingLineIds -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. - -```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: False -Accept wildcard characters: False -``` - -### -UMDtmfMap -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: - -- emailAddress:\<integers\> - -- lastNameFirstName:\<integers\> - -- firstNameLastName:\<integers\> - -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\<integers\>,lastNameFirstName:\<integers\>,firstNameLastName:\<integers\>. - -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\<integers\>, all existing lastNameFirstName and firstNameLastName values are removed. - -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"; Remove="emailAddress:\<integers\>","lastNameFirstName:\<integers\>","firstNameLastName:\<integers\>"}. - -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\<integers1\>","emailAddress:\<intgers2\>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -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. - -```yaml -Type: String -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 -``` - -### -WebPage -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsEmailAddress -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. - -- In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value. - -The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value. - -```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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/56d7fc86-2ac3-4e28-bc7a-761e91ac655a.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md deleted file mode 100644 index 12274ec0b5..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online -title: Undo-SoftDeletedUnifiedGroup -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Undo-SoftDeletedUnifiedGroup - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Undo-SoftDeletedUnifiedGroup cmdlet to restore soft-deleted Office 365 groups in your cloud-based organization. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Undo-SoftDeletedUnifiedGroup [-SoftDeletedObject] <UnifiedGroupIdParameter> [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Office 365 groups are group objects that are available across Office 365 services. - -Soft-deleted Office 365 groups are groups that have been deleted, but can be restored within 30 days of being deleted. All of the group contents can be restored within this period. After 30 days, soft-deleted Office 365 groups are marked for permanent deletion and can't be restored. - -To display all soft-deleted Office 365 groups in your organization, use the Get-AzureADMSDeletedGroup cmdlet in Azure Active Directory PowerShell. To permanently remove (purge) a soft-deleted Office 365 group, use the Remove-AzureADMSDeletedDirectoryObject cmdlet in Azure Active Directory PowerShell. For more information, see [Permanently delete an Office 365 group](https://support.office.com/article/b7c66b59-657a-4e1a-8aa0-8163b1f4eb54#bkmk_perm). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Undo-SoftDeletedUnifiedGroup -SoftDeletedObject "Marketing Department" -``` - -This example restores the soft-deleted Office 365 Group named Marketing Department. - -## PARAMETERS - -### -SoftDeletedObject -The SoftDeletedObject parameter specifies the soft-deleted Office 365 Group that you want to restore. You can use any value that uniquely identifies the Office 365 Group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- \<domain name\>\\\<account name\> - -- Email address - -- GUID - -- LegacyExchangeDN - -- SamAccountName - -- User ID or user principal name (UPN) - -Note: You might need to use the DistinguishedName or ExchangeGuid property to identify the soft-deleted Office 365 Group, because it's possible for an active Office 365 Group and a soft-deleted Office 365 Group to have the same primary SMTP address. - -```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. - -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/89f09bfc-43d6-457c-978f-b699c27ea325.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Update-EOPDistributionGroupMember.md b/exchange/exchange-ps/exchange/users-and-groups/Update-EOPDistributionGroupMember.md deleted file mode 100644 index 5af9eeb8d7..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Update-EOPDistributionGroupMember.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -applicable: Exchange Online Protection -title: Update-EOPDistributionGroupMember -schema: 2.0.0 -monikerRange: "eop-ps" ---- - -# Update-EOPDistributionGroupMember - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Update-EOPDistributionGroupMember cmdlet to add or remove members from distribution groups and mail-enabled security groups in Microsoft Exchange Online Protection (EOP) standalone. This cmdlet isn't available in Exchange Enterprise CAL with Services (EOP Premium). In EOP Premium, use the Update-DistributionGroupMember cmdlet. - -Typically, EOP standalone customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Update-EOPDistributionGroupMember [-ExternalDirectoryObjectId <String>] - [-Identity <DistributionGroupIdParameter>] [-Members <String[]>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-EOPDistributionGroupMember -Identity "Security Team" -Members @("Kitty Petersen","Tyson Fawcett") -``` - -This example replaces the current members of the Security Team distribution group with Kitty Petersen and Tyson Fawcett. - -### -------------------------- Example 2 -------------------------- -``` -$CurrentMemberObjects = Get-DistributionGroupMember "Security Team"; $CurrentMemberNames = $CurrentMemberObjects | % {$_.name}; $CurrentMemberNames += "Tyson Fawcett"; Update-EOPDistributionGroupMember -Identity "Security Team" -Members $CurrentMemberNames -``` - -This example adds a new user named Tyson Fawcett to the distribution group named Security Team while preserving the current members of the group. The current member objects are retrieved in a collection, the collection is filtered to extract the names, the user "Tyson Fawcett" is added, and the updated name list replaces the current membership of the distribution group. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to update. You can use any value that uniquely identifies the group. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the list of recipients (mail-enabled objects) in the distribution group or mail-enabled security group. In Exchange Online Protection, the valid recipient types are: - -- Mail users - -- Distribution groups - -- Mail-enabled security groups - -You can use any value that uniquely identifies the recipient. - -For example: - -- Name - -- Display name - -- Alias - -- Distinguished name (DN) - -- Canonical DN - -- Email address - -- GUID - -To replace the current members of the group with the recipients that you specify, use the syntax @("\<recipient1\>","\<recipient2\>"...). To add new group members without affecting the existing members, see Example 2 in the Examples section. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/a6d4f790-1b94-42f8-af6f-fa79c504d8ec.aspx) diff --git a/exchange/exchange-ps/exchange/users-and-groups/Upgrade-DistributionGroup.md b/exchange/exchange-ps/exchange/users-and-groups/Upgrade-DistributionGroup.md deleted file mode 100644 index 241eeb68ed..0000000000 --- a/exchange/exchange-ps/exchange/users-and-groups/Upgrade-DistributionGroup.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -applicable: Exchange Online -title: Upgrade-DistributionGroup -schema: 2.0.0 -monikerRange: "exchonline-ps" ---- - -# Upgrade-DistributionGroup - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Upgrade-DistributionGroup cmdlet to upgrade distribution groups to Office 365 groups. This cmdlet only works on distribution groups, not mail-enabled security groups. - -Note: Before you use this cmdlet, verify there are no email address policies that you created with the IncludeUnifiedGroupRecipients parameter; otherwise the command will fail. Remove and recreate the email address policies after you upgrade your distribution groups to Office 365 groups. - -For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). - -## SYNTAX - -``` -Upgrade-DistributionGroup [-DlIdentities] <MultiValuedProperty> [-ActionType <String>] - [-ExecutingUser <RecipientIdParameter>] [<CommonParameters>] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Upgrade-DistributionGroup -DlIdentities hr@contoso.com,finance@contoso.com -``` - -This example upgrades the specified distribution groups to Office 365 groups. - -## PARAMETERS - -### -DlIdentities -The DlIdentities parameter specifies the email address of the distribution group that you want to upgrade to an Office 365 Group. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActionType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutingUser -This parameter is reserved for internal Microsoft use. - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS - -[Online Version](https://technet.microsoft.com/library/5a220f26-585d-4aa7-812d-9fbcd29979ab.aspx) diff --git a/exchange/mapping/MAML2Yaml/monikerMapping.json b/exchange/mapping/MAML2Yaml/monikerMapping.json new file mode 100644 index 0000000000..4e2ae5eca8 --- /dev/null +++ b/exchange/mapping/MAML2Yaml/monikerMapping.json @@ -0,0 +1,12 @@ +{ + "exchange-ps": { + "conceptualToc": "docs-conceptual/toc.yml", + "conceptualTocUrl": "/powershell/exchange/exchange-ps/toc.json", + "referenceTocUrl": "/powershell/module/exchange-ps/toc.json", + "packageRoot": "exchange-ps", + "serviceMap": "mapping/serviceMapping.json", + "modules": { + "exchange": {} + } + } +} \ No newline at end of file diff --git a/exchange/mapping/monikerMapping.json b/exchange/mapping/monikerMapping.json deleted file mode 100644 index 848fc16750..0000000000 --- a/exchange/mapping/monikerMapping.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "exchange-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/exchange/exchange-ps/toc.json", - "referenceTocUrl": "/powershell/module/exchange-ps/toc.json", - "packageRoot": "exchange-ps", - "modules": { - "exchange": {} - } - } -} \ No newline at end of file diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json new file mode 100644 index 0000000000..b6691a949e --- /dev/null +++ b/exchange/mapping/serviceMapping.json @@ -0,0 +1,1407 @@ +{ + "Add-ADPermission": "active-directory", + "Dump-ProvisioningCache": "active-directory", + "Get-ADPermission": "active-directory", + "Get-ADServerSettings": "active-directory", + "Get-ADSite": "active-directory", + "Get-AdSiteLink": "active-directory", + "Get-DomainController": "active-directory", + "Get-OrganizationalUnit": "active-directory", + "Get-Trust": "active-directory", + "Get-UserPrincipalNamesSuffix": "active-directory", + "Remove-ADPermission": "active-directory", + "Reset-ProvisioningCache": "active-directory", + "Set-ADServerSettings": "active-directory", + "Set-ADSite": "active-directory", + "Set-AdSiteLink": "active-directory", + "Disable-AntiPhishRule": "defender-for-office-365", + "Disable-ATPProtectionPolicyRule": "defender-for-office-365", + "Disable-SafeAttachmentRule": "defender-for-office-365", + "Disable-SafeLinksRule": "defender-for-office-365", + "Enable-AntiPhishRule": "defender-for-office-365", + "Enable-ATPProtectionPolicyRule": "defender-for-office-365", + "Enable-SafeAttachmentRule": "defender-for-office-365", + "Enable-SafeLinksRule": "defender-for-office-365", + "Get-AntiPhishPolicy": "defender-for-office-365", + "Get-AntiPhishRule": "defender-for-office-365", + "Get-ATPBuiltInProtectionRule": "defender-for-office-365", + "Get-AtpPolicyForO365": "defender-for-office-365", + "Get-ATPProtectionPolicyRule": "defender-for-office-365", + "Get-ATPTotalTrafficReport": "defender-for-office-365", + "Get-ContentMalwareMdoAggregateReport": "defender-for-office-365", + "Get-ContentMalwareMdoDetailReport": "defender-for-office-365", + "Get-EmailTenantSettings": "defender-for-office-365", + "Get-MailDetailATPReport": "defender-for-office-365", + "Get-MailTrafficATPReport": "defender-for-office-365", + "Get-SafeAttachmentPolicy": "defender-for-office-365", + "Get-SafeAttachmentRule": "defender-for-office-365", + "Get-SafeLinksAggregateReport": "defender-for-office-365", + "Get-SafeLinksDetailReport": "defender-for-office-365", + "Get-SafeLinksPolicy": "defender-for-office-365", + "Get-SafeLinksRule": "defender-for-office-365", + "Get-SpoofIntelligenceInsight": "defender-for-office-365", + "Get-SpoofMailReport": "defender-for-office-365", + "New-AntiPhishPolicy": "defender-for-office-365", + "New-AntiPhishRule": "defender-for-office-365", + "New-ATPBuiltInProtectionRule": "defender-for-office-365", + "New-ATPProtectionPolicyRule": "defender-for-office-365", + "New-SafeAttachmentPolicy": "defender-for-office-365", + "New-SafeAttachmentRule": "defender-for-office-365", + "New-SafeLinksPolicy": "defender-for-office-365", + "New-SafeLinksRule": "defender-for-office-365", + "Remove-AntiPhishPolicy": "defender-for-office-365", + "Remove-AntiPhishRule": "defender-for-office-365", + "Remove-ATPProtectionPolicyRule": "defender-for-office-365", + "Remove-SafeAttachmentPolicy": "defender-for-office-365", + "Remove-SafeAttachmentRule": "defender-for-office-365", + "Remove-SafeLinksPolicy": "defender-for-office-365", + "Remove-SafeLinksRule": "defender-for-office-365", + "Set-AntiPhishPolicy": "defender-for-office-365", + "Set-AntiPhishRule": "defender-for-office-365", + "Set-ATPBuiltInProtectionRule": "defender-for-office-365", + "Set-AtpPolicyForO365": "defender-for-office-365", + "Set-ATPProtectionPolicyRule": "defender-for-office-365", + "Set-EmailTenantSettings": "defender-for-office-365", + "Set-SafeAttachmentPolicy": "defender-for-office-365", + "Set-SafeAttachmentRule": "defender-for-office-365", + "Set-SafeLinksPolicy": "defender-for-office-365", + "Set-SafeLinksRule": "defender-for-office-365", + "Add-AttachmentFilterEntry": "antispam-antimalware", + "Add-ContentFilterPhrase": "antispam-antimalware", + "Add-IPAllowListEntry": "antispam-antimalware", + "Add-IPAllowListProvider": "antispam-antimalware", + "Add-IPBlockListEntry": "antispam-antimalware", + "Add-IPBlockListProvider": "antispam-antimalware", + "Delete-QuarantineMessage": "antispam-antimalware", + "Disable-EOPProtectionPolicyRule": "antispam-antimalware", + "Disable-HostedContentFilterRule": "antispam-antimalware", + "Disable-HostedOutboundSpamFilterRule": "antispam-antimalware", + "Disable-MalwareFilterRule": "antispam-antimalware", + "Disable-ReportSubmissionRule": "antispam-antimalware", + "Enable-AntispamUpdates": "antispam-antimalware", + "Enable-EOPProtectionPolicyRule": "antispam-antimalware", + "Enable-HostedContentFilterRule": "antispam-antimalware", + "Enable-HostedOutboundSpamFilterRule": "antispam-antimalware", + "Enable-MalwareFilterRule": "antispam-antimalware", + "Export-QuarantineMessage": "antispam-antimalware", + "Enable-ReportSubmissionRule": "antispam-antimalware", + "Get-AgentLog": "antispam-antimalware", + "Get-AggregateZapReport": "antispam-antimalware", + "Get-ArcConfig": "antispam-antimalware", + "Get-AttachmentFilterEntry": "antispam-antimalware", + "Get-AttachmentFilterListConfig": "antispam-antimalware", + "Get-BlockedConnector": "antispam-antimalware", + "Get-BlockedSenderAddress": "antispam-antimalware", + "Get-ConfigAnalyzerPolicyRecommendation": "antispam-antimalware", + "Get-ContentFilterConfig": "antispam-antimalware", + "Get-ContentFilterPhrase": "antispam-antimalware", + "Get-CustomizedUserSubmission": "antispam-antimalware", + "Get-DetailZapReport": "antispam-antimalware", + "Get-DkimSigningConfig": "antispam-antimalware", + "Get-EOPProtectionPolicyRule": "antispam-antimalware", + "Get-ExoPhishSimOverrideRule": "antispam-antimalware", + "Get-ExoSecOpsOverrideRule": "antispam-antimalware", + "Get-HostedConnectionFilterPolicy": "antispam-antimalware", + "Get-HostedContentFilterPolicy": "antispam-antimalware", + "Get-HostedContentFilterRule": "antispam-antimalware", + "Get-HostedOutboundSpamFilterPolicy": "antispam-antimalware", + "Get-HostedOutboundSpamFilterRule": "antispam-antimalware", + "Get-IPAllowListConfig": "antispam-antimalware", + "Get-IPAllowListEntry": "antispam-antimalware", + "Get-IPAllowListProvider": "antispam-antimalware", + "Get-IPAllowListProvidersConfig": "antispam-antimalware", + "Get-IPBlockListConfig": "antispam-antimalware", + "Get-IPBlockListEntry": "antispam-antimalware", + "Get-IPBlockListProvider": "antispam-antimalware", + "Get-IPBlockListProvidersConfig": "antispam-antimalware", + "Get-MailboxJunkEmailConfiguration": "antispam-antimalware", + "Get-MalwareFilteringServer": "antispam-antimalware", + "Get-MalwareFilterPolicy": "antispam-antimalware", + "Get-MalwareFilterRule": "antispam-antimalware", + "Get-PhishSimOverridePolicy": "antispam-antimalware", + "Get-QuarantineMessage": "antispam-antimalware", + "Get-QuarantineMessageHeader": "antispam-antimalware", + "Get-QuarantinePolicy": "antispam-antimalware", + "Get-RecipientFilterConfig": "antispam-antimalware", + "Get-ReportSubmissionPolicy": "antispam-antimalware", + "Get-ReportSubmissionRule": "antispam-antimalware", + "Get-SecOpsOverridePolicy": "antispam-antimalware", + "Get-SenderFilterConfig": "antispam-antimalware", + "Get-SenderIdConfig": "antispam-antimalware", + "Get-SenderReputationConfig": "antispam-antimalware", + "Get-TeamsProtectionPolicy": "antispam-antimalware", + "Get-TeamsProtectionPolicyRule": "antispam-antimalware", + "Get-TenantAllowBlockListItems": "antispam-antimalware", + "Get-TenantAllowBlockListSpoofItems": "antispam-antimalware", + "New-DkimSigningConfig": "antispam-antimalware", + "New-EOPProtectionPolicyRule": "antispam-antimalware", + "New-ExoPhishSimOverrideRule": "antispam-antimalware", + "New-ExoSecOpsOverrideRule": "antispam-antimalware", + "New-HostedContentFilterPolicy": "antispam-antimalware", + "New-HostedContentFilterRule": "antispam-antimalware", + "New-HostedOutboundSpamFilterPolicy": "antispam-antimalware", + "New-HostedOutboundSpamFilterRule": "antispam-antimalware", + "New-MalwareFilterPolicy": "antispam-antimalware", + "New-MalwareFilterRule": "antispam-antimalware", + "New-PhishSimOverridePolicy": "antispam-antimalware", + "New-QuarantinePermissions": "antispam-antimalware", + "New-QuarantinePolicy": "antispam-antimalware", + "New-ReportSubmissionPolicy": "antispam-antimalware", + "New-ReportSubmissionRule": "antispam-antimalware", + "New-SecOpsOverridePolicy": "antispam-antimalware", + "New-TeamsProtectionPolicy": "antispam-antimalware", + "New-TeamsProtectionPolicyRule": "antispam-antimalware", + "New-TenantAllowBlockListItems": "antispam-antimalware", + "New-TenantAllowBlockListSpoofItems": "antispam-antimalware", + "Preview-QuarantineMessage": "antispam-antimalware", + "Release-QuarantineMessage": "antispam-antimalware", + "Remove-AttachmentFilterEntry": "antispam-antimalware", + "Remove-BlockedConnector": "antispam-antimalware", + "Remove-BlockedSenderAddress": "antispam-antimalware", + "Remove-ContentFilterPhrase": "antispam-antimalware", + "Remove-EOPProtectionPolicyRule": "antispam-antimalware", + "Remove-ExoPhishSimOverrideRule": "antispam-antimalware", + "Remove-ExoSecOpsOverrideRule": "antispam-antimalware", + "Remove-HostedContentFilterPolicy": "antispam-antimalware", + "Remove-HostedContentFilterRule": "antispam-antimalware", + "Remove-HostedOutboundSpamFilterPolicy": "antispam-antimalware", + "Remove-HostedOutboundSpamFilterRule": "antispam-antimalware", + "Remove-IPAllowListEntry": "antispam-antimalware", + "Remove-IPAllowListProvider": "antispam-antimalware", + "Remove-IPBlockListEntry": "antispam-antimalware", + "Remove-IPBlockListProvider": "antispam-antimalware", + "Remove-MalwareFilterPolicy": "antispam-antimalware", + "Remove-MalwareFilterRule": "antispam-antimalware", + "Remove-PhishSimOverridePolicy": "antispam-antimalware", + "Remove-QuarantinePolicy": "antispam-antimalware", + "Remove-ReportSubmissionPolicy": "antispam-antimalware", + "Remove-ReportSubmissionRule": "antispam-antimalware", + "Remove-SecOpsOverridePolicy": "antispam-antimalware", + "Remove-TenantAllowBlockListItems": "antispam-antimalware", + "Remove-TenantAllowBlockListSpoofItems": "antispam-antimalware", + "Rotate-DkimSigningConfig": "antispam-antimalware", + "Set-ArcConfig": "antispam-antimalware", + "Set-AttachmentFilterListConfig": "antispam-antimalware", + "Set-ContentFilterConfig": "antispam-antimalware", + "Set-DkimSigningConfig": "antispam-antimalware", + "Set-EOPProtectionPolicyRule": "antispam-antimalware", + "Set-ExoPhishSimOverrideRule": "antispam-antimalware", + "Set-ExoSecOpsOverrideRule": "antispam-antimalware", + "Set-HostedConnectionFilterPolicy": "antispam-antimalware", + "Set-HostedContentFilterPolicy": "antispam-antimalware", + "Set-HostedContentFilterRule": "antispam-antimalware", + "Set-HostedOutboundSpamFilterPolicy": "antispam-antimalware", + "Set-HostedOutboundSpamFilterRule": "antispam-antimalware", + "Set-IPAllowListConfig": "antispam-antimalware", + "Set-IPAllowListProvider": "antispam-antimalware", + "Set-IPAllowListProvidersConfig": "antispam-antimalware", + "Set-IPBlockListConfig": "antispam-antimalware", + "Set-IPBlockListProvider": "antispam-antimalware", + "Set-IPBlockListProvidersConfig": "antispam-antimalware", + "Set-MailboxJunkEmailConfiguration": "antispam-antimalware", + "Set-MalwareFilteringServer": "antispam-antimalware", + "Set-MalwareFilterPolicy": "antispam-antimalware", + "Set-MalwareFilterRule": "antispam-antimalware", + "Set-PhishSimOverridePolicy": "antispam-antimalware", + "Set-QuarantinePermissions": "antispam-antimalware", + "Set-QuarantinePolicy": "antispam-antimalware", + "Set-RecipientFilterConfig": "antispam-antimalware", + "Set-ReportSubmissionPolicy": "antispam-antimalware", + "Set-ReportSubmissionRule": "antispam-antimalware", + "Set-SecOpsOverridePolicy": "antispam-antimalware", + "Set-SenderFilterConfig": "antispam-antimalware", + "Set-SenderIdConfig": "antispam-antimalware", + "Set-SenderReputationConfig": "antispam-antimalware", + "Set-TeamsProtectionPolicy": "antispam-antimalware", + "Set-TeamsProtectionPolicyRule": "antispam-antimalware", + "Set-TenantAllowBlockListItems": "antispam-antimalware", + "Set-TenantAllowBlockListSpoofItems": "antispam-antimalware", + "Test-IPAllowListProvider": "antispam-antimalware", + "Test-IPBlockListProvider": "antispam-antimalware", + "Test-SenderId": "antispam-antimalware", + "Update-SafeList": "antispam-antimalware", + "Clear-TextMessagingAccount": "client-access", + "Compare-TextMessagingVerificationCode": "client-access", + "Disable-PushNotificationProxy": "client-access", + "Enable-PushNotificationProxy": "client-access", + "Export-AutoDiscoverConfig": "client-access", + "Get-CASMailbox": "client-access", + "Get-CASMailboxPlan": "client-access", + "Get-ClientAccessRule": "client-access", + "Get-ImapSettings": "client-access", + "Get-MailboxCalendarConfiguration": "client-access", + "Get-MailboxMessageConfiguration": "client-access", + "Get-MailboxRegionalConfiguration": "client-access", + "Get-MailboxSpellingConfiguration": "client-access", + "Get-OutlookProvider": "client-access", + "Get-OwaMailboxPolicy": "client-access", + "Get-PopSettings": "client-access", + "Get-TextMessagingAccount": "client-access", + "New-ClientAccessRule": "client-access", + "New-OutlookProvider": "client-access", + "New-OwaMailboxPolicy": "client-access", + "Remove-ClientAccessRule": "client-access", + "Remove-OutlookProvider": "client-access", + "Remove-OwaMailboxPolicy": "client-access", + "Send-TextMessagingVerificationCode": "client-access", + "Set-CASMailbox": "client-access", + "Set-CASMailboxPlan": "client-access", + "Set-ClientAccessRule": "client-access", + "Set-ImapSettings": "client-access", + "Set-MailboxCalendarConfiguration": "client-access", + "Set-MailboxMessageConfiguration": "client-access", + "Set-MailboxRegionalConfiguration": "client-access", + "Set-MailboxSpellingConfiguration": "client-access", + "Set-OutlookProvider": "client-access", + "Set-OwaMailboxPolicy": "client-access", + "Set-PopSettings": "client-access", + "Set-TextMessagingAccount": "client-access", + "Test-CalendarConnectivity": "client-access", + "Test-ClientAccessRule": "client-access", + "Test-EcpConnectivity": "client-access", + "Test-ImapConnectivity": "client-access", + "Test-OutlookConnectivity": "client-access", + "Test-OutlookWebServices": "client-access", + "Test-OwaConnectivity": "client-access", + "Test-PopConnectivity": "client-access", + "Test-PowerShellConnectivity": "client-access", + "Test-WebServicesConnectivity": "client-access", + "Disable-OutlookAnywhere": "client-access-servers", + "Enable-OutlookAnywhere": "client-access-servers", + "Get-ActiveSyncVirtualDirectory": "client-access-servers", + "Get-AuthRedirect": "client-access-servers", + "Get-AutodiscoverVirtualDirectory": "client-access-servers", + "Get-ClientAccessArray": "client-access-servers", + "Get-ClientAccessServer": "client-access-servers", + "Get-ClientAccessService": "client-access-servers", + "Get-EcpVirtualDirectory": "client-access-servers", + "Get-MapiVirtualDirectory": "client-access-servers", + "Get-OutlookAnywhere": "client-access-servers", + "Get-OwaVirtualDirectory": "client-access-servers", + "Get-PowerShellVirtualDirectory": "client-access-servers", + "Get-RpcClientAccess": "client-access-servers", + "Get-WebServicesVirtualDirectory": "client-access-servers", + "New-ActiveSyncVirtualDirectory": "client-access-servers", + "New-AuthRedirect": "client-access-servers", + "New-AutodiscoverVirtualDirectory": "client-access-servers", + "New-ClientAccessArray": "client-access-servers", + "New-EcpVirtualDirectory": "client-access-servers", + "New-MapiVirtualDirectory": "client-access-servers", + "New-OwaVirtualDirectory": "client-access-servers", + "New-PowerShellVirtualDirectory": "client-access-servers", + "New-RpcClientAccess": "client-access-servers", + "New-WebServicesVirtualDirectory": "client-access-servers", + "Remove-ActiveSyncVirtualDirectory": "client-access-servers", + "Remove-AuthRedirect": "client-access-servers", + "Remove-AutodiscoverVirtualDirectory": "client-access-servers", + "Remove-ClientAccessArray": "client-access-servers", + "Remove-EcpVirtualDirectory": "client-access-servers", + "Remove-MapiVirtualDirectory": "client-access-servers", + "Remove-OwaVirtualDirectory": "client-access-servers", + "Remove-PowerShellVirtualDirectory": "client-access-servers", + "Remove-RpcClientAccess": "client-access-servers", + "Remove-WebServicesVirtualDirectory": "client-access-servers", + "Set-ActiveSyncVirtualDirectory": "client-access-servers", + "Set-AuthRedirect": "client-access-servers", + "Set-AutodiscoverVirtualDirectory": "client-access-servers", + "Set-ClientAccessArray": "client-access-servers", + "Set-ClientAccessServer": "client-access-servers", + "Set-ClientAccessService": "client-access-servers", + "Set-EcpVirtualDirectory": "client-access-servers", + "Set-MapiVirtualDirectory": "client-access-servers", + "Set-OutlookAnywhere": "client-access-servers", + "Set-OwaVirtualDirectory": "client-access-servers", + "Set-PowerShellVirtualDirectory": "client-access-servers", + "Set-RpcClientAccess": "client-access-servers", + "Set-WebServicesVirtualDirectory": "client-access-servers", + "Add-DatabaseAvailabilityGroupServer": "database-availability-groups", + "Add-MailboxDatabaseCopy": "database-availability-groups", + "Get-DatabaseAvailabilityGroup": "database-availability-groups", + "Get-DatabaseAvailabilityGroupNetwork": "database-availability-groups", + "Get-MailboxDatabaseCopyStatus": "database-availability-groups", + "Move-ActiveMailboxDatabase": "database-availability-groups", + "New-DatabaseAvailabilityGroup": "database-availability-groups", + "New-DatabaseAvailabilityGroupNetwork": "database-availability-groups", + "Remove-DatabaseAvailabilityGroup": "database-availability-groups", + "Remove-DatabaseAvailabilityGroupNetwork": "database-availability-groups", + "Remove-DatabaseAvailabilityGroupServer": "database-availability-groups", + "Remove-MailboxDatabaseCopy": "database-availability-groups", + "Restore-DatabaseAvailabilityGroup": "database-availability-groups", + "Resume-MailboxDatabaseCopy": "database-availability-groups", + "Set-DatabaseAvailabilityGroup": "database-availability-groups", + "Set-DatabaseAvailabilityGroupNetwork": "database-availability-groups", + "Set-MailboxDatabaseCopy": "database-availability-groups", + "Start-DatabaseAvailabilityGroup": "database-availability-groups", + "Stop-DatabaseAvailabilityGroup": "database-availability-groups", + "Suspend-MailboxDatabaseCopy": "database-availability-groups", + "Test-ReplicationHealth": "database-availability-groups", + "Update-MailboxDatabaseCopy": "database-availability-groups", + "Clear-ActiveSyncDevice": "devices", + "Clear-MobileDevice": "devices", + "Export-ActiveSyncLog": "devices", + "Get-ActiveSyncDevice": "devices", + "Get-ActiveSyncDeviceAccessRule": "devices", + "Get-ActiveSyncDeviceAutoblockThreshold": "devices", + "Get-ActiveSyncDeviceClass": "devices", + "Get-ActiveSyncDeviceStatistics": "devices", + "Get-ActiveSyncMailboxPolicy": "devices", + "Get-ActiveSyncOrganizationSettings": "devices", + "Get-DeviceConditionalAccessPolicy": "devices", + "Get-DeviceConditionalAccessRule": "devices", + "Get-DeviceConfigurationPolicy": "devices", + "Get-DeviceConfigurationRule": "devices", + "Get-DevicePolicy": "devices", + "Get-DeviceTenantPolicy": "devices", + "Get-DeviceTenantRule": "devices", + "Get-MobileDevice": "devices", + "Get-MobileDeviceMailboxPolicy": "devices", + "Get-MobileDeviceStatistics": "devices", + "New-ActiveSyncDeviceAccessRule": "devices", + "New-ActiveSyncMailboxPolicy": "devices", + "New-DeviceConditionalAccessPolicy": "devices", + "New-DeviceConditionalAccessRule": "devices", + "New-DeviceConfigurationPolicy": "devices", + "New-DeviceConfigurationRule": "devices", + "New-DeviceTenantPolicy": "devices", + "New-DeviceTenantRule": "devices", + "New-MobileDeviceMailboxPolicy": "devices", + "Remove-ActiveSyncDevice": "devices", + "Remove-ActiveSyncDeviceAccessRule": "devices", + "Remove-ActiveSyncDeviceClass": "devices", + "Remove-ActiveSyncMailboxPolicy": "devices", + "Remove-DeviceConditionalAccessPolicy": "devices", + "Remove-DeviceConditionalAccessRule": "devices", + "Remove-DeviceConfigurationPolicy": "devices", + "Remove-DeviceConfigurationRule": "devices", + "Remove-DeviceTenantPolicy": "devices", + "Remove-DeviceTenantRule": "devices", + "Remove-MobileDevice": "devices", + "Remove-MobileDeviceMailboxPolicy": "devices", + "Set-ActiveSyncDeviceAccessRule": "devices", + "Set-ActiveSyncDeviceAutoblockThreshold": "devices", + "Set-ActiveSyncMailboxPolicy": "devices", + "Set-ActiveSyncOrganizationSettings": "devices", + "Set-DeviceConditionalAccessPolicy": "devices", + "Set-DeviceConditionalAccessRule": "devices", + "Set-DeviceConfigurationPolicy": "devices", + "Set-DeviceConfigurationRule": "devices", + "Set-DeviceTenantPolicy": "devices", + "Set-DeviceTenantRule": "devices", + "Set-MobileDeviceMailboxPolicy": "devices", + "Test-ActiveSyncConnectivity": "devices", + "Disable-AddressListPaging": "email-addresses-and-address-books", + "Enable-AddressListPaging": "email-addresses-and-address-books", + "Get-AddressBookPolicy": "email-addresses-and-address-books", + "Get-AddressList": "email-addresses-and-address-books", + "Get-DetailsTemplate": "email-addresses-and-address-books", + "Get-EmailAddressPolicy": "email-addresses-and-address-books", + "Get-GlobalAddressList": "email-addresses-and-address-books", + "Get-OabVirtualDirectory": "email-addresses-and-address-books", + "Get-OfflineAddressBook": "email-addresses-and-address-books", + "Move-AddressList": "email-addresses-and-address-books", + "Move-OfflineAddressBook": "email-addresses-and-address-books", + "New-AddressBookPolicy": "email-addresses-and-address-books", + "New-AddressList": "email-addresses-and-address-books", + "New-EmailAddressPolicy": "email-addresses-and-address-books", + "New-GlobalAddressList": "email-addresses-and-address-books", + "New-OabVirtualDirectory": "email-addresses-and-address-books", + "New-OfflineAddressBook": "email-addresses-and-address-books", + "Remove-AddressBookPolicy": "email-addresses-and-address-books", + "Remove-AddressList": "email-addresses-and-address-books", + "Remove-EmailAddressPolicy": "email-addresses-and-address-books", + "Remove-GlobalAddressList": "email-addresses-and-address-books", + "Remove-OabVirtualDirectory": "email-addresses-and-address-books", + "Remove-OfflineAddressBook": "email-addresses-and-address-books", + "Restore-DetailsTemplate": "email-addresses-and-address-books", + "Set-AddressBookPolicy": "email-addresses-and-address-books", + "Set-AddressList": "email-addresses-and-address-books", + "Set-DetailsTemplate": "email-addresses-and-address-books", + "Set-EmailAddressPolicy": "email-addresses-and-address-books", + "Set-GlobalAddressList": "email-addresses-and-address-books", + "Set-OabVirtualDirectory": "email-addresses-and-address-books", + "Set-OfflineAddressBook": "email-addresses-and-address-books", + "Update-AddressList": "email-addresses-and-address-books", + "Update-EmailAddressPolicy": "email-addresses-and-address-books", + "Update-GlobalAddressList": "email-addresses-and-address-books", + "Update-OfflineAddressBook": "email-addresses-and-address-books", + "Enable-ExchangeCertificate": "encryption-and-certificates", + "Export-ExchangeCertificate": "encryption-and-certificates", + "Get-DataEncryptionPolicy": "encryption-and-certificates", + "Get-ExchangeCertificate": "encryption-and-certificates", + "Get-IRMConfiguration": "encryption-and-certificates", + "Get-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", + "Get-M365DataAtRestEncryptionPolicyAssignment": "encryption-and-certificates", + "Get-MailboxIRMAccess": "encryption-and-certificates", + "Get-OMEConfiguration": "encryption-and-certificates", + "Get-OMEMessageStatus": "encryption-and-certificates", + "Get-RMSTemplate": "encryption-and-certificates", + "Get-SmimeConfig": "encryption-and-certificates", + "Import-ExchangeCertificate": "encryption-and-certificates", + "New-DataEncryptionPolicy": "encryption-and-certificates", + "New-ExchangeCertificate": "encryption-and-certificates", + "New-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", + "New-OMEConfiguration": "encryption-and-certificates", + "Remove-ExchangeCertificate": "encryption-and-certificates", + "Remove-MailboxIRMAccess": "encryption-and-certificates", + "Remove-OMEConfiguration": "encryption-and-certificates", + "Set-DataEncryptionPolicy": "encryption-and-certificates", + "Set-IRMConfiguration": "encryption-and-certificates", + "Set-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", + "Set-M365DataAtRestEncryptionPolicyAssignment": "encryption-and-certificates", + "Set-MailboxIRMAccess": "encryption-and-certificates", + "Set-OMEConfiguration": "encryption-and-certificates", + "Set-OMEMessageRevocation": "encryption-and-certificates", + "Set-RMSTemplate": "encryption-and-certificates", + "Set-SmimeConfig": "encryption-and-certificates", + "Test-IRMConfiguration": "encryption-and-certificates", + "Test-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", + "Add-FederatedDomain": "federation-and-hybrid", + "Disable-RemoteMailbox": "federation-and-hybrid", + "Enable-RemoteMailbox": "federation-and-hybrid", + "Get-FederatedDomainProof": "federation-and-hybrid", + "Get-FederatedOrganizationIdentifier": "federation-and-hybrid", + "Get-FederationInformation": "federation-and-hybrid", + "Get-FederationTrust": "federation-and-hybrid", + "Get-HybridConfiguration": "federation-and-hybrid", + "Get-HybridMailflowDatacenterIPs": "federation-and-hybrid", + "Get-IntraOrganizationConfiguration": "federation-and-hybrid", + "Get-IntraOrganizationConnector": "federation-and-hybrid", + "Get-OnPremisesOrganization": "federation-and-hybrid", + "Get-PendingFederatedDomain": "federation-and-hybrid", + "Get-RemoteMailbox": "federation-and-hybrid", + "New-FederationTrust": "federation-and-hybrid", + "New-HybridConfiguration": "federation-and-hybrid", + "New-IntraOrganizationConnector": "federation-and-hybrid", + "New-OnPremisesOrganization": "federation-and-hybrid", + "New-RemoteMailbox": "federation-and-hybrid", + "Remove-FederatedDomain": "federation-and-hybrid", + "Remove-FederationTrust": "federation-and-hybrid", + "Remove-HybridConfiguration": "federation-and-hybrid", + "Remove-IntraOrganizationConnector": "federation-and-hybrid", + "Remove-OnPremisesOrganization": "federation-and-hybrid", + "Remove-RemoteMailbox": "federation-and-hybrid", + "Set-FederatedOrganizationIdentifier": "federation-and-hybrid", + "Set-FederationTrust": "federation-and-hybrid", + "Set-HybridConfiguration": "federation-and-hybrid", + "Set-IntraOrganizationConnector": "federation-and-hybrid", + "Set-OnPremisesOrganization": "federation-and-hybrid", + "Set-PendingFederatedDomain": "federation-and-hybrid", + "Set-RemoteMailbox": "federation-and-hybrid", + "Test-FederationTrust": "federation-and-hybrid", + "Test-FederationTrustCertificate": "federation-and-hybrid", + "Update-HybridConfiguration": "federation-and-hybrid", + "Update-Recipient": "federation-and-hybrid", + "Clean-MailboxDatabase": "mailbox-databases-and-servers", + "Disable-MailboxQuarantine": "mailbox-databases-and-servers", + "Disable-MetaCacheDatabase": "mailbox-databases-and-servers", + "Dismount-Database": "mailbox-databases-and-servers", + "Enable-MailboxQuarantine": "mailbox-databases-and-servers", + "Enable-MetaCacheDatabase": "mailbox-databases-and-servers", + "Get-FailedContentIndexDocuments": "mailbox-databases-and-servers", + "Get-MailboxDatabase": "mailbox-databases-and-servers", + "Get-MailboxRepairRequest": "mailbox-databases-and-servers", + "Get-MailboxServer": "mailbox-databases-and-servers", + "Get-SearchDocumentFormat": "mailbox-databases-and-servers", + "Get-StoreUsageStatistics": "mailbox-databases-and-servers", + "Mount-Database": "mailbox-databases-and-servers", + "Move-DatabasePath": "mailbox-databases-and-servers", + "New-MailboxDatabase": "mailbox-databases-and-servers", + "New-MailboxRepairRequest": "mailbox-databases-and-servers", + "New-SearchDocumentFormat": "mailbox-databases-and-servers", + "Remove-MailboxDatabase": "mailbox-databases-and-servers", + "Remove-MailboxRepairRequest": "mailbox-databases-and-servers", + "Remove-SearchDocumentFormat": "mailbox-databases-and-servers", + "Remove-StoreMailbox": "mailbox-databases-and-servers", + "Set-MailboxDatabase": "mailbox-databases-and-servers", + "Set-MailboxServer": "mailbox-databases-and-servers", + "Set-SearchDocumentFormat": "mailbox-databases-and-servers", + "Start-MailboxAssistant": "mailbox-databases-and-servers", + "Test-AssistantHealth": "mailbox-databases-and-servers", + "Test-ExchangeSearch": "mailbox-databases-and-servers", + "Test-MRSHealth": "mailbox-databases-and-servers", + "Update-DatabaseSchema": "mailbox-databases-and-servers", + "Update-FileDistributionService": "mailbox-databases-and-servers", + "Update-StoreMailboxState": "mailbox-databases-and-servers", + "Add-MailboxFolderPermission": "mailboxes", + "Add-MailboxPermission": "mailboxes", + "Add-RecipientPermission": "mailboxes", + "Connect-Mailbox": "mailboxes", + "Disable-App": "mailboxes", + "Disable-InboxRule": "mailboxes", + "Disable-Mailbox": "mailboxes", + "Disable-ServiceEmailChannel": "mailboxes", + "Disable-SweepRule": "mailboxes", + "Enable-App": "mailboxes", + "Enable-InboxRule": "mailboxes", + "Enable-Mailbox": "mailboxes", + "Enable-ServiceEmailChannel": "mailboxes", + "Enable-SweepRule": "mailboxes", + "Expedite-Delicensing": "mailboxes", + "Export-MailboxDiagnosticLogs": "mailboxes", + "Export-RecipientDataProperty": "mailboxes", + "Get-App": "mailboxes", + "Get-CalendarDiagnosticAnalysis": "mailboxes", + "Get-CalendarDiagnosticLog": "mailboxes", + "Get-CalendarDiagnosticObjects": "mailboxes", + "Get-CalendarNotification": "mailboxes", + "Get-CalendarProcessing": "mailboxes", + "Get-Clutter": "mailboxes", + "Get-EventsFromEmailConfiguration": "mailboxes", + "Get-ExternalInOutlook": "mailboxes", + "Get-FocusedInbox": "mailboxes", + "Get-InboxRule": "mailboxes", + "Get-Mailbox": "mailboxes", + "Get-MailboxAutoReplyConfiguration": "mailboxes", + "Get-MailboxCalendarFolder": "mailboxes", + "Get-MailboxExportRequest": "mailboxes", + "Get-MailboxExportRequestStatistics": "mailboxes", + "Get-MailboxFolder": "mailboxes", + "Get-MailboxFolderPermission": "mailboxes", + "Get-MailboxFolderStatistics": "mailboxes", + "Get-MailboxImportRequest": "mailboxes", + "Get-MailboxImportRequestStatistics": "mailboxes", + "Get-MailboxLocation": "mailboxes", + "Get-MailboxPermission": "mailboxes", + "Get-MailboxPlan": "mailboxes", + "Get-MailboxRestoreRequest": "mailboxes", + "Get-MailboxRestoreRequestStatistics": "mailboxes", + "Get-MailboxSentItemsConfiguration": "mailboxes", + "Get-MailboxStatistics": "mailboxes", + "Get-MailboxUserConfiguration": "mailboxes", + "Get-MessageCategory": "mailboxes", + "Get-PendingDelicenseUser": "mailboxes", + "Get-Place": "mailboxes", + "Get-RecipientPermission": "mailboxes", + "Get-RecoverableItems": "mailboxes", + "Get-ResourceConfig": "mailboxes", + "Get-SweepRule": "mailboxes", + "Get-UserPhoto": "mailboxes", + "Import-RecipientDataProperty": "mailboxes", + "New-App": "mailboxes", + "New-InboxRule": "mailboxes", + "New-Mailbox": "mailboxes", + "New-MailboxExportRequest": "mailboxes", + "New-MailboxFolder": "mailboxes", + "New-MailboxImportRequest": "mailboxes", + "New-MailboxRestoreRequest": "mailboxes", + "New-MailMessage": "mailboxes", + "New-SiteMailbox": "mailboxes", + "New-SweepRule": "mailboxes", + "Remove-App": "mailboxes", + "Remove-CalendarEvents": "mailboxes", + "Remove-InboxRule": "mailboxes", + "Remove-Mailbox": "mailboxes", + "Remove-MailboxExportRequest": "mailboxes", + "Remove-MailboxFolderPermission": "mailboxes", + "Remove-MailboxImportRequest": "mailboxes", + "Remove-MailboxPermission": "mailboxes", + "Remove-MailboxRestoreRequest": "mailboxes", + "Remove-MailboxUserConfiguration": "mailboxes", + "Remove-RecipientPermission": "mailboxes", + "Remove-SweepRule": "mailboxes", + "Remove-UserPhoto": "mailboxes", + "Restore-Mailbox": "mailboxes", + "Restore-RecoverableItems": "mailboxes", + "Resume-MailboxExportRequest": "mailboxes", + "Resume-MailboxImportRequest": "mailboxes", + "Resume-MailboxRestoreRequest": "mailboxes", + "Search-Mailbox": "mailboxes", + "Set-App": "mailboxes", + "Set-CalendarNotification": "mailboxes", + "Set-CalendarProcessing": "mailboxes", + "Set-Clutter": "mailboxes", + "Set-EventsFromEmailConfiguration": "mailboxes", + "Set-ExternalInOutlook": "mailboxes", + "Set-FocusedInbox": "mailboxes", + "Set-InboxRule": "mailboxes", + "Set-Mailbox": "mailboxes", + "Set-MailboxAutoReplyConfiguration": "mailboxes", + "Set-MailboxCalendarFolder": "mailboxes", + "Set-MailboxExportRequest": "mailboxes", + "Set-MailboxFolderPermission": "mailboxes", + "Set-MailboxImportRequest": "mailboxes", + "Set-MailboxPlan": "mailboxes", + "Set-MailboxRestoreRequest": "mailboxes", + "Set-MailboxSentItemsConfiguration": "mailboxes", + "Set-Place": "mailboxes", + "Set-ResourceConfig": "mailboxes", + "Set-SweepRule": "mailboxes", + "Set-UserPhoto": "mailboxes", + "Suspend-MailboxExportRequest": "mailboxes", + "Suspend-MailboxImportRequest": "mailboxes", + "Suspend-MailboxRestoreRequest": "mailboxes", + "Test-MAPIConnectivity": "mailboxes", + "Undo-SoftDeletedMailbox": "mailboxes", + "Add-ResubmitRequest": "mail-flow", + "Disable-DnssecForVerifiedDomain": "mail-flow", + "Disable-IPv6ForAcceptedDomain": "mail-flow", + "Disable-SmtpDaneInbound": "mail-flow", + "Disable-TransportAgent": "mail-flow", + "Enable-DnssecForVerifiedDomain": "mail-flow", + "Enable-IPv6ForAcceptedDomain": "mail-flow", + "Enable-SmtpDaneInbound": "mail-flow", + "Enable-TransportAgent": "mail-flow", + "Export-Message": "mail-flow", + "Get-AcceptedDomain": "mail-flow", + "Get-AddressRewriteEntry": "mail-flow", + "Get-DeliveryAgentConnector": "mail-flow", + "Get-DnssecStatusForVerifiedDomain": "mail-flow", + "Get-EdgeSubscription": "mail-flow", + "Get-EdgeSyncServiceConfig": "mail-flow", + "Get-ForeignConnector": "mail-flow", + "Get-FrontendTransportService": "mail-flow", + "Get-InboundConnector": "mail-flow", + "Get-IPv6StatusForAcceptedDomain": "mail-flow", + "Get-MailboxTransportService": "mail-flow", + "Get-Message": "mail-flow", + "Get-MessageTrace": "mail-flow", + "Get-MessageTraceDetail": "mail-flow", + "Get-MessageTrackingLog": "mail-flow", + "Get-MessageTrackingReport": "mail-flow", + "Get-NetworkConnectionInfo": "mail-flow", + "Get-OutboundConnector": "mail-flow", + "Get-Queue": "mail-flow", + "Get-QueueDigest": "mail-flow", + "Get-ReceiveConnector": "mail-flow", + "Get-RemoteDomain": "mail-flow", + "Get-ResubmitRequest": "mail-flow", + "Get-RoutingGroupConnector": "mail-flow", + "Get-SendConnector": "mail-flow", + "Get-SmtpDaneInboundStatus": "mail-flow", + "Get-SystemMessage": "mail-flow", + "Get-TransportAgent": "mail-flow", + "Get-TransportConfig": "mail-flow", + "Get-TransportPipeline": "mail-flow", + "Get-TransportServer": "mail-flow", + "Get-TransportService": "mail-flow", + "Get-X400AuthoritativeDomain": "mail-flow", + "Install-TransportAgent": "mail-flow", + "New-AcceptedDomain": "mail-flow", + "New-AddressRewriteEntry": "mail-flow", + "New-DeliveryAgentConnector": "mail-flow", + "New-EdgeSubscription": "mail-flow", + "New-EdgeSyncServiceConfig": "mail-flow", + "New-ForeignConnector": "mail-flow", + "New-InboundConnector": "mail-flow", + "New-OutboundConnector": "mail-flow", + "New-ReceiveConnector": "mail-flow", + "New-RemoteDomain": "mail-flow", + "New-RoutingGroupConnector": "mail-flow", + "New-SendConnector": "mail-flow", + "New-SystemMessage": "mail-flow", + "New-X400AuthoritativeDomain": "mail-flow", + "Redirect-Message": "mail-flow", + "Remove-AcceptedDomain": "mail-flow", + "Remove-AddressRewriteEntry": "mail-flow", + "Remove-DeliveryAgentConnector": "mail-flow", + "Remove-EdgeSubscription": "mail-flow", + "Remove-ForeignConnector": "mail-flow", + "Remove-InboundConnector": "mail-flow", + "Remove-Message": "mail-flow", + "Remove-OutboundConnector": "mail-flow", + "Remove-ReceiveConnector": "mail-flow", + "Remove-RemoteDomain": "mail-flow", + "Remove-ResubmitRequest": "mail-flow", + "Remove-RoutingGroupConnector": "mail-flow", + "Remove-SendConnector": "mail-flow", + "Remove-SystemMessage": "mail-flow", + "Remove-X400AuthoritativeDomain": "mail-flow", + "Resume-Message": "mail-flow", + "Resume-Queue": "mail-flow", + "Retry-Queue": "mail-flow", + "Search-MessageTrackingReport": "mail-flow", + "Set-AcceptedDomain": "mail-flow", + "Set-AddressRewriteEntry": "mail-flow", + "Set-DeliveryAgentConnector": "mail-flow", + "Set-EdgeSyncServiceConfig": "mail-flow", + "Set-ForeignConnector": "mail-flow", + "Set-FrontendTransportService": "mail-flow", + "Set-InboundConnector": "mail-flow", + "Set-MailboxTransportService": "mail-flow", + "Set-OutboundConnector": "mail-flow", + "Set-ReceiveConnector": "mail-flow", + "Set-RemoteDomain": "mail-flow", + "Set-ResubmitRequest": "mail-flow", + "Set-RoutingGroupConnector": "mail-flow", + "Set-SendConnector": "mail-flow", + "Set-SystemMessage": "mail-flow", + "Set-TransportAgent": "mail-flow", + "Set-TransportConfig": "mail-flow", + "Set-TransportServer": "mail-flow", + "Set-TransportService": "mail-flow", + "Set-X400AuthoritativeDomain": "mail-flow", + "Start-EdgeSynchronization": "mail-flow", + "Start-HistoricalSearch": "mail-flow", + "Stop-HistoricalSearch": "mail-flow", + "Suspend-Message": "mail-flow", + "Suspend-Queue": "mail-flow", + "Test-EdgeSynchronization": "mail-flow", + "Test-Mailflow": "mail-flow", + "Test-SmtpConnectivity": "mail-flow", + "Uninstall-TransportAgent": "mail-flow", + "Validate-OutboundConnector": "mail-flow", + "Complete-MigrationBatch": "move-and-migration", + "Export-MigrationReport": "move-and-migration", + "Get-MigrationBatch": "move-and-migration", + "Get-MigrationConfig": "move-and-migration", + "Get-MigrationEndpoint": "move-and-migration", + "Get-MigrationStatistics": "move-and-migration", + "Get-MigrationUser": "move-and-migration", + "Get-MigrationUserStatistics": "move-and-migration", + "Get-MoveRequest": "move-and-migration", + "Get-MoveRequestStatistics": "move-and-migration", + "Get-PublicFolderMailboxMigrationRequest": "move-and-migration", + "Get-PublicFolderMailboxMigrationRequestStatistics": "move-and-migration", + "Get-PublicFolderMigrationRequest": "move-and-migration", + "Get-PublicFolderMigrationRequestStatistics": "move-and-migration", + "Get-PublicFolderMoveRequest": "move-and-migration", + "Get-PublicFolderMoveRequestStatistics": "move-and-migration", + "New-MigrationBatch": "move-and-migration", + "New-MigrationEndpoint": "move-and-migration", + "New-MoveRequest": "move-and-migration", + "New-PublicFolderMigrationRequest": "move-and-migration", + "New-PublicFolderMoveRequest": "move-and-migration", + "Remove-MigrationBatch": "move-and-migration", + "Remove-MigrationEndpoint": "move-and-migration", + "Remove-MigrationUser": "move-and-migration", + "Remove-MoveRequest": "move-and-migration", + "Remove-PublicFolderMailboxMigrationRequest": "move-and-migration", + "Remove-PublicFolderMigrationRequest": "move-and-migration", + "Remove-PublicFolderMoveRequest": "move-and-migration", + "Resume-MoveRequest": "move-and-migration", + "Resume-PublicFolderMigrationRequest": "move-and-migration", + "Resume-PublicFolderMoveRequest": "move-and-migration", + "Set-MigrationBatch": "move-and-migration", + "Set-MigrationConfig": "move-and-migration", + "Set-MigrationEndpoint": "move-and-migration", + "Set-MigrationUser": "move-and-migration", + "Set-MoveRequest": "move-and-migration", + "Set-PublicFolderMigrationRequest": "move-and-migration", + "Set-PublicFolderMoveRequest": "move-and-migration", + "Start-MigrationBatch": "move-and-migration", + "Start-MigrationUser": "move-and-migration", + "Stop-MigrationBatch": "move-and-migration", + "Stop-MigrationUser": "move-and-migration", + "Suspend-MoveRequest": "move-and-migration", + "Suspend-PublicFolderMailboxMigrationRequest": "move-and-migration", + "Suspend-PublicFolderMigrationRequest": "move-and-migration", + "Suspend-PublicFolderMoveRequest": "move-and-migration", + "Test-MigrationServerAvailability": "move-and-migration", + "Disable-CmdletExtensionAgent": "organization", + "Enable-CmdletExtensionAgent": "organization", + "Enable-OrganizationCustomization": "organization", + "Get-AccessToCustomerDataRequest": "organization", + "Get-ApplicationAccessPolicy": "organization", + "Get-AuthConfig": "organization", + "Get-AuthenticationPolicy": "organization", + "Get-AuthServer": "organization", + "Get-CmdletExtensionAgent": "organization", + "Get-ExchangeAssistanceConfig": "organization", + "Get-ExchangeDiagnosticInfo": "organization", + "Get-ExchangeFeature": "organization", + "Get-ExchangeServer": "organization", + "Get-ExchangeServerAccessLicense": "organization", + "Get-ExchangeServerAccessLicenseUser": "organization", + "Get-ExchangeSettings": "organization", + "Get-FeatureConfiguration": "organization", + "Get-Notification": "organization", + "Get-OrganizationConfig": "organization", + "Get-PartnerApplication": "organization", + "Get-PerimeterConfig": "organization", + "Get-ServicePrincipal": "organization", + "Get-SettingOverride": "organization", + "New-ApplicationAccessPolicy": "organization", + "New-AuthenticationPolicy": "organization", + "New-AuthServer": "organization", + "New-ExchangeSettings": "organization", + "New-FeatureConfiguration": "organization", + "New-PartnerApplication": "organization", + "New-ServicePrincipal": "organization", + "New-SettingOverride": "organization", + "Remove-ApplicationAccessPolicy": "organization", + "Remove-AuthenticationPolicy": "organization", + "Remove-AuthServer": "organization", + "Remove-FeatureConfiguration": "organization", + "Remove-PartnerApplication": "organization", + "Remove-ServicePrincipal": "organization", + "Remove-SettingOverride": "organization", + "Set-AccessToCustomerDataRequest": "organization", + "Set-ApplicationAccessPolicy": "organization", + "Set-AuthConfig": "organization", + "Set-AuthenticationPolicy": "organization", + "Set-AuthServer": "organization", + "Set-CmdletExtensionAgent": "organization", + "Set-ExchangeAssistanceConfig": "organization", + "Set-ExchangeFeature": "organization", + "Set-ExchangeServer": "organization", + "Set-ExchangeSettings": "organization", + "Set-FeatureConfiguration": "organization", + "Set-Notification": "organization", + "Set-OrganizationConfig": "organization", + "Set-PartnerApplication": "organization", + "Set-PerimeterConfig": "organization", + "Set-ServicePrincipal": "organization", + "Set-SettingOverride": "organization", + "Test-ApplicationAccessPolicy": "organization", + "Test-OAuthConnectivity": "organization", + "Test-ServicePrincipalAuthorization": "organization", + "Test-SystemHealth": "organization", + "Update-ExchangeHelp": "organization", + "Disable-JournalArchiving": "policy-and-compliance", + "Disable-JournalRule": "policy-and-compliance", + "Disable-OutlookProtectionRule": "policy-and-compliance", + "Disable-TransportRule": "policy-and-compliance", + "Enable-JournalRule": "policy-and-compliance", + "Enable-OutlookProtectionRule": "policy-and-compliance", + "Enable-TransportRule": "policy-and-compliance", + "Execute-AzureADLabelSync": "policy-and-compliance", + "Export-JournalRuleCollection": "policy-and-compliance", + "Export-TransportRuleCollection": "policy-and-compliance", + "Get-AdministrativeUnit": "policy-and-compliance", + "Get-AutoSensitivityLabelPolicy": "policy-and-compliance", + "Get-AutoSensitivityLabelRule": "policy-and-compliance", + "Get-EtrLimits": "policy-and-compliance", + "Get-ExoInformationBarrierPolicy": "policy-and-compliance", + "Get-ExoInformationBarrierRelationship": "policy-and-compliance", + "Get-ExoInformationBarrierSegment": "policy-and-compliance", + "Get-InformationBarrierPoliciesApplicationStatus": "policy-and-compliance", + "Get-InformationBarrierPolicy": "policy-and-compliance", + "Get-InformationBarrierRecipientStatus": "policy-and-compliance", + "Get-JournalRule": "policy-and-compliance", + "Get-Label": "policy-and-compliance", + "Get-LabelPolicy": "policy-and-compliance", + "Get-MessageClassification": "policy-and-compliance", + "Get-OrganizationSegment": "policy-and-compliance", + "Get-OutlookProtectionRule": "policy-and-compliance", + "Get-ProtectionAlert": "policy-and-compliance", + "Get-ReviewItems": "policy-and-compliance", + "Get-SupervisoryReviewPolicyV2": "policy-and-compliance", + "Get-SupervisoryReviewRule": "policy-and-compliance", + "Get-TransportRule": "policy-and-compliance", + "Get-TransportRuleAction": "policy-and-compliance", + "Get-TransportRulePredicate": "policy-and-compliance", + "Import-JournalRuleCollection": "policy-and-compliance", + "Import-TransportRuleCollection": "policy-and-compliance", + "Install-UnifiedCompliancePrerequisite": "policy-and-compliance", + "Invoke-ComplianceSecurityFilterAction": "policy-and-compliance", + "New-AutoSensitivityLabelPolicy": "policy-and-compliance", + "New-AutoSensitivityLabelRule": "policy-and-compliance", + "New-InformationBarrierPolicy": "policy-and-compliance", + "New-JournalRule": "policy-and-compliance", + "New-Label": "policy-and-compliance", + "New-LabelPolicy": "policy-and-compliance", + "New-MessageClassification": "policy-and-compliance", + "New-OrganizationSegment": "policy-and-compliance", + "New-OutlookProtectionRule": "policy-and-compliance", + "New-ProtectionAlert": "policy-and-compliance", + "New-SupervisoryReviewPolicyV2": "policy-and-compliance", + "New-SupervisoryReviewRule": "policy-and-compliance", + "New-TransportRule": "policy-and-compliance", + "Remove-AutoSensitivityLabelPolicy": "policy-and-compliance", + "Remove-AutoSensitivityLabelRule": "policy-and-compliance", + "Remove-InformationBarrierPolicy": "policy-and-compliance", + "Remove-JournalRule": "policy-and-compliance", + "Remove-Label": "policy-and-compliance", + "Remove-LabelPolicy": "policy-and-compliance", + "Remove-MessageClassification": "policy-and-compliance", + "Remove-OrganizationSegment": "policy-and-compliance", + "Remove-OutlookProtectionRule": "policy-and-compliance", + "Remove-ProtectionAlert": "policy-and-compliance", + "Remove-SupervisoryReviewPolicyV2": "policy-and-compliance", + "Remove-TransportRule": "policy-and-compliance", + "Set-AutoSensitivityLabelPolicy": "policy-and-compliance", + "Set-AutoSensitivityLabelRule": "policy-and-compliance", + "Set-InformationBarrierPolicy": "policy-and-compliance", + "Set-JournalRule": "policy-and-compliance", + "Set-Label": "policy-and-compliance", + "Set-LabelPolicy": "policy-and-compliance", + "Set-MessageClassification": "policy-and-compliance", + "Set-OrganizationSegment": "policy-and-compliance", + "Set-OutlookProtectionRule": "policy-and-compliance", + "Set-ProtectionAlert": "policy-and-compliance", + "Set-SupervisoryReviewPolicyV2": "policy-and-compliance", + "Set-SupervisoryReviewRule": "policy-and-compliance", + "Set-TransportRule": "policy-and-compliance", + "Start-InformationBarrierPoliciesApplication": "policy-and-compliance", + "Stop-InformationBarrierPoliciesApplication": "policy-and-compliance", + "Test-ArchiveConnectivity": "policy-and-compliance", + "Get-AdminAuditLogConfig": "policy-and-compliance-audit", + "Get-AuditConfig": "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-MailboxAuditLogSearch": "policy-and-compliance-audit", + "New-UnifiedAuditLogRetentionPolicy": "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-MailboxAuditBypassAssociation": "policy-and-compliance-audit", + "Set-UnifiedAuditLogRetentionPolicy": "policy-and-compliance-audit", + "Write-AdminAuditLog": "policy-and-compliance-audit", + "Get-ComplianceSearch": "policy-and-compliance-content-search", + "Get-ComplianceSearchAction": "policy-and-compliance-content-search", + "Get-ComplianceSecurityFilter": "policy-and-compliance-content-search", + "Get-MailboxSearch": "policy-and-compliance-content-search", + "Invoke-ComplianceSearchActionStep": "policy-and-compliance-content-search", + "New-ComplianceSearch": "policy-and-compliance-content-search", + "New-ComplianceSearchAction": "policy-and-compliance-content-search", + "New-ComplianceSecurityFilter": "policy-and-compliance-content-search", + "New-MailboxSearch": "policy-and-compliance-content-search", + "Remove-ComplianceSearch": "policy-and-compliance-content-search", + "Remove-ComplianceSearchAction": "policy-and-compliance-content-search", + "Remove-ComplianceSecurityFilter": "policy-and-compliance-content-search", + "Remove-MailboxSearch": "policy-and-compliance-content-search", + "Set-ComplianceSearch": "policy-and-compliance-content-search", + "Set-ComplianceSearchAction": "policy-and-compliance-content-search", + "Set-ComplianceSecurityFilter": "policy-and-compliance-content-search", + "Set-MailboxSearch": "policy-and-compliance-content-search", + "Start-ComplianceSearch": "policy-and-compliance-content-search", + "Start-MailboxSearch": "policy-and-compliance-content-search", + "Stop-ComplianceSearch": "policy-and-compliance-content-search", + "Stop-MailboxSearch": "policy-and-compliance-content-search", + "Export-ActivityExplorerData": "policy-and-compliance-dlp", + "Export-DlpPolicyCollection": "policy-and-compliance-dlp", + "Get-ClassificationRuleCollection": "policy-and-compliance-dlp", + "Get-DataClassification": "policy-and-compliance-dlp", + "Get-DataClassificationConfig": "policy-and-compliance-dlp", + "Get-DlpCompliancePolicy": "policy-and-compliance-dlp", + "Get-DlpComplianceRule": "policy-and-compliance-dlp", + "Get-DlpDetailReport": "policy-and-compliance-dlp", + "Get-DlpDetectionsReport": "policy-and-compliance-dlp", + "Get-DlpEdmSchema": "policy-and-compliance-dlp", + "Get-DlpIncidentDetailReport": "policy-and-compliance-dlp", + "Get-DlpKeywordDictionary": "policy-and-compliance-dlp", + "Get-DlpPolicy": "policy-and-compliance-dlp", + "Get-DlpPolicyTemplate": "policy-and-compliance-dlp", + "Get-DlpSensitiveInformationType": "policy-and-compliance-dlp", + "Get-DlpSensitiveInformationTypeRulePackage": "policy-and-compliance-dlp", + "Get-DlpSiDetectionsReport": "policy-and-compliance-dlp", + "Get-PolicyConfig": "policy-and-compliance-dlp", + "Get-PolicyTipConfig": "policy-and-compliance-dlp", + "Import-DlpPolicyCollection": "policy-and-compliance-dlp", + "Import-DlpPolicyTemplate": "policy-and-compliance-dlp", + "New-ClassificationRuleCollection": "policy-and-compliance-dlp", + "New-DataClassification": "policy-and-compliance-dlp", + "New-DlpCompliancePolicy": "policy-and-compliance-dlp", + "New-DlpComplianceRule": "policy-and-compliance-dlp", + "New-DlpComplianceRuleV2": "policy-and-compliance-dlp", + "New-DlpEdmSchema": "policy-and-compliance-dlp", + "New-DlpFingerprint": "policy-and-compliance-dlp", + "New-DlpKeywordDictionary": "policy-and-compliance-dlp", + "New-DlpPolicy": "policy-and-compliance-dlp", + "New-DlpSensitiveInformationType": "policy-and-compliance-dlp", + "New-DlpSensitiveInformationTypeRulePackage": "policy-and-compliance-dlp", + "New-Fingerprint": "policy-and-compliance-dlp", + "New-PolicyTipConfig": "policy-and-compliance-dlp", + "Remove-ClassificationRuleCollection": "policy-and-compliance-dlp", + "Remove-DataClassification": "policy-and-compliance-dlp", + "Remove-DlpCompliancePolicy": "policy-and-compliance-dlp", + "Remove-DlpComplianceRule": "policy-and-compliance-dlp", + "Remove-DlpEdmSchema": "policy-and-compliance-dlp", + "Remove-DlpKeywordDictionary": "policy-and-compliance-dlp", + "Remove-DlpPolicy": "policy-and-compliance-dlp", + "Remove-DlpPolicyTemplate": "policy-and-compliance-dlp", + "Remove-DlpSensitiveInformationType": "policy-and-compliance-dlp", + "Remove-DlpSensitiveInformationTypeRulePackage": "policy-and-compliance-dlp", + "Remove-PolicyTipConfig": "policy-and-compliance-dlp", + "Set-ClassificationRuleCollection": "policy-and-compliance-dlp", + "Set-DataClassification": "policy-and-compliance-dlp", + "Set-DlpCompliancePolicy": "policy-and-compliance-dlp", + "Set-DlpComplianceRule": "policy-and-compliance-dlp", + "Set-DlpEdmSchema": "policy-and-compliance-dlp", + "Set-DlpKeywordDictionary": "policy-and-compliance-dlp", + "Set-DlpPolicy": "policy-and-compliance-dlp", + "Set-DlpSensitiveInformationType": "policy-and-compliance-dlp", + "Set-DlpSensitiveInformationTypeRulePackage": "policy-and-compliance-dlp", + "Set-PolicyConfig": "policy-and-compliance-dlp", + "Set-PolicyTipConfig": "policy-and-compliance-dlp", + "Test-DataClassification": "policy-and-compliance-dlp", + "Test-TextExtraction": "policy-and-compliance-dlp", + "Add-ComplianceCaseMember": "policy-and-compliance-ediscovery", + "Add-eDiscoveryCaseAdmin": "policy-and-compliance-ediscovery", + "Get-CaseHoldPolicy": "policy-and-compliance-ediscovery", + "Get-CaseHoldRule": "policy-and-compliance-ediscovery", + "Get-ComplianceCase": "policy-and-compliance-ediscovery", + "Get-ComplianceCaseMember": "policy-and-compliance-ediscovery", + "Get-eDiscoveryCaseAdmin": "policy-and-compliance-ediscovery", + "New-CaseHoldPolicy": "policy-and-compliance-ediscovery", + "New-CaseHoldRule": "policy-and-compliance-ediscovery", + "New-ComplianceCase": "policy-and-compliance-ediscovery", + "Remove-CaseHoldPolicy": "policy-and-compliance-ediscovery", + "Remove-CaseHoldRule": "policy-and-compliance-ediscovery", + "Remove-ComplianceCase": "policy-and-compliance-ediscovery", + "Remove-ComplianceCaseMember": "policy-and-compliance-ediscovery", + "Remove-eDiscoveryCaseAdmin": "policy-and-compliance-ediscovery", + "Set-CaseHoldPolicy": "policy-and-compliance-ediscovery", + "Set-CaseHoldRule": "policy-and-compliance-ediscovery", + "Set-ComplianceCase": "policy-and-compliance-ediscovery", + "Update-ComplianceCaseMember": "policy-and-compliance-ediscovery", + "Update-eDiscoveryCaseAdmin": "policy-and-compliance-ediscovery", + "Enable-ComplianceTagStorage": "policy-and-compliance-retention", + "Export-ContentExplorerData": "policy-and-compliance-retention", + "Export-FilePlanProperty": "policy-and-compliance-retention", + "Get-AdaptiveScope": "policy-and-compliance-retention", + "Get-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "Get-AppRetentionComplianceRule": "policy-and-compliance-retention", + "Get-ComplianceRetentionEvent": "policy-and-compliance-retention", + "Get-ComplianceRetentionEventType": "policy-and-compliance-retention", + "Get-ComplianceTag": "policy-and-compliance-retention", + "Get-ComplianceTagStorage": "policy-and-compliance-retention", + "Get-DataRetentionReport": "policy-and-compliance-retention", + "Get-FilePlanPropertyAuthority": "policy-and-compliance-retention", + "Get-FilePlanPropertyCategory": "policy-and-compliance-retention", + "Get-FilePlanPropertyCitation": "policy-and-compliance-retention", + "Get-FilePlanPropertyDepartment": "policy-and-compliance-retention", + "Get-FilePlanPropertyReferenceId": "policy-and-compliance-retention", + "Get-FilePlanPropertyStructure": "policy-and-compliance-retention", + "Get-FilePlanPropertySubCategory": "policy-and-compliance-retention", + "Get-HoldCompliancePolicy": "policy-and-compliance-retention", + "Get-HoldComplianceRule": "policy-and-compliance-retention", + "Get-ManagedContentSettings": "policy-and-compliance-retention", + "Get-ManagedFolder": "policy-and-compliance-retention", + "Get-ManagedFolderMailboxPolicy": "policy-and-compliance-retention", + "Get-RecordReviewNotificationTemplateConfig": "policy-and-compliance-retention", + "Get-RegulatoryComplianceUI": "policy-and-compliance-retention", + "Get-RetentionCompliancePolicy": "policy-and-compliance-retention", + "Get-RetentionComplianceRule": "policy-and-compliance-retention", + "Get-RetentionEvent": "policy-and-compliance-retention", + "Get-RetentionPolicy": "policy-and-compliance-retention", + "Get-RetentionPolicyTag": "policy-and-compliance-retention", + "Import-FilePlanProperty": "policy-and-compliance-retention", + "Invoke-HoldRemovalAction": "policy-and-compliance-retention", + "New-AdaptiveScope": "policy-and-compliance-retention", + "New-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "New-AppRetentionComplianceRule": "policy-and-compliance-retention", + "New-ComplianceRetentionEvent": "policy-and-compliance-retention", + "New-ComplianceRetentionEventType": "policy-and-compliance-retention", + "New-ComplianceTag": "policy-and-compliance-retention", + "New-FilePlanPropertyAuthority": "policy-and-compliance-retention", + "New-FilePlanPropertyCategory": "policy-and-compliance-retention", + "New-FilePlanPropertyCitation": "policy-and-compliance-retention", + "New-FilePlanPropertyDepartment": "policy-and-compliance-retention", + "New-FilePlanPropertyReferenceId": "policy-and-compliance-retention", + "New-FilePlanPropertySubCategory": "policy-and-compliance-retention", + "New-HoldCompliancePolicy": "policy-and-compliance-retention", + "New-HoldComplianceRule": "policy-and-compliance-retention", + "New-ManagedContentSettings": "policy-and-compliance-retention", + "New-ManagedFolder": "policy-and-compliance-retention", + "New-ManagedFolderMailboxPolicy": "policy-and-compliance-retention", + "New-RetentionCompliancePolicy": "policy-and-compliance-retention", + "New-RetentionComplianceRule": "policy-and-compliance-retention", + "New-RetentionPolicy": "policy-and-compliance-retention", + "New-RetentionPolicyTag": "policy-and-compliance-retention", + "Remove-AdaptiveScope": "policy-and-compliance-retention", + "Remove-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "Remove-AppRetentionComplianceRule": "policy-and-compliance-retention", + "Remove-ComplianceRetentionEventType": "policy-and-compliance-retention", + "Remove-ComplianceTag": "policy-and-compliance-retention", + "Remove-FilePlanPropertyAuthority": "policy-and-compliance-retention", + "Remove-FilePlanPropertyCategory": "policy-and-compliance-retention", + "Remove-FilePlanPropertyCitation": "policy-and-compliance-retention", + "Remove-FilePlanPropertyDepartment": "policy-and-compliance-retention", + "Remove-FilePlanPropertyReferenceId": "policy-and-compliance-retention", + "Remove-FilePlanPropertySubCategory": "policy-and-compliance-retention", + "Remove-HoldCompliancePolicy": "policy-and-compliance-retention", + "Remove-HoldComplianceRule": "policy-and-compliance-retention", + "Remove-ManagedContentSettings": "policy-and-compliance-retention", + "Remove-ManagedFolder": "policy-and-compliance-retention", + "Remove-ManagedFolderMailboxPolicy": "policy-and-compliance-retention", + "Remove-RetentionCompliancePolicy": "policy-and-compliance-retention", + "Remove-RetentionComplianceRule": "policy-and-compliance-retention", + "Remove-RetentionPolicy": "policy-and-compliance-retention", + "Remove-RetentionPolicyTag": "policy-and-compliance-retention", + "Set-AdaptiveScope": "policy-and-compliance-retention", + "Set-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "Set-AppRetentionComplianceRule": "policy-and-compliance-retention", + "Set-ComplianceRetentionEventType": "policy-and-compliance-retention", + "Set-ComplianceTag": "policy-and-compliance-retention", + "Set-FilePlanPropertyAuthority": "policy-and-compliance-retention", + "Set-FilePlanPropertyCategory": "policy-and-compliance-retention", + "Set-FilePlanPropertyCitation": "policy-and-compliance-retention", + "Set-FilePlanPropertyDepartment": "policy-and-compliance-retention", + "Set-FilePlanPropertyReferenceId": "policy-and-compliance-retention", + "Set-FilePlanPropertySubCategory": "policy-and-compliance-retention", + "Set-HoldCompliancePolicy": "policy-and-compliance-retention", + "Set-HoldComplianceRule": "policy-and-compliance-retention", + "Set-ManagedContentSettings": "policy-and-compliance-retention", + "Set-ManagedFolder": "policy-and-compliance-retention", + "Set-ManagedFolderMailboxPolicy": "policy-and-compliance-retention", + "Set-RecordReviewNotificationTemplateConfig": "policy-and-compliance-retention", + "Set-RegulatoryComplianceUI": "policy-and-compliance-retention", + "Set-RetentionCompliancePolicy": "policy-and-compliance-retention", + "Set-RetentionComplianceRule": "policy-and-compliance-retention", + "Set-RetentionPolicy": "policy-and-compliance-retention", + "Set-RetentionPolicyTag": "policy-and-compliance-retention", + "Start-ManagedFolderAssistant": "policy-and-compliance-retention", + "Start-RetentionAutoTagLearning": "policy-and-compliance-retention", + "Stop-ManagedFolderAssistant": "policy-and-compliance-retention", + "Validate-RetentionRuleQuery": "policy-and-compliance-retention", + "Add-VivaModuleFeaturePolicy": "powershell-v3-module", + "Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Connect-ExchangeOnline": "powershell-v3-module", + "Connect-IPPSSession": "powershell-v3-module", + "Disconnect-ExchangeOnline": "powershell-v3-module", + "Get-ConnectionInformation": "powershell-v3-module", + "Get-DefaultTenantBriefingConfig": "powershell-v3-module", + "Get-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", + "Get-EXOCasMailbox": "powershell-v3-module", + "Get-EXOMailbox": "powershell-v3-module", + "Get-EXOMailboxFolderPermission": "powershell-v3-module", + "Get-EXOMailboxFolderStatistics": "powershell-v3-module", + "Get-EXOMailboxPermission": "powershell-v3-module", + "Get-EXOMailboxStatistics": "powershell-v3-module", + "Get-EXOMobileDeviceStatistics": "powershell-v3-module", + "Get-EXORecipient": "powershell-v3-module", + "Get-EXORecipientPermission": "powershell-v3-module", + "Get-MyAnalyticsFeatureConfig": "powershell-v3-module", + "Get-UserBriefingConfig": "powershell-v3-module", + "Get-VivaInsightsSettings": "powershell-v3-module", + "Get-VivaModuleFeature": "powershell-v3-module", + "Get-VivaModuleFeatureEnablement": "powershell-v3-module", + "Get-VivaModuleFeaturePolicy": "powershell-v3-module", + "Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Remove-VivaModuleFeaturePolicy": "powershell-v3-module", + "Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Set-DefaultTenantBriefingConfig": "powershell-v3-module", + "Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", + "Set-MyAnalyticsFeatureConfig": "powershell-v3-module", + "Set-UserBriefingConfig": "powershell-v3-module", + "Set-VivaInsightsSettings": "powershell-v3-module", + "Update-VivaModuleFeaturePolicy": "powershell-v3-module", + "Get-CompromisedUserAggregateReport": "reporting", + "Get-CompromisedUserDetailReport": "reporting", + "Get-HistoricalSearch": "reporting", + "Get-LogonStatistics": "reporting", + "Get-MailDetailDlpPolicyReport": "reporting", + "Get-MailDetailEncryptionReport": "reporting", + "Get-MailDetailTransportRuleReport": "reporting", + "Get-MailFilterListReport": "reporting", + "Get-MailflowStatusReport": "reporting", + "Get-MailTrafficEncryptionReport": "reporting", + "Get-MailTrafficPolicyReport": "reporting", + "Get-MailTrafficSummaryReport": "reporting", + "Get-MxRecordReport": "reporting", + "Get-OutboundConnectorReport": "reporting", + "Get-RecipientStatisticsReport": "reporting", + "Get-ReportExecutionInstance": "reporting", + "Get-SCInsights": "reporting", + "Get-ServiceDeliveryReport": "reporting", + "Get-SupervisoryReviewActivity": "reporting", + "Get-SupervisoryReviewOverallProgressReport": "reporting", + "Get-SupervisoryReviewPolicyReport": "reporting", + "Get-SupervisoryReviewReport": "reporting", + "Get-SupervisoryReviewTopCasesReport": "reporting", + "Test-Message": "reporting", + "Add-ManagementRoleEntry": "role-based-access-control", + "Add-RoleGroupMember": "role-based-access-control", + "Get-ManagementRole": "role-based-access-control", + "Get-ManagementRoleAssignment": "role-based-access-control", + "Get-ManagementRoleEntry": "role-based-access-control", + "Get-ManagementScope": "role-based-access-control", + "Get-RoleAssignmentPolicy": "role-based-access-control", + "Get-RoleGroup": "role-based-access-control", + "Get-RoleGroupMember": "role-based-access-control", + "New-ManagementRole": "role-based-access-control", + "New-ManagementRoleAssignment": "role-based-access-control", + "New-ManagementScope": "role-based-access-control", + "New-RoleAssignmentPolicy": "role-based-access-control", + "New-RoleGroup": "role-based-access-control", + "Remove-ManagementRole": "role-based-access-control", + "Remove-ManagementRoleAssignment": "role-based-access-control", + "Remove-ManagementRoleEntry": "role-based-access-control", + "Remove-ManagementScope": "role-based-access-control", + "Remove-RoleAssignmentPolicy": "role-based-access-control", + "Remove-RoleGroup": "role-based-access-control", + "Remove-RoleGroupMember": "role-based-access-control", + "Set-ManagementRoleAssignment": "role-based-access-control", + "Set-ManagementRoleEntry": "role-based-access-control", + "Set-ManagementScope": "role-based-access-control", + "Set-RoleAssignmentPolicy": "role-based-access-control", + "Set-RoleGroup": "role-based-access-control", + "Update-RoleGroupMember": "role-based-access-control", + "Add-GlobalMonitoringOverride": "server-health-and-performance", + "Add-ServerMonitoringOverride": "server-health-and-performance", + "Get-AvailabilityReportOutage": "server-health-and-performance", + "Get-EventLogLevel": "server-health-and-performance", + "Get-GlobalMonitoringOverride": "server-health-and-performance", + "Get-HealthReport": "server-health-and-performance", + "Get-MonitoringItemHelp": "server-health-and-performance", + "Get-MonitoringItemIdentity": "server-health-and-performance", + "Get-ServerComponentState": "server-health-and-performance", + "Get-ServerHealth": "server-health-and-performance", + "Get-ServerMonitoringOverride": "server-health-and-performance", + "Get-ThrottlingPolicy": "server-health-and-performance", + "Get-ThrottlingPolicyAssociation": "server-health-and-performance", + "Invoke-MonitoringProbe": "server-health-and-performance", + "New-AvailabilityReportOutage": "server-health-and-performance", + "New-ThrottlingPolicy": "server-health-and-performance", + "Remove-AvailabilityReportOutage": "server-health-and-performance", + "Remove-GlobalMonitoringOverride": "server-health-and-performance", + "Remove-ServerMonitoringOverride": "server-health-and-performance", + "Remove-ThrottlingPolicy": "server-health-and-performance", + "Set-AvailabilityReportOutage": "server-health-and-performance", + "Set-EventLogLevel": "server-health-and-performance", + "Set-ServerComponentState": "server-health-and-performance", + "Set-ServerMonitor": "server-health-and-performance", + "Set-ThrottlingPolicy": "server-health-and-performance", + "Set-ThrottlingPolicyAssociation": "server-health-and-performance", + "Test-ServiceHealth": "server-health-and-performance", + "Add-AvailabilityAddressSpace": "sharing-and-collaboration", + "Add-PublicFolderAdministrativePermission": "sharing-and-collaboration", + "Add-PublicFolderClientPermission": "sharing-and-collaboration", + "Disable-MailPublicFolder": "sharing-and-collaboration", + "Enable-MailPublicFolder": "sharing-and-collaboration", + "Get-AvailabilityAddressSpace": "sharing-and-collaboration", + "Get-AvailabilityConfig": "sharing-and-collaboration", + "Get-MailPublicFolder": "sharing-and-collaboration", + "Get-OrganizationRelationship": "sharing-and-collaboration", + "Get-PublicFolder": "sharing-and-collaboration", + "Get-PublicFolderAdministrativePermission": "sharing-and-collaboration", + "Get-PublicFolderClientPermission": "sharing-and-collaboration", + "Get-PublicFolderDatabase": "sharing-and-collaboration", + "Get-PublicFolderItemStatistics": "sharing-and-collaboration", + "Get-PublicFolderMailboxDiagnostics": "sharing-and-collaboration", + "Get-PublicFolderStatistics": "sharing-and-collaboration", + "Get-SharingPolicy": "sharing-and-collaboration", + "Get-SiteMailbox": "sharing-and-collaboration", + "Get-SiteMailboxDiagnostics": "sharing-and-collaboration", + "Get-SiteMailboxProvisioningPolicy": "sharing-and-collaboration", + "New-AvailabilityConfig": "sharing-and-collaboration", + "New-OrganizationRelationship": "sharing-and-collaboration", + "New-PublicFolder": "sharing-and-collaboration", + "New-PublicFolderDatabase": "sharing-and-collaboration", + "New-PublicFolderDatabaseRepairRequest": "sharing-and-collaboration", + "New-SharingPolicy": "sharing-and-collaboration", + "New-SiteMailboxProvisioningPolicy": "sharing-and-collaboration", + "New-SyncMailPublicFolder": "sharing-and-collaboration", + "Remove-AvailabilityAddressSpace": "sharing-and-collaboration", + "Remove-AvailabilityConfig": "sharing-and-collaboration", + "Remove-OrganizationRelationship": "sharing-and-collaboration", + "Remove-PublicFolder": "sharing-and-collaboration", + "Remove-PublicFolderAdministrativePermission": "sharing-and-collaboration", + "Remove-PublicFolderClientPermission": "sharing-and-collaboration", + "Remove-PublicFolderDatabase": "sharing-and-collaboration", + "Remove-SharingPolicy": "sharing-and-collaboration", + "Remove-SiteMailboxProvisioningPolicy": "sharing-and-collaboration", + "Remove-SyncMailPublicFolder": "sharing-and-collaboration", + "Resume-PublicFolderReplication": "sharing-and-collaboration", + "Set-AvailabilityConfig": "sharing-and-collaboration", + "Set-MailPublicFolder": "sharing-and-collaboration", + "Set-OrganizationRelationship": "sharing-and-collaboration", + "Set-PublicFolder": "sharing-and-collaboration", + "Set-PublicFolderDatabase": "sharing-and-collaboration", + "Set-SharingPolicy": "sharing-and-collaboration", + "Set-SiteMailbox": "sharing-and-collaboration", + "Set-SiteMailboxProvisioningPolicy": "sharing-and-collaboration", + "Suspend-PublicFolderReplication": "sharing-and-collaboration", + "Test-OrganizationRelationship": "sharing-and-collaboration", + "Test-SiteMailbox": "sharing-and-collaboration", + "Update-PublicFolder": "sharing-and-collaboration", + "Update-PublicFolderHierarchy": "sharing-and-collaboration", + "Update-PublicFolderMailbox": "sharing-and-collaboration", + "Update-SiteMailbox": "sharing-and-collaboration", + "Disable-UMAutoAttendant": "unified-messaging", + "Disable-UMCallAnsweringRule": "unified-messaging", + "Disable-UMIPGateway": "unified-messaging", + "Disable-UMMailbox": "unified-messaging", + "Disable-UMServer": "unified-messaging", + "Disable-UMService": "unified-messaging", + "Enable-UMAutoAttendant": "unified-messaging", + "Enable-UMCallAnsweringRule": "unified-messaging", + "Enable-UMIPGateway": "unified-messaging", + "Enable-UMMailbox": "unified-messaging", + "Enable-UMServer": "unified-messaging", + "Enable-UMService": "unified-messaging", + "Export-UMCallDataRecord": "unified-messaging", + "Export-UMPrompt": "unified-messaging", + "Get-OnlineMeetingConfiguration": "unified-messaging", + "Get-UMActiveCalls": "unified-messaging", + "Get-UMAutoAttendant": "unified-messaging", + "Get-UMCallAnsweringRule": "unified-messaging", + "Get-UMCallDataRecord": "unified-messaging", + "Get-UMCallRouterSettings": "unified-messaging", + "Get-UMCallSummaryReport": "unified-messaging", + "Get-UMDialPlan": "unified-messaging", + "Get-UMHuntGroup": "unified-messaging", + "Get-UMIPGateway": "unified-messaging", + "Get-UMMailbox": "unified-messaging", + "Get-UMMailboxPIN": "unified-messaging", + "Get-UMMailboxPolicy": "unified-messaging", + "Get-UmServer": "unified-messaging", + "Get-UMService": "unified-messaging", + "Import-UMPrompt": "unified-messaging", + "New-UMAutoAttendant": "unified-messaging", + "New-UMCallAnsweringRule": "unified-messaging", + "New-UMDialPlan": "unified-messaging", + "New-UMHuntGroup": "unified-messaging", + "New-UMIPGateway": "unified-messaging", + "New-UMMailboxPolicy": "unified-messaging", + "Remove-UMAutoAttendant": "unified-messaging", + "Remove-UMCallAnsweringRule": "unified-messaging", + "Remove-UMDialPlan": "unified-messaging", + "Remove-UMHuntGroup": "unified-messaging", + "Remove-UMIPGateway": "unified-messaging", + "Remove-UMMailboxPolicy": "unified-messaging", + "Set-UMAutoAttendant": "unified-messaging", + "Set-UMCallAnsweringRule": "unified-messaging", + "Set-UMCallRouterSettings": "unified-messaging", + "Set-UMDialPlan": "unified-messaging", + "Set-UMIPGateway": "unified-messaging", + "Set-UMMailbox": "unified-messaging", + "Set-UMMailboxPIN": "unified-messaging", + "Set-UMMailboxPolicy": "unified-messaging", + "Set-UmServer": "unified-messaging", + "Set-UMService": "unified-messaging", + "Test-UMConnectivity": "unified-messaging", + "Add-DistributionGroupMember": "users-and-groups", + "Add-UnifiedGroupLinks": "users-and-groups", + "Disable-DistributionGroup": "users-and-groups", + "Disable-MailContact": "users-and-groups", + "Disable-MailUser": "users-and-groups", + "Enable-DistributionGroup": "users-and-groups", + "Enable-MailContact": "users-and-groups", + "Enable-MailUser": "users-and-groups", + "Get-Contact": "users-and-groups", + "Get-DistributionGroup": "users-and-groups", + "Get-DistributionGroupMember": "users-and-groups", + "Get-DynamicDistributionGroup": "users-and-groups", + "Get-DynamicDistributionGroupMember": "users-and-groups", + "Get-EligibleDistributionGroupForMigration": "users-and-groups", + "Get-Group": "users-and-groups", + "Get-LinkedUser": "users-and-groups", + "Get-MailContact": "users-and-groups", + "Get-MailUser": "users-and-groups", + "Get-Recipient": "users-and-groups", + "Get-SecurityPrincipal": "users-and-groups", + "Get-UnifiedGroup": "users-and-groups", + "Get-UnifiedGroupLinks": "users-and-groups", + "Get-User": "users-and-groups", + "New-DistributionGroup": "users-and-groups", + "New-DynamicDistributionGroup": "users-and-groups", + "New-MailContact": "users-and-groups", + "New-MailUser": "users-and-groups", + "New-UnifiedGroup": "users-and-groups", + "Remove-DistributionGroup": "users-and-groups", + "Remove-DistributionGroupMember": "users-and-groups", + "Remove-DynamicDistributionGroup": "users-and-groups", + "Remove-MailContact": "users-and-groups", + "Remove-MailUser": "users-and-groups", + "Remove-UnifiedGroup": "users-and-groups", + "Remove-UnifiedGroupLinks": "users-and-groups", + "Set-Contact": "users-and-groups", + "Set-DistributionGroup": "users-and-groups", + "Set-DynamicDistributionGroup": "users-and-groups", + "Set-Group": "users-and-groups", + "Set-LinkedUser": "users-and-groups", + "Set-MailContact": "users-and-groups", + "Set-MailUser": "users-and-groups", + "Set-UnifiedGroup": "users-and-groups", + "Set-User": "users-and-groups", + "Undo-SoftDeletedUnifiedGroup": "users-and-groups", + "Update-DistributionGroupMember": "users-and-groups", + "Upgrade-DistributionGroup": "users-and-groups" +} \ No newline at end of file diff --git a/images/add_related_link.png b/images/add_related_link.png deleted file mode 100644 index 3f22beca8c..0000000000 Binary files a/images/add_related_link.png and /dev/null differ diff --git a/images/auto_fork.png b/images/auto_fork.png deleted file mode 100644 index 6d3b380625..0000000000 Binary files a/images/auto_fork.png and /dev/null differ diff --git a/images/contrib-consumption-model-orig.png b/images/contrib-consumption-model-orig.png deleted file mode 100644 index 7ac9b3d330..0000000000 Binary files a/images/contrib-consumption-model-orig.png and /dev/null differ diff --git a/images/contrib-consumption-model.png b/images/contrib-consumption-model.png deleted file mode 100644 index aab8501253..0000000000 Binary files a/images/contrib-consumption-model.png and /dev/null differ diff --git a/images/edit_icon.png b/images/edit_icon.png deleted file mode 100644 index bb87aa6e19..0000000000 Binary files a/images/edit_icon.png and /dev/null differ diff --git a/images/edit_video_capture.jpg b/images/edit_video_capture.jpg deleted file mode 100644 index b4caffa663..0000000000 Binary files a/images/edit_video_capture.jpg and /dev/null differ diff --git a/images/m365-cc-sc-edit-icon.png b/images/m365-cc-sc-edit-icon.png new file mode 100644 index 0000000000..46684dca7a Binary files /dev/null and b/images/m365-cc-sc-edit-icon.png differ diff --git a/images/open-a-pull-request-page.png b/images/open-a-pull-request-page.png new file mode 100644 index 0000000000..e61752e9fc Binary files /dev/null and b/images/open-a-pull-request-page.png differ diff --git a/images/propose-file-change.png b/images/propose-file-change.png new file mode 100644 index 0000000000..9b67cdea6e Binary files /dev/null and b/images/propose-file-change.png differ diff --git a/images/propose_file_change.png b/images/propose_file_change.png deleted file mode 100644 index 6a68423b09..0000000000 Binary files a/images/propose_file_change.png and /dev/null differ diff --git a/images/quick-update-comparing-changes-page.png b/images/quick-update-comparing-changes-page.png new file mode 100644 index 0000000000..8b75fead9d Binary files /dev/null and b/images/quick-update-comparing-changes-page.png differ diff --git a/images/quick-update-edit-button-on-github-page.png b/images/quick-update-edit-button-on-github-page.png new file mode 100644 index 0000000000..2add79f543 Binary files /dev/null and b/images/quick-update-edit-button-on-github-page.png differ diff --git a/images/quick-update-edit-button-on-learn-page.png b/images/quick-update-edit-button-on-learn-page.png new file mode 100644 index 0000000000..dfb170ad8f Binary files /dev/null and b/images/quick-update-edit-button-on-learn-page.png differ diff --git a/images/quick-update-editor-page.png b/images/quick-update-editor-page.png new file mode 100644 index 0000000000..3b7ba57f92 Binary files /dev/null and b/images/quick-update-editor-page.png differ diff --git a/images/quick-update-fork-this-repository-page.png b/images/quick-update-fork-this-repository-page.png new file mode 100644 index 0000000000..3e78555ce8 Binary files /dev/null and b/images/quick-update-fork-this-repository-page.png differ diff --git a/images/quick-update-github-edit-icon.png b/images/quick-update-github-edit-icon.png new file mode 100644 index 0000000000..ba180b5f75 Binary files /dev/null and b/images/quick-update-github-edit-icon.png differ diff --git a/images/quick-update-open-a-pull-request-page.png b/images/quick-update-open-a-pull-request-page.png new file mode 100644 index 0000000000..7087660ec9 Binary files /dev/null and b/images/quick-update-open-a-pull-request-page.png differ diff --git a/images/quick-update-propose-changes-dialog.png b/images/quick-update-propose-changes-dialog.png new file mode 100644 index 0000000000..54a2d31b33 Binary files /dev/null and b/images/quick-update-propose-changes-dialog.png differ diff --git a/images/upload_files.png b/images/upload_files.png index 2ae1b27ee2..231f5c6a78 100644 Binary files a/images/upload_files.png and b/images/upload_files.png differ diff --git a/ms-commerce/TOC.yml b/ms-commerce/TOC.yml new file mode 100644 index 0000000000..b5ef71ac32 --- /dev/null +++ b/ms-commerce/TOC.yml @@ -0,0 +1,2 @@ +- name: Index + href: index.md \ No newline at end of file diff --git a/ms-commerce/breadcrumb/toc.yml b/ms-commerce/breadcrumb/toc.yml new file mode 100644 index 0000000000..61d8fca61e --- /dev/null +++ b/ms-commerce/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/ms-commerce/docfx.json b/ms-commerce/docfx.json new file mode 100644 index 0000000000..87dabf8d0c --- /dev/null +++ b/ms-commerce/docfx.json @@ -0,0 +1,50 @@ +{ + "build": { + "content": [ + { + "files": [ + "**/*.md", + "**/*.yml" + ], + "exclude": [ + "**/obj/**", + "**/includes/**", + "_themes/**", + "_themes.pdf/**", + "**/docfx.json", + "_repo.en-us/**", + "README.md", + "LICENSE", + "LICENSE-CODE", + "ThirdPartyNotices.md" + ] + } + ], + "resource": [ + { + "files": [ + "**/*.png", + "**/*.jpg" + ], + "exclude": [ + "**/obj/**", + "**/includes/**", + "_themes/**", + "_themes.pdf/**", + "**/docfx.json", + "_repo.en-us/**" + ] + } + ], + "overwrite": [], + "externalReference": [], + "globalMetadata": { + "breadcrumb_path": "/powershell/breadcrumb/toc.json", + "extendBreadcrumb": true, + "feedback_system": "None" + }, + "fileMetadata": {}, + "template": [], + "dest": "ms-commerce" + } +} \ No newline at end of file diff --git a/ms-commerce/index.md b/ms-commerce/index.md new file mode 100644 index 0000000000..ac668226df --- /dev/null +++ b/ms-commerce/index.md @@ -0,0 +1 @@ +# Welcome to ms-commerce! \ No newline at end of file diff --git a/officewebapps/docfx.json b/officewebapps/docfx.json index 4eee300d92..025b927d0f 100644 --- a/officewebapps/docfx.json +++ b/officewebapps/docfx.json @@ -2,7 +2,9 @@ "build": { "content": [ { - "files": ["**/*.md"], + "files": [ + "**/*.md" + ], "src": "docs-conceptual", "version": "officewebapps-ps", "dest": "officewebapps", @@ -12,26 +14,36 @@ "README.md", "LICENSE", "LICENSE-CODE", - "ThirdPartyNotices"] + "ThirdPartyNotices" + ] }, { - "files": ["toc.yml"], + "files": [ + "toc.yml" + ], "src": "docs-conceptual", "version": "officewebapps-ps", "dest": "officewebapps/officewebapps-ps" }, { - "files": ["**/*.md"], - "src": "officewebapps-ps", - "version": "officewebapps-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "officewebapps-ps", - "version": "officewebapps-ps", - "dest": "module/officewebapps-ps" - } + "files": [ + "**/*.yml" + ], + "exclude": [ + "toc.yml" + ], + "src": "officewebapps-ps", + "version": "officewebapps-ps", + "dest": "module" + }, + { + "files": [ + "toc.yml" + ], + "src": "officewebapps-ps", + "version": "officewebapps-ps", + "dest": "module/officewebapps-ps" + } ], "resource": [ { @@ -53,16 +65,20 @@ "overwrite": [], "externalReference": [], "globalMetadata": { - "author" : "kenwith", - "ms.author" : "mikeplum", - "manager" : "laurawi", - "ms.date" : "11/28/2017", - "ms.topic" : "reference", - "ms.prod" : "office-online-server-powershell", - "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "ms.service": "office-online-server-powershell", + "uhfHeaderId": "MSDocsHeader-Dev_Office", + "author": "serdarsoysal", + "ms.author": "mikeplum", + "manager": "laurawi", + "ms.date": "11/28/2017", + "ms.topic": "reference", + "products": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/e87e9701-158d-46fb-8165-fb54b7c45d88", + "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" + ], + "ms.devlang": "powershell", + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": {}, "template": [], diff --git a/officewebapps/docs-conceptual/index.md b/officewebapps/docs-conceptual/index.md index f07da40f0e..2b011f543a 100644 --- a/officewebapps/docs-conceptual/index.md +++ b/officewebapps/docs-conceptual/index.md @@ -1,5 +1,12 @@ -# Office Online Server cmdlet reference -Welcome to the Office Online Server PowerShell cmdlet help references. The Office Online Server cmdlets provide the command line interface for administration and management. +--- +title: Office Online Server cmdlet help reference +description: "Learn about the Office Online Server PowerShell cmdlet help reference." +--- -Here you will find all of the Office Online Server PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +# Office Online Server cmdlet help reference + +Welcome to the Office Online Server PowerShell cmdlet **Help** reference. The Office Online Server cmdlets provide the command line interface for administration and management. + +Here, you will find all of the Office Online Server PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. + +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. diff --git a/officewebapps/docs-conceptual/intro.md b/officewebapps/docs-conceptual/intro.md index f07da40f0e..8ac54086df 100644 --- a/officewebapps/docs-conceptual/intro.md +++ b/officewebapps/docs-conceptual/intro.md @@ -1,3 +1,7 @@ +--- +title: Office Online Server cmdlet reference +--- + # Office Online Server cmdlet reference Welcome to the Office Online Server PowerShell cmdlet help references. The Office Online Server cmdlets provide the command line interface for administration and management. diff --git a/officewebapps/mapping/MAML2Yaml/monikerMapping.json b/officewebapps/mapping/MAML2Yaml/monikerMapping.json new file mode 100644 index 0000000000..3c722651ec --- /dev/null +++ b/officewebapps/mapping/MAML2Yaml/monikerMapping.json @@ -0,0 +1,11 @@ +{ + "officewebapps-ps": { + "conceptualToc": "docs-conceptual/toc.yml", + "conceptualTocUrl": "/powershell/officewebapps/officewebapps-ps/toc.json", + "referenceTocUrl": "/powershell/module/officewebapps-ps/toc.json", + "packageRoot": "officewebapps-ps", + "modules": { + "officewebapps": {} + } + } +} \ No newline at end of file diff --git a/officewebapps/mapping/monikerMapping.json b/officewebapps/mapping/monikerMapping.json deleted file mode 100644 index f9897aa0d7..0000000000 --- a/officewebapps/mapping/monikerMapping.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "officewebapps-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/officewebapps/officewebapps-ps/toc.json", - "referenceTocUrl": "/powershell/module/officewebapps-ps/toc.json", - "packageRoot": "officewebapps-ps", - "modules": { - "officewebapps": {} - } - } -} \ No newline at end of file diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md index 546b871a65..5f8470dadc 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Get-OfficeWebAppsExcelBIServer online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-OfficeWebAppsExcelBIServer diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md index 95eb86c4a5..1af1fd7bb1 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Get-OfficeWebAppsExcelUserDefinedFunction online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-OfficeWebAppsExcelUserDefinedFunction @@ -50,4 +53,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md index 0c8874cf7b..6aceca683e 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Get-OfficeWebAppsFarm online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-OfficeWebAppsFarm @@ -47,4 +50,4 @@ These details include the health status and roles held by each server. ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md index 8ccd940ceb..453f1006dc 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Get-OfficeWebAppsHost online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-OfficeWebAppsHost diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md index afb8d27997..45ec6f32f5 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Get-OfficeWebAppsMachine online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-OfficeWebAppsMachine @@ -35,7 +38,7 @@ This example returns details about the current server that is in an Office Onlin (Get-OfficeWebAppsFarm).Machines ``` -This example returns details about all servers that are in a Office Online Server farm. +This example returns details about all servers that are in an Office Online Server farm. ## PARAMETERS @@ -45,4 +48,4 @@ This example returns details about all servers that are in a Office Online Serve ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md index 76a245ac61..0640085f2b 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: New-OfficeWebAppsExcelBIServer online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-OfficeWebAppsExcelBIServer @@ -50,4 +53,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md index 151e1accb9..c631ff437e 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: New-OfficeWebAppsExcelUserDefinedFunction online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-OfficeWebAppsExcelUserDefinedFunction @@ -30,7 +33,7 @@ New-OfficeWebAppsExcelUserDefinedFunction -Assembly c:\myudf.dll -AssemblyLocati ### ------------------EXAMPLE 2--------------------- ``` -New-OfficeWebAppsExcelUserDefinedFunction -Assembly "CompanyName.Hierarchichal.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38" -AssemblyLocation GAC -Enable:$true -Description "My GAC Server UDFs" +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" ``` ## PARAMETERS @@ -134,4 +137,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md index abd1412eb4..d2afbe0bcb 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: New-OfficeWebAppsFarm online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-OfficeWebAppsFarm @@ -44,7 +47,7 @@ You run this cmdlet on the first server in the Office Online Server farm and the 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 Online. 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 @@ -256,7 +259,7 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel Online workbooks where workbooks contain connections to external data. +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 @@ -305,7 +308,7 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel Online. +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 @@ -337,7 +340,7 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel Online. +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default is 1800 seconds. ```yaml @@ -368,7 +371,7 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifes the duration, in seconds, of the external data cache lifetime in Excel Online. +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The default is 300 seconds. ```yaml @@ -401,7 +404,7 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel Online. +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. @@ -457,7 +460,7 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel Online when there is no user activity. +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. @@ -480,7 +483,7 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel Online. +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml @@ -514,7 +517,7 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel Online. +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The default is False. ```yaml @@ -530,7 +533,7 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh -Turns off or on the warning dialog displayed when data refreshes in Excel Online. +Turns off or on the warning dialog displayed when data refreshes in Excel in a browser. ```yaml Type: SwitchParameter @@ -760,7 +763,7 @@ Accept wildcard characters: False 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 paramater to True when you use ClipartEnabled. +You must set this parameter to True when you use ClipartEnabled. ```yaml Type: SwitchParameter @@ -791,9 +794,9 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office Online. +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 Online. +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 @@ -919,7 +922,7 @@ 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 the Word Online. +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. @@ -955,7 +958,7 @@ Accept wildcard characters: False ### -TranslationServiceAppId Specifies the application ID for the translation service. -The default is the public application ID for Office Online. +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 diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md index 22d3c0cfae..b8b8d28dcf 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: New-OfficeWebAppsHost online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-OfficeWebAppsHost @@ -19,7 +22,7 @@ New-OfficeWebAppsHost -Domain <String> ## DESCRIPTION The New-OfficeWebAppsHost cmdlet adds a host domain to the list of host domains to which Office Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file changes. -This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to a Office Online Server farm and using it for file operations without your knowledge. +This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to an Office Online Server farm and using it for file operations without your knowledge. You may any domain type including: Public, Pool, Farm, and Active Directory domain names. Just make sure that the domain you're granting access to meets your security requirements. @@ -68,4 +71,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md index 26e1ba1eb0..e14ee933a9 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: New-OfficeWebAppsMachine online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-OfficeWebAppsMachine @@ -128,4 +131,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md index 2949b457a9..a77ac79a21 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Remove-OfficeWebAppsExcelBIServer online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-OfficeWebAppsExcelBIServer @@ -50,4 +53,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md index 564407454b..6fb132b9ed 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Remove-OfficeWebAppsExcelUserDefinedFunction online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-OfficeWebAppsExcelUserDefinedFunction @@ -82,4 +85,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md index a915735c65..24e918437f 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Remove-OfficeWebAppsHost online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-OfficeWebAppsHost @@ -57,4 +60,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md index 9bac101e73..eb7f54047f 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Remove-OfficeWebAppsMachine online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-OfficeWebAppsMachine @@ -73,4 +76,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md index 3fb2e85f49..fa7c33ca21 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Repair-OfficeWebAppsFarm online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Repair-OfficeWebAppsFarm @@ -18,7 +21,7 @@ Repair-OfficeWebAppsFarm [-Force] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from a Office Online Server farm. +The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from an Office Online Server farm. This cmdlet updates the farm topology but does not clean up services and web applications on the servers that are removed. For this reason, we recommend making every effort to run the Remove-OfficeWebAppsMachine cmdlet from the unhealthy servers so that they are cleanly removed from the farm. Use the Repair-OfficeWebAppsFarm cmdlet only if the unhealthy servers have failed and you cannot run the Remove-OfficeWebAppsMachine cmdlet directly on them. @@ -97,4 +100,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md index be153ecbfa..3f8b966834 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Set-OfficeWebAppsExcelUserDefinedFunction online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-OfficeWebAppsExcelUserDefinedFunction @@ -144,4 +147,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md index 7859234837..800ce67d72 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Set-OfficeWebAppsFarm online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-OfficeWebAppsFarm @@ -50,7 +53,7 @@ This example enables insertion of clip art from Office.com. Set-OfficeWebAppsFarm -EditingEnabled:$true ``` -This example enables edit functionality for Office Online. +This example enables edit functionality for Office in a browser. ### ------------------EXAMPLE 3--------------------- ``` @@ -272,7 +275,7 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel Online workbooks where workbooks contain connections to external data. +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 @@ -321,7 +324,7 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel Online. +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 @@ -353,7 +356,7 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel Online. +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default is 1800 seconds. ```yaml @@ -384,7 +387,7 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel Online. +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The default is 300 seconds. ```yaml @@ -417,7 +420,7 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel Online. +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. @@ -475,7 +478,7 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel Online when there is no user activity. +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. @@ -498,7 +501,7 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel Online. +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml @@ -532,7 +535,7 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel Online. +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The default is False. ```yaml @@ -548,7 +551,7 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh -Turns off or on the warning dialog box that is displayed when data refreshes in Excel Online. +Turns off or on the warning dialog box that is displayed when data refreshes in Excel in a browser. ```yaml Type: SwitchParameter @@ -813,9 +816,9 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office Online. +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 Online. +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 @@ -945,7 +948,7 @@ 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 the Word Online. +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. @@ -983,7 +986,7 @@ Accept wildcard characters: False ### -TranslationServiceAppId Specifies the application ID for the translation service. -The default is the public application ID for Office Online. +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 @@ -1020,4 +1023,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md index fdc4cd7119..eced821b85 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md @@ -4,6 +4,9 @@ Module Name: officewebapps title: Set-OfficeWebAppsMachine online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-OfficeWebAppsMachine @@ -131,4 +134,4 @@ Accept wildcard characters: False ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/officewebapps/officewebapps-ps/officewebapps/officewebapps.md b/officewebapps/officewebapps-ps/officewebapps/officewebapps.md index c6f73174a5..7bda9b6c5d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/officewebapps.md +++ b/officewebapps/officewebapps-ps/officewebapps/officewebapps.md @@ -2,7 +2,6 @@ Module Name: Office Online Server PowerShell Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX title: officewebapps -Locale: en-US --- # Office Online Server PowerShell diff --git a/repo_docs/ADVANCED.md b/repo_docs/ADVANCED.md index 92b4dea3f2..4dda622c87 100644 --- a/repo_docs/ADVANCED.md +++ b/repo_docs/ADVANCED.md @@ -1,200 +1,172 @@ # Contribute using tools such as Git and Visual Studio Code (advanced) ## Steps in a nutshell + 1. Fork Office PowerShell repo to your own account. 2. Clone your repo to your local development computer. -``` -git clone [URL to your forked repo] -``` + + ```DOS + git clone [URL to your forked repo] + ``` + 3. Keep your forked repo up-to-date with upstream repo. -``` -git remote add upstream https://github.com/MicrosoftDocs/office-docs-powershell.git -``` -``` -git fetch upstream -``` + + ```DOS + git remote add upstream https://github.com/MicrosoftDocs/office-docs-powershell.git + git fetch upstream + ``` + 4. Create your own working branch. -``` -git checkout -b [name of your branch] -``` + + ```DOS + git checkout -b [name of your branch] + ``` + 5. Work on content in your favorite Markdown editor. 6. Test to make sure your work matches the correct schema (use PlatyPS tool for this). 7. Merge the Master branch with your working branch (in your forked repo) and resolve any issues. -``` -git merge master [name of your branch] -``` + + ```DOS + git merge master [name of your branch] + ``` + 8. Submit a Pull Request to move your work upstream. ## Steps in more detail ### Sign In or Join GitHub -To sign in to GitHub, point your web browser to https://github.com/login. -To join GitHub for the first time, point your web browser to -https://github.com/join. +To sign in to GitHub, point your web browser to <https://github.com/login>. + +To join GitHub for the first time, point your web browser to <https://github.com/join>. -It is highly recommended to turn on two-factor authentication for security, see -https://help.github.com/articles/about-two-factor-authentication/. +It is highly recommended to turn on two-factor authentication for security, see <https://help.github.com/articles/about-two-factor-authentication/>. ### Fork the GitHub repository into your own account -Fork the GitHub project into your own account so you have a place to work on it. -To Fork the project, point your web browser to the repository at -https://github.com/MicrosoftDocs/office-docs-powershell -and then click the Fork button on the upper right corner of the repository page as shown in screenshot. +Fork the GitHub project into your own account so you have a place to work on it. To Fork the project, point your web browser to the repository at +<https://github.com/MicrosoftDocs/office-docs-powershell> and then click the Fork button on the upper right corner of the repository page as shown in screenshot. -![Image of Fork button on Github](../images/fork_button_on_github.png) +![Image of Fork button on Github.](../images/fork_button_on_github.png) -You now have your very own copy (fork) of the main Office PowerShell repository. You can see it by clicking on your profile drop-down in the upper right of the page and choosing Your Profile and then clicking the Repositories tab of your GitHub account as shown in the diagram. +You now have your very own copy (fork) of the main Office PowerShell repository. You can see it by clicking on your profile drop-down in the upper right of the page and choosing Your Profile and then clicking the Repositories tab of your GitHub account as shown in the diagram. -![View Your Forked Repos on Github](../images/view_your_forked_repos.png) +![View Your Forked Repos on Github.](../images/view_your_forked_repos.png) -Your repository is an exact copy of the original Office PowerShell repository and is located in your GitHub account. -In GitHub terms the main Office PowerShell repository is the Upstream repository and your forked version is the Downstream repository. +Your repository is an exact copy of the original Office PowerShell repository and is located in your GitHub account. In GitHub terms the main Office PowerShell repository is the Upstream repository and your forked version is the Downstream repository. -You can update your repository with the Upstream repository at any time and it is recommended to do this fairly often so that your fork doesn't get out of sync with the original. -The next section covers cloning and updating your repo with the upstream repo. +You can update your repository with the Upstream repository at any time and it is recommended to do this fairly often so that your fork doesn't get out of sync with the original. The next section covers cloning and updating your repo with the upstream repo. ### Clone your Fork to your local development machine -Now that you have your own copy of the repository on GitHub the next step is to get the actual files on your local computer so you can work with them. -To do this you clone your GitHub repository to your local computer. Here is a diagram: -![Diagram of repository flow on Github](../images/github_flow.png) +Now that you have your own copy of the repository on GitHub the next step is to get the actual files on your local computer so you can work with them. To do this you clone your GitHub repository to your local computer. Here is a diagram: + +![Diagram of repository flow on Github.](../images/github_flow.png) -Tip: You can clone your repository to muliple computers if you choose. -You just have to make sure you save your local work by pushing it back up to your repository. -And vice versa, when you start working on a new computer you have to remember to pull any changes down to your local work computer. -This will be described in more detail later on. +> [!TIP] +> You can clone your repository to multiple computers if you choose. You just have to make sure you save your local work by pushing it back up to your repository. And vice versa, when you start working on a new computer you have to remember to pull any changes down to your local work computer. This will be described in more detail later on. -There are many tools that can be used to work with GitHub. -This example uses Visual Studio Code but use whatever you prefer. -The concepts are the same. Visual Studio Code is available for -**Windows, Linux, and Mac**. -You can find it here: -https://code.visualstudio.com/ +There are many tools that can be used to work with GitHub. This example uses Visual Studio Code but use whatever you prefer. The concepts are the same. Visual Studio Code is available for **Windows, Linux, and Mac**. You can find it here: <https://code.visualstudio.com/>. -If you have Git Bash installed you can get to it from within Visual Studio Code by pressing -**Control-`** (control-backtick key which is to the left of number 1). +If you have Git Bash installed you can get to it from within Visual Studio Code by pressing **Control-`** (control-backtick key which is to the left of number 1). Using Visual Studio Code and Git Bash you can clone a repository as follows: -``` + +```DOS git clone [URL to your forked repo] ``` -For example, `git clone https://github.com/kenwith/office-docs-powershell.git` +For example, -Note that in this example my user is -**kenwith** -so I need to make sure I am cloning the Fork I created and not the upstream original. -The user is in the URL for the GitHub repo. +```DOS +git clone https://github.com/kenwith/office-docs-powershell.git +``` -Once you have cloned your repository you can use git push and git pull to push and pull your changes up to your repository. -It is best to use your own working branch so this will be covered in the next section. +Note that in this example my user is **kenwith** so I need to make sure I am cloning the Fork I created and not the upstream original. The user is in the URL for the GitHub repo. -To update your copy of the repo with the upstream copy you first need to add a remote origin and then fetch the upstream branch. -There are many ways to do this but one way is to use Git Bash as follows: -``` +Once you have cloned your repository you can use git push and git pull to push and pull your changes up to your repository. It is best to use your own working branch so this will be covered in the next section. + +To update your copy of the repo with the upstream copy you first need to add a remote origin and then fetch the upstream branch. There are many ways to do this but one way is to use Git Bash as follows: + +```DOS git remote add upstream https://github.com/MicrosoftDocs/office-docs-powershell.git -``` -``` git fetch upstream ``` -For more details, see: -- https://help.github.com/articles/configuring-a-remote-for-a-fork/ -- https://help.github.com/articles/syncing-a-fork/ +For details, see: + +- <https://help.github.com/articles/configuring-a-remote-for-a-fork/> +- <https://help.github.com/articles/syncing-a-fork/> ### Create and checkout a branch for your work -The next step is to create your own working branch. -The reason for this is so that you can pull updates from the Master branch from the upstream repository and merge your own working branch in your own Fork. -This way you can be sure when you do a Pull Request that you won't be conflicting with edits that have happened since you forked the project. + +The next step is to create your own working branch. The reason for this is so that you can pull updates from the Master branch from the upstream repository and merge your own working branch in your own Fork. This way you can be sure when you do a Pull Request that you won't be conflicting with edits that have happened since you forked the project. In the Git Bash terminal in Visual Studio Code: -``` + +```DOS git checkout -b [name of your branch] ``` -Note the -b flag creates the branch if it doesn't exist and switches to it. To checkout an existing branch leave out the -b flag. +Note the `-b` flag creates the branch if it doesn't exist and switches to it. To checkout an existing branch leave out the `-b` flag. ### Make edits to the relevant PowerShell cmdlet markdown -Open your favorite Markdown editor and edit the Markdown in your working branch. -Tip: Visual Studio Code provides a nice side-by-side view for editing Markdown content. -One side will show the Markdown source and the other side will show a preview of how the Markdown will render. -You can find this view by clicking the small icon in the upper right of Visual Studio Code that looks like a side by side view with a magnifying glass. +Open your favorite Markdown editor and edit the Markdown in your working branch. -Some important notes when editing Markdown: +> [!TIP] +> Visual Studio Code provides a nice side-by-side view for editing Markdown content. One side will show the Markdown source and the other side will show a preview of how the Markdown will render. You can find this view by clicking the small icon in the upper right of Visual Studio Code that looks like a side by side view with a magnifying glass. -Make sure your edits match the required PowerShell schema. -The schema can be found here: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md -Any deviations will break Get-Help. -If you want to validate you can use the PlatyPS tool. -Use the New-ExternalHelp command (from PlatyPS) on your Markdown. -If there are any schema errors they will show up. +Some important notes when editing Markdown: -Since GitHub is a source control system and marks edits on a per-line basis it is important to have each sentence, or concept, on its own line. -Markdown will still show paragraphs with each sentence on its own line. -To break into another paragraph add a blank line in between the paragraphs. -Here is a great article that describes this writing system: -http://rhodesmill.org/brandon/2012/one-sentence-per-line/ +Make sure your edits match the required PowerShell schema. The schema can be found here: <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>. Any deviations will break **Get-Help**. If you want to validate you can use the PlatyPS tool. Use the **New-ExternalHelp** command (from PlatyPS) on your Markdown. If there are any schema errors they will show up. -Learn how to write good Markdown (which is a type of Markup language): -https://guides.github.com/features/mastering-markdown/ +Since GitHub is a source control system and marks edits on a per-line basis it is important to have each sentence, or concept, on its own line. Markdown will still show paragraphs with each sentence on its own line. To break into another paragraph add a blank line in between the paragraphs. Here is a great article that describes this writing system: <https://rhodesmill.org/brandon/2012/one-sentence-per-line/>. -More about writing content for GitHub: -https://help.github.com/categories/writing-on-github/ +Learn how to write good Markdown (which is a type of Markup language): <https://guides.github.com/features/mastering-markdown/>. -You can find the schema that the content should follow here: -https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md +More about writing content for GitHub: <https://help.github.com/categories/writing-on-github/>. +You can find the schema that the content should follow here: <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>. ### Merge the upstream Master branch into your branch -Merge the Master branch with your working branch (in your forked repo) and resolve any issues. -https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging -It is best practice to merge the Master branch from upstream with your working branch and not vice versa. -Then you can submit a Pull Request for your working branch and the upstream repo maintainer can merge your branch into Master without issues. +Merge the Master branch with your working branch (in your forked repo) and resolve any issues. <https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging> -Make sure that you have your working branch checked out and that your forked repo is updated with the upstream Master branch. -See the section on forking above for details. +It is best practice to merge the Master branch from upstream with your working branch and not vice versa. Then you can submit a Pull Request for your working branch and the upstream repo maintainer can merge your branch into Master without issues. + +Make sure that you have your working branch checked out and that your forked repo is updated with the upstream Master branch. See the section on forking above for details. Merge the Master branch with your working branch and then resolve issues. -``` + +```DOS git merge master [name of your branch] ``` ### Create a Pull Request -To get your work back into the upstream repo you create a Pull Request. -A Pull Request asks the maintainers of the upstream repo to pull your work into the main project. -1. To create a Pull Request, Open your web browser and navigate to the main upstream repo site at: -https://github.com/MicrosoftDocs/office-docs-powershell +To get your work back into the upstream repo you create a Pull Request. A Pull Request asks the maintainers of the upstream repo to pull your work into the main project. + +1. To create a Pull Request, Open your web browser and navigate to the main upstream repo site at: <https://github.com/MicrosoftDocs/office-docs-powershell>. 2. Click the New Pull Request button towards the top of the page. 3. Click the link to "compare across forks". 4. Select the upstream branch and your local branch. 5. Click Create Pull Request. -The repo maintainers will be notified of your Pull Request. -Your Pull Request will have its own page where you can discuss and modify your request if required. +The repo maintainers will be notified of your Pull Request. Your Pull Request will have its own page where you can discuss and modify your request if required. +## Confirm your work shows up on learn.microsoft.com -## Confirm your work shows up on docs.microsoft.com -Once your Pull Request is approved and your branch merged into Master your changes will show up on the review.docs.microsoft.com site. -Unfortunately this site requires a Microsoft login. +Once your Pull Request is approved and your branch merged into Master your changes will show up on the review.learn.microsoft.com site. Unfortunately this site requires a Microsoft login. -The next step is for a maintainer to merge the Master branch into the Live branch. -Once this is done your work will show up on docs.microsoft.com. +The next step is for a maintainer to merge the Master branch into the Live branch. Once this is done your work will show up on learn.microsoft.com. -The easiest way to find a cmdlet on docs.microsoft.com is to use the PowerShell Browser here: https://docs.microsoft.com/powershell/module -If you know a cmdlet exists but doesn't show up in the PowerShell Browser search then open an Issue (link at top of this repo). +The easiest way to find a cmdlet on learn.microsoft.com is to use the PowerShell Browser here: <https://learn.microsoft.com/powershell/module>. If you know a cmdlet exists but doesn't show up in the PowerShell Browser search then open an Issue (link at top of this repo). When the product team releases a new build your work will also show up in the Office products themselves when a user types Get-Help for the cmdlets that you worked on. ### Congratulations are in order! -You just joined an elite club of contributors to Microsoft Office documentation! -Your edits will be pulled into the product and show up under Get-Help when someone is viewing reference content for the cmdlet you edited. -See your status here: -https://github.com/MicrosoftDocs/office-docs-powershell/graphs/contributors -Don't forget to ~~brag~~ share on social media! -Sharing helps sustain the community and advertises to others to contribute to the open source content as well! +You just joined an elite club of contributors to Microsoft Office documentation! Your edits will be pulled into the product and show up under Get-Help when someone is viewing reference content for the cmdlet you edited. See your status here: <https://github.com/MicrosoftDocs/office-docs-powershell/graphs/contributors> + +Don't forget to ~~brag~~ share on social media! Sharing helps sustain the community and advertises to others to contribute to the open source content as well! diff --git a/repo_docs/FAQ.md b/repo_docs/FAQ.md index 70dd53cca3..3cdca633fe 100644 --- a/repo_docs/FAQ.md +++ b/repo_docs/FAQ.md @@ -1,95 +1,79 @@ # Frequently Asked Questions ## What are best practices for content on GitHub? -It is best practice to keep each sentence or idea on its own line. -This is so that anyone that is reviewing a commit can quickly and easily see what changed. -If you have a giant string of text on a single line then Git just flags that entire line as a 'change'. -To learn more about this concept, see http://rhodesmill.org/brandon/2012/one-sentence-per-line/. + +It is best practice to keep each sentence or idea on its own line. This is so that anyone that is reviewing a commit can quickly and easily see what changed. If you have a giant string of text on a single line then Git just flags that entire line as a 'change'. To learn more about this concept, see https://rhodesmill.org/brandon/2012/one-sentence-per-line/. ## When will my content go live? -When you submit a Pull Request it goes through a validation check and the results are shown on the Pull Request page in GitHub. -Once the checks are completed, and there are no errors or warnings, and the appropriate sign off has been completed by the product team, a GitHub maintainer will merged the Pull Request into the Master branch on GitHub. +When you submit a Pull Request it goes through a validation check and the results are shown on the Pull Request page in GitHub. Once the checks are completed, and there are no errors or warnings, and the appropriate sign off has been completed by the product team, a GitHub maintainer will merged the Pull Request into the Master branch on GitHub. -A site located at review.docs.microsoft.com shows a mirror of the docs.microsoft.com and pulls from the Master branch. -Unfortunately the review site requires a Microsoft login at this time. -This review site provides an opportunity for Microsoft product teams, support, and other internal stakeholders to review any changes before they are pushed to the live site. +A site located at review.learn.microsoft.com shows a mirror of the learn.microsoft.com and pulls from the Master branch. Unfortunately the review site requires a Microsoft login at this time. This review site provides an opportunity for Microsoft product teams, support, and other internal stakeholders to review any changes before they are pushed to the live site. -The next step is for a GitHub maintainer to merge the Master branch into the Live branch. -Once this is complete the changes in the Pull Request will show up on docs.microsoft.com (docs.microsoft.com pulls its content from the Live branch). -There is not a set schedule for this to happen but the maintainers are good about doing this fairly quickly. +The next step is for a GitHub maintainer to merge the Master branch into the Live branch. Once this is complete the changes in the Pull Request will show up on learn.microsoft.com (learn.microsoft.com pulls its content from the Live branch). There is not a set schedule for this to happen but the maintainers are good about doing this fairly quickly. ## When does the GitHub content show up in the products with Get-Help? -The one source of truth for Office PowerShell cmdlets is the GitHub repository. -When a product team ships an update or new version they can use the PlatyPS tool to generate XML and add that to the release. +The one source of truth for Office PowerShell cmdlets is the GitHub repository. When a product team ships an update or new version they can use the PlatyPS tool to generate XML and add that to the release. -The XML contains the latest version of the reference content on GitHub. -Ideally the Online versions will always have the latest content from GitHub and the On Premises products will always have the latest help with Update-Help. -The work to make this happen is not yet done so the content is only refreshed on product team releases. +The XML contains the latest version of the reference content on GitHub. Ideally the Online versions will always have the latest content from GitHub and the On Premises products will always have the latest help with Update-Help. The work to make this happen is not yet done so the content is only refreshed on product team releases. -NOTE: For now (3/1/2018) the XML is being placed in skype/update-help. -This help is generated from the New-ExternalHelp command that is part of PlatyPS. -The 2019 release is working towards pulling help from here with Update-Help. -Stay tuned. +NOTE: For now (3/1/2018) the XML is being placed in skype/update-help. This help is generated from the New-ExternalHelp command that is part of PlatyPS. The 2019 release is working towards pulling help from here with Update-Help. Stay tuned. ## What metadata do reference topics need to have? Every cmdlet reference topic needs at least the following in the metadata field at the top of the reference article: ``` -external help file: +external help file: applicable: Skype for Business Server 2015 title: Add-CsSlaDelegates +author: +ms.author: +ms.reviewer: +manager: schema: 2.0.0 ``` -The *external help file* tag is for the docs.microsoft.com infrastructure. -It can be empty but without it the build will fail. -The *applicable* tag is so that when PlatyPS is run to generate the XML that goes in the product it can only pull help content for specific product versions. -Every applicable tag is located in the [Applicable Tags](https://github.com/MicrosoftDocs/office-docs-powershell/wiki/Applicable-Tags) wiki page. -These tags have to be added to the docs.microsoft.com infrastructure. -If you try to include a tag that has not been added then the build will fail. +The *external help file* tag is for the learn.microsoft.com infrastructure. It can be empty but without it the build will fail. + +The *applicable* tag is so that when PlatyPS is run to generate the XML that goes in the product it can only pull help content for specific product versions. Every applicable tag is located in the [Applicable Tags](https://github.com/MicrosoftDocs/office-docs-powershell/wiki/Applicable-Tags) wiki page. These tags have to be added to the learn.microsoft.com infrastructure. If you try to include a tag that has not been added then the build will fail. The *title* tag is for metrics. More information about metrics coming. -The *schema* tag let's the build system know what schema to use. -The 2.0.0 is the only supported schema currently. -The schema can be viewed on the PlatyPS site, see https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md. +The *author* is the GitHub alias of the person that owns this topic. Usually the PM or sometimes a dev that owns the cmdlet. + +The *ms.author* is the Microsoft alias of the same author. + +The *ms.reviewer* is the Microsoft alias of someone that can approve any technical changes (if different than the author). + +The *manager* is the Microsoft alias of a manager for the team that owns the cmdlet. This is useful if the person that owns the cmdlet leaves the company. The manager will be reached to in order to find the new author. + +The *schema* tag let's the build system know what schema to use. The 2.0.0 is the only supported schema currently. The schema can be viewed on the PlatyPS site, see <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>. -There is also metadata at the global level for the folder. -This metadata is contained in the docfx.json file of the folder. -For example, SharePoint is here: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/docfx.json +There is also metadata at the global level for the folder. This metadata is contained in the docfx.json file of the folder. For example, SharePoint is here: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/docfx.json>. ## What is the special Table of Contents (TOC) file all about? Every folder has a special file that is a table of contents for all the files in the folder. Some examples are: -* Teams: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md -* Skype: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md -* SharePoint Server: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md -Every folder must have this TOC file. -When you browse the list of cmdlets in the Reference folder this is the file you see. -For example, https://docs.microsoft.com/en-us/powershell/module/skype/?view=skype-ps. -Note that docs.microsoft.com automatically strips out the note about manually entering a description. -It ONLY strips this out if it is in the exact format given. -Any slight deviation from the format and it won't strip it out and you will see that "manually enter description" text. +- Teams: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md> +- Skype: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md> +- Exchange: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/main/exchange/exchange-ps/exchange/exchange.md> + +Every folder must have this TOC file. When you browse the list of cmdlets in the Reference folder this is the file you see. For example, <https://learn.microsoft.com/powershell/module/skype/?view=skype-ps>. Note that learn.microsoft.com automatically strips out the note about manually entering a description. It ONLY strips this out if it is in the exact format given. Any slight deviation from the format and it won't strip it out and you will see that "manually enter description" text. ## I can't find the cmdlet I am looking for, what can I do? -Finding a cmdlet can sometimes be a challenge. -This is because you might need to use cmdlets that are in various modules and across multiple products. -For example, you might need a Windows cmdlet, then an Azure cmdlet, then a SharePoint cmdlet, then an Office 365 cmdlet. +Finding a cmdlet can sometimes be a challenge. This is because you might need to use cmdlets that are in various modules and across multiple products. For example, you might need a Windows cmdlet, then an Azure cmdlet, then a SharePoint cmdlet, then an Office 365 cmdlet. -The best way to find cmdlets is to use the PowerShell Browser and search. -The PowerShell Browser searches across all products and platforms. -You can find the PowerShell Browser here: https://docs.microsoft.com/powershell/module +The best way to find cmdlets is to use the PowerShell Browser and search. The PowerShell Browser searches across all products and platforms. You can find the PowerShell Browser here: <https://learn.microsoft.com/powershell/module>. ## I am a Microsoft employee but new to GitHub, what should I do? -You can learn about working with GitHub as a Microsoft employee here: https://docs.opensource.microsoft.com/github/ +You can learn about working with GitHub as a Microsoft employee here: <https://docs.opensource.microsoft.com/github/> In a nutshell you need to create a GitHub account and link it with your Microsoft account so you can contribute openly. @@ -101,46 +85,40 @@ They try to get to these every day and verify and merge Pull Requests. If it is an emergency you can look through the merge history and see who has worked on and merged a recent version and contact them directly. -If you are a Microsoft employee you can email the distribution group which includes the maintainers of the repository. -The distribution group is Office Docs PowerShell Maintainers (od-powershell). +If you are a Microsoft employee you can email the distribution group which includes the maintainers of the repository. The distribution group is Office Docs PowerShell Maintainers (od-powershell). ## Git is getting on my nerves, do you have any advice? One of the most confusing things with Git and GitHub is that there are many, many ways to do things. -You can use the command line with a cmd prompt or you can use a command line with git bash or you can use a GUI like GitHub Desktop https://desktop.github.com/. +You can use the command line with a cmd prompt or you can use a command line with git bash or you can use a GUI like GitHub Desktop <https://desktop.github.com/>. -If you are working with the command line using Git Bash, this will help: -https://www.codeproject.com/Articles/457305/Basic-Git-Command-Line-Reference-for-Windows-Users +If you are working with the command line using Git Bash, this will help: <https://www.codeproject.com/Articles/457305/Basic-Git-Command-Line-Reference-for-Windows-Users>. Also check out Git Kraken https://www.gitkraken.com/ which has a great user interface and visualizations. ## Why are all the cmdlets for a given product in a single folder in the repo? Wouldn't it be better to put them in buckets? -GitHub is the single source of truth for Office PowerShell cmdlet reference. -There is a single reference article per cmdlet. -There is a folder for each major product area in order to create a basic structure but this isn't require for the system to work. -Each article is tagged with appropriate metadata for versioning. -Keeping things as simple as possible has a number of benefits. -For more about the design of the system, see the FAQ item *"Why is this open source project designed the way it is?"*. +GitHub is the single source of truth for Office PowerShell cmdlet reference. There is a single reference article per cmdlet. There is a folder for each major product area in order to create a basic structure but this isn't require for the system to work. Each article is tagged with appropriate metadata for versioning. Keeping things as simple as possible has a number of benefits. For more about the design of the system, see the FAQ item *"Why is this open source project designed the way it is?"*. ## Why is this open source project designed the way it is? + The system was designed to be as simple as possible in order to achieve three primary objectives. 1. Increase community engagement. There are many open source projects and every one of them is striving for community involvement. We designed the PowerShell reference project to be easily understood in order to increase community ownership and contributions. - If a person comes to a project and they cannot understand what they can do in 20-30 seconds then they are likely to bounce on to something else. - The open source PowerShell reference project was designed to break down the barriers to understanding and so someone can ‘flow’ directly into contributions once they have discovered the project. + If a person comes to a project and they cannot understand what they can do in 20-30 seconds then they are likely to bounce on to something else. + The open source PowerShell reference project was designed to break down the barriers to understanding and so someone can 'flow' directly into contributions once they have discovered the project. A vibrant and active community results in the best reference content that goes directly back into PowerShell Get-Help. - + 1. Central location for content that feeds multiple surfacing mechanisms. - The first two places the PowerShell reference content is surfaces is Get-Help in PowerShell itself and the docs.microsoft.com website. - In the future the content can also be surfaced in an iOS app, Android app, Windows Universal app, and other mechanisms. - With a simple, centralized, system for the source of truth, in GitHub, it becomes much easier to surface content using multiple mechanisms since GitHub is not tailored for once specific location, such as Get-Help. - If the GitHub repo focused on one specific site or mechanism then surfacing from other mechansisms could become too complex or could exponentially expound the effort required. + The first two places the PowerShell reference content is surfaces is Get-Help in PowerShell itself and the learn.microsoft.com website. + In the future the content can also be surfaced in an iOS app, Android app, Windows Universal app, and other mechanisms. + With a simple, centralized, system for the source of truth, in GitHub, it becomes much easier to surface content using multiple mechanisms since GitHub is not tailored for once specific location, such as Get-Help. + If the GitHub repo focused on one specific site or mechanism then surfacing from other mechanisms could become too complex or could exponentially expound the effort required. 1. Keep content fresh and up to date. @@ -148,5 +126,3 @@ The system was designed to be as simple as possible in order to achieve three pr The system was designed so that the process can be automated, perhaps with a GitHub webhook that triggers on any merge. The idea is that in the past the Get-Help content was immediately outdated once a product shipped. With the new system the content in Get-Help will always be up-to-date by running an Update-Help, or equivalent, command in PowerSHell. - - diff --git a/repo_docs/NEW_CMDLETS.md b/repo_docs/NEW_CMDLETS.md index 9e41864e45..fbbbaaefc1 100644 --- a/repo_docs/NEW_CMDLETS.md +++ b/repo_docs/NEW_CMDLETS.md @@ -1,246 +1,196 @@ # Create new cmdlet topics + Cmdlet reference topics follow a very strict schema that's difficult to duplicate manually (remember, the topics on the web are also used for `Get-Help` from the command line). Instead, you use the open-source [platyPS](https://github.com/PowerShell/platyPS) tool to export the cmdlet and all of its properties to a markdown (.md) file from your PowerShell connection to the server or service. ## Step 1: Install platyPS -If you're running Windows 10 or Windows Server 2016, you already have Windows PowerShell 5.x installed, so installing platyPS is easy. -Run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): +On Windows 10, Windows Server 2016, or later, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): -``` +```powershell Install-Module -Name platyPS -Scope CurrentUser ``` -**Notes**: - -- You need platyPS v0.11.1 or later, released on or about September 13, 2018. If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded (or run the command `Remove-Module platyPS`) and then run `Update-Module platyPS` from an elevated Windows PowerShell window. - -- Windows PowerShell 5.x is part of the Windows Management Framework (WMF) and can be [downloaded](http://aka.ms/wmf5download) and installed on these versions of Windows: - - - Windows Server 2012 R2 - - - Windows Server 2012 - - - Windows Server 2008 R2 SP1 - - - Windows 8.1 +If you need to install platyPS on old versions of Windows (Windows 8.1 or Windows 2012 R2 or earlier), you need to install Windows PowerShell 5.1 before you can install platyPS. For instructions, see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this article. - - Windows 7 +If you need to install platyPS on really old versions of Windows (a server running a product that lacks support for WMF 5.1 or its requirements), see the [Install platyPS on really old versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this article. - If you need to install platyPS on an older version of Windows (for example, a server running a product that lacks support for WMF 5.x or its requirements), see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this topic. +You need platyPS v0.14.0 or later (released April 2019). If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded and then run `Update-Module platyPS` from a new elevated Windows PowerShell window. Or, run the command `Remove-Module platyPS` and then run `Install-Module -Name platyPS -Scope CurrentUser` to get the current version. ## Step 2: Connect to the PowerShell environment that has the cmdlet -You probably know how to do this already, but the available workloads and connection methods are: - -- Skype for Business Online: [https://technet.microsoft.com/library/dn362795.aspx](https://technet.microsoft.com/library/dn362795.aspx) -- Microsoft Teams: [https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/](https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/) +You probably know how to do this already, but the available workloads and connection methods are: - **HINT:** Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed. +- Microsoft Teams: [Install Microsoft Teams PowerShell](https://learn.microsoft.com/MicrosoftTeams/teams-powershell-install) -- SharePoint Online: [Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + > [!TIP] + > Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed. - Exchange: - - - Exchange Online: [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell) - - - Office 365 Security & Compliance Center: [Connect to Office 365 Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell) - - - Exchange Online Protection: [Connect to Exchange Online Protection PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-eop/connect-to-exchange-online-protection-powershell) - - - Exchange Server: [Connect to Exchange servers using remote PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-server/connect-to-exchange-servers-using-remote-powershell) - -**Notes**: - -- You might need to connect to the service in an elevated Windows PowerShell prompt (required for Skype for Business Online and Teams, but not Exchange). The connection instructions topic should contain this and other connection requirements. - -- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles). + - Exchange Online PowerShell: [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) + - Security & Compliance PowerShell: [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell) + - Exchange Online Protection PowerShell: [Connect to Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-protection-powershell) + - Exchange Server PowerShell: [Connect to Exchange servers using remote PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-servers-using-remote-powershell) + +> [!TIP] +> You might need to connect to the service in an elevated Windows PowerShell prompt (Teams and Exchange environments don't require an elevated Windows PowerShell prompt). The connection instructions article should plainly state this and other connection requirements. +> +> In Exchange and Security & Compliance PowerShell environments, the cmdlets that are available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles. +> +> Remote PowerShell connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell in favor of REST API connections. For more information, see the following articles: +> +> - [REST API connections in the EXO V3 module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#rest-api-connections-in-the-exo-v3-module). +> - [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). +> - [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). +> +> REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. The true parameter type values are visible in product code. ## Step 3: Load platyPS in the PowerShell environment -After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session: -``` +After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), you likely don't need to do anything to make the platyPS cmdlets available to you in your session. However, it you're having issues, run the following command to manually load the platyPS module: + +```powershell Import-Module platyPS ``` ### Step 4: Find your module name -**Note**: This step is required only if you're interested in creating cmdlet reference topics for **all** available cmdlets in your product (the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (the _Command_ parameter in `New-MarkdownHelp`), you can skip this step. + +> [!NOTE] +> This step is required only if you're interested in creating cmdlet reference articles for **all** available cmdlets in the product (using the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (using the _Command_ parameter in `New-MarkdownHelp`), you can skip this step. platyPS needs the name of the loaded PowerShell module or snap-in that contains the cmdlets you want to update. To find the name, run the following command: -``` +```powershell Get-Module | Format-Table -Auto ``` The command returns all of the currently loaded modules or snap-ins, and the output will resemble this: -``` +```powershell ModuleType Version Name ExportedCommands ---------- ------- ---- ---------------- Manifest 3.1.0.0 Microsoft.PowerShell.Management {Add-Computer, Add-Content, Checkpoint-Computer, Clear-Con... Manifest 3.0.0.0 Microsoft.PowerShell.Security {ConvertFrom-SecureString, ConvertTo-SecureString, Get-Acl... Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Object...} Binary 1.0.0.1 PackageManagement {Find-Package, Find-PackageProvider, Get-Package, Get-Pack... -Script 0.10.0 platyps {Get-HelpPreview, Get-MarkdownMetadata, Merge-MarkdownHelp... -Script 1.0.0.1 PowerShellGet {Find-Command, Find-DscResource, Find-Module, Find-RoleCap... -Script 1.2 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PS... +Script 2.2.5 PowerShellGet {Find-Command, Find-DscResource, Find-Module, Find-RoleCap... +Script 2.0.0 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PS... Script 1.0 tmp_byivwzpq.e1k {Add-AvailabilityAddressSpace, Add-DistributionGroupMember... ``` or this: -``` +```powershell ModuleType Version Name ExportedCommands ---------- ------- ---- ---------------- -Binary 16.0.7723.0 Microsoft.Online.SharePoint.PowerShell {Add-SPOGeoAdministrator, Add-SPOHubSiteAssociation, A... -Manifest 3.1.0.0 Microsoft.PowerShell.Management {Add-Computer, Add-Content, Checkpoint-Computer, Clear... -Manifest 3.0.0.0 Microsoft.PowerShell.Security {ConvertFrom-SecureString, ConvertTo-SecureString, Get... -Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Object...} -Script 1.2 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remov... +Manifest 3.1.0.0 Microsoft.PowerShell.Management {Add-Computer, Add-Content, Checkpoint-Computer, Clear-Content...} +Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Object...} +Script 4.2.0 MicrosoftTeams {Add-TeamChannelUser, Add-TeamUser, Connect-MicrosoftTeams, Disconnect-Microso... +Script 1.4.7 PackageManagement {Find-Package, Find-PackageProvider, Get-Package, Get-PackageProvider...} +Script 2.2.5 PowerShellGet {Find-Command, Find-DscResource, Find-Module, Find-RoleCapability...} +Script 2.0.0 PSReadline {Get-PSReadLineKeyHandler, Get-PSReadLineOption, Remove-PSReadLineKeyHandler, ... ``` -For services that use remote PowerShell (Skype for Business Online, Teams, Exchange Online, Security & Compliance Center, and Exchange Online Protection), the module name is a temporary value that changes every time you connect. In this output, the module name is `tmp_byivwzpq.e1k`, but yours will be different. +For services that use remote connections (Exchange), the module name is a temporary value that changes every time you connect. In the example output, the module name is `tmp_byivwzpq.e1k`, but yours will be different. -For SharePoint Online in the SharePoint Online Management Shell, the module name is always `Microsoft.Online.SharePoint.PowerShell`. +For Microsoft Teams, the module name is always `MicrosoftTeams`. Either way, take note of your module name. You'll need it in the next steps. -### Step 5: Verify your PSSession variable name -**Note**: This step is required in Exchange, Skype for Business Online and other products that use remote PowerShell in their connection instructions (one or more **xxx-xxxSession** commands are present). **If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell, you can skip this step**. - -Check the details of your connection instructions, but your session information is stored in a variable. For example, in the Exchange connection instructions, the variable is `$Session`. You'll use this variable name in later steps. - -**If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps**: - -1. Run the following command to find your session: - - ``` - Get-PSSession | Format-Table -Auto - ``` - - The output will resemble this: - - ``` - Id Name ComputerName ComputerType State ConfigurationName Availability - -- ---- ------------ ------------ ----- ----------------- ------------ - 1 WinRM1 outlook.office365.com RemoteMachine Opened Microsoft.Exchange Available - ``` - - or this: - - ``` - Id Name ComputerName ComputerType State ConfigurationName Availability - -- ---- ------------ ------------ ----- ----------------- ------------ - 1 WinRM1 admin2a.online.lync.com RemoteMachine Opened Microsoft.PowerShell Available - ``` - - **Note**: If you see multiple sessions, either start over in a new PowerShell window or confirm the session you want to use. The first connection is 1, the second is 2, and so on. - -2. Use the following syntax to store the session in a variable: - - ``` - $<VariableName> = Get-PSSession <SessionID> - ``` - - For example, using the sample output in the previous step: - - ``` - $Session = Get-PSSession 1 - ``` +### Step 5: Run platyPS to generate topic files - The variable name you choose doesn't matter, but you'll use it in later steps. - -### Step 6: Run platyPS to generate topic files You have two choices: -- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple but could take a while, and you'll end up with dozens or possibly hundreds of cmdlets files you don't need. The basic syntax is: +- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple but could take a while, and you'll end up with dozens or possibly hundreds of cmdlet files you don't need. The basic syntax is: + + ```powershell + New-MarkdownHelp -Module <ModuleName> -OutputFolder "<Path"> ``` - New-MarkdownHelp -Module <ModuleName> -OutputFolder "<Path"> [-Session <PSSessionVariableName>] - ``` - **Dump specific cmdlets to files**: This is a bit harder to set up, but the output is much quicker, and there are no extra topic files created. The basic syntax is: + ```powershell + New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> ``` - New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> [-Session <PSSessionVariableName>] - ``` - or - - ``` - $x = "<Cmdlet1>","<Cmdlet2>",..."<CmdletN>" - New-MarkdownHelp -Command $x -OutputFolder "<Path"> [-Session <PSSessionVariableName>] - ``` + or -**Notes**: + ```powershell + $x = "<Cmdlet1>","<Cmdlet2>",..."<CmdletN>" -- \<ModuleName\> is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `Microsoft.Online.SharePoint.PowerShell`). + New-MarkdownHelp -Command $x -OutputFolder "<Path"> + ``` -- \<PSSessionVariableName\> is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection instructions used remote PowerShell (one or more **xxx-xxxSession** commands)_. +**Notes**: - Failure to use the _Session_ parameter in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recognized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc. +- \<ModuleName\> is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `MicrosoftTeams`). - If the \<Path\> location doesn't exist, it's created for you. #### Dump all cmdlets in the module/snap-in to files -This example creates topic files for all available cmdlets in the Skype for Business Online PowerShell session where the module is `tmp_byivwzpq.e1k` and the session variable is `$Session` in the folder C:\My Docs\SfBO. -``` -New-MarkdownHelp -Module tmp_byivwzpq.e1k -OutputFolder "C:\My Docs\SfBO" -Session $Session +This example creates topic files for all available cmdlets in the Microsoft Teams module `MicrosoftTeams` in the folder C:\My Docs\Teams. + +```powershell +New-MarkdownHelp -Module MicrosoftTeams -OutputFolder "C:\My Docs\Teams" ``` #### Dump specific cmdlets to files -This example creates a topic file for the cmdlet named Get-CoolFeature in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO". -``` -New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session +This example creates a topic file for the cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session in the folder "C:\My Docs\ExO". + +```powershell +New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" ``` -This example creates topic files for the Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature cmdlets from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO. +This example creates topic files for the **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** cmdlets from the Exchange Online session in the folder C:\My Docs\ExO. The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files. -``` +```powershell $NewCmdlets = "Get-CoolFeature","New-CoolFeature","Remove-CoolFeature","Set-CoolFeature" -``` -``` -New-MarkdownHelp -Command $NewCmdlets -OutputFolder "C:\My Docs\ExO" -Session $Session +New-MarkdownHelp -Command $NewCmdlets -OutputFolder "C:\My Docs\ExO" ``` -### Step 7: Document the new cmdlet -Now that you have topic files for the new cmdets, you can actually document them. The topics are plain text UTF-8 files that are formatted using [markdown](https://guides.github.com/features/mastering-markdown/). Office writers use [Visual Studio Code](https://code.visualstudio.com/) to edit topic files, but you can use Notepad or your favorite text editor. +### Step 6: Document the new cmdlet + +Now that you have topic files for the new cmdlets, you can actually document them. The topics are plain text UTF-8 files that are formatted using [markdown](https://guides.github.com/features/mastering-markdown/). Office writers use [Visual Studio Code](https://code.visualstudio.com/) to edit topic files, but you can use Notepad or your favorite text editor. These are the basic topic elements that require your attention, regardless of the product or service: - **The SYNOPSIS section**: Be brief. Use the DESCRIPTION section for less critical information. - - **The DESCRIPTION section**: More details (for example, permissions required to run the cmdlet) - - **One or more code examples in the EXAMPLES section**: The code block (only one code block) goes first, then the description text. - - **A description for every parameter in each parameter section** We highly encourage you to plagiarize existing content and formatting from other cmdlet topics in the product or service. Many parameters are common across a wide variety of cmdlets. #### Metadata in the new cmdlet + Less obvious but still important information that's often manually required in every topic is **cmdlet metadata** at the top of the topic and **parameter metadata** in every parameter section. ##### Cmdlet metadata -Here's an example of the cmdlet metadata that's required at the top of every topic: - ``` - external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml - Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets - online version: - applicable: Microsoft StaffHub - title: Get-StaffHubUsersForTenant - schema: 2.0.0 - ``` +Every cmdlet reference topic needs (at a minimum) the following properties in the metadata field at the top of the reference article: + +```text +external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml +Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets +online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates +applicable: Skype for Business Server 2015 +title: Add-CsSlaDelegates +author: +ms.author: +ms.reviewer: +manager: +schema: 2.0.0 +``` -- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific, and the location is specified somewhere in product code. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange, SharePoint) use multiple XML files. See other topics for available values. Don't guess; a wrong value here will affect the availability of the help topic at the command line. +- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific, and the location is specified somewhere in product code. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange) use multiple XML files. See other topics for available values. Don't guess; a wrong value here will affect the availability of the help topic at the command line. -- **Module Name**: Not used in Exchange topics (remove it). For other products, this is the module name of the product. +- **Module Name**: In Exchange topics, this value is `ExchangeOnlineManagement` for those few cmdlets that are [baked into the Exchange Online PowerShell V3 module itself](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#cmdlets-in-the-exchange-online-powershell-module). For other products, this is the module name of the product. -- **online version**: Empty, but needs to be present. +- **online version**: This is the URL of the topic. This URL value is what makes the `Get-Help <Cmdlet> -Online` command work, so it's very important. - **applicable**: You need to add this attribute and value yourself. Notice that it starts with a lowercase 'a'. See other topics for available values. Don't invent new values here. The value **must** come from the list of predefined values. @@ -248,146 +198,178 @@ Here's an example of the cmdlet metadata that's required at the top of every top - **schema**: This value is always 2.0.0 in all products. +- **author**: The GitHub alias of the person that owns this topic. Usually the PM or sometimes a dev that owns the cmdlet. + +- **ms.author**: The Microsoft alias of the same author. + +- **ms.reviewer**: The Microsoft alias of someone that can approve any technical changes (if different than the author). + +- **manager**: The Microsoft alias of a manager for the team that owns the cmdlet. This is useful if the person that owns the cmdlet leaves the company. The manager will be reached to in order to find the new author. + ##### Parameter metadata + Here's an example of the parameter metadata that's present in every parameter section: - ```yaml - Type: String - Parameter Sets: (All) - Aliases: - Applicable: Microsoft StaffHub - Required: False - Position: 1 - Default value: None - Accept pipeline input: False - Accept wildcard characters: False - ``` +```text +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft StaffHub + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are: +- **Type**: In any environment, the values `Object` or `Object[]` are wrong. As previously described, REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. Other values like `String`, `Boolean`, and `DateTime` are detected correctly. The true parameter type values are visible in product code. + - **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values. -- **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. +- **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS **or any other PowerShell utility** (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. ### Step 8: Add the new cmdlet topic files to the repository -When you're done editing the topics, upload them to GitHub. + +When you're done editing the topics, upload them to GitHub. Note that you need to fork the repo, upload your files to your fork, and then submit a Pull Request. 1. Go to the correct location in the appropriate GitHub repository: - - Exchange: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange) + - Exchange: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange> + - Office Web Apps: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps> + - Skype: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/skype/skype-ps/skype> + - StaffHub: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/staffhub/staffhub-ps/staffhub> + - Teams: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams> + - Whiteboard: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard> + - SharePoint / OneDrive: <https://github.com/MicrosoftDocs/OfficeDocs-SharePoint-PowerShell> - For Exchange, you also need to go one level deeper into an appropriate subfolder. Choose wisely based on the surrounding cmdlet topics. Don't create new folders. +2. Select **Add file** \> **Upload files** - - Office Web Apps: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps) + ![Upload file.](../images/upload_files.png) - - SharePoint Online: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-online](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-online) +3. After you're done adding files, go to the **Propose changes** section at the bottom of the page: - - SharePoint PNP: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-pnp](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-pnp) + - A brief title is required. By default, the title is the name of the file, but you can change it. + - Optionally, you can enter more details in the **Add an optional extended description** box. You should @ include the GitHub alias of someone who can review and approve your upload. - - SharePoint Server: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-server](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-server) + When you're ready, click the green **Propose changes** button. - - Skype: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/skype/skype-ps/skype](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/skype/skype-ps/skype) + ![Propose file change section.](../images/propose-file-change.png) - - StaffHub: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/staffhub/staffhub-ps/staffhub](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/staffhub/staffhub-ps/staffhub) +4. On the **Open a pull request** page that appears, click the green **Create pull request** button. - - Teams: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams) + ![Open a pull request page.](../images/open-a-pull-request-page.png) - - Whiteboard: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard) +5. That's it. There's nothing more for you to do. -2. Click **Upload files** - - ![Upload file](../images/upload_files.png) +### Step 9: Add the new cmdlets to the TOC file -3. After you're done adding files, go to the **Propose file change** area at the bottom of the page. Enter a title and optional description information and then click **Propose file change**. +Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is the name of the module. For example: -4. On the next screen, click **Create pull request**. +- Exchange <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/exchange/exchange-ps/exchange/exchange.md> -### Step 9: Add the new cmdlets to the TOC file. -**Note**: This step isn't required for Exchange or SharePoint PNP, because there is no TOC file. + > [!TIP] + > Exchange also uses pseudo folders to organize cmdlets. You need to add any new cmdlets in the proper location in the file: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/exchange/mapping/serviceMapping.json>. -Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is the name of the module. For example: +- Office Web Apps: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/officewebapps/officewebapps-ps/officewebapps/officewebapps.md> -- Office Web Apps: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/officewebapps/officewebapps-ps/officewebapps/officewebapps.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/officewebapps/officewebapps-ps/officewebapps/officewebapps.md) +- Skype: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md> -- SharePoint Online: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md) +- StaffHub: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/staffhub/staffhub-ps/staffhub/staffhub.md> -- SharePoint Server: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md) +- Teams: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md> -- Skype: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md) +- Whiteboard: <https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/whiteboard/whiteboard-ps/whiteboard/whiteboard.md> -- StaffHub: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/staffhub/staffhub-ps/staffhub/staffhub.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/staffhub/staffhub-ps/staffhub/staffhub.md) +In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it's in _exactly_ the right format so it won't render as a template text. -- Teams: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md) +The steps to edit and publish the TOC file are identical to modifying any existing topic. The instructions are [here](https://github.com/MicrosoftDocs/office-docs-powershell/blob/main/README.md) (you're starting at Step 4). -- Whiteboard: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/whiteboard/whiteboard-ps/whiteboard/whiteboard.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/whiteboard/whiteboard-ps/whiteboard/whiteboard.md) +## Appendix -In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it's in _exactly_ the right format so it won't render as a template text. +### Reference -After you're done editing the TOC file: +- <https://learn.microsoft.com/powershell/module/powershellget/install-module> -1. Go to the **Propose file change** area at the bottom of the page. Enter a title and optional description information and then click **Propose file change**. +- <https://learn.microsoft.com/powershell/module/powershellget/update-module> -2. On the next screen, click **Create pull request**. +- <https://github.com/PowerShell/platyPS> -## Appendix +- <https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-module> -### Reference +### Install platyPS on older versions of Windows -- https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6 +> [!NOTE] +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. -- https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6 +The following older versions of Windows don't automatically include Windows PowerShell 5.1, but they support it. You need to download and install the Windows Management Framework (WMF) 5.1 from <https://aka.ms/wmf5download> on these versions of Windows: -- https://github.com/PowerShell/platyPS +- Windows 8.1 +- Windows Server 2012 or Windows Server 2012 R2 +- Windows 7 Service Pack 1 (SP1)<sup>1,</sup><sup>2</sup> +- Windows Server 2008 R2 SP1<sup>1,</sup><sup>2</sup> -- https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-module?view=powershell-6 +- <sup>1</sup> This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +- <sup>2</sup> Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). +### Install platyPS on really old versions of Windows (WMF 3.0 or 4.0) -### Install platyPS on older versions of Windows +> [!NOTE] +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. + +To install platyPS for use with products that require PowerShell 3.0 or 4.0 and don't initially have access to the **Install-Module** cmdlet, do the steps in this section. -**Note**: These procedures aren't required on Windows 10, Windows Server 2016, or other versions of Windows where the WMF 5.x is already installed. +1. Download and install PowerShellGet. The steps are described in [Installing PowerShellGet](https://learn.microsoft.com/powershell/scripting/gallery/installing-psget) and are summarized here as follows: -1. Download and install [PowerShellGet](https://www.microsoft.com/download/details.aspx?id=51451). + a. **PowerShell 3.0 only**: On the target computer, run the following command in an elevated Windows PowerShell window: -2. From an elevated Windows PowerShell window, run the following command: + ```powershell + [Environment]::SetEnvironmentVariable( + 'PSModulePath', + ((([Environment]::GetEnvironmentVariable('PSModulePath', 'Machine') -split ';') + "$env:ProgramFiles\WindowsPowerShell\Modules") -join ';'), 'Machine' + ) + ``` - ``` - Save-Module PowerShellGet -Path "<TargetPath>" - ``` + b. On another computer running PowerShell 5.1 or later where PowerShellGet is installed and working, open an elevated Windows PowerShell window and run the following command: - Where \<TargetPath\> is a location that's easy to find (for example, C:\Temp\PSG). + ```powershell + Save-Module PowerShellGet -Path "<ExistingPath>" + ``` - **Notes**: + Where \<ExistingPath\> is **an existing** folder/path that's easy to find (for example, `C:\Temp\PSG`). - - The target folder/path must already exist. + c. The command will create two new folders in the target path: - - The command will create two new folders in the target path: - - - PackageManagement + - `PackageManagement\<VersionFolder>\<FilesAndFolders>` + - `PowerShellGet\<VersionFolder>\<FilesAndFolders>` - - PowerShellGet + d. Move the \<FilesAndFolders\> out from under the \<VersionFolder\> and delete the now empty \<VersionFolder\> so the contents of the folders look like this: -3. Delete the following folders from your computer or move them to a remote location for safekeeping: + - `PackageManagement\<FilesAndFolders>` + - `PowerShellGet\<FilesAndFolders>` - - C:\Program Files\WindowsPowerShell\Modules\PackageManagement +2. On the target computer, delete the following folders or move them to a remote location for safekeeping: - - C:\Program Files\WindowsPowerShell\Modules\PowerShellGet + - `C:\Program Files\WindowsPowerShell\Modules\PackageManagement` + - `C:\Program Files\WindowsPowerShell\Modules\PowerShellGet` -4. In Windows Explorer, copy the PackageManagement and PowerShellGet folders FROM \<TargetPath\> TO C:\Program Files\WindowsPowerShell\Modules\ (replacing the folders you deleted in Step 3 with the new ones you downloaded in Step 2). +3. Copy the `PackageManagement` and `PowerShellGet` folders that you downloaded and fixed in Step 1b to `C:\Program Files\WindowsPowerShell\Modules` on the target computer. - You should now have the following folders again: + You should have the following folders on the target computer: - - C:\Program Files\WindowsPowerShell\Modules\PackageManagement + - `C:\Program Files\WindowsPowerShell\Modules\PackageManagement` + - `C:\Program Files\WindowsPowerShell\Modules\PowerShellGet` - - C:\Program Files\WindowsPowerShell\Modules\PowerShellGet +4. From an elevated Windows PowerShell window on the target computer, run the following command: -5. From an elevated Windows PowerShell window, run the following command: + ```powershell + Set-PSRepository -Name PSGallery -InstallationPolicy Trusted + ``` - ``` - Set-PSRepository -Name PSGallery -InstallationPolicy Trusted - ``` +5. Now you can finally install platyPS on the target computer by running the usual command: -6. Now you can finally install platyPS by running the following command: - - ``` - Install-Module -Name platyPS -Scope CurrentUser - ``` + ```powershell + Install-Module -Name platyPS -Scope CurrentUser + ``` diff --git a/repo_docs/UPDATE_CMDLETS.md b/repo_docs/UPDATE_CMDLETS.md index 32ced750ab..0f89ae5ffa 100644 --- a/repo_docs/UPDATE_CMDLETS.md +++ b/repo_docs/UPDATE_CMDLETS.md @@ -1,13 +1,14 @@ # Update existing cmdlet topics + Manually adding new parameters to a cmdlet reference topic is doable, but there are several obstacles to overcome: -- **Add the paramter and Type value to the SYNTAX block(s)**: Easy to do if there's only one, but what if there are multiple SYNTAX blocks (also known as parameter sets)? Does the new parameter go in one, some, or all of them? And what about the parameter Type value (String? `$true | $ false`? A finite list of values?) +- **Add the parameter and Type value to the SYNTAX block(s)**: Easy to do if there's only one, but what if there are multiple SYNTAX blocks (also known as parameter sets)? Does the new parameter go in one, some, or all of them? And what about the parameter Type value (String? `$true | $ false`? A finite list of values?) -- **Create a new section for each parameter**: It's easy to create the section and write the descrition, but again, what about the parameter Type value? And which parameter sets does it belong to? +- **Create a new section for each parameter**: It's easy to create the section and write the description, but again, what about the parameter Type value? And which parameter sets does it belong to? The reality is: you almost always need the open-source [platyPS](https://github.com/PowerShell/platyPS) tool to automatically answer the unknowns about new parameters. -Currently, the best method with platyPS is to simply create a new version of the topic using the **New-MarkdownHelp** cmdlet, and copy whatever you need out of it. Theoretically, platyPS has an **Update-MarkdownHelp** cmdlet that automatically updates an existing local copy of the topic for you, which you can then upload in its entirety to the GitHub website to replace the exisitng topic. This approach currently has some issues in our enviornment: +Currently, the best method with platyPS is to simply create a new version of the topic using the **New-MarkdownHelp** cmdlet, and copy whatever you need out of it. Theoretically, platyPS has an **Update-MarkdownHelp** cmdlet that automatically updates an existing local copy of the topic for you, which you can then upload in its entirety to the GitHub website to replace the existing topic. This approach currently has some issues in our environment: - It's difficult to get a local copy of an existing cmdlet topic from the GitHub website (unless you're interested in forking the repo and having a local cloned copy on your computer). You have to copy/paste everything from the Raw view of the topic on the web site, and the local copy text file you manually create needs to be UTF-8 formatted (instead of the Notepad default of ANSI). @@ -15,135 +16,127 @@ Currently, the best method with platyPS is to simply create a new version of the In short, it's simply easier and faster to generate a new local copy of the cmdlet topic, and copy/paste only what you need into the existing topic on GitHub. -Removing parameters from topics is a manual excercise, but we'll explain the process fully. +Removing parameters from topics is a manual exercise, but we'll explain the process fully. ## Use platyPS to add new cmdlets to existing topics ### Step 1: Install platyPS + The steps are the same as [Create new cmdlet topics](NEW_CMDLETS.md#step-1-install-platyps). ### Step 2: Connect to the PowerShell environment that has the cmdlet + You probably know how to do this already, but the available workloads and connection methods are also described in [Create new cmdlet topics](NEW_CMDLETS.md#step-2-connect-to-the-powershell-environment-that-has-the-cmdlet). +> [!NOTE] +> Remote PowerShell connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell in favor of REST API connections. For more information, see the following articles: +> +> - [REST API connections in the EXO V3 module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#rest-api-connections-in-the-exo-v3-module). +> - [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). +> - [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). +> +> REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. The true parameter type values are visible in product code. + ### Step 3: Load platyPS in the PowerShell environment + After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session: -``` +```powershell Import-Module platyPS ``` -### Step 4: Verify your PSSession variable name -This step is the same as in [Create new cmdlet topics](NEW_CMDLETS.md#step-5-verify-your-your-pssession-variable-name). - -To recap: this step is required in Exchange, Skype for Business Online and other products that use remote PowerShell in their connection instructions (one or more **xxx-xxxSession** commands are present), and the value is most likely `$Session`. - -If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell to connect, you can skip this step. +### Step 4: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file -### Step 5: Use New-MarkdownHelp to dump the latest verion of the cmdlet to a file These instructions are the same (up to a point) as in [Create new cmdlet topics](NEW_CMDLETS.md): The basic syntax is: - ``` - New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> [-Session <PSSessionVariableName>] - ``` +```powershell +New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> +``` - or - - ``` - $x = "<Cmdlet1>","<Cmdlet2>",..."<CmdletN>" - New-MarkdownHelp -Command $x -OutputFolder "<Path"> [-Session <PSSessionVariableName>] - ``` +or - This example create a topic file for the updated cmdlet named Get-CoolFeature in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO". +```powershell +$x = "<Cmdlet1>","<Cmdlet2>",..."<CmdletN>" +New-MarkdownHelp -Command $x -OutputFolder "<Path"> ``` -New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session + +This example create a topic file for the updated cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session in the folder "C:\My Docs\ExO". + +```powershell +New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" ``` -This example creates topic files for the updated cmdlets Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO. +This example creates topic files for the updated cmdlets **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** from the Exchange Online session in the folder C:\My Docs\ExO. The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files. -``` +```powershell $Delta = "Get-CoolFeature","New-CoolFeature","Remove-CoolFeature","Set-CoolFeature" -``` +New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO" ``` -New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO" -Session $Session -``` -### Step 6: Document the new parameters +### Step 5: Document the new parameters + The resulting topics are plain text UTF-8 files that are formatted using [markdown](https://guides.github.com/features/mastering-markdown/). Office writers use [Visual Studio Code](https://code.visualstudio.com/) to edit topic files, but you can use Notepad or your favorite text editor. 1. Find the new parameter(s) in the SYNTAX block and the parameter sections. -2. Add a parameter description. We highly enourage you to plagerize existing content and formatting from other cmdlet topics. Many parameters are common across a wide variety of cmdlets. - -3. Create/fill out the parameter metadata like other existing parameters in the topic. - - Here's an example of the parameter metadata that's present in every parameter section: - - ``` - Type: String - Parameter Sets: (All) - Aliases: - Applicable: Microsoft StaffHub - Required: False - Position: 1 - Default value: None - Accept pipeline input: False - Accept wildcard characters: False - ``` - - Most of the atrributes and values are generated automatically by platyPS. The ones that require manual intervention are: +2. Add a parameter description. We highly encourage you to plagiarize existing content and formatting from other cmdlet topics. Many parameters are common across a wide variety of cmdlets. - - **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values. - - - **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. - -### Step 7: Copy your changes into the existing topic on GitHub -At this point, the steps are basically identical to [Short URL: aka.ms/office-powershell](../README.md): - -1. Go to the cmdlet topics location in the appropriate GiHub repository: +3. Create/fill out the parameter metadata like other existing parameters in the topic. - - Exchange: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange) + Here's an example of the parameter metadata that's present in every parameter section: - For Exchage, you also need to go one level deepter into an appropriate subfolder. + ```yaml + Type: String + Parameter Sets: (All) + Aliases: + Applicable: Microsoft StaffHub - - Office Web Apps: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps) + Required: False + Position: 1 + Default value: None + Accept pipeline input: False + Accept wildcard characters: False + ``` - - SharePoint Online: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-online](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-online) + Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are: - - SharePoint PNP: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-pnp](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-pnp) + - **Type**: In any environment, the values `Object` or `Object[]` are wrong. As previously described, REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. Other values like `String`, `Boolean`, and `DateTime` are detected correctly. The true parameter type values are visible in product code. - - SharePoint Server: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-server](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/sharepoint/sharepoint-ps/sharepoint-server) + - **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values. - - Skype: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/skype/skype-ps/skype](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/skype/skype-ps/skype) + - **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS **or any other PowerShell utility** (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. - - StaffHub: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/staffhub/staffhub-ps/staffhub](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/staffhub/staffhub-ps/staffhub) +### Step 6: Copy your changes into the existing topic on GitHub - - Teams: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams) +1. Go to the cmdlet topics location in the appropriate GiHub repository: - - Whiteboard: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard) + - Exchange: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/exchange/exchange-ps/exchange> + - Office Web Apps: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps> + - Skype: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/skype/skype-ps/skype> + - StaffHub: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/staffhub/staffhub-ps/staffhub> + - Teams: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams> + - Whiteboard: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard> -2. Find the topic and click **Edit** +2. Find the existing topic and click **Edit**. 3. Copy/paste your updates (and only your updates) from your new, local copy of the topic into the existing topic (click the **Preview** tab to see what they'll look like). - **IMPORTANT**: The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help. - Any deviation will throw errors in the Pull Request. The schema can be found here: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md - -4. Once you're satisfied with your work, go to the **Propose file change** area at the bottom of the topic. Enter a title and other description information and then click **Propose file change**. - - ![Image of Propose file change on Github](../images/propose_file_change.png) + > [!IMPORTANT] + > The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help. Any deviation will throw errors in the Pull Request. The schema can be found here: <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>. -7. On the next screen, click **Create pull request**. +4. At this point, the steps are identical to [Short URL: aka.ms/office-powershell](../README.md) (You're starting at Step 4). ## Remove existing parameters from existing topics -Removing parameters is a search and destroy mission in the existing topics on GitHub, using the basic [Editing Instrucstions](../README.md). -The most important thing to remember: a parameter isn't gone until it's truly not available to customers. If a parameter is still available, but it's going away "in the future", it doesn't work correctly anymore, or isn't supposed to be available, it needs to remain in the topic until the product code is actually changed to remove the parameter. Until then, you can use this type of languague for the parameter description: +Removing parameters is a search and destroy mission in the existing topics on GitHub, using the basic [Editing Instructions](../README.md). + +The most important thing to remember: a parameter isn't gone until it's truly not available to customers. If a parameter is still available, but it's going away "in the future", it doesn't work correctly anymore, or isn't supposed to be available, it needs to remain in the topic until the product code is actually changed to remove the parameter. Until then, you can use this type of language for the parameter description: - This parameter is reserved for internal Microsoft use. @@ -154,7 +147,5 @@ Hear me now, believe me later: Removing available parameters from a cmdlet refer After you've confirmed that the parameter in question is really gone, find and remove all references to the parameter in the topic: - The SYNTAX block(s) - - Examples - - The individual parameter sections where each parameter is described. Be sure to delete the whole section including the \`\`\`yaml part at the end (don't leave trailing \`\`\`, which is easy to do). diff --git a/sharepoint/docfx.json b/sharepoint/docfx.json deleted file mode 100644 index 3aedc0ff0c..0000000000 --- a/sharepoint/docfx.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "build": { - "content": [ - { - "files": ["**/*.md"], - "src": "docs-conceptual", - "version": "sharepoint-ps", - "dest": "sharepoint", - "exclude": [ - "**/obj/**", - "**/includes/**", - "README.md", - "LICENSE", - "LICENSE-CODE", - "ThirdPartyNotices"] - }, - { - "files": ["toc.yml"], - "src": "docs-conceptual", - "version": "sharepoint-ps", - "dest": "sharepoint/sharepoint-ps" - }, - { - "files": ["**/*.md"], - "src": "sharepoint-ps", - "version": "sharepoint-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "sharepoint-ps", - "version": "sharepoint-ps", - "dest": "module/sharepoint-ps" - } - ], - "resource": [ - { - "files": [ - "**/*.png", - "**/*.jpg" - ], - "exclude": [ - "**/obj/**", - "**/includes/**" - ] - } - ], - "versions": { - "sharepoint-ps": { - "dest": "sharepoint-ps" - } - }, - "overwrite": [], - "externalReference": [], - "globalMetadata": { - "author" : "techwriter40", - "ms.author" : "kirks", - "manager" : "pamgreen", - "ms.date" : "11/28/2017", - "ms.topic" : "reference", - "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" - }, - "fileMetadata": { - "ms.service":{ - "sharepoint-ps/sharepoint-online/*.md":"sharepoint-powershell" - }, - "ms.prod":{ - "sharepoint-ps/sharepoint-server/*.md":"sharepoint-2016-powershell" - } - }, - "template": [], - "dest": "sharepoint-ps" - } -} \ No newline at end of file diff --git a/sharepoint/docs-conceptual/index.md b/sharepoint/docs-conceptual/index.md deleted file mode 100644 index 1b0481d533..0000000000 --- a/sharepoint/docs-conceptual/index.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: SharePoint PowerShell -description: Find out how to manage SharePoint Server and SharePoint Online using PowerShell cmdlets. -services: sharepoint-powershell -author: czeumault -manager: carolz -layout: LandingPage -ms.assetid: -ms.service: sharepoint-powershell -ms.tgt_pltfrm: na -ms.devlang: na -ms.topic: landing-page -ms.date: 11/27/2017 -ms.author: carolz ---- -# SharePoint PowerShell - -Find out how to manage SharePoint Server and SharePoint Online using PowerShell cmdlets. - -<ul class="panelContent cardsFTitle"> - <li> - <a href="http://github.com/powershell/sharepoint/overview"> - <div class="cardSize"> - <div class="cardPadding"> - <div class="card"> - <div class="cardImageOuter"> - <div class="cardImage"> - <img src="https://docs.microsoft.com/en-us/office/media/icons/walkthrough-map-blue.svg" alt="" /> - </div> - </div> - <div class="cardText"> - <h3>Overview</h3> - </div> - </div> - </div> - </div> - </a> - </li> - <li> - <a href="http://github.com/powershell/module/sharepoint-server/"> - <div class="cardSize"> - <div class="cardPadding"> - <div class="card"> - <div class="cardImageOuter"> - <div class="cardImage"> - <img src="https://docs.microsoft.com/en-us/office/media/icons/walkthrough-map-blue.svg" alt="" /> - </div> - </div> - <div class="cardText"> - <h3>SharePoint Server cmdlets</h3> - </div> - </div> - </div> - </div> - </a> - </li> - <li> - <a href="http://github.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell"> - <div class="cardSize"> - <div class="cardPadding"> - <div class="card"> - <div class="cardImageOuter"> - <div class="cardImage"> - <img src="https://docs.microsoft.com/media/logos/logo_sharepoint.svg" alt="" /> - </div> - </div> - <div class="cardText"> - <h3>SharePoint Online cmdlets</h3> - </div> - </div> - </div> - </div> - </a> - </li> - <li> - <a href="http://github.com/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets"> - <div class="cardSize"> - <div class="cardPadding"> - <div class="card"> - <div class="cardImageOuter"> - <div class="cardImage"> - <img src="https://docs.microsoft.com/media/logos/logo_sharepoint.svg" alt="" /> - </div> - </div> - <div class="cardText"> - <h3>Patterns and Practices</h3> - </div> - </div> - </div> - </div> - </a> - </li> -</ul> - ---- - -<h2>Top Solutions</h2> -<ul class="panelContent cardsW"> - <li> - <div class="cardSize"> -         <div class="cardPadding"> -             <div class="card"> -                 <div class="cardText"> -                     <h3>SharePoint Server</h3> -                     <p><a href="http://github.com/powershell/sharepoint/overview?%20view=sharepoint-ps&branch=master#permissions">Permissions</a></p> - <p><a href="http://github.com/powershell/module/sharepoint-server/install-spsolution?view=sharepoint-ps">Install-SPSolution</a></p> - <p><a href="http://github.com/powershell/module/sharepoint-server/restore-spsite?view=sharepoint-ps">Restore-SPSite</a></p> - <p><a href="http://github.com/powershell/module/sharepoint-server/get-spsite?view=sharepoint">Get-SPSite</a></p> -                 </div> -             </div> -         </div> -     </div> - </li> - <li> -     <div class="cardSize"> -         <div class="cardPadding"> -             <div class="card"> -                 <div class="cardText"> -                     <h3>SharePoint Online</h3> - <p><a href="http://github.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps">Connect to SharePoint Online</a></p> - <p><a href="http://github.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=share">Introduction to the SharePoint Online Management Shell</a></p> - <p><a href="https://technet.microsoft.com/en-us/library/fp161362(v=office.16).aspx">Office 365 PowerShell for SharePoint Online</a></p> -                 </div> -             </div> -         </div> -     </div> - </li> -</ul> diff --git a/sharepoint/docs-conceptual/overview.md b/sharepoint/docs-conceptual/overview.md deleted file mode 100644 index 9b9f87093a..0000000000 --- a/sharepoint/docs-conceptual/overview.md +++ /dev/null @@ -1,49 +0,0 @@ -## Overview ## - -Microsoft PowerShell is a command-line shell and scripting language that provides an administrator full access to applicable application programming interfaces (APIs). Administrators can interact directly with SharePoint Server to manipulate web applications, site collections, sites, lists and much more. In addition, an administrator can script cmdlets (pronounced "command-lets"). - -By default, Powershell is located at the following path: <%SystemRoot%>\System32\WindowsPowerShell\v1.0\PowerShell.exe. - -PowerShell can be used by authorized admins to perform a wide variety of tasks in SharePoint on-premises and SharePoint Online. Microsoft provides the cmdlets used for these 2 systems and the Patterns and Practices (PnP) group has created an additional set of modules that provide many additional capabilities. - -For a list of SharePoint Server on-premises cmdlets, see [SharePoint Server cmdlets](sharepoint-server\sharepoint-server-cmdlets.md) - -For a list of SharePoint Online cmdlets, see [SharePoint Online cmdlets](sharepoint-online\sharepoint-online-cmdlets.md) - -For a list of the SharePoint PnP cmdlets, see [SharePoint PnP cmdlets](sharepoint-pnp\sharepoint-pnp-cmdlets.md) - -#### SharePoint Online #### - -Verify that you have the following administrative permissions: - -* You must be assigned the global administrator role on the SharePoint Online site on which you are running the PowerShell cmdlet. -  For more information, see [Default administrative roles and user groups](https://support.office.com/en-us/article/Default-SharePoint-Groups-13BB2B6B-DD8C-447E-B71B-0E4BB9EFE1D3?ui=en-US&rs=en-US&ad=US). - -**IMPORTANT:** You can use a specific group of PowerShell with SharePoint Online. For more information, see [Office 365 PowerShell for SharePoint Online](https://technet.microsoft.com/en-us/library/fp161362(v=office.16).aspx). - -## Learning PowerShell ## - -There are several PowerShell learning resources for SharePoint IT professionals. - -#### TechNet Scripting Center #### - -The TechNet Scripting Center includes many resources to help you learn the basics about PowerShell. It also contains script repositories with samples of scripts that are typically used with various Microsoft products. The following table shows the main learning resources. - -|**Page**|**Description**| -|------------------|------------------| -|[Windows PowerShell Documentation on TechNet ](https://docs.microsoft.com/en-us/powershell/scripting/powershell-scripting?view=powershell-5.1)|This section of the TechNet Library contains web copies of the core PowerShell Get-Help topics. The section also has web copies of the PowerShell Getting Started document, the PowerShell.exe help, and a PowerShell primer.| -|[Scripting With Windows PowerShell ](https://technet.microsoft.com/en-us/scriptcenter/dd742419.aspx)| The home page for PowerShell scripting learning resources.| -|[Windows PowerShell Owner's Manual ](https://technet.microsoft.com/en-us/library/ee221100.aspx)|Web-based guide for getting started with PowerShell.| -|[Windows PowerShell Quick Reference ](https://www.microsoft.com/en-us/download/details.aspx?id=30002)|Downloadable copy of the Quick Reference document that is installed with PowerShell.| - -As you read these resources, consider that the following concepts and cmdlets are useful ones to learn before you use PowerShell for SharePoint Server: - -* [Get-Command](https://go.microsoft.com/fwlink/p/?LinkId=171069) -* [Get-Member](https://go.microsoft.com/fwlink/p/?LinkId=171070) -* [Get-Help](https://go.microsoft.com/fwlink/p/?LinkId=171068) -* [Aliasing](https://go.microsoft.com/fwlink/p/?LinkId=113207) -* [Piping and the Pipeline in Windows PowerShell ](https://technet.microsoft.com/en-us/library/ee176927.aspx) -* [Cmdlet Parameter Sets ](https://msdn.microsoft.com/library/dd878348(VS.85).aspx) -* [Foreach-Object ](https://technet.microsoft.com/en-us/library/ee176828.aspx) -* [Where-Object](https://technet.microsoft.com/en-us/library/ee177028.aspx) - diff --git a/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md b/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md deleted file mode 100644 index a8df79c990..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md +++ /dev/null @@ -1,53 +0,0 @@ -# Getting started with SharePoint Online Management Shell # - -Before you get started using PowerShell to manage SharePoint Online, make sure that the SharePoint Online Management Shell is installed and you have connected to SharePoint Online. - -Install the SharePoint Online Management Shell by downloading and running the [SharePoint Online Management Shell](https://go.microsoft.com/fwlink/p/?LinkId=255251) or installing module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Microsoft.Online.SharePoint.PowerShell/16.0.8029.0). Once installed, the module is available for use, and you do not need to install it again until you need features introduced in a later version. For example, you may need to install a new version for TLS 1.2 negotiation after October 2018. - -First you can check if you have already installed SharePoint Online Management Shell by running the following command in administrative mode in PowerShell. - -```ps -Get-Module -Name Microsoft.Online.SharePoint.PowerShell -ListAvailable | Select Name,Version -``` - -If your operating system is using PowerShell 5 or newer, you can install Sharepoint Online Management Shell also by running following command in administrative mode. - -```ps -Install-Module -Name Microsoft.Online.SharePoint.PowerShell -``` - -To open the SharePoint Online Management Shell command prompt, from the **Start** screen, type **sharepoint**, and then click **SharePoint Online Management Shell**. - -<br /> - -> [!Video https://www.youtube.com/embed/TMzHAWEQjlk] - -## To connect with a user name and password ## - -1. Fill in the values for the **$adminUPN** and **$orgName** variables (replacing all the text between the quotes, including the < and > characters), and then run the following commands at the SharePoint Online Management Shell command prompt: - -``` -$adminUPN="<the full email address of a SharePoint administrator account, example: jdoe@contosotoycompany.onmicrosoft.com>" -$orgName="<name of your Office 365 organization, example: contosotoycompany>" -$userCredential = Get-Credential -UserName $adminUPN -Message "Type the password." -Connect-SPOService -Url https://$orgName-admin.sharepoint.com -Credential $userCredential - -``` - -2. When prompted with the Windows PowerShell credential request dialog box, type the password for the SharePoint Online SharePoint administrator account. - -To make a user account a SharePoint administrator, see [Assign admin roles in Office 365 for business](https://support.office.com/en-us/article/Assign-admin-roles-in-Office-365-for-business-eac4d046-1afd-4f1a-85fc-8219c79e1504?ui=en-US&rs=en-US&ad=US) or [Assign roles to user accounts with Office 365 PowerShell](https://technet.microsoft.com/library/mt736914.aspx). - -## To connect with multifactor authentication (MFA) ## - -1. Fill in the value for the **$orgName** variable (replacing all the text between the quotes, including the < and > characters), and then run the following commands at the SharePoint Online Management Shell command prompt: - -``` -$orgName="<name of your Office 365 organization, example: contosotoycompany>" -Connect-SPOService -Url https://$orgName-admin.sharepoint.com -``` -2. When prompted with the **Microsoft SharePoint Online Management Shell** dialog box, type the account name and password for a SharePoint administrator account, and then click **Sign in**. - -3. Follow the instructions in the **Microsoft SharePoint Online Management Shell** dialog box to provide the additional authentication information, such as a verification code, and then click **Sign in**. - -You are now ready to use SharePoint Online commands. diff --git a/sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md b/sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md deleted file mode 100644 index 44aa97b4f0..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md +++ /dev/null @@ -1,23 +0,0 @@ -# What is the SharePoint Online Management Shell? # - -The SharePoint Online Management Shell is a Windows PowerShell module that you can use to manage SharePoint Online users, sites, and site collections. Command-line operations in Windows PowerShell are composed of a series of commands. Each command uses a cmdlet and a set of settings known as parameters. For example, you use the **New-SPOSite** cmdlet for a command that creates a new SharePoint Online site collection with a specified title, URL, owner, storage quota, and template (the parameters). - -SharePoint Online PowerShell commands can be very efficient for batch operations — for example, creating a dozen new site collections or adding hundreds of new SharePoint Online users to a site. For more information, see [Why you need to use Office 365 PowerShell](https://technet.microsoft.com/library/dn568034.aspx). - -#### What is the difference between SharePoint Online PowerShell commands and Office 365 PowerShell commands? #### - -The major and obvious difference is the nouns they use. Every SharePoint Online cmdlet will start with SPO as its noun. Conversely, Office 365 will start with MSO as it noun. - -The set of SharePoint Online Management Shell commands differs from the set of Office 365 for professionals and small businesses PowerShell commands. SharePoint Online Management Shell commands manage SharePoint Online users and site collections, whereas Office 365 commands manage Office 365-level tasks such as users, licenses, organization information, and services. They both manage users and groups. However, Office 365 PowerShell commands manage users and groups for all of the Office 365 services. The SharePoint Online commands manage users and groups only for SharePoint Online. - -#### Should I use the SharePoint Online Admin Center or SharePoint Online PowerShell commands? #### - -If you are new to Office 365 and SharePoint Online and you have not done much managing of SharePoint sites or users, the SharePoint Online Administration Center is a good place to start. - -After you get familiar with SharePoint Online sites and users, try using SharePoint Online commands, especially when you want to manage lots of users, sites, or site collections. - -# How do I get permissions and set up the environment? # - -To use SharePoint Online PowerShell commands, you must be a SharePoint Online global administrator. - -Before you can run SharePoint Online commands, you must install the SharePoint Online Management Shell module and connect to the SharePoint Online service. For more information, see [Connect SharePoint Online](connect-sharepoint-online.md) diff --git a/sharepoint/docs-conceptual/sharepoint-online/sharepoint-online-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-online/sharepoint-online-cmdlets.md deleted file mode 100644 index 8d31c2e5c1..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-online/sharepoint-online-cmdlets.md +++ /dev/null @@ -1,6 +0,0 @@ -#SharePoint Online Cmdlets - -For a listing of the SharePoint Online cmdlets, see [SharePoint Online cmdlets](../../sharepoint-ps/sharepoint-online/sharepoint-online.md). - -* [Introduction to SharePoint Online Management Shell](introduction-sharepoint-online-management-shell.md) -* [Getting started with SharePoint Online Management Shell](connect-sharepoint-online.md) diff --git a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md deleted file mode 100644 index 30e9c27cbc..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md +++ /dev/null @@ -1,597 +0,0 @@ -# PnP PowerShell overview - -SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online as SharePoint On-Premises. - -![SharePoint Patterns and Practices](https://devofficecdn.azureedge.net/media/Default/PnP/sppnp.png) - -_**Applies to:** SharePoint Online | SharePoint 2016 | SharePoint 2013_ - -## Installation # - -There are 3 ways to install the cmdlets. We recommend, where possible, to install them from the [PowerShell Gallery](https://www.powershellgallery.com). Alternatively you can download the setup files or run a PowerShell script to download the PowerShellGet module and install the cmdlets subsequently. - -### PowerShell Gallery ### -If you main OS is Windows 10, or if you have [PowerShellGet](https://github.com/powershell/powershellget) installed, you can run the following commands to install the PowerShell cmdlets: - -|**SharePoint Version**|**Command to install**| -|------------------|------------------| -|SharePoint Online|```Install-Module SharePointPnPPowerShellOnline ```| -|SharePoint 2016|```Install-Module SharePointPnPPowerShell2016```| -|SharePoint 2013|```Install-Module SharePointPnPPowerShell2013```| - -*Notice*: if you install the latest PowerShellGet from Github, you might receive an error message stating ->PackageManagement\Install-Package : The version 'x.x.x.x' of the module 'SharePointPnPPowerShellOnline' being installed is not catalog signed. - -In order to install the cmdlets when you get this error specify the -SkipPublisherCheck switch with the Install-Module cmdlet, e.g. ```Install-Module SharePointPnPPowerShellOnline -SkipPublisherCheck -AllowClobber``` - -### Setup files ## -You can download setup files from the [releases](https://github.com/sharepoint/pnp-powershell/releases) section of the PnP PowerShell repository. These files will up be updated on a monthly basis. Run the install and restart any open instances of PowerShell to use the cmdlets. - -### Installation script ## -This is an alternative for installation on machines that have at least PowerShell v3 installed. You can find the version of PowerShell by opening PowerShell and running ```$PSVersionTable.PSVersion```. The value for ```Major``` should be above 3. - -To install the cmdlets you can run the below command which will install PowerShell Package Management and then install the PowerShell Modules from the PowerShell Gallery. - -```powershell -Invoke-Expression (New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/sharepoint/PnP-PowerShell/master/Samples/Modules.Install/Install-SharePointPnPPowerShell.ps1') -``` - -## Updating ## -Every month a new release will be made available of the PnP PowerShell Cmdlets. If you earlier installed the cmdlets using the setup file, simply download the [latest version](https://github.com/SharePoint/PnP-PowerShell/releases/latest) and run the setup. This will update your existing installation. - -If you have installed the cmdlets using PowerShellGet with ```Install-Module``` from the PowerShell Gallery then you will be able to use the following command to install the latest updated version: - -```powershell -Update-Module SharePointPnPPowerShell* -``` - -This will automatically load the module after starting PowerShell 3.0. - -You can check the installed PnP-PowerShell versions with the following command: - -```powershell -Get-Module SharePointPnPPowerShell* -ListAvailable | Select-Object Name,Version | Sort-Object Version -Descending -``` - -## Getting Started # - -To use the library you first need to connect to your tenant: - -```powershell -Connect-PnPOnline –Url https://yoursite.sharepoint.com –Credentials (Get-Credential) -``` - -Notice: if you use multi-factor authentication on your tenant, use - -```powershell -Connect-PnPOnline -Url https://yoursite.sharepoint.com -UseWebLogin -``` - -To view all cmdlets, enter - -```powershell -Get-Command -Module *PnP* -``` - -At the following links you will find a few videos on how to get started with the cmdlets: - -* https://channel9.msdn.com/blogs/OfficeDevPnP/PnP-Web-Cast-Introduction-to-Office-365-PnP-PowerShell -* https://channel9.msdn.com/blogs/OfficeDevPnP/Introduction-to-PnP-PowerShell-Cmdlets -* https://channel9.msdn.com/blogs/OfficeDevPnP/PnP-Webcast-PnP-PowerShell-Getting-started-with-latest-updates - -### Setting up credentials ## -See this [wiki page](https://github.com/SharePoint/PnP-PowerShell/wiki/How-to-use-the-Windows-Credential-Manager-to-ease-authentication-with-PnP-PowerShell) for more information on how to use the Windows Credential Manager to setup credentials that you can use in unattended scripts - -## Cmdlet overview - - -### Apps -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Add-PnPApp.md)** |Add/uploads an available app to the app catalog|SharePoint Online -**[Get‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Get-PnPApp.md)** |Returns the available apps from the app catalog|SharePoint Online -**[Install‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Install-PnPApp.md)** |Installs an available app from the app catalog|SharePoint Online -**[Publish‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md)** |Publishes/Deploys/Trusts an available app in the app catalog|SharePoint Online -**[Remove‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md)** |Removes an app from the app catalog|SharePoint Online -**[Uninstall‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md)** |Uninstalls an available add-in from the site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Unpublish‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md)** |Unpublishes/retracts an available add-in from the app catalog|SharePoint Online -**[Update‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Update-PnPApp.md)** |Updates an available app from the app catalog|SharePoint Online -**[Get‑PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md)** |Returns a SharePoint AddIn Instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Uninstall‑PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md)** |Removes an app from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Import‑PnPAppPackage](../../sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md)** |Adds a SharePoint Addin to a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Grant‑PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md)** |Explicitly grants a specified permission to the "SharePoint Online Client" service principal|SharePoint Online - - -### Base Cmdlets -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPAppAuthAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md)** |Returns the access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPAuthenticationRealm](../../sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md)** |Returns the authentication realm|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPAzureADManifestKeyCredentials](../../sharepoint-ps/sharepoint-pnp/Get-PnPAzureADManifestKeyCredentials.md)** |Return the JSON Manifest snippet for Azure Apps|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPAzureCertificate](../../sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md)** |Get PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPAzureCertificate](../../sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md)** |Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPConnection](../../sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPContext](../../sharepoint-ps/sharepoint-pnp/Get-PnPContext.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPContext](../../sharepoint-ps/sharepoint-pnp/Set-PnPContext.md)** |Set the ClientContext|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPException](../../sharepoint-ps/sharepoint-pnp/Get-PnPException.md)** |Returns the last exception that occured|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPHealthScore](../../sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md)** |Retrieves the healthscore|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Connect‑PnPOnline](../../sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md)** |Connect to a SharePoint site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Disconnect‑PnPOnline](../../sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md)** |Disconnects the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md)** |Returns a previously not loaded property of a ClientObject|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Invoke‑PnPQuery](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md)** |Executes the currently queued actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md)** |Adds a credential to the Windows Credential Manager|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md)** |Get a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md)** |Removes a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPTraceLog](../../sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md)** |Turn log tracing on or off|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Branding -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md)** |Adds a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md)** |Return user custom actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md)** |Removes a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPHomePage](../../sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md)** |Return the homepage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPHomePage](../../sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md)** |Sets the home page of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPJavaScriptBlock](../../sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md)** |Adds a link to a JavaScript snippet/block to a web or site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md)** |Adds a link to a JavaScript file to a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md)** |Returns all or a specific custom action(s) with location type ScriptLink|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md)** |Removes a JavaScript link or block from a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md)** |Returns the URLs of the default Master Page and the custom Master Page.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md)** |Set the masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPMinimalDownloadStrategy](../../sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md)** |Activates or deactivates the minimal downloading strategy.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md)** |Adds an item to a navigation element|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md)** |Returns all or a specific navigation node|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md)** |Removes a menu item from either the quicklaunch or top navigation|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Disable‑PnPResponsiveUI](../../sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md)** |Deactivate the PnP Response UI add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Enable‑PnPResponsiveUI](../../sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md)** |Activates the PnP Response UI Add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTheme](../../sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md)** |Returns the current theme/composed look of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPTheme](../../sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md)** |Sets the theme of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPWebTheme](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md)** |Sets the theme of the current web.|SharePoint Online - - -### Client-Side Pages -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPAvailableClientSideComponents](../../sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md)** |Gets the available client side components on a particular page|SharePoint Online -**[Move‑PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md)** |Moves a Client-Side Component to a different section/column|SharePoint Online -**[Add‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md)** |Adds a Client-Side Page|SharePoint Online -**[Get‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md)** |Gets a Client-Side Page|SharePoint Online -**[Remove‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md)** |Removes a Client-Side Page|SharePoint Online -**[Set‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md)** |Sets parameters of a Client-Side Page|SharePoint Online -**[Add‑PnPClientSidePageSection](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md)** |Adds a new section to a Client-Side page|SharePoint Online -**[Add‑PnPClientSideText](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md)** |Adds a text element to a client-side page.|SharePoint Online -**[Add‑PnPClientSideWebPart](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md)** |Adds a Client-Side Web Part to a client-side page|SharePoint Online - - -### Content Types -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPContentType](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md)** |Adds a new content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPContentType](../../sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md)** |Retrieves a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPContentType](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md)** |Removes a content type from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPContentTypeFromList](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md)** |Removes a content type from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPContentTypePublishingHubUrl](../../sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md)** |Returns the url to Content Type Publishing Hub|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPContentTypeToList](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md)** |Adds a new content type to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPDefaultContentTypeToList](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md)** |Sets the default content type for a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPFieldFromContentType](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md)** |Removes a site column from a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPFieldToContentType](../../sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md)** |Adds an existing site column to a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Diagnostic utilites -======= -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Measure‑PnPList](../../sharepoint-ps/sharepoint-pnp/Measure-PnPList.md)** |Returns statistics on the list object|SharePoint Online, SharePoint 2016 -**[Measure‑PnPResponseTime](../../sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md)** |Gets statistics on response time for the specified endpoint by sending probe requests|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Measure‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md)** |Returns statistics on the web object|SharePoint Online, SharePoint 2016 - - -### Document Sets -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Remove‑PnPContentTypeFromDocumentSet](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md)** |Removes a content type from a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPContentTypeToDocumentSet](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md)** |Adds a content type to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPDocumentSet](../../sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md)** |Creates a new document set in a library.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPDocumentSetField](../../sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md)** |Sets a site column from the available content types to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPDocumentSetTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md)** |Retrieves a document set template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Event Receivers -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md)** |Adds a new remote event receiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md)** |Return registered eventreceivers|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md)** |Remove an eventreceiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Features -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New‑PnPExtensibilityHandlerObject](../../sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md)** |Creates an ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate cmdlet|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Disable‑PnPFeature](../../sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md)** |Disables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Enable‑PnPFeature](../../sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md)** |Enables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPFeature](../../sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md)** |Returns all activated or a specific activated feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Fields -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPField](../../sharepoint-ps/sharepoint-pnp/Add-PnPField.md)** |Add a field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPField](../../sharepoint-ps/sharepoint-pnp/Get-PnPField.md)** |Returns a field from a list or site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPField](../../sharepoint-ps/sharepoint-pnp/Remove-PnPField.md)** |Removes a field from a list or a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPField](../../sharepoint-ps/sharepoint-pnp/Set-PnPField.md)** |Changes one or more properties of a field in a specific list or for the whole web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPFieldFromXml](../../sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md)** |Adds a field to a list or as a site column based upon a CAML/XML field definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPTaxonomyField](../../sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md)** |Add a taxonomy field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPView](../../sharepoint-ps/sharepoint-pnp/Set-PnPView.md)** |Change view properties|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Files and Folders -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Add-PnPFile.md)** |Uploads a file to Web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Copy‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md)** |Copies a file or folder to a different location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Find‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Find-PnPFile.md)** |Finds a file in the virtual file system of the web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Get-PnPFile.md)** |Downloads a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Move‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Move-PnPFile.md)** |Moves a file to a different location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md)** |Removes a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Rename‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md)** |Renames a file in its current location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPFileCheckedIn](../../sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md)** |Checks in a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPFileCheckedOut](../../sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md)** |Checks out a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md)** |Creates a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md)** |Return a folder object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Move‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md)** |Move a folder to another location in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md)** |Deletes a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Rename‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md)** |Renames a folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Resolve‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md)** |Returns a folder from a given site relative path, and will create it if it does not exist.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPFolderItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md)** |List content in folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Copy‑PnPItemProxy](../../sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md)** |Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Move‑PnPItemProxy](../../sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md)** |Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Information Management -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md)** |Gets the label/tag of the specified list or library (if applicable)|SharePoint Online -**[Set‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md)** |Sets a label/tag on the specified list or library|SharePoint Online -**[Get‑PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md)** |Opens or closes a site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPSitePolicy](../../sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md)** |Sets a site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPSitePolicy](../../sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md)** |Retrieves all or a specific site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Lists -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md)** |Gets the default column values for all folders in document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md)** |Sets default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPList](../../sharepoint-ps/sharepoint-pnp/Get-PnPList.md)** |Returns a List object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPList](../../sharepoint-ps/sharepoint-pnp/New-PnPList.md)** |Creates a new list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPList](../../sharepoint-ps/sharepoint-pnp/Remove-PnPList.md)** |Deletes a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPList](../../sharepoint-ps/sharepoint-pnp/Set-PnPList.md)** |Updates list settings|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md)** |Adds an item to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md)** |Retrieves list items|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md)** |Deletes an item from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md)** |Updates a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPListItemPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md)** |Sets list item permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Move‑PnPListItemToRecycleBin](../../sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md)** |Moves an item from a list to the Recycle Bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPListPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md)** |Sets list permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPProvisioningTemplateFromGallery](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplateFromGallery.md)** |Retrieves or searches provisioning templates from the PnP Template Gallery|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Request‑PnPReIndexList](../../sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md)** |Marks the list for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPView](../../sharepoint-ps/sharepoint-pnp/Add-PnPView.md)** |Adds a view to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPView](../../sharepoint-ps/sharepoint-pnp/Get-PnPView.md)** |Returns one or all views from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPView](../../sharepoint-ps/sharepoint-pnp/Remove-PnPView.md)** |Deletes a view from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Microsoft Graph -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Connect‑PnPMicrosoftGraph](../../sharepoint-ps/sharepoint-pnp/Connect-PnPMicrosoftGraph.md)** |Connect to the Microsoft Graph|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md)** |Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Disable‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md)** |Disables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Enable‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md)** |Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Get‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md)** |Returns the defined Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Remove‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md)** |Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph|SharePoint Online -**[Update‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md)** |Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Get‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md)** |Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups|SharePoint Online -**[New‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md)** |Creates a new Office 365 Group (aka Unified Group)|SharePoint Online -**[Remove‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md)** |Removes one Office 365 Group (aka Unified Group) or a list of Office 365 Groups|SharePoint Online -**[Set‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md)** |Sets Office 365 Group (aka Unified Group) properties|SharePoint Online -**[Get‑PnPUnifiedGroupMembers](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md)** |Gets members of a particular Office 365 Group (aka Unified Group)|SharePoint Online -**[Get‑PnPUnifiedGroupOwners](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md)** |Gets owners of a particular Office 365 Group (aka Unified Group)|SharePoint Online - - -### Provisioning -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPDataRowsToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md)** |Adds datarows to a list inside a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPFileFromProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md)** |Removes a file from a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPFileToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md)** |Adds a file to a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Convert‑PnPFolderToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md)** |Creates a pnp package file of an existing template xml, and includes all files in the current folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPListFoldersToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md)** |Adds folders to a list in a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md)** |Adds a PnP Provisioning Template object to a tenant template|SharePoint Online -**[Apply‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md)** |Applies a site template to a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Convert‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md)** |Converts a provisioning template to an other schema version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md)** |Generates a provisioning site template from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md)** |Creates a new provisioning template object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Read‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md)** |Loads/Reads a PnP file from the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Save‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md)** |Saves a PnP site template to the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPProvisioningTemplateFromFolder](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md)** |Generates a provisioning template from a given folder, including only files that are present in that folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPProvisioningTemplateMetadata](../../sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md)** |Sets metadata of a provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md)** |Adds a tenant sequence object to a tenant template|SharePoint Online -**[Get‑PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md)** |Returns one ore more provisioning sequence object(s) from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md)** |Creates a new tenant sequence object|SharePoint Online -**[New‑PnPTenantSequenceCommunicationSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md)** |Creates a communication site object|SharePoint Online -**[Add‑PnPTenantSequenceSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md)** |Adds a existing tenant sequence site object to a tenant template|SharePoint Online -**[Get‑PnPTenantSequenceSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md)** |Returns one ore more sites from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPTenantSequenceSubSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md)** |Adds a tenant sequence sub site object to a tenant sequence site object|SharePoint Online -**[New‑PnPTenantSequenceTeamNoGroupSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md)** |Creates a new team site without an Office 365 group in-memory object|SharePoint Online -**[New‑PnPTenantSequenceTeamNoGroupSubSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md)** |Creates a team site subsite with no Office 365 group object|SharePoint Online -**[New‑PnPTenantSequenceTeamSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md)** |Creates a team site object|SharePoint Online -**[Apply‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md)** |Applies a tenant template to the current tenant.|SharePoint Online -**[New‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md)** |Creates a new tenant template object|SharePoint Online -**[Read‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md)** |Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template.|SharePoint Online -**[Save‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md)** |Saves a PnP provisioning hierarchy to the file system|SharePoint Online -**[Test‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md)** |Tests a provisioning hierarchy for invalid references|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Publishing -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Set‑PnPAvailablePageLayouts](../../sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md)** |Sets the available page layouts for the current site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPDefaultPageLayout](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md)** |Sets a specific page layout to be the default page layout for a publishing site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPHtmlPublishingPageLayout](../../sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md)** |Adds a HTML based publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md)** |Adds a Masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md)** |Adds an Image Rendition if the Name of the Image Rendition does not already exist. This prevents creating two Image Renditions that share the same name.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md)** |Returns all image renditions or if Identity is specified a specific one|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md)** |Removes an existing image rendition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPPublishingPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md)** |Adds a publishing page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPPublishingPageLayout](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md)** |Adds a publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPWikiPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md)** |Adds a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPWikiPage](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md)** |Removes a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWikiPageContent](../../sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md)** |Gets the contents/source of a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPWikiPageContent](../../sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md)** |Sets the contents of a wikipage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Records Management -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPInPlaceRecordsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md)** |Returns if the place records management feature is enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPInPlaceRecordsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md)** |Activates or deactivates in the place records management feature.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Disable‑PnPInPlaceRecordsManagementForSite](../../sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md)** |Disables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Enable‑PnPInPlaceRecordsManagementForSite](../../sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md)** |Enables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Clear‑PnPListItemAsRecord](../../sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md)** |Undeclares a list item as a record|SharePoint Online -**[Set‑PnPListItemAsRecord](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md)** |Declares a list item as a record|SharePoint Online -**[Test‑PnPListItemIsRecord](../../sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md)** |Checks if a list item is a record|SharePoint Online -**[Get‑PnPListRecordDeclaration](../../sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md)** |Returns the manual record declaration settings for a list|SharePoint Online -**[Set‑PnPListRecordDeclaration](../../sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md)** |The RecordDeclaration parameter supports 4 values: AlwaysAllowManualDeclaration NeverAllowManualDeclaration UseSiteCollectionDefaults |SharePoint Online - - -### Search -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md)** |Returns the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md)** |Sets the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPSearchCrawlLog](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md)** |Returns entries from the SharePoint search crawl log|SharePoint Online -**[Submit‑PnPSearchQuery](../../sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md)** |Executes an arbitrary search query against the SharePoint search index|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPSiteSearchQueryResults](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md)** |Executes a search query to retrieve indexed site collections|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### SharePoint Recycle Bin -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Clear‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Clear-PnPRecycleBinItem.md)** |Permanently deletes all or a specific recycle bin item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md)** |Returns the items in the recycle bin from the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Move‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Move-PnPRecycleBinItem.md)** |Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin|SharePoint Online -**[Restore‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Restore-PnPRecycleBinItem.md)** |Restores the provided recycle bin item to its original location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md)** |Returns all modern and classic site collections in the tenant scoped recycle bin|SharePoint Online - - -### SharePoint WebHooks -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md)** |Adds a new Webhook subscription|SharePoint Online -**[Remove‑PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md)** |Removes a Webhook subscription from the resource|SharePoint Online -**[Set‑PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md)** |Updates a Webhook subscription|SharePoint Online -**[Get‑PnPWebhookSubscriptions](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md)** |Gets all the Webhook subscriptions of the resource|SharePoint Online - - -### Sites -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Set‑PnPAppSideLoading](../../sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md)** |Enables the App SideLoading Feature on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPAuditing](../../sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md)** |Get the Auditing setting of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPAuditing](../../sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md)** |Set Auditing setting for a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Test‑PnPOffice365GroupAliasIsUsed](../../sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md)** |Tests if a given alias is already used used|SharePoint Online -**[Add‑PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md)** |Adds a Role Defintion (Permission Level) to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md)** |Retrieves a Role Definitions of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md)** |Remove a Role Definition from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPSite.md)** |Returns the current site collection from the context.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPSite.md)** |Sets Site Collection properties.|SharePoint Online -**[Add‑PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md)** |Adds one or more users as site collection administrators to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md)** |Returns the current site collection administrators of the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md)** |Removes one or more users as site collection administrators from the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Install‑PnPSolution](../../sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md)** |Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Uninstall‑PnPSolution](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md)** |Uninstalls a sandboxed solution from a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Taxonomy -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPSiteCollectionTermStore](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md)** |Returns the site collection term store|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Export‑PnPTaxonomy](../../sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md)** |Exports a taxonomy to either the output or to a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Import‑PnPTaxonomy](../../sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md)** |Imports a taxonomy from either a string array or a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPTaxonomyFieldValue](../../sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md)** |Sets a taxonomy term value in a listitem field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTaxonomyItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md)** |Returns a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPTaxonomyItem](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md)** |Removes a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTaxonomySession](../../sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md)** |Returns a taxonomy session|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTerm](../../sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md)** |Returns a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPTerm](../../sharepoint-ps/sharepoint-pnp/New-PnPTerm.md)** |Creates a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md)** |Returns a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md)** |Creates a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md)** |Removes a taxonomy term group and all its containing termsets|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Import‑PnPTermGroupFromXml](../../sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md)** |Imports a taxonomy TermGroup from either the input or from an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Export‑PnPTermGroupToXml](../../sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md)** |Exports a taxonomy TermGroup to either the output or to an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPTermSet](../../sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md)** |Returns a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Import‑PnPTermSet](../../sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md)** |Imports a taxonomy term set from a file in the standard format.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPTermSet](../../sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md)** |Creates a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Tenant Administration -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md)** |Returns the current OAuth Access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPHideDefaultThemes](../../sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md)** |Returns if the default / OOTB themes should be visible to users or not.|SharePoint Online -**[Set‑PnPHideDefaultThemes](../../sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md)** |Defines if the default / OOTB themes should be visible to users or not.|SharePoint Online -**[Get‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md)** |Retrieve all or a specific hubsite.|SharePoint Online -**[Register‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md)** |Registers a site as a hubsite|SharePoint Online -**[Set‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md)** |Sets hubsite properties|SharePoint Online -**[Unregister‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md)** |Unregisters a site as a hubsite|SharePoint Online -**[Add‑PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md)** |Connects a site to a hubsite.|SharePoint Online -**[Remove‑PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md)** |Disconnects a site from a hubsite.|SharePoint Online -**[Grant‑PnPHubSiteRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md)** |Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online -**[Add‑PnPOffice365GroupToSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md)** |Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group|SharePoint Online -**[Disable‑PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md)** |Disables PnP PowerShell telemetry tracking|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Enable‑PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md)** |Enables PnP PowerShell telemetry tracking.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPPowerShellTelemetryEnabled](../../sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md)** |Returns true if the PnP PowerShell Telemetry has been enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPSite](../../sharepoint-ps/sharepoint-pnp/New-PnPSite.md)** |Creates a new site collection|SharePoint Online -**[Add‑PnPSiteCollectionAppCatalog](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md)** |Adds a Site Collection scoped App Catalog to a site|SharePoint Online -**[Remove‑PnPSiteCollectionAppCatalog](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md)** |Removes a Site Collection scoped App Catalog from a site|SharePoint Online -**[Add‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md)** |Creates a new Site Design on the current tenant.|SharePoint Online -**[Get‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md)** |Retrieve Site Designs that have been registered on the current tenant.|SharePoint Online -**[Invoke‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md)** |Apply a Site Design to an existing site. * Requires Tenant Administration Rights *|SharePoint Online -**[Remove‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md)** |Removes a Site Design|SharePoint Online -**[Set‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md)** |Updates a Site Design on the current tenant.|SharePoint Online -**[Get‑PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md)** |Returns the principals with design rights on a specific Site Design|SharePoint Online -**[Grant‑PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md)** |Grants the specified principals rights to use the site design.|SharePoint Online -**[Revoke‑PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md)** |Revokes the specified principals rights to use the site design.|SharePoint Online -**[Add‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md)** |Creates a new Site Script on the current tenant.|SharePoint Online -**[Get‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md)** |Retrieve Site Scripts that have been registered on the current tenant.|SharePoint Online -**[Remove‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md)** |Removes a Site Script|SharePoint Online -**[Set‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md)** |Updates an existing Site Script on the current tenant.|SharePoint Online -**[Get‑PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md)** |Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.|SharePoint Online -**[Remove‑PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md)** |Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog|SharePoint Online -**[Set‑PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md)** |Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.|SharePoint Online -**[Get‑PnPTenant](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md)** |Returns organization-level site collection properties|SharePoint Online -**[Set‑PnPTenant](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md)** |Sets organization-level site collection properties|SharePoint Online -**[Get‑PnPTenantAppCatalogUrl](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md)** |Retrieves the url of the tenant scoped app catalog.|SharePoint Online -**[Get‑PnPTenantCdnEnabled](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md)** |Retrieves if the Office 365 Content Delivery Network has been enabled.|SharePoint Online -**[Set‑PnPTenantCdnEnabled](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md)** |Enables or disabled the public or private Office 365 Content Delivery Network (CDN).|SharePoint Online -**[Add‑PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md)** |Adds a new origin to the public or private content delivery network (CDN).|SharePoint Online -**[Get‑PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md)** |Returns the current registered origins from the public or private content delivery network (CDN).|SharePoint Online -**[Remove‑PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md)** |Removes an origin from the Public or Private content delivery network (CDN).|SharePoint Online -**[Get‑PnPTenantCdnPolicies](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md)** |Returns the CDN Policies for the specified CDN (Public | Private).|SharePoint Online -**[Set‑PnPTenantCdnPolicy](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md)** |Sets the CDN Policies for the specified CDN (Public | Private).|SharePoint Online -**[Clear‑PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md)** |Permanently deletes a site collection from the tenant scoped recycle bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Restore‑PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md)** |Restores a site collection from the tenant scoped recycle bin|SharePoint Online -**[Disable‑PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md)** |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online -**[Enable‑PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md)** |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online -**[Get‑PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md)** |Returns the current tenant's "SharePoint Online Client" service principal.|SharePoint Online -**[Revoke‑PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md)** |Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.|SharePoint Online -**[Get‑PnPTenantServicePrincipalPermissionGrants](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md)** |Gets the collection of permission grants for the "SharePoint Online Client" service principal|SharePoint Online -**[Approve‑PnPTenantServicePrincipalPermissionRequest](../../sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md)** |Approves a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online -**[Deny‑PnPTenantServicePrincipalPermissionRequest](../../sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md)** |Denies a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online -**[Get‑PnPTenantServicePrincipalPermissionRequests](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md)** |Gets the collection of permission requests for the "SharePoint Online Client" service principal|SharePoint Online -**[Get‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md)** |Retrieve site information.|SharePoint Online -**[New‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md)** |Creates a new site collection for the current tenant|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md)** |Removes a site collection|SharePoint Online -**[Set‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md)** |Set site information.|SharePoint Online -**[Add‑PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md)** |Adds or updates a theme to the tenant.|SharePoint Online -**[Get‑PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md)** |Returns all or a specific theme|SharePoint Online -**[Remove‑PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md)** |Removes a theme|SharePoint Online -**[Get‑PnPTimeZoneId](../../sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md)** |Returns a time zone ID|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWebTemplates](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md)** |Returns the available web templates.|SharePoint Online - - -### User and group management -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md)** |Returns a specific SharePoint group or all SharePoint groups in site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPGroup.md)** |Adds group to the Site Groups List and returns a group object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md)** |Removes a group from a web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md)** |Updates a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPGroupMembers](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md)** |Retrieves all members of a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPGroupPermissions](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md)** |Returns the permissions for a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPGroupPermissions](../../sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md)** |Adds and/or removes permissions of a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPUser](../../sharepoint-ps/sharepoint-pnp/Get-PnPUser.md)** |Returns site users of current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPUser](../../sharepoint-ps/sharepoint-pnp/New-PnPUser.md)** |Adds a user to the built-in Site User Info List and returns a user object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPUser](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md)** |Removes a specific user from the site collection User Information List|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPUserFromGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md)** |Removes a user from a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPUserToGroup](../../sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md)** |Adds a user to a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### User Profiles -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New‑PnPPersonalSite](../../sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md)** |Office365 only: Creates a personal / OneDrive For Business site|SharePoint Online -**[New‑PnPUPABulkImportJob](../../sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md)** |Submit up a new user profile bulk import job.|SharePoint Online -**[Get‑PnPUPABulkImportStatus](../../sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md)** |Get user profile bulk import status.|SharePoint Online -**[Get‑PnPUserProfileProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md)** |You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. |SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPUserProfileProperty](../../sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md)** |Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. |SharePoint Online - - -### Utilities -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Send‑PnPMail](../../sharepoint-ps/sharepoint-pnp/Send-PnPMail.md)** |Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Web Parts -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get‑PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md)** |Retrieve one or more Client-Side components from a page|SharePoint Online -**[Remove‑PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md)** |Removes a Client-Side component from a page|SharePoint Online -**[Set‑PnPClientSideText](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md)** |Set Client-Side Text Component properties|SharePoint Online -**[Set‑PnPClientSideWebPart](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md)** |Set Client-Side Web Part properties|SharePoint Online -**[Get‑PnPWebPart](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md)** |Returns a webpart definition object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPWebPart](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md)** |Removes a webpart from a page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWebPartProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md)** |Returns a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPWebPartProperty](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md)** |Sets a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPWebPartToWebPartPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md)** |Adds a webpart to a web part page in a specified zone|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPWebPartToWikiPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md)** |Adds a webpart to a wiki page in a specified table row and column|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWebPartXml](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md)** |Returns the webpart XML of a webpart registered on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Webs -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Set‑PnPIndexedProperties](../../sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md)** |Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPIndexedProperty](../../sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md)** |Marks the value of the propertybag key specified to be indexed by search.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPIndexedProperty](../../sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md)** |Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPIndexedPropertyKeys](../../sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md)** |Returns the keys of the property bag values that have been marked for indexing by search|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPPropertyBag](../../sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md)** |Returns the property bag values.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPPropertyBagValue](../../sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md)** |Removes a value from the property bag|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPPropertyBagValue](../../sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md)** |Sets a property bag value|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Request‑PnPReIndexWeb](../../sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md)** |Marks the web for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPRequestAccessEmails](../../sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md)** |Returns the request access e-mail addresses|SharePoint Online -**[Set‑PnPRequestAccessEmails](../../sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md)** |Sets Request Access Emails on a web|SharePoint Online -**[Get‑PnPSubWebs](../../sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md)** |Returns the subwebs of the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md)** |Returns the current web object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[New‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/New-PnPWeb.md)** |Creates a new subweb under the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md)** |Removes a subweb in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md)** |Sets properties on a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Invoke‑PnPWebAction](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md)** |Executes operations on web, lists and list items.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Set‑PnPWebPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md)** |Set permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -### Workflows -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add‑PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md)** |Adds a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md)** |Returns a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md)** |Removes a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md)** |Get workflow instances|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Resume‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md)** |Resume a workflow|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Start‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md)** |Starts a workflow instance on a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Stop‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md)** |Stops a workflow instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Add‑PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md)** |Adds a workflow subscription to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Get‑PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md)** |Return a workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -**[Remove‑PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md)** |Remove workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online - - -## Additional resources -<a name="bk_addresources"> </a> - -- [SharePoint PnP PowerShell on GitHub](https://github.com/SharePoint/PnP-PowerShell) diff --git a/sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md deleted file mode 100644 index 40ce4e7841..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md +++ /dev/null @@ -1,38 +0,0 @@ -#SharePoint Server Cmdlets - -For a listing of the SharePoint Server cmdlets, see [SharePoint Server cmdlets](../../sharepoint-ps/sharepoint-server/sharepoint-server.md) - -## Accessing PowerShell for SharePoint Server ## - -After you install SharePoint Server, applicable PowerShell cmdlets are available in the SharePoint 2016 Management Shell. You can manage most aspects of SharePoint Server in the SharePoint Management Shell. You can create new site collections, web applications, user accounts, service applications, proxies, and more. Commands that you type in the SharePoint Management Shell return SharePoint objects that are based on the Microsoft .NET Framework. You can apply these objects as input to subsequent commands or store the objects in local variables for later use. - -With the SharePoint Management Shell, you do not have to register the snap-in that contains the cmdlets. Registration of the Microsoft.SharePoint.PowerShell.dll module for SharePoint Server cmdlets is automatic, as a result of the **Add-PSSnapin Microsoft.SharePoint.PowerShell** line in the SharePoint.ps1 file that is located in %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\<version>\Config\PowerShell\Registration, where version "15" equals SharePoint Server 2013, and version "16" equals SharePoint Server 2016. To use the PowerShell console, you must register this snap-in manually. - -Whether you use the SharePoint Management Shell or the PowerShell console, you can also load additional snap-ins. For more information, see [Customizing Profiles](https://technet.microsoft.com/en-us/library/2008.10.windowspowershell.aspx). - -**NOTE:** The SharePoint Management Shell and the PowerShell console also differ in the use of the **ReuseThread** option, which defines how the threading model is used. The SharePoint Management Shell's use is defined by this line, {Host.Runspace.ThreadOptions = "ReuseThread"}, which is in the SharePoint.ps1 file. For more information, see [PS Thread Options](https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.runspaces.psthreadoptions?redirectedfrom=MSDN&view=powershellsdk-1.1.0). - -## Permissions ## - -Before you can use the Add-SPShellAdmin cmdlet to grant permissions for users to run SharePoint Server cmdlets, verify that you meet all of the following minimum requirements: - -* You must have membership in the **securityadmin** fixed server role on the SQL Server instance. -* You must be a member of the Administrators group on the server on which you are running the PowerShell cmdlet. - -**NOTE:** If these permissions are not satisfied, contact your Setup administrator or SQL Server administrator to request these permissions. - -For additional information about PowerShell permissions, see [Add-SPShellAdmin](../../sharepoint-ps/sharepoint-server/Add-SPShellAdmin.md). - -If you do not have membership in the **SharePoint_Shell_Access** role or **WSS_Admin_WPG** local group, use the **Add-SPShellAdmin** cmdlet to add the **WSS_Admin_WPG** group in all front-end web servers in the SharePoint farm and the **SharePoint_Shell_Access** role. If the SQL Server database does not have a **SharePoint_Shell_Access** role, the role is automatically created when you run the **Add-SPShellAdmin** cmdlet. After you run the **Add-SPShellAdmin** cmdlet, users can run SharePoint PowerShell cmdlets in a multiple-server farm environment. - -**NOTE:** When you install SharePoint Server, the user account from which you run the installation is granted the appropriate permissions to run PowerShell cmdlets. If any users have not been added to run a PowerShell cmdlet, you can use the **Add-SPShellAdmin** cmdlet to add them. - -To see a list of all of the **SPShellAdmin** cmdlets, from a PowerShell command prompt, type _Get-Command -Noun SPShellAdmin_. - -## Scripts and execution policies ## - -Although you can use Microsoft PowerShell to perform a single administrative task, you can also use a script to automate a series of tasks. A script is a text file that contains one or more Microsoft PowerShell commands. Microsoft PowerShell scripts have a .ps1 file name extension. - -To run scripts, the minimum required execution policy for SharePoint Server is **RemoteSigned**, although the default policy for PowerShell is Restricted. If the policy is left as Restricted, the SharePoint Management Shell will change the policy for PowerShell to RemoteSigned. This means that you must select **Run as administrator** to start the SharePoint Management Shell with elevated administrative permission. This change will apply to all PowerShell sessions. For more information, see [ExecutionPolicy Enumeration](https://docs.microsoft.com/en-us/dotnet/api/microsoft.powershell.executionpolicy?redirectedfrom=MSDN&view=powershellsdk-1.1.0). - -For additional information about scripts and execution policies, see [about_scripts](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_scripts?view=powershell-5.1&viewFallbackFrom=powershell-Microsoft.PowerShell.Core) and  [about_execution_policies](https://technet.microsoft.com/library/dd347641.aspx). diff --git a/sharepoint/docs-conceptual/toc.yml b/sharepoint/docs-conceptual/toc.yml deleted file mode 100644 index 0b5c9f02fe..0000000000 --- a/sharepoint/docs-conceptual/toc.yml +++ /dev/null @@ -1,14 +0,0 @@ -- name: Home - href: index.md - items: - - name: Overview - href: overview.md - - name: SharePoint Online Cmdlets - href: sharepoint-online/introduction-sharepoint-online-management-shell.md - items: - - name: Connect to SharePoint Online - href: sharepoint-online/connect-sharepoint-online.md - - name: SharePoint Server Cmdlets - href: sharepoint-server/sharepoint-server-cmdlets.md - - name: SharePoint PnP Cmdlets - href: sharepoint-pnp/sharepoint-pnp-cmdlets.md diff --git a/sharepoint/mapping/monikerMapping.json b/sharepoint/mapping/monikerMapping.json deleted file mode 100644 index f6808a117f..0000000000 --- a/sharepoint/mapping/monikerMapping.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "sharepoint-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/sharepoint/sharepoint-ps/toc.json", - "referenceTocUrl": "/powershell/module/sharepoint-ps/toc.json", - "packageRoot": "sharepoint-ps", - "modules": { - "sharepoint-online": {}, - "sharepoint-server": {}, - "sharepoint-pnp": {} - } - } -} \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md deleted file mode 100644 index 514062d356..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOGeoAdministrator -schema: 2.0.0 ---- - -# Add-SPOGeoAdministrator - -## SYNOPSIS - -Adds a new SharePoint user or security Group as GeoAdministrator of the current Multi-Geo Tenant. - - -## SYNTAX - -```powershell -Add-SPOGeoAdministrator - -UserPrincipalName <string> - -GroupAlias <string> - -ObjectId <guid> - [<CommonParameters>] -``` - -## DESCRIPTION -This Cmdlet requires a connection to a multi-geo tenant to run correctly. You must be a SharePoint Online global Administrator to run this script and allows you to add a user or group in the SharePoint Tenant as GeoAdministrator - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-SPOGeoAdministrator -UserPrincipalName admin@contoso.onmicrosoft.com -``` -Add a user as admin to the SharePoint Online multi-geo tenant - - -## PARAMETERS - -### -GroupAlias -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: Group -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -PARAMVALUE: Guid - - -```yaml -Type: Guid -Parameter Sets: ObjectId -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -UserPrincipalName -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: User -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) - -[Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) - - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md deleted file mode 100644 index f8e7592a41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md +++ /dev/null @@ -1,72 +0,0 @@ - --- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOHubSiteAssociation -schema: 2.0.0 ---- - -# Add-SPOHubSiteAssociation - -## SYNOPSIS -Associates a site with a hub site. - -## SYNTAX - -``` -Add-SPOHubSiteAssociation [-Site] <SpoSitePipeBind> -HubSite <SpoHubSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to associate a site with a hub site. - -## EXAMPLES - -### Example 1 - -``` -Add-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research -HubSite https://contoso.sharepoint.com/sites/Marketing -``` - -This example associates the research site with the marketing hub site. - -## PARAMETERS - -### -Site - -URL of the site to join to the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HubSite - -URL of the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## NOTES - -If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error. - -If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md deleted file mode 100644 index b90daa2e1f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOSiteDesign -schema: 2.0.0 ---- - -# Add-SPOSiteDesign - -## SYNOPSIS - -Creates a new site design available to users when they create a new site from the SharePoint home page. - -## SYNTAX - -```powershell -Add-SPOSiteDesign - -Title <string> - -WebTemplate <string> - -SiteScripts <SPOSiteScriptPipeBind[]> - [-Description <string>] - [-PreviewImageUrl <string>] - [-PreviewImageAltText <string>] - [-IsDefault] - [<CommonParameters>] -``` - -## DESCRIPTION - -Creates a new site design available to users when they create a new site from the SharePoint home page. - -## EXAMPLES - -### Example 1 - -This example creates a new site design. - -```powershell -Add-SPOSiteDesign ` - -Title "Contoso customer tracking" ` - -WebTemplate "64" ` - -SiteScripts "<ID>" ` - -Description "Tracks key customer data in a list" ` - -PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" ` - -PreviewImageAltText "site preview" -``` - -## PARAMETERS - -### -Title -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebTemplate -Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteScripts -An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. - -```yaml -Type: SPOSiteScriptPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The display description of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageUrl -The URL of a preview image. If none is specified, SharePoint uses a generic image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageAltText -The alt text description of the image for accessibility. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md deleted file mode 100644 index 9ac39f180f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOSiteDesignTask -schema: 2.0.0 ---- - -# Add-SPOSiteDesignTask - -## SYNOPSIS - -Similar to Invoke-SPOSiteDesign, this command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-SPOSiteDesign is limited to 30 actions and subactions). - -The supported site templates you can apply a site design to include: “modern” team site (with O365 group), “modern” team site (without an O365 group); communication site; classic team site; and classic publishing site. - -## SYNTAX - -```powershell -Add-SPOSiteDesignTask - -SiteDesignId <guid> - -WebUrl <string> - [<CommonParameters>] -``` - -## DESCRIPTION - -This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-SPOSiteDesign is limited to 30 actions and subactions). - -This command is intended to replace Invoke-SPOSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts. - -> [!NOTE] -> This command only creates the request. To check on the job status or to view details of the scheduled run, use the commands in the related section below. - -## EXAMPLES - -### Example 1 - -This example applies a site design that includes two site scripts - totaling over 30 site script actions. Executing the commands will schedule the site design to be queued and run against the designated site collection. - -```powershell -Add-SPOSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome%E2%80%9D-%60%60%60--##%20PARAMETERS--###%20-SiteDesignId--The%20ID%20of%20the%20site%20design%20to%20apply.--%60%60%60yaml-Type:%20SPOSiteDesignPipeBind-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online-Required:%20True%20-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False%20%20-%60%60%60--###%20-WebUrl-The%20URL%20of%20the%20site%20collection%20where%20the%20site%20design%20will%20be%20applied.--%60%60%60yaml-Type:%20String-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online-Required:%20True%20-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False%20%20-%60%60%60--##%20INPUTS--##%20OUTPUTS--##%20NOTES--##%20RELATED%20LINKS--[Get-SPOSiteDesignTask](https://docs.microsoft.com/en-us/powershell/module/sharepoint-online/get-spositedesigntask?view=sharepoint-ps)--[Invoke-SPOSiteDesign](https://docs.microsoft.com/en-us/powershell/module/sharepoint-online/invoke-spositedesign?view=sharepoint-ps)diff%20--git%20a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md%20b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.mddeleted%20file%20mode%20100644index%20f312f970b1..0000000000---%20a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md+++%20/dev/null@@%20-1,134%20+0,0%20@@-----external%20help%20file:%20sharepointonline.xml-applicable:%20SharePoint%20Online-title:%20Add-SPOSiteScript-schema:%202.0.0------#%20Add-SPOSiteScript--##%20SYNOPSIS--Uploads%20a%20new%20site%20script%20for%20use%20either%20directly%20or%20in%20a%20site%20design.--##%20SYNTAX--%60%60%60powershell-Add-SPOSiteScript-%20%20-Title%20%3Cstring%3E-%20%20-Content%20%3Cstring%3E-%20%20[-Description%20%3Cstring%3E]-%20%20[%3CCommonParameters%3E]-%60%60%60--##%20DESCRIPTION--Uploads%20a%20new%20site%20script%20for%20use%20either%20directly%20or%20in%20a%20site%20design.--##%20EXAMPLES--###%20Example%201--This%20example%20adds%20a%20new%20site%20logo%20from%20the%20following%20script%20in%20a%20file.--%60%60%60json-{-"$schema": "schema.json", - "actions": [ - { - "verb": "setSiteLogo", - "url": "https://contoso.sharepoint.com/SiteAssets/company-logo.png" - } - ] -} -``` - -```powershell -Get-Content 'c:\scripts\site-script.json' -Raw | Add-SPOSiteScript -Title "Customer logo" -Description "Applies customer logo for customer sites" -``` - -### Example 2 - -This example sets the external sharing capabilities of the site to the ExternalUserAndGuestSharing option. We also add a site design for a Communication site (68) which uses this script. - -```powershell -PS C:\> $script = @' ->> { ->> "$schema": "schema.json", ->> "actions": [ ->> { ->> "verb": "setSiteExternalSharingCapability", ->> "capability": "ExternalUserAndGuestSharing" ->> } ->> ], ->> "bindata": { }, ->> "version": 1 ->> }; ->> '@ - -PS C:\> Add-SPOSiteScript -Title "External User and Guest Sharing site script" -Description "A site script to manage the -guest access of a site" -Content $script - -Id : ea9e3a52-7c12-4da8-a901-4912be8a76bc -Title : External User and Guest Sharing site script -Description : A site script to manage theguest access of a site -Content : -Version : 0 - -PS C:\> Add-SPOSiteDesign -Title "Communication Site with External Users and Guest Sharing" -WebTemplate "68" -SiteScripts "ea9e3a52-7c12-4da8-a901-4912be8a76bc" -``` - -## PARAMETERS - -### -Title -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Content -The JSON value that describes the script. For more information, see the [JSON reference](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -A description of the script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md deleted file mode 100644 index 6de695fac1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOTenantCdnOrigin -schema: 2.0.0 ---- - -# Add-SPOTenantCdnOrigin - -## SYNOPSIS - -Configures a new origin to public or private content delivery network (CDN). Requires Tenant administrator permissions. - -## SYNTAX - -``` -Add-SPOTenantCdnOrigin -CdnType <SPOTenantCdnType> [-Confirm] -OriginUrl <String> [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION - -Configures a new origin to public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library and requests that content in that library should be retrievable by using a CDN. - -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -## EXAMPLES - -### Example 1 - -``` -Add-SPOTenantCdnOrigin -CdnType public -OriginUrl /sites/site/subfolder -``` - -This example configures a public CDN on a site level. - - - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are: public or private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginUrl - -Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. - -Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md deleted file mode 100644 index ccd8e53022..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOTheme -schema: 2.0.0 ---- - -# Add-SPOTheme - -## SYNOPSIS - -Creates a new custom theme, or overwrites an existing theme to modify its settings. - -## SYNTAX - -``` -Add-SPOTheme - -Identity <SpoThemePipeBind> - -IsInverted <bool> - -Overwrite - -Palette <SpoThemePalettePipeBind> - [<CommonParameters>] -``` - -## DESCRIPTION - -The **Add-SPOTheme** cmdlet creates a new theme or updates an existing theme. The color palette settings can be passed as either a hash table or a dictionary. - -Adding a theme does not apply the theme to any sites. It adds the theme to your tenant store, and then the theme is available in the list of themes under the **Change the look** option for modern pages. - -## EXAMPLES - -### Example 1 - -In this example, a new theme named `"Custom Cyan"` is created, with color palette settings that are various shades of cyan. Note that the settings are passed as a hash table. - -```powershell -$themepalette = @{ - "themePrimary" = "#00ffff"; - "themeLighterAlt" = "#f3fcfc"; - "themeLighter" = "#daffff"; - "themeLight" = "#affefe"; - "themeTertiary" = "#76ffff"; - "themeSecondary" = "#39ffff"; - "themeDarkAlt" = "#00c4c4"; - "themeDark" = "#009090"; - "themeDarker" = "#005252"; - "neutralLighterAlt" = "#f8f8f8"; - "neutralLighter" = "#f4f4f4"; - "neutralLight" = "#eaeaea"; - "neutralQuaternaryAlt" = "#dadada"; - "neutralQuaternary" = "#d0d0d0"; - "neutralTertiaryAlt" = "#c8c8c8"; - "neutralTertiary" = "#a6a6a6"; - "neutralSecondaryAlt" = "#767676"; - "neutralSecondary" = "#666666"; - "neutralPrimary" = "#333"; - "neutralPrimaryAlt" = "#3c3c3c"; - "neutralDark" = "#212121"; - "black" = "#000000"; - "white" = "#fff"; - "primaryBackground" = "#fff"; - "primaryText" = "#333" - } - -Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false -``` - -> [!NOTE] -> Prior to the December 2017 release of the SPO Management Shell, the **Add-SPOTheme** cmdlet required that color palette settings be passed as a dictionary. We recommend that you use the latest version of the SPO Management Shell, or use the `HashToDictionary` function to convert a hash table to a dictionary if needed. - -### Example 2 - -If you want to update an existing theme (to modify some of its color settings, for example), use the same syntax as shown previously, but add the `-Overwrite` flag to the **Add-SPOTheme** cmdlet. - -```powershell -Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false -Overwrite -``` -## PARAMETERS - -### -Identity - -```yaml -Type: SpoThemePalettePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInverted - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: None -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: None -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Palette - -```yaml -Type: SpoThemePalettePipeBind -Parameter Sets: (All) -Aliases: None -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md deleted file mode 100644 index 3498329a54..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOUser -schema: 2.0.0 ---- - -# Add-SPOUser - -## SYNOPSIS -Adds an existing Office 365 user or an Office 365 security group to a SharePoint group. - -## SYNTAX - -``` -Add-SPOUser -Group <String> -LoginName <String> -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Along with the group memberships that are normally required to run Windows PowerShell, you must be a SharePoint Online global administrator and a site collection administrator to use the `Add-SPOUser` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Add-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@contoso.com -Group "SC1 Owners" -``` -Example 1 adds a user who has the e-mail address joe.healy@contoso.com to the group "SC1 Owners" in the site collection https://contoso.sharepoint.com/sites/sc1. - -### ------------ Example 2 -------------------- -``` -Add-SPOUser -Site https://contoso.sharepoint.com -LoginName melissa.kerr@contoso.com -Group "Team Site Members" -``` -Example 2 adds a user who has the e-mail address melissa.kerr@contoso.com to the group "Team Site Members" in the site collection https://contoso.sharepoint.com. - - -## PARAMETERS - -### -Group -Specifies the name of the SharePoint group to add the user or the security group to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName -Specifies the login name of the user to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the URL of the site collection to which you want to add the user. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - [Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[New-SPOSiteGroup](New-SPOSiteGroup.md) - -[Get-SPOUser](Get-SPOUser.md) - -[Set-SPOUser](Set-SPOUser.md) - -[Remove-SPOUser](Remove-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md b/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md deleted file mode 100644 index 1ee8fa6309..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Approve-SPOTenantServicePrincipalPermissionGrant - -## SYNOPSIS - -Approves a permission request for the current tenant's "SharePoint Online Client" service principal. - - -## SYNTAX - -### Default - -```powershell -Approve-SPOTenantServicePrincipalPermissionGrant -Resource <string> -Scope <string> -``` - -## DESCRIPTION - -Adds a permission for the current tenant's "SharePoint Online Client" service principal. Can be used to add needed permissions to the service principal without specifically requesting them in the SharePoint Framework solution file (sppkg). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell - Approve-SPOTenantServicePrincipalPermissionGrant -Resource "Microsoft Graph" -Scope "Mail.Read" -``` - -Adds a permission scope for the 'Microsoft Graph' resource with scope claim 'Mail.Read'. - -## PARAMETERS - -### -Resource - -Resource of the permission request to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope - -Scope of the permission request to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md deleted file mode 100644 index c4a8221da2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Approve-SPOTenantServicePrincipalPermissionRequest - -## SYNOPSIS - -Approves a permission request for the current tenant's "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Approve-SPOTenantServicePrincipalPermissionRequest -RequestId <Guid> -``` - -## DESCRIPTION - -Approves a permission request for the current tenant's "SharePoint Online Client" service principal - -The return value of a successful call is a permission grant object. See [the "Permission grant object" section of the -Get-SPOTenantServicePrincipalPermissionGrants help documentation](Get-SPOTenantServicePrincipalPermissionGrants.md) -for more information about a permission grant object. - -To get the collection of permission grants for the "SharePoint Online Client" service principal, use the -[Get-SPOTenantServicePrincipalPermissionGrants](Get-SPOTenantServicePrincipalPermissionGrants.md) command. - -Approving a permission request also removes that request from the list of permission requests. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -$requests = Get-SPOTenantServicePrincipalPermissionRequests -$requestToApprove = $requests | ? { $_.Resource -eq 'Office 365 SharePoint Online' -and $_.Scope -eq 'MyFiles.Read' } | Select-Object -First 1 - -if ($requestToApprove -ne $null) -{ - Approve-SPOTenantServicePrincipalPermissionRequest -RequestId $requestToApprove.Id -} -``` - -Approves the permission request for the 'Office 365 SharePoint Online' resource with scope claim 'MyFiles.Read'. -If there is no request with those properties, then no approve action will be taken. - -## PARAMETERS - -### -RequestId - -The ID of the permission request to approve - -```yaml -Type: Guid - -Required: True -Position: Named -Accept pipeline input: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md b/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md deleted file mode 100644 index 5cda84bdf6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Connect-SPOService -schema: 2.0.0 ---- - -# Connect-SPOService - -## SYNOPSIS - -Connects a SharePoint Online global administrator to a SharePoint Online connection (the SharePoint Online Administration Center). -This cmdlet must be run before any other SharePoint Online cmdlets can run. - - -## SYNTAX - -### AuthenticationUrl - -``` -Connect-SPOService -AuthenticationUrl <String> [-ClientTag <String>] [-Credential <CredentialCmdletPipeBind>] - -Url <UrlCmdletPipeBind> [<CommonParameters>] -``` - -### AuthenticationLocation - -``` -Connect-SPOService [-ClientTag <String>] [-Credential <CredentialCmdletPipeBind>] - [-Region <AADCrossTenantAuthenticationLocation>] -Url <UrlCmdletPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION - -The `Connect-SPOService` cmdlet connects a SharePoint Online global administrator to the SharePoint Online Administration Center. - -Only a single SharePoint Online service connection is maintained from any single Windows PowerShell session. -In other words, this is a per-organization administrator connection. -Running the `Connect-SPOService` cmdlet twice implicitly disconnects the previous connection. -The Windows PowerShell session will be set to serve the new SharePoint Online global administrator specified. - -A delegated partner administrator has to swap connections for different organizations within the same Windows PowerShell session. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -``` -Connect-SPOService -Url https://contoso-admin.sharepoint.com -credential admin@contoso.com -``` - -Example 1 shows how a SharePoint Online global administrator with credential admin@contoso.com connects to a SharePoint Online Administration Center that has the URL http://contoso-admin.sharepoint.com/. - - -### -----------------------EXAMPLE 2----------------------------- - -``` -$username = "admin@contoso.sharepoint.com" -$password = "password" -$cred = New-Object -TypeName System.Management.Automation.PSCredential -argumentlist $userName, $(convertto-securestring $Password -asplaintext -force) -Connect-SPOService -Url https://contoso-admin.sharepoint.com/ -Credential $cred -``` - -Example 2 shows how a SharePoint Online global administrator with a username and password connects to a SharePoint Online Administration Center that has the URL http://contoso-admin.sharepoint.com/. - - -## PARAMETERS - -### -AuthenticationUrl - -Location for AAD Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used. - -```yaml -Type: String -Parameter Sets: AuthenticationUrl -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTag - -Permits appending a client tag to existing client tag. Used optionally in the CSOM http traffic to identify used script or solution. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential - -Specifies the credentials to use to connect. If no credentials are presented, a dialog will prompt for the credentials. The credentials must be those of a SharePoint Online global administrator who can access the SharePoint Online Administration Center site. - - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Region - -The valid values are: Default | ITAR | Germany | China - -The default value is "default". - -> [!NOTE] -> The ITAR value is for United States Government cloud tenancies only. - - -```yaml -Type: AADCrossTenantAuthenticationLocation -Parameter Sets: AuthenticationLocation -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the URL of the SharePoint Online Administration Center site. - - -```yaml -Type: UrlCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Disconnect-SPOService](Disconnect-SPOService.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md b/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md deleted file mode 100644 index 190a8698be..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: ConvertTo-SPOMigrationEncryptedPackage -schema: 2.0.0 ---- - -# ConvertTo-SPOMigrationEncryptedPackage - -## SYNOPSIS -Use this Cmdlet to convert your XML files into a new encryted migration package. - -## SYNTAX - -### ImplicitSourceParameterSet -``` -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters <EncryptionParameters> - -MigrationSourceLocations <MigrationPackageLocation> [-NoLogFile] -TargetFilesPath <String> - -TargetPackagePath <String> [<CommonParameters>] -``` - -### ExplicitSourceParameterSet -``` -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters <EncryptionParameters> [-NoLogFile] - -SourceFilesPath <String> -SourcePackagePath <String> -TargetFilesPath <String> -TargetPackagePath <String> - [<CommonParameters>] -``` - -## DESCRIPTION -This command convert the XML file on your temprary XML folder files into a new set of targeted migration encrypted metadata files to the target directory. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters SHA256 - -MigrationSourceLocations $MigrationPackageLocation -NoLogFile -TargetFilesPath $TargetFilesPath - -TargetPackagePath $TargetPackagePath -``` - -Changes a migration package to a migration encrypted package on the "migrationSourceLocations" , with log file on the current tenant - -### Example 2 -```powershell -PS C:\> ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters SHA384 - -MigrationSourceLocations $MigrationPackageLocation -TargetFilesPath $TargetFilesPath - -TargetPackagePath $TargetPackagePath -``` - -Same as example1 but without log file and using an encription type SHA384 - -## PARAMETERS - -### -EncryptionParameters -Parameters of the encription, it doesn't accept wildcard caracters. -It accepts parameters like SHA384, SHA256, etc. - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSourceLocations -Posible Source locations to migrate - -```yaml -Type: MigrationPackageLocation -Parameter Sets: ImplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Switch Parameter to determine if you should get or not a log file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilesPath -Defines the temporary Path where are located the XML source files. - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath -Defines the source package path location. - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFilesPath -Defines the temporary Path where are located the XML source files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPackagePath -Defines the source package path location of the package to be encrypted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[ConvertTo-SPOMigrationTargetedPackage](ConvertTo-SPOMigrationTargetedPackage.md) -[Migrate to SharePoint Online using PowerShell](https://docs.microsoft.com/en-us/sharepointmigration/overview-spmt-ps-cmdlets) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md b/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md deleted file mode 100644 index ece9f651b9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: ConvertTo-SPOMigrationTargetedPackage -schema: 2.0.0 ---- - -# ConvertTo-SPOMigrationTargetedPackage - -## SYNOPSIS -Use this cmdlet to convert your XML files into a new migration package. - -## SYNTAX - -### DocumentLibraryImport -``` -ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] <String> [-SourcePackagePath] <String> - [[-OutputPackagePath] <String>] [-TargetWebUrl] <String> [-AzureADUserCredentials <CredentialCmdletPipeBind>] - -Credentials <CredentialCmdletPipeBind> [-NoAzureADLookup] [-NoLogFile] [-ParallelImport] - [-PartitionSizeInBytes <Int64>] -TargetDocumentLibraryPath <String> - [-TargetDocumentLibrarySubFolderPath <String>] [-TargetEnvironment <TargetEnvironment>] - [-UserMappingFile <String>] [<CommonParameters>] -``` - -### ListImport -``` -ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] <String> [-SourcePackagePath] <String> - [[-OutputPackagePath] <String>] [-TargetWebUrl] <String> [-AzureADUserCredentials <CredentialCmdletPipeBind>] - -Credentials <CredentialCmdletPipeBind> [-NoAzureADLookup] [-NoLogFile] [-ParallelImport] - [-PartitionSizeInBytes <Int64>] [-TargetEnvironment <TargetEnvironment>] -TargetListPath <String> - [-UserMappingFile <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use this Cmdlets to create a migration package from one Library to Another Library in form of a package. It converts the XML files and saves them as a new set of targeted migration package metadata files to the target directory. - - -## EXAMPLES - -### Example 1 -This example shows how to convert a package to a targeted one by looking up data in the target site collection. It uses the �ParallelImport parameter to boost file share migration performance. -```Powershell -$finalPackages = ConvertTo-SPOMigrationTargetedPackage -ParallelImport -SourceFilesPath $sourceFiles -SourcePackagePath $sourcePackage -OutputPackagePath $targetPackage -Credentials $cred -TargetWebUrl $targetWeb -TargetDocumentLibraryPath $targetDocLib -``` - - -## PARAMETERS - -### -AzureADUserCredentials -Receives Azure Active Directory User Credentials - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -Fill out the Regular Credentials (Get-Credential) - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoAzureADLookup -Switch parameter that says if the command should or should not look up for Azure AD. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Switch Parameter to determine if you should get or not a log file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPackagePath -Output package path - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParallelImport -Switch parameter to boost file share migration performance. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionSizeInBytes -Define the partition size in Bytes where it will be located the target package. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilesPath -Defines the temporary Path where are located the XML source files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath -Defines the source package path location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibraryPath -Defines the target document library path. - -```yaml -Type: String -Parameter Sets: DocumentLibraryImport -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibrarySubFolderPath -Defines the target document library subfolder path. - -```yaml -Type: String -Parameter Sets: DocumentLibraryImport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetEnvironment -Defines the Target environment: Production, ProductionChina, None or OnPremises. - -```yaml -Type: TargetEnvironment -Parameter Sets: (All) -Aliases: -Accepted values: Production, ProductionChina, None, OnPremises -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListPath -Defines the Target list path - -```yaml -Type: String -Parameter Sets: ListImport -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -Defines the Target Web URL of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserMappingFile -Defines the file mapping of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - - -[ConvertTo-SPOMigrationEncryptedPackage](ConvertTo-SPOMigrationEncryptedPackage.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md deleted file mode 100644 index 1cf08b259d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Deny-SPOTenantServicePrincipalPermissionRequest - -## SYNOPSIS - -Denies a permission request for the current tenant's "SharePoint Online Client" service principal - -## SYNTAX - -### Default -```powershell -Deny-SPOTenantServicePrincipalPermissionRequest -RequestId <Guid> -``` - -## DESCRIPTION -Denies a permission request for the current tenant's "SharePoint Online Client" service principal - -Denying a permission request removes that request from the list of permission requests. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$requests = Get-SPOTenantServicePrincipalPermissionRequests -$requestToDeny = $requests | ? { $_.Resource -eq 'Office 365 SharePoint Online' -and $_.Scope -eq 'MyFiles.Read' } | Select-Object -First 1 - -if ($requestToDeny -ne $null) -{ - Deny-SPOTenantServicePrincipalPermissionRequest -RequestId $requestToDeny.Id -} -``` - -Denies the permission request for the 'Office 365 SharePoint Online' resource with scope claim 'MyFiles.Read'. -If there is no request with those properties, then no deny action will be taken. - -## PARAMETERS - -### -RequestId -The ID of the permission request to deny - -```yaml -Type: Guid - -Required: True -Position: Named -Accept pipeline input: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md deleted file mode 100644 index e83e632c6e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Disable-SPOTenantServicePrincipal - -## SYNOPSIS - -Disables the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Disable-SPOTenantServicePrincipal -``` - -## DESCRIPTION -Disables the current tenant's "SharePoint Online Client" service principal. - -When the service principal's account is disabled, clients and components that use this service principal -will not be able to request an access token for this service principal. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Disable-SPOTenantServicePrincipal -``` - -Disables the current tenant's "SharePoint Online Client" service principal. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md b/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md deleted file mode 100644 index a2399432bf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Disconnect-SPOService -schema: 2.0.0 ---- - -# Disconnect-SPOService - -## SYNOPSIS -Disconnects from a SharePoint Online service. - - -## SYNTAX - -``` -Disconnect-SPOService [<CommonParameters>] -``` - -## DESCRIPTION -The `Disconnect-SPOService` cmdlet explicitly disconnects a previously created SharePoint Online service connection. - -Global administrators can disconnect the service by running the `Disconnect-SPOService` cmdlet or by running the `Connect-SPOService` cmdlet to initiate another connection. -For more information, see `Connect-SPOService`. - -Even after a connection is terminated, operations that were started before the connection is terminated will run to completion. -In other words, long-running operations will not be terminated by running the `Disconnect-SPOService` cmdlet or the `Connect-SPOService` cmdlet. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Disconnect-SPOService -``` -This example disconnects the service for the tenant. - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Connect-SPOService](Connect-SPOService.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md deleted file mode 100644 index 5b146ffc54..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Enable-SPOTenantServicePrincipal - -## SYNOPSIS - -Enables the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Enable-SPOTenantServicePrincipal -``` - -## DESCRIPTION -Enables the current tenant's "SharePoint Online Client" service principal. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Enable-SPOTenantServicePrincipal -``` - -Enables the current tenant's "SharePoint Online Client" service principal. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md b/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md deleted file mode 100644 index aac194a7fd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: microsoft.online.sharepoint.powershell -online version: -applicable: SharePoint Online -title: Export-SPOQueryLogs -schema: 2.0.0 ---- - - -# Export-SPOQueryLogs - -## SYNOPSIS -Export query logs for a user in an Office 365 tenant. - -## SYNTAX - -``` -Export-SPOQueryLogs [-StartTime <DateTime>] -LoginName <String> -OutputFolder <String> [<CommonParameters>] -``` - -## DESCRIPTION -Export the query logs for a user in an Office 365 tenant. The result of the export is stored in the current working folder or a specified folder, in the two files loginName_queries.csv and loginName_personalQueries.csv. - -The output of the queries.csv will be for example: - -| QueryTime | QueryText | -| ------------- | ------------- | -| 5/31/2018 09:16 | Querytext1 | -| 5/31/2018 08:16 | Querytext2 | - -You have to be a tenant admin to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Export-SPOQueryLogs -LoginName user1@contoso.sharepoint.com -``` -Example 1 exports the query log for a user who has the e-mail address user1@contoso.harepoint.com to the two files user1@contoso.sharepoint.com_queries.csv and user1@contoso.sharepoint.com_personalQueries.csv, in the current working folder. - - -### ------------ Example 2 -------------------- -``` -Export-SPOQueryLogs -LoginName user1@contoso.sharepoint.com -StartTime "2018-10-21" -OutputFolder "c:\users\contosoadmin\Documents" -``` -Example 2 exports the query log from the starting time 21. October 2018, for a user who has the e-mail address user1@contoso.sharepoint.com, to the two files user1@contoso.sharepoint.com_queries.csv and user1@contoso.sharepoint.com_personalQueries.csv, in the folder c:\users\contosoadmin\Documents. - -## PARAMETERS - -### -LoginName -Specifies the login name of the user to export. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFolder -Target folder where the CSV file is generated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies from which point of time to export the logs from. Use the date format YYYY-MM-DD. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps) - -[Set up the SharePoint Online Management Shell Windows PowerShell environment](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md deleted file mode 100644 index d78e02b3d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Export-SPOUserInfo -schema: 2.0.0 ---- - -# Export-SPOUserInfo - -## SYNOPSIS -Export user information from site user information list. - -## SYNTAX - -``` -Export-SPOUserInfo -LoginName <String> -Site <SpoSitePipeBind> -OutputFolder <String> [<CommonParameters>] -``` - -## DESCRIPTION -Export user information from site user information list. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Export-SPOUserInfo -LoginName joe.healy@contoso.com -site https://contoso.sharepoint.com/sites/sc1 -OutputFolder "C:\users\admin\exportfolder" -``` -Example 1 exports a user data who has the e-mail address joe.healy@contoso.com from the site collection https://contoso.sharepoint.com/sites/sc1 to folder C:\users\admin\exportfolder. - - -### ------------ Example 2 -------------------- -``` -$sites = Get-SPOSite -IncludePersonalSite $true -$user = "joe.healy@contoso.com" -foreach ($site in $sites) -{ -Export-SPOUserInfo -LoginName $user -site $site.Url -OutputFolder -"C:\users\admin\exportfolder" -} -``` -Example 2 exports user data who has email address joe.healy@contoso.com from all site collections to folder C:\users\admin\exportfolder. - -## PARAMETERS - -### -LoginName -Specifies the login name of the user to export. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the URL of the site collection to which you want to export the user. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFolder -Target folder where the CSV file is generated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[New-SPOSiteGroup](New-SPOSiteGroup.md) - -[Get-SPOUser](Get-SPOUser.md) - -[Set-SPOUser](Set-SPOUser.md) - -[Remove-SPOUser](Remove-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md b/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md deleted file mode 100644 index a01b8be360..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Export-SPOUserProfile -schema: 2.0.0 ---- - -# Export-SPOUserProfile - -## SYNOPSIS -Export user profile data to csv file. - -## SYNTAX - -``` -Export-SPOUserProfile -LoginName <String> -OutputFolder <String> [<CommonParameters>] -``` - -## DESCRIPTION -Export user profile data to csv file. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Export-SPOUserProfile -LoginName joe.healy@contoso.com -OutputFolder "C:\users\admin\exportfolder" -``` -Example 1 exports user data who has the e-mail address joe.healy@contoso.com to a folder "C:\users\admin\exportfolder". - -## PARAMETERS - -### -LoginName -Specifies the login name of the user who's data is exported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFolder -Specifies the output folder location where the CSV file is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Export-SPOUserInfo](Export-SPOUserInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md deleted file mode 100644 index 77c3fab815..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOAppErrors -schema: 2.0.0 ---- - -# Get-SPOAppErrors - -## SYNOPSIS -Returns application errors. - -## SYNTAX - -``` -Get-SPOAppErrors [-EndTimeInUtc <DateTime>] -ProductId <Guid> [-StartTimeInUtc <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPOAppErrors` cmdlet returns application monitoring errors (if available) for the application that is specified by ProductId between StartTimeInUtc in Coordinated Universal Time (UTC) and EndTimeInUtc in UTC. - -Based on server configuration, errors are available for a limited time. -The default is seven days. -Older errors are purged. -Date time values that are older than 50 years or later than 20 years from today are considered invalid - -Each error includes the error message, time in UTC that error happened, the site where the error happened, and the error type. -Values for error type are as follows: 0 - None, 1 - Install Error, 2 - Upgrade Error, 3 - Runtime Error. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Get-SPOAppErrors -ProductId ba51729b-e017-409d-681a-66f1dd18f0f4 -``` -This example returns a collection of monitoring error message(s) for application whose GUID is ba51729b-e017-409d-681a-66f1dd18f0f4. - - -## PARAMETERS - -### -EndTimeInUtc -Specifies the end time in UTC to search for monitoring errors. If no end time is given, the default value current time in UTC is used. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Specifies the application’s GUID. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTimeInUtc -Specifies the start time in UTC to search for monitoring errors — for example, 01032011:12:00. If no start time is given, the default value 72 hours before the current time is used. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppInfo](Get-SPOAppInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md deleted file mode 100644 index 7967fedc29..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOAppInfo -schema: 2.0.0 ---- - -# Get-SPOAppInfo - -## SYNOPSIS -Returns all installed applications. - -## SYNTAX - -``` -Get-SPOAppInfo [[-ProductId] <Guid>] [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPOAppInfo` cmdlet gets all the installed applications from an external marketplace or from the App Catalog that contain Name in their application names or the installed application with mentioned ProductId. ProductId takes precedence if not empty. - -Either ProductId or Name must be given. Name is ignored if ProductId is specified. - -The returned collection of installed applications contains Product ID (GUID), Product name and Source. Values for source type are as follows: 0 = App Catalog and 1 = Marketplace. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832. - - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Get-SPOAppInfo -Name "Excel Service" -``` -Example 1 returns all the installed applications from the external marketplace or from the App Catalog that contain "Excel Service" in their application names. - -### ------------ Example 2 -------------------- -``` -Get-SPOAppInfo -ProductId 6751729b-e017-409d-681a-66f1dd18f0ff -``` -Example 2 returns the installed application that has the GUID 6751729b-e017-409d-681a-66f1dd18f0ff. - -### ------------ Example 3 -------------------- -``` -Get-SPOAppInfo -Name " " | Sort Name -``` -Example 3 returns the installed application that have a space in the name and sorts the in ascending order. - -## PARAMETERS - -### -Name -Specifies the application’s name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Specifies the application’s GUID. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md deleted file mode 100644 index a1e034c796..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOCrossGeoMovedUsers -schema: 2.0.0 ---- - -# Get-SPOCrossGeoMovedUsers - -## SYNOPSIS -In a multi-geo tenant returns the SharePoint Online user (or users) that had been moved - - -## SYNTAX - -``` -Get-SPOCrossGeoMovedUsers -Direction <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet allows you to get the moved users out and in the current SPO Site - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOCrossGeoMovedUsers -Direction MoveIn -``` -Get the cross users that have been moved in the current SPO site - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOCrossGeoMovedUsers -Direction MoveOut -``` -Get the cross users that have been moved out the current SPO site - - -## PARAMETERS - -### -Direction -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: MoveIn, MoveOut -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md deleted file mode 100644 index 8990c872ae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOCrossGeoUsers -schema: 2.0.0 ---- - -# Get-SPOCrossGeoUsers - -## SYNOPSIS -In a multi-geo tenant returns the SharePoint Online user (or users) that matches the criteria - - -## SYNTAX - -```Powershell -Get-SPOCrossGeoUsers -ValidDataLocation <Boolean> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains a single parameter called (ValidDataLocation) which is a switch and enables to validate the location of the data, for users in a multi-geo tenant in SharePoint Online. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -```Powershell -Get-SPOCrossGeoUsers -ValidDataLocation -``` -In a multi-geo tenant, get the cross users and validate the data location - - -## PARAMETERS - -### -ValidDataLocation -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[ConvertTo-SPOMigrationTargetedPackage](ConvertTo-SPOMigrationTargetedPackage.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataConnectionSetting.md deleted file mode 100644 index e18c49ab4b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataConnectionSetting.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Get-SPODataConnectionSetting -schema: 2.0.0 ---- - -# Get-SPODataConnectionSetting - -## SYNOPSIS - -Returns Business Connectivity Services OData connection properties. - - -## SYNTAX - -``` -Get-SPODataConnectionSetting -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Get-SPODataConnectionSetting` cmdlet to display Business Connectivity Services OData connection properties for a specified Business Connectivity Services connection. - -If the name of the connection is not specified by using the Name parameter, this cmdlet will return the list of the connections for the specified BDC service context. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPODataConnectionSetting -ServiceContext "http://contoso/" -Name "ContosoServiceApp" -``` - -This example returns properties of the BCS connection named ContosoServiceApp - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPODataConnectionSetting -ServiceContext "http://contoso/" -``` - -This example returns a list of BCS connections for the service context named http://contoso - - -## PARAMETERS - -### -ServiceContext -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Business Connectivity Services connection object. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) - -[Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) - -[Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataConnectionSettingMetadata.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataConnectionSettingMetadata.md deleted file mode 100644 index b70e7f5d43..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataConnectionSettingMetadata.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Get-SPODataConnectionSettingMetadata -schema: 2.0.0 ---- - -# Get-SPODataConnectionSettingMetadata - -## SYNOPSIS - -Returns a Business Data Connectivity service metadata object. - - -## SYNTAX - -``` -Get-SPODataConnectionSettingMetadata -ServiceContext <SPServiceContextPipeBind> -Name <String> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Get-SPODataConnectionSettingMetaData` cmdlet to return a Business Data Connectivity service metadata object for a specific Business Connectivity Services service application. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPODataConnectionSettingMetadata -ServiceContext "http://contoso/" -Name "ContosoServiceApp" -``` - -This example displays metadata properties of BCS connection named ContosoServiceApp - - -## PARAMETERS - -### -ServiceContext -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Business Connectivity Services connection whose metadata properties the user wants to see displayed. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPODataConnectionSettingMetaData](Set-SPODataConnectionSettingMetaData.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md deleted file mode 100644 index 065b9cd30e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPODeletedSite -schema: 2.0.0 ---- - -# Get-SPODeletedSite - -## SYNOPSIS -Returns all deleted site collections from the Recycle Bin. - -## SYNTAX - -### ParameterSetPersonalSitesOnly -``` -Get-SPODeletedSite [[-Identity] <SpoSitePipeBind>] [-IncludeOnlyPersonalSite] [-Limit <String>] - [<CommonParameters>] -``` - -### ParameterSetAllSites -``` -Get-SPODeletedSite [[-Identity] <SpoSitePipeBind>] [-IncludePersonalSite] [-Limit <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPODeletedSite` cmdlet returns all deleted site collections that match the given criteria from the Recycle Bin. - -By default the cmdlet only returns site and site collections that are not Personal Sites (My Sites). -To include personal sites, use the IncludePersonalSite parameter. -To return only Personal Sites, use the IncludeOnlyPersonalSite parameter. - -These two Switch Parameters are in different parameter sets, so you can only use either one of them but not both. - -This action does not restore these returned sites or site collection. -It only returns their properties so that you can see what sites or site collections have been deleted. -To restore the site or site collections, forward the results to the `Restore-SPODeletedSite` cmdlet in the pipeline. - -You must be a SharePoint Online global administrator and a site collection administrator for the deleted site collections to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Get-SPODeletedSite -IncludePersonalSite -``` -The command in this example returns all deleted site collections from the Recycle Bin including Personal Sites. - - -## PARAMETERS - -### -IncludeOnlyPersonalSite -Use this switch parameter to only include Personal Sites in the returned results. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetPersonalSitesOnly -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the URL of the deleted site collection to be returned. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludePersonalSite -Use this switch parameter to include Personal Sites with the returned results. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAllSites -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Specifies the maximum number of site collections to return. -It can be any number. -To retrieve all site collections, use ALL. -The default value is 200. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Restore-SPODeletedSite](Restore-SPODeletedSite.md) - -[Remove-SPODeletedSite](Remove-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md deleted file mode 100644 index 1f23ba0192..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOExternalUser -schema: 2.0.0 ---- - -# Get-SPOExternalUser - -## SYNOPSIS -Returns external users in the tenant's folder. - - -## SYNTAX - -``` -Get-SPOExternalUser [[-Position] <Int32>] [[-PageSize] <Int32>] [[-Filter] <String>] [[-SortOrder] <SortOrder>] - [[-SiteUrl] <String>] [-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount <Boolean>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPOExternalUser` cmdlet returns external users that are located in the tenant's folder based on specified criteria. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOExternalUser -Position 0 -PageSize 2 -``` -Example 1 returns the first two external users in the collection. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOExternalUser -Position 2 -PageSize 2 -``` -Example 2 returns two external users from the third page of the collection. - - -### -----------------------EXAMPLE 3----------------------------- -``` -Get-SPOExternalUser -Position 0 -PageSize 30 -Filter https://contosoe.testsite.com -``` -Example 3 returns the first 30 users that match the filter, https://contosoe.testsite.com. - -## PARAMETERS - -### -Filter -Limits the results to only those users whose first name, last name or email address begins with the text in the string, using a case-insensitive comparison - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -Specifies the maximum number of users to be returned in the collection. - -The value must be less than or equal to 50. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Position -Use to specify the zero-based index of the position in the sorted collection of the first result to be returned. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteUrl -Specifies the site to retrieve external users for. -If no site is specified, the external users for all sites are returned. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortOrder -Specifies the sort results in Ascending or Descending order on the SPOUser.Email property should occur. - - -```yaml -Type: SortOrder -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount -System.Boolean - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Remove-SPOExternalUser](Remove-SPOExternalUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md deleted file mode 100644 index ba4d16f76a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOGeoAdministrator -schema: 2.0.0 ---- - -# Get-SPOGeoAdministrator - -## SYNOPSIS -This cmdlet returns the SharePoint Online user or security group accounts with global administrative privilegies in the current Multi-Geographics tenant - -## SYNTAX - -```powershell -Get-SPOGeoAdministrator [<CommonParameters>] -``` - -## DESCRIPTION - -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -The `Get-SPOGeoAdministrator` cmdlet a single parameter set and matches a user or a list of users which has the ability to do changes globally in the SharePoint Organization. -Running this Cmdlet on a single tenant organization will lead to a error -4, which means that you're not in a multi-Geo Tenant. - -You must be a SharePoint Online global administrator and you must have a Multi-Geo Tenant to run the `Get-SPOGeoAdministrator` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOGeoAdministrator -``` -You will get a SharePoint Online User user or security group that are Multi-Geographic administrators on the current multi-geo Tenant - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -[Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCompatibilityStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCompatibilityStatus.md deleted file mode 100644 index f2d1ccf009..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCompatibilityStatus.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOGeoMoveCompatibilityStatus -schema: 2.0.0 ---- - -# Get-SPOGeoMoveCompatibilityStatus - -## SYNOPSIS -This cmdlet returns the compatibility status between geographics location - - -## SYNTAX - -``` -Get-SPOGeoMoveCompatibilityStatus [-AllLocations <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns the compatibility between sites and locations for a move in a multi geo SharePoint Online tenant. - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Get-SPOGeoMoveCompatibilityStatus -AllLocations $true -``` - -Get the compatibility status for all locations - -### EXAMPLE 2 -```powershell -Get-SPOGeoMoveCompatibilityStatus -AllLocations $false -``` - -Get the compatibility status for the current location - - -## PARAMETERS - -### -AllLocations -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md deleted file mode 100644 index db7974fa67..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOGeoStorageQuota -schema: 2.0.0 ---- - -# Get-SPOGeoStorageQuota - -## SYNOPSIS -This Cmdlet gets the Storage quota on a multi-geo tenant - - -## SYNTAX - -```Powershell -Get-SPOGeoStorageQuota [-AllLocations] [<CommonParameters>] -``` - -## DESCRIPTION -This Cmdlet shows the storage on the current location or all locations in a multi-geo SPO tenant - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -```Powershell -Get-SPOGeoStorageQuota -AllLocations -``` -Get the storage size quota of all locations - -### -----------------------EXAMPLE 2----------------------------- -```Powershell -Get-SPOGeoStorageQuota -``` -Get the storage size quota of the current location - - -## PARAMETERS - -### -AllLocations -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Set-SPOGeoStorageQuota](set-SPOGeoStorageQuota.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md deleted file mode 100644 index 49d0e6bbda..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOHideDefaultThemes -schema: 2.0.0 ---- - -# Get-SPOHideDefaultThemes - -## SYNOPSIS - -Queries the current SPOHideDefaultThemes setting. - -## DESCRIPTION - -The **Get-SPOHideDefaultThemes** cmdlet retrieves the current **Set-SPOHideDefaultThemes** setting. You might want to use this cmdlet in a PowerShell script to read the setting and then take different actions based on whether the default themes are hidden. This cmdlet does not have any parameters. - -Note that this cmdlet was named **Get-HideDefaultThemes** until the December 2017 release of the SPO Management Shell. We recommend that you use the latest version of the PowerShell cmdlets. - -## EXAMPLES - -### Example 1 - -``` -Get-SPOHideDefaultThemes $false -``` - - -## INPUTS - -## OUTPUTS - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md deleted file mode 100644 index e7b54419f2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOHubSite -schema: 2.0.0 ---- - -# Get-SPOHubSite - -## SYNOPSIS -Lists hub sites or hub site information. - -## SYNTAX - -``` -Get-SPOHubSite [-Identity] <SpoHubSitePipeBind> -[<CommonParameters>] -``` - -## DESCRIPTION -Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** the cmdlet returns detailed information about the specific hub. You can find which hub a site is associated with by providing the site's identity with this cmdlet. - -If the hub site doesn’t exist, this cmdlet returns a “File not found” error. - -## EXAMPLES - -### Example 1 - -``` -Get-SPOHubSite -``` - -This example lists all hub sites in the tenant. - -### Example 2 - -``` -Get-SPOHubSite https://contoso.sharepoint.com/sites/online-marketing - -ID : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 -Title : Marketing Hub -SiteId : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 -SiteUrl : https://contoso.sharepoint.com/sites/Marketing -LogoUrl : https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png -Description : Hub for the Marketing division -Rights : nestorw@contoso.onmicrosoft.com -``` - -This example begins with the online-marketing site. The cmdlet finds the associated hub site, which is marketing. Then it lists all the details about the marketing hub site. - -## PARAMETERS - -### -Identity - -URL of the hub site. If not specified, the cmdlet lists all hub sites in the tenant. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md deleted file mode 100644 index 87870ba408..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOMigrationJobProgress -schema: 2.0.0 ---- - -# Get-SPOMigrationJobProgress - -## SYNOPSIS -This cmdlet lets you report on SPO migration jobs that are in progress. - - -## SYNTAX - -### AzureLocationsInline -``` -Get-SPOMigrationJobProgress -AzureQueueUri <String> -Credentials <CredentialCmdletPipeBind> - [-DontWaitForEndJob] [-EncryptionParameters <EncryptionParameters>] [-JobIds <Guid[]>] [-NoLogFile] - [-TargetWebUrl <String>] [<CommonParameters>] -``` - -### AzureLocationsImplicit -``` -Get-SPOMigrationJobProgress -Credentials <CredentialCmdletPipeBind> [-DontWaitForEndJob] - [-EncryptionParameters <EncryptionParameters>] [-JobIds <Guid[]>] - -MigrationPackageAzureLocations <MigrationPackageAzureLocations> [-NoLogFile] [-TargetWebUrl <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet lets you report on SPO migration jobs that are in progress. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -$myQueueUri = <uri to azure report queue> - -Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri -``` -This will report on ALL jobs within the report queue. - - -### -----------------------EXAMPLE 2----------------------------- -``` -$jobIds = @(<jobid1>,<jobId2>....) - -Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri -JobIds $jobIds -``` -This will report only jobs defined within the $jobIds collection from the report queue. - - -### -----------------------EXAMPLE 3----------------------------- -``` -$targetWebUrl = <myTargetWebUrl> -$creds = <my site credentials> - -Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWebUrl -Credentials $creds -``` -This will report on any currently queued or in progress jobs and wait for all jobs to complete - - -### -----------------------EXAMPLE 4----------------------------- -``` -$targetWebUrl = <myTargetWebUrl> -$creds = <my site credentials> - -Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWebUrl -Credentials $creds -DontWaitForJobEnd -``` -This will report on any currently queued or in progress jobs and not wait for all jobs to complete - - -## PARAMETERS - -### -AzureQueueUri -An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import. - - -```yaml -Type: String -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session’s previous call to `Connect-SPOService` will be used to connect to the site collection. - - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DontWaitForEndJob -Tells the cmdlet to not wait for the job to end. It will only process as many messages as are currently in the queue and then terminate. If this flag is set to $false, it will wait for the job to end before terminating. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionParameters -PARAMVALUE: EncryptionParameters - - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobIds -Id of a previously created migration job that exists on the target site collection. - - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationPackageAzureLocations -A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the `Set-SPOMigrationPackageAzureSource` - - -```yaml -Type: MigrationPackageAzureLocations -Parameter Sets: AzureLocationsImplicit -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Indicates to not create a log file. The default is to create a new CopyMigrationPackage log file within the directory specified within the SourcePackagePath parameter. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -The fully qualified target web URL where the package will be imported into. This must include the same TargetWebURL that was used during `ConvertTo-SPOMigrationTargetedPackage`. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md deleted file mode 100644 index cde23168df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOMigrationJobStatus -schema: 2.0.0 ---- - -# Get-SPOMigrationJobStatus - -## SYNOPSIS -Use this cmdlet to monitor the status of a submitted SharePoint Online migration job. - - -## SYNTAX - -``` -Get-SPOMigrationJobStatus -Credentials <CredentialCmdletPipeBind> [-JobId <Guid>] [-NoLogFile] - -TargetWebUrl <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet will check the status of a migration job, - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -```powershell -$targetWebUrl = "https://contoso.sharepoint.com/sites/migrationtest" -$credentials = Get-Credential -Get-SPOMigrationJobStatus -TargetWebUrl $targetWebUrl -Credentials $credentials -JobId "779c4b3b-ec24-4705-bb58-c38f4329418c" -``` - -Get the status of your SPO Migration Job. -You can obtain the Job id when submit package data to create new SPO migration job via the Invoke-SPOMigrationEncryptUploadSubmit cmdlet - -## PARAMETERS - -### -Credentials -The credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session’s previous call to `Connect-SPOService` will be used to connect to the site collection. - - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -(optional) The ID of a migration job that exists on the target site collection. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -(optional) Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -The fully qualified target web URL where the package will be imported. This must include the same TargetWebUrl that was used during `ConvertTo-SPOMigrationTargetedPackage`. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md deleted file mode 100644 index 1c674cf0df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOPublicCdnOrigins -schema: 2.0.0 ---- - -# Get-SPOPublicCdnOrigins - -## SYNOPSIS -This cmdlet returns a list of CDN Origins in your SharePoint Online Tenant - -## SYNTAX - -```powershell -Get-SPOPublicCdnOrigins [<CommonParameters>] -``` - -## DESCRIPTION -List CDN Origins in your Tenant by id or url. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\WINDOWS\system32> Get-SPOPublicCdnOrigins | Fl - -Id : 16530053476cf3efe88b499076356d0205504b2451688c20a65d561c951783e0859ac590 -Url : HTTPS:/CONTOSO.SHAREPOINT.COM/SITES/CDN/CDNFILESLIBRARY -``` - -This example return a list of CDN Origins. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[New-SPOPublicCdnOrigin](New-SPOPublicCdnOrigin.md) - -[Remove-SPOPublicCdnOrigin](Remove-SPOPublicCdnOrigin.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md deleted file mode 100644 index 23b16f57dc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOSite -schema: 2.0.0 ---- - -# Get-SPOSite - -## SYNOPSIS -Returns one or more site collections. - - -## SYNTAX - -### ParamSet1 -``` -Get-SPOSite [[-Identity] <SpoSitePipeBind>] [-Detailed] [-Limit <String>] [<CommonParameters>] -``` - -### ParamSet2 -``` -Get-SPOSite [-Detailed] [-Filter <String>] [-IncludePersonalSite <Boolean>] [-Limit <String>] - [-Template <String>] [<CommonParameters>] -``` - -### ParamSet3 -``` -Get-SPOSite [-Identity] <SpoSitePipeBind> [-DisableSharingForNonOwnersStatus] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets. - -The `Get-SPOSite` cmdlet retrieves and returns properties of all site collections that match the given criteria. - -With version 5361 of the SharePoint Online Management Shell, you may experience the following: - -Additional site collections are now displayed. For example, all group and video sites along with team sites will be displayed. - -The Detailed parameter has been deprecated. It will continue to work with earlier versions - -You may see an impact on performance when the Filter parameter is used. - -> [!NOTE] -> Site collections in the Recycle Bin will not be retrieved by using the `Get-SPOSite` cmdlet. - -You need to be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832. - -> [!NOTE] -> If Site Collection Storage Management is enabled for the tenant, you will not be able to set quota and will have a generic error returned. To workaround this issue, set the site collection storage management to "manual" temporarily, set your quotas and then set the site collection storage management setting back to its original setting. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOSite -``` -Example 1 returns all site collections. - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOSite -Identity https://contoso.sharepoint.com -``` -Example 2 lists the site collection with detailed properties. - -### -----------------------EXAMPLE 3----------------------------- -``` -Get-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwnersStatus -``` -Example 3 disables the ability for non owners of a site collection to share. - -### -----------------------EXAMPLE 4----------------------------- -``` -Get-SPOSite -Template GROUP#0 -IncludePersonalSite:$false -``` -This example enumerates Group Site Collections in a tenant. - -### -----------------------EXAMPLE 5----------------------------- -``` -Get-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -detailed |fl -``` -This example gets quota details for a Group Site. - - -## PARAMETERS - -### -Detailed -Use this parameter to get additional property information on a site collection. You will notice a slower response time when the Detailed parameter is used. - -The following properties are returned: - ---ResourceUsageCurrent - ---ResourceUsageAverage - ---StorageUsageCurrent - ---LockIssue - ---WebsCount - ---CompatibilityLevel - ---AllowSelfServiceUpgrade - ---SiteDefinedSharingCapability-returns the stored value of the site policy. - ---SharingCapability --returns the effective access level (the site policy and the tenant policy combined. - - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1, ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSharingForNonOwnersStatus -This parameter prevents non-owners from sharing. - -> [!NOTE] -> his parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later. - - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet3 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form {$_PropertyName <operator> "filterValue"}. Valid operators are as follows: eq, ne, like, notlike. - -> [!NOTE] -> The operator values are case-sensitive. - - -```yaml -Type: String -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the URL of the site collection. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SpoSitePipeBind -Parameter Sets: ParamSet3 -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludePersonalSite -Displays personal sites when value is set to $true. - -The values are $true and $false. By default, the value is $false which means no personal sites will be returned. - - -```yaml -Type: Boolean -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. The default value is 200. - - -```yaml -Type: String -Parameter Sets: ParamSet1, ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Displays sites of a specific template. For example, STS, STS#0 or STS#1. - - -```yaml -Type: String -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteContentMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteContentMoveState.md deleted file mode 100644 index dc270c03d7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteContentMoveState.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOSiteContentMoveState -schema: 2.0.0 ---- - -# Get-SPOSiteContentMoveState - -## SYNOPSIS -This Cmdlet allows a SharePoint administrators to check the status of a site or group move. - - -## SYNTAX - -### GroupName -```powershell -Get-SPOSiteContentMoveState [-GroupName] <String> [<CommonParameters>] -``` - -### SourceSiteUrl -```powershell -Get-SPOSiteContentMoveState [-SourceSiteUrl] <String> [<CommonParameters>] -``` - -## DESCRIPTION -This command gets the information and the status of a move request of a user between sites in a SharePoint Online Multi Geo tenant. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOSiteContentMoveState -GroupName "group@contoso.com" -``` - -Gets the status of the site content for the group "group@contoso.com" - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOSiteContentMoveState -SourceSiteUrl $siteurl -``` - -Gets the status of the site content give on the variable $siteurl - - -## PARAMETERS - -### -GroupName -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: GroupName -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSiteUrl -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: SourceSiteUrl -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md deleted file mode 100644 index 4432394c9c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOSiteDesign -schema: 2.0.0 ---- - -# Get-SPOSiteDesign - -## SYNOPSIS - -Gets details about site designs that are on the SharePoint tenant. You can specify an ID of a specific site design to retrieve. If there are no parameters listed, details about all site designs are listed. - -## SYNTAX - -```powershell -Get-SPOSiteDesign - [[-Identity] <SPOSiteDesignPipeBind>] - [<CommonParameters>] -``` - -## DESCRIPTION - -Gets details about site designs that are on the SharePoint tenant. You can specify an ID of a specific site design to retrieve. If there are no parameters listed, details about all site designs are listed. - -## EXAMPLES - -### Example 1 - -This example and sample response show how to get site design details. - -```powershell -Get-SPOSiteDesign 44252d09-62c4-4913-9eb0-a2a8b8d7f863 - -Id : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 -Title : Contoso - Team Project -WebTemplate : 64 -SiteScriptIds : {1306913c-8463-42ca-bd63-efad0fcdbba4} -Description : Use this design to apply Contoso theme and create - custom lists and add to nav -``` - - -## PARAMETERS - -### -Identity -The ID of the site design to retrieve. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md deleted file mode 100644 index 9bf433e5e9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOSiteDesignRights -schema: 2.0.0 ---- - -# Get-SPOSiteDesignRights - -## SYNOPSIS - -Displays a list of principals and their rights for usage of the site design. This can be used to determine the scope that your site design has with users on the tenant. - -## SYNTAX - -```powershell -Get-SPOSiteDesignRights - [-Identity] <SPOSiteDesignPipeBind> - [<CommonParameters>] -``` - -## DESCRIPTION - -Displays a list of principals and their rights for usage of the site design. This can be used to determine the scope that your site design has with users on the tenant. - -## EXAMPLES - -### Example 1 - -This example gets the rights for a site design. - -```powershell -Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1 - -DisplayName PrincipalName Rights ------------ ------------- ------ -Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View -``` - - -## PARAMETERS - -### -Identity -The ID of the site design to get scoping information. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md deleted file mode 100644 index 5a99c59da7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: -schema: 2.0.0 ---- - -# Get-SPOSiteDesignRun - -## SYNOPSIS -Retrieves a list of site designs applied to a specified site collection. - - -## SYNTAX - -``` -Get-SPOSiteDesignRun [-WebUrl] <String> [[-SiteDesignId] <SPOSiteDesignPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Retrieves a list of site designs applied to a specified site collection. The WebUrl is required to know which site collection to query. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title. - -## EXAMPLES - -### ------------ Example 1 -------------------- - -This example would return a list of the site designs applied to the specified site. Providing a specific site design ID will return the details for just that applied site design. - -```powershell -PS C:\> Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" - -Id: | sean530z-55a3-4804-8b0a-80578626d6ef -SiteDesignId: | sean530b-4133-444e-9e31-fb0c07f69d3a -WebId: | 4f8509cd-7972-44d0-a14a-3c8ad69ee50f -SiteId: | d5d19d7c-sean-4625-9461-281bfc8a9ece -SiteDesignVersion: | 3 -SiteDesignTitle: | Contoso Project Playbook -``` - -## PARAMETERS - -### -SiteDesignId -The ID of a specific site design. Use this optional parameter if you wish to only return details on a specific site design run. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebUrl -The Url of the site collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md deleted file mode 100644 index 68a88a7679..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: -schema: 2.0.0 ---- - -# Get-SPOSiteDesignRunStatus - -## SYNOPSIS - -Retrieves and displays a list of all site script actions executed for a specified site design applied to a site. - -## SYNTAX - -``` -Get-SPOSiteDesignRunStatus [-Run] <SPOSiteDesignRun> [<CommonParameters>] -``` - -## DESCRIPTION - -Retrieves and displays a list of all site script actions executed for a specified site design applied to a site. - -## EXAMPLES - -### Example 1 - -This example gets the run for a specific site design applied to a site and sets it to a variable. This variable is then passed into the command -run parameter. The result is a display of all the site script actions applied for that site design run, including the script action title and outcome. - -```powershell -PS C:\> $myrun = Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" -SiteDesignId cefd782e-sean-4814-a68a-b33b116c302f - -PS C:\> Get-SPOSiteDesignRunStatus -Run $myrun - -OrdinalIndex: | 0 -SiteScriptId: | sean530b-4133-444e-9e31-fb0c07f69d3a -SiteScriptTitle: | project tracker script for contoso legal -SiteScriptIndex: | 0 -ActionIndex: | 0 -ActionTitle: | Add principal contoso legal team to SPGroup Owners. -ActionKey: | 4f8509cd-0000-0000-0000-00000000 -OutcomeCode: | Success -OutcomeText: | - -OrdinalIndex: | 1 -SiteScriptId: | sean530b-4133-444e-9e31-abc123abc123 -SiteScriptTitle: | project tracker script for contoso legal -SiteScriptIndex: | 0 -ActionIndex: | 1 -ActionTitle: | Apply theme Contoso Legal. -ActionKey: | 4f8509cd-0000-0000-0000-00000000 -OutcomeCode: | Success -OutcomeText: | -``` - -## PARAMETERS - -### -Run - -The site design run for the desired set of script action details. - -```yaml -Type: SPOSiteDesignRun -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignRun - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md deleted file mode 100644 index 2c4fde18cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Add-SPOSiteDesignTask -schema: 2.0.0 ---- - -# Get-SPOSiteDesignTask - -## SYNOPSIS - -Cmdlet to get a scheduled site design script. - -## SYNTAX - -```powershell -Get-SPOSiteDesignTask - -Identity <guid> - -WebUrl <string> - [<CommonParameters>] -``` - -## DESCRIPTION - -Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL fo the SPWeb where the site design is scheduled to be applied. - - -> [!NOTE] -> This command only retrieves a previously scheduled request. - -## EXAMPLES - -### Example 1 - -This example applies a site design that includes two site scripts - totaling over 30 site script actions. Executing the commands will schedule the site design to be queued and run against the designated site collection. - -```powershell -Get-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome%E2%80%9D--%60%60%60--##%20PARAMETERS--###%20-Identity-The%20ID%20of%20the%20scheduled%20site%20design%20to%20apply.--%60%60%60yaml-Type:%20SPOSiteDesignPipeBind-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online-Required:%20True%20-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False%20%20-%60%60%60--###%20-WebUrl-The%20URL%20of%20the%20site%20collection%20where%20the%20site%20design%20will%20be%20applied.--%60%60%60yaml-Type:%20String-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online-Required:%20True%20-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False%20%20-%60%60%60-##%20RELATED%20LINKS--[Add-SPOSiteDesignTask](Get-SPOSiteDesignTask.md)--[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md)--[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md)diff%20--git%20a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md%20b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.mddeleted%20file%20mode%20100644index%20f5f5b784bc..0000000000---%20a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md+++%20/dev/null@@%20-1,105%20+0,0%20@@-----external%20help%20file:%20sharepointonline.xml-applicable:%20SharePoint%20Online-title:%20Get-SPOSiteGroup-schema:%202.0.0------#%20Get-SPOSiteGroup--##%20SYNOPSIS-Gets%20all%20the%20groups%20on%20the%20specified%20site%20collection.---##%20SYNTAX--%60%60%60-Get-SPOSiteGroup%20[-Group%20%3CString%3E]%20[-Limit%20%3CInt32%3E]%20-Site%20%3CSpoSitePipeBind%3E%20[%3CCommonParameters%3E]-%60%60%60--##%20DESCRIPTION-Use%20the%20%60Get-SPOSiteGroup%60%20cmdlet%20to%20get%20all%20the%20groups%20on%20the%20specified%20site%20collection%20by%20using%20the%20Site%20parameter.--You%20must%20be%20a%20SharePoint%20Online%20global%20administrator%20and%20a%20site%20collection%20administrator%20to%20run%20the%20cmdlet.--For%20permissions%20and%20the%20most%20current%20information%20about%20Windows%20PowerShell%20for%20SharePoint%20Online,%20see%20the%20online%20documentation%20at%20http://go.microsoft.com/fwlink/p/?LinkId=251832%20(http://go.microsoft.com/fwlink/p/?LinkId=251832).---##%20EXAMPLES--###%20-----------------------EXAMPLE%201------------------------------%60%60%60-Get-SPOSiteGroup%20-Site%20http://contoso.sharepoint.com/sites/siteA-%60%60%60-This%20example%20returns%20all%20the%20groups%20on%20the%20specified%20site%20collection%20http://contoso.sharepoint.com/sites/siteA.---##%20PARAMETERS--###%20-Group-Specifies%20the%20group%20name.---%60%60%60yaml-Type:%20String-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online--Required:%20False-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-Limit-Specifies%20the%20maximum%20number%20of%20site%20collections%20to%20return.%20To%20retrieve%20all%20of%20the%20site%20collections,%20use%20Limit%20ALL.%20The%20default%20value%20is%20200.---%60%60%60yaml-Type:%20Int32-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online--Required:%20False-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-Site-Specifies%20the%20site%20collection%20scope.---%60%60%60yaml-Type:%20SpoSitePipeBind-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Online--Required:%20True-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False-%60%60%60--###%20CommonParameters-This%20cmdlet%20supports%20the%20common%20parameters:%20-Debug,%20-ErrorAction,%20-ErrorVariable,%20-InformationAction,%20-InformationVariable,%20-OutVariable,%20-OutBuffer,%20-PipelineVariable,%20-Verbose,%20-WarningAction,%20and%20-WarningVariable.%20For%20more%20information,%20see%20about_CommonParameters%20(http://go.microsoft.com/fwlink/?LinkID=113216).--##%20INPUTS--##%20OUTPUTS--##%20NOTES--##%20RELATED%20LINKS--[Getting%20started%20with%20SharePoint%20Online%20Management%20Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps)--[Set-SPOSiteGroup](Set-SPOSiteGroup.md)--[Remove-SPOSiteGroup](Remove-SPOSiteGroup.md)diff%20--git%20a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md%20b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.mddeleted%20file%20mode%20100644index%203964792320..0000000000---%20a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md+++%20/dev/null@@%20-1,68%20+0,0%20@@-----external%20help%20file:%20sharepointonline.xml-applicable:%20SharePoint%20Online-title:%20Get-SPOSiteScript-schema:%202.0.0------#%20Get-SPOSiteScript--##%20SYNOPSIS--Displays%20information%20about%20existing%20site%20scripts.%20When%20no%20parameter%20is%20provided,%20this%20cmdlet%20returns%20the%20**Id**,%20**Title**,%20**Description**,%20and%20**Version**%20of%20each%20site%20script.%20When%20a%20site%20script%20ID%20is%20provided,%20this%20cmdlet%20also%20returns%20the%20**Content**,%20which%20is%20the%20JSON%20of%20the%20site%20script.--##%20SYNTAX--%60%60%60powershell-Get-SPOSiteScript-%20%20[[-Identity]%20%3CSPOSiteScriptPipeBind%3E]-%20%20[%3CCommonParameters%3E]-%60%60%60--##%20DESCRIPTION--Displays%20information%20about%20existing%20site%20scripts.%20When%20no%20parameter%20is%20provided,%20this%20cmdlet%20returns%20the%20**Id**,%20**Title**,%20**Description**,%20and%20**Version**%20of%20each%20site%20script.%20When%20a%20site%20script%20ID%20is%20provided,%20this%20cmdlet%20also%20returns%20the%20**Content**,%20which%20is%20the%20JSON%20of%20the%20site%20script.--##%20EXAMPLES--###%20Example%201--This%20example%20shows%20how%20to%20get%20script%20information%20for%20a%20specific%20script%20ID.--%60%60%60powershell-Get-SPOSiteScript%2007702c07-0485-426f-b710-4704241caad9--Id%20%20%20%20%20%20%20%20%20%20:%2007702c07-0485-426f-b710-4704241caad9-Title%20%20%20%20%20%20%20:%20Contoso%20theme-Description%20:-Content%20%20%20%20%20:%20{-"$schema": "schema.json", - "actions": [ - { - "verb": "applyTheme", - "themeName": "Custom Cyan" - } - ], - "bindata": { }, - "version": 1 - } -Version : 1 -``` - -## PARAMETERS - -### -Identity -The ID of the site script to get information about. - -```yaml -Type: SPOSiteScriptPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md deleted file mode 100644 index f58d910ec6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOSiteScriptFromList -schema: 2.0.0 ---- - -# Get-SPOSiteScriptFromList - -## SYNOPSIS - -Creates site script syntax from an existing SharePoint list. - -## SYNTAX - -```powershell -Get-SPOSiteScriptFromList - -ListUrl <string> - [<CommonParameters>] -``` - -## DESCRIPTION - -Uses an existing SharePoint list to output a JSON blob that can be used to create a site script for use in a site design. - -[!NOTE] -Most column data types and list configurations - including view formatting - are supported. Managed metadata fields cannot be extracted at this time. - -## EXAMPLES - -### Example 1 - -This example creates the site script output from an existing list - and writes it to a variable. This variable is then referenced to create a site script. - -```powershell -C:\> $extracted = Get-SPOSiteScriptFromList -ListUrl "https://contoso.sharepoint.com/sites/strategy/customer-contacts" -C:\> Add-SPOSiteScript ` - -Title "Contoso Customer Tracker" - -Description "This creates a customer contact list" - -Content $extracted -``` - -## PARAMETERS - -### -ListUrl -The url of the list to be referenced for the JSON output. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md deleted file mode 100644 index 9e2a836d36..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenant -schema: 2.0.0 ---- - -# Get-SPOTenant - -## SYNOPSIS -Returns SharePoint Online organization properties. - -## SYNTAX - -``` -Get-SPOTenant [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPOTenant` cmdlet returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, ResourceQuotaAllocated and SiteCreationMode. - -Currently, there are no parameters for this cmdlet. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Get-SPOTenant -``` -This example returns the organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, ResourceQuotaAllocated, SiteCreationMode and OneDriveStorageQuota. - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md deleted file mode 100644 index 1b2ce5d75a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantCdnEnabled -schema: 2.0.0 ---- - -# Get-SPOTenantCdnEnabled - -## SYNOPSIS -Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. Requires Tenant administrator permissions. - - -## SYNTAX - -``` -Get-SPOTenantCdnEnabled -CdnType <SPOTenantCdnType> [<CommonParameters>] -``` - -## DESCRIPTION -Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOTenantCdnEnabled -CdnType Public -``` - -The example returns a CDN with a type of public. - - -## PARAMETERS - -### -CdnType -Specifies the CDN type. The valid values are Public or Private. - - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md deleted file mode 100644 index 97b0b9bc68..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantCdnOrigins -schema: 2.0.0 ---- - -# Get-SPOTenantCdnOrigins - -## SYNOPSIS -Lists all the configured origins under the tenancy or under a given site. Requires Tenant administrator permissions. - - -## SYNTAX - -``` -Get-SPOTenantCdnOrigins -CdnType <SPOTenantCdnType> [<CommonParameters>] -``` - -## DESCRIPTION -Lists all the configured origins under the tenancy or under a given site. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOTenantCdnOrigins -CdnType Public -``` - -The example returns a list of origins from the Tenant. - - -## PARAMETERS - -### -CdnType -Specifies the CDN type. The valid values are: Public or Private. - - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md deleted file mode 100644 index e2014b0331..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantCdnPolicies -schema: 2.0.0 ---- - -# Get-SPOTenantCdnPolicies - -## SYNOPSIS -Get the public or private Policies applied on your SharePoint Online Tenant. Requires Tenant administrator permissions. - -## SYNTAX - -``` -Get-SPOTenantCdnPolicies -CdnType <SPOTenantCdnType> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets the public or private policies applied to a SharePoint Online organization tenant. - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOTenantCdnPolicies -CdnType Public -``` - -This example returns public CDN policies of your tenant. - -### Example 2 -```powershell -Get-SPOTenantCdnPolicies -CdnType Private -``` - -This example returns private CDN policies of your tenant. - -## PARAMETERS - -### -CdnType -Type of CDN on the current SPO Tenant (Public,Private) - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Set-SPOTenantCdnEnabled](Set-SPOTenantCdnEnabled.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md deleted file mode 100644 index b3027ef668..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantContentTypeReplicationParameters -schema: 2.0.0 ---- - -# Get-SPOTenantContentTypeReplicationParameters - -## SYNOPSIS -Gets content types for replication parameters - -## SYNTAX - -```powershell -Get-SPOTenantContentTypeReplicationParameters [<CommonParameters>] -``` - -## DESCRIPTION -Before you run the cmdlets, please use �Connect-SPOService� to connect to SharePoint Online first. -This Cmdlets gets the content types that are being replicated from primary location to satellite - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOTenantContentTypeReplicationParameters -``` -Gets content types for replication parameters - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) - -[Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) - - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md deleted file mode 100644 index e3aba52eed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantLogEntry -schema: 2.0.0 ---- - -# Get-SPOTenantLogEntry - -## SYNOPSIS -Retrieves SharePoint Online company logs. - - -## SYNTAX - -### CorrelationId -``` -Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>] - -CorrelationId <Guid> [<CommonParameters>] -``` - -### Source -``` -Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>] - -Source <Int32> [<CommonParameters>] -``` - -### User -``` -Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>] - -User <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets. - -The `Get-SPOTenantLogEntry` cmdlet cannot retrieve all SharePoint Online errors. This cmdlet retrieves a subset of errors that happen due to external systems. - -For Beta 2, the only company logs available are for Business Connectivity Services (BCS). - -> [!NOTE] -> If you do not use any parameter, the first 1000 rows in descending time range are returned. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOTenantLogEntry -``` -This example retrieves all logs that are available. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOTenantLogEntry -MaxRows 500 -``` -This example retrieves the first 500 log entries. - - -### -----------------------EXAMPLE 3----------------------------- -``` -$endTimeinUTC = Get-SPOTenantLogLastAvailableTimeInUtc -$startTimeinUTC = $endTimeinUTC.AddDays(-14) -$tenantlogs = Get-SPOTenantLogEntry -StartTimeinUtc $startTimeinUTC -EndTimeinUTC $endTimeinUTC -``` -This example retrieves log entries recorded over that previous 14 days. - - -### -----------------------EXAMPLE 4----------------------------- -``` -$endTimeinUTC = Get-SPOTenantLogLastAvailableTimeInUtc -$startTimeinUTC = $endTimeinUTC.AddDays(-14) -$tenantlogs = Get-SPOTenantLogEntry -StartTimeinUtc $startTimeinUTC -EndTimeinUTC $endTimeinUTC -CorrelationId e2c2be70-6382-4ce7-8a44-ae7dadff5597 -``` -This example retrieves log entries recorded over that previous 14 days that have the CorrelationId of “e2c2be70-6382-4ce7-8a44-ae7dadff5597”. - - -## PARAMETERS - -### -CorrelationId -Specifies the Correlation ID as a filter. - - -```yaml -Type: Guid -Parameter Sets: CorrelationId -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTimeInUtc -Specifies the end time in UTC to search for logs. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRows -Specifies the maximum number of rows in the descending order of timestamp. The value must be less than 5000. The default value is 1000. - - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Specifies the component that logs the errors. - - -```yaml -Type: Int32 -Parameter Sets: Source -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTimeInUtc -Specifies the start time in Coordinated Universal Time (UTC) to search for the logs — for example, 01032011:12:00. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -Specifies the log-on identity as a filter. - - -```yaml -Type: String -Parameter Sets: User -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md deleted file mode 100644 index 6d3da1629b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantLogLastAvailableTimeInUtc -schema: 2.0.0 ---- - -# Get-SPOTenantLogLastAvailableTimeInUtc - -## SYNOPSIS -Returns the most recent time when the SharePoint Online organization logs were collected. - -## SYNTAX - -``` -Get-SPOTenantLogLastAvailableTimeInUtc [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the time in Coordinated Universal Time (UTC) when the logs were last collected. -After you know the time, you can use the `Get-SPOTenantLogEntry` cmdlet to retrieve the logs. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOTenantLogLastAvailableTimeInUtc -``` - -This example returns the time in UTC when the SharePoint Online organization logs were most recently collected. - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOTenantLogEntry](Get-SPOTenantLogEntry.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md deleted file mode 100644 index 6d36e08d58..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Get-SPOTenantServicePrincipalPermissionGrants - -## SYNOPSIS - -Gets the collection of permission grants for the "SharePoint Online Client" service principal - -## SYNTAX - -### Default -```powershell -Get-SPOTenantServicePrincipalPermissionGrants -``` - -## DESCRIPTION -Gets the collection of permission grants for the "SharePoint Online Client" service principal. - -A permission grant contains the following properties: - -- ClientId: The objectId of the service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId). - -- ConsentType: Whether consent was provided by the administrator on behalf of the organization or whether consent was provided by an individual. The possible values are "AllPrincipals" or "Principal". - -- ObjectId: The unique identifier for the permission grant. - -- _(Coming soon)_ Resource: The resource to which access has been granted. - -- ResourceId: The objectId of the resource service principal to which access has been granted. - -- Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-SPOTenantServicePrincipalPermissionGrants -``` - -Gets the collection of permission grants for the "SharePoint Online Client" service principal. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md deleted file mode 100644 index 8c8f7427dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- - -# Get-SPOTenantServicePrincipalPermissionRequests - -## SYNOPSIS - -Gets the collection of permission requests for the "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Get-SPOTenantServicePrincipalPermissionRequests -``` - -## DESCRIPTION -Gets the collection of permission requests for the "SharePoint Online Client" service principal. - -Permission request object - -A permission request contains the following properties: - -- Id: The identifier of the request. - -- Resource: The resource that the application requires access to. - -- Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-SPOTenantServicePrincipalPermissionRequests -``` - -Gets the collection of permission requests for the "SharePoint Online Client" service principal. - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md deleted file mode 100644 index 7b97172df6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantSyncClientRestriction -schema: 2.0.0 ---- - -# Get-SPOTenantSyncClientRestriction - -## SYNOPSIS -Returns the current configuration status. - - -## SYNTAX - -``` -Get-SPOTenantSyncClientRestriction [<CommonParameters>] -``` - -## DESCRIPTION -You must be a SharePoint Online global administrator to run the cmdlet. - -Requires a valid `Connect-SPOService` context to identify the tenant. For information on how to connect to the tenant, see `Connect-SPOService`. - -The `Get-SPOTenantSyncClientRestriction` cmdlet returns whether the TenantRestrictionEnabled property is true or false and DomainGUIDs that are currently in the safe recipient list which is represented by the AllowedDomainList property. - -The `Get-SPOTenantSyncClientRestriction` cmdlet also returns the current state of the BlockMacSync parameter. - -The `Get-SPOTenantSyncClientRestriction` cmdlet also returns the current state of the GrooveBlockOption parameter. - -The `Get-SPOTenantSyncClientRestriction` cmdlet does not have any parameters. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOTenantSyncClientRestriction -``` -This example returns a current boolean value of the TenantRestrictionEnabled and BlockMacSync properties and a current set list of domains GUIDs in the AllowedDomainList property. - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md deleted file mode 100644 index e9e1d94277..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTenantTaxonomyReplicationParameters -schema: 2.0.0 ---- - -# Get-SPOTenantTaxonomyReplicationParameters - -## SYNOPSIS - -Get the replication parameters to manage Multi-Geo taxonomy replication. - -## SYNTAX - -```powershell -Get-SPOTenantTaxonomyReplicationParameters [<CommonParameters>] -``` - -## DESCRIPTION -Before you use this cmdlet, please use "Connect-SPOService" to connect to SharePoint Online first -This Cmdlet gets the replication parameters and it works to get the replication taxonomy in a Multi-Geo tenant. -It works with the [Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) to set the parameters. - -Get the sites to be replicated in a Multi-Geo taxonomy replication. - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOTenantTaxonomyReplicationParameters -``` - -Gets the replication groups that are being replicated on the current tenant. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) - -[Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md deleted file mode 100644 index ed5040c331..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOTheme -schema: 2.0.0 ---- - -# Get-SPOTheme - -## SYNOPSIS - -Retrieves settings for an existing theme. - -## DESCRIPTION - -The **Get-SPOTheme** cmdlet returns the settings for a named existing theme, or for all uploaded themes if no name is provided. - -## EXAMPLES - -### Example 1 - -This example shows how to use the **Get-SPOTheme** cmdlet to return the settings for the `"Custom Cyan"` theme created in the example for the **Add-SPOTheme** cmdlet. Note that this example uses the PowerShell `ConvertTo-Json` filter to display the theme in JSON format. - -``` -Get-SPOTheme -Name "Custom Cyan" | ConvertTo-Json -``` - - -``` -{ - "Name": "Custom Cyan", - "Palette": { - "themeLight": "#affefe", - "themeTertiary": "#76ffff", - "black": "#000000", - "neutralSecondary": "#666666", - "neutralTertiaryAlt": "#c8c8c8", - "themeSecondary": "#39ffff", - "themeDarker": "#005252", - "primaryBackground": "#fff", - "neutralQuaternary": "#d0d0d0", - "neutralPrimaryAlt": "#3c3c3c", - "neutralPrimary": "#333", - "themeDark": "#009090", - "themeLighter": "#daffff", - "neutralTertiary": "#a6a6a6", - "neutralQuaternaryAlt": "#dadada", - "themeLighterAlt": "#f3fcfc", - "white": "#fff", - "neutralSecondaryAlt": "#767676", - "neutralLighter": "#f4f4f4", - "neutralLight": "#eaeaea", - "neutralDark": "#212121", - "themeDarkAlt": "#00c4c4", - "neutralLighterAlt": "#f8f8f8", - "primaryText": "#333", - "themePrimary": "#00ffff" - }, - "IsInverted": false -} -``` - -### Example 2 - -To return all uploaded themes, use the **Get-SPOTheme** command with no arguments. - -``` -Get-SPOTheme -``` - -<!--(Commenting out this image because I don't see a way to have images in this location) - -This is an example of the output from this command. - -![Get-SPOTheme example](../../images/Get-SPOTheme-example.png)--> - -## INPUTS - -## OUTPUTS - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md deleted file mode 100644 index e82c3c0645..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOUser -schema: 2.0.0 ---- - -# Get-SPOUser - -## SYNOPSIS -Returns the SharePoint Online user or security group accounts that match a given search criteria. - - -## SYNTAX - -### ByGroup -``` -Get-SPOUser [-Group <String>] [-Limit <String>] -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -### All -``` -Get-SPOUser [-Limit <String>] -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -### ByLogin -``` -Get-SPOUser [-LoginName <String>] -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -The `Get-SPOUser` cmdlet matches one and only one user or security group. - -You must be a SharePoint Online global administrator and a site collection administrator to run the `Get-SPOUser` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -``` -Example 1 returns all user or security group accounts from the site collection http://contoso.sharepoint.com/sites/finance. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -LoginName melissa.kerr@contoso.com -``` -Example 2 returns one user or security group account whose user name is HYPERLINK "mailto:melissa.kerr@contoso.com" melissa.kerr@contoso.com from the site collection https://contoso.sharepoint.com/sites/finance. - - -### -----------------------EXAMPLE 3----------------------------- -``` -Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -Group "Team Site Members" -``` -Example 3 returns one user or security group account inside group Team Site Members from the site collection http://contoso.sharepoint.com/sites/finance. - -## PARAMETERS - -### -Group -Specifies the group to get the users from. - - -```yaml -Type: String -Parameter Sets: ByGroup -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Specifies the maximum number of users returned. The default value is to return 500 users. To return all users specify the value “All”. - - -```yaml -Type: String -Parameter Sets: ByGroup, All -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName -Specifies the user name. - - -```yaml -Type: String -Parameter Sets: ByLogin -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the URL of the site collection to get the user from. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Remove-SPOUser](Remove-SPOUser.md) - -[Set-SPOUser](Set-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md deleted file mode 100644 index f5353bed0d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOUserAndContentMoveState -schema: 2.0.0 ---- - -# Get-SPOUserAndContentMoveState - -## SYNOPSIS -This cmdlet allows a SharePoint administrators to check the status of a user or site move across geo locations. - -## SYNTAX - -### MoveReport -```powershell -Get-SPOUserAndContentMoveState [-Limit <UInt32>] [-MoveDirection <Direction>] [-MoveEndTime <DateTime>] - [-MoveStartTime <DateTime>] [-MoveState <State>] [<CommonParameters>] -``` - -### OdbMoveId -```powershell -Get-SPOUserAndContentMoveState -OdbMoveId <Guid> [<CommonParameters>] -``` - -### UserPrincipalName -```powershell -Get-SPOUserAndContentMoveState -UserPrincipalName <String> [<CommonParameters>] -``` - -## DESCRIPTION -This command gets the information and the status of a move request of a user between sites in a SharePoint Online Multi Geo tenant. - -The following are the available move states: - -|Status |Description| -| --- | --- | -|NotStarted| The move has not started. | -|InProgress| The move is in progress in one of the following states: Validation, Backup, Restore, Cleanup.| -|Success| The move has completed successfully.| -|Failed |The move failed.| - -## EXAMPLES -### Example 1 - -```Powershell -Get-SPOUserAndContentMoveState -OdbMoveId b298219e-3440-10b8-8931-46e805e2b85b -``` -Obtain the move state by OneDrive Move Job ID - -### Example 2 - -```Powershell -Get-SPOUserAndContentMoveState -movestate NotStarted -``` -Getting which moves are being done in a particular state -###Example 3 - -```Powershell -Get-SPOUserAndContentMoveState -MoveDirection All -``` -Gives you the output for users moving in and out from the geo location you are logged into - -###Example 4 -```Powershell -Get-SPOUserAndContentMoveState -MoveDirection In -``` -Gives you the output for users moving into the geo location that you are logged into - -###Example 5 -```Powershell -Get-SPOUserAndContentMoveState -MoveDirection Out -``` -Gives you the output for users moving out from the geo location that you are logged into - -###Example 6 -```Powershell -Get-SPOUserAndContentMoveState -UserPrincipalName jezz@contoso.com -``` -Obtains the status of the move for jezz@contoso.com - -## PARAMETERS - -### -Limit -Get the limit of user on a single call of the parameter - -```yaml -Type: UInt32 -Parameter Sets: MoveReport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveDirection -Allows you to define the direction of the user move in relation to your current SharePoint location - -```yaml -Type: Direction -Parameter Sets: MoveReport -Aliases: -Accepted values: All, MoveIn, MoveOut -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveEndTime -Allows you to obtain the moves that are scheduled to end by a particular time, as defined in UTC - -```yaml -Type: DateTime -Parameter Sets: MoveReport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveStartTime -Allows you to obtain the moves that are scheduled to begin at a particular time, as defined in UTC - -```yaml -Type: DateTime -Parameter Sets: MoveReport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveState -Move State current status. - -```yaml -Type: State -Parameter Sets: MoveReport -Aliases: -Accepted values: All, NotStarted, Scheduled, InProgress, Stopped, Success, Failed -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OdbMoveId -Onedrive GUID MoveID that you get when you start a job. - -```yaml -Type: Guid -Parameter Sets: OdbMoveId -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -User Principal name is the unique property on Azure AD for each user. - -```yaml -Type: String -Parameter Sets: UserPrincipalName -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md deleted file mode 100644 index b5af50d226..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOUserOneDriveLocation -schema: 2.0.0 ---- - -# Get-SPOUserOneDriveLocation - -## SYNOPSIS -This cmdlet will return the UPN of a user, current location this user locates, user�s corresponding MySite(ODB) Url and the site id. - -## SYNTAX - -```powershell -Get-SPOUserOneDriveLocation -UserPrincipalName <String> [<CommonParameters>] -``` - -## DESCRIPTION -This command will return information about the onedrive location from the current user - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -```powershell -Get-SPOUserOneDriveLocation -UserPrincipalName admin@contoso.com -``` -Get the current location this user locates, user's corresponding MySite(ODB) Url and site ID. - -## PARAMETERS - -### -UserPrincipalName -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md deleted file mode 100644 index a2a7ef951e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Get-SPOWebTemplate -schema: 2.0.0 ---- - -# Get-SPOWebTemplate - -## SYNOPSIS -Displays all site templates that match the given identity. - - -## SYNTAX - -``` -Get-SPOWebTemplate [[-LocaleId] <UInt32>] [-CompatibilityLevel <Int32>] [-Name <String>] [-Title <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPOWebTemplate` cmdlet displays all site templates that match the given identity and are available in SharePoint Online. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOWebTemplate -``` -Example 1 returns all the site templates in the language of the administrator site. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOWebTemplate -LocaleID 1036 -``` -Example 2 returns a list of all the French site templates. - - -## PARAMETERS - -### -CompatibilityLevel -Specifies the compatibility level of the site template. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocaleId -Specifies the Locale ID of the site template. - - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the site template. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Specifies the Locale ID of the site template. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOfficeStoreAppsDefaultActivation.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOfficeStoreAppsDefaultActivation.md deleted file mode 100644 index 55bc7ed2bf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOfficeStoreAppsDefaultActivation.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Get-SPOfficeStoreAppsDefaultActivation -schema: 2.0.0 ---- - -# Get-SPOfficeStoreAppsDefaultActivation - -## SYNOPSIS - -Returns the properties of apps for Office. - - -## SYNTAX - -### AppsForOfficeSettingsInSiteSubscription -``` -Get-SPOfficeStoreAppsDefaultActivation -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### AppsForOfficeSettingsInWebApplication -``` -Get-SPOfficeStoreAppsDefaultActivation -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Get-SPOfficeStoreAppsDefaultActivation` cmdlet to return settings for apps for Office that run in a specific web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Get-SPOfficeStoreAppsDefaultActivation -WebApplication http://sphvm-8044 -``` - -This examples returns the setting for the web application http://sphvm-8044. - -### -----------------------EXAMPLE 2----------------------------- -``` -Get-SPOfficeStoreAppsDefaultActivation -SiteSubscription efca5b88-b3a3-448d-afbc-ef620f4744f1 -``` - -This examples returns the Subscription ID setting for the tenant - -## PARAMETERS - -### -SiteSubscription -Specifies the Site Group to which the settings apply. - - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: AppsForOfficeSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the web application to which the setting applies. - - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: AppsForOfficeSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPOfficeStoreAppsDefaultActivation](Set-SPOfficeStoreAppsDefaultActivation.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md deleted file mode 100644 index b5f5847c6d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Grant-SPOHubSiteRights -schema: 2.0.0 ---- - -# Grant-SPOHubSiteRights - -## SYNOPSIS -Grants rights to users or mail-enabled security groups to access the hub site. - -## SYNTAX - -``` -Grant-SPOHubSiteRights [-Identity] <SpoHubSitePipeBind> -Principals - <string[]> -Rights {Join} [<CommonParameters>] -``` - -## DESCRIPTION -Applies permissions to a set of users or mail-enabled security groups. Use this cmdlet to scope visibility of who can associate their site with the hub site when using the SharePoint user interface. Hub sites are public by default. Once you set permissions, only those groups or users you specified can associate their site with the hub site. - -To view which users or groups have permissions to a site, use the [Get-SPOHubSite](Get-SPOHubSite.md) cmdlet. - -## EXAMPLES - -### Example 1 - -``` -Grant-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing --Principals nestorw@contoso.onmicrosoft.com --Rights Join -``` - -This example shows how to grant rights to Nestor (a user at the fictional Contoso site) to associate his sites with the marketing hub site. - -## PARAMETERS - -### -Identity - -URL of the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals - -One or more principles to add permissions for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rights - -Always set to the value **Join**. Any user or group with **Join** permissions can view and join the hub site. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md deleted file mode 100644 index 5941b7118a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Grant-SPOSiteDesignRights -schema: 2.0.0 ---- - -# Grant-SPOSiteDesignRights - -## SYNOPSIS - -Used to apply permissions to a set of users or a security group, effectively scoping the visibility of the site design in the UX. They start off public, but after you set permissions, only those groups or users with permissions can access the site design. - -## SYNTAX - -```powershell -Grant-SPOSiteDesignRights - [-Identity] <SPOSiteDesignPipeBind> - -Principals <string[]> - -Rights {View} - [<CommonParameters>] -``` - -## DESCRIPTION - -Used to apply permissions to a set of users or a security group, effectively scoping the visibility of the site design in the UX. They start off public, but after you set permissions, only those groups or users with permissions can access the site design. - -## EXAMPLES - -### Example 1 - -This example shows how to grant view rights on a site design to Nestor (a user at the fictional Contoso site). - -```powershell -Grant-SPOSiteDesignRights ` - -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Principals "nestorw@contoso.onmicrosoft.com" ` - -Rights View -``` - -## PARAMETERS - -### -Identity -The ID of the site design to get scoping information. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals -One or more principles to add permissions for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rights -Always set to the value **View**. Any user or group with view permissions can view and use the site design. - -```yaml -Type: SPOSiteDesignPrincipalRights -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md b/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md deleted file mode 100644 index 1f52b350f5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Invoke-SPOMigrationEncryptUploadSubmit -schema: 2.0.0 ---- - -# Invoke-SPOMigrationEncryptUploadSubmit - -## SYNOPSIS -Creates a new migration job in the target site collection - -## SYNTAX - -### ImplicitSourceParameterSet -```powershell -Invoke-SPOMigrationEncryptUploadSubmit -Credentials <CredentialCmdletPipeBind> - -MigrationSourceLocations <MigrationPackageLocation> [-NoLogFile] -TargetWebUrl <String> [<CommonParameters>] -``` - -### ExplicitSourceParameterSet -```powershell -Invoke-SPOMigrationEncryptUploadSubmit -Credentials <CredentialCmdletPipeBind> [-NoLogFile] - -SourceFilesPath <String> -SourcePackagePath <String> -TargetWebUrl <String> [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new migration job in the target site collection, and then returns a GUID representing the JobID. This command will upload encrypted source files and manifests into temporary Azure blob storage per job. - -## EXAMPLES - -### Example 1 -This example shows how to submit package data to create a new migration job - -```powershell -$job = Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath $sourceFiles -SourcePackagePath $spoPackagePath -Credentials $cred -TargetWebUrl $targetWebUrl -``` - -### Example 2 -```Powershell -$sourceFiles = "sourceFiles" -$spoPackagePath = "packagePath" -$credentials = Get-Credential -$targetweburl = "https://contoso.sharepoint.com/" -Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath $sourceFiles -SourcePackagePath $spoPackagePath -Credentials $credentials -TargetWebUrl $targetweburl -``` - -This example shows how to submit package data to create a new migration job. - -This article contains the steps on how to create this package: https://support.office.com/en-us/article/upload-on-premises-content-to-sharepoint-online-using-powershell-cmdlets-555049c6-15ef-45a6-9a1f-a1ef673b867c - - -### Example 3 - -This example shows how to submit package data to create new migration jobs for parallel import. -```Powershell -$jobs = $finalPackages | % {Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath $_.FilesDirectory.FullName -SourcePackagePath $_.PackageDirectory.FullName -Credentials $cred -TargetWebUrl $targetWeb} -``` - -## PARAMETERS - -### -Credentials -Parameter to fill out credentials of the SPO tenant. - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSourceLocations -Migration Location where the package lies. - -```yaml -Type: MigrationPackageLocation -Parameter Sets: ImplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Controls if a log will be created or not - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilesPath -Source files Path, string - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath -Source Package Path. - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -Target web URL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Upload on-premises content to SharePoint Online using PowerShell cmdlets](https://support.office.com/en-us/article/upload-on-premises-content-to-sharepoint-online-using-powershell-cmdlets-555049c6-15ef-45a6-9a1f-a1ef673b867c) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md deleted file mode 100644 index 1754d445ab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Invoke-SPOSiteDesign -schema: 2.0.0 ---- - -# Invoke-SPOSiteDesign - -## SYNOPSIS - -Applies a published site design to a specified site collection target. This allows a site design to be applied to an existing site collection. The supported site templates you can apply a site design to include: “modern” team site (with O365 group), “modern” team site (without an O365 group); communication site; classic team site; and classic publishing site. - -## SYNTAX - -```powershell -Invoke-SPOSiteDesign - [-Identity] - -WebUrl <string> - [<CommonParameters>] -``` - -## DESCRIPTION - -Applies a published site design to a specified site collection target. This allows a site design to be applied to an existing site collection. - -## EXAMPLES - -### Example 1 - -This example applies a site design whose script creates two lists, formats several of the columns, adds the lists to the site navigation, and then joins the site to an existing hub site. - -```powershell -Invoke-SPOSiteDesign -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectgo" - -Title Outcome ----------------------------------------------- ------- -Create or update list Project Activities Success -Update list description Success -Create column Project Status Success -Create column Effort (days) Success -Set custom formatter for field Project Status Success -Set custom formatter for field Effort (days) Success -Create or update list Project Collateral Success -Create column Due Date Success -Set custom formatter for field Due Date Success -Add Project Activities to left nav Success -Add Project Collateral to left nav Success -Add to Hub Site Success -``` - -## PARAMETERS - -### -Identity -The ID of the site design to apply. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebUrl -The URL of the site collection where the site design will be applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md deleted file mode 100644 index 03b670cad5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: New-SPODataConnectionSetting -schema: 2.0.0 ---- - -# New-SPODataConnectionSetting - -## SYNOPSIS -Creates a new Business Data Connectivity service connection. - - -## SYNTAX - -``` -New-SPODataConnectionSetting -AuthenticationMode <ODataAuthenticationMode> -ServiceAddressURL <Uri> - -ServiceContext <SPServiceContextPipeBind> -Name <String> [-AssignmentCollection <SPAssignmentCollection>] - [-ExtensionProvider <String>] [-SecureStoreTargetApplicationId <String>] [<CommonParameters>] -``` - - -## DESCRIPTION -Use the `New-SPODataConnectionSetting` cmdlet to create a new Business Data Connectivity service connection and its associated metadata properties in the farm. -To see the metadata settings, use the `Get-SPODataConnectionSettingMetaData` cmdlet. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -New-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso/" -ServiceAddressURL "https://expensereporting.cloudapp.net/expensereporting.svc" -AuthenticationMode "Credentials" -SecureStoreTargetApplicationId "DallasUserName" -``` - -This example creates a new Business Data Connectivity service connection named ContosoServiceApp. - -In this process, a Microsoft Business Connectivity Services connection metadata object is created. - - -## PARAMETERS - -### -AuthenticationMode -Specifies the type of authentication mode required for the Business Connectivity Services connection. - -The value for the authentication mode is any one of the following options: - -```yaml -Type: ODataAuthenticationMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAddressURL -Specifies the URL for the OData service. -The URL does not have be Internet facing. -This is the final destination from which data is retrieved. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Business Connectivity Services connection object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExtensionProvider -{{Fill ExtensionProvider Description}} - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStoreTargetApplicationId -Specifies the Secure Store Target Application ID. -Works in conjunction with the AuthenticationMode parameter. - -The value for the SecureStoreTargetApplicationId parameter is any one of the following options: - ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSetting](Get-SPODataConnectionSetting.md) - -[Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) - -[Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md deleted file mode 100644 index 85d4855d69..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: New-SPOMigrationEncryptionParameters -schema: 2.0.0 ---- - -# New-SPOMigrationEncryptionParameters - -## SYNOPSIS -{{Fill in the Synopsis}} - - -## SYNTAX - -```powershell -New-SPOMigrationEncryptionParameters [<CommonParameters>] -``` - - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -{{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md deleted file mode 100644 index e0410ad1aa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: New-SPOMigrationPackage -schema: 2.0.0 ---- - -# New-SPOMigrationPackage - -## SYNOPSIS -Cmdlet to create a new migration package based on source files in a local or network shared folder. - - -## SYNTAX - -``` -New-SPOMigrationPackage [-SourceFilesPath] <String> [-OutputPackagePath] <String> [[-TargetWebUrl] <String>] - [[-TargetDocumentLibraryPath] <String>] [[-TargetDocumentLibrarySubFolderPath] <String>] [-IgnoreHidden] - [-IncludeFileSharePermissions] [-NoAzureADLookup] [-NoLogFile] [-ReplaceInvalidCharacters] - [<CommonParameters>] -``` - - -## DESCRIPTION -Cmdlet to create a new migration package based on source files in a local or network shared folder. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg - -New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg -TargetWebUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -TargetDocumentLibraryPath "Shared Documents" -TargetDocumentLibrarySubFolderPath "Sub Folder/Target Folder" -``` -This example creates a new set of migration source package metadata files, using default URL values, in the d:\MigrationPackages\Folder1_SrcPkg directory based on content files found in the \\fileserver\share\folder1 source location. - - -### -----------------------EXAMPLE 2----------------------------- -``` -New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg -TargetWebUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -TargetDocumentLibraryPath "Shared Documents" -``` -This example creates a new set of migration source package metadata files in the d:\MigrationPackages\Folder1_SrcPkg directory based on content files found in the \\fileserver\share\folder1 source location. The package is prepared using the document library path “https://contoso.sharepoint.com/sites/TargetSite/TargetWeb/Shared Documents”. - - -## PARAMETERS - -### -IgnoreHidden -Switch to ignore hidden files and folders. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeFileSharePermissions -Used to include permissions and sharing information into the generated manifest files in the package metadata. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoAzureADLookup -Switch to not lookup local user accounts in Azure Active Directory. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Used to not create a log file. The default is to create a new CreateMigrationPackage log file within the directory specified within the OutputPackagePath parameter. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPackagePath -The directory location where the output package metadata files will be saved. If the directory does not exist, it will be created. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplaceInvalidCharacters -Switch to replace characters in file and folder names that would be invalid in SharePoint Online. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilesPath -The directory location where the source content files exist. This directory will be enumerated to create the package metadata files. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibraryPath -The web relative document library to use as the document library part of the base URL in the package metadata. If this is not supplied, “Documents” will be used within the package metadata instead. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibrarySubFolderPath -Specifies the document library relative subfolder to use as the folder path part of the base URL in the package metadata. If this is not provided, no value will be used within the package metadata. The files will be homed under the document library root. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -The fully qualified web URL to use as the web address part of the base URL in the package metadata. If this is not provided, “http://fileserver/sites/user” will be used instead within the package metadata. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md deleted file mode 100644 index 7613850773..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: New-SPOPublicCdnOrigin -schema: 2.0.0 ---- - -# New-SPOPublicCdnOrigin - -## SYNOPSIS -Creates a new public CDN on a document library in your Sharepoint Online Tenant - - -## SYNTAX - -```powershell -New-SPOPublicCdnOrigin [-Url] <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -This Cmdlet creates a new Public CDN Origin in your SPO Tenant - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -New-SPOPublicCdnOrigin –URL https://contoso.sharepoint.com/sites/CDN/CDNFilesLibrary/ -``` - -This example shows how to you can setup a new Public CDN on a document library in your SharePoint online tenant. - - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specify the URL that will be enabled for Public CDN in your tenant - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## NOTES - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOPublicCdnOrigins](Get-SPOPublicCdnOrigins.md) - -[Remove-SPOPublicCdnOrigin](Remove-SPOPublicCdnOrigin.md) - - - - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md deleted file mode 100644 index f0fdcad934..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: New-SPOSdnProvider -schema: 2.0.0 ---- - -# New-SPOSdnProvider - -## SYNOPSIS -Adds a new Software-Defined Networking (SDN) provider - - -## SYNTAX - -```powershell -New-SPOSdnProvider [-Identity] <String> [-License] <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -This Cmdlet creates a new Software-Defined Networking, and it receives two parameters, the Identity (ID) of the Hive and the License key of the Hive. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -New-SPOSdnProvider -ID "Hive" -License "<Hive license key>" -``` - -This example creates the Hive for a SDN Provider. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -License -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - - -[Remove-SPOSdnProvider](Remove-SPOSdnProvider.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md deleted file mode 100644 index 69ae371f2b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: New-SPOSite -schema: 2.0.0 ---- - -# New-SPOSite - -## SYNOPSIS -Creates a new SharePoint Online site collection for the current company. - - -## SYNTAX - -``` -New-SPOSite [-CompatibilityLevel <Int32>] [-LocaleId <UInt32>] [-NoWait] -Owner <String> - [-ResourceQuota <Double>] -StorageQuota <Int64> [-Template <String>] [-TimeZoneId <Int32>] [-Title <String>] - -Url <UrlCmdletPipeBind> [<CommonParameters>] -``` - - -## DESCRIPTION -The `New-SPOSite` cmdlet creates a new site collection for the current company. -However, creating a new SharePoint Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -New-SPOSite -Url http://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy@contoso.com -StorageQuota 1000 -Title "My new site collection" -``` - -Example 1 creates a new site collection for the current company with specified site URL, title and owner. The storage quota is set to 1000 megabytes. - -### -----------------------EXAMPLE 2----------------------------- -``` -New-SPOSite -Url http://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy@contoso.com -StorageQuota 1000 -CompatibilityLevel 15 -LocaleID 1033 -ResourceQuota 300 -Template "STS#0" -TimeZoneId 13 -Title "My new site collection" -``` - -Example 2 creates a new site collection for the current company with specified site URL, title, owner and template. The storage quota is set to 1000 megabytes and the resource quota is set to 300 megabytes. The template compatibility level is set to 15 which means that the site collection only supports the SharePoint 2013 template. The language is set to English - United States (LocaleID = 1033) and the time zone is set to (GMT-08:00) Pacific Time (US and Canada) (TimeZone = 13). - -### -----------------------EXAMPLE 3----------------------------- -``` -New-SPOSite -Url https://contoso.sharepoint.com/sites/accounting -Owner admin@contoso.com -StorageQuota 100 -NoWait -ResourceQuota 50 -Template STS#0 -``` - -Example 3 creates a new site collection for the current company with specified site URL, owner and template. The storage quota is set to 100 megabytes and the resource quota is set to 50 megabytes. This cmdlet is executed immediately without delay. - - -## PARAMETERS - -### -CompatibilityLevel -Specifies the version of templates to use when you are creating a new site collection. This value sets the initial CompatibilityLevel value for the site collection. The values for this parameter can be SharePoint Server. When this parameter is not specified, the CompatibilityLevel will be by default the highest possible version for the Web application. - -> [!NOTE] -> For SharePoint Online Preview, it can only be set to "14" or "15". "14" indicates SharePoint 2010 Products, "15" indicates SharePoint 2013. Other values are not valid and will cause error. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocaleId -Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft (https://go.microsoft.com/fwlink/p/?LinkId=242911). The Template and LocaleId parameters must be a valid combination as returned from the `Get-SPOWebTemplate` cmdlet. - - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Specifies to continue executing script immediately. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the user name of the site collection’s primary owner. The owner must be a user instead of a security group or an email-enabled security group. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceQuota -Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company’s aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint (https://msdn.microsoft.com/en-us/library/gg615462.aspx). - - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuota -Specifies the storage quota for this site collection in megabytes. This value must not exceed the company’s available quota. - - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the site collection template type. Use the `Get-SPOWebTemplate` cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the `Get-SPOWebTemplate` cmdlet. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZoneId -Specifies the time zone of the site collection. For more information, see SPRegionalSettings.TimeZones Property (https://go.microsoft.com/fwlink/p/?LinkId=242912). - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Specifies the title of the site collection. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the full URL of the new site collection. It must be in a valid managed path in the company’s site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams. - - -```yaml -Type: UrlCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOSite](Get-SPOSite.md) - -[Set-SPOSite](Set-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md deleted file mode 100644 index b2d8921cb6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: New-SPOSiteGroup -schema: 2.0.0 ---- - -# New-SPOSiteGroup - -## SYNOPSIS -Creates a new group in a SharePoint Online site collection. - - -## SYNTAX - -``` -New-SPOSiteGroup -Group <String> -PermissionLevels <String[]> -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -A SharePoint group is a set of individual users. -SharePoint groups enable you to manage sets of users instead of individual users. - -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Group "Project Leads" -PermissionLevels "Full Control" -``` - -This example creates a group named Project Leads with the Full Control permission level on the site collection https://contoso.sharepoint.com/sites/siteA. - -### -----------------------EXAMPLE 2----------------------------- -``` -New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/marketing -Group "NewGroupName" -PermissionLevels "Design" -``` -This example creates a group named NewGroupName with the Design permission level on the site collection https://contoso.sharepoint.com/sites/marketing. - - -## PARAMETERS - -### -Group -Specifies the name of the group to add. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevels -Specifies the permission levels to grant to the newly created group. It can be any permission level that exists on the site collection on which the group is being created. - -> [!NOTE] -> Permission levels are defined by SharePoint Online administrators in the SharePoint Online Administration Center. - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection to add the group to. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[New-SPOSite](New-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md deleted file mode 100644 index a69dd7c5af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy - -## SYNOPSIS -Creates a new SharePoint Online management Application Proxy Name - - - -## SYNTAX - -``` -New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] -Name <String> - -OnlineTenantUri <String> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This Cmdlet is used to create a new Application Proxy name, for example usually when you run [this script](https://www.microsoft.com/en-us/download/confirmation.aspx?id=51490) you onboard your SharePoint Online (SPO) tenant and your SharePoint server cloud SSA to cloud hybrid search. - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy -Name $SPO_MANAGEMENT_APPPROXY_NAME -OnlineTenantUri $PortalUrl -DefaultProxyGroup -``` -Found the proxies for the tenant on the variable $PortalUrl on the Default Proxy Group. - - -## PARAMETERS - -### -AssignmentCollection -After the creation of the new Principal Management Service Application proxy assign it to the collection. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Search Proxies on the default Proxy Group - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -SPO Management AppProxy Name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlineTenantUri -Define the online Tenant URI. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## RELATED LINKS -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) - -[Full Download to Hybrid Scripts](https://www.microsoft.com/en-us/download/confirmation.aspx?id=51490) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md deleted file mode 100644 index 7c61e1d75d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Register-SPOHubSite -schema: 2.0.0 ---- - -# Register-SPOHubSite - -## SYNOPSIS -Enables the hub site feature on a site to make it a hub site. - - -## SYNTAX - -``` -Register-SPOHubSite - -Site <SpoSitePipeBind> - -Principals <string[]> - [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to register an existing site collection as a hub site. - -> [!IMPORTANT] -> A maximum of 100 hub sites may be created per tenant, with 'unlimited' number of site collections associated to a hub site. - -## EXAMPLES - -### Example 1 - -``` -Register-SPOHubSite https://contoso.sharepoint.com/sites/Marketing -Principals $null -``` - -This example registers the marketing site on Contoso as hub site without setting any principals for it. - -## PARAMETERS - -### -Site -Specifies the URL of the site collection to which to enable the hub site features. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals -Specifies One or more principles (user or group) to be granted rights to the specified HubSite. Can be used to filter who can associate sites to this hub site. - -```yaml -Type: string[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## NOTES - -If the site doesn’t exist, this cmdlet returns a “File not found” error. - -If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error. - -If the site is already associated with another hub site, this cmdlet returns a "This site is currently associated with a HubSite" error. You'll need to run the [Remove-SPOHubSiteAssociation](Remove-SPOHubSiteAssociation.md) cmdlet first before you can make the site a hub site. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md deleted file mode 100644 index bacdc46e13..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Remove-SPODataConnectionSetting -schema: 2.0.0 ---- - -# Remove-SPODataConnectionSetting - -## SYNOPSIS -Removes a Business Connectivity Services connection. - - -## SYNTAX - -### Identity -``` -Remove-SPODataConnectionSetting [-Identity] <ODataConnectionSettings> - -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -### Name -``` -Remove-SPODataConnectionSetting -ServiceContext <SPServiceContextPipeBind> -Name <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Remove-SPODataConnectionSetting` cmdlet to remove a Business Connectivity Services connection for a particular Business Connectivity Services service application in the farm. - -The metadata object associated with the Business Connectivity Services connection is also deleted. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Remove-SPODataConnectionSetting -ServiceContext "http://contoso/" -Name "ContosoServiceApp" -``` - -This example removes the Business Connectivity Services connection named ContosoServiceApp. -Metadata properties are also removed. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Remove-SPODataConnectionSetting -ServiceContext "http://contoso/" -Name "ContosoServiceApp-metadata" -``` - -This example removes the Business Connectivity Services connection metadata named ContosoServiceApp. - -The associated Business Connectivity Services connection object is also removed. - - -### -----------------------EXAMPLE 3----------------------------- -``` -$ConnectionVariable = Get-SPODataConnectionSettingMetadata -ServiceContext http://contoso -Name "ContosoServiceApp" - -Remove-SPODataConnectionSetting -Identity $ConnectionVariable -ServiceContext "http://contoso/" -``` - -This example removes the Business Connectivity Services and its associated metadata connection named ContosoServiceApp. - - -## PARAMETERS - -### -Identity -Specifies the OData Connection Settings object. - -```yaml -Type: ODataConnectionSettings -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the existing Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSetting](Get-SPODataConnectionSetting.md) - -[New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) - -[Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md deleted file mode 100644 index a65e49aba6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPODeletedSite -schema: 2.0.0 ---- - -# Remove-SPODeletedSite - -## SYNOPSIS -Removes a SharePoint Online deleted site collection from the Recycle Bin. - - -## SYNTAX - -``` -Remove-SPODeletedSite [-Confirm] -Identity <SpoSitePipeBind> [-NoWait] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPODeletedSite` cmdlet permanently removes a SharePoint Online deleted site collection from the Recycle Bin. - -You have to be a SharePoint Online global administrator and site collection administrator permissions to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -Remove-SPODeletedSite -Identity https://contoso.sharepoint.com/sites/sitetoremove -``` -This example removes a SharePoint Online deleted site collection named https://contoso.sharepoint.com/sites/sitetoremove from the Recycle Bin and deletes it permanently. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the URL of the site collection to remove. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Remove-SPOSite](Remove-SPOSite.md) - -[Get-SPODeletedSite](Get-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOExternalUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOExternalUser.md deleted file mode 100644 index 83c38bd9af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOExternalUser.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOExternalUser -schema: 2.0.0 ---- - -# Remove-SPOExternalUser - -## SYNOPSIS -Removes a collection of external users from the tenancy's folder. - - -## SYNTAX - -``` -Remove-SPOExternalUser [-Confirm] -UniqueIDs <String[]> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPOExternalUser` cmdlet permanently removes a collection of external users from the tenancy's folder. - -Users who are removed lose access to all tenant resources. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -$user = Get-SPOExternalUser -Filter someone@example.com -Remove-SPOExternalUser -UniqueIDs @($user.UniqueId) -``` -This example removes a specific external user who has the address “someone@example.com”. Organization members may still see the external user name displayed in the Shared With dialog, but the external user will not be able to sign in and will not be able to access any tenant resources. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniqueIDs -Specifies an ID that can be used to identify an external user based on their Windows Live ID. - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOExternalUser](Get-SPOExternalUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md deleted file mode 100644 index 9a9153d2a1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOGeoAdministrator -schema: 2.0.0 ---- - -# Remove-SPOGeoAdministrator - -## SYNOPSIS -Removes a new SharePoint user or security Group in the current Multi-Geo Tenant. - - -## SYNTAX - -```powershell -Remove-SPOGeoAdministrator [-LoginName] <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains a single parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -The `Remove-SPOGeoAdministrator` cmdlet matches a user or a security group and remove the GeoAdministrator privilegies in the SharePoint Organization. - -You must be a SharePoint Online global administrator and you must have a Multi-Geo Tenant to run the `Get-SPOGeoAdministrator` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - - - -## EXAMPLES - -### Example 1 -```powershell -Remove-SPOGeoAdministrator contosoadmin [-LoginName] <String> -``` -Remove the GeoAdministrator privilegies to the user contosoadmin of the SharePoint Online multi-geo tenant. - -### Example 2 -```powershell -Remove-SPOGeoAdministrator -LoginName contosoadmin -``` -Same as example 1, but using the LoginName parameter. - -## PARAMETERS - -### -LoginName -It's the user Principal Name or UPN of a user. Typically the username that he uses to log in. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -[Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md deleted file mode 100644 index 35fa0642f5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOHubSiteAssociation -schema: 2.0.0 ---- - -# Remove-SPOHubSiteAssociation - -## SYNOPSIS -Removes a site from its associated hub site. - -## SYNTAX - -``` -Remove-SPOHubSiteAssociation [-Site] <SpoSitePipeBind> -[<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to remove an association between a site and a hub site. - -> [!IMPORTANT] -> This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments. - -If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error. - -## EXAMPLES - -### Example 1 - -``` -Remove-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research -``` - -This example removes the research site from the marketing hub site. - -## PARAMETERS - -### -Site - -URL of the site to remove from the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md deleted file mode 100644 index f2c1d23999..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOMigrationJob -schema: 2.0.0 ---- - -# Remove-SPOMigrationJob - -## SYNOPSIS -Cmdlet to remove a previously created migration job from the specified site collection. - - -## SYNTAX - -``` -Remove-SPOMigrationJob [-TargetWebUrl] <String> [-JobId] <Guid> -Credentials <CredentialCmdletPipeBind> - [-NoLogFile] [<CommonParameters>] -``` - -## DESCRIPTION -Cmdlet to remove a previously created migration job from the specified site collection. - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -Remove-SPOMigrationJob -JobId 4da9e777-3e38-4804-96d9-ddeebe7dfa79 -TargetUrl https://contoso.sharepoint.com/sites/TargetSite -``` - -This example removes the specified migration job from the site collection “https://contoso.sharepoint.com/sites/TargetSite”. - - -## PARAMETERS - -### -Credentials -Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session’s previous call to `Connect-SPOService` will be used to connect to the site collection. - - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Id of a previously created migration job that exists on the target site collection. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -The fully qualified URL of the site collection where the job will be deleted if found. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md deleted file mode 100644 index bc6f58cc6f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOPublicCdnOrigin -schema: 2.0.0 ---- - -# Remove-SPOPublicCdnOrigin - -## SYNOPSIS -Removes a given public CDN origin based on its identity (id) in your Sharepoint Online Tenant - - -## SYNTAX - -```powershell -Remove-SPOPublicCdnOrigin [-Identity] <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet will remove a Public CDN Origin based on its identity. - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -#Get a list of CDN origins - -Get-SPOPublicCdnOrigins -Id Url --- --- -11270051ee79e73829f6e7a3ee5d900d49c4fc5901645c642b799ecb62787a5069ca80fb HTTPS://CONTOSO.SHAREPOINT.COM/SITES/CDN... -#then remove the CDN by Identity id GUID. -Remove-SPOPublicCdnOrigin -Identity 11270051ee79e73829f6e7a3ee5d900d49c4fc5901645c642b799ecb62787a5069ca80fb -``` - - -This example returns a list of CDN origins and then removes an origin based on the identity. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -It's the unique identificator of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -[New-SPOPublicCdnOrigin](New-SPOPublicCdnOrigin.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md deleted file mode 100644 index e11799970e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOSdnProvider -schema: 2.0.0 ---- - -# Remove-SPOSdnProvider - -## SYNOPSIS -Removes Software-Defined Networking (SDN) Support in your SharePoint Online tenant - - -## SYNTAX - -```powershell -Remove-SPOSdnProvider [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Removes SDN Support in your SharePoint Online tenant - - -## EXAMPLES - -### EXAMPLE 1 -```yaml -Remove-SPOSdnProvider -Confirm:false -``` - -This command removes the SDN support for your Online Tenant without confirmation. - -### -----------------------EXAMPLE 2----------------------------- -```yaml -Remove-SPOSdnProvider -Confirm:true -WhatIf -``` - -This command will prompt for a confirmation before "simulating" that it will remove the support for SDN in the current SPO tenant (-WhatIf) - - - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[New-SPOSdnProvider](New-SPOSdnProvider.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md deleted file mode 100644 index e4d4f12d6a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOSite -schema: 2.0.0 ---- - -# Remove-SPOSite - -## SYNOPSIS -Sends a SharePoint Online site collection to the SharePoint Online Recycle Bin. - - -## SYNTAX - -``` -Remove-SPOSite [-Confirm] -Identity <SpoSitePipeBind> [-NoWait] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPOSite` cmdlet does not delete a site collection from the site collections list permanently. -Instead, the removed site collection is moved to the Recycle Bin. -You can use the `Restore-SPODeletedSitecmdlet` to restore a site collection from the Recycle Bin. -To delete a site collection permanently, first move the site collection to the Recycle Bin by using the `Remove-SPOSite` cmdlet and then delete it from the Recycle Bin by using the `Remove-SPODeletedSite` cmdlet. - -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Remove-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -NoWait -``` - -This example immediately removes the site collection named https://contoso.sharepoint.com/sites/site1 from the site collections list and moves it to the Recycle Bin. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the URL of the site collection to remove. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -Specifies to continue executing script immediately. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Remove-SPODeletedSite](Remove-SPODeletedSite.md) - -[Restore-SPODeletedSite](Restore-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md deleted file mode 100644 index 5be91c318d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOSiteDesign -schema: 2.0.0 ---- - -# Remove-SPOSiteDesign - -## SYNOPSIS - -Removes a site design. It no longer appears in the UI for creating a new site. - -## SYNTAX - -```powershell - Remove-SPOSiteDesign - [-Identity] <SPOSiteDesignPipeBind> - [<CommonParameters>] -``` - -## DESCRIPTION - -Removes a site design. It no longer appears in the UI for creating a new site. - -## EXAMPLES - -### Example 1 - -This example shows how to remove a site design. - -```powershell -Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a -``` - - -## PARAMETERS - -### -Identity -The ID of the site design to remove. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md deleted file mode 100644 index 83f2f8395e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -applicable: SharePoint Online -title: Remove-SPOSiteDesignTask -schema: 2.0.0 ---- - -# Remove-SPOSiteDesignTask - -## SYNOPSIS - -Command to remove a scheduled site design script. - -## SYNTAX - -```powershell -Remove-SPOSiteDesignTask - -Identity <guid> - [<CommonParameters>] -``` - -## DESCRIPTION - -Removes a scheduled site design by providing the site design ID. If the execution of the associated site script has already started the execution will not be terminated. - -> [!NOTE] -> This command only removes a scheduled request. To check on the job status or to view details of the scheduled run, use the commands in the related section below. - -## EXAMPLES - -### Example 1 - -This example removes a previously scheduled site design. - -```powershell -Remove-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -``` - -## PARAMETERS - -### -Identity -The ID of the site design to apply. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## RELATED LINKS - -[Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md) - -[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) - -[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md deleted file mode 100644 index 5de9077287..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOSiteGroup -schema: 2.0.0 ---- - -# Remove-SPOSiteGroup - -## SYNOPSIS -Removes a SharePoint Online group from a site collection. - - -## SYNTAX - -``` -Remove-SPOSiteGroup -Identity <String> -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPOSiteGroup` cmdlet to remove a group from a site collection by specifying the name of the group in the Identity parameter. - -You must be a SharePoint Online global administrator and a site collection administrator to run the `Remove-SPOSiteGroup` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -Remove-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/marketing -Identity GroupToRemove -``` -This example removes a group named GroupToRemove from the site collection https://contoso.sharepoint.com/sites/marketing. - - -## PARAMETERS - -### -Identity -Specifies the name of the group to remove. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection to remove the group from. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOSiteGroup](Get-SPOSiteGroup.md) - -[New-SPOSiteGroup](New-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md deleted file mode 100644 index 51e52d4d15..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOSiteScript -schema: 2.0.0 ---- - -# Remove-SPOSiteScript - -## SYNOPSIS - -Removes a site script. - -## SYNTAX - -```powershell -Remove-SPOSiteScript - [-Identity] <SPOSiteScriptPipeBind> - [<CommonParameters>] -``` - -## EXAMPLES - -### Example 1 - -This example shows how to remove a site design. - -```powershell -Remove-SPOSiteScript 5ea28194-6fe7-4e2c-ba84-c409368278e2 -``` - -## DESCRIPTION - -Removes a site script. - -## PARAMETERS - -### -Identity -The ID of the site script to remove. - -```yaml -Type: SPOSiteScriptPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md deleted file mode 100644 index 0675d4d2cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOTenantCdnOrigin -schema: 2.0.0 ---- - -# Remove-SPOTenantCdnOrigin - -## SYNOPSIS -Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions. - - -## SYNTAX - -``` -Remove-SPOTenantCdnOrigin -CdnType <SPOTenantCdnType> [-Confirm] -OriginUrl <String> [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Removes a new origin from the Public or Private content delivery network (CDN). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Remove-SPOTenantCdnOrigin -CdnType Public -OriginScope Tenant -OriginUrl sites/pubsite/siteassets/subfolder -``` - -The example removes a CDN from a tenant level. - -### -----------------------EXAMPLE 2----------------------------- -``` -Remove-SPOTenantCdnOrigin -CdnType Public -OriginScope Site -Site https://contoso.sharepoint.com/sites/pubsite -OriginUrl siteassets/subfolder -``` - -The example removes a CDN from a site level. - - -## PARAMETERS - -### -CdnType -Specifies the CDN type. The valuid values are: Public or Private. - - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginUrl -Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. - -Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library. - -Any asset stored under the path provided (in the container itself or any of its subfolders) will be exposed via CDN - -Mask - Mask allows to configure a partial URL match. It must start with */, and must not include * anywhere else. I.e. an origin “*/masterpates” will expose all the assets under all the masterpages libraries, either under the tenant root (means, anywhere in the tenancy) or in the given site collection, depends on the OriginScope parameter. Equally, */masterpages/subfolder will enable items in “subfolder” and below. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md deleted file mode 100644 index 11dcbbccb0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOTenantSyncClientRestriction -schema: 2.0.0 ---- - -# Remove-SPOTenantSyncClientRestriction - -## SYNOPSIS -Disables the feature for the tenancy. - - -## SYNTAX - -``` -Remove-SPOTenantSyncClientRestriction [<CommonParameters>] -``` - -## DESCRIPTION - -You must be a SharePoint Online global administrator to run the cmdlet. - -Requires a valid `Connect-SPOService` context to identify the tenant. For information on how to connect to the tenant, see `Connect-SPOService`. - -The `Remove-SPOTenantSyncClientRestriction` cmdlet disables the feature for tenancy, but does not remove any present domain GUID entries from the safe sender recipient list. After the `Remove-SPOTenantSyncClientRestriction` cmdlet is run it can take up to 24 hours for change to take effect. This parameter will also remove any values set from the GrooveBlockOption parameter for syncing. - -The `Remove-SPOTenantSyncClientRestriction` cmdlet does not have any parameters. - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -Remove-SPOTenantSyncClientRestriction -``` -This example returns  the value of False for the TenantRestrictionEnabled property. - - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md deleted file mode 100644 index b41cb9786c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOTheme -schema: 2.0.0 ---- - -# Remove-SPOTheme - -## SYNOPSIS - -Removes a theme from the theme gallery. - -## DESCRIPTION - -The **Remove-SPOTheme** cmdlet removes a theme from your tenant store. - -## EXAMPLES - -### Example 1 - -This example removes the `"Custom Cyan"` theme that was used in the previous examples for the **Add-SPOTheme** and **Get-SPOTheme** cmdlets. - -``` -Remove-SPOTheme -Name "Custom Cyan" -``` - -## INPUTS - -## OUTPUTS - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md deleted file mode 100644 index 26623d770b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOUser -schema: 2.0.0 ---- - -# Remove-SPOUser - -## SYNOPSIS -Removes a user or a security group from a site collection or a group. - - -## SYNTAX - -``` -Remove-SPOUser [-Group <String>] -LoginName <String> -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -You must be a SharePoint Online global administrator and a site collection administrator to run the `Remove-SPOUser` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -Remove-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@contoso.com -Group "SC1 Owners" -``` -This example removes a user who has the email address joe.healy@contoso.com from the group SC1 Owners in the site collection https://contoso.sharepoint.com/sites/sc1. - - -## PARAMETERS - -### -Group -Specifies the group to remove the user from. If not specified, the cmdlet removes the user from all groups. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName -Specifies the user name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection to remove the user from. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOUser](Get-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md deleted file mode 100644 index 25fd6290d3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOUserInfo -schema: 2.0.0 ---- - -# Remove-SPOUserInfo - -## SYNOPSIS -Removes user from user information list of specific site collection. - -## SYNTAX - -``` -Remove-SPOUserInfo -LoginName <String> -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Can be used to remove user from user information lists of the specific site collections. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Remove-SPOUserInfo -LoginName joe.healy@contoso.com -Site https://contoso.sharepoint.com/sites/sc1 -``` -Example 1 removes a user who has the e-mail address joe.healy@contoso.com from the user ifnoramtion list of https://contoso.sharepoint.com/sites/sc1 site collection. - -## PARAMETERS - -### -LoginName -Specifies the login name of the user to removed from user information list. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the URL of the site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPOUserProfile](Remove-SPOUserProfile.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md deleted file mode 100644 index d1599ea999..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Remove-SPOUserProfile -schema: 2.0.0 ---- - -# Remove-SPOUserProfile - -## SYNOPSIS -Remove user profile from the tenant. - -## SYNTAX - -``` -Remove-SPOUserProfile -LoginName <String> [<CommonParameters>] -``` - -## DESCRIPTION -Can be used to remove the SharePoint user profile from the tenant. - -> [!NOTE] -> The User must be first be deleted from AAD before the user profile can be deleted. You can use the Azure AD cmdlet Remove-AzureADUser for this action - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -Remove-SPOUserProfile -LoginName joe.healy@contoso.com -``` -Example 1 removes a user who has the e-mail address joe.healy@contoso.com from the SharePoint Online User Profiles of the particular tenant. - - -## PARAMETERS - -### -LoginName -Specifies the login name of the user which user profile is deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPOUserInfo](Remove-SPOUserInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md deleted file mode 100644 index 548e478338..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Repair-SPOSite -schema: 2.0.0 ---- - -# Repair-SPOSite - -## SYNOPSIS -Checks and repairs the site collection and its contents. - - -## SYNTAX - -``` -Repair-SPOSite [-Confirm] -Identity <SpoSitePipeBind> [-RuleId <Guid>] [-RunAlways] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Repair-SPOSite` cmdlet runs one or all site collection health checks on the site collection and its contents. -This cmdlet will make changes if issues are found and automatically repairable. - -The cmdlet reports the health check rules with a summary of the results. -The rules might not support automatic repair. -Tests without repair mode can be initiated by running the `Test-SPOSite` cmdlet. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Repair-SPOSite https://contoso.sharepoint.com/sites/marketing -``` - -This example runs all the site collection health checks in repair mode on the https://contoso.sharepoint.com/sites/marketing site collection. - -### -----------------------EXAMPLE 2----------------------------- -``` -Repair-SPOSite https://contoso.sharepoint.com/sites/marketing -RuleID "ee967197-ccbe-4c00-88e4-e6fab81145e1" -``` - -This example runs the Missing Galleries Check rule in repair mode on the https://contoso.sharepoint.com/sites/marketing site collection. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the SharePoint Online site collection on which to run the repairs. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RuleId -Specifies a health check rule to run. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunAlways -Displays a message that explains the effect of the command instead of executing the command. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Test-SPOSite](Test-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md deleted file mode 100644 index 4e4dd29c17..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Request-SPOPersonalSite -schema: 2.0.0 ---- - -# Request-SPOPersonalSite - -## SYNOPSIS -Requests that one or more users be enqueued for a Personal Site to be created. - - -## SYNTAX - -``` -Request-SPOPersonalSite [-NoWait] -UserEmails <String[]> [<CommonParameters>] -``` - -## DESCRIPTION -The `Request-SPOPersonalSite` cmdlet requests that the users specified be enqueued so that a Personal Site be created for each. The actual Personal site is created by a Timer Job later. - -> [!NOTE] -> You must specify a string array of user logins that contains one or more valid user email (logins) and cannot contain any empty fields. The command will stop if it encounters any empty strings in the array. A maximum of 200 users can be specified. - -> [!NOTE] -> The actor executing this cmdlet must be at least assigned the SharePoint Online administrator role and have been assigned a SharePoint Online license to be able to provision the OneDrive for Business sites. - -> [!NOTE] -> This commandlet is NOT OneDrive Multi-Geo aware. If you need to request Personal Sites for Multi-Geo enabled tenants, you must run this commandlet for users in the region their data is to be hosted in. To retrieve users with a specific PDL, use the following sample: -get-MSOLUser | Where {$_.PreferredDataLocation -eq "EUR"] - -## EXAMPLES - -### ----------------------EXAMPLE 1----------------------- -``` -$emails = "user1@contoso.com", "user2@contoso.com" -Request-SPOPersonalSite –UserEmails $emails -``` - -This example requests that two users to be enqueued for the creation of a Personal Site. - -### ----------------------EXAMPLE 2----------------------- -``` -Request-SPOPersonalSite –UserEmails $emails -``` -This example requests that many users to be queued for the creation of a Personal Site. The users are previously defined using the variable $emails. - - -## PARAMETERS - -### -NoWait -Continues without the status being polled. Polling the action can slow it’s progress if lots of user emails are specified. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserEmails -Specifies one or more user logins to be enqueued for the creation of a Personal Site. The Personal site is created by a Timer Job later. You can specify between 1 and 200 users. - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md deleted file mode 100644 index 736857417c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Request-SPOUpgradeEvaluationSite -schema: 2.0.0 ---- - -# Request-SPOUpgradeEvaluationSite - -## SYNOPSIS -Requests to create a copy of an existing site collection for the purposes of validating the effects of upgrade without affecting the original site. - - -## SYNTAX - -``` -Request-SPOUpgradeEvaluationSite [-Confirm] -Identity <SpoSitePipeBind> [-NoEmail] [-NoUpgrade] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Request-SPOUpgradeEvaluationSite` cmdlet lets the SharePoint Online global administrator request a copy of an existing site collection for the purposes of validating the effects of upgrade without affecting the original site. - -A request for an upgrade evaluation site is not automatically processed. -Instead, it is scheduled to occur on the background when it causes the least effect on the service. - -You must be a SharePoint Online global administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Request-SPOUpgradeEvaluationSite http://contoso.sharepoint.com/sites/marketing -``` -Example 1 requests a site upgrade evaluation for the marketing site http://contoso.sharepoint.com/sites/marketing using the default options of sending an email message and automatically trying to upgrade the evaluation site. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Request-SPOUpgradeEvaluationSite http://contoso.sharepoint.com/sites/marketing -NoEmail $true -NoUpgrade $true -``` -This example requests a site upgrade evaluation for the marketing site http://contoso.sharepoint.com/sites/marketing. It specifies to not send email messages and not automatically try upgrade of the evaluation site. By using the cmdlet in this way, a SharePoint Online global administrator can make changes to the upgrade evaluation site before starting the actual upgrade. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the SharePoint Online site collection for which you want to request a copy for the new Upgrade or Evaluation site collection. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoEmail -Specifies that the system not send the requester and site collection administrators an email message at the end of the upgrade evaluation site creation process. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoUpgrade -Specifies that the system not perform an upgrade as part of the evaluation site creation process. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Upgrade-SPOSite](Upgrade-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md deleted file mode 100644 index 2498c581cf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Restore-SPODeletedSite -schema: 2.0.0 ---- - -# Restore-SPODeletedSite - -## SYNOPSIS -Restores a SharePoint Online deleted site collection from the Recycle Bin. - - -## SYNTAX - -``` -Restore-SPODeletedSite -Identity <SpoSitePipeBind> [-NoWait] [<CommonParameters>] -``` - -## DESCRIPTION -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -Restore-SPODeletedSite -Identity https://contoso.sharepoint.com/sites/arecycledsite -``` -This example restores a SharePoint Online deleted site collection named "https://contoso.sharepoint.com/sites/arecycledsite" from the Recycle Bin. - - -## PARAMETERS - -### -Identity -Specifies the URL of the site collection to restore. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -Specifies to continue executing script immediately. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPODeletedSite](Get-SPODeletedSite.md) - -[Remove-SPODeletedSite](Remove-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md deleted file mode 100644 index abedebc951..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Revoke-SPOHubSiteRights -schema: 2.0.0 ---- - -# Revoke-SPOHubSiteRights - -## SYNOPSIS -Revokes rights for specified principals to a hub. - -## SYNTAX - -``` -Revoke-SPOHubSiteRights [-Identity] <SpoHubSitePipeBind> -Principals - <string[]> [<CommonParameters>] -``` - -## DESCRIPTION -Revokes rights for specified principals to the given hub site. The specified principals will no longer be able to associate sites with the hub. To find which principals have access to a hub site, use the [Get-SPOHubSite](Get-SPOHubSite.md) cmdlet. - -If the hub site doesn’t exist, this cmdlet returns a “File not found” error. - -## EXAMPLES - -### Example 1 - -``` -Revoke-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing ` --Principals "nestorw@contoso.onmicrosoft.com" -``` - -This example shows how to revoke rights so that Nestor can no longer join sites to the Marketing hub site. - -## PARAMETERS - -### -Identity - -URL of the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: HubSite -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals - -One or more principles to add permissions for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md deleted file mode 100644 index 490c2e789a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Revoke-SPOSiteDesignRights -schema: 2.0.0 ---- - -# Revoke-SPOSiteDesignRights - -## SYNOPSIS - -Revokes rights for specified principals from a site design. - -## SYNTAX - -```powershell -Revoke-SPOSiteDesignRights - [-Identity] <SPOSiteDesignPipeBind> - -Principals <string[]> - [<CommonParameters>] -``` - -## DESCRIPTION - -Revokes rights for specified principals from a site design. - -## EXAMPLES - -### Example 1 - -This example shows how to revoke rights to a site design for Nestor. - -```powershell -Revoke-SPOSiteDesignRights 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Principals "nestorw@contoso.onmicrosoft.com" -``` - - -## PARAMETERS - -### -Identity -The ID of the site design from which to revoke rights. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals -One or more principals to revoke rights on the specified site design. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md deleted file mode 100644 index 0720cd8f11..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -schema: 2.0.0 ---- -# Revoke-SPOTenantServicePrincipalPermission - -## SYNOPSIS - -Revokes a permission that was previously granted to the "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Revoke-SPOTenantServicePrincipalPermission -ObjectId <String> -``` - -## DESCRIPTION - -Revokes a permission that was previously granted to the "SharePoint Online Client" service principal. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -$grants = Get-SPOTenantServicePrincipalPermissionGrants -$grantToRemove = $grants | ? { $_.Resource -eq 'Office 365 SharePoint Online' -and $_.Scope -eq 'MyFiles.Read' } | Select-Object -First 1 - -if ($grantToRemove -ne $null) -{ - Revoke-SPOTenantServicePrincipalPermission -ObjectId $grantToRemove.ObjectId -} -``` - -Revokes the permission associated with the 'Office 365 SharePoint Online' resource and with scope claim 'MyFiles.Read'. -If there is no permission with those properties, then no revoke action will be taken. - -## PARAMETERS - -### -ObjectId - -The Object ID of the permission grant to revoke - -```yaml -Type: string - -Required: True -Position: Named -Accept pipeline input: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md deleted file mode 100644 index 4f0b5ebdaf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Revoke-SPOUserSession -schema: 2.0.0 ---- - -# Revoke-SPOUserSession - -## SYNOPSIS -Provides IT administrators the ability to invalidate a particular users' O365 sessions across all their devices. - - -## SYNTAX - -``` -Revoke-SPOUserSession [-User] <String> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -You must be a SharePoint Online global administrator to run the cmdlet. - -Requires a valid `Connect-SPOService` context to identify the tenant. For information about how to connect to the tenant, see `Connect-SPOService`. - -When the cmdlet is ran the following will occur: - -User will be signed out of browser, desktop and mobile applications accessing Office 365 resources across all devices. - -Will not be applicable for guest users. - -Possible results for this cmdlet are: - -Results Reason - -Warning : We couldn't find the user@contoso.com. Check for typos and try again. Invalid input for -User parameter. - -We successfully signed out <user> from all devices. Successful instantaneous revocation. - -It can take up to an hour to sign out <user> from all devices. Successful non-instantaneous revocation. - -Sorry, something went wrong and we couldn't sign out <user> from any device. The cmdlet did not successfully execute. - -The cmdlet will be available in the future, but it isn't ready for use in your organization yet. The cmdlet has been disabled for the tenant. - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -Revoke-SPOUserSession -User user1@contoso.com -``` -This example signs out user1 in the contoso tenancy from all devices. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -Specifies a user name. For example, user1@contoso.com - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPObjectSecurity.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPObjectSecurity.md deleted file mode 100644 index a1a057f2d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPObjectSecurity.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Revoke-SPObjectSecurity -schema: 2.0.0 ---- - -# Revoke-SPObjectSecurity - -## SYNOPSIS -Removes a security principal from a SPObjectSecurity object. - - -## SYNTAX - -### RevokeOne -``` -Revoke-SPObjectSecurity [-Identity] <SPObjectSecurity> [-Principal] <SPClaim> [[-Rights] <String[]>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### RevokeAll -``` -Revoke-SPObjectSecurity [-Identity] <SPObjectSecurity> [-All] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -The `Revoke-SPObjectSecurity` cmdlet to remove a security principal, such as a user, from a SPObjectSecurity object. -An SPObjectSecurity object is a common object that is used to represent the security access control list (ACL) of SharePoint administrative objects, in particular service applications. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -$security = Get-SPServiceApplicationSecurity $serviceApp -Admin -Revoke-SPObjectSecurity $security "domain\user" -Set-SPServiceApplicationSecurity $serviceApp -Admin $security -``` - -This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and removes a user from that ACL. -The removed an administrator for the service application $serviceApp. - - -## PARAMETERS - -### -Identity -Specifies the SPObjectSecurity object from which the security principal is removed. -You can use the `Get-SPServiceApplicationSecurity` cmdlet to get a SPObjectSecurity object . - -```yaml -Type: SPObjectSecurity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Principal -Specifies the principal for whom the rights are removed. - -The type must a valid name a principal; for example, Full Control. - -```yaml -Type: SPClaim -Parameter Sets: RevokeOne -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rights -Specifies the rights of the principal to revoke. - -The type must a valid array of strings that represents the rights of the principal to revoke. - -```yaml -Type: String[] -Parameter Sets: RevokeOne -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -Specifies that all security principals are removed from the specified SPObjectSecurity object. - -```yaml -Type: SwitchParameter -Parameter Sets: RevokeAll -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md deleted file mode 100644 index 00fe93de18..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPODataConnectionSetting -schema: 2.0.0 ---- - -# Set-SPODataConnectionSetting - -## SYNOPSIS -Sets or updates global properties for a Microsoft Business Connectivity Services connection. - - -## SYNTAX - -### Identity -``` -Set-SPODataConnectionSetting [-Identity] <ODataConnectionSettings> -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <ODataAuthenticationMode>] [-Confirm] - [-ExtensionProvider <String>] [-SecureStoreTargetApplicationId <String>] [-ServiceAddressURL <Uri>] [-WhatIf] - [<CommonParameters>] -``` - -### Name -``` -Set-SPODataConnectionSetting -ServiceContext <SPServiceContextPipeBind> -Name <String> - [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <ODataAuthenticationMode>] [-Confirm] - [-ExtensionProvider <String>] [-SecureStoreTargetApplicationId <String>] [-ServiceAddressURL <Uri>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPODataConnectionSetting` cmdlet to update the properties of an existing connection for a specific Business Connectivity Services service application. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### -------------EXAMPLE 1----------- -``` -Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso/" -AuthenticationMode "PassThrough" -``` - -This example updates the properties of Business Connectivity Services connection named ContosoServiceApp. - - -### -------------EXAMPLE 2----------- -``` -$ConnectionVariable = Get-SPODataConnectionSetting -ServiceContext http://contoso -Name "ContosoServiceApp" - -Set-SPODataConnectionSetting -Identity $ConnectionVariable -AuthenticationMode "PassThrough" -``` - -This example updates the properties of the Business Connectivity Services service connection named ContosoServiceApp. - - -### -------------EXAMPLE 3----------- -``` -Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso/" -AuthenticationMode "PassThrough" -ExtensionProvider "" -``` - -This example updates the properties of Business Connectivity Services connection named ContosoServiceApp, the authentication mode has been changed and extension provider value has been cleared. - - -## PARAMETERS - -### -Identity -Specifies the OData Connection Settings object. - -```yaml -Type: ODataConnectionSettings -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object: An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the existing Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMode -Specifies the type of authentication mode that is required for the Business Connectivity Services connection. - -The value for the authentication mode is any one of the following options: - ---PassThrough ---RevertToSelf ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate ---Anonymous - -```yaml -Type: ODataAuthenticationMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionProvider -{{Fill ExtensionProvider Description}} - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStoreTargetApplicationId -Specifies the Secure Store Target Application ID. -Works in conjunction with the AuthenticationMode parameter. - -The value for the SecureStoreTargetApplicationId parameter is any one of the following options: - ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAddressURL -Specifies the URL for the OData service. -The URL does not have to be Internet facing. -This is the final destination from which data is retrieved. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSetting](Get-SPODataConnectionSetting.md) - -[New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) - -[Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md deleted file mode 100644 index 8e7c7ba7e1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPODataConnectionSettingMetadata -schema: 2.0.0 ---- - -# Set-SPODataConnectionSettingMetadata - -## SYNOPSIS -Updates properties for the metadata of a Business Connectivity Services connection. - - -## SYNTAX - -### Identity -``` -Set-SPODataConnectionSettingMetadata [-Identity] <ODataConnectionSettings> - -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-AuthenticationMode <ODataAuthenticationMode>] [-Confirm] [-SecureStoreTargetApplicationId <String>] - [-ServiceAddressMetadataURL <Uri>] [-WhatIf] [<CommonParameters>] -``` - -### Name -``` -Set-SPODataConnectionSettingMetadata -ServiceContext <SPServiceContextPipeBind> -Name <String> - [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <ODataAuthenticationMode>] [-Confirm] - [-SecureStoreTargetApplicationId <String>] [-ServiceAddressMetadataURL <Uri>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPODataConnectionSettingMetaData` cmdlet to update properties for a Business Connectivity Services connection for a Business Connectivity Services service application in the farm. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### --------------EXAMPLE 1------------- -``` -Set-SPODataConnectionSettingMetadata -Name "ContosoServiceApp" -ServiceContext "http://contoso/" -AuthenticationMode "PassThrough" -``` - -This example updates the authentication mode of the metadata of Business Connectivity Services connection named ContosoServiceApp. - - -### --------------EXAMPLE 2------------- -``` -$ConnectionVariable = Get-SPODataConnectionSettingMetadata -ServiceContext http://contoso -Name "ContosoServiceApp" - -Set-SPODataConnectionSettingMetadata -Identity $ConnectionVariable -AuthenticationMode "PassThrough" -``` - -This example updates the Metadata properties of the Business Connectivity Services connection named ContosoServiceApp. - - -## PARAMETERS - -### -Identity -Specifies the OData Connection Settings object. - -```yaml -Type: ODataConnectionSettings -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or an SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the existing Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMode -Specifies the type of authentication mode that the Business Connectivity Services connection requires. - -The value for the authentication mode is any one of the following options: - ---PassThrough ---RevertToSelf ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate ---Anonymous - -```yaml -Type: ODataAuthenticationMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStoreTargetApplicationId -Specifies the Secure Store Target Application ID. -Works in conjunction with the AuthenticationMode parameter. - -The value for the SecureStoreTargetApplicationId parameter is any one of the following options: - ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAddressMetadataURL -Specifies the metadata URL for the OData service. -This URL does not have to be Internet facing. -If a value is not specified for a connection, a default value is used. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSettingMetaData](Get-SPODataConnectionSettingMetaData.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md deleted file mode 100644 index e537d2f543..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOGeoStorageQuota -schema: 2.0.0 ---- - -# Set-SPOGeoStorageQuota - -## SYNOPSIS -This Cmdlet sets the Storage quota on a multi-geo tenant - - -## SYNTAX - -```powershell -Set-SPOGeoStorageQuota -GeoLocation <String> -StorageQuotaMB <Int64> [<CommonParameters>] -``` - -## DESCRIPTION -This Cmdlet sets the storage on a particular geolocation, with a specific number of MBs - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Set-SPOGeoStorageQuota -GeoLocation EASTUS -StorageQuotaMB 512 -``` - -Sets the SharePoint Online Storage Quota on the EAST US location to 512 MB. - - -## PARAMETERS - -### -GeoLocation -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuotaMB -PARAMVALUE: Int64 - - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOGeoStorageQuota](Get-SPOGeoStorageQuota.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md deleted file mode 100644 index d1a0d8798f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOHideDefaultThemes -schema: 2.0.0 ---- - -# Set-SPOHideDefaultThemes - -## SYNOPSIS - -Specifies whether the default themes should be available. - -## DESCRIPTION - -The **Set-SPOHideDefaultThemes** cmdlet is used to specify whether the default themes that come with SharePoint should be included in the theme picker list. For example, you might want to create custom themes for your sites and then remove the default themes to ensure that all pages use your custom themes. - -After creating the `"Custom Cyan"` theme, hiding the default themes leaves only the one custom theme in the themes list under **Change the look**. - -Specify the setting as either `$true` to hide the default themes, or `$false` (the default setting) to allow use of the default themes. - -Note that this cmdlet was named **Set-HideDefaultThemes** until the December 2017 release of the SPO Management Shell. We recommend that you use the latest version of the PowerShell cmdlets. - -## EXAMPLES - -### Example 1 - -In this example, the cmdlet hides the default themes. - -``` -Set-SPOHideDefaultThemes $true -``` - -### Example 2 - -In this example, the cmdlet restores the default themes to the theme picker list. - -``` -Set-SPOHideDefaultThemes $false -``` - - -## INPUTS - -## OUTPUTS - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md deleted file mode 100644 index afe8e8fe4d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOHubSite -schema: 2.0.0 ---- - -# Set-SPOHubSite - -## SYNOPSIS -Sets the hub site information such as name, logo, and description. - -## SYNTAX - -``` -Set-SPOHubSite [-Identity] <SpoHubSitePipeBind> - [-Title <string>] - [-LogoUrl <string>] - [-Description <string>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to set properties such as name, logo, and description. These properties appear for the hub in the SharePoint user interface. - -If the hub site doesn’t exist, this cmdlet returns a “File not found” error. - -## EXAMPLES - -### Example 1 - -``` -Set-SPOHubSite https://contoso.sharepoint.com/sites/Marketing ` --Title "Marketing Hub" ` --LogoUrl https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png ` --Description "Hub for the Marketing division” -``` - -This example updates the name of the hub displayed in the SharePoint user interface. It also updates the logo used in the hub navigation, and specifies an optional description for the hub. - -## PARAMETERS - -### -Identity - -URL of the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: HubSite -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -The display name of the hub. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogoUrl - -The URL of a logo to use in the hub navigation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -A description of the hub site. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md deleted file mode 100644 index 16d18a98cf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md +++ /dev/null @@ -1,342 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOMigrationPackageAzureSource -schema: 2.0.0 ---- - -# Set-SPOMigrationPackageAzureSource - -## SYNOPSIS -Cmdlet to create Azure containers, upload migration package files into the appropriate containers and snapshot the uploaded content. - - -## SYNTAX - -### ImplicitSourceExplicitAzure -``` -Set-SPOMigrationPackageAzureSource -AccountKey <String> -AccountName <String> [-AzureQueueName <String>] - [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>] [-EncryptionParameters <EncryptionParameters>] - [-FileContainerName <String>] -MigrationSourceLocations <MigrationPackageLocation> [-NoLogFile] - [-NoSnapshotCreation] [-NoUpload] [-Overwrite] [-PackageContainerName <String>] [<CommonParameters>] -``` - -### ExplicitSourceExplicitAzure -``` -Set-SPOMigrationPackageAzureSource -AccountKey <String> -AccountName <String> [-AzureQueueName <String>] - [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>] [-EncryptionParameters <EncryptionParameters>] - [-FileContainerName <String>] [-NoLogFile] [-NoSnapshotCreation] [-NoUpload] [-Overwrite] - [-PackageContainerName <String>] -SourceFilesPath <String> -SourcePackagePath <String> [<CommonParameters>] -``` - -### ImplicitSourceImplicitAzure -``` -Set-SPOMigrationPackageAzureSource [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>] - [-EncryptionParameters <EncryptionParameters>] - -MigrationPackageAzureLocations <MigrationPackageAzureLocations> - -MigrationSourceLocations <MigrationPackageLocation> [-NoLogFile] [-NoSnapshotCreation] [-NoUpload] - [-Overwrite] [<CommonParameters>] -``` - -### ExplicitSourceImplicitAzure -``` -Set-SPOMigrationPackageAzureSource [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>] - [-EncryptionParameters <EncryptionParameters>] - -MigrationPackageAzureLocations <MigrationPackageAzureLocations> [-NoLogFile] [-NoSnapshotCreation] - [-NoUpload] [-Overwrite] -SourceFilesPath <String> -SourcePackagePath <String> [<CommonParameters>] -``` - - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets. - -This cmdlet returns a Microsoft.Online.SharePoint.Migration. MigrationPackageAzureLocations object, which can be used as a source for this cmdlet or, more commonly, as a source for the `Submit-SPOMigrationJob` cmdlet. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -$azurelocations = Set-SPOMigrationPackageAzureSource -SourcePath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_TgtPkg -FileContainerUri migration-files -PackageContainerUri migration-package -AccountName migrationstore -AccountKey "nmcXQ+1NctB7BlRVm+8+qWUn6GUFIH7E5ZQPThcjg8SfFWTJ34HthyOEoROwxHYIajpOYxYDt7qUwSEBQlLWoA==" -``` -This example creates migration package containers in Azure storage using the supplied account credentials, uploads the package files into them, snapshots the files and lastly returns the connection strings to a PowerShell variable. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Set-SPOMigrationPackageAzureSource -SourcePath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_TgtPkg -MigrationPackageAzureLocations $azurelocations -AccountName migrationstore -AccountKey "nmcXQ+1NctB7BlRVm+8+qWUn6GUFIH7E5ZQPThcjg8SfFWTJ34HthyOEoROwxHYIajpOYxYDt7qUwSEBQlLWoA==" -NoUpload -``` -This example uses existing migration package containers in Azure storage to snapshot previously uploaded files and then returns the connection strings to a PowerShell variable. - - -## PARAMETERS - -### -AccountKey -The account key for the Azure Storage account. - - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountName -The account name for the Azure Storage account. - - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureQueueName -An optional name of the Azure Storage Reporting Queue where import operations lists events during import. This value must be in lower case and conform to Azure’s queue naming rules. - - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionMetaInfo -PARAMVALUE: MigrationFileEncryptionInfo[] - - -```yaml -Type: MigrationFileEncryptionInfo[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionParameters -PARAMVALUE: EncryptionParameters - - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileContainerName -The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package content files. The value must be in lower case and conform to Azure’s container naming rules. If this not supplied a name will be generated using the format <GUID>-files. - - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationPackageAzureLocations -A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the `Set-SPOMigrationPackageAzureSource` - - -```yaml -Type: MigrationPackageAzureLocations -Parameter Sets: ImplicitSourceImplicitAzure, ExplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSourceLocations -PARAMVALUE: MigrationPackageLocation - - -```yaml -Type: MigrationPackageLocation -Parameter Sets: ImplicitSourceExplicitAzure, ImplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Indicates to not create a log file. The default is to create a new CopyMigrationPackage log file within the directory specified within the SourcePackagePath parameter. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoSnapshotCreation -Indicates to not perform snapshots on the content in the containers. The default is to snapshot each of the packages files in the containers. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoUpload -Indicates to not upload the package files. The default is to upload all the package files. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageContainerName -The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package metadata files. The value must be in lower case and conform to Azure’s container naming rules. If this not supplied a name will be generated using the format <GUID>-package. - - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilesPath -The directory location where the package’s source content files exist. - - -```yaml -Type: String -Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath -The directory location where the package’s metadata files exist. - - -```yaml -Type: String -Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md deleted file mode 100644 index 2f57269908..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md +++ /dev/null @@ -1,764 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOSite -schema: 2.0.0 ---- - -# Set-SPOSite - -## SYNOPSIS -Sets or updates one or more properties' values for a site collection. - - -## SYNTAX - -### ParamSet2 -``` -Set-SPOSite [-Identity] <SpoSitePipeBind> -EnablePWA <Boolean> [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### ParamSet1 -``` -Set-SPOSite [-Identity] <SpoSitePipeBind> [-AllowSelfServiceUpgrade <Boolean>] [-Confirm] - [-DenyAddAndCustomizePages <Boolean>] [-LocaleId <UInt32>] [-LockState <String>] [-NoWait] [-Owner <String>] - [-ResourceQuota <Double>] [-ResourceQuotaWarningLevel <Double>] - [-SandboxedCodeActivationCapability <SandboxedCodeActivationCapabilities>] - [-SharingCapability <SharingCapabilities>] [-StorageQuota <Int64>] [-StorageQuotaWarningLevel <Int64>] - [-Title <String>] [-WhatIf] [-AllowLimitedAccess <Boolean>] [-BlockDownloadOfNonViewableFiles <Boolean>] - [-CommentsOnSitePagesDisabled <Boolean>] [-SocialBarOnSitePagesDisabled <Boolean>] - [-DisableAppViews <AppViewsPolicy>] - [-DisableCompanyWideSharingLinks <CompanyWideSharingLinksPolicy>] [-DisableFlows <FlowsPolicy>] - [-DisabledWebpartIds <Guid>] - [-RestrictedToGeo <RestrictedToRegion>] [-SharingAllowedDomainList <String>] - [-SharingBlockedDomainList <String>] [-SharingDomainRestrictionMode <SharingDomainRestrictionModes>] - [-ShowPeoplePickerSuggestionsForGuestUsers <Boolean>] [-StorageQuotaReset] - [-DefaultSharingLinkType] [-DefaultLinkPermission] [<CommonParameters>] -``` - -### ParamSet3 -``` -Set-SPOSite [-Identity] <SpoSitePipeBind> [-Confirm] [-DisableSharingForNonOwners] [-WhatIf] - [<CommonParameters>] -``` - -### ParamSet4 -``` -Set-SPOSite [-Identity] <SpoSitePipeBind> [-Confirm] [-WhatIf] [-NewUrl <String>] [<CommonParameters>] -``` - - -## DESCRIPTION -For any parameters that are passed in, the `Set-SPOSite` cmdlet sets or updates the setting for the site collection identified by parameter Identity. - -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -Owner joe.healy@contoso.com -NoWait -``` - -Example 1 updates the owner of site collection https://contoso.sharepoint.com/sites/site1 to the person whose email address is joe.healy@contoso.com. This cmdlet is executed immediately without delay. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -ResourceQuota 0 -StorageQuota 15000 -``` - -Example 2 updates the settings of site collection https://contoso.sharepoint.com/sites/site1. The storage quota is updated to 15000 megabytes and the resource quota is updated to 0 megabytes. - - -### -----------------------EXAMPLE 3----------------------------- -``` -Set-SPOSite -Identity https://contoso.sharepoint.com -StorageQuota 3000 -StorageQuotaWarningLevel 2000 -``` - -This example updates the settings of site collection https://contoso.sharepoint.com. The storage quota is updated to 3000 megabytes and the storage quota warning level is updated to 2000 megabytes. - - -### -----------------------EXAMPLE 4----------------------------- -``` -Set-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwners -``` - -Example 4 prevents non-owners of a site from inviting new users to the site. - - -### -----------------------EXAMPLE 5----------------------------- -``` -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -StorageQuota 3000 -StorageQuotaWarningLevel 2000 -``` - -This example sets the quota for the site. - -> [!NOTE] -> If Site Collection Storage Management is enabled for the tenant, you will not be able to set quota and will have a generic error returned. To workaround this issue, set the site collection storage management to "manual" temporarily, set your quotas and then set the site collection storage management setting back to its original setting. - - -## PARAMETERS - -### -EnablePWA -Determines whether site can include Project Web App. -For more information about Project Web App, see Plan SharePoint groups in Project Server. - - -```yaml -Type: Boolean -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the URL of the site collection to update. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowSelfServiceUpgrade -Determines whether site collection administrators can upgrade their site collections. - - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyAddAndCustomizePages -Determines whether the Add And Customize Pages right is denied on the site collection. -For more information about permission levels, see User permissions and permission levels in SharePoint. - - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSharingForNonOwners -This parameter prevents non-owners from invited new users to the site. - -This parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later. - - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet3 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledWebpartIds -This parameter is used for eanbling disabled web parts that use third-party service (Amazon Kindle, YouTube, Twitter). The GUIDs that can be used are 46698648-fcd5-41fc-9526-c7f7b2ace919 (Amazon Kindle), 544dd15b-cf3c-441b-96da-004d5a8cea1d (YouTube), f6fdf4f8-4a24-437b-a127-32e66a5dd9b4 (Twitter). - -The Set-SPOTenant cmdlet is used for disabling these web parts with third-party services. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -LocaleId -Specifies the language of this site collection. -For more information, see Locale IDs Assigned by Microsoft (http://go.microsoft.com/fwlink/p/?LinkId=242911). - - -```yaml -Type: UInt32 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockState -Sets the lock state on a site. -Valid values are: NoAccess and Unlock. -When the lock state of a site is NoAccess, all traffic to the site will be blocked. -If parameter NoAccessRedirectUrl in the `Set-SPOTenant` cmdlet is set, traffic to sites that have a lock state NoAccess will be redirected to that URL. -If parameter NoAccessRedirectUrl is not set, a 403 error will be returned. - - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Specifies to continue executing script immediately. - - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the owner of the site collection. - - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceQuota -Specifies the resource quota in megabytes of the site collection. -The default value is 0. -For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint (http://msdn.microsoft.com/en-us/library/gg615462.aspx). - - -```yaml -Type: Double -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceQuotaWarningLevel -Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the resource quota. - - -```yaml -Type: Double -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SandboxedCodeActivationCapability -PARAMVALUE: Unknown | Check | Disabled | Enabled - - -```yaml -Type: SandboxedCodeActivationCapabilities -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingCapability -Determines what level of sharing is available for the site. -The possible values are: Disabled - don't allow sharing outside your organization, ExistingExternalUserSharingOnly - Allow sharing only with the external users that already exist in your organization's directory, ExternalUserSharingOnly - allow external users who accept sharing invitations and sign in as authenticated users, or ExternalUserAndGuestSharing - allow sharing with all external users, and by using anonymous access links. - -For more information about sharing, see Turn external sharing on or off for SharePoint Online (https://docs.microsoft.com/sharepoint/turn-external-sharing-on-or-off). - - -```yaml -Type: SharingCapabilities -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuota -Specifies the storage quota in megabytes of the site collection. - - -```yaml -Type: Int64 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuotaWarningLevel -Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the storage quota. - - -```yaml -Type: Int64 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Specifies the title of the site collection. - - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowLimitedAccess -{{Fill AllowLimitedAccess Description}} - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockDownloadOfNonViewableFiles -{{Fill BlockDownloadOfNonViewableFiles Description}} - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsOnSitePagesDisabled -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -SocialBarOnSitePagesDisabled -Disables or enables the Social Bar for Site Collection. - -The Social Bar will appear on all modern SharePoint pages with the exception of the home page of a site. It will give users the ability to like a page, see the number of views, likes, and comments on a page, and see the people who have liked a page. - -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAppViews -PARAMVALUE: Unknown | Disabled | NotDisabled - - -```yaml -Type: AppViewsPolicy -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCompanyWideSharingLinks -PARAMVALUE: Unknown | Disabled | NotDisabled - - -```yaml -Type: CompanyWideSharingLinksPolicy -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableFlows -PARAMVALUE: Unknown | Disabled | NotDisabled - - -```yaml -Type: FlowsPolicy -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewUrl -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: ParamSet4 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictedToGeo -PARAMVALUE: NoRestriction | BlockMoveOnly | BlockFull | Unknown - - -```yaml -Type: RestrictedToRegion -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingAllowedDomainList -Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, “contoso.com fabrikam.com”. - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. - - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingBlockedDomainList -Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, “contoso.com fabrikam.com”. - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. - - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingDomainRestrictionMode -Specifies the external sharing mode for domains. - -The following values are: - -None - -AllowList - -BlockList - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. - - -```yaml -Type: SharingDomainRestrictionModes -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowPeoplePickerSuggestionsForGuestUsers -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuotaReset -Resets the OneDrive for Business storage quota to the tenant’s new default storage space. - - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - - -### -DefaultSharingLinkType - -The default link type for the site collection - -PARAMVALUE: None | AnonymousAccess | Internal | Direct - -None - Respect the organization default sharing link type -AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link -Internal - Sets the default sharing link for this site to the “organization” link or company shareable link -Direct - Sets the default sharing link for this site to the “Specific people” link - - -```yaml -Type: SharingLinkType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -DefaultLinkPermission - -The default link permission for the site collection - -PARAMVALUE: None | View | Edit - -None - Respect the organization default link permission -View - Sets the default link permission for the site to “view” permissions -Edit - Sets the default link permission for the site to “edit” permissions - -```yaml -Type: SharingPermissionType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Set-SPOTenant](Set-SPOTenant.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md deleted file mode 100644 index 0e320529e7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOSiteDesign -schema: 2.0.0 ---- - -# Set-SPOSiteDesign - -## SYNOPSIS - -Updates a previously uploaded site design. - -## SYNTAX - -```powershell -Set-SPOSiteDesign - [-Identity <SPOSiteDesignPipeBind>] - [-Title <string>] - [-WebTemplate <string>] - [-SiteScripts <SPOSiteScriptPipeBind[]>] - [-Description <string>] - [-PreviewImageUrl <string>] - [-PreviewImageAltText <string>] - [-IsDefault] - [<CommonParameters>] -``` - -## EXAMPLES - -### Example 1 - -This example updates a previously created site design. - -```powershell -Set-SPOSiteDesign ` - -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Title "Contoso customer tracking - version 2" ` - -WebTemplate "68" ` - -Description "Updated site design for list schema that tracks key customer data in a list" ` - -PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" ` - -PreviewImageAltText "site preview - version 2" -``` - -## DESCRIPTION - -Updates a previously uploaded site design. - -## PARAMETERS - -### -Identity -The site design Id. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebTemplate -Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteScripts -An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. - -```yaml -Type: SPOSiteScriptPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The display description of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageUrl -The URL of a preview image. If none is specified, SharePoint uses a generic image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageAltText -The alt text description of the image for accessibility. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md deleted file mode 100644 index 513734a37a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOSiteGroup -schema: 2.0.0 ---- - -# Set-SPOSiteGroup - -## SYNOPSIS -Updates the SharePoint Online owner and permission levels on a group inside a site collection. - - -## SYNTAX - -``` -Set-SPOSiteGroup -Identity <String> [-Name <String>] [-Owner <String>] [-PermissionLevelsToAdd <String[]>] - [-PermissionLevelsToRemove <String[]>] -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -You must be a SharePoint Online global administrator and a site collection administrator to run the `Set-SPOSiteGroup` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Set-SPOSiteGroup -Site http://contoso.sharepoint.com/sites/siteA -Identity "ProjectViewers" -PermissionLevelsToRemove "Full Control" -PermissionLevelsToAdd "View Only" -``` - -Example 1 changes permission level of the ProjectViewers group inside site collection http://contoso.sharepoint.com/sites/siteA from Full Control to View Only. - -### -----------------------EXAMPLE 2----------------------------- -``` -Set-SPOSiteGroup -Site https://contoso.sharepoint.com -Identity "ProjectViewers" -Owner Melissa.kerr@contoso.com -``` - -Example 2 sets Melissa.kerr@contoso.com as the owner of the ProjectViewers group. - - -## PARAMETERS - -### -Identity -Specifies the name of the group. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the new name of the group. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the owner (individual or a security group) of the group to be created. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevelsToAdd -Specifies the permission levels to grant to the group. - -> [!NOTE] -> Permission levels are defined by SharePoint Online global administrators from SharePoint Online Administration Center. - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevelsToRemove -Specifies the permission levels to remove from the group. - -> [!NOTE] -> Permission levels are defined by SharePoint Online global administrators from SharePoint Online Administration Center. - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection the group belongs to. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOSiteGroup](Get-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md deleted file mode 100644 index 6f048e0dcf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOSiteOffice365Group -schema: 2.0.0 ---- - -# Set-SPOSiteOffice365Group - -## SYNOPSIS -Connects a top-level SPO site collection to a new Office 365 Group. - -## SYNTAX - -``` -Set-SPOSiteOffice365Group - -Site <string> - -DisplayName <string> - -Alias <string> - [-IsPublic] - [-Description <string>] - [-Classification <string>] - [-KeepOldHomepage] - [<CommonParameters>] -``` - -## DESCRIPTION -Connects a top-level SPO site collection to a new Office 365 Group. You must be a SharePoint Online global administrator to run the cmdlet. - -> [!IMPORTANT] -> This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments. - -If the site doesn’t exist, this cmdlet returns a “File not found” error. - -## EXAMPLES - -### Example 1 - -This example creates a new Office 365 Group named "site1group" and connects site collection https://contoso.sharepoint.com/sites/site1 to it. The group will privacy set to "Private" and Classification set to "Highly Confidential". - -``` -Set-SPOSiteOffice365Group ` - -Site https://contoso.sharepoint.com/sites/site1 ` - -DisplayName "site1group" ` - -Alias "site1group" ` - -Classification "Highly Confidential" ` -``` - -### Example 2 - -This example creates a new Office 365 Group named "classicsite" and connects site collection https://contoso.sharepoint.com/sites/classicsite to it. It will keep the old home page from the classic site. - -``` -Set-SPOSiteOffice365Group ` - -Site https://contoso.sharepoint.com/sites/classicsite ` - -DisplayName "Classic Site" ` - -Alias "classicsite" ` - -KeepOldHomepage ` -``` - - -## PARAMETERS - -### -Site - -The site collection being connected to new Office 365 Group. - -```yaml -Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Specifies the name of the new Office 365 Group that will be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias - -Specifies the email alias for the new Office 365 Group that will be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Specifies the group’s description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPublic - -Determines the Office 365 Group’s privacy setting. If switch is included, the group will be public, otherwise it will be private. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Specifies the classification value, if classifications are set for the organization. If no value is provided, the default classification will be set, if one is configured. - -See [Azure Active Directory cmdlets for configuring group settings](https://go.microsoft.com/fwlink/?LinkID=827484) and follow the steps in the Create settings at the directory level to define the classification for Office 365 groups. - -See [Manage Office 365 Groups with PowerShell](https://support.office.com/en-us/article/Manage-Office-365-Groups-with-PowerShell-aeb669aa-1770-4537-9de2-a82ac11b0540) for more information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepOldHomepage - -For sites that already have a modern page set as homepage, you can specify whether you want to keep it as the homepage. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md deleted file mode 100644 index 5afc07b3d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOSiteScript -schema: 2.0.0 ---- - -# Set-SPOSiteScript - -## SYNOPSIS - -Updates a previously uploaded site script. - -## SYNTAX - -``` -Set-SPOSiteScript - -Identity <SPOSiteScriptPipeBind> - -Title <string> - -Content <string> - [-Description <string>] - [-Version <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION - -Updates a previously uploaded site script. - -## EXAMPLES - -### Example 1 - -This example updates a previously created site script. Any site designs referencing it execute the updated script. - -``` -$newnavscript = @' -{ - "$schema": "schema.json", - "actions": [ - { - "verb": "addNavLink", - "url": "/Custom Library", - "displayName": "Custom Library Updated", - "isWebRelative": true - }, - { - "verb": "addNavLink", - "url": "/Lists/Custom List", - "displayName": "Custom List Updated", - "isWebRelative": true - }, - { - "verb": "applyTheme", - "themeName": "Contoso Explorers" - } - ], - "bindata": { }, - "version": 2 -}; -'@ - -Set-SPOSiteScript -Identity edaec4ec-71e2-4026-ac1e-6686bb30190d -Content $newnavscript -Version 2 - -``` - -## PARAMETERS - -### -Identity - -The id of the site design. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Content - -The JSON value that describes the script. For more information, see the [JSON reference](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -A description of the script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Version - -A version number of the script. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -## INPUTS - -## OUTPUTS - -## NOTES - - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md deleted file mode 100644 index b69563c26c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md +++ /dev/null @@ -1,1272 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOTenant -schema: 2.0.0 ---- - -# Set-SPOTenant - -## SYNOPSIS -Sets properties on the SharePoint Online organization. - - -## SYNTAX - -``` -Set-SPOTenant [-ApplyAppEnforcedRestrictionsToAdHocRecipients <Boolean>] - [-BccExternalSharingInvitations <Boolean>] [-BccExternalSharingInvitationsList <String>] - [-DisplayStartASiteOption <Boolean>] [-ExternalServicesEnabled <Boolean>] [-MaxCompatibilityLevel <Int32>] - [-MinCompatibilityLevel <Int32>] [-NoAccessRedirectUrl <String>] [-OfficeClientADALDisabled <Boolean>] - [-ProvisionSharedWithEveryoneFolder <Boolean>] [-RequireAcceptingAccountMatchInvitedAccount <Boolean>] - [-SearchResolveExactEmailOrUPN <Boolean>] [-SharingCapability <SharingCapabilities>] - [-ShowAllUsersClaim <Boolean>] [-ShowEveryoneClaim <Boolean>] - [-ShowEveryoneExceptExternalUsersClaim <Boolean>] [-SignInAccelerationDomain <String>] - [-StartASiteFormUrl <String>] [-UsePersistentCookiesForExplorerView <Boolean>] - [-CommentsOnSitePagesDisabled <Boolean>] [-SocialBarOnSitePagesDisabled <Boolean>] - [-DefaultSharingLinkType <SharingLinkType>] - [-DisableWebPartIds <Guid>] - [-DisallowInfectedFileDownload <Boolean>] [-EnableGuestSignInAcceleration <Boolean>] - [-FileAnonymousLinkType <AnonymousLinkType>] [-FolderAnonymousLinkType <AnonymousLinkType>] - [-IPAddressAllowList <String>] [-IPAddressEnforcement <Boolean>] [-IPAddressWACTokenLifetime <Int32>] - [-LegacyAuthProtocolsEnabled <Boolean>] [-NotificationsInOneDriveForBusinessEnabled <Boolean>] - [-NotificationsInSharePointEnabled <Boolean>] [-NotifyOwnersWhenInvitationsAccepted <Boolean>] - [-NotifyOwnersWhenItemsReshared <Boolean>] [-ODBAccessRequests <SharingState>] - [-ODBMembersCanShare <SharingState>] [-OneDriveForGuestsEnabled <Boolean>] [-OneDriveStorageQuota <Int64>] - [-OrphanedPersonalSitesRetentionPeriod <Int32>] [-OwnerAnonymousNotification <Boolean>] - [-PermissiveBrowserFileHandlingOverride <Boolean>] [-PreventExternalUsersFromResharing <Boolean>] - [-PublicCdnAllowedFileTypes <String>] [-PublicCdnEnabled <Boolean>] - [-RequireAnonymousLinksExpireInDays <Int32>] [-SharingAllowedDomainList <String>] - [-SharingBlockedDomainList <String>] [-SharingDomainRestrictionMode <SharingDomainRestrictionModes>] - [-ShowPeoplePickerSuggestionsForGuestUsers <Boolean>] - [-SpecialCharactersStateInFileFolderNames <SpecialCharactersState>] [-UseFindPeopleInPeoplePicker <Boolean>] - [-UserVoiceForFeedbackEnabled <Boolean>] - [-ContentTypeSyncSiteTemplatesList MySites [-ExcludeSiteTemplate]] - [<CommonParameters>] -``` - -## DESCRIPTION -You can use the `Set-SPOTenant` cmdlet to enable external services and to specify the versions in which site collections can be created. -You can also use the `Set-SPOSite` cmdlet together with the `Set-SPOTenant` cmdlet to block access to a site in your organization and redirect traffic to another site. - -You must be a SharePoint Online global administrator to run the cmdlet. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/team1 -LockState NoAccess -Set-SPOTenant -NoAccessRedirectUrl 'http://www.contoso.com/' -``` -This example blocks access to https://contoso.sharepoint.com/sites/team1 and redirects traffic to http://www.contoso.com. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Set-SPOTenant -ShowEveryoneExceptExternalUsersClaim $false -``` -This example hides the "Everyone Except External Users" claim in People Picker. - - -### -----------------------EXAMPLE 3----------------------------- -``` -Set-SPOTenant -ShowAllUsersClaim $false -``` -This example hides the "All Users" claim group in People Picker. - - -### -----------------------EXAMPLE 4----------------------------- -``` -Set-SPOTenant -UsePersistentCookiesForExplorerView $true -``` -This example enables the use of special persisted cookie for Open with Explorer. - -### -----------------------EXAMPLE 5----------------------------- - -``` -Set-SPOTenant -LegacyAuthProtocolsEnabled $True -``` - -This example enables legacy authentication protocols on the tenant. This can help to enable login in situations where the admin users get an error like "Cannot contact web site 'https://contoso-admin.sharepoint.com/' or the web site does not support SharePoint Online credentials. The response status code is 'Unauthorized'.", and the underlying error is "Access denied. Before opening files in this location, you must first browse to the web site and select the option to login automatically." - -### -----------------------EXAMPLE 6------------------------------ - -``` -Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -``` - -This example enables Content Type Hub to push content types to all OneDrive for Business sites. There is no change in Content Type Publishing behaviour for other sites. - -### -----------------------EXAMPLE 7------------------------------- - -``` -Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -ExcludeSiteTemplate -``` - -This example stops publishing content types to OneDrive for Business sites. - -## PARAMETERS - -### -ApplyAppEnforcedRestrictionsToAdHocRecipients -When the feature is enabled, all guest users are subject to conditional access policy. By default guest users who are accessing SharePoint Online files with pass code are exempt from the conditional access policy. - -The valid values are: -False (default) - Guest access users are exempt from conditional access policy. -True - Conditional access policy is applieda also to guest users. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BccExternalSharingInvitations -When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. - -The valid values are: -False (default) - BCC for external sharing is disabled. -True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BccExternalSharingInvitationsList -Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. -Multiple addresses can be specified by creating a comma separated list with no spaces. - -The valid values are: -"" (default) - Blank by default, this will also clear any value that has been set. -Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayStartASiteOption -Determines whether tenant users see the Start a Site menu option. - -The valid values are: -True (default) - Tenant users will see the Start a Site menu option. -False - Start a Site is hidden from the menu. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalServicesEnabled -Enables external services for a tenant. -External services are defined as services that are not in the Office 365 datacenters. - -The valid values are: -True (default) - External services are enabled for the tenant. -False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCompatibilityLevel -Specifies the upper bound on the compatibility level for new sites. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinCompatibilityLevel -Specifies the lower bound on the compatibility level for new sites. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoAccessRedirectUrl -Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess." - -The valid values are: -"" (default) - Blank by default, this will also remove or clear any value that has been set. -Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OfficeClientADALDisabled -When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. - -The valid values are: -False (default) - Modern Authentication is enabled/allowed. -True - Modern Authentication via ADAL is disabled. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvisionSharedWithEveryoneFolder -Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. - -The valid values are: -True (default) - The Shared with Everyone folder is created. -False - No folder is created when the site and OneDrive for Business document library is created. - -The default behavior of the Shared with Everyone folder changed in August 2015. -For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US) - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAcceptingAccountMatchInvitedAccount -Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. - -Administrators who desire increased control over external collaborators should consider enabling this feature. - -Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. - -The valid values are: -False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. -True - User must accept this invitation with bob@contoso.com. - -> [!NOTE] -> If this functionality is turned off (value is False), it is possible for the external/guest users you invite to your Azure AD, to log in using their personal, non-work accounts either on purpose, or by accident (they might have a pre-existing, signed in session already active in the browser window they use to accept your invitation). - -> [!NOTE] -> Even though setting the value is instant (if you first run **Set-SPOTenant -RequireAcceptingAccountMatchInvitedAccount $True**, and then **Get-SPOTenant -RequireAcceptingAccountMatchInvitedAccount**, True should be returned), the functionality isn't turned on immediately. It may take up to 24 hours to take effect. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchResolveExactEmailOrUPN -Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. This also does not allow SharePoint users to search for security groups or SharePoint groups. - -SharePoint Administrators will still be able to use starts with or partial name matching when enabled. - -The valid values are: -False (default) - Starts with / partial name search functionality is available. -True - Disables starts with / partial name search functionality for all SharePoint users, except SharePoint Admins. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingCapability -Determines what level of sharing is available for the site. - -The valid values are: -ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. -Disabled - External user sharing (share by email) and guest link sharing are both disabled. -ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. - -For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx). - - -```yaml -Type: SharingCapabilities -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: ExternalUserAndGuestSharing -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowAllUsersClaim -Enables the administrator to hide the All Users claim groups in People Picker. - -When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organtization members in the tenant that used NTLM to authentication with SharePoint. - -Note, the All Users (authenticated) group is equivalent to the Everyone claim, and shows as Everyone. -To change this, see -ShowEveryoneClaim. - -The valid values are: -True (default) - The All Users claim groups are displayed in People Picker. -False - The All Users claim groups are hidden in People Picker. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowEveryoneClaim -Enables the administrator to hide the Everyone claim in the People Picker. -When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. - -Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. - -The valid values are: -True (default) - The Everyone claim group is displayed in People Picker. -False - The Everyone claim group is hidden from the People Picker. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowEveryoneExceptExternalUsersClaim -Enables the administrator to hide the "Everyone except external users" claim in the People Picker. -When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. - -The valid values are: -True (default) - The Everyone except external users is displayed in People Picker. -False - The Everyone except external users claim is not visible in People Picker. - - -```yaml -Type: Boolean - -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInAccelerationDomain -Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. - -When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. -This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. - -Acceleration will not occur on site collections that are shared externally. - -This value should be configured with the login domain that is used by your company (that is, example@contoso.com). - -If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. - -The valid values are: -"" (default) - Blank by default, this will also remove or clear any value that has been set. -Login Domain - For example: "contoso.com" - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartASiteFormUrl -Specifies URL of the form to load in the Start a Site dialog. - -The valid values are: -"" (default) - Blank by default, this will also remove or clear any value that has been set. -Full URL - Example: "https://contoso.sharepoint.com/path/to/form" - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsePersistentCookiesForExplorerView -Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. - -"Open with Explorer" requires persisted cookies to operate correctly. -When the user does not select "Keep Me Signed in" at the time of sign-in, "Open with Explorer" will fail. - -This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online. -To clear this cookie, the user must log out of their Windows session. - -The valid values are: -False (default) - No special cookie is generated and the normal Office 365 sign-in length/timing applies. -True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign-in. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsOnSitePagesDisabled -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialBarOnSitePagesDisabled -Disables or enables the Social Bar. - -The Social Bar will appear on all modern SharePoint pages with the exception of the home page of a site. It will give users the ability to like a page, see the number of views, likes, and comments on a page, and see the people who have liked a page. - -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSharingLinkType -Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. - -For additional information about how to change the default link type, see Change the default link type when users get links for sharing. - -> [!NOTE] -> Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. - -The values are: -None -Direct -Internal -AnonymousAccess - - -```yaml -Type: SharingLinkType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledWebPartIds -PARAMVALUE: <Guid>[,<Guid>,...] - -Allows administrators prevent certain, specific web parts from being added to pages or rendering on pages on which they were previously added. Only web parts that utilize third-party services (Amazon Kindle, YouTube, Twitter) can be disabled in such a manner. - -To disable a specific web part you need to enter its GUID as the parameter: Amazon Kindle (46698648-fcd5-41fc-9526-c7f7b2ace919), YouTube (544dd15b-cf3c-441b-96da-004d5a8cea1d), Twitter (f6fdf4f8-4a24-437b-a127-32e66a5dd9b4) - -You can enter in multiple GUIDs by using a comma to separate them. To view a list of disabled web parts, use Get-SPOSite to get DisabledWebPartIds. - -To reenable disabled web parts, use the Set-SPOSite with the -DisabledWebPartIds parameter and corresponding GUIDs. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisallowInfectedFileDownload -Prevents the Download button from being displayed on the Virus Found warning page. - -Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableGuestSignInAcceleration -Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. - -> [!NOTE] -> If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileAnonymousLinkType -PARAMVALUE: None | View | Edit - - -```yaml -Type: AnonymousLinkType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderAnonymousLinkType -PARAMVALUE: None | View | Edit - - -```yaml -Type: AnonymousLinkType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressAllowList -Configures multiple IP addresses or IP address ranges (IPv4 or IPv6). - -Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. - -> [!NOTE] -> The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressEnforcement -Allows access from network locations that are defined by an administrator. - -The values are $true and $false. The default value is $false which means the setting is disabled. - -Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressWACTokenLifetime -PARAMVALUE: Int32 - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LegacyAuthProtocolsEnabled -By default this value is set to $True, which means that authentication using legacy protocols is enabled. - -Setting this parameter to $False prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. - -A value of True- Enables Office clients using non-modern authentication protocols (such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. - -A value of False- Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. - -> [!NOTE] -> This may also prevent third-party apps from accessing SharePoint Online resources. -Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources. For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class. - -> [!NOTE] -> The change is not instant. It might take up to 24 hours to be applied. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationsInOneDriveForBusinessEnabled -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationsInSharePointEnabled -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOwnersWhenInvitationsAccepted -When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. - -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. - -The values are $true and $false. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOwnersWhenItemsReshared -When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. - -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. - -The values are $true and $false. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODBAccessRequests -Lets administrators set policy on access requests and requests to share in OneDrive for Business. - -Values: - -On- Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. - -Off- Prevent access requests and requests to share on OneDrive for Business. - -Unspecified- Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive. - - -```yaml -Type: SharingState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODBMembersCanShare -Lets administrators set policy on re-sharing behavior in OneDrive for Business. - -Values: - -On- Users with edit permissions can re-share. - -Off- Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. - -Unspecified- Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive. - - -```yaml -Type: SharingState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveForGuestsEnabled -Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. - -The valid values are the following: - -$true-Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. - -$false- Administrator managed Guest users can't be given OneDrives as functionality is turned off. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OneDriveStorageQuota -Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. - -A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. - -If value is set to 0, the parameter will have no effect. - -If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. - - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrphanedPersonalSitesRetentionPeriod -Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. - -The value range is in days, between 30 and 3650. The default value is 30. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerAnonymousNotification -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissiveBrowserFileHandlingOverride -Enables the Permissive browser file handling. By default, the browser file handling is set to Strict. The Strict setting adds headers that force the browser to download certain types of files. The forced download improves security by disallowing the automatic execution of Web content. When the setting is set to Permissive, no headers are added and certain types of files can be executed in the browser instead of download. - -The valid values are: - -True- Enable the Permissive browser file handling setting. - -False- Keep the default Strict browser file handling setting. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventExternalUsersFromResharing -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCdnAllowedFileTypes -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCdnEnabled -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAnonymousLinksExpireInDays -Specifies all anonymous links that have been created (or will be created) will expire after the set number of days . - -To remove the expiration requirement, set the value to zero (0). - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingAllowedDomainList -Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, “contoso.com fabrikam.com”. - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingBlockedDomainList -Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, “contoso.com fabrikam.com”. - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingDomainRestrictionMode -Specifies the external sharing mode for domains. - -The following values are: -None -AllowList -BlockList - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. - - -```yaml -Type: SharingDomainRestrictionModes -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowPeoplePickerSuggestionsForGuestUsers -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpecialCharactersStateInFileFolderNames -Permits the use of special characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. - -> [!NOTE] -> The only two characters that can be managed at this time are the # and % characters. - -The following are the valid values: - -NoPreference- Support for feature will be enabled by Microsoft on your Office 365 tenant. - -Allowed- Lets the # and % characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. - -Disallowed- Disallows the # and % characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. - - -```yaml -Type: SpecialCharactersState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseFindPeopleInPeoplePicker - -> [!NOTE] -> When set to $true, users aren't able to share with security groups or SharePoint groups. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserVoiceForFeedbackEnabled -PARAMVALUE: $true | $false - -When set to $true, the "Feedback" link will be shown at the bottom of all modern SharePoint Online pages. The "Feedback" link will allow the end user to fill out a feedback form inside SharePoint Online which will then create an entry in the public SharePoint UserVoice topic. When set to $false, feedback link will not be shown anymore. It may take up to an hour for a change of this property to be reflected consistently throughout your tenant. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: $true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypeSyncSiteTemplatesList MySites [-ExcludeSiteTemplate] -By default Content Type Hub will no longer push content types to OneDrive for Business sites (formerly known as MySites). -In case you want the Content Type Hub to push content types to OneDrive for Business sites, use: -``` -Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -``` -When the feature is enabled, the Content Type Hub will push content types to OneDrive for Business sites. - -Once you have enabled Content Type publishing to OneDrive for Business sites, you can disable it later using: -``` -Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -ExcludeSiteTemplate -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Upgrade-SPOSite](Upgrade-SPOSite.md) - -[Set-SPOSite](Set-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md deleted file mode 100644 index f4674f5823..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOTenantCdnEnabled -schema: 2.0.0 ---- - -# Set-SPOTenantCdnEnabled - -## SYNOPSIS -Enables or disables Public content delivery network (CDN) or Private CDN on the tenant level. Requires Tenant administrator permissions. - - -## SYNTAX - -``` -Set-SPOTenantCdnEnabled [-CdnType <SPOTenantCdnTypeClient>] [-Confirm] [-Enable <Boolean>] [-NoDefaultOrigins] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Enables or disables Public content delivery network (CDN) or Private CDN on the tenant level. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Set-SPOTenantCdnEnabled -CdnType public -Enable $true -``` - -The example enables a CDN. - - -## PARAMETERS - -### -CdnType -Specifies the CDN type. The valid values are: public or private. - - -```yaml -Type: SPOTenantCdnTypeClient -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private, Both -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Specifies if the CDN is enabled. - -The valid values are: $True and $False. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDefaultOrigins -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Set-SPOTenantCdnEnabled](Set-SPOTenantCdnEnabled.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md deleted file mode 100644 index 1a48a510a1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOTenantCdnPolicy -schema: 2.0.0 ---- - -# Set-SPOTenantCdnPolicy - -## SYNOPSIS - -Sets the content delivery network (CDN) policies from the tenant level. - - -## SYNTAX - -``` -Set-SPOTenantCdnPolicy -CdnType <SPOTenantCdnType> -PolicyType <SPOTenantCdnPolicyType> -PolicyValue <String> - [<CommonParameters>] -``` - -## DESCRIPTION - -{{Fill in the Description}} - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- - -``` -Set-SPOTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,BMP" -``` - -This example sets a CDN to a public type with a policy value of listed extensions. - -### --------------------EXAMPLE 2--------------------- - -``` -Set-SPOTenantCdnPolicy -CdnType Public -PolicyType ExcludeRestrictedSiteClassifications -PolicyValue "Confidential,Restricted" -``` - -This example sets a CDN to a public type with a policy value of valid site classifications. - -## PARAMETERS - -### -CdnType - -{{Fill CdnType Description}} - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyType - -{{Fill PolicyType Description}} - -```yaml -Type: SPOTenantCdnPolicyType -Parameter Sets: (All) -Aliases: -Accepted values: IncludeFileExtensions, ExcludeRestrictedSiteClassifications, ExcludeIfNoScriptDisabled -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyValue - -{{Fill PolicyValue Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md deleted file mode 100644 index cda7dd3ba7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOTenantContentTypeReplicationParameters -schema: 2.0.0 ---- - -# Set-SPOTenantContentTypeReplicationParameters - -## SYNOPSIS -Select content types for replication - - -## SYNTAX - -### ReplicateAllContentTypes -``` -Set-SPOTenantContentTypeReplicationParameters [-ReplicateAllContentTypes] [<CommonParameters>] -``` - -### ReplicateSelectedContentTypes -``` -Set-SPOTenantContentTypeReplicationParameters -ReplicatedContentTypes <String[]> [<CommonParameters>] -``` - -## DESCRIPTION -Before you run the cmdlets, please use �Connect-SPOService� to connect to SharePoint Online first. -By default, all published content types in primary location will be replicated to satellite. - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Set-SPOTenantContentTypeReplicationParameters -ReplicatedContentTypes "ct1","ct2" -``` -Tenant admin can use this cmdlet to select only some content types only for replicating to overwrite default settings - - -### EXAMPLE 2 -```powershell -Set-SPOTenantContentTypeReplicationParameters -ReplicateAllContentTypes -``` -Tenant admin can also reset to replicate all the content types. - - -## PARAMETERS - -### -ReplicateAllContentTypes -{{Fill ReplicateAllContentTypes Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: ReplicateAllContentTypes -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicatedContentTypes -{{Fill ReplicatedContentTypes Description}} - -```yaml -Type: String[] -Parameter Sets: ReplicateSelectedContentTypes -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) - -[Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md deleted file mode 100644 index 40084a185c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOTenantSyncClientRestriction -schema: 2.0.0 ---- - -# Set-SPOTenantSyncClientRestriction - -## SYNOPSIS -Controls tenant-wide options and restrictions specific to syncing files. - - -## SYNTAX - -### Blocking -``` -Set-SPOTenantSyncClientRestriction [-BlockMacSync] [-DomainGuids <String>] [-Enable] [<CommonParameters>] -``` - -### ReportProblemDialogFeature -``` -Set-SPOTenantSyncClientRestriction -DisableReportProblemDialog <Boolean> [<CommonParameters>] -``` - -### FileExclusion -``` -Set-SPOTenantSyncClientRestriction [-ExcludedFileExtensions <String>] [<CommonParameters>] -``` - -### GrooveBlockOptions -``` -Set-SPOTenantSyncClientRestriction [-GrooveBlockOption <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets](https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - -You must be a SharePoint Online global administrator to run the cmdlet. - -Requires a valid Connect-SPOService context to identify the tenant. For information on how to connect to the tenant, see [Connect-SPOService](Connect-SPOService.md) - -The **Set-SPOTenantSyncClientRestriction** cmdlet is used to control a variety of tenant-wide administrative settings related to syncing files from OneDrive and SharePoint. You may use it to: - -* Set restrictions on whether users can sync items to non-domain joined machines, control the list of allowed domains, and manage whether Mac clients (which do not support domain join) can sync. - -* Prevents files with specific extensions from being synced. - -* Controls whether users can continue to sync OneDrive for Business libraries with the old OneDrive for Business sync client. - -**Restrict non-domain joined machines from syncing** - -The **Set-SPOTenantSyncClientRestriction** cmdlet can be used to enable the feature for tenancy and set the domain GUIDs in the safe recipients list. When this feature is enabled it can take up to 24 hours for the change to take effect. However, any changes to the safe domains list are reflected within five minutes. - -The **Set-SPOTenantSyncClientRestriction** cmdlet applies both to existing Microsoft OneDrive for Business sync client (Groove.exe) and the Microsoft OneDrive for Business Next Generation Sync Client (OneDrive.exe). OneDrive.exe is the new sync client that will sync both consumer and business accounts. - -> [!IMPORTANT] -> The new OneDrive for Business Next Generation Sync Client lets you connect and sync files from your OneDrive for Business. You can add a work or school account to the new OneDrive for Business sync client and sync all your files in OneDrive to your computer. For more information, see [Improve your OneDrive sync experience](https://go.microsoft.com/fwlink/p/?LinkId=717436). - -When the feature is enabled the following will occur: - -* All OneDrive for Business Sync client requests originating from a domain that is not on the safe recipients list will be blocked. -* All Microsoft OneDrive Mac Sync client and Mac Beta client requests will not be blocked by default. -* Microsoft OneDrive mobile apps are not blocked when this feature is enabled. -* Regardless whether a computer is managed by a device management solution, a sync relationship will not be established unless they are joined to a domain in the Safe Recipient List. -* Any files that have been previously been synced down to your computer will not be deleted. -* When this feature is enabled, please be aware the following upload behavior: - - * New or existing files added to the client will still be uploaded to the server and will not be blocked. - * Regardless if the computer is joined to a domain which is set in the Safe Recipient List. - * Regardless if the computer is joined to a domain which is not set in the Safe Recipient List. - * And for all non-domain joined computers. - - -* Microsoft OneDrive for Business sync client prior to version 15.0.4693.1000 will stop syncing existing libraries. - -> [!IMPORTANT] -> In order to explicitly block Microsoft OneDrive client for Mac or OneDrive for Business Next Generation Sync Client on Mac OS X, please run the **Set-SPOTenantSyncClientRestriction** cmdlet with the **BlockMacSync** parameter set to true. For more information about the Next Generation Sync Client for Mac OS X, see [Get started with the new OneDrive sync client on Mac OS X](https://go.microsoft.com/fwlink/?LinkID=717727). - -> [!IMPORTANT] -> There is a known OneDrive for Business sync client issue where syncing is being blocked even if a computer is joined to a domain which is set in the Safe Recipient List. To resolve this behavior, obtain the 15.0.4719.1000 version or higher of the sync client, see [May 12, 2015, update for OneDrive for Business](https://support.microsoft.com/en-us/kb/2986244/). - -> [!NOTE] -> To determine the version of your Sync client, see [What version of the sync client am I using?](https://support.office.com/en-us/article/Which-version-of-OneDrive-am-I-using-19246eae-8a51-490a-8d97-a645c151f2ba). - -* The latest OneDrive for Business sync client can be downloaded from [Download OneDrive for Windows](http://go.microsoft.com/fwlink/?LinkID=404119&clcid=0x409) or [How to install OneDrive for Business for SharePoint and SharePoint Online](http://go.microsoft.com/fwlink/?LinkID=321300&clcid=0x409). - -> [!IMPORTANT] -> This capability doesn’t support Microsoft Azure Active Directory (AD) Joined or Workplace Joined devices. - -For additional information about how to troubleshoot the OneDrive for Business sync client, see [How to switch from an MSI installation of OneDrive for Business (formerly SkyDrive Pro) standalone to a Click-To-Run installation of OneDrive for Business (formerly SkyDrive Pro) standalone](http://go.microsoft.com/fwlink/?LinkId=526386&clcid=0x409). - -**Block specific file extensions from syncing** - -The **Set-SPOTenantSyncClientRestriction** cmdlet can be used to configure a list of file extensions that should not be synced by the OneDrive sync client, such as .PST files. - -Any file extension may be blocked using this feature, but note that it may take up to 24 hours for a change to take affect across all user devices. When this feature is enabled, users syncing any file that is in the exclusion list will see an error message informing them of the block. - -> [!IMPORTANT] -> This feature is only supported by the new OneDrive for Business sync client. To determine the version of your Sync client, see [What version of the sync client am I using?](https://support.office.com/en-us/article/Which-version-of-OneDrive-am-I-using-19246eae-8a51-490a-8d97-a645c151f2ba). - -**Control whether users can use the old OneDrive for Business sync client** - -The **Set-SPOTenantSyncClientRestriction** cmdlet can be used to configure your tenant to allow or disallow users from using the old OneDrive for Business sync client to sync OneDrive for Business libraries. - -This feature is controlled on an opt-out model which lets users to continue syncing with the old sync client, you may choose to opt out of the Groove block. - -When this feature is enabled, the old OneDrive for Business sync client will stop syncing the user’s OneDrive contents. OneDrive for Business users who are still using the old OneDrive for Business sync client will see an error message and will be prompted to launch and configure the new OneDrive for Business sync client. If they do not yet have the new client installed, they will have the opportunity to download and install it. - -If you opt out, users will be able to resume syncing with the old OneDrive for Business Sync client. -Note that it may take up to an hour for this change to be reflected. - -> [!NOTE] -> This feature only applies to syncing a user’s own OneDrive for Business sites. Team Sites and shared content from other people’s OneDrive for Business sites will continue to sync with the old OneDrive for Business sync client. - - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -Set-SPOTenantSyncClientRestriction –Enable –DomainGuids "786548DD-877B-4760-A749-6B1EFBC1190A; 877564FF-877B-4760-A749-6B1EFBC1190A" -``` - -This example enables the feature for the tenancy and adds the domains GUIDs to the safe recipient list. - -### --------------------EXAMPLE------------------ - -``` -Set-SPOTenantSyncClientRestriction –Enable –DomainGuids "786548DD-877B-4760-A749-6B1EFBC1190A; 877564FF-877B-4760-A749-6B1EFBC1190A" -BlockMacSync:$true -``` - -This example turns on the Block Mac sync functionality. - -### --------------------EXAMPLE------------------ - -``` -Set-SPOTenantSyncClientRestriction –ExcludedFileExtensions "pptx;docx;xlsx" -``` - -This example blocks syncing of PowerPoint, Word, and Excel file types using the new sync client (OneDrive.exe). - -### --------------------EXAMPLE------------------ - -``` -Set-SPOTenantSyncClientRestriction –ExcludedFileExtensions "" -``` - -This example clears the ExcludedFileExtension list and lets all file types synced with the new client (OneDrive.exe). - -### --------------------EXAMPLE------------------ - -``` -Set-SPOTenantSyncClientRestriction -GrooveBlockOption "OptOut" -``` -This example allows users in a tenant to continue syncing OneDrive for Business libraries with the old OneDrive for Business sync client. - -### --------------------EXAMPLE------------------ - -``` -Set-SPOTenantSyncClientRestriction -GrooveBlockOption "HardOptIn" -``` -This example blocks users in a tenant from syncing OneDrive for Business libraries using the old OneDrive for Business sync client. Users will be prompted to upgrade to the new client. - - - - -## PARAMETERS - -### -BlockMacSync -Block Mac sync clients-- the Beta version and the new sync client (OneDrive.exe). -The values for this parameter are True and False. The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: Blocking -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableReportProblemDialog - - -```yaml -Type: Boolean -Parameter Sets: ReportProblemDialogFeature -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainGuids -Sets the domain GUID to add to the safe recipient list. Requires a minimum of 1 domain GUID. The maximum number of domain GUIDs allowed are 125. - -```yaml -Type: String -Parameter Sets: Blocking -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Enables the feature to block sync originating from domains that are not present in the safe recipients list. - -```yaml -Type: SwitchParameter -Parameter Sets: Blocking -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedFileExtensions -Blocks certain file types from syncing with the new sync client (OneDrive.exe). - -> [!NOTE] -> It may take up to one hour for changes to take effect. - -```yaml -Type: String -Parameter Sets: FileExclusion -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrooveBlockOption -Controls whether or not a tenant’s users can sync OneDrive for Business libraries with the old OneDrive for Business sync client. -The valid values are **OptOut, HardOptin, and SoftOptin**. - -```yaml -Type: String -Parameter Sets: GrooveBlockOptions -Aliases: -Accepted values: OptOut, HardOptIn, SoftOptIn -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md deleted file mode 100644 index 654f3495b7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOTenantTaxonomyReplicationParameters -schema: 2.0.0 ---- - -# Set-SPOTenantTaxonomyReplicationParameters - -## SYNOPSIS -Select groups for replication - - -## SYNTAX - -### ReplicateAllGroups -```powershell -Set-SPOTenantTaxonomyReplicationParameters [-ReplicateAllGroups] [<CommonParameters>] -``` - -### ReplicateSelectedGroups -```powershell -Set-SPOTenantTaxonomyReplicationParameters -ReplicatedGroups <String[]> [<CommonParameters>] -``` - -## DESCRIPTION -Before you run the cmdlets, please use �Connect-SPOService� to connect to SharePoint Online first. -By default, all global groups except system/search/people/sitecollection in primary location will be replicated to -satellite. - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Set-SPOTenantTaxonomyReplicationParameters -ReplicatedGroups "group1","group2" -``` -Tenant admin can use this cmdlet to select some groups only for replicating to overwrite default settings. - -### EXAMPLE 2 -```powershell -Set-SPOTenantTaxonomyReplicationParameters �ReplicateAllGroups -``` -Tenant admin can also reset to replicate all the groups. - - - -## PARAMETERS - -### -ReplicateAllGroups -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: ReplicateAllGroups -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicatedGroups -PARAMVALUE: String[] - - -```yaml -Type: String[] -Parameter Sets: ReplicateSelectedGroups -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) - -[Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md deleted file mode 100644 index 5bcae449f8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Set-SPOUser -schema: 2.0.0 ---- - -# Set-SPOUser - -## SYNOPSIS -Configures properties on an existing user. - - -## SYNTAX - -``` -Set-SPOUser -IsSiteCollectionAdmin <Boolean> -LoginName <String> -Site <SpoSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPOUser` cmdlet to configure properties of an existing user. -That is, to add or remove a user as a SharePoint Online site collection administrator. - -You must have the SharePoint Online global administrator permission to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -Set-SPOUser -Site https://contoso.sharepoint.com/sites/marketing -LoginName melissa.kerr@contoso.com -IsSiteCollectionAdmin $true -``` -This example makes melissa.kerr@contoso.com a SharePoint Online site collection administrator on https://contoso.sharepoint.com/sites/marketing. - - -## PARAMETERS - -### -IsSiteCollectionAdmin -Specifies whether the user is a site collection administrator. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName -Specifies the user name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the full URL of the site collection. It must be in a valid managed path in the company’s site. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOUser](Get-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOfficeStoreAppsDefaultActivation.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOfficeStoreAppsDefaultActivation.md deleted file mode 100644 index 1e5df38763..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOfficeStoreAppsDefaultActivation.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPOfficeStoreAppsDefaultActivation -schema: 2.0.0 ---- - -# Set-SPOfficeStoreAppsDefaultActivation - -## SYNOPSIS -Sets the properties of apps for Office. - - -## SYNTAX - -### AppsForOfficeSettingsInSiteSubscription -``` -Set-SPOfficeStoreAppsDefaultActivation -Enable <Boolean> -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### AppsForOfficeSettingsInWebApplication -``` -Set-SPOfficeStoreAppsDefaultActivation -Enable <Boolean> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPOfficeStoreAppsDefaultActivation` cmdlet to set app settings for Office that are on the Office Store and would be started when the document that contains those apps in their browser is opened. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -Set-SPOfficeStoreAppsDefaultActivation -SiteSubscription efca5b88-b3a3-448d-afbc-ef620f4744f1 -Enable $true -``` - -This example enables the apps for Office from the Office Store Office client that uses the subscription id, efca5b88-b3a3-448d-afbc-ef620f4744f1. - - -## PARAMETERS - -### -Enable -Specifies whether the apps for Office from the Office Store should be started. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the Site Group to which the settings apply. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: AppsForOfficeSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the web application to which the setting applies. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: AppsForOfficeSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPOfficeStoreAppsDefaultActivation](Get-SPOfficeStoreAppsDefaultActivation.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md deleted file mode 100644 index 394829d6cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Start-SPOSiteContentMove -schema: 2.0.0 ---- - -# Start-SPOSiteContentMove - -## SYNOPSIS -Start a job to move a particular user or group of users to be moved across geo locations relative to the one that executes the command - - -## SYNTAX - -### UrlAndDestinationDataLocation -```powershell -Start-SPOSiteContentMove [-Url] <String> [-DestinationDataLocation] <String> - [[-PreferredMoveBeginDate] <DateTime>] [[-PreferredMoveEndDate] <DateTime>] [[-Reserved] <String>] - [-ValidationOnly] [<CommonParameters>] -``` - -### GroupNameAndDestinationDataLocation -```powershell -Start-SPOSiteContentMove [-GroupName] <String> [-DestinationDataLocation] <String> - [[-PreferredMoveBeginDate] <DateTime>] [[-PreferredMoveEndDate] <DateTime>] [[-Reserved] <String>] - [-ValidationOnly] [<CommonParameters>] -``` - -### UrlAndDestinationUrl -```powershell -Start-SPOSiteContentMove [-Url] <String> [-DestinationUrl] <String> [[-PreferredMoveBeginDate] <DateTime>] - [[-PreferredMoveEndDate] <DateTime>] [[-Reserved] <String>] [-ValidationOnly] [<CommonParameters>] -``` - -## DESCRIPTION -This command starts the information and the status of a move request of a user between sites in a SharePoint Online Multi Geo tenant. - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Start-SPOSiteContentMove -Url $url -DestinationDataLocation $DestLocation -PreferredMoveBeginDate ((Get-Date).AddHour(1)) -PreferredMoveEndDate ((Get-Date).AddHour(12)) -``` -Starts the movement of the content on $url to the destination defined on $DestLocation variable preferred to start 1 hour ahead from now, until 12 hours to that relative time. - -### EXAMPLE 2 -```powershell -Start-SPOSiteContentMove -GroupName group@contoso.com -DestinationDataLocation $destlocation -``` -Starts the movement of a group of users called group@contoso.com to the destination location called $destlocation - -### EXAMPLE 3 -```powershell -Start-SPOSiteContentMove -Url $url -DestinationUrl $destlocation -``` -Starts the movement from a $url and set it to the location defined on $destlocation - - -## PARAMETERS - -### -DestinationDataLocation -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, GroupNameAndDestinationDataLocation -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationUrl -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: UrlAndDestinationUrl -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: GroupNameAndDestinationDataLocation -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMoveBeginDate -PARAMVALUE: DateTime - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMoveEndDate -PARAMVALUE: DateTime - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reserved -PARAMVALUE: String - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Destination URL where the move will take place - - -```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, UrlAndDestinationUrl -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidationOnly -PARAMVALUE: SwitchParameter - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOUserAndContentMoveState](Get-SPOUserAndContentMoveState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md deleted file mode 100644 index cf7f9a5d48..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Start-SPOUserAndContentMove -schema: 2.0.0 ---- - -# Start-SPOUserAndContentMove - -## SYNOPSIS -Starts the ability to move a user closer to their sites. - -## SYNTAX - -```powershell -Start-SPOUserAndContentMove [-UserPrincipalName] <String> [-DestinationDataLocation] <String> - [[-PreferredMoveBeginDate] <DateTime>] [[-PreferredMoveEndDate] <DateTime>] [-OverwriteOdb] - [[-Notify] <String>] [[-Reserved] <String>] [-ValidationOnly] [<CommonParameters>] -``` - -## DESCRIPTION -In a multi-geo company, this cmdlet requires a multi-geo tenant to work, and enables the ability to move a user closer to their sites - -## EXAMPLES - -### EXAMPLE 1 -```yaml -Start-SPOUserAndContentMove -UserPrinciplName username@contoso.com -DestinationDataLocation EUR -``` - -This example moves the user username@contoso.com from the current location, example NA to the European Site (EUR) - -### EXAMPLE 2 -```yaml -Start-SPOUserAndContentMove -UserPrinciplName username@contoso.com -DestinationDataLocation EUR -``` - -This example moves the user username@contoso.com from the current location, example NA to the European Site (EUR) - - -### EXAMPLE 3 -```yaml -Start-SPOUserAndContentMove -UserPrinciplName username@contoso.com -DestinationDataLocation EUR -``` - -This example moves the user username@contoso.com from the current location, example NA to the European Site (EUR) - - - -## PARAMETERS - -### -DestinationDataLocation -Defines the new destination of the user that you want to move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notify -Makes a SPO notification that the user is being move - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverwriteOdb -Switch parameter to Overwrite the information into the DB - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMoveBeginDate -Specifies what is the preferred Date and time to start the job - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMoveEndDate -Specifies what is the preferred Date and time to stop the job - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reserved -This parameter will only check for reserved users to be moved near to their sites - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -UserPrincipalName or UPN defined for the specific user on the SPO tenant - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidationOnly -This parameter will force the cmdlet to execute only validation - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md deleted file mode 100644 index 8f882eb66f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Stop-SPOUserAndContentMove -schema: 2.0.0 ---- - -# Stop-SPOUserAndContentMove - -## SYNOPSIS -In a Multi-Geo company, stops the ability to move a user's content related objects in a SharePoint Online Tenant - -## SYNTAX - -```powershell -Stop-SPOUserAndContentMove [-UserPrincipalName] <String> [<CommonParameters>] -``` - -## DESCRIPTION -Stops the ability to move a user's content related objects in a Sharepoint Online Tenant - -## EXAMPLES - -### EXAMPLE 1 -```yaml -Stop-SPOUserAndContentMove -UserPrincipalName TesIser@contoso.com -``` - -This example stops the ability to moves the movement of the objects for the "TesIser@contoso.com" in the current Tenant - -### EXAMPLE 2 -```yaml -Stop-SPOUserAndContentMove TesIser@contoso.com -``` - -Equivalent to the one above - -## PARAMETERS - -### -UserPrincipalName -UserPrincipalName or UPN defined for the specific user on the SPO tenant - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md b/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md deleted file mode 100644 index f2710cf726..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Submit-SPOMigrationJob -schema: 2.0.0 ---- - -# Submit-SPOMigrationJob - -## SYNOPSIS -Cmdlet to submit a new migration job referenced to a previously uploaded package in Azure Blob storage into to a site collection. - - -## SYNTAX - -### AzureLocationsInline -``` -Submit-SPOMigrationJob [-TargetWebUrl] <String> [-FileContainerUri] <String> [-PackageContainerUri] <String> - [-AzureQueueUri <String>] -Credentials <CredentialCmdletPipeBind> - [-EncryptionParameters <EncryptionParameters>] [-NoLogFile] [<CommonParameters>] -``` - -### AzureLocationsPipebind -``` -Submit-SPOMigrationJob [-TargetWebUrl] <String> - [-MigrationPackageAzureLocations] <MigrationPackageAzureLocations> -Credentials <CredentialCmdletPipeBind> - [-EncryptionParameters <EncryptionParameters>] [-NoLogFile] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets. - -This cmdlet returns a GUID value which represents the MigrationJobId, or returns an empty GUID if the job was not successfully created. - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Submit-SPOMigrationJob -TargetUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -FileContainerUri "https://migrationstore.blob.core.windows.net/migration-files?sv=2014-02-14&sr=c&sig=THTTJoeGHysxRLgv22j473XYS2blH1YAVIdsfWrPhq8=&se=2015-04-06T05:09:36Z&sp=rl" -PackageContainerUri "https://migrationstore.blob.core.windows.net/migration-package?sv=2014-02-14&sr=c&sig=2PCBJtiXsVWiK5GrY7jBEdyEAwtunQNJLH8uo6I0+Ew=&se=2015-04-06T05:09:37Z&sp=rwl" -``` -This example creates a new migration job in the target site collection for the web at the URL ‘https://contoso.sharepoint.com/sites/TargetSite/TargetWeb’. The migration job includes information about the file and package metadata Azure Storage containers that are passed into the command. - - -### -----------------------EXAMPLE 2----------------------------- -``` -Submit-SPOMigrationJob -TargetUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -MigrationPackageAzureLocations $azurelocations -``` -This example creates a new migration job in the target site collection for the web at the URL ‘https://contoso.sharepoint.com/sites/TargetSite/TargetWeb’. The migration job includes information about the file and package metadata Azure Storage containers that are passed into the command. - - -## PARAMETERS - -### -AzureQueueUri -An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import. - - -```yaml -Type: String -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session’s previous call to `Connect-SPOService` will be used to connect to the site collection. - - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionParameters -PARAMVALUE: EncryptionParameters - - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileContainerUri -A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package content files. - - -```yaml -Type: String -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationPackageAzureLocations -A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the `Set-SPOMigrationPackageAzureSource` cmdlet. - - -```yaml -Type: MigrationPackageAzureLocations -Parameter Sets: AzureLocationsPipebind -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoLogFile -Indicates to not create a log file. The default is to create a new CreateMigrationJob log file within the current directory. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageContainerUri -A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package metadata files. - - -```yaml -Type: String -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl -The fully qualified target web URL where the package will be imported into. This must include the same TargetWebURL that was used during `ConvertTo-SPOMigrationTargetedPackage`. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md deleted file mode 100644 index d8f0bcf2c1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Test-SPOSite -schema: 2.0.0 ---- - -# Test-SPOSite - -## SYNOPSIS -Tests a SharePoint Online site collection. - - -## SYNTAX - -``` -Test-SPOSite -Identity <SpoSitePipeBind> [-RuleId <Guid>] [-RunAlways] [<CommonParameters>] -``` - -## DESCRIPTION -The `Test-SPOSite` cmdlet runs one or all site collection health checks on the site collection and its contents. -Tests are intended not to make any changes except in repair mode, which can be initiated by running the `Repair-SPOSite` cmdlet. -This cmdlet reports the rules together with a summary of the results. - -You must be a SharePoint Online global administrator to run the `Test-SPOSite` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Test-SPOSite https://contoso.sharepoint.com/sites/marketing -``` - -This example runs all the site collection health checks on the https://contoso.sharepoint.com/sites/marketing site collection. - - -## PARAMETERS - -### -Identity -Specifies the SharePoint Online site collection to test. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RuleId -Specifies the health check rule to run. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunAlways -Displays a message that states the effect of the command instead of executing the command. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOSite](Get-SPOSite.md) - -[New-SPOSite](New-SPOSite.md) - -[Repair-SPOSite](Repair-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md deleted file mode 100644 index 949d7cb705..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Unregister-SPOHubSite -schema: 2.0.0 ---- - -# Unregister-SPOHubSite - -## SYNOPSIS -Disables the hub site feature on a site. - -## SYNTAX - -``` -Unregister-SPOHubSite [-Identity] <SpoHubSitePipeBind> -[-WhatIf] [-Confirm] -[<CommonParameters>] -``` - -## DESCRIPTION -Disables the hub site feature on a site so that it is no longer a hub site. Associated sites may still appear associated for up to an hour. If you want to speed up the process, use the Remove-SPOHubSiteAssociation cmdlet to remove the associates sites first. - -If the site doesn’t exist, this cmdlet returns a “File not found” error. - -## EXAMPLES - -### Example 1 - -``` -Unregister-SPOHubSite -Identity <guid> -``` - -This example removes a site from the hub site list based on unique hub identifier (<guid>). - -### Example 2 - -``` -Unregister-SPOHubSite -Identity https://contoso.sharepoint.com/sites/Marketing -``` - -This example disables the hub feature on the marketing site. - -## PARAMETERS - -### -Identity - -Guid based identifier or URL of the site to disable the hub site feature. If hub site has been already deleted, you will need to use a Guid based identifier to remove the site from the list of hub sites. - -```yaml -Type: SpoHubSitePipeBind -Parameter Sets: (All) -Aliases: HubSite -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md deleted file mode 100644 index 770ea34e8c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: sharepointonline.xml -applicable: SharePoint Online -title: Upgrade-SPOSite -schema: 2.0.0 ---- - -# Upgrade-SPOSite - -## SYNOPSIS -Starts the upgrade process on a site collection. - - -## SYNTAX - -``` -Upgrade-SPOSite [-Confirm] -Identity <SpoSitePipeBind> [-NoEmail] [-QueueOnly] [-VersionUpgrade] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Upgrade-SPOSite` cmdlet activates the upgrade process for the specified SharePoint Online site collection. -This cmdlet can also be used to resume failed upgrades. - -When upgrade is initiated, it can either be a build-to-build or version-to-version upgrade. -The default is build-to-build upgrade. -When in version-to-version upgrade, site collection health checks are first run in repair mode to ensure that the site collection can be upgraded successfully. - -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing -``` - -Example 1 runs a build-to-build upgrade of the existing site collection https://contoso.sharepoint.com/sites/marketing. The CompatibilityLevel property associated with the site collection is not changed by this operation. For more information about CompatibilityLevel, see `New-SPOSite`. - -### -----------------------EXAMPLE 2----------------------------- -``` -Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing -VersionUpgrade -``` - -Example 2 runs a version-to-version upgrade of the existing site collection https://contoso.sharepoint.com/sites/marketing. The CompatibilityLevel property associated with the site collection is changed to a value of SharePoint 2013 by this operation. For more information about CompatibilityLevel, see `New-SPOSite`. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the SharePoint Online site collection to upgrade. - - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoEmail -Specifies that the system not send the requester and site collection administrators a notification e-mail message at the end of the upgrade process. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueOnly -Adds the site collection to the upgrade queue. The upgrade does not occur immediately. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionUpgrade -Specifies whether to perform a version-to-version upgrade on the site collection. When this parameter is set, it internally triggers any available build-to-build upgrade associated with the current site collection operating mode and continues with version-to-version upgrade. When this parameter is not set, it triggers only build-to-build upgrade on the site collection. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Request-SPOUpgradeEvaluationSite](Request-SPOUpgradeEvaluationSite.md) - -[New-SPOSite](New-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md deleted file mode 100644 index be570ad2dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -Module Name: SharePoint Online PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: sharepoint-online -Locale: en-US ---- - -# SharePoint Online PowerShell - -## Description - -The following cmdlet references are for SharePoint Online. - -## sharepoint-online Cmdlets - -### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) -{{Manually Enter Add-SPOGeoAdministrator Description Here}} - -### [Add-SPOHubSiteAssociation](Add-SPOHubSiteAssociation.md) -{{Manually Enter Add-SPOHubSiteAssociation Description Here}} - -### [Add-SPOSiteDesign](Add-SPOSiteDesign.md) -{{Manually Enter Add-SPOSiteDesign Description Here}} - -### [Add-SPOSiteDesign](Add-SPOSiteDesignTask.md) -{{Manually Enter Add-SPOSiteDesignTask Description Here}} - -### [Add-SPOSiteScript](Add-SPOSiteScript.md) -{{Manually Enter Add-SPOSiteScript Description Here}} - -### [Add-SPOTenantCdnOrigin](Add-SPOTenantCdnOrigin.md) -{{Manually Enter Add-SPOTenantCdnOrigin Description Here}} - -### [Add-SPOTheme](Add-SPOTheme.md) -{{Manually Enter Add-SPOTheme Description Here}} - -### [Add-SPOUser](Add-SPOUser.md) -{{Manually Enter Add-SPOUser Description Here}} - -### [Approve-SPOTenantServicePrincipalPermissionRequest](Approve-SPOTenantServicePrincipalPermissionRequest.md) -{{Manually Enter Approve-SPOTenantServicePrincipalPermissionRequest Description Here}} - -### [Connect-SPOService](Connect-SPOService.md) -{{Manually Enter Connect-SPOService Description Here}} - -### [Deny-SPOTenantServicePrincipalPermissionRequest](Deny-SPOTenantServicePrincipalPermissionRequest.md) -{{Manually Enter Deny-SPOTenantServicePrincipalPermissionRequest Description Here}} - -### [Disable-SPOTenantServicePrincipal](Disable-SPOTenantServicePrincipal.md) -{{Manually Enter Connect-SPOService Description Here}} - -### [Disconnect-SPOService](Disconnect-SPOService.md) -{{Manually Enter Disconnect-SPOService Description Here}} - -### [Enable-SPOTenantServicePrincipal](Enable-SPOTenantServicePrincipal.md) -{{Manually Enter Enable-SPOTenantServicePrincipal Description Here}} - -### [Export-SPOUserInfo](Export-SPOUserInfo.md) -{{Manually Enter Export-SPOUserInfo Description Here}} - -### [Get-SPOAppErrors](Get-SPOAppErrors.md) -{{Manually Enter Get-SPOAppErrors Description Here}} - -### [Get-SPOAppInfo](Get-SPOAppInfo.md) -{{Manually Enter Get-SPOAppInfo Description Here}} - -### [Get-SPOCrossGeoMovedUsers](Get-SPOCrossGeoMovedUsers.md) -{{Manually Enter Get-SPOCrossGeoMovedUsers Description Here}} - -### [Get-SPOCrossGeoUsers](Get-SPOCrossGeoUsers.md) -{{Manually Enter Get-SPOCrossGeoUsers Description Here}} - -### [Get-SPODataConnectionSetting](Get-SPODataConnectionSetting.md) -{{Manually Enter Get-SPODataConnectionSetting Description Here}} - -### [Get-SPODataConnectionSettingMetadata](Get-SPODataConnectionSettingMetadata.md) -{{Manually Enter Get-SPODataConnectionSettingMetadata Description Here}} - -### [Get-SPODeletedSite](Get-SPODeletedSite.md) -{{Manually Enter Get-SPODeletedSite Description Here}} - -### [Get-SPOExternalUser](Get-SPOExternalUser.md) -{{Manually Enter Get-SPOExternalUser Description Here}} - -### [Get-SPOfficeStoreAppsDefaultActivation](Get-SPOfficeStoreAppsDefaultActivation.md) -{{Manually Enter Get-SPOfficeStoreAppsDefaultActivation Description Here}} - -### [Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) -{{Manually Enter Get-SPOGeoAdministrators Description Here}} - -### [Get-SPOGeoMoveCompatibilityStatus](Get-SPOGeoMoveCompatibilityStatus.md) -{{Manually Enter Get-SPOGeoMoveCompatibilityStatus Description Here}} - -### [Get-SPOGeoStorageQuota](Get-SPOGeoStorageQuota.md) -{{Manually Enter Get-SPOGeoStorageQuota Description Here}} - -### [Get-SPOHideDefaultThemes](Get-SPOHideDefaultThemes.md) -{{Manually Enter Get-SPOHideDefaultThemes Description Here}} - -### [Get-SPOHubSite](Get-SPOHubSite.md) -{{Manually Enter Get-SPOHubSite Description Here}} - -### [Get-SPOMigrationJobProgress](Get-SPOMigrationJobProgress.md) -{{Manually Enter Get-SPOMigrationJobProgress Description Here}} - -### [Get-SPOMigrationJobStatus](Get-SPOMigrationJobStatus.md) -{{Manually Enter Get-SPOMigrationJobStatus Description Here}} - -### [Get-SPOPublicCdnOrigins](Get-SPOPublicCdnOrigins.md) -{{Manually Enter Get-SPOPublicCdnOrigins Description Here}} - -### [Get-SPOSite](Get-SPOSite.md) -{{Manually Enter Get-SPOSite Description Here}} - -### [Get-SPOSiteContentMoveState](Get-SPOSiteContentMoveState.md) -{{Manually Enter Get-SPOSiteContentMoveState Description Here}} - -### [Get-SPOSiteDesign](Get-SPOSiteDesign.md) -{{Manually Enter Get-SPOSiteDesign Description Here}} - -### [Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) -{{Manually Enter Get-SPOSiteDesignRights Description Here}} - -### [Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) -{{Manually Enter Get-SPOSiteDesignRights Description Here}} - -### [Get-SPOSiteDesignRights](Get-SPOSiteDesignRights.md) -{{Manually Enter Get-SPOSiteDesignRights Description Here}} - -### [Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md) -{{Manually Enter Add-SPOSiteDesign Description Here}} - -### [Get-SPOSiteGroup](Get-SPOSiteGroup.md) -{{Manually Enter Get-SPOSiteGroup Description Here}} - -### [Get-SPOSiteScript](Get-SPOSiteScript.md) -{{Manually Enter Get-SPOSiteScript Description Here}} - -### [Get-SPOSiteScriptFromList](Get-SPOSiteScriptFromList.md) -{{Manually Enter Get-SPOSiteScript Description Here}} - -### [Get-SPOTenant](Get-SPOTenant.md) -{{Manually Enter Get-SPOTenant Description Here}} - -### [Get-SPOTenantCdnEnabled](Get-SPOTenantCdnEnabled.md) -{{Manually Enter Get-SPOTenantCdnEnabled Description Here}} - -### [Get-SPOTenantCdnOrigins](Get-SPOTenantCdnOrigins.md) -{{Manually Enter Get-SPOTenantCdnOrigins Description Here}} - -### [Get-SPOTenantCdnPolicies](Get-SPOTenantCdnPolicies.md) -{{Manually Enter Get-SPOTenantCdnPolicies Description Here}} - -### [Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) -{{Manually Enter Get-SPOTenantContentTypeReplicationParameters Description Here}} - -### [Get-SPOTenantLogEntry](Get-SPOTenantLogEntry.md) -{{Manually Enter Get-SPOTenantLogEntry Description Here}} - -### [Get-SPOTenantLogLastAvailableTimeInUtc](Get-SPOTenantLogLastAvailableTimeInUtc.md) -{{Manually Enter Get-SPOTenantLogLastAvailableTimeInUtc Description Here}} - -### [Get-SPOTenantServicePrincipalPermissionGrants](Get-SPOTenantServicePrincipalPermissionGrants.md) -{{Manually Enter Get-SPOTenantServicePrincipalPermissionGrants Description Here}} - -### [Get-SPOTenantServicePrincipalPermissionRequests](Get-SPOTenantServicePrincipalPermissionRequests.md) -{{Manually Enter Get-SPOTenantServicePrincipalPermissionRequests Description Here}} - -### [Get-SPOTenantSyncClientRestriction](Get-SPOTenantSyncClientRestriction.md) -{{Manually Enter Get-SPOTenantSyncClientRestriction Description Here}} - -### [Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) -{{Manually Enter Get-SPOTenantTaxonomyReplicationParameters Description Here}} - -### [Get-SPOTheme](Get-SPOTheme.md) -{{Manually Enter Get-SPOTheme Description Here}} - -### [Get-SPOUser](Get-SPOUser.md) -{{Manually Enter Get-SPOUser Description Here}} - -### [Get-SPOUserAndContentMoveState](Get-SPOUserAndContentMoveState.md) -{{Manually Enter Get-SPOUserAndContentMoveState Description Here}} - -### [Get-SPOUserOneDriveLocation](Get-SPOUserOneDriveLocation.md) -{{Manually Enter Get-SPOUserOneDriveLocation Description Here}} - -### [Get-SPOWebTemplate](Get-SPOWebTemplate.md) -{{Manually Enter Get-SPOWebTemplate Description Here}} - -### [Grant-SPOHubSiteRights](Grant-SPOHubSiteRights.md) -{{Manually Enter Grant-SPOHubSiteRights Description Here}} - -### [Grant-SPOSiteDesignRights](Grant-SPOSiteDesignRights.md) -{{Manually Enter Grant-SPOSiteDesignRights Description Here}} - -### [Invoke-SPOMigrationEncryptUploadSubmit](Invoke-SPOMigrationEncryptUploadSubmit.md) -{{Manually Enter Invoke-SPOMigrationEncryptUploadSubmit Description Here}} - -### [Invoke-SPOSiteDesign](Invoke-SPOSiteDesign.md) -{{Manually Enter Invoke-SPOSiteDesign Description Here}} - -### [New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) -{{Manually Enter New-SPODataConnectionSetting Description Here}} - -### [New-SPOMigrationEncryptionParameters](New-SPOMigrationEncryptionParameters.md) -{{Manually Enter New-SPOMigrationEncryptionParameters Description Here}} - -### [New-SPOMigrationPackage](New-SPOMigrationPackage.md) -{{Manually Enter New-SPOMigrationPackage Description Here}} - -### [New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy](New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md) -{{Manually Enter New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy Description Here}} - -### [New-SPOPublicCdnOrigin](New-SPOPublicCdnOrigin.md) -{{Manually Enter New-SPOPublicCdnOrigin Description Here}} - -### [New-SPOSdnProvider](New-SPOSdnProvider.md) -{{Manually Enter New-SPOSdnProvider Description Here}} - -### [New-SPOSite](New-SPOSite.md) -{{Manually Enter New-SPOSite Description Here}} - -### [New-SPOSiteGroup](New-SPOSiteGroup.md) -{{Manually Enter New-SPOSiteGroup Description Here}} - -### [Register-SPOHubSite](Register-SPOHubSite.md) -{{Manually Enter Register-SPOHubSite Description Here}} - -### [Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) -{{Manually Enter Remove-SPODataConnectionSetting Description Here}} - -### [Remove-SPODeletedSite](Remove-SPODeletedSite.md) -{{Manually Enter Remove-SPODeletedSite Description Here}} - -### [Remove-SPOExternalUser](Remove-SPOExternalUser.md) -{{Manually Enter Remove-SPOExternalUser Description Here}} - -### [Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) -{{Manually Enter Remove-SPOGeoAdministrator Description Here}} - -### [Remove-SPOHubSiteAssociation](Remove-SPOHubSiteAssociation.md) -{{Manually Enter Remove-SPOHubSiteAssociation Description Here}} - -### [Remove-SPOMigrationJob](Remove-SPOMigrationJob.md) -{{Manually Enter Remove-SPOMigrationJob Description Here}} - -### [Remove-SPOPublicCdnOrigin](Remove-SPOPublicCdnOrigin.md) -{{Manually Enter Remove-SPOPublicCdnOrigin Description Here}} - -### [Remove-SPOSdnProvider](Remove-SPOSdnProvider.md) -{{Manually Enter Remove-SPOSdnProvider Description Here}} - -### [Remove-SPOSite](Remove-SPOSite.md) -{{Manually Enter Remove-SPOSite Description Here}} - -### [Remove-SPOSiteDesign](Remove-SPOSiteDesign.md) -{{Manually Enter Remove-SPOSiteDesign Description Here}} - -### [Remove-SPOSiteDesignTask](Remove-SPOSiteDesignTask.md) -{{Manually Enter Remove-SPOSiteDesign Description Here}} - -### [Remove-SPOSiteGroup](Remove-SPOSiteGroup.md) -{{Manually Enter Remove-SPOSiteGroup Description Here}} - -### [Remove-SPOSiteScript](Remove-SPOSiteScript.md) -{{Manually Enter Remove-SPOSiteScript Description Here}} - -### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md) -{{Manually Enter Remove-SPOTenantCdnOrigin Description Here}} - -### [Remove-SPOTenantSyncClientRestriction](Remove-SPOTenantSyncClientRestriction.md) -{{Manually Enter Remove-SPOTenantSyncClientRestriction Description Here}} - -### [Remove-SPOTheme](Remove-SPOTheme.md) -{{Manually Enter Remove-SPOTheme Description Here}} - -### [Remove-SPOUser](Remove-SPOUser.md) -{{Manually Enter Remove-SPOUser Description Here}} - -### [Repair-SPOSite](Repair-SPOSite.md) -{{Manually Enter Repair-SPOSite Description Here}} - -### [Request-SPOPersonalSite](Request-SPOPersonalSite.md) -{{Manually Enter Request-SPOPersonalSite Description Here}} - -### [Request-SPOUpgradeEvaluationSite](Request-SPOUpgradeEvaluationSite.md) -{{Manually Enter Request-SPOUpgradeEvaluationSite Description Here}} - -### [Restore-SPODeletedSite](Restore-SPODeletedSite.md) -{{Manually Enter Restore-SPODeletedSite Description Here}} - -### [Revoke-SPObjectSecurity](Revoke-SPObjectSecurity.md) -{{Manually Enter Revoke-SPObjectSecurity Description Here}} - -### [Revoke-SPOHubSiteRights](Revoke-SPOHubSiteRights.md) -{{Manually Enter Revoke-SPOHubSiteRights Description Here}} - -### [Revoke-SPOSiteDesignRights](Revoke-SPOSiteDesignRights.md) -{{Manually Enter Revoke-SPOSiteDesignRights Description Here}} - -### [Revoke-SPOTenantServicePrincipalPermission](Revoke-SPOTenantServicePrincipalPermission.md) -{{Manually Enter Revoke-SPOTenantServicePrincipalPermission Description Here}} - -### [Revoke-SPOUserSession](Revoke-SPOUserSession.md) -{{Manually Enter Revoke-SPOUserSession Description Here}} - -### [Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) -{{Manually Enter Set-SPODataConnectionSetting Description Here}} - -### [Set-SPODataConnectionSettingMetadata](Set-SPODataConnectionSettingMetadata.md) -{{Manually Enter Set-SPODataConnectionSettingMetadata Description Here}} - -### [Set-SPOfficeStoreAppsDefaultActivation](Set-SPOfficeStoreAppsDefaultActivation.md) -{{Manually Enter Set-SPOfficeStoreAppsDefaultActivation Description Here}} - -### [Set-SPOGeoStorageQuota](Set-SPOGeoStorageQuota.md) -{{Manually Enter Set-SPOGeoStorageQuota Description Here}} - -### [Set-SPOHideDefaultThemes](Set-SPOHideDefaultThemes.md) -{{Manually Enter Set-SPOHideDefaultThemes Description Here}} - -### [Set-SPOHubSite](Set-SPOHubSite.md) -{{Manually Enter Set-SPOHubSite Description Here}} - -### [Set-SPOMigrationPackageAzureSource](Set-SPOMigrationPackageAzureSource.md) -{{Manually Enter Set-SPOMigrationPackageAzureSource Description Here}} - -### [Set-SPOSite](Set-SPOSite.md) -{{Manually Enter Set-SPOSite Description Here}} - -### [Set-SPOSiteDesign](Set-SPOSiteDesign.md) -{{Manually Enter Set-SPOSiteDesign Description Here}} - -### [Set-SPOSiteGroup](Set-SPOSiteGroup.md) -{{Manually Enter Set-SPOSiteGroup Description Here}} - -### [Set-SPOSiteScript](Set-SPOSiteScript.md) -{{Manually Enter Set-SPOSiteScript Description Here}} - -### [Set-SPOTenant](Set-SPOTenant.md) -{{Manually Enter Set-SPOTenant Description Here}} - -### [Set-SPOTenantCdnEnabled](Set-SPOTenantCdnEnabled.md) -{{Manually Enter Set-SPOTenantCdnEnabled Description Here}} - -### [Set-SPOTenantCdnPolicy](Set-SPOTenantCdnPolicy.md) -{{Manually Enter Set-SPOTenantCdnPolicy Description Here}} - -### [Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) -{{Manually Enter Set-SPOTenantContentTypeReplicationParameters Description Here}} - -### [Set-SPOTenantSyncClientRestriction](Set-SPOTenantSyncClientRestriction.md) -{{Manually Enter Set-SPOTenantSyncClientRestriction Description Here}} - -### [Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) -{{Manually Enter Set-SPOTenantTaxonomyReplicationParameters Description Here}} - -### [Set-SPOUser](Set-SPOUser.md) -{{Manually Enter Set-SPOUser Description Here}} - -### [Start-SPOSiteContentMove](Start-SPOSiteContentMove.md) -{{Manually Enter Start-SPOSiteContentMove Description Here}} - -### [Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) -{{Manually Enter Start-SPOUserAndContentMove Description Here}} - -### [Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md) -{{Manually Enter Stop-SPOUserAndContentMove Description Here}} - -### [Submit-SPOMigrationJob](Submit-SPOMigrationJob.md) -{{Manually Enter Submit-SPOMigrationJob Description Here}} - -### [Test-SPOSite](Test-SPOSite.md) -{{Manually Enter Test-SPOSite Description Here}} - -### [Unregister-SPOHubSite](Unregister-SPOHubSite.md) -{{Manually Enter Unregister-SPOHubSite Description Here}} - -### [Upgrade-SPOSite](Upgrade-SPOSite.md) -{{Manually Enter Upgrade-SPOSite Description Here}} - - -<!--updated March 6, 2018; moved cmdlets from https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-powershell; added items from TOC that were missing on this page--> diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md deleted file mode 100644 index 3324129976..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPApp - -## SYNOPSIS -Add/uploads an available app to the app catalog - -## SYNTAX - -### Add only -```powershell -Add-PnPApp -Path <String> - [-Scope <AppCatalogScope>] - [-Overwrite [<SwitchParameter>]] - [-Timeout <Int>] - [-Connection <SPOnlineConnection>] -``` - -### Add and Publish -```powershell -Add-PnPApp -Path <String> - -Publish [<SwitchParameter>] - [-SkipFeatureDeployment [<SwitchParameter>]] - [-Scope <AppCatalogScope>] - [-Overwrite [<SwitchParameter>]] - [-Timeout <Int>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPApp -Path ./myapp.sppkg -``` - -This will upload the specified app package to the app catalog - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPApp -Path ./myapp.sppkg -Publish -``` - -This will upload the specified app package to the app catalog and deploy/trust it at the same time. - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPApp -Path ./myapp.sppkg -Scope Site -Publish -``` - -This will upload the specified app package to the site collection app catalog and deploy/trust it at the same time. - -## PARAMETERS - -### -Overwrite -Overwrites the existing app package if it already exists - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Specifies the Id or an actual app metadata instance - -```yaml -Type: String -Parameter Sets: Add only, Add and Publish - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Publish -This will deploy/trust an app into the app catalog - -```yaml -Type: SwitchParameter -Parameter Sets: Add and Publish - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SkipFeatureDeployment - - -```yaml -Type: SwitchParameter -Parameter Sets: Add and Publish - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Timeout -Specifies the timeout in seconds. Defaults to 200. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.ALM.AppMetadata - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md deleted file mode 100644 index 6b440bb26d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPClientSidePage - -## SYNOPSIS -Adds a Client-Side Page - -## SYNTAX - -```powershell -Add-PnPClientSidePage -Name <String> - [-LayoutType <ClientSidePageLayoutType>] - [-PromoteAs <ClientSidePagePromoteType>] - [-CommentsEnabled [<SwitchParameter>]] - [-Publish [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPClientSidePage -Name "NewPage" -``` - -Creates a new Client-Side page named 'NewPage' - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPClientSidePage "NewPage" -``` - -Creates a new Client-Side page named 'NewPage' - -## PARAMETERS - -### -CommentsEnabled -Enables or Disables the comments on the page - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LayoutType -Specifies the layout type of the page. - -```yaml -Type: ClientSidePageLayoutType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -Specifies the name of the page. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -PromoteAs -Allows to promote the page for a specific purpose (HomePage | NewsPage) - -```yaml -Type: ClientSidePagePromoteType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Publish -Publishes the page once it is saved. Applicable to libraries set to create major and minor versions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md deleted file mode 100644 index ad0c7022eb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPClientSidePageSection - -## SYNOPSIS -Adds a new section to a Client-Side page - -## SYNTAX - -```powershell -Add-PnPClientSidePageSection -Page <ClientSidePagePipeBind> - -SectionTemplate <CanvasSectionTemplate> - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPClientSidePageSection -Page "MyPage" -SectionTemplate OneColumn -``` - -Adds a new one-column section to the Client-Side page 'MyPage' - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPClientSidePageSection -Page "MyPage" -SectionTemplate ThreeColumn -Order 10 -``` - -Adds a new Three columns section to the Client-Side page 'MyPage' with an order index of 10 - -### ------------------EXAMPLE 3------------------ -```powershell -$page = Add-PnPClientSidePage -Name "MyPage" -PS> Add-PnPClientSidePageSection -Page $page -SectionTemplate OneColumn -``` - -Adds a new one column section to the Client-Side page 'MyPage' - -## PARAMETERS - -### -Order -Sets the order of the section. (Default = 1) - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Page -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SectionTemplate -Specifies the columns template to use for the section. - -```yaml -Type: CanvasSectionTemplate -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md deleted file mode 100644 index d99b77fae6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPClientSideText - -## SYNOPSIS -Adds a text element to a client-side page. - -## SYNTAX - -### Default -```powershell -Add-PnPClientSideText -Page <ClientSidePagePipeBind> - -Text <String> - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Positioned -```powershell -Add-PnPClientSideText -Page <ClientSidePagePipeBind> - -Text <String> - -Section <Int> - -Column <Int> - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds a new text element to a section on a client-side page. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPClientSideText -Page "MyPage" -Text "Hello World!" -``` - -Adds the text 'Hello World!' to the Client-Side Page 'MyPage' - -## PARAMETERS - -### -Column -Sets the column where to insert the text control. - -```yaml -Type: Int -Parameter Sets: Positioned - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Order -Sets the order of the text control. (Default = 1) - -```yaml -Type: Int -Parameter Sets: Default, Positioned - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Page -The name of the page. - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: Default, Positioned - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Section -Sets the section where to insert the text control. - -```yaml -Type: Int -Parameter Sets: Positioned - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Text -Specifies the text to display in the text area. - -```yaml -Type: String -Parameter Sets: Default, Positioned - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md deleted file mode 100644 index 865f8dbd92..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPClientSideWebPart - -## SYNOPSIS -Adds a Client-Side Web Part to a client-side page - -## SYNTAX - -### Default with built-in webpart -```powershell -Add-PnPClientSideWebPart -Page <ClientSidePagePipeBind> - -DefaultWebPartType <DefaultClientSideWebParts> - [-WebPartProperties <PropertyBagPipeBind>] - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Default with 3rd party webpart -```powershell -Add-PnPClientSideWebPart -Page <ClientSidePagePipeBind> - -Component <ClientSideComponentPipeBind> - [-WebPartProperties <PropertyBagPipeBind>] - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Positioned with built-in webpart -```powershell -Add-PnPClientSideWebPart -Page <ClientSidePagePipeBind> - -DefaultWebPartType <DefaultClientSideWebParts> - -Section <Int> - -Column <Int> - [-WebPartProperties <PropertyBagPipeBind>] - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Positioned with 3rd party webpart -```powershell -Add-PnPClientSideWebPart -Page <ClientSidePagePipeBind> - -Component <ClientSideComponentPipeBind> - -Section <Int> - -Column <Int> - [-WebPartProperties <PropertyBagPipeBind>] - [-Order <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds a client-side web part to an existing client-side page. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPClientSideWebPart -Page "MyPage" -DefaultWebPartType BingMap -``` - -Adds a built-in Client-Side component 'BingMap' to the page called 'MyPage' - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPClientSideWebPart -Page "MyPage" -Component "HelloWorld" -``` - -Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPClientSideWebPart -Page "MyPage" -Component "HelloWorld" -Section 1 -Column 2 -``` - -Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' in section 1 and column 2 - -## PARAMETERS - -### -Column -Sets the column where to insert the WebPart control. - -```yaml -Type: Int -Parameter Sets: Positioned with built-in webpart, Positioned with 3rd party webpart - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Component -Specifies the component instance or Id to add. - -```yaml -Type: ClientSideComponentPipeBind -Parameter Sets: Default with 3rd party webpart, Positioned with 3rd party webpart - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DefaultWebPartType -Defines a default WebPart type to insert. - -```yaml -Type: DefaultClientSideWebParts -Parameter Sets: Default with built-in webpart, Positioned with built-in webpart - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Order -Sets the order of the WebPart control. (Default = 1) - -```yaml -Type: Int -Parameter Sets: Default with built-in webpart, Default with 3rd party webpart, Positioned with built-in webpart, Positioned with 3rd party webpart - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Page -The name of the page. - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: Default with built-in webpart, Default with 3rd party webpart, Positioned with built-in webpart, Positioned with 3rd party webpart - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Section -Sets the section where to insert the WebPart control. - -```yaml -Type: Int -Parameter Sets: Positioned with built-in webpart, Positioned with 3rd party webpart - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -WebPartProperties -The properties of the WebPart - -```yaml -Type: PropertyBagPipeBind -Parameter Sets: Default with built-in webpart, Default with 3rd party webpart, Positioned with built-in webpart, Positioned with 3rd party webpart - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md deleted file mode 100644 index 93fb434d3f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPContentType - -## SYNOPSIS -Adds a new content type - -## SYNTAX - -```powershell -Add-PnPContentType -Name <String> - [-ContentTypeId <String>] - [-Description <String>] - [-Group <String>] - [-ParentContentType <ContentType>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct -``` - -This will add a new content type based on the parent content type stored in the $ct variable. - -## PARAMETERS - -### -ContentTypeId -If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -Specifies the description of the new content type - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Group -Specifies the group of the new content type - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -Specify the name of the new content type - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ParentContentType -Specifies the parent of the new content type - -```yaml -Type: ContentType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.ContentType - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md deleted file mode 100644 index a50a5f0d6e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPContentTypeToDocumentSet - -## SYNOPSIS -Adds a content type to a document set - -## SYNTAX - -```powershell -Add-PnPContentTypeToDocumentSet -ContentType <ContentTypePipeBind[]> - -DocumentSet <DocumentSetPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set" -``` - -This will add the content type called 'Test CT' to the document set called ''Test Document Set' - -### ------------------EXAMPLE 2------------------ -```powershell -$docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set" -$ct = Get-PnPContentType -Identity "Test CT" -Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset -``` - -This will add the content type called 'Test CT' to the document set called ''Test Document Set' - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B -``` - -This will add the content type called 'Test CT' to the document set called ''Test Document Set' - -## PARAMETERS - -### -ContentType -The content type object, name or id to add. Either specify name, an id, or a content type object. - -```yaml -Type: ContentTypePipeBind[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DocumentSet -The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object - -```yaml -Type: DocumentSetPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md deleted file mode 100644 index 2d5910c7ea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPContentTypeToList - -## SYNOPSIS -Adds a new content type to a list - -## SYNTAX - -```powershell -Add-PnPContentTypeToList -List <ListPipeBind> - -ContentType <ContentTypePipeBind> - [-DefaultContentType [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType -``` - -This will add an existing content type to a list and sets it as the default content type - -## PARAMETERS - -### -ContentType -Specifies the content type that needs to be added to the list - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DefaultContentType -Specify if the content type needs to be the default content type or not - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -Specifies the list to which the content type needs to be added - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md deleted file mode 100644 index 263965be65..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPCustomAction - -## SYNOPSIS -Adds a custom action - -## SYNTAX - -### Client Side Component Id -```powershell -Add-PnPCustomAction -Name <String> - -Title <String> - -Location <String> - -ClientSideComponentId <GuidPipeBind> - [-RegistrationId <String>] - [-RegistrationType <UserCustomActionRegistrationType>] - [-Scope <CustomActionScope>] - [-ClientSideComponentProperties <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Default -```powershell -Add-PnPCustomAction -Name <String> - -Title <String> - -Description <String> - -Group <String> - -Location <String> - [-Sequence <Int>] - [-Url <String>] - [-ImageUrl <String>] - [-CommandUIExtension <String>] - [-RegistrationId <String>] - [-Rights <PermissionKind[]>] - [-RegistrationType <UserCustomActionRegistrationType>] - [-Scope <CustomActionScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds a user custom action to a web or sitecollection. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$cUIExtn = "<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location=""Ribbon.List.Share.Controls._children""><Button Id=""Ribbon.List.Share.GetItemsCountButton"" Alt=""Get list items count"" Sequence=""11"" Command=""Invoke_GetItemsCountButtonRequest"" LabelText=""Get Items Count"" TemplateAlias=""o1"" Image32by32=""_layouts/15/images/placeholder32x32.png"" Image16by16=""_layouts/15/images/placeholder16x16.png"" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command=""Invoke_GetItemsCountButtonRequest"" CommandAction=""javascript: alert('Total items in this list: '+ ctx.TotalListItems);"" EnabledScript=""javascript: function checkEnable() { return (true);} checkEnable();""/></CommandUIHandlers></CommandUIExtension>" - -Add-PnPCustomAction -Name 'GetItemsCount' -Title 'Invoke GetItemsCount Action' -Description 'Adds custom action to custom list ribbon' -Group 'SiteActions' -Location 'CommandUI.Ribbon' -CommandUIExtension $cUIExtn -``` - -Adds a new custom action to the custom list template, and sets the Title, Name and other fields with the specified values. On click it shows the number of items in that list. Notice: escape quotes in CommandUIExtension. - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPCustomAction -Title "CollabFooter" -Name "CollabFooter" -Location "ClientSideExtension.ApplicationCustomizer" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"} -``` - -Adds a new application customizer to the site. This requires that an SPFX solution has been deployed containing the application customizer specified. - -## PARAMETERS - -### -ClientSideComponentId -The Client Side Component Id of the custom action - -Only applicable to: SharePoint Online - -```yaml -Type: GuidPipeBind -Parameter Sets: Client Side Component Id - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ClientSideComponentProperties -The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}" - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: Client Side Component Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CommandUIExtension -XML fragment that determines user interface properties of the custom action - -```yaml -Type: String -Parameter Sets: Default - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description of the custom action - -```yaml -Type: String -Parameter Sets: Default - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Group -The group where this custom action needs to be added like 'SiteActions' - -```yaml -Type: String -Parameter Sets: Default - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ImageUrl -The URL of the image associated with the custom action - -```yaml -Type: String -Parameter Sets: Default - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Location -The actual location where this custom action need to be added like 'CommandUI.Ribbon' - -```yaml -Type: String -Parameter Sets: Default, Client Side Component Id - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Name -The name of the custom action - -```yaml -Type: String -Parameter Sets: Default, Client Side Component Id - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -RegistrationId -The identifier of the object associated with the custom action. - -```yaml -Type: String -Parameter Sets: Default, Client Side Component Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RegistrationType -Specifies the type of object associated with the custom action - -```yaml -Type: UserCustomActionRegistrationType -Parameter Sets: Default, Client Side Component Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Rights -A string array that contain the permissions needed for the custom action - -```yaml -Type: PermissionKind[] -Parameter Sets: Default - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Scope -The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command. - -```yaml -Type: CustomActionScope -Parameter Sets: Default, Client Side Component Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Sequence -Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page. - -```yaml -Type: Int -Parameter Sets: Default - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the custom action - -```yaml -Type: String -Parameter Sets: Default, Client Side Component Id - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -The URL, URI or ECMAScript (JScript, JavaScript) function associated with the action - -```yaml -Type: String -Parameter Sets: Default - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[UserCustomAction](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.usercustomaction.aspx)[BasePermissions](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.basepermissions.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md deleted file mode 100644 index 784948c13d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPDataRowsToProvisioningTemplate - -## SYNOPSIS -Adds datarows to a list inside a PnP Provisioning Template - -## SYNTAX - -```powershell -Add-PnPDataRowsToProvisioningTemplate -Path <String> - -List <ListPipeBind> - -Query <String> - [-Fields <String[]>] - [-TokenizeUrls [<SwitchParameter>]] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-IncludeSecurity [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice' -``` - -Adds datarows to a list in an in-memory PnP Provisioning Template - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice' -IncludeSecurity -``` - -Adds datarows to a list in an in-memory PnP Provisioning Template - -## PARAMETERS - -### -Fields -The fields to retrieve. If not specified all fields will be loaded in the returned list object. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeSecurity -A switch to include ObjectSecurity information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: 5 -Accept pipeline input: False -``` - -### -List -The list to query - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Path -Filename of the .PNP Open XML site template to read from, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Query -The CAML query to execute against the list - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while loading the template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: 4 -Accept pipeline input: False -``` - -### -TokenizeUrls -If set, this switch will try to tokenize the values with web and site related tokens - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md deleted file mode 100644 index f4be705e5b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPDocumentSet - -## SYNOPSIS -Creates a new document set in a library. - -## SYNTAX - -```powershell -Add-PnPDocumentSet -List <ListPipeBind> - -Name <String> - -ContentType <ContentTypePipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPDocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test" -``` - -This will add a new document set based upon the 'Test Document Set' content type to a list called 'Documents'. The document set will be named 'Test' - -## PARAMETERS - -### -ContentType -The name of the content type, its ID or an actual content object referencing to the document set - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The name of the list, its ID or an actual list object from where the document set needs to be added - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Name -The name of the document set - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md deleted file mode 100644 index 2129bc84a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPEventReceiver - -## SYNOPSIS -Adds a new remote event receiver - -## SYNTAX - -```powershell -Add-PnPEventReceiver -Name <String> - -Url <String> - -EventReceiverType <EventReceiverType> - -Synchronization <EventReceiverSynchronization> - [-List <ListPipeBind>] - [-SequenceNumber <Int>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPEventReceiver -List "ProjectList" -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ItemAdded -Synchronization Asynchronous -``` - -This will add a new remote event receiver that is executed after an item has been added to the ProjectList list - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPEventReceiver -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType WebAdding -Synchronization Synchronous -``` - -This will add a new remote event receiver that is executed while a new subsite is being created - -## PARAMETERS - -### -EventReceiverType -The type of the event receiver like ItemAdded, ItemAdding. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceivertype.aspx for the full list of available types. - -```yaml -Type: EventReceiverType -Parameter Sets: (All) -Aliases: Type - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The list object or name where the remote event receiver needs to be added. If omitted, the remote event receiver will be added to the web. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -The name of the remote event receiver - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -SequenceNumber -The sequence number where this remote event receiver should be placed - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Synchronization -The synchronization type: Asynchronous or Synchronous - -```yaml -Type: EventReceiverSynchronization -Parameter Sets: (All) -Aliases: Sync - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -The URL of the remote event receiver web service - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.EventReceiverDefinition - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md deleted file mode 100644 index 322c52bce1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPField - -## SYNOPSIS -Add a field - -## SYNTAX - -### Add field by XML to list -```powershell -Add-PnPField [-AddToDefaultView [<SwitchParameter>]] - [-Required [<SwitchParameter>]] - [-Group <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Add field reference to list -```powershell -Add-PnPField -List <ListPipeBind> - -Field <FieldPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Add field to list -```powershell -Add-PnPField -DisplayName <String> - -InternalName <String> - -Type <FieldType> - [-List <ListPipeBind>] - [-Id <GuidPipeBind>] - [-AddToDefaultView [<SwitchParameter>]] - [-Required [<SwitchParameter>]] - [-Group <String>] - [-ClientSideComponentId <GuidPipeBind>] - [-ClientSideComponentProperties <String>] - [-Choices <String[]>] - [-Formula <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Add field to web -```powershell -Add-PnPField -DisplayName <String> - -InternalName <String> - -Type <FieldType> - [-Id <GuidPipeBind>] - [-ClientSideComponentId <GuidPipeBind>] - [-ClientSideComponentProperties <String>] - [-Choices <String[]>] - [-Formula <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds a field to a list or as a site column - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPField -Type Calculated -InternalName "C1" -DisplayName "C1" -Formula ="[Title]" -``` - -Adds a new calculated site column with the formula specified - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPField -List "Demo list" -DisplayName "Location" -InternalName "SPSLocation" -Type Choice -Group "Demo Group" -AddToDefaultView -Choices "Stockholm","Helsinki","Oslo" -``` - -This will add a field of type Choice to the list "Demo List". - -### ------------------EXAMPLE 3------------------ -```powershell -PS:>Add-PnPField -List "Demo list" -DisplayName "Speakers" -InternalName "SPSSpeakers" -Type MultiChoice -Group "Demo Group" -AddToDefaultView -Choices "Obiwan Kenobi","Darth Vader", "Anakin Skywalker" -``` - -This will add a field of type Multiple Choice to the list "Demo List". (you can pick several choices for the same item) - -## PARAMETERS - -### -AddToDefaultView -Switch Parameter if this field must be added to the default view - -```yaml -Type: SwitchParameter -Parameter Sets: Add field to list, Add field by XML to list - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Choices -Specify choices, only valid if the field type is Choice - -```yaml -Type: String[] -Parameter Sets: Add field to list - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -ClientSideComponentId -The Client Side Component Id to set to the field - -Only applicable to: SharePoint Online - -```yaml -Type: GuidPipeBind -Parameter Sets: Add field to list, Add field to web - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ClientSideComponentProperties -The Client Side Component Properties to set to the field - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: Add field to list, Add field to web - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayName -The display name of the field - -```yaml -Type: String -Parameter Sets: Add field to list, Add field to web - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Field -The name of the field, its ID or an actual field object that needs to be added - -```yaml -Type: FieldPipeBind -Parameter Sets: Add field reference to list - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Formula -Specify the formula. Only available if the field type is Calculated - -```yaml -Type: String -Parameter Sets: Add field to list - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Group -The group name to where this field belongs to - -```yaml -Type: String -Parameter Sets: Add field to list, Add field by XML to list - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Id -The ID of the field, must be unique - -```yaml -Type: GuidPipeBind -Parameter Sets: Add field to list, Add field to web - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -InternalName -The internal name of the field - -```yaml -Type: String -Parameter Sets: Add field to list, Add field to web - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The name of the list, its ID or an actual list object where this field needs to be added - -```yaml -Type: ListPipeBind -Parameter Sets: Add field to list, Add field reference to list - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Required -Switch Parameter if the field is a required field - -```yaml -Type: SwitchParameter -Parameter Sets: Add field to list, Add field by XML to list - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Type -The type of the field like Choice, Note, MultiChoice - -```yaml -Type: FieldType -Parameter Sets: Add field to list, Add field to web - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Field - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md deleted file mode 100644 index 4bf59b3f6f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPFieldFromXml - -## SYNOPSIS -Adds a field to a list or as a site column based upon a CAML/XML field definition - -## SYNTAX - -```powershell -Add-PnPFieldFromXml -FieldXml <String> - [-List <ListPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' -Add-PnPFieldFromXml -FieldXml $xml -``` - -Adds a field with the specified field CAML code to the site. - -### ------------------EXAMPLE 2------------------ -```powershell -$xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' -Add-PnPFieldFromXml -List "Demo List" -FieldXml $xml -``` - -Adds a field with the specified field CAML code to the list "Demo List". - -## PARAMETERS - -### -FieldXml -CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -List -The name of the list, its ID or an actual list object where this field needs to be added - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Field - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Field CAML](http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md deleted file mode 100644 index 6ab9d6c1a5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPFieldToContentType - -## SYNOPSIS -Adds an existing site column to a content type - -## SYNTAX - -```powershell -Add-PnPFieldToContentType -Field <FieldPipeBind> - -ContentType <ContentTypePipeBind> - [-Required [<SwitchParameter>]] - [-Hidden [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPFieldToContentType -Field "Project_Name" -ContentType "Project Document" -``` - -This will add an existing site column with an internal name of "Project_Name" to a content type called "Project Document" - -## PARAMETERS - -### -ContentType -Specifies which content type a field needs to be added to - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Field -Specifies the field that needs to be added to the content type - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Hidden -Specifies whether the field should be hidden or not - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Required -Specifies whether the field is required or not - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md deleted file mode 100644 index d1ff1f96b8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPFile - -## SYNOPSIS -Uploads a file to Web - -## SYNTAX - -### Upload file -```powershell -Add-PnPFile -Path <String> - -Folder <String> - [-NewFileName <String>] - [-Checkout [<SwitchParameter>]] - [-CheckInComment <String>] - [-Approve [<SwitchParameter>]] - [-ApproveComment <String>] - [-Publish [<SwitchParameter>]] - [-PublishComment <String>] - [-UseWebDav [<SwitchParameter>]] - [-Values <Hashtable>] - [-ContentType <ContentTypePipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Upload file from stream -```powershell -Add-PnPFile -FileName <String> - -Stream <Stream> - -Folder <String> - [-Checkout [<SwitchParameter>]] - [-CheckInComment <String>] - [-Approve [<SwitchParameter>]] - [-ApproveComment <String>] - [-Publish [<SwitchParameter>]] - [-PublishComment <String>] - [-UseWebDav [<SwitchParameter>]] - [-Values <Hashtable>] - [-ContentType <ContentTypePipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPFile -Path c:\temp\company.master -Folder "_catalogs/masterpage" -``` - -This will upload the file company.master to the masterpage catalog - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPFile -Path .\displaytemplate.html -Folder "_catalogs/masterpage/display templates/test" -``` - -This will upload the file displaytemplate.html to the test folder in the display templates folder. If the test folder does not exist it will create it. - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPFile -Path .\sample.doc -Folder "Shared Documents" -Values @{Modified="1/1/2016"} -``` - -This will upload the file sample.doc to the Shared Documnets folder. After uploading it will set the Modified date to 1/1/2016. - -### ------------------EXAMPLE 4------------------ -```powershell -Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -Stream $fileStream -Values @{Modified="1/1/2016"} -``` - -This will add a file sample.doc with the contents of the stream into the Shared Documents folder. After adding it will set the Modified date to 1/1/2016. - -### ------------------EXAMPLE 5------------------ -```powershell -Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -ContentType "Document" -Values @{Modified="1/1/2016"} -``` - -This will add a file sample.doc to the Shared Documents folder, with a ContentType of 'Documents'. After adding it will set the Modified date to 1/1/2016. - -### ------------------EXAMPLE 6------------------ -```powershell -Add-PnPFile -FileName sample.docx -Folder "Documents" -Values @{Modified="1/1/2016"; Created="1/1/2017"; Editor=23} -``` - -This will add a file sample.docx to the Documents folder and will set the Modified date to 1/1/2016, Created date to 1/1/2017 and the Modified By field to the user with ID 23. To find out about the proper user ID to relate to a specific user, use Get-PnPUser. - -### ------------------EXAMPLE 7------------------ -```powershell -Add-PnPFile -FileName sample.docx -Folder "Documents" -NewFileName "differentname.docx" -``` - -This will upload a local file sample.docx to the Documents folder giving it the filename differentname.docx on SharePoint - -## PARAMETERS - -### -Approve -Will auto approve the uploaded file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ApproveComment -The comment added to the approval. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CheckInComment -The comment added to the checkin. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Checkout -If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ContentType -Use to assign a ContentType to the file. - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -FileName -Name for file - -```yaml -Type: String -Parameter Sets: Upload file from stream - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Folder -The destination folder in the site - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -NewFileName -Filename to give the file on SharePoint - -```yaml -Type: String -Parameter Sets: Upload file - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -The local file path. - -```yaml -Type: String -Parameter Sets: Upload file - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Publish -Will auto publish the file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PublishComment -The comment added to the publish action. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Stream -Stream with the file contents - -```yaml -Type: Stream -Parameter Sets: Upload file from stream - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -UseWebDav - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Values -Use the internal names of the fields when specifying field names. - -Single line of text: -Values @{"Title" = "Title New"} - -Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} - -Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} - -Choice: -Values @{"Choice" = "Value 1"} - -Number: -Values @{"Number" = "10"} - -Currency: -Values @{"Number" = "10"} - -Currency: -Values @{"Currency" = "10"} - -Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} - -Lookup (id of lookup value): -Values @{"Lookup" = "2"} - -Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} - -Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} - -Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} - -Yes/No: -Values @{"YesNo" = $false} - -Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} - -Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} - -Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term - -Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} - -Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} - -Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/,%20OfficePnp"} - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.File - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md deleted file mode 100644 index b2b83e36fc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPFileToProvisioningTemplate - -## SYNOPSIS -Adds a file to a PnP Provisioning Template - -## SYNTAX - -```powershell -Add-PnPFileToProvisioningTemplate -Path <String> - -Source <String> - -Folder <String> - [-Container <String>] - [-FileLevel <FileLevel>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-FileOverwrite [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPFileToProvisioningTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder -``` - -Adds a file to a PnP Site Template - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPFileToProvisioningTemplate -Path template.xml -Source $sourceFilePath -Folder $targetFolder -``` - -Adds a file reference to a PnP Site XML Template - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPFileToProvisioningTemplate -Path template.pnp -Source "./myfile.png" -Folder "folderinsite" -FileLevel Published -FileOverwrite:$false -``` - -Adds a file to a PnP Site Template, specifies the level as Published and defines to not overwrite the file if it exists in the site. - -### ------------------EXAMPLE 4------------------ -```powershell -Add-PnPFileToProvisioningTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder -Container $container -``` - -Adds a file to a PnP Site Template with a custom container for the file - -## PARAMETERS - -### -Container -The target Container for the file to add to the in-memory template, optional argument. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 3 -Accept pipeline input: False -``` - -### -FileLevel -The level of the files to add. Defaults to Published - -```yaml -Type: FileLevel -Parameter Sets: (All) - -Required: False -Position: 4 -Accept pipeline input: False -``` - -### -FileOverwrite -Set to overwrite in site, Defaults to true - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: 5 -Accept pipeline input: False -``` - -### -Folder -The target Folder for the file to add to the in-memory template. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 2 -Accept pipeline input: False -``` - -### -Path -Filename of the .PNP Open XML site template to read from, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Source -The file to add to the in-memory template, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while loading the template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: 4 -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md deleted file mode 100644 index 266faf6ab6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPFolder - -## SYNOPSIS -Creates a folder within a parent folder - -## SYNTAX - -```powershell -Add-PnPFolder -Name <String> - -Folder <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPFolder -Name NewFolder -Folder _catalogs/masterpage -``` - -This will create the folder NewFolder in the masterpage catalog - -## PARAMETERS - -### -Folder -The parent folder in the site - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Name -The folder name - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md deleted file mode 100644 index 743413ff6c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPHtmlPublishingPageLayout - -## SYNOPSIS -Adds a HTML based publishing page layout - -## SYNTAX - -```powershell -Add-PnPHtmlPublishingPageLayout -SourceFilePath <String> - -Title <String> - -Description <String> - -AssociatedContentTypeID <String> - [-DestinationFolderHierarchy <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPHtmlPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901 -``` - -Uploads the pagelayout 'customlayout.aspx' from the current location to the current site as a 'web part page' pagelayout - -## PARAMETERS - -### -AssociatedContentTypeID -Associated content type ID - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Description -Description for the page layout - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DestinationFolderHierarchy -Folder hierarchy where the HTML page layouts will be deployed - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SourceFilePath -Path to the file which will be uploaded - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -Title for the page layout - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md deleted file mode 100644 index 312db204cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPHubSiteAssociation - -## SYNOPSIS -Connects a site to a hubsite. - -## SYNTAX - -```powershell -Add-PnPHubSiteAssociation -Site <SitePipeBind> - -HubSite <SitePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Connects an existing site to a hubsite - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite -``` - -This example adds the specified site to the hubsite. - -## PARAMETERS - -### -HubSite -The hubsite to connect the site to - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Site -The site to connect to the hubsite - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md deleted file mode 100644 index 99b0f73293..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPIndexedProperty - -## SYNOPSIS -Marks the value of the propertybag key specified to be indexed by search. - -## SYNTAX - -```powershell -Add-PnPIndexedProperty -Key <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Key -Key of the property bag value to be indexed - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md deleted file mode 100644 index 6bfdaecb13..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPJavaScriptBlock - -## SYNOPSIS -Adds a link to a JavaScript snippet/block to a web or site collection - -## SYNTAX - -```powershell -Add-PnPJavaScriptBlock -Name <String> - -Script <String> - [-Sequence <Int>] - [-Scope <CustomActionScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Specify a scope as 'Site' to add the custom action to all sites in a site collection. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' -Sequence 9999 -Scope Site -``` - -Add a JavaScript code block to all pages within the current site collection under the name myAction and at order 9999 - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' -``` - -Add a JavaScript code block to all pages within the current web under the name myAction - -## PARAMETERS - -### -Name -The name of the script block. Can be used to identify the script with other cmdlets or coded solutions - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Key - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope -The scope of the script to add to. Either Web or Site, defaults to Web. 'All' is not valid for this command. - -```yaml -Type: CustomActionScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Script -The javascript block to add to the specified scope - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Sequence -A sequence number that defines the order on the page - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md deleted file mode 100644 index c840edd0ae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPJavaScriptLink - -## SYNOPSIS -Adds a link to a JavaScript file to a web or sitecollection - -## SYNTAX - -```powershell -Add-PnPJavaScriptLink -Name <String> - -Url <String[]> - [-Sequence <Int>] - [-Scope <CustomActionScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Creates a custom action that refers to a JavaScript file - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js -Sequence 9999 -Scope Site -``` - -Injects a reference to the latest v1 series jQuery library to all pages within the current site collection under the name jQuery and at order 9999 - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js -``` - -Injects a reference to the latest v1 series jQuery library to all pages within the current web under the name jQuery - -## PARAMETERS - -### -Name -Name under which to register the JavaScriptLink - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Key - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope -Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web. - -```yaml -Type: CustomActionScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Sequence -Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -URL to the JavaScript file to inject - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md deleted file mode 100644 index 26a1a04d12..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPListFoldersToProvisioningTemplate - -## SYNOPSIS -Adds folders to a list in a PnP Provisioning Template - -## SYNTAX - -```powershell -Add-PnPListFoldersToProvisioningTemplate -Path <String> - -List <ListPipeBind> - [-Recursive [<SwitchParameter>]] - [-IncludeSecurity [<SwitchParameter>]] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -``` - -Adds top level folders from a list to an existing template and returns an in-memory PnP Site Template - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Recursive -``` - -Adds all folders from a list to an existing template and returns an in-memory PnP Site Template - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Recursive -IncludeSecurity -``` - -Adds all folders from a list with unique permissions to an in-memory PnP Site Template - -## PARAMETERS - -### -IncludeSecurity -A switch to include ObjectSecurity information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: 5 -Accept pipeline input: False -``` - -### -List -The list to query - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 2 -Accept pipeline input: False -``` - -### -Path -Filename of the .PNP Open XML site template to read from, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Recursive -A switch parameter to include all folders in the list, or just top level folders. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: 4 -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while loading the template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: 6 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md deleted file mode 100644 index 14f9a0afed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPListItem - -## SYNOPSIS -Adds an item to a list - -## SYNTAX - -```powershell -Add-PnPListItem -List <ListPipeBind> - [-ContentType <ContentTypePipeBind>] - [-Values <Hashtable>] - [-Folder <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPListItem -List "Demo List" -Values @{"Title" = "Test Title"; "Category"="Test Category"} -``` - -Adds a new list item to the "Demo List", and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPListItem -List "Demo List" -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"} -``` - -Adds a new list item to the "Demo List", sets the content type to "Company" and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPListItem -List "Demo List" -Values @{"MultiUserField"="user1@domain.com","user2@domain.com"} -``` - -Adds a new list item to the "Demo List" and sets the user field called MultiUserField to 2 users. Separate multiple users with a comma. - -### ------------------EXAMPLE 4------------------ -```powershell -Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Folder "projects/europe" -``` - -Adds a new list item to the "Demo List". It will add the list item to the europe folder which is located in the projects folder. Folders will be created if needed. - -## PARAMETERS - -### -ContentType -Specify either the name, ID or an actual content type. - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Folder -The list relative URL of a folder. E.g. "MyFolder" for a folder located in the root of the list, or "MyFolder/SubFolder" for a folder located in the MyFolder folder which is located in the root of the list. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Values -Use the internal names of the fields when specifying field names. - -Single line of text: -Values @{"Title" = "Title New"} - -Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} - -Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} - -Choice: -Values @{"Choice" = "Value 1"} - -Number: -Values @{"Number" = "10"} - -Currency: -Values @{"Number" = "10"} - -Currency: -Values @{"Currency" = "10"} - -Date and Time: -Values @{"DateAndTime" = "03/13/2015 14:16"} - -Lookup (id of lookup value): -Values @{"Lookup" = "2"} - -Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} - -Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} - -Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} - -Yes/No: -Values @{"YesNo" = $false} - -Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} - -Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} - -Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term - -Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} - -Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} - -Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/,%20OfficePnp"} - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.ListItem - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md deleted file mode 100644 index 0d9444e8a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPMasterPage - -## SYNOPSIS -Adds a Masterpage - -## SYNTAX - -```powershell -Add-PnPMasterPage -SourceFilePath <String> - -Title <String> - -Description <String> - [-DestinationFolderHierarchy <String>] - [-UIVersion <String>] - [-DefaultCssFile <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPMasterPage -SourceFilePath "page.master" -Title "MasterPage" -Description "MasterPage for Web" -DestinationFolderHierarchy "SubFolder" -``` - -Adds a MasterPage from the local file "page.master" to the folder "SubFolder" in the Masterpage gallery. - -## PARAMETERS - -### -DefaultCssFile -Default CSS file for the MasterPage, this Url is SiteRelative - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -Description for the Masterpage - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DestinationFolderHierarchy -Folder hierarchy where the MasterPage will be deployed - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SourceFilePath -Path to the file which will be uploaded - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -Title for the Masterpage - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -UIVersion -UIVersion of the Masterpage. Default = 15 - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.File - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md deleted file mode 100644 index b4fb9b1241..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPNavigationNode - -## SYNOPSIS -Adds an item to a navigation element - -## SYNTAX - -```powershell -Add-PnPNavigationNode -Location <NavigationType> - -Title <String> - [-Url <String>] - [-Parent <Int>] - [-First [<SwitchParameter>]] - [-External [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds a menu item to either the quicklaunch or top navigation - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -``` - -Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/" - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPNavigationNode -Title "Contoso USA" -Url "http://contoso.sharepoint.com/sites/contoso/usa/" -Location "QuickLaunch" -Parent 2012 -``` - -Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso USA", will link to the url "http://contoso.sharepoint.com/sites/contoso/usa/" and will have the node with id 2012 as a parent navigation node. - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -First -``` - -Adds a navigation node to the quicklaunch, as the first item. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/" - -### ------------------EXAMPLE 4------------------ -```powershell -Add-PnPNavigationNode -Title "Contoso Pharmaceuticals" -Url "http://contoso.sharepoint.com/sites/contosopharma/" -Location "QuickLaunch" -External -``` - -Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso Pharmaceuticals" and will link to the external url "http://contoso.sharepoint.com/sites/contosopharma/" - -### ------------------EXAMPLE 5------------------ -```powershell -Add-PnPNavigationNode -Title "Wiki" -Location "QuickLaunch" -Url "wiki/" -``` - -Adds a navigation node to the quicklaunch. The navigation node will have the title "Wiki" and will link to Wiki library on the selected Web. - -## PARAMETERS - -### -External -Indicates the destination URL is outside of the site collection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -First -Add the new menu item to beginning of the collection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Location -The location of the node to add. Either TopNavigationBar, QuickLaunch, SearchNav - -```yaml -Type: NavigationType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Parent -The key of the parent. Leave empty to add to the top level - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the node to add - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -The url to navigate to when clicking the new menu item. This can either be absolute or relative to the Web. Fragments are not supported. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.NavigationNode - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md deleted file mode 100644 index 1ccbb5160a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPOffice365GroupToSite - -## SYNOPSIS -Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group - -## SYNTAX - -```powershell -Add-PnPOffice365GroupToSite -Url <String> - -Alias <String> - -DisplayName <String> - [-Description <String>] - [-Classification <String>] - [-IsPublic [<SwitchParameter>]] - [-KeepOldHomePage [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command allows you to add an Office 365 Unified group to an existing classic site collection. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPOffice365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" -Alias "FinanceTeamsite" -DisplayName = "My finance team site group" -``` - -This will add a group called MyGroup to the current site collection - -## PARAMETERS - -### -Alias -Specifies the alias of the group. Cannot contain spaces. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Classification -Specifies the classification of the group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The optional description of the group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayName -The display name of the group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -IsPublic -Specifies if the group is public. Defaults to false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -KeepOldHomePage -Specifies if the current site home page is kept. Defaults to false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -Url of the site to be connected to an Office 365 Group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md deleted file mode 100644 index 404a9019e6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPProvisioningTemplate - -## SYNOPSIS -Adds a PnP Provisioning Template object to a tenant template - -## SYNTAX - -```powershell -Add-PnPProvisioningTemplate -SiteTemplate <ProvisioningTemplate> - -TenantTemplate <ProvisioningHierarchy> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnpProvisioningTemplate -TenantTemplate $tenanttemplate -SiteTemplate $sitetemplate -``` - -Adds an existing site template to an existing tenant template object - -## PARAMETERS - -### -SiteTemplate -The template to add to the tenant template - -```yaml -Type: ProvisioningTemplate -Parameter Sets: (All) -Aliases: Template - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TenantTemplate -The tenant template to add the template to - -```yaml -Type: ProvisioningHierarchy -Parameter Sets: (All) -Aliases: Hierarchy - -Required: True -Position: Named -Accept pipeline input: True -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md deleted file mode 100644 index a27eef4ec2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPPublishingImageRendition - -## SYNOPSIS -Adds an Image Rendition if the Name of the Image Rendition does not already exist. This prevents creating two Image Renditions that share the same name. - -## SYNTAX - -```powershell -Add-PnPPublishingImageRendition -Name <String> - -Width <Int> - -Height <Int> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600 -``` - - - -## PARAMETERS - -### -Height -The height of the Image Rendition. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Name -The display name of the Image Rendition. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Width -The width of the Image Rendition. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md deleted file mode 100644 index f172fced91..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPPublishingPage - -## SYNOPSIS -Adds a publishing page - -## SYNTAX - -### WithTitle -```powershell -Add-PnPPublishingPage -PageName <String> - -PageTemplateName <String> - [-Title <String>] - [-FolderPath <String>] - [-Publish [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' -``` - -Creates a new page based on the pagelayout 'ArticleLeft' - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' -Folder '/Pages/folder' -``` - -Creates a new page based on the pagelayout 'ArticleLeft' with a site relative folder path - -## PARAMETERS - -### -FolderPath -The site relative folder path of the page to be added - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Folder - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PageName -The name of the page to be added as an aspx file - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PageTemplateName -The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage' - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Publish -Publishes the page. Also Approves it if moderation is enabled on the Pages library. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the page - -```yaml -Type: String -Parameter Sets: WithTitle - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md deleted file mode 100644 index 1861196e7f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPPublishingPageLayout - -## SYNOPSIS -Adds a publishing page layout - -## SYNTAX - -```powershell -Add-PnPPublishingPageLayout -SourceFilePath <String> - -Title <String> - -Description <String> - -AssociatedContentTypeID <String> - [-DestinationFolderHierarchy <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901 -``` - -Uploads the pagelayout 'customlayout.aspx' to the current site as a 'web part page' pagelayout - -## PARAMETERS - -### -AssociatedContentTypeID -Associated content type ID - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Description -Description for the page layout - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DestinationFolderHierarchy -Folder hierarchy where the html page layouts will be deployed - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SourceFilePath -Path to the file which will be uploaded - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -Title for the page layout - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md deleted file mode 100644 index 646531a548..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPRoleDefinition - -## SYNOPSIS -Adds a Role Definition (Permission Level) to the site collection in the current context - -## SYNTAX - -```powershell -Add-PnPRoleDefinition -RoleName <String> - [-Clone <RoleDefinitionPipeBind>] - [-Include <PermissionKind[]>] - [-Exclude <PermissionKind[]>] - [-Description <String>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command allows adding a custom Role Definition (Permission Level) to the site collection in the current context. It does not replace or remove existing Role Definitions. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPRoleDefinition -RoleName "CustomPerm" -``` - -Creates additional permission level with no permission flags enabled. - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPRoleDefinition -RoleName "NoDelete" -Clone "Contribute" -Exclude DeleteListItems -``` - -Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPRoleDefinition -RoleName "AddOnly" -Clone "Contribute" -Exclude DeleteListItems, EditListItems -``` - -Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems - -### ------------------EXAMPLE 4------------------ -```powershell -PS> $roleDefinition = Get-PnPRoleDefinition -Identity "Contribute" -Add-PnPRoleDefinition -RoleName "AddOnly" -Clone $roleDefinition -Exclude DeleteListItems, EditListItems -``` - -Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems - -## PARAMETERS - -### -Clone -An existing permission level or the name of an permission level to clone as base template. - -```yaml -Type: RoleDefinitionPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -Optional description for the new permission level. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Exclude -Specifies permission flags(s) to disable. - -```yaml -Type: PermissionKind[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Include -Specifies permission flags(s) to enable. - -```yaml -Type: PermissionKind[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RoleName -Name of new permission level. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md deleted file mode 100644 index a2e325f866..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPSiteClassification - -## SYNOPSIS -Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph. - -## SYNTAX - -```powershell -Add-PnPSiteClassification -Classifications <String> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Add-PnPSiteClassification -Classifications "Top Secret" -``` - -Adds the "Top Secret" classification to the already existing classification values. - -### ------------------EXAMPLE 2------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Add-PnPSiteClassification -Classifications "Top Secret","HBI" -``` - -Adds the "Top Secret" and the "For Your Eyes Only" classification to the already existing classification values. - -## PARAMETERS - -### -Classifications - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md deleted file mode 100644 index c9d46bef64..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPSiteCollectionAdmin - -## SYNOPSIS -Adds one or more users as site collection administrators to the site collection in the current context - -## SYNTAX - -```powershell -Add-PnPSiteCollectionAdmin -Owners <UserPipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command allows adding one to many users as site collection administrators to the site collection in the current context. It does not replace or remove exisitng site collection administrators. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com" -``` - -This will add user@contoso.onmicrosoft.com as an additional site collection owner to the site collection in the current context - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") -``` - -This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional site collection owners to the site collection in the current context - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPUser | ? Title -Like "*Doe" | Add-PnPSiteCollectionAdmin -``` - -This will add all users with their title ending with "Doe" as additional site collection owners to the site collection in the current context - -## PARAMETERS - -### -Owners -Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators to the site in the current context. Existing administrators will stay. Can be both users and groups. - -```yaml -Type: UserPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md deleted file mode 100644 index fec1934053..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPSiteCollectionAppCatalog - -## SYNOPSIS -Adds a Site Collection scoped App Catalog to a site - -## SYNTAX - -```powershell -Add-PnPSiteCollectionAppCatalog -Site <SitePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite" -``` - -This will add a SiteCollection app catalog to the specified site - -## PARAMETERS - -### -Site -Url of the site to add the app catalog to. - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md deleted file mode 100644 index 1ce9d10eea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPSiteDesign - -## SYNOPSIS -Creates a new Site Design on the current tenant. - -## SYNTAX - -```powershell -Add-PnPSiteDesign -Title <String> - -SiteScriptIds <GuidPipeBind[]> - -WebTemplate <SiteWebTemplate> - [-Description <String>] - [-IsDefault [<SwitchParameter>]] - [-PreviewImageAltText <String>] - [-PreviewImageUrl <String>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPSiteDesign -Title "My Company Design" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5","6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -WebTemplate TeamSite -``` - -Adds a new Site Design, with the specified title and description. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts. The WebTemplate parameter specifies that this design applies to Team Sites. - -## PARAMETERS - -### -Description -The description of the site design - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IsDefault -Specifies if the site design is a default site design - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PreviewImageAltText -Sets the text for the preview image - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PreviewImageUrl -Sets the url to the preview image - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SiteScriptIds -An array of guids of site scripts - -```yaml -Type: GuidPipeBind[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the site design - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -WebTemplate -Specifies the type of site to which this design applies - -```yaml -Type: SiteWebTemplate -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md deleted file mode 100644 index a067924e11..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPSiteScript - -## SYNOPSIS -Creates a new Site Script on the current tenant. - -## SYNTAX - -```powershell -Add-PnPSiteScript -Title <String> - -Content <String> - [-Description <String>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPSiteScript -Title "My Site Script" -Description "A more detailed description" -Content $script -``` - -Adds a new Site Script, where $script variable contains the script. - -## PARAMETERS - -### -Content -A JSON string containing the site script - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Description -The description of the site script - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the site script - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md deleted file mode 100644 index 72e7794847..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPStoredCredential - -## SYNOPSIS -Adds a credential to the Windows Credential Manager - -## SYNTAX - -```powershell -Add-PnPStoredCredential -Name <String> - -Username <String> - [-Password <SecureString>] -``` - -## DESCRIPTION -Adds an entry to the Windows Credential Manager. If you add an entry in the form of the URL of your tenant/server PnP PowerShell will check if that entry is available when you connect using Connect-PnPOnline. If it finds a matching URL it will use the associated credentials. - -If you add a Credential with a name of "https://yourtenant.sharepoint.com/" it will find a match when you connect to "https://yourtenant.sharepoint.com/" but also when you connect to "https://yourtenant.sharepoint.com/sites/demo1". Of course you can specify more granular entries, allow you to automatically provide credentials for different URLs. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -``` - -You will be prompted to specify the password and a new entry will be added with the specified values - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) -``` - -A new entry will be added with the specified values - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) -Connect-PnPOnline -Url https://tenant.sharepoint.com/sites/mydemosite -``` - -A new entry will be added with the specified values, and a subsequent connection to a sitecollection starting with the entry name will be made. Notice that no password prompt will occur. - -## PARAMETERS - -### -Name -The credential to set - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Password -If not specified you will be prompted to enter your password. -If you want to specify this value use ConvertTo-SecureString -String 'YourPassword' -AsPlainText -Force - -```yaml -Type: SecureString -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Username - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md deleted file mode 100644 index 1c125ba609..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPTaxonomyField - -## SYNOPSIS -Add a taxonomy field - -## SYNTAX - -### Id -```powershell -Add-PnPTaxonomyField -DisplayName <String> - -InternalName <String> - [-TaxonomyItemId <GuidPipeBind>] - [-List <ListPipeBind>] - [-Group <String>] - [-Id <GuidPipeBind>] - [-AddToDefaultView [<SwitchParameter>]] - [-MultiValue [<SwitchParameter>]] - [-Required [<SwitchParameter>]] - [-FieldOptions <AddFieldOptions>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Path -```powershell -Add-PnPTaxonomyField -TermSetPath <String> - -DisplayName <String> - -InternalName <String> - [-TermPathDelimiter <String>] - [-List <ListPipeBind>] - [-Group <String>] - [-Id <GuidPipeBind>] - [-AddToDefaultView [<SwitchParameter>]] - [-MultiValue [<SwitchParameter>]] - [-Required [<SwitchParameter>]] - [-FieldOptions <AddFieldOptions>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds a taxonomy/managed metadata field to a list or as a site column. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPTaxonomyField -DisplayName "Test" -InternalName "Test" -TermSetPath "TestTermGroup|TestTermSet" -``` - -Adds a new taxonomy field called "Test" that points to the TestTermSet which is located in the TestTermGroup - -## PARAMETERS - -### -AddToDefaultView -Switch Parameter if this field must be added to the default view - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayName -The display name of the field - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -FieldOptions -Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details - -```yaml -Type: AddFieldOptions -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Group -The group name to where this field belongs to - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Id -The ID for the field, must be unique - -```yaml -Type: GuidPipeBind -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -InternalName -The internal name of the field - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The list object or name where this field needs to be added - -```yaml -Type: ListPipeBind -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MultiValue -Switch Parameter if this Taxonomy field can hold multiple values - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Required -Switch Parameter if the field is a required field - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TaxonomyItemId -The ID of the Taxonomy item - -```yaml -Type: GuidPipeBind -Parameter Sets: Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermPathDelimiter -The path delimiter to be used, by default this is '|' - -```yaml -Type: String -Parameter Sets: Path - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermSetPath -The path to the term that this needs be be bound - -```yaml -Type: String -Parameter Sets: Path - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Field - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md deleted file mode 100644 index c21bbf6f0b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPTenantCdnOrigin - -## SYNOPSIS -Adds a new origin to the public or private content delivery network (CDN). - -## SYNTAX - -```powershell -Add-PnPTenantCdnOrigin -OriginUrl <String> - -CdnType <SPOTenantCdnType> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Add a new origin to the public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library and requests that content in that library should be retrievable by using a CDN. - -You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPTenantCdnOrigin -OriginUrl /sites/site/subfolder -CdnType Public -``` - -This example configures a public CDN on site level. - -## PARAMETERS - -### -CdnType -Specifies the CDN type. The valid values are: public or private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -OriginUrl -Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. - -Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md deleted file mode 100644 index 7d69af941b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPTenantSequence - -## SYNOPSIS -Adds a tenant sequence object to a tenant template - -## SYNTAX - -```powershell -Add-PnPTenantSequence -Template <ProvisioningHierarchy> - -Sequence <ProvisioningSequence> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPTenantSequence -Template $mytemplate -Sequence $mysequence -``` - -Adds an existing sequence object to an existing hierarchy object - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPTenantSequence -Id "MySequence" | Add-PnPTenantSequence -Template $template -``` - -Creates a new instance of a provisioning sequence object and sets the Id to the value specified, then the sequence is added to an existing hierarchy object - -## PARAMETERS - -### -Sequence -Optional Id of the sequence - -```yaml -Type: ProvisioningSequence -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Template -The template to add the sequence to - -```yaml -Type: ProvisioningHierarchy -Parameter Sets: __AllParameterSets -Aliases: Hierarchy - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md deleted file mode 100644 index 01ae0e9e2f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPTenantSequenceSite - -## SYNOPSIS -Adds a existing tenant sequence site object to a tenant template - -## SYNTAX - -```powershell -Add-PnPTenantSequenceSite -Site <ProvisioningSitePipeBind> - -Sequence <ProvisioningSequence> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPTenantSequenceSite -Site $myteamsite -Sequence $mysequence -``` - -Adds an existing site object to an existing hierarchy sequence - -## PARAMETERS - -### -Sequence -The sequence to add the site to - -```yaml -Type: ProvisioningSequence -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Site - - -```yaml -Type: ProvisioningSitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md deleted file mode 100644 index 0e10e0f695..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPTenantSequenceSubSite - -## SYNOPSIS -Adds a tenant sequence sub site object to a tenant sequence site object - -## SYNTAX - -```powershell -Add-PnPTenantSequenceSubSite -SubSite <TeamNoGroupSubSite> - -Site <SiteCollection> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPTenantSequenceSubSite -Site $mysite -SubSite $mysubsite -``` - -Adds an existing subsite object to an existing sequence site object - -## PARAMETERS - -### -Site -The site to add the subsite to - -```yaml -Type: SiteCollection -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -SubSite -The subsite to add - -```yaml -Type: TeamNoGroupSubSite -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md deleted file mode 100644 index a54bac5862..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPTenantTheme - -## SYNOPSIS -Adds or updates a theme to the tenant. - -## SYNTAX - -```powershell -Add-PnPTenantTheme -Identity <ThemePipeBind> - -Palette <ThemePalettePipeBind> - -IsInverted <Boolean> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Adds or updates atheme to the tenant. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$themepalette = @{ - "themePrimary" = "#00ffff"; - "themeLighterAlt" = "#f3fcfc"; - "themeLighter" = "#daffff"; - "themeLight" = "#affefe"; - "themeTertiary" = "#76ffff"; - "themeSecondary" = "#39ffff"; - "themeDarkAlt" = "#00c4c4"; - "themeDark" = "#009090"; - "themeDarker" = "#005252"; - "neutralLighterAlt" = "#f8f8f8"; - "neutralLighter" = "#f4f4f4"; - "neutralLight" = "#eaeaea"; - "neutralQuaternaryAlt" = "#dadada"; - "neutralQuaternary" = "#d0d0d0"; - "neutralTertiaryAlt" = "#c8c8c8"; - "neutralTertiary" = "#a6a6a6"; - "neutralSecondaryAlt" = "#767676"; - "neutralSecondary" = "#666666"; - "neutralPrimary" = "#333"; - "neutralPrimaryAlt" = "#3c3c3c"; - "neutralDark" = "#212121"; - "black" = "#000000"; - "white" = "#fff"; - "primaryBackground" = "#fff"; - "primaryText" = "#333" - } -PS:>Add-PnPTenantTheme -Identity "MyCompanyTheme" -Palette $themepalette -IsInverted $false -``` - -This example adds a theme to the current tenant. - -## PARAMETERS - -### -Identity -The name of the theme to add or update - -```yaml -Type: ThemePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -IsInverted -If the theme is inverted or not - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Palette -The palette to add. See examples for more information. - -```yaml -Type: ThemePalettePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md deleted file mode 100644 index 8b82828e0f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPUserToGroup - -## SYNOPSIS -Adds a user to a group - -## SYNTAX - -### Internal -```powershell -Add-PnPUserToGroup -LoginName <String> - -Identity <GroupPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### External -```powershell -Add-PnPUserToGroup -Identity <GroupPipeBind> - -EmailAddress <String> - [-SendEmail [<SwitchParameter>]] - [-EmailBody <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPUserToGroup -LoginName user@company.com -Identity 'Marketing Site Members' -``` - -Add the specified user to the group "Marketing Site Members" - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPUserToGroup -LoginName user@company.com -Identity 5 -``` - -Add the specified user to the group with Id 5 - -## PARAMETERS - -### -EmailAddress -The email address of the user - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: External - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -EmailBody - - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: External - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The group id, group name or group object to add the user to. - -```yaml -Type: GroupPipeBind -Parameter Sets: Internal, External - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -LoginName -The login name of the user - -```yaml -Type: String -Parameter Sets: Internal - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -SendEmail - - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: External - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md deleted file mode 100644 index b5f1067557..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPView - -## SYNOPSIS -Adds a view to a list - -## SYNTAX - -```powershell -Add-PnPView -List <ListPipeBind> - -Title <String> - -Fields <String[]> - [-Query <String>] - [-ViewType <ViewType>] - [-RowLimit <UInt32>] - [-Personal [<SwitchParameter>]] - [-SetAsDefault [<SwitchParameter>]] - [-Paged [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -``` - -Adds a view named "Demo view" to the "Demo List" list. - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Paged -``` - -Adds a view named "Demo view" to the "Demo List" list and makes sure there's paging on this view. - -## PARAMETERS - -### -Fields -A list of fields to add. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The ID or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Paged -If specified, the view will have paging. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Personal -If specified, a personal view will be created. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Query -A valid CAML Query. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RowLimit -The row limit for the view. Defaults to 30. - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SetAsDefault -If specified, the view will be set as the default view for the list. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the view. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ViewType -The type of view to add. - -```yaml -Type: ViewType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.View - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md deleted file mode 100644 index c82567b9af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPWebPartToWebPartPage - -## SYNOPSIS -Adds a webpart to a web part page in a specified zone - -## SYNTAX - -### XML -```powershell -Add-PnPWebPartToWebPartPage -Xml <String> - -ServerRelativePageUrl <String> - -ZoneId <String> - -ZoneIndex <Int> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### FILE -```powershell -Add-PnPWebPartToWebPartPage -Path <String> - -ServerRelativePageUrl <String> - -ZoneId <String> - -ZoneIndex <Int> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 -``` - -This will add the webpart as defined by the XML in the listview.webpart file to the specified page in the specified zone and with the order index of 1 - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 -``` - -This will add the webpart as defined by the XML in the $webpart variable to the specified page in the specified zone and with the order index of 1 - -## PARAMETERS - -### -Path -A path to a webpart file on a the file system. - -```yaml -Type: String -Parameter Sets: FILE - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Server Relative Url of the page to add the webpart to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Xml -A string containing the XML for the webpart. - -```yaml -Type: String -Parameter Sets: XML - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ZoneId -The Zone Id where the webpart must be placed - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ZoneIndex -The Zone Index where the webpart must be placed - -```yaml -Type: Int -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md deleted file mode 100644 index 535df16d1a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPWebPartToWikiPage - -## SYNOPSIS -Adds a webpart to a wiki page in a specified table row and column - -## SYNTAX - -### XML -```powershell -Add-PnPWebPartToWikiPage -Xml <String> - -ServerRelativePageUrl <String> - -Row <Int> - -Column <Int> - [-AddSpace [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### FILE -```powershell -Add-PnPWebPartToWikiPage -Path <String> - -ServerRelativePageUrl <String> - -Row <Int> - -Column <Int> - [-AddSpace [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -Row 1 -Column 1 -``` - -This will add the webpart as defined by the XML in the listview.webpart file to the specified page in the first row and the first column of the HTML table present on the page - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -Row 1 -Column 1 -``` - -This will add the webpart as defined by the XML in the $webpart variable to the specified page in the first row and the first column of the HTML table present on the page - -## PARAMETERS - -### -AddSpace -Must there be a extra space between the webpart - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Column -Column number where the webpart must be placed - -```yaml -Type: Int -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Path -A path to a webpart file on a the file system. - -```yaml -Type: String -Parameter Sets: FILE - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Row -Row number where the webpart must be placed - -```yaml -Type: Int -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Xml -A string containing the XML for the webpart. - -```yaml -Type: String -Parameter Sets: XML - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md deleted file mode 100644 index 96b69687a0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Add-PnPWebhookSubscription - -## SYNOPSIS -Adds a new Webhook subscription - -## SYNTAX - -```powershell -Add-PnPWebhookSubscription -NotificationUrl <String> - [-List <ListPipeBind>] - [-ExpirationDate <DateTime>] - [-ClientState <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -``` - -Add a Webhook subscription for the specified notification Url on the list MyList - -### ------------------EXAMPLE 2------------------ -```powershell -Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -``` - -Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 - -### ------------------EXAMPLE 3------------------ -```powershell -Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -ClientState "Hello State!" -``` - -Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 with a specific client state - -## PARAMETERS - -### -ClientState -A client state information that will be passed through notifications - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExpirationDate -The date at which the Webhook subscription will expire. (Default: 6 months from today) - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The list object or name where the Webhook subscription will be added to - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NotificationUrl -The URL of the Webhook endpoint that will be notified of the change - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Entities.WebhookSubscription - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md deleted file mode 100644 index 7c050fae1a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPWikiPage - -## SYNOPSIS -Adds a wiki page - -## SYNTAX - -### WithContent -```powershell -Add-PnPWikiPage -Content <String> - -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### WithLayout -```powershell -Add-PnPWikiPage -Layout <WikiPageLayout> - -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPWikiPage -PageUrl '/sites/demo1/pages/wikipage.aspx' -Content 'New WikiPage' -``` - -Creates a new wiki page '/sites/demo1/pages/wikipage.aspx' and sets the content to 'New WikiPage' - -## PARAMETERS - -### -Content - - -```yaml -Type: String -Parameter Sets: WithContent - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Layout - - -```yaml -Type: WikiPageLayout -Parameter Sets: WithLayout - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -The server relative page URL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md deleted file mode 100644 index 173efc0ba2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPWorkflowDefinition - -## SYNOPSIS -Adds a workflow definition - -## SYNTAX - -```powershell -Add-PnPWorkflowDefinition -Definition <WorkflowDefinition> - [-DoNotPublish [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPWorkflowDefinition -Definition $wfdef -``` - -Adds an existing workflow definition, retrieved by Get-PnPWorkflowDefinition, to a site. - -## PARAMETERS - -### -Definition -The workflow definition to add. - -```yaml -Type: WorkflowDefinition -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DoNotPublish -Overrides the default behaviour, which is to publish workflow definitions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.Guid - -Returns the Id of the workflow definition - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md deleted file mode 100644 index 69b3774fbb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Add-PnPWorkflowSubscription - -## SYNOPSIS -Adds a workflow subscription to a list - -## SYNTAX - -```powershell -Add-PnPWorkflowSubscription -Name <String> - -DefinitionName <String> - -List <ListPipeBind> - -HistoryListName <String> - -TaskListName <String> - [-StartManually [<SwitchParameter>]] - [-StartOnCreated [<SwitchParameter>]] - [-StartOnChanged [<SwitchParameter>]] - [-AssociationValues <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf -list $list -``` - -Adds an Workflow with the name 'SendMessageWf' to the list $list. - -### ------------------EXAMPLE 2------------------ -```powershell -$list | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf -``` - -Adds an Workflow with the name "SendMessageWf" to the list $list. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPList -Identity "MyCustomList" | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf -``` - -Adds an Workflow with the name "SendMessageWf" to the list "MyCustomList". - -## PARAMETERS - -### -AssociationValues - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DefinitionName -The name of the workflow definition - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -HistoryListName -The name of the History list - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The list to add the workflow to - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Name -The name of the subscription - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -StartManually -Switch if the workflow should be started manually, default value is 'true' - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StartOnChanged -Should the workflow run when an item is changed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StartOnCreated -Should the workflow run when an new item is created - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TaskListName -The name of the task list - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md deleted file mode 100644 index d3860d888a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Apply-PnPProvisioningTemplate - -## SYNOPSIS -Applies a site template to a web - -## SYNTAX - -### Instance -```powershell -Apply-PnPProvisioningTemplate [-InputInstance <ProvisioningTemplate>] - [-ResourceFolder <String>] - [-OverwriteSystemPropertyBagValues [<SwitchParameter>]] - [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]] - [-ProvisionContentTypesToSubWebs [<SwitchParameter>]] - [-ProvisionFieldsToSubWebs [<SwitchParameter>]] - [-ClearNavigation [<SwitchParameter>]] - [-Parameters <Hashtable>] - [-Handlers <Handlers>] - [-ExcludeHandlers <Handlers>] - [-ExtensibilityHandlers <ExtensibilityHandler[]>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Gallery -```powershell -Apply-PnPProvisioningTemplate [-GalleryTemplateId <Guid>] - [-ResourceFolder <String>] - [-OverwriteSystemPropertyBagValues [<SwitchParameter>]] - [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]] - [-ProvisionContentTypesToSubWebs [<SwitchParameter>]] - [-ProvisionFieldsToSubWebs [<SwitchParameter>]] - [-ClearNavigation [<SwitchParameter>]] - [-Parameters <Hashtable>] - [-Handlers <Handlers>] - [-ExcludeHandlers <Handlers>] - [-ExtensibilityHandlers <ExtensibilityHandler[]>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Path -```powershell -Apply-PnPProvisioningTemplate -Path <String> - [-ResourceFolder <String>] - [-OverwriteSystemPropertyBagValues [<SwitchParameter>]] - [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]] - [-ProvisionContentTypesToSubWebs [<SwitchParameter>]] - [-ProvisionFieldsToSubWebs [<SwitchParameter>]] - [-ClearNavigation [<SwitchParameter>]] - [-Parameters <Hashtable>] - [-Handlers <Handlers>] - [-ExcludeHandlers <Handlers>] - [-ExtensibilityHandlers <ExtensibilityHandler[]>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Apply-PnPProvisioningTemplate -Path template.xml -``` - -Applies a site template in XML format to the current web. - -### ------------------EXAMPLE 2------------------ -```powershell -Apply-PnPSPnPProvisioningTemplateiteTemplate -Path template.xml -ResourceFolder c:\provisioning\resources -``` - -Applies a site template in XML format to the current web. Any resources like files that are referenced in the template will be retrieved from the folder as specified with the ResourceFolder parameter. - -### ------------------EXAMPLE 3------------------ -```powershell -Apply-PnPProvisioningTemplate -Path template.xml -ResourceFolder c:\provisioning\resources -``` - -Applies a provisioning template in XML format to the current web. Any resources like files that are referenced in the template will be retrieved from the folder as specified with the ResourceFolder parameter. - -### ------------------EXAMPLE 4------------------ -```powershell -Apply-PnPProvisioningTemplate -Path template.xml -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"} -``` - -Applies a site template in XML format to the current web. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:<key>} token. - -For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template. - -### ------------------EXAMPLE 5------------------ -```powershell -Apply-PnPProvisioningTemplate -Path template.xml -Handlers Lists, SiteSecurity -``` - -Applies a site template in XML format to the current web. It will only apply the lists and site security part of the template. - -### ------------------EXAMPLE 6------------------ -```powershell -Apply-PnPProvisioningTemplate -Path template.pnp -``` - -Applies a site template from a pnp package to the current web. - -### ------------------EXAMPLE 7------------------ -```powershell -Apply-PnPProvisioningTemplate -Path https://tenant.sharepoint.com/sites/templatestorage/Documents/template.pnp -``` - -Applies a site template from a pnp package stored in a library to the current web. - -### ------------------EXAMPLE 8------------------ -```powershell - -$handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 -$handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 -Apply-PnPProvisioningTemplate -Path NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2 -``` - -This will create two new ExtensibilityHandler objects that are run while provisioning the template - -### ------------------EXAMPLE 9------------------ -```powershell -Apply-PnPProvisioningTemplate -Path .\ -InputInstance $template -``` - -Applies a site template from an in-memory instance of a ProvisioningTemplate type of the PnP Core Component, reading the supporting files, if any, from the current (.\) path. The syntax can be used together with any other supported parameters. - -## PARAMETERS - -### -ClearNavigation -Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExcludeHandlers -Allows you to run all handlers, excluding the ones specified. - -```yaml -Type: Handlers -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExtensibilityHandlers -Allows you to specify ExtensbilityHandlers to execute while applying a template - -```yaml -Type: ExtensibilityHandler[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -GalleryTemplateId - - -```yaml -Type: Guid -Parameter Sets: Gallery - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Handlers -Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. - -```yaml -Type: Handlers -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IgnoreDuplicateDataRowErrors -Ignore duplicate data row errors when the data row in the template already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -InputInstance -Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Path parameter refers to the path of any supporting file for the template. - -```yaml -Type: ProvisioningTemplate -Parameter Sets: Instance - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OverwriteSystemPropertyBagValues -Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Parameters -Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter. - -```yaml -Type: Hashtable -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Path to the xml or pnp file containing the provisioning template. - -```yaml -Type: String -Parameter Sets: Path - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -ProvisionContentTypesToSubWebs -If set content types will be provisioned if the target web is a subweb. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ProvisionFieldsToSubWebs -If set fields will be provisioned if the target web is a subweb. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ResourceFolder -Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while applying a template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md deleted file mode 100644 index e29fc020b1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Apply-PnPTenantTemplate - -## SYNOPSIS -Applies a tenant template to the current tenant. - -## SYNTAX - -### By Path -```powershell -Apply-PnPTenantTemplate -Path <String> - [-SequenceId <String>] - [-ResourceFolder <String>] - [-Handlers <Handlers>] - [-ExcludeHandlers <Handlers>] - [-ExtensibilityHandlers <ExtensibilityHandler[]>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Parameters <Hashtable>] - [-OverwriteSystemPropertyBagValues [<SwitchParameter>]] - [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]] - [-ProvisionContentTypesToSubWebs [<SwitchParameter>]] - [-ProvisionFieldsToSubWebs [<SwitchParameter>]] - [-ClearNavigation [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### By Object -```powershell -Apply-PnPTenantTemplate -Template <ProvisioningHierarchy> - [-SequenceId <String>] - [-ResourceFolder <String>] - [-Handlers <Handlers>] - [-ExcludeHandlers <Handlers>] - [-ExtensibilityHandlers <ExtensibilityHandler[]>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Parameters <Hashtable>] - [-OverwriteSystemPropertyBagValues [<SwitchParameter>]] - [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]] - [-ProvisionContentTypesToSubWebs [<SwitchParameter>]] - [-ProvisionFieldsToSubWebs [<SwitchParameter>]] - [-ClearNavigation [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Apply-PnPTenantTemplate -Path myfile.pnp -``` - -Will read the tenant template from the filesystem and will apply the sequences in the template - -### ------------------EXAMPLE 2------------------ -```powershell -Apply-PnPTenantTemplate -Path myfile.pnp -SequenceId "mysequence" -``` - -Will read the tenant template from the filesystem and will apply the specified sequence in the template - -### ------------------EXAMPLE 3------------------ -```powershell -Apply-PnPTenantTemplate -Path myfile.pnp -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"} -``` - -Applies a tenant template to the current tenant. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:<key>} token. - -For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template. - -## PARAMETERS - -### -ClearNavigation -Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExcludeHandlers -Allows you to run all handlers, excluding the ones specified. - -```yaml -Type: Handlers -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExtensibilityHandlers -Allows you to specify ExtensbilityHandlers to execute while applying a template - -```yaml -Type: ExtensibilityHandler[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Handlers -Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. - -```yaml -Type: Handlers -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IgnoreDuplicateDataRowErrors -Ignore duplicate data row errors when the data row in the template already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OverwriteSystemPropertyBagValues -Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Parameters -Allows you to specify parameters that can be referred to in the hierarchy by means of the {parameter:<Key>} token. See examples on how to use this parameter. - -```yaml -Type: Hashtable -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Path to the xml or pnp file containing the provisioning hierarchy. - -```yaml -Type: String -Parameter Sets: By Path - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -ProvisionContentTypesToSubWebs -If set content types will be provisioned if the target web is a subweb. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ProvisionFieldsToSubWebs -If set fields will be provisioned if the target web is a subweb. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ResourceFolder -Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the tenant template is located will be used. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SequenceId - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Template - - -```yaml -Type: ProvisioningHierarchy -Parameter Sets: By Object -Aliases: Hierarchy - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while applying a template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md deleted file mode 100644 index c43a146d14..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Approve-PnPTenantServicePrincipalPermissionRequest - -## SYNOPSIS -Approves a permission request for the current tenant's "SharePoint Online Client" service principal - -## SYNTAX - -```powershell -Approve-PnPTenantServicePrincipalPermissionRequest -RequestId <GuidPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Approves a permission request for the current tenant's "SharePoint Online Client" service principal - -The return value of a successful call is a permission grant object. - -To get the collection of permission grants for the "SharePoint Online Client" service principal, use the Get-PnPTenantServicePrincipalPermissionGrants command. - -Approving a permission request also removes that request from the list of permission requests. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RequestId - - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md deleted file mode 100644 index 77f8ce204d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Clear-PnPListItemAsRecord - -## SYNOPSIS -Undeclares a list item as a record - -## SYNTAX - -```powershell -Clear-PnPListItemAsRecord -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Clear-PnPListItemAsRecord -List "Documents" -Identity 4 -``` - -Undeclares the document in the documents library with id 4 as a record - -## PARAMETERS - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md deleted file mode 100644 index ddd1228e4c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Clear-PnPTenantRecycleBinItem - -## SYNOPSIS -Permanently deletes a site collection from the tenant scoped recycle bin - -## SYNTAX - -```powershell -Clear-PnPTenantRecycleBinItem -Url <String> - [-Wait [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -The Clear-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be permanently deleted from the recycle bin as well. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Clear-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -``` - -This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin - -### ------------------EXAMPLE 2------------------ -```powershell -Clear-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait -``` - -This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin and will wait with executing further PowerShell commands until the operation has completed - -## PARAMETERS - -### -Force -If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -Url of the site collection to permanently delete from the tenant recycle bin - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Wait -If provided, the PowerShell execution will halt until the operation has completed - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md deleted file mode 100644 index aa261a32da..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Clear-PnPRecycleBinItem - -## SYNOPSIS -Permanently deletes all or a specific recycle bin item - -## SYNTAX - -### All -```powershell -Clear-PnPRecycleBinItem [-All [<SwitchParameter>]] - [-SecondStageOnly [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### Identity -```powershell -Clear-PnPRecycleBinItem -Identity <RecycleBinItemPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPRecycleBinItem | ? FileLeafName -like "*.docx" | Clear-PnpRecycleBinItem -``` - -Permanently deletes all the items in the first and second stage recycle bins of which the file names have the .docx extension - -### ------------------EXAMPLE 2------------------ -```powershell -Clear-PnpRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442 -``` - -Permanently deletes the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 from the recycle bin - -### ------------------EXAMPLE 3------------------ -```powershell -Clear-PnpRecycleBinItem -Identity $item -Force -``` - -Permanently deletes the recycle bin item stored under variable $item from the recycle bin without asking for confirmation from the end user first - -## PARAMETERS - -### -All -Clears all items - -```yaml -Type: SwitchParameter -Parameter Sets: All - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -If provided, no confirmation will be asked to permanently delete the recycle bin item - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Id of the recycle bin item or the recycle bin item itself to permanently delete - -```yaml -Type: RecycleBinItemPipeBind -Parameter Sets: Identity - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -SecondStageOnly -If provided, only all the items in the second stage recycle bin will be cleared - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: All - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPMicrosoftGraph.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPMicrosoftGraph.md deleted file mode 100644 index 6b6afb378c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPMicrosoftGraph.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Connect-PnPMicrosoftGraph - -## SYNOPSIS -Connect to the Microsoft Graph - -## SYNTAX - -### Scope -```powershell -Connect-PnPMicrosoftGraph -Scopes <String[]> -``` - -### AAD -```powershell -Connect-PnPMicrosoftGraph -AppId <String> - -AppSecret <String> - -AADDomain <String> -``` - -## DESCRIPTION -Uses the Microsoft Authentication Library (Preview) to connect to Azure AD and to get an OAuth 2.0 Access Token to consume the Microsoft Graph API - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPMicrosoftGraph -Scopes $arrayOfScopes -``` - -Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://graph.microsoft.io/en-us/docs/authorization/permission_scopes - -### ------------------EXAMPLE 2------------------ -```powershell -Connect-PnPMicrosoftGraph -AppId '<id>' -AppSecret '<secret>' -AADDomain 'contoso.onmicrosoft.com' -``` - -Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started. - -## PARAMETERS - -### -AADDomain -The AAD where the O365 app is registred. Eg.: contoso.com, or contoso.onmicrosoft.com. - -```yaml -Type: String -Parameter Sets: AAD - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AppId -The client id of the app which gives you access to the Microsoft Graph API. - -```yaml -Type: String -Parameter Sets: AAD - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AppSecret -The app key of the app which gives you access to the Microsoft Graph API. - -```yaml -Type: String -Parameter Sets: AAD - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scopes -The array of permission scopes for the Microsoft Graph API. - -```yaml -Type: String[] -Parameter Sets: Scope - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md deleted file mode 100644 index f25587f4ae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md +++ /dev/null @@ -1,923 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Connect-PnPOnline - -## SYNOPSIS -Connect to a SharePoint site - -## SYNTAX - -### Main -```powershell -Connect-PnPOnline -Url <String> - [-ReturnConnection [<SwitchParameter>]] - [-Credentials <CredentialPipeBind>] - [-CurrentCredentials [<SwitchParameter>]] - [-UseAdfs [<SwitchParameter>]] - [-LoginProviderName <String>] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-AuthenticationMode <ClientAuthenticationMode>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-Scopes <String[]>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### Access Token -```powershell -Connect-PnPOnline -AccessToken <String> - [-ReturnConnection [<SwitchParameter>]] - [-Url <String>] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### PnP Office 365 Management Shell to the Microsoft Graph -```powershell -Connect-PnPOnline -Graph [<SwitchParameter>] - [-LaunchBrowser [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### Microsoft Graph using Scopes -```powershell -Connect-PnPOnline -Scopes <String[]> - [-NoTelemetry [<SwitchParameter>]] -``` - -### WebLogin -```powershell -Connect-PnPOnline -Url <String> - -UseWebLogin [<SwitchParameter>] - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-Scopes <String[]>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### SPO Management Shell Credentials -```powershell -Connect-PnPOnline -Url <String> - -SPOManagementShell [<SwitchParameter>] - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-ClearTokenCache [<SwitchParameter>]] - [-Scopes <String[]>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### PnP O365 Management Shell / DeviceLogin -```powershell -Connect-PnPOnline -Url <String> - -PnPO365ManagementShell [<SwitchParameter>] - [-ReturnConnection [<SwitchParameter>]] - [-LaunchBrowser [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### Token -```powershell -Connect-PnPOnline -Url <String> - -AppId <String> - -AppSecret <String> - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-Realm <String>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-Scopes <String[]>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### Azure Active Directory -```powershell -Connect-PnPOnline -Url <String> - -ClientId <String> - -RedirectUri <String> - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-ClearTokenCache [<SwitchParameter>]] - [-AzureEnvironment <AzureEnvironment>] - [-Scopes <String[]>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### Microsoft Graph using Azure Active Directory -```powershell -Connect-PnPOnline -AppId <String> - -AppSecret <String> - -AADDomain <String> - [-NoTelemetry [<SwitchParameter>]] -``` - -### High Trust using a X509Certificate2 object. -```powershell -Connect-PnPOnline -Url <String> - -ClientId <String> - -HighTrustCertificate <X509Certificate2> - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-HighTrustCertificateIssuerId <String>] - [-NoTelemetry [<SwitchParameter>]] -``` - -### App-Only with Azure Active Directory -```powershell -Connect-PnPOnline -Url <String> - -ClientId <String> - -Tenant <String> - -CertificatePath <String> - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-CertificatePassword <SecureString>] - [-AzureEnvironment <AzureEnvironment>] - [-Scopes <String[]>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -### High Trust using a certificate from a PFX file. -```powershell -Connect-PnPOnline -Url <String> - -ClientId <String> - -HighTrustCertificatePath <String> - -HighTrustCertificatePassword <String> - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-HighTrustCertificateIssuerId <String>] - [-NoTelemetry [<SwitchParameter>]] -``` - -### App-Only with Azure Active Directory using certificate as PEM strings -```powershell -Connect-PnPOnline -Url <String> - -ClientId <String> - -Tenant <String> - -PEMCertificate <String> - -PEMPrivateKey <String> - [-ReturnConnection [<SwitchParameter>]] - [-MinimalHealthScore <Int>] - [-RetryCount <Int>] - [-RetryWait <Int>] - [-RequestTimeout <Int>] - [-CreateDrive [<SwitchParameter>]] - [-DriveName <String>] - [-CertificatePassword <SecureString>] - [-AzureEnvironment <AzureEnvironment>] - [-TenantAdminUrl <String>] - [-SkipTenantAdminCheck [<SwitchParameter>]] - [-IgnoreSslErrors [<SwitchParameter>]] - [-NoTelemetry [<SwitchParameter>]] -``` - -## DESCRIPTION -If no credentials have been specified, and the CurrentCredentials parameter has not been specified, you will be prompted for credentials. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -``` - -This will prompt for username and password and creates a context for the other PowerShell commands to use. When a generic credential is added to the Windows Credential Manager with https://contoso.sharepoint.com, PowerShell will not prompt for username and password. - -### ------------------EXAMPLE 2------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -Credentials (Get-Credential) -``` - -This will prompt for username and password and creates a context for the other PowerShell commands to use. - -### ------------------EXAMPLE 3------------------ -```powershell -Connect-PnPOnline -Url http://yourlocalserver -CurrentCredentials -``` - -This will use the current user credentials and connects to the server specified by the Url parameter. - -### ------------------EXAMPLE 4------------------ -```powershell -Connect-PnPOnline -Url http://yourlocalserver -Credentials 'O365Creds' -``` - -This will use credentials from the Windows Credential Manager, as defined by the label 'O365Creds'. - -### ------------------EXAMPLE 5------------------ -```powershell -Connect-PnPOnline -Url http://yourlocalserver -Credentials (Get-Credential) -UseAdfs -``` - -This will prompt for username and password and creates a context using ADFS to authenticate. - -### ------------------EXAMPLE 6------------------ -```powershell -Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -CreateDrive -cd SPO:\\ -dir -``` - -This will prompt you for credentials and creates a context for the other PowerShell commands to use. It will also create a SPO:\\ drive you can use to navigate around the site - -### ------------------EXAMPLE 7------------------ -```powershell -Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -AuthenticationMode FormsAuthentication -``` - -This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA) - -### ------------------EXAMPLE 8------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -AppSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany -``` - -This will authenticate you to the German Azure environment using the German Azure endpoints for authentication - -### ------------------EXAMPLE 9------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -SPOManagementShell -``` - -This will authenticate you using the SharePoint Online Management Shell application - -### ------------------EXAMPLE 10------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell -``` - -This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will have to be opened where you have to enter a code that is shown in your PowerShell window. - -### ------------------EXAMPLE 11------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell -LaunchBrowser -``` - -This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will automatically open and the code you need to enter will be automatically copied to your clipboard. - -### ------------------EXAMPLE 12------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -AccessToken $myaccesstoken -``` - -This will authenticate you using the provided access token - -### ------------------EXAMPLE 13------------------ -```powershell -Connect-PnPOnline -Scopes $arrayOfScopes -``` - -Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://graph.microsoft.io/en-us/docs/authorization/permission_scopes - -### ------------------EXAMPLE 14------------------ -```powershell -Connect-PnPOnline -AppId '<id>' -AppSecret '<secret>' -AADDomain 'contoso.onmicrosoft.com' -``` - -Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started. - -### ------------------EXAMPLE 15------------------ -```powershell -certutil.exe -csp 'Microsoft Enhanced RSA and AES Cryptographic Provider' -v -p 'password' -importpfx -user c:\HighTrust.pfx NoRoot -Connect-PnPOnline -Url https://yourserver -ClientId <id> -HighTrustCertificate (Get-Item Cert:\CurrentUser\My\<thumbprint>) -``` - -Connect to an on-premises SharePoint environment using a high trust certificate, stored in the Personal certificate store of the current user. - -### ------------------EXAMPLE 16------------------ -```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -PEMCertificate <PEM string> -PEMPrivateKey <PEM string> -``` - -Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. - -### ------------------EXAMPLE 17------------------ -```powershell -Connect-PnPOnline -Url https://yourserver -ClientId 763d5e60-b57e-426e-8e87-b7258f7f8188 -HighTrustCertificatePath c:\HighTrust.pfx -HighTrustCertificatePassword 'password' -HighTrustCertificateIssuerId 6b9534d8-c2c1-49d6-9f4b-cd415620bca8 -``` - -Connect to an on-premises SharePoint environment using a high trust certificate stored in a .PFX file. - -## PARAMETERS - -### -AADDomain -The AAD where the O365 app is registred. Eg.: contoso.com, or contoso.onmicrosoft.com. - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: Microsoft Graph using Azure Active Directory - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AccessToken -Connect with an existing Access Token - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: Access Token - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AppId -The Application Client ID to use. - -```yaml -Type: String -Parameter Sets: Token, Microsoft Graph using Azure Active Directory - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AppSecret -The Application Client Secret to use. - -```yaml -Type: String -Parameter Sets: Token, Microsoft Graph using Azure Active Directory - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AuthenticationMode -Specify to use for instance use forms based authentication (FBA) - -```yaml -Type: ClientAuthenticationMode -Parameter Sets: Main - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AzureEnvironment -The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment. - -Only applicable to: SharePoint Online - -```yaml -Type: AzureEnvironment -Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CertificatePassword -Password to the certificate (*.pfx) - -Only applicable to: SharePoint Online - -```yaml -Type: SecureString -Parameter Sets: App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CertificatePath -Path to the certificate (*.pfx) - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: App-Only with Azure Active Directory - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ClearTokenCache -Clears the token cache. - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: Azure Active Directory, SPO Management Shell Credentials - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ClientId -The Client ID of the Azure AD Application - -```yaml -Type: String -Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -CreateDrive -If you want to create a PSDrive connected to the URL - -```yaml -Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Credentials -Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Windows Credential Manager for the correct credentials. - -```yaml -Type: CredentialPipeBind -Parameter Sets: Main - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CurrentCredentials -If you want to connect with the current user credentials - -```yaml -Type: SwitchParameter -Parameter Sets: Main - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DriveName -Name of the PSDrive to create (default: SPO) - -```yaml -Type: String -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Graph -Log in using the PnP O365 Management Shell application towards the Graph. You will be asked to consent to: - -* Read and write managed metadata -* Have full control of all site collections -* Read user profiles -* Invite guest users to the organization -* Read and write all groups -* Read and write directory data -* Access the directory as you -* Read and write identity providers -* Access the directory as you - - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: PnP Office 365 Management Shell to the Microsoft Graph - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -HighTrustCertificate -The certificate which has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Note that CNG key storage providers are not supported. - -Only applicable to: SharePoint Server 2013, SharePoint Server 2016 - -```yaml -Type: X509Certificate2 -Parameter Sets: High Trust using a X509Certificate2 object. - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -HighTrustCertificateIssuerId -The IssuerID under which the certificate has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Uses the ClientID if not specified. - -Only applicable to: SharePoint Server 2013, SharePoint Server 2016 - -```yaml -Type: String -Parameter Sets: High Trust using a X509Certificate2 object., High Trust using a certificate from a PFX file. - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -HighTrustCertificatePassword -The password of the private key certificate (.pfx) to use for the High Trust connection - -Only applicable to: SharePoint Server 2013, SharePoint Server 2016 - -```yaml -Type: String -Parameter Sets: High Trust using a certificate from a PFX file. - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -HighTrustCertificatePath -The path to the private key certificate (.pfx) to use for the High Trust connection - -Only applicable to: SharePoint Server 2013, SharePoint Server 2016 - -```yaml -Type: String -Parameter Sets: High Trust using a certificate from a PFX file. - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -IgnoreSslErrors -Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LaunchBrowser -Launch a browser automatically and copy the code to enter to the clipboard - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: PnP O365 Management Shell / DeviceLogin, PnP Office 365 Management Shell to the Microsoft Graph - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LoginProviderName -The name of the ADFS trusted login provider - -```yaml -Type: String -Parameter Sets: Main - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MinimalHealthScore -Specifies a minimal server healthscore before any requests are executed. - -```yaml -Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NoTelemetry -In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PEMCertificate -PEM encoded certificate - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PEMPrivateKey -PEM encoded private key for the certificate - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PnPO365ManagementShell -Log in using the PnP O365 Management Shell application. You will be asked to consent to: - -* Read and write managed metadata -* Have full control of all site collections -* Read user profiles -* Invite guest users to the organization -* Read and write all groups -* Read and write directory data -* Access the directory as you -* Read and write identity providers -* Access the directory as you - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: PnP O365 Management Shell / DeviceLogin - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Realm -Authentication realm. If not specified will be resolved from the url specified. - -```yaml -Type: String -Parameter Sets: Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RedirectUri -The Redirect URI of the Azure AD Application - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: Azure Active Directory - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -RequestTimeout -The request timeout. Default is 180000 - -```yaml -Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RetryCount -Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. - -```yaml -Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RetryWait -Defines how many seconds to wait before each retry. Default is 1 second. - -```yaml -Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ReturnConnection -Returns the connection for use with the -Connection parameter on cmdlets. - -```yaml -Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Scopes -The array of permission scopes for the Microsoft Graph API. - -Only applicable to: SharePoint Online - -```yaml -Type: String[] -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, SPO Management Shell Credentials, Microsoft Graph using Scopes - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SkipTenantAdminCheck -Should we skip the check if this site is the Tenant admin site. Default is false - -```yaml -Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SPOManagementShell -Log in using the SharePoint Online Management Shell application - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: SPO Management Shell Credentials - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Tenant -The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TenantAdminUrl -The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate. - -```yaml -Type: String -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -The Url of the site collection to connect to. - -```yaml -Type: String -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -UseAdfs -If you want to connect to your on-premises SharePoint farm using ADFS - -```yaml -Type: SwitchParameter -Parameter Sets: Main - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UseWebLogin -If you want to connect to SharePoint with browser based login. This is required when you have multi-factor authentication (MFA) enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: WebLogin - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md deleted file mode 100644 index 5696d24e3a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Convert-PnPFolderToProvisioningTemplate - -## SYNOPSIS -Creates a pnp package file of an existing template xml, and includes all files in the current folder - -## SYNTAX - -```powershell -Convert-PnPFolderToProvisioningTemplate -Out <String> - [-Force [<SwitchParameter>]] - [-Folder <String>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Convert-PnPFolderToProvisioningTemplate -Out template.pnp -``` - -Creates a pnp package file of an existing template xml, and includes all files in the current folder - -### ------------------EXAMPLE 2------------------ -```powershell -Convert-PnPFolderToProvisioningTemplate -Out template.pnp -Folder c:\temp -``` - -Creates a pnp package file of an existing template xml, and includes all files in the c:\temp folder - -## PARAMETERS - -### -Folder -Folder to process. If not specified the current folder will be used. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md deleted file mode 100644 index 88ed52a9b0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Convert-PnPProvisioningTemplate - -## SYNOPSIS -Converts a provisioning template to an other schema version - -## SYNTAX - -```powershell -Convert-PnPProvisioningTemplate -Path <String> - [-Out <String>] - [-Encoding <Encoding>] - [-Force [<SwitchParameter>]] - [-ToSchema <XMLPnPSchemaVersion>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Convert-PnPProvisioningTemplate -Path template.xml -``` - -Converts a provisioning template to the latest schema and outputs the result to current console. - -### ------------------EXAMPLE 2------------------ -```powershell -Convert-PnPProvisioningTemplate -Path template.xml -Out newtemplate.xml -``` - -Converts a provisioning template to the latest schema and outputs the result the newtemplate.xml file. - -### ------------------EXAMPLE 3------------------ -```powershell -Convert-PnPProvisioningTemplate -Path template.xml -Out newtemplate.xml -ToSchema V201512 -``` - -Converts a provisioning template to the latest schema using the 201512 schema and outputs the result the newtemplate.xml file. - -## PARAMETERS - -### -Encoding -The encoding type of the XML file, Unicode is default - -```yaml -Type: Encoding -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Path to the xml file containing the site template - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -ToSchema -The schema of the output to use, defaults to the latest schema - -```yaml -Type: XMLPnPSchemaVersion -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md deleted file mode 100644 index 38eb9ba43e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Copy-PnPFile - -## SYNOPSIS -Copies a file or folder to a different location - -## SYNTAX - -### SOURCEURL -```powershell -Copy-PnPFile -SourceUrl <String> - -TargetUrl <String> - [-OverwriteIfAlreadyExists [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-SkipSourceFolderName [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -``` - -Copies a file named company.docx located in a document library called Documents in the current site to the site collection otherproject. If a file named company.docx already exists, it won't perform the copy. - -### ------------------EXAMPLE 2------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents/company2.docx -``` - -Copies a file named company.docx located in a document library called Documents to a new document named company2.docx in the same library. - -### ------------------EXAMPLE 3------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents2/company.docx -``` - -Copies a file named company.docx located in a document library called Documents to a document library called Documents2 in the same site. - -### ------------------EXAMPLE 4------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Subsite/Documents/company2.docx -``` - -Copies a file named company.docx located in a document library called Documents to the document library named Document in a subsite named Subsite as a new document named company2.docx. - -### ------------------EXAMPLE 5------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Subsite/Documents -``` - -Copies a file named company.docx located in a document library called Documents to the document library named Document in a subsite named Subsite keeping the file name. - -### ------------------EXAMPLE 6------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -OverwriteIfAlreadyExists -``` - -Copies a file named company.docx located in a document library called Documents in the current site to the site collection otherproject. If a file named company.docx already exists, it will still perform the copy and replace the original company.docx file. - -### ------------------EXAMPLE 7------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents -OverwriteIfAlreadyExists -``` - -Copies a folder named MyDocs in the document library called Documents located in the current site to the site collection otherproject. If the MyDocs folder exist it will copy into it, if not it will be created. - -### ------------------EXAMPLE 8------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents -SkipSourceFolderName -OverwriteIfAlreadyExists -``` - -Copies a folder named MyDocs in the document library called Documents located in the current site to the root folder of the library named Documents in the site collection otherproject. - -### ------------------EXAMPLE 9------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents/MyDocs -SkipSourceFolderName -OverwriteIfAlreadyExists -``` - -Copies a folder named MyDocs in the MyDocs folder of the library named Documents. If the MyDocs folder does not exists, it will be created. - -### ------------------EXAMPLE 10------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents/MyDocs -OverwriteIfAlreadyExists -``` - -Copies a folder named MyDocs in the root of the library named Documents. If the MyDocs folder exists in the target, a subfolder also named MyDocs is created. - -### ------------------EXAMPLE 11------------------ -```powershell -PS:>Copy-PnPFile -SourceUrl SubSite1/Documents/company.docx -TargetUrl SubSite2/Documents -``` - -Copies a file named company.docx in the library named Documents in SubSite1 to the library named Documents in SubSite2. - -## PARAMETERS - -### -Force -If provided, no confirmation will be requested and the action will be performed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OverwriteIfAlreadyExists -If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the copy operation will be canceled if the file already exists at the TargetUrl location. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SkipSourceFolderName -If the source is a folder, the source folder name will not be created, only the contents within it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SourceUrl -Site relative Url specifying the file or folder to copy. - -```yaml -Type: String -Parameter Sets: SOURCEURL -Aliases: SiteRelativeUrl - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TargetUrl -Server relative Url where to copy the file or folder to. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md deleted file mode 100644 index 56345b5de2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Copy-PnPItemProxy - -## SYNOPSIS -Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md deleted file mode 100644 index 1435a37e3e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Deny-PnPTenantServicePrincipalPermissionRequest - -## SYNOPSIS -Denies a permission request for the current tenant's "SharePoint Online Client" service principal - -## SYNTAX - -```powershell -Deny-PnPTenantServicePrincipalPermissionRequest -RequestId <GuidPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Denies a permission request for the current tenant's "SharePoint Online Client" service principal - -Denying a permission request removes that request from the list of permission requests. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RequestId - - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md deleted file mode 100644 index 6c719b82a3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Disable-PnPFeature - -## SYNOPSIS -Disables a feature - -## SYNTAX - -```powershell -Disable-PnPFeature -Identity <GuidPipeBind> - [-Force [<SwitchParameter>]] - [-Scope <FeatureScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Deactivates a feature that was active on a site - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" - -### ------------------EXAMPLE 2------------------ -```powershell -Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force -``` - -This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force. - -### ------------------EXAMPLE 3------------------ -```powershell -Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web -``` - -This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope. - -## PARAMETERS - -### -Force -Specifies whether to continue if an error occurs when deactivating the feature. - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The id of the feature to disable. - -```yaml -Type: GuidPipeBind -Parameter Sets: __AllParameterSets - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Scope -Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web. - -```yaml -Type: FeatureScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md deleted file mode 100644 index 70c8e9f601..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Disable-PnPInPlaceRecordsManagementForSite - -## SYNOPSIS -Disables in place records management for a site. - -## SYNTAX - -```powershell -Disable-PnPInPlaceRecordsManagementForSite [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Disable-PnPInPlaceRecordsManagementForSite -``` - -The in place records management feature will be disabled - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md deleted file mode 100644 index f20ba32057..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Disable-PnPPowerShellTelemetry - -## SYNOPSIS -Disables PnP PowerShell telemetry tracking - -## SYNTAX - -```powershell -Disable-PnPPowerShellTelemetry [-Force [<SwitchParameter>]] -``` - -## DESCRIPTION -Disables PnP PowerShell telemetry tracking - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Disable-PnPPowerShellTelemetry -``` - -Will prompt you to confirm to disable telemetry tracking. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md deleted file mode 100644 index 640a2ab702..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Disable-PnPResponsiveUI - -## SYNOPSIS -Deactivate the PnP Response UI add-on - -## SYNTAX - -```powershell -Disable-PnPResponsiveUI [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Disables the PnP Responsive UI implementation on a classic SharePoint Site - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Disable-PnPResponsiveUI -``` - -If enabled previously, this will remove the PnP Responsive UI from a site. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md deleted file mode 100644 index cba6994cfe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Disable-PnPSiteClassification - -## SYNOPSIS -Disables Site Classifications for the tenant. Requires a connection to the Microsoft Graph. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Disable-PnPSiteClassification -``` - -Disables Site Classifications for your tenant. - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md deleted file mode 100644 index 47e5207d5a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Disable-PnPTenantServicePrincipal - -## SYNOPSIS -Enables the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Disable-PnPTenantServicePrincipal [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Enables the current tenant's "SharePoint Online Client" service principal. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md deleted file mode 100644 index 52624f6296..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Disconnect-PnPOnline - -## SYNOPSIS -Disconnects the context - -## SYNTAX - -```powershell -Disconnect-PnPOnline [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Disconnects the current context and requires you to build up a new connection in order to use the Cmdlets again. Using Connect-PnPOnline to connect to a different site has the same effect. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Disconnect-PnPOnline -``` - -This will disconnect you from the server. - -## PARAMETERS - -### -Connection -Connection to be used by cmdlet - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md deleted file mode 100644 index 20411cb0d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Enable-PnPFeature - -## SYNOPSIS -Enables a feature - -## SYNTAX - -```powershell -Enable-PnPFeature -Identity <GuidPipeBind> - [-Force [<SwitchParameter>]] - [-Scope <FeatureScope>] - [-Sandboxed [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" - -### ------------------EXAMPLE 2------------------ -```powershell -Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force -``` - -This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force. - -### ------------------EXAMPLE 3------------------ -```powershell -Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web -``` - -This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope. - -## PARAMETERS - -### -Force -Specifies whether to overwrite an existing feature with the same feature identifier. This parameter is ignored if there are no errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The id of the feature to enable. - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Sandboxed -Specify this parameter if the feature you're trying to activate is part of a sandboxed solution. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Scope -Specify the scope of the feature to activate, either Web or Site. Defaults to Web. - -```yaml -Type: FeatureScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md deleted file mode 100644 index 06137358a5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Enable-PnPInPlaceRecordsManagementForSite - -## SYNOPSIS -Enables in place records management for a site. - -## SYNTAX - -```powershell -Enable-PnPInPlaceRecordsManagementForSite [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Enable-PnPInPlaceRecordsManagementForSite -``` - -The in place records management feature will be enabled and the in place record management will be enabled in all locations with record declaration allowed by all contributors and undeclaration by site admins - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md deleted file mode 100644 index e558e9b880..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Enable-PnPPowerShellTelemetry - -## SYNOPSIS -Enables PnP PowerShell telemetry tracking. - -## SYNTAX - -```powershell -Enable-PnPPowerShellTelemetry [-Force [<SwitchParameter>]] -``` - -## DESCRIPTION -In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off, alternative, use the -NoTelemetry switch on Connect-PnPOnline to turn it off for that session. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Enable-PnPPowerShellTelemetry -``` - -Will prompt you to confirm to enable telemetry tracking. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md deleted file mode 100644 index 6a2d0aef73..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Enable-PnPResponsiveUI - -## SYNOPSIS -Activates the PnP Response UI Add-on - -## SYNTAX - -```powershell -Enable-PnPResponsiveUI [-InfrastructureSiteUrl <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Enables the PnP Responsive UI implementation on a classic SharePoint Site - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Enable-PnPResponsiveUI -``` - -Will upload a CSS file, a JavaScript file and adds a custom action to the root web of the current site collection, enabling the responsive UI on the site collection. The CSS and JavaScript files are located in the style library, in a folder called SP.Responsive.UI. - -## PARAMETERS - -### -InfrastructureSiteUrl -A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md deleted file mode 100644 index c892a30d8e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Enable-PnPSiteClassification - -## SYNOPSIS -Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph. - -## SYNTAX - -```powershell -Enable-PnPSiteClassification -Classifications <String> - -DefaultClassification <String> - [-UsageGuidelinesUrl <String>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -DefaultClassification "LBI" -``` - -Enables Site Classifications for your tenant and provides three classification values. The default value will be set to "LBI" - -### ------------------EXAMPLE 2------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -UsageGuidelinesUrl http://aka.ms/sppnp -``` - -Enables Site Classifications for your tenant and provides three classification values. The usage guideliness will be set to the specified URL. - -## PARAMETERS - -### -Classifications - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DefaultClassification - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -UsageGuidelinesUrl - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md deleted file mode 100644 index 0943e51a08..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Enable-PnPTenantServicePrincipal - -## SYNOPSIS -Enables the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Enable-PnPTenantServicePrincipal [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Enables the current tenant's "SharePoint Online Client" service principal. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md deleted file mode 100644 index 59f334fcc5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Export-PnPTaxonomy - -## SYNOPSIS -Exports a taxonomy to either the output or to a file. - -## SYNTAX - -### TermSet -```powershell -Export-PnPTaxonomy [-TermSetId <GuidPipeBind>] - [-TermStoreName <String>] - [-IncludeID [<SwitchParameter>]] - [-Path <String>] - [-Force [<SwitchParameter>]] - [-Delimiter <String>] - [-Encoding <Encoding>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Export-PnPTaxonomy -``` - -Exports the full taxonomy to the standard output - -### ------------------EXAMPLE 2------------------ -```powershell -Export-PnPTaxonomy -Path c:\output.txt -``` - -Exports the full taxonomy the file output.txt - -### ------------------EXAMPLE 3------------------ -```powershell -Export-PnPTaxonomy -Path c:\output.txt -TermSet f6f43025-7242-4f7a-b739-41fa32847254 -``` - -Exports the term set with the specified id - -## PARAMETERS - -### -Delimiter -The path delimiter to be used, by default this is '|' - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Encoding -Defaults to Unicode - -```yaml -Type: Encoding -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeID -If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid> - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -File to export the data to. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermSetId -If specified, will export the specified termset only - -```yaml -Type: GuidPipeBind -Parameter Sets: TermSet - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermStoreName -Term store to export; if not specified the default term store is used. - -```yaml -Type: String -Parameter Sets: TermSet - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md deleted file mode 100644 index 156c8ff608..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Export-PnPTermGroupToXml - -## SYNOPSIS -Exports a taxonomy TermGroup to either the output or to an XML file. - -## SYNTAX - -```powershell -Export-PnPTermGroupToXml [-Identity <Id, Title or TermGroup>] - [-Out <String>] - [-FullTemplate [<SwitchParameter>]] - [-Encoding <Encoding>] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Export-PnPTermGroupToXml -``` - -Exports all term groups in the default site collection term store to the standard output - -### ------------------EXAMPLE 2------------------ -```powershell -Export-PnPTermGroupToXml -Out output.xml -``` - -Exports all term groups in the default site collection term store to the file 'output.xml' in the current folder - -### ------------------EXAMPLE 3------------------ -```powershell -Export-PnPTermGroupToXml -Out c:\output.xml -Identity "Test Group" -``` - -Exports the term group with the specified name to the file 'output.xml' located in the root folder of the C: drive. - -### ------------------EXAMPLE 4------------------ -```powershell -$termgroup = Get-PnPTermGroup -GroupName Test -$termgroup | Export-PnPTermGroupToXml -Out c:\output.xml -``` - -Retrieves a termgroup and subsequently exports that term group to a the file named 'output.xml' - -## PARAMETERS - -### -Encoding -Defaults to Unicode - -```yaml -Type: Encoding -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -FullTemplate -If specified, a full provisioning template structure will be returned - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID or name of the termgroup - -```yaml -Type: Id, Title or TermGroup -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Out -File to export the data to. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md deleted file mode 100644 index 36c91d9155..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Find-PnPFile - -## SYNOPSIS -Finds a file in the virtual file system of the web. - -## SYNTAX - -### Web -```powershell -Find-PnPFile -Match <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### List -```powershell -Find-PnPFile -Match <String> - -List <ListPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Folder -```powershell -Find-PnPFile -Match <String> - -Folder <FolderPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Find-PnPFile -Match *.master -``` - -Will return all masterpages located in the current web. - -### ------------------EXAMPLE 2------------------ -```powershell -Find-PnPFile -List "Documents" -Match *.pdf -``` - -Will return all pdf files located in given list. - -### ------------------EXAMPLE 3------------------ -```powershell -Find-PnPFile -Folder "Shared Documents/Sub Folder" -Match *.docx -``` - -Will return all docx files located in given folder. - -## PARAMETERS - -### -Folder -Folder object or relative url of a folder to query - -```yaml -Type: FolderPipeBind -Parameter Sets: Folder - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -List title, url or an actual List object to query - -```yaml -Type: ListPipeBind -Parameter Sets: List - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Match -Wildcard query - -```yaml -Type: String -Parameter Sets: Web, List, Folder - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.File - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md deleted file mode 100644 index 09d1ddd51a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAccessToken - -## SYNOPSIS -Returns the current OAuth Access token - -## SYNTAX - -```powershell -Get-PnPAccessToken [-Decoded [<SwitchParameter>]] -``` - -## DESCRIPTION -Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAccessToken -``` - -Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API - -## PARAMETERS - -### -Decoded -Returns the access token in a decoded manner - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md deleted file mode 100644 index f04822fc23..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPApp - -## SYNOPSIS -Returns the available apps from the app catalog - -## SYNTAX - -```powershell -Get-PnPApp [-Identity <AppMetadataPipeBind>] - [-Scope <AppCatalogScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPApp -``` - -This will return all available apps from the tenant app catalog. It will list the installed version in the current site. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPApp -Scope Site -``` - -This will return all available apps from the site collection scoped app catalog. It will list the installed version in the current site. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f -``` - -This willr retrieve the specific app from the app catalog. - -## PARAMETERS - -### -Identity -Specifies the Id of an app which is available in the app catalog - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<OfficeDevPnP.Core.ALM.AppMetadata> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md deleted file mode 100644 index cb41d65829..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAppAuthAccessToken - -## SYNOPSIS -Returns the access token - -## SYNTAX - -```powershell -Get-PnPAppAuthAccessToken [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns the access token from the current client context (only works with App-Only authentication) - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$accessToken = Get-PnPAppAuthAccessToken -``` - -This will put the access token from current context in the $accessToken variable. Will only work in App authentication flow (App+user or App-Only) - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md deleted file mode 100644 index 9757a295a6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAppInstance - -## SYNOPSIS -Returns a SharePoint AddIn Instance - -## SYNTAX - -### -```powershell -Get-PnPAppInstance [-Includes <String[]>] - [-Identity <AppPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns a SharePoint App/Addin that has been installed in the current site - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAppInstance -``` - -This will return all addin instances in the site. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will return an addin instance with the specified id. - -## PARAMETERS - -### -Identity -Specifies the Id of the App Instance - -```yaml -Type: AppPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<Microsoft.SharePoint.Client.AppInstance> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md deleted file mode 100644 index d938daeae8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAuditing - -## SYNOPSIS -Get the Auditing setting of a site - -## SYNTAX - -```powershell -Get-PnPAuditing [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAuditing -``` - -Gets the auditing settings of the current site - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Audit - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md deleted file mode 100644 index de10876106..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAuthenticationRealm - -## SYNOPSIS -Returns the authentication realm - -## SYNTAX - -```powershell -Get-PnPAuthenticationRealm [-Url <String>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Gets the authentication realm for the current web - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAuthenticationRealm -``` - -This will get the authentication realm for the current connected site - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPAuthenticationRealm -Url https://contoso.sharepoint.com -``` - -This will get the authentication realm for https://contoso.sharepoint.com - -## PARAMETERS - -### -Url -Specifies the URL of the site - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md deleted file mode 100644 index caf1477ca8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAvailableClientSideComponents - -## SYNOPSIS -Gets the available client side components on a particular page - -## SYNTAX - -```powershell -Get-PnPAvailableClientSideComponents -Page <ClientSidePagePipeBind> - [-Component <ClientSideComponentPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAvailableClientSideComponents -Page "MyPage.aspx" -``` - -Gets the list of available client side components on the page 'MyPage.aspx' - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPAvailableClientSideComponents $page -``` - -Gets the list of available client side components on the page contained in the $page variable - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPAvailableClientSideComponents -Page "MyPage.aspx" -ComponentName "HelloWorld" -``` - -Gets the client side component 'HelloWorld' if available on the page 'MyPage.aspx' - -## PARAMETERS - -### -Component -Specifies the component instance or Id to look for. - -```yaml -Type: ClientSideComponentPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Page -The name of the page. - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureADManifestKeyCredentials.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureADManifestKeyCredentials.md deleted file mode 100644 index 1a326ba824..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureADManifestKeyCredentials.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAzureADManifestKeyCredentials - -## SYNOPSIS -Return the JSON Manifest snippet for Azure Apps - -## SYNTAX - -```powershell -Get-PnPAzureADManifestKeyCredentials -CertPath <String> -``` - -## DESCRIPTION -Creates the JSON snippet that is required for the manifest JSON file for Azure WebApplication / WebAPI apps - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAzureADManifestKeyCredentials -CertPath .\mycert.cer -``` - -Output the JSON snippet which needs to be replaced in the application manifest file - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPAzureADManifestKeyCredentials -CertPath .\mycert.cer | Set-Clipboard -``` - -Output the JSON snippet which needs to be replaced in the application manifest file and copies it to the clipboard - -## PARAMETERS - -### -CertPath -Specifies the path to the certificate like .\mycert.cer - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -Outputs a JSON formatted string - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md deleted file mode 100644 index 6b35259c79..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPAzureCertificate - -## SYNOPSIS -Get PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application. - -See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. - -KeyCredentials contains the ADAL app manifest sections. - -Certificate contains the PEM encoded certificate. - -PrivateKey contains the PEM encoded private key of the certificate. - -## SYNTAX - -```powershell -Get-PnPAzureCertificate -CertificatePath <String> - [-CertificatePassword <SecureString>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPAzureCertificate -CertificatePath "mycert.pfx" -``` - -This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPAzureCertificate -CertificatePath "mycert.pfx" -CertificatePassword (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) -``` - -This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx which has the password YourPassword. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPAzureCertificate -CertificatePath "mycert.cer" | clip -``` - -Output the JSON snippet which needs to be replaced in the application manifest file and copies it to the clipboard - -## PARAMETERS - -### -CertificatePassword -Password to the certificate (*.pfx) - -```yaml -Type: SecureString -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CertificatePath -Path to the certificate (*.pfx) - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md deleted file mode 100644 index a608813a06..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPClientSideComponent - -## SYNOPSIS -Retrieve one or more Client-Side components from a page - -## SYNTAX - -```powershell -Get-PnPClientSideComponent -Page <ClientSidePagePipeBind> - [-InstanceId <GuidPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPClientSideComponent -Page Home -``` - -Returns all controls defined on the given page. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -``` - -Returns a specific control defined on the given page. - -## PARAMETERS - -### -InstanceId -The instance id of the component - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Page -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md deleted file mode 100644 index 2379528ba2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPClientSidePage - -## SYNOPSIS -Gets a Client-Side Page - -## SYNTAX - -```powershell -Get-PnPClientSidePage -Identity <ClientSidePagePipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPClientSidePage -Identity "MyPage.aspx" -``` - -Gets the Modern Page (Client-Side) named 'MyPage.aspx' in the current SharePoint site - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPClientSidePage "MyPage" -``` - -Gets the Modern Page (Client-Side) named 'MyPage.aspx' in the current SharePoint site - -## PARAMETERS - -### -Identity -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md deleted file mode 100644 index fa9763f22b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPConnection - -## SYNOPSIS -Returns the current context - -## DESCRIPTION -Returns a PnP PowerShell Connection for use with the -Connection parameter on other cmdlets. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$ctx = Get-PnPConnection -``` - -This will put the current connection for use with the -Connection parameter on other cmdlets. - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md deleted file mode 100644 index 4c7d1e068b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPContentType - -## SYNOPSIS -Retrieves a content type - -## SYNTAX - -```powershell -Get-PnPContentType [-Identity <ContentTypePipeBind>] - [-List <ListPipeBind>] - [-InSiteHierarchy [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPContentType -``` - -This will get a listing of all available content types within the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPContentType -InSiteHierarchy -``` - -This will get a listing of all available content types within the site collection - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPContentType -Identity "Project Document" -``` - -This will get the content type with the name "Project Document" within the current context - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPContentType -List "Documents" -``` - -This will get a listing of all available content types within the list "Documents" - -## PARAMETERS - -### -Identity -Name or ID of the content type to retrieve - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -InSiteHierarchy -Search site hierarchy for content types - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -List to query - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.ContentType - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md deleted file mode 100644 index 6b8ca353bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPContentTypePublishingHubUrl - -## SYNOPSIS -Returns the url to Content Type Publishing Hub - -## SYNTAX - -```powershell -Get-PnPContentTypePublishingHubUrl [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$url = Get-PnPContentTypePublishingHubUrl -Connect-PnPOnline -Url $url -Get-PnPContentType - -``` - -This will retrieve the url to the content type hub, connect to it, and then retrieve the content types form that site - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md deleted file mode 100644 index 57ff5c7026..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPContext - -## SYNOPSIS -Returns the current context - -## DESCRIPTION -Returns a Client Side Object Model context - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$ctx = Get-PnPContext -``` - -This will put the current context in the $ctx variable. - -## OUTPUTS - -### Microsoft.SharePoint.Client.ClientContext - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md deleted file mode 100644 index 8a8298af29..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPCustomAction - -## SYNOPSIS -Return user custom actions - -## SYNTAX - -### -```powershell -Get-PnPCustomAction [-Includes <String[]>] - [-Identity <GuidPipeBind>] - [-Scope <CustomActionScope>] - [-ThrowExceptionIfCustomActionNotFound [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns all or a specific user custom action - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPCustomAction -``` - -Returns all custom actions of the current site. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -``` - -Returns the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPCustomAction -Scope web -``` - -Returns all custom actions for the current web object. - -## PARAMETERS - -### -Identity -Identity of the CustomAction to return. Omit to return all CustomActions. - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Scope -Scope of the CustomAction, either Web, Site or All to return both - -```yaml -Type: CustomActionScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ThrowExceptionIfCustomActionNotFound -Switch parameter if an exception should be thrown if the requested CustomAction does not exist (true) or if omitted, nothing will be returned in case the CustomAction does not exist - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<Microsoft.SharePoint.Client.UserCustomAction> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md deleted file mode 100644 index b8402f76d9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPDefaultColumnValues - -## SYNOPSIS -Gets the default column values for all folders in document library - -## SYNTAX - -```powershell -Get-PnPDefaultColumnValues -List <ListPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Gets the default column values for a document library, per folder. Supports both text, people and taxonomy fields. - -## PARAMETERS - -### -List -The ID, Name or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md deleted file mode 100644 index e1095696ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPDocumentSetTemplate - -## SYNOPSIS -Retrieves a document set template - -## SYNTAX - -### -```powershell -Get-PnPDocumentSetTemplate -Identity <DocumentSetPipeBind> - [-Includes <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPDocumentSetTemplate -Identity "Test Document Set" -``` - -This will get the document set template with the name "Test Document Set" - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPDocumentSetTemplate -Identity "0x0120D520005DB65D094035A241BAC9AF083F825F3B" -``` - -This will get the document set template with the id "0x0120D520005DB65D094035A241BAC9AF083F825F3B" - -## PARAMETERS - -### -Identity -Either specify a name, an id, a document set template object or a content type object - -```yaml -Type: DocumentSetPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.DocumentSet.DocumentSetTemplate - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md deleted file mode 100644 index ad8f5d9d38..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPEventReceiver - -## SYNOPSIS -Return registered eventreceivers - -## SYNTAX - -### List -```powershell -Get-PnPEventReceiver [-List <ListPipeBind>] - [-Identity <EventReceiverPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### -```powershell -Get-PnPEventReceiver [-Includes <String[]>] - [-Identity <EventReceiverPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns all registered or a specific eventreceiver - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPEventReceiver -``` - -This will return all registered event receivers on the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -``` - -This will return the event receiver with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPEventReceiver -Identity MyReceiver -``` - -This will return the event receiver with the provided ReceiverName "MyReceiver" from the current web - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPEventReceiver -List "ProjectList" -``` - -This will return all registered event receivers in the provided "ProjectList" list - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPEventReceiver -List "ProjectList" -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -``` - -This will return the event receiver in the provided "ProjectList" list with with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPEventReceiver -List "ProjectList" -Identity MyReceiver -``` - -This will return the event receiver in the "ProjectList" list with the provided ReceiverName "MyReceiver" - -## PARAMETERS - -### -Identity -The Guid of the event receiver - -```yaml -Type: EventReceiverPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -List -The list object from which to get the event receiver object - -```yaml -Type: ListPipeBind -Parameter Sets: List - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.EventReceiverDefinition - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md deleted file mode 100644 index 8ad992ad9e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPException - -## SYNOPSIS -Returns the last exception that occured - -## SYNTAX - -```powershell -Get-PnPException [-All [<SwitchParameter>]] -``` - -## DESCRIPTION -Returns the last exception which can be used while debugging PnP Cmdlets - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPException -``` - -Returns the last exception - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPException -All -``` - -Returns all exceptions that occurred - -## PARAMETERS - -### -All -Show all exceptions - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md deleted file mode 100644 index e5ab289ec5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPFeature - -## SYNOPSIS -Returns all activated or a specific activated feature - -## SYNTAX - -### -```powershell -Get-PnPFeature [-Includes <String[]>] - [-Identity <FeaturePipeBind>] - [-Scope <FeatureScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPFeature -``` - -This will return all activated web scoped features - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPFeature -Scope Site -``` - -This will return all activated site scoped features - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -``` - -This will return a specific activated web scoped feature - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -Scope Site -``` - -This will return a specific activated site scoped feature - -## PARAMETERS - -### -Identity -The feature ID or name to query for, Querying by name is not supported in version 15 of the Client Side Object Model - -```yaml -Type: FeaturePipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Scope -The scope of the feature. Defaults to Web. - -```yaml -Type: FeatureScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<Microsoft.SharePoint.Client.Feature> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md deleted file mode 100644 index 8c039f0e26..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPField - -## SYNOPSIS -Returns a field from a list or site - -## SYNTAX - -### -```powershell -Get-PnPField [-Includes <String[]>] - [-List <ListPipeBind>] - [-Identity <FieldPipeBind>] - [-Group <String>] - [-InSiteHierarchy [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPField -``` - -Gets all the fields from the current site - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPField -List "Demo list" -Identity "Speakers" -``` - -Gets the speakers field from the list Demo list - -## PARAMETERS - -### -Group -Filter to the specified group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The field object or name to get - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -InSiteHierarchy -Search site hierarchy for fields - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The list object or name where to get the field from - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Field - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md deleted file mode 100644 index fe3bde936d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPFile - -## SYNOPSIS -Downloads a file. - -## SYNTAX - -### Return as file object -```powershell -Get-PnPFile -Url <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Return as list item -```powershell -Get-PnPFile -Url <String> - [-AsListItem [<SwitchParameter>]] - [-ThrowExceptionIfFileNotFound [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Return as string -```powershell -Get-PnPFile -Url <String> - [-AsString [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Save to local path -```powershell -Get-PnPFile -Url <String> - -AsFile [<SwitchParameter>] - [-Path <String>] - [-Filename <String>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -``` - -Retrieves the file and downloads it to the current folder - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor -AsFile -``` - -Retrieves the file and downloads it to c:\temp\company.spcolor - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsString -``` - -Retrieves the file and outputs its contents to the console - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsFile -``` - -Retrieves the file and returns it as a File object - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsListItem -``` - -Retrieves the file and returns it as a ListItem object - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPFile -Url _catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor -AsFile -``` - -Retrieves the file by site relative URL and downloads it to c:\temp\company.spcolor - -## PARAMETERS - -### -AsFile - - -```yaml -Type: SwitchParameter -Parameter Sets: Save to local path - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -AsListItem -Returns the file as a listitem showing all its properties - -```yaml -Type: SwitchParameter -Parameter Sets: Return as list item - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AsString -Retrieve the file contents as a string - -```yaml -Type: SwitchParameter -Parameter Sets: Return as string - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Filename -Name for the local file - -```yaml -Type: String -Parameter Sets: Save to local path - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Overwrites the file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: Save to local path - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Local path where the file should be saved - -```yaml -Type: String -Parameter Sets: Save to local path - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ThrowExceptionIfFileNotFound -If provided in combination with -AsListItem, a Sytem.ArgumentException will be thrown if the file specified in the -Url argument does not exist. Otherwise it will return nothing instead. - -```yaml -Type: SwitchParameter -Parameter Sets: Return as list item - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -The URL (server or site relative) to the file - -```yaml -Type: String -Parameter Sets: Return as file object, Return as list item, Save to local path, Return as string -Aliases: ServerRelativeUrl,SiteRelativeUrl - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.File - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md deleted file mode 100644 index 593e988c44..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPFolder - -## SYNOPSIS -Return a folder object - -## SYNTAX - -### -```powershell -Get-PnPFolder -Url <String> - [-Includes <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Retrieves a folder if it exists. Use Ensure-PnPFolder to create the folder if it does not exist. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPFolder -Url "Shared Documents" -``` - -Returns the folder called 'Shared Documents' which is located in the root of the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPFolder -Url "/sites/demo/Shared Documents" -``` - -Returns the folder called 'Shared Documents' which is located in the root of the current web - -## PARAMETERS - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Url -Site or server relative URL of the folder to retrieve. In the case of a server relative url, make sure that the url starts with the managed path as the current web. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RelativeUrl - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Folder - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Ensure-PnPFolder](https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/EnsureSPOFolder.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md deleted file mode 100644 index 4a76cce458..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPFolderItem - -## SYNOPSIS -List content in folder - -## SYNTAX - -```powershell -Get-PnPFolderItem [-FolderSiteRelativeUrl <String>] - [-ItemType <String>] - [-ItemName <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -``` - -Returns the contents of the folder SitePages which is located in the root of the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemName "Default.aspx" -``` - -Returns the file 'Default.aspx' which is located in the folder SitePages which is located in the root of the current web - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType Folder -``` - -Returns all folders in the folder SitePages which is located in the root of the current web - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType File -``` - -Returns all files in the folder SitePages which is located in the root of the current web - -## PARAMETERS - -### -FolderSiteRelativeUrl -The site relative folder to retrieve - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -ItemName -Optional name of the item to retrieve - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ItemType -The type of contents to retrieve, either File, Folder or All (default) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md deleted file mode 100644 index 2ab5911d1e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPGroup - -## SYNOPSIS -Returns a specific SharePoint group or all SharePoint groups in site. - -## SYNTAX - -### ByName -```powershell -Get-PnPGroup [-Identity <GroupPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Members -```powershell -Get-PnPGroup [-AssociatedMemberGroup [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Visitors -```powershell -Get-PnPGroup [-AssociatedVisitorGroup [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Owners -```powershell -Get-PnPGroup [-AssociatedOwnerGroup [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### -```powershell -Get-PnPGroup [-Includes <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPGroup -``` - -Returns all SharePoint groups in a site - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPGroup -Identity 'My Site Users' -``` - -This will return the group called 'My Site Users' in if available in the current site - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPGroup -AssociatedMemberGroup -``` - -This will return the current members group for the site - -## PARAMETERS - -### -AssociatedMemberGroup -Retrieve the associated member group - -```yaml -Type: SwitchParameter -Parameter Sets: Members - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AssociatedOwnerGroup -Retrieve the associated owner group - -```yaml -Type: SwitchParameter -Parameter Sets: Owners - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AssociatedVisitorGroup -Retrieve the associated visitor group - -```yaml -Type: SwitchParameter -Parameter Sets: Visitors - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Get a specific group by name - -```yaml -Type: GroupPipeBind -Parameter Sets: ByName -Aliases: Name - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<Microsoft.SharePoint.Client.Group> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md deleted file mode 100644 index 4341770127..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPGroupMembers - -## SYNOPSIS -Retrieves all members of a group - -## SYNTAX - -```powershell -Get-PnPGroupMembers -Identity <GroupPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command will return all the users that are a member of the provided SharePoint Group - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPGroupMembers -Identity 'Marketing Site Members' -``` - -Returns all the users that are a member of the group 'Marketing Site Members' in the current sitecollection - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPGroup | Get-PnPGroupMembers -``` - -Returns all the users that are a member of any of the groups in the current sitecollection - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPGroup | ? Title -Like 'Marketing*' | Get-PnPGroupMembers -``` - -Returns all the users that are a member of any of the groups of which their name starts with the word 'Marketing' in the current sitecollection - -## PARAMETERS - -### -Identity -A group object, an ID or a name of a group - -```yaml -Type: GroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.User - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md deleted file mode 100644 index f9c523251f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPGroupPermissions - -## SYNOPSIS -Returns the permissions for a specific SharePoint group - -## SYNTAX - -### ByName -```powershell -Get-PnPGroupPermissions -Identity <GroupPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPGroupPermissions -Identity 'My Site Members' -``` - -Returns the permissions for the SharePoint group with the name 'My Site Members' - -## PARAMETERS - -### -Identity -Get the permissions of a specific group by name - -```yaml -Type: GroupPipeBind -Parameter Sets: ByName -Aliases: Name - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.RoleDefinitionBindingCollection - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md deleted file mode 100644 index 7589522277..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPHealthScore - -## SYNOPSIS -Retrieves the healthscore - -## DESCRIPTION -Retrieves the current health score value of the server which is a value between 0 and 10. Lower is better. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPHealthScore -``` - -This will retrieve the current health score of the server. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPHealthScore -Url https://contoso.sharepoint.com -``` - -This will retrieve the current health score for the url https://contoso.sharepoint.com. - -## OUTPUTS - -### System.Int32 - -Returns a int value representing the current health score value of the server. - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md deleted file mode 100644 index 88b25e6beb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPHideDefaultThemes - -## SYNOPSIS -Returns if the default / OOTB themes should be visible to users or not. - -## SYNTAX - -```powershell -Get-PnPHideDefaultThemes [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns if the default themes are visible. Use Set-PnPHideDefaultThemes to change this value. - -You must be a SharePoint Online global administrator to run the cmdlet. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPHideDefaultThemes -``` - -This example returns the current setting if the default themes should be visible - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md deleted file mode 100644 index 9e30b22b25..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPHomePage - -## SYNOPSIS -Return the homepage - -## SYNTAX - -```powershell -Get-PnPHomePage [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns the URL to the page set as home page - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPHomePage -``` - -Will return the URL of the home page of the web. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md deleted file mode 100644 index 27d708d7bb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPHubSite - -## SYNOPSIS -Retrieve all or a specific hubsite. - -## SYNTAX - -```powershell -Get-PnPHubSite [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPHubSite -``` - -Returns all hubsite properties - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPHubSite -Identity https://contoso.sharepoint.com/sites/myhubsite -``` - -Returns the properties of the specified hubsite - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md deleted file mode 100644 index 460bcf883c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPInPlaceRecordsManagement - -## SYNOPSIS -Returns if the place records management feature is enabled. - -## SYNTAX - -```powershell -Get-PnPInPlaceRecordsManagement [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPInPlaceRecordsManagement -``` - -Returns if $true if in place records management is active - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md deleted file mode 100644 index a77cc8c6b3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPIndexedPropertyKeys - -## SYNOPSIS -Returns the keys of the property bag values that have been marked for indexing by search - -## SYNTAX - -```powershell -Get-PnPIndexedPropertyKeys [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md deleted file mode 100644 index 664eb7191f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPJavaScriptLink - -## SYNOPSIS -Returns all or a specific custom action(s) with location type ScriptLink - -## SYNTAX - -```powershell -Get-PnPJavaScriptLink [-Name <String>] - [-Scope <CustomActionScope>] - [-ThrowExceptionIfJavaScriptLinkNotFound [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPJavaScriptLink -``` - -Returns all web scoped JavaScript links - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPJavaScriptLink -Scope All -``` - -Returns all web and site scoped JavaScript links - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPJavaScriptLink -Scope Web -``` - -Returns all Web scoped JavaScript links - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPJavaScriptLink -Scope Site -``` - -Returns all Site scoped JavaScript links - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPJavaScriptLink -Name Test -``` - -Returns the web scoped JavaScript link named Test - -## PARAMETERS - -### -Name -Name of the Javascript link. Omit this parameter to retrieve all script links - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Key - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Scope of the action, either Web, Site or All to return both, defaults to Web - -```yaml -Type: CustomActionScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ThrowExceptionIfJavaScriptLinkNotFound -Switch parameter if an exception should be thrown if the requested JavaScriptLink does not exist (true) or if omitted, nothing will be returned in case the JavaScriptLink does not exist - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.UserCustomAction - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md deleted file mode 100644 index 5ea0e41178..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPLabel - -## SYNOPSIS -Gets the label/tag of the specified list or library (if applicable) - -## SYNTAX - -```powershell -Get-PnPLabel -List <ListPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPLabel -List "Demo List" -``` - -This gets the label which is set to a list or a library. - -## PARAMETERS - -### -List -The ID or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md deleted file mode 100644 index 2da725ca7a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPList - -## SYNOPSIS -Returns a List object - -## SYNTAX - -### -```powershell -Get-PnPList [-Includes <String[]>] - [-Identity <ListPipeBind>] - [-ThrowExceptionIfListNotFound [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPList -``` - -Returns all lists in the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPList -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -Returns a list with the given id. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPList -Identity Lists/Announcements -``` - -Returns a list with the given url. - -## PARAMETERS - -### -Identity -The ID, name or Url (Lists/MyList) of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -ThrowExceptionIfListNotFound -Switch parameter if an exception should be thrown if the requested list does not exist (true) or if omitted, nothing will be returned in case the list does not exist - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.List - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md deleted file mode 100644 index c8af32b758..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPListInformationRightsManagement - -## SYNOPSIS -Get the site closure status of the site which has a site policy applied - -## SYNTAX - -```powershell -Get-PnPListInformationRightsManagement -List <ListPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPListInformationRightsManagement -List "Documents" -``` - -Returns Information Rights Management (IRM) settings for the list. See 'Get-Help Set-PnPListInformationRightsManagement -Detailed' for more information about the various values. - -## PARAMETERS - -### -List - - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md deleted file mode 100644 index b023fa1d65..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPListItem - -## SYNOPSIS -Retrieves list items - -## SYNTAX - -### By Id -```powershell -Get-PnPListItem -List <ListPipeBind> - [-Id <Int>] - [-Fields <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### By Unique Id -```powershell -Get-PnPListItem -List <ListPipeBind> - [-UniqueId <GuidPipeBind>] - [-Fields <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### By Query -```powershell -Get-PnPListItem -List <ListPipeBind> - [-Query <String>] - [-PageSize <Int>] - [-ScriptBlock <ScriptBlock>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### All Items -```powershell -Get-PnPListItem -List <ListPipeBind> - [-Fields <String[]>] - [-PageSize <Int>] - [-ScriptBlock <ScriptBlock>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPListItem -List Tasks -``` - -Retrieves all list items from the Tasks list - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPListItem -List Tasks -Id 1 -``` - -Retrieves the list item with ID 1 from from the Tasks list - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 -``` - -Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from from the tasks lists - -### ------------------EXAMPLE 4------------------ -```powershell -(Get-PnPListItem -List Tasks -Fields "Title","GUID").FieldValues -``` - -Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPListItem -List Tasks -Query "<View><Query><Where><Eq><FieldRef Name='GUID'/><Value Type='Guid'>bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</Value></Eq></Where></Query></View>" -``` - -Retrieves all list items based on the CAML query specified - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPListItem -List Tasks -PageSize 1000 -``` - -Retrieves all list items from the Tasks list in pages of 1000 items - -### ------------------EXAMPLE 7------------------ -```powershell -Get-PnPListItem -List Tasks -PageSize 1000 -ScriptBlock { Param($items) $items.Context.ExecuteQuery() } | % { $_.BreakRoleInheritance($true, $true) } -``` - -Retrieves all list items from the Tasks list in pages of 1000 items and breaks permission inheritance on each item - -## PARAMETERS - -### -Fields -The fields to retrieve. If not specified all fields will be loaded in the returned list object. - -```yaml -Type: String[] -Parameter Sets: All Items, By Id, By Unique Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Id -The ID of the item to retrieve - -```yaml -Type: Int -Parameter Sets: By Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The list to query - -```yaml -Type: ListPipeBind -Parameter Sets: __AllParameterSets - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -PageSize -The number of items to retrieve per page request. - -```yaml -Type: Int -Parameter Sets: All Items, By Query - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Query -The CAML query to execute against the list - -```yaml -Type: String -Parameter Sets: By Query - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ScriptBlock -The script block to run after every page request. - -```yaml -Type: ScriptBlock -Parameter Sets: All Items, By Query - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UniqueId -The unique id (GUID) of the item to retrieve - -```yaml -Type: GuidPipeBind -Parameter Sets: By Unique Id - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.ListItem - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md deleted file mode 100644 index d9ab69d027..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPListRecordDeclaration - -## SYNOPSIS -Returns the manual record declaration settings for a list - -## SYNTAX - -```powershell -Get-PnPListRecordDeclaration -List <ListPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPListRecordDeclaration -List "Documents" -``` - -Returns the record declaration setting for the list "Documents" - -## PARAMETERS - -### -List -The list to retrieve the record declaration settings for - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md deleted file mode 100644 index 1cf95e6917..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPMasterPage - -## SYNOPSIS -Returns the URLs of the default Master Page and the custom Master Page. - -## SYNTAX - -```powershell -Get-PnPMasterPage [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md deleted file mode 100644 index 187ed97ff6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPNavigationNode - -## SYNOPSIS -Returns all or a specific navigation node - -## SYNTAX - -### All nodes by location -```powershell -Get-PnPNavigationNode [-Location <NavigationType>] - [-Tree [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### A single node by ID -```powershell -Get-PnPNavigationNode [-Id <Int>] - [-Tree [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPNavigationNode -``` - -Returns all navigation nodes in the quicklaunch navigation - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPNavigationNode -QuickLaunch -``` - -Returns all navigation nodes in the quicklaunch navigation - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPNavigationNode -TopNavigationBar -``` - -Returns all navigation nodes in the top navigation bar - -### ------------------EXAMPLE 4------------------ -```powershell -$node = Get-PnPNavigationNode -Id 2030 -PS> $children = $node.Children -``` - -Returns the selected navigation node and retrieves any children - -## PARAMETERS - -### -Id -The Id of the node to retrieve - -```yaml -Type: Int -Parameter Sets: A single node by ID - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Location -The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch - -```yaml -Type: NavigationType -Parameter Sets: All nodes by location - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Tree -Show a tree view of all navigation nodes - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md deleted file mode 100644 index ad60cf4f39..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPPowerShellTelemetryEnabled - -## SYNOPSIS -Returns true if the PnP PowerShell Telemetry has been enabled. - -## SYNTAX - -```powershell -Get-PnPPowerShellTelemetryEnabled [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off, alternative, use the -NoTelemetry switch on Connect-PnPOnline to turn it off for that session. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPPowerShellTelemetryEnabled -``` - -Will return true of false. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md deleted file mode 100644 index 586f3f8d41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPProperty - -## SYNOPSIS -Returns a previously not loaded property of a ClientObject - -## SYNTAX - -```powershell -Get-PnPProperty -ClientObject <ClientObject> - -Property <String[]> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Will populate properties of an object and optionally, if needed, load the value from the server. If one property is specified its value will be returned to the output. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell - -$web = Get-PnPWeb -Get-PnPProperty -ClientObject $web -Property Id, Lists -$web.Lists -``` - -Will load both the Id and Lists properties of the specified Web object. - -### ------------------EXAMPLE 2------------------ -```powershell - -$list = Get-PnPList -Identity 'Site Assets' -Get-PnPProperty -ClientObject $list -Property Views -``` - -Will load the views object of the specified list object and return its value to the output. - -## PARAMETERS - -### -ClientObject -Specifies the object where the properties of should be retrieved - -```yaml -Type: ClientObject -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Property -The properties to load. If one property is specified its value will be returned to the output. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.ClientObject - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md deleted file mode 100644 index 23d97b80ab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPPropertyBag - -## SYNOPSIS -Returns the property bag values. - -## SYNTAX - -```powershell -Get-PnPPropertyBag [-Key <String>] - [-Folder <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPPropertyBag -``` - -This will return all web property bag values - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPPropertyBag -Key MyKey -``` - -This will return the value of the key MyKey from the web property bag - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPPropertyBag -Folder /MyFolder -``` - -This will return all property bag values for the folder MyFolder which is located in the root of the current web - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPPropertyBag -Folder /MyFolder -Key vti_mykey -``` - -This will return the value of the key vti_mykey from the folder MyFolder which is located in the root of the current web - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPPropertyBag -Folder / -Key vti_mykey -``` - -This will return the value of the key vti_mykey from the root folder of the current web - -## PARAMETERS - -### -Folder -Site relative url of the folder. See examples for use. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Key -Key that should be looked up - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### SharePointPnP.PowerShell.Commands.PropertyBagValue - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md deleted file mode 100644 index 94113f2c56..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md +++ /dev/null @@ -1,473 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPProvisioningTemplate - -## SYNOPSIS -Generates a provisioning site template from a web - -## SYNTAX - -```powershell -Get-PnPProvisioningTemplate [-Out <String>] - [-IncludeAllTermGroups [<SwitchParameter>]] - [-IncludeSiteCollectionTermGroup [<SwitchParameter>]] - [-IncludeSiteGroups [<SwitchParameter>]] - [-IncludeTermGroupsSecurity [<SwitchParameter>]] - [-IncludeSearchConfiguration [<SwitchParameter>]] - [-PersistBrandingFiles [<SwitchParameter>]] - [-PersistPublishingFiles [<SwitchParameter>]] - [-IncludeNativePublishingFiles [<SwitchParameter>]] - [-SkipVersionCheck [<SwitchParameter>]] - [-PersistMultiLanguageResources [<SwitchParameter>]] - [-ResourceFilePrefix <String>] - [-Handlers <Handlers>] - [-ExcludeHandlers <Handlers>] - [-ExtensibilityHandlers <ExtensibilityHandler[]>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-ContentTypeGroups <String[]>] - [-Force [<SwitchParameter>]] - [-Encoding <Encoding>] - [-TemplateDisplayName <String>] - [-TemplateImagePreviewUrl <String>] - [-TemplateProperties <Hashtable>] - [-OutputInstance [<SwitchParameter>]] - [-ExcludeContentTypesFromSyndication [<SwitchParameter>]] - [-Schema <XMLPnPSchemaVersion>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -``` - -Extracts a provisioning template in Office Open XML from the current web. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.xml -``` - -Extracts a provisioning template in XML format from the current web. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -Schema V201503 -``` - -Extracts a provisioning template in Office Open XML from the current web and saves it in the V201503 version of the schema. - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -IncludeAllTermGroups -``` - -Extracts a provisioning template in Office Open XML from the current web and includes all term groups, term sets and terms from the Managed Metadata Service Taxonomy. - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -IncludeSiteCollectionTermGroup -``` - -Extracts a provisioning template in Office Open XML from the current web and includes the term group currently (if set) assigned to the site collection. - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -PersistComposedLookFiles -``` - -Extracts a provisioning template in Office Open XML from the current web and saves the files that make up the composed look to the same folder as where the template is saved. - -### ------------------EXAMPLE 7------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -Handlers Lists, SiteSecurity -``` - -Extracts a provisioning template in Office Open XML from the current web, but only processes lists and site security when generating the template. - -### ------------------EXAMPLE 8------------------ -```powershell - -$handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 -$handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 -Get-PnPProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2 -``` - -This will create two new ExtensibilityHandler objects that are run during extraction of the template - -### ------------------EXAMPLE 9------------------ -Only supported on SP2016 and SP Online -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources -``` - -Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named after the value specified in the Out parameter. For instance if the Out parameter is specified as -Out 'template.xml' the generated resource file will be called 'template.en-US.resx'. - -### ------------------EXAMPLE 10------------------ -Only supported on SP2016 and SP Online -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources -ResourceFilePrefix MyResources -``` - -Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named 'MyResources.en-US.resx' etc. - -### ------------------EXAMPLE 11------------------ -```powershell -$template = Get-PnPProvisioningTemplate -OutputInstance -``` - -Extracts an instance of a provisioning template object from the current web. This syntax cannot be used together with the -Out parameter, but it can be used together with any other supported parameters. - -### ------------------EXAMPLE 12------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -ContentTypeGroups "Group A","Group B" -``` - -Extracts a provisioning template in Office Open XML from the current web, but only processes content types from the to given content type groups. - -### ------------------EXAMPLE 13------------------ -```powershell -Get-PnPProvisioningTemplate -Out template.pnp -ExcludeContentTypesFromSyndication -``` - -Extracts a provisioning template in Office Open XML from the current web, excluding content types provisioned through content type syndication (content type hub), in order to prevent provisioning errors if the target also provision the content type using syndication. - -## PARAMETERS - -### -ContentTypeGroups -Allows you to specify from which content type group(s) the content types should be included into the template. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Encoding -The encoding type of the XML file, Unicode is default - -```yaml -Type: Encoding -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExcludeContentTypesFromSyndication -Specify whether or not content types issued from a content hub should be exported. By default, these content types are included. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExcludeHandlers -Allows you to run all handlers, excluding the ones specified. - -```yaml -Type: Handlers -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExtensibilityHandlers -Allows you to specify ExtensbilityHandlers to execute while extracting a template. - -```yaml -Type: ExtensibilityHandler[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Handlers -Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting. - -```yaml -Type: Handlers -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeAllTermGroups -If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeNativePublishingFiles -If specified, out of the box / native publishing files will be saved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeSearchConfiguration -If specified the template will contain the current search configuration of the site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeSiteCollectionTermGroup -If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeSiteGroups -If specified all site groups will be included. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeTermGroupsSecurity -If specified all the managers and contributors of term groups will be included. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -OutputInstance -Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PersistBrandingFiles -If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PersistMultiLanguageResources -If specified, resource values for applicable artifacts will be persisted to a resource file - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PersistPublishingFiles -If specified the files used for the publishing feature will be saved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ResourceFilePrefix -If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.<language>.resx. See examples for more info. - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Schema -The schema of the output to use, defaults to the latest schema - -```yaml -Type: XMLPnPSchemaVersion -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -SkipVersionCheck -During extraction the version of the server will be checked for certain actions. If you specify this switch, this check will be skipped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateDisplayName -It can be used to specify the DisplayName of the template file that will be extracted. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateImagePreviewUrl -It can be used to specify the ImagePreviewUrl of the template file that will be extracted. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateProperties -It can be used to specify custom Properties for the template file that will be extracted. - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while extracting a template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplateFromGallery.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplateFromGallery.md deleted file mode 100644 index 497095bf43..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplateFromGallery.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPProvisioningTemplateFromGallery - -## SYNOPSIS -Retrieves or searches provisioning templates from the PnP Template Gallery - -## SYNTAX - -### Identity -```powershell -Get-PnPProvisioningTemplateFromGallery [-Identity <Guid>] - [-Path <String>] - [-Force [<SwitchParameter>]] -``` - -### Search -```powershell -Get-PnPProvisioningTemplateFromGallery [-Search <String>] - [-TargetPlatform <TargetPlatform>] - [-TargetScope <TargetScope>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPProvisioningTemplateFromGallery -``` - -Retrieves all templates from the gallery - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPProvisioningTemplateFromGallery -Search "Data" -``` - -Searches for a templates containing the word 'Data' in the Display Name - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPProvisioningTemplateFromGallery -Identity ae925674-8aa6-438b-acd0-d2699a022edd -``` - -Retrieves a template with the specified ID - -### ------------------EXAMPLE 4------------------ -```powershell -$template = Get-PnPProvisioningTemplateFromGallery -Identity ae925674-8aa6-438b-acd0-d2699a022edd -Apply-PnPProvisioningTemplate -InputInstance $template -``` - -Retrieves a template with the specified ID and applies it to the site. - -### ------------------EXAMPLE 5------------------ -```powershell -$template = Get-PnPProvisioningTemplateFromGallery -Identity ae925674-8aa6-438b-acd0-d2699a022edd -Path c:\temp -``` - -Retrieves a template with the specified ID and saves the template to the specified path - -## PARAMETERS - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: Identity - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity - - -```yaml -Type: Guid -Parameter Sets: Identity - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path - - -```yaml -Type: String -Parameter Sets: Identity - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Search - - -```yaml -Type: String -Parameter Sets: Search - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TargetPlatform - - -```yaml -Type: TargetPlatform -Parameter Sets: Search - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TargetScope - - -```yaml -Type: TargetScope -Parameter Sets: Search - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md deleted file mode 100644 index 57ea10412f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPPublishingImageRendition - -## SYNOPSIS -Returns all image renditions or if Identity is specified a specific one - -## SYNTAX - -```powershell -Get-PnPPublishingImageRendition [-Identity <ImageRenditionPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPPublishingImageRendition -``` - -Returns all Image Renditions - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPPublishingImageRendition -Identity "Test" -``` - -Returns the image rendition named "Test" - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPPublishingImageRendition -Identity 2 -``` - -Returns the image rendition where its id equals 2 - -## PARAMETERS - -### -Identity -Id or name of an existing image rendition - -```yaml -Type: ImageRenditionPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Publishing.ImageRendition - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md deleted file mode 100644 index 4f5554627e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPRecycleBinItem - -## SYNOPSIS -Returns the items in the recycle bin from the context - -## SYNTAX - -### Identity -```powershell -Get-PnPRecycleBinItem [-Identity <GuidPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### FirstStage -```powershell -Get-PnPRecycleBinItem [-FirstStage [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### SecondStage -```powershell -Get-PnPRecycleBinItem [-SecondStage [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### -```powershell -Get-PnPRecycleBinItem [-Includes <String[]>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPRecycleBinItem -``` - -Returns all items in both the first and the second stage recycle bins in the current site collection - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPRecycleBinItem -Identity f3ef6195-9400-4121-9d1c-c997fb5b86c2 -``` - -Returns all a specific recycle bin item by id - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPRecycleBinItem -FirstStage -``` - -Returns all items in only the first stage recycle bin in the current site collection - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPRecycleBinItem -SecondStage -``` - -Returns all items in only the second stage recycle bin in the current site collection - -## PARAMETERS - -### -FirstStage -Return all items in the first stage recycle bin - -```yaml -Type: SwitchParameter -Parameter Sets: FirstStage - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Returns a recycle bin item with a specific identity - -```yaml -Type: GuidPipeBind -Parameter Sets: Identity - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -SecondStage -Return all items in the second stage recycle bin - -```yaml -Type: SwitchParameter -Parameter Sets: SecondStage - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.RecycleBinItem - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md deleted file mode 100644 index 5b15bd3d1e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPRequestAccessEmails - -## SYNOPSIS -Returns the request access e-mail addresses - -## SYNTAX - -```powershell -Get-PnPRequestAccessEmails [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPRequestAccessEmails -``` - -This will return all the request access e-mail addresses for the current web - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<System.String> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md deleted file mode 100644 index 9c1071743f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPRoleDefinition - -## SYNOPSIS -Retrieves a Role Definitions of a site - -## SYNTAX - -```powershell -Get-PnPRoleDefinition [-Identity <RoleDefinitionPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPRoleDefinition -``` - -Retrieves the Role Definitions (Permission Levels) settings of the current site - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPRoleDefinition -Identity Read -``` - -Retrieves the specified Role Definition (Permission Level) settings of the current site - -## PARAMETERS - -### -Identity -The name of a role definition to retrieve. - -```yaml -Type: RoleDefinitionPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.RoleDefinition - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md deleted file mode 100644 index 14c3ab38dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSearchConfiguration - -## SYNOPSIS -Returns the search configuration - -## SYNTAX - -### Xml -```powershell -Get-PnPSearchConfiguration [-Path <String>] - [-Scope <SearchConfigurationScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### OutputFormat -```powershell -Get-PnPSearchConfiguration [-OutputFormat <OutputFormat>] - [-Scope <SearchConfigurationScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSearchConfiguration -``` - -Returns the search configuration for the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSearchConfiguration -Scope Site -``` - -Returns the search configuration for the current site collection - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSearchConfiguration -Scope Subscription -``` - -Returns the search configuration for the current tenant - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription -``` - -Returns the search configuration for the current tenant and saves it to the specified file - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPSearchConfiguration -Scope Site -OutputFormat ManagedPropertyMappings -``` - -Returns all custom managed properties and crawled property mapping at the current site collection - -## PARAMETERS - -### -OutputFormat -Output format for of the configuration. Defaults to complete XML - -```yaml -Type: OutputFormat -Parameter Sets: OutputFormat - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Local path where the search configuration will be saved - -```yaml -Type: String -Parameter Sets: Xml - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Scope -Scope to use. Either Web, Site, or Subscription. Defaults to Web - -```yaml -Type: SearchConfigurationScope -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -Does not return a string when the -Path parameter has been specified. - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md deleted file mode 100644 index 6f313a9c78..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSearchCrawlLog - -## SYNOPSIS -Returns entries from the SharePoint search crawl log - -## SYNTAX - -```powershell -Get-PnPSearchCrawlLog [-LogLevel <LogLevel>] - [-RowLimit <Int>] - [-Filter <String>] - [-ContentSource <ContentSource>] - [-StartDate <DateTime>] - [-EndDate <DateTime>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSearchCrawlLog -``` - -Returns the last 100 crawl log entries for site content. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSearchCrawlLog -Filter "https://<tenant>-my.sharepoint.com/personal" -``` - -Returns the last 100 crawl log entries for OneDrive content. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSearchCrawlLog -ContentSource UserProfiles -``` - -Returns the last 100 crawl log entries for user profiles. - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPSearchCrawlLog -ContentSource UserProfiles -Filter "mikael" -``` - -Returns the last 100 crawl log entries for user profiles with the term "mikael" in the user principal name. - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPSearchCrawlLog -ContentSource Sites LogLevel Error -RowLimit 10 -``` - -Returns the last 10 crawl log entries with a state of Error for site content. - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPSearchCrawlLog -EndDate (Get-Date).AddDays(-100) -``` - -Returns the last 100 crawl log entries for site content up until 100 days ago. - -## PARAMETERS - -### -ContentSource -Content to retrieve (Sites, User Profiles). Defaults to Sites. - -```yaml -Type: ContentSource -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EndDate -End date to stop getting entries from. Default to current time. - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Filter -Filter to limit what is being returned. Has to be a URL prefix for SharePoint content, and part of a user principal name for user profiles. Wildcard characters are not supported. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LogLevel -Filter what log entries to return (All, Success, Warning, Error). Defaults to All - -```yaml -Type: LogLevel -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RowLimit -Number of entries to return. Defaults to 100. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StartDate -Start date to start getting entries from. Defaults to start of time. - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md deleted file mode 100644 index 1de29bceea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSite - -## SYNOPSIS -Returns the current site collection from the context. - -## SYNTAX - -### -```powershell -Get-PnPSite [-Includes <String[]>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSite -``` - -Gets the current site - -## PARAMETERS - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Site - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md deleted file mode 100644 index bd7d0e0351..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteClassification - -## SYNOPSIS -Returns the defined Site Classifications for the tenant. Requires a connection to the Microsoft Graph. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Get-PnPSiteClassification -``` - -Returns the currently set site classifications for the tenant. - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md deleted file mode 100644 index 38d7d616cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteClosure - -## SYNOPSIS -Get the site closure status of the site which has a site policy applied - -## SYNTAX - -```powershell -Get-PnPSiteClosure [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteClosure -``` - -Get the site closure status of the site. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md deleted file mode 100644 index 62c852f098..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteCollectionAdmin - -## SYNOPSIS -Returns the current site collection administrators of the site collection in the current context - -## SYNTAX - -```powershell -Get-PnPSiteCollectionAdmin [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command will return all current site collection administrators of the site collection in the current context - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteCollectionAdmin -``` - -This will return all the current site collection administrators of the site collection in the current context - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md deleted file mode 100644 index 76af2e5a51..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteCollectionTermStore - -## SYNOPSIS -Returns the site collection term store - -## SYNTAX - -```powershell -Get-PnPSiteCollectionTermStore [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteCollectionTermStore -``` - -Returns the site collection term store. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TermStore - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md deleted file mode 100644 index a2f6eec85b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteDesign - -## SYNOPSIS -Retrieve Site Designs that have been registered on the current tenant. - -## SYNTAX - -```powershell -Get-PnPSiteDesign [-Identity <TenantSiteDesignPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteDesign -``` - -Returns all registered site designs - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -``` - -Returns a specific registered site designs - -## PARAMETERS - -### -Identity -If specified will retrieve the specified site design - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md deleted file mode 100644 index 8666372b63..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteDesignRights - -## SYNOPSIS -Returns the principals with design rights on a specific Site Design - -## SYNTAX - -```powershell -Get-PnPSiteDesignRights -Identity <TenantSiteDesignPipeBind> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -``` - -Returns the principals with rights on a specific site design - -## PARAMETERS - -### -Identity -The ID of the Site Design to receive the rights for - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md deleted file mode 100644 index cf48313f66..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSitePolicy - -## SYNOPSIS -Retrieves all or a specific site policy - -## SYNTAX - -```powershell -Get-PnPSitePolicy [-AllAvailable [<SwitchParameter>]] - [-Name <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSitePolicy -``` - -Retrieves the current applied site policy. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSitePolicy -AllAvailable -``` - -Retrieves all available site policies. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSitePolicy -Name "Contoso HBI" -``` - -Retrieves an available site policy with the name "Contoso HBI". - -## PARAMETERS - -### -AllAvailable -Retrieve all available site policies - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -Retrieves a site policy with a specific name - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Entities.SitePolicyEntity - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md deleted file mode 100644 index 2629a13fa6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteScript - -## SYNOPSIS -Retrieve Site Scripts that have been registered on the current tenant. - -## SYNTAX - -```powershell -Get-PnPSiteScript [-Identity <TenantSiteScriptPipeBind>] - [-SiteDesign <TenantSiteDesignPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteScript -``` - -Returns all registered site scripts - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -``` - -Returns a specific registered site script - -## PARAMETERS - -### -Identity -If specified will retrieve the specified site script - -```yaml -Type: TenantSiteScriptPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -SiteDesign -If specified will retrieve the site scripts for this design - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md deleted file mode 100644 index 6a25cd1ef1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSiteSearchQueryResults - -## SYNOPSIS -Executes a search query to retrieve indexed site collections - -## SYNTAX - -### Limit -```powershell -Get-PnPSiteSearchQueryResults [-StartRow <Int>] - [-MaxResults <Int>] - [-Query <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### All -```powershell -Get-PnPSiteSearchQueryResults [-All [<SwitchParameter>]] - [-Query <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSiteSearchQueryResults -``` - -Returns the top 500 site collections indexed by SharePoint Search - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSiteSearchQueryResults -Query "WebTemplate:STS" -``` - -Returns the top 500 site collections indexed by SharePoint Search which have are based on the STS (Team Site) template - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSiteSearchQueryResults -Query "WebTemplate:SPSPERS" -``` - -Returns the top 500 site collections indexed by SharePoint Search which have are based on the SPSPERS (MySite) template, up to the MaxResult limit - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPSiteSearchQueryResults -Query "Title:Intranet*" -``` - -Returns the top 500 site collections indexed by SharePoint Search of which the title starts with the word Intranet - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPSiteSearchQueryResults -MaxResults 10 -``` - -Returns the top 10 site collections indexed by SharePoint Search - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPSiteSearchQueryResults -All -``` - -Returns absolutely all site collections indexed by SharePoint Search - -## PARAMETERS - -### -All -Automatically page results until the end to get more than 500 sites. Use with caution! - -```yaml -Type: SwitchParameter -Parameter Sets: All - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MaxResults -Maximum amount of search results to return. Default and max is 500 search results. - -```yaml -Type: Int -Parameter Sets: Limit - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Query -Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -StartRow -Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results. - -```yaml -Type: Int -Parameter Sets: Limit - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<System.Object> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md deleted file mode 100644 index 09a1d29a0f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPStorageEntity - -## SYNOPSIS -Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog. - -## SYNTAX - -```powershell -Get-PnPStorageEntity [-Key <String>] - [-Scope <StorageEntityScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPStorageEntity -``` - -Returns all site storage entities/farm properties - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPStorageEntity -Key MyKey -``` - -Returns the storage entity/farm property with the given key. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPStorageEntity -Scope Site -``` - -Returns all site collection scoped storage entities - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPStorageEntity -Key MyKey -Scope Site -``` - -Returns the storage entity from the site collection with the given key - -## PARAMETERS - -### -Key -The key of the value to retrieve. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Scope -Defines the scope of the storage entity. Defaults to Tenant. - -```yaml -Type: StorageEntityScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md deleted file mode 100644 index af73262162..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPStoredCredential - -## SYNOPSIS -Get a credential - -## SYNTAX - -```powershell -Get-PnPStoredCredential -Name <String> - [-Type <CredentialType>] -``` - -## DESCRIPTION -Returns a stored credential from the Windows Credential Manager - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPStoredCredential -Name O365 -``` - -Returns the credential associated with the specified identifier - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPStoredCredential -Name testEnvironment -Type OnPrem -``` - -Gets the credential associated with the specified identifier from the credential manager and then will return a credential that can be used for on-premises authentication - -## PARAMETERS - -### -Name -The credential to retrieve. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Type -The object type of the credential to return from the Credential Manager. Possible valus are 'O365', 'OnPrem' or 'PSCredential' - -```yaml -Type: CredentialType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md deleted file mode 100644 index a156590941..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPSubWebs - -## SYNOPSIS -Returns the subwebs of the current web - -## SYNTAX - -### -```powershell -Get-PnPSubWebs [-Includes <String[]>] - [-Identity <WebPipeBind>] - [-Recurse [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPSubWebs -``` - -Retrieves all subsites of the current context returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSubWebs -Recurse -``` - -Retrieves all subsites of the current context and all of their nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSubWebs -Recurse -Includes "WebTemplate","Description" | Select ServerRelativeUrl, WebTemplate, Description -``` - -Retrieves all subsites of the current context and shows the ServerRelativeUrl, WebTemplate and Description properties in the resulting output - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPSubWebs -Identity Team1 -Recurse -``` - -Retrieves all subsites of the subsite Team1 and all of its nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output - -## PARAMETERS - -### -Identity -If provided, only the subsite with the provided Id, GUID or the Web instance will be returned - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Recurse -If provided, recursion through all subsites and their childs will take place to return them as well - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Web - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md deleted file mode 100644 index abf0e0e20c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTaxonomyItem - -## SYNOPSIS -Returns a taxonomy item - -## SYNTAX - -```powershell -Get-PnPTaxonomyItem -TermPath <String> - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -TermPath -The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Term - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TaxonomyItem - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md deleted file mode 100644 index 9e1e44fcb2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTaxonomySession - -## SYNOPSIS -Returns a taxonomy session - -## SYNTAX - -```powershell -Get-PnPTaxonomySession [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TaxonomySession - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md deleted file mode 100644 index 07d514dd72..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenant - -## SYNOPSIS -Returns organization-level site collection properties - -## SYNTAX - -```powershell -Get-PnPTenant [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, -ResourceQuotaAllocated, and SiteCreationMode. - -Currently, there are no parameters for this cmdlet. - -You must be a SharePoint Online global administrator to run the cmdlet. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenant -``` - -This example returns all tenant settings - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md deleted file mode 100644 index 701c1e2d70..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantAppCatalogUrl - -## SYNOPSIS -Retrieves the url of the tenant scoped app catalog. - -## SYNTAX - -```powershell -Get-PnPTenantAppCatalogUrl [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantAppCatalogUrl -``` - -Returns the url of the tenant scoped app catalog site collection - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md deleted file mode 100644 index c5d379030b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantCdnEnabled - -## SYNOPSIS -Retrieves if the Office 365 Content Delivery Network has been enabled. - -## SYNTAX - -```powershell -Get-PnPTenantCdnEnabled -CdnType <SPOTenantCdnType> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Enables or disabled the public or private Office 365 Content Delivery Network (CDN). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantCdnEnabled -CdnType Public -``` - -Returns the enabled status of the specified CDN - -## PARAMETERS - -### -CdnType -The type of cdn to retrieve the origins from - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md deleted file mode 100644 index 9bb4c6bb4f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantCdnOrigin - -## SYNOPSIS -Returns the current registered origins from the public or private content delivery network (CDN). - -## SYNTAX - -```powershell -Get-PnPTenantCdnOrigin -CdnType <SPOTenantCdnType> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns the current registered origins from the public or private content delivery network (CDN). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantCdnOrigin -CdnType Public -``` - -Returns the configured CDN origins for the specified CDN type - -## PARAMETERS - -### -CdnType -The type of cdn to retrieve the origins from - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md deleted file mode 100644 index 3650f5c101..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantCdnPolicies - -## SYNOPSIS -Returns the CDN Policies for the specified CDN (Public | Private). - -## SYNTAX - -```powershell -Get-PnPTenantCdnPolicies -CdnType <SPOTenantCdnType> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Enables or disabled the public or private Office 365 Content Delivery Network (CDN). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantCdnPolicies -CdnType Public -``` - -Returns the policies for the specified CDN type - -## PARAMETERS - -### -CdnType -The type of cdn to retrieve the policies from - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md deleted file mode 100644 index 6d98bd9a0e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantRecycleBinItem - -## SYNOPSIS -Returns all modern and classic site collections in the tenant scoped recycle bin - -## SYNTAX - -```powershell -Get-PnPTenantRecycleBinItem [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command will return all the items in the tenant recycle bin for the Office 365 tenant you are connected to. Be sure to connect to the SharePoint Online Admin endpoint (https://yourtenantname-admin.sharepoint.com) in order for this command to work. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantRecycleBinItem -``` - -Returns all modern and classic site collections in the tenant scoped recycle bin - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.Online.SharePoint.TenantAdministration.DeletedSiteProperties - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md deleted file mode 100644 index 57c22311e5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantSequence - -## SYNOPSIS -Returns one ore more provisioning sequence object(s) from a tenant template - -## SYNTAX - -```powershell -Get-PnPTenantSequence -Template <ProvisioningHierarchy> - [-Identity <ProvisioningSequencePipeBind>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantSequence -Template $myhierarchy -``` - -Returns all sequences from the specified tenant template - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTenantSequence -Template $myhierarchy -Identity "mysequence" -``` - -Returns the specified sequence from the specified tenant template - -## PARAMETERS - -### -Identity -Optional Id of the sequence - -Only applicable to: SharePoint Online - -```yaml -Type: ProvisioningSequencePipeBind -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Template -The hierarchy to retrieve the sequence from - -Only applicable to: SharePoint Online - -```yaml -Type: ProvisioningHierarchy -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md deleted file mode 100644 index f054359fa4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantSequenceSite - -## SYNOPSIS -Returns one ore more sites from a tenant template - -## SYNTAX - -```powershell -Get-PnPTenantSequenceSite -Sequence <ProvisioningSequence> - [-Identity <ProvisioningSitePipeBind>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantSequenceSite -Sequence $mysequence -``` - -Returns all sites from the specified sequence - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTenantSequenceSite -Sequence $mysequence -Identity 8058ea99-af7b-4bb7-b12a-78f93398041e -``` - -Returns the specified site from the specified sequence - -## PARAMETERS - -### -Identity -Optional Id of the site - -Only applicable to: SharePoint Online - -```yaml -Type: ProvisioningSitePipeBind -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Sequence -The sequence to retrieve the site from - -Only applicable to: SharePoint Online - -```yaml -Type: ProvisioningSequence -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md deleted file mode 100644 index b733c87c97..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantServicePrincipal - -## SYNOPSIS -Returns the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Get-PnPTenantServicePrincipal [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns the current tenant's "SharePoint Online Client" service principal. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md deleted file mode 100644 index 4cca22168d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantServicePrincipalPermissionGrants - -## SYNOPSIS -Gets the collection of permission grants for the "SharePoint Online Client" service principal - -## SYNTAX - -```powershell -Get-PnPTenantServicePrincipalPermissionGrants [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Gets the collection of permission grants for the "SharePoint Online Client" service principal. - -A permission grant contains the following properties: - -* ClientId: The objectId of the service principal granted consent to impersonate the user when accessing the resource(represented by the resourceId). -* ConsentType: Whether consent was provided by the administrator on behalf of the organization or whether consent was provided by an individual.The possible values are "AllPrincipals" or "Principal". -* ObjectId: The unique identifier for the permission grant. -* Resource: The resource to which access has been granted (Coming soon) -* ResourceId: The objectId of the resource service principal to which access has been granted. -* Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. - - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md deleted file mode 100644 index 56ab7651fc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantServicePrincipalPermissionRequests - -## SYNOPSIS -Gets the collection of permission requests for the "SharePoint Online Client" service principal - -## SYNTAX - -```powershell -Get-PnPTenantServicePrincipalPermissionRequests [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Gets the collection of permission requests for the "SharePoint Online Client" service principal. - -Permission request object - -A permission request contains the following properties: - -* Id: The identifier of the request. -* Resource: The resource that the application requires access to. -* Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. - - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md deleted file mode 100644 index f94d5aab3e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantSite - -## SYNOPSIS -Retrieve site information. - -## SYNTAX - -```powershell -Get-PnPTenantSite [-Url <String>] - [-Template <String>] - [-Detailed [<SwitchParameter>]] - [-IncludeOneDriveSites [<SwitchParameter>]] - [-Filter <String>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Use this cmdlet to retrieve site information from your tenant administration. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantSite -``` - -Returns all site collections - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTenantSite -Url http://tenant.sharepoint.com/sites/projects -``` - -Returns information about the project site - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPTenantSite -Detailed -``` - -Returns all sites with the full details of these sites - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPTenantSite -IncludeOneDriveSites -``` - -Returns all sites including all OneDrive for Business sites - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPTenantSite -IncludeOneDriveSites -Filter "Url -like '-my.sharepoint.com/personal/'" -``` - -Returns all OneDrive for Business sites - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPTenantSite -Template SITEPAGEPUBLISHING#0 -``` - -Returns all Communication sites - -### ------------------EXAMPLE 7------------------ -```powershell -Get-PnPTenantSite -Filter "Url -like 'sales'" -``` - -Returns all sites including 'sales' in the url - -## PARAMETERS - -### -Detailed -By default, not all returned attributes are populated. This switch populates all attributes. It can take several seconds to run. Without this, some attributes will show default values that may not be correct. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Filter -Specifies the script block of the server-side filter to apply. See https://technet.microsoft.com/en-us/library/fp161380.aspx - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeOneDriveSites -By default, the OneDrives are not returned. This switch includes all OneDrives. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Template -By default, all sites will be returned. Specify a template value alike "STS#0" here to filter on the template - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -The URL of the site - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Identity - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.Online.SharePoint.TenantAdministration.SiteProperties - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md deleted file mode 100644 index 36b8e745c2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTenantTheme - -## SYNOPSIS -Returns all or a specific theme - -## SYNTAX - -```powershell -Get-PnPTenantTheme [-Name <String>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns all or a specific tenant theme. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTenantTheme -``` - -Returns all themes - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTenantTheme -Name "MyCompanyTheme" -``` - -Returns the specified theme - -## PARAMETERS - -### -Name -The name of the theme to retrieve - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md deleted file mode 100644 index 1bc833d5d5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTerm - -## SYNOPSIS -Returns a taxonomy term - -## SYNTAX - -### -```powershell -Get-PnPTerm [-Includes <String[]>] - [-IncludeChildTerms [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### By Term Id -```powershell -Get-PnPTerm -Identity <Id, Name or Object> - [-TermStore <Id, Name or Object>] - [-IncludeChildTerms [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### By Termset -```powershell -Get-PnPTerm -TermSet <Id, Title or TaxonomyItem> - -TermGroup <Id, Title or TermGroup> - [-Identity <Id, Name or Object>] - [-TermStore <Id, Name or Object>] - [-Recursive [<SwitchParameter>]] - [-IncludeChildTerms [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -``` - -Returns all term in the termset "Departments" which is in the group "Corporate" from the site collection termstore - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTerm -Identity "Finance" -TermSet "Departments" -TermGroup "Corporate" -``` - -Returns the term named "Finance" in the termset "Departments" from the termgroup called "Corporate" from the site collection termstore - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPTerm -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -TermSet "Departments" -TermGroup "Corporate" -``` - -Returns the term named with the given id, from the "Departments" termset in a term group called "Corporate" from the site collection termstore - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPTerm -Identity "Small Finance" -TermSet "Departments" -TermGroup "Corporate" -Recursive -``` - -Returns the term named "Small Finance", from the "Departments" termset in a term group called "Corporate" from the site collection termstore even if it's a subterm below "Finance" - -## PARAMETERS - -### -Identity -The Id or Name of a Term - -```yaml -Type: Id, Name or Object -Parameter Sets: By Term Id, By Termset - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -IncludeChildTerms -Includes the hierarchy of child terms if available - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Recursive -Find the first term recursivly matching the label in a term hierarchy. - -```yaml -Type: SwitchParameter -Parameter Sets: By Termset - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermGroup -Name of the termgroup to check. - -```yaml -Type: Id, Title or TermGroup -Parameter Sets: By Termset - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TermSet -Name of the termset to check. - -```yaml -Type: Id, Title or TaxonomyItem -Parameter Sets: By Termset - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TermStore -Term store to check; if not specified the default term store is used. - -```yaml -Type: Id, Name or Object -Parameter Sets: By Term Id, By Termset - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.Term - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md deleted file mode 100644 index b2b9d1f380..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTermGroup - -## SYNOPSIS -Returns a taxonomy term group - -## SYNTAX - -### -```powershell -Get-PnPTermGroup [-Includes <String[]>] - [-Identity <Id, Title or TaxonomyItem>] - [-TermStore <Id, Name or Object>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTermGroup -``` - -Returns all Term Groups in the site collection termstore - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTermGroup -Identity "Departments" -``` - -Returns the termgroup named "Departments" from the site collection termstore - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPTermGroup -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -``` - -Returns the termgroup with the given ID from the site collection termstore - -## PARAMETERS - -### -Identity -Name of the taxonomy term group to retrieve. - -```yaml -Type: Id, Title or TaxonomyItem -Parameter Sets: (All) -Aliases: GroupName - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -TermStore -Term store to check; if not specified the default term store is used. - -```yaml -Type: Id, Name or Object -Parameter Sets: (All) -Aliases: TermStoreName - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TermGroup - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md deleted file mode 100644 index 1d68f729ff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTermSet - -## SYNOPSIS -Returns a taxonomy term set - -## SYNTAX - -### -```powershell -Get-PnPTermSet -TermGroup <Id, Title or TermGroup> - [-Includes <String[]>] - [-Identity <Id, Name or Object>] - [-TermStore <Id, Name or Object>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTermSet -TermGroup "Corporate" -``` - -Returns all termsets in the group "Corporate" from the site collection termstore - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTermSet -Identity "Departments" -TermGroup "Corporate" -``` - -Returns the termset named "Departments" from the termgroup called "Corporate" from the site collection termstore - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPTermSet -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -TermGroup "Corporate -``` - -Returns the termset with the given id from the termgroup called "Corporate" from the site collection termstore - -## PARAMETERS - -### -Identity -The Id or Name of a termset - -```yaml -Type: Id, Name or Object -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -TermGroup -Name of the term group to check. - -```yaml -Type: Id, Title or TermGroup -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TermStore -Term store to check; if not specified the default term store is used. - -```yaml -Type: Id, Name or Object -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TermSet - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md deleted file mode 100644 index aacaa7ce0b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTheme - -## SYNOPSIS -Returns the current theme/composed look of the current web. - -## SYNTAX - -```powershell -Get-PnPTheme [-DetectCurrentComposedLook [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTheme -``` - -Returns the current composed look of the current web. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTheme -DetectCurrentComposedLook -``` - -Returns the current composed look of the current web, and will try to detect the currently applied composed look based upon the actual site. Without this switch the cmdlet will first check for the presence of a property bag variable called _PnP_ProvisioningTemplateComposedLookInfo that contains composed look information when applied through the provisioning engine or the Set-PnPTheme cmdlet. - -## PARAMETERS - -### -DetectCurrentComposedLook -Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Entities.ThemeEntity - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md deleted file mode 100644 index c70961dcd3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPTimeZoneId - -## SYNOPSIS -Returns a time zone ID - -## SYNTAX - -```powershell -Get-PnPTimeZoneId [-Match <String>] -``` - -## DESCRIPTION -In order to create a new classic site you need to specify the timezone this site will use. Use the cmdlet to retrieve a list of possible values. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPTimeZoneId -``` - -This will return all time zone IDs in use by Office 365. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTimeZoneId -Match Stockholm -``` - -This will return the time zone IDs for Stockholm - -## PARAMETERS - -### -Match -A string to search for like 'Stockholm' - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -## OUTPUTS - -### List<SharePointPnP.PowerShell.Commands.GetTimeZoneId+Zone> - -Returns a list of matching zones. Use the ID property of the object for use in New-SPOTenantSite - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md deleted file mode 100644 index 65436784ad..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPUPABulkImportStatus - -## SYNOPSIS -Get user profile bulk import status. - -## SYNTAX - -```powershell -Get-PnPUPABulkImportStatus [-JobId <GuidPipeBind>] - [-IncludeErrorDetails [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Retreieve information about the status of submitted user profile bulk upload jobs. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPUPABulkImportStatus -``` - -This will list the status of all submitted user profile bulk import jobs. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPUPABulkImportStatus -IncludeErrorDetails -``` - -This will list the status of all submitted user profile bulk import jobs, and if it contains an error it will include the error log messages if present. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPUPABulkImportStatus -JobId <guid> -``` - -This will list the status for the specified import job. - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPUPABulkImportStatus -JobId <guid> -IncludeErrorDetails -``` - -This will list the status for the specified import job, and if it contains an error it will include the error log messages if present. - -## PARAMETERS - -### -IncludeErrorDetails -Include error log details - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -JobId -The instance id of the job - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md deleted file mode 100644 index 5449cd9054..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPUnifiedGroup - -## SYNOPSIS -Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups - -## SYNTAX - -```powershell -Get-PnPUnifiedGroup [-Identity <UnifiedGroupPipeBind>] - [-ExcludeSiteUrl [<SwitchParameter>]] - [-IncludeClassification [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPUnifiedGroup -``` - -Retrieves all the Office 365 Groups - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPUnifiedGroup -Identity $groupId -``` - -Retrieves a specific Office 365 Group based on its ID - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPUnifiedGroup -Identity $groupDisplayName -``` - -Retrieves a specific or list of Office 365 Groups that start with the given DisplayName - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPUnifiedGroup -Identity $groupSiteMailNickName -``` - -Retrieves a specific or list of Office 365 Groups for which the email starts with the provided mail nickName - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPUnifiedGroup -Identity $group -``` - -Retrieves a specific Office 365 Group based on its object instance - -## PARAMETERS - -### -ExcludeSiteUrl -Exclude fetching the site URL for Office 365 Groups. This speeds up large listings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The Identity of the Office 365 Group. - -```yaml -Type: UnifiedGroupPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IncludeClassification -Include Classification value of Office 365 Groups. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md deleted file mode 100644 index 7550a86d38..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPUnifiedGroupMembers - -## SYNOPSIS -Gets members of a particular Office 365 Group (aka Unified Group) - -## SYNTAX - -```powershell -Get-PnPUnifiedGroupMembers -Identity <UnifiedGroupPipeBind> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPUnifiedGroupMembers -Identity $groupId -``` - -Retrieves all the members of a specific Office 365 Group based on its ID - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPUnifiedGroupMembers -Identity $group -``` - -Retrieves all the members of a specific Office 365 Group based on the group's object instance - -## PARAMETERS - -### -Identity -The Identity of the Office 365 Group. - -```yaml -Type: UnifiedGroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md deleted file mode 100644 index b793465861..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPUnifiedGroupOwners - -## SYNOPSIS -Gets owners of a particular Office 365 Group (aka Unified Group) - -## SYNTAX - -```powershell -Get-PnPUnifiedGroupOwners -Identity <UnifiedGroupPipeBind> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPUnifiedGroupOwners -Identity $groupId -``` - -Retrieves all the owners of a specific Office 365 Group based on its ID - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPUnifiedGroupOwners -Identity $group -``` - -Retrieves all the owners of a specific Office 365 Group based on the group's object instance - -## PARAMETERS - -### -Identity -The Identity of the Office 365 Group. - -```yaml -Type: UnifiedGroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md deleted file mode 100644 index 21e3aa8aea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPUser - -## SYNOPSIS -Returns site users of current web - -## SYNTAX - -```powershell -Get-PnPUser [-Identity <UserPipeBind>] - [-WithRightsAssigned [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command will return all the users that exist in the current site collection its User Information List - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPUser -``` - -Returns all users from the User Information List of the current site collection regardless if they currently have rights to access the current site - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPUser -Identity 23 -``` - -Returns the user with Id 23 from the User Information List of the current site collection - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -``` - -Returns the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPUser | ? Email -eq "user@tenant.onmicrosoft.com" -``` - -Returns the user with e-mail address user@tenant.onmicrosoft.com from the User Information List of the current site collection - -### ------------------EXAMPLE 5------------------ -```powershell -Get-PnPUser -WithRightsAssigned -``` - -Returns only those users from the User Information List of the current site collection who currently have any kind of access rights given either directly to the user or Active Directory Group or given to the user or Active Directory Group via membership of a SharePoint Group to the current site - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPUser -WithRightsAssigned -Web subsite1 -``` - -Returns only those users from the User Information List of the current site collection who currently have any kind of access rights given either directly to the user or Active Directory Group or given to the user or Active Directory Group via membership of a SharePoint Group to subsite 'subsite1' - -## PARAMETERS - -### -Identity -User ID or login name - -```yaml -Type: UserPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -WithRightsAssigned -If provided, only users that currently have any kinds of access rights assigned to the current site collection will be returned. Otherwise all users, even those who previously had rights assigned, but not anymore at the moment, will be returned as the information is pulled from the User Information List. Only works if you don't provide an -Identity. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.User - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md deleted file mode 100644 index d03e13289d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPUserProfileProperty - -## SYNOPSIS -You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. - - -## SYNTAX - -```powershell -Get-PnPUserProfileProperty -Account <String[]> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Requires a connection to a SharePoint Tenant Admin site. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPUserProfileProperty -Account 'user@domain.com' -``` - -Returns the profile properties for the specified user - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPUserProfileProperty -Account 'user@domain.com','user2@domain.com' -``` - -Returns the profile properties for the specified users - -## PARAMETERS - -### -Account -The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.UserProfiles.PersonProperties - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md deleted file mode 100644 index 0ba8fcd051..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPView - -## SYNOPSIS -Returns one or all views from a list - -## SYNTAX - -### -```powershell -Get-PnPView -List <ListPipeBind> - [-Includes <String[]>] - [-Identity <ViewPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPView -List "Demo List" -``` - -Returns all views associated from the specified list - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPView -List "Demo List" -Identity "Demo View" -``` - -Returns the view called "Demo View" from the specified list - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPView -List "Demo List" -Identity "5275148a-6c6c-43d8-999a-d2186989a661" -``` - -Returns the view with the specified ID from the specified list - -## PARAMETERS - -### -Identity -The ID or name of the view - -```yaml -Type: ViewPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -List -The ID or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.View - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md deleted file mode 100644 index 8b71695619..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWeb - -## SYNOPSIS -Returns the current web object - -## SYNTAX - -### -```powershell -Get-PnPWeb [-Includes <String[]>] - [-Identity <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWeb -``` - -This will return the current web - -## PARAMETERS - -### -Identity -The guid of the web or web object - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Web - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md deleted file mode 100644 index 93131fae0a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWebPart - -## SYNOPSIS -Returns a webpart definition object - -## SYNTAX - -```powershell -Get-PnPWebPart -ServerRelativePageUrl <String> - [-Identity <WebPartPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -``` - -Returns all webparts defined on the given page. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 -``` - -Returns a specific webpart defined on the given page. - -## PARAMETERS - -### -Identity -The identity of the webpart, this can be the webpart guid or an webpart object - -```yaml -Type: WebPartPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -ServerRelativePageUrl -Full server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<Microsoft.SharePoint.Client.WebParts.WebPartDefinition> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md deleted file mode 100644 index a5464d6dcc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWebPartProperty - -## SYNOPSIS -Returns a web part property - -## SYNTAX - -```powershell -Get-PnPWebPartProperty -ServerRelativePageUrl <String> - -Identity <GuidPipeBind> - [-Key <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -``` - -Returns all properties of the webpart. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -``` - -Returns the title property of the webpart. - -## PARAMETERS - -### -Identity -The id of the webpart - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Key -Name of a single property to be returned - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Full server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md deleted file mode 100644 index e8746de6a3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWebPartXml - -## SYNOPSIS -Returns the webpart XML of a webpart registered on a site - -## SYNTAX - -```powershell -Get-PnPWebPartXml -ServerRelativePageUrl <String> - -Identity <WebPartPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWebPartXml -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 -``` - -Returns the webpart XML for a given webpart on a page. - -## PARAMETERS - -### -Identity -Id or title of the webpart. Use Get-PnPWebPart to retrieve all webpart Ids - -```yaml -Type: WebPartPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md deleted file mode 100644 index b6b6435c08..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWebTemplates - -## SYNOPSIS -Returns the available web templates. - -## SYNTAX - -```powershell -Get-PnPWebTemplates [-Lcid <UInt32>] - [-CompatibilityLevel <Int>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Will list all available templates one can use to create a classic site. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWebTemplates -``` - - - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWebTemplates -LCID 1033 -``` - -Returns all webtemplates for the Locale with ID 1033 (English) - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPWebTemplates -CompatibilityLevel 15 -``` - -Returns all webtemplates for the compatibility level 15 - -## PARAMETERS - -### -CompatibilityLevel -The version of SharePoint - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Lcid -The language ID. For instance: 1033 for English - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplateCollection - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Locale IDs](http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md deleted file mode 100644 index 7b230522b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWebhookSubscriptions - -## SYNOPSIS -Gets all the Webhook subscriptions of the resource - -## SYNTAX - -```powershell -Get-PnPWebhookSubscriptions [-List <ListPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWebhookSubscriptions -List MyList -``` - -Gets all Webhook subscriptions of the list MyList - -## PARAMETERS - -### -List -The list object or name to get the Webhook subscriptions from - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Entities.WebhookSubscription - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md deleted file mode 100644 index e222afc1af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWikiPageContent - -## SYNOPSIS -Gets the contents/source of a wiki page - -## SYNTAX - -```powershell -Get-PnPWikiPageContent -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWikiPageContent -PageUrl '/sites/demo1/pages/wikipage.aspx' -``` - -Gets the content of the page '/sites/demo1/pages/wikipage.aspx' - -## PARAMETERS - -### -ServerRelativePageUrl -The server relative URL for the wiki page - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md deleted file mode 100644 index d40385d0f0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWorkflowDefinition - -## SYNOPSIS -Returns a workflow definition - -## SYNTAX - -```powershell -Get-PnPWorkflowDefinition [-Name <String>] - [-PublishedOnly [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns a workflow definition - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWorkflowDefinition -Name MyWorkflow -``` - -Gets a Workflow with the name "MyWorkflow". - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWorkflowDefinition -Name MyWorkflow -PublishedOnly $false -``` - -Gets a Workflow with the name "MyWorkflow" that is published. - -## PARAMETERS - -### -Name -The name of the workflow - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -PublishedOnly -Return only the published workflows - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.WorkflowServices.WorkflowDefinition - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md deleted file mode 100644 index 039ae0440e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWorkflowInstance - -## SYNOPSIS -Get workflow instances - -## SYNTAX - -```powershell -Get-PnPWorkflowInstance -List <ListPipeBind> - -ListItem <ListItemPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Gets all workflow instances - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWorkflowInstance -List "My Library" -ListItem $ListItem -``` - -Retrieves workflow instances running against the provided item on list "My Library" - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWorkflowInstance -List "My Library" -ListItem 2 -``` - -Retrieves workflow instances running against the provided item with 2 in the list "My Library" - -## PARAMETERS - -### -List -The List for which workflow instances should be retrieved - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -ListItem -The List Item for which workflow instances should be retrieved - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md deleted file mode 100644 index 6270650a93..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Get-PnPWorkflowSubscription - -## SYNOPSIS -Return a workflow subscription - -## SYNTAX - -```powershell -Get-PnPWorkflowSubscription [-Name <String>] - [-List <ListPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns a workflow subscriptions from a list - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Get-PnPWorkflowSubscription -Name MyWorkflow -``` - -Gets an Workflow subscription with the name "MyWorkflow". - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWorkflowSubscription -Name MyWorkflow -list $list -``` - -Gets an Workflow subscription with the name "MyWorkflow" from the list $list. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPList -identity "MyList" | Get-PnPWorkflowSubscription -Name MyWorkflow -``` - -Gets an Workflow subscription with the name "MyWorkflow" from the list "MyList". - -## PARAMETERS - -### -List -A list to search the association for - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -Name -The name of the workflow - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.WorkflowServices.WorkflowSubscription - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md deleted file mode 100644 index 5387417b92..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Grant-PnPHubSiteRights - -## SYNOPSIS -Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users - -## SYNTAX - -```powershell -Grant-PnPHubSiteRights [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Grant-PnPHubSiteRights -Identity https://contoso.sharepoint.com/sites/hubsite -Principals "myuser@mydomain.com","myotheruser@mydomain.com" -Rights Join -``` - -This example shows how to grant rights to myuser and myotheruser to associate their sites with the provided Hub Site - -### ------------------EXAMPLE 2------------------ -```powershell -Grant-PnPHubSiteRights -Identity https://contoso.sharepoint.com/sites/hubsite -Principals "myuser@mydomain.com" -Rights None -``` - -This example shows how to revoke rights from myuser to associate their sites with the provided Hub Site - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md deleted file mode 100644 index cc1d6cb365..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Grant-PnPSiteDesignRights - -## SYNOPSIS -Grants the specified principals rights to use the site design. - -## SYNTAX - -```powershell -Grant-PnPSiteDesignRights -Identity <TenantSiteDesignPipeBind> - -Principals <String[]> - [-Rights <TenantSiteDesignPrincipalRights>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Grant-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com" -``` - -Grants the specified principals View rights on the site design specified - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSiteDesign -Title "MySiteDesign" -SiteScriptIds 438548fd-60dd-42cf-b843-2db506c8e259 -WebTemplate TeamSite | Grant-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com" -``` - -Grants the specified principals View rights on the site design specified - -## PARAMETERS - -### -Identity -The site design to use. - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Principals -One or more principals to grant rights to. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Rights -The rights to set. Defaults to 'View' - -```yaml -Type: TenantSiteDesignPrincipalRights -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md deleted file mode 100644 index f478489532..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Grant-PnPTenantServicePrincipalPermission - -## SYNOPSIS -Explicitly grants a specified permission to the "SharePoint Online Client" service principal - -## SYNTAX - -```powershell -Grant-PnPTenantServicePrincipalPermission -Scope <String> - -Resource <String> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Grant-PnPTenantServicePrincipalPermission -Scope "Group.Read.All" -Resource "Microsoft Graph" -``` - -This will explicitly grant the Group.Read.All permission on the Microsoft Graph resource - -## PARAMETERS - -### -Resource -The resource to grant the permission for - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope -The scope to grant the permission for - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.ALM.AppMetadata - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md deleted file mode 100644 index 356029ace8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Import-PnPAppPackage - -## SYNOPSIS -Adds a SharePoint Addin to a site - -## SYNTAX - -```powershell -Import-PnPAppPackage -Path <String> - [-Force [<SwitchParameter>]] - [-LoadOnly [<SwitchParameter>]] - [-Locale <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This commands requires that you have an addin package to deploy - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Import-PnPAppPackage -Path c:\files\demo.app -LoadOnly -``` - -This will load the addin in the demo.app package, but will not install it to the site. - - -### ------------------EXAMPLE 2------------------ -```powershell -Import-PnPAppPackage -Path c:\files\demo.app -Force -``` - -This load first activate the addin sideloading feature, upload and install the addin, and deactivate the addin sideloading feature. - - -## PARAMETERS - -### -Force -Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LoadOnly -Will only upload the addin, but not install it - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Locale -Will install the addin for the specified locale - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Path pointing to the .app file - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.AppInstance - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md deleted file mode 100644 index 32afe9d78d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Import-PnPTaxonomy - -## SYNOPSIS -Imports a taxonomy from either a string array or a file - -## SYNTAX - -### Direct -```powershell -Import-PnPTaxonomy [-Terms <String[]>] - [-Lcid <Int>] - [-TermStoreName <String>] - [-Delimiter <String>] - [-SynchronizeDeletions [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### File -```powershell -Import-PnPTaxonomy -Path <String> - [-Lcid <Int>] - [-TermStoreName <String>] - [-Delimiter <String>] - [-SynchronizeDeletions [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Import-PnPTaxonomy -Terms 'Company|Locations|Stockholm' -``` - -Creates a new termgroup, 'Company', a termset 'Locations' and a term 'Stockholm' - -### ------------------EXAMPLE 2------------------ -```powershell -Import-PnPTaxonomy -Terms 'Company|Locations|Stockholm|Central','Company|Locations|Stockholm|North' -``` - -Creates a new termgroup, 'Company', a termset 'Locations', a term 'Stockholm' and two subterms: 'Central', and 'North' - -### ------------------EXAMPLE 3------------------ -```powershell -Import-PnPTaxonomy -Path ./mytaxonomyterms.txt -``` - -Imports the taxonomy from the file specified. Each line has to be in the format TERMGROUP|TERMSET|TERM. See example 2 for examples of the format. - -## PARAMETERS - -### -Delimiter -The path delimiter to be used, by default this is '|' - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Lcid - - -```yaml -Type: Int -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Specifies a file containing terms per line, in the format as required by the Terms parameter. - -```yaml -Type: String -Parameter Sets: File - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -SynchronizeDeletions -If specified, terms that exist in the termset, but are not in the imported data, will be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Terms -An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'. - -```yaml -Type: String[] -Parameter Sets: Direct - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -TermStoreName -Term store to import to; if not specified the default term store is used. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md deleted file mode 100644 index e38c6b14d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Import-PnPTermGroupFromXml - -## SYNOPSIS -Imports a taxonomy TermGroup from either the input or from an XML file. - -## SYNTAX - -### XML -```powershell -Import-PnPTermGroupFromXml [-Xml <String>] - [-Connection <SPOnlineConnection>] -``` - -### File -```powershell -Import-PnPTermGroupFromXml [-Path <String>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Import-PnPTermGroupFromXml -Xml $xml -``` - -Imports the XML based termgroup information located in the $xml variable - -### ------------------EXAMPLE 2------------------ -```powershell -Import-PnPTermGroupFromXml -Path input.xml -``` - -Imports the XML file specified by the path. - -## PARAMETERS - -### -Path -The XML File to import the data from - -```yaml -Type: String -Parameter Sets: File - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Xml -The XML to process - -```yaml -Type: String -Parameter Sets: XML - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md deleted file mode 100644 index 813ffb1de6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Import-PnPTermSet - -## SYNOPSIS -Imports a taxonomy term set from a file in the standard format. - -## SYNTAX - -```powershell -Import-PnPTermSet -GroupName <String> - -Path <String> - [-TermSetId <Guid>] - [-SynchronizeDeletions [<SwitchParameter>]] - [-IsOpen <Boolean>] - [-Contact <String>] - [-Owner <String>] - [-TermStoreName <String>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -The format of the file is the same as that used by the import function in the web interface. A sample file can be obtained from the web interface. - -This is a CSV file, with the following headings: - - Term Set Name,Term Set Description,LCID,Available for Tagging,Term Description,Level 1 Term,Level 2 Term,Level 3 Term,Level 4 Term,Level 5 Term,Level 6 Term,Level 7 Term - -The first data row must contain the Term Set Name, Term Set Description, and LCID, and should also contain the first term. - -It is recommended that a fixed GUID be used as the termSetId, to allow the term set to be easily updated (so do not pass Guid.Empty). - -In contrast to the web interface import, this is not a one-off import but runs synchronisation logic allowing updating of an existing Term Set. When synchronising, any existing terms are matched (with Term Description and Available for Tagging updated as necessary), any new terms are added in the correct place in the hierarchy, and (if synchroniseDeletions is set) any terms not in the imported file are removed. - -The import file also supports an expanded syntax for the Term Set Name and term names (Level 1 Term, Level 2 Term, etc). These columns support values with the format 'Name | GUID', with the name and GUID separated by a pipe character (note that the pipe character is invalid to use within a taxomony item name). This expanded syntax is not required, but can be used to ensure all terms have fixed IDs. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Import-PnPTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -SynchronizeDeletions -``` - -Creates (or updates) the term set specified in the import file, in the group specified, removing any existing terms not in the file. - -### ------------------EXAMPLE 2------------------ -```powershell -Import-PnPTermSet -TermStoreName 'My Term Store' -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -TermSetId '{15A98DB6-D8E2-43E6-8771-066C1EC2B8D8}' -``` - -Creates (or updates) the term set specified in the import file, in the term store and group specified, using the specified ID. - -### ------------------EXAMPLE 3------------------ -```powershell -Import-PnPTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -IsOpen $true -Contact 'user@example.org' -Owner 'user@example.org' -``` - -Creates (or updates) the term set specified in the import file, setting the IsOpen, Contact, and Owner properties as specified. - -## PARAMETERS - -### -Contact -Contact for the term set; if not specified, the existing setting is retained. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -GroupName -Group to import the term set to; an error is returned if the group does not exist. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -IsOpen -Whether the term set should be marked open; if not specified, then the existing setting is not changed. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owner -Owner for the term set; if not specified, the existing setting is retained. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Path -Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration). - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -SynchronizeDeletions -If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermSetId -GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used. - -```yaml -Type: Guid -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermStoreName -Term store to import into; if not specified the default term store is used. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md deleted file mode 100644 index f1438a8faa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Install-PnPApp - -## SYNOPSIS -Installs an available app from the app catalog - -## SYNTAX - -```powershell -Install-PnPApp -Identity <AppMetadataPipeBind> - [-Scope <AppCatalogScope>] - [-Wait [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will install an app that is available in the tenant scoped app catalog, specified by the id, to the current site. - -### ------------------EXAMPLE 2------------------ -```powershell -Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site -``` - -This will install an app that is available in the site collection scoped app catalog, specified by the id, to the current site. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe | Install-PnPApp -``` - -This will install the given app from the tenant scoped app catalog into the site. - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site | Install-PnPApp -``` - -This will install the given app from the site collection scoped app catalog into the site. - -## PARAMETERS - -### -Identity -Specifies the Id or an actual app metadata instance - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Wait -If specified the execution will pause until the app has been installed in the site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md deleted file mode 100644 index 7b674c3d3f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Install-PnPSolution - -## SYNOPSIS -Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that. - -## SYNTAX - -```powershell -Install-PnPSolution -PackageId <GuidPipeBind> - -SourceFilePath <String> - [-MajorVersion <Int>] - [-MinorVersion <Int>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Install-PnPSolution -PackageId c2f5b025-7c42-4d3a-b579-41da3b8e7254 -SourceFilePath mypackage.wsp -``` - -Installs the package to the current site - -## PARAMETERS - -### -MajorVersion -Optional major version of the solution, defaults to 1 - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MinorVersion -Optional minor version of the solution, defaults to 0 - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PackageId -ID of the solution, from the solution manifest - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -SourceFilePath -Path to the sandbox solution package (.WSP) file - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md deleted file mode 100644 index c1a7d6ce85..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Invoke-PnPQuery - -## SYNOPSIS -Executes the currently queued actions - -## SYNTAX - -```powershell -Invoke-PnPQuery [-RetryCount <Int>] - [-RetryWait <Int>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Executes any queued actions / changes on the SharePoint Client Side Object Model Context - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Invoke-PnPQuery -RetryCount 5 -``` - -This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and will retry 5 times in case of throttling. - -### ------------------EXAMPLE 2------------------ -```powershell -Invoke-PnPQuery -RetryWait 10 -``` - -This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and delay the execution for 10 seconds before it retries the execution. - -## PARAMETERS - -### -RetryCount -Number of times to retry in case of throttling. Defaults to 10. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RetryWait -Delay in seconds. Defaults to 1. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md deleted file mode 100644 index 6526e798ae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Invoke-PnPSiteDesign - -## SYNOPSIS -Apply a Site Design to an existing site. * Requires Tenant Administration Rights * - -## SYNTAX - -```powershell -Invoke-PnPSiteDesign -Identity <TenantSiteDesignPipeBind> - [-WebUrl <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Invoke-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -``` - -Applies the specified site design to the current site. - -### ------------------EXAMPLE 2------------------ -```powershell -Invoke-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -WebUrl https://contoso.sharepoint.com/sites/mydemosite -``` - -Applies the specified site design to the specified site. - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSiteDesign | ?{$_.Title -eq "Demo"} | Invoke-PnPSiteDesign -``` - -Applies the specified site design to the specified site. - -## PARAMETERS - -### -Identity -The Site Design Id or an actual Site Design object to apply - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -WebUrl -The URL of the web to apply the site design to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md deleted file mode 100644 index 13b132fae6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Invoke-PnPWebAction - -## SYNOPSIS -Executes operations on web, lists and list items. - -## SYNTAX - -```powershell -Invoke-PnPWebAction [-Webs <Web[]>] - [-WebAction <Web>] - [-ShouldProcessWebAction <Web>] - [-PostWebAction <Web>] - [-ShouldProcessPostWebAction <Web>] - [-WebProperties <String[]>] - [-ListAction <List>] - [-ShouldProcessListAction <List>] - [-PostListAction <List>] - [-ShouldProcessPostListAction <List>] - [-ListProperties <String[]>] - [-ListItemAction <ListItem>] - [-ShouldProcessListItemAction <ListItem>] - [-ListItemProperties <String[]>] - [-SubWebs [<SwitchParameter>]] - [-DisableStatisticsOutput [<SwitchParameter>]] - [-SkipCounting [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Invoke-PnPWebAction -ListAction ${function:ListAction} -``` - -This will call the function ListAction on all the lists located on the current web. - -### ------------------EXAMPLE 2------------------ -```powershell -Invoke-PnPWebAction -ShouldProcessListAction ${function:ShouldProcessList} -ListAction ${function:ListAction} -``` - -This will call the function ShouldProcessList, if it returns true the function ListAction will then be called. This will occur on all lists located on the current web - -## PARAMETERS - -### -DisableStatisticsOutput -Will not output statistics after the operation - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ListAction -Function to be executed on the list. There is one input parameter of type List - -```yaml -Type: List -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ListItemAction -Function to be executed on the list item. There is one input parameter of type ListItem - -```yaml -Type: ListItem -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ListItemProperties -The properties to load for list items. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ListProperties -The properties to load for list. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PostListAction -Function to be executed on the list, this will trigger after list items have been processed. There is one input parameter of type List - -```yaml -Type: List -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PostWebAction -Function to be executed on the web, this will trigger after lists and list items have been processed. There is one input parameter of type Web - -```yaml -Type: Web -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShouldProcessListAction -Function to be executed on the web that would determine if ListAction should be invoked, There is one input parameter of type List and the function should return a boolean value - -```yaml -Type: List -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShouldProcessListItemAction -Function to be executed on the web that would determine if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a boolean value - -```yaml -Type: ListItem -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShouldProcessPostListAction -Function to be executed on the web that would determine if PostListAction should be invoked, There is one input parameter of type List and the function should return a boolean value - -```yaml -Type: List -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShouldProcessPostWebAction -Function to be executed on the web that would determine if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value - -```yaml -Type: Web -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShouldProcessWebAction -Function to be executed on the web that would determine if WebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value - -```yaml -Type: Web -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SkipCounting -Will skip the counting process; by doing this you will not get an estimated time remaining - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SubWebs -Specify if sub webs will be processed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -WebAction -Function to be executed on the web. There is one input parameter of type Web - -```yaml -Type: Web -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -WebProperties -The properties to load for web. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Webs -Webs you want to process (for example different site collections), will use Web parameter if not specified - -```yaml -Type: Web[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md deleted file mode 100644 index c6a62ef387..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: -applicable: SharePoint Online, SharePoint 2016 -schema: 2.0.0 ---- -# Measure-PnPList - -## SYNOPSIS -Returns statistics on the list object - -## SYNTAX - -### -```powershell -Measure-PnPList -Identity <ListPipeBind> - [-Includes <String[]>] - [-ItemLevel [<SwitchParameter>]] - [-BrokenPermissions [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Measure-PnPList "Documents" -``` - -Gets statistics on Documents document library - -### ------------------EXAMPLE 2------------------ -```powershell -Measure-PnPList "Documents" -BrokenPermissions -ItemLevel -``` - -Displays items and folders with broken permissions inside Documents library - -## PARAMETERS - -### -BrokenPermissions -Show items with broken permissions - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity - - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Includes -Specify properties to include when retrieving objects from the server. - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -ItemLevel -Show item level statistics - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md deleted file mode 100644 index e98c60c97a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Measure-PnPResponseTime - -## SYNOPSIS -Gets statistics on response time for the specified endpoint by sending probe requests - -## SYNTAX - -```powershell -Measure-PnPResponseTime [-Url <DiagnosticEndpointPipeBind>] - [-Count <UInt32>] - [-WarmUp <UInt32>] - [-Timeout <UInt32>] - [-Histogram <UInt32>] - [-Mode <MeasureResponseTimeMode>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Measure-PnPResponseTime -Count 100 -Timeout 20 -``` - -Calculates statistics on sequence of 100 probe requests, sleeps 20ms between probes - -### ------------------EXAMPLE 2------------------ -```powershell -Measure-PnPResponseTime "/Pages/Test.aspx" -Count 1000 -``` - -Calculates statistics on response time of Test.aspx by sending 1000 requests with default sleep time between requests - -### ------------------EXAMPLE 3------------------ -```powershell -Measure-PnPResponseTime $web -Count 1000 -WarmUp 10 -Histogram 20 -Timeout 50 | Select -expa Histogram | % {$_.GetEnumerator() | Export-Csv C:\Temp\responsetime.csv -NoTypeInformation} -``` - -Builds histogram of response time for the home page of the web and exports to CSV for later processing in Excel - -## PARAMETERS - -### -Count -Number of probe requests to send - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Histogram -Number of buckets in histogram in output statistics - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Mode -Response time measurement mode. RoundTrip - measures full request round trip. SPRequestDuration - measures server processing time only, based on SPRequestDuration HTTP header. Latency - difference between RoundTrip and SPRequestDuration - -```yaml -Type: MeasureResponseTimeMode -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Timeout -Idle timeout between requests to avoid request throttling - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url - - -```yaml -Type: DiagnosticEndpointPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -WarmUp -Number of warm up requests to send before start calculating statistics - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md deleted file mode 100644 index fe997d79e9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -applicable: SharePoint Online, SharePoint 2016 -schema: 2.0.0 ---- -# Measure-PnPWeb - -## SYNOPSIS -Returns statistics on the web object - -## SYNTAX - -```powershell -Measure-PnPWeb [-Identity <WebPipeBind>] - [-Recursive [<SwitchParameter>]] - [-IncludeHiddenList [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Measure-PnPWeb -``` - -Gets statistics on the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Measure-PnPWeb $web -Recursive -``` - -Gets statistics on the provided web including all its subwebs - -### ------------------EXAMPLE 3------------------ -```powershell -Measure-PnPList $web -Recursive -``` - -Gets statistics on the chosen including all sub webs - -## PARAMETERS - -### -Identity - - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -IncludeHiddenList -Include hidden lists in statistics calculation - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Recursive -Iterate all sub webs recursively - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online, SharePoint Server 2016 - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md deleted file mode 100644 index 1886fd4380..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Move-PnPClientSideComponent - -## SYNOPSIS -Moves a Client-Side Component to a different section/column - -## SYNTAX - -### Move to other section -```powershell -Move-PnPClientSideComponent -Section <Int> - -Page <ClientSidePagePipeBind> - -InstanceId <GuidPipeBind> - [-Position <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Move to other column -```powershell -Move-PnPClientSideComponent -Column <Int> - -Page <ClientSidePagePipeBind> - -InstanceId <GuidPipeBind> - [-Position <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Move within a column -```powershell -Move-PnPClientSideComponent -Position <Int> - -Page <ClientSidePagePipeBind> - -InstanceId <GuidPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Move to other section and column -```powershell -Move-PnPClientSideComponent -Section <Int> - -Column <Int> - -Page <ClientSidePagePipeBind> - -InstanceId <GuidPipeBind> - [-Position <Int>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Moves a Client-Side Component to a different location on the page. Notice that the sections and or columns need to be present before moving the component. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -``` - -Moves the specified component to the first section of the page. - -### ------------------EXAMPLE 2------------------ -```powershell -Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Column 2 -``` - -Moves the specified component to the second column of the current section. - -### ------------------EXAMPLE 3------------------ -```powershell -Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -Column 2 -``` - -Moves the specified component to the first section of the page into the second column. - -### ------------------EXAMPLE 4------------------ -```powershell -Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -Column 2 -Position 2 -``` - -Moves the specified component to the first section of the page into the second column and sets the column to position 2 in the list of webparts. - -## PARAMETERS - -### -Column -The column to move the webpart to - -```yaml -Type: Int -Parameter Sets: Move to other column, Move to other section and column - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -InstanceId -The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids. - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Page -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Position -Change to order of the webpart in the column - -```yaml -Type: Int -Parameter Sets: Move to other column, Move to other section, Move to other section and column, Move within a column - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Section -The section to move the webpart to - -```yaml -Type: Int -Parameter Sets: Move to other section, Move to other section and column - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md deleted file mode 100644 index 105d692ef0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Move-PnPFile - -## SYNOPSIS -Moves a file to a different location - -## SYNTAX - -### Server Relative -```powershell -Move-PnPFile -ServerRelativeUrl <String> - -TargetUrl <String> - [-OverwriteIfAlreadyExists [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Site Relative -```powershell -Move-PnPFile -SiteRelativeUrl <String> - -TargetUrl <String> - [-OverwriteIfAlreadyExists [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -PS:>Move-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -``` - -Moves a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it won't perform the move. - -### ------------------EXAMPLE 2------------------ -```powershell -PS:>Move-PnPFile -SiteRelativeUrl Documents/company.aspx -TargetUrl /sites/otherproject/Documents/company.docx -``` - -Moves a file named company.docx located in the document library called Documents located in the current site to the Documents library in the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it won't perform the move. - -### ------------------EXAMPLE 3------------------ -```powershell -PS:>Move-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -OverwriteIfAlreadyExists -``` - -Moves a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it will still perform the move and replace the original company.aspx file. - -## PARAMETERS - -### -Force -If provided, no confirmation will be requested and the action will be performed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OverwriteIfAlreadyExists -If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the move operation will be canceled if the file already exists at the TargetUrl location. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativeUrl -Server relative Url specifying the file to move. Must include the file name. - -```yaml -Type: String -Parameter Sets: Server Relative - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SiteRelativeUrl -Site relative Url specifying the file to move. Must include the file name. - -```yaml -Type: String -Parameter Sets: Site Relative - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TargetUrl -Server relative Url where to move the file to. Must include the file name. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md deleted file mode 100644 index fd3d52f686..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Move-PnPFolder - -## SYNOPSIS -Move a folder to another location in the current web - -## SYNTAX - -```powershell -Move-PnPFolder -Folder <String> - -TargetFolder <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Move-PnPFolder -Folder Documents/Reports -TargetFolder 'Archived Reports' -``` - -This will move the folder Reports in the Documents library to the 'Archived Reports' library - -### ------------------EXAMPLE 2------------------ -```powershell -Move-PnPFolder -Folder 'Shared Documents/Reports/2016/Templates' -TargetFolder 'Shared Documents/Reports' -``` - -This will move the folder Templates to the new location in 'Shared Documents/Reports' - -## PARAMETERS - -### -Folder -The folder to move - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TargetFolder -The new parent location to which the folder should be moved to - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -Only applicable to: SharePoint Online - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Folder - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md deleted file mode 100644 index 22395f953e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Move-PnPItemProxy - -## SYNOPSIS -Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md deleted file mode 100644 index 5fa12f00bd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Move-PnPListItemToRecycleBin - -## SYNOPSIS -Moves an item from a list to the Recycle Bin - -## SYNTAX - -```powershell -Move-PnPListItemToRecycleBin -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Move-PnPListItemToRecycleBin -List "Demo List" -Identity "1" -Force -``` - -Moves the listitem with id "1" from the "Demo List" list to the Recycle Bin. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md deleted file mode 100644 index fb833fa6e7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Move-PnPRecycleBinItem - -## SYNOPSIS -Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin - -## SYNTAX - -```powershell -Move-PnPRecycleBinItem [-Identity <RecycleBinItemPipeBind>] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Move-PnpRecycleBinItem -``` - -Moves all the items in the first stage recycle bin of the current site collection to the second stage recycle bin - -### ------------------EXAMPLE 2------------------ -```powershell -Move-PnpRecycleBinItem -Identity 26ffff29-b526-4451-9b6f-7f0e56ba7125 -``` - -Moves the item with the provided ID in the first stage recycle bin of the current site collection to the second stage recycle bin without asking for confirmation first - -### ------------------EXAMPLE 3------------------ -```powershell -Move-PnpRecycleBinItem -Force -``` - -Moves all the items in the first stage recycle bin of the current context to the second stage recycle bin without asking for confirmation first - -## PARAMETERS - -### -Force -If provided, no confirmation will be asked to move the first stage recycle bin items to the second stage - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -If provided, moves the item with the specific ID to the second stage recycle bin - -```yaml -Type: RecycleBinItemPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md deleted file mode 100644 index ed3c2768c0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPAzureCertificate - -## SYNOPSIS -Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. - -See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. - -KeyCredentials contains the ADAL app manifest sections. - -Certificate contains the PEM encoded certificate. - -PrivateKey contains the PEM encoded private key of the certificate. - -## SYNTAX - -```powershell -New-PnPAzureCertificate [-CommonName <String>] - [-Country <String>] - [-State <String>] - [-Locality <String>] - [-Organization <String>] - [-OrganizationUnit <String>] - [-Out <String>] - [-ValidYears <Int>] - [-CertificatePassword <SecureString>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPAzureCertificate -``` - -This will generate a default self-signed certificate named "pnp.contoso.com" valid for 10 years. - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPAzureCertificate -CommonName "My Certificate" -ValidYears 30 -``` - -This will output a certificate named "My Certificate" which expires in 30 years from now. - -## PARAMETERS - -### -CertificatePassword -Optional certificate password - -```yaml -Type: SecureString -Parameter Sets: (All) - -Required: False -Position: 8 -Accept pipeline input: False -``` - -### -CommonName -Common Name (e.g. server FQDN or YOUR name) [pnp.contoso.com] - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Country -Country Name (2 letter code) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -Locality -Locality Name (eg, city) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 3 -Accept pipeline input: False -``` - -### -Organization -Organization Name (eg, company) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 4 -Accept pipeline input: False -``` - -### -OrganizationUnit -Organizational Unit Name (eg, section) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 5 -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path (.pfx) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 6 -Accept pipeline input: False -``` - -### -State -State or Province Name (full name) - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 2 -Accept pipeline input: False -``` - -### -ValidYears -Number of years until expiration (default is 10, max is 30) - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: 7 -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md deleted file mode 100644 index 4345e9912b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPExtensibilityHandlerObject - -## SYNOPSIS -Creates an ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate cmdlet - -## SYNTAX - -```powershell -New-PnPExtensibilityHandlerObject -Assembly <String> - -Type <String> - [-Configuration <String>] - [-Disabled [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell - -$handler = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler -Get-PnPProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler -``` - -This will create a new ExtensibilityHandler object that is run during extraction of the template - -## PARAMETERS - -### -Assembly -The full assembly name of the handler - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Configuration -Any configuration data you want to send to the handler - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Disabled -If set, the handler will be disabled - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Type -The type of the handler - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Framework.Provisioning.Model.ExtensibilityHandler - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md deleted file mode 100644 index 5c01336d26..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPGroup - -## SYNOPSIS -Adds group to the Site Groups List and returns a group object - -## SYNTAX - -```powershell -New-PnPGroup -Title <String> - [-Description <String>] - [-Owner <String>] - [-AllowRequestToJoinLeave [<SwitchParameter>]] - [-AutoAcceptRequestToJoinLeave [<SwitchParameter>]] - [-AllowMembersEditMembership [<SwitchParameter>]] - [-DisallowMembersViewMembership [<SwitchParameter>]] - [-RequestToJoinEmail <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPGroup -Title "My Site Users" -``` - - - -## PARAMETERS - -### -AllowMembersEditMembership -A switch parameter that specifies whether group members can modify membership in the group - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AllowRequestToJoinLeave -A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AutoAcceptRequestToJoinLeave -A switch parameter that specifies whether users are automatically added or removed when they make a request - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description for the group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisallowMembersViewMembership -A switch parameter that disallows group members to view membership. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owner -The owner for the group, which can be a user or another group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RequestToJoinEmail -The e-mail address to which membership requests are sent - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The Title of the group - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Group - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md deleted file mode 100644 index 9c77d459ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPList - -## SYNOPSIS -Creates a new list - -## SYNTAX - -```powershell -New-PnPList -Title <String> - -Template <ListTemplateType> - [-Url <String>] - [-Hidden [<SwitchParameter>]] - [-EnableVersioning [<SwitchParameter>]] - [-EnableContentTypes [<SwitchParameter>]] - [-OnQuickLaunch [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPList -Title Announcements -Template Announcements -``` - -Create a new announcements list - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPList -Title "Demo List" -Url "DemoList" -Template Announcements -``` - -Create a list with a title that is different from the url - -### ------------------EXAMPLE 3------------------ -```powershell -New-PnPList -Title HiddenList -Template GenericList -Hidden -``` - -Create a new custom list and hides it from the SharePoint UI. - -## PARAMETERS - -### -EnableContentTypes -Switch parameter if content types should be enabled on this list - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableVersioning -Switch parameter if versioning should be enabled - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Hidden -Switch parameter if list should be hidden from the SharePoint UI - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OnQuickLaunch -Switch parameter if this list should be visible on the QuickLaunch - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Template -The type of list to create. - -```yaml -Type: ListTemplateType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -The Title of the list - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -If set, will override the url of the list. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md deleted file mode 100644 index 74cd0f621a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPPersonalSite - -## SYNOPSIS -Office365 only: Creates a personal / OneDrive For Business site - -## SYNTAX - -```powershell -New-PnPPersonalSite -Email <String[]> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$users = ('katiej@contoso.onmicrosoft.com','garth@contoso.onmicrosoft.com') - New-PnPPersonalSite -Email $users -``` - -Creates a personal / OneDrive For Business site for the 2 users in the variable $users - -## PARAMETERS - -### -Email -The UserPrincipalName (UPN) of the users - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md deleted file mode 100644 index aa4c14b247..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPProvisioningTemplate - -## SYNOPSIS -Creates a new provisioning template object - -## SYNTAX - -```powershell -New-PnPProvisioningTemplate [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$template = New-PnPProvisioningTemplate -``` - -Creates a new instance of a site template object. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Server 2013, SharePoint Server 2016 - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -Only applicable to: SharePoint Server 2013, SharePoint Server 2016 - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md deleted file mode 100644 index 6e85fe0e2a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPProvisioningTemplateFromFolder - -## SYNOPSIS -Generates a provisioning template from a given folder, including only files that are present in that folder - -## SYNTAX - -```powershell -New-PnPProvisioningTemplateFromFolder [-Out <String>] - [-Folder <String>] - [-Match <String>] - [-ContentType <ContentTypePipeBind>] - [-Properties <Hashtable>] - [-AsIncludeFile [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Encoding <Encoding>] - [-TargetFolder <String>] - [-Schema <XMLPnPSchemaVersion>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.xml -``` - -Creates an empty provisioning template, and includes all files in the current folder. - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -``` - -Creates an empty provisioning template, and includes all files in the c:\temp folder. - -### ------------------EXAMPLE 3------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -``` - -Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder. - -### ------------------EXAMPLE 4------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -``` - -Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder - -### ------------------EXAMPLE 5------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -ContentType "Test Content Type" -``` - -Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add a property to the item for the content type. - -### ------------------EXAMPLE 6------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -Properties @{"Title" = "Test Title"; "Category"="Test Category"} -``` - -Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add the specified properties to the file entries. - -### ------------------EXAMPLE 7------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.pnp -``` - -Creates an empty provisioning template as a pnp package file, and includes all files in the current folder - -### ------------------EXAMPLE 8------------------ -```powershell -New-PnPProvisioningTemplateFromFolder -Out template.pnp -Folder c:\temp -``` - -Creates an empty provisioning template as a pnp package file, and includes all files in the c:\temp folder - -## PARAMETERS - -### -AsIncludeFile -If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ContentType -An optional content type to use. - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Encoding -The encoding type of the XML file, Unicode is default - -```yaml -Type: Encoding -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Folder -Folder to process. If not specified the current folder will be used. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Force -Overwrites the output file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Match -Optional wildcard pattern to match filenames against. If empty all files will be included. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Properties -Additional properties to set for every file entry in the generated template. - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Schema -The schema of the output to use, defaults to the latest schema - -```yaml -Type: XMLPnPSchemaVersion -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -TargetFolder -Target folder to provision to files to. If not specified, the current folder name will be used. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md deleted file mode 100644 index 1fdb48021d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPSite - -## SYNOPSIS -Creates a new site collection - -## SYNTAX - -### Communication Site with Built-In Site Design -```powershell -New-PnPSite -Title <String> - -Url <String> - -Type <SiteType> - [-Description <String>] - [-Classification <String>] - [-AllowFileSharingForGuestUsers [<SwitchParameter>]] - [-SiteDesign <CommunicationSiteDesign>] - [-Lcid <UInt32>] - [-Connection <SPOnlineConnection>] -``` - -### Team Site -```powershell -New-PnPSite -Title <String> - -Alias <String> - -Type <SiteType> - [-Lcid <UInt32>] - [-Description <String>] - [-Classification <String>] - [-IsPublic <String>] - [-Connection <SPOnlineConnection>] -``` - -### Communication Site with Custom Design -```powershell -New-PnPSite -Title <String> - -Url <String> - -SiteDesignId <GuidPipeBind> - -Type <SiteType> - [-Description <String>] - [-Classification <String>] - [-AllowFileSharingForGuestUsers [<SwitchParameter>]] - [-Lcid <UInt32>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -The New-PnPSite cmdlet creates a new site collection for the current tenant. Currently only 'modern' sites like Communication Site and the Modern Team Site are supported. If you want to create a classic site, use New-PnPTenantSite. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -``` - -This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -SiteDesign Showcase -``` - -This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. It will use the 'Showcase' design for the site. - -### ------------------EXAMPLE 3------------------ -```powershell -New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -SiteDesignId ae2349d5-97d6-4440-94d1-6516b72449ac -``` - -This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. It will use the specified custom site design for the site. - -### ------------------EXAMPLE 4------------------ -```powershell -New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Classification "HBI" -``` - -This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. The classification for the site will be set to "HBI" - -### ------------------EXAMPLE 5------------------ -```powershell -New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -ShareByEmailEnabled -``` - -This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. Allows owners to invite users outside of the organization. - -### ------------------EXAMPLE 6------------------ -```powershell -New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Lcid 1044 -``` - -This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' and sets the default language to Italian. - -### ------------------EXAMPLE 7------------------ -```powershell -New-PnPSite -Type TeamSite -Title 'Team Contoso' -Alias contoso -``` - -This will create a new Modern Team Site collection with the title 'Team Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' or 'https://tenant.sharepoint.com/teams/contoso' based on the managed path configuration in the SharePoint Online Admin portal. - -### ------------------EXAMPLE 8------------------ -```powershell -New-PnPSite -Type TeamSite -Title 'Team Contoso' -Alias contoso -IsPublic -``` - -This will create a new Modern Team Site collection with the title 'Team Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' or 'https://tenant.sharepoint.com/teams/contoso' based on the managed path configuration in the SharePoint Online Admin portal and sets the site to public. - -### ------------------EXAMPLE 9------------------ -```powershell -New-PnPSite -Type TeamSite -Title 'Team Contoso' -Alias contoso -Lcid 1040 -``` - -This will create a new Modern Team Site collection with the title 'Team Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' or 'https://tenant.sharepoint.com/teams/contoso' based on the managed path configuration in the SharePoint Online Admin portal and sets the default language of the site to Italian. - -## PARAMETERS - -### -Alias -Specifies the alias of the new site collection which represents the part of the URL that will be assigned to the site behind 'https://tenant.sharepoint.com/sites/' or 'https://tenant.sharepoint.com/teams/' based on the managed path configuration in the SharePoint Online Admin portal - -```yaml -Type: String -Parameter Sets: Team Site - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -AllowFileSharingForGuestUsers -Specifies if guest users can share files in the new site collection - -```yaml -Type: SwitchParameter -Parameter Sets: Communication Site with Built-In Site Design - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Classification -Specifies the classification of the new site collection - -```yaml -Type: String -Parameter Sets: Communication Site with Built-In Site Design - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Description -Specifies the description of the new site collection - -```yaml -Type: String -Parameter Sets: Communication Site with Built-In Site Design - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -IsPublic -Specifies if new site collection is public. Defaults to false. - -```yaml -Type: String -Parameter Sets: Team Site - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Lcid -Specifies the language of the new site collection. Defaults to the current language of the web connected to. - -```yaml -Type: UInt32 -Parameter Sets: Communication Site with Built-In Site Design - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -SiteDesign -Specifies the site design of the new site collection. Defaults to 'Topic' - -```yaml -Type: CommunicationSiteDesign -Parameter Sets: Communication Site with Built-In Site Design - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -SiteDesignId -Specifies the site design id to use for the new site collection. If specified will override SiteDesign - -```yaml -Type: GuidPipeBind -Parameter Sets: Communication Site with Custom Design - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Title -Specifies the title of the new site collection - -```yaml -Type: String -Parameter Sets: Communication Site with Built-In Site Design - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Type -@Specifies with type of site to create. - -```yaml -Type: SiteType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -Specifies the full url of the new site collection - -```yaml -Type: String -Parameter Sets: Communication Site with Built-In Site Design - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### System.String - -Returns the url of the newly created site collection - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md deleted file mode 100644 index 5ff315b466..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantSequence - -## SYNOPSIS -Creates a new tenant sequence object - -## SYNTAX - -```powershell -New-PnPTenantSequence [-Id <String>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$sequence = New-PnPTenantSequence -``` - -Creates a new instance of a tenant sequence object. - -### ------------------EXAMPLE 2------------------ -```powershell -$sequence = New-PnPTenantSequence -Id "MySequence" -``` - -Creates a new instance of a tenant sequence object and sets the Id to the value specified. - -## PARAMETERS - -### -Id -Optional Id of the sequence - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md deleted file mode 100644 index ce6f555f83..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantSequenceCommunicationSite - -## SYNOPSIS -Creates a communication site object - -## SYNTAX - -```powershell -New-PnPTenantSequenceCommunicationSite -Url <String> - -Title <String> - [-Language <UInt32>] - [-Owner <String>] - [-Description <String>] - [-Classification <String>] - [-SiteDesignId <String>] - [-HubSite [<SwitchParameter>]] - [-AllowFileSharingForGuestUsers [<SwitchParameter>]] - [-TemplateIds <String[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$site = New-PnPTenantSequenceCommunicationSite -Url "/sites/mycommunicationsite" -Title "My Team Site" -``` - -Creates a new communication site object with the specified variables - -## PARAMETERS - -### -AllowFileSharingForGuestUsers - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Classification - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -HubSite - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Language - - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owner - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SiteDesignId - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateIds - - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md deleted file mode 100644 index 788a94356a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantSequenceTeamNoGroupSite - -## SYNOPSIS -Creates a new team site without an Office 365 group in-memory object - -## SYNTAX - -```powershell -New-PnPTenantSequenceTeamNoGroupSite -Url <String> - -Title <String> - -TimeZoneId <UInt32> - [-Language <UInt32>] - [-Owner <String>] - [-Description <String>] - [-HubSite [<SwitchParameter>]] - [-TemplateIds <String[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$site = New-PnPTenantSequenceTeamNoGroupSite -Alias "MyTeamSite" -Title "My Team Site" -``` - -Creates a new team site object with the specified variables - -## PARAMETERS - -### -Description - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -HubSite - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Language - - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owner - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateIds - - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TimeZoneId - - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md deleted file mode 100644 index 64d2358b4b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantSequenceTeamNoGroupSubSite - -## SYNOPSIS -Creates a team site subsite with no Office 365 group object - -## SYNTAX - -```powershell -New-PnPTenantSequenceTeamNoGroupSubSite -Url <String> - -Title <String> - -TimeZoneId <UInt32> - [-Language <UInt32>] - [-Description <String>] - [-TemplateIds <String[]>] - [-QuickLaunchDisabled [<SwitchParameter>]] - [-UseDifferentPermissionsFromParentSite [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$site = New-PnPTenantSequenceTeamNoGroupSubSite -Url "MyTeamSubsite" -Title "My Team Site" -TimeZoneId 4 -``` - -Creates a new team site subsite object with the specified variables - -## PARAMETERS - -### -Description - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Language - - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -QuickLaunchDisabled - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateIds - - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TimeZoneId - - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -UseDifferentPermissionsFromParentSite - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md deleted file mode 100644 index 853ba4083b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantSequenceTeamSite - -## SYNOPSIS -Creates a team site object - -## SYNTAX - -```powershell -New-PnPTenantSequenceTeamSite -Alias <String> - -Title <String> - [-Description <String>] - [-DisplayName <String>] - [-Classification <String>] - [-Public [<SwitchParameter>]] - [-HubSite [<SwitchParameter>]] - [-TemplateIds <String[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$site = New-PnPTenantSequenceTeamSite -Alias "MyTeamSite" -Title "My Team Site" -``` - -Creates a new team site object with the specified variables - -## PARAMETERS - -### -Alias - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Classification - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayName - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -HubSite - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Public - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateIds - - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md deleted file mode 100644 index f471467c63..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantSite - -## SYNOPSIS -Creates a new site collection for the current tenant - -## SYNTAX - -```powershell -New-PnPTenantSite -Title <String> - -Url <String> - -Owner <String> - -TimeZone <Int> - [-Description <String>] - [-Lcid <UInt32>] - [-Template <String>] - [-ResourceQuota <Double>] - [-ResourceQuotaWarningLevel <Double>] - [-StorageQuota <Int>] - [-StorageQuotaWarningLevel <Int>] - [-RemoveDeletedSite [<SwitchParameter>]] - [-Wait [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -The New-PnPTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint -Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner user@example.org -TimeZone 4 -Template STS#0 -``` - -This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00',the owner 'user@example.org' and the template used will be STS#0, a TeamSite - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPTenantSite -Title Contoso -Url /sites/contososite -Owner user@example.org -TimeZone 4 -Template STS#0 -``` - -This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contososite' of which the base part will be picked up from your current connection, the timezone 'UTC+01:00', the owner 'user@example.org' and the template used will be STS#0, a TeamSite - -## PARAMETERS - -### -Description -Specifies the description of the new site collection - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Lcid -Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx. To get the list of supported languages use: (Get-PnPWeb -Includes RegionalSettings.InstalledLanguages).RegionalSettings.InstalledLanguages - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owner -Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -RemoveDeletedSite -Specifies if any existing site with the same URL should be removed from the recycle bin - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ResourceQuota -Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. - -```yaml -Type: Double -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ResourceQuotaWarningLevel -Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter - -```yaml -Type: Double -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StorageQuota -Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StorageQuotaWarningLevel -Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Template -Specifies the site collection template type. Use the Get-PnPWebTemplates cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-PnPWebTemplates cmdlet. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TimeZone -Use Get-PnPTimeZoneId to retrieve possible timezone values - -```yaml -Type: Int -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -Specifies the title of the new site collection - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Wait - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Locale IDs](http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911)[Resource Usage Limits on Sandboxed Solutions in SharePoint 2010](http://msdn.microsoft.com/en-us/library/gg615462.aspx.)[Creating on-premises site collections using CSOM](http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md deleted file mode 100644 index 7dd994f949..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPTenantTemplate - -## SYNOPSIS -Creates a new tenant template object - -## SYNTAX - -```powershell -New-PnPTenantTemplate [-Author <String>] - [-Description <String>] - [-DisplayName <String>] - [-Generator <String>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -$template = New-PnPTenantTemplate -``` - -Creates a new instance of a tenant template object. - -## PARAMETERS - -### -Author - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayName - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Generator - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md deleted file mode 100644 index 0bcd8277ac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPTerm - -## SYNOPSIS -Creates a taxonomy term - -## SYNTAX - -```powershell -New-PnPTerm -Name <String> - -TermSet <Id, Title or TaxonomyItem> - -TermGroup <Id, Title or TermGroup> - [-Id <Guid>] - [-Lcid <Int>] - [-Description <String>] - [-CustomProperties <Hashtable>] - [-LocalCustomProperties <Hashtable>] - [-TermStore <Id, Name or Object>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -Name "Finance" -``` - -Creates a new taxonomy term named "Finance" in the termset Departments which is located in the "Corporate" termgroup - -## PARAMETERS - -### -CustomProperties -Custom Properties - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -Descriptive text to help users understand the intended use of this term. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Id -The Id to use for the term; if not specified, or the empty GUID, a random GUID is generated and used. - -```yaml -Type: Guid -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Lcid -The locale id to use for the term. Defaults to the current locale id. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LocalCustomProperties -Custom Properties - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -The name of the term. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -TermGroup -The termgroup to create the term in. - -```yaml -Type: Id, Title or TermGroup -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -TermSet -The termset to add the term to. - -```yaml -Type: Id, Title or TaxonomyItem -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TermStore -Term store to check; if not specified the default term store is used. - -```yaml -Type: Id, Name or Object -Parameter Sets: __AllParameterSets -Aliases: TermStoreName - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.Term - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md deleted file mode 100644 index e4d952f35e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPTermGroup - -## SYNOPSIS -Creates a taxonomy term group - -## SYNTAX - -```powershell -New-PnPTermGroup -Name <String> - [-Id <Guid>] - [-Description <String>] - [-TermStore <Id, Name or Object>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPTermGroup -GroupName "Countries" -``` - -Creates a new taxonomy term group named "Countries" - -## PARAMETERS - -### -Description -Description to use for the term group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Id -GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: GroupId - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -Name of the taxonomy term group to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: GroupName - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -TermStore -Term store to add the group to; if not specified the default term store is used. - -```yaml -Type: Id, Name or Object -Parameter Sets: (All) -Aliases: TermStoreName - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TermGroup - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md deleted file mode 100644 index 3cba7e7719..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPTermSet - -## SYNOPSIS -Creates a taxonomy term set - -## SYNTAX - -```powershell -New-PnPTermSet -Name <String> - -TermGroup <Id, Title or TermGroup> - [-Id <Guid>] - [-Lcid <Int>] - [-Contact <String>] - [-Description <String>] - [-IsOpenForTermCreation [<SwitchParameter>]] - [-IsNotAvailableForTagging [<SwitchParameter>]] - [-Owner <String>] - [-StakeHolders <String[]>] - [-CustomProperties <Hashtable>] - [-TermStore <Id, Name or Object>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPTermSet -Name "Department" -TermGroup "Corporate" -``` - -Creates a new termset named "Department" in the group named "Corporate" - -## PARAMETERS - -### -Contact -An e-mail address for term suggestion and feedback. If left blank the suggestion feature will be disabled. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CustomProperties - - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -Descriptive text to help users understand the intended use of this term set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Id -The Id to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used. - -```yaml -Type: Guid -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IsNotAvailableForTagging -By default a term set is available to be used by end users and content editors of sites consuming this term set. Specify this switch to turn this off - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IsOpenForTermCreation -When a term set is closed, only metadata managers can add terms to this term set. When it is open, users can add terms from a tagging application. Not specifying this switch will make the term set closed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Lcid -The locale id to use for the term set. Defaults to the current locale id. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -The name of the termset. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Owner -The primary user or group of this term set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StakeHolders -People and groups in the organization that should be notified before major changes are made to the term set. You can enter multiple users or groups. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermGroup -Name, id or actualy termgroup to create the termset in. - -```yaml -Type: Id, Title or TermGroup -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -TermStore -Term store to check; if not specified the default term store is used. - -```yaml -Type: Id, Name or Object -Parameter Sets: (All) -Aliases: TermStoreName - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Taxonomy.TermSet - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md deleted file mode 100644 index 5a275dfea8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPUPABulkImportJob - -## SYNOPSIS -Submit up a new user profile bulk import job. - -## SYNTAX - -```powershell -New-PnPUPABulkImportJob -Folder <String> - -Path <String> - -UserProfilePropertyMapping <Hashtable> - -IdProperty <String> - [-IdType <ImportProfilePropertiesUserIdType>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/bulk-user-profile-update-api-for-sharepoint-online for information on the API and how the bulk import process works. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -@" - { - "value": [ - { - "IdName": "mikaels@contoso.com", - "Department": "PnP", - }, - { - "IdName": "vesaj@contoso.com", - "Department": "PnP", - } - ] -} -"@ > profiles.json - -New-PnPUPABulkImportJob -Folder "Shared Documents" -Path profiles.json -IdProperty "IdName" -UserProfilePropertyMapping @{"Department"="Department"} -``` - -This will submit a new user profile bulk import job to SharePoint Online. - -## PARAMETERS - -### -Folder -Site or server relative URL of the folder to where you want to store the import job file. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -IdProperty -The name of the identifying property in your file. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 3 -Accept pipeline input: False -``` - -### -IdType -The type of profile identifier (Email/CloudId/PrincipalName). Defaults to Email. - -```yaml -Type: ImportProfilePropertiesUserIdType -Parameter Sets: (All) - -Required: False -Position: 4 -Accept pipeline input: False -``` - -### -Path -The local file path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -UserProfilePropertyMapping -Specify user profile property mapping between the import file and UPA property names. - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: True -Position: 2 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md deleted file mode 100644 index 113c470c9d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# New-PnPUnifiedGroup - -## SYNOPSIS -Creates a new Office 365 Group (aka Unified Group) - -## SYNTAX - -```powershell -New-PnPUnifiedGroup -DisplayName <String> - -Description <String> - -MailNickname <String> - [-Owners <String[]>] - [-Members <String[]>] - [-IsPrivate [<SwitchParameter>]] - [-GroupLogoPath <String>] - [-Force [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -``` - -Creates a public Office 365 Group with all the required properties - -### ------------------EXAMPLE 2------------------ -```powershell -New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -Owners $arrayOfOwners -Members $arrayOfMembers -``` - -Creates a public Office 365 Group with all the required properties, and with a custom list of Owners and a custom list of Members - -### ------------------EXAMPLE 3------------------ -```powershell -New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -IsPrivate -``` - -Creates a private Office 365 Group with all the required properties - -### ------------------EXAMPLE 4------------------ -```powershell -New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -Owners $arrayOfOwners -Members $arrayOfMembers -IsPrivate -``` - -Creates a private Office 365 Group with all the required properties, and with a custom list of Owners and a custom list of Members - -## PARAMETERS - -### -Description -The Description of the Office 365 Group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DisplayName -The Display Name of the Office 365 Group. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -GroupLogoPath -The path to the logo file of to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IsPrivate -Makes the group private when selected. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MailNickname -The Mail Nickname of the Office 365 Group. Cannot contain spaces. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Members -The array UPN values of the group's members. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owners -The array UPN values of the group's owners. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md deleted file mode 100644 index 9d76ae0d88..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPUser - -## SYNOPSIS -Adds a user to the built-in Site User Info List and returns a user object - -## SYNTAX - -```powershell -New-PnPUser -LoginName <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPUser -LoginName user@company.com -``` - -Adds a new user with the login user@company.com to the current site - -## PARAMETERS - -### -LoginName -The users login name (user@company.com) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: LogonName - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.User - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md deleted file mode 100644 index 00c2a057ea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# New-PnPWeb - -## SYNOPSIS -Creates a new subweb under the current web - -## SYNTAX - -```powershell -New-PnPWeb -Title <String> - -Url <String> - -Template <String> - [-Description <String>] - [-Locale <Int>] - [-BreakInheritance [<SwitchParameter>]] - [-InheritNavigation [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -New-PnPWeb -Title "Project A Web" -Url projectA -Description "Information about Project A" -Locale 1033 -Template "STS#0" -``` - -Creates a new subweb under the current web with URL projectA - -## PARAMETERS - -### -BreakInheritance -By default the subweb will inherit its security from its parent, specify this switch to break this inheritance - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description of the new web - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -InheritNavigation -Specifies whether the site inherits navigation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Locale -The language id of the new web. default = 1033 for English - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Template -The site definition template to use for the new web, e.g. STS#0. Use Get-PnPWebTemplates to fetch a list of available templates - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the new web - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Url -The URL of the new web - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Web - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md deleted file mode 100644 index e3f09450cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Publish-PnPApp - -## SYNOPSIS -Publishes/Deploys/Trusts an available app in the app catalog - -## SYNTAX - -```powershell -Publish-PnPApp -Identity <AppMetadataPipeBind> - [-SkipFeatureDeployment [<SwitchParameter>]] - [-Scope <AppCatalogScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Publish-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f -``` - -This will deploy/trust an app into the app catalog. Notice that the app needs to be available in the tenant scoped app catalog - -### ------------------EXAMPLE 2------------------ -```powershell -Publish-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f -Scope Site -``` - -This will deploy/trust an app into the app catalog. Notice that the app needs to be available in the site collection scoped app catalog - -## PARAMETERS - -### -Identity -Specifies the Id of the app - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SkipFeatureDeployment - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md deleted file mode 100644 index b894a531e0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Read-PnPProvisioningTemplate - -## SYNOPSIS -Loads/Reads a PnP file from the file system - -## SYNTAX - -```powershell -Read-PnPProvisioningTemplate -Path <String> - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Read-PnPProvisioningTemplate -Path template.pnp -``` - -Loads a PnP file from the file system - -### ------------------EXAMPLE 2------------------ -```powershell -Read-PnPProvisioningTemplate -Path template.pnp -TemplateProviderExtensions $extensions -``` - -Loads a PnP file from the file system using some custom template provider extenions while loading the file. - -## PARAMETERS - -### -Path -Filename to read from, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while loading the template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md deleted file mode 100644 index e4ebc14a32..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Read-PnPTenantTemplate - -## SYNOPSIS -Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template. - -## SYNTAX - -```powershell -Read-PnPTenantTemplate -Path <String> - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Read-PnPTenantTemplate -Path template.pnp -``` - -Reads a PnP tenant templatey file from the file system and returns an in-memory instance - -## PARAMETERS - -### -Path -Filename to read from, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while loading the template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md deleted file mode 100644 index 0c4dcd8bff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Register-PnPHubSite - -## SYNOPSIS -Registers a site as a hubsite - -## SYNTAX - -```powershell -Register-PnPHubSite -Site <SitePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Registers a site as a hubsite - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Register-PnPHubSite -Site https://tenant.sharepoint.com/sites/myhubsite -``` - -This example registers the specified site as a hubsite - -## PARAMETERS - -### -Site -The site to register as a hubsite - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md deleted file mode 100644 index 8417bb9127..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPApp - -## SYNOPSIS -Removes an app from the app catalog - -## SYNTAX - -```powershell -Remove-PnPApp -Identity <AppMetadataPipeBind> - [-Scope <AppCatalogScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will remove the specified app from the tenant scoped app catalog - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site -``` - -This will remove the specified app from the site collection scoped app catalog - -## PARAMETERS - -### -Identity -Specifies the Id of the Addin Instance - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md deleted file mode 100644 index be5a958334..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPClientSideComponent - -## SYNOPSIS -Removes a Client-Side component from a page - -## SYNTAX - -```powershell -Remove-PnPClientSideComponent -Page <ClientSidePagePipeBind> - -InstanceId <GuidPipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -``` - -Removes the control specified from the page. - -## PARAMETERS - -### -Force -If specified you will not receive the confirmation question - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -InstanceId -The instance id of the component - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Page -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md deleted file mode 100644 index d98922e1a9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPClientSidePage - -## SYNOPSIS -Removes a Client-Side Page - -## SYNTAX - -```powershell -Remove-PnPClientSidePage -Identity <ClientSidePagePipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPClientSidePage -Identity "MyPage" -``` - -Removes the Client-Side page named 'MyPage.aspx' - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPClientSidePage $page -``` - -Removes the specified Client-Side page which is contained in the $page variable. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md deleted file mode 100644 index 1b1f5237cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPContentType - -## SYNOPSIS -Removes a content type from a web - -## SYNTAX - -```powershell -Remove-PnPContentType -Identity <ContentTypePipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPContentType -Identity "Project Document" -``` - -This will remove a content type called "Project Document" from the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPContentType -Identity "Project Document" -Force -``` - -This will remove a content type called "Project Document" from the current web with force - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The name or ID of the content type to remove - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md deleted file mode 100644 index 427048a9e0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPContentTypeFromDocumentSet - -## SYNOPSIS -Removes a content type from a document set - -## SYNTAX - -```powershell -Remove-PnPContentTypeFromDocumentSet -ContentType <ContentTypePipeBind> - -DocumentSet <DocumentSetPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPContentTypeFromDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set" -``` - -This will remove the content type called 'Test CT' from the document set called ''Test Document Set' - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPContentTypeFromDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B -``` - -This will remove the content type with ID '0x0101001F1CEFF1D4126E4CAD10F00B6137E969' from the document set with ID '0x0120D520005DB65D094035A241BAC9AF083F825F3B' - -## PARAMETERS - -### -ContentType -The content type to remove. Either specify name, an id, or a content type object. - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DocumentSet -The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object - -```yaml -Type: DocumentSetPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md deleted file mode 100644 index b8aef8b839..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPContentTypeFromList - -## SYNOPSIS -Removes a content type from a list - -## SYNTAX - -```powershell -Remove-PnPContentTypeFromList -List <ListPipeBind> - -ContentType <ContentTypePipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPContentTypeFromList -List "Documents" -ContentType "Project Document" -``` - -This will remove a content type called "Project Document" from the "Documents" list - -## PARAMETERS - -### -ContentType -The name of a content type, its ID or an actual content type object that needs to be removed from the specified list. - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The name of the list, its ID or an actual list object from where the content type needs to be removed from - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md deleted file mode 100644 index 31d4c5e904..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPCustomAction - -## SYNOPSIS -Removes a custom action - -## SYNTAX - -```powershell -Remove-PnPCustomAction [-Identity <UserCustomActionPipeBind>] - [-Scope <CustomActionScope>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -``` - -Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web -``` - -Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' from the current web. - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -Force -``` - -Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' without asking for confirmation. - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPCustomAction -Scope All | ? Location -eq ScriptLink | Remove-PnPCustomAction -``` - -Removes all custom actions that are ScriptLinks - -## PARAMETERS - -### -Force -Use the -Force flag to bypass the confirmation question - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The id or name of the CustomAction that needs to be removed or a CustomAction instance itself - -```yaml -Type: UserCustomActionPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection. - -```yaml -Type: CustomActionScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md deleted file mode 100644 index d7cbabefd6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPEventReceiver - -## SYNOPSIS -Remove an eventreceiver - -## SYNTAX - -### List -```powershell -Remove-PnPEventReceiver -Identity <EventReceiverPipeBind> - [-List <ListPipeBind>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Removes/unregisters a specific eventreceiver - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -``` - -This will remove the event receiver with ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPEventReceiver -List ProjectList -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -``` - -This will remove the event receiver with ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the "ProjectList" list - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPEventReceiver -List ProjectList -Identity MyReceiver -``` - -This will remove the event receiver with ReceiverName "MyReceiver" from the "ProjectList" list - -### ------------------EXAMPLE 4------------------ -```powershell -Remove-PnPEventReceiver -List ProjectList -``` - -This will remove all event receivers from the "ProjectList" list - -### ------------------EXAMPLE 5------------------ -```powershell -Remove-PnPEventReceiver -``` - -This will remove all event receivers from the current site - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPEventReceiver | ? ReceiverUrl -Like "*azurewebsites.net*" | Remove-PnPEventReceiver -``` - -This will remove all event receivers from the current site which are pointing to a service hosted on Azure Websites - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The Guid of the event receiver on the list - -```yaml -Type: EventReceiverPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -List -The list object from where to remove the event receiver object - -```yaml -Type: ListPipeBind -Parameter Sets: List - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md deleted file mode 100644 index 9c4baea634..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPField - -## SYNOPSIS -Removes a field from a list or a site - -## SYNTAX - -```powershell -Remove-PnPField -Identity <FieldPipeBind> - [-Force [<SwitchParameter>]] - [-List <ListPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPField -Identity "Speakers" -``` - -Removes the speakers field from the site columns - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPField -List "Demo list" -Identity "Speakers" -``` - -Removes the speakers field from the list Demo list - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The field object or name to remove - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -List -The list object or name where to remove the field from - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: 1 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md deleted file mode 100644 index c830d58dbf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPFieldFromContentType - -## SYNOPSIS -Removes a site column from a content type - -## SYNTAX - -```powershell -Remove-PnPFieldFromContentType -Field <FieldPipeBind> - -ContentType <ContentTypePipeBind> - [-DoNotUpdateChildren [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPFieldFromContentType -Field "Project_Name" -ContentType "Project Document" -``` - -This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document" - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPFieldFromContentType -Field "Project_Name" -ContentType "Project Document" -DoNotUpdateChildren -``` - -This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document". It will not update content types that inherit from the "Project Document" content type. - -## PARAMETERS - -### -ContentType -The content type where the field is to be removed from - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -DoNotUpdateChildren -If specified, inherited content types will not be updated - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Field -The field to remove - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md deleted file mode 100644 index 1f2f5c9822..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPFile - -## SYNOPSIS -Removes a file. - -## SYNTAX - -### Server Relative -```powershell -Remove-PnPFile -ServerRelativeUrl <String> - [-Recycle [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Site Relative -```powershell -Remove-PnPFile -SiteRelativeUrl <String> - [-Recycle [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -PS:>Remove-PnPFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor -``` - -Removes the file company.spcolor - -### ------------------EXAMPLE 2------------------ -```powershell -PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor -``` - -Removes the file company.spcolor - -### ------------------EXAMPLE 3------------------ -```powershell -PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor -Recycle -``` - -Removes the file company.spcolor and saves it to the Recycle Bin - -## PARAMETERS - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Recycle - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativeUrl -Server relative URL to the file - -```yaml -Type: String -Parameter Sets: Server Relative - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SiteRelativeUrl -Site relative URL to the file - -```yaml -Type: String -Parameter Sets: Site Relative - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md deleted file mode 100644 index ac29880fe5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPFileFromProvisioningTemplate - -## SYNOPSIS -Removes a file from a PnP Provisioning Template - -## SYNTAX - -```powershell -Remove-PnPFileFromProvisioningTemplate -Path <String> - -FilePath <String> - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPFileFromProvisioningTemplate -Path template.pnp -FilePath filePath -``` - -Removes a file from an in-memory PnP Provisioning Template - -## PARAMETERS - -### -FilePath -The relative File Path of the file to remove from the in-memory template - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Path -Filename to read the template from, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while saving the template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: 2 -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md deleted file mode 100644 index a78ec933ec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPFolder - -## SYNOPSIS -Deletes a folder within a parent folder - -## SYNTAX - -```powershell -Remove-PnPFolder -Name <String> - -Folder <String> - [-Recycle [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage -``` - -Removes the folder 'NewFolder' from '_catalogsmasterpage' - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage -Recycle -``` - -Removes the folder 'NewFolder' from '_catalogsmasterpage' and is saved in the Recycle Bin - -## PARAMETERS - -### -Folder -The parent folder in the site - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -The folder name - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Recycle - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md deleted file mode 100644 index cf9518db25..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPGroup - -## SYNOPSIS -Removes a group from a web. - -## SYNTAX - -```powershell -Remove-PnPGroup [-Identity <GroupPipeBind>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPGroup -Identity "My Users" -``` - -Removes the group "My Users" - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -A group object, an ID or a name of a group to remove - -```yaml -Type: GroupPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md deleted file mode 100644 index 70f1d00cb4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPHubSiteAssociation - -## SYNOPSIS -Disconnects a site from a hubsite. - -## SYNTAX - -```powershell -Remove-PnPHubSiteAssociation -Site <SitePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Disconnects an site from a hubsite - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -``` - -This example adds the specified site to the hubsite. - -## PARAMETERS - -### -Site -The site to disconnect from its hubsite - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md deleted file mode 100644 index d6f81f7afb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPIndexedProperty - -## SYNOPSIS -Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore. - -## SYNTAX - -```powershell -Remove-PnPIndexedProperty -Key <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPIndexedProperty -key "MyIndexProperty" -``` - -Removes the Indexed property "MyIndexProperty" from the current web - -## PARAMETERS - -### -Key -Key of the property bag value to be removed from indexing - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md deleted file mode 100644 index 5c2eeb8d8b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPJavaScriptLink - -## SYNOPSIS -Removes a JavaScript link or block from a web or sitecollection - -## SYNTAX - -```powershell -Remove-PnPJavaScriptLink [-Identity <UserCustomActionPipeBind>] - [-Force [<SwitchParameter>]] - [-Scope <CustomActionScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPJavaScriptLink -Identity jQuery -``` - -Removes the injected JavaScript file with the name jQuery from the current web after confirmation - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPJavaScriptLink -Identity jQuery -Scope Site -``` - -Removes the injected JavaScript file with the name jQuery from the current site collection after confirmation - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPJavaScriptLink -Identity jQuery -Scope Site -Confirm:$false -``` - -Removes the injected JavaScript file with the name jQuery from the current site collection and will not ask for confirmation - -### ------------------EXAMPLE 4------------------ -```powershell -Remove-PnPJavaScriptLink -Scope Site -``` - -Removes all the injected JavaScript files from the current site collection after confirmation for each of them - -### ------------------EXAMPLE 5------------------ -```powershell -Remove-PnPJavaScriptLink -Identity faea0ce2-f0c2-4d45-a4dc-73898f3c2f2e -Scope All -``` - -Removes the injected JavaScript file with id faea0ce2-f0c2-4d45-a4dc-73898f3c2f2e from both the Web and Site scopes - -### ------------------EXAMPLE 6------------------ -```powershell -Get-PnPJavaScriptLink -Scope All | ? Sequence -gt 1000 | Remove-PnPJavaScriptLink -``` - -Removes all the injected JavaScript files from both the Web and Site scope that have a sequence number higher than 1000 - -## PARAMETERS - -### -Force -Use the -Force flag to bypass the confirmation question - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Name or id of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links. - -```yaml -Type: UserCustomActionPipeBind -Parameter Sets: (All) -Aliases: Key,Name - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection. - -```yaml -Type: CustomActionScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md deleted file mode 100644 index 22209a8c8d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPList - -## SYNOPSIS -Deletes a list - -## SYNTAX - -```powershell -Remove-PnPList -Identity <ListPipeBind> - [-Recycle [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPList -Identity Announcements -``` - -Removes the list named 'Announcements'. Asks for confirmation. - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPList -Identity Announcements -Force -``` - -Removes the list named 'Announcements' without asking for confirmation. - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPList -Title Announcements -Recycle -``` - -Removes the list named 'Announcements' and saves to the Recycle Bin - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID or Title of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Recycle -Defines if the list should be moved to recycle bin or directly deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md deleted file mode 100644 index 4b6c584b16..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPListItem - -## SYNOPSIS -Deletes an item from a list - -## SYNTAX - -```powershell -Remove-PnPListItem -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-Recycle [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPListItem -List "Demo List" -Identity "1" -Force -``` - -Removes the listitem with id "1" from the "Demo List" list. - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPListItem -List "Demo List" -Identity "1" -Force -Recycle -``` - -Removes the listitem with id "1" from the "Demo List" list and saves it in the Recycle Bin. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Recycle - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md deleted file mode 100644 index 8a0ff1be30..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPNavigationNode - -## SYNOPSIS -Removes a menu item from either the quicklaunch or top navigation - -## SYNTAX - -### Remove a node by ID -```powershell -Remove-PnPNavigationNode -Identity <NavigationNodePipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### All Nodes -```powershell -Remove-PnPNavigationNode -All [<SwitchParameter>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPNavigationNode -Identity 1032 -``` - -Removes the navigation node with the specified id - -### ------------------EXAMPLE 2------------------ -```powershell -$nodes = Get-PnPNavigationNode -QuickLaunch -PS:>$nodes | Select-Object -First 1 | Remove-PnPNavigationNode -Force -``` - -Retrieves all navigation nodes from the Quick Launch navigation, then removes the first node in the list and it will not ask for a confirmation - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPNavigationNode -Title Recent -Location QuickLaunch -``` - -Will remove the recent navigation node from the quick launch in the current web. - -### ------------------EXAMPLE 4------------------ -```powershell -Remove-PnPNavigationNode -Title Home -Location TopNavigationBar -Force -``` - -Will remove the home navigation node from the top navigation bar without prompting for a confirmation in the current web. - -### ------------------EXAMPLE 5------------------ -```powershell -Remove-PnPNavigationNode -Location QuickLaunch -All -``` - -Will remove all the navigation nodes from the quick launch bar in the current web. - -## PARAMETERS - -### -All -Specifying the All parameter will remove all the nodes from specifed Location. - -```yaml -Type: SwitchParameter -Parameter Sets: All Nodes - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The Id or node object to delete - -```yaml -Type: NavigationNodePipeBind -Parameter Sets: Remove a node by ID - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md deleted file mode 100644 index 2108b9d35c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPPropertyBagValue - -## SYNOPSIS -Removes a value from the property bag - -## SYNTAX - -```powershell -Remove-PnPPropertyBagValue -Key <String> - [-Folder <String>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPPropertyBagValue -Key MyKey -``` - -This will remove the value with key MyKey from the current web property bag - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPPropertyBagValue -Key MyKey -Folder /MyFolder -``` - -This will remove the value with key MyKey from the folder MyFolder which is located in the root folder of the current web - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPPropertyBagValue -Key MyKey -Folder / -``` - -This will remove the value with key MyKey from the root folder of the current web - -## PARAMETERS - -### -Folder -Site relative url of the folder. See examples for use. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Key -Key of the property bag value to be removed - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md deleted file mode 100644 index 98899304fb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPPublishingImageRendition - -## SYNOPSIS -Removes an existing image rendition - -## SYNTAX - -```powershell -Remove-PnPPublishingImageRendition -Identity <ImageRenditionPipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600 -``` - - - -## PARAMETERS - -### -Force -If provided, no confirmation will be asked to remove the Image Rendition. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The display name or id of the Image Rendition. - -```yaml -Type: ImageRenditionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md deleted file mode 100644 index 2db23eacab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPRoleDefinition - -## SYNOPSIS -Remove a Role Definition from a site - -## SYNTAX - -```powershell -Remove-PnPRoleDefinition -Identity <RoleDefinitionPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPRoleDefinition -Identity MyRoleDefinition -``` - -Removes the specified Role Definition (Permission Level) from the current site - -## PARAMETERS - -### -Force -Do not ask for confirmation to delete the role definition - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The identity of the role definition, either a RoleDefinition object or a the name of roledefinition - -```yaml -Type: RoleDefinitionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md deleted file mode 100644 index 2bd5a63146..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPSiteClassification - -## SYNOPSIS -Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph - -## SYNTAX - -```powershell -Remove-PnPSiteClassification -Classifications <String> - [-Confirm [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Remove-PnPSiteClassification -Classifications "HBI" -``` - -Removes the "HBI" site classification from the list of available values. - -### ------------------EXAMPLE 2------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Remove-PnPSiteClassification -Classifications "HBI", "Top Secret" -``` - -Removes the "HBI" site classification from the list of available values. - -## PARAMETERS - -### -Classifications - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Confirm -Specifying the Confirm parameter will allow the confirmation question to be skipped - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md deleted file mode 100644 index 16ca0096aa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPSiteCollectionAdmin - -## SYNOPSIS -Removes one or more users as site collection administrators from the site collection in the current context - -## SYNTAX - -```powershell -Remove-PnPSiteCollectionAdmin -Owners <UserPipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command allows removing one to many users as site collection administrators from the site collection in the current context. All existing site collection administrators not included in this command will remain site collection administrator. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com" -``` - -This will remove user@contoso.onmicrosoft.com as a site collection owner from the site collection in the current context - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") -``` - -This will remove user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as site collection owners from the site collection in the current context - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPUser | ? Title -Like "*Doe" | Remove-PnPSiteCollectionAdmin -``` - -This will remove all users with their title ending with "Doe" as site collection owners from the site collection in the current context - -### ------------------EXAMPLE 4------------------ -```powershell -Get-PnPSiteCollectionAdmin | Remove-PnPSiteCollectionAdmin -``` - -This will remove all existing site collection administrators from the site collection in the current context - -## PARAMETERS - -### -Owners -Specifies owner(s) to remove as site collection adminstrators. Can be both users and groups. - -```yaml -Type: UserPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md deleted file mode 100644 index 08852c3c9b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPSiteCollectionAppCatalog - -## SYNOPSIS -Removes a Site Collection scoped App Catalog from a site - -## SYNTAX - -```powershell -Remove-PnPSiteCollectionAppCatalog -Site <SitePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Notice that this will not remove the App Catalog list and its contents from the site. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPOffice365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" -``` - -This will remove a SiteCollection app catalog from the specified site - -## PARAMETERS - -### -Site -Url of the site to remove the app catalog from. - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md deleted file mode 100644 index 4517f35036..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPSiteDesign - -## SYNOPSIS -Removes a Site Design - -## SYNTAX - -```powershell -Remove-PnPSiteDesign -Identity <TenantSiteDesignPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -``` - -Removes the specified site design - -## PARAMETERS - -### -Force -If specified you will not be asked to confirm removing the specified Site Design - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the site design to remove - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md deleted file mode 100644 index 9ae292af03..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPSiteScript - -## SYNOPSIS -Removes a Site Script - -## SYNTAX - -```powershell -Remove-PnPSiteScript -Identity <TenantSiteScriptPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -``` - -Removes the specified site script - -## PARAMETERS - -### -Force -If specified you will not be asked to confirm removing the specified Site Script - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the Site Script to remove - -```yaml -Type: TenantSiteScriptPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md deleted file mode 100644 index 8cebff5f3e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPStorageEntity - -## SYNOPSIS -Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog - -## SYNTAX - -```powershell -Remove-PnPStorageEntity -Key <String> - [-Scope <StorageEntityScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPStorageEntity -Key MyKey -``` - -Removes an existing storage entity / farm property - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPStorageEntity -Key MyKey -Scope Site -``` - -Removes an existing storage entity from the current site collection - -## PARAMETERS - -### -Key -The key of the value to remove. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope -Defines the scope of the storage entity. Defaults to Tenant. - -```yaml -Type: StorageEntityScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md deleted file mode 100644 index 272effd06b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPStoredCredential - -## SYNOPSIS -Removes a credential - -## SYNTAX - -```powershell -Remove-PnPStoredCredential -Name <String> - [-Force [<SwitchParameter>]] -``` - -## DESCRIPTION -Removes a stored credential from the Windows Credential Manager - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPStoredCredential -Name https://tenant.sharepoint.com -``` - -Removes the specified credential from the Windows Credential Manager - -## PARAMETERS - -### -Force -If specified you will not be asked for confirmation - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -The credential to remove - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md deleted file mode 100644 index 8d9df8b9a0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPTaxonomyItem - -## SYNOPSIS -Removes a taxonomy item - -## SYNTAX - -```powershell -Remove-PnPTaxonomyItem -TermPath <String> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TermPath -The path, delimited by | of the taxonomy item to remove, alike GROUPLABEL|TERMSETLABEL|TERMLABEL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Term - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md deleted file mode 100644 index a4c213290e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPTenantCdnOrigin - -## SYNOPSIS -Removes an origin from the Public or Private content delivery network (CDN). - -## SYNTAX - -```powershell -Remove-PnPTenantCdnOrigin -OriginUrl <String> - -CdnType <SPOTenantCdnType> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Removes an origin from the Public or Private content delivery network (CDN). - -You must be a SharePoint Online global administrator to run the cmdlet. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPTenantCdnOrigin -Url /sites/site/subfolder -CdnType Public -``` - -This example removes the specified origin from the public CDN - -## PARAMETERS - -### -CdnType -The cdn type to remove the origin from. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -OriginUrl -The origin to remove. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md deleted file mode 100644 index 24cde56ea7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPTenantSite - -## SYNOPSIS -Removes a site collection - -## SYNTAX - -```powershell -Remove-PnPTenantSite -Url <String> - [-SkipRecycleBin [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Removes a site collection which is listed in your tenant administration site. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -``` - -This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' and put it in the recycle bin. - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin -``` - -This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' with force and it will skip the recycle bin. - -### ------------------EXAMPLE 3------------------ -```powershell -Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin -``` - -This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the recycle bin. - -## PARAMETERS - -### -Force -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SkipRecycleBin -Do not add to the tenant scoped recycle bin when selected. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: SkipTrash - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -Specifies the full URL of the site collection that needs to be deleted - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md deleted file mode 100644 index f928f76ebe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPTenantTheme - -## SYNOPSIS -Removes a theme - -## SYNTAX - -```powershell -Remove-PnPTenantTheme -Identity <ThemePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Removes the specified theme from the tenant configuration - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPTenantTheme -Name "MyCompanyTheme" -``` - -Removes the specified theme. - -## PARAMETERS - -### -Identity -The name of the theme to retrieve - -```yaml -Type: ThemePipeBind -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md deleted file mode 100644 index 5208498068..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPTermGroup - -## SYNOPSIS -Removes a taxonomy term group and all its containing termsets - -## SYNTAX - -```powershell -Remove-PnPTermGroup -GroupName <String> - [-TermStoreName <String>] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -GroupName -Name of the taxonomy term group to delete. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TermStoreName -Term store to use; if not specified the default term store is used. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md deleted file mode 100644 index 977e1033a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPUnifiedGroup - -## SYNOPSIS -Removes one Office 365 Group (aka Unified Group) or a list of Office 365 Groups - -## SYNTAX - -```powershell -Remove-PnPUnifiedGroup -Identity <UnifiedGroupPipeBind> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPUnifiedGroup -Identity $groupId -``` - -Removes an Office 365 Groups based on its ID - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPUnifiedGroup -Identity $group -``` - -Removes the provided Office 365 Groups - -## PARAMETERS - -### -Identity -The Identity of the Office 365 Group. - -```yaml -Type: UnifiedGroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md deleted file mode 100644 index a915bd05d7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPUser - -## SYNOPSIS -Removes a specific user from the site collection User Information List - -## SYNTAX - -```powershell -Remove-PnPUser -Identity <UserPipeBind> - [-Force [<SwitchParameter>]] - [-Confirm [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command will allow the removal of a specific user from the User Information List - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPUser -Identity 23 -``` - -Remove the user with Id 23 from the User Information List of the current site collection - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -``` - -Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPUser | ? Email -eq "user@tenant.onmicrosoft.com" | Remove-PnPUser -``` - -Remove the user with e-mail address user@tenant.onmicrosoft.com from the User Information List of the current site collection - -### ------------------EXAMPLE 4------------------ -```powershell -Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -Confirm:$false -``` - -Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection without asking to confirm the removal first - -## PARAMETERS - -### -Confirm -Specifying the Confirm parameter will allow the confirmation question to be skipped - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Force -Specifying the Force parameter will skip the confirmation question - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -User ID or login name - -```yaml -Type: UserPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.User - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md deleted file mode 100644 index 922454f6ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPUserFromGroup - -## SYNOPSIS -Removes a user from a group - -## SYNTAX - -```powershell -Remove-PnPUserFromGroup -LoginName <String> - -Identity <GroupPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPUserFromGroup -LoginName user@company.com -GroupName 'Marketing Site Members' -``` - -Removes the user user@company.com from the Group 'Marketing Site Members' - -## PARAMETERS - -### -Identity -A group object, an ID or a name of a group - -```yaml -Type: GroupPipeBind -Parameter Sets: (All) -Aliases: GroupName - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -LoginName -A valid login name of a user (user@company.com) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: LogonName - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md deleted file mode 100644 index 3650d76f7c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPView - -## SYNOPSIS -Deletes a view from a list - -## SYNTAX - -```powershell -Remove-PnPView -Identity <ViewPipeBind> - -List <ListPipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPView -List "Demo List" -Identity "All Items" -``` - -Removes the view with title "All Items" from the "Demo List" list. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID or Title of the view. - -```yaml -Type: ViewPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -List -The ID or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md deleted file mode 100644 index 239fa58d61..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPWeb - -## SYNOPSIS -Removes a subweb in the current web - -## SYNTAX - -### ByUrl -```powershell -Remove-PnPWeb -Url <String> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### ByIdentity -```powershell -Remove-PnPWeb -Identity <WebPipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPWeb -Url projectA -``` - -Remove a web - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPWeb -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0 -``` - -Remove a web specified by its ID - -### ------------------EXAMPLE 3------------------ -```powershell -Get-PnPSubWebs | Remove-PnPWeb -Force -``` - -Remove all subwebs and do not ask for confirmation - -## PARAMETERS - -### -Force -Do not ask for confirmation to delete the subweb - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Identity/Id/Web object to delete - -```yaml -Type: WebPipeBind -Parameter Sets: ByIdentity - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Url -The site relative url of the web, e.g. 'Subweb1' - -```yaml -Type: String -Parameter Sets: ByUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md deleted file mode 100644 index 5e7ac4256c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPWebPart - -## SYNOPSIS -Removes a webpart from a page - -## SYNTAX - -### ID -```powershell -Remove-PnPWebPart -Identity <GuidPipeBind> - -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### NAME -```powershell -Remove-PnPWebPart -Title <String> - -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 -``` - -This will remove the webpart specified by ID to the specified page in the first row and the first column of the HTML table present on the page - -### ------------------EXAMPLE 2------------------ -```powershell -Remove-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Title MyWebpart -``` - -This will remove the webpart specified by title to the specified page in the first row and the first column of the HTML table present on the page - -## PARAMETERS - -### -Identity -The Guid of the webpart - -```yaml -Type: GuidPipeBind -Parameter Sets: ID - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx - -```yaml -Type: String -Parameter Sets: __AllParameterSets -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -The name of the webpart - -```yaml -Type: String -Parameter Sets: NAME -Aliases: Name - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md deleted file mode 100644 index 691971ab6b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPWebhookSubscription - -## SYNOPSIS -Removes a Webhook subscription from the resource - -## SYNTAX - -```powershell -Remove-PnPWebhookSubscription -Identity <WebhookSubscriptionPipeBind> - [-List <ListPipeBind>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPWebhookSubscription -List MyList -Identity ea1533a8-ff03-415b-a7b6-517ee50db8b6 -``` - -Removes the Webhook subscription with the specified id from the list MyList - -### ------------------EXAMPLE 2------------------ -```powershell -$subscriptions = Get-PnPWebhookSubscriptions -List MyList -Remove-PnPWebhookSubscription -Identity $subscriptions[0] -List MyList -``` - -Removes the first Webhook subscription from the list MyList - -### ------------------EXAMPLE 3------------------ -```powershell -$subscriptions = Get-PnPWebhookSubscriptions -List MyList -$subscriptions[0] | Remove-PnPWebhookSubscription -List MyList -``` - -Removes the first Webhook subscription from the list MyList - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The identity of the Webhook subscription to remove - -```yaml -Type: WebhookSubscriptionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -List -The list object or name which the Webhook subscription will be removed from - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Entities.WebhookSubscription - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md deleted file mode 100644 index 356125ccc3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPWikiPage - -## SYNOPSIS -Removes a wiki page - -## SYNTAX - -### SERVER -```powershell -Remove-PnPWikiPage -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### SITE -```powershell -Remove-PnPWikiPage -SiteRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPWikiPage -PageUrl '/pages/wikipage.aspx' -``` - -Removes the page '/pages/wikipage.aspx' - -## PARAMETERS - -### -ServerRelativePageUrl - - -```yaml -Type: String -Parameter Sets: SERVER -Aliases: PageUrl - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SiteRelativePageUrl - - -```yaml -Type: String -Parameter Sets: SITE - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md deleted file mode 100644 index 7b2a6c762c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPWorkflowDefinition - -## SYNOPSIS -Removes a workflow definition - -## SYNTAX - -```powershell -Remove-PnPWorkflowDefinition -Identity <WorkflowDefinitionPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPWorkflowDefinition -Identity $wfDef -``` - -Removes the workflow, retrieved by Get-PnPWorkflowDefinition, from the site. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWorkflowDefinition -Name MyWorkflow | Remove-PnPWorkflowDefinition -``` - -Get the workflow MyWorkFlow and remove from the site. - -## PARAMETERS - -### -Identity -The definition to remove - -```yaml -Type: WorkflowDefinitionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md deleted file mode 100644 index 63c7bf0977..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Remove-PnPWorkflowSubscription - -## SYNOPSIS -Remove workflow subscription - -## SYNTAX - -```powershell -Remove-PnPWorkflowSubscription -Identity <WorkflowSubscriptionPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Removes a previously registered workflow subscription - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Remove-PnPWorkflowSubscription -identity $wfSub -``` - -Removes the workflowsubscription, retrieved by Get-PnPWorkflowSubscription. - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPWorkflowSubscription -Name MyWorkflow | Remove-PnPWorkflowSubscription -``` - -Get the workflowSubscription MyWorkFlow and remove it. - -## PARAMETERS - -### -Identity -The subscription to remove - -```yaml -Type: WorkflowSubscriptionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md deleted file mode 100644 index 424e4fc931..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Rename-PnPFile - -## SYNOPSIS -Renames a file in its current location - -## SYNTAX - -### SERVER -```powershell -Rename-PnPFile -ServerRelativeUrl <String> - -TargetFileName <String> - [-OverwriteIfAlreadyExists [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### SITE -```powershell -Rename-PnPFile -SiteRelativeUrl <String> - -TargetFileName <String> - [-OverwriteIfAlreadyExists [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -PS:>Rename-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetFileName mycompany.docx -``` - -Renames a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to mycompany.docx. If a file named mycompany.aspx already exists, it won't perform the rename. - -### ------------------EXAMPLE 2------------------ -```powershell -PS:>Rename-PnPFile -SiteRelativeUrl Documents/company.aspx -TargetFileName mycompany.docx -``` - -Renames a file named company.docx located in the document library called Documents located in the current site to mycompany.aspx. If a file named mycompany.aspx already exists, it won't perform the rename. - -### ------------------EXAMPLE 3------------------ -```powershell -PS:>Rename-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetFileName mycompany.docx -OverwriteIfAlreadyExists -``` - -Renames a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to mycompany.aspx. If a file named mycompany.aspx already exists, it will still perform the rename and replace the original mycompany.aspx file. - -## PARAMETERS - -### -Force -If provided, no confirmation will be requested and the action will be performed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OverwriteIfAlreadyExists -If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If ommitted, the rename operation will be canceled if a file already exists with the TargetFileName file name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativeUrl -Server relative Url specifying the file to rename. Must include the file name. - -```yaml -Type: String -Parameter Sets: SERVER - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SiteRelativeUrl -Site relative Url specifying the file to rename. Must include the file name. - -```yaml -Type: String -Parameter Sets: SITE - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TargetFileName -File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md deleted file mode 100644 index 5c1130897f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Rename-PnPFolder - -## SYNOPSIS -Renames a folder - -## SYNTAX - -```powershell -Rename-PnPFolder -Folder <String> - -TargetFolderName <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Rename-PnPFolder -Folder Documents/Reports -TargetFolderName 'Archived Reports' -``` - -This will rename the folder Reports in the Documents library to 'Archived Reports' - -## PARAMETERS - -### -Folder -The folder to rename - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TargetFolderName -The new folder name - -Only applicable to: SharePoint Online - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -Only applicable to: SharePoint Online - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md deleted file mode 100644 index 1af626c53a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Request-PnPReIndexList - -## SYNOPSIS -Marks the list for full indexing during the next incremental crawl - -## SYNTAX - -```powershell -Request-PnPReIndexList -Identity <ListPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Request-PnPReIndexList -Identity "Demo List" -``` - - - -## PARAMETERS - -### -Identity -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md deleted file mode 100644 index 60474d487b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Request-PnPReIndexWeb - -## SYNOPSIS -Marks the web for full indexing during the next incremental crawl - -## SYNTAX - -```powershell -Request-PnPReIndexWeb [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md deleted file mode 100644 index d5455a7845..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Resolve-PnPFolder - -## SYNOPSIS -Returns a folder from a given site relative path, and will create it if it does not exist. - -## SYNTAX - -### -```powershell -Resolve-PnPFolder -SiteRelativePath <String> - [-Includes <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Returns a folder from a given site relative path, and will create it if it does not exist. If you do not want the folder to be created, for instance just to test if a folder exists, use Get-PnPFolder - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Resolve-PnPFolder -SiteRelativePath "demofolder/subfolder" -``` - -Creates a folder called subfolder in a folder called demofolder located in the root folder of the site. If the folder hierarchy does not exist, it will be created. - -## PARAMETERS - -### -Includes -Specify properties to include when retrieving objects from the server. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -SiteRelativePath -Site Relative Folder Path - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Web -The web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Folder - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)[Get-PnPFolder](https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/GetPnPFolder.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md deleted file mode 100644 index 2623b3a003..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Restore-PnPTenantRecycleBinItem - -## SYNOPSIS -Restores a site collection from the tenant scoped recycle bin - -## SYNTAX - -```powershell -Restore-PnPTenantRecycleBinItem -Url <String> - [-Wait [<SwitchParameter>]] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -The Reset-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be restored to its original location. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Reset-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -``` - -This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location - -### ------------------EXAMPLE 2------------------ -```powershell -Reset-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait -``` - -This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location and will wait with executing further PowerShell commands until the site collection restore has completed - -## PARAMETERS - -### -Force -If provided, no confirmation will be asked to restore the site collection from the tenant recycle bin - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -Url of the site collection to restore from the tenant recycle bin - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Wait -If provided, the PowerShell execution will halt until the site restore process has completed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md deleted file mode 100644 index 77f3d9b7b6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Restore-PnPRecycleBinItem - -## SYNOPSIS -Restores the provided recycle bin item to its original location - -## SYNTAX - -### Identity -```powershell -Restore-PnPRecycleBinItem -Identity <RecycleBinItemPipeBind> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### All -```powershell -Restore-PnPRecycleBinItem -All [<SwitchParameter>] - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Restore-PnpRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442 -``` - -Restores the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 to its original location - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPRecycleBinItem | ? FileLeafName -like "*.docx" | Restore-PnpRecycleBinItem -``` - -Restores all the items in the first and second stage recycle bins to their original location of which the filename ends with the .docx extension - -## PARAMETERS - -### -All -If provided all items will be stored - -```yaml -Type: SwitchParameter -Parameter Sets: All - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Force -If provided, no confirmation will be asked to restore the recycle bin item - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Id of the recycle bin item or the recycle bin item object itself to restore - -```yaml -Type: RecycleBinItemPipeBind -Parameter Sets: Identity - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md deleted file mode 100644 index 785258c5af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Resume-PnPWorkflowInstance - -## SYNOPSIS -Resume a workflow - -## SYNTAX - -```powershell -Resume-PnPWorkflowInstance -Identity <WorkflowInstancePipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Resumes a previously stopped workflow instance - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Resume-PnPWorkflowInstance -identity $wfInstance -``` - -Resumes the workflow instance, this can be the Guid of the instance or the instance itself. - -## PARAMETERS - -### -Identity -The instance to resume - -```yaml -Type: WorkflowInstancePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md deleted file mode 100644 index 419e110780..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Revoke-PnPSiteDesignRights - -## SYNOPSIS -Revokes the specified principals rights to use the site design. - -## SYNTAX - -```powershell -Revoke-PnPSiteDesignRights -Identity <TenantSiteDesignPipeBind> - -Principals <String[]> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Revoke-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com" -``` - -Revokes rights to the specified principals on the site design specified - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd | Revoke-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com" -``` - -Revokes rights to the specified principals on the site design specified - -## PARAMETERS - -### -Identity -The site design to use. - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Principals -One or more principals to revoke. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md deleted file mode 100644 index 2c77722be4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Revoke-PnPTenantServicePrincipalPermission - -## SYNOPSIS -Revokes a permission that was previously granted to the "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Revoke-PnPTenantServicePrincipalPermission -ObjectId <String> - [-Force [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Revokes a permission that was previously granted to the "SharePoint Online Client" service principal. - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ObjectId - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md deleted file mode 100644 index 779018b4fc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Save-PnPProvisioningTemplate - -## SYNOPSIS - -Saves a PnP site template to the file system - -## SYNTAX - -```powershell -Save-PnPProvisioningTemplate -InputInstance <ProvisioningTemplate> - -Out <String> - [-Force [<SwitchParameter>]] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Save-PnPSiteTemplate -InputInstance $template -Out .\template.pnp -``` - -Saves a PnP site template to the file system as a PnP file. - -### ------------------EXAMPLE 2------------------ -```powershell -Save-PnPProvisioningTemplate -InputInstance $template -Out .\template.pnp -``` - -Saves a PnP file to the file systems - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -InputInstance -Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template. - -```yaml -Type: ProvisioningTemplate -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify the ITemplateProviderExtension to execute while saving a template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md deleted file mode 100644 index 3ac9d07ac3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Save-PnPTenantTemplate - -## SYNOPSIS -Saves a PnP provisioning hierarchy to the file system - -## SYNTAX - -```powershell -Save-PnPTenantTemplate -Template <ProvisioningHierarchy> - -Out <String> - [-Force [<SwitchParameter>]] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Save-PnPTenantTemplate -Template $template -Out .\hierarchy.pnp -``` - -Saves a PnP tenant template to the file system - -## PARAMETERS - -### -Force -Specifying the Force parameter will skip the confirmation question. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Out -Filename to write to, optionally including full path. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Template -Allows you to provide an in-memory instance of a Tenant Template. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template. - -```yaml -Type: ProvisioningHierarchy -Parameter Sets: (All) -Aliases: Hierarchy - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md deleted file mode 100644 index 15efcba66a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Send-PnPMail - -## SYNOPSIS -Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information. - -## SYNTAX - -```powershell -Send-PnPMail -To <String[]> - -Subject <String> - -Body <String> - [-Server <String>] - [-From <String>] - [-Password <String>] - [-Cc <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Send-PnPMail -To address@tenant.sharepointonline.com -Subject test -Body test -``` - -Sends an e-mail using the SharePoint SendEmail method using the current context. E-mail is sent from the system account and can only be sent to accounts in the same tenant - -### ------------------EXAMPLE 2------------------ -```powershell -Send-PnPMail -To address@contoso.com -Subject test -Body test -From me@tenant.onmicrosoft.com -Password xyz -``` - -Sends an e-mail via Office 365 SMTP and requires a from address and password. E-mail is sent from the from user and can be sent to both internal and external addresses. - -### ------------------EXAMPLE 3------------------ -```powershell -Send-PnPMail -To address@contoso.com -Subject test -Body test -From me@server.net -Password xyz -Server yoursmtp.server.net -``` - -Sends an e-mail via a custom SMTP server and requires a from address and password. E-mail is sent from the from user. - -## PARAMETERS - -### -Body -Body of the email - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Cc -List of recipients on CC - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -From -If using from address, you also have to provide a password - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Password -If using a password, you also have to provide the associated from address - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Server - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Subject -Subject of the email - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -To -List of recipients - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md deleted file mode 100644 index 9223c878f5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPAppSideLoading - -## SYNOPSIS -Enables the App SideLoading Feature on a site - -## SYNTAX - -### On -```powershell -Set-PnPAppSideLoading -On [<SwitchParameter>] - [-Connection <SPOnlineConnection>] -``` - -### Off -```powershell -Set-PnPAppSideLoading -Off [<SwitchParameter>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPAppSideLoading -On -``` - -This will turn on App side loading - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPAppSideLoading -Off -``` - -This will turn off App side loading - -## PARAMETERS - -### -Off - - -```yaml -Type: SwitchParameter -Parameter Sets: Off - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -On - - -```yaml -Type: SwitchParameter -Parameter Sets: On - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md deleted file mode 100644 index aafd093478..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPAuditing - -## SYNOPSIS -Set Auditing setting for a site - -## SYNTAX - -### Specific flags -```powershell -Set-PnPAuditing [-RetentionTime <Int>] - [-TrimAuditLog [<SwitchParameter>]] - [-EditItems [<SwitchParameter>]] - [-CheckOutCheckInItems [<SwitchParameter>]] - [-MoveCopyItems [<SwitchParameter>]] - [-DeleteRestoreItems [<SwitchParameter>]] - [-EditContentTypesColumns [<SwitchParameter>]] - [-SearchContent [<SwitchParameter>]] - [-EditUsersPermissions [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### Enable all -```powershell -Set-PnPAuditing -EnableAll [<SwitchParameter>] - [-RetentionTime <Int>] - [-TrimAuditLog [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### Disable All -```powershell -Set-PnPAuditing -DisableAll [<SwitchParameter>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPAuditing -EnableAll -``` - -Enables all auditing settings for the current site - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPAuditing -DisableAll -``` - -Disables all auditing settings for the current site - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPAuditing -RetentionTime 7 -``` - -Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPAuditing -TrimAuditLog -``` - -Enables the automatic trimming of the audit log - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPAuditing -RetentionTime 7 -CheckOutCheckInItems -MoveCopyItems -SearchContent -``` - -Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log. - -Do auditing for: -- Checking out or checking in items -- Moving or copying items to another location in the site -- Searching site content - -## PARAMETERS - -### -CheckOutCheckInItems -Audit checking out or checking in items - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DeleteRestoreItems -Audit deleting or restoring items - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisableAll -Disable all audit flags - -```yaml -Type: SwitchParameter -Parameter Sets: Disable All - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -EditContentTypesColumns -Audit editing content types and columns - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EditItems -Audit editing items - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EditUsersPermissions -Audit editing users and permissions - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableAll -Enable all audit flags - -```yaml -Type: SwitchParameter -Parameter Sets: Enable all - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -MoveCopyItems -Audit moving or copying items to another location in the site. - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RetentionTime -Set the retention time - -```yaml -Type: Int -Parameter Sets: Specific flags, Enable all - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SearchContent -Audit searching site content - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TrimAuditLog -Trim the audit log - -```yaml -Type: SwitchParameter -Parameter Sets: Specific flags, Enable all - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md deleted file mode 100644 index 0a3d85cd15..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPAvailablePageLayouts - -## SYNOPSIS -Sets the available page layouts for the current site - -## SYNTAX - -### SPECIFIC -```powershell -Set-PnPAvailablePageLayouts -PageLayouts <String[]> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### ALL -```powershell -Set-PnPAvailablePageLayouts -AllowAllPageLayouts [<SwitchParameter>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### INHERIT -```powershell -Set-PnPAvailablePageLayouts -InheritPageLayouts [<SwitchParameter>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -AllowAllPageLayouts -An array of page layout files to set as available page layouts for the site. - -```yaml -Type: SwitchParameter -Parameter Sets: ALL - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -InheritPageLayouts -Set the available page layouts to inherit from the parent site. - -```yaml -Type: SwitchParameter -Parameter Sets: INHERIT - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PageLayouts -An array of page layout files to set as available page layouts for the site. - -```yaml -Type: String[] -Parameter Sets: SPECIFIC - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md deleted file mode 100644 index 64f4db1fce..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPClientSidePage - -## SYNOPSIS -Sets parameters of a Client-Side Page - -## SYNTAX - -```powershell -Set-PnPClientSidePage -Identity <ClientSidePagePipeBind> - [-Name <String>] - [-Title <String>] - [-LayoutType <ClientSidePageLayoutType>] - [-PromoteAs <ClientSidePagePromoteType>] - [-CommentsEnabled [<SwitchParameter>]] - [-Publish [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPClientSidePage -Identity "MyPage" -LayoutType Home -Title "My Page" -``` - -Updates the properties of the Client-Side page named 'MyPage' - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled -``` - -Enables the comments on the Client-Side page named 'MyPage' - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled:$false -``` - -Disables the comments on the Client-Side page named 'MyPage' - -## PARAMETERS - -### -CommentsEnabled -Enables or Disables the comments on the page - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The name/identity of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -LayoutType -Sets the layout type of the page. (Default = Article) - -```yaml -Type: ClientSidePageLayoutType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Name -Sets the name of the page. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PromoteAs -Allows to promote the page for a specific purpose (HomePage | NewsPage) - -```yaml -Type: ClientSidePagePromoteType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Publish -Publishes the page once it is saved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -Sets the title of the page. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md deleted file mode 100644 index b4153be2cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPClientSideText - -## SYNOPSIS -Set Client-Side Text Component properties - -## SYNTAX - -```powershell -Set-PnPClientSideText -Page <ClientSidePagePipeBind> - -InstanceId <GuidPipeBind> - -Text <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets the rendered text in existing client side text component - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSetClientSideText -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Text "MyText" -``` - -Sets the text of the client side text component. - -## PARAMETERS - -### -InstanceId -The instance id of the text component - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Page -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Text -Text to set - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md deleted file mode 100644 index ef639c86aa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPClientSideWebPart - -## SYNOPSIS -Set Client-Side Web Part properties - -## SYNTAX - -```powershell -Set-PnPClientSideWebPart -Page <ClientSidePagePipeBind> - -Identity <ClientSideWebPartPipeBind> - [-Title <String>] - [-PropertiesJson <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets specific client side webpart properties. Notice that the title parameter will only set the -internal- title of webpart. The title which is shown in the UI will, if possible, have to be set using the PropertiesJson parameter. Use Get-PnPClientSideComponent to retrieve the instance id and properties of a webpart. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPClientSideWebPart -Page Home -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 -PropertiesJson $myproperties -``` - -Sets the properties of the client side webpart given in the $myproperties variable. - -## PARAMETERS - -### -Identity -The identity of the webpart. This can be the webpart instance id or the title of a webpart - -```yaml -Type: ClientSideWebPartPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Page -The name of the page - -```yaml -Type: ClientSidePagePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -PropertiesJson -Sets the properties as a JSON string. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Title -Sets the internal title of the webpart. Notice that this will NOT set a visible title. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md deleted file mode 100644 index 71908978af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPContext - -## SYNOPSIS -Set the ClientContext - -## SYNTAX - -```powershell -Set-PnPContext -Context <ClientContext> -``` - -## DESCRIPTION -Sets the Client Context to use by the cmdlets, which allows easy context switching. See examples for details. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Url $siteAurl -Credentials $credentials -$ctx = Get-PnPContext -Get-PnPList # returns the lists from site specified with $siteAurl -Connect-PnPOnline -Url $siteBurl -Credentials $credentials -Get-PnPList # returns the lists from the site specified with $siteBurl -Set-PnPContext -Context $ctx # switch back to site A -Get-PnPList # returns the lists from site A -``` - - - -## PARAMETERS - -### -Context -The ClientContext to set - -```yaml -Type: ClientContext -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: True -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md deleted file mode 100644 index 9cba82d2bd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPDefaultColumnValues - -## SYNOPSIS -Sets default column values for a document library - -## SYNTAX - -```powershell -Set-PnPDefaultColumnValues -List <ListPipeBind> - -Field <FieldPipeBind> - -Value <String[]> - [-Folder <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets default column values for a document library, per folder, or for the root folder if the folder parameter has not been specified. Supports both text and taxonomy fields. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPDefaultColumnValues -List Documents -Field TaxKeyword -Value "Company|Locations|Stockholm" -``` - -Sets a default value for the enterprise keywords field on a library to a term called "Stockholm", located in the "Locations" term set, which is part of the "Company" term group - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPDefaultColumnValues -List Documents -Field TaxKeyword -Value "15c4c4e4-4b67-4894-a1d8-de5ff811c791" -``` - -Sets a default value for the enterprise keywords field on a library to a term with the id "15c4c4e4-4b67-4894-a1d8-de5ff811c791". You need to ensure the term is valid for the field. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPDefaultColumnValues -List Documents -Field MyTextField -Value "DefaultValue" -``` - -Sets a default value for the MyTextField text field on a library to a value of "DefaultValue" - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPDefaultColumnValues -List Documents -Field MyPeopleField -Value "1;#Foo Bar" -``` - -Sets a default value for the MyPeopleField people field on a library to a value of "Foo Bar" using the id from the user information list. - -### ------------------EXAMPLE 5------------------ -```powershell -$user = New-PnPUser -LoginName foobar@contoso.com -Set-PnPDefaultColumnValues -List Documents -Field MyPeopleField -Value "$($user.Id);#$($user.LoginName)" -``` - -Sets a default value for the MyPeopleField people field on a library to a value of "Foo Bar" using the id from the user information list. - -### ------------------EXAMPLE 6------------------ -```powershell -$user1 = New-PnPUser -LoginName user1@contoso.com -$user2 = New-PnPUser -LoginName user2@contoso.com -Set-PnPDefaultColumnValues -List Documents -Field MyMultiPeopleField -Value "$($user1.Id);#$($user1.LoginName)","$($user2.Id);#$($user2.LoginName)" -``` - -Sets a default value for the MyMultiPeopleField people field on a library to a value of "User 1" and "User 2" using the id from the user information list. - -## PARAMETERS - -### -Field -The internal name, id or a reference to a field - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Folder -A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/') - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The ID, Name or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Value -A list of values. In case of a text field the values will be concatenated, separated by a semi-colon. In case of a taxonomy field multiple values will added. In case of people field multiple values will be added. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md deleted file mode 100644 index 50fb3762ce..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPDefaultContentTypeToList - -## SYNOPSIS -Sets the default content type for a list - -## SYNTAX - -```powershell -Set-PnPDefaultContentTypeToList -List <ListPipeBind> - -ContentType <ContentTypePipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPDefaultContentTypeToList -List "Project Documents" -ContentType "Project" -``` - -This will set the Project content type (which has already been added to a list) as the default content type - -## PARAMETERS - -### -ContentType -The content type object that needs to be set as the default content type on the list. Content Type needs to be present on the list. - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The name of a list, an ID or the actual list object to update - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md deleted file mode 100644 index b3191d074c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPDefaultPageLayout - -## SYNOPSIS -Sets a specific page layout to be the default page layout for a publishing site - -## SYNTAX - -### TITLE -```powershell -Set-PnPDefaultPageLayout -Title <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### INHERIT -```powershell -Set-PnPDefaultPageLayout -InheritFromParentSite [<SwitchParameter>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPDefaultPageLayout -Title projectpage.aspx -``` - -Sets projectpage.aspx to be the default page layout for the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPDefaultPageLayout -Title test/testpage.aspx -``` - -Sets a page layout in a folder in the Master Page & Page Layout gallery, such as _catalog/masterpage/test/testpage.aspx, to be the default page layout for the current web - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPDefaultPageLayout -InheritFromParentSite -``` - -Sets the default page layout to be inherited from the parent site - -## PARAMETERS - -### -InheritFromParentSite -Set the default page layout to be inherited from the parent site. - -```yaml -Type: SwitchParameter -Parameter Sets: INHERIT - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -Title of the page layout - -```yaml -Type: String -Parameter Sets: TITLE - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md deleted file mode 100644 index b688484c56..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPDocumentSetField - -## SYNOPSIS -Sets a site column from the available content types to a document set - -## SYNTAX - -```powershell -Set-PnPDocumentSetField -DocumentSet <DocumentSetPipeBind> - -Field <FieldPipeBind> - [-SetSharedField [<SwitchParameter>]] - [-SetWelcomePageField [<SwitchParameter>]] - [-RemoveSharedField [<SwitchParameter>]] - [-RemoveWelcomePageField [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -SetSharedField -SetWelcomePageField -``` - -This will set the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -RemoveSharedField -RemoveWelcomePageField -``` - -This will remove the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field. - -## PARAMETERS - -### -DocumentSet -The document set in which to set the field. Either specify a name, a document set template object, an id, or a content type object - -```yaml -Type: DocumentSetPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Field -The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -RemoveSharedField -Removes the field as a Shared Field - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RemoveWelcomePageField -Removes the field as a Welcome Page Field - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SetSharedField -Set the field as a Shared Field - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SetWelcomePageField -Set the field as a Welcome Page field - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md deleted file mode 100644 index ead88b6fd7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPField - -## SYNOPSIS -Changes one or more properties of a field in a specific list or for the whole web - -## SYNTAX - -```powershell -Set-PnPField -Identity <FieldPipeBind> - -Values <Hashtable> - [-List <ListPipeBind>] - [-UpdateExistingLists [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPField -Identity AssignedTo -Values @{JSLink="customrendering.js";Group="My fields"} -``` - -Updates the AssignedTo field on the current web to use customrendering.js for the JSLink and sets the group name the field is categorized in to "My Fields". Lists that are already using the AssignedTo field will not be updated. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPField -Identity AssignedTo -Values @{JSLink="customrendering.js";Group="My fields"} -UpdateExistingLists -``` - -Updates the AssignedTo field on the current web to use customrendering.js for the JSLink and sets the group name the field is categorized in to "My Fields". Lists that are already using the AssignedTo field will also be updated. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPField -List "Tasks" -Identity "AssignedTo" -Values @{JSLink="customrendering.js"} -``` - -Updates the AssignedTo field on the Tasks list to use customrendering.js for the JSLink - -## PARAMETERS - -### -Identity -The field object, internal field name (case sensitive) or field id to update - -```yaml -Type: FieldPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -List -The list object, name or id where to update the field. If omitted the field will be updated on the web. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: True -``` - -### -UpdateExistingLists -If provided, the field will be updated on existing lists that use it as well. If not provided or set to $false, existing lists using the field will remain unchanged but new lists will get the updated field. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Values -Hashtable of properties to update on the field. Use the syntax @{property1="value";property2="value"}. - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Field - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md deleted file mode 100644 index 8752b71d86..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPFileCheckedIn - -## SYNOPSIS -Checks in a file - -## SYNTAX - -```powershell -Set-PnPFileCheckedIn -Url <String> - [-CheckinType <CheckinType>] - [-Comment <String>] - [-Approve [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -PS:>Set-PnPFileCheckedIn -Url "/Documents/Contract.docx" -``` - -Checks in the file "Contract.docx" in the "Documents" library - -### ------------------EXAMPLE 2------------------ -```powershell -PS:>Set-PnPFileCheckedIn -Url "/Documents/Contract.docx" -CheckinType MinorCheckin -Comment "Smaller changes" -``` - -Checks in the file "Contract.docx" in the "Documents" library as a minor version and adds the check in comment "Smaller changes" - -## PARAMETERS - -### -Approve -Approve file - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CheckinType -The check in type to use. Defaults to Major - -```yaml -Type: CheckinType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Comment -The check in comment - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -The server relative url of the file to check in - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md deleted file mode 100644 index 5c121b5192..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPFileCheckedOut - -## SYNOPSIS -Checks out a file - -## SYNTAX - -```powershell -Set-PnPFileCheckedOut -Url <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -PS:>Set-PnPFileCheckedOut -Url "/sites/testsite/subsite/Documents/Contract.docx" -``` - -Checks out the file "Contract.docx" in the "Documents" library. - -## PARAMETERS - -### -Url -The server relative url of the file to check out - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md deleted file mode 100644 index 77893bf27e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPGroup - -## SYNOPSIS -Updates a group - -## SYNTAX - -```powershell -Set-PnPGroup -Identity <GroupPipeBind> - [-SetAssociatedGroup <AssociatedGroupType>] - [-AddRole <String>] - [-RemoveRole <String>] - [-Title <String>] - [-Owner <String>] - [-Description <String>] - [-AllowRequestToJoinLeave <Boolean>] - [-AutoAcceptRequestToJoinLeave <Boolean>] - [-AllowMembersEditMembership <Boolean>] - [-OnlyAllowMembersViewMembership <Boolean>] - [-RequestToJoinEmail <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPGroup -Identity 'My Site Members' -SetAssociatedGroup Members -``` - -Sets the SharePoint group with the name 'My Site Members' as the associated members group - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPGroup -Identity 'My Site Members' -Owner 'site owners' -``` - -Sets the SharePoint group with the name 'site owners' as the owner of the SharePoint group with the name 'My Site Members' - -## PARAMETERS - -### -AddRole -Name of the permission set to add to this SharePoint group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AllowMembersEditMembership -A switch parameter that specifies whether group members can modify membership in the group - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AllowRequestToJoinLeave -A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AutoAcceptRequestToJoinLeave -A switch parameter that specifies whether users are automatically added or removed when they make a request - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description for the group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -A group object, an ID or a name of a group - -```yaml -Type: GroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -OnlyAllowMembersViewMembership -A switch parameter that specifies whether only group members are allowed to view the list of members in the group - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owner -The owner for the group, which can be a user or another group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RemoveRole -Name of the permission set to remove from this SharePoint group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RequestToJoinEmail -The e-mail address to which membership requests are sent - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SetAssociatedGroup -One of the associated group types (Visitors, Members, Owners - -```yaml -Type: AssociatedGroupType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title for the group - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md deleted file mode 100644 index 0d7bba0b88..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPGroupPermissions - -## SYNOPSIS -Adds and/or removes permissions of a specific SharePoint group - -## SYNTAX - -### ByName -```powershell -Set-PnPGroupPermissions -Identity <GroupPipeBind> - [-List <ListPipeBind>] - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole Contribute -``` - -Adds the 'Contribute' permission to the SharePoint group with the name 'My Site Members' - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole 'Full Control' -AddRole 'Read' -``` - -Removes the 'Full Control' from and adds the 'Contribute' permissions to the SharePoint group with the name 'My Site Members' - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole @('Contribute', 'Design') -``` - -Adds the 'Contribute' and 'Design' permissions to the SharePoint group with the name 'My Site Members' - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole @('Contribute', 'Design') -``` - -Removes the 'Contribute' and 'Design' permissions from the SharePoint group with the name 'My Site Members' - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPGroupPermissions -Identity 'My Site Members' -List 'MyList' -RemoveRole @('Contribute') -``` - -Removes the 'Contribute' permissions from the list 'MyList' for the group with the name 'My Site Members' - -## PARAMETERS - -### -AddRole -Name of the permission set to add to this SharePoint group - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Get the permissions of a specific group by name - -```yaml -Type: GroupPipeBind -Parameter Sets: ByName -Aliases: Name - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -List -The list to apply the command to. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RemoveRole -Name of the permission set to remove from this SharePoint group - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md deleted file mode 100644 index f4a9fce32d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPHideDefaultThemes - -## SYNOPSIS -Defines if the default / OOTB themes should be visible to users or not. - -## SYNTAX - -```powershell -Set-PnPHideDefaultThemes -HideDefaultThemes <Boolean> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Use this cmdlet to hide or show the default themes to users - -You must be a SharePoint Online global administrator to run the cmdlet. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPHideDefaultThemes -HideDefaultThemes $true -``` - -This example hides the default themes - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPHideDefaultThemes -HideDefaultThemes $false -``` - -This example shows the default themes - -## PARAMETERS - -### -HideDefaultThemes -Defines if the default themes should be visible or hidden - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md deleted file mode 100644 index 09ccd09d14..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPHomePage - -## SYNOPSIS -Sets the home page of the current web. - -## SYNTAX - -```powershell -Set-PnPHomePage -RootFolderRelativeUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx -``` - -Sets the home page to the home.aspx file which resides in the SitePages library - -## PARAMETERS - -### -RootFolderRelativeUrl -The root folder relative url of the homepage, e.g. 'sitepages/home.aspx' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Path - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md deleted file mode 100644 index ab01a7a54c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPHubSite - -## SYNOPSIS -Sets hubsite properties - -## SYNTAX - -```powershell -Set-PnPHubSite [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -Title "My New Title" -``` - -Sets the title of the hubsite - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md deleted file mode 100644 index 22d003f635..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPInPlaceRecordsManagement - -## SYNOPSIS -Activates or deactivates in the place records management feature. - -## SYNTAX - -### Enable or Disable -```powershell -Set-PnPInPlaceRecordsManagement -Enabled <Boolean> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPInPlaceRecordsManagement -Enabled $true -``` - -Activates In Place Records Management - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPInPlaceRecordsManagement -Enabled $false -``` - -Deactivates In Place Records Management - -## PARAMETERS - -### -Enabled - - -```yaml -Type: Boolean -Parameter Sets: Enable or Disable - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md deleted file mode 100644 index 044b3c8c3e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPIndexedProperties - -## SYNOPSIS -Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed. - -## SYNTAX - -```powershell -Set-PnPIndexedProperties -Keys <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Keys - - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md deleted file mode 100644 index 4ba2dd1356..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPLabel - -## SYNOPSIS -Sets a label/tag on the specified list or library - -## SYNTAX - -```powershell -Set-PnPLabel -List <ListPipeBind> - -Label <String> - [-SyncToItems <Boolean>] - [-BlockDeletion <Boolean>] - [-BlockEdit <Boolean>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPLabel -List "Demo List" -Label "Project Documentation" -``` - -This sets an O365 label on the specified list or library. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPLabel -List "Demo List" -Label "Project Documentation" -SyncToItems $true -``` - -This sets an O365 label on the specified list or library and sets the label to all the items in the list and library as well. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPLabel -List "Demo List" -Label "Project Documentation" -BlockDelete $true -BlockEdit $true -``` - -This sets an O365 label on the specified list or library. Next, it also blocks the ability to either edit or delete the item. - -## PARAMETERS - -### -BlockDeletion -Block deletion of items in the library. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -BlockEdit -Block edititing of items in the library. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Label -The name of the label. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -List -The ID or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SyncToItems -Apply label to existing items in the library. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md deleted file mode 100644 index e3d20afaef..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPList - -## SYNOPSIS -Updates list settings - -## SYNTAX - -```powershell -Set-PnPList -Identity <ListPipeBind> - [-EnableContentTypes <Boolean>] - [-BreakRoleInheritance [<SwitchParameter>]] - [-CopyRoleAssignments [<SwitchParameter>]] - [-ClearSubscopes [<SwitchParameter>]] - [-Title <String>] - [-Description <String>] - [-Hidden <Boolean>] - [-ForceCheckout <Boolean>] - [-ListExperience <ListExperience>] - [-EnableAttachments <Boolean>] - [-EnableFolderCreation <Boolean>] - [-EnableVersioning <Boolean>] - [-EnableMinorVersions <Boolean>] - [-MajorVersions <UInt32>] - [-MinorVersions <UInt32>] - [-EnableModeration <Boolean>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPList -Identity "Demo List" -EnableContentTypes $true -``` - -Switches the Enable Content Type switch on the list - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPList -Identity "Demo List" -Hidden $true -``` - -Hides the list from the SharePoint UI. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPList -Identity "Demo List" -EnableVersioning $true -``` - -Turns on major versions on a list - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPList -Identity "Demo List" -EnableVersioning $true -MajorVersions 20 -``` - -Turns on major versions on a list and sets the maximum number of Major Versions to keep to 20. - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPList -Identity "Demo Library" -EnableVersioning $true -EnableMinorVersions $true -MajorVersions 20 -MinorVersions 5 -``` - -Turns on major versions on a document library and sets the maximum number of Major versions to keep to 20 and sets the maximum of Minor versions to 5. - -### ------------------EXAMPLE 6------------------ -```powershell -Set-PnPList -Identity "Demo List" -EnableAttachments $true -``` - -Turns on attachments on a list - -## PARAMETERS - -### -BreakRoleInheritance -If used the security inheritance is broken for this list - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ClearSubscopes -If used the unique permissions are cleared from child objects and they can inherit role assignments from this object - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CopyRoleAssignments -If used the roles are copied from the parent web - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description of the list - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableAttachments -Enable or disable attachments. Set to $true to enable, $false to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableContentTypes -Set to $true to enable content types, set to $false to disable content types - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableFolderCreation -Enable or disable folder creation. Set to $true to enable, $false to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableMinorVersions -Enable or disable minor versions versioning. Set to $true to enable, $false to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableModeration -Enable or disable whether content approval is enabled for the list. Set to $true to enable, $false to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableVersioning -Enable or disable versioning. Set to $true to enable, $false to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ForceCheckout -Enable or disable force checkout. Set to $true to enable, $false to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Hidden -Hide the list from the SharePoint UI. Set to $true to hide, $false to show. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ListExperience -Set the list experience: Auto, NewExperience or ClassExperience - -Only applicable to: SharePoint Online - -```yaml -Type: ListExperience -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MajorVersions -Maximum major versions to keep - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MinorVersions -Maximum minor versions to keep - -```yaml -Type: UInt32 -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the list - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md deleted file mode 100644 index 89fb14e0cf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPListInformationRightsManagement - -## SYNOPSIS -Get the site closure status of the site which has a site policy applied - -## SYNTAX - -```powershell -Set-PnPListInformationRightsManagement -List <ListPipeBind> - [-Enable <Boolean>] - [-EnableExpiration <Boolean>] - [-EnableRejection <Boolean>] - [-AllowPrint <Boolean>] - [-AllowScript <Boolean>] - [-AllowWriteCopy <Boolean>] - [-DisableDocumentBrowserView <Boolean>] - [-DocumentAccessExpireDays <Int>] - [-DocumentLibraryProtectionExpireDate <DateTime>] - [-EnableDocumentAccessExpire <Boolean>] - [-EnableDocumentBrowserPublishingView <Boolean>] - [-EnableGroupProtection <Boolean>] - [-EnableLicenseCacheExpire <Boolean>] - [-LicenseCacheExpireDays <Int>] - [-GroupName <String>] - [-PolicyDescription <String>] - [-PolicyTitle <String>] - [-TemplateId <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPListInformationRightsManagement -List "Documents" -Enabled $true -``` - -Enables Information Rights Management (IRM) on the list. - -## PARAMETERS - -### -AllowPrint -Sets a value indicating whether the viewer can print the downloaded document. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AllowScript -Sets a value indicating whether the viewer can run a script on the downloaded document. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AllowWriteCopy -Sets a value indicating whether the viewer can write on a copy of the downloaded document. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisableDocumentBrowserView -Sets a value indicating whether to block Office Web Application Companion applications (WACs) from showing this document. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DocumentAccessExpireDays -Sets the number of days after which the downloaded document will expire. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DocumentLibraryProtectionExpireDate -Sets the date after which the Information Rights Management (IRM) protection of this document library will stop. - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Enable -Specifies whether Information Rights Management (IRM) is enabled for the list. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableDocumentAccessExpire -Sets a value indicating whether the downloaded document will expire. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableDocumentBrowserPublishingView -Sets a value indicating whether to enable Office Web Application Companion applications (WACs) to publishing view. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableExpiration -Specifies whether Information Rights Management (IRM) expiration is enabled for the list. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableGroupProtection -Sets a value indicating whether the permission of the downloaded document is applicable to a group. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableLicenseCacheExpire -Sets whether a user must verify their credentials after some interval. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableRejection -Specifies whether Information Rights Management (IRM) rejection is enabled for the list. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -GroupName -Sets the group name (email address) that the permission is also applicable to. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LicenseCacheExpireDays -Sets the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The list to set Information Rights Management (IRM) settings for. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PolicyDescription -Sets the permission policy description. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PolicyTitle -Sets the permission policy title. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateId - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md deleted file mode 100644 index 438219f6d1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPListItem - -## SYNOPSIS -Updates a list item - -## SYNTAX - -```powershell -Set-PnPListItem -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-ContentType <ContentTypePipeBind>] - [-Values <Hashtable>] - [-SystemUpdate [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPListItem -List "Demo List" -Identity 1 -Values @{"Title" = "Test Title"; "Category"="Test Category"} -``` - -Sets fields value in the list item with ID 1 in the "Demo List". It sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPListItem -List "Demo List" -Identity 1 -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"} -``` - -Sets fields value in the list item with ID 1 in the "Demo List". It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPListItem -List "Demo List" -Identity $item -Values @{"Title" = "Test Title"; "Category"="Test Category"} -``` - -Sets fields value in the list item which has been retrieved by for instance Get-PnPListItem. It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. - -## PARAMETERS - -### -ContentType -Specify either the name, ID or an actual content type - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -SystemUpdate -Update the item without creating a new version. - -Only applicable to: SharePoint Online - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Values -Use the internal names of the fields when specifying field names. - -Single line of text: -Values @{"TextField" = "Title New"} - -Multiple lines of text: -Values @{"MultiTextField" = "New text\n\nMore text"} - -Rich text: -Values @{"MultiTextField" = "<strong>New</strong> text"} - -Choice: -Values @{"ChoiceField" = "Value 1"} - -Number: -Values @{"NumberField" = "10"} - -Currency: -Values @{"NumberField" = "10"} - -Currency: -Values @{"CurrencyField" = "10"} - -Date and Time: -Values @{"DateAndTimeField" = "03/13/2015 14:16"} - -Lookup (id of lookup value): -Values @{"LookupField" = "2"} - -Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} - -Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} - -Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} - -Yes/No: -Values @{"YesNoField" = $false} - -Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"PersonField" = "user1@domain.com","21"} - -Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} - -Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term - -Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = ("CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR")} - -Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = ("fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593")} - -Hyperlink or Picture: -Values @{"HyperlinkField" = "https://github.com/OfficeDev/,%20OfficePnp"} - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.ListItem - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md deleted file mode 100644 index b520fb227a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPListItemAsRecord - -## SYNOPSIS -Declares a list item as a record - -## SYNTAX - -```powershell -Set-PnPListItemAsRecord -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-DeclarationDate <DateTime>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPListItemAsRecord -List "Documents" -Identity 4 -``` - -Declares the document in the documents library with id 4 as a record - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPListItemAsRecord -List "Documents" -Identity 4 -DeclarationDate $date -``` - -Declares the document in the documents library with id as a record - -## PARAMETERS - -### -DeclarationDate -The declaration date - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md deleted file mode 100644 index 43a724c068..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPListItemPermission - -## SYNOPSIS -Sets list item permissions - -## SYNTAX - -### Inherit -```powershell -Set-PnPListItemPermission -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-InheritPermissions [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Group -```powershell -Set-PnPListItemPermission -Group <GroupPipeBind> - -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-AddRole <String>] - [-RemoveRole <String>] - [-ClearExisting [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### User -```powershell -Set-PnPListItemPermission -User <String> - -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-AddRole <String>] - [-RemoveRole <String>] - [-ClearExisting [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -AddRole 'Contribute' -``` - -Adds the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -RemoveRole 'Contribute' -``` - -Removes the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -AddRole 'Contribute' -ClearExisting -``` - -Adds the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' and removes all other permissions - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPListItemPermission -List 'Documents' -Identity 1 -InheritPermissions -``` - -Resets permissions for listitem with id 1 to inherit permissions from the list 'Documents' - -## PARAMETERS - -### -AddRole -The role that must be assigned to the group or user - -```yaml -Type: String -Parameter Sets: User, Group - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ClearExisting -Clear all existing permissions - -```yaml -Type: SwitchParameter -Parameter Sets: User, Group - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Group - - -```yaml -Type: GroupPipeBind -Parameter Sets: Group - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -InheritPermissions -Inherit permissions from the list, removing unique permissions - -```yaml -Type: SwitchParameter -Parameter Sets: Inherit - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: __AllParameterSets - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -RemoveRole -The role that must be removed from the group or user - -```yaml -Type: String -Parameter Sets: User, Group - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -User - - -```yaml -Type: String -Parameter Sets: User - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md deleted file mode 100644 index 1a94e3edf0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPListPermission - -## SYNOPSIS -Sets list permissions - -## SYNTAX - -### Group -```powershell -Set-PnPListPermission -Group <GroupPipeBind> - -Identity <ListPipeBind> - [-AddRole <String>] - [-RemoveRole <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### User -```powershell -Set-PnPListPermission -User <String> - -Identity <ListPipeBind> - [-AddRole <String>] - [-RemoveRole <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPListPermission -Identity 'Documents' -User 'user@contoso.com' -AddRole 'Contribute' -``` - -Adds the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents' - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPListPermission -Identity 'Documents' -User 'user@contoso.com' -RemoveRole 'Contribute' -``` - -Removes the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents' - -## PARAMETERS - -### -AddRole -The role that must be assigned to the group or user - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Group - - -```yaml -Type: GroupPipeBind -Parameter Sets: Group - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Identity -The ID or Title of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -RemoveRole -The role that must be removed from the group or user - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -User - - -```yaml -Type: String -Parameter Sets: User - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md deleted file mode 100644 index b136314d80..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPListRecordDeclaration - -## SYNOPSIS -The RecordDeclaration parameter supports 4 values: - -AlwaysAllowManualDeclaration -NeverAllowManualDeclaration -UseSiteCollectionDefaults - - -## SYNTAX - -```powershell -Set-PnPListRecordDeclaration -List <ListPipeBind> - [-ManualRecordDeclaration <EcmListManualRecordDeclaration>] - [-AutoRecordDeclaration <Boolean>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPListRecordDeclaration -List "Documents" -ManualRecordDeclaration NeverAllowManualDeclaration -``` - -Sets the manual record declaration to never allow - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPListRecordDeclaration -List "Documents" -AutoRecordDeclaration $true -``` - -Turns on auto record declaration for the list - -## PARAMETERS - -### -AutoRecordDeclaration -Defines if you want to set auto record declaration on the list - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The List to set the manual record declaration settings for - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ManualRecordDeclaration -Defines the manual record declaration setting for the lists - -```yaml -Type: EcmListManualRecordDeclaration -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md deleted file mode 100644 index 2cd37ea853..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPMasterPage - -## SYNOPSIS -Set the masterpage - -## SYNTAX - -### Server Relative -```powershell -Set-PnPMasterPage [-MasterPageServerRelativeUrl <String>] - [-CustomMasterPageServerRelativeUrl <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Site Relative -```powershell -Set-PnPMasterPage [-MasterPageSiteRelativeUrl <String>] - [-CustomMasterPageSiteRelativeUrl <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets the default master page of the current web. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master -``` - -Sets the master page based on a server relative URL - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master -CustomMasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master -``` - -Sets the master page and custom master page based on a server relative URL - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master -``` - -Sets the master page based on a site relative URL - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master -CustomMasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master -``` - -Sets the master page and custom master page based on a site relative URL - -## PARAMETERS - -### -CustomMasterPageServerRelativeUrl -Specifies the custom Master page URL based on the server relative URL - -```yaml -Type: String -Parameter Sets: Server Relative -Aliases: CustomMasterPageUrl - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CustomMasterPageSiteRelativeUrl -Specifies the custom Master page URL based on the site relative URL - -```yaml -Type: String -Parameter Sets: Site Relative - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MasterPageServerRelativeUrl -Specifies the Master page URL based on the server relative URL - -```yaml -Type: String -Parameter Sets: Server Relative -Aliases: MasterPageUrl - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MasterPageSiteRelativeUrl -Specifies the Master page URL based on the site relative URL - -```yaml -Type: String -Parameter Sets: Site Relative - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md deleted file mode 100644 index e8e5bd0aee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPMinimalDownloadStrategy - -## SYNOPSIS -Activates or deactivates the minimal downloading strategy. - -## SYNTAX - -### On -```powershell -Set-PnPMinimalDownloadStrategy -On [<SwitchParameter>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Off -```powershell -Set-PnPMinimalDownloadStrategy -Off [<SwitchParameter>] - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Activates or deactivates the minimal download strategy feature of a site - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPMinimalDownloadStrategy -Off -``` - -Will deactivate minimal download strategy (MDS) for the current web. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPMinimalDownloadStrategy -On -``` - -Will activate minimal download strategy (MDS) for the current web. - -## PARAMETERS - -### -Force -Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Off -Turn minimal download strategy off - -```yaml -Type: SwitchParameter -Parameter Sets: Off - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -On -Turn minimal download strategy on - -```yaml -Type: SwitchParameter -Parameter Sets: On - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md deleted file mode 100644 index 40c1d9ed6d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPPropertyBagValue - -## SYNOPSIS -Sets a property bag value - -## SYNTAX - -### Folder -```powershell -Set-PnPPropertyBagValue -Key <String> - -Value <String> - [-Folder <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Web -```powershell -Set-PnPPropertyBagValue -Key <String> - -Value <String> - -Indexed [<SwitchParameter>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPPropertyBagValue -Key MyKey -Value MyValue -``` - -This sets or adds a value to the current web property bag - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder / -``` - -This sets or adds a value to the root folder of the current web - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /MyFolder -``` - -This sets or adds a value to the folder MyFolder which is located in the root folder of the current web - -## PARAMETERS - -### -Folder -Site relative url of the folder. See examples for use. - -```yaml -Type: String -Parameter Sets: Folder - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Indexed - - -```yaml -Type: SwitchParameter -Parameter Sets: Web - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Key - - -```yaml -Type: String -Parameter Sets: Web, Folder - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Value - - -```yaml -Type: String -Parameter Sets: Web, Folder, - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md deleted file mode 100644 index 8c1c6efe1f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPProvisioningTemplateMetadata - -## SYNOPSIS -Sets metadata of a provisioning template - -## SYNTAX - -```powershell -Set-PnPProvisioningTemplateMetadata -Path <String> - [-TemplateDisplayName <String>] - [-TemplateImagePreviewUrl <String>] - [-TemplateProperties <Hashtable>] - [-TemplateProviderExtensions <ITemplateProviderExtension[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateDisplayName "DisplayNameValue" -``` - -Sets the DisplayName property of a site template in XML format. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateDisplayName "DisplayNameValue" -``` - -Sets the DisplayName property of a site template in Office Open XML format. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateImagePreviewUrl "Full URL of the Image Preview" -``` - -Sets the Url to the preview image of a site template in XML format. - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateImagePreviewUrl "Full URL of the Image Preview" -``` - -Sets the to the preview image of a site template in Office Open XML format. - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"} -``` - -Sets the property 'Property1' to the value 'Test Value 1' of a site template in XML format. - -### ------------------EXAMPLE 6------------------ -```powershell -Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"} -``` - -Sets the property 'Property1' to the value 'Test Value 1' of a site template in Office Open XML format. - -## PARAMETERS - -### -Path -Path to the xml or pnp file containing the site template. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -TemplateDisplayName -It can be used to specify the DisplayName of the template file that will be updated. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateImagePreviewUrl -It can be used to specify the ImagePreviewUrl of the template file that will be updated. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateProperties -It can be used to specify custom Properties for the template file that will be updated. - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TemplateProviderExtensions -Allows you to specify ITemplateProviderExtension to execute while extracting a template. - -```yaml -Type: ITemplateProviderExtension[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md deleted file mode 100644 index 56d9479c07..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPRequestAccessEmails - -## SYNOPSIS -Sets Request Access Emails on a web - -## SYNTAX - -```powershell -Set-PnPRequestAccessEmails -Emails <String[]> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPRequestAccessEmails -Emails someone@example.com -``` - -This will update the request access e-mail address - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPRequestAccessEmails -Emails @( someone@example.com; someoneelse@example.com ) -``` - -This will update multiple request access e-mail addresses - -## PARAMETERS - -### -Emails -Email address(es) to set the RequestAccessEmails to - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md deleted file mode 100644 index 0042fbd7e8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPSearchConfiguration - -## SYNOPSIS -Sets the search configuration - -## SYNTAX - -### Config -```powershell -Set-PnPSearchConfiguration -Configuration <String> - [-Scope <SearchConfigurationScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### Path -```powershell -Set-PnPSearchConfiguration -Path <String> - [-Scope <SearchConfigurationScope>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSearchConfiguration -Configuration $config -``` - -Sets the search configuration for the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPSearchConfiguration -Configuration $config -Scope Site -``` - -Sets the search configuration for the current site collection - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPSearchConfiguration -Configuration $config -Scope Subscription -``` - -Sets the search configuration for the current tenant - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription -``` - -Reads the search configuration from the specified XML file and sets it for the current tenant - -## PARAMETERS - -### -Configuration -Search configuration string - -```yaml -Type: String -Parameter Sets: Config - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Path -Path to a search configuration - -```yaml -Type: String -Parameter Sets: Path - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope - - -```yaml -Type: SearchConfigurationScope -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md deleted file mode 100644 index abeb92e74b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md +++ /dev/null @@ -1,365 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPSite - -## SYNOPSIS -Sets Site Collection properties. - -## SYNTAX - -### Set Properties -```powershell -Set-PnPSite [-Classification <String>] - [-DisableFlows [<SwitchParameter>]] - [-LogoFilePath <String>] - [-Sharing <SharingCapabilities>] - [-StorageMaximumLevel <Int>] - [-StorageWarningLevel <Int>] - [-AllowSelfServiceUpgrade [<SwitchParameter>]] - [-NoScriptSite [<SwitchParameter>]] - [-Owners <String>] - [-CommentsOnSitePagesDisabled [<SwitchParameter>]] - [-DefaultLinkPermission <SharingPermissionType>] - [-DefaultSharingLinkType <SharingLinkType>] - [-DisableAppViews <AppViewsPolicy>] - [-DisableCompanyWideSharingLinks <CompanyWideSharingLinksPolicy>] - [-DisableSharingForNonOwners [<SwitchParameter>]] - [-LocaleId <UInt32>] - [-NewUrl <String>] - [-RestrictedToGeo <RestrictedToRegion>] - [-SocialBarOnSitePagesDisabled [<SwitchParameter>]] - [-Identity <String>] - [-Connection <SPOnlineConnection>] -``` - -### Set Lock State -```powershell -Set-PnPSite [-LockState <SiteLockState>] - [-Wait [<SwitchParameter>]] - [-Identity <String>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSite -Classification "HBI" -``` - -Sets the current site classification to HBI - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPSite -Classification $null -``` - -Unsets the current site classification - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPSite -DisableFlows -``` - -Disables Flows for this site - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPSite -DisableFlows:$false -``` - -Enables Flows for this site - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPSite -LogoFilePath c:\images\mylogo.png -``` - -Sets the logo if the site is a modern team site - -## PARAMETERS - -### -AllowSelfServiceUpgrade -Specifies if the site administrator can upgrade the site collection - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Classification -The classification to set - -```yaml -Type: String -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CommentsOnSitePagesDisabled -Specifies if comments on site pages are enabled or disabled - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DefaultLinkPermission -Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions - -```yaml -Type: SharingPermissionType -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DefaultSharingLinkType -Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the "organization" link or company shareable link. Direct - Sets the default sharing link for this site to the "Specific people" link - -```yaml -Type: SharingLinkType -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisableAppViews - - -```yaml -Type: AppViewsPolicy -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisableCompanyWideSharingLinks - - -```yaml -Type: CompanyWideSharingLinksPolicy -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisableFlows -Disables flows for this site - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisableSharingForNonOwners -Specifies to prevent non-owners from inviting new users to the site - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Url - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LocaleId -Specifies the language of this site collection. - -```yaml -Type: UInt32 -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LockState -Sets the lockstate of a site - -```yaml -Type: SiteLockState -Parameter Sets: Set Lock State - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LogoFilePath -Sets the logo if the site is modern team site. If you want to set the logo for a classic site, use Set-PnPWeb -SiteLogoUrl - -```yaml -Type: String -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NewUrl -Specifies the language of this site collection. - -```yaml -Type: String -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NoScriptSite -Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties -Aliases: DenyAndAddCustomizePages - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owners -Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups. - -```yaml -Type: String -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RestrictedToGeo -Specifies the Geo/Region restrictions of this site. - -```yaml -Type: RestrictedToRegion -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Sharing -Specifies what the sharing capablilites are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly - -```yaml -Type: SharingCapabilities -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SocialBarOnSitePagesDisabled -Disables or enables the Social Bar for Site Collection. - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StorageMaximumLevel -Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. - -```yaml -Type: Int -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StorageWarningLevel -Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter - -```yaml -Type: Int -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Wait -Wait for the operation to complete - -```yaml -Type: SwitchParameter -Parameter Sets: Set Lock State - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md deleted file mode 100644 index 0a44714b3b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPSiteClosure - -## SYNOPSIS -Opens or closes a site which has a site policy applied - -## SYNTAX - -```powershell -Set-PnPSiteClosure -State <ClosureState> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSiteClosure -State Open -``` - -This opens a site which has been closed and has a site policy applied. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPSiteClosure -State Closed -``` - -This closes a site which is open and has a site policy applied. - -## PARAMETERS - -### -State -The state of the site - -```yaml -Type: ClosureState -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md deleted file mode 100644 index b9d1bb11f0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPSiteDesign - -## SYNOPSIS -Updates a Site Design on the current tenant. - -## SYNTAX - -```powershell -Set-PnPSiteDesign -Identity <TenantSiteDesignPipeBind> - [-Title <String>] - [-SiteScriptIds <GuidPipeBind[]>] - [-Description <String>] - [-IsDefault [<SwitchParameter>]] - [-PreviewImageAltText <String>] - [-PreviewImageUrl <String>] - [-WebTemplate <SiteWebTemplate>] - [-Version <Int>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSiteDesign -Identity 046e2e76-67ba-46ca-a5f6-8eb418a7821e -Title "My Updated Company Design" -``` - -Updates an existing Site Design and sets a new title. - -### ------------------EXAMPLE 2------------------ -```powershell -$design = Get-PnPSiteDesign -Identity 046e2e76-67ba-46ca-a5f6-8eb418a7821e -Set-PnPSiteDesign -Identity $design -Title "My Updated Company Design" -``` - -Updates an existing Site Design and sets a new title. - -## PARAMETERS - -### -Description -The description of the site design - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The guid or an object representing the site design - -```yaml -Type: TenantSiteDesignPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -IsDefault -Specifies if the site design is a default site design - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PreviewImageAltText -Sets the text for the preview image - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PreviewImageUrl -Sets the url to the preview image - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SiteScriptIds -An array of guids of site scripts - -```yaml -Type: GuidPipeBind[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the site design - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Version -Specifies the version of the design - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -WebTemplate -Specifies the type of site to which this design applies - -```yaml -Type: SiteWebTemplate -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md deleted file mode 100644 index 5502ec6509..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPSitePolicy - -## SYNOPSIS -Sets a site policy - -## SYNTAX - -```powershell -Set-PnPSitePolicy -Name <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSitePolicy -Name "Contoso HBI" -``` - -This applies a site policy with the name "Contoso HBI" to the current site. The policy needs to be available in the site. - -## PARAMETERS - -### -Name -The name of the site policy to apply - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md deleted file mode 100644 index 6c9cb2ef41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPSiteScript - -## SYNOPSIS -Updates an existing Site Script on the current tenant. - -## SYNTAX - -```powershell -Set-PnPSiteScript -Identity <TenantSiteScriptPipeBind> - [-Title <String>] - [-Description <String>] - [-Content <String>] - [-Version <Int>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f -Title "My Site Script" -``` - -Updates an existing Site Script and changes the title. - -### ------------------EXAMPLE 2------------------ -```powershell -$script = Get-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f -Set-PnPSiteScript -Identity $script -Title "My Site Script" -``` - -Updates an existing Site Script and changes the title. - -## PARAMETERS - -### -Content -A JSON string containing the site script - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description of the site script - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The guid or an object representing the site script - -```yaml -Type: TenantSiteScriptPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Title -The title of the site script - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Version -Specifies the version of the site script - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md deleted file mode 100644 index 2704be2d7f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPStorageEntity - -## SYNOPSIS -Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog. - -## SYNTAX - -```powershell -Set-PnPStorageEntity -Key <String> - -Value <String> - [-Comment <String>] - [-Description <String>] - [-Scope <StorageEntityScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPStorageEntity -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description" -``` - -Sets an existing or adds a new storage entity / farm property at tenant level. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPStorageEntity -Scope Site -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description" -``` - -Sets an existing or adds a new storage entity site collection level. - -## PARAMETERS - -### -Comment -The comment to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description -The description to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Key -The key of the value to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Scope -Defines the scope of the storage entity. Defaults to Tenant. - -```yaml -Type: StorageEntityScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Value -The value to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md deleted file mode 100644 index 6dee410ad6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTaxonomyFieldValue - -## SYNOPSIS -Sets a taxonomy term value in a listitem field - -## SYNTAX - -### ITEMS -```powershell -Set-PnPTaxonomyFieldValue -ListItem <ListItem> - -InternalFieldName <String> - [-Terms <Hashtable>] - [-Connection <SPOnlineConnection>] -``` - -### ITEM -```powershell -Set-PnPTaxonomyFieldValue -TermId <GuidPipeBind> - -ListItem <ListItem> - -InternalFieldName <String> - [-Label <String>] - [-Connection <SPOnlineConnection>] -``` - -### PATH -```powershell -Set-PnPTaxonomyFieldValue -TermPath <String> - -ListItem <ListItem> - -InternalFieldName <String> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermId 863b832b-6818-4e6a-966d-2d3ee057931c -``` - -Sets the field called 'Department' to the value of the term with the ID specified - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermPath 'CORPORATE|DEPARTMENTS|HR' -``` - -Sets the field called 'Department' to the term called HR which is located in the DEPARTMENTS termset, which in turn is located in the CORPORATE termgroup. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -Terms @{"TermId1"="Label1";"TermId2"="Label2"} -``` - -Sets the field called 'Department' with multiple terms by ID and label. You can refer to those terms with the {ID:label} token. - -## PARAMETERS - -### -InternalFieldName -The internal name of the field - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Label -The Label value of the term - -```yaml -Type: String -Parameter Sets: ITEM - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ListItem -The list item to set the field value to - -```yaml -Type: ListItem -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TermId -The Id of the Term - -```yaml -Type: GuidPipeBind -Parameter Sets: ITEM - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -TermPath -A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL - -```yaml -Type: String -Parameter Sets: PATH - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Terms -Allows you to specify terms with key value pairs that can be referred to in the template by means of the {id:label} token. See examples on how to use this parameter. - -```yaml -Type: Hashtable -Parameter Sets: ITEMS - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md deleted file mode 100644 index 6d9ccd6f37..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md +++ /dev/null @@ -1,1004 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTenant - -## SYNOPSIS -Sets organization-level site collection properties - -## SYNTAX - -```powershell -Set-PnPTenant [-MinCompatibilityLevel <Int>] - [-MaxCompatibilityLevel <Int>] - [-ExternalServicesEnabled <Boolean>] - [-NoAccessRedirectUrl <String>] - [-SharingCapability <SharingCapabilities>] - [-DisplayStartASiteOption <Boolean>] - [-StartASiteFormUrl <String>] - [-ShowEveryoneClaim <Boolean>] - [-ShowAllUsersClaim <Boolean>] - [-ShowEveryoneExceptExternalUsersClaim <Boolean>] - [-SearchResolveExactEmailOrUPN <Boolean>] - [-OfficeClientADALDisabled <Boolean>] - [-LegacyAuthProtocolsEnabled <Boolean>] - [-RequireAcceptingAccountMatchInvitedAccount <Boolean>] - [-ProvisionSharedWithEveryoneFolder <Boolean>] - [-SignInAccelerationDomain <String>] - [-EnableGuestSignInAcceleration <Boolean>] - [-UsePersistentCookiesForExplorerView <Boolean>] - [-BccExternalSharingInvitations <Boolean>] - [-BccExternalSharingInvitationsList <String>] - [-UserVoiceForFeedbackEnabled <Boolean>] - [-PublicCdnEnabled <Boolean>] - [-PublicCdnAllowedFileTypes <String>] - [-RequireAnonymousLinksExpireInDays <Int>] - [-SharingAllowedDomainList <String>] - [-SharingBlockedDomainList <String>] - [-SharingDomainRestrictionMode <SharingDomainRestrictionModes>] - [-OneDriveStorageQuota <Int>] - [-OneDriveForGuestsEnabled <Boolean>] - [-IPAddressEnforcement <Boolean>] - [-IPAddressAllowList <String>] - [-IPAddressWACTokenLifetime <Int>] - [-UseFindPeopleInPeoplePicker <Boolean>] - [-DefaultSharingLinkType <SharingLinkType>] - [-ODBMembersCanShare <SharingState>] - [-ODBAccessRequests <SharingState>] - [-PreventExternalUsersFromResharing <Boolean>] - [-ShowPeoplePickerSuggestionsForGuestUsers <Boolean>] - [-FileAnonymousLinkType <AnonymousLinkType>] - [-FolderAnonymousLinkType <AnonymousLinkType>] - [-NotifyOwnersWhenItemsReshared <Boolean>] - [-NotifyOwnersWhenInvitationsAccepted <Boolean>] - [-NotificationsInOneDriveForBusinessEnabled <Boolean>] - [-NotificationsInSharePointEnabled <Boolean>] - [-OwnerAnonymousNotification <Boolean>] - [-CommentsOnSitePagesDisabled <Boolean>] - [-SocialBarOnSitePagesDisabled <Boolean>] - [-OrphanedPersonalSitesRetentionPeriod <Int>] - [-DisallowInfectedFileDownload <Boolean>] - [-DefaultLinkPermission <SharingPermissionType>] - [-ConditionalAccessPolicy <SPOConditionalAccessPolicyType>] - [-AllowDownloadingNonWebViewableFiles <Boolean>] - [-AllowEditing <Boolean>] - [-ApplyAppEnforcedRestrictionsToAdHocRecipients <Boolean>] - [-FilePickerExternalImageSearchEnabled <Boolean>] - [-EmailAttestationRequired <Boolean>] - [-EmailAttestationReAuthDays <Int>] - [-HideDefaultThemes <Boolean>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, -ResourceQuotaAllocated, and SiteCreationMode. - -You must be a SharePoint Online global administrator to run the cmdlet. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTenantSite -Identity https://contoso.sharepoint.com/sites/team1 -LockState NoAccess -Set-PnPTenant -NoAccessRedirectUrl 'http://www.contoso.com/' -``` - -This example blocks access to https://contoso.sharepoint.com/sites/team1 and redirects traffic to http://www.contoso.com. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPTenant -ShowEveryoneExceptExternalUsersClaim $false -``` - -This example hides the "Everyone Except External Users" claim in People Picker. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPTenant -ShowAllUsersClaim $false -``` - -This example hides the "All Users" claim group in People Picker. - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPTenant -UsePersistentCookiesForExplorerView $true -``` - -This example enables the use of special persisted cookie for Open with Explorer. - -## PARAMETERS - -### -AllowDownloadingNonWebViewableFiles - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -AllowEditing - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ApplyAppEnforcedRestrictionsToAdHocRecipients - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -BccExternalSharingInvitations -When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. - -The valid values are: -False (default) - BCC for external sharing is disabled. -True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -BccExternalSharingInvitationsList -Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. -Multiple addresses can be specified by creating a comma separated list with no spaces. - -The valid values are: -"" (default) - Blank by default, this will also clear any value that has been set. -Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CommentsOnSitePagesDisabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ConditionalAccessPolicy - - -```yaml -Type: SPOConditionalAccessPolicyType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DefaultLinkPermission - - -```yaml -Type: SharingPermissionType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DefaultSharingLinkType -Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. - -For additional information about how to change the default link type, see Change the default link type when users get links for sharing. - -Note: -Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. - -The values are: None Direct Internal AnonymousAccess - -```yaml -Type: SharingLinkType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisallowInfectedFileDownload -Prevents the Download button from being displayed on the Virus Found warning page. - -Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. - - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayStartASiteOption -Determines whether tenant users see the Start a Site menu option. - -The valid values are: -True (default) - Tenant users will see the Start a Site menu option. -False - Start a Site is hidden from the menu. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EmailAttestationReAuthDays - - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EmailAttestationRequired - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableGuestSignInAcceleration -Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. - -Note: -If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ExternalServicesEnabled -Enables external services for a tenant. -External services are defined as services that are not in the Office 365 datacenters. - -The valid values are: -True (default) - External services are enabled for the tenant. -False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -FileAnonymousLinkType - - -```yaml -Type: AnonymousLinkType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -FilePickerExternalImageSearchEnabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -FolderAnonymousLinkType - - -```yaml -Type: AnonymousLinkType -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -HideDefaultThemes -Defines if the default themes are visible or hidden - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IPAddressAllowList -Configures multiple IP addresses or IP address ranges (IPv4 or IPv6). - -Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. - -Note: -The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IPAddressEnforcement -Allows access from network locations that are defined by an administrator. - -The values are $true and $false. The default value is $false which means the setting is disabled. - -Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IPAddressWACTokenLifetime - - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LegacyAuthProtocolsEnabled -By default this value is set to $true. - -Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. - -A value of $true - Enables Office clients using non-modern authentication protocols(such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. - -A value of $false - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. - -Note: -This may also prevent third-party apps from accessing SharePoint Online resources.Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources.For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MaxCompatibilityLevel -Specifies the upper bound on the compatibility level for new sites. - -```yaml -Type: Int -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MinCompatibilityLevel -Specifies the lower bound on the compatibility level for new sites. - -```yaml -Type: Int -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NoAccessRedirectUrl -Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess" - -The valid values are: -""(default) - Blank by default, this will also remove or clear any value that has been set. -Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NotificationsInOneDriveForBusinessEnabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NotificationsInSharePointEnabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NotifyOwnersWhenInvitationsAccepted -When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. - -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. - -The values are $true and $false. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NotifyOwnersWhenItemsReshared -When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. - -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. - -The values are $true and $false. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ODBAccessRequests -Lets administrators set policy on access requests and requests to share in OneDrive for Business. - -Values: - -On- Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. - -Off- Prevent access requests and requests to share on OneDrive for Business. - -Unspecified- Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive. - -```yaml -Type: SharingState -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ODBMembersCanShare -Lets administrators set policy on re-sharing behavior in OneDrive for Business. - -Values: - -On- Users with edit permissions can re-share. - -Off- Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. - -Unspecified- Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive. - -```yaml -Type: SharingState -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OfficeClientADALDisabled -When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. - -The valid values are: -False (default) - Modern Authentication is enabled/allowed. -True - Modern Authentication via ADAL is disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OneDriveForGuestsEnabled -Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. - -The valid values are the following: - -$true-Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. - -$false- Administrator managed Guest users can't be given OneDrives as functionality is turned off. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OneDriveStorageQuota -Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. - -A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. - -If value is set to 0, the parameter will have no effect. - -If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OrphanedPersonalSitesRetentionPeriod -Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. - -The value range is in days, between 30 and 3650. The default value is 30. - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -OwnerAnonymousNotification - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PreventExternalUsersFromResharing - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ProvisionSharedWithEveryoneFolder -Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. - -The valid values are: -True (default) - The Shared with Everyone folder is created. -False - No folder is created when the site and OneDrive for Business document library is created. - -The default behavior of the Shared with Everyone folder changed in August 2015. -For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US) - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PublicCdnAllowedFileTypes - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PublicCdnEnabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RequireAcceptingAccountMatchInvitedAccount -Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. - -Administrators who desire increased control over external collaborators should consider enabling this feature. - -Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. - -The valid values are: -False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. -True - User must accept this invitation with bob@contoso.com. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RequireAnonymousLinksExpireInDays -Specifies all anonymous links that have been created (or will be created) will expire after the set number of days . - -To remove the expiration requirement, set the value to zero (0). - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SearchResolveExactEmailOrUPN -Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. - -SharePoint Administrators will still be able to use starts with or partial name matching when enabled. - -The valid values are: -False (default) - Starts with / partial name search functionality is available. -True - Disables starts with / partial name search functionality for all SharePoint users, except SharePoint Admins. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SharingAllowedDomainList -Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SharingBlockedDomainList -Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SharingCapability -Determines what level of sharing is available for the site. - -The valid values are: -ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. Disabled - External user sharing (share by email) and guest link sharing are both disabled. -ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. - -For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx). - -```yaml -Type: SharingCapabilities -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SharingDomainRestrictionMode -Specifies the external sharing mode for domains. - -The following values are: None AllowList BlockList - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. - -```yaml -Type: SharingDomainRestrictionModes -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShowAllUsersClaim -Enables the administrator to hide the All Users claim groups in People Picker. - -When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organtization members in the tenant that used NTLM to authentication with SharePoint. - -Note, the All Users(authenticated) group is equivalent to the Everyone claim, and shows as Everyone.To change this, see - ShowEveryoneClaim. - -The valid values are: -True(default) - The All Users claim groups are displayed in People Picker. -False - The All Users claim groups are hidden in People Picker. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShowEveryoneClaim -Enables the administrator to hide the Everyone claim in the People Picker. -When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. - -Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. - -The valid values are: -True (default) - The Everyone claim group is displayed in People Picker. -False - The Everyone claim group is hidden from the People Picker. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShowEveryoneExceptExternalUsersClaim -Enables the administrator to hide the "Everyone except external users" claim in the People Picker. -When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. - -The valid values are: -True(default) - The Everyone except external users is displayed in People Picker. -False - The Everyone except external users claim is not visible in People Picker. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ShowPeoplePickerSuggestionsForGuestUsers - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SignInAccelerationDomain -Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. - -When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. -This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. - -Acceleration will not occur on site collections that are shared externally. - -This value should be configured with the login domain that is used by your company (that is, example@contoso.com). - -If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. - -The valid values are: -"" (default) - Blank by default, this will also remove or clear any value that has been set. -Login Domain - For example: "contoso.com" - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SocialBarOnSitePagesDisabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StartASiteFormUrl -Specifies URL of the form to load in the Start a Site dialog. - -The valid values are: -"" (default) - Blank by default, this will also remove or clear any value that has been set. -Full URL - Example: "https://contoso.sharepoint.com/path/to/form" - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UseFindPeopleInPeoplePicker -Note: -When set to $true, users aren't able to share with security groups or SharePoint groups. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UsePersistentCookiesForExplorerView -Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. - -"Open with Explorer" requires persisted cookies to operate correctly. -When the user does not select "Keep Me Signed in" at the time of sign -in, "Open with Explorer" will fail. - -This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. - -The valid values are: -False(default) - No special cookie is generated and the normal Office 365 sign -in length / timing applies. -True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign -in. - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UserVoiceForFeedbackEnabled - - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md deleted file mode 100644 index a2ad90d60c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTenantCdnEnabled - -## SYNOPSIS -Enables or disabled the public or private Office 365 Content Delivery Network (CDN). - -## SYNTAX - -```powershell -Set-PnPTenantCdnEnabled -Enable <Boolean> - -CdnType <CdnType> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Enables or disabled the public or private Office 365 Content Delivery Network (CDN). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTenantCdnEnabled -CdnType Public -Enable $true -``` - -This example sets the Public CDN enabled. - -## PARAMETERS - -### -CdnType -The type of cdn to enable or disable - -```yaml -Type: CdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Enable -Specify to enable or disable - -```yaml -Type: Boolean -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md deleted file mode 100644 index ec3c62c2dc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTenantCdnPolicy - -## SYNOPSIS -Sets the CDN Policies for the specified CDN (Public | Private). - -## SYNTAX - -```powershell -Set-PnPTenantCdnPolicy -CdnType <SPOTenantCdnType> - -PolicyType <SPOTenantCdnPolicyType> - -PolicyValue <String> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets the CDN Policies for the specified CDN (Public | Private). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF" -``` - -This example sets the IncludeFileExtensions policy to the specified value. - -## PARAMETERS - -### -CdnType -The type of cdn to retrieve the policies from - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PolicyType -The type of the policy to set - -```yaml -Type: SPOTenantCdnPolicyType -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PolicyValue -The value of the policy to set - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md deleted file mode 100644 index 46c02aa4c9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTenantSite - -## SYNOPSIS -Set site information. - -## SYNTAX - -### Set Properties -```powershell -Set-PnPTenantSite -Url <String> - [-Title <String>] - [-Sharing <SharingCapabilities>] - [-StorageMaximumLevel <Int>] - [-StorageWarningLevel <Int>] - [-UserCodeMaximumLevel <Double>] - [-UserCodeWarningLevel <Double>] - [-AllowSelfServiceUpgrade [<SwitchParameter>]] - [-Owners <String>] - [-NoScriptSite [<SwitchParameter>]] - [-Wait [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -### Set Lock State -```powershell -Set-PnPTenantSite -Url <String> - [-LockState <SiteLockState>] - [-Wait [<SwitchParameter>]] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets site properties for existing sites. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title "Contoso Website" -Sharing Disabled -``` - -This will set the title of the site collection with the URL 'https://contoso.sharepoint.com/' to 'Contoso Website' and disable sharing on this site collection. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title "Contoso Website" -StorageWarningLevel 8000 -StorageMaximumLevel 10000 -``` - -This will set the title of the site collection with the URL 'https://contoso.sharepoint.com/' to 'Contoso Website', set the storage warning level to 8GB and set the storage maximum level to 10GB. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners "user@contoso.onmicrosoft.com" -``` - -This will add user@contoso.onmicrosoft.com as an additional site collection owner at 'https://contoso.sharepoint.com/sites/sales'. - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") -``` - -This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional site collection owners at 'https://contoso.sharepoint.com/sites/sales'. - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -NoScriptSite:$false -``` - -This will enable script support for the site 'https://contoso.sharepoint.com/sites/sales' if disabled. - -## PARAMETERS - -### -AllowSelfServiceUpgrade -Specifies if the site administrator can upgrade the site collection - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LockState -Sets the lockstate of a site - -```yaml -Type: SiteLockState -Parameter Sets: Set Lock State - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NoScriptSite -Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. - -```yaml -Type: SwitchParameter -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owners -Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups. - -```yaml -Type: String -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Sharing -Specifies what the sharing capablilites are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly - -```yaml -Type: SharingCapabilities -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StorageMaximumLevel -Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. - -```yaml -Type: Int -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StorageWarningLevel -Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter - -```yaml -Type: Int -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title -Specifies the title of the site - -```yaml -Type: String -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -Specifies the URL of the site - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -UserCodeMaximumLevel -Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. - -```yaml -Type: Double -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UserCodeWarningLevel -Specifies the warning level for the resource quota. This value must not exceed the value set for the UserCodeMaximumLevel parameter - -```yaml -Type: Double -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Wait -Wait for the operation to complete - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md deleted file mode 100644 index 034f67d6fe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTheme - -## SYNOPSIS -Sets the theme of the current web. - -## SYNTAX - -```powershell -Set-PnPTheme [-ColorPaletteUrl <String>] - [-FontSchemeUrl <String>] - [-BackgroundImageUrl <String>] - [-ResetSubwebsToInherit [<SwitchParameter>]] - [-UpdateRootWebOnly [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION - Sets the theme of the current web, if any of the attributes is not set, that value will be set to null - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTheme -``` - -Removes the current theme and resets it to the default. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -``` - - - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -BackgroundImageUrl 'style library/background.png' -``` - - - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -BackgroundImageUrl 'style library/background.png' -ResetSubwebsToInherit -``` - -Sets the theme to the web, and updates all subwebs to inherit the theme from this web. - -## PARAMETERS - -### -BackgroundImageUrl -Specifies the Background Image Url based on the site or server relative url - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ColorPaletteUrl -Specifies the Color Palette Url based on the site or server relative url - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -FontSchemeUrl -Specifies the Font Scheme Url based on the site or server relative url - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ResetSubwebsToInherit -Resets subwebs to inherit the theme from the rootweb - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UpdateRootWebOnly -Updates only the rootweb, even if subwebs are set to inherit the theme. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md deleted file mode 100644 index 5a000b79e5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPTraceLog - -## SYNOPSIS -Turn log tracing on or off - -## SYNTAX - -### On -```powershell -Set-PnPTraceLog -On [<SwitchParameter>] - [-LogFile <String>] - [-Level <LogLevel>] - [-Delimiter <String>] - [-IndentSize <Int>] - [-AutoFlush <Boolean>] -``` - -### Off -```powershell -Set-PnPTraceLog -Off [<SwitchParameter>] -``` - -## DESCRIPTION -Defines if tracing should be turned on. PnP Core, which is the foundation of these cmdlets, uses the standard Trace functionality of .NET. With this cmdlet you can turn capturing of this trace to a log file on or off. Notice that basically only the Provisioning Engine writes to the tracelog which means that cmdlets related to the engine will produce output. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPTraceLog -On -LogFile traceoutput.txt -``` - -This turns on trace logging to the file 'traceoutput.txt' and will capture events of at least 'Information' level. - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPTraceLog -On -LogFile traceoutput.txt -Level Debug -``` - -This turns on trace logging to the file 'traceoutput.txt' and will capture debug events. - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPTraceLog -On -LogFile traceoutput.txt -Level Debug -Delimiter "," -``` - -This turns on trace logging to the file 'traceoutput.txt' and will write the entries as comma separated. Debug events are captured. - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPTraceLog -Off -``` - -This turns off trace logging. It will flush any remaining messages to the log file. - -## PARAMETERS - -### -AutoFlush -Auto flush the trace log. Defaults to true. - -```yaml -Type: Boolean -Parameter Sets: On - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Delimiter -If specified the trace log entries will be delimited with this value. - -```yaml -Type: String -Parameter Sets: On - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -IndentSize -Indents in the tracelog will be with this amount of characters. Defaults to 4. - -```yaml -Type: Int -Parameter Sets: On - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Level -The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'. - -```yaml -Type: LogLevel -Parameter Sets: On - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -LogFile -The path and filename of the file to write the trace log to. - -```yaml -Type: String -Parameter Sets: On - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Off -Turn off tracing to log file. - -```yaml -Type: SwitchParameter -Parameter Sets: Off - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -On -Turn on tracing to log file - -```yaml -Type: SwitchParameter -Parameter Sets: On - -Required: True -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md deleted file mode 100644 index 7d212d1917..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPUnifiedGroup - -## SYNOPSIS -Sets Office 365 Group (aka Unified Group) properties - -## SYNTAX - -```powershell -Set-PnPUnifiedGroup -Identity <UnifiedGroupPipeBind> - [-DisplayName <String>] - [-Description <String>] - [-Owners <String[]>] - [-Members <String[]>] - [-IsPrivate [<SwitchParameter>]] - [-GroupLogoPath <String>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPUnifiedGroup -Identity $group -DisplayName "My Displayname" -``` - -Sets the display name of the group where $group is a Group entity - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPUnifiedGroup -Identity $groupId -Descriptions "My Description" -DisplayName "My DisplayName" -``` - -Sets the display name and description of a group based upon its ID - -### ------------------EXAMPLE 3------------------ -```powershell -Set-PnPUnifiedGroup -Identity $group -GroupLogoPath ".\MyLogo.png" -``` - -Sets a specific Office 365 Group logo. - -### ------------------EXAMPLE 4------------------ -```powershell -Set-PnPUnifiedGroup -Identity $group -IsPrivate:$false -``` - -Sets a group to be Public if previously Private. - -### ------------------EXAMPLE 5------------------ -```powershell -Set-PnPUnifiedGroup -Identity $group -Owners demo@contoso.com -``` - -Adds demo@contoso.com as an additional owner to the group. - -## PARAMETERS - -### -Description -The Description of the group to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DisplayName -The DisplayName of the group to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -GroupLogoPath -The path to the logo file of to set. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The Identity of the Office 365 Group. - -```yaml -Type: UnifiedGroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -IsPrivate -Makes the group private when selected. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Members -The array UPN values of members to set to the group. Note: Will replace members. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Owners -The array UPN values of owners to set to the group. Note: Will replace owners. - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md deleted file mode 100644 index bef796d90c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPUserProfileProperty - -## SYNOPSIS -Office365 only: Uses the tenant API to retrieve site information. - -You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. - - -## SYNTAX - -### Single -```powershell -Set-PnPUserProfileProperty -Value <String> - -Account <String> - -PropertyName <String> - [-Connection <SPOnlineConnection>] -``` - -### Multi -```powershell -Set-PnPUserProfileProperty -Values <String[]> - -Account <String> - -PropertyName <String> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Requires a connection to a SharePoint Tenant Admin site. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm' -``` - -Sets the SPS-Location property for the user as specified by the Account parameter - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2' -``` - -Sets the MyProperty multi value property for the user as specified by the Account parameter - -## PARAMETERS - -### -Account -The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PropertyName -The property to set, for instance SPS-Skills or SPS-Location - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Value -The value to set in the case of a single value property - -```yaml -Type: String -Parameter Sets: Single - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Values -The values set in the case of a multi value property, e.g. "Value 1","Value 2" - -```yaml -Type: String[] -Parameter Sets: Multi - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md deleted file mode 100644 index c2fdb5deca..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPView - -## SYNOPSIS -Change view properties - -## SYNTAX - -```powershell -Set-PnPView -Identity <ViewPipeBind> - -Values <Hashtable> - [-List <ListPipeBind>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets one or more properties of an existing view. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPView -List "Tasks" -Identity "All Tasks" -Values @{JSLink="hierarchytaskslist.js|customrendering.js";Title="My view"} -``` - -Updates the "All Tasks" view on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to "My view" - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPList -Identity "Tasks" | Get-PnPView | Set-PnPView -Values @{JSLink="hierarchytaskslist.js|customrendering.js"} -``` - -Updates all views on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink - -## PARAMETERS - -### -Identity -The Id, Title or instance of the view - -```yaml -Type: ViewPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -List -The Id, Title or Url of the list - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: False -``` - -### -Values -Hashtable of properties to update on the view. Use the syntax @{property1="value";property2="value"}. - -```yaml -Type: Hashtable -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### Microsoft.SharePoint.Client.Field - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md deleted file mode 100644 index 9b651661ae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPWeb - -## SYNOPSIS -Sets properties on a web - -## SYNTAX - -```powershell -Set-PnPWeb [-SiteLogoUrl <String>] - [-AlternateCssUrl <String>] - [-Title <String>] - [-Description <String>] - [-MasterUrl <String>] - [-CustomMasterUrl <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets properties on a web - -## PARAMETERS - -### -AlternateCssUrl - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CustomMasterUrl - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Description - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MasterUrl - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SiteLogoUrl -Sets the logo of the web to the current url. If you want to set the logo to a modern team site, use Set-PnPSite -SiteLogoPath - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Title - - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md deleted file mode 100644 index a77a794788..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPWebPartProperty - -## SYNOPSIS -Sets a web part property - -## SYNTAX - -```powershell -Set-PnPWebPartProperty -ServerRelativePageUrl <String> - -Identity <GuidPipeBind> - -Key <String> - -Value <PSObject> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -Value "New Title" -``` - -Sets the title property of the webpart. - -## PARAMETERS - -### -Identity -The Guid of the webpart - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Key -Name of a single property to be set - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Value -Value of the property to be set - -```yaml -Type: PSObject -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md deleted file mode 100644 index 998404ec6b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPWebPermission - -## SYNOPSIS -Set permissions - -## SYNTAX - -### Group -```powershell -Set-PnPWebPermission -Group <GroupPipeBind> - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### User -```powershell -Set-PnPWebPermission -User <String> - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### GroupByWebIdentity -```powershell -Set-PnPWebPermission -Identity <WebPipeBind> - -Group <GroupPipeBind> - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### UserByWebIdentity -```powershell -Set-PnPWebPermission -Identity <WebPipeBind> - -User <String> - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### GroupByWebUrl -```powershell -Set-PnPWebPermission -Url <String> - -Group <GroupPipeBind> - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### UserByWebUrl -```powershell -Set-PnPWebPermission -Url <String> - -User <String> - [-AddRole <String[]>] - [-RemoveRole <String[]>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets web permissions - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPWebPermission -Url projectA -User 'user@contoso.com' -AddRole 'Contribute' -``` - -Adds the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its site relative url - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPWebPermission -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0 -User 'user@contoso.com' -RemoveRole 'Contribute' -``` - -Removes the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its ID - -## PARAMETERS - -### -AddRole -The role that must be assigned to the group or user - -```yaml -Type: String[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Group - - -```yaml -Type: GroupPipeBind -Parameter Sets: Group, GroupByWebIdentity, GroupByWebUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Identity -Identity/Id/Web object - -```yaml -Type: WebPipeBind -Parameter Sets: GroupByWebIdentity, UserByWebIdentity - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -RemoveRole -The role that must be removed from the group or user - -```yaml -Type: String[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Url -The site relative url of the web, e.g. 'Subweb1' - -```yaml -Type: String -Parameter Sets: GroupByWebUrl, UserByWebUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -User - - -```yaml -Type: String -Parameter Sets: User, UserByWebIdentity, UserByWebUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md deleted file mode 100644 index a0e8883628..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPWebTheme - -## SYNOPSIS -Sets the theme of the current web. - -## SYNTAX - -```powershell -Set-PnPWebTheme [-Theme <ThemePipeBind>] - [-WebUrl <String>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Sets the theme of the current web. * Requires Tenant Administration Rights * - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPWebTheme -Theme MyTheme -``` - -Sets the theme named "MyTheme" to the current web - -### ------------------EXAMPLE 2------------------ -```powershell -Get-PnPTenantTheme -Name "MyTheme" | Set-PnPWebTheme -``` - -Sets the theme named "MyTheme" to the current web - -## PARAMETERS - -### -Theme -Specifies the Color Palette Url based on the site or server relative url - -```yaml -Type: ThemePipeBind -Parameter Sets: (All) - -Required: False -Position: 0 -Accept pipeline input: True -``` - -### -WebUrl -The URL of the web to apply the theme to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline. - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md deleted file mode 100644 index 34a92c36cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Set-PnPWebhookSubscription - -## SYNOPSIS -Updates a Webhook subscription - -## SYNTAX - -```powershell -Set-PnPWebhookSubscription -Subscription <WebhookSubscriptionPipeBind> - [-List <ListPipeBind>] - [-NotificationUrl <String>] - [-ExpirationDate <DateTime>] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Set-PnPWebhookSubscription -List MyList -Subscription ea1533a8-ff03-415b-a7b6-517ee50db8b6 -NotificationUrl https://my-func.azurewebsites.net/webhook -``` - -Updates an existing Webhook subscription with the specified id on the list MyList with a new Notification Url - -### ------------------EXAMPLE 2------------------ -```powershell -Set-PnPWebhookSubscription -List MyList -Subscription ea1533a8-ff03-415b-a7b6-517ee50db8b6 -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -``` - -Updates an existing Webhook subscription with the specified id on the list MyList with a new Notification Url and a new expiration date - -### ------------------EXAMPLE 3------------------ -```powershell -$subscriptions = Get-PnPWebhookSubscriptions -List MyList -$updated = $subscriptions[0] -$updated.ExpirationDate = "2017-10-01" -Set-PnPWebhookSubscription -List MyList -Subscription $updated -``` - -Updates the Webhook subscription from the list MyList with a modified subscription object. -Note: The date will be converted to Universal Time - -## PARAMETERS - -### -ExpirationDate -The date at which the Webhook subscription will expire. (Default: 6 months from today) - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -List -The list object or name from which the Webhook subscription will be modified - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -NotificationUrl -The URL of the Webhook endpoint that will be notified of the change - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Subscription -The identity of the Webhook subscription to update - -```yaml -Type: WebhookSubscriptionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### OfficeDevPnP.Core.Entities.WebhookSubscription - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md deleted file mode 100644 index 4b926aa824..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Set-PnPWikiPageContent - -## SYNOPSIS -Sets the contents of a wikipage - -## SYNTAX - -### STRING -```powershell -Set-PnPWikiPageContent -Content <String> - -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### FILE -```powershell -Set-PnPWikiPageContent -Path <String> - -ServerRelativePageUrl <String> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## PARAMETERS - -### -Content - - -```yaml -Type: String -Parameter Sets: STRING - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Path - - -```yaml -Type: String -Parameter Sets: FILE - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -ServerRelativePageUrl -Site Relative Page Url - -```yaml -Type: String -Parameter Sets: FILE, STRING -Aliases: PageUrl - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md deleted file mode 100644 index 9120b6ae3d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Start-PnPWorkflowInstance - -## SYNOPSIS -Starts a workflow instance on a list item - -## SYNTAX - -```powershell -Start-PnPWorkflowInstance -Subscription <WorkflowSubscriptionPipeBind> - -ListItem <ListItemPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem $item -``` - -Starts a workflow instance on the specified list item - -### ------------------EXAMPLE 2------------------ -```powershell -Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem 2 -``` - -Starts a workflow instance on the specified list item - -## PARAMETERS - -### -ListItem -The list item to start the workflow against - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: 1 -Accept pipeline input: False -``` - -### -Subscription -The workflow subscription to start - -```yaml -Type: WorkflowSubscriptionPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md deleted file mode 100644 index 3a28d26b30..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Stop-PnPWorkflowInstance - -## SYNOPSIS -Stops a workflow instance - -## SYNTAX - -```powershell -Stop-PnPWorkflowInstance -Identity <WorkflowInstancePipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Stop-PnPWorkflowInstance -identity $wfInstance -``` - -Stops the workflow Instance - -## PARAMETERS - -### -Force -Forcefully terminate the workflow instead of cancelling. Works on errored and non-responsive workflows. Deletes all created tasks. Does not notify participants. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -The instance to stop - -```yaml -Type: WorkflowInstancePipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md deleted file mode 100644 index 97b795e435..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Submit-PnPSearchQuery - -## SYNOPSIS -Executes an arbitrary search query against the SharePoint search index - -## SYNTAX - -### Limit -```powershell -Submit-PnPSearchQuery -Query <String> - [-StartRow <Int>] - [-MaxResults <Int>] - [-TrimDuplicates <Boolean>] - [-Properties <Hashtable>] - [-Refiners <String>] - [-Culture <Int>] - [-QueryTemplate <String>] - [-SelectProperties <String[]>] - [-RefinementFilters <String[]>] - [-SortList <Hashtable>] - [-RankingModelId <String>] - [-ClientType <String>] - [-CollapseSpecification <String>] - [-HiddenConstraints <String>] - [-TimeZoneId <Int>] - [-EnablePhonetic <Boolean>] - [-EnableStemming <Boolean>] - [-EnableQueryRules <Boolean>] - [-SourceId <Guid>] - [-ProcessBestBets <Boolean>] - [-ProcessPersonalFavorites <Boolean>] - [-RelevantResults [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -### All -```powershell -Submit-PnPSearchQuery -Query <String> - [-All [<SwitchParameter>]] - [-TrimDuplicates <Boolean>] - [-Properties <Hashtable>] - [-Refiners <String>] - [-Culture <Int>] - [-QueryTemplate <String>] - [-SelectProperties <String[]>] - [-RefinementFilters <String[]>] - [-SortList <Hashtable>] - [-RankingModelId <String>] - [-ClientType <String>] - [-CollapseSpecification <String>] - [-HiddenConstraints <String>] - [-TimeZoneId <Int>] - [-EnablePhonetic <Boolean>] - [-EnableStemming <Boolean>] - [-EnableQueryRules <Boolean>] - [-SourceId <Guid>] - [-ProcessBestBets <Boolean>] - [-ProcessPersonalFavorites <Boolean>] - [-RelevantResults [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Submit-PnPSearchQuery -Query "finance" -``` - -Returns the top 500 items with the term finance - -### ------------------EXAMPLE 2------------------ -```powershell -Submit-PnPSearchQuery -Query "Title:Intranet*" -MaxResults 10 -``` - -Returns the top 10 items indexed by SharePoint Search of which the title starts with the word Intranet - -### ------------------EXAMPLE 3------------------ -```powershell -Submit-PnPSearchQuery -Query "Title:Intranet*" -All -``` - -Returns absolutely all items indexed by SharePoint Search of which the title starts with the word Intranet - -### ------------------EXAMPLE 4------------------ -```powershell -Submit-PnPSearchQuery -Query "Title:Intranet*" -Refiners "contentclass,FileType(filter=6/0/*)" -``` - -Returns absolutely all items indexed by SharePoint Search of which the title starts with the word Intranet, and return refiners for contentclass and FileType managed properties - -## PARAMETERS - -### -All -Automatically page results until the end to get more than 500. Use with caution! - -```yaml -Type: SwitchParameter -Parameter Sets: All - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ClientType -Specifies the name of the client which issued the query. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -CollapseSpecification -Limit the number of items per the collapse specification. See https://docs.microsoft.com/en-us/sharepoint/dev/general-development/customizing-search-results-in-sharepoint#collapse-similar-search-results-using-the-collapsespecification-property for more information. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Culture -The locale for the query. - -```yaml -Type: Int -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnablePhonetic -Specifies whether the phonetic forms of the query terms are used to find matches. - -```yaml -Type: Boolean -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableQueryRules -Specifies whether Query Rules are enabled for this query. - -```yaml -Type: Boolean -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -EnableStemming -Specifies whether stemming is enabled. - -```yaml -Type: Boolean -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -HiddenConstraints -The keyword query’s hidden constraints. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MaxResults -Maximum amount of search results to return. Default and max per page is 500 search results. - -```yaml -Type: Int -Parameter Sets: Limit - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ProcessBestBets -Determines whether Best Bets are enabled. - -```yaml -Type: Boolean -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -ProcessPersonalFavorites -Determines whether personal favorites data is processed or not. - -```yaml -Type: Boolean -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Properties -Extra query properties. Can for example be used for Office Graph queries. - -```yaml -Type: Hashtable -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Query -Search query in Keyword Query Language (KQL). - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -QueryTemplate -Specifies the query template that is used at run time to transform the query based on user input. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RankingModelId -The identifier (ID) of the ranking model to use for the query. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RefinementFilters -The set of refinement filters used. - -```yaml -Type: String[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Refiners -The list of refiners to be returned in a search result. - -```yaml -Type: String -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -RelevantResults -Specifies whether only relevant results are returned - -```yaml -Type: SwitchParameter -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SelectProperties -The list of properties to return in the search results. - -```yaml -Type: String[] -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SortList -The list of properties by which the search results are ordered. - -```yaml -Type: Hashtable -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -SourceId -Specifies the identifier (ID or name) of the result source to be used to run the query. - -```yaml -Type: Guid -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -StartRow -Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results. - -```yaml -Type: Int -Parameter Sets: Limit - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TimeZoneId -The identifier for the search query time zone. - -```yaml -Type: Int -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -TrimDuplicates -Specifies whether near duplicate items should be removed from the search results. - -```yaml -Type: Boolean -Parameter Sets: __AllParameterSets - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## OUTPUTS - -### List<System.Object> - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md deleted file mode 100644 index 117250a2cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Test-PnPListItemIsRecord - -## SYNOPSIS -Checks if a list item is a record - -## SYNTAX - -```powershell -Test-PnPListItemIsRecord -List <ListPipeBind> - -Identity <ListItemPipeBind> - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Test-PnPListItemIsRecord -List "Documents" -Identity 4 -``` - -Returns true if the document in the documents library with id 4 is a record - -## PARAMETERS - -### -Identity -The ID of the listitem, or actual ListItem object - -```yaml -Type: ListItemPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md deleted file mode 100644 index 3e5e18a83d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Test-PnPOffice365GroupAliasIsUsed - -## SYNOPSIS -Tests if a given alias is already used used - -## SYNTAX - -```powershell -Test-PnPOffice365GroupAliasIsUsed -Alias <String> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -This command allows you to test if a provided alias is used or free, helps decide if it can be used as part of connecting an Office 365 Unified group to an existing classic site collection. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Test-PnPOffice365GroupAliasIsUsed -Alias "MyGroup" -``` - -This will test if the alias MyGroup is already used - -## PARAMETERS - -### -Alias -Specifies the alias of the group. Cannot contain spaces. - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md deleted file mode 100644 index 6e1a1332fe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Test-PnPTenantTemplate - -## SYNOPSIS -Tests a provisioning hierarchy for invalid references - -## SYNTAX - -```powershell -Test-PnPTenantTemplate -Template <ProvisioningHierarchy> - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Test-PnPProvisioningHierarchy -Hierarchy $myhierarchy -``` - -Checks for valid template references - -## PARAMETERS - -### -Template -The in-memory template to test - -Only applicable to: SharePoint Online - -```yaml -Type: ProvisioningHierarchy -Parameter Sets: __AllParameterSets -Aliases: Hierarchy - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md deleted file mode 100644 index f0ae27c0a2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Uninstall-PnPApp - -## SYNOPSIS -Uninstalls an available add-in from the site - -## SYNTAX - -```powershell -Uninstall-PnPApp -Identity <AppMetadataPipeBind> - [-Scope <AppCatalogScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Uninstall-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will uninstall the specified app from the current site. - -### ------------------EXAMPLE 2------------------ -```powershell -Uninstall-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site -``` - -This will uninstall the specified app from the current site. Notice that the app was original installed from the site collection appcatalog. - -## PARAMETERS - -### -Identity -Specifies the Id of the Addin Instance - -Only applicable to: SharePoint Online - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -Only applicable to: SharePoint Online - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -Only applicable to: SharePoint Online - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md deleted file mode 100644 index cf34f2c132..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Uninstall-PnPAppInstance - -## SYNOPSIS -Removes an app from a site - -## SYNTAX - -```powershell -Uninstall-PnPAppInstance -Identity <AppPipeBind> - [-Force [<SwitchParameter>]] - [-Web <WebPipeBind>] - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Removes an add-in/app that has been installed to a site. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Uninstall-PnPAppInstance -Identity $appinstance -``` - -Uninstalls the app instance which was retrieved with the command Get-PnPAppInstance - -### ------------------EXAMPLE 2------------------ -```powershell -Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' - -### ------------------EXAMPLE 3------------------ -```powershell -Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -force -``` - -Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' and do not ask for confirmation - -## PARAMETERS - -### -Force -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Identity -Appinstance or Id of the addin to remove. - -```yaml -Type: AppPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: True -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Web -This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. - -```yaml -Type: WebPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md deleted file mode 100644 index 9a8b754334..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Online -schema: 2.0.0 ---- -# Uninstall-PnPSolution - -## SYNOPSIS -Uninstalls a sandboxed solution from a site collection - -## SYNTAX - -```powershell -Uninstall-PnPSolution -PackageId <GuidPipeBind> - -PackageName <String> - [-MajorVersion <Int>] - [-MinorVersion <Int>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Uninstall-PnPSolution -PackageId c2f5b025-7c42-4d3a-b579-41da3b8e7254 -SourceFilePath mypackage.wsp -``` - -Removes the package to the current site - -## PARAMETERS - -### -MajorVersion -Optional major version of the solution, defaults to 1 - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -MinorVersion -Optional minor version of the solution, defaults to 0 - -```yaml -Type: Int -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -PackageId -ID of the solution, from the solution manifest - -```yaml -Type: GuidPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -PackageName -Filename of the WSP file to uninstall - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md deleted file mode 100644 index e60e6feff8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Unpublish-PnPApp - -## SYNOPSIS -Unpublishes/retracts an available add-in from the app catalog - -## SYNTAX - -```powershell -Unpublish-PnPApp -Identity <AppMetadataPipeBind> - [-Scope <AppCatalogScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will retract, but not remove, the specified app from the tenant app catalog - -### ------------------EXAMPLE 2------------------ -```powershell -Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site -``` - -This will retract, but not remove, the specified app from the site collection app catalog - -## PARAMETERS - -### -Identity -Specifies the Id of the Addin Instance - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md deleted file mode 100644 index d9d299a381..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Unregister-PnPHubSite - -## SYNOPSIS -Unregisters a site as a hubsite - -## SYNTAX - -```powershell -Unregister-PnPHubSite -Site <SitePipeBind> - [-Connection <SPOnlineConnection>] -``` - -## DESCRIPTION -Registers a site as a hubsite - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Unregister-PnPHubSite -Site https://tenant.sharepoint.com/sites/myhubsite -``` - -This example unregisters the specified site as a hubsite - -## PARAMETERS - -### -Site -The site to unregister as a hubsite - -```yaml -Type: SitePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md deleted file mode 100644 index c125577b5f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Update-PnPApp - -## SYNOPSIS -Updates an available app from the app catalog - -## SYNTAX - -```powershell -Update-PnPApp -Identity <AppMetadataPipeBind> - [-Scope <AppCatalogScope>] - [-Connection <SPOnlineConnection>] -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Update-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -``` - -This will update an already installed app if a new version is available in the tenant app catalog. Retrieve a list all available apps and the installed and available versions with Get-PnPApp - -### ------------------EXAMPLE 2------------------ -```powershell -Update-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site -``` - -This will update an already installed app if a new version is available in the site collection app catalog. Retrieve a list all available apps and the installed and available versions with Get-PnPApp -Scope Site - -## PARAMETERS - -### -Identity -Specifies the Id or an actual app metadata instance - -```yaml -Type: AppMetadataPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Accept pipeline input: True -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: SPOnlineConnection -Parameter Sets: (All) - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md deleted file mode 100644 index 5d7db16b79..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -applicable: SharePoint Online -schema: 2.0.0 ---- -# Update-PnPSiteClassification - -## SYNOPSIS -Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph. - -## SYNTAX - -### Specific -```powershell -Update-PnPSiteClassification [-Classifications <String>] - [-DefaultClassification <String>] - [-UsageGuidelinesUrl <String>] -``` - -### Settings -```powershell -Update-PnPSiteClassification -Settings <SiteClassificationsSettings> -``` - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Update-PnPSiteClassification -Classifications "HBI","Top Secret" -``` - -Replaces the existing values of the site classification settings - -### ------------------EXAMPLE 2------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Update-PnPSiteClassification -DefaultClassification "LBI" -``` - -Sets the default classification value to "LBI". This value needs to be present in the list of classification values. - -### ------------------EXAMPLE 3------------------ -```powershell -Connect-PnPOnline -Scopes "Directory.ReadWrite.All" -Update-PnPSiteClassification -UsageGuidelinesUrl http://aka.ms/sppnp -``` - -sets the usage guideliness URL to the specified URL. - -## PARAMETERS - -### -Classifications -A list of classifications, separated by commas. E.g. "HBI","LBI","Top Secret" - -```yaml -Type: String -Parameter Sets: Specific - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -DefaultClassification -The default classification to be used. The value needs to be present in the list of possible classifications - -```yaml -Type: String -Parameter Sets: Specific - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -Settings -A settings object retrieved by Get-PnPSiteClassification - -```yaml -Type: SiteClassificationsSettings -Parameter Sets: Settings - -Required: True -Position: Named -Accept pipeline input: False -``` - -### -UsageGuidelinesUrl -The UsageGuidelinesUrl. Set to "" to clear. - -```yaml -Type: String -Parameter Sets: Specific - -Required: False -Position: Named -Accept pipeline input: False -``` - -## RELATED LINKS - -[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-DatabaseToAvailabilityGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-DatabaseToAvailabilityGroup.md deleted file mode 100644 index 7f1575a864..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-DatabaseToAvailabilityGroup.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-DatabaseToAvailabilityGroup -schema: 2.0.0 ---- - -# Add-DatabaseToAvailabilityGroup - -## SYNOPSIS -Adds one or more SharePoint databases to a SQL Server Availability Group - -## SYNTAX - -### Default -``` -Add-DatabaseToAvailabilityGroup [-AGName] <String> [-AssignmentCollection <SPAssignmentCollection>] - -DatabaseName <String> [-FileShare <String>] [<CommonParameters>] -``` - -### AllDatabases -``` -Add-DatabaseToAvailabilityGroup [-AGName] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-FileShare <String>] [-ProcessAllDatabases] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-DatabaseToAvailabilityGroup cmdlet to add an availability group to the farm. - -## EXAMPLES - -### Example 1 -``` -Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -FileShare \\backup\share\ -``` - -This example adds the database WSS_Content to the availability group named "MyAvailabilityGroup". - -### Example 2 -``` -Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -ProcessAllDatabases -FileShare \\backup\share\ -``` - -This example adds all SharePoint databases attached to the farm to the availability group named "MyAvailabilityGroup" - -## PARAMETERS - -### -AGName -The name of the availability group from which the databases are being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the database to be added to the availability group. -**Note:** This parameter should not be used in conjunction with the **ProcessAllDatabases** parameter. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileShare -When a database is being added to the availability group, backup / restores are done from this location to propagate the database to all replicas. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessAllDatabases -Adds all databases from the current SharePoint farm into the availability group. - -```yaml -Type: SwitchParameter -Parameter Sets: AllDatabases -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchResource.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchResource.md deleted file mode 100644 index 7c8615c719..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchResource.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Add-FASTSearchResource ---- - -# Add-FASTSearchResource - -## SYNOPSIS -Uploads a resource to the resource store. - -## SYNTAX - -``` -Add-FASTSearchResource [-Path] <String> [-FilePath] <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet uploads a specified file, located in the local environment, to the Microsoft FAST Search Server 2010 for SharePoint resource store. -The location of the resource store is typically specified in %FASTSEARCH%/etc/Admin.config (where %FASTSEARCH% is the FAST Search Server 2010 for SharePoint installation folder.) Specify a unique location of the resource in the upload URI. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>Add-FASTSearchResource dictionaries\spellcheck\check_en.aut c:\check_en.aut -``` - -This example uploads the file c:\check_en.aut to dictionaries\spellcheck\check_en.aut to the resource store. - -## PARAMETERS - -### -Path -Partial URI within the resource store where the file will be uploaded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceURI -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -Path of the local resource to be uploaded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchResource](Get-FASTSearchResource.md) - -[Remove-FASTSearchResource](Remove-FASTSearchResource.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchSpelltuning.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchSpelltuning.md deleted file mode 100644 index 65faa5ee6a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchSpelltuning.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Add-FASTSearchSpelltuning ---- - -# Add-FASTSearchSpelltuning - -## SYNOPSIS -Enables the spell tuning processor, used to fine-tune a spell check dictionary. - -## SYNTAX - -``` -Add-FASTSearchSpelltuning [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet activates alignment of the spell checking dictionary with the index, so that spell checking dictionaries are built from content that is fed into the index (not from standardized spelling dictionaries). - -The Did You Mean feature is dictionary based; when spell tuning is activated, Did You Mean only suggests terms that are actually in the index. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### (FAST Server for SharePoint 2010) -``` - -``` - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSpelltuningStatus](Get-FASTSearchSpelltuningStatus.md) - -[Remove-FASTSearchSpelltuning](Remove-FASTSearchSpelltuning.md) - -[Reset-FASTSearchSpelltuning](Reset-FASTSearchSpelltuning.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPAppDeniedEndpoint.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPAppDeniedEndpoint.md deleted file mode 100644 index 81d9f69a68..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPAppDeniedEndpoint.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPAppDeniedEndpoint -schema: 2.0.0 ---- - -# Add-SPAppDeniedEndpoint - -## SYNOPSIS - -Adds a relative URL endpoint of a server to the list of app-denied endpoints. - - - -## SYNTAX - -``` -Add-SPAppDeniedEndpoint [-Endpoint] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-SPAppDeniedEndpoint cmdlet to add a relative URL endpoint of a server to the list of app-denied endpoints in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE------------- -``` -PS C:\>Add-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" -``` - -This example adds the "/_vti_bin/contoso/service.asmx" endpoint to the list of denied endpoints for apps. -Apps will not be able to access this endpoint. - -## PARAMETERS - -### -Endpoint -Specifies a relative URL endpoint of a server that is added to the list of app-denied endpoints. -Apps will not be able to access relative URL endpoints of a server that exist in the app-denied endpoint list. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-SPAppDeniedEndpoints](Clear-SPAppDeniedEndpoints.md) - -[Get-SPAppDeniedEndpoints](Get-SPAppDeniedEndpoints.md) - -[Remove-SPAppDeniedEndpoint](Remove-SPAppDeniedEndpoint.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPClaimTypeMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPClaimTypeMapping.md deleted file mode 100644 index 96b7a6641b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPClaimTypeMapping.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPClaimTypeMapping -schema: 2.0.0 ---- - -# Add-SPClaimTypeMapping - -## SYNOPSIS - -Adds a claim mapping to a trusted security token service (STS) identity provider. - - - -## SYNTAX - -``` -Add-SPClaimTypeMapping [-Identity] <SPClaimMappingPipeBind> - [-TrustedIdentityTokenIssuer] <SPTrustedIdentityTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPClaimTypeMapping cmdlet adds a claim type mapping rule to a security token service (STS) identity provider from a farm trust STS authentication provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>Get-SPTrustedIdentityProvider -Name "LiveIDSTS" | Add-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" -``` - -This example adds a claim mapping to a trusted identity token issuer. - -## PARAMETERS - -### -Identity -Specifies the STS for the farm that will issue the security token for the identity provider. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, ClaimMap1); or an instance of a valid SPClaimMapping object. - -```yaml -Type: SPClaimMappingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TrustedIdentityTokenIssuer -Specifies the farm trust Token Issuer (STS authentication provider). - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an authentication provider (for example, MyIDprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Overwrites the claim mapping rule if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPDiagnosticsPerformanceCounter.md deleted file mode 100644 index 2fb049b66c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPDiagnosticsPerformanceCounter.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPDiagnosticsPerformanceCounter -schema: 2.0.0 ---- - -# Add-SPDiagnosticsPerformanceCounter - -## SYNOPSIS - -Adds a new instance of a performance counter to a Web front end computer or a database server. - - - -## SYNTAX - -### AddCounter -``` -Add-SPDiagnosticsPerformanceCounter [-Category] <String> -Counter <String> [-AllInstances] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseServer] [-WebFrontEnd] [-WhatIf] - [<CommonParameters>] -``` - -### AddInstance -``` -Add-SPDiagnosticsPerformanceCounter [-Category] <String> [-Counter <String>] -Instance <String> [-AllInstances] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseServer] [-WebFrontEnd] [-WhatIf] - [<CommonParameters>] -``` - -### AddMultipleCounters -``` -Add-SPDiagnosticsPerformanceCounter [-Category] <String> [-Instance <String>] [-AllInstances] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseServer] [-WebFrontEnd] [-WhatIf] - -CounterList <String[]> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Add-SPDiagnosticsPerformanceCounter cmdlet adds a performance counter to a front end Web server or a database server. -A performance counter is read and recorded in the usage database. -By default, the new performance counter is added to the database servers in the farm. - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -C:\PS>Add-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued" -``` - -This example adds the counter that has the name ASP.NET\Requests Queued on front end Web servers. - -### ------------------EXAMPLE 2------------------ -``` -C:\PS>Add-SPDiagnosticsPerformanceCounter -category PhysicalDisk -counter "Avg. Disk Queue Length" -allinstances -``` - -This example adds all instances of the counter PhysicalDisk in the category Avg. -Disk Queue Length on front end Web servers. - -### ------------------EXAMPLE 3------------------ -``` -C:\PS>Add-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserver -``` - -This example adds the _Total instance of the counter % Processor Time in the category Processor on database servers. - -## PARAMETERS - -### -Category -Specifies the category of performance counter to add to the target Web front end computer or database server. - -The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Counter -Specifies the type of counter to add to the target Web front end computer or database server. - -The type must be a valid name of counter type; for example, Requests Queued, Avg. -Disk Queue Length, and % Processor Time. - -```yaml -Type: String -Parameter Sets: AddCounter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: AddInstance -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies the display name of the new performance counter. - -The type must be a valid name of a performance counter instance; for example Total_PerfCounter. - -```yaml -Type: String -Parameter Sets: AddInstance -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: AddMultipleCounters -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllInstances -Collects all instances of a counter category and type on the target Web front end computer or database server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Adds the specified performance counter to all database servers in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebFrontEnd -Adds the specified performance counter to all Web front end computers in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CounterList -{{Fill CounterList Description}} - -```yaml -Type: String[] -Parameter Sets: AddMultipleCounters -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPDistributedCacheServiceInstance.md deleted file mode 100644 index 9b83b98fbc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPDistributedCacheServiceInstance.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPDistributedCacheServiceInstance -schema: 2.0.0 ---- - -# Add-SPDistributedCacheServiceInstance - -## SYNOPSIS - -Adds an instance of the distributed cache service to a local server. - - - -## SYNTAX - -### (Default) -``` -Add-SPDistributedCacheServiceInstance [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### CacheSizeSet -``` -Add-SPDistributedCacheServiceInstance [-AssignmentCollection <SPAssignmentCollection>] [-CacheSizeInMB <Int32>] - [<CommonParameters>] -``` - -### LocalServerRoleSet -``` -Add-SPDistributedCacheServiceInstance [-AssignmentCollection <SPAssignmentCollection>] [-Role <SPServerRole>] - [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets](https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Add-SPDistributedCacheServiceInstance cmdlet to add an instance of the distributed cache server to a local server. This is required to start the AppFabric service. - - - -## EXAMPLES - -### Example 1 -``` -Add-SPDistributedCacheServiceInstance -``` - -This example adds an instance of the distributed cache service to a local server. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheSizeInMB -Specifies the amount of RAM to allocate for the Distributed Cache service instance. - -If this parameter is not specified, the default value will be used. - -```yaml -Type: Int32 -Parameter Sets: CacheSizeSet -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Specifies the type of server role that the Distributed Cache service instance should be configured for. - -This parameter is typically used when you are going to do a server role conversion to the specified server role. - -The valid values are: - -* SingleServerFarm -* DistributedCache -* WebFrontEndWithDistributedCache - -```yaml -Type: SPServerRole -Parameter Sets: LocalServerRoleSet -Aliases: -Accepted values: DistributedCache, SingleServerFarm, WebFrontEndWithDistributedCache -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-SPDistributedCacheServiceInstance](Remove-SPDistributedCacheServiceInstance.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPEduClassMember.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPEduClassMember.md deleted file mode 100644 index 9cef850966..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPEduClassMember.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Add-SPEduClassMember -schema: 2.0.0 ---- - -# Add-SPEduClassMember - -## SYNOPSIS -Not in use - -## SYNTAX - -``` -Add-SPEduClassMember [-AssignmentCollection <SPAssignmentCollection>] -ClassId <String> -Role <String> - -Site <SPSitePipeBind> -UserAlias <String> [<CommonParameters>] -``` - -## DESCRIPTION -Not in use - -## EXAMPLES - -### Example 1 -``` -Not in use -``` - - -## PARAMETERS - -### -AssignmentCollection -Not in use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClassId -Not in use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Role -Not in use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Site -Not in use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -UserAlias -Not in use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPEduUser.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPEduUser.md deleted file mode 100644 index 6027d7b8e9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPEduUser.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Add-SPEduUser -schema: 2.0.0 ---- - -# Add-SPEduUser - -## SYNOPSIS -Do not use - -## SYNTAX - -``` -Add-SPEduUser [-AssignmentCollection <SPAssignmentCollection>] [-FirstName <String>] [-LastName <String>] - -Role <String> -Site <SPSitePipeBind> -UserAlias <String> [-UserEmail <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - -## EXAMPLES - -### Example 1 -``` -Do not use -``` - - - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FirstName -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LastName -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Role -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Site -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -UserAlias -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -UserEmail -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPInfoPathUserAgent.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPInfoPathUserAgent.md deleted file mode 100644 index 109e5093e8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPInfoPathUserAgent.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPInfoPathUserAgent -schema: 2.0.0 ---- - -# Add-SPInfoPathUserAgent - -## SYNOPSIS -Adds a user agent to a farm. - -## SYNTAX - -``` -Add-SPInfoPathUserAgent [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPInfoPathUserAgent cmdlet creates a user agent to receive the .xml file that contains the data of the form for indexing. -The user agent receives the InfoPath 2013 files from InfoPath Forms Services in SharePoint Server instead of Web pages in response to an HTTP request. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE----------------- -``` -C:\PS>Add-SPInfoPathUserAgent -Name "NewAgent" -``` - -This example creates a new agent named NewAgent. - -## PARAMETERS - -### -Name -Specifies the name of the user agent to receive InfoPath 2013 files. -These user agents represent search bots that are commonly used in an enterprise environment. -If a different search technology is being used and InfoPath 2013 files are not being indexed, you can add additional search bots for that technology to the collection. - -The type must be a valid file name; for example UserAgentName1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPPluggableSecurityTrimmer.md deleted file mode 100644 index 62a5fd6969..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPPluggableSecurityTrimmer.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPPluggableSecurityTrimmer -schema: 2.0.0 ---- - -# Add-SPPluggableSecurityTrimmer - -## SYNOPSIS -Adds a pluggable security trimmer to a Profile service application proxy. - -## SYNTAX - -``` -Add-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId <Guid> -PlugInId <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-QualifiedTypeName <String>] [-WhatIf] - [-CustomProperties <NameValueCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-SPPluggableSecurityTrimmer cmdlet to add a specified pluggable security trimmer to a User Profile service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE 1-------------------- -``` -C:\PS>$proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} -C:\PS>Add-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0 -``` - -This example adds a pluggable security trimmer that is related to the User Profile service application proxy. - -## PARAMETERS - -### -UserProfileApplicationProxyId -Specifies the ID of the User Profile service application proxy to which you are adding the pluggable security trimmer. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlugInId -The index of the pluggable security trimmer must have an integer value greater than or equal to zero. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QualifiedTypeName -Specifies the qualified type name of the class that implements the pluggable security trimmer. - -The type must be a valid qualified type name, in the form Microsoft.Office.Server.SocialData.SocialSecurityTrimmer,Microsoft.Office.Server.UserProfiles,Version=14.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomProperties -{{Fill CustomProperties Description}} - -```yaml -Type: NameValueCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPProfileLeader.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPProfileLeader.md deleted file mode 100644 index cfb8edc009..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPProfileLeader.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPProfileLeader -schema: 2.0.0 ---- - -# Add-SPProfileLeader - -## SYNOPSIS -Adds a company leader. - -## SYNTAX - -``` -Add-SPProfileLeader [-ProfileServiceApplicationProxy] <SPServiceApplicationProxyPipeBind> - [-Name] <SPProfileLeaderPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server 2010 Service Pack 1 (SP1). - -Use the `Add-SPProfileLeader` cmdlet to add a user as the company leader in the User Profile Service Application. - -For additional information about SPProfileLeader cmdlets, see the \*-SPProfileLeader Windows PowerShell cmdlets in SharePoint Server https://go.microsoft.com/fwlink/p/?LinkId=226295. - -After you use the `Add-SPProfileLeader` cmdlet to add a company leader, you have to complete a full crawl of your content sources for the changes to take effect. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831. - -## EXAMPLES - -### ---------EXAMPLE------------ -``` -C:\PS>$upaProxy = Get-SPServiceApplicationProxy | where {$_.TypeName -eq 'User Profile Service Application Proxy'} -C:\PS>Add-SPProfileLeader -ProfileServiceApplicationProxy $upaProxy -Name "contoso\janedoe" -``` - -This example adds a company leader named Jane Doe. - -## PARAMETERS - -### -ProfileServiceApplicationProxy -Specifies the name of the User Profile Service Application Proxy to use. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the account name to be added as a leader for the new User Profile Service application. -For example, contoso\janedoe. - -```yaml -Type: SPProfileLeaderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPProfileSyncConnection.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPProfileSyncConnection.md deleted file mode 100644 index 08d57c4ee0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPProfileSyncConnection.md +++ /dev/null @@ -1,363 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPProfileSyncConnection -schema: 2.0.0 ---- - -# Add-SPProfileSyncConnection - -## SYNOPSIS -Adds a synchronization connection. - -## SYNTAX - -``` -Add-SPProfileSyncConnection [-ProfileServiceApplication] <SPServiceApplicationPipeBind> - -ConnectionDomain <String> -ConnectionForestName <String> -ConnectionPassword <SecureString> - -ConnectionSynchronizationOU <String> -ConnectionUserName <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ConnectionClaimIDMapAttribute <String>] - [-ConnectionClaimProviderIdValue <String>] [-ConnectionClaimProviderTypeValue <String>] - [-ConnectionNamingContext <String>] [-ConnectionPort <Int32>] [-ConnectionServerName <String>] - [-ConnectionUseSSL <Boolean>] [-WhatIf] [-ConnectionFilterOutUnlicensed <Boolean>] - [-ConnectionUseDisabledFilter <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the Add-SPProfileSyncConnection cmdlet to add a User Profile synchronization connection. - -For additional information about profile synchronization connections, see - -This cmdlet only works with Active Directory Synchronization Connections - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE----------- -``` -PS C:\>Add-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionForestName "fabrikam.com"-ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com" -``` - -This example adds a user from the fabrikam domain using a specific user profile service application. - -## PARAMETERS - -### -ProfileServiceApplication -Specifies the name of the User Profile service application. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectionDomain -Specifies the NetBIOS name of the domain you are connecting to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionForestName -Specifies the fully qualified domain name (FQDN) of the forest you are connecting to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionPassword -Specifies the password of the account used for directory connection. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionSynchronizationOU -Specifies the top level organizational unit (OU) that you would like to synchronize. -The value must be a domain name and you can only include one container per command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionUserName -Specifies the user name to be used for the synchronization connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionClaimIDMapAttribute -Specifies the Claims ID used by the Claim Provider, that is, samAccountName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionClaimProviderIdValue -Specifies the Claims Provider ID or Name for an authentication type while a Web App is configured. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionClaimProviderTypeValue -Specifies the Authentication claim Provider that will be used to encode the User Profile accounts names. -For example, Windows/Forms etc. -This means if a user logs in using the given Authentication Type, then a profile can be found by looking up a claim encoded credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionNamingContext -Specifies the naming context of the directory information tree to connect to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionPort -Specifies the port to be used to connect to the directory service. -The default port is 389. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionServerName -Specifies the name of the domain controller to connect to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionUseSSL -Specifies if the connection to the directory service must be over SSL. - -The valid values are: $True or $False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionFilterOutUnlicensed -Do not use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionUseDisabledFilter -Filters out disabled accounts. - ->[!NOTE] -This will only filter out accounts which are in a disabled state prior to being imported. It will not filter out accounts which have been disabled after importing. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachineInfo.md deleted file mode 100644 index c3738ef06a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachineInfo.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPRoutingMachineInfo -schema: 2.0.0 ---- - -# Add-SPRoutingMachineInfo - -## SYNOPSIS - -Adds a new routing target to the farm. - - - -## SYNTAX - -``` -Add-SPRoutingMachineInfo [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> [-Name] <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Availability <SPRoutingMachineAvailability>] - [-OutgoingPort <Int32>] [-OutgoingScheme <SPRoutingOutgoingScheme>] [-StaticWeight <Double>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-SPRoutingMachineInfo cmdlet to add a new routing target to the farm by using the RequestManagementSettings and Name parameters. - -## EXAMPLES - -### -------------EXAMPLE-------------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>Add-SPRoutingMachineInfo -RequestManagementSettings $rm -Name <MachineName> -Availability Available - -C:\PS> -``` - -This example adds a routing target for a specified identity to the farm. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to add to the routing target. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the computer to add to the route. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Availability -Specifies whether or not the added computer will be available for routing. - -The valid values are: - ---Available ---Unavailable - -```yaml -Type: SPRoutingMachineAvailability -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutgoingPort -Specifies the port used by Request Manager to make an outgoing connection. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutgoingScheme -Determines the Http scheme of outgoing connections. - -The valid values are: - ---SameAsIncoming ---Http ---Https - -```yaml -Type: SPRoutingOutgoingScheme -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticWeight -Specifies the static weight of a computer routing that is used by Request Manager. -If the static weight is higher, more requests will be routed to the computer. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPRoutingMachineInfo](Get-SPRoutingMachineInfo.md) - -[Remove-SPRoutingMachineInfo](Remove-SPRoutingMachineInfo.md) - -[Set-SPRoutingMachineInfo](Set-SPRoutingMachineInfo.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachinePool.md deleted file mode 100644 index dee73696b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachinePool.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPRoutingMachinePool -schema: 2.0.0 ---- - -# Add-SPRoutingMachinePool - -## SYNOPSIS - -Adds a new machine pool. - - - -## SYNTAX - -``` -Add-SPRoutingMachinePool [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> [-Name] <String> - [-AssignmentCollection <SPAssignmentCollection>] [-MachineTargets <SPRoutingRuleTargetPipeBind[]>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-SPRoutingMachinePool cmdlet to add a machine pool by using the RequestManagementSettings and Name parameters. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE-------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <MachineName> -``` - -This example adds a machine pool. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to add to the routing machine pool. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of machine pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MachineTargets -Specifies the routing targets collection that the machine pool will contain. - -```yaml -Type: SPRoutingRuleTargetPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPRoutingMachinePool](Get-SPRoutingMachinePool.md) - -[Remove-SPRoutingMachinePool](Remove-SPRoutingMachinePool.md) - -[Set-SPRoutingMachinePool](Set-SPRoutingMachinePool.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingRule.md deleted file mode 100644 index 56043612b8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingRule.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPRoutingRule -schema: 2.0.0 ---- - -# Add-SPRoutingRule - -## SYNOPSIS - -Adds a routing rule. - - - -## SYNTAX - -``` -Add-SPRoutingRule [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> [-Name] <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] - [-ExecutionGroup <Int32>] [-Expiration <DateTime>] [-MachinePool <SPRoutingMachinePoolPipeBind>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPRoutingRule cmdlet adds a routing rule for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE-------- -``` -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>Get-SPRoutingRule -RequestManagementSettings $rm - -C:\PS>$machines=Get-SPRoutingMachineInfo -RequestManagementSettings $rm - -C:\PS>Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machines -``` - -This examples adds a routing rule to the farm by using the $rm and $machines variables. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to add to the routing rule. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Criteria -Specifies the criteria for the rule to match. - -```yaml -Type: SPRequestManagementRuleCriteriaPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutionGroup -Specifies the group in which the rule will be placed. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expiration -Specifies the expiration date and time of the rule. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachinePool -Specifies the pool of machines to which a request will be routed if the created rule is matched. - -```yaml -Type: SPRoutingMachinePoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPRoutingRule](Get-SPRoutingRule.md) - -[Remove-SPRoutingRule](Remove-SPRoutingRule.md) - -[Set-SPRoutingRule](Set-SPRoutingRule.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPScaleOutDatabase.md deleted file mode 100644 index 6f82d29ce2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPScaleOutDatabase.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPScaleOutDatabase -schema: 2.0.0 ---- - -# Add-SPScaleOutDatabase - -## SYNOPSIS - -Adds an existing scale-out database to the specified service application. - - - -## SYNTAX - -``` -Add-SPScaleOutDatabase -DatabaseName <String> -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabaseFailoverServer <String>] [-DatabaseServer <String>] [-WhatIf] [-DeferUpgradeActions] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-SPScaleOutDatabase cmdlet to add an existing scale-out database to the specified service application by using the ServiceApplication parameter or creates a new scale-out database and adds it to the specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE------------ -``` -C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" - -C:\PS>Add-SPScaleOutDatabase -ServiceApplication $serviceApplication -``` - -This example adds a new or existing scale out database into a specific service application. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database to add to the specified service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the service application of the scale-out databases. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the owner's credentials of the scale-out database to be added to the service application. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer -The name of the failover server for the scale-out database to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -The name of the server hosting the scale-out database to be added. -If a value is not provided, the default database server will be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -{{Fill DeferUpgradeActions Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPScaleOutDatabase](Get-SPScaleOutDatabase.md) - -[Remove-SPScaleOutDatabase](Remove-SPScaleOutDatabase.md) - -[Split-SPScaleOutDatabase](Split-SPScaleOutDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSecureStoreSystemAccount.md deleted file mode 100644 index 5edb4ae70a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSecureStoreSystemAccount.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPSecureStoreSystemAccount -schema: 2.0.0 ---- - -# Add-SPSecureStoreSystemAccount - -## SYNOPSIS -Adds an account to a designated list. - -## SYNTAX - -``` -Add-SPSecureStoreSystemAccount [-AccountName] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Add-SPSecureStoreSystemAccount cmdlet to add a user to a list that of accounts which will be considered a system account. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE---------- -``` -C:\PS>Add-SPSecureStoreSystemAccount -AccountName contoso\jdoe -``` - -This example adds the account name jdoe. - -## PARAMETERS - -### -AccountName -Specifies the account name to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPSecureStoreSystemAccount](Get-SPSecureStoreSystemAccount.md) - -[Remove-SPSecureStoreSystemAccount](Remove-SPSecureStoreSystemAccount.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPServerScaleOutDatabase.md deleted file mode 100644 index 9896065b4a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPServerScaleOutDatabase.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPServerScaleOutDatabase -schema: 2.0.0 ---- - -# Add-SPServerScaleOutDatabase - -## SYNOPSIS - -Adds an existing scale-out content database to the specified service application. - - -## SYNTAX - -``` -Add-SPServerScaleOutDatabase -DatabaseName <String> -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabaseFailoverServer <String>] [-DatabaseServer <String>] [-WhatIf] [-DeferUpgradeActions] - [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Add-SPServerScaleOutDatabase cmdlet to add an existing scale-out database to the specified service application by using the ServiceApplication parameter or creates a new scale-out database and adds it to the specified service application. - -## EXAMPLES - -### -------------EXAMPLE------------ -``` -PS C:\>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" -PS C:\>Add-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -``` - -This example adds a new or existing scale out database into a specific service application. - - -## PARAMETERS - -### -DatabaseName - -Specifies the name of the database to add to the specified service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication - -Specifies the service application of the scale-out databases. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials - -Specifies the owner's credentials of the scale-out database to be added to the service application. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer - -The name of the failover server for the scale-out database to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer - -The name of the server hosting the scale-out database to be added. -If a value is not provided, the default database server will be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies whether upgrade actions are deferred duringi an Upgrade process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPServerScaleOutDatabase](Get-SPServerScaleOutDatabase.md) - -[Remove-SPServerScaleOutDatabase](Remove-SPServerScaleOutDatabase.md) - -[Split-SPServerScaleOutDatabase](Split-SPServerScaleOutDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPServiceApplicationProxyGroupMember.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPServiceApplicationProxyGroupMember.md deleted file mode 100644 index ff22a39959..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPServiceApplicationProxyGroupMember.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPServiceApplicationProxyGroupMember -schema: 2.0.0 ---- - -# Add-SPServiceApplicationProxyGroupMember - -## SYNOPSIS - -Adds a member to the service application proxy group. - - - -## SYNTAX - -``` -Add-SPServiceApplicationProxyGroupMember [-Identity] <SPServiceApplicationProxyGroupPipeBind> - [-Member] <SPServiceApplicationProxyPipeBind[]> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPServiceApplicationProxyGroupMember cmdlet adds a member to the service application proxy group. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -match 'User Profile Service Application Proxy'} -PS C:\>Add-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member $proxy -``` - -This example adds a select service application proxy to the service application proxy group named RemoteProxyGroup. - -The service application proxy group GUID is unique to every farm. -You can run Get-SPServiceApplicationProxyGroup | Select Name,Id to see the GUID of the serviceapplication proxy groups. -Use this result for any other SPServiceApplicationProxyGroup cmdlets. - -## PARAMETERS - -### -Identity -Specifies the service application proxy group to which to add the member. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Member -Specifies an array of members to add to the service application proxy group. - -```yaml -Type: SPServiceApplicationProxyPipeBind[] -Parameter Sets: (All) -Aliases: Proxy -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPShellAdmin.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPShellAdmin.md deleted file mode 100644 index 7af0af31cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPShellAdmin.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPShellAdmin -schema: 2.0.0 ---- - -# Add-SPShellAdmin - -## SYNOPSIS - -Adds a user to the SharePoint_Shell_Access role for the specified database. - - - -## SYNTAX - -``` -Add-SPShellAdmin [-UserName] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-database <SPDatabasePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -When you run this cmdlet to add a user to the SharePoint_Shell_Access role, you must have membership in the securityadmin fixed server role on the SQL Server instance, membership in the db_owner fixed database role on all affected databases, and local administrative permission on the local computer. - -This cmdlet is intended only to be used with a database that uses Windows authentication. -There is no need to use this cmdlet for databases that use SQL authentication; in fact, doing so may result in an error message. - -Use the Add-SPShellAdmin cmdlet to add a user to the SharePoint_Shell_Access role as follows: - ---If you specify only the user, the user is added to the role for the farm configuration database. - ---If you use the database parameter, the user is added to the role on the farm configuration database, the Central Administration content database, and the specified database. Using the database parameter is the preferred method because most of the administrative operations require access to the Central Administration content database. - -The user is added to the WSS_Admin_WPG group on all Web servers when the user is added to the SharePoint_Shell_Access role. -If the target database does not have a SharePoint_Shell_Access role, the role is automatically created. - -In order to use Windows PowerShell for SharePoint Products, a user must be a member of the SharePoint_Shell_Access role on the configuration database and a member of the WSS_ADMIN_WPG local group on the computer where SharePoint Products is installed. - -However, the result of running this cmdlet is that the user specified with the UserName parameter will have the **SPDataAccess** role, if it exists, or db_owner role, if the SPDataAccess role does not exist, on the affected databases as described above. Therefore, you should carefully plan which users are given this access. - -Therefore, you should carefully plan which users are given this access. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### -------------------EXAMPLE 1------------------------- -``` -PS C:\>Add-SPShellAdmin -UserName CONTOSO\User1 -``` - -This example adds a new user named User1 to the SharePoint_Shell_Access role in the farm configuration database only, and also ensures the user is added to the WSS_Admin_WPG local group on each server in the farm. - -### -------------------EXAMPLE 2------------------------- -``` -PS C:\>Add-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6 -``` - -This example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified content database and the configuration database by passing a database GUID to the cmdlet. - -### -------------------EXAMPLE 3------------------------- -``` -PS C:\>Get-SPDatabase | Where-Object {$_.WebApplication -like "SPAdministrationWebApplication"} | Add-SPShellAdmin CONTOSO\User1 -``` - -This example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified Central Administration content database and the configuration database. - -### -------------------EXAMPLE 4------------------------- -``` -PS C:\>Get-SPDatabase | ?{$_.Name -eq "WSS_Content"} | Add-SPShellAdmin -Username CONTOSO\User1 -``` - -This example adds a new user named User1 to the SharePoint_Shell_Access role of both the specified content database and the configuration database by passing the name of the database to the cmdlet. - -## PARAMETERS - -### -UserName -Specifies the name of the user to add to the SharePoint_Shell_Access role in the target database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -database -Specifies the GUID of the database or the Database object that includes the SharePoint_Shell_Access role to which you want to add the user. -If the database parameter is not specified, the configuration database is used. -The farm configuration database is always included, even if you specify another database. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSiteSubscriptionFeaturePackMember.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSiteSubscriptionFeaturePackMember.md deleted file mode 100644 index 6f9dad039e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSiteSubscriptionFeaturePackMember.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPSiteSubscriptionFeaturePackMember -schema: 2.0.0 ---- - -# Add-SPSiteSubscriptionFeaturePackMember - -## SYNOPSIS - -Adds a feature to a SharePoint Feature set. - - - -## SYNTAX - -``` -Add-SPSiteSubscriptionFeaturePackMember [-Identity] <SPSiteSubscriptionFeaturePackPipeBind> - -FeatureDefinition <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPSiteSubscriptionFeaturePackMember cmdlet adds features to the provided SharePoint Feature set. -Feature sets are an Allow List of SharePoint Features that can be associated with any site subscription. -If a Feature set is assigned to a site subscription, only the SPFeatures object in that Feature set are available for use on the site collections and Web sites that are members of the site subscription. -Feature sets contain a list of the GUIDs of each Feature that are on the Allow List for associated site subscriptions. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE---------------- -``` -PS C:\>$fp = New-SPSiteSubscriptionFeaturePack -PS C:\>Get-SPFeature -limit all | Where{ $_.Scope -eq "WEB" } | Add-SPSiteSubscriptionFeaturePackMember -id $fp -PS C:\>$fp = Get-SPSiteSubscriptionFeaturePack $fp -``` - -This example creates a Feature set and adds all Web site scoped Features to the set. - -The Feature set is refreshed in the last line so that the local object has the correct values. - -## PARAMETERS - -### -Identity -Specifies the Feature set object or GUID to which the given SharePoint Feature is added. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a Feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. - -```yaml -Type: SPSiteSubscriptionFeaturePackPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FeatureDefinition -Specifies the Feature definition, name, or GUID to add to the Feature set. - -```yaml -Type: SPFeatureDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSiteSubscriptionProfileConfig.md deleted file mode 100644 index e455a95d91..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSiteSubscriptionProfileConfig.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPSiteSubscriptionProfileConfig -schema: 2.0.0 ---- - -# Add-SPSiteSubscriptionProfileConfig - -## SYNOPSIS -Adds a new site subscription to a User Profile Service application. - -## SYNTAX - -### Default -``` -Add-SPSiteSubscriptionProfileConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-MySiteHostLocation <SPSitePipeBind>] -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SynchronizationOU <String>] [-WhatIf] - [<CommonParameters>] -``` - -### MySiteSettings -``` -Add-SPSiteSubscriptionProfileConfig [-Identity] <SPSiteSubscriptionPipeBind> - -MySiteHostLocation <SPSitePipeBind> -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MySiteManagedPath <SPPrefixPipeBind>] - [-SiteNamingConflictResolution <String>] [-SynchronizationOU <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Add-SPSiteSubscriptionProfileConfig cmdlet adds a new site subscription to a User Profile Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE------------------ -``` -PS C:\>$sub = Get-SPSiteSubscription http://contoso/my -PS C:\>$proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Add-SPSiteSubscriptionProfileConfig -Identity $sub -ProfileServiceApplicationProxy $proxy -MySiteHostLocation http://contoso/my -PS C:\>$sub = New-SPSiteSubscription -``` - -This example creates a new User Profile Service application tenant. - -## PARAMETERS - -### -Identity -Specifies the proxy of the User Profile Service application to add the site subscription to. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MySiteHostLocation -Specifies the site collection where the My Site host for the site subscription is provisioned. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the identifier for the User Profile Service Application proxy where the tenant is to be created. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MySiteManagedPath -Specifies the managed path where personal sites will be created. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteNamingConflictResolution -Specifies the format to use to name personal sites. - -Use one of the following integer values: - -1 Personal site collections are to be named based on user names without any conflict resolution. -For example, http://portal_site/location/username/ - -2 Personal site collections are to be based on user names with conflict resolution by using domain names. -For example, .../username/ or .../domain_username/ - -3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. -For example, http://portal_site/location/domain_username/ - -The default value is 1 (do not resolve conflicts). - -```yaml -Type: String -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SynchronizationOU -Specifies the organizational unit serving the site subscription. - -The type must be a valid name of an organizational unit; for example, OrgUnit1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSolution.md deleted file mode 100644 index 6e58459015..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPSolution.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPSolution -schema: 2.0.0 ---- - -# Add-SPSolution - -## SYNOPSIS - -Uploads a SharePoint solution package to the farm. - -## SYNTAX - -``` -Add-SPSolution [-LiteralPath] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Language <UInt32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPSolution cmdlet adds a SharePoint solution package to the farm. -This cmdlet does not deploy the uploaded SharePoint solution. -Use the Install-SPSolution cmdlet to deploy the SharePoint solution in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Add-SPSolution -LiteralPath c:\contoso_solution.wsp -``` - -This example adds the SharePoint solution in the file contoso_solution.wsp to the farm. - -## PARAMETERS - -### -LiteralPath -Specifies the path to the solution package. - -The type must be a valid path in either of the following forms: - -- C:\folder_name -- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Specifies the language pack to install with the solution package. - -The type must be a valid language identifier; for example, 1033. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPThrottlingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPThrottlingRule.md deleted file mode 100644 index 734ea08395..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPThrottlingRule.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPThrottlingRule -schema: 2.0.0 ---- - -# Add-SPThrottlingRule - -## SYNOPSIS - -Adds a new throttling rule. - - - -## SYNTAX - -``` -Add-SPThrottlingRule [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> [-Name] <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] - [-Expiration <DateTime>] [-Threshold <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPThrottlingRule cmdlet adds a new throttling rule for the farm by using the Name and RequestManagementSettings parameters. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE--------- -``` -PS C:\>$web=Get-SPWebApplication -Identity <URL of web application> -PS C:\>$rm=Get-SPRequestManagementSettings -Identity $web -PS C:\>$c=New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false -PS C:\>Add-SPThrottlingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -Threshold 4 -``` - -This example adds a throttling rule for a specified identity by using the $rm and $c variables. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to add. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the throttling rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Criteria -Specifies the criteria for the rule to match. - -```yaml -Type: SPRequestManagementRuleCriteriaPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expiration -Specifies the expiration date and time of the rule. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -Specifies a value between 0 and 10 which defines the maximum threshold for throttling. -The Request Manager will remove routing targets if their Health-Score becomes greater than this value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPThrottlingRule](Get-SPThrottlingRule.md) - -[Remove-SPThrottlingRule](Remove-SPThrottlingRule.md) - -[Set-SPThrottlingRule](Set-SPThrottlingRule.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPUserLicenseMapping.md deleted file mode 100644 index c4e33cae9b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPUserLicenseMapping.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPUserLicenseMapping -schema: 2.0.0 ---- - -# Add-SPUserLicenseMapping - -## SYNOPSIS - -Maps a security group, forms-based role, or claim to a SharePoint user license. - - - -## SYNTAX - -``` -Add-SPUserLicenseMapping - -Mapping <System.Collections.Generic.List`1[Microsoft.SharePoint.PowerShell.SPUserLicenseMapping]> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Add-SPUserLicenseMapping cmdlet maps a claim, Active Directory Domain Services (AD DS) security group, or forms-based role to a SharePoint user license for a farm or web application. -To specify a mapping to a specific web application, use the WebApplication parameter. -If you do not specify parameters, mapping applies to the entire SharePoint farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1------------------- -``` -PS C:\>$a = New-SPUserLicenseMapping -SecurityGroup yoursecuritygroup -License Enterprise -PS C:\>Add-SPUserLicenseMapping -Mapping $a -``` - -This example adds user mappings for the entire farm. - -## PARAMETERS - -### -Mapping -```yaml -Type: List<Microsoft.SharePoint.PowerShell.SPUserLicenseMapping> -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-SPUserLicensing](Disable-SPUserLicensing.md) - -[Enable-SPUserLicensing](Enable-SPUserLicensing.md) - -[Get-SPUserLicenseMapping](Get-SPUserLicenseMapping.md) - -[Remove-SPUserLicenseMapping](Remove-SPUserLicenseMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPUserSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Add-SPUserSolution.md deleted file mode 100644 index dd74d42efb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Add-SPUserSolution.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Add-SPUserSolution -schema: 2.0.0 ---- - -# Add-SPUserSolution - -## SYNOPSIS - -Uploads a new sandboxed solution to the solution gallery. - - - -## SYNTAX - -``` -Add-SPUserSolution [-LiteralPath] <String> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-SPUserSolution cmdlet uploads a new sandboxed solution package to the solution gallery. -This cmdlet does not activate the uploaded sandboxed solution; to activate the solution in the site collection, use the Install-SPUserSolution cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE--------------------- -``` -PS C:\>Add-SPUserSolution -LiteralPath c:\contoso_solution.wsp -Site http://sitename -``` - -This example adds the sandboxed solution c:\contoso_solution.wsp to the site http://sitename. - -## PARAMETERS - -### -LiteralPath -Specifies the path to the sandboxed solution package. - -The type must be a valid path in either of the following forms: - -- C:\folder_name -- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection where the sandboxed solution is to be added. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSiteobject. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPConfigurationDatabase.md deleted file mode 100644 index 5c7edefd79..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPConfigurationDatabase.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Backup-SPConfigurationDatabase -schema: 2.0.0 ---- - -# Backup-SPConfigurationDatabase - -## SYNOPSIS - -Performs a farm-level configuration-only backup. - - - -## SYNTAX - -### DefaultSet -``` -Backup-SPConfigurationDatabase -Directory <String> [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] [-Item <String>] - [<CommonParameters>] -``` - -### ShowTree -``` -Backup-SPConfigurationDatabase [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] [-Item <String>] - [-ShowTree] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Backup-SPConfigurationDatabase cmdlet performs a configuration-only backup of the current farm or a configuration-only backup of a separate configuration database which is not attached to the current farm. -If you wish to perform a configuration-only backup of the current farm, there is no need to specify the DatabaseServer and DatabaseName parameters. -However, using the Backup-SPFarm cmdlet with the ConfigurationOnly parameter is recommended for such a scenario. - -An example of a configuration backup is an administrator creates a farm configuration template which then can be applied to other SharePoint farms by performing a restore using the Restore-SPFarm cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831. - -## EXAMPLES - -### -------------------EXAMPLE 1-------------------- -``` -PS C:\>Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -ShowTree -``` - -This example displays components that are available for inclusion in a configuration-only backup. - -### -------------------EXAMPLE 2-------------------- -``` -PS C:\>Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -Verbose -``` - -This example performs a configuration-only backup with verbose output. - -## PARAMETERS - -### -Directory -Specifies the path where SharePoint Products stores the backup package it generates. -If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. -This includes a basic installation. -However, if SQL Server and SharePoint Products are installed on multiple computers or if you have multiple servers running SharePoint Products, you must use Universal Naming Convention (UNC) share paths so that the SQL Server database and search components are written to the same location; for example, \\\\computer_name\volume\Backup). - -Multiple backup packages can be stored in the same location. -This is the same path that you pass to the Directory parameter of the Restore-SPFarm cmdlet. - -The type must be either of the valid paths: - -- C:\folder_name -- \\\\server_name\folder_name - -The spbr* folders are automatically created. - -```yaml -Type: String -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the ID and password that corresponds to the administrator user name for the SQL Server database. - -This parameter should only be specified if SQL authentication is used to connect to the database. -If Windows authentication is used to connect to the database, then this parameter should not be specified. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the configuration database name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the SQL database server that contains the configuration database. -The default value is the local computer name. - -The type must be a valid database server; for example, DS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Indicates the part of the farm to back up. -You may use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. -If multiple items match the name, the full path must be provided. -Surround the item or path in quotation marks if it contains a space. - -If the Item parameter is not specified, the entire farm configuration is backed up. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowTree -Displays which objects in the farm will be backed up based on the other parameters passed to the backup cmdlet, namely the Item parameter. -Items that will be excluded from the backup based on the other parameters passed to the Backup-SPConfigurationDatabase cmdlet will be preceded with an asterisk character (*). -Items that cannot be backed up will be enclosed in square brackets (\[ \]). -A backup will not be performed if the ShowTree parameter is present. - -```yaml -Type: SwitchParameter -Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPEnterpriseSearchServiceApplicationIndex.md b/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPEnterpriseSearchServiceApplicationIndex.md deleted file mode 100644 index bc470fc99c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPEnterpriseSearchServiceApplicationIndex.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Backup-SPEnterpriseSearchServiceApplicationIndex -schema: 2.0.0 ---- - -# Backup-SPEnterpriseSearchServiceApplicationIndex - -## SYNOPSIS -Takes a backup of the search index to a specified backup location. - -## SYNTAX - -### RunBackup -``` -Backup-SPEnterpriseSearchServiceApplicationIndex [-Phase] <Int32> - [-SearchApplication] <SearchServiceApplication> [-BackupFolder] <String> [-BackupHandleFile] <String> - [[-Retries] <Int32>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [-PeerToPeer] - [-SpecifiedBackupHandle <String>] [<CommonParameters>] -``` - -### AbortBackup -``` -Backup-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] <SearchServiceApplication> - [-BackupHandleFile] <String> [[-Retries] <Int32>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [-Abort] [-PeerToPeer] [-SpecifiedBackupHandle <String>] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet will take a backup of the search index to a specified backup location. -The cmdlet has to be run in two phases. -Phase one will take a backup of what is present in the index at the time that the backup cmdlet is run. -Phase two will take a differential backup of what was added to the index after you started the first phase index backup. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Backup-SPEnterpriseSearchServiceApplicationIndex -Phase 1 -SearchApplication $ssa -BackupFolder "\\backuphost\backupfolder" -BackupHandleFile "\\backuphost\backupfolder\backuphandle.txt" -Retries 3 -``` - -This example starts a Phase 1 backup of the search index for the default search application, and stores the backup at the location \\\\backuphost\backupfolder. -The cmdlet stores a handle file backuphandle.txt that is used by the second phase cmdlet. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Backup-SPEnterpriseSearchServiceApplicationIndex -Phase 1 $ssa -BackupFolder "\\backuphost\backupfolder" -BackupHandleFile "\\backuphost\backupfolder\backuphandle.txt" -Retries 3 -``` - -This example checks the backup status and progress by re-running the cmdlet for Phase 1. - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Backup-SPEnterpriseSearchServiceApplicationIndex -Phase 2 -SearchApplication $ssa -BackupFolder "\\backuphost\backupfolder" -BackupHandleFile "\\backuphost\backupfolder\backuphandle.txt" -Retries 3 -``` - -This example starts the Phase 2 of the search index backup by using the same backup location and backup handle file as used for Phase 1. -The Search Service Application must be paused before the second phase can be started. - -## PARAMETERS - -### -Phase -Specifies the phase of the backup job. - -```yaml -Type: Int32 -Parameter Sets: RunBackup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Name of the search service application to be backed up - -```yaml -Type: SearchServiceApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackupFolder -Full UNC path of the backup files should be written. - -```yaml -Type: String -Parameter Sets: RunBackup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupHandleFile -Specifies a file handle for an ongoing backup job. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Retries -Number of times to retry if temporary failure occurs. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Abort -{{Fill Abort Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: AbortBackup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerToPeer -{{Fill PeerToPeer Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpecifiedBackupHandle -{{Fill SpecifiedBackupHandle Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPFarm.md b/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPFarm.md deleted file mode 100644 index ddc558091d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPFarm.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Backup-SPFarm -schema: 2.0.0 ---- - -# Backup-SPFarm - -## SYNOPSIS - -Creates a backup of an individual database, Web application, or the entire farm. - - - -## SYNTAX - -### DefaultSet -``` -Backup-SPFarm -BackupMethod <String> -Directory <String> [-AssignmentCollection <SPAssignmentCollection>] - [-BackupThreads <Int32>] [-ConfigurationOnly] [-Force] [-Item <String>] [-Percentage <Int32>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ShowTree -``` -Backup-SPFarm [-ShowTree] [-AssignmentCollection <SPAssignmentCollection>] [-ConfigurationOnly] - [-Item <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Backup-SPFarm cmdlet creates a backup for the entire farm or individual components within the farm. -It can also be used to back up just the configuration settings of a farm to be used as a farm template for other SharePoint farms. -If you want to back up a single site collection, use the Backup-SPSite cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Backup-SPFarm -Directory \\file_server\share\Backup -BackupMethod full -ConfigurationOnly -``` - -This example backs up the configuration settings of the farm to the \\\\file_server\share\Backup directory. - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Backup-SPFarm -ShowTree -Item "Microsoft SharePoint Foundation Web Application" -Verbose -``` - -This example shows which components of the farm would be backed up under the "Microsoft SharePoint Foundation Web Application" node, but do not actually back them up. - -### --------------------EXAMPLE 3--------------------- -``` -PS C:\>Backup-SPFarm -Directory C:\Backup -BackupMethod full -BackupThreads 10 -Force -``` - -This example performs a backup of a farm using 10 threads and forces the backup to be saved to the C:\Backup directory even though SharePoint estimates that it does not have sufficient space available. - -## PARAMETERS - -### -BackupMethod -Specifies the type of backup file to be created. - -If a backup is performed with the -ShowTree parameter, then the BackupMethod parameter is not used. - -A full backup is a backup of all the selected data. -A differential backup is a backup of all the selected data that has changed since the last full backup. -If an item does not support differential backup, then a full backup is performed for that item instead. - -The type must be either of the following: - -- Full -- Differential - -```yaml -Type: String -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies the path where SharePoint Products stores the backup package it generates. -If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. -This includes a basic installation. -However, if SQL Server and SharePoint Products are installed on multiple computers or if you have multiple servers running SharePoint Products, you must use Universal Naming Convention (UNC) share paths so that the SQL Server database and search components are written to the same location; for example, \\\\computer_name\volume\Backup). - -Multiple backup packages can be stored in the same location. -This is the same path that you pass to the Directory parameter of the Restore-SPFarm cmdlet. - -The type must be either of the valid paths: - -- C:\folder_name -- \\\\server_name\folder_name - -The spbr* folders are automatically created. - -```yaml -Type: String -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowTree -Displays which objects in the farm will be backed up based on the other parameters passed to the Backup-SPFarm cmdelt, namely the Item parameter. -Items that will be excluded from the backup based on the other parameters passed to the Backup-SPFarm cmdlet will be preceded with an asterisk character (*). -Items that cannot be backed up will be enclosed in square brackets (\[ \]). -A backup will not be performed if the ShowTree parameter is present. - -```yaml -Type: SwitchParameter -Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackupThreads -Specifies the number of threads to be used during the backup. -The fewer the threads, the easier the backup log file is to read and understand. -The more the threads, the more components that can be backed up in parallet, potentially resulting in a faster backup operation. -The minimum value is 1 and the maximum value is 10. - -The default value is 3. - -If a backup is performed with the -ShowTree parameter, then the BackupMethod parameter is not used. - -```yaml -Type: Int32 -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationOnly -If set, the backup will contain configuration settings only (no data) for each of the objects to be backed up. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies to proceed with a backup operation even if the estimation is that the backup directory does not have sufficient space to hold the entire backup. - -If a backup is performed with the ShowTree parameter, then the Force parameter is not used. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Indicates the part of the farm to back up. -You might use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. -If multiple items are included in the same match, the full path must be provided. -By default, the top node is selected. -Surround the item or path in quotation marks if it contains a space. -If this parameter is not specified, the entire farm is backed up. - -The type must be a valid item; for example, Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Percentage -Requests progress updates about the backup operation to be displayed in increments of that percentage; for example, a value of 5 displays backup progress updates at every 5 percent completed, and a value of 10 displays backup progress updates at every 10 percent completed. -To have progress outputs displayed, you must specify the Verbose parameter. - -This percentage is not precise and the actual progress updates might be lower or higher than requested. -Progress updates are always recorded in the backup log file. - -The percentage value is not prcesie and the actual progress updates might be lower or higher than requested. - -The default value is 5. -For a very large database, 1 is the recommended value. - -Valid values are an integer value between 1 and 100. - -```yaml -Type: Int32 -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPSite.md deleted file mode 100644 index 33ebb77edf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Backup-SPSite.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Backup-SPSite -schema: 2.0.0 ---- - -# Backup-SPSite - -## SYNOPSIS - -Performs a backup of a site collection. - - - -## SYNTAX - -``` -Backup-SPSite [-Identity] <SPSitePipeBind> -Path <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-NoSiteLock] [-UseSqlSnapshot] [-WhatIf] [-UseABSDocStreamInfo] [<CommonParameters>] -``` - -## DESCRIPTION -The Backup-SPSite cmdlet performs a backup of the site collection when the Identity parameter is used. - -By default, the site collection will be set to read-only for the duration of the backup to reduce the potential for user activity during the backup operation to corrupt the backup. -If you have SQL Server Enterprise Edition, we recommend that UseSqlSnapshot parameter be used because this ensures a valid backup while it allows users to continue reading and writing to the site collection during the backup. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE 1-------------------- -``` -PS C:\>Backup-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -``` - -This example backs up a site collection at http://server_name/sites/site_name to the C:\Backup\site_name.bak file. - - -### -------------------EXAMPLE 2-------------------- -``` -PS C:\>Get-SPSiteAdministration http://server_name/sites/site_name | Backup-SPSite -Path C:\Backup\site_name.bak -``` - -This example backs up a site collection at http://server_name/sites/site_name to the C:\Backup\site_name.bak file. -Same result as Example 1, but a different way of performing the operation. - -### -------------------EXAMPLE 3-------------------- -``` -PS C:\>Backup-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -UseSqlSnapshot -``` - -This example backs up a site collection using database snapshots to ensure backup integrity. - -### -------------------EXAMPLE 4-------------------- -``` -PS C:\>Backup-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -NoSiteLock -``` - -This example backs up a site collection and prevents placing the site into a read only mode during the backup phase. Use the -NoSiteLock parameter when backing up a site in production where it is desirable to not place the site into a read only mode while the backup takes place. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site collection to be backed up. - -For example, a valid URL, such as http://server_name/sites/site_name or a GUID such as, "01234567-89ab-cdef-0123-456789abcdef" - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the backup file (that is, C:\Backup\site_name.bak. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specify to overwrite an existing backup file if it already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoSiteLock -Specifies the site collection to remain read and write during the backup. - -If the NoSiteLock parameter is not specified, then a site collection that has a site collection lock setting of "none" or "no additions" will be temporarily set to "read only" while the site collection backup is performed. -Once the backup has completed, the site collection lock will return to its original state. -The backup package will record the original site collection lock state so that it is restored to that state. - -If users are writing to the site collection while the site collection is being backed up, then the NoSiteLock parameter is not recommended for potential impact to backup integrity - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSqlSnapshot -Specifies a SQL Database Snapshot will be created when the backup begins, and all site collection data will be retrieved directly from the database snapshot. -This snapshot will be deleted automatically when the backup completes - -The UseSqlSnapshot parameter is recommended if the database server hosting your content database supports database snapshots such as SQL Server Enterprise Edition and SQL Server Developer Edition. -This is because it will ensure a valid backup while allowing users to continue reading and writing to the site collection during the backup. -It is not necessary to specify the NoSiteLock parameter when specifying the UseSqlSnapshot parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseABSDocStreamInfo -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-FASTSearchContentCollection.md deleted file mode 100644 index 7ffa08f6d7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-FASTSearchContentCollection.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Clear-FASTSearchContentCollection ---- - -# Clear-FASTSearchContentCollection - -## SYNOPSIS -Clears the content of a Microsoft FAST Search Server 2010 for SharePoint content collection. - -## SYNTAX - -``` -Clear-FASTSearchContentCollection [-Name] <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes from the index all items that are associated with the specified collection without removing the collection. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>Clear-FASTSearchContentCollection -Name newscollection -``` - -This example clears the content of the "newscollection" content collection. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>Clear-FASTSearchContentCollection -Name newscollection -Force -``` - -This example clears the content of the "newscollection" content collection. -The user does not have to confirm the operation. - -## PARAMETERS - -### -Name -The name of the content collection to clear. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. - -If Confirm is false (-Confirm:$false), you will not be prompted. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings so the user is not asked to confirm the operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchContentCollection](New-FASTSearchContentCollection.md) - -[Remove-FASTSearchContentCollection](Remove-FASTSearchContentCollection.md) - -[Get-FASTSearchContentCollection](Get-FASTSearchContentCollection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPAppDeniedEndpointList.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPAppDeniedEndpointList.md deleted file mode 100644 index 82f4f2df63..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPAppDeniedEndpointList.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPAppDeniedEndpointList -schema: 2.0.0 ---- - -# Clear-SPAppDeniedEndpointList - -## SYNOPSIS - -Applies to: - - - - -## SYNTAX - -``` -Clear-SPAppDeniedEndpointList [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Clear-SPAppDeniedEndpoint cmdlet to remove all app-denied endpoints in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------EXAMPLE--------- -``` -PS C:\>Clear-SPAppDeniedEndpoint -``` - -This example removes all app-denied endpoints from the farm. - - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPAppDeniedEndpointList](Get-SPAppDeniedEndpointList.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPBusinessDataCatalogEntityNotificationWeb.md deleted file mode 100644 index 51206a87e9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPBusinessDataCatalogEntityNotificationWeb.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPBusinessDataCatalogEntityNotificationWeb -schema: 2.0.0 ---- - -# Clear-SPBusinessDataCatalogEntityNotificationWeb - -## SYNOPSIS - -Clears the entity notification site. - - - -## SYNTAX - -``` -Clear-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Clear-SPBusinessDataCatalogEntityNotificationWeb cmdlet to clear the entity notification site for the given service context. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE----------- -``` -PS C:\>Clear-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext "http://contoso/" -``` - -This example clears the entity notification site for the service context corresponding to the site http://contoso. - -## PARAMETERS - -### -ServiceContext -Specifies the dervice context for which the entity notification web has to be cleared. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPBusinessDataCatalogEntityNotificationWeb](Get-SPBusinessDataCatalogEntityNotificationWeb.md) - -[Set-SPBusinessDataCatalogEntityNotificationWeb](Set-SPBusinessDataCatalogEntityNotificationWeb.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPContentDatabaseSyncData.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPContentDatabaseSyncData.md deleted file mode 100644 index aeff3d319f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPContentDatabaseSyncData.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2019 -title: Clear-SPContentDatabaseSyncData -schema: 2.0.0 ---- - -# Clear-SPContentDatabaseSyncData - -## SYNOPSIS -Clears synchronization information from the content databases that have not been synchronized since the mentioned number of days. - -## SYNTAX - -``` -Clear-SPContentDatabaseSyncData [-DaysSinceLastProfileSync] <Int32>] - [-AssignmentCollection <SPAssignmentCollection>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use the **Clear-SPContentDatabaseSyncData** to clear synchronization information from the content databases that has not been synchronized since the mentioned number of days, which can be passed as a parameter. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -PS C:\> Clear-SPContentDatabaseSyncData -DaysSinceLastProfileSync 12 -``` - -This example resets synchronization information from the content databases that have not been synchronized for more than or equal to 12 days, without prompting for user confirmation. - -## PARAMETERS - -### -DaysSinceLastProfileSync -Specifies the least number of days by which the databases are old. - -The default value of this parameter is 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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). - -## RELATED LINKS - - - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPDistributedCacheItem.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPDistributedCacheItem.md deleted file mode 100644 index ee7959028c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPDistributedCacheItem.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPDistributedCacheItem -schema: 2.0.0 ---- - -# Clear-SPDistributedCacheItem - -## SYNOPSIS - -Clears cached items from the distributed cache server. - - - -## SYNTAX - -``` -Clear-SPDistributedCacheItem [-ContainerType] <SPDistributedCacheContainerType> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Clear-SPDistributedCacheItems cmdlet to clear cached items from the distributed cache server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE------ -``` -PS C:\>Clear-SPDistributedCacheItem -ContainerType DistributedLogonTokenCache -``` - -This example removes all the cache items for distributed token cache. - -## PARAMETERS - -### -ContainerType - -Specifies the container type to clear. - -The valid values for SharePoint Server 2013 and SharePoint Server 2016 are the following: - -DistributedDefaultCache, DistributedAccessCache, DistributedActivityFeedCache, DistributedBouncerCache, DistributedLogonTokenCache, DistributedServerToAppServerAccessTokenCache, DistributedSearchCache, DistributedSecurityTrimmingCache, DistributedActivityFeedLMTCache, DistributedViewStateCache - -Additional valid values for SharePoint Server 2016 are the following: - -DistributedSharedWithUserCache, DistributedUnifiedGroupsCache, DistributedFileLockThrottlerCache, -DistributedResourceTallyCache, DistributedHealthScoreCache, DistributedClientSideAppUpdateTimeCache - - -```yaml -Type: SPDistributedCacheContainerType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPLogLevel.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPLogLevel.md deleted file mode 100644 index f66ba83b8a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPLogLevel.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPLogLevel -schema: 2.0.0 ---- - -# Clear-SPLogLevel - -## SYNOPSIS - -Resets the Windows event logging and trace logging to their default values. - - - -## SYNTAX - -``` -Clear-SPLogLevel [-AssignmentCollection <SPAssignmentCollection>] [-Identity <String[]>] - [-InputObject <PSObject>] [<CommonParameters>] -``` - -## DESCRIPTION -The Clear-SPLogLevel cmdlet resets the Windows event logging and trace logging levels for the specified categories to the default values. -If the Identity parameter is not provided, all categories are affected. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Clear-SPLogLevel -Identity Cat1 -``` - -This example resets the log levels for a single category. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>"Cat1", "Cat2", "Cat3" | Clear-SPLogLevel -``` - -This example resets the log levels for multiple categories. - -### --------------EXAMPLE 3----------------- -``` -PS C:\>Get-SPLogLevel | Clear-SPLogLevel -``` - -This example resets the log levels for all categories. - -### --------------EXAMPLE 4----------------- -``` -PS C:\>Clear-SPLogLevel -Identity "SharePoint Server:Database" -``` - -This example resets the log level for the specific category in the SharePoint Server area only. This is useful when more than one area uses the same named category. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". -If the Identity parameter is not specified, the event throttling setting is applied to all categories in the farm. - -Providing an invalid category is a non-terminating error and will be ignored. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the result of the InputObject parameter to be piped. -The value can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. -The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, modify their values, and then pipe the results to the Set-SPLogLevel cmdlet. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPMetadataWebServicePartitionData.md deleted file mode 100644 index 2089284f20..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPMetadataWebServicePartitionData.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPMetadataWebServicePartitionData -schema: 2.0.0 ---- - -# Clear-SPMetadataWebServicePartitionData - -## SYNOPSIS -Removes all data for a site subscription on a metadata Web service application. - -## SYNTAX - -### Default -``` -Clear-SPMetadataWebServicePartitionData [-Identity] <SPSiteSubscriptionPipeBind> - [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-FromContentDatabase <SPContentDatabasePipeBind>] [-FromServiceDatabase] [<CommonParameters>] -``` - -### ServiceContext -``` -Clear-SPMetadataWebServicePartitionData [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] -ServiceContext <SPServiceContextPipeBind> - [-FromContentDatabase <SPContentDatabasePipeBind>] [-FromServiceDatabase] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Clear-SPMetadataWebServicePartitionData cmdlet to clear all data for a site subscription on a metadata Web service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE--------------- -``` -PS C:\>Clear-SPMetadataWebServicePartitionData -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -``` - -This example removes data for a site subscription on a Metadata Service application. - -## PARAMETERS - -### -Identity -Specifies the site subscription configuration to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceProxy -Specifies the service proxy for the service application that contains the site subscription. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -{{Fill ServiceContext Description}} - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FromContentDatabase -{{Fill FromContentDatabase Description}} - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromServiceDatabase -{{Fill FromServiceDatabase Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPPerformancePointServiceApplicationTrustedLocation.md deleted file mode 100644 index 9ccc6f6f81..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPPerformancePointServiceApplicationTrustedLocation.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPPerformancePointServiceApplicationTrustedLocation -schema: 2.0.0 ---- - -# Clear-SPPerformancePointServiceApplicationTrustedLocation - -## SYNOPSIS -Clears all the trusted locations for a PerformancePoint Service application identity. - -## SYNTAX - -``` -Clear-SPPerformancePointServiceApplicationTrustedLocation - -ServiceApplication <SPPerformancePointMonitoringServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-TrustedLocationType <TrustedFileType>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Clear-SPPerformancePointServiceApplicationTrustedLocation cmdlet removes all the trusted locations for a PerformancePoint Service application. -Use the TrustedLocationType parameter to remove only the trusted locations for a trusted location type. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Clear-SPPerformancePointServiceApplicationTrustedLocation -ServiceApplication My_Service_Application -``` - -This example removes trusted locations from the Service application named, My_Service_Application. - -## PARAMETERS - -### -ServiceApplication -Specifies the PerformancePoint Service application that contains the trusted locations. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedLocationType -Specifies the type of trusted locations to clear. -If the TrustedLocationType parameter is not specified, this cmdlet clears all the trusted locations for the specified PerformancePoint Service application. - -The type must be one of the following: content, data source. - -```yaml -Type: TrustedFileType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseDeletedDataSubRange.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseDeletedDataSubRange.md deleted file mode 100644 index f4c27df2df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseDeletedDataSubRange.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPScaleOutDatabaseDeletedDataSubRange -schema: 2.0.0 ---- - -# Clear-SPScaleOutDatabaseDeletedDataSubRange - -## SYNOPSIS - -Clears all partitions inside the specified deleted subrange. - - - -## SYNTAX - -``` -Clear-SPScaleOutDatabaseDeletedDataSubRange -Database <SPDatabasePipeBind> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Clear-SPScaleOutDatabaseDeletedDataSubRange cmdlet to clear all partitions inside the specified deleted subrange that are contained within a specified scale-out database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE-------------- -``` -PS C:\>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication -PS C:\>$database = $databases[0] -PS C:\>$state = Get-SPScaleOutDatabaseDataState -Database $database -PS C:\>Set-SPScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubRangePoint $state.Range.RangeEnd -SubRangeMode Deleted -IsUpperSubRange $false -PS C:\>$state = Get-SPScaleOutDatabaseDataState -Database $database -PS C:\>Clear-SPScaleOutDatabaseDeletedDataSubRange -Database $database -Range $state.Range -IsUpperSubRange $false -``` - -This example creates a deleted subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. -The example then clears that subrange and all data in the partitions in the subrange. - -## PARAMETERS - -### -Database -Specifies the scale-out database to clear the deleted subrange from. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsUpperSubRange -Specifies whether the subrange with deleted mode is on the upper or lower side of the data range. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range -Specifies the expected data range of the scale-out database. - -```yaml -Type: SPScaleOutDataRange -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPScaleOutDatabaseDataSubRange](Set-SPScaleOutDatabaseDataSubRange.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseLog.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseLog.md deleted file mode 100644 index cd5601b4d5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseLog.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPScaleOutDatabaseLog -schema: 2.0.0 ---- - -# Clear-SPScaleOutDatabaseLog - -## SYNOPSIS - -Clears all scale-out logs. - -## SYNTAX - -``` -Clear-SPScaleOutDatabaseLog -Database <SPDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-LogEntryTimeout <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Clear-SPScaleOutDatabaseLog cmdlet clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE------- -``` -PS C:\>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication -PS C:\>$database = $databases[0] -PS C:\>Clear-SPScaleOutDatabaseLog -Database $database -LogEntryTimeout 30 -``` - -This example removes all scale-out log entries in the first scale-out database of the specified service application unless there is a scale-out log entry which is more recent than 30 minutes. - -## PARAMETERS - -### -Database -Specifies the scale-out database from which to clear the logs. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogEntryTimeout -Specifies the time-out value in minutes for the log entries. -If there is at least one log entry which is more recent than this value, no log entries will be deleted. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseTenantData.md deleted file mode 100644 index 4db2cd7d9d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPScaleOutDatabaseTenantData.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPScaleOutDatabaseTenantData -schema: 2.0.0 ---- - -# Clear-SPScaleOutDatabaseTenantData - -## SYNOPSIS - -Removes all data related to the specified site subscription. - - - -## SYNTAX - -``` -Clear-SPScaleOutDatabaseTenantData -ServiceApplication <SPServiceApplicationPipeBind> - -SiteSubscriptionId <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Clear-SPScaleOutDatabaseTenantData cmdlet removes all data related to the specified site subscription from the specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE--------- -``` -PS C:\>Clear-SPScaleOutDatabaseTenantData -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" -``` - -This example clears all data related to the site subscription with id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904 from the specified service application. - -## PARAMETERS - -### -ServiceApplication -Specifies the service application in which to clear data. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId -Specifies the site subscription id of the site subscription in which to clear data. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Export-SPScaleOutDatabaseTenantData](Export-SPScaleOutDatabaseTenantData.md) - -[Import-SPScaleOutDatabaseTenantData](Import-SPScaleOutDatabaseTenantData.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSecureStoreCredentialMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSecureStoreCredentialMapping.md deleted file mode 100644 index 6b0107f3ac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSecureStoreCredentialMapping.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPSecureStoreCredentialMapping -schema: 2.0.0 ---- - -# Clear-SPSecureStoreCredentialMapping - -## SYNOPSIS -Deletes a credential mapping from a Secure Store Service application. - -## SYNTAX - -### AllApplications -``` -Clear-SPSecureStoreCredentialMapping [-All] -Principal <SPClaim> -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### OneApplication -``` -Clear-SPSecureStoreCredentialMapping -Identity <SPSecureStoreApplication> -Principal <SPClaim> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Clear-SPSecureStoreCredentialMapping cmdlet deletes a credential mapping from a Secure Store application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" -PS C:\>$userClaim = New-SPClaimsPrincipal -Identity "CONTOSO\janedoe" -IdentityType WindowsSamAccountName -PS C:\>Clear-SPSecureStoreCredentialMapping -Identity $ssApp -Principal $userClaim -``` - -This example deletes the credential mapping from the target application ContosoTargetApplication for the user with alias johndoe and domain CONTOSO. - -## PARAMETERS - -### -All -Specifies that the principal is deleted from all Secure Store applications. - -```yaml -Type: SwitchParameter -Parameter Sets: AllApplications -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the Secure Store application (that contains the principal) from which to delete the credential mapping. - -```yaml -Type: SPSecureStoreApplication -Parameter Sets: OneApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Principal -Specifies the SPClaims object that contains the principal. - -```yaml -Type: SPClaim -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context for which the credential mapping will be deleted. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: AllApplications -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSecureStoreDefaultProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSecureStoreDefaultProvider.md deleted file mode 100644 index d3a9e4bb0d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSecureStoreDefaultProvider.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPSecureStoreDefaultProvider -schema: 2.0.0 ---- - -# Clear-SPSecureStoreDefaultProvider - -## SYNOPSIS -Clears the secure store provider. - -## SYNTAX - -``` -Clear-SPSecureStoreDefaultProvider [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Clear-SPSecureStoreDefaultProvider cmdlet clears the secure store provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Clear-SPSecureStoreDefaultProvider -``` - -This example clears the secure store provider. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md deleted file mode 100644 index 5da2c35fa6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPServerScaleOutDatabaseDeletedDataSubRange -schema: 2.0.0 ---- - -# Clear-SPServerScaleOutDatabaseDeletedDataSubRange - -## SYNOPSIS - -Clears all partitions inside the specified deleted subrange. - - -## SYNTAX - -``` -Clear-SPServerScaleOutDatabaseDeletedDataSubRange -Database <SPDatabasePipeBind> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Clear-SPServerScaleOutDatabaseDeletedDataSubRange cmdlet to clear all partitions inside the specified deleted subrange that are contained within a specified scale-out database. - - - -## EXAMPLES - -### --------------EXAMPLE-------------- -``` -PS C:\>$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -PS C:\>$database = $databases[0] -PS C:\>$state = Get-SPServerScaleOutDatabaseDataState -Database $database -PS C:\>Set-SPServerScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubRangePoint $state.Range.RangeEnd -SubRangeMode Deleted -IsUpperSubRange $false -PS C:\>$state = Get-SPServerScaleOutDatabaseDataState -Database $database -PS C:\>Clear-SPServerScaleOutDatabaseDeletedDataSubRange -Database $database -Range $state.Range -IsUpperSubRange $false -``` - -This example creates a deleted subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. -The example then clears that subrange and all data in the partitions in the subrange. - - -## PARAMETERS - -### -Database - -Specifies the scale-out database to clear the deleted subrange from. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsUpperSubRange - -Specifies whether the subrange with deleted mode is on the upper or lower side of the data range. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range - -Specifies the expected data range of the scale-out database. - -```yaml -Type: SPScaleOutDataRange -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-SPServerScaleOutDatabaseDataSubRange](Set-SPServerScaleOutDatabaseDataSubRange.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseLog.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseLog.md deleted file mode 100644 index a376248023..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseLog.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPServerScaleOutDatabaseLog -schema: 2.0.0 ---- - -# Clear-SPServerScaleOutDatabaseLog - -## SYNOPSIS - -Use the Clear-SPServerScaleOutDatabaseLog cmdlet clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value. - - -## SYNTAX - -``` -Clear-SPServerScaleOutDatabaseLog -Database <SPDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-LogEntryTimeout <Int32>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Clear-SPServerScaleOutDatabaseLog cmdlet clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value. - -## EXAMPLES - -### -----------EXAMPLE------- -``` -PS C:\>$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -PS C:\>$database = $databases[0] -PS C:\>Clear-SPServerScaleOutDatabaseLog -Database $database -LogEntryTimeout 30 -``` - -This example removes all scale-out log entries in the first scale-out database of the specified service application unless there is a scale-out log entry which is more recent than 30 minutes. - - -## PARAMETERS - -### -Database - -Specifies the scale-out database from which to clear the logs. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogEntryTimeout - -Specifies the time-out value in minutes for the log entries. -If there is at least one log entry which is more recent than this value, no log entries will be deleted. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseTenantData.md deleted file mode 100644 index a888429dc8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPServerScaleOutDatabaseTenantData.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPServerScaleOutDatabaseTenantData -schema: 2.0.0 ---- - -# Clear-SPServerScaleOutDatabaseTenantData - -## SYNOPSIS - -Removes all data related to the specified site subscription. - -## SYNTAX - -``` -Clear-SPServerScaleOutDatabaseTenantData -ServiceApplication <SPServiceApplicationPipeBind> - -SiteSubscriptionId <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Clear-SPServerScaleOutDatabaseTenantData cmdlet removes all data related to the specified site subscription from the specified service application. - - - - -## EXAMPLES - -### ------------EXAMPLE--------- -``` -PS C:\>Clear-SPServerScaleOutDatabaseTenantData -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" -``` - -This example clears all data related to the site subscription with id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904 from the specified service application. - -## PARAMETERS - -### -ServiceApplication - -Specifies the service application in which to clear data. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId - -Specifies the site subscription id of the site subscription in which to clear data. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Export-SPServerScaleOutDatabaseTenantData](Export-SPServerScaleOutDatabaseTenantData.md) - -[Import-SPServerScaleOutDatabaseTenantData](Import-SPServerScaleOutDatabaseTenantData.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md deleted file mode 100644 index c65b0ea021..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Clear-SPSiteSubscriptionBusinessDataCatalogConfig -schema: 2.0.0 ---- - -# Clear-SPSiteSubscriptionBusinessDataCatalogConfig - -## SYNOPSIS - -Deletes all data from the Business Data Connectivity Metadata Store for a specified partition. - - - -## SYNTAX - -``` -Clear-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Clear-SPSiteSubscriptionBusinessDataCatalogConfig cmdlet deletes all models and data from the Business Data Connectivity Metadata Store for a specified service partition. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Clear-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso -``` - -This example deletes all data from the Business Data Connectivity Metadata Store for the specified site. - -## PARAMETERS - -### -ServiceContext -Specifies the service context for which the Business Data Connectivity models are deleted. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Connect-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Connect-SPConfigurationDatabase.md deleted file mode 100644 index 69eed7ecc1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Connect-SPConfigurationDatabase.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Connect-SPConfigurationDatabase -schema: 2.0.0 ---- - -# Connect-SPConfigurationDatabase - -## SYNOPSIS - -Connects the local server computer to a farm. - - - -## SYNTAX - -``` -Connect-SPConfigurationDatabase [-DatabaseName] <String> [-SkipRegisterAsDistributedCacheHost] - [-Passphrase] <SecureString> -DatabaseServer <String> [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseCredentials <PSCredential>] [-DatabaseFailOverPartner <String>] [-LocalServerRole <SPServerRole>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Connect-SPConfigurationDatabase cmdlet connects the current server to the specified configuration database. - -Essentially, this cmdlet connects the server to the farm. -If the current computer cannot be connected to a farm, the following error message is displayed: - -"This machine is already connected to a SharePoint farm. -See: Dismount-SPConfigurationDatabase" - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Connect-SPConfigurationDatabase -DatabaseServer "ServerName\InstanceName" -DatabaseName "SharePointConfigurationDatabaseName" -Passphrase (ConvertTo-SecureString "MyP@ssw0rd" -AsPlainText -Force) -PS C:\>Start-Service SPTimerv4 -``` - -This example joins the local server computer to a farm that is configured to use the database SharePointConfigurationDatabase on an instance of SQL Server by using the name ServerName\InstanceName with the passphrase MyP@ssw0rd. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the configuration database to which to connect the server. - -The type must be a valid database name; for example, DB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the server on which to create the configuration database. -The default value is the local computer name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passphrase -Specifies the secure password phrase for connecting the current server to the configuration database. - -The type must be a valid secure string; for example, MyBDCApp1serverkey. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SkipRegisterAsDistributedCacheHost -By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default). - -Use this parameter to not register the server computer as a distributed cache host. -If you want to have a dedicated cache host, then use this parameter to make sure that caching service is not installed on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. -If this parameter is not specified, the current user is used. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseFailOverPartner -Specifies the Database Mirroring partner for a SQL Server instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalServerRole -Specifies the MinRole assigned to the local server. - -```yaml -Type: SPServerRole -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Convert-SPWebApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Convert-SPWebApplication.md deleted file mode 100644 index f0897b9cf8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Convert-SPWebApplication.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Convert-SPWebApplication -schema: 2.0.0 ---- - -# Convert-SPWebApplication - -## SYNOPSIS - -Converts the authentication mode of a web application. - - - -## SYNTAX - -``` -Convert-SPWebApplication -Identity <SPWebApplicationPipeBind> -From <String> -To <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Force] [-RetainPermissions] [-Database <SPContentDatabase>] - [-MapList <String>] [-SiteSubsriptionId <Guid>] [-SkipPolicies] [-SkipSites] - [-SourceSkipList <String>] [-TrustedProvider <SPTrustedIdentityTokenIssuerPipeBind>] - [-LoggingDirectory <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Convert-SPWebApplication cmdlet to convert the authentication mode of a Web application to Windows Claims authentication mode and migrate the user accounts in the content database to claims encoded values. - -When retaining permissions, users within Sites are only converted if the source account is enabled and queryable by SharePoint. For example, if the Active Directory account is deleted or disabled prior to a Classic Windows to Windows Claims conversion, the account in the database will not be updated to the Claims format. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE 1------- -``` -PS C:\>Convert-SPWebApplication -Identity "https://<webappurl>" -To Claims -RetainPermissions -``` - -This example converts a web application specified by the Identity parameter to use the claim authentication mode. - -### ------------EXAMPLE 2------- -``` -PS C:\>Convert-SPWebApplication -Identity "https://<webappurl>" -From Legacy -To Claims -RetainPermissions -``` - -This example converts a web application specified by the Identity parameter from Classic Windows authentication to Claims authentication mode while retaining permissions. The -From parameter is required after security update MS04-022 or the April 2014 Cumulative Update for SharePoint Server 2013 is applied. This is required for all versions of SharePoint Server 2016. - -## PARAMETERS - -### -Identity -Specifies the URL of the web application that you want to convert, for example: http://mysite/app1 - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -From -Specifies the authentication method to convert from. - -Valid values for this parameter are as follows. - -Legacy, Claims-Windows, Claims-Trusted-Default - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -To -Specifies the authentication method to convert to. - -Valid values for this parameter are as follows. - -Claims, Claims-Windows, Claims-Trusted-Default, Claims-SharePoint-Online - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Forces the conversion of the web application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainPermissions -Specifies the account under which the cmdlet is run and retains the permission in the web application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -Specifies the name of the content database to migrate. - -```yaml -Type: SPContentDatabase -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapList -Specifies a file containing as list of rows in the following format: user-key, migrated-user-name, migrated-user-key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubsriptionId -Specifies the GUID fo the Site Subscription. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPolicies -Specifies the SPWebApplication security policies will not be migrated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSites -Specifies the SPWebApplication's SPSites will not be migrated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSkipList -Specifies a file containing as list of rows in the following format: user-key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedProvider -When you migrate from a trusted login provider this is how you specify which trusted login provider. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoggingDirectory -Specifies a directory where verbose logs about the results of the migration will be written. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPAccessServicesDatabaseCredentials.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPAccessServicesDatabaseCredentials.md deleted file mode 100644 index 396a949036..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPAccessServicesDatabaseCredentials.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPAccessServicesDatabaseCredentials -schema: 2.0.0 ---- - -# Copy-SPAccessServicesDatabaseCredentials - -## SYNOPSIS -{{Fill in the Synopsis}} - -## SYNTAX - -``` -Copy-SPAccessServicesDatabaseCredentials [-AppUrl] <String> [-AssignmentCollection <SPAssignmentCollection>] - -ServerCredential <NetworkCredential> -ServiceContext <SPServiceContextPipeBind> -SourceServer <String> - -TargetServer <String> [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AppUrl -{{Fill AppUrl Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerCredential -{{Fill ServerCredential Description}} - -```yaml -Type: NetworkCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -{{Fill ServiceContext Description}} - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SourceServer -{{Fill SourceServer Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetServer -{{Fill TargetServer Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPActivitiesToWorkflowService.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPActivitiesToWorkflowService.md deleted file mode 100644 index 52f77c7fef..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPActivitiesToWorkflowService.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.SharePoint.WorkflowServices.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPActivitiesToWorkflowService -schema: 2.0.0 ---- - -# Copy-SPActivitiesToWorkflowService - -## SYNOPSIS -This cmdlet copies the Workflow Activities from SharePoint Server to the Workflow Manager farm. Activities are defined within Microsoft provided or custom coded assemblies. - - - -## SYNTAX - -``` -Copy-SPActivitiesToWorkflowService [-ActivityName <String>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Credential <ICredentials>] [-Force <Boolean>] [-WhatIf] [-WorkflowServiceAddress <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -Copies Workflow activites from SharePoint Server to Workflow Manager. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$credential = [System.Net.CredentialCache]::DefaultNetworkCredentials -PS C:\>$site = Get-SPSite <siteurl> -PS C:\>$proxy = Get-SPWorkflowServiceApplicationProxy -PS C:\>$svcAddress = $proxy.GetWorkflowServiceAddress($site) -PS C:\>Copy-SPActivitiesToWorkflowService -WorkflowServiceAddress $svcAddress -Credential $credential -Force $true -``` - - -Copies the Workflow activities from SharePoint to the Workflow Manager farm using the specified Site Collection URL as a reference. - - -## PARAMETERS - -### -ActivityName -Copies a specific ActivityName. If not specified, all Activities are copied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The credential used to connect to Workflow Manager. - -```yaml -Type: ICredentials -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces a specific Activity to be copied to Workflow Manager. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkflowServiceAddress -The Workflow Manager farm endpoint URL. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPBusinessDataCatalogAclToChildren.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPBusinessDataCatalogAclToChildren.md deleted file mode 100644 index 3ff6439642..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPBusinessDataCatalogAclToChildren.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPBusinessDataCatalogAclToChildren -schema: 2.0.0 ---- - -# Copy-SPBusinessDataCatalogAclToChildren - -## SYNOPSIS - -Copies a set of permissions of a Business Data Connectivity Metadata Store metadata object to its child objects. - - - -## SYNTAX - -``` -Copy-SPBusinessDataCatalogAclToChildren -MetadataObject <MetadataObject> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Copy-SPBusinessDataCatalogAclToChildren cmdlet copies a set of rights of a Business Data Connectivity metadata object to its child objects. - -Any principals and their rights will be lost from the child metadata objects. -Make sure that the parent metadata object has the final permissions you want, or make sure to append them to the child object again after you run this cmdlet. - -Running this cmdlet on a BdcObjectType BdcCatalog (Business Data Connectivity Metadata Store) will propagate to: - -- BDC Models -- External Systems -- External Content Types -- Methods -- Method Instances - -Running this cmdlet on a BdcObjectType Model (Business Data Connectivity Model) will propagate to: - -- Nothing; this type has no child metadata objects - -Running this cmdlet on a BdcObjectType LobSystem (External System) will propagate to: - -- External Content Types -- Methods -- Method Instances - -Running this cmdlet on a BdcObjectType Entity (External Content Type) will propagate to: - -- Methods -- Method Instances - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ExternalSystem = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext http://contoso -Name "ContosoDatabase" -``` - -This example looks at the principals (users) and their corresponding rights given for the External System metadata object, and overwrites the permissions of its child metadata objects with these same principals and rights. - -Any principals and their rights will be lost from the child metadata objects. -Make sure that the parent metadata object has the final permissions you want, or make sure to append them to the child object again after you run this cmdlet. - -## PARAMETERS - -### -MetadataObject -Specifies the Business Data Connectivity metadata object. - -```yaml -Type: MetadataObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPContentTypes.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPContentTypes.md deleted file mode 100644 index 59a5ab4440..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPContentTypes.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPContentTypes -schema: 2.0.0 ---- - -# Copy-SPContentTypes - -## SYNOPSIS -Specifies content types for replicating from on-premises to SharePoint Online (SPO) environment. - -## SYNTAX - -``` -Copy-SPContentTypes [-AssignmentCollection <SPAssignmentCollection>] [-AuthEndpoint <String>] - -ContentTypeNames <String[]> -Credential <PSCredential> [-GraphApiEndPoint <String>] -LocalSiteUrl <Uri> - -LocalTermStoreName <String> -RemoteSiteUrl <Uri> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is used in hybrid scenarios with SharePoint Online to copy Content Types from an on-premises farm to SharePoint Online. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Copy-SPContentTypes -LocalSiteUrl http://localsite/ -LocalTermStoreName "managed metadata service application proxy" -RemoteSiteUrl https://contoso.sharepoint.com/ -ContentTypeNames @("ContentTypeA", "ContentTypeB") -Credential (Get-Credential) -``` - -This example migrates the specified content types named: ContentTypeA, ContentTypeB on the local site http://localsite/ whose term store named "managed metadata service application proxy" to the hub site of remote site https://contoso.sharepoint.com/. If the remote site is a hub site, the migration target will be itself. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthEndpoint -Specifies the AuthEndpoint to use, but not the default one. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypeNames -Specifies the content type names to be migrated. Can be in a form of an array. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrator account credential of the target SharePoint Online site. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -GraphApiEndPoint -Specifies the GraphApiEndpoint to use, but not the default one. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalSiteUrl -Specifies the migration source. Can be a local site or a local hubsite. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LocalTermStoreName -Specifies the name of the local term store of the local site. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RemoteSiteUrl -Specifies the migration target. You can input a remote site url or remote hub site url, both will be processed to be the hub site url. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Uri -System.String -System.String[] -System.Management.Automation.PSCredential -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPSideBySideFiles.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPSideBySideFiles.md deleted file mode 100644 index 601bf9b7f7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPSideBySideFiles.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -Applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPSideBySideFiles -schema: 2.0.0 ---- - -# Copy-SPSideBySideFiles - -## SYNOPSIS -Copy side by side files. - -## SYNTAX - -``` -Copy-SPSideBySideFiles [-AssignmentCollection <SPAssignmentCollection>] [-LogFile <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -In SharePoint Server 2016, zero down time in-place upgrade is available. If the PSConfig.exe file is used during an upgrade and copy SideBySide files fail, you can use the **Copy-SPSideBySideFiles** cmdlet to copy SideBySide files. If you use Microsoft PowerShell scripts instead of PSConfig.exe to perform an upgrade, please run the **Copy-SPSideBySideFiles** cmdlet to copy SideBySide files. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Copy-SPSideBySideFiles -LogFile "C:\CopySideBySideFiles.log" -``` - -This example copies SideBySide files and writes a log data of the copy process to the CopySideBySideFiles.log file. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LogFile -Specifies the fully-qualified logfile name of SideBySide copy operation. If LogFile is not specified, the logfile will be placed in default SharePoint log files folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPSite.md deleted file mode 100644 index e1d643135d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPSite.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPSite -schema: 2.0.0 ---- - -# Copy-SPSite - -## SYNOPSIS - -Makes a copy of a site collection. - - - -## SYNTAX - -``` -Copy-SPSite [-Identity] <SPSitePipeBind> [-TargetUrl] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-DestinationDatabase <SPContentDatabasePipeBind>] [-HostHeaderWebApplication <String>] [-PreserveSiteId] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Copy-SPSite cmdlet to make a copy of a site collection from an implied source content database to a specified destination content database. - -The copy of the site collection has a new URL and a new SiteID. -When you have database snapshot capabilities on a computer runningSQL Server, a temporary snapshot of the source database is created for the duration of the copy to prevent any data changes during the copy process. -If you do not have database snapshot capabilities on the server running SQL Server, you can back up the source and restore it to the destination to get the same result. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE------------- -``` -PS C:\>Copy-SPSite http://contoso/sites/OldTeam -DestinationDatabase WSS_Content -TargetUrl http://contoso/sites/NewTeam -``` - -This example makes a copy of the http://contoso/sites/OldTeam site collection from its database to the WSS_Content database with the new URL, http://contoso/sites/NewTeam and a new Site ID. - -## PARAMETERS - -### -Identity -Specifies the site collection to copy. -This can be a valid URL or GUID. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetUrl -The URL that will be used for the destination copy of the site collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DestinationDatabase -Specifies the location where the copy will be sent to. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostHeaderWebApplication -Use when the site collection is a host-named site collection that allows the site to land on the correct web application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreserveSiteId -Specifies if the SiteID is to be saved or not. - -The valid values are True and False. The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Test-SPSite](Test-SPSite.md) - -[Repair-SPSite](Repair-SPSite.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPTaxonomyGroups.md b/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPTaxonomyGroups.md deleted file mode 100644 index eb7ca91649..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Copy-SPTaxonomyGroups.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Copy-SPTaxonomyGroups -schema: 2.0.0 ---- - -# Copy-SPTaxonomyGroups - -## SYNOPSIS -Copies Managed Metadata Taxonomy Groups from SharePoint on-premises to SharePoint Online. - -## SYNTAX - -``` -Copy-SPTaxonomyGroups [-AssignmentCollection <SPAssignmentCollection>] [-AuthEndpoint <String>] - -Credential <PSCredential> [-GraphApiEndpoint <String>] -GroupNames <String[]> -LocalSiteUrl <Uri> - -LocalTermStoreName <String> -RemoteSiteUrl <Uri> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Copy-SPTaxonomyGroups cmdlet to copy specified Metadata groups from an on-premises environment to SharePoint Online in a Hybrid SharePoint setup. SharePoint Online becomes the authoritative source for the copied Taxonomy Group. All updates to the Taxonomy Group must be made in SharePoint Online. Once a Taxonomy Group is copied, it cannot be re-copied. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$credential = Get-Credential -PS C:\>Copy-SPTaxonomyGroups -LocalTermStoreName "Managed Metadata Service Application Proxy" -LocalSiteUrl "http://sharepoint/" -RemoteSiteUrl "http://contoso.sharepoint.com/" -GroupNames "Group1","Group2" -Credential $credential -``` - -This example copies two taxonomy groups "Group1" and "Group2" from local Term Store to the remote Term Store in "http://contoso.com/". These two sites have been enabled with Hybrid Taxonomy. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthEndpoint -Specifies the Azure Active Directory Graph API authentication endpoint. By default, the well-known endpoint will be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store. - -Writes data to remote Term Store, so a Term Store Administrator's credential is needed to perform the operations. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -GraphApiEndpoint -Specifies the Azure Active Directory Graph API endpoint. By default, the well-known endpoint will be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupNames -Specifies the name array of Taxonomy groups in local on-premises term store that will be copied to remote SharePoint Online Term store. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LocalSiteUrl -Specifies the Url of local SharePoint on-premises site that contains the local Taxonomy Term Store. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LocalTermStoreName -Specifies the name of local Taxonomy Term Store in the SharePoint on-premises farm. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RemoteSiteUrl -Specifies the Url of remote SharePoint Online site that contains remote Taxonomy Term Store. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Uri -System.String[] -System.Management.Automation.PSCredential -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-ProjectServerLicense.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-ProjectServerLicense.md deleted file mode 100644 index 0ad7f661ef..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-ProjectServerLicense.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Disable-ProjectServerLicense -schema: 2.0.0 ---- - -# Disable-ProjectServerLicense - -## SYNOPSIS -If the farm has Project Server enabled, this cmdlet will disable the Project Server functionality across the farm. All Project Web App sites will be read only and will still contain any data that existed before the license was disabled. New Project Web App sites cannot be created. - -## SYNTAX - -``` -Disable-ProjectServerLicense [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Disables Project Server functionality across the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Disable-ProjectServerLicense -``` - -This example disables Project Server functionality for the entire farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPAppAutoProvision.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPAppAutoProvision.md deleted file mode 100644 index 3a702c82c6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPAppAutoProvision.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPAppAutoProvision -schema: 2.0.0 ---- - -# Disable-SPAppAutoProvision - -## SYNOPSIS - -Disables automatic provisioning of an app. - - - -## SYNTAX - -``` -Disable-SPAppAutoProvision [-AssignmentCollection <SPAssignmentCollection>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Disable-SPAppAutoProvision cmdlet to disable automatic provisioning of an app to the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1-------------- -``` -PS C:\>Disable-SPAppAutoProvision -``` - -This example disables app auto provisioning for the farm. -The app auto provisioning is enabled by default. -This setting overrides site subscription level setting. - -### ---------------EXAMPLE 2-------------- -``` -C:\PS>$subscription = Get-SPSiteSubscription http://Contoso.com - -PS C:\>Disable-SPAppAutoProvision -SiteSubscription $subscription -``` - -This example disables app auto provisioning for the site subscription for Contoso.Com site. -The app auto provisioning is enabled by default. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site collection for which auto provisioning is to be disabled. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-SPAppAutoProvision](Enable-SPAppAutoProvision.md) - -[Get-SPAppAutoProvisionConnection](Get-SPAppAutoProvisionConnection.md) - -[Set-SPAppAutoProvisionConnection](Set-SPAppAutoProvisionConnection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPBusinessDataCatalogEntity.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPBusinessDataCatalogEntity.md deleted file mode 100644 index 48e1816545..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPBusinessDataCatalogEntity.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPBusinessDataCatalogEntity -schema: 2.0.0 ---- - -# Disable-SPBusinessDataCatalogEntity - -## SYNOPSIS - -Deactivates an External Content type in the Business Data Connectivity Metadata Store. - - - -## SYNTAX - -``` -Disable-SPBusinessDataCatalogEntity -Identity <Entity> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPBusinessDataCatalogEntity cmdlet deactivates an External Content type in the Business Data Connectivity Metadata Store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$entityToDisable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso -PS C:\>Disable-SPBusinessDataCatalogEntity -Identity $entityToDisable -``` - -This example deactivates the External Content type of the name Customer in the Contoso. -Note that the terms External Content type and Entity refer to the same object type, and the term Disable refers to the same action as the Business Data Connectivity term Deactivate. - -## PARAMETERS - -### -Identity -Specifies the External Content type in the Business Data Connectivity Metadata Store to deactivate. - -```yaml -Type: Entity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPFeature.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPFeature.md deleted file mode 100644 index 62531e76fc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPFeature.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPFeature -schema: 2.0.0 ---- - -# Disable-SPFeature - -## SYNOPSIS - -Disables an installed SharePoint Feature at a given scope. - - - -## SYNTAX - -``` -Disable-SPFeature [-Identity] <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-Url <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPFeature cmdlet disables a SharePoint Feature at the given scope. -If the scope of the Feature is the farm, the URL is not needed. -Otherwise, provide the URL at which this Feature is to be deactivated (explicit scope is not needed). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Disable-SPFeature -identity "MyCustom" -URL http://somesite -``` - -This example disables the "MyCustom" Web site scoped feature at http://somesite. - -### --------------EXAMPLE 2----------------- -``` -C:\PS>$w = Get-SPWeb http://somesite/myweb | ForEach{ $_.URL } -PS C:\>Get-SPFeature -Web $w |%{ Disable-SPFeature -Identity $_ -URL $w} -``` - -This example disables all features in the subsite at http://somesite/myweb. - -You do not need to use the SPAssignment cmdlets in this case because the Web object is not stored -- only the string value for the URL. - -## PARAMETERS - -### -Identity -Specifies the name of the Feature or GUID to disable. - -The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the format 21d186e1-7036-4092-a825-0eb6709e9281. - -```yaml -Type: SPFeatureDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces a Feature to be disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the URL of the Web application, site collection, or Web site to which the Feature is being disabled. - -The type must be a valid URL, such as http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPHealthAnalysisRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPHealthAnalysisRule.md deleted file mode 100644 index c124109f2e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPHealthAnalysisRule.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPHealthAnalysisRule -schema: 2.0.0 ---- - -# Disable-SPHealthAnalysisRule - -## SYNOPSIS - -Disables health analyzer rules. - - - -## SYNTAX - -``` -Disable-SPHealthAnalysisRule [-Identity] <SPHealthAnalysisRuleInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Disable-SPHealthAnalysisRule cmdlet to disable a health analyzer rule. - -The SPHealthAnalysisRule cmdlets were first introduced in the February 2011 Cumulative Update, which is available for download as follows: - ---Description of the SharePoint Foundation Cumulative Update Server Hotfix Package (SharePoint Foundation server-package) (http://support.microsoft.com/kb/2475880) ---Description of the SharePoint Server Cumulative Update Server Hotfix Package (MOSS server-package (http://support.microsoft.com/kb/2475878) - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE 1--------------------------- -``` -PS C:\>Disable-SPHealthAnalysisRule -Identity "CustomRule" -``` - -This example disables the health analyzer rule named CustomRule. - -## PARAMETERS - -### -Identity -Specifies the name or GUID of the health analyzer rule to disable. - -The type must be a valid name; an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPHealthAnalysisRuleInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPInfoPathFormTemplate.md deleted file mode 100644 index 9776dc6741..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Disable-SPInfoPathFormTemplate - -## SYNOPSIS -Deactivates a InfoPath form template from the specified site collection. - -## SYNTAX - -``` -Disable-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPInfoPathFormTemplate cmdlet deactivates the InfoPath form template that is specified in the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Disable-SPInfoPathFormTemplate -Identity "FormTemplate.xsn" -Site http://testSite -``` - -This example deactivates an InfoPath form template from a site collection named TestSite. - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to disable. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection that contains the InfoPath form template to deactivate. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: Url -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md deleted file mode 100644 index a1f37bc1d1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync -schema: 2.0.0 ---- - -# Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync - -## SYNOPSIS -Disables Timer Job execution of the Active Directory Enterprise Resource Pool synchronization. - -## SYNTAX - -``` -Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync [-Url] <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Active Directory Enterprise Resource Pool synchronization is used to create or update multiple Project Server enterprise resources at the same time. -Project Server enterprise resources can also be automatically activated and deactivated based on group membership in the Active Directory directory service. -For example, new employees in your department can automatically be added as Project Server enterprise resources as long as they are in the Active Directory group selected for synchronization. -Conversely, employees who are removed from the Active Directory group have their Project Server accounts deactivated upon synchronization. - -Enterprise Resource Pool synchronization also updates enterprise resource properties with the most current data from Active Directory. -For example, an employee's name and e-mail address may change because of marriage. -As long as the change is made in Active Directory and the user is in the linked group, the change occurs in the user's Enterprise Resource properties when synchronization occurs. - -The Enterprise Resource Pool can be mapped to a single Active Directory group for synchronization. -However, this Active Directory group can contain nested groups whose members are also synchronized. - -The following actions can occur during the Enterprise Resource Pool synchronization process: - -- A new Project Server enterprise resource and corresponding user account can be created based on an Active Directory account. -- An active Project Server resource/user account can be deactivated. -- An existing Project Server user account's metadata (for example, name, e-mail address, and so on) can be updated if it has changed in Active Directory. -- A previously inactive Project Server resource/user account can be reactivated. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync http://localhost/pwa -``` - -This example disables Timer Job execution of the Active Directory Enterprise Resource Pool synchronization on http://localhost/pwa. - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App (PWA) instance to disable Active Directory Enterprise Resource Sync. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectEmailNotification.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectEmailNotification.md deleted file mode 100644 index f4c2ab83d1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectEmailNotification.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2016, Project Server 2019 -title: Disable-SPProjectEmailNotification -schema: 2.0.0 ---- - -# Disable-SPProjectEmailNotification - -## SYNOPSIS -Turns off the Project Web App site level setting for email notifications in Project Server. - -## SYNTAX - -``` -Disable-SPProjectEmailNotification [-Url] <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Turns off the Project Web App site level setting for email notifications in Project Server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-SPProjectEmailNotification -Url http://pwa_site -``` - -Disables Project Server email notifications on the Project Web App site, http://pwa_site. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the Project Web App site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectEnterpriseProjectTaskSync.md deleted file mode 100644 index c5d5d833bf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectEnterpriseProjectTaskSync.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Disable-SPProjectEnterpriseProjectTaskSync -schema: 2.0.0 ---- - -# Disable-SPProjectEnterpriseProjectTaskSync - -## SYNOPSIS -Disables task sync between Project Web App and the associated project site. Once this is disabled, tasks created in the enterprise project in Project Web App will no longer sync to the task list on the project site associated with the project. This feature is disabled by default. - -## SYNTAX - -``` -Disable-SPProjectEnterpriseProjectTaskSync [-AssignmentCollection <SPAssignmentCollection>] -Url <Uri> - [<CommonParameters>] -``` - -## DESCRIPTION -Disables task sync between Project Web App and the associated project site. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-SPProjectEnterpriseProjectTaskSync -Url http://pwa_site -``` - -Disables Project Server task sync on the Project Web App site, http://pwa_site. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the PWA site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectQueueStatsMonitoring.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectQueueStatsMonitoring.md deleted file mode 100644 index 4814cc8f07..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPProjectQueueStatsMonitoring.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Disable-SPProjectQueueStatsMonitoring -schema: 2.0.0 ---- - -# Disable-SPProjectQueueStatsMonitoring - -## SYNOPSIS -Disables monitoring Project Server queue statistics. - -## SYNTAX - -``` -Disable-SPProjectQueueStatsMonitoring [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Disables monitoring Project Server queue statistics. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-SPProjectQueueStatsMonitoring -``` - -Disables monitoring Project Server queue statistics. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPSessionStateService.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPSessionStateService.md deleted file mode 100644 index 472cfe410c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPSessionStateService.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPSessionStateService -schema: 2.0.0 ---- - -# Disable-SPSessionStateService - -## SYNOPSIS -Turns off the session state service on the farm. - -## SYNTAX - -``` -Disable-SPSessionStateService [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPSessionStateService cmdlet turns off the session state service. -If your farm does not depend on session state service, we recommend that you disable it. - -When session state is disabled, some SharePoint Server services, components, and third-party components no longer function. -Changing this property modifies the Web.config file on every content Web application on every server in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Disable-SPSessionStateService -``` - -This example turns off ASP.NET session state on the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPSingleSignOn.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPSingleSignOn.md deleted file mode 100644 index c6f17d2b17..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPSingleSignOn.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPSingleSignOn -schema: 2.0.0 ---- - -# Disable-SPSingleSignOn - -## SYNOPSIS -Disables the single sign-on (SSO) Service on a farm server. - -## SYNTAX - -``` -Disable-SPSingleSignOn -ServerName <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Disable-SPSingleSignOn cmdlet to disable the SSO Service on a farm server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Disable-SPSingleSignOn myOldSSO -ServerName CONTOSO -``` - -This example turns off the SSO Service on the server named CONTOSO. - -## PARAMETERS - -### -ServerName -Specifies the name of the server in which the service is running. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPTimerJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPTimerJob.md deleted file mode 100644 index 5caabb9cbe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPTimerJob.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPTimerJob -schema: 2.0.0 ---- - -# Disable-SPTimerJob - -## SYNOPSIS - -Disables a timer job. - - - -## SYNTAX - -``` -Disable-SPTimerJob [-Identity] <SPTimerJobPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPTimerJob cmdlet disables a timer job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE----------------------- -``` -PS C:\>Disable-SPTimerJob job-ceip-datacollection -``` - -This example disables the timer job named job-ceip-datacollection. - -## PARAMETERS - -### -Identity -Specifies the timer job to disable. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. - -```yaml -Type: SPTimerJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPUserLicensing.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPUserLicensing.md deleted file mode 100644 index e712e7a6a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPUserLicensing.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPUserLicensing -schema: 2.0.0 ---- - -# Disable-SPUserLicensing - -## SYNOPSIS - -Disables user license enforcement. - - - -## SYNTAX - -``` -Disable-SPUserLicensing [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPUserLicensing cmdlet disables user license enforcement on the SharePoint farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1------------------- -``` -PS C:\>Disable-SPUserLicensing -``` - -This example disables user license enforcement on the SharePoint farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPUserSolutionAllowList.md deleted file mode 100644 index 0d6553af4b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPUserSolutionAllowList.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPUserSolutionAllowList -schema: 2.0.0 ---- - -# Disable-SPUserSolutionAllowList - -## SYNOPSIS -Disables the user managed solutions gallery capability on the farm. - -## SYNTAX - -``` -Disable-SPUserSolutionAllowList [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Disables the user managed solutions gallery capability on the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-SPUserSolutionAllowList -``` - -Disables the user managed solutions gallery capability on the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPWebApplicationHttpThrottling.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPWebApplicationHttpThrottling.md deleted file mode 100644 index d40fb386fb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPWebApplicationHttpThrottling.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPWebApplicationHttpThrottling -schema: 2.0.0 ---- - -# Disable-SPWebApplicationHttpThrottling - -## SYNOPSIS - -Turns off network throttling for a Web application. - - - -## SYNTAX - -``` -Disable-SPWebApplicationHttpThrottling [-Identity] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-SPWebApplicationHttpThrottling cmdlet turns off network throttling for a Web application. -This operation prompts you to confirm that you want to turn off network throttling. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Disable-SPWebApplicationHTTPThrottling http://sitename -``` - -This example disables network throttling on the Web application http://sitename. - -## PARAMETERS - -### -Identity -Turns off network throttling on the specified SharePoint Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPWebTemplateForSiteMaster.md b/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPWebTemplateForSiteMaster.md deleted file mode 100644 index 557cf4996c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disable-SPWebTemplateForSiteMaster.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Disable-SPWebTemplateForSiteMaster -schema: 2.0.0 ---- - -# Disable-SPWebTemplateForSiteMaster - -## SYNOPSIS -Disables the site master in the farm. - -## SYNTAX - -``` -Disable-SPWebTemplateForSiteMaster [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] -Template <SPWebTemplatePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Disable-SPWebTemplateForSiteMaster cmdlet to disable a site master in the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-SPWebTemplateForSiteMaster -Template STS#0 -``` - -This example disables the template in the site master of a farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. - -When this parameter is not specified, the CompatibilityLevel parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the name of the template. For example, SPSPERS#2. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Disconnect-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Disconnect-SPConfigurationDatabase.md deleted file mode 100644 index f7c144391e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Disconnect-SPConfigurationDatabase.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Disconnect-SPConfigurationDatabase -schema: 2.0.0 ---- - -# Disconnect-SPConfigurationDatabase - -## SYNOPSIS - -Disconnects the local server computer from the farm. - - - -## SYNTAX - -``` -Disconnect-SPConfigurationDatabase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Disconnect-SPConfigurationDatabase cmdlet disconnects the active server computer from the SharePoint configuration database. -This operation removes the server computer from the farm. -The configuration database must be disconnected before the database can be removed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Disconnect-SPConfigurationDatabase -Confirm:$false -``` - -This example removes the local server computer from a farm without prompting for user confirmation. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPContentDatabase.md deleted file mode 100644 index 5ffd07fc2e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPContentDatabase.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Dismount-SPContentDatabase -schema: 2.0.0 ---- - -# Dismount-SPContentDatabase - -## SYNOPSIS - -Detaches a content database from its currently associated Web application. - - - -## SYNTAX - -``` -Dismount-SPContentDatabase [-Identity] <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Dismount-SPContentDatabase cmdlet to detatch the given content database from its currently associated Web application. -This cmdlet will not delete the content database. -Use the Remove-SPContentDatabase cmdlet to delete a content database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1------------ -``` -PS C:\>Dismount-SPContentDatabase 12345678-90ab-cdef-1234-567890abcdef -``` - -This example detaches the content database with the GUID 12345678-90ab-cdef-1234-567890abcdef from its current parent Web application. - -### --------------EXAMPLE 2------------ -``` -PS C:\>Get-SPContentDatabase -WebApplication http://sitename | Dismount-SPContentDatabase -WhatIf -``` - -This example detaches all content databases from the Web application on port 80 of the local machine. -Remove the WhatIf parameter to perform the operation. - -## PARAMETERS - -### -Identity -Specifies the content database to detach. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPSiteMapDatabase.md deleted file mode 100644 index bd61e8fadf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPSiteMapDatabase.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2016 -title: Dismount-SPSiteMapDatabase -schema: 2.0.0 ---- - -# Dismount-SPSiteMapDatabase - -## SYNOPSIS -Do not use. - -## SYNTAX - -``` -Dismount-SPSiteMapDatabase [-DatabaseId] <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use. - -## EXAMPLES - -### ------------EXAMPLE------------------ -``` -PS C:\> -``` - -Do not use. - -## PARAMETERS - -### -AssignmentCollection -Do not use. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseId -Do not use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPStateServiceDatabase.md deleted file mode 100644 index 54103ebef8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Dismount-SPStateServiceDatabase.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Dismount-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Dismount-SPStateServiceDatabase - -## SYNOPSIS -Removes the association to a state service database from the farm without dropping the database in the Microsoft SQL Server database. - -## SYNTAX - -``` -Dismount-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Dismount-SPStateServiceDatabase cmdlet removes a state service database from a service application and deletes the associated SharePoint object. -This cmdlet does not delete or alter the state service database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Dismount-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -``` - -This example removes the association between the SharePoint farm and the SQL Server database without dropping the SQL Server database. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPStateServiceDatabase -ServiceApplication F9168C5E-CEB2-4faa-B6B -F-329BF39FA1E4 | Dismount-SPStateServiceDatabase -``` - -This example dismounts a single database because only the Identity parameter is used. - -## PARAMETERS - -### -Identity -Specifies the state service database to remove from the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-ProjectServerLicense.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-ProjectServerLicense.md deleted file mode 100644 index da8720959c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-ProjectServerLicense.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Enable-ProjectServerLicense -schema: 2.0.0 ---- - -# Enable-ProjectServerLicense - -## SYNOPSIS -Enables all Project Server functionality in the farm. The cmdlet depends on the farm having a valid SharePoint Server license (trials are allowed). Any existing Project Web App sites will become read/write. A Project Server Trial key will only be accepted if the farm has never had a Project Server trial key previously. - -## SYNTAX - -``` -Enable-ProjectServerLicense [-Key] <String> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Enables Project Server functionality on the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-ProjectServerLicense -Key XXXXX-XXXXX-XXXXX-XXXXX-XXXXX -``` - -This example enables all Project Server functionality in the farm. The type of license being enabled (full or trial) depends on the key that is passed in. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Key -License key (trial or full). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPAppAutoProvision.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPAppAutoProvision.md deleted file mode 100644 index 4a7b6a2874..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPAppAutoProvision.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPAppAutoProvision -schema: 2.0.0 ---- - -# Enable-SPAppAutoProvision - -## SYNOPSIS - -Enables automatic provisioning of an app. - -## SYNTAX - -``` -Enable-SPAppAutoProvision [-AssignmentCollection <SPAssignmentCollection>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Enable-SPAppAutoProvision cmdlet to enable automatic provisioning of an app to the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1-------- -``` -PS C:\>Enable-SPAppAutoProvision -``` - -This example enables auto provisioning for the farm. -The app auto provisioning is enabled by default. -This setting overrides site subscription level setting. - -### --------------EXAMPLE 2-------- -``` -C:\PS>$subscription = Get-SPSiteSubscription http://Contoso.com -PS C:\>Enable-SPAppAutoProvision -SiteSubscription $subscription -``` - -This example enables app auto provisioning for the site subscription for Contoso.Com site. -The app auto provisioning is enabled by default. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site collection for which auto provisioning is to be enabled. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-SPAppAutoProvision](Disable-SPAppAutoProvision.md) - -[Get-SPAppAutoProvisionConnection](Get-SPAppAutoProvisionConnection.md) - -[Set-SPAppAutoProvisionConnection](Set-SPAppAutoProvisionConnection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPBusinessDataCatalogEntity.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPBusinessDataCatalogEntity.md deleted file mode 100644 index 8add132a17..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPBusinessDataCatalogEntity.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPBusinessDataCatalogEntity -schema: 2.0.0 ---- - -# Enable-SPBusinessDataCatalogEntity - -## SYNOPSIS - -Activates an External Content type in the Business Data Connectivity Metadata Store. - - - -## SYNTAX - -``` -Enable-SPBusinessDataCatalogEntity -Identity <Entity> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-SPBusinessDataCatalogEntity cmdlet activates an External Content type in the Business Data Connectivity Metadata Store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$entityToEnable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso -PS C:\>Enable-SPBusinessDataCatalogEntity -Identity $entityToEnable -``` - -This example activates the External Content type with the name Customer in the Contoso namespace on the site http://contoso. -Note that the terms External Content type and Entity refer to the same object type. - -## PARAMETERS - -### -Identity -Specifies the External Content type in the Business Data Connectivity Metadata Store to activate. - -```yaml -Type: Entity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPFeature.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPFeature.md deleted file mode 100644 index 01dd9eb7d5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPFeature.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPFeature -schema: 2.0.0 ---- - -# Enable-SPFeature - -## SYNOPSIS - -Enables an installed SharePoint Feature at the given scope. - -## SYNTAX - -### SiteFeature -``` -Enable-SPFeature [-Identity] <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-PassThru] [-Url <String>] [-WhatIf] [<CommonParameters>] -``` - -### FarmFeatureDefinition -``` -Enable-SPFeature [-Identity] <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-PassThru] [-WhatIf] [-CompatibilityLevel <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-SPFeature cmdlet enables an installed feature at the given scope. -If the feature is a farm feature, no URL is needed. -Otherwise, provide the URL where the feature is to be enabled and it will be enabled at the proper scope based on the Feature definition. - -This cmdlet has no output unless the PassThru parameter is provided, in which case the SPFeatureDefinition object for the newly enabled feature is returned. - -If you try to use the Url parameter on a farm-scoped feature, you receive the following error message: - -The feature '\<feature name\>' applies to the entire farm; the Url parameter cannot be used with farm-scoped features. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Enable-SPFeature -identity "MyCustom" -URL http://somesite -``` - -This example enables the "MyCustom" site scoped SharePoint Feature at http://somesite. - -### --------------EXAMPLE 2----------------- -``` -C:\PS>$w = Get-SPWeb http://somesite/myweb | ForEach{ $_.URL } -PS C:\>Get-SPFeature -Web $w |%{ Enable-SPFeature -Identity $_ -URL $w} -``` - -This example enables all SharePoint Features in the subsite at http://somesite/myweb. - -## PARAMETERS - -### -Identity -Specifies the name of the Feature or GUID to uninstall. - -The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. - -```yaml -Type: SPFeatureDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the activation of a Feature. -This causes any custom code associated with the Feature to rerun. - -> [!NOTE] -> Please be aware ```-Force``` will not work if you updated the feature with Update-SPSolution. -> In this case you have to disable feature first with ```Disable-SPFeature``` and then enable it back with ```Enable-SPFeature``` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If provided, the cmdlet outputs the Feature definition object after enable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the URL of the Web application, site collection, or Web site for which the Feature is being activated. - -The type must be a valid URL; for example, http://server_name. - -```yaml -Type: String -Parameter Sets: SiteFeature -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -{{Fill CompatibilityLevel Description}} - -```yaml -Type: Int32 -Parameter Sets: FarmFeatureDefinition -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPHealthAnalysisRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPHealthAnalysisRule.md deleted file mode 100644 index bf20f8c016..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPHealthAnalysisRule.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPHealthAnalysisRule -schema: 2.0.0 ---- - -# Enable-SPHealthAnalysisRule - -## SYNOPSIS - -Enables a health analyzer rule. - - - -## SYNTAX - -``` -Enable-SPHealthAnalysisRule [-Identity] <SPHealthAnalysisRuleInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Enable-SPHealthAnalysisRule cmdlet to enable a health analyzer rule. - -The SPHealthAnalysisRule cmdlets were first introduced in the February 2011 Cumulative Update, which is available for download as follows: - ---Description of the SharePoint Foundation Cumulative Update Server Hotfix Package (SharePoint Foundation server-package) (http://support.microsoft.com/kb/2475880) ---Description of the SharePoint Server Cumulative Update Server Hotfix Package (MOSS server-package (http://support.microsoft.com/kb/2475878) - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE 1--------------------------- -``` -PS C:\>Enable-SPHealthAnalysisRule -Identity "CustomRule" -``` - -This example enables the health analyzer rule named CustomRule. - -## PARAMETERS - -### -Identity -Specifies the name or GUID of the health analyzer rule to enable. - -The type must be a valid name, an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPHealthAnalysisRuleInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPInfoPathFormTemplate.md deleted file mode 100644 index a3ad9751d3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Enable-SPInfoPathFormTemplate - -## SYNOPSIS -Activates a InfoPath form template in the specified site collection. - -## SYNTAX - -``` -Enable-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-SPInfoPathFormTemplate cmdlet activates an InfoPath form template to the SharePoint site collection specified in the Site parameter. -This cmdlet returns a new InfoPath form template. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Enable-SPInfoPathFormTemplate -Identity "FormTemplate.xsn" -Site "http://testsite/" -``` - -This example activates an InfoPath form template to a site collection named TestSite. - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to activate. -The form template must be an administrator-approved, browser-enabled form template that is available on the server farm. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection that contains the InfoPath form template to activate. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md deleted file mode 100644 index 9c677b0e56..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync -schema: 2.0.0 ---- - -# Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync - -## SYNOPSIS -Enables Timer Job execution of the Active Directory Enterprise Resource Pool synchronization. - -## SYNTAX - -``` -Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync [-Url] <Uri> - [-GroupUids] <System.Collections.Generic.IEnumerable`1[System.Guid]> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Active Directory Enterprise Resource Pool synchronization is used to create or update multiple Project Server enterprise resources at the same time. -Project Server enterprise resources can also be automatically activated and deactivated based on group membership in the Active Directory directory service. -For example, new employees in your department can automatically be added as Project Server enterprise resources as long as they are in the Active Directory group selected for synchronization. -Conversely, employees who are removed from the Active Directory group have their Project Server accounts deactivated upon synchronization. - -Enterprise Resource Pool synchronization also updates enterprise resource properties with the most current data from Active Directory. -For example, an employee's name and e-mail address may change because of marriage. -As long as the change is made in Active Directory and the user is in the linked group, the change occurs in the user's Enterprise Resource properties when synchronization occurs. - -The Enterprise Resource Pool can be mapped to a single Active Directory group for synchronization. -However, this Active Directory group can contain nested groups whose members are also synchronized. - -The following actions can occur during the Enterprise Resource Pool synchronization process: - -- A new Project Server enterprise resource and corresponding user account can be created based on an Active Directory account. -- An active Project Server resource/user account can be deactivated. -- An existing Project Server user account's metadata (for example, name, e-mail address, and so on) can be updated if it has changed in Active Directory. -- A previously inactive Project Server resource/user account can be reactivated. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -PS C:\>$groupGuids = Get-ADGroup -Filter {Name -eq 'Domain Users' -or Name -eq 'Domain Admins'} | select ObjectGuid #Active Directory PowerShell Module required -PS C:\>[Guid[]]$groupUids = $groupGuids[0].ObjectGuid,$groupGuids[1].ObjectGuid -PS C:\>Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync -Url http://pwa_site -GroupUids $groupUids -``` - -Retrieves the ObjectGuid values of the Domain Users and Domain Admins Active Directory groups and adds them to the Active Directory Enterprise Resource Pool Synchronization on the Project Web Apps site, http://pwa_site. - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App instance to enable Active Directory Enterprise Resource Sync. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupUids -The Active Directory Group GUID to synchronize the Enterprise Resource Pool with. - -```yaml -Type: System.Collections.Generic.IEnumerable`1[System.Guid] -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md) - -[Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectEmailNotification.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectEmailNotification.md deleted file mode 100644 index bc33b73e13..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectEmailNotification.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Enable-SPProjectEmailNotification -schema: 2.0.0 ---- - -# Enable-SPProjectEmailNotification - -## SYNOPSIS -Turns on the Project Web App site level setting for email notifications in Project Server. - -## SYNTAX - -``` -Enable-SPProjectEmailNotification [-Url] <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Turns on the Project Web App site level setting for email notifications in Project Server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-SPProjectEmailNotification -Url http://pwa_site -``` - -Enables Project Server email notifications on the Project Web App site, http://pwa_site. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the Project Web App site. -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectEnterpriseProjectTaskSync.md deleted file mode 100644 index 41adb57e89..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectEnterpriseProjectTaskSync.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Enable-SPProjectEnterpriseProjectTaskSync -schema: 2.0.0 ---- - -# Enable-SPProjectEnterpriseProjectTaskSync - -## SYNOPSIS -Enables task sync between Project Web App and the associated project site. Once this is enabled, tasks created in the enterprise project in Project Web App will sync to the task list on the project site associated with the project. This feature is disabled by default. - -If you enable this feature, the restrictions that come with SharePoint lists, such as the maximum number of items supported before throttling, apply. - -Syncing tasks uses the queue and can affect performance. You should enable it only if you really need it. - -## SYNTAX - -``` -Enable-SPProjectEnterpriseProjectTaskSync [-AssignmentCollection <SPAssignmentCollection>] -Url <Uri> - [<CommonParameters>] -``` - -## DESCRIPTION -Enables task sync between Project Web App and the associated project site. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-SPProjectEnterpriseProjectTaskSync -Url http://pwa_site -``` - -Enables Project Task sync on the Project Web Apps site, http://pwa_site. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the PWA site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectQueueStatsMonitoring.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectQueueStatsMonitoring.md deleted file mode 100644 index 96cfd4f263..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPProjectQueueStatsMonitoring.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Enable-SPProjectQueueStatsMonitoring -schema: 2.0.0 ---- - -# Enable-SPProjectQueueStatsMonitoring - -## SYNOPSIS -Enables monitoring Project Server queue statistics. - -## SYNTAX - -``` -Enable-SPProjectQueueStatsMonitoring [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Enables monitoring Project Server queue statistics. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-SPProjectQueueStatsMonitoring -``` - -Enables monitoring Project Server queue statistics. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPSessionStateService.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPSessionStateService.md deleted file mode 100644 index 381fd3501b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPSessionStateService.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPSessionStateService -schema: 2.0.0 ---- - -# Enable-SPSessionStateService - -## SYNOPSIS -Creates a session state database and turns on the session state service. - -## SYNTAX - -### AdvancedProvision -``` -Enable-SPSessionStateService -DatabaseName <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DatabaseCredentials <PSCredential>] [-DatabaseServer <String>] [-SessionTimeout <Int32>] [-WhatIf] - [<CommonParameters>] -``` - -### DefaultProvision -``` -Enable-SPSessionStateService [-DefaultProvision] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SessionTimeout <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Enable-SPSessionStateService cmdlet creates a session state database, installs the ASP.NET session state schema, and updates the Web.config files on the farm to turn on the session state service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Enable-SPSessionStateService -DefaultProvision -``` - -This example enables a ASP.NET session state on a SharePoint Server farm that uses the defaults (database hosted on the configuration database SQL Server, using Windows authentication, 60-minute session time-out). - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Enable-SPSessionStateService -DatabaseName "Session State Database" -DatabaseServer "localhost" -SessionTimeout 120 -``` - -This example enables a ASP.NET session state on a SharePoint Server farm that uses a custom database name, database server, session time-out of 120 minutes, and Windows credentials (due to the lack of a DatabaseCredentials parameter). - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for the session state service. - -The type must be a valid name of a SQL Server database; for example, SessionStateDB1. - -```yaml -Type: String -Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProvision -Specifies that the default provisioning settings are used. -The default provisioning settings are: Windows Authentication, Auto SQL Server (configuration database), and Auto Catalog Name. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the database credentials for SQL Authentication used to access the session state service database. -If this parameter is not specified, Windows authentication is used. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the host SQL Server for the state service database. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionTimeout -Specifies the time, in minutes, that a ASP .NET session state service will remain active with no user activity. -The default value is 60. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPTimerJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPTimerJob.md deleted file mode 100644 index a87fc666ee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPTimerJob.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPTimerJob -schema: 2.0.0 ---- - -# Enable-SPTimerJob - -## SYNOPSIS - -Enables a timer job. - - - -## SYNTAX - -``` -Enable-SPTimerJob [-Identity] <SPTimerJobPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-SPTimerJob cmdlet enables a timer job. -A timer job must be enabled before it can be started. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE--------------------- -``` -PS C:\>Get-SPTimerJob job-ceip-datacollection | Enable-SPTimerJob -``` - -This example enables the timer job named job-ceip-datacollection. - -## PARAMETERS - -### -Identity -Specifies the timer job to enable. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. - -```yaml -Type: SPTimerJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPUserLicensing.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPUserLicensing.md deleted file mode 100644 index 66043da82c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPUserLicensing.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPUserLicensing -schema: 2.0.0 ---- - -# Enable-SPUserLicensing - -## SYNOPSIS - -Enables user-license enforcement. - - - -## SYNTAX - -``` -Enable-SPUserLicensing [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-SPUserLicensing cmdlet enables user-license enforcement on the SharePoint farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE------------------ -``` -PS C:\>Enable-SPUserLicensing -``` - -This example enables user-license enforcement on the SharePoint farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPUserSolutionAllowList.md deleted file mode 100644 index 2e33346eae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPUserSolutionAllowList.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPUserSolutionAllowList -schema: 2.0.0 ---- - -# Enable-SPUserSolutionAllowList - -## SYNOPSIS -Enables the user managed solutions gallery capability on the farm. - -## SYNTAX - -``` -Enable-SPUserSolutionAllowList [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Enables the user managed solutions gallery capability on the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-SPUserSolutionAllowList -``` - -This example enables a user managed solutions gallery on the entire farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPWebApplicationHttpThrottling.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPWebApplicationHttpThrottling.md deleted file mode 100644 index bb7595e3f4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPWebApplicationHttpThrottling.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPWebApplicationHttpThrottling -schema: 2.0.0 ---- - -# Enable-SPWebApplicationHttpThrottling - -## SYNOPSIS - -Turns on network throttling for a Web application. - - - -## SYNTAX - -``` -Enable-SPWebApplicationHttpThrottling [-Identity] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Enable-SPWebApplicationHttpThrottling cmdlet turns on network throttling for a Web application. -This operation prompts you to confirm that you want to turn on network throttling. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Enable-SPWebApplicationHttpThrottling http://sitename -``` - -This example enables network throttling on the http://sitename Web application. - -## PARAMETERS - -### -Identity -Turns on network throttling on the specified SharePoint Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPWebTemplateForSiteMaster.md b/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPWebTemplateForSiteMaster.md deleted file mode 100644 index f8e29df7d6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Enable-SPWebTemplateForSiteMaster.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Enable-SPWebTemplateForSiteMaster -schema: 2.0.0 ---- - -# Enable-SPWebTemplateForSiteMaster - -## SYNOPSIS -Creates a template for a site master. - -## SYNTAX - -``` -Enable-SPWebTemplateForSiteMaster [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] -Template <SPWebTemplatePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Enable-SPWebTemplateEnabledForSiteMaster cmdlet to create a site master in the database. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-SPWebTemplateForSiteMaster -Template STS#0 -CompatibilityLevel 15 -``` - -This example creates a site master in the database using the Team Site template. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. - -When this parameter is not specified, the CompatibilityLevel parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the name of the template. For example, SPSPERS#2. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPAccessServicesDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPAccessServicesDatabase.md deleted file mode 100644 index 0027ee5252..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPAccessServicesDatabase.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPAccessServicesDatabase -schema: 2.0.0 ---- - -# Export-SPAccessServicesDatabase - -## SYNOPSIS -Exports an Access Services Database to a DACPAC via the Data-Tier Framework. - -## SYNTAX - -``` -Export-SPAccessServicesDatabase [-AssignmentCollection <SPAssignmentCollection>] -DatabaseName <String> - -ServerReferenceId <Guid> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet exports an Access Services Database to a DACPAC. The cmdlet requires the Data-Tier Framework to be installed on the SharePoint server where the cmdlet is run. The Data-Tier Framework packages can be found at [Microsoft® SQL Server® Data-Tier Application Framework (17.4.1 GA DacFx)](https://www.microsoft.com/en-us/download/details.aspx?id=56508). Install the following MSI from the download: - -EN\x86\DacFramework.msi - -Note: The x86 package is required. The x64 package is not compatible with this cmdlet. - -See more information about Data-Tier Framework at [Data-tier Applications](https://docs.microsoft.com/en-us/sql/relational-databases/data-tier-applications/data-tier-applications). - -## EXAMPLES - -### Example 1 -``` -PS C:\>$contentdb = Get-SPContentDatabase ContentDbName -PS C:\>$accessDb = Get-SPAccessServicesDatabase -ContentDb $contentdb -EA 0 | Select -First 1 -PS C:\>Export-SPAccessServicesDatabase -DatabaseName $accessDb.DatabaseName -ServerReferenceId $accessDb.ServerReferenceId | Set-Content -Path C:\accessDb.bacpac -Encoding Byte -``` - -This cmdlet retrieves the first Access Database from the specified Content Database and exports the Access Database to a BACPAC. This BACPAC file can then be imported via SQL Server Management Studio to restore the Access Database. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the Access Database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerReferenceId -The ServerReferenceId used for the Access Database. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Guid -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPAppPackage.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPAppPackage.md deleted file mode 100644 index ecd8ea265a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPAppPackage.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPAppPackage -schema: 2.0.0 ---- - -# Export-SPAppPackage - -## SYNOPSIS - -Exports an app package. - -## SYNTAX - -``` -Export-SPAppPackage -App <SPApp> -Path <String> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Export-SPAppPackage cmdlet to export an app package from the content database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------- -``` -C:\PS>$instance = Get-SPAppInstance -AppInstanceId $instance.Id -PS C:\>Export-SPAppPackage -App $instance.App -Path .\exported.spapp -``` - -This example exports an app package to the \exported.spapp location. - -## PARAMETERS - -### -App -Specifies the App for which to export the package. - -```yaml -Type: SPApp -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the exported file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Import-SPAppPackage](Import-SPAppPackage.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPBusinessDataCatalogModel.md deleted file mode 100644 index 342597633d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPBusinessDataCatalogModel.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPBusinessDataCatalogModel -schema: 2.0.0 ---- - -# Export-SPBusinessDataCatalogModel - -## SYNOPSIS - -Exports a Business Data Connectivity Model. - - - -## SYNTAX - -``` -Export-SPBusinessDataCatalogModel -Identity <MetadataObject> -Path <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Force] [-LocalizedNamesIncluded] [-ModelsIncluded] - [-PermissionsIncluded] [-PropertiesIncluded] [-ProxiesIncluded] [-SettingId <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPBusinessDataCatalogModel cmdlet exports a Business Data Connectivity Model. -There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). -The Model type contains the base XML metadata, and can also include resource properties. -The Resource type includes only resource properties. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceContext http://contoso -PS C:\>Export-SPBusinessDataCatalogModel -Identity $Model -Path "C:\folder\model.bdcm" -``` - -This example gets a Business Data Connectivity Model from the Business Data Connectivity Metadata Store and exports it to the location specified with the name model and using the bdcm file extension. - -## PARAMETERS - -### -Identity -Specifies the Business Data Connectivity Metadata Store metadata object from which to export the Business Data Connectivity Model. - -```yaml -Type: MetadataObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path and name to use to create the export file. - -The type must be a valid path in either of the following forms: - -- C:\folder_name \file.bdcm -- \\\\server_name\folder_name \file.bdcm -- …\folder_name\file.bdcm - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Overwrites the output file if the file exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalizedNamesIncluded -Specifies that names for business data fields in multiple languages are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModelsIncluded -Specifies that models are included in the exported Business Data Connectivity Model file. -A model contains the base XML metadata for a system. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsIncluded -Specifies that permissions from the Business Data Connectivity Model are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertiesIncluded -Specifies that properties from the application definition are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxiesIncluded -Specifies that proxies for Business Data Connectivity Service applications are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingId -Specifies the custom environment settings model slice to export. - -The type must be a valid string that identifies a model slice; for example, ModelSlice1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPEnterpriseSearchTopology.md deleted file mode 100644 index 26ecc2e618..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPEnterpriseSearchTopology.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPEnterpriseSearchTopology -schema: 2.0.0 ---- - -# Export-SPEnterpriseSearchTopology - -## SYNOPSIS -Saves an existing search topology. - -## SYNTAX - -``` -Export-SPEnterpriseSearchTopology -Filename <String> -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPEnterpriseSearchTopology cmdlet exports the topology for a shared search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Export-SPEnterpriseSearchTopology -SearchApplication $ssa -Filename topology.xml -``` - -This example exports the topology to a file named topology.xml in the search service application referenced by $ssa. - -## PARAMETERS - -### -Filename -Specifies the path and file name to use to create the topology XML file. - -The type must be a valid path, in the form MyFeature\Feature.xml. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application with the topology to export. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchTopology](New-SPEnterpriseSearchTopology.md) - -[Get-SPEnterpriseSearchTopology](Get-SPEnterpriseSearchTopology.md) - -[Set-SPEnterpriseSearchTopology](Set-SPEnterpriseSearchTopology.md) - -[Remove-SPEnterpriseSearchTopology](Remove-SPEnterpriseSearchTopology.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPInfoPathAdministrationFiles.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPInfoPathAdministrationFiles.md deleted file mode 100644 index 28b47982b2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPInfoPathAdministrationFiles.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPInfoPathAdministrationFiles -schema: 2.0.0 ---- - -# Export-SPInfoPathAdministrationFiles - -## SYNOPSIS -Saves InfoPath form templates on the SharePoint Central Administration Web site and .udcx files to a .cab file. - -## SYNTAX - -``` -Export-SPInfoPathAdministrationFiles [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Identity <SPFormsServicePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPInfoPathAdministrationFiles cmdlet saves all InfoPath form templates (.xsn files) and universal data connections (.udcx files) that are located on the Central Administration page. -The backup package includes all workflow forms in InfoPath that were deployed by an administrator and not included with SharePoint Server, and includes browser forms that were deployed by an administrator. -The backup package is output to the specified .cab file. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Export-SPInfoPathAdministrationFiles -path d:\file.cab -``` - -This example saves all InfoPath form templates (.xsn files) and universal data connections (.udcx files) located on the SharePoint Central Administration Web site in a compressed cabinet file named file.cab. - -## PARAMETERS - -### -Path -Specifies the location and name of the output .cab file. - -The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfsfiles.cab. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the site collection that contains the InfoPath form template and Central Administration .udcx files to export. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPFormsServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPMetadataWebServicePartitionData.md deleted file mode 100644 index 0eb1fe0814..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPMetadataWebServicePartitionData.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPMetadataWebServicePartitionData -schema: 2.0.0 ---- - -# Export-SPMetadataWebServicePartitionData - -## SYNOPSIS -Exports the data from a metadata Web service for a site subscription. - -## SYNTAX - -``` -Export-SPMetadataWebServicePartitionData [-Identity] <SPSiteSubscriptionPipeBind> - [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> -Path <String> - [-AssignmentCollection <SPAssignmentCollection>] [-NoCompression] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Export-SPMetadataWebServicePartitionData cmdlet to export the data from a metadata Web service that is associated with the specified site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE-------------- -``` -PS C:\>Export-SPMetadataWebServicePartitionData -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -Path "\\server_name\folder_name\file_name.cab" -``` - -This example creates a backup of data for a specific site subscription on a Metadata Service application. - -## PARAMETERS - -### -Identity -Specifies the site subscription to export. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceProxy -Specifies the service proxy for the service application that contains the site subscription. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path and file name for the file to create from the exported data. - -The type must be a valid path in either of the following forms: - -- C:\folder_name\subscription_export -- \\\\server_name\folder_name\file_name.cab - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoCompression -{{Fill NoCompression Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPPerformancePointContent.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPPerformancePointContent.md deleted file mode 100644 index 4072403233..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPPerformancePointContent.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPPerformancePointContent -schema: 2.0.0 ---- - -# Export-SPPerformancePointContent - -## SYNOPSIS -Exports a Performance Point Server (PPS) dashboard. - -## SYNTAX - -``` -Export-SPPerformancePointContent [-AssignmentCollection <SPAssignmentCollection>] -ExportFileUrl <String> - -ItemUrls <Array> [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPPerformancePointContent exports a PPS dashboard and its dependencies from a CMP file that can then be used to import to another server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Export-SPPerformancePointContent -ItemUrls http://contoso/sites/marketing/default.aspx -ExportFileURL "http://contoso/bicenter/SharedDocuments/bi/dashboard1.cmp" -``` - -This example exports a dashboard at the location specified with the ItemUrls parameter. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExportFileUrl -Output name and path of the CMP file to which the data will be stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemUrls -The URL to the dashboard to be migrated or to the additional content URLs. - -```yaml -Type: Array -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPScaleOutDatabaseTenantData.md deleted file mode 100644 index 4f8f779190..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPScaleOutDatabaseTenantData.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPScaleOutDatabaseTenantData -schema: 2.0.0 ---- - -# Export-SPScaleOutDatabaseTenantData - -## SYNOPSIS - -Exports the data of the specified subscription. - - - -## SYNTAX - -``` -Export-SPScaleOutDatabaseTenantData -FilePath <String> -ServiceApplication <SPServiceApplicationPipeBind> - -SiteSubscriptionId <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Export-SPScaleOutDatabaseTenantData cmdlet to export the data of the specified subscription id to the specified file from the specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE------- -``` -PS C:\>Export-SPScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" -``` - -This example exports data for the site subscription with id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904 to the file at C:\ TenantData.dat, from the specified service application. - -## PARAMETERS - -### -FilePath -Specifies the output path for the file to export the data to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the service application to export the data from. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId -Specifies the site subscription id of the site subscription to export the data from. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrites an existing data file without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-SPScaleOutDatabaseTenantData](Clear-SPScaleOutDatabaseTenantData.md) - -[Import-SPScaleOutDatabaseTenantData](Import-SPScaleOutDatabaseTenantData.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPServerScaleOutDatabaseTenantData.md deleted file mode 100644 index 2d5092b88a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPServerScaleOutDatabaseTenantData.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPServerScaleOutDatabaseTenantData -schema: 2.0.0 ---- - -# Export-SPServerScaleOutDatabaseTenantData - -## SYNOPSIS - -Exports the data of the specified subscription. - -## SYNTAX - -``` -Export-SPServerScaleOutDatabaseTenantData [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -FilePath <String> [-Force] -ServiceApplication <SPServiceApplicationPipeBind> -SiteSubscriptionId <Guid> - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Export-SPServerScaleOutDatabaseTenantData cmdlet to export the data of the specified subscription id to the specified file from the specified service application. - - -## EXAMPLES - -### ----------EXAMPLE------- -``` -PS C:\>Export-SPServerScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" -``` - -This example exports data for the site subscription with id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904 to the file at C:\ TenantData.dat, from the specified service application. - -## PARAMETERS - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -{{Fill FilePath Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -{{Fill ServiceApplication Description}} - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId -{{Fill SiteSubscriptionId Description}} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Clear-SPServerScaleOutDatabaseTenantData](Clear-SPServerScaleOutDatabaseTenantData.md) - -[Import-SPServerScaleOutDatabaseTenantData](Import-SPServerScaleOutDatabaseTenantData.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md deleted file mode 100644 index 143f1f9cd2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPSiteSubscriptionBusinessDataCatalogConfig -schema: 2.0.0 ---- - -# Export-SPSiteSubscriptionBusinessDataCatalogConfig - -## SYNOPSIS - -Exports all data from the Business Data Connectivity Metadata Store associated with a partition. - - - -## SYNTAX - -``` -Export-SPSiteSubscriptionBusinessDataCatalogConfig -Path <String> -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-LocalizedNamesIncluded] - [-ModelsIncluded] [-PermissionsIncluded] [-PropertiesIncluded] [-ProxiesIncluded] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The SPSiteSubscriptionBusinessDataCatalogConfig cmdlet exports all data from the Business Data Connectivity Metadata Store associated with a specified partition. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Export-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso -Path "C:\folder\exportedFile.xml" -``` - -This example exports the data file named exportedFile.xml. - -## PARAMETERS - -### -Path -Specifies the path and name to use to create the export file. - -The type must be a valid path in either of the following forms: - -- C:\folder_name\file.xml -- \\\\server_name\folder_name\file.xml -- …\folder_name\file.xml - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context of the data to be exported. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrites the output file if the file exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalizedNamesIncluded -Specifies that names for business data fields in multiple languages are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModelsIncluded -Specifies that Business Data Connectivity models are included in the exported file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsIncluded -Specifies that permissions from the Business Data Connectivity Models are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertiesIncluded -Specifies that properties from the Business Data Connectivity Models are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxiesIncluded -Specifies that proxies for Business Data Connectivity Service applications are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPSiteSubscriptionSettings.md deleted file mode 100644 index e6329a4e90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPSiteSubscriptionSettings.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPSiteSubscriptionSettings -schema: 2.0.0 ---- - -# Export-SPSiteSubscriptionSettings - -## SYNOPSIS - -Creates a backup file of site subscription data. - - - -## SYNTAX - -``` -Export-SPSiteSubscriptionSettings [-Identity] <SPSiteSubscriptionPipeBind> -Path <String> [-AdminProperties] - [-AssignmentCollection <SPAssignmentCollection>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPSiteSubscriptionSettings cmdlet generates a backup file of all settings in the subscription data store for the given site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Export-SPSiteSubscriptionSettings -Identity "http://sitecollection/" -Path "C:\siteCollection_sitesubscriptionsettings.txt" -``` - -The example backs up the subscription settings store of http://siteCollection. - - -### --------------EXAMPLE 2----------------- -``` -C:\PS>$site = Get-SPSite http://siteCollection -PS C:\>Export-SPSiteSubscriptionSettings -Identity $site.SiteSubscription -Path "C:\siteCollection_sitesubscriptionsettings.txt" -``` - -The example backs up the subscription settings store of http://siteCollection using the Site Subscription object. - -## PARAMETERS - -### -Identity -Specifies the ID of the site subscription from which to back up data. - -The type must be a valid URL, in the form http://server_name or a Site Subscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the location of the output file. - -The type must be a valid path; for example, C:/backupfile.back.. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminProperties -Specifies that only administrator subscription properties are exported. -If this parameter is not set, only non-administrator subscription properties are exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Forces the output backup file (if provided) to overwrite any existing file at the given path. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPTagsAndNotesData.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPTagsAndNotesData.md deleted file mode 100644 index 963082b341..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPTagsAndNotesData.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPTagsAndNotesData -schema: 2.0.0 ---- - -# Export-SPTagsAndNotesData - -## SYNOPSIS -Exports the SharePoint Newsfeed tags and notes from the SharePoint database to a ZIP file. - -## SYNTAX - -``` -Export-SPTagsAndNotesData [-Site] <SPSitePipeBind> [-FilePath] <String> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPTagsAndNotesData cmdlet exports the SharePoint Newsfeed tags and notes from the SharePoint database. -The tags and notes are written into separate files, and then the two are compressed and added to the ZIP file you specify. - -## EXAMPLES - -### ----------------EXAMPLE----------------- -``` -Export-SPTagsAndNotesData -Site http://site.contoso.com -FilePath C:\TagsAndNotes.zip -``` - -This example creates a new ZIP file called TagsAndNotes.zip, on the root of C: drive, exports tags and notes from the SharePoint database for the site http://site.contoso.com, and adds the resulting files to the TagsAndNotes.zip file - -## PARAMETERS - -### -Site -URL of the root site where you want to export the tags and notes from. - -You must specify a valid URL to an existing SharePoint root site. -For example: http://site.contoso.com - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FilePath -File name, including full path, that you want export the tags and notes to. - -The cmdlet will create a new ZIP file with the name you specified. -If the file already exists, the cmdlet won't perform the export and will ask you to specify a new file name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Export-SPWeb.md deleted file mode 100644 index 3b6904ca56..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Export-SPWeb.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Export-SPWeb -schema: 2.0.0 ---- - -# Export-SPWeb - -## SYNOPSIS - -Exports a site, list, or library. - - - -## SYNTAX - -``` -Export-SPWeb [-Identity] <SPWebPipeBind> -Path <String> [-AppLogFilePath <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-CompressionSize <Int32>] [-Confirm] [-Force] [-HaltOnError] - [-HaltOnWarning] [-IncludeUserSecurity] [-IncludeVersions <SPIncludeVersions>] [-ItemUrl <String>] - [-NoFileCompression] [-NoLogFile] [-UseSqlSnapshot] [-WhatIf] [-IncludeAlerts] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-SPWeb cmdlet exports a site, list, or library. -The capability to export from a library is a new feature in SharePoint. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE-----------------------. -``` -PS C:\>Export-SPWeb http://site -Path "site export.cmp" -``` - -This example exports the site at http://site/ to a file called site export.cmp in the current directory. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the Web to be exported. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint site (for example, MySPSite1); or an instance of a valid SPWeb object. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the name of the export file. - -If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppLogFilePath -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompressionSize -Sets the maximum file size for the compressed export files. -If the total size of the exported package is greater than this size, the exported package will be split into multiple files. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forcefully overwrites the export package if it already exists. - -The type must be either of the following values: - --True - --False - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HaltOnError -Stops the export process when an error occurs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HaltOnWarning -Stops the export process when a warning occurs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUserSecurity - -Preserves the user security settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeVersions -Indicates the type of file and list item version history to be included in the export operation. -If the IncludeVersions parameter is absent, the Export-SPWeb cmdlet by default uses a value of 1. - -The type must be any one of the following versions: - --Last major version for files and list items (default) - --The current version, either the last major version or the last minor version - --Last major and last minor version for files and list items - --All versions for files and list items - -Valid values are: - -All, CurrentVersion, LastMajor, LastMajorAndMinor - -```yaml -Type: SPIncludeVersions -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemUrl -Specifies the URL of the Web application, GUID, or object to be exported. - -The type must be a valid URL; for example, http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoFileCompression -Either enables or disables file compression in the export package. -The export package is stored in the folder specified by the Path parameter or Identity parameter. -We recommend that you use this parameter for performance reasons. -If compression is enabled, the export process can increase by approximately 30 percent. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Suppresses the generation of an export log file. -If this parameter is not specified, the Export-SPWeb cmdlet will generate an export log file in the same location as the export package. -The log file uses Unified Logging Service (ULS). - -It is recommended to use this parameter. -However, for performance reasons, you might not want to generate a log file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSqlSnapshot -Specifies a SQL Database Snapshot will be created when the export process begins, and all exported data will be retrieved directly from the database snapshot. -This snapshot will be automatically deleted when export completes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAlerts -Indicates if alerts are turned on. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-AvailabilityGroupStatus.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-AvailabilityGroupStatus.md deleted file mode 100644 index 83832c35f3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-AvailabilityGroupStatus.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-AvailabilityGroupStatus -schema: 2.0.0 ---- - -# Get-AvailabilityGroupStatus - -## SYNOPSIS -Returns one or more objects representing the availability groups known to the SharePoint farm. - -## SYNTAX - -``` -Get-AvailabilityGroupStatus [-AssignmentCollection <SPAssignmentCollection>] [-Identity <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -Returns one or more objects representing the availability groups known to the SharePoint farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-AvailabilityGroupStatus -Identity MyAvailabilityGroup - -``` - -This example returns an availability group named "MyAvailabilityGroup". - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Finds the availability group whose name property matches this string. Otherwise, returns all availability groups. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchContentCollection.md deleted file mode 100644 index fd202bb407..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchContentCollection.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchContentCollection ---- - -# Get-FASTSearchContentCollection - -## SYNOPSIS -Retrieves Microsoft FAST Search Server 2010 for SharePoint content collections. - -## SYNTAX - -``` -Get-FASTSearchContentCollection [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves all FAST Search Server 2010 for SharePoint content collections. -When a collection name is specified, a single collection is retrieved, if it exists. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchContentCollection -``` - -This example retrieves all FAST Search Server 2010 for SharePoint content collections. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchContentCollection -Name newscollection -``` - -This example retrieves the "newscollection" content collection. - -## PARAMETERS - -### -Name -The name of the FAST Search Server 2010 for SharePoint collection to retrieve. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-FASTSearchContentCollection](Clear-FASTSearchContentCollection.md) - -[New-FASTSearchContentCollection](New-FASTSearchContentCollection.md) - -[Remove-FASTSearchContentCollection](Remove-FASTSearchContentCollection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchDocumentProcessingPipeline.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchDocumentProcessingPipeline.md deleted file mode 100644 index a563c45c99..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchDocumentProcessingPipeline.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchDocumentProcessingPipeline ---- - -# Get-FASTSearchDocumentProcessingPipeline - -## SYNOPSIS -Retrieves FAST Search Server 2010 for SharePoint document processing pipelines. - -## SYNTAX - -``` -Get-FASTSearchDocumentProcessingPipeline [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -A document processing pipeline consists of multiple processing stages that an item goes through before being indexed for searching. -Item processing includes adding/removing/modifying metadata, linguistic processing, language detection. -This cmdlet retrieves all FAST Search Server 2010 for SharePoint document processing pipelines. -When one pipeline name is specified, a single pipeline is retrieved if it exists. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchDocumentProcessingPipeline -``` - -This example retrieves all FAST Search Server 2010 for SharePoint document processing pipelines. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchDocumentProcessingPipeline -Name "Office14 (webcluster)" -``` - -This example retrieves a single FAST Search Server 2010 for SharePoint document processing pipeline named "Office14 (webcluster)". - -## PARAMETERS - -### -Name -The name of the document processing pipeline to retrieve. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCategory.md deleted file mode 100644 index eaa23d9f8b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCategory.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataCategory ---- - -# Get-FASTSearchMetadataCategory - -## SYNOPSIS -Retrieves a crawled property category. - -## SYNTAX - -``` -Get-FASTSearchMetadataCategory [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a category object from the installation. -If no name is specified, it retrieves all categories in the system. - -A category contains several crawled properties that are grouped together for setting properties that are common to them all. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchMetadataCategory -``` - -This example returns all available categories. -This is the default behavior if you do not specify any parameters. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchMetadataCategory -Name SharePoint -``` - -This example returns one specific category, the "SharePoint" category. - -### ---------------EXAMPLE 3----------------- -``` -PS C:\>Get-FASTSearchMetadataCategory -Name m* -``` - -This example returns all categories with a name that begins with "m". -Matching is case-insensitive. - -### ---------------EXAMPLE 4----------------- -``` -PS C:\>$category = Get-FASTSearchMetadataCategory -Name "Enterprise Crawler" -PS C:\>$category.GetAllCrawledProperties()|ForEach-Object {$_.Name} -``` - -This example returns all crawled properties that are mapped to the category named "Enterprise Crawler". -The example first retrieves the category, and then calls the category's GetAllCrawledProperties() function to list its crawled properties. -It then iterates over the list of crawled properties and selects the name of each crawled property. - -## PARAMETERS - -### -Name -The name of the category to retrieve. -If no category is specified, all categories are returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CategoryName, N -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchMetadataCategory](Remove-FASTSearchMetadataCategory.md) - -[Set-FASTSearchMetadataCategory](Set-FASTSearchMetadataCategory.md) - -[New-FASTSearchMetadataCategory](New-FASTSearchMetadataCategory.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCrawledProperty.md deleted file mode 100644 index c39a17bff7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCrawledProperty.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataCrawledProperty ---- - -# Get-FASTSearchMetadataCrawledProperty - -## SYNOPSIS -Retrieves a crawled property from Microsoft FAST Search Server 2010 for SharePoint. - -## SYNTAX - -``` -Get-FASTSearchMetadataCrawledProperty [[-Name] <String>] [-Count <Int32>] [-Filter <String>] [-Offset <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a crawled property from the FAST Search Server 2010 for SharePoint system. -If the cmdlet is called without any parameters, it returns all crawled properties in the system. -The order of the returned crawled property list is fixed, and multiple calls return the same ordered list as long as no new crawled properties have been added. - -Get-FASTSearchMetadataCrawledProperty supports several ways of looking up properties. -Run with a single parameter or with a named parameter (using Name), the cmdlet retrieves crawled properties with that exact name, if any exist. -The Name parameter supports wildcards. -Alternatively, a filter can be specified (using the Filter parameter) to search the crawled properties and to return any crawled property with a name that includes the filter value. -The filter option does not support wildcards. - -Retrieving crawled properties with the Filter parameter is much more efficient than using the Name parameter. - -To paginate a set of results from this cmdlet, use an Offset and Count to control the number of returned results. - -Offset and Count are calculated before either filter or named matching is done. -This means that if a crawled property falls outside the \[Offset,Offset+Count\] range, it will not be returned. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchMetadataCrawledProperty -``` - -Calling Get-FASTSearchMetadataCrawledProperty without any parameters returns all known crawled properties in the FAST Search Server 2010 for SharePoint system. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchMetadataCrawledProperty -Name viewurl -``` - -This example retrieves a crawled property with the exact name "viewurl". - -### ---------------EXAMPLE 3----------------- -``` -PS C:\>Get-FASTSearchMetadataCrawledProperty -filter 4 -``` - -This example retrieves and returns any crawled property that includes a "4" in its name. - -### ---------------EXAMPLE 4----------------- -``` -PS C:\>Get-FASTSearchMetadataCrawledproperty -filter url -count 2 -``` - -This example retrieves the first two crawled properties with the name "url". - -### ---------------EXAMPLE 5----------------- -``` -PS C:\>Get-FASTSearchMetadataCrawledproperty |ForEach-Object{ if ($_.IsMappedToContents) {$_.Name} } -``` - -This example returns the names of all crawled properties that have the IsMappedToContents parameter set to "true". -The example first retrieves all configured crawled properties, and then iterates over them to find those with IsMappedToContents set to "true" - -### ---------------EXAMPLE 6----------------- -``` -PS C:\>Get-FASTSearchMetadataCrawledproperty -offset 0 -count 2 -PS C:\>Get-FASTSearchMetadataCrawledproperty -offset 2 -count 2 -PS C:\>Get-FASTSearchMetadataCrawledproperty -offset 4 -count 2 -``` - -This example generates a list of two crawled properties each time the cmdlet is run. -The Offset is increased by the Count value to start returning crawled properties where the last run ended. - -### ---------------EXAMPLE 7----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchMetadataCrawledProperty -filter url| where-object {($_.Name -eq "url") -and ($_.VariantType -eq 31) -and ($_.Propset -eq "63e90878-0292-490d-8b7c-f3905a8b65fd")} -``` - -This example lists all potential matches to a named crawled property, and then selects the exact crawled property by iterating over the result set and picking out the result that also matches both the requested property set and variant type. -The command returns the "url" crawled property in the "Enterprise Crawler" category. - -## PARAMETERS - -### -Name -The name of crawled property to retrieve. - -The Name parameter supports wildcards. -Combine the Name parameter with the Offset and Count parameters to control the range that is searched. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Count -The maximum number of crawled properties to return (starting from the first returned crawled property, or from the index given by the Offset parameter). - -If the Filter or Name parameter is specified, these will only be applied after the result set has been narrowed down to the range \[Offset, Offset + Count\]. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The term used to search for configured crawled properties. - -The Filter parameter does not support wildcards. -Matching is case-insensitive, and matches a string anywhere within the name attribute of the crawled property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Offset -The offset in the result set from which to start returning results. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataCrawledProperty](New-FASTSearchMetadataCrawledProperty.md) - -[Set-FASTSearchMetadataCrawledProperty](Set-FASTSearchMetadataCrawledProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCrawledPropertyMapping.md deleted file mode 100644 index 0aed9d2864..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataCrawledPropertyMapping.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataCrawledPropertyMapping ---- - -# Get-FASTSearchMetadataCrawledPropertyMapping - -## SYNOPSIS -Retrieves a list of crawled properties mapped to a managed property. - -## SYNTAX - -### Name -``` -Get-FASTSearchMetadataCrawledPropertyMapping [-Name] <String> [<CommonParameters>] -``` - -### ManagedProperty -``` -Get-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty <ManagedProperty> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a list of the crawled properties that are mapped to a managed property. -The managed property can be specified with the Name parameter or by a ManagedPropertyImpl object as returned by Get-FASTSearchMetadataManagedProperty (using the ManagedProperty parameter). - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -C:\PS>Get-FASTSearchMetadataCrawledPropertyMapping -Name title -``` - -This example returns a list of crawled properties that are mapped to the managed property named "title". - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>$managedproperty = Get-FASTSearchMetadataManagedProperty -name title -PS C:\>Get-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty $managedproperty -``` - -This example first retrieves a ManagedPropertyImpl object, and then uses it to look up the corresponding crawled property mappings. -It returns all crawled properties that are set up to map content into this managed property. - -### ---------------EXAMPLE 3----------------- -``` -PS C:\>$crawledproperty = Get-FASTSearchmetadataCrawledProperty -name title -PS C:\>$crawledproperty.GetMappedManagedProperties() -``` - -These commands are the opposite of Get-FASTSearchMetdataCrawledPropertyMapping; they find all managed properties that have a mapping for a specific crawled property. -This is useful when assessing how modifying a crawled property will impact the search index. - -## PARAMETERS - -### -Name -The name of a managed property for finding crawled properties. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ManagedProperty -The managed property object for finding crawled properties. - -```yaml -Type: ManagedProperty -Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataCrawledPropertyMapping](New-FASTSearchMetadataCrawledPropertyMapping.md) - -[Remove-FASTSearchMetadataCrawledPropertyMapping](Remove-FASTSearchMetadataCrawledPropertyMapping.md) - -[Set-FASTSearchMetadataCrawledPropertyMapping](Set-FASTSearchMetadataCrawledPropertyMapping.md) - -[Get-FASTSearchMetadataCrawledProperty](Get-FASTSearchMetadataCrawledProperty.md) - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataFullTextIndex.md deleted file mode 100644 index 20e1d36da9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataFullTextIndex.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataFullTextIndex ---- - -# Get-FASTSearchMetadataFullTextIndex - -## SYNOPSIS -Retrieves a full text index. - -## SYNTAX - -``` -Get-FASTSearchMetadataFullTextIndex [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a full text index object. -The full text indexes are the searchable content of a Microsoft FAST Search Server 2010 for SharePoint system. -Although it is also possible to search on a specific managed property without using a full text index, full relevancy calculation is only done when searching in full text indexes. - -If no name is specified, all full text indexes are retrieved. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchMetadataFullTextIndex -Name content -``` - -This example retrieves the full text index named "content". - -## PARAMETERS - -### -Name -The name of the full text index to retrieve. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: FullTextIndexName, N -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataFullTextIndex](New-FASTSearchMetadataFullTextIndex.md) - -[Remove-FASTSearchMetadataFullTextIndex](Remove-FASTSearchMetadataFullTextIndex.md) - -[Set-FASTSearchMetadataFullTextIndex](Set-FASTSearchMetadataFullTextIndex.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataFullTextIndexMapping.md deleted file mode 100644 index 96047aaaf9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataFullTextIndexMapping.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataFullTextIndexMapping ---- - -# Get-FASTSearchMetadataFullTextIndexMapping - -## SYNOPSIS -Retrieves mappings between managed properties and the full text indexes. - -## SYNTAX - -``` -Get-FASTSearchMetadataFullTextIndexMapping [-FullTextIndex <FullTextIndex>] - [-ManagedProperty <ManagedProperty>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves mappings from managed properties to full text indexes. -These mappings control which managed properties are included in each full text index. - -Running Get-FASTSearchMetadataFullTextIndexMapping with only a managed property as a parameter (the ManagedProperty parameter) returns all mappings to full text indexes in which the managed property is included. - -Running Get-FASTSearchMetadataFullTextIndexMapping with only a full text index as a parameter (the FullTextIndex parameter) returns all mappings from managed properties that are included in the full text index - -Running Get-FASTSearchMetadataFullTextIndexMapping with both the ManagedProperty and the FullTextIndex parameters returns a single FullTextIndexMappingImpl object for that exact mapping, if it exists in the Microsoft FAST Search Server 2010 for SharePoint system. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>$fulltextindex = Get-FASTSearchMetadataFullTextIndex -name content -PS C:\>Get-FASTSearchMetadataFullTextIndexMapping -fulltextindex $fulltextindex| ForEach-Object {$_.ManagedProperty.Name} -``` - -This example retrieves the full text index mappings for the full text index "content". -It then iterates over the mappings and outputs the names of the managed properties included in the full text index. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>$title = Get-FASTSearchMetadataManagedProperty -name title -PS C:\>Get-FASTSearchMetadataFullTextIndexMapping -managedproperty $title -``` - -This example retrieves all full text indexes where the managed property named "title" is included. - -The specified managed property is mapped to both "content" and "thirdfulltextindex", showing that there is no limit to how many full text indexes a managed property can be part of. - -## PARAMETERS - -### -FullTextIndex -The full text index specified to retrieve mappings. - -```yaml -Type: FullTextIndex -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ManagedProperty -The managed property specified to retrieve mappings. - -```yaml -Type: ManagedProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataFullTextIndexMapping](New-FASTSearchMetadataFullTextIndexMapping.md) - -[Remove-FASTSearchMetadataFullTextIndexMapping](Remove-FASTSearchMetadataFullTextIndexMapping.md) - -[Set-FASTSearchMetadataFullTextIndexMapping](Set-FASTSearchMetadataFullTextIndexMapping.md) - -[Get-FASTSearchMetadataFullTextIndex](Get-FASTSearchMetadataFullTextIndex.md) - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataManagedProperty.md deleted file mode 100644 index edb1c733b2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataManagedProperty.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataManagedProperty ---- - -# Get-FASTSearchMetadataManagedProperty - -## SYNOPSIS -Retrieves a managed property with the specified name. - -## SYNTAX - -``` -Get-FASTSearchMetadataManagedProperty [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This command retrieves managed properties that match the input parameter. -If wildcards are used, the command may return more than one managed property. - -A managed property is a piece of information (such as title, author, etc.) that is stored for each item in the index. - -See Set-FASTSearchMetadataManagedProperty for details about the managed property parameters and how to configure them. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchMetadataManagedProperty -name title -``` - -This example retrieves a managed property named "title". -It returns an object representing the managed property. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchMetadataManagedProperty -name content* -``` - -This example returns all managed properties with names starting with "content". -It returns a list of managed property objects. - -## PARAMETERS - -### -Name -The name of the managed property to retrieve. -This option supports wildcards, and the matching is case-insensitive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataManagedProperty](New-FASTSearchMetadataManagedProperty.md) - -[Set-FASTSearchMetadataManagedProperty](Set-FASTSearchMetadataManagedProperty.md) - -[Remove-FASTSearchMetadataManagedProperty](Remove-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataRankProfile.md deleted file mode 100644 index 6996b4e1f2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchMetadataRankProfile.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchMetadataRankProfile ---- - -# Get-FASTSearchMetadataRankProfile - -## SYNOPSIS -Retrieves rank profiles from the Microsoft FAST Search Server 2010 for SharePoint system. - -## SYNTAX - -``` -Get-FASTSearchMetadataRankProfile [[-Name] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves rank profiles which match the Name parameter. -A rank profile is a weighting scheme for calculating relevance, specifying how each relevance component should be weighted when calculating an item's relevance. - -See Set-FASTSearchMetadataRankProfile for details about rank profile parameters. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchMetadataRankProfile -Name newdefault -``` - -This example retrieves the rank profile named "newdefault". - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchMetadataRankProfile -Name *?default -``` - -This example retrieves all rank profiles that match the pattern "*?default". -It will not match the default rankprofile named "default". - -## PARAMETERS - -### -Name -The name of the rank profile to retrieve. -This option supports wildcards, and matching is case-insensitive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataRankProfile](New-FASTSearchMetadataRankProfile.md) - -[Remove-FASTSearchMetadataRankProfile](Remove-FASTSearchMetadataRankProfile.md) - -[Set-FASTSearchMetadataRankProfile](Set-FASTSearchMetadataRankProfile.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchResource.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchResource.md deleted file mode 100644 index 570b34c2bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchResource.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchResource ---- - -# Get-FASTSearchResource - -## SYNOPSIS -Downloads a resource from the resource store. - -## SYNTAX - -``` -Get-FASTSearchResource [-Path] <String> [-FilePath] <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet downloads a specified file located in the Microsoft FAST Search Server 2010 for SharePoint resource store to the local environment. -The location of the resource store is typically specified in %FASTSEARCH%/etc/Admin.config (where %FASTSEARCH% is the FAST Search Server 2010 for SharePoint installation folder.) - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchResource dictionaries\spellcheck\check_en.aut c:\check_en.aut -``` - -This example downloads dictionaries\spellcheck\check_en.aut from the resource store to c:\check_en.aut. - -## PARAMETERS - -### -Path -Partial URI within the resource store where the file needs to be downloaded from. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceURI -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -Path to download the resource. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchResource](Remove-FASTSearchResource.md) - -[Add-FASTSearchResource](Add-FASTSearchResource.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSearchSettingGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSearchSettingGroup.md deleted file mode 100644 index bade3edd27..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSearchSettingGroup.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSearchSettingGroup ---- - -# Get-FASTSearchSearchSettingGroup - -## SYNOPSIS -Retrieves Microsoft FAST Search Server 2010 for SharePoint search setting groups. - -## SYNTAX - -``` -Get-FASTSearchSearchSettingGroup [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves one or all FAST Search Server 2010 for SharePoint search setting groups. -When a group name is specified, a single group is retrieved, if it exists. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSearchSettingGroup -``` - -This example retrieves all FAST Search Server 2010 for SharePoint search setting groups. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSearchSettingGroup -Name marketinggroup -``` - -This example retrieves the "marketinggroup" search setting group. - -## PARAMETERS - -### -Name -The name of the search setting group to retrieve. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSearchSettingGroup](New-FASTSearchSearchSettingGroup.md) - -[Remove-FASTSearchSearchSettingGroup](Remove-FASTSearchSearchSettingGroup.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityAliaser.md deleted file mode 100644 index bbb607ff69..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityAliaser.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityAliaser ---- - -# Get-FASTSearchSecurityAliaser - -## SYNOPSIS -Gets a security principal aliaser. - -## SYNTAX - -``` -Get-FASTSearchSecurityAliaser [[-Identity] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets a regular expression or XML principal aliaser. -If the Identity parameter is not specified, it gets a list of all aliasers. - -A principal aliaser maps users from one user store into users in other user stores. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityAliaser -``` - -This example gets a list of all XML and regular expression principal aliasers. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityAliaser -Identity xmlalias4 -``` - -This example gets the principal aliaser with the ID "xmlalias4". - -## PARAMETERS - -### -Identity -The identity of a regular expression or XML aliaser to get. - -If not specified, the cmdlet gets a list of all aliasers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchSecurityAliaser](Remove-FASTSearchSecurityAliaser.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityCCTKServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityCCTKServer.md deleted file mode 100644 index dd557645ac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityCCTKServer.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityCCTKServer ---- - -# Get-FASTSearchSecurityCCTKServer - -## SYNOPSIS -Gets the CCTK server general setting. - -## SYNTAX - -``` -Get-FASTSearchSecurityCCTKServer [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets the configuration setting for the server that handles CCTK requests. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityCCTKServer -``` - -This example retrieves the configuration setting for the server that handles CCTK requests. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityCCTKServer](Set-FASTSearchSecurityCCTKServer.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityClaimsUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityClaimsUserStore.md deleted file mode 100644 index 045d5caa1d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityClaimsUserStore.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityClaimsUserStore ---- - -# Get-FASTSearchSecurityClaimsUserStore - -## SYNOPSIS -Get the claims security user store. - -## SYNTAX - -``` -Get-FASTSearchSecurityClaimsUserStore [[-Identity] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a specific claims user store. - -If the Identity parameter is not specified, the cmdlet gets a list of all claims user stores. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityClaimsUserStore -Identity clm -``` - -This example retrieves the claims user store with the identity "clm". - -## PARAMETERS - -### -Identity -The identity of a claims user store to display. - -If an Identity is not specified, all claims user stores are displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityClaimsUserStore](Set-FASTSearchSecurityClaimsUserStore.md) - -[New-FASTSearchSecurityClaimsUserStore](New-FASTSearchSecurityClaimsUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityCompleteGroupExpansion.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityCompleteGroupExpansion.md deleted file mode 100644 index 90b0e1a828..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityCompleteGroupExpansion.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityCompleteGroupExpansion ---- - -# Get-FASTSearchSecurityCompleteGroupExpansion - -## SYNOPSIS -Gets complete group expansion information for a user. - -## SYNTAX - -``` -Get-FASTSearchSecurityCompleteGroupExpansion [-Identity] <String> [-User] <String> [-ExtraProperties] - [[-XmlFile] <String>] [[-Worker] <WorkerPoolNode>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets troubleshooting information for group expansions and aliaser processing performed to create the user search security filter. - -The group expansion information contains the user, expanded groups that contain the user (i.e., the user is a member of the group), and all groups that contain other expanded groups. - -The aliaser procession information contains all mapped to users and groups based on the regular expression and XML aliaser mapping definitions. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityCompleteGroupExpansion -Identity ln1 -User user1 -``` - -This example retrieves complete group expansion information for "user1" in the user store "ln1", showing all equivalent users and groups in all user stores, by finding all parents and processing all aliaser mappings. - -## PARAMETERS - -### -Identity -The identity of the user store containing the user to expand. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -User -The user or group identifier to expand. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtraProperties -If specified, the command gets the extra properties for all principals (user and groups) returned by the resolve. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -XmlFile -The absolute path to an XML file which is accessible and writable from the security manager. -If specified, complete expansion information is written as XML to this file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityDecodedSid.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityDecodedSid.md deleted file mode 100644 index ff86d42180..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityDecodedSid.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityDecodedSid ---- - -# Get-FASTSearchSecurityDecodedSid - -## SYNOPSIS -Gets the user identifier and SID from the encoded security identifier. - -## SYNTAX - -``` -Get-FASTSearchSecurityDecodedSid [-EncodedSID] <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet decodes an encoded security identifier (SID) and returns the user/group identifier (the common name) and Windows SID. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityDecodedSid -EncodedSID aebaaaaaaaaakiaaaaaccaqaaa -``` - -This example retrieves the Windows SID and user or group identifier for an encoded security identifier. - -## PARAMETERS - -### -EncodedSID -The encoded extended security identifier that will be decoded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityEncodedSid](Get-FASTSearchSecurityEncodedSid.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityDefaultUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityDefaultUserStore.md deleted file mode 100644 index aa35271b62..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityDefaultUserStore.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityDefaultUserStore ---- - -# Get-FASTSearchSecurityDefaultUserStore - -## SYNOPSIS -Gets the default user store general setting. - -## SYNTAX - -``` -Get-FASTSearchSecurityDefaultUserStore [[-Worker] <WorkerPoolNode>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets the identity of the default user store that users and groups are looked up in. -The purpose of the command is to determine the user's or group's document access if the user store identity is not specified when looking up the user or group. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityDefaultUserStore -``` - -This example gets the identity of the default user store. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityWorkerNode workerserver | Get-FASTSearchSecurityDefaultUserStore -``` - -This example gets the default user store's general setting information for the security worker with a server name of "workerserver". - -## PARAMETERS - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityDefaultUserStore](Set-FASTSearchSecurityDefaultUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityEncodedSid.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityEncodedSid.md deleted file mode 100644 index 71041abc14..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityEncodedSid.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityEncodedSid ---- - -# Get-FASTSearchSecurityEncodedSid - -## SYNOPSIS -Gets the encoded extended security identifier. - -## SYNTAX - -``` -Get-FASTSearchSecurityEncodedSid [[-SID] <String>] [[-User] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns a Base64 encoded security identifier for a user, group, or Windows SID (Windows security identifier). - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityEncodedSid -SID S-1-5-7 -``` - -This example returns an encoded security identifier and user name for the Windows SID, "5-1-5-7". - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityEncodedSid -User users -``` - -This example returns the encoded security identifier for the Windows built-in "Users" group. - -## PARAMETERS - -### -SID -The Windows security identifier to encode. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -The user or group identifier to encode. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityDecodedSid](Get-FASTSearchSecurityDecodedSid.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityGeneralSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityGeneralSettings.md deleted file mode 100644 index ef3fa8ee68..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityGeneralSettings.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityGeneralSettings ---- - -# Get-FASTSearchSecurityGeneralSettings - -## SYNOPSIS -Gets the security general settings. - -## SYNTAX - -``` -Get-FASTSearchSecurityGeneralSettings [[-Worker] <WorkerPoolNode>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves configuration information for general security settings, such as: - --- Default user store ID - --- CCTK server port number - --- CCTK server enabled - --- Default log level - --- Log level namespaces - --- Public Filter FQL - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityGeneralSettings | fl -``` - -This example retrieves the configuration setting for all the general security settings and formats the information as a list. - -## PARAMETERS - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityLogLevel.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityLogLevel.md deleted file mode 100644 index ccf14849fd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityLogLevel.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityLogLevel ---- - -# Get-FASTSearchSecurityLogLevel - -## SYNOPSIS -Gets the log level general setting. - -## SYNTAX - -``` -Get-FASTSearchSecurityLogLevel [[-Worker] <WorkerPoolNode>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the configuration information for the log level general setting. -The log level controls the type of information that is logged by the security system. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityLogLevel -``` - -This example gets the configuration information for the log level's general setting, specifying the data logged by the security system. - -## PARAMETERS - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityLogLevel](Set-FASTSearchSecurityLogLevel.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityLotusNotesUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityLotusNotesUserStore.md deleted file mode 100644 index 0c042910a2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityLotusNotesUserStore.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityLotusNotesUserStore ---- - -# Get-FASTSearchSecurityLotusNotesUserStore - -## SYNOPSIS -Gets a Lotus Notes user store. - -## SYNTAX - -``` -Get-FASTSearchSecurityLotusNotesUserStore [[-Identity] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a specific Lotus Notes user store. -If the Identity parameter is not specified, the cmdlet gets a list of all Lotus Notes user stores. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityLotusNotesUserStore -Identity ln1 -``` - -This example gets the Lotus Notes user store with the identity "ln1". - -## PARAMETERS - -### -Identity -The identity of the Lotus Notes user store to get. -If not specified, a list of all Lotus Notes user stores is returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSecurityLotusNotesUserStore](New-FASTSearchSecurityLotusNotesUserStore.md) - -[Set-FASTSearchSecurityLotusNotesUserStore](Set-FASTSearchSecurityLotusNotesUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityPublicFilter.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityPublicFilter.md deleted file mode 100644 index 7378c8e409..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityPublicFilter.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityPublicFilter ---- - -# Get-FASTSearchSecurityPublicFilter - -## SYNOPSIS -Gets the public filter general setting. - -## SYNTAX - -``` -Get-FASTSearchSecurityPublicFilter [[-Worker] <WorkerPoolNode>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the public filter general setting configuration information. -The public filter is the search security filter that is used to find documents that all users have access to. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityPublicFilter -``` - -This example gets the security public filter's general setting configuration information. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityWorkerNode workerserver | Get-FASTSearchSecurityPublicFilter -``` - -This example gets the security public filter's general setting configuration information for a security worker with the server name of "workerserver". - -## PARAMETERS - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityPublicFilter](Set-FASTSearchSecurityPublicFilter.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityRegexAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityRegexAliaser.md deleted file mode 100644 index 20cc21f2b8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityRegexAliaser.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityRegexAliaser ---- - -# Get-FASTSearchSecurityRegexAliaser - -## SYNOPSIS -Gets a regular expression principal aliaser. - -## SYNTAX - -``` -Get-FASTSearchSecurityRegexAliaser [[-Identity] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a regular expression aliaser. -A regular expression aliaser maps users/groups from one user store to users/groups in other user stores, based on a regular expression pattern. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityRegexAliaser -Identity regex1 -``` - -This example retrieves a regular expression aliaser with an identity of "regex1". - -## PARAMETERS - -### -Identity -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSecurityRegexAliaser](New-FASTSearchSecurityRegexAliaser.md) - -[Set-FASTSearchSecurityRegexAliaser](Set-FASTSearchSecurityRegexAliaser.md) - -[New-FASTSearchSecurityRegexAliaserPattern](New-FASTSearchSecurityRegexAliaserPattern.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserFilter.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserFilter.md deleted file mode 100644 index b275130fc3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserFilter.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityUserFilter ---- - -# Get-FASTSearchSecurityUserFilter - -## SYNOPSIS -Gets a user's search security filter. - -## SYNTAX - -``` -Get-FASTSearchSecurityUserFilter [-Identity] <String> [-User] <String> [[-Worker] <WorkerPoolNode>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the user search security filter containing all groups that the user has access to. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityUserFilter -Identity ln1 -User user1 -``` - -This example gets the search security filter for user "user1" in user store "ln1". - -## PARAMETERS - -### -Identity -The identity of the user store containing the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -User -The identifier of the user or group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserStore.md deleted file mode 100644 index 045cac97c9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserStore.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityUserStore ---- - -# Get-FASTSearchSecurityUserStore - -## SYNOPSIS -Gets a user store. - -## SYNTAX - -``` -Get-FASTSearchSecurityUserStore [[-Identity] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a security user store. If the Identity parameter is not specified, it gets a list of all user stores. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityUserStore -Identity ln1 -``` - -This example gets the user store with an identity of "ln1". - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityUserStore -``` - -This example gets a list of all user stores. - -## PARAMETERS - -### -Identity -The identity of the user store to get. -If not specified, the cmdlet gets a list of all user stores. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchSecurityUserStore](Remove-FASTSearchSecurityUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserStoreGroupExpansion.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserStoreGroupExpansion.md deleted file mode 100644 index 49b81b429f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityUserStoreGroupExpansion.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityUserStoreGroupExpansion ---- - -# Get-FASTSearchSecurityUserStoreGroupExpansion - -## SYNOPSIS -Gets all groups in a user store that the specified user is a member of. - -## SYNTAX - -``` -Get-FASTSearchSecurityUserStoreGroupExpansion [-Identity] <String> [-User] <String> - [[-Worker] <WorkerPoolNode>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets all the groups in a user store that the user is a member of, and all the groups that any owning group is a member of. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityUserStoreGroupExpansion -Identity ln1 -User user1 -``` - -This example gets all the groups in the "ln1" user store that are parents, grand-parents, etc. -of the "user1" user. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityWorkerNode workerserver | Get-FASTSearchSecurityUserStoreGroupExpansion -Identity ln2 -User user1 -``` - -This example gets all the groups in the "ln2" user store from the worker with a server name of "workerserver" that are parents, grand-parents, etc. -of the "user1" user. - -## PARAMETERS - -### -Identity -The identity of the user store to look in. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -User -The user or group identifier to look up. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Worker -The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. - -```yaml -Type: WorkerPoolNode -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityWorkerNode.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityWorkerNode.md deleted file mode 100644 index 0d2f080ce7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityWorkerNode.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityWorkerNode ---- - -# Get-FASTSearchSecurityWorkerNode - -## SYNOPSIS -Gets status information about a security worker or workers. - -## SYNTAX - -``` -Get-FASTSearchSecurityWorkerNode [[-Identity] <String>] [-Active] [-Dead] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the URI and status for a security worker or a group of workers. -A security worker is the Windows service that generates user search security filters. -The cmdlet's function changes depending upon the parameter values: - --- If Identity is specified, the command gets the worker associated with the given URI. - --- If Active is specified, the command gets a list of all active workers. - --- If Dead is specified, the command gets a list of all inactive workers. - --- If none of these parameters are specified, the command returns a list of all workers. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityWorkerNode -Identity localhost -``` - -This example gets the status and complete URI for the worker with "localhost" in its URI. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityWorkerNode -``` - -This example returns a list of all workers, both active and inactive. - -## PARAMETERS - -### -Identity -The identity of the worker to get. -This is a URI or a partial URI, the server name for example. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Active -If specified, get a list of all active workers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Dead -If specified, get a list of all inactive workers. -A worker is "dead" if it does not respond to requests from the security manager. -This may occur if a worker machine goes down, or if there are network problems. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityXMLAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityXMLAliaser.md deleted file mode 100644 index 4cab578708..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSecurityXMLAliaser.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSecurityXMLAliaser ---- - -# Get-FASTSearchSecurityXMLAliaser - -## SYNOPSIS -Gets a security principal aliaser. - -## SYNTAX - -``` -Get-FASTSearchSecurityXMLAliaser [[-Identity] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet gets a regular expression or XML principal aliaser. -If the Identity parameter is not specified, it gets a list of all aliasers. - -A principal aliaser maps users from one user store into users in other user stores. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSecurityAliaser -``` - -This example gets a list of all XML and regular expression principal aliasers. - -### ---------------EXAMPLE 2----------------- -``` -PS C:\>Get-FASTSearchSecurityAliaser -Identity xmlalias4 -``` - -This example gets the principal aliaser with the ID xmlalias4. - -## PARAMETERS - -### -Identity -The identity of a regular expression or XML aliaser to get. -If not specified, the cmdlet gets a list of all aliasers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSecurityXMLAliaser](New-FASTSearchSecurityXMLAliaser.md) - -[Set-FASTSearchSecurityXMLAliaser](Set-FASTSearchSecurityXMLAliaser.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSpelltuningStatus.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSpelltuningStatus.md deleted file mode 100644 index 1065a935d0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-FASTSearchSpelltuningStatus.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Get-FASTSearchSpelltuningStatus ---- - -# Get-FASTSearchSpelltuningStatus - -## SYNOPSIS -Retrieves the status of spell tuning. - -## SYNTAX - -``` -Get-FASTSearchSpelltuningStatus [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the status of the automated alignment of the spell checking dictionary with the index; spell tuning is either active or inactive. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-FASTSearchSpelltuningStatus -``` - -## 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 - -[Reset-FASTSearchSpelltuning](Reset-FASTSearchSpelltuning.md) - -[Add-FASTSearchSpelltuning](Add-FASTSearchSpelltuning.md) - -[Remove-FASTSearchSpelltuning](Remove-FASTSearchSpelltuning.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-ProjectServerLicense.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-ProjectServerLicense.md deleted file mode 100644 index 6c4ed17697..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-ProjectServerLicense.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-ProjectServerLicense -schema: 2.0.0 ---- - -# Get-ProjectServerLicense - -## SYNOPSIS -Retrieves the status of the license for Project Server. If the current license is a trial, it will also indicate the expiry date and if it has expired. - -## SYNTAX - -``` -Get-ProjectServerLicense [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Retrieves the status of the license for Project Server. If the current license is a trial, it will also indicate the expiry date and if it has expired. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ProjectServerLicense -``` - -Gets the status of the Project Server license and when it was activated. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the -objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServiceApplication.md deleted file mode 100644 index 219c23800c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServiceApplication.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: microsoft.office.access.services.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAccessServiceApplication -schema: 2.0.0 ---- - -# Get-SPAccessServiceApplication - -## SYNOPSIS -Returns an Access Services application or a collection of Access Services applications. - -## SYNTAX - -``` -Get-SPAccessServiceApplication [[-Identity] <SPAccessServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPAccessServiceApplication cmdlet retrieves an Access Services application. -If an identity is not specified, the cmdlet returns the collection of Access Services applications that are in the farm. -The properties returned from this cmdlet are read-only. -If changes need to be made, use the Set-SPAccessServiceApplication cmdlet. -These changes affect all computers in the farm in which this Access Services application runs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE 1---------------- -``` -PS C:\>Get-SPAccessServiceApplication -identity "MyAccessService" -``` - -This example displays an Access Services application named MyAccessService. - -### ------------EXAMPLE 2---------------- -``` -PS C:\>Get-SPAccessServiceApplication | where {$_.recordsintablemax -gt 10000} -``` - -This example displays every Access Services application that run in the farm, which allows more than 10,000 records in a table. - -### ------------EXAMPLE 3---------------- -``` -PS C:\>Get-SPAccessServiceApplication -``` - -This example displays every Access Services application in the farm. - -## PARAMETERS - -### -Identity -Specifies the Access Services application to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPAccessServiceApplication object. - -```yaml -Type: SPAccessServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesApplication.md deleted file mode 100644 index 656f07f490..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesApplication.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAccessServicesApplication -schema: 2.0.0 ---- - -# Get-SPAccessServicesApplication - -## SYNOPSIS - -Gets an Access Services Service Application. - - -## SYNTAX - -``` -Get-SPAccessServicesApplication [[-Identity] <SPServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION - -Returns Access Services service applications available in the farm. - - -## EXAMPLES - -### Example 1 -``` - -PS C:\>$sa = Get-SPServiceApplication| ?{$_.TypeName -eq 'Access Services Web Service Application'} -PS C:\>Get-SPAccessServicesApplication -Identity $sa - -``` -Returns the Access Services application using a service application pipebind. - -### Example 2 -``` -PS C:\>Get-SPAccessServicesApplication -Identity 0d1da6e4-5cd6-4ccf-9ae1-ace2e964223a -``` - -Returns the Access Services application with the specified GUID. - - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity - -Must be in the form of a Service Application pipe bind or a GUID. - - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabase.md deleted file mode 100644 index 59cc4704b8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabase.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAccessServicesDatabase -schema: 2.0.0 ---- - -# Get-SPAccessServicesDatabase - -## SYNOPSIS -Returns an Access Services database. - -## SYNTAX - -``` -Get-SPAccessServicesDatabase [[-Identity] <AccessServicesDatabasePipeBind>] - [[-ContentDb] <SPContentDatabasePipeBind>] [[-AccessAppsOnly] <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns an Access Services database. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPAccessServicesDatabase -Identity https://apps-eec88dc5f597c6.contoso-apps.com/sites/team/accessApp -``` -Using the App Web, this example returns the Access database named 'accessApp'. - -### Example 2 -``` -PS C:\>Get-SPAccessServicesDatabase -ContentDb WSS_Content -``` -This example returns all Access databases associated with sites in the content database, WSS_Content. - -## PARAMETERS - -### -AccessAppsOnly -Returns only Access Apps. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContentDb -The Content Database to return Access Apps from. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -The URL to the Access App. Must be the App Web URL. - -```yaml -Type: AccessServicesDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Office.Access.Services.PowerShell.AccessServicesDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPContentDatabasePipeBind -System.Boolean -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServer.md deleted file mode 100644 index 6eb036053b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServer.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAccessServicesDatabaseServer -schema: 2.0.0 ---- - -# Get-SPAccessServicesDatabaseServer - -## SYNOPSIS -Returns SQL Server instances associated with Access Services. - -## SYNTAX - -### GetSingleDatabaseServerParamterSet -``` -Get-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [<CommonParameters>] -``` - -### GetDatabaseServersParameterSet -``` -Get-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns the SQL Server instances that are available for use with Access Services. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPAccessServicesDatabaseServer -``` - -Returns all SQL Server instances available for use. - - -### Example 2 -``` -PS C:\>Get-SPAccessServicesDatabaseServer -DatabaseServer ACCSQL -ServiceContext http://siteUrl -DatabaseServergroup DEFAULT -``` - -Returns the database server ACCSQL from the DEFAULT database server group using the service context from http://siteUrl. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies an existing Database Server associated with Access Services. - -```yaml -Type: AccessServicesDatabaseServerPipeBind -Parameter Sets: GetSingleDatabaseServerParamterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerGroup -The name of the database server group. - -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: GetSingleDatabaseServerParamterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: GetDatabaseServersParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context to retrieve Access Services database server information from. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServerGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServerGroup.md deleted file mode 100644 index 31182fb06b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServerGroup.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAccessServicesDatabaseServerGroup -schema: 2.0.0 ---- - -# Get-SPAccessServicesDatabaseServerGroup - -## SYNOPSIS -Returns a database server group. - -## SYNTAX - -``` -Get-SPAccessServicesDatabaseServerGroup [-ServiceContext] <SPServiceContextPipeBind> - [[-DatabaseServerGroup] <AccessServicesDatabaseServerGroupPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns a database server group associated with the given service context. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPAccessServicesDatabaseServerGroup -ServiceContext http://siteUrl -``` -Returns the database server group associated with the site, http://siteUrl. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseServerGroup -The name of the database server group. - -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context to retrieve Access Services database server information from. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.Office.Access.Services.PowerShell.AccessServicesDatabaseServerGroupPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServerGroupMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServerGroupMapping.md deleted file mode 100644 index f54c5b5198..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAccessServicesDatabaseServerGroupMapping.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAccessServicesDatabaseServerGroupMapping -schema: 2.0.0 ---- - -# Get-SPAccessServicesDatabaseServerGroupMapping - -## SYNOPSIS -Returns the mapping of the database server group. - -## SYNTAX - -``` -Get-SPAccessServicesDatabaseServerGroupMapping [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet shows the current mapping of the database server group associated with a specific service context. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPAccessServicesDatabaseServerGroupMapping -ServiceContext http://siteUrl -``` - -Outputs the database server group associated with the site, http://siteUrl. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context to retrieve Access Services database server information from. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAlternateURL.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAlternateURL.md deleted file mode 100644 index fd75dd97e8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAlternateURL.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAlternateURL -schema: 2.0.0 ---- - -# Get-SPAlternateURL - -## SYNOPSIS - -Returns all alternate URLs that match a given set of criteria. - - - -## SYNTAX - -### ResourceName -``` -Get-SPAlternateURL [[-Identity] <SPAlternateUrlPipeBind>] -ResourceName <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -### WebApplication -``` -Get-SPAlternateURL [[-Identity] <SPAlternateUrlPipeBind>] -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPAlternateURL cmdlet returns all alternate URLs that match the scope given by either the optional Identity parameter or by a combination of the optional WebApplication, Zone, or Resource parameters. -Each criterion that is added narrows the scope. -If no criteria are specified then all alternate URLs are returned. - -If the Identity parameter is used, only the specific matching alternate URL is returned. -If no alternate URL with the given identity exists at the given scope, nothing is returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPAlternateURL -WebApplication http://sitename -``` - -This example displays all the alternate URLs on a given Web application. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPAlternateURL -ResourceName "MyResource" -``` - -This example displays all the alternate URLs for a given resource. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the alternate URL to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or a valid URL, in the form http://server_name. - -```yaml -Type: SPAlternateUrlPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource from which to list alternate URLs. - -```yaml -Type: String -Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the Web application from which to list alternate URLs. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Zone -Specifies one of the five zones with which the alternate URLs is associated. - -Must be a valid zone: Default, Intranet, Internet, Extranet, or Custom - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppAcquisitionConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppAcquisitionConfiguration.md deleted file mode 100644 index 27b4e891bd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppAcquisitionConfiguration.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppAcquisitionConfiguration -schema: 2.0.0 ---- - -# Get-SPAppAcquisitionConfiguration - -## SYNOPSIS - -Returns app acquisition settings. - -## SYNTAX - -### MarketplaceSettingsInSiteSubscription -``` -Get-SPAppAcquisitionConfiguration -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### MarketplaceSettingsInWebApplication -``` -Get-SPAppAcquisitionConfiguration [-AssignmentCollection <SPAssignmentCollection>] - -WebApplication <SPWebApplicationPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets [https://go.microsoft.com/fwlink/?LinkID=187810](https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Get-SPAppAcquisitionConfiguration` cmdlet to return app acquisition settings from the SharePoint Storeor App Catalog. - -## EXAMPLES - -### ------------EXAMPLE 1------- -``` -PS C:\>Get-SPAppAcquisitionConfiguration -WebApplication http://localhost -``` - -This example returns app acquisition settings for the specified web application. - - -### ------------EXAMPLE 2------- -``` -PS C:\>Get-SPAppAcquisitionConfiguration -SiteSubscription http://localhost/sites/SharePointOnlineAdmin -``` - -This example returns app acquisition settings for the specified tenant. - -## PARAMETERS - -### -SiteSubscription - -Specifies the site collection for which app acquisition settings are to be returned. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: MarketplaceSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication - -Specifies the web application for which app acquisition settings are to be returned. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: MarketplaceSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -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 - -### Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-SPAppAcquisitionConfiguration](Set-SPAppAcquisitionConfiguration.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppAutoProvisionConnection.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppAutoProvisionConnection.md deleted file mode 100644 index 3aaa33576e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppAutoProvisionConnection.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppAutoProvisionConnection -schema: 2.0.0 ---- - -# Get-SPAppAutoProvisionConnection - -## SYNOPSIS - -Returns provision connection settings for an app. - - - -## SYNTAX - -``` -Get-SPAppAutoProvisionConnection [-AssignmentCollection <SPAssignmentCollection>] - [-ConnectionType <ConnectionTypes>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppAutoProvisionConnection cmdlet to return the provision connection settings for an app. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1---------- -``` -PS C:\>Get-SpAppAutoProvisionConnection -``` - -This example returns the entire app auto provisioning connection information for the default site subscription. - -### ---------------EXAMPLE 2---------- -``` -PS C:\>$subscription = Get-SPSiteSubscription http://Contoso.com -PS C:\>Get-SPAppAutoProvisionConnection -SiteSubscription $subscription -ConnectionType RemoteWebHost -``` - -This example returns the remote web host app auto provisioning connection information for the site subscription for Contoso.com site - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectionType -Specifies the connection type to provision the app. - -```yaml -Type: ConnectionTypes -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site collection from which to return the provision connection. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAppAutoProvisionConnection](Set-SPAppAutoProvisionConnection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDeniedEndpointList.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDeniedEndpointList.md deleted file mode 100644 index 4c8b3698be..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDeniedEndpointList.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppDeniedEndpointList -schema: 2.0.0 ---- - -# Get-SPAppDeniedEndpointList - -## SYNOPSIS - -Applies to: - - - -## SYNTAX - -``` -Get-SPAppDeniedEndpointList [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPAppEndpoint cmdlet to return the app-denied endpoint list for the entire farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------EXAMPLE---------- -``` -PS C:\>Get-SPAppDeniedEndpoint -``` - -This example returns all the app-denied endpoints within the farm. - - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Clear-SPAppDeniedEndpointList](Clear-SPAppDeniedEndpointList.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDisablingConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDisablingConfiguration.md deleted file mode 100644 index 6842b33565..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDisablingConfiguration.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppDisablingConfiguration -schema: 2.0.0 ---- - -# Get-SPAppDisablingConfiguration - -## SYNOPSIS - -Applies to: - - - - -## SYNTAX - -``` -Get-SPAppDisablingConfiguration [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPAppDisablingConfiguration cmdlet to return the disable sync list state for an app . - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### -------------EXAMPLE------- -``` -PS C:\>Get-SPAppDisablingConfiguration -``` - -This example returns disable list sync state of a pp. - - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-SPAppDisablingConfiguration](Set-SPAppDisablingConfiguration.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDomain.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDomain.md deleted file mode 100644 index 02673eb5e5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppDomain.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppDomain -schema: 2.0.0 ---- - -# Get-SPAppDomain - -## SYNOPSIS - -Returns the domain used to host apps. - - - -## SYNTAX - -``` -Get-SPAppDomain [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppDomain cmdlet to return the domain used to host apps in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Get-SPAppDomain -``` - -This example returns the domain name that hosts apps in the entire farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAppDomain](Set-SPAppDomain.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppHostingQuotaConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppHostingQuotaConfiguration.md deleted file mode 100644 index 8aa10d8746..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppHostingQuotaConfiguration.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppHostingQuotaConfiguration -schema: 2.0.0 ---- - -# Get-SPAppHostingQuotaConfiguration - -## SYNOPSIS -Returns the hosting quotas for an app. - -## SYNTAX - -``` -Get-SPAppHostingQuotaConfiguration [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - -SiteSubscription <SPSiteSubscriptionPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Get-SPAppHostingQuotaConfiguration` cmdlet to return the hosting quotas for a specified app by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - -## EXAMPLES - -### --------------EXAMPLE 1--------- -``` -PS C:\>Get-SPAppHostingQuotaConfiguration -Identity '586d4a32-98c3-42ce-80be-3c76c10c250c' -``` - -This example returns the hosted app quota associated to SiteSubscriptionID "586d4a32-98c3-42ce-80be-3c76c10c250c". - -### --------------EXAMPLE 1--------- -``` -PS C:\>Get-SPSiteSubscription | Get-SPAppHostingQuotaConfiguration -Identity $_ -``` - -This example returns the hosted app quota associated for all site subscriptions in the farm. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site subscription from which to get site collections. - -The type must be a valid URL, in the form, http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -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 - -### Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-SPAppHostingQuotaConfiguration](Set-SPAppHostingQuotaConfiguration.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppInstance.md deleted file mode 100644 index 0b0028292e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppInstance.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppInstance -schema: 2.0.0 ---- - -# Get-SPAppInstance - -## SYNOPSIS - -Returns the metadata for an instance of an app. - -## SYNTAX - -### IdentityParameterSet -``` -Get-SPAppInstance -Identity <SPAppInstance> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### SiteAndIdParameterSet -``` -Get-SPAppInstance -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] -AppInstanceId <Guid> - [<CommonParameters>] -``` - -### WebParameterSet -``` -Get-SPAppInstance [-App <SPApp>] [-AssignmentCollection <SPAssignmentCollection>] -Web <SPWebPipeBind> - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Get-AppInstance cmdlet to get a collection of app instances that are installed on an SPWeb object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE 1----------- -``` -PS C:\>Get-SPAppInstance -Web http://localhost -``` - -This example returns a collection if more than one app is installed on http://localhost. -If only one app is installed, a single object is returned. - -### -----------EXAMPLE 2----------- -``` -PS C:\>Get-SPAppInstance -AppInstanceId $instance.Id -``` - -This example returns the ID of an instance of an app. - -## PARAMETERS - -### -Identity -Specifies the App instance for which to find metadata. - -```yaml -Type: SPAppInstance -Parameter Sets: IdentityParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Sets the query scope to a site. - -Subsites are not included. - -```yaml -Type: SPSitePipeBind -Parameter Sets: SiteAndIdParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -App -Specifies the App. - -This parameter returns metadata for all instances of an app. - -```yaml -Type: SPApp -Parameter Sets: WebParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AppInstanceId -Specifies the App Instance ID to display. - -```yaml -Type: Guid -Parameter Sets: SiteAndIdParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Web -Specifies the SPWeb object. - -```yaml -Type: SPWebPipeBind -Parameter Sets: WebParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Restart-SPAppInstanceJobs](Restart-SPAppInstanceJobs.md) - -[Uninstall-SPAppInstance](Uninstall-SPAppInstance.md) - -[Update-SPAppInstance](Update-SPAppInstance.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppPrincipal.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppPrincipal.md deleted file mode 100644 index d0d8b9fe3b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppPrincipal.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppPrincipal -schema: 2.0.0 ---- - -# Get-SPAppPrincipal - -## SYNOPSIS - -Displays a specific app principal object. - - - -## SYNTAX - -``` -Get-SPAppPrincipal -NameIdentifier <String> -Site <SPWebPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppPrincipal cmdlet to display a specific app principal object from the SharePoint app registry. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE-------- -``` -PS C:\>Get-SPAppPrincipal -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" -``` - -This example returns the app principal for a specified ID. - -## PARAMETERS - -### -NameIdentifier -Specifies the app principal's name identifier to search for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Register-SPAppPrincipal](Register-SPAppPrincipal.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppScaleProfile.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppScaleProfile.md deleted file mode 100644 index 591ba5da7f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppScaleProfile.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppScaleProfile -schema: 2.0.0 ---- - -# Get-SPAppScaleProfile - -## SYNOPSIS - -Returns settings for an app profile. - -## SYNTAX - -``` -Get-SPAppScaleProfile [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppScaleProfile cmdlet to return settings for an app profile. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Get-SPAppScaleProfile -``` - -This example returns the farm level app scale profile. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAppScaleProfile](Set-SPAppScaleProfile.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppSiteSubscriptionName.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppSiteSubscriptionName.md deleted file mode 100644 index 1a5aafb455..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppSiteSubscriptionName.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppSiteSubscriptionName -schema: 2.0.0 ---- - -# Get-SPAppSiteSubscriptionName - -## SYNOPSIS - -Returns the name of the specified site subscription. - - - -## SYNTAX - -``` -Get-SPAppSiteSubscriptionName [-AssignmentCollection <SPAssignmentCollection>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppSiteSubscriptionName cmdlet to return the name of the specified site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE 1------- -``` -PS C:\>Get-SPAppSiteSubscriptionName -``` - -This example returns the name of the default site subscription. - -### ------------EXAMPLE 2------- -``` -PS C:\>Get-SPAppSiteSubscriptionName -SiteSubscription https://www.contoso.com -``` - -This example returns the name of the site subscription for SPSite https://www.contoso.com - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. -If this parameter is not specified, then the default site subscription is used. -All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAppSiteSubscriptionName](Set-SPAppSiteSubscriptionName.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStateSyncLastRunTime.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStateSyncLastRunTime.md deleted file mode 100644 index 8d5f8c91e5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStateSyncLastRunTime.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppStateSyncLastRunTime -schema: 2.0.0 ---- - -# Get-SPAppStateSyncLastRunTime - -## SYNOPSIS - -Returns the latest time the app state update job was invoked. - - - -## SYNTAX - -``` -Get-SPAppStateSyncLastRunTime [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppStateSyncLastRunTime cmdlet to return the latest time the app state update job was invoked. -The app state update job updates the app states in SharePoint from the marketplace including app updates. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE------------ -``` -PS C:\>Get-SPAppStateSyncLastRunTime -``` - -This example returns the latest time the app state update job was invoked. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStateUpdateInterval.md deleted file mode 100644 index 4cadf9a990..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStateUpdateInterval.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppStateUpdateInterval -schema: 2.0.0 ---- - -# Get-SPAppStateUpdateInterval - -## SYNOPSIS - -Returns the interval in hours between updates of the app state update job. - -## SYNTAX - -``` -Get-SPAppStateUpdateInterval [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAppStateUpdateInterval cmdlet to return the interval in hours between updates of the app state update job. -The app state update job updates the app states, including app updates, in SharePoint based on information in the SharePoint Store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE------- -``` -PS C:\>Get-SPAppStateUpdateInterval -``` - -This example returns the app state update timer job invocation interval in hours. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAppStateUpdateInterval](Set-SPAppStateUpdateInterval.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStoreConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStoreConfiguration.md deleted file mode 100644 index 8744214167..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStoreConfiguration.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppStoreConfiguration -schema: 2.0.0 ---- - -# Get-SPAppStoreConfiguration - -## SYNOPSIS - -Returns app SharePoint Store settings. - -## SYNTAX - -``` -Get-SPAppStoreConfiguration [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPAppStoreConfiguration cmdlet to return all apps and their associated SharePoint Store settings. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE------- -``` -PS C:\>Get-SPAppStoreConfiguration -``` - -This example returns the settings for all of the apps. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-SPAppStoreConfiguration](Set-SPAppStoreConfiguration.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStoreWebServiceConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStoreWebServiceConfiguration.md deleted file mode 100644 index 1d01b84e2e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAppStoreWebServiceConfiguration.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAppStoreWebServiceConfiguration -schema: 2.0.0 ---- - -# Get-SPAppStoreWebServiceConfiguration - -## SYNOPSIS -Returns properties of a SharePoint Store app. - -## SYNTAX - -``` -Get-SPAppStoreWebServiceConfiguration [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Get-SPAppStoreWebServiceConfiguration` cmdlet to return property settings or SharePoint Store apps. - -This cmdlet is not intended for the IT Pro audience. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPAppStoreWebServiceConfiguration -``` - -This example returns the product type and version for a SharePoint Store app. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAuthenticationProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAuthenticationProvider.md deleted file mode 100644 index 0abd999dec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAuthenticationProvider.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAuthenticationProvider -schema: 2.0.0 ---- - -# Get-SPAuthenticationProvider - -## SYNOPSIS - -Returns an authentication provider. - - - -## SYNTAX - -``` -Get-SPAuthenticationProvider [[-Identity] <SPAuthenticationProviderPipeBind>] - [-WebApplication] <SPWebApplicationPipeBind> [-Zone] <SPUrlZone> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPAuthenticationProvider cmdlet returns an authentication provider on a specified Web application zone. -The following are the standard authentication providers available for SharePoint Products: NTLM, Classic NTLM, Negotiate, and Classic Negotiate. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPAuthenticationProvider -WebApplication http://webAppUrl -Zone Default -``` - -This example retrieves the authentication provider in the Default zone of the Web Application 'http://webappurl/'. - -## PARAMETERS - -### -Identity -Specifies the authentication provider to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint authentication provider (for example, NTLM); or an instance of a valid SPAuthenticationProvider object. - -```yaml -Type: SPAuthenticationProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Returns the content databases for the specified Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -Specifies the Web application zone or zones for which to return the authentication provider. - -The type must be any one of the valid zones: Default, Intranet, Internet, Extranet, or Custom. - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAuthenticationRealm.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAuthenticationRealm.md deleted file mode 100644 index d36ed5a2d0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPAuthenticationRealm.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPAuthenticationRealm -schema: 2.0.0 ---- - -# Get-SPAuthenticationRealm - -## SYNOPSIS - -Returns the authentication realms. - -## SYNTAX - -``` -Get-SPAuthenticationRealm [[-ServiceContext] <SPServiceContextPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPAuthenticationRealm cmdlet to display the authentication realms of the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE------------- -``` -PS C:\>Get-SPAuthenticationRealm -``` - -This example displays the authentication realms in the entire farm. - -## PARAMETERS - -### -ServiceContext -Specifies the service context for which the realm needs to be displayed. -For example, $root.web. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAuthenticationRealm](Set-SPAuthenticationRealm.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBackupHistory.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBackupHistory.md deleted file mode 100644 index 8f0b01565b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBackupHistory.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBackupHistory -schema: 2.0.0 ---- - -# Get-SPBackupHistory - -## SYNOPSIS - -Returns a history of backup and restore operations. - - - -## SYNTAX - -``` -Get-SPBackupHistory -Directory <String> [-AssignmentCollection <SPAssignmentCollection>] [-ShowBackup] - [-ShowRestore] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPBackupHistory cmdlet reads a history of backup and restore operations that have been run. -Specifies whether you want to display only the backup history, only the restore history, or all of the history. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPBackupHistory -Directory \\file_server\share\Backup -``` - -This example returns all farm backup and restore operations that have been run for the \\\\file_server\share\Backup directory. - -### ------------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPBackupHistory -Directory C:\Backup -ShowBackup -``` - -This example returns all of the farm backup operations that have been run for the C:\Backup directory. - -### ------------------EXAMPLE 3----------------- -``` -PS C:\>(Get-SPBackupHistory -Directory C:\Backup -ShowBackup)[0].SelfId | Restore-SPFarm -Directory C:\Backup -RestoreMethod overwrite -``` - -This example gets all of the farm backup operations that have been run for the C:\Backup directory, finds the most recent backup, and then passes its backup GUID to the Restore-SPFarm cmdlet. -The Restore-SPFarm cmdlet will then perform an overwrite restore from that backup package. - -## PARAMETERS - -### -Directory -Specifies the path where the SharePoint Products backup packages generated from a farm backup have been stored. - -The type must be a valid path in either of the following forms: - -- C:\folder_name -- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShowBackup -Filters the output so that the history of backup operations only is displayed. -If both the ShowBackup and the ShowRestore parameters are not specified, the history of both backup and restore operations is displayed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowRestore -Filters the output so that the history of restore operations only is displayed. -If both the ShowBackup and the ShowRestore parameters are absent, the history of both backup and restore operations is displayed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBingMapsBlock.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBingMapsBlock.md deleted file mode 100644 index 409c2ca826..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBingMapsBlock.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBingMapsBlock -schema: 2.0.0 ---- - -# Get-SPBingMapsBlock - -## SYNOPSIS - -Returns Bing Maps blocked status. - - - -## SYNTAX - -``` -Get-SPBingMapsBlock [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPBingMapsBlock cmdlet to return true or false on whether Bing Maps are blocked in all locales. -This cmdlet will return an object, and "BlockBingMapsInAllLocales" property will return True or False. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE----------- -``` -PS C:\>Get-SPBingMapsBlock -``` - -This example returns an object, and BlockBingMapsInAllLocales property will return True or False on whether Bing Maps are blocked in all locales. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPBingMapsBlock](Set-SPBingMapsBlock.md) - -[Get-SPBingMapsKey](Get-SPBingMapsKey.md) - -[Set-SPBingMapskey](Set-SPBingMapskey.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBingMapsKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBingMapsKey.md deleted file mode 100644 index a384887cfb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBingMapsKey.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBingMapsKey -schema: 2.0.0 ---- - -# Get-SPBingMapsKey - -## SYNOPSIS - -Returns the Bing Maps key. - - - -## SYNTAX - -``` -Get-SPBingMapsKey [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPBingMapsKey cmdlet to return the current Bing Maps key for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE----------- -``` -PS C:\>Get-SPBingMapsKey -``` - -This example returns the Bing Maps key for the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPBingMapskey](Set-SPBingMapskey.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBrowserCustomerExperienceImprovementProgram.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBrowserCustomerExperienceImprovementProgram.md deleted file mode 100644 index 75d705d242..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBrowserCustomerExperienceImprovementProgram.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBrowserCustomerExperienceImprovementProgram -schema: 2.0.0 ---- - -# Get-SPBrowserCustomerExperienceImprovementProgram - -## SYNOPSIS - -Returns the current opt-in state for the browser Customer Experience Improvement Program. - - - -## SYNTAX - -### Farm -``` -Get-SPBrowserCustomerExperienceImprovementProgram [-Farm] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### SiteSubscription -``` -Get-SPBrowserCustomerExperienceImprovementProgram -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### WebApplication -``` -Get-SPBrowserCustomerExperienceImprovementProgram -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPBrowserCustomerExperienceImprovementProgram cmdlet reads the current opt-in state for the browser Customer Experience Improvement Program. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Get-SPBrowserCustomerExperienceImprovementProgram -WebApplication http://WebAppexample1 -``` - -This example returns the current Customer Experience Improvement Program opt-in state for the Web application, WebAppexample1. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPSiteSubscription http://SiteSubscription1 | Get-SPBrowserCustomerExperienceImprovementProgram -``` - -The following example returns the Customer Experience Improvement Program opt-in state for the site subscription, SiteSubscription1. - -## PARAMETERS - -### -Farm -Specifies that the opt-in state for the farm is returned by this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: Farm -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Returns the opt-in state for the specified site subscription. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Returns the opt-in state for the specified SharePoint Web application. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogEntityNotificationWeb.md deleted file mode 100644 index 72866c0749..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogEntityNotificationWeb.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBusinessDataCatalogEntityNotificationWeb -schema: 2.0.0 ---- - -# Get-SPBusinessDataCatalogEntityNotificationWeb - -## SYNOPSIS - -Returns the entity notification site. - - - -## SYNTAX - -``` -Get-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPBusinessDataCatalogEntityNotificationWeb cmdlet to return the entity notification site that can receive and forward external system notifications. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------EXAMPLE----------- -``` -PS C:\>Get-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext "http://contoso/" -``` - -This example returns the entity notification site for the site collection at http://contoso. - -## PARAMETERS - -### -ServiceContext -Specifies the service context for which the entity notification web has to be returned. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-SPBusinessDataCatalogEntityNotificationWeb](Clear-SPBusinessDataCatalogEntityNotificationWeb.md) - -[Set-SPBusinessDataCatalogEntityNotificationWeb](Set-SPBusinessDataCatalogEntityNotificationWeb.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogMetadataObject.md deleted file mode 100644 index 46c58aa1f0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogMetadataObject.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBusinessDataCatalogMetadataObject -schema: 2.0.0 ---- - -# Get-SPBusinessDataCatalogMetadataObject - -## SYNOPSIS - -Returns a Business Data Connectivity Metadata Store metadata object. - - - -## SYNTAX - -``` -Get-SPBusinessDataCatalogMetadataObject -BdcObjectType <PSBdcObjectType> - -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] - [-Namespace <String>] [-ContainingLobSystem <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPBusinessDataCatalogMetadataObject cmdlet reads a Business Data Connectivity Metadata Store metadata object from a Business Data Connectivity Service application. - -Output for this cmdlet can be a series of objects. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceConext http://contoso -``` - -This example gets a metadata object of type Model with the name ContosoModel from the Business Data Connectivity Metadata Store on the given site. - -## PARAMETERS - -### -BdcObjectType -Specifies the type of the metadata object to return. - -The type must be one of the following valid metadata object types: BdcCatalog, Model, LobSystem, LobSystemInstance, or Entity. - -```yaml -Type: PSBdcObjectType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context of the Business Data Connectivity Metadata Store metadata object to return. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the metadata object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace of the metadata object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainingLobSystem -Specifies the name of the LobSystem. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogThrottleConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogThrottleConfig.md deleted file mode 100644 index 52d917ca76..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPBusinessDataCatalogThrottleConfig.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPBusinessDataCatalogThrottleConfig -schema: 2.0.0 ---- - -# Get-SPBusinessDataCatalogThrottleConfig - -## SYNOPSIS - -Returns the throttling configuration for a Business Data Connectivity Service application. - - - -## SYNTAX - -### FileBackedProvided -``` -Get-SPBusinessDataCatalogThrottleConfig [-FileBacked] -Scope <ThrottleScope> -ThrottleType <ThrottleType> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### ProxyProvided -``` -Get-SPBusinessDataCatalogThrottleConfig -Scope <ThrottleScope> - -ServiceApplicationProxy <SPServiceApplicationProxyPipeBind> -ThrottleType <ThrottleType> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPBusinessDataCatalogThrottleConfig cmdlet reads the throttling configuration for a Business Data Connectivity Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy -``` - -This example returns the throttling information that is related to database items for the given service application. - -## PARAMETERS - -### -FileBacked -Requests the throttling configuration for file backed metadata catalogs. - -```yaml -Type: SwitchParameter -Parameter Sets: FileBackedProvided -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Returns the throttling configuration for the specified the scope. - -The type must be one of the following: Wcf, WebService, Database, Global, or Custom. - -```yaml -Type: ThrottleScope -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplicationProxy -Specifies the Business Data Connectivity Service application proxy that contains the throttling configuration to get. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: ProxyProvided -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleType -Returns the throttling configuration for the specified throttle type. - -The type must be one of the following: None, Items, Size, Connections, or Timeout. - -```yaml -Type: ThrottleType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPCertificateAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPCertificateAuthority.md deleted file mode 100644 index d2bd724908..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPCertificateAuthority.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPCertificateAuthority -schema: 2.0.0 ---- - -# Get-SPCertificateAuthority - -## SYNOPSIS - -Returns the SharePoint certificate authority (CA). - - - -## SYNTAX - -``` -Get-SPCertificateAuthority [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPCertificateAuthority cmdlet returns the SharePoint certificate authority (CA). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPCertificateAuthority -``` - -This example gets the certificate authority. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimProvider.md deleted file mode 100644 index 05e2be36af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimProvider.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPClaimProvider -schema: 2.0.0 ---- - -# Get-SPClaimProvider - -## SYNOPSIS - -Returns a claim provider. - - - -## SYNTAX - -``` -Get-SPClaimProvider [[-Identity] <SPClaimProviderPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPClaimProvider cmdlet returns a claim provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPClaimProvider -Identity "MyClaimProvider" | Set-SPClaimProvider -Enabled $false -``` - -This example disables the claim provider MyClaimProvider. - -## PARAMETERS - -### -Identity -Specifies the claim provider to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. - -```yaml -Type: SPClaimProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimProviderManager.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimProviderManager.md deleted file mode 100644 index d8ba31751d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimProviderManager.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPClaimProviderManager -schema: 2.0.0 ---- - -# Get-SPClaimProviderManager - -## SYNOPSIS - -Returns a claim provider manager. - - - -## SYNTAX - -``` -Get-SPClaimProviderManager [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPClaimProviderManager cmdlet reads a claim provider manager. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE-------- -``` -PS C:\>Get-SPClaimProviderManager -``` - -This example returns a claim provider manager for the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimTypeEncoding.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimTypeEncoding.md deleted file mode 100644 index 5d300322c0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPClaimTypeEncoding.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPClaimTypeEncoding -schema: 2.0.0 ---- - -# Get-SPClaimTypeEncoding - -## SYNOPSIS - -Returns a list of all the types of claims. - -## SYNTAX - -``` -Get-SPClaimTypeEncoding [-AssignmentCollection <SPAssignmentCollection>] [-ClaimType <String>] - [-EncodingCharacter <Char>] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPClaimTypeEncoding cmdlet to return the following: - - --- A list of all the types of claims that are registered in the farm - --- The Unicode character that will be encoded when the SPClaim.ToEncodedString method is invoked - --- The SPClaim.ClaimType property is set to a valid value - - -For additional information about the SPClaim methods and properties, see M:Microsoft.SharePoint.Administration.Claims.SPClaim.ToEncodedString and P:Microsoft.SharePoint.Administration.Claims.SPClaim.ClaimType respectively. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1-------- -``` -PS C:\>Get-SPClaimTypeEncoding -``` - -This example returns a list of all types of claima in the farm. - -### --------------EXAMPLE 2-------- -``` -PS C:\>Get-SPClaimTypeEncoding -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" -``` - -This example returns a specific claim type by using the ClaimType parameter. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClaimType -Specifies an encoding character that is mapped to a type of input claim. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncodingCharacter -Specifies a type of claim that is mapped to an input character. - -```yaml -Type: Char -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPClaimTypeEncoding](New-SPClaimTypeEncoding.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPConnectedServiceApplicationInformation.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPConnectedServiceApplicationInformation.md deleted file mode 100644 index 3f29cb02b4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPConnectedServiceApplicationInformation.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPConnectedServiceApplicationInformation -schema: 2.0.0 ---- - -# Get-SPConnectedServiceApplicationInformation - -## SYNOPSIS -Returns the health of the service application proxy. - -## SYNTAX - -``` -Get-SPConnectedServiceApplicationInformation [[-ServiceApplicationProxy] <SPServiceApplicationProxyPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPConnectedServiceApplicationInformation` cmdlet checks whether the proxy to a service application is in good health. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - -## EXAMPLES - -### Example 1 -``` -PS C:\>$validProxy = $false -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq "User Profile Service Application Proxy"} -PS C:\>$proxyHealth = Get-SPConnectedServiceApplicationInformation -ServiceApplicationProxy $proxy -PS C:\>if(($proxyHealth -ne $null) -and ($proxyHealth.ApplicationAddressesState -eq "UpToDate")) { - $validProxy = $true - } else { - $validProxy = $false - } -PS C:\>$validProxy -``` - -This example checks the health of the service application proxy server. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplicationProxy -Specifies the name of the service application proxy. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDatabase.md deleted file mode 100644 index 26efd48020..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDatabase.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPContentDatabase -schema: 2.0.0 ---- - -# Get-SPContentDatabase - -## SYNOPSIS - -Returns one or more content databases. - - - -## SYNTAX - -### DefaultSet -``` -Get-SPContentDatabase [[-Identity] <SPContentDatabasePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-NoStatusFilter] [<CommonParameters>] -``` - -### ContentDatabasesOfSite -``` -Get-SPContentDatabase -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### AllContentDatabasesInWebApplication -``` -Get-SPContentDatabase -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-NoStatusFilter] [<CommonParameters>] -``` - -### Unattached -``` -Get-SPContentDatabase [-AssignmentCollection <SPAssignmentCollection>] [-ConnectAsUnattachedDatabase] - [-DatabaseCredentials <PSCredential>] -DatabaseName <String> -DatabaseServer <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPContentDatabase cmdlet returns the specified content databases. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE 1------------ -``` -PS C:\>Get-SPContentDatabase -WebApplication http://webAppUrl -``` - -This example returns all content databases used by the sitename Web application. - -### ----------------EXAMPLE 2------------ -``` -PS C:\>Get-SPContentDatabase -Site http://siteUrl -``` - -This example returns the content database that contains the site collection at http://siteUrl. - -## PARAMETERS - -### -Identity -Specifies a specific content database to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Returns the content database for the specified site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: ContentDatabasesOfSite -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Returns the content databases for the specified Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: AllContentDatabasesInWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectAsUnattachedDatabase -Specifies that only unattached databases in the farm are returned. - -```yaml -Type: SwitchParameter -Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database in the farm. - -```yaml -Type: String -Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the database server in the farm. - -```yaml -Type: String -Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStatusFilter -Specifies whether a status filter is turned on. - -The valid values are True or False. The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultSet, AllContentDatabasesInWebApplication -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDatabaseOrphanedData.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDatabaseOrphanedData.md deleted file mode 100644 index 7b78ba0a62..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDatabaseOrphanedData.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2019 -title: Get-SPContentDatabaseOrphanedData -schema: 2.0.0 ---- - -# Get-SPContentDatabaseOrphanedData - -## SYNOPSIS -Gets orphaned data in content database. - - -## SYNTAX - -``` -Get-SPContentDatabaseOrphanedData [-Identity] <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - - -## DESCRIPTION -Use the **Get-SPContentDatabaseOrphanedData** to display orphaned objects. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -PS C:\> Get-SPContentDatabase "WSS_Content" | Get-SPContentDatabaseOrphanedData -``` -This example gets orphan objects in content database named "WSS_Content". - -## PARAMETERS - -### -Identity -Specifies the GUID of the content database to get. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -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). - - -## RELATED LINKS - - - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDeploymentJob.md deleted file mode 100644 index 94062a26f6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDeploymentJob.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPContentDeploymentJob -schema: 2.0.0 ---- - -# Get-SPContentDeploymentJob - -## SYNOPSIS -Returns a content deployment job or a collection of content deployment jobs. - -## SYNTAX - -``` -Get-SPContentDeploymentJob [[-Identity] <SPContentDeploymentJobPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Path <SPContentDeploymentPathPipeBind>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPContentDeploymentJob cmdlet reads the specified content deployment job. -If the Identity parameter is not specified, this cmdlet returns the collection of content deployment jobs on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Get-SPContentDeploymentJob -Identity 'Job 1' -``` - -This example returns the content deployment job called Job 1. - -## PARAMETERS - -### -Identity -Specifies the content deployment job to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. - -```yaml -Type: SPContentDeploymentJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies that content deployment jobs for only the specified content deployment path are returned. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. - -```yaml -Type: SPContentDeploymentPathPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDeploymentPath.md deleted file mode 100644 index 1a43df1b43..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPContentDeploymentPath.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPContentDeploymentPath -schema: 2.0.0 ---- - -# Get-SPContentDeploymentPath - -## SYNOPSIS -Returns a content deployment path or a collection of content deployment paths. - -## SYNTAX - -``` -Get-SPContentDeploymentPath [[-Identity] <SPContentDeploymentPathPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPContentDeploymentPath cmdlet reads the specified content deployment path. -If the Identity parameter is not specified, this cmdlet returns the collection of content deployment paths on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE-------------- -``` -PS C:\>Get-SPContentDeploymentPath -Identity 'Path 1' -``` - -This example returns the content deployment path named Path 1. - -## PARAMETERS - -### -Identity -Specifies the content deployment path to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment path (for example, DeployPath1); or an instance of a valid SPContentDeploymentJob object. - -```yaml -Type: SPContentDeploymentPathPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPCustomLayoutsPage.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPCustomLayoutsPage.md deleted file mode 100644 index 52dbf59f24..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPCustomLayoutsPage.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPCustomLayoutsPage -schema: 2.0.0 ---- - -# Get-SPCustomLayoutsPage - -## SYNOPSIS - -Returns a mapping to a custom layout page. - - - -## SYNTAX - -``` -Get-SPCustomLayoutsPage -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Identity <SPCustomPage>] [-CompatibilityLevel <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPCustomLayoutsPagecmdlet cmdlet returns a mapping to a custom layout page in a Web application. -If the Identity parameter is not specified, this cmdlet returns the collection of mappings for all custom layout pages. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPCustomLayoutsPage -Identity '_layouts/accessdenied.aspx' -WebApplication 'http://webappurl/' -``` - -This example returns the mapping of the AccessDenied layout page in the Web application. - -## PARAMETERS - -### -WebApplication -Specifies the SharePoint Web application that contains the custom layout page. - -The type must be a valid URL, in the form http://webAppUrl; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the custom layout page to get. - -The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted. - -```yaml -Type: SPCustomPage -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDataConnectionFile.md deleted file mode 100644 index db186acaab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDataConnectionFile.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDataConnectionFile -schema: 2.0.0 ---- - -# Get-SPDataConnectionFile - -## SYNOPSIS -Returns a data connection file or a collection of data connection files. - -## SYNTAX - -``` -Get-SPDataConnectionFile [[-Identity] <SPDataConnectionFilePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPDataConnectionFile cmdlet gets a specified data connection file or a collection of data connection files. -If the Identity parameter is not specified, the cmdlet returns the collection of data connection files for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPDataConnectionFile -``` - -This example lists the Identity, DisplayName, and WebAccessible properties ofeach .udcx file. - -### ---------------EXAMPLE 2-------------- -``` -C:\PS>"Sample.udcx" | Get-SPDataConnectionFile -``` - -This example lists the Identity, DisplayName, and WebAccessible properties of the specified file, named Sample.udcx. - -### ---------------EXAMPLE 3-------------- -``` -PS C:\>Get-SPDataConnectionFile | where {$_.Category -eq "Category1"} -``` - -This example lists the Identity, DisplayName, and WebAccessible properties of all .udcx files with the specified Category. - -## PARAMETERS - -### -Identity -Specifies the data file connection to get. - -The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. - -```yaml -Type: SPDataConnectionFilePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDataConnectionFileDependent.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDataConnectionFileDependent.md deleted file mode 100644 index 47862050c3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDataConnectionFileDependent.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDataConnectionFileDependent -schema: 2.0.0 ---- - -# Get-SPDataConnectionFileDependent - -## SYNOPSIS -Returns deployed forms on the server dependent on a universal data connection. - -## SYNTAX - -``` -Get-SPDataConnectionFileDependent [-Identity] <SPDataConnectionFilePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPDataConnectionFileDependent returns all administrator deployed forms that depend on a specified universal data connection (.udc) file located in the central data connection store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPDataConnectionFileDependant -Identity 'FileName.udcx' -``` - -This example displays a list of deployed forms with a specified name. - -## PARAMETERS - -### -Identity -Specifies the data connection file to get. - -The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. - -```yaml -Type: SPDataConnectionFilePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDatabase.md deleted file mode 100644 index 7a1b098a7b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDatabase.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDatabase -schema: 2.0.0 ---- - -# Get-SPDatabase - -## SYNOPSIS - -Retrieves all properties of a database. - - - -## SYNTAX - -### DefaultParameterSet -``` -Get-SPDatabase [[-Identity] <SPDatabasePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### ServerParameterSet -``` -Get-SPDatabase -ServerInstance <SPDatabaseServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### NameParameterSet -``` -Get-SPDatabase [-AssignmentCollection <SPAssignmentCollection>] -Name <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPDatabase cmdlet displays all public properties of a database to the current window. -If the Identity parameter is specified, only properties of that ID are displayed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Get-SPDatabase | ?{$_.TypeName -eq 'Microsoft.Office.Server.Administration.ProfileDatabase'} -``` - -This example gets the Profile database used by the User Profile Service Application. - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Get-SPDatabase -Name 'Profile DB' -``` - -This example gets the Profile database by name. Applies to SharePoint Server 2016, SharePoint Server 2019 only. - -## PARAMETERS - -### -Identity -Specifies the name of the database to display public properties. - -The type must be a valid GUID, in the form 1234-3456-567kg. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerInstance -Specifies the name of the SQL instance that contains the database in either the form "Server" for a default SQL instance or "Server\Instance" for a named SQL instance. - -```yaml -Type: SPDatabaseServiceInstancePipeBind -Parameter Sets: ServerParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the database. - -```yaml -Type: String -Parameter Sets: NameParameterSet -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDeletedSite.md deleted file mode 100644 index a95d251ace..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDeletedSite.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDeletedSite -schema: 2.0.0 ---- - -# Get-SPDeletedSite - -## SYNOPSIS - -Gets a list of deleted site collections. - - - -## SYNTAX - -``` -Get-SPDeletedSite [-Identity] <SPDeletedSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-ContentDatabase <SPContentDatabasePipeBind>] [-DateTimeFrom <String>] [-DateTimeTo <String>] - [-Limit <String>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the Get-SPDeletedSite cmdlet to display a list of deleted site collections by using the Identity parameter. -If no parameter is specified, then all deleted site collections in the farm are displayed. - -Unlike the Get-SPSite cmdlet that uses the host name and scheme for the Identity parameter (that is, http://server_name), the value of the identity parameter for all SPDeletedSite cmdlets use a server-relative URL. -Typically, the forward slash character (/) begins the relative URL and also denotes the root site. - -For additional information about a server-relative URL or understanding general concepts about absolute and relative URLs, see Server-relative URL Property (http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spsite.serverrelativeurl.aspx) or Understanding Absolute and Relative URL Addresses (http://msdn.microsoft.com/en-us/library/bb208688(office.12).aspx). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1--------------------- -``` -PS C:\>Get-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c -``` - -This example gets a specific deleted site collection by using a site ID. - -### ------------------EXAMPLE 2--------------------- -``` -PS C:\>Get-SPDeletedSite "/" -``` - -This example gets a deleted site collection from the root site. - -### ------------------EXAMPLE 3--------------------- -``` -PS C:\>Get-SPDeletedSite '/Site/cat*' -``` - -This example matches a deleted site collection that contains any combination with the string "cat". -The asterisk (*) wildcard character requests a match for multiple characters. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site collection to get. - -The identity can be either a valid server-relative URL in the form /sites/site_name or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPDeletedSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the GUID of the content database from which to list site collections. - -The type must be a valid database name in the form SPContentDB01 or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DateTimeFrom -The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateTimeTo -The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Limits the maximum number of site collections to return. -The default value is 1000. - -The type must be a valid non-negative number. -Specify ALL to return all site collections for the given scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site subscription from which to get site collections. - -The type must be a valid URL in the form http://server_name or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the Web application from which to list sites. - -The type must be a valid URL in the form http://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDesignerSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDesignerSettings.md deleted file mode 100644 index 17d4a953bd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDesignerSettings.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDesignerSettings -schema: 2.0.0 ---- - -# Get-SPDesignerSettings - -## SYNOPSIS - -Displays SharePoint Designer features. - - - -## SYNTAX - -``` -Get-SPDesignerSettings [-WebApplication] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPDesignerSettings cmdlet determines whether SharePoint Designer features are enabled on the specified Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE------------------------ -``` -PS C:\>Get-SPDesignerSettings -webapplication http://contoso -``` - -This example retrieves the SharePoint Designer settings for the Web application, http://contoso. - -## PARAMETERS - -### -WebApplication -Specifies the Web application in which the settings apply. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticConfig.md deleted file mode 100644 index 16138ec367..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticConfig.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDiagnosticConfig -schema: 2.0.0 ---- - -# Get-SPDiagnosticConfig - -## SYNOPSIS - -Retrieves ULS diagnostic configuration values of the farm. - - - -## SYNTAX - -``` -Get-SPDiagnosticConfig [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPDiagnoticConfig cmdlet retrieves ULS diagnostic configuration values of the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPDiagnosticConfig -``` - -This example returns all diagnostic configuration values. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticsPerformanceCounter.md deleted file mode 100644 index 054a20fc66..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticsPerformanceCounter.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDiagnosticsPerformanceCounter -schema: 2.0.0 ---- - -# Get-SPDiagnosticsPerformanceCounter - -## SYNOPSIS - -Returns a collection of performance counters. - - - -## SYNTAX - -``` -Get-SPDiagnosticsPerformanceCounter [-AssignmentCollection <SPAssignmentCollection>] [-DatabaseServer] - [-WebFrontEnd] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPDiagnosticsPerformanceCounter cmdlet returns the collection of performance counters that are read and recorded in the usage database. -If neither the DatabaseServer or WebFrontEnd parameters are specified, this cmdlet returns the performance counters on the front end Web servers and database servers in the farm. - -To distinguish counters that are collected on database servers and counters that are collected on front end Web servers, note that counters that are collected on database servers have a Provider Name of job-diagnostics-performance-counter-sql-provider, and counters that are collected on front end Web servers have a Provider Name of job-diagnostics-performance-counter-wfe-provider. - -The Get-SPDiagnosticsPerformanceCounter cmdlet is only available by using Windows PowerShell. -There is no user interface. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPDiagnosticsPerformanceCounter -``` - -This example gets the performance counter settings for front end Web servers and database servers. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPDiagnosticsPerformanceCounter -WebFrontEnd -``` - -This example gets the performance counter settings for front end Web servers. - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>Get-SPDiagnosticsPerformanceCounter -DatabaseServer -``` - -This example gets the performance counter settings for database servers. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseServer -Returns performance counters collected for the database servers in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebFrontEnd -Returns performance counters collected for the front end Web servers in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticsProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticsProvider.md deleted file mode 100644 index 61e8f512a9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDiagnosticsProvider.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDiagnosticsProvider -schema: 2.0.0 ---- - -# Get-SPDiagnosticsProvider - -## SYNOPSIS - -Returns a diagnostics provider. - - - -## SYNTAX - -``` -Get-SPDiagnosticsProvider [[-Identity] <SPDiagnosticsProviderPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPDiagnosticsProvider cmdlet reads the specified diagnostics provider. -If the Identity parameter is not specified, this cmdlet returns the collection diagnostics providers in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPDiagnosticsProvider -``` - -This example returns all the diagnostics providers in the farm. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider -``` - -This example returns the event log diagnostics provider. - -## PARAMETERS - -### -Identity -Specifies the diagnostics provider to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticsProv1); or an instance of a valid SPDiagnosticsProvider object. - -```yaml -Type: SPDiagnosticsProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDistributedCacheClientSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDistributedCacheClientSetting.md deleted file mode 100644 index b07e4f775b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPDistributedCacheClientSetting.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPDistributedCacheClientSetting -schema: 2.0.0 ---- - -# Get-SPDistributedCacheClientSetting - -## SYNOPSIS - -Returns distributed cache settings from usage. - - - -## SYNTAX - -``` -Get-SPDistributedCacheClientSetting [-ContainerType] <SPDistributedCacheContainerType> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPDistributedCacheClientSettings cmdlet to return distributed cache settings from usage. -Usage can be any type of cache that the ContainerType parameter specifies. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE-------- -``` -PS C:\>Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache -``` - -This example returns the Distributed Cache client settings for DistributedLogonTokenCache. - -## PARAMETERS - -### -ContainerType - -Specifies the container type to clear. - -The valid values are the following: - --DistributedDefaultCache - --DistributedAccessCache - --DistributedActivityFeedCache - --DistributedBouncerCache - --DistributedLogonTokenCache - --DistributedServerToAppServerAccessTokenCache - --DistributedSearchCache - --DistributedSecurityTrimmingCache - --DistributedActivityFeedLMTCache - --DistributedViewStateCache - - - -```yaml -Type: SPDistributedCacheContainerType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPDistributedCacheClientSetting](Set-SPDistributedCacheClientSetting.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEduServiceSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEduServiceSetting.md deleted file mode 100644 index 9b74de04d6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEduServiceSetting.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Get-SPEduServiceSetting -schema: 2.0.0 ---- - -# Get-SPEduServiceSetting - -## SYNOPSIS -Do not use - -## SYNTAX - -``` -Get-SPEduServiceSetting [-Service] <Services> [-AssignmentCollection <SPAssignmentCollection>] - -Site <SPSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - -## EXAMPLES - -### Example 1 -``` -Do not use -``` - - - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Service -Do not use - -```yaml -Type: Services -Parameter Sets: (All) -Aliases: -Accepted values: Lync, Exchange, StudyGroup -Applicable: SharePoint Server 2013 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchAdministrationComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchAdministrationComponent.md deleted file mode 100644 index 50d011bee4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchAdministrationComponent.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchAdministrationComponent -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchAdministrationComponent - -## SYNOPSIS -Returns the administration component for a search service application. - -## SYNTAX - -``` -Get-SPEnterpriseSearchAdministrationComponent [-AssignmentCollection <SPAssignmentCollection>] - -SearchApplication <SearchServiceApplicationPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchAdmininstrationComponent cmdlet retrieves an administration component for a search service application in order to update or delete it. - -For permissions and the most current information about search cmdlets, see the online documentation, [https://go.microsoft.com/fwlink/?LinkId=163185](https://go.microsoft.com/fwlink/?LinkId=163185). - -## EXAMPLES - -### Example 1 -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>et-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa -``` - -This example obtains an object reference to the administration component of a search service application named Search Service Application. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the administration component. - -The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -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 - -### Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchComponent.md deleted file mode 100644 index 7d570edd46..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchComponent.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchComponent -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchComponent - -## SYNOPSIS - -Retrieves one or all search components in a given search topology.. - - - -## SYNTAX - -``` -Get-SPEnterpriseSearchComponent [[-Identity] <SearchComponentPipeBind>] - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the search component with the specified identity from the given search topology. -If an identity is not provided, all search components in the given search topology will be retrieved. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b6155525' -Identity '06e6651d-ecdd-4105-bb65-6a83b6155525' -SearchApplication $ssa -``` - -This example retrieves the search component with the identity 06e6651d-ecdd-4105-bb65-6a83b6155525 from the search topology with identity 56e6651d-ecdd-4105-bb65-6a83b6155525 in the search service application referenced by $ssa. - -### ------------------EXAMPLE 2----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b6155525' -SearchApplication $ssa -``` - -This example retrieves all search components from the search topology with the identity 56e6651d-ecdd-4105-bb65-6a83b6155525 in the search service application referenced by $ssa. - -## PARAMETERS - -### -Identity -Specifies the identity for a search component. - -```yaml -Type: SearchComponentPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology from which to retrieve the search component/search components. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology and search component/search components. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md deleted file mode 100644 index 527e630c0b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchContentEnrichmentConfiguration -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchContentEnrichmentConfiguration - -## SYNOPSIS - -Returns the content enrichment configuration for the specified search service application. - - - -## SYNTAX - -``` -Get-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the ContentEnrichmentConfiguration object for the SearchServiceApplication. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -``` - -This example retrieves the ContentEnrichmentConfiguration object from the default SearchServiecApplication. - -## PARAMETERS - -### -SearchApplication -Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPEnterpriseSearchContentEnrichmentConfiguration](Set-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[New-SPEnterpriseSearchContentEnrichmentConfiguration](New-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[Remove-SPEnterpriseSearchContentEnrichmentConfiguration](Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlContentSource.md deleted file mode 100644 index 524dca209d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlContentSource.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlContentSource -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlContentSource - -## SYNOPSIS -Returns a crawl content source. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlContentSource [[-Identity] <ContentSourcePipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchCrawlContentSource cmdlet reads the content source when the rules of content source are created, updated, or deleted, or reads a CrawlContentSource object when the search functionality is initially configured and after any new content source is added. - -If the Identity parameter is not specified, this cmdlet returns the content source collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchCrawlContentSource -SearchApplication $ssa -Identity 'Local SharePoint Sites' -``` - -This example retrieves the default content source for the search service application, 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the content source to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. - -```yaml -Type: ContentSourcePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the content source. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlCustomConnector.md deleted file mode 100644 index 407d9de103..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlCustomConnector.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlCustomConnector -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlCustomConnector - -## SYNOPSIS -Returns a CustomConnector object type. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Protocol <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Identity parameter displays a custom connector for a specified Web application. -If no parameters are specified, all the objects of the CustomConnector object type are returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE---------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication $ssa -Protocol 'http://' -``` - -This example obtains a reference to all custom crawl connectors for the http:// protocol for a search service application named 'Search Service Application'. - -## PARAMETERS - -### -SearchApplication -Specifies the Search application with which the CustomConnector objects are associated. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the string version of the protocol for which to return the CustomConnector object, for example, "dctm://" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlDatabase.md deleted file mode 100644 index b31f5ee5c6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlDatabase.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlDatabase -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlDatabase - -## SYNOPSIS -Returns a crawl store. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlDatabase [[-Identity] <CrawlStorePipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchCrawlDatabase cmdlet returns a CrawlStore object for use during configuration and when a crawl database for a search service application is modified or deleted. -A crawl database stores crawl history data for a search service application. - -If the Identity parameter is not specified, this cmdlet returns the crawl database collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE------------------- -``` -PS C:\>Get-SPEnterpriseSearchCrawlDatabase -SearchApplication 'Search Service Application' -Identity CrawlDB_1 -``` - -This example gets a reference to the crawl database CrawlDB_1 from the search service application named 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the crawl database to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a CrawlStore object, in the form CrawlStore1; or an instance of a valid CrawlStore object. - -```yaml -Type: CrawlStorePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl database. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlExtension.md deleted file mode 100644 index 5545ce899e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlExtension.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlExtension -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlExtension - -## SYNOPSIS -Returns the file types to be included in the content index. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlExtension [[-Identity] <ExtensionPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchCrawlExtension cmdlet returns any or all file extensions in the index for a search application. - -Run this cmdlet at the initial search configuration, and after any new IFilter interface is added to read the rule when you create, update, or delete the extension rule. -If the Identity parameter is not specified, this cmdlet returns the crawl extension collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### Add code example. -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchCrawlExtension -Identity 'pdf' -SearchApplication $ssa -``` - -This example checks whether the pdf file type is included in the file types to be included in the content index. - -## PARAMETERS - -### -Identity -Specifies the file name extension to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid file name extension (for example, .xml); or an instance of a valid CrawlExtension object. - -```yaml -Type: ExtensionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the extension collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlLogReadPermission.md deleted file mode 100644 index 93162943df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlLogReadPermission.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlLogReadPermission -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlLogReadPermission - -## SYNOPSIS -Retrieves the list of users with permission to access the crawl log information. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -Only the Search Service Application administrator can use the Get-SPEnterpriseSearchCrawlLogReadPermission cmdlet. - -The Search Service Application administrator uses the cmdlet to retrieve a list of users with permission to view the crawl log information. -The administrator can choose to limit this list to users with permission to view crawl log information from a particular tenant. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant '00000000-0000-0000-0000-000000000001' -``` - -This example retrieves a list of users who have permission to view the crawl log information for a tenant with id '00000000-0000-0000-0000-000000000001' on the search application referenced by `$ssa`. - -## PARAMETERS - -### -SearchApplication -Specifies the name of the search application for which to list crawl log permissions. -The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the list of users shall be within the scope of this tenant. -The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPEnterpriseSearchCrawlLogReadPermission](Set-SPEnterpriseSearchCrawlLogReadPermission.md) - -[Remove-SPEnterpriseSearchCrawlLogReadPermission](Remove-SPEnterpriseSearchCrawlLogReadPermission.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlMapping.md deleted file mode 100644 index 3fa5f87c63..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlMapping.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlMapping -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlMapping - -## SYNOPSIS -Returns a crawl mapping for the search application. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlMapping [[-Identity] <CrawlMappingPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchCrawlMapping cmdlet reads a CrawlMapping object when one of the crawl mapping rules is created, updated, or deleted. -Run this cmdlet when the search is initially configured, and when access is changed through a different mechanism to create the crawl mapping rule; for example, when a rule is changed to use file:\\\\ rather than http://. - -If the Identity parameter is not specified, this cmdlet returns the crawl mapping collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------ EXAMPLE ------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchCrawlMapping -SearchApplication $ssa -``` - -This example returns the crawl mappings for the search application 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the crawl mapping to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://crawlmap1; or an instance of a valid CrawlMapping object. - -```yaml -Type: CrawlMappingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl mapping collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlRule.md deleted file mode 100644 index c7dc5964e7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchCrawlRule.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchCrawlRule -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchCrawlRule - -## SYNOPSIS -Accesses crawl rules. - -## SYNTAX - -``` -Get-SPEnterpriseSearchCrawlRule [[-Identity] <CrawlRulePipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPEnterpriseSearchCrawlRule cmdlet for a search administrator to run this procedure to retrieve the crawl rule when the crawl rule is updated or deleted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Identity http://webAppUrl -``` - -This example uses the `Get-SPEnterpriseSearchCrawlRule` cmdlet to retrieve a crawl rule. - -### ---------------EXAMPLE 2--------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchCrawlRule -SearchApplication $searchApp | ?{$_.Path -like '*example*'} -``` - -This example returns a list of crawl rules with paths that contain the word example from the search service application named 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the search crawl rule path. - -A valid URL, such as "http://webappurl/", or an instance of a valid CrawlRule object - -```yaml -Type: CrawlRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl rule. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchFileFormat.md deleted file mode 100644 index 386c9980d6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchFileFormat.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchFileFormat -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchFileFormat - -## SYNOPSIS - -Retrieves all parseable file formats. - - - -## SYNTAX - -``` -Get-SPEnterpriseSearchFileFormat [[-Identity] <DocumentParserFileFormatPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION - -The Get-SPEnterpriseSearchFileFormat cmdlet returns the file format information for a given format ID. -If no format ID is provided, the cmdlet returns all the parseable file formats. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### -------------EXAMPLE 1------------- -``` -C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication -Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa -``` - -This example uses the Get-SPEnterpriseSearchFileFormat to retrieve all parseable file formats in the search service application referenced by $ssa. - -### -------------EXAMPLE 2------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity DOCX -``` - -This example uses the Get-SPEnterpriseSearchFileFormat cmdlet to retrieve information about the file format DOCX in the search service application referenced by `$ssa`. - -## PARAMETERS - -### -Identity -Specifies the format ID for which to retrieve file format information. - -```yaml -Type: DocumentParserFileFormatPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication - -Specifies the search application for which to retrieve file format information. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchFileFormat](New-SPEnterpriseSearchFileFormat.md) - -[Set-SPEnterpriseSearchFileFormatState](Set-SPEnterpriseSearchFileFormatState.md) - -[Remove-SPEnterpriseSearchFileFormat](Remove-SPEnterpriseSearchFileFormat.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchHostController.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchHostController.md deleted file mode 100644 index 6a309ad7c9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchHostController.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchHostController -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchHostController - -## SYNOPSIS -Lists the specified or all search host controllers in the farm. - -## SYNTAX - -``` -Get-SPEnterpriseSearchHostController [-AssignmentCollection <SPAssignmentCollection>] - [-SearchServiceInstance <SearchServiceInstancePipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet lists the specified or all SearchHostControllers in the farm. -The SearchHostController is related to the SearchServiceInstance, where the SearchHostController manages the search components that run on a server, and maintains a local repository for linguistic dictionaries. -The search components retrieve the linguistic dictionaries from the PrimaryHostController. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPEnterpriseSearchHostController -``` - -This example retrieves a list of all HostControllers in the farm with their status (primary/secondary) and repository version. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssi = Get-SPEnterpriseSearchServiceInstance -Local -PS C:\>Get-SPEnterpriseSearchHostController -SearchServiceInstance $ssi -``` - -This example retrieves the status information for the SearchHostController on the local server. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchServiceInstance -The Search Service instance of the server from where the SearchHostController object is returned. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLanguageResourcePhrase.md deleted file mode 100644 index 4b69bbc568..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLanguageResourcePhrase.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchLanguageResourcePhrase -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchLanguageResourcePhrase - -## SYNOPSIS -Returns a language resource phrase. - -## SYNTAX - -``` -Get-SPEnterpriseSearchLanguageResourcePhrase [-AssignmentCollection <SPAssignmentCollection>] - [-Identity <LanguageResourcePhrasePipeBind>] [-Language <String>] [-Mapping <String>] - -Owner <SearchObjectOwner> -SearchApplication <SearchServiceApplicationPipeBind> [-SourceId <Guid>] - [-Type <LanguageResourceType>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchLanguageResourcePhrase cmdlet reads a LanguageResourcePhrase object when the language resource phrase is created or deleted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language 'en-us' -Type QuerySuggestionBlockList -``` - -This example returns all language resource entries for the en-us language in the QuerySuggestionBlockList type. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity - -Specifies the language resource phrase to get. - -The type must be a string; a valid name of a language resource phrase (for example, LanguageResourcePhrase1); or an instance of a valid LanguageResourcePhrase object. - - - -```yaml -Type: LanguageResourcePhrasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language - -Filters to return phrases of a specified source language. - -The type must be a valid name of a language; for example, en-us or ja-jp. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mapping - -Allows a term or phrase to be mapped to another term or phrase. -For example, the nickname "John" could be mapped to "Jonathan". - -This parameter only applies to nicknames and substitutions. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner - -Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. - -The owner must be one of the following valid levels: - -- Search Service Application -- Site Subscription -- Site Collection -- Site - - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication - -Specifies the search application that contains the language resources. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SourceId - -Identifies the search result source for which the LanguageResourcePhrase applies to. - - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type - -Filters to return phrases of a specified type. - -The type must be one of the following valid types of phrases: - -- QuerySuggestionBlockList -- QuerySuggestionAlwaysSuggest -- Nickname -- QuerySuggestionSubstitution - - - -```yaml -Type: LanguageResourceType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLinguisticComponentsStatus.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLinguisticComponentsStatus.md deleted file mode 100644 index 97020ca4e9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLinguisticComponentsStatus.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchLinguisticComponentsStatus -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchLinguisticComponentsStatus - -## SYNOPSIS -Returns the status of the linguistic query and document processing components. - -## SYNTAX - -``` -Get-SPEnterpriseSearchLinguisticComponentsStatus [[-Identity] <LinguisticComponentsStatusPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns an object that represents the operational status of the linguistic query and document processing components. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -``` - -This example gets the current status of the linguistic query and document processing components from the default SearchServiceApplication. - -## PARAMETERS - -### -Identity -An object that represents the current status of the linguistic components. - -```yaml -Type: LinguisticComponentsStatusPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the linguistic processing components. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPEnterpriseSearchLinguisticComponentsStatus](Set-SPEnterpriseSearchLinguisticComponentsStatus.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLinksDatabase.md deleted file mode 100644 index c1cfe5c06e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchLinksDatabase.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchLinksDatabase -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchLinksDatabase - -## SYNOPSIS -Retrieves a reference to a links database. - -## SYNTAX - -``` -Get-SPEnterpriseSearchLinksDatabase [[-Identity] <LinksStorePipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchLinksDatabase cmdlet returns a LinksStore object for use during configuration and when a links database for a search service application is modified or deleted. -A links database stores query logging and search analytics data for a search service application. -If the Identity parameter is not specified, this cmdlet returns all links databases for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------EXAMPLE--------- -``` -PS C:\>Get-SPEnterpriseSearchLinksDatabase -Identity LinksDB_1 -SearchApplication 'Search Service Application' -``` - -This example gets a reference to the links database LinksDB_1 from the search service application 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the links database to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. - -```yaml -Type: LinksStorePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the links database. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchLinksDatabase](New-SPEnterpriseSearchLinksDatabase.md) - -[Set-SPEnterpriseSearchLinksDatabase](Set-SPEnterpriseSearchLinksDatabase.md) - -[Remove-SPEnterpriseSearchLinksDatabase](Remove-SPEnterpriseSearchLinksDatabase.md) - -[Move-SPEnterpriseSearchLinksDatabases](Move-SPEnterpriseSearchLinksDatabases.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataCategory.md deleted file mode 100644 index bb3ffb38c3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataCategory.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchMetadataCategory -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchMetadataCategory - -## SYNOPSIS -Returns a crawled property category. - -## SYNTAX - -``` -Get-SPEnterpriseSearchMetadataCategory [[-Identity] <CategoryPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-SiteCollection <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads a MetadataCategory object when the category is created, updated, or deleted. -You should run this cmdlet when the initial search is configured, and after a new crawled property category is discovered during a crawl. -SPEnterpriseSearchMetadataCategory represents a category in the enterprise search metadata property schema. - -If the Identity parameter is not specified, this cmdlet returns the metadata category collection for the specified search service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -``` - -This example retrieves the metadata category collection of a search service application for the default search service application. - -## PARAMETERS - -### -Identity -Specifies the metadata category to retrieve. - -The type must a valid search application name, for example, MetadataCategory1, or an instance of a valid Category object. - -```yaml -Type: CategoryPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the enterprise search metadata categories. - -The type must a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the metadata categories returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the metadata categories returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataCrawledProperty.md deleted file mode 100644 index c6665b9a40..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataCrawledProperty.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchMetadataCrawledProperty -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchMetadataCrawledProperty - -## SYNOPSIS -Returns a crawled property. - -## SYNTAX - -``` -Get-SPEnterpriseSearchMetadataCrawledProperty [-AssignmentCollection <SPAssignmentCollection>] - [-Category <CategoryPipeBind>] [-Limit <String>] [-Name <String>] [-PropSet <Guid>] - -SearchApplication <SearchServiceApplicationPipeBind> [-SiteCollection <Guid>] [-Tenant <Guid>] - [-VariantType <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads a CrawledProperty object for a crawled property that was created or updated. -You should run this cmdlet when the search functionality is configured for the first time, and after new crawled properties are discovered during a crawl. -If the Name parameter is not specified, this cmdlet returns all crawled properties for the specified category for the specified search application. -If neither the Name nor the Category parameter is specified, this cmdlet returns all crawled properties for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People -PS C:\>Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Category $cat -Limit 1 -``` - -This example returns the first crawled property in the PeopleSearch_Scope metadata category for the default search service application. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Specifies the metadata category of the crawled property to return. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - -```yaml -Type: CategoryPipeBind -Parameter Sets: (All) -Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit - -Specifies the maximum number of items to return. - -Specify ALL to return all possible results. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the crawled property to retrieve. - -The type must be a valid crawled property name, for example "urn:schemas-microsoft-com:sharepoint:portal:profile:UserName" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropSet - -Specifies to return crawled properties that use the specified property set. -A property set belongs to one crawled property category. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication - -Specifies the search application that contains the crawled property. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteCollection - -Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -Specifies that the crawled properties returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VariantType - -Specifies to return crawled properties that use the specified variant type. - -The type must be an integer that specifies the variant data type of the property set. - - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: vt -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataManagedProperty.md deleted file mode 100644 index f670eb7a9f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataManagedProperty.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchMetadataManagedProperty -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchMetadataManagedProperty - -## SYNOPSIS -Returns a managed property. - -## SYNTAX - -``` -Get-SPEnterpriseSearchMetadataManagedProperty [[-Identity] <ManagedPropertyPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Limit <String>] [-SiteCollection <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads a ManagedProperty object for managed properties that are created or updated. - -If the Identity parameter is not specified, this cmdlet returns the managed property collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName -``` - -This example retrieves the managed property UserName from the default search service application. - -## PARAMETERS - -### -Identity -Specifies the managed property to retrieve. - -The type must be a valid name of metadata property, for example MetadataProperty1, or an instance of a valid ManagedProperty object. - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the managed property collection. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Limit -Specifies the maximum number of managed properties to return. -Specify ALL to return all possible results. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the managed properties returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataMapping.md deleted file mode 100644 index 1301ccb384..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchMetadataMapping.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchMetadataMapping -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchMetadataMapping - -## SYNOPSIS -Returns the current status of a managed property mapping. - -## SYNTAX - -``` -Get-SPEnterpriseSearchMetadataMapping -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CrawledProperty <CrawledPropertyPipeBind>] - [-ManagedProperty <ManagedPropertyPipeBind>] [-SiteCollection <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads a Mapping object when a managed property mapping is created, updated, or deleted. -SPEnterpriseSearchMetadataMapping represents a category of a mapping between a managed property and one or more crawled properties in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName -PS C:\>Get-SPEnterpriseSearchMetadataMapping -SearchApplication $ssa -ManagedProperty $mp -``` - -This example lists all crawled properties mapped to the managed property UserName for the default search service application. - -## PARAMETERS - -### -SearchApplication -Specifies the search application that contains the metadata mapping. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CrawledProperty -Specifies the crawled property from which to return mappings. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form http://server_name, or an instance of a valid CrawledProperty object. - -```yaml -Type: CrawledPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -Specifies the managed property from which to return mappings. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the metadata mappings returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the metadata mappings returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchOwner.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchOwner.md deleted file mode 100644 index c723a3b862..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchOwner.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchOwner -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchOwner - -## SYNOPSIS -Retrieves the search object owner. - -## SYNTAX - -``` -Get-SPEnterpriseSearchOwner [[-Identity] <SearchObjectOwner>] -Level <SearchObjectLevel> - [-AssignmentCollection <SPAssignmentCollection>] [-SPWeb <SPWebPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchOwner cmdlet retrieves the search object owner. -Get-SPEnterpriseSearchOwner provides scoping context to other cmdlets such as SPEnterpriseSearchResultItemType. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>Get-SPEnterpriseSearchOwner -Level SPSite -``` - -This example shows how to retrieve the tenant owner of a search object at the SPSite level. - -## PARAMETERS - -### -Identity -Specifies the search object owner to retrieve. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Level -Specifies whether the owner object resides at the SPWeb, SPSite, SPSite Subscription, or SSA level. - -```yaml -Type: SearchObjectLevel -Parameter Sets: (All) -Aliases: l -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SPWeb -Specifies the SPWeb or SPSite in which this object resides. -It is only needed if Level is equal to SPWeb or SPSite. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchPropertyRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchPropertyRule.md deleted file mode 100644 index d8d0661edf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchPropertyRule.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchPropertyRule -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchPropertyRule - -## SYNOPSIS -Returns a property rule instance, which can be used in result item types. - -## SYNTAX - -``` -Get-SPEnterpriseSearchPropertyRule [-PropertyName] <String> [-Operator] <DefaultOperator> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchPropertyRule cmdlet returns an instance of a property rule, given the specified condition. -The value for the condition is set in a separate step. -Such a rule can be used in result item types, to group the results based on the condition of a result property. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>$rule = Get-SPEnterpriseSearchPropertyRule -PropertyName 'ContentTypeId' -Operator 'StartsWith' -PS C:\>$rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') -``` - -This example returns a rule for the property "ContentTypeId", where the condition is that the property shall start with a specific value. - -The second step specifies the value that the property shall start with. - -## PARAMETERS - -### -PropertyName -Specifies the name of the property that the rule concerns. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operator -Specifies the operation to apply to the property, for example "Starts with". - -```yaml -Type: DefaultOperator -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchPropertyRuleCollection](Get-SPEnterpriseSearchPropertyRuleCollection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchPropertyRuleCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchPropertyRuleCollection.md deleted file mode 100644 index 0e8a330c82..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchPropertyRuleCollection.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchPropertyRuleCollection -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchPropertyRuleCollection - -## SYNOPSIS -Returns the collection of rules that are applied to search results. - -## SYNTAX - -``` -Get-SPEnterpriseSearchPropertyRuleCollection [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchPropertyRuleCollection cmdlet returns the collection of rules that are applied to search results. -Rules can be added and removed from the rule collection. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>$rule = Get-SPEnterpriseSearchPropertyRule -PropertyName 'ContentTypeId' -Operator 'StartsWith' -PS C:\>$rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') -PS C:\>$ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection -PS C:\>$ruleCollection.Add($rule) -``` - -This example returns a rule for the result property "ContentTypeId", the rule specifies that this property must start with the value "0x010063C2F478ACC511DFB869B5BFDFD720851252". - -Thereafter the example returns the rule collection, and adds the rule to the rule collection. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchPropertyRule](Get-SPEnterpriseSearchPropertyRule.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md deleted file mode 100644 index 0e6cc9aa88..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryAndSiteSettingsService -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryAndSiteSettingsService - -## SYNOPSIS -Returns the search manager service. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryAndSiteSettingsService [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryAndSiteSettingsService cmdlet returns a manager service. -A manager service is the endpoint for the search service application to process queries and site administration requests from the search service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$qssService = Get-SPEnterpriseSearchQUeryAndSiteSettingsService -``` - -This example obtains a reference to the query and site settings service. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md deleted file mode 100644 index 3336c5798f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance - -## SYNOPSIS -Returns the service manager service instance. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance - [[-Identity] <SearchQueryAndSiteSettingsServiceInstancePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Local] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance cmdlet returns the service manager service instance when a search manager service is started or stopped. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -C:\PS>$qqssSvcInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local -``` - -This example obtain a reference to the query and site setting service instance on the local farm. - -### ------------------EXAMPLE 2------------------ -``` -C:\PS>$qssSvcInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity myServer -``` - -This example obtain a reference to the query and site setting service instance from a specific server name. - -## PARAMETERS - -### -Identity -Specifies the search manager service instance to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid server name on which search manager service instance runs; or an instance of a valid SearchManagerServiceInstance object. - -```yaml -Type: SearchQueryAndSiteSettingsServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Local -Specifies that the service manager service instance for the current search server is returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md deleted file mode 100644 index c1b873038f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy - -## SYNOPSIS -Returns the search manager service proxy. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy cmdlet reads the SearchQueryAndSiteSettingsServiceProxy object when a search Web service manager service is started or stopped. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$qssSvcProxy = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy -``` - -This example obtains a reference to the query and site settings service proxy. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAuthority.md deleted file mode 100644 index 93c260f8c9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryAuthority.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryAuthority -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryAuthority - -## SYNOPSIS -Returns an authoritative page. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryAuthority [[-Identity] <AuthorityPagePipeBind>] -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryAuthority cmdlet reads a QueryAuthority object when the authoritative page is created or deleted or when the query rank is modified. - -If the Identity parameter is not specified, this cmdlet returns the authority page collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchQueryAuthority -Identity 'http://contoso.com/' -SearchApplication $ssa -``` - -This example obtains the authoritative page for the URL http://contoso.com from the search service application named 'Search Service Application'. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPEnterpriseSearchQueryAuthority -SearchApplication 'Search Service Application' -``` - -This example obtains the collection of query authority pages from a search service application named 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the query authority to get. - -The type must be a valid URL, in the form http://server_name; or an instance of a valid AuthorityPage object. - -```yaml -Type: AuthorityPagePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Query Authority is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the authority page to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryDemoted.md deleted file mode 100644 index 96e4fb3436..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryDemoted.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryDemoted -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryDemoted - -## SYNOPSIS -Returns a demoted site rule. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryDemoted [[-Identity] <DemotedPipeBind>] -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryDemoted cmdlet reads the DemotedSite object when a demoted site rule is created or deleted, or when the demoted site rule is updated to modify the query rank. - -If the Identity parameter is not specified, this cmdlet returns the demoted site rule collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$demotedRule = Get-SPEnterpriseSearchQueryDemoted -Identity http://somesite.com -SearchApplication 'Search Service Application' -PS C:\>Remove-SPEnterpriseSearchQueryDemoted -Identity $demotedRule -SearchApplication 'Search Service Application' -``` - -This example obtains a reference to a site demotion rule for the URL http://somesite.com, and removes it. - -## PARAMETERS - -### -Identity -Specifies the demoted site rule to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance a valid Demoted object. - -```yaml -Type: DemotedPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Demoted object is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the demoted site rule collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryKeyword.md deleted file mode 100644 index f6f489eef8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryKeyword.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryKeyword -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryKeyword - -## SYNOPSIS -Returns a keyword term. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryKeyword [[-Identity] <KeywordPipeBind>] -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryKeyword cmdlet reads a QueryKeyword object when the keyword rule is created, updated, or deleted. - -If the Identity parameter is not specified, this cmdlet returns the query keyword collection from the specified search application. - -You can use this cmdlet for keywords in site collections that are in SharePoint Server mode. -You cannot use this cmdlet after a site collection is upgraded to SharePoint Server mode because keywords and Best Bets are automatically migrated to query rules. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site http://myserver/sites/engineering | Set-SPEnterpriseSearchQueryKeyword -StartDate "12/25/2009" -EndDate "12/24/2010" -Site http://myserver/sites/engineering -``` - -This example gets a reference to the keyword with the term Engineering from the site http://myserver/sites/engineering and sets the start dates and end dates for the keyword. - -## PARAMETERS - -### -Identity -Specifies the keyword term to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. - -```yaml -Type: KeywordPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Filters to return keywords with the specified results URL. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryScope.md deleted file mode 100644 index 968a8df42d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryScope.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryScope -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryScope - -## SYNOPSIS -Returns a query results scope. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryScope [[-Identity] <ScopePipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Url <Uri>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryScope cmdlet reads a QueryScope object when the shared scope is created or deleted, or when the definition of the shared scope is updated. - -If the Identity parameter is not specified, this cmdlet returns the query scope collection from the specified search application. - -In SharePoint Server, result sources provide the functionality that scopes provided in SharePoint Server. - -During an upgrade from SharePoint Server, to retain legacy settings, shared scopes are automatically migrated. -However, these scopes are read-only after the migration. -This cmdlet can be used to read a shared scope that has been migrated. - -During an upgrade from SharePoint Server, to preserve legacy settings, local scopes are also automatically migrated when the corresponding sites or site collections are migrated. -In a SharePoint Server farm, the scopes of a site or site collection that is in SharePoint Server mode are read-write, whereas the scopes of a site or site collection after upgrade to SharePoint Server mode are read-only. -This cmdlet can be used to read a migrated local scope in either situation. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPenterpriseSearchServiceApplication -Identity 'Search service Application' -PS C:\>Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage http://altServer -``` - -This example obtains a reference to the scope named MustCrawl on the search application named MySSA, and changes the description, compilation type, and alternate access URL. - -## PARAMETERS - -### -Identity -Specifies the results scope to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Filters to return scopes for the specified results URL. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryScopeRule.md deleted file mode 100644 index d3e625e827..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQueryScopeRule.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQueryScopeRule -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQueryScopeRule - -## SYNOPSIS -Returns a shared scope rule. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQueryScopeRule [[-Identity] <ScopeRulePipeBind>] -Scope <ScopePipeBind> [-Url <Uri>] - [-AssignmentCollection <SPAssignmentCollection>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchQueryScopeRule cmdlet reads a QueryScopeRule object when the shared scope rule is created, updated, or deleted. -SPEnterpriseSearchQueryScopeRule represents a query result scope rule that can be applied to a scope. - -In SharePoint Server, result sources provide the functionality that scopes provided in SharePoint Server. - -During an upgrade from SharePoint Server, to retain legacy settings, shared scopes are automatically migrated. -However, these scopes are read-only after the migration. -This cmdlet can be used to read a scope rule of a shared scope that has been migrated. - -During an upgrade from SharePoint Server, to preserve legacy settings, local scopes are also automatically migrated when the corresponding sites or site collections are migrated. -In a SharePoint Server farm, the scopes of a site or site collection that is in SharePoint Server mode are read-write, whereas the scopes of a site or site collection after upgrade to SharePoint Server mode are read-only. -This cmdlet can be used to read a scope rule of a migrated local scope in either situation. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>$scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa -PS C:\>Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url http://criticalSite | Set-SPEnterpriseSearchQueryScopeRule -Url http://criticalSite -UrlScopeRuleType Url -``` - -This example gets a reference to a scope rule for the URL http://criticalSite, and sets its rule type to URL. - -## PARAMETERS - -### -Identity -Specifies the scope rule to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance of a valid ScopeRule object. - -```yaml -Type: ScopeRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Returns query scope rules for the specified scope. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The type must be a valid URL, in the form http://server_name. - -Returns query scope rules for the specified results URL. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope rule collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQuerySpellingCorrection.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQuerySpellingCorrection.md deleted file mode 100644 index 6821a326f8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQuerySpellingCorrection.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQuerySpellingCorrection -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQuerySpellingCorrection - -## SYNOPSIS -Returns the object that exposes the Query Spelling Correction (QSC) configuration. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQuerySpellingCorrection [[-Identity] <QuerySpellingCorrectionPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the object that exposes the QSC configuration parameters. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchQuerySpellingCorrection -SearchApplication $ssa -``` - -Returns the current configuration for the Query Spelling Correction component for the default search service application. - -## PARAMETERS - -### -Identity -Specifies an object that represents the current status for the query spelling correction. - -```yaml -Type: QuerySpellingCorrectionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication - -Specifies the search service application that contains the query spelling correction parameters. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQuerySuggestionCandidates.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQuerySuggestionCandidates.md deleted file mode 100644 index 4c02e45938..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchQuerySuggestionCandidates.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchQuerySuggestionCandidates -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchQuerySuggestionCandidates - -## SYNOPSIS -Returns a list of queries. - -## SYNTAX - -``` -Get-SPEnterpriseSearchQuerySuggestionCandidates -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-SourceId <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPEnterpriseSearchQuerySuggestionCandidates cmdlet to return a list of popular queries that can be displayed in a related queries Web Part. -The list gives the administrator a chance to review potential queries and add some of them to the related queries list. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE------------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchQuerySuggestionCandidates -SearchApplication $ssa -``` - -This example returns popular search queries by using the search application contained in the variable $searchapp. - -## PARAMETERS - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. - -The owner must be one of the following valid levels: - -- Search Service Application -- Site Subscription -- Site Collection -- Site - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query topology. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchRankingModel.md deleted file mode 100644 index 587dbea39c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchRankingModel.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchRankingModel -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchRankingModel - -## SYNOPSIS -Returns a ranking model. - -## SYNTAX - -``` -Get-SPEnterpriseSearchRankingModel [[-Identity] <RankingModelPipeBind>] -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads the RankingModel object when a ranking model is created, removed, or updated. - -If the Identity parameter is not specified or the identity does not match any of the ranking models in the collection, all rank models for the search application are returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level ssa -PS C:\>Get-SPEnterpriseSearchRankingModel -Identity '8f6fd0bc-06f9-43cf-bbab-08c377e083f4' -SearchApplication $ssa -Owner $owner -``` - -This example retrieves the ranking model on the search service application level with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 for the search application Search Service Application. - -### ------------------EXAMPLE 2------------------ -``` -C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -$owner = Get-SPEnterpriseSearchOwner -Level ssa -Get-SPEnterpriseSearchRankingModel -SearchApplication $ssa -Owner $owner -``` - -This example retrieves all ranking models defined on the search service application level for the search application Search Service Application. - -## PARAMETERS - -### -Identity -Specifies the ranking model to retrieve. - -The type must be a valid GUID in the form 8f6fd0bc-06f9-43cf-bbab-08c377e083f4, or an instance of a valid RankingModel object. - -```yaml -Type: RankingModelPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the scope where the ranking model is available. -The available scopes are: SSA, Tenant, Site Collection or Site. -A ranking model can be available in multiple scopes. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the ranking model. - -The type must be a valid GUID in the form 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchResultItemType.md deleted file mode 100644 index 4fb883ad15..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchResultItemType.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchResultItemType -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchResultItemType - -## SYNOPSIS -Retrieves result item types. - -## SYNTAX - -``` -Get-SPEnterpriseSearchResultItemType [[-Identity] <ResultItemTypePipeBind>] -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION - -The Get-SPEnterpriseSearchResultItemType cmdlet retrieves the result item types that exist for the specified owner. - -Result item types enable you to change the look of search results based on the type of result. -You start by defining a collection of rules, which will be evaluated against the properties of results. -Then you define the display template to use for rendering that type of result. -Once you have created the result item type, results matching the rules of the result item type will render using the specified display template. - -Example use cases: - -- Change the look of results for a particular file name extension, for example Word documents. -- Change the look of a particular content type in search results. -- Change the look of results from a particular author. -- Add a result action to results from a particular result source as part of a custom search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -PS C:\>Get-SPEnterpriseSearchResultItemType -Owner $tenantOwner -SearchApplication $ssa -``` - -This example retrieves the result item types that are defined for the owner referenced by $tenantowner for the search application referenced by $ssa. - -Although SearchApplication and SearchApplicationProxy are optional parameters, this cmdlet requires use of one of them. - -## PARAMETERS - -### -Identity -Specifies the result item type to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: ResultItemTypePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the result item type is created. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplicationProxy -Specifies the proxy of the search application that contains the result item type. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchResultItemType](New-SPEnterpriseSearchResultItemType.md) - -[Set-SPEnterpriseSearchResultItemType](Set-SPEnterpriseSearchResultItemType.md) - -[Remove-SPEnterpriseSearchResultItemType](Remove-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchResultSource.md deleted file mode 100644 index 219bdb6e30..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchResultSource.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchResultSource -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchResultSource - -## SYNOPSIS -Retrieves a result source. - -## SYNTAX - -``` -Get-SPEnterpriseSearchResultSource [[-Identity] <ResultSourcePipeBind>] -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet retrieves a result source object. - -If the Identity parameter is not specified, this cmdlet returns the result source collection for the specified search object owner. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831] (https://go.microsoft.com/fwlink/p/?LinkId=251831). - - - -## EXAMPLES - -### -------------- Example 1: Get result source by name -------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>Get-SPEnterpriseSearchResultSource -Identity "Local SharePoint Results" -SearchApplication $ssa -Owner $owner -``` - -This example retrieves the search service application level result source with the name "Local SharePoint Results". - - -### -------------- Example 2: Get result source by id -------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>Get-SPEnterpriseSearchResultSource -Identity 8413cd39-2156-4e00-b54d-11efd9abdB89 -SearchApplication $ssa -Owner $owner -``` - -This example retrieves the search service application level result source with the id 8413cd39-2156-4e00-b54d-11efd9abdB89. - -### -------------- Example 3: Get all result sources under SSA -------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>Get-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -``` - -This example retrieves all the search service application level result sources. - -## PARAMETERS - -### -Identity -Specifies the result source to retrieve. - -The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Local SharePoint Results"); or an instance of a valid Source object. - -If not specified, the result source collection for the specified search object owner is returned. - -```yaml -Type: ResultSourcePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchResultSource](New-SPEnterpriseSearchResultSource.md) - -[Set-SPEnterpriseSearchResultSource](Set-SPEnterpriseSearchResultSource.md) - -[Remove-SPEnterpriseSearchResultSource](Remove-SPEnterpriseSearchResultSource.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchSecurityTrimmer.md deleted file mode 100644 index 2838fc5b77..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchSecurityTrimmer.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchSecurityTrimmer -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchSecurityTrimmer - -## SYNOPSIS -Returns a custom security trimmer. - -## SYNTAX - -``` -Get-SPEnterpriseSearchSecurityTrimmer [[-Identity] <SecurityTrimmerPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the SecurityTrimmer. -A custom security trimmer trims search results before the results are returned to the user. - -If the Identity parameter is not specified, this cmdlet returns the security trimmer collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -PS C:\>Get-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa -``` - -This example obtains the pluggable security trimmers registered in the search service application MySSA. - -## PARAMETERS - -### -Identity -Specifies the pluggable security trimmer used for the specified search application. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SecurityTrimmer object. - -```yaml -Type: SecurityTrimmerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the security trimmer. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchService.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchService.md deleted file mode 100644 index 28bc3155f1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchService.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchService -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchService - -## SYNOPSIS -Returns the search service for the farm. - -## SYNTAX - -``` -Get-SPEnterpriseSearchService [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the SearchService object when the search service is updated or deleted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchService -``` - -This example obtains a reference to the search service of the current farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index 6064fdea97..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Returns the search service application for a farm. - -## SYNTAX - -``` -Get-SPEnterpriseSearchServiceApplication [[-Identity] <SearchServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves the SearchServiceApplication object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' -``` - -This example obtains a reference to a search service application named 'Search Service Application'. - -## PARAMETERS - -### -Identity -Specifies the search service application to retrieve. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplicationBackupStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplicationBackupStore.md deleted file mode 100644 index 8b3e3158b4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplicationBackupStore.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchServiceApplicationBackupStore -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchServiceApplicationBackupStore - -## SYNOPSIS - -Retrieves information about the search service application backup files. - - - -## SYNTAX - -``` -Get-SPEnterpriseSearchServiceApplicationBackupStore [-BackupFolder] <String> [-Name] <String> - [[-BackupId] <String>] [-UseMostRecent] [-IsVerbose] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet returns information about the search databases and index files in a specified search service application backup location. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPEnterpriseSearchServiceApplicationBackupStore -BackupFolder \\sample\backup -Name "Search Service Application" -BackupId 3222ad97-91ad-471f-a764-780ec1f05f74 -``` - -This example retrieves the backup of the search databases and index files that are located at \\\\sample\backup with the backup id 3222ad97-91ad-471f-a764-780ec1f05f74 from the search service application Search Service Application. - -### ------------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPEnterpriseSearchServiceApplicationBackupStore -BackupFolder \\sample\backup -Name "Search Service Application" -UseMostRecent -``` - -This example retrieves the most recently taken backup of the search databases and index files that are located at \\\\sample\backup from the search service application Search Service Application. - -## PARAMETERS - -### -BackupFolder -Specifies the full file path of the backup files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the search service application from which to retrieve the related backup information. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupId -Specifies the GUID of the backup in the referred package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UseMostRecent -A switch to specify if the most recent backup should be used. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsVerbose -A switch to specify if messages should be printed out when the cmdlet is running. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplicationProxy.md deleted file mode 100644 index 40b3493b7c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceApplicationProxy.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchServiceApplicationProxy - -## SYNOPSIS -Returns the search service application proxy. - -## SYNTAX - -``` -Get-SPEnterpriseSearchServiceApplicationProxy [[-Identity] <SearchServiceApplicationProxyPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads the SearchServiceApplicationProxy object when the search service application proxy is created updated or deleted. -If the Identity parameter is not specified, this cmdlet returns the search service application proxy collection for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$proxy = Get-SPEnterpriseSearchServiceApplicationProxy -Identity 'Search Service Application Proxy' -``` - -This example obtains a reference to a search service application proxy with the name 'Search Service Application Proxy'. - -## PARAMETERS - -### -Identity -Specifies the search service application proxy to retrieve. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceInstance.md deleted file mode 100644 index f3716fb5df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchServiceInstance.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchServiceInstance -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchServiceInstance - -## SYNOPSIS -Returns the search service instance for a farm. - -## SYNTAX - -``` -Get-SPEnterpriseSearchServiceInstance [[-Identity] <SearchServiceInstancePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Local] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet returns the SearchServiceInstance object when the object is created, updated, or deleted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceInstance -Local -``` - -This example obtains a reference to the local search service instance. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceInstance | ?{$_.Server -match 'SP01'} -``` - -This example obtains a reference to the search service instance on the SharePoint server named 'SP01'. - -## PARAMETERS - -### -Identity -Specifies the search service instance to return. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Local -Returns the search service instance for the current search server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchSiteHitRule.md deleted file mode 100644 index d91fe570d4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchSiteHitRule.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchSiteHitRule -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchSiteHitRule - -## SYNOPSIS -Returns the shared site hit rule. - -## SYNTAX - -``` -Get-SPEnterpriseSearchSiteHitRule [[-Identity] <SiteHitRulePipeBind>] [-SearchService <SearchServicePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPEnterpriseSearchSiteHitRule cmdlet reads a SiteHitRule object when the site hit rule is created, updated, or deleted. -A SiteHitRule object sets how many crawler sessions (threads) can simultaneously crawl the given site. - -If the Identity parameter is not specified, this cmdlet returns the site hit rule collection for the specified search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$shRule = Get-SPEnterpriseSearchSiteHitRule -Identity MySiteHitRule -``` - -The following example obtains a reference to the site hit rule with the name MySiteHitRule. - -## PARAMETERS - -### -Identity -Specifies the site hit rule to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SiteHitRule object. - -```yaml -Type: SiteHitRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchService -Specifies the search service that hosts the crawler with the specified shared site search rules. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchStatus.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchStatus.md deleted file mode 100644 index 7cc88bd516..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchStatus.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchStatus -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchStatus - -## SYNOPSIS -Retrieves diagnostics information for the search components. - -## SYNTAX - -``` -Get-SPEnterpriseSearchStatus -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Component <String>] [-Constellation] [-Detailed] - [-DetailSearchRuntime] [-HealthReport] [-JobStatus] [-Primary] [-Text] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet retrieves diagnostic information for all or specified search components in the active topology of a Search Service Application. - -If you don't specify any of the optional parameters, the cmdlet will retrieve the health status of all the search components within the Search Service Application. -Each search component will have one of the following states: - -- Active: The search component is running OK -- Degraded: The search component is in a status where it cannot perform all operations correctly. The reason for the degraded status is typically a transient situation related to a restart or network issues. -- Failed: The search component is not running. This status indicated that the component cannot perform operations correctly. -- Unknown: The component can't be reached. The reason for the unknown status is typically hardware or communication issues. - -If you have defined more than one Index component for a partition in your search topology, this cmdlet will indicate which index component that has the Primary role for this partition. - -You can use the cmdlet to output the following additional information: - -- List the status of background activities (batch jobs) initiated by the search components -- List the status of background activities (batch jobs) initiated by the search components -- List detailed diagnostic information for the index component -- Debug information that may be used by Microsoft for detailed issue resolution - -If you don't want to iterate over the output in a script, use the Text parameter. -If you do not use the Text parameter, the cmdlet will output a set of objects that have the following properties: - -- string Name: the name of a search component, a health report item or a constellation property -- string State: the status of the search component -- string Level: when you are using the HealthReport parameter, this property indicates the importance level of each health report item (Error, Warning, Info, Verbose) -- string Message: additional information that is provided as a text string -- ReadOnlyDictionary\<string,string\>Details: dictionary name/value pairs that provide additional diagnostic information - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceApplication | Get-SPEnterpriseSearchStatus -Text -``` - -This example retrieves a list that has diagnostics information about all search components of the default Search Service Application. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPEnterpriseSearchStatus -SearchApplication 'Search Service Application' -JobStatus -Text -``` - -This example retrieves the background activity job status for the search analytics timer jobs. - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceApplication | Get-SPEnterpriseSearchStatus -HealthReport -Component IndexComponent1 -Text -``` - -This example retrieves the diagnostic information for the index component named IndexComponent1. - -## PARAMETERS - -### -SearchApplication -Specifies the search service application that contains the search components. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Component - -Specifies the name of the search component. -This parameter is only used in association with the HealthReport and Primary parameter. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Constellation - -Specifies if internal diagnostic information for the search topology should be provided. -This parameter should only be used for debugging. - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Detailed -Specifies the level of detail for the HealthReport parameter. -When this parameter is used, the cmdlet will also output verbose diagnostic information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailSearchRuntime - -Specifies if internal diagnostic information for the search runtime should be provided. -This parameter should only be used for debugging. - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthReport - -Specifies if diagnostic information for the search component should be provided. -When using this parameter, you must specify the component name using the Component parameter. - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobStatus -Specifies if status information for the Search Analytics and Usage Analytics timer jobs should be provided. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Primary - -Specifies if the Admin component has the Primary role. -When using this parameter, you must specify the component name using the Component parameter. -Returns true if the Admin Component has the Primary role. - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Text - -Specifies if the print output from this cmdlet should be outputted in a format that is convenient for reading. -If not used, this cmdlet outputs a SearchStatusInfo object. - -When using this parameter, the output is printed to the console and cannot be piped to a file or another program. - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchTopology.md deleted file mode 100644 index bdb7838b39..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchTopology.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchTopology -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchTopology - -## SYNOPSIS -Retrieves one or all search topologies that belong to a given search service application. - -## SYNTAX - -``` -Get-SPEnterpriseSearchTopology [[-Identity] <SearchTopologyPipeBind>] - -SearchApplication <SearchServiceApplicationPipeBind> [-Active] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves a given search topology, the active search topology, or all search topologies that belong to a given search service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchTopology -SearchApplication $ssa -``` - -This example retrieves all search topologies of the search service application referenced by $ssa. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Active -``` - -This example retrieves the active search topology of the search service application referenced by $ssa. - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity '10fa59cb-4b32-4fe6-8f8d-065388df201e' -``` - -This example retrieves search topology with the identity 10fa59cb-4b32-4fe6-8f8d-065388df201e of the search service application referenced by $ssa. - -## PARAMETERS - -### -Identity -Specifies the search topology to retrieve. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application to which the search topology belongs. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Active -Specifies that the active search topology should be returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchTopology](New-SPEnterpriseSearchTopology.md) - -[Set-SPEnterpriseSearchTopology](Set-SPEnterpriseSearchTopology.md) - -[Remove-SPEnterpriseSearchTopology](Remove-SPEnterpriseSearchTopology.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchVssDataPath.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchVssDataPath.md deleted file mode 100644 index 16c054e199..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPEnterpriseSearchVssDataPath.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPEnterpriseSearchVssDataPath -schema: 2.0.0 ---- - -# Get-SPEnterpriseSearchVssDataPath - -## SYNOPSIS -Retrieves the index paths for all active search index components on the current server. - -## SYNTAX - -``` -Get-SPEnterpriseSearchVssDataPath [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet retrieves the index paths for all active index components on the current server. -This list is required as input by the Search VSS Writer in order to perform VSS backup of the current server. -This cmdlet will typically be called from a VSS script, and rarely used directly. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>Get-SPEnterpriseSearchVssDataPath -``` - -This example gets the index paths for all active index components on the current server. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelBIServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelBIServer.md deleted file mode 100644 index 422e64fde5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelBIServer.md +++ /dev/null @@ -1,101 +0,0 @@ - --- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Get-SPExcelBIServer -schema: 2.0.0 ---- - -# Get-SPExcelBIServer - -## SYNOPSIS - -Returns the server ID of the instance of Analysis Services. - -## SYNTAX - -``` -Get-SPExcelBIServer [[-Identity] <SPExcelBIServerPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPExcelBIServer cmdlet to return the server ID of the instance of Analysis Servicesthat has been configured as a data model server in Excel Services. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPExcelBIServer -ExcelServiceApplication 'Excel Service Application' -``` - -This example displays the name of the Excel Service application named 'Excel Service Application'. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the ExcelServiceApplication identity. - -```yaml -Type: SPExcelBIServerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind -Microsoft.Office.Excel.Server.Cmdlet.SPExcelBIServerPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelBlockedFileType.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelBlockedFileType.md deleted file mode 100644 index c187ba52db..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelBlockedFileType.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Get-SPExcelBlockedFileType -schema: 2.0.0 ---- - -# Get-SPExcelBlockedFileType - -## SYNOPSIS -Returns a file type or list of file types that are prevented from loading. - -## SYNTAX - -``` -Get-SPExcelBlockedFileType [[-Identity] <SPExcelBlockedFileTypePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPExcelBlockedFileType cmdlet reads a file type or a list of file types that cannot be loaded in Excel Services Application. Excel Services Application does not load any files that correspond to a file type in this list. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPExcelBlockedFileType -ExcelServiceApplication 'Excel Service Application' -``` - -This example retrieves all blocked file types for the service application named 'Excel Service Application'. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel -Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel -Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelBlockedFileTypePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Office.Excel.Server.Cmdlet.SPExcelBlockedFileTypePipeBind -Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelDataConnectionLibrary.md deleted file mode 100644 index 343018575d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelDataConnectionLibrary.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Get-SPExcelDataConnectionLibrary -schema: 2.0.0 ---- - -# Get-SPExcelDataConnectionLibrary - -## SYNOPSIS -Returns a trusted data connection library or a list of trusted data connection libraries. - -## SYNTAX - -``` -Get-SPExcelDataConnectionLibrary [[-Identity] <SPExcelDCLPipeBind>] - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPExcelDataConnectionLibrary cmdlet gets a library of data connection files that Excel Services Application and the Excel client use to connect to an external data source. -Excel Services Application loads data connection files only if they are stored in a data connection library that is in the list of trusted data connection libraries. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPExcelserviceapplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary -``` - -This example displays all the data connection libraries that connection files can be loaded by an Excel Services Application Web service application. - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelserviceapplication -identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.Description.Contains("Sales Cube")} -``` - -This example displays all the data connection libraries that have descriptions containing the words Sales Cube from the specified Excel Services Application Web service application. - -## PARAMETERS - -### -Identity -Specifies the DataConnectionLibrary object to return. -If the identity parameter is not specified, this cmdlet returns all the data connection libraries that have connection files that can be loaded by Excel Services Application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection library (for example, DataConnectionLib1); a valid URL, in the form http://server_name; or an instance of a valid SPExcelDCL object. - -```yaml -Type: SPExcelDCLPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelDataProvider.md deleted file mode 100644 index 4e58355ae0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelDataProvider.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Get-SPExcelDataProvider -schema: 2.0.0 ---- - -# Get-SPExcelDataProvider - -## SYNOPSIS -Returns a safe data provider or a list of safe data providers. - -## SYNTAX - -``` -Get-SPExcelDataProvider -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPExcelDataProvider cmdlet reads a safe data provider or a list of safe data providers for an Excel Services Application. -Excel Services Application refreshes external data connections only if the data provider for the connection is on the list of safe data providers. -Excel Services Application includes a set of common data providers on this list. -Therefore, using cmdlets to modify safe data providers is typically done only in custom data connection scenarios. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE--------------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "ExcelServices" | Get-SPExcelDataProvider | where {$_.ProviderID -eq "SQLOLEDB"} -``` - -This example displays the data provider with the provider identifier (ID) SQLOLEDB from the list of data providers that is on the MyExcelService application. -To select a specific provider from the list of safe providers, you must pipe a where clause that can filter the list of providers. - -### --------------EXAMPLE-------------- -``` -PS C:\>Get-SPExcelDataProvider -ExcelServiceApplication "Excel Services" | format-table -``` - -This example displays a list of safe data providers for the specific Excel Services Application Web service application, and then formats the results of the data providers in a table. - -## PARAMETERS - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelDataProvider list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelFileLocation.md deleted file mode 100644 index fdc021011b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelFileLocation.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Get-SPExcelFileLocation -schema: 2.0.0 ---- - -# Get-SPExcelFileLocation - -## SYNOPSIS -Returns a trusted file location or a list of trusted file locations. - -## SYNTAX - -``` -Get-SPExcelFileLocation [[-Identity] <SPExcelFileLocationPipeBind>] - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPExcelFileLocation cmdlet gets locations from which Excel Services Application loads workbooks. -Excel Services Application loads only workbooks that are stored in a trusted file location. -Properties of trusted file locations control how workbooks can be used when loaded by Excel Services Application. -Excel Services Application always enforces the properties that are defined by the trusted file location from which a workbook was loaded. -The properties of the trusted file location to use are determined through comparison of the file path for the workbook with the address of the trusted file location. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation -``` - -This example displays a list of trusted file locations for the Excel Services Application Web service application named MyExcelService. - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation | Format-list * -``` - -This example displays a list of trusted file locations for the Excel Services Application Web service application named MyExcelService, and then formats the list of properties into a table. - -### --------------EXAMPLE 3-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation | where {$_.ExternalDataAllowed -ne "None"} -``` - -This example displays a list of trusted file locations that allow external data connectivity for the Excel Services Application Web service application named MyExcelService. - -## PARAMETERS - -### -Identity -Specifies the SPExcelFileLocation object to return. -If the Identity parameter is not specified, the cmdlet returns all the file locations in the specified. -Excel Services Application Web service application. - -The type must be a valid string that identifies the file location, in the form http://myPortal/myTeam; a valid string that identifies the path, in the form C:\folder_name; a valid UNC path to a trusted location in the form, \\\\computer_name\share; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPExcelFileLocation object. - -```yaml -Type: SPExcelFileLocationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelServiceApplication.md deleted file mode 100644 index 9c8b2a092f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelServiceApplication.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Get-SPExcelServiceApplication -schema: 2.0.0 ---- - -# Get-SPExcelServiceApplication - -## SYNOPSIS -Returns an SPExcelServiceApplication object. - -## SYNTAX - -``` -Get-SPExcelServiceApplication [[-Identity] <SPExcelServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPExcelServiceApplication cmdlet retrieves an SPExcelServiceApplication object. -If the object returned by this cmdlet is changed, the change affects all instances of the specified Excel Services Application Web service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPExcelServiceApplication "MyExcelServices" -``` - -This example displays the Excel Services Application Web service application named MyExcelServices. - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelServiceApplication -``` - -This example displays every Excel Services Application Web service application that runs in the farm. - -### --------------EXAMPLE 3-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | format-list * -``` - -This example displays Excel Services Application Web service application named MyExcelService, and then displays all of its settings in a list format. - -## PARAMETERS - -### -Identity -Specifies the ExcelServiceApplication object to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelUserDefinedFunction.md deleted file mode 100644 index 877bb9d106..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPExcelUserDefinedFunction.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Get-SPExcelUserDefinedFunction -schema: 2.0.0 ---- - -# Get-SPExcelUserDefinedFunction - -## SYNOPSIS -Returns a user-defined function or a collection of user-defined functions. - -## SYNTAX - -``` -Get-SPExcelUserDefinedFunction [[-Identity] <SPExcelUDFPipeBind>] - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPExcelUserDefinedFunction cmdlet reads a user-defined function and its properties, or returns the collection of user-defined functions for an Excel Services Application Web service application. -Excel Services Application uses only user-defined functions that are in the list of user-defined functions. -User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. -The assemblies can perform custom logic or other actions, such as refreshing data. -Windows PowerShell cmdlets operate on the entries in the user-defined function list, but do not operate on the assemblies. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -``` - -This example displays the user-defined function named SampleCompany.SampleApplication.SampleUdf from the list of user-defined functions that is in the Excel Services Application Web service application named MyExcelService. - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelServiceApplication | Get-SPExcelUserDefinedFunction | format-list -``` - -This example displays every user-defined function for every Excel Services Application Web service application in the farm, and then displays the results in a list. - -## PARAMETERS - -### -Identity -Specifies the UserDefinedFunction object to get. -If the Identity parameter is not specified, the cmdlet returns all of the functions in the user defined functions list. - -The type must be a valid name of the code assembly (for example, SampleCompany.SampleApplication.SampleUdf); or an instance of a valid SPExcelUDF object. - -```yaml -Type: SPExcelUDFPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelUserDefinedFunction list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFarm.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFarm.md deleted file mode 100644 index aeed9c35e3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFarm.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPFarm -schema: 2.0.0 ---- - -# Get-SPFarm - -## SYNOPSIS - -Returns the local SharePoint farm. - - - -## SYNTAX - -``` -Get-SPFarm [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPFarm cmdlet returns the local SharePoint farm. -No parameters are used. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -``` -C:\PS>$f = Get-SPFarm -``` - -This example stores the local farm in a variable. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFarmConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFarmConfig.md deleted file mode 100644 index 905a7ddf87..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFarmConfig.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPFarmConfig -schema: 2.0.0 ---- - -# Get-SPFarmConfig - -## SYNOPSIS - -Returns a global property or a collection of global properties for the local farm. - - - -## SYNTAX - -``` -Get-SPFarmConfig [-AssignmentCollection <SPAssignmentCollection>] [-ServiceConnectionPoint] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPFarmConfig cmdlet retrieves global settings for the local farm that are not members of the SPFarm object. -This cmdlet creates a new PSCustomObject object from the collection of properties returned from the local farm, and then adds this object to the pipeline. - -The PSCustomObject object can be read, or modified and passed to the Set-SPFarmConfig cmdlet to change parameter values. - -The properties collected in the PSCustomObject object must be farm-wide settings, and must be configurable only once for the entire farm. - -The parameter name added to the PSCustomObject object must match exactly the input parameter name for the Set-SPFarmConfig cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### -------------EXAMPLE---------------- -``` -PS C:\>$a = Get-SPFarmConfig -PS C:\>$a.AjaxTimeout = 200 -PS C:\>$a | Set-SPFarmConfig -``` - -This example uses the Get-SPFarmConfig cmdlet to add the Ajax Timeout setting to the PSCustomObject object, sets the value for Ajax Timeout, and then passes PSCustomObject to the Set-SPFarmConfig cmdlet to change the Ajax Timeout setting. Ajax Timeout, a farm-wide setting, is a member of the SPWebService object and cannot be accessed with a Windows PowerShell cmdlet. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceConnectionPoint -Gets the information stored in the current farm's service connection point in Active Directory. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFeature.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFeature.md deleted file mode 100644 index c7a5918998..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPFeature.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPFeature -schema: 2.0.0 ---- - -# Get-SPFeature - -## SYNOPSIS - -Returns the SharePoint Features based on a given scope. - - - -## SYNTAX - -### FarmFeatures -``` -Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Farm] [-Limit <String>] [<CommonParameters>] -``` - -### SiteFeatures -``` -Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Limit <String>] [-Site <SPSitePipeBind>] [-Sandboxed] [<CommonParameters>] -``` - -### WebFeatures -``` -Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Limit <String>] [-Web <SPWebPipeBind>] [<CommonParameters>] -``` - -### WebApplicationFeatures -``` -Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Limit <String>] [-WebApplication <SPWebApplicationPipeBind>] [<CommonParameters>] -``` - -### FarmFeatureDefinitions -``` -Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Limit <String>] [-CompatibilityLevel <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. - -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets [https://go.microsoft.com/fwlink/?LinkID=18781](https://go.microsoft.com/fwlink/?LinkID=187810). - -All parameter sets take the Identity parameter, which can be either the relative path of the SharePoint Feature (considered the feature name) or the GUID of a Feature definition. - -If the Identity parameter is provided, the cmdlets attempt to find the given Feature definition or instance for the given scope. -If no parameters are specified, all installed features are returned. - -The Get-SPFeature cmdlet behaves differently at each scope, returning the enabled Features at each level. -If no scope is provided, all installed Features are returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPFeature -Limit ALL | Where-Object {$_.Scope -eq "SITE"} -``` -This example returns a list of all installed SITE scoped Features. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPSite http://somesite | Get-SPWeb -Limit ALL |%{ Get-SPFeature -Web $_ } | Select DisplayName,ID -Unique -``` - -This example returns the name and identifier (ID) of each uniquely enabled Feature on every SPWeb object in the site collection at http://somesite. - -## PARAMETERS - -### -Identity -Specifies the name of the Feature to retrieve. - -The type must be the full or partial name, in the form Feature1, or a GUID, in the form 1234-4567-9879, of the Feature to get. - -```yaml -Type: SPFeatureDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Farm -Specifies that if this parameter is used, only enabled farm Features are displayed. - -```yaml -Type: SwitchParameter -Parameter Sets: FarmFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Limits the display results. If "All" is specified, all Features are displayed. - -The type must be a valid number greater than 0. The default value is 200. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the name of the site collection from which to get enabled Features. - -The type must be a valid URL for a site collection, in the form http://server_name . - -```yaml -Type: SPSitePipeBind -Parameter Sets: SiteFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Web -Specifies the URL or GUID of the Web. - -The type must be a valid URL, in the form http://server_name , or a GUID, in the form 1234-5678-9876-0987. - -```yaml -Type: SPWebPipeBind -Parameter Sets: WebFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the name of the Web application from which to get enabled Features. - -The type must be a valid URL to the Web application in the form http://server_name . - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplicationFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. - -```yaml -Type: Int32 -Parameter Sets: FarmFeatureDefinitions -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sandboxed -Specifies to retrieve Sandbox features. - -```yaml -Type: SwitchParameter -Parameter Sets: SiteFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPHealthAnalysisRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPHealthAnalysisRule.md deleted file mode 100644 index 64aca27b14..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPHealthAnalysisRule.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPHealthAnalysisRule -schema: 2.0.0 ---- - -# Get-SPHealthAnalysisRule - -## SYNOPSIS - -Gets a health analyzer rule. - - - -## SYNTAX - -``` -Get-SPHealthAnalysisRule [-Identity] <SPHealthAnalysisRuleInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Get-SPHealthAnalysisRule cmdlet to return a list of a health analyzer rules. -To return a specify health analyzer rule, use the Identity parameter; otherwise, all health analyzer rules will be returned. - -The SPHealthAnalysisRule cmdlets were first introduced in the February 2011 Cumulative Update, which is available for download as follows: - ---Description of the SharePoint Foundation Cumulative Update Server Hotfix Package (SharePoint Foundation server-package) (http://support.microsoft.com/kb/2475880) ---Description of the SharePoint Server Cumulative Update Server Hotfix Package (MOSS server-package (http://support.microsoft.com/kb/2475878) - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE 1--------------------------- -``` -PS C:\>Get-SPHealthAnalysisRule -Identity "CustomRule" -``` - -This example returns the health analyzer rule named CustomRule. - -## PARAMETERS - -### -Identity -Specifies the name or GUID of the health analyzer rule to get. - -The type must be a valid name, an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPHealthAnalysisRuleInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPHelpCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPHelpCollection.md deleted file mode 100644 index c445f796b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPHelpCollection.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPHelpCollection -schema: 2.0.0 ---- - -# Get-SPHelpCollection - -## SYNOPSIS - -Returns Help collection files. - - - -## SYNTAX - -``` -Get-SPHelpCollection [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPHelpCollection cmdlet reads the specified Help collection files. -If the Name parameter is not specified, this cmdlet returns all installed Help collection files. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPHelpCollection -``` - -This example gets all installed Help collection files. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Help collection files to get. - -The type must be a valid name of a Help collection folder; for example, HelpDocs1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPIRMSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPIRMSettings.md deleted file mode 100644 index 5c3389e8cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPIRMSettings.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPIRMSettings -schema: 2.0.0 ---- - -# Get-SPIRMSettings - -## SYNOPSIS - -Returns the Information Rights Management (IRM) settings. - - - -## SYNTAX - -``` -Get-SPIRMSettings [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPIRMSettings cmdlet to display IRM settings for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE---------------- -``` -PS C:\>Get-SPIRMSettings -``` - -This example returns IRM settings for the entire farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPIRMSettings](Set-SPIRMSettings.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathFormTemplate.md deleted file mode 100644 index 925fc9791d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Get-SPInfoPathFormTemplate - -## SYNOPSIS -Returns a InfoPath form template. - -## SYNTAX - -``` -Get-SPInfoPathFormTemplate [[-Identity] <SPFormTemplatePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPInfoPathFormTemplate cmdlet reads a specific InfoPath form template or the collection of templates. -If the Identity parameter is not specified, the cmdlet returns the collection of InfoPath form templates for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPInfoPathFormTemplate -``` - -This example lists the Identity, DisplayName, and FormTemplateStatus property for each admininstrator-deployed InfoPath form template. - -### ---------------EXAMPLE 2-------------- -``` -C:\PS>"SomeFormTemplate.xsn" | Get-SPInfoPathFormTemplate | format-list -``` - -This example lists all the properties of the specified InfoPath form template. - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathFormsService.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathFormsService.md deleted file mode 100644 index d0e8722847..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathFormsService.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInfoPathFormsService -schema: 2.0.0 ---- - -# Get-SPInfoPathFormsService - -## SYNOPSIS -Returns the InfoPath Forms Services in SharePoint Server settings that are in the farm. - -## SYNTAX - -``` -Get-SPInfoPathFormsService [-AssignmentCollection <SPAssignmentCollection>] - [-Identity <SPFormsServicePipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPInfoPathFormsService cmdlet reads the settings for the InfoPath Forms Services in SharePoint Server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE---------------- -``` -PS C:\>Get-SPInfoPathFormsService -``` - -This example displays the InfoPath Forms Services settings for the entire farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the InfoPath Forms Services settings to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a forms service (for example, FormsService1); or an instance of a valid SPFormsService object. - -```yaml -Type: SPFormsServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathUserAgent.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathUserAgent.md deleted file mode 100644 index 87ef8ead97..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathUserAgent.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInfoPathUserAgent -schema: 2.0.0 ---- - -# Get-SPInfoPathUserAgent - -## SYNOPSIS -Returns a user agent or all the currently defined user agents for the farm. - -## SYNTAX - -``` -Get-SPInfoPathUserAgent [[-Identity] <SPUserAgentPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPInfoPathUserAgent cmdlet reads the user agent specified in Identity. -If the Identity parameter is not specified, this cmdlet returns the collection of user agents for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPInfoPathUserAgent -``` - -This example displays a list of user agents in the entire farm. - -## PARAMETERS - -### -Identity -Specifies the user agent to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user agent (for example, UserAgent1; or an instance of a valid SPUserAgent object. - -```yaml -Type: SPUserAgentPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathWebServiceProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathWebServiceProxy.md deleted file mode 100644 index fd87340347..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInfoPathWebServiceProxy.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInfoPathWebServiceProxy -schema: 2.0.0 ---- - -# Get-SPInfoPathWebServiceProxy - -## SYNOPSIS -Returns the Web proxy settings for the Web application. - -## SYNTAX - -``` -Get-SPInfoPathWebServiceProxy [-Identity] <SPWebServiceProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPInfoPathWebServiceProxy cmdlet reads the Web proxy settings for the SharePoint Web application specified in Identity. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPInfoPathWebServiceProxy -Identity "http://server_name/" -``` - -This example displays the Web service proxy settings for a specified Web application. - -## PARAMETERS - -### -Identity -Specifies the SharePoint Web application to get. - -The type must be a valid URL, in the form http://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPWebServiceProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInsightsConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInsightsConfig.md deleted file mode 100644 index bb06a7d9c4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInsightsConfig.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInsightsConfig -schema: 2.0.0 ---- - -# Get-SPInsightsConfig - -## SYNOPSIS -Returns the uploader.xml and Microsoft.Office.BigData.DataLoader.exe.config files from the Configuration database. - -## SYNTAX - -``` -Get-SPInsightsConfig [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Returns the uploader.xml and Microsoft.Office.BigData.DataLoader.exe.config files from the Configuration database. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$config = Get-SPInsightsConfig -PS C:\>$xml = $config.UploaderXml -PS C:\>$config.UploaderXml = $xml -PS C:\>$config.Update() -PS C:\>Stop-SPService -Identity "Microsoft SharePoint Insights" -PS C:\>Start-SPService -Identity "Microsoft SharePoint Insights" -``` - -This example returns and modifies the config.uploader.xml file. It then restarts the SharePoint Insights service on all servers in order to commit the changes. - -### Example 2 -``` -PS C:\>$config = Get-SPInsightsConfig -PS C:\>PS C:\>$odlExeConfig = $config.OdlExeConfig -PS C:\>$config.OdlExeConfig = $odlExeConfig -PS C:\>$config.Update() -PS C:\>Stop-SPService -Identity "Microsoft SharePoint Insights" -PS C:\>Start-SPService -Identity "Microsoft SharePoint Insights" -``` - -This example returns and modifies the config.uploader.xml file. It then restarts the SharePoint Insights service on all servers in order to commit the changes. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInternalAppStateSyncLastRunTime.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInternalAppStateSyncLastRunTime.md deleted file mode 100644 index 001bcfc00f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInternalAppStateSyncLastRunTime.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInternalAppStateSyncLastRunTime -schema: 2.0.0 ---- - -# Get-SPInternalAppStateSyncLastRunTime - -## SYNOPSIS - -Returns the latest time the internal app state update job was invoked. - - - -## SYNTAX - -``` -Get-SPInternalAppStateSyncLastRunTime [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPInternalAppStateSyncLastRunTime cmdlet to return the latest time the internal app state update job was invoked. -The internal app state update job gets app upgrades from the internal app directory and sets them on app instances. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE----------- -``` -PS C:\>Get-SPInternalAppStateSyncLastRunTime -``` - -This example returns the latest time the internal app state update job was invoked. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInternalAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInternalAppStateUpdateInterval.md deleted file mode 100644 index 34a5649993..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPInternalAppStateUpdateInterval.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPInternalAppStateUpdateInterval -schema: 2.0.0 ---- - -# Get-SPInternalAppStateUpdateInterval - -## SYNOPSIS - -Returns the interval in hours between updates of the internal app state update job. - - - -## SYNTAX - -``` -Get-SPInternalAppStateUpdateInterval [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPInternalAppStateUpdateInterval cmdlet to return the interval in hours between updates of the internal app state update job. -The internal app state update job gets app upgrades from the internal app directory and sets them on app instances. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE----------- -``` -PS C:\>Get-SPInternalAppStateUpdateInterval -``` - -This example returns the interval in hours between updates of the internal app state update job. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPInternalAppStateUpdateInterval](Set-SPInternalAppStateUpdateInterval.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPLogEvent.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPLogEvent.md deleted file mode 100644 index 252f4522bf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPLogEvent.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPLogEvent -schema: 2.0.0 ---- - -# Get-SPLogEvent - -## SYNOPSIS - -Returns results from a Unified Logging Service (ULS) trace log. - - - -## SYNTAX - -### Directory -``` -Get-SPLogEvent [-AssignmentCollection <SPAssignmentCollection>] [-AsString] [-ContextKey <String[]>] - [-Directory <String>] [-MinimumLevel <String>] [-EndTime <DateTime>] [-StartTime <DateTime>] - [<CommonParameters>] -``` - -### File -``` -Get-SPLogEvent [-AssignmentCollection <SPAssignmentCollection>] [-AsString] [-ContextKey <String[]>] - [-MinimumLevel <String>] [-EndTime <DateTime>] [-File <String>] [-StartTime <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPLogEvent cmdlet returns records from a ULS trace log file that match the criteria. -If no parameters are specified, all records from all log files are returned. -Use the StartTime and EndTime parameters to filter on a time range. -The use of these parameters is recommended to optimize performance of this cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPLogEvent -MinimumLevel "Warning" -``` - -This example returns all log entries equal to or more severe than Warning from the default log directory. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPLogEvent -Directory "C:\Logs" | Where-Object {$_.Level -eq "Warning"} -``` - -This example returns all warning entries from log files in the C:\Logs directory. - -### --------------EXAMPLE 3----------------- -``` -PS C:\>Get-SPLogEvent -StartTime "12/04/2007 17:00" -EndTime "12/04/2007 18:00" -``` - -This example returns error entries that occurred during a particular time range, which is culture-specific to the United States. - -### --------------EXAMPLE 4----------------- -``` -PS C:\>Get-SPLogEvent -ContextKey @("UserName" ,"SiteName") -``` - -This example returns the contents of the most recent log file and adds the specified context key data. - -### --------------EXAMPLE 5----------------- -``` -PS C:\>Get-SPLogEvent | Where-Object {$_.Level -eq "Error" -and {$_.Area -eq "SharePoint Foundation "} -``` - -This example returns all error entries related to SharePoint Foundation. - -### --------------EXAMPLE 6----------------- -``` -PS C:\>Get-SPLogEvent -ContextKey @("Name") | %{$_.ToString() + "'t" + $_.Context["Name"]} -``` - -This example returns the contents of the log file and adds context data. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsString -Returns each record as a separate string - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContextKey -Specifies that context data should be added to the results for the specified Context Keys, for example: `-ContextKey @("UserName", "SiteName")`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Lists log files from an alternate directory (any directory other than the configured LogLocation directory). - -```yaml -Type: String -Parameter Sets: Directory -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumLevel -Returns records at or above the specified level. -The valid values are Error or Warning. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a specific file to query records from. - -```yaml -Type: String -Parameter Sets: File -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPLogLevel.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPLogLevel.md deleted file mode 100644 index c434751855..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPLogLevel.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPLogLevel -schema: 2.0.0 ---- - -# Get-SPLogLevel - -## SYNOPSIS - -Returns a list of objects or diagnostic levels. - - - -## SYNTAX - -``` -Get-SPLogLevel [-AssignmentCollection <SPAssignmentCollection>] [-Identity <String[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPLogLevel cmdlet displays a list of objects or diagnostic levels based on the criteria specified. -If no parameter is specified, a list of all diagnostic levels for all categories is returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPLogLevel -``` - -This example displays throttle levels for all categories. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPLogLevel -Identity "Category1" -``` - -This example displays the throttle level for the Category1 category. - -### --------------EXAMPLE 3----------------- -``` -C:\PS>"Cat1", "Cat2", "Cat3" | Get-SpLogLevel -``` - -This example displays the throttle level for multiple categories. - -### --------------EXAMPLE 4----------------- -``` -PS C:\>Get-SPLogLevel -Identity "Area:*" -``` - -This example displays the throttle level for all categories in one area. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies a valid category name; for example, Backup and Restore, or Administration. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPManagedAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPManagedAccount.md deleted file mode 100644 index feb8748628..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPManagedAccount.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPManagedAccount -schema: 2.0.0 ---- - -# Get-SPManagedAccount - -## SYNOPSIS - -Retrieves accounts registered in the configuration database. - - - -## SYNTAX - -### Server -``` -Get-SPManagedAccount [[-Identity] <SPManagedAccountPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Server <SPServerPipeBind>] [<CommonParameters>] -``` - -### Service -``` -Get-SPManagedAccount [[-Identity] <SPManagedAccountPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Service <SPServicePipeBind>] [<CommonParameters>] -``` - -### WebApplication -``` -Get-SPManagedAccount [[-Identity] <SPManagedAccountPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-WebApplication <SPWebApplicationPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPManagedAccount cmdlet returns the managed accounts that match the given scope. -The scope can be any one of the following values: Web application, service, or server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPManagedAccount -``` - -This example displays all the managed accounts in the farm. - -## PARAMETERS - -### -Identity -Specifies the full name or partial name of the managed accounts to retrieve. - -The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. - -```yaml -Type: SPManagedAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the scope to a server. - -```yaml -Type: SPServerPipeBind -Parameter Sets: Server -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Service -Specifies the scope to a service. - -```yaml -Type: SPServicePipeBind -Parameter Sets: Service -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the scope to a Web application. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPManagedPath.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPManagedPath.md deleted file mode 100644 index 46da083381..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPManagedPath.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPManagedPath -schema: 2.0.0 ---- - -# Get-SPManagedPath - -## SYNOPSIS - -Returns all managed paths that match the given criteria. - - - -## SYNTAX - -### HostHeader -``` -Get-SPManagedPath [[-Identity] <SPPrefixPipeBind>] [-HostHeader] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### WebApplication -``` -Get-SPManagedPath [[-Identity] <SPPrefixPipeBind>] -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web application, site collection or for all host-named site collections. -If an Identity parameter is not provided, all managed paths for the given scope are returned. - -Host-named sites (no matter the Web application in which they are contained) share a single set of managed paths. -Use the HostHeader parameter to return host-named site collections-scoped managed paths. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPManagedPath -WebApplication http://sitename -``` - -This example returns all managed paths for the specified Web application. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPManagedPath -identity "Sites" -HostHeader -``` - -This example gets the Sites managed path from the host-named site collections-scoped managed paths. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the managed path to return. - -The type must be a valid URL, in the http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostHeader -If provided, the managed paths returned are for the host-named sites in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL or GUID of the Web application from which to get the managed path. - -The type must be a valid URL, in the form http://server_name, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMetadataServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMetadataServiceApplication.md deleted file mode 100644 index a039d0e6c0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMetadataServiceApplication.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPMetadataServiceApplication -schema: 2.0.0 ---- - -# Get-SPMetadataServiceApplication - -## SYNOPSIS -Returns a managed metadata service application. - -## SYNTAX - -``` -Get-SPMetadataServiceApplication [-Identity] <SPMetadataServiceCmdletPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPMetadataServiceApplication cmdlet to retrieve a specified managed metadata service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE----------------- -``` -PS C:\>Get-SPMetadataServiceApplication -Identity "ManagedMetadataServiceApp1" -``` - -This example retrieves an existing managed metadata service application. - -## PARAMETERS - -### -Identity -Specifies the managed metadata service application to get. - -The type must be a valid GUID or the name of a valid managed metadata service application. - -```yaml -Type: SPMetadataServiceCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMetadataServiceApplicationProxy.md deleted file mode 100644 index c05b6ba07d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMetadataServiceApplicationProxy.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPMetadataServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPMetadataServiceApplicationProxy - -## SYNOPSIS -Returns an existing connection to a managed metadata service application, which is also known as a proxy, to the managed metadata service application. - -## SYNTAX - -``` -Get-SPMetadataServiceApplicationProxy [-Identity] <SPMetadataServiceProxyCmdletPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPMetadataServiceApplicationProxy cmdlet to get a specified connection to a managed metadata service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE------------- -``` -PS C:\>Get-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -``` - -This example retrieves an existing connection to a managed metadata service application. - -## PARAMETERS - -### -Identity -Specifies the service application proxy to read. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMicrofeedOptions.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMicrofeedOptions.md deleted file mode 100644 index 8816830ce1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMicrofeedOptions.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPMicrofeedOptions -schema: 2.0.0 ---- - -# Get-SPMicrofeedOptions - -## SYNOPSIS -Returns the feed cache settings for the current user profile application. - -## SYNTAX - -``` -Get-SPMicrofeedOptions [-AssignmentCollection <SPAssignmentCollection>] - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns the feed cache settings for the current user profile application. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Get-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy -``` - -This example returns cache feed settings from the specified User Profile Service Application Proxy. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the unique identifier for the proxy. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind -Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMobileMessagingAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMobileMessagingAccount.md deleted file mode 100644 index 6311b5a928..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPMobileMessagingAccount.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPMobileMessagingAccount -schema: 2.0.0 ---- - -# Get-SPMobileMessagingAccount - -## SYNOPSIS - -Retrieves mobile messaging accounts for the specified Web application. - - - -## SYNTAX - -``` -Get-SPMobileMessagingAccount [[-Identity] <SPMobileMessagingAccountPipeBind>] - -WebApplication <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPMobileMessagingAccount cmdlet retrieves the specified mobile messaging accounts for the specified Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPMobileMessagingAccount -WebApplication http://sitename -``` - -This example retrieves the current mobile account settings information of the Web application http://sitename. - -## PARAMETERS - -### -Identity -Specifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. -Valid values are:SMS and MMS. -If you do not specify this parameter, account information is returned for both SMS and MMS. - -```yaml -Type: SPMobileMessagingAccountPipeBind -Parameter Sets: (All) -Aliases: ServiceType, AccountType -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the identity of the Web application to delete. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423). - -You either must specify WebApplication or must use the HostHeader switch and specify the full URL in the Identity parameter. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPO365LinkSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPO365LinkSettings.md deleted file mode 100644 index 4c4a7e7a78..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPO365LinkSettings.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPO365LinkSettings -schema: 2.0.0 ---- - -# Get-SPO365LinkSettings - -## SYNOPSIS -Gets hybrid configurations. - -## SYNTAX - -``` -Get-SPO365LinkSettings [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the **Get-SPO365LinkSettings** cmdlet to display current hybrid configurations in the farm. - - - -## EXAMPLES - -### EXAMPLE 1 -```powershell -$gc = Start-SPAssignment -Get-SPO365LinkSettings – AssignmentCollection $gc -Stop-SPAssignment $gc - -``` -This example returns all hybrid configurations. - -## PARAMETERS - - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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). - - - -## RELATED LINKS - -[Set-SPO365LinkSettings](Set-SPO365LinkSettings.md) - -[Test-SPO365LinkSettings](Test-SPO365LinkSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPendingUpgradeActions.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPendingUpgradeActions.md deleted file mode 100644 index 9d18d86d5a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPendingUpgradeActions.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPPendingUpgradeActions -schema: 2.0.0 ---- - -# Get-SPPendingUpgradeActions - -## SYNOPSIS - -Displays pending upgrade actions. - - - -## SYNTAX - -``` -Get-SPPendingUpgradeActions [-RootObject] <IUpgradable> [-AssignmentCollection <SPAssignmentCollection>] - [-Recursive] [-SkipSiteUpgradeActionInfo] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPPendingUpgradeActions cmdlet to display the current pending upgrade actions for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE------- -``` -PS C:\>Get-SPFarm | Get-SPPendingUpgradeActions -Recursive -``` - -## PARAMETERS - -### -RootObject -Specifies a SharePoint object where you check for which upgrade actions are outstanding for that object based on its current upgrade status. - -This object must be inherited from IUpgradable. - -```yaml -Type: IUpgradable -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Recursive -Specifies whether to perform the same pending upgrade action checks on each IUpgradable object that occurs under the RootObject parameter that is specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSiteUpgradeActionInfo -Specifies to not include pending upgrade actions for all child objects of a content database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPerformancePointServiceApplication.md deleted file mode 100644 index ee6db45835..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPerformancePointServiceApplication.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPPerformancePointServiceApplication -schema: 2.0.0 ---- - -# Get-SPPerformancePointServiceApplication - -## SYNOPSIS -Returns a PerformancePoint Service application object and properties. - -## SYNTAX - -``` -Get-SPPerformancePointServiceApplication [[-Identity] <SPPerformancePointMonitoringServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPPerformancePointServiceApplication cmdlet to read a PerformancePoint Service application object and properties. -If the Identity parameter is not specified, the cmdlet returns the collection of PerformancePoint Service applications in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE------------------ -``` -PS C:\>Get-SPPerformancePointServiceApplication "PPSApp_01" -``` - -This example gets a PerformancePoint Service application named PPSApp_01. - -## PARAMETERS - -### -Identity -Specifies the PerformancePoint Service application to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPerformancePointServiceApplicationTrustedLocation.md deleted file mode 100644 index 64337b98f1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPerformancePointServiceApplicationTrustedLocation.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPPerformancePointServiceApplicationTrustedLocation -schema: 2.0.0 ---- - -# Get-SPPerformancePointServiceApplicationTrustedLocation - -## SYNOPSIS -Returns a trusted location object and properties for a PerformancePoint Service application. - -## SYNTAX - -``` -Get-SPPerformancePointServiceApplicationTrustedLocation [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Identity <SPPerformancePointMonitoringServiceApplicationTrustedLocationPipeBind>] - [-ServiceApplication <SPPerformancePointMonitoringServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPPerformancePointMonitoringServiceApplicationTrustedLocation cmdlet to read a trusted location object and properties. -If the Identity parameter is not specified, this cmdlet returns the list of all trusted locations and their properties for a PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------------EXAMPLE---------------------- -``` -PS C:\>Get-SPPerformancePointServiceApplication PPSApp_01 | Get-SPPerformancePointServiceApplicationTrustedLocation -Identity $_.ID | select * -``` - -This example retrieves TrustedLocation information for the PPSApp_01 PerformancePoint Service application. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the trusted location to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPPerformancePointMonitoringServiceApplicationTrustedLocation object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationTrustedLocationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the PerformancePoint Service application that contains the trusted location. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPluggableSecurityTrimmer.md deleted file mode 100644 index 61657e385d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPPluggableSecurityTrimmer.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPPluggableSecurityTrimmer -schema: 2.0.0 ---- - -# Get-SPPluggableSecurityTrimmer - -## SYNOPSIS -Gets pluggable security trimmers added to a profile service application proxy. - -## SYNTAX - -``` -Get-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId <Guid> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPPluggableSecurityTrimmer cmdlet to list the pluggable security trimmers that have been added to a User Profile service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE--------------------- -``` -PS C:\>$pr = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Get-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -``` - -This example gets a list of the pluggable security trimmers that are associated with the User Profile service application proxy. - -## PARAMETERS - -### -UserProfileApplicationProxyId -Specifies the ID of the User Profile service application proxy to which the pluggable security trimmers have been added. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProcessAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProcessAccount.md deleted file mode 100644 index e0b8a868a6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProcessAccount.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPProcessAccount -schema: 2.0.0 ---- - -# Get-SPProcessAccount - -## SYNOPSIS - -Returns a system account or a managed account. - - - -## SYNTAX - -### LocalService -``` -Get-SPProcessAccount [-AssignmentCollection <SPAssignmentCollection>] [-LocalService] [<CommonParameters>] -``` - -### LocalSystem -``` -Get-SPProcessAccount [-AssignmentCollection <SPAssignmentCollection>] [-LocalSystem] [<CommonParameters>] -``` - -### NetworkService -``` -Get-SPProcessAccount [-AssignmentCollection <SPAssignmentCollection>] [-NetworkService] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPProcessAccount cmdlet returns a system account or a managed account and creates the SPProcessAccountPipeBind object. -All operations that can accept an account can accept the SPProcessAccountPipeBind in place of the SPManagedAccountPipeBind. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Get-SPProcessAccount -NetworkService -``` - -This example creates the SPProcessAccountPipeBind type by using the NetworkService account. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPProcessAccount -NetworkService | New-SPServiceApplicationPool -Account $_ -``` - -This example creates an SPServiceApplicationPool account by using the NetworkService account returned by the Get-SPProcessAccount cmdlet. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LocalService -Returns the LocalService account. - -```yaml -Type: SwitchParameter -Parameter Sets: LocalService -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalSystem -Returns the LocalSystem account. - -```yaml -Type: SwitchParameter -Parameter Sets: LocalSystem -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkService -Returns the NetworkService account. - -```yaml -Type: SwitchParameter -Parameter Sets: NetworkService -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProduct.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProduct.md deleted file mode 100644 index 3242667588..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProduct.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPProduct -schema: 2.0.0 ---- - -# Get-SPProduct - -## SYNOPSIS - -Returns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product. - - - -## SYNTAX - -### Local -``` -Get-SPProduct [-AssignmentCollection <SPAssignmentCollection>] [-Local] [<CommonParameters>] -``` - -### Server -``` -Get-SPProduct [-AssignmentCollection <SPAssignmentCollection>] [-Server <SPServerPipeBind>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPProduct cmdlet returns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product. -By default this cmdlet returns the list of SharePoint-related products installed in the farm. -Use the Local parameter to get only information about the local server or for a specific server to get the list, use the Server parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPProduct -Local -``` - -This example displays the SharePoint-related products installed on the local server. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Local -Returns product and update information for only the local computer. -If you use the Local parameter, you cannot use the Server parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Local -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Returns product and update information for a specified server. -If you use the Server parameter, you cannot use the Local parameter. - -```yaml -Type: SPServerPipeBind -Parameter Sets: Server -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProfileLeader.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProfileLeader.md deleted file mode 100644 index 94f7888598..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProfileLeader.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPProfileLeader -schema: 2.0.0 ---- - -# Get-SPProfileLeader - -## SYNOPSIS -Returns the current company leaders. - -## SYNTAX - -``` -Get-SPProfileLeader [-ProfileServiceApplicationProxy] <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the Get-SPProfileLeader cmdlet to display the current company leaders. - -For additional information about SPProfileLeader cmdlets, see The *-SPProfileLeader Windows PowerShell cmdlets in SharePoint Server SP1 (https://go.microsoft.com/fwlink/p/?LinkId=226295) (https://go.microsoft.com/fwlink/p/?LinkId=226295). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE----------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Get-SPProfileLeader -ProfileServiceApplicationProxy $proxy -``` - -This example returns a company leader from the specific user profile service application as indicated by the variable, $upaProxy. - -## PARAMETERS - -### -ProfileServiceApplicationProxy -Specifies the name of the User Profile Service Application Proxy to use. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProfileServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProfileServiceApplicationSecurity.md deleted file mode 100644 index a6e2b21023..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProfileServiceApplicationSecurity.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPProfileServiceApplicationSecurity -schema: 2.0.0 ---- - -# Get-SPProfileServiceApplicationSecurity - -## SYNOPSIS -Returns permission and identity information. - -## SYNTAX - -``` -Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [-Type <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPProfileServiceApplicationSecurity cmdlet to display permission and identity information for the following User Profile objects: - -- Read individual My Sites -- Use Personal Features -- Use Social Features -- Create Personal Site - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE-------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS PS C:\>Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy -Type MySiteReaderACL -``` - -This example displays MySite information on UPA Proxy 1. - -## PARAMETERS - -### -ProfileServiceApplicationProxy -Specifies the unique identifier for the proxy. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of object to display. - -The type is any one of the following values: - -- MySiteReaderACL -- MySiteHostReaderACL -- UserACL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseQuota.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseQuota.md deleted file mode 100644 index 5e08356e48..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseQuota.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectDatabaseQuota -schema: 2.0.0 ---- - -# Get-SPProjectDatabaseQuota - -## SYNOPSIS -Microsoft internal use only. - -## SYNTAX - -``` -Get-SPProjectDatabaseQuota -Url <Uri> [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Microsoft internal use only. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -PS C:\> -``` - -## PARAMETERS - -### -Url -Microsoft internal use only. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Microsoft internal use only. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseUsage.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseUsage.md deleted file mode 100644 index 51cfecfdea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseUsage.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectDatabaseUsage -schema: 2.0.0 ---- - -# Get-SPProjectDatabaseUsage - -## SYNOPSIS -Returns an approximate size, in megabytes (MB) of the Project Web App data used in the content database. - -## SYNTAX - -``` -Get-SPProjectDatabaseUsage [-AssignmentCollection <SPAssignmentCollection>] -Url <Uri> [<CommonParameters>] -``` - -## DESCRIPTION -Returns an approximate size, in megabytes (MB) of the Project Web App data used in the content database. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPProjectDatabaseUsage -Url http://contoso.com/sites/pwa -``` - -This example shows the size of the Project Web App data in the content data for the Project Web App site at http://contoso.com/sites/pwa. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the Project Web App site collection. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEnterpriseProjectTaskSync.md deleted file mode 100644 index d393029a2f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEnterpriseProjectTaskSync.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectEnterpriseProjectTaskSync -schema: 2.0.0 ---- - -# Get-SPProjectEnterpriseProjectTaskSync - -## SYNOPSIS -Returns whether the task list sync between Project Web App and project sites is enabled or disabled. This cmdlet returns a value only if the feature has previously been enabled or disabled. - -## SYNTAX - -``` -Get-SPProjectEnterpriseProjectTaskSync [-AssignmentCollection <SPAssignmentCollection>] -Url <Uri> - [<CommonParameters>] -``` - -## DESCRIPTION -Returns whether the task list sync between Project Web App and project sites is enabled or disabled. This cmdlet returns a value only if the feature has previously been enabled or disabled. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPProjectEnterpriseProjectTaskSync -Url http://contoso/sites/PWA -``` - -This example shows the syntax for getting the task sync status for the Project Web App site at http://contoso/sites/PWA. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the PWA site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEventServiceSettings.md deleted file mode 100644 index 335bc52c6a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEventServiceSettings.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectEventServiceSettings -schema: 2.0.0 ---- - -# Get-SPProjectEventServiceSettings - -## SYNOPSIS -Returns the settings for the Microsoft Project Server Events Service. There is currently only one setting which is the port that the service listens on for requests. - -## SYNTAX - -``` -Get-SPProjectEventServiceSettings [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns the settings for the Microsoft Project Server Events Service. There is currently only one setting which is the port that the service listens on for requests. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPProjectEventServiceSettings -``` - -This example shows what port the service is listening on. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019, Project Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectIsEmailNotificationEnabled.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectIsEmailNotificationEnabled.md deleted file mode 100644 index 6bd71cf6e4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectIsEmailNotificationEnabled.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2016, Project Server 2019 -title: Get-SPProjectIsEmailNotificationEnabled -schema: 2.0.0 ---- - -# Get-SPProjectIsEmailNotificationEnabled - -## SYNOPSIS -Returns the Project Web App site level setting for email notifications. True if notifications is turned on, False otherwise. - -## SYNTAX - -``` -Get-SPProjectIsEmailNotificationEnabled [-Url] <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Returns the Project Web App site level setting for email notifications. True if notifications is turned on, False otherwise. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPProjectIsEmailNotificationEnabled -Url http://contoso/sites/pwa -``` - -Returns the status of email notifications for the PWA site http://contoso/sites/pwa. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the Project Web App site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectOdataConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectOdataConfiguration.md deleted file mode 100644 index 9a131df065..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectOdataConfiguration.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectOdataConfiguration -schema: 2.0.0 ---- - -# Get-SPProjectOdataConfiguration - -## SYNOPSIS -Returns the settings for how the OData service is configured for an instance of Project Web App. - -## SYNTAX - -``` -Get-SPProjectOdataConfiguration [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPProjectOdataConfiguration cmdlet returns the settings for how the OData service is configured for an instance of Project Web App. -It returns the current settings for a list of parameters that specify paging, the enabling of various querying functionality, whether MaxResultsPerCollection has been enabled, and whether verbose errors are enabled. -The cmdlet can also be used to return an itemized list of entities that have an override specified for their maximum page size. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ----------------------EXAMPLE 1----------------------- -``` -PS C:\>Get-SPProjectOdataConfiguration -``` - -This example returns the OData configuration for the instance of Project Web App. - -### ----------------------EXAMPLE 2----------------------- -``` -C:\PS>(Get-SPProjectOdataConfiguration).EntitySetsWithMaxPAgeSizeOverride -``` - -This example returns the list of entities that have the MaxPageSizeOverride option configured. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectPCSSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectPCSSettings.md deleted file mode 100644 index 26632ddc10..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectPCSSettings.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectPCSSettings -schema: 2.0.0 ---- - -# Get-SPProjectPCSSettings - -## SYNOPSIS -Gets the settings for the Project Calculation Engine on the Project Server. - -## SYNTAX - -``` -Get-SPProjectPCSSettings [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPProjectPCSSettings cmdlet lets users read the settings that control the operations of the Project Calculation Engine on Project Server. -The cmdlet requires you to identify the Project Server Service Application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPProjectPCSSettings -sa "Project Service Application" -``` - -This example reads the settings for the Project Calculation Engine running on the "Project Service Application" service application. - -## PARAMETERS - -### -ServiceApplication -The Project Server Service Application for which the settings are to be read. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectPermissionMode.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectPermissionMode.md deleted file mode 100644 index 504aad62bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectPermissionMode.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectPermissionMode -schema: 2.0.0 ---- - -# Get-SPProjectPermissionMode - -## SYNOPSIS -Returns the permission mode for a Project Web App (PWA) instance. - -## SYNTAX - -``` -Get-SPProjectPermissionMode [-Url] <Uri> [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPProjectPermissionMode cmdlet returns the presently configured permission mode for the provided PWA instance. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------EXAMPLE 1------------------- -``` -PS C:\>Get-SPProjectPermissionMode -Url http://AppServer/pwa -``` - -This example returns the permission mode setting for a PWA instance. - -## PARAMETERS - -### -Url -Specifies the URL of the PWA instance for which you want to retrieve the permission mode. - -The type must be a valid URL, in the form http://\<ServerName\>/\<PWASite\>. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPProjectPermissionMode](Set-SPProjectPermissionMode.md) - -[Invoke-SPProjectActiveDirectoryGroupSync](Invoke-SPProjectActiveDirectoryGroupSync.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectQueueSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectQueueSettings.md deleted file mode 100644 index a735b4a0a0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectQueueSettings.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectQueueSettings -schema: 2.0.0 ---- - -# Get-SPProjectQueueSettings - -## SYNOPSIS -Returns a list of all Project Server Queue settings and their current values for the specified Project Server Service Application. - -## SYNTAX - -``` -Get-SPProjectQueueSettings [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns a list of all Project Server Queue settings and their current values for a specific Project Server Service Application. -Settings returned include the following: - -- MaxDegreeOfConcurrency -- MsgRetryInterval -- MsgRetryLimit -- SqlRetryInterval -- SqlRetryLimit -- SqlCommandTimeout -- CleanupSuccessAgeLimit -- CleanupNonSuccessAgeLimit -- PeriodicTasksInterval -- QueueTimeout -- MaxConnections - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Get-SPProjectQueueSettings -ServiceApplication "Project Service Application" -``` - -This example retrieves the queue settings for the "Project Service Application" service application. - -## PARAMETERS - -### -ServiceApplication -Specifies the Project Server service application to target. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg; a valid name of a Project Server Service Application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectWebInstance.md deleted file mode 100644 index c872c18e46..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectWebInstance.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Get-SPProjectWebInstance -schema: 2.0.0 ---- - -# Get-SPProjectWebInstance - -## SYNOPSIS -Returns an instance of a Project Web App site. - -## SYNTAX - -``` -Get-SPProjectWebInstance [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Url <Uri>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPProjectWebInstance cmdlet returns an instance of a Project Web App site, including the following information: - -- ID (GUID) -- Service application name -- Parent web app -- Project Web App URL -- Locale identifier (LCID) -- Admin account -- Project Web App database server -- Database name for the Project Web App database -- Provisioning status -- Report center status -- Site ID (GUID) - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPProjectWebInstance -Url http://server/pwa -``` - -This example returns the properties for a Project Web App instance at http://server/pwa. - -## PARAMETERS - -### -ServiceApplication -Specifies the name of the Project Server service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Web App instance (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Specifies the URL of the Project Web App instance to get. - -The type must be a valid URL, in the form http://\<server_name\>/\<PWA_name\>. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRequestManagementSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRequestManagementSettings.md deleted file mode 100644 index 11ea318d3a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRequestManagementSettings.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPRequestManagementSettings -schema: 2.0.0 ---- - -# Get-SPRequestManagementSettings - -## SYNOPSIS - -Returns a Request Manager object. - - - -## SYNTAX - -``` -Get-SPRequestManagementSettings [-Identity] <SPRequestManagementSettingsPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPRequestManagementSettings cmdlet returns a Request Manager object which is base for performing any request manager management operation. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE------- -``` -PS C:\>Get-SPRequestManagementSettings -Identity <GUID> -``` - -This example returns a request manager object for a specified identity. - -## PARAMETERS - -### -Identity -Specifies the web-application for which a user wants to enable routing or throttling. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPRequestManagementSettings](Set-SPRequestManagementSettings.md) - -[New-SPRequestManagementRuleCriteria](New-SPRequestManagementRuleCriteria.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingMachineInfo.md deleted file mode 100644 index 664f7cc3a4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingMachineInfo.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPRoutingMachineInfo -schema: 2.0.0 ---- - -# Get-SPRoutingMachineInfo - -## SYNOPSIS - -Returns all the routing targets. - - - -## SYNTAX - -``` -Get-SPRoutingMachineInfo [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Availability <SPRoutingMachineAvailability>] - [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPRoutingMachineInfo cmdlet to return all the routing targets that are being used by the Request Manager object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE------------ -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -PS C:\>Get-SPRoutingMachineInfo -RequestManagementSettings $rm -``` - -This example returns a routing target for a specified identity. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to return. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Availability -Specifies whether or not the specified computer will be available for routing. -If no value is specified, all computers are returned. - -The values for this parameter are filtered based on availability. - -The valid values are: - ---Available ---Unavailable - -```yaml -Type: SPRoutingMachineAvailability -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the computer for which you want to return routing information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingMachineInfo](Add-SPRoutingMachineInfo.md) - -[Remove-SPRoutingMachineInfo](Remove-SPRoutingMachineInfo.md) - -[Set-SPRoutingMachineInfo](Set-SPRoutingMachineInfo.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingMachinePool.md deleted file mode 100644 index 73261e7718..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingMachinePool.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPRoutingMachinePool -schema: 2.0.0 ---- - -# Get-SPRoutingMachinePool - -## SYNOPSIS - -Returns all available routing pools. - - - -## SYNTAX - -``` -Get-SPRoutingMachinePool [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPRoutingMachinePool cmdlet to return all available routing pools by using the RequestManagementSettings parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE--------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -PS C:\>Get-SPRoutingMachinePool -RequestManagementSettings $rm -``` - -This example returns a routing pool for the specified identity. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to return. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the machine pool to return. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingMachinePool](Add-SPRoutingMachinePool.md) - -[Remove-SPRoutingMachinePool](Remove-SPRoutingMachinePool.md) - -[Set-SPRoutingMachinePool](Set-SPRoutingMachinePool.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingRule.md deleted file mode 100644 index 451f667de0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPRoutingRule.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPRoutingRule -schema: 2.0.0 ---- - -# Get-SPRoutingRule - -## SYNOPSIS - -Returns all routing rules. - - - -## SYNTAX - -``` -Get-SPRoutingRule [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPRoutingRule cmdlet to return routing rules for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE------------ -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -PS C:\>Get-SPRoutingRule -RequestManagementSettings $rm -``` - -This example returns a routing rule for the farm. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to return. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule to return. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingRule](Add-SPRoutingRule.md) - -[Remove-SPRoutingRule](Remove-SPRoutingRule.md) - -[Set-SPRoutingRule](Set-SPRoutingRule.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabase.md deleted file mode 100644 index 55cccdf1a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabase.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPScaleOutDatabase -schema: 2.0.0 ---- - -# Get-SPScaleOutDatabase - -## SYNOPSIS - -Returns all scale-out database objects. - - - -## SYNTAX - -``` -Get-SPScaleOutDatabase -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPScaleOutDatabase cmdlet to returns all scale-out database objects for the specified service application. - -A scale-out database is a database which implements the Shared Service Database Scale Out Generic Protocol. -For additional information about the Database Scale Out Generic Protocol, see SharePoint Shared Service Database Scale Out Generic Protocol Specification (http://msdn.microsoft.com/en-us/library/hh656675(office.12).aspx) - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE-------------- -``` -C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" - -PS C:\>Get-SPScaleOutDatabase -ServiceApplication $serviceApplication -``` - -This example gets all scale-out databases for the given service application by using the $serviceApplication variable. - -## PARAMETERS - -### -ServiceApplication -Specifies the service application of the scale-out databases. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPScaleOutDatabase](Add-SPScaleOutDatabase.md) - -[Remove-SPScaleOutDatabase](Remove-SPScaleOutDatabase.md) - -[Split-SPScaleOutDatabase](Split-SPScaleOutDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseDataState.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseDataState.md deleted file mode 100644 index 3e37b50c90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseDataState.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPScaleOutDatabaseDataState -schema: 2.0.0 ---- - -# Get-SPScaleOutDatabaseDataState - -## SYNOPSIS - -Returns the state information about the specified scale-out database. - - - -## SYNTAX - -### UnattachedDatabase -``` -Get-SPScaleOutDatabaseDataState -ConnectionString <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-IsAzureDatabase] [-WhatIf] [<CommonParameters>] -``` - -### AttachedDatabase -``` -Get-SPScaleOutDatabaseDataState -Database <SPDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Get-SPScaleOutDatabaseDataState cmdlet to return state information about the specified scale-out database or about the database which will be connected with the specified connection string. -The database state information includes total count of partitions, total weight of the partitions, the range and the subranges of the database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE-------------- -``` -C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -PS C:\>Get-SPScaleOutDatabaseDataState -Database $database -``` - -This example gets the data state of the scale-out database for the first scale-out database of the given service application. - -## PARAMETERS - -### -ConnectionString -Specifies the connection string for the scale-out database from which to return the state information. - -```yaml -Type: String -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -Specifies the scale-out database to return the state information about. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAzureDatabase -Specifies whether the state information of the scale-out database is in the form of a Microsoft SQL Azure Database. - -```yaml -Type: SwitchParameter -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseInconsistency.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseInconsistency.md deleted file mode 100644 index 692039352c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseInconsistency.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPScaleOutDatabaseInconsistency -schema: 2.0.0 ---- - -# Get-SPScaleOutDatabaseInconsistency - -## SYNOPSIS - -Displays all inconsistencies related to scale-out databases' ranges. - - - -## SYNTAX - -``` -Get-SPScaleOutDatabaseInconsistency -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPScaleOutDatabaseInconsistency cmdlet to return all inconsistencies related to scale out databases' ranges and subranges for a specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE-------------- -``` -C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" - -PS C:\>Get-SPScaleOutDatabaseInconsistency -ServiceApplication $serviceApplication -``` - -This example gets all the scale-out inconsistencies for the given service application. - -## PARAMETERS - -### -ServiceApplication -Specifies the service application for which to return the scale-out inconsistencies. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseLogEntry.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseLogEntry.md deleted file mode 100644 index 6b3c52c2d6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPScaleOutDatabaseLogEntry.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPScaleOutDatabaseLogEntry -schema: 2.0.0 ---- - -# Get-SPScaleOutDatabaseLogEntry - -## SYNOPSIS - -Queries a scale-out database for scale-out logs. - - - -## SYNTAX - -``` -Get-SPScaleOutDatabaseLogEntry -Count <Int32> -Database <SPDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-CorrelationId <Guid>] - [-MajorAction <SPScaleOutDatabaseMajorAction>] [-RangeLimitPoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPScaleOutDatabaseLogEntry cmdlet to query a scale-out database for scale-out logs that include specified criteria. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE----------- -``` -C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -PS C:\>Get-SPScaleOutDatabaseLogEntry -Database $database -Count 10 -MajorAction DataMove -``` - -This example gets the 10 most recent scale-out log entries from the first scale-out database of the given service application. - -## PARAMETERS - -### -Count -Specifies the number of scale-out log entries to return. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -Specifies the scale-out database from which to return the scale-out logs - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CorrelationId -Specifies the correlation id of the scale-out logs to be returned. -Correlation id of the log entries that belong to the same major action are the same. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MajorAction -Specifies the major action of the scale-out log entries to be returned. -The values are the following: - -DataMove -A data migration operation between two scale-out databases. - -Recovery -Any data recovery operation that is performed to recover from a failure. - -```yaml -Type: SPScaleOutDatabaseMajorAction -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RangeLimitPoint - -Specifies the range limit point of the scale-out log entries to be returned. - -The range limit point has different meaning depending on the action that records the log entry. - ---If the action is to create, change or delete a data subrange, the range limit point represents the following: ---If the action targets a lower data subrange, the range limit point represents the start point of that lower data subrange. ---If the action targets an upper data subrange, the range limit point represents the end point of that upper data subrange. ---If the action is to extend a data range, the range limit point represents the following: ---If the action extends the start point of the data range, range limit point represents the new start point of the data range. ---If the action extends the end point of the data range, range limit point represents the new end point of the data range. - - - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreApplication.md deleted file mode 100644 index e576fe3fa3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreApplication.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSecureStoreApplication -schema: 2.0.0 ---- - -# Get-SPSecureStoreApplication - -## SYNOPSIS -Returns a Secure Store application. - -## SYNTAX - -### NameSet -``` -Get-SPSecureStoreApplication -Name <String> -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### AllSet -``` -Get-SPSecureStoreApplication -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-All] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPSecureStoreApplication cmdlet returns a Secure Store application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" -``` - -This example gets the Secure Store application for the target application with the name ContosoTargetApplication. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPSecureStoreApplication -ServiceContext http://contoso -All -``` - -This example returns all of the Secure Store applications http://contoso. - -## PARAMETERS - -### -Name -Specifies the name of the Secure Store application to get. - -```yaml -Type: String -Parameter Sets: NameSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context for the local Secure Store application to connect to. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -All -Returns all secure store applications for the given Service Context. - -```yaml -Type: SwitchParameter -Parameter Sets: AllSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreSystemAccount.md deleted file mode 100644 index 00503df92c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreSystemAccount.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSecureStoreSystemAccount -schema: 2.0.0 ---- - -# Get-SPSecureStoreSystemAccount - -## SYNOPSIS -Returns a list of users from a designated list. - -## SYNTAX - -``` -Get-SPSecureStoreSystemAccount [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSecureStoreSystemAccount cmdlet to return a list of user accounts which are considered to be a system account. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE---------- -``` -PS C:\>Get-SPSecureStoreSystemAccount -``` - -This example returns a list of user accounts for the secure store system. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPSecureStoreSystemAccount](Add-SPSecureStoreSystemAccount.md) - -[Remove-SPSecureStoreSystemAccount](Remove-SPSecureStoreSystemAccount.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecurityTokenServiceConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecurityTokenServiceConfig.md deleted file mode 100644 index 6b2f811dbc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecurityTokenServiceConfig.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSecurityTokenServiceConfig -schema: 2.0.0 ---- - -# Get-SPSecurityTokenServiceConfig - -## SYNOPSIS - -Returns the security token service (STS) for the farm. - - - -## SYNTAX - -``` -Get-SPSecurityTokenServiceConfig [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPSecurityTokenServiceConfig cmdlet reads the security token service (STS) for the farm. -An STS authenticates security tokens in incoming SOAP messages. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Set-SPSecurityTokenServiceConfig -ServiceTokenLifetime 1000 -``` - -This example gets the security token service (STS) for the farm and sets the expiration for the service token cache to 1000 minutes. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServer.md deleted file mode 100644 index 5521421685..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServer.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServer -schema: 2.0.0 ---- - -# Get-SPServer - -## SYNOPSIS -Returns the server or servers in the farm that match the given identity. - - -## SYNTAX - -``` -Get-SPServer [[-Identity] <SPServerPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPServer cmdlet returns the SPServer object for the given identity (if it exists in the farm). -If no parameters are specified, the cmdlet returns all servers in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPServer -``` - -This example returns all servers in the local farm in a list. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPServer | Where{ $_.NeedsUpgrade -eq $TRUE} -``` - -This example returns a list of all servers in the farm that need an upgrade. - -## PARAMETERS - -### -Identity -Specifies the address of the server to return. - -```yaml -Type: SPServerPipeBind -Parameter Sets: (All) -Aliases: Address -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabase.md deleted file mode 100644 index 07007f0464..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabase.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServerScaleOutDatabase -schema: 2.0.0 ---- - -# Get-SPServerScaleOutDatabase - -## SYNOPSIS - -Returns all scale-out database objects. - - - -## SYNTAX - -``` -Get-SPServerScaleOutDatabase -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPServerScaleOutDatabase cmdlet to return all scale-out database objects for the specified service application. - -A scale-out database is a database which implements the Shared Service Database Scale Out Generic Protocol. -For more information, see SharePoint Shared Service Database Scale Out Generic Protocol Specification (https://go.microsoft.com/fwlink/p/?LinkId=273867) - - - - -## EXAMPLES - -### ----------EXAMPLE-------------- -``` -C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" - -PS C:\>Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -``` - -This example gets all scale-out databases for the given service application by using the $serviceApplication variable. - - -## PARAMETERS - -### -ServiceApplication - -Specifies the service application of the scale-out databases. - - - - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-SPServerScaleOutDatabase](Add-SPServerScaleOutDatabase.md) - -[Remove-SPServerScaleOutDatabase](Remove-SPServerScaleOutDatabase.md) - -[Split-SPServerScaleOutDatabase](Split-SPServerScaleOutDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseDataState.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseDataState.md deleted file mode 100644 index d4e50d2351..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseDataState.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServerScaleOutDatabaseDataState -schema: 2.0.0 ---- - -# Get-SPServerScaleOutDatabaseDataState - -## SYNOPSIS - -Returns the state information about the specified scale-out database. - - - - -## SYNTAX - -### UnattachedDatabase -``` -Get-SPServerScaleOutDatabaseDataState -ConnectionString <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-IsAzureDatabase] [-WhatIf] [<CommonParameters>] -``` - -### AttachedDatabase -``` -Get-SPServerScaleOutDatabaseDataState -Database <SPDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Get-SPServerScaleOutDatabaseDataState cmdlet to return state information about the specified scale-out database or about the database which will be connected with the specified connection string. -The database state information includes total count of partitions, total weight of the partitions, the range and the subranges of the database. - - - - -## EXAMPLES - -### ----------------EXAMPLE-------------- -``` -C:\PS>$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -PS C:\>Get-SPServerScaleOutDatabaseDataState -Database $database -``` - -This example gets the data state of the scale-out database for the first scale-out database of the given service application. - - -## PARAMETERS - -### -ConnectionString - -Specifies the connection string for the scale-out database from which to return the state information. - - - - - -```yaml -Type: String -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database - -Specifies the scale-out database for which the command returns state information. - - - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAzureDatabase - -Specifies whether the state information of the scale-out database is in the form of a Microsoft Windows Azure SQL Database. - - - - - -```yaml -Type: SwitchParameter -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseInconsistency.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseInconsistency.md deleted file mode 100644 index 39aab295d2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseInconsistency.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServerScaleOutDatabaseInconsistency -schema: 2.0.0 ---- - -# Get-SPServerScaleOutDatabaseInconsistency - -## SYNOPSIS - -Displays all inconsistencies related to scale-out databases' ranges. - - - - -## SYNTAX - -``` -Get-SPServerScaleOutDatabaseInconsistency -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPServerScaleOutDatabaseInconsistency cmdlet to return all inconsistencies related to scale out databases' ranges and subranges for a specified service application. - - - - -## EXAMPLES - -### -------------EXAMPLE-------------- -``` -C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" - -PS C:\>Get-SPServerScaleOutDatabaseInconsistency -ServiceApplication $serviceApplication -``` - -This example gets all the scale-out inconsistencies for the given service application. - -## PARAMETERS - -### -ServiceApplication - -Specifies the service application for which to return the scale-out inconsistencies. - - - - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseLogEntry.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseLogEntry.md deleted file mode 100644 index ab79ec3e26..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServerScaleOutDatabaseLogEntry.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServerScaleOutDatabaseLogEntry -schema: 2.0.0 ---- - -# Get-SPServerScaleOutDatabaseLogEntry - -## SYNOPSIS - -Queries a scale-out database for scale-out logs. - - - -## SYNTAX - -``` -Get-SPServerScaleOutDatabaseLogEntry -Count <Int32> -Database <SPDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-CorrelationId <Guid>] - [-MajorAction <SPScaleOutDatabaseMajorAction>] [-RangeLimitPoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Get-SPServerScaleOutDatabaseLogEntry cmdlet to query a scale-out database for scale-out logs that include specified criteria. - - - -## EXAMPLES - -### -------------EXAMPLE----------- -``` -C:\PS>$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -PS C:\>Get-SPServerScaleOutDatabaseLogEntry -Database $database -Count 10 -MajorAction DataMove -``` - -This example gets the 10 most recent scale-out log entries from the first scale-out database of the given service application. - - -## PARAMETERS - -### -Count - -Specifies the number of scale-out log entries to return. - - - - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database - -Specifies the scale-out database from which to return the scale-out logs - - - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CorrelationId - -Specifies the correlation id of the scale-out logs to be returned. -Correlation id of the log entries that belong to the same major action are the same. - - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MajorAction - -Specifies the major action of the scale-out log entries to be returned. -The values are the following: - -DataMove -A data migration operation between two scale-out databases. - -Recovery -Any data recovery operation that is performed to recover from a failure. - - - - -```yaml -Type: SPScaleOutDatabaseMajorAction -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RangeLimitPoint - -Specifies the range limit point of the scale-out log entries to be returned. - -The range limit point has different meaning depending on the action that records the log entry. - - - - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPService.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPService.md deleted file mode 100644 index 77104e88ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPService.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPService -schema: 2.0.0 ---- - -# Get-SPService - -## SYNOPSIS -Gets a service in the farm. - -## SYNTAX - -``` -Get-SPService [[-Identity] <SPServicePipeBind>] [-All] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPService cmdlet gets a service in the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPService -Identity 'Microsoft SharePoint Server Diagnostics Service' -``` - -This example gets the Microsoft SharePoint Server Diagnostics Service in the farm. - -## PARAMETERS - -### -All -Specifies all services in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of the service to get. - -```yaml -Type: SPServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServicePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplication.md deleted file mode 100644 index d82f4413f7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplication.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceApplication -schema: 2.0.0 ---- - -# Get-SPServiceApplication - -## SYNOPSIS - -Returns the specified service application. - - - -## SYNTAX - -``` -Get-SPServiceApplication [[-Identity] <SPServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPServiceApplication cmdlet returns the service application specified by the Identity parameter. -If no parameter is specified, the cmdlet returns all service applications in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1---------------------- -``` -PS C:\>Get-SPServiceApplication -``` - -This example returns all service applications in the farm. - -### ------------------EXAMPLE 2---------------------- -``` -PS C:\>Get-SPServiceApplication -Identity e2c2be70-6382-4ce7-8a44-ae7dadff5597 -``` - -This example returns the service application that has the Identity "e2c2be70-6382-4ce7-8a44-ae7dadff5597". - -### ------------------EXAMPLE 3---------------------- -``` -PS C:\>Get-SPServiceApplication -Name AccountingServiceApp -``` - -This example returns the service application that has the friendly name "AccountingServiceApp". - -You can use either the Identity or the Name parameter but if you use both, the command will process the Identity first and ignore the Name. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application to get. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the new usage application.The type must be a valid name of a usage application; for example, UsageApplication1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationEndpoint.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationEndpoint.md deleted file mode 100644 index 7f39d18d9a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationEndpoint.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceApplicationEndpoint -schema: 2.0.0 ---- - -# Get-SPServiceApplicationEndpoint - -## SYNOPSIS - -Returns the endpoint of a service application. - - - -## SYNTAX - -### Identity -``` -Get-SPServiceApplicationEndpoint [-Identity] <SPServiceEndpointPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### Name -``` -Get-SPServiceApplicationEndpoint -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPServiceApplicationEndpoint cmdlet sets the host of a service endpoint. -Use the second parameter set and do not specify the Name parameter to return a collection of all endpoints for the specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE-------------------- -``` -PS C:\>Get- SPServiceApplicationEndpoint -ServiceApplication "ServiceSubApp1" -``` - -This example returns the SPServiceEndpoint object based on the specified service application. - -## PARAMETERS - -### -Identity -Specifies the service endpoint to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form http://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object. - -```yaml -Type: SPServiceEndpointPipeBind -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the service application endpoint. - -The type must be a valid name of an service application endpoint; for example, SvcAppEndpoint1. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationPool.md deleted file mode 100644 index 0d8930d757..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationPool.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceApplicationPool -schema: 2.0.0 ---- - -# Get-SPServiceApplicationPool - -## SYNOPSIS - -Returns the specified Internet Information Services (IIS) application pool. - - - -## SYNTAX - -``` -Get-SPServiceApplicationPool [[-Identity] <SPIisWebServiceApplicationPoolPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPServiceApplicationPool cmdlet returns the IIS application pool specified by the Identity parameter, or returns all application pools if the Identity parameter is not specified. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPServiceApplicationPool -``` - -This example returns all the service application pools in the farm. - -## PARAMETERS - -### -Identity -Specifies the name or identifier (ID) of the application pool to get. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationProxy.md deleted file mode 100644 index 08ea250f3e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationProxy.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPServiceApplicationProxy - -## SYNOPSIS - -Returns an instance of the specified service application proxy. - - - -## SYNTAX - -``` -Get-SPServiceApplicationProxy [[-Identity] <SPServiceApplicationProxyPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPServiceApplicationProxy cmdlet returns an instance of the service application proxy specified by the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPServiceApplicationProxy -``` - -This example retrieves all the service application proxies in the farm. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application proxy to return. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationProxyGroup.md deleted file mode 100644 index cee25d77a4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationProxyGroup.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceApplicationProxyGroup -schema: 2.0.0 ---- - -# Get-SPServiceApplicationProxyGroup - -## SYNOPSIS - -Returns the proxy group for the specified service application. - - - -## SYNTAX - -### Identity -``` -Get-SPServiceApplicationProxyGroup [[-Identity] <SPServiceApplicationProxyGroupPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### Default identity -``` -Get-SPServiceApplicationProxyGroup [-Default] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPServiceApplicationProxyGroup cmdlet displays a list of the proxy groups in the farm. -To display a specific proxy group, use the Identity parameter. -If no parameter value is specified, a list of all proxy groups is displayed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPServiceApplicationProxyGroup -``` - -This example retrieves all of the service application proxy groups in the farm. - -## PARAMETERS - -### -Identity -Specifies the name or the GUID of the proxy group. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Default -Returns the default service proxy group for the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: Default identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationSecurity.md deleted file mode 100644 index fb2a603688..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceApplicationSecurity.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceApplicationSecurity -schema: 2.0.0 ---- - -# Get-SPServiceApplicationSecurity - -## SYNOPSIS - -Returns the SPObjectSecurity object for a service application. - - - -## SYNTAX - -``` -Get-SPServiceApplicationSecurity [-Identity] <SPServiceApplicationPipeBind> [-Admin] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPServiceApplicationSecurity cmdlet returns a security object for the specified service application. -Use this cmdlet with the Grant-SPObjectSecurity and Set-SPServiceApplicationSecurity cmdlets to manage security for a service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin -Grant-SPObjectSecurity $security $principal "Full Control" -Set-SPServiceApplicationSecurity $serviceApp -Admin $security -``` - -This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application, and adds a new user principal to that ACL. -The new user is an administrator for the service application $serviceApp. - -## PARAMETERS - -### -Identity -Specifies the service application to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, SearchServiceApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Admin -Returns the access control list (ACL) that contains the administrators list of the service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceContext.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceContext.md deleted file mode 100644 index 29f278ca23..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceContext.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceContext -schema: 2.0.0 ---- - -# Get-SPServiceContext - -## SYNOPSIS - -Returns a service context. - - - -## SYNTAX - -### Site -``` -Get-SPServiceContext [-Site] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### SiteSubscription -``` -Get-SPServiceContext -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPServiceContext cmdlet returns a service context or a collection of service contexts. -Specify the Site parameter to return an individual service context, or specify the SiteSubscription parameter to return a collection of service contexts. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE--------------- -``` -C:\PS>$sitesub = Get-SPSiteSubscription http://my.contoso.com/ - -PS C:\>Get-SPServiceContext $sitesub -``` - -This example returns the service context for a site in a hosted environment. - -## PARAMETERS - -### -Site -Returns the service context for only the Web application that contains the specified site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: Site -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Returns all of the service contexts for all Web applications in which the specified site subscription has site collections. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceHostConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceHostConfig.md deleted file mode 100644 index fc3f3f9efc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceHostConfig.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceHostConfig -schema: 2.0.0 ---- - -# Get-SPServiceHostConfig - -## SYNOPSIS - -Returns the common Web service settings. - - - -## SYNTAX - -``` -Get-SPServiceHostConfig [-AssignmentCollection <SPAssignmentCollection>] [-Default] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPServiceHostConfig returns the common Web service settings. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE------------------- -``` -PS C:\>Get-SPServiceHostConfig -``` - -This example displays the Web service settings. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Default -This parameter has no effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceInstance.md deleted file mode 100644 index 9190aacb03..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPServiceInstance.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPServiceInstance -schema: 2.0.0 ---- - -# Get-SPServiceInstance - -## SYNOPSIS - -Returns the services instance for a specific server or the entire farm. - - - -## SYNTAX - -### Identity -``` -Get-SPServiceInstance [[-Identity] <SPServiceInstancePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-All] [<CommonParameters>] -``` - -### Server -``` -Get-SPServiceInstance -Server <SPServerPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-All] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPServiceInstance cmdlet returns the services instance specified by the Identity parameter for a specific server. -If the Server parameter is not specified, the Get-SPServiceInstance cmdlet returns results for the entire farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPServiceInstance -Server ServerA -``` - -This example displays the service instances from a given server. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service instance. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPServiceInstancePipeBind -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the server from which to return the service instance. - -```yaml -Type: SPServerPipeBind -Parameter Sets: Server -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -All -Returns all services instance in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSessionStateService.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSessionStateService.md deleted file mode 100644 index f9dabc02ef..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSessionStateService.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSessionStateService -schema: 2.0.0 ---- - -# Get-SPSessionStateService - -## SYNOPSIS -Returns the properties of the session state service, including time-out and database settings. - -## SYNTAX - -``` -Get-SPSessionStateService [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPSessionStateService cmdlet reads the properties of the session state service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPSessionStateService -``` - -This example returns the current configuration of the session state service. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPShellAdmin.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPShellAdmin.md deleted file mode 100644 index 26a3ad14af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPShellAdmin.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPShellAdmin -schema: 2.0.0 ---- - -# Get-SPShellAdmin - -## SYNOPSIS - -Returns the names of all users who have the SharePoint_Shell_Access role. - - - -## SYNTAX - -``` -Get-SPShellAdmin [[-database] <SPDatabasePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPShellAdmin cmdlet to return the names of all users who have the SharePoint_Shell_Access role in a database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE---------------------- -``` -PS C:\>Get-SPShellAdmin -database 4251d855-3c15-4501-8dd1-98f960359fa6 -``` - -This example returns the name of each user who has the SharePoint_Shell_Access role in the database specified. - -## PARAMETERS - -### -database -Specifies the GUID of the database or the Databse Object that includes the SharePoint_Shell_Access role whose user names you want to display. -If the database parameter is not specified, the configuration database is used. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSite.md deleted file mode 100644 index c102acae5a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSite.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSite -schema: 2.0.0 ---- - -# Get-SPSite - -## SYNOPSIS - -Returns all site collections that match the specified criteria. - - - -## SYNTAX - -### AllSitesInIdentity -``` -Get-SPSite [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] [-Confirm] [-Filter <ScriptBlock>] [-Limit <String>] [-Regex] [-WhatIf] - [<CommonParameters>] -``` - -### AllSitesInContentDB -``` -Get-SPSite -ContentDatabase <SPContentDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] [-Confirm] [-Filter <ScriptBlock>] [-Limit <String>] [-WhatIf] - [-NeedsB2BUpgrade] [<CommonParameters>] -``` - -### AllSitesInSiteSubscription -``` -Get-SPSite -SiteSubscription <SPSiteSubscriptionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] [-Confirm] [-Filter <ScriptBlock>] [-Limit <String>] [-WhatIf] - [<CommonParameters>] -``` - -### AllSitesInWebApplication -``` -Get-SPSite [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <Int32>] [-Confirm] - [-Filter <ScriptBlock>] [-Limit <String>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPSite cmdlet returns either a single site that matches the Identity parameter, or all the sites that match the Filter parameter for the specified scope. -The scopes are the WebApplication, ContentDatabase , and SiteSubscription parameters. -If none of these scopes is provided, the scope is the farm. -If the scope is specified with no Filter parameter, all sites in that scope are returned. - -The Identity parameter supports providing a partial URL that ends in a wildcard character (*). -All site collections that match this partial URL for the specified scope are returned. -Additionally, if the Regex parameter is provided, the Identity parameter is treated as a regular expression and any site collection with a URL provided in the given scope that matches the expression is returned. - -The Filter parameter is a server-side filter for certain site collection properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. -These site collection properties are Owner, SecondaryOwner, and LockState. -The Filter parameter is a script block that uses the same syntax as a Where-Object statement, but is run on the server for faster results. - -Valid values for LockState are: Unlock, NoAdditions, ReadOnly, NoAccess. - -It is important to note that every site collection that the Get-SPSite cmdlet returns is automatically destroyed at the end of the pipeline. -To store the results of Get-SPSite in a local variable, use the Start-SPAssignment and Stop-SPAssignment cmdlets to avoid memory leaks. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1--------------------- -``` -PS C:\>Get-SPSite 'http://<site name>' | Get-SPWeb -Limit All | Select Title -``` - -This example gets the collection of subweb titles in site collection at http://\<site name\>. - -### ------------------EXAMPLE 2--------------------- -``` -PS C:\>Get-SPSite -ContentDatabase "b399a366-d899-4cff-8a9b-8c0594ee755f" | Format-Table -Property Url, Owner, SecondaryOwner -``` - -This example gets a subset of data from all sites in the content database b399a366-d899-4cff-8a9b-8c0594ee755f. - -### ------------------EXAMPLE 3--------------------- -``` -PS C:\>Start-SPAssignment -Global - -PS C:\>$s = Get-SPSite -Identity http://<MyApp>/Sites/Site1 - -PS C:\>$s.Url - -PS C:\>Stop-SPAssignment -Global -``` - -This example gets the sites specified by the Identity parameter and inserts the results in the variable s - -The previous example uses the Global method of assignment collection. -The Global method is easy to use but the contents of this object grows quickly. -Be careful not to run a Get-SPSite command that returns many results while global assignment is enabled. - -### ------------------EXAMPLE 4--------------------- -``` -PS C:\>$GC = Start-SPAssignment -PS C:\>$Sites = $GC | Get-SPSite -Filter {$_.Owner -eq "DOMAIN\JDow"} -Limit 50 -PS C:\>Stop-SPAssignment $GC -``` - -This example gets the first 50 sites owned by user DOMAIN\JDow by using a server-side query, and assigns them to a local variable. - -This example uses advanced assignment collection methods. - -### ------------------EXAMPLE 5--------------------- -``` -PS C:\>Get-SPWebApplication http://<site name> | Get-SPSite -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.Usage.Storage }{$sum} -``` - -This example shows a command that returns the sum of the disk space usage for all sites in a given web application. - -### ------------------EXAMPLE 6--------------------- -``` -PS C:\>Get-SPSite -Identity "http://localserver/(my|personal)/sites" -Regex -``` - -This example returns all sites that match the given regular expression. - -The Quotes on the Identity parameter are required when the Regex parameter is used. - -### ------------------EXAMPLE 7--------------------- -``` -PS C:\>Get-SPSite http://<site name>/sites/teams/* -Limit 100 -``` - -This example gets up to 100 of the sites under the URL http://sitename/sites/teams. - -### ------------------EXAMPLE 8--------------------- -``` -PS C:\>Get-SPSite | select url, @{Expression={$_.Usage.Storage}} -``` - -This example gets the amount of storage used by a site collection, by using the storage field of the .UsageInfo property. - -### ------------------EXAMPLE 9--------------------- -``` -PS C:\>Get-SPSite -Limit all -CompatibilityLevel 14 -``` - -This example returns all SharePoint Server mode site collections. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site collection to get. - -The type must be a valid URL, in the form, http://server_name or http://server_name/sites/sitename, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPSitePipeBind -Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the GUID of the content database from which to list site collections. - -The type must be a valid database name, in the form, SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site subscription from which to get site collections. - -The type must be a valid URL, in the form, http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: AllSitesInSiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. -This value sets the initial CompatibilityLevel value for the site collection. -The values for this parameter can be either SharePoint Server or SharePoint Server. -When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies the script block of the server-side filter to apply. - -The type must be a valid filter name and value in the form {$_PropertyName \<operator\> "filterValue"}. - -Valid operators are: EQ, NE, LIKE, NOTLIKE. - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Limits the maximum number of site collections to return. -The default value is 200. - -The type must be a valid non-negative number. -Specify ALL to return all site collections for the given scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Regex -When used, the URL provided for the Identity parameter is treated as a regular expression. - -```yaml -Type: SwitchParameter -Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the web application from which to list sites. - -The type must be a valid URL, in the form, http://server_name, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the name of the web application (for example, WebApplication1212). - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: AllSitesInWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NeedsB2BUpgrade -Specifies whether the site needs to be upgraded. - -The valid values are True and False. - -```yaml -Type: SwitchParameter -Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteAdministration.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteAdministration.md deleted file mode 100644 index 3332b15f87..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteAdministration.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteAdministration -schema: 2.0.0 ---- - -# Get-SPSiteAdministration - -## SYNOPSIS - -Returns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access. - - - -## SYNTAX - -### AllSitesInIdentity -``` -Get-SPSiteAdministration [-Identity] <SPSiteAdministrationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Filter <ScriptBlock>] [-Limit <String>] [-Regex] - [-WhatIf] [<CommonParameters>] -``` - -### AllSitesInContentDB -``` -Get-SPSiteAdministration -ContentDatabase <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Filter <ScriptBlock>] [-Limit <String>] - [-WhatIf] [<CommonParameters>] -``` - -### AllSitesInSiteSubscription -``` -Get-SPSiteAdministration -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Filter <ScriptBlock>] [-Limit <String>] - [-WhatIf] [<CommonParameters>] -``` - -### AllSitesInWebApplication -``` -Get-SPSiteAdministration [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Filter <ScriptBlock>] - [-Limit <String>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPSiteAdminitration cmdlet returns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPSiteAdministration | Select -Property Url, OwnerLoginName, @{Name="Storage";Expression={$_.Quota.StorageMaximumLevel}} -``` - -This example gets a subset of data from all of the sites in the content database with the URL b399a366-d899-4cff-8a9b-8c0594ee755f (farm administrator does not require access). -This command uses the calculated property Storage to display the maximum storage value for the content database. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Start-SPAssignment -Global -$s = Get-SPSiteAdministration -Identity http://MyApp/Sites/Site1 -$s.Url -Stop-SPAssignment -Global -``` - -This example gets the site collections specified by the Identity parameter and inserts the results into the variable s. -This example uses the Global method of garbage collection. -This method is easier to use but grows quickly. -Do not run a Get-SPSite command that returns many results while global assignment is on. - -### ------------------EXAMPLE 3------------------- -``` -C:\PS>$GC = Start-SPAssignment -$Sites = $GC | Get-SPSiteAdministration -Filter {$_.Owner -eq "DOMAIN\JDoe"} -Limit 50 -Stop-SPAssignment $GC -``` - -This example gets the first 50 sites owned by user DOMAIN\JDoe by using a server-side query, and assigns the returned sites to a local variable. -This command uses advanced assignment collection methods. - -### ------------------EXAMPLE 4------------------ -``` -PS C:\>Get-SPWebApplication http://sitename | Get-SPSiteAdministration -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.DiskUsed }{$sum} -``` - -This command returns the sum of the disk space usage for all sites in the specified Web application. - -### ------------------EXAMPLE 5------------------ -``` -PS C:\>Get-SPWebApplication http://sitename | Get-SPSiteAdministration -Limit ALL | Select URL -``` - -This example gets the URLs for all site collections in a Web application. - -### ------------------EXAMPLE 6------------------ -``` -PS C:\>Get-SPSiteAdministration -identity "http://localserver/(my|personal)/sites" -Regex -``` - -This example returns all sites that match the given regular expression. -The quotation marks around the value specified for the Identity parameter are required when using the Regex flag. - -### ------------------EXAMPLE 7------------------ -``` -PS C:\>Get-SPSite "http://sitename/sites/teams/*" -Limit 100 -``` - -This example gets up to 100 of the sites under the URL http://sitename/sites/teams. - -## PARAMETERS - -### -Identity -Specifies the URL (full or partial) or GUID of the site collection to retrieve. - -The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-456-987fg. - -```yaml -Type: SPSiteAdministrationPipeBind -Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the URL (full or partial) or GUID of the site collection to retrieve. - -The type must be a valid URL, in the form http://server_name, or a GUID, in the form, 1234-456-987fg. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site group from which to get site collections. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: AllSitesInSiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies the script block of the server-side filter to apply. - -The type must be a valid filter name and a value in the form { $_ PropertyName \<operator \> "filterValue"}} - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Limits the maximum number of site collections to return. -The default value is 200. - -The type must be a valid non-negative number. -Provide ALL to return all site collections for the given scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Regex -Enabling this switch causes the URL provided for the Identity parameter to be treated as a regular expression. - -```yaml -Type: SwitchParameter -Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the Web application from which to list sites. - -The type must be a valid URL, in the form http://server_name; a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the Web application name (for example, WebApplication1212). - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: AllSitesInWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteMapDatabase.md deleted file mode 100644 index a4b0674ce5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteMapDatabase.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteMapDatabase -schema: 2.0.0 ---- - -# Get-SPSiteMapDatabase - -## SYNOPSIS -Do not use - -## SYNTAX - -``` -Get-SPSiteMapDatabase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - -## EXAMPLES - -### Example 1 -``` -PS C:\>Do not use -``` - -Do not use - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteMaster.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteMaster.md deleted file mode 100644 index d86aead22d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteMaster.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016 -title: Get-SPSiteMaster -schema: 2.0.0 ---- - -# Get-SPSiteMaster - -## SYNOPSIS -Returns site master information. - -## SYNTAX - -``` -Get-SPSiteMaster [-ContentDatabase] <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSiteMaster cmdlet to display site master information in the farm. - -Typically the following information is displayed: - -* ContentDatabase - -* SiteId - -* TemplateName - -* Language - -* CompatibilityLevel - -* FeaturesToActivateOnCopy - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPSiteMaster -ContentDatabase WSS_Content -``` - -This example returns the site master in the database WSS_Content. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the name of the database to get the list of Site Masters. For example, WSS_Content. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPContentDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscription.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscription.md deleted file mode 100644 index 699ceedf8f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscription.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscription -schema: 2.0.0 ---- - -# Get-SPSiteSubscription - -## SYNOPSIS - -Returns the site subscription for the given URL or all site subscriptions in the local farm. - - - -## SYNTAX - -``` -Get-SPSiteSubscription [[-Identity] <SPSiteSubscriptionPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPSiteSubscription cmdlet returns the site subscription for the given URL when the Identity parameter is used. -If no parameter is specified, all unique site subscriptions in the farm are listed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE---------------------- -``` -C:\PS>$SiteSub = Get-SPSiteSubscription http://Contoso.com - -C:\PS>$SiteSub = Get-SPSite http://contoso.com | Get-SPSiteSubscription -``` - -This example retrieves the site subscription for http://Contoso.com. - -## PARAMETERS - -### -Identity -Specifies the ID of the subscription. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionConfig.md deleted file mode 100644 index 047eaf6835..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionConfig.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscriptionConfig -schema: 2.0.0 ---- - -# Get-SPSiteSubscriptionConfig - -## SYNOPSIS - -Returns the configuration properties of a site subscription. - - - -## SYNTAX - -``` -Get-SPSiteSubscriptionConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPSiteSubscriptionConfig cmdlet returns the configuration properties of a site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE--------------- -``` -PS C:\>Get-SPSiteSubscriptionConfig http://contoso.com | Select FeatureSet -``` - -This example gets the feature set ID for the site subscription that contains the Web site http://contoso.com. - -## PARAMETERS - -### -Identity -Specifies the site subscription configuration to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionEdiscoveryHub.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionEdiscoveryHub.md deleted file mode 100644 index 6542dce877..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionEdiscoveryHub.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscriptionEdiscoveryHub -schema: 2.0.0 ---- - -# Get-SPSiteSubscriptionEdiscoveryHub - -## SYNOPSIS -Displays the eDiscovery hub for a site subscription. - -## SYNTAX - -``` -Get-SPSiteSubscriptionEdiscoveryHub [-Identity] <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSiteSubscriptionEdiscoveryHub cmdlet to display the site collection configured as the eDiscovery hub for the specified site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE---------------------- -``` -PS C:\>Get-SPSiteSubscriptionEdiscoveryHub -Identity http://contoso.com -``` - -This example displays the eDiscovery hub for the specified site collection. - -## PARAMETERS - -### -Identity -Specifies the URL of the site collections to the eDiscovery hub. -Can pipe the result from the Get-SPSiteSubscription cmdlet. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionEdiscoverySearchScope.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionEdiscoverySearchScope.md deleted file mode 100644 index c3467aaba9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionEdiscoverySearchScope.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscriptionEdiscoverySearchScope -schema: 2.0.0 ---- - -# Get-SPSiteSubscriptionEdiscoverySearchScope - -## SYNOPSIS -Displays the search scope for the eDiscovery hub of the specified site collection. - -## SYNTAX - -``` -Get-SPSiteSubscriptionEdiscoverySearchScope [-Identity] <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSiteSubscriptionEdiscoverySearchScope cmdlet to retrieve the search scope that has been configured for the eDiscovery hub of the specified site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE-------------------- -``` -PS C:\>Get-SPSiteSubscriptionEdiscoverySearchScope - Identity http://contoso.com -``` - -This example displays the search scope for the eDiscovery hub for the specified site collection. - -## PARAMETERS - -### -Identity -Specifies the URL to the group of site collections that contained the search scope. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionFeaturePack.md deleted file mode 100644 index a9eef80341..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionFeaturePack.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscriptionFeaturePack -schema: 2.0.0 ---- - -# Get-SPSiteSubscriptionFeaturePack - -## SYNOPSIS - -Retrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription. - - - -## SYNTAX - -### FeaturePack -``` -Get-SPSiteSubscriptionFeaturePack [[-Identity] <SPSiteSubscriptionFeaturePackPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### SiteSubscription -``` -Get-SPSiteSubscriptionFeaturePack [-AssignmentCollection <SPAssignmentCollection>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPSiteSubscriptionFeaturePack cmdlet retrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription. - -Be careful when you assign Feature sets to variables because changes to the Feature set are not reflected until the variable is refreshed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get- SPSiteSubscriptionFeaturePack -``` - -This example returns all defined Feature sets in the local farm. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPSiteSubscriptionFeaturePack -SiteSubscription http://contoso.com | ForEach{ $_.FeatureDefinitions } -``` - -This example returns the list (name, ID, and scope) of all Features allowed in the Feature set that is currently assigned to the site subscription of http://contoso.com. - -## PARAMETERS - -### -Identity -Specifies a valid name or GUID of the Feature set. - -```yaml -Type: SPSiteSubscriptionFeaturePackPipeBind -Parameter Sets: FeaturePack -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -If provided, ensures that the returned Feature set is the Feature set that is currently assigned to the given site subscription. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionIRMConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionIRMConfig.md deleted file mode 100644 index bcc0a5f706..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionIRMConfig.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscriptionIRMConfig -schema: 2.0.0 ---- - -# Get-SPSiteSubscriptionIRMConfig - -## SYNOPSIS - -Gets the Information Rights Management (IRM) settings. - - - -## SYNTAX - -``` -Get-SPSiteSubscriptionIRMConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSiteSubscriptionIRMConfig cmdlet to display IRM setting information for a specified tenant when the Identity parameter is used. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE----------- -``` -PS C:\>site = Get-SPSite http://myspserver - -C:\PS>$subscription = $site.SiteSubscription - -PS C:\>Get-SPSiteSubscriptionIRMConfig -Identity $subscription -``` - -This example gets the IRM settings for a specified tenant by using the Identity parameter. - -## PARAMETERS - -### -Identity -Specifies the site subscription for a particular tenant. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPSiteSubscriptionIRMConfig](Set-SPSiteSubscriptionIRMConfig.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionMetadataConfig.md deleted file mode 100644 index 7e71ae144f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteSubscriptionMetadataConfig.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteSubscriptionMetadataConfig -schema: 2.0.0 ---- - -# Get-SPSiteSubscriptionMetadataConfig - -## SYNOPSIS -Returns the site subscription configuration settings for a Metadata Service application. - -## SYNTAX - -``` -Get-SPSiteSubscriptionMetadataConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSiteSubscriptionMetadataConfig cmdlet to read the site subscription configuration settings for a specified shared service application for the Metadata Service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>Get-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -``` - -This example retrieves the site subscription-specific settings for an existing partitioned Metadata Service application. - -## PARAMETERS - -### -Identity -Specifies the site subscription to read. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceProxy -Specifies the proxy of the metadata Service application for the site subscription. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteURL.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteURL.md deleted file mode 100644 index f860202bc2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteURL.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteURL -schema: 2.0.0 ---- - -# Get-SPSiteURL - -## SYNOPSIS - -Displays all URL mappings for the site. - - - -## SYNTAX - -``` -Get-SPSiteURL [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPSiteUrl cmdlet to display all the URL mappings of the site by using the Identity parameter. - -The Get-SPSiteUrl cmdlet only applies to the root site collection for a host name, that is http://www.contoso.com. -This cmdlet cannot be directly run against a managed path site collection underneath the root, that is, http://www.contoso.com/sites/test. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE---------- -``` -C:\PS>$site = Get-SPSite 'http://www.contoso.com/' - -PS C:\>Get-SPSiteURL -Identity $site -``` - -This example displays all the URLs that bind to the site collection, http://www.contoso.com. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site collection to display. -Must be the root site collection of a host name. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPSiteUrl](Remove-SPSiteUrl.md) - -[Set-SPSiteUrl](Set-SPSiteUrl.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteUpgradeSessionInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteUpgradeSessionInfo.md deleted file mode 100644 index 20f5e9adbc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSiteUpgradeSessionInfo.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSiteUpgradeSessionInfo -schema: 2.0.0 ---- - -# Get-SPSiteUpgradeSessionInfo - -## SYNOPSIS - -Manage or report site upgrade. - - - -## SYNTAX - -### ContentDB -``` -Get-SPSiteUpgradeSessionInfo -ContentDatabase <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-HideWaiting] [-ShowCompleted] [-ShowFailed] - [-ShowInProgress] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -### Site -``` -Get-SPSiteUpgradeSessionInfo -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Get-SPSiteUpgradeSessionInfo cmdlet to manage or report site upgrade of the farm. - -This cmdlet has two modes, get upgrade information for a specific SPSite object or for a given content database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE 1---------- -``` -C:\PS>$db = Get-SPContentDatabase -Identity wss_content - -PS C:\>Get-SPSiteUpgradeSessionInfo -ContentDatabase $db -``` - -This example returns siteupgradeinfo for every SPContentDatabase returned from Get-SPContentDatabase cmdlet. - -### -----------EXAMPLE 2---------- -``` -C:\PS>$site=Get-SPSite -Identity http://localhost - -PS C:\>Get-SPSiteUpgradeSessionInfo -Site $site -``` - -This example returns siteupgradeinfo for every SPSite object returned from Get-SPSite cmdlet. - -## PARAMETERS - -### -ContentDatabase -Specifies the GUID of the content database from which to list site collections.The type must be a valid database name, in the form SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -```yaml -Type: SPSitePipeBind -Parameter Sets: Site -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -HideWaiting -Specifies to hide site collections that upgrade has not started. - -```yaml -Type: SwitchParameter -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowCompleted -Specifies to show site collections that has completed upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowFailed -Specifies to show site collections that have failed upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowInProgress -Displays site collections that are in the process of being upgraded. - -```yaml -Type: SwitchParameter -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies to limit the result to site collections within the site subscription. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPSiteUpgradeSessionInfo](Remove-SPSiteUpgradeSessionInfo.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSolution.md deleted file mode 100644 index 4932408ed2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPSolution.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPSolution -schema: 2.0.0 ---- - -# Get-SPSolution - -## SYNOPSIS - -Returns a specified SharePoint solution. - - - -## SYNTAX - -``` -Get-SPSolution [[-Identity] <SPSolutionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPSolution cmdlet returns a specified SharePoint solution. -If the Identity parameter is not specified, this cmdlet returns the collection of all installed SharePoint solutions in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPSolution -``` - -This example returns the collection of all installed SharePoint solutions in the farm. - -## PARAMETERS - -### -Identity -Specifies the SharePoint solution to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. - -```yaml -Type: SPSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceApplication.md deleted file mode 100644 index e778568eff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceApplication.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPStateServiceApplication -schema: 2.0.0 ---- - -# Get-SPStateServiceApplication - -## SYNOPSIS -Returns state service applications on the farm. - -## SYNTAX - -``` -Get-SPStateServiceApplication [[-Identity] <SPStateServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPStateServiceApplication cmdlet returns a state service application on the farm. -If the Identity parameter is not specified, this cmdlet returns the collection of all state service applications on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPStateServiceApplication -``` - -This example displays all state service applications in the farm. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPStateServiceApplication -Identity "StateServiceApp1" -``` - -This example displays a specific state service application in the farm. - -## PARAMETERS - -### -Identity -Specifies the state service application to get. - -The type must be a valid name of a state service application (for example, StateServiceApp1) or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceApplicationProxy.md deleted file mode 100644 index 8130f91aa5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceApplicationProxy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPStateServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPStateServiceApplicationProxy - -## SYNOPSIS -Returns state service application proxies on the farm. - -## SYNTAX - -``` -Get-SPStateServiceApplicationProxy [[-Identity] <SPStateServiceApplicationProxyPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPStateServiceApplicationProxy cmdlet returns a state service application proxy on the farm. -If the Identity parameter is not specified, this cmdlet returns the collection of all state service application proxies on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPStateServiceApplicationProxy -``` - -This example displays all the state service application proxies on the farm. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPStateServiceApplicationProxy -Identity 81dc50e0-c0f9-4d2c-8284-bb03bb1ea676 -``` - -This example displays a specific state service application proxy on the farm. - -## PARAMETERS - -### -Identity -Specifies the state service application proxy to get. - -The type must be a valid name of a state service application proxy (for example, StateServiceProxy); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPStateServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceDatabase.md deleted file mode 100644 index a41b24bd4e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPStateServiceDatabase.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Get-SPStateServiceDatabase - -## SYNOPSIS -Returns a state service database. - -## SYNTAX - -### Default -``` -Get-SPStateServiceDatabase [[-Identity] <SPStateDatabasePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### ServiceApplication -``` -Get-SPStateServiceDatabase [[-ServiceApplication] <SPStateServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPStateServiceDatabase cmdlet returns a state service database on the farm. -If the Identity parameter is not specified, this cmdlet returns the collection of all state service databases on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1---------------- -``` -PS C:\>Get-SPStateServiceDatabase -``` - -This example displays all of the state service databases on the farm. - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -``` - -This example displays a specific state service database in the farm. - -### --------------EXAMPLE 3-------------- -``` -PS C:\>Get-SPStateServiceDatabase -ServiceApplication "StateServiceApp1" -``` - -This example displays all state service databases associated with a specific service. - -## PARAMETERS - -### -Identity -Specifies the state service database to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPStateServiceDatabase object (for example, StateSvcDB1). - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: Default -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Filters to return only the state service database associated with the specified state service application. - -The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: ServiceApplication -Aliases: Application -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTaxonomySession.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTaxonomySession.md deleted file mode 100644 index 9997347324..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTaxonomySession.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTaxonomySession -schema: 2.0.0 ---- - -# Get-SPTaxonomySession - -## SYNOPSIS -Returns a TaxonomySession object. - -## SYNTAX - -``` -Get-SPTaxonomySession -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPTaxonomySession cmdlet to get a TaxonomySession object. -A TaxonomySession object contains the set of metadata term stores for a taxonomy session. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE-------------------- -``` -C:\PS>$session = Get-SPTaxonomySession -Site "http://sitename/" -``` - -This example retrieves a TaxonomySession object, which can be used to access term stores associated with the Web application for a site. - -## PARAMETERS - -### -Site -Specifies the SharePoint site mapped to the set of metadata term stores for the taxonomy session. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPThrottlingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPThrottlingRule.md deleted file mode 100644 index 5d061916ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPThrottlingRule.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPThrottlingRule -schema: 2.0.0 ---- - -# Get-SPThrottlingRule - -## SYNOPSIS - -Returns all throttling rules. - - - -## SYNTAX - -``` -Get-SPThrottlingRule [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPThrottlingRule cmdlet to return all the throttling rules from the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE-------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -PS C:\>Get-SPThrottlingRule -RequestManagementSettings $rm -``` - -This example returns throttling rules for the farm by using the $rm and $web variables. - -## PARAMETERS - -### -RequestManagementSettings -Specifies the name of the request management settings object to return. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the throttling rule to return. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPThrottlingRule](Add-SPThrottlingRule.md) - -[Remove-SPThrottlingRule](Remove-SPThrottlingRule.md) - -[Set-SPThrottlingRule](Set-SPThrottlingRule.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTimerJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTimerJob.md deleted file mode 100644 index 49ca270fa0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTimerJob.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTimerJob -schema: 2.0.0 ---- - -# Get-SPTimerJob - -## SYNOPSIS - -Returns timer jobs. - -## SYNTAX - -``` -Get-SPTimerJob [[-Identity] <SPTimerJobPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Type <String>] [-WebApplication <SPWebApplicationPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPTimerJob cmdlet reads a specified timer job, timer jobs of a specified type, or timer jobs defined for a specified scope. - -If no parameters are specified, this cmdlet returns all timer job definitions for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES -### ---------------------EXAMPLE 01--------------------- -``` -PS C:\>Get-SPTimerJob -WebApplication "http://servername/" | select Name, DisplayName -``` - -This example displays all timer jobs for a specified Web application. - -### ---------------------EXAMPLE 02--------------------- -```powershell -PS C:\>Get-SPTimerJob | select -ExpandProperty HistoryEntries -``` -The above example will show you timer job run history - -## PARAMETERS - -### -Identity -Specifies the timer job to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. - -```yaml -Type: SPTimerJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Filters to return timer jobs of a specified type. - -The type must be a name of a valid timer job type; for example, TimerJob1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Filters to return timer jobs defined for the scope of a specified SharePoint Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTopologyServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTopologyServiceApplication.md deleted file mode 100644 index 3fb6c4ee83..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTopologyServiceApplication.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.TopologyService-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTopologyServiceApplication -schema: 2.0.0 ---- - -# Get-SPTopologyServiceApplication - -## SYNOPSIS - -Displays properties of the topology service application for the current farm. - - - -## SYNTAX - -``` -Get-SPTopologyServiceApplication [[-Identity] <SPTopologyWebServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPTopologyServiceApplication cmdlet displays the advanced properties of an application when the Identity parameter is used. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPTopologyServiceApplication -``` - -This example displays properties of the topology service application for the current farm. - -## PARAMETERS - -### -Identity -Specifies the GUID of the application. - -The type must be a valid GUID, in the form 1234-4567-098jhj. - -```yaml -Type: SPTopologyWebServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTopologyServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTopologyServiceApplicationProxy.md deleted file mode 100644 index f754749f5f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTopologyServiceApplicationProxy.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.TopologyService-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTopologyServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPTopologyServiceApplicationProxy - -## SYNOPSIS - -Retrieves the topology service application proxy. - - - -## SYNTAX - -``` -Get-SPTopologyServiceApplicationProxy [[-Identity] <SPTopologyWebServiceProxyPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPTopologyServiceApplicationProxy cmdlet retrieves the local topology service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPTopologyServiceApplicationProxy -``` - -This example displays the topology service application proxy in the farm. - -## PARAMETERS - -### -Identity -Specifies the GUID of the application proxy. - -The type must be a valid GUID, in the form 1234-4567-098jhj. - -```yaml -Type: SPTopologyWebServiceProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTranslationThrottlingSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTranslationThrottlingSetting.md deleted file mode 100644 index f48e9867f1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTranslationThrottlingSetting.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Translation.dll-Help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTranslationThrottlingSetting -schema: 2.0.0 ---- - -# Get-SPTranslationThrottlingSetting - -## SYNOPSIS -Gets time duration settings. - -## SYNTAX - -``` -Get-SPTranslationThrottlingSetting [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Farm <SPFarm>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPTranslationThrottlingSetting cmdlet to display the time duration for timer jobs. - -## EXAMPLES - -### Example 1 -``` -Get-SPTranslationThrottlingSetting -``` - -This example displays all the time duration and timer jobs for the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -``yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Farm -Specifies the farm - -```yaml -Type: SPFarm -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedIdentityTokenIssuer.md deleted file mode 100644 index 0c8c747674..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedIdentityTokenIssuer.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTrustedIdentityTokenIssuer -schema: 2.0.0 ---- - -# Get-SPTrustedIdentityTokenIssuer - -## SYNOPSIS - -Returns an identity provider. - - - -## SYNTAX - -``` -Get-SPTrustedIdentityTokenIssuer [[-Identity] <SPTrustedIdentityTokenIssuerPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPTrustedIdentityTokenIssuer cmdlet returns an identity provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------------EXAMPLE 1------------------------ -``` -C:\PS>$trustedsts = Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" -``` - -This example gets a trusted identity token issuer. - -## PARAMETERS - -### -Identity -Specifies the identity provider to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedRootAuthority.md deleted file mode 100644 index 2c3f3de1de..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedRootAuthority.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTrustedRootAuthority -schema: 2.0.0 ---- - -# Get-SPTrustedRootAuthority - -## SYNOPSIS - -Returns a trusted root authority. - - - -## SYNTAX - -``` -Get-SPTrustedRootAuthority [[-Identity] <SPTrustedRootAuthorityPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPTrustedRootAuthority cmdlet returns a trusted root authority. -If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$rootauthority=Get-SPTrustedRootAuthority -Identity "WFEFarm1" -``` - -This example creates a new trusted root authority, WFEFarm1. - -## PARAMETERS - -### -Identity -Specifies the trusted root authority to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. - -```yaml -Type: SPTrustedRootAuthorityPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedSecurityTokenIssuer.md deleted file mode 100644 index 34d92b1e45..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedSecurityTokenIssuer.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTrustedSecurityTokenIssuer -schema: 2.0.0 ---- - -# Get-SPTrustedSecurityTokenIssuer - -## SYNOPSIS - -Returns the trusted security token issuer object. - - - -## SYNTAX - -``` -Get-SPTrustedSecurityTokenIssuer [[-Identity] <SPTrustedSecurityTokenServicePipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPTrustedSecurityTokenService cmdlet to return the trusted security token issuer by using the Identity parameter. -This cmdlet returns the T:Microsoft.SharePoint.Administration.Claims.SPSecurityTokenServiceManager object. -The properties on this object can be set by using the Set-SPTrustedSecurityTokenIssuer cmdlet and then updated back to the object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE---------- -``` -PS C:\>Get-SPTrustedSecurityTokenService -``` - -This example displays all trusted security token service objects from the farm. - -## PARAMETERS - -### -Identity -Specifies the ID of the trusted security token issuer object that you want to return. -If you do not specify this parameter, the cmdlet returns all the objects. - -```yaml -Type: SPTrustedSecurityTokenServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPTrustedSecurityTokenIssuer](New-SPTrustedSecurityTokenIssuer.md) - -[Remove-SPTrustedSecurityTokenIssuer](Remove-SPTrustedSecurityTokenIssuer.md) - -[Set-SPTrustedSecurityTokenIssuer](Set-SPTrustedSecurityTokenIssuer.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedServiceTokenIssuer.md deleted file mode 100644 index 37d82e6f00..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPTrustedServiceTokenIssuer.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPTrustedServiceTokenIssuer -schema: 2.0.0 ---- - -# Get-SPTrustedServiceTokenIssuer - -## SYNOPSIS - -Returns the object that represents the farm trust. - - - -## SYNTAX - -``` -Get-SPTrustedServiceTokenIssuer [[-Identity] <SPTrustedServiceTokenIssuerPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPTrustedServiceTokenIssuer cmdlet returns the object that represents the farm trust. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPTrustedServiceTokenIssuer "WFEFarm1" -``` - -This example gets the trusted services token issuer WFEFarm1. - -## PARAMETERS - -### -Identity -Specifies the trusted service token issuer to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. - -```yaml -Type: SPTrustedServiceTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUpgradeActions.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUpgradeActions.md deleted file mode 100644 index 7a0803d92e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUpgradeActions.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUpgradeActions -schema: 2.0.0 ---- - -# Get-SPUpgradeActions - -## SYNOPSIS - -Returns all upgrade actions. - - - -## SYNTAX - -``` -Get-SPUpgradeActions [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPUpgradeActions cmdlet to return all upgrade actions (that is, detail on the action name, type, target object type, schema version, and compatibility level) within the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE------------ -``` -PS C:\>Get-SPUpgradeActions -``` - -This example returns all upgrade actions within the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageApplication.md deleted file mode 100644 index 468f6c8423..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageApplication.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUsageApplication -schema: 2.0.0 ---- - -# Get-SPUsageApplication - -## SYNOPSIS - -Returns a specified usage application. - - - -## SYNTAX - -``` -Get-SPUsageApplication [[-Identity] <SPUsageApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-UsageService <SPUsageServicePipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUsageApplication cmdlet return a specified usage application. -If the Identity parameter is not specified, the cmdlet returns the local usage application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE------------------ -``` -PS C:\>Get-SPUsageApplication -Identity "Usage and Health data collection" -``` - -This example returns the usage application named, Usage and Health data collection - -## PARAMETERS - -### -Identity -Specifies the usage application to get. -If the Identity parameter is not specified, the cmdlet returns the local usage application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object. - -```yaml -Type: SPUsageApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UsageService -Filters to return the usage application with the specified parent SPUsageService object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. - -```yaml -Type: SPUsageServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageDefinition.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageDefinition.md deleted file mode 100644 index c69592b276..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageDefinition.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUsageDefinition -schema: 2.0.0 ---- - -# Get-SPUsageDefinition - -## SYNOPSIS - -Returns a usage definition object. - - - -## SYNTAX - -``` -Get-SPUsageDefinition [[-Identity] <SPUsageDefinitionPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUsageDefinition cmdlet reads a usage definition object. -If the Identity parameter is not specified, this cmdlet returns the collection of usage definitions in the farm. -A usage definition object defines a specific type of usage. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE----------------- -``` -PS C:\>Get-SPUsageDefinition -Identity "Page Requests" -``` - -This example returns the SPRequestUsage provider on the local farm. - -## PARAMETERS - -### -Identity -Specifies the usage definition object to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object. - -```yaml -Type: SPUsageDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageService.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageService.md deleted file mode 100644 index 46218483c0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUsageService.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUsageService -schema: 2.0.0 ---- - -# Get-SPUsageService - -## SYNOPSIS - -Returns a usage service. - - - -## SYNTAX - -``` -Get-SPUsageService [[-Identity] <SPUsageServicePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUsageService cmdlet returns the specified usage service. -If the Identity parameter is not specified, the cmdlet returns the local usage service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE------------------------- -``` -PS C:\>Get-SPUsageService -Identity 57055d99-9914-4af6-a3bf-7b76e3f231c2 -``` - -This example returns a SPUsageService object of the specified ID. - -## PARAMETERS - -### -Identity -Specifies the usage service to get. -If the Identity parameter is not specified, the cmdlet returns the local usage service. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. - -```yaml -Type: SPUsageServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUser.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUser.md deleted file mode 100644 index 833fe5be03..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUser.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUser -schema: 2.0.0 ---- - -# Get-SPUser - -## SYNOPSIS - -Returns the user account or accounts that match a given search criteria. - - - -## SYNTAX - -``` -Get-SPUser [[-Identity] <SPUserPipeBind>] -Web <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Group <SPGroupPipeBind>] [-Limit <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUser cmdlet returns all SharePoint user accounts that match the scope given by the Identity, Web, or Group parameters. - -The Identity parameter can use the alias of a user for returning exact matches. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPUser -Web 'https://sharepoint.contoso.com/' -Group 'Viewers' -``` - -This example returns all members of the SharePoint group Viewers on the site https://sharepoint.contoso.com. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPUser -Identity 'i:0#.w|contoso\jdoe' -Web 'https://sharepoint.contoso.com/' -``` - -This example returns the specific user identified via Windows Claims on the site https://sharepoint.contoso.com. - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>Get-SPUser -Identity 'contoso\jdoe' -Web 'https://sharepoint.contoso.com/' -``` - -This example returns the specific user identified via Classic Windows authentication on the site https://sharepoint.contoso.com. - -## PARAMETERS - -### -Identity -Specifies the ID or login name of the user to be returned. - -The type must be a valid ID or login name, such as the format of 'CONTOSO\jdoe' for Classic Windows Authentication or 'i:0#.w|CONTOSO\jdoe' for Windows Claims. - -```yaml -Type: SPUserPipeBind -Parameter Sets: (All) -Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Web -Specifies the Web site to be used as a scope. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Foundation Web site (for example, MySPSite1); or an instance of a valid SPWeb object. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Group -Specifies the user group to which the new user belongs. - -```yaml -Type: SPGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Specifies the maximum number of users to return. -The default value is 500. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicense.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicense.md deleted file mode 100644 index 02d5455d85..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicense.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserLicense -schema: 2.0.0 ---- - -# Get-SPUserLicense - -## SYNOPSIS - -Returns the list of supported SharePoint user licenses. - - - -## SYNTAX - -``` -Get-SPUserLicense [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUserLicense cmdlet returns the list of supported SharePoint user licenses in the SharePoint farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE------------------- -``` -PS C:\>Get-SPUserLicense -``` - -This example returns the list of supported SharePoint user licenses for the SharePoint farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicenseMapping.md deleted file mode 100644 index 104c2eb16f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicenseMapping.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserLicenseMapping -schema: 2.0.0 ---- - -# Get-SPUserLicenseMapping - -## SYNOPSIS - -Returns the claim-to-user license mappings. - - - -## SYNTAX - -``` -Get-SPUserLicenseMapping [-AssignmentCollection <SPAssignmentCollection>] - [-WebApplication <SPWebApplicationPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUserLicenseMapping cmdlet returns the claim-to-user license mappings for the entire SharePoint farm or a specific web application. - -Getting the mappings for the entire farm does not retrieve any specific mappings on a web application. - -If you specify no parameters, the license mappings for the entire farm are returned. -To display the license mappings for a specific web application, use the WebApplication parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPUserLicenseMapping -``` - -This example returns all claim-to-user license mappings for the entire SharePoint farm. - -### ---------------EXAMPLE 2 ----------------- -``` -PS C:\>Get-SPUserLicenseMapping -WebApplication "SharePoint - 80" -``` - -This example returns all claim-to-user license mappings for the web application with the name "SharePoint - 80". - -### ---------------EXAMPLE 3 ----------------- -``` -PS C:\>Get-SPUserLicenseMapping -WebApplication http://<server_name>/sitename -``` - -This example returns all claim-to-user license mappings for the Web application with the URL http://\<server_name\>/sites/sitename. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, web application name, or instance of a web application object from which to get the user license mappings. -The type must be an URL in the form http://server_name or http://server_name/sites/sitename, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh), a web application name (that is, SharePoint - 80), or an instance of a web application object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPUserLicenseMapping](Add-SPUserLicenseMapping.md) - -[Remove-SPUserLicenseMapping](Remove-SPUserLicenseMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicensing.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicensing.md deleted file mode 100644 index a061bc606b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserLicensing.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserLicensing -schema: 2.0.0 ---- - -# Get-SPUserLicensing - -## SYNOPSIS - -Returns the state of user-license enforcement. - - - -## SYNTAX - -``` -Get-SPUserLicensing [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUserLicensing cmdlet returns the state of user-license enforcement for an entire SharePoint farm. - -If user-license enforcement is enabled on a SharePoint farm, the return value is true. -Otherwise the value is false. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE------------- -``` -PS C:\>Get-SPUserLicensing -``` - -This example returns the state of user-license enforcement on the SharePoint farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-SPUserLicensing](Disable-SPUserLicensing.md) - -[Enable-SPUserLicensing](Enable-SPUserLicensing.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSettingsProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSettingsProvider.md deleted file mode 100644 index 9b83895799..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSettingsProvider.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserSettingsProvider -schema: 2.0.0 ---- - -# Get-SPUserSettingsProvider - -## SYNOPSIS - -Returns a list of User Settings Providers installed on the farm. - - - -## SYNTAX - -``` -Get-SPUserSettingsProvider [[-Identity] <SPUserSettingsProviderPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPUserSettingsProvider cmdlet to return a list of User Settings Providers. -To return a list of a specific user setting provider, use the Identity parameter. -Otherwise, the list for the entire farm is returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE-------- -``` -C:\PS>$provider = Get-SPUserSettingsProvider - -C:\PS>$site = Get-SPSite -Identity http://someserver - -C:\PS>$user = $site.RootWeb.CurrentUser - -PS C:\>ctx = $provider.GetProviderContext($user) - -C:\PS>$provider.GetUserRegionalSettings($ctx,$user) -``` - -This example returns the regional settings for a specified user. - -## PARAMETERS - -### -Identity -Specifies the GUID ID for a User Settings Provider. - -```yaml -Type: SPUserSettingsProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPUserSettingsProvider](New-SPUserSettingsProvider.md) - -[Remove-SPUserSettingsProvider](Remove-SPUserSettingsProvider.md) - -[Get-SPUserSettingsProviderManager](Get-SPUserSettingsProviderManager.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSettingsProviderManager.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSettingsProviderManager.md deleted file mode 100644 index f24fd7354b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSettingsProviderManager.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserSettingsProviderManager -schema: 2.0.0 ---- - -# Get-SPUserSettingsProviderManager - -## SYNOPSIS - -Returns the User Settings Provider Manager. - - - -## SYNTAX - -``` -Get-SPUserSettingsProviderManager [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPUserSettingsProviderManager cmdlet to return the User Settings Provider Manager for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE-------- -``` -PS C:\>Get-SPUserSettingsProviderManager -``` - -This example returns the User Settings Provider Manager for the farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPUserSettingsProvider](Get-SPUserSettingsProvider.md) - -[New-SPUserSettingsProvider](New-SPUserSettingsProvider.md) - -[Remove-SPUserSettingsProvider](Remove-SPUserSettingsProvider.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSolution.md deleted file mode 100644 index d39ad52790..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSolution.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserSolution -schema: 2.0.0 ---- - -# Get-SPUserSolution - -## SYNOPSIS - -Returns a specified sandboxed solution. - - - -## SYNTAX - -``` -Get-SPUserSolution [[-Identity] <SPUserSolutionPipeBind>] -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPUserSolution cmdlet returns a specified sandboxed solution. -If the Identity parameter is not specified, this cmdlet returns the collection of sandboxed solutions in the site collection. -A user solution is a sandboxed solution. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE--------------------- -``` -PS C:\>Get-SPUserSolution -Site http://sitename -``` - -This example displays information about sandboxed solutions in the site http://sitename. - -## PARAMETERS - -### -Identity -Specifies the sandboxed solution to get. - -The type must be a valid name of a user solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. - -```yaml -Type: SPUserSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection that contains the sandboxed solution. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSolutionAllowList.md deleted file mode 100644 index 037afd7a04..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPUserSolutionAllowList.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPUserSolutionAllowList -schema: 2.0.0 ---- - -# Get-SPUserSolutionAllowList - -## SYNOPSIS -Gets the user managed solutions gallery configured on the specified web application. - -## SYNTAX - -``` -Get-SPUserSolutionAllowList [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -WebApplication <SPWebApplicationPipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the user managed solutions gallery configured on the specified web application. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPUserSolutionAllowList -WebApplication http://webAppUrl -``` -This example gets the user managed solutions gallery on the web application with root http://webAppUrl. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the web application to search for the user solution allow list. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioExternalData.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioExternalData.md deleted file mode 100644 index aa42153f35..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioExternalData.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPVisioExternalData -schema: 2.0.0 ---- - -# Get-SPVisioExternalData - -## SYNOPSIS -Returns the settings for external data connections for a Visio Services application. - -## SYNTAX - -``` -Get-SPVisioExternalData -VisioServiceApplication <SPVisioServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPVisioExternalData cmdlet reads the service settings for managing settings that are related to connecting to external data. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------------ -``` -PS C:\>Get-SPVisioExternalData -VisioServiceApplication "VGS1" -``` - -This example gets settings related to external data for a Visio Services application. - -### ------------------EXAMPLE 2------------------------ -``` -PS C:\>Get-SPVisioServiceApplication -identity "VGS1" | Get-SPVisioExternalData -``` - -This example uses a pipe bind to get settings related to external data for a Visio Services application. - -## PARAMETERS - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioExternalData object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioPerformance.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioPerformance.md deleted file mode 100644 index cda5fd14db..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioPerformance.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPVisioPerformance -schema: 2.0.0 ---- - -# Get-SPVisioPerformance - -## SYNOPSIS -Returns the Visio Services settings for the performance of a Visio Services application. - -## SYNTAX - -``` -Get-SPVisioPerformance -VisioServiceApplication <SPVisioServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPVisioPerformance cmdlet reads the service settings for managing and configuring peformance for a Visio Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE---------------------- -``` -PS C:\>Get-SPVisioPerformance -VisioServiceApplication "VGS1" -``` - -This example gets settings related to performance for a Visio Services application. - -## PARAMETERS - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioPerformance object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioSafeDataProvider.md deleted file mode 100644 index 8732279245..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioSafeDataProvider.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPVisioSafeDataProvider -schema: 2.0.0 ---- - -# Get-SPVisioSafeDataProvider - -## SYNOPSIS -Returns the settings of a safe data provider for a Visio Services application. - -## SYNTAX - -``` -Get-SPVisioSafeDataProvider -VisioServiceApplication <SPVisioServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-DataProviderId <String>] [-DataProviderType <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPVisioSafeDataProvider cmdlet retrieves the settings of the safe provider for a Visio Services application. -If the DataProviderID parameter is not specified, this cmdlet returns the collection of safe providers in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE 1---------------------- -``` -PS C:\>Get-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -``` - -This example returns a list of safe data providers for a specific Visio Services application. - -### -------------------EXAMPLE 2---------------------- -``` -PS C:\>Get-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "SQLOLEDB" -DataProviderType 1 -``` - -This example returns information about a specified safe data provider for a specific Visio Services application. - -## PARAMETERS - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataProviderId -Specifies the safe data provider to get. -The combination of DataProviderID and DataProviderType uniquely identify a data provider for a Visio Graphics Service application. -The string that identifies the data provider can be a maximum of 255 alphanumeric characters. - -The type must be a valid string that identifies the data provider; for example, VisioDataProvider1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataProviderType -Specifies the supported type of the data provider to get. -Custom data types are supported; for example, Excel services. - -The type must be a valid identity of a data provider type. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioServiceApplication.md deleted file mode 100644 index 0b3a2d4241..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioServiceApplication.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPVisioServiceApplication -schema: 2.0.0 ---- - -# Get-SPVisioServiceApplication - -## SYNOPSIS -Returns properties of a Visio Services application or a collection of Visio Services applications. - -## SYNTAX - -``` -Get-SPVisioServiceApplication [[-Identity] <SPVisioServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPVisioServiceApplication cmdlet retrieves the settings of the specified Visio Services application. -If the Identity parameter is not specified, this cmdlet returns the collection of Visio Services applications in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------------EXAMPLE 1------------------------- -``` -PS C:\>Get-SPVisioServiceApplication -``` - -This example returns a collection of all Visio Services applications in the farm. - -### -----------------------EXAMPLE 2------------------------- -``` -PS C:\>Get-SPVisioServiceApplication "VGS1" -``` - -This example returns properties of the VGS1 Visio Services application. - -## PARAMETERS - -### -Identity -Specifies the Visio Services application to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioServiceApplicationProxy.md deleted file mode 100644 index b626bb5b49..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPVisioServiceApplicationProxy.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPVisioServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPVisioServiceApplicationProxy - -## SYNOPSIS -Returns properties of a Visio Services application proxy or a collection of Visio Services application proxies. - -## SYNTAX - -``` -Get-SPVisioServiceApplicationProxy [[-Identity] <SPVisioServiceApplicationProxyPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPVisioServiceApplicationProxy cmdlet reads the settings of a Visio Services application proxy. -If the Identity parameter is not specified, this cmdlet returns the collection of Visio Services application proxies on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE 1--------------------- -``` -PS C:\>Get-SPVisioServiceApplicationProxy -``` - -This example returns a list of Visio Services application proxies. - -### ----------------EXAMPLE 2--------------------- -``` -PS C:\>Get-SPVisioServiceApplicationProxy "Connection to VGS2" -``` - -This example returns settings for a Visio Services application proxy. - -## PARAMETERS - -### -Identity -Specifies the Visio Services application proxy to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPIBinding.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPIBinding.md deleted file mode 100644 index 656b82068b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPIBinding.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWOPIBinding -schema: 2.0.0 ---- - -# Get-SPWOPIBinding - -## SYNOPSIS - -Returns a list of bindings that were created by using New-SPWOPIBinding on the current SharePoint farm where this cmdlet is run. - - - -## SYNTAX - -``` -Get-SPWOPIBinding [-Action <String>] [-Application <String>] [-AssignmentCollection <SPAssignmentCollection>] - [-Extension <String>] [-ProgId <String>] [-Server <String>] [-WOPIZone <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWOPIBinding returns a list of bindings that were created by using New-SPWOPIBinding on the current SharePoint farm where this cmdlet is run. -Results include actions, applications, file types and zones that are configured for a WOPI application (such as a server that runs Office Web Apps Server). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPWOPIBinding -Server "Server.corp.Contoso.com" -``` - -This example returns a list of bindings that were created on the current SharePoint farm where this cmdlet is run for the WOPI application "Server.corp.Contoso.com." The WOPI application may be the server that runs Office Web Apps Server. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPWOPIZone | Get-SPWOPIBinding -``` - -This example returns a list of bindings that were created on the current SharePoint farm where this cmdlet is run for the zone configured for the WOPI application. - -## PARAMETERS - -### -Action -Specifies the action to return bindings for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Application -Specifies the application to return bindings for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Extension -Specifies the file name extension to return bindings for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgId -Specifies the programmatic identifier (ProgID) for an application to return bindings for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of WOPI application (such as a server that runs Office Web Apps Server) to return bindings for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WOPIZone -Specifies the zone to return bindings for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[New-SPWOPIBinding](New-SPWOPIBinding.md) - -[Set-SPWOPIBinding](Set-SPWOPIBinding.md) - -[Remove-SPWOPIBinding](Remove-SPWOPIBinding.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPISuppressionSetting.md deleted file mode 100644 index 645cff5900..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPISuppressionSetting.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWOPISuppressionSetting -schema: 2.0.0 ---- - -# Get-SPWOPISuppressionSetting - -## SYNOPSIS - -Returns the suppression settings on the current SharePoint farm where this cmdlet is run. - - - -## SYNTAX - -``` -Get-SPWOPISuppressionSetting [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWOPISuppressionSetting cmdlet returns the suppression settings on the current SharePoint farm where this cmdlet is run. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPWOPISuppressionSetting -``` - -This example returns all the suppression settings on the current SharePoint farm where this cmdlet is run. -The suppression settings returned include the DocType and WOPIAction. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[New-SPWOPISuppressionSetting](New-SPWOPISuppressionSetting.md) - -[Remove-SPWOPISuppressionSetting](Remove-SPWOPISuppressionSetting.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPIZone.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPIZone.md deleted file mode 100644 index fb59eb9920..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWOPIZone.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWOPIZone -schema: 2.0.0 ---- - -# Get-SPWOPIZone - -## SYNOPSIS - -Returns the zone that is configured on the current SharePoint farm for the WOPI application to use. - - - -## SYNTAX - -``` -Get-SPWOPIZone [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWOPIZone returns the zone that is configured on the current SharePoint farm for the WOPI application (such as a server that runs Office Web Apps Server) to use. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPWOPIZone -``` - -This example returns the zone that is configured for the WOPI application (such as a server that runs Office Web Apps Server) to use. -Return values may be "internal-http," "internal-https," "external-http" or "external-https." - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[Set-SPWOPIZone](Set-SPWOPIZone.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWeb.md deleted file mode 100644 index bab25d00a0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWeb.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWeb -schema: 2.0.0 ---- - -# Get-SPWeb - -## SYNOPSIS - -Returns all subsites that match the given criteria. - - - -## SYNTAX - -``` -Get-SPWeb [[-Identity] <SPWebPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Filter <ScriptBlock>] [-Limit <String>] [-Regex] [-Site <SPSitePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWeb cmdlet returns all subsites that match the scope given by the Identity parameter. -All subsites that meet the criteria are returned. - -The Identity can be either the full URL or a relative path. -If you specify a relative path, you must also specify the Site parameter to identify the site collection from which to return the subsite. - -The Identity parameter also supports providing a partial URL that ends in a wildcard character (*). -All subsites that match this partial URL for the specified scope are returned. -Additionally, if the Regex parameter is provided, the Identity parameter is treated as a regular expression and any subweb with a URL provided in the given scope that matches the expression is returned. - -The Filter parameter is a server-side filter for certain subsite properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. -These subsite properties are Template and Title. -The Filter parameter is a script block that uses the same syntax as a Where-Object statement, but is run server-side for faster results. - -It is important to note that every site collection returned by the Get-SPWeb cmdlet is automatically disposed of at the end of the pipeline. -To store the results of Get-SPWeb in a local variable, the Start-SPAssignment and Stop-SPAssignment cmdlets must be used to avoid memory leaks. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE 1---------------------- -``` -PS C:\>Get-SPWeb -site http://sitename/sites/site1 -``` - -This example returns all the subwebs in a given site collection. - -### --------------------EXAMPLE 2---------------------- -``` -PS C:\>Get-SPWeb -Site http://sitename/sites/site1 -filter {$_.Template -eq "STS#0"} -``` - -This example displays all subsites that use the "STS#0" template. - -### --------------------EXAMPLE 3---------------------- -``` -PS C:\>Start-SPAssignment -Global - -C:\PS>$w = Get-SPWeb http://sitename - -C:\PS>$w.set_SiteLogoUrl("http://pathtoimage/test.jpg") - -C:\PS>$w.Update() - -PS C:\>Stop-SPAssignment -Global -``` - -This example demonstrates how to save a subsite as a variable and to call object model methods on the SPAssignment object. - -## PARAMETERS - -### -Identity -Specifies the name or full or partial URL of the subsite. -If you use a relative path, you must specify the Site parameter. - -A valid URL in the form http://server_name or a relative path in the form of /SubSites/MySubSite. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies the server-side filter to use for the specified scope. - -The type must be a valid filter in the form {filterName \<operator\> "filterValue"}. - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -Limits the maximum number of subsites to return. -The default value is 200. -To return all sites, enter ALL - -The type must be a valid number greater than 0 or ALL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Regex -Specifies the URL that is provided by the Identity parameter is treated as a regular expression. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the URL or GUID of the site collection from which to list subsites. - -The type must be a valid URL, in the form of http://server_name; a GUID, in the form 1234-5678-9807, or an SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplication.md deleted file mode 100644 index 2eef578e2a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplication.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWebApplication -schema: 2.0.0 ---- - -# Get-SPWebApplication - -## SYNOPSIS - -Returns all Web applications that match the given criteria. - - - -## SYNTAX - -``` -Get-SPWebApplication [[-Identity] <SPWebApplicationPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-IncludeCentralAdministration] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWebApplication cmdlet returns all Web applications that match the scope given by the Identity parameter. -The Identity can be the name of the name, URL, or GUID of the Web application. -If no Identity is specified, all Web applications are returned. - -The Central Administration Web application is only returned if its exact identity is provided or the IncludeCentralAdministration flag is provided. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1---------------------- -``` -C:\PS>$w = Get-SPWebApplication http://sitename -``` - -This example gets the Web application for http://sitename and stores it in a variable. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPWebApplication -IncludeCentralAdministration | Where { $_.DefaultServerComment -eq "SharePoint Central Administration v4"} | Format-List * -``` - -This example displays all public properties on the SharePoint Central Administration Web application in list format. - -## PARAMETERS - -### -Identity -Specifies the name, URL, or GUID of the Web application. - -The type must be a valid URL, in the form http://server_name; a GUID, in the form 1234-5678-9876-0987; or a valid name, in the form SPWebApplication - 1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeCentralAdministration -Includes the Central Administration Web application in the collection of Web applications that can be returned. -The IncludeCentral Administration parameter must still meet any other filters provided. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplicationAppDomain.md deleted file mode 100644 index fce5ed52ce..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplicationAppDomain.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWebApplicationAppDomain -schema: 2.0.0 ---- - -# Get-SPWebApplicationAppDomain - -## SYNOPSIS - -Returns all app domains for a specific web application. - -## SYNTAX - -### ResourceName -``` -Get-SPWebApplicationAppDomain [[-Identity] <SPAppDomainPipeBind>] -AppDomain <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -### WebApplication -``` -Get-SPWebApplicationAppDomain [[-Identity] <SPAppDomainPipeBind>] -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Get-SPWebApplicationAppDoman cmdlet to return all app domains for a specific web application or for all web applications. If you do not specify parameters, the default zone is used. - -## EXAMPLES - -### -----------EXAMPLE 1--------- -``` -PS C:\>Get-SPWebApplicationAppDomain -``` - -Returns a list of SPAppDomain objects, one for each of the app domains for all web applications in the farm. - -### -----------EXAMPLE 2--------- -``` -PS C:\>Get-SPWebApplicationAppDomain -Zone Default -``` - -Returns a list of SPAppDomain objects, one for each of the app domains for the Default zone for all web applications in the farm. - -### -----------EXAMPLE 3--------- -``` -PS C:\>Get-SPWebApplicationAppDomain -WebApplication http://www.contoso.com -``` - -Returns a list of SPAppDomain objects, one for each of all the app domains for the specified web application for all zones. - -### -----------EXAMPLE 4--------- -``` -PS C:\>Get-SPWebApplicationAppDomain -AppDomain contosoapps.com -``` - -Returns a list of SPAppDomain objects, one for each web application and zone pair that shares the specified app domain. - -## PARAMETERS - -### -Identity - -Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object. - -```yaml -Type: SPAppDomainPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AppDomain - -Specifies the URI of the app domain. - -```yaml -Type: String -Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication - -Specifies the GUID, URI, or name of the web application for which the app domain is being configured. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Zone - -Specifies the security zone to which the app domain will be assigned. - -* Default - -* Intranet - -* Internet - -* Extranet - -* Custom - -If no value is specified, Default is applied. - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.Administration.SPAppCmdlets.SPAppDomainPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-SPWebApplicationAppDomain](New-SPWebApplicationAppDomain.md) - -[Remove-SPWebApplicationAppDomain](Remove-SPWebApplicationAppDomain.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplicationHttpThrottlingMonitor.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplicationHttpThrottlingMonitor.md deleted file mode 100644 index 6ca3e3edb8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebApplicationHttpThrottlingMonitor.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWebApplicationHttpThrottlingMonitor -schema: 2.0.0 ---- - -# Get-SPWebApplicationHttpThrottlingMonitor - -## SYNOPSIS - -Returns all counters and their associated Health Score bucket values for network throttling on a Web application. - - - -## SYNTAX - -``` -Get-SPWebApplicationHttpThrottlingMonitor [-Identity] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWebApplicationHttpThrottlingMonitor cmdlet reads all counters for network throttling on a Web application. -This cmdlet returns a list that contains all of the performance counters and their associated Health Score bucket values. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$s = get-SPWebApplicationHTTPThrottlingMonitors http://sharepoint -``` - -This example gets all performance counters that are being read in the network throttling monitor for the http://sharepoint Web application. - -## PARAMETERS - -### -Identity -Returns throttling performance counter settings for the specified SharePoint Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebPartPack.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebPartPack.md deleted file mode 100644 index bf135b4908..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebPartPack.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWebPartPack -schema: 2.0.0 ---- - -# Get-SPWebPartPack - -## SYNOPSIS - -Returns the Web Part packages that were installed for the specified scope. - - - -## SYNTAX - -``` -Get-SPWebPartPack [[-Identity] <String>] [-AssignmentCollection <SPAssignmentCollection>] [-GlobalOnly] - [-WebApplication <SPWebApplicationPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWebPartPack cmdlet returns the installed Web Part packages that match the Identity parameter. -The scope of results can be narrowed by using the optional WebApplication parameter. -The scope does not include any Web Part packages installed in the global assembly cache (GAC) unless the GlobalOnly parameter is used. -If this parameter is used, only Web Part packages that have been installed in the GAC are returned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPWebPartPack -WebApplication http://zsharepoint2:80 -``` - -This example returns all Web Part packages that have been installed on the Web application on port 80 in local farm. - -## PARAMETERS - -### -Identity -Specifies the full or partial name of the Web Part package from the configuration database. - -The type must be a valid name of a Web Part package; for example, MyWebPartPackage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GlobalOnly -Returns only Web Part packages that are installed in the global assembly cache (GAC). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the Web application from which to list Web Part packages. -If no Web application is specified, the specified Web Part packages will be returned from all Web applications. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebTemplate.md deleted file mode 100644 index 1bd2ea76b1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebTemplate.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWebTemplate -schema: 2.0.0 ---- - -# Get-SPWebTemplate - -## SYNOPSIS - -Displays all globally installed site templates that match the given identity. - - - -## SYNTAX - -``` -Get-SPWebTemplate [[-Identity] <SPWebTemplatePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <UInt32>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-SPWebTemplate cmdlet displays all installed site templates that match the full or partial identity that was given. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -C:\PS>$template = Get-SPWebTemplate "STS#0" - -PS C:\>New-SPSite http://contoso.com -OwnerAlias "DOMAIN\JDOE" -Template $template -``` - -This example creates a site collection by using the team site Web template (ID=STS#0). - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPWebTemplate "STS*" -``` - -This example displays basic information about all the STS templates. - -## PARAMETERS - -### -Identity -Specifies the name of the Web template to display. - -The type must be the ID or full or partial name of the Web template. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. -This value sets the initial CompatibilityLevel value for the site collection. -The values for this parameter can be either SharePoint Server or SharePoint Server. -When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the Web application depending on the SiteCreationMode setting - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebTemplatesEnabledForSiteMaster.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebTemplatesEnabledForSiteMaster.md deleted file mode 100644 index 841678d490..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWebTemplatesEnabledForSiteMaster.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWebTemplatesEnabledForSiteMaster -schema: 2.0.0 ---- - -# Get-SPWebTemplatesEnabledForSiteMaster - -## SYNOPSIS -Returns a list of site master web templates. - -## SYNTAX - -``` -Get-SPWebTemplatesEnabledForSiteMaster [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-SPWebTemplatesEnabledForSiteMaster cmdlet to display a full list of site master web templates in the farm. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPWebTemplatesEnabledForSiteMaster -``` - -This example displays all the site master web templates in a farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWorkflowConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWorkflowConfig.md deleted file mode 100644 index b03bd35cc7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWorkflowConfig.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWorkflowConfig -schema: 2.0.0 ---- - -# Get-SPWorkflowConfig - -## SYNOPSIS - -Returns workflow settings for the specified Web application. - - - -## SYNTAX - -### SiteCollection -``` -Get-SPWorkflowConfig [-SiteCollection] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### WebApplication -``` -Get-SPWorkflowConfig [-WebApplication] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Get-SPWorkflowConfig cmdlet returns workflow settings for the Web application specified by the WebApplication parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPWorkFlowConfig -webapplication http://sitename -``` - -This example gets workflow settings for the specified Web application (http://sitename). - -To get farm-level workflow settings for event delivery time-out, postpone threshold, and batch size, use the Get-SPFarmConfig cmdlet. - -## PARAMETERS - -### -SiteCollection -Specifies the name or URL of the site collection. - -The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. -No other parameters are used. - -```yaml -Type: SPSitePipeBind -Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the name or URL of the Web application. - -The type must be a valid name, in the form WebApplication-1212, or a URL, in the form http://server_name/WebApplication-1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWorkflowServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWorkflowServiceApplicationProxy.md deleted file mode 100644 index b41ca4cec4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Get-SPWorkflowServiceApplicationProxy.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.SharePoint.WorkflowServices.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Get-SPWorkflowServiceApplicationProxy -schema: 2.0.0 ---- - -# Get-SPWorkflowServiceApplicationProxy - -## SYNOPSIS -Returns the Workflow Service Application Proxy. - -## SYNTAX - -``` -Get-SPWorkflowServiceApplicationProxy [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Returns the Workflow Service Application Proxy. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-SPWorkflowServiceApplicationProxy -``` -Returns the Workflow Service Application Proxy. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Grant-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/sharepoint-server/Grant-SPBusinessDataCatalogMetadataObject.md deleted file mode 100644 index 8527228ef6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Grant-SPBusinessDataCatalogMetadataObject.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Grant-SPBusinessDataCatalogMetadataObject -schema: 2.0.0 ---- - -# Grant-SPBusinessDataCatalogMetadataObject - -## SYNOPSIS - -Grants a right to a principal for the specified Business Data Connectivity Metadata Store metadata object. - - - -## SYNTAX - -``` -Grant-SPBusinessDataCatalogMetadataObject -Identity <MetadataObject> -Principal <SPClaim> -Right <PSBdcRight> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SettingId <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Grant-SPBusinessDataCatalogMetadataObject cmdlet grants the right to a specified principal (user) for a Business Data Connectivity Metadata Store metadata object. -This cmdlet checks to verify that the Identity parameter is a valid IndividuallySecurableMetadata object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$claimJohn = New-SPClaimsPrincipal -Identity "CONTOSO\johndoe" -IdentityType WindowsSamAccountName -PS C:\>$Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -ServiceContext http://contoso -Name "ContosoModel" -PS C:\>Grant-SPBusinessDataCatalogMetadataObject -Identity $Model -Principal $claimJohn -Right Edit -``` - -This example gives Edit permissions to the user with the identity johndoe on domain CONTOSO, for the model metadata object with the name ContosoModel. - -## PARAMETERS - -### -Identity -Specifies the Business Data Connectivity Metadata Store metadata object that contains the principal. - -```yaml -Type: MetadataObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Principal -Specifies the principal to whom the rights apply. - -The type must be a claim. - -```yaml -Type: SPClaim -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Right -Specifies the right to grant the principal. - -The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients. - -```yaml -Type: PSBdcRight -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingId -Specifies the model slice for which to grant the right. - -The type must be a valid string that identifies a model slice; for example, ModelSlice1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Grant-SPObjectSecurity.md b/sharepoint/sharepoint-ps/sharepoint-server/Grant-SPObjectSecurity.md deleted file mode 100644 index 0ccd87d766..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Grant-SPObjectSecurity.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Grant-SPObjectSecurity -schema: 2.0.0 ---- - -# Grant-SPObjectSecurity - -## SYNOPSIS - -Adds a new security principal to an SPObjectSecurity object. - - - -## SYNTAX - -``` -Grant-SPObjectSecurity [-Identity] <SPObjectSecurity> [-Principal] <SPClaim> [-Rights] <String[]> - [-AssignmentCollection <SPAssignmentCollection>] [-Replace] [<CommonParameters>] -``` - -## DESCRIPTION -The Grant-SPObjectSecurity cmdlet adds a new security principal, such as a user, to a SPObjectSecurity object. -An SPObjectSecurity object is a common object that is used to represent the security access control list (ACL) of SharePoint administrative objects, in particular, service applications. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$principal = New-SPClaimsPrincipal "CONTOSO\JaneDoe" -IdentityType WindowsSamAccountName -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} -PS C:\>$security = Get-SPServiceApplicationSecurity $sa -Admin -PS C:\>Grant-SPObjectSecurity $security $principal "Full Control" -PS C:\>Set-SPServiceApplicationSecurity $sa -Admin $security -``` - -This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on the User Profile Service Application and adds a new user principal to that ACL. - -The new user is an administrator for the service application $serviceApp. - -## PARAMETERS - -### -Identity -Specifies the SPObjectSecurity object to which the new security principal is added. -You can use the Get-SPServiceApplicationSecurity cmdlet to get a SPObjectSecurity object . - -```yaml -Type: SPObjectSecurity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Principal -Specifies the principal to whom the rights apply. - -The type must a valid name a principal; for example, Full Control. - -```yaml -Type: SPClaim -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rights -Specifies the rights granted to the principal. - -The type must a valid array of strings that represents the rights granted to the principal. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Replace -Replaces the existing rights on the SPObjectSecurity object with the new rights specified. -If this parameter is not specified, the new rights are added to the existing rights. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPAccessServicesDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPAccessServicesDatabase.md deleted file mode 100644 index 8ab459e629..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPAccessServicesDatabase.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPAccessServicesDatabase -schema: 2.0.0 ---- - -# Import-SPAccessServicesDatabase - -## SYNOPSIS -Imports an Access Services Database to a DACPAC via the Data-Tier Framework. - -## SYNTAX - -``` -Import-SPAccessServicesDatabase [-AssignmentCollection <SPAssignmentCollection>] -Bacpac <Byte[]> - -DatabaseName <String> -ServerReferenceId <Guid> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet exports an Access Services Database to a DACPAC. The cmdlet requires the Data-Tier Framework to be installed on the SharePoint server where the cmdlet is run. The Data-Tier Framework packages can be found at [Microsoft® SQL Server® Data-Tier Application Framework (17.4.1 GA DacFx)](https://www.microsoft.com/en-us/download/details.aspx?id=56508). Install the following MSI from the download: - -EN\x86\DacFramework.msi - -Note: The x86 package is required. The x64 package is not compatible with this cmdlet. - -See more information about Data-Tier Framework at [Data-tier Applications](https://docs.microsoft.com/en-us/sql/relational-databases/data-tier-applications/data-tier-applications). - -## EXAMPLES - -### Example 1 -``` -PS C:\>$accessDb = Get-SPAccessServicesDatabaseServer -ServiceContext http://site_url -DatabaseServer SQLSERVERNAME -DatabaseServerGroup DEFAULT -PS C:\>Import-SPAccessServicesDatabase -DatabaseName accessDatabaseName -ServerReferenceId $accessDb.ServerReferenceId -Bacpac (Get-Content -Path C:\accessDb.bacpac -Encoding Byte) -``` - -This example gets the ServerReferenceId value of the SQL Server for the Access Services Service Application; -DatabaseServerGroup is set to the value DEFAULT by default. The next step is to import the bacpac file to a byte array and finally, import the Access Services Database as the specified SQL database name to the specified SQL Server. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Bacpac -A byte array of the bacpac file. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the database to create from the bacpac file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerReferenceId -The ServerReferenceId to be used for the Access Database. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Guid -System.Byte[] -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPAppPackage.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPAppPackage.md deleted file mode 100644 index aa4922716d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPAppPackage.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPAppPackage -schema: 2.0.0 ---- - -# Import-SPAppPackage - -## SYNOPSIS - -Imports an app package. - -## SYNTAX - -``` -Import-SPAppPackage -Path <String> -Source <SPAppSource> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [-AssetId <String>] [-ContentMarket <String>] -Site <SPSitePipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Import-SPAppPackage cmdlet to import an app package from the content database and create an app inside the site collection by using the SiteCollection parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE---------- -``` -PS C:\>Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site http://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) -``` - -This example imports an app package. - -## PARAMETERS - -### -Path -Specifies the path of the input file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Defines the source of the app. The source indicates where the app package originates from, for example, if the app was built by a developer but did not reside on the SharePoint Marketplace, you might use the CorporateCatalog source. - -The following are valid values: - -InvalidSource, Marketplace, CorporateCatalog, DeveloperSite, ObjectModel, RemoteObjectModel - -The following are valid sources (not parameters of -Source) of the app: - ---SharePoint Store (Marketplace) - ---App catalog (CorporateCatalog) - ---SharePointService - Indicates apps that were built in place with SharePoint features, for example Access Services (ObjectModel) - - -```yaml -Type: SPAppSource -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssetId -Specifies the Asset Id to import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentMarket -Specifies the name of the content market. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the SPSite object to import. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Export-SPAppPackage](Export-SPAppPackage.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPBusinessDataCatalogDotNetAssembly.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPBusinessDataCatalogDotNetAssembly.md deleted file mode 100644 index 6196d46ff0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPBusinessDataCatalogDotNetAssembly.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPBusinessDataCatalogDotNetAssembly -schema: 2.0.0 ---- - -# Import-SPBusinessDataCatalogDotNetAssembly - -## SYNOPSIS - -Imports a .NET Connectivity assembly. - - - -## SYNTAX - -``` -Import-SPBusinessDataCatalogDotNetAssembly -LobSystem <LobSystem> -Path <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DependentAssemblyPaths <String[]>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPBusinessDataCatalogDotNetAssembly cmdlet imports a .NET Connectivity Assembly that corresponds to a .NET Assembly Connector and LobSystem in the metadata store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE 1---------------- -``` -PS C:\>Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" -``` - -This example imports the assembly Assembly. - -### -----------------EXAMPLE 2---------------- -``` -PS C:\>Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" -DependentAssemblyPaths "c:\Folder\Assembly2.dll","c:\Folder\Assembly3.dll" -``` - -This example imports the assembly Assembly, and also imports the dependent assemblies Assembly2 and Assembly3. - -## PARAMETERS - -### -LobSystem -Specifies the LobSystem that the assembly corresponds to. - -```yaml -Type: LobSystem -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the primary assembly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DependentAssemblyPaths -Specifies a list of paths to dependent assemblies. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPBusinessDataCatalogModel.md deleted file mode 100644 index b58b81753e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPBusinessDataCatalogModel.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPBusinessDataCatalogModel -schema: 2.0.0 ---- - -# Import-SPBusinessDataCatalogModel - -## SYNOPSIS - -Imports a Business Data Connectivity Model. - -## SYNTAX - -### Catalog -``` -Import-SPBusinessDataCatalogModel -Identity <MetadataObject> -Path <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-LocalizedNamesIncluded] - [-ModelsIncluded] [-PermissionsIncluded] [-PropertiesIncluded] [-SettingId <String>] [-WhatIf] - [<CommonParameters>] -``` - -### ServiceContext -``` -Import-SPBusinessDataCatalogModel -Path <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Force] [-LocalizedNamesIncluded] [-ModelsIncluded] [-PermissionsIncluded] [-PropertiesIncluded] - [-SettingId <String>] [-WhatIf] -ServiceContext <SPServiceContextPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPBusinessDataCatalogModel cmdlet imports a Business Data Connectivity Model. -There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). -The Model type contains the base XML metadata, and can also include resource properties. -The Resource type includes only resource properties. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$MetadataStore = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Catalog" -ServiceConext http://contoso -PS C:\>Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $MetadataStore -``` - -This example gets the Business Data Connectivity Metadata Store and then imports a Business Data Connectivity Model of Model type to it from the path specified with the name model. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Import-SPBusinessDataCatalogModel -Path "C:\Program Files\Duet Enterprise\2.0\BDC Models\Reporting.en-us.bdcr -Identity $bdcCatalog -ModelsIncluded:$false -``` - -This example imports a resource only file by using the ModelsIncluded parameter. - -## PARAMETERS - -### -Identity -Specifies the Business Data Connectivity Metadata Store metadata object to import to. - -```yaml -Type: MetadataObject -Parameter Sets: Catalog -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path and name to use. - -The type must be a valid path in either of the following forms: - -- C:\folder_name\file.bdcm -- \\\\server_name\folder_name\file.bdcm -- …\folder_name\file.bdcm - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrites the Business Data Connectivity Model if the file exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalizedNamesIncluded -Specifies that names for business data fields in multiple languages are imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModelsIncluded -Specifies that models are included in the imported Business Data Connectivity Model file. -A model contains the base XML metadata for a system. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsIncluded -Specifies that permissions from the Business Data Connectivity Model are imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertiesIncluded -Specifies that properties from the Business Data Connectivity Model are imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingId -Specifies the custom environment settings model slice to import. - -The type must be a valid string that identifies a model slice; for example, ModelSlice1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context to set. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchCustomExtractionDictionary.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchCustomExtractionDictionary.md deleted file mode 100644 index 054e9a6deb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchCustomExtractionDictionary.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPEnterpriseSearchCustomExtractionDictionary -schema: 2.0.0 ---- - -# Import-SPEnterpriseSearchCustomExtractionDictionary - -## SYNOPSIS - -Imports a custom extraction dictionary. - -## SYNTAX - -``` -Import-SPEnterpriseSearchCustomExtractionDictionary -DictionaryName <String> -FileName <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet imports a custom extraction dictionary from a .cvs file and deploys it to the extraction sub flow. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$searchApp = Get-SPEnterpriseSearchServiceApplication -PS C:\>Import-SPEnterpriseSearchCustomExtractionDictionary -SearchApplication $searchApp -Filename c:\transfer\entity_extraction.csv -DictionaryName Microsoft.UserDictionaries.EntityExtraction.Custom.Word.1 -``` - -This example imports the custom extraction dictionary that is located at c:\transfer to the default search service application. -The entries of this dictionary will be matched in a case-insensitive way against the terms in the documents being indexed. - -## PARAMETERS - -### -DictionaryName -Specifies the name of the target dictionary. -The name must be one of the following 12 predefined dictionaries. -The name signifies the "case sensitivity" and "token matching" behavior. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileName - -Specifies the file path of the .cvs file to be imported - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication - -Specifies the search service application to which the custom extraction dictionary should be imported. - - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchPopularQueries.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchPopularQueries.md deleted file mode 100644 index cf238b2442..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchPopularQueries.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPEnterpriseSearchPopularQueries -schema: 2.0.0 ---- - -# Import-SPEnterpriseSearchPopularQueries - -## SYNOPSIS -Imports queries from a comma-separated list. -The search box will suggest these queries as users type. - -## SYNTAX - -``` -Import-SPEnterpriseSearchPopularQueries -ResultSource <Source> - -SearchApplicationProxy <SearchServiceApplicationProxyPipeBind> -Web <SPWeb> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Filename <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPEnterpriseSearchPopularQueries cmdlet imports queries from a comma-separated list. -As the user types a query in the search box, the search box will suggest queries from the comma-separated list. -The search box bases these suggestions on: - -- The SPWeb the search box is located on. -- The Result Source configured on the search box. - -For example, if the search box is located on the "Engineering" SPWeb, the suggested queries will differ from if the search box is located on the "Management" SPWeb. -Likewise, if the Result Source on the search box is "Local SharePoint Results", the suggested queries will differ from if the Result Source is "Conversations". - -The comma-separated list must consist of one line per query, where each line contains the following items: - -Query Text. -The actual query expression. - -Query Count. -The number of times this query was executed. - -Click Count. -The number of times any user clicked any result for this query. - -LCID. -The locale identifier (LCID) for the language of the query. - -Each line must use the formatting: Query Text,Query Count,Click Count,LCID. -For example, Company store,100,80,1033. -For suggestions to appear in the search box, the Click Count value must be more than five. -The search box ranks query suggestions by their Click Count values (approximately). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>$ssap = Get-SPEnterpriseSearchServiceApplicationProxy -PS C:\>$hostname = hostname -PS C:\>$web = get-spsite | get-spweb | where {$_.Url-eq "http://$hostname/"} -PS C:\>$owner = new-object Microsoft.Office.Server.Search.Administration.SearchObjectOwner -ArgumentList @([Microsoft.Office.Server.Search.Administration.SearchObjectLevel]::SPWeb,$web) -PS C:\>$mgr = new-object Microsoft.Office.Server.Search.Administration.Query.FederationManager -ArgumentList $ssap -PS C:\>$source = $mgr.GetSourceByName("Local SharePoint Results", $owner) -PS C:\>Import-SPEnterpriseSearchPopularQueries -SearchApplicationProxy $ssap -Filename C:\input.txt -ResultSource $source -Web $web -``` - -This example uses the Import-SPEnterpriseSearchPopularQueries cmdlet to import the queries file that is named C:\input.txt and associate with it the Result Source referenced by $source and the SPWeb referenced by $web. -The example defines the variable $web as the SPWeb with URL http://hostname, and the variable $source as the Result Source named "Local SharePoint Results" at the SPWeb referenced by $web. - -## PARAMETERS - -### -ResultSource -Specifies the Result Source to associate with the imported queries. -The type must be an instance of a valid Source object. - -```yaml -Type: Source -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplicationProxy -Specifies the proxy for the search application to which the queries file should be imported. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Web -Specifies the SPWeb to associate with the imported queries. -The type must be an instance of a valid SPWeb object. - -```yaml -Type: SPWeb -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filename -Specifies the full UNC (Universal Naming Convention) path of the file to import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchThesaurus.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchThesaurus.md deleted file mode 100644 index 1992751ba7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchThesaurus.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPEnterpriseSearchThesaurus -schema: 2.0.0 ---- - -# Import-SPEnterpriseSearchThesaurus - -## SYNOPSIS -Deploys the dictionary to the thesaurus component in the query processing flow. - -## SYNTAX - -``` -PS C:\>Import-SPEnterpriseSearchThesaurus -FileName <String> -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet imports a thesaurus dictionary using a .cvs file, and deploys it to the query processing flow. -A previously deployed thesaurus is overwritten by an import of a new .cvs file. - -NOTE: If an empty .cvs file is imported, an empty thesaurus will be deployed. -No synonyms will then be added to the queries. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -C:\PS>$searchApp = Get-SPEnterpriseSearchServiceApplication -Import-SPEnterpriseSearchThesaurus -SearchApplication $searchApp -Filename -\\host\share\thesaurus.csv -``` - -This example imports a thesaurus dictionary .cvs file named thesaurus.csv that is located at \\\\host\share to the default search service application. - -## PARAMETERS - -### -FileName -Specifies the full UNC (Universal Naming Convention) path of the .cvs file to be imported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application to which the thesaurus dictionary should be imported - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchTopology.md deleted file mode 100644 index a99fc59074..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPEnterpriseSearchTopology.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPEnterpriseSearchTopology -schema: 2.0.0 ---- - -# Import-SPEnterpriseSearchTopology - -## SYNOPSIS -Imports and activates a topology from an XML file. - -## SYNTAX - -``` -Import-SPEnterpriseSearchTopology -Filename <String> -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPEnterpriseSearchTopology cmdlet imports from an XML file the topology for a shared search application. -The Export-SPEnterpriseSearchTopology cmdlet is used to save a search topology. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Import-SPEnterpriseSearchTopology -SearchApplication $ssa -Filename .\topology.xml -``` - -This example imports a topology from a file named topology.xml to the default search service application. - -## PARAMETERS - -### -Filename -Specifies the path and file name of the topology XML file to import. - -The type must be a valid path, in the form MyFeature\Feature.xml. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application to which to apply the topology. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchTopology](New-SPEnterpriseSearchTopology.md) - -[Get-SPEnterpriseSearchTopology](Get-SPEnterpriseSearchTopology.md) - -[Set-SPEnterpriseSearchTopology](Set-SPEnterpriseSearchTopology.md) - -[Remove-SPEnterpriseSearchTopology](Remove-SPEnterpriseSearchTopology.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPInfoPathAdministrationFiles.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPInfoPathAdministrationFiles.md deleted file mode 100644 index 9bf677a26c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPInfoPathAdministrationFiles.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPInfoPathAdministrationFiles -schema: 2.0.0 ---- - -# Import-SPInfoPathAdministrationFiles - -## SYNOPSIS -Imports InfoPath form templates and .udcx files that are located on the SharePoint Central Administration Web site. - -## SYNTAX - -``` -Import-SPInfoPathAdministrationFiles [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Identity <SPFormsServicePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPInfoPathAdministrationFiles cmdlet imports InfoPath form templates (.xsn files) and universal data connections (.udcx files) that are located on the SharePoint Central Administration Web site into the specified InfoPath Forms Services service. -This cmdlet imports from a backup package that includes all workflow forms in InfoPath that were deployed by an administrator and not included with SharePoint Foundation, and browser forms that were deployed by an administrator. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Import-SPInfoPathAdministrationFiles -path "backupfiles.cab" -``` - -This example imports form templates (XSN files) and universal data connections (UDCX files) located on the SharePoint Central Administration Web site into the specified Forms service. - -## PARAMETERS - -### -Path -Specifies the location of the .cab file to import. - -The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfsfiles.cab. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the destination InfoPath Forms Services service for the import. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a forms service (for example, FormsService1); or an instance of a valid SPFormsService object. - -```yaml -Type: SPFormsServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPMetadataWebServicePartitionData.md deleted file mode 100644 index fd72bb13c9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPMetadataWebServicePartitionData.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPMetadataWebServicePartitionData -schema: 2.0.0 ---- - -# Import-SPMetadataWebServicePartitionData - -## SYNOPSIS -Restores the data for a site subscription. - -## SYNTAX - -``` -Import-SPMetadataWebServicePartitionData [-Identity] <SPSiteSubscriptionPipeBind> - [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> -Path <String> - [-AssignmentCollection <SPAssignmentCollection>] [-OverwriteExisting] [-NoCompression] - [-ToContentDatabase <SPContentDatabasePipeBind>] [-ToServiceDatabase] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Import-SPMetadataWebServicePartitionData cmdlet to restore data for a site subscription to a shared service application for the Metadata Service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE---------------------- -``` -PS C:\>$subscription = Get-SPSIteSubscription -Identity http://site_url -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Managed Metadata Service Connection'} -PS C:\>Import-SPMetadataWebServicePartitionData -Identity $subscription -ServiceProxy $proxy -Path "\\server_name\folder_name\file_name.cab" -``` - -This example restores a backup of Metadata Service application data for a specific site subscription on a Metadata Service application. - -## PARAMETERS - -### -Identity -Specifies the site subscription to import. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceProxy -Specifies the proxy for the service application that contains the site subscription. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path and name of the subscription data file to import. - -The type must be a valid path in either of the following forms: - -- C:\folder_name\formtemplate_name -- \\\\server_name\folder_name\file_name.cab - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OverwriteExisting -Specifies whether to overwrite the existing site subscription data, if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoCompression -{{Fill NoCompression Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToContentDatabase -{{Fill ToContentDatabase Description}} - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToServiceDatabase -{{Fill ToServiceDatabase Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPPerformancePointContent.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPPerformancePointContent.md deleted file mode 100644 index fe2bc8e005..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPPerformancePointContent.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPPerformancePointContent -schema: 2.0.0 ---- - -# Import-SPPerformancePointContent - -## SYNOPSIS -Imports a Performance Point Server (PPS) dashboard. - -## SYNTAX - -``` -Import-SPPerformancePointContent [-AssignmentCollection <SPAssignmentCollection>] -DatasourceMap <Hashtable> - -ImportFileUrl <String> -LocationMap <Hashtable> -MasterPageUrl <String> -SiteDestination <SPWebPipeBind> - [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPPerformancePointContent imports a PPS dashboard and its dependencies from a CMP file that can then be used to import to another server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$ContentList = @{"/bi/Dashboard Content" = "/biprod/Dashboard Content"; "/bi/My Projects" = "/biprod/My Projects"} -PS C:\>$DatasourceList = @{"/bi/DataConnections/AdventureWorks.ppsdc" = "/myBi/libraries/DataConnections/AdventureWorks_prod.ppsdc"; "/bi/DataConnections/AW 2008 Cubes4.ppsdc" = "/myBi/libraries/DataConnections/AW 2008 Cubes3.ppsdc"; "/sales/DataConnections/Excel DS.ppsdc" = "/marketing/PPS Data Sources/PDW 2010.ppsdc"} -PS C:\>Import-SPPerformancePointContent -ImportFileURL "http://contoso.com/biprod/DocumentLibrary/Dashboard1.cmp" -SiteDestination "http://contoso.com/biprod/" -LocationMap $ContentList -DatasourceMap $DatasourceList -MasterPage "marketing and sales.master" -``` - -This example imports a dashboard by using the $Datasourcelist and $ContentList variables. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatasourceMap -Maps existing or adds new data sources to destination library. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImportFileUrl -Path and Name of the CMP file created in the export command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationMap -Maps the locations between source lists and destination lists. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterPageUrl -Specifies which master page to use for imported dashboards. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteDestination -Specifies the site to which the dashboard will be deployed. Also used to determine the location of the import Key Performance Indicator (KPI). - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPWebPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPScaleOutDatabaseTenantData.md deleted file mode 100644 index f565118ceb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPScaleOutDatabaseTenantData.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPScaleOutDatabaseTenantData -schema: 2.0.0 ---- - -# Import-SPScaleOutDatabaseTenantData - -## SYNOPSIS - -Imports data from the specified subscription id. - - - -## SYNTAX - -``` -Import-SPScaleOutDatabaseTenantData -FilePath <String> -ServiceApplication <SPServiceApplicationPipeBind> - -SiteSubscriptionId <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Import-SPScaleOutDatabaseTenantData cmdlet to import data from the specified file for the specified subscription id to the specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE---------- -``` -PS C:\>Import-SPScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" -``` - -This example imports data from the file at C:\TenantData.dat, to the specified service application and marks all the imported data with the site subscription id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904. - -## PARAMETERS - -### -FilePath -Specifies the absolute path to the data file. - -An absolute path includes the root directory and all sub-directories. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the service application to import the data to. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId -Specifies the site subscription id to import the data from. -This value will replace the site subscription id value from the data file. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-SPScaleOutDatabaseTenantData](Clear-SPScaleOutDatabaseTenantData.md) - -[Export-SPScaleOutDatabaseTenantData](Export-SPScaleOutDatabaseTenantData.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPServerScaleOutDatabaseTenantData.md deleted file mode 100644 index f3fc1918f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPServerScaleOutDatabaseTenantData.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPServerScaleOutDatabaseTenantData -schema: 2.0.0 ---- - -# Import-SPServerScaleOutDatabaseTenantData - -## SYNOPSIS - -Imports data from the specified subscription id. - -## SYNTAX - -``` -Import-SPServerScaleOutDatabaseTenantData -FilePath <String> -ServiceApplication <SPServiceApplicationPipeBind> - -SiteSubscriptionId <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Import-SPServerPScaleOutDatabaseTenantData cmdlet to import data from the specified file for the specified subscription id to the specified service application. - -## EXAMPLES - -### -------------EXAMPLE---------- -``` -PS C:\>Import-SPServerScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" -``` - -This example imports data from the file at C:\TenantData.dat, to the specified service application and marks all the imported data with the site subscription id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904. - - -## PARAMETERS - -### -FilePath - -Specifies the absolute path to the data file. - -An absolute path includes the root directory and all sub-directories. - - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication - -Specifies the service application to import the data to. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId - -Specifies the site subscription id to import the data from. -This value will replace the site subscription id value from the data file. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Clear-SPServerScaleOutDatabaseTenantData](Clear-SPServerScaleOutDatabaseTenantData.md) - -[Export-SPServerScaleOutDatabaseTenantData](Export-SPServerScaleOutDatabaseTenantData.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md deleted file mode 100644 index d25f9b90ca..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPSiteSubscriptionBusinessDataCatalogConfig -schema: 2.0.0 ---- - -# Import-SPSiteSubscriptionBusinessDataCatalogConfig - -## SYNOPSIS - -Imports data associated with an exported file that contains all data associated with the Business Data Connectivity Metadata Store for a given partition. - - - -## SYNTAX - -``` -Import-SPSiteSubscriptionBusinessDataCatalogConfig -Path <String> -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-LocalizedNamesIncluded] [-ModelsIncluded] - [-PermissionsIncluded] [-PropertiesIncluded] [-ProxiesIncluded] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Import-SPSiteSubscriptionBusinessDataCatalogConfig cmdlet to import a data file that contains Business Data Connecitivity models and all data associated with the Business Data Connectivity Metadata Store for a given partition. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE--------------------------- -``` -PS C:\>Import-SPSiteSubscriptionBusinessDataCatalogConfig -Path "C:\folder\importFile.xml" -ServiceContext http://contoso -``` - -This example imports the data file named importFile.xml. - -## PARAMETERS - -### -Path -Specifies the path and name to use to create the export file.The type must be a valid path in either of the following forms: - -C:\folder_name - -\\\\server_name\folder_name - -..\folder_name\file.xml - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context of the data to be exported. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalizedNamesIncluded -Specifies that names for business data fields in multiple languages be imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModelsIncluded -Specifies that Business Data Connectivity models be included in the imported file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsIncluded -Specifies that permissions from the Business Data Connectivity model be exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertiesIncluded -Specifies that properties from the Business Data Connectivity model be imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxiesIncluded -Specifies that proxies for Business Data Connectivity Service Applications be exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPSiteSubscriptionSettings.md deleted file mode 100644 index ac0dfbe0ac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPSiteSubscriptionSettings.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPSiteSubscriptionSettings -schema: 2.0.0 ---- - -# Import-SPSiteSubscriptionSettings - -## SYNOPSIS - -Restores a backup of subscription site settings to the given subscription identifier. - -## SYNTAX - -``` -Import-SPSiteSubscriptionSettings [-Identity] <SPSiteSubscriptionPipeBind> -Path <String> [-AdminProperties] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPSiteSubscriptionSettings cmdlet restores a backup of subscription site settings to the given subscription identifier when the Identity parameter is used. -To overwrite existing settings, use the Force parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>$subscription = Get-SPSiteSubscription http://site_url -PS C:\>Import-SPSiteSubscriptionSettings -Identity $subscription -Path "C:\backups\contoso_settings_file.bak" -Force -``` - -This example restores the subscription settings store of contoso.com. - -## PARAMETERS - -### -Identity -Specifies the ID of the subscription to restore . - -The type must be a valid URL, in the form http://site_url, or a GUID, in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the location of the input file. - -The type must be a valid path, in the form C:\filename.bak. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminProperties -Specifies that only administrator subscription properties are imported. -If this parameter is not set, only non-administrator subscription properties are imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -If a setting key already exists, determines whether the value must be overwritten with the value in the backup file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Import-SPWeb.md deleted file mode 100644 index 2403881c73..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Import-SPWeb.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Import-SPWeb -schema: 2.0.0 ---- - -# Import-SPWeb - -## SYNOPSIS - -Imports a web, list, or library. - - - -## SYNTAX - -``` -Import-SPWeb [-Identity] <SPWebPipeBind> -Path <String> [-ActivateSolutions] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-HaltOnError] [-HaltOnWarning] - [-IncludeUserCustomAction <SPIncludeUserCustomAction>] [-IncludeUserSecurity] [-NoFileCompression] - [-NoLogFile] [-UpdateVersions <SPUpdateVersions>] [-WhatIf] [-PreserveDeletedUserMetadataReferences] - [<CommonParameters>] -``` - -## DESCRIPTION -The Import-SPWeb cmdlet imports a web, list, or library. -The capability to import from a library is a new feature in SharePoint Products. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE---------------------- -``` -PS C:\>Import-SPWeb http://site -Path export.cmp -UpdateVersions Overwrite -``` - -This example imports the contents of export.cmp into a site at http://site, overwriting the versioned content on the site with the contents of the export.cmp file. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the Web to import into. - -The type must be a valid URL, GUID, or object; for example, a valid URL, in the form http://server_name, or a GUID, in the form, 1234-4567-5678a. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the name of the import file. - -If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActivateSolutions -Specifies whether user solutions are activated during import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forcefully overwrites the export package if it already exists. - -The type must be either of the following values - --True - --False - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HaltOnError -Stops the import process when an error occurs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HaltOnWarning -Stops the import process when a warning occurs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUserCustomAction -Specifies whether User Custom Actions are included during import. - -Valid values are: - -All, None - -```yaml -Type: SPIncludeUserCustomAction -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUserSecurity - -Preserves the user security settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoFileCompression -Either enables or disables file compression in the import package. -The import package is stored in the folder specified by the Path parameter or Identity parameter. -We recommend that you use this parameter for performance reasons. -If compression is enabled, the import process can increase by approximately 30 percent. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile -Suppresses the generation of an import log file. -If this parameter is absent, the Import-SPWeb cmdlet will generate an export log file in the same location as the export package. -The log file uses Unified Logging Service (ULS). - -We recommend that you use this parameter. -However, for performance reasons, you might not want to generate a log file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateVersions -Indicates how to resolve situations where a file to be imported to a site already exists in that site. -If the UpdateVersions parameter is absent, the import operation by default uses a value of 1. - -The type must be any one of the following: - --Add new versions to the current file - --Overwrite the file and all of its versions (delete then insert) - --Ignore the file if it exists on the destination - -The default value is Add new versions to the current file. - -Valid values are: - -Append, Ignore, Overwrite - -```yaml -Type: SPUpdateVersions -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreserveDeletedUserMetadataReferences -{{Fill PreserveDeletedUserMetadataReferences Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Initialize-SPResourceSecurity.md b/sharepoint/sharepoint-ps/sharepoint-server/Initialize-SPResourceSecurity.md deleted file mode 100644 index 96e71d77e0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Initialize-SPResourceSecurity.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Initialize-SPResourceSecurity -schema: 2.0.0 ---- - -# Initialize-SPResourceSecurity - -## SYNOPSIS - -Enforces resource security on the local server. - - - -## SYNTAX - -``` -Initialize-SPResourceSecurity [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Initialize-SPResourceSecurity cmdlet enforces resource security on the local server. -This cmdlet enforces security for all resources, including files, folders, and registry keys. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Initialize-SPResourceSecurity -``` - -This example enforces resource security on the local server. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Initialize-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Initialize-SPStateServiceDatabase.md deleted file mode 100644 index 36c346f0ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Initialize-SPStateServiceDatabase.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Initialize-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Initialize-SPStateServiceDatabase - -## SYNOPSIS -Installs the state database schema into a state service database. - -## SYNTAX - -``` -Initialize-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Initialize-SPStateServiceDatabase cmdlet installs the session state database schema in an empty state service database. -The current user's credentials are used to create the state database schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>$db = Get-SPStateServiceDatabase -Identity StateServceDbName -PS C:\>Initialize-SPStateServiceDatabase -Identity $db -``` - -This example installs the state service database schema into the database associated with the provided identity. - -## PARAMETERS - -### -Identity -Specifies the state service database to initialize. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-FASTSearchAdminDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-FASTSearchAdminDatabase.md deleted file mode 100644 index 20b8015ec1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-FASTSearchAdminDatabase.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Install-FASTSearchAdminDatabase ---- - -# Install-FASTSearchAdminDatabase - -## SYNOPSIS -Installs the database used by the Microsoft FAST Search Server 2010 for SharePoint administration services. - -## SYNTAX - -``` -Install-FASTSearchAdminDatabase [-DbConnection <String>] [-DbName <String>] [-DbServer <String>] [-Force] - [-Upgrade <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet installs the database used by the FAST Search Server 2010 for SharePoint administration services. -This cmdlet is primarily called during installation, by the FAST Search Server 2010 for SharePoint installer. - -The administration database default name is "FASTSearchAdminDatabase" and should be located in the Microsoft SQL Server instance specified by the DbServer or DbConnection parameters. - -In addition to performing an initial installation of the database schema, this cmdlet can also: - --- Reinstall (destructively) the database schema if it already exists. --- Upgrade the database schema from an earlier version. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Install-FASTSearchAdminDatabase -DbConnection "Data Source=sqlserver.contoso.com;Database=FASTSearchAdminDatabase;integrated Security=True;" -``` - -This example installs the database schema in the database server specified by the connection string. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Install-FASTSearchAdminDatabase -Upgrade -DbServer "sqlserver.contoso.com" -``` - -This example upgrades the database schema already installed in the FAST Search Server 2010 for SharePoint administration database on the given SQL Server instance. - -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Install-FASTSearchAdminDatabase -Force -DbServer "sqlserver.contoso.com" -``` - -This example deletes and reinstalls the database schema already installed in the FAST Search Server 2010 for SharePoint administration database on the given SQL Server instance. - -## PARAMETERS - -### -DbConnection -Specifies the database connection string for the FAST Search Server 2010 for SharePoint administration database, in the same format as the ConnectionString property of the System.Data.SqlClient.SqlConnection .NET Framework type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DbName -Specifies the name of the FAST Search Server 2010 for SharePoint administration database. - -The name only takes effect when used in conjunction with the DbServer parameter, not the DbConnection parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DbServer -Specifies the database server instance that contains the FAST Search Server 2010 for SharePoint administration database. - -Only one of the DbServer and DbConnection parameters must be specified. -Using DbServer with a value of sqlserver.contoso.com is equivalent to using DbConnection with the value "Data Source=sqlserver.contoso.com;Database=FASTSearchAdminDatabase;integrated Security=True" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter specifies that the FAST Search Server 2010 for SharePoint administration database already exists, but should be reinstalled. - -This will delete all data that already exists in the database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Upgrade -Specifies that the FAST Search Server 2010 for SharePoint administration database already exists and that it should be upgraded, because it uses an older version of the database schema. - -The upgrade process will attempt to migrate all data to the new database schema. - -It is strongly recommended that you back up the database before performing this operation. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Uninstall-FASTSearchAdminDatabase](Uninstall-FASTSearchAdminDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPApp.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPApp.md deleted file mode 100644 index 6bee513605..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPApp.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPApp -schema: 2.0.0 ---- - -# Install-SPApp - -## SYNOPSIS - -Installs an instance of an app. - - - -## SYNTAX - -``` -Install-SPApp -Identity <SPApp> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - -Web <SPWebPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Install-SPApp cmdlet to install an instance of an app within a web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE------------ -``` -PS C:\>$spapp = Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site http://site_url -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) -PS C:\>Install-SPApp -Web http://site_url -Identity $spapp -``` - -This example installs an app by first importing the app package, and then installing it. - -## PARAMETERS - -### -Identity -Specifies the app to install. -The App object is created by using the Import-SPAppPackage cmdlet. - -```yaml -Type: SPApp -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Web -Specifies the SPWeb object of the app. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Import-SPAppPackage](Import-SPAppPackage.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPApplicationContent.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPApplicationContent.md deleted file mode 100644 index db17b7bed3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPApplicationContent.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPApplicationContent -schema: 2.0.0 ---- - -# Install-SPApplicationContent - -## SYNOPSIS - -Copies shared application data to existing Web application folders. - - - -## SYNTAX - -``` -Install-SPApplicationContent [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The Install-SPApplicationContent cmdlet copies shared application data to existing Web application folders. - -This cmdlet does not take any parameters. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------EXAMPLE-------------------- -``` -PS C:\>Install-SPApplicationContent -``` - -This example copies data to a Web application in the existing folders. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -During a Cummulative Update installation if you face a situation where the full PSConfig cannot run then this cmdlet should be executed on all SharePoint servers to keep the Farm in a supported state. - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPDataConnectionFile.md deleted file mode 100644 index db3631c7aa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPDataConnectionFile.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPDataConnectionFile -schema: 2.0.0 ---- - -# Install-SPDataConnectionFile - -## SYNOPSIS -Installs the provided data connection file. - -## SYNTAX - -``` -Install-SPDataConnectionFile [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Category <String>] [-Confirm] [-Overwrite] [-WebAccessible] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Install-SPDataConnectionFile cmdlet installs the provided data connection file. -If the specified data connection file exists, the user is prompted to replace the existing file. - -This cmdlet does not create a new file. -Instead, it creates a new data connection file object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Install-SPDataConnectionFile -Path 'C:\folder\sample.udcx' -Category "Install" -WebAccessible $true -``` - -This example uploads a data connection file to a specified category. - -This cmdlet is equivalent to the Upload Data Connection File user interface setting that is located on the Manage Data Connection Files page of the SharePoint Central Administration Web site. - -## PARAMETERS - -### -Path -Specifies the full path to the name of the file in the data connection store. - -The type must be the name of a valid data connection file; for example, C:\foldername\myconnection.udcx. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category -Sets an arbitrary category on the file which can be used to group the files. -The category name can have a maximum of 255 characters. - -The type must be a valid string value; for example, Category1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -Overwrites the existing data connection file. -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebAccessible -Specifies that the universal data connection file can be accessed by using the Web service. -If False, only the Forms Server can retrieve the universal data connection files internally. -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPEduSites.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPEduSites.md deleted file mode 100644 index df97808a15..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPEduSites.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Install-SPEduSites -schema: 2.0.0 ---- - -# Install-SPEduSites - -## SYNOPSIS -Do not use - -## SYNTAX - -``` -Install-SPEduSites [-WebApplication] <SPWebApplicationPipeBind> [-MySiteHost] <SPSitePipeBind> - [-SearchCenter] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - -## EXAMPLES - -### Example 1 -``` -Do not use -``` - - - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MySiteHost -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SearchCenter -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Do not use - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPFeature.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPFeature.md deleted file mode 100644 index b557fb7711..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPFeature.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPFeature -schema: 2.0.0 ---- - -# Install-SPFeature - -## SYNOPSIS - -Installs a SharePoint Feature by using the Feature.xml file. - - - -## SYNTAX - -### PathSet -``` -Install-SPFeature [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -### AllExistingFeatures -``` -Install-SPFeature [-AllExistingFeatures] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] - [-SolutionId <String>] [-WhatIf] [<CommonParameters>] -``` - -### ScanForFeatures -``` -Install-SPFeature [-ScanForFeatures] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] - [-SolutionId <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Install-SPFeature cmdlet installs a specific SPFeature by providing, in the Identity parameter, the relative path from the version-specific common FEATURES folder to the feature. -The version-specific FEATURES folder is "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\" if the site collection is in 14 mode, and "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\" if the site collection is in 15 mode. -The SharePoint Feature's files must already be put in the proper directory, either manually or by using a solution installer. - -If the value of the AllExistingFeatures parameter is true, the file system is scanned and all new features that are in both FEATURES folders are installed. -This is generally only used during deployment and upgrade. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Install-SPFeature -path "MyCustomFeature" -``` - -This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Install-SPFeature -AllExistingFeatures -Whatif -``` - -This example shows the unregistered features that are available on the file system and that are installed if this command is run without the WhatIf parameter. -This is commonly done after an upgrade process. - -### --------------EXAMPLE 3----------------- -``` -PS C:\>Install-SPFeature -path "MyCustomFeature" -CompatibilityLevel 14 -``` - -This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature\feature.xml. - -### --------------EXAMPLE 4----------------- -``` -PS C:\>Install-SPFeature -path "MyCustomFeature" -CompatibilityLevel 15 -``` - -This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature\feature.xml. - -## PARAMETERS - -### -Path -Specifies an authentic file path; for example, MyFeature. - -The path to feature must be a literal path to the 14\Template\Features directory. -The feature.xml file name is implied and does not need to be provided. - -If the path to the feature is not found , the following error message is displayed: "Failed to find the XML file at location 14\Template\Features\\\<file path\>." - -```yaml -Type: String -Parameter Sets: PathSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllExistingFeatures -Scans for existing, but unregistered features, and then registers them with the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: AllExistingFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScanForFeatures -Scans and then displays a feature. -The ScanForFeatures parameter does not install a feature. - -```yaml -Type: SwitchParameter -Parameter Sets: ScanForFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of feature to install. -When the version is not specified it will default to the web applications MaxVersion value. - -The values for this can be either 14 or 15. - -```yaml -Type: Int32 -Parameter Sets: PathSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the installation of an already installed feature. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SolutionId -Specifies the solution ID of the features. -If the SolutionId parameter is not provided, all solution IDs are scanned. - -```yaml -Type: String -Parameter Sets: AllExistingFeatures, ScanForFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPHelpCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPHelpCollection.md deleted file mode 100644 index d92f364954..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPHelpCollection.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPHelpCollection -schema: 2.0.0 ---- - -# Install-SPHelpCollection - -## SYNOPSIS - -Installs the provided Help site collection files in the current farm. - - - -## SYNTAX - -### InstallAll -``` -Install-SPHelpCollection [-All] [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### InstallOne -``` -Install-SPHelpCollection -LiteralPath <String> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Install-SPHelpCollection cmdlet installs the Help site collection files for SharePoint Products in the current farm. -Use the LiteralPath parameter to install specific custom Help collection files. -If the LiteralPath parameter is not specified, all available Help in the Help site collection is installed and existing Help collection files are overwritten. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Install-SPHelpCollection -LiteralPath 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\1033\OSSAdmin.cab' -``` - -This example installs the specified help collection in the current farm. - -## PARAMETERS - -### -All -If the LiteralPath parameter is not specified, specifies that all Help Collection CABs under %Program Files%\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\\\<LCID\> in the Help site collection are installed, and existing Help collections are overwritten. - -```yaml -Type: SwitchParameter -Parameter Sets: InstallAll -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiteralPath -Specifies the exact path to a specific custom Help file in the Help site collection cab file. - -The type must be a valid path in either of the following forms: - -- C:\folder_name -- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: InstallOne -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPInfoPathFormTemplate.md deleted file mode 100644 index 9ec9c80384..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Install-SPInfoPathFormTemplate - -## SYNOPSIS -Installs an InfoPath form template on a farm. - -## SYNTAX - -``` -Install-SPInfoPathFormTemplate [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-EnableGradualUpgrade] [-NoWait] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Install-SPInfoPathFormTemplate cmdlet installs an InfoPath form template on a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - - -### ---------------EXAMPLE 1-------------- -``` -PS C:\>Install-SPInfoPathFormTemplate -Path c:\Form.xsn -``` - -This example installs a single form template to the farm. - -### ---------------EXAMPLE 2-------------- -``` -PS C:\>"FormTemplateFirst.xsn", "FormTemplateSecond.xsn", "FormTemplateThird.xsn" | Install-SPInfoPathFormTemplate -``` - -This example installs multiple form templates on a farm. - -## PARAMETERS - -### -Path -Specifies the path and name of the form template to install. - -The type must be a valid path and file name of a form template, in the form: - -- C:\folder_name\formtemplate_name -- \\\\server_name\folder_name\formtemplate_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableGradualUpgrade -Specifies that the new form can be gradually upgraded. - -- If specified and the form template file exists, the form template is gradually upgraded and is then used for new sessions only. -- If not specified and the form template does not exist, the form is overwritten during an upgrade and is then used for exisiting and new sessions. -- If specified and the form template file does not exist, ignore the switch. -- If not specified and the file exists, the user is prompted to upgrade and to use the gradual upgrade if the upgrade is allowed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Specifies that the form template is installed in the background and that the progress of the installation not be shown. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPService.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPService.md deleted file mode 100644 index 0119068307..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPService.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPService -schema: 2.0.0 ---- - -# Install-SPService - -## SYNOPSIS - -Installs and provisions services on a farm. - - - -## SYNTAX - -``` -Install-SPService [-AssignmentCollection <SPAssignmentCollection>] [-Provision] [<CommonParameters>] -``` - -## DESCRIPTION -The Install-SPService cmdlet installs and optionally provisions services on a farm. -This cmdlet installs all services, service instances, and service proxies specified in the registry on the local server computer. -Use this cmdlet in a script that you build to install and deploy a SharePoint farm or to install a custom developed service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Install-SPService -``` - -This example installs all services, service instances and service proxies specified in the registry on the local server computer. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Provision -Specifies default settings when installing a standalone service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPSolution.md deleted file mode 100644 index 9deea5bb59..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPSolution.md +++ /dev/null @@ -1,365 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPSolution -schema: 2.0.0 ---- - -# Install-SPSolution - -## SYNOPSIS - -Deploys an installed SharePoint solution in the farm. - - - -## SYNTAX - -### Deploy -``` -Install-SPSolution [-Identity] <SPSolutionPipeBind> [-AllWebApplications] - [-AssignmentCollection <SPAssignmentCollection>] [-CASPolicies] [-CompatibilityLevel <String>] [-Confirm] - [-Force] [-FullTrustBinDeployment] [-GACDeployment] [-Language <UInt32>] [-Local] [-Time <String>] - [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -### Synchronize -``` -Install-SPSolution [[-Identity] <SPSolutionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Language <UInt32>] [-Synchronize] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Install-SPSolution cmdlet deploys an installed SharePoint solution in the farm. -Use the Add-SPSolution cmdlet to install a SharePoint solution package in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Install-SPSolution -Identity contoso_solution.wsp -GACDeployment -``` - -This example deploys the installed SharePoint solution contoso_solution.wsp in the farm and specifies that GAC can be deployed for the new SharePoint solution. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Install-SPSolution -Identity contoso_solution.wsp -GACDeployment -AddtoLatestVersion $true -``` - -This example deploys the installed SharePoint solution contoso_solution.wsp in the farm within the latest version directories and specifies that global assembly cache (GAC) can be deployed for the new SharePoint solution. - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>Install-SPSolution -Identity contoso_solution.wsp -GACDeployment -CompatibilityLevel {14,15} -``` - -This example deploys the installed SharePoint solution installs a previously added solution so it can be used correctly in both 14 and 15 mode site collections. - -## PARAMETERS - -### -Identity -Specifies the SharePoint solution to deploy. - -The value must be an authentic GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an authentic name of a SharePoint solution (for example, SPSolution1); or an instance of an authentic SPSolution object. - -```yaml -Type: SPSolutionPipeBind -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SPSolutionPipeBind -Parameter Sets: Synchronize -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllWebApplications -Specifies that the new SharePoint solution is deployed for all SharePoint web applications in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CASPolicies -Specifies that code access security (CAS) policies can be deployed for the new SharePoint solution. - -```yaml -Type: SwitchParameter -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel - -{{Fill CompatibilityLevel Description}} - - - -```yaml -Type: String -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the deployment of the new SharePoint solution. - -```yaml -Type: SwitchParameter -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullTrustBinDeployment -Specifies that full trust Bin deployment is permitted. -This parameter is to be used if the solution is fully trusted. - -Bin assembly is an assembly installed into the bin directory of the virtual server. -The assembly in the package will have DeploymentTarget=WebApplication attribute set. -For additional information about bin assembly, see Assembly Element - -```yaml -Type: SwitchParameter -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GACDeployment -Specifies that global assembly cache (GAC) can be deployed for the new SharePoint solution. - -```yaml -Type: SwitchParameter -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Specifies a language for the solution when a solution language package is deployed. -If this parameter is not specified, zero ("0") is assumed. -Use zero for solutions that are valid for all languages. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -Deploys the solution on the active server. - -```yaml -Type: SwitchParameter -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Synchronize -Synchronizes all solutions or the specified solution in the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: Synchronize -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -Specifies when the solution will be deployed. -The default value is immediate deployment. - -The type must be a valid DateTime value, in the form 2010, 5, 1. - -```yaml -Type: String -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication - -Deploys the SharePoint solution for the specified SharePoint web application. - -The value must be in one of the following forms: - ---An authentic GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ---An authentic name of a SharePoint web application (for example, MyOfficeApp1) ---An instance of an authentic SPWebApplication object. - - - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPUserSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPUserSolution.md deleted file mode 100644 index c846b18552..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPUserSolution.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPUserSolution -schema: 2.0.0 ---- - -# Install-SPUserSolution - -## SYNOPSIS - -Activates a sandboxed solution in a site collection. - - - -## SYNTAX - -``` -Install-SPUserSolution [-Identity] <SPUserSolutionPipeBind> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Install-SPUserSolution cmdlet activates a sandboxed solution in a site collection. -A user solution is a sandboxed solution. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE--------------------- -``` -PS C:\>Install-SPUserSolution -Identity contoso_solution.wsp -Site http://sitename -``` - -This example activates the sandboxed solution contoso_solution.wsp in the site http://sitename. - -## PARAMETERS - -### -Identity -Specifies the sandboxed solution to activate. - -The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. - -```yaml -Type: SPUserSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Activates the sandboxed solution for the specified site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPWebPartPack.md b/sharepoint/sharepoint-ps/sharepoint-server/Install-SPWebPartPack.md deleted file mode 100644 index 52e1bca6b4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Install-SPWebPartPack.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Install-SPWebPartPack -schema: 2.0.0 ---- - -# Install-SPWebPartPack - -## SYNOPSIS - -Installs the specified Web Part package to the specified location. - -## SYNTAX - -### UseFileName -``` -Install-SPWebPartPack [-LiteralPath] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Force] [-GlobalInstall] [-Language <UInt32>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] - [-CompatibilityLevel <String>] [<CommonParameters>] -``` - -### UseName -``` -Install-SPWebPartPack [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] - [-GlobalInstall] [-Language <UInt32>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] - [-CompatibilityLevel <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Install-SPWebPartPack cmdlet installs the Web Part package, at the LiteralPath parameter location, in the local farm. -The Web Part package can be installed in a specific Web application by using the WebApplication parameter. -If a Web application is not specified, the Web Part package is installed in all Web applications. - -Use the Language parameter to specify a package language. - -Use the GlobalInstall parameter to install the package to the global assembly cache (GAC). -Assemblies in the GAC are granted FullTrust permission, which gives this package full access to all system-wide resources. - -Use the Force parameter to install the package to overwrite any existing Web Part package with the same name or installed in the same location. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Install-SPWebPartPack "MyCustomWebPartPack" -LiteralPath "C:\mywebpart.wpp" -GlobalInstall -``` - -This example installs the Web Part Package with the name MyCustomWebPartPack globally in the farm from the path c:/mywebpart.wpp. - -## PARAMETERS - -### -LiteralPath -Specifies the exact path to the Web Part package. - -```yaml -Type: String -Parameter Sets: UseFileName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Web Part package to install. - -```yaml -Type: String -Parameter Sets: UseName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrites any existing Web Part package with the same name or installed in the same location. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalInstall -Installs the Web Part package in the global assembly cache (GAC) rather than in the /bin directory of each Web application. -This installation makes the Web Part globally accessible on the servers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Specifies the language ID for the Web Part package. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the Web application on which to install the Web Part pack. -If no Web application is specified, the Web Part pack is installed on all Web applications. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md deleted file mode 100644 index 531eff3df6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync -schema: 2.0.0 ---- - -# Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync - -## SYNOPSIS -Triggers Active Directory Enterprise Resource Pool synchronization on the specified instance of Project Web App. - -## SYNTAX - -``` -Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync [-Url] <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Active Directory Enterprise Resource Pool synchronization is used to create or update multiple Project Server enterprise resources at the same time. -Project Server enterprise resources can also be automatically activated and deactivated based on group membership in the Active Directory directory service. -For example, new employees in your department can automatically be added as Project Server enterprise resources as long as they are in the Active Directory group selected for synchronization. -Conversely, employees who are removed from the Active Directory group have their Project Server accounts deactivated upon synchronization. - -Enterprise Resource Pool synchronization also updates enterprise resource properties with the most current data from Active Directory. -For example, an employee's name and e-mail address may change because of marriage. -As long as the change is made in Active Directory and the user is in the linked group, the change occurs in the user's Enterprise Resource properties when synchronization occurs. - -The Enterprise Resource Pool can be mapped to a single Active Directory group for synchronization. -However, this Active Directory group can contain nested groups whose members are also synchronized. - -The following actions can occur during the Enterprise Resource Pool synchronization process: - -- A new Project Server enterprise resource and corresponding user account can be created based on an Active Directory account. -- An active Project Server resource/user account can be deactivated. -- An existing Project Server user account's metadata (for example, name, e-mail address, and so on) can be updated if it has changed in Active Directory. -- A previously inactive Project Server resource/user account can be reactivated. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync http://localhost/pwa -``` - -This example triggers an Active Directory Enterprise Resource Pool synchronization for the instance of Project Web App located at http://localhost/pwa. - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App instance where you want to invoke a synchronization. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Invoke-SPProjectActiveDirectoryGroupSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Invoke-SPProjectActiveDirectoryGroupSync.md deleted file mode 100644 index 6a73ccdfa6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Invoke-SPProjectActiveDirectoryGroupSync.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Invoke-SPProjectActiveDirectoryGroupSync -schema: 2.0.0 ---- - -# Invoke-SPProjectActiveDirectoryGroupSync - -## SYNOPSIS -Manually starts the synchronization job to synchronize Project Server group membership with the specified Active Directory groups. - -## SYNTAX - -``` -Invoke-SPProjectActiveDirectoryGroupSync [-Url] <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -In Project Server permission mode, groups can be created to assign permissions and synced with Active Directory groups to determine group membership. -The Invoke-SPProjectActiveDirectoryGroupSync cmdlet manually starts the job that synchronizes the group membership from Active Directory into Project Server. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------EXAMPLE 1------------------- -``` -PS C:\>Invoke-SPProjectActiveDirectoryGroupSync -Url http://AppServer/pwa -``` - -This example synchronizes group membership for the specified PWA instance. - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App (PWA) instance where you want to start the Active Directory sync. - -The type must be a valid URL, in the form http://\<ServerName\>/\<PWAName\>. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPProjectPermissionMode](Get-SPProjectPermissionMode.md) - -[Set-SPProjectPermissionMode](Set-SPProjectPermissionMode.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Merge-SPLogFile.md b/sharepoint/sharepoint-ps/sharepoint-server/Merge-SPLogFile.md deleted file mode 100644 index 54a0d8d9b2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Merge-SPLogFile.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Merge-SPLogFile -schema: 2.0.0 ---- - -# Merge-SPLogFile - -## SYNOPSIS - -Combines trace log entries from all farm computers into a single log file on the local computer. - - - -## SYNTAX - -``` -Merge-SPLogFile -Path <String> [-Area <String[]>] [-AssignmentCollection <SPAssignmentCollection>] - [-Category <String[]>] [-ContextFilter <String[]>] [-Correlation <Guid[]>] [-EndTime <DateTime>] - [-EventID <String[]>] [-ExcludeNestedCorrelation] [-Level <String>] [-Message <String[]>] [-Overwrite] - [-Process <String[]>] [-StartTime <DateTime>] [-ThreadID <UInt32[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The Merge-SPLogFile cmdlet returns records from Unified Logging Service (ULS) trace log files on each farm server that match the criteria, and writes the results to a new log file on the local computer. -If no results are returned, a warning is written to the Windows PowerShell console window. - -We recommend that you filter by using the StartTime and EndTime parameters to optimize performance of this cmdlet. -Some filtering parameters such as Process, Area, Category, EventID and Message support wildcards. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -``` - -This example merges the last hour of log data from all farm computers with no filtering. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area Search -``` - -This example merges the last hour of log data from the Search area. - -### --------------EXAMPLE 3----------------- -``` -PS C:\>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area "SharePoint Foundation","Web Analytics Services" -``` - -This example merges the last hour of log data from the SharePoint Foundation and Web Analytics Services areas. - -### --------------EXAMPLE 4----------------- -``` -PS C:\>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Level High -``` - -This example merges the log data of level High or higher. - -### --------------EXAMPLE 5----------------- -``` -PS C:\>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -StartTime "06/09/2008 16:00" -EndTime "06/09/2008 16:15" -``` - -This example merges the log data for events in a particular time range, which is culture-specific to the United States. - -### --------------EXAMPLE 6----------------- -``` -PS C:\>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Message "*permission changed*" -``` - -This example merges the log data for events with permission changed in the message text. - -### --------------EXAMPLE 7----------------- -``` -PS C:\>Merge-SPLogFile -Overwrite -Path d:\1.log -ContextFilter "name=timer job*" -Area "*search*" -``` - -This example merges the log data for all search timer jobs. - -### --------------EXAMPLE 8----------------- -``` -PS C:\>Merge-SPLogFile -Overwrite -Path d:\2.log -ContextFilter "user=contoso?joeuser" -``` - -This example shows how to merge the log data for all user names that have a contoso\joeuser or Contoso/joeuser format. - -## PARAMETERS - -### -Path -Specifies the path and file name to which to write the merged log file. -Relative paths are supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Area -Specifies the area name to filter on. - -The type must be a valid name; for example, SharePoint Foundation. - -The use of wildcards is supported. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category -Specifies the category ID to filter on. - -The type must be a valid category name; for example, category1. - -The use of wildcards is supported. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContextFilter -Specifies a filter for trace entries in a particular context in the form key=value, for example, user=contoso\joeuser. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Correlation -Specifies the correlation ID to filter on. -The type must be a valid GUID, in the form F0BB0790-4323-A153-096F-ABCDC80E24D4. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the log entries returned. - -The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventID -Specifies the Event ID to filter on. -The use of wildcards is supported. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeNestedCorrelation -Excludes nested correlation values in the results. -This parameter is only used when filtering results by using the ContextFilter parameter - -By default, records returned from the ContextFilter parameter include all related records in addition to the records that match the filter. -Specifying this option includes only the records that match the filter and excludes any related records. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Level -Specifies the level name to filter on. - -Results include the specified level and everything more severe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Message -Specifies the message text to filter on. - -The type must be valid text. -Text with spaces should be enclosed with quotation marks; for example, "This is a test." - -The use of wildcards is supported. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -Overwrites the log file if it already exists at the specified path. - -The type must be either of the following values: - -- $True -- $False - -The default value is $False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Process -Specifies the process name to filter on. - -The use of wildcards is supported. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the log entries returned. - -The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. - -The default is one hour prior to the current time on the local computer. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThreadID -Specifies the thread ID to filter on. - -The type must be a valid integer from 0 through 4,294,967,295. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Merge-SPUsageLog.md b/sharepoint/sharepoint-ps/sharepoint-server/Merge-SPUsageLog.md deleted file mode 100644 index 24d393beda..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Merge-SPUsageLog.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Merge-SPUsageLog -schema: 2.0.0 ---- - -# Merge-SPUsageLog - -## SYNOPSIS -Returns records from usage log files. - -## SYNTAX - -``` -Merge-SPUsageLog [-Identity] <SPUsageDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-DiagnosticLogPath <String>] [-EndTime <DateTime>] [-OverWrite] [-Partial] [-Servers <String[]>] - [-StartTime <DateTime>] [<CommonParameters>] -``` - -## DESCRIPTION -The Merge-SPUsageLog cmdlet returns records from usage log files on each farm server that match the criteria, and writes the results to pipeline. - -The command gathers, filters, and aggregates logs base on user specified criteria, we recommend that you filter by using the StartTime and EndTime parameters to optimize performance of this cmdlet. - -You should at least specify a usage type. For information on valid usage types, see Get-SPUsageDefinition. - -This cmdlet requires PowerShell Remoting to be enabled. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Merge-SPUsageLog -Identity 'Timer Jobs' -Servers SPSERVER1 -``` - -Merges the Usage log for the Usage Definition 'Timer Jobs' from the specified server and outputs to the PowerShell console. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DiagnosticLogPath -Specifies the file to write diagnostic information to. A relative path is supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the log entries returned. - -The type must be a valid DateTime format that is culture-specific to the administrative language, that is, 2/16/2007 12:15:12 for English-US. - -The default value is the current time. - -If you want to specify UTC time, you must add a "Z" to the end of the parameter. For example, "2016-06-15 03:29:18.199 Z". If the "Z" is not specify, local computer time will be displayed instead of UTC. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of usage log file. - -```yaml -Type: SPUsageDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OverWrite -Overwrites the diagnostic log file if it already exists at the specified path. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partial -Not used. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Servers -The server address or addresses to filter on. - -To obtain a list of valid addresses in the farm use Get-SPServer | Select Address. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the log entries returned. - -The type must be a valid DateTime format that is culture-specific to the administrative language, such as "2/16/2007 12:15:12" for English-US. - -The default value is one hour prior to the current time on the local computer. - -If you want to specify UTC time, you must add a "Z" to the end of the parameter. For example, "2016-06-15 03:29:18.199 Z". If the "Z" is not specify, local computer time will be displayed instead of UTC. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPUsageDefinitionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPDatabase.md deleted file mode 100644 index a5eca71da3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPDatabase.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016 -title: Migrate-SPDatabase -schema: 2.0.0 ---- - -# Migrate-SPDatabase - -## SYNOPSIS -Do not use. - -## SYNTAX - -### SiteSubscription -``` -Migrate-SPDatabase [-Identity] <SPDatabasePipeBind> [-DestinationDatabase] <SPContentDatabasePipeBind> - [-SiteSubscription] <SPSiteSubscriptionPipeBind> [-ServiceType] <ServiceExtensionType> [-Overwrite] - [-UseLinkedSqlServer] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -### SiteCollection -``` -Migrate-SPDatabase [-Identity] <SPDatabasePipeBind> [-SiteCollection] <SPSitePipeBind> - [-ServiceType] <ServiceExtensionType> [-Overwrite] [-UseLinkedSqlServer] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use. - -## EXAMPLES - -### Example 1 -``` -PS C:\>#Do not use. -``` - -Do not use. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationDatabase -Do not use. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Overwrite -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Do not use. - -```yaml -Type: ServiceExtensionType -Parameter Sets: (All) -Aliases: -Accepted values: DefaultDatabase, Project, UserProfile, SiteSubscription, BDC, Securityobjects, Taxonomy, AppManagement, All -Applicable: SharePoint Server 2016 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Do not use. - -```yaml -Type: SPSitePipeBind -Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Do not use. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLinkedSqlServer -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPProjectDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPProjectDatabase.md deleted file mode 100644 index 70e9d259ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPProjectDatabase.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: Project Server 2016, Project Server 2019 -title: Migrate-SPProjectDatabase -schema: 2.0.0 ---- - -# Migrate-SPProjectDatabase - -## SYNOPSIS -Copies the data from the Project Server 2013 database into the corresponding SharePoint Server 2016, SharePoint Server 2019 content database containing the migrated site collection. - -## SYNTAX - -``` -Migrate-SPProjectDatabase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] -DatabaseName <String> - [-DatabaseServer <String>] [-FailoverPartner <String>] [-Overwrite] [-SQLLogon <PSCredential>] - -SiteCollection <SPSitePipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Copies the data from the Project Server 2013 database into the corresponding SharePoint Server 2016, SharePoint Server 2019 content database containing the migrated site collection. - -Both the Project Server 2013 database and the SharePoint Server 2016, SharePoint Server 2019 database must be on the same instance of SQL -Server and the SharePoint farm account must have full access to the Project Server 2013 database. During the migration process the Project Server 2013 database will be modified and cannot be mounted back to a Project Server 2013. -## EXAMPLES - -### Example 1 -``` -PS C:\>Migrate-SPProjectDatabase -Name ProjectDB1 -SiteCollection "http://contoso1/sites/PWA" -``` - -This example will look for a Project Server 2013 database named ProjectDB1 on the same instance of SQL Server where the content database containing http://contoso1/sites/PWA is located. The data will be upgraded and copied into the site collection. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the Project Server 2013 database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -The name of the instance of SQL Server hosting the Project Server 2013 database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverPartner -The name of the SQL Server failover partner for the Project Server 2013 database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -Specifies to overwrite any Project data from previous attempts. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SQLLogon -SQL Server authentication credentials if needed. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -The URL of the site collection to which you want to copy the Project data. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: True -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 -Applicable: Project Server 2016, Project 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.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPProjectResourcePlans.md b/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPProjectResourcePlans.md deleted file mode 100644 index 8a1c5cb3d5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Migrate-SPProjectResourcePlans.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2016, Project Server 2019 -title: Migrate-SPProjectResourcePlans -schema: 2.0.0 ---- - -# Migrate-SPProjectResourcePlans - -## SYNOPSIS -Migrates the published resource plan assignment data to engagements. Run after data migration has been completed from Project Server 2013 to Project Server 2016, Project Server 2019. - -## SYNTAX - -``` -Migrate-SPProjectResourcePlans [-Url] <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Migrates the published resource plan assignment data to engagements. Run after data migration has been completed from Project Server 2013 to Project Server 2016, Project Server 2019. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Migrate-SPProjectResourcePlans -Url http://pwa_site -``` -Migrates the Project Resource Plans on the Project Web App site http://pwa_site. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -The URL of the Project Web App site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPContentDatabase.md deleted file mode 100644 index f23b2df045..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPContentDatabase.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Mount-SPContentDatabase -schema: 2.0.0 ---- - -# Mount-SPContentDatabase - -## SYNOPSIS - -Attaches an existing content database to the farm. - - - -## SYNTAX - -``` -Mount-SPContentDatabase [-Name] <String> [-WebApplication] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-AssignNewDatabaseId] [-ChangeSyncKnowledge] [-Confirm] - [-ClearChangeLog] [-DatabaseCredentials <PSCredential>] [-DatabaseServer <String>] [-MaxSiteCount <Int32>] - [-NoB2BSiteUpgrade] [-SkipIntegrityChecks] [-WarningSiteCount <Int32>] [-WhatIf] - [-DatabaseAccessCredentials <PSCredential>] [-DatabaseFailoverServer <String>] [-SkipSiteUpgrade] - [-UseLatestSchema] [<CommonParameters>] -``` - -## DESCRIPTION -The Mount-SPContentDatabase cmdlet attaches an existing content database to the farm. -If the database being mounted requires an upgrade, this cmdlet will cause the database to be upgraded. - -The default behavior of this cmdlet causes an upgrade of the schema of the database and initiates upgraded builds for all site collections within the specified content database if required. -To prevent initiation of upgraded builds of site collections, use the NoB2BSiteUpgrade parameter. -This cmdlet does not trigger version-to-version upgrade of any site collections. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE 1--------------------- -``` -PS C:\>Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication http://sitename -``` - -This example mounts an existing database to the sitename web application. -If upgrades are required, it triggers database schema upgrade and then performs only build-to-build upgrade actions on existing site collections if required. -This operation does not changed the CompatibilityLevel for existing site collections in this database. - -### -----------------EXAMPLE 2--------------------- -``` -PS C:\>Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication http://sitename -NoB2BSiteUpgrade -``` - -This example mounts an existing database to the sitename web application but it prevents any site upgrades from occurring. -If upgrades are required, it triggers database schema upgrades only and no build-to-build upgrade actions are performed on any site collections. -This operation does not change the CompatibilityLevel for existing site collections in this database. - -## PARAMETERS - -### -Name -Specifies the existing content database to attach to the farm. - -The type must be a valid name of a SharePoint content database; for example, SPContentDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Attaches the content database to the specified SharePoint web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignNewDatabaseId -Creates a new database ID automatically when the content database is attached. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChangeSyncKnowledge -Database attach will cause all Groove sync client to re-synchronize their content. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClearChangeLog -Clears any pending changes from the change log in the content database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the content database specified in the Name parameter. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSiteCount -Specifies the maximum number of web sites that can use the content database. - -The type must be a positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateUserExperience -Determines whether the content databases should upgrade to the latest user interface. By default, the user interface will not change during upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -NoB2BSiteUpgrade -Specifies not to upgrade all child objects when performing a build-to-build upgrade. -This parameter has no effect when a version-to-version upgrade is specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipIntegrityChecks -Specifies the upgrade process not to run the internal integrity checks such as missing templates, and orphan detection as part of the upgrade process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarningSiteCount -Specifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified. - -The type must be a positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseAccessCredentials -Specifies the credential that belong to SPDataAccess role. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer -Specifies the name of the database server to be mirrored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSiteUpgrade -Specifies to not upgrade all site objects when performing upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLatestSchema -Specifies to use the latest schema. In an on-premises environment, this parameter has no effect. - -There are two values $True and $False. - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPSiteMapDatabase.md deleted file mode 100644 index 1b5fe1a1e0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPSiteMapDatabase.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2016 -title: Mount-SPSiteMapDatabase -schema: 2.0.0 ---- - -# Mount-SPSiteMapDatabase - -## SYNOPSIS -Mounts a Site Map database. Do not use. - -## SYNTAX - -``` -Mount-SPSiteMapDatabase [-DatabaseName] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DatabaseCredentials <PSCredential>] [-DatabaseFailoverServer <String>] -DatabaseServer <String> [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Do not use. - -## EXAMPLES - -### Example 1 -``` -PS C:\>#Do not use. -``` - -Do not use. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Do not use. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPStateServiceDatabase.md deleted file mode 100644 index a9ce693d3d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Mount-SPStateServiceDatabase.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Mount-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Mount-SPStateServiceDatabase - -## SYNOPSIS -Attaches an existing state service database to the farm. - -## SYNTAX - -``` -Mount-SPStateServiceDatabase [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseCredentials <PSCredential>] [-DatabaseServer <String>] - [-ServiceApplication <SPStateServiceApplicationPipeBind>] [-Weight <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The Mount-SPStateServiceDatabase cmdlet attaches an existing state service database to the farm. -If the session state database schema is not installed in the state service database, use the Initialize-SPStateServiceDatabase cmdlet to install the schema after the state service database has been mounted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Mount-SPStateServiceDatabase -Name "statedata1" -DatabaseServer "localhost" -``` - -This example associates a SharePoint Server farm with a SQL Server database. - -This example is used in least privilege scenarios when an administrator cannot create databases in SQL. -The database must already exist and be empty. -The database cannot be used until the Initialize-SPStateServiceDatabase cmdlet is run, so errors could occur with this example. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Mount-SPStateServiceDatabase -Name "statedata1" -DatabaseServer "localhost" -ServiceApplication "ServiceApp1" -Weight 10 | Initialize-SPStateServiceDatabase -``` - -This example associates a SharePoint Server farm with a SQL Server database, at the same time that it also associates the database with a service application and gives a weight of 10. -The result is immediately piped to the Initialize-SPStateServiceDatabase cmdlet so that the database can be used. - -## PARAMETERS - -### -Name -Specifies the database name that is created in the SQL Server database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the database credentials for SQL Authentication used to access the state service database. -If this parameter is not specified, Windows authentication is used. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the state service database. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the state service application to which to add the state database. - -The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for the state database used to load balance the allocation of new data. -The default value is 1. - -The type must be a valid integer in the range of 1 to 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPAppManagementData.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPAppManagementData.md deleted file mode 100644 index ebe6303132..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPAppManagementData.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPAppManagementData -schema: 2.0.0 ---- - -# Move-SPAppManagementData - -## SYNOPSIS -Do Not Use - -## SYNTAX - -``` -Move-SPAppManagementData [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-OverWrite] - -SiteSubscriptionId <Guid> -SourceAppManagementDatabase <SPDatabasePipeBind> - -TargetContentDatabase <SPContentDatabasePipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do Not Use - -## EXAMPLES - -### Example 1 -``` -Do Not Use -``` - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverWrite -Do Not Use - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptionId -Do Not Use -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAppManagementDatabase -Do Not Use -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetContentDatabase -Do Not Use - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPBlobStorageLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPBlobStorageLocation.md deleted file mode 100644 index c98f008c95..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPBlobStorageLocation.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPBlobStorageLocation -schema: 2.0.0 ---- - -# Move-SPBlobStorageLocation - -## SYNOPSIS - -Copies a content database to a new location by using Remote BLOB Storage (RBS). - - - -## SYNTAX - -``` -Move-SPBlobStorageLocation [-SourceDatabase] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DestinationDatabase <String>] [-DestinationDataSourceInstance <String>] [-Dir <String>] - [-VerboseMod <Boolean>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Move-SPBlobStorageLocation cmdlet to use Remote BLOB Storage (RBS) to copy a content database to an instance of a SQL Server database. -The database size limitation for SQL Server is 4 gigabytes (GB). -If a content database is greater than 4 GB, the database cannot be copied directly to a SQL Server database instance. -The Move-SPBlobStorageLocation cmdlet uses the advantage of RBS and copies databases larger than 4 GB. -RBS stores the data on the local hard disk and keeps the links to the data in the database, which results in a smaller database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------EXAMPLE 1----------------------- -``` -PS C:\>Move-SPBlobStorageLocation WSS_Content -``` - -This example copies the content database named WSS_Content from the Windows Internal Database to the same database name in SQL Server 2008 Express by using RBS. - -### -------------------EXAMPLE 2----------------------- -``` -PS C:\>Move-SPBlobStorageLocation WSS_Content -DestinationDatabase WSS_V4_Content -BackupDatabase WSSBackupDB -VerboseMod:$true -``` - -This example copies the content database named WSS_Content from the Windows Internal Database to a database in SQL Server 2008 Express. -The name of the new database will be WSS_V4_Content. -During the move, the backup file name will be WSSBackupDB. -The output of this command displays log information to the Command Prompt window. - -## PARAMETERS - -### -SourceDatabase -Specifies the name of the Windows Internal Database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationDatabase -Specifies the name of the migrated database. -If the DestinationDatabase parameter is not specified, the SourceDatabase parameter is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationDataSourceInstance -Specifies the name of the instance of the destination database. -The value in the SourceDatabase parameter is migrated to this instance. -The name of the instance of the database should be SQL Server with Service Pack 1 (SP1) and Cumulative Update 2 version or higher. -If the DestinationDataSourceInstance parameter is not specified, the local host name is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dir -Used for all disk operations, including storing temporary backups and database (.mdf) files of a migrated database. -If the Dir parameter is not specified, a default directory of the destination SQL Server instance is used. -The free space in this directory should be at least two times the size of the source database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VerboseMod -Generates verbose log output to be displayed in the Command Prompt window. -If the VerboseMod parameter is not specified, no output is displayed. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPDeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPDeletedSite.md deleted file mode 100644 index 9e8308f57c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPDeletedSite.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPDeletedSite -schema: 2.0.0 ---- - -# Move-SPDeletedSite - -## SYNOPSIS - -Moves deleted site collections from one content database to another. - - - -## SYNTAX - -``` -Move-SPDeletedSite [-Identity] <SPDeletedSitePipeBind> -DestinationDatabase <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ContentDatabase <SPContentDatabasePipeBind>] - [-RbsProviderMapping <Hashtable>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Move-SPDeletedSite cmdlet to move data in a specified site collection from its current content database to the content database specified by the DestinationDatabase parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------EXAMPLE---------- -``` -PS C:\>Move-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c -DestinationDatabase "ContentDB2" -``` - -This example moves deleted site collections from the specified GUID to the database named "ContentDB2". - -## PARAMETERS - -### -Identity -Specifies the identity of the site collection to be moved. -For example, http://servername/sites/sitename. - -```yaml -Type: SPDeletedSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DestinationDatabase -Specifies the content database that the site collection should be moved to. -For example, ContentDB2. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the SQL Server content database where the site collection data will be stored. -If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RbsProviderMapping -Used to move a Remote BLOB Storage (RBS)-enabled site collection from one RBS-enabled content database to another RBS-enabled content database without moving the underlying Binary Large Object (BLOB) content. -If the content database has more than one RBS provider associated with it, you must specify all providers. -The same providers must be enabled on the target content database and the source content database. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the Web application from which to list sites. - -The type must be a valid URL in the form http://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPEnterpriseSearchLinksDatabases.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPEnterpriseSearchLinksDatabases.md deleted file mode 100644 index 249a2e1113..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPEnterpriseSearchLinksDatabases.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPEnterpriseSearchLinksDatabases -schema: 2.0.0 ---- - -# Move-SPEnterpriseSearchLinksDatabases - -## SYNOPSIS -Moves data across links databases. - -## SYNTAX - -``` -Move-SPEnterpriseSearchLinksDatabases [-SearchApplication] <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-RepartitioningId <Guid>] - [-SourceStores <LinksStore[]>] [-TargetStores <LinksStore[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Move-SPEnterpriseSearchLinksDatabases cmdlet moves data across a given list of links databases during farm configuration and scale out, to improve the performance and resource load of the farm. -Once the move has started, the cmdlet will return a unique identifier, the RepartitioningId. -Use this identifier to retrigger if the current run fails. -After the move has finished, the old databases can be removed. - -A links database stores query logging and analytics information. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceapplication -PS C:\>$ssa | New-SPEnterpriseSearchLinksDatabase -DatabaseName "links1" -PS C:\>$ssa | New-SPEnterpriseSearchLinksDatabase -DatabaseName "links2" -PS C:\>$ssa | New-SPEnterpriseSearchLinksDatabase -DatabaseName "links3" -PS C:\>$dbs = $ssa | Get-SPEnterpriseSearchLinksDatabase -PS C:\>$ssa | Move-SPEnterpriseSearchLinksDatabases -TargetStores $dbs -``` - -This example adds 3 new links databases and uses Move-SPEnterpriseSearchLinksDatabases to move data from the current links databases into new databases. - -## PARAMETERS - -### -SearchApplication - -Specifies the search application that contains the links database. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -Specifies the search application that contains the links database. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepartitioningId - -Resumes the move with this identifier. - - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceStores - -Specifies a source list of databases. -If this parameter is not specified then all currently existing links databases will be used as a source list. - - - -```yaml -Type: LinksStore[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetStores - -Specifies a target list of databases. -If this parameter is not specified then all currently existing links databases will be used as a target list. - - - -```yaml -Type: LinksStore[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchLinksDatabase](New-SPEnterpriseSearchLinksDatabase.md) - -[Set-SPEnterpriseSearchLinksDatabase](Set-SPEnterpriseSearchLinksDatabase.md) - -[Get-SPEnterpriseSearchLinksDatabase](Get-SPEnterpriseSearchLinksDatabase.md) - -[Remove-SPEnterpriseSearchLinksDatabase](Remove-SPEnterpriseSearchLinksDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPProfileManagedMetadataProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPProfileManagedMetadataProperty.md deleted file mode 100644 index edcfc146e6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPProfileManagedMetadataProperty.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPProfileManagedMetadataProperty -schema: 2.0.0 ---- - -# Move-SPProfileManagedMetadataProperty - -## SYNOPSIS -Moves multiple-string values into a term set. - -## SYNTAX - -``` -Move-SPProfileManagedMetadataProperty -Identity <String> - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-AvailableForTagging] [-Confirm] [-TermSetName <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Move-SPProfileManagedMetadataProperty cmdlet to move multiple-string or single-string property values into a term set that you specify. -If you do not specify a term set, the values are moved into the Keywords term set. -Any new values you add to the property after running the cmdlet will be moved into the term set that you specified. - -After a user profile application has been upgraded from Office SharePoint Server, single-string and multiple-string value properties are not available for use unless the Move-SPProfileManagedMetadataProperty cmdlet is run to map them to term sets within Managed Metadata Service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE------------------ -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Move-SPProfileManagedMetadataProperty -ProfileServiceApplicationProxy $proxy -Identity SPS-Interests -TermSetName Interests -AvailableForTagging -``` - -This example moves values from the SPS-Interests property into a new term set called Interests and marks that term set as available for tagging. - -## PARAMETERS - -### -Identity -Specifies the name of the profile property that needs to be migrated to the taxonomy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the name of the User Profile Service Application Proxy to use. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AvailableForTagging -Determines whether the terms in the resulting term set can be used for Managed Metadata tagging. -If a term set has more than 30,000 terms, using it for Managed Metadata tagging may lead to performance issues on the client computer. -Because a majority of the profile properties may have more than 30,000 terms, the default value is No. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TermSetName -When specified, the term set name is created. -If the TermSetName parameter is not specified, the property is mapped to the Keywords term set in Managed Metadata Service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPSite.md deleted file mode 100644 index 854352ce85..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPSite.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPSite -schema: 2.0.0 ---- - -# Move-SPSite - -## SYNOPSIS - -Moves site collections from one content database to another. - - - -## SYNTAX - -``` -Move-SPSite [-Identity] <SPSitePipeBind> -DestinationDatabase <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-RbsProviderMapping <Hashtable>] [-WhatIf] - [-CopyEvents <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION - -The Move-SPSite cmdlet moves the data in the specified site collection from its current content database to the content database specified by the DestinationDatabase parameter. - -A no-access lock is applied to the site collection to prevent users from altering data within the site collection while the move is taking place. - -Once the move is complete, the site collection is returned to its original lock state. - -An IIS reset is required for the site move to take effect. - -The destination content database specified must already exist, must be attached to the same SQL Server as the site collection's current content database, and must be attached to the site collection's current Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ---------------------EXAMPLE 1----------------------- -``` -PS C:\>Move-SPSite http://servername/sites/sitename -DestinationDatabase ContentDb2 -``` - -This example moves the site collection http://servername/sites/sitename to the content database ContentDb2. - -### ---------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPSite -ContentDatabase ContentDb1 | Move-SPSite -DestinationDatabase ContentDb2 -``` - -This example moves all site collections in ContentDb1 to ContentDb2. - -### ---------------------EXAMPLE 3----------------------- -``` -PS C:\>Get-SPSiteAdministration | where { $_.OwnerLoginName -eq "DOMAIN\username" } | Move-SPSite -DestinationDatabase ContentDb2 -``` - -This example moves all site collections where DOMAIN\username is the site collection owner to ContentDb2. -The Get-SPSiteAdministration cmdlet is used instead of the Get-SPSite cmdlet because you must have permission within the site collection to access the properties of the SPSite object. -You can access the properties of the SPSiteAdministration object as a SharePoint farm administrator. - -### ---------------------EXAMPLE 4----------------------- -``` -PS C:\>Move-SPSite -Identity siteUrl -DestinationDatabase databaseName -RbsProviderMapping - @{"sourceProvider1"="targetProvider1", "sourceProvider2"="targetProvider2"} -``` - -This example moves an RBS-enabled site collection from one RBS-enabled content database to another RBS-enabled content database, sourceProvider1 is the source RBS provider and targetProvider1 is the target RBS provider. - -## PARAMETERS - -### -Identity -Specifies the identity of the site collection to be moved. -For example, http://servername/sites/sitename. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DestinationDatabase -Specifies the content database that the site collection should be moved to. -For example, ContentDB2. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RbsProviderMapping -This parameter was added in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Used to move an RBS-enabled site collection from one RBS-enabled content database to another RBS-enabled content database without moving the underlying BLOB content. -If the content database has more than one RBS provider associated with it, you must specify all providers. -The same providers must be enabled on the target content database and the source content database. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyEvents -Specifies if events need to be copied. - -The valid values are True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPSocialComment.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPSocialComment.md deleted file mode 100644 index 85df380b7b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPSocialComment.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPSocialComment -schema: 2.0.0 ---- - -# Move-SPSocialComment - -## SYNOPSIS -Moves social comments. - -## SYNTAX - -``` -Move-SPSocialComment [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-NewUrl <String>] - [-OldUrl <String>] -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server 2010 with Service Pack 1 (SP1) and SharePoint Foundation 2010 with Service Pack 1 (SP1). - -Use the Move-SPSocialComment cmdlet to move social comments from one page to another page. - -This cmdlet does not move Tags or Ratings. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - -## EXAMPLES - -### Example 1 -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Move-SPSocialComments -ProfileServiceApplicationProxy $proxy -OldUrl "http://contoso/Pages/oldtest.aspx" -NewUrl "http://contoso/Pages/newtest.aspx" -``` - -This example moves social comments from oldtest.aspx to newtest.aspx. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewUrl -Specifies the target URI to which the social notes will be moved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OldUrl -Specifies the source URI from which the social notes will be moved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. - -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -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 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind -Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPUser.md b/sharepoint/sharepoint-ps/sharepoint-server/Move-SPUser.md deleted file mode 100644 index e40b359f4e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Move-SPUser.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Move-SPUser -schema: 2.0.0 ---- - -# Move-SPUser - -## SYNOPSIS - -Migrates a user account in SharePoint Products. - - - -## SYNTAX - -``` -Move-SPUser [-Identity] <SPUserPipeBind> -NewAlias <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-IgnoreSID] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Move-SPUser cmdlet migrates user access from one domain user account to another. -If an entry for the new login name already exists, the entry is marked for deletion to make way for the migration. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$user = Get-SPUser -Identity "DOMAIN\JaneDoe" -Web http://webUrl -PS C:\>Move-SPUser -Identity $user -NewAlias "Domain\JaneSmith" -IgnoreSid -``` - -This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith. - -### ------------------EXAMPLE 2------------------ -``` -C:\PS>$user = Get-SPUser -Identity "DomainA\JaneDoe" -Web http://webUrl -PS C:\>Move-SPUser -Identity $user -NewAlias "DomainB\JaneDoe" -``` - -This example migrates DOMAIN\JaneDoe from DomainA to the new account of DOMAINB\JaneDoe in DomainB with SID History enabled. - -### ------------------EXAMPLE 3------------------ -``` -C:\PS>$user = Get-SPUser -Identity "i:0#.w|DOMAIN\JaneDoe" -Web http://webUrl -PS C:\>Move-SPUser -Identity $user -NewAlias "i:0#.W|Domain\JaneSmith" -IgnoreSid -``` - -This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith when using Windows Claims. `-IgnoreSid` must always be used with `Move-SPUser` when using a Claims Identity, such as Windows Claims. - -## PARAMETERS - -### -Identity -Specifies the `SPUser` object retrieved via `Get-SPUser`. - -The type must be a valid `SPUser` object. - -```yaml -Type: SPUserPipeBind -Parameter Sets: (All) -Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewAlias -Specifies the new login name of the user account. - -The type must be a valid login name, in the form DOMAIN\username. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSID -Indicates (if present) that Active Directory will not be queried for the SID history attribute to ensure that the new login name is correspondent to the old login name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchContentCollection.md deleted file mode 100644 index b01eedebca..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchContentCollection.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchContentCollection ---- - -# New-FASTSearchContentCollection - -## SYNOPSIS -Creates a new Microsoft FAST Search Server 2010 for SharePoint content collection. - -## SYNTAX - -``` -New-FASTSearchContentCollection [-Name] <String> [[-Description] <String>] [[-Pipeline] <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new FAST Search Server 2010 for SharePoint content collection. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchContentCollection -Name newscollection -``` - -This example creates a new FAST Search Server 2010 for SharePoint content collection named "newscollection". - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchContentCollection -Name newscollection -Description "A collection for news content" -``` - -This example creates a new content collection named "newscollection", and attaches a description to it. - -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchContentCollection -Name newscollection -Description "A collection for news content" -Pipeline "Office14 (webcluster)" -``` - -This example creates a new content collection, and uses the FAST Search Server 2010 for SharePoint document processing pipeline "Office14 (webcluster)" to feed content to the content collection. - -## PARAMETERS - -### -Name -The name of the FAST Search Server 2010 for SharePoint content collection to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -A description of the content collection to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pipeline -The FAST Search Server 2010 for SharePoint document processing pipeline used to feed content to the content collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-FASTSearchContentCollection](Clear-FASTSearchContentCollection.md) - -[Remove-FASTSearchContentCollection](Remove-FASTSearchContentCollection.md) - -[Get-FASTSearchContentCollection](Get-FASTSearchContentCollection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCategory.md deleted file mode 100644 index f4d92a7e72..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCategory.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataCategory ---- - -# New-FASTSearchMetadataCategory - -## SYNOPSIS -Creates a new category for crawled properties. - -## SYNTAX - -``` -New-FASTSearchMetadataCategory -Name <String> -Propset <Guid> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new category for crawled properties. -A category is identified by its name and its property set global unique identifier (GUID). - -All crawled properties that are members of a category share the same property set GUID as the category. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$guid = [guid]::NewGuid() -New-FASTSearchMetadataCategory -Name ExampleCategory -Propset $guid -``` - -This example creates a category named "ExampleCategory" with a new GUID generated by the system. -New crawled properties can then be mapped to this category by specifying the GUID when calling New-FASTSearchMetadataCrawledProperty or Set-FASTSearchMetadataCrawledProperty. - -See Set-FASTSearchMetadataCategory for descriptions of category properties. - -## PARAMETERS - -### -Name -The name of the new category. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Propset -The property set Global Unique Identifier (GUID) assigned to this category. -A GUID is a 128-bit integer that has a very low probability of being duplicated. -The GUID can be specified either in the form of a System.Guid object, or as a 128-bit integer with the format "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". -A crawled property can only be mapped to one category at a time. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataCategory](Get-FASTSearchMetadataCategory.md) - -[Remove-FASTSearchMetadataCategory](Remove-FASTSearchMetadataCategory.md) - -[Set-FASTSearchMetadataCategory](Set-FASTSearchMetadataCategory.md) - -[New-FASTSearchMetadataCrawledProperty](New-FASTSearchMetadataCrawledProperty.md) - -[Set-FASTSearchMetadataCrawledProperty](Set-FASTSearchMetadataCrawledProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCrawledProperty.md deleted file mode 100644 index 0dbcbc87d1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCrawledProperty.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataCrawledProperty ---- - -# New-FASTSearchMetadataCrawledProperty - -## SYNOPSIS -Creates a new crawled property. - -## SYNTAX - -``` -New-FASTSearchMetadataCrawledProperty -Name <String> -Propset <Guid> -VariantType <Int32> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new crawled property. -A crawled property is a piece of metadata extracted from content sources and fed to the Microsoft FAST Search Server 2010 for SharePoint system. -For example, the title of a Web page would normally be a crawled property. - -A crawled property is uniquely defined by three properties: - --- The name of the crawled property. --- The property set to which the crawled property is mapped, specified as a GUID (Global Unique Identifier). The GUID identifies which category the crawled property belongs to. A crawled property must be a member of a category. --- The variant type of the crawled property, which specifies the crawled property's data type. - -To include content in the full text indexes, crawled properties must be mapped to managed properties. -If a crawled property has IsMappedToContents set to "true", then the crawled property will automatically be added to the default searchable index (the full text index called "content"). -A newly created crawled property has its IsMappedToContents parameter set to the same value as the mapped-to category's MapToContents parameter. - -See New-FASTSearchMetadataCategory for information about creating a new category for crawled properties. - -See Set-FASTSearchMetadataCrawledProperty for information about changing the properties of an existing crawled property. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$guid = [guid]::NewGuid() -New-FASTSearchMetadataCategory -Name MoreWeb -Propset $guid -New-FASTSearchMetadataCrawledProperty -Name ExtendedTitle -Propset $guid -Varianttype 31 -``` - -This example first creates a new category named "MoreWeb", and then creates a new crawled property "ExtendedTitle" that is mapped to the "MoreWeb" category (because it has the same property set value). -The data type of the crawled property is a Unicode string (VT_LPWSTR, variant type 31). - -The new category gets the property set value "e20d8de2-0b5c-46f8-993d-6cdacbda5164", which was randomly generated by the System.GUID.NewGuid() method. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchMetadataCrawledProperty | Where-Object -filterscript { $_.CategoryName -eq "Web"} -New-FASTSearchMetadataCrawledProperty -Name Internaltitle -varianttype 31 -Propset d1b5d3f0-c0b3-11cf-9a92-00a0c908dbf1 -``` - -This example adds a new crawled property to an existing catalog of crawled properties. -The new crawled property is named "Internaltitle", added to the "Web" category. -It is variant type 31, a Unicode string in the user default locale. - -The "Web" category has several property set GUIDs. -Investigating with the command: - -Get-FASTSearchMetadataCrawledProperty | Where-Object -filterscript { $_.CategoryName -eq "Web"} - -reveals that the "DESCRIPTION" crawled property, which is a type similar to the crawled property to add, has the property set value "d1b5d3f0-c0b3-11cf-9a92-00a0c908dbf1". -This property set is chosen for the new crawled property. - -To use this crawled property, you must configure the connector or feeding application to send a value with the same name, variant type, and property set. - -## PARAMETERS - -### -Name -The name of the new crawled property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Propset -The property set GUID of the new crawled property. - -The GUID controls which category the crawled property belongs to. -A GUID (Global Unique Identifier) is a 128-bit integer that has a very low probability of being duplicated. -The GUID can be specified either as a System.Guid object, or as an integer having the format "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VariantType -An integer value specifying the data type of the crawled property. -See https://go.microsoft.com/fwlink/?LinkId=163232 (https://go.microsoft.com/fwlink/?LinkId=163232) for a list of common variant types. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchMetadataCrawledProperty](Set.FASTSearchMetadataCrawledProperty.md) - -[Get-FASTSearchMetadataCrawledProperty](Get-FASTSearchMetadataCrawledProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCrawledPropertyMapping.md deleted file mode 100644 index 5f0a33e1f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataCrawledPropertyMapping.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataCrawledPropertyMapping ---- - -# New-FASTSearchMetadataCrawledPropertyMapping - -## SYNOPSIS -Creates a new mapping from a crawled property to a managed property. - -## SYNTAX - -``` -New-FASTSearchMetadataCrawledPropertyMapping -CrawledProperty <CrawledProperty> - -ManagedProperty <ManagedProperty> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet maps a crawled property to a managed property and stores the crawled content in the Microsoft FAST Search Server 2010 for SharePoint index. - -You can map a crawled property to multiple managed properties. -If you map multiple crawled properties to a single managed property, use the managed property's MergeCrawledProperties parameter to control whether or not the crawled properties are merged into the managed property or just overwritten. -See Set-FASTSearchMetadataManagedProperty for more information. - -When you map a crawled property into a managed property, the variant type of the crawled property is converted into the available data types in FAST Search Server 2010 for SharePoint. -See https://go.microsoft.com/fwlink/?LinkId=163233 (https://go.microsoft.com/fwlink/?LinkId=163233) for details about this conversion, and which variant types can be converted into native FAST Search Server 2010 for SharePoint types. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$sitetitle_managedproperty = Get-FASTSearchMetadataManagedProperty -Name sitetitle -$internaltitle_crawledproperty = Get-FASTSearchMetadataCrawledProperty -name internaltitle -New-FASTSearchMetadataCrawledPropertyMapping -Managedproperty $sitetitle_managedproperty -crawledproperty $internaltitle_crawledproperty -``` - -This example adds a mapping from the crawled property "internaltitle" (here part of the Web category) to the managed property "sitetitle". - -Note that both the crawled property and the managed property already exist, and these commands only add the mapping. -As a result, the crawled property "internaltitle" will now be mapped to "sitetitle" and stored in the FAST Search Server 2010 for SharePoint system. -The managed property can then be included in a full text index to make it searchable. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$extended_title = New-FASTSearchMetadataManagedproperty -name ExtendedTitle -Type 1 -$title = Get-FASTSearchMetadataManagedProperty -name title -$title.GetCrawledPropertyMappings() | ForEach-Object { New-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty $extended_title -CrawledProperty $_ } -``` - -This example adds a new managed property named "ExtendedTitle", and maps to "ExtendedProperty" all crawled properties that are normally mapped to the managed property named "title". -The original "title" managed property is not changed, to avoid changing the current behavior of the search system. - -This example first generates a list of crawled property objects mapped to the original "title" managed property. -Then the example iterates over this list using ForEach-Object to add each of them to the new "ExtendedTitle" managed property. -More crawled properties can be added to this new managed property later without impacting the "title" managed property. - -## PARAMETERS - -### -CrawledProperty -The crawled property that is mapped to a managed property. - -```yaml -Type: CrawledProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -The managed property to which a crawled property is mapped. - -```yaml -Type: ManagedProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataCrawledPropertyMapping](Get-FASTSearchMetadataCrawledPropertyMapping.md) - -[Remove-FASTSearchMetadataCrawledPropertyMapping](Remove-FASTSearchMetadataCrawledPropertyMapping.md) - -[Set-FASTSearchMetadataCrawledPropertyMapping](Set-FASTSearchMetadataCrawledPropertyMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataFullTextIndex.md deleted file mode 100644 index 56a1655a7d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataFullTextIndex.md +++ /dev/null @@ -1,99 +0,0 @@ - --- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataFullTextIndex ---- - -# New-FASTSearchMetadataFullTextIndex - -## SYNOPSIS -Creates a new full text index. - -## SYNTAX - -``` -New-FASTSearchMetadataFullTextIndex -Description <String> -Name <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new full text index in Microsoft FAST Search Server 2010 for SharePoint. -A full text index can be searched by specifying the full text index name in a query. -For example: "extracontent:car" searches for the term "car" in the full text index named "extracontent". -If no full text index is specified, the default full text index is used. -A relevancy score is calculated when searching the full text index, according to the rank profile specified in the query (or the default rank profile, if no rank profile is specified). - -See Set-FASTSearchMetadataFullTextIndex for details about changing the default full text index for searching. - -See Set-FASTSearchMetadataRankProfile for more details about rank profiles. - -Use New-FASTSearchMetadataFullTextIndexMapping to create mappings from managed properties to a new full text index. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchMetadataFullTextIndex -Name CommonSharePoint -Description "Content from the common SharePoint site." -``` - -This example creates a new full text index named "CommonSharePoint". -After it has been created, you can map managed properties into the full text index. -See New-FASTSearchMetadataFullTextIndexMapping for details about mapping properties into a full text index. - -## PARAMETERS - -### -Description -Description of the full text index, including the type of content or which connector feeds the data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the new full text index. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchMetadataFullTextIndex](Remove-FASTSearchMetadataFullTextIndex.md) - -[Set-FASTSearchMetadataFullTextIndex](Set-FASTSearchMetadataFullTextIndex.md) - -[Get-FASTSearchMetadataFullTextIndex](Get-FASTSearchMetadataFullTextIndex.md) - -[Set-FASTSearchMetadataRankProfile](Set-FASTSearchMetadataRankProfile.md) - -[New-FASTSearchMetadataFullTextIndexMapping](New-FASTSearchMetadataFullTextIndexMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataFullTextIndexMapping.md deleted file mode 100644 index d95be2bc58..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataFullTextIndexMapping.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataFullTextIndexMapping ---- - -# New-FASTSearchMetadataFullTextIndexMapping - -## SYNOPSIS -Creates a new mapping from a managed property into the full text index. - -## SYNTAX - -``` -New-FASTSearchMetadataFullTextIndexMapping -FullTextIndex <FullTextIndex> -Level <Int32> - -ManagedProperty <ManagedProperty> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet adds the content of a managed property to a full text index by mapping the managed property into the full text index. -The mapping is only applicable to new content; existing content must be re-fed to appear in this full text index. - -The managed properties are ordered by a concept called importance level. -If the number of matching documents for a query term is greater than the StopWordThreshold for the rank profile in use, the Microsoft FAST Search Server 2010 for SharePoint system retries the query, limiting the managed properties searched to those from a higher importance level. - -Importance level 1 (the first level that will be used in a query) includes managed properties from all levels 1 and up. -Importance level 2 includes levels 2 and up. -The maximum level is 7. - -This process is called drilling. -See Set-FASTSearchMetadataRankProfile for more information about StopWordThreshold. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title -$fulltextindex = Get-FASTSearchMetadataFullTextIndex -Name thirdfulltextindex -New-FASTSearchMetadataFullTextIndexMapping -ManagedProperty $title -FullTextIndex $fulltextindex -Level 3 -``` - -This example maps the managed property called "title" into the full text index named "thirdfulltextindex" at level 3. - -After this mapping is made, the content must be re-fed to populate the full text index. - -## PARAMETERS - -### -FullTextIndex -The full text index to add the mapping to. - -```yaml -Type: FullTextIndex -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Level -The importance level of this managed property. -Allowed values are 1 through 7. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ImportanceLevel, L -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -The managed property being mapped to the full text index. - -```yaml -Type: ManagedProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchMetadataFullTextIndexMapping](Remove-FASTSearchMetadataFullTextIndexMapping.md) - -[Set-FASTSearchMetadataFullTextIndexMapping](Set-FASTSearchMetadataFullTextIndexMapping.md) - -[Get-FASTSearchMetadataFullTextIndexMapping](Get-FASTSearchMetadataFullTextIndexMapping.md) - -[Set-FASTSearchMetadataRankProfile](Set-FASTSearchMetadataRankProfile.md) - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - -[Get-FASTSearchMetadataFullTextIndex](Get-FASTSearchMetadataFullTextIndex.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataManagedProperty.md deleted file mode 100644 index d791ccfdc3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataManagedProperty.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataManagedProperty ---- - -# New-FASTSearchMetadataManagedProperty - -## SYNOPSIS -Creates a new managed property. - -## SYNTAX - -``` -New-FASTSearchMetadataManagedProperty -Name <String> -Type <Int32> [-Description <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new managed property in the Microsoft FAST Search Server 2010 for SharePoint system. -The managed property can be one of the following data types: - --- Text: UTF-8 encoded text string --- Integer: Signed 64 bit integer --- Boolean: true / false --- Float: Double-precision 64-bit floating point, as specified in IEEE-754 --- Decimal: Integer with up to 27 decimals (number of decimals is set through the DecimalPlaces parameter of the managed property; see Set-FASTSearchMetadataManagedProperty). --- Datetime: Date range in ISO8601 format. Valid date range is -29000-01-01T00:00:00,000 to 29000-12-31T23:59:59,999. Managed properties which have the type datetime always have sorting enabled. - -See https://go.microsoft.com/fwlink/?LinkId=163234 (https://go.microsoft.com/fwlink/?LinkId=163234) for more detailed information about the valid value ranges for each of these data types, and how illegal values are handled. - -For IEEE-754, see http://ieeexplore.ieee.org/servlet/opac?punumber=2355 (http://ieeexplore.ieee.org/servlet/opac?punumber=2355). - -For details about the options that can be set on a managed property, see Set-FASTSearchMetadataManagedProperty. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchMetadataManagedProperty -name integervalue -type 2 -description "A managed property for integer values" -``` - -This example creates a managed property called "integervalue" of type 2 (integer). -To further change the settings on the managed property, see Set-FASTSearchMetadataManagedProperty. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$managedproperty = New-FASTSearchMetadataManagedProperty -Name webtitle -type 1 -description "Titles from RSS and Sitemap Files" -$rsstitle = Get-FASTSearchMetadataCrawledProperty -Name rss.title -$sitetitle = Get-FASTSearchMetadataCrawledProperty -Name sitemap.title -New-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty $managedproperty -CrawledProperty $rsstitle -New-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty $managedproperty -CrawledProperty $sitetitle -$content_fulltextindex = Get-FASTSearchMetadataFullTextIndex -name content -New-FASTSearchMetadataFullTextIndexMapping -FullTextIndex $content_fulltextindex -ManagedProperty $managedproperty -level 7 -``` - -This example shows a complete work-flow for making a new managed property and mapping a crawled property to it. -It creates a new managed property called "webtitle" to which it maps the crawled properties "rss.title" and "sitemap.title". -The "webtitle" managed property is then mapped into the full text index "content" at importance level 7. - -After this, you can feed documents (not shown here) with the crawled properties "rss.title" and "sitemap.title", and they will appear in the "webtitle" managed property. -This managed property is then searchable as part of the full text index named "content". - -To make the managed property searchable on its own, see Set-FASTSearchMetadataManagedProperty-Queryable. - -## PARAMETERS - -### -Name -The name of the new managed property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -An integer representing the data type of the new managed property. -Valid values are: - --- 1 (Text) --- 2 (Integer) --- 3 (Boolean) --- 4 (Float) --- 5 (Decimal) --- 6 (Datetime) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -A text description of the managed property explaining what the managed property is used for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - -[Set-FASTSearchMetadataManagedProperty](Set-FASTSearchMetadataManagedProperty.md) - -[Remove-FASTSearchMetadataManagedProperty](Remove-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataRankProfile.md deleted file mode 100644 index db201c5fc5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchMetadataRankProfile.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchMetadataRankProfile ---- - -# New-FASTSearchMetadataRankProfile - -## SYNOPSIS -Creates a new rank profile to calculate relevance in queries. - -## SYNTAX - -``` -New-FASTSearchMetadataRankProfile -Name <String> [-Template <RankProfile>] [<CommonParameters>] -``` - -## DESCRIPTION -A rank profile controls the relevancy calculation for a query. -It consists of several components which are weighted so that the relevancy calculation fits the content. -See Set-FASTSearchMetadataRankProfile for more details. - -A rank profile can either be created with default values, or based on another existing rank profile using the Template parameter. - -The rank profile is typically specified as part of a query. -If no rank profile is specified in the query, the default rank profile is used. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchMetadataRankProfile -Name newrankdistribution -``` - -This example adds a new rank profile based on the default settings. -The new rank profile is called "newrankdistribution". - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$rankprofile_template = Get-FASTSearchMetadataRankProfile -Name newrankdistribution -New-FASTSearchMetadataRankProfile -Template $rankprofile_template -Name ExtraRankProfile -``` - -This example adds a new rank profile based on an existing rank profile called "newrankdistribution". - -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$new_rank_profile = New-FASTSearchMetadataRankProfile -Name ImprovedDefault -$new_rank_profile.makeDefault() -``` - -This example specifies a new rank profile to use as the default rank profile for the FAST Search Server 2010 for SharePoint. - -## PARAMETERS - -### -Name -The name of the new rank profile. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -An object representing the rank profile that will serve as a template in creating the new rank profile. - -```yaml -Type: RankProfile -Parameter Sets: (All) -Aliases: RankProfileTemplate, T -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FASTSearchMetadataRankProfile](Remove-FASTSearchMetadataRankProfile.md) - -[Set-FASTSearchMetadataRankProfile](Set-FASTSearchMetadataRankProfile.md) - -[Get-FASTSearchMetadataRankProfile](Get-FASTSearchMetadataRankProfile.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSearchSettingGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSearchSettingGroup.md deleted file mode 100644 index ad75aee635..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSearchSettingGroup.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchSearchSettingGroup ---- - -# New-FASTSearchSearchSettingGroup - -## SYNOPSIS -Creates a new Microsoft FAST Search Server 2010 for SharePoint search setting group. - -## SYNTAX - -``` -New-FASTSearchSearchSettingGroup -Name <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new FAST Search Server 2010 for SharePoint search setting group. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSearchSettingGroup -Name marketinggroup -``` - -This example creates a new FAST Search Server 2010 for SharePoint search setting group named "marketinggroup". - -## PARAMETERS - -### -Name -The name of the search setting group to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSearchSettingGroup](Get-FASTSearchSearchSettingGroup.md) - -[Remove-FASTSearchSearchSettingGroup](Remove-FASTSearchSearchSettingGroup.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityClaimsUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityClaimsUserStore.md deleted file mode 100644 index b3e02f2835..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityClaimsUserStore.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchSecurityClaimsUserStore ---- - -# New-FASTSearchSecurityClaimsUserStore - -## SYNOPSIS -Creates a FAST Search Server 2010 for SharePoint security user store to provide security for claims content. - -## SYNTAX - -``` -New-FASTSearchSecurityClaimsUserStore [-Identity] <String> [[-Description] <String>] [[-Issuer] <String>] - [-ObjectToClone <ClaimsUserStore>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet configures extended security for claims content. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSecurityClaimsUserStore -Identity clm -``` - -This example creates a new security claims user store with a user store Identity of "clm". - -This example uses default values for all parameters except the required Identity parameter. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityClaimsUserStore -Identity clm | New-FASTSearchSecurityClaimsUserStore -Identity cl2 -``` - -This example creates a new security claims user store with an identity of "cl2" using all properties from the claims user store "clm" as a baseline. -The New-FASTSearchSecurityClaimsUserStore cmdlet uses the ObjectToClone value on the pipeline as input to the New cmdlet. - -## PARAMETERS - -### -Identity -The user store identity. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -A brief explanation of the user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Issuer -The Microsoft SharePoint Server Security Token Service (STS) claims provider that issued the claims. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectToClone -A claims user store object whose property values are used as a baseline to create another claims user store. - -```yaml -Type: ClaimsUserStore -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityClaimsUserStore](Get-FASTSearchSecurityClaimsUserStore.md) - -[Set-FASTSearchSecurityClaimsUserStore](Set-FASTSearchSecurityClaimsUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityLotusNotesUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityLotusNotesUserStore.md deleted file mode 100644 index 31cae10f4a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityLotusNotesUserStore.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchSecurityLotusNotesUserStore ---- - -# New-FASTSearchSecurityLotusNotesUserStore - -## SYNOPSIS -Creates a FAST Search Server 2010 for SharePoint security user store to provide security for Lotus Notes content. - -## SYNTAX - -``` -New-FASTSearchSecurityLotusNotesUserStore [-Identity] <String> - [[-NonIndexableCharacterEncodingPrefix] <String>] [[-NonIndexableCharacterPattern] <String>] - [[-Description] <String>] [[-UseDenyOnDefault] <Boolean>] [[-UseDocumentSecurity] <Boolean>] - [[-UseWildcardSecurity] <Boolean>] [[-UseViewSecurity] <Boolean>] [[-AllowPrefix] <String>] - [[-DenyPrefix] <String>] [[-NonIndexableCharacterHandling] <String>] [-ObjectToClone <LotusNotesUserStore>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet configures FAST Search Server 2010 for SharePoint security for Lotus Notes content. - -A Lotus Notes security user store uses a user-dependent query filter that is applied to each query to enforce the defined access control policies based on indexed values. -The Lotus Notes security user store search filter requires that the user has read access to both the item and the database to view a specific item. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>new-FASTSearchSecurityLotusNotesUserStore ln1 -``` - -This example creates a new security Lotus Notes user store with a user store identity of "ln1". - -This example uses default values for all parameters except the required Identity parameter. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityLotusNotesUserStore -Identity ln1 | New-FASTSearchSecurityLotusNotesUserStore -Identity ln3 -UseViewSecurity $true -``` - -This example creates a new Lotus Notes user store with an identity of "ln3" and enables view level security. -The New-FASTSearchSecurityLotusNotesUserStore command uses the ObjectToClone object on the pipeline as input to the New command for default parameter values. - -## PARAMETERS - -### -Identity -User store identity. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -A brief explanation of the user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseDenyOnDefault -If true, support for default access with deny on users/groups is enabled on database level security. - -You must enable this filter for an inverse security model: first grant access to everyone, and then explicitly deny access to certain groups or users. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseDocumentSecurity -If true, item security is enabled (i.e., the filter contains an item level security condition). - -If set to false, item level security is ignored; only database level security (and possibly view security) is used. - -If items always inherit the ACLs of the database, you can turn off this option. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseWildcardSecurity -If true, database access through wildcard group entry (starting with */) is enabled. - -If set to false, the wildcard check is ignored. -Only normal groups are checked against the database ACL. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseViewSecurity -If true, view security is enabled (i.e., the filter contains a view level security condition). - -If set to false, view level security is ignored; only database level security (and possibly item security) is used. - -If views always inherit the ACLs of the database, or if views are not indexed, you can turn off this option. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowPrefix -A string value prepended to the document ACL to control which items the user is allowed access to and which items will be returned in the query. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DenyPrefix -A string value prepended to the ACL to control which items the user is denied access to and which items are not returned from the query. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NonIndexableCharacterHandling -Specifies what to do with ACL values that match the NonIndexableCharacterRegExPattern regular expression. - -Valid values: - --- encode - The ACL is encoded into a single searchable term. --- encodeWithPrefix - The value of NonIndexableEncodedPrefix is concatenated with the ACL to be encoded, producing a single searchable term. --- remove - The ACL is removed from both allowing and denying access. Specify "remove" if the ACL is never used to deny access. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NonIndexableCharacterEncodingPrefix -If NonIndexableCharacterHandling is set to encodeWithPrefix, this parameter specifies the prefix added to the encoded ACL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NonIndexableCharacterPattern -Specifies a regular expression pattern used to detect non-indexable characters in an ACL. - -Identities matching this regular expression pattern will be processed based on NonIndexableCharacterHandling. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectToClone -A Lotus Notes user store object whose property values are used as a baseline for the Lotus Notes user store being created. - -```yaml -Type: LotusNotesUserStore -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityLotusNotesUserStore](Set-FASTSearchSecurityLotusNotesUserStore.md) - -[Get-FASTSearchSecurityLotusNotesUserStore](Get-FASTSearchSecurityLotusNotesUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityRegexAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityRegexAliaser.md deleted file mode 100644 index dc24b2a00d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityRegexAliaser.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchSecurityRegexAliaser ---- - -# New-FASTSearchSecurityRegexAliaser - -## SYNOPSIS -Creates a regular expression aliaser. - -## SYNTAX - -``` -New-FASTSearchSecurityRegexAliaser [-InputUserStoreId] <String> [-OutputUserStoreIds] <String[]> - [-Patterns] <System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig]> - [[-Identity] <String>] [[-CaseSensitive] <Boolean>] [[-UnicodeCaseSensitive] <Boolean>] - [-ObjectToClone <SecurityRegexAliaser>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a regular expression aliaser to map users/groups from one user store to users/groups in other user stores, based on a regular expression pattern. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSecurityRegexAliaserPattern -Regex .* -MapToUsername \1 | New-FASTSearchSecurityRegexAliaser -Identity regex1 -InputUserStoreId ln1 -OutputUserStoreIds ln2 -``` - -This example creates a regular expression aliaser pattern object and pipes it into a New-FASTSearchSecurityRegexAliaser cmdlet to create a regular expression aliaser. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSecurityRegexAliaserPattern -Regex .* -MapToUsername \1 | New-FASTSearchSecurityRegexAliaser -InputUserStoreId ln1 -OutputUserStoreIds ln2,ln3 -CaseSensitive $False -UnicodeCaseSensitive $False -``` - -This example creates a regular expression aliaser pattern object and pipes it into a New-FASTSearchSecurityRegexAliaser cmdlet to create a regular expression aliaser. -The example sets the case-sensitive flags so pattern matching is performed in a case-insensitive manner. -The OutputUserStoreIds parameter maps users/groups to two user stores: "ln2" and "ln3". -The example generates the aliaser identity. - -## PARAMETERS - -### -InputUserStoreId -The identity of the mapped-from user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputUserStoreIds -A comma-separated list of mapped-to user store identities. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Patterns -A list of RegExAliasPatternMapConfig instances containing the regular expression patterns used for the mapping. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Identity -The identity of the aliaser. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CaseSensitive -Specifies whether the regular expression patterns defined in the RegExAliasPatternMapConfig list are matched based on case sensitivity matching rules. -The default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UnicodeCaseSensitive -Specifies whether the regular expressions patterns defined in the RegExAliasPatternMapConfig list are matched based on Unicode case sensitivity matching rules. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectToClone -A SecurityRegexAliaser object whose property values are used for the SecurityRegexAliaser aliaser being created. - -```yaml -Type: SecurityRegexAliaser -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityRegexAliaser](Set-FASTSearchSecurityRegexAliaser.md) - -[Get-FASTSearchSecurityRegexAliaser](Get-FASTSearchSecurityRegexAliaser.md) - -[New-FASTSearchSecurityRegexAliaserPattern](New-FASTSearchSecurityRegexAliaserPattern.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityRegexAliaserPattern.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityRegexAliaserPattern.md deleted file mode 100644 index 88d4b09322..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityRegexAliaserPattern.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchSecurityRegexAliaserPattern ---- - -# New-FASTSearchSecurityRegexAliaserPattern - -## SYNOPSIS -Creates a new regular expression pattern for a regex principal aliaser. - -## SYNTAX - -``` -New-FASTSearchSecurityRegexAliaserPattern [-Regex] <String> [-MapToUsername] <String> - [[-InputPropertyName] <String>] - [-Patterns <System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig]>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new regular expression pattern that can be added to the list of patterns for a regular expression based principal aliaser. -This cmdlet creates a regular expression pattern that is used by and input to the New-FASTSearchSecurityRegexAliaser and Set-FASTSearchSecurityRegexAliaser cmdlets. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSecurityRegexAliaserPattern -Regex .* -InputPropertyName mail -MapToUsername "\1" -``` - -This example creates a regular expression pattern that can be used to map the "mail" property of a Microsoft user store to identities in other user stores. - -Use the regex pattern configuration object output from this command for the value of a pattern's parameter in a New-FASTSearchSecurityRegexAliaser or a Set-FASTSearchSecurityRegexAliaser cmdlet. - -## PARAMETERS - -### -Regex -The regular expression pattern that determines if the user or group should be mapped to another user store. -This regular expression pattern may contain regular expression groups that may be used in the generation of the MapToUsername value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapToUsername -The user or group name to look to. -This can also contain regular expression group replacements using the syntax: - -\# - -where # is the group capture index. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputPropertyName -The user/group property name this regular expression pattern is matched against. - -The InputPropertyName is one of the following: - --- $PRINCIPAL_REFERENCE_ID - The identifier of the user or group. This is the default. --- $PRINCIPAL_REFERENCE_ALIAS - The alias of the user or group. - -Any other property of the user or group. -Refer to your specific user store for other properties that the user store exposes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Patterns -A list of RegExAliasPatternMapConfig objects. -The RegExAliasPatternMapConfig being created is added to this list. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityRegexAliaser](Get-FASTSearchSecurityRegexAliaser.md) - -[New-FASTSearchSecurityRegexAliaser](New-FASTSearchSecurityRegexAliaser.md) - -[Set-FASTSearchSecurityRegexAliaser](Set-FASTSearchSecurityRegexAliaser.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityXMLAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityXMLAliaser.md deleted file mode 100644 index 14f886d1dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-FASTSearchSecurityXMLAliaser.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: New-FASTSearchSecurityXMLAliaser ---- - -# New-FASTSearchSecurityXMLAliaser - -## SYNOPSIS -Creates an XML principal aliaser. - -## SYNTAX - -``` -New-FASTSearchSecurityXMLAliaser [-InputUserStoreId] <String> [-OutputUserStoreIds] <String[]> - [[-Identity] <String>] [[-InputPropertyName] <String>] [-ObjectToClone <SecurityXMLAliaser>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates an XML aliaser to map users and groups from one user store to users and groups in other user stores, based on an XML mapping file. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSecurityXMLAliaser -InputUserStoreId win -OutputUserStoreIds ln3 -InputPropertyName mail -``` - -This example creates an XML principal aliaser to map the mail property of a Microsoft user store to users and groups in another user store. - -Use the Set-FASTSearchSecurityXMLAliaser cmdlet to upload the XML mapping file. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityAliaser xmlalias2 | New-FASTSearchSecurityXMLAliaser -Identity myxmlalias -OutputUserStoreIds ln2 -``` - -This example creates an XML principal aliaser based on an existing XML aliaser but sets the output user store IDs to 'ln2'. - -Use the Set-FASTSearchSecurityXMLAliaser cmdlet to upload an XML mapping file with desired mappings for the new aliaser. - -## PARAMETERS - -### -InputUserStoreId -The identity of the mapped-from user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputUserStoreIds -A comma-separated list of mapped-to user store identities. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Identity -The identity of the aliaser. -An identity is generated if the parameter is not specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputPropertyName -The user/group property name this regular expression pattern is matched against. - -The InputPropertyName is one of the following: - --- $PRINCIPAL_REFERENCE_ID - The identifier of the user or group. This is the default. - -Be sure to enclose in single quotes: '$PRINCIPAL_REFERENCE_ID' - --- $PRINCIPAL_REFERENCE_ALIAS - The alias of the user or group. - -Be sure to enclose in single quotes: '$PRINCIPAL_REFERENCE_NAME' - -Any other property of the user or group. -Refer to your specific user store for other properties that the user store exposes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectToClone -A SecurityXMLAliaserobject whose property values are copied as a baseline in the creation of another SecurityXMLAliaser aliaser. - -```yaml -Type: SecurityXMLAliaser -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FASTSearchSecurityXMLAliaser](Set-FASTSearchSecurityXMLAliaser.md) - -[Get-FASTSearchSecurityXMLAliaser](Get-FASTSearchSecurityXMLAliaser.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServiceApplication.md deleted file mode 100644 index 568b339990..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServiceApplication.md +++ /dev/null @@ -1,470 +0,0 @@ ---- -external help file: microsoft.office.access.services.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAccessServiceApplication -schema: 2.0.0 ---- - -# New-SPAccessServiceApplication - -## SYNOPSIS -Creates a new instance of an Access Services application in SharePoint Server. - -## SYNTAX - -``` -New-SPAccessServiceApplication [-Name <String>] -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-ColumnsMax <Int32>] [-Confirm] - [-Default] [-NonRemotableQueriesAllowed] [-OrderByMax <Int32>] [-OuterJoinsAllowed] - [-OutputCalculatedColumnsMax <Int32>] [-PrivateBytesMax <Int32>] [-RecordsInTableMax <Int32>] - [-RequestDurationMax <Int32>] [-RowsMax <Int32>] [-SessionMemoryMax <Int32>] - [-SessionsPerAnonymousUserMax <Int32>] [-SessionsPerUserMax <Int32>] [-SourcesMax <Int32>] - [-TemplateSizeMax <Int32>] [-WhatIf] [-ApplicationLogSizeMax <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPAccessServiceApplication cmdlet creates a new instance of an Access Services application in SharePoint Server 2010, SharePoint Server 2013. -After you create a new Access Services application, use the Set-SPAccessServiceApplication cmdlet to modify its global settings. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE 1---------------- -``` -PS C:\>New-SPAccessServiceApplication -Name "MyAccessService" -SPIisWebServiceApplicationPool MyAppPool -``` - -This example creates a new instance of Access Services named MyAccessService that runs under the application pool named MyAppPool. - -### ------------EXAMPLE 2---------------- -``` -PS C:\>New-SPAccessServiceApplication -Name "MyAccessService" -SPIisWebServiceApplicationPool MyAppPool -SessionsPerUserMax 25 -``` - -This example creates a new instance of Access Services named MyAccessService that runs under the application pool named MyAppPool, which allows up to 25 sessions per user on each back end application server machine on which Access Services runs. - -## PARAMETERS - -### -Name -Specifies the display name of the Access Services application to create. -The name can contain a maximum of 128 characters and can contain the comma (,), equal sign (=), or colon (:) characters provided they are enclosed in quotation marks. - -The type must be a valid name of an Access Services application; for example, AccessSrvApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing Internet Information Services (IIS) application pool to run the Web service in for the new Access Services application. - -The type must be a valid instance of a SPIisWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheTimeout -Specifies the number of seconds that a data cache will remain active on Access Services with no user activity. -Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days. - -The type must be the integers -1, or an integer in the range of 1 to 2073600 (24 days). -The default value is 300. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ColumnsMax -Specifies the maximum number of columns that a list involved in a query can contain, or that the output of the query can contain. -The default value is 30. - -The type must be an integer in the range of 1 to 255 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Specifies that the service application is associated with Web applications by adding this service application's proxy to the farm's default proxy list. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonRemotableQueriesAllowed -Specifies that queries that cannot be remoted to the database tier can run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrderByMax -Specifies the maximum number of Order By clauses in the query. -The default value is 4. - -The type must be an integer in the range of 1 to 8. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OuterJoinsAllowed -Specifies that left and right outer joins are supported. -Inner joins are always supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputCalculatedColumnsMax -Specifies the maximum number of calculated columns that can be included in the output as a part of the query. -Calculated columns in the underlying list are not included. -The default value is 10. - -The type must be an integer in the range of 1 to 32. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBytesMax -Specifies the maximum private bytes in megabytes (MB) that can be used by Access Services. -When set to -1, Access Services defaults to 75 percent of physical memory on the machine. -Valid values are -1 (no limit), and from 1 to any positive integer.The default value is -1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordsInTableMax -Specifies the maximum number of records allowed for a table in the Access Services application. -Valid values include: -1, no limit, and 1 to any positive integer. -The default value is 500000. - -The type must be the integer -1, or an integer in the range of 1 to MaxInt. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestDurationMax -Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. -Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. -The default value is 30. - -The type must be the integer -1, or an integer in the range of 1 to 2073600 (24 days) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RowsMax -Specifies the maximum number of rows that a list involved in a query can have, or that the output of the query can have. -The default value is 50000. - -The type must be an integer in the range of 1 to 200000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionMemoryMax -Specifies the maximum allowable size, in megabytes, of an individual session. -Valid values include 0, disable property, and 1 to 4095. -The default value is 64. - -The type must be the integer 0, or an integer in the range of 1 to 4095. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerAnonymousUserMax -Specifies the maximum number of sessions allowed per user. -If this maximum is reached, the oldest session will be deleted when a new session is started. -Valid values include: -1, no limit, and 1 to any positive integer. -The default value is 10. - -The type must be the integer -1, or an integer in the range of 1 to MaxInt. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerUserMax -Specifies the maximum number of sessions allowed per user. -If this maximum is reached, the oldest session will be deleted when a new session is started. -Valid values include: -1, no limit, and 1 to any positive integer. -The default value is 10. - -The type must be the integer -1, or an integer in the range of 1 to MaxInt. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcesMax -Specifies the maximum number of lists that can be used as input to a query at one time. -The default value is 8. - -The type must be an integer in the range of 1 to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateSizeMax -The maximum allowable size in megabytes allowed for Access templates (.accdt file files) uploaded into the solution gallery. -Valid values: -1(no limit), from 1 to any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationLogSizeMax -Specifies the maximum number of records for an Access Services Application Log list. Valid valies: -1 to maxint. 0 means none are allowed. The default value is 3000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesApplication.md deleted file mode 100644 index 750d9ba5b3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesApplication.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAccessServicesApplication -schema: 2.0.0 ---- - -# New-SPAccessServicesApplication - -## SYNOPSIS -Creates an Access Services Service Application. - -## SYNTAX - -### DefaultParameterSet -``` -New-SPAccessServicesApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-Confirm] -DatabaseServer <String> - [-DatabaseServerCredentials <PSCredential>] [-Default] [-Encrypt <Boolean>] [-Hosted <Boolean>] - [-Name <String>] [-PrivateBytesMax <Int32>] [-QueryTimeout <Int32>] [-RecoveryPointObjective <Int32>] - [-RequestDurationMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] [-SessionsPerUserMax <Int32>] - [-TrustServerCertificate <Boolean>] [-WhatIf] [<CommonParameters>] -``` - -### NoApplicationServerParameterSet -``` -New-SPAccessServicesApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-Confirm] [-Default] - [-Hosted <Boolean>] [-Name <String>] [-PrivateBytesMax <Int32>] [-QueryTimeout <Int32>] - [-RecoveryPointObjective <Int32>] [-RequestDurationMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] - [-SessionsPerUserMax <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Access Services Service Application. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-SPAccessServicesApplication -DatabaseServer SQLServerName -ApplicationPool 'SharePoint Web Services Default' -Name 'Access Services Service Application' -Default -``` - -Creates an Access Services Service Application. - -## PARAMETERS - -### -ApplicationPool -Specifies the existing IIS application pool in which to run the Web service for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheTimeout -The maximum time (in seconds) that a data cache can remain available, as measured from the end of each request for data in that cache. - -Valid values: -1 (indicates no limit); 1 through 2073600 (24 days). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid SQL Server host name; for example, SERVER\Database. - -```yaml -Type: String -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerCredentials -Specifies the credentials used to log into the database server. - -```yaml -Type: PSCredential -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Add to default Service Application Proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: NoApplicationServerParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encrypt -Specifies to use SSL encryption between Access Services and the SQL Server hosting Access Services databases. - -```yaml -Type: Boolean -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Hosted -{{Fill Hosted Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Access Services Service Application to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBytesMax -The maximum number of private bytes (in MB) allocated by the Access Services process. - -Valid values: -1 (the limit is set to 50% of physical memory on the machine), any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryTimeout -Maximum time in seconds for a database command or query to execute before it is cancelled. - -Valid values: 0 (indicates no limit); 1 through 2073600 (24 days). Recommended value is 60. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPointObjective -{{Fill RecoveryPointObjective Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestDurationMax -The maximum duration (in seconds) allowed for a request from an application. - -Valid values: -1 (indicates no limit); 1 through 2073600 (24 days). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerAnonymousUserMax -The maximum number of sessions allowed per anonymous user. If this maximum is hit the oldest session will be deleted when a new session is started. - -Valid values: -1 (no limit), 1 to any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerUserMax -The maximum number of sessions allowed per user. If a user has this many sessions and starts a new session, the user's oldest session is deleted. - -Valid values: -1 (no limit), from 1 to any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustServerCertificate -{{Fill TrustServerCertificate Description}} - -```yaml -Type: Boolean -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesApplicationProxy.md deleted file mode 100644 index d8cb7eb24d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesApplicationProxy.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAccessServicesApplicationProxy -schema: 2.0.0 ---- - -# New-SPAccessServicesApplicationProxy - -## SYNOPSIS -Creates a Proxy for an Access Services Service Application. - -## SYNTAX - -``` -New-SPAccessServicesApplicationProxy [-application] <SPServiceApplication> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a Proxy for an Access Services Service Application. -## EXAMPLES - -### Example 1 -``` -PS C:\>$sa = New-SPAccessServicesApplication -DatabaseServer spag.lab.cobaltatom.com -ApplicationPool 'SharePoint Web Services Default' -Name 'Access Services Service Application' -Default -PS C:\>New-SPAccessServicesApplicationProxy -application $sa -``` - -This example creates an Access Services Application, placing it into the `$sa` variable. Using the `$sa` variable, it is then used to create the Access Services Service Application Proxy. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -application -Specifies the Access Services Service Application to create a proxy for. - -```yaml -Type: SPServiceApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.Administration.SPServiceApplication -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesDatabaseServer.md deleted file mode 100644 index 1c0773c84c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAccessServicesDatabaseServer.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAccessServicesDatabaseServer -schema: 2.0.0 ---- - -# New-SPAccessServicesDatabaseServer - -## SYNOPSIS -Adds a server to host Access Services databases. - -## SYNTAX - -``` -New-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-AvailableForCreate <Boolean>] [-Confirm] - [-DatabaseServerCredentials <PSCredential>] [-DatabaseServerGroupName <String>] -DatabaseServerName <String> - [-Encrypt <Boolean>] [-Exclusive <Boolean>] [-SecondaryDatabaseServerName <String>] - [-ServerReferenceId <Guid>] [-TrustServerCertificate <Boolean>] [-UserDomain <String>] - [-ValidateServer <Boolean>] [-WhatIf] [-LoginType <LoginType>] [-State <DatabaseServerStates>] - [-StateOwner <ServerStateOwner>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet adds additional Access Services database servers to host Access Services databases. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-SPAccessServicesDatabaseServer -ServiceContext http://siteUrl -DatabaseServerName SQLSVR01 -ValidateServer:$true -``` - -This example adds the SQL Server named SQLSVR01 as an Access Services database server using the context of the site, http://siteUrl. This also validates SQLSVR01 is capable of hosting Access Services databases. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AvailableForCreate -Indicates whether or not the SQL Server is available to create Access Services databases on. The default value is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerCredentials -Specifies the credentials used to connect to the SQL Server. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerGroupName -Specifies the Access Services database group name. The default value is DEFAULT. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerName -Specifies the name of the SQL Server to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encrypt -Specifies to use SSL encryption between Access Services and the SQL Server hosting Access Services databases. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exclusive -If the SQL Server has AvaliableForCreate set to False, this will update it to True. If the SQL Server Id does not match the database server Id and the server has AvailableForCreate set to True, this will set AvailableForCreate to False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryDatabaseServerName -Specifies a secondary SQL Server to associate to the new SQL Server. This is used for disaster recovery purposes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerReferenceId -Provide a specific Server Reference Id. By default, a Server Reference Id is generated automatically when the SQL Server is added. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context to retrieve Access Services information from. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TrustServerCertificate -Sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserDomain -Specifies the domain to use for credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidateServer -Validates the SQL Server is in a supported state to host Access Services databases. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginType -Indicates the login type. Valid values are: - -* ApplicationLogin - -*LocalDBApplicationLogin - -* ServerLogin - -* StorageAccountLogon - -* WindowsAzureServerLogin - -The default value is ServerLogin. - -```yaml -Type: LoginType -Parameter Sets: (All) -Aliases: -Accepted values: ApplicationLogin, LocalDBApplicationLogin, ServerLogin, StorageAccountLogon, WindowsAzureServerLogin -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Indicates the availability of the SQL Server to be added. Valid values are: - -* Active - -* Locked - -* Reserved - -The default value is Active. - -```yaml -Type: DatabaseServerStates -Parameter Sets: (All) -Aliases: -Accepted values: Active, Locked, Reserved -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOwner -Specifies the state owner. Valid values are: - -* NoOwner - -* TenantMove - -The default value is NoOwner. - -```yaml -Type: ServerStateOwner -Parameter Sets: (All) -Aliases: -Accepted values: NoOwner, TenantMove -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAlternateURL.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAlternateURL.md deleted file mode 100644 index 366d207925..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAlternateURL.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAlternateURL -schema: 2.0.0 ---- - -# New-SPAlternateURL - -## SYNOPSIS - -Creates a new public or internal URL for the specified Web application zone or resource. - - - -## SYNTAX - -### WebApplication -``` -New-SPAlternateURL [-Url] <String> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Internal] [-WhatIf] [-Zone <SPUrlZone>] - [<CommonParameters>] -``` - -### ResourceName -``` -New-SPAlternateURL [-Url] <String> -ResourceName <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Internal] [-WhatIf] [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The New-SPAlternateUrl cmdlet creates a new public or internal URL for the specified Web application zone or resource. -Use the ResourceName parameter if the alternate URL is for an external resource. - -Each Web application can be associated with a collection of mappings between internal and public URLs. -Both internal and public URLs consist of the protocol and domain portion of the full URL; for example, https://www.fabrikam.com. -Users type a public URL to get to the SharePoint site, and that URL appears in the links on the pages. -Internal URLs are in the URL requests that are sent to the SharePoint site. -Many internal URLs can be associated with a single public URL in multiserver farms; for example, when a load balancer routes requests to specific IP addresses to various servers in the load-balancing cluster. - -Each Web application supports five collections of mappings per URL; the five collections correspond to five zones (default, intranet, extranet, Internet, and custom). -When the Web application receives a request for an internal URL in a particular zone, links on the pages returned to the user have the public URL for that zone. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>#create the public URL -PS C:\>New-SPAlternateURL https://www.contoso.com -Zone "Internet" - -PS C:\>#create the internal URL -PS C:\>New-SPAlternateURL http://sharepoint.contoso.com -Zone "Internet" -internal -``` - -This example translates incoming requests for https://www.contoso.com into http://sharepoint.contoso.com (on the Internet zone). - -When a reverse proxy is being set up to handle public URL SSL termination, alternate access mappings must be configured to handle the URL translation. - -## PARAMETERS - -### -Url -Specifies the public URL that users access to sign in to the Web application. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the name, URL, or GUID of the Web application for which to create the mapping. - -The type must be a valid name, URL, in the form WebApplication-1212, http://server_name, or GUID, in the form 1234-5678-9876-0987. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the resource name, if the alternate URL is for an external resource. -If no value is specified, the value is left blank. - -```yaml -Type: String -Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Internal -Makes this alternate URL an internal URL. -If this parameter is not provided, the URL is a public URL. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -Specifies one of the five zones with which the alternate URL is associated. - -The type must be a valid zone: Default, Intranet, Internet, Extranet, or Custom. - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAppManagementServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAppManagementServiceApplication.md deleted file mode 100644 index 331e7eaeea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAppManagementServiceApplication.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAppManagementServiceApplication -schema: 2.0.0 ---- - -# New-SPAppManagementServiceApplication - -## SYNOPSIS - -Creates an App Management Service application. - - - -## SYNTAX - -``` -New-SPAppManagementServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabaseName <String>] [-DatabaseServer <String>] [-FailoverDatabaseServer <String>] [-Name <String>] - [-WhatIf] [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-SPAppManagementServiceApplication cmdlet to create an App Management Service application with the specified name on the specified application pool with a single database which specified parameters create. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE---------- -``` -PS C:\>New-SPAppManagementServiceApplication -Name AppManagement -DatabaseServer MyDatabaseServer -DatabaseName AppManagementDB -ApplicationPool MyServiceAppPool -``` - -This example creates an App Management Service application named AppManagement with a database server MyDatabaseServer and database name AppManagementDB. -The new service application will run under the app pool named MyServiceAppPool - -## PARAMETERS - -### -ApplicationPool -Specifies the application pool of the service application. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the credentials to use when creating the service application database. -These credentials will have owner rights on the newly created service application database. -If a value is not provided, the current user's credentials are used by default. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the service application database to be created. -If a value is not provided, a default database name is provided. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the server of the service application database to be created, If a value is not provided, the default database server is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the failover server of the service application database to be created, If a value is not provided, there will not be a failover server for the service application database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the service application to be created. -If not provided, the default name is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPAppManagementServiceApplicationProxy](New-SPAppManagementServiceApplicationProxy.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAppManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAppManagementServiceApplicationProxy.md deleted file mode 100644 index cd3a6ffefc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAppManagementServiceApplicationProxy.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAppManagementServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPAppManagementServiceApplicationProxy - -## SYNOPSIS - -Creates an App Management Service application proxy. - - - -## SYNTAX - -### ServiceApplication -``` -New-SPAppManagementServiceApplicationProxy -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Name <String>] [-UseDefaultProxyGroup] [-WhatIf] - [<CommonParameters>] -``` - -### Uri -``` -New-SPAppManagementServiceApplicationProxy -Uri <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Name <String>] [-UseDefaultProxyGroup] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the New-SPAppManagementServiceApplicationProxy cmdlet to create an App Management Service application proxy with the specified name for the specified App Management Service application or the specified endpoint. -Depending on the parameter value, it also adds the new proxy to the default proxy group. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE------------- -``` -PS C:\>$sa = New-SPAppManagementServiceApplication -Name AppManagement -DatabaseServer MyDatabaseServer -DatabaseName AppManagementDB -ApplicationPool MyServiceAppPool -PS C:\>New-SPAppManagementServiceApplicationProxy -Name AppManagementProxy -UseDefaultProxyGroup -ServiceApplication $sa -``` - -This example creates a new App Management Service application proxy named AppManagementProxy for the specified service application and adds the new App Management Service application proxy to the default proxy group. - -## PARAMETERS - -### -ServiceApplication -Specifies the App Management Service application for which you are creating the service application proxy. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: ServiceApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Uri -Specifies the endpoint URI of the App Management Service application in which to create the service application proxy. - -```yaml -Type: String -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the service application proxy to be created. -If a value is not provided, a default name is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultProxyGroup -Specifies whether to add the newly created service application proxy to the default proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPAppManagementServiceApplication](New-SPAppManagementServiceApplication.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAuthenticationProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAuthenticationProvider.md deleted file mode 100644 index 0f1145faa5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAuthenticationProvider.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAuthenticationProvider -schema: 2.0.0 ---- - -# New-SPAuthenticationProvider - -## SYNOPSIS - -Creates a new authentication provider in the farm. - - - -## SYNTAX - -### Forms -``` -New-SPAuthenticationProvider -ASPNETMembershipProvider <String> -ASPNETRoleProviderName <String> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### Trusted -``` -New-SPAuthenticationProvider -TrustedIdentityTokenIssuer <SPTrustedIdentityTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### Windows -``` -New-SPAuthenticationProvider [-AllowAnonymous] [-AssignmentCollection <SPAssignmentCollection>] - [-DisableKerberos] [-UseBasicAuthentication] [-UseWindowsIntegratedAuthentication] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The New-SPAuthenticationProvider cmdlet creates a new authentication provider in the farm. - ---NTLM, Classic NTLM, Negotiate, and Classic Negotiate can be set only in a web application. ---For ASP.NET Membership Provider or Role providers, no objects are persisted. The object is created and used for setting this type of Authentication provider in a web application. ---For STS Authentication providers, an object is created and persisted in the SPFarm object. - -You cannot use classic NTLM with any claims-based authentication type. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------------------EXAMPLE1------------------ -``` -PS C:\>$ap = New-SPAuthenticationProvider -UseWindowsIntegratedAuthentication -PS C:\>Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http://<servername> -Port 80 -AuthenticationProvider $ap -``` - -This example creates a Windows claims authentication provider. - -### ---------------------------EXAMPLE2------------------ -``` -PS C:\>$ap = New-SPAuthenticationProvider -ASPNETMembershipProvider "membership" -ASPNETRoleProviderName "rolemanager" -PS C:\>Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http://<servername> -Port 80 -AuthenticationProvider $ap -``` - -This example creates an authentication provider that is based on the ASP.NET membership role provider. - -### ---------------------------EXAMPLE3------------------ -``` -PS C:\>$ap = New-SPAuthenticationProvider -TrustedIdentityTokenIssuer | Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" -PS C:\>Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http://<servername> -Port 80 -AuthenticationProvider $ap -``` - -This example creates a trusted token issuer authentication provider. - -## PARAMETERS - -### -ASPNETMembershipProvider -Specifies the name of the membership provider. - -The value must be a valid name of an ASP.NET membership provider; for example, myMembershipProvider. - -```yaml -Type: String -Parameter Sets: Forms -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ASPNETRoleProviderName -Specifies the name of the role provider. - -The value must be a valid name of an ASP.NET role provider; for example, myRoleProvider. - -```yaml -Type: String -Parameter Sets: Forms -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedIdentityTokenIssuer -Specifies the identity of the authentication provider. - -The value must be in one of the following forms: - ---A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ---A valid name of a TrustedIdentityTokenIssuer (for example, myRoleProvider) ---An instance of a valid SPTrustedIdentityTokenIssuer object - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: Trusted -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymous -Specifies whether the web application allows anonymous access. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DisableKerberos -Specifies whether the web application disables Kerberos authentication. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseBasicAuthentication -Specifies whether the web application uses Basic authentication. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseWindowsIntegratedAuthentication -Specifies whether the web application uses Integrated Windows authentication. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAzureAccessControlServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPAzureAccessControlServiceApplicationProxy.md deleted file mode 100644 index e0981f1dd3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPAzureAccessControlServiceApplicationProxy.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPAzureAccessControlServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPAzureAccessControlServiceApplicationProxy - -## SYNOPSIS - -Creates a new service application proxy group. - - - -## SYNTAX - -``` -New-SPAzureAccessControlServiceApplicationProxy -MetadataServiceEndpointUri <String> -Name <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-SPAzureAccessContrlServiceApplicationProxy cmdlet to create a new service application proxy group for the Azure Control service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE-------------- -``` -PS C:\>New-SPAzureAccessControlServiceApplicationProxy -Name "ACS" -metadataEndpointUri "http://test/" -DefaultProxyGroup -``` - -This example creates a proxy group named ACS which will be added to the default proxy group. - -## PARAMETERS - -### -MetadataServiceEndpointUri -Specifies the URL of the Azure Access Control Service's metadata document. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the proxy that you want to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies whether the proxy needs to be added to the default proxy group. - -We recommend that you add the proxy to the default proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPBECWebServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPBECWebServiceApplicationProxy.md deleted file mode 100644 index 964383a741..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPBECWebServiceApplicationProxy.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPBECWebServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPBECWebServiceApplicationProxy - -## SYNOPSIS -Do not use. - -## SYNTAX - -``` -New-SPBECWebServiceApplicationProxy [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultProxyGroup] -Name <String> -ServiceEndpointUri <String> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------ Example 1 -------------------- -``` -PS C:\> -``` - -## PARAMETERS - -### -AssignmentCollection -Do not use. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpointUri -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPBusinessDataCatalogServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPBusinessDataCatalogServiceApplication.md deleted file mode 100644 index d00b6f9e12..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPBusinessDataCatalogServiceApplication.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPBusinessDataCatalogServiceApplication -schema: 2.0.0 ---- - -# New-SPBusinessDataCatalogServiceApplication - -## SYNOPSIS - -Creates a new Business Data Connectivity service application in the farm. - - - -## SYNTAX - -``` -New-SPBusinessDataCatalogServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-DatabaseName <String>] [-DatabaseServer <String>] [-Name <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabasePassword <SecureString>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] - [-PartitionMode] [-Sharing] [-WhatIf] [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPBusinessDataCatalogServiceApplication cmdlet creates a new Business Data Connectivity service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp" -``` - -This example creates a Business Data Connectivity service application named ContosoServiceApp. -In this process it uses the SharePoint Web Services Default application pool and creates a database named ContosoBdcDB. - -## PARAMETERS - -### -ApplicationPool -Specifies the IIS application pool to use for the new Business Data Connectivity service application. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name for the Business Data Connectivity database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid SQL Server host name; for example, SERVER\Database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a display name for the new Business Data Connectivity service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user specified in DatabaseUserName. -Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. - -The type must be a valid password. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user name to use for connecting to the database. -Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host server for the failover database server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restricts data by subscription ID. -This property cannot be changed after the service application is created. - -This property has no effect on SharePoint Server 2019. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sharing -Specifies that the Business Data Connectivity application is published and shared across the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPBusinessDataCatalogServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPBusinessDataCatalogServiceApplicationProxy.md deleted file mode 100644 index 6e069603f7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPBusinessDataCatalogServiceApplicationProxy.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPBusinessDataCatalogServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPBusinessDataCatalogServiceApplicationProxy - -## SYNOPSIS - -Creates a new Business Data Connectivity service application proxy in the farm. - -## SYNTAX - -### PipeBind -``` -New-SPBusinessDataCatalogServiceApplicationProxy [-Name <String>] - -ServiceApplication <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultProxyGroup] [-WhatIf] [<CommonParameters>] -``` - -### Uri -``` -New-SPBusinessDataCatalogServiceApplicationProxy [-Name <String>] -Uri <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-WhatIf] [-PartitionMode] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The New-SPBusinessDataCatalogServiceApplicationProxy cmdlet creates a new Business Data Connectivity service application proxy for a Business Data Connectivity service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$sa = New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp" -PS C:\>New-SPBusinessDataCatalogServiceApplicationProxy -Name "ContosoServiceAppProxy" -ServiceApplication $sa -``` - -This example creates a new Business Data Connectivity service application proxy with the name ContosoServiceAppProxy for the given service application. - -## PARAMETERS - -### -Name -Specifies a display name for the new Business Data Connectivity service application proxy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the Business Data Connectivity service application associated with the new proxy. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: PipeBind -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI of a remote service application to which to connect. - -The type must be a valid URI, in the form file:\\\\server_name\sitedocs. - -```yaml -Type: Uri -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the service application proxy is added to the default proxy group for the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies if partition mode is to be turned on. - -The valid values are True and False. The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPCentralAdministration.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPCentralAdministration.md deleted file mode 100644 index c689851e88..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPCentralAdministration.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPCentralAdministration -schema: 2.0.0 ---- - -# New-SPCentralAdministration - -## SYNOPSIS - -Creates a new SharePoint Central Administration Web application. - - - -## SYNTAX - -``` -New-SPCentralAdministration [[-Port] <Int32>] [[-WindowsAuthProvider] <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-SecureSocketsLayer] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPCentralAdministration cmdlet creates a new Central Administration Web application and starts the central administration service on the local computer. -Central Administration is available only on computers where this service runs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>New-SPCentralAdministration -WindowsAuthProvider NTLM -Port 8080 -``` - -This example creates the Central Administration site at port 8080 on the local farm using NTLM authentication. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>New-SPCentralAdministration -WindowsAuthProvider Kerberos -Port 443 -SecureSocketsLayer -``` - -This example creates the Central Administration site using SSL on port 443 with Kerberos authentication. - - -## PARAMETERS - -### -Port -Specifies the port number for Central Administration. -If no port is specified, a nonconflicting port number is auto-generated. - -The type must be a valid port number. - -If you specify a port number that has already been assigned, IIS does not start the new site until you change either the port number of the new site or the port number of the old site. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WindowsAuthProvider -Specifies the authorization provider for this Web application. -If no authentication provider is specified, the default value NTLM is used. - -The type must be one of two values: Kerberos or NTLM. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SecureSocketsLayer -Enables Secure Socket Layer (SSL) encryption for the specified port. If you choose to use SSL, you must assign a server certificate to the Central Administration IIS web site by using the IIS administration tools. The Central Administration web application won't be accessible until you do this. - -The default value is False. - -If this parameter is omitted or set to False the Central Administration site will use HTTP for the specified port. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimProvider.md deleted file mode 100644 index a6ca7e90a5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimProvider.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPClaimProvider -schema: 2.0.0 ---- - -# New-SPClaimProvider - -## SYNOPSIS - -Registers a new claim provider in the farm. - - - -## SYNTAX - -``` -New-SPClaimProvider -AssemblyName <String> -Description <String> -DisplayName <String> -Type <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Default] [-Enabled] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPClaimProvider cmdlet registers a new claim provider in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>New-SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -AllWebApplications -``` - -This example registers a claim provider in the farm. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>New-SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -Scope (Get-SPWebApplication http://test) -``` - -This example registers a claim provider scoped to a given Web application. - -## PARAMETERS - -### -AssemblyName -The type must be a valid name of an assembly; for example, ClaimAssembly1. - -Specifies the name of the assembly with the claim provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the claim provider. - -The type must be a valid name of an assembly; for example, ClaimAssembly1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the new claim provider. - -The type must be a valid name of a claim provider; for example, ClaimProvider1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the claim. - -The type must be a valid name of a claim type; for example MyClaimProvider.Providers.CustomProvider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Default -Specifies that the claim provider applies to all Web applications and zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Turns on the claim provider. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimTypeEncoding.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimTypeEncoding.md deleted file mode 100644 index 510195966b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimTypeEncoding.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPClaimTypeEncoding -schema: 2.0.0 ---- - -# New-SPClaimTypeEncoding - -## SYNOPSIS - -Registers a new type of claim. - - - -## SYNTAX - -``` -New-SPClaimTypeEncoding -ClaimType <String> -EncodingCharacter <Char> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the New-SPClaimTypeEncoding cmdlet to register the following: - ---A new type of claim - ---The Unicode character to which it should be encoded when the SPClaim.ToEncodedString method is invoked - ---The SPClaim.ClaimType property is set to a valid valu -e - -For more information about the SPClaim methods and properties, see M:Microsoft.SharePoint.Administration.Claims.SPClaim.ToEncodedString and P:Microsoft.SharePoint.Administration.Claims.SPClaim.ClaimType respectively. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------EXAMPLE------- -``` -PS C:\>New-SPClaimTypeEncoding -EncodingCharacter '1' -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" -``` - -This example registers a new type of claim. - -## PARAMETERS - -### -ClaimType -Specifies the type of claim for which you want to create a mapping. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncodingCharacter -Specifies the Unicode character to which you want to create a mapping. - -```yaml -Type: Char -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses confirmation messages to any claim type that is added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPClaimTypeEncoding](Get-SPClaimTypeEncoding.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimTypeMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimTypeMapping.md deleted file mode 100644 index 874eb6fcbe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimTypeMapping.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPClaimTypeMapping -schema: 2.0.0 ---- - -# New-SPClaimTypeMapping - -## SYNOPSIS - -Creates a claim mapping rule for a security token service (STS) identity provider. - -## SYNTAX - -``` -New-SPClaimTypeMapping [-IncomingClaimType] <String> [-IncomingClaimTypeDisplayName] <String> - [[-LocalClaimType] <String>] [-AssignmentCollection <SPAssignmentCollection>] [-SameAsIncoming] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPClaimTypeMapping cmdlet creates a claim mapping rule for a security token service (STS) identity provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE 1---------------------------- -``` -PS C:\>$map1 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" -IncomingClaimTypeDisplayName "EmailAddress" -SameAsIncoming -PS C:\>$map2 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" -PS C:\>New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" -Description "LiveID Provider" -Realm "urn:domain.company.com" -ImportTrustCertificate $cert -ClaimsMappings $map1[,$map2..] -SignInUrl "https://login.live.com/login.srf" -IdentifierClaim $map2.InputClaimType -``` - -This example creates a claim map from an incoming token to a SharePoint token. - -## PARAMETERS - -### -IncomingClaimType -Specifies the URI of the incoming claim type. - -The type must be a valid URI, in the form http://schemas.microsoft.com/email. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncomingClaimTypeDisplayName -Specifies the display name of the incoming claim type. - -The type must be a valid name of an incoming claim type; for example, Email. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalClaimType -Specifies the URI of the local claim type. -If the SameAsIncoming parameter is False, this is a required parameter. - -The type must be a valid URI, in the form http://schemas.microsoft.com/email. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SameAsIncoming -Specifies that the claim type specified in the IncomingClaimType parameter is used for the LocalClaimType parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimsPrincipal.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimsPrincipal.md deleted file mode 100644 index d729bff780..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPClaimsPrincipal.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPClaimsPrincipal -schema: 2.0.0 ---- - -# New-SPClaimsPrincipal - -## SYNOPSIS - -Creates a claims principal. - - - -## SYNTAX - -### STSIdentity -``` -New-SPClaimsPrincipal [-ClaimValue] <String> [[-ClaimType] <String>] - [-TrustedIdentityTokenIssuer] <SPTrustedIdentityTokenIssuerPipeBind> [-IdentifierClaim] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### ClaimProvider -``` -New-SPClaimsPrincipal [-ClaimValue] <String> [-ClaimType] <String> - [-AssignmentCollection <SPAssignmentCollection>] -ClaimProvider <SPClaimProvider> [<CommonParameters>] -``` - -### BasicClaim -``` -New-SPClaimsPrincipal [-EncodedClaim] <String> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### IdentityType -``` -New-SPClaimsPrincipal [-Identity] <String> [-IdentityType] <SPIdentifierTypes> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### TrustIdentity -``` -New-SPClaimsPrincipal [-Identity] <String> [-TrustedIdentityTokenIssuer] <SPTrustedIdentityTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The New-SPClaimsPrincipal cmdlet creates a claims principal. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------------EXAMPLE 1----------------------------- -``` -PS C:\>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal contoso\johndoe -TrustedIdentityTokenIssuer "NTLM") -``` - -This example creates a claim principal for a Windows user. - -### -------------------------EXAMPLE 2----------------------------- -``` -PS C:\>New-SPSite http://localhost/sites/newsite -owner (New-SPClaimsPrincipal contoso\allusers -TrustedIdentityTokenIssuer "NTLM") -``` - -This example creates a claim principal for a Windows group. - -### -------------------------EXAMPLE 3----------------------------- -``` -PS C:\>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal -ClaimValue "john@contoso.com" -ClaimType Email -TrustedIdentityTokenIssuer "LiveID STS" -IdentifierClaim Yes) -``` - -This example creates a claim principal for a trusted identity token issuer claim. - -### -------------------------EXAMPLE 4----------------------------- -``` -PS C:\>$ip = New-SPIdentityProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider" -PS C:\>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@contoso.com" -TrustedIdentityTokenIssuer $ip) -``` - -This example creates a claim principal for a ASPNet Membership User. - -### -------------------------EXAMPLE 5----------------------------- -``` -PS C:\>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal "Sales Manager Role" -IdentityProvider "myRoleProvider") -``` - -This example creates a claim principal for a ASPNet Role. - -### -------------------------EXAMPLE 6----------------------------- -``` -PS C:\>$cp = New-SPClaimsPrincipal -Identity "redmond\SiteOwner" -IdentityType 1 -PS C:\>New-SPSite http://servername:port -OwnerAlias $cp.ToEncodedString() -Template "STS#0" -``` - -This example creates a claim principal for a Basic Claim Role, which is also called an encoded claim). - -## PARAMETERS - -### -ClaimValue -Specifies the claim value of the claims object. -The claims value specifies the user, group, or computer that the claim is authenticating. - -The type must be a valid claim value; for example, john@contoso.com. - -```yaml -Type: String -Parameter Sets: STSIdentity, ClaimProvider -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -EncodedClaim -Converts a simple claim to a full encoded claim. - -The type must be a valid claim value; for example, i:001w|redmond\user. - -```yaml -Type: String -Parameter Sets: BasicClaim -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of the new claims principal. - -The type must be a valid name of a claims principal. - -```yaml -Type: String -Parameter Sets: IdentityType, TrustIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClaimType -Specifies the type of claim to create. -The value I indicates a unique user identity claim, and the value C indicates all other claims. - -The type must be either of the following values: I or C. - -```yaml -Type: String -Parameter Sets: STSIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClaimProvider -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedIdentityTokenIssuer -Specifies the ID of the authentication provider. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an Authentication provider (for example, MyAuthprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: STSIdentity, TrustIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Specifies the type of the new claims principal. - -The type must be one of the following: WindowsSamAccountName, WindowsSecurityGroupSid, FormsUser, FormsRole, or EncodedClaim. - -```yaml -Type: SPIdentifierTypes -Parameter Sets: IdentityType -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierClaim -Specifies if the new claim is an identity claim. - -```yaml -Type: SwitchParameter -Parameter Sets: STSIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClaimProvider -Specifies the security token service identity provider that will contain the claims principal. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object. - -```yaml -Type: SPClaimProvider -Parameter Sets: ClaimProvider -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPConfigurationDatabase.md deleted file mode 100644 index 40e3a30ed6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPConfigurationDatabase.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPConfigurationDatabase -schema: 2.0.0 ---- - -# New-SPConfigurationDatabase - -## SYNOPSIS - -Creates a new configuration database. - - - -## SYNTAX - -``` -New-SPConfigurationDatabase [-DatabaseName] <String> [-DatabaseServer] <String> [[-DirectoryDomain] <String>] - [[-DirectoryOrganizationUnit] <String>] [[-AdministrationContentDatabaseName] <String>] - [[-DatabaseCredentials] <PSCredential>] [-FarmCredentials] <PSCredential> [-Passphrase] <SecureString> - [-SkipRegisterAsDistributedCacheHost] [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseFailOverServer <String>] [-LocalServerRole <SPServerRole>] [-ServerRoleOptional] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPConfigurationDatabase cmdlet creates a new configuration database on the specified database server. -This is the central database for a new SharePoint farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -``` - -This example prompts the user to provide user credentials for the default Farm Administrator account. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -SkipRegisterAsDistributedCacheHost -``` - -This example prompts the user to provide user credentials for the default Farm Administrator account and skips registering the server as Distributed Cache host. Applies to SharePoint Server 2013 and SharePoint Server 2016, SharePoint Server 2019 only. - -### ------------------EXAMPLE 3----------------------- -``` -PS C:\>New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -LocalServerRole Custom -``` - -This example prompts the user to provide user credentials for the default Farm Administrator account and sets the Server Role to Custom. Applies to SharePoint Server 2016, SharePoint Server 2019 only. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the new configuration database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the database server on which to create the configuration database. -If no value is specified, the default value is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DirectoryDomain -Specifies the directory domain for the new farm. -If no domain is specified, the domain in which the local computer is located is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DirectoryOrganizationUnit -Specifies the directory organizational unit for the new configuration database. -If no organizational unit is specified, the organizational unit in which the local computer is located is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdministrationContentDatabaseName -Specifies the name for the Central Administration content database for the new farm. -If no name is specified, a default name is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the Credential object for the database user. -Use this parameter if you use SQL Server Authentication. -If no database credentials are provided, Windows authentication is used. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -FarmCredentials -Specifies credentials for the Farm Administrator account. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Passphrase -Specifies the secure password phrase for the new farm. -This passphrase is used to join other machines to this farm. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SkipRegisterAsDistributedCacheHost -By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default). - -Use this parameter to not register the server computer as a distributed cache host. -If you want to have a dedicated cache host, then use this parameter to make sure that caching service is not installed on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseFailOverServer -Specifies the SQL Server Database Mirror partner server for the Configuration and Central Administration database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LocalServerRole -Specifies the Server Role. Valid options for all versions of SharePoint Server 2016, SharePoint Server 2019 are: -`Custom`, `SingleServerFarm`, `Application`, `WebFrontEnd`, `DistributedCache`, `Search` - -With the addition of Feature Pack 1, new options include: -`ApplicationWithSearch`, `WebFrontEndWithDistributedCache ` - -```yaml -Type: SPServerRole -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerRoleOptional -Configures the farm to not require a server role to be specified. If no server role is specified, the server defaults to the Custom role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteMapDatabaseName -Do not use. Specifies the database name of the Site Map site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteMapDatabaseServer -Do not use. Specifies the database server name of the Site Map site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDatabase.md deleted file mode 100644 index d625c82a39..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDatabase.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPContentDatabase -schema: 2.0.0 ---- - -# New-SPContentDatabase - -## SYNOPSIS - -Creates a new content database and attaches it to the specified Web application. - - - -## SYNTAX - -``` -New-SPContentDatabase [-Name] <String> [-WebApplication] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-AssignNewDatabaseId] [-Confirm] [-ClearChangeLog] - [-DatabaseCredentials <PSCredential>] [-DatabaseServer <String>] [-MaxSiteCount <Int32>] - [-WarningSiteCount <Int32>] [-WhatIf] [-ChangeSyncKnowledge] [-DatabaseAccessCredentials <PSCredential>] - [-UseLatestSchema] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPContentDatabase cmdlet creates a new content database and attaches it to the specified Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE-------------------- -``` -PS C:\>New-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication http://sitename -``` - -This example creates a new content database for the sitename Web application. - -## PARAMETERS - -### -Name -Specifies the new content database to create within the farm. - -The type must be a valid name of a SharePoint content database; for example, SPContentDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Attaches the content database to the specified SharePoint Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignNewDatabaseId -Creates a new database ID automatically when the content database is attached. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClearChangeLog -Clears any pending changes from the change log in the content database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the content database specified in the Name parameter. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSiteCount -Specifies the maximum number of Web sites that can use the content database. - -The type must be a positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarningSiteCount -Specifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified. - -The type must be a positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChangeSyncKnowledge -Specifies Groove sync client to resync their content when a Content Database attach is used. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseAccessCredentials -Specifies the credential for the SPDataAccess role. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLatestSchema -Specifies to use the latest schema. In an on-premises environment, this parameter will have no effect at all. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDeploymentJob.md deleted file mode 100644 index 622217687e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDeploymentJob.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPContentDeploymentJob -schema: 2.0.0 ---- - -# New-SPContentDeploymentJob - -## SYNOPSIS -Creates a content deployment job. - -## SYNTAX - -``` -New-SPContentDeploymentJob -Name <String> -SPContentDeploymentPath <SPContentDeploymentPathPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] - [-EmailAddresses <String[]>] [-EmailNotifications <ContentDeploymentNotificationSettings>] - [-HostingSupportEnabled] [-IncrementalEnabled] [-Schedule <String>] [-ScheduleEnabled] - [-Scope <SPWebPipeBind[]>] [-SqlSnapshotSetting <ContentDeploymentSqlSnapshotSetting>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPContentDeploymentJob cmdlet adds a new content deployment job to a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPContentDeploymentPath "Path 1" | New-SPContentDeploymentJob -Name "Deployment Job" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false -``` - -This example creates a new content deployment job called Deployment Job by using the deployment path Path 1. -The job is configured to be an incremental job with no schedule. - -## PARAMETERS - -### -Name -Specifies the name of the new content deployment job. - -The type must be a valid name of a content deployment job; for example, DeployJob1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SPContentDeploymentPath -Specifies the deployment path to associate with the new deployment job. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployJob1); or an instance of a valid SPContentDeploymentJob object. - -```yaml -Type: SPContentDeploymentPathPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the content deployment job. -The name can be a maximum of 4096 alphanumeric characters. - -The type must be a valid string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object. - -The type must be a list of valid e-mail addresses. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailNotifications -Specifies how e-mail notifications are sent about this ContentDeploymentJob object. - -The type must be one of the following: - --Never specifies that e-mail notifications will not be sent when a job succeeds or fails. - -- SendEmailOnSuccess specifies that e-mail notifications will be sent if a content deployment job succeeds. -- SendEmailOnFailure specifies that e-mail notifications will be sent if a content deployment job fails. -- SendEmailOnAlways specifies that e-mail notifications will be sent when a job succeeds or fails. - -```yaml -Type: ContentDeploymentNotificationSettings -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostingSupportEnabled -Enables special hosting- behavior. -The default value is False. - -Normally, a content deployment job is enabled or disabled by using the SharePoint Central Administration Web site. -However, in the case of hosting, the tenant administrator does not have permissions to access the Central Administration page to configure jobs. -Therefore, when the HostingSupportEnabled parameter is set to True, the hoster creates the job, so that tenants can enable or disable their deployment jobs from their tenant administration site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncrementalEnabled -Specifies that only incremental changes are deployed to the destination site collection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Sets the schedule for the deployment job. - -The type must be a valid SPSchedule object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleEnabled -Specifies to enable the schedule for the deployment job. -If the schedule is not enabled the job can be run only manually. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Sets the scope of the deployment job. -SPSites passed in must exist in the current path of the source site collection. -The default scope is the entire site collection. -Valid values include an SPWeb object or an array of SPWeb objects. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Foundation Web site (for example, MySPSite1); or an instance of a valid SPWeb object. - -```yaml -Type: SPWebPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlSnapshotSetting -Creates a database snapshot of the source SharePoint Foundation content database to use for the export process. - -The type must be one of the following values: - -- None -- CreateNew - -The CreateNew value requires thatSQL Server Enterprise Edition be installed. - -```yaml -Type: ContentDeploymentSqlSnapshotSetting -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDeploymentPath.md deleted file mode 100644 index c5d2eb19a2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPContentDeploymentPath.md +++ /dev/null @@ -1,385 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPContentDeploymentPath -schema: 2.0.0 ---- - -# New-SPContentDeploymentPath - -## SYNOPSIS -Creates a new content deployment path. - -## SYNTAX - -``` -New-SPContentDeploymentPath -DestinationCentralAdministrationURL <Uri> -DestinationSPSite <String> - -DestinationSPWebApplication <Uri> -Name <String> -PathAccount <PSCredential> -SourceSPSite <SPSitePipeBind> - -SourceSPWebApplication <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Authentication <PathAuthenticationOption>] [-CompressionEnabled] [-Confirm] - [-DeploySecurityInformation <SPIncludeSecurity>] [-DeployUserNamesEnabled] [-Description <String>] - [-EventReceiversEnabled] [-KeepTemporaryFilesOptions <TemporaryFilesOption>] [-PathEnabled] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPContentDeploymentPath cmdlet adds a new content deployment path for a content deployment job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE---------------------- -``` -C:\PS>$source = Get-SPSite "http://source/" - -C:\PS>$credentials=Get-Credential - -PS C:\>New-SPContentDeploymentPath -Name "Deployment Path" -SourceSPWebApplication $source.WebApplication -SourceSPSite $source DestinationCentralAdministrationURL "http://destination:8080/" -DestinationSPWebApplication "http://destination/" -DestinationSPSite "http://destination/" -KeepTemporaryFilesOptions "Failure" -PathAccount $credentials -PathEnabled:$true -``` - -This example creates a new deployment path called Deployment Path that connects a source at http://source to a destination at http://destination. -The path is enabled and configured to keep temporary files on job failure. - -## PARAMETERS - -### -DestinationCentralAdministrationURL -Specifies the SharePoint Central Administration URL for the destination farm. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationSPSite -Specifies the destination site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationSPWebApplication -Specifies the destination Web application. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new content deployment path. - -The type must be a valid name of a content deployment path; for example, DeployPath1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathAccount -Specifies the user ID that is an administrator on the Central Administration page on the destination farm. - -The type must be a valid SharePoint user. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSPSite -Specifies the source site collection for the deployment path. -Must be a site collection in the source specified in the SourceSPWebApplication parameter. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSPWebApplication -Specifies the source Web application for the deployment path. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Authentication -Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application. - -The type must be one of the following values: WindowsAuth or BasicAuth. - -```yaml -Type: PathAuthenticationOption -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompressionEnabled -Turns on compression during the export. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploySecurityInformation -Specifies the user and group information to include during the export operation for this content deployment path. -The default value is All. - -The type must be one of the following values: None, All, or WssOnly- Applies only SharePoint Foundation security settings. -Includes user memberships and role assignments such as default roles, for example, Web Designer or any custom roles that extend from the default roles. -The access control list (ACL) for each object is migrated. -No user information defined in the DAP or LDAP servers is included. - -```yaml -Type: SPIncludeSecurity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeployUserNamesEnabled -Specifies whether to include user names during a deployment. - -Valid values are one of the following: - -- $True Retains the original author and editor information, time and date stamp, and user lookup value. -- $False Retains the original date and time stamp, but replaces the author and editor data with the System Account, and replaces the user lookup value with an empty string (""). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Sets the description for the content deployment path. -The description can contain a maximum of 4096 alphanumeric characters. - -The type must be a valid string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventReceiversEnabled -Turns on event receivers during import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepTemporaryFilesOptions -Specifies that temporary files are kept after content deployment is finished. - -The type must be one of the following values: Never, Always, or OnFailure. - -```yaml -Type: TemporaryFilesOption -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathEnabled -Enables the new content deployment path. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEduClass.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEduClass.md deleted file mode 100644 index 42a0402bec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEduClass.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: New-SPEduClass -schema: 2.0.0 ---- - -# New-SPEduClass - -## SYNOPSIS -Do not use - -## SYNTAX - -``` -New-SPEduClass [-AssignmentCollection <SPAssignmentCollection>] [-Building <String>] -ClassId <String> - -ClassName <String> [-DayOfWeek <String>] [-EndDate <DateTime>] [-EndTime <String>] [-Room <String>] - -Site <SPSitePipeBind> [-StartDate <DateTime>] [-StartTime <String>] [-Year <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - -## EXAMPLES - -### Example 1 -``` -Do not use -``` - - - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Building -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ClassId -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ClassName -{Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DayOfWeek -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -EndDate -Do not use - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -EndTime -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Room -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Site -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartDate -Do not use - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Year -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.SharePoint.PowerShell.SPSitePipeBind -System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchAdminComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchAdminComponent.md deleted file mode 100644 index f2a7340022..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchAdminComponent.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchAdminComponent -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchAdminComponent - -## SYNOPSIS -Creates a new admin component for the given topology and search service instance. - -## SYNTAX - -``` -New-SPEnterpriseSearchAdminComponent -SearchServiceInstance <SearchServiceInstancePipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new search admin component and adds it to an inactive search topology in a specific search service instance. -The change is effectuated when the search topology is enabled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchAdminComponent -SearchTopology $topology -SearchServiceInstance $si -SearchApplication $ssa -``` - -This example adds a new Search Administration Component to the inactive topology for the existing Search Service Application. - -## PARAMETERS - -### -SearchServiceInstance - -Specifies the search service instance that will host the new admin component. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology where the new admin component should be added. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchAnalyticsProcessingComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchAnalyticsProcessingComponent.md deleted file mode 100644 index ddb4122b7f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchAnalyticsProcessingComponent.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchAnalyticsProcessingComponent -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchAnalyticsProcessingComponent - -## SYNOPSIS -Creates a new analytics processing component for the given topology and search service instance. - -## SYNTAX - -``` -New-SPEnterpriseSearchAnalyticsProcessingComponent -SearchServiceInstance <SearchServiceInstancePipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new analytics processing component and adds it to an inactive search topology in a specific search service instance. -The change is effectuated when the search topology is enabled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchAnalyticsProcessingComponent -SearchTopology $topology -SearchServiceInstance $si -SearchApplication $ssa -``` - -This example adds a new Search Analytics Processing Component to the inactive topology for the existing Search Service Application. - -## PARAMETERS - -### -SearchServiceInstance - -Specifies the search service instance that will host the new analytics processing component. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology where the new analytics processing component should be added. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchContentEnrichmentConfiguration.md deleted file mode 100644 index 999a4e584c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchContentEnrichmentConfiguration -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchContentEnrichmentConfiguration - -## SYNOPSIS -Creates a new ContentEnrichmentConfiguration object. - -## SYNTAX - -``` -New-SPEnterpriseSearchContentEnrichmentConfiguration [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new ContentEnrichmentConfiguration object that the user can change. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$config = New-SPEnterpriseSearchContentEnrichmentConfiguration -``` - -This example creates a new ContentEnrichmentConfiguration object. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchContentEnrichmentConfiguration](Get-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[Set-SPEnterpriseSearchContentEnrichmentConfiguration](Set-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[Remove-SPEnterpriseSearchContentEnrichmentConfiguration](Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchContentProcessingComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchContentProcessingComponent.md deleted file mode 100644 index e4687a1ba5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchContentProcessingComponent.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchContentProcessingComponent -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchContentProcessingComponent - -## SYNOPSIS -Creates a new content processing component for the given topology and search service instance. - -## SYNTAX - -``` -New-SPEnterpriseSearchContentProcessingComponent -SearchServiceInstance <SearchServiceInstancePipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new content processing component and adds it to an inactive search topology in a specific search service instance. -The change is effectuated when the search topology is enabled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchContentProcessingComponent -SearchTopology $topology -SearchServiceInstance $si -SearchApplication $ssa -``` - -This example adds a new Search Content Processing Component to the inactive topology for the existing Search Service Application. - -## PARAMETERS - -### -SearchServiceInstance - -Specifies the search service instance that will host the new content processing component. - - - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology where the new content processing component should be added. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlComponent.md deleted file mode 100644 index ea231d19fd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlComponent.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlComponent -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlComponent - -## SYNOPSIS -Creates a new crawl component for the given topology and search service instance. - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlComponent -SearchServiceInstance <SearchServiceInstancePipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new crawl component and adds it to an inactive search topology in a specific search service instance. -The change is effectuated when the search topology is enabled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchCrawlComponent -SearchTopology $topology -SearchServiceInstance $si -SearchApplication $ssa -``` - -This example adds a new Search Crawl Component to the inactive topology for the existing Search Service Application. - -## PARAMETERS - -### -SearchServiceInstance - -Specifies the search service instance that will host the new crawl component. - - - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology where the new crawl component should be added. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlContentSource.md deleted file mode 100644 index 5a06c650ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlContentSource.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlContentSource -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlContentSource - -## SYNOPSIS -Creates a content source for a Search service application. - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlContentSource [-AssignmentCollection <SPAssignmentCollection>] - [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm] - [-CrawlPriority <CrawlPriority>] [-CustomProtocol <String>] [-LOBSystemSet <String[]>] - [-MaxPageEnumerationDepth <Int32>] [-MaxSiteEnumerationDepth <Int32>] -Name <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-SharePointCrawlBehavior <SharePointCrawlBehavior>] - [-StartAddresses <String>] [-Tag <String>] -Type <ContentSourceType> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPEnterpriseSearchCrawlContentSource cmdlet creates a new content source. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchCrawlContentSource -SearchApplication $ssa -Type File -name FileServer -StartAddresses file://someserver/public -``` - -This example creates a new content source of type file to crawl a file system. - -## PARAMETERS - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BDCApplicationProxyGroup - -Specifies the proxy to use for a business type content source. -This proxy group must contain a default Business Data Connectivity Metadata Store proxy. - - - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlPriority - -Specifies the priority of this content source. - -The value must be one of the following integers: 1= Normal, 2=High. - - - -```yaml -Type: CrawlPriority -Parameter Sets: (All) -Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomProtocol - -Specifies the custom protocol, handled by the custom connector, to use for this content source. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOBSystemSet - -Specifies a comma-separated list of Business Data Connectivity metadata store system names and system instance names for a business type content source. - - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPageEnumerationDepth - -Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. - - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSiteEnumerationDepth - -Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. - - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the content source to create. - -The type must be a valid name of a ContentSource object (for example, ContentSource1). - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication - -Specifies the search application that contains the content source. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Search service application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SharePointCrawlBehavior - -Specifies crawl behavior for a sharepoint type content source. -The behavior can be either: - -CrawlSites to crawl only particular site collections. - -CrawlVirtualServers to crawl the entire server and all site collections on the server. - - - -```yaml -Type: SharePointCrawlBehavior -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartAddresses - -Specifies the comma-separated list of URLs at which to start a crawl for this content source. - -The type must be a valid URL, in the form http://server_name. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag - -Specifies the URL for the page to modify the settings for a custom content source. -The string that specifies the URL can contain a maximum of 1,024 characters. - -The type must be a valid URL, in the form http://server_name. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type - -Specifies the name of the content source type. -The value Business is for the Business Data Connectivity metadata store. -The value Exchange is for Microsoft Exchange public folders. -The value Custom is for a custom content source type. - -The type must be the valid name of a content source type; for example, custom. - - - -```yaml -Type: ContentSourceType -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlCustomConnector.md deleted file mode 100644 index ac0986fc0c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlCustomConnector.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlCustomConnector -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlCustomConnector - -## SYNOPSIS -Registers a protocol for custom crawling. - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlCustomConnector -ModelFilePath <String> -Protocol <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPEnterpriseSearchCrawlCustomConnector cmdlet registers, for a search system, the protocol that is used to crawl the custom repository. - -If the Name parameter is not provided, in the administration application user interface (UI) the name protocol identifies the protocol specified. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchCrawlCustomConnector -SearchApplication $ssa -ModelFilePath \\models\myFileTypeModel.mft -Protocol "mftml://" -``` - -This example creates a custom connector for a file type whose model is located at \\\\models\myFileTypeModel.mft and has the protocol name mftml://. - -## PARAMETERS - -### -ModelFilePath -Specifies the path to a model file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the string version of the protocol; for example, dctm://. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that is associated with the protocol. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the custom connector that appears on the SharePoint Central Administration Web site. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlDatabase.md deleted file mode 100644 index b6445106f7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlDatabase.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlDatabase -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlDatabase - -## SYNOPSIS -Creates a crawl database which can be added to a search service application. - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlDatabase -DatabaseName <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] - [-FailoverDatabaseServer <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPEnterpriseSearchCrawlDatabase cmdlet is used during initial configuration and farm scale-out to create a new crawl database, which can be added to a search service application. -A crawl database stores crawl history for a search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchCrawlDatabase -SearchApplication $ssa -DatabaseName newCrawlDB -``` - -This example creates a new crawl database named newCrawlDB for the mySearchServiceApp search service application. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database to create for the crawl database. - -The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl database. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the name of the password for the Microsoft SQL Server database server. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the account name specified in the Database Server parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Server that is used for failover when SQL Server mirroring is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlExtension.md deleted file mode 100644 index 391a0648af..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlExtension.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlExtension -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlExtension - -## SYNOPSIS -Adds an extension rule to a Search service application. - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlExtension [[-Name] <String>] -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The New-SPEnterpriseSearchCrawlExtension cmdlet adds a file name extension to the list of file types that you want to include in the index. -After a new IFilter is registered, run this cmdlet so that the new file type will be crawled. -If a file type is added without registering an associated IFilter, only the file properties will be crawled and included in the index. -After you run this cmdlet, you must run a full crawl of all content sources that might contain this file type to guarantee that files of this type are in the index. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchCrawlExtension -Name "pdf" -SearchApplication $ssa -``` - -This example adds the PDF file type to the list of file name extensions to include in the index. - -## PARAMETERS - -### -Name -Specifies the new file name extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the extension collection. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlMapping.md deleted file mode 100644 index e1354f8a81..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlMapping.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlMapping -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlMapping - -## SYNOPSIS -Creates a crawl mapping rule for a shared search application. - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlMapping [-Url] <String> -SearchApplication <SearchServiceApplicationPipeBind> - -Target <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -The New-SPEnterpriseSearchCrawlMapping cmdlet is run when the search functionality is initially configured, and when access is changed through a different mechanism to create the crawl mapping rule; for example, when a rule is changed to use file:\\\\ rather than http://. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchCrawlMapping -SearchApplication $ssa -Url "file://location1" -Target "http://location2/" -``` - -This example will change the query results link from the file share where the item was crawled to the Web site location from which the item can be browsed. - -## PARAMETERS - -### -Url -Specifies the source URI for the crawl mapping. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl mapping collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Target -Specifies the target URI for the crawl mapping to get. - -The type must be a valid URI; for example, file:\\\\ server_name\sitedocs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlRule.md deleted file mode 100644 index 236cd25cf9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchCrawlRule.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchCrawlRule -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchCrawlRule - -## SYNOPSIS -Creates a new crawl rule. - - -## SYNTAX - -``` -New-SPEnterpriseSearchCrawlRule [-AccountName <String>] [-AccountPassword <SecureString>] - [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationType <CrawlRuleAuthenticationType>] - [-Confirm] [-ContentClass <String>] [-CrawlAsHttp <Boolean>] [-FollowComplexUrls <Boolean>] - [-IsAdvancedRegularExpression <Boolean>] -Path <String> [-PluggableSecurityTimmerId <Int32>] - [-Priority <Int32>] -SearchApplication <SearchServiceApplicationPipeBind> [-SuppressIndexing <Boolean>] - -Type <CrawlRuleType> [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -The `New-SPEnterpriseSearchCrawlRule` cmdlet creates special rules for crawling items that are contained in the specified path. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Identity http://ExampleSharePointSite -CrawlAsHttp 1 -Type InclusionRule -``` - -This example creates an inclusion type crawl rule for the site at http://ExampleSharePointSite. -The rule specifies that the site be crawled as an HTTP site. - - -## PARAMETERS - -### -AccountName -Specifies the account to use when applying the crawl rule. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountPassword -Specifies the account to use when applying the crawl rule. - - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies one of the following authentication types to access matching URLs: - -BasicAccountRuleAccess -- Specifies the account name and password that are required for this authentication type. - -CertificateRuleAccess -- Specifies the valid client certificate name that is required for this authentication type. - -NTLMAccountRuleAccess -- Specifies the account name for integrated authentication. - -FormRuleAccess -- Specifies a valid URL for HTTP POST or HTTP GET, public and private parameters, and a list of error pages that are used by this authentication type. - -CookieRuleAccess -- Specifies private parameters and a list of error pages that are used by this authentication type. - -AnonymousAccess-- Specifies that the matching URLs have to be accessed anonymously. - - -```yaml -Type: CrawlRuleAuthenticationType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentClass -Specifies the string that is sent to the protocol handler for any content that matches the crawl rule. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlAsHttp -Specifies whether the crawler should crawl content from a hierarchical content source as HTTP content. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FollowComplexUrls -Specifies whether the index engine should crawl content with URLs that contain a question mark (?). - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAdvancedRegularExpression -Specifies whether the rule has a full regular expression syntax. - -The default value is False. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a unique path to which a crawl rule applies. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PluggableSecurityTimmerId -{{Fill PluggableSecurityTimmerId Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Defines where in the list of crawl rules this crawl rule should be applied. - -The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the Search application that is associated with the crawl rule to be modified. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SuppressIndexing -Specifies whether the crawler should exclude the content of items that this rule applies to from the content index. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of crawl rule. -A value of zero (0) includes the rule, a value of 1 excludes the rule. - - -```yaml -Type: CrawlRuleType -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchFileFormat.md deleted file mode 100644 index 788d8afaf6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchFileFormat.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchFileFormat -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchFileFormat - -## SYNOPSIS -Adds a new file format to the parsing system. - - -## SYNTAX - -``` -New-SPEnterpriseSearchFileFormat [-FormatId] <String> [-FormatName] <String> [-MimeType] <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPEnterpriseSearchFileFormat` cmdlet adds a new file format and a corresponding file name extension to the search parsing system. -This binds the file format to a filter-based format handler in the search parsing system. -Thus, the search parsing system can only parse the new file format if the user has installed a corresponding filter-based format handler, an IFilter, for the new file format. -If the installed IFilter registers more than one file name extension, the user must use the `New-SPEnterpriseSearchFileFormat` cmdlet to add a new file format to the parsing system for each of these file name extensions. -The user must also ensure that the file name extension of the new file format is a member of the file-type inclusion list. -The file-type inclusion list specifies which files that are crawled, based on their file name extensions. -The system will only consider the new file format after a restart of the content processing components. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchFileFormat -SearchApplication $ssa -FormatId foo -FormatName FooApp -MimeType "text/foo" -``` - -This example uses the `New-SPEnterpriseSearchFileFormat` cmdlet to add a new file format FooApp with the belonging file name extension foo to the parsing system in the search service application referenced by $ssa - - -## PARAMETERS - -### -FormatId -Specifies the file name extension of the format to add. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FormatName -Specifies the name of the format to add. - -Usually this is the name of the application handling the format. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MimeType -Specifies the mime type of the format to add. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application for which to add the new file format. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchFileFormat](Get-SPEnterpriseSearchFileFormat.md) - -[Set-SPEnterpriseSearchFileFormatState](Set-SPEnterpriseSearchFileFormatState.md) - -[Remove-SPEnterpriseSearchFileFormat](Remove-SPEnterpriseSearchFileFormat.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchIndexComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchIndexComponent.md deleted file mode 100644 index 003754b323..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchIndexComponent.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchIndexComponent -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchIndexComponent - -## SYNOPSIS -Creates a new index component for the given topology and search service instance. - - -## SYNTAX - -``` -New-SPEnterpriseSearchIndexComponent -SearchServiceInstance <SearchServiceInstancePipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-IndexPartition <UInt32>] [-RootDirectory <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new index component and adds it to an inactive search topology in a specific search service instance. -The change is effectuated when the search topology is enabled. - - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchIndexComponent -SearchTopology $topology -SearchServiceInstance $si -SearchApplication $ssa -IndexPartition 1 -RootDirectory E:\Index -``` - -This example adds a new Search Index Component to the inactive topology for the existing Search Service Application. The directory of the Index Component is set to E:\Index with a Partition number of 1. - - -## PARAMETERS - -### -SearchServiceInstance -Specifies the search service instance that will host the new index component. - - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology where the new index component should be added. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IndexPartition -Specifies the index partition number to assign to the new search index component. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RootDirectory -Specifies the root directory that will hold the index location for the new search index component. -This is needed if you want to isolate the index on dedicated discs in order to avoid I/O contention with other parts of the system, other system sharing the same disks, or because you do not want to risk the index filling up the OS disk (generally C: ) - -If you specify the root directory to be the root of a volume, e.g. -E:, the index will not be cleaned up if you delete the SSA. -You will then have to delete the SSA manually. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchLanguageResourcePhrase.md deleted file mode 100644 index 7dc93935f2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchLanguageResourcePhrase.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchLanguageResourcePhrase -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchLanguageResourcePhrase - -## SYNOPSIS -Adds a language resource phrase to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchLanguageResourcePhrase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -Language <String> [-Mapping <String>] -Name <String> -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-SourceId <Guid>] -Type <LanguageResourceType> - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPEnterpriseSearchLanguageResourcePhrase` cmdlet adds a query keyword phrase to a shared search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language en-us -Type QuerySuggestionBlockList -Name secret -``` - -This example adds a new entry to the QuerySuggestionBlockList for the en-us language. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Adds the phrase for the specified source language. - -The type must be a valid name of a language; for example, en-us or ja-jp. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mapping -Allows a term or phrase to be mapped to another term or phrase. -For example, the nickname "John" could be mapped to "Jonathan". - -This parameter only applies to nicknames and substitutions. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the term to add to the list specified in the Type parameter. - -The type must be a valid name of a language resource phrase (for example, LanguageResourcePhrase1). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. - -The owner must be one of the following valid levels: - -- Search Service Application -- Site Subscription -- Site Collection -- Site - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the language resources. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the new phrase. - -The type must be one of the following valid types of phrases: - -- QuerySuggestionBlockList -- QuerySuggestionAlwaysSuggest -- Nickname -- QuerySuggestionSubstitution - - -```yaml -Type: LanguageResourceType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchLinksDatabase.md deleted file mode 100644 index 9a5a8de7ff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchLinksDatabase.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchLinksDatabase -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchLinksDatabase - -## SYNOPSIS -Creates a new links database for a search service application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchLinksDatabase -DatabaseName <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] - [-FailoverDatabaseServer <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPEnterpriseSearchLinksDatabase` cmdlet during initial configuration and farm scale out to create a new links database, which can be added to a search service application. -A links database stores query logging and analytics information. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchLinksDatabase -DatabaseName LinksDB_1 -SearchApplication $ssa -``` - -This example adds a new links database LinksDB_1 to the search service application. - - -## PARAMETERS - -### -DatabaseName -Specifies the links database to obtain. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the links database. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password of the account to connect to the database. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the server to use for the host SQL database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the name of the account to connect to the database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the server to use for failover in the case of SQL Server mirroring. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPEnterpriseSearchLinksDatabase](Set-SPEnterpriseSearchLinksDatabase.md) - -[Get-SPEnterpriseSearchLinksDatabase](Get-SPEnterpriseSearchLinksDatabase.md) - -[Remove-SPEnterpriseSearchLinksDatabase](Remove-SPEnterpriseSearchLinksDatabase.md) - -[Repartition-SPEnterpriseSearchLinksDatabases](Repartition-SPEnterpriseSearchLinksDatabases.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataCategory.md deleted file mode 100644 index 91b5603883..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataCategory.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchMetadataCategory -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchMetadataCategory - -## SYNOPSIS -Adds a crawled property category to a search service application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchMetadataCategory [-AssignmentCollection <SPAssignmentCollection>] - [-AutoCreateNewManagedProperties <Boolean>] [-Confirm] [-DiscoverNewProperties <Boolean>] - [-MapToContents <Boolean>] -Name <String> [-PropSet <Guid>] - -SearchApplication <SearchServiceApplicationPipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates the new crawled property category. -SPEnterpriseSearchMetadataCategory represents a category in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$guid = [System.Guid]::NewGuid() -PS C:\>New-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Name MyCategory -DiscoverNewProperties $true -PropSet $guid -``` - -This example adds a new metadata category named MyCategory to the default search service application. -The DiscoverNewProperties parameter is set to true. -Therefore, new crawled properties will be added to the MyCategory metadata category and the unique category identifier is set with the PropSet parameter. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AutoCreateNewManagedProperties -Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: auto -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverNewProperties -Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapToContents -Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: m -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the identity of the new metadata category. - -The type must be a valid name of a metadata category, for example, MetadataCategory1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropSet -Creates a new metadata category with the specified property set. - -Note that the specified property set is the identifier of the category. -Therefore, two categories cannot share a property set. - -The type must be a valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the enterprise search metadata categories. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataCrawledProperty.md deleted file mode 100644 index 757ccdb613..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataCrawledProperty.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchMetadataCrawledProperty -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchMetadataCrawledProperty - -## SYNOPSIS -Adds a crawled property. - - -## SYNTAX - -``` -New-SPEnterpriseSearchMetadataCrawledProperty [-AssignmentCollection <SPAssignmentCollection>] - -Category <CategoryPipeBind> [-Confirm] [-IsMappedToContents <Boolean>] -IsNameEnum <Boolean> -Name <String> - -PropSet <Guid> -SearchApplication <SearchServiceApplicationPipeBind> [-SiteCollection <Guid>] - [-Tenant <Guid>] -VariantType <Int32> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is used when the search functionality is configured for the first time and to add new crawled properties after the first configuration. -SPEnterpriseSearchMetadataCrawledProperty represents a crawled property in the enterprise search metadata property schema. -Or, crawled properties are automatically created during regular crawls (see SPEnterpriseSearchMetadataCategory). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People -PS C:\>$crawlprop = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Category $cat -Limit 1 -PS C:\>New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name "MyCrawlProp" -PropSet $crawlprop.PropSet -Category $crawlprop.CategoryName -IsNameEnum $false -VariantType $crawlprop.VariantType -IsMappedToContents $false -``` - -This example maps the new crawled property MyCrawlProp to the People metadata category for the default search service application. -The mapping uses the constraints from the existing People category. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category -Specifies to which metadata category the crawled property should be added - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - - -```yaml -Type: CategoryPipeBind -Parameter Sets: (All) -Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMappedToContents -Specifies that the crawled property should be mapped to managed properties. -Specify true to map a crawled property to a managed property. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: im -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsNameEnum -Specifies whether the crawled property name is of type integer. -Specified by true or false. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: ie -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the identity of the new crawled property. - -The type must be a valid crawled property name, for example "urn:schemas-microsoft-com:sharepoint:portal:profile:UserName" - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropSet -Specifies the property set that belongs to an existing category. - -A valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawled property. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the crawled properties returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VariantType -Adds the crawled property as the specified variant type. -For more information about valid values for this property, see VARIANT Type Constants (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409) (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409). - -The type must be an integer that specifies the variant data type of the property set. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: vt -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataManagedProperty.md deleted file mode 100644 index 91628374e7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataManagedProperty.md +++ /dev/null @@ -1,486 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchMetadataManagedProperty -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchMetadataManagedProperty - -## SYNOPSIS -Adds a managed property to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchMetadataManagedProperty [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultForQueryIndependentRank <UInt32>] [-Description <String>] [-EnabledForQueryIndependentRank <Boolean>] - [-EnabledForScoping <Boolean>] [-FullTextQueriable <Boolean>] [-IncludeInAlertSignature <Boolean>] - [-IncludeInMd5 <Boolean>] -Name <String> [-NameNormalized <Boolean>] [-NoWordBreaker <Boolean>] - [-Queryable <Boolean>] [-RemoveDuplicates <Boolean>] [-RespectPriority <Boolean>] [-Retrievable <Boolean>] - [-SafeForAnonymous <Boolean>] -SearchApplication <SearchServiceApplicationPipeBind> [-SiteCollection <Guid>] - [-Tenant <Guid>] -Type <Int32> [-UserFlags <Int16>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new managed property. -SPEnterpriseSearchMetadataManagedProperty represents a managed property in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchMetadataManagedProperty -Name AboutMeUpdate -SearchApplication $ssa -Type 4 -``` - -This example creates a new managed property named AboutMeUpdate in the default search service application and sets it type to DateTime. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultForQueryIndependentRank -Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). - - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: def -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a description to the metadata managed property. - -The type must be a valid string. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForQueryIndependentRank -Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking. - -The type must be one of the following query-independent ranking features in the custom model XML: - -- queryIndependentFeature -- categoryFeature -- languageFeature - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: qir -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForScoping -Specifies that the managed property can be used in a scope definition. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullTextQueriable -Specifies that the managed property can be used in enterprise search SQL queries. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeInAlertSignature -{{Fill IncludeInAlertSignature Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: ia -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeInMd5 -Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: im5 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new managed property. - -The type must be a valid name of a managed property, for example, ManagedProperty1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameNormalized -Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. -If value is set to true, the values are normalized. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: nn -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWordBreaker -Specifies that the values for this managed property are processed by a word breaker. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: nw -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queryable -Specifies whether this managed property is queryable or not. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: q -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDuplicates -Specifies that duplicate values for the managed property are removed. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: rd -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RespectPriority -Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. -Otherwise, all mapped crawled properties that have a value are copied. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: rp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Retrievable -Specifies whether this managed property is retrievable or not. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeForAnonymous -{{Fill SafeForAnonymous Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: sfa -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the managed property collection. - -The type must be a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the managed properties returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the data type of the new managed property. - -The type must be one of the following data types: - -1 = Text - -2 = Integer - -3 = Decimal - -4 = DateTime - -5 = YesNo - -6 = Binary - -7 = Double - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserFlags -Reserved for future use. - - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md deleted file mode 100644 index 6ae29bb247..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchMetadataMapping -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchMetadataMapping - -## SYNOPSIS -Adds a managed property mapping. - - -## SYNTAX - -``` -New-SPEnterpriseSearchMetadataMapping -CrawledProperty <CrawledPropertyPipeBind> - -ManagedProperty <ManagedPropertyPipeBind> -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SiteCollection <Guid>] [-Tenant <Guid>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet maps a crawled property to a managed property. -SPEnterpriseSearchMetadataMapping represents a snapshot of a mapping between a managed property and one or more crawled properties in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName -PS C:\>$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People -PS C:\>$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Category $cat -Limit 1 -PS C:\>$ncp = New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name "MyCrawlProp" -PropSet $cp.PropSet -Category $cp.CategoryName -IsNameEnum $false -VariantType $cp.VariantType -IsMappedToContents $true -PS C:\>New-SPEnterpriseSearchMetadataMapping -SearchApplication $ssa -ManagedProperty $mp -CrawledProperty $ncp -``` - -This example maps the created crawled property MyCrawlProp to the managed property UserName for the default search service application. - - -## PARAMETERS - -### -CrawledProperty -Specifies the crawled property to map. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form http://server_name, or an instance of a valid CrawledProperty object. - -```yaml -Type: CrawledPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -Specifies the managed property to which the crawled property should be mapped. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the metadata mapping. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the metadata mapping returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the metadata mapping returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryAuthority.md deleted file mode 100644 index 4a0cab2872..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryAuthority.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchQueryAuthority -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchQueryAuthority - -## SYNOPSIS -Adds an authoritative page to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchQueryAuthority [-Url] <String> -Level <Single> -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPEnterpriseSearchQueryAuthority` cmdlet adds an authoritative page to adjust query rank. -SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher in relevance than demoted sites, which are de-emphasized in relevance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchQueryAuthority -SearchApplication $ssa -Url http://contoso.com -Level 1.5 -``` - -This example designates the URL http://contoso.com as an authoritative page with a relative importance of 1.5. - - -## PARAMETERS - -### -Url -Specifies the query authority page to create. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Level -Specifies the level of the new authoritative page. -Authoritative pagesare expert pages that link to the most relevant information. -A search service application can have multiple authoritative pages. -The Level property is used to specify the relative relevance adjustment of the authoritative pages. -This parameter may receive a floating point value of 0.0 - 2.0, where 0.0 has the most positive impact on relevance. - -```yaml -Type: Single -Parameter Sets: (All) -Aliases: l -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the authority page collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryDemoted.md deleted file mode 100644 index 71a6601461..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryDemoted.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchQueryDemoted -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchQueryDemoted - -## SYNOPSIS -Adds a demoted site rule to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchQueryDemoted [-Url] <String> -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPEnterpriseSearchQueryDemoted` cmdlet adjusts query rank by adding a demoted site rule to the shared search application. -Query demoted sites are de-emphasized in relevance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchQueryDemoted -Url http://examplesite -SearchApplication $ssa -``` - -This example adds a demoted site rule for the URL http://examplesite.com to a search service application. - - -## PARAMETERS - -### -Url -Specifies the identity of the new demoted site rule. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Demoted object is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the demoted site rule collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryKeyword.md deleted file mode 100644 index 59906fd65f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryKeyword.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchQueryKeyword -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchQueryKeyword - -## SYNOPSIS -Adds a keyword term to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchQueryKeyword [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Contact <String>] [-Definition <String>] [-EndDate <DateTime>] [-ReviewDate <DateTime>] - -Site <SPSitePipeBind> [-StartDate <DateTime>] -Term <String> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPEnterpriseSearchQueryKeyword` cmdlet changes query results by creating a new keyword. -A query keyword is a query component of a query topology. -SPEnterpriseSearchQueryKeyword represents relevance setting through keywords. - -You can use this cmdlet for keywords in site collections that are in SharePoint Server. -You cannot use this cmdlet after a site collection is upgraded to SharePoint Server because keywords and Best Bets are automatically migrated to query rules. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPEnterpriseSearchQueryKeyword -Term Tangible -Site http://myserver/sites/team -``` - -This example creates a new query keyword for the site http://myserver/sites/team with the term Tangible. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Contact -Specifies the user name associated with the new keyword. - -The type must be a valid user name; for example, KeywordUser1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Definition -Specifies the definition of the new keyword term. - -The type must be a valid string; for example, a keyword term definition. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -Specifies the expiration date of the keyword term. -The default value is MaxDate. - -The type must be a valid DateTime type, in the form 2010,12,05. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReviewDate -Specifies the review date of the keyword term. -The default value is MaxDate. - -The type must be a valid date, in the form 2010,12,05. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Associates the new keyword term to the specified results URL. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Specifies the activation date for the keyword term. -The default value is the current date. - -The type must be a valid date, in the form 2010,12,05. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Term -Specifies the keyword term to create. - -The type must be a valid string that contains a keyword term (for example, KeywordTerm1). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryProcessingComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryProcessingComponent.md deleted file mode 100644 index baf475dd4a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryProcessingComponent.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchQueryProcessingComponent -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchQueryProcessingComponent - -## SYNOPSIS -Creates a new query processing component for the given topology and search service instance. - - -## SYNTAX - -``` -New-SPEnterpriseSearchQueryProcessingComponent -SearchServiceInstance <SearchServiceInstancePipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new query processing component and adds it to an inactive search topology in a specific search service instance. -The change is effectuated when the search topology is enabled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchQueryProcessingComponent -SearchTopology $topology -SearchServiceInstance $si -SearchApplication $ssa -``` -This example adds a new Search Query Processing Component to the inactive topology for the existing Search Service Application. - -## PARAMETERS - -### -SearchServiceInstance -Specifies the search service instance that will host the new query processing component. - - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology where the new query processing component should be added. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryScope.md deleted file mode 100644 index 6c0e7885dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryScope.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchQueryScope -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchQueryScope - -## SYNOPSIS -Adds a query results scope to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchQueryScope [-AlternateResultsPage <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-CompilationType <Int32>] [-Confirm] -Description <String> - -DisplayInAdminUI <Boolean> [-ExtendedSearchFilter <String>] -Name <String> [-OwningSiteUrl <Uri>] - -SearchApplication <SearchServiceApplicationPipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you upgrade a Search service application to SharePoint Server, you can view shared scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for shared scopes after upgrade. -However, you can convert shared scopes to result sources, which serve a similar purpose. -Similarly, after you upgrade a SharePoint Server site collection to SharePoint Server mode, you can view local scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. -However, you can convert local scopes to result sources, which serve a similar purpose. - -Use the `New-SPEnterpriseSearchQueryScope` cmdlet to create a new shared scope. -SPEnterpriseSearchQueryScope represents a query results scope used by all shared search applications on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchQueryScope -Name MustCrawl -Description "Sites we must crawl" -DisplayInAdminUI $true -SearchApplication $ssa -``` - -This example adds a scope named MustCrawl that will be displayed in the administration UI to the search service application named MySSA. - - -## PARAMETERS - -### -AlternateResultsPage -Specifies the location to display results for the new query scope. - -The type must be a valid URL, in the form http://server_name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: a -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompilationType -Specifies the compilation type of the new scope. -The value 0 specifies the conditionally compiled scope type and the value 1 specifies the always compiled scope type. - -The type must be either of the following: 0 or 1. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: type -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a description of the new query scope. - -The type must be a valid string; for example, a description of a query scope. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayInAdminUI -Specifies that the new scope is displayed in the administration application user interface (UI). -The default setting is to hide the new scope in the administration application UI. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: disp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedSearchFilter -{{Fill ExtendedSearchFilter Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the identity of the scope to create. - -The type must be a valid name of a scope (for example, Scope1). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwningSiteUrl -Specifies the SharePoint site that is associated with the new scope. - -The type must be a valid SharePoint site URL, in the form http://server_name. - - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryScopeRule.md deleted file mode 100644 index 3a615fb39d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchQueryScopeRule.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchQueryScopeRule -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchQueryScopeRule - -## SYNOPSIS -Adds a shared scope rule to a query scope. - - -## SYNTAX - -``` -New-SPEnterpriseSearchQueryScopeRule -RuleType <String> -Scope <ScopePipeBind> -Url <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-FilterBehavior <String>] - [-ManagedProperty <ManagedPropertyPipeBind>] [-MatchingString <String>] [-PropertyValue <String>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-UrlScopeRuleType <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -After you upgrade a Search service application to SharePoint Server, you can view shared scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for shared scopes after upgrade. -However, you can convert shared scopes to result sources, which serve a similar purpose. -Similarly, after you upgrade a SharePoint Server site collection to SharePoint Server mode, you can view local scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. -However, you can convert local scopes to result sources, which serve a similar purpose. - -The `New-SPEnterpriseSearchQueryScopeRule` cmdlet creates a new shared scope rule. -SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can be applied to a scope. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication -C:\PS>$scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchQueryScopeRule -Scope $scope -RuleType AllContent -Url http://criticalSite -``` - -This example creates a new scope rule of type AllContent for the URL http://criticalSite. - - -## PARAMETERS - -### -RuleType -Specifies the type of scope rule to create. - -The type must be one of the following values: AllContent, Url, or PropertyQuery. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: type -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Applies the query scope rule to the specified scope. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Specifies the results URL that is associated with the query scope rule. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterBehavior -Specifies the type of scope rule to create for the query scope. -The default value is Include. - -The type must be one of the following values: Exclude, Include, or Require. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -Specifies the managed property to use for the PropertyQuery scope rule. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a managed property (for example, ManagedProperty1); or an instance of a valid ManagedProperty object. - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: mname -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchingString -Specifies the string to use when matching the URL rule type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: text -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyValue -Specifies the property value to use when matching the PropertyQuery rule type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: value -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope rule collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlScopeRuleType -Specifies the value to use when matching the URL rule type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ut -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchRankingModel.md deleted file mode 100644 index ded505587e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchRankingModel.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchRankingModel -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchRankingModel - -## SYNOPSIS -Adds a ranking model to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchRankingModel -Owner <SearchObjectOwner> -RankingModelXML <String> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet adds a new ranking model to the assignment collection. -The name, description and identifier (ID) for the new ranking model are contained in the .xml file specified in RankingModelXML. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SPWeb -SPWeb http://sharepoint/team -PS C:\>[String]$rankmodel = Get-Content .\rankModel.xml -PS C:\>New-SPEnterpriseSearchRankingModel -SearchApplication $ssa -Owner $owner -RankingModelXML $rankmodel -``` - -This example creates a ranking model for the site http://sharepoint/team for the search service application Search Service Application from the file rankModel.xml which is stored in the current directory. - - -## PARAMETERS - -### -Owner -Specifies the scope where the ranking model is available. -The available scopes are: SSA, Tenant, Site Collection or Site. -A ranking model can be available in multiple scopes. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RankingModelXML -Specifies the name of the XML representation of the new ranking model. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the ranking model. - -The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchResultItemType.md deleted file mode 100644 index a98ff6ff0b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchResultItemType.md +++ /dev/null @@ -1,397 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchResultItemType -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchResultItemType - -## SYNOPSIS -Creates a new result item type. - - -## SYNTAX - -### New -``` -New-SPEnterpriseSearchResultItemType [-Name] <String> [-Rules] <PropertyRuleCollection> - [[-RulePriority] <Int32>] [[-DisplayProperties] <String>] [[-SourceID] <Guid>] [-DisplayTemplateUrl] <String> - -Owner <SearchObjectOwner> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-OptimizeForFrequentUse <Boolean>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -### Copy -``` -New-SPEnterpriseSearchResultItemType [[-Name] <String>] [[-Rules] <PropertyRuleCollection>] - [[-RulePriority] <Int32>] [[-DisplayProperties] <String>] [[-SourceID] <Guid>] - [[-DisplayTemplateUrl] <String>] -ExistingResultItemType <ResultItemTypePipeBind> - -ExistingResultItemTypeOwner <SearchObjectOwner> -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-OptimizeForFrequentUse <Boolean>] - [-SearchApplication <SearchServiceApplicationPipeBind>] - [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPEnterpriseSearchResultItemType` cmdlet to create a new result item type. - -Result item types enable you to change the look of search results based on the type of result. -You start by defining a collection of rules, which will be evaluated against the properties of results. -Then you define the display template to use for rendering that type of result. -Once you have created the result item type, results matching the rules of the result item type will render using the specified display template. - -Example use cases: - -- Change the look of results for a particular file name extension, for example Word documents. -- Change the look of a particular content type in search results. -- Change the look of results from a particular author. -- Add a result action to results from a particular result source as part of a custom search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$rule = Get-SPEnterpriseSearchPropertyRule -PropertyName "ContentTypeId" -Operator "StartsWith" -PS C:\>$rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') -PS C:\>$ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection -PS C:\>$ruleCollection.Add($rule) -PS C:\>$displayProperties = "WorkId,Rank,Title,Size,Path,Description,SiteName,HitHighlightedSummary,HitHighlightedProperties,ViewsLifeTime" -$displaytemplateUrl = "~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_MyCustomDisplayTemplate.js" -PS C:\>$web = Get-SPWeb http://webUrl -PS C:\>$tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web -PS C:\>$proxy = Get-SPEnterpriseSearchServiceApplicationProxy -PS C:\>New-SPEnterpriseSearchResultItemType -SearchApplicationProxy $proxy ` ->> -Name "CustomResultType" ` ->> -Rules $ruleCollection ` ->> -RulePriority 1 ` ->> -DisplayProperties $displayProperties ` ->> -DisplayTemplateUrl $displaytemplateUrl ` ->> -Owner $tenantOwner -``` - -This example first defines the rule to apply to the search results in order to target results with a specific property and adds the rule to the rule collection. - -Thereafter the example defines the properties of the result that shall be displayed and the URL to the display template governing the appearance of the rendered results. - -Finally, the example defines the rule item type by its name, the rule collection, the display properties, the display template and the tenant owner. - -## PARAMETERS - -### -Name -Specifies the name of the result item type. - -```yaml -Type: String -Parameter Sets: New -Aliases: n -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Copy -Aliases: n -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rules -Specifies the collection of rules to evaluate the result properties against. - -```yaml -Type: PropertyRuleCollection -Parameter Sets: New -Aliases: rule -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: PropertyRuleCollection -Parameter Sets: Copy -Aliases: rule -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RulePriority -Specifies which priority the collection of rules has compared to other rules. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: priority -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayProperties -Specifies which result properties to display. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dp -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceID -Identifies the search result source that the result item type applies to. -Leave this parameter blank to apply to all result sources. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: sid -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayTemplateUrl -Specifies the URL of the display template that shall be used for rendering the results. -Specify an absolute URL. - -```yaml -Type: String -Parameter Sets: New -Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Copy -Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExistingResultItemType -Specifies an existing result item type to which new rules or displayed properties can be added. - -```yaml -Type: ResultItemTypePipeBind -Parameter Sets: Copy -Aliases: copy -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExistingResultItemTypeOwner -Specifies the search object owner that defines the scope at which an existing result item type was created. - -```yaml -Type: SearchObjectOwner -Parameter Sets: Copy -Aliases: eo -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the result item type is created. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptimizeForFrequentUse -Enable this flag if you always want the properties of this result item type to be requested, regardless of whether the result type is triggered. -This will improve performance as long as it is only enabled on the most frequently used result item types. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: opt -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the result item type. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplicationProxy -Specifies the proxy of the search application that contains the result item type. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPEnterpriseSearchResultItemType](Set-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchResultItemType](Get-SPEnterpriseSearchResultItemType.md) - -[Remove-SPEnterpriseSearchResultItemType](Remove-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) - -[Get-SPEnterpriseSearchPropertyRule](Get-SPEnterpriseSearchPropertyRule.md) - -[Get-SPEnterpriseSearchPropertyRuleCollection](Get-SPEnterpriseSearchPropertyRuleCollection.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchResultSource.md deleted file mode 100644 index ac14be8bca..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchResultSource.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchResultSource -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchResultSource - -## SYNOPSIS -Creates a new result source. - - -## SYNTAX - -``` -New-SPEnterpriseSearchResultSource [-AssignmentCollection <SPAssignmentCollection>] - [-AuthenticationType <FederationAuthType>] [-AutoDiscover <Boolean>] [-Confirm] [-Description <String>] - [-MakeDefault <Boolean>] -Name <String> -Owner <SearchObjectOwner> [-Password <String>] -ProviderId <Guid> - [-QueryTemplate <String>] [-RemoteUrl <String>] -SearchApplication <SearchServiceApplicationPipeBind> - [-SsoId <String>] [-UserName <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a result source. -Use result sources to scope search results and federate queries to external sources, such as internet search engines. -After defining a result source, configure search web parts and query rule actions to use it. -Result Sources replace Search Scopes, which are now deprecated. -This cmdlet supports the same create operations as are supported through the "Manage Result Sources" page in Central Administration, except the operations "Form Authentication" and "Cookie Authentication". -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -ProviderId fa947043-6046-4f97-9714-40d4c113963d -Name "Custom SharePoint Result Source" -``` - -This example creates a new search service application level result source, named "Custom SharePoint Result Source". - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the authentication type of the new result source. - -A specific set of authentication types are supported for each search provider type and, if parameter is not specified, the authentication type will default based on search provider type. - -This cmdlet supports the following set of authentication mechanisms and corresponding types: Default SharePoint Authentication (FederationAuthType.LocalNTAuth), Basic Authentication (FederationAuthType.SingleAccountBasicAuth - specify UserName and Password), Default Remote SharePoint Authentication (FederationAuthType.PerUserBasicAuth), Single Sign On (FederationAuthType.SSO - requires SsoId to be specified), Anonymous (FederationAuthType.Anonymous), Digest Authentication (FederationAuthType.SingleAccountDigest - specify UserName and Password), NTLM Application Pool Identity (FederationAuthType.ApplicationPoolIdentity), NTLM User Name and Password (FederationAuthType.SingleAccountNTLM - specify UserName and Password). - -When using a Local SharePoint Search/Local SharePoint People Search provider, then FederationAuthType.LocalNTAuth (default) and FederationAuthType.SingleAccountBasicAuth are supported. - -When using a Remote SharePoint Search/Remote SharePoint People Search provider, then FederationAuthType.PerUserBasicAuth (default) and FederationAuthType.SSO are supported. - -When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. - -All authentication types are listed in the enum FederationAuthType. - - -```yaml -Type: FederationAuthType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDiscover -Specifies whether to use automatic discovery of the Exchange server endpoint for the new result source. - -Setting value to true ($true) states that automatic discovery should be used. -If not specified or set to false ($false), automatic discovery will not be used. - -Only applicable when using an Exchange search provider. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the new result source. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeDefault -Specifies whether the new result source should be set as default or not, for the scope specified by the Owner parameter. - -Setting value to true ($true) states that the result source should be set as default. -If not specified or set to false, the new result source will not be set as default. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new result source. - -Names must be unique at each administrative level. - -For example, two result sources in a site cannot share a name, but one in a site and one provided by the site collection can. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is created. - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the user credentials to use to connect to the new result source. - -Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId -Specifies the search provider to be used by the new result source. - -Is specified as a Guid or GUID string, which must be one of the following: FA947043-6046-4F97-9714-40D4C113963D (Local SharePoint Search), E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local SharePoint People Search), 1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (Remote SharePoint Search), E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (Remote SharePoint People Search), 3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search), 3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1). - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryTemplate -Specifies the query transformation template of the new result source. - -Incoming queries are changed according to the template, to use this new query text instead. -Include the incoming query in the new text by using the query variable "{searchTerms}". -Use this to scope results. - -For example, to only return OneNote items, set the new text to "{searchTerms} fileextension=one". -Then, an incoming query "sharepoint" becomes "sharepoint fileextension=one". -Default value is {searchTerms}. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteUrl -Specifies the connection URL template of the new result source. - -Must be set when using a search provider that consumes it: Remote SharePoint Search, Remote SharePoint People Search, OpenSearch 1.0/1.1 and Exchange (if AutoDiscover is not turned on). - -When using other search providers the parameter is ignored. - -For Remote SharePoint Search/Remote SharePoint People Search, specify the address of the root site collection of the remote SharePoint farm. - -For OpenSearch 1.0/1.1, specify the URL of the OpenSearch source. - -Include the query in the URL by using the query variable "{searchTerms}", which will be automatically replaced with the query. -For Exchange, specify the Exchange EWS URL from which to retrieve results. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SsoId -Specifies the reverse proxy certificate Secure Store Id to use to connect to the new result source. - -Must be specified if authentication type (AuthenticationType) is set to FederationAuthType.SSO (Single Sign On). - -If you are connecting to your intranet through a reverse proxy, enter the SSO Id of the Single Sign On entry which stores the certificate used to authenticate against the reverse proxy. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the user name of the user credentials to use to connect to the new result source. - -Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchResultSource](Get-SPEnterpriseSearchResultSource.md) - -[Set-SPEnterpriseSearchResultSource](Set-SPEnterpriseSearchResultSource.md) - -[Remove-SPEnterpriseSearchResultSource](Remove-SPEnterpriseSearchResultSource.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchSecurityTrimmer.md deleted file mode 100644 index 46f598ce38..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchSecurityTrimmer.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchSecurityTrimmer -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchSecurityTrimmer - -## SYNOPSIS -Adds a custom security trimmer to a shared search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchSecurityTrimmer [-Id] <Int32> [-RulePath <String>] - -SearchApplication <SearchServiceApplicationPipeBind> -TypeName <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Properties <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new object to configure the security trimmer. -SPEnterpriseSearchSecurityTrimmer represents a security trimmer that performs customized security trimming of search results at query time, when the results are returned to the user. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa -TypeName "SearchCustomSecurityTrimmer.CustomSecurityTrimmerPost, SearchCustomSecurityTrimmer, Version=1.0.0.0, Culture=neutral, PublicKeyToken=48e046c834625a88, processorArchitecture=MSIL" -Id 1 -``` - -This example adds a new custom security trimmer for trimming the returned result set. This new security trimmer is added to the search application by using the id 1. The strong named assembly contains the class CustomSecurityTrimmerPost, which implements the ISecurityTrimmerPost interface. - - -## PARAMETERS - -### -Id -Specifies the identity of the security trimmer to use for the specified search application. - -If this parameter specifies an existing custom security trimmer, the trimmer will be removed and replaced with the custom trimmer. - -Remove the existing trimmer before you add a new one. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RulePath -Specifies the content path where the security trimmer will be applied. - -The string must be a valid URI in the form file:\\\\server_name\content, and it must correspond to an existing crawl rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Adds the security trimmer to the specified search application. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TypeName -Specifies the strong named assembly name of a security trimmer type. -The strong name must refer to a type whose assembly is deployed to the global assembly cache on a query server and that type must implement the ISecurityTrimmerPre, ISecurityTrimmerPost or ISecurityTrimmer2 interface. -Security trimming can be done in two places: before query execution (ISecurityTrimmerPre) or after the results set has returned (ISecurityTrimmerPost or ISecurityTrimmer2). -For how to reference a strong name assembly, see http://msdn.microsoft.com/en-us/library/s1sx4kfb.aspx (http://msdn.microsoft.com/en-us/library/s1sx4kfb.aspx) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the name-value pairs that specify the configuration properties. - -The type must be in the following name/value pair format: Name1~Value1~Name2~Value2~ - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index bdfca9f90c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Adds a search service application to a farm. - - -## SYNTAX - -``` -New-SPEnterpriseSearchServiceApplication [[-Name] <String>] - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] - [-DatabaseUsername <String>] [-Partitioned] [-WhatIf] - [-AdminApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-CloudIndex <Boolean>] - [-FailoverDatabaseServer <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is used when the search functionality is first configured or when a new shared search application is added to a farm. -SPEnterpriseSearchServiceApplication represents a self-contained aggregation of indexed content and properties available for search and provides an anchor class for setting global search properties. -A farm can include multiple search service applications. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$appPool = New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account 'CONTOSO\ServiceApps' -PS C:\>New-SPEnterpriseSearchServiceApplication -Name "Search Service Application" -ApplicationPool $appPool -``` - -This example creates a new search service application named NewSSA in a new application pool. - -A search service application that is created in this manner will have active search topology, but no search components. - - -## PARAMETERS - -### -Name -Specifies the names of the new search application. - -The type must be a valid name of a search application, for example, SearchApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the IIS application pool to use for the new search application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL of a search application, in the form http://server_name; or an instance of a valid SPIisWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to create for the new search application. - -The type must be a valid name of a SQL Server database, for example, SearchAppDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user ID that is used for accessing the search application database on SQL Server. - -The type must be a valid password. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid SQL Server host name, for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user ID to use for accessing the search application SQL Server database. - -The type must be a valid user name, for example, SearchUserName1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partitioned -Specifies that the search service application uses web-hosted mode. -Web-hosted mode segregates results for a given hosted subscription. - -This property has no effect on SharePoint Server 2019. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminApplicationPool -Specifies the application pool to be used with the SearchAdminWebServiceApplication that is associated with SearchServiceApplication. If not specified, ApplicationPool will be used. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudIndex -When CloudIndex is true, this becomes a cloud Search service application that crawls on premises content in a cloud hybrid search solution. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the SQL server that hosts the mirror instances of search databases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchServiceApplicationProxy.md deleted file mode 100644 index d1f62fc3c3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchServiceApplicationProxy.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchServiceApplicationProxy - -## SYNOPSIS -Adds a new search application proxy to a farm. - - -## SYNTAX - -### SSA -``` -New-SPEnterpriseSearchServiceApplicationProxy [[-Name] <String>] - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-MergeWithDefaultPartition] [-Partitioned] [-WhatIf] [<CommonParameters>] -``` - -### Uri -``` -New-SPEnterpriseSearchServiceApplicationProxy [[-Name] <String>] -Uri <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MergeWithDefaultPartition] [-Partitioned] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -This cmdlet creates a proxy for a search service application. -The search service application proxy can be used by a web application or another service consumer to use the functionality that is provided by the search application. - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (http://msdn.microsoft.com/en-us/library/dd878348(VS.85).aspx). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchServiceApplicationProxy -Name 'Search Service Application Proxy' -SearchApplication $ssa -``` - -This example adds a search service application proxy to a search service application. - - -## PARAMETERS - -### -Name -Specifies the display name of the search application proxy to create. - -The type must be a valid string, for example, SearchAppProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the URI to the search application to use for search. - -The type must be a valid URI, in the form file:\\\\server_name\searchapp. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: SSA -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI to the search application to use for search. - -The type must be a valid URI, in the form file:\\\\server_name\searchapp. - -```yaml -Type: String -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MergeWithDefaultPartition -Merges the index partition for the proxy with the default index partition collection for the search service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partitioned -Specifies that the search service application must use web-hosted mode. -web-hosted mode segregates results for a given hosted subscription. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchSiteHitRule.md deleted file mode 100644 index ce5e760c46..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchSiteHitRule.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchSiteHitRule -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchSiteHitRule - -## SYNOPSIS -Adds a new site hit rule for a search application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchSiteHitRule -Behavior <String> -HitRate <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SearchService <SearchServicePipeBind>] [-WhatIf] - -Name <String> [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPEnterpriseSearchSiteHitRule` cmdlet sets the maximum limits for crawling a site. -The new site hit rule is used by all search service applications on the current farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------EXAMPLE------------------ -``` -PS C:\>New-SPEnterpriseSearchSiteHitRule -Name myHost -Behavior 0 -HitRate 40 -``` - -This example creates a new site hit rule on the myHost host that limits to 40 the number of simultaneous requests. - - -## PARAMETERS - -### -Name -The name of the host to which the site hit rule should be applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Behavior -Defines a rule to be followed when the farm's search service crawls the given site. - -If a value of zero is specified, the hit rate is the maximum number of simultaneous requests. If a value of 1 is specified, then hit rate is the number of seconds to delay between requests to the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HitRate -Value to use for maximum requests or seconds of delay, according to behavior. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchService -Specifies the search service in the farm that hosts the crawl. - -The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet will be used. - -```yaml -Type: SearchServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchTopology.md deleted file mode 100644 index 4044ae03be..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchTopology.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPEnterpriseSearchTopology -schema: 2.0.0 ---- - -# New-SPEnterpriseSearchTopology - -## SYNOPSIS -Creates a new search topology in the given search service application. - - -## SYNTAX - -``` -New-SPEnterpriseSearchTopology -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Clone] [-Confirm] - [-SearchTopology <SearchTopologyPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new, inactive search topology in the given search service application. -If the Clone switch is used, a cloned topology is created. -Otherwise, an empty topology is created. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>New-SPEnterpriseSearchTopology -SearchApplication $ssa -``` - -This example creates a new, empty search topology in the search service application referenced by $ssa. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -PS C:\>New-SPEnterpriseSearchTopology -SearchApplication $ssa -Clone -SearchTopology $topology -``` - -This example creates a new search topology in the search service application referenced by $ssa by cloning the existing topology referenced by $topology. - - -## PARAMETERS - -### -SearchApplication -Specifies the search application to which the search topology will belong. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Clone -Specifies that the new search topology is to be created by cloning an existing search topology. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Specifies that the new search topology is to be created by cloning an existing search topology. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the existing search topology of which the new topology will be a clone. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchTopology](Get-SPEnterpriseSearchTopology.md) - -[Set-SPEnterpriseSearchTopology](Set-SPEnterpriseSearchTopology.md) - -[Remove-SPEnterpriseSearchTopology](Remove-SPEnterpriseSearchTopology.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelBIServer.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelBIServer.md deleted file mode 100644 index 4009027392..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelBIServer.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelBIServer -schema: 2.0.0 ---- - -# New-SPExcelBIServer - -## SYNOPSIS - - -Configures -Analysis Services servers to work with Excel Services. - - - -## SYNTAX - -``` -New-SPExcelBIServer [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> -ServerId <String> [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -Use the New-SPExcelBIServer cmldet to configure Analysis Services servers to work with Excel Services. - - - - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -New-SPExcelBIServer -ExcelServiceApplication "MyExcel" -ServerID "MSS01" -``` - -This example configures the analysis server to work the Excel Service application named MyExcel and ServerID of MSS01. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the Analysis server - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServerId - -The name of the Analysis Services server - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelBlockedFileType.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelBlockedFileType.md deleted file mode 100644 index 6812ea2cd0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelBlockedFileType.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelBlockedFileType -schema: 2.0.0 ---- - -# New-SPExcelBlockedFileType - -## SYNOPSIS -Adds a file type to the list of file types that Excel Services Application prevents from loading. - - -## SYNTAX - -``` -New-SPExcelBlockedFileType -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> -FileType <FileType> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPExcelBlockedFileType` cmdlet adds an entry to the list of file types that Excel Services Application prevents from loading. -Excel Services Application does not load any files that correspond to a file type that is on this list. -The specified file type is prevented from loading by all instances of Excel Services Application for the specified Excel Services Application Web service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$sa = Get-SPExcelServiceApplication -PS C:\>New-SPExcelBlockedFileType -FileType XLSM -ExcelServiceApplication $sa -``` - -This example adds an entry for XLSM to the list of file types that Excel Services Application currently prevents from loading. - - -## PARAMETERS - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -FileType -Specifies the file types that are blocked from loading. - -The type must be one of the following file extensions: XLSX, XLSB, or XLSM. - -```yaml -Type: FileType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelDataConnectionLibrary.md deleted file mode 100644 index 22f6bb722c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelDataConnectionLibrary.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelDataConnectionLibrary -schema: 2.0.0 ---- - -# New-SPExcelDataConnectionLibrary - -## SYNOPSIS -Adds a new data connection library to Excel Services Application. - - -## SYNTAX - -``` -New-SPExcelDataConnectionLibrary -Address <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPExcelDataConnectionLibrary` cmdlet adds a data connection library to the list of trusted data connection libraries for an Excel Services Application Web service application. -Excel Services Application loads only data connection files that are stored in a data connection library that is on the list of trusted data connection libraries. -Data connection libraries contain data connection files, which contain all the resources that Excel Services Application and the Excel client require to connect to an external data source. -Data connection libraries enable you to reuse and share data connections. -Data connections can be loaded by using information from the workbook file; however, using a data connection library to load data connections allows data connections to be managed separately from workbooks. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$sa = Get-SPExcelServiceApplication -PS C:\>New-SPExcelDataConnectionLibrary -Address "http://portal/site/salesDCL" -Description "This is the DCL where all the connections to the sales data are stored." -ExcelServiceApplication $sa -``` - -This example adds a new data connection library (DCL) and then sets its description to the list of trusted data connection libraries that is in the Excel Services Application Web service application named MyExcelService. - -Workbooks can use connection files stored in that library to refresh data on the Excel Services Application Web service application. - - -## PARAMETERS - -### -Address -Specifies the address of the data connection library. -The address must be unique in the list of trusted data connection libraries. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a friendly description for the data connection library. - -The type must be a valid string; for example, this is a custom OLEDB provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelDataProvider.md deleted file mode 100644 index 694194d68e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelDataProvider.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelDataProvider -schema: 2.0.0 ---- - -# New-SPExcelDataProvider - -## SYNOPSIS -Adds a new safe data provider to Excel Services Application. - - -## SYNTAX - -``` -New-SPExcelDataProvider -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> -ProviderId <String> - -ProviderType <DataProviderType> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Description <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPExcelDataProvider` cmdlet adds a data provider to the list of safe data providers in an Excel Services Application Web service application. -Excel Services Application refreshes external data connections only if the data provider for a connection is on the list of safe data providers. -Excel Services Application includes a set of common data providers on this list. -Therefore, using cmdlets to modify safe data providers typically occurs only in custom data connection scenarios. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPExcelServiceApplication -identity "MyExcelService" | New-SPExcelDataProvider -providerID "CustomOLEDB" -ProviderType OleDb -description "This is a custom OLEDB provider" -``` - -This example adds a new custom OLEDB data provider to the list of safe data providers for the Excel Services Application Web service application named MyExcelService. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPExcelServiceApplication | New-SPExcelDataProvider -providerID "CustomOLEDB" -ProviderType OleDb -description "This is a custom OLEDB provider" -``` - -This example adds a new custom OLEDB data provider to the list of safe data providers for all Excel Services Application Web service application in the farm. - - -## PARAMETERS - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelDataProvider list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ProviderId -Specifies the name of the provider. -This ID should be present in the connection strings generated by this provider and the ID must be unique for the provider type. - -The type must be a valid name of a provider; for example CustomOLEDB. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderType -Specifies the supported type of data provider to add to safe provider list. - -The type must be one of the following: OleDb, Odbc, or OdbcDsn. - -```yaml -Type: DataProviderType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a friendly description for the new data provider. - -The type must be a valid string; for example, "This is a custom OLEDB provider". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelFileLocation.md deleted file mode 100644 index 73f43451b6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelFileLocation.md +++ /dev/null @@ -1,599 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelFileLocation -schema: 2.0.0 ---- - -# New-SPExcelFileLocation - -## SYNOPSIS -Adds a new trusted location to Excel Services Application. - - -## SYNTAX - -``` -New-SPExcelFileLocation -Address <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> - [-AbortOnRefreshOnOpenFail] [-AssignmentCollection <SPAssignmentCollection>] - [-AutomaticVolatileFunctionCacheLifetime <Int32>] [-ChartAndImageSizeMax <Int32>] - [-ConcurrentDataRequestsPerSessionMax <Int32>] [-Confirm] [-DefaultWorkbookCalcMode <DefaultWorkbookCalcMode>] - [-Description <String>] [-DisplayGranularExtDataErrors] [-ExternalDataAllowed <AllowExternalData>] - [-IncludeChildren] [-LocationType <LocationType>] [-ManualExtDataCacheLifetime <Int32>] - [-NewWorkbookSessionTimeout <Int32>] [-PeriodicExtDataCacheLifetime <Int32>] [-RequestDurationMax <Int32>] - [-RESTExternalDataAllowed] [-SessionTimeout <Int32>] [-ShortSessionTimeout <Int32>] [-UdfsAllowed] - [-WarnOnDataRefresh] [-WhatIf] [-WorkbookSizeMax <Int32>] [-ChartRenderDurationMax <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPExcelFileLocation` cmdlet adds a new location to the list of trusted file locations in an Excel Services Application Web service application. -Excel Services Application loads only workbooks that are stored in a trusted file location. -Properties of trusted file locations control how workbooks can be used when loaded on Excel Services Application. -Excel Services Application always enforces the properties defined by the trusted file location from which a workbook was loaded. -The properties that the trusted file location uses are determined through comparison of the file path for the workbook with the Address parameter of the trusted file location. - -The longest match takes precedence. -For example, if http://portal/site/ and http://portal/site/subsite are trusted locations and you load a workbook from the subsite, the application uses the properties from the subsite trusted location because it has the longest matching address. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Get-SPExcelServiceApplication -identity "MyExcelService" | New-SPExcelFileLocation -address "http://myportal/myTeam" -includechildren -locationType SharePoint -description "This is my team's site on myPortal." -workbooksizemax 50 -externaldataallowed DclAndEmbedded -WarnOnDataRefresh:$false -``` - -This example adds a new trusted file location to the list of trusted file locations that is in the Excel Services Application Web service application named MyExcelService. - -This example enables workbooks to load from any child or subfolder that starts with http://myPortal/myTeam. -All workbooks loaded from this location must be smaller than 50 megabytes (MB) in size. -The workbooks can refresh external data by using connections that are embedded in the workbook file or stored in a data connection library. -A warning message that the workbook is attempting to refresh external data will not be displayed. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPExcelServiceApplication -identity "MyExcelService" | New-SPExcelFileLocation -address http://myPortal/myTeam/managers -locationType SharePoint -description "This is the manager's subsite for myTeam." -``` - -This example adds a new trusted file location to the list of trusted file locations that is in the Excel Services Application Web service application named MyExcelService with a given address and description. - - -## PARAMETERS - -### -Address -Specifies a Web folder, or file directory from which Excel Services Application can load workbooks. - -The type must be a valid URL, in the form http://myPortal/myTeam; or a valid UNC path in form, \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AbortOnRefreshOnOpenFail -Specifies that the loading of a Excel Services Application file automatically fails if an automatic data refresh operation fails when the file is opened. -The load is failed only if the following conditions are true: - -- The user has SharePoint Product and Technologies read-only permissions to the file. -- The workbook file has data connections that are refreshed automatically when the Excel Services Application file is opened. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AutomaticVolatileFunctionCacheLifetime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. -Valid values include: - --1 Calculates once when the workbook loads. - -0 Always calculates. - -1 to 2073600 Caches 1 second to 24 days. -The default integer value is 300. - -The type must be the integers -1 or 0, or an integer value in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened. -The default value is 1. - -The type must be a valid integer greater than 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentDataRequestsPerSessionMax -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 must be queued. -The scope of this setting is the logical server. -The default value is 5. - -The type must be a positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultWorkbookCalcMode -Specifies the calculation mode of workbooks. -Settings other than File override the workbook settings. -The default setting is File. - -The type must be one of the following: File, Manual, Auto, or AutoDataTables. - -```yaml -Type: DefaultWorkbookCalcMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a friendly description for the new file location. - -The type must be a valid string; for example, this is the file location of the monthly sales reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayGranularExtDataErrors -Displays granular error messages for external data failures for files in this location. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDataAllowed -Specifies the type of external data access allowed for workbooks. -None specifies that data refresh is disabled. -Dcl specifies that data is refreshed only when it uses a connection file in a trusted data connection library. -DclandEmbedded specifies that a data connection library can be used but is not required. -The scope of this setting is the trusted location. -The default value is None. - -The type must be any of the following settings: - -None - -Dcl - -DclAndEmbedded - -```yaml -Type: AllowExternalData -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeChildren -Indicates that subordinate URLs, directories and libraries are trusted. -For example, if the trusted file location is http://portal and IncludeChildren is true, http://portal/subSite is also trusted, as is any URL subordinate to the URL specified in Address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationType -Specifies the type of location. -Location type indicates how Excel Services Application retrieves files from the location specified in Address. -The default setting is the SharePoint type. -The default value is SharePoint. - -The type must be one of the following: SharePoint, UNC, or HTTP. - -```yaml -Type: LocationType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManualExtDataCacheLifetime -Specifies the time, in seconds, that Excel Services Application waits before it re-issues a manual, or user-initiated, external data request. -During this time period, the results from the previous external data request can be returned from an external data cache. -The default value is 300. - -The valid values are any one of the following items: - --1 Never refresh after first query.1 to 2073600- Caches 1 second to 24 days. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWorkbookSessionTimeout -Specifies the time, in seconds, that a session for a new, unsaved, workbook remains active on Excel Services Application with no user activity. -Valid values include the following: - --1 Session never expires. - -0 Session expires at the end of a single request. - -1 to 2073600 Remains active 1 second to 24 days. -The default value is 1800. - -The type must be -1, 0, or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeriodicExtDataCacheLifetime -Specifies the time, in seconds, that Excel Services Application waits before it re-issues an on-open or periodic (that is, automatic) external data request. -During this time period, the results from the previous external data request can be returned from an external data cache. -A value of -1 specifies never to refresh after the first query. -The default value is 300. - -The type must be -1, 0, or integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The default value is 300. - -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RESTExternalDataAllowed -Specifies whether requests from the Representational State Transfer (REST) Application Programming Interface (API) are permitted to refresh external data connections. -The RESTExternalDataAllowed parameter has no effect if ExternalDataAllowed parameter is set to None. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionTimeout -Specifies the time, in seconds, that a session remains active on Excel Services Application with no user activity. -Valid values include the following: - --1 Session never expires. - -0 session expires at the end of a single request. - -1 to 2073600 Remains active 1 second to 24 days. -The default value is 300. - -The type must be -1, 0, or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortSessionTimeout -Specifies the time, in seconds, that a user has to make the initial interaction with a spreadsheet. -After this time has elapsed, if the user is not active, the session is closed. -The value must always be less than SessionTimeout. -If the ShortSessionTimeout value is greater than or equal to SessionTimeout, an error is returned. -The default value is 75. - -The type must be -1 or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdfsAllowed -Specifies that user-defined functions can be called by workbooks that are loaded from the trusted file location that is specified in Address. - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnOnDataRefresh -Specifies that a warning is displayed to the user on the first refresh of data for the workbook. -The default value is True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookSizeMax -Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The default value is 10. - -The type must be an integer value in the range of 1 to 2000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChartRenderDurationMax -{{Fill ChartRenderDurationMax Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelServiceApplication.md deleted file mode 100644 index a6770847d3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelServiceApplication.md +++ /dev/null @@ -1,562 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelServiceApplication -schema: 2.0.0 ---- - -# New-SPExcelServiceApplication - -## SYNOPSIS -Creates a new instance of Excel Services Application. - - -## SYNTAX - -### ExistingTargetApplicationParameterSet -``` -New-SPExcelServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-Name <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-CachingOfUnusedFilesEnable] [-Confirm] - [-CrossDomainAccessAllowed] [-Default] [-EncryptedUserConnectionRequired <EncryptedConnectionMode>] - [-ExternalDataConnectionLifetime <Int32>] [-FileAccessMethod <FileAccessMethod>] - [-LoadBalancingScheme <LoadBalancingScheme>] [-MemoryCacheThreshold <Int32>] [-PrivateBytesMax <Int32>] - [-SessionsPerUserMax <Int32>] [-SiteCollectionAnonymousSessionsMax <Int32>] - [-TerminateProcessOnAccessViolation] [-ThrottleAccessViolationsPerSiteCollection <Int32>] - [-UnattendedAccountApplicationId <String>] [-UnusedObjectAgeMax <Int32>] [-WhatIf] [-WorkbookCache <String>] - [-WorkbookCacheSizeMax <Int32>] [-UseEffectiveUserName] [-WorkbookModelUsageTracker <String>] - [<CommonParameters>] -``` - -### NewTargetApplicationParameterSet -``` -New-SPExcelServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-Name <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-CachingOfUnusedFilesEnable] [-Confirm] - [-CrossDomainAccessAllowed] [-Default] [-EncryptedUserConnectionRequired <EncryptedConnectionMode>] - [-ExternalDataConnectionLifetime <Int32>] [-FileAccessMethod <FileAccessMethod>] - [-LoadBalancingScheme <LoadBalancingScheme>] [-MemoryCacheThreshold <Int32>] [-PrivateBytesMax <Int32>] - [-SessionsPerUserMax <Int32>] [-SiteCollectionAnonymousSessionsMax <Int32>] - [-TerminateProcessOnAccessViolation] [-ThrottleAccessViolationsPerSiteCollection <Int32>] - [-UnusedObjectAgeMax <Int32>] [-WhatIf] [-WorkbookCache <String>] [-WorkbookCacheSizeMax <Int32>] - [-UnattendedServiceAccount <PSCredential>] [-UseEffectiveUserName] [-WorkbookModelUsageTracker <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPExcelServiceApplication` cmdlet creates a new Excel Services Application Web service application with new settings. -After you create a new Excel Services Application Web service application, you can use the `Set-SPExcelServiceApplication` cmdlet to modify the global settings of the new application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>New-SPExcelServiceApplication -Name "MyExcelService" -ApplicationPool "SharePoint Services" -``` - -This example creates a new instance of Excel Services Application with the display name MyExcelService. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>New-SPExcelServiceApplication -Name "My Excel Service" -ApplicationPool "SharePoint Services" -SessionsPerUserMax 5 -``` - -This example creates a new instance of Excel Services Application with the display name My Excel Service and allows only five sessions per user for each back-end application server computer that is running Excel Services Application. - - -## PARAMETERS - -### -ApplicationPool -Specifies the existing IIS application pool to run the Web service in for the new Excel Service application. - -The type must be a valid SPIisWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies a friendly name for the new Excel Services Application Web service application. -The name that you use must be a unique name of an Excel Services Application Web service application that is in this farm. -The name can be a maximum of 128 characters. -The default value is Service_numofapplications+1. - -The type must be a valid string; for example, MyExcelServiceApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CachingOfUnusedFilesEnable -Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. -The default is true when the parameter is not specified on the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrossDomainAccessAllowed -Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Specifies that the proxy for this service application is added to the default proxy group of the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedUserConnectionRequired -Requires that encryption is used between the end user and the Excel Services Application server. -The scope of this setting is the logical server. -The default value is None. - -The type must be one of the following: None or Connection. - -```yaml -Type: EncryptedConnectionMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDataConnectionLifetime -Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. -Valid values include: - --1 Never recycle - -1 to 2073600 Remain active 1 second to 24 days. - -The default value is 1800. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileAccessMethod -Specifies the authentication method that Excel Services Application uses to retrieve files. -UseFileAccessAccount specifies that all workbooks always use the credentials of the service account running Excel Services Application. -UseImpersonation specifies that Excel Services Application retrieves the workbook files as the user who is making the request. -The default value is UseImpersonation. - -The type must be one of the following: UseImpersonation or UseFileAccessAccount. - -```yaml -Type: FileAccessMethod -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancingScheme -Specifies the load-balancing schema that is used by the Excel Services Application Web service application for sending requests to different back-end computers that are running Excel Calculation Services. -The default value is WorkbookURL. - -The type must be one of the following: RoundRobin, Local, or WorkbookURL. - -```yaml -Type: LoadBalancingScheme -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryCacheThreshold -Specifies 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. -Setting this value to 0 disables caching of inactive objects. -The default value is 90. - -The type must be an integer in the range of 0 to 95. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel Services Application. -When set to -1, the maximum private bytes defaults to 50 percent of physical memory on the computer. -Valid values include -1 for no limit, and any positive integer. -The default value is -1. - -The type must be -1 or any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerUserMax -Specifies the maximum number of sessions allowed for a user. -If a user reaches this maximum, the oldest session will be deleted when a new session is started. -Valid values include -1 for no limit, and any positive integer. -The default value is 25. - -The type must be -1 or any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollectionAnonymousSessionsMax -Specifies the maximum number of anonymous sessions allowed per site collection. -A value of 0 specifies that no anonymous sessions are allowed. -Valid values include -1 for no limit, 0 to disable the setting, or any positive integer. -The default value is 25. - -The type must be -1, 0, or any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TerminateProcessOnAccessViolation -Terminates Excel Services Application when an access violation occurs in the process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleAccessViolationsPerSiteCollection -Specifies that if a workbook causes an access violation error on Excel Services Application, all files that originate from that workbook's site collection are blocked from loading for the specified period (in seconds). -Existing sessions for files on that site collection are unaffected. -Valid values include 0 to disable the setting, and the range of 1 to 2073600 seconds (24 days). -The default value is 0. - -The type must be an integer value in the range of 0 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnattendedAccountApplicationId -Specifies that the application ID that is used to look up the unattended service account credentials from the secure store service specified by UnattendedAccountSecureServiceAppName. -The secure store service is contacted when this parameter is set and specific error cases occur. -Valid values are alphanumeric strings with a maximum of 256 characters. -The default value is an empty string. - -The type must be a valid string of alphanumeric characters; for example, UnattendedServiceAccountID. - -The unattended account is a single account that all workbooks can use to refresh data. -An unattended account is required when workbook connections specify None for authentication, or when any non-Windows credentials are used to refresh data. - -```yaml -Type: String -Parameter Sets: ExistingTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnusedObjectAgeMax -Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. -Valid values include -1 for no maximum setting, and a positive integer in the range of 1 to 34560 minutes (24 days). -The default value is -1. - -The type must be -1, or an integer in the range of 1 to 34560. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookCache -Specifies the local file system location of the cache that is used for storing workbooks used by Excel Services Application. - -If no value is specified, then the default value is a subdirectory in the system temporary directory. - -The type must be a valid path in either of the following forms: - --- C:\folder_name --- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookCacheSizeMax -Specifies the maximum allowable size, in megabytes, of an individual session. -The default value is 0. - -The type must be any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnattendedServiceAccount -{{Fill UnattendedServiceAccount Description}} - -```yaml -Type: PSCredential -Parameter Sets: NewTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseEffectiveUserName -{{Fill UseEffectiveUserName Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookModelUsageTracker -{{Fill WorkbookModelUsageTracker Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelUserDefinedFunction.md deleted file mode 100644 index 71c7c392e3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPExcelUserDefinedFunction.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: New-SPExcelUserDefinedFunction -schema: 2.0.0 ---- - -# New-SPExcelUserDefinedFunction - -## SYNOPSIS -Adds a new user-defined function to Excel Services Application. - - -## SYNTAX - -``` -New-SPExcelUserDefinedFunction -Assembly <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> - [-AssemblyLocation <AssemblyLocation>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Description <String>] [-Enable] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPExcelUserDefinedFunction` cmdlet adds a user-defined function to an Excel Services Application Web service application. -Excel Services Application uses only user-defined functions that have an entry in the list of user-defined functions. -User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. -The assemblies can perform custom logic or other actions, such as refresh data. -Windows PowerShell cmdlets operate on the entries that are in the list of user-defined functions, but they do not operate on the assemblies. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPExcelServiceApplication | New-SPExcelUserDefinedFunction -Assembly "SampleCompany.SampleApplication.SampleUdf" -AssemblyLocation GAC -``` - -This example adds the SampleComany.SampleApplication.SampleUdf file to every Excel Services Application Web service application in the farm. - -The user-defined function assembly is deployed to the global assembly cache (GAC). - - -## PARAMETERS - -### -Assembly -Specifies the strongly typed name of the assembly. -The name must be unique in the list of user-defined functions. -The name can be a maximum of 4096 alphanumeric characters. - -The type must be a string of alphanumeric characters; for example: - --- SampleCompany.SampleApplication.SampleUdf --- C:\UDFs\SampleUdf.dll --- \\\\MyNetworkServer\UDFs\SampleUdf.dll - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the list of user-defined functions. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssemblyLocation -Specifies the location where the assembly is stored. -The default value is GAC. - -The type must be one of the following: GAC or LocalFile. - -```yaml -Type: AssemblyLocation -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a friendly description for the user-defined function. -The name can be a maximum of 4096 alphanumeric characters. -The default value is an empty string. - -The type must be a valid string of alphanumeric characters; for example, this is the user-defined function for consolidation reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Activates the user-defined function for use with Excel Services Application. -The default value is True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPLogFile.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPLogFile.md deleted file mode 100644 index bf1631c456..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPLogFile.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPLogFile -schema: 2.0.0 ---- - -# New-SPLogFile - -## SYNOPSIS -Creates a new log file. - - -## SYNTAX - -``` -New-SPLogFile [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPLogFile` cmdlet ends the current log file and starts a new log file. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPLogFile -``` - -This example ends the current log file and starts a new log file. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPManagedAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPManagedAccount.md deleted file mode 100644 index 660f9b30e8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPManagedAccount.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPManagedAccount -schema: 2.0.0 ---- - -# New-SPManagedAccount - -## SYNOPSIS -Registers a new managed account. - - -## SYNTAX - -``` -New-SPManagedAccount [-Credential] <PSCredential> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -The `New-SPManagedAccount` cmdlet registers a new managed account for the specified Credential or Username and Password. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$cred = Get-Credential -PS C:\>New-SPManagedAccount -Credential $cred -``` - -This example adds a new managed account to the farm by using credentials that are prompted. - - -## PARAMETERS - -### -Credential -Indicates the Credential object that specifies the credentials of the new managed account. -If you use Credential, you cannot specify Username and Password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPManagedPath.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPManagedPath.md deleted file mode 100644 index 6eda0ec482..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPManagedPath.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPManagedPath -schema: 2.0.0 ---- - -# New-SPManagedPath - -## SYNOPSIS -Creates a new managed path for the given Web application for all host header site collections. - - -## SYNTAX - -### HostHeader -``` -New-SPManagedPath [-RelativeURL] <String> [-HostHeader] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Explicit] [-WhatIf] [<CommonParameters>] -``` - -### WebApplication -``` -New-SPManagedPath [-RelativeURL] <String> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Explicit] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `New-SPManagedPath` cmdlet adds a new managed path to a given Web application or for use with all host header site collections. -If the HostHeader switch is provided, the managed path is shared among all host-named site collections; otherwise, a Web application must be specified to create this managed path within. -The relative URL is a partial URL that represents the managed path. -When the slash mark (/) is used, the root is defined. -If the Explicit parameter is not provided, the new managed path is a wildcard path. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPManagedPath "Teams" -WebApplication "http://somesite/" -``` - -This example creates a Teams managed path for a given Web application (http://somesite). - - -## PARAMETERS - -### -RelativeURL -Specifies the relative URL for the new managed path. - -The type must be a valid partial URL such as site or sites/teams/. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -HostHeader -If this parameter is provided, this managed path applies to all host header site collections. - -```yaml -Type: SwitchParameter -Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the Web application group to add this path. - -The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-0987645a. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Explicit -Specifies whether the managed path is explicit or wildcard. - -If not provided, the managed path is a wildcard path. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPMarketplaceWebServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPMarketplaceWebServiceApplicationProxy.md deleted file mode 100644 index 862c40ae53..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPMarketplaceWebServiceApplicationProxy.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPMarketplaceWebServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPMarketplaceWebServiceApplicationProxy - -## SYNOPSIS -Creates a service application proxy for the app identity data web service. - - -## SYNTAX - -``` -New-SPMarketplaceWebServiceApplicationProxy -Name <String> -ServiceEndpointUri <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPMarketplaceWebServiceApplicationProxy` cmdlet to create a service application proxy for the app identity data web service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPMarketplaceWebServiceApplicationProxy -Name ApplicationIdentityData -ServiceEndpointUri http://server:7800/ApplicationIdentityData.svc -DefaultProxyGroup -``` - -This example adds a proxy named ApplicationIdentityData to the app identity web service. - - -## PARAMETERS - -### -Name -Specifies the name of the service application proxy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpointUri -Specifies the URI of the app identity data web service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies whether to add the service application proxy to the default proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPMetadataServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPMetadataServiceApplication.md deleted file mode 100644 index baf0a21e86..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPMetadataServiceApplication.md +++ /dev/null @@ -1,521 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPMetadataServiceApplication -schema: 2.0.0 ---- - -# New-SPMetadataServiceApplication - -## SYNOPSIS -Creates a new managed metadata service application. - - -## SYNTAX - -### NoQuota -``` -New-SPMetadataServiceApplication -Name <String> [-AdministratorAccount <String>] - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-CacheTimeCheckInterval <Int32>] [-Confirm] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] - [-DatabaseServer <String>] [-FailoverDatabaseServer <String>] [-FullAccessAccount <String>] [-HubUri <String>] - [-MaxChannelCache <Int32>] [-PartitionMode] [-ReadAccessAccount <String>] [-RestrictedAccount <String>] - [-SyndicationErrorReportEnabled] [-WhatIf] [-DisablePartitionQuota] [-DeferUpgradeActions] - [<CommonParameters>] -``` - -### Quota -``` -New-SPMetadataServiceApplication -Name <String> [-AdministratorAccount <String>] - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-CacheTimeCheckInterval <Int32>] [-Confirm] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] - [-DatabaseServer <String>] [-FailoverDatabaseServer <String>] [-FullAccessAccount <String>] [-HubUri <String>] - [-MaxChannelCache <Int32>] [-PartitionMode] [-ReadAccessAccount <String>] [-RestrictedAccount <String>] - [-SyndicationErrorReportEnabled] [-WhatIf] -GroupsPerPartition <Int32> -LabelsPerPartition <Int32> - -PropertiesPerPartition <Int32> -TermSetsPerPartition <Int32> -TermsPerPartition <Int32> - [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPMetadataServiceApplication` cmdlet to create a new managed metadata service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE 1------------- -``` -PS C:\>New-SPMetadataServiceApplication -Name "MetadataServiceApp1" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB1" -``` - -This example creates a new managed metadata service application. - - -### -------------------EXAMPLE 2------------- -``` -PS C:\>New-SPMetadataServiceApplication -Name "MetadataServiceApp2" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB2" -HubUri "http://sitename/" -SyndicationErrorReportEnabled -``` - -This example creates a new managed metadata service application and specifies a content type hub to be used for syndication. -It also enables error reporting during syndication. - - -### -------------------EXAMPLE 3------------- -``` -PS C:\>New-SPMetadataServiceApplication -Name "MetadataServiceApp3" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB3" -PartitionMode -``` - -This example creates a new managed metadata service application that is partitioned, for use by sites in a subscription. - - -## PARAMETERS - -### -Name -Specifies the name of the service application to create. -The name can contain a maximum of 128 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AdministratorAccount -A comma-separated list of user accounts or service accounts in the format \<domain\>\\\<account\> that may create and run the service application. -The accounts must already exist. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies an existing IIS application pool in which to run the new managed metadata service application. - -The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool, or an instance of an SPServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheTimeCheckInterval -Specifies an interval, in seconds, that a front-end Web Server should wait before asking the application server for changes. -This value is set per timer job, client application, or Web application. - -The mininum value is 1, and there is no maximum value. -The default value is 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. - -If SQL authentication is to be used, either DatabaseCredentials must be specified or both the DatabaseUserName and DatabasePassword parameters must be set. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to create for the new managed metadata service application. - -The type must be a valid name of a SQL Server database; for example MeatadataDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid name of a SQL Server database; for example SqlServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host server for the failover database server. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullAccessAccount -Specifies a comma-separated set of application pool accounts in the format \<domain\>\\\<account\> that will be given read/write permission to the managed metadata service's term store and content type gallery. -The accounts must already exist. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HubUri -Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxChannelCache -Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server should hold open to the application server. - -This value is set per timer job, client application, or Web application. - -The minimum value is 0, and there is no maximum value. The default value is 4. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restrict data by subscription. - -Note This property cannot be changed after the service application has been created. - -This property has no effect on SharePoint Server 2019. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadAccessAccount -Specifies a comma-separated set of application pool accounts in the format \<domain\>\\\<account\> that will be given read-only permission to the managed metadata service's term store and content type gallery. - -The accounts must already exist. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictedAccount -Specifies a comma-separated set of application pool accounts in the format \<domain\>\\\<account\> that will be given permission to read the managed metadata service's term store and content type gallery; and permission to write to open term sets and local term sets and to create new enterprise keywords. - -The accounts must already exist. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyndicationErrorReportEnabled -Enables reporting of errors when content types are imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisablePartitionQuota -Disables partition quotas. - -```yaml -Type: SwitchParameter -Parameter Sets: NoQuota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupsPerPartition -Sets the maximum number of Term Groups per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabelsPerPartition -Sets the maximum number of Labels per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertiesPerPartition -Sets the maximum number of Properties per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TermSetsPerPartition -Sets the maximum number of Term Sets per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TermsPerPartition -Sets the maximum number of Terms per partition. -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPMetadataServiceApplicationProxy.md deleted file mode 100644 index 27a5049f8a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPMetadataServiceApplicationProxy.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPMetadataServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPMetadataServiceApplicationProxy - -## SYNOPSIS -Creates a new connection to a managed metadata service application. - - -## SYNTAX - -``` -New-SPMetadataServiceApplicationProxy -Name <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-ContentTypePushdownEnabled] [-ContentTypeSyndicationEnabled] [-DefaultProxyGroup] - [-DefaultKeywordTaxonomy] [-DefaultSiteCollectionTaxonomy] [-PartitionMode] - [-ServiceApplication <SPMetadataServiceCmdletPipeBind>] [-Uri <String>] [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -Use the `New-SPMetadataServiceApplicationProxy` cmdlet to create a new connection to a managed metadata service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE 1---------------- -``` -PS C:\>New-SPMetadataServiceApplicationProxy -Name "MetadataServiceProxy1" -ServiceApplication "MetadataServiceApp1" -``` - -This example creates a connection to a managed metadata service application in the local farm. - - -### -------------------EXAMPLE 2---------------- -``` -PS C:\>New-SPMetadataServiceApplicationProxy -Name "MetadataServiceProxy3" -ServiceApplication "MetadataServiceApp3" -PartitionMode -``` - -This example creates a partitioned connection to a managed metadata service application in the local farm. - - -## PARAMETERS - -### -Name -Specifies the display name of the service application proxy to create. -The name can contain a maximum of 128 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypePushdownEnabled -Specifies that existing instances of changed content types in subsites and libraries will be updated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypeSyndicationEnabled -Specifies that this connection will provide access to the content types that are associated with the managed metadata service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the connection be added to the default proxy group for the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultKeywordTaxonomy -Specifies that new enterprise keywords will be stored in the term store associated with the managed metadata service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSiteCollectionTaxonomy -Specifies that the term set that is created when you create a new managed metadata column will be stored in the term store associated with the managed metadata application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restrict data by subscription. - -This property cannot be changed after the service application proxy has been created. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the local managed metadata service application to connect to. -The service application must exist on the local farm. - -The type must be a valid GUID; a valid name of the service application; or an instance of a valid SPMetadataServiceApplication object. - -```yaml -Type: SPMetadataServiceCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI of a remote managed metadata service application to connect to. - -To specify the managed metadata service application that this proxy is connecting to, you must set only the URI parameter or only the ServiceApplication parameter. - -The type must be a valid URL, in the form urn:schemas-microsoft-com:sharepoint:service:fa5c65ebed244a15817768825004f3a7#authority=urn:uuid:acdd6deff6sd4bb899f5beb42051bf3b7&authority=https:// \<server\>:32844/Topology/topology.svc. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplication.md deleted file mode 100644 index 33b85cb9ea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplication.md +++ /dev/null @@ -1,709 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPPerformancePointServiceApplication -schema: 2.0.0 ---- - -# New-SPPerformancePointServiceApplication - -## SYNOPSIS -Creates a new service application for the PerformancePoint Service. - - -## SYNTAX - -``` -New-SPPerformancePointServiceApplication [-Name] <String> - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AnalyticQueryCellMax <Int32>] - [-AnalyticQueryLoggingEnabled <Boolean>] [-ApplicationCacheEnabled <Boolean>] - [-ApplicationCacheMinimumHitCount <Int32>] [-ApplicationProxyCacheEnabled <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [-CommentsDisabled <Boolean>] [-CommentsScorecardMax <Int32>] - [-Confirm] [-DatabaseFailoverServer <String>] [-DatabaseName <String>] [-DatabaseServer <String>] - [-DatabaseSQLAuthenticationCredential <PSCredential>] [-DataSourceQueryTimeoutSeconds <Int32>] - [-DecompositionTreeMaximum <Int32>] [-ElementCacheSeconds <Int32>] [-FilterRememberUserSelectionsDays <Int32>] - [-FilterTreeMembersMax <Int32>] [-IndicatorImageCacheSeconds <Int32>] [-MSMQEnabled <Boolean>] - [-MSMQName <String>] [-SelectMeasureMaximum <Int32>] [-SessionHistoryHours <Int32>] - [-ShowDetailsInitialRows <Int32>] [-ShowDetailsMaxRows <Int32>] [-ShowDetailsMaxRowsDisabled <Boolean>] - [-TrustedContentLocationsRestricted <Boolean>] [-TrustedDataSourceLocationsRestricted <Boolean>] [-WhatIf] - [-AnalyticResultCacheMinimumHitCount <Int32>] [-DataSourceUnattendedServiceAccountTargetApplication <String>] - [-FilterSearchResultsMax <Int32>] [-UseEffectiveUserName <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPPerformancePointServiceApplication` cmdlet creates a new PerformancePoint Service on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE------------------------ -``` -PS C:\>New-SPPerformancePointServiceApplication -Name PPS_Application_01 -ApplicationPool PPS_Application_Pool_01 -``` - -This example creates a new PerformancePoint Service application named PPSApp_01 and sets it to run under an application pool named PPS_Application_Pool_01. - - -## PARAMETERS - -### -Name -Specifies the name of the new PerformancePoint Service application. - -The type must be a valid name of a PerformancePoint Service application; for example, PerfPointApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS application pool to run the Web service in for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AnalyticQueryCellMax -Specifies the maximum number of returned cells in an analytic grid. - -A valid integer value from 1 through 1,000,000,000. -The default value is 100,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnalyticQueryLoggingEnabled -Turns on verbose logging of query events. - -The type must be one of the following: True or False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationCacheEnabled -Specifies whether the rendered output cache on the application server is on (True) or off (False). -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationCacheMinimumHitCount -Specifies the minimum number of times rendered output must be requested before it is added to cache. -The default value is 2. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationProxyCacheEnabled -Specifies rendered output cache on the front end Web server. -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommentsDisabled -Specifies that users can add comments to scorecard cells. - -The type must be one of the following: true or false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsScorecardMax -Specifies the maximum number of comments that can be added to a scorecard. -The default value is 1000. - -The type must be an integer value from 1 through 1,000,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer -Specifies the name of the database server that contains the PerformancePoint Services database that must be mirrored. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the PerformancePoint Services database that will be created when the service application is provisioned. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the database server where the PerformancePoint Services database will be created. -This should be the same server name that is used for the SharePoint content and configuration databases. - -The value may be written as SQL instance\server if it is not referring to the default instance. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseSQLAuthenticationCredential -Determines whether to use Windows authentication or SQL Server authentication when connecting to a PerformancePoint Services database. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataSourceQueryTimeoutSeconds -Specifies the time, in seconds, before a data source query times out. -The default value is 300. - -The type must be an integer value in the range of 1 to 36,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecompositionTreeMaximum -Specifies the maximum number of items (per level) returned to the decomposition tree visualization. - -A valid integer value from 1 through 1,000,000. -The default value is 25. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElementCacheSeconds -Specifies the first class object cache expiration time. -The default value is 15. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterRememberUserSelectionsDays -Specifies the number of days that user filter selections are remembered. -The default value is 90. - -The type must be an integer value from 1 through 10,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterTreeMembersMax -Specifies the maximum number of records to show in filter treeview control. -The default value is 500. - -The type must be an integer value from 1 through 100,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IndicatorImageCacheSeconds -Specifies the time, in seconds, that key performance indicator (KPI) icons are cached. -The default value is 10. - -The type must be an integer value from 1 through 3,600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MSMQEnabled -Specifies that notifications are sent to Microsoft Message Queuing (MSMQ) on content change. - -The type must be one of the following: true or false. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MSMQName -Specifies the name of the queue. -The queue name can contain a maximum of 380 characters, and cannot contain the following characters: CR (ASCII 13), LF (ASCII 10), backslash (\\), plus sign (+, comma (,), or quotation marks (""). - -The type must be a valid MSMQ name; for example, MessageQueue1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelectMeasureMaximum -Specifies the maximum number of measures to show in a dashboard Select Measure control. -The default value is 1000. - -The type must be an integer value from 1 through 1,000,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionHistoryHours -Specifies the number of hours between clearing expired user navigation history. -The default value is 2. - -The type must be an integer value from 1 through 48. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetailsInitialRows -Specifies the initial number of rows to retrieve for show details. -The default value is 1,000. - -The type must be an integer value from 1 through 100,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetailsMaxRows -Specifies the maximum number of rows to retrieve for show details. - -The type must be an integer value from 1 through 1,000,000. -The default value is 10,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetailsMaxRowsDisabled -Turns off the ShowDetailsInitialRows setting. -If set to True, Analysis Services controls limit. - -The type must be one of the following: True or False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedContentLocationsRestricted -Specifies that only specified locations are trusted. -The default setting is false (trust all content locations). - -The type must be one of the following: True or False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedDataSourceLocationsRestricted -Specifies that only specified locations are trusted. -The default setting is false (trust all data source locations). - -The type must be one of the following: True or False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnalyticResultCacheMinimumHitCount -The minimum number of times an analytic report needs to be accessed before caching starts happening. - -The default value is 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: harePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataSourceUnattendedServiceAccountTargetApplication -The name of the Secure Store Application that will be used by default to access data sources. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterSearchResultsMax -The maximum number of items to return on a Dashboard when viewing a filter. - -The default value is 5000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseEffectiveUserName -Enables the use of the Analysis Services Effective User Name feature. - -The type must be one of the following: True or False. The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplicationProxy.md deleted file mode 100644 index b078ed1fc5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplicationProxy.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPPerformancePointServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPPerformancePointServiceApplicationProxy - -## SYNOPSIS -Creates a proxy for a PerformancePoint Service application. - - -## SYNTAX - -``` -New-SPPerformancePointServiceApplicationProxy [-Name] <String> - -ServiceApplication <SPPerformancePointMonitoringServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Default] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPPerformancePointServiceApplicationProxy` cmdlet creates a proxy for a PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE-------------------- -``` -PS C:\>New-SPPerformancePointServiceApplicationProxy -Name PPS_Application_Proxy_01 -ServiceApplication PPS_Application_01 -Default -``` - -This example creates a new PerformancePoint Service application proxy named PPS_Application_Proxy_01, associated with the service application named PPS_Application_01 and is added to the Default proxy group. - - -## PARAMETERS - -### -Name -Specifies the name of the PerformancePoint Service application proxy to create. - -The type must be a valid name of a PerformancePoint Service application proxy; for example, PerfPointAppProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the PerformancePoint Service application that is associated with the new service application proxy. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Specifies that the new application proxy will be added to the default service application proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplicationTrustedLocation.md deleted file mode 100644 index 51cc9df844..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPerformancePointServiceApplicationTrustedLocation.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPPerformancePointServiceApplicationTrustedLocation -schema: 2.0.0 ---- - -# New-SPPerformancePointServiceApplicationTrustedLocation - -## SYNOPSIS -Creates a new trusted location for a PerformancePoint Service application. - - -## SYNTAX - -``` -New-SPPerformancePointServiceApplicationTrustedLocation - -ServiceApplication <SPPerformancePointMonitoringServiceApplicationPipeBind> - -TrustedLocationType <TrustedFileType> -Type <RepositoryLocationType> -Url <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPPerformancePointServiceApplicationTrustedLocation` cmdlet creates a new trusted location for a PerformancePoint Service application. -The new trusted location can be a Content or Data Source trusted location type and is enforced only when it is enabled in the PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE--------------------- -``` -PS C:\>New-SPPerformancePointServiceApplicationTrustedLocation -ServiceApplication PPSApp_01 -url "http://some_valid_site_url/" -Type Site -TrustedLocationType Content -``` - -This example creates a new TrustedLocation for the PPSApp_01 service application. -This creates a Content trusted location of type Site with the specified URL. - - -## PARAMETERS - -### -ServiceApplication -Specifies the PerformancePoint Service application to which the new trusted location will be added. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TrustedLocationType -Specifies the type of trusted locations to create. -If TrustedLocationType is not specified, this cmdlet creates all the trusted locations for the specified PerformancePoint Service application. - -The type must be one of the following: Content or Data Source. - -```yaml -Type: TrustedFileType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of trusted location. - -The type must be one of the following: Site Collection, Site, Document Library, List - -```yaml -Type: RepositoryLocationType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the URL of the trusted location site, site collection, site, document library, or list. -The type must be a valid URL, in the form http://server_name, or http://server_name/sitecollection/site/list. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the new safe data provider. - -The type must be a valid string with a maximum of 4096 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPowerPointConversionServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPPowerPointConversionServiceApplication.md deleted file mode 100644 index 837d3c0d90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPowerPointConversionServiceApplication.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Powerpoint.dll-Help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPPowerPointConversionServiceApplication -schema: 2.0.0 ---- - -# New-SPPowerPointConversionServiceApplication - -## SYNOPSIS -Creates a PowerPoint Conversion Service application. - - -## SYNTAX - -``` -New-SPPowerPointConversionServiceApplication [-Name] <String> - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -Use the `New-SPPowerPointConversionServiceApplication` cmdlet to create a new instance of a PowerPoint Conversion Service application by using the Name parameter. - -After the PowerPoint Conversion Service application is created, you can convert PowerPoint presentations to various formats. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPPowerPointConversionServiceApplication -Name "MyWorkgroupPPTApp" -ApplicationPool "SharePoint Web Services Default" -``` - -This example creates a new instance of the PowerPoint Conversion Service application named MyWorkgroupPPTApp and assigns it to the default application pool. - - -## PARAMETERS - -### -Name -Specifies the name of the PowerPoint Conversion Service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Assigns an application pool that Internet Information Services (IIS) will use for this service application. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPPowerPointConversionServiceApplicationProxy](New-SPPowerPointConversionServiceApplicationProxy.md) - -[Set-SPPowerPointConversionServiceApplication](Set-SPPowerPointConversionServiceApplication.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPowerPointConversionServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPPowerPointConversionServiceApplicationProxy.md deleted file mode 100644 index 5c4e677a57..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPPowerPointConversionServiceApplicationProxy.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Powerpoint.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPPowerPointConversionServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPPowerPointConversionServiceApplicationProxy - -## SYNOPSIS -Creates a PowerPoint Conversion Service application proxy. - - -## SYNTAX - -``` -New-SPPowerPointConversionServiceApplicationProxy [-Name] <String> - -ServiceApplication <SPPowerPointConversionServiceApplicationPipeBind> [-AddToDefaultGroup] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPPowerPointConversionServiceApplicationProxy` cmdlet to create a PowerPoint Conversion Service application proxy. -The service application proxy is instantiated on the front-end web server and acts as an intermediary between the client computer and the service application back end. - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPPowerPointConversionServiceApplicationProxy -Name "MyWorkgroupPPTAppProxy" -ServiceApplication "MyWorkgroupPPTApp" -AddtoDefaultGroup -``` - -This example creates a new instance of the PowerPoint Conversion Service application proxy named MyWorkgroupPPTAppProxy, binds it to the MyWorkgroupPPTApp service application and then adds it to the default service application proxy group - - -## PARAMETERS - -### -Name -Specifies the name of the service application proxy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the name of the service application to bind. - -```yaml -Type: SPPowerPointConversionServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AddToDefaultGroup -Adds the newly created proxy to the default service application proxy group. -If not specified, the proxy is not added to a group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPPowerPointConversionServiceApplication](New-SPPowerPointConversionServiceApplication.md) - -[Set-SPPowerPointConversionServiceApplication](Set-SPPowerPointConversionServiceApplication.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProfileServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPProfileServiceApplication.md deleted file mode 100644 index 2e7d95f568..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProfileServiceApplication.md +++ /dev/null @@ -1,489 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPProfileServiceApplication -schema: 2.0.0 ---- - -# New-SPProfileServiceApplication - -## SYNOPSIS -Adds a User Profile Service Application to a farm. - - -## SYNTAX - -### Default -``` -New-SPProfileServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-Name <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MySiteHostLocation <SPSitePipeBind>] - [-PartitionMode] [-ProfileDBCredentials <PSCredential>] [-ProfileDBName <String>] [-ProfileDBServer <String>] - [-ProfileSyncDBCredentials <PSCredential>] [-ProfileDBFailoverServer <String>] [-ProfileSyncDBName <String>] - [-ProfileSyncDBServer <String>] [-ProfileSyncDBFailoverServer <String>] [-SocialDBCredentials <PSCredential>] - [-SocialDBName <String>] [-SocialDBServer <String>] [-SocialDBFailoverServer <String>] [-WhatIf] - [-DeferUpgradeActions] [<CommonParameters>] -``` - -### MySiteSettings -``` -New-SPProfileServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-Name <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] -MySiteHostLocation <SPSitePipeBind> - [-MySiteManagedPath <SPPrefixPipeBind>] [-PartitionMode] [-ProfileDBCredentials <PSCredential>] - [-ProfileDBName <String>] [-ProfileDBServer <String>] [-ProfileSyncDBCredentials <PSCredential>] - [-ProfileDBFailoverServer <String>] [-ProfileSyncDBName <String>] [-ProfileSyncDBServer <String>] - [-ProfileSyncDBFailoverServer <String>] [-SiteNamingConflictResolution <String>] - [-SocialDBCredentials <PSCredential>] [-SocialDBName <String>] [-SocialDBServer <String>] - [-SocialDBFailoverServer <String>] [-WhatIf] [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. - -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `New-SPProfileServiceApplication` cmdlet adds and creates a new profile service application, or creates an instance of a profile service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPProfileServiceApplication -Name 'User Profile Service Application' -ApplicationPool 'SharePoint Web Services Default' -ProfileDBName Profile -SocialDBName Social -ProfileSyncDBname Sync -``` - -This example creates a new User Profile Service application. - - -## PARAMETERS - -### -ApplicationPool -Specifies the existing IIS application pool in which to run the Web service for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the display name for the new User Profile Service application. -The name must be a unique name of a User Profile Service application in this farm. -The name can be a maximum of 64 characters. - -The type must be a valid name of a service application; for example, UserProfileSvcApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MySiteHostLocation -Specifies the site collection where the My Site will be created. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MySiteManagedPath -Specifies the managed path where personal sites will be created. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restrict data by site group. -After the PartitionMode parameter is set and the service application is created, it cannot be changed. - -This property has no effect on SharePoint Server 2019. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileDBCredentials -Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileDBName -Specifies the name of the database where the User Profile database is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileDBServer -Specifies the database where the User Profile database will be created. - -The type must be a valid name of a SQL Server database; for example, ProfileAppDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileSyncDBCredentials -Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileDBFailoverServer -Associates a content database with a specific failover server that is used in conjunction with SQL Server database mirroring. -The server name is the required value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileSyncDBName -Specifies the database where the Profile Sync database will be created. - -The type must be a valid name of a SQL Server database; for example, ProfileSyncAppDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileSyncDBServer -Specifies the database server that will host the Profile Sync database that is specified in the ProfileSyncDBName parameter. - -The type must be a valid name of a SQL Server host; for example, SQLServerProfileSyncHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileSyncDBFailoverServer -Associates a Profile Sync database with a specific failover server that is used in conjunction with SQL Server database mirroring. -The server name is the required value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteNamingConflictResolution -Specifies the format to use to name personal sites. - -Use one of the following integer values: - -1 Personal site collections are to be based on user names without any conflict resolution. -For example, http://portal_site/location/username/ - -2 Personal site collections are to be based on user names with conflict resolution by using domain names. -For example, .../username/ or .../domain_username/ - -3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. -For example, http://portal_site/location/domain_username/ - -The default value is 1 (do not resolve conflicts). - -```yaml -Type: String -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialDBCredentials -The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialDBName -Specifies the database where the Social database will be created. - -The type must be a valid name of a SQL Server host; for example, SQLServerSocialHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialDBServer -Specifies the database server that will host the Social database that is specified in SocialDBName. - -The type must be a valid name of a SQL Server host; for example, SQLServerSocialHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialDBFailoverServer -Associates a Social database with a specific failover server that is used in conjunction with SQL Server database mirroring. -The server name is the required value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProfileServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPProfileServiceApplicationProxy.md deleted file mode 100644 index 5e806b7b5f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProfileServiceApplicationProxy.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPProfileServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPProfileServiceApplicationProxy - -## SYNOPSIS -Creates a User Profile Service application proxy on the local farm. - - -## SYNTAX - -### Application -``` -New-SPProfileServiceApplicationProxy -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-Name <String>] - [-PartitionMode] [-WhatIf] [<CommonParameters>] -``` - -### Uri -``` -New-SPProfileServiceApplicationProxy -Uri <Uri> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultProxyGroup] [-Name <String>] [-PartitionMode] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `New-SPProfileServiceApplicationProxy` creates a User Profile Service application proxy on the local farm. -The proxy is added to the default proxy group for the local farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$sa = New-SPProfileServiceApplication -Name 'User Profile Service Application' -ApplicationPool 'SharePoint Web Services Default' -ProfileDBName Profile -SocialDBName Social -ProfileSyncDBname Sync -PS C:\>New-ProfileServiceApplicationProxy -Name 'User Profile Service Application Proxy' -ServiceApplication $sa -DefaultProxyGroup -``` - -This example creates a new User Profile Service application proxy. - - -## PARAMETERS - -### -ServiceApplication -Specifies the local User Profile Service application that is associated with the new proxy. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription User Profile Service application (for example, ProfileSvcApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: Application -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -The URI of the remote user profile service application this proxy should communicate with. -This value is required only if you plan to connect a User Profile Service application from a remote farm. - -```yaml -Type: Uri -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the User Profile Service application proxy be added to the default proxy group for the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name for the new User Profile Service application. -The name that you use must be a unique name of a User Profile Service application in this farm. -The name can be a maximum of 128 characters. - -The type must be a name of a valid User Profile Service application proxy; for example, UserProfileSvcProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restrict data by site group. -After the PartitionMode parameter is set and the service application is created, it cannot be changed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProjectServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPProjectServiceApplication.md deleted file mode 100644 index fe53a656f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProjectServiceApplication.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: New-SPProjectServiceApplication -schema: 2.0.0 ---- - -# New-SPProjectServiceApplication - -## SYNOPSIS -Creates a new Project Server Service application. - - -## SYNTAX - -``` -New-SPProjectServiceApplication [-Name] <String> -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Proxy] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPProjectServiceApplication` cmdlet creates a new Project Server Service application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>New-SPProjectServiceApplication -Name "PsiApplication" -ApplicationPool "PsiApplicationPool" -Proxy -``` - -This example creates a Project Server Service application with the name PsiApplication and an application pool with the name PsiApplicationPool and it creates a Project Server Service application proxy for the application. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPIisWebServiceApplicationPool "PsiApplicationPool" | New-SPProjectServiceApplication -Name "PsiApplication" -``` - -This example creates a Project Server Service application with the name PsiApplication. -The result is piped using an application pool object. - - -## PARAMETERS - -### -ApplicationPool -Specifies the existing IIS application pool to run the Web service in for the new service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new Project Server Service application. - -The type must be a valid name of a Project Server Service application; for example, ProjectWebApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Proxy -Specifies that a proxy for new service application is automatically created. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProjectServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPProjectServiceApplicationProxy.md deleted file mode 100644 index 24438755fb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPProjectServiceApplicationProxy.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: New-SPProjectServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPProjectServiceApplicationProxy - -## SYNOPSIS -Creates a proxy for a Project Server Service application. - - -## SYNTAX - -``` -New-SPProjectServiceApplicationProxy [-Name] <String> -ServiceApplication <PsiServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPProjectServiceApplicationProxy` cmdlet creates a proxy for a Project Server Service application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### -------------------EXAMPLE 1------------------ -``` -PS C:\>New-SPProjectServiceApplicationProxy -Name PsiApplicationProxy -ServiceApplication PsiApplication -``` - -This example creates a Project Server Service application proxy with the name PsiApplicationProxy for the application PsiApplication. - - -### -------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPServiceApplication | ?{ $_.Name -eq "PsiApplication" } | New-SPProjectServiceApplicationProxy -Name "PsiApplicationProxy" -Default -``` - -This example creates a Project Server Service application proxy with the name PsiApplicationProxy for the application PsiApplication and adds the proxy to the Default proxy group. - - -## PARAMETERS - -### -Name -Specifies the name of the new proxy. - -The type must be a valid name of a Project Server Service application proxy; for example, ProjectSvcProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the Project Server Service application to associate with the new proxy. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPRequestManagementRuleCriteria.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPRequestManagementRuleCriteria.md deleted file mode 100644 index e5e28cd7f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPRequestManagementRuleCriteria.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPRequestManagementRuleCriteria -schema: 2.0.0 ---- - -# New-SPRequestManagementRuleCriteria - -## SYNOPSIS -Creates criteria for the rule to match. - - -## SYNTAX - -### CustomPropertyParameterSet -``` -New-SPRequestManagementRuleCriteria [-Value] <String> [-CustomHeader] <String> [-CaseSensitive] - [[-MatchType] <SPRequestManagementRuleMatchType>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -### StandardParameterSet -``` -New-SPRequestManagementRuleCriteria [-Value] <String> [-Property] <SPRequestManagementRulePropertyType> - [-CaseSensitive] [[-MatchType] <SPRequestManagementRuleMatchType>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `New-SPRequestManagementRuleCriteria` cmdlet to create criteria for the rule to match. - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPRequestManagementRuleCriteria -Property Host -Value Client01 -MatchType Equals -``` - -This example creates a new rule that matches the Host 'Client01'. - -## PARAMETERS - -### -Value -Specifies a value for the rule to match. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomHeader -Specifies the custom header for the rule. - -```yaml -Type: String -Parameter Sets: CustomPropertyParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -Specifies a header for a value to match. - -The following are the valid values: - ---Url - ---Urlreferrer - ---UserAgent - ---Host - ---IP - ---HttpMethod - ---SoapAction - ---CustomHeader - -```yaml -Type: SPRequestManagementRulePropertyType -Parameter Sets: StandardParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CaseSensitive -Specifies whether or not the match is case sensitive. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchType -Defines operators for the match. - -The following are the valid values: - ---Equals - ---Regex - ---StartsWith - ---EndsWith - -```yaml -Type: SPRequestManagementRuleMatchType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPRequestManagementSettings](Get-SPRequestManagementSettings.md) - -[Set-SPRequestManagementSettings](Set-SPRequestManagementSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreApplication.md deleted file mode 100644 index 24e5644ee6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreApplication.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSecureStoreApplication -schema: 2.0.0 ---- - -# New-SPSecureStoreApplication - -## SYNOPSIS -Creates a new Secure Store application. - - -## SYNTAX - -``` -New-SPSecureStoreApplication -ServiceContext <SPServiceContextPipeBind> -TargetApplication <TargetApplication> - [-Administrator <SPClaim[]>] [-AssignmentCollection <SPAssignmentCollection>] - [-CredentialsOwnerGroup <SPClaim[]>] -Fields <TargetApplicationField[]> [-TicketRedeemer <SPClaim[]>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPSecureStoreApplication` cmdlet creates a new Secure Store application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$usernameField = New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false -PS C:\>$passwordField = New-SPSecureStoreApplicationField -Name "Password" -Type WindowsPassword -Masked:$true -PS C:\>$fields = $usernameField,$passwordField -PS C:\>$userClaim = New-SPClaimsPrincipal -Identity "CONTOSO\janedoe" -IdentityType WindowsSamAccountName -PS C:\>$contosoTargetApp = New-SPSecureStoreTargetApplication -Name "ContosoTargetApplication" -FriendlyName "Contoso Target Application" -ApplicationType Group -PS C:\>New-SPSecureStoreApplication -ServiceContext http://contoso -TargetApplication $contosoTargetApp -Fields $fields -Administrator $userClaim -``` - -This example creates a new group target application ContosoTargetApplication and then a new application for that target application. This new application has two fields; UserName of type WindowsUserName and Password of type WindowsPassword. The user with identity janedoe on the CONTOSO domain is set as the target application administrator. - - -## PARAMETERS - -### -ServiceContext -Specifies the service context for the target application. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetApplication -Specifies information about the target application. -For example, the TargetApplication object includes data values for application name, display name, contact info, enable ticketing flag and URL address to set the credential. -The schema for the TargetApplication object is defined in the ISecureSToreProviderExtended interface that exposes the target application metadata. - -```yaml -Type: TargetApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Administrator -Specifies the administrator of the new Secure Store application. - -```yaml -Type: SPClaim[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CredentialsOwnerGroup -Specifies the claims object for the groups that own the group credentials. - -```yaml -Type: SPClaim[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -Specifies the field information for the application. -The default fields are username and password. - -```yaml -Type: TargetApplicationField[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TicketRedeemer -Specifies the ticket redeemer claim value. - -```yaml -Type: SPClaim[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreApplicationField.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreApplicationField.md deleted file mode 100644 index 32ebf77d97..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreApplicationField.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSecureStoreApplicationField -schema: 2.0.0 ---- - -# New-SPSecureStoreApplicationField - -## SYNOPSIS -Creates a new Secure Store application fields object. - - -## SYNTAX - -``` -New-SPSecureStoreApplicationField [-Masked] -Name <String> -Type <SecureStoreCredentialType> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPSecureStoreApplicationField` cmdlet creates a new Secure Store application field object for a target application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false -``` - -This example creates a new credential field of type WindowsUserName with the name UserName and the masked property (which when true will hide characters as they are typed in by the user) set to false. -This cmdlet is typically used in conjunction with the `New-SPSecureStoreApplication` cmdlet. - - -## PARAMETERS - -### -Masked -Masks the visible characters that are typed in the field. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new target application field. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of credential field to add to a target application. - -The type must be one of the following: UserName, Password, Pin, Key, Generic, WindowsUserName, or WindowsPassword. - -```yaml -Type: SecureStoreCredentialType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreServiceApplication.md deleted file mode 100644 index 488d24bed9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreServiceApplication.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSecureStoreServiceApplication -schema: 2.0.0 ---- - -# New-SPSecureStoreServiceApplication - -## SYNOPSIS -Creates a new Secure Store Service application in the farm. - - -## SYNTAX - -``` -New-SPSecureStoreServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AuditingEnabled] [-Name <String>] [-AssignmentCollection <SPAssignmentCollection>] - [-AuditlogMaxSize <Int32>] [-Confirm] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] - [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] - [-FailoverDatabaseServer <String>] [-PartitionMode] [-Sharing] [-WhatIf] [-DeferUpgradeActions] - [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPSecureStoreServiceApplication` cmdlet creates a new Secure Store Service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>New-SPSecureStoreServiceApplication -ApplicationPool 'SharePoint Web Services Default' -AuditingEnabled:$false -DatabaseName 'Secure Store' -Name 'Secure Store Service Application' -``` - -This example creates a new Secure Store Service application with the name Contoso Secure Store with auditing disabled and creates a database with the name ContosoSSDatabase on the given database server for use with the service application. - - -## PARAMETERS - -### -ApplicationPool -Specifies the existing IIS application pool to run the Web service in for the new service application. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditingEnabled -Turns on auditing for the Secure Store Service. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new Secure Store Service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuditlogMaxSize -Specifies the number of days to retain the audit log. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the Secure Store service database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user specified in DatabaseUserName. -Use this parameter only if SQL authentication is used to access the metadata service application database. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user name to use for connecting to the database for the Secure Store service application. -Use this parameter only if SQL authentication is used to access the service application database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host server for the failover database server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restricts data by subscription ID. -This property cannot be changed after the service application is created. - -This property has no effect on SharePoint Server 2019. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sharing -Specifies that the Secure Store service application is published and shared across the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreServiceApplicationProxy.md deleted file mode 100644 index 2e323adf60..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreServiceApplicationProxy.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSecureStoreServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPSecureStoreServiceApplicationProxy - -## SYNOPSIS -Creates a new Secure Store Service application proxy in the farm. - - -## SYNTAX - -### PipeBind -``` -New-SPSecureStoreServiceApplicationProxy -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-Name <String>] [-WhatIf] - [<CommonParameters>] -``` - -### Uri -``` -New-SPSecureStoreServiceApplicationProxy -Uri <Uri> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultProxyGroup] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `New-SPSecureStoreServiceApplicationProxy` cmdlet creates a new Secure Store Service application proxy for a Secure Store Service application in the farm. - -The `New-SPSecureStoreServiceApplicationProxy` cmdlet does not specify whether the service application proxy is partitioned or not. -If you want to specify a partitioned service application proxy, a partitioned service application can be created by using the `New-SPSecureStoreServiceApplication` cmdlet. -The result of the `New-SPSecureStoreServiceApplication` cmdlet can be passed to the `New-SPSecureStoreServiceApplicationProxy` cmdlet. -Similarly, if you want to specify an unpartitioned service application proxy, an unpartitioned service application can be created by using the `New-SPSecureStoreServiceApplication` cmdlet. -The result of the `New-SPSecureStoreServiceApplication` cmdlet can be passed to the `New-SPSecureStoreServiceApplicationProxy` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$sa = New-SPSecureStoreServiceApplication -ApplicationPool 'SharePoint Web Services Default' -AuditingEnabled:$false -DatabaseName 'Secure Store' -Name 'Secure Store Service Application' -PS C:\>New-SPSecureStoreServiceApplicationProxy -Name 'Secure Store Service Application Proxy' -ServiceApplication $sa -``` - -This example creates a new Secure Store Service application and proxy. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$nameofproxy = "Connection to: HostedSecureStoreInParentFarm" -PS C:\>$proxy = Get-SPServiceApplicationProxy | where {$_ -match $nameofproxy} -PS C:\>$prop = $proxy.Properties -PS C:\>$type = $prop["Microsoft.Office.Server.Utilities.SPPartitionOptions"].GetType() -PS C:\>$partition = [enum]::Parse( $type, 1 ) -PS C:\>$prop["Microsoft.Office.Server.Utilities.SPPartitionOptions"] = $partition -PS C:\>$proxy.Update() -``` - -This example converts an unpartitioned secure store service application proxy in the child to a partitioned one. - - -## PARAMETERS - -### -ServiceApplication -Specifies the local Secure Store Service application associated with the new proxy. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: PipeBind -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI of a remote Secure Store Service application associated with the new proxy. - -The type must be a valid URI, in the form file:\\\\server_name\sitedocs. - -```yaml -Type: Uri -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the service application proxy be added to the farm's default proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new service application proxy to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreTargetApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreTargetApplication.md deleted file mode 100644 index 51a5a912d6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSecureStoreTargetApplication.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSecureStoreTargetApplication -schema: 2.0.0 ---- - -# New-SPSecureStoreTargetApplication - -## SYNOPSIS -Creates a new Secure Store target application. - - -## SYNTAX - -``` -New-SPSecureStoreTargetApplication -ApplicationType <TargetApplicationType> -FriendlyName <String> - -Name <String> [-AssignmentCollection <SPAssignmentCollection>] [-ContactEmail <String>] - [-SetCredentialsUri <Uri>] [-TimeoutInMinutes <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPSecureStoreTargetApplication` cmdlet creates a new Secure Store Target application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>New-SPSecureStoreTargetApplication -Name "ContosoTargetApplication" -FriendlyName "Contoso Target Application" -ApplicationType Group -``` - -This example creates a new group type target application with the given name and friendly display name. - - -## PARAMETERS - -### -ApplicationType -Specifies the type of target application. - -The type must be one of the following: Individual, Group, IndividualWithTicketing, GroupWithTicketing, RestrictedIndividual, or RestrictedGroup. - -```yaml -Type: TargetApplicationType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the name of the new target application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the new target application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContactEmail -Specifies the contact information for the target application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetCredentialsUri -Specifies the URI for setting the user application credentials. - -The type must be a valid URI, in the form file:\\\\server_name\sitedocs. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutInMinutes -The time, in minutes, a ticket is valid if it is not redeemed by the target application. -Make sure that the ticket time-out value is long enough to last between the time when the ticket is issued to the time that it is redeemed The default value is 2. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPServiceApplicationPool.md deleted file mode 100644 index a277f36e01..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPServiceApplicationPool.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPServiceApplicationPool -schema: 2.0.0 ---- - -# New-SPServiceApplicationPool - -## SYNOPSIS -Creates a new Web service application pool. - - -## SYNTAX - -``` -New-SPServiceApplicationPool [-Name] <String> [-Account] <SPProcessAccountPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPServiceApplicationPool` cmdlet creates a new Web service application pool in Internet Information Services (IIS). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE----------------------- -``` -PS C:\>New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account (Get-SPManagedAccount 'contoso\serviceAccount') -``` - -This example creates a new Web service application pool. - -For the Account parameter, the name of a managed account in the farm can be given. -Use the `Get-SPManagedAccount` cmdlet to view the existing managed account in the farm. -Also, a process account from the output of the `Get-SPProcessAccount` cmdlet can be used. - - -## PARAMETERS - -### -Name -Specifies the name of the new Web service application pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Account -Specifies the credentials that will be the identity of the new application pool. - -```yaml -Type: SPProcessAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPServiceApplicationProxyGroup.md deleted file mode 100644 index 4bde16de9f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPServiceApplicationProxyGroup.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPServiceApplicationProxyGroup -schema: 2.0.0 ---- - -# New-SPServiceApplicationProxyGroup - -## SYNOPSIS -Creates a new service application proxy group. - - -## SYNTAX - -``` -New-SPServiceApplicationProxyGroup [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPServiceApplicationProxyGroup` cmdlet creates a new service application proxy group specified by the Name parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPServiceApplicationProxyGroup -Name RemoteProxyGroup -``` - -This example creates a new service application proxy with the name RemoteProxyGroup. - - -## PARAMETERS - -### -Name -Specifies the name of the new service application proxy group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSite.md deleted file mode 100644 index 9678e31629..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSite.md +++ /dev/null @@ -1,460 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSite -schema: 2.0.0 ---- - -# New-SPSite - -## SYNOPSIS -Creates a new site collection at the specified URL. - - -## SYNTAX - -``` -New-SPSite [-Url] <String> -OwnerAlias <SPUserPipeBind> [-AdministrationSiteType <SPAdministrationSiteType>] - [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <Int32>] [-Confirm] - [-ContentDatabase <SPContentDatabasePipeBind>] [-Description <String>] - [-HostHeaderWebApplication <SPWebApplicationPipeBind>] [-Language <UInt32>] [-Name <String>] - [-OverrideCompatibilityRestriction] [-OwnerEmail <String>] [-QuotaTemplate <SPQuotaTemplatePipeBind>] - [-SecondaryEmail <String>] [-SecondaryOwnerAlias <SPUserPipeBind>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-Template <SPWebTemplatePipeBind>] [-WhatIf] - [-CreateFromSiteMaster] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPSite` cmdlet creates a new site collection with the URL and owner that the Url and OwnerAlias parameters. -This cmdlet can create site collections in either the SharePoint Server mode which uses the legacy versions of templates and features, or can be created in SharePoint Server mode which uses the new versions of templates and features. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>New-SPSite http://webApp/sites/test -OwnerAlias "DOMAIN\JDoe" -Language 1033 -Template STS#0 -``` - -This example creates an English site collection at http://\<site name\>/sites/test that is owned by user DOMAIN\Jdow. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>$w = Get-SPWebApplication http://webApp -PS C:\>New-SPSite http://www.contoso.com -OwnerAlias "DOMAIN\jdow" -HostHeaderWebApplication $w -Name "Contoso" -Template STS#0 -``` - -This example creates a host-named site collection. -Because the template is provided, the root web of this site collection will be created. - - -### ------------------EXAMPLE 3----------------------- -``` -PS C:\>Get-SPWebTemplate | Where{ $_.Title -eq "Team Site" } | ForEach-Object{ New-SPSite http://<site name</sites/test -OwnerAlias DOMAIN\jdow -Template $_ } -``` - -This example creates a site collection by using the "Team Site" Web template. - - -### ------------------EXAMPLE 4----------------------- -``` -PS C:\>New-SPSite -URL http://webApp/sites/testsite -OwnerAlias "DOMAIN\JDow" -Language 1033 -CompatibilityLevel 14 -Template STS#0 -``` - -This example creates an English 14 mode site collection by using the Team site template at http://\<site name\>/sites/testsite that is owned by user DOMAIN\Jdow - - -## PARAMETERS - -### -Url -Specifies the URL that the new site collection uses. - -If the URL is not a host header site, the URL must start with the web application URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OwnerAlias -Specifies the user login name of the site owner. - -The type must be a valid user alias, in the form, Domain\username. - -```yaml -Type: SPUserPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdministrationSiteType -Specifies the site type. - -Valid values are None or TentantAdministration. - -```yaml -Type: SPAdministrationSiteType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. - -This value sets the initial CompatibilityLevel value for the site collection. - -When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the name or GUID of the content database in which to create the new site. If no content database is specified, the site collection is selected automatically. - -The type must be a valid database name in the form, SiteContent1212, or a GUID in the form, 1234-5678-9807. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Describes the new site. - -If no value is specified, the value is left blank. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostHeaderWebApplication -Specifies that if the URL provided is to be a host-named site collection, the HostHeaderWebApplication parameter must be the name, URL, GUID, or SPWebApplication object for the web application in which this site collection is created. - -If no value is specified, the value is left blank. - -The type must be a valid name in one of the following forms: - ---A WebApplication - ---A URL (for example, http://server_name) - ---A GUID (for example, 1234-5678-9876-0987) - - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Specifies the language ID for the new site collection. - -If no language is specified, the site collection is created with the same language that was specified when the product was installed. - -This must be a valid language identifier (LCID). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the title of the new site collection. - -If no name is specified, the default name is applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideCompatibilityRestriction -Specifies whether to use compatibility restriction for site. - -The valid values are True or False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerEmail -Specifies the email address of site owner. -If no value is specified, the value is left blank. - -The type must be a email address in the form, someone@example.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuotaTemplate -Specifies the quota template for the new site.The template must exist already. - -If no template is specified, no quota is applied. - -```yaml -Type: SPQuotaTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryEmail -Specifies the email address of the secondary site owner. If no value is specified, the value is left blank. - -The type must be a email address, in the form, someone@example.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryOwnerAlias -Specifies the user login credentials of the secondary site owner. - -If no value is specified, the value is left blank. - -The type must be a valid user alias, in the form, Domain\username. - -```yaml -Type: SPUserPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the Site Group to get site collections. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the Web template for the root web of the new site collection. - -The template must be already installed. - -If no template is specified, no template is provisioned. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateFromSiteMaster -Specifies whether to create a new site using the Site Master. - -The valid values are True or False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteMaster.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteMaster.md deleted file mode 100644 index de059ddc04..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteMaster.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSiteMaster -schema: 2.0.0 ---- - -# New-SPSiteMaster - -## SYNOPSIS -Creates a site master. - - -## SYNTAX - -``` -New-SPSiteMaster [-ContentDatabase] <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <Int32>] [-Confirm] [-Language <UInt32>] - -Template <SPWebTemplatePipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-SPSiteMaster cmdlet to create a site master information in the farm. - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPSiteMaster -ContentDatabase WSS_Content -Template STS#0 -``` - -This example creates a site master in the database WSS_Content. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. - -When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the name of the database to create the site master in. For example, WSS_Content. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Language -Specifies the locale ID to use. For example, use 1033 for English. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the name of the template. - -The values are the following: - --- SPSPERS#2 - --- SPSPERS#6 - --- SPSPERS#7 - --- SPSPERS#8 - --- SPSPERS#9 - --- SPSPERS#10 - --- STS#0 - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPContentDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteSubscription.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteSubscription.md deleted file mode 100644 index 33ff44d43e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteSubscription.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSiteSubscription -schema: 2.0.0 ---- - -# New-SPSiteSubscription - -## SYNOPSIS -Creates a new site subscription. - - -## SYNTAX - -``` -New-SPSiteSubscription [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPSiteSubscription` cmdlet creates a new subscription to which the SPSites object can belong. -Sites that are members of a site subscription can share settings and configuration information. -A site collection can be a member of only one site subscription and once set, cannot be changed. - -Site subscriptions are not persisted in a database until used in conjunction with either an SPSite or the Site Subscription Settings Service. -After a site subscription is applied to any site collection in the farm, the site subscription can be retrieved by using the `Get-SPSiteSubscription` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` - -PS C:\>$subscription = New-SPSiteSubscription - -``` - -This example creates a new site subscription. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>$subscription = New-SPSiteSubscription -PS C:\>Set-SPSite -Identity http://siteUrl -SiteSubscription $subscription -``` - -This example creates a new Site Subscription and sets it on the site collection http://siteUrl. - - -### ------------------EXAMPLE 3----------------------- -``` -PS C:\>New-SPSite -URL http://siteUrl -OwnerAlias "DOMAIN\JDow" -Language 1033 -SiteSubscription (New-SPSiteSubscription) -``` - -This example creates a new Site Collection at http://siteUrl along with a new Site Subscription. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteSubscriptionFeaturePack.md deleted file mode 100644 index 5807fdad49..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSiteSubscriptionFeaturePack.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSiteSubscriptionFeaturePack -schema: 2.0.0 ---- - -# New-SPSiteSubscriptionFeaturePack - -## SYNOPSIS -Creates a new SharePoint Feature set that can be used to limit the features available to a site subscription. - - -## SYNTAX - -``` -New-SPSiteSubscriptionFeaturePack [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPSiteSubscriptionFeaturePack` cmdlet to create a new SharePoint Feature set that limits the Features available to a specified site subscription. - -SharePoint Feature sets are on an Allow List of SharePoint Features that can be associated with any site subscription. -If a Feature set is assigned to a site subscription, only SPFeatures objects in that Feature set are available for use on the site collections and Webs that are members of the site subscription. -Feature sets contain a list of the GUIDs of each Feature that is on an Allow List for associated site subscriptions. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` - -PS C:\>$fs = New-SPSiteSubscriptionFeaturePack - -``` - -This example creates a new SharePoint Feature Pack and stores it in a variable. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceApplication.md deleted file mode 100644 index 75d5cf6624..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceApplication.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPStateServiceApplication -schema: 2.0.0 ---- - -# New-SPStateServiceApplication - -## SYNOPSIS -Creates a new state service application. - - -## SYNTAX - -``` -New-SPStateServiceApplication [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Database <SPStateDatabasePipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPStateServiceApplication` cmdlet creates a new state service application on the farm. -A state service application is the container for state service databases. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>$db = New-SPStateServiceDatabase -Name 'State Service' -PS C:\>New-SPStateServiceApplication -Name 'State Service' -Database $db -``` - -This example creates a new state service database and a state service application associated with the database. - -## PARAMETERS - -### -Name -Specifies the name of the new service application. - -The type must be a valid name of a service application; for example, StateSvcApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Database -Specifies the state service database that is associated with the new service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceApplicationProxy.md deleted file mode 100644 index 62af03ef74..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceApplicationProxy.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPStateServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPStateServiceApplicationProxy - -## SYNOPSIS -Creates a proxy for a state service application. - - -## SYNTAX - -``` -New-SPStateServiceApplicationProxy [-ServiceApplication] <SPStateServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-DefaultProxyGroup] [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPStateServiceApplicationProxy` cmdlet creates a proxy for a state service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE------------------- -``` -PS C:\>$db = New-SPStateServiceDatabase -Name 'State Service' -PS C:\>$sa = New-SPStateServiceApplication -Name 'State Service' -Database $db -PS C:\>New-SPStateServiceApplicationProxy -Name 'State Service Proxy' -ServiceApplication $sa -DefaultProxyGroup -``` - -This example creates a State Service database and Service Application. It then associates a new State Service Proxy with the State Service application and adds it to the Default proxy group. - - -## PARAMETERS - -### -ServiceApplication -Specifies the state service application to associate with the new proxy. - -The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the service application proxy is added to the farm's default proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the new proxy. - -The type must be a valid name of a SQL Server database; for example, SessionStateDB1. -Service application proxy; for example, StateSvcAppProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceDatabase.md deleted file mode 100644 index a8bcc6bca1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPStateServiceDatabase.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPStateServiceDatabase -schema: 2.0.0 ---- - -# New-SPStateServiceDatabase - -## SYNOPSIS -Creates and provisions a new state service database and installs the state database schema into it. - - -## SYNTAX - -``` -New-SPStateServiceDatabase [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseCredentials <PSCredential>] [-DatabaseServer <String>] - [-ServiceApplication <SPStateServiceApplicationPipeBind>] [-Weight <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPStateServiceDatabase` cmdlet creates and a new state service database. -This cmdlet installs the session state database schema in the state service database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>New-SPStateServiceDatabase -Name 'State Service' -``` - -This example creates a new state service database. - -## PARAMETERS - -### -Name -Specifies the name for the state service database that is stored in SQL Server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the database credentials for SQL Authentication used to access the state service database. -If this parameter is not specified, Windows authentication is used. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the state service database. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the state service application to add the state database to. - -The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for the state database. -The default value is 1. - -This parameter is used when new rows of data are allocated among the collection of databases that are associated with a service application - -The type must be a valid integer in the range of 1 to 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSubscriptionSettingsServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSubscriptionSettingsServiceApplication.md deleted file mode 100644 index 35681452da..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSubscriptionSettingsServiceApplication.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSubscriptionSettingsServiceApplication -schema: 2.0.0 ---- - -# New-SPSubscriptionSettingsServiceApplication - -## SYNOPSIS -Creates a new subscription settings service application. - - -## SYNTAX - -``` -New-SPSubscriptionSettingsServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabaseName <String>] [-DatabaseServer <String>] [-FailoverDatabaseServer <String>] [-Name <String>] - [-WhatIf] [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPSubscriptionSettingsServiceApplication` cmdlet to create a subscription settings service application that can be used to store settings that are shared across all site collections in a single site subscription. -This cmdlet is used only in an environment where site subscriptions are used to delegate administration or partition services that are used for storing settings that are shared across all site collections in a single site subscription. -This cmdlet is used only in an environment where site subscriptions are used to delegate administration or partition services. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------EXAMPLE--------------- -``` - -PS C:\>$sa = New-SPSubscriptionSettingsServiceApplication -ApplicationPool 'SharePoint Web Services Default' -Name 'Subscriptions Settings Service Application' -DatabaseName 'Subscription' - -``` - -This example creates a Subscriptions Settings Service application. - -## PARAMETERS - -### -ApplicationPool -Specifies the IIS application pool to use for the new subscription settings application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the subscription settings database. - -If not provided, one will be generated. - -The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host SQL Server instance for the database specified in the DatabaseName parameter. -If not provided, the default database server will be used. - -The type must be a valid SQL Server instance name; for example, SQLServerHost1. - -The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host SQL Server instance for the failover database server. - -The type must be a valid SQL Server instance name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the new subscription settings service. - -The type must be a valid name of a subscription settings service application; for example, SubscriptionSettingsApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSubscriptionSettingsServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPSubscriptionSettingsServiceApplicationProxy.md deleted file mode 100644 index cea94cb529..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPSubscriptionSettingsServiceApplicationProxy.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPSubscriptionSettingsServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPSubscriptionSettingsServiceApplicationProxy - -## SYNOPSIS -Creates an application proxy to a subscription settings service application. - - -## SYNTAX - -### ServiceApplication -``` -New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### Uri -``` -New-SPSubscriptionSettingsServiceApplicationProxy -Uri <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `New-SPSubscriptionSettingsServiceApplicationProxy` cmdlet to create an application proxy to a subscription settings service application. -This is required for the local farm to consume a subscription settings service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------------- -``` -PS C:\>$sa = New-SPSubscriptionSettingsServiceApplication -ApplicationPool 'SharePoint Web Services Default' -Name 'Subscriptions Settings Service Application' -DatabaseName 'Subscription' -PS C:\>New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $sa -``` - -This example creates a new Subscription Settings Service application and proxy. - -## PARAMETERS - -### -ServiceApplication -Specifies the subscription settings service application associated with the new proxy. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: ServiceApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Uri -Specifies the address of the subscription settings service application to associate the new application proxy with. - -The type must be a valid URI, in the form file:\\\\server_name\sitedocs. - -```yaml -Type: String -Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTranslationServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPTranslationServiceApplication.md deleted file mode 100644 index 44e35d87a6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTranslationServiceApplication.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: Microsoft.Office.TranslationServices.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPTranslationServiceApplication -schema: 2.0.0 ---- - -# New-SPTranslationServiceApplication - -## SYNOPSIS -Provisions a new instance of the Machine Translation service. - - -## SYNTAX - -``` -New-SPTranslationServiceApplication [-Name] <String> -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredential <PSCredential>] - [-DatabaseName <String>] [-DatabaseServer <String>] [-Default] [-FailoverDatabaseServer <String>] - [-PartitionMode] [-WhatIf] [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPTranslationServiceApplication` cmdlet to provision a new instance of the Machine Translation service on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------EXAMPLE--------------- -``` -PS C:\>New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'SharePoint Web Services Default' -DatabaseServer Server1 -DatabaseName TranslationServiceDatabase -``` - -This example creates a Machine Translation service application named TranslationService which will run in the SharePoint Web Services Default service application pool. -The database will be called TranslationServiceDatabase and will be hosted on the Server1 SQL server instance. - - -## PARAMETERS - -### -Name -Specifies the unique identifier of Translation Service instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the managed application pool that the instance of Translation Service will run in. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredential -Specifies the SQL Server credentials used for this Translation Service instance. -This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the database name which is to be used for this Translation Service instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the database server which is to be used for this Translation Service instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Determines whether or not the proxy for this service application should be added to the default proxy group for this Web application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Restricts this service to behave uniquely on a partitioned set of site collections. -This cannot be changed after the application is provisioned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Specifies if the upgrade process is to be deferred and manually completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPTranslationServiceApplication](Set-SPTranslationServiceApplication.md) - -[New-SPTranslationServiceApplicationProxy](New-SPTranslationServiceApplicationProxy.md) - -[Set-SPTranslationServiceApplicationProxy](Set-SPTranslationServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTranslationServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPTranslationServiceApplicationProxy.md deleted file mode 100644 index 2795be9cbb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTranslationServiceApplicationProxy.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Office.TranslationServices.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPTranslationServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPTranslationServiceApplicationProxy - -## SYNOPSIS -Creates a Machine Translation Service application proxy on the local farm. - - -## SYNTAX - -### ConnectLocal -``` -New-SPTranslationServiceApplicationProxy -Name <String> - -ServiceApplication <TranslationServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DefaultProxyGroup] [-PartitionMode] [-WhatIf] [<CommonParameters>] -``` - -### ConnectRemote -``` -New-SPTranslationServiceApplicationProxy -Name <String> -Uri <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-PartitionMode] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `New-SPTranslationServiceApplicationProxy` cmdlet creates a Machine Translation Service application proxy on the local farm. -The proxy is added to the default proxy group for the local farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------EXAMPLE--------- -``` -PS C:\>$sa = New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'SharePoint Web Services Default' -DatabaseServer Server1 -DatabaseName TranslationServiceDatabase -PS C:\>New-SPTranslationServiceApplicationProxy -Name TranslationServiceProxy -ServiceApplication $sa -DefaultProxyGroup -``` - -This example creates a Machine Translation Service application and proxy in the default proxy group named TranslationServiceProxy. - - -## PARAMETERS - -### -Name -Specifies the display name for the new Machine Translation Service application. -The name that you use must be a unique name of a Machine Translation Service application in this farm. -The name can be a maximum of 128 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the local Machine Translation Service application that is associated with the new proxy. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Machine Translation Service application (for example, MachTrans1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: TranslationServiceApplicationPipeBind -Parameter Sets: ConnectLocal -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI of the remote machine translation service application this proxy should communicate with. -This value is required only if you plan to connect a Machine Translation Service application from a remote farm. - -```yaml -Type: String -Parameter Sets: ConnectRemote -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the Machine Translation Service application proxy be added to the default proxy group for the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restrict data by site group. -After the PartitionMode parameter is set and the service application is created, it cannot be changed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPTranslationServiceApplication](New-SPTranslationServiceApplication.md) - -[Set-SPTranslationServiceApplication](Set-SPTranslationServiceApplication.md) - -[Set-SPTranslationServiceApplicationProxy](Set-SPTranslationServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedIdentityTokenIssuer.md deleted file mode 100644 index b1b2759e50..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedIdentityTokenIssuer.md +++ /dev/null @@ -1,373 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPTrustedIdentityTokenIssuer -schema: 2.0.0 ---- - -# New-SPTrustedIdentityTokenIssuer - -## SYNOPSIS -Creates an identity provider in the farm. - - -## SYNTAX - -### BasicParameterSet -``` -New-SPTrustedIdentityTokenIssuer -ClaimsMappings <SPClaimMappingPipeBind[]> -Description <String> - -IdentifierClaim <String> -Name <String> -Realm <String> -SignInUrl <String> - [-AssignmentCollection <SPAssignmentCollection>] [-ClaimProvider <SPClaimProviderPipeBind>] - [-ImportTrustCertificate <X509Certificate2>] [-UseWReply] [-Confirm] [-RegisteredIssuerName <String>] - [-SignOutUrl <String>] [-WhatIf] [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -New-SPTrustedIdentityTokenIssuer -ClaimsMappings <SPClaimMappingPipeBind[]> -Description <String> - -IdentifierClaim <String> -Name <String> -Realm <String> -SignInUrl <String> - [-AssignmentCollection <SPAssignmentCollection>] [-ClaimProvider <SPClaimProviderPipeBind>] - -MetadataEndPoint <Uri> [-UseWReply] [-Confirm] [-SignOutUrl <String>] [-WhatIf] [<CommonParameters>] -``` - -### ActiveDirectoryBackedParameterSet -``` -New-SPTrustedIdentityTokenIssuer -Description <String> -Name <String> -Realm <String> -SignInUrl <String> - [-AssignmentCollection <SPAssignmentCollection>] [-ImportTrustCertificate <X509Certificate2>] [-UseWReply] - [-Confirm] [-IdentifierClaimIs <String>] [-RegisteredIssuerName <String>] [-SignOutUrl <String>] - [-UseDefaultConfiguration] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPTrustedIdentityTokenIssuer` cmdlet creates an identity provider in the farm. -This object is created and used only for setting this type of identity provider in a Web application. -The specified claim type cannot be NTLM, Classic NTLM, Negotiate, or Classic Negotiate. -For ASP.NET Membership provider or Role providers, no objects are persisted. -For security token service (STS) identity providers, this cmdlet creates and persists the identity provider object in the SPFarm object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------- EXAMPLE--------------------------- -``` -PS C:\>New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" - Description "LiveID STS" -Certificate (Get-ChildItem "cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") -SignInUrl http://int.contoso.com/ -IdentifierClaim "http://schemas.contoso.com/2007/05/Claims/Puid" -``` - -This example creates a new identity provider in the farm named LiveIDSTS. - - -## PARAMETERS - -### -ClaimsMappings -Specifies the mapping of the claims from the original token to the SharePoint token. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. - -```yaml -Type: SPClaimMappingPipeBind[] -Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the new identity provider. - -The type must be a valid string; for example, LiveID STS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierClaim -Specifies which claim type from the trusted STS will be used for the new identity provider. - -The type must be a valid claim type from the trusted STS; for example, http://schemas.microsoft.com/2007/05/Claims/Puid. - -```yaml -Type: String -Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new identity provider. - -The type must be a valid name of an identity provider; for example, LiveIDSTS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Realm -Specifies the realm, or resource partition, associated with this trust. - -The type must be a name of a valid realm; for example, MD_REALM. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInUrl -Specifies the sign-in URLs for this trusted STS identity provider. - -The type must be a valid URL, in the form http://int.live.com/. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClaimProvider -Specifies the IP STS that can resolve and search claims for claims people picker. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object. - -```yaml -Type: SPClaimProviderPipeBind -Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImportTrustCertificate -Specifies the X.509 certificate object from trusted authentication provider farm. - -The type must be a name of a valid X.509 certificate; for example, Certificate1. - -```yaml -Type: X509Certificate2 -Parameter Sets: BasicParameterSet, ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -Specifies the URI for the metadata endpoint of the trusted provider. - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseWReply -Includes a WReply with the token request. - -WReply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierClaimIs -Specifies which of the default mapped claims should be used as the identifier claim. - -Only used if the UseDefaultConfiguration parameter is set to true, otherwise use the IdentifierClaim parameter. - -```yaml -Type: String -Parameter Sets: ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegisteredIssuerName -Specifies the Registered Issuer Name instead of not using the metadata endpoint. - -```yaml -Type: String -Parameter Sets: BasicParameterSet, ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignOutUrl -Specifies the sign out URI for the trusted provider. This lets SharePoint to sign the user out from the trusted provider when they sign out from SharePoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SSharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultConfiguration -Specifies if the default set of claim mappings should be used. - -If UseDefaultConfiguration parameter is used, then the IdentifierClaimIs parameter must be used. - -```yaml -Type: SwitchParameter -Parameter Sets: ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedRootAuthority.md deleted file mode 100644 index 8748413d17..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedRootAuthority.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPTrustedRootAuthority -schema: 2.0.0 ---- - -# New-SPTrustedRootAuthority - -## SYNOPSIS -Creates a trusted root authority. - - -## SYNTAX - -### ManualUpdateCertificateParameterSet -``` -New-SPTrustedRootAuthority [-Name] <String> -Certificate <X509Certificate2> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -New-SPTrustedRootAuthority [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -MetadataEndPoint <Uri> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPTrustedRootAuthority` cmdlet creates a trusted root authority. -If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx -PS C:\>New-SPTrustedRootAuthority -Name "WFEFarm1" -Certificate $cert -``` - -This example creates a new trusted root authority, WFEFarm1. - - -## PARAMETERS - -### -Name -Specifies the name of the trusted root authority to create. - -The value must be a valid name of a trusted root authority; for example, WFEFarm1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificate -Specifies the X.509 certificate of the trusted root authority. - -The value must be a name of a valid X.509 certificate; for example, Certificate1. - -```yaml -Type: X509Certificate2 -Parameter Sets: ManualUpdateCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -Specifies the Uri of the metadata endpoint. - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedSecurityTokenIssuer.md deleted file mode 100644 index 4fb85e1299..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedSecurityTokenIssuer.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPTrustedSecurityTokenIssuer -schema: 2.0.0 ---- - -# New-SPTrustedSecurityTokenIssuer - -## SYNOPSIS -Creates a trust between a server to server principal. - - -## SYNTAX - -### ImportCertificateParameterSet -``` -New-SPTrustedSecurityTokenIssuer [-Name] <String> -Certificate <X509Certificate2> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-IsTrustBroker] - [-RegisteredIssuerName <String>] [-WhatIf] [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -New-SPTrustedSecurityTokenIssuer [-Name] <String> -MetadataEndPoint <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-IsTrustBroker] - [-RegisteredIssuerName <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `New-SPTrustedSecurityTokenIssuer` cmdlet to establish a trust between a server to server principal. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------EXAMPLE----------- -``` -PS C:\>New-SPTrustedSecurityTokenIssuer -Name "SPFarmA" -MetadataEndPoint https://mysite/my/_layouts/metadata/test/1/ -isSelfIssuer "false" -``` - -This example creates a new trusted security token named SPFarmA. - - -## PARAMETERS - -### -Name -Specifies the name of the issuer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificate -Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer. - -```yaml -Type: X509Certificate2 -Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -Specifies the URI for the metadata endpoint of the issuer. - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the issuer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsTrustBroker -Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server or Lync). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegisteredIssuerName -Specifies the name of the registered token issuer instead of using metadata endpoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPTrustedSecurityTokenIssuer](Get-SPTrustedSecurityTokenIssuer.md) - -[Remove-SPTrustedSecurityTokenIssuer](Remove-SPTrustedSecurityTokenIssuer.md) - -[Set-SPTrustedSecurityTokenIssuer](Set-SPTrustedSecurityTokenIssuer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedServiceTokenIssuer.md deleted file mode 100644 index f0437f1032..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPTrustedServiceTokenIssuer.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPTrustedServiceTokenIssuer -schema: 2.0.0 ---- - -# New-SPTrustedServiceTokenIssuer - -## SYNOPSIS -Creates a trust with a SharePoint farm. - - -## SYNTAX - -### ImportCertificateParameterSet -``` -New-SPTrustedServiceTokenIssuer [-Name] <String> -Certificate <X509Certificate2> - [-AssignmentCollection <SPAssignmentCollection>] [-Description <String>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -New-SPTrustedServiceTokenIssuer [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Description <String>] [-Confirm] -MetadataEndPoint <Uri> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPTrustedServiceTokenIssuer` cmdlet creates a trust with a SharePoint farm. -If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx -PS C:\>New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Certificate $cert -``` - -This example shows how to create a new SharePoint Farm trust using the trust certificate from a file. - - -## PARAMETERS - -### -Name -Specifies the name of the trust. - -The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificate -The type must be a name of a valid X.509 certificate; for example, Certificate1. - -Specifies the X.509 certificate object from trusted authentication provider farm. - -```yaml -Type: X509Certificate2 -Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the trust. - -The type must be a valid string; for example, WFE Farm Trust1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -Specifies the URI for the metadata endpoint of the trusted provider. - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUsageApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPUsageApplication.md deleted file mode 100644 index 582c9c2d29..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUsageApplication.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPUsageApplication -schema: 2.0.0 ---- - -# New-SPUsageApplication - -## SYNOPSIS -Creates a new usage application. - - -## SYNTAX - -``` -New-SPUsageApplication [[-Name] <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] - [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-UsageService <SPUsageServicePipeBind>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPUsageApplication` cmdlet creates a new usage application in the local farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE------------------------- -``` -PS C:\>New-SPUsageApplication -Name "Usage Application For Farm ABC" -``` - -This example creates a new usage application for the specified name. - - -## PARAMETERS - -### -Name -Specifies the friendly name of the new usage application. - -The type must be a valid name of a usage application; for example, UsageApplication1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the logging database. -If the logging database does not exist, a logging database is automatically created. - -The type must be a valid name of a SQL Server database; for example, UsageLogDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user specified in DatabaseUserName. -Use this parameter only if SQL Server Authentication is used to access the logging database. - -The type must be a valid password. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the SPServer object where the logging database is created. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user name to use for connecting to the logging database. -Use this parameter only if SQL Server Authentication is used to access the logging database. - -The type must be a valid user name; for example, UserName1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host SQL Server instance for the failover database server. - -The type must be a valid SQL Server instance name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsageService -Filters to return the usage application with the specified parent SPUsageService object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. - -```yaml -Type: SPUsageServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUsageLogFile.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPUsageLogFile.md deleted file mode 100644 index 70159dfff9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUsageLogFile.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPUsageLogFile -schema: 2.0.0 ---- - -# New-SPUsageLogFile - -## SYNOPSIS -Starts a new usage log file on the current server computer. - - -## SYNTAX - -``` -New-SPUsageLogFile [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPUsageLogFile` cmdlet starts a new usage log file on the current server computer. -The usage data in memory is flushed to the current usage log file before the new log file is created. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE------------------- -``` -PS C:\>New-SPUsageLogFile -``` - -This example terminates the current usage log file and creates a new one. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUser.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPUser.md deleted file mode 100644 index fc835730c3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUser.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPUser -schema: 2.0.0 ---- - -# New-SPUser - -## SYNOPSIS -Adds an existing user to a SharePoint site with the designated permissions. - - -## SYNTAX - -``` -New-SPUser [-UserAlias] <String> -Web <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DisplayName <String>] [-Email <String>] [-Group <SPGroupPipeBind>] [-PermissionLevel <String[]>] - [-SiteCollectionAdmin] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPUser` cmdlet adds an existing user to a SharePoint web site with the designated permissions. -This user has the given permissions in all subsites that inherit permissions. -The user account must already exist in the user directory. - -If your environment is in Active Directory mode, the user must already exist in Active Directory Domain Services (AD DS) and only the UserAlias parameter is required; all other fields are pulled from AD DS. -If only an alias is given and the farm is in Active Directory Account Create mode, the Email parameter is also required. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1---------------------- -``` -PS C:\>New-SPUser -UserAlias 'Contoso\Jdow'-DisplayName 'Jane Dow' -Web http://contoso.com -``` - -This example adds a new user named Jane Dow to the Contoso domain. - - -### ------------------EXAMPLE 2---------------------- -``` -PS C:\>Get-SPWeb http://sitename | New-SPUser -UserAlias Contoso\Jdow -``` - -This example adds Contoso\Jdow to all webs in the http://sitename site collection. -Because this site collection uses inherited permissions, only the top-level web site needs to be touched. - - -## PARAMETERS - -### -UserAlias -Specifies the user alias from Active Directory Domain Services (AD DS). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Web -Specifies the URL or GUID of the web on which to create this user. - -The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-9876-0987. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies a string that contains the display name of the user. - -The type must be a valid user name; for example, Joe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies the email address of the new user. - -The type must be a valid email address, in the form someone@contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the user group to which the new user belongs. - -```yaml -Type: SPGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevel -Adds a user to a permission level. - -The type must be a valid permission level for the web application; for example, Full Control, Read, Contribute, or All. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollectionAdmin -Specifies whether to add the user as an administrator to the site collection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserLicenseMapping.md deleted file mode 100644 index 59e8611230..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserLicenseMapping.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPUserLicenseMapping -schema: 2.0.0 ---- - -# New-SPUserLicenseMapping - -## SYNOPSIS -Creates a license mapping object. - - -## SYNTAX - -### TrustIdentity -``` -New-SPUserLicenseMapping -Claim <SPClaim> -License <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -### ClaimsValues -``` -New-SPUserLicenseMapping -ClaimType <String> -License <String> -OriginalIssuer <String> -Value <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ValueType <String>] - [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -### FormsAuth -``` -New-SPUserLicenseMapping -License <String> -Role <String> -RoleProviderName <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WebApplication <SPWebApplicationPipeBind>] - [-WhatIf] [<CommonParameters>] -``` - -### WindowsAuth -``` -New-SPUserLicenseMapping -License <String> -SecurityGroup <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WebApplication <SPWebApplicationPipeBind>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `New-SPUserLicenseMapping` cmdlet to create a new license mapping object. -This cmdlet must be used first before the `Add-SPUserLicenseMapping` cmdlet can be used. - -The object created by using the `New-SPUserLicenseMapping` cmdlet is stored in memory and is not written to any database in SharePoint Server. -After the object is created you can pipe the result to the `Add-SPUserLicenseMapping` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------- EXAMPLE---------------------------) -``` -PS C:\>$a = New-SPUserLicenseMapping -SecurityGroup EntSecGroup -License Enterprise -PS C:\>$a | Add-SPUserLicenseMapping -``` - -This example creates a license mapping object for the Active Directory secured group named 'EntSecGroup' and then pipes the result to the `Add-SPUserLicenseMapping` cmdlet. - - -## PARAMETERS - -### -Claim -Specifies the claims principal to license. -The value must be an authentic claims principal. - -```yaml -Type: SPClaim -Parameter Sets: TrustIdentity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClaimType -Specifies the type of the claim. -The value must be an authentic name of a claim type. - -```yaml -Type: String -Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -License -Specifies the name of a supported SharePoint user license. -For the full list of supported licenses on a SharePoint farm, see the `Get-SPUserLicense` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OriginalIssuer -Specifies the original issuer of the claim. -The value must be the authentic name of an original issuer. - -```yaml -Type: String -Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Specifies the name of a forms-based role. -The value must be an authentic name of a forms-based role. - -```yaml -Type: String -Parameter Sets: FormsAuth -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoleProviderName -Specifies the name of a role provider. -The value must be an authentic name of a role provider. - -```yaml -Type: String -Parameter Sets: FormsAuth -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecurityGroup -Specifies the name of an AD DS security group. -The value must be a name of an Active Directory security group. - -```yaml -Type: String -Parameter Sets: WindowsAuth -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the claim. -The value must be an authentic claim value. - -```yaml -Type: String -Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValueType -Specifies the value type of the claim. -The value must be an authentic name of a claim value type. - -```yaml -Type: String -Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, web application name, or web application object instance where the mapping is to be added. -If you omit this parameter, the mapping is applied to the entire farm. - -The type must be an URL in the form http://server_name or http://server_name/sites/sitename, a GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh), a name of a web application (for example, SharePoint - 80), or an instance of a web application object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPUserLicenseMapping](Add-SPUserLicenseMapping.md) - -[Get-SPUserLicenseMapping](Get-SPUserLicenseMapping.md) - -[Remove-SPUserLicenseMapping](Remove-SPUserLicenseMapping.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserSettingsProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserSettingsProvider.md deleted file mode 100644 index feaad503cd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserSettingsProvider.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPUserSettingsProvider -schema: 2.0.0 ---- - -# New-SPUserSettingsProvider - -## SYNOPSIS -Adds a new User Settings Provider. - - -## SYNTAX - -``` -New-SPUserSettingsProvider -AssemblyName <String> -DisplayName <String> -Type <String> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPUserSettingsProvider` cmdlet to add a new User Settings Provider to the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------- EXAMPLE--------------------------- -``` -PS C:\>New-SPUserSettingsProvider -DisplayName "My User Settings Provider" -AssemblyName MyProvider.dll -Type MyProvider -``` - -This example adds a user setting provider with a display name of "My User Settings Provider" which uses the MyProvider.dll file. - - -## PARAMETERS - -### -AssemblyName -Specifies the assembly name for the provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name to use for this provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type name to use for this provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPUserSettingsProvider](Get-SPUserSettingsProvider.md) - -[Remove-SPUserSettingsProvider](Remove-SPUserSettingsProvider.md) - -[Get-SPUserSettingsProviderManager](Get-SPUserSettingsProviderManager.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserSolutionAllowList.md deleted file mode 100644 index 39a66d0de7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPUserSolutionAllowList.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPUserSolutionAllowList -schema: 2.0.0 ---- - -# New-SPUserSolutionAllowList - -## SYNOPSIS -Creates a user managed solutions gallery. - - -## SYNTAX - -``` -New-SPUserSolutionAllowList [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] -ListTitle <String> - -Site <SPSitePipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a user managed solutions gallery. - - -## EXAMPLES - -### ----------------------- EXAMPLE--------------------------- -``` -PS C:\>New-SPUserSolutionAllowList -Site http://contoso/sites/site1 -ListTitle "Allow List" -``` -This example creates a user managed solutions gallery named "Allow List" under the root web of the site collection at http://contoso/sites/site1. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListTitle -Specifies the title of the user solution allow list to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site collection where the user solution allow list will be created. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioSafeDataProvider.md deleted file mode 100644 index 51aeef83fd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioSafeDataProvider.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPVisioSafeDataProvider -schema: 2.0.0 ---- - -# New-SPVisioSafeDataProvider - -## SYNOPSIS -Adds a new data provider to a Visio Services application. - - -## SYNTAX - -``` -New-SPVisioSafeDataProvider -DataProviderId <String> -DataProviderType <Int32> - -VisioServiceApplication <SPVisioServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Description <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPVisioSafeDataProvider` cmdlet adds a new data provider to the list of safe data providers for a Visio Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE------------------------ -``` -PS C:\>New-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "CustomProvider" -DataProviderType 5 -Description "Custom Data Provider" -``` - -This example creates a new safe data provider for a specified Visio Services application. - - -## PARAMETERS - -### -DataProviderId -Specifies the name of the data provider to create. -The combination of DataProviderID and DataProviderType uniquely identify a data provider for a Visio Services application. -The string that identifies the data provider can be a maximum of 255 alphanumeric characters. - -The type must be a valid string that identifies the data provider; for example, VisioDataProvider1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataProviderType -The type must be a valid identity of a data provider type. - -Specifies the supported type of the data provider to add. -Custom data types are supported; for example, Excel Services. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisioServiceApplication -Specifies the Visio Services application in which to add the new safe data provider. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the new safe data provider. - -The type must be a string with a maximum of 4096 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioServiceApplication.md deleted file mode 100644 index 2bae94142f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioServiceApplication.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPVisioServiceApplication -schema: 2.0.0 ---- - -# New-SPVisioServiceApplication - -## SYNOPSIS -Adds a new Visio Services application to a farm. - - -## SYNTAX - -``` -New-SPVisioServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AddToDefaultGroup] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPVisioServiceApplication` cmdlet adds a new Visio Services application to a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------EXAMPLE 1--------------------- -``` -PS C:\>New-SPVisioServiceApplication -Identity 'Visio Graphics Service Application' -ApplicationPool 'SharePoint Web Services Default' -CreateDefaultProxy -``` - -This example creates a new Visio Services application named 'Visio Graphics Service Application' and also creates a service application proxy associated with it. - - -## PARAMETERS - -### -ApplicationPool -Specifies the existing IIS application pool in which to run the Web service for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AddToDefaultGroup -Specifies that a default proxy is created for the new Visio Services application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the Visio Services application to create. - -The type must be a valid name of a Visio Service application; for example, MyVisioService1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioServiceApplicationProxy.md deleted file mode 100644 index 95efe15173..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPVisioServiceApplicationProxy.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPVisioServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPVisioServiceApplicationProxy - -## SYNOPSIS -Adds a new Visio Services application proxy to a farm. - - -## SYNTAX - -``` -New-SPVisioServiceApplicationProxy -ServiceApplication <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPVisioServiceApplicationProxy` cmdlet adds a new Visio Services application proxy to a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE------------------------ -``` -PS C:\>$sa = New-SPVisioServiceApplication -Identity 'Visio Graphics Service Application' -ApplicationPool 'SharePoint Web Services Default' -PS C:\>New-SPVisioServiceApplicationProxy -Identity 'Visio Graphics Service Application Proxy' -ServiceApplication $sa -``` - -This example creates a new Visio Services application proxy connected to a Visio Services application. - - -## PARAMETERS - -### -ServiceApplication -Specifies the Visio Services application that is associated with the application proxy. - -The type must be a valid name of a Visio Services application; for example, MyVisioService1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the Visio Services application proxy to create. - -The type must be a valid name of a Visio Services application; for example, MyVisioService1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWOPIBinding.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWOPIBinding.md deleted file mode 100644 index cc84f1cfb3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWOPIBinding.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWOPIBinding -schema: 2.0.0 ---- - -# New-SPWOPIBinding - -## SYNOPSIS -Creates a new binding to associate file name extensions or applications with actions on the current SharePoint farm where this cmdlet is run. - - -## SYNTAX - -``` -New-SPWOPIBinding -ServerName <String> [-Action <String>] [-AllowHTTP] [-Application <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Extension <String>] [-FileName <String>] - [-ProgId <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPWOPIBinding` cmdlet associates file name extensions or applications to actions on the current SharePoint farm where this cmdlet is run. -Each binding allows you to use the WOPI application to view or edit files in your SharePoint library. -For example, when a user sees a Word document in a SharePoint document list, the SharePoint list will display the available options to view or edit the document based on the actions that are bound to Word on that SharePoint farm. - -To use a WOPI application, such as a server that runs Office Web Apps Server, for Office Web Apps, you must run this cmdlet on the SharePoint farm before you can use the Office Web Apps. - -If you run `New-SPWOPIBinding` for an application or file name extension where the binding (or association) already exists, the cmdlet will fail. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>New-SPWOPIBinding -ServerName "Server.corp.Contoso.com" -``` - -This example creates bindings for all the applications and file name extensions that the WOPI application supports on the current SharePoint farm where this cmdlet is run. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>New-SPWOPIBinding -ServerName "Server.corp.Contoso.com" -Application "Excel" -``` - -This example associates Excel with all the actions that the WOPI application supports for Excel on the current SharePoint farm where this cmdlet is run. - - -## PARAMETERS - -### -ServerName -Specifies the name or fully qualified domain name (FQDN) of the WOPI application (such as a server that runs Office Web Apps Server). - -This can also be an FQDN of a load balanced endpoint for multiple Office Web Apps servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Action -Specifies the action to bind. - -For example, "view," "edit," and "embedview." For a list of actions that the WOPI application supports, run `Get-SPWOPIBinding`. -Typically, you will not use this parameter. - -If you specify some actions but not others, some SharePoint features may not work. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowHTTP -Specifies that the cmdlet can use HTTP for discovery of what the WOPI application supports. - -If this is specified as True, the discovery information from the WOPI application will be sent on a nonsecure connection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Application -Specifies applications to bind. - -Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote." Run `Get-SPWOPIBinding` to get the full list of application the WOPI application supports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the file name extensions to bind. - -Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileName -Specifies the path of the xml file that contains the discover information for the WOPI application. - -You can load discovery information from an xml file instead of requesting from the WOPI application directly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgId -Specifies the programmatic identifier (ProgID) for an application to bind. - -Run `Get-SPWOPIBinding` to get the list of ProgIDs that the WOPI application supports. - -You may only want to use this parameter to associate an action to an OneNote folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[Get-SPWOPIBinding](Get-SPWOPIBinding.md) - -[Set-SPWOPIBinding](Set-SPWOPIBinding.md) - -[Remove-SPWOPIBinding](Remove-SPWOPIBinding.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWOPISuppressionSetting.md deleted file mode 100644 index 45be13f66e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWOPISuppressionSetting.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWOPISuppressionSetting -schema: 2.0.0 ---- - -# New-SPWOPISuppressionSetting - -## SYNOPSIS -The `New-SPWOPISuppressionSetting` cmdlet turns off Office Web Apps for the action, file name extension, or programmatic identifier that you've specified on the current SharePoint farm. - - -## SYNTAX - -``` -New-SPWOPISuppressionSetting [-Action <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Extension <String>] [-ProgId <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPWOPISuppressionSetting` cmdlet turns off Office Web Apps for the action, file name extension, or programmatic identifier (ProgId) that you've specified on the current SharePoint farm. -The cmdlet does this without removing the discovery information or the ability for users to use the SharePoint Share by link feature to send a link to a document and allow the recipient to use Office Web Apps for that document type. -You may have to use this cmdlet if you want to use Excel Services to view Excel workbooks instead of the WOPI application (for example Office Web Apps Server). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPWOPISuppressionSetting -Extension "XLSX" -Action "view" -PS C:\>New-SPWOPISuppressionSetting -Extension "XLS" -Action "view" -``` - -This example turns off the ability of a user to use Office Web Apps to view Excel workbooks that have file name extensions ".xlsx" or ".xls". - - -## PARAMETERS - -### -Action -Specifies the action to suppress for a given extension or programmatic identifier (ProgId). - -For example, "view," "edit," and "embedview." For a full list of actions, run `Get-SPWOPIBinding`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the file name extension to suppress. - -Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgId -Specifies the programmatic identifier (ProgId) for an application to suppress. - -Run `Get-SPWOPIBinding` to get the list of ProgIds that the WOPI application supports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[Get-SPWOPISuppressionSetting](Get-SPWOPISuppressionSetting.md) - -[Remove-SPWOPISuppressionSetting](Remove-SPWOPISuppressionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWeb.md deleted file mode 100644 index 3fa4bdb3fb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWeb.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWeb -schema: 2.0.0 ---- - -# New-SPWeb - -## SYNOPSIS -Creates a new site in an existing site collection. - - -## SYNTAX - -``` -New-SPWeb [-Url] <String> [-Language <UInt32>] [-Template <SPWebTemplatePipeBind>] [-Name <String>] - [-Description <String>] [-AddToQuickLaunch] [-UniquePermissions] [-AddToTopNav] [-UseParentTopNav] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPWeb` cmdlet creates a new site in the existing site collection specified by the Url parameter. -You can create a site with a specific default language by specifying the Language parameter. -If no language is specified, the site is created with the same language that was specified when the product was installed. -You can create a site from a specific template by specifying the Template parameter. -If no template is specified, the site is created and the template can be provided later or by the first user to log on. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPWeb http://somesite/subweb1 -Template "STS#0" -``` - -This example creates a new subsite by using the Team Site template at the provided URL (http://somesite/subweb1). -The Team Site template is a value referenced as the variable STS#0 for the Template parameter. - - -## PARAMETERS - -### -Url -Specifies the URL where the new site is to be created. -The URL must be inside an existing site collection. -The URL must be a valid URL, in the form http://server_name/site1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Language -Specifies the language template identifier for the new site. -If no language is specified, the site is created with the same language that was specified when the product was installed. - -The type must be a valid language identifier (LCID). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the Web template for the new site. -The template must already exist. -If no template is specified, no template is applied and a template can be selected later. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the title of the new site. -If no title is specified, the default title is applied. -The default title is configured for each template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Describes the new site. -If no description is specified, the entry is left blank. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddToQuickLaunch -Adds this site to the Quick Launch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniquePermissions -Specifies that this site is to be created with unique permissions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddToTopNav -Adds this site to the top-level navigation bar. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseParentTopNav -Specifies that the same top-level navigation bar as the parent site is to be used for this site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplication.md deleted file mode 100644 index 6d163579b4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplication.md +++ /dev/null @@ -1,438 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWebApplication -schema: 2.0.0 ---- - -# New-SPWebApplication - -## SYNOPSIS -Creates a new Web application within the local farm. - - -## SYNTAX - -``` -New-SPWebApplication -ApplicationPool <String> -Name <String> - [-AdditionalClaimProvider <SPClaimProviderPipeBind[]>] [-AllowAnonymousAccess] - [-ApplicationPoolAccount <SPProcessAccountPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-AuthenticationMethod <String>] [-AuthenticationProvider <SPAuthenticationProviderPipeBind[]>] [-Confirm] - [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] - [-HostHeader <String>] [-Path <String>] [-Port <UInt32>] [-SecureSocketsLayer] - [-ServiceApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] - [-SignInRedirectProvider <SPTrustedIdentityTokenIssuerPipeBind>] [-SignInRedirectURL <String>] [-Url <String>] - [-UserSettingsProvider <SPUserSettingsProviderPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Web application specified by the Name parameter. -The user specified by the DatabaseCredentials parameter must be a member of the dbcreator fixed server role on the database server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPWebApplication -Name "Contoso Internet Site" -Port 80 -HostHeader sharepoint.contoso.com -URL "https://www.contoso.com/" -ApplicationPool "ContosoAppPool" -ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\jdoe") -``` - -This example creates a new Web application by using an internal host header of sharepoint.contoso.com and a public URL of https://www.contoso.com. - - -## PARAMETERS - -### -ApplicationPool -Specifies the name of an application pool to use; for example, SharePoint - 1213. -If an application pool with the name provided does not exist, the ApplicationPoolAccount parameter must be provided and a new application pool will be created. -If no value is specified, the default application pool will be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new Web application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AdditionalClaimProvider -Adds a specific claim provider to the defined Web application. - -```yaml -Type: SPClaimProviderPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymousAccess -Allows anonymous access to the Web application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPoolAccount -Specifies the user account that this application pool will run as. -Use the `Get-SPIisWebServicApplicationPool` cmdlet to use a system account. - -```yaml -Type: SPProcessAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMethod -Uses Kerberos or NTLM to specify the authentication method. -If no value is specified, the default NTLM is applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationProvider -Specifies the authentication provider or providers that apply to a Web application. - -```yaml -Type: SPAuthenticationProviderPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the Windows PowerShell Credential object for the database user account. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the initial content database for the new Web application. - -The type must be a valid database name; for example, ContentDB1. -If no value is specified, a value in the format WSS_Content_\<GUID\> is auto-generated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the database server name. -The type must be a valid database server name, in the form SQL1; where named instances are used, the format can appear as server\server. -The default SQL server instance is used if a value is not provided. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostHeader -Specifies a valid URL assigned to the Web application that must correlate to the alternate access mapping configuration, in the form server_name. - -When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. -The Url parameter is used to specify the public URL.If no value is specified, the value is left blank. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the physical directory for the new Web application in the virtual directories folder. -The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication. -If no value is specified, the value %wwwroot%\wss\VirtualDirectories\\\<portnumber\> is applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which this Web application can be accessed. -This can be any valid port number. -If no port is specified, a nonconflicting port number is automatically generated. - -If you specify a port number that has already been assigned, IIS does not start the new site until you change either the port number of the new site or the port number of the old site. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureSocketsLayer -Enables Secure Sockets Layer (SSL) encryption for this Web application. -If you choose to use SSL, you must add the certificate on each server by using the IIS administration tools. -Until this is done, the Web application will be inaccessible from this IIS Web site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplicationProxyGroup -Specifies a custom service application proxy group for the Web application to use. -The Web application will use the proxies in this proxy group to connect to service applications. -If this parameter is not specified, the default proxy group for the farm is used. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: ProxyGroup -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInRedirectProvider -Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInRedirectURL -Specifies the sign-in redirect URL for the Web application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the load-balanced URL for the Web application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSettingsProvider -Provides access to external user settings provider. - -```yaml -Type: SPUserSettingsProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplicationAppDomain.md deleted file mode 100644 index cc5165dcb2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplicationAppDomain.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWebApplicationAppDomain -schema: 2.0.0 ---- - -# New-SPWebApplicationAppDomain - -## SYNOPSIS -Creates an AppDomain entry. - - -## SYNTAX - -``` -New-SPWebApplicationAppDomain [-AppDomain] <String> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Port <Int32>] [-SecureSocketsLayer] [-WhatIf] - [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-SPWebApplicationAppDomain cmdlet to create an AppDomain entry. If you specify a port, the cmdlet adds a port binding to the Internet Information Services (IIS) site corresponding to the Web Application/Zone combination. - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>New-SPWebApplicationAppDomain -AppDomain contosoapps.com -WebApplication http://www.contoso.com -``` - -Creates a new app domain for apps for SharePoint for the specified web application in the default zone. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>New-SPWebApplicationAppDomain -AppDomain contosoapps.com -WebApplication http://www.contoso.com -Zone Internet -Port 10000 -``` - -Creates a new app domain for apps for SharePoint for the specified web application in the internet zone at port 10000. - - -## PARAMETERS - -### -AppDomain -Specifies the URI of the app domain. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the GUID, URI, or name of the web application for which the app domain is being configured. - - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the IIS port number to which the app domain will be assigned. If no value is specified, the same port used by the web application for the zone is applied. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureSocketsLayer -Specifies that the app domain will use Secured Sockets Layer (SSL) security. If no value is specified, no SSL security will be used. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -Specifies the security zone to which the app domain will be assigned. - -* Default - -* Intranet - -* Internet - -* Extranet - -* Custom - -If no value is specified, Default is applied. - - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -### System.String -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPWebApplicationAppDomain](Get-SPWebApplicationAppDomain.md) - -[Remove-SPWebApplicationAppDomain](Remove-SPWebApplicationAppDomain.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplicationExtension.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplicationExtension.md deleted file mode 100644 index 8e596399bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWebApplicationExtension.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWebApplicationExtension -schema: 2.0.0 ---- - -# New-SPWebApplicationExtension - -## SYNOPSIS -Creates a new zone instance for the Web application. - - -## SYNTAX - -``` -New-SPWebApplicationExtension [-Identity] <SPWebApplicationPipeBind> -Name <String> -Zone <SPUrlZone> - [-AdditionalClaimProvider <SPClaimProviderPipeBind[]>] [-AllowAnonymousAccess] - [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMethod <String>] - [-AuthenticationProvider <SPAuthenticationProviderPipeBind[]>] [-Confirm] [-HostHeader <String>] - [-Path <String>] [-Port <UInt32>] [-SecureSocketsLayer] - [-SignInRedirectProvider <SPTrustedIdentityTokenIssuerPipeBind>] [-SignInRedirectURL <String>] [-Url <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPWebApplicationExtension` cmdlet creates a new zone instance for the Web application. -This is also known as extending a Web application and allows alternate permissions to be configured for the same content that is available in the existing Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPWebApplication http://sitename | New-SPWebApplicationExtension -Name "ExtranetSite" -SecureSocketsLayer -Zone "Extranet" -URL "https://extranet.sitename.com/" -``` - -This example extends the given Web application at http://sitename to the Extranet zone for SSL use. - - -## PARAMETERS - -### -Identity -Specifies the Web application to extend. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new IIS Web site in the Web application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -Specifies one of the five zones with which the internal URL of this new extension is to be associated. -This zone cannot already be in use. - -The type must be any one of the following values: Default, Intranet, Internet, Extranet, or Custom - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdditionalClaimProvider -Adds a specific claim provider to the defined Web application. - -```yaml -Type: SPClaimProviderPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymousAccess -Allows anonymous access to the Web application zone. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMethod -Uses Kerberos or NTLM to specify the authentication method. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationProvider -Specifies the authentication provider(s) that applies to a Web apllication. - -```yaml -Type: SPAuthenticationProviderPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostHeader -Specifies a valid URL assigned to the Web application by that must correlate to the alternate access mapping configuration, in the form http://server_name. - -When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. -The Url parameter is used to specify the public URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the physical directory for the new Web site (in the virtual directories folder). -The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the application port. -Can be any valid port number. - -If no port is specified, a nonconflicting port number is automatically generated. - -If you specify a port number that is already assigned, IIS does not start the new site until you change either the port number of the new site or the port number of the old site. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureSocketsLayer -Enables Secure Sockets Layer (SSL) encryption for this Web application. -If you use SSL, you must add the certificate on each server by using the IIS administration tools. -Until this is done, the Web application is inaccessible from this IIS Web site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInRedirectProvider -Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInRedirectURL -Specifies the sign-in redirect URL for the Web application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the load-balanced URL for the Web application zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWordConversionServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWordConversionServiceApplication.md deleted file mode 100644 index b97e49c902..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWordConversionServiceApplication.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Office.Word.Server.dll-Help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWordConversionServiceApplication -schema: 2.0.0 ---- - -# New-SPWordConversionServiceApplication - -## SYNOPSIS -Creates a new instance of a Word Automation Services application on the farm. - - -## SYNTAX - -``` -New-SPWordConversionServiceApplication [-Name] <String> - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DatabaseCredential <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] [-Default] - [-PartitionMode] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `New-SPWordConversionServiceApplication` cmdlet creates a new instance of a Word Automation Services application on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPWordConversionServiceApplication -Name 'Word Conversion Services' -ApplicationPool 'SharePoint Web Services Default' -DatabaseName 'Word' -``` - -This example creates a new Word Automation Services application named Word Conversion Services in an existing application pool named SharePoint Web Services Default. - - -## PARAMETERS - -### -Name -Specifies the name of the new Word Automation Services application. - -The type must be a valid name of a Word Automation Services application; for example, WordSvcApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS-managed application pool in which this instance of Word Automation Services runs. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredential -Specifies the credentials to use for connecting to the database for the Word Automation Services application. -Use this parameter only if SQL Server Authentication is used to access the service application database. - -When the DatabaseCredential parameter is specified, the DatabaseName and DatabaseServer parameters are required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to create for the new Word Automation Services application. - -The type must be a valid SQL database name; for example, MetadataDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the Word Automation Services database. - -The type must be a valid SQL database server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Specifies that the service application proxy is added to the farm's default proxy group for this Web application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that this service behaves uniquely on a partitioned set of site collections. -This property cannot be changed after the application is provisioned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkManagementServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkManagementServiceApplication.md deleted file mode 100644 index afc03a4f9c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkManagementServiceApplication.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Office.Server.WorkManagement.dll-help.xml -applicable: SharePoint Server 2013 -title: New-SPWorkManagementServiceApplication -schema: 2.0.0 ---- - -# New-SPWorkManagementServiceApplication - -## SYNOPSIS -Creates a new Work Management Service application. - - -## SYNTAX - -``` -New-SPWorkManagementServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> -Name <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Proxy] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPWorkManagementServiceApplication` cmdlet to create a new Work Management Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -Note: This functionality has been removed from SharePoint Server 2016, SharePoint Server 2019, but the cmdlet is still present in the product. - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPWorkManagementServiceApplication -Name 'Work Management Service Application' -ApplicationPool 'SharePoint Web Services Default' -``` - -This example creates a new Work Management Service Application using the Application Pool named SharePoint Web Services Default. - - -## PARAMETERS - -### -ApplicationPool -Specifies the name of an application pool to use; for example, SharePoint - 1213. -If no value is specified, the default application pool is used. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Work Management Service application to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -Specifies whether to add the Work Management Service application to the proxy group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPWorkManagementServiceApplicationProxy](New-SPWorkManagementServiceApplicationProxy.md) - -[Set-SPWorkManagementServiceApplication](Set-SPWorkManagementServiceApplication.md) - -[Set-SPWorkManagementServiceApplicationProxy](Set-SPWorkManagementServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkManagementServiceApplicationProxy.md deleted file mode 100644 index 8f08159b98..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkManagementServiceApplicationProxy.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Office.Server.WorkManagement.dll-help.xml -applicable: SharePoint Server 2013 -title: New-SPWorkManagementServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPWorkManagementServiceApplicationProxy - -## SYNOPSIS -Creates a new service application proxy group. - - -## SYNTAX - -``` -New-SPWorkManagementServiceApplicationProxy -Name <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DefaultProxyGroup] [-ServiceApplication <SPWorkManagementServiceCmdletPipeBind>] [-Uri <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `New-SPWorkManagementServiceApplicationProxy` cmdlet to create a new Work Management Service application proxy object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -Note: This functionality has been removed from SharePoint Server 2016, SharePoint Server 2019, but the cmdlet is still present in the product. - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$sa = New-SPWorkManagementServiceApplication -Name 'Work Management Service Application' -ApplicationPool 'SharePoint Web Services Default' -PS C:\>New-SPWorkManagementServiceApplicationProxy -name 'Work Management Service Application Proxy' -ServiceApplication $sa -``` - -This example creates a new SPWorkManagementServiceApplicationProxy called Work Management Service Application Proxy mapped to the "Work Management Service Application" Service Application. - - -## PARAMETERS - -### -Name -Specifies the display name for the new Work Management Service application proxy. -The name that you use must be a unique name of a Work Management Service application proxy in the farm. -The maximum length is 128 characters. - -The value must be a name of a valid Work Management Service application proxy; for example, WorkMgmtSvcProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the Work Management Service application proxy be added to the default proxy group for the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the local Work Management Service application that is associated with the new proxy. - -The value must be in one of the following forms: - ---A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh - ---A valid name of a Work Management Service application (for example, WorkManServ1) - ---An instance of a valid SPServiceApplication object - -```yaml -Type: SPWorkManagementServiceCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI of a remote Work Management service application to connect to. - -To specify the Work Management service application that this proxy is connecting to, you must set only the URI parameter or only the ServiceApplication parameter. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPWorkManagementServiceApplication](New-SPWorkManagementServiceApplication.md) - -[Set-SPWorkManagementServiceApplication](Set-SPWorkManagementServiceApplication.md) - -[Set-SPWorkManagementServiceApplicationProxy](Set-SPWorkManagementServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkflowServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkflowServiceApplicationProxy.md deleted file mode 100644 index 9d95a00956..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPWorkflowServiceApplicationProxy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.WorkflowServices.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: New-SPWorkflowServiceApplicationProxy -schema: 2.0.0 ---- - -# New-SPWorkflowServiceApplicationProxy - -## SYNOPSIS -Creates a proxy to connect to Workflow Manager. - - -## SYNTAX - -``` -New-SPWorkflowServiceApplicationProxy [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-PartitionMode] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a proxy to connect to Workflow Manager. - -Note: Consider using the cmdlet `Register-SPWorkflowService` instead which binds a Workflow Manager farm and creates the Workflow Service Proxy. - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>New-SPWorkflowServiceApplicationProxy -``` - -Creates a Workflow Service Application Proxy. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies that the service application restrict data by subscription. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Pause-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Pause-SPProjectWebInstance.md deleted file mode 100644 index e91a408fcb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Pause-SPProjectWebInstance.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Pause-SPProjectWebInstance -schema: 2.0.0 ---- - -# Pause-SPProjectWebInstance - -## SYNOPSIS -Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server PSI or CSOM. - - -## SYNTAX - -``` -Pause-SPProjectWebInstance [-Identity] <ProjectInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server Interface (PSI) or Client Server Object Model (CSOM). While in this state the database is not actually read-only and the Queue service can still write to the database, but it will not pick up any new jobs to process. This cmdlet is used to allow the queue to empty out before an administrator switches the database to read-only. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} -PS C:\>$instance = Get-SPProjectWebInstance -ServiceApplication $sa -PS C:\>Pause-SPProjectWebInstance -Identity $instance -``` - -Pauses the Project Web Server Instance in the Project Web Application Service Application. - -## PARAMETERS - -### -Identity -Specifies the instance of Project Web App to be switched to read-only mode. -It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite). - -```yaml -Type: ProjectInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Resume-SPProjectWebInstance](Resume-SPProjectWebInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Publish-SPServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Publish-SPServiceApplication.md deleted file mode 100644 index 8b2655b4b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Publish-SPServiceApplication.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Publish-SPServiceApplication -schema: 2.0.0 ---- - -# Publish-SPServiceApplication - -## SYNOPSIS -Shares the specified local service application outside the farm. - - -## SYNTAX - -``` -Publish-SPServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-InfoLink <Uri>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Publish-SPServiceApplication` cmdlet publishes the local service application, specified by the Identity parameter, outside the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Publish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -Description "Connect to this TestServiceApplcation of you want to use FeatureA in your farm" -InfoLink http://testurl -``` - -This example publishes a service application to another farm. - -The service application GUID is unique to every farm. -You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, `Grant-SPServiceApplication`. - - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application to share outside the farm. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Describes the service application to share outside the farm. -If no value is specified, the value is left blank. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InfoLink -Specifies the link to more information about the service application to share outside the farm. -If no link is specified, no link is made available. - -The type must be a valid URL, in the form http://server_name/Site_Name/page_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Receive-SPServiceApplicationConnectionInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Receive-SPServiceApplicationConnectionInfo.md deleted file mode 100644 index 6206209a0e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Receive-SPServiceApplicationConnectionInfo.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.SharePoint.TopologyService-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Receive-SPServiceApplicationConnectionInfo -schema: 2.0.0 ---- - -# Receive-SPServiceApplicationConnectionInfo - -## SYNOPSIS -Configures this farm to receive service information from another farm. - - -## SYNTAX - -``` -Receive-SPServiceApplicationConnectionInfo [-FarmUrl] <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [-Filter <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Receive-SPServiceApplicationConnectionInfo` cmdlet retrieves the list of service applications published by another farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Receive-SPServiceApplicationConnectionInfo -FarmUrl http://FarmB/topology/topology.svc -``` - -This example retreives a list of service applications published by a given farm. - -The FarmURL parameter can be obtained by the `Get-SPTopologyServiceApplication` cmdlet. - - -## PARAMETERS - -### -FarmUrl -Specifies the URL of the farm from which to receive service application information. - -The type must be a valid URL, in the form http://site_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Filter -Specifies a filter to use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Register-SPAppPrincipal.md b/sharepoint/sharepoint-ps/sharepoint-server/Register-SPAppPrincipal.md deleted file mode 100644 index edf476bd90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Register-SPAppPrincipal.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Register-SPAppPrincipal -schema: 2.0.0 ---- - -# Register-SPAppPrincipal - -## SYNOPSIS -Lets an on-premises administrator register an app principal. - -## SYNTAX - -``` -Register-SPAppPrincipal -DisplayName <String> -NameIdentifier <String> -Site <SPWebPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Register-SPAppPrincipal` cmdlet to let an on-premises farm administrator to register an app principal management service. - - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831(https://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$site = Get-SPSite "https://<urlofsite>" -PS C:\>Register-SPAppPrincipal -site $site.root -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" -DisplayName "Contoso" -``` - -This example registers the app principal named Contoso. - - -## PARAMETERS - -### -DisplayName -Specifies the friendly name to use for the app principal that is being registered. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameIdentifier -Specifies the app principal's name identifier that needs to be added to the app management service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -{{Fill Site Description}} - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppPrincipal](Get-SPAppPrincipal.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Register-SPWorkflowService.md b/sharepoint/sharepoint-ps/sharepoint-server/Register-SPWorkflowService.md deleted file mode 100644 index dbd557dc8f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Register-SPWorkflowService.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.SharePoint.WorkflowServices.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Register-SPWorkflowService -schema: 2.0.0 ---- - -# Register-SPWorkflowService - -## SYNOPSIS -Registers a Workflow Manager farm with the SharePoint farm. - - -## SYNTAX - -``` -Register-SPWorkflowService [-AllowOAuthHttp] [-AssignmentCollection <SPAssignmentCollection>] [-Force] - [-PartitionMode] -SPSite <SPSitePipeBind> [-ScopeName <String>] -WorkflowHostUri <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet registers a Workflow Manager farm with the SharePoint farm in order to allow users to leverage SharePoint 2013 workflows. - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Register-SPWorkflowService -SPSite https://site_name -WorkflowHostUri https://workflow.contoso.com:12290 -ScopeName SharePoint -``` -Registers the Workflow Manager farm located at https://workflow.contoso.com:12290 with the SharePoint farm using https://site_name as a reference. A custom Scope named 'SharePoint' is used. - -## PARAMETERS - -### -AllowOAuthHttp -Allows connecting to Workflow Manager using HTTP rather than HTTPS. This is not recommended for security. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Forces the registration, even if previously registered. Will overwrite the existing Scope. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionMode -Specifies to use a SharePoint multi-tenancy features when registering Workflow Manager. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SPSite -The Site Collection used as a reference to register Workflow Manager with the SharePoint farm. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeName -The name of the scope in Workflow Manager to use. if not specified, the default Scope will be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkflowHostUri -The URI on which the Workflow Manager is hosted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-DatabaseFromAvailabilityGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-DatabaseFromAvailabilityGroup.md deleted file mode 100644 index 7ea4e1d0ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-DatabaseFromAvailabilityGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-DatabaseFromAvailabilityGroup -schema: 2.0.0 ---- - -# Remove-DatabaseFromAvailabilityGroup - -## SYNOPSIS -Removes one or more SharePoint databases from an availability group in SQL Server. - - -## SYNTAX - -### Default -``` -Remove-DatabaseFromAvailabilityGroup [-AGName] <String> [-AssignmentCollection <SPAssignmentCollection>] - -DatabaseName <String> [-Force] [-KeepSecondaryData] [<CommonParameters>] -``` - -### AllDatabases -``` -Remove-DatabaseFromAvailabilityGroup [-AGName] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Force] [-KeepSecondaryData] [-ProcessAllDatabases] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [https://msdn.microsoft.com/library/dd878348(VS.85).aspx](https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-DatabaseFromAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -``` - -This example removes the availability group named "MyAvailabilityGroup" from the WSS_Content database. - - -## PARAMETERS - -### -AGName -The name of the availability group from which the databases are being removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the database to be removed from the availability group. - -NOTE: This parameter should not be used in conjunction with the ProcessAllDatabases parameter. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces a remove from the group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepSecondaryData -Specifies that copies of the databases on the replicas in the availability group will not be deleted. Otherwise, those database copies will be dropped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessAllDatabases -Removes all databases from the current SharePoint farm into the availability group. - -```yaml -Type: SwitchParameter -Parameter Sets: AllDatabases -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchContentCollection.md deleted file mode 100644 index 4b5785c33d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchContentCollection.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchContentCollection ---- - -# Remove-FASTSearchContentCollection - -## SYNOPSIS -Deletes a Microsoft FAST Search Server 2010 for SharePoint content collection. - -## SYNTAX - -``` -Remove-FASTSearchContentCollection [-Name] <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a FAST Search Server 2010 for SharePoint content collection. -All items in the collection will be deleted. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchContentCollection -Name newscollection -Force -``` - -This example removes the content collection named "newscollection" without asking the user to confirm the operation. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchContentCollection -Name newscollection -WhatIf -``` - -This example describes what would happen if you executed the Remove-FASTSearchContentCollection cmdlet. - -## PARAMETERS - -### -Name -The name of the content collection to delete. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. - -If Confirm is false (-Confirm:$false), you will not be prompted. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings so the user is not asked to confirm the operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-FASTSearchContentCollection](Clear-FASTSearchContentCollection.md) - -[New-FASTSearchContentCollection](New-FASTSearchContentCollection.md) - -[Get-FASTSearchContentCollection](Get-FASTSearchContentCollection.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataCategory.md deleted file mode 100644 index 309f916f75..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataCategory.md +++ /dev/null @@ -1,160 +0,0 @@ - --- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchMetadataCategory ---- - -# Remove-FASTSearchMetadataCategory - -## SYNOPSIS -Removes a crawled property category from the installation. - -## SYNTAX - -### Name -``` -Remove-FASTSearchMetadataCategory [-Name] <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -### Category -``` -Remove-FASTSearchMetadataCategory -Category <Category> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a crawled property category from your installation. -The cmdlet takes either the name of the category (Name parameter) or a category object (Category parameter). - -All crawled properties mapped to this category are also removed. -To avoid deleting crawled properties belonging to a category that you are about to remove, first map all crawled properties that you wish to save to a different property set using the Set-FASTSearchMetadataCrawledProperty cmdlet. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchMetadataCategory -name Sharepoint -``` - -This example deletes the category named "Sharepoint". -Confirmation of the operation is requested. -All crawled properties mapped to the "SharePoint" category are also removed. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$category = Get-FASTSearchMetadataCategory -name Office -Remove-FASTSearchMetadataCategory -category $category -force -``` - -This example deletes a crawled property category (stored as $category). -Since Force is specified, confirmation of the operation is not required. - -## PARAMETERS - -### -Name -The name of the category to delete. - -```yaml -Type: String -Parameter Sets: Name -Aliases: CategoryName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Category -A category object to be deleted. - -```yaml -Type: Category -Parameter Sets: Category -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. - -If Confirm is false (-Confirm $false), confirmation prompting is not used. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings, so that confirmation of the operation is not required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataCategory](Get-FASTSearchMetadataCategory.md) - -[Set-FASTSearchMetadataCategory](Set-FASTSearchMetadataCategory.md) - -[New-FASTSearchMetadataCategory](New-FASTSearchMetadataCategory.md) - -[Set-FASTSearchMetadataCrawledProperty](Set-FASTSearchMetadataCrawledProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataCrawledPropertyMapping.md deleted file mode 100644 index e0a904bb26..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataCrawledPropertyMapping.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchMetadataCrawledPropertyMapping ---- - -# Remove-FASTSearchMetadataCrawledPropertyMapping - -## SYNOPSIS -Removes a crawled-property-to-managed-property mapping. - -## SYNTAX - -``` -Remove-FASTSearchMetadataCrawledPropertyMapping -CrawledProperty <CrawledProperty> - -ManagedProperty <ManagedProperty> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes the mapping of a crawled property to a managed property. -Both the managed property and the crawled property still exist after the mapping is removed. - -The cmdlet parameters are both objects, and must be retrieved separately. - -The content must be recrawled/re-fed for the search index to reflect that the mapping was removed. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>$title = Get-FASTSearchMetadataManagedProperty -name title -PS C:\>$crawledproperties = $title.GetCrawledPropertyMappings() -PS C:\>$crawledproperties # To List the output before the removal -PS C:\>Remove-FASTSearchMetadataCrawledPropertyMapping -managedproperty $title -crawledproperty $crawledproperties[4] -PS C:\>$crawledproperties # To list the output after the removal -``` - -This example removes the mapping of the crawled property "sitemap.title" to the managed property "title". - -This example calls the GetCrawledPropertyMappings() method call exposed by the managed property, but you could also find the crawled property by using Get-FASTSearchMetadataCrawledProperty. -The return value from GetCrawledPropertyMappings() is an array of crawled properties, of which the last is the "sitemap.title" crawled property mapping. -The last of the crawled properties (array index 4) has the mapping removed from it by calling Remove-FASTSearchMetadataCrawledPropertyMapping. - -## PARAMETERS - -### -CrawledProperty -The crawled property which is having a mapping removed. -The object can be retrieved by using Get-FASTSearchMetadataCrawledProperty, or by using the GetCrawledPropertyMappings() method call on a managed property object. - -```yaml -Type: CrawledProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -The managed property object which is having a mapping removed. -The object can be retrieved by using the Get-FASTSearchMetadataManagedPropertycmdlet. - -```yaml -Type: ManagedProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. -If Confirm is false (-Confirm:$false), confirmation prompting is not used. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings, so that confirmation of the operation is not required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataCrawledPropertyMapping](Get-FASTSearchMetadataCrawledPropertyMapping.md) - -[New-FASTSearchMetadataCrawledPropertyMapping](New-FASTSearchMetadataCrawledPropertyMapping.md) - -[Set-FASTSearchMetadataCrawledPropertyMapping](Set-FASTSearchMetadataCrawledPropertyMapping.md) - -[Get-FASTSearchMetadataCrawledProperty](Get-FASTSearchMetadataCrawledProperty.md) - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataFullTextIndex.md deleted file mode 100644 index eba915dbea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataFullTextIndex.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchMetadataFullTextIndex ---- - -# Remove-FASTSearchMetadataFullTextIndex - -## SYNOPSIS -Removes a full text index from the Microsoft FAST Search Server 2010 for SharePoint system. - -## SYNTAX - -### FullTextIndex -``` -Remove-FASTSearchMetadataFullTextIndex -FullTextIndex <FullTextIndex> [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -### Name -``` -Remove-FASTSearchMetadataFullTextIndex -Name <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes a full text index. -The content of the index is removed and is no longer searchable. -The managed properties mapped to the full text index are still available and can be mapped to other or new full text indexes. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchMetadataFullTextIndex -name secondarycontent -``` - -This example removes the full text index named "secondarycontent" from the FAST Search Server 2010 for SharePoint system. -The cmdlet asks for confirmation as long as neither the Force parameter is used or the $ConfirmPreference environment is set to a higher value than HIGH. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$index=Get-FASTSearchMetadataFullTextIndex -name secondarycontent -Remove-FASTSearchMetadataFullTextIndex -FullTextIndex $index -force -``` - -This example removes the full text index represented by the $index variable. -Since the Force parameter is specified, confirmation of the index removal is not used. - -## PARAMETERS - -### -FullTextIndex -A full text index object representing the full text index to remove. - -```yaml -Type: FullTextIndex -Parameter Sets: FullTextIndex -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the full text index to remove. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. -If Confirm is false (-Confirm:$false), confirmation prompting is not used. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings, so that confirmation of the operation is not required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataFullTextIndex](New-FASTSearchMetadataFullTextIndex.md) - -[Set-FASTSearchMetadataFullTextIndex](Set-FASTSearchMetadataFullTextIndex.md) - -[Get-FASTSearchMetadataFullTextIndex](Get-FASTSearchMetadataFullTextIndex.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataFullTextIndexMapping.md deleted file mode 100644 index 583d365530..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataFullTextIndexMapping.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchMetadataFullTextIndexMapping ---- - -# Remove-FASTSearchMetadataFullTextIndexMapping - -## SYNOPSIS -Removes a managed-property-to-full-text-index mapping. - -## SYNTAX - -``` -Remove-FASTSearchMetadataFullTextIndexMapping [-Mapping] <FullTextIndexMapping> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes the mapping of a managed property to a full text index. -The managed properties are not affected, and can still be mapped to other full text indexes. - -The content must be recrawled/re-fed to reflect that managed properties have been removed from full text indexes. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>$fulltextindex = Get-FASTSearchMetadataFullTextIndex -Name content -PS C:\>$managedproperty = Get-FASTSearchMetadataManagedProperty -Name CreatedBy -PS C:\>$fulltextindexmapping = Get-FASTSearchMetadataFullTextIndexMapping -ManagedProperty $managedproperty -FullTextIndex $fulltextindex -PS C:\>Remove-FASTSearchMetadataFullTextIndexMapping -mapping $fulltextindexmapping -``` - -This example removes the mapping of the managed property "CreatedBy" from the full text index "content". -Since the cmdlet takes an object of the mapping, the example first retrieves the mapping using Get-FASTSearchMetadataFullTextIndexMapping. - -## PARAMETERS - -### -Mapping -An object representing the full text index mapping to be removed. - -```yaml -Type: FullTextIndexMapping -Parameter Sets: (All) -Aliases: FullTextIndexMapping, M -Applicable: FAST Server for SharePoint 2010 - -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataFullTextIndexMapping](New-FASTSearchMetadataFullTextIndexMapping.md) - -[Set-FASTSearchMetadataFullTextIndexMapping](Set-FASTSearchMetadataFullTextIndexMapping.md) - -[Get-FASTSearchMetadataFullTextIndexMapping](Get-FASTSearchMetadataFullTextIndexMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataManagedProperty.md deleted file mode 100644 index 9d7c9c8d36..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataManagedProperty.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchMetadataManagedProperty ---- - -# Remove-FASTSearchMetadataManagedProperty - -## SYNOPSIS -Removes a managed property from the Microsoft FAST Search Server 2010 for SharePoint system. - -## SYNTAX - -### Name -``` -Remove-FASTSearchMetadataManagedProperty [-Name] <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -### ManagedProperty -``` -Remove-FASTSearchMetadataManagedProperty -ManagedProperty <ManagedProperty> [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This command removes a managed property and its content from the FAST Search Server 2010 for SharePoint system. -If the managed property is mapped into any full text indexes, the mapping is also removed. -If there are any crawled property mappings to this managed property, those mappings are also removed. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchMetadataManagedProperty -Name title -``` - -This example removes the managed property named "title" from the system. -It will ask for confirmation before going through with the removal unless Force is specified. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>$createdby = Get-FASTSearchMetadataManagedProperty -name CreatedBy -PS C:\>Remove-FASTSearchMetadataManagedProperty -ManagedProperty $createdby -Force -``` - -This example removes the managed property represented by the object $managedproperty. -The object is retrieved by calling Get-FASTSearchMetaDataManagedProperty, but any other call that returns a ManagedPropertyImpl object is acceptable. - -No confirmation is required, since the Force parameter is specified. - -## PARAMETERS - -### -Name -The name of the managed property to remove. - -```yaml -Type: String -Parameter Sets: Name -Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ManagedProperty -An object that represents the managed property to remove. - -```yaml -Type: ManagedProperty -Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. -If Confirm is false (-Confirm:$false), confirmation prompting is not used. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings, so that confirmation of the operation is not required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - -[New-FASTSearchMetadataManagedProperty](New-FASTSearchMetadataManagedProperty.md) - -[Set-FASTSearchMetadataManagedProperty](Set-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataRankProfile.md deleted file mode 100644 index 2558331427..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchMetadataRankProfile.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchMetadataRankProfile ---- - -# Remove-FASTSearchMetadataRankProfile - -## SYNOPSIS -Removes a rank profile from the Microsoft FAST Search Server 2010 for SharePoint system. - -## SYNTAX - -### Name -``` -Remove-FASTSearchMetadataRankProfile [-Name] <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -### RankProfile -``` -Remove-FASTSearchMetadataRankProfile -RankProfile <RankProfile> [-Confirm] [-Force] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes a rank profile from the FAST Search Server 2010 for SharePoint system. - -A rank profile controls relevance calculation when searching a full text index. -If a deleted rank profile is specified when searching, then the default rank profile is used. - -The default rank profile cannot be deleted. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchMetadataRankProfile -Name webcontent -``` - -This example removes the rank profile "webcontent". - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>$rankprofile = Get-FASTSearchMetadataRankProfile -Name newrankprofile -PS C:\>Remove-FASTSearchMetadataRankProfile -Force -RankProfile $rankprofile -``` - -This example deletes the rank profile object which represents the rank profile named "newrankprofile". - -No confirmation is required, since the Force parameter is specified. - -## PARAMETERS - -### -Name -The name of the rank profile to remove. - -```yaml -Type: String -Parameter Sets: Name -Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RankProfile -An object representing the rank profile to remove. - -```yaml -Type: RankProfile -Parameter Sets: RankProfile -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. - -If Confirm is false (-Confirm:$false), confirmation prompting is not used. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is greater than or equal to the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings, so that confirmation of the operation is not required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataRankProfile](New-FASTSearchMetadataRankProfile.md) - -[Set-FASTSearchMetadataRankProfile](Set-FASTSearchMetadataRankProfile.md) - -[Get-FASTSearchMetadataRankProfile](Get-FASTSearchMetadataRankProfile.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchResource.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchResource.md deleted file mode 100644 index 2aef03a539..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchResource.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchResource ---- - -# Remove-FASTSearchResource - -## SYNOPSIS -Deletes a resource from the resource store. - -## SYNTAX - -``` -Remove-FASTSearchResource [-Path] <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a specified file located in the Microsoft FAST Search Server 2010 for SharePoint resource store. -The location of the resource store is typically specified in %FASTSEARCH%/etc/Admin.config (where %FASTSEARCH% is the FAST Search Server 2010 for SharePoint installation folder.) - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchResource dictionaries\spellcheck\check_en.aut -``` - -This example deletes the resource dictionaries\spellcheck\check_en.aut from the resource store. - -## PARAMETERS - -### -Path -Partial URI within the resource store of the file which will be deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceURI -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchResource](Get-FASTSearchResource.md) - -[Add-FASTSearchResource](Add-FASTSearchResource.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSearchSettingGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSearchSettingGroup.md deleted file mode 100644 index e325a54741..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSearchSettingGroup.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchSearchSettingGroup ---- - -# Remove-FASTSearchSearchSettingGroup - -## SYNOPSIS -Deletes a Microsoft FAST Search Server 2010 for SharePoint search setting group. - -## SYNTAX - -``` -Remove-FASTSearchSearchSettingGroup -Name <String> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a FAST Search Server 2010 for SharePoint search setting group. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSearchSettingGroup -Name marketinggroup -``` - -This example deletes the "marketinggroup" search setting group. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSearchSettingGroup -Name marketinggroup -Force -``` - -This example deletes the "marketinggroup" search setting group without being prompted to confirm the operation. - -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSearchSettingGroup -Name marketinggroup -WhatIf -``` - -This example describes what would happen if you executed the Remove-FASTSearchSearchSettingGroup cmdlet. - -## PARAMETERS - -### -Name -The name of the search setting group to delete. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated. - -If Confirm is false (-Confirm:$false), you will not be prompted. - -In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmPreference shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides any user prompting settings so the user is not asked to confirm the operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSearchSettingGroup](New-FASTSearchSearchSettingGroup.md) - -[Get-FASTSearchSearchSettingGroup](Get-FASTSearchSearchSettingGroup.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSecurityAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSecurityAliaser.md deleted file mode 100644 index 3543b025e7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSecurityAliaser.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchSecurityAliaser ---- - -# Remove-FASTSearchSecurityAliaser - -## SYNOPSIS -Removes a security aliaser. - -## SYNTAX - -``` -Remove-FASTSearchSecurityAliaser [-Identity] <String> [[-SecurityAliaserToRemove] <SecurityAliaser>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a regular expression or XML aliaser. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSecurityAliaser -Identity xmlalias2 -``` - -This example deletes an XML aliaser. -A prompt is displayed to confirm the request. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSecurityAliaser -Identity xmlalias4 -Confirm:$False -``` - -This example deletes an XML aliaser without displaying a prompt. - -## PARAMETERS - -### -Identity -The identity of the regular expression or XML aliaser to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityAliaserToRemove -A SecurityXMLAliaser or SecurityRegexAliaser object whose identity is used as the aliaser identity to remove. - -```yaml -Type: SecurityAliaser -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 10000 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated and you must confirm the remove request. - -To suppress user prompting, set the confirm parameter to false. -For example: -confirm:$false - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityAliaser](Get-FASTSearchSecurityAliaser.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSecurityUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSecurityUserStore.md deleted file mode 100644 index fd6445de8a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSecurityUserStore.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchSecurityUserStore ---- - -# Remove-FASTSearchSecurityUserStore - -## SYNOPSIS -Removes a user store. - -## SYNTAX - -``` -Remove-FASTSearchSecurityUserStore [-Identity] <String> [[-SecurityUserStoreToRemove] <SecurityUserStore>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a security user store. -The user store may be a Lotus Notes, Microsoft, or claims user store. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSecurityUserStore -Identity wn1 -``` - -This example deletes the "wn1" user store. -A prompt is displayed to confirm the request. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityLotusNotesUserStore ln2 | remove-FASTSearchSecurityUserStore -``` - -This example deletes the user store specified by a piped SecurityUserStoreToRemove instance. -A prompt is displayed to confirm the request. - -## PARAMETERS - -### -Identity -The identity of the user store to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityUserStoreToRemove -A MicrosoftUserStore, LotusNotesUserStore, or ClaimsUserStore instance whose identity is used to remove the user store. - -```yaml -Type: SecurityUserStore -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Activates user prompting to confirm the operation. -If set, prompting is activated and you must confirm the remove request. - -To suppress user prompting, set the confirm parameter to false. -For example: -confirm:$false - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityUserStore](Get-FASTSearchSecurityUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSpelltuning.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSpelltuning.md deleted file mode 100644 index 5db9c05e48..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-FASTSearchSpelltuning.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Remove-FASTSearchSpelltuning ---- - -# Remove-FASTSearchSpelltuning - -## SYNOPSIS -Disables spell tuning. - -## SYNTAX - -``` -Remove-FASTSearchSpelltuning [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet disables the alignment of the spell check dictionaries with indexed content. -This cmdlet stops the generation of new dictionaries, and the Did You Mean feature will only use content that was fed into the index before this cmdlet was run. - -After disabling the dictionary-index alignment, use the Reset-FASTSearchSpelltuning cmdlet to return to the out-of-the-box spelling dictionaries. -Did You Mean will then make suggestions based on standard spell checking dictionaries, not on indexed content. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### (FAST Server for SharePoint 2010) -``` -PS C:\>Remove-FASTSearchSpelltuning -``` - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSpelltuningStatus](Get-FASTSearchSpelltuningStatus.md) - -[Reset-FASTSearchSpelltuning](Reset-FASTSearchSpelltuning.md) - -[Add-FASTSearchSpelltuning](Add-FASTSearchSpelltuning.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAccessServicesDatabaseServer.md deleted file mode 100644 index 7ecda9ca9f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAccessServicesDatabaseServer.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPAccessServicesDatabaseServer -schema: 2.0.0 ---- - -# Remove-SPAccessServicesDatabaseServer - -## SYNOPSIS -{{Fill in the Synopsis}} - - -## SYNTAX - -``` -Remove-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -{{Fill DatabaseServer Description}} - -```yaml -Type: AccessServicesDatabaseServerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerGroup -{{Fill DatabaseServerGroup Description}} - -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -{{Fill ServiceContext Description}} - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPActivityFeedItems.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPActivityFeedItems.md deleted file mode 100644 index f8a7e4af2b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPActivityFeedItems.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPActivityFeedItems -schema: 2.0.0 ---- - -# Remove-SPActivityFeedItems - -## SYNOPSIS -Removes activity events from the published and consolidated tables. - - -## SYNTAX - -``` -Remove-SPActivityFeedItems [-AllItems <Boolean>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-ID <Int64>] -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> [-SearchText <String>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-SPActivityFeedItems cmdlet to remove an activity event. - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -$upaProxy = Get-SPServiceApplicationProxy 1232b6f7-b9ff-99ad-0cd0-fg1g67h981aq -$upaProxy = Get-SPServiceApplicationProxy 1232b6f7-b9ff-99ad-0cd0-fg1g67h981aq -``` - -This example removes the specific user profile service application. - - -## PARAMETERS - -### -AllItems -Specifies whether to delete events.A value of "1" deletes all events. -A value of "0", no events are deleted.The default value is 0 (zero). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ID -Limits events deleted to those which match the specified ActivityEventID. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchText -Limits events deleted to those which contain SearchText in the string. - -Note that the SearchText will apply to *all* of the XML text saved in SQL representing this activity. The text seen in a browser window may be saved in a different representation in SQL. For example, a ">" feed symbol may be represented as ">" text in SQL, so the SearchText should reference “>” instead of “>”. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. - -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -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 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind -Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAlternateURL.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAlternateURL.md deleted file mode 100644 index 2b0eb87833..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAlternateURL.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPAlternateURL -schema: 2.0.0 ---- - -# Remove-SPAlternateURL - -## SYNOPSIS -Completely deletes the specified alternate URL. - - -## SYNTAX - -``` -Remove-SPAlternateURL [-Identity] <SPAlternateUrlPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPAlternateUrl` cmdlet completely deletes the alternate URL specified by the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Remove-SPAlternateURL -WebApplication http://sitename -Zone Extranet -``` - -This example deletes the extranet URL for the given Web application. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Remove-SPAlternateURL -``` - -This example removes all extranet alternate URLs in the farm. - - -## PARAMETERS - -### -Identity -Specifies the identity of the alternate URL to delete. -The identity can be either a valid URL, in the form http://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPAlternateUrlPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAppDeniedEndpoint.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAppDeniedEndpoint.md deleted file mode 100644 index 23640c5ddc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAppDeniedEndpoint.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPAppDeniedEndpoint -schema: 2.0.0 ---- - -# Remove-SPAppDeniedEndpoint - -## SYNOPSIS -Removes a relative URL endpoint of a server from the list of app-denied endpoints. - - -## SYNTAX - -``` -Remove-SPAppDeniedEndpoint [-Endpoint] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPAppDeniedEndpoint` cmdlet to remove a relative URL endpoint of a server from the list of app-denied endpoints. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" -``` - -This example removes the "/_vti_bin/contoso/service.asmx" endpoint from the list of denied endpoints for apps. -Apps will be able to access this endpoint because it is being removed from the app-denied endpoint list. - - -## PARAMETERS - -### -Endpoint -Specifies a relative URL endpoint of a server that will be removed from the list of app-denied endpoints. -Apps will not be able to access relative URL endpoints of a server that exist in the app-denied endpoint list. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPAppDeniedEndpoint](Remove-SPAppDeniedEndpoint.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAppPrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAppPrincipalPermission.md deleted file mode 100644 index d0826132ad..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPAppPrincipalPermission.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPAppPrincipalPermission -schema: 2.0.0 ---- - -# Remove-SPAppPrincipalPermission - -## SYNOPSIS -Removes the permissions on a specified app principal. - - -## SYNTAX - -``` -Remove-SPAppPrincipalPermission -AppPrincipal <SPAppPrincipal> -Scope <SPCmdletAppPrincipalPermissionScope> - -Site <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [-DisableAppOnlyPolicy] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPAppPrincipalPermission` cmdlet to remove the permissions on a specified app principal for a given scope (that is, SharePoint Online, site collection, or web). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------EXAMPLE------------ -``` -PS C:\>$clientID = "11111111-2222-3333-4444-555555555555" -PS C:\>$site = Get-SPSite http://siteUrl -PS C:\>$realm = Get-SPAuthenticationRealm -ServiceContext $site -PS C:\>$appIdentifier = $clientID + "@" + $realm -PS C:\>$appPrincipal = Get-SPAppPrincipal -NameIdentifier $appIdentifier -Web $site.RootWeb -PS C:\>Remove-AppPrincipalPermission -AppPrincipal $appPrincipal -site $site.RootWeb -Scope Site -``` - -This example removes the App Principal permission from the site collection scope. - - -## PARAMETERS - -### -AppPrincipal -Specifies the AppPrincipal object to remove. - -```yaml -Type: SPAppPrincipal -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which to apply the principal permission. - -The value is any of the following scopes: - ---Site - ---SiteCollection - ---SiteSubscription - -```yaml -Type: SPCmdletAppPrincipalPermissionScope -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site (that is, SPWeb object) to remove. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAppOnlyPolicy -Disables the app only policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPAppPrincipalPermission](Set-SPAppPrincipalPermission.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPApplicationCredentialKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPApplicationCredentialKey.md deleted file mode 100644 index f02f24fbf2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPApplicationCredentialKey.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2019 -title: Remove-SPApplicationCredentialKey -schema: 2.0.0 ---- - -# Remove-SPApplicationCredentialKey - -## SYNOPSIS -Removes the application credential key from the local server. - - -## SYNTAX - -``` -Remove-SPApplicationCredentialKey [-AssignmentCollection <SPAssignmentCollection>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - - -## DESCRIPTION -Use the **Remove-SPApplicationCredentialKey** cmdlet to remove the application credential key from the local server. The application credential key is used by certain features to encrypt and decrypt passwords. - -## EXAMPLES - -### EXAMPLE -```powershell -PS C:\> Remove-SPApplicationCredentialKey -Confirm:$false -``` -This example removes the application credential key from the local server without prompting for user confirmation. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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). - - -## RELATED LINKS - -[Set-ApplicationCredentialKey](Set-ApplicationCredentialKey.md) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPBusinessDataCatalogModel.md deleted file mode 100644 index eca864f95d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPBusinessDataCatalogModel.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPBusinessDataCatalogModel -schema: 2.0.0 ---- - -# Remove-SPBusinessDataCatalogModel - -## SYNOPSIS -Deletes a Business Data Connectivity Model. - - -## SYNTAX - -``` -Remove-SPBusinessDataCatalogModel -Identity <MetadataObject> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPBusinessDataCatalogModel` cmdlet deletes a Business Data Connectivity Model. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$modelFile = Get-SPBusinessDataCatalogMetadataObject -Name "ContosoModel" -BdcObjectType Model -ServiceContext http://contoso - -PS C:\>Remove-SPBusinessDataCatalogModel -Identity $modelFile -``` - -This example removes the Business Data Connectivity Model file named ContosoModel. - - -## PARAMETERS - -### -Identity -Specifies the Business Data Connectivity Metadata Store metadata object to remove. - -```yaml -Type: MetadataObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPCentralAdministration.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPCentralAdministration.md deleted file mode 100644 index 2f863caffa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPCentralAdministration.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPCentralAdministration -schema: 2.0.0 ---- - -# Remove-SPCentralAdministration - -## SYNOPSIS -Removes the SharePoint Central Administration web site from the local server. - - -## SYNTAX - -``` -Remove-SPCentralAdministration [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Removes the SharePoint Central Administration web site from the local server. - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPCentralAdministration -``` -This example removes the Central Administration web site from the local server. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPClaimProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPClaimProvider.md deleted file mode 100644 index e2422f71d7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPClaimProvider.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPClaimProvider -schema: 2.0.0 ---- - -# Remove-SPClaimProvider - -## SYNOPSIS -Unregisters a claim provider. - - -## SYNTAX - -``` -Remove-SPClaimProvider [-Identity] <SPClaimProviderPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPClaimProvider` cmdlet unregisters a claim provider. -If the unregistered claim provider was assigned to a trusted identity token issuer, the trusted token issuer will use the default (system) claim provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove - SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh" -``` - -This example removes a claim provider from the farm - - -## PARAMETERS - -### -Identity -Specifies the claim provider to unregister. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. - -```yaml -Type: SPClaimProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPClaimTypeMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPClaimTypeMapping.md deleted file mode 100644 index ba0e2b01e3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPClaimTypeMapping.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPClaimTypeMapping -schema: 2.0.0 ---- - -# Remove-SPClaimTypeMapping - -## SYNOPSIS -Deletes a claim type mapping rule for a security token service (STS) identity provider. - - -## SYNTAX - -``` -Remove-SPClaimTypeMapping [-Identity] <SPClaimMappingPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] -TrustedIdentityTokenIssuer <SPTrustedIdentityTokenIssuerPipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPClaimMapping` cmdlet deletes a claim type mapping rule from a farm trust STS identity provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE------------------------- -``` -PS C:\>Remove-SPClaimMapping "Email" | Get-SPIdentityProvider "LiveIDSTS" -``` - -This example removes an identity provider named LiveIDSTS. - - -## PARAMETERS - -### -Identity -Specifies the claim mapping to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. - -```yaml -Type: SPClaimMappingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedIdentityTokenIssuer -Specifies the token issuer or a valid SPTrustedIdentityTokenIssuerPipeBind object. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -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 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPConfigurationDatabase.md deleted file mode 100644 index a454ba31dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPConfigurationDatabase.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPConfigurationDatabase -schema: 2.0.0 ---- - -# Remove-SPConfigurationDatabase - -## SYNOPSIS -Permanently removes a configuration database. - - -## SYNTAX - -``` -Remove-SPConfigurationDatabase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPConfigurationDatabase` cmdlet permanently removes the farm's configuration database. -The configuration database must be already dismounted from any associated farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPConfigurationDatabase -``` - -This example permanently deletes a configuration database from a farm. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDatabase.md deleted file mode 100644 index fe609af77c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDatabase.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPContentDatabase -schema: 2.0.0 ---- - -# Remove-SPContentDatabase - -## SYNOPSIS -Deletes a content database. - -## SYNTAX - -``` -Remove-SPContentDatabase [-Identity] <SPContentDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPContentDatabase` cmdlet deletes a content database permanently from SQL Server. -In situations where data needs to be persisted, use the `Dismount-SPContentDatabase` cmdlet. -This will remove the content database from SharePoint Products but not from SQL Server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE--------------------- -``` -PS C:\>Remove-SPContentDatabase WSS_Content -``` - -This example deletes the content database named 'WSS_Content'. - - -## PARAMETERS - -### -Identity -Specifies the content database to delete. - -The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies the force of a removal. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDeploymentJob.md deleted file mode 100644 index 540340c2b9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDeploymentJob.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPContentDeploymentJob -schema: 2.0.0 ---- - -# Remove-SPContentDeploymentJob - -## SYNOPSIS -Removes a content deployment job. - - -## SYNTAX - -``` -Remove-SPContentDeploymentJob [-Identity] <SPContentDeploymentJobPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPContentDeploymentJob` cmdlet removes a content deployment job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPContentDeploymentJob -Identity "DeployJob1" -``` - -This example removes a deployment job named DeployJob1. - - -## PARAMETERS - -### -Identity -Specifies the content deployment job to remove. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployJob1); or an instance of a valid SPContentDeploymentJob object. - -```yaml -Type: SPContentDeploymentJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDeploymentPath.md deleted file mode 100644 index a98597fcd4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPContentDeploymentPath.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPContentDeploymentPath -schema: 2.0.0 ---- - -# Remove-SPContentDeploymentPath - -## SYNOPSIS -Removes a content deployment path. - - -## SYNTAX - -``` -Remove-SPContentDeploymentPath [-Identity] <SPContentDeploymentPathPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPContentDeploymentPath` cmdlet removes a content deployment path. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPContentDeploymentPath -Path1 -``` - -This example removes a content path named Path1. - - -## PARAMETERS - -### -Identity -Specifies the content deployment path to remove. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment path (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. - -```yaml -Type: SPContentDeploymentPathPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDeletedSite.md deleted file mode 100644 index 12d93db309..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDeletedSite.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPDeletedSite -schema: 2.0.0 ---- - -# Remove-SPDeletedSite - -## SYNOPSIS -Removes a deleted site collection. - - -## SYNTAX - -``` -Remove-SPDeletedSite [-Identity] <SPDeletedSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-ContentDatabase <SPContentDatabasePipeBind>] [-WebApplication <SPWebApplicationPipeBind>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the `Remove-SPDeletedSite` cmdlet to permanently remove a deleted site collection from the farm. - -Unlike the `Remove-SPSite` cmdlet that uses the host name and scheme for the Identity parameter (that is, http://server_name), the value of the identity parameter for all SPDeletedSite cmdlets use a server-relative URL. -Typically, the forward slash character (/) begins the relative URL and also denotes the root site. - -For additional information about a server-relative URL or understanding general concepts about absolute and relative URLs, see Server Relative URL Property (http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spsite.serverrelativeurl.aspx) or Understanding Absolute and Relative URL Addresses (http://msdn.microsoft.com/en-us/library/bb208688(office.12).aspx). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c -``` - -This example permanently removes a specific deleted site collection by using a site ID. - - -## PARAMETERS - -### -Identity -Specifies the identity of the deleted site collection to permanently delete. -The identity can be either a valid server-relative URL in the form /sites/site_name; a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPDeletedSite object. - -```yaml -Type: SPDeletedSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the GUID of the content database from which to list site collections. - -The type must be a valid database name in the form SPContentDB01 or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the Web application from which to list sites. - -The type must be a valid URL in the form http://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDiagnosticsPerformanceCounter.md deleted file mode 100644 index b598bd4c11..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDiagnosticsPerformanceCounter.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPDiagnosticsPerformanceCounter -schema: 2.0.0 ---- - -# Remove-SPDiagnosticsPerformanceCounter - -## SYNOPSIS -Removes an instance of a performance counter. - - -## SYNTAX - -``` -Remove-SPDiagnosticsPerformanceCounter [-Category] <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Counter <String>] [-DatabaseServer] [-Instance <String>] [-WebFrontEnd] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPDiagnosticsPerformanceCounter` cmdlet removes performance counters from the collection of performance counters that are read and recorded in the usage database. -This cmdlet can also be used to remove entire categories and types of counters from the collection. -If either the DatabaseServer or WebFrontEnd parameters are not specified, this cmdlet removes the specified performance counters on the front end Web servers in the farm. - -The `Remove-SPDiagnosticsPerformanceCounter` cmdlet is only available by using Windows PowerShell. -There is no user interface. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Remove-SPDiagnosticsPerformanceCounter -category ASP.NET -``` - -This example removes all the counters in the category ASP.NET on front end Web servers. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Remove-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued" -``` - -This example removes the counters in the category ASP.NET that have requests queued on front end Web servers. - - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>Remove-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserver -``` - -This example removes the counters of the _Total instance, with the counter % Processor Time in the category Processor on database servers. - - -## PARAMETERS - -### -Category -Specifies the category of performance counters to remove. - -The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Counter -Specifies the type of counter to remove. -If this parameter is not specified, this cmdlet removes all performance counters of the specified category. - -The type must be a valid name of counter type; for example, Requests Queued, Avg. -Disk Queue Length, and % Processor Time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseServer -Removes the specified performance counters that are collected on the database servers in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies the instance name of the performance counter to remove. -If this parameter is not specified, this cmdlet removes all instances of the specified performance counter. - -The type must be a valid name of a performance counter instance; for example Total_PerfCounter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebFrontEnd -Removes performance counters that are collected on the front end Web servers in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDistributedCacheServiceInstance.md deleted file mode 100644 index f66a29e5e0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPDistributedCacheServiceInstance.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPDistributedCacheServiceInstance -schema: 2.0.0 ---- - -# Remove-SPDistributedCacheServiceInstance - -## SYNOPSIS -Removes an instance of the distributed cache service from a local server. - -## SYNTAX - -``` -Remove-SPDistributedCacheServiceInstance [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-SPDistributedCacheServiceInstance cmdlet to remove an instance of the distributed cache service from a local server. This is required to stop the AppFabric service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPDistributedCacheServiceInstance -``` - -This example removes an instance of a distributed cache. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-SPDistributedCacheServiceInstance](Add-SPDistributedCacheServiceInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEduClassMember.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEduClassMember.md deleted file mode 100644 index 2b0a1c76aa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEduClassMember.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Remove-SPEduClassMember -schema: 2.0.0 ---- - -# Remove-SPEduClassMember - -## SYNOPSIS -Do not use - - -## SYNTAX - -``` -Remove-SPEduClassMember [-AssignmentCollection <SPAssignmentCollection>] -ClassId <String> - -Site <SPSitePipeBind> -UserAlias <String> [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -Do not use -``` - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClassId -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Site -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -UserAlias -Do not use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchComponent.md deleted file mode 100644 index b4ba9f330f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchComponent.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchComponent -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchComponent - -## SYNOPSIS -Removes the specified search component from the given search topology. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchComponent [-Identity] <SearchComponentPipeBind> - -SearchTopology <SearchTopologyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes the specified search component from an inactive search topology. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e -PS C:\>Remove-SPEnterpriseSearchComponent -SearchTopology $topology -Identity c1642176-b9ae-4096-834c-080da5fba90e -``` - -This example removes the search component with identity c1642176-b9ae-4096-834c-080da5fba90e from the search topology with identity 10fa59cb-4b32-4fe6-8f8d-065388df201e from the default search application. - - -## PARAMETERS - -### -Identity -Specifies the identity for a search component - -```yaml -Type: SearchComponentPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchTopology -Specifies the search topology from which to retrieve the search component/search components. - - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the search topology and search component/search components. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md deleted file mode 100644 index 4b07784634..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchContentEnrichmentConfiguration -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchContentEnrichmentConfiguration - -## SYNOPSIS -Removes the current content enrichment configuration from the search service application. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes the current content enrichment configuration from the SearchServiceApplication. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Remove-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -``` - -This example removes the content enrichment configuration from the default search service application. - - -## PARAMETERS - -### -SearchApplication -Specifies the SearchServiceApplication that contains content enrichment configuration. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchContentEnrichmentConfiguration](Get-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[Set-SPEnterpriseSearchContentEnrichmentConfiguration](Set-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[New-SPEnterpriseSearchContentEnrichmentConfiguration](New-SPEnterpriseSearchContentEnrichmentConfiguration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlContentSource.md deleted file mode 100644 index a989580b56..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlContentSource.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlContentSource -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlContentSource - -## SYNOPSIS -Deletes a specified crawl content source from a search application. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchCrawlContentSource` cmdlet deletes a specified crawl content source from a service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" -PS C:\>$topo = Get-SPEnterpriseSearchCrawlTopology -SearchApplication $searchapp -PS C:\>New-SPEnterpriseSearchCrawlTopology -SearchApplication $searchapp -clone -CrawlTopology $topo -PS C:\>$newtopo = Get-SPEnterpriseSearchCrawlTopology -SearchApplication $searchapp -Identity 11111111-1111-1111-1111-111111111111 -PS C:\>$cc = Get-SPEnterpriseSearchCrawlComponent -CrawlTopology $newtopo -Identity 22222222-2222-2222-2222-222222222222 -PS C:\>$cc | Remove-SPEnterpriseSearchCrawlComponent -PS C:\>$newtopo | Set-SPEnterpriseSearchCrawlTopology -Active -``` - -This example creates a new, inactive, crawl topology, removes a crawl component from it and activates the new crawl topology. - - -## PARAMETERS - -### -Identity -The crawl content source to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. - -```yaml -Type: ContentSourcePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl content source. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlCustomConnector.md deleted file mode 100644 index 999cd27bcc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlCustomConnector.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlCustomConnector -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlCustomConnector - -## SYNOPSIS -Removes a CustomConnector object. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlCustomConnector -Identity <SPCustomConnectorPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - -SearchApplication <SearchServiceApplicationPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -The `Get-SPEnterpriseSearchCrawlCustomConnector` selects the custom connector or connectors and then pipes them to the `Remove-SPEnterpriseSearchCrawlCustomConnector` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication MySearchServiceApp" - Identity "dctm://" | Remove-SPEnterpriseSearchCrawlCustomConnector -``` - -This example removes a custom connector for the dctm:// protocol from the MySearchServiceApp search service application. - - -## PARAMETERS - -### -Identity -Specifies the CustomConnector object to remove. -The Identity parameter must be an instance of a valid CustomConnector object. - -```yaml -Type: SPCustomConnectorPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplicationobject. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlDatabase.md deleted file mode 100644 index dcbfeb6c05..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlDatabase.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlDatabase -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlDatabase - -## SYNOPSIS -Deletes a crawl database. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlDatabase [-Identity] <CrawlStorePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchCrawlDatabase` cmdlet deletes a specified crawl database from a search service application. -A crawl database stores crawl history for a search service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPEnterpriseSearchCrawlDatabase -Identity CrawlDB-0 --SearchApplication mySearchServiceApp -``` - -This example removes the CrawlDB-0 crawl database from the mySearchServiceApp search service application. - - -## PARAMETERS - -### -Identity -Specifies the crawl database to delete. - -A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object. - -```yaml -Type: CrawlStorePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl database collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlExtension.md deleted file mode 100644 index 4aa8ec1282..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlExtension.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlExtension -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlExtension - -## SYNOPSIS -Removes a file name extension from the list of files that can be crawled. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlExtension [-Identity] <ExtensionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchCrawlExtension` cmdlet prevents files with this extension from being crawled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" -PS C:\>$searchapp | Get-SPEnterpriseSearchCrawlExtension "pdf" | Remove-SPEnterpriseSearchCrawlExtension -``` - -This example removes the PDF IFilter and removes the pdf file extension from the list of file types to include in the content index. - - -## PARAMETERS - -### -Identity -The file name extension to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid file name extension (for example, .xml); or an instance of a valid CrawlExtension object. - -```yaml -Type: ExtensionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the extension collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlLogReadPermission.md deleted file mode 100644 index 843f5bd1fa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlLogReadPermission.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlLogReadPermission -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlLogReadPermission - -## SYNOPSIS -Removes permission to view crawl log information. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlLogReadPermission [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Identity <CrawlLogReadPermissionPipeBind>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-Tenant <Guid>] [-UserNames <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Only the Search Service Application administrator can use this cmdlet. - -The `Remove-SPEnterpriseSearchCrawlLogReadPermission` cmdlet removes the permission to view crawl log information for one or more users. -The administrator can choose to restrict this removal to a particular tenant. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$crawlLogPermission = Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant "00000000-0000-0000-0000-000000000001" -PS C:\>Remove-SPEnterpriseSearchCrawlLogReadPermission -Identity $crawlLogPermission -UserNames "contoso\user1;contoso\user2" -``` - -This example removes user1 and user2 from the list of users referenced by $crawlLogPermission. -$crawlLogPermission is the list of users who have permission to view the crawl log information from the tenant with id "00000000-0000-0000-0000-000000000001" on the search application referenced by $ssa. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the crawl log permissions list from which to remove the user(s). - -```yaml -Type: CrawlLogReadPermissionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl log. -The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Specifies the tenant for which the user permissions shall be removed. -The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserNames -Specifies the user names that shall no longer have permission to view the crawl log information. -Separate names with semi-colons. - -Specifies the user names that no longer shall have permission to view the crawl log information. -Use the form "domain\username". -When adding several user names, separate names with semi-colons. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPEnterpriseSearchCrawlLogReadPermission](Set-SPEnterpriseSearchCrawlLogReadPermission.md) - -[Get-SPEnterpriseSearchCrawlLogReadPermission](Get-SPEnterpriseSearchCrawlLogReadPermission.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlMapping.md deleted file mode 100644 index 449fc0362c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlMapping.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlMapping -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlMapping - -## SYNOPSIS -Deletes a crawl mapping. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlMapping [-Identity] <CrawlMappingPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchCrawlMapping` cmdlet deletes a crawl mapping from the crawl mapping collection. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication "Sample Search Service Application" -PS C:\>$mappingtodelete = Get-SPEnterpriseSearchCrawlContentSource -Identity "somemapping" -PS C:\>mappingtodelete | Remove-SPEnterpriseSearchCrawlMapping -``` - -This example removes a crawl mapping from a search application. - - -## PARAMETERS - -### -Identity -The crawl mapping to delete. - -A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid CrawlMapping object. - -```yaml -Type: CrawlMappingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl mapping collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlRule.md deleted file mode 100644 index a6141a7e26..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchCrawlRule.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchCrawlRule -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchCrawlRule - -## SYNOPSIS -Deletes a crawl rule. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchCrawlRule [-Identity] <CrawlRulePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchCrawlRule` cmdlet deletes a crawl rule that is used to crawl content for a content source. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchApp = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp -PS C:\>Remove-SPEnterpriseSearchCrawlRule -Identity http://mySPSite -SearchApplication $searchApp -``` - -This example removes a crawl rule pertaining to the path http://mySPSite from the mySearchServiceApp search service application. - - -## PARAMETERS - -### -Identity -The crawl rule to delete. - -A valid crawl rule URL, such as http://server_name, or an instance of a valid CrawlRule object. - -```yaml -Type: CrawlRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -The search application that contains the crawl rule collection. - -A valid search application name, such as SearchApp1, or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchFileFormat.md deleted file mode 100644 index a3bf16fa5c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchFileFormat.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchFileFormat -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchFileFormat - -## SYNOPSIS -Removes support for parsing a file format. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchFileFormat [-Identity] <DocumentParserFileFormatPipeBind> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchFileFormat` removes a file format from the search parsing system. -The search parsing system will only consider the change after a restart of the content processing components. -Afterwards the search parsing system will stop parsing the file format. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Remove-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity foo -``` - -This example uses the `Remove-SPEnterpriseSearchFileFormat` cmdlet to remove the file format with the belonging file name extension foo in the search service application referenced by $ssa. - - -## PARAMETERS - -### -Identity -Specifies the identification of the format to be removed. - - -```yaml -Type: DocumentParserFileFormatPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the file format. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchFileFormat](New-SPEnterpriseSearchFileFormat.md) - -[Get-SPEnterpriseSearchFileFormat](Get-SPEnterpriseSearchFileFormat.md) - -[Set-SPEnterpriseSearchFileFormatState](Set-SPEnterpriseSearchFileFormatState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchLanguageResourcePhrase.md deleted file mode 100644 index aed3dac7c5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchLanguageResourcePhrase.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchLanguageResourcePhrase -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchLanguageResourcePhrase - -## SYNOPSIS -Deletes a language resource phrase from a shared search application. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchLanguageResourcePhrase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -Identity <LanguageResourcePhrasePipeBind> [-Language <String>] [-Mapping <String>] -Owner <SearchObjectOwner> - [-SearchApplication <SearchServiceApplicationPipeBind>] [-SourceId <Guid>] [-Type <LanguageResourceType>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchLanguageResourcePhrase` cmdlet deletes one or more language resource phrases from the collection of language resource phrases in a shared search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" -PS C:\>$obsoletephrase = Get-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $searchapp -Language en-us -Type QuerySuggestionBlockList -Identity secret -PS C:\>$obsoletephrase | Remove-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $searchapp -Type QuerySuggestionBlockList -Language en-us -``` - -This example removes a language resource item on the QuerySuggestionBlockList for the en-us language. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The language resource phrase to delete. - -The type must be a string; a valid name of a language resource phrase (for example, LanguageResourcePhrase1); or an instance of a valid LanguageResourcePhrase object. - - -```yaml -Type: LanguageResourcePhrasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Language -Deletes phrases of the specified language only. - -The type must be a valid name of a language; for example, en_us. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mapping -Allows a term or phrase to be mapped to another term or phrase. -For example, the nickname "John" could be mapped to "Jonathan". - -This parameter only applies to nicknames and substitutions. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. - -The owner must be one of the following valid levels: - -- Search Service Application - -- Site Subscription - -- Site Collection - -- Site - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the language resources. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Constrains to delete phrases of specified type. - -The type must be one of the following valid types of phrases: - -- QuerySuggestionBlockList - -- QuerySuggestionAlwaysSuggest - -- Nickname - -- QuerySuggestionSubstitution - - -```yaml -Type: LanguageResourceType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchLinksDatabase.md deleted file mode 100644 index 3660ec8b3d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchLinksDatabase.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchLinksDatabase -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchLinksDatabase - -## SYNOPSIS -Deletes a links database. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchLinksDatabase [-Identity] <LinksStorePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchLinksDatabase` cmdlet deletes a specified links database from a search service application. -A links database stores query logging and analytics information. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$linksDatabase = $ssa | Get-SPEnterpriseSearchLinksDatabase Links2 -PS C:\>Remove-SPEnterpriseSearchLinksDatabase -Identity $linksDatabase -``` - -This example removes the links database referenced by $linksDatabase. -$linksDatabase is the identity of the links database Links2 on the search service application referenced by $ssa. - - -## PARAMETERS - -### -Identity -Specifies the links database to delete. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. - -```yaml -Type: LinksStorePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the links database. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchLinksDatabase](New-SPEnterpriseSearchLinksDatabase.md) - -[Set-SPEnterpriseSearchLinksDatabase](Set-SPEnterpriseSearchLinksDatabase.md) - -[Get-SPEnterpriseSearchLinksDatabase](Get-SPEnterpriseSearchLinksDatabase.md) - -[Move-SPEnterpriseSearchLinksDatabases](Move-SPEnterpriseSearchLinksDatabases.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataCategory.md deleted file mode 100644 index a1638ff294..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataCategory.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchMetadataCategory -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchMetadataCategory - -## SYNOPSIS -Deletes a crawled property category. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchMetadataCategory [-Identity] <CategoryPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a crawled property category. -You should use this cmdlet after a crawl to delete unused or unwanted categories from the metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication -PS C:\>Remove-SPEnterpriseSearchMetadataCategory -Identity MyCategory -SearchApplication $searchapp -``` - -This example removes the metadata category named MyCategory for the default search service application. - - -## PARAMETERS - -### -Identity -Specifies the metadata category to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - -Note that if only a name for a category is specified, a SearchApplication must also be specified. - -```yaml -Type: CategoryPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the enterprise search metadata property schema. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataManagedProperty.md deleted file mode 100644 index f64dcbff60..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataManagedProperty.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchMetadataManagedProperty -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchMetadataManagedProperty - -## SYNOPSIS -Deletes a metadata managed property. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchMetadataManagedProperty [-Identity] <ManagedPropertyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-SiteCollection <Guid>] [-Tenant <Guid>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a specified managed property from the managed property collection. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication -PS C:\>$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity AboutMeUpdate -PS C:\>Remove-SPEnterpriseSearchMetadataManagedProperty -Identity $mp -``` - -This example removes the managed property AboutMeUpdate from the default search service application. - - -## PARAMETERS - -### -Identity -Specifies the managed property to delete. - -The type must be a valid name of a managed property, for example ManagedProperty1, or an instance of a valid ManagedProperty object. - -Note that if only a name of a managed property is specified, a SearchApplication must also be specified. - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the managed property collection. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the managed properties returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataMapping.md deleted file mode 100644 index 11f03fc0c6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchMetadataMapping.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchMetadataMapping -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchMetadataMapping - -## SYNOPSIS -Deletes a metadata mapping from a managed property. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchMetadataMapping [-Identity] <MappingPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes mappings from a managed property. -A metadata mapping is the mapping between a managed property and one or more crawled properties in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication -PS C:\>$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People -PS C:\>$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -Limit 1 -PS C:\>$mycp = New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Name "MyCrawlProp" -PropSet $cp.PropSet -Category $cp.CategoryName -IsNameEnum $false -VariantType $cp.VariantType -PS C:\>$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity UserName -PS C:\>New-SPEnterpriseSearchMetadataMapping -SearchApplication $searchapp -ManagedProperty $mp -CrawledProperty $mycp -# Retrieve the new mapping -PS C:\>$map = Get-SPEnterpriseSearchMetadataMapping -SearchApplication $searchapp -ManagedProperty $mp -CrawledProperty $mycp -PS C:\>Remove-SPEnterpriseSearchMetadataMapping -Identity $map -confirm:$false -``` - -This example removes an existing mapping between the managed property UserName and the crawled property MyCrawlProp (see `Set-SPEnterpriseSearchMetadataMapping`) for the default search service application. - - -## PARAMETERS - -### -Identity -Specifies the metadata mapping to delete. - -The type must be a valid URL, in the form http://server_name, or an instance of a valid Mapping object. - -```yaml -Type: MappingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the managed property collection. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryAuthority.md deleted file mode 100644 index 7b66a53496..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryAuthority.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchQueryAuthority -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchQueryAuthority - -## SYNOPSIS -Deletes an authoritative page. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchQueryAuthority [-Identity] <AuthorityPagePipeBind> -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchQueryAuthority` cmdlet adjusts query rank by deleting an authoritative page. -SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher in relevance than demoted sites, which are de-emphasized in relevance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPEnterpriseSearchQueryAuthority -Identity http://contoso.com -SearchApplication MySSA -``` - -This example removes the query authority URL http://contoso.com from the search service application named MySSA. - - -## PARAMETERS - -### -Identity -Specifies the query authority page to delete. - -The type must be a valid URL, in the form http://server_name; or an instance a valid AuthorityPage object. - -```yaml -Type: AuthorityPagePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Query Authority is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the authoritative page collection to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryDemoted.md deleted file mode 100644 index c3d4908229..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryDemoted.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchQueryDemoted -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchQueryDemoted - -## SYNOPSIS -Deletes a demoted site rule. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchQueryDemoted [-Identity] <DemotedPipeBind> -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchQueryDemoted` cmdlet adjusts query rank by deleting a demoted site rule from the demoted site collection. -Query demoted sites are de-emphasized in relevance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$demotedRule = Get-SPEnterpriseSearchQueryDemoted -Identity http://somesite.com -SearchApplication MySSA -PS C:\>$demotedRule | Remove-SPEnterpriseSearchQueryDemoted -``` - -This example obtains a reference to a site demotion rule for the URL http://somesite.com and removes it. - - -## PARAMETERS - -### -Identity -Specifies the demoted site rule to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid Demoted object. - -```yaml -Type: DemotedPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Demoted object is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the demoted site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryKeyword.md deleted file mode 100644 index 8b97c0161b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryKeyword.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchQueryKeyword -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchQueryKeyword - -## SYNOPSIS -Deletes a query keyword. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchQueryKeyword [-Identity] <KeywordPipeBind> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchQueryKeyword` cmdlet deletes unused or unwanted keywords from the query keyword collection. - -You cannot use this cmdlet after a site collection is upgraded to SharePoint Server because keywords and Best Bets are automatically migrated to query rules. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site http://myserver/sites/engineering | Remove-SPEnterpriseSearchQueryKeyword -Site http://myserver/sites/engineering -``` - -This example removes the Engineering keyword from the site collection at http://myserver/sites/engineering. - - -## PARAMETERS - -### -Identity -Specifies the keyword term to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. - -```yaml -Type: KeywordPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Filters to delete keywords from the specified site collection of results. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryScope.md deleted file mode 100644 index 5bfe4623e7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryScope.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchQueryScope -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchQueryScope - -## SYNOPSIS -Deletes a query scope. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchQueryScope [-Identity] <ScopePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-Url <Uri>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you upgrade a Search service application to SharePoint Server, you can view shared scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for shared scopes after upgrade. -However, you can convert shared scopes to result sources, which serve a similar purpose. -Similarly, after you upgrade a SharePoint Server site collection to SharePoint Server, you can view local scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. -However, you can convert local scopes to result sources, which serve a similar purpose. - -The `Remove-SPEnterpriseSearchQueryScope` cmdlet deletes one or more specified shared scopes from the query scope collection. -A query scope represents a query results scope used by all shared search applications on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPenterpriseSearchServiceApplication -Identity MySSA -PS C:\>Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Remove-SPEnterpriseSearchQueryScope -``` - -This example removes a scope named MustCrawl from a search service application named MySSA. - - -## PARAMETERS - -### -Identity -Specifies the query scope to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope collection. - -The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Filters to delete scopes of the specified results URL. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryScopeRule.md deleted file mode 100644 index b29531688a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchQueryScopeRule.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchQueryScopeRule -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchQueryScopeRule - -## SYNOPSIS -Deletes query results scope rules. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchQueryScopeRule [-Identity] <ScopeRulePipeBind> -Url <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Scope <ScopePipeBind>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you upgrade a Search service application to SharePoint Server, you can view shared scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for shared scopes after upgrade. -However, you can convert shared scopes to result sources, which serve a similar purpose. -Similarly, after you upgrade a SharePoint Server site collection to SharePoint Server, you can view local scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. -However, you can convert local scopes to result sources, which serve a similar purpose. - -The `Remove-SPEnterpriseSearchQueryScopeRule` cmdlet deletes one or more shared scope rules from the scope rule collection. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "MySSA" -PS C:\>$scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa -PS C:\>Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url http://criticalSite | Remove-SPEnterpriseSearchQueryScopeRule -Url http://criticalSite -``` - -This example removes a scope rule for the URL http://criticalSite from a search service application named MySSA. - - -## PARAMETERS - -### -Identity -Specifies the scope rule to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance of a valid ScopeRule object. - -```yaml -Type: ScopeRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Filters to delete query scope rules for the specified results URL. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Filters to delete multiple rules for a specified scope. - -The type must be a valid string that identifies the scope; for example, Scope1. - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope rule collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchRankingModel.md deleted file mode 100644 index 9629f4bb05..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchRankingModel.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchRankingModel -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchRankingModel - -## SYNOPSIS -Deletes a ranking model. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchRankingModel [-Identity] <RankingModelPipeBind> -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a specified ranking model. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -$owner = Get-SPEnterpriseSearchOwner -Level ssa -Remove-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 -SearchApplication $ssa -Owner $owner -``` - -This example removes the ranking model for the search service application with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level ssa -PS C:\>$MyRanking = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" | Get-SPEnterpriseSearchRankingModel -Owner $owner -PS C:\>Remove-SPEnterpriseSearchRankingModel -Identity $MyRanking -Owner $owner -``` - -This example removes the ranking model object MyRanking from the search service application Search Service Application. - - -## PARAMETERS - -### -Identity -Specifies the ranking model to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid RankingModel object. - -```yaml -Type: RankingModelPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the scope where the ranking model is available. -The available scopes are: SSA, Tenant, Site Collection or Site. -A ranking model can be available in multiple scopes. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the ranking model. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchResultItemType.md deleted file mode 100644 index 1c97737950..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchResultItemType.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchResultItemType -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchResultItemType - -## SYNOPSIS -Removes a result item type for a search object owner. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchResultItemType [-Identity] <ResultItemTypePipeBind> -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] - [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchResultItemType` cmdlet removes a user-created result item type, given a result type identity and a search owner. -You cannot use this cmdlet to remove the built-in result item types that are included with SharePoint products. - -Result item types enable you to change the look of search results based on the type of result. -You start by defining a collection of rules, which will be evaluated against the properties of results. -Then you define the display template to use for rendering that type of result. -Once you have created the result item type, results matching the rules of the result item type will display using the specified display template. - -Example use cases: - -- Change the look of results for a particular file name extension, for example Word documents. - -- Change the look of a particular content type in search results. - -- Change the look of results from a particular author. - -- Add a result action to results from a particular result source as part of a custom search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$web = Get-SPWeb "UrlOfTheSite" -PS C:\>$tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web -PS C:\>$searchapp = Get-SPEnterpriseSearchServiceApplication -PS C:\>$resultType = Get-SPEnterpriseSearchResultItemType -Owner $tenantOwner -SearchApplication $searchapp -PS C:\>Remove-SPEnterpriseSearchResultItemType -Identity $resultType -Owner $tenantOwner -SearchApplication $searchapp -``` - -This example first defines variables for the URL of the site, the search owner and search application. -It then retrieves the result item type and checks whether the result item type is a built-in result item type or not. -If $resultType.BuiltIn returns false, the result item type is not built-in and you can modify it. -Next, the example removes the result item type referenced by $resultType for the owner referenced by $tenantOwner. - -## PARAMETERS - -### -Identity -Specifies the result item type to update. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: ResultItemTypePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the result item type is created. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplicationProxy -Specifies the proxy of the search application that contains the result item type. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchResultItemType](New-SPEnterpriseSearchResultItemType.md) - -[Set-SPEnterpriseSearchResultItemType](Set-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchResultItemType](Get-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchResultSource.md deleted file mode 100644 index 9e80b408c1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchResultSource.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchResultSource -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchResultSource - -## SYNOPSIS -Deletes a result source. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchResultSource [-Identity] <ResultSourcePipeBind> -Owner <SearchObjectOwner> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a specified result source. -This cmdlet supports the same delete operations as are supported through the "Manage Result Sources" page in Central Administration. -The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true). -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>Remove-SPEnterpriseSearchResultSource -Identity "Custom SharePoint Result Source" -SearchApplication $ssa -Owner $owner -``` - -This example deletes the search service application level result source with the name "Custom SharePoint Result Source". - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>Remove-SPEnterpriseSearchResultSource -Identity 12345678-90ab-cdef-1234-567890bcdefgh -SearchApplication $ssa -Owner $owner -``` - -This example deletes the search service application level result source with the id 12345678-90ab-cdef-1234-567890bcdefgh. - - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>$resultSource = Get-SPEnterpriseSearchResultSource -Identity "Custom SharePoint Result Source" -SearchApplication $ssa -Owner $owner -PS C:\>Remove-SPEnterpriseSearchResultSource -Identity $resultSource -SearchApplication $ssa -Owner $owner -``` - -This example deletes the search service application level result source with the name "Custom SharePoint Result Source", by specifying a Source instance. - - -## PARAMETERS - -### -Identity -Specifies the result source to delete. -The result source cannot be a built in source. -The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Custom SharePoint Result Source"); or an instance of a valid Source object. - - -```yaml -Type: ResultSourcePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchResultSource](New-SPEnterpriseSearchResultSource.md) - -[Get-SPEnterpriseSearchResultSource](Get-SPEnterpriseSearchResultSource.md) - -[Set-SPEnterpriseSearchResultSource](Set-SPEnterpriseSearchResultSource.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchSecurityTrimmer.md deleted file mode 100644 index df6a1d1277..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchSecurityTrimmer.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchSecurityTrimmer -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchSecurityTrimmer - -## SYNOPSIS -Deletes a custom security trimmer. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchSecurityTrimmer [[-Identity] <SecurityTrimmerPipeBind>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes the customized security trimmer that is used for a search application's query results. -A custom security trimmer trims search results before the results are returned to the user. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchSecurityTrimmer -SearchApplication MySSA | Remove-SPEnterpriseSearchSecurityTrimmer -``` - -This example removes the security trimmer registered in the search service application named MySSA. - - -## PARAMETERS - -### -Identity -Specifies the security trimmer to delete. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SecurityTrimmer object. - -```yaml -Type: SecurityTrimmerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the security trimmer. - -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index bcdcc1d8ec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Deletes a search service application. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchServiceApplication [-Identity] <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-RemoveData] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes a specified SearchServiceApplication from a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPEnterpriseSearchServiceApplication -Identity MySSA -``` - -This example removes the search service application named MySSA from the farm. - - -## PARAMETERS - -### -Identity -Specifies the search service application to delete. - -A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveData -Specifies that all search databases and index files associated with the search service application to be deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplicationProxy.md deleted file mode 100644 index 6491ae4e10..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplicationProxy.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchServiceApplicationProxy -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchServiceApplicationProxy - -## SYNOPSIS -Deletes a search service application proxy. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchServiceApplicationProxy [-Identity] <SearchServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes the specified search service application proxy from a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPEnterpriseSearchServiceApplicationProxy -Identity SearchProxy -``` - -This example removes a search service application proxy named SearchProxy. - - -## PARAMETERS - -### -Identity -Specifies the search service application proxy to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, ServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md deleted file mode 100644 index 705b6f6db7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchServiceApplicationSiteSettings -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchServiceApplicationSiteSettings - -## SYNOPSIS -Cleans up search settings for a particular site collection, subscription, or search application. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchServiceApplicationSiteSettings [-Identity] <SiteSettingsPipeBind> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-TenantId <Guid>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPEnterpriseSearchServiceApplicationSiteSettings` cmdlet to remove all search settings for the specified site collection, subscription, or search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$app = Get-SPEnterpriseSearchServiceApplication -PS C:\>$GC = Start-SPAssignment -PS C:\>$s = $GC | Get-SPSite UrlOfASiteCollection -PS C:\>Remove-SPEnterpriseSearchServiceApplicationSiteSettings -Identity $s.ID.ToString() -SearchApplication $app -PS C:\>Stop-SPAssignment $GC -``` - -This example removes the search settings for the site collection referenced by $s in the search application referenced by $app. -$s is the site collection with URL "UrlOfSiteCollection" and $s.ID.ToString() is the string representation of the site ID. - - -## PARAMETERS - -### -Identity -Specifies the site collection to remove search settings from. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SiteSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantId -Specifies the tenant from which to remove search settings. -The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings](Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchSiteHitRule.md deleted file mode 100644 index e3ec760b90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchSiteHitRule.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchSiteHitRule -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchSiteHitRule - -## SYNOPSIS -Deletes a site hit rule. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchSiteHitRule [-Identity] <SiteHitRulePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SearchService <SearchServicePipeBind>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchSiteHitRule` cmdlet deletes the site hit rule that controls the number of threads used to crawl a given site. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------- -``` -PS C:\>Remove-SPEnterpriseSearchSiteHitRule -Identity myHost -``` - -This example removes a site hit rule for the myHost host. - - -## PARAMETERS - -### -Identity -The rule that is used for the specified site. - -The type must be a valid site hit rule host or an instance of a valid SiteHitRule object. - -```yaml -Type: SiteHitRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchService -Specifies the search service in the farm that hosts the crawl. - -The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet is used. - -```yaml -Type: SearchServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTenantConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTenantConfiguration.md deleted file mode 100644 index 93150fc978..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTenantConfiguration.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchTenantConfiguration -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchTenantConfiguration - -## SYNOPSIS -Removes all tenant specific search settings. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchTenantConfiguration [-SiteSubscriptionId] <Guid> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPEnterpriseSearchTenantConfigurationcmdlet` removes all tenant specific search settings. -The removed settings are: query Rules, result types, result sources, managed metadata, ranking models, search dictionaries, authoritative pages, query suggestion settings, client types and the default search center. -Use this cmdlet when removing tenants and in conjunction with moving tenants. -When moving a tenant, copy the tenant configuration from the source to the destination and then use this cmdlet to remove the tenant configuration from the source farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Remove-SPEnterpriseSearchTenantConfiguration -SiteSubscriptionId "00000000-0000-0000-0000-000000000001" -SearchApplication $ssa -``` - -This example uses Remove-SPEnterpriseSearchTenantConfiguration to remove all tenant specific settings from the search service application referenced by $ssa. - - -## PARAMETERS - -### -SiteSubscriptionId -Specifies the site subscription of the tenant. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: Identity -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application that contains the tenant configuration. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTenantSchema.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTenantSchema.md deleted file mode 100644 index 39965d18b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTenantSchema.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchTenantSchema -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchTenantSchema - -## SYNOPSIS -Removes a defined search schema. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchTenantSchema [-Identity] <TenantSchemaPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-SiteCollection <Guid>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes a search schema. -Use this cmdlet to remove an unused or unwanted search schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>[Guid]$guid = "909b84cb-90f2-4a1b-8df4-22547a9b2227" -PS C:\>Remove-SPEnterpriseSearchTenantSchema -Identity $guid -SearchApplication $ssa -``` - -This example removes the search schema for the tenant with GUID 909b84cb-90f2-4a1b-8df4-22547a9b2227. - - -## PARAMETERS - -### -Identity -Specifies the tenant of the search schema to be removed. - -The type must be a valid GUID, in string form, that identifies the tenant in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -The tenant GUID can be found in the Search Service Application database, in the folder \Databases\Search_Service_Application\Tables\dbo.MSSTenant. - -```yaml -Type: TenantSchemaPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the enterprise search schema to be removed. - -The type must be a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the search schema to be removed is within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTopology.md deleted file mode 100644 index 2b1fa75ee3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPEnterpriseSearchTopology.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPEnterpriseSearchTopology -schema: 2.0.0 ---- - -# Remove-SPEnterpriseSearchTopology - -## SYNOPSIS -Removes an inactive search topology from a search service application. - - -## SYNTAX - -``` -Remove-SPEnterpriseSearchTopology [-Identity] <SearchTopologyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet removes the given inactive search topology from the search service application to which it belongs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 4b32-4fe6-8f8d-065388df201e -PS C:\>Remove-SPEnterpriseSearchTopology -Identity $topology -``` - -This example removes a search topology with the identity 4b32-4fe6-8f8d-065388df201e. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Remove-SPEnterpriseSearchTopology -Identity $topo -SearchApplication $ssa -``` - -This example removes the search topology referenced by $topo in the search service application referenced by $ssa. - - -## PARAMETERS - -### -Identity -Specifies the search topology to retrieve. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application to which the search topology belongs. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchTopology](Get-SPEnterpriseSearchTopology.md) - -[New-SPEnterpriseSearchTopology](New-SPEnterpriseSearchTopology.md) - -[Set-SPEnterpriseSearchTopology](Set-SPEnterpriseSearchTopology.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelBIServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelBIServer.md deleted file mode 100644 index 46f7a4d958..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelBIServer.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Remove-SPExcelBIServer -schema: 2.0.0 ---- - -# Remove-SPExcelBIServer - -## SYNOPSIS - -Removes an instance of Analysis Services. - - -## SYNTAX - -``` -Remove-SPExcelBIServer [-Identity] <SPExcelBIServerPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION - -Use the Remove-SPExcelBIServer cmdlet to remove an instance of Analysis Services from the Allow List of BI servers to be used with -Excel Services. - - - - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Remove-SPExcelBIServer -ExcelServiceApplication "MyExcel" - -``` - -This example removes the instance of the anaylsis services that uses the Excel Service Application named, "MyExcel". - - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the ExcelServiceApplication identity. - -```yaml -Type: SPExcelBIServerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Office.Excel.Server.Cmdlet.SPExcelBIServerPipeBind -Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelBlockedFileType.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelBlockedFileType.md deleted file mode 100644 index ad0543d280..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelBlockedFileType.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Remove-SPExcelBlockedFileType -schema: 2.0.0 ---- - -# Remove-SPExcelBlockedFileType - -## SYNOPSIS -Removes an entry from the list of file types that are prevented from loading on Excel Services Application. - - -## SYNTAX - -``` -Remove-SPExcelBlockedFileType [-Identity] <SPExcelBlockedFileTypePipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPExcelBlockedExcelFileType` cmdlet removes an entry from the list of file types that are prevented from loading on an Excel Services Application Web service application. -Excel Services Application does not load any file types that correspond to a file type that is on this list. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Remove-SPExcelBlockedExcelFileType -FileType XLSX -``` - -This example removes the .xlsx file name extensions from the list of file types that are prevented from loading by Excel Services Application. - -After the .xlsx file name extension is removed from the list, these extensions are allowed to load in Excel Services Application. - - -## PARAMETERS - -### -Identity -Specifies the file type to remove from the list of blocked file types. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; one of the following file types: XLSX, XLSB, XLSM; or an instance of a valid SPExcelBlockedFileType object. - -```yaml -Type: SPExcelBlockedFileTypePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelDataConnectionLibrary.md deleted file mode 100644 index 684824f87b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelDataConnectionLibrary.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Remove-SPExcelDataConnectionLibrary -schema: 2.0.0 ---- - -# Remove-SPExcelDataConnectionLibrary - -## SYNOPSIS -Removes a data connection library from Excel Services Application. - - -## SYNTAX - -``` -Remove-SPExcelDataConnectionLibrary [-Identity] <SPExcelDCLPipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPExcelDataConnectionLibrary` cmdlet removes a library from the Excel Services Application trusted data connection libraries list. -Excel Services Application loads data connection files only if they are stored in a data connection library that is on the trusted data connection libraries list. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Get-SPExcelServiceApplication | Get-SPExcelDataConnectionLibrary | Remove-SPExcelDataConnectionLibrary -``` - -This example removes all data connection libraries from all Excel Services Application running in the farm. - -Connection files are no longer loaded from any libraries. -Workbooks that depend on any connection files might not refresh data. - - -## PARAMETERS - -### -Identity -Specifies the data connection library to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection library (for example, DataConnectionLib1); a valid URL, in the form http://server_name; or an instance of a valid SPExcelDCL object. - -```yaml -Type: SPExcelDCLPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelDataProvider.md deleted file mode 100644 index e64e236672..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelDataProvider.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Remove-SPExcelDataProvider -schema: 2.0.0 ---- - -# Remove-SPExcelDataProvider - -## SYNOPSIS -Removes a data provider from Excel Services Application. - - -## SYNTAX - -``` -Remove-SPExcelDataProvider [-Identity] <SPExcelDataProviderPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPExcelDataProvider` cmdlet removes a data provider that is stored on the list of safe data providers. -Excel Services Application refreshes external data connections only if the data provider for that connection is on the list of safe data providers. -Excel Services Application includes a set of common data providers on this list, so using cmdlets to modify safe data providers is typically done only in custom data connection scenarios. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -C:\PS>$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | { where {$_.providerID -eq "MyCustomProvider"} - -PS C:\>Remove-SPExcelDataProvider $provider -``` - -This example removes a custom data provider from the list of safe data providers that is on the Excel Services Application Web service application named MyExcelService. - -Excel Services Application will no longer refresh any data connections that use this data provider. - - -## PARAMETERS - -### -Identity -Specifies the SPExcelDataProvider object to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPExcelDataProvider object. - -```yaml -Type: SPExcelDataProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelFileLocation.md deleted file mode 100644 index 2349c9385d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelFileLocation.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Remove-SPExcelFileLocation -schema: 2.0.0 ---- - -# Remove-SPExcelFileLocation - -## SYNOPSIS -Removes a trusted file location from Excel Services Application. - - -## SYNTAX - -``` -Remove-SPExcelFileLocation [-Identity] <SPExcelFileLocationPipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPExcelFileLocation` cmdlet removes a location from the list of trusted file locations. -Excel Services Application loads only workbooks that are stored in a trusted file location. -Properties of trusted file locations control how workbooks can be used when loaded on Excel Services Application. -Excel Services Application always enforces the properties defined by the trusted file location from which a workbook was loaded. -The properties used by the trusted file location are determined by comparing the file path for the workbook with the Address parameter of the trusted file location. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Get-SPExcelServiceApplication | Get-SPExcelFileLocation | where {$_.Address -ne "http://"} | Remove-SPExcelFileLocation -``` - -This example removes all nondefault trusted file locations from every Excel Services Application Web service application in the farm. - - -## PARAMETERS - -### -Identity -Specifies the FileLocation object to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that identifies the file location, in the form http://myPortal/myTeam; a valid string that identifies the path, in the form C:\folder_name; or an instance of a valid SPExcelFileLocation object. - -```yaml -Type: SPExcelFileLocationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelUserDefinedFunction.md deleted file mode 100644 index 6f330dae75..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPExcelUserDefinedFunction.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Remove-SPExcelUserDefinedFunction -schema: 2.0.0 ---- - -# Remove-SPExcelUserDefinedFunction - -## SYNOPSIS -Removes a user-defined function from Excel Services Application. - - -## SYNTAX - -``` -Remove-SPExcelUserDefinedFunction [-Identity] <SPExcelUDFPipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPExcelUserDefinedFunction` cmdlet removes a user-defined function from the list of user-defined functions. -User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. -The assemblies can perform custom logic or other actions, such as refresh data. -The Windows PowerShell cmdlets operate on the entries in the user-defined function list, but do not operate on the assemblies. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Get-SPExcelServiceApplication | Remove-SPExcelUserDefinedFunction -Identity "SampleCompany.SampleApplication.SampleUdf" -``` - -This example removes the SampleCompany.SampleApplication.SampleUdf user-defined function from the list of user-defined functions for every Excel Services Application Web service application in the farm. - - -## PARAMETERS - -### -Identity -Specifies the SPExcelUserDefinedFunction object that you want to remove. - -The type must be a valid name of the code assembly (for example, SampleCompany.SampleApplication.SampleUdf); or an instance of a valid SPExcelUDF object. - -```yaml -Type: SPExcelUDFPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the list of user-defined functions. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPInfoPathUserAgent.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPInfoPathUserAgent.md deleted file mode 100644 index 17d052ed90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPInfoPathUserAgent.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPInfoPathUserAgent -schema: 2.0.0 ---- - -# Remove-SPInfoPathUserAgent - -## SYNOPSIS -Removes a user agent. - - -## SYNTAX - -``` -Remove-SPInfoPathUserAgent [-Identity] <SPUserAgentPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPIPUserAgent` cmdlet removes a specified user agent from the user agent collection on a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Remove-SPInfoPathUserAgent -Identity "UserAgentName" -``` - -This example removes a user agent. - - -## PARAMETERS - -### -Identity -Specifies the name of the user agent to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user agent (for example, UserAgent1; or an instance of a valid SPUserAgent object. - -```yaml -Type: SPUserAgentPipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPManagedAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPManagedAccount.md deleted file mode 100644 index b2c36f0dd6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPManagedAccount.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPManagedAccount -schema: 2.0.0 ---- - -# Remove-SPManagedAccount - -## SYNOPSIS -Removes a managed account registration from the farm. - - -## SYNTAX - -``` -Remove-SPManagedAccount [-Identity] <SPManagedAccountPipeBind> -NewPassword <SecureString> - [-AssignmentCollection <SPAssignmentCollection>] [-ChangePassword] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Remove-SPManagedAccount` cmdlet removes account registration from the configuration database within the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE------------------- -``` -PS C:\>Remove-SPManagedAccount -Identity DOMAIN\ServiceAcct -``` - -This example removes the DOMAIN\ServiceAcct managed account from the farm. - - -## PARAMETERS - -### -Identity -Specifies the full name or partial name of the managed accounts to retrieve. - -The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. - -```yaml -Type: SPManagedAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewPassword -Specifies a secure string for the new password (that is, $MySecureString). Works in conjunction with the ChangePassword parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ChangePassword -Specifies whether a password is to be changed. -Works in conjunction with the NewPassword parameter. -When the ChangePassword value is set, a secure string value is required for the NewPassword parameter (that is, $MySecureString). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPManagedPath.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPManagedPath.md deleted file mode 100644 index 81840ddad1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPManagedPath.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPManagedPath -schema: 2.0.0 ---- - -# Remove-SPManagedPath - -## SYNOPSIS -Deletes the specified managed path from the specified host header or Web application. - - -## SYNTAX - -### HostHeader -``` -Remove-SPManagedPath [-Identity] <SPPrefixPipeBind> [-HostHeader] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### WebApplication -``` -Remove-SPManagedPath [-Identity] <SPPrefixPipeBind> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Remove-SPManagedPath` cmdlet deletes the managed path specified by the Identity parameter from the host header or the Web application. -The Identity must be the partial URL of the managed path to be deleted. - -If you are using host-named site collections, specify the HostHeader parameter. -To delete a host-named site collection managed path, provide the HostHeader switch. -Otherwise, you must specify the Web application that contains the managed path to be deleted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE 1---------------------------- -``` -PS C:\>Remove-SPManagedPath "sites" -HostHeader -``` - -This example removes the sites managed path from the list of host-named site collection managed paths. - -Depending on the confirmation level of the local system, the preceding example can prompt prior to execution. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPWebApplication | Remove-SPManagedPath "personal" -confirm:$false -``` - -This example removes the personal managed path from all Web applications in the farm. -This command does not prompt for confirmation. - - -## PARAMETERS - -### -Identity -Specifies the name of the managed path to delete. -For example, in the URL http://sitename/sites/site1, "sites" is the name of the managed path. - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -HostHeader -Specifies that the Identity is a host header managed path. - -```yaml -Type: SwitchParameter -Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the identity of the Web application that hosts the managed path to delete. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name, in the form WebApp2423. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplication.md deleted file mode 100644 index 12d35c0baf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplication.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPPerformancePointServiceApplication -schema: 2.0.0 ---- - -# Remove-SPPerformancePointServiceApplication - -## SYNOPSIS -Deletes a PerformancePoint Service application from a farm. - - -## SYNTAX - -``` -Remove-SPPerformancePointServiceApplication - [-Identity] <SPPerformancePointMonitoringServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPPerformancePointServiceApplication` cmdlet deletes a PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE----------------- -``` -PS C:\>Remove-SPPerformancePointServiceApplication -Identity PPSApp_01 -``` - -This example removes the PPSApp_01 PerformancePoint Service application. - - -## PARAMETERS - -### -Identity -Specifies the PerformancePoint Service application to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `et-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplicationProxy.md deleted file mode 100644 index a884298498..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplicationProxy.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPPerformancePointServiceApplicationProxy -schema: 2.0.0 ---- - -# Remove-SPPerformancePointServiceApplicationProxy - -## SYNOPSIS -Deletes the proxy for a PerformancePoint Service application. - - -## SYNTAX - -``` -Remove-SPPerformancePointServiceApplicationProxy - [-Identity] <SPPerformancePointMonitoringServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPPerformancePointServiceApplicationProxy` cmdlet deletes the proxy for a PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE-------------------- -``` -PS C:\>Remove-SPPerformancePointServiceApplicationProxy -Identity PPS_Application_Proxy_01 -``` - -This example removes the PPS_Application_Proxy_01 application proxy from its associated PerformancePoint Service application. - - -## PARAMETERS - -### -Identity -Specifies the PerformancePoint Service application proxy to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application proxy (for example, PerfPointAppProxy1); or an instance of a valid SPPerformancePointMonitoringServiceApplicationProxy object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplicationTrustedLocation.md deleted file mode 100644 index 1fb8ce9c07..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPerformancePointServiceApplicationTrustedLocation.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPPerformancePointServiceApplicationTrustedLocation -schema: 2.0.0 ---- - -# Remove-SPPerformancePointServiceApplicationTrustedLocation - -## SYNOPSIS -Removes a single trusted location from a PerformancePoint Service application. - - -## SYNTAX - -``` -Remove-SPPerformancePointServiceApplicationTrustedLocation - -Identity <SPPerformancePointMonitoringServiceApplicationTrustedLocationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPPerformancePointServiceApplicationTrustedLocation` cmdlet deletes a single trusted location from a PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------------EXAMPLE-------------------- -``` -PS C:\>Remove-SPPerformancePointServiceApplicationTrustedLocation -Identity <Valid GUID of a Trusted Location in an Application> -``` - -This example removes a Trusted Location having the specified GUID from a PerformancePoint Service Application. - - -## PARAMETERS - -### -Identity -Specifies the trusted location to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPPerformancePointMonitoringServiceApplicationTrustedLocation object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationTrustedLocationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPluggableSecurityTrimmer.md deleted file mode 100644 index f10299cd83..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPPluggableSecurityTrimmer.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPPluggableSecurityTrimmer -schema: 2.0.0 ---- - -# Remove-SPPluggableSecurityTrimmer - -## SYNOPSIS -Removes a pluggable security trimmer from a profile service application proxy. - - -## SYNTAX - -``` -Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId <Guid> -PlugInId <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPPluggableSecurityTrimmer` cmdlet to remove a specified pluggable security trimmer from a User Profile service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE 1---------------------- -``` -PS C:\>$pr = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -PlugInId 0 -``` - -This example removes a pluggable security trimmer. - - -### -----------------EXAMPLE 2---------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0 -``` - -This example turns off security trimming in a User Profile Service Application. - - -## PARAMETERS - -### -UserProfileApplicationProxyId -Specifies the ID of the User Profile service application proxy from which the pluggable security trimmer is removed. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlugInId -The index of the pluggable security trimmer must have an integer value greater than or equal to zero. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProfileLeader.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProfileLeader.md deleted file mode 100644 index 6d0a0a65d7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProfileLeader.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPProfileLeader -schema: 2.0.0 ---- - -# Remove-SPProfileLeader - -## SYNOPSIS -Remove a company leader. - - -## SYNTAX - -``` -Remove-SPProfileLeader [-ProfileServiceApplicationProxy] <SPServiceApplicationProxyPipeBind> - [-Name] <SPProfileLeaderPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the `Remove-SPProfileLeader` cmdlet to remove a user as the company leader. - -For additional information about SPProfileLeader cmdlets, see The *-SPProfileLeader Windows PowerShell cmdlets in SharePoint Server SP1 (https://go.microsoft.com/fwlink/p/?LinkId=226295) (https://go.microsoft.com/fwlink/p/?LinkId=226295). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Remove-SPProfileLeader -ProfileServiceApplicationProxy $proxy -Name "contoso\janedow" -``` - -This example removes the user "Jane Dow" from the leaders list for a specific user profile service application. - - -## PARAMETERS - -### -ProfileServiceApplicationProxy -Specifies the name of the User Profile Service Application Proxy to use. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the account name to be removed as a leader for the new User Profile Service application. -For example, Contoso\Joe. - -```yaml -Type: SPProfileLeaderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProfileSyncConnection.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProfileSyncConnection.md deleted file mode 100644 index 1e33c474ea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProfileSyncConnection.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPProfileSyncConnection -schema: 2.0.0 ---- - -# Remove-SPProfileSyncConnection - -## SYNOPSIS -Removes a synchronization connection. - - -## SYNTAX - -``` -Remove-SPProfileSyncConnection [-ProfileServiceApplication] <SPServiceApplicationPipeBind> - -ConnectionDomain <String> -ConnectionForestName <String> -ConnectionPassword <SecureString> - -ConnectionSynchronizationOU <String> -ConnectionUserName <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ConnectionNamingContext <String>] - [-ConnectionServerName <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the `Remove-SPProfileSyncConnection` cmdlet to remove a User Profile synchronization connection. - -This cmdlet only works with Active Directory Synchronization Connections - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Remove-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com" -``` - -This example removes a user from the fabrikam domain using a specific user profile service application. - - -## PARAMETERS - -### -ProfileServiceApplication -Specifies the name of the User Profile service application. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectionDomain -Specifies the NetBIOS name of the domain you are connecting to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionForestName -Specifies the forest name you are connecting to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionPassword -Specifies the password of the account used for directory connection. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionSynchronizationOU -Specifies the top level organizational unit (OU) that you would like to synchronize. -The value must be a domain name and you can only include one container per command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionUserName -Specifies the user name to be used for the synchronization connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionNamingContext -Specifies the naming context of the directory information tree to connect to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionServerName -Specifies the name of the connection server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProjectWebInstanceData.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProjectWebInstanceData.md deleted file mode 100644 index a87f08518a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPProjectWebInstanceData.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2016, Project Server 2019 -title: Remove-SPProjectWebInstanceData -schema: 2.0.0 ---- - -# Remove-SPProjectWebInstanceData - -## SYNOPSIS -Disassociates a Site Collection with the Project Server instance. - - -## SYNTAX - -``` -Remove-SPProjectWebInstanceData [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -SiteCollection <SPSitePipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet disassociates the Project Server instance from the specified Site Collection, disabling the PWA Feature and removing Project content. - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPProjectWebInstanceData -SiteCollection http://contoso/sites/pwa -``` - -This example disassociates http://contoso/sites/pwa from the Project Server instance. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -The site collection to disassociate from the Project Server instance. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: True -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 -Applicable: Project Server 2016, Project 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.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingMachineInfo.md deleted file mode 100644 index 9fe6c5a4eb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingMachineInfo.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPRoutingMachineInfo -schema: 2.0.0 ---- - -# Remove-SPRoutingMachineInfo - -## SYNOPSIS -Removes an external routing target. - - -## SYNTAX - -``` -Remove-SPRoutingMachineInfo [-Identity] <SPRoutingMachineInfoPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPRoutingMachineInfo` cmdlet to remove an external routing target by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------EXAMPLE------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>$M=Get-SPRoutingMachineInfo -RequestManagementSettings $rm -Name <MachineName> - -PS C:\>Remove-SPRoutingMachineInfo -Identity $M -``` - -This example removes a routing target for a specified identity. - - -## PARAMETERS - -### -Identity -Specifies the computer object that Request Manager will remove. - -```yaml -Type: SPRoutingMachineInfoPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingMachineInfo](Add-SPRoutingMachineInfo.md) - -[Get-SPRoutingMachineInfo](Get-SPRoutingMachineInfo.md) - -[Set-SPRoutingMachineInfo](Set-SPRoutingMachineInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingMachinePool.md deleted file mode 100644 index 4578b2f58d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingMachinePool.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPRoutingMachinePool -schema: 2.0.0 ---- - -# Remove-SPRoutingMachinePool - -## SYNOPSIS -Removes a routing pool from Request Manager. - - -## SYNTAX - -``` -Remove-SPRoutingMachinePool [-Identity] <SPRoutingMachinePoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPRoutingMachinePool` cmdlet to remove a routing pool from the Request Manager object by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>$pool=Get-SPRoutingMachinePool -RequestManagementSettings $rm - -PS C:\>Remove-SPRoutingMachinePool -Identity $pool -``` - -This example removes a routing pool for the specified identity by using the $pool variable. - - -## PARAMETERS - -### -Identity -Specifies the Request Manager object to remove. - -```yaml -Type: SPRoutingMachinePoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingMachinePool](Add-SPRoutingMachinePool.md) - -[Get-SPRoutingMachinePool](Get-SPRoutingMachinePool.md) - -[Set-SPRoutingMachinePool](Set-SPRoutingMachinePool.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingRule.md deleted file mode 100644 index 0f11538e09..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPRoutingRule.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPRoutingRule -schema: 2.0.0 ---- - -# Remove-SPRoutingRule - -## SYNOPSIS -Removes a routing rule. - - -## SYNTAX - -``` -Remove-SPRoutingRule [-Identity] <SPRoutingRulePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPRoutingRule` cmdlet removes a routing rule by using the Identity parameter. -If the Identity parameter is not specified, the routing rules for the entire farm are removed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -PS C:\>Get-SPRoutingRule -RequestManagementSettings $rm - -C:\PS>$machines=Get-SPRoutingMachineInfo -RequestManagementSettings $rm - -C:\PS>$pool=Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machines - -C:\PS>$c=New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false - -C:\PS>$rule=Add-SPRoutingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -MachinePool $pool - -PS C:\>Remove-SPRoutingRule -Identity $rule -``` - -This example removes a routing for a specified identity by using the $rule variable. - - -## PARAMETERS - -### -Identity -Specifies the rule object to remove. - -```yaml -Type: SPRoutingRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingRule](Add-SPRoutingRule.md) - -[Get-SPRoutingRule](Get-SPRoutingRule.md) - -[Set-SPRoutingRule](Set-SPRoutingRule.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPScaleOutDatabase.md deleted file mode 100644 index 00a8f38236..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPScaleOutDatabase.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPScaleOutDatabase -schema: 2.0.0 ---- - -# Remove-SPScaleOutDatabase - -## SYNOPSIS -Removes a specific scale-out database. - - -## SYNTAX - -``` -Remove-SPScaleOutDatabase -Database <SPDatabasePipeBind> -ServiceApplication <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DeleteData] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPScaleOutDatabase` cmdlet to remove a specific scale-out database from a specified service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -PS C:\>Remove-SPScaleOutDatabase -ServiceApplication $serviceApplication -Database $database -``` - -This example removes the specified scale-out database from the specified service application. - - -## PARAMETERS - -### -Database -Specifies the scale-out database to remove. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the service application of the scale-out database to remove. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteData -Specifies whether to delete data when the scale out database is removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPScaleOutDatabase](Add-SPScaleOutDatabase.md) - -[Get-SPScaleOutDatabase](Get-SPScaleOutDatabase.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md deleted file mode 100644 index 6c34ed547f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSecureStoreApplication -schema: 2.0.0 ---- - -# Remove-SPSecureStoreApplication - -## SYNOPSIS -Deletes a Secure Store application. - - -## SYNTAX - -``` -Remove-SPSecureStoreApplication -Identity <SPSecureStoreApplication> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSecureStoreApplication` cmdlet deletes a Secure Store application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApp" | Remove -SPSecureStoreApplication -``` - -This example removes the specified application and target. - - -## PARAMETERS - -### -Identity -Specifies the Secure Store application to delete. - -```yaml -Type: SPSecureStoreApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreSystemAccount.md deleted file mode 100644 index 8e28b59da7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreSystemAccount.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSecureStoreSystemAccount -schema: 2.0.0 ---- - -# Remove-SPSecureStoreSystemAccount - -## SYNOPSIS -Removes a user account from a designated list. - - -## SYNTAX - -``` -Remove-SPSecureStoreSystemAccount [-Identity] <SPSecureStoreSystemAccountPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPSecureStoreSystemAccount` cmdlet to remove a user account from a designated list of accounts which will be considered a system account. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- -``` -PS C:\>Remove-SPSecureStoreSystemAccount -Identity contoso\jdoe -``` - -This example removes a specific user name jdoe by using the Identity parameter. - - -### -----------------------EXAMPLE 2----------------------------- -``` -PS C:\>Get-SPSecureStoreSystemAccount | Where-Object -filter {$_.AccountName -eq 'Contoso\admin'} | Remove-SPSecureStoreSystemAccount -``` - -This example removes the admin, user from the contoso domain by filtering the results from the `Get-SPSecureStoreSystemAccount` cmdlet. - - -## PARAMETERS - -### -Identity -Specifies the name, object, or GUID to remove. - -```yaml -Type: SPSecureStoreSystemAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPSecureStoreSystemAccount](Add-SPSecureStoreSystemAccount.md) - -[Get-SPSecureStoreSystemAccount](Get-SPSecureStoreSystemAccount.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServerScaleOutDatabase.md deleted file mode 100644 index 1fa52023dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServerScaleOutDatabase.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPServerScaleOutDatabase -schema: 2.0.0 ---- - -# Remove-SPServerScaleOutDatabase - -## SYNOPSIS -Removes a specific scale-out database. - - -## SYNTAX - -``` -Remove-SPServerScaleOutDatabase -Database <SPDatabasePipeBind> - -ServiceApplication <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DeleteData] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-SPServerScaleOutDatabase cmdlet to remove a specific scale-out database from a specified service application. - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Managed Metadata Service'} -PS C:\>$database = Get-SPServerScaleOutDatabase -ServiceApplication $sa -PS C:\>Remove-SPServerScaleOutDatabase -Database $database -ServiceApplication $sa -``` - -This example removes the specified scale-out database from the Managed Metadata Service application. - - -## PARAMETERS - -### -Database -Specifies the scale-out database to remove. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the service application of the scale-out database to remove. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteData -Specifies whether to delete data when the scale out database is removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-SPServerScaleOutDatabase](Add-SPServerScaleOutDatabase.md) - -[Get-SPServerScaleOutDatabase](Get-SPServerScaleOutDatabase.md) - -[Split-SPServerScaleOutDatabase](Split-SPServerScaleOutDatabase.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplication.md deleted file mode 100644 index 147da7f8cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplication.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPServiceApplication -schema: 2.0.0 ---- - -# Remove-SPServiceApplication - -## SYNOPSIS -Deletes the specified service application on the local server. - - -## SYNTAX - -``` -Remove-SPServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-RemoveData] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPServiceApplication` cmdlet deletes the specified service application from the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------------- -``` -PS C:\>Remove-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -RemoveData -``` - -This example deletes the service application and its database. - -The service application GUID is unique to every farm. -You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, or `Publish-SPServiceApplication`. - - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application to remove. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveData -Deletes all databases and other data associated with the service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationPool.md deleted file mode 100644 index 90cb759e0f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationPool.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPServiceApplicationPool -schema: 2.0.0 ---- - -# Remove-SPServiceApplicationPool - -## SYNOPSIS -Completely deletes the specified Web service application pool. - - -## SYNTAX - -``` -Remove-SPServiceApplicationPool [-Identity] <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPServiceApplicationPool` cmdlet completely deletes the specified Web service application pool. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPServiceApplicationPool TestServiceWebApplicationPool -``` - -This example deletes the selected service application pool. - - -## PARAMETERS - -### -Identity -Specifies the identity of the Web service application pool to delete. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxy.md deleted file mode 100644 index 5b4db81ff8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxy.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPServiceApplicationProxy -schema: 2.0.0 ---- - -# Remove-SPServiceApplicationProxy - -## SYNOPSIS -Deletes the specified service application proxy. - - -## SYNTAX - -``` -Remove-SPServiceApplicationProxy [-Identity] <SPServiceApplicationProxyPipeBind> [-RemoveData] [-Confirm] - [-WhatIf] [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPServiceApplicationProxy` cmdlet deletes the service application proxy specified by the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Remove-SPServiceApplicationProxy $proxy -``` - -This example deletes the User Profile Service Application proxy. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application proxy to remove. - -The type must be a GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoveData -Deletes all databases and other data associated with the service application proxy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxyGroup.md deleted file mode 100644 index 85a51cbbb1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxyGroup.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPServiceApplicationProxyGroup -schema: 2.0.0 ---- - -# Remove-SPServiceApplicationProxyGroup - -## SYNOPSIS -Completely deletes the specified service application proxy group. - - -## SYNTAX - -``` -Remove-SPServiceApplicationProxyGroup [-Identity] <SPServiceApplicationProxyGroupPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Completely deletes the specified service application proxy group. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE------------------------- -``` -PS C:\>Remove-SPServiceApplicationProxyGroup RemoteProxyGroup -``` - -This example deletes the service application proxy group named RemoteProxyGroup. - -The service application proxy group GUID is unique to every farm. -You can run `Get-SPServiceApplicationProxyGroup | Select Name,Id` to see the GUID of the service application proxy groups. -Use this result for any other SPServiceApplicationProxyGroup cmdlets. - - -## PARAMETERS - -### -Identity -The identity of the service application proxy group to delete. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxyGroupMember.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxyGroupMember.md deleted file mode 100644 index 9956d0db4b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPServiceApplicationProxyGroupMember.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPServiceApplicationProxyGroupMember -schema: 2.0.0 ---- - -# Remove-SPServiceApplicationProxyGroupMember - -## SYNOPSIS -Removes one or more proxies from the specified service application proxy group. - - -## SYNTAX - -``` -Remove-SPServiceApplicationProxyGroupMember [-Identity] <SPServiceApplicationProxyGroupPipeBind> - [-Member] <SPServiceApplicationProxyPipeBind[]> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPServiceApplicationProxyGroupMember` cmdlet removes one or more proxies from the specified service application proxy group. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member babab30e-8e3a-428b-8ff4-4d5c8f455e6d -``` - -This example removes a service application proxy from the selected service application proxy group named RemoteProxyGroup. - -The service application proxy group GUID is unique to every farm. -You can run `Get-SPServiceApplicationProxyGroup | Select Name,Id` to see the GUID of the service application proxy groups. -Use this result for any other SPServiceApplicationProxyGroup cmdlets. - - -## PARAMETERS - -### -Identity -Specifies the identity of the service application proxy group from which to remove the member or members. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Member -Specifies the member or members to remove from the service application proxy group. - -```yaml -Type: SPServiceApplicationProxyPipeBind[] -Parameter Sets: (All) -Aliases: Proxy -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPShellAdmin.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPShellAdmin.md deleted file mode 100644 index ba83220ea0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPShellAdmin.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPShellAdmin -schema: 2.0.0 ---- - -# Remove-SPShellAdmin - -## SYNOPSIS -Removes a user from the SharePoint_Shell_Access role. - - -## SYNTAX - -``` -Remove-SPShellAdmin [-UserName] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-database <SPDatabasePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPShellAdmin` cmdlet to remove a user from the SharePoint_Shell_Access role in a specified database. - -When you use this cmdlet to remove a user from the role, you do not remove the user from the WSS_ADMIN_WPG group in the target database. - -When you run this cmdlet to add a user to the SharePoint_Shell_Access role, the user must have the following security permissions: - -- Security_Admin role access on the instance of SQL Server and the db_owner role in the database. -- Administrative permission to the local computer. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>Remove-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6 -``` - -This example removes an existing user named User1 from the SharePoint_Shell_Access role in the database specified. - - -## PARAMETERS - -### -UserName -Specifies the name of the user you want to remove from the SharePoint_Shell_Access role in the specified database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -database -Specifies the GUID of the database or the Databse Object that includes the SharePoint_Shell_Access role from which the user is to be removed. -If the database parameter is not specified, the configuration database is used. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSite.md deleted file mode 100644 index d7d53855ac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSite.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSite -schema: 2.0.0 ---- - -# Remove-SPSite - -## SYNOPSIS -Completely deletes an existing site collection and all subsites. - - -## SYNTAX - -``` -Remove-SPSite [-Identity] <SPSitePipeBind> [-DeleteADAccounts] [-GradualDelete] - [-CheckComplianceFlags <Boolean>] [-AssignmentCollection <SPAssignmentCollection>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-SPSite** cmdlet completely deletes an existing site collection and all subsites. -This operation cannot be undone. - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Remove-SPSite -Identity 'http://sitename/' -GradualDelete -Confirm:$False -``` - -This example removes the given site collection and all included sites by using GradualDelete which places the site in the site recycle bin; confirmation has been suppressed. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Remove-SPSite -Identity 'http://sitename/' -``` - -This example immediately deletes the site and it's contents from the farm. - -## PARAMETERS - -### -Identity -Specifies the identity of the site to delete. -The identity can be either a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` -### -DeleteADAccounts -Forces deletion of user accounts from Active Directory Domain Services (AD DS). -This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -CheckComplianceFlags -Specifies if compliance flags are enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteADAccounts -Forces deletion of user accounts from Active Directory Domain Services (AD DS). - -This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GradualDelete -If provided, occurs gradually to use less system load. - -This operation is strongly recommended for deleting very large sites. This option places the site in the site recycle bin instead of immediately deleting the site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteMaster.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteMaster.md deleted file mode 100644 index e0fd6f8910..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteMaster.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteMaster -schema: 2.0.0 ---- - -# Remove-SPSiteMaster - -## SYNOPSIS -Removes a site master. - -## SYNTAX -``` -Remove-SPSiteMaster [-ContentDatabase] <SPContentDatabasePipeBind> [-SiteId] <Guid> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-SPSiteMaster cmdlet to remove a site master from the database. - -## EXAMPLES -### -----------------------EXAMPLE----------------------------- -``` -PS C:\>$master = Get-SPSiteMaster -ContentDatabase WSS_Content | Select -First 1 -PS C:\>Remove-SPSiteMaster -ContentDatabase WSS_Content -SiteId $master.SiteId -``` - -This example removes the first Site Master found in the WSS_Content database. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the name of the database to remove the site master. For example, WSS_Content. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SiteId -Specifies the ID of the Site Master to remove. For example, ff480534-7e64-44a5-b7e3-7c418624cdf6. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -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 -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPContentDatabasePipeBind -System.Guid -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscription.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscription.md deleted file mode 100644 index c8740e7c70..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscription.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscription -schema: 2.0.0 ---- - -# Remove-SPSiteSubscription - -## SYNOPSIS -Removes data stored in a subscription settings service application for a set of site subscriptions. - - -## SYNTAX - -``` -Remove-SPSiteSubscription [-Identity] <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSiteSubscription` cmdlet removes a site subscription along with all contained site collections and settings. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPSiteSubscription "http://contoso.com/" -``` - -This example removes all data for the contoso.com site subscription (site collections, site subscription and settings). - - -## PARAMETERS - -### -Identity -Specifies the site subscription settings service application that contains the service data to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the removal of a site subscription and is the only way to stop this command from prompting for confirmation. - -The type must be either of the following values: - -- True -- False - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md deleted file mode 100644 index 1895399a35..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscriptionBusinessDataCatalogConfig -schema: 2.0.0 ---- - -# Remove-SPSiteSubscriptionBusinessDataCatalogConfig - -## SYNOPSIS -Removes the Business Data Connectivity Metadata Store for a partition. - - -## SYNTAX - -``` -Remove-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSiteSubscriptionBusinessDataCatalogConfig` cmdlet removes the Business Data Connectivity Metadata Store and all associated data for a specified partition. -To completely remove a partition and the data that it contains, run the `Clear-SPSiteSubscriptionBusinessDataCatalogConfig` cmdlet to remove the data from the Business Data Connectivity Metadata Store and then run the `Remove-SPSiteSubscriptionBusinessDataCatalogConfig` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso -``` - -This example removes the Business Data Connectivity Metadata Store for the partition http://contoso. - - -## PARAMETERS - -### -ServiceContext -Specifies the service context of the Business Data Connectivity Metadata Store to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionFeaturePack.md deleted file mode 100644 index bd89e9d810..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionFeaturePack.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscriptionFeaturePack -schema: 2.0.0 ---- - -# Remove-SPSiteSubscriptionFeaturePack - -## SYNOPSIS -Removes a SharePoint Feature set from a site subscription. - - -## SYNTAX - -``` -Remove-SPSiteSubscriptionFeaturePack [-Identity] <SPSiteSubscriptionFeaturePackPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSiteSubscriptionFeaturePack` cmdlet removes a SharePoint Feature set by specifying the GUID or Feature set object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE------------------------ -``` -PS C:\>Remove-SPFeatureSet -Identity "30daa535-b0fe-4d10-84b0-fb04029d161a" -``` - -This example removes a SharePoint Feature set that has the ID 30daa535-b0fe-4d10-84b0-fb04029d161a. - - -## PARAMETERS - -### -Identity -Specifies the Feature set object to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. - -```yaml -Type: SPSiteSubscriptionFeaturePackPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionFeaturePackMember.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionFeaturePackMember.md deleted file mode 100644 index 972054495b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionFeaturePackMember.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscriptionFeaturePackMember -schema: 2.0.0 ---- - -# Remove-SPSiteSubscriptionFeaturePackMember - -## SYNOPSIS -Removes a feature definition from the provided SharePoint Feature set. - - -## SYNTAX - -### AllFeatureDefinitions -``` -Remove-SPSiteSubscriptionFeaturePackMember [-Identity] <SPSiteSubscriptionFeaturePackPipeBind> - [-AllFeatureDefinitions] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -### SingleFeatureDefinition -``` -Remove-SPSiteSubscriptionFeaturePackMember [-Identity] <SPSiteSubscriptionFeaturePackPipeBind> - -FeatureDefinition <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Remove-SPSiteSubscriptionFeaturePackMember` cmdlet removes the provided FeatureDefinition parameter from the feature set specified by the Identity parameter. -If the AllFeatureDefinitions flag is provided, all feature definitions are removed from the given Feature set. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -C:\PS>$FS = Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" - -PS C:\>Remove-SPSiteSubscriptionFeaturePackMember -Identity $fs -FeatureDefinition (Get-SPFeature "PublishingSite") -``` - -This example removes the PublishingSite feature from the Feature set that has ID 30daa535-b0fe-4d10-84b0-fb04029d161a. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" | Remove-SPSiteSubscriptionFeaturePackMember -AllFeatureDefinitions -``` - -This example removes all features from the Feature set 30daa535-b0fe-4d10-84b0-fb04029d161a. - - -## PARAMETERS - -### -Identity -Specifies the Feature set from which to remove a feature. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. - -```yaml -Type: SPSiteSubscriptionFeaturePackPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllFeatureDefinitions -Clears all features from the Feature set. - -```yaml -Type: SwitchParameter -Parameter Sets: AllFeatureDefinitions -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureDefinition -Specifies the feature definition to be removed. - -```yaml -Type: SPFeatureDefinitionPipeBind -Parameter Sets: SingleFeatureDefinition -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionMetadataConfig.md deleted file mode 100644 index fa835e53a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionMetadataConfig.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscriptionMetadataConfig -schema: 2.0.0 ---- - -# Remove-SPSiteSubscriptionMetadataConfig - -## SYNOPSIS -Removes site subscription configuration settings. - - -## SYNTAX - -``` -Remove-SPSiteSubscriptionMetadataConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPSiteSubscriptionMetadataConfig` cmdlet to remove the site subscription-specific configuration settings for a specified Metadata Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE------------------- -``` -PS C:\>Remove-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -``` - -This example removes the site subscription-specific settings from an existing partitioned Metadata Service application. - - -## PARAMETERS - -### -Identity -Specifies the site subscription for which to remove the Metadata Service application settings. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceProxy -Specifies the local metadata service proxy for the service application containing the site subscription-specific settings. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionProfileConfig.md deleted file mode 100644 index 25a1c17a73..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionProfileConfig.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscriptionProfileConfig -schema: 2.0.0 ---- - -# Remove-SPSiteSubscriptionProfileConfig - -## SYNOPSIS -Deletes a site subscription from a User Profile Service application. - - -## SYNTAX - -### Default -``` -Remove-SPSiteSubscriptionProfileConfig [-Identity] <SPSiteSubscriptionPipeBind> - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### ServiceContext -``` -Remove-SPSiteSubscriptionProfileConfig -ServiceContext <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSiteSubscriptionProfileConfig` cmdlet deletes a site subscription from a User Profile Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------EXAMPLE----------------- -``` -PS C:\>$sub = Get-SPSiteSubscription http://contoso/my -PS C:\>$pr = Get-SPServiceApplicationProxy | ?{$_.DisplayName.Contains(PartitionedUserProfileApplication_Proxy)} -PS C:\>Remove-SPSiteSubscriptionProfileConfig -Identity $sub -ProfileServiceApplicationProxy $pr -``` - -This example removes tenant data. - - -## PARAMETERS - -### -Identity -Specifies the proxy of the User Profile Service application that contains the site subscription to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Name of the proxy of the User Profile Service application. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context for the User Profile service application to connect to. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionSettings.md deleted file mode 100644 index 52a7dd649c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteSubscriptionSettings.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteSubscriptionSettings -schema: 2.0.0 ---- - -# Remove-SPSiteSubscriptionSettings - -## SYNOPSIS -Removes the settings service data for a specified site subscription, or finds and removes orphaned data. - - -## SYNTAX - -### FindAllOrphans -``` -Remove-SPSiteSubscriptionSettings [-Identity] <SPServiceApplicationPipeBind> [-FindAllOrphans] - [-AlternativeSiteSubscriptions <Guid[]>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] - [-WhatIf] [<CommonParameters>] -``` - -### SpecifySiteSubscriptions -``` -Remove-SPSiteSubscriptionSettings [-Identity] <SPServiceApplicationPipeBind> -SiteSubscriptions <Guid[]> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Remove-SPSiteSubscriptionSettings` cmdlet deletes site subscription stored data for the specified site subscription. -If the FindAllOrphans parameter is specified, this cmdlet locates any data in the service application that does not exist in the list of local site subscriptions or the alternate list of subscriptions. - -The set of site subscriptions can be specified directly, or discovered by comparing data in the service application to the set of existing site subscriptions which finds the data set that corresponds to nonexistent site subscriptions. - -If this cmdlet is run on a federated service application without specifying the complete list of site subscription IDs for the AlternativeSiteSubscriptions parameter, data loss can result. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------EXAMPLE 1-------------- -``` -PS C:\>Remove-SPSiteSubscriptionSettings -FindAllOrphans -Whatif -``` - -This example finds all orphans and displays them on the screen. -Remove the WhatIf parameter to remove these extra settings. - - -### ------------EXAMPLE 2-------------- -``` -PS C:\>Remove-SPSubscriptionSettingsServiceApplication -FindAllOrphans -AlternativeSiteSubscriptions $SubscriptionList -``` - -Use this example if the service application is consumed by a remote farm and you want the clean orphaned site subscription settings data (an array of all site subscriptions whose data must remain in the service application is assigned to the $SubscriptionList variable. - - -## PARAMETERS - -### -Identity -Specifies the site subscription settings service application that contains the service data to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FindAllOrphans -Specifies that orphaned settings stores in the service application are deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscriptions -Specifies the site subscriptions with the settings service data to delete. - -The type must be an array of valid GUIDs. - -```yaml -Type: Guid[] -Parameter Sets: SpecifySiteSubscriptions -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AlternativeSiteSubscriptions -Specifies the complete collection or comma-separated list of site subscriptions that should exist in the settings service application. -Any data not matching the items in this list will be removed. - -This parameter is important when the FindAllOrphans parameter is used. -The value specified for AlternativeSiteSubscriptions parameter is stating that any site subscriptions not on the local farm will be deleted, unless an alternate list of site subscriptions is given. - -The type must be an array of valid GUIDs. - -```yaml -Type: Guid[] -Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Automatically bypasses the secondary warning provided by the cmdlet prior to the operation. - -```yaml -Type: SwitchParameter -Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteURL.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteURL.md deleted file mode 100644 index 77057c4db6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteURL.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteURL -schema: 2.0.0 ---- - -# Remove-SPSiteURL - -## SYNOPSIS -Removes an URL mapping from the site. - - -## SYNTAX - -``` -Remove-SPSiteURL [-Url] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSiteUrl` cmdlet removes an URL mapping from the site. - -The `Remove-SPSiteUrl` cmdlet only applies to the root site collection for a host name, that is, http://www.contoso.com. -This cmdlet cannot be directly run against a managed path site collection underneath the root, that is, http://www.contoso.com/sites/test. - -You cannot remove the primary URL for a given site collection, which is typically defined as the first URL in the default zone. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPSiteURL -Url http://contoso.sharepoint.com -``` - -This example removes the URL from the site collection, http://contoso.sharepoint.com. - - -## PARAMETERS - -### -Url -Specifies the URL to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPSiteUrl](Get-SPSiteUrl.md) - -[Set-SPSiteUrl](Set-SPSiteUrl.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteUpgradeSessionInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteUpgradeSessionInfo.md deleted file mode 100644 index b20d71758f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSiteUpgradeSessionInfo.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSiteUpgradeSessionInfo -schema: 2.0.0 ---- - -# Remove-SPSiteUpgradeSessionInfo - -## SYNOPSIS -Removes an SPSite object from upgrade. - - -## SYNTAX - -``` -Remove-SPSiteUpgradeSessionInfo [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPSiteUpgradeSessionInfo` cmdlet to remove an SPSite object from the upgrade queue. - -If the site is not in the upgrade queue, the returned value is Null. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------EXAMPLE------------- -``` -PS C:\>Get-SPSite | Remove-SPSiteUpgradeSessionInfo -``` - -This example removes the SPSite objects from the farm. - - -## PARAMETERS - -### -Identity -Specifies the site from which to remove the site collections. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPSiteUpgradeSessionInfo](Get-SPSiteUpgradeSessionInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSocialItemByDate.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSocialItemByDate.md deleted file mode 100644 index bdae3bab94..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSocialItemByDate.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSocialItemByDate -schema: 2.0.0 ---- - -# Remove-SPSocialItemByDate - -## SYNOPSIS -Deletes tags, notes, or ratings. - - -## SYNTAX - -``` -Remove-SPSocialItemByDate -EndDate <DateTime> - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-RemoveComments <Boolean>] - [-RemoveRatings <Boolean>] [-RemoveTags <Boolean>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPSocialItemByDate` cmdlet to delete, tags, notes, ratings created before a particular date. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPSocialItemByDate -RemoveTags 1 -ProfileServiceApplicationProxy c6681d53-e6c4-432f-9f31-22d3de81b00c -EndDate 9/15/2009 -``` - -This example removes tags before 9/15/09 from the specified User Profile Service Application Proxy. - - -## PARAMETERS - -### -EndDate -Specifies the date before which data is to be deleted. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the unique identifier for the proxy. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveComments -When this parameter is specified, comments will be removed. - -Valid values for this parameter are: - --- $True --- $False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveRatings -When this parameter is specified, ratings will be removed. - -Valid values for this parameter are: - ---$True ---$False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveTags -When this parameter is specified, tags will be removed. - -Valid values for this parameter are: - ---$True ---$False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSolution.md deleted file mode 100644 index 78c1a71f17..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSolution.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSolution -schema: 2.0.0 ---- - -# Remove-SPSolution - -## SYNOPSIS -Removes a SharePoint solution from a farm. - - -## SYNTAX - -``` -Remove-SPSolution [-Identity] <SPSolutionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Force] [-Language <UInt32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSolution` cmdlet deletes a SharePoint solution from a farm. -Before you use this cmdlet, you must use the `Uninstall-SPSolution` cmdlet to retract the solution files from the front-end Web server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPSolution -Identity contoso_solution.wsp -``` - -This example removes the SharePoint solution contoso_solution.wsp. - - -## PARAMETERS - -### -Identity -Specifies the SharePoint solution to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. - -```yaml -Type: SPSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the removal of the SharePoint solution. -You can use this parameter to remove SharePoint solutions that have been added to the server, even if they have not been deployed by using the `Install-SPSolution` cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Removes the language pack for the specified language. - -The type must be a valid language identifier; for example, 1033. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSolutionDeploymentLock.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSolutionDeploymentLock.md deleted file mode 100644 index 36d3c0c442..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSolutionDeploymentLock.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPSolutionDeploymentLock -schema: 2.0.0 ---- - -# Remove-SPSolutionDeploymentLock - -## SYNOPSIS -Removes the solution deployment lock for a server. - - -## SYNTAX - -``` -Remove-SPSolutionDeploymentLock [[-Identity] <SPServerPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPSolutionDeploymentLock` cmdlet removes the solution deployment lock for a server. -If the Identity parameter is not specified, this cmdlet removes the solution deployment lock for all servers in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPSolutionDeploymentLock -``` - -This example removes the solution deployment lock for all servers in the farm. - - -## PARAMETERS - -### -Identity -Specifies the server for which the solution deployment lock is to be removed. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. - -```yaml -Type: SPServerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPStateServiceDatabase.md deleted file mode 100644 index ab4b513dd3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPStateServiceDatabase.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Remove-SPStateServiceDatabase - -## SYNOPSIS -Removes a state service database from a state service application and drops it from the SQL Server. - - -## SYNTAX - -``` -Remove-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPStateServiceDatabase` cmdlet removes a state service database from a state service application and deletes the database. -To remove a state service database and not delete the database, use the `Dismount-SPStateServiceDatabase` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Remove-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -``` - -This example removes the specified database from a SharePoint Server farm and drops the database from the SQL Server (data loss). - - -## PARAMETERS - -### -Identity -Specifies the state service database to remove. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPThrottlingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPThrottlingRule.md deleted file mode 100644 index 55f9a5c7f3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPThrottlingRule.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPThrottlingRule -schema: 2.0.0 ---- - -# Remove-SPThrottlingRule - -## SYNOPSIS -Removes a throttling rule. - - -## SYNTAX - -``` -Remove-SPThrottlingRule [-Identity] <SPThrottlingRulePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPThrottlingRule` cmdlet to remove a throttling rule from the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>$c=New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false - -C:\PS>$throttlingrule=Add-SPThrottlingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -Threshold 4 - -PS C:\>Remove-SPThrottlingRule -Identity $throttlingrule -``` - -This example removes a throttling rule for a specified identity by using the $throttlingrule variable. - - -## PARAMETERS - -### -Identity -Specifies the throttling rule object to remove. - -```yaml -Type: SPThrottlingRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPThrottlingRule](Add-SPThrottlingRule.md) - -[Get-SPThrottlingRule](Get-SPThrottlingRule.md) - -[Set-SPThrottlingRule](Set-SPThrottlingRule.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTranslationServiceJobHistory.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTranslationServiceJobHistory.md deleted file mode 100644 index af6a34607d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTranslationServiceJobHistory.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Office.TranslationServices.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPTranslationServiceJobHistory -schema: 2.0.0 ---- - -# Remove-SPTranslationServiceJobHistory - -## SYNOPSIS -Removes Machine Translation service jobs. - - -## SYNTAX - -``` -Remove-SPTranslationServiceJobHistory [-Identity] <TranslationServiceApplicationPipeBind> [-AllPartitions] - [-AssignmentCollection <SPAssignmentCollection>] [-BeforeDate <DateTime>] [-Confirm] [-IncludeActiveJobs] - [-JobId <Guid>] [-PartitionId <Guid>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPTranslationServiceJobHistory` cmdlet to remove a machine translation service job from the job history database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE-------------- -``` -PS C:\>Remove-SPTranslationServiceJobHistory TranslationService -BeforeDate 2012/01/31 -``` - -This example removes all jobs completed before 2012/01/31 in the database associated with the Machine Translation Service application named TranslationService. - - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the instance of the Machine Translation service to remove. - -The type must be a valid URL, in the form http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: TranslationServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AllPartitions -Removes all the jobs from the database given other parameters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BeforeDate -Specifies all expired jobs before a given date. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeActiveJobs -Specifies expired jobs which contain active translations. -By default, jobs are not deleted if a translation is active. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies only a job Id and its items to expire. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionId -Specifies only a partition Id and its items to expire. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedIdentityTokenIssuer.md deleted file mode 100644 index 4eece8e383..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedIdentityTokenIssuer.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPTrustedIdentityTokenIssuer -schema: 2.0.0 ---- - -# Remove-SPTrustedIdentityTokenIssuer - -## SYNOPSIS -Deletes a Security Token Service (STS) identity provider from the farm. - - -## SYNTAX - -``` -Remove-SPTrustedIdentityTokenIssuer [-Identity] <SPTrustedIdentityTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPTrustedIdentityTokenIssuer` cmdlet deletes a Security Token service (STS) identity provider from the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE-------------------- -``` -PS C:\>Remove-SPTrustedIdentityTokenIssuer "LiveIDSTS" -``` - -This example removes an identity provider named LiveIDSTS from the farm. - - -## PARAMETERS - -### -Identity -Specifies the identity provider to remove. - -The type must be one of the following forms: - ---A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ---A valid name of identity provider (for example, LiveID STS) ---An instance of a valid SPIdentityProvider object - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedRootAuthority.md deleted file mode 100644 index 93665e1415..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedRootAuthority.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPTrustedRootAuthority -schema: 2.0.0 ---- - -# Remove-SPTrustedRootAuthority - -## SYNOPSIS -Deletes a trusted root authority. - - -## SYNTAX - -``` -Remove-SPTrustedRootAuthority [-Identity] <SPTrustedRootAuthorityPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPTrustedRootAuthority` cmdlet deletes a trusted root authority from a signing certificate store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPTrustedRootAuthority -Name "WFEFarm1" -``` - -This example removes the trusted root authority WFEFarm1. - - -## PARAMETERS - -### -Identity -Specifies the trusted root authority to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. - -```yaml -Type: SPTrustedRootAuthorityPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedSecurityTokenIssuer.md deleted file mode 100644 index 9a01232001..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedSecurityTokenIssuer.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPTrustedSecurityTokenIssuer -schema: 2.0.0 ---- - -# Remove-SPTrustedSecurityTokenIssuer - -## SYNOPSIS -Removes the trusted security token service object. - - -## SYNTAX - -``` -Remove-SPTrustedSecurityTokenIssuer [-Identity] <SPTrustedSecurityTokenServicePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPTrustedSecurityTokenService` cmdlet to remove the trusted security token service object by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPTrustedSecurityTokenService -Identity FarmA -``` - -This example removes the trusted security token issuer object named FarmA from the farm. - - -## PARAMETERS - -### -Identity -Specifies the ID of the trusted security token issuer object to be removed. - -```yaml -Type: SPTrustedSecurityTokenServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPTrustedSecurityTokenIssuer](Get-SPTrustedSecurityTokenIssuer.md) - -[New-SPTrustedSecurityTokenIssuer](New-SPTrustedSecurityTokenIssuer.md) - -[Set-SPTrustedSecurityTokenIssuer](Set-SPTrustedSecurityTokenIssuer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedServiceTokenIssuer.md deleted file mode 100644 index 671134811c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPTrustedServiceTokenIssuer.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPTrustedServiceTokenIssuer -schema: 2.0.0 ---- - -# Remove-SPTrustedServiceTokenIssuer - -## SYNOPSIS -Deletes the object that represents the farm trust. - - -## SYNTAX - -``` -Remove-SPTrustedServiceTokenIssuer [-Identity] <SPTrustedServiceTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPTrustedServiceTokenIssuer` cmdlet deletes the object that represents the farm trust. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Remove-SPTrustedServiceTokenIssuer "WFE Farm 2" -``` - -This example deletes the trusted service token issuer WFE Farm 2. - - -## PARAMETERS - -### -Identity -Specifies the trusted service token issuer to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. - -```yaml -Type: SPTrustedServiceTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUsageApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUsageApplication.md deleted file mode 100644 index 95d7cf81d3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUsageApplication.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPUsageApplication -schema: 2.0.0 ---- - -# Remove-SPUsageApplication - -## SYNOPSIS -Removes a usage application from the local farm. - - -## SYNTAX - -``` -Remove-SPUsageApplication [-Identity] <SPUsageApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-RemoveData] - [-UsageService <SPUsageServicePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPUsageApplication` cmdlet deletes a usage application from the local farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE-------------------- -``` -PS C:\>Remove-SPUsageApplication -Identity "Usage and Health data collection" -RemoveData -``` - -This example removes the existing usage application and the associated logging DB. - - -## PARAMETERS - -### -Identity -Specifies the usage application to delete. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object. - -```yaml -Type: SPUsageApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveData -Specifies that the logging database is also removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsageService -Reserved for future use. - -```yaml -Type: SPUsageServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUser.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUser.md deleted file mode 100644 index 34fb2dc7d9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUser.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPUser -schema: 2.0.0 ---- - -# Remove-SPUser - -## SYNOPSIS -Removes a user from a Web site. - - -## SYNTAX - -``` -Remove-SPUser [-Identity] <SPUserPipeBind> -Web <SPWebPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Group <SPGroupPipeBind>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPUser` cmdlet specifies the identity and user group from which a user is to be removed. -The `Remove-SPUser` cmdlet does not remove the user from Active Directory Domain Services (AD DS). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Remove-SPUser "Contoso \jdoe" -web http://test/web1 - -PS C:\>Get-SPWeb "http://test/web1" | Remove-SPUser "Contoso\jdoe" -``` - -This example removes the user (Contoso\jdoe) from the Web application http://test/web1. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPSite http://contoso.com |Get-SPWeb |Remove-SPUser "Contoso\jdoe" -``` - -This syntax removes the user (Contoso\Jdoe) from every Web in a site collection located at http://contoso.com. - - -## PARAMETERS - -### -Identity -Specifies the GUID, the user name, or SPUser object to remove. - -The type must be a valid GUID of the user, in the form 1234-5678-9876-0987. - -```yaml -Type: SPUserPipeBind -Parameter Sets: (All) -Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Web -Specifies the name of the URL or GUID from which the user is to be removed. -This parameter is needed only if the identity provided is the user name. - -The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-9807. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -The user only gets removed from that group. -Otherwise, the user gets removed from the site. - -```yaml -Type: SPGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserLicenseMapping.md deleted file mode 100644 index 6b8b26e150..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserLicenseMapping.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPUserLicenseMapping -schema: 2.0.0 ---- - -# Remove-SPUserLicenseMapping - -## SYNOPSIS -Removes a claim-to-SharePoint user license mapping. - - -## SYNTAX - -``` -Remove-SPUserLicenseMapping -Identity <System.Collections.Generic.List`1[System.Guid]> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPUserLicenseMapping` cmdlet uses the Identity parameter to remove a claim-to-SharePoint user license mapping. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------EXAMPLE--------------- -``` -PS C:\>Remove-SPUserLicenseMapping -Identity e69ba7cc-4be0-4723-ad63-58d06173afff -``` - -This example removes the claim-to-license mapping that has the unique ID, e69ba7cc-4be0-4723-ad63-58d06173afff. - - -## PARAMETERS - -### -Identity -Specifies the unique ID of a claim-to-license mapping. -The type must be a valid GUID (that is, e69ba7cc-4be0-4723-ad63-58d06173afff). - -```yaml -Type: System.Collections.Generic.List`1[System.Guid] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPUserLicenseMapping](Add-SPUserLicenseMapping.md) - -[Get-SPUserLicenseMapping](Get-SPUserLicenseMapping.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserSettingsProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserSettingsProvider.md deleted file mode 100644 index 316ef8206c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserSettingsProvider.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPUserSettingsProvider -schema: 2.0.0 ---- - -# Remove-SPUserSettingsProvider - -## SYNOPSIS -Removes a User Settings Provider. - - -## SYNTAX - -``` -Remove-SPUserSettingsProvider [-Identity] <SPUserSettingsProviderPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Remove-SPUserSettingsProvider` cmdlet to remove a User Settings Provider from the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPUserSettingsProvider -Identity "234bf0ed-70db-4158-a332-4dfd683b4148" -``` - -This example removes a specific User Settings Provider by using the GUID, 234bf0ed-70db-4158-a332-4dfd683b4148. - - -## PARAMETERS - -### -Identity -Specifies the GUID ID for a User Settings Provider to remove. - -```yaml -Type: SPUserSettingsProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPUserSettingsProvider](Get-SPUserSettingsProvider.md) - -[New-SPUserSettingsProvider](New-SPUserSettingsProvider.md) - -[Get-SPUserSettingsProviderManager](Get-SPUserSettingsProviderManager.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserSolution.md deleted file mode 100644 index 3bbf6ebbdd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPUserSolution.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPUserSolution -schema: 2.0.0 ---- - -# Remove-SPUserSolution - -## SYNOPSIS -Removes a sandboxed solution from the solution gallery. - - -## SYNTAX - -``` -Remove-SPUserSolution [-Identity] <String> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPUserSolution` cmdlet completely removes a sandboxed solution from the solution gallery. -Before you can remove the sandboxed solution from the solution gallery, you must deactivate it by using the `Uninstall-SPUserSolution` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------EXAMPLE---------------------- -``` -PS C:\>Remove-SPUserSolution -Identity contoso_solution.wsp -Site http://sitename -``` - -This example removes the sandboxed solution contoso_solution.wsp from the site http://sitename. - - -## PARAMETERS - -### -Identity -Specifies the sandboxed solution to remove. - -The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Remove the sandboxed solution from the specified site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPVisioSafeDataProvider.md deleted file mode 100644 index 5daeed3cc7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPVisioSafeDataProvider.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPVisioSafeDataProvider -schema: 2.0.0 ---- - -# Remove-SPVisioSafeDataProvider - -## SYNOPSIS -Removes a data provider from a Visio Services application. - - -## SYNTAX - -``` -Remove-SPVisioSafeDataProvider -DataProviderId <String> -DataProviderType <Int32> - -VisioServiceApplication <SPVisioServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPVisioSafeDataProvider` cmdlet deletes the safe data provider that is specified in the DataProviderID parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE------------------------ -``` -PS C:\>Remove-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "CustomProvider" -DataProviderType 5 -``` - -This example removes a safe data provider for a specified Visio Services application. - - -## PARAMETERS - -### -DataProviderId -Specifies the name of the data provider to delete. -The combination of DataProviderID and DataProviderType uniquely identifies a data provider for a Visio Services application. -The string that identifies the data provider can be a maximum of 255 alphanumeric characters. - -The type must be a valid string that identifies the data provider. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DataProviderType -Specifies the supported type of the data provider to delete. - -The type must be a valid identity of a data provider type. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWOPIBinding.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWOPIBinding.md deleted file mode 100644 index b966fc77cd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWOPIBinding.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPWOPIBinding -schema: 2.0.0 ---- - -# Remove-SPWOPIBinding - -## SYNOPSIS -Removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. - - -## SYNTAX - -### Identity -``` -Remove-SPWOPIBinding [[-Identity] <SPWopiBindingPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### Filter -``` -Remove-SPWOPIBinding [-Action <String>] [-Application <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Extension <String>] [-ProgId <String>] - [-Server <String>] [-WhatIf] [-WOPIZone <String>] [<CommonParameters>] -``` - -### RemoveAll -``` -Remove-SPWOPIBinding [-All] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPWOPIBinding` cmdlet removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. -After you run this cmdlet, you can use `New-SPWOPIBinding` to re-create the bindings as needed. -If you remove all the bindings for an application, users cannot use Office Web Apps or the SharePoint Share by link feature for that application. -If you remove all the bindings on the SharePoint farm where this cmdlet is run, users cannot use Office Web Apps or the SharePoint Share by link feature for any applications in the SharePoint library. - -If you want to stop using Office Web Apps for default clicks, but must preserve the bindings' discovery information and the ability for users to use the SharePoint Share by link feature to send a link to a document and allow the recipient to use Office Web Apps for that document type, use the `New-SPWOPISuppression` cmdlet instead. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Remove-SPWOPIBinding -Application "Excel" -``` - -This example removes all bindings for Excel on the current SharePoint farm where this cmdlet is run. - - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Remove-SPWOPIBinding -All:$true -``` - -This example removes all bindings on the current SharePoint farm where this cmdlet is run. - - -### --------------EXAMPLE 3----------------- -``` -PS C:\>Get-SPWOPIBinding -Action "MobileView" | Remove-SPWOPIBinding -``` - -This example removes all bindings for Office Mobile Web Apps on the current SharePoint farm where this cmdlet is run. - - -## PARAMETERS - -### -Identity -Specifies the binding. - -```yaml -Type: SPWopiBindingPipeBind -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Action -Specifies the action to remove bindings for. -For example, "view," "edit," and "embedview." For a list of actions run `Get-SPWOPIBinding`. -Most typically you will not use this parameter. -If you specify some actions but not others, some features in SharePoint may not work. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -Removes all bindings. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveAll -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Application -Specifies application to remove bindings for. -Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote." Run `Get-SPWOPIBinding` to get the list of applications. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the file name extensions to remove bindings for. -Run `Get-SPWOPIBinding` to get the list of file name extensions. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgId -Specifies the programmatic identifier (ProgID) for an application to remove bindings for. -Run `Get-SPWOPIBinding` to get the list of ProgIDs. -You may only want to use this parameter to remove bindings for OneNote. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of WOPI application (like Office Web Apps Server) to remove bindings for. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WOPIZone -Specifies the zone to remove bindings for. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[New-SPWOPIBinding](New-SPWOPIBinding.md) - -[Get-SPWOPIBinding](Get-SPWOPIBinding.md) - -[Set-SPWOPIBinding](Set-SPWOPIBinding.md) - -[New-SPWOPISuppressionSetting](New-SPWOPISuppressionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWOPISuppressionSetting.md deleted file mode 100644 index 0134939296..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWOPISuppressionSetting.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPWOPISuppressionSetting -schema: 2.0.0 ---- - -# Remove-SPWOPISuppressionSetting - -## SYNOPSIS -Removes the suppression settings for a file name extension or programmatic ID and action on the current SharePoint farm where this cmdlet is run. - - -## SYNTAX - -### DocTypeAndAction -``` -Remove-SPWOPISuppressionSetting [-Action <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Extension <String>] [-ProgId <String>] [-WhatIf] [<CommonParameters>] -``` - -### Identity -``` -Remove-SPWOPISuppressionSetting [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Identity <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPWOPISuppressionSetting` cmdlet removes the suppression settings for a file name extension or programmatic indentifier (ProgID) and action on the current SharePoint farm where this cmdlet is run. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Remove-SPWOPISuppressionSetting -Extension "XLSX" -Action "view" -``` - -This example removes suppression settings for viewing Excel workbooks that have the file name extension ".xlsx." - - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Get-SPWOPISuppressionSetting | Remove-SPWOPISuppressionSetting -``` - -This example removes all suppression settings on the current SharePoint farm where this cmdlet is run. - - -## PARAMETERS - -### -Action -Specifies the action for a given file name extension or programmatic identifier (ProgId). -For example, "view," "edit," and "embedview." - -```yaml -Type: String -Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the file name extension. -Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. - -```yaml -Type: String -Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies a string that represents a SPWOPISuppressionSetting. -Run `Get-SPWOPISuppressionSetting` to see examples of such strings. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProgId -Specifies the programmatic identifier (ProgID) for an application to suppress. -Run `Get-SPWOPIBinding` to get the list of ProgIDs that the WOPI application supports. - -```yaml -Type: String -Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[New-SPWOPISuppressionSetting](New-SPWOPISuppressionSetting.md) - -[Get-SPWOPISuppressionSetting](Get-SPWOPISuppressionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWeb.md deleted file mode 100644 index 76caa607ca..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWeb.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPWeb -schema: 2.0.0 ---- - -# Remove-SPWeb - -## SYNOPSIS -Completely deletes the specified Web. - - -## SYNTAX - -``` -Remove-SPWeb [-Identity] <SPWebPipeBind> [-Recycle] [-CheckComplianceFlags <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-SPWeb** cmdlet completely deletes the Web specified by the Identity parameter. - -Deleting the top level Web site of a site collection causes the entire site collection to be removed. - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Remove-SPWeb http://sitename/subsite -``` - -This example completely deletes a subsite. - - -## PARAMETERS - -### -Identity -Specifies the identity of the Web to delete. - -The type must be a valid full URL, in the form http://server_name/site_name, or an SPWeb object. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` -### -CheckComplianceFlags -Specifies if compliance flags are enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recycle -Specifies if the SPWeb object should be recycled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWebApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWebApplication.md deleted file mode 100644 index 6e649c4752..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWebApplication.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPWebApplication -schema: 2.0.0 ---- - -# Remove-SPWebApplication - -## SYNOPSIS -Deletes the specified Web application. - - -## SYNTAX - -### RemoveZoneOfWebApp -``` -Remove-SPWebApplication [-Identity] <SPWebApplicationPipeBind> -Zone <SPUrlZone> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DeleteIISSite] [-WhatIf] [<CommonParameters>] -``` - -### RemoveWebApp -``` -Remove-SPWebApplication [-Identity] <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DeleteIISSite] [-RemoveContentDatabases] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Remove-SPWebApplication` cmdlet deletes the Web application specified by the Identity and Zone parameters. -If no zone is provided, the entire Web application and all zones are removed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Get-SPWebApplication http://sitename | Remove-SPWebApplication -Zone "Internet" -Confirm -``` - -This example prompts and then removes the Internet zone Web application extension on the Web application at http://sitename. -This command does not remove the content databases or the IIS Web site. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Remove-SPWebApplication http://sitename -Confirm -DeleteIISSite -RemoveContentDatabases -``` - -This example permanently removes the Web application, all content databases and the IIS Web site at http://sitename - - -## PARAMETERS - -### -Identity -Specifies the URL or name of the Web application to delete. - -The type must be a valid URL, in the form http://server_name, or a valid name, in the form WebApplication-1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Zone -Specifies one of the five zones to be removed. -If this parameter is not provided, all Web application zones are removed. - -The type must be any one of the following values: Default, Intranet, Internet, Extranet, or Custom. - -```yaml -Type: SPUrlZone -Parameter Sets: RemoveZoneOfWebApp -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteIISSite -Deletes the associated IIS Web sites. -If this parameter is not provided, the IIS site is not removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveContentDatabases -Permanently deletes all associated content databases. -If this parameter is not provided, no content databases are removed. - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveWebApp -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWebApplicationAppDomain.md deleted file mode 100644 index e3ba1a7330..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWebApplicationAppDomain.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPWebApplicationAppDomain -schema: 2.0.0 ---- - -# Remove-SPWebApplicationAppDomain - -## SYNOPSIS -Deletes the AppDomain. - -## SYNTAX - -``` -Remove-SPWebApplicationAppDomain [-Identity] <SPAppDomainPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-SPWebApplicationAppDomain cmdlet to delete the AppDomain for a specified zone or to delete all the app domains for the web application if no zone is specified. - -This cmdlet also deletes the Internet Information Services (IIS) port binding if any was added for the WebApp/Zone combination. - -## EXAMPLES - -### ----------------------EXAMPLE 1----------------------- -``` -PS C:\>Remove-SPWebApplicationAppDomain -WebApplication http://www.contoso.com -``` -Removes all of the app domains for the specified web application. - -### ----------------------EXAMPLE 2----------------------- -``` -PS C:\>Remove-SPWebApplicationAppDomain -WebApplication http://www.contoso.com -Zone Internet -``` -Removes the app domains for the internet zone for the specified web application. - -## PARAMETERS - -### -Identity -Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object to remove. - -```yaml -Type: SPAppDomainPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.Administration.SPAppCmdlets.SPAppDomainPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPWebApplicationAppDomain](Get-SPWebApplicationAppDomain.md) - -[New-SPWebApplicationAppDomain](New-SPWebApplicationAppDomain.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWordConversionServiceJobHistory.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWordConversionServiceJobHistory.md deleted file mode 100644 index fe998f1005..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPWordConversionServiceJobHistory.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Office.Word.Server.dll-Help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Remove-SPWordConversionServiceJobHistory -schema: 2.0.0 ---- - -# Remove-SPWordConversionServiceJobHistory - -## SYNOPSIS -Removes entries from the Word Automation Services job history database. - - -## SYNTAX - -``` -Remove-SPWordConversionServiceJobHistory [-Identity] <WordServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-BeforeDate <DateTime>] [-Confirm] [-IncludeActiveJobs] - [-JobId <Guid>] [-SubscriptionId <Guid>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-SPWordConversionServiceJobHistory` cmdlet removes entries from the Word Automation Services job history database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------------EXAMPLE 1------------------------ -``` -PS C:\>Get-SPServiceApplication -Name TestWordServer | Remove-SPWordConversionServiceJobHistory -BeforeDate 1/1/2009 -``` - -This example deletes all the items in the database before 1/1/2009. - - -### ---------------------EXAMPLE 2------------------------ -``` -PS C:\>Get-SPServiceApplication -Name TestWordServer | Remove-SPWordConversionServiceJobHistory -JobId 00000000-0000-0112-08FF-63927635FEF1 -IncludeActiveJobs -``` - -This example deletes the job with the specified ID, even if it is still processing. - - -## PARAMETERS - -### -Identity -Specifies the Word Automation Services application to be processed. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: WordServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BeforeDate -Specifies that only jobs started before this date are to be removed. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeActiveJobs -Specifies that jobs that contain active conversions can be removed. -By default, jobs that have active conversions are not removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies that only the job with the specified ID is to be removed. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies that only jobs corresponding to this subscription ID are to be removed. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Rename-SPServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Rename-SPServer.md deleted file mode 100644 index b70bf875f6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Rename-SPServer.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Rename-SPServer -schema: 2.0.0 ---- - -# Rename-SPServer - -## SYNOPSIS -Renames a server that is currently connected to the farm. - - -## SYNTAX - -``` -Rename-SPServer [-Identity] <SPServerPipeBind> -Name <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Rename-SPServer` cmdlet changes the name of the server for internal use within SharePoint Products. -The server itself must be manually renamed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Rename-SPServer -Identity "wfb1" -Name "WFE1" -``` - -This example changes the name of the SharePoint server wfb1 to WFE1. - - -## PARAMETERS - -### -Identity -Specifies the original name of the server. - -The type must be a URL, in the form http://server_name, or a GUID, in the form 1234-4567-987gb. - -```yaml -Type: SPServerPipeBind -Parameter Sets: (All) -Aliases: Address -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the new name of the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPManagedAccountDeployment.md b/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPManagedAccountDeployment.md deleted file mode 100644 index be05673782..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPManagedAccountDeployment.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Repair-SPManagedAccountDeployment -schema: 2.0.0 ---- - -# Repair-SPManagedAccountDeployment - -## SYNOPSIS -Repairs the local managed account credential deployment. - - -## SYNTAX - -``` -Repair-SPManagedAccountDeployment [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Repair-SPManagedAccountDeployment` cmdlet to repair the local deployment of managed account credentials deployment on a server for the rare cases that the managed accounts service credentials are in a broken state. -It re-deploys each local service and Web applications credentials and also determines if the passphrase is not correct on the server and repairs provides warnings accordingly. -The `Repair-SPManagedAccountDeployment` cmdlet should not be used as part of the regular credential update process, but should be one of the first troubleshooting steps, specifically if a servers' services are failing to start when other servers' services are working correctly. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Repair-SPManagedAccountDeployment -``` - -This example repairs the deployment of credentials on all services and Web application associated with managed account (s) on the local server. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPProjectWebInstance.md deleted file mode 100644 index d40afd6e36..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPProjectWebInstance.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Repair-SPProjectWebInstance -schema: 2.0.0 ---- - -# Repair-SPProjectWebInstance - -## SYNOPSIS -Re-queues specific Project Server queue items that may have fallen out of the queue. - - -## SYNTAX - -``` -Repair-SPProjectWebInstance [-Identity] <ProjectInstancePipeBind> -RepairRule <ProjectSiteHealthRuleName> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Repair-SPProjectWebInstance` cmdlet re-queues specific Project Server queue items that may have fallen out of the queue. -This includes triggers that may have been missed and queue jobs that were enqueued on a server that was subsequently removed from the farm. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Repair-SPProjectWebInstance -Identity http://contoso-appsrv/PWA -RepairRule QueueMissingTriggers -``` - -This example enqueues any missing triggers for the Project Web App instance at http://contoso-appsrv/PWA. - - -## PARAMETERS - -### -Identity -The identity of the instance of Project Web App. - -```yaml -Type: ProjectInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RepairRule -Valid values: QueueMissingTriggers searches the Project Web App for any triggers that might have been missed; QueueStaleServerGroups re-queues any jobs that were picked up by a server that was subsequently removed from the farm. - -```yaml -Type: ProjectSiteHealthRuleName -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Test-SPProjectWebInstance](Test-SPProjectWebInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPSite.md deleted file mode 100644 index 79fa52e707..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Repair-SPSite.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Repair-SPSite -schema: 2.0.0 ---- - -# Repair-SPSite - -## SYNOPSIS -Activates the RunRepairs method against the referenced SPSite object. - - -## SYNTAX - -``` -Repair-SPSite [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-RuleId <Guid>] [-RunAlways] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Repair-SPSite` cmdlet runs one or all site collection health checks on the site collection and its contents. -This cmdlet automatically repairs issues that it finds. - -Run the `Test-SPSite` cmdlet for reports of rules which were run and a summary of the results. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------EXAMPLE 1--------------- -``` -PS C:\>Repair-SPSite http://<site name>/sites/testsite -``` - -This example runs all the site collection health checks in repair mode on the http://\<site name\>/sites/testsite site collection. - - -### ------------EXAMPLE 2--------------- -``` -PS C:\>Repair-SPSite http://<site name>/sites/testsite -Rule "ee967197-ccbe-4c00-88e4-e6fab81145e1" -``` - -This example runs just the "Missing Galleries Check" in repair mode on the http://\<site name\>/sites/testsite site collection. - - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site to run a repair. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleId -Specifies the specific site health rule to run instead of running all applicable rules at once. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunAlways -Forces a rule to run even if a health check was run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Test-SPSite](Test-SPSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Request-SPUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Request-SPUpgradeEvaluationSite.md deleted file mode 100644 index 1e0b82d62c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Request-SPUpgradeEvaluationSite.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Request-SPUpgradeEvaluationSite -schema: 2.0.0 ---- - -# Request-SPUpgradeEvaluationSite - -## SYNOPSIS -Requests an upgrade evaluation site for a specified site. - - -## SYNTAX - -``` -Request-SPUpgradeEvaluationSite [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Email] [-NoUpgrade] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Request-SPUpgradeEvaluationSite` cmdlet to initiate a request to create temporary copy of a site collection at an auto-generated URL and upgrade the site collection to a newer experience. -Users can view the site to see how their site will work in the new experience. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>$site=Get-SPSite https://contoso.com/sites/TeamSite1 -PS C:\>Request-SPUpgradeEvaluationSite $site -NoUpgrade -Email -``` - -This example requests an upgrade evaluation site the specified contoso.com team site. - - -## PARAMETERS - -### -Identity -Specifies the SPSite object for the new upgrade evaluation site collection. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies not to send the requester and site collection administrators a notification email when the upgrade evaluation site is ready. -The default value is not to send an email message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoUpgrade -Specifies not to perform an upgrade as part of the process that creates the upgrade evaluation site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPAccessServicesDatabasePassword.md b/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPAccessServicesDatabasePassword.md deleted file mode 100644 index 2f0f21e8cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPAccessServicesDatabasePassword.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Reset-SPAccessServicesDatabasePassword -schema: 2.0.0 ---- - -# Reset-SPAccessServicesDatabasePassword - -## SYNOPSIS -Resets the specified Access Services Database password with a randomly generated password. - -## SYNTAX - -``` -Reset-SPAccessServicesDatabasePassword [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] -Database <AccessServicesDatabasePipeBind> - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Resets the specified Access Services Database password with a randomly generated password. - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>$contentdb = Get-SPContentDatabase ContentDbName -PS C:\>$db = Get-SPAccessServicesDatabase -ContentDb $contentdb -EA 0 | select -First 1 -PS C:\>Reset-SPAccessServicesDatabasePassword -Database $db -ServiceContext http://site_url -``` - -Resets the database password for the specified Access Database. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -The specified Access Services database. - -```yaml -Type: AccessServicesDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context for the local Access Services application to connect to. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.Office.Access.Services.PowerShell.AccessServicesDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectEventServiceSettings.md deleted file mode 100644 index 1002afb390..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectEventServiceSettings.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2016, Project Server 2019 -title: Reset-SPProjectEventServiceSettings -schema: 2.0.0 ---- - -# Reset-SPProjectEventServiceSettings - -## SYNOPSIS -Resets the Microsoft Project Server Events Service 2016 settings to the default values. The Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - - -## SYNTAX - -``` -Reset-SPProjectEventServiceSettings [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Resets the Microsoft Project Server Events Service 2016 settings to the default values. The Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Reset-SPProjectEventServiceSettings -``` - -Resets the Microsoft Project Server Events Service 2016 settings to the default values. The Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectPCSSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectPCSSettings.md deleted file mode 100644 index 13c972213b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectPCSSettings.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Reset-SPProjectPCSSettings -schema: 2.0.0 ---- - -# Reset-SPProjectPCSSettings - -## SYNOPSIS -Resets the settings for the Project Calculation Engine on Project Server. - - -## SYNTAX - -``` -Reset-SPProjectPCSSettings [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Reset-SPProjectPCSSettings` cmdlet lets you reset the settings that control the operations of the Project Calculation Engine on Project Server. -The cmdlet requires you to identify the Project Server service application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} -PS C:\>Reset-SPProjectPCSSettings -ServiceApplication $sa -``` - -This cmdlet resets the settings for the Project Calculation Engine that is running on a Project Server Service Application. - - -## PARAMETERS - -### -ServiceApplication -The Project Server service application for which the settings are to be read. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectQueueSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectQueueSettings.md deleted file mode 100644 index a04fbd51d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPProjectQueueSettings.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Reset-SPProjectQueueSettings -schema: 2.0.0 ---- - -# Reset-SPProjectQueueSettings - -## SYNOPSIS -Resets all Project Server Queue settings to their default values for a specific Project Server Service Application. - - -## SYNTAX - -``` -Reset-SPProjectQueueSettings [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Resets all Project Server Queue settings to their default values for a specific Project Server Service Application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} -PS C:\>Reset-SPProjectQueueSettings -ServiceApplication $sa -``` - -This example resets the queue settings for a Project Server Service Application service application. - - -## PARAMETERS - -### -ServiceApplication -Specifies the Project Server service application to target. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name for a Project Server service application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPProjectQueueSettings](Set-SPProjectQueueSettings.md) - -[Get-SPProjectQueueSettings](Get-SPProjectQueueSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPSites.md b/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPSites.md deleted file mode 100644 index 12e2dc5135..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Reset-SPSites.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Reset-SPSites -schema: 2.0.0 ---- - -# Reset-SPSites - -## SYNOPSIS -Synchronizes the content database with the configuration database of the farm. - -## SYNTAX - -``` -Reset-SPSites [-Identity] <SPContentDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Reset-SPSites cmdlet synchronizes the content database with the configuration database of the farm with respect to what site collections actually exist in the content database. - -It also ensures that all site collections in the content database are registered in the configuration database and removes any site collection references in the configuration database if the site collection does not exist in the content database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>$contentdb = Get-SPContentDatabase ContentDbName -PS C:\>Reset-SPSites -Identity $contentDb -``` - -Synchronizes the sites in the content database named ContentDbName with the configuration database. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies a specific content database. This could either be ID or Name of the content database or a valid instance of a content database. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPContentDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Restart-SPAppInstanceJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Restart-SPAppInstanceJob.md deleted file mode 100644 index 8ff8f1f724..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Restart-SPAppInstanceJob.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Restart-SPAppInstanceJob -schema: 2.0.0 ---- - -# Restart-SPAppInstanceJob - -## SYNOPSIS -Restarts an app instance. - -## SYNTAX - -``` -Restart-SPAppInstanceJob -AppInstance <SPAppInstance> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Restart-SPAppInstanceJob cmdlet to restart an app instance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>$instance = Get-SPAppInstance -Web http://site_url | ?{$_.Title -eq 'Contoso App'} -PS C:\>Restart-SPAppInstanceJob -AppInstance $instance -``` - -Restarts the App Instance for the App named 'Contoso App' on http://site_url. - -## PARAMETERS - -### -AppInstance -Specifies the app instance object to restart. - -```yaml -Type: SPAppInstance -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPDeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPDeletedSite.md deleted file mode 100644 index 5e09f8ceba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPDeletedSite.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Restore-SPDeletedSite -schema: 2.0.0 ---- - -# Restore-SPDeletedSite - -## SYNOPSIS -Restores a deleted site collection. - - -## SYNTAX - -``` -Restore-SPDeletedSite [-Identity] <SPDeletedSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-ContentDatabase <SPContentDatabasePipeBind>] [-WebApplication <SPWebApplicationPipeBind>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -Use the `Restore-SPDeletedSite` cmdlet to restore a previously deleted site collection. - -Unlike the `Restore-SPSite` cmdlet that uses the host name and scheme for the Identity parameter (that is, http://server_name), the value of the identity parameter for all SPDeletedSite cmdlets use a server-relative URL. -Typically, the forward slash character (/) begins the relative URL and also denotes the root site. - -For additional information about a server-relative URL or understanding general concepts about absolute and relative URLs, see Server-relative URL Property (http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spsite.serverrelativeurl.aspx) or Understanding Absolute and Relative URL Addresses (http://msdn.microsoft.com/en-us/library/bb208688(office.12).aspx). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE 1---------------------- -``` -PS C:\>$deletedSite = Get-SPDeletedSite /sites/site_name -PS C:\>Restore-SPDeletedSite -Identity $deletedSite -``` - -This example restores a specific deleted site collection by using the site ID. - - -## PARAMETERS - -### -Identity -Specifies the identity of the deleted site collection to be restored. -The identity can be either a valid server-relative URL in the form /sites/site_name; a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPDeletedSite object. - -A site collection must not already exist at the URL location to perform a restore. - -```yaml -Type: SPDeletedSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the SQL Server content database where the site collection data will be stored. -If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the URL, GUID, or name of the Web application from which to list sites. - -The type must be a valid URL in the form http://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index 1b37660200..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Restore-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Restore-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Restores third-party backup of a search application. - - -## SYNTAX - -### Config -``` -Restore-SPEnterpriseSearchServiceApplication [-Name] <String> - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> - -AdminSearchServiceInstance <SearchServiceInstancePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] -DatabaseName <String> [-DatabasePassword <SecureString>] -DatabaseServer <String> - [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-WhatIf] [<CommonParameters>] -``` - -### Full -``` -Restore-SPEnterpriseSearchServiceApplication [-Name] <String> - -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-KeepId] [-WhatIf] -TopologyFile <String> [-DeferUpgradeActions] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. - -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -This cmdlet is used by third parties to create a search application that uses existing data. - -Some third parties back up the application data and have to restore the application later. So, the data is restored and uses the `Restore-SPEnterpriseSearchServiceApplication` cmdlet to create a new search application that uses the restored data. - -This cmdlet supports parameter sets. - -The first set of parameters is for Application Configuration Attach mode and the second set of parameters is for Search Application Attach mode. - -Application Configuration Attach mode only restores configuration data that is stored in the administration database. -However, Search Application Attach restores configuration, topology and all crawled data. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------------EXAMPLE 1----------------------- -``` -PS C:\>$searchInstance = Get-SPEnterpriseSearchServiceInstance -local -PS C:\>$applicationPool = New-SPServiceApplicationPool -Name "SearchServiceApplicationPool" -Account "domain\username" -PS C:\>Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -ApplicationPool $applicationPool -AdminSearchServiceInstance $searchInstance -DatabaseName "SearchServiceApplication_Admindb" -DatabaseServer "SQLServer1" -``` - -This example uses Application Configuration Attach mode to restore configuration data. - - -### ----------------------EXAMPLE 2----------------------- -``` -PS C:\>$applicationPool = New-SPServiceApplicationPool -Name "SearchServiceApplicationPool" -Account "domain\username" -PS C:\>Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -ApplicationPool $applicationPool -TopologyFile "C:\TopologyFile.xml" -``` - -This example uses Search Application Attach mode to restore topology data in the file that is named topology.xml. - - -## PARAMETERS - -### -Name -Specifies the new Search application name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the application pool for the query web service. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminSearchServiceInstance -Specifies the search service instance to be used with the administration component. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to create for the restoring the search application. - -The type must be a valid name of a SQL Server database, for example, RestoreDB1. - -```yaml -Type: String -Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the name of the password for the database server on the SQL Server. - -```yaml -Type: SecureString -Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid SQL Server host name, for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the account name that is specified in the Database Server parameter. - -```yaml -Type: String -Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Use this parameter if you want the administration database to use a failover database server. - -```yaml -Type: String -Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepId -Specifies if the search service application ID's from the topology .xml file should be used for the restored search service application. - -```yaml -Type: SwitchParameter -Parameter Sets: Full -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TopologyFile -Specifies the path of the .XML file that contains the application topology information. - -```yaml -Type: String -Parameter Sets: Full -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeferUpgradeActions -Prevents database schema update during restore. Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: Full -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPEnterpriseSearchServiceApplicationIndex.md b/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPEnterpriseSearchServiceApplicationIndex.md deleted file mode 100644 index b8ea831ef0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPEnterpriseSearchServiceApplicationIndex.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Restore-SPEnterpriseSearchServiceApplicationIndex -schema: 2.0.0 ---- - -# Restore-SPEnterpriseSearchServiceApplicationIndex - -## SYNOPSIS -Restores the search index from the specified backup files. - - -## SYNTAX - -### Restore -``` -Restore-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] <SearchServiceApplication> - [-BackupFolder] <String> [-AllReplicas] [-AllowMove] [[-Retries] <Int32>] [[-RetryPauseSeconds] <Int32>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### RestoreProgress -``` -Restore-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] <SearchServiceApplication> - [-Handle] <String> [[-Retries] <Int32>] [[-RetryPauseSeconds] <Int32>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -This cmdlet will clear the complete search index for a specified search service application and replace it with the search index from the specified backup files. - -This cmdlet supports parameter sets. -The first set of parameters is for Application Configuration Attach mode and the second set of parameters is for Search Application Attach mode. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000" -PS C:\>Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -Handle $handle -``` - -This example starts a restore of the search index in the default search service application from a backup located at \\\\sample\backup\spbr0000. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000" -PS C:\>Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication "Search Service Application" -Handle $handle -``` - -This example checks the status of the running job to restore of the search index in the search service application Search Service Application with the handle $handle . - - -## PARAMETERS - -### -SearchApplication -Specifies the search service application that contains the index files that should be restored. - -```yaml -Type: SearchServiceApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupFolder -Specifies the full file path of the backup files. - -```yaml -Type: String -Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Handle -A handle returned from an initial call using Parameter set 1. - -```yaml -Type: String -Parameter Sets: RestoreProgress -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllReplicas -Specifies a switch to restore all replicas, not just the primary. - -```yaml -Type: SwitchParameter -Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMove -Specifies a switch to move instead of copying files when restoring. -Moving may be faster than copying. - - -```yaml -Type: SwitchParameter -Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Retries -Specifies the number of times to retry if temporary failure occurs. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryPauseSeconds -Seconds to pause between retries if temporary failure occurs. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPFarm.md b/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPFarm.md deleted file mode 100644 index f471c7dc59..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPFarm.md +++ /dev/null @@ -1,364 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Restore-SPFarm -schema: 2.0.0 ---- - -# Restore-SPFarm - -## SYNOPSIS -Restores one or more items from a backup. - - -## SYNTAX - -### DefaultSet -``` -Restore-SPFarm -Directory <String> -RestoreMethod <String> [-AssignmentCollection <SPAssignmentCollection>] - [-BackupId <Guid>] [-ConfigurationOnly] [-Confirm] [-FarmCredentials <PSCredential>] [-Force] [-Item <String>] - [-NewDatabaseServer <String>] [-Percentage <Int32>] [-RestoreThreads <Int32>] [-WhatIf] [<CommonParameters>] -``` - -### ShowTree -``` -Restore-SPFarm -Directory <String> [-ShowTree] [-AssignmentCollection <SPAssignmentCollection>] - [-BackupId <Guid>] [-ConfigurationOnly] [-Confirm] [-Item <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Restore-SPFarm` cmdlet restores one or more items from a backup such as an individual database, Web application, or the entire farm. -This cmdlet can also be used to apply a farm template to the entire farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE 1----------------------- -``` -PS C:\>Restore-SPFarm -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod new -ConfigurationOnly -``` - -This example restores the configuration settings from the backup package in the \\\\file_server\share\Backup directory to the farm. - - -### -------------------EXAMPLE 2----------------------- -``` -PS C:\>Restore-SPFarm -ShowTree -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -Item "Microsoft SharePoint Foundation Web Application" -Verbose -``` - -This example show which components of the farm would be restored under the Microsoft SharePoint Foundation Web Application node, but does not actually restore them. - - -### -------------------EXAMPLE 3----------------------- -``` -PS C:\>Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod overwrite -RestoreThreads 10 -Force -``` - -This example restores a farm by using 10 threads and suppresses the overwrite warning. - - -## PARAMETERS - -### -Directory -Specifies the path where SharePoint Products stored the backup package. -If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. -This includes a basic installation. -However, if SQL Server and SharePoint Products are installed on multiple computers, you must use Universal Naming Convention (UNC) share paths so that the SQL Server and SharePoint Products can read from the same location (for example, \\\\computer_name \volume\Backup). - -The type must be either of the valid paths: - -- C:\folder_name -- \\\\server_name\folder_name - -The spbr* folders are created automatically. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestoreMethod -Specifies the method of restore to perform. - -The valid values are: - -- New; Specifies a new location to restore the content and is intended to be used when restoring to a different farm. Additional prompts will be presented to specify the new settings. -- Overwrite; Restores content and settings to their original locations and is intended to be used when restoring to the same farm it was backed up from. If the Overwrite parameter is used, a confirmation prompt is displayed. If you want the confirmation prompt suppressed, use the Force parameter. - -```yaml -Type: String -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowTree -Displays which objects in the farm will be restored based on the other parameters passed to the `Restore-SPFarm` cmdlet namely the Item and ConfigurationOnly parameters. -Items that will be excluded from the restore based on the other parameters passed to the `Restore-SPFarm` cmdlet will be preceded with an asterisk (*). -Items that cannot be restored will be enclosed in square brackets (\[ \]). -A restore operation will not be performed if the ShowTree parameter is present. - -```yaml -Type: SwitchParameter -Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackupId -Specifies the GUID of the backup package that is to be restored. -Each backup package has a unique GUID associated with it. -The GUID can be seen by using the `Get-SPBackupHistory` cmdlet to view the backup history. -If this parameter is not specified, the most recent backup package in the path that is specified with the Directory parameter is used. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConfigurationOnly -Specifies settings only (no data) will be restored from the backup package and applied to objects on the destination farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FarmCredentials -Specifies the credentials that will be used for all components being restored. -For example, the application pool credentials for Web applications being restored. -If an application pool being restored already exists in the farm, the credentials specified by the FarmCredentials parameter is ignored when restoring that application pool. - -```yaml -Type: PSCredential -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Suppresses the prompt warning that you will overwrite components when you perform an overwrite restore operation. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Indicates the part of the backup package to be restored. -You can use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if it has a unique name. -If multiple items match the name, the full path must be provided. -Surround the item or path in double quotation marks if it contains a space. -If this parameter is absent, the entire backup package is restored. - -The type must be a valid item, such as: - -Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseServer -Specifies a valid SQL Database Server name. -If specified, will be used as a default Database Server name for all databases within the restore operation. - -This parameter is only valid when restoring as new. -It is not valid for overwrite restores. - -```yaml -Type: String -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Percentage -Requests that progress updates about the restore operation be displayed in increments of that percentage. -For example, a value of 5 displays restore progress updates at every 5 percent completed, and a value of 10 displays restore progress updates at every 10 percent completed. - -Note: Progress will only be displayed in the output if the -Verbose parameter is specified. -Otherwise, you may see the progress in the restore log file. - -This percentage is not precise and the actual progress updates might be lower or higher than requested. - -For a very large database, 1 is the recommended value. - -The type must be an integer value between 1 and 100. - -The default value is 5. - -```yaml -Type: Int32 -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestoreThreads -The number of threads that should be used during the restore. - -The fewer the restore threads, the easier it is to understand the restore log. -However, the more restore threads, the more components can be restored in parallel, potentially resulting in a faster restore. - -The valid range is between 1 and 10. -The default value is 3. - -```yaml -Type: Int32 -Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPSite.md deleted file mode 100644 index 749dfaa02b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Restore-SPSite.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Restore-SPSite -schema: 2.0.0 ---- - -# Restore-SPSite - -## SYNOPSIS -Restores a site collection. - - -## SYNTAX - -### DatabaseFromPipebind -``` -Restore-SPSite [-Identity] <String> -Path <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-ContentDatabase <SPContentDatabasePipeBind>] [-Force] [-GradualDelete] [-HostHeaderWebApplication <String>] - [-WhatIf] [-PreserveSiteID] [<CommonParameters>] -``` - -### DatabaseParameter -``` -Restore-SPSite [-Identity] <String> -Path <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DatabaseName <String>] [-DatabaseServer <String>] [-Force] [-GradualDelete] - [-HostHeaderWebApplication <String>] [-WhatIf] [-PreserveSiteID] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Restore-SPSite` cmdlet performs a restoration of the site collection to a location specified by the Identity parameter. -A content database may only contain one copy of a site collection. -If a site collection is backed up and restored to a different URL location within the same Web application, an additional content database must be available to hold the restored copy of the site collection. - - -## EXAMPLES - -### ----------------------EXAMPLE 1---------------------- -``` -PS C:\>Restore-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -``` - -This example restores a site collection from the backup file C:\Backup\site_name.bak to the site collection URL http://server_name/sites/site_name. - - -### ----------------------EXAMPLE 2---------------------- -``` -PS C:\>Restore-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -Force -DatabaseServer SQLBE1 -DatabaseName SQLDB1 -``` - -This example restores a site collection backup from the backup file C:\Backup\site_name.bak, but overwrites the existing site collection at http://server_name/sites/site_name while specifying that the site collection must be stored in a specific content database. - - -### ----------------------EXAMPLE 3---------------------- -``` -PS C:\>Restore-SPSite http://www.example.com -Path \\file_server\share\site_name.bak -HostHeaderWebApplication http://server_name -``` - -This example restores a site collection backup from the backup file \\\\file_server\share\site_name.bak to the host-named site collection http://www.example.com on the Web application http://server_name. - - -## PARAMETERS - -### -Identity -Specifies the URL location to which the site collection is restored. - -A site collection does not have to already exist at the URL location to perform a restore. -However, you must specify a valid URL location that a site collection can be created. -If a site collection already exists at the specified URL location, you must specify the Force parameter to overwrite it. - -The type must be a valid URL, in the form http://server_name/sites/site_name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a valid path to the location of the backup. -For example, C:\Backup\site_name.bak. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentDatabase -Specifies the SQL Server content database where the site collection data will be stored. -If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: DatabaseFromPipebind -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the SQL Server content database where the site collection data will be stored. -If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. - -The type must be a valid database name, in the form SQLDB1. - -```yaml -Type: String -Parameter Sets: DatabaseParameter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the SQL Server containing the content database specified by the DatabaseName parameter. - -The type must be a valid database server name, in the form SQLBE1 and needs to be used in conjunction with the DatabaseName parameter. - -```yaml -Type: String -Parameter Sets: DatabaseParameter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that the existing site collection at the URL location is to be overwritten by this restoration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GradualDelete -Specifies that the site collection being overwritten with the Force parameter should be gradually deleted over time by a timer job instead of all at once, which reduces its impact on SharePoint Products and SQL Server performance. -This option is recommended for large site collections. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostHeaderWebApplication -A valid URL assigned to the Web application by using alternate access mapping, such as http://server_name - -Restores a site collection as a host-named site collection instead of a path-based site collection. -When the HostHeaderWebApplication parameter is present, the value of the Identity parameter is the URL of the host-named site collection and the value of the HostHeaderWebApplication parameter is the URL of the Web application that will hold the host-named site collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreserveSiteID -Preserves the original Site ID instead of creating a new one. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index 241b3bfc6d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Resume-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Resume-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Resumes a search service application that was suspended. - -## SYNTAX - -``` -Resume-SPEnterpriseSearchServiceApplication [-Identity] <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads the SearchServiceApplication object and moves it from the Paused for: External Request status to the Resumed status. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA -PS C:\>$ssa | Resume-SPEnterpriseSearchServiceApplication -``` - -This example obtains a reference to a search service application named MySSA and then resumes it. - -## PARAMETERS - -### -Identity -Specifies the search service application to resume. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, MyQueryServer); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPProjectWebInstance.md deleted file mode 100644 index 3f08c046c9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPProjectWebInstance.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Resume-SPProjectWebInstance -schema: 2.0.0 ---- - -# Resume-SPProjectWebInstance - -## SYNOPSIS -Switches the specified instance of Project Web App to read-write mode, allowing users to change data again. - -## SYNTAX - -``` -Resume-SPProjectWebInstance [-Identity] <ProjectInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Switches the specified instance of Project Web App to read-write mode, allowing users to change data again. -This cmdlet does not set the database itself to read-write. -The database must be set to read-write before you run this cmdlet, or this cmdlet will fail. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} -PS C:\>$instance = Get-SPProjectWebInstance -ServiceApplication $sa -PS C:\>Resume-SPProjectWebInstance -Identity $instance -``` - -Resumes the Project Web Server Instance in the Project Web Application Service Application. - -## PARAMETERS - -### -Identity -Specifies the instance of Project Web App to be switched to read-write mode. -It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite). - -```yaml -Type: ProjectInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Pause-SPProjectWebInstance](Pause-SPProjectWebInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPStateServiceDatabase.md deleted file mode 100644 index 4015f1a99d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Resume-SPStateServiceDatabase.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Resume-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Resume-SPStateServiceDatabase - -## SYNOPSIS -Resumes a paused state service database so that new rows of data are received. - - -## SYNTAX - -``` -Resume-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Resume-SPStateServiceDatabase` cmdlet resumes a paused state service database, an operation that adds the state service database to the set of databases that can receive new data as required by SharePoint Server applications. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE------------------ -``` -PS C:\>$db = Get-SPStateServiceDatabase -Identity StateServceDbName -PS C:\>Resume-SPStateServiceDatabase -Identity $db -``` - -This example resumes a paused state service database. - - -## PARAMETERS - -### -Identity -Specifies the state service database to resume. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Revoke-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/sharepoint-server/Revoke-SPBusinessDataCatalogMetadataObject.md deleted file mode 100644 index 58bba0e3eb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Revoke-SPBusinessDataCatalogMetadataObject.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Revoke-SPBusinessDataCatalogMetadataObject -schema: 2.0.0 ---- - -# Revoke-SPBusinessDataCatalogMetadataObject - -## SYNOPSIS -Revokes a right to a principal in the specified Business Data Connectivity Metadata Store metadata object. - - -## SYNTAX - -``` -Revoke-SPBusinessDataCatalogMetadataObject -Identity <MetadataObject> -Principal <SPClaim> -Right <PSBdcRight> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SettingId <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Revoke-SPBusinessDataCatalogMetadataObject` cmdlet revokes a right granted to a principal user in the specified Business Data Connectivity Metadata Store metadata object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$claimJohn = New-SPClaimsPrincipal -Identity "CONTOSO\johndoe" -IdentityType WindowsSamAccountName -PS C:\>$MetadataObject = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext http://contoso -Name "ContosoDatabase" -PS C:\>Revoke-SPBusinessDataCatalogMetadataObject -Identity $MetadataObject -Principal $claimJohn -Right "Execute" -``` - -This example removes the execute right from the External System with the name ContosoDatabase for the user with the identity of johndoe on the domain CONTOSO. - - -## PARAMETERS - -### -Identity -Specifies the Business Data Connectivity Metadata Store metadata object that contains the principal. - -```yaml -Type: MetadataObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Principal -Specifies the principal to whom the rights apply. - -The type must be a claim. - -```yaml -Type: SPClaim -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Right -Specifies the right to revoke the principal. - -The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients. - -```yaml -Type: PSBdcRight -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingId -Specifies the custom environment settings model slice for which to revoke the right. - -The type must be a valid string that identifies a model slice; for example, ModelSlice1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchConfiguration.md deleted file mode 100644 index 89b79fe70e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchConfiguration.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchConfiguration ---- - -# Set-FASTSearchConfiguration - -## SYNOPSIS -Configures the local instance of Microsoft FAST Search Server 2010 for SharePoint. - -## SYNTAX - -``` -Set-FASTSearchConfiguration [-LogFile <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet configures the local instance of FAST Search Server 2010 for SharePoint. - -FAST Search Server 2010 for SharePoint must be installed, but not running, on the local machine before you run this cmdlet. - -If you are not running this cmdlet on the admin node in the FAST Search Server 2010 for SharePoint installation, make sure that the admin node is started before you run this cmdlet. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FastSearchConfiguration -LogFile C:\log.txt -``` - -This example configures the local machine and writes the log output to C:\log.txt. - -## PARAMETERS - -### -LogFile -Specifies the full path of a file where all log messages will be written. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchIPSec.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchIPSec.md deleted file mode 100644 index 38c2fdf8be..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchIPSec.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchIPSec ---- - -# Set-FASTSearchIPSec - -## SYNOPSIS -Configures local Internet Protocol security (IPsec) for Microsoft FAST Search Server 2010 for SharePoint. - -## SYNTAX - -### Create -``` -Set-FASTSearchIPSec [-Create] -Password <SecureString> -UserName <String> [-LogFile <String>] - [<CommonParameters>] -``` - -### Remove -``` -Set-FASTSearchIPSec [-Remove] [-LogFile <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet deletes or creates firewall rules to configure IP security for the local machine. - -FAST Search Server 2010 for SharePoint must be installed on the local machine before you run this cmdlet. - -If you are not running this cmdlet on the admin node in the FAST Search Server 2010 for SharePoint installation, make sure that the admin node is started before you run this cmdlet. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchIPSec -Create -UserName user1 -Password xxx -``` - -This example sets up Internet Protocol security on the local machine. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchIPSec -Remove -``` - -This example removes Internet Protocol security rules from the local machine. - -## PARAMETERS - -### -Create -Specifies that IPsec rules will be created. - -```yaml -Type: SwitchParameter -Parameter Sets: Create -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the domain user that can look up machines in the domain controller. - -```yaml -Type: SecureString -Parameter Sets: Create -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Remove -Specifies that IPsec rules will be deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: Remove -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the username of the domain user that can look up machines in the domain controller. - -```yaml -Type: String -Parameter Sets: Create -Aliases: User -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogFile -Specifies the full path of a file where all log messages will be written. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCategory.md deleted file mode 100644 index 55a764464f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCategory.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataCategory ---- - -# Set-FASTSearchMetadataCategory - -## SYNOPSIS -Updates the settings of a crawled property category. - -## SYNTAX - -### Category -``` -Set-FASTSearchMetadataCategory -Category <Category> [-MapToContents <Boolean>] - [-DiscoverNewProperties <Boolean>] [-NewName <String>] [<CommonParameters>] -``` - -### Name -``` -Set-FASTSearchMetadataCategory -Name <String> [-MapToContents <Boolean>] [-DiscoverNewProperties <Boolean>] - [-NewName <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet changes the settings of a crawled property category. -A category is a group of crawled properties, and the properties of the category control the default behavior of the member crawled properties. - -If MapToContents is set to "true" on a crawled property category, new crawled properties added to a category are mapped to the "content" full text index. -The names of the crawled properties mapped to the "content" full text index are added to the crawledpropertynames managed property. -You can override this action by setting the crawled property's IsMappedToContents parameter to "false". - -You can call the cmdlet with either the name of the category (Name parameter), or with a category object (Category parameter). - -You can also use the cmdlet to rename a category. - -You can only map a crawled property to one category at a time. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchMetadataCategory -Name Titles -DiscoverNewProperties 1 -MapToContents 1 -``` - -With this example, all new crawled properties for the category "Titles" are automatically discovered and added to the category. -A crawled property is considered a member of the category if it has the same property set as the category. - -This example also sets MapToContents so that new crawled properties are mapped to the "content" full text index. -If you do not want a newly discovered crawled property made available through the full text index, override this action by setting the specific crawled property's IsMappedToContents parameter to false. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchMetadataCategory -Name ExtendedTitle -Newname Titles -``` - -This example changes the name of the category "ExtendedTitle" to "Titles". - -## PARAMETERS - -### -Category -Specifies the category to be changed. - -```yaml -Type: Category -Parameter Sets: Category -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the category to update. - -```yaml -Type: String -Parameter Sets: Name -Aliases: CategoryName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MapToContents -If this parameter is set to true, all newly created or discovered properties (if automatic discovery is enabled) are added to the "content" full text index. - -The name of each crawled property is added to the "crawledpropertynames" managed property. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverNewProperties -If this parameter is set to true, previously unknown crawled properties mapped to this category (having the same property set identifier) are created and added to the category. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewName -The new name for the category. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataCategory](Get-FASTSearchMetadataCategory.md) - -[Remove-FASTSearchMetadataCategory](Remove-FASTSearchMetadataCategory.md) - -[New-FASTSearchMetadataCategory](New-FASTSearchMetadataCategory.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCrawledProperty.md deleted file mode 100644 index f0e1042eaf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCrawledProperty.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataCrawledProperty ---- - -# Set-FASTSearchMetadataCrawledProperty - -## SYNOPSIS -Updates the properties of a crawled property. - -## SYNTAX - -### CrawledProperty -``` -Set-FASTSearchMetadataCrawledProperty -CrawledProperty <CrawledProperty> [-Propset <Guid>] - [-VariantType <Int32>] [-IsMappedToContents <Boolean>] [<CommonParameters>] -``` - -### Name -``` -Set-FASTSearchMetadataCrawledProperty -Name <String> [-Propset <Guid>] [-VariantType <Int32>] - [-IsMappedToContents <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet specifies if a crawled property should be automatically indexed as part of the default full text index, "content". - -When the IsMappedToContents parameter is set to "true", the crawled property is added to the default searchable index. - -To find the crawled property to update, specify a crawled property object, or the combination of name, property set, and variant type. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$description = Get-FASTSearchMetadataCrawledProperty -Name Description -$description # Before -Set-FASTSearchMetadataCrawledProperty -CrawledProperty $description -IsMappedToContents 1 -$description # After -``` - -This example automatically maps a crawled property to the full text index "content", making the content of the crawled property searchable. - -## PARAMETERS - -### -CrawledProperty -An object representing the crawled property to update. - -```yaml -Type: CrawledProperty -Parameter Sets: CrawledProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the crawled property to update. - -```yaml -Type: String -Parameter Sets: Name -Aliases: CrawledPropertyName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Propset -The property set GUID of the crawled property which is being updated. - -The GUID controls which category the crawled property is part of. -A GUID (Global Unique Identifier) is a 128-bit integer that has a very low probability of being duplicated. -The accepted GUID format is "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" or a System.Guid object. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VariantType -An integer value specifying the variant type of the updated crawled property. - -See https://go.microsoft.com/fwlink/?LinkId=163232 (https://go.microsoft.com/fwlink/?LinkId=163232) for a list of common variant types. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMappedToContents -This Boolean parameter specifies whether or not the content of the crawled property should be automatically mapped into the default full text index. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataCrawledProperty](New-FASTSearchMetadataCrawledProperty.md) - -[Get-FASTSearchMetadataCrawledProperty](Get-FASTSearchMetadataCrawledProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCrawledPropertyMapping.md deleted file mode 100644 index aa6df45ca1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataCrawledPropertyMapping.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataCrawledPropertyMapping ---- - -# Set-FASTSearchMetadataCrawledPropertyMapping - -## SYNOPSIS -Specifies which crawled properties map into specific managed properties. - -## SYNTAX - -### ManagedProperty -``` -Set-FASTSearchMetadataCrawledPropertyMapping - -CrawledPropertyMapping <System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledProperty]> - -ManagedProperty <ManagedProperty> [<CommonParameters>] -``` - -### Name -``` -Set-FASTSearchMetadataCrawledPropertyMapping - -CrawledPropertyMapping <System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledProperty]> - -Name <String> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet replaces a managed property's crawled property mappings with a set of mappings specified as a parameter (CrawledPropertyMapping). -All other existing crawled property mappings for the managed property are removed. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$title = Get-FASTSearchMetadataManagedProperty -Name title -$extendedtitle = Get-FASTSearchMetadataManagedProperty -name extendedtitle -$mappings_for_title = $title.GetCrawledPropertyMappings() -Set-FASTSearchMetadataCrawledPropertyMapping -CrawledPropertyMapping $mappings_for_title -ManagedProperty $extendedtitle -``` - -This example adds the crawled property mappings from the managed property "title" to the managed property "extendedtitle". - -The example first retrieves a list of the crawled property mappings for the managed property named "title" using the GetCrawledPropertyMappings(). -It then calls Set-FASTSearchMetadataCrawledPropertyMapping with this list as a parameter. -This replaces any existing crawled property mappings for the managed property "extendedtitle". - -## PARAMETERS - -### -CrawledPropertyMapping -The list of crawled property mappings applied to the specified managed property. -The order in the list controls which crawled property is used when multiple crawled properties exist. -The list must consist of one or more Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledPropertyImpl objects. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledProperty] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -An object representing a managed property. - -```yaml -Type: ManagedProperty -Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the managed property whose crawled property mappings you are updating. - -```yaml -Type: String -Parameter Sets: Name -Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataCrawledPropertyMapping](Get-FASTSearchMetadataCrawledPropertyMapping.md) - -[New-FASTSearchMetadataCrawledPropertyMapping](New-FASTSearchMetadataCrawledPropertyMapping.md) - -[Remove-FASTSearchMetadataCrawledPropertyMapping](Remove-FASTSearchMetadataCrawledPropertyMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataFullTextIndex.md deleted file mode 100644 index a8885a5e58..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataFullTextIndex.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataFullTextIndex ---- - -# Set-FASTSearchMetadataFullTextIndex - -## SYNOPSIS -Updates the properties of a full text index. - -## SYNTAX - -### FullTextIndex -``` -Set-FASTSearchMetadataFullTextIndex -FullTextIndex <FullTextIndex> [-Description <String>] - [-StemmingEnabled <Boolean>] [<CommonParameters>] -``` - -### Name -``` -Set-FASTSearchMetadataFullTextIndex -Name <String> [-Description <String>] [-StemmingEnabled <Boolean>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet enables/disables stemming and changes the description of a full text index. - -Stemming is the process of reducing words to their base form or expanding to all known forms to increase recall. -Whether stemming is done through reduction or expansion depends on the language in which the content is written. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchMetadataFullTextIndex -name content -description "Central content repository" -``` - -This example updates the description of the existing full text index named "content". - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchMetadataFullTextIndex -Name content -StemmingEnabled 1 -``` - -This example enables stemming on the full text index named "content". -The content of the full text index must be recrawled/re-fed for this change to take effect. - -## PARAMETERS - -### -FullTextIndex -An object representing the full text index to be updated. - -```yaml -Type: FullTextIndex -Parameter Sets: FullTextIndex -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the full text index to be updated. - -```yaml -Type: String -Parameter Sets: Name -Aliases: FullTextIndexName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Description -A new description to use for the full text index. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StemmingEnabled -Enables or disables stemming for this full text index. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataFullTextIndex](New-FASTSearchMetadataFullTextIndex.md) - -[Remove-FASTSearchMetadataFullTextIndex](Remove-FASTSearchMetadataFullTextIndex.md) - -[Get-FASTSearchMetadataFullTextIndex](Get-FASTSearchMetadataFullTextIndex.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataFullTextIndexMapping.md deleted file mode 100644 index d554c7049d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataFullTextIndexMapping.md +++ /dev/null @@ -1,103 +0,0 @@ - --- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataFullTextIndexMapping ---- - -# Set-FASTSearchMetadataFullTextIndexMapping - -## SYNOPSIS -Updates the importance level of an existing full text index mapping. - -## SYNTAX - -``` -Set-FASTSearchMetadataFullTextIndexMapping -Level <Int32> -Mapping <FullTextIndexMapping> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet changes the importance level of an existing full text index mapping. - -Managed properties are mapped according to an importance level. -If the number of matching documents for a query term is higher than the StopWordThreshold for the rank profile in use, the Microsoft FAST Search Server 2010 for SharePoint system retries the query while limiting the search to managed properties belonging to a higher importance level than the one previously tried. - -It repeats this process until it finds a level where the query term count is lower than StopWordThreshold. - -Importance level 1 (the first that will be used) includes all levels from 1 and up. -Importance level 2 includes all levels 2 and up. -The maximum level is 7. - -This process is called drilling. -See Set-FASTSearchMetadataRankProfile for more information about StopWordThreshold. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$content = get-fastsearchmetadatafulltextindex -name content -$sitetitle = Get-FASTSearchMetadataManagedProperty -name sitetitle -$sitetitle_fulltextindexmapping = Get-FASTSearchMetadataFullTextIndexMapping -managedproperty $sitetitle -fulltextindex $content -Set-FASTSearchMetadataFullTextIndexMapping -mapping $sitetitle_fulltextindexmapping -level 7 -``` - -This example looks up a full text index mapping for a managed property named "SiteTitle" and moves it from importance level 1 to importance level 7. - -The example first retrieves the full text index object for "content" and the managed property object for "sitetitle". -It then uses these objects to get the full text index mapping object with the Get-FASTSearchMetadataFullTextIndexMapping cmdlet. -Finally, the example calls the Set-FASTSearchMetadataFullTextIndexMapping cmdlet to update the level. - -## PARAMETERS - -### -Level -The importance level to use for this mapping. -Valid values are 1 through 7. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ImportanceLevel, L -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mapping -The full text index object to update. - -```yaml -Type: FullTextIndexMapping -Parameter Sets: (All) -Aliases: FullTextIndexMapping, M -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataFullTextIndexMapping](New-FASTSearchMetadataFullTextIndexMapping.md) - -[Remove-FASTSearchMetadataFullTextIndexMapping](Remove-FASTSearchMetadataFullTextIndexMapping.md) - -[Get-FASTSearchMetadataFullTextIndexMapping](Get-FASTSearchMetadataFullTextIndexMapping.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataManagedProperty.md deleted file mode 100644 index 6d563396cd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataManagedProperty.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataManagedProperty ---- - -# Set-FASTSearchMetadataManagedProperty - -## SYNOPSIS -Updates the features of a managed property. - -## SYNTAX - -### ManagedProperty -``` -Set-FASTSearchMetadataManagedProperty -ManagedProperty <ManagedProperty> [-Description <String>] - [-MergeCrawledProperties <Boolean>] [-Queryable <Boolean>] [-RefinementEnabled <Boolean>] - [-SortableType <Int32>] [-SummaryType <Int32>] [-StemmingEnabled <Boolean>] [-DecimalPlaces <Int32>] - [-MaxIndexSize <Int32>] [-MaxResultSize <Int32>] [-IsMapped <Boolean>] [<CommonParameters>] -``` - -### Name -``` -Set-FASTSearchMetadataManagedProperty -Name <String> [-Description <String>] - [-MergeCrawledProperties <Boolean>] [-Queryable <Boolean>] [-RefinementEnabled <Boolean>] - [-SortableType <Int32>] [-SummaryType <Int32>] [-StemmingEnabled <Boolean>] [-DecimalPlaces <Int32>] - [-MaxIndexSize <Int32>] [-MaxResultSize <Int32>] [-IsMapped <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the properties/features of an existing managed property. - -Several of these changes require that the content be recrawled/re-fed to take full effect. -If, for example, a managed property is made searchable (Queryable) it will only become searchable after the content is updated. -During the recrawl/re-feed, the new content will be searchable, while the old will not. - -For properties such as whether the managed property should have sorting enabled (SortableType), the managed property defaults to the value '0' until the content has been re-fed/recrawled. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title -Set-FASTSearchMetadataManagedProperty -ManagedProperty $title -Refinement 1 -``` - -This example enables refinement for the managed property "title". -Content must be re-fed/recrawled to populate the refinement. -Until it is populated, the refinement defaults to having no value. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title -Set-FASTSearchMetadataManagedProperty -ManagedProperty $title -Queryable 1 -``` - -This example enables searching against the "title" managed property. -A front-end application can search in the specified managed property using the syntax: "title:\<search terms\>". - -Relevancy is not calculated for such queries (unlike searches against the full text indexes), and only the quality component of the relevancy score is available. - -The content must be recrawled/re-fed for this to take effect. - -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title -Set-FASTSearchMetadataManagedProperty -ManagedProperty $title -SummaryType 1 -``` - -This example changes the summary type for the managed property named "title" from dynamic to static. -A static summary type means that the entire contents of the managed property is returned as part of the item summary. - -The content must be recrawled/re-fed for this to take effect. - -## PARAMETERS - -### -ManagedProperty -The managed property object to modify. - -```yaml -Type: ManagedProperty -Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the managed property to modify. - -```yaml -Type: String -Parameter Sets: Name -Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Description -A text string describing the managed property's use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MergeCrawledProperties -This Boolean value controls whether or not multiple crawled properties mapped to this managed property are merged when multiple crawled properties are present in the input. - -If not set, only the first element of the first non-empty crawled property is stored in the managed property. -The one that is chosen is the crawled property that was mapped to the managed property first. - -The content must be re-fed/recrawled for this change to take effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queryable -This Boolean value specifies whether or not the managed property is directly searchable on its own (and not only as part of a full text index). - -If not set, it can only be searched when included in a full text index. - -The content must be recrawled/re-fed again for this change to take effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefinementEnabled -This Boolean value specifies whether or not a refiner is available for the managed property. - -Refiners group search results based on the values of individual managed properties from the complete result set of a query. -Refiners are often used to navigate the result set in the front-end application. - -After enabling refinement on a managed property, the content must be recrawled/re-fed for the change to take effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortableType -The sorting type of the managed property. -Valid values are: - --- 0 ("sorting disabled") specifies that the managed property is not sortable. --- 1 ("sorting enabled") specifies that the managed property is sortable. --- 2 ("latent sorting") specifies that the managed property is prepared for sorting, but must be changed to "sorting enabled" for sorting to be supported. - -In contrast to switching from "sorting disabled" to "sorting enabled", this does not require reprocessing of data. - -Setting sorting to latent on a managed property can help reduce memory resource usage, while keeping the option of enabling sorting quickly at a later date. - -If a managed property is changed from "sorting disabled" to "sorting enabled", the sort value will default to 0 for all documents that have not been recrawled/re-fed. - -Managed properties of the type datetime always have sorting enabled. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummaryType -The type of summary to return for the managed property. -Valid values are: - --- 0 (summary disabled), no content is returned for this managed property. --- 1 (static), the full value of the managed property is returned. --- 2 (dynamic), hit highlighting is done on the content of the managed property based on the query terms, and a hit highlighted summary is returned. - -The content must be recrawled/re-fed for any change in this setting to take effect, except when disabling summary generation. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StemmingEnabled -Enables or disables stemming for the managed property. - -Stemming is the process of reducing words to their base form, or expanding to all known forms, to increase recall. -Whether stemming is done through reduction or expansion depends on the content language. - -The content must be recrawled/re-fed for this to take effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecimalPlaces -This integer parameter specifies how many decimal places should be used for the managed property. - -A higher number of decimals provides a more precise result, but reduces the minimum and maximum number size that can be stored in the managed property. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxIndexSize -This integer parameter sets the maximum number of kilobytes indexed for the managed property. - -Valid values range from 0 through 2097151 (2GB). - -The measured value equals the data stored prior to indexing and is slightly larger than the effective number of kilobytes that is searchable for the managed property. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxResultSize -This integer parameter sets the maximum number of kilobytes that can be returned for this managed property. - -If a managed property's content is longer than this, then the returned version of the managed property is truncated to the specified value. - -Valid values are from 0 through 2097151 (2GB). - -If the summary type of the managed property is dynamic, then this size refers to the size of the source data used for generating the hit highlighted summary. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMapped -This Boolean parameter specifies whether or not the managed property is mapped to support Alternate Access Mappings in SharePoint. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - -[New-FASTSearchMetadataManagedProperty](New-FASTSearchMetadataManagedProperty.md) - -[Remove-FASTSearchMetadataManagedProperty](Remove-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataRankProfile.md deleted file mode 100644 index 29d176b046..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchMetadataRankProfile.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchMetadataRankProfile ---- - -# Set-FASTSearchMetadataRankProfile - -## SYNOPSIS -Reconfigures a rank profile. - -## SYNTAX - -### Name -``` -Set-FASTSearchMetadataRankProfile -Name <String> [-AuthorityWeight <Int32>] - [-FreshnessManagedPropertyReference <ManagedProperty>] [-FreshnessResolution <Int32>] - [-FreshnessWeight <Int32>] [-PositionStopWordThreshold <Int64>] [-QualityWeight <Int32>] - [-QueryAuthorityWeight <Int32>] [-RankModelName <String>] [-StopWordThreshold <Int64>] [<CommonParameters>] -``` - -### RankProfile -``` -Set-FASTSearchMetadataRankProfile -RankProfile <RankProfile> [-AuthorityWeight <Int32>] - [-FreshnessManagedPropertyReference <ManagedProperty>] [-FreshnessResolution <Int32>] - [-FreshnessWeight <Int32>] [-PositionStopWordThreshold <Int64>] [-QualityWeight <Int32>] - [-QueryAuthorityWeight <Int32>] [-RankModelName <String>] [-StopWordThreshold <Int64>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet adjusts the relevancy components of a rank profile to improve search result relevance. - -All weights are relative to each other. -If QualityWeight is 400, and AuthorityWeight is 100, this means that QualityWeight is 4 times more important than AuthorityWeight. - -After being multiplied by the weights determined in the rank profile, all relevance components are combined into a single rank score, which decides the sorting of the result set (as long as non-relevancy sorting is not specified). -All changes are effective immediately, and the content does not need to be re-fed for this to take effect. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchMetadataRankProfile -Name ExtraRankProfile -QualityWeight 100 -AuthorityWeight 200 -QueryAuthorityWeight 10 -FreshnessWeight 0 -``` - -This example changes the weights of the relevancy components on the rank profile named "ExtraRankProfile". -You can specify one or more weights to modify at a time. - -This example turns off the freshness relevancy component by setting the weight to 0, while adjusting the other components. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$processingtime = Get-FASTSearchMetadataManagedProperty -name Processingtime -Set-FASTSearchMetadataRankProfile -Name ExtraRankProfile -FreshnessManagedPropertyReference $processingtime -``` - -This example changes the "ExtraRankProfile" rank profile so that it no longer determines document freshness based on the "docdatetime" managed property. - -Instead, freshness is based on when the item was last processed (fed) into the FAST Search Server 2010 for SharePoint system. -The time the item was processed is stored in the "processingtime" managed property by default. - -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchMetadataRankProfile -Name ExtraRankProfile -StopWordThreshold 100000 -``` - -This example sets the stop word threshold of the rank profile named "ExtraRankProfile" to 100000. -The stop word threshold determines if the query term is too common to be taken into account when calculating the relevancy of an item. - -Lowering the stop word threshold means that more terms may be ignored when calculating relevancy, which can have a positive impact on performance. - -### ---------------EXAMPLE 4----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$rankprofile = Get-FASTSearchMetadataRankProfile -Name default -$rankprofile.GetQualityComponents() -``` - -The quality rank metric is an importance score assigned to a document, independent of query terms. -This example lists the managed properties involved in calculating the quality rank by calling the GetQualityComponents() method call on the rank profile. - -### ---------------EXAMPLE 5----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$new_rank_component = New-FASTSearchMetadataManagedProperty -Name sitecredibility -$rankprofile = Get-FASTSearchMetadataRankProfile -Name default -$rankprofile.CreateQualityComponent($new_rank_component,100) -$rankprofile.GetQualityComponents() -``` - -The quality rank metric is an importance score assigned to a document, independent of query terms. -This example adds another managed property, named "sitecredibility", to the list of quality components which form the quality rank score. -The "sitecredibility" managed property is weighted the same as the other quality components (100). - -The next step would be to populate "sitecredibility" with a suitable crawled property. - -## PARAMETERS - -### -Name -The name of the rank profile to modify. - -```yaml -Type: String -Parameter Sets: Name -Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RankProfile -An object representing a rank profile. - -```yaml -Type: RankProfile -Parameter Sets: RankProfile -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AuthorityWeight -This integer parameter sets the authority weight component of the rank profile. - -Ranking on authority takes the connections between items into account when calculating a relevancy score. -Items that are central and frequently linked to receive a higher authority relevancy score than items that are hard to reach and less frequently linked to. - -The authority relevancy score is calculated regularly by the Webanalyzer component. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FreshnessManagedPropertyReference -This parameter specifies which managed properties to use when calculating freshness. - -The managed property must be represented with a ManagedPropertyImpl object (e.g., as returned from Get-FASTSearchMetadataManagedProperty). - -The managed property must be of the type "datetime" and have sorting enabled. - -The value of the managed property is used when calculating how fresh the document is. -Items with an older datetime value in the specified managed property get a lower freshness relevancy score. - -```yaml -Type: ManagedProperty -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FreshnessResolution -This integer parameter sets the size of the freshness boost tick. - -The tick is the smallest amount of time the freshness relevancy considers to be a different value. - -If set to an hour, all documents with a freshness managed property value within the same hour receive the same freshness relevancy score. - -If set to a day, documents with the same day value in the freshness managed property are considered equally fresh. - -Valid values are: - -0 (Second) - -1 (Minute) - -2 (Hour) - -3 (Day) - -4 (Year) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FreshnessWeight -This integer parameter sets the weight of the freshness relevancy component when calculating the relevance of a result. - -The freshness rank value goes down the older the document is. - -See the FreshnessManagedPropertyReference parameter to change the managed property used for calculating freshness. - -Set this value to 0 to ignore item freshness when calculating relevancy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PositionStopWordThreshold -This integer parameter sets the position stop word threshold. - -If a query term occurs more often than position-stop-word-threshold (independent of the number of items it occurs in), then proximity relevancy calculations are not done for that term. - -If the query term count does not exceed the position stop word threshold, an extra rank score is added if query terms are positioned close to each other in the managed properties. - -If you do not want to use proximity as part of the relevancy model, set this parameter to 0 to disable proximity calculation. -This will decrease CPU use when searching. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QualityWeight -This integer parameter sets the weight of the quality component of the relevancy model. - -Quality denotes the assigned importance of a document. -The quality metrics are assigned to individual documents without taking into account the query being evaluated. - -An excessively high quality weight makes item ranking less dependent on the user query terms, which can lead to a poor search experience, since items with a high quality relevancy score could outweigh items that are more relevant to the query terms. - -The quality relevancy score is calculated dynamically, based on one or more quality components. -The GetQualityComponents() method available on the RankProfileImpl object lists the managed properties used for this. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryAuthorityWeight -This integer parameter sets the weight of the query authority relevancy component. - -The query authority increases for an item when a user clicks through to it from search results. -The more popular the item is for a given query, the higher the query authority relevancy score. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RankModelName -The name of a rank profile to modify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopWordThreshold -This integer parameter sets the stop word threshold of the rank profile. - -A stop word is a search term that is so common in the result set that it is not counted as part of the relevancy calculation. - -When a query term exceeds this threshold, FAST Search Server 2010 for SharePoint retries the query with a higher full text index importance level until it can find a level where the query term is not a stop word (see Set-FASTSearchMetadataFullTextIndexMapping for details about importance levels). - -If this is not possible, the query term is not included in the result set's relevancy. -A low StopWordThreshold value gives better search performance, but a lower result set relevancy (since there is a bigger chance that a query term does not influence which items are in the result set). - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchMetadataRankProfile](New-FASTSearchMetadataRankProfile.md) - -[Remove-FASTSearchMetadataRankProfile](Remove-FASTSearchMetadataRankProfile.md) - -[Get-FASTSearchMetadataRankProfile](Get-FASTSearchMetadataRankProfile.md) - -[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityCCTKServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityCCTKServer.md deleted file mode 100644 index 0cbf5e6646..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityCCTKServer.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityCCTKServer ---- - -# Set-FASTSearchSecurityCCTKServer - -## SYNOPSIS -Updates the CCTK server general setting. - -## SYNTAX - -``` -Set-FASTSearchSecurityCCTKServer [[-Port] <Int32>] [[-Enable] <Boolean>] - [[-GeneralSetting] <CCTKServerSetting>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the configuration information for the Content Connector Toolkit (CCTK) server general settings. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1---------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityCCTKServer -Port 13271 -Enable $true -``` - -This example updates the CCTK server port number and enables the CCTK server to accept requests. - -## PARAMETERS - -### -Port -The port number that the security manager listens to for handling CCTK requests. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -A Boolean flag to determine if the CCTK service will accept requests. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeneralSetting -A CCTKServerSetting instance whose property values are used for the CCTKServerSetting being updated. - -```yaml -Type: CCTKServerSetting -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityCCTKServer](Get-FASTSearchSecurityCCTKServer.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityClaimsUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityClaimsUserStore.md deleted file mode 100644 index 1fa2bfbb1a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityClaimsUserStore.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityClaimsUserStore ---- - -# Set-FASTSearchSecurityClaimsUserStore - -## SYNOPSIS -Updates a claims user store. - -## SYNTAX - -``` -Set-FASTSearchSecurityClaimsUserStore [-Identity] <String> [[-SecurityContent] <ClaimsUserStore>] - [[-Description] <String>] [[-Issuer] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the configuration settings for a claims user store. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityClaimsUserStore -Identity clm -Description "Sharepoint Users" -``` - -This example updates the description of the "clm" claims user store. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityClaimsUserStore -Identity cl2 | Set-FASTSearchSecurityClaimsUserStore -Issuer Windows -``` - -This example sets the issuer of the "cl2" claims user store to "Windows". -The Set-FASTSearchSecurityClaimsUserStore cmdlet updates the SecurityContent value piped from the Get-FASTSearchSecurityClaimsUserStore. - -## PARAMETERS - -### -Identity -The user store identity. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityContent -A claims user store object whose property values are used to update another claims user store. - -```yaml -Type: ClaimsUserStore -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Description -A brief explanation of the user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Issuer -The Microsoft SharePoint Server Security Token Service (STS) claims provider that issued the claims. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityClaimsUserStore](Get-FASTSearchSecurityClaimsUserStore.md) - -[New-FASTSearchSecurityClaimsUserStore](New-FASTSearchSecurityClaimsUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityDefaultUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityDefaultUserStore.md deleted file mode 100644 index 14372fffe2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityDefaultUserStore.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityDefaultUserStore ---- - -# Set-FASTSearchSecurityDefaultUserStore - -## SYNOPSIS -Updates the default user store general setting. - -## SYNTAX - -### ProcessId -``` -Set-FASTSearchSecurityDefaultUserStore [[-DefaultUserStoreId] <String>] [<CommonParameters>] -``` - -### ProcessGeneralSetting -``` -Set-FASTSearchSecurityDefaultUserStore [[-GeneralSetting] <DefaultUserStoreSetting>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the identity of the user store that users and groups are looked up in, to determine the appropriate document access if the user store identity is not specified when looking up the user or group. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityDefaultUserStore -DefaultUserStoreId win -``` - -This example sets the default user store to "win". - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$defuserstore | Set-FASTSearchSecurityDefaultUserStore -``` - -This example updates the default user store using values from a pipeline GeneralSetting parameter. - -In this example, the $defuserstoreGeneralSetting was created with this command: $defuserstore = Get-FASTSearchSecurityDefaultUserStore. - -## PARAMETERS - -### -DefaultUserStoreId -The identity of the user store to set as the default user store. - -```yaml -Type: String -Parameter Sets: ProcessId -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeneralSetting -A DefaultUserStoreSettinginstance whose property values are used for the DefaultUserStoreSetting being updated. - -```yaml -Type: DefaultUserStoreSetting -Parameter Sets: ProcessGeneralSetting -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityDefaultUserStore](Get-FASTSearchSecurityDefaultUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityLogLevel.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityLogLevel.md deleted file mode 100644 index 7246402444..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityLogLevel.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityLogLevel ---- - -# Set-FASTSearchSecurityLogLevel - -## SYNOPSIS -Updates the log level general setting. - -## SYNTAX - -``` -Set-FASTSearchSecurityLogLevel [[-GeneralSetting] <LogLevelSetting>] [-DebugNameSpaceLogLevel <String[]>] - [-DefaultLogLevel <String>] [-ErrorNameSpaceLogLevel <String[]>] [-IncludeExceptionStack <Boolean>] - [-InfoNameSpaceLogLevel <String[]>] [-WarningNameSpaceLogLevel <String[]>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the configuration information for the log level's general setting. -The log level controls the type of information that is logged by the security system. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityLogLevel -DefaultLogLevel debug -IncludeExceptionStack $True -``` - -This example sets the default log level to the "Debug" level and enables the setting to include the exception stack in the log. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityLogLevel -WarningNameSpaceLogLevel Microsoft -``` - -This example sets the log level setting for the "Microsoft" namespace to the "Warning" level. - -## PARAMETERS - -### -GeneralSetting -A LogLevelSetting whose property values are used for the LogLevelSetting being updated. - -```yaml -Type: LogLevelSetting -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DebugNameSpaceLogLevel -A list of C# namespaces. -Any class contained in that namespace logs all messages to the log. - -A class can occur in only one namespace. -If you specify the same class in more than one name space log level, the log level that generates the most messages will be set. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultLogLevel -Specifies the type of log messages that each class writes to the log, unless the class is contained in a namespace explicitly specified in ErrorLogLevelNameSpaces, WarningLogLevelNameSpaces, InfoLogLevelNameSpaces, and DebugLogLevelNameSpaces. - -Valid values are: - --- Error --- Warning --- Info --- Debug - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ErrorNameSpaceLogLevel -A list of C# namespaces. -Any class included in the namespace only logs error messages. - -A class can occur in only one namespace. -If you specify the same class in more than one namespace log level, the log level that generates the most messages will be set. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeExceptionStack -Whether or not to include the exception stack in the log. -Set to $True to include the exception stack. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InfoNameSpaceLogLevel -A list of C# namespaces. -Any class contained in that namespace only logs error, warning, and info messages. - -A class can occur in only one namespace. -If you specify the same class in more than one namespace log level, the log level that generates the most messages will be set. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WarningNameSpaceLogLevel -A list of C# namespaces. -Any class included in the namespace only logs error and warning messages. - -A class can occur in only one namespace. -If you specify the same class in more one than namespace log level, the log level that generates the most messages will be set. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityLogLevel](Get-FASTSearchSecurityLogLevel.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityLotusNotesUserStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityLotusNotesUserStore.md deleted file mode 100644 index a68e1084d7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityLotusNotesUserStore.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityLotusNotesUserStore ---- - -# Set-FASTSearchSecurityLotusNotesUserStore - -## SYNOPSIS -Updates a Lotus Notes user store. - -## SYNTAX - -``` -Set-FASTSearchSecurityLotusNotesUserStore [-Identity] <String> [[-SecurityContent] <LotusNotesUserStore>] - [[-NonIndexableCharacterEncodingPrefix] <String>] [[-NonIndexableCharacterPattern] <String>] - [[-Description] <String>] [[-UseDenyOnDefault] <Boolean>] [[-UseDocumentSecurity] <Boolean>] - [[-UseWildcardSecurity] <Boolean>] [[-UseViewSecurity] <Boolean>] [[-AllowPrefix] <String>] - [[-DenyPrefix] <String>] [[-NonIndexableCharacterHandling] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the configuration settings for a Lotus Notes user store. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityLotusNotesUserStore -Identity ln4 -Description "My Lotus user store" -``` - -This example updates the description of the "ln4" Lotus Notes user store. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityLotusNotesUserStore -Identity ln3 | Set-FASTSearchSecurityLotusNotesUserStore -UseDocumentSecurity $false -``` - -This example sets the UseDocumentSecurity of the "ln3" Lotus Notes user store to false to skip item level security. - -In this case, only database level security is used. -The Set-FASTSearchSecurityLotusNotesUserStore command updates the SecurityContent object piped from the Get-FASTSearchSecurityLotusNotesUserStore. - -## PARAMETERS - -### -Identity -Identity of the Lotus Notes user store to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityContent -A Lotus Notes user store object whose property values are used for the Lotus Notes user store being updated. - -```yaml -Type: LotusNotesUserStore -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Description -A brief explanation of the user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDenyOnDefault -If true, support for default access with deny on users/groups is enabled on database level security. - -You must enable this filter for an inverse security model: first grant access to everyone, and then explicitly deny access to certain groups or users. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDocumentSecurity -If true, item security is enabled (i.e., the filter contains a item level security condition). - -If set to false, item level security is ignored; only database level security (and possibly view security) is used. - -If items always inherit the ACLs of the database, you can turn off this option. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseWildcardSecurity -If true, database access through wildcard group entry (starting with */) is enabled. - -If set to false, the wildcard check is ignored. -Only normal groups are checked against the database ACL. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseViewSecurity -If true, view security is enabled (i.e., the filter contains a view level security condition). - -If set to false, view level security is ignored; only database level security (and possibly item security) is used. - -If views always inherit the ACLs of the database, or if views are not indexed, you can turn off this option. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrefix -A string value prepended to the document ACL to control which items the user is allowed access to and which items will be returned in the query. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyPrefix -A string value prepended to the ACL to control which items the user is denied access to and which items are not returned from the query. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonIndexableCharacterHandling -Specifies what to do with ACL values that match the NonIndexableCharacterRegExPattern regular expression. - -Valid values: - --- encode - The ACL is encoded into a single searchable term. --- encodeWithPrefix - The value of NonIndexableEncodedPrefix is concatenated with the ACL to be encoded, producing a single searchable term. --- remove - The ACL is removed from both allowing and denying access. Specify "remove" if the ACL is never used to deny access. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonIndexableCharacterEncodingPrefix -If NonIndexableCharacterHandling is set to encodeWithPrefix, this parameter specifies the prefix added to the encoded ACL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonIndexableCharacterPattern -Specifies a regular expression pattern used to detect non-indexable characters in an ACL. -Identities matching this regular expression pattern will be processed based on NonIndexableCharacterHandling. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityLotusNotesUserStore](Get-FASTSearchSecurityLotusNotesUserStore.md) - -[New-FASTSearchSecurityLotusNotesUserStore](New-FASTSearchSecurityLotusNotesUserStore.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityPublicFilter.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityPublicFilter.md deleted file mode 100644 index ed05b56a8f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityPublicFilter.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityPublicFilter ---- - -# Set-FASTSearchSecurityPublicFilter - -## SYNOPSIS -Updates the public filter general setting. - -## SYNTAX - -### ProcessFilter -``` -Set-FASTSearchSecurityPublicFilter [[-Filter] <String>] [<CommonParameters>] -``` - -### ProcessPipelineSetting -``` -Set-FASTSearchSecurityPublicFilter [[-GeneralSetting] <PublicFilterSetting>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the public filter general setting configuration. -The public filter is the search security filter that is used to find documents that all users have access to. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityPublicFilter -Filter docacl:unknown -``` - -This example updates the search security filter that is used to find documents that all users have access to. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -C:\PS>$pubfilter | Set-FASTSearchSecurityPublicFilter -``` - -This example updates the public filter setting using values from a pipeline GeneralSetting parameter. - -In this example, the $pubfilterGeneralSetting was created with this command: $pubfilter = Get-FASTSearchSecurityPublicFilter. - -## PARAMETERS - -### -Filter -The search security filter that is used to find documents that all users have access to. - -```yaml -Type: String -Parameter Sets: ProcessFilter -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeneralSetting -A PublicFilterSetting whose property values are used for the PublicFilterSetting being updated. - -```yaml -Type: PublicFilterSetting -Parameter Sets: ProcessPipelineSetting -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: 9999 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FASTSearchSecurityPublicFilter](Get-FASTSearchSecurityPublicFilter.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityRegexAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityRegexAliaser.md deleted file mode 100644 index ba618d4b9e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityRegexAliaser.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityRegexAliaser ---- - -# Set-FASTSearchSecurityRegexAliaser - -## SYNOPSIS -Updates a regular expression aliaser. - -## SYNTAX - -``` -Set-FASTSearchSecurityRegexAliaser [-Identity] <String> [-CaseSensitive <Boolean>] [-InputUserStoreId <String>] - [-OutputUserStoreIds <String[]>] - [-Patterns <System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig]>] - [-RegexAliaser <SecurityRegexAliaser>] [-UnicodeCaseSensitive <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the configuration settings for a regular expression aliaser to map users/groups from one user store to users/groups in other user stores, based on a regular expression pattern. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityRegexAliaser -Identity regex1 -OutputUserStoreIds ln2, ln3 -``` - -This example modifies the output user store ids for the "regex1" regular expression aliaser. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>New-FASTSearchSecurityRegexAliaserPattern -Regex .* -InputPropertyName mail -MapToUsername "\1" | Set-FASTSearchSecurityRegexAliaser -Identity regexalias1 -``` - -This example sets the regular expression pattern for the Regex Aliaser "regexalias1". -The regular expression pattern can be used to map the "mail" property of a Microsoft user store to identities in other user stores. - -## PARAMETERS - -### -Identity -The identity of the aliaser to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaseSensitive -Specifies whether the regular expressions patterns defined in the RegExAliasPatternMapConfig list are matched based on case sensitivity matching rules. -The default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputUserStoreId -The identity of the mapped-from user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputUserStoreIds -A comma-separated list of mapped-to user store identities. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Patterns -List of RegExAliasPatternMapConfig instances containing the regular expression patterns using for the mapping. - -Use the New-RegExAliasPatternMapConfig cmdlet to create patterns. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RegexAliaser -A SecurityRegexAliaser object whose property values are used for the SecurityRegexAliaser aliaser being created. - -```yaml -Type: SecurityRegexAliaser -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UnicodeCaseSensitive -Specifies whether the regular expressions patterns defined in the RegExAliasPatternMapConfig list are matched based on Unicode case sensitivity matching rules. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSecurityRegexAliaser](New-FASTSearchSecurityRegexAliaser.md) - -[Get-FASTSearchSecurityRegexAliaser](Get-FASTSearchSecurityRegexAliaser.md) - -[New-FASTSearchSecurityRegexAliaserPattern](New-FASTSearchSecurityRegexAliaserPattern.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityXMLAliaser.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityXMLAliaser.md deleted file mode 100644 index ac0e49ccd5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-FASTSearchSecurityXMLAliaser.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Set-FASTSearchSecurityXMLAliaser ---- - -# Set-FASTSearchSecurityXMLAliaser - -## SYNOPSIS -Updates an XML aliaser. - -## SYNTAX - -``` -Set-FASTSearchSecurityXMLAliaser -Identity <String> [-InputPropertyName <String>] [-InputUserStoreId <String>] - [-OutputUserStoreIds <String[]>] [-PathToXMLFile <String>] [-XMLAliaser <SecurityXMLAliaser>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the configuration settings for an XML principal aliaser. - -An XML aliaser maps users/groups from one user store to users/groups in other user stores, based on an XML mapping file. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Set-FASTSearchSecurityXMLAliaser -Identity xmlalias1 -PathToXMLFile "C:\dev\temp\mapping1.xml" -``` - -This example uploads and updates the XML mapping for an XML aliaser. - -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Get-FASTSearchSecurityAliaser myxmlalias | Set-FASTSearchSecurityXMLAliaser -OutputUserStoreIds ln2 -InputPropertyName '$PRINCIPAL_REFERENCE_ALIAS' -``` - -This example changes the OutputUserStoreIds and InputPropertyName for the XML aliaser piped from a Get-FASTSearchSecurityAliaser cmdlet. - -## PARAMETERS - -### -Identity -The identity of the XML aliaser to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputPropertyName -The user/group property name this regular expression pattern is matched again. - -The inputPropertyName is one of the following: - --- $PRINCIPAL_REFERENCE_ID - The identifier of the user or group. This is the default. - -Be sure to enclose in single quotes: '$PRINCIPAL_REFERENCE_ID' - --- $PRINCIPAL_REFERENCE_ALIAS - The alias of the user or group. - -Be sure to enclose in single quotes: '$PRINCIPAL_REFERENCE_NAME' - -Any other property of the user or group. -Refer to your specific user store for other properties that the user store exposes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputUserStoreId -The identity of the mapped-from user store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputUserStoreIds -A comma-separated list of mapped-to user store identities. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathToXMLFile -The absolute path to the XML mapping file to upload to the XML aliaser. - -The path must specify a file accessible to the security manager. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XMLAliaser -A SecurityXMLAliaserobject whose property values are being updated. - -```yaml -Type: SecurityXMLAliaser -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FASTSearchSecurityXMLAliaser](New-FASTSearchSecurityXMLAliaser.md) - -[Get-FASTSearchSecurityXMLAliaser](Get-FASTSearchSecurityXMLAliaser.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServiceApplication.md deleted file mode 100644 index 012232a7e8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServiceApplication.md +++ /dev/null @@ -1,450 +0,0 @@ ---- -external help file: microsoft.office.access.services.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAccessServiceApplication -schema: 2.0.0 ---- - -# Set-SPAccessServiceApplication - -## SYNOPSIS -Sets global properties of an existing Access Services application in SharePoint Server. - - -## SYNTAX - -``` -Set-SPAccessServiceApplication [-Identity] <SPAccessServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-ColumnsMax <Int32>] [-Confirm] - [-NonRemotableQueriesAllowed] [-OrderByMax <Int32>] [-OuterJoinsAllowed] [-OutputCalculatedColumnsMax <Int32>] - [-PrivateBytesMax <Int32>] [-RecordsInTableMax <Int32>] [-RequestDurationMax <Int32>] [-RowsMax <Int32>] - [-SessionMemoryMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] [-SessionsPerUserMax <Int32>] - [-SourcesMax <Int32>] [-TemplateSizeMax <Int32>] [-WhatIf] [-ApplicationLogSizeMax <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPAccessServiceApplication` cmdlet sets the global runtime properties of an existing Access Services application in SharePoint Server. -The changes made to the properties by using this cmdlet affect all machines in the farm on which this Access Services application runs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------EXAMPLE 1------------------ -``` -PS C:\>Set-SPAccessServiceApplication -identity "MyAccessService" -RequestDurationMax 100 -``` - -This example sets the Access Services application named MyAccessService to let requests take up to 100 seconds before they time out. - - -### ------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPAccessServiceApplication | Set-SPAccessServiceApplication -SessionsPerUserMax 5 -``` - -This example sets every Access Services application in the farm to allow up to five sessions per user on each back-end application server computer on which Access Services runs. - -First, every Access Services application is retrieved and then a new value is set by using the `Set-SPAccessServiceApplication` cmdlet. - - -### ------------EXAMPLE 3------------------ -``` -PS C:\>Get-SPAccessServiceApplication | where {$_.RowsMax -gt 50000 } | Set-SPAccessServiceApplication -RowsMax 50000 -``` - -This example sets every Access Services application in the farm that allows more than 50,000 rows to be returned from, or used in, a query and then sets the service application to allow up to 50,000 rows only. - -First, every Access Services application that has more than 50,000 rows is retrieved and then a new value is set by using the `Set-SPAccessServiceApplication` cmdlet. - - -## PARAMETERS - -### -Identity -Specifies the Access Services application to update. - -The type must be a valid name of an Access Services application; for example, AccessSrvApp1; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPAccessServiceApplication object. - -```yaml -Type: SPAccessServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheTimeout -Specifies the number of seconds that a data cache will remain active on Access services with no user activity. -Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days. - -The type must be the integers -1, or an integer in the range of 1 to 2073600 (24 days). -The default value is 300. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ColumnsMax -Specifies the maximum number of columns that a list involved in a query can contain, or that the output of the query can contain. -The default value is 30. - -The type must be an integer in the range of 1 to 255. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonRemotableQueriesAllowed -Specifies that queries that cannot be sent remotely to the database tier can run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrderByMax -Specifies the maximum number of Order By clauses in the query. -The default value is 4. - -The type must be an integer in the range of 1 to 8. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OuterJoinsAllowed -Specifies that left and right outer joins are supported. -Inner joins are always supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputCalculatedColumnsMax -Specifies the maximum number of calculated columns that can be included in the output as a part of the query. -Calculated columns in the underlying SharePoint list are not included. -The default value is 10. - -The type must be an integer in the range of 1 to 32. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBytesMax -Specifies the maximum private bytes in megabytes that can be used by Access Services. -When set to -1 it defaults to 75 percent of physical memory on the machine. -Valid values: -1, no limit, from 1 to any positive integer.The default value is -1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordsInTableMax -Specifies the maximum number of records allowed for a table in the Access Services application. -Valid values include: -1, no limit, and 1 to any positive integer. -The default value is 500000. - -The type must be the integer -1, or an integer in the range of 1 to MaxInt. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestDurationMax -Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. -Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. -The default value is 30. - -The type must be the integer -1, or an integer in the range of 1 to 2073600 (24 days) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RowsMax -Specifies the maximum number of rows that a list involved in a query can have, or that the output of the query can have. -The default value is 50000. - -The type must be an integer in the range of 1 to 200000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionMemoryMax -Specifies the maximum allowable size, in megabytes, of an individual session. -Valid values include: 0, disable property, 1 to 4095. -The default value is 64. - -The type must be the integer 0, or an integer in the range of 1 to 4095. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerAnonymousUserMax -The maximum number of sessions allowed per user. -If this maximum is reached, the oldest session will be deleted when a new session is started. -Valid values include: -1, no limit, and 1 to any positive integer. -The default value is 10. - -The integer -1, or an integer in the range of 1 to MaxInt - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerUserMax -Specifies the maximum number of sessions allowed per user. -If this maximum is reached, the oldest session will be deleted when a new session is started. -Valid values include: -1, no limit, and 1 to any positive integer. -The default value is 10. - -The integer -1, or an integer in the range of 1 to MaxInt. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcesMax -Specifies the maximum number of lists that may be used as input to a query at one time. -The default value is 8. - -The type must be an integer in the range of 1 to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateSizeMax -The maximum allowable size in megabytes (MB) allowed for Access templates (.accdt files) uploaded into the solution gallery. -Valid values: -1, no limit, from 1 to any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationLogSizeMax -The maximum number of records for an Access Services Application Log list. Valid valies: -1 to maxint. A value of zero means none is allowed. The default value is 3000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesApplication.md deleted file mode 100644 index f1b9ec73c1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesApplication.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAccessServicesApplication -schema: 2.0.0 ---- - -# Set-SPAccessServicesApplication - -## SYNOPSIS -{{Fill in the Synopsis}} - - -## SYNTAX - -``` -Set-SPAccessServicesApplication [-Identity] <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-Confirm] [-PrivateBytesMax <Int32>] - [-RecoveryPointObjective <Int32>] [-RequestDurationMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] - [-SessionsPerUserMax <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheTimeout -{{Fill CacheTimeout Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -{{Fill Identity Description}} - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PrivateBytesMax -{{Fill PrivateBytesMax Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPointObjective -{{Fill RecoveryPointObjective Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestDurationMax -{{Fill RequestDurationMax Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerAnonymousUserMax -{{Fill SessionsPerAnonymousUserMax Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerUserMax -{{Fill SessionsPerUserMax Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesDatabaseServer.md deleted file mode 100644 index 060b293a42..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesDatabaseServer.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAccessServicesDatabaseServer -schema: 2.0.0 ---- - -# Set-SPAccessServicesDatabaseServer - -## SYNOPSIS -{{Fill in the Synopsis}} - - -## SYNTAX - -### SetAvailableForCreateParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] -AvailableForCreate <Boolean> [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [-Exclusive <Boolean>] [-WhatIf] - [<CommonParameters>] -``` - -### SetCredentialsParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> [-DatabaseServerCredentials <PSCredential>] - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [-DatabaseServerName <String>] [-WhatIf] - [<CommonParameters>] -``` - -### SetEncryptParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> -Encrypt <Boolean> - -TrustServerCertificate <Boolean> [-WhatIf] [<CommonParameters>] -``` - -### SetFailoverParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> -Failover <Boolean> [-WhatIf] - [<CommonParameters>] -``` - -### SetSecondaryDatabaseServerNameParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [-SecondaryDatabaseServerName <String>] - [-WhatIf] [<CommonParameters>] -``` - -### SetUserDomainParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> -UserDomain <String> [-WhatIf] - [<CommonParameters>] -``` - -### SetServerStateParameterSet -``` -Set-SPAccessServicesDatabaseServer [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -DatabaseServer <AccessServicesDatabaseServerPipeBind> - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> -State <DatabaseServerStates> - -StateOwner <ServerStateOwner> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AvailableForCreate -{{Fill AvailableForCreate Description}} - -```yaml -Type: Boolean -Parameter Sets: SetAvailableForCreateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -{{Fill DatabaseServer Description}} - -```yaml -Type: AccessServicesDatabaseServerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerCredentials -{{Fill DatabaseServerCredentials Description}} - -```yaml -Type: PSCredential -Parameter Sets: SetCredentialsParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerGroup -{{Fill DatabaseServerGroup Description}} - -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerName -{{Fill DatabaseServerName Description}} - -```yaml -Type: String -Parameter Sets: SetCredentialsParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encrypt -{{Fill Encrypt Description}} - -```yaml -Type: Boolean -Parameter Sets: SetEncryptParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exclusive -{{Fill Exclusive Description}} - -```yaml -Type: Boolean -Parameter Sets: SetAvailableForCreateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Failover -{{Fill Failover Description}} - -```yaml -Type: Boolean -Parameter Sets: SetFailoverParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryDatabaseServerName -{{Fill SecondaryDatabaseServerName Description}} - -```yaml -Type: String -Parameter Sets: SetSecondaryDatabaseServerNameParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -{{Fill ServiceContext Description}} - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TrustServerCertificate -{{Fill TrustServerCertificate Description}} - -```yaml -Type: Boolean -Parameter Sets: SetEncryptParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserDomain -{{Fill UserDomain Description}} - -```yaml -Type: String -Parameter Sets: SetUserDomainParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -{{Fill State Description}} - -```yaml -Type: DatabaseServerStates -Parameter Sets: SetServerStateParameterSet -Aliases: -Accepted values: Active, Locked, Reserved -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOwner -{{Fill StateOwner Description}} - -```yaml -Type: ServerStateOwner -Parameter Sets: SetServerStateParameterSet -Aliases: -Accepted values: NoOwner, TenantMove -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesDatabaseServerGroupMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesDatabaseServerGroupMapping.md deleted file mode 100644 index 8f95d99925..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAccessServicesDatabaseServerGroupMapping.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: microsoft.office.access.server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAccessServicesDatabaseServerGroupMapping -schema: 2.0.0 ---- - -# Set-SPAccessServicesDatabaseServerGroupMapping - -## SYNOPSIS -{{Fill in the Synopsis}} - - -## SYNTAX - -### ClearDatabaseServerGroupMappingParameterSetName -``` -Set-SPAccessServicesDatabaseServerGroupMapping [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-ClearMapping] [-Confirm] [-CorporateCatalog] - [-DeveloperSite] [-ObjectModel] [-RemoteObjectModel] [-StoreFront] [-WhatIf] [<CommonParameters>] -``` - -### SetDatabaseServerGroupMappingParameter -``` -Set-SPAccessServicesDatabaseServerGroupMapping [-ServiceContext] <SPServiceContextPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-CorporateCatalog] - -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [-DeveloperSite] [-ObjectModel] - [-RemoteObjectModel] [-StoreFront] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClearMapping -{{Fill ClearMapping Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: ClearDatabaseServerGroupMappingParameterSetName -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CorporateCatalog -{{Fill CorporateCatalog Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServerGroup -{{Fill DatabaseServerGroup Description}} - -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: SetDatabaseServerGroupMappingParameter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeveloperSite -{{Fill DeveloperSite Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectModel -{{Fill ObjectModel Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteObjectModel -{{Fill RemoteObjectModel Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -{{Fill ServiceContext Description}} - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StoreFront -{{Fill StoreFront Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceContextPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAlternateURL.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAlternateURL.md deleted file mode 100644 index 496339ca03..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAlternateURL.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAlternateURL -schema: 2.0.0 ---- - -# Set-SPAlternateURL - -## SYNOPSIS -Configures the specified alternate URL. - - -## SYNTAX - -``` -Set-SPAlternateURL [-Identity] <SPAlternateUrlPipeBind> [-Url <String>] [-Zone <SPUrlZone>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPAlternateUrl` cmdlet changes the URL or zone of the alternate URL specified by the Identity parameter. -This cmdlet can be used to change only the zone of internal URLs and cannot be used to change the zone of public URLs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Set-SPAlternateURL -Identity https://www.contoso.com -Zone "Internet" -``` - -This example changes the zone of the alternate URL https://www.contoso.com. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Set-SPAlternateURL -Identity https://www.contoso.com -Url https://sharepoint.contoso.com -Zone "Default" -``` - -This example changes the URL and zone of the alternate URL https://www.contoso.com. - - -### ------------------EXAMPLE 3------------------ -``` -PS C:\>Get-SPAlternateURL https://www.contoso.com | Set-SPAlternateURL -Zone "Internet" -``` - -This example changes the zone of the alternate URL https://www.contoso.com. - - -### ------------------EXAMPLE 4------------------ -``` -PS C:\>Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Set-SPAlternateURL -Zone "Intranet" -``` - -This example changes the zone of the alternate URL for the specified Web application from Extranet to Intranet. - - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the alternate URL to change. - -The type must be a valid URL, in the form http://server_name/WebApplication/site, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPAlternateUrlPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Specifies the new alternate URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -Sets the supplied alternate URL as one of the five zones. - -The type must be any one of the following values: Default, Intranet, Internet, Extranet, or Custom. - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppAcquisitionConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppAcquisitionConfiguration.md deleted file mode 100644 index 027c7edc05..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppAcquisitionConfiguration.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppAcquisitionConfiguration -schema: 2.0.0 ---- - -# Set-SPAppAcquisitionConfiguration - -## SYNOPSIS -Sets app acquisition settings. - -## SYNTAX - -### MarketplaceSettingsInSiteSubscription -``` -Set-SPAppAcquisitionConfiguration -Enable <Boolean> -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### MarketplaceSettingsInWebApplication -``` -Set-SPAppAcquisitionConfiguration -Enable <Boolean> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -WebApplication <SPWebApplicationPipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the Set-SPAppAcquisitionConfiguration cmdlet to set app acquisition settings from the SharePoint Store or App Catalog. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SPAppAcquisitionConfiguration -WebApplication http://localhost -Enable:$false -``` - -This example disabled app purchases for the specified Web Application. - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Set-SPAppAcquisitionConfiguration -SiteSubscription http://localhost/sites/SharePointOnlineAdmin1 -Enable:$false -``` - -This example disables app purchases for the specified tenant. - - -## PARAMETERS - -### -Enable -Specifies whether acquisition is enabled or disabled. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site collection for which to set app acquisition settings. - - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: MarketplaceSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the web application for which acquisitions settings are to be set. - - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: MarketplaceSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -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 -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPWebApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPAppAcquisitionConfiguration](Get-SPAppAcquisitionConfiguration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppAutoProvisionConnection.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppAutoProvisionConnection.md deleted file mode 100644 index e1886217ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppAutoProvisionConnection.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppAutoProvisionConnection -schema: 2.0.0 ---- - -# Set-SPAppAutoProvisionConnection - -## SYNOPSIS -Sets provision connection settings for an app. - - -## SYNTAX - -### WebHostEndPoint -``` -Set-SPAppAutoProvisionConnection -ConnectionType <ConnectionTypes> -EndPoint <String> - [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [<CommonParameters>] -``` - -### WebHostSetup -``` -Set-SPAppAutoProvisionConnection -ConnectionType <ConnectionTypes> -EndPoint <String> -Password <String> - -Username <String> [-AssignmentCollection <SPAssignmentCollection>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -### WebHostCredential -``` -Set-SPAppAutoProvisionConnection -ConnectionType <ConnectionTypes> -Password <String> -Username <String> - [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [<CommonParameters>] -``` - -### Remove -``` -Set-SPAppAutoProvisionConnection [-Remove] [-AssignmentCollection <SPAssignmentCollection>] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPAppAutoProvisionConnection` cmdlet to set provision connection settings for a specified app. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SpAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username <username> -``` - -This example configures remote web host to be used provision apps that use this functionality for the default site subscription server on http://SPremotewebhost. - - -### --------------------EXAMPLE 2--------------------- -``` -C:\PS>$subscription = Get-SPSiteSubscription http://Contoso.com - -PS C:\>Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username <username> -SiteSubscription $subscription -``` - -This example configures remote web host to be used provision apps that use this functionality for the site subscription of Contoso.com site to server on http://SPremotewebhost. - - -### --------------------EXAMPLE 3--------------------- -``` -PS C:\>Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -``` - -This example updates the endpoint of the already configured remote web host server https://SPRemotewebhost for the default site subscription. - - -### --------------------EXAMPLE 4--------------------- -``` -PS C:\>Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -Remove -``` - -This example removes the remote web host configuration for the default site subscription. - - -## PARAMETERS - -### -ConnectionType -Specifies the connection type to provision. - -```yaml -Type: ConnectionTypes -Parameter Sets: WebHostEndPoint, WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndPoint -Specifies the end point of the provision connection. - -```yaml -Type: String -Parameter Sets: WebHostEndPoint, WebHostSetup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password for the provision connection. - -```yaml -Type: String -Parameter Sets: WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Removes the auto provision connection of the app. - -```yaml -Type: SwitchParameter -Parameter Sets: Remove -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Username -Specifies the user name of the connection. - -```yaml -Type: String -Parameter Sets: WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the site collection for which the provision connection is to be associated. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppAutoProvisionConnection](Get-SPAppAutoProvisionConnection.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppDisablingConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppDisablingConfiguration.md deleted file mode 100644 index a8a45ab64d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppDisablingConfiguration.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppDisablingConfiguration -schema: 2.0.0 ---- - -# Set-SPAppDisablingConfiguration - -## SYNOPSIS -Sets the disable list sync state for an app. - - -## SYNTAX - -``` -Set-SPAppDisablingConfiguration -Enable <Boolean> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPAppDisablingConfiguration cmdlet to set the disabled sync list state for an app . - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPAppDisablingConfiguration -``` - -This example sets the disable sync state for apps. - - -## PARAMETERS - -### -Enable -Specifies whether to enable or disable an entry from the list. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPAppDisablingConfiguration](Get-SPAppDisablingConfiguration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppDomain.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppDomain.md deleted file mode 100644 index a59069f4f3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppDomain.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppDomain -schema: 2.0.0 ---- - -# Set-SPAppDomain - -## SYNOPSIS -Sets the domain used to host apps. - - -## SYNTAX - -``` -Set-SPAppDomain [-AppDomain] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAppDomain` cmdlet to set the domain used to host apps in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPAppDomain -Domain apps.contoso.com -``` - -This example sets the app domain to apps.contoso.com. -All apps in the farm will be hosted in the apps.contoso.com domain. - - -## PARAMETERS - -### -AppDomain -Specifies the domain to be used for apps. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppDomain](Get-SPAppDomain.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppHostingQuotaConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppHostingQuotaConfiguration.md deleted file mode 100644 index 744c657926..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppHostingQuotaConfiguration.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppHostingQuotaConfiguration -schema: 2.0.0 ---- - -# Set-SPAppHostingQuotaConfiguration - -## SYNOPSIS -Sets hosting quotas for an app. - - -## SYNTAX - -``` -Set-SPAppHostingQuotaConfiguration -AppHostingLicenseQuota <Double> -AppInstanceCountQuota <Double> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - -SiteSubscription <SPSiteSubscriptionPipeBind> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPAppHostingQuotaConfiguration cmdlet to set hosting quotas for a specified app by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### ----------------EXAMPLE 1---------- -``` -PS C:\>Set-SPAppHostingQuotaConfiguration -Identity 586d4a32-98c3-42ce-80be-3c76c10c250c -AppInstanceCountQuota 50 -AppHostingLicenseQuota 25 -``` - -This example sets hosting Quotas for the SiteSubscriptionId "586d4a32-98c3-42ce-80be-3c76c10c250c" with hosted appinstance limit as 50 and hosted apps licenses assigned as 25. - - -### ----------------EXAMPLE 2---------- -``` -PS C:\>Get-SPSiteSubscription | Set-SPAppHostingQuotaConfiguration -Identity $_ -AppInstanceCountQuota 50 -AppHostingLicenseQuota 25 -``` - -This example sets hosting Quotas for all SiteSubscriptions in the farm with hosted apps limit as 50 and hosted apps licenses assigned as 25. - - -## PARAMETERS - -### -AppHostingLicenseQuota -Specifies the app licensing quota. - - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppInstanceCountQuota -Specifies the number instances of an app. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the Site Subscription. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -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 - -### Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPAppHostingQuotaConfiguration](Get-SPAppHostingQuotaConfiguration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppManagementDeploymentId.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppManagementDeploymentId.md deleted file mode 100644 index 7fcf13a6ee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppManagementDeploymentId.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppManagementDeploymentId -schema: 2.0.0 ---- - -# Set-SPAppManagementDeploymentId - -## SYNOPSIS -Sets the identifier of the farm or tenant used by the Office Marketplace to issue App licenses. - - -## SYNTAX - -``` -Set-SPAppManagementDeploymentId -AppManagementServiceApplication <AppManagementServiceApplication> - -DeploymentId <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Identity <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAppManagementDeploymentId` cmdlet to set the identifier of the farm or tenant used by the Office Marketplace to issue App Licenses. -To ensure you do not lose rights to the use of all Apps you have purchased on the Marketplace, do not change the deployment id unless directed by Microsoft documentation or support. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------EXAMPLE 1---------- -``` -PS C:\>$sa = Get-SPServiceApplication | where {$_.TypeName -eq "App Management Service Application"} -PS C:\>Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24BF2 -AppManagementServiceApplication $sa -``` - -This example sets the deployment identifier of the current farm to 3102B7C3-1866-48EE-91CB-84E20AD24BF2. - - -### -----------EXAMPLE 2---------- -``` -PS C:\>$sa = Get-SPServiceApplication | where {$_.TypeName -eq "App Management Service Application"} -PS C:\>Get-SPSiteSubscription | where{$_.Id -eq "88f16a50-0530-4f3f-b749-24ef0b30d685"} | Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24BF2 -AppManagementServiceApplication $sa -``` - -This example sets the deployment identifier of the tenant with the site subscription identifier 88f16a50-0530-4f3f-b749-24ef0b30d685 to 3102B7C3-1866-48EE-91CB-84E20AD24BF2. - - -## PARAMETERS - -### -AppManagementServiceApplication -Specifies the app management service application object that is running on the farm. - -```yaml -Type: AppManagementServiceApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentId -Specifies the deployment identifier value for the tenant. -This parameter works in conjunction with the value that is defined with Identity parameter. -If Identity parameter is omitted, then it is assumed that this deployment identifier value belongs to the farm. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Identifies the site subscription object representing the tenant to which the DeploymentId parameter is to be assigned. -If the Identity parameter is omitted, it is assumed that the deployment identifier belongs to the farm. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: Subscription -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppPrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppPrincipalPermission.md deleted file mode 100644 index 1355752ab6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppPrincipalPermission.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppPrincipalPermission -schema: 2.0.0 ---- - -# Set-SPAppPrincipalPermission - -## SYNOPSIS -Sets the permissions on a given app principal. - - -## SYNTAX - -``` -Set-SPAppPrincipalPermission -AppPrincipal <SPAppPrincipal> -Right <SPCmdletAppPrincipalPermissionKind> - -Scope <SPCmdletAppPrincipalPermissionScope> -Site <SPWebPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [-EnableAppOnlyPolicy] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAppPrincipalPermission` cmdlet to set the permissions on a given app principal for a given scope (tenant, site collection, and web) and given levels (Read, Write, Manage, Full Control). - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------EXAMPLE------------- -``` -PS C:\>$clientID = "11111111-2222-3333-4444-555555555555" -PS C:\>$site = Get-SPSite http://siteUrl -PS C:\>$realm = Get-SPAuthenticationRealm -ServiceContext $site -PS C:\>$appIdentifier = $clientID + "@" + $realm -PS C:\>$appPrincipal = Get-SPAppPrincipal -NameIdentifier $appIdentifier -Web $site.RootWeb -PS C:\>Set-AppPrincipalPermission -AppPrincipal $appPrincipal -Site $site.RootWeb -Scope Site -Level Manage -``` - -This example sets the App Principal permission to Manage with a scope of Site. - -## PARAMETERS - -### -AppPrincipal -Specifies the AppPrincipal object. - -```yaml -Type: SPAppPrincipal -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Right -Specifies the permission level for the principal object. - -The value is any of the following levels: - ---Read - ---Write - ---Manage - ---Full Control - -```yaml -Type: SPCmdletAppPrincipalPermissionKind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which to apply the principal permission. - -The value is any of the following scopes: - ---Site - ---SiteCollection - ---SiteSubscription - -```yaml -Type: SPCmdletAppPrincipalPermissionScope -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site (that is, SPWeb object) that the AppPrincipalPermission is being set.a - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAppOnlyPolicy -Specifies if the app only policy is turned on for the app principal. - -The valid values are True and False. The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPAppPrincipalPermission](Remove-SPAppPrincipalPermission.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppScaleProfile.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppScaleProfile.md deleted file mode 100644 index f4ad60b039..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppScaleProfile.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppScaleProfile -schema: 2.0.0 ---- - -# Set-SPAppScaleProfile - -## SYNOPSIS -Sets settings for the app profile. - - -## SYNTAX - -``` -Set-SPAppScaleProfile [-AssignmentCollection <SPAssignmentCollection>] [-MaxDatabaseSize <String>] - [-RemoteWebSiteInstanceCount <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAppScaleProfile` cmdlet to set settings for an app profile. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE----------- -``` -PS C:\>Set-SPAppScaleProfile -MaxDatabaseSize "2 GB" -RemoteWebSiteInstanceCount 1 -``` - -This example sets the farm level app scale profile. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaxDatabaseSize -Specifies the database size of the app profile. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteWebSiteInstanceCount -Specifies whether a remote site can access the profilefrom. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppScaleProfile](Get-SPAppScaleProfile.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppSiteDomain.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppSiteDomain.md deleted file mode 100644 index c0cc9dc914..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppSiteDomain.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppSiteDomain -schema: 2.0.0 ---- - -# Set-SPAppSiteDomain - -## SYNOPSIS -Creates or changes the URL of any installed app. - - -## SYNTAX - -``` -Set-SPAppSiteDomain -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPAppSiteDomain cmdlet to create or change the URL of any installed app by using the Site parameter to reset the subscription name and app site domain identifier. - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPAppSiteDomain -Site https://www.contoso.com -``` - -This example sets the subscription name and app site domain identifier for the https://www.contoso.com site. - - -## PARAMETERS - -### -Site -Specifies the SPSite object or the GUID of the SPSite or the URL of the SPSite. - - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppSiteSubscriptionName.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppSiteSubscriptionName.md deleted file mode 100644 index 38a40667f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppSiteSubscriptionName.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppSiteSubscriptionName -schema: 2.0.0 ---- - -# Set-SPAppSiteSubscriptionName - -## SYNOPSIS -Sets or changes the name for the specified site subscription. - - -## SYNTAX - -``` -Set-SPAppSiteSubscriptionName -Name <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Force] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAppSiteSubscriptionName` cmdlet to set or change the name for a specified site subscription by using the Name parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------EXAMPLE 1---------- -``` -PS C:\>Set-SPAppSiteSubscriptionName -Name Contoso -``` - -This example sets the name of the default site subscription to "Contoso". - - -### -----------EXAMPLE 2---------- -``` -PS C:\>Set-SPAppSiteSubscriptionName -Name Contoso -SiteSubscription https://www.contoso.com -``` - -This example changes the name of the site subscription for SPSite from https://www.contoso.com to "Contoso". - - -## PARAMETERS - -### -Name -Specifies the name for the site subscription. - -Each site subscription must have a unique name. -The name is used in part to determine the domain that apps for SharePoint are installed in for each site subscription. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The site subscription name is recorded in other databases in the SharePoint farm. -In cases such as disaster recovery or restore of the SharePoint farm, the Force parameter can be specified to ensure that the site subscription name has been propagated appropriately throughout the SharePoint farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. -If this parameter is not specified, then the default site subscription is used. -All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppSiteSubscriptionName](Get-SPAppSiteSubscriptionName.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStateUpdateInterval.md deleted file mode 100644 index b740c8ef68..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStateUpdateInterval.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppStateUpdateInterval -schema: 2.0.0 ---- - -# Set-SPAppStateUpdateInterval - -## SYNOPSIS -Sets the interval in hours between updates of the app state update job. - - -## SYNTAX - -``` -Set-SPAppStateUpdateInterval -AppStateSyncHours <Int32> -FastAppRevocationHours <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAppStateUpdateInterval` cmdlet to set the interval in hours between updates of the app state update job. -The app state update job updates the app states, including app updates, in SharePoint based on information in the SharePoint Store. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------EXAMPLE-------------- -``` -PS C:\>Set-SPAppStateUpdateInterval -AppStateSyncHours 24 -FastAppRevocationHours 6 -``` - -This example sets the app state update interval to 24 hours and the fast app revocation interval to 6 hours. - - -## PARAMETERS - -### -AppStateSyncHours -Specifies the interval in hours between updates of the app states. -Values are 1 to 24 inclusive. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FastAppRevocationHours -Specifies the interval in hours between checks of the list of revoked apps in the SharePoint Store. -If the list of revoked apps has changed from the last time, the app states are updated. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppStateUpdateInterval](Get-SPAppStateUpdateInterval.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStoreConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStoreConfiguration.md deleted file mode 100644 index e9934814c2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStoreConfiguration.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppStoreConfiguration -schema: 2.0.0 ---- - -# Set-SPAppStoreConfiguration - -## SYNOPSIS -Sets SharePoint Store settings for an app. - - -## SYNTAX - -``` -Set-SPAppStoreConfiguration [-Url <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] -Enable <Boolean> [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPAppStoreConfiguration cmdlet to set SharePoint Store settings for a specified app. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SPAppStoreConfiguration -Url http://office.microsoft.com -Enable $true -``` - -This example sets the URL to the Office.com server. - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Set-SPAppStoreConfiguration -Enable $false -``` - -This example turns off the SharePoint Store. - -### --------------------EXAMPLE 3--------------------- -``` -PS C:\>Set-SPAppStoreConfiguration -Enable $true -``` - -This example turns on the SharePoint Store. - -## PARAMETERS - -### -Url -Specifies the URL of the app for which to set SharePoint Store settings. - -The SharePoint store value should not be changed unless instructed by a Microsoft representative. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Specifies whether the Office Store services lets third- party add-ins to be found or downloaded. - -This is intended for administrators to disable discovery and downloads of third-party add-ins on their SharePoint tenants and site collections. - -The valid values are True and False. - -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPAppStoreConfiguration](Get-SPAppStoreConfiguration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStoreWebServiceConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStoreWebServiceConfiguration.md deleted file mode 100644 index 8b70a06c8d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAppStoreWebServiceConfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAppStoreWebServiceConfiguration -schema: 2.0.0 ---- - -# Set-SPAppStoreWebServiceConfiguration - -## SYNOPSIS -Sets properties of a SharePoint Store app. - - -## SYNTAX - -``` -Set-SPAppStoreWebServiceConfiguration [-AssignmentCollection <SPAssignmentCollection>] -Client <String> - [-Confirm] [-ProxyVersion <Version>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPAppStoreWebServiceConfiguration cmdlet to set the product type (On-Premises or Online) and the version used to access the SharePoint Store when SharePoint is configured to access the . - -This cmdlet is not intended for the ITPro audience. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPAppStoreWebServiceConfiguration -Client=SP -ProxyVersion=16.1 -``` - -This example set the product type and version for a SharePoint Store app. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Client -Specifies the client value of the SharePoint Store app. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyVersion -Specifies the proxy version value of the SharePoint Store app. - -```yaml -Type: Version -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPApplicationCredentialKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPApplicationCredentialKey.md deleted file mode 100644 index c9ae6c3929..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPApplicationCredentialKey.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2019 -title: Set-SPApplicationCredentialKey -schema: 2.0.0 ---- - -# Set-SPApplicationCredentialKey - -## SYNOPSIS -Sets the application credential key on the local server. - - -## SYNTAX - -``` -Set-SPApplicationCredentialKey [-Password] <SecureString> [-AssignmentCollection <SPAssignmentCollection>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - - -## DESCRIPTION -Use the **Set-SPApplicationCredentialKey** cmdlet to set the application credential key on the local server, which is used by certain features to encrypt and decrypt passwords. - -The application credential key must be identical on each server in the farm where it is set. - -## EXAMPLES - -### EXAMPLE -```powershell -PS C:\> $key = ConvertTo-SecureString -String "New Password" -AsPlainText -Force -Set-SPApplicationCredentialKey -Password $key -``` - -This example sets the application credential key on the local server to "New Password". - -## PARAMETERS - -### -Password -Specifies the application credential key. -Avoid reusing the farm passphrase or service account passwords for the application credential key. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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). - - -## RELATED LINKS -[Remove-SPApplicationCredentialKey](Remove-SPApplicationCredentialKey.md) - - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAuthenticationRealm.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAuthenticationRealm.md deleted file mode 100644 index b7f0cd2af1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPAuthenticationRealm.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPAuthenticationRealm -schema: 2.0.0 ---- - -# Set-SPAuthenticationRealm - -## SYNOPSIS -Sets the authentication realm. - - -## SYNTAX - -``` -Set-SPAuthenticationRealm [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Realm <String>] - [-ServiceContext <SPServiceContextPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPAuthenticationRealm` cmdlet to set the authentication realm at the farm or site collection level by using the Realm parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$c = Get-SPServiceContext -Site "https://<websiteurl>" -PS C:\>Set-SPAuthenticationRealm -ServiceContext $c -Realm "t686d436-9f16-42db-09b7-cb578e110ccd" -``` - -This example sets the authentication realm as specified by the realm parameter. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Realm -Specifies the realm to be set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext -Specifies the service context for which the realm needs to be set. -For example, $root.web. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAuthenticationRealm](Get-SPAuthenticationRealm.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBingMapsBlock.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBingMapsBlock.md deleted file mode 100644 index a2938db393..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBingMapsBlock.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBingMapsBlock -schema: 2.0.0 ---- - -# Set-SPBingMapsBlock - -## SYNOPSIS -Sets Bing maps to blocked status. - - -## SYNTAX - -``` -Set-SPBingMapsBlock [-BlockBingMapsInAllLocales] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPBingMapsBlock` cmdlet to specify whether to block Bing Maps in all locales, or not to block them in all locales. -Bing Maps will be displayed only in non-restricted locales if this property is not set. -The default value is 0 (not blocked). -Use a value of 1 to block in all locales. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPBingMapsBlock 1 -``` - -This example displays how to block Bing Maps in all locales for the farm. - - -## PARAMETERS - -### -BlockBingMapsInAllLocales -Specifies whether Bing Maps are blocked in all locales. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPBingMapsBlock](Get-SPBingMapsBlock.md) - -[Get-SPBingMapsKey](Get-SPBingMapsKey.md) - -[Set-SPBingMapskey](Set-SPBingMapskey.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBingMapsKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBingMapsKey.md deleted file mode 100644 index 5241a29bf8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBingMapsKey.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBingMapsKey -schema: 2.0.0 ---- - -# Set-SPBingMapsKey - -## SYNOPSIS -Sets the Bing Maps key. - - -## SYNTAX - -``` -Set-SPBingMapsKey [-BingKey] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPBingMapsKey` cmdlet to set the Bing Maps key. -This key lets you access Bing Maps. -For additional information about Bing Keys, see Bing Maps Account Center (https://www.bingmapsportal.com/) - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPBingMapsKey -BingKey <Bing Maps Key> -``` - -This example sets the key that is used by Bing Maps. - - -## PARAMETERS - -### -BingKey -Specifies the Bing Maps key to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPBingMapsKey](Get-SPBingMapsKey.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBrowserCustomerExperienceImprovementProgram.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBrowserCustomerExperienceImprovementProgram.md deleted file mode 100644 index e2f30a8e13..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBrowserCustomerExperienceImprovementProgram.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBrowserCustomerExperienceImprovementProgram -schema: 2.0.0 ---- - -# Set-SPBrowserCustomerExperienceImprovementProgram - -## SYNOPSIS -Turns on or off the browser Customer Experience Improvement Program. - - -## SYNTAX - -### Farm -``` -Set-SPBrowserCustomerExperienceImprovementProgram [-Farm] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Enable] [-WhatIf] [<CommonParameters>] -``` - -### SiteSubscription -``` -Set-SPBrowserCustomerExperienceImprovementProgram -SiteSubscription <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Enable] [-WhatIf] [<CommonParameters>] -``` - -### WebApplication -``` -Set-SPBrowserCustomerExperienceImprovementProgram -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Enable] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPBrowserCustomerExperienceImprovementProgram` cmdlet turns on or off the browser Customer Experience Improvement Program for collecting software quality metrics. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable -``` - -This example turns on the browser Customer Experience Improvement Program for the farm. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable:$False -``` - -This example turns off the browser Customer Experience Improvement Program for the farm. - - -### ------------------EXAMPLE 3----------------------- -``` -PS C:\>Set-SPWebApplication http://MyOfficeApp1 | Get- SPBrowserCustomerExperienceImprovementProgram -Enable -``` - -This example turns on the browser Customer Experience Improvement Program for the Web application, MyOfficeApp1. - - -## PARAMETERS - -### -Farm -{{Fill Farm Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: Farm -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Sets the Customer Experience Improvement Program opt-in state for the specified site subscription. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Sets the Customer Experience Improvement Program opt-in state for the specified SharePoint Web application. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Turns on the browser Customer Experience Improvement Program. -The default value is True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogEntityNotificationWeb.md deleted file mode 100644 index 25846582f4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogEntityNotificationWeb.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBusinessDataCatalogEntityNotificationWeb -schema: 2.0.0 ---- - -# Set-SPBusinessDataCatalogEntityNotificationWeb - -## SYNOPSIS -Sets the entity notification site. - - -## SYNTAX - -``` -Set-SPBusinessDataCatalogEntityNotificationWeb -Web <SPWebPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPBusinessDataCatalogEntityNotificationWeb` cmdlet to sets the entity notification site for the specified service context by using the Web parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set- SPBusinessDataCatalogEntityNotificationWeb -Web "http://contoso/" -``` - -This example sets http://contoso as the entity notification site for the service context of the site at http://contoso. - - -## PARAMETERS - -### -Web -Specifies the site to be set as the entity notification site for its own service context. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-SPBusinessDataCatalogEntityNotificationWeb](Clear-SPBusinessDataCatalogEntityNotificationWeb.md) - -[Get-SPBusinessDataCatalogEntityNotificationWeb](Get-SPBusinessDataCatalogEntityNotificationWeb.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogMetadataObject.md deleted file mode 100644 index 511358a5e3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogMetadataObject.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBusinessDataCatalogMetadataObject -schema: 2.0.0 ---- - -# Set-SPBusinessDataCatalogMetadataObject - -## SYNOPSIS -Sets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object. - - -## SYNTAX - -### Display -``` -Set-SPBusinessDataCatalogMetadataObject -Identity <MetadataObject> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DisplayName <String>] [-Remove] - [-SettingId <String>] [-WhatIf] [<CommonParameters>] -``` - -### NameValue -``` -Set-SPBusinessDataCatalogMetadataObject -Identity <MetadataObject> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-PropertyName <String>] - [-PropertyValue <PSObject>] [-Remove] [-SettingId <String>] [-WhatIf] [<CommonParameters>] -``` - -### NameRemove -``` -Set-SPBusinessDataCatalogMetadataObject -Identity <MetadataObject> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-PropertyName <String>] [-Remove] - [-SettingId <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPBusinessDataCatalogMetadataObject` cmdlet sets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$obj = Get-SPBusinessDataCatalogMetadataObject -Namespace "ContosoDatabase" -Name "ContosoDatabase" -BdcObjectType "LobSystemInstance" -ServiceContext http://contoso -PS C:\>Set-SPBusinessDataCatalogMetadataObject -Identity $obj -PropertyName "ShowInSearchUI" -PropertyValue "True" -``` - -This example creates a property on the LobSystemInstance (External System Instance) of name ContosoDatabase. -The property has the name ShowInSearchUI and a value of True. - - -## PARAMETERS - -### -Identity -Specifies the Business Data Connectivity Metadata Store metadata object to update. - -```yaml -Type: MetadataObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the Business Data Connectivity Metadata Store metadata object. - -```yaml -Type: String -Parameter Sets: Display -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyName -Specifies the name of the property to update. - -```yaml -Type: String -Parameter Sets: NameValue, NameRemove -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyValue -Sets the new value of the property specified in the PropertyName parameter. - -```yaml -Type: PSObject -Parameter Sets: NameValue -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Removes the property specified in the PropertyName parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingId -Specifies the custom environment settings model slice for which the property applies. - -The type must be a valid string that identifies a model slice; for example, ModelSlice1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogServiceApplication.md deleted file mode 100644 index 7fa309aa33..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogServiceApplication.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBusinessDataCatalogServiceApplication -schema: 2.0.0 ---- - -# Set-SPBusinessDataCatalogServiceApplication - -## SYNOPSIS -Sets global properties for a Business Data Connectivity service application in the farm. - - -## SYNTAX - -``` -Set-SPBusinessDataCatalogServiceApplication [-ApplicationPool <SPIisWebServiceApplicationPool>] - [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabasePassword <SecureString>] - [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] - -Identity <SPServiceApplicationPipeBind> [-Name <String>] [-Sharing] [-Confirm] [-WhatIf] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPBusinessDataCatalogServiceApplication` cmdlet sets global properties for a Business Data Connectivity service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Business Data Connectivity Service Application'} -PS C:\>Set-SPBusinessDataCatalogServiceApplication -Identity $sa -FailoverDatabaseServer "CONTOSO\Backup" -``` - -This example sets the failover database server to CONTOSO\Backup for the given service application. - - -## PARAMETERS - -### -ApplicationPool -Specifies the IIS application pool to use for the new Business Data Connectivity service application. - -```yaml -Type: SPIisWebServiceApplicationPool -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the Business Data Connectivity database. - -The type must be a valid name of a SQL Server database; for example, UsageLogDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user specified in DatabaseUserName. -Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. - -The type must be a valid password. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the Business Data Connectivity database. - -The type must be a valid name of a SQL Server database; for example, UsageLogDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user name to use for connecting to the catalog database. -Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. - -The type must be a valid user name; for example, UserName1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host server for the failover database server. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Identity -Specifies the Business Data Connectivity service application associated with the new proxy. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies a display name for the new Business Data Connectivity service application proxy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sharing -Specifies that the Business Data Connectivity service application is published and shared across the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -{{Fill AssignmentCollection Description}} - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogThrottleConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogThrottleConfig.md deleted file mode 100644 index 4f70fb7551..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPBusinessDataCatalogThrottleConfig.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPBusinessDataCatalogThrottleConfig -schema: 2.0.0 ---- - -# Set-SPBusinessDataCatalogThrottleConfig - -## SYNOPSIS -Sets the throttling configuration for a Business Data Connectivity Service application. - - -## SYNTAX - -### MaxDefault -``` -Set-SPBusinessDataCatalogThrottleConfig -Default <Int32> -Identity <ThrottleConfig> -Maximum <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### Enforcement -``` -Set-SPBusinessDataCatalogThrottleConfig [-Enforced] -Identity <ThrottleConfig> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPBusinessDataCatalogThrottleConfig` cmdlet sets the throttling configuration for a Business Data Connectivity Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy | Set-SPBusinessDataCatalogThrottleConfig -Maximum 1000000000 -Default 500000 -``` - -This example sets the database item throttling to values of 1000000000 maximum and 500000 default for the given service application. - - -## PARAMETERS - -### -Default -Specifies the default setting of the throttle configuration. - -```yaml -Type: Int32 -Parameter Sets: MaxDefault -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enforced -Specifies that the throttle configuration setting cannot be overridden. - -```yaml -Type: SwitchParameter -Parameter Sets: Enforcement -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the throttle configuration to update. - -```yaml -Type: ThrottleConfig -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Maximum -Specifies the maximum value of the throttling configuration setting. - -```yaml -Type: Int32 -Parameter Sets: MaxDefault -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPCentralAdministration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPCentralAdministration.md deleted file mode 100644 index 0b4f3cbeae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPCentralAdministration.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPCentralAdministration -schema: 2.0.0 ---- - -# Set-SPCentralAdministration - -## SYNOPSIS -Sets the port for the SharePoint Central Administration Web site. - - -## SYNTAX - -``` -Set-SPCentralAdministration -Port <Int32> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [-SecureSocketsLayer] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPCentralAdministration` cmdlet sets the port for the Central Administration site. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Set-SPCentralAdministration -Port 8282 -``` - -This example sets the port for the Central Administration web application on the local farm to 8282. - - -## PARAMETERS - -### -Port -Specifies the administration port for the Central Administration site. - -The type must be a valid port number; for example, 8080. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureSocketsLayer -Enables Secure Socket Layer (SSL) encryption for the specified port. If you choose to use SSL, you must assign a server certificate to the Central Administration IIS web site by using the IIS administration tools. The Central Administration web application won't be accessible until you do this. - -The default value is False. - -If this parameter is omitted or set to False the Central Administration site will use HTTP for the specified port. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPClaimProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPClaimProvider.md deleted file mode 100644 index 2dd1fc4e62..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPClaimProvider.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPClaimProvider -schema: 2.0.0 ---- - -# Set-SPClaimProvider - -## SYNOPSIS -Updates registration of a claims provider. - - -## SYNTAX - -``` -Set-SPClaimProvider [-Identity] <SPClaimProviderPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Default] [-Enabled] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPClaimProvider` cmdlet updates registration of a claims provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Set-SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh" -``` - -This example turns off the specified claim provider. - - -## PARAMETERS - -### -Identity -Specifies the claim provider to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. - -```yaml -Type: SPClaimProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Default -Specifies that the claim provider applies to all Web applications and zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Turns on the claim provider. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDatabase.md deleted file mode 100644 index 4a5ac9dcfc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDatabase.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPContentDatabase -schema: 2.0.0 ---- - -# Set-SPContentDatabase - -## SYNOPSIS -Sets global properties of a SharePoint content database. - - -## SYNTAX - -``` -Set-SPContentDatabase [-Identity] <SPContentDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-MaxSiteCount <Int32>] [-Status <SPObjectStatus>] [-WarningSiteCount <Int32>] [-WhatIf] - [-DatabaseFailoverServer <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPContentDatabase` cmdlet sets global properties of a SharePoint content database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------EXAMPLE 1--------------- -``` -PS C:\>Get-SPContentDatabase http://contoso.com | Set-SPContentDatabase -MaxSiteCount 1 -``` - -This example sets the MaxSiteCount for the content database that contains contoso.com to 1. - - -### ---------------EXAMPLE 2--------------- -``` -PS C:\>Get-SPContentDatabase -WebApplication http://sitename | Set-SPContentDatabase -WarningSiteCount $null -``` - -This example clears the WarningSiteCount for all databases in the sitename Web application. - - -## PARAMETERS - -### -Identity -Specifies the content database to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSiteCount -Specifies the maximum number of site collections that this database can host. - -The type must be a positive integer. -Set to $null to clear this value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Status -Specifies the status of the SQL Server database. -Set this parameter to Ready to make the database available to host new sites. -Set this parameter to Offline to make the database unavailable to host new sites. - -The type must be either of the following: Ready or Offline - -```yaml -Type: SPObjectStatus -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WarningSiteCount -Specifies the number of site collections that can be created before a warning event is generated and the owner of the site collection is notified. - -The type must be a positive integer. -Set to $null to clear this value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer -Specifies the name of the mirror server for failover. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDeploymentJob.md deleted file mode 100644 index 79a12e02ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDeploymentJob.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPContentDeploymentJob -schema: 2.0.0 ---- - -# Set-SPContentDeploymentJob - -## SYNOPSIS -Sets properties of a content deployment job. - - -## SYNTAX - -``` -Set-SPContentDeploymentJob [-Identity] <SPContentDeploymentJobPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] - [-EmailAddresses <String[]>] [-EmailNotifications <ContentDeploymentNotificationSettings>] - [-HostingSupportEnabled] [-IncrementalEnabled] [-Name <String>] [-Schedule <String>] [-ScheduleEnabled] - [-Scope <SPWebPipeBind[]>] [-SqlSnapshotSetting <ContentDeploymentSqlSnapshotSetting>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPContentDeploymentJob` cmdlet sets the properties of a content deployment job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE------------------ -``` -PS C:\>Get-SPContentDeploymentJob "Job 1" | Set-SPContentDeploymentJob -Schedule "hourly between 0 and 59" -ScheduleEnabled:$true -``` - -This example sets the deployment job called Job 1 to run hourly. - - -## PARAMETERS - -### -Identity -Specifies the content deployment job to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. - -```yaml -Type: SPContentDeploymentJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the content deployment job. -The name can be a maximum of 4096 alphanumeric characters. - -The type must be a valid string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAddresses -Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object. - -The type must be a list of valid e-mail addresses. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailNotifications -Specifies how e-mail notifications are sent about this ContentDeploymentJob object. - -The type must be one of the following: - --Never specifies that e-mail notifications will not be sent when a job succeeds or fails. - -- Success specifies that e-mail notifications will be sent if a content deployment job succeeds. -- Failure specifies that e-mail notifications will be sent if a content deployment job fails. -- Always specifies that e-mail notifications will be sent when a job succeeds or fails. - -```yaml -Type: ContentDeploymentNotificationSettings -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostingSupportEnabled -Enables special hosting behavior. -The default value is False. - -Normally, a content deployment job is enabled or disabled by using the SharePoint Central Administration Web site. -However, in the case of hosting, the tenant administrator does not have permissions to access the Central Administration page to configure jobs. -Therefore, when the HostingSupportEnabled parameter is set to True, the hoster creates the job, so that tenants can enable or disable their deployment jobs from their tenant administration site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncrementalEnabled -Specifies that only incremental changes are deployed to the destination site collection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new content deployment job. - -The type must be a valid name of a content deployment job; for example, DeployJob1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Schedule -Sets the schedule for the deployment job. - -The type must be a valid SPSchedule object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleEnabled -Enables the schedule for the deployment job. -If the schedule is not enabled, the job can be run manually only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Sets the scope of the deployment job. -SPSite objects that are passed in must exist in the current path of the source site collection. -The default scope is the entire site collection. -Valid values include a SPWeb object or an array of SPWeb objects. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Foundation Web site (for example, MySPSite1); or an instance of a valid SPWeb object. - -```yaml -Type: SPWebPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlSnapshotSetting -Backs up the SharePoint Foundation content database by using SQL Server. - -The type must be one of the following values: None or CreateNew. - -```yaml -Type: ContentDeploymentSqlSnapshotSetting -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDeploymentPath.md deleted file mode 100644 index 17e9098887..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPContentDeploymentPath.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPContentDeploymentPath -schema: 2.0.0 ---- - -# Set-SPContentDeploymentPath - -## SYNOPSIS -Sets properties of a content deployment path. - - -## SYNTAX - -``` -Set-SPContentDeploymentPath [-Identity] <SPContentDeploymentPathPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Authentication <PathAuthenticationOption>] - [-CompressionEnabled] [-DeploySecurityInformation <SPIncludeSecurity>] [-DeployUserNamesEnabled] - [-Description <String>] [-DestinationCentralAdministrationURL <Uri>] [-EventReceiversEnabled] - [-KeepTemporaryFilesOptions <TemporaryFilesOption>] [-Name <String>] [-PathAccount <PSCredential>] - [-PathEnabled] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPContentDeploymentPath` cmdlet sets the properties of a content deployment path for a content deployment job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Get-SPContentDeploymentPath "Path 1" | Set-SPContentDeploymentPath -PathEnabled:$false -``` - -This example sets the deployment path Path 1 to be disabled. - - -## PARAMETERS - -### -Identity -Specifies the content deployment path to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. - -```yaml -Type: SPContentDeploymentPathPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Authentication -Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application. - -The type must be one of the following values: WindowsAuth or BasicAuth. - -```yaml -Type: PathAuthenticationOption -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompressionEnabled -Turns on compression during the export. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploySecurityInformation -Specifies the user and group information to include during the export operation for this content deployment path. -The default value is All. - -The type must be one of the following values: None, All, or WssOnly- Applies only SharePoint Foundation security settings. -Includes user memberships and role assignments such as default roles, for example, Web Designer or any custom roles that extend from the default roles. -The access control list (ACL) for each object is migrated. -No user information defined in the DAP or LDAP servers is included. - -```yaml -Type: SPIncludeSecurity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeployUserNamesEnabled -Specify to enable event receivers during import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Sets the description for the content deployment path. -The description can contain a maximum of 4096 alphanumeric characters. - -The type must be a valid string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DestinationCentralAdministrationURL -Specifies the SharePoint Central Administration URL for the destination farm. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventReceiversEnabled -Turns on event receivers during import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepTemporaryFilesOptions -Specifies that temporary files are kept after content deployment is finished. - -The type must be one of the following values: Never, Always, or OnFailure. - -```yaml -Type: TemporaryFilesOption -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the content deployment path. - -The type must be a valid name of a content deployment path; for example, DeploymentPath1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PathAccount -Specifies the user ID that is an administrator on the Central Administration page on the destination farm. - -The type must be a valid SharePoint user. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathEnabled -Enables the content deployment path. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPCustomLayoutsPage.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPCustomLayoutsPage.md deleted file mode 100644 index 6deedc6b66..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPCustomLayoutsPage.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPCustomLayoutsPage -schema: 2.0.0 ---- - -# Set-SPCustomLayoutsPage - -## SYNOPSIS -Maps a new path for a custom layout page. - - -## SYNTAX - -### CustomPage -``` -Set-SPCustomLayoutsPage -Identity <SPCustomPage> -RelativePath <String> - -WebApplication <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [-CompatibilityLevel <Int32>] [<CommonParameters>] -``` - -### ResetCustomPage -``` -Set-SPCustomLayoutsPage -Identity <SPCustomPage> [-Reset] -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [-CompatibilityLevel <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPCustomLayoutsPage` cmdlet maps a new path for a custom layouts page in a Web application. -To remove the mapping for a custom layouts page, use the Reset parameter instead of the RelativePath parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPCustomLayoutsPage -Identity AccessDenied -RelativePath "/_layouts/custompages/myaccessdenied.aspx" -WebApplication "http://server_name/mywebapp" -``` - -This example maps the specified path for the AccessDenied layout page in the Web application "http://server_name/mywebapp". - - -## PARAMETERS - -### -Identity -Specifies the custom layout page to set. - -The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted. - -```yaml -Type: SPCustomPage -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RelativePath -Specifies the path of the custom layout page. - -The type must be a valid path of a layout page, in the form _layouts/custompages/myaccessdenied.aspx. - -```yaml -Type: String -Parameter Sets: CustomPage -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reset -Resets the mapping of a custom layouts page. - -```yaml -Type: SwitchParameter -Parameter Sets: ResetCustomPage -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the SharePoint Web application that contains the custom layout page. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDataConnectionFile.md deleted file mode 100644 index 1a77714f66..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDataConnectionFile.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPDataConnectionFile -schema: 2.0.0 ---- - -# Set-SPDataConnectionFile - -## SYNOPSIS -Sets properties of a data connection file. - - -## SYNTAX - -``` -Set-SPDataConnectionFile [-Identity] <SPDataConnectionFilePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Category <String>] [-Confirm] [-Description <String>] - [-DisplayName <String>] [-WebAccessible <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPDataConnectionFile` cmdlet sets the properties of the data connection file specified in the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Set-SPDataConnectionFile -Identity "sample.udcx" -Category "Temp" -``` - -This example updates the Category of the specified .udcx file. - - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Set-SPDataConnectionFile -Identity "sample.udcx" -DisplayName "NewDisplayName" -``` - -This example updates the DisplayName of the specified .udcx file. - - -### --------------EXAMPLE 3----------------- -``` -PS C:\>Sample.udcx" | Set-SPDataConnectionFile -Category "Temp" -``` - -This example updates the Category of the specified .udcx file. - - -### --------------EXAMPLE 4----------------- -``` -PS C:\>Get-SPDataConnectionFile | where {$_.Category -eq "Category1"} | Set-SPDataConnectionFile -Category "Category2" -``` - -This example updates the Category field for the collection of .udcx files that are returned from a query used by the `Get-SPDataConnectionFile` cmdlet. - - -## PARAMETERS - -### -Identity -Specifies the data connection file to update. - -The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. - -```yaml -Type: SPDataConnectionFilePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category -Sets an arbitrary category on the file which can be used to group the files. -The category name can have a maximum of 255 characters. - -The type must be a valid string value; for example, Category1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Sets the description for the data connection file. -The name can be a maximum of 4096 alphanumeric characters. - -The type must be a valid string; for example, Description of my universal data connection file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name that describes the data connection file. -The name can have a maximum of 255 characters. - -The type must be a valid string; for example, InfoPathUDC1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebAccessible -Specifies that the universal data connection file can be accessed by using the Web service. -If false, only the forms server can retrieve the universal data connection files internally. -The default value is False. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDefaultProfileConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDefaultProfileConfig.md deleted file mode 100644 index 33df7c7b09..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDefaultProfileConfig.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPDefaultProfileConfig -schema: 2.0.0 ---- - -# Set-SPDefaultProfileConfig - -## SYNOPSIS -Changes the MySitesPublicEnabled property of the User Profile Application Proxy. - - -## SYNTAX - -``` -Set-SPDefaultProfileConfig [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -MySitesPublicEnabled <Boolean> -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPDefaultProfileConfig cmdlet to change the MySitesPublicEnabled property of a User Profile Application Proxy from whatever was set at the time of Proxy creation to whatever is defined by using this cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715)](https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Set-SPDefaultProfileConfig $proxy -MySitesPublicEnabled $true -``` - -This example changes the MySitesPublicEnabled property of the specified user profile service application. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MySitesPublicEnabled -Enables or disables public MySites. - -The valid values are $True or $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -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 -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDesignerSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDesignerSettings.md deleted file mode 100644 index 361e9dc17e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDesignerSettings.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPDesignerSettings -schema: 2.0.0 ---- - -# Set-SPDesignerSettings - -## SYNOPSIS -Sets SharePoint Designer features. - - -## SYNTAX - -``` -Set-SPDesignerSettings [-WebApplication] <SPWebApplicationPipeBind> [-AllowDesigner <Boolean>] - [-AllowMasterPageEditing <Boolean>] [-AllowRevertFromTemplate <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ShowURLStructure <Boolean>] [-WhatIf] - [-AllowCreateDeclarativeWorkflow <Boolean>] [-AllowSaveDeclarativeWorkflowAsTemplate <Boolean>] - [-AllowSavePublishDeclarativeWorkflow <Boolean>] [-DesignerDownloadUrl <String>] - [-RequiredDesignerVersion <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPDesignerSettings` cmdlet sets SharePoint Designer features on a specified Web application when the WebApplicaton is used. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE-------------------- -``` -PS C:\>Set-SPDesignerSettings -WebApplication http://constoso -AllowRevertFromTemplate $False -AllowMasterPageEditing $False -``` - -This example disables the ability to detach pages from existing site definitions and to edit master pages and page layouts. - - -## PARAMETERS - -### -WebApplication -Specifies the Web application in which the settings will apply. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AllowDesigner -Specifies whether to allow users to edit sites in a web application by using SharePoint Designer. -The default value is True - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMasterPageEditing -Specifies whether to allow site administrators to customize master pages and layout pages using SharePoint Designer. -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowRevertFromTemplate -Specifies whether to allow site administrators to detach pages from the original site definition using SharePoint Designer. -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowURLStructure -Specifies whether to allow site administrators to manage the URL structure of their Web sites by using SharePoint Designer. -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreateDeclarativeWorkflow -Allows the creation of declarative workflows. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSaveDeclarativeWorkflowAsTemplate -Allows saving declarative workflows as a template. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSavePublishDeclarativeWorkflow -Allows saving of published declarative workflows. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DesignerDownloadUrl -Sets the URL to the SharePoint Designer download. The default value is: - -https://go.microsoft.com/fwlink/?LinkId=328584 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredDesignerVersion -Sets the required version of SharePoint Designer. The default value is - -15.0.0.0 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDiagnosticConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDiagnosticConfig.md deleted file mode 100644 index 773c6029f6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDiagnosticConfig.md +++ /dev/null @@ -1,509 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPDiagnosticConfig -schema: 2.0.0 ---- - -# Set-SPDiagnosticConfig - -## SYNOPSIS -Sets diagnostic configuration settings on the farm. - - -## SYNTAX - -``` -Set-SPDiagnosticConfig [-AllowLegacyTraceProviders] [-AppAnalyticsAutomaticUploadEnabled] - [-AssignmentCollection <SPAssignmentCollection>] [-CustomerExperienceImprovementProgramEnabled] - [-DaysToKeepLogs <Int32>] [-DownloadErrorReportingUpdatesEnabled] [-ErrorReportingAutomaticUploadEnabled] - [-ErrorReportingEnabled] [-EventLogFloodProtectionEnabled] [-EventLogFloodProtectionNotifyInterval <Int32>] - [-EventLogFloodProtectionQuietPeriod <Int32>] [-EventLogFloodProtectionThreshold <Int32>] - [-EventLogFloodProtectionTriggerPeriod <Int32>] [-InputObject <PSObject>] [-LogCutInterval <Int32>] - [-LogDiskSpaceUsageGB <Int32>] [-LogLocation <String>] [-LogMaxDiskSpaceUsageEnabled] - [-ScriptErrorReportingDelay <Int32>] [-ScriptErrorReportingEnabled] [-ScriptErrorReportingRequireAuth] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPDiagnosticConfig` cmdlet to set diagnostic configuration settings on the entire farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Set-SPDiagnosticConfig -ErrorReportingEnabled -DownloadErrorReportingUpdatesEnabled:$false -DaysToKeepLog 60 -``` - -This example enables ErrorReporting, disables DownloadErrorReportingUpdatesEnable and sets DaysToKeepLog to 60. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>$config = Get-SPDiagnosticConfig -PS C:\>$config.CustomerExperienceImprovementProgramEnabled = $false -PS C:\>$config.LogCutInterval = 60 -PS C:\>$config | Set-SPDiagnosticConfig -``` - -This example disables CEIP and sets LogCutInterval to 60 minutes. - - -## PARAMETERS - -### -AllowLegacyTraceProviders -Specifies that trace providers built for previous versions of SharePoint Products and Technologies can write to the trace session for SharePoint Products. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppAnalyticsAutomaticUploadEnabled -Specifies whether aggregated app usage data is automatically uploaded to Microsoft. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomerExperienceImprovementProgramEnabled -Specifies whether participation in the Customer Experience Improvement Program (CEIP) is enabled. - -The CEIP is designed to improve the quality, reliability, and performance of Microsoft products and technologies. -With your permission, anonymous information about your server is sent to Microsoft to help improve SharePoint Products. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DaysToKeepLogs -Specifies the number of days to keep trace log files. -The type must be a valid number between 1 and 366. -The default value is 14 days. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DownloadErrorReportingUpdatesEnabled -Specifies whether the error reporting remote control file is downloaded. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ErrorReportingAutomaticUploadEnabled -Specifies whether error reports are uploaded to Microsoft automatically. - -Error reports include the following: information regarding the condition of the server when a problem occurs; the operating system version and computer hardware in use; and the digital product ID, which can be used to identify your license. -The IP address of your computer is also sent because you are connecting to an online service to send error reports; however, the IP address is used only to generate aggregate statistics. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ErrorReportingEnabled -Specifies whether collection of error reports is enabled. - -Error reports are created when your system encounters hardware or software problems. -Microsoft and its partners actively use these reports to improve the reliability of the software. -Error reports include the following: information regarding the condition of the server when the problem occurs; the operating system version and computer hardware in use; and the digital product ID, which can be used to identify your license. -The IP address of your computer is also sent because you are connecting to an online service to send error reports; however, the IP address is used only to generate aggregate statistics. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLogFloodProtectionEnabled -Specifies whether the Event log flood protection feature is enabled. - -If multiple similar events are written to the event log, some duplicate messages are suppressed. -Then, after a period of time, a summary message is written that shows how many events were suppressed. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLogFloodProtectionNotifyInterval -Specifies in minutes how often to write a summary event indicating how many events were suppressed due to flood protection. - -The integer range is between 1 and 1440. -The default value is 5. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLogFloodProtectionQuietPeriod -Specifies in minutes how much time must pass without an event firing to exit flood protection. - -The integer range is between 1 and 1440. -The default value is 2. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLogFloodProtectionThreshold -Specifies the number of events allowed in a given timeframe before an event is considered to be flooding the event log. - -The integer range is between 1 and 100. -The default value is 5. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLogFloodProtectionTriggerPeriod -Specifies in minutes the timeframe to watch for events that may be flooding. - -The integer range is between 1 and 1440. -The default value is 2. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Use the result from the `Get-SPDiagnosticConfig` cmdlet, make modifications and then pipeline the object into `Set-SPDiagnosticConfig` cmdlet to update the content database. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LogCutInterval -Specifies the number of minutes between log file rollovers. - -The value must be a valid integer between 0 and 1440. - -The default value is 30. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogDiskSpaceUsageGB -Specifies the maximum amount of storage to use for trace log files, in gigabytes (GB). - -The default value is 1000 and only takes effect when the LogMaxDiskSpaceusageEnabled cmdlet is set to True. - -The type must be a valid number between 1 and 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLocation -Specifies the path of where to log files will reside. - -The type must be a valid path, in the form C:\Logs. - -The default location is %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\14\Logs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogMaxDiskSpaceUsageEnabled -Specifies whether to restrict the maximum space to use for trace log files. - -The type must be either of the following values: - -- $True -- $False - -The default value is $False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptErrorReportingDelay -Specifies the time (in minutes) between script error reports. - -The type must be a valid integer between 0 and 1440. -The value is specified in minutes. - -The default value is 30. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptErrorReportingEnabled -Specifies whether error reporting is enabled for client script errors. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptErrorReportingRequireAuth -Specifies whether script error reporting requires authentication. - -The type must be either of the following values: - -- $True -- $False - -The default value is $True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDiagnosticsProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDiagnosticsProvider.md deleted file mode 100644 index ce80deaffe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDiagnosticsProvider.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPDiagnosticsProvider -schema: 2.0.0 ---- - -# Set-SPDiagnosticsProvider - -## SYNOPSIS -Enables a diagnostics provider and updates its retention policy. - - -## SYNTAX - -``` -Set-SPDiagnosticsProvider [-Identity] <SPDiagnosticsProviderPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DaysRetained <Int32>] [-Enable] [-WhatIf] - [-MaxTotalSizeInBytes <Int64>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPDiagnosticsProvider` cmdlet enables a diagnostics provider and updates its retention policy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable:$false -PS C:\>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider -``` - -This example disables the event log diagnostics provider. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable -DaysRetained 10 -PS C:\>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider -``` - -This example enables the event log diagnostics provider and changes its retention policy to 10 days. - - -## PARAMETERS - -### -Identity -Specifies the diagnostics provider to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticProv1); or an instance of a valid SPDiagnosticsProvider object. - -```yaml -Type: SPDiagnosticsProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysRetained -Specifies the number of days to retain the data collected by a diagnostics provider. - -The type must be a valid integer value in the range of 1 to 14. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Turns on or off the specified diagnostics provider. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxTotalSizeInBytes -The maximum size of the partition within the Usage database. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDistributedCacheClientSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDistributedCacheClientSetting.md deleted file mode 100644 index e553a1e744..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPDistributedCacheClientSetting.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPDistributedCacheClientSetting -schema: 2.0.0 ---- - -# Set-SPDistributedCacheClientSetting - -## SYNOPSIS -Sets distributed cache settings. - - -## SYNTAX - -``` -Set-SPDistributedCacheClientSetting [-ContainerType] <SPDistributedCacheContainerType> - [-DistributedCacheClientSettings] <SPDistributedCacheClientSettings> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPDistributedCacheClientSettings` cmdlet to set the distributed cache service based on usage. -Usage can be any type of cache that the ContainerType parameter specifies. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$settings = Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache -PS C:\>$settings.MaxConnectionsToServer = 10 -PS C:\>Set-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache -DistributedCacheClientSettings $settings -``` - -This example updates the MaxConnectionsToServer to 10 for DistributedLogonTokenCache. - - -## PARAMETERS - -### -ContainerType -Specifies the container type to clear. - -The valid values are the following: - --DistributedDefaultCache - --DistributedAccessCache - --DistributedActivityFeedCache - --DistributedBouncerCache - --DistributedLogonTokenCache - --DistributedServerToAppServerAccessTokenCache - --DistributedSearchCache - --DistributedSecurityTrimmingCache - --DistributedActivityFeedLMTCache - --DistributedViewStateCache - - -```yaml -Type: SPDistributedCacheContainerType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DistributedCacheClientSettings -Updates the various cache client settings. -It is recommended to use the default settings. - -```yaml -Type: SPDistributedCacheClientSettings -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPDistributedCacheClientSetting](Get-SPDistributedCacheClientSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEduServiceSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEduServiceSetting.md deleted file mode 100644 index 493edfc70f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEduServiceSetting.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013 -title: Set-SPEduServiceSetting -schema: 2.0.0 ---- - -# Set-SPEduServiceSetting - -## SYNOPSIS -Do not use - - -## SYNTAX - -``` -Set-SPEduServiceSetting [[-Enabled] <Boolean>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -Service <Services> -Site <SPSitePipeBind> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -Do not use -``` - - - - -## PARAMETERS - -### -AssignmentCollection -Do not use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Do not use - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Do not use - -```yaml -Type: Services -Parameter Sets: (All) -Aliases: -Accepted values: Lync, Exchange, StudyGroup -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Do not use - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: True -Position: Named -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchAdministrationComponent.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchAdministrationComponent.md deleted file mode 100644 index c1deb09cd0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchAdministrationComponent.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchAdministrationComponent -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchAdministrationComponent - -## SYNOPSIS -Sets properties of an administration component for a search service application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchAdministrationComponent [[-Identity] <AdminComponentPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] - [-SearchApplication <SearchServiceApplicationPipeBind>] - [-SearchServiceInstance <SearchServiceInstancePipeBind>] [-StoragePath <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-SPEnterpriseSearchAdministrationComponent cmdlet updates properties of an AdministrationComponent object for a search service application. - -For permissions and the most current information about search cmdlets, see the online documentation, [https://go.microsoft.com/fwlink/?LinkId=163185](https://go.microsoft.com/fwlink/?LinkId=163185). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` - PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication "Search Service Application" - PS C:\>$admin = Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa - PS C:\>$admin | Set-SPEnterpriseSearchAdministrationComponent -SearchServiceInstance SP02 -Force -``` - -This example moves the administration component to a different server. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that the admin component must be moved to the new search service instance. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the administration component to update. - -The type must be a valid name (GUID), such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid AdminComponent object. - -```yaml -Type: AdminComponentPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the administration component. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchServiceInstance -Specifies the search service instance to host the administration component. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoragePath -Specifies the path for storing data for the administration component. The path must contain a valid file share and use valid registry characters. - -The type must be a valid path in either of the following forms: - -- C:\folder_name - -- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.Office.Server.Search.Cmdlet.AdminComponentPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md deleted file mode 100644 index e97b15bcf0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchContentEnrichmentConfiguration -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchContentEnrichmentConfiguration - -## SYNOPSIS -Stores the specified content enrichment configuration to the search service application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchContentEnrichmentConfiguration - -ContentEnrichmentConfiguration <ContentEnrichmentConfigurationPipeBind> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet validates the ContentEntrichmentConfiguration object and stores the provided configuration in the SearchServiceApplication. -Both a ContentEnrichmentConfiguration and a SearchServiceApplication object have to be provided. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1 ------------------ -``` -PS C:\>$config = New-SPEnterpriseSearchContentEnrichmentConfiguration -PS C:\>$config.Endpoint = "http://server/service" -PS C:\>$config.InputProperties = "Title", "Url" -PS C:\>$config.OutputProperties = "Title", "Url" -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -ContentEnrichmentConfiguration $config -``` - -This example creates a new ContentEnrichmentConfiguration object. -The URL of the external web service is stored in the $config.Endpoint property. -The new ContentEnrichmentConfiguration is configured to use Title and URL, which are the managed properties that you want to send to the external web service. -It is also configured to expect the external web service to output the same managed properties. -The SearchServiceApplication object is retrieved and used for storing the newly created ContentEnrichmentConfiguration. - - -### ------------------EXAMPLE 2 ------------------ -``` -C:\PS>$config = New-SPEnterpriseSearchContentEnrichmentConfiguration -$config.Endpoint = "http://server/service" -$config.InputProperties = "Title" -$config.OutputProperties = "Title" -$config.Trigger = 'Contains(Title, "Example")' -$ssa = Get-SPEnterpriseSearchServiceApplication -Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -ContentEnrichmentConfiguration $config -``` - -This example creates a new ContentEnrichmentConfiguration object. -The URL of the external web service is stored in the $config.Endpoint property. -The new ContentEnrichmentConfiguration is configured to use Title, which is the managed property that you want to send to the external web service. -It is also configured to expect the external web service to output the same managed property. -The $config.Trigger is set to only send the managed property when the Boolean trigger expression is true, in this case when the managed property Title contains the string "Example". -The SearchServiceApplication object is retrieved, and used for storing the newly created ContentEnrichmentConfiguration. - - -## PARAMETERS - -### -ContentEnrichmentConfiguration -Specifies the ContentEnrichmentConfiguration that should be stored in the SearchServiceApplication. - -```yaml -Type: ContentEnrichmentConfigurationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchContentEnrichmentConfiguration](Get-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[New-SPEnterpriseSearchContentEnrichmentConfiguration](New-SPEnterpriseSearchContentEnrichmentConfiguration.md) - -[Remove-SPEnterpriseSearchContentEnrichmentConfiguration](Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlContentSource.md deleted file mode 100644 index 5b794b9a61..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlContentSource.md +++ /dev/null @@ -1,621 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchCrawlContentSource -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchCrawlContentSource - -## SYNOPSIS -Sets the properties of a crawl content source for a Search service application. - - -## SYNTAX - -### MonthlyDate -``` -Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] - [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm] - [-CrawlPriority <CrawlPriority>] [-CrawlScheduleDaysOfMonth <Int32>] - [-CrawlScheduleMonthsOfYear <MonthsOfYear>] [-CrawlScheduleRepeatDuration <Int32>] - [-CrawlScheduleRepeatInterval <Int32>] [-CrawlScheduleStartDateTime <DateTime>] [-CustomProtocol <String>] - [-EnableContinuousCrawls <Boolean>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Int32>] - [-MaxSiteEnumerationDepth <Int32>] [-MonthlyCrawlSchedule] [-Name <String>] - [-ScheduleType <ContentSourceCrawlScheduleType>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-StartAddresses <String>] [-Tag <String>] [-WhatIf] [<CommonParameters>] -``` - -### Weekly -``` -Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] - [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm] - [-CrawlPriority <CrawlPriority>] [-CrawlScheduleDaysOfWeek <DaysOfWeek>] - [-CrawlScheduleRepeatDuration <Int32>] [-CrawlScheduleRepeatInterval <Int32>] - [-CrawlScheduleRunEveryInterval <Int32>] [-CrawlScheduleStartDateTime <DateTime>] [-CustomProtocol <String>] - [-EnableContinuousCrawls <Boolean>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Int32>] - [-MaxSiteEnumerationDepth <Int32>] [-Name <String>] [-ScheduleType <ContentSourceCrawlScheduleType>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] - [-WeeklyCrawlSchedule] [-WhatIf] [<CommonParameters>] -``` - -### Daily -``` -Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] - [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm] - [-CrawlPriority <CrawlPriority>] [-CrawlScheduleRepeatDuration <Int32>] [-CrawlScheduleRepeatInterval <Int32>] - [-CrawlScheduleRunEveryInterval <Int32>] [-CrawlScheduleStartDateTime <DateTime>] [-CustomProtocol <String>] - [-DailyCrawlSchedule] [-EnableContinuousCrawls <Boolean>] [-LOBSystemSet <String[]>] - [-MaxPageEnumerationDepth <Int32>] [-MaxSiteEnumerationDepth <Int32>] [-Name <String>] - -ScheduleType <ContentSourceCrawlScheduleType> [-SearchApplication <SearchServiceApplicationPipeBind>] - [-StartAddresses <String>] [-Tag <String>] [-WhatIf] [<CommonParameters>] -``` - -### RemoveSchedule -``` -Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] - [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm] - [-CrawlPriority <CrawlPriority>] [-CustomProtocol <String>] [-EnableContinuousCrawls <Boolean>] - [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Int32>] [-MaxSiteEnumerationDepth <Int32>] - [-Name <String>] [-RemoveCrawlSchedule] [-ScheduleType <ContentSourceCrawlScheduleType>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPEnterpriseSearchCrawlContentSource` cmdlet updates the rules of a crawl content source when the search functionality is initially configured and after any new content source is added. -This cmdlet is called once to set the incremental crawl schedule for a content source and it is called again to set a full crawl schedule. - -The value of the optional EnableContinuousCrawls parameter can be True or False. -A value of True enables continuous crawls of items in this content source. -This causes the search system to automatically start incremental crawls to process the latest changes to items in the corresponding data repositories. -This helps to keep the index fresh for items in this content source. -Search service application administrators can still configure full crawls as needed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$cs = Get-SPEnterpriseSearchCrawlContentSource -Identity 'Local SharePoint Sites' -SearchApplication $ssa -PS C:\>$cs | Set-SPEnterpriseSearchCrawlContentSource -ScheduleType Full -DailyCrawlSchedule -CrawlScheduleRunEveryInterval 30 -PS C:\>$cs | Set-SPEnterpriseSearchCrawlContentSource -ScheduleType Incremental -DailyCrawlSchedule -CrawlScheduleRepeatInterval 60 -CrawlScheduleRepeatDuration 1440 -``` - -This example returns the "Local SharePoint Sites" content source and creates a schedule to run a full crawl every 30 days and an incremental crawl every hour every day. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BDCApplicationProxyGroup -Specifies the proxy to use for a business type content source. -This proxy group must contain a default Business Data Connectivity Metadata Store proxy. - - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlPriority -Specifies the priority of this content source. - -The type must be one of the following integers: 1= Normal, 2=High. - - -```yaml -Type: CrawlPriority -Parameter Sets: (All) -Aliases: p -Accepted values: Normal, High -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleDaysOfMonth -Specifies the days on which to crawl when the MonthlyCrawlSchedule parameter is set. - - -```yaml -Type: Int32 -Parameter Sets: MonthlyDate -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleDaysOfWeek -Specifies the days on which to crawl when the WeeklyCrawlSchedule parameter is set. - - -```yaml -Type: DaysOfWeek -Parameter Sets: Weekly -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Weekdays, Saturday, Weekends, Everyday -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleMonthsOfYear -Specifies the months on which to crawl when the MonthlyCrawlSchedule parameter is set. - - -```yaml -Type: MonthsOfYear -Parameter Sets: MonthlyDate -Aliases: month -Accepted values: January, February, March, April, May, June, July, August, September, October, November, December, AllMonths -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleRepeatDuration -Specifies the number of times to repeat the crawl schedule. - - -```yaml -Type: Int32 -Parameter Sets: MonthlyDate, Weekly, Daily -Aliases: duration -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleRepeatInterval -Specifies the number of minutes between each repeat interval for the crawl schedule - - -```yaml -Type: Int32 -Parameter Sets: MonthlyDate, Weekly, Daily -Aliases: interval -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleRunEveryInterval -Specifies the interval between crawls. - -When the DailyCrawlSchedule parameter is set, specifies the number of days between crawls. - -When the WeeklyCrawlSchedule parameter is set, specifies the number of weeks between crawls. - - -```yaml -Type: Int32 -Parameter Sets: Weekly, Daily -Aliases: every -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlScheduleStartDateTime -Specifies the initial date of the crawl. -The default value is midnight on the current day. - - -```yaml -Type: DateTime -Parameter Sets: MonthlyDate, Weekly, Daily -Aliases: start -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomProtocol -Specifies the custom protocol, handled by the custom connector, to use for this content source. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DailyCrawlSchedule -Base schedule on days between crawls. - - -```yaml -Type: SwitchParameter -Parameter Sets: Daily -Aliases: daily -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableContinuousCrawls -Specifies the value of the EnableContinuousCrawls parameter: True or False. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the crawl content source to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. - - -```yaml -Type: ContentSourcePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LOBSystemSet -Specifies a comma-separated list of Business Data Connectivity Metadata Store system names and system instance names for a business type content source. - - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPageEnumerationDepth -Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSiteEnumerationDepth -Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonthlyCrawlSchedule -Base the schedule on months between crawls. - - -```yaml -Type: SwitchParameter -Parameter Sets: MonthlyDate -Aliases: monthly -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the new display name for the content source. - -The type must be a valid name of a content source; for example, ContentSource1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveCrawlSchedule -Deletes the specified crawl. - - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveSchedule -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleType -Specifies the type of crawl schedule. - -The type must be one of the following values: Full or Incremental. - - -```yaml -Type: ContentSourceCrawlScheduleType -Parameter Sets: MonthlyDate, Weekly, RemoveSchedule -Aliases: -Accepted values: Full, Incremental, Full, Incremental -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: ContentSourceCrawlScheduleType -Parameter Sets: Daily -Aliases: -Accepted values: Full, Incremental, Full, Incremental -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the content source. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartAddresses -Specifies the comma-separated list of URLs at which to start a crawl for this content source. - -The type must be a valid URL, in the form http://server_name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Specifies the URL for the page to modify the settings for a custom content source. -The string that specifies the URL can contain a maximum of 1,024 characters. - -The type must be a valid URL, in the form http://server_name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeeklyCrawlSchedule -Base the schedule on weeks between crawls. - - -```yaml -Type: SwitchParameter -Parameter Sets: Weekly -Aliases: weekly -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.Office.Server.Search.Cmdlet.ContentSourcePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlDatabase.md deleted file mode 100644 index 209aa0d9ae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlDatabase.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchCrawlDatabase -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchCrawlDatabase - -## SYNOPSIS -Sets properties of a crawl database for a Search service application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchCrawlDatabase [-Identity] <CrawlStorePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-FailoverDatabaseServer <String>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [-DatabaseName <String>] - [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPEnterpriseSearchCrawlDatabase` cmdlet sets properties of a specified crawl database for a Search service application. -A crawl database stores crawl history for a Search service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SPEnterpriseSearchCrawlDatabase -Identity SearchApp_CrawlStore -SearchApplication $ssa -FailoverDatabaseServer \\failoverServer -``` - -This example sets the failover database server for the crawl database, SearchApp_CrawlStore, to the \\\\failoverServer server. - - -## PARAMETERS - -### -Identity -Specifies the crawl database to modify. - -A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object. - -```yaml -Type: CrawlStorePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the server to be used for failover when SQL Server mirroring is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application to which the crawl database applies. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to create for the crawl database. The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the Microsoft SQL Server database server. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the account name on the Database Server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlLogReadPermission.md deleted file mode 100644 index b6dd848a14..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlLogReadPermission.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchCrawlLogReadPermission -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchCrawlLogReadPermission - -## SYNOPSIS -Grants users permission to view the crawl log information. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchCrawlLogReadPermission [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Identity <CrawlLogReadPermissionPipeBind>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-Tenant <Guid>] [-UserNames <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Only the Search Service Application administrator can use this cmdlet. - -The administrator uses the `Set-SPEnterpriseSearchCrawlLogReadPermission` cmdlet to grant users permission to view crawl log information. -The administrator can choose to restrict the permission to crawl log information from a particular tenant. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$crawlLogPermission = Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant "00000000-0000-0000-0000-000000000001" -PS C:\>Set-SPEnterpriseSearchCrawlLogReadPermission -Identity $crawlLogPermission -SearchApplication $ssa -UserNames "user1;user2" -Tenant "00000000-0000-0000-0000-000000000001" -``` - -This example first defines $crawlLogPermission, which is the list of users who have permission to view the crawl log information from the tenant with id "00000000-0000-0000-0000-000000000001" on the search application referenced by $ssa. -Then the example uses the `Set-SPEnterpriseSearchCrawlLogReadPermission` cmdlet to add user1 and user2 to the list of users referenced by $crawlLogPermission. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the crawl log permissions list to which users should be added. - -```yaml -Type: CrawlLogReadPermissionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the crawl log. -The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the users shall be added to the crawl log permissions list within the scope of this tenant only. -The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserNames -Specifies the user names that shall be granted permission to view the crawl log information Use "domain\username" or "username". -When adding several user names, separate names with semi-colons. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchCrawlLogReadPermission](Get-SPEnterpriseSearchCrawlLogReadPermission.md) - -[Remove-SPEnterpriseSearchCrawlLogReadPermission](Remove-SPEnterpriseSearchCrawlLogReadPermission.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlRule.md deleted file mode 100644 index b7724b2fad..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchCrawlRule.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchCrawlRule -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchCrawlRule - -## SYNOPSIS -Sets properties for a crawl rule. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchCrawlRule [-AccountName <String>] [-AccountPassword <SecureString>] - [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationType <CrawlRuleAuthenticationType>] - [-Confirm] [-ContentClass <String>] [-CrawlAsHttp <Boolean>] [-FollowComplexUrls <Boolean>] - -Identity <CrawlRulePipeBind> [-IsAdvancedRegularExpression <Boolean>] [-PluggableSecurityTimmerId <Int32>] - [-Priority <Int32>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-SuppressIndexing <Boolean>] - [-Type <CrawlRuleType>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -A search administrator runs the `Set-SPEnterpriseSearchCrawlRule` cmdlet at initial search configuration or any other time, to set or update various attributes of a crawl rule. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$crawlRule = Get-SPEnterpriseSearchCrawlRule -Identity 'file://fileserver/root' -SearchApplication $ssa -PS C:\>Set-SPEnterpriseSearchCrawlRule -Identity $crawlRule -Type "ExclusionRule" -``` - -This example sets the type of the crawl rule pertaining to the URL, file://fileserver/root, to exclude this path from future crawls. - - -## PARAMETERS - -### -AccountName -Specifies the name of the account to be used to crawl content identified by the crawl rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountPassword -Specifies the password for AccountName. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies one of the following authentication types: - -- BasicAccountRuleAccess -Specifies basic authentication. - -- CertificateRuleAccess -Specifies the X.509 certificate name. - -- NTLMAccountRuleAccess -Specifies the account name for integrated authentication. - - -```yaml -Type: CrawlRuleAuthenticationType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentClass -Specifies a string that is sent to the protocol handler for any content that matches the crawl rule. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawlAsHttp -Specifies whether the crawler crawls content from a hierarchical content source as HTTP content. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FollowComplexUrls -Specifies whether the index engine crawls content from URLs that contain a question mark (?). - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of the crawl rule. - -The type must be a valid crawl rule URL, such as http://server_name, or an instance of a valid CrawlRule object. - - -```yaml -Type: CrawlRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsAdvancedRegularExpression -Specifies whether the rule has full regular expression syntax. - -The default value is False. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PluggableSecurityTimmerId -Specifies the ID of the custom pluggable security trimmer to use, if registered. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Defines where in the list of crawl rules this crawl rule is to be applied. - -The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -The name of the search application that is associated with the crawl rule to be modified. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressIndexing -Specifies whether the crawler excludes the content of items, to which this rule applies, from the content index. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of crawl rule. -A value of zero (0) includes the rule and a value of 1 excludes the rule. - - -```yaml -Type: CrawlRuleType -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchFileFormatState.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchFileFormatState.md deleted file mode 100644 index a40af55b62..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchFileFormatState.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchFileFormatState -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchFileFormatState - -## SYNOPSIS -Sets the activation state of a parser for a given file format. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchFileFormatState [-Identity] <DocumentParserFileFormatStatePipeBind> [-Enable] <Boolean> - -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [-UseIFilter <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPEnterpriseSearchFileFormatState` cmdlet sets the activation state of the parser that corresponds to the specified file format. -By default, the initial activation state of all file formats is $TRUE (enabled). -Use this cmdlet to temporarily disable a malfunctioning parser. -The system will only consider the change after a restart of the content processing components. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SPEnterpriseSearchFileFormatState -SearchApplication $ssa -Identity PDF -Enable $false -``` - -This example uses the `Set-SPEnterpriseSearchFileFormatState` cmdlet to disable the parser for the file format "PDF". - - -## PARAMETERS - -### -Identity -Specifies the identification of the format to be disabled or enabled. - - -```yaml -Type: DocumentParserFileFormatStatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Enable -Specifies the activation state of the parser that corresponds to the specified file format. -The activation state can be $FALSE (disabled) or $TRUE (enabled). - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseIFilter -Specifies use of a third-party iFilter when parsing the file format. UseIFilter can be $false (built-in format handler is used) or $TRUE (third-party iFilter is used). $false is the default value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchFileFormat](New-SPEnterpriseSearchFileFormat.md) - -[Get-SPEnterpriseSearchFileFormat](Get-SPEnterpriseSearchFileFormat.md) - -[Remove-SPEnterpriseSearchFileFormat](Remove-SPEnterpriseSearchFileFormat.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchLinguisticComponentsStatus.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchLinguisticComponentsStatus.md deleted file mode 100644 index f497498db8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchLinguisticComponentsStatus.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchLinguisticComponentsStatus -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchLinguisticComponentsStatus - -## SYNOPSIS -Sets the operation status of the linguistic query and document processing components. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchLinguisticComponentsStatus [-AllEnabled <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [-EntityExtractionEnabled <Boolean>] - [-Identity <LinguisticComponentsStatusPipeBind>] [-QuerySpellingEnabled <Boolean>] - -SearchApplication <SearchServiceApplicationPipeBind> [-StemmingEnabled <Boolean>] - [-ThesaurusEnabled <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet sets the operational status of the linguistic query and document processing components. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -StemmingEnabled $false -``` - -This example shows how to disable stemming during query processing by setting the parameter StemmingEnabled to false. - - -### ------------------EXAMPLE 2----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -AllEnabled $false -``` - -This example shows how to disable all linguistic query and document processing functionalities. - - -## PARAMETERS - -### -AllEnabled -A Boolean value to enable or deactivate all linguistic functionalities. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -EntityExtractionEnabled -A Boolean value to enable or deactivate the company extractor and all custom extractors during document processing. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -An object that represents the current status of the linguistic components. - - -```yaml -Type: LinguisticComponentsStatusPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -QuerySpellingEnabled -A Boolean value to enable or deactivate query spelling correction. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the linguistic processing components. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StemmingEnabled -A Boolean value to enable or deactivate expansive stemming during query processing. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThesaurusEnabled -A Boolean value to enable or deactivate thesaurus lookup during query processing. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchLinguisticComponentsStatus](Get-SPEnterpriseSearchLinguisticComponentsStatus.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchLinksDatabase.md deleted file mode 100644 index 50ffd7849b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchLinksDatabase.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchLinksDatabase -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchLinksDatabase - -## SYNOPSIS -Sets properties of a links database for a search service application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchLinksDatabase [-Identity] <LinksStorePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseName <String>] - [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] - [-FailoverDatabaseServer <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPEnterpriseSearchLinksDatabase` cmdlet sets properties of a specified links database for a search service application. -A links database stores query logging and analytics information. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp -PS C:\>Set-SPEnterpriseSearchLinksDatabase -Identity SearchApp_LinksStore -SearchApplication $ssa -FailoverDatabaseServer \\failoverServer -``` - -This example sets the failover database server to \\\\failoverServer for the links database SearchApp_LinksStore in the search service application mySearchServiceApp. - - -## PARAMETERS - -### -Identity -Specifies the links database to modify. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. - -```yaml -Type: LinksStorePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the links database name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password of the account to connect to the database. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the server to use for the host SQL database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the name of the account to connect to the database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the server to use for failover when using SQL Server mirroring. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the links database. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchLinksDatabase](New-SPEnterpriseSearchLinksDatabase.md) - -[Get-SPEnterpriseSearchLinksDatabase](Get-SPEnterpriseSearchLinksDatabase.md) - -[Remove-SPEnterpriseSearchLinksDatabase](Remove-SPEnterpriseSearchLinksDatabase.md) - -[Move-SPEnterpriseSearchLinksDatabases](Move-SPEnterpriseSearchLinksDatabases.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataCategory.md deleted file mode 100644 index 485c9c5820..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataCategory.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchMetadataCategory -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchMetadataCategory - -## SYNOPSIS -Sets properties of a crawled property category. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchMetadataCategory [-AssignmentCollection <SPAssignmentCollection>] - [-AutoCreateNewManagedProperties <Boolean>] [-Confirm] [-DiscoverNewProperties <Boolean>] - -Identity <CategoryPipeBind> [-MapToContents <Boolean>] [-Name <String>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a crawled property category when the search functionality is configured for the first time and after a new crawled property category is discovered during a crawl. -SPEnterpriseSearchMetadataCategory represents a category in the enterprise search metadata property schema. - -Note that a category may represent multiple propsets. -Changes to the category will overwrite all propsets. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SPEnterpriseSearchMetadataCategory -Identity People -SearchApplication $ssa -DiscoverNewProperties $false -MapToContents $false -``` - -This example sets both DiscoverNewProperties and MapToContents properties to False for the People category for the default search service application. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AutoCreateNewManagedProperties -Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. - -Note: -Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: auto -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverNewProperties -Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. - -Note: -Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the metadata category to update. - -The type must be a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - - -```yaml -Type: CategoryPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MapToContents -Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. - -Note: -Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: m -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the enterprise search metadata category. - -The type must be a valid name of a metadata category, for example MetadataCategory1. - -Note: -Null indicates that the value is unchanged. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the enterprise search metadata categories. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataCrawledProperty.md deleted file mode 100644 index 67a71db3fc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataCrawledProperty.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchMetadataCrawledProperty -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchMetadataCrawledProperty - -## SYNOPSIS -Sets the properties of a metadata crawled property. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchMetadataCrawledProperty [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -Identity <CrawledPropertyPipeBind> -IsMappedToContents <Boolean> [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a crawled property when the search functionality is configured for the first time and after any new crawled property is added to create the rules for the crawled property. -SPEnterpriseSearchMetadataCrawledProperty represents a crawled property in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$crawlprop = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name MyCrawlProp -PS C:\>Set-SPEnterpriseSearchMetadataCrawledProperty -Identity $crawlprop -IsMappedToContent $true -``` - -This example sets the IsMappedToContent parameter of the crawled property MyCrawlProp to false (see the example for the `New-SPEnterpriseSearchMetadataCrawledProperty` command) for the default search service application. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the crawled property to update. - -The type must be an instance of a valid CrawledProperty object. - - -```yaml -Type: CrawledPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMappedToContents -Specifies that the crawled property is mapped to managed properties. -Specify true to map a crawled property to a managed property. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: im -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataManagedProperty.md deleted file mode 100644 index f734fc27c6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataManagedProperty.md +++ /dev/null @@ -1,481 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchMetadataManagedProperty -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchMetadataManagedProperty - -## SYNOPSIS -Sets the properties of a metadata managed property. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchMetadataManagedProperty [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultForQueryIndependentRank <UInt32>] [-Description <String>] [-EnabledForQueryIndependentRank <Boolean>] - [-EnabledForScoping <Boolean>] [-FullTextQueriable <Boolean>] -Identity <ManagedPropertyPipeBind> - [-IncludeInAlertSignature <Boolean>] [-IncludeInMd5 <Boolean>] [-Name <String>] [-NameNormalized <Boolean>] - [-NoWordBreaker <Boolean>] [-RemoveDuplicates <Boolean>] [-RespectPriority <Boolean>] [-Retrievable <Boolean>] - [-SafeForAnonymous <Boolean>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-SiteCollection <Guid>] - [-Tenant <Guid>] [-UserFlags <Int16>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates the properties of a managed property. -It is typically used to change the name or description of a managed property. -SPEnterpriseSearchMetadataManagedProperty represents a managed property in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName -EnabledForScoping $true -``` - -This example sets the EnabledForScoping property to true for the managed property named UserName in the default search service application. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultForQueryIndependentRank -Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). - -Note: -Null indicates that the value is unchanged. - - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: def -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a description to the metadata managed property. - -The type must be a valid string. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForQueryIndependentRank -Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking. - -The type must be one of the following query-independent ranking features in the custom model XML: - -- queryIndependentFeature -- categoryFeature -- languageFeature - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: qir -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForScoping -Specifies that the managed property can be used in a scope definition. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullTextQueriable -Specifies that the managed property can be used in enterprise search SQL queries. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the managed property to update. - -The type must be a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object - - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeInAlertSignature -Specifies whether this managed property should be included in alert signature. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: ia -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeInMd5 -Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: im5 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the managed property. - -The type must be a valid managed property name, for example ManagedProperty1. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameNormalized -Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. -If value is set to true, the values are normalized. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: nn -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWordBreaker -Specifies that the values for this managed property are processed by a word breaker. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: nw -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDuplicates -Specifies that duplicate values for the managed property are removed. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: rd -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RespectPriority -Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. -Otherwise, all mapped crawled properties that have a value are copied. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: rp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Retrievable -Specifies whether the values for this managed property are retrievable or not. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeForAnonymous -Specifies whether it is acceptable to display the contents of the property in search results for anonymous searches. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: sfa -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the managed property collection. - -The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the managed properties returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserFlags -Reserved for future use. - -Note: Null indicates that the value is unchanged. - - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataMapping.md deleted file mode 100644 index 1f66cab586..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchMetadataMapping.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchMetadataMapping -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchMetadataMapping - -## SYNOPSIS -Sets the properties of a managed property mapping for a search service application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchMetadataMapping [-Identity] <MappingPipeBind> - [-SearchApplication <SearchServiceApplicationPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-CrawledProperty <CrawledPropertyPipeBind>] [-ManagedProperty <ManagedPropertyPipeBind>] - [-SiteCollection <Guid>] [-Tenant <Guid>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a managed property mapping. -SPEnterpriseSearchMetadataMapping represents a mapping between a managed property and one or more crawled properties in the enterprise search metadata property schema. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>## get the crawl property to set to, in this case a new property is created -PS C:\>$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People -PS C:\>$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Category $cat -Limit 1 -PS C:\>$ncp = New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name "MyNewCrawlProp" -PropSet $cp.PropSet -Category $cp.CategoryName -IsNameEnum $false -VariantType $cp.VariantType -IsMappedToContents $true -PS C:\>## get the mapping to replace -PS C:\>$mycp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name MyCrawlProp -PS C:\>$map = Get-SPEnterpriseSearchMetadataMapping -SearchApplication $ssa -ManagedProperty $mp -CrawledProperty $mycp -## set the new crawl property to map to for this mapping -PS C:\>Set-SPEnterpriseSearchMetadataMapping -Identity $map -SearchApplication $ssa -CrawledProperty $ncp -``` - -This example updates an existing mapping between the managed property UserName and the crawled property MyCrawlProp (see `New-SPEnterpriseSearchMetadataMapping`) for the default search service application. -The crawled property is replaced with a new crawled property named MyNewCrawlProp. - - -## PARAMETERS - -### -Identity -Specifies the metadata mapping to update. - -The type must be a valid URL, in the form http://server_name, or an instance of a valid Mapping object. - -```yaml -Type: MappingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the metadata mapping. - -The type be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrawledProperty -Specifies the crawled property to map. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form http://server_name, or an instance of a valid CrawledProperty object. - -Note: Null indicates that the value is unchanged. - -```yaml -Type: CrawledPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedProperty -Specifies the managed property to receive the crawled property mapping. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. - -Note: Null indicates that the value is unchanged. - -```yaml -Type: ManagedPropertyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollection -Specifies that the metadata mappings returned are to be within the scope of a site collection (SPSite). - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies that the metadata mappings returned are to be within the scope of a tenant. - -The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchPrimaryHostController.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchPrimaryHostController.md deleted file mode 100644 index 4118280aa9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchPrimaryHostController.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchPrimaryHostController -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchPrimaryHostController - -## SYNOPSIS -Sets the primary search host controller for the farm. - -## SYNTAX - -``` -Set-SPEnterpriseSearchPrimaryHostController [-SearchServiceInstance] <SearchServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet sets the primary SearchHostController for the farm to the defined SearchHostController. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -Local -PS C:\>Set-SPEnterpriseSearchPrimaryHostController $si -``` - -This example sets the local SearchHostController instance as the new primary SearchHostController. -It is up to the user to select the HostController with latest version available. - -If you choose a SearchHostController that is not running the latest version of the repository, you will have to confirm before you continue. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -Local -PS C:\>Set-SPEnterpriseSearchPrimaryHostController $si -Force -``` - -This example sets the local SearchHostController instance as the new primary SearchHostController. - -If you choose a SearchHostController that is not running the latest version of the repository, you will not get a confirmation message before you continue. - - -## PARAMETERS - -### -SearchServiceInstance -SearchServiceInstance of the server from where the SearchHostController object is returned. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force the change of the primary SearcHostController. -No confirmation messages are asked, even if user tries to set primary to a SearchHostController not running the latest version of the repository. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryAuthority.md deleted file mode 100644 index b8062faacb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryAuthority.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchQueryAuthority -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchQueryAuthority - -## SYNOPSIS -Sets the properties of an authoritative page for a shared search application. - -## SYNTAX - -``` -Set-SPEnterpriseSearchQueryAuthority [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - -Identity <AuthorityPagePipeBind> [-Level <Single>] -Owner <SearchObjectOwner> - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPEnterpriseSearchQueryAuthority` cmdlet updates properties of an authoritative page and adjusts the query rank of an authoritative page. -SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher in relevance than demoted sites, which are de-emphasized in relevance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Set-SPEnterpriseSearchQueryAuthority -Identity http://contoso.com -Level 0.5 -SearchApplication MySSA -``` - -This example adjusts the authoritative level of the URL http://contoso.com to 0.5 on the search service application named MySSA. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the query authority page to update. - -The type must be a valid URL, in the form http://server_name; or an instance of a valid AuthorityPage object. - - -```yaml -Type: AuthorityPagePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Level -Specifies the level of the new authoritative page. -Authoritative pages, designated by the service application administrator, are expert pages that link to the most relevant information. -Because a search service application can have several designated authoritative pages, you use the Level property to specify the value of a specific page. -This parameter sets the level for the most valuable authoritative pages to 0. - -The type must be one of the following floating-point numbers: 0, 1, or 2. - - -```yaml -Type: Single -Parameter Sets: (All) -Aliases: l -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the authority page collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryKeyword.md deleted file mode 100644 index aaf178bd5c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryKeyword.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchQueryKeyword -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchQueryKeyword - -## SYNOPSIS -Sets the properties of a keyword term for a shared search application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchQueryKeyword [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Contact <String>] [-Definition <String>] [-EndDate <DateTime>] -Identity <KeywordPipeBind> - [-ReviewDate <DateTime>] -Site <SPSitePipeBind> [-StartDate <DateTime>] [-Term <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPEnterpriseSearchQueryKeyword` cmdlet updates properties and rules of a keyword term. -A query keyword is a query component of a query topology. -SPEnterpriseSearchQueryKeyword represents relevance setting through keywords. - -You can use this cmdlet for keywords in site collections that are in SharePoint Server mode. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site http://myserver/sites/engineering | Set-SPEnterpriseSearchQueryKeyword -StartDate "12/25/2009" -EndDate "12/24/2010" -Site http://myserver/sites/engineering -``` - -This example gets a reference to the keyword with the term Engineering from the site http://myserver/sites/engineering and sets the start dates and end dates for the keyword. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Contact -Specifies the user name associated with the new keyword. - -The type must be a valid user name; for example, KeywordUser1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Definition -Specifies the definition of the new keyword term. - -The type must be a valid string; for example, a keyword term definition. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -Specifies the expiration date of the keyword term. -The default value is MaxDate. - -The type must be a valid DateTime type, in the form 2010,12,05. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the keyword term to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. - - -```yaml -Type: KeywordPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReviewDate -Specifies the review date of the keyword term. -The default value is MaxDate. - -The type must be a valid DateTime type, in the form 2010,12,05. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Associates the new keyword term to the specified results URL. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Specifies the activation date for the keyword term. -The default value is the current date. - -The type must be a valid date, in the form 2010,12,05. - - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Term -Specifies the keyword term that triggers keyword results. - -The type must be a valid string; for example, a keyword term. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryScope.md deleted file mode 100644 index 9fb6e90471..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryScope.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchQueryScope -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchQueryScope - -## SYNOPSIS -Sets the properties of a query results scope for a shared search application. - -## SYNTAX - -``` -Set-SPEnterpriseSearchQueryScope -AlternateResultsPage <String> - [-AssignmentCollection <SPAssignmentCollection>] [-CompilationType <Int32>] [-Confirm] [-Description <String>] - [-DisplayInAdminUI <Boolean>] -Identity <ScopePipeBind> [-Name <String>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-Url <Uri>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -After you upgrade a Search service application to SharePoint Server, you can view shared scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for shared scopes after upgrade. -However, you can convert shared scopes to result sources, which serve a similar purpose. -Similarly, after you upgrade to Sharepoint Server Site Collection to SharePoint Server mode, you can view local scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. -However, you can convert local scopes to result sources, which serve a similar purpose. - -The `Set-SPEnterpriseSearchQueryScope` cmdlet updates properties of a shared scope. -SPEnterpriseSearchQueryScope represents a query results scope used by all shared search applications on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPenterpriseSearchServiceApplication -PS C:\>Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage http://altServer -``` - -This example obtains a reference to the scope named MustCrawl on the search service application named MySSA and changes the description, compilation type and alternate access URL. - - -## PARAMETERS - -### -AlternateResultsPage -Specifies the location to display results for the new query scope. - -The type must be a valid URL, in the form http://server_name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompilationType -Specifies the compilation type of the new scope. -The value 0 specifies the conditionally compiled scope type, and the value 1 specifies the always compiled scope type. - -The type must be either of the following: 0 or 1. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: type -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a description of the new query scope. - -The type must be a valid string; for example, a description of a query scope. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayInAdminUI -Specifies that the new scope is displayed in the administration application user interface (UI). -The default setting is to hide the new scope in the administration application UI. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: disp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of the scope to create. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the query scope. - -The type must be a valid name of a query scope; for example, QueryScope1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Filters to delete scopes for the specified results URL. - -The type must be a valid URL, in the form http://server_name. - - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryScopeRule.md deleted file mode 100644 index 6ff25ff949..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQueryScopeRule.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchQueryScopeRule -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchQueryScopeRule - -## SYNOPSIS -Sets the properties of a shared scope rule for a query scope. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchQueryScopeRule [-Identity] <ScopeRulePipeBind> -Url <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-FilterBehavior <String>] - [-ManagedPropertyName <String>] [-MatchingString <String>] [-PropertyValue <String>] [-Scope <ScopePipeBind>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-UrlScopeRuleType <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -After you upgrade a Search service application SharePoint Server, you can view shared scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for shared scopes after upgrade. -However, you can convert shared scopes to result sources, which serve a similar purpose. -Similarly, after you upgrade a SharePoint Server site collection to SharePoint Server mode, you can view local scopes, but you cannot create, update, or delete them. -Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. -However, you can convert local scopes to result sources, which serve a similar purpose. - -The `Set-SPEnterpriseSearchQueryScopeRule` cmdlet updates the properties of a query scope. -SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can be applied to a scope. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa -PS C:\>Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url http://criticalSite | Set-SPEnterpriseSearchQueryScopeRule -Url http://criticalSite -UrlScopeRuleType Url -``` - -This example gets a reference to a scope rule for the URL http://criticalSite and sets its rule type to Url. - - -## PARAMETERS - -### -Identity -Specifies the scope rule to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance a valid ScopeRule object. - -```yaml -Type: ScopeRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Specifies the results URL that is associated with the query scope rule. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterBehavior -Specifies the type of scope rule to create for the query scope. - -The type must be one of the following values: Exclude, Include, or Require. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedPropertyName -Specifies the name of the managed property to use for the PropertyQuery scope rule. - -The type must be a valid name of a managed property; for example, ManagedProp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: mname -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchingString -Specifies the string to use when matching the URL rule type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: text -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyValue -Specifies the property value to use when matching the PropertyQuery rule type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: value -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Applies the query scope rule to the specified scope. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - -```yaml -Type: ScopePipeBind -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the query scope rule collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlScopeRuleType -Specifies the value to use when matching the URL rule type. - -The type must be one of the following values: Folder, HostName, or Domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ut -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQuerySpellingCorrection.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQuerySpellingCorrection.md deleted file mode 100644 index ea27d7a9a1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchQuerySpellingCorrection.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchQuerySpellingCorrection -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchQuerySpellingCorrection - -## SYNOPSIS -Sets the operation status of the Query Spelling Corrections (QSC) component. - -## SYNTAX - -``` -Set-SPEnterpriseSearchQuerySpellingCorrection [-AssignmentCollection <SPAssignmentCollection>] - [-ContentAlignmentEnabled <Boolean>] [-DiacriticsInSuggestionsEnabled <Boolean>] - [-Identity <QuerySpellingCorrectionPipeBind>] [-MaxDictionarySize <Int32>] [-MaxProcessingTime <TimeSpan>] - -SearchApplication <SearchServiceApplicationPipeBind> [-SecurityTrimmingEnabled <Boolean>] - [-SpellingDictionary <SpellingDictionaryType>] [-TermFrequencyThreshold <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet provides access to the configuration options for the QSC component. -The two most prominent configuration options are the switch to enable the content-alignment process and the selection of dictionaries to be used for query spelling correction, that is the set of fixed dictionaries per language or the dynamic dictionary that is being produced by the content alignment process. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>Set-SpEnterpriseSEarchQuerySpellingCorrection -SearchApplication $ssa -SpellingDictionary dynamic -``` - -This example sets the dictionary named dynamic to be used for query spelling correction for the default search service application. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContentAlignmentEnabled -A Boolean value to enable or deactivate the content alignment process. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiacriticsInSuggestionsEnabled -A switch to enable or disable spelling suggestions that contain diacritics (for example, German umlaut umlaut). -The default setting is true. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an object that represents the current status for the query spelling correction. - - -```yaml -Type: QuerySpellingCorrectionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaxDictionarySize -Specifies the maximal number of terms in a content-aligned spelling dictionary. -In a multi-tenant environment, this number is valid per tenant. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxProcessingTime -Specifies the maximum runtime for compiling a content-aligned spelling dictionary. -The default value is 6 hours. - - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search service application that contains the QSC components. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecurityTrimmingEnabled -A Boolean value to enable or deactivate the security check for spelling suggestions. -If enabled, only spelling suggestions that deliver at least one document for the current user are shown. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpellingDictionary -Specifies the dictionary to be used for query spelling correction. -The two available values are dynamic and static. -When value is set to dynamic, the query spelling correction uses the content-aligned dictionary. -When value is set to static, the query spelling correction uses the out of the box static spelling dictionaries. - - -```yaml -Type: SpellingDictionaryType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TermFrequencyThreshold -Specifies the minimum number of documents that must contain the most frequently used term in the document collection for the content-alignment process to be executed. -In a multi-tenant environment, this number is valid per tenant. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchRankingModel.md deleted file mode 100644 index 5304090c93..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchRankingModel.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchRankingModel -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchRankingModel - -## SYNOPSIS -Sets the properties of a ranking model for a shared search service application. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchRankingModel [-Identity] <RankingModelPipeBind> -Owner <SearchObjectOwner> - -RankingModelXML <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a ranking model for a search service application. -The name, description, and identifier (ID) for a ranking model are contained in the .xml file specified in RankingModelXML. -If the Identity parameter is not specified or the identity does not match any of the ranking models in the collection, an exception is thrown and the default ranking model is used. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level ssa -PS C:\>$rankingModel = Get-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 -SearchApplication $ssa -Owner $owner -PS C:\>$newrankmodel = Get-Content .\newRankModel.xml -PS C:\>$newrankmodel = [String]$newrankmodel -PS C:\>Set-SPEnterpriseSearchRankingModel -Identity $rankingModel -SearchApplication $ssa -Owner $owner -RankingModelXML $newrankmodel -``` - -This example reconfigures the ranking model with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 with the new ranking model specified in newRankModel.xml. - - -## PARAMETERS - -### -Identity -Specifies the ranking model to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid RankingModel object. - -```yaml -Type: RankingModelPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the scope where the ranking model is available. -The available scopes are: SSA, Tenant, Site Collection or Site. -A ranking model can be available in multiple scopes. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RankingModelXML -Specifies the name of the XML representation of the new ranking model. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application that contains the ranking model. - -The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchResultItemType.md deleted file mode 100644 index a6148a7c2c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchResultItemType.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchResultItemType -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchResultItemType - -## SYNOPSIS -Sets properties of a result item type. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchResultItemType [-Identity] <ResultItemTypePipeBind> -Owner <SearchObjectOwner> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DisplayProperties <String>] - [-DisplayTemplateUrl <String>] [-Name <String>] [-OptimizeForFrequentUse <Boolean>] [-RulePriority <Int32>] - [-Rules <PropertyRuleCollection>] [-SearchApplication <SearchServiceApplicationPipeBind>] - [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>] [-SourceID <Guid>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPEnterpriseSearchResultItemType` cmdlet sets properties of user-created result item types. -You cannot use this cmdlet to set or change properties of the built-in result item types that are included with SharePoint products. - -Result item types enable you to change the look of search results based on the type of result. -You start by defining a collection of rules, which will be evaluated against the properties of results. -Then you define the display template to use for rendering that type of result. -Once you have created the result item type, results matching the rules of the result item type will render using the specified display template. - -Example use cases: - -- Change the look of results for a particular file name extension, for example Word documents. -- Change the look of a particular content type in search results. -- Change the look of results from a particular author. -- Add a result action to results from a particular result source as part of a custom search application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$web = Get-SPWeb http://webUrl -PS C:\>$tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$resultType = Get-SPEnterpriseSearchResultItemType -Owner $tenantOwner -SearchApplication $ssa -PS C:\>$resultType.BuiltIn -PS C:\>$rule = Get-SPEnterpriseSearchPropertyRule -PropertyName "ContentTypeId" -Operator "StartsWith" -PS C:\>$rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') -PS C:\>$ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection -PS C:\>$ruleCollection.Add($rule) -PS C:\>$displayProperties = "WorkId,Rank,Title,Size,Path,Description,SiteName,HitHighlightedSummary,HitHighlightedProperties,ViewsLifeTime" -PS C:\>$displaytemplateUrl = "~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_MyCustomDisplayTemplate.js" -PS C:\>Set-SPEnterpriseSearchResultItemType --Identity $resultType ` --SearchApplication $ssa ` --Name "CustomResultType" ` --Rules $ruleCollection ` --RulePriority 1 --DisplayProperties $displayProperties ` --DisplayTemplateUrl $displaytemplateUrl ` --Owner $tenantOwner -``` - -This example first defines variables for the URL of the site, the search owner and search application. -It retrieves the result item type and checks whether the result item type is a built-in result item type. -If $resultType.BuiltIn returns false then the result item type is not built-in and you can set its properties by using the `Set-SPEnterpriseSearchResultItemType`. - -Next, the example creates the rule that result item types shall be matched against and adds it to a property rule collection. - -Next, the example defines which properties of the result item type that shall be displayed and the display template to use. - -Finally, the example uses the `Set-SPEnterpriseSearchResultItemType` cmdlet to modify the result item type. - - -## PARAMETERS - -### -Identity -Specifies the result item type to update. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: ResultItemTypePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the result item type was created. - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayProperties -Specifies which result properties to display. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dp -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayTemplateUrl -Specifies the URL of the display template that shall be used for rendering the results. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the result item type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: n -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptimizeForFrequentUse -{{ Fill OptimizeForFrequentUse Description }} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: opt -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RulePriority -Specifies which priority the collection of rules has compared to other rules. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: priority -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rules -Specifies the collection of rules to evaluate the result properties against. - -```yaml -Type: PropertyRuleCollection -Parameter Sets: (All) -Aliases: rule -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the name of the search application. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplicationProxy -Specifies the proxy of the search application that contains the result item type. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SourceID -Identifies the search result source that the result item type applies to. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: sid -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchResultItemType](New-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchResultItemType](Get-SPEnterpriseSearchResultItemType.md) - -[Remove-SPEnterpriseSearchResultItemType](Remove-SPEnterpriseSearchResultItemType.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) - -[Get-SPEnterpriseSearchPropertyRule](Get-SPEnterpriseSearchPropertyRule.md) - -[Get-SPEnterpriseSearchPropertyRuleCollection](Get-SPEnterpriseSearchPropertyRuleCollection.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchResultSource.md deleted file mode 100644 index e9e46013f4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchResultSource.md +++ /dev/null @@ -1,452 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchResultSource -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchResultSource - -## SYNOPSIS -Sets properties of a result source. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchResultSource [-AssignmentCollection <SPAssignmentCollection>] - [-AuthenticationType <FederationAuthType>] [-AutoDiscover <Boolean>] [-Confirm] [-Description <String>] - -Identity <ResultSourcePipeBind> [-MakeDefault <Boolean>] [-Name <String>] [-Owner <SearchObjectOwner>] - [-Password <String>] [-ProviderId <Guid>] [-QueryTemplate <String>] [-RemoteUrl <String>] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-SsoId <String>] [-UserName <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a user-created result source. -This cmdlet supports the same update operations as are supported through the "Manage Result Sources" page in Central Administration. -The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true) for any update operation other than changing the default result source using the MakeDefault parameter. - For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>$customResultSource = New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -ProviderId fa947043-6046-4f97-9714-40d4c113963d -Name "Custom SharePoint Result Source" -PS C:\>Set-SPEnterpriseSearchResultSource -Identity $customResultSource -Name "Basic SharePoint Result Source" -``` - -This example updates the name of the result source and the identity of the result source is specified as a result source instance. -SearchApplication and Owner are not required for this update operation. - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$owner = Get-SPEnterpriseSearchOwner -Level SSA -PS C:\>$customResultSource = New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -ProviderId fa947043-6046-4f97-9714-40d4c113963d -Name "Custom SharePoint Result Source" -PS C:\>Set-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -Identity "Custom SharePoint Result Source" -Description "A custom SharePoint Result Source for demonstration purposes" -``` - -This example updates the description of the result source and the identity of the result source is specified by name. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies an authentication type for the result source. If parameter is not specified, the value is unchanged. - -A specific set of authentication types are supported for each search provider type and if parameter is not specified, the authentication type will default based on search provider type. - -This cmdlet supports the following set of authentication mechanisms and corresponding types: Default SharePoint Authentication (FederationAuthType.LocalNTAuth), Basic Authentication (FederationAuthType.SingleAccountBasicAuth - specify UserName and Password), Default Remote SharePoint Authentication (FederationAuthType.PerUserBasicAuth), Single Sign On (FederationAuthType.SSO - requires SsoId to be specified), Anonymous (FederationAuthType.Anonymous), Digest Authentication (FederationAuthType.SingleAccountDigest - specify UserName and Password), NTLM Application Pool Identity (FederationAuthType.ApplicationPoolIdentity), NTLM User Name and Password (FederationAuthType.SingleAccountNTLM - specify UserName and Password). - -When using a Local SharePoint Search/Local SharePoint People Search provider, then FederationAuthType.LocalNTAuth (default) and FederationAuthType.SingleAccountBasicAuth are supported. - -When using a Remote SharePoint Search/Remote SharePoint People Search provider, then FederationAuthType.PerUserBasicAuth (default) and FederationAuthType.SSO are supported. - -When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. - -All authentication types are listed in the enum FederationAuthType. - - -```yaml -Type: FederationAuthType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoDiscover -Specifies whether to use automatic discovery of the Exchange server endpoint for the result source. - -Setting value to true ($true) states that automatic discovery should be used. - -If parameter is not specified, the value is unchanged. - -Only applicable when using an Exchange search provider. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the result source. - -If parameter is not specified, the value is unchanged. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the result source to update. - -The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Custom SharePoint Result Source"); or an instance of a valid Source object. - - -```yaml -Type: ResultSourcePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MakeDefault -Specifies whether the result source should be set as default result source or not, for the scope specified by the Owner parameter. - -If parameter is not specified, the default result source will not change. - -Setting value to true ($true) states that the result source should be set as default. - -Setting value to false ($false) states that the result source should not be set as default and in this case, if the result source to update is currently the default, the original default result source ("Local SharePoint Results") will be set as default again. - -Tip: Use instance, not name or GUID string Id, as Identity when using Makedefault, to clearly specify that Owner is only to be used for specifying the level where the result source should be set as default (if value is true) or where the default should be reset to original (if value is false). - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the result source. - -If parameter is not specified, the value is unchanged. - -Names must be unique at each administrative level. - -For example, two result sources in a site cannot share a name, but one in a site and one provided by the site collection can. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. - - -```yaml -Type: SearchObjectOwner -Parameter Sets: (All) -Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the user credentials to use to connect to the result source. - -If parameter is not specified, the value is unchanged. - -Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId -Specifies a search provider to be used by the result source. - -If parameter is not specified, the value is unchanged. - -Is specified as a Guid or GUID string, which must be one of the following: FA947043-6046-4F97-9714-40D4C113963D (Local SharePoint Search), E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local SharePoint People Search), 1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (Remote SharePoint Search), E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (Remote SharePoint People Search), 3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search), 3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1). - - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryTemplate -Specifies the query transformation template of the result source. - -If parameter is not specified, the value is unchanged. - -Incoming queries are changed according to the template, to use this new query text instead. -Include the incoming query in the new text by using the query variable "{searchTerms}". -Use this to scope results. - -For example, to only return OneNote items, set the new text to "{searchTerms} fileextension=one". -Then, an incoming query "sharepoint" becomes "sharepoint fileextension=one". -Default value is {searchTerms}. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteUrl -Specifies a connection URL template for the result source. - -If parameter is not specified, the value is unchanged. - -Must be set when using a search provider that consumes it: Remote SharePoint Search, Remote SharePoint People Search, OpenSearch 1.0/1.1, and Exchange (if AutoDiscover is not turned on). - -When using other search providers the parameter is ignored. - -For Remote SharePoint Search/Remote SharePoint People Search, specify the address of the root site collection of the remote SharePoint farm. - -For OpenSearch 1.0/1.1, specify the URL of the OpenSearch source. - -Include the query in the URL by using the query variable "{searchTerms}", which will be automatically replaced with the query. -For Exchange, specify the Exchange EWS URL from which to retrieve results. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SsoId -Specifies the reverse proxy certificate Secure Store Id to use to connect to the result source. - -If parameter is not specified, the value is unchanged. - -Must be specified if authentication type (AUthenticationType) is set to FederationAuthType.SSO (Single Sign On). - -If you are connecting to your intranet through a reverse proxy, enter the SSO Id of the Single Sign On entry which stores the certificate used to authenticate against the reverse proxy. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the user name of the user credentials to use to connect to the result source. - -If parameter is not specified, the value is unchanged. - -Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPEnterpriseSearchResultSource](New-SPEnterpriseSearchResultSource.md) - -[Get-SPEnterpriseSearchResultSource](Get-SPEnterpriseSearchResultSource.md) - -[Remove-SPEnterpriseSearchResultSource](Remove-SPEnterpriseSearchResultSource.md) - -[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchService.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchService.md deleted file mode 100644 index 64d54cb5b7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchService.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchService -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchService - -## SYNOPSIS -Sets the properties of a search service for a farm. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchService [[-Identity] <SearchServicePipeBind>] [-AcknowledgementTimeout <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ConnectionTimeout <String>] - [-ContactEmail <String>] [-IgnoreSSLWarnings <String>] [-InternetIdentity <String>] - [-PerformanceLevel <String>] [-ProxyType <String>] [-ServiceAccount <String>] - [-ServicePassword <SecureString>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a search service for a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$password = Read-Host -AsSecureString -PS C:\>Set-SPEnterpriseSearchService -IgnoreSSLWarnings $true -ServiceAccount 'contoso\adminAccount' -ServicePassword $password -``` - -This example configures the search service to ignore SSL warnings and changes the service account for the search service. - - -## PARAMETERS - -### -Identity -Specifies the search service to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchService1); or an instance of a valid SearchService object. - -```yaml -Type: SearchServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AcknowledgementTimeout -Specifies the time in seconds that the search server will wait for request acknowledgement while connecting to other services. - -The type must be string input that can be parsed to an integer value. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionTimeout -Specifies the time in seconds that the search server waits while connecting to other services. - -The type must be string input that can be parsed to an integer value. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactEmail -Specifies an e-mail address to which external site administrators can write if problems occur when the site is being crawled. - -The type must be a valid e-mail address, in the form MyAddress@mycompany.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSSLWarnings -Specifies that the search service will ignore Secure Sockets Layer (SSL) certificate name warnings. -The default value is False. - -The type must be a string that can be cast to a Boolean value, for example, True or False. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternetIdentity -Specifies the value that the crawler sends in the headers of its HTTP requests to sites when it fetches their pages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerformanceLevel -Specifies the relative number of threads for the indexer performance: - -Reduced: Total number of threads = number of processors, Max Threads/host = number of processors - -Partly Reduced: Total number of threads = 4 times the number of processors , Max Threads/host = 16 time the number of processors - -Maximum: Total number of threads = number of processors - -The type must be one of the following values: Reduced, PartlyReduced, or Maximum. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyType -Specifies whether the search service uses a proxy server or connects directly when crawling content. -The default value is Direct, (No proxy server is used). - -The type must be one of the following values: Direct or Proxy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccount -Specifies the user account or service account to use for running the Office Server Search service. -When this parameter is used, the ServicePassword parameter must also be specified. - -The type must be a valid account name on the domain, in the form Domain\user name or user name. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePassword -Specifies the password for the service account specified in ServiceAccount. - -The type must contain the domain password to the account specified in the ServiceAccount parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index e5e62eeea7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Sets the properties of a search service application for a farm. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchServiceApplication [-AdminApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] - [-DatabaseUsername <String>] [-DefaultContentAccessAccountName <String>] - [-DefaultContentAccessAccountPassword <SecureString>] [-DefaultSearchProvider <SearchProvider>] - [-DiacriticSensitive <String>] [-FailoverDatabaseServer <String>] -Identity <SearchServiceApplicationPipeBind> - [-VerboseQueryMonitoring <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a search service application. -SPEnterpriseSearchServiceApplication represents a self-contained aggregation of indexed content and properties available for search and provides an anchor class for setting global search properties. -A search application can include multiple search service applications. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Set-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -VerboseQueryMonitoring True -``` - -This example turns on verbose query logging in the default search service application named Search Service Application. - - -## PARAMETERS - -### -AdminApplicationPool -Specifies the application pool for the administrative web service for the search service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AdminAppPool1); or an instance of a valid IISWebServiceApplicationPool object. - - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies an application pool for the search service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPool1); or an instance of a valid IISWebServiceApplicationPool object. - - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -This parameter is obsolete and has no function. -You should not use this parameter. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user ID that is used for accessing the web service administration database on SQL Server. - - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the web service administration database. - -The type must be a valid SQL Server host name, for example, SQLServerHost1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user ID to use for accessing the web service administration database. - -The type must be a valid user name, for example, WebAdminUserDB1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultContentAccessAccountName -Specifies the account ID to use for accessing content. - -The type must be a valid user name, for example, ContentAccessUser1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultContentAccessAccountPassword -Specifies the password for the content access account. - -The type must be a valid password. - - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSearchProvider -Specifies the search application type to be used for this application. -This parameter has been deprecated for SharePoint Server. - - -```yaml -Type: SearchProvider -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiacriticSensitive -Specifies that the search application respects diacritics (for example, ä). -The default value is false. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host SQL instance for the failover database server. - -The type must be a valid SQL Server instance name, for example, SQLServerHost1. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the search service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object. - - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VerboseQueryMonitoring -Enables verbose query logging. -The default value is False. - -The type must be a string that can be cast to a Boolean value, for example, True or False. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceApplicationProxy.md deleted file mode 100644 index 46b5421a4e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceApplicationProxy.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchServiceApplicationProxy - -## SYNOPSIS -Sets properties of a search service application proxy. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchServiceApplicationProxy [-Identity] <SearchServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of a site administration service application proxy for a search application. -SPEnterpriseSearchServiceApplicationProxy represents the proxy for search site administration functionality. -One search service application proxy exists for each search application on a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceApplicationProxy -Identity SsaProxy | Set- SPEnterpriseSearchServiceApplicationProxy -Name ContosoSearchProxy -``` - -This example sets the display name of a search service application proxy. - - -## PARAMETERS - -### -Identity -Specified the search service application proxy to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. - -```yaml -Type: SearchServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the search application proxy to retrieve. - -The type must be a valid string, for example, SearchAppProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceInstance.md deleted file mode 100644 index 2c59780709..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchServiceInstance.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchServiceInstance -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchServiceInstance - -## SYNOPSIS -Sets the properties of a search service instance. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchServiceInstance [-Identity] <SearchServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultIndexLocation <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet updates properties of the search service instance for a farm. - - For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$si = Get-SPEnterpriseSearchServiceInstance -Local -PS C:\>Set-SPEnterpriseSearchServiceInstance -Identity $si -DefaultIndexLocation F:\SearchIndex -``` -Sets the default index location to F:\SearchIndex. - -## PARAMETERS - -### -Identity -Specifies the search service instance to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultIndexLocation -> [!NOTE] -> On SharePoint Server 2013 and SharePoint Server 2016, SharePoint Server 2019 this parameter is obsolete and has no function. You should not use this parameter. - -Specifies the default path to use for creating an index of content. - -The type must be a valid path in either of the following forms: - -- C:\folder_name - -- \\\\server_name\folder_name - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.Office.Server.Search.Cmdlet.SearchServiceInstancePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchTopology.md deleted file mode 100644 index c1878d32bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPEnterpriseSearchTopology.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPEnterpriseSearchTopology -schema: 2.0.0 ---- - -# Set-SPEnterpriseSearchTopology - -## SYNOPSIS -Activates a given search topology. - - -## SYNTAX - -``` -Set-SPEnterpriseSearchTopology [-Identity] <SearchTopologyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet enables the search topology with the given identity, marking the currently active search topology as inactive. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e -PS C:\>Set-SPEnterpriseSearchTopology -Identity $topology -SearchApplication $ssa -``` - -This example enables a search topology with the Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -PS C:\>$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa | ?{$_.State -eq 'Inactive'} -PS C:\>Set-SPEnterpriseSearchTopology -Identity $topology -SearchApplication $ssa -``` - -This example retreives an inactive topology and sets it to the active topology. - -## PARAMETERS - -### -Identity -Specifies the search topology to enable. - -```yaml -Type: SearchTopologyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchApplication -Specifies the search application to which the search topology will belong. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPEnterpriseSearchTopology](Get-SPEnterpriseSearchTopology.md) - -[New-SPEnterpriseSearchTopology](New-SPEnterpriseSearchTopology.md) - -[Remove-SPEnterpriseSearchTopology](Remove-SPEnterpriseSearchTopology.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelBIServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelBIServer.md deleted file mode 100644 index fa60a52a27..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelBIServer.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Set-SPExcelBIServer -schema: 2.0.0 ---- - -# Set-SPExcelBIServer - -## SYNOPSIS - -Specifies a description for an existing BI server for Excel Services. - -## SYNTAX - -``` -Set-SPExcelBIServer [-Identity] <SPExcelBIServerPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Description <String>] -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> - [-ServerId <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPExcelBIServer cmdlet to specify a description for an existing BI server for Excel Services. - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'} -PS C:\>Set-SPExcelBIServer -Identity "ExcelServices" -ExcelServiceApplication $sa -``` - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the Analysis server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the ExcelServiceApplication identity. - -```yaml -Type: SPExcelBIServerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerId -The name of the Analysis Services server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Office.Excel.Server.Cmdlet.SPExcelBIServerPipeBind -Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelDataConnectionLibrary.md deleted file mode 100644 index d4ab49e142..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelDataConnectionLibrary.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Set-SPExcelDataConnectionLibrary -schema: 2.0.0 ---- - -# Set-SPExcelDataConnectionLibrary - -## SYNOPSIS -Sets properties of a data connection library for Excel Services Application. - - -## SYNTAX - -``` -Set-SPExcelDataConnectionLibrary [-Identity] <SPExcelDCLPipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-Address <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPExcelDataConnectionLibrary` cmdlet sets the properties of a library from which Excel Services Application loads data connection files. -Excel Services Application loads data connection files only if they are stored in a data connection library that is on the list of trusted data connection libraries. -Data connection libraries constitute a kind of list that contains data connection files. -These files contain everything that Excel Services Application and the Excel client require to connect to an external data source. -Data connection libraries enable you to reuse and share data connections. -Data connections can be loaded by using information from the workbook file. -However, using a data connection library to load data connections provides an additional layer for data connections so that they can be managed separately from workbooks. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.address -eq "http://portal/site/salesDCL" } | Set-SPExcelDataConnectionLibrary -Description "This is the DCL where all the connections to the sales data are stored -``` - -This example sets a display description for the entry http://portal/site/salesDCL in the list of trusted data connection libraries (DCLs) that is on the Excel Services Application Web service application named MyExcelService. - - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.address -eq "http://portal/site/salesDCL" } | Set-SPExcelDataConnectionLibrary -Address "http://portal/site/salesDCL-%60%60%60--This%20example%20updates%20the%20address%20of%20the%20data%20connection%20library%20for%20the%20entry%20http://portal/test/site/salesDCL%20to%20http://portal/site/salesDCL%20in%20the%20list%20of%20trusted%20data%20connection%20libraries,%20which%20is%20on%20the%20Excel%20Services%20Application%20Web%20service%20application%20named%20MyExcelService.---##%20PARAMETERS--###%20-Identity-Specifies%20the%20DataConnectionLibrary%20object%20to%20update.--The%20type%20must%20be%20a%20valid%20GUID,%20in%20the%20form%2012345678-90ab-cdef-1234-567890bcdefgh;%20a%20valid%20name%20of%20a%20data%20connection%20library%20(for%20example,%20DataConnectionLib1);%20a%20valid%20URL,%20in%20the%20form%20http://server_name;%20or%20an%20instance%20of%20a%20valid%20SPExcelDCL%20object.--%60%60%60yaml-Type:%20SPExcelDCLPipeBind-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Server%202010,%20SharePoint%20Server%202013--Required:%20True-Position:%201-Default%20value:%20None-Accept%20pipeline%20input:%20True%20(ByValue)-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-ExcelServiceApplication-Specifies%20the%20Excel%20Services%20Application%20Web%20service%20application%20that%20contains%20SPExcelDataConnectionLibrary%20list%20object.--The%20type%20must%20be%20a%20valid%20GUID,%20in%20the%20form%2012345678-90ab-cdef-1234-567890bcdefgh;%20a%20valid%20name%20of%20an%20Excel%20Services%20Application%20Web%20service%20application%20in%20the%20farm%20(for%20example,%20MyExcelService1);%20or%20an%20instance%20of%20a%20valid%20SPExcelServiceApplication%20object.--%60%60%60yaml-Type:%20SPExcelServiceApplicationPipeBind-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Server%202010,%20SharePoint%20Server%202013--Required:%20True-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20True%20(ByPropertyName,%20ByValue)-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-Address-Specifies%20the%20address%20of%20the%20data%20connection%20library.-The%20address%20must%20be%20unique%20in%20the%20list%20of%20trusted%20data%20connection%20libraries.--The%20type%20must%20be%20a%20valid%20URL,%20in%20the%20form%20http://server_name.--%60%60%60yaml-Type:%20String-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Server%202010,%20SharePoint%20Server%202013--Required:%20False-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-AssignmentCollection-Manages%20objects%20for%20the%20purpose%20of%20proper%20disposal.-Use%20of%20objects,%20such%20as%20SPWeb%20or%20SPSite,%20can%20use%20large%20amounts%20of%20memory%20and%20use%20of%20these%20objects%20in%20Windows%20PowerShell%20scripts%20requires%20proper%20memory%20management.-Using%20the%20SPAssignment%20object,%20you%20can%20assign%20objects%20to%20a%20variable%20and%20dispose%20of%20the%20objects%20after%20they%20are%20needed%20to%20free%20up%20memory.-When%20SPWeb,%20SPSite,%20or%20SPSiteAdministration%20objects%20are%20used,%20the%20objects%20are%20automatically%20disposed%20of%20if%20an%20assignment%20collection%20or%20the%20Global%20parameter%20is%20not%20used.--When%20the%20Global%20parameter%20is%20used,%20all%20objects%20are%20contained%20in%20the%20global%20store.-If%20objects%20are%20not%20immediately%20used,%20or%20disposed%20of%20by%20using%20the%20%60Stop-SPAssignment%60%20command,%20an%20out-of-memory%20scenario%20can%20occur.--%60%60%60yaml-Type:%20SPAssignmentCollection-Parameter%20Sets:%20(All)-Aliases:%20-Applicable:%20SharePoint%20Server%202010,%20SharePoint%20Server%202013--Required:%20False-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20True%20(ByValue)-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-Confirm-Prompts%20you%20for%20confirmation%20before%20executing%20the%20command.-For%20more%20information,%20type%20the%20following%20command:%20%60get-help%20about_commonparameters%60--%60%60%60yaml-Type:%20SwitchParameter-Parameter%20Sets:%20(All)-Aliases:%20cf-Applicable:%20SharePoint%20Server%202010,%20SharePoint%20Server%202013--Required:%20False-Position:%20Named-Default%20value:%20None-Accept%20pipeline%20input:%20False-Accept%20wildcard%20characters:%20False-%60%60%60--###%20-Description-Specifies%20a%20friendly%20description%20for%20the%20data%20connection%20library.--The%20type%20must%20a%20valid%20a%20string;%20for%20example,"This is the data connection library where all the connections to the sales data are stored". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelDataProvider.md deleted file mode 100644 index f8027e8c5f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelDataProvider.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Set-SPExcelDataProvider -schema: 2.0.0 ---- - -# Set-SPExcelDataProvider - -## SYNOPSIS -Sets properties of a safe data provider for Excel Services Application. - - -## SYNTAX - -``` -Set-SPExcelDataProvider [-Identity] <SPExcelDataProviderPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-ProviderId <String>] - [-ProviderType <DataProviderType>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPExcelDataProvider` cmdlet sets the properties of a data provider that is stored in the list of safe data providers. -Excel Services Application refreshes external data connections only if the data provider for that connection is in the list of safe data providers. -Excel Services Application include a set of common data providers in this list. -Therefore, using cmdlets to modify safe data providers is typically an operation of custom data connection scenarios. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | where {$_.ProviderID -eq "SQLOLEDB" } -PS C:\>Set-SPExcelDataProvider $provider -Description "The SQLOLEDB provider description has changed." -PS C:\>$provider | format-table -``` - -This example retrieves the SQLOLEDB data provider from the list of safe data providers that is on the Excel Services Application Web service application named MyExcelService, as an object, adds a new display description and then displays the provider output in a Command Prompt window, formatted as a table. - - -## PARAMETERS - -### -Identity -Specifies the SPExcelDataProvider object to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPExcelDataProvider object. - -```yaml -Type: SPExcelDataProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a display description for the data provider. - -The type must a valid a string; for example, this is a custom OLEDB provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId -Specifies the name of the data provider. -This ID should be present in the connection strings generated by this data provider and the ID must be unique for the data provider type. - -The type must a valid name of a provider; for example, CustomOLEDB. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderType -Specifies the supported type of the data provider to set. - -The type must be one of the following: OleDb, Odbc, or OdbcDsn. - -```yaml -Type: DataProviderType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelFileLocation.md deleted file mode 100644 index ee0091301a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelFileLocation.md +++ /dev/null @@ -1,613 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Set-SPExcelFileLocation -schema: 2.0.0 ---- - -# Set-SPExcelFileLocation - -## SYNOPSIS -Sets properties of a trusted file location for Excel Services Application. - - -## SYNTAX - -``` -Set-SPExcelFileLocation [-Identity] <SPExcelFileLocationPipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AbortOnRefreshOnOpenFail] [-Address <String>] - [-AssignmentCollection <SPAssignmentCollection>] [-AutomaticVolatileFunctionCacheLifetime <Int32>] - [-ChartAndImageSizeMax <Int32>] [-ConcurrentDataRequestsPerSessionMax <Int32>] [-Confirm] - [-DefaultWorkbookCalcMode <DefaultWorkbookCalcMode>] [-Description <String>] [-DisplayGranularExtDataErrors] - [-ExternalDataAllowed <AllowExternalData>] [-IncludeChildren] [-LocationType <LocationType>] - [-ManualExtDataCacheLifetime <Int32>] [-NewWorkbookSessionTimeout <Int32>] - [-PeriodicExtDataCacheLifetime <Int32>] [-RequestDurationMax <Int32>] [-RESTExternalDataAllowed] - [-SessionTimeout <Int32>] [-ShortSessionTimeout <Int32>] [-UdfsAllowed] [-WarnOnDataRefresh] [-WhatIf] - [-WorkbookSizeMax <Int32>] [-ChartRenderDurationMax <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPExcelFileLocation` cmdlet sets properties of a location from which Excel Services Application loads workbooks. -Excel Services Application loads only workbooks that are stored in a trusted file location. -Properties of trusted file locations control how workbooks can be used when they are loaded on Excel Services Application. -Excel Services Application always enforces the properties that are defined by the trusted file location from which a workbook was loaded. -The properties that are used by the trusted file location are determined by comparison of the file path for the workbook with the Address parameter of the trusted file location. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Get-SPExcelFileLocation -ExcelServiceApplication "My Excel Service" | where { $_.externaldataallowed -eq "DclAndEmbedded"} | Set-SPExcelFileLocation -ExernalDataAllowed Dcl -``` - -This example gets every trusted file location for the Excel Services Application Web service application named My Excel Service that allows data connections to load from workbook files and specifies that the locations must use a data connection library to load data connections. - - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelServiceApplication | Get-SPExcelFileLocation | where {$_.Address -eq "http://"} | Set-SPExcelFileLocation -Description "This is the default trusted file location for Excel Services Application. It allows any file from anywhere in SharePoint to load." -``` - -This example changes the description of the default file location for every Excel Services Application Web service application in the farm. - - -## PARAMETERS - -### -Identity -Specifies the FileLocation object to update. -The name must be unique in the list of file locations. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string identifying the file location, in the form http://myPortal/myTeam; a valid string identifying the path, in the form C:\folder_name; or an instance of a valid SPExcelFileLocation object. - -```yaml -Type: SPExcelFileLocationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AbortOnRefreshOnOpenFail -Specifies that the load of a Excel Services Application file automatically fails if an automatic data refresh operation fails when the file is opened. -The load is failed only if the following conditions are true: - --- User has read-only permissions to the Excel Services Application file. --- Workbook file has data connections that refresh automatically when the Excel file is opened. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Address -System.String - -Specifies a Web folder, or file directory from which Excel Services Application can load workbooks. - -The type must be a valid URL, in the form http://myPortal/myTeam; or a valid UNC path in form, \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AutomaticVolatileFunctionCacheLifetime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. -Valid values include: - --1, calculate once when the workbook loads - -0, always calculate - -1 to 2073600, cache 1 second to 24 days - -The type must be the integers -1 or 0, or an integer value in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened. -The default value is 1. - -The type must be a valid integer greater than 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentDataRequestsPerSessionMax -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 must be queued. -The scope of this setting is the logical server. -The default value is 5. - -The type must be a positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultWorkbookCalcMode -Specifies the calculation mode of workbooks. -All of the settings except the File setting override the workbook settings. -If this parameter is changed, it is applied to all new sessions on Excel Services Application when the ConfigDB properties cache is refreshed. -The default setting is File. - -The type must be one of the following: File, Manual, Auto, or AutoDataTables. - -```yaml -Type: DefaultWorkbookCalcMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a friendly description for the new file location. - -The type must be a valid string; for example, this is the file location of the monthly sales reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayGranularExtDataErrors -Displays granular error messages for external data failures for files in this location. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDataAllowed -Specifies the type of external data access allowed for workbooks: -None specifies that data refresh is disabled. -Dcl specifies that data is refreshed only when it uses a connection file in a trusted data connection library. -DclandEmbedded specifies that a data connection library can be used but is not required. -The scope of this setting is the trusted location. - -The default value is None. - -The type must be one of the following: None, Dcl, or DclAndEmbedded. - -```yaml -Type: AllowExternalData -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeChildren -Indicates that subordinate URLs, directories and libraries are trusted. -For example, if the trusted file location is http://portal, and IncludeChildren is true, then http://portal/subSite is also trusted, as is any subURL under the URL specified in Address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationType -The type of location. -LocationType indicates how Excel Services Application retrieves files from that location specified in Address. -The default value is SharePoint. - -The type must be one of the following: SharePoint, UNC, or HTTP. - -```yaml -Type: LocationType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManualExtDataCacheLifetime -Specifies the time, in seconds, that Excel Services Application waits before re-issuing a manual, or user-initiated, external data request. -During this period, the results from the previous external data request may be returned from an external data cache. - -Valid values are: - --1 Never refresh after first query - -1 to 2073600 Caches 1 second to 24 days. - -The default value is 300. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWorkbookSessionTimeout -Specifies the time, in seconds, that a session for a new, unsaved, workbook will remain active on Excel Services Application with no user activity. -The default value 1800. -Valid values include the following: - --1, session never expires - -0, session expires at the end of a single request - -1 to 2073600, remain active 1 second to 24 days. - -The type must be -1, 0, or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeriodicExtDataCacheLifetime -Specifies the time, in seconds, that Excel Services Application waits before re-issuing an on-open or periodic (that is, automatic) external data request. -During this period, the results from the previous external data request may be returned from an external data cache. -A value -1 specifies to never refresh after the first query. - -The type must be -1, 0, or an integer in the range of 1 to 2073600. - -The default value is 300. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses the request is timed 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: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RESTExternalDataAllowed -Specifies whether requests from the Representational State Transfer (REST) Application Programming Interface (API) are permitted to refresh external data connections. - -The RESTExternalDataAllowed parameter has no effect if the External DataAllowed parameter is set to None. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionTimeout -Specifies the time, in seconds, that a session will remain active on Excel Services Application with no user activity. -The default is 300 seconds. -The default value is 300. -Valid values include: - --1, session never expires - -0, session expires at the end of a single request - -1 to 2073600, remain active 1 second to 24 days - -The type must be -1, 0, or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortSessionTimeout -Specifies the time, in seconds, that a user has to make the initial interaction with a spreadsheet. -After this time has elapsed, if the user is not active, then the session is closed. -The value must always be less than SessionTimeout. -If the ShortSessionTimeout value is greater than or equal to SessionTimeout, an error is returned. -The default value is 75. - -The type must be -1 or an integer in the range of 1 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdfsAllowed -Specifies that user-defined functions can be called by workbooks loaded from the trusted file location that is specified in Address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnOnDataRefresh -Specifies that a warning is displayed to the user on the first refresh of data for the workbook. -The default value is True. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookSizeMax -Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The default value is 10. - -The type must be an integer value in the range of 1 to 2000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChartRenderDurationMax -The maximum time (in seconds) spent rendering any single chart. - -Valid values: -1 (no limit); from 1 through 2073600 (24 days). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelServiceApplication.md deleted file mode 100644 index 27219a21e3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelServiceApplication.md +++ /dev/null @@ -1,529 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Set-SPExcelServiceApplication -schema: 2.0.0 ---- - -# Set-SPExcelServiceApplication - -## SYNOPSIS -Sets global properties for Excel Services Application. - - -## SYNTAX - -### ExistingTargetApplicationParameterSet -``` -Set-SPExcelServiceApplication [[-Identity] <SPExcelServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-CachingOfUnusedFilesEnable] [-Confirm] - [-CrossDomainAccessAllowed] [-EncryptedUserConnectionRequired <EncryptedConnectionMode>] - [-ExternalDataConnectionLifetime <Int32>] [-FileAccessMethod <FileAccessMethod>] - [-LoadBalancingScheme <LoadBalancingScheme>] [-MemoryCacheThreshold <Int32>] [-PrivateBytesMax <Int32>] - [-SessionsPerUserMax <Int32>] [-SiteCollectionAnonymousSessionsMax <Int32>] - [-TerminateProcessOnAccessViolation] [-ThrottleAccessViolationsPerSiteCollection <Int32>] - [-UnattendedAccountApplicationId <String>] [-UnusedObjectAgeMax <Int32>] [-WhatIf] [-WorkbookCache <String>] - [-WorkbookCacheSizeMax <Int32>] [-UseEffectiveUserName] [-WorkbookModelUsageTracker <String>] - [<CommonParameters>] -``` - -### NewTargetApplicationParameterSet -``` -Set-SPExcelServiceApplication [[-Identity] <SPExcelServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-CachingOfUnusedFilesEnable] [-Confirm] - [-CrossDomainAccessAllowed] [-EncryptedUserConnectionRequired <EncryptedConnectionMode>] - [-ExternalDataConnectionLifetime <Int32>] [-FileAccessMethod <FileAccessMethod>] - [-LoadBalancingScheme <LoadBalancingScheme>] [-MemoryCacheThreshold <Int32>] [-PrivateBytesMax <Int32>] - [-SessionsPerUserMax <Int32>] [-SiteCollectionAnonymousSessionsMax <Int32>] - [-TerminateProcessOnAccessViolation] [-ThrottleAccessViolationsPerSiteCollection <Int32>] - [-UnusedObjectAgeMax <Int32>] [-WhatIf] [-WorkbookCache <String>] [-WorkbookCacheSizeMax <Int32>] - [-UnattendedServiceAccount <PSCredential>] [-UseEffectiveUserName] [-WorkbookModelUsageTracker <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-ExcelServiceApplication` cmdlet changes global runtime properties for Excel Services Application. -Changes to properties that are made by using this cmdlet affect all machines in the farm that are running an instance of the specified Excel Services Application Web service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'} -PS C:\>Set-SPExcelServiceApplication -Identity $sa -SessionsPerUserMax 10 -``` - -This example sets the Excel Services Application to enable each user to open no more than 10 sessions at one time on a back-end application server that runs Excel Services Application. - - -### --------------EXAMPLE 2-------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'} -PS C:\>Set-SPExcelServiceApplication -Identity $sa -PrivateBytesMax -1 -``` -This example sets the maximum number of private bytes of memory on the computer to a value of -1, which indicates that Excel Services Application will consume 50 percent of the available memory resources. - - -## PARAMETERS - -### -Identity -Specifies the SPExcelServiceApplication object to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CachingOfUnusedFilesEnable -Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. -The default is true when the parameter is not specified on the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CrossDomainAccessAllowed -Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedUserConnectionRequired -Requires that encryption is used between the end-user and the server running Excel Services Application. -The scope of this setting is the logical server. -The default value is None. - -The type must be one of the following: None or Connection. - -```yaml -Type: EncryptedConnectionMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDataConnectionLifetime -Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. - -Valid values are: - --1 Never recycle - -1 to 2073600 Remain active 1 second to 24 days. - -The default value is 1800. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileAccessMethod -Specifies the authentication method that Excel Services Application uses to retrieve files. -UseFileAccessAccount specifies that all workbooks always use the credentials of the service account running Excel Services Application. -UseImpersonation specifies that Excel Services Application retrieves the workbook files as the user who makes the request. -The default value is UseImpersonation. - -The type must be one of the following: UseImpersonation or UseFileAccessAccount. - -```yaml -Type: FileAccessMethod -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancingScheme -Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers. -The default value is WorkbookURL. - -The type must be one of the following: RoundRobin, Local, or WorkbookURL. - -```yaml -Type: LoadBalancingScheme -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryCacheThreshold -Specifies 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. -Setting this value to 0 disables caching of inactive objects. -The default value is 90. - -The type must be an integer in the range of 0 to 95. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBytesMax -Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. -When set to -1, the maximum private bytes defaults to 50 percent of physical memory on the computer. -Valid values include -1 for no limit, and any positive integer. -The default value is -1. - -The type must be -1 or any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionsPerUserMax -Specifies the maximum number of sessions allowed for a user. -If a user reaches this maximum the oldest session is deleted when a new session is started. -Valid values include -1 for no limit, and any positive integer. -The default value is 25. - -The type must be -1 or any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteCollectionAnonymousSessionsMax -Specifies the maximum number of anonymous sessions allowed per site collection. -A value of 0 specifies that no anonymous sessions are allowed. -Valid values include -1 for no limit, 0 to disable the setting, or any positive integer. -The default value is 25. - -The type must be -1, 0, or any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TerminateProcessOnAccessViolation -Terminates Excel Services Application when an access violation occurs in the process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleAccessViolationsPerSiteCollection -Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbook's site collection are blocked from loading for the specified period (in seconds). -Existing sessions for files on that site collection are unaffected. -Valid values include 0 to disable the setting, and the range of 1 to 2073600 seconds (24 days). -The default value is 0. - -The type must be an integer value in the range of 0 to 2073600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnattendedAccountApplicationId -Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter. -The secure storage service is contacted when this parameter is set and specific error cases occur. -Valid values are alphanumeric strings with a maximum of 256 characters. -The default value is an empty string. - -The type must be a valid string of alphanumeric characters; for example, UnattendedServiceAccountID. - -The unattended account is a single account that all workbooks can use to refresh data. -An unattended account is required when workbook connections specify None for authentication, or when any non-Windows credentials are used to refresh data. - -```yaml -Type: String -Parameter Sets: ExistingTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnusedObjectAgeMax -Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. -Valid values include -1 for no maximum setting, and a positive integer in the range of 1 to 34560 minutes (24 days). -The default value is -1. - -The type must be -1, or an integer in the range of 1 to 34560. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookCache -Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application. - -If no value is specified, the default value is a subdirectory in the system temporary directory. - -The type must be a valid path in either of the following forms: - --- C:\folder_name --- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookCacheSizeMax -Specifies the maximum allowable size, in megabytes, of an individual session. -The default value is 0. - -The type must be any positive integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnattendedServiceAccount -The Unattended Service Account is a single account that all workbooks can use to refresh data. This account is required to refresh data when workbook connections specify "Use the Unattended Service Account" without using Windows Credentials. - -```yaml -Type: PSCredential -Parameter Sets: NewTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseEffectiveUserName -The UseEffectiveUserName property is an alternative to Windows delegation for allowing users to securely access Analysis Services data. - -The setting will only impact external data connections based on Analysis Services workbook connections with an authentication setting of "Use the authenticated user's account". - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkbookModelUsageTracker -{{Fill WorkbookModelUsageTracker Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelUserDefinedFunction.md deleted file mode 100644 index 608317f91c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPExcelUserDefinedFunction.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2010, SharePoint Server 2013 -title: Set-SPExcelUserDefinedFunction -schema: 2.0.0 ---- - -# Set-SPExcelUserDefinedFunction - -## SYNOPSIS -Sets properties of a user-defined function in Excel Services Application. - - -## SYNTAX - -``` -Set-SPExcelUserDefinedFunction [-Identity] <SPExcelUDFPipeBind> - -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-Assembly <String>] - [-AssemblyLocation <AssemblyLocation>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Description <String>] [-Enable] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPExcelUserDefinedFunction` cmdlet sets properties of a user-defined function assembly. -Excel Services Application uses only user-defined functions that have an entry in the user-defined function list. -User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. -The assemblies can perform custom logic or other actions, such as refresh data. -Windows PowerShell cmdlets operate on the entries in the user-defined function list and do not operate on the assemblies. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1-------------- -``` -PS C:\>Set-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity SampleCompany.SampleApplication.SampleUdf -Description "This is the new description for the sample UDF" -``` - -This example changes the description of the user-defined function (UDF) to the UDF SampleCompany.SampleApplication.SampleUdf file for the Excel Services Application Web service application named My Excel Service. - - -### --------------EXAMPLE 2-------------- -``` -PS C:\>Get-SPExcelServiceApplication "My Excel Service" | Set-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -Enable: $false -``` - -This example disables the sample UDF SampleCompany.SampleApplication.SampleUdf file from the Excel Services Application named My Excel Service. - - -## PARAMETERS - -### -Identity -Specifies the SPExcelUserDefinedFunction object to update. - -The type must be a valid name of the code assembly; for example, SampleCompany.SampleApplication.SampleUdf; or an instance of a valid SPExcelUDF object. - -```yaml -Type: SPExcelUDFPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExcelServiceApplication -Specifies the Excel Services Application Web service application that contains the SPExcelUserDefinedFunction list object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. - -```yaml -Type: SPExcelServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Assembly -Specifies the strongly-typed name of the assembly. -The name must be unique in the list of user-defined functions and cannot be more than 4096 alphanumeric characters long. - -The type must be a string of alphanumeric characters; for example, SampleCompany.SampleApplication.SampleUdf, C:\UDFs\SampleUdf.dll, or \\\\MyNetworkServer\UDFs\SampleUdf.dll. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssemblyLocation -Specifies the location where the assembly is stored. - -The type must be one of the following: GAC or LocalFile. - -```yaml -Type: AssemblyLocation -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a display description for the user-defined function. -The name cannot be more than 4096 alphanumeric characters long. - -The type must be a string of alphanumeric characters; for example, this is the user-defined function for consolidation reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Activates the user-defined function for use with Excel Services Application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPFarmConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPFarmConfig.md deleted file mode 100644 index 93435afe33..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPFarmConfig.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPFarmConfig -schema: 2.0.0 ---- - -# Set-SPFarmConfig - -## SYNOPSIS -Sets a global property or a collection of global properties for the local farm. - - -## SYNTAX - -``` -Set-SPFarmConfig [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DataFormWebPartAutoRefreshEnabled <Boolean>] [-Force] [-InstalledProductsRefresh] - [-ServiceConnectionPointBindingInformation <String>] [-ServiceConnectionPointDelete] [-WhatIf] - [-WorkflowBatchSize <Int32>] [-WorkflowEventDeliveryTimeout <Int32>] [-WorkflowPostponeThreshold <Int32>] - [-ASPScriptOptimizationEnabled <Boolean>] [-UserAccountDirectoryPathIsImmutable] - [-DefaultActivateOnSiteMasterValue <Boolean>] [-MaxSiteSubscriptionSettingsValueLength <UInt32>] - [-MaxTenantStoreValueLength <UInt32>] [-SiteMasterMode <SPSiteMasterMode>] - [-SiteMasterValidationIntervalInHours <UInt32>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPFarmConfig` cmdlet updates a collection of global settings for the local farm that are not members of the SPFarm object. -Use the `Get-SPFarmConfig` cmdlet to read global settings for the local farm and to create a new PSCustomObject object from the collection of properties returned from the local farm and then add this object to the pipeline. -Modify the PSCustomObject object and pass it to the `Set-SPFarmConfig` cmdlet to change the parameter values. - -The properties collected in the PSCustomObject object must be farm-wide settings and must be configurable only once for the entire farm. -The parameter name added to the PSCustomObject object must match exactly the input parameter name for the `Set-SPFarmConfig` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------------EXAMPLE-------------------------- -``` -PS C:\>Set-SPFarmConfig -WorkflowBatchSize 50 -``` - -This example sets the WorkflowBatdhSize to 50. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFormWebPartAutoRefreshEnabled -Specifies whether any DataFormWebPart on any page in this farm is allowed to periodically refresh its contents asynchronously (after the page has finished rendering). - -When set to false, all DataFormWebParts will ignore the automatic refresh interval provided in Web Part properties. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the deletion or updating of the service connection point. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstalledProductsRefresh -Updates the current machine license state with the list of products that are installed in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceConnectionPointBindingInformation -Adds or updates the service connection point for the current farm in Active Directory Domain Service (AD DS). - -The type must be an array of strings that are key value pairs that will be added to the service connection point. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceConnectionPointDelete -Delete the service connection point for the current farm in AD DS. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkflowBatchSize -Specifies the paging size for events delivered to a single workflow instance. - -For each request, the events are streamed out 100 at a time. - -Batch size is the number of events processed for a single workflow instance, which can have many events queued at the same time. -Throttle will override batch size; if the workflow instance cannot be started or restarted because there are too many instances running across all front-end Web servers, none of the events will be fetched, regardless of the batch size. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkflowEventDeliveryTimeout -Specifies the time as an integer in which a workflow job must run without the job timing out. - -If the workflow job does time out, it gets put back in the queue to be run again. - -For example, if the value is set to 5, the workflow job must run within 5 minutes are the workflow job will time out. -Any workflow job that does time out is placed back in the queue to run again.The default value is 5. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkflowPostponeThreshold -Specifies the number of workflows that can be running in IIS against a content database at a time before new workflow instances get postponed into a queue. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ASPScriptOptimizationEnabled -Specifies if ASP Script optimization is enabled. The default value is false (off). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserAccountDirectoryPathIsImmutable -Specifies if the `UserAccountDirectoryPath` property on an `SPSite` object is immutable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultActivateOnSiteMasterValue -Specifies whether to activate site master as default. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSiteSubscriptionSettingsValueLength -Sets the maximum size of a SiteSubscription property value. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxTenantStoreValueLength -Sets the maximum size of a Tenant Store property value. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteMasterMode -Specifies if site master mode is turned on or off. The default value is off. - -```yaml -Type: SPSiteMasterMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteMasterValidationIntervalInHours -Determines the length of time, in hours, to validate the Site Master. - -The default value is 24. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPIRMSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPIRMSettings.md deleted file mode 100644 index 3c176ec6b0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPIRMSettings.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPIRMSettings -schema: 2.0.0 ---- - -# Set-SPIRMSettings - -## SYNOPSIS -Sets the Information Rights Management (IRM) settings. - - -## SYNTAX - -### UseSpecifiedCertificateUrl -``` -Set-SPIRMSettings -CertificateServerUrl <Uri> [-IrmEnabled] [-AssignmentCollection <SPAssignmentCollection>] - [-CertificatePassword <SecureString>] [-Confirm] [-ServiceAuthenticationCertificate <X509Certificate2>] - [-SubscriptionScopeSettingsEnabled] [-WhatIf] [-UseOauth] [<CommonParameters>] -``` - -### UseServiceDiscovery -``` -Set-SPIRMSettings [-IrmEnabled] [-AssignmentCollection <SPAssignmentCollection>] - [-CertificatePassword <SecureString>] [-Confirm] [-ServiceAuthenticationCertificate <X509Certificate2>] - [-SubscriptionScopeSettingsEnabled] [-UseActiveDirectoryDiscovery] [-WhatIf] [-UseOauth] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPIRMSettings` cmdlet to set the Information Rights Management (IRM) settings for the tenant. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1------------ -``` -PS C:\>Set-SPIRMSettings -RmsEnabled -UseActiveDirectoryDiscovery -``` - -This example enables IRM for the farm and configures it to use the default RMS server configured in Active Directory. - -### --------------EXAMPLE 2------------ -``` -PS C:\>Set-SPIRMSettings -RmsEnabled -CertificateServerUrl http://myrmsserver -``` - -This example enables IRM for the farm and specifies the URL of the RMS server to use. - -### --------------EXAMPLE 3------------ -``` -PS C:\>site = Get-SPSite http://myspserver -PS C:\>$subscription = $site.SiteSubscription -PS C:\>Set-SPIRMSettings -SiteSubscription $subscription -RmsEnabled -CertificateServerUrl http://myrmsserver -``` - -This example enables IRM for the specified tenant and specifies the URL of the RMS server to use. - -### --------------EXAMPLE 4------------ -``` -PS C:\>Set-SPIRMSettings -RmsEnabled:$false -``` - -This example disables IRM for the farm. - - -## PARAMETERS - -### -CertificateServerUrl -Specifies the address of the RMS certificate server to use for the tenant. - -```yaml -Type: Uri -Parameter Sets: UseSpecifiedCertificateUrl -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IrmEnabled -Specifies whether or not IRM is enabled in the tenant. - -The default value is false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies the password to access the Service Authentication Certificate. -This password is required in order to install the certificate in the machine certificate store. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAuthenticationCertificate -Specifies the service authentication certificate. - -If the parameter is specified and not null, the authentication certificate is used when connecting from this farm to the RMS server. -If the parameter is not specified, the local farm connects to RMS server using integrated windows authentication. - -```yaml -Type: X509Certificate2 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionScopeSettingsEnabled -Specifies whether or not IRM can be configured at the site subscription scope. - -Site subscriptions can only configure custom IRM settings if IRM is enabled at the Farm scope. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseActiveDirectoryDiscovery -Specifies whether or not the RMS service should be used for discovery that will determine the address of the RMS server in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: UseServiceDiscovery -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseOauth -Specifies whether OAuth should be used. - -The valid values are True and False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPIRMSettings](Get-SPIRMSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathFormTemplate.md deleted file mode 100644 index b3fb98a6c7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Set-SPInfoPathFormTemplate - -## SYNOPSIS -Sets properties of a InfoPath form template. - - -## SYNTAX - -``` -Set-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Category <String>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPInfoPathFormsTemplate` cmdlet modifies the category of an InfoPath form template or to specify the browser streams for the form template. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Set-InfoPathFormTemplate -Identity "Sample.xsn" -Category "WorkFlowCategory" -``` - -This example modifies the category property of a form template for a specified name. - - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category -Specifies the category of the form template. -The category name can have a maximum of 255 characters. - -The type must be a valid name of a form template category; for example, FormTemplateCategory1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathFormsService.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathFormsService.md deleted file mode 100644 index b14917243f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathFormsService.md +++ /dev/null @@ -1,468 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPInfoPathFormsService -schema: 2.0.0 ---- - -# Set-SPInfoPathFormsService - -## SYNOPSIS -Sets parameters for InfoPath Forms Services in SharePoint Server. - - -## SYNTAX - -``` -Set-SPInfoPathFormsService [-ActiveSessionTimeout <Int32>] [-AllowEmbeddedSqlForDataConnections <String>] - [-AllowUdcAuthenticationForDataConnections <String>] [-AllowUserFormBrowserEnabling <String>] - [-AllowUserFormBrowserRendering <String>] [-AllowUserFormCrossDomainDataConnections <String>] - [-AllowViewState <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DefaultDataConnectionTimeout <Int32>] [-Identity <SPFormsServicePipeBind>] - [-MaxDataConnectionResponseSize <Int32>] [-MaxDataConnectionRoundTrip <Int32>] - [-MaxDataConnectionTimeout <Int32>] [-MaxFormLoadTime <Int32>] [-MaxPostbacksPerSession <Int32>] - [-MaxUserActionsPerPostback <Int32>] [-MemoryCacheSize <Int32>] [-RequireSslForDataConnections <String>] - [-ViewStateThreshold <Int32>] [-WhatIf] [-MaxSizeOfUserFormState <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPInfoPathFormsService` cmdlet modifies the settings for InfoPath Forms Services in SharePoint Server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE 1----------------- -``` -PS C:\>Set-SPInfoPathFormsService -AllowUserFormBrowserEnabling $true -AllowUserFormBrowserRendering $false -``` - -This example modifies the AllowUserFormBrowserEnabling and AllowUserFormBrowserRendering parameter values. - -### --------------EXAMPLE 2----------------- -``` -PS C:\>Set-SPInfoPathFormsService -AllowViewState $true -ViewStateThreshold 40961 -``` - -This example modifies the AllowViewState and ViewStateThreshold parameter values. - -## PARAMETERS - -### -ActiveSessionTimeout -Specifies the duration, in minutes, that a form's session state can remain active. -The default value is 1440. - -The type must be a non-negative integer value in the range from 0 through 999,999. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmbeddedSqlForDataConnections -Specifies a value that indicates whether embedded SQL authentication can be used by browser-enabled InfoPath form templates. - -The type must be one of the following values: True, False (default) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUdcAuthenticationForDataConnections -Specifies that authentication information in a universal data connection (.udcx file) can be used. - -The type must be one of the following values: True (default), False - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserFormBrowserEnabling -Specifies that users can browser enable form templates that do not contain form code, require full trust, enable rendering on a mobile device, or use a data connection managed by a server administrator. - -The type must be one of the following values: True (default), False - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserFormBrowserRendering -Specifies that browser-enabled form templates will be rendered by InfoPath Forms Services. - -The type must be one of the following values: True (default), False - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserFormCrossDomainDataConnections -Specifies that data connections to data sources located in a different domain can be queried. - -The type must be one of the following values: True, False (default) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowViewState -Defines the location to store form session state: View state when True, or Session State Service when False. - -The type must be one of the following values: True, False (default) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDataConnectionTimeout -Specifies the default data connection timeout in milliseconds. -The default value is 10000 (10 seconds). - -The type must be a non-negative integer and less than or equal to the value set for MaxDataConnectionTimeout. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the InfoPath Forms Services service to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an InfoPath Forms Services service (for example, FormsService1); or an instance of a valid SPFormsService object. - -```yaml -Type: SPFormsServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDataConnectionResponseSize -Specifies the maximum size allowed for a data connection response. -The default value is 15000 kilobytes (KB). - -The type must be a non-negative integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDataConnectionRoundTrip -Sets a threshold, in milliseconds, for the maximum time it takes from the start of a data request to the return of the data request on the server (the data connection round trip). -If the data connection round trip time exceeds this threshold, an event is logged in the Operational log. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDataConnectionTimeout -Specifies the maximum data connection timeout in milliseconds. -The default value is 20000 (20 seconds). - -The type must be a non-negative integer and less than or equal to 999999. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxFormLoadTime -Sets a threshold, in milliseconds, for maximum form load time. -If form load time exceeds this threshold, an event is logged in the Operational log. - -The MaxFormLoadTime parameter measures the time it takes for a form to open, starting from when the request is accepted by the server until it leaves the server. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPostbacksPerSession -Specifies the value of the maximum postbacks that an instance of a browser-enabled InfoPath form template can make to the InfoPath Forms Services service. -The default value is 20. - -The type must be a non-negative integer and less than or equal to 999999. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxUserActionsPerPostback -Specifies the maximum user actions per postback. -The default value is 200. - -The type must be a non-negative integer and less than or equal to 999999. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryCacheSize -Sets the size, in megabytes (MB), of the cache for solutions in memory. - -The default value is 250 MB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireSslForDataConnections -Specifies the Secure Sockets Layer (SSL) requirement value. -If data connections in browser-enabled form templates require basic authentication or digest authentication, a password is sent over the network. -Set this value to True to require an SSL-encrypted connection for these authentication types. - -The type must be one of the following values: True (default), False. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ViewStateThreshold -Specifies the maximum size in kilobytes of the session state when stored in the form view. -The default value is 40. - -The type must be a non-negative integer and less than or equal to 99,999,999. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSizeOfUserFormState -Specifies the value of the maximum size in kilobytes of session state an instance of a browser-enabled InfoPath form template can use. The default value is 4096. - -The type must be a non-negative integer and less than or equal to 999999. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathWebServiceProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathWebServiceProxy.md deleted file mode 100644 index dd73dd0749..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInfoPathWebServiceProxy.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPInfoPathWebServiceProxy -schema: 2.0.0 ---- - -# Set-SPInfoPathWebServiceProxy - -## SYNOPSIS -Sets parameters for an existing SharePoint Web service application. - - -## SYNTAX - -``` -Set-SPInfoPathWebServiceProxy [-Identity] <SPWebServiceProxyPipeBind> [-AllowForUserForms <String>] - [-AllowWebServiceProxy <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPInfoPathWebServiceProxy` cmdlet configures exposed parameters for an existing SharePoint Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Set-SPInfoPathWebServiceProxy -Identity "http://server_name/" -AllowWebServiceProxy $true -``` - -This example sets the Web service proxy for a Web application. - - -## PARAMETERS - -### -Identity -Specifies the SharePoint Web service application proxy to update. - -The type must be a valid URL, in the form http://server_name; a valid name of a Web application (for example, WebApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPWebServiceProxy object. - -```yaml -Type: SPWebServiceProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowForUserForms -Specifies that a form opened in the InfoPath client can use the InfoPath Forms Services Web service proxy to connect to a Web service. -This parameter can be set only when AllowWebServiceProxy is set to True. - -The type must be one of the following: True, False The default value is False. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowWebServiceProxy -Specifies that browser-enabled form templates can use the InfoPath Forms Services Web service proxy to connect to a Web service. - -The type must be one of the following: True, False The default value is False. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInternalAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInternalAppStateUpdateInterval.md deleted file mode 100644 index ad794dcb2e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPInternalAppStateUpdateInterval.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPInternalAppStateUpdateInterval -schema: 2.0.0 ---- - -# Set-SPInternalAppStateUpdateInterval - -## SYNOPSIS -Sets the interval in hours between updates of the internal app state update job. - - -## SYNTAX - -``` -Set-SPInternalAppStateUpdateInterval -AppStateSyncHours <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPInternalAppStateUpdateInterval` cmdlet to set the interval in hours between updates of the internal app state update job. -The internal app state update job gets app upgrades from the internal app directory and sets them on app instances. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------EXAMPLE------------ -``` -PS C:\>Set-SPInternalAppStateUpdateInterval -AppStateSyncHours 24 -``` - -This example sets a 24-hour interval between updates of the internal app state update job. - - -## PARAMETERS - -### -AppStateSyncHours -Specifies the hour for which the internal app states are updated. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPInternalAppStateUpdateInterval](Get-SPInternalAppStateUpdateInterval.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPLogLevel.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPLogLevel.md deleted file mode 100644 index 8916bbe145..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPLogLevel.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPLogLevel -schema: 2.0.0 ---- - -# Set-SPLogLevel - -## SYNOPSIS -Sets the trace and event level for a set of categories. - - -## SYNTAX - -``` -Set-SPLogLevel [-AssignmentCollection <SPAssignmentCollection>] [-EventSeverity <String>] - [-Identity <String[]>] [-InputObject <PSObject>] [-TraceSeverity <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPLogLevel` cmdlet sets the Windows event logging and trace logging levels for one or more diagnostic logging categories registered in the farm. -If an event or trace associated with a category occurs, but is less severe than that category's logging level, the event or trace is not written to the event log or the trace log. -If an event or trace associated with a category occurs and is equally severe or more severe than that category's logging level, the event or trace is written to the event log or the trace log. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>set-sploglevel -TraceSeverity Monitorable -``` - -This example sets the TraceSeverity values for all categories to Monitorable. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Set-SPLogLevel -TraceSeverity High -EventSeverity Warning -Identity "Cat1" -``` - -This example sets the EventSeverity and TraceSeverity values for a single category. - - -### ------------------EXAMPLE 3----------------------- -``` -C:\PS>"Cat1", "Cat2", "Cat3" | Set-SPLogLevel -EventSeverity Error -``` - -This example sets the EventSeverity values for multiple categories. - - -### ------------------EXAMPLE 4----------------------- -``` -PS C:\>Set-SPLogLevel -EventSeverity Warning -Identity "AreaName:*" -``` - -This example sets the EventSeverity values for all categories in the same area. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -EventSeverity -Specifies the category level to be set. -The category level is any one of the following values: - -- None -- ErrorCritical -- Error -- Warning -- Information -- Verbose - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". -If the Identity parameter is not specified, the event-throttling setting is applied to all categories in the farm. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The InputObject is pipelined to the cmdlet and can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. -The user can retrieve one or more categories from the `Get-SPLogLevel` cmdlet, modify the category values and then pipeline them into the `Set-SPLogLevel` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TraceSeverity -Specifies trace throttle to set the specified categor(ies) to. -The trace log files are text files that are written to the trace log path that is defined on the Diagnostic Logging Settings page on the SharePoint Central Administration site. -The type must be any one of the following values: - -- None (no traces are written to the trace log) -- Unexpected -- Monitorable -- High -- Medium -- Verbose -- VerboseEx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPManagedAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPManagedAccount.md deleted file mode 100644 index 2b36a48e2b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPManagedAccount.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPManagedAccount -schema: 2.0.0 ---- - -# Set-SPManagedAccount - -## SYNOPSIS -Configures the managed account. - - -## SYNTAX - -### NewPassword -``` -Set-SPManagedAccount [-Identity] <SPManagedAccountPipeBind> -ConfirmPassword <SecureString> - -NewPassword <SecureString> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-EmailNotification <Int32>] [-PreExpireDays <Int32>] [-Schedule <String>] [-SetNewPassword] [-WhatIf] - [<CommonParameters>] -``` - -### ExistingPassword -``` -Set-SPManagedAccount [-Identity] <SPManagedAccountPipeBind> -ExistingPassword <SecureString> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-EmailNotification <Int32>] - [-PreExpireDays <Int32>] [-Schedule <String>] [-UseExistingPassword] [-WhatIf] [<CommonParameters>] -``` - -### NewPasswordAsParameter -``` -Set-SPManagedAccount [-Identity] <SPManagedAccountPipeBind> -Password <SecureString> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-EmailNotification <Int32>] - [-PreExpireDays <Int32>] [-Schedule <String>] [-WhatIf] [<CommonParameters>] -``` - -### AutoGeneratePassword -``` -Set-SPManagedAccount [-Identity] <SPManagedAccountPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-AutoGeneratePassword] [-Confirm] [-EmailNotification <Int32>] [-PreExpireDays <Int32>] [-Schedule <String>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPManagedAccount` cmdlet sets the properties on the given managed account. - -You can use this cmdlet to change the password expiration and notification settings for the managed account: Use the default parameter set. -Additionally, you can use this cmdlet to change the password for the managed account to automatically generated passwords on a set schedule: Use the parameter set that includes the AutoGeneratePassword parameter. -You can also use this cmdlet to change the password for the managed account to a new value, known to the administrator: Use the parameter set that includes the SetNewPassword parameter. -Finally, you can use this cmdlet to change the password for the managed account to an existing value that has been already been changed in Active Directory Domain Services (AD DS): Use the parameter set that includes the UseExistingPassword parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$m = Get-SPManagedAccount -Identity "DOMAINx\UserY" -PS C:\>Set-SPManagedAccount -Identity $m -AutoGeneratePassword true -``` - -This example displays an explicit managed account if it exists and then attempts to update it to use automatically generated passwords. - - -## PARAMETERS - -### -Identity -Specifies the full name or partial name of the managed accounts to retrieve. - -The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. - -```yaml -Type: SPManagedAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConfirmPassword -Confirms the new password for this managed account. - -```yaml -Type: SecureString -Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExistingPassword -Sets the password for this managed account to an existing value that has already been changed in Active Directory Domain Services (AD DS). - -```yaml -Type: SecureString -Parameter Sets: ExistingPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPassword -Sets a new password for the managed account - -```yaml -Type: SecureString -Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Sets a password for the managed account. - -```yaml -Type: SecureString -Parameter Sets: NewPasswordAsParameter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AutoGeneratePassword -Automatically generates a new password. - -The type must be either of the following values: - -- True -- False - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: AutoGeneratePassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailNotification -Specifies the number of days before password change to begin e-mail notifications. - -The default value is 5. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreExpireDays -Specifies the number of days before expiration to schedule password change. - -The default value is 2. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Specifies the new schedule on which the password change job is to run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SetNewPassword -Sets the password to the new value that is passed in, and changes the value in AD DS. - -The type must be either of the following values: - -- True -- False - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseExistingPassword -Sets the password to a new value passed in where the value is already changed in AD DS. - -The type must be either of the following values: - -- True -- False - -The default value is False. - -```yaml -Type: SwitchParameter -Parameter Sets: ExistingPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMetadataServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMetadataServiceApplication.md deleted file mode 100644 index 1aa188b57a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMetadataServiceApplication.md +++ /dev/null @@ -1,530 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPMetadataServiceApplication -schema: 2.0.0 ---- - -# Set-SPMetadataServiceApplication - -## SYNOPSIS -Sets the properties of a managed metadata service application. - - -## SYNTAX - -### NoQuota -``` -Set-SPMetadataServiceApplication [-Identity] <SPMetadataServiceCmdletPipeBind> [-AdministratorAccount <String>] - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-CacheTimeCheckInterval <Int32>] [-Confirm] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] - [-DatabaseServer <String>] [-DoNotUnpublishAllPackages] [-FailoverDatabaseServer <String>] - [-FullAccessAccount <String>] [-Name <String>] [-RestrictedAccount <String>] [-SyndicationErrorReportEnabled] - [-HubUri <String>] [-MaxChannelCache <Int32>] [-ReadAccessAccount <String>] [-WhatIf] [-DisablePartitionQuota] - [<CommonParameters>] -``` - -### Quota -``` -Set-SPMetadataServiceApplication [-Identity] <SPMetadataServiceCmdletPipeBind> [-AdministratorAccount <String>] - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-CacheTimeCheckInterval <Int32>] [-Confirm] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] - [-DatabaseServer <String>] [-DoNotUnpublishAllPackages] [-FailoverDatabaseServer <String>] - [-FullAccessAccount <String>] [-Name <String>] [-RestrictedAccount <String>] [-SyndicationErrorReportEnabled] - [-HubUri <String>] [-MaxChannelCache <Int32>] [-ReadAccessAccount <String>] [-WhatIf] - -GroupsPerPartition <Int32> -LabelsPerPartition <Int32> -PropertiesPerPartition <Int32> - -TermSetsPerPartition <Int32> -TermsPerPartition <Int32> [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPMetadataServiceApplication` cmdlet to set the properties of a managed metadata service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>$sa = Get-SPMetadataServiceApplication -Identity 'Managed Metadata Service Application' -PS C:\>Set-SPMetadataServiceApplication -Identity $sa -HubUri 'http://sitename/' -SyndicationErrorReportEnabled -``` - -This example adds a content type hub to an existing managed metadata service application. -It also enables error reporting when content types are imported. - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>$sa = Get-SPMetadataServiceApplication -Identity 'Managed Metadata Service Application' -PS C:\>Set-SPMetadataServiceApplication -Identity $sa -AdministratorAccount 'contoso\username1' -FullAccessAccount 'contoso\AppPoolAccount1,contoso\AppPoolAccount2' -RestrictedAccount 'contoso\AppPoolAccount3,contoso\AppPoolAccount4,contoso\AppPoolAccount5' -ReadAccessAccount 'contoso\AppPoolAccount6' -``` - -This example sets permissions on an existing managed metadata service application. - -If you use Windows PowerShell to set any of the account values, you should set all of them. -The `Set-SPMetadataServiceApplication` cmdlet first erases all accounts, then adds the accounts that you specified. - - -## PARAMETERS - -### -Identity -Specifies the managed metadata service application to update. - -The type must be a valid GUID or the name of a valid managed metadata service application. - -```yaml -Type: SPMetadataServiceCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AdministratorAccount -A comma-separated list of user accounts or service accounts in the format \<domain\>\\\<account\> that may create and run the service application. -The accounts must already exist. - -If a value is set by using this parameter, any existing values for the FullAccessAccount, ReadAccessAccount and RestrictedAccount parameters are removed. -Consider setting all four parameters at the same time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies an existing IIS application pool in which to run the Web service for the managed metadata service application. - -The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool; or an instance of a valid SPServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheTimeCheckInterval -Specifies the interval, in seconds, that a front-end Web server should wait before asking the application server for changes. -This value is set per timer job, client application, or Web application. - -The mininum value is 1, and there is no maximum value. -The default value is 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. - -If SQL authentication is to be used, either the DatabaseCredentials parameter must be specified or both the DatabaseUserName and DatabasePassword parameters must be set. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database that contains the term store for the managed metadata service application. - -The type must be a valid name of a SQL Server database; for example MeatadataDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid name of a SQL Server database; for example SqlServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotUnpublishAllPackages -If this flag is set, the packages will not be unpublished. -If the HubUri parameter is changed, all content type packages will be unpublished by default. - -If the HubUri parameter is not changed, this flag has no effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host server for the failover database server. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullAccessAccount -Specifies a comma-separated set of application pool accounts in the format \<domain\>\\\<account\> that will be given read/write permission to the managed metadata service's term store and content type gallery. -The accounts must already exist. - -If a value is set by using this parameter, any existing values for the AdministratorAccount, ReadAccessAccount and RestrictedAccount parameters are removed. -Consider setting all four parameters at the same time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the new name of the service application. -The name can contain a maximum of 128 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictedAccount -Specifies a comma-separated set of application pool accounts in the format \<domain\>\\\<account\> that will be given permission to read the managed metadata service's term store and content type gallery and permission to write to open term sets and local term sets and to create new enterprise keywords. -The accounts must already exist. - -If a value is set by using this parameter, any previous values for the FullAccessAccount, ReadAccessAccount and AdministratorAccount parameters are removed. -Consider setting all four parameters at the same time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyndicationErrorReportEnabled -Enables reporting of errors when content types are imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HubUri -Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxChannelCache -Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server holds open to the application server. -This value is set per timer job, client application, or Web application. - -The minimum value is 0, and there is no maximum value. -The default value is 4. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadAccessAccount -Specifies a comma-separated set of application pool accounts in the format \<domain\>\\\<account\> that will be given read-only permission to the managed metadata service's term store and content type gallery. -The accounts must already exist. - -If a value is set by using this parameter, any previous values for the FullAccessAccount, RestrictedAccount and AdministratorAccount parameters are removed. -Consider setting all four parameters at the same time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisablePartitionQuota -When in partitioned mode, disables the partition quota. - -```yaml -Type: SwitchParameter -Parameter Sets: NoQuota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupsPerPartition -When in partitioned mode, sets the maximum number of groups per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabelsPerPartition -When in partitioned mode, sets the maximum number of labels per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertiesPerPartition -When in partitioned mode, sets the maximum number of properties per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TermSetsPerPartition -When in partitioned mode, sets the maximum number of term sets per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TermsPerPartition -When in partitioned mode, sets the maximum number of terms per partition. - -```yaml -Type: Int32 -Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMetadataServiceApplicationProxy.md deleted file mode 100644 index 5b4fbf6b55..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMetadataServiceApplicationProxy.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPMetadataServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPMetadataServiceApplicationProxy - -## SYNOPSIS -Sets the properties of a connection to a managed metadata service application. - - -## SYNTAX - -``` -Set-SPMetadataServiceApplicationProxy [-Identity] <SPMetadataServiceProxyCmdletPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-ContentTypePushdownEnabled] - [-ContentTypeSyndicationEnabled] [-DefaultKeywordTaxonomy] [-DefaultSiteCollectionTaxonomy] [-Name <String>] - [-DefaultProxyGroup] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPMetadataServiceApplicationProxy` cmdlet to set the properties of a connection to a managed metadata service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -ContentTypeSyndicationEnabled -ContentTypePushdownEnabled -``` - -This example enables content type syndication and enables content type pushdown on an existing connection to a managed metadata service application. - - -### -----------------EXAMPLE 2--------------------- -``` -PS C:\>Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -ContentTypeSyndicationEnabled:$false -ContentTypePushdownEnabled:$false -``` - -This example disables content type syndication and disables content type pushdown on an existing connection to a managed metadata service application. - - -### -----------------EXAMPLE 3--------------------- -``` -PS C:\>Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -DefaultKeywordTaxonomy -DefaultSiteCollectionTaxonomy:$false -``` - -This example configures an existing connection to a managed metadata service application to be the default location for storing enterprise keywords and prevents it from being the default location for storing column-specific term sets. - - -## PARAMETERS - -### -Identity -Specifies the connection to update. - -The type must be a GUID that represents the identity of the connection to modify, the name of a valid connection to a managed metadata service, or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypePushdownEnabled -Specifies that existing instances of changed content types in subsites and libraries will be updated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypeSyndicationEnabled -Specifies that this connection will provide access to the content types that are associated with the managed metadata service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultKeywordTaxonomy -Specifies that new enterprise keywords will be stored in the term store associated with the managed metadata service application. - -Do not make more than one connection the default keyword location. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSiteCollectionTaxonomy -Specifies that the term set that is created when you create a new managed metadata column will be stored in the term store associated with the managed metadata service application. - -Do not make more than one connection the default location for site collection term sets. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the new display name of the connection. -The name can contain a maximum of 128 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the connection be added to the default proxy group of the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMicrofeedOptions.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMicrofeedOptions.md deleted file mode 100644 index 3a06cec308..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMicrofeedOptions.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPMicrofeedOptions -schema: 2.0.0 ---- - -# Set-SPMicrofeedOptions - -## SYNOPSIS -Sets the feed cache settings. - - -## SYNTAX - -``` -Set-SPMicrofeedOptions [-AssignmentCollection <SPAssignmentCollection>] [-AsyncRefs <Boolean>] - [-MaxCacheMs <Int32>] [-MaxMentions <Int32>] [-MaxPostLength <Int32>] [-MaxTags <Int32>] - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPMicrofeedOptions cmdlet to set the feed cache settings for the current user profile application. - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Set-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy -MaxTags 4 -``` - -This example sets the maximum tags per post and reply to 4 for the specified User Profile Service Application Proxy. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.  - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsyncRefs -Performs reference-posts via async threads. If the value is set to True, each @mention in a thread is handled in its own .NET threadpool async thread. - - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCacheMs -Specifies the permissible range of cache loop up time. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxMentions -Specifies the maximum number @mentions per post and reply. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPostLength -Sets the maximum number of characters in a Microfeed post. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxTags -Specifies the maximum number #tags per post and reply. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the unique identifier for the proxy. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind -Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMobileMessagingAccount.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMobileMessagingAccount.md deleted file mode 100644 index ee2b99bc5d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPMobileMessagingAccount.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPMobileMessagingAccount -schema: 2.0.0 ---- - -# Set-SPMobileMessagingAccount - -## SYNOPSIS -Configures the specified mobile messaging account. - - -## SYNTAX - -``` -Set-SPMobileMessagingAccount [-Identity] <SPMobileMessagingAccountPipeBind> - -WebApplication <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Password <String>] [-ServiceName <String>] [-ServiceUrl <String>] [-UserId <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPMobileMessagingAccount` cmdlet configures the specified mobile messaging account. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPMobileMessagingAccount -WebApplication http://sitename -Identity SMS -ServiceName SMSLink -ServiceUrl https://www.adatum.com/Service/MessagingService.asmx-UserId someone@example.com -Password password1 -``` - -This example changes the SMS mobile account settings of the Web application, http://sitename, to the following values:service name: SMSLink; service URL: https://www.adatum.com/Service/MessagingService.asmx; user ID: someone@example.com; and password: password1. - - -## PARAMETERS - -### -Identity -Specifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. -Valid values are SMS and MMS. -If you do not specify this parameter account, information is returned for both SMS and MMS. - -```yaml -Type: SPMobileMessagingAccountPipeBind -Parameter Sets: (All) -Aliases: ServiceType, AccountType -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the identity of the Web application that hosts the managed path to delete. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423). - -You either must specify WebApplication or must use the HostHeader switch and specify the full URL in the Identity parameter. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Password -Specifies the password, if credentials are required for the account. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Specifies the name of the SMS service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceUrl -Specifies the URL of the SMS service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -Specifies the user name, if credentials are required for the account. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPO365LinkSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPO365LinkSettings.md deleted file mode 100644 index a85b2e26bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPO365LinkSettings.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPO365LinkSettings -schema: 2.0.0 ---- - -# Set-SPO365LinkSettings - -## SYNOPSIS -Set SharePoint O365 Link Settings for Hybrid Configuration. - -## SYNTAX - -``` -Set-SPO365LinkSettings -MySiteHostUrl <String> [-Audiences <String[]>] [-RedirectSites <Boolean>] - [-HybridAppLauncherEnabled <Boolean>] [-OnedriveDefaultToCloudEnabled <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the **Set-SPO365LinkSettings** cmdlet to configure some of Hybrid features (Hybrid site redirection, OneDrive redirection, ODB default to Cloud) without running Hybrid Configuration Wizard. - -To run this cmdlet requires farm administrator permission and that the user account has full control access to the User Profile Application service. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -PS C:\> Set-SPO365LinkSettings -MySiteHostUrl https://contoso-my.sharepoint.com/ -RedirectSites $true -``` - -This example sets the mysite host URL to contoso-my.sharepoint.com - -## PARAMETERS - -### -Audiences -Sets the user(s) for whom redirection is active. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HybridAppLauncherEnabled -Sets a flag that indicates whether app launcher get data from SharePoint Online (SPO) is allowed - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MySiteHostUrl -Sets the root URL for the redirected pages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OnedriveDefaultToCloudEnabled -Sets a flag that indicates whether Local Onedrive is redirected to SPO OneDrive. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016 - -Required: False -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). - - - -## RELATED LINKS - -[Get-SPO365LinkSettings](Get-SPO365LinkSettings.md) - -[Test-SPO365LinkSettings](Test-SPO365LinkSettings.md) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPassPhrase.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPassPhrase.md deleted file mode 100644 index add978093d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPassPhrase.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPPassPhrase -schema: 2.0.0 ---- - -# Set-SPPassPhrase - -## SYNOPSIS -Sets the pass phrase to a new value. - - -## SYNTAX - -### LocalOnly -``` -Set-SPPassPhrase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-LocalServerOnly] [-WhatIf] - -PassPhrase <SecureString> [<CommonParameters>] -``` - -### AcrossFarm -``` -Set-SPPassPhrase [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - -ConfirmPassPhrase <SecureString> -PassPhrase <SecureString> [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPPassPhrase` cmdlet sets the Passphrase to a new Passphrase value. -If the LocalServerOnly parameter is not used, the farm encryption key is re-encrypted with the new value and attempts to propagate this value to all other servers in the farm. -If the LocalServerOnly parameter is used, this is updated on the local machine only and the farm encryption key is not changed. -The Passphrase value must be the same on all servers in the farm if the farm is to function correctly. -So if the Passphrase fails to propagate to all servers, the LocalServerOnly parameter can be used to set the remaining servers to the new Passphrase value manually. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>$passphrase = ConvertTo-SecureString -asPlainText -Force -PS C:\>Set-SPPassPhrase -PassPhrase $passphrase -Confirm -``` - -This example queries for a string to use as a passphrase and sets the farm passphrase to a new value. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalServerOnly -Scopes the Passphrase change to the local server only. -If this parameter is not used, the Passphrase change is performed farm-wide. - -```yaml -Type: SwitchParameter -Parameter Sets: LocalOnly -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfirmPassPhrase -Passphrase is typed a second time to confirm that it matches the first entry. - -```yaml -Type: SecureString -Parameter Sets: AcrossFarm -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassPhrase -Specifies the new Passphrase value. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPerformancePointSecureDataValues.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPerformancePointSecureDataValues.md deleted file mode 100644 index 12fea9c03d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPerformancePointSecureDataValues.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPPerformancePointSecureDataValues -schema: 2.0.0 ---- - -# Set-SPPerformancePointSecureDataValues - -## SYNOPSIS -Sets global settings for the unattended service account. - -## SYNTAX - -``` -Set-SPPerformancePointSecureDataValues - [-ServiceApplication] <SPPerformancePointMonitoringServiceApplicationPipeBind> - -DataSourceUnattendedServiceAccount <PSCredential> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPPerformancePointSecureDataValues` cmdlet sets global settings and properties for the unattended service account. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE 1-------------------- -``` -PS C:\>Set-SPPerformancePointSecureDataValues -ServiceApplication "PerformancePoint Service Application" -DataSourceUnattendedServiceAccount (get-credential) -``` - -This example shows how to set the unattended service account by prompting the user for the user name and password. - -### --------------------EXAMPLE 2-------------------- -``` -PS C:\>Set-SPPerformancePointSecureDataValues -ServiceApplication "PerformancePoint Service Application" -DataSourceUnattendedServiceAccount (New-Object System.Management.Automation.PSCredential "domain\user", (ConvertTo-SecureString "password" -AsPlainText -Force)) -``` - -This example shows how to pass the user name and password as parameters to the cmdlet. - -The DataSourceUnattendedServiceAccount parameter accepts a PSCredential object. -Therefore, to pass in this value as a parameter, a new PSCredential object must be created using the desired username and password values. -The PSCredential object requires that the password be given as a SecureString type. - -## PARAMETERS - -### -ServiceApplication -Specifies the PerformancePoint Service application that is to be configured. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DataSourceUnattendedServiceAccount -Specifies the user credentials (user name and password) for the data source of the unattended service account. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPerformancePointServiceApplication.md deleted file mode 100644 index 65f356915f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPerformancePointServiceApplication.md +++ /dev/null @@ -1,740 +0,0 @@ ---- -external help file: Microsoft.PerformancePoint.Scorecards.BIMonitoringService.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPPerformancePointServiceApplication -schema: 2.0.0 ---- - -# Set-SPPerformancePointServiceApplication - -## SYNOPSIS -Sets global runtime properties for a PerformancePoint Services application. - -## SYNTAX - -``` -Set-SPPerformancePointServiceApplication [-Identity] <SPPerformancePointMonitoringServiceApplicationPipeBind> - [-AnalyticQueryCellMax <Int32>] [-AnalyticQueryLoggingEnabled <Boolean>] [-ApplicationCacheEnabled <Boolean>] - [-ApplicationCacheMinimumHitCount <Int32>] [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] - [-ApplicationProxyCacheEnabled <Boolean>] [-AssignmentCollection <SPAssignmentCollection>] - [-CommentsDisabled <Boolean>] [-CommentsScorecardMax <Int32>] [-Confirm] [-DatabaseFailoverServer <String>] - [-DatabaseName <String>] [-DatabaseServer <String>] [-DatabaseSQLAuthenticationCredential <PSCredential>] - [-DataSourceQueryTimeoutSeconds <Int32>] [-DecompositionTreeMaximum <Int32>] [-ElementCacheSeconds <Int32>] - [-FilterRememberUserSelectionsDays <Int32>] [-FilterTreeMembersMax <Int32>] - [-IndicatorImageCacheSeconds <Int32>] [-MSMQEnabled <Boolean>] [-MSMQName <String>] - [-SelectMeasureMaximum <Int32>] [-SessionHistoryHours <Int32>] [-SettingsDatabase <String>] - [-ShowDetailsInitialRows <Int32>] [-ShowDetailsMaxRows <Int32>] [-ShowDetailsMaxRowsDisabled <Boolean>] - [-TrustedContentLocationsRestricted <Boolean>] [-TrustedDataSourceLocationsRestricted <Boolean>] [-WhatIf] - [-AnalyticResultCacheMinimumHitCount <Int32>] [-DatabaseUseWindowsAuthentication <Boolean>] - [-DataSourceUnattendedServiceAccountTargetApplication <String>] [-FilterSearchResultsMax <Int32>] - [-UseEffectiveUserName <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPPerformancePointServiceApplication` cmdlet updates global runtime properties for a PerformancePoint Service application. -The changes made to properties by using this cmdlet affect all servers in the farm that run the instance of the specified PerformancePoint Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE---------------------- -``` -PS C:\>$sa = Get-SPPerformancePointServiceApplication -PS C:\>Set-SPPerformancePointServiceApplication -Identity $sa -DataSourceQueryTimeoutSeconds 5000 -``` - -This example sets the Data Source Query Timeout setting to a value of 5000. -This cmdlet is equivalent to the PerformancePoint Service Settings page on the SharePoint Central Administration Web site. - -## PARAMETERS - -### -Identity -Specifies the PerformancePoint Service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. - -```yaml -Type: SPPerformancePointMonitoringServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AnalyticQueryCellMax -Specifies the maximum number of returned cells in an analytic grid. - -A valid integer between 1-1,000,000,000. -The default value is 100,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnalyticQueryLoggingEnabled -Turns on verbose logging of query events. - -The type must be one of the following: True, False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationCacheEnabled -Specifies whether rendered output cache on the application server is on (True) or off (False). -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationCacheMinimumHitCount -Specifies the minimum number of times rendered output must be requested before it is added to cache. -The default value is 2. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS application pool to run the Web service in for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ApplicationProxyCacheEnabled -Specifies rendered output cache on the web front end. -The default value is True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommentsDisabled -Specifies that users can add comments to scorecard cells. - -The type must be one of the following: $True, $False. -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsScorecardMax -Specifies the maximum number of comments that can be added to a scorecard. -The default value is 1000. - -The type must be an integer value in the range of 1 to 1,000,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseFailoverServer -Specifies the name of the database server that contains the PerformancePoint Services database that must be mirrored. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation 2010 with Service Pack 1 (SP1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the PerformancePoint Services database that will be created when the service application is provisioned. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation 2010 with Service Pack 1 (SP1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the database server where the PerformancePoint Services database will be created. -This should be the same server name that is used for the SharePoint content and configuration databases. - -The value may be written as SQL instance\server if it is not referring to the default instance. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseSQLAuthenticationCredential -Determines whether to use Windows authentication or SQL Server authentication when connecting to a PerformancePoint Services database. - -This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataSourceQueryTimeoutSeconds -Specifies the time, in seconds, before a data source query times out. -The default value is 300. - -The type must be an integer value in the range of 1 to 36,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecompositionTreeMaximum -Specifies the maximum number of items (per level) returned to the decomposition tree visualization. - -A valid integer value between 1-1,000,000. -The default value is 25. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElementCacheSeconds -Specifies the first class object cache expiration time. -The default value is 15. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterRememberUserSelectionsDays -Specifies the number of days that user filter selections are remembered. -The default value is 90. - -The type must be an integer value in the range of 1 to 10,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterTreeMembersMax -The maximum number of records to show in filter treeview control. -The default value is 500. - -An integer value in the range of 1 to 100,000 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IndicatorImageCacheSeconds -Specifies the time, in seconds, that key performance indicator (KPI) icons are cached. -The default value is 10. - -The type must be an integer value in the range of 1 to 3600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MSMQEnabled -Specifies that notifications are sent to Microsoft Message Queuing (MSMQ) on content change. - -The type must be one of the following: True, False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MSMQName -Specifies the name of the queue. -The queue name can contain a maximum of 380 characters and cannot contain the following characters: CR (ASCII 13), LF (ASCII 10), backslash (\\), plus sign (+), comma (,), or quotation marks (""). - -The type must be a valid MSMQ name; for example, MessageQueue1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelectMeasureMaximum -Specifies the maximum number of measures to show in a dashboard Select Measure control. -The default value is 1000. - -The type must be an integer value in the range of 1 to 1,000,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionHistoryHours -Specifies the number of hours between clearing of expired user navigation history. -The default value is 2. - -The type must be an integer value in the range of 1 to 48. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsDatabase -Specifies the name of the PerformancePoint Service database used for that service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetailsInitialRows -Specifies the initial number of rows to retrieve for show details. -The default value is 1000. - -The type must be an integer value in the range of 1 to 100,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetailsMaxRows -Specifies the maximum number of rows to retrieve for show details. - -The type must be an integer value in the range of 1 to 1,000,000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetailsMaxRowsDisabled -Turns off the ShowDetailsInitialRows setting. -If set to true, Analysis Services controls limit. - -The type must be one of the following: True, False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedContentLocationsRestricted -Specifies that only specified locations are trusted. -The default setting is false (trust all content locations). - -The type must be one of the following: True, False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedDataSourceLocationsRestricted -Specify to trust only specified data source locations. -The default is to trust all data source locations. - -The type must be one of the following: True, False. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnalyticResultCacheMinimumHitCount -The minimum number of times an analytic report needs to be accessed before caching starts happening. The default value is 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUseWindowsAuthentication -When this value is set to true, Performance Point Services disables from using SQL authentication against all data sources. - -The type must be one of the following: $True, $False. The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataSourceUnattendedServiceAccountTargetApplication -The name of the Secure Store Application that will be used by default to access data sources. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterSearchResultsMax -The maximum number of items to return on a Dashboard when viewing a filter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseEffectiveUserName -Enables the use of the Analysis Services Effective User Name feature. - -The type must be one of the following: True, False. The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPowerPointConversionServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPowerPointConversionServiceApplication.md deleted file mode 100644 index 2dc347486b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPPowerPointConversionServiceApplication.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Powerpoint.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPPowerPointConversionServiceApplication -schema: 2.0.0 ---- - -# Set-SPPowerPointConversionServiceApplication - -## SYNOPSIS -Configures settings for a PowerPoint Conversion Service application. - - -## SYNTAX - -``` -Set-SPPowerPointConversionServiceApplication [-Identity] <SPPowerPointConversionServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CacheExpirationPeriodInSeconds <UInt32>] - [-MaximumConversionsPerWorker <UInt32>] [-WorkerKeepAliveTimeoutInSeconds <UInt32>] - [-WorkerProcessCount <UInt32>] [-WorkerTimeoutInSeconds <UInt32>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPPowerPointConversionServiceApplication` cmdlet to set properties and settings for an instance of a PowerPoint Conversion Service application that is in a farm. - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SPPowerPointConversionServiceApplication -Identity "MyWorkgroupPPTApp" -CacheExpirationPeriodInSeconds 1200 -``` - -This example establishes new operational defaults for the conversion cache expiration. - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Set-SPPowerPointConversionServiceApplication -Identity "MyWorkgroupPPTApp" -DisableBinaryScan:$false -``` - -This example disables binary scanning of documents. - - -## PARAMETERS - -### -Identity -Specifies the unique name of this PowerPoint Conversion Service application. - -```yaml -Type: SPPowerPointConversionServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CacheExpirationPeriodInSeconds -Specifies the maximum time, in seconds, that items remain in the back-end server cache. -The default value is 600 seconds (10 minutes). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumConversionsPerWorker -Specifies the maximum number of presentations that a conversion worker process can convert before recycling. -The default value is 5. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerKeepAliveTimeoutInSeconds -Specifies the maximum time, in seconds, that a conversion worker process can be unresponsive before being terminated. -The default value is 120 seconds. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerProcessCount -Specifies the number of active instances of the conversion worker process on each back-end. -This value must be less than the Windows Communication Foundation (WCF) connection limit for this computer. -The default value is 3. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerTimeoutInSeconds -Specifies the maximum time, in seconds, that a conversion worker process is given for any single conversion. -The default is 300 seconds (5 minutes). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPPowerPointConversionServiceApplication](New-SPPowerPointConversionServiceApplication.md) - -[New-SPPowerPointConversionServiceApplicationProxy](New-SPPowerPointConversionServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplication.md deleted file mode 100644 index 36f2e3034f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplication.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPProfileServiceApplication -schema: 2.0.0 ---- - -# Set-SPProfileServiceApplication - -## SYNOPSIS -Sets properties of a User Profile Service application. - -## SYNTAX - -### Default -``` -Set-SPProfileServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-GetNonImportedObjects <Boolean>] [-MySiteHostLocation <SPSitePipeBind>] - [-ProfileDBCredentials <PSCredential>] [-ProfileSyncDBCredentials <PSCredential>] - [-ProfileSyncDBFailoverServer <String>] [-PurgeNonImportedObjects <Boolean>] - [-SocialDBCredentials <PSCredential>] [-SocialDBFailoverServer <String>] [-Name <String>] - [-UseOnlyPreferredDomainControllers <Boolean>] [-WhatIf] [-ProfileDBFailoverServer <String>] - [<CommonParameters>] -``` - -### MySiteSettings -``` -Set-SPProfileServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-GetNonImportedObjects <Boolean>] -MySiteHostLocation <SPSitePipeBind> - [-MySiteManagedPath <SPPrefixPipeBind>] [-ProfileDBCredentials <PSCredential>] - [-ProfileSyncDBCredentials <PSCredential>] [-ProfileSyncDBFailoverServer <String>] - [-PurgeNonImportedObjects <Boolean>] [-SiteNamingConflictResolution <String>] - [-SocialDBCredentials <PSCredential>] [-SocialDBFailoverServer <String>] [-Name <String>] - [-UseOnlyPreferredDomainControllers <Boolean>] [-WhatIf] [-ProfileDBFailoverServer <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The Set-SPProfileServiceApplication cmdlet sets properties of a User Profile Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------EXAMPLE--------------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} -PS C:\>Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true -``` - -This example purges objects from the Profile database which are not in scope of the User Profile import. - - -## PARAMETERS - -### -Identity -Specifies the User Profile Service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS application pool in which to run the Web service for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GetNonImportedObjects -Specifies whether to inform the users that did not come from the import pipeline and will be marked for deletion. -The list of users marked for deletion is displayed to the console window. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MySiteHostLocation -Specifies the site collection where the My Site will be provisioned. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MySiteManagedPath -Specifies the managed path location of personal sites. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProfileDBCredentials -Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileSyncDBCredentials -Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileSyncDBFailoverServer -Specifies the name of the failover SQL server for Profile database. -It is used to build the connection string for the Profile database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PurgeNonImportedObjects -Specifies whether to mark the non-imported users in the profile store for deletion and then inform the users that did not come from the import pipeline which will be marked for deletion. -The list of users marked for deletion is displayed on the console window - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteNamingConflictResolution -Specifies the format to use to name personal sites. - -Use one of the following integer values: - -1--Personal site collections are to be based on user names without any conflict resolution. -For example, http://portal_site/location/username/ - -2-- Personal site collections are to be based on user names with conflict resolution by using domain names. -For example, .../username/ or .../domain_username/ - -3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. -For example, http://portal_site/location/domain_username/ - -The default value is 1 (do not resolve conflicts). - -```yaml -Type: String -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialDBCredentials -The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialDBFailoverServer -Specifies the name of the failover SQL server for Social database. -It is used to build the connection string for the Social database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name for the new User Profile Service application. -The name that you use must be a unique name of a User Profile Service application in this farm. -The name can be a maximum of 128 characters. - -The type must be a valid name of a User Profile Service application; for example, UserProfileSvcApp1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseOnlyPreferredDomainControllers -Restricts profile synchronization communication to a specific domain controller. - -The valid values are $true or $false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileDBFailoverServer -Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplicationProxy.md deleted file mode 100644 index df372558ec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplicationProxy.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPProfileServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPProfileServiceApplicationProxy - -## SYNOPSIS -Sets properties of a proxy for a User Profile Service application. - -## SYNTAX - -``` -Set-SPProfileServiceApplicationProxy [-Identity] <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] - [-MySiteHostLocation <SPSitePipeBind>] [-MySiteManagedPath <SPPrefixPipeBind>] [-Name <String>] - [-SiteNamingConflictResolution <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProfileServiceApplicationProxy` cmdlet sets properties of a proxy for a User Profile Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ----------------EXAMPLE--------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Set-SPProfileServiceApplicationProxy -Identity $proxy -SiteNamingConflictResolution 2 -``` - -This example sets the User Profile Service Application Proxy to use a site naming conflict resolution to use domain names prefixed to usernames. - - -## PARAMETERS - -### -Identity -Specifies the User Profile Service application proxy to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the User Profile Service application proxy is added to the default proxy group for the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MySiteHostLocation -Specifies the site collection where the My Site will be created. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MySiteManagedPath -Specifies the managed path location of personal sites. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the display name for the User Profile Service application. -The name that you use must be a unique name of a User Profile Service application in this farm. -The name can be a maximum of 128 characters. - -The type must be a name of a valid service application proxy; for example, UserProfileSvcProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteNamingConflictResolution -Specifies the format to use to name personal sites. - -Use one of the following integer values: - -1 Personal site collections are to be based on user names without any conflict resolution. -For example, http://portal_site/location/username/ - -2 Personal site collections are to be based on user names with conflict resolution by using domain names. -For example, .../username/ or .../domain_username/ - -3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. -For example, http://portal_site/location/domain_username/ - -The default value is 1 (do not resolve conflicts). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplicationSecurity.md deleted file mode 100644 index 5298f12cfe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProfileServiceApplicationSecurity.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPProfileServiceApplicationSecurity -schema: 2.0.0 ---- - -# Set-SPProfileServiceApplicationSecurity - -## SYNOPSIS -Sets permission and identity information. - -## SYNTAX - -``` -Set-SPProfileServiceApplicationSecurity -Identity <SPObjectSecurity> - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [-Type <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPProfileServiceApplictionSecurity` cmdlet to set permission and identity information for the following User Profile objects: - -- Read individual My Sites -- Use Personal Features -- Use Social Features -- Create Personal Site - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>$security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy -PS C:\>$everyone = New-SPClaimsPrincipal -Identity 'c:0(.s|true' -IdentityType EncodedClaim -PS C:\>Revoke-SPObjectSecurity -Identity $security -Principal $everyone -Rights 'Create Personal Site' -PS C:\>Set-SPProfileServiceApplicationSecurity -Identity $security -ProfileServiceApplicationProxy $proxy -``` - -This example revokes the right 'Create Personal Site' from All Authenticated Users. - - -## PARAMETERS - -### -Identity -Specifies the User Profile Service Application security object. - -```yaml -Type: SPObjectSecurity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the unique identifier for the proxy. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of object to display. - -The type is any one of the following values: - -- MySiteReaderACL -- UserACL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectDatabaseQuota.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectDatabaseQuota.md deleted file mode 100644 index fdad0ba3d8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectDatabaseQuota.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectDatabaseQuota -schema: 2.0.0 ---- - -# Set-SPProjectDatabaseQuota - -## SYNOPSIS -Microsoft internal use only. - -## SYNTAX - -### settings -``` -Set-SPProjectDatabaseQuota [-Settings] <ProjectDatabaseQuotaSettings> -Url <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### options -``` -Set-SPProjectDatabaseQuota [-Enabled] -MaxDbSize <Int32> -ReadOnlyLimit <Int32> - -ReadOnlyWarningThreshold <Int32> -Url <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Microsoft internal use only. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -Settings -Microsoft internal use only. - -```yaml -Type: ProjectDatabaseQuotaSettings -Parameter Sets: settings -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDbSize -Microsoft internal use only. - -```yaml -Type: Int32 -Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadOnlyLimit -Microsoft internal use only. - -```yaml -Type: Int32 -Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadOnlyWarningThreshold -Microsoft internal use only. - -```yaml -Type: Int32 -Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Microsoft internal use only. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Microsoft internal use only. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectEventServiceSettings.md deleted file mode 100644 index 2ce05ac944..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectEventServiceSettings.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2016, Project Server 2019 -title: Set-SPProjectEventServiceSettings -schema: 2.0.0 ---- - -# Set-SPProjectEventServiceSettings - -## SYNOPSIS -Allows you to change the Microsoft Project Server Events Service 2016 TCP port settings. If you change the TCP port, the Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - -## SYNTAX - -``` -Set-SPProjectEventServiceSettings [-AssignmentCollection <SPAssignmentCollection>] [-NetTcpPort <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -Allows you to change the Microsoft Project Server Events Service 2016 TCP port settings. If you change the TCP port, the Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPProjectEventServiceSettings -NetTcpPort 16100 -``` - -This example tells the service to listen on port 16100. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetTcpPort -TCP port to listen on. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectOdataConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectOdataConfiguration.md deleted file mode 100644 index a6b0dcfd44..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectOdataConfiguration.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectOdataConfiguration -schema: 2.0.0 ---- - -# Set-SPProjectOdataConfiguration - -## SYNOPSIS -Sets the properties for how the OData service is configured for an instance of Project Web App. - -## SYNTAX - -``` -Set-SPProjectOdataConfiguration [-AcceptCountRequests <Boolean>] [-AcceptProjectionRequests <Boolean>] - [-AssignmentCollection <SPAssignmentCollection>] [-ClearEntityPageSizeOverrides] [-DefaultMaxPageSize <Int32>] - [-EntitySetName <String>] [-MaxResultsPerCollection <Int32>] [-PageSizeOverride <Int32>] - [-UseVerboseErrors <Boolean>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectOdataConfiguration` cmdlet sets the settings for how the OData service is configured for an instance of Project Web App. -It allows the user to configure the settings for a list of parameters that specify paging, the enabling of various querying functionality, whether MaxResultsPerCollection has been enabled and whether verbose errors are enabled. -Paging can be specified per entity. -If no paging overrides exist for a given entity, the DefaultMaxPageSize parameter is used. -MaxResultsPerCollection cannot be used in conjunction with paging. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ----------------------EXAMPLE 1----------------------- -``` -PS C:\>Set-SPProjectOdataConfiguration -ClearEntityPageSizeOverrides -``` - -This example clears any page size overrides that have been set for any specific entities. - - -### ----------------------EXAMPLE 2----------------------- -``` -PS C:\>Set-SPProjectOdataConfiguration -AcceptProjectionRequests $true -``` - -This example sets AcceptProjectionRequests to true. - - -### ----------------------EXAMPLE 3----------------------- -``` -PS C:\>Set-SPProjectOdataConfiguration -DefaultMaxPageSize 50 -``` - -This example sets the default maximum page size to 50 rows. - - -### ----------------------EXAMPLE 4----------------------- -``` -PS C:\>Set-SPProjectOdataConfiguration -EntitySetName Assignments -PageSizeOverride 100 -``` - -This example sets the page size override for the Assignments entity. - - -## PARAMETERS - -### -AcceptCountRequests -Sets whether requests with the $count path segment or the $inlinecount query options are accepted. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptProjectionRequests -Sets whether projection requests should be accepted. -Projection requests are made by using the $select query option. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClearEntityPageSizeOverrides -Clears all page-size overrides that had been set for any entities. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultMaxPageSize -Sets the default page size. -This is used for any entities that do not have an override set using the PageSizeOverride parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntitySetName -Specifies the entity name that is used to set a page size override with PageSizeOverride. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxResultsPerCollection -Sets the integer value that indicates the maximum number of results per entity. -This parameter cannot be used in conjunction with paging. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSizeOverride -Overrides the page size that is used for a specific entity. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseVerboseErrors -Sets the service to use more verbose error messages (for example, stack trace). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectPCSSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectPCSSettings.md deleted file mode 100644 index b934e802cb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectPCSSettings.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectPCSSettings -schema: 2.0.0 ---- - -# Set-SPProjectPCSSettings - -## SYNOPSIS -Sets the settings for the Project Calculation Engine on Project Server. - -## SYNTAX - -``` -Set-SPProjectPCSSettings [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-CachePersistence <Int32>] [-EditingSessionTimeout <Int32>] - [-MaximumIdleWorkersCount <Int32>] [-MaximumProjectSize <Int32>] [-MaximumSessionsPerUser <Int32>] - [-MaximumWorkersCount <Int32>] [-MinimumMemoryRequired <Int32>] [-RequestTimeLimits <Int32>] - [-NetTcpPort <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectPCSSettings` cmdlet lets you configure the different settings that govern the operations of the Project Calculation Engine on Project Server. -The settings are per service application, which is identified by the Service Application parameter provided to this cmdlet. -The settings have maximum and minimum values that are enforced by Project Server. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPProjectPCSSettings -sa "Project Service Application" -MaximumSessionsPerUser 500 -``` - -This example sets 500 as the maximum allowed Project Calculation Engine sessions that a user can open on the "Project Service Application" service application. - - -## PARAMETERS - -### -ServiceApplication -The Project Server service application for which the settings are to be read. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CachePersistence -The maximum length of time before the Project Calculation Engine can begin to remove temporary cache files of projects opened on the Project Server service application. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EditingSessionTimeout -The maximum length of time that a user can be idle in a Project Calculation Engine session before a timeout occurs. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumIdleWorkersCount -The maximum number of idle Project Calculation Engine sessions available at a given time. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumProjectSize -The maximum size of a project that can be opened by the Project Calculation Engine. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumSessionsPerUser -The maximum number of sessions that a user is allowed to open. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumWorkersCount -The maximum number of Project Calculation Engine sessions that can be created. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumMemoryRequired -The minimum memory required before launching a new Project Calculation Engine session. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeLimits -The maximum allowable time for a request to the Project Calculation Engine to complete before the Project Calculation Engine session is terminated. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetTcpPort -The TCP port to use with the PCS service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectPermissionMode.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectPermissionMode.md deleted file mode 100644 index 808e4ba5c2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectPermissionMode.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectPermissionMode -schema: 2.0.0 ---- - -# Set-SPProjectPermissionMode - -## SYNOPSIS -Changes the permission mode for a Project Web App instance. -Running this cmdlet deletes all security settings and reverts to the default settings for the specified mode. - -## SYNTAX - -``` -Set-SPProjectPermissionMode [-Url] <Uri> [-Mode] <PermissionMode> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectPermissionMode` cmdlet changes the permission mode for the specified Project Web App instance. - -Switching security modes deletes all permissions configuration information for the specified Project Web App instance and reverts to the default settings for the specified mode. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------EXAMPLE 1------------------- -``` -PS C:\>Set-SPPRojectPermissionMode -Url http://AppServer/pwa -AdministratorAccount contoso\John.Woods -Mode ProjectServer -``` - -This example shows the syntax for transitioning a server into Project Server permission mode. - - -### --------------EXAMPLE 2------------------- -``` -PS C:\>Set-SPPRojectPermissionMode -Url http://AppServer/pwa -AdministratorAccount contoso\John.Woods -Mode SharePoint -``` - -This example shows the syntax for transitioning a server into SharePoint permission mode. - - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App instance for which the permission mode is to be changed. - -The type must be a valid URL, in the form http://\<ServerName\>/\<PWAName\>. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the mode into which the instance should be changed. - -The type must be a valid permission mode, in the form SharePoint or ProjectServer. - -```yaml -Type: PermissionMode -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPProjectPermissionMode](Get-SPProjectPermissionMode.md) - -[Invoke-SPProjectActiveDirectoryGroupSync](Invoke-SPProjectActiveDirectoryGroupSync.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectQueueSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectQueueSettings.md deleted file mode 100644 index 38994ff03d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectQueueSettings.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectQueueSettings -schema: 2.0.0 ---- - -# Set-SPProjectQueueSettings - -## SYNOPSIS -Sets the value of one or multiple Project Server Queue settings for a specific Project Server service application. - -## SYNTAX - -``` -Set-SPProjectQueueSettings [-ServiceApplication <PsiServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-CleanupNonSuccessAgeLimit <Int32>] - [-CleanupSuccessAgeLimit <Int32>] [-MaxConnections <Int32>] [-MaxDegreeOfConcurrency <Int32>] - [-MsgRetryInterval <Int32>] [-MsgRetryLimit <Int32>] [-PeriodicTasksInterval <Int32>] [-QueueTimeout <Int32>] - [-SqlCommandTimeout <Int32>] [-SqlRetryInterval <Int32>] [-SqlRetryLimit <Int32>] [-NetTcpPort <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -Sets the value of one or multiple Project Server Queue settings for a specific Project Server service application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPProjectQueueSettings -ServiceApplication "Project Service Application" -MaxDegreeOfConcurrency 6 -``` - -This example sets a maximum of 6 for the number of jobs that can be processed at one time by the specified service application. - - -## PARAMETERS - -### -ServiceApplication -Specifies the Project Server service application to target. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CleanupNonSuccessAgeLimit -This setting determines the age threshold at which any job in a completed, non-successful state (example: Failed But Not Blocking Correlation) can be purged when the Queue Cleanup job runs. -The age of each job is determined by the completed date and time. -For example, if a job was cancelled at 2/1/2007 10:41 p.m. -and the Queue Cleanup job runs at 2/2/2007 11:55 p.m., then the job will not be purged (assuming the Cleanup Age Limit For Non-successful Jobs was 7 days). -Because the number of completed, non-successful jobs is usually not high, the Cleanup Age Limit For Non-successful Jobs setting is usually set to a high value of 168 (7 days). - -Minimum: 1;Maximum: 100000;Default: 168 (7 days) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CleanupSuccessAgeLimit -This setting determines the age threshold at which successful jobs can be purged when the Queue Cleanup job runs. -The age of each job is determined by the completed date and time. -For example, if a job succeeded at 2/1/2007 10:41 p.m. -and the Queue Cleanup job runs at 2/2/2007 11:55 p.m., then the job will be purged (assuming the Cleanup Age Limit For Successful Jobs was 1 day). -Since the number of successful jobs is usually high, the Cleanup Age Limit For Successful Jobs setting is usually set to a low value of 24 (1 day). - -Minimum: 1;Maximum: 100000;Default: 24 (1 day) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxConnections -Maximum number of Queue connections allowed to be pending dispatch on the server. - -Default: 10 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDegreeOfConcurrency -The Queue is multi-threaded, which enables multiple jobs to be processed at the same time. -This setting limits the degree of concurrency of the queue. -Note that this setting is per Project Server service application. - -Minimum: 1;Maximum: 10;Default: 4 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsgRetryInterval -If job processing fails due to transient issues (like a SQL Deadlock), instead of failing the job, the Queue will wait for the Retry Interval to elapse and retry the job. - -Minimum: 0 (immediately retry);Maximum: 300000 (5 minutes);Default: 1000 (1 second) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsgRetryLimit -If job processing fails due to transient issues (like a SQL Deadlock), instead of failing the job, the Queue will retry the job. -The number of retries is bound by the Retry Limit. - -Minimum: 0 (no retries);Maximum: 100;Default: 5 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeriodicTasksInterval -There are a number of bookkeeping tasks executed by the Queue System. -Some examples are awakening jobs in 'Sleeping' state, updating the heartbeat timestamp, checking whether Queue Cleanup needs to be executed and so on. -This setting controls the time interval at which these tasks run. - -Minimum: 500 (1/2 second);Maximum: 300000 (5 minutes);Default: 10000 (10 second) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueTimeout -The Queue System has a failover recovery feature. -If the farm contains multiple servers running the Project Server Application Service and the Queue Service fails on one server, jobs are automatically redistributed to other servers on which the Queue Service is online. -A Queue Service is considered to have timed out if it cannot be accessed from the Queue health timer job for more than the 'Queue Timeout' interval. - -Minimum: 5 minutes;Maximum: 60 minutes;Default: 15 minutes - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlCommandTimeout -The Queue makes SQL calls for retrieving and executing jobs. -This setting controls the timeout value for all such calls. -If any job fails due to a SQL Timeout error, administrators can increase this setting and retry the job. - -Minimum: 30 seconds;Maximum: 86400 (1 day);Default: 1800 (30 minutes) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlRetryInterval -If the Queue fails to connect to a Project Web App database due to a transient SQL problem (like a SQL Deadlock), the Queue will wait for the SQL Retry Interval to elapse and retry the query. - -Minimum: 0 (immediately retry);Maximum: 60000 (1 minute);Default: 1000 (1 second) - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlRetryLimit -If the Queue fails to connect to a Project Web App database due to a transient SQL problem (like a SQL Deadlock), the Queue will retry the query after the SQL Retry Interval has elapsed. -The number of retries is bound by the SQL Retry Limit. - -Minimum: 0 (no retries)Maximum: 100Default: 5 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetTcpPort -Sets the TCP port the Project Queue service uses. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectServiceApplication.md deleted file mode 100644 index ecc3f06fcd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectServiceApplication.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectServiceApplication -schema: 2.0.0 ---- - -# Set-SPProjectServiceApplication - -## SYNOPSIS -Sets the properties of a Project Server Service application. - -## SYNTAX - -``` -Set-SPProjectServiceApplication [-Identity] <PsiServiceApplicationPipeBind> - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectServiceApplication` cmdlet sets the properties of a Project Server Service application. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set- SPProjectServiceApplication -Identity PSIServiceApp -ApplicationPool newapppool RegisterTimerJob -``` - -This example updates the application pool and re-registers the timer job for a Project Server Service application. - - -## PARAMETERS - -### -Identity -Specifies the Project Server Service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS application pool to run the web service in for the service application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSync.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSync.md deleted file mode 100644 index cde4b0efb5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSync.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectUserSync -schema: 2.0.0 ---- - -# Set-SPProjectUserSync - -## SYNOPSIS -Controls the behavior of WSS user sync. - -## SYNTAX - -``` -Set-SPProjectUserSync [-Url] <Uri> [-Value] <UserSyncParameterValues[]> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -WSS User sync synchronizes Project Server permissions with SharePoint Server permissions. -When users are granted permissions to Project Server entities, permissions are granted to the Project Web App site and the connected SharePoint sites. -By using this cmdlet, administrators can control the behavior of WSS User sync. -They can choose to disable WSS User sync, enable it only for the Project Web App site, enable it only for connected SharePoint sites, or enable for both. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPProjectUserSync http://localhost/pwa EnablePWA -``` - -In this example, WSS User sync is enabled for the Project Web App site at http://localhost/pwa. - - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App instance to set the Project User Sync settings. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Disabled completely disables WSS User Sync; EnablePWA enables WSS User sync for the Project Web App site; EnableEntProj enables WSS User sync for all SharePoint sites connected to Enterprise Projects; EnableSPProj enables WSS User sync for all SharePoint sites connected to SharePoint Projects; EnableAll enables WSS User sync for the Project Web App site and all connected SharePoint sites. - -```yaml -Type: UserSyncParameterValues[] -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPProjectUserSyncDisabledSyncThreshold](Set-SPProjectUserSyncDisabledSyncThreshold.md) - -[Set-SPProjectUserSyncFullSyncThreshold](Set-SPProjectUserSyncFullSyncThreshold.md) - -[Set-SPProjectUserSyncOffPeakSyncThreshold](Set-SPProjectUserSyncOffPeakSyncThreshold.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncDisabledSyncThreshold.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncDisabledSyncThreshold.md deleted file mode 100644 index 7fc3c0f90b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncDisabledSyncThreshold.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectUserSyncDisabledSyncThreshold -schema: 2.0.0 ---- - -# Set-SPProjectUserSyncDisabledSyncThreshold - -## SYNOPSIS -Defines the threshold over which a user sync job will not be executed but instead will be deleted. -This threshold is the product of the number of projects multiplied by the number of users. - -## SYNTAX - -``` -Set-SPProjectUserSyncDisabledSyncThreshold [-Url] <Uri> [-Threshold] <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectUserSyncDisabledSyncThreshold` cmdlet d the threshold over which a user sync job will not be executed but instead will be deleted. -This threshold is the product of the number of projects multiplied by the number of users. -The purpose of configuring this threshold is to prevent malicious user syncs of the whole server. -Set it to a negative value to reset to default value (not set). - -This cmdlet only works in Project Server Permission mode. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPProjectUserSyncDisabledSyncThreshold -URL http//contoso-AppSrv/PWA -Threshold 400 -``` - -This example sets the sync disable threshold for the Project Web App instance at http//contoso-AppSrv/PWA to 400. - - -## PARAMETERS - -### -Url -The URL of the Project Web App instance where you want to set the threshold. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -A whole number consisting of the number of projects multiplied by the number of users. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPProjectUserSync](Set-SPProjectUserSync.md) - -[Set-SPProjectUserSyncFullSyncThreshold](Set-SPProjectUserSyncFullSyncThreshold.md) - -[Set-SPProjectUserSyncOffPeakSyncThreshold](Set-SPProjectUserSyncOffPeakSyncThreshold.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncFullSyncThreshold.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncFullSyncThreshold.md deleted file mode 100644 index ec24ea1aad..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncFullSyncThreshold.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectUserSyncFullSyncThreshold -schema: 2.0.0 ---- - -# Set-SPProjectUserSyncFullSyncThreshold - -## SYNOPSIS -Defines the threshold over which a delta user sync job will be executed as a complete user sync. -This threshold is the product of the number of projects multiplied by the number of users. - -## SYNTAX - -``` -Set-SPProjectUserSyncFullSyncThreshold [-Url] <Uri> [-Threshold] <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectUserSyncFullSyncThreshold` cmdlet defines the threshold over which a delta user sync job will be executed as a complete user sync. -This threshold is the product of the number of projects multiplied by the number of users. -The purpose of this threshold is to use the full sync method instead of the delta sync method when the amount of changes is large enough. -Set it to a negative value to reset to the default (not set). - -This cmdlet only works in Project Server Permission mode. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPProjectUserSyncFullSyncThreshold -URL http://contoso-AppSrv/ -Threshold 800 -``` - -This example sets the full user sync threshold for the Project Web App instance at http//contoso-AppSrv/PWA to 800. - - -## PARAMETERS - -### -Url -The URL of the Project Web App instance where you want to set the threshold. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -A whole number consisting of the number of projects multiplied by the number of users. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPProjectUserSync](Set-SPProjectUserSync.md) - -[Set-SPProjectUserSyncDisabledSyncThreshold](Set-SPProjectUserSyncDisabledSyncThreshold.md) - -[Set-SPProjectUserSyncOffPeakSyncThreshold](Set-SPProjectUserSyncOffPeakSyncThreshold.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncOffPeakSyncThreshold.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncOffPeakSyncThreshold.md deleted file mode 100644 index cb6fb6194c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPProjectUserSyncOffPeakSyncThreshold.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Set-SPProjectUserSyncOffPeakSyncThreshold -schema: 2.0.0 ---- - -# Set-SPProjectUserSyncOffPeakSyncThreshold - -## SYNOPSIS -Defines the threshold over which a full user sync job will be executed during off peak hours instead of immediately. -This threshold is the product of the number of projects multiplied by the number of users. - -## SYNTAX - -``` -Set-SPProjectUserSyncOffPeakSyncThreshold [-Url] <Uri> [-Threshold] <Int32> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPProjectUserSyncOffPeakSyncThreshold` cmdlet defines the threshold over which a full user sync job will be executed during off-peak hours instead of immediately. -This threshold is the product of the number of projects multiplied by the number of users. -This threshold is used to preserve server performance. -Set it to a negative value to reset to the default of no threshold configured. - -This cmdlet only works in Project Server Permission mode. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPProjectUserSyncOffPeakSyncThreshold -URL http://contoso/PWA -Threshold 900000 -``` - -This example sets the sync off-peak threshold for the Project Web App instance at http//contoso-AppSrv/PWA to 900000. - - -## PARAMETERS - -### -Url -The URL of the Project Web App instance where you want to set the threshold. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -A whole number consisting of the number of projects multiplied by the number of users. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPProjectUserSync](Set-SPProjectUserSync.md) - -[Set-SPProjectUserSyncDisabledSyncThreshold](Set-SPProjectUserSyncDisabledSyncThreshold.md) - -[Set-SPProjectUserSyncFullSyncThreshold](Set-SPProjectUserSyncFullSyncThreshold.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRequestManagementSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRequestManagementSettings.md deleted file mode 100644 index ef5d0bcc11..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRequestManagementSettings.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPRequestManagementSettings -schema: 2.0.0 ---- - -# Set-SPRequestManagementSettings - -## SYNOPSIS -Sets Request Manager properties. - - -## SYNTAX - -``` -Set-SPRequestManagementSettings [-Identity] <SPRequestManagementSettingsPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-RoutingEnabled] [-RoutingScheme <SPRoutingScheme>] - [-ThrottlingEnabled] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPRequestManagementSettings` cmdlet to set properties for the Request Manager. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$wa = Get-SPWebApplication http://webAppUrl -PS C:\>$req = $wa | Get-SPRequestManagementSettings -PS C:\>Set-SPRequestManagementSettings -Identity $req -ThrottlingEnabled:$false -``` - -This example disables throttling on the specified Web Application. - -## PARAMETERS - -### -Identity -Specifies the Request Manager object for which settings will be applied. - -```yaml -Type: SPRequestManagementSettingsPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RoutingEnabled -Specifies whether routing is enabled or disabled for the Request Manager object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingScheme -Specifies the routing scheme. - -The value is one of the following: - ---Default- Performs random selection. ---StaticMachineWeight- Uses Static weight of target. ---HealthBased- Considers health score of machine. - -```yaml -Type: SPRoutingScheme -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottlingEnabled -Specifies whether throttling is enabled or disabled for the Request Manager object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPRequestManagementSettings](Get-SPRequestManagementSettings.md) - -[New-SPRequestManagementRuleCriteria](New-SPRequestManagementRuleCriteria.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingMachineInfo.md deleted file mode 100644 index 6f18a89986..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingMachineInfo.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPRoutingMachineInfo -schema: 2.0.0 ---- - -# Set-SPRoutingMachineInfo - -## SYNOPSIS -Sets routing target properties. - - -## SYNTAX - -``` -Set-SPRoutingMachineInfo [-Identity] <SPRoutingMachineInfoPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Availability <SPRoutingMachineAvailability>] - [-ClearOutgoingPort] [-OutgoingPort <Int32>] [-OutgoingScheme <SPRoutingOutgoingScheme>] - [-StaticWeight <Double>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPRoutingMachineInfo` cmdlet to set routing target properties by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$wa = Get-SPWebApplication -Identity http://webAppUrl -PS C:\>$rm = Get-SPRequestManagementSettings -Identity $wa -PS C:\>$m = Get-SPRoutingMachineInfo -RequestManagementSettings $rm -Name SP01 -PS C:\>Set-SPRoutingMachineInfo -Identity $m -Availability Unavailable -``` - -This example sets the "Availability" routing target property to Unavailable for a specified identity. - -## PARAMETERS - -### -Identity -Specifies the name of the request management settings object to set. - -```yaml -Type: SPRoutingMachineInfoPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Availability -Specifies whether or not the specified computer will be available for routing. - -The valid values are: - ---Available ---Unavailable - -```yaml -Type: SPRoutingMachineAvailability -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClearOutgoingPort -Clears the outgoing port if it is set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutgoingPort -Specifies the port used by Request Manager to make an outgoing connection. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutgoingScheme -Determines the schema of outgoing connections. - -The valid values are: - ---SameAsIncoming ---Http ---Https - -```yaml -Type: SPRoutingOutgoingScheme -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticWeight -Specifies whether the static weight of a computer routing is used by Request Manager. -If the static weight is higher, more requests will be routed to the computer. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingMachineInfo](Add-SPRoutingMachineInfo.md) - -[Get-SPRoutingMachineInfo](Get-SPRoutingMachineInfo.md) - -[Remove-SPRoutingMachineInfo](Remove-SPRoutingMachineInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingMachinePool.md deleted file mode 100644 index efc73104dc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingMachinePool.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPRoutingMachinePool -schema: 2.0.0 ---- - -# Set-SPRoutingMachinePool - -## SYNOPSIS -Sets properties of a machine pool. - - -## SYNTAX - -``` -Set-SPRoutingMachinePool [-Identity] <SPRoutingMachinePoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-MachineTargets <SPRoutingRuleTargetPipeBind[]>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPRoutingMachinePool` cmdlet to set properties of a machine pool by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$wa = Get-SPWebApplication -Identity http://webAppUrl -PS C:\>$rm = Get-SPRequestManagementSettings -Identity $wa -PS C:\>$pool = Get-SPRoutingMachinePool -RequestManagementSettings $rm -Name 'MachinePool' -PS C:\>$newMachine = Get-SPRoutingMachineInfo -RequestManagementSettings $rm -Name SP01 -PS C:\>Set-SPRoutingMachinePool -Identity $pool -MachineTargets ($pool.MachineTargets + $newMachine) -``` -This example sets the routing machine pool on the specified Web Application. Using the Request Management settings of the Web Application, it retrieves the existing routing machine pool named 'MachinePool'. It then gets the routing machine info for a new machine to add to the pool. Lastly, it sets the pool with the existing machine targets plus the new machine target. - -## PARAMETERS - -### -Identity -Specifies the name of the request management settings object to set. - -```yaml -Type: SPRoutingMachinePoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MachineTargets -Specifies the routing targets collection that the machine pool will contain. - -```yaml -Type: SPRoutingRuleTargetPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingMachinePool](Add-SPRoutingMachinePool.md) - -[Get-SPRoutingMachinePool](Get-SPRoutingMachinePool.md) - -[Remove-SPRoutingMachinePool](Remove-SPRoutingMachinePool.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingRule.md deleted file mode 100644 index f19c3351bc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPRoutingRule.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPRoutingRule -schema: 2.0.0 ---- - -# Set-SPRoutingRule - -## SYNOPSIS -Changes properties of an existing routing rule. - - -## SYNTAX - -``` -Set-SPRoutingRule [-Identity] <SPRoutingRulePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] [-ExecutionGroup <Int32>] [-Expiration <DateTime>] - [-MachinePool <SPRoutingMachinePoolPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPRoutingRule` cmdlet to change properties of an existing routing rule. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>$wa = Get-SPWebApplication http://webAppUrl -PS C:\>$rm = Get-SPRequestManagementSettings -Identity $wa -PS C:\>Get-SPRoutingRule -RequestManagementSettings $rm -PS C:\>$machines = Get-SPRoutingMachineInfo -RequestManagementSettings $rm -PS C:\>$pool = Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machines -PS C:\>$criteria = New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false -PS C:\>$rule = Add-SPRoutingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -MachinePool $pool -PS C:\>$criteriaNew = New-SPRequestManagementRuleCriteria -Property UserAgent -MatchType Equals -Value "Mozilla/4.0 (compatible; MSIE 4.01; Windows NT; MS Search 6.0 Robot)" -PS C:\>Set-SPRoutingRule -Identity $rule -Criteria $criteriaNew -``` - -This example sets a routing rule for the specified identity by using the $rule variable. - - -## PARAMETERS - -### -Identity -Specifies the name of the request management settings object to set. - -```yaml -Type: SPRoutingRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Criteria -Specifies the criteria for the rule to match. - -```yaml -Type: SPRequestManagementRuleCriteriaPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutionGroup -Specifies the group in which the rule will be placed. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expiration -Specifies the expiration date and time of the rule. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachinePool -Specifies the pool of machines to which a request will be routed if the changed rule is matched. - -```yaml -Type: SPRoutingMachinePoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPRoutingRule](Add-SPRoutingRule.md) - -[Get-SPRoutingRule](Get-SPRoutingRule.md) - -[Remove-SPRoutingRule](Remove-SPRoutingRule.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPScaleOutDatabaseDataRange.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPScaleOutDatabaseDataRange.md deleted file mode 100644 index d503aa3fe7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPScaleOutDatabaseDataRange.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPScaleOutDatabaseDataRange -schema: 2.0.0 ---- - -# Set-SPScaleOutDatabaseDataRange - -## SYNOPSIS -Extends the range of a specified scale-out database. - - -## SYNTAX - -``` -Set-SPScaleOutDatabaseDataRange -Database <SPDatabasePipeBind> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-NewRangePoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPScaleOutDatabaseDataRange` cmdlet to extend the range of a specified scale-out database towards a specified direction. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -C:\PS>$state = Get-SPScaleOutDatabaseDataState -Database $database - -PS C:\>Set-SPScaleOutDatabaseDataRange -Database $database -Range $state.Range -NewRangePoint $null -IsUpperSubRange $true -``` - -This example extends the data range end point of the first database in the specified service application up to the maximum range point. - - -## PARAMETERS - -### -Database -Specifies the scale-out database to which to extend the data range. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsUpperSubRange -Specifies whether to set the start or the end point of the data range with the specified value in the NewRangePoint parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range -Specifies the expected data range of the scale-out database. - -```yaml -Type: SPScaleOutDataRange -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewRangePoint -Specifies the new start or end point of the database. - -The maximum value is NULL. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-SPScaleOutDatabaseDataSubRange](Set-SPScaleOutDatabaseDataSubRange.md) - -[Get-SPScaleOutDatabase](Get-SPScaleOutDatabase.md) - -[Get-SPScaleOutDatabaseDataState](Get-SPScaleOutDatabaseDataState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPScaleOutDatabaseDataSubRange.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPScaleOutDatabaseDataSubRange.md deleted file mode 100644 index 0cda4d4f90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPScaleOutDatabaseDataSubRange.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPScaleOutDatabaseDataSubRange -schema: 2.0.0 ---- - -# Set-SPScaleOutDatabaseDataSubRange - -## SYNOPSIS -Creates a subrange for a specified scale-out database. - - -## SYNTAX - -### UnattachedDatabase -``` -Set-SPScaleOutDatabaseDataSubRange -ConnectionString <String> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> -SubRangeMode <SPScaleOutDatabaseSubRangeMode> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-IgnoreSubRangePointOnBoundary] - [-IsAzureDatabase] [-SubRangePoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -### AttachedDatabase -``` -Set-SPScaleOutDatabaseDataSubRange -Database <SPDatabasePipeBind> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> -SubRangeMode <SPScaleOutDatabaseSubRangeMode> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-IgnoreSubRangePointOnBoundary] - [-SubRangePoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPScaleOutDatabaseDataSubRange` cmdlet to create a subrange with the specified parameters for a specified scale-out database or a database which will be connected with a specified connection string. -A subrange is a subset of a range of data. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication - -C:\PS>$database = $databases[0] - -C:\PS>$state = Get-SPScaleOutDatabaseDataState -Database $database - -PS C:\>Set-SPScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubRangePoint $state.Range.RangeEnd -SubRangeMode ReadOnly -IsUpperSubRange $false -``` - -This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. - - -## PARAMETERS - -### -ConnectionString -Specifies the connection string for the scale-out database to create the new data sub-range. - -```yaml -Type: String -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -Specifies the scale-out database to create the data subrange. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsUpperSubRange -Specifies whether to create the data subrange on the upper or lower side of the data range. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range -Specifies the expected current range of the scale-out database prior to this operation. - -```yaml -Type: SPScaleOutDataRange -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubRangeMode -Specifies the mode of the data subrange to be created. -The data subrange mode values are the following: - ---NULL- The data subrange on the specified side (lower or upper) of the data range will be removed. ---ReadOnly - The partitions which are inside the new data subrange can be read, but cannot be modified. ---Changing -The partitions which are inside the new data subrange cannot be read or modified ---Deleted- The partitions which are inside the new data subrange cannot be read or modified - -```yaml -Type: SPScaleOutDatabaseSubRangeMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSubRangePointOnBoundary -Specifies whether to complete without any errors if the new subrange's start and end points are the same. -If this parameter is specified, no errors are displayed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAzureDatabase -Specifies whether the database is hosted on SQL Azure. - -```yaml -Type: SwitchParameter -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubRangePoint -Specifies the start or end point of the data subrange to be created as defined by the following criteria: - ---The start point if the data sub-range is created on the upper side of the data range. ---The end point if the data sub-range is created on the lower side of the data range. - -The maximum value is NULL. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-SPScaleOutDatabaseDeletedDataSubRange](Clear-SPScaleOutDatabaseDeletedDataSubRange.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreApplication.md deleted file mode 100644 index d746ddda8f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreApplication.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSecureStoreApplication -schema: 2.0.0 ---- - -# Set-SPSecureStoreApplication - -## SYNOPSIS -Sets properties of a Secure Store application. - - -## SYNTAX - -``` -Set-SPSecureStoreApplication -Identity <SPSecureStoreApplication> [-Administrator <SPClaim[]>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-CredentialsOwnerGroup <SPClaim[]>] - [-Fields <TargetApplicationField[]>] [-TargetApplication <TargetApplication>] [-TicketRedeemer <SPClaim[]>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSecureStoreApplication` cmdlet sets properties of a Secure Store application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$targetApp.FriendlyName = "Updated Contoso Target App" - -PS C:\>Set-SPSecureStoreApplication -Identity $application -TargetApplication $targetApp -``` - -This example sets a new display name Updated Contoso Target App for the target application. - - -## PARAMETERS - -### -Identity -Specifies the Secure Store application to update. - -```yaml -Type: SPSecureStoreApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Administrator -Specifies the administrator of the Secure Store application. - -```yaml -Type: SPClaim[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CredentialsOwnerGroup -Specifies the claims object for the groups that own the group credentials. - -```yaml -Type: SPClaim[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -Specifies the field information for the application. -The default fields are username and password. - -```yaml -Type: TargetApplicationField[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetApplication -Specifies the target application. - -```yaml -Type: TargetApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TicketRedeemer -Specifies the ticket redeemer claim value. - -```yaml -Type: SPClaim[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreDefaultProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreDefaultProvider.md deleted file mode 100644 index e246f955b7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreDefaultProvider.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSecureStoreDefaultProvider -schema: 2.0.0 ---- - -# Set-SPSecureStoreDefaultProvider - -## SYNOPSIS -Updates the secure store provider. - - -## SYNTAX - -``` -Set-SPSecureStoreDefaultProvider -Type <Type> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSecureStoreDefaultProvider` cmdlet sets or replaces the secure store provider. -To register a third-party secure store, implement the ISecureStoreProvider interface. -With the interface defined, place the DLL file in the global assembly cache, and then load the DLL and load the type, as shown in the example. -You can then set the secure store provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>[Reflection.Assembly]::LoadFrom("C:\ContosoFolder\contosoSecureStore.dll") - -C:\PS>$type = [Contoso.SecureStore.ContosoSecureStoreProvider] - -PS C:\>Set-SPSecureStoreDefaultProvider -Type $type -``` - -This example sets the custom implemented secure store provider. - - -## PARAMETERS - -### -Type -The type must be a secure store provider type enclosed in square brackets; for example, \[Reflection.Assembly\]. - -```yaml -Type: Type -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreServiceApplication.md deleted file mode 100644 index 6041e03f6c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecureStoreServiceApplication.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSecureStoreServiceApplication -schema: 2.0.0 ---- - -# Set-SPSecureStoreServiceApplication - -## SYNOPSIS -Sets properties of a Secure Store Service application in the farm. - - -## SYNTAX - -``` -Set-SPSecureStoreServiceApplication -Identity <SPServiceApplicationPipeBind> - [-ApplicationPool <SPIisWebServiceApplicationPool>] [-AssignmentCollection <SPAssignmentCollection>] - [-AuditingEnabled] [-AuditlogMaxSize <Int32>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] - [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-Sharing] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSecureStoreServiceApplication` cmdlet sets properties of a Secure Store Service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Set-SPSecureStoreServiceApplication -Identity $contosoServApp -AuditlogMaxSize 40 -``` - -This example sets the maximum size of the audit log to 40 days for the given service application. - - -## PARAMETERS - -### -Identity -Specifies the service application to update. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS application pool to run the Web service in for the new service application. - -```yaml -Type: SPIisWebServiceApplicationPool -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuditingEnabled -Turns on auditing for the Secure Store Service. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuditlogMaxSize -Specifies the number of days to retain the audit log. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the Secure Store service database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user specified in DatabaseUserName. -Use this parameter only if SQL authentication is used to access the metadata service application database. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user name to use for connecting to the database for the Secure Store service application. -Use this parameter only if SQL authentication is used to access the service application database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host server for the failover database server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sharing -Specifies that the Secure Store Service application is published and shared across the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecurityTokenServiceConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecurityTokenServiceConfig.md deleted file mode 100644 index 296a96e6be..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSecurityTokenServiceConfig.md +++ /dev/null @@ -1,449 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSecurityTokenServiceConfig -schema: 2.0.0 ---- - -# Set-SPSecurityTokenServiceConfig - -## SYNOPSIS -Updates the settings of the SharePoint security token service (STS) identity provider. - - -## SYNTAX - -### QueueSigningCertificateReference -``` -Set-SPSecurityTokenServiceConfig -QueueSigningCertificateThumbprint <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-FormsTokenLifetime <Int32>] - [-MaxLogonTokenCacheItems <Int32>] [-MaxServiceTokenCacheItems <Int32>] - [-QueueSigningCertificateStoreName <String>] [-ServiceTokenCacheExpirationWindow <Int32>] - [-ServiceTokenLifetime <Int32>] [-WhatIf] [-WindowsTokenLifetime <Int32>] [<CommonParameters>] -``` - -### RevokeSigningCertificateReference -``` -Set-SPSecurityTokenServiceConfig -RevokeSigningCertificateThumbprint <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-FormsTokenLifetime <Int32>] - [-MaxLogonTokenCacheItems <Int32>] [-MaxServiceTokenCacheItems <Int32>] - [-RevokeSigningCertificateStoreName <String>] [-ServiceTokenCacheExpirationWindow <Int32>] - [-ServiceTokenLifetime <Int32>] [-WhatIf] [-WindowsTokenLifetime <Int32>] [<CommonParameters>] -``` - -### SigningCertificateReference -``` -Set-SPSecurityTokenServiceConfig -SigningCertificateThumbprint <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-FormsTokenLifetime <Int32>] - [-MaxLogonTokenCacheItems <Int32>] [-MaxServiceTokenCacheItems <Int32>] - [-ServiceTokenCacheExpirationWindow <Int32>] [-ServiceTokenLifetime <Int32>] - [-SigningCertificateStoreName <String>] [-WhatIf] [-WindowsTokenLifetime <Int32>] - [-QueueSigningCertificateThumbprint <String>] [-QueueSigningCertificateStoreName <String>] - [<CommonParameters>] -``` - -### SigningCertificateImport -``` -Set-SPSecurityTokenServiceConfig [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-FormsTokenLifetime <Int32>] [-ImportSigningCertificate <X509Certificate2>] - [-MaxLogonTokenCacheItems <Int32>] [-MaxServiceTokenCacheItems <Int32>] - [-ServiceTokenCacheExpirationWindow <Int32>] [-ServiceTokenLifetime <Int32>] [-WhatIf] - [-WindowsTokenLifetime <Int32>] [<CommonParameters>] -``` - -### SigningCertificateQueue -``` -Set-SPSecurityTokenServiceConfig [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-FormsTokenLifetime <Int32>] [-MaxLogonTokenCacheItems <Int32>] [-MaxServiceTokenCacheItems <Int32>] - [-QueueSigningCertificate <X509Certificate2>] [-ServiceTokenCacheExpirationWindow <Int32>] - [-ServiceTokenLifetime <Int32>] [-WhatIf] [-WindowsTokenLifetime <Int32>] [<CommonParameters>] -``` - -### SigningCertificateRevoke -``` -Set-SPSecurityTokenServiceConfig [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-FormsTokenLifetime <Int32>] [-MaxLogonTokenCacheItems <Int32>] [-MaxServiceTokenCacheItems <Int32>] - [-RevokeSigningCertificate <X509Certificate2>] [-ServiceTokenCacheExpirationWindow <Int32>] - [-ServiceTokenLifetime <Int32>] [-WhatIf] [-WindowsTokenLifetime <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPSecurityTokenServiceConfig` cmdlet updates the settings of the SharePoint security token service (STS) identity provider. -If a certificate file is used, the certificate must be an X509 certificate with private keys, otherwise an exception is raised. - -This cmdlet operates only with certificates that can be exported. -To create a certificate which can be used in this cmdlet specify the X509KeyStorageFlags.Exportable bit in the keyStorageFlags parameter of the x509Certificate2 object constructor. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SPSecurityTokenServiceConfig -SigningCertificateThumbprint "2796BAE63F1801E277261BA0D77770028F20EEE4" -``` - -This example updates the signing certificate of the SharePoint security token service (STS) identity provider with a certificate that has been deployed in the certificate store. - - -### --------------------EXAMPLE 2--------------------- -``` -C:\PS>$stsCert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 "c:\sts.pfx","a",20 - -PS C:\>Set-SPSecurityTokenServiceConfig -ImportSigningCertificate $stsCert -``` - -This example imports the signing certificate for the SharePoint STS identity provider. - - -## PARAMETERS - -### -QueueSigningCertificateThumbprint -{{ Fill QueueSigningCertificateThumbprint Description }} - -```yaml -Type: String -Parameter Sets: QueueSigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RevokeSigningCertificateThumbprint -{{ Fill RevokeSigningCertificateThumbprint Description }} - -```yaml -Type: String -Parameter Sets: RevokeSigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateThumbprint -Specifies the thumbrpint of the signing certificate. - -The type must be a valid identity of a signing certificate; for example 2796BAE63F1801E277261BA0D77770028F20EEE4. - -```yaml -Type: String -Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FormsTokenLifetime -Specifies the expiration time, in minutes, for tokens issued to ASP.NET Membership Provider and Role providers. -The default value is 1380. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImportSigningCertificate -Specifies the X.509 certificate object from trusted authentication provider farm. - -The type must be a name of a valid X.509 certificate; for example, Certificate1. - -```yaml -Type: X509Certificate2 -Parameter Sets: SigningCertificateImport -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxLogonTokenCacheItems -Specifies the maximum number of entries for the in-memory logon token cache. -The default value is 10000 entries. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxServiceTokenCacheItems -Specifies the maximum number of entries for the in-memory service token cache. -The default value is 10000 entries. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueSigningCertificate -{{ Fill QueueSigningCertificate Description }} - -```yaml -Type: X509Certificate2 -Parameter Sets: SigningCertificateQueue -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueSigningCertificateStoreName -{{ Fill QueueSigningCertificateStoreName Description }} - -```yaml -Type: String -Parameter Sets: QueueSigningCertificateReference, SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RevokeSigningCertificate -{{ Fill RevokeSigningCertificate Description }} - -```yaml -Type: X509Certificate2 -Parameter Sets: SigningCertificateRevoke -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RevokeSigningCertificateStoreName -{{ Fill RevokeSigningCertificateStoreName Description }} - -```yaml -Type: String -Parameter Sets: RevokeSigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTokenCacheExpirationWindow -Specifies the interval, in minutes, for automatically renewing the token in the cache. -The default value is 2 minutes. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTokenLifetime -Specifies the expiration time, in minutes, for the security token service cache. -The default value is 15 minutes. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateStoreName -Specifies the certificate store where the signing certificate resides. -The identity store for an identity provider can be a SQL database table, an Active Directory Domain Services (AD DS), or Active Directory Lightweight Directory Service (AD LDS). - -The type must be a valid identity of a signing certificate store; for example IdentityStore1. - -```yaml -Type: String -Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsTokenLifetime -Specifies the expiration time, in minutes, for tokens issued to Windows users. -The default value is 1380 minutes. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServer.md deleted file mode 100644 index 2c8889dcf3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServer.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServer -schema: 2.0.0 ---- - -# Set-SPServer - -## SYNOPSIS -Changes the role of the server. - - -## SYNTAX - -``` -Set-SPServer [-Identity] <SPServerPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Role <SPServerRole>] [-Status <SPObjectStatus>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-SPServer cmdlet changes the role of the server in the farm by using the Role parameter. A new cmdlet in SharePoint Server 2016, SharePoint Server 2019 that is used in MinRole. - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -Set-SPServer -Role SingleServerFarm -``` - -This example changes the server to SingleServerFarm role. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of the server in the farm. - -```yaml -Type: SPServerPipeBind -Parameter Sets: (All) -Aliases: Address -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Role -Specifies the name of the server role you want to change. - -The valid values are: - -* WebFrontEnd -* Application -* SingleServerFarm -* Distributed Cache -* Search -* Custom -* ApplicationWithSearch -* WebFrontEndWithDistributedCache - - -```yaml -Type: SPServerRole -Parameter Sets: (All) -Aliases: -Accepted values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Sets the status of the server in the farm. - -```yaml -Type: SPObjectStatus -Parameter Sets: (All) -Aliases: -Accepted values: Online, Disabled, Offline, Unprovisioning, Provisioning, Upgrading, Patching -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServerPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServerScaleOutDatabaseDataRange.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServerScaleOutDatabaseDataRange.md deleted file mode 100644 index 2d083276c7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServerScaleOutDatabaseDataRange.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServerScaleOutDatabaseDataRange -schema: 2.0.0 ---- - -# Set-SPServerScaleOutDatabaseDataRange - -## SYNOPSIS -Extends the range of a specified scale-out database. - - -## SYNTAX - -``` -Set-SPServerScaleOutDatabaseDataRange -Database <SPDatabasePipeBind> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-NewRangePoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPServerScaleOutDatabaseDataRange cmdlet to extend the range of a specified scale-out database in a specified direction. - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -$database = $databases[0] -$state = Get-SPServerScaleOutDatabaseDataState -Database $database -Set-SPServerScaleOutDatabaseDataRange -Database $database -Range $state.Range -NewRangePoint $null -IsUpperSubRange $true -``` - -This example extends the data range end point of the first database in the specified service application up to the maximum range point. - - -## PARAMETERS - -### -Database -Specifies the scale-out database to which to extend the data range. - - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsUpperSubRange -Specifies whether to set the start point or the end point of the data range with the specified value in the NewRangePoint parameter. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range -Specifies the expected data range of the scale-out database. - - -```yaml -Type: SPScaleOutDataRange -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewRangePoint -Specifies the new start point or end point of the database. -The maximum value is NULL. - -``yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-SPServerScaleOutDatabaseDataSubRange](Set-SPServerScaleOutDatabaseDataSubRange.md) - -[Clear-SPServerScaleOutDatabaseDeletedDataSubRange](Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServerScaleOutDatabaseDataSubRange.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServerScaleOutDatabaseDataSubRange.md deleted file mode 100644 index 44c66bbd5d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServerScaleOutDatabaseDataSubRange.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServerScaleOutDatabaseDataSubRange -schema: 2.0.0 ---- - -# Set-SPServerScaleOutDatabaseDataSubRange - -## SYNOPSIS -Creates a subrange for a specified scale-out database. - - -## SYNTAX - -### UnattachedDatabase -``` -Set-SPServerScaleOutDatabaseDataSubRange -ConnectionString <String> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> -SubRangeMode <SPScaleOutDatabaseSubRangeMode> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-IgnoreSubRangePointOnBoundary] - [-IsAzureDatabase] [-SubRangePoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -### AttachedDatabase -``` -Set-SPServerScaleOutDatabaseDataSubRange -Database <SPDatabasePipeBind> -IsUpperSubRange <Boolean> - -Range <SPScaleOutDataRange> -SubRangeMode <SPScaleOutDatabaseSubRangeMode> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-IgnoreSubRangePointOnBoundary] - [-SubRangePoint <Byte[]>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets] (https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -$database = $databases[0] -$state = Get-SPServerScaleOutDatabaseDataState -Database $database -Set-SPServerScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubRangePoint $state.Range.RangeEnd -SubRangeMode ReadOnly -IsUpperSubRange $false - -``` - -This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. - - -## PARAMETERS - -### -ConnectionString -Specifies the connection string for the scale-out database to create the new data sub-range. - - -```yaml -Type: String -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -Specifies the scale-out database to create the data subrange. - - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsUpperSubRange -Specifies whether to create the data subrange on the upper or lower side of the data range. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range -Specifies the expected current range of the scale-out database prior to this operation. - - -```yaml -Type: SPScaleOutDataRange -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubRangeMode - - - - -```yaml -Type: SPScaleOutDatabaseSubRangeMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSubRangePointOnBoundary -Specifies whether to complete without any errors if the new subrange’s start and end points are the same. If this parameter is specified, no errors are displayed. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAzureDatabase -Specifies whether the database is hosted on SQL Azure. - - -```yaml -Type: SwitchParameter -Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubRangePoint -Specifies the start or end point of the data subrange to be created as defined by the following criteria: - ---The start point if the data sub-range is created on the upper side of the data range. ---The end point if the data sub-range is created on the lower side of the data range. - -The maximum value is NULL. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPDatabasePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Clear-SPServerScaleOutDatabaseDeletedDataSubRange](Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplication.md deleted file mode 100644 index 0fa949e448..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplication.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServiceApplication -schema: 2.0.0 ---- - -# Set-SPServiceApplication - -## SYNOPSIS -Sets properties of a service application. - - -## SYNTAX - -``` -Set-SPServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-DefaultEndpoint <SPServiceEndpointPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-IisWebServiceApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] - [-ServiceApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPServiceApplication` cmdlet to set various properties of a service application such as the default endpoint and the application pool used by the service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------------EXAMPLE---------------- -``` -C:\PS>$serviceapp = Get-SPServiceApplication "My Service App" - -PS C:\>Set-SPServiceApplication $serviceapp -DefaultEndpoint https -``` - -This example sets the default endpoint of the service application to be https. - - -## PARAMETERS - -### -Identity -Specifies the service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultEndpoint -Specifies the address of the default endpoint of the service application. - -```yaml -Type: SPServiceEndpointPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IisWebServiceApplicationPool -Specifies the name or identity of the application pool used by the service application. - -The IisWebServiceApplicationPool parameter only applies to Web Service applications. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplicationProxyGroup -Specifies a custom service application proxy group for the Web application to use. -The Web application will use the proxies in this proxy group to connect to service applications. -If the ServiceApplicationProxyGroup parameter is not specified, the farm's default proxy group is used. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationEndpoint.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationEndpoint.md deleted file mode 100644 index 2493453db4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationEndpoint.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServiceApplicationEndpoint -schema: 2.0.0 ---- - -# Set-SPServiceApplicationEndpoint - -## SYNOPSIS -Sets the host of an endpoint for a service application. - - -## SYNTAX - -### HostName -``` -Set-SPServiceApplicationEndpoint [-Identity] <SPServiceEndpointPipeBind> -HostName <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### ResetHostName -``` -Set-SPServiceApplicationEndpoint [-Identity] <SPServiceEndpointPipeBind> [-ResetHostName] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set- SPServiceApplicationEndpoint` cmdlet sets the host of a service endpoint. -Use the second parameter set to reset the host of the service endpoint to use the default endpoint. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE------------------- -``` -PS C:\>Set-SPServiceApplicationEndpoint -Identity "ServiceApp1" -HostName http://sitename -ResetHostName $true -``` - -This example associates the SPServiceEndpoint object with the specified identity and resets the hostname. - - -## PARAMETERS - -### -Identity -Specifies the service endpoint to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form http://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object. - -```yaml -Type: SPServiceEndpointPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -HostName -Specifies the default host of the service endpoint. - -The type must be a valid full load balanced URL, in the form http://server_name. - -```yaml -Type: String -Parameter Sets: HostName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetHostName -Removes the current host of the service endpoint and uses the default host. - -```yaml -Type: SwitchParameter -Parameter Sets: ResetHostName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationPool.md deleted file mode 100644 index 262b91c58e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationPool.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServiceApplicationPool -schema: 2.0.0 ---- - -# Set-SPServiceApplicationPool - -## SYNOPSIS -Changes the account used for the Identity of the specified application pool. - - -## SYNTAX - -``` -Set-SPServiceApplicationPool [-Identity] <SPIisWebServiceApplicationPoolPipeBind> - [[-Account] <SPProcessAccountPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPServiceApplicationPool` cmdlet changes the account used for the Identity of the specified application pool. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPServiceApplicationPool TestServiceWebApplicationPool -Account testdomain\testuser1 -``` - -This example changes the identity of the selected service application pool. - -For the Account parameter, the name of a managed account in the farm can be given. -Use the `Get-SPManagedAccount` cmdlet to view the existing managed account in the farm. -Also, a process account from the output of the `Get-SPProcessAccount` cmdlet can be used. - - -## PARAMETERS - -### -Identity -Specifies the identity of the Web service application pool to configure. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Account -Specifies the credentials that will be the new Identity of the application pool. - -```yaml -Type: SPProcessAccountPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationSecurity.md deleted file mode 100644 index 5f44bbdce4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceApplicationSecurity.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServiceApplicationSecurity -schema: 2.0.0 ---- - -# Set-SPServiceApplicationSecurity - -## SYNOPSIS -Updates the SPObjectSecurity object for a service application. - - -## SYNTAX - -``` -Set-SPServiceApplicationSecurity [-Identity] <SPServiceApplicationPipeBind> - [-ObjectSecurity] <SPObjectSecurity> [-Admin] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPServiceApplicationSecurity` cmdlet updates a security object for the specified service application. -Use this cmdlet with the `Grant-SPObjectSecurity` and `Get-SPServiceApplicationSecurity` cmdlets to manage security for a service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin -Grant-SPObjectSecurity $security $principal "Full Control" -Set-SPServiceApplicationSecurity $serviceApp -Admin $security -``` - -This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and adds a new user principal to that ACL. -The new user is an administrator for the service application $serviceApp. - - -## PARAMETERS - -### -Identity -Specifies the service application that contains the SPObjectSecurity object to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, ServiceApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectSecurity -Specifies the SPObjectSecurity object to update. - -```yaml -Type: SPObjectSecurity -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Admin -Updates the access control list (ACL) that contains the administrators list of the service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceHostConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceHostConfig.md deleted file mode 100644 index 46f9c5bb28..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPServiceHostConfig.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPServiceHostConfig -schema: 2.0.0 ---- - -# Set-SPServiceHostConfig - -## SYNOPSIS -Configures one or more common settings for all Web services. - - -## SYNTAX - -### SslCertificateReference -``` -Set-SPServiceHostConfig [-Identity] <SPIisWebServiceSettings> -SslCertificateThumbprint <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-HttpPort <Int32>] [-HttpsPort <Int32>] - [-NetTcpPort <Int32>] [-NoWait] [-SslCertificateStoreName <String>] [-WhatIf] [<CommonParameters>] -``` - -### SslCertificateImport -``` -Set-SPServiceHostConfig [-Identity] <SPIisWebServiceSettings> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-HttpPort <Int32>] [-HttpsPort <Int32>] [-ImportSslCertificate <X509Certificate2>] - [-NetTcpPort <Int32>] [-NoWait] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set- SPServiceHostConfig` cmdlet configures one or more common settings for all Web services. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPServiceHostConfig -Port 12345 -``` - -This example sets the HTTP port for the Web services. - - -## PARAMETERS - -### -Identity -Specifies the identity of the Web service application to configure. - -```yaml -Type: SPIisWebServiceSettings -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SslCertificateThumbprint -Specifies the thumbprint of the SSL certificate to retrieve for secure protocols. - -```yaml -Type: String -Parameter Sets: SslCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPort -Specifies the new port for the Web service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: Port -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsPort -Specifies the new secure port for the Web service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: SecurePort -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImportSslCertificate -Specifies the SSL Certificate to use for secure protocols. - -```yaml -Type: X509Certificate2 -Parameter Sets: SslCertificateImport -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetTcpPort -Sets the TCP port for the Web service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -For more information, see TechNet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateStoreName -Specifies the thumbprint of the SSL certificate to retrieve for secure protocols. - -```yaml -Type: String -Parameter Sets: SslCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSessionStateService.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSessionStateService.md deleted file mode 100644 index 81825ee89a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSessionStateService.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSessionStateService -schema: 2.0.0 ---- - -# Set-SPSessionStateService - -## SYNOPSIS -Updates the credentials that are used to communicate with the state service database. - - -## SYNTAX - -``` -Set-SPSessionStateService [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DatabaseCredentials <PSCredential>] [-SessionTimeout <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSessionStateService` cmdlet updates the credentials that are used to communicate with the state service database. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPSessionStateService -SessionTimeout 120 -``` - -This example changes the ASP.NET session state time-out to 2 hours. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the database credentials for SQL Authentication that are used to access the state service database. -If this parameter is not specified, Windows authentication is used. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionTimeout -Specifies the time, in minutes that an ASP.NET session will remain active with no user activity. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSite.md deleted file mode 100644 index b5310f0405..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSite.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSite -schema: 2.0.0 ---- - -# Set-SPSite - -## SYNOPSIS -Configures the specified sites. - - -## SYNTAX - -### SiteSubscription -``` -Set-SPSite [-Identity] <SPSitePipeBind> [-AdministrationSiteType <SPAdministrationSiteType>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Force] - [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -Set-SPSite [-Identity] <SPSitePipeBind> [-AdministrationSiteType <SPAdministrationSiteType>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-LockState <String>] [-MaxSize <Int64>] - [-OwnerAlias <SPUserPipeBind>] [-QuotaTemplate <SPQuotaTemplatePipeBind>] - [-SecondaryOwnerAlias <SPUserPipeBind>] [-SharingType <String>] [-Template <SPWebTemplatePipeBind>] - [-Url <String>] [-UserAccountDirectoryPath <String>] [-WarningSize <Int64>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPSite` cmdlet configures the site collection that is specified by the Identity parameter. -If a parameter is not used, the value is not changed. - -The QuotaTemplate parameter is mutually exclusive to the MaxSize parameter and WarningSize parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Get-SPSite http://sitename/sites/teams/* | Set-SPSite -SecondaryOwner "DOMAIN\Jdoe" -``` - -This example sets the secondary owner on a set of site collections to DOMAIN\Jdoe. - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Set-SPSite -identity "http://sitename/" -MaxSize 4000000 -WarningSize 2000000 -``` - -This example configures the Quota settings for the site collection http://sitename. - - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site collection to configure, or refers to an SPSite object that contains sites to configure. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AdministrationSiteType -Specifies the site type. - -Valid values are None or TentantAdministration. - -```yaml -Type: SPAdministrationSiteType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses confirmation messages involved in setting the site subscription. -This parameter is used in conjunction with the SiteSubscription parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockState -Sets the lock state of this site collection. -The valid lock states are - -Unlock Unlocks the site collection and makes it available to users - -NoAdditions Prevents users from adding new content to the site collection. -Updates and deletions are still allowed - -ReadOnly Prevents users from adding, updating, or deleting content. - -NoAccess Prevents access to content completely. -Users who attempt to access the site receive an access-denied message. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSize -Sets the maximum storage size for the site collection in bytes. - -The integer value must be larger than the WarningSize value. -You cannot use this parameter if the site collection is using a quota template. - -```yaml -Type: Int64 -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerAlias -Specifies the alias name of the site collection administrator. - -The type must be a valid e-mail alias, in the form domain\username. - -```yaml -Type: SPUserPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuotaTemplate -Specifies the new quota template for this site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef or a string - -```yaml -Type: SPQuotaTemplatePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryOwnerAlias -Sets the alias of the secondary site collection administrator. - -The type must be a valid e-mail alias, in the form domain\username. - -```yaml -Type: SPUserPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingType -Specifies whether external access a site collection should be disabled, limited to external users only, or enabled for external users and anonymous guests. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the Site Group to get site collections. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the template for this site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Specifies the URL of the new site. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccountDirectoryPath -Sets an organization unit to which to scope user accounts. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarningSize -Sets the storage warning level for the site collection in bytes. - -The integer value must be between 0 and the MaxSize value. -You cannot use this parameter if the site collection is using a quota template. - -```yaml -Type: Int64 -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteAdministration.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteAdministration.md deleted file mode 100644 index b67ddb445c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteAdministration.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteAdministration -schema: 2.0.0 ---- - -# Set-SPSiteAdministration - -## SYNOPSIS -Allows farm administrators to configure any site collection. - - -## SYNTAX - -### SiteSubscription -``` -Set-SPSiteAdministration [-Identity] <SPSiteAdministrationPipeBind> - [-AdministrationSiteType <SPAdministrationSiteType>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -### Default -``` -Set-SPSiteAdministration [-Identity] <SPSiteAdministrationPipeBind> - [-AdministrationSiteType <SPAdministrationSiteType>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-LockState <String>] [-MaxSize <Int64>] [-OwnerAlias <SPUserPipeBind>] - [-SecondaryOwnerAlias <SPUserPipeBind>] [-Template <SPWebTemplatePipeBind>] [-WarningSize <Int64>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPSiteAdministration` cmdlet allows a farm administrator to configure particular settings on a site collection even if the farm administrator is not granted explicit permissions. -Any parameter that is not provided is not changed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPSiteAdministration http://sitename -OwnerAlias "DOMAIN\NewOwner" -``` - -This example allows farm administrators to change the ownership of a site collection to which they do not have access. - - -## PARAMETERS - -### -Identity -Specifies the URL (full or partial) or GUID of the site collection. - -The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-456-987fg. - -```yaml -Type: SPSiteAdministrationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AdministrationSiteType -Specifies the site type. - -Valid values are None or TentantAdministration. - -```yaml -Type: SPAdministrationSiteType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses confirmation messages involved in setting the site subscription. -This parameter is used in conjunction with the SiteSubscription parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockState -Specifies the lock state for the given site collection. - -The type must be any of the following values: - -- Unlock: Sets the site collection to unlock. -- Content: No new content can be added. Updates and deletions are allowed. -- Readonly: Sets the site collection to read-only. -- Noaccess: Sets the site collection to unavailable to all users. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSize -Sets the maximum storage size of the site collection. - -The type must be a valid number greater than or equal to 0. - -Set to 0 for unlimited. - - -```yaml -Type: Int64 -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerAlias -Sets the owner of this site collection. - -The type must be a valid user alias. - -```yaml -Type: SPUserPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryOwnerAlias -Sets the secondary owner of this site collection. - -The type must be a valid user alias. - -```yaml -Type: SPUserPipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the Site Group to get site collections. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the Web template for the top-level Web site of this site collection. -This can only be given if the template has not already been configured. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef, or an SPWebTemplate object. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarningSize -Specifies the site collection warning size limit. - -The type must be a valid number greater than or equal to 0. -Set to 0 for unlimited. - -```yaml -Type: Int64 -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionConfig.md deleted file mode 100644 index 33961960b7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionConfig.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteSubscriptionConfig -schema: 2.0.0 ---- - -# Set-SPSiteSubscriptionConfig - -## SYNOPSIS -Sets the configuration properties of a site subscription. - - -## SYNTAX - -``` -Set-SPSiteSubscriptionConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-PassThru] [-UserAccountDirectoryPath <String>] - [-WhatIf] [-FeaturePack <SPSiteSubscriptionFeaturePackPipeBind>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSiteSubscriptionConfig` cmdlet sets the configuration properties of a site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPSiteSubscription http://contoso.com -FeatureSet 12345678-90ab-cdef-1234-567890abcdef -``` - -This example sets the Feature set of the entire site subscription that contains http://contoso.com with a Feature set GUID. - - -## PARAMETERS - -### -Identity -Specifies the site subscription configuration to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies the output object can be passed through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccountDirectoryPath -Sets the site user account directory path to a specific organizational unit (OU) that is in the same domain as the site subscription. - -The type must be a name of a distinguished OU; for example, OU=Contoso1, DC=OSGCorp,DC=local. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeaturePack -{{Fill FeaturePack Description}} - -```yaml -Type: SPSiteSubscriptionFeaturePackPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionEdiscoveryHub.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionEdiscoveryHub.md deleted file mode 100644 index d0cba68507..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionEdiscoveryHub.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteSubscriptionEdiscoveryHub -schema: 2.0.0 ---- - -# Set-SPSiteSubscriptionEdiscoveryHub - -## SYNOPSIS -Sets properties for the eDiscovery hub of a site subscription. - - -## SYNTAX - -``` -Set-SPSiteSubscriptionEdiscoveryHub -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-SearchScope <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSiteSubscriptionEdiscoveryHub` cmdlet sets global properties and settings for the Ediscovery hub. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE-------------------- -``` -PS C:\>Set-SPSiteSubscriptionEdiscoverySearchScope -Site http://contoso.com/sites/sitecollection1 -SearchScope 1 -``` - -This example enables the search scope for the entire site subscription. -A value of zero (0) disables the search scope across the entire site subscription. - - -## PARAMETERS - -### -Site -Specifies the site collection for the Ediscovery hub. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the name for the search scope. -The default value is All Sites. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionIRMConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionIRMConfig.md deleted file mode 100644 index 152a2464e3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionIRMConfig.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteSubscriptionIRMConfig -schema: 2.0.0 ---- - -# Set-SPSiteSubscriptionIRMConfig - -## SYNOPSIS -Sets the Information Rights Management (IRM) settings. - - -## SYNTAX - -``` -Set-SPSiteSubscriptionIRMConfig [-Identity] <SPSiteSubscriptionPipeBind> [-IrmEnabled] - [-AssignmentCollection <SPAssignmentCollection>] [-CertificateServerUrl <Uri>] [-Confirm] [-PassThru] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Identity parameter of the `Set-SPSiteSubscriptionIRMConfig` cmdlet to set the IRM setting for a specified tenant. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>site = Get-SPSite HYPERLINK "http://<myspserver>" http:// <myspserver> - -C:\PS>$subscription = $site.SiteSubscription - -PS C:\>Set-SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled -CertificateServerUrl http:// <rmsserver> -``` - -This example enables IRM for the tenant and configures it to use the specified RMS server. - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>site = Get-SPSite HYPERLINK "http://myspserver/" http:// <myspserver> - -C:\PS>$subscription = $site.SiteSubscription - -PS C:\>Set- SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled:$false -``` - -This example disables IRM for the tenant. - - -## PARAMETERS - -### -Identity -Specifies a site subscription for a particular tenant. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IrmEnabled -Specifies whether IRM is enabled in the tenant. - -The default value is false. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateServerUrl -Specifies the address of the RMS certificate server to use for the tenant. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that the output object can be passed through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPSiteSubscriptionIRMConfig](Get-SPSiteSubscriptionIRMConfig.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionMetadataConfig.md deleted file mode 100644 index 2ca0fea6b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionMetadataConfig.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteSubscriptionMetadataConfig -schema: 2.0.0 ---- - -# Set-SPSiteSubscriptionMetadataConfig - -## SYNOPSIS -Sets the site subscription configuration settings for a specified Metadata Service application. - - -## SYNTAX - -``` -Set-SPSiteSubscriptionMetadataConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-ServiceProxy] <SPMetadataServiceProxyCmdletPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DoNotUnpublishAllPackages] [-HubUri <String>] [-SyndicationErrorReportEnabled] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPSiteSubscriptionMetadataConfig` cmdlet to set the site subscription-specific settings for a specified shared service application for the Metadata Service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -HubUri "http://sitename/" -SyndicationErrorReportEnabled:$false -``` - -This example sets the content type syndication hub and disables syndication error reporting for a specific site subscription on an existing partitioned Metadata Service application. - - -## PARAMETERS - -### -Identity -Specifies the site subscription for which to set the Metadata Service application settings. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceProxy -Specifies the local metadata service proxy for the service application that contains the site subscription-specific settings. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. - -```yaml -Type: SPMetadataServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotUnpublishAllPackages -{{ Fill DoNotUnpublishAllPackages description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HubUri -Specifies the URI of the syndication hub. - -The type must be a valid URI, in the form file:\\\\server_name\sitedocs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyndicationErrorReportEnabled -Enables error reporting for content type syndication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionProfileConfig.md deleted file mode 100644 index ac3a11670b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteSubscriptionProfileConfig.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteSubscriptionProfileConfig -schema: 2.0.0 ---- - -# Set-SPSiteSubscriptionProfileConfig - -## SYNOPSIS -Sets the parameters of a site subscription. - - -## SYNTAX - -### Default -``` -Set-SPSiteSubscriptionProfileConfig [-Identity] <SPSiteSubscriptionPipeBind> - [-MySiteHostLocation <SPSitePipeBind>] -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-SynchronizationOU <String>] [-WhatIf] - [<CommonParameters>] -``` - -### MySiteSettings -``` -Set-SPSiteSubscriptionProfileConfig [-Identity] <SPSiteSubscriptionPipeBind> - -MySiteHostLocation <SPSitePipeBind> -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MySiteManagedPath <SPPrefixPipeBind>] - [-SiteNamingConflictResolution <String>] [-SynchronizationOU <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPSiteSubscriptionProfileConfig` cmdlet sets the parameters of a site subscription. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -Identity -Specifies the proxy of the User Profile Service application that contains the site subscription to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MySiteHostLocation -Specifies the site collection where the My Site host for the site subscription is provisioned. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the name of the proxy for the User Profile Service application. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MySiteManagedPath -Specifies the managed path where personal sites will be created. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: SPPrefixPipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteNamingConflictResolution -Specifies the format to use to name personal sites. - -Use one of the following integer values: - -1-- Personal site collections to be named after user names without any conflict resolution. -For example, http://portal_site/location/username/ - -2-- Personal site collections to be named after user names with conflict resolution by using domain names. -For example, .../username/ or .../domain_username/ - -3-- Personal site collections to be named using domain and username always to avoid any conflicts. -For example, http://portal_site/location/domain_username/ - -The default value is 1 (do not resolve conflicts). - -```yaml -Type: String -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SynchronizationOU -Specifies the organizational unit that serves the site subscription. - -The type must be a valid name of an organizational unit; for example, OrgUnit1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteURL.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteURL.md deleted file mode 100644 index 678cd83c79..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSiteURL.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSiteURL -schema: 2.0.0 ---- - -# Set-SPSiteURL - -## SYNOPSIS -Adds or changes an URL mapping for the site. - - -## SYNTAX - -``` -Set-SPSiteURL [-Identity] <SPSitePipeBind> -Url <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [-Zone <SPUrlZone>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPSiteUrl` cmdlet adds or changes an URL mapping for the site. - -The `Set-SPSiteUrl` cmdlet only applies to the root site collection for a host name that is, http://www.contoso.com. -This cmdlet cannot be directly run against a managed path site collection underneath the root that is, http://www.contoso.com/sites/test. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -C:\PS>$site = Get-SPSite 'http://www.contoso.com/' - -PS C:\>Set-SPSiteURL -Identity $site -Url http://contoso.sharepoint.com -Zone 0 -``` - -This example adds an additional URL, http://contoso.sharepoint.com, to the site collection. -The newly added URL is in the default zone. - - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site collection to set. -Must be the root site collection for a host-name. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Url -Specifies the URL. -This must be unique. -This must be an absolute URL including scheme (that is, https://www.contoso.com). -If URL exists, the current entry is updated. -Otherwise, the URL entry is added and cannot be in use by another site collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -Specifies one of the five zones with which the alternate URL is associated. -If the Zone parameter is not specified and is a new entry, the default value is set. -If an entry exists and is not specified, do not change. - - -```yaml -Type: SPUrlZone -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPSiteUrl](Get-SPSiteUrl.md) - -[Remove-SPSiteUrl](Remove-SPSiteUrl.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceApplication.md deleted file mode 100644 index 31b32b6cc3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceApplication.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPStateServiceApplication -schema: 2.0.0 ---- - -# Set-SPStateServiceApplication - -## SYNOPSIS -Updates the name of a state service application. - - -## SYNTAX - -``` -Set-SPStateServiceApplication [-Identity] <SPStateServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPStateServiceApplication` cmdlet updates the name of a state service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPStateServiceApplication -Identity "State Service Application 1" -Name "New name for State Service Application 1" -``` - -This example changes the display name of a state service application. - - -## PARAMETERS - -### -Identity -Specifies the state service application to update. - -The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the state service application. - -The type must be a valid name of a state service application; for example, StateSvc1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceApplicationProxy.md deleted file mode 100644 index 5435a75b91..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceApplicationProxy.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPStateServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPStateServiceApplicationProxy - -## SYNOPSIS -Updates the name of a state service application proxy. - -## SYNTAX - -``` -Set-SPStateServiceApplicationProxy [-Identity] <SPStateServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPStateServiceApplicationProxy` cmdlet updates the name of a state service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -PS C:\>Set-SPServiceApplicationProxy -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -Name "New Service Application Proxy Name" -``` - -This example changes the display name of a state service application proxy. - - -## PARAMETERS - -### -Identity -Specifies the state service application proxy to update. - -The type must be a valid name of a state service application proxy (for example, StateServiceProxy); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplicationProxy object. - -```yaml -Type: SPStateServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -{{ Fill Confirm Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the state service application proxy. - -The type must be a valid name of a state service application; for example, StateSvcProxy1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -{{ Fill WhatIf Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceDatabase.md deleted file mode 100644 index b5610664b3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPStateServiceDatabase.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Set-SPStateServiceDatabase - -## SYNOPSIS -Updates properties of a state service database. - -## SYNTAX - -``` -Set-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> - [[-ServiceApplication] <SPStateServiceApplicationPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DatabaseCredentials <PSCredential>] [-Weight <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPStateServiceDatabase` cmdlet manages the credentials that are used to communicate with the database, sets the weight of the database, or changes the state service application with which it is associated. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -Weight 10 -``` - -This example updates the database weight to the maximum (10). - - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -ServiceApplication "StateSvcApp1" -``` - -This example updates the associated service application for a state service database. - - -### --------------------EXAMPLE 3--------------------- -``` -C:\PS>$cred = Get-Credential - -PS C:\>Set-SPStateServiceDatabase -Identity "StateSvcDB1" -DatabaseCredentials $cred -``` - -This example updates the SQL Authentication credentials that are used for a given database. - - -## PARAMETERS - -### -Identity -Specifies the state service database to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplication -Specifies the state service application to which to add the state database. - -The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. - -```yaml -Type: SPStateServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: Application -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the database credentials for SQL Authentication used to access the state service database. -If this parameter is not specified, Windows authentication is used. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for the state database. -The default value is 1. - -The type must be a valid integer in the range of 1 to 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSubscriptionSettingsServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSubscriptionSettingsServiceApplication.md deleted file mode 100644 index bcf0428062..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPSubscriptionSettingsServiceApplication.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPSubscriptionSettingsServiceApplication -schema: 2.0.0 ---- - -# Set-SPSubscriptionSettingsServiceApplication - -## SYNOPSIS -Sets properties of a subscription settings service application. - - -## SYNTAX - -``` -Set-SPSubscriptionSettingsServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseCredentials <PSCredential>] - [-DatabaseName <String>] [-DatabaseServer <String>] [-FailoverDatabaseServer <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPSubscriptionSettingsServiceApplication` cmdlet to set properties on a subscription settings service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ---------------------EXAMPLE-------------------------- -``` -C:\PS>$applicationPool = GetServiceApplicationPool SettingsApplicationPool - -PS C:\>Get-SPServiceApplication -Name SettingsServiceApp | Set-SPSubscriptionSettingsServiceApplication -ApplicationPool $applicationPool -``` - -This example changes the application pool of the subscription settings service application. -This command assumes that a subscription settings service application named SettingsServiceApp exists and that an application pool named SettingsApplicationPool exists - - -## PARAMETERS - -### -Identity -Specifies the settings service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the subscription settings database. - -The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsAppDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host SQL Server instance for the database specified in DatabaseName parameter. - -The type must be a valid SQL Server instance name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the name of the host SQL Server instance for the failover database server. - -The type must be a valid SQL Server instance name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPThrottlingRule.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPThrottlingRule.md deleted file mode 100644 index 272b6cd4c4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPThrottlingRule.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPThrottlingRule -schema: 2.0.0 ---- - -# Set-SPThrottlingRule - -## SYNOPSIS -Changes properties of an existing throttling rule. - - -## SYNTAX - -``` -Set-SPThrottlingRule [-Identity] <SPThrottlingRulePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] [-Expiration <DateTime>] [-Threshold <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPThrottlingRule` cmdlet to change the properties of an existing throttling rule by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE--------------------- -``` -C:\PS>$web=Get-SPWebApplication -Identity <URL of web application> - -C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web - -C:\PS>$c=New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false - -C:\PS>$throttlingrule=Add-SPThrottlingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -Threshold 4 - -C:\PS>$criteriaNew = New-SPRequestManagementRuleCriteria -Property UserAgent -MatchType Equals -Value "Mozilla/4.0 (compatible; MSIE 4.01; Windows NT; MS Search 6.0 Robot)" - -PS C:\>Set-SPThrottlingRule -Identity $ throttlingrule -Criteria $criteriaNew -Threshold 8 -``` - -This example sets throttling rule property - - -## PARAMETERS - -### -Identity -Specifies the throttling rule object to set. - -```yaml -Type: SPThrottlingRulePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Criteria -Specifies the criteria for the rule to match. - -```yaml -Type: SPRequestManagementRuleCriteriaPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expiration -Specifies the expiration date and time of the rule. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -Specifies a value between 0 and 10 which defines the maximum threshold for throttling. -The Request Manager will remove routing targets if the Health-Score becomes greater than this value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPThrottlingRule](Add-SPThrottlingRule.md) - -[Get-SPThrottlingRule](Get-SPThrottlingRule.md) - -[Remove-SPThrottlingRule](Remove-SPThrottlingRule.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTimerJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTimerJob.md deleted file mode 100644 index ebe46349b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTimerJob.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTimerJob -schema: 2.0.0 ---- - -# Set-SPTimerJob - -## SYNOPSIS -Sets the schedule for running a timer job. - - -## SYNTAX - -``` -Set-SPTimerJob [-Identity] <SPTimerJobPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Schedule <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPTimerJob` cmdlet sets the schedule for running a specified timer job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE------------------------ -``` -PS C:\>Get-SPTimerJob job-recycle-bin-cleanup | Set-SPTimerJob -Schedule "weekly at sat 5:00" -``` - -This example sets the schedule to run the job-recylce-bin-cleanup timer job to weekly at sat 5:00. - -## PARAMETERS - -### -Identity -Specifies the timer job to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. - -```yaml -Type: SPTimerJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Specifies the schedule for running the timer job. - -The type must be a valid SharePoint Timer service (SPTimer) schedule in the form of any one of the following schedules: - -- Every 5 minutes between 0 and 59 -- Hourly between 0 and 59 -- Daily at 15:00:00 -- Weekly between Fri 22:00:00 and Sun 06:00:00 -- Monthly at 15 15:00:00 -- Yearly at Jan 1 15:00:00 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTopologyServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTopologyServiceApplication.md deleted file mode 100644 index 89b21a5adc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTopologyServiceApplication.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.SharePoint.TopologyService-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTopologyServiceApplication -schema: 2.0.0 ---- - -# Set-SPTopologyServiceApplication - -## SYNOPSIS -Sets the properties on the topology service application of the local farm. - - -## SYNTAX - -``` -Set-SPTopologyServiceApplication [-Identity] <SPTopologyWebServiceApplicationPipeBind> - -LoadBalancerUrl <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPTopologyServiceApplication` cmdlet sets the advanced properties of an application when the Identity parameter is used. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPTopologyServiceApplication 67877d63-bff4-4521-867a-ef4979ba07ce -LoadBalancedURL "https://testurl/" -``` - -This example sets the load-balanced URL for the topology service application. - -The topology service application GUID is unique to every farm. -You can run the `Get-SPTopologyServiceApplication` cmdlet to retrieve the GUID. - - -## PARAMETERS - -### -Identity -Specifies the GUID of the application to be set. - -The type must be a valid GUID, in the form 1234-456-854gh. - -```yaml -Type: SPTopologyWebServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LoadBalancerUrl -Specifies an external physical load balancer. - -The type must be a valid URL, in the form http://search. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTopologyServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTopologyServiceApplicationProxy.md deleted file mode 100644 index d0ccee9356..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTopologyServiceApplicationProxy.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.SharePoint.TopologyService-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTopologyServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPTopologyServiceApplicationProxy - -## SYNOPSIS -Sets the proxy properties of the topology service application. - - -## SYNTAX - -``` -Set-SPTopologyServiceApplicationProxy [-Identity] <SPTopologyWebServiceProxyPipeBind> -BadListPeriod <String> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPTopologyServiceApplicationProxy` cmdlet sets the properties of the local topology service application proxy and the default load balancer. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPTopologyServiceApplicationProxy 67877d63-bff4-4521-867a-ef4979ba07ce -BadListPeriod 1234 -``` - -This example sets the bad list period for the given topology service application proxy. - -The topology service application GUID is unique to every farm. -You can run the `Get-SPTopologyServiceApplication` cmdlet to retrieve the GUID. - - -## PARAMETERS - -### -Identity -Specifies the GUID of the application proxy. - -The type must be a valid GUID, in the form 1234-4567-098jhj. - -```yaml -Type: SPTopologyWebServiceProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BadListPeriod -Specifies the time period that a node is kept in a bad list. - -The type must be a valid value between 1 and 480 (in minutes). - -The default value is 10. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationServiceApplication.md deleted file mode 100644 index 7b35ab79da..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationServiceApplication.md +++ /dev/null @@ -1,648 +0,0 @@ ---- -external help file: Microsoft.Office.TranslationServices.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTranslationServiceApplication -schema: 2.0.0 ---- - -# Set-SPTranslationServiceApplication - -## SYNOPSIS -Sets property settings on a Machine Translation service application. - -## SYNTAX - -``` -Set-SPTranslationServiceApplication [-Identity] <TranslationServiceApplicationPipeBind> - [-AddEnabledFileExtensions <String[]>] [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-ClearEnabledFileExtensions] [-Confirm] - [-DatabaseCredential <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] - [-DisableBinaryFileScan <Boolean>] [-EnableAllFileExtensions] [-FailoverDatabaseServer <String>] - [-JobExpirationDays <Int32>] [-KeepAliveTimeout <Int32>] [-MachineTranslationAddress <String>] - [-MachineTranslationCategory <String>] [-MachineTranslationClientId <String>] [-MaximumBinaryFileSize <Int32>] - [-MaximumItemsPerDay <Int32>] [-MaximumItemsPerPartitionPerDay <Int32>] - [-MaximumSyncTranslationRequests <Int32>] [-MaximumTextFileSize <Int32>] [-MaximumTranslationAttempts <Int32>] - [-MaximumTranslationTime <Int32>] [-MaximumWordCharacterCount <Int32>] [-RecycleProcessThreshold <Int32>] - [-RemoveEnabledFileExtensions <String[]>] [-TimerJobFrequency <Int32>] [-TotalActiveProcesses <Int32>] - [-TranslationsPerInstance <Int32>] [-UseDefaultInternetSettings] [-WebProxyAddress <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPTranslationServiceApplication` cmdlet to set properties on a Machine Translation service application in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE--------------- -``` -PS C:\>Set-SPTranslationServiceApplication TranslationService -JobExpirationDays 14 -TotalActiveProcesses 3 -``` - -This example sets the job expiration to 14 days and the number of worker processes per server to 3 for the Machine Translation Service application named TranslationService. - - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the instance of the Machine Translation service to set. - -The type must be a valid URL in the form, http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). - -```yaml -Type: TranslationServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AddEnabledFileExtensions -Comma delimited list of file extensions that you want to add to the set of enabled file extensions for the Machine Translation Service application - -To return a list of supported file extensions, type \[Microsoft.Office.TranslationServices.TranslationService\]::EnumerateFileExtensions(). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the managed application pool that the instance of Translation Service will run in. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClearEnabledFileExtensions -Disables all file extensions for the Machine Translation Service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredential -Specifies the SQL Server credentials used for this Translation Service instance. -This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the database name which is to be used for this Translation Service instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the database server which is to be used for this Translation Service instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBinaryFileScan -Determines whether Gatekeeper is run on binary files. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAllFileExtensions -Enables all file extensions for the Machine Translation Service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobExpirationDays -Specifies the amount of days after which completed jobs can be automatically removed from the Machine Translation Service queue database. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepAliveTimeout -Specifies the length of time (in seconds) that the worker can be inactive before it is automatically stopped. - -The valid values are 60 to 600. -The default value is 60. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineTranslationAddress -Specifies the service URL the service application will use to call the translation provider. -For example, https://api.microsofttranslator.com/v2/soap.svc - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineTranslationCategory -Specifies the category which will be used by the service when calling the translation provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineTranslationClientId -Specifies the AppId which will be used by the service when calling the translation provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumBinaryFileSize -Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain binary data. -The valid values are 100 to 524288. -The default value is 51200. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumItemsPerDay -Specifies the maximum number of items which can be added to the job queue in a 24-hour period. -A value of zero indicates no limit. - -The valid values are 1000 to 1000000. -A value of zero indicates no limit. -The default value is zero. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumItemsPerPartitionPerDay -Specifies the maximum number of items which can be added to the job queue in a 24-hour period per partition. -A value of zero indicates no limit. - -The valid values are 1000 to 1000000. -A value of zero indicates no limit. -The default value is zero. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumSyncTranslationRequests -Specifies the maximum number of items which can be added to the sync queue. -A valid of zero indicates no limit. - -The valid values are 0 to 300. -The default value is 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumTextFileSize -Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain mostly text data. -The valid values are 100 to 15360. -The default value is 5120. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumTranslationAttempts -Specifies the maximum number of attempts an unsuccessful job is tried before it is marked as Failed. - -The valid values are 1 to 10. -The default value is 2. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumTranslationTime -Specifies the maximum length of time (in minutes) that a translation can take. - -The valid values are 60 to 3600. -The default value is 600. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumWordCharacterCount -Specifies the maximum character count for a Microsoft Word document which can be translated. - -The valid Int values are 10000 to 10000000. -The default value is 500000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecycleProcessThreshold -Specifies the number of documents which are translated before a Translation Worker process is recycled. - -The valid values are 1 to 1,000. -The default value is 100. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveEnabledFileExtensions -Comma delimited list of file extensions that you want to remove from the set of enabled file extensions for the Machine Translation Service application. - -To return a list of supported file extensions, type \[Microsoft.Office.TranslationServices.TranslationService\]::EnumerateFileExtensions(). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimerJobFrequency -Specifies the frequency (in minutes) with which the timer job for this service application runs. -The valid values are 1 to 59. -The default value is 15 minutes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TotalActiveProcesses -Specifies the number of Translation Workers which are simultaneously running on a single machine. - -The valid values are 1 to 5. -The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranslationsPerInstance -Specifies the number of translations dispatched to each service instance every time the timer job is run. - -Valid values are 1 to 1,000. -The default value is 200. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultInternetSettings -Determines whether the service application will use default Internet settings for the user service account to connect to the translation provider. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebProxyAddress -Specifies the web proxy address and port that the service application will use to connect to the translation provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPTranslationServiceApplication](New-SPTranslationServiceApplication.md) - -[New-SPTranslationServiceApplicationProxy](New-SPTranslationServiceApplicationProxy.md) - -[Set-SPTranslationServiceApplicationProxy](Set-SPTranslationServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationServiceApplicationProxy.md deleted file mode 100644 index dc8381c956..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationServiceApplicationProxy.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Office.TranslationServices.dll-Help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTranslationServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPTranslationServiceApplicationProxy - -## SYNOPSIS -Sets properties to the Machine Translation service application proxy. - -## SYNTAX - -``` -Set-SPTranslationServiceApplicationProxy [-Identity] <TranslationServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-MaximumGroupSize <Int32>] - [-MaximumItemCount <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPTranslationServiceApplicationProxy` cmdlet to set properties on a Machine Translation service application proxy in the farm. - -## EXAMPLES - -### -------------EXAMPLE--------- -``` -PS C:\>Set-SPTranslationServiceApplicationProxy TranslationServiceProxy -DefaultProxyGroup -``` - -This example adds the Machine Translation Service application proxy named TranslationServiceProxy to the default proxy group. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application proxy. - -The type must be a valid GUID in the form, 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: TranslationServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies that the Machine Translation Service application proxy be added to the default proxy group for the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumGroupSize -Maximum number of bytes the proxy will send to the service in a single request. -The valid values are 131072 to 10485760. -The default value is 2097152. - -We do not recommend use of this parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumItemCount -Maximum number of documents to be translated that the proxy will send to the service in a single request. -The valid values are 1 to 40960. -The default value is 9000. - -We do not recommend use of this parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPTranslationServiceApplication](New-SPTranslationServiceApplication.md) - -[New-SPTranslationServiceApplicationProxy](New-SPTranslationServiceApplicationProxy.md) - -[Set-SPTranslationServiceApplication](Set-SPTranslationServiceApplication.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationThrottlingSetting.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationThrottlingSetting.md deleted file mode 100644 index eec4b57469..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTranslationThrottlingSetting.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Translation.dll-Help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTranslationThrottlingSetting -schema: 2.0.0 ---- - -# Set-SPTranslationThrottlingSetting - -## SYNOPSIS -Sets the timer job duration. - -## SYNTAX - -``` -Set-SPTranslationThrottlingSetting [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-SiteQuota <Int32>] [-TenantQuota <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Set-SPTranslationThrottlingSetting cmdlet to set the timer job duration for each site collection. - -## EXAMPLES - -### -----------------EXAMPLE-------------------- -``` -Set-SPTranslationThrottlingSetting -SiteQuota 300 -TenantQuota 600 -``` - -This limits the Translation Timer job to spend no more than 300 seconds (5 minutes) per site collection, and no more than 600 seconds (10 minutes) per tenant. - -Note: TenantQuota must be greater than or equal to SiteQuota. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.  - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteQuota - -The duration (in seconds) of timer job processing time that an individual SPSite is limited to - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantQuota -The duration (in seconds) of timer job processing time that an individual tenant is limited to. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedIdentityTokenIssuer.md deleted file mode 100644 index a8c330e44e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedIdentityTokenIssuer.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTrustedIdentityTokenIssuer -schema: 2.0.0 ---- - -# Set-SPTrustedIdentityTokenIssuer - -## SYNOPSIS -Sets the identity providers of a Web application. - - -## SYNTAX - -### ImportCertificateParameterSet -``` -Set-SPTrustedIdentityTokenIssuer [-Identity] <SPTrustedIdentityTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-ClaimProvider <SPClaimProviderPipeBind>] - [-ClaimsMappings <SPClaimMappingPipeBind[]>] [-Description <String>] - -ImportTrustCertificate <X509Certificate2> [-Realm <String>] [-SignInUrl <String>] [-UseWReply] [-Confirm] - [-RegisteredIssuerName <String>] [-WhatIf] [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -Set-SPTrustedIdentityTokenIssuer [-Identity] <SPTrustedIdentityTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-ClaimProvider <SPClaimProviderPipeBind>] - [-ClaimsMappings <SPClaimMappingPipeBind[]>] [-Description <String>] -MetadataEndPoint <Uri> [-Realm <String>] - [-SignInUrl <String>] [-UseWReply] [-Confirm] [-RegisteredIssuerName <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-SPTrustedIdentityTokenIssuer cmdlet sets the identity providers of a Web application or extended Web application. -For the ASP.NET Membership provider and Role provider, this cmdlet changes the identity provider only if the result is piped to a variable and passed to a Web application. -For security token service (STS) identity providers, this cmdlet changes the persisted identity provider object in the SPFarm object. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------------------EXAMPLE 1---------------------- -``` -PS C:\>Set-SPTrustedIdentityTokenIssuer "LiveIDSTS" -Certificate (Get-ChildItem"cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") -``` - -This example sets the identity provider to LiveIDSTS. - - -### -------------------------EXAMPLE 2---------------------- -``` -C:\PS>$ip = @( (Get-SPTrustedIdentityTokenIssuer "LiveID STS"), (New-SPTrustedIdentityTokenIssuer -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider"), (Get-SPTrustedIdentityTokenIssuer "NTLM")) ) -New-SPWebApplication http://contoso.com -IdentityProvider $ip -``` - -This example sets the identity provider using the .ASPNetMembership and Role parameters. -When these parameters are used, a variable must be set; otherwise, the values do not take effect. - - -## PARAMETERS - -### -Identity -Specifies the identity provider to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClaimProvider -Specifies the IP STS that can resolve and search claims for claims people picker. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim provider (for example, MyIDprovider1); or an instance of a valid SPClaimProvider object. - -```yaml -Type: SPClaimProviderPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClaimsMappings -Specifies the mapping of the claims from the original token to the SharePoint token. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. - -```yaml -Type: SPClaimMappingPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the new identity provider. - -The type must be a valid string; for example, LiveID STS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImportTrustCertificate -Specifies the X.509 certificate object from trusted authentication provider farm. - -The type must be a name of a valid X.509 certificate; for example, Certificate1. - -```yaml -Type: X509Certificate2 -Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Realm -Specifies the realm, or resource partition, associated with this trust. - -The type must be a name of a valid realm; for example, MD_REALM. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInUrl -Specifies the sign-in URLs for this trusted identity provider STS. - -The type must be a valid URL, in the form http://int.live.com/. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseWReply -Includes a WReply with the token request. -Wreply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegisteredIssuerName -{{Fill RegisteredIssuerName Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedRootAuthority.md deleted file mode 100644 index 210e5df8eb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedRootAuthority.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTrustedRootAuthority -schema: 2.0.0 ---- - -# Set-SPTrustedRootAuthority - -## SYNOPSIS -Creates a new trusted root authority. - - -## SYNTAX - -### ManualUpdateCertificateParameterSet -``` -Set-SPTrustedRootAuthority [-Identity] <SPTrustedRootAuthorityPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Certificate <X509Certificate2>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -Set-SPTrustedRootAuthority [-Identity] <SPTrustedRootAuthorityPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MetadataEndPoint <Uri>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPTrustedRootAuthority` cmdlet creates a new trusted root authority. -If a certificate file is used, the certificate must be an X509 certificate with private keys, otherwise an exception is raised. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx -Get - SPTrustedRootAuthority -Name "WFEFarm1" | Set- SPTrustedRootAuthority -Certificate $cert -``` - -This example updates the certificate of the trusted root authority WFEFarm1. - - -## PARAMETERS - -### -Identity -Specifies the trusted root authority to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. - -```yaml -Type: SPTrustedRootAuthorityPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Certificate -Specifies the X.509 certificate of the trusted root authority. - -The type must be a name of a valid X.509 certificate; for example, Certificate1. - -```yaml -Type: X509Certificate2 -Parameter Sets: ManualUpdateCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -{{Fill MetadataEndPoint Description}} - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedSecurityTokenIssuer.md deleted file mode 100644 index 5d2d1e5421..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedSecurityTokenIssuer.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTrustedSecurityTokenIssuer -schema: 2.0.0 ---- - -# Set-SPTrustedSecurityTokenIssuer - -## SYNOPSIS -Sets the trusted token issuer. - - -## SYNTAX - -### ImportCertificateParameterSet -``` -Set-SPTrustedSecurityTokenIssuer [-Identity] <SPTrustedSecurityTokenServicePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Certificate <X509Certificate2>] [-Confirm] - [-Description <String>] [-IsTrustBroker] [-RegisteredIssuerName <String>] [-WhatIf] [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -Set-SPTrustedSecurityTokenIssuer [-Identity] <SPTrustedSecurityTokenServicePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Description <String>] [-IsTrustBroker] - [-MetadataEndPoint <Uri>] [-RegisteredIssuerName <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPTrustedSecurityTokenIssuer` cmdlet to set the trusted token issuer. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE-------------------- -``` -C:\PS>$a=Get-SPTrustedSecurityTokenIssuer - -PS C:\>Set-SPTrustedSecurityTokenIssuer -Identity $a -MetadataEndpoint https://<webappurl/>/_layouts/15/metadata/json/1/ -``` - -This example sets the metadata endpoint of the url for the self-issue. - - -## PARAMETERS - -### -Identity -Specifies the id of the SPTrustedSecurityTokenIssuer object to be set. - -```yaml -Type: SPTrustedSecurityTokenServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Certificate -Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer. - -```yaml -Type: X509Certificate2 -Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the issuer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsTrustBroker -Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server or Lync). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -Specifies the URI for the metadata endpoint of the issuer. - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegisteredIssuerName -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPTrustedSecurityTokenIssuer](Get-SPTrustedSecurityTokenIssuer.md) - -[New-SPTrustedSecurityTokenIssuer](New-SPTrustedSecurityTokenIssuer.md) - -[Remove-SPTrustedSecurityTokenIssuer](Remove-SPTrustedSecurityTokenIssuer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedServiceTokenIssuer.md deleted file mode 100644 index 798cb143ab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPTrustedServiceTokenIssuer.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPTrustedServiceTokenIssuer -schema: 2.0.0 ---- - -# Set-SPTrustedServiceTokenIssuer - -## SYNOPSIS -Updates a trust with the farm. - - -## SYNTAX - -### ImportCertificateParameterSet -``` -Set-SPTrustedServiceTokenIssuer [-Identity] <SPTrustedServiceTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Certificate <X509Certificate2>] [-Description <String>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -### MetadataEndPointParameterSet -``` -Set-SPTrustedServiceTokenIssuer [-Identity] <SPTrustedServiceTokenIssuerPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Description <String>] [-Confirm] [-MetadataEndPoint <Uri>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPTrustedServiceTokenIssuer` cmdlet updates a trust with a SharePoint farm. -If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx -Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" - ImportTrustCertificate $cert -``` - -This example updates a SharePoint Farm trust using the trust certificate from a file. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" -FederationMetadataUrl "https://liveid.com/STS/2007/03/fedmetadata.xml" -``` - -This example updates a SharePoint farm trust using the trust certificate from the federation metadata endpoint URL. - - -## PARAMETERS - -### -Identity -Specifies the trusted service token issuer to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. - -```yaml -Type: SPTrustedServiceTokenIssuerPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Certificate -Specifies the X.509 certificate object from trusted authentication provider farm. - -The type must be a name of a valid X.509 certificate; for example, Certificate1. - -```yaml -Type: X509Certificate2 -Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the trust. - -The type must be a valid string; for example, WFE Farm Trust1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataEndPoint -{{Fill MetadataEndPoint Description}} - -```yaml -Type: Uri -Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageApplication.md deleted file mode 100644 index e82b0260dc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageApplication.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPUsageApplication -schema: 2.0.0 ---- - -# Set-SPUsageApplication - -## SYNOPSIS -Sets properties of a usage application. - - -## SYNTAX - -``` -Set-SPUsageApplication [-Identity] <SPUsageApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseName <String>] - [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-EnableLogging] - [-FailoverDatabaseServer <String>] [-UsageService <SPUsageServicePipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPUsageApplication` cmdlet sets properties of a usage application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE---------------------- -``` -PS C:\>Set-SPUsageApplication -Identity "Usage and Health data collection" -DatabaseServer "Server Name" -DatabaseName "New Logging DB" -``` - -This example changes the database server and database name used by the usage logging service to store logging data. - - -## PARAMETERS - -### -Identity -Specifies the usage application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a usage application (for example; UsageApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPUsageApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the logging database. - -The type must be a valid name of a SQL Server database; for example, UsageLogDB1. - -If the logging database does not exist, a logging database will be automatically created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePassword -Specifies the password for the user specified in DatabaseUserName. -Use this parameter only if SQL Server Authentication is used to access the logging database. - -The type must be a valid password. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the database specified in DatabaseName. - -The type must be a valid SQL Server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseUsername -Specifies the user name to use for connecting to the logging database. -Use this parameter only if SQL Server Authentication is used to access the logging database. - -The type must be a valid user name; for example, UserName1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableLogging -Specifies that this usage application collects usage data. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDatabaseServer -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsageService -Specifies the SPUsageService object that is the parent of the usage application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. - -```yaml -Type: SPUsageServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageDefinition.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageDefinition.md deleted file mode 100644 index 476649ede6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageDefinition.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPUsageDefinition -schema: 2.0.0 ---- - -# Set-SPUsageDefinition - -## SYNOPSIS -Sets the retention period for a usage provider. - - -## SYNTAX - -``` -Set-SPUsageDefinition [-Identity] <SPUsageDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DaysRetained <Int32>] [-DaysToKeepUsageFiles <Int32>] [-Enable] [-MaxTotalSizeInBytes <Int64>] - [-WhatIf] [-UsageDatabaseEnabled] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPUsageDefinition` cmdlet sets the retention period for a specified usage provider. -A usage definition object defines a specific type of usage provider. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE-------------------- -``` -PS C:\>Set-SPUsageDefinition -Identity "Page Requests" -DaysRetained 31 -``` - -This example sets the number of days that stores page requests usage data to 31. - - -## PARAMETERS - -### -Identity -Specifies the usage definition object to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object. - -```yaml -Type: SPUsageDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysRetained -Specifies the number of days that usage data for the usage provider is retained in the usage service database. -The default value is 14. - -The type must be an integer between 0 and 31. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysToKeepUsageFiles -Specifies the number of days to keep usage file retention. -The value must be less than or equal to value of the DaysRetained parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Turns on the specified usage provider. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxTotalSizeInBytes -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsageDatabaseEnabled -{{Fill UsageDatabaseEnabled Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageService.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageService.md deleted file mode 100644 index 7d7f0202ea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUsageService.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPUsageService -schema: 2.0.0 ---- - -# Set-SPUsageService - -## SYNOPSIS -Updates the properties of a usage service. - - -## SYNTAX - -``` -Set-SPUsageService [[-Identity] <SPUsageServicePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-LoggingEnabled <Boolean>] [-UsageLogCutTime <UInt32>] [-UsageLogLocation <String>] - [-UsageLogMaxFileSizeKB <UInt32>] [-UsageLogMaxSpaceGB <UInt32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPUsageService` cmdlet updates the properties of a usage service. -If the Identity parameter is not specified, the cmdlet applies the changes to the local usage service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------------EXAMPLE----------------- -``` -PS C:\>Set-SPUsageService -LoggingEnabled $false - -PS C:\>Set-SPUsageService -UsageLogLocation "D:\\testusagelogdir" - - -PS C:\>Set-SPUsageService -UsageLogCutTime 5 -``` - -The examples disables usage logging, changes the directory where usage files are stored and creates a new usage log file every 5 minutes. - - -## PARAMETERS - -### -Identity -Specifies the usage service to update. - -The type must be in one of the following forms: - ---A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ---A valid name of a usage service (for example, UsageService1) ---An instance of a valid SPUsageService object. - -```yaml -Type: SPUsageServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoggingEnabled -Specifies that usage data is logged to usage files. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsageLogCutTime -Specifies the time, in minutes, of usage data that is collected per usage log file. -The default time is 5 minutes. - -The value must be an integer in the range of 1 to 1440. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UsageLogLocation -Specifies the path on every computer in the farm where usage log files are created. - -The value must be a valid local path in the following form: - -- C:\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UsageLogMaxFileSizeKB -Specifies the maximum size of a single usage file that is applied to all the usage providers. - -The minimum value is 512 kilobytes (KB) and the maximum value is 65536 KB. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UsageLogMaxSpaceGB -The parameter is not used in SharePoint Server. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUser.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUser.md deleted file mode 100644 index 3cfc391088..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPUser.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPUser -schema: 2.0.0 ---- - -# Set-SPUser - -## SYNOPSIS -Configures properties of an existing user. - - -## SYNTAX - -``` -Set-SPUser [-Identity] <SPUserPipeBind> [-AddPermissionLevel <String[]>] - [-AssignmentCollection <SPAssignmentCollection>] [-ClearPermissions] [-Confirm] [-DisplayName <String>] - [-Email <String>] [-Group <SPGroupPipeBind>] [-IsSiteCollectionAdmin] [-PassThru] - [-RemovePermissionLevel <String[]>] [-SyncFromAD] [-Web <SPWebPipeBind>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPUser` cmdlet configures properties of an existing user. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPUser -Identity 'Contoso\jdow' -Web http:// test -AddPermissionLevel "Contributor" -``` - -This example sets a user (Contoso\jdow) to be a contributor on http://test. - - -## PARAMETERS - -### -Identity -Specifies the GUID, login name, or SPUser object of the user to be returned. - -The type must be a GUID of an existing user in the form, 1234-5678-9876-0987. - -```yaml -Type: SPUserPipeBind -Parameter Sets: (All) -Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AddPermissionLevel -Specifies the permission level to add to the user. - -The value must be one of the following options: - ---Contribute - -Can view, add, update and delete list items and documents. - ---Design - -Can view, add, update, delete, approve and customize documents. - ---Full Control - -Has full control for all documents. - ---Limited Access - -Can view specific lists, document libraries, list items, folders, or documents when permissions are granted. - ---Read - -Can view pages and list items and download documents. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClearPermissions -Deletes all assigned permissions from the user. -If Clear and Add values exist, permissions are first cleared and then new permissions are added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the new display name of the user. - -The type must be a valid name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies the new email address of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Adds the user to an existing group in the given site. - -```yaml -Type: SPGroupPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsSiteCollectionAdmin -Specifies whether to set the user as a site collection administrator. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If not provided, indicates that this cmdlet has no output. -If provided, this parameter indicates that the SPUser object for this user is to be returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemovePermissionLevel -Removes the permission level from the user. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncFromAD -If provided, specifies that user information will be synchronized from the user directory store. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Web -Specifies the name of the URL or GUID to be used as a scope. -This parameter is not needed if the SPUser object is provided as the identity. - -The value must be an authentic URL, in the form http://server_name, or GUID, in the form 1234-5678-9807. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioExternalData.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioExternalData.md deleted file mode 100644 index 32cb1eee8d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioExternalData.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPVisioExternalData -schema: 2.0.0 ---- - -# Set-SPVisioExternalData - -## SYNOPSIS -Configures settings related to external data connections for a Visio Services application. - -## SYNTAX - -``` -Set-SPVisioExternalData -UnattendedServiceAccountApplicationID <String> - -VisioServiceApplication <SPVisioServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPVisioExternalData` cmdlet sets and configures settings for external data connections for the Visio Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPVisioExternalData -VisioServiceApplication "VGS1" -UnattendedServiceAccountApplicationID "SSSApp1" -``` - -This example sets the unattended service account application ID to SSSApp1 for the Visio Services application named VGS1. - - -## PARAMETERS - -### -UnattendedServiceAccountApplicationID -Specifies the target application ID in the registered secure store service that is used to reference unattended service account credentials. -The unattended service account is a single account that all documents can use to refresh data. -It is required when connecting to external data sources. - -The type must be a valid value less than or equal to 256 characters. -The application ID must be registered in the secure store service application or an error message will be displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioExternalData object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioPerformance.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioPerformance.md deleted file mode 100644 index 229c201cae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioPerformance.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPVisioPerformance -schema: 2.0.0 ---- - -# Set-SPVisioPerformance - -## SYNOPSIS -Sets performance properties for a Visio Services application. - - -## SYNTAX - -``` -Set-SPVisioPerformance -MaxDiagramCacheAge <Int32> -MaxDiagramSize <Int64> -MaxRecalcDuration <Int32> - -MinDiagramCacheAge <Int32> -VisioServiceApplication <SPVisioServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] -MaxCacheSize <Int64> [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPVisioPerformance` cmdlet sets properties related to performance for a Visio Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE 1---------------------- -``` -PS C:\>Set-SPVisioPerformance -VisioServiceApplication "VGS2" -MaxDiagramSize 10 -MaxRecalcDuration 120 -MinDiagramCacheAge 1 -MaxDiagramCacheAge 4 -``` - -This example changes settings that are related to performance for a Visio Services application. - - -### -------------------EXAMPLE 2---------------------- -``` -PS C:\>Set-SPVisioPerformance -VisioServiceApplication "VGS2" -MaxDiagramSize 10 -``` - -This example changes settings that are related to performance for a Visio Services application. -Note that only one setting value is specified. -The cmdlet prompts you for the other parameter values. - - -## PARAMETERS - -### -MaxDiagramCacheAge -Specifies the time, in minutes, after which cached items are purged. -This value affects memory use on the server. -A large cache age slows the rate at which diagrams can be refreshed by users and reduces CPU and memory use of the server. -The default value is 60 minutes. - -The type must be an integer in the range of 0 to 34560 (24 days). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDiagramSize -Specifies the maximum size, in megabytes, of a diagram that can be opened by the Visio Services application. -The default value is 5. - -The type must be an integer in the range of 1 to 50. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRecalcDuration -Specifies the maximum time, in seconds, that a diagram can only be recalculated by the Visio Services application. -Diagram recalculation operations that take longer than this number of seconds are canceled by the service. -A low value increases performance by allowing only simple diagrams to be processed by the server, which minimizes CPU and memory use. -A larger value allows the recalculation of more complex diagrams while using more CPU cycles and memory. - -The type must be a valid integer value in the range of 1 to 120 seconds (2 minutes). -The default value is 60 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinDiagramCacheAge -Specifies the minimum time, in minutes, a diagram is cached in memory. -This value affects memory use on the server. -A small value allows users to refresh their diagrams more often, but will increase memory and CPU load of the server. -The default value is 5. - -The type must be an integer in the range of 0 to 34560 (24 days). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioPerformance object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaxCacheSize -{{Fill MaxCacheSize Description}} - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioSafeDataProvider.md deleted file mode 100644 index 9d03102a63..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioSafeDataProvider.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPVisioSafeDataProvider -schema: 2.0.0 ---- - -# Set-SPVisioSafeDataProvider - -## SYNOPSIS -Specifies a description of a safe data provider for a Visio Services application. - -## SYNTAX - -``` -Set-SPVisioSafeDataProvider -DataProviderId <String> -DataProviderType <Int32> -Description <String> - -VisioServiceApplication <SPVisioServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPVisioSafeDataProvider` cmdlet sets the Description property of a safe data provider for a Visio Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------------EXAMPLE 1---------------------- -``` -PS C:\>Set-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "SQLOLEDB" -DataProviderType 1 -Description "SQL OLEDB Driver!" -``` - -This example sets the description property of a safe data provider for a specific Visio Services application. - - -### -------------------EXAMPLE 2---------------------- -``` -PS C:\>Get-SPVisioServiceApplication -Identity "VGS1" | Set-SPVisioSafeDataProvider -DataProviderID "SQLOLEDB" -DataProviderType 1 -Description "SQL OLEDB Driver!" -``` - -This example sets the Description property of a safe data provider for a specific Visio Services application. -The result is piped from the `Set-SPVisioSafeDataProvider` cmdlet. - - -## PARAMETERS - -### -DataProviderId -Specifies the name of the data provider to update. -The combination of DataProviderID and DataProviderType uniquely identifies a data provider for a Visio Services application. -The string that identifies the data provider can be a maximum of 255 alphanumeric characters. -Custom data types are supported; for example, Excel Services. - -The type must be a valid string that identifies the data provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataProviderType -Specifies the supported type of the data provider to get. -Custom data types are supported; for example, Excel services. - -The type must be a valid identity of a data provider type. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the safe data provider to set. - -The type must be a string with a maximum of 4096 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisioServiceApplication -Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioServiceApplication.md deleted file mode 100644 index d987a790dd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPVisioServiceApplication.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Office.Visio.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPVisioServiceApplication -schema: 2.0.0 ---- - -# Set-SPVisioServiceApplication - -## SYNOPSIS -Sets the ServiceApplicationPool property for a Visio Services application. - -## SYNTAX - -``` -Set-SPVisioServiceApplication [-Identity] <SPVisioServiceApplicationPipeBind> - [-ServiceApplicationPool] <SPIisWebServiceApplicationPoolPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPVisioServiceApplication` cmdlet sets the ServiceApplicationPool property for a Visio Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------------EXAMPLE 1---------------------- -``` -PS C:\>Set-SPVisioServiceApplication -identity "VGS1" -ServiceApplicationPool "SharePoint Web Services System Default" -``` - -This example changes the application pool of the VGS1 service application. - - -### -----------------EXAMPLE 2---------------------- -``` -PS C:\>Get-SPServiceApplicationPool "SharePoint Web Services Default" | Set-SPVisioServiceApplication VGS1 -``` - -This example changes the application pool of the VGS1 service application. -The results are piped from the `Get-SPServiceApplicationPool` cmdlet. - - -## PARAMETERS - -### -Identity -Specifies the Visio Services application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. - -```yaml -Type: SPVisioServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceApplicationPool -Specifies the IIS application pool to change. -The Web service for the service application runs in the specified application pool. - -The type must be a valid name of a Visio Service application pool, such as MyVisioServiceAppPool1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPIisWebServiceApplicationPoolPipeBind object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWOPIBinding.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWOPIBinding.md deleted file mode 100644 index 42fd89e7ad..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWOPIBinding.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWOPIBinding -schema: 2.0.0 ---- - -# Set-SPWOPIBinding - -## SYNOPSIS -Updates the default click action for an application or file name extension binding. - - -## SYNTAX - -``` -Set-SPWOPIBinding [-Identity] <SPWopiBindingPipeBind> [-DefaultAction] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPWOPIBinding` cmdlet updates the default click action for an application or file name extension binding. -For example, you can set the default click action to view for a Word document in a SharePoint library. -To do this, you set the default action to true for the "view"-"Word" bindings. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\> Get-SPWOPIBinding -Action "view" -Application "Word"| Set-SPWOPIBinding -DefaultAction:$true -``` - -This example sets the default click action to view for a Word document in a SharePoint library. -You can verify that the default click action is set to view for Word by running the cmdlet `Get-SPWOPIBinding -Action "view" -Application "Word"`. -The IsDefaultAction value is set to "True." - - -## PARAMETERS - -### -Identity -Specifies the binding. - -```yaml -Type: SPWopiBindingPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultAction -Specifies whether the binding should be set as the default click action for an application or file name extension in the binding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[Get-SPWOPIBinding](Get-SPWOPIBinding.md) - -[Remove-SPWOPIBinding](Remove-SPWOPIBinding.md) - -[New-SPWOPIBinding](New-SPWOPIBinding.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWOPIZone.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWOPIZone.md deleted file mode 100644 index 8bb31afe83..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWOPIZone.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWOPIZone -schema: 2.0.0 ---- - -# Set-SPWOPIZone - -## SYNOPSIS -Configures the zone that the current SharePoint farm will use to navigate the browser to the WOPI application. - - -## SYNTAX - -``` -Set-SPWOPIZone [[-Zone] <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPWOPIZone` cmdlet configures the zone that the current SharePoint farm will use to navigate the browser to the WOPI application (such as a server that runs Office Web Apps Server). -The SharePoint Server page in the browser creates a frame that contains a page on the WOPI application. -The zone for the URL of the WOPI application page is determined by this setting. - -If you do not set the zone, the default is "internal-HTTPS." If you select a zone that is not supported by the WOPI application, Office Web Apps will not work. -Only use HTTP when you are on a fully secure network that uses IPSEC (full encryption) or in a test environment that does not contain sensitive data. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Set-SPWOPIZone -Zone "external-https" -``` - -This example configures the current SharePoint farm to use external connections through HTTPS to the WOPI application (such as a server that runs Office Web Apps Server). - - -## PARAMETERS - -### -Zone -Specifies the zone. -For a list of zones that the WOPI application supports, run `Get-SPWOPIBinding`. - -If you have a SharePoint farm that's internal and external, specify external. -If you have a SharePoint farm that's internal only, specify internal. -Only use HTTP when you are on a fully secure network that uses IPSEC (full encryption) or in a test environment that does not contain sensitive data. -The options are as follows: - -- Internal-HTTP -- Internal-HTTPS -- External-HTTP -- External-HTTPS - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters`. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() - -[Get-SPWOPIZone](Get-SPWOPIZone.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWeb.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWeb.md deleted file mode 100644 index ec62e14e38..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWeb.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWeb -schema: 2.0.0 ---- - -# Set-SPWeb - -## SYNOPSIS -Configures the specified subsite. - - -## SYNTAX - -``` -Set-SPWeb [-Identity] <SPWebPipeBind> [-Description <String>] [-RelativeUrl <String>] [-Theme <String>] - [-Template <SPWebTemplatePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPWeb` cmdlet configures the subsite specified by the Identity parameter. -Settings for any parameters that are not provided are not changed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPWeb http://sitename/subweb | Set-SPWeb -Title "My Site Title" -``` - -This example sets the title of an existing subsite. - - -## PARAMETERS - -### -Identity -The URL of the Web or SPWeb object that represents the Web. - -The type must be a valid URL, in the form http://server_name, or an SPWeb object. - -```yaml -Type: SPWebPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Description -Specifies the new description of the Web. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RelativeUrl -Specifies the new relative URL for the Web. -This is the URL path after the site collection URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Theme -Specifies the new theme to apply to the Web. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template -Specifies the new template to apply to the Web. -This cannot be done if the template is already applied. - -```yaml -Type: SPWebTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWebApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWebApplication.md deleted file mode 100644 index 46b4b4f72c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWebApplication.md +++ /dev/null @@ -1,412 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWebApplication -schema: 2.0.0 ---- - -# Set-SPWebApplication - -## SYNOPSIS -Configures the specified Web application. - - -## SYNTAX - -### UpdateMailSettings -``` -Set-SPWebApplication [-Identity] <SPWebApplicationPipeBind> [-OutgoingEmailAddress <String>] - [-ReplyToEmailAddress <String>] -SMTPServer <String> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-WhatIf] [-DisableSMTPEncryption] [-NotProvisionGlobally] [-SMTPServerPort <Int32>] - [<CommonParameters>] -``` - -### UpdateClaimSettings -``` -Set-SPWebApplication [-Identity] <SPWebApplicationPipeBind> -Zone <SPUrlZone> - [-AdditionalClaimProvider <SPClaimProviderPipeBind[]>] [-AssignmentCollection <SPAssignmentCollection>] - [-AuthenticationMethod <String>] [-AuthenticationProvider <SPAuthenticationProviderPipeBind[]>] [-Confirm] - [-Force] [-SignInRedirectProvider <SPTrustedIdentityTokenIssuerPipeBind>] [-SignInRedirectURL <String>] - [-WhatIf] [-NotProvisionGlobally] [<CommonParameters>] -``` - -### UpdateGeneralSettings -``` -Set-SPWebApplication [-Identity] <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-DefaultQuotaTemplate <String>] [-DefaultTimeZone <Int32>] [-Force] - [-ServiceApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-WhatIf] [-NotProvisionGlobally] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Set-SPWebApplication` cmdlet configures the Web application specified by the Identity parameter. -For any settings that are zone-specific (for the Zone parameter set), the zone to configure must be provided. -The provided zone must already exist. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPWebApplication http://somesite | Set-SPWebApplication -Zone "Extranet" -HostHeader "http://www.contoso.com/" - AllowAnonymousAccess -``` - -This example sets the HostHeader URL for the Extranet zone of the given Web application as http://www.contoso.com and enables anonymous access. - - -## PARAMETERS - -### -Identity -Specifies the name or URL of the Web application. - -The type must be a valid name, in the form WebApplication-1212, or URL, in the form http://server_name/WebApplicaiton-1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OutgoingEmailAddress -Specifies the new outgoing e-mail address for e-mail messages sent from this Web application. -The type must be a valid address; for example, someone@example.com. - -```yaml -Type: String -Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplyToEmailAddress -Configures the reply e-mail address. - -The type must be a valid address; for example, someone@example.com. - -```yaml -Type: String -Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SMTPServer -Specifies the new outbound SMTP server that this Web application will use. - -```yaml -Type: String -Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -When configuring zone-specific settings, the zone to configure must be specified. -This zone must already exist. - -The type must be any one of the following values: Default, Intranet, Internet, Extranet, or Custom. - -```yaml -Type: SPUrlZone -Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdditionalClaimProvider -Adds a specific claim provider to the defined Web application. - -```yaml -Type: SPClaimProviderPipeBind[] -Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMethod -Use to set a Web application to classic Windows authentication. -The valid values are NTLM or Kerberos. - -```yaml -Type: String -Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationProvider -Defines the authentication provider(s) that applies to the Web application. - -```yaml -Type: SPAuthenticationProviderPipeBind[] -Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultQuotaTemplate -Specifies the new default site quota template for this Web application. - -```yaml -Type: String -Parameter Sets: UpdateGeneralSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultTimeZone -Specifies the default time zone for new site collections in this Web application. - -```yaml -Type: Int32 -Parameter Sets: UpdateGeneralSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses confirmation messages involved in settings for a Web application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplicationProxyGroup -Specifies a custom service application proxy group for the Web application to use. -The Web application will use the proxies in this proxy group to connect to service applications. -If this parameter is not specified, the farm's default proxy group is used. - -```yaml -Type: SPServiceApplicationProxyGroupPipeBind -Parameter Sets: UpdateGeneralSettings -Aliases: ProxyGroup -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInRedirectProvider -Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. - -```yaml -Type: SPTrustedIdentityTokenIssuerPipeBind -Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInRedirectURL -Specifies the sign-in redirect URL for the Web application. - -```yaml -Type: String -Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSMTPEncryption -{{Fill DisableSMTPEncryption Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotProvisionGlobally -{{Fill NotProvisionGlobally Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SMTPServerPort -{{Fill SMTPServerPort Description}} - -```yaml -Type: Int32 -Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWebApplicationHttpThrottlingMonitor.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWebApplicationHttpThrottlingMonitor.md deleted file mode 100644 index d678ce152b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWebApplicationHttpThrottlingMonitor.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWebApplicationHttpThrottlingMonitor -schema: 2.0.0 ---- - -# Set-SPWebApplicationHttpThrottlingMonitor - -## SYNOPSIS -Sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application. - - -## SYNTAX - -``` -Set-SPWebApplicationHttpThrottlingMonitor [-Identity] <SPWebApplicationPipeBind> [-Category] <String> - [-Counter] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-HealthScoreBuckets <Double[]>] [-Instance <String>] [-IsDESC] [-LowerLimit <Double>] [-UpperLimit <Double>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPWebApplicationHttpThrottlingMonitor` cmdlet sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -C:\PS>$buckets=(2000,1000,500,300,200,100,50,30,20,10) -Set-SPWebApplicationHttpThrottlingMonitor http://sharepoint - -Category Memory -Counter 'Available Mbytes' -IsDesc -HealthScoreBuckets $buckets -``` - -This example sets the Health Score bucket values for the Memory\Available Mbytes counter to the array listed for the http://sharepoint Web application. - - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Set-SPWebApplicationHttpThrottlingMonitor http://sharepoint -0 -Category Memory -Counter 'Available Mbytes' -IsDesc -UpperLimit 3000 -``` - -This example sets the upper limit for the Memory\Available Mbytes counter, the highest value in the Health Score buckets, to 3000 for the http://sharepoint Web application. - - -## PARAMETERS - -### -Identity -Specifies the SharePoint Web application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Category -Specifies the name of the performance counter category. - -The type must be a valid performance counter category in the throttling monitor. -Use the `Get-SPWebApplicationHttpThrottlingMonitor` cmdlet to return a list of performance counter categories in the throttling monitor. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Counter -Specifies the name of the performance counter. - -The type must be a valid performance counter in the throttling monitor. -Use the `Get-SPWebApplicationHttpThrottlingMonitor` cmdlet to return a list of performance counters in the throttling monitor. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthScoreBuckets -Specifies bucket ranges to use in determining the calculation of the server Health Score for this counter. - -```yaml -Type: Double[] -Parameter Sets: (All) -Aliases: Buckets -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies the instance of the performance counter. -The default value is empty. -If the specified value is invalid, this cmdlet will not run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsDESC -Specifies that this counter is interpreted in descending order. - -If this parameter is set, Health Score bucket values are interpreted in descending order; for example, set this parameter by using the Memory category and Available Mbytes counter to monitor available memory. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LowerLimit -Specifies the lower limit of the numerical threshold of the specified performance counter. -The lower limit is the lowest value in the Health Score bucket values. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: Lower -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpperLimit -Specifies the upper limit of the numerical threshold of the specified performance counter. -The upper limit is the highest value in the Health Score bucket values. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: Upper -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWordConversionServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWordConversionServiceApplication.md deleted file mode 100644 index 791ac19d72..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWordConversionServiceApplication.md +++ /dev/null @@ -1,490 +0,0 @@ ---- -external help file: Microsoft.Office.Word.Server.dll-Help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWordConversionServiceApplication -schema: 2.0.0 ---- - -# Set-SPWordConversionServiceApplication - -## SYNOPSIS -Sets properties of a Word Automation Services application. - -## SYNTAX - -``` -Set-SPWordConversionServiceApplication [-Identity] <WordServiceApplicationPipeBind> [-ActiveProcesses <Int32>] - [-AddSupportedFormats <String[]>] [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-ClearSupportedFormats] [-Confirm] - [-ConversionsPerInstance <Int32>] [-ConversionTimeout <Int32>] [-DatabaseCredential <PSCredential>] - [-DatabaseName <String>] [-DatabaseServer <String>] [-DisableBinaryFileScan] [-DisableEmbeddedFonts] - [-KeepAliveTimeout <Int32>] [-MaximumConversionAttempts <Int32>] [-MaximumConversionTime <Int32>] - [-MaximumMemoryUsage <Int32>] [-RecycleProcessThreshold <Int32>] [-RemoveSupportedFormats <String[]>] - [-TimerJobFrequency <Int32>] [-WhatIf] [-MaximumGroupSize <Int32>] [-MaximumSyncConversionRequests <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-SPWordConversionServiceApplication` cmdlet sets global properties of a Word Automation Services application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -----------EXAMPLE----------------- -``` -PS C:\>Get-SPServiceApplication -Name WordServices1 | Set-SPWordConversionServiceApplication -TimerJobFrequency 30 -``` - -This example sets the timer job frequency of the WordServices1 application to 30 minutes. - - -## PARAMETERS - -### -Identity -Specifies the Word Automation Services application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object. - -```yaml -Type: WordServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ActiveProcesses -Specifies the number of conversion processes on each machine on which the service application runs. -This value is equivalent to the number of simultaneous conversions. -The default value is 8. - -The type must be a valid integer in the range from 1 to 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddSupportedFormats -Specifies a set of file formats to be enabled for use by the service application. - -The value must be a comma-delimited list of one or more of the following: docx, doc, mht, rtf, xml. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the existing IIS managed application pool in which this instance of Word Automation Services runs. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClearSupportedFormats -Specifies that all file formats should be disabled for use by the service application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConversionsPerInstance -Specifies the number of items sent to each conversion process (see the ActiveProcesses parameter description earlier in this table) every time the timer job is run. -The default value is 12. - -The type must be a valid integer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConversionTimeout -Specifies the time, in minutes, after which a conversion that is marked InProgress is confirmed to be still running each time the timer job runs and if necessary, the conversion is restarted. -The default value is 5. - -The type must be a valid integer in the range from 1 to 60. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredential -Specifies the credentials to use for connecting to the database for the Word Automation Services application. -Use this parameter only if SQL Authentication is used to access the service application database. - -When the DatabaseCredential parameter is specified, the DatabaseName and DatabaseServer parameters are required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to use for this instance of the Word Automation Services application. - -The type must be a valid SQL database name; for example, MetadataDB1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseServer -Specifies the name of the host server for the Word Automation Services database. - -The type must be a valid SQL database server host name; for example, SQLServerHost1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBinaryFileScan -Specifies whether additional checks are run when Word documents are processed. -Turn this setting off only if all documents processed by the service are trusted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableEmbeddedFonts -Specifies whether embedded fonts are ignored when present in input documents. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepAliveTimeout -Specifies the length of time, in seconds, that a conversion can be non-responsive before it is terminated. -The default value is 30. - -The type must be a valid integer in the range from 10 to 60. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumConversionAttempts -The maximum number of conversion attempts before a conversion is marked with status "Failed". -The default value is 2. - -The type must be a valid integer in the range from 1 to 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumConversionTime -Specifies the maximum length of time, in seconds, that a conversion can run before it is terminated. -The default value is 300. - -The type must be a valid integer in the range from 60 to MaxInt. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumMemoryUsage -Specifies the maximum percentage of system memory which can be used by the service application. -The default value is 100. - -The type must be a valid integer in the range from 10 to 100. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecycleProcessThreshold -Specifies the number of documents which are converted before a conversion process is recycled. -For additional information about the conversion process, see the ActiveProcess parameter description earlier in this table. - -The type must be a valid integer in the range from 1 to 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSupportedFormats -Specifies a set of file formats to be disabled for use by the service application. - -The value must be a comma delimited list of one or more of the following: docx, doc, mht, rtf, xml. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimerJobFrequency -Specifies the frequency, in minutes, with which the timer job for this service application runs. -The default value is 15. - -The type must be a valid integer in the range from 1 to 59. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumGroupSize -{{Fill MaximumGroupSize Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumSyncConversionRequests -{{Fill MaximumSyncConversionRequests Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkManagementServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkManagementServiceApplication.md deleted file mode 100644 index 9298a95675..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkManagementServiceApplication.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: Microsoft.Office.Server.WorkManagement.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPWorkManagementServiceApplication -schema: 2.0.0 ---- - -# Set-SPWorkManagementServiceApplication - -## SYNOPSIS -Sets settings for the Work Management Service application. - -## SYNTAX - -``` -Set-SPWorkManagementServiceApplication [-Identity] <SPWorkManagementServiceCmdletPipeBind> - [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-MinimumTimeBetweenProviderRefreshes <TimeSpan>] [-MinimumTimeBetweenSearchQueries <TimeSpan>] - [-Name <String>] [-WhatIf] [-MinimumTimeBetweenEwsSyncSubscriptionSearches <TimeSpan>] - [-NumberOfSubscriptionSyncsPerEwsSyncRun <UInt32>] [-NumberOfUsersEwsSyncWillProcessAtOnce <UInt32>] - [-NumberOfUsersPerEwsSyncBatch <UInt32>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPWorkManagementServiceApplication` cmdlet to set settings (that is, minimum time between refreshes for aggregating tasks and load per machine for synchronization with Exchange) for the specified Work Management Service Application by using the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE--------------- -``` -C:\PS>$wmservice = Get-SPServiceApplication -Name "Work Management Service Application" - -C:\PS>$refreshTime = New-Timespan -Minutes 10 - -PS C:\>Set-SPWorkManagementServiceApplication -Identity $wmservice -MinimumTimeBetweenProviderRefreshes $refreshTime -``` - -This example sets the minimum time between provider refreshes to 10 minutes on the service application named "Work Management Service Application". - -## PARAMETERS - -### -Identity -Specifies the service application to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPWorkManagementServiceApplication object - -```yaml -Type: SPWorkManagementServiceCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ApplicationPool -Specifies the name of an application pool to use; for example, SharePoint - 1213. -If no value is specified, the default application pool is used. - -```yaml -Type: SPIisWebServiceApplicationPoolPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumTimeBetweenProviderRefreshes -Specifies the minimum amount of time between cache update operations per user. -If this time has not passed since the last successful refresh request for a user, the service application does not execute new refresh requests. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumTimeBetweenSearchQueries -Specifies the minimum amount of time between calls to the Search Service application to discover new SharePoint task lists where a user has tasks. -If this time has not passed since the last successful call to Search for a user, the service application does not call Search during refresh operations. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Work Management Service application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumTimeBetweenEwsSyncSubscriptionSearches -This value specifies the minimum amount of time between calls into our routine that tries to find new tenants that want to sync EWS tasks. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfSubscriptionSyncsPerEwsSyncRun -This value specifies the maximum number of tenants the service will try to sync via EWS per Timer job interval - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfUsersEwsSyncWillProcessAtOnce -This value specifies the maximum number of users a service instance machine will sync via EWS at one time across all tenants. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfUsersPerEwsSyncBatch -This value specifies the maximum number of users a service instance will try to sync on a given tenant via EWS per Timer job interval - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPWorkManagementServiceApplication](New-SPWorkManagementServiceApplication.md) - -[New-SPWorkManagementServiceApplicationProxy](New-SPWorkManagementServiceApplicationProxy.md) - -[Set-SPWorkManagementServiceApplicationProxy](Set-SPWorkManagementServiceApplicationProxy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkManagementServiceApplicationProxy.md deleted file mode 100644 index 1e66589dea..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkManagementServiceApplicationProxy.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Office.Server.WorkManagement.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPWorkManagementServiceApplicationProxy -schema: 2.0.0 ---- - -# Set-SPWorkManagementServiceApplicationProxy - -## SYNOPSIS -Sets the settings for the Work Management Service application proxy. - -## SYNTAX - -``` -Set-SPWorkManagementServiceApplicationProxy [-Identity] <SPWorkManagementServiceProxyCmdletPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DefaultProxyGroup] [-Name <String>] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Set-SPWorkManagementServiceApplicationProxy` cmdlet to set the settings for the Work Management service application proxy. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE-------- -``` -PS C:\>Set-SPWorkManagementServiceApplicationProxy -Identity "9187d901-e0e0-4509-b117-9eca20d3ead5" -DefaultProxyGroup -``` - -This example makes the Work Management service part of the default proxy group. - - -## PARAMETERS - -### -Identity -Specifies the service application proxy to update. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPWorkManagementServiceApplicationProxy object - -```yaml -Type: SPWorkManagementServiceProxyCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup -Specifies whether the Work Management Service application proxy is to the default proxy group for the local farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name for the new Work Management Service application. -For example, WorkManService1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-SPWorkManagementServiceApplication](New-SPWorkManagementServiceApplication.md) - -[New-SPWorkManagementServiceApplicationProxy](New-SPWorkManagementServiceApplicationProxy.md) - -[Set-SPWorkManagementServiceApplication](Set-SPWorkManagementServiceApplication.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md deleted file mode 100644 index 643184b4ff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Set-SPWorkflowConfig -schema: 2.0.0 ---- - -# Set-SPWorkflowConfig - -## SYNOPSIS -Configures the workflow settings for the specified Web application. - - -## SYNTAX - -### SiteCollection -``` -Set-SPWorkflowConfig [-SiteCollection] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-DeclarativeWorkflowsEnabled <Boolean>] [-EmailNoPermissionParticipantsEnabled <Boolean>] - [-SendDocumentToExternalParticipants <Boolean>] [-SingleWorkflowEpisodeTimeout <Int32>] [<CommonParameters>] -``` - -### WebApplication -``` -Set-SPWorkflowConfig [-WebApplication] <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-DeclarativeWorkflowsEnabled <Boolean>] - [-EmailNoPermissionParticipantsEnabled <Boolean>] [-SendDocumentToExternalParticipants <Boolean>] - [-SingleWorkflowEpisodeTimeout <Int32>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Set-SPWorkflowConfig` cmdlet to configure the workflow settings for the specified Web application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Set-SPWorkflowConfig -webapplication http://sitename DeclarativeWorkflowsEnabled $true -EmailNoPermissionParticipantsEnabled $true -SendDocumentToExternalParticipants $false -``` - -This example sets the workflow settings for the specified Web application to turn on declarative workflows, turn on e-mail to participants who do not have permissions to the site and turn off the functionality to send e-mail messages as attachments to external participants. - -No return values. -Use the `Get-SPWorkflowConfig` cmdlet to see values. -To set farm-level workflow settings for event-delivery time-out and to postpone threshold and batch size, use `Set-SPFarmConfig`. - - -## PARAMETERS - -### -SiteCollection -Specifies the name or URL of the site collection. - -The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. -No other parameters are used. - -```yaml -Type: SPSitePipeBind -Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the name or URL of the Web application. - -The type must be a valid name or GUID, in the form WebApplication-1212, or a URL, in the form http://server_name/WebApplication-1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DeclarativeWorkflowsEnabled -Sets whether declarative workflows are allowed to run in the Web application. - -The type must be either 1 for True or 0 for False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailNoPermissionParticipantsEnabled -Sets whether workflows send task e-mail messages to users who do not have permissions to the site in which the workflows are running. - -The type must be either 1 for True or 0 for False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendDocumentToExternalParticipants -Sets whether workflows automatically send a copy of the document as an e-mail attachment to participants who do not have access to the site or who are not in any linked directory other than Active Directory Domain Services (AD DS). - -The type must be either 1 for True or 0 for False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SingleWorkflowEpisodeTimeout -{{Fill SingleWorkflowEpisodeTimeout Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Split-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Split-SPScaleOutDatabase.md deleted file mode 100644 index eef7683d65..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Split-SPScaleOutDatabase.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Split-SPScaleOutDatabase -schema: 2.0.0 ---- - -# Split-SPScaleOutDatabase - -## SYNOPSIS -Moves a specified percentage of partitions from one scale-out database to another. - - -## SYNTAX - -### NewDatabase -``` -Split-SPScaleOutDatabase -NewDatabaseName <String> -SourceDatabase <SPDatabasePipeBind> - -SourceServiceApplication <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-MoveLowerHalf] [-NewDatabaseCredentials <PSCredential>] [-NewDatabaseFailoverServer <String>] - [-NewDatabaseServer <String>] [-SourcePercentage <Int32>] [-WhatIf] [<CommonParameters>] -``` - -### ExistingDatabase -``` -Split-SPScaleOutDatabase -SourceDatabase <SPDatabasePipeBind> - -SourceServiceApplication <SPServiceApplicationPipeBind> -TargetDatabase <SPDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MoveLowerHalf] [-SourcePercentage <Int32>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Split-SPScaleOutDatabase` cmdlet to move a specified percentage of partitions from a source database to an existing target database or to a new database that you create with the specified parameters. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE--------------- -``` -PS C:\>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication -PS C:\>$database = $databases[0] -PS C:\>Split-SPScaleOutDatabase -NewDatabaseName Database2 -NewDatabaseServer MyDatabaseServer -SourceDatabase $database -SourceServiceApplication $serviceApplication -SourcePercentage 30 -``` - -This example creates a new scale-out database named Database2 on the MyDatabaseServer database server in the given service application. - -The example also moves 30 percent of the data from the upper side of the data range in the first scale-out database of the given service application. - -## PARAMETERS - -### -NewDatabaseName -Specifies the name of a new scale-out database that you are creating. - -```yaml -Type: String -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabase -The source scale-out database to move data from. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceServiceApplication -The service application in which the data move operation will take place. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDatabase -The target scale-out database to move data to. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: ExistingDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveLowerHalf -Specifies whether to move the lower or the upper side of the data range from the source scale-out database. -If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseCredentials -Specifies the credentials to use when creating the scale-out database. -These credentials will have owner rights on the newly created scale-out database. -If a value is not provided, the current user's credentials will be used by default. - -```yaml -Type: PSCredential -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseFailoverServer -Specifies the failover server name of the new scale-out database to be created. -If a value is not provided, the new scale-out database does not have a failover server. - -```yaml -Type: String -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseServer -Specifies the name of the server of the new scale-out database to be created. -If a value is not provided, the default database server is used. - -```yaml -Type: String -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePercentage -Specifies the percentage of data in the source scale-out database to move. -If a value is not provided, the default value of 50 percent is used. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPScaleOutDatabase](Add-SPScaleOutDatabase.md) - -[Get-SPScaleOutDatabase](Get-SPScaleOutDatabase.md) - -[Remove-SPScaleOutDatabase](Remove-SPScaleOutDatabase.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Split-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Split-SPServerScaleOutDatabase.md deleted file mode 100644 index 88fc5648c8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Split-SPServerScaleOutDatabase.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Split-SPServerScaleOutDatabase -schema: 2.0.0 ---- - -# Split-SPServerScaleOutDatabase - -## SYNOPSIS -Moves a specified percentage of partitions from one scale-out database to another. - - -## SYNTAX - -### NewDatabase -``` -Split-SPServerScaleOutDatabase -NewDatabaseName <String> -SourceDatabase <SPDatabasePipeBind> - -SourceServiceApplication <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-MoveLowerHalf] [-NewDatabaseCredentials <PSCredential>] [-NewDatabaseFailoverServer <String>] - [-NewDatabaseServer <String>] [-SourcePercentage <Int32>] [-WhatIf] [<CommonParameters>] -``` - -### ExistingDatabase -``` -Split-SPServerScaleOutDatabase -SourceDatabase <SPDatabasePipeBind> - -SourceServiceApplication <SPServiceApplicationPipeBind> -TargetDatabase <SPDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-MoveLowerHalf] [-SourcePercentage <Int32>] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets](https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - -Use the Split-SPServerScaleOutDatabase cmdlet to move a specified percentage of partitions from a source database to an existing target database or to a new database that you create with the specified parameters. - - - -## EXAMPLES - -### ---------------EXAMPLE--------------- -``` -PS C:\>$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication -PS C:\>$database = $databases[0] -PS C:\>Split-SPServerScaleOutDatabase -NewDatabaseName Database2 -NewDatabaseServer MyDatabaseServer -SourceDatabase $database -SourceServiceApplication $serviceApplication -SourcePercentage 30 -``` - -This example creates a new scale-out database named Database2 on the MyDatabaseServer database server in the given service application. The example also moves 30 percent of the data from the upper side of the data range in the first scale-out database of the given service application. - -## PARAMETERS - -### -NewDatabaseName -Specifies the name of a new scale-out database that you are creating. - -```yaml -Type: String -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabase -The source scale-out database to move data from. - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceServiceApplication -The service application in which the data move operation will take place. - - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDatabase -The target scale-out database to move data to. - - -```yaml -Type: SPDatabasePipeBind -Parameter Sets: ExistingDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveLowerHalf -Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseCredentials -Specifies the credentials to use when creating the scale-out database. These credentials will have owner permissions on the new scale-out database. If you do not provide a value, the credentials of the logged on user will be used. - - -```yaml -Type: PSCredential -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseFailoverServer -Specifies the failover server name of the new scale-out database. If you do not provide a value, the new scale-out database does not have a failover server. - - -```yaml -Type: String -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDatabaseServer -Specifies the name of the server of the new scale-out database. If you do not provide a value, the name of the default database server is used. - - -```yaml -Type: String -Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePercentage -Specifies the percentage of data in the source scale-out database to move. If you do not provide a value, the default value, 50 percent, is used. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-SPServerScaleOutDatabase](Add-SPServerScaleOutDatabase.md) - -[Get-SPServerScaleOutDatabase](Get-SPServerScaleOutDatabase.md) - -[Remove-SPServerScaleOutDatabase](Remove-SPServerScaleOutDatabase.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPAdminJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPAdminJob.md deleted file mode 100644 index a6c0a28a1a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPAdminJob.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPAdminJob -schema: 2.0.0 ---- - -# Start-SPAdminJob - -## SYNOPSIS -Immediately starts any waiting administrative job on the local computer. - - -## SYNTAX - -``` -Start-SPAdminJob [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Start-SPAdminJob` cmdlet to execute all administrative timer jobs immediately rather than waiting for the timer job to run. - -When the service account for the SharePoint Administration service (SPAdminV4)) is disabled (necessary in some installations for security reasons), the `Start-SPAdminJob` cmdlet must be run on all computers to perform administrative task like provisioning. - -When you run this cmdlet in person (not in script), use the Verbose parameter to see the individual administrative operations that are run. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Start-SPAdminJob -Verbose -``` - -This example runs all waiting administrative jobs and shows verbose output to the administrator. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPAssignment.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPAssignment.md deleted file mode 100644 index 92a2925bc3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPAssignment.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPAssignment -schema: 2.0.0 ---- - -# Start-SPAssignment - -## SYNOPSIS -Initiates a new assignment store. - - -## SYNTAX - -``` -Start-SPAssignment [-AssignmentCollection <SPAssignmentCollection>] [-Global] [<CommonParameters>] -``` - -## DESCRIPTION -The `Start-SPAssignment` cmdlet properly disposes of objects used with variable assignments. - -Large amounts of memory are often required when SPWeb, SPSite, or SPSiteAdminsitration objects are used. -So the use of these objects, or lists of these objects, in Windows PowerShell scripts requires proper memory management. -By default, all Get commands dispose of these objects immediately after the pipeline finishes, but by using SPAssignment, you can assign the list of objects to a variable and dispose of the objects after they are no longer needed. -You can also ensure that the objects remain as long as you need them, even throughout multiple iterations of commands. - -There are three levels of assignment: - --- No assignment -- The object is not assigned to a variable and is disposed of after each iteration of the command. - --- Simple assignment -- All objects are assigned to the global assignment store. This is done by using the Global parameter. When using this level, all objects are assigned to a global store and are disposed of when the Stop-SPAssignment cmdlet is called. - --- Advanced assignment -- Objects are assigned to named stores for disposal. You can dispose of objects by using the Identity parameter with the `Stop-SPAssignment` cmdlet. - -Regardless of the assignment level used, all objects are disposed of when the Windows PowerShell run space is closed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Start-SPAssignment -global -PS C:\>$w = Get-SPWeb http://MyWeb -PS C:\>$w | Set-SPWeb -title "Accounting" -PS C:\>Stop-SPAssignment -global -``` - -This example uses simple assignment. -Although it is easier to use simple assignment, it is not a good idea to run commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled. -Ensure that you run `Stop-SPAssignment` before you attempt any iterations of multiple objects. - - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>$gc = Start-SPAssignment -PS C:\>$web = $gc | Get-SPWeb http://MyWeb -PS C:\>$web | Set-SPWeb -title "Accounting" -PS C:\>Stop-SPAssignment -Identity $gc -``` - -This example sets the title of the SPWeb object in multiple lines and controls the rate of disposal. -This is an advanced example. -Only developers are advised to use it. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Global -If you use this parameter, all objects are assigned to the lifetime of the script and are disposed of when the `Stop-SPAssignment` cmdlet is called. - -If you do not use this parameter, you must assign the output of this cmdlet to a variable and then dispose of objects by using the Identity parameter of the `Stop-SPAssignment` cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPContentDeploymentJob.md deleted file mode 100644 index 20a03bad98..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPContentDeploymentJob.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Publishing.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPContentDeploymentJob -schema: 2.0.0 ---- - -# Start-SPContentDeploymentJob - -## SYNOPSIS -Starts a content deployment job. - -## SYNTAX - -``` -Start-SPContentDeploymentJob [-Identity] <SPContentDeploymentJobPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DeploySinceTime <String>] [-TestEnabled] - [-WaitEnabled] [-WhatIf] [-UseSpecificSnapshot <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Start-SPContentDeploymentJob` cmdlet starts a content deployment job. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Get-SPContentDeploymentPath "Path 1" | New-SPContentDeploymentJob -Name "Job 1" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false | Start-SPContentDeploymentJob -``` - -This example creates a content deployment job Job 1 and runs it immediately. - - -## PARAMETERS - -### -Identity -Specifies the content deployment job to run. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. - -```yaml -Type: SPContentDeploymentJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploySinceTime -Specifies the date to use to determine what changes to export incrementally. -This parameter is ignored if the deployment job type is full. - -The type must be a valid DateTime type, in the form 2010,12,05. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestEnabled -Runs the content deployment job in test mode only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitEnabled -Specifies that the command is not returned until the operation is complete. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSpecificSnapshot -Use a snapshot of the named Content Database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPDiagnosticsSession.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPDiagnosticsSession.md deleted file mode 100644 index fcbc0ca092..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPDiagnosticsSession.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPDiagnosticsSession -schema: 2.0.0 ---- - -# Start-SPDiagnosticsSession - -## SYNOPSIS -Starts a diagnostic session to report diagnostic information to the usage database. - - -## SYNTAX - -``` -Start-SPDiagnosticsSession [-AssignmentCollection <SPAssignmentCollection>] [-CorrelationId <Guid>] - [-Dashboard] [-TraceLevel <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Start-SPDiagnosticsSession` cmdlet to report diagnostic information to the usage database. -After a diagnostic session starts, all Windows PowerShell for SharePoint cmdlets in Windows PowerShell scripts will use the same correlation to report diagnostic information. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### -------------EXAMPLE------- -``` -PS C:\>$correlationId = [guid]::NewGuid() -PS C:\>Start-SPDiagnosticsSession -CorrelationId $correlationId -Dashboard:$true -TraceLevel Verbose -``` - -This example starts a diagnostic session for a specified correlation ID with the trace level of verbose. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CorrelationId -Specifies the correlation ID to be used for the diagnostic session. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dashboard -Specifies that diagnostics behave as if the developer dashboard were enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TraceLevel -Specifies the Unified Logging Service (ULS) trace level override. - ---High ---Medium ---Monitorable ---Unexpected ---Verbose ---VerboseEx ---None - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Stop-SPDiagnosticsSession](Stop-SPDiagnosticsSession.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md deleted file mode 100644 index 8256f0af81..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -schema: 2.0.0 ---- - -# Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance - -## SYNOPSIS -Starts an instance of a search manager service. - -## SYNTAX - -``` -Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance - [-Identity] <SearchQueryAndSiteSettingsServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance` cmdlet starts the query and site settings service instance on the server instance in the same farm as the search service application to host the query object model (OM), Windows Communication Foundation (WCF) endpoint and query processor for the search service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$qssInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local -PS C:\>Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstance -``` - -This example starts the local query and site settings instance. - - -## PARAMETERS - -### -Identity -Specifies the search manager service instance to start. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid SPServer name, or the name of a search manager service instance (for example, SearchManagerServiceInstance1); or an instance of a valid SearchManagerServiceInstance object. - - -```yaml -Type: SearchQueryAndSiteSettingsServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPEnterpriseSearchServiceInstance.md deleted file mode 100644 index e897be649d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPEnterpriseSearchServiceInstance.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPEnterpriseSearchServiceInstance -schema: 2.0.0 ---- - -# Start-SPEnterpriseSearchServiceInstance - -## SYNOPSIS -Starts an instance of a search service. - -## SYNTAX - -``` -Start-SPEnterpriseSearchServiceInstance [-Identity] <SearchServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet starts an instance of a search service on a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -If you run this cmdlet on a running search service instance, the associated search components are also restarted. -This may lead to a short downtime for queries. - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceInstance -Local | Start-SPEnterpriseSearchServiceInstance -``` - -This example starts the local search service instance. - - -## PARAMETERS - -### -Identity -Specifies the search service instance to start. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPInfoPathFormTemplate.md deleted file mode 100644 index 5c22fdfac7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Start-SPInfoPathFormTemplate - -## SYNOPSIS -Activates a previously quiesced InfoPath form template. - -## SYNTAX - -``` -Start-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Start-SPInfoPathFormTemplate` cmdlet activates a previously quiesced InfoPath form template after the form is upgraded. -During update, a form is quiesced, which disables access to the form. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Start-SPInfoPathFormTemplate -Identity formName.xsn -``` - -This example activates a form with a specified name. - - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to start. - -The type must be a valid URL, in the form http://server_name; a valid name of a Web application (for example, WebApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPWebServiceProxy object. - - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPProjectGenerateWsdl.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPProjectGenerateWsdl.md deleted file mode 100644 index c520bf926a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPProjectGenerateWsdl.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: Project Server 2016, Project Server 2019 -title: Start-SPProjectGenerateWsdl -schema: 2.0.0 ---- - -# Start-SPProjectGenerateWsdl - -## SYNOPSIS -Generates ASPX pages from WSDL files. - -## SYNTAX - -``` -Start-SPProjectGenerateWsdl [-AssignmentCollection <SPAssignmentCollection>] [-Path <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -Generates ASPX pages from WSDL files. - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Start-SPProjectGenerateWsdl -``` -Generates ASPX files in C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\PSI from the pre-existing WSDL files. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -The path to the location containing the WSDL files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPService.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPService.md deleted file mode 100644 index 00342c4d90..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPService.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPService -schema: 2.0.0 ---- - -# Start-SPService - -## SYNOPSIS -Enables a service in the farm. - - -## SYNTAX - -``` -Start-SPService [-Identity] <SPServicePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-IncludeCustomServerRole] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Start-SPService cmdlet enables a service in the farm. Service instances for this service will be started on the appropriate servers in the farm. - -This cmdlet only controls service instances on servers that are managed by MinRole. The behavior for the Custom server role has changed with the November 2016 Public Update (PU). Please see the IncludeCustomServerRole parameter for additional information. - - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Start-SPService -Identity "Microsoft SharePoint Foundation Sandboxed Code Service" -``` - -This example enables the Microsoft SharePoint Foundation Sandboxed Code Service in the farm. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of the service to enable. - -```yaml -Type: SPServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeCustomServerRole -Creates a timer job that also starts service instances on servers that are assigned to the custom server role. - -This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServicePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPServiceInstance.md deleted file mode 100644 index f35b16f0ab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPServiceInstance.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPServiceInstance -schema: 2.0.0 ---- - -# Start-SPServiceInstance - -## SYNOPSIS -Starts the service instance for a service on a specific server or the farm. - - -## SYNTAX - -``` -Start-SPServiceInstance [-Identity] <SPServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Start-SPServiceInstance` cmdlet to start the service instance for a service on a specific server or on the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Start-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce -``` - -This example starts the given service instance on the server. - -The service instance GUID is unique to every farm. -You can run the `Get-SPServiceInstance` cmdlet to see the GUID of the service instances and then use the result from the SPServiceInstance cmdlet for other cmdlets. - - -## PARAMETERS - -### -Identity -Specifies the GUID of the service instance to get. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPTimerJob.md b/sharepoint/sharepoint-ps/sharepoint-server/Start-SPTimerJob.md deleted file mode 100644 index 0bdb968a02..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Start-SPTimerJob.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Start-SPTimerJob -schema: 2.0.0 ---- - -# Start-SPTimerJob - -## SYNOPSIS -Runs a timer job once. - - -## SYNTAX - -``` -Start-SPTimerJob [-Identity] <SPTimerJobPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Start-SPTimerJob` cmdlet runs a timer job once on each front-end Web server where the parent service is provisioned. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------------EXAMPLE---------------- -``` -PS C:\>Get-SPTimerJob job-recycle-bin-cleanup | Start-SPTimerJob -``` - -This example starts the timer job named, job-recycle-bin-cleanup. - -## PARAMETERS - -### -Identity -Specifies the timer job to run. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. - -```yaml -Type: SPTimerJobPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPAssignment.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPAssignment.md deleted file mode 100644 index 68eef8ae68..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPAssignment.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPAssignment -schema: 2.0.0 ---- - -# Stop-SPAssignment - -## SYNOPSIS -Disposes of objects in the provided assignment collection. - - -## SYNTAX - -``` -Stop-SPAssignment [[-SemiGlobal] <SPAssignmentCollection>] [-AssignmentCollection <SPAssignmentCollection>] - [-Global] [<CommonParameters>] -``` - -## DESCRIPTION -The `Stop-SPAssignment` cmdlet disposes of objects in the provided assignment collection. -Use the Global parameter to dispose of all objects in the global assignment collector and to stop the global store from collecting additional objects. -Provide a SemiGlobal assignment collector to dispose of all contained objects. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Start-SPAssignment -global -PS C:\>$w = Get-SPWeb http://MyWeb -PS C:\>$w | Set-SPWeb -title "Accounting" -PS C:\>Stop-SPAssignment -global -``` - -This example uses simple assignment. -While easier to use simple assignment, running commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled is not recommended. -Ensure that `Stop-SPAssignment` is run before attempting any iterations of multiple objects. - - -## PARAMETERS - -### -SemiGlobal -Provides the assignment collector from which to dispose of objects. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Global -Stops the global assignment collector from storing objects and disposes of any objects contained by the global assignment collector. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPContentTypeReplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPContentTypeReplication.md deleted file mode 100644 index 0c47e021d2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPContentTypeReplication.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SSharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPContentTypeReplication -schema: 2.0.0 ---- - -# Stop-SPContentTypeReplication - -## SYNOPSIS -Stops Content Type replication job to SharePoint Online. - -## SYNTAX - -``` -Stop-SPContentTypeReplication [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Stops Content Type replication job to SharePoint Online and deletes the replication timer job. - -## EXAMPLES - -### -----------------EXAMPLE---------------- -``` -PS C:\>Stop-SPContentTypeReplication -``` -Stops Content Type replication job to SharePoint Online. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -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 - -### Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPDiagnosticsSession.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPDiagnosticsSession.md deleted file mode 100644 index efb1e21fec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPDiagnosticsSession.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPDiagnosticsSession -schema: 2.0.0 ---- - -# Stop-SPDiagnosticsSession - -## SYNOPSIS -Stops a diagnostic session. - - -## SYNTAX - -``` -Stop-SPDiagnosticsSession [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Stop-SPDiagnosticsSession` cmdlet to stop a diagnostic session. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE--------- -``` -PS C:\>Stop-SPDiagnosticsSession -``` - -This example stops a diagnostic session. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Start-SPDiagnosticsSession](Start-SPDiagnosticsSession.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPDistributedCacheServiceInstance.md deleted file mode 100644 index 8ddb305772..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPDistributedCacheServiceInstance.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPDistributedCacheServiceInstance -schema: 2.0.0 ---- - -# Stop-SPDistributedCacheServiceInstance - -## SYNOPSIS -Stops an instance of the Distributed Cache service on a local server. - - -## SYNTAX - -``` -Stop-SPDistributedCacheServiceInstance [-Graceful] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Stop-SPDistributedCacheServiceInstance cmdlet to stop an instance of the Distributed Cache service on a local server. While a -Graceful switch does exist, this cmdlet is not capable of properly transferring cached items to another Distributed Cache host within the farm. Follow the guidance available at [Manage the Distributed Cache service in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/jj219613.aspx) to properly issue a graceful shutdown of the Distributed Cache service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### ------------ Example 1 ---------- -``` -PS C:\> -``` -Please see referenced article instead of using this cmdlet directly. - -## PARAMETERS - -### -Graceful -Specifies whether to gracefully stop an instance of the Distributed Cache service. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPDistributedCacheServiceInstanceOnLocalServer](Remove-SPDistributedCacheServiceInstanceOnLocalServer.md) - -[Add-SPDistributedCacheServiceInstanceOnLocalServer](Add-SPDistributedCacheServiceInstanceOnLocalServer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md deleted file mode 100644 index b93f054765..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -schema: 2.0.0 ---- - -# Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance - -## SYNOPSIS -Stops an instance of a search manager service. - -## SYNTAX - -``` -Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance - [-Identity] <SearchQueryAndSiteSettingsServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance` cmdlet stops an instance of a search manager service. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$qssInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local -PS C:\>Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstance -``` - -This example stops the local query and site settings service instance. - - -## PARAMETERS - -### -Identity -Specifies the search manager service instance to stop. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid SPServer name, or the name of a search manager service instance (for example, SearchManagerServiceInstance1); or an instance of a valid SearchManagerServiceInstance object. - -```yaml -Type: SearchQueryAndSiteSettingsServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPEnterpriseSearchServiceInstance.md deleted file mode 100644 index e8babdd2a2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPEnterpriseSearchServiceInstance.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPEnterpriseSearchServiceInstance -schema: 2.0.0 ---- - -# Stop-SPEnterpriseSearchServiceInstance - -## SYNOPSIS -Stops an instance of a search service. - -## SYNTAX - -``` -Stop-SPEnterpriseSearchServiceInstance [-Identity] <SearchServiceInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet stops an instance of a search service. - -Before you can stop a search service instance, you must remove all search topology components on the associated server from the active topology. -This can be done in three ways: - -- Removing components from the search topology -- Moving components to another server. For more information, see . -- Removing the search service application. For more information, see `Remove-SPEnterpriseSearchServiceApplication` - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPEnterpriseSearchServiceInstance -Local | Stop-SPEnterpriseSearchServiceInstance -``` - -This example stops the local search service instance. - - -## PARAMETERS - -### -Identity -Specifies the shared search service instance to stop. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - -```yaml -Type: SearchServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPInfoPathFormTemplate.md deleted file mode 100644 index 190c252d92..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Stop-SPInfoPathFormTemplate - -## SYNOPSIS -Disables a InfoPath form template on a farm before an upgrade. - -## SYNTAX - -``` -Stop-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-TimeLeft <Int32>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Stop-SPInfoPathFormTemplate` cmdlet quiesces, or disables, an InfoPath form template before it upgrades the form. -Before a form is updated it is quiesced, which disables access to the form. -Use `Start-SPIPFormTemplate` to unquiesce, or activate, a form template after the form is upgraded. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Stop-SPInfoPathFormTemplate -Identity formName.xsn -``` - -This example disables a form template for a specified name. - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to start. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeLeft -Specifies the time duration, in minutes, before the form template will be quiesced. -The default value is 0. - -An integer value in the range from 0 to 1440. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPService.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPService.md deleted file mode 100644 index b6dd2b065e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPService.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPService -schema: 2.0.0 ---- - -# Stop-SPService - -## SYNOPSIS -Disables a service in the farm. - -## SYNTAX - -``` -Stop-SPService [-Identity] <SPServicePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-IncludeCustomServerRole] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The Stop-SPService cmdlet disables a service in the farm. Service instances for this service will be stopped on the appropriate servers in the farm. - -**Note**: This cmdlet only controls service instances on servers that are managed by MinRole. The behavior for the Custom server role has changed with the November 2016 Public Update (PU). Please see the **IncludeCustomServerRole** parameter for additional information. - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -Stop-SPService -Identity "Microsoft SharePoint Foundation Sandboxed Code Service" -``` - -This example disables the Microsoft SharePoint Foundation Sandboxed Code Service in the farm. - - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -**Note**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the name of the service to disable. - -```yaml -Type: SPServicePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeCustomServerRole -Creates a timer job that also stops service instances on servers that are assigned to the custom server role. -**Note**: This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServicePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPServiceInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPServiceInstance.md deleted file mode 100644 index 2e6d05c403..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPServiceInstance.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPServiceInstance -schema: 2.0.0 ---- - -# Stop-SPServiceInstance - -## SYNOPSIS -Stops the service instance for a service. - - -## SYNTAX - -``` -Stop-SPServiceInstance [-Identity] <SPServiceInstancePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Stops the service instance for a service on the specified server or for the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Stop-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce -``` - -This example stops the service instance in the given server. - -The service instance GUID is unique to every farm. -You can run the `Get-SPServiceInstance` cmdlet to see the GUID of the service instances and then use the result from the SPServiceInstance cmdlet for other cmdlets. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service instance to get. - -```yaml -Type: SPServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPTaxonomyReplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPTaxonomyReplication.md deleted file mode 100644 index 318058741b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Stop-SPTaxonomyReplication.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Stop-SPTaxonomyReplication -schema: 2.0.0 ---- - -# Stop-SPTaxonomyReplication - -## SYNOPSIS -Terminates Hybrid SharePoint Taxonomy replication from SharePoint Online site to local SharePoint on-premises site. - -## SYNTAX - -``` -Stop-SPTaxonomyReplication [-AssignmentCollection <SPAssignmentCollection>] -Credential <PSCredential> - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Stop-SPTaxonomyReplication cmdlet to terminate Hybrid SharePoint Taxonomy replication from SharePoint Online site to local SharePoint on-premises site. The Taxonomy Groups Replication timer job will be killed and a full replication from SharePoint Online Taxonomy store to local SharePoint on-premises store will be performed. - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Stop-SPTaxonomyReplication -Credential (Get-Credential) -``` - -This example performs a full replication and deletes the Taxonomy Groups Replication timer job. If the full replication fails, you can run the cmdlet again. The credential is a SharePoint Online tenant administrator credential. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Credential -This is the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store. - -Fetches full taxonomy data properties, so a Term Store Administrator's credential is needed to perform the operations. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSCredential -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Suspend-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Suspend-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index da82ad0aa0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Suspend-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Suspend-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Suspend-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Suspends a search service application, pausing all crawls and search operations, to perform a task such as system maintenance. - -## SYNTAX - -``` -Suspend-SPEnterpriseSearchServiceApplication [-Identity] <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet reads the SearchServiceApplication object and moves it from Paused for: External Request status to Suspend status. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA -PS C:\>$ssa | Suspend-SPEnterpriseSearchServiceApplication -``` - -This example obtains a reference to a search service application named MySSA and pauses it, stopping all crawls and other search components such as content processing components, analytics processing components and indexing components. - -## PARAMETERS - -### -Identity -Specifies the search service application to suspend. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Suspend-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Suspend-SPStateServiceDatabase.md deleted file mode 100644 index 87001bbb38..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Suspend-SPStateServiceDatabase.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Office.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Suspend-SPStateServiceDatabase -schema: 2.0.0 ---- - -# Suspend-SPStateServiceDatabase - -## SYNOPSIS -Pauses a state database and thus prevents new rows of data from being added to a database. - -## SYNTAX - -``` -Suspend-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Suspend-SPStateServiceDatabase` cmdlet pauses a state database. -This cmdlet updates the state database object that is specified in the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>$db = Get-SPStateServiceDatabase -PS C:\>Suspend-SPStateServiceDatabase -Identity $db -``` - -This example suspends a specified state service database. - -## PARAMETERS - -### -Identity -Specifies the state database to pause. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. - -```yaml -Type: SPStateDatabasePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Sync-SPProjectPermissions.md b/sharepoint/sharepoint-ps/sharepoint-server/Sync-SPProjectPermissions.md deleted file mode 100644 index 83dbda8ae0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Sync-SPProjectPermissions.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Sync-SPProjectPermissions -schema: 2.0.0 ---- - -# Sync-SPProjectPermissions - -## SYNOPSIS -Manually synchronizes permissions between a Project Web App instance and its associated project sites. - -## SYNTAX - -### PSMode -``` -Sync-SPProjectPermissions [-Url] <Uri> [-SyncPWASite] [-SyncProjectSites] [-Async] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -### SPMode -``` -Sync-SPProjectPermissions [-Url] <Uri> [[-Type] <SharePointPermissionModeSyncType>] - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Sync-SPProjectPermissions` cmdlet causes permissions to be synchronized to the project sites associated with projects in a Project Web App instance and the permissions set on those projects in Project Server. - -This cmdlet works with both SharePoint permission mode and Project Server permission mode. - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Sync-SPProjectPermissions -Url http://pwa_site -Type Full -``` - -Performs a full sync against the PWA site http://pwa_site. - -## PARAMETERS - -### -Url -Specifies the URL of the Project Web App instance for which you want to synch permissions. - -The type must be a valid URL, in the form http://pwa_site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncPWASite -Triggers a synchronization of Project Server permissions to the PWA site. - -This parameter is used with Project Server permission mode. - -```yaml -Type: SwitchParameter -Parameter Sets: PSMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of sync to perform: full or incremental. - -This parameter is used with SharePoint permission mode. - -Valid values are: - -Full, Incremental, AllGroups - -```yaml -Type: SharePointPermissionModeSyncType -Parameter Sets: SPMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncProjectSites -Triggers a synchronization of Project Server permissions to the project sites. - -This parameter is used with Project Server permission mode. - -```yaml -Type: SwitchParameter -Parameter Sets: PSMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Async -Specifies that the synchronization is placed in the Project Server queue. -Omitting this flag causes the synchronization to occur immediately within the Windows PowerShell console. - -This parameter is used with Project Server permission mode. - -```yaml -Type: SwitchParameter -Parameter Sets: PSMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Test-SPContentDatabase.md deleted file mode 100644 index e4c0b72d55..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPContentDatabase.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Test-SPContentDatabase -schema: 2.0.0 ---- - -# Test-SPContentDatabase - -## SYNOPSIS -Tests a content database. - - -## SYNTAX - -### ContentDatabaseById -``` -Test-SPContentDatabase [-Identity] <SPContentDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-DatabaseCredentials <PSCredential>] [-ExtendedCheck] [-ServerInstance <SPDatabaseServiceInstancePipeBind>] - [-ShowLocation] [-ShowRowCounts] [<CommonParameters>] -``` - -### ContentDatabaseByName -``` -Test-SPContentDatabase -Name <String> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-DatabaseCredentials <PSCredential>] [-ExtendedCheck] - [-ServerInstance <SPDatabaseServiceInstancePipeBind>] [-ShowLocation] [-ShowRowCounts] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Test-SPContentDatabase` cmdlet to test a content database against a Web application to verify all customizations referenced within the content database are also installed in the web application. -This cmdlet can be issued against a content database currently attached to the farm, or a content database that is not connected to the farm. -It can be used to test content databases from SharePoint 2010 Products and from SharePoint Products and Technologies. - -The `Test-SPContentDatabase` cmdlet does not change any of the data or structure of the content database, but can cause load on the database while the checks are in progress, which could temporarily block use of the content database. -This cmdlet should only be used against a content database that is currently under low or no usage. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------------------EXAMPLE 1----------------------- -``` -PS C:\>Test-SPContentDatabase -name WSS_Content_DB -webapplication http://sitename -``` - -This example tests the WSS_Content_DB content database against the sitename Web application and returns a list of issues. - - -### ----------------------------EXAMPLE 2----------------------- -``` -PS C:\>$DB = Get-SPContentDatabase -site http://contoso.com -PS C:\>Test-SPContentDatabase $DB -showrowcounts -``` - -This example gets the content database that contains the site collection at http://contoso.com and then tests the database against the Web application that hosts it to determine issues. -Together with displaying the list of issues, by specifying the ShowRowCounts parameter, this also returns the table size metrics from the content database. - -## PARAMETERS - -### -Identity -Specifies an existing connected SharePoint content database to one of the two parameter sets in the form of a GUID or database name if it is unique. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: ContentDatabaseById -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the existing content database to test. - -The type must be a valid name of a SharePoint content database; for example, SPContentDB1. - -```yaml -Type: String -Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the SharePoint Web application to use to test the content database. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DatabaseCredentials -Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. - -The type must be a valid PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedCheck -Checks for inconsistent authentication modes during database-attach upgrade process. - -The selected mode, claims or classic, must be the same in both versions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerInstance -Specifies the instance of the database service to use to test the specified content database. - -The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SQL Server instance (for example, DBSvrInstance1); or an instance of a valid SPDatabaseServiceInstance object. - -```yaml -Type: SPDatabaseServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowLocation -Specifies the locations where missing templates and features are being used within the database. -Typically, reported locations are scoped within the site collections that are within the specified content database. - -The use of the parameter significantly increases the time to complete the test procedure. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowRowCounts -Returns database statistics which are row counts for tables in the content database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Test-SPInfoPathFormTemplate.md deleted file mode 100644 index b94ed61106..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Test-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Test-SPInfoPathFormTemplate - -## SYNOPSIS -Validates that a InfoPath form template is browser-enabled. - -## SYNTAX - -``` -Test-SPInfoPathFormTemplate [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Test-SPInfoPathFormTemplate` cmdlet validates that an InfoPath form template can be browser-enabled. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Test-SPInfoPathFormTemplate -Identity formName.xsn -``` - -This example validates an InfoPath form template for a specified name. - -## PARAMETERS - -### -Path -Specifies the path and name of the InfoPath form template to install. - -The type must be a valid path and file name of a form template, in the form: - -- C:\folder_name\formtemplate_name -- \\\\server_name\folder_name\formtemplate_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPO365LinkSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Test-SPO365LinkSettings.md deleted file mode 100644 index af8d46f350..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPO365LinkSettings.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Test-SPO365LinkSettings -schema: 2.0.0 ---- - -# Test-SPO365LinkSettings - -## SYNOPSIS -Validates whether the configured Office 365 hybrid site uses a valid template. - -## SYNTAX - -``` -Test-SPO365LinkSettings [-AssignmentCollection <SPAssignmentCollection>] -MySiteHostUrl <Uri> - [<CommonParameters>] -``` - -## DESCRIPTION -Use the **Test-SPO365LinkSettings** cmdlet to validate a templated against a configured Office 365 hybrid site. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Test-SPO365LinkSettings -MySiteHostUrl https://contoso-my.sharepoint.com/ -``` - -This example test a template using the contoso-my.sharepoint site. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` -### -MySiteHostUrl -The root URL for the redirected pages - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS -[Get-SPO365LinkSettings](Get-SPO365LinkSettings.md) - -[Set-SPO365LinkSettings](Set-SPO365LinkSettings.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPProjectServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Test-SPProjectServiceApplication.md deleted file mode 100644 index 0c103a3931..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPProjectServiceApplication.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Test-SPProjectServiceApplication -schema: 2.0.0 ---- - -# Test-SPProjectServiceApplication - -## SYNOPSIS -This cmdlet runs a series of health checks against the Project Service Application. - -## SYNTAX - -``` -Test-SPProjectServiceApplication [-Identity] <PsiServiceApplicationPipeBind> - [[-Rule] <ProjectServiceApplicationHealthRuleName>] [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet runs a series of health checks against the Project Service Application. - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} -PS C:\>Test-SPProjectServiceApplication -Identity $sa -``` - -This example runs all health checks again the service application named "Project Service Application." - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identity -The name of the Project Service Application to test against. - -```yaml -Type: PsiServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Rule -Which rule to run against the service application. - -Valid rules are: - -All, CalcServiceWorkerState, QueueInFlightJobs, QueueServiceInternalState - -Project Server 2013 has this additional rule which is not available in Project Server 2016, Project Server 2019: - -QueueSiteCheck - -Project Server 2016, Project Server 2019 added this additional rule: - -DatabasePermissions - -```yaml -Type: ProjectServiceApplicationHealthRuleName -Parameter Sets: (All) -Aliases: -Accepted values: All, QueueServiceInternalState, QueueInFlightJobs, CalcServiceWorkerState, DatabasePermissions -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Office.Project.Server.Cmdlet.PsiServiceApplicationPipeBind -Microsoft.Office.Project.Server.HealthRules.ProjectServiceApplicationHealthRuleName -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Test-SPProjectWebInstance.md deleted file mode 100644 index 2260c6c03b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPProjectWebInstance.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml -applicable: Project Server 2013, Project Server 2016, Project Server 2019 -title: Test-SPProjectWebInstance -schema: 2.0.0 ---- - -# Test-SPProjectWebInstance - -## SYNOPSIS -Runs a suite of tests on an existing Project Web Instance. - -## SYNTAX - -``` -Test-SPProjectWebInstance [-Identity] <ProjectInstancePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Rule <ProjectSiteHealthRuleName>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet runs a suite of tests on an existing Project Web Instance. -The tests are designed to verify the health status of the Project Web Instance. -The cmdlet returns the set of tests as a list of Microsoft.Office.Project.Server.HealthRules objects associated with a status of type SPSiteHealthStatusType (Passed, FailedWarning, FailedError). - -For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- -``` -PS C:\>Get-SPProjectWebInstance | Test-SPProjectWebInstance -``` - -This example runs a suite of tests on all Project Web Instances in the SharePoint Server farm. - -## PARAMETERS - -### -Identity -Specifies a Project Web Instance. - -```yaml -Type: ProjectInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Rule -{{Fill Rule Description}} - -```yaml -Type: ProjectSiteHealthRuleName -Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Mount-SPProjectWebInstance](Mount-SPProjectWebInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Test-SPSite.md deleted file mode 100644 index f711049166..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Test-SPSite.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Test-SPSite -schema: 2.0.0 ---- - -# Test-SPSite - -## SYNOPSIS -Activates the RunTests method against a referenced SPSite object. - - -## SYNTAX - -``` -Test-SPSite [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-RuleId <Guid>] - [-RunAlways] [<CommonParameters>] -``` - -## DESCRIPTION -The `Test-SPSite` cmdlet runs one or all site collection health checks on the site collection and its contents. -This cmdlet reports the rules which were run and provides a summary of the results. - -To run tests in repair mode, use the `Repair-SPSite` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1------------ -``` -PS C:\>Test-SPSite http://<site name>/sites/testsite -``` - -This example runs all the site collection health checks on the http://\<site name\>/sites/testsite site collection. - -### --------------EXAMPLE 2------------ -``` -PS C:\>Test-SPSite http://<site name</sites/testsite -Rule "ee967197-ccbe-4c00-88e4-e6fab81145e1" -``` - -This example runs just the "Missing Galleries Check" on the http://\<site name\>/sites/testsite site collection. - -## PARAMETERS - -### -Identity -Specifies the URL or GUID of the site to run a test. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RuleId -Specifies one specific site health rule to run. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunAlways -Forces a rule to run even if a health check was run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Repair-SPSite](Repair-SPSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-FASTSearchAdminDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-FASTSearchAdminDatabase.md deleted file mode 100644 index ac152b815e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-FASTSearchAdminDatabase.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: FAST Server for SharePoint 2010 -schema: 2.0.0 -title: Uninstall-FASTSearchAdminDatabase ---- - -# Uninstall-FASTSearchAdminDatabase - -## SYNOPSIS -Uninstalls the database used by the Microsoft FAST Search Server 2010 for SharePoint administration services. -This cmdlet is primarily called during uninstallation by the FAST Search Server 2010 for SharePoint installer. - -## SYNTAX - -``` -Uninstall-FASTSearchAdminDatabase [-DbConnection <String>] [-DbName <String>] [-DbServer <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet uninstalls the database used by the FAST Search Server 2010 for SharePoint administration services. -All data is deleted. -This cmdlet is primarily called during uninstallation, by the FAST Search Server 2010 for SharePoint installer. - -The administration database default name is "FASTSearchAdminDatabase" and is located in the Microsoft SQL Server instance specified by the DbServer or DbConnection parameters. - -For permissions and the most current information about FAST Search Server 2010 for SharePoint cmdlets, see the online documentation, (https://go.microsoft.com/fwlink/?LinkId=163227). - -## EXAMPLES - -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) -``` -PS C:\>Uninstall-FASTSearchAdminDatabase -DbServer=sqlserver.contoso.com -``` - -This example uninstalls the FAST Search Server 2010 for SharePoint administration database on the given SQL Server instance. -All data will be deleted. - -## PARAMETERS - -### -DbConnection -Specifies the database connection string for the FAST Search Server 2010 for SharePoint administration database, in the same format as the ConnectionString property of the System.Data.SqlClient.SqlConnection .NET Framework type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DbName -Specifies the name of the FAST Search Server 2010 for SharePoint administration database. - -The name only takes effect when used in conjunction with the DbServer parameter, not the DbConnection parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DbServer -Specifies the database server instance that contains the FAST Search Server 2010 for SharePoint administration database - -Only one of the DbServer and DbConnection parameters must be specified. -Using DbServer with a value of sqlserver.contoso.com is equivalent to using DbConnection with the value "Data Source=sqlserver.contoso.com;Database=FASTSearchAdminDatabase;integrated Security=True"" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Install-FASTSearchAdminDatabase](Install-FASTSearchAdminDatabase.md) - diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPAppInstance.md deleted file mode 100644 index 28091a11a9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPAppInstance.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPAppInstance -schema: 2.0.0 ---- - -# Uninstall-SPAppInstance - -## SYNOPSIS -Uninstalls an instance of an app. - - -## SYNTAX - -``` -Uninstall-SPAppInstance -Identity <SPAppInstance> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Uninstall-SPAppInstance` cmdlet to uninstall an instance of an app. -This cmdlet is required to be run before a migration process. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE-------------- -``` -PS C:\>$spapp = Get-SPAppInstance -AppInstanceId $instance.Id -PS C:\>Uninstall-SPAppInstance -Identity $spapp -``` - -This example uninstalls an instance of an app. - - -## PARAMETERS - -### -Identity -Specifies the app instance for which to find metadata. - -```yaml -Type: SPAppInstance -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppInstance](Get-SPAppInstance.md) - -[Restart-SPAppInstanceJobs](Restart-SPAppInstanceJobs.md) - -[Uninstall-SPAppInstance](Uninstall-SPAppInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPDataConnectionFile.md deleted file mode 100644 index 9b7d988a74..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPDataConnectionFile.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPDataConnectionFile -schema: 2.0.0 ---- - -# Uninstall-SPDataConnectionFile - -## SYNOPSIS -Removes a data connection file. - -## SYNTAX - -``` -Uninstall-SPDataConnectionFile [-Identity] <SPDataConnectionFilePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Uninstall-SPDataConnectionFile` cmdlet removes the data connection file specified in the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Uninstall-SPDataConnectionFile -Identity "Sample.udcx -PS C:\>"Sample1.udcx", "Sample2.udcx", "Sample3.udcx" | Uninstall-SPDataConnectionFile -``` - -This example uninstalls a specified data connection file in two different ways. - -## PARAMETERS - -### -Identity -Specifies the data connection file to remove. - -The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. - -```yaml -Type: SPDataConnectionFilePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPFeature.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPFeature.md deleted file mode 100644 index 938caa31ac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPFeature.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPFeature -schema: 2.0.0 ---- - -# Uninstall-SPFeature - -## SYNOPSIS -Uninstalls an installed feature definition. - - -## SYNTAX - -``` -Uninstall-SPFeature [-Identity] <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-CompatibilityLevel <Int32>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Uninstall-SPFeature` cmdlet removes the specified feature definition from the collection of feature definitions in the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1----------------------- -``` -PS C:\>Uninstall-SPFeature -path "MyCustomFeature" -``` - -This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. - -### ------------------EXAMPLE 2----------------------- -``` -PS C:\>Uninstall-SPFeature -path "MyCustomFeature" -CompatibilityLevel 14 -``` - -This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. - -## PARAMETERS - -### -Identity -Specifies the name of the feature or GUID to uninstall. - -The type must be the name of the feature folder located in the \<drive\>:\program files\common files\Microsoft Shared\Web server extensions\15\template\features folder, or must be a GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. - -```yaml -Type: SPFeatureDefinitionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies the version of feature to uninstall. -When the version is not specified it will default to the web applications MaxVersion value. - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the uninstallation of a feature that is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPHelpCollection.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPHelpCollection.md deleted file mode 100644 index 7382c1012d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPHelpCollection.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPHelpCollection -schema: 2.0.0 ---- - -# Uninstall-SPHelpCollection - -## SYNOPSIS -Removes Help collection files. - - -## SYNTAX - -``` -Uninstall-SPHelpCollection -Name <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Uninstall-SPHelpCollection` cmdlet removes the specified Help collection files from the product Help library in the current farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Uninstall-SPHelpCollection -Name "OSSAdmin.1033" -``` - -This example uninstalls a Help collection. -The folder name of the Help collection to uninstall is OSSAdmin.1033. - -## PARAMETERS - -### -Name -Specifies the name of the Help collection files to uninstall. - -The type must be a valid name of a Help collection; for example, HelpDocs1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPInfoPathFormTemplate.md deleted file mode 100644 index 99d529da98..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Uninstall-SPInfoPathFormTemplate - -## SYNOPSIS -Removes a InfoPath form template from a farm. - -## SYNTAX - -``` -Uninstall-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Uninstall-SPInfoPathFormTemplate` cmdlet removes a specified InfoPath form template from a farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Uninstall-SPInfoPathFormTemplate -Identity formName.xsn -``` - -This example removes an InfoPath form template from a farm. - - -## PARAMETERS - -### -Identity -Specifies the InfoPath form template to uninstall. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. - -```yaml -Type: SPFormTemplatePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPSolution.md deleted file mode 100644 index 468d726d27..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPSolution.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPSolution -schema: 2.0.0 ---- - -# Uninstall-SPSolution - -## SYNOPSIS -Retracts a deployed SharePoint solution. - - -## SYNTAX - -### AllWebApplication -``` -Uninstall-SPSolution [-Identity] <SPSolutionPipeBind> [-AllWebApplications] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-CompatibilityLevel <String>] - [-Language <UInt32>] [-Local] [-Time <String>] [-WhatIf] [<CommonParameters>] -``` - -### OneWebApplication -``` -Uninstall-SPSolution [-Identity] <SPSolutionPipeBind> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-CompatibilityLevel <String>] - [-Language <UInt32>] [-Local] [-Time <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Uninstall-SPSolution` cmdlet retracts a deployed SharePoint solution in preparation for removing it from the farm entirely. -This cmdlet removes files from the front-end Web server. -Use the `Remove-SPSolution` cmdlet to delete the solution package from the solution store of the farm; be sure to use the `Remove-SPSolution` cmdlet only after you have run `Uninstall-SPSolution`. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Uninstall-SPSolution -Identity contoso_solution.wsp -``` - -This example retracts the deployed SharePoint solution contoso_solution.wsp. - -## PARAMETERS - -### -Identity -Specifies the SharePoint solution to uninstall. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. - -```yaml -Type: SPSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllWebApplications -Specifies that the new SharePoint solution will be uninstalled for all SharePoint Web applications in the farm. - -```yaml -Type: SwitchParameter -Parameter Sets: AllWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Uninstalls the SharePoint solution for the specified SharePoint Web application. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: OneWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -Specifies whether to uninstall the solution, from a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to uninstall the solution only from the version directory based on the version tracked in the manifest of the solution's cab file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Uninstalls the language pack for the specified language. - -The type must be a valid language identifier; for example, 1033. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -Uninstalls the solution from the active server computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -Specifies when the solution will be uninstalled. -The default value is immediate retraction. - -The type must be a valid DateTime value, in the form 2010,12,05. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPUserSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPUserSolution.md deleted file mode 100644 index 47ef63373e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPUserSolution.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPUserSolution -schema: 2.0.0 ---- - -# Uninstall-SPUserSolution - -## SYNOPSIS -Deactivates a sandboxed solution in a site collection. - - -## SYNTAX - -``` -Uninstall-SPUserSolution [-Identity] <SPUserSolutionPipeBind> -Site <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Uninstall-SPUserSolution` cmdlet deactivates a sandboxed solution in a site collection so that you can delete it by using the `Remove-SPUserSolution` cmdlet. -A user solution is a sandboxed solution. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE--------------- -``` -PS C:\>Uninstall-SPUserSolution -Identity contoso_solution.wsp -Site http://sitename -``` - -This example deactivates the sandboxed solution contoso_solution.wsp on the site http://sitename. - -## PARAMETERS - -### -Identity -Specifies the sandboxed solution to deactivate. - -The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. - -```yaml -Type: SPUserSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Deactivates the sandboxed solution for the specified site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPWebPartPack.md b/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPWebPartPack.md deleted file mode 100644 index a684f92557..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Uninstall-SPWebPartPack.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Uninstall-SPWebPartPack -schema: 2.0.0 ---- - -# Uninstall-SPWebPartPack - -## SYNOPSIS -Uninstalls the specified Web Part package. - - -## SYNTAX - -``` -Uninstall-SPWebPartPack [-Identity] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Language <UInt32>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf] [-CompatibilityLevel <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Uninstall-SPWebPartPack` cmdlet uninstalls the Web Part package specified by the Identity parameter. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ -``` -PS C:\>Uninstall-SPWebPartPack "mypart.wpp" -WebApplication http://portal -``` - -This example uninstalls mypart.wpp to from the Web application http://portal. - -### ------------------EXAMPLE 2------------------ -``` -PS C:\>Get-SPWebPartPack -WebApplication http://portal | Uninstall-SPWebPartPack -``` - -This example uninstalls all Web part packages from the Web application http://portal. - -## PARAMETERS - -### -Identity -Specifies the Web Part package in the farm's configuration database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Language -Specifies the language ID of the Web Part package to delete. -If no language is specified, the Web Part package is uninstalled for all languages. - -The type must be a valid language identifier, in the form 1033. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the Web application from which to uninstall the Web Part package. -If no Web application is specified, the Web Part package is uninstalled from all Web applications. - -The type must be a valid name, in the form WebApplication-1212, or a URL, in the form http://server_name/WebApplication-1212. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityLevel -{{Fill CompatibilityLevel Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Unpublish-SPServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Unpublish-SPServiceApplication.md deleted file mode 100644 index 5b2f7c5f52..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Unpublish-SPServiceApplication.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Unpublish-SPServiceApplication -schema: 2.0.0 ---- - -# Unpublish-SPServiceApplication - -## SYNOPSIS -Stops sharing the specified service application outside the farm. - - -## SYNTAX - -``` -Unpublish-SPServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Unpublish-SPServiceApplication` cmdlet to stop publishing the service application, specified by the Identity parameter, outside the farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>UnPublish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -``` - -This example stops publishing of the specified service application outside the farm. - -The service application GUID is unique to every farm. -You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, `Publish-SPServiceApplication`. - -## PARAMETERS - -### -Identity -Specifies the GUID of the service application to stop sharing outside the farm. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPAppCatalogConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPAppCatalogConfiguration.md deleted file mode 100644 index 64540bede6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPAppCatalogConfiguration.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPAppCatalogConfiguration -schema: 2.0.0 ---- - -# Update-SPAppCatalogConfiguration - -## SYNOPSIS -Sets a specific site collection as the App Catalog site collection. - -## SYNTAX - -``` -Update-SPAppCatalogConfiguration [-Site] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Force] [-SkipWebTemplateChecking] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Update-SPAppCatalogConfiguration cmdlet to set a specific site collection as the App Catalog site collection. The App Catalog site collection contains catalogs for Apps for SharePoint and Apps for Office. It is used to help ITPro administrators distribute SharePoint Apps and Office Apps to their end users. Each Web Application or Tenancy can have 1 App Catalog Site collection associated to it. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - -## EXAMPLES - -### ---------------EXAMPLE----------- -``` -PS C:\>Update-SPAppCatalogConfiguration -Site http://contoso/sites/appcatalog_1 -Force:$true -SkipWebTemplateChecking:$true -``` -This example sets http://contoso/sites/appcatalog_1 as the app catalog site collection for the tenant it belongs to. - -## PARAMETERS - -### -Site -Specifies the URL or GUID of the site collection to be set as the app catalog site collection. - - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies to force marking the site collection even if there are validation errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipWebTemplateChecking -Specifies whether to skip checking if the template of the site is APCATALOG#0. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPSitePipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPAppInstance.md deleted file mode 100644 index f95676a769..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPAppInstance.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPAppInstance -schema: 2.0.0 ---- - -# Update-SPAppInstance - -## SYNOPSIS -Updates the app instance. - - -## SYNTAX - -``` -Update-SPAppInstance -App <SPApp> -Identity <SPAppInstance> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Update-SPAppInstance` cmdlet to update the app instance. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - - -## EXAMPLES - -### --------EXAMPLE--------- -``` -PS C:\>$spapp = Import-SPAppPackage -Path .\feature-upgrade-v2.spapp -Site http://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) -C:\S>$instance = Get-SPAppInstance -AppInstanceId $instance.Id -PS C:\>Update-SPAppInstance -Identity $instance -App $spapp -``` - -This example updates an instance of an app. - - -## PARAMETERS - -### -App -Specifies the app version to upgrade to. - -```yaml -Type: SPApp -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies The app instance to upgrade. - -```yaml -Type: SPAppInstance -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPAppInstance](Get-SPAppInstance.md) - -[Restart-SPAppInstanceJobs](Restart-SPAppInstanceJobs.md) - -[Uninstall-SPAppInstance](Uninstall-SPAppInstance.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPDistributedCacheSize.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPDistributedCacheSize.md deleted file mode 100644 index f33f5781d5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPDistributedCacheSize.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPDistributedCacheSize -schema: 2.0.0 ---- - -# Update-SPDistributedCacheSize - -## SYNOPSIS -Reconfigures the allocation of memory that is dedicated to the Distributed Cache service. - -## SYNTAX - -``` -Update-SPDistributedCacheSize [-CacheSizeInMB] <UInt32> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Update-SPDistributedCacheSize cmdlet to allocate memory to the Distributed cache service. - -## EXAMPLES - -### -------------EXAMPLE---------- -``` -PS C:\>Update-SPDistributedCacheSize -CacheSizeInMB 2048 -``` - -Updates the Distributed Cache size to 2048MB. - - -## PARAMETERS - -### -CacheSizeInMB -Specifies the memory size in megabytes (MB) that you want to allocate to the Distributed Cache service. The default value is 5 percent of total system random access memory (RAM). This value should not be more than 40 percent of total system RAM with a maximum limit of 16 gigabytes (GB). - - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.UInt32 -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPFarmEncryptionKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPFarmEncryptionKey.md deleted file mode 100644 index 0d2ace0160..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPFarmEncryptionKey.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPFarmEncryptionKey -schema: 2.0.0 ---- - -# Update-SPFarmEncryptionKey - -## SYNOPSIS -Changes the value of the farm encryption key and using the new key, re-encrypts all the data. - - -## SYNTAX - -``` -Update-SPFarmEncryptionKey [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Resume] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPFarmEncryptionKey` cmdlet changes the farm encryption key to a new randomly generated value. -When the new key is used, all the data is re-encrypted. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE----------------------- -``` -PS C:\>Update-SPFarmEncryptionKey -confirm -``` - -This example changes the farm encryption key to a new value and re-encrypts all the data. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Resume -Resumes re-encryption of data with the new farm encryption key if a previous attempt failed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPHelp.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPHelp.md deleted file mode 100644 index 3a8e45a3c7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPHelp.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPHelp -schema: 2.0.0 ---- - -# Update-SPHelp - -## SYNOPSIS -Updates SharePoint cmdlet help. - - -## SYNTAX - -``` -Update-SPHelp [-AssignmentCollection <SPAssignmentCollection>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-SPHelp cmdlet checks the Windows Download Center for updates for the SharePoint Management Shell help files against the version of the help files on the local computer. If there updates available, the cmdlet will download and install these updates. By default, the cmdlet will allow checking for updates only once every 24 hours. To override this check, use the Force parameter. - -The computer that the cmdlet is being run on must have an internet connection. - -Note: This cmdlet currently does not update cmdlet help. - - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- -``` -PS C:\>Update-SPHelp -``` -Updates SharePoint cmdlet help. - -### --------------------EXAMPLE 2--------------------- -``` -PS C:\>Update-SPHelp -Force -``` - -This example over-rides the throttling logic and checks for updates to the help files even if a check was made in the last 24 hours. - -### --------------------EXAMPLE 3--------------------- -``` -PS C:\>Update-SPHelp -Verbose -``` - -This example checks for updates to the help files and provides detailed feedback for each step of the process. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Over-rides the throttling logic and checks for updates to the help files even if a check was made in the last 24 hours. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathAdminFileUrl.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathAdminFileUrl.md deleted file mode 100644 index ee96bbb381..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathAdminFileUrl.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPInfoPathAdminFileUrl -schema: 2.0.0 ---- - -# Update-SPInfoPathAdminFileUrl - -## SYNOPSIS -Updates InfoPath form templates (.xsn files) and universal data connections (.udcx files), including all .xsn files and .udcx files that were deployed by an administrator. - -## SYNTAX - -``` -Update-SPInfoPathAdminFileUrl -Find <Uri> -Replace <Uri> [-AssignmentCollection <SPAssignmentCollection>] - [-Confirm] [-Scan] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPInfoPathAdminFileUrl` cmdlet updates data connections in administrator-approved InfoPath form templates (.xsn files) and universal data connections (.udcx files). -This allows for InfoPath data connections that reference the current farm to be updated when content is migrated to a different farm URL. -This cmdlet cannot update any references to URLs that exist in form template business logic (code). -Typically, this cmdlet is used with the `Import-SPInfoPathAdministratorFiles` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPWebApplication http://contoso2010 | Update-SPInfoPathAdminFileUrl --find "http://contoso2007/" --replace "http://contoso2010/" -``` - -This example updates data connections in administrator-approved InfoPath form templates and universal data connection files. -Data connections that reference http://contoso 2007 are updated to reference http://contoso2010. - -## PARAMETERS - -### -Find -Specifies the URL to find. - -The type must be a valid URL, in the form http://previous_server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies the URL to find. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scan -Run the tool and log the actions that can be taken. -No content is changed as a result of the scan. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathFormTemplate.md deleted file mode 100644 index 81437f5cb0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathFormTemplate.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Office.InfoPath.Server.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPInfoPathFormTemplate -schema: 2.0.0 ---- - -# Update-SPInfoPathFormTemplate - -## SYNOPSIS -Upgrades all InfoPath form templates on the farm. - -## SYNTAX - -``` -Update-SPInfoPathFormTemplate [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPInfoPathFormTemplate` cmdlet upgrades all the InfoPath form templates on a farm that were deployed by an administrator. -Use this cmdlet after the farm is upgraded to a new version. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ---------------EXAMPLE-------------- -``` -PS C:\>Update-SPInfoPathFormTemplate -``` - -This example updates InfoPath form templates on the entire farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathUserFileUrl.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathUserFileUrl.md deleted file mode 100644 index 78a08b591c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPInfoPathUserFileUrl.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPInfoPathUserFileUrl -schema: 2.0.0 ---- - -# Update-SPInfoPathUserFileUrl - -## SYNOPSIS -Updates InfoPath form templates (.xsn files) and universal data connections (.udcx files). - - -## SYNTAX - -### ContentDB -``` -Update-SPInfoPathUserFileUrl [-ContentDatabase] <SPContentDatabasePipeBind> -Find <Uri> -Replace <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Scan] [-WhatIf] [<CommonParameters>] -``` - -### Site -``` -Update-SPInfoPathUserFileUrl [-Site] <SPSitePipeBind> -Find <Uri> -Replace <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Scan] [-WhatIf] [<CommonParameters>] -``` - -### WebApp -``` -Update-SPInfoPathUserFileUrl [-WebApplication] <SPWebApplicationPipeBind> -Find <Uri> -Replace <Uri> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-Scan] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see Cmdlet Parameter Sets (https://go.microsoft.com/fwlink/?LinkID=187810). - -The `Update-SPInfoPathAdminFileUrl` cmdlet updates data connections in InfoPath form templates (.xsn files) and universal data connections (.udcx files). -This allows for InfoPath data connections that reference the current farm to be updated when content is migrated to a different farm URL. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Get-SPWebApplication http://contoso2010 | Update-SPInfoPathUserFileUrl -Find "http://contoso2007/" -Replace "http://contoso2010/" -``` - -This example updates data connections in InfoPath form templates and universal data connection files, for all content under the Web application http://contoso2010. - -Data connections that reference http://contoso2007 are updated to reference http://contoso2010. - -## PARAMETERS - -### -ContentDatabase -Specifies the parent content database where the update will start. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content database (for example, SPContent DB1); or an instance of a valid SPContentDatabase object. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Specifies the parent site collection where the update will start. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://sites/example; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: Site -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the parent SharePoint Web application where the update will start. - -The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: WebApp -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Find -Specifies the URL to find. - -The type must be a valid URL, in the form http://previous_server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies the URL to find. - -The type must be a valid URL, in the form http://server_name. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scan -Run the tool and log the actions that can be taken. -No content is changed as a result of the scan. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPProfilePhotoStore.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPProfilePhotoStore.md deleted file mode 100644 index 947b7634b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPProfilePhotoStore.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPProfilePhotoStore -schema: 2.0.0 ---- - -# Update-SPProfilePhotoStore - -## SYNOPSIS -Updates the profile photo store to be compatible with SharePoint Server. - -## SYNTAX - -``` -Update-SPProfilePhotoStore -MySiteHostLocation <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-CreateThumbnailsForImportedPhotos <Boolean>] - [-NewBaseUri <Uri>] [-NoDelete <Boolean>] [-OldBaseUri <Uri>] [<CommonParameters>] -``` - -## DESCRIPTION -After upgrading from Office SharePoint Server to SharePoint Server, run the `Update-SPProfilePhotoStore` cmdlet to ensure that the SharePoint profile photo store is compatible with SharePoint Server. -The `Update-SPProfilePhotoStore` cmdlet should be used only after an upgrade from Office SharePoint Server has completed. -When the `Update-SPProfilePhotoStore` cmdlet is used, three thumbnail versions with predictable sizes and names are created from the original photo, the new photos are placed into the My Site Host's User Photos library, and the property value in the profile database is updated. - -During the operation, the original image is left as-is. -If the operation fails for certain users for any reason, it continues on to the next user. - -During the migration of profile photos from one server URL to another, one can use the OldBaseUri and NewBaseUri parameters. -You just need to specify the starting portion of the URL that has changed from old to new and an attempt to rebase the profile picture URLs will occur. - -For example, OldBaseUri: http://server1/my/ProfilePhotos; NewBaseUri: http://server1/my/NewLocation/ProfilePhotos - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------- -``` -PS C:\>Update-SPProfilePhotoStore -MySiteHostLocation http://mysites -``` - -This example uploads photos to a specified My Site host location. - -## PARAMETERS - -### -MySiteHostLocation -Specifies the URL for the My Site host location where the photos are to be uploaded. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CreateThumbnailsForImportedPhotos -Creates thumbnails for all the imported user profile pictures. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewBaseUri -Specifies the new URL for profile pictures. -For example, http://server2/. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDelete -When the value is set to true, imported user profile picture files will be preserverd after creating thumbnails for them. -> [!NOTE] -> This will only work when CreateThumbnailsForImportedPhotos is set to `$true` - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OldBaseUri -Specifies the old URL for profile pictures. -For example, http://server1/. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPRepopulateMicroblogFeedCache.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPRepopulateMicroblogFeedCache.md deleted file mode 100644 index 5939afd4a7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPRepopulateMicroblogFeedCache.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPRepopulateMicroblogFeedCache -schema: 2.0.0 ---- - -# Update-SPRepopulateMicroblogFeedCache - -## SYNOPSIS -Refreshes the microblog feed cache. - -## SYNTAX - -### (Default) -``` -Update-SPRepopulateMicroblogFeedCache [-AccountName <String>] - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [-SiteUrl <String>] [<CommonParameters>] -``` - -### Default -``` -Update-SPRepopulateMicroblogFeedCache [-AccountName <String>] - -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] - [-SiteUrl <String>] [<CommonParameters>] -``` - -### FollowableList -``` -Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] -SiteSubscription <SPSiteSubscriptionPipeBind> -ListId <Guid> - -ListRootFolderUrl <String> -SiteId <Guid> -WebId <Guid> [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Update-SPRepopulateMicroblogFeedCache` cmdlet to refresh the feeds of a given user. -It can be used in scenarios where the automatic refresh has failed or when reverting to an old version of a user's personal site. - -When you refresh the cache, the `Update-SPRepopulateMicroblogLMTCache` cmdlet should be run first and then the `Update-SPRepopulateMicroblogFeedCache` cmdlet second. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE 1------------ -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy $proxy -AccountName contoso\userName -``` - -This example refreshes the feeds for a specific user by using the AccountName parameter. - -### ------------EXAMPLE 2------------ -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy $proxy -AccountName contoso\userName -SiteSubscription 0C37852B-34D0-418e-91C6-2AC25AF4BE5B -``` - -This example refreshes the feeds for a specific user by using the AccountName parameter. - -## PARAMETERS - -### -AccountName -Specifies the user's account name for the User Profile Service application. - -```yaml -Type: String -Parameter Sets: (All), Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileServiceApplicationProxy -Specifies the User Profile Service application proxy to update. - -The type must be in one of the following forms: - ---A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ---A valid name of a service application proxy (for example, UserProfileSvcProxy1) ---An instance of a valid SPServiceApplicationProxy object - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteSubscription -Specifies the account under which this service should run. -This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All), Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SiteUrl -Specifies the Site's URL to repopulate the site feeds. If you don't specify this parameter, you must specify the AccountName parameter. If neither parameter is specified, an error message is displayed. - -```yaml -Type: String -Parameter Sets: (All), Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListId -The ListId of the FollowableList. - -```yaml -Type: Guid -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListRootFolderUrl -The RootFolderUrl of the FollowableList. - -```yaml -Type: String -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteId -The SiteId containing the FollowableList. - -```yaml -Type: Guid -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebId -The WebId containing the FollowableList. - -```yaml -Type: Guid -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Update-SPRepopulateMicroblogLMTCache](Update-SPRepopulateMicroblogLMTCache.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPRepopulateMicroblogLMTCache.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPRepopulateMicroblogLMTCache.md deleted file mode 100644 index c0d8095a40..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPRepopulateMicroblogLMTCache.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPRepopulateMicroblogLMTCache -schema: 2.0.0 ---- - -# Update-SPRepopulateMicroblogLMTCache - -## SYNOPSIS -Refreshes the cache. - -## SYNTAX - -``` -Update-SPRepopulateMicroblogLMTCache -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Update-SPRepopulateMicroblogLMTCache` cmdlet to refresh when the Feed Cache Repopulation Job timer job fails to work. -The `Update-SPRepopulateMicroblogLMTCache` cmdlet forcefully refreshes the last modified times of all the known persisted entities to FeedCache. - -When you refresh the cache, the `Update-SPRepopulateMicroblogLMTCache` cmdlet should be run first and then the `Update-SPRepopulateMicroblogFeedCache` cmdlet second. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------EXAMPLE----------- -``` -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} -PS C:\>Update-SPRepopulateMicroblogLMTCache -ProfileServiceApplicationProxy $proxy -``` - -This example refreshes the cache for the specified proxy. - -## PARAMETERS - -### -ProfileServiceApplicationProxy -Specifies the User Profile Service application proxy to update. - -The type must be in one of the following forms: - - ---A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh - ---A valid name of a service application proxy (for example, UserProfileSvcProxy1) - ---An instance of a valid SPServiceApplicationProxy object - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Update-SPRepopulateMicroblogFeedCache](Update-SPRepopulateMicroblogFeedCache.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreApplicationServerKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreApplicationServerKey.md deleted file mode 100644 index 70fada53ec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreApplicationServerKey.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPSecureStoreApplicationServerKey -schema: 2.0.0 ---- - -# Update-SPSecureStoreApplicationServerKey - -## SYNOPSIS -Synchronizes the key on a Microsoft SharePoint server with the Secure Store master key. - -## SYNTAX - -``` -Update-SPSecureStoreApplicationServerKey -Passphrase <String> - -ServiceApplicationProxy <SPServiceApplicationProxyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPSecureStoreApplicationServerKey` cmdlet synchronizes the key on a SharePoint server with the master key for the Secure Store service database. - -Updating a server key is required when: - ---A new SharePoint server that will run a Secure Store service instance is joined to the farm. ---The key stored in the server is not the key required for the current Secure Store service database (because of server or networking issues). ---The master key is updated but during propagation of the new key, this process fails on one or more of the servers. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$newPassPhrase = "abcDEF123!" -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'} -PS C:\>Update-SPSecureStoreApplicationServerKey -ServiceApplicationProxy $proxy -Passphrase $newPassPhrase -``` - -This example synchronizes the passphrase of the server key on a SharePoint server with the master key for the Secure Store service database. - -## PARAMETERS - -### -Passphrase -Specifies the passphrase that is used for the Secure Store service database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplicationProxy -Specifies the proxy of the service application that contains the server key to synchronize. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreCredentialMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreCredentialMapping.md deleted file mode 100644 index 382d514eac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreCredentialMapping.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPSecureStoreCredentialMapping -schema: 2.0.0 ---- - -# Update-SPSecureStoreCredentialMapping - -## SYNOPSIS -Sets a new credential mapping for a Secure Store Service application. - -## SYNTAX - -``` -Update-SPSecureStoreCredentialMapping -Identity <SPSecureStoreApplication> -Principal <SPClaim> - -Values <SecureString[]> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPSecureStoreCredentialMapping` cmdlet sets a new credential mapping for a Secure Store Service application. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" -PS C:\>$firstCredential = ConvertTo-SecureString "LOBDATABASE\jdoe" -AsPlainText -Force -PS C:\>$secondCredential = ConvertTo-SecureString "abcDEF123$%^" -AsPlainText -Force -PS C:\>$credentialValues = $firstCredential,$secondCredential -PS C:\>$userClaim = New-SPClaimsPrincipal -Identity "CONTOSO\janedoe" -IdentityType WindowsSamAccountName -PS C:\>Update-SPSecureStoreCredentialMapping -Identity $ssApp -Values $credentialValues -Principal $userClaim -``` - -This example updates a credential mapping for the given site and the target application ContosoTargetApplication, for the user with the identity janedoe on domain CONTOSO. -This user is mapped to a pair of credential values on the External System with a username of identity jdoe on domain LOBDATABASE and password abcDEF123$%^. - -## PARAMETERS - -### -Identity -Specifies the Secure Store Service application (that contains the principal) from which to delete the credential mapping. - -```yaml -Type: SPSecureStoreApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Principal -Specifies the SPClaims object that contains the principal. - -```yaml -Type: SPClaim -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Values -Specifies the field values for the credential mapping. - -```yaml -Type: SecureString[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreGroupCredentialMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreGroupCredentialMapping.md deleted file mode 100644 index e5e5ea1f50..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreGroupCredentialMapping.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPSecureStoreGroupCredentialMapping -schema: 2.0.0 ---- - -# Update-SPSecureStoreGroupCredentialMapping - -## SYNOPSIS -Sets a new group credential mapping for a Secure Store Service application. - -## SYNTAX - -``` -Update-SPSecureStoreGroupCredentialMapping -Identity <SPSecureStoreApplication> -Values <SecureString[]> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPSecureStoreGroupCredentialMapping` cmdlet sets a new group credential mapping for a Secure Store Service application. -Group credentials are a set of credentials that are associated with multiple identities. -Target applications will get credentials for a Secure Store application by using the current user. -If the current user meets the authorization rule defined in the Secure Store application for the group credentials, then the data is provided. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoGroupTargetApplication" -PS C:\>$firstCredential = ConvertTo-SecureString "LOBDATABASE\fulltimeemployees" -AsPlainText -Force -PS C:\>$secondCredential = ConvertTo-SecureString "abcDEF123$%^" -AsPlainText -Force -PS C:\>$credentialValues = $firstCredential,$secondCredential -PS C:\>Update-SPSecureStoreGroupCredentialMapping -Identity $ssApp -Values $credentialValues -``` - -This example adds a credential mapping for the target application ContosoGroupTargetApplication, for all users in this group target application. -These users are mapped to a pair of credential values on the External System with a username of identity fulltimeemployees on domain LOBDATABASE and with password abcDEF123$%^. - -## PARAMETERS - -### -Identity -Specifies the Secure Store application (that contains the principal) from which to delete the credential mapping. - -```yaml -Type: SPSecureStoreApplication -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Values -Specifies the field values for the credential mapping. - -```yaml -Type: SecureString[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreMasterKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreMasterKey.md deleted file mode 100644 index f436ef9a53..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSecureStoreMasterKey.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPSecureStoreMasterKey -schema: 2.0.0 ---- - -# Update-SPSecureStoreMasterKey - -## SYNOPSIS -Changes the master key of a Secure Store Service application. - -## SYNTAX - -``` -Update-SPSecureStoreMasterKey -Passphrase <String> -ServiceApplicationProxy <SPServiceApplicationProxyPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPSecureStoreApplicationServerKey` cmdlet changes the master key of a Secure Store Service application. - -Updating the master key is required when: - - ---A new instance of a service application is created and the database for the Secure Store service application is new or empty. - ---The master key or passphrase has been compromised. - ---Security guidelines require that the passphrase or key be replaced. - - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>$newPassPhrase = "abcDEF123!" -PS C:\>$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'} -PS C:\>Update-SPSecureStoreMasterKey -ServiceApplicationProxy $proxy -Passphrase $newPassPhrase -``` - -This example creates a new master key for the given service application. - -## PARAMETERS - -### -Passphrase -Specifies the passphrase that is used for the Secure Store database. -The passphrase that you enter is not stored. -Make sure that you write down the passphrase and store it in a secure location. -The passphrase will be required to add new Secure Store service servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceApplicationProxy -Specifies the proxy of the Secure Store service application that contains the master key to update. - -```yaml -Type: SPServiceApplicationProxyPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSolution.md deleted file mode 100644 index 3fa350dce9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPSolution.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPSolution -schema: 2.0.0 ---- - -# Update-SPSolution - -## SYNOPSIS -Upgrades a deployed SharePoint solution. - - -## SYNTAX - -``` -Update-SPSolution [-Identity] <SPSolutionPipeBind> -LiteralPath <String> - [-AssignmentCollection <SPAssignmentCollection>] [-CASPolicies] [-Confirm] [-Force] [-GACDeployment] [-Local] - [-Time <String>] [-WhatIf] [-FullTrustBinDeployment] [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPSolution` cmdlet upgrades a deployed SharePoint solution in the farm. -Use this cmdlet only if a new solution contains the same set of files and features as the deployed solution. -If files and features are different, the solution must be retracted and redeployed by using the `Uninstall-SPSolution` and `Install-SPSolution` cmdlets, respectively. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Update-SPSolution -Identity contoso_solution.wsp -LiteralPath c:\contoso_solution_v2.wsp -GACDeployment -``` - -This example upgrades the deployed SharePoint solution contoso_solution.wsp to the solution c:\contoso_solution_v2.wsp. - -## PARAMETERS - -### -Identity -Specifies the SharePoint solution to deploy. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. - -```yaml -Type: SPSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LiteralPath -Specifies the path to the solution package. - -The type must be a valid path in either of the following forms: - -- C:\folder_name -- \\\\server_name\folder_name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CASPolicies -Specifies that Code Access Security (CAS) policies can be deployed for the new SharePoint solution. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the deployment of the new SharePoint solution. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GACDeployment -Specifies that the new SharePoint solution can be deployed to the global assembly cache (GAC). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -Deploys the solution on the local computer only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -Specifies when the solution will be deployed. -The default value is immediate deployment. - -The type must be a valid DateTime value, in the form 2010, 5, 1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullTrustBinDeployment -Specifies whether to deploy using fully trusted bin. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPUserSolution.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPUserSolution.md deleted file mode 100644 index 3cb5d8f587..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPUserSolution.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPUserSolution -schema: 2.0.0 ---- - -# Update-SPUserSolution - -## SYNOPSIS -Upgrades an activated sandboxed solution in a farm. - - -## SYNTAX - -``` -Update-SPUserSolution [-Identity] <SPUserSolutionPipeBind> -Site <SPSitePipeBind> - -ToSolution <SPUserSolutionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPUserSolution` cmdlet upgrades a sandboxed solution that has already been activated in a specified site collection. -A user solution is a sandboxed solution. -Before you use this cmdlet to upgrade the activated solution, use the Add-SPUserSolution cmdlet to upload the upgraded solution to the solution gallery. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE--------------------- -``` -PS C:\>Update-SPUserSolution -Identity contoso_solution.wsp -Site http://sitename -ToSolution contoso_solution_v2.wsp -``` - -This example upgrades the sandboxed solution contoso_solution.wsp in the site http://sitename to the sandboxed solution contoso_solution_v2.wsp. - -## PARAMETERS - -### -Identity -Specifies the sandboxed solution to upgrade. - -The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. - -```yaml -Type: SPUserSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Site -Upgrade the sandboxed solution for the specified site collection. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToSolution -Specifies the sandboxed solution you want to upgrade to. - -The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. - -```yaml -Type: SPUserSolutionPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPWOPIProofKey.md b/sharepoint/sharepoint-ps/sharepoint-server/Update-SPWOPIProofKey.md deleted file mode 100644 index da597d7774..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Update-SPWOPIProofKey.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Update-SPWOPIProofKey -schema: 2.0.0 ---- - -# Update-SPWOPIProofKey - -## SYNOPSIS -Updates the public key that is used to connect to the WOPI application on the current SharePoint farm where this cmdlet is run. - - -## SYNTAX - -``` -Update-SPWOPIProofKey [-AssignmentCollection <SPAssignmentCollection>] [-ServerName <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Update-SPWOPIProofKey` cmdlet updates the public key that is used to connect to the WOPI application (which could be a server that runs Office Web Apps Server) on the current SharePoint farm where this cmdlet is run. -You may want to use this cmdlet if the keys become unsynchronized between the SharePoint farm and the WOPI application. -If the keys are unsynchronized, documents may not open in the browser and messages such as "Invalid Proof Signature for file…" or "Invalid Proof Signature for folder..." are found in the Unified Logging System (ULS) logs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -PS C:\>Update-SPWOPIProofKey -ServerName "Server.corp.Contoso.com" -``` - -This example obtains the current public key from the WOPI application (such as a server that runs Office Web Apps Server) and updates the key that is stored on the SharePoint farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the WOPI application to obtain the key from. -This may be a server that runs Office Web Apps Server. -If this parameter is missing, public keys for all WOPI applications which are connected to the current SharePoint farm, are updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Content roadmap for Office Web Apps]() - -[Use Office Web Apps with SharePoint 2013]() diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPAppManagementServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPAppManagementServiceApplication.md deleted file mode 100644 index 2e27ca05ba..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPAppManagementServiceApplication.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPAppManagementServiceApplication -schema: 2.0.0 ---- - -# Upgrade-SPAppManagementServiceApplication - -## SYNOPSIS -Do Not Use - -## SYNTAX - -### AppManagementSvcAppById -``` -Upgrade-SPAppManagementServiceApplication [[-Identity] <SPServiceApplicationPipeBind>] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-DatabaseIds <Guid[]>] [-WhatIf] - [<CommonParameters>] -``` - -### AppManagementSvcAppByName -``` -Upgrade-SPAppManagementServiceApplication [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-DatabaseIds <Guid[]>] [-Name <String>] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do Not Use - -## EXAMPLES - -### --------------EXAMPLE----------------- -``` -Do Not Use -``` - - - -## PARAMETERS - -### -AssignmentCollection -Do Not Use - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseIds -Do Not Use - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do Not Use - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: AppManagementSvcAppById -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Do Not Use - -```yaml -Type: String -Parameter Sets: AppManagementSvcAppByName -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPContentDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPContentDatabase.md deleted file mode 100644 index e8c03b1f2d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPContentDatabase.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPContentDatabase -schema: 2.0.0 ---- - -# Upgrade-SPContentDatabase - -## SYNOPSIS -Resumes a failed database upgrade or begins a build-to-build database upgrade. - - -## SYNTAX - -### ContentDatabaseById -``` -Upgrade-SPContentDatabase [-Identity] <SPContentDatabasePipeBind> [-ForceDeleteLock] - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-NoB2BSiteUpgrade] - [-ServerInstance <SPDatabaseServiceInstancePipeBind>] [-SkipIntegrityChecks] [-UseSnapshot] [-WhatIf] - [-AllowUnattached] [-SkipSiteUpgrade] [<CommonParameters>] -``` - -### ContentDatabaseByName -``` -Upgrade-SPContentDatabase [-ForceDeleteLock] -Name <String> -WebApplication <SPWebApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-NoB2BSiteUpgrade] - [-ServerInstance <SPDatabaseServiceInstancePipeBind>] [-SkipIntegrityChecks] [-UseSnapshot] [-WhatIf] - [-AllowUnattached] [-SkipSiteUpgrade] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet Parameter Sets](https://go.microsoft.com/fwlink/?LinkID=187810). - -Use the `Upgrade-SPContentDatabase` cmdlet to resume a failed database upgrade or begin a build-to-build database upgrade against a SharePoint content database. -The `Upgrade-SPContentDatabase` cmdlet initiates an upgrade of an existing content database that is attached to the current farm. -This cmdlet begins a new upgrade session, which can be used either to resume a failed version-to-version or build-to-build upgrade of a content database or to begin a build-to-build upgrade of a content database. - -If the database is hosted on a version of SQL Server that supports creation and use of snapshots of the database, this cmdlet can use a database snapshot for build-to-build upgrades. -During upgrade, users see a ready-only version of the database, which is the snapshot. -After upgrade users see upgraded content. - -The default behavior of this cmdlet causes an upgrade of the schema of the database and initiates build-to-build upgrades for all site collections within the specified content database if required. -To prevent build-to-build upgrades of site collections, use the NoB2BSiteUpgrade parameter. - -This cmdlet does not trigger version-to-version upgrade of any site collections. - - -## EXAMPLES - -### --------------------------EXAMPLE 1------------------------------ -``` -PS C:\>Upgrade-SPContentDatabase WSS_Content -``` - -This example upgrades the existing WSS_Content content database schema and then performs only build-to-build upgrade actions on existing site collections if required. -This operation does not changed the CompatibilityLevel for existing site collections in this database. - -### --------------------------EXAMPLE 2------------------------------ -``` -PS C:\>Upgrade-SPContentDatabase WSS_Content -NoB2BSiteUpgrade -``` - -This example upgrades the existing WSS_Content content database schema only. -No build-to-build upgrade actions are performed on any site collections. -This operation does not change The CompatibilityLevel for existing site collections in this database. - -### --------------------------EXAMPLE 3------------------------------ -``` -PS C:\>Upgrade-SPContentDatabase WSS_Content -NoB2BSiteUpgrade -UseSnapshot -``` - -This example upgrades the existing WSS_Content content database schema only while using a snapshot of the database to retain read-only access to the content during the upgrade. -No build-to-build upgrade actions are performed on any site collections. -This operation does not change the CompatibilityLevel for existing site collections in this database. - -## PARAMETERS - -### -Identity -Specifies the content database to upgrade. - -The value must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPContentDatabase object. - -```yaml -Type: SPContentDatabasePipeBind -Parameter Sets: ContentDatabaseById -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ForceDeleteLock -Forces deletion of locks on the database before the upgrade starts. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of attached content database. - -```yaml -Type: String -Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplication -Specifies the web application that hosts the attached content database. - -```yaml -Type: SPWebApplicationPipeBind -Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoB2BSiteUpgrade -Specifies to not upgrade all child objects when performing a build-to-build upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerInstance -The SQL Server instance that hosts the attached content database. - -```yaml -Type: SPDatabaseServiceInstancePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipIntegrityChecks -Specifies the upgrade process not to run the internal integrity checks such as missing templates and orphan detection as part of the upgrade process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSnapshot -Specifies to use the snapshot method to perform unattached upgrade. -This will make a snapshot of the current database and then perform all upgrade operations that apply to the database and optionally to its contents. - -The existing connections to the content database will be set to use the snapshot for the duration of the upgrade and then switched back after successful completion of upgrade. -A failed upgrade reverts the database to its state when the snapshot was taken. - -This parameter only works for versions of SQL Server that support creation and use of snapshots, for example, SQL ServerEnterprise edition. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUnattached -Lets the upgrade process to proceed on a content database which is not currently attached to a SharePoint farm. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSiteUpgrade -Specifies to not upgrade databases and their child objects when performing upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPEnterpriseSearchServiceApplication.md deleted file mode 100644 index 1263142a7d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPEnterpriseSearchServiceApplication.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPEnterpriseSearchServiceApplication -schema: 2.0.0 ---- - -# Upgrade-SPEnterpriseSearchServiceApplication - -## SYNOPSIS -Upgrades a search service application. - -## SYNTAX - -``` -Upgrade-SPEnterpriseSearchServiceApplication [-Identity] <SearchServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet starts an upgrade process on a search service application. -This cmdlet runs the associated upgrade actions for the search service application. -Also, you can upgrade multiple search service applications in parallel by starting several instances of this cmdlet. -It is not necessary to run this cmdlet if you already have run the SharePoint Products Configuration Wizard. - -For the upgrade process to run successful, all of the computers in the farm must have the same version of binaries installed. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ----------------EXAMPLE 1----------------- -``` -PS C:\>Get-SPEnterpriseSearchServiceApplication | Upgrade-SPEnterpriseSearchServiceApplication -``` - -This example upgrades a search service application. - -### ----------------EXAMPLE 2----------------- -``` -PS C:\>Upgrade-SPEnterpriseSearchServiceApplication -Identity 846ceb0b-31d6-4c79-82c1-3a9deafe0b45 -``` - -This example upgrades a search service application. - -### ----------------EXAMPLE 3----------------- -``` -PS C:\>Upgrade-SPEnterpriseSearchServiceApplication "DefaultSearchApplication" -``` - -This example upgrades a search service application. - -## PARAMETERS - -### -Identity -Specifies the search service application to upgrade. - -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - -```yaml -Type: SearchServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md deleted file mode 100644 index 2b24870848..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Office.Server.Search.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings -schema: 2.0.0 ---- - -# Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings - -## SYNOPSIS -Upgrades search settings for a particular site collection. - -## SYNTAX - -``` -Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings -Identity <SPSitePipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Use the `Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings` cmdlet to upgrade the search settings for specified site collection from 2010 to 2013 experience. -The upgrades include conversion of best bets to query rules. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------EXAMPLE-------- -``` -C:\PS>$site= Get-SPSite http://test - -PS C:\>Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings -Identity $site -``` - -This example upgrades the search settings for the site collection referenced by $site. - - -## PARAMETERS - -### -Identity -Specifies the site collection for which to upgrade search settings. -The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPEnterpriseSearchServiceApplicationSiteSettings](Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPFarm.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPFarm.md deleted file mode 100644 index 40b96dbb55..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPFarm.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPFarm -schema: 2.0.0 ---- - -# Upgrade-SPFarm - -## SYNOPSIS -Activates the Upgrade method for the local farm. - - -## SYNTAX - -``` -Upgrade-SPFarm [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [-ServerOnly] - [-SkipDatabaseUpgrade] [-SkipSiteUpgrade] [<CommonParameters>] -``` - -## DESCRIPTION -The `Upgrade-SPFarm` cmdlet starts the upgrade process on the local farm. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -----------EXAMPLE--------- -``` -PS C:\>Upgrade-SPFarm -``` - -This example starts the upgrade process on the local farm. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerOnly -Specifies to only upgrade local server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDatabaseUpgrade -Specifies to not upgrade databases and their child objects when performing upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSiteUpgrade -Specifies to not upgrade all site objects when performing upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPProfileServiceApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPProfileServiceApplication.md deleted file mode 100644 index 56941e0c63..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPProfileServiceApplication.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPProfileServiceApplication -schema: 2.0.0 ---- - -# Upgrade-SPProfileServiceApplication - -## SYNOPSIS -Upgrades User Profile Service and its related profile and social store. - -## SYNTAX - -``` -Upgrade-SPProfileServiceApplication [-Identity] <SPServiceApplicationPipeBind> - [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Upgrades User Profile Service and its related profile and social store. - -## EXAMPLES - -### -----------EXAMPLE--------- -``` -PS C:\>$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} -PS C:\>Upgrade-SPProfileServiceApplication $sa -``` - -This example upgrades the specified user profile service application. - -## PARAMETERS - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the User Profile Service application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user profile service application (for example, UserProfileServiceApp); or an instance of a valid SPServiceApplication object. - -```yaml -Type: SPServiceApplicationPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPServiceApplicationPipeBind -Microsoft.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSingleSignOnDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSingleSignOnDatabase.md deleted file mode 100644 index 4f987e321b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSingleSignOnDatabase.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.SSOUpgrade-help.xml -applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPSingleSignOnDatabase -schema: 2.0.0 ---- - -# Upgrade-SPSingleSignOnDatabase - -## SYNOPSIS -Migrates the application definitions from Single Sign-On (SSO) database to Secure Store database as target applications. - -## SYNTAX - -``` -Upgrade-SPSingleSignOnDatabase -SecureStoreConnectionString <String> -SecureStorePassphrase <SecureString> - -SSOConnectionString <String> [-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Upgrade-SPSingleSignOnDatabase` cmdlet migrates the application definitions from SSO database to Secure Store database as target applications. -Use the `Upgrade-SPSingleSignOn` cmdlet to convert an SSO database to a Secure Store database. -SSO is a SharePoint Server feature. -SSO functionality is performed by the Secure Store Service in SharePoint Server. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### ------------------EXAMPLE------------------ -``` -PS C:\>Upgrade-SPSingleSignOnDatabase -SSOConnectionString "Data Source=oldServer;Database=SSO;Trusted_Connection=yes;" -SecureStoreConnectionString "Data Source=CONTOSO\SQLDatabase;Database=ContosoSSDatabase;Trusted_Connection=yes;" -SecureStorePassphrase "abcDEF123!@#" -``` - -This example migrates the SSO database at the SSO connection to a Secure Store database at the Secure Store connection. - -## PARAMETERS - -### -SecureStoreConnectionString -Specifies the SQL Server connection string for the Secure Store database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStorePassphrase -Specifies the passphrase used for the Secure Store database. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SSOConnectionString -Specifies the SQL Server connection string for the SSO database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSite.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSite.md deleted file mode 100644 index 8da93b5b24..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSite.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.SharePoint.PowerShell.dll-help.xml -applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPSite -schema: 2.0.0 ---- - -# Upgrade-SPSite - -## SYNOPSIS -Starts the upgrade process on a site collection. - -## SYNTAX - -``` -Upgrade-SPSite [-Identity] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-Email] [-QueueOnly] [-Unthrottled] [-VersionUpgrade] [-WhatIf] [-Priority <Byte>] [<CommonParameters>] -``` - -## DESCRIPTION -The `Upgrade-SPSite` cmdlet starts the upgrade process on a site collection. - -The `Upgrade-SPSite` cmdlet activates the upgrade process for the specified SPSite object. -You can also use this cmdlet to resume failed upgrades. -When you use this cmdlet to initiate upgrade on an SPSite object, the object can be either a build-to-build or version-to-version upgrade. - -By default, the `Upgrade-SPSite` cmdlet operates as a build-to-build upgrade. -This prevents unexpected version upgrades of site collections if you use this cmdlet after a patching operation. -When in version-to-version upgrade mode, site collection health checks are run in repair mode to ensure that the site collection is healthy enough to upgrade successfully. -If successful, the remainder of the upgrade occurs. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### -------------EXAMPLE 1---------- -``` -PS C:\>Upgrade-SPSite http://<site name>/sites/testsite -``` - -This example upgrades the existing http://\<site name\>/sites/testsite site collection by using only build-to-build upgrade actions. -The SPSite.CompatibilityLevel will not be changed by this operation. - -### -------------EXAMPLE 2---------- -``` -PS C:\>Upgrade-SPSite http://<site name>/sites/testsite -VersionUpgrade -``` - -This example upgrades the existing http://\<site name\>/sites/testsite site collection by using only build-to-build upgrade actions. -The SPSite.CompatibilityLevel will not be changed by this operation. - -## PARAMETERS - -### -Identity -Specifies the SPSite object to run upgrade operations against. - -```yaml -Type: SPSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AssignmentCollection -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies whether to send mail on completion of the site collection upgrade. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueOnly -Specifies to put the site into the queue for a delayed upgrade that is managed by a timer job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Unthrottled -Specifies a farm administrator to bypass the throttle which permits a site collection to be upgraded even if there are "too many" site collections in the throttle to be upgraded. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionUpgrade -Specifies to perform a version-to-version upgrade on the SPSite object. -When this parameter is set, it internally triggers all available build-to-build actions that are associated with the current site collection operating mode. -Version-to-version actions follow to bring site collections to the next site collection operating mode inclusive of all new build-to-build actions that are associated with the new site collection operating mode. -When this parameter is not set, it triggers only available build-to-build upgrade actions that are associated with the current site collection operating mode. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies what priority to upgrade the site. - -The valid values are: - -* 128 - 255 (Low Priority) - -* 11 - 127 (Normal Priority) - -* 0 - 10 (High Priority) - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSiteMapDatabase.md deleted file mode 100644 index 97b1531f04..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/Upgrade-SPSiteMapDatabase.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointserver.xml -applicable: SharePoint Server 2016, SharePoint Server 2019 -title: Upgrade-SPSiteMapDatabase -schema: 2.0.0 ---- - -# Upgrade-SPSiteMapDatabase - -## SYNOPSIS -Do not use. - -## SYNTAX - -``` -Upgrade-SPSiteMapDatabase [-DatabaseId] <Guid> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm] - [-WhatIf] [<CommonParameters>] -``` - -## DESCRIPTION -Do not use. - -## EXAMPLES - -### -------------EXAMPLE 1---------- -``` -PS C:\>#Do not use -``` - -Do not use. - -## PARAMETERS - -### -AssignmentCollection -Do not use. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseId -Do not use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2016, SharePoint 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.SharePoint.PowerShell.SPAssignmentCollection - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md b/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md deleted file mode 100644 index 67ccdfeee7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md +++ /dev/null @@ -1,1154 +0,0 @@ ---- -Module Name: SharePointServer -Module Guid: 01dfdcd9-c48d-46a9-b09a-587ca5c4829a -Help Version: 17.0.15229.2100 -Download Help Link: https://officedocs-cdn.azureedge.net/powershell/sharepoint/ -title: sharepoint-server -Locale: en-US -Additional Locale: de-DE,es-ES,fr-FR,it-IT,ja-JP,ko-KR,pt-BR,ru-RU,zh-CN,zh-TW -de-DE Version: 17.0.15229.2100 -es-ES Version: 17.0.15229.2100 -fr-FR Version: 17.0.15229.2100 -it-IT Version: 17.0.15229.2100 -ja-JP Version: 17.0.15229.2100 -ko-KR Version: 17.0.15229.2100 -pt-BR Version: 17.0.15229.2100 -ru-RU Version: 17.0.15229.2100 -zh-CN Version: 17.0.15229.2100 -zh-TW Version: 17.0.15229.2100 ---- -# SharePoint Server PowerShell -## Description -The following cmdlet references are for SharePoint Server. - -## Access Service (2010) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPAccessServiceApplication](Get-SPAccessServiceApplication.md)** |Returns an Access Services application or a collection of Access Services applications. |SharePoint 2010, SharePoint 2013, SharePoint 2016 -**[New-SPAccessServiceApplication](New-SPAccessServiceApplication.md)** |Creates a new instance of an Access Services application in SharePoint Server. |SharePoint 2010, SharePoint 2013, SharePoint 2016 -**[Set-SPAccessServiceApplication](Set-SPAccessServiceApplication.md)** |Sets global properties of an existing Access Services application in SharePoint Server. |SharePoint 2010, SharePoint 2013, SharePoint 2016 - -## Access Services (2013) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Copy-SPAccessServicesDatabaseCredentials](Copy-SPAccessServicesDatabaseCredentials.md)** |{{Manually Enter Copy-SPAccessServicesDatabaseCredentials Description Here}} |SharePoint 2013, SharePoint 2016 -**[Export-SPAccessServicesDatabase](Export-SPAccessServicesDatabase.md)** |Exports an Access Services Database to a DACPAC via the Data-Tier Framework. |SharePoint 2016 -**[Get-SPAccessServicesApplication](Get-SPAccessServicesApplication.md)** |Gets an Access Services Service Application. |SharePoint 2013, SharePoint 2016 -**[Get-SPAccessServicesDatabase](Get-SPAccessServicesDatabase.md)** |Returns an Access Services database. |SharePoint 2013, SharePoint 2016 -**[Get-SPAccessServicesDatabaseServer](Get-SPAccessServicesDatabaseServer.md)** |Returns SQL Server instances associated with Access Services. |SharePoint 2013, SharePoint 2016 -**[Get-SPAccessServicesDatabaseServerGroup](Get-SPAccessServicesDatabaseServerGroup.md) |Returns a database server group. |SharePoint 2013, SharePoint 2016 -**[Get-SPAccessServicesDatabaseServerGroupMapping](Get-SPAccessServicesDatabaseServerGroupMapping.md)** |Returns the mapping of the database server group. |SharePoint 2013, SharePoint 2016 -**[Import-SPAccessServicesDatabase](Import-SPAccessServicesDatabase.md)** |Imports an Access Services Database to a DACPAC via the Data-Tier Framework. |SharePoint 2016 -**[New-SPAccessServicesApplication](New-SPAccessServicesApplication.md)** |Creates an Access Services Service Application. |SharePoint 2013, SharePoint 2016 -**[New-SPAccessServicesApplicationProxy](New-SPAccessServicesApplicationProxy.md)** |Creates a Proxy for an Access Services Service Application. |SharePoint 2013, SharePoint 2016 -**[New-SPAccessServicesDatabaseServer](New-SPAccessServicesDatabaseServer.md)** |Adds a server to host Access Services databases. |SharePoint 2013, SharePoint 2016 -**[Remove-SPAccessServicesDatabaseServer](Remove-SPAccessServicesDatabaseServer.md)** |Removes a database server for hosting Access Services databases. |SharePoint 2013, SharePoint 2016 -**[Reset-SPAccessServicesDatabasePassword](Reset-SPAccessServicesDatabasePassword.md)** |Resets the specified Access Services Database password with a randomly generated password. |SharePoint 2013, SharePoint 2016 -**[Set-SPAccessServicesApplication](Set-SPAccessServicesApplication.md)** |Sets properties of an Access Services Service Application. |SharePoint 2013, SharePoint 2016 -**[Set-SPAccessServicesDatabaseServer](Set-SPAccessServicesDatabaseServer.md)** |{{Manually Enter Set-SPAccessServicesDatabaseServer Description Here}} |SharePoint 2013, SharePoint 2016 -**[Set-SPAccessServicesDatabaseServerGroupMapping](Set-SPAccessServicesDatabaseServerGroupMapping.md)** |{{Manually Enter Set-SPAccessServicesDatabaseServerGroupMapping Description Here}} |SharePoint 2013, SharePoint 2016 - -## SharePoint Addins -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPAppDeniedEndpoint](Add-SPAppDeniedEndpoint.md)** | -**[Clear-SPAppDeniedEndpointList](Clear-SPAppDeniedEndpointList.md)** | -**[Disable-SPAppAutoProvision](Disable-SPAppAutoProvision.md)** | -**[Enable-SPAppAutoProvision](Enable-SPAppAutoProvision.md)** | -**[Export-SPAppPackage](Export-SPAppPackage.md)** | -**[Get-SPAppAcquisitionConfiguration](Get-SPAppAcquisitionConfiguration.md)** | -**[Get-SPAppAutoProvisionConnection](Get-SPAppAutoProvisionConnection.md)** | -**[Get-SPAppDeniedEndpointList](Get-SPAppDeniedEndpointList.md)** | -**[Get-SPAppDisablingConfiguration](Get-SPAppDisablingConfiguration.md)** | -**[Get-SPAppDomain](Get-SPAppDomain.md)** | -**[Get-SPAppHostingQuotaConfiguration](Get-SPAppHostingQuotaConfiguration.md)** | -**[Get-SPAppInstance](Get-SPAppInstance.md)** | -**[Get-SPAppPrincipal](Get-SPAppPrincipal.md)** | -**[Get-SPAppScaleProfile](Get-SPAppScaleProfile.md)** | -**[Get-SPAppSiteSubscriptionName](Get-SPAppSiteSubscriptionName.md)** | -**[Get-SPAppStateSyncLastRunTime](Get-SPAppStateSyncLastRunTime.md)** | -**[Get-SPAppStateUpdateInterval](Get-SPAppStateUpdateInterval.md)** | -**[Get-SPAppStoreConfiguration](Get-SPAppStoreConfiguration.md)** | -**[Get-SPAppStoreWebServiceConfiguration](Get-SPAppStoreWebServiceConfiguration.md)** | -**[Get-SPInternalAppStateSyncLastRunTime](Get-SPInternalAppStateSyncLastRunTime.md)** | -**[Get-SPInternalAppStateUpdateInterval](Get-SPInternalAppStateUpdateInterval.md)** | -**[Import-SPAppPackage](Import-SPAppPackage.md)** | -**[Install-SPApp](Install-SPApp.md)** | -**[Move-SPAppManagementData](Move-SPAppManagementData.md)** | -**[New-SPMarketplaceWebServiceApplicationProxy](New-SPMarketplaceWebServiceApplicationProxy.md)** | -**[Register-SPAppPrincipal](Register-SPAppPrincipal.md)** | -**[Remove-SPAppDeniedEndpoint](Remove-SPAppDeniedEndpoint.md)** | -**[Remove-SPAppPrincipalPermission](Remove-SPAppPrincipalPermission.md)** | -**[Restart-SPAppInstanceJob](Restart-SPAppInstanceJob.md)** | -**[Set-SPAppAcquisitionConfiguration](Set-SPAppAcquisitionConfiguration.md)** | -**[Set-SPAppAutoProvisionConnection](Set-SPAppAutoProvisionConnection.md)** | -**[Set-SPAppDisablingConfiguration](Set-SPAppDisablingConfiguration.md)** | -**[Set-SPAppDomain](Set-SPAppDomain.md)** | -**[Set-SPAppHostingQuotaConfiguration](Set-SPAppHostingQuotaConfiguration.md)** | -**[Set-SPAppManagementDeploymentId](Set-SPAppManagementDeploymentId.md)** | -**[Set-SPAppPrincipalPermission](Set-SPAppPrincipalPermission.md)** | -**[Set-SPAppScaleProfile](Set-SPAppScaleProfile.md)** | -**[Set-SPAppSiteDomain](Set-SPAppSiteDomain.md)** | -**[Set-SPAppSiteSubscriptionName](Set-SPAppSiteSubscriptionName.md)** | -**[Set-SPAppStateUpdateInterval](Set-SPAppStateUpdateInterval.md)** | -**[Set-SPAppStoreConfiguration](Set-SPAppStoreConfiguration.md)** | -**[Set-SPAppStoreWebServiceConfiguration](Set-SPAppStoreWebServiceConfiguration.md)** | -**[Set-SPInternalAppStateUpdateInterval](Set-SPInternalAppStateUpdateInterval.md)** | -**[Update-SPAppCatalogConfiguration](Update-SPAppCatalogConfiguration.md)** | -**[Update-SPAppInstance](Update-SPAppInstance.md)** | -**[Uninstall-SPAppInstance](Uninstall-SPAppInstance.md)** | - -## App Management Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New-SPAppManagementServiceApplication](New-SPAppManagementServiceApplication.md)** | -**[New-SPAppManagementServiceApplicationProxy](New-SPAppManagementServiceApplicationProxy.md)** | - -## Backup and Restore Operations -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Backup-SPConfigurationDatabase](Backup-SPConfigurationDatabase.md)** | -**[Backup-SPFarm](Backup-SPFarm.md)** | -**[Backup-SPSite](Backup-SPSite.md)** | -**[Export-SPWeb](Export-SPWeb.md)** | -**[Get-SPBackupHistory](Get-SPBackupHistory.md)** | -**[Restore-SPDeletedSite](Restore-SPDeletedSite.md)** | -**[Restore-SPFarm](Restore-SPFarm.md)** | -**[Restore-SPSite](Restore-SPSite.md)** | - -## Bing Maps -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPBingMapsBlock](Get-SPBingMapsBlock.md)** | -**[Get-SPBingMapsKey](Get-SPBingMapsKey.md)** | -**[Set-SPBingMapsBlock](Set-SPBingMapsBlock.md)** | -**[Set-SPBingMapsKey](Set-SPBingMapsKey.md)** | - -## Business Data Connectivity Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Clear-SPBusinessDataCatalogEntityNotificationWeb](Clear-SPBusinessDataCatalogEntityNotificationWeb.md)** | -**[Copy-SPBusinessDataCatalogAclToChildren](Copy-SPBusinessDataCatalogAclToChildren.md)** | -**[Disable-SPBusinessDataCatalogEntity](Disable-SPBusinessDataCatalogEntity.md)** | -**[Enable-SPBusinessDataCatalogEntity](Enable-SPBusinessDataCatalogEntity.md)** | -**[Export-SPBusinessDataCatalogModel](Export-SPBusinessDataCatalogModel.md)** | -**[Get-SPBusinessDataCatalogEntityNotificationWeb](Get-SPBusinessDataCatalogEntityNotificationWeb.md)** | -**[Get-SPBusinessDataCatalogMetadataObject](Get-SPBusinessDataCatalogMetadataObject.md)** | -**[Get-SPBusinessDataCatalogThrottleConfig](Get-SPBusinessDataCatalogThrottleConfig.md)** | -**[Grant-SPBusinessDataCatalogMetadataObject](Grant-SPBusinessDataCatalogMetadataObject.md)** | -**[Import-SPBusinessDataCatalogDotNetAssembly](Import-SPBusinessDataCatalogDotNetAssembly.md)** | -**[Import-SPBusinessDataCatalogModel](Import-SPBusinessDataCatalogModel.md)** | -**[New-SPBECWebServiceApplicationProxy](New-SPBECWebServiceApplicationProxy.md)** | -**[New-SPBusinessDataCatalogServiceApplication](New-SPBusinessDataCatalogServiceApplication.md)** | -**[New-SPBusinessDataCatalogServiceApplicationProxy](New-SPBusinessDataCatalogServiceApplicationProxy.md)** | -**[Remove-SPBusinessDataCatalogModel](Remove-SPBusinessDataCatalogModel.md)** | -**[Revoke-SPBusinessDataCatalogMetadataObject](Revoke-SPBusinessDataCatalogMetadataObject.md)** | -**[Set-SPBusinessDataCatalogEntityNotificationWeb](Set-SPBusinessDataCatalogEntityNotificationWeb.md)** | -**[Set-SPBusinessDataCatalogMetadataObject](Set-SPBusinessDataCatalogMetadataObject.md)** | -**[Set-SPBusinessDataCatalogServiceApplication](Set-SPBusinessDataCatalogServiceApplication.md)** | -**[Set-SPBusinessDataCatalogThrottleConfig](Set-SPBusinessDataCatalogThrottleConfig.md)** | - -## Database Operations -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-DatabaseToAvailabilityGroup](Add-DatabaseToAvailabilityGroup.md)** | -**[Add-SPScaleOutDatabase](Add-SPScaleOutDatabase.md)** | -**[Add-SPServerScaleOutDatabase](Add-SPServerScaleOutDatabase.md)** | -**[Clear-SPScaleOutDatabaseDeletedDataSubRange](Clear-SPScaleOutDatabaseDeletedDataSubRange.md)** | -**[Clear-SPScaleOutDatabaseLog](Clear-SPScaleOutDatabaseLog.md)** | -**[Clear-SPScaleOutDatabaseTenantData](Clear-SPScaleOutDatabaseTenantData.md)** | -**[Clear-SPServerScaleOutDatabaseDeletedDataSubRange](Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md)** | -**[Clear-SPServerScaleOutDatabaseLog](Clear-SPServerScaleOutDatabaseLog.md)** | -**[Clear-SPServerScaleOutDatabaseTenantData](Clear-SPServerScaleOutDatabaseTenantData.md)** | -**[Dismount-SPContentDatabase](Dismount-SPContentDatabase.md)** | -**[Export-SPScaleOutDatabaseTenantData](Export-SPScaleOutDatabaseTenantData.md)** | -**[Export-SPServerScaleOutDatabaseTenantData](Export-SPServerScaleOutDatabaseTenantData.md)** | -**[Get-AvailabilityGroupStatus](Get-AvailabilityGroupStatus.md)** | -**[Get-SPContentDatabase](Get-SPContentDatabase.md)** | -**[Get-SPDatabase](Get-SPDatabase.md)** | -**[Get-SPScaleOutDatabase](Get-SPScaleOutDatabase.md)** | -**[Get-SPScaleOutDatabaseDataState](Get-SPScaleOutDatabaseDataState.md)** | -**[Get-SPScaleOutDatabaseInconsistency](Get-SPScaleOutDatabaseInconsistency.md)** | -**[Get-SPScaleOutDatabaseLogEntry](Get-SPScaleOutDatabaseLogEntry.md)** | -**[Get-SPServerScaleOutDatabase](Get-SPServerScaleOutDatabase.md)** | -**[Get-SPServerScaleOutDatabaseDataState](Get-SPServerScaleOutDatabaseDataState.md)** | -**[Get-SPServerScaleOutDatabaseInconsistency](Get-SPServerScaleOutDatabaseInconsistency.md)** | -**[Get-SPServerScaleOutDatabaseLogEntry](Get-SPServerScaleOutDatabaseLogEntry.md)** | -**[Import-SPScaleOutDatabaseTenantData](Import-SPScaleOutDatabaseTenantData.md)** | -**[Import-SPServerScaleOutDatabaseTenantData](Import-SPServerScaleOutDatabaseTenantData.md)** | -**[Migrate-SPDatabase](Migrate-SPDatabase.md)** | -**[Move-SPBlobStorageLocation](Move-SPBlobStorageLocation.md)** | -**[Mount-SPContentDatabase](Mount-SPContentDatabase.md)** | -**[New-SPContentDatabase](New-SPContentDatabase.md)** | -**[Remove-DatabaseFromAvailabilityGroup](Remove-DatabaseFromAvailabilityGroup.md)** | -**[Remove-SPContentDatabase](Remove-SPContentDatabase.md)** | -**[Remove-SPScaleOutDatabase](Remove-SPScaleOutDatabase.md)** | -**[Remove-SPServerScaleOutDatabase](Remove-SPServerScaleOutDatabase.md)** | -**[Set-SPContentDatabase](Set-SPContentDatabase.md)** | -**[Set-SPScaleOutDatabaseDataRange](Set-SPScaleOutDatabaseDataRange.md)** | -**[Set-SPScaleOutDatabaseDataSubRange](Set-SPScaleOutDatabaseDataSubRange.md)** | -**[Split-SPScaleOutDatabase](Split-SPScaleOutDatabase.md)** | -**[Split-SPServerScaleOutDatabase](Split-SPServerScaleOutDatabase.md)** | -**[Set-SPServerScaleOutDatabaseDataRange](Set-SPServerScaleOutDatabaseDataRange.md)** | -**[Set-SPServerScaleOutDatabaseDataSubRange](Set-SPServerScaleOutDatabaseDataSubRange.md)** | -**[Test-SPContentDatabase](Test-SPContentDatabase.md)** | -**[Upgrade-SPContentDatabase](Upgrade-SPContentDatabase.md)** | - -## Diagnostics (ULS) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Clear-SPLogLevel](Clear-SPLogLevel.md)** | -**[Get-SPLogEvent](Get-SPLogEvent.md)** | -**[Get-SPLogLevel](Get-SPLogLevel.md)** | -**[Merge-SPLogFile](Merge-SPLogFile.md)** | -**[New-SPLogFile](New-SPLogFile.md)** | -**[Set-SPLogLevel](Set-SPLogLevel.md)** | - -## Distributed Cache -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPDistributedCacheServiceInstance](Add-SPDistributedCacheServiceInstance.md)** | -**[Clear-SPDistributedCacheItem](Clear-SPDistributedCacheItem.md)** | -**[Get-SPDistributedCacheClientSetting](Get-SPDistributedCacheClientSetting.md)** | -**[Remove-SPDistributedCacheServiceInstance](Remove-SPDistributedCacheServiceInstance.md)** | -**[Set-SPDistributedCacheClientSetting](Set-SPDistributedCacheClientSetting.md)** | -**[Stop-SPDistributedCacheServiceInstance](Stop-SPDistributedCacheServiceInstance.md)** | -**[Update-SPDistributedCacheSize](Update-SPDistributedCacheSize.md)** | - -## Excel Calculation Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPExcelBIServer](Get-SPExcelBIServer.md)** | -**[Get-SPExcelBlockedFileType](Get-SPExcelBlockedFileType.md)** | -**[Get-SPExcelDataConnectionLibrary](Get-SPExcelDataConnectionLibrary.md)** | -**[Get-SPExcelDataProvider](Get-SPExcelDataProvider.md)** | -**[Get-SPExcelFileLocation](Get-SPExcelFileLocation.md)** | -**[Get-SPExcelServiceApplication](Get-SPExcelServiceApplication.md)** | -**[Get-SPExcelUserDefinedFunction](Get-SPExcelUserDefinedFunction.md)** | -**[New-SPExcelBIServer](New-SPExcelBIServer.md)** | -**[New-SPExcelBlockedFileType](New-SPExcelBlockedFileType.md)** | -**[New-SPExcelDataConnectionLibrary](New-SPExcelDataConnectionLibrary.md)** | -**[New-SPExcelDataProvider](New-SPExcelDataProvider.md)** | -**[New-SPExcelFileLocation](New-SPExcelFileLocation.md)** | -**[New-SPExcelServiceApplication](New-SPExcelServiceApplication.md)** | -**[New-SPExcelUserDefinedFunction](New-SPExcelUserDefinedFunction.md)** | -**[Remove-SPExcelBIServer](Remove-SPExcelBIServer.md)** | -**[Remove-SPExcelBlockedFileType](Remove-SPExcelBlockedFileType.md)** | -**[Remove-SPExcelDataConnectionLibrary](Remove-SPExcelDataConnectionLibrary.md)** | -**[Remove-SPExcelDataProvider](Remove-SPExcelDataProvider.md)** | -**[Remove-SPExcelFileLocation](Remove-SPExcelFileLocation.md)** | -**[Remove-SPExcelUserDefinedFunction](Remove-SPExcelUserDefinedFunction.md)** | -**[Set-SPExcelBIServer](Set-SPExcelBIServer.md)** | -**[Set-SPExcelDataConnectionLibrary](Set-SPExcelDataConnectionLibrary.md)** | -**[Set-SPExcelDataProvider](Set-SPExcelDataProvider.md)** | -**[Set-SPExcelFileLocation](Set-SPExcelFileLocation.md)** | -**[Set-SPExcelServiceApplication](Set-SPExcelServiceApplication.md)** | -**[Set-SPExcelUserDefinedFunction](Set-SPExcelUserDefinedFunction.md)** | - -## Farm -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Disable-SPTimerJob](Disable-SPTimerJob.md)** | -**[Enable-SPTimerJob](Enable-SPTimerJob.md)** | -**[Get-SPBrowserCustomerExperienceImprovementProgram](Get-SPBrowserCustomerExperienceImprovementProgram.md)** | -**[Get-SPFarm](Get-SPFarm.md)** | -**[Get-SPFarmConfig](Get-SPFarmConfig.md)** | -**[Get-SPMobileMessagingAccount](Get-SPMobileMessagingAccount.md)** | -**[Get-SPProduct](Get-SPProduct.md)** | -**[Get-SPProcessAccount](Get-SPProcessAccount.md)** | -**[Get-SPServer](Get-SPServer.md)** | -**[Get-SPService](Get-SPService.md)** | -**[Get-SPServiceHostConfig](Get-SPServiceHostConfig.md)** | -**[Get-SPServiceInstance](Get-SPServiceInstance.md)** | -**[Get-SPTimerJob](Get-SPTimerJob.md)** | -**[Get-SPWebPartPack](Get-SPWebPartPack.md)** | -**[Get-SPUserSettingsProvider](Get-SPUserSettingsProvider.md)** | -**[Get-SPUserSettingsProviderManager](Get-SPUserSettingsProviderManager.md)** | -**[Install-SPWebPartPack](Install-SPWebPartPack.md)** | -**[New-SPUserSettingsProvider](New-SPUserSettingsProvider.md)** | -**[Remove-SPUserSettingsProvider](Remove-SPUserSettingsProvider.md)** | -**[Rename-SPServer](Rename-SPServer.md)** | -**[Set-SPBrowserCustomerExperienceImprovementProgram](Set-SPBrowserCustomerExperienceImprovementProgram.md)** | -**[Set-SPCustomLayoutsPage](Set-SPCustomLayoutsPage.md)** | -**[Set-SPFarmConfig](Set-SPFarmConfig.md)** | -**[Set-SPMobileMessagingAccount](Set-SPMobileMessagingAccount.md)** | -**[Set-SPIRMSettings](Set-SPIRMSettings.md)** | -**[Set-SPServiceHostConfig](Set-SPServiceHostConfig.md)** | -**[Set-SPTimerJob](Set-SPTimerJob.md)** | -**[Start-SPAdminJob](Start-SPAdminJob.md)** | -**[Start-SPService](Start-SPService.md)** | -**[Start-SPServiceInstance](Start-SPServiceInstance.md)** | -**[Start-SPTimerJob](Start-SPTimerJob.md)** | -**[Stop-SPService](Stop-SPService.md)** | -**[Stop-SPServiceInstance](Stop-SPServiceInstance.md)** | -**[Uninstall-SPWebPartPack](Uninstall-SPWebPartPack.md)** | -**[Unpublish-SPServiceApplication](Unpublish-SPServiceApplication.md)** | - -## Farm and Sandbox Solutions -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPSolution](Add-SPSolution.md)** | -**[Add-SPUserSolution](Add-SPUserSolution.md)** | -**[Disable-SPUserSolutionAllowList](Disable-SPUserSolutionAllowList.md)** | -**[Enable-SPUserSolutionAllowList](Enable-SPUserSolutionAllowList.md)** | -**[Get-SPSolution](Get-SPSolution.md)** | -**[Get-SPUserSolution](Get-SPUserSolution.md)** | -**[Get-SPUserSolutionAllowList](Get-SPUserSolutionAllowList.md)** | -**[Install-SPSolution](Install-SPSolution.md)** | -**[Install-SPUserSolution](Install-SPUserSolution.md)** | -**[New-SPUserSolutionAllowList](New-SPUserSolutionAllowList.md)** | -**[Remove-SPSolution](Remove-SPSolution.md)** | -**[Remove-SPSolutionDeploymentLock](Remove-SPSolutionDeploymentLock.md)** | -**[Remove-SPUserSolution](Remove-SPUserSolution.md)** | -**[Uninstall-SPSolution](Uninstall-SPSolution.md)** | -**[Uninstall-SPUserSolution](Uninstall-SPUserSolution.md)** | -**[Update-SPSolution](Update-SPSolution.md)** | -**[Update-SPUserSolution](Update-SPUserSolution.md)** | - -## FAST Search Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-FASTSearchResource](Add-FASTSearchResource.md)** | -**[Add-FASTSearchSpelltuning](Add-FASTSearchSpelltuning.md)** | -**[Clear-FASTSearchContentCollection](Clear-FASTSearchContentCollection.md)** | -**[Get-FASTSearchContentCollection](Get-FASTSearchContentCollection.md)** | -**[Get-FASTSearchDocumentProcessingPipeline](Get-FASTSearchDocumentProcessingPipeline.md)** | -**[Get-FASTSearchMetadataCategory](Get-FASTSearchMetadataCategory.md)** | -**[Get-FASTSearchMetadataCrawledProperty](Get-FASTSearchMetadataCrawledProperty.md)** | -**[Get-FASTSearchMetadataCrawledPropertyMapping](Get-FASTSearchMetadataCrawledPropertyMapping.md)** | -**[Get-FASTSearchMetadataFullTextIndex](Get-FASTSearchMetadataFullTextIndex.md)** | -**[Get-FASTSearchMetadataFullTextIndexMapping](Get-FASTSearchMetadataFullTextIndexMapping.md)** | -**[Get-FASTSearchMetadataManagedProperty](Get-FASTSearchMetadataManagedProperty.md)** | -**[Get-FASTSearchMetadataRankProfile](Get-FASTSearchMetadataRankProfile.md)** | -**[Get-FASTSearchResource](Get-FASTSearchResource.md)** | -**[Get-FASTSearchSearchSettingGroup](Get-FASTSearchSearchSettingGroup.md)** | -**[Get-FASTSearchSecurityAliaser](Get-FASTSearchSecurityAliaser.md)** | -**[Get-FASTSearchSecurityCCTKServer](Get-FASTSearchSecurityCCTKServer.md)** | -**[Get-FASTSearchSecurityClaimsUserStore](Get-FASTSearchSecurityClaimsUserStore.md)** | -**[Get-FASTSearchSecurityCompleteGroupExpansion](Get-FASTSearchSecurityCompleteGroupExpansion.md)** | -**[Get-FASTSearchSecurityDecodedSid](Get-FASTSearchSecurityDecodedSid.md)** | -**[Get-FASTSearchSecurityDefaultUserStore](Get-FASTSearchSecurityDefaultUserStore.md)** | -**[Get-FASTSearchSecurityEncodedSid](Get-FASTSearchSecurityEncodedSid.md)** | -**[Get-FASTSearchSecurityGeneralSettings](Get-FASTSearchSecurityGeneralSettings.md)** | -**[Get-FASTSearchSecurityLogLevel](Get-FASTSearchSecurityLogLevel.md)** | -**[Get-FASTSearchSecurityLotusNotesUserStore](Get-FASTSearchSecurityLotusNotesUserStore.md)** | -**[Get-FASTSearchSecurityPublicFilter](Get-FASTSearchSecurityPublicFilter.md)** | -**[Get-FASTSearchSecurityRegexAliaser](Get-FASTSearchSecurityRegexAliaser.md)** | -**[Get-FASTSearchSecurityUserFilter](Get-FASTSearchSecurityUserFilter.md)** | -**[Get-FASTSearchSecurityUserStore](Get-FASTSearchSecurityUserStore.md)** | -**[Get-FASTSearchSecurityUserStoreGroupExpansion](Get-FASTSearchSecurityUserStoreGroupExpansion.md)** | -**[Get-FASTSearchSecurityWorkerNode](Get-FASTSearchSecurityWorkerNode.md)** | -**[Get-FASTSearchSecurityXMLAliaser](Get-FASTSearchSecurityXMLAliaser.md)** | -**[Get-FASTSearchSpelltuningStatus](Get-FASTSearchSpelltuningStatus.md)** | -**[Install-FASTSearchAdminDatabase](Install-FASTSearchAdminDatabase.md)** | -**[New-FASTSearchContentCollection](New-FASTSearchContentCollection.md)** | -**[New-FASTSearchMetadataCategory](New-FASTSearchMetadataCategory.md)** | -**[New-FASTSearchMetadataCrawledProperty](New-FASTSearchMetadataCrawledProperty.md)** | -**[New-FASTSearchMetadataCrawledPropertyMapping](New-FASTSearchMetadataCrawledPropertyMapping.md)** | -**[New-FASTSearchMetadataFullTextIndex](New-FASTSearchMetadataFullTextIndex.md)** | -**[New-FASTSearchMetadataFullTextIndexMapping](New-FASTSearchMetadataFullTextIndexMapping.md)** | -**[New-FASTSearchMetadataManagedProperty](New-FASTSearchMetadataManagedProperty.md)** | -**[New-FASTSearchMetadataRankProfile](New-FASTSearchMetadataRankProfile.md)** | -**[New-FASTSearchSearchSettingGroup](New-FASTSearchSearchSettingGroup.md)** | -**[New-FASTSearchSecurityClaimsUserStore](New-FASTSearchSecurityClaimsUserStore.md)** | -**[New-FASTSearchSecurityLotusNotesUserStore](New-FASTSearchSecurityLotusNotesUserStore.md)** | -**[New-FASTSearchSecurityRegexAliaser](New-FASTSearchSecurityRegexAliaser.md)** | -**[New-FASTSearchSecurityRegexAliaserPattern](New-FASTSearchSecurityRegexAliaserPattern.md)** | -**[New-FASTSearchSecurityXMLAliaser](New-FASTSearchSecurityXMLAliaser.md)** | -**[Remove-FASTSearchContentCollection](Remove-FASTSearchContentCollection.md)** | -**[Remove-FASTSearchMetadataCategory](Remove-FASTSearchMetadataCategory.md)** | -**[Remove-FASTSearchMetadataCrawledPropertyMapping](Remove-FASTSearchMetadataCrawledPropertyMapping.md)** | -**[Remove-FASTSearchMetadataFullTextIndex](Remove-FASTSearchMetadataFullTextIndex.md)** | -**[Remove-FASTSearchMetadataFullTextIndexMapping](Remove-FASTSearchMetadataFullTextIndexMapping.md)** | -**[Remove-FASTSearchMetadataManagedProperty](Remove-FASTSearchMetadataManagedProperty.md)** | -**[Remove-FASTSearchMetadataRankProfile](Remove-FASTSearchMetadataRankProfile.md)** | -**[Remove-FASTSearchResource](Remove-FASTSearchResource.md)** | -**[Remove-FASTSearchSearchSettingGroup](Remove-FASTSearchSearchSettingGroup.md)** | -**[Remove-FASTSearchSecurityAliaser](Remove-FASTSearchSecurityAliaser.md)** | -**[Remove-FASTSearchSecurityUserStore](Remove-FASTSearchSecurityUserStore.md)** | -**[Remove-FASTSearchSpelltuning](Remove-FASTSearchSpelltuning.md)** | -**[Set-FASTSearchConfiguration](Set-FASTSearchConfiguration.md)** | -**[Set-FASTSearchIPSec](Set-FASTSearchIPSec.md)** | -**[Set-FASTSearchMetadataCategory](Set-FASTSearchMetadataCategory.md)** | -**[Set-FASTSearchMetadataCrawledProperty](Set-FASTSearchMetadataCrawledProperty.md)** | -**[Set-FASTSearchMetadataCrawledPropertyMapping](Set-FASTSearchMetadataCrawledPropertyMapping.md)** | -**[Set-FASTSearchMetadataFullTextIndex](Set-FASTSearchMetadataFullTextIndex.md)** | -**[Set-FASTSearchMetadataFullTextIndexMapping](Set-FASTSearchMetadataFullTextIndexMapping.md)** | -**[Set-FASTSearchMetadataManagedProperty](Set-FASTSearchMetadataManagedProperty.md)** | -**[Set-FASTSearchMetadataRankProfile](Set-FASTSearchMetadataRankProfile.md)** | -**[Set-FASTSearchSecurityCCTKServer](Set-FASTSearchSecurityCCTKServer.md)** | -**[Set-FASTSearchSecurityClaimsUserStore](Set-FASTSearchSecurityClaimsUserStore.md)** | -**[Set-FASTSearchSecurityDefaultUserStore](Set-FASTSearchSecurityDefaultUserStore.md)** | -**[Set-FASTSearchSecurityLogLevel](Set-FASTSearchSecurityLogLevel.md)** | -**[Set-FASTSearchSecurityLotusNotesUserStore](Set-FASTSearchSecurityLotusNotesUserStore.md)** | -**[Set-FASTSearchSecurityPublicFilter](Set-FASTSearchSecurityPublicFilter.md)** | -**[Set-FASTSearchSecurityRegexAliaser](Set-FASTSearchSecurityRegexAliaser.md)** | -**[Set-FASTSearchSecurityXMLAliaser](Set-FASTSearchSecurityXMLAliaser.md)** | -**[Uninstall-FASTSearchAdminDatabase](Uninstall-FASTSearchAdminDatabase.md)** | - -## Feature -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Disable-SPFeature](Disable-SPFeature.md)** | -**[Enable-SPFeature](Enable-SPFeature.md)** | -**[Get-SPFeature](Get-SPFeature.md)** | -**[Install-SPFeature](Install-SPFeature.md)** | -**[Uninstall-SPFeature](Uninstall-SPFeature.md)** | - -## Hybrid and Migration -Cmdlet|Description|Platform -:-----|:----------|:------- -**[ConvertTo-SPOMigrationEncryptedPackage](ConvertTo-SPOMigrationEncryptedPackage.md)** | -**[ConvertTo-SPOMigrationTargetedPackage](ConvertTo-SPOMigrationTargetedPackage.md)** | -**[Copy-SPContentTypes](Copy-SPContentTypes.md)** | -**[Get-SPInsightsConfig](Get-SPInsightsConfig.md)** | -**[New-SPAzureAccessControlServiceApplicationProxy](New-SPAzureAccessControlServiceApplicationProxy.md)** | -**[Stop-SPContentTypeReplication](Stop-SPContentTypeReplication.md)** | - -## Identity (General) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPClaimTypeMapping](Add-SPClaimTypeMapping.md)** | -**[Get-SPClaimProvider](Get-SPClaimProvider.md)** | -**[Get-SPClaimProviderManager](Get-SPClaimProviderManager.md)** | -**[Get-SPClaimTypeEncoding](Get-SPClaimTypeEncoding.md)** | -**[Get-SPUser](Get-SPUser.md)** | -**[Move-SPUser](Move-SPUser.md)** | -**[New-SPClaimProvider](New-SPClaimProvider.md)** | -**[New-SPClaimsPrincipal](New-SPClaimsPrincipal.md)** | -**[New-SPClaimTypeEncoding](New-SPClaimTypeEncoding.md)** | -**[New-SPClaimTypeMapping](New-SPClaimTypeMapping.md)** | -**[New-SPManagedAccount](New-SPManagedAccount.md)** | -**[New-SPUser](New-SPUser.md)** | -**[Remove-SPClaimProvider](Remove-SPClaimProvider.md)** | -**[Remove-SPClaimTypeMapping](Remove-SPClaimTypeMapping.md)** | -**[Remove-SPManagedAccount](Remove-SPManagedAccount.md)** | -**[Remove-SPUser](Remove-SPUser.md)** | -**[Set-SPClaimProvider](Set-SPClaimProvider.md)** | -**[Set-SPUser](Set-SPUser.md)** | - -## InfoPath Forms Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPInfoPathUserAgent](Add-SPInfoPathUserAgent.md)** | -**[Disable-SPInfoPathFormTemplate](Disable-SPInfoPathFormTemplate.md)** | -**[Enable-SPInfoPathFormTemplate](Enable-SPInfoPathFormTemplate.md)** | -**[Export-SPInfoPathAdministrationFiles](Export-SPInfoPathAdministrationFiles.md)** | -**[Get-SPDataConnectionFile](Get-SPDataConnectionFile.md)** | -**[Get-SPDataConnectionFileDependent](Get-SPDataConnectionFileDependent.md)** | -**[Get-SPInfoPathFormsService](Get-SPInfoPathFormsService.md)** | -**[Get-SPInfoPathFormTemplate](Get-SPInfoPathFormTemplate.md)** | -**[Get-SPInfoPathUserAgent](Get-SPInfoPathUserAgent.md)** | -**[Get-SPInfoPathWebServiceProxy](Get-SPInfoPathWebServiceProxy.md)** | -**[Import-SPInfoPathAdministrationFiles](Import-SPInfoPathAdministrationFiles.md)** | -**[Install-SPDataConnectionFile](Install-SPDataConnectionFile.md)** | -**[Install-SPInfoPathFormTemplate](Install-SPInfoPathFormTemplate.md)** | -**[Remove-SPInfoPathUserAgent](Remove-SPInfoPathUserAgent.md)** | -**[Set-SPDataConnectionFile](Set-SPDataConnectionFile.md)** | -**[Set-SPInfoPathFormsService](Set-SPInfoPathFormsService.md)** | -**[Set-SPInfoPathFormTemplate](Set-SPInfoPathFormTemplate.md)** | -**[Set-SPInfoPathWebServiceProxy](Set-SPInfoPathWebServiceProxy.md)** | -**[Start-SPInfoPathFormTemplate](Start-SPInfoPathFormTemplate.md)** | -**[Stop-SPInfoPathFormTemplate](Stop-SPInfoPathFormTemplate.md)** | -**[Test-SPInfoPathFormTemplate](Test-SPInfoPathFormTemplate.md)** | -**[Uninstall-SPDataConnectionFile](Uninstall-SPDataConnectionFile.md)** | -**[Uninstall-SPInfoPathFormTemplate](Uninstall-SPInfoPathFormTemplate.md)** | -**[Update-SPInfoPathAdminFileUrl](Update-SPInfoPathAdminFileUrl.md)** | -**[Update-SPInfoPathFormTemplate](Update-SPInfoPathFormTemplate.md)** | -**[Update-SPInfoPathUserFileUrl](Update-SPInfoPathUserFileUrl.md)** | - -## Installation and Upgrade -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Connect-SPConfigurationDatabase](Connect-SPConfigurationDatabase.md)** | -**[Copy-SPSideBySideFiles](Copy-SPSideBySideFiles.md)** | -**[Disconnect-SPConfigurationDatabase](Disconnect-SPConfigurationDatabase.md)** | -**[Get-SPPendingUpgradeActions](Get-SPPendingUpgradeActions.md)** | -**[Get-SPUpgradeActions](Get-SPUpgradeActions.md)** | -**[Initialize-SPResourceSecurity](Initialize-SPResourceSecurity.md)** | -**[Install-SPApplicationContent](Install-SPApplicationContent.md)** | -**[Install-SPHelpCollection](Install-SPHelpCollection.md)** | -**[Install-SPService](Install-SPService.md)** | -**[New-SPCentralAdministration](New-SPCentralAdministration.md)** | -**[New-SPConfigurationDatabase](New-SPConfigurationDatabase.md)** | -**[Remove-SPCentralAdministration](Remove-SPCentralAdministration.md)** | -**[Remove-SPConfigurationDatabase](Remove-SPConfigurationDatabase.md)** | -**[Set-SPCentralAdministration](Set-SPCentralAdministration.md)** | -**[Set-SPServer](Set-SPServer.md)** | -**[Set-SPPassPhrase](Set-SPPassPhrase.md)** | -**[Uninstall-SPHelpCollection](Uninstall-SPHelpCollection.md)** | -**[Upgrade-SPFarm](Upgrade-SPFarm.md)** | -**[Update-SPFarmEncryptionKey](Update-SPFarmEncryptionKey.md)** | - -## Machine Translation Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPTranslationThrottlingSetting](Get-SPTranslationThrottlingSetting.md)** | -**[New-SPTranslationServiceApplication](New-SPTranslationServiceApplication.md)** | -**[New-SPTranslationServiceApplicationProxy](New-SPTranslationServiceApplicationProxy.md)** | -**[Remove-SPTranslationServiceJobHistory](Remove-SPTranslationServiceJobHistory.md)** | -**[Set-SPTranslationServiceApplication](Set-SPTranslationServiceApplication.md)** | -**[Set-SPTranslationServiceApplicationProxy](Set-SPTranslationServiceApplicationProxy.md)** | -**[Set-SPTranslationThrottlingSetting](Set-SPTranslationThrottlingSetting.md)** | - -## Managed Account -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPManagedAccount](Get-SPManagedAccount.md)** | -**[Set-SPManagedAccount](Set-SPManagedAccount.md)** | -**[Repair-SPManagedAccountDeployment](Repair-SPManagedAccountDeployment.md)** | - -## Managed Metadata Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Export-SPMetadataWebServicePartitionData](Export-SPMetadataWebServicePartitionData.md)** | -**[Copy-SPTaxonomyGroups](Copy-SPTaxonomyGroups.md)** | -**[Get-SPMetadataServiceApplication](Get-SPMetadataServiceApplication.md)** | -**[Get-SPMetadataServiceApplicationProxy](Get-SPMetadataServiceApplicationProxy.md)** | -**[Get-SPTaxonomySession](Get-SPTaxonomySession.md)** | -**[Import-SPMetadataWebServicePartitionData](Import-SPMetadataWebServicePartitionData.md)** | -**[Move-SPProfileManagedMetadataProperty](Move-SPProfileManagedMetadataProperty.md)** | -**[New-SPMetadataServiceApplication](New-SPMetadataServiceApplication.md)** | -**[New-SPMetadataServiceApplicationProxy](New-SPMetadataServiceApplicationProxy.md)** | -**[Set-SPMetadataServiceApplication](Set-SPMetadataServiceApplication.md)** | -**[Set-SPMetadataServiceApplicationProxy](Set-SPMetadataServiceApplicationProxy.md)** | -**[Stop-SPTaxonomyReplication](Stop-SPTaxonomyReplication.md)** | - -## Office Web Apps/Office Online Server -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPWOPIBinding](Get-SPWOPIBinding.md)** | -**[Get-SPWOPISuppressionSetting](Get-SPWOPISuppressionSetting.md)** | -**[Get-SPWOPIZone](Get-SPWOPIZone.md)** | -**[New-SPWOPIBinding](New-SPWOPIBinding.md)** | -**[New-SPWOPISuppressionSetting](New-SPWOPISuppressionSetting.md)** | -**[Remove-SPWOPIBinding](Remove-SPWOPIBinding.md)** | -**[Remove-SPWOPISuppressionSetting](Remove-SPWOPISuppressionSetting.md)** | -**[Set-SPWOPIBinding](Set-SPWOPIBinding.md)** | -**[Set-SPWOPIZone](Set-SPWOPIZone.md)** | -**[Update-SPWOPIProofKey](Update-SPWOPIProofKey.md)** | - -## PerformancePoint Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Clear-SPPerformancePointServiceApplicationTrustedLocation](Clear-SPPerformancePointServiceApplicationTrustedLocation.md)** | -**[Export-SPPerformancePointContent](Export-SPPerformancePointContent.md)** | -**[Get-SPPerformancePointServiceApplication](Get-SPPerformancePointServiceApplication.md)** | -**[Get-SPPerformancePointServiceApplicationTrustedLocation](Get-SPPerformancePointServiceApplicationTrustedLocation.md)** | -**[Import-SPPerformancePointContent](Import-SPPerformancePointContent.md)** | -**[New-SPPerformancePointServiceApplication](New-SPPerformancePointServiceApplication.md)** | -**[New-SPPerformancePointServiceApplicationProxy](New-SPPerformancePointServiceApplicationProxy.md)** | -**[New-SPPerformancePointServiceApplicationTrustedLocation](New-SPPerformancePointServiceApplicationTrustedLocation.md)** | -**[Remove-SPPerformancePointServiceApplication](Remove-SPPerformancePointServiceApplication.md)** | -**[Remove-SPPerformancePointServiceApplicationProxy](Remove-SPPerformancePointServiceApplicationProxy.md)** | -**[Remove-SPPerformancePointServiceApplicationTrustedLocation](Remove-SPPerformancePointServiceApplicationTrustedLocation.md)** | -**[Set-SPPerformancePointSecureDataValues](Set-SPPerformancePointSecureDataValues.md)** | -**[Set-SPPerformancePointServiceApplication](Set-SPPerformancePointServiceApplication.md)** | - -## PowerPoint Conversion Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New-SPPowerPointConversionServiceApplication](New-SPPowerPointConversionServiceApplication.md)** | -**[New-SPPowerPointConversionServiceApplicationProxy](New-SPPowerPointConversionServiceApplicationProxy.md)** | -**[Set-SPPowerPointConversionServiceApplication](Set-SPPowerPointConversionServiceApplication.md)** | - -## PowerShell (General) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Start-SPAssignment](Start-SPAssignment.md)** | -**[Stop-SPAssignment](Stop-SPAssignment.md)** | -**[Update-SPHelp](Update-SPHelp.md)** | - -## Project Server -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md)** | -**[Disable-SPProjectEmailNotification](Disable-SPProjectEmailNotification.md)** | -**[Disable-SPProjectEnterpriseProjectTaskSync](Disable-SPProjectEnterpriseProjectTaskSync.md)** | -**[Disable-SPProjectQueueStatsMonitoring](Disable-SPProjectQueueStatsMonitoring.md)** | -**[Disable-ProjectServerLicense](Disable-ProjectServerLicense.md)** | -**[Enable-ProjectServerLicense](Enable-ProjectServerLicense.md)** | -**[Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md)** | -**[Enable-SPProjectEmailNotification](Enable-SPProjectEmailNotification.md)** | -**[Enable-SPProjectEnterpriseProjectTaskSync](Enable-SPProjectEnterpriseProjectTaskSync.md)** | -**[Enable-SPProjectQueueStatsMonitoring](Enable-SPProjectQueueStatsMonitoring.md)** | -**[Get-ProjectServerLicense](Get-ProjectServerLicense.md)** | -**[Get-SPProjectDatabaseQuota](Get-SPProjectDatabaseQuota.md)** | -**[Get-SPProjectDatabaseUsage](Get-SPProjectDatabaseUsage.md)** | -**[Get-SPProjectEnterpriseProjectTaskSync](Get-SPProjectEnterpriseProjectTaskSync.md)** | -**[Get-SPProjectEventServiceSettings](Get-SPProjectEventServiceSettings.md)** | -**[Get-SPProjectIsEmailNotificationEnabled](Get-SPProjectIsEmailNotificationEnabled.md)** | -**[Get-SPProjectOdataConfiguration](Get-SPProjectOdataConfiguration.md)** | -**[Get-SPProjectPCSSettings](Get-SPProjectPCSSettings.md)** | -**[Get-SPProjectPermissionMode](Get-SPProjectPermissionMode.md)** | -**[Get-SPProjectQueueSettings](Get-SPProjectQueueSettings.md)** | -**[Get-SPProjectWebInstance](Get-SPProjectWebInstance.md)** | -**[Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync](Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md)** | -**[Invoke-SPProjectActiveDirectoryGroupSync](Invoke-SPProjectActiveDirectoryGroupSync.md)** | -**[Migrate-SPProjectDatabase](Migrate-SPProjectDatabase.md)** | -**[Migrate-SPProjectResourcePlans](Migrate-SPProjectResourcePlans.md)** | -**[New-SPProjectServiceApplication](New-SPProjectServiceApplication.md)** | -**[New-SPProjectServiceApplicationProxy](New-SPProjectServiceApplicationProxy.md)** | -**[Pause-SPProjectWebInstance](Pause-SPProjectWebInstance.md)** | -**[Remove-SPProjectWebInstanceData](Remove-SPProjectWebInstanceData.md)** | -**[Repair-SPProjectWebInstance](Repair-SPProjectWebInstance.md)** | -**[Reset-SPProjectEventServiceSettings](Reset-SPProjectEventServiceSettings.md)** | -**[Reset-SPProjectPCSSettings](Reset-SPProjectPCSSettings.md)** | -**[Reset-SPProjectQueueSettings](Reset-SPProjectQueueSettings.md)** | -**[Resume-SPProjectWebInstance](Resume-SPProjectWebInstance.md)** | -**[Set-SPProjectDatabaseQuota](Set-SPProjectDatabaseQuota.md)** | -**[Set-SPProjectEventServiceSettings](Set-SPProjectEventServiceSettings.md)** | -**[Set-SPProjectOdataConfiguration](Set-SPProjectOdataConfiguration.md)** | -**[Set-SPProjectPCSSettings](Set-SPProjectPCSSettings.md)** | -**[Set-SPProjectPermissionMode](Set-SPProjectPermissionMode.md)** | -**[Set-SPProjectQueueSettings](Set-SPProjectQueueSettings.md)** | -**[Set-SPProjectServiceApplication](Set-SPProjectServiceApplication.md)** | -**[Set-SPProjectUserSync](Set-SPProjectUserSync.md)** | -**[Set-SPProjectUserSyncDisabledSyncThreshold](Set-SPProjectUserSyncDisabledSyncThreshold.md)** | -**[Set-SPProjectUserSyncFullSyncThreshold](Set-SPProjectUserSyncFullSyncThreshold.md)** | -**[Set-SPProjectUserSyncOffPeakSyncThreshold](Set-SPProjectUserSyncOffPeakSyncThreshold.md)** | -**[Start-SPProjectGenerateWsdl](Start-SPProjectGenerateWsdl.md)** | -**[Sync-SPProjectPermissions](Sync-SPProjectPermissions.md)** | -**[Test-SPProjectServiceApplication](Test-SPProjectServiceApplication.md)** | -**[Test-SPProjectWebInstance](Test-SPProjectWebInstance.md)** | - -## Request Management -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPThrottlingRule](Add-SPThrottlingRule.md)** | -**[Get-SPRequestManagementSettings](Get-SPRequestManagementSettings.md)** | -**[Add-SPRoutingMachineInfo](Add-SPRoutingMachineInfo.md)** | -**[Add-SPRoutingMachinePool](Add-SPRoutingMachinePool.md)** | -**[Add-SPRoutingRule](Add-SPRoutingRule.md)** | -**[Get-SPRoutingMachineInfo](Get-SPRoutingMachineInfo.md)** | -**[Get-SPRoutingMachinePool](Get-SPRoutingMachinePool.md)** | -**[Get-SPRoutingRule](Get-SPRoutingRule.md)** | -**[Get-SPThrottlingRule](Get-SPThrottlingRule.md)** | -**[New-SPRequestManagementRuleCriteria](New-SPRequestManagementRuleCriteria.md)** | -**[Remove-SPRoutingMachineInfo](Remove-SPRoutingMachineInfo.md)** | -**[Remove-SPRoutingMachinePool](Remove-SPRoutingMachinePool.md)** | -**[Remove-SPRoutingRule](Remove-SPRoutingRule.md)** | -**[Remove-SPThrottlingRule](Remove-SPThrottlingRule.md)** | -**[Set-SPRequestManagementSettings](Set-SPRequestManagementSettings.md)** | -**[Set-SPRoutingMachineInfo](Set-SPRoutingMachineInfo.md)** | -**[Set-SPRoutingMachinePool](Set-SPRoutingMachinePool.md)** | -**[Set-SPRoutingRule](Set-SPRoutingRule.md)** | -**[Set-SPThrottlingRule](Set-SPThrottlingRule.md)** | - -## Search Service Application -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Backup-SPEnterpriseSearchServiceApplicationIndex](Backup-SPEnterpriseSearchServiceApplicationIndex.md)** | -**[Export-SPEnterpriseSearchTopology](Export-SPEnterpriseSearchTopology.md)** | -**[Get-SPEnterpriseSearchAdministrationComponent](Get-SPEnterpriseSearchAdministrationComponent.md)** | -**[Get-SPEnterpriseSearchComponent](Get-SPEnterpriseSearchComponent.md)** | -**[Get-SPEnterpriseSearchContentEnrichmentConfiguration](Get-SPEnterpriseSearchContentEnrichmentConfiguration.md)** | -**[Get-SPEnterpriseSearchCrawlContentSource](Get-SPEnterpriseSearchCrawlContentSource.md)** | -**[Get-SPEnterpriseSearchCrawlCustomConnector](Get-SPEnterpriseSearchCrawlCustomConnector.md)** | -**[Get-SPEnterpriseSearchCrawlDatabase](Get-SPEnterpriseSearchCrawlDatabase.md)** | -**[Get-SPEnterpriseSearchCrawlExtension](Get-SPEnterpriseSearchCrawlExtension.md)** | -**[Get-SPEnterpriseSearchCrawlLogReadPermission](Get-SPEnterpriseSearchCrawlLogReadPermission.md)** | -**[Get-SPEnterpriseSearchCrawlMapping](Get-SPEnterpriseSearchCrawlMapping.md)** | -**[Get-SPEnterpriseSearchCrawlRule](Get-SPEnterpriseSearchCrawlRule.md)** | -**[Get-SPEnterpriseSearchFileFormat](Get-SPEnterpriseSearchFileFormat.md)** | -**[Get-SPEnterpriseSearchHostController](Get-SPEnterpriseSearchHostController.md)** | -**[Get-SPEnterpriseSearchLanguageResourcePhrase](Get-SPEnterpriseSearchLanguageResourcePhrase.md)** | -**[Get-SPEnterpriseSearchLinguisticComponentsStatus](Get-SPEnterpriseSearchLinguisticComponentsStatus.md)** | -**[Get-SPEnterpriseSearchLinksDatabase](Get-SPEnterpriseSearchLinksDatabase.md)** | -**[Get-SPEnterpriseSearchMetadataCategory](Get-SPEnterpriseSearchMetadataCategory.md)** | -**[Get-SPEnterpriseSearchMetadataCrawledProperty](Get-SPEnterpriseSearchMetadataCrawledProperty.md)** | -**[Get-SPEnterpriseSearchMetadataManagedProperty](Get-SPEnterpriseSearchMetadataManagedProperty.md)** | -**[Get-SPEnterpriseSearchMetadataMapping](Get-SPEnterpriseSearchMetadataMapping.md)** | -**[Get-SPEnterpriseSearchOwner](Get-SPEnterpriseSearchOwner.md)** | -**[Get-SPEnterpriseSearchPropertyRule](Get-SPEnterpriseSearchPropertyRule.md)** | -**[Get-SPEnterpriseSearchPropertyRuleCollection](Get-SPEnterpriseSearchPropertyRuleCollection.md)** | -**[Get-SPEnterpriseSearchQueryAndSiteSettingsService](Get-SPEnterpriseSearchQueryAndSiteSettingsService.md)** | -**[Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance](Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md)** | -**[Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy](Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md)** | -**[Get-SPEnterpriseSearchQueryAuthority](Get-SPEnterpriseSearchQueryAuthority.md)** | -**[Get-SPEnterpriseSearchQueryDemoted](Get-SPEnterpriseSearchQueryDemoted.md)** | -**[Get-SPEnterpriseSearchQueryKeyword](Get-SPEnterpriseSearchQueryKeyword.md)** | -**[Get-SPEnterpriseSearchQueryScope](Get-SPEnterpriseSearchQueryScope.md)** | -**[Get-SPEnterpriseSearchQueryScopeRule](Get-SPEnterpriseSearchQueryScopeRule.md)** | -**[Get-SPEnterpriseSearchQuerySpellingCorrection](Get-SPEnterpriseSearchQuerySpellingCorrection.md)** | -**[Get-SPEnterpriseSearchQuerySuggestionCandidates](Get-SPEnterpriseSearchQuerySuggestionCandidates.md)** | -**[Get-SPEnterpriseSearchRankingModel](Get-SPEnterpriseSearchRankingModel.md)** | -**[Get-SPEnterpriseSearchResultItemType](Get-SPEnterpriseSearchResultItemType.md)** | -**[Get-SPEnterpriseSearchResultSource](Get-SPEnterpriseSearchResultSource.md)** | -**[Get-SPEnterpriseSearchSecurityTrimmer](Get-SPEnterpriseSearchSecurityTrimmer.md)** | -**[Get-SPEnterpriseSearchService](Get-SPEnterpriseSearchService.md)** | -**[Get-SPEnterpriseSearchServiceApplication](Get-SPEnterpriseSearchServiceApplication.md)** | -**[Get-SPEnterpriseSearchServiceApplicationBackupStore](Get-SPEnterpriseSearchServiceApplicationBackupStore.md)** | -**[Get-SPEnterpriseSearchServiceApplicationProxy](Get-SPEnterpriseSearchServiceApplicationProxy.md)** | -**[Get-SPEnterpriseSearchServiceInstance](Get-SPEnterpriseSearchServiceInstance.md)** | -**[Get-SPEnterpriseSearchSiteHitRule](Get-SPEnterpriseSearchSiteHitRule.md)** | -**[Get-SPEnterpriseSearchStatus](Get-SPEnterpriseSearchStatus.md)** | -**[Get-SPEnterpriseSearchTopology](Get-SPEnterpriseSearchTopology.md)** | -**[Get-SPEnterpriseSearchVssDataPath](Get-SPEnterpriseSearchVssDataPath.md)** | -**[Import-SPEnterpriseSearchCustomExtractionDictionary](Import-SPEnterpriseSearchCustomExtractionDictionary.md)** | -**[Import-SPEnterpriseSearchPopularQueries](Import-SPEnterpriseSearchPopularQueries.md)** | -**[Import-SPEnterpriseSearchThesaurus](Import-SPEnterpriseSearchThesaurus.md)** | -**[Import-SPEnterpriseSearchTopology](Import-SPEnterpriseSearchTopology.md)** | -**[Move-SPEnterpriseSearchLinksDatabases](Move-SPEnterpriseSearchLinksDatabases.md)** | -**[New-SPEnterpriseSearchAdminComponent](New-SPEnterpriseSearchAdminComponent.md)** | -**[New-SPEnterpriseSearchAnalyticsProcessingComponent](New-SPEnterpriseSearchAnalyticsProcessingComponent.md)** | -**[New-SPEnterpriseSearchContentEnrichmentConfiguration](New-SPEnterpriseSearchContentEnrichmentConfiguration.md)** | -**[New-SPEnterpriseSearchContentProcessingComponent](New-SPEnterpriseSearchContentProcessingComponent.md)** | -**[New-SPEnterpriseSearchCrawlComponent](New-SPEnterpriseSearchCrawlComponent.md)** | -**[New-SPEnterpriseSearchCrawlContentSource](New-SPEnterpriseSearchCrawlContentSource.md)** | -**[New-SPEnterpriseSearchCrawlCustomConnector](New-SPEnterpriseSearchCrawlCustomConnector.md)** | -**[New-SPEnterpriseSearchCrawlDatabase](New-SPEnterpriseSearchCrawlDatabase.md)** | -**[New-SPEnterpriseSearchCrawlExtension](New-SPEnterpriseSearchCrawlExtension.md)** | -**[New-SPEnterpriseSearchCrawlMapping](New-SPEnterpriseSearchCrawlMapping.md)** | -**[New-SPEnterpriseSearchCrawlRule](New-SPEnterpriseSearchCrawlRule.md)** | -**[New-SPEnterpriseSearchFileFormat](New-SPEnterpriseSearchFileFormat.md)** | -**[New-SPEnterpriseSearchIndexComponent](New-SPEnterpriseSearchIndexComponent.md)** | -**[New-SPEnterpriseSearchLanguageResourcePhrase](New-SPEnterpriseSearchLanguageResourcePhrase.md)** | -**[New-SPEnterpriseSearchLinksDatabase](New-SPEnterpriseSearchLinksDatabase.md)** | -**[New-SPEnterpriseSearchMetadataCategory](New-SPEnterpriseSearchMetadataCategory.md)** | -**[New-SPEnterpriseSearchMetadataCrawledProperty](New-SPEnterpriseSearchMetadataCrawledProperty.md)** | -**[New-SPEnterpriseSearchMetadataManagedProperty](New-SPEnterpriseSearchMetadataManagedProperty.md)** | -**[New-SPEnterpriseSearchMetadataMapping](New-SPEnterpriseSearchMetadataMapping.md)** | -**[New-SPEnterpriseSearchQueryAuthority](New-SPEnterpriseSearchQueryAuthority.md)** | -**[New-SPEnterpriseSearchQueryDemoted](New-SPEnterpriseSearchQueryDemoted.md)** | -**[New-SPEnterpriseSearchQueryKeyword](New-SPEnterpriseSearchQueryKeyword.md)** | -**[New-SPEnterpriseSearchQueryProcessingComponent](New-SPEnterpriseSearchQueryProcessingComponent.md)** | -**[New-SPEnterpriseSearchQueryScope](New-SPEnterpriseSearchQueryScope.md)** | -**[New-SPEnterpriseSearchQueryScopeRule](New-SPEnterpriseSearchQueryScopeRule.md)** | -**[New-SPEnterpriseSearchRankingModel](New-SPEnterpriseSearchRankingModel.md)** | -**[New-SPEnterpriseSearchResultItemType](New-SPEnterpriseSearchResultItemType.md)** | -**[New-SPEnterpriseSearchResultSource](New-SPEnterpriseSearchResultSource.md)** | -**[New-SPEnterpriseSearchSecurityTrimmer](New-SPEnterpriseSearchSecurityTrimmer.md)** | -**[New-SPEnterpriseSearchServiceApplication](New-SPEnterpriseSearchServiceApplication.md)** | -**[New-SPEnterpriseSearchServiceApplicationProxy](New-SPEnterpriseSearchServiceApplicationProxy.md)** | -**[New-SPEnterpriseSearchSiteHitRule](New-SPEnterpriseSearchSiteHitRule.md)** | -**[New-SPEnterpriseSearchTopology](New-SPEnterpriseSearchTopology.md)** | -**[Remove-SPEnterpriseSearchComponent](Remove-SPEnterpriseSearchComponent.md)** | -**[Remove-SPEnterpriseSearchContentEnrichmentConfiguration](Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md)** | -**[Remove-SPEnterpriseSearchCrawlContentSource](Remove-SPEnterpriseSearchCrawlContentSource.md)** | -**[Remove-SPEnterpriseSearchCrawlCustomConnector](Remove-SPEnterpriseSearchCrawlCustomConnector.md)** | -**[Remove-SPEnterpriseSearchCrawlDatabase](Remove-SPEnterpriseSearchCrawlDatabase.md)** | -**[Remove-SPEnterpriseSearchCrawlExtension](Remove-SPEnterpriseSearchCrawlExtension.md)** | -**[Remove-SPEnterpriseSearchCrawlLogReadPermission](Remove-SPEnterpriseSearchCrawlLogReadPermission.md)** | -**[Remove-SPEnterpriseSearchCrawlMapping](Remove-SPEnterpriseSearchCrawlMapping.md)** | -**[Remove-SPEnterpriseSearchCrawlRule](Remove-SPEnterpriseSearchCrawlRule.md)** | -**[Remove-SPEnterpriseSearchFileFormat](Remove-SPEnterpriseSearchFileFormat.md)** | -**[Remove-SPEnterpriseSearchLanguageResourcePhrase](Remove-SPEnterpriseSearchLanguageResourcePhrase.md)** | -**[Remove-SPEnterpriseSearchLinksDatabase](Remove-SPEnterpriseSearchLinksDatabase.md)** | -**[Remove-SPEnterpriseSearchMetadataCategory](Remove-SPEnterpriseSearchMetadataCategory.md)** | -**[Remove-SPEnterpriseSearchMetadataManagedProperty](Remove-SPEnterpriseSearchMetadataManagedProperty.md)** | -**[Remove-SPEnterpriseSearchMetadataMapping](Remove-SPEnterpriseSearchMetadataMapping.md)** | -**[Remove-SPEnterpriseSearchQueryAuthority](Remove-SPEnterpriseSearchQueryAuthority.md)** | -**[Remove-SPEnterpriseSearchQueryDemoted](Remove-SPEnterpriseSearchQueryDemoted.md)** | -**[Remove-SPEnterpriseSearchQueryKeyword](Remove-SPEnterpriseSearchQueryKeyword.md)** | -**[Remove-SPEnterpriseSearchQueryScope](Remove-SPEnterpriseSearchQueryScope.md)** | -**[Remove-SPEnterpriseSearchQueryScopeRule](Remove-SPEnterpriseSearchQueryScopeRule.md)** | -**[Remove-SPEnterpriseSearchRankingModel](Remove-SPEnterpriseSearchRankingModel.md)** | -**[Remove-SPEnterpriseSearchResultItemType](Remove-SPEnterpriseSearchResultItemType.md)** | -**[Remove-SPEnterpriseSearchResultSource](Remove-SPEnterpriseSearchResultSource.md)** | -**[Remove-SPEnterpriseSearchSecurityTrimmer](Remove-SPEnterpriseSearchSecurityTrimmer.md)** | -**[Remove-SPEnterpriseSearchServiceApplication](Remove-SPEnterpriseSearchServiceApplication.md)** | -**[Remove-SPEnterpriseSearchServiceApplicationProxy](Remove-SPEnterpriseSearchServiceApplicationProxy.md)** | -**[Remove-SPEnterpriseSearchServiceApplicationSiteSettings](Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md)** | -**[Remove-SPEnterpriseSearchSiteHitRule](Remove-SPEnterpriseSearchSiteHitRule.md)** | -**[Remove-SPEnterpriseSearchTenantConfiguration](Remove-SPEnterpriseSearchTenantConfiguration.md)** | -**[Remove-SPEnterpriseSearchTenantSchema](Remove-SPEnterpriseSearchTenantSchema.md)** | -**[Remove-SPEnterpriseSearchTopology](Remove-SPEnterpriseSearchTopology.md)** | -**[Restore-SPEnterpriseSearchServiceApplication](Restore-SPEnterpriseSearchServiceApplication.md)** | -**[Restore-SPEnterpriseSearchServiceApplicationIndex](Restore-SPEnterpriseSearchServiceApplicationIndex.md)** | -**[Resume-SPEnterpriseSearchServiceApplication](Resume-SPEnterpriseSearchServiceApplication.md)** | -**[Set-SPEnterpriseSearchAdministrationComponent](Set-SPEnterpriseSearchAdministrationComponent.md)** | -**[Set-SPEnterpriseSearchContentEnrichmentConfiguration](Set-SPEnterpriseSearchContentEnrichmentConfiguration.md)** | -**[Set-SPEnterpriseSearchCrawlContentSource](Set-SPEnterpriseSearchCrawlContentSource.md)** | -**[Set-SPEnterpriseSearchCrawlDatabase](Set-SPEnterpriseSearchCrawlDatabase.md)** | -**[Set-SPEnterpriseSearchCrawlLogReadPermission](Set-SPEnterpriseSearchCrawlLogReadPermission.md)** | -**[Set-SPEnterpriseSearchCrawlRule](Set-SPEnterpriseSearchCrawlRule.md)** | -**[Set-SPEnterpriseSearchFileFormatState](Set-SPEnterpriseSearchFileFormatState.md)** | -**[Set-SPEnterpriseSearchLinguisticComponentsStatus](Set-SPEnterpriseSearchLinguisticComponentsStatus.md)** | -**[Set-SPEnterpriseSearchLinksDatabase](Set-SPEnterpriseSearchLinksDatabase.md)** | -**[Set-SPEnterpriseSearchMetadataCategory](Set-SPEnterpriseSearchMetadataCategory.md)** | -**[Set-SPEnterpriseSearchMetadataCrawledProperty](Set-SPEnterpriseSearchMetadataCrawledProperty.md)** | -**[Set-SPEnterpriseSearchMetadataManagedProperty](Set-SPEnterpriseSearchMetadataManagedProperty.md)** | -**[Set-SPEnterpriseSearchMetadataMapping](Set-SPEnterpriseSearchMetadataMapping.md)** | -**[Set-SPEnterpriseSearchPrimaryHostController](Set-SPEnterpriseSearchPrimaryHostController.md)** | -**[Set-SPEnterpriseSearchQueryAuthority](Set-SPEnterpriseSearchQueryAuthority.md)** | -**[Set-SPEnterpriseSearchQueryKeyword](Set-SPEnterpriseSearchQueryKeyword.md)** | -**[Set-SPEnterpriseSearchQueryScope](Set-SPEnterpriseSearchQueryScope.md)** | -**[Set-SPEnterpriseSearchQueryScopeRule](Set-SPEnterpriseSearchQueryScopeRule.md)** | -**[Set-SPEnterpriseSearchQuerySpellingCorrection](Set-SPEnterpriseSearchQuerySpellingCorrection.md)** | -**[Set-SPEnterpriseSearchRankingModel](Set-SPEnterpriseSearchRankingModel.md)** | -**[Set-SPEnterpriseSearchResultItemType](Set-SPEnterpriseSearchResultItemType.md)** | -**[Set-SPEnterpriseSearchResultSource](Set-SPEnterpriseSearchResultSource.md)** | -**[Set-SPEnterpriseSearchService](Set-SPEnterpriseSearchService.md)** | -**[Set-SPEnterpriseSearchServiceApplication](Set-SPEnterpriseSearchServiceApplication.md)** | -**[Set-SPEnterpriseSearchServiceApplicationProxy](Set-SPEnterpriseSearchServiceApplicationProxy.md)** | -**[Set-SPEnterpriseSearchServiceInstance](Set-SPEnterpriseSearchServiceInstance.md)** | -**[Set-SPEnterpriseSearchTopology](Set-SPEnterpriseSearchTopology.md)** | -**[Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance](Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md)** | -**[Start-SPEnterpriseSearchServiceInstance](Start-SPEnterpriseSearchServiceInstance.md)** | -**[Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance](Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md)** | -**[Stop-SPEnterpriseSearchServiceInstance](Stop-SPEnterpriseSearchServiceInstance.md)** | -**[Suspend-SPEnterpriseSearchServiceApplication](Suspend-SPEnterpriseSearchServiceApplication.md)** | -**[Upgrade-SPEnterpriseSearchServiceApplication](Upgrade-SPEnterpriseSearchServiceApplication.md)** | -**[Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings](Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md)** | - -## Secure Store Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPSecureStoreSystemAccount](Add-SPSecureStoreSystemAccount.md)** | -**[Clear-SPSecureStoreCredentialMapping](Clear-SPSecureStoreCredentialMapping.md)** | -**[Clear-SPSecureStoreDefaultProvider](Clear-SPSecureStoreDefaultProvider.md)** | -**[Disable-SPSingleSignOn](Disable-SPSingleSignOn.md)** | -**[Get-SPSecureStoreApplication](Get-SPSecureStoreApplication.md)** | -**[Get-SPSecureStoreSystemAccount](Get-SPSecureStoreSystemAccount.md)** | -**[New-SPSecureStoreApplication](New-SPSecureStoreApplication.md)** | -**[New-SPSecureStoreApplicationField](New-SPSecureStoreApplicationField.md)** | -**[New-SPSecureStoreServiceApplication](New-SPSecureStoreServiceApplication.md)** | -**[New-SPSecureStoreServiceApplicationProxy](New-SPSecureStoreServiceApplicationProxy.md)** | -**[New-SPSecureStoreTargetApplication](New-SPSecureStoreTargetApplication.md)** | -**[Remove-SPSecureStoreApplication](Remove-SPSecureStoreApplication.md)** | -**[Remove-SPSecureStoreSystemAccount](Remove-SPSecureStoreSystemAccount.md)** | -**[Set-SPSecureStoreApplication](Set-SPSecureStoreApplication.md)** | -**[Set-SPSecureStoreDefaultProvider](Set-SPSecureStoreDefaultProvider.md)** | -**[Set-SPSecureStoreServiceApplication](Set-SPSecureStoreServiceApplication.md)** | -**[Update-SPSecureStoreApplicationServerKey](Update-SPSecureStoreApplicationServerKey.md)** | -**[Update-SPSecureStoreCredentialMapping](Update-SPSecureStoreCredentialMapping.md)** | -**[Update-SPSecureStoreGroupCredentialMapping](Update-SPSecureStoreGroupCredentialMapping.md)** | -**[Update-SPSecureStoreMasterKey](Update-SPSecureStoreMasterKey.md)** | -**[Upgrade-SPSingleSignOnDatabase](Upgrade-SPSingleSignOnDatabase.md)** | - -## Security (General) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPShellAdmin](Add-SPShellAdmin.md)** | -**[Get-SPAuthenticationProvider](Get-SPAuthenticationProvider.md)** | -**[Get-SPAuthenticationRealm](Get-SPAuthenticationRealm.md)** | -**[Get-SPCertificateAuthority](Get-SPCertificateAuthority.md)** | -**[Get-SPIRMSettings](Get-SPIRMSettings.md)** | -**[Get-SPSecurityTokenServiceConfig](Get-SPSecurityTokenServiceConfig.md)** | -**[Get-SPShellAdmin](Get-SPShellAdmin.md)** | -**[Get-SPTrustedIdentityTokenIssuer](Get-SPTrustedIdentityTokenIssuer.md)** | -**[Get-SPTrustedRootAuthority](Get-SPTrustedRootAuthority.md)** | -**[Get-SPTrustedSecurityTokenIssuer](Get-SPTrustedSecurityTokenIssuer.md)** | -**[Get-SPTrustedServiceTokenIssuer](Get-SPTrustedServiceTokenIssuer.md)** | -**[Grant-SPObjectSecurity](Grant-SPObjectSecurity.md)** | -**[New-SPAuthenticationProvider](New-SPAuthenticationProvider.md)** | -**[New-SPTrustedIdentityTokenIssuer](New-SPTrustedIdentityTokenIssuer.md)** | -**[New-SPTrustedRootAuthority](New-SPTrustedRootAuthority.md)** | -**[New-SPTrustedSecurityTokenIssuer](New-SPTrustedSecurityTokenIssuer.md)** | -**[New-SPTrustedServiceTokenIssuer](New-SPTrustedServiceTokenIssuer.md)** | -**[Set-SPSecurityTokenServiceConfig](Set-SPSecurityTokenServiceConfig.md)** | -**[Set-SPTrustedIdentityTokenIssuer](Set-SPTrustedIdentityTokenIssuer.md)** | -**[Set-SPTrustedRootAuthority](Set-SPTrustedRootAuthority.md)** | -**[Set-SPTrustedSecurityTokenIssuer](Set-SPTrustedSecurityTokenIssuer.md)** | -**[Set-SPTrustedServiceTokenIssuer](Set-SPTrustedServiceTokenIssuer.md)** | -**[Remove-SPShellAdmin](Remove-SPShellAdmin.md)** | -**[Remove-SPTrustedIdentityTokenIssuer](Remove-SPTrustedIdentityTokenIssuer.md)** | -**[Remove-SPTrustedRootAuthority](Remove-SPTrustedRootAuthority.md)** | -**[Remove-SPTrustedSecurityTokenIssuer](Remove-SPTrustedSecurityTokenIssuer.md)** | -**[Remove-SPTrustedServiceTokenIssuer](Remove-SPTrustedServiceTokenIssuer.md)** | -**[Set-SPAuthenticationRealm](Set-SPAuthenticationRealm.md)** | - -## Service Application -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPServiceApplicationProxyGroupMember](Add-SPServiceApplicationProxyGroupMember.md)** | -**[Get-SPConnectedServiceApplicationInformation](Get-SPConnectedServiceApplicationInformation.md)** | -**[Get-SPServiceApplication](Get-SPServiceApplication.md)** | -**[Get-SPServiceApplicationEndpoint](Get-SPServiceApplicationEndpoint.md)** | -**[Get-SPServiceApplicationPool](Get-SPServiceApplicationPool.md)** | -**[Get-SPServiceApplicationProxy](Get-SPServiceApplicationProxy.md)** | -**[Get-SPServiceApplicationProxyGroup](Get-SPServiceApplicationProxyGroup.md)** | -**[Get-SPServiceApplicationSecurity](Get-SPServiceApplicationSecurity.md)** | -**[Publish-SPServiceApplication](Publish-SPServiceApplication.md)** | -**[New-SPServiceApplicationPool](New-SPServiceApplicationPool.md)** | -**[New-SPServiceApplicationProxyGroup](New-SPServiceApplicationProxyGroup.md)** | -**[Receive-SPServiceApplicationConnectionInfo](Receive-SPServiceApplicationConnectionInfo.md)** | -**[Remove-SPServiceApplication](Remove-SPServiceApplication.md)** | -**[Remove-SPServiceApplicationPool](Remove-SPServiceApplicationPool.md)** | -**[Remove-SPServiceApplicationProxy](Remove-SPServiceApplicationProxy.md)** | -**[Remove-SPServiceApplicationProxyGroup](Remove-SPServiceApplicationProxyGroup.md)** | -**[Remove-SPServiceApplicationProxyGroupMember](Remove-SPServiceApplicationProxyGroupMember.md)** | -**[Set-SPServiceApplication](Set-SPServiceApplication.md)** | -**[Set-SPServiceApplicationEndpoint](Set-SPServiceApplicationEndpoint.md)** | -**[Set-SPServiceApplicationPool](Set-SPServiceApplicationPool.md)** | -**[Set-SPServiceApplicationSecurity](Set-SPServiceApplicationSecurity.md)** | - -## Session State Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Disable-SPSessionStateService](Disable-SPSessionStateService.md)** | -**[Enable-SPSessionStateService](Enable-SPSessionStateService.md)** | -**[Get-SPSessionStateService](Get-SPSessionStateService.md)** | -**[Set-SPSessionStateService](Set-SPSessionStateService.md)** | - -## Site -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Copy-SPSite](Copy-SPSite.md)** | -**[Get-SPDeletedSite](Get-SPDeletedSite.md)** | -**[Get-SPServiceContext](Get-SPServiceContext.md)** | -**[Get-SPSite](Get-SPSite.md)** | -**[Get-SPSiteAdministration](Get-SPSiteAdministration.md)** | -**[Get-SPSiteMaster](Get-SPSiteMaster.md)** | -**[Get-SPSiteUpgradeSessionInfo](Get-SPSiteUpgradeSessionInfo.md)** | -**[Get-SPSiteURL](Get-SPSiteURL.md)** | -**[Move-SPDeletedSite](Move-SPDeletedSite.md)** | -**[Move-SPSite](Move-SPSite.md)** | -**[New-SPSite](New-SPSite.md)** | -**[New-SPSiteMaster](New-SPSiteMaster.md)** | -**[Remove-SPDeletedSite](Remove-SPDeletedSite.md)** | -**[Remove-SPSite](Remove-SPSite.md)** | -**[Remove-SPSiteMaster](Remove-SPSiteMaster.md)** | -**[Remove-SPSiteUpgradeSessionInfo](Remove-SPSiteUpgradeSessionInfo.md)** | -**[Remove-SPSiteURL](Remove-SPSiteURL.md)** | -**[Repair-SPSite](Repair-SPSite.md)** | -**[Request-SPUpgradeEvaluationSite](Request-SPUpgradeEvaluationSite.md)** | -**[Reset-SPSites](Reset-SPSites.md)** | -**[Set-SPSite](Set-SPSite.md)** | -**[Set-SPSiteAdministration](Set-SPSiteAdministration.md)** | -**[Set-SPSiteURL](Set-SPSiteURL.md)** | -**[Test-SPSite](Test-SPSite.md)** | -**[Upgrade-SPSite](Upgrade-SPSite.md)** | - -## Site Subscriptions -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPSiteSubscriptionFeaturePackMember](Add-SPSiteSubscriptionFeaturePackMember.md)** | -**[Add-SPSiteSubscriptionProfileConfig](Add-SPSiteSubscriptionProfileConfig.md)** | -**[Clear-SPMetadataWebServicePartitionData](Clear-SPMetadataWebServicePartitionData.md)** | -**[Clear-SPSiteSubscriptionBusinessDataCatalogConfig](Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md)** | -**[Export-SPSiteSubscriptionBusinessDataCatalogConfig](Export-SPSiteSubscriptionBusinessDataCatalogConfig.md)** | -**[Export-SPSiteSubscriptionSettings](Export-SPSiteSubscriptionSettings.md)** | -**[Get-SPSiteSubscription](Get-SPSiteSubscription.md)** | -**[Get-SPSiteSubscriptionConfig](Get-SPSiteSubscriptionConfig.md)** | -**[Get-SPSiteSubscriptionEdiscoveryHub](Get-SPSiteSubscriptionEdiscoveryHub.md)** | -**[Get-SPSiteSubscriptionEdiscoverySearchScope](Get-SPSiteSubscriptionEdiscoverySearchScope.md)** | -**[Get-SPSiteSubscriptionFeaturePack](Get-SPSiteSubscriptionFeaturePack.md)** | -**[Get-SPSiteSubscriptionIRMConfig](Get-SPSiteSubscriptionIRMConfig.md)** | -**[Get-SPSiteSubscriptionMetadataConfig](Get-SPSiteSubscriptionMetadataConfig.md)** | -**[Import-SPSiteSubscriptionBusinessDataCatalogConfig](Import-SPSiteSubscriptionBusinessDataCatalogConfig.md)** | -**[Import-SPSiteSubscriptionSettings](Import-SPSiteSubscriptionSettings.md)** | -**[New-SPSiteSubscription](New-SPSiteSubscription.md)** | -**[New-SPSiteSubscriptionFeaturePack](New-SPSiteSubscriptionFeaturePack.md)** | -**[Remove-SPSiteSubscription](Remove-SPSiteSubscription.md)** | -**[Remove-SPSiteSubscriptionBusinessDataCatalogConfig](Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md)** | -**[Remove-SPSiteSubscriptionFeaturePack](Remove-SPSiteSubscriptionFeaturePack.md)** | -**[Remove-SPSiteSubscriptionFeaturePackMember](Remove-SPSiteSubscriptionFeaturePackMember.md)** | -**[Remove-SPSiteSubscriptionMetadataConfig](Remove-SPSiteSubscriptionMetadataConfig.md)** | -**[Remove-SPSiteSubscriptionProfileConfig](Remove-SPSiteSubscriptionProfileConfig.md)** | -**[Remove-SPSiteSubscriptionSettings](Remove-SPSiteSubscriptionSettings.md)** | -**[Set-SPSiteSubscriptionConfig](Set-SPSiteSubscriptionConfig.md)** | -**[Set-SPSiteSubscriptionEdiscoveryHub](Set-SPSiteSubscriptionEdiscoveryHub.md)** | -**[Set-SPSiteSubscriptionIRMConfig](Set-SPSiteSubscriptionIRMConfig.md)** | -**[Set-SPSiteSubscriptionMetadataConfig](Set-SPSiteSubscriptionMetadataConfig.md)** | -**[Set-SPSiteSubscriptionProfileConfig](Set-SPSiteSubscriptionProfileConfig.md)** | - -## State Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Dismount-SPStateServiceDatabase](Dismount-SPStateServiceDatabase.md)** | -**[Get-SPStateServiceApplication](Get-SPStateServiceApplication.md)** | -**[Get-SPStateServiceApplicationProxy](Get-SPStateServiceApplicationProxy.md)** | -**[Get-SPStateServiceDatabase](Get-SPStateServiceDatabase.md)** | -**[Initialize-SPStateServiceDatabase](Initialize-SPStateServiceDatabase.md)** | -**[Mount-SPStateServiceDatabase](Mount-SPStateServiceDatabase.md)** | -**[New-SPStateServiceApplication](New-SPStateServiceApplication.md)** | -**[New-SPStateServiceApplicationProxy](New-SPStateServiceApplicationProxy.md)** | -**[New-SPStateServiceDatabase](New-SPStateServiceDatabase.md)** | -**[Remove-SPStateServiceDatabase](Remove-SPStateServiceDatabase.md)** | -**[Resume-SPStateServiceDatabase](Resume-SPStateServiceDatabase.md)** | -**[Set-SPStateServiceApplication](Set-SPStateServiceApplication.md)** | -**[Set-SPStateServiceApplicationProxy](Set-SPStateServiceApplicationProxy.md)** | -**[Set-SPStateServiceDatabase](Set-SPStateServiceDatabase.md)** | -**[Suspend-SPStateServiceDatabase](Suspend-SPStateServiceDatabase.md)** | - -## Subscription Settings Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New-SPSubscriptionSettingsServiceApplication](New-SPSubscriptionSettingsServiceApplication.md)** | -**[New-SPSubscriptionSettingsServiceApplicationProxy](New-SPSubscriptionSettingsServiceApplicationProxy.md)** | -**[Set-SPSubscriptionSettingsServiceApplication](Set-SPSubscriptionSettingsServiceApplication.md)** | - -## Topology Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPTopologyServiceApplication](Get-SPTopologyServiceApplication.md)** | -**[Get-SPTopologyServiceApplicationProxy](Get-SPTopologyServiceApplicationProxy.md)** | -**[Set-SPTopologyServiceApplication](Set-SPTopologyServiceApplication.md)** | -**[Set-SPTopologyServiceApplicationProxy](Set-SPTopologyServiceApplicationProxy.md)** | - -## Usage and Health Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPDiagnosticsPerformanceCounter](Add-SPDiagnosticsPerformanceCounter.md)** | -**[Disable-SPHealthAnalysisRule](Disable-SPHealthAnalysisRule.md)** | -**[Enable-SPHealthAnalysisRule](Enable-SPHealthAnalysisRule.md)** | -**[Get-SPDiagnosticConfig](Get-SPDiagnosticConfig.md)** | -**[Get-SPDiagnosticsPerformanceCounter](Get-SPDiagnosticsPerformanceCounter.md)** | -**[Get-SPDiagnosticsProvider](Get-SPDiagnosticsProvider.md)** | -**[Get-SPHealthAnalysisRule](Get-SPHealthAnalysisRule.md)** | -**[Get-SPHelpCollection](Get-SPHelpCollection.md)** | -**[Get-SPUsageApplication](Get-SPUsageApplication.md)** | -**[Get-SPUsageDefinition](Get-SPUsageDefinition.md)** | -**[Get-SPUsageService](Get-SPUsageService.md)** | -**[Merge-SPUsageLog](Merge-SPUsageLog.md)** | -**[New-SPUsageApplication](New-SPUsageApplication.md)** | -**[New-SPUsageLogFile](New-SPUsageLogFile.md)** | -**[Remove-SPDiagnosticsPerformanceCounter](Remove-SPDiagnosticsPerformanceCounter.md)** | -**[Remove-SPUsageApplication](Remove-SPUsageApplication.md)** | -**[Set-SPDiagnosticConfig](Set-SPDiagnosticConfig.md)** | -**[Set-SPDiagnosticsProvider](Set-SPDiagnosticsProvider.md)** | -**[Set-SPUsageApplication](Set-SPUsageApplication.md)** | -**[Set-SPUsageDefinition](Set-SPUsageDefinition.md)** | -**[Set-SPUsageService](Set-SPUsageService.md)** | -**[Start-SPDiagnosticsSession](Start-SPDiagnosticsSession.md)** | -**[Stop-SPDiagnosticsSession](Stop-SPDiagnosticsSession.md)** | - -## User Licensing -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPUserLicenseMapping](Add-SPUserLicenseMapping.md)** | -**[Disable-SPUserLicensing](Disable-SPUserLicensing.md)** | -**[Enable-SPUserLicensing](Enable-SPUserLicensing.md)** | -**[Get-SPUserLicense](Get-SPUserLicense.md)** | -**[Get-SPUserLicenseMapping](Get-SPUserLicenseMapping.md)** | -**[Get-SPUserLicensing](Get-SPUserLicensing.md)** | -**[New-SPUserLicenseMapping](New-SPUserLicenseMapping.md)** | -**[Remove-SPUserLicenseMapping](Remove-SPUserLicenseMapping.md)** | - -## User Profile Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPPluggableSecurityTrimmer](Add-SPPluggableSecurityTrimmer.md)** | -**[Add-SPProfileLeader](Add-SPProfileLeader.md)** | -**[Add-SPProfileSyncConnection](Add-SPProfileSyncConnection.md)** | -**[Export-SPTagsAndNotesData](Export-SPTagsAndNotesData.md)** | -**[Get-SPMicrofeedOptions](Get-SPMicrofeedOptions.md)** | -**[Get-SPPluggableSecurityTrimmer](Get-SPPluggableSecurityTrimmer.md)** | -**[Get-SPProfileLeader](Get-SPProfileLeader.md)** | -**[Get-SPProfileServiceApplicationSecurity](Get-SPProfileServiceApplicationSecurity.md)** | -**[New-SPProfileServiceApplication](New-SPProfileServiceApplication.md)** | -**[New-SPProfileServiceApplicationProxy](New-SPProfileServiceApplicationProxy.md)** | -**[Remove-SPActivityFeedItems](Remove-SPActivityFeedItems.md)** | -**[Remove-SPPluggableSecurityTrimmer](Remove-SPPluggableSecurityTrimmer.md)** | -**[Remove-SPProfileLeader](Remove-SPProfileLeader.md)** | -**[Remove-SPProfileSyncConnection](Remove-SPProfileSyncConnection.md)** | -**[Remove-SPSocialItemByDate](Remove-SPSocialItemByDate.md)** | -**[Move-SPSocialComment](Move-SPSocialComment.md)** | -**[Set-SPDefaultProfileConfig](Set-SPDefaultProfileConfig.md)** | -**[Set-SPProfileServiceApplication](Set-SPProfileServiceApplication.md)** | -**[Set-SPProfileServiceApplicationProxy](Set-SPProfileServiceApplicationProxy.md)** | -**[Set-SPProfileServiceApplicationSecurity](Set-SPProfileServiceApplicationSecurity.md)** | -**[Set-SPMicrofeedOptions](Set-SPMicrofeedOptions.md)** | -**[Update-SPProfilePhotoStore](Update-SPProfilePhotoStore.md)** | -**[Update-SPRepopulateMicroblogFeedCache](Update-SPRepopulateMicroblogFeedCache.md)** | -**[Update-SPRepopulateMicroblogLMTCache](Update-SPRepopulateMicroblogLMTCache.md)** | -**[Upgrade-SPProfileServiceApplication](Upgrade-SPProfileServiceApplication.md)** | - -## Visio Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Get-SPVisioExternalData](Get-SPVisioExternalData.md)** | -**[Get-SPVisioPerformance](Get-SPVisioPerformance.md)** | -**[Get-SPVisioSafeDataProvider](Get-SPVisioSafeDataProvider.md)** | -**[Get-SPVisioServiceApplication](Get-SPVisioServiceApplication.md)** | -**[Get-SPVisioServiceApplicationProxy](Get-SPVisioServiceApplicationProxy.md)** | -**[New-SPVisioSafeDataProvider](New-SPVisioSafeDataProvider.md)** | -**[New-SPVisioServiceApplication](New-SPVisioServiceApplication.md)** | -**[New-SPVisioServiceApplicationProxy](New-SPVisioServiceApplicationProxy.md)** | -**[Remove-SPVisioSafeDataProvider](Remove-SPVisioSafeDataProvider.md)** | -**[Set-SPVisioExternalData](Set-SPVisioExternalData.md)** | -**[Set-SPVisioPerformance](Set-SPVisioPerformance.md)** | -**[Set-SPVisioSafeDataProvider](Set-SPVisioSafeDataProvider.md)** | -**[Set-SPVisioServiceApplication](Set-SPVisioServiceApplication.md)** | - -## Web -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Disable-SPWebTemplateForSiteMaster](Disable-SPWebTemplateForSiteMaster.md)** | -**[Enable-SPWebTemplateForSiteMaster](Enable-SPWebTemplateForSiteMaster.md)** | -**[Get-SPWeb](Get-SPWeb.md)** | -**[Get-SPWebTemplate](Get-SPWebTemplate.md)** | -**[Get-SPWebTemplatesEnabledForSiteMaster](Get-SPWebTemplatesEnabledForSiteMaster.md)** | -**[Import-SPWeb](Import-SPWeb.md)** | -**[New-SPWeb](New-SPWeb.md)** | -**[Remove-SPWeb](Remove-SPWeb.md)** | -**[Set-SPWeb](Set-SPWeb.md)** | - -## Web Application -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Convert-SPWebApplication](Convert-SPWebApplication.md)** | -**[Disable-SPWebApplicationHttpThrottling](Disable-SPWebApplicationHttpThrottling.md)** | -**[Enable-SPWebApplicationHttpThrottling](Enable-SPWebApplicationHttpThrottling.md)** | -**[Get-SPAlternateURL](Get-SPAlternateURL.md)** | -**[Get-SPContentDeploymentJob](Get-SPContentDeploymentJob.md)** | -**[Get-SPContentDeploymentPath](Get-SPContentDeploymentPath.md)** | -**[Get-SPCustomLayoutsPage](Get-SPCustomLayoutsPage.md)** | -**[Get-SPDesignerSettings](Get-SPDesignerSettings.md)** | -**[Get-SPManagedPath](Get-SPManagedPath.md)** | -**[Get-SPWebApplication](Get-SPWebApplication.md)** | -**[Get-SPWebApplicationAppDomain](Get-SPWebApplicationAppDomain.md)** | -**[Get-SPWebApplicationHttpThrottlingMonitor](Get-SPWebApplicationHttpThrottlingMonitor.md)** | -**[New-SPAlternateURL](New-SPAlternateURL.md)** | -**[New-SPContentDeploymentJob](New-SPContentDeploymentJob.md)** | -**[New-SPContentDeploymentPath](New-SPContentDeploymentPath.md)** | -**[New-SPManagedPath](New-SPManagedPath.md)** | -**[New-SPWebApplication](New-SPWebApplication.md)** | -**[New-SPWebApplicationAppDomain](New-SPWebApplicationAppDomain.md)** | -**[New-SPWebApplicationExtension](New-SPWebApplicationExtension.md)** | -**[Remove-SPAlternateURL](Remove-SPAlternateURL.md)** | -**[Remove-SPContentDeploymentJob](Remove-SPContentDeploymentJob.md)** | -**[Remove-SPContentDeploymentPath](Remove-SPContentDeploymentPath.md)** | -**[Remove-SPManagedPath](Remove-SPManagedPath.md)** | -**[Remove-SPWebApplication](Remove-SPWebApplication.md)** | -**[Remove-SPWebApplicationAppDomain](Remove-SPWebApplicationAppDomain.md)** | -**[Set-SPAlternateURL](Set-SPAlternateURL.md)** | -**[Set-SPContentDeploymentJob](Set-SPContentDeploymentJob.md)** | -**[Set-SPContentDeploymentPath](Set-SPContentDeploymentPath.md)** | -**[Set-SPDesignerSettings](Set-SPDesignerSettings.md)** | -**[Set-SPWebApplication](Set-SPWebApplication.md)** | -**[Set-SPWebApplicationHttpThrottlingMonitor](Set-SPWebApplicationHttpThrottlingMonitor.md)** | -**[Start-SPContentDeploymentJob](Start-SPContentDeploymentJob.md)** | - -## Word Automation Services -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New-SPWordConversionServiceApplication](New-SPWordConversionServiceApplication.md)** | -**[Remove-SPWordConversionServiceJobHistory](Remove-SPWordConversionServiceJobHistory.md)** | -**[Set-SPWordConversionServiceApplication](Set-SPWordConversionServiceApplication.md)** | - -## Work Management Service -Cmdlet|Description|Platform -:-----|:----------|:------- -**[New-SPWorkManagementServiceApplication](New-SPWorkManagementServiceApplication.md)** |SharePoint 2010, SharePoint 2013 -**[New-SPWorkManagementServiceApplicationProxy](New-SPWorkManagementServiceApplicationProxy.md)** |SharePoint 2010, SharePoint 2013 -**[Set-SPWorkManagementServiceApplication](Set-SPWorkManagementServiceApplication.md)** |SharePoint 2010, SharePoint 2013 -**[Set-SPWorkManagementServiceApplicationProxy](Set-SPWorkManagementServiceApplicationProxy.md)** |SharePoint 2010, SharePoint 2013 - -## Workflow Service (SharePoint 2013 Workflows / Workflow Manager) -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Copy-SPActivitiesToWorkflowService](Copy-SPActivitiesToWorkflowService.md)** |SharePoint 2013, SharePoint 2016 -**[Get-SPWorkflowConfig](Get-SPWorkflowConfig.md)** |SharePoint 2013, SharePoint 2016 -**[Get-SPWorkflowServiceApplicationProxy](Get-SPWorkflowServiceApplicationProxy.md)** |SharePoint 2013, SharePoint 2016 -**[New-SPWorkflowServiceApplicationProxy](New-SPWorkflowServiceApplicationProxy.md)** |SharePoint 2013, SharePoint 2016 -**[Register-SPWorkflowService](Register-SPWorkflowService.md)** |SharePoint 2013, SharePoint 2016 -**[Set-SPWorkflowConfig](Set-SPWorkflowConfig.md)** |SharePoint 2013, SharePoint 2016 - -## DO NOT USE -Cmdlet|Description|Platform -:-----|:----------|:------- -**[Add-SPEduClassMember](Add-SPEduClassMember.md)** |DO NOT USE -**[Add-SPEduUser](Add-SPEduUser.md)** |DO NOT USE -**[Dismount-SPSiteMapDatabase](Dismount-SPSiteMapDatabase.md)** |DO NOT USE -**[Get-SPEduServiceSetting](Get-SPEduServiceSetting.md)** |DO NOT USE -**[Get-SPSiteMapDatabase](Get-SPSiteMapDatabase.md)** |DO NOT USE -**[Install-SPEduSites](Install-SPEduSites.md)** |DO NOT USE -**[Mount-SPSiteMapDatabase](Mount-SPSiteMapDatabase.md)** |DO NOT USE -**[New-SPEduClass](New-SPEduClass.md)** |DO NOT USE -**[Remove-SPEduClassMember](Remove-SPEduClassMember.md)** |DO NOT USE -**[Set-SPEduServiceSetting](Set-SPEduServiceSetting.md)** |DO NOT USE -**[Upgrade-SPSiteMapDatabase](Upgrade-SPSiteMapDatabase.md)** |DO NOT USE -**[Upgrade-SPAppManagementServiceApplication](Upgrade-SPAppManagementServiceApplication.md)** |DO NOT USE diff --git a/skype/docfx.json b/skype/docfx.json index 533e2734d0..4b1f9f1bd1 100644 --- a/skype/docfx.json +++ b/skype/docfx.json @@ -2,7 +2,9 @@ "build": { "content": [ { - "files": ["**/*.md"], + "files": [ + "**/*.md" + ], "src": "docs-conceptual", "version": "skype-ps", "dest": "skype", @@ -12,26 +14,44 @@ "README.md", "LICENSE", "LICENSE-CODE", - "ThirdPartyNotices"] + "ThirdPartyNotices" + ] }, { - "files": ["toc.yml"], + "files": [ + "toc.yml" + ], "src": "docs-conceptual", "version": "skype-ps", "dest": "skype/skype-ps" }, { - "files": ["**/*.md"], - "src": "skype-ps", - "version": "skype-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "skype-ps", - "version": "skype-ps", - "dest": "module/skype-ps" - } + "files": [ + "**/*.yml" + ], + "exclude": [ + "toc.yml" + ], + "src": "skype-ps", + "version": "skype-ps", + "dest": "module" + }, + { + "files": [ + "toc.yml" + ], + "src": "skype-ps", + "version": "skype-ps", + "dest": "module/skype-ps" + }, + { + "files": [ + "**/*.md" + ], + "src": "virtual-folder", + "version": "skype-ps", + "dest": "module" + } ], "resource": [ { @@ -53,16 +73,21 @@ "overwrite": [], "externalReference": [], "globalMetadata": { - "author" : "kenwith", - "ms.author" : "kenwith", - "manager" : "serdars", - "ms.date" : "09/25/2017", - "ms.topic" : "reference", - "ms.service" : "skypeforbusiness-powershell", - "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "uhfHeaderId": "MSDocsHeader-M365-IT", + "author": "serdarsoysal", + "ms.author": "serdars", + "manager": "serdars", + "ms.date": "04/04/2023", + "ms.topic": "reference", + "ms.service": "skypeforbusiness-powershell", + "products": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/74b1e9df-8124-4d0c-b310-50c3bf3ff02b", + "https://authoring-docs-microsoft.poolparty.biz/devrel/63959238-cb90-4871-a33d-4a5519097e47", + "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" + ], + "ms.devlang": "powershell", + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": {}, "template": [], diff --git a/skype/docs-conceptual/index.md b/skype/docs-conceptual/index.md index 2b030dbc6d..d2fa109425 100644 --- a/skype/docs-conceptual/index.md +++ b/skype/docs-conceptual/index.md @@ -1,14 +1,16 @@ --- -localization_priority: Normal +ms.localizationpriority: medium +title: Skype for Business cmdlet help reference +description: "Learn about the Skype for Business PowerShell cmdlet help reference." --- -#Skype for Business cmdlet reference +# Skype for Business cmdlet help reference -Welcome to the Skype for Business PowerShell cmdlet help references. The Skype for Business cmdlets provide the command line interface for server and service administration and management. +Welcome to the Skype for Business PowerShell cmdlet **Help** reference. The Skype for Business cmdlets provide the command line interface for server and service administration and management. > [!IMPORTANT] -> As you migrate to Microsoft Teams you will find that some of the cmdlets in the Skype for Business Online module are also used for Microsoft Teams. To learn more about this, see: [Teams PowerShell Overview](https://docs.microsoft.com/en-us/MicrosoftTeams/teams-powershell-overview). +> As you migrate to Microsoft Teams, you will find that some of the cmdlets in the Skype for Business Online module are also used for Microsoft Teams. To learn more about this, see: [Teams PowerShell Overview](/MicrosoftTeams/teams-powershell-overview). -Here you will find all of the Skype for Business and relevant Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here, you will find all of the Skype for Business and relevant Microsoft Teams PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. diff --git a/skype/docs-conceptual/intro.md b/skype/docs-conceptual/intro.md index 2b030dbc6d..309683be13 100644 --- a/skype/docs-conceptual/intro.md +++ b/skype/docs-conceptual/intro.md @@ -1,14 +1,16 @@ --- -localization_priority: Normal +ms.localizationpriority: medium +title: Skype for Business Server cmdlet reference +description: "Learn about Skype for Business Server cmdlets." --- -#Skype for Business cmdlet reference +# Skype for Business Server cmdlet reference -Welcome to the Skype for Business PowerShell cmdlet help references. The Skype for Business cmdlets provide the command line interface for server and service administration and management. +Welcome to the Skype for Business Server PowerShell cmdlet help references. The Skype for Business Server cmdlets provide the command line interface for server administration and management. > [!IMPORTANT] -> As you migrate to Microsoft Teams you will find that some of the cmdlets in the Skype for Business Online module are also used for Microsoft Teams. To learn more about this, see: [Teams PowerShell Overview](https://docs.microsoft.com/en-us/MicrosoftTeams/teams-powershell-overview). +> As you migrate to Microsoft Teams, to learn more, see: [Teams PowerShell Overview](/MicrosoftTeams/teams-powershell-overview). -Here you will find all of the Skype for Business and relevant Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here you will find all of the Skype for Business Server. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. diff --git a/skype/mapping/monikerMapping.json b/skype/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from skype/mapping/monikerMapping.json rename to skype/mapping/MAML2Yaml/monikerMapping.json diff --git a/skype/skype-ps/skype/Add-CsSlaDelegates.md b/skype/skype-ps/skype/Add-CsSlaDelegates.md index 86b0affe49..3700e12bc1 100644 --- a/skype/skype-ps/skype/Add-CsSlaDelegates.md +++ b/skype/skype-ps/skype/Add-CsSlaDelegates.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates +applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Add-CsSlaDelegates schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Add-CsSlaDelegates @@ -35,7 +40,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Add-CsSlaDelegates"} Add-CsSlaDelegates -Identity emergency -Delegate sip:delegate_1@contosohealth.com ``` -This example adds a delegate “delegate_1@contosohealth.com” to an SLA configuration identified by “emergency”. +This example adds a delegate "delegate_1@contosohealth.com" to an SLA configuration identified by "emergency". ## PARAMETERS @@ -58,16 +63,12 @@ Accept wildcard characters: False ### -Identity 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 -- User principal name (UPN) - - Example: kenmyer@litwareinc.com -- Domain name and logon name in the form domain\logon - - Example: litwareinc\kenmyer -- Active Directory display name (this form typically requires quotes) - - Example: "Ken Myer" -- Active Directory distinguished name - - Example: CN=KenMyer,CN=Users,DC=Atlanta,DC=Corp,DC=litware,DC=com + +- SIP address: Example. sip:kenmyer@litwareinc.com. +- User principal name (UPN). Example: kenmyer@litwareinc.com. +- Domain name and logon name in the form domain\logon. Example: litwareinc\kenmyer. +- Active Directory display name (this form typically requires quotes). Example: "Ken Myer". +- Active Directory distinguished name. Example: CN=KenMyer,CN=Users,DC=Atlanta,DC=Corp,DC=litware,DC=com ```yaml Type: UserIdParameter @@ -131,7 +132,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -142,4 +143,3 @@ The `Add-CsSlaDelegates` cmdlet returns a Microsoft.Rtc.Management.SlaConfigurat ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md index 4309f9e087..e35882d1bb 100644 --- a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Approve-CsDeviceUpdateRule @@ -161,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -186,4 +191,3 @@ Instead, the `Approve-CsDeviceUpdateRule` cmdlet approves instances of the Micro [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Backup-CsPool.md b/skype/skype-ps/skype/Backup-CsPool.md index c4f5981ff9..ebbf326a13 100644 --- a/skype/skype-ps/skype/Backup-CsPool.md +++ b/skype/skype-ps/skype/Backup-CsPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Backup-CsPool @@ -77,6 +82,7 @@ Allowed values are: * CMS * UserData +* RGS ```yaml Type: BackupCategory @@ -262,7 +268,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -284,4 +290,3 @@ None. [Get-CsBackupServiceStatus](Get-CsBackupServiceStatus.md) [Get-CsPoolBackupRelationship](Get-CsPoolBackupRelationship.md) - diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md b/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md index 9d1685bd9f..4565de64c5 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md +++ b/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Clear-CsDeviceUpdateFile @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ The `Clear-CsDeviceUpdateFile` cmdlet does not return any values. [Clear-CsDeviceUpdateLog](Clear-CsDeviceUpdateLog.md) [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md b/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md index 633d05ad89..37114a8907 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md +++ b/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Clear-CsDeviceUpdateLog @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +154,3 @@ The `Clear-CsDeviceUpdateLog` cmdlet does not return any values. [Clear-CsDeviceUpdateFile](Clear-CsDeviceUpdateFile.md) [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md b/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md deleted file mode 100644 index 36745bbcd5..0000000000 --- a/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Clear-CsOnlineTelephoneNumberReservation -schema: 2.0.0 ---- - -# Clear-CsOnlineTelephoneNumberReservation - -## SYNOPSIS -Use the `Clear-CsOnlineTelephoneNumberReservation` cmdlet to clear a reserved list of telephone numbers before they are acquired. -The telephone numbers will then be available for search and reservation again. - -## SYNTAX - -``` -Clear-CsOnlineTelephoneNumberReservation [-Tenant <Guid>] -ReservationId <String> - -InventoryType <String> [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet will fail if any of the numbers in the reservation have already been assigned. -An error message will identify the source of the failure. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Clear-CsOnlineTelephoneNumberReservation -ReservationId b1ae43f5-07ab-4b81-be32-4b8cc2d11f75 -InventoryType Service -``` - -This example clears a reservation with an inventory type of "Service". - - -## PARAMETERS - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -- "Service" for numbers assigned to conferencing support. - -- "Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -Specifies the identification of the reservation you want to clear. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - -[Online version:](https://docs.microsoft.com/en-us/powershell/module/skype/Clear-CsOnlineTelephoneNumberReservation?view=skype-ps) diff --git a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md b/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md index 175370c9c1..e6cc17f0f3 100644 --- a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Clear-CsPersistentChatRoom @@ -78,7 +83,7 @@ You must specify an EndDate when running the `Clear-CsPersistentChatRoom` cmdlet Type: DateTime 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 Required: True Position: Named @@ -97,7 +102,7 @@ For example: Type: String 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 Required: True Position: 1 @@ -113,7 +118,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: ChatRoom Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 1 @@ -132,7 +137,7 @@ 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, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -148,7 +153,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -158,7 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -175,4 +180,3 @@ None. Instead, `Clear-CsPersistentChatRoom` modifies existing instances of the M ## RELATED LINKS [Remove-CsPersistentChatMessage](Remove-CsPersistentChatMessage.md) - diff --git a/skype/skype-ps/skype/Complete-CsCceApplianceRegistration.md b/skype/skype-ps/skype/Complete-CsCceApplianceRegistration.md deleted file mode 100644 index 1df20bfee6..0000000000 --- a/skype/skype-ps/skype/Complete-CsCceApplianceRegistration.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Complete-CsCceApplianceRegistration -schema: 2.0.0 ---- - -# Complete-CsCceApplianceRegistration - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Complete-CsCceApplianceRegistration [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Confirm] [-Force] [-Instance <Object>] [-Tenant <Object>] [-WhatIf] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - -Insert descriptive text for example 1. - -Insert example commands for example 1. - -## PARAMETERS - -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassDualWrite -PARAMVALUE: $true | $false - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: PSObject - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Complete-CsCceApplianceUnregistration.md b/skype/skype-ps/skype/Complete-CsCceApplianceUnregistration.md deleted file mode 100644 index 0b90dc80e6..0000000000 --- a/skype/skype-ps/skype/Complete-CsCceApplianceUnregistration.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Complete-CsCceApplianceUnregistration -schema: 2.0.0 ---- - -# Complete-CsCceApplianceUnregistration - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Complete-CsCceApplianceUnregistration [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Confirm] [-Force] - [-Tenant <Object>] [-WhatIf] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassDualWrite -PARAMVALUE: $true | $false - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Convert-CsUserData.md b/skype/skype-ps/skype/Convert-CsUserData.md index 02012d3a2d..36e5bfd5b6 100644 --- a/skype/skype-ps/skype/Convert-CsUserData.md +++ b/skype/skype-ps/skype/Convert-CsUserData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Convert-CsUserData @@ -175,7 +180,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -199,4 +204,3 @@ The `Convert-CsUserData` cmdlet creates either XML or ZIP files, depending on wh [Sync-CsUserData](Sync-CsUserData.md) [Update-CsUserData](Update-CsUserData.md) - diff --git a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md b/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md index 6cf6a7b706..a337781345 100644 --- a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md +++ b/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # ConvertTo-JsonForPSWS @@ -156,7 +161,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,5 +176,4 @@ You can pipe any object to ConvertTo-JsonForPSWS. ## RELATED LINKS -[ConvertTo-Json](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-6) - +[ConvertTo-Json](https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-6) diff --git a/skype/skype-ps/skype/Copy-CsVoicePolicy.md b/skype/skype-ps/skype/Copy-CsVoicePolicy.md index 6df14e758d..2b2f8404d0 100644 --- a/skype/skype-ps/skype/Copy-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Copy-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/copy-csvoicepolicy +applicable: Lync Server 2013 title: Copy-CsVoicePolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Copy-CsVoicePolicy @@ -121,21 +126,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob - -```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 -``` - ### CommonParameters ## INPUTS @@ -145,4 +135,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md b/skype/skype-ps/skype/Debug-CsAddressBookReplication.md index e602d707ba..1afa8db7a1 100644 --- a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md +++ b/skype/skype-ps/skype/Debug-CsAddressBookReplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Debug-CsAddressBookReplication @@ -283,7 +288,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -302,4 +307,3 @@ The Debug-CsAddressBookReplication cmdlet returns instances of the Microsoft.Rtc [Test-CsAddressBookService](Test-CsAddressBookService.md) [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) - diff --git a/skype/skype-ps/skype/Debug-CsDataConference.md b/skype/skype-ps/skype/Debug-CsDataConference.md index f36b342ae3..6db0f9115d 100644 --- a/skype/skype-ps/skype/Debug-CsDataConference.md +++ b/skype/skype-ps/skype/Debug-CsDataConference.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Debug-CsDataConference @@ -103,7 +108,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -119,4 +124,3 @@ The Debug-CsDataConference cmdlet does not accept pipelined input. ## RELATED LINKS [Test-CsDataConference](Test-CsDataConference.md) - diff --git a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md b/skype/skype-ps/skype/Debug-CsInterPoolReplication.md index a755520913..ebc215436e 100644 --- a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md +++ b/skype/skype-ps/skype/Debug-CsInterPoolReplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Debug-CsInterPoolReplication @@ -196,7 +201,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -210,4 +215,3 @@ Debug-CsInterPoolReplication does not accept pipelined data. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md b/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md index d2738be08c..5f9eb262df 100644 --- a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md +++ b/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Debug-CsIntraPoolReplication @@ -223,7 +228,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -244,4 +249,3 @@ Debug-CsIntraPoolReplication returns instances of the Microsoft.Rtc.Management.U [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) [Test-CsReplica](Test-CsReplica.md) - diff --git a/skype/skype-ps/skype/Debug-CsLisConfiguration.md b/skype/skype-ps/skype/Debug-CsLisConfiguration.md index 09472f5093..11d2b846e0 100644 --- a/skype/skype-ps/skype/Debug-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Debug-CsLisConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Debug-CsLisConfiguration @@ -41,7 +46,7 @@ Debug-CsLisConfiguration | Format-Table -Wrap ``` Running this command will display the entire LIS configuration to the Skype for Business Server Management Shell window in XML format. -By default, the output of the Debug-CsLisConfiguration cmdlet is displayed on one line, with an ellipsis (…) at the end of the line indicating that there's more than one line of data. +By default, the output of the Debug-CsLisConfiguration cmdlet is displayed on one line, with an ellipsis (...) at the end of the line indicating that there's more than one line of data. Therefore, in this example we pipe the output to the Format-Table cmdlet, specifying the Wrap parameter, to display the full output wrapped to fit in the display window. @@ -81,7 +86,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -104,4 +109,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Export-CsLisConfiguration](Export-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md b/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md index 273904a7ff..417dd26a22 100644 --- a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md +++ b/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Debug-CsStorageServiceFailures @@ -262,7 +267,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -277,4 +282,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md b/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md index 8a5305e262..df94000299 100644 --- a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md +++ b/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore +applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsUnifiedContactStore schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Debug-CsUnifiedContactStore @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -154,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Test-CsUnifiedContactStore](Test-CsUnifiedContactStore.md) - diff --git a/skype/skype-ps/skype/Disable-CsAdDomain.md b/skype/skype-ps/skype/Disable-CsAdDomain.md index 9790bd5cdb..38a11de6d4 100644 --- a/skype/skype-ps/skype/Disable-CsAdDomain.md +++ b/skype/skype-ps/skype/Disable-CsAdDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Disable-CsAdDomain @@ -196,7 +201,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -215,4 +220,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-CsAdDomain](Enable-CsAdDomain.md) [Get-CsAdDomain](Get-CsAdDomain.md) - diff --git a/skype/skype-ps/skype/Disable-CsAdForest.md b/skype/skype-ps/skype/Disable-CsAdForest.md index 1029ebf768..c417b7c00c 100644 --- a/skype/skype-ps/skype/Disable-CsAdForest.md +++ b/skype/skype-ps/skype/Disable-CsAdForest.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Disable-CsAdForest @@ -208,7 +213,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -224,4 +229,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Disable-CsComputer.md b/skype/skype-ps/skype/Disable-CsComputer.md index fddf71da35..d6b985bdfd 100644 --- a/skype/skype-ps/skype/Disable-CsComputer.md +++ b/skype/skype-ps/skype/Disable-CsComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Disable-CsComputer @@ -169,7 +174,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -190,4 +195,3 @@ Instead, Disable-CsComputer disables instances of the Microsoft.Rtc.Management.D [Get-CsComputer](Get-CsComputer.md) [Test-CsComputer](Test-CsComputer.md) - diff --git a/skype/skype-ps/skype/Disable-CsHostingProvider.md b/skype/skype-ps/skype/Disable-CsHostingProvider.md index 15e8995c52..ed00fbdde6 100644 --- a/skype/skype-ps/skype/Disable-CsHostingProvider.md +++ b/skype/skype-ps/skype/Disable-CsHostingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Disable-CsHostingProvider @@ -170,7 +175,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -197,4 +202,3 @@ Instead, the cmdlet disables instances of the Microsoft.Rtc.Management.WritableC [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Disable-CsMeetingRoom.md b/skype/skype-ps/skype/Disable-CsMeetingRoom.md index 23143b350b..15cd889743 100644 --- a/skype/skype-ps/skype/Disable-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Disable-CsMeetingRoom.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsMeetingRoom schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Disable-CsMeetingRoom @@ -14,12 +19,14 @@ When you disable a meeting room object you remove all the Skype for Business Ser However, the Active Directory user account itself is not deleted. This cmdlet was introduced in Lync Server 2013. +**Note**: This cmdlet is not supported for managing Microsoft Teams Rooms. You must use the methods described in the [Microsoft Teams Rooms](/microsoftteams/rooms) documentation to manage Microsoft Teams Rooms. + ## SYNTAX ``` Disable-CsMeetingRoom [-Identity] <UserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-PassThru] [-WhatIf] - [-AsJob] [<CommonParameters>] + [<CommonParameters>] ``` ## DESCRIPTION @@ -152,24 +159,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -194,4 +185,3 @@ Instead, Disable-CsMeetingRoom deletes instance of the Microsoft.Rtc.Management. [Move-CsMeetingRoom](Move-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md deleted file mode 100644 index 33c7c043a3..0000000000 --- a/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Disable-CsOnlineDialInConferencingUser -schema: 2.0.0 ---- - -# Disable-CsOnlineDialInConferencingUser - -## SYNOPSIS -Use the `Disable-CsOnlineDialInConferencingUser` cmdlet to prevent a Skype for Business Online user from using dial-in or audio conferencing through Skype for Business Online. - -## SYNTAX - -``` -Disable-CsOnlineDialInConferencingUser [-WhatIf] [-SendEmailFromDisplayName <String>] [-TenantDomain <String>] - [-SendEmailToAddress <String>] [-SendEmailFromAddress <String>] [-Confirm] [-SendEmail] [[-Identity] <UserIdParameter>] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -The `Disable-CsOnlineDialInConferencingUser` cmdlet validates that the user is provisioned for audio conferencing using Microsoft as the audio conferencing provider and then disables audio conferencing which prevents the user from setting up audio conferences or meetings. - -When a user is disabled, the conference ID or passcode that was assigned to the user is released so it can be used by another user that is enabled for dial-in or audio conferencing even if they have a license assigned to them. - -When you disable the user for audio conferencing using this cmdlet, it will check that the user belongs to the specified tenant or domain and any audio conferencing information is removed. - -If the user is enabled for a third-party audio conferencing provider (ACP) and the Active Directory information is set, the cmdlet will fail and you must use the Remove-CsUserACP cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:> Disable-CsOnlineDialInConferencingUser -Identity "Pilar Ackerman" -Confirm -``` - -This example disables user "Pilar Ackerman" from using audio conferencing and will prompt you to confirm the operation. - - -## PARAMETERS - -### -Identity -Specifies the identity of the user account that will be disabled for Skype for Business Online. -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmail -Send an email to the user that contains his Audio Conference information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromAddress -You can specify the From Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromDisplayName and -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromDisplayName -You can specify the Display Name to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromAddress and -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToAddress -You can specify the To Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -NOTE: This parameter is reserved for internal Microsoft use. - -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -NOTE: This parameter is reserved for internal Microsoft use. - -Specifies the domain name for the tenant or organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Enable-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/enable-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinedialinconferencinguser?view=skype-ps) diff --git a/skype/skype-ps/skype/Disable-CsOnlineSipDomain.md b/skype/skype-ps/skype/Disable-CsOnlineSipDomain.md deleted file mode 100644 index b66ba0943b..0000000000 --- a/skype/skype-ps/skype/Disable-CsOnlineSipDomain.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Disable-CsOnlineSipDomain -schema: 2.0.0 ---- - -# Disable-CsOnlineSipDomain - -## SYNOPSIS -**THIS IS PRELIMINARY DOCUMENTATION OF UPCOMING FUNCTIONALITY**</br> -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. **IMPORTANT:** Only 1 Skype for Business forest can be in hybrid mode at a given time. - -## SYNTAX - -``` -Disable-CsOnlineSipDomain -Domain <String> [-Force] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet enables 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. When an online SIP domain is disabled in Skype for Business Online, provisioning is blocked for users in this SIP domain. This ensures routing for any on-premises users in this SIP domain continues to function properly. - -This cmdlet facilitates consolidation of multiple Skype for Business Server deployments into a single Office 365 tenant. Consolidation can be achieved by moving one deployment at a time into Office 365, **provided the following key requirements are met**: - - There must be at most 1 O365 tenant involved. Consolidation in scenarios with >1 O365 tenant is not supported. - - At any given time, only 1 on-premise SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) - - If 1 deployment is in hybrid mode, all sip domains from any other SfB forests must be disabled using this cmdlet before they can be synchronized into the tenant with Azure AD Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. - - Organizations must fully migrate each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the “hybrid” deployment, *before* moving on to migrate the next on-premise SfB deployment. - - -This cmdlet may also be useful for organizations with on-premises deployments of Skype for Business Server that have not properly configured Azure AD Connect. If the organization does not sync msRTCSIP-DeploymentLocator for its users, then Skype for Business Online will attempt to provision online any users with an assigned Skype for Business license, despite there being users on-premises. While the correct fix is to update the configuration for Azure AD Connect to sync those attributes, using Disable-CsOnlineSipDomain can also mitigate the problem until that configuration change can be made. If this cmdlet is run, any users that were previously provisioned online in that domain will be de-provisioned in Skype for Business Online. - -**IMPORTANT** -This cmdlet should not be run for domains that contain users hosted in Skype for Business Online. Any users in a sip domain that are already provisioned *online* will cease to function if you disable the online sip domain: - - Their SIP addresses will be removed. - - All contacts and meetings for these users hosted in Skype for Business Online will be deleted. - - These users will no longer be able to login to the Skype for Business Online environment. - - If these users use Teams, they will no longer be able to inter-operate with Skype for Business users, nor will they be able to federate with any users in other organizations. - - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Disable-CsOnlineSipDomain -Domain Fabrikam.com -``` - -The cmdlet above disables the online sip domain Fabrikam.com. This would be useful in the case where a company, Contoso.com, that has Skype for Business acquires Fabrikam, which also has an on-premises deployment of Skype for Business Server. If Contoso is in hybrid mode with Skype for Business Online or if the intent is to configure it for hybrid, then if the organization wants to synchronize identities from Fabrikam.com into the same O365 tenant, the organization must first run this cmdlet. - -## PARAMETERS - -### -Domain -The SIP domain to be disabled for online provisioning in Skype for Business Online. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Skype for Business Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the 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 confirmation prompts that might occur when running the command. - -```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 -``` - - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 -This cmdlet is for advanced scenarios only. Organizations that are pure online or have only 1 on-premise deployment need not run this cmdlet. - -## RELATED LINKS - -[Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) -[Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) diff --git a/skype/skype-ps/skype/Disable-CsPublicProvider.md b/skype/skype-ps/skype/Disable-CsPublicProvider.md index 18a9d226da..7fe6d0507f 100644 --- a/skype/skype-ps/skype/Disable-CsPublicProvider.md +++ b/skype/skype-ps/skype/Disable-CsPublicProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Disable-CsPublicProvider @@ -163,7 +168,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -187,4 +192,3 @@ Instead, the cmdlet disables instances of the Microsoft.Rtc.Management.WritableC [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Disable-CsUser.md b/skype/skype-ps/skype/Disable-CsUser.md index 1d74e4f816..df9affeaa4 100644 --- a/skype/skype-ps/skype/Disable-CsUser.md +++ b/skype/skype-ps/skype/Disable-CsUser.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Disable-CsUser @@ -161,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -184,4 +189,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.ADConne [Enable-CsUser](Enable-CsUser.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Enable-CsAdDomain.md b/skype/skype-ps/skype/Enable-CsAdDomain.md index faa039bbfd..c23a8ddc5c 100644 --- a/skype/skype-ps/skype/Enable-CsAdDomain.md +++ b/skype/skype-ps/skype/Enable-CsAdDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsAdDomain @@ -224,7 +229,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -243,4 +248,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-CsAdDomain](Disable-CsAdDomain.md) [Get-CsAdDomain](Get-CsAdDomain.md) - diff --git a/skype/skype-ps/skype/Enable-CsAdForest.md b/skype/skype-ps/skype/Enable-CsAdForest.md index 1df022deb8..0ef2979fe9 100644 --- a/skype/skype-ps/skype/Enable-CsAdForest.md +++ b/skype/skype-ps/skype/Enable-CsAdForest.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsAdForest @@ -225,7 +230,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -240,4 +245,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Enable-CsComputer.md b/skype/skype-ps/skype/Enable-CsComputer.md index 2a982d93fb..7d94d1d9aa 100644 --- a/skype/skype-ps/skype/Enable-CsComputer.md +++ b/skype/skype-ps/skype/Enable-CsComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsComputer @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -173,4 +178,3 @@ Instead, the Enable-CsComputer cmdlet enables instances of the Microsoft.Rtc.Man [Get-CsComputer](Get-CsComputer.md) [Test-CsComputer](Test-CsComputer.md) - diff --git a/skype/skype-ps/skype/Enable-CsHostingProvider.md b/skype/skype-ps/skype/Enable-CsHostingProvider.md index f8dbe232f5..13691b8524 100644 --- a/skype/skype-ps/skype/Enable-CsHostingProvider.md +++ b/skype/skype-ps/skype/Enable-CsHostingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsHostingProvider @@ -168,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -195,4 +200,3 @@ Instead, the cmdlet enables instances of the Microsoft.Rtc.Management.WritableCo [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Enable-CsMeetingRoom.md b/skype/skype-ps/skype/Enable-CsMeetingRoom.md index fdc4b86b42..c823fe60ad 100644 --- a/skype/skype-ps/skype/Enable-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Enable-CsMeetingRoom.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/enable-csmeetingroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsMeetingRoom schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Enable-CsMeetingRoom @@ -14,7 +19,9 @@ To enable a meeting room you must first create an Active Directory user account Note that, although meeting room objects are based on user accounts, these objects will not show up when you run the Get-CsUser cmdlet. This cmdlet was introduced in Lync Server 2013. -The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Online and Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: https://docs.microsoft.com/en-us/skypeforbusiness/deploy/deploy-clients/with-office-365 +The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: [Manage conferencing in Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/conferencing/conferencing). + +**Note**: This cmdlet is not supported for managing Microsoft Teams Rooms. You must use the methods described in the [Microsoft Teams Rooms](/microsoftteams/rooms) documentation to manage Microsoft Teams Rooms. ## SYNTAX @@ -23,7 +30,7 @@ The process for creating and updating meeting rooms differs depending on your de Enable-CsMeetingRoom [-Identity] <UserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-HostingProviderProxyFqdn <Fqdn>] [-OriginatorSid <SecurityIdentifier>] [-PassThru] [-ProxyPool <Fqdn>] [-RegistrarPool <Fqdn>] [-SipAddress <String>] [-SipAddressType <AddressType>] [-SipDomain <Fqdn>] [-WhatIf] - [-AsJob] [<CommonParameters>] + [<CommonParameters>] ``` ## DESCRIPTION @@ -40,7 +47,7 @@ Note that, for Skype for Business Server, there are no cmdlets for creating or r Instead, you use the Enable-CsMeetingRoom cmdlet to enable meeting rooms and the Disable-CsMeetingRoom cmdlet to disable meeting rooms. The resource account must already exist in order for you to enable the meeting room, and disabling a meeting room only removes that room from your collection of meeting rooms; it does not delete the resource mailbox account. -The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Online and Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: https://docs.microsoft.com/en-us/skypeforbusiness/deploy/deploy-clients/with-office-365 +The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: [Manage conferencing in Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/conferencing/conferencing). The functions carried out by the Enable-CsMeetingRoom cmdlet are not available in the Skype for Business Server Control Panel. @@ -301,24 +308,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -344,4 +335,3 @@ The cmdlet also accepts pipelined instances of the Active Directory user object. [Move-CsMeetingRoom](Move-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md deleted file mode 100644 index e5427b261d..0000000000 --- a/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Enable-CsOnlineDialInConferencingUser -schema: 2.0.0 ---- - -# Enable-CsOnlineDialInConferencingUser - -## SYNOPSIS -Use the `Enable-CsOnlineDialInConferencingUser` cmdlet to enable a Skype for Business user to access audio conferencing through Skype for Business Online. - -## SYNTAX - -``` -Enable-CsOnlineDialInConferencingUser [-AllowPstnOnlyMeetings <Boolean>] [-ServiceNumber <String>] - [-SendEmailFromDisplayName <String>] [-ConferenceId <Int32>] [-TenantDomain <String>] - [-TollFreeServiceNumber <String>] [-SendEmailToAddress <String>] [-SendEmailFromAddress <String>] [-SendEmail] - [[-Identity] <UserIdParameter>] [-Tenant <Guid>] [-AllowTollFreeDialIn <Boolean>] [-DomainController <Fqdn>] - [-ReplaceProvider] [-Force] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -The `Enable-CsOnlineDialInConferencingUser` cmdlet allows a Skype for Business user to access audio conferencing through Skype for Business Online. -The cmdlet will validate if the user has the correct license assigned. -If the user already uses Microsoft as the audio conferencing provider, the cmdlet will run without any errors but no changes are made to the user. -The user can be moved from a third-party audio conferencing provider to Microsoft as the PSTN conferencing provider by using the ReplaceProvider parameter. - -If the bridge information (BridgeID or BridgeName) isn't provided and the tenant is just using one audio conferencing bridge, the user is assigned to the bridge. -If the bridge information isn't provided and the tenant uses multiple audio conferencing bridges, the user is then assigned to the default bridge. - -The audio conferencing provider name and domain information is automatically set for the user when they are enabled for audio conferencing. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:> Enable-CsOnlineDialInConferencingUser -Identity "Ken Meyer" -AllowPstnOnlyMeetings $false -ConferenceId 3659305 -ReplaceProvider -ServiceNumber 14255551234 -``` - -This example enables a user named Ken Meyer to use audio conferencing and set up Skype for Business Online dial-in meetings. -When the cmdlet runs, it will replace Ken's existing audio conferencing provider information, set the default phone number to 14255551234 and the ConferenceId for meetings to 3659305. - - -## PARAMETERS - -### -Identity -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPstnOnlyMeetings -If true, non-authenticated users can start meetings. -If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. -An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. -The default is false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConferenceId -Specifies the ConferenceId that will be used by the user for dial-in meetings. The cmdlet will fail if: - -The ConferenceId is already being used in the bridge where the user is assigned, or to which the user would be assigned. - -The ConferenceId doesn't meet the ConferenceId format requirements. - -ConferenceId and ResetConferenceId are mutually exclusive. When ConferenceId is specified the new ConferenceId will be assigned to the user. When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: Passcode -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplaceProvider -If present, the ReplaceProvider switch causes the user's default conferencing provider information to be set to Microsoft. -If omitted, the Active Directory information will not be updated. - -If the ReplaceProvider parameter is not used and the user is enabled for a 3rd party conferencing provider, the cmdlet will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmail -Send an email to the user that contains his Audio Conference information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromAddress -You can specify the From Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromDisplayName and -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromDisplayName -You can specify the Display Name to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromAddress and -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToAddress -You can specify the To Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -Specifies the default phone number to be used by the user. -The default number is used in meeting invitations. -The service number parameter overwrites the default service number assigned to the bridge for the user. -The service number can be specified in the following formats: E.164 number, +\<E.164 number\> and tel:\<E.164 number\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -Specifies the domain name for the tenant or organization. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TollFreeServiceNumber -Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. -The toll-free number can be specified in the following formats: E.164 number, +\<E.164 number\> and tel:\<E.164 number\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTollFreeDialIn -If true, specified toll-free number is used in meeting invitations. -If false, specified toll-free number is not allowed to be used in meeting invitations. -The default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Disable-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/disable-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinedialinconferencinguser?view=skype-ps) diff --git a/skype/skype-ps/skype/Enable-CsOnlineSipDomain.md b/skype/skype-ps/skype/Enable-CsOnlineSipDomain.md deleted file mode 100644 index d49b8ed924..0000000000 --- a/skype/skype-ps/skype/Enable-CsOnlineSipDomain.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Enable-CsOnlineSipDomain -schema: 2.0.0 ---- - -# Enable-CsOnlineSipDomain - -## SYNOPSIS -THIS IS PRELIMINARY DOCUMENTATION OF UPCOMING FUNCTIONALITY</br> - -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. - -## SYNTAX - -``` -Enable-CsOnlineSipDomain -Domain <String> [-Force] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet enables online provisioning of users in the specified SIP domain. In conjunction with Disable-CsOnlineSipDomain, this cmdlet allows organizations to consolidate *multiple on-premises deployments of Skype for Business Server (or Lync Server)* into a single Office 365 tenant. Consolidation can be achieved by moving one deployment at a time into Office 365, provided the following key requirements are met: - - There must be at most 1 O365 tenant involved. Consolidation for scenarios with > 1 O365 tenant is not supported. - - At any given time, only 1 on-premise SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) - - If 1 deployment is in hybrid mode, all online SIP domains from any other SfB forests must be disabled before they can be synchronized into the tenant with Azure AD Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. - - Organizations must fully migrate (e.g move all users to the cloud) each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the “hybrid” deployment, *before* moving on to migrate the next on-premise SfB deployment. - -Before running this cmdlet for any SIP domain in a Skype for Business Server deployment, you must complete migration of any other existing hybrid SfB deployment that is in progress. All users in an existing hybrid deployment must be moved to the cloud, and that existing hybrid deployment must be detached from Office 365, as described below. - -**IMPORTANT** -If you have more than one on-premises deployment of Skype for Business Server, you *must* ensure SharedSipAddressSpace is disabled in all other Skype for Business Server deployments except the deployment containing the SIP domain that is being enabled. - -**HOW TO DETACH A HYBRID DEPLOYMENT FROM OFFICE 365** - -Once you have moved all users from on-premises into the cloud, you can decommission the on-premises Skype for Business deployment. Aside from removing any hardware, a critical step is to logically detach that on-premises deployment from Office 365. Detaching hybrid consists of 3 steps, which are detailed below: - - Disable shared sip address space in the O365 tenant. - - Disable the ability in the on-premises environment to communicate with O365 - - Update DNS records to point to Office 365. </br> - -These steps should be done together as a unit. - -> [!NOTE] -> Any federated organizations that are using the older Direct Federation model (also known as Allowed Partner Server) will need to update their allowed domain entries for your organization to remove the proxy FQDN. This legacy federation model is not based on DNS SRV records, so such a config will become out of date, once your organization moves to the cloud. If you suspect any of your federated partners may be using Direct Federation, we suggest you send them a communication about this as you prepare to complete your migration to the cloud. - -The steps are: -</br> -1. **Disable shared sip address space in the Office 365 tenant** - The command below needs to be done from a Skype for Business Online PowerShell window. - - `PS C:\> Set-CsTenantFederationConfiguration -SharedSipAddressSpace $false`</br> - -1. **Disable ability in on-premise to communicate with Office 365** - The command below needs to be done from an on-premises PowerShell window. If you have previously imported an Office 365 session, start a new Skype for Business PowerShell session. - - `Get-CsHostingProvider|Set-CsHostingProvider -Enabled $false`</br> - -1. **Update DNS to point to O365** - The organization’s external DNS for the former on-premises deployment needs to be updated so that Skype for Business records point to Office 365 instead of Onprem. Specifically: - - -| Record Type | Name | TTL | Value | -|:--------------|:-------------------------|:----:|:----------------------------------| -| SRV | \_sipfederationtls.\_tcp | 3600 | 100 1 5061 sipfed.online.lync.com | -| SRV | \_sip.\_tls | 3600 | 100 1 443 sipdir.online.lync.com | -| CNAME | lyncdiscover | 3600 | webdir.online.lync.com | -| CNAME | sip | 3600 | sipdir.online.lync.com | -| CNAME | meet | 3600 | webdir.online.lync.com | -| CNAME | dialin | 3600 | webdir.online.lync.com | - - - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Enable-CsOnlineSipDomain -Domain contoso.com -``` - -Enables the domain contoso.com for online provisioning in Skype for Business Online. - -## PARAMETERS - -### -Domain -The SIP domain to be enabled for online provisioning in Skype for Business Online. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Skype for Business Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 -``` - - -### -Force -Suppresses all confirmation prompts that might occur when running the command. - -```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 -``` - - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 - -## RELATED LINKS - -[Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) -[Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) diff --git a/skype/skype-ps/skype/Enable-CsPublicProvider.md b/skype/skype-ps/skype/Enable-CsPublicProvider.md index 857572f955..e94296ea51 100644 --- a/skype/skype-ps/skype/Enable-CsPublicProvider.md +++ b/skype/skype-ps/skype/Enable-CsPublicProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsPublicProvider @@ -158,7 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -187,4 +192,3 @@ Instead, the cmdlet enables instances of the Microsoft.Rtc.Management.WritableCo [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Enable-CsReplica.md b/skype/skype-ps/skype/Enable-CsReplica.md index a5e4364021..9b9ffe4c9e 100644 --- a/skype/skype-ps/skype/Enable-CsReplica.md +++ b/skype/skype-ps/skype/Enable-CsReplica.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsReplica @@ -141,7 +146,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -158,4 +163,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) - diff --git a/skype/skype-ps/skype/Enable-CsTopology.md b/skype/skype-ps/skype/Enable-CsTopology.md index 99a0ad68e8..6ea479e1df 100644 --- a/skype/skype-ps/skype/Enable-CsTopology.md +++ b/skype/skype-ps/skype/Enable-CsTopology.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsTopology @@ -183,7 +188,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -210,4 +215,3 @@ Instead, the Enable-CsTopology cmdlet enables instances of the Microsoft.Rtc.Man [Test-CsSetupPermission](Test-CsSetupPermission.md) [Test-CsTopology](Test-CsTopology.md) - diff --git a/skype/skype-ps/skype/Enable-CsUser.md b/skype/skype-ps/skype/Enable-CsUser.md index 9223ace1ec..edbb4b7306 100644 --- a/skype/skype-ps/skype/Enable-CsUser.md +++ b/skype/skype-ps/skype/Enable-CsUser.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Enable-CsUser @@ -78,6 +83,13 @@ 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 -------------------------- +``` +Enable-CsUser -Identity user@litwareinc.com -HostingProvider sipfed.online.lync.com -SipAddressType UserPrincipalName +``` + +Example 5 populates an existing Active Directory user in on-premises Skype for Business server who has been enabled for Skype for Business Online, or Microsoft Teams. The parameter -HostingProvider sipfed.online.lync.com specifies that the user is homed online, not on premises. + ## PARAMETERS @@ -290,7 +302,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -314,4 +326,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.ADConne [Disable-CsUser](Disable-CsUser.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Export-CsArchivingData.md b/skype/skype-ps/skype/Export-CsArchivingData.md index 9779d8445c..cd7d61b79f 100644 --- a/skype/skype-ps/skype/Export-CsArchivingData.md +++ b/skype/skype-ps/skype/Export-CsArchivingData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Export-CsArchivingData @@ -313,7 +318,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -333,6 +338,4 @@ The Export-CsArchivingData cmdlet returns Archiving database records in EML form [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) -[Export archived data in Skype for Business Server](https://docs.microsoft.com/en-us/skypeforbusiness/manage/archiving/export-archived-data) - - +[Export archived data in Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/archiving/export-archived-data) diff --git a/skype/skype-ps/skype/Export-CsConfiguration.md b/skype/skype-ps/skype/Export-CsConfiguration.md index 853185b966..07b09a1158 100644 --- a/skype/skype-ps/skype/Export-CsConfiguration.md +++ b/skype/skype-ps/skype/Export-CsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Export-CsConfiguration @@ -130,7 +135,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +154,3 @@ If called along with the AsBytes parameter, the Export-CsConfiguration cmdlet re ## RELATED LINKS [Import-CsConfiguration](Import-CsConfiguration.md) - diff --git a/skype/skype-ps/skype/Export-CsLisConfiguration.md b/skype/skype-ps/skype/Export-CsLisConfiguration.md index da22f840f3..86b50a823e 100644 --- a/skype/skype-ps/skype/Export-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Export-CsLisConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Export-CsLisConfiguration @@ -11,7 +16,6 @@ schema: 2.0.0 Exports an Enterprise Voice Enhanced 9-1-1 (E9-1-1) configuration to a file in compressed format for backup purposes. This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ### FileName @@ -39,7 +43,6 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h `Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Export-CsLisConfiguration"}` - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -60,27 +63,20 @@ In this example, the LIS configuration is stored as an array of bytes in a varia ``` $lisconfig = Export-CsLisConfiguration -AsBytes -$lisconfig | Set-Content -Path C:\E911Config.bak -Encoding byte +[System.IO.File]::WriteAllBytes('C:\E911Config.bak', $lisconfig) -Get-Content -ReadCount 0 -Encoding byte -Path C:\E911Config.bak | Import-CsLisConfiguration +[System.IO.File]::ReadAllBytes('C:\E911Config.bak') | Import-CsLisConfiguration ``` Example 3 is a more complete version of Example 2. The first line is the same, we call the Export-CsLisConfiguration cmdlet with the AsBytes parameter to store the LIS configuration as an array of bytes in the variable $lisconfig. The rest of this example shows how to save that configuration to a file and then import it back into the location configuration database. -In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the Windows PowerShell Set-Content cmdlet. -We assign values to two parameters of the Set-Content cmdlet: Path and Encoding. -We assign the full path and file name of the file to which we want to save the configuration to the Path parameter. -We use the Encoding parameter with a value of byte to ensure the configuration is stored as an array of bytes. +In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the full path and file name of the file to which we want to save the configuration. Finally, in line 3 we import the configuration back into the location configuration database. -First we call the Get-Content cmdlet to retrieve the contents from the file. -We pass a value of 0 to the ReadCount property, which tells the Get-Content cmdlet to read all the contents of the file at once rather than one line at a time. -We again use the Encoding parameter with a value of byte to specify what type of data we're reading from the file. -Finally we pass the file name to the Path parameter. -The contents of the file that we read with the Get-Content cmdlet are piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location database. - +First we retrieve the contents from the file. +The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location database. ## PARAMETERS @@ -123,22 +119,19 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Byte[] Returns a byte array when the AsBytes parameter is used. - ## NOTES - ## RELATED LINKS [Import-CsLisConfiguration](Import-CsLisConfiguration.md) @@ -150,4 +143,3 @@ Returns a byte array when the AsBytes parameter is used. [Unpublish-CsLisConfiguration](Unpublish-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index 28d364a04c..0000000000 --- a/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Export-CsOrganizationalAutoAttendantHolidays -schema: 2.0.0 ---- - -# Export-CsOrganizationalAutoAttendantHolidays - -## SYNOPSIS -Use Export-CsOrganizationalAutoAttendantHolidays 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-CsOrganizationalAutoAttendantHolidays cmdlet. - -## SYNTAX - -``` -Export-CsOrganizationalAutoAttendantHolidays [-PrimaryUri] <Uri> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-CsOrganizationalAutoAttendantHolidays cmdlet and the Import-CsOrganizationalAutoAttendantHolidays cmdlet enable you to export holiday schedules in your auto attendant and then later import that information. This can be extremely useful in a situation where you need to configure same holiday sets in multiple auto attendants. - -The Export-CsOrganizationalAutoAttendantHolidays cmdlet returns the holiday schedule information in serialized form (as a byte array). The caller can then write the bytes to the disk to obtain a CSV file. Similarly, the Import-CsOrganizationalAutoAttendantHolidays cmdlet accepts the holiday schedule information as a byte array, which can be read from the aforementioned CSV file. The first line of the CSV file is considered a header record and is always ignored. - -**NOTE** -- Each line in the CSV file used by Export-CsOrganizationalAutoAttendantHolidays and Import-CsOrganizationalAutoAttendantHolidays cmdlet should be of the following format: - - `HolidayName,StartDateTime1,EndDateTime1,StartDateTime2,EndDateTime2,…,StartDateTime10,EndDateTime10` - - where - - HolidayName is the name of the holiday to be imported. - - StartDateTimeX and EndDateTimeX specify a date/time range for the holiday and are optional. If no date-time ranges are defined, then the holiday is imported without any date/time ranges. They follow the same format as New-CsOnlineDateTimeRange cmdlet. - - EndDateTimeX is optional. If it is not specified, the end bound of the date time range is set to 00:00 of the day after the start date. -- The first line of the CSV file is considered a header record and is always ignored by Import-CsOrganizationalAutoAttendantHolidays cmdlet. -- If the destination auto attendant for the import already contains a call flow or schedule by the same name as one of the holidays being imported, the corresponding CSV record is skipped. -- For holidays that are successfully imported, a default call flow is created which is configured without any greeting and simply disconnects the call on being executed. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$bytes = Export-CsOrganizationalAutoAttendantHolidays -PrimaryUri sip:mainoaa@contoso.com -[System.IO.File]::WriteAllBytes("C:\Exports\Holidays.csv", $bytes) -``` - -In this example, the Export-CsOrganizationalAutoAttendantHolidays cmdlet is used to export holiday schedules of an auto attendant with Primary URI of sip:mainoaa@contoso.com. The exported bytes are then written to a file with the path "C:\Exports\Holidays.csv". - -## PARAMETERS - -### -PrimaryUri -The Primary URI represents the SIP address of the auto attendant whose holiday schedules are to be exported. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -The String is used as the PrimaryUri input. - - -## OUTPUTS - -### System.Byte[] - - -## NOTES - - -## RELATED LINKS - -[Import-CsOrganizationalAutoAttendantHolidays](Import-CsOrganizationalAutoAttendantHolidays.md) - -[Get-CsOrganizationalAutoAttendantHolidays](Get-CsOrganizationalAutoAttendantHolidays.md) - diff --git a/skype/skype-ps/skype/Export-CsPersistentChatData.md b/skype/skype-ps/skype/Export-CsPersistentChatData.md index 80c098e024..c748866515 100644 --- a/skype/skype-ps/skype/Export-CsPersistentChatData.md +++ b/skype/skype-ps/skype/Export-CsPersistentChatData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Export-CsPersistentChatData @@ -69,7 +74,7 @@ For example, this syntax specifies the database found in the RTC database instan 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 Required: True Position: Named @@ -86,7 +91,7 @@ You cannot use both AsBytes and FileName in the same command. Type: SwitchParameter Parameter Sets: AsBytes Aliases: -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 @@ -102,7 +107,7 @@ SQL instance name of the Persistent Chat database. 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 Required: False Position: Named @@ -118,7 +123,7 @@ When present, all exported categories and chat rooms will be disabled when the e 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 Required: False Position: Named @@ -137,7 +142,7 @@ For example: Type: String Parameter Sets: FileName Aliases: -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 @@ -162,7 +167,7 @@ The default value is All, which means that all the Persistent Chat information w Type: ExportLevel 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 Required: False Position: Named @@ -181,7 +186,7 @@ For example: 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 Required: False Position: Named @@ -198,7 +203,7 @@ By default all Categories are exported. Type: System.Collections.Generic.List`1[System.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 Required: False Position: Named @@ -219,7 +224,7 @@ This parameter is valid only when they Level is set to RoomDirectory. Type: DateTime 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 Required: False Position: Named @@ -229,7 +234,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -246,4 +251,3 @@ The Export-CsPersistentChatData cmdlet creates .ZIP files. ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Export-CsRgsConfiguration.md b/skype/skype-ps/skype/Export-CsRgsConfiguration.md index 7a3e2e7eba..eb820753a3 100644 --- a/skype/skype-ps/skype/Export-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Export-CsRgsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Export-CsRgsConfiguration @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -158,4 +163,3 @@ The Export-CsRgsConfiguration cmdlet creates compressed files with the .ZIP file ## RELATED LINKS [Import-CsRgsConfiguration](Import-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Export-CsUserData.md b/skype/skype-ps/skype/Export-CsUserData.md index b9ea16bbdb..0a7cb7f3d3 100644 --- a/skype/skype-ps/skype/Export-CsUserData.md +++ b/skype/skype-ps/skype/Export-CsUserData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Export-CsUserData @@ -45,7 +50,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Export-CsUserData"} The functions carried out by the `Export-CsUserData` cmdlet are not available in the Skype for Business Server Control Panel. -NOTE: URNs that have the following characters back slash (\\) and forward slash (/) will cause the powershell command to fail and stop the export of the user data until that point.The following error is reported: Export-CsUserData : "urn:hcd:User1/test@domain.com" is not a valid uniform resource name (At line:1 char:1+ Export-CsUserData -PoolFqdn pool01.domain.com -FileName c:\temp\UserDataExport.zip+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~    + CategoryInfo          : NotSpecified: (:) [Export-CsUserData], UriFormatException    + FullyQualifiedErrorId : System.UriFormatException,Microsoft.Rtc.Management.BlobStor +NOTE: URNs that have the following characters back slash (\\) and forward slash (/) will cause the powershell command to fail and stop the export of the user data until that point.The following error is reported: Export-CsUserData : "urn:hcd:User1/test@domain.com" is not a valid uniform resource name (At line:1 char:1+ Export-CsUserData -PoolFqdn pool01.domain.com -FileName c:\temp\UserDataExport.zip+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [Export-CsUserData], UriFormatException + FullyQualifiedErrorId : System.UriFormatException,Microsoft.Rtc.Management.BlobStor ## EXAMPLES @@ -263,7 +268,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Find-CsGroup.md b/skype/skype-ps/skype/Find-CsGroup.md deleted file mode 100644 index 3aba453855..0000000000 --- a/skype/skype-ps/skype/Find-CsGroup.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Find-CsGroup.xml -applicable: Skype for Business Online -title: Find-CsGroup -schema: 2.0.0 ---- - -# Find-CsGroup - -## SYNOPSIS -Use the Find-CsGroup cmdlet to search groups. - -## SYNTAX - -``` -Find-CsGroup [-Tenant <Guid>] -SearchQuery <String> [-MaxResults <UInt32>] [-ExactMatchOnly <Boolean>] -[-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The Find-CsGroup cmdlet lets you search groups in the Azure Address Book Service (AABS). - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -Find-CsGroup -SearchQuery "ed0d1180-169e-47c7-b718-bf9e60543914" -ExactMatchOnly $true -``` - -This example finds and displays only those groups that are an exact match to the search query. - -## 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExactMatchOnly -The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxResults -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: 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.Group.Models.GroupModel -The Find-CsGroup cmdlet returns a list of Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel. Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel contains Id and DisplayName. - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CSOnlinePSTNGateway.md b/skype/skype-ps/skype/Get-CSOnlinePSTNGateway.md deleted file mode 100644 index 9269cca0cd..0000000000 --- a/skype/skype-ps/skype/Get-CSOnlinePSTNGateway.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: -applicable: Skype for Business Online -title: Get-CSOnlinePSTNGateway -schema: 2.0.0 ---- - -# Get-CSOnlinePSTNGateway - -## SYNOPSIS -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. - -## SYNTAX - -### Identity (Default) -``` -Get-CSOnlinePSTNGateway [-Tenant <System.Guid>] [[-Identity] <XdsGlobalRelativeIdentity>] [-LocalStore] - [<CommonParameters>] -``` - -### Filter -``` -Get-CSOnlinePSTNGateway [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to show the configuration of the previously created Session Border Controller(s) (SBC(s)) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter set to $false, the SBC will continue existing calls, bit all new calls routed to another SBC in a route (if exists). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CSOnlinePSTNGateway -``` - -This example shows all SBCs paired with the tenant - -### Example 2 -```powershell -PS C:\> Get-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"} -``` - -This example selects all SBC with names matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc - -## PARAMETERS - -### -Filter - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The parameter is optional for the cmdlet. If not set all SBC paired to the tenant are listed. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md) - -[New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md) - -[Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md index 637d50333a..25ec18533d 100644 --- a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAVEdgeConfiguration @@ -148,7 +153,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,4 +176,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md b/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md index 40674eabfd..11284940f2 100644 --- a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAccessEdgeConfiguration @@ -127,7 +132,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsAdContact.md b/skype/skype-ps/skype/Get-CsAdContact.md index 288593da5e..34b07fefb1 100644 --- a/skype/skype-ps/skype/Get-CsAdContact.md +++ b/skype/skype-ps/skype/Get-CsAdContact.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdContact @@ -225,7 +230,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -247,4 +252,3 @@ The Get-CsAdContact cmdlet accepts a pipelined string value representing the Ide [Get-CsAdUser](Get-CsAdUser.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsAdDomain.md b/skype/skype-ps/skype/Get-CsAdDomain.md index f04cfbdf8b..5bccf6a4ec 100644 --- a/skype/skype-ps/skype/Get-CsAdDomain.md +++ b/skype/skype-ps/skype/Get-CsAdDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdDomain @@ -158,7 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -179,4 +184,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-CsAdDomain](Disable-CsAdDomain.md) [Enable-CsAdDomain](Enable-CsAdDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsAdForest.md b/skype/skype-ps/skype/Get-CsAdForest.md index 2139837330..7c4a94daab 100644 --- a/skype/skype-ps/skype/Get-CsAdForest.md +++ b/skype/skype-ps/skype/Get-CsAdForest.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdForest @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -164,4 +169,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAdPrincipal.md b/skype/skype-ps/skype/Get-CsAdPrincipal.md index 394b804137..408fcea9c1 100644 --- a/skype/skype-ps/skype/Get-CsAdPrincipal.md +++ b/skype/skype-ps/skype/Get-CsAdPrincipal.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdPrincipal @@ -114,13 +119,12 @@ Accept wildcard characters: False ### -Filter Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. -The Filter parameter uses the much of the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. -For example, a filter that returns only principals who are not enabled for Skype for Business Server would look like this: +The Filter parameter uses much of the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. +For example, a filter that returns only principals whose sip address equals "RedmondMeetingRoom@litwareinc.com" would look like this: -`-Filter {Enabled -ne $True}` +`-Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com"}` -In that example. -Enabled represents the Active Directory attribute, -ne represents the comparison operator (not equal to), and $True (a built-in Windows PowerShell variable) represents the value True. +In that example, SipAddress represents the Skype for Business attribute, -eq represents the comparison operator (equal to "sip:RedmondMeetingRoom@litwareinc.com") ```yaml Type: String @@ -230,7 +234,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -254,4 +258,3 @@ For example, this syntax returns Active Directory principal information for the [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Get-CsAdServerSchema.md b/skype/skype-ps/skype/Get-CsAdServerSchema.md index 2a8b32d2b1..68b5c4a03e 100644 --- a/skype/skype-ps/skype/Get-CsAdServerSchema.md +++ b/skype/skype-ps/skype/Get-CsAdServerSchema.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdServerSchema @@ -70,7 +75,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -89,4 +94,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Install-CsAdServerSchema](Install-CsAdServerSchema.md) - diff --git a/skype/skype-ps/skype/Get-CsAdUser.md b/skype/skype-ps/skype/Get-CsAdUser.md index 7c70c2a645..64a6b36104 100644 --- a/skype/skype-ps/skype/Get-CsAdUser.md +++ b/skype/skype-ps/skype/Get-CsAdUser.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdUser @@ -254,7 +259,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -274,4 +279,3 @@ The Get-CsAdUser cmdlet accepts a pipelined string value representing the Identi ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md b/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md index 00f9dc0694..0e359015b0 100644 --- a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdditionalInternalDomain ## SYNOPSIS -{{Fill in the Synopsis}} +Returns existing additional SIP domain names present in the topology. ## SYNTAX @@ -23,21 +28,21 @@ Get-CsAdditionalInternalDomain [-Filter <String>] [-LocalStore] [<CommonParamete ``` ## DESCRIPTION -{{Fill in the Description}} +Returns existing additional SIP domain names present in the topology. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Get-CsAdditionalInternalDomain -LocalStore ``` -{{ Add example description here }} +Gets additional SIP domain names from LocalStore ## PARAMETERS ### -Filter -{{Fill Filter Description}} +Enables you to limit the returned data. ```yaml Type: String @@ -53,7 +58,7 @@ Accept wildcard characters: False ``` ### -Identity -{{Fill Identity Description}} +Unique identifier for the additional SIP domain to be returned. ```yaml Type: XdsGlobalRelativeIdentity @@ -69,7 +74,7 @@ Accept wildcard characters: False ``` ### -LocalStore -{{Fill LocalStore Description}} +Retrieves from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter @@ -86,7 +91,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -100,4 +105,3 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md b/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md index d3422cd1ca..7515253dc6 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAddressBookConfiguration @@ -140,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -162,4 +167,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md index 7aeff0bf90..17e9105af0 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAddressBookNormalizationConfiguration @@ -121,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md index 4a141bf05b..d12fa7f30e 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAddressBookNormalizationRule @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsAdminRole.md b/skype/skype-ps/skype/Get-CsAdminRole.md index 4e6eaedbfc..45ac191dd0 100644 --- a/skype/skype-ps/skype/Get-CsAdminRole.md +++ b/skype/skype-ps/skype/Get-CsAdminRole.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdminRole @@ -218,7 +223,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -234,4 +239,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md b/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md index 9eb3a149be..553b2ad153 100644 --- a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md +++ b/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAdminRoleAssignment @@ -102,7 +107,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -123,4 +128,3 @@ The Get-CsAdminRoleAssignment cmdlet returns string values representing the RBAC ## RELATED LINKS [Get-CsAdminRole](Get-CsAdminRole.md) - diff --git a/skype/skype-ps/skype/Get-CsAllowedDomain.md b/skype/skype-ps/skype/Get-CsAllowedDomain.md index d45e2b9687..d929aab5aa 100644 --- a/skype/skype-ps/skype/Get-CsAllowedDomain.md +++ b/skype/skype-ps/skype/Get-CsAllowedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAllowedDomain @@ -41,7 +46,6 @@ Conversely, the blocked list represents domains that users are expressly forbidd The Get-CsAllowedDomain cmdlet provides a way for you to return information about all the domains on the allowed domains list. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -66,21 +70,19 @@ Get-CsAllowedDomain -Filter *fabrikam* ``` The command shown in Example 3 returns a collection of all the allowed domains that have the string value "fabrikam" anywhere in their Identity. -To do this, the command uses the Filter parameter and the filter value "*fabrikam*". +To do this, the command uses the Filter parameter and the filter value "\*fabrikam\*". 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 -------------------------- ``` -Where-Object {$_.ProxyFqdn -ne $Null} - Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null} ``` In Example 4, the Get-CsAllowedDomain cmdlet and the Where-Object cmdlet are used to return a collection of all the domains where no value has been entered for the ProxyFqdn property. To carry out this task, the Get-CsAllowedDomain cmdlet is first called without any additional parameters in order to return a collection of all the allowed domains. 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: +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 -------------------------- ``` @@ -91,7 +93,6 @@ Example 5 returns all the allowed domains that have their health status checked To do this, the Get-CsAllowedDomain cmdlet is first used to return a collection of all the domains on the allowed domains list. That collection is then piped to the Where-Object cmdlet, which picks out only those domains where the MarkForMonitoring property is equal to True. - ## PARAMETERS ### -Identity @@ -122,7 +123,7 @@ To return all of the domains that have an Identity that begins with the letter " 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\]*` +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: String @@ -154,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -179,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsAllowedDomain](Set-CsAllowedDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsAnalogDevice.md b/skype/skype-ps/skype/Get-CsAnalogDevice.md index 71dd15b4e5..395151838c 100644 --- a/skype/skype-ps/skype/Get-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Get-CsAnalogDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAnalogDevice @@ -264,7 +269,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -290,4 +295,3 @@ The Get-CsAnalogDevice cmdlet accepts a pipelined string value that represents t [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Get-CsAnnouncement.md b/skype/skype-ps/skype/Get-CsAnnouncement.md index 30b6d2213f..a6d35b457e 100644 --- a/skype/skype-ps/skype/Get-CsAnnouncement.md +++ b/skype/skype-ps/skype/Get-CsAnnouncement.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAnnouncement @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +194,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAnnouncement](Set-CsAnnouncement.md) [Import-CsAnnouncementFile](Import-CsAnnouncementFile.md) - diff --git a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsApplicationEndpoint.md index b22fa5a449..abcb4005cc 100644 --- a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md +++ b/skype/skype-ps/skype/Get-CsApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsApplicationEndpoint @@ -202,7 +207,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -221,4 +226,3 @@ Accepts a pipelined string value representing the Identity of the application en ## RELATED LINKS [Move-CsApplicationEndpoint](Move-CsApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md b/skype/skype-ps/skype/Get-CsArchivingConfiguration.md index 0685e601b5..55d5040275 100644 --- a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsArchivingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsArchivingConfiguration @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,4 +176,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/Get-CsArchivingPolicy.md b/skype/skype-ps/skype/Get-CsArchivingPolicy.md index c27c781bd1..f7195895dc 100644 --- a/skype/skype-ps/skype/Get-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Get-CsArchivingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsArchivingPolicy @@ -178,7 +183,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -203,4 +208,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md b/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md index ac31ee2de6..b3dc99ff07 100644 --- a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md +++ b/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsAudioConferencingProvider @@ -117,7 +122,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -134,4 +139,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md b/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md index a8a513f408..4829ab115f 100644 --- a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsAudioTestServiceApplication @@ -182,7 +187,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -200,4 +205,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsAudioTestServiceApplication](Set-CsAudioTestServiceApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsAuthConfig.md b/skype/skype-ps/skype/Get-CsAuthConfig.md index 946ae61932..56541b3cdc 100644 --- a/skype/skype-ps/skype/Get-CsAuthConfig.md +++ b/skype/skype-ps/skype/Get-CsAuthConfig.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csauthconfig +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAuthConfig schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsAuthConfig @@ -18,10 +23,15 @@ Get-CsAuthConfig [[-Pool] <String>] [-WhatIf] [-Confirm] [<CommonParameters>] ## DESCRIPTION Use the Get-CsAuthConfig cmdlet to retrieve the authentication configuration for your organization. -This cmdlet gets authentication configuration from two server roles - Registrar and WebServices. + +This cmdlet gets authentication configuration from two server roles: Registrar and WebServices. + It is meant to only be run at the global level. -If you do run it at the pool level and only one of the roles are present on the pool, the cmdlet will return the setting that corresponds to the role that exists on the pool and the global settings for the role that doesn’t exist on the pool. + +If you do run it at the pool level and only one of the roles are present on the pool, the cmdlet will return the setting that corresponds to the role that exists on the pool and the global settings for the role that doesn't exist on the pool. + If neither role is present on the pool, it will return an error. + If both roles are present for the pool, but policies are not defined at the pool level, the cmdlet will return an error. ## EXAMPLES @@ -42,7 +52,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -57,7 +67,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: 0 Default value: None @@ -73,7 +83,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -83,7 +93,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md index 30272eee94..9b8fbb11b7 100644 --- a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAutodiscoverConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsAutodiscoverConfiguration @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -164,4 +169,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md b/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md index 59f8f1ff54..0807cde4a1 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsBackupServiceConfiguration @@ -107,7 +112,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -128,4 +133,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsBackupServiceConfiguration](Remove-CsBackupServiceConfiguration.md) [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md b/skype/skype-ps/skype/Get-CsBackupServiceStatus.md index 1cbb52daf5..6b305b2b3c 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md +++ b/skype/skype-ps/skype/Get-CsBackupServiceStatus.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsBackupServiceStatus @@ -63,8 +68,9 @@ Allowed values are: * CMS * UserData +* RGS -If this parameter is not specified then both backup types will be checked. +If this parameter is not specified then all three backup types will be checked. ```yaml Type: BackupCategory @@ -96,7 +102,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -116,4 +122,3 @@ Returns information about the backup service. ## RELATED LINKS [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md index f9a0f1953f..7b0c12b2c5 100644 --- a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsBandwidthPolicyServiceConfiguration @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsBandwidthPolicyServiceConfiguration](Remove-CsBandwidthPolicyServiceConfiguration.md) [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsBlockedDomain.md b/skype/skype-ps/skype/Get-CsBlockedDomain.md index 1a40ddd7f3..4db4188c4b 100644 --- a/skype/skype-ps/skype/Get-CsBlockedDomain.md +++ b/skype/skype-ps/skype/Get-CsBlockedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsBlockedDomain @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsBlockedDomain](Set-CsBlockedDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md index ced345a6b3..82470cd5a7 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsBroadcastMeetingConfiguration @@ -123,28 +128,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -161,4 +146,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md b/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md index b69c89c743..acdf4bbf3d 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md +++ b/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsBroadcastMeetingPolicy @@ -235,28 +240,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -273,4 +258,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsBusyOptions.md b/skype/skype-ps/skype/Get-CsBusyOptions.md index b1e6f3bd31..717261c488 100644 --- a/skype/skype-ps/skype/Get-CsBusyOptions.md +++ b/skype/skype-ps/skype/Get-CsBusyOptions.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsBusyOptions @@ -71,7 +76,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -91,6 +96,6 @@ Microsoft.Rtc.Management.AD.UserIdParameter object. ## RELATED LINKS -[Remove-CsBusyOptions](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://docs.microsoft.com/en-us/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsCallParkOrbit.md b/skype/skype-ps/skype/Get-CsCallParkOrbit.md index 15fc92f102..d13afad9f1 100644 --- a/skype/skype-ps/skype/Get-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/Get-CsCallParkOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsCallParkOrbit @@ -82,7 +87,7 @@ It does this by checking the StartsWith property of the NumberRangeStart object ### -------------------------- Example 6 -------------------------- ``` -Get-CsCallParkOrbit | Where-Object {\[Char\]::IsDigit($_.NumberRangeStart\[0\])} +Get-CsCallParkOrbit | Where-Object {[Char]::IsDigit($_.NumberRangeStart[0])} ``` The command in this example returns all call park orbit ranges where no prefix has been assigned to the numbers in the range. @@ -180,7 +185,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -203,4 +208,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsCallParkOrbit](Remove-CsCallParkOrbit.md) [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) - diff --git a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md index 5f2bc01ece..5bf6b230bd 100644 --- a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsCallViaWorkPolicy @@ -26,10 +31,7 @@ Get-CsCallViaWorkPolicy [[-Identity] <XdsIdentity>] [-LocalStore] [-Tenant <Guid ## DESCRIPTION -To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command from the Windows PowerShell prompt. - -Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"} - +Use the Get-CsCallViaWorkPolicy cmdlet to return call via work policies. ## EXAMPLES @@ -46,8 +48,8 @@ This example returns the properties of the policy currently assigned to the Redm ### -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:*" +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 @@ -118,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -143,4 +145,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsCallerIdPolicy.md b/skype/skype-ps/skype/Get-CsCallerIdPolicy.md deleted file mode 100644 index fc74cc4b8c..0000000000 --- a/skype/skype-ps/skype/Get-CsCallerIdPolicy.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsCallerIdPolicy -schema: 2.0.0 ---- - -# Get-CsCallerIdPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Get-CsCallerIdPolicy [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsCallerIdPolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Filter -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsCallingLineIdentity.md b/skype/skype-ps/skype/Get-CsCallingLineIdentity.md deleted file mode 100644 index 6dc86909cc..0000000000 --- a/skype/skype-ps/skype/Get-CsCallingLineIdentity.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsCallingLineIdentity -schema: 2.0.0 ---- - -# Get-CsCallingLineIdentity - -## SYNOPSIS -Use the `Get-CsCallingLineIdentity` cmdlet to display the Caller ID policies for your organization. - -## SYNTAX - -``` -Get-CsCallingLineIdentity [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [-AsJob] -[<CommonParameters>] -``` - -## DESCRIPTION -By default, the Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can create Caller ID policies to change this behavior, and you can use the Get-CsCallingLineIdentity cmdlet to display the existing Caller ID policies for your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Get-CsCallingLineIdentity -``` - -The example gets and displays the Caller ID policies for your organization. - -## PARAMETERS - -### -Filter -The Filter parameter lets you insert a string through which your search results are filtered. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter identifies the Caller ID policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - - -## OUTPUTS - -### -Identity : Global - -Description : - -EnableUserOverride : False - -ServiceNumber : - -CallingIDSubstitute : LineUri - -BlockIncomingPstnCallerID : False - - -## NOTES - - -## RELATED LINKS -[Grant-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/grant-cscallinglineidentity?view=skype-ps) - -[New-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/new-cscallinglineidentity?view=skype-ps) - -[Remove-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cscallinglineidentity?view=skype-ps) - -[Set-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/set-cscallinglineidentity?view=skype-ps) - diff --git a/skype/skype-ps/skype/Get-CsCdrConfiguration.md b/skype/skype-ps/skype/Get-CsCdrConfiguration.md index 058f1dcccb..2b953208c4 100644 --- a/skype/skype-ps/skype/Get-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/Get-CsCdrConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsCdrConfiguration @@ -133,7 +138,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsCertificate.md b/skype/skype-ps/skype/Get-CsCertificate.md index 7c5bccd1d0..99a8ec2704 100644 --- a/skype/skype-ps/skype/Get-CsCertificate.md +++ b/skype/skype-ps/skype/Get-CsCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsCertificate @@ -174,7 +179,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -199,4 +204,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Request-CsCertificate](Request-CsCertificate.md) [Set-CsCertificate](Set-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Get-CsClientAccessLicense.md b/skype/skype-ps/skype/Get-CsClientAccessLicense.md index 1dfdfd5003..ca9a1a2205 100644 --- a/skype/skype-ps/skype/Get-CsClientAccessLicense.md +++ b/skype/skype-ps/skype/Get-CsClientAccessLicense.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClientAccessLicense @@ -207,7 +212,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -227,4 +232,3 @@ The Get-CsClientAccessLicense cmdlet returns licensing information. ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsClientCertificate.md b/skype/skype-ps/skype/Get-CsClientCertificate.md index 26821b65f0..396563d963 100644 --- a/skype/skype-ps/skype/Get-CsClientCertificate.md +++ b/skype/skype-ps/skype/Get-CsClientCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClientCertificate @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +154,3 @@ The cmdlet also accepts pipelined input of user objects. ## RELATED LINKS [Revoke-CsClientCertificate](Revoke-CsClientCertificate.md) - diff --git a/skype/skype-ps/skype/Get-CsClientPinInfo.md b/skype/skype-ps/skype/Get-CsClientPinInfo.md index 2b0c3a859c..58a1c53bdf 100644 --- a/skype/skype-ps/skype/Get-CsClientPinInfo.md +++ b/skype/skype-ps/skype/Get-CsClientPinInfo.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClientPinInfo @@ -126,7 +131,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -152,4 +157,3 @@ The cmdlet also accepts pipelined input of user objects. [Set-CsClientPin](Set-CsClientPin.md) [Unlock-CsClientPin](Unlock-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Get-CsClientPolicy.md b/skype/skype-ps/skype/Get-CsClientPolicy.md index abc78b9591..43174d771f 100644 --- a/skype/skype-ps/skype/Get-CsClientPolicy.md +++ b/skype/skype-ps/skype/Get-CsClientPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsClientPolicy @@ -116,8 +121,8 @@ 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:*". +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 @@ -171,28 +176,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -216,4 +201,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientPolicy](Remove-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md b/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md index 3a3bbd8da8..62a9a4f591 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClientVersionConfiguration @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md b/skype/skype-ps/skype/Get-CsClientVersionPolicy.md index 00a1d1831d..79e4188c89 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Get-CsClientVersionPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClientVersionPolicy @@ -168,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -193,4 +198,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md index cf9eaf96f3..88381a0d58 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClientVersionPolicyRule @@ -191,7 +196,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -214,4 +219,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientVersionPolicyRule](Remove-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md b/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md index d230275eff..9908ff7acb 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md +++ b/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md @@ -1,9 +1,13 @@ --- 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 -online version: schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsCloudCallDataConnector @@ -40,7 +44,7 @@ Retrieves the Call Data Connector data from the local replica of the Central Man Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -50,7 +54,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md index 35921c36a2..2e03619361 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md @@ -1,9 +1,13 @@ --- 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 -online version: schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsCloudCallDataConnectorConfiguration @@ -73,7 +77,7 @@ 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 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -94,7 +98,7 @@ If this parameter is not specified, the Get-CsCloudCallDataConnectorConfiguratio Type: XdsIdentity Parameter Sets: Identity Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -109,7 +113,7 @@ Retrieves the CloudCallDataConnector configuration data from the local replica o Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -119,13 +123,12 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.WritableConfig.Settings.CallDataConnectorConfiguration diff --git a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md b/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md index b567b73a7f..0cec065b8a 100644 --- a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md +++ b/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsCloudMeetingPolicy @@ -123,28 +128,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -153,7 +138,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - -[Online Version](http://technet.microsoft.com/EN-US/library/ecb6d085-73b5-4a31-89ab-31fa411d4c85(OCS.15).aspx) - - diff --git a/skype/skype-ps/skype/Get-CsClsAgentStatus.md b/skype/skype-ps/skype/Get-CsClsAgentStatus.md index 0f9bfa1483..cf595df96b 100644 --- a/skype/skype-ps/skype/Get-CsClsAgentStatus.md +++ b/skype/skype-ps/skype/Get-CsClsAgentStatus.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClsAgentStatus @@ -75,7 +80,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -93,4 +98,3 @@ Or an XmlDocument object if the DefaultXml parameter is used. ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsClsConfiguration.md b/skype/skype-ps/skype/Get-CsClsConfiguration.md index 2c0dd51237..d64818736f 100644 --- a/skype/skype-ps/skype/Get-CsClsConfiguration.md +++ b/skype/skype-ps/skype/Get-CsClsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClsConfiguration @@ -154,7 +159,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -177,4 +182,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) [Set-CsClsConfiguration](Set-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsClsRegion.md b/skype/skype-ps/skype/Get-CsClsRegion.md index 05b4f865f7..2fbc717fd3 100644 --- a/skype/skype-ps/skype/Get-CsClsRegion.md +++ b/skype/skype-ps/skype/Get-CsClsRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClsRegion @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClsRegion](Remove-CsClsRegion.md) [Set-CsClsRegion](Set-CsClsRegion.md) - diff --git a/skype/skype-ps/skype/Get-CsClsScenario.md b/skype/skype-ps/skype/Get-CsClsScenario.md index 8b27c07464..b6d5b31459 100644 --- a/skype/skype-ps/skype/Get-CsClsScenario.md +++ b/skype/skype-ps/skype/Get-CsClsScenario.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClsScenario @@ -143,7 +148,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsClsSearchTerm.md b/skype/skype-ps/skype/Get-CsClsSearchTerm.md index 57f88a3f06..df614416c4 100644 --- a/skype/skype-ps/skype/Get-CsClsSearchTerm.md +++ b/skype/skype-ps/skype/Get-CsClsSearchTerm.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClsSearchTerm @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -163,4 +168,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsClsSearchTerm](Set-CsClsSearchTerm.md) - diff --git a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md b/skype/skype-ps/skype/Get-CsClsSecurityGroup.md index 06a57f2040..7c79d2ab0a 100644 --- a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/Get-CsClsSecurityGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsClsSecurityGroup @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md b/skype/skype-ps/skype/Get-CsCommonAreaPhone.md index e05563366c..97dc27f37a 100644 --- a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Get-CsCommonAreaPhone.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsCommonAreaPhone @@ -238,7 +243,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -264,4 +269,3 @@ Represents the Identity of the common area phone. [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Get-CsComputer.md b/skype/skype-ps/skype/Get-CsComputer.md index 4b0ed67e08..295846eabe 100644 --- a/skype/skype-ps/skype/Get-CsComputer.md +++ b/skype/skype-ps/skype/Get-CsComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsComputer @@ -136,7 +141,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -159,4 +164,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-CsComputer](Enable-CsComputer.md) [Test-CsComputer](Test-CsComputer.md) - diff --git a/skype/skype-ps/skype/Get-CsConferenceDirectory.md b/skype/skype-ps/skype/Get-CsConferenceDirectory.md index d673b9bd7c..aaeb78a46a 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/Get-CsConferenceDirectory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsConferenceDirectory @@ -116,7 +121,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -139,4 +144,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsConferenceDirectory](New-CsConferenceDirectory.md) [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) - diff --git a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md b/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md index c759f57f39..6ce2b822e0 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md +++ b/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsConferenceDisclaimer @@ -100,7 +105,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -121,4 +126,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsConferenceDisclaimer](Remove-CsConferenceDisclaimer.md) [Set-CsConferenceDisclaimer](Set-CsConferenceDisclaimer.md) - diff --git a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md b/skype/skype-ps/skype/Get-CsConferencingConfiguration.md index 15c4de60b8..381a5744ae 100644 --- a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsConferencingConfiguration @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsConferencingPolicy.md b/skype/skype-ps/skype/Get-CsConferencingPolicy.md index 7e63c5a8d6..570ad8b1b5 100644 --- a/skype/skype-ps/skype/Get-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Get-CsConferencingPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConferencingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsConferencingPolicy @@ -232,24 +237,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -275,4 +264,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) [Get-CsConferencingPolicy](Get-CsConferencingPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md b/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md index 2abbdf22b0..fdc95a47a5 100644 --- a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsConfigurationStoreLocation @@ -84,7 +89,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -106,4 +111,3 @@ The Get-CsConfigurationStoreLocation cmdlet reports back the location of the con [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md b/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md index bd37e00b30..8c4b36089d 100644 --- a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsConversationHistoryConfiguration @@ -103,7 +108,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -124,4 +129,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsConversationHistoryConfiguration](Remove-CsConversationHistoryConfiguration.md) [Set-CsConversationHistoryConfiguration](Set-CsConversationHistoryConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsCpsConfiguration.md b/skype/skype-ps/skype/Get-CsCpsConfiguration.md index 1d89b06dfa..2859c7b997 100644 --- a/skype/skype-ps/skype/Get-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/Get-CsCpsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsCpsConfiguration @@ -129,7 +134,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -154,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsCpsConfiguration](Set-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - diff --git a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md b/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md index bedb013ace..ab7cc8b8ab 100644 --- a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md +++ b/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDatabaseMirrorState @@ -62,7 +67,7 @@ For example: 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 Required: True Position: Named @@ -102,7 +107,7 @@ Allowed values for Skype for Business Server 2015 are: Type: DatabaseNameType 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 Required: False Position: Named @@ -118,7 +123,7 @@ Retrieves the backup mirror state from the local replica of the Central Manageme 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 Required: False Position: Named @@ -137,7 +142,7 @@ For example: 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 Required: False Position: Named @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md index 40520e849c..dcc4810931 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDeviceUpdateConfiguration @@ -138,7 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -161,4 +166,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md index 002f4dbb0d..0e5442fdfb 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDeviceUpdateRule @@ -151,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -176,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md index 4940601275..e828788cb7 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDiagnosticConfiguration @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md index 42b8242e07..70f111e8de 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDiagnosticHeaderConfiguration @@ -153,7 +158,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -176,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md index 4bff21968b..fe50bf5290 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDialInConferencingAccessNumber @@ -301,7 +306,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -324,4 +329,3 @@ The Get-CsDialInConferencingAccessNumber cmdlet accepts a string value represent [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md index 69528e3f5f..1a86bff077 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDialInConferencingConfiguration @@ -129,7 +134,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -152,4 +157,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md index c3172b43e8..7656e7a355 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDialInConferencingDtmfConfiguration @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,4 +162,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md b/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md index afe1cc6d92..1f82e950cc 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsDialInConferencingLanguageList @@ -118,7 +123,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -139,4 +144,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Get-CsDialPlan.md b/skype/skype-ps/skype/Get-CsDialPlan.md index dea174566d..bd10f2446f 100644 --- a/skype/skype-ps/skype/Get-CsDialPlan.md +++ b/skype/skype-ps/skype/Get-CsDialPlan.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsDialPlan @@ -96,7 +101,7 @@ The unique identifier designating the scope, and for per-user scope a name, to i 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -112,7 +117,7 @@ Performs a wildcard search that allows you to narrow down your results to only d 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -128,7 +133,7 @@ Retrieves the dial plan information from the local replica of the Central Manage 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -153,24 +158,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -198,4 +187,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Test-CsDialPlan](Test-CsDialPlan.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsEffectivePolicy.md b/skype/skype-ps/skype/Get-CsEffectivePolicy.md index 574c6e534d..117520586f 100644 --- a/skype/skype-ps/skype/Get-CsEffectivePolicy.md +++ b/skype/skype-ps/skype/Get-CsEffectivePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsEffectivePolicy @@ -187,7 +192,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -208,4 +213,3 @@ The cmdlet also accepts pipelined instances of the Active Directory user object. ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsEffectiveTenantDialPlan.md b/skype/skype-ps/skype/Get-CsEffectiveTenantDialPlan.md deleted file mode 100644 index 891bdd018b..0000000000 --- a/skype/skype-ps/skype/Get-CsEffectiveTenantDialPlan.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsEffectiveTenantDialPlan -schema: 2.0.0 ---- - -# Get-CsEffectiveTenantDialPlan - -## SYNOPSIS -Use the Get-CsEffectiveTenantDialPlan cmdlet to retrieve an effective tenant dial plan. - -## SYNTAX - -``` -Get-CsEffectiveTenantDialPlan [-Identity] <UserIdParameter> [-OU <OUIdParameter>] [-DomainController <Fqdn>] - [-Credential <PSCredential>] [-ResultSize <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsEffectiveTenantDialPlan cmdlet returns information about the effective tenant dial plan in an organization. -The returned effective Tenant Dial Plan contains the Identity and the Normalization rules that are effective for the user while using the EnterpriseVoice features. -The Identity is in the form TenantGUID_GlobalVoiceDialPlan_TenantDialPlan. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsEffectiveTenantDialPlan -Identity Vt1_User1 -``` - -This example gets the effective tenant dial plan for the Vt1_User1 organization. - - -## PARAMETERS - -### -Identity -The Identity parameter is the unique identifier of the tenant dial plan to retrieve. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Credential parameter specifies the user name 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. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OU -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. - -```yaml -Type: OUIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - - -## OUTPUTS - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md index 3e97500657..36aa47f5ad 100644 --- a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsEnhancedEmergencyServiceDisclaimer @@ -94,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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -117,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsEnhancedEmergencyServiceDisclaimer](Set-CsEnhancedEmergencyServiceDisclaimer.md) [Get-CsLocationPolicy](Get-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsExUmContact.md b/skype/skype-ps/skype/Get-CsExUmContact.md index 5a739b7fdb..e674e05256 100644 --- a/skype/skype-ps/skype/Get-CsExUmContact.md +++ b/skype/skype-ps/skype/Get-CsExUmContact.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsExUmContact @@ -207,7 +212,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -233,4 +238,3 @@ Accepts a pipelined string value representing the Identity of an Exchange UM con [Set-CsExUmContact](Set-CsExUmContact.md) [Move-CsExUmContact](Move-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md index 90a6b2954a..5fa4d707b7 100644 --- a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md @@ -1,17 +1,21 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsExternalAccessPolicy ## SYNOPSIS Returns information about the external access policies that have been configured for use in your organization. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; and, 3) access Skype for Business Server over the Internet, without having to log on to your internal network. -This cmdlet was introduced in Lync Server 2010. +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)](/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 @@ -39,12 +43,15 @@ External access policies can grant (or revoke) the ability of your users to do a 1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). + 3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. 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. -The Get-CsExternalAccessPolicy cmdlet provides a way for you to return information about all of the external access policies that have been configured for use in your organization. +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. +The Get-CsExternalAccessPolicy cmdlet provides a way for you to return information about all of the external access policies that have been configured for use in your organization. ## EXAMPLES @@ -56,7 +63,6 @@ Get-CsExternalAccessPolicy Example 1 returns a collection of all the external access policies configured for use in your organization. Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. - ### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" @@ -65,8 +71,6 @@ Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. Because access policy Identities must be unique, this command will never return more than one item. - - ### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond @@ -113,7 +117,6 @@ NOTE: The ApplicableTo parameter can only be used with Skype for Business Online NOTE: This command requires the Office 365 UsageLocation property to be configured for the user's Active Directory user account. - ## PARAMETERS ### -Identity @@ -145,18 +148,16 @@ Accept wildcard characters: False **Below Content Applies To:** Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 Enables you to do a wildcard search for external access policies. -For example, to find all the policies configured at the site scope, use this Filter: +For example, to find all the policies configured at the site scope, use this Filter: `site:*` -To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: +To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: `"S*".` Note that the Filter parameter can only be applied to the policy Identity. - - **Below Content Applies To:** Skype for Business Online Enables you to do a wildcard search for external access policies. @@ -170,8 +171,6 @@ To find the per-user policies Seattle, Seville, and Saskatoon (all of which star Note that the Filter parameter can only be applied to the policy Identity. - - ```yaml Type: String Parameter Sets: Filter, (All) @@ -262,43 +261,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy - ## NOTES - ## RELATED LINKS [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) @@ -308,4 +283,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md index 1ee885bb96..f3dc30cd98 100644 --- a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsExternalUserCommunicationPolicy @@ -14,7 +19,7 @@ Returns information about one or more external user communication policies confi ## SYNTAX ``` -Get-CsExternalUserCommunicationPolicy [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [-AsJob] [<CommonParameters>] +Get-CsExternalUserCommunicationPolicy [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [<CommonParameters>] ``` ## DESCRIPTION @@ -41,7 +46,7 @@ This example uses the Identity parameter to retrieve the external user communica 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:<ExternalUserCommunicationPolicy>. +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:<ExternalUserCommunicationPolicy>`. ### -------------------------- Example 4 ------------------------ ``` @@ -123,28 +128,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,10 +142,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps) +[New-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps) -[Set-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md b/skype/skype-ps/skype/Get-CsFIPSConfiguration.md index 6bfc63ac9b..4a4f0b69d7 100644 --- a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/Get-CsFIPSConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsFIPSConfiguration @@ -27,7 +32,7 @@ Get-CsFIPSConfiguration [[-Identity] <XdsIdentity>] [-LocalStore] [-Tenant <Guid ## DESCRIPTION The Federal Information Processing Standards (FIPS) are a series of standards and guidelines used by computers engaged in work for the US government; for example, there are FIPS standards that govern the use of such things as cryptography, encryption, and digital signatures. -(See http://www.itl.nist.gov/fipspubs/by-num.htm (http://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. +(See https://www.itl.nist.gov/fipspubs/by-num.htm (https://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. If you need to work with the United States government (or with other entities that follow FIPS) then you can enable FIPS compliance in Skype for Business Server. Keep in mind, however, that, for the on-premises version of Skype for Business Server, you have only a single, global collection of FIPS configuration settings: FIPS compliance can only be enabled or disabled for your entire Skype for Business Server implementation. @@ -135,7 +140,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -158,4 +163,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md index 1239a1559b..388bc6c94d 100644 --- a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsFileTransferFilterConfiguration @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -169,4 +174,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsGraphPolicy.md b/skype/skype-ps/skype/Get-CsGraphPolicy.md index 7db35a5e7d..69cd22f5e8 100644 --- a/skype/skype-ps/skype/Get-CsGraphPolicy.md +++ b/skype/skype-ps/skype/Get-CsGraphPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsGraphPolicy @@ -12,7 +17,7 @@ Use the `Get-CsGraphPolicy` cmdlet to return information about one or more graph ## SYNTAX ``` -Get-CsGraphPolicy [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [-AsJob] +Get-CsGraphPolicy [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [<CommonParameters>] ``` @@ -107,28 +112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -137,4 +122,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Grant-CsGraphPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csgraphpolicy?view=skype-ps) +[Grant-CsGraphPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md index 77a0326213..199078925f 100644 --- a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsGroupPickupUserOrbit @@ -84,7 +89,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -101,4 +106,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md index 3fa82e4b85..ce017ff110 100644 --- a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsHealthMonitoringConfiguration @@ -133,7 +138,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md index 216789f3f4..7910736a0e 100644 --- a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsHostedVoicemailPolicy @@ -55,14 +60,6 @@ Get-CsHostedVoicemailPolicy -Filter tag:* This command returns the policy settings for all per-user hosted voice mail policies (policies beginning with the tag scope). -### -------------------------- Example 4 -------------------------- -``` -Get-CsHostedVoicemailPolicy -Tenant "73d355dd-ce5d-4ab9-bf49-7b822c18dd98" -``` - -This command returns the hosted voice mail policy for the Skype for Business Online tenant with the tenant ID 73d355dd-ce5d-4ab9-bf49-7b822c18dd98. - - ## PARAMETERS ### -Identity @@ -73,7 +70,7 @@ The Identity includes the scope (in the case of global), the scope and site (for 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -90,7 +87,7 @@ This will retrieve all instances of a hosted voice mail policy where the Identit 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,55 +103,7 @@ Retrieves the hosted voice mail policy from the local replica of the Central Man 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 -Globally unique identifier (GUID) of the Skype for Business Online tenant account whose voicemail policy is to be retrieved. - -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: 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -164,7 +113,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +138,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsHostedVoicemailPolicy](Set-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsHostingProvider.md b/skype/skype-ps/skype/Get-CsHostingProvider.md index 41f0d34469..3e5f2a3e66 100644 --- a/skype/skype-ps/skype/Get-CsHostingProvider.md +++ b/skype/skype-ps/skype/Get-CsHostingProvider.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-cshostingprovider +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsHostingProvider schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsHostingProvider @@ -154,28 +159,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -202,4 +187,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsHuntGroup.md b/skype/skype-ps/skype/Get-CsHuntGroup.md deleted file mode 100644 index b3c8068746..0000000000 --- a/skype/skype-ps/skype/Get-CsHuntGroup.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsHuntGroup -schema: 2.0.0 ---- - -# Get-CsHuntGroup - -## SYNOPSIS -The Get-CsHuntGroup cmdlet returns the identified Call Queues. - -## SYNTAX - -``` -Get-CsHuntGroup [-PrimaryUri <System.Uri>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsHuntGroup cmdlet lets you retrieve information about the Call Queues in your organization. Call Queue output contains statistical data on the number of active calls that are in the queue. - -If called without parameters, Get-CsHuntgroup returns a collection of all Call Queues configured to be used in your organization. - -The Get-CsHuntGroup cmdlet may suggest additional steps required to complete the Call Queue setup. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsHuntGroup -``` - -This example gets all Call Queues in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" -``` - -This example gets the Call Queue with the primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com". If no Call Queue exists with the primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com", then this example generates an error. - - -## PARAMETERS - -### -PrimaryUri -The PrimaryUri parameter represents the SIP address for the Call Queue. It must start with "sip:". - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassDualWrite -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for Microsoft internal use only. - -PARAMVALUE: Fqdn - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.HuntGroup.Models.HuntGroup - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsHuntGroupTenantInformation.md b/skype/skype-ps/skype/Get-CsHuntGroupTenantInformation.md deleted file mode 100644 index 48cdd53e63..0000000000 --- a/skype/skype-ps/skype/Get-CsHuntGroupTenantInformation.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsHuntGroupTenantInformation -schema: 2.0.0 ---- - -# Get-CsHuntGroupTenantInformation - -## SYNOPSIS -The Get-CsHuntGroupTenantInformation cmdlet returns additional call queue information for the tenant. - -## SYNTAX - -``` -Get-CsHuntGroupTenantInformation [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsHuntGroupTenantInformation cmdlet returns additional call queue information for the tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsHuntGroupTenantInformation -``` -This example returns additional call queue information for the tenant. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md index cc3a7f3831..4fe4251dd1 100644 --- a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsHybridApplicationEndpoint @@ -50,7 +55,7 @@ This example uses the Filter parameter to retrieve all the hybrid application en ### -Credential Enables you to run the Get-CsHybridApplicationEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects. -To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic. +To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential @@ -175,7 +180,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,8 +194,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsHybridMediationServer.md b/skype/skype-ps/skype/Get-CsHybridMediationServer.md index cef597580d..22a1a60c23 100644 --- a/skype/skype-ps/skype/Get-CsHybridMediationServer.md +++ b/skype/skype-ps/skype/Get-CsHybridMediationServer.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsHybridMediationServer @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Gets the external FQDN of an Edge server access proxy that serves as a hosting provider to a user. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -106,28 +113,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,7 +125,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsHybridMediationServer](Set-CsHybridMediationServer.md) - -[Online Version](http://technet.microsoft.com/EN-US/library/ca9c1492-7716-47d7-99e9-bc8ddb096535(OCS.15).aspx) - - diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md index 57bae9d156..35c6ae3de8 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsHybridPSTNAppliance @@ -10,11 +15,13 @@ schema: 2.0.0 ## SYNOPSIS Use the `Get-CsHybridPSTNAppliance` cmdlet to retrieve information about your Skype for Business Cloud Connector Edition appliances. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` Get-CsHybridPSTNAppliance [-Name <String>] [-LocalStore] [[-Identity] <XdsGlobalRelativeIdentity>] -[-Tenant <Guid>] [-Filter <String>] [-SiteName <String>] [-AsJob] [<CommonParameters>] +[-Tenant <Guid>] [-Filter <String>] [-SiteName <String>] [<CommonParameters>] ``` ## DESCRIPTION @@ -164,28 +171,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -194,8 +181,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsHybridPSTNAppliance](https://docs.microsoft.com/en-us/powershell/module/skype/set-cshybridpstnappliance?view=skype-ps) +[Set-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance?view=skype-ps) -[Register-CsHybridPSTNAppliance](https://docs.microsoft.com/en-us/powershell/module/skype/register-cshybridpstnappliance?view=skype-ps) +[Register-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance?view=skype-ps) -[Unregister-CsHybridPSTNAppliance](https://docs.microsoft.com/en-us/powershell/module/skype/unregister-cshybridpstnappliance?view=skype-ps) +[Unregister-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md b/skype/skype-ps/skype/Get-CsHybridPSTNSite.md index 4d2725f68b..3bfc36476a 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Get-CsHybridPSTNSite.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsHybridPSTNSite @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the Get-CsHybridPSTNSite cmdlet to retrieve information about your hybrid public switched telephone network (PSTN) sites. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -123,28 +130,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +147,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md b/skype/skype-ps/skype/Get-CsIPPhonePolicy.md index 4c0386aa1b..7ae4ac2e57 100644 --- a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md +++ b/skype/skype-ps/skype/Get-CsIPPhonePolicy.md @@ -1,19 +1,24 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/get-csipphonepolicy +applicable: Skype for Business Server 2019 title: Get-CsIPPhonePolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsIPPhonePolicy ## SYNOPSIS -Use the Get-CsIPPhonePolicy cmdlet to get all the settings of the Skype for Business Online global IP phone policy. IP phone policies define the Skype for Business Online features that are available to users. +Use the Get-CsIPPhonePolicy cmdlet to get all the settings of the Skype for Business Online and Skype for Business Server 2019 global IP phone policy. IP phone policies define the Skype for Business features that are available to users. ## SYNTAX ``` -Get-CsIPPhonePolicy [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [-AsJob] [<CommonParameters>] +Get-CsIPPhonePolicy [[-Identity] <XdsIdentity>] [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [<CommonParameters>] ``` ## DESCRIPTION @@ -37,7 +42,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -53,7 +58,7 @@ This parameter is reserved for internal Microsoft use. Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: 1 @@ -69,7 +74,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -85,27 +90,7 @@ This parameter is reserved for internal Microsoft use. 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -115,7 +100,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,6 +116,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsIPPhonePolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csipphonepolicy?view=skype-ps) +[Grant-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy?view=skype-ps) -[Set-CsIPPhonePolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csipphonepolicy?view=skype-ps) +[Set-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsImConfiguration.md b/skype/skype-ps/skype/Get-CsImConfiguration.md index 9183fd763f..b174055e0f 100644 --- a/skype/skype-ps/skype/Get-CsImConfiguration.md +++ b/skype/skype-ps/skype/Get-CsImConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsImConfiguration @@ -102,7 +107,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -117,8 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md b/skype/skype-ps/skype/Get-CsImFilterConfiguration.md index 22c65a6f45..fec8ca39e9 100644 --- a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/Get-CsImFilterConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csimfilterconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsImFilterConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsImFilterConfiguration @@ -140,28 +145,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -184,4 +169,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsImFilterConfiguration](Remove-CsImFilterConfiguration.md) [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md b/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md index 3eb33d8fd1..4c07855098 100644 --- a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsImTranslationConfiguration @@ -86,7 +91,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -95,4 +100,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md index ab29930e2e..769b89632e 100644 --- a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsKerberosAccountAssignment @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Get-CsLisCivicAddress.md b/skype/skype-ps/skype/Get-CsLisCivicAddress.md index b8b7722c82..c1fd4ffdb0 100644 --- a/skype/skype-ps/skype/Get-CsLisCivicAddress.md +++ b/skype/skype-ps/skype/Get-CsLisCivicAddress.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisCivicAddress @@ -61,7 +66,7 @@ Example 3 retrieves all Location Information Server (LIS) civic addresses that h ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -82,4 +87,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Test-CsLisCivicAddress](Test-CsLisCivicAddress.md) [Get-CsLisLocation](Get-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Get-CsLisLocation.md b/skype/skype-ps/skype/Get-CsLisLocation.md index 56ba3a57e7..7b91277e0f 100644 --- a/skype/skype-ps/skype/Get-CsLisLocation.md +++ b/skype/skype-ps/skype/Get-CsLisLocation.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisLocation @@ -76,7 +81,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -99,4 +104,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsLisLocation](Set-CsLisLocation.md) [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Get-CsLisPort.md b/skype/skype-ps/skype/Get-CsLisPort.md index e9c2645c04..3eec392209 100644 --- a/skype/skype-ps/skype/Get-CsLisPort.md +++ b/skype/skype-ps/skype/Get-CsLisPort.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisPort @@ -54,7 +59,7 @@ The Where-Object cmdlet checks the City property of each item in the collection ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -75,4 +80,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisPort](Remove-CsLisPort.md) [Set-CsLisPort](Set-CsLisPort.md) - diff --git a/skype/skype-ps/skype/Get-CsLisServiceProvider.md b/skype/skype-ps/skype/Get-CsLisServiceProvider.md index 4d003220d3..2efdc5c58d 100644 --- a/skype/skype-ps/skype/Get-CsLisServiceProvider.md +++ b/skype/skype-ps/skype/Get-CsLisServiceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisServiceProvider @@ -38,7 +43,7 @@ There will never be more than one service provider for an E9-1-1 implementation, ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -58,4 +63,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisServiceProvider](Remove-CsLisServiceProvider.md) [Set-CsLisServiceProvider](Set-CsLisServiceProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsLisSubnet.md b/skype/skype-ps/skype/Get-CsLisSubnet.md index 80528cdcb7..070908d63a 100644 --- a/skype/skype-ps/skype/Get-CsLisSubnet.md +++ b/skype/skype-ps/skype/Get-CsLisSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisSubnet @@ -55,7 +60,7 @@ Because the Subnet ID must be unique, this command will return, at most, one obj ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -75,4 +80,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisSubnet](Remove-CsLisSubnet.md) [Set-CsLisSubnet](Set-CsLisSubnet.md) - diff --git a/skype/skype-ps/skype/Get-CsLisSwitch.md b/skype/skype-ps/skype/Get-CsLisSwitch.md index 68d30934a5..b4fbab5b8d 100644 --- a/skype/skype-ps/skype/Get-CsLisSwitch.md +++ b/skype/skype-ps/skype/Get-CsLisSwitch.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisSwitch @@ -65,7 +70,7 @@ The Where-Object cmdlet checks the City property of each item in the collection ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -86,4 +91,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisSwitch](Remove-CsLisSwitch.md) [Set-CsLisSwitch](Set-CsLisSwitch.md) - diff --git a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md b/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md index db18f57ff1..469f7a2244 100644 --- a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLisWirelessAccessPoint @@ -65,7 +70,7 @@ The Where-Object cmdlet checks the City property of each item in the collection ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -86,4 +91,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisWirelessAccessPoint](Remove-CsLisWirelessAccessPoint.md) [Set-CsLisWirelessAccessPoint](Set-CsLisWirelessAccessPoint.md) - diff --git a/skype/skype-ps/skype/Get-CsLocationPolicy.md b/skype/skype-ps/skype/Get-CsLocationPolicy.md index ed699f6c11..06e3d908b0 100644 --- a/skype/skype-ps/skype/Get-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Get-CsLocationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsLocationPolicy @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -173,4 +178,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) [Test-CsLocationPolicy](Test-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsManagementConnection.md b/skype/skype-ps/skype/Get-CsManagementConnection.md index 272bb0c4b0..be0b6e4a2d 100644 --- a/skype/skype-ps/skype/Get-CsManagementConnection.md +++ b/skype/skype-ps/skype/Get-CsManagementConnection.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsManagementConnection @@ -57,7 +62,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -77,4 +82,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsManagementConnection](Remove-CsManagementConnection.md) [Set-CsManagementConnection](Set-CsManagementConnection.md) - diff --git a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md b/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md index d1e7924cf8..a9c3ebe4b8 100644 --- a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md +++ b/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsManagementStoreReplicationStatus @@ -120,7 +125,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -141,4 +146,3 @@ If the CentralManagementStoreStatus parameter is used, then the cmdlet returns i ## RELATED LINKS [Invoke-CsManagementStoreReplication](Invoke-CsManagementStoreReplication.md) - diff --git a/skype/skype-ps/skype/Get-CsMcxConfiguration.md b/skype/skype-ps/skype/Get-CsMcxConfiguration.md index 11a61f21e9..8a44cb988e 100644 --- a/skype/skype-ps/skype/Get-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/Get-CsMcxConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMcxConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsMcxConfiguration @@ -155,7 +160,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -172,4 +177,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsMediaConfiguration.md b/skype/skype-ps/skype/Get-CsMediaConfiguration.md index d16fb02e57..226f87551c 100644 --- a/skype/skype-ps/skype/Get-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/Get-CsMediaConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsMediaConfiguration @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsMediaConfiguration](Remove-CsMediaConfiguration.md) [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md b/skype/skype-ps/skype/Get-CsMeetingConfiguration.md index aa1e8a8854..431f2547ca 100644 --- a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsMeetingConfiguration.md @@ -1,8 +1,16 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMeetingConfiguration schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +manager: bulenteg +audience: ITPro +ms.topic: reference +ms.localizationpriority: medium --- # Get-CsMeetingConfiguration @@ -180,24 +188,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -220,4 +212,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsMeetingConfiguration](Remove-CsMeetingConfiguration.md) [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md b/skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md deleted file mode 100644 index 7dfd23ecdf..0000000000 --- a/skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsMeetingMigrationStatus -schema: 2.0.0 ---- - -# Get-CsMeetingMigrationStatus - -## SYNOPSIS -You use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. - -## SYNTAX -``` -Get-CsMeetingMigrationStatus [[-Identity] <UserIdParameter>] [-Confirm] [-EndTime <DateTime>] [-StartTime <DateTime>] - [-SummaryOnly] [-Tenant <Guid>] [-WhatIf] [-AsJob] [-State <StateType>] [<CommonParameters>] -``` - -## DESCRIPTION -Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. - -You can use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsMeetingMigrationStatus -SummaryOnly -``` - -This example is used to get a summary status of all MMS migrations. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsMeetingMigrationStatus -UserId "ashaw@contoso.com" -``` - -This example get 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. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start date of the date range. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end date of the date range. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummaryOnly -Specified that you want a summary status of MMS migrations returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### -State -With this parameter you can filter by migration state. Possible values are: -* Pending -* InProgress -* Failed -* Succeeded - -```yaml -Type: StateType -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Get-CsTenantMigrationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-cstenantmigrationconfiguration?view=skype-ps) - -[Get-CsOnlineDialInConferencingTenantSettings](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinedialinconferencingtenantsettings?view=skype-ps) - -[Start-CsExMeetingMigration](https://docs.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsMeetingRoom.md b/skype/skype-ps/skype/Get-CsMeetingRoom.md index 76cdb2700e..4401dd0254 100644 --- a/skype/skype-ps/skype/Get-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Get-CsMeetingRoom.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMeetingRoom schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsMeetingRoom @@ -13,12 +18,15 @@ A meeting room is a conferencing device designed to address video conferencing a This cmdlet was introduced in Lync Server 2013. +**Note**: This cmdlet is not supported for managing Microsoft Teams Rooms. You must use the methods described in the [Microsoft Teams Rooms](/microsoftteams/rooms) documentation to manage Microsoft Teams Rooms. + + ## SYNTAX ``` Get-CsMeetingRoom [[-Identity] <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LdapFilter <String>] [-OU <OUIdParameter>] - [-ResultSize <Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32]>] [-AsJob] + [-ResultSize <Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32]>] [<CommonParameters>] ``` @@ -216,24 +224,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -259,4 +251,3 @@ The Get-CsMeetingRoom cmdlet accepts a pipelined string value representing the I [Move-CsMeetingRoom](Move-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Get-CsMobilityPolicy.md b/skype/skype-ps/skype/Get-CsMobilityPolicy.md index 4292f27c49..c59665485e 100644 --- a/skype/skype-ps/skype/Get-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Get-CsMobilityPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMobilityPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsMobilityPolicy @@ -199,24 +204,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -233,4 +222,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md index 374915957c..de1572dc01 100644 --- a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkBandwidthPolicyProfile @@ -109,7 +114,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkBandwidthPolicyProfile](Remove-CsNetworkBandwidthPolicyProfile.md) [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md b/skype/skype-ps/skype/Get-CsNetworkConfiguration.md index fa484eb793..5914281385 100644 --- a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsNetworkConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsNetworkConfiguration @@ -117,24 +122,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -169,4 +158,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md index 718e8b82e3..c65e85e16f 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkInterRegionRoute @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkInterRegionRoute](Remove-CsNetworkInterRegionRoute.md) [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md index c25bcd11ec..447ed6ca95 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkInterSitePolicy @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkInterSitePolicy](Remove-CsNetworkInterSitePolicy.md) [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkInterface.md b/skype/skype-ps/skype/Get-CsNetworkInterface.md index 086395d943..cce4863773 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterface.md +++ b/skype/skype-ps/skype/Get-CsNetworkInterface.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkInterface @@ -157,7 +162,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -176,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsComputer](Get-CsComputer.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkRegion.md b/skype/skype-ps/skype/Get-CsNetworkRegion.md index 9d3528ef30..bac9faa045 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegion.md +++ b/skype/skype-ps/skype/Get-CsNetworkRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkRegion @@ -120,7 +125,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -143,4 +148,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkRegion](Remove-CsNetworkRegion.md) [Set-CsNetworkRegion](Set-CsNetworkRegion.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md b/skype/skype-ps/skype/Get-CsNetworkRegionLink.md index 3cd761e916..9c7f1775f6 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/Get-CsNetworkRegionLink.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkRegionLink @@ -121,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -144,4 +149,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkRegionLink](Remove-CsNetworkRegionLink.md) [Set-CsNetworkRegionLink](Set-CsNetworkRegionLink.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkSite.md b/skype/skype-ps/skype/Get-CsNetworkSite.md index 6d33a53b31..63eaeaaf8c 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSite.md +++ b/skype/skype-ps/skype/Get-CsNetworkSite.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkSite @@ -120,7 +125,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -143,4 +148,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkSite](Remove-CsNetworkSite.md) [Set-CsNetworkSite](Set-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkSubnet.md b/skype/skype-ps/skype/Get-CsNetworkSubnet.md index 9c78852cc5..aca38d63a4 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/Get-CsNetworkSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsNetworkSubnet @@ -117,7 +122,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +145,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkSubnet](Remove-CsNetworkSubnet.md) [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) - diff --git a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md b/skype/skype-ps/skype/Get-CsOAuthConfiguration.md index 03932d6754..b2c5cfbfdd 100644 --- a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md +++ b/skype/skype-ps/skype/Get-CsOAuthConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsOAuthConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsOAuthConfiguration @@ -17,12 +22,12 @@ This cmdlet was introduced in Lync Server 2013. ### Identity (Default) ``` -Get-CsOAuthConfiguration [[-Identity] <XdsIdentity>] [-LocalStore] [-Tenant <Guid>] [-AsJob] [<CommonParameters>] +Get-CsOAuthConfiguration [[-Identity] <XdsIdentity>] [-LocalStore] [-Tenant <Guid>] [<CommonParameters>] ``` ### Filter ``` -Get-CsOAuthConfiguration [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [-AsJob] [<CommonParameters>] +Get-CsOAuthConfiguration [-Filter <String>] [-LocalStore] [-Tenant <Guid>] [<CommonParameters>] ``` @@ -132,28 +137,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,4 +156,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsOAuthConfiguration](Set-CsOAuthConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsOAuthServer.md b/skype/skype-ps/skype/Get-CsOAuthServer.md index cf27564a49..d8186132f4 100644 --- a/skype/skype-ps/skype/Get-CsOAuthServer.md +++ b/skype/skype-ps/skype/Get-CsOAuthServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsOAuthServer @@ -137,7 +142,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsOAuthServer](Remove-CsOAuthServer.md) [Set-CsOAuthServer](Set-CsOAuthServer.md) - diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md deleted file mode 100644 index f17475acfa..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineApplicationEndpoint -schema: 2.0.0 ---- - -# Get-CsOnlineApplicationEndpoint - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Get-CsOnlineApplicationEndpoint [-Uri] <String> [-Audience <String>] [-Ring <String>] [-PhoneNumber <String>] - [-IsInternalRun <Boolean>] [-Tenant <Guid>] [-RunFullProvisioningFlow <Boolean>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### Example 1 -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -Uri -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -{{Fill Audience Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -{{Fill DomainController Description}} - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -{{Fill IsInternalRun Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -{{Fill PhoneNumber Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -{{Fill Ring Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -{{Fill RunFullProvisioningFlow Description}} - -```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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingTenantSettings.md b/skype/skype-ps/skype/Get-CsOnlineDialInConferencingTenantSettings.md deleted file mode 100644 index b1d9c1c4bb..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingTenantSettings.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDialInConferencingTenantSettings -schema: 2.0.0 ---- - -# Get-CsOnlineDialInConferencingTenantSettings - -## SYNOPSIS -Use the Get-CsOnlineDialInConferencingTenantSettings cmdlet to retrieve tenant level settings for dial-in conferencing. - -## SYNTAX - -### Identity (Default) -``` -Get-CsOnlineDialInConferencingTenantSettings [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] - [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlineDialInConferencingTenantSettings [-Tenant <Guid>] [-Filter <String>] [-LocalStore] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDialInConferencingTenantSettings -``` - -This example returns the global setting for the tenant administrator's organization. - - -## PARAMETERS - -### -Filter -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 -``` - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -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: 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.WritableConfig.Settings.OnLineDialInConferencing.OnLineDialInConferencingTenantSettings - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUser.md deleted file mode 100644 index 53f9d90e0a..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUser.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineDialInConferencingUser -schema: 2.0.0 ---- - -# Get-CsOnlineDialInConferencingUser - -## SYNOPSIS -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. - -## SYNTAX - -``` -Get-CsOnlineDialInConferencingUser [-BridgeName <String>] [-ServiceNumber <String>] [-TenantDomain <String>] - [-LdapFilter <String>] [[-Identity] <UserIdParameter>] [-Tenant <Guid>] [-BridgeId <Guid>] [-ResultSize <Int32>] - [-DomainController <Fqdn>] [-Force] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet will only return users that have been enabled for audio conferencing using Microsoft as the audio conferencing provider. -Users that are enabled for audio conferencing using a third-party audio conferencing provider won't be returned. -If there are no users in the organization that have been enabled for audio conferencing, then the cmdlet will return no results. - -The see a list of users with conferencing providers other than Microsoft use the Get-CsUserAcp cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:> Get-CsOnlineDialInConferencingUser -LdapFilter "Department=Finance" -``` - -This example uses the LdapFilter parameter to limit the returned data to users who work in the Finance department. - -### -------------------------- Example 2 -------------------------- -``` -PS C:> Get-CsOnlineDialInConferencingUser -ServiceNumber +14255034412 | Format-Table -Property DisplayName, SipAddress -``` - -This example returns users who have been enabled for audio conferencing provided by Microsoft, and are assigned to the specified service number. - -By default, the Get-CsOnlineDialInConferencingUser cmdlet returns a large number of properties. -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 and SipAddress. - - -## PARAMETERS - -### -BridgeId -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. - -```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 -Specifies the name for the audio conferencing bridge. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the user to retrieve. -The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -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, +\<E.164 number\> and tel:\<E.164 number\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -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. -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: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -NOTE: This parameter is reserved for internal Microsoft use. - -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Enable-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/enable-csonlinedialinconferencinguser?view=skype-ps) - -[Disable-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/disable-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinedialinconferencinguser?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserInfo.md b/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserInfo.md deleted file mode 100644 index 26d1b658af..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserInfo.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDialInConferencingUserInfo -schema: 2.0.0 ---- - -# Get-CsOnlineDialInConferencingUserInfo - -## SYNOPSIS -Use the `Get-CsOnlineDialInConferencingUserInfo` cmdlet to view the properties and settings of users that are enabled for dial-in conferencing and are using Microsoft or third-party provider as their PSTN conferencing provider. - -## SYNTAX - -### IdentityParams -``` -Get-CsOnlineDialInConferencingUserInfo [-Identity] <UserIdParameter> [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -### TenantIdParams -``` -Get-CsOnlineDialInConferencingUserInfo [-Tenant <Guid>] [-Skip <Int32>] [-First <Int32>] - [-SearchQuery <String>] [-Select <FilterSelection>] [-Filter <String>] [-SortDescending] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet will return users that have been enabled for audio conferencing using Microsoft or a third-party as the audio conferencing provider. If there are no users in the organization that have been enabled for audio conferencing, then the cmdlet will return no results. - -You can use [Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) cmdlet to return only users that have been enabled for audio conferencing using Microsoft as the audio conferencing provider. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDialInConferencingUserInfo -Filter {Provider -eq "InterCall"} -First 10 -``` - -This example returns users who have been enabled for audio conferencing provided by InterCall, but it will show only the first 10 users. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineDialInConferencingUserInfo -Select ConferencingProviderOther -``` - -This example returns users who have been enabled for audio conferencing provided by other than Microsoft. - -## PARAMETERS - -### -Identity -Specifies the user to retrieve. The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to limit the returned data by filtering on Skype for Business specific attributes. For example, you can limit returned data to users who have been assigned a specific third-party provider. - -The Filter parameter uses the same filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only users who have InterCall as Audio Conferencing Provider, with Provider representing the attribute, and -eq representing the comparison operator (equal to): - -{Provider -eq "InterCall"} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -When present, the cmdlet returns the first X number of users from the list of all the users enabled for dial-in conferencing. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchQuery -The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Use next values to filter the output: -* DialInConferencingOn: Display all the users who are enabled for dial-in conferencing. -* DialInConferencingOff: Display all the users who are not enabled for dial-in conferencing. -* ConferencingProviderMS: Display all the users who are CPC enabled. -* ConferencingProviderOther: Display all the users who have 3rd party ACP. -* ReadyForMigrationToCPC: Display all the users who have 3rd party ACP and have been assigned a CPC license. -* NoFilter: Display all the users. - -```yaml -Type: FilterSelection -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Skips (does not select) the specified number of items. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortDescending -Indicates that the cmdlet sorts the objects in descending order. The default is ascending order. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) \ No newline at end of file diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserState.md b/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserState.md deleted file mode 100644 index ae6e84c3ff..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserState.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDialInConferencingUserState -schema: 2.0.0 ---- - -# Get-CsOnlineDialInConferencingUserState - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Get-CsOnlineDialInConferencingUserState [[-Identity] <UserIdParameter>] [-Tenant <Guid>] - [-TenantDomain <String>] [-Provider <ProviderType>] [-LicenseState <String[]>] - [-ResultSize <Unlimited>] [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### Example 1 -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LicenseState -PARAMVALUE: String\[\] - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -PARAMVALUE: AllProviders | NoProviders | Microsoft | ThirdParty - -```yaml -Type: ProviderType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -PARAMVALUE: Unlimited - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsOnlineDialOutPolicy.md b/skype/skype-ps/skype/Get-CsOnlineDialOutPolicy.md deleted file mode 100644 index b6aa71fb0c..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialOutPolicy.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDialOutPolicy -schema: 2.0.0 ---- - -# Get-CsOnlineDialOutPolicy - -## SYNOPSIS - -## SYNTAX - -### Identity (Default) -``` -Get-CsOnlineDialOutPolicy [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlineDialOutPolicy [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Filter -{{Fill Filter Description}} - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -{{Fill Identity Description}} - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -{{Fill LocalStore Description}} - -```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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingPolicy.md b/skype/skype-ps/skype/Get-CsOnlineDialinConferencingPolicy.md deleted file mode 100644 index 28db2f39e0..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingPolicy.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDialinConferencingPolicy -schema: 2.0.0 ---- - -# Get-CsOnlineDialinConferencingPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Get-CsOnlineDialinConferencingPolicy [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlineDialinConferencingPolicy [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Filter -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md b/skype/skype-ps/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md deleted file mode 100644 index 42d9d87d2e..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDialinConferencingTenantConfiguration -schema: 2.0.0 ---- - -# 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 - -### Identity (Default) -``` -Get-CsOnlineDialinConferencingTenantConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] - [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlineDialinConferencingTenantConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] - [<CommonParameters>] -``` - -## DESCRIPTION -The dial-in conferencing configuration specifies only if dial-in conferencing is enabled for the tenant. -By contrast, the dial-in conferencing tenant settings specify what functions are available during a conference call. -For example, whether or not entries and exits from the call are announced. -The settings also manage some of the administrative functions, such as when users get notification of administrative actions, like a PIN change. -For more information on settings and their customization, see Set-CsOnlineDialInConferencingTenantSettings. - -This cmdlet currently displays only the enabled or disabled status of your tenant configuration. -There is one configuration per tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDialinConferencingTenantConfiguration -``` - -This example returns the configuration for the tenant administrator's organization. - - -## PARAMETERS - -### -Filter -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 -``` - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -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: 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.WritableConfig.Settings.OnLineDialInConferencing.OnLineDialInConferencingTenantConfiguration - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenant.md b/skype/skype-ps/skype/Get-CsOnlineDirectoryTenant.md deleted file mode 100644 index 64e51044be..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenant.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDirectoryTenant -schema: 2.0.0 ---- - -# Get-CsOnlineDirectoryTenant - -## SYNOPSIS -Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve a tenant and associated parameters from the Business Voice Directory. - -## SYNTAX - -``` -Get-CsOnlineDirectoryTenant [[-Tenant] <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The following is an example of the Get-CsOnlineDirectoryTenant cmdlet's console output. - -Get-CsOnlineDirectoryTenant - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : 7a205197-8e59-487d-b9fa-3fc1b108f1e5 - -DefaultBridge : 00000000-0000-0000-0000-000000000000 - -Numbers : {13479167372, 13479167375, 13479167377, 13479167386...} - -Bridges : {Id = \[5bc815ae-d9e9-4fb6-af74-cf4fa73ceaa6\], Name = \[Conference Bridge\], DefaultServiceNumber = \[\], - -IsDefaultBridge = \[False\]} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5 -``` - -This example returns the tenant specified by GUID. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can find your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - - -## OUTPUTS - -### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacTenant - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md b/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md deleted file mode 100644 index b04713fc0d..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineDirectoryTenantNumberCities -schema: 2.0.0 ---- - -# Get-CsOnlineDirectoryTenantNumberCities - -## SYNOPSIS -Use the Get-CsOnlineDirectoryTenantNumberCities cmdlet to retrieve the cities for which telephone numbers have been acquired by your organization. - -## SYNTAX - -``` -Get-CsOnlineDirectoryTenantNumberCities [[-Tenant] <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet can be used to fetch all the cities for which your organization has already acquired telephone numbers. -It is mainly used to filter cities for which telephone numbers are acquired. - -The console output will be in the form: - -Get-CsOnlineDirectoryTenantNumberCities - -NOAM-US-CA-LA - -NOAM-US-IL-CH - -NOAM-US-NY-NY - -NOAM-US-TX-DA - -NOAM-US-MA-BO - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDirectoryTenantNumberCities -``` - -This example returns all the cities for which telephone numbers have been acquired by your organization. - - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - - -## OUTPUTS - -### IList<string> containing the geocodes of the relevant cities. - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md deleted file mode 100644 index ceef8e983c..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 ---- - -# Get-CsOnlineEnhancedEmergencyServiceDisclaimer - -## SYNOPSIS -Use the Get-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. - -## SYNTAX - -``` -Get-CsOnlineEnhancedEmergencyServiceDisclaimer [-CountryOrRegion <CountryInfo>] [-DomainController <Fqdn>] [-Force] [-Tenant <Guid>] [-Version <String>] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -You can use this cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. The United States is currently the only country supported. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion "US" -``` - -This example returns your organization's enhanced emergency service terms and conditions acceptance status. - - -## PARAMETERS - -### -CountryOrRegion -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". - -```yaml -Type: CountryInfo -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 - - -## RELATED LINKS -[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlineenhancedemergencyservicedisclaimer?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md deleted file mode 100644 index f92502a001..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineLisCivicAddress -schema: 2.0.0 ---- - -# Get-CsOnlineLisCivicAddress - -## SYNOPSIS -Use the Get-CsOnlineLisCivicAddress cmdlet to retrieve information about existing emergency civic addresses defined in the Location Information Service (LIS.) - -## SYNTAX - -``` -Get-CsOnlineLisCivicAddress [-CivicAddressId <Guid>] [-LocationId <Guid>] - [-PopulateNumberOfVoiceUsers] [-PopulateNumberOfTelephoneNumbers] [-AssignmentStatus <String>] - [-City <String>] [-CountryOrRegion <String>] [-Description <String>] [-ValidationStatus <String>] - [-ResultSize <Int32>] [-NumberOfResultsToSkip <Int32>] [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineLisCivicAddress -CivicAddressId 235678321ee38d9a5-33dc-4a32-9fb8-f234cedb91ac -``` - -This example returns the civic address with the specified identification. - - - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineLisCivicAddress -City Seattle -``` - -This example returns all the civic addresses in the city of Seattle. - - -## PARAMETERS - -### -AssignmentStatus -Specifies whether the retrieved addresses have been assigned to users or not. -Valid inputs are "Assigned", or "Unassigned". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the city of the target civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CivicAddressId -Specifies the identification number of the civic address to return. - -```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 -``` - -### -CountryOrRegion -Specifies the country or region of the target civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the administrator defined description of the target civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -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 -``` - -### -NumberOfResultsToSkip -Specifies the number of results to skip. -If there are a large number of civic addresses, you can limit the number of returns by using the ResultSize parameter. -If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. -For example the command below will return civic addresses 26-50 for Seattle. - -`Get-CsOnlineLisCivicAddress -City Seattle -ResultSize 25 -NumberOfResultsToSkip 25` - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopulateNumberOfVoiceUsers -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -Specifies the maximum number of results to return. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ValidationStatus -Specifies the validation status of the addresses to be returned. -Valid inputs are: Valid, Invalid, and Notvalidated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### -PopulateNumberOfTelephoneNumbers -{{Fill PopulateNumberOfTelephoneNumbers Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - - -## OUTPUTS - -### One or more instances of civic address objects. - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineLisLocation.md b/skype/skype-ps/skype/Get-CsOnlineLisLocation.md deleted file mode 100644 index d38de2a7e2..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineLisLocation.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineLisLocation -schema: 2.0.0 ---- - -# Get-CsOnlineLisLocation - -## SYNOPSIS -Use the Get-CsOnlineLisLocation cmdlet to retrieve information on previously defined locations in the Location Information Service (LIS.) - -## SYNTAX - -### GetByLocationID (Default) -``` -Get-CsOnlineLisLocation [-PopulateNumberOfVoiceUsers] [-PopulateNumberOfTelephoneNumbers] - [-AssignmentStatus <String>] [-City <String>] [-CountryOrRegion <String>] [-Description <String>] - [-ValidationStatus <String>] [-ResultSize <Int32>] [-NumberOfResultsToSkip <Int32>] [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -### UseCivicAddressId -``` -Get-CsOnlineLisLocation -CivicAddressId <Guid> [-PopulateNumberOfVoiceUsers] - [-PopulateNumberOfTelephoneNumbers] [-AssignmentStatus <String>] [-City <String>] [-CountryOrRegion <String>] - [-Description <String>] [-ValidationStatus <String>] [-ResultSize <Int32>] [-NumberOfResultsToSkip <Int32>] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -### UseLocationId -``` -Get-CsOnlineLisLocation [-PopulateNumberOfVoiceUsers] [-PopulateNumberOfTelephoneNumbers] - [-LocationId <Guid>] [-AssignmentStatus <String>] [-City <String>] [-CountryOrRegion <String>] - [-Description <String>] [-ValidationStatus <String>] [-ResultSize <Int32>] [-NumberOfResultsToSkip <Int32>] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -### UseLocation -``` -Get-CsOnlineLisLocation [-PopulateNumberOfVoiceUsers] [-PopulateNumberOfTelephoneNumbers] -Location <String> - [-AssignmentStatus <String>] [-City <String>] [-CountryOrRegion <String>] [-Description <String>] - [-ValidationStatus <String>] [-ResultSize <Int32>] [-NumberOfResultsToSkip <Int32>] [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineLisLocation -City Seattle -ResultSize 25 -ValidationStatus Validated -``` - -This example returns a maximum of 25 validated locations in Seattle. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineLisLocation -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -``` - -This example returns the locations associated with a civic address specified by its unique identifier. - -### -------------------------- Example 3 -------------------------- -``` -Get-CsOnlineLisLocation -Location "3rd Floor Cafe" -``` - -This example returns the location described as the "3rd Floor Cafe". - -### -------------------------- Example 4 -------------------------- -``` -Get-CsOnlineLisLocation -LocationId 5aa884e8-d548-4b8e-a289-52bfd5265a6e -``` - -This example returns the information on one location specified by its unique identifier. - - -## PARAMETERS - -### -CivicAddressId -Specifies the identification number of the civic address that is associated with the target locations. - -```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 -``` - -### -Location -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: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentStatus -Specifies whether the retrieved locations have been assigned to users or not. -Valid inputs are "Assigned", or "Unassigned". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the city of the target location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the country or region of the target location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the administrator defined description of the civic address that is associated with the target locations. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -Specifies the unique identifier of the target location. - -```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 -``` - -### -NumberOfResultsToSkip -Specifies the number of results to skip. -If there are a large number of locations, you can limit the number of returns by using the ResultSize parameter. -If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. -For example the command below will return locations 26-50 for Seattle. - -`Get-CsOnlineLisLocation -City Seattle -ResultSize 25 -NumberOfResultsToSkip 25` - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopulateNumberOfVoiceUsers -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -Specifies the maximum number of results to return. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ValidationStatus -Specifies the validation status of the addresses to be returned. -Valid inputs are: Valid, Invalid, and Notvalidated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### -PopulateNumberOfTelephoneNumbers -{{Fill PopulateNumberOfTelephoneNumbers Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - - -## OUTPUTS - -### Returns an instance, or instances of emergency location objects. - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md deleted file mode 100644 index 46512ac813..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineNumberPortInOrder -schema: 2.0.0 ---- - -# Get-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -Get-CsOnlineNumberPortInOrder [-Tenant <Guid>] [-PortInOrderId <String>] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - -## PARAMETERS - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortInOrderId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md b/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md deleted file mode 100644 index 8c63a3a4c8..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineNumberPortOutOrderPin -schema: 2.0.0 ---- - -# Get-CsOnlineNumberPortOutOrderPin - -## SYNOPSIS - - -## SYNTAX - -``` -Get-CsOnlineNumberPortOutOrderPin [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -{{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 -{{Fill DomainController Description}} - -```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 -{{Fill Force Description}} - -```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 -{{Fill Tenant Description}} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlinePstnUsage.md b/skype/skype-ps/skype/Get-CsOnlinePstnUsage.md deleted file mode 100644 index 246beb44f5..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlinePstnUsage.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Get-CsOnlinePstnUsage - -## SYNOPSIS -Returns information about online public switched telephone network (PSTN) usage records used in your tenant. - -## SYNTAX - -### Identity (Default) -``` -Get-CsOnlinePstnUsage [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlinePstnUsage [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -Online PSTN usages are string values that are used for call authorization. An online PSTN usage links an online voice policy to a route. The `Get-CsOnlinePstnUsage` cmdlet retrieves the list of all online PSTN usages available within a tenant. - -This cmdlet is used when configuring Microsoft Phone System Direct Routing. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Get-CSOnlinePSTNUsage -``` - -This command returns the list of global PSTN usages available within the tenant. - -## PARAMETERS - -### -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. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The level at which these settings are applied. The only identity that can be applied to PSTN usages is Global. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Set-CsOnlinePstnUsage](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinepstnusage?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineSipDomain.md b/skype/skype-ps/skype/Get-CsOnlineSipDomain.md deleted file mode 100644 index c7f3d0f9fe..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineSipDomain.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineSipDomain -schema: 2.0.0 ---- - -# Get-CsOnlineSipDomain - -## SYNOPSIS -**THIS IS PRELIMINARY DOCUMENTATION OF UPCOMING FUNCTIONALITY**</br> - -This cmdlet lists online sip domains and their enabled/disabled status. In a disabled domain, provisioning of users is blocked. Once a domain is re-enabled, provisioning of users in that domain will happen. - -## SYNTAX - -``` -Get-CsOnlineSipDomain [-Domain <String>] [-DomainType <DomainStatus>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is useful for organizations consolidating multiple on-premises deployments of Skype for Business Server into a single Office 365 tenant. During consolidation, sip domains for all forests hosting Skype for Business Server - other than the forest currently in hybrid mode - must be disabled. Once a hybrid deployment is fully migrated to the cloud and detached from Office 365, the next forest can start migration to the cloud. This cmdlet allows administrators to view the status of sip domains in their Office 365 tenant. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsOnlineSipDomain -``` - -List all online SIP domains in the tenant and show their enabled/disabled status. - -### Example 2 -```powershell -PS C:\> Get-CsOnlineSipDomain -DomainType Disabled -``` - -List all disabled online SIP domains in the tenant. - -## PARAMETERS - -### -Domain -A specific domain to get the status of. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -DomainType -This indicates the status of an online sip domain, which can be either enabled or disabled. - -```yaml -Type: DomainStatus -Parameter Sets: (All) -Aliases: -Accepted values: All, Enabled, Disabled -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.Provision.OSD.OnlineSipDomainBase+DomainState -## NOTES - -## RELATED LINKS - -[Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) -[Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md deleted file mode 100644 index 8042c117c7..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberAvailableCount -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberAvailableCount - -## SYNOPSIS -Use the Get-CsOnlineTelephoneNumberAvailableCount cmdlet to retrieve the total telephone numbers your organization is licensed to acquire. - -## SYNTAX -``` -Get-CsOnlineTelephoneNumberAvailableCount [[-Tenant] <Guid>] [-InventoryType <String>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The console output of this cmdlet will be in the form: - -Get-CsOnlineTelephoneNumberAvailableCount - -RunspaceId Count - -------------- ------ - -37c11bb0-3064-4e36-a0af-05efe9ee2bd3 11010 - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberAvailableCount -``` - -This example returns the total telephone numbers your organization is licensed to acquire. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### LacAvailableNumberCount object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md deleted file mode 100644 index 8081ea50a7..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryAreas -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberInventoryAreas - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryAreas` cmdlet to retrieve the geographical areas where specified inventory types are supported. - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryAreas [-Tenant <Guid>] -RegionalGroup <String> - -CountryOrRegion <String> [-Area <String>] -InventoryType <String> [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION -Following is an example of the console output for the Get-CsOnlineTelephoneNumberInventoryAreas cmdlet. - -Get-CsOnlineTelephoneNumberInventoryAreas -InventoryType Subscriber -RegionalGroup NOAM -CountryOrRegion US - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : IL - -DefaultName : Illinois - -Cities : {} - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : MA - -DefaultName : Massachusetts - -Cities : {} - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : NY - -DefaultName : New York - -Cities : {} - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : OR - -DefaultName : Oregon - -Cities : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryAreas -InventoryType Subscriber -RegionalGroup NOAM -CountryOrRegion US -``` - -This example returns the areas with Subscriber inventory in the specified region and country. - - -## PARAMETERS - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.InventoryArea -Instance or array of the objects. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md deleted file mode 100644 index 9a627c1ab4..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryCities -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberInventoryCities - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryCities` to retrieve the cities that support a given inventory type within a geographical area. - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryCities [-Tenant <Guid>] -RegionalGroup <String> - -CountryOrRegion <String> -Area <String> [-CapitalOrMajorCity <String>] -InventoryType <String> - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Following is an example of the `Get-CsOnlineTelephoneNumberInventoryCities` cmdlet's console output. - -Get-CsOnlineTelephoneNumberInventoryCities -InventoryType Service -RegionalGroup NOAM -CountryOrRegion US -Area NY - -RunspaceId : 1374aa93-75c4-4679-b765-6efc22f97563 - -Id : NY - -DefaultName : New York City - -GeoCode : NOAM-US-NY-NY - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryCities -InventoryType Service -RegionalGroup NOAM -CountryOrRegion US -Area NY -``` - -The following example retrieves the cities defined as supporting "Service" inventory types in New York state. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryCities -InventoryType Subscriber -RegionalGroup NOAM -CountryOrRegion US -Area NY -``` - -The following example retrieves the cities defined as supporting "Subscriber" inventory types in New York state. - - -## PARAMETERS - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -Specifies the target geographical city for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: City -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.InventoryCity -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md deleted file mode 100644 index 629a1f50e9..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryCountries -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberInventoryCountries - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryCountries` cmdlet to retrieve a list of countries with telephone number inventories by specified region and telephone number inventory types. - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryCountries [-Tenant <Guid>] -RegionalGroup <String> - [-CountryOrRegion <String>] -InventoryType <String> [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Following is an example of the `Get-CsOnlineTelephoneNumberInventoryCountries` cmdlet's console output. - -RunspaceId : af39ca40-06a7-473b-8963-668865d15e87 - -Id : US - -DefaultName : United States - -Areas : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryCountries -InventoryType Service -RegionalGroup NOAM -``` - -This example returns the countries in the north American region that contain service type telephone numbers. - -## PARAMETERS - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Country -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md deleted file mode 100644 index ef36c80bcd..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryRegions -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberInventoryRegions - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryRegions` cmdlet to retrieve the regions where specified inventory types are supported. - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryRegions [-Tenant <Guid>] [-RegionalGroup <String>] - -InventoryType <String> [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Following is an example of the `Get-CsOnlineTelephoneNumberInventoryRegions` cmdlet's console output. - -RunspaceId : f90303a9-c6a8-483c-b3b3-a5b8cdbab19c - -Id : NOAM - -DefaultName : North America - -Countries : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryRegions -InventoryType Service -``` - -This example returns the region where the inventory type of "Service" is supported. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryRegions -InventoryType Subscriber -``` - -This example returns the region where the inventory type of "Subscriber" is supported. - -## PARAMETERS - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Region -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md deleted file mode 100644 index 18615a5fe3..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryTypes -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberInventoryTypes - -## SYNOPSIS -Use the Get-CsOnlineTelephoneNumberInventoryTypes cmdlet to retrieve the telephone number inventory types that are defined. - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryTypes [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION -This is an example of Get-CsOnlineTelephoneNumberInventoryTypes cmdlet's console output. - -RunspaceId : af39ca40-06a7-473b-8963-668865d15e87 - -Id : Service - -Description : Inventory of service telephone numbers - -Regions : {} - -Reservations : {} - -RunspaceId : af39ca40-06a7-473b-8963-668865d15e87 - -Id : Subscriber - -Description : Inventory of subscriber telephone numbers - -Regions : {} - -Reservations : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryTypes -``` - -This example retrieves all the telephone number types for your organization. - - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Inventory -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md deleted file mode 100644 index 2bce713e68..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberReservationsInformation -schema: 2.0.0 ---- - -# Get-CsOnlineTelephoneNumberReservationsInformation - -## SYNOPSIS -Use the Get-CsOnlineTelephoneNumberReservationsInformation to retrieve information about the total number of telephone numbers which can reserved per session, and the maximum active reservations per session. - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberReservationsInformation [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is used to see the number of active reservations, reserved telephone numbers, maximum reservations supported per session, and maximum telephone numbers that can be reserved per session. - -The console output of this cmdlet will be in the following form: - -Get-CsOnlineTelephoneNumberReservationsInformation - -RunspaceId : 37c11bb0-3064-4e36-a0af-05efe9ee2bd3 - -ActiveReservationsCount : 0 - -ActiveReservedNumbersCount : 0 - -MaximumActiveReservationsCount : 10 - -MaximumActiveReservedNumbersCount : 200 - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberReservationsInformation -``` - -This example returns the number of active reservations, reserved telephone numbers, maximum reservations supported per session, and maximum telephone numbers that can be reserved per session. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### LacReservationInformation object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md deleted file mode 100644 index c77603dd89..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Get-CsOnlineUser - -## SYNOPSIS -Returns information about users who have accounts homed on Skype for Business Online. -This cmdlet can only be used with Skype for Business Online. - -## SYNTAX - -``` -Get-CsOnlineUser [-Filter <String>] [-LdapFilter <String>] [-OnOfficeCommunicationServer] [-OnModernServer] - [-UnassignedUser] [-SkipUserPolicies] [-OU <OUIdParameter>] [-DomainController <Fqdn>] - [-Credential <PSCredential>] [[-Identity] <UserIdParameter>] [-ResultSize <>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOnlineUser cmdlet returns information about users who have accounts homed on Skype for Business Online. -The returned information includes standard Active Directory account information (such as the department the user works in, his or her address and phone number, etc.) as well as Skype for Business Server 2015 specific information: the Get-CsOnlineUser cmdlet returns information about such things as whether or not the user has been enabled for Enterprise Voice and which per-user policies (if any) have been assigned to the user. - -Note that the Get-CsOnlineUser cmdlet does not have a TenantId parameter; that means you cannot use a command similar to this in order to limit the returned data to users who have accounts with a specific Skype for Business Online tenant: - -`Get-CsOnlineUser -TenantId "bf19b7db-6960-41e5-a139-2aa373474354"` - -However, if you have multiple you can return users from a specified tenant by using the Filter parameter and a command similar to this: - -`Get-CsOnlineUser -Filter {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"}` - -That command will limit the returned data to user accounts belong to the tenant with the TenantId "bf19b7db-6960-41e5-a139-2aa373474354". -If you do not know your tenant IDs you can return that information by using this command: - -`Get-CsTenant` - -If you have a hybrid or "split domain" deployment (that is, a deployment in which some users have accounts homed on Skype for Business Online while other users have accounts homed on an on-premises version of Skype for Business Server 2015) keep in mind that the Get-CsOnlineUser cmdlet only returns information for Skype for Business Online users. -However, the cmdlet will return information for both online users and on-premises users. -If you want to exclude Skype for Business Online users from the data returned by the Get-CsUser cmdlet, use the following command: - -`Get-CsUser -Filter {TenantId -eq "00000000-0000-0000-0000-000000000000"}` - -By definition, users homed on the on-premises version will always have a TenantId equal to 00000000-0000-0000-0000-000000000000. -Users homed on Skype for Business Online will a TenantId that is equal to some value other than 00000000-0000-0000-0000-000000000000. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineUser -``` - -The command shown in Example 1 returns information for all the users configured as online users. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" -``` - -In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". - -### -------------------------- Example 3 -------------------------- -``` -Get-CsOnlineUser -Filter {ArchivingPolicy -eq "RedmondArchiving"} -``` - -Example 3 uses the Filter parameter to limit the returned data to online users who have been assigned the per-user archiving policy RedmondArchiving. -To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". - -### -------------------------- Example 4 -------------------------- -``` -Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} -``` - -Example 4 returns information only for user accounts that have been configured so that the account does not appear in Microsoft Exchange address lists. -(That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. - -### -------------------------- Example 5 -------------------------- -``` -Get-CsOnlineUser -Filter {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"} -``` - -The command shown in Example 5 returns information for all the online users assigned to the tenant with the TenantID "bf19b7db-6960-41e5-a139-2aa373474354". -To accomplish the task, the command includes the Filter parameter along with the filter value {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"}. -This filter limits the returned data to online users assigned to the tenant "bf19b7db-6960-41e5-a139-2aa373474354". - - -## PARAMETERS - -### -Credential -This parameter is not used with Skype for Business Online. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is not used with Skype for Business Online. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to limit the returned data by filtering on Skype for Business specific attributes. -For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. - -The Filter parameter uses the same filtering syntax that is used by the Where-Object cmdlet. -For example, a filter that returns only users who have been enabled for Enterprise Voice would look like this, 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: - -`{EnterpriseVoiceEnabled -eq $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 -``` - -### -Identity -Indicates the Identity of the user account to be retrieved. -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). - -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: Skype for Business Online - -Required: False -Position: 1 -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). -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnModernServer -When present, the cmdlet returns a collection of users homed on Skype for Business. -Users with accounts on previous versions of the software will not be returned when you use this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: OnLyncServer -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnOfficeCommunicationServer -This parameter is not used with Skype for Business Online. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OU -This parameter is not used with Skype for Business Online. - -```yaml -Type: OUIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -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: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipUserPolicies -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnassignedUser -Enables you to return a collection of all the users who have been enabled for Skype for Business but are not currently assigned to a Registrar pool. -Users are not allowed to log on to unless they are assigned to a Registrar pool. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUser or String -A String must represent a valid user account Identity (for example, "sip:kenmyer@litwareinc.com"). - - -## OUTPUTS - -### Microsoft.Rtc.Management.ADConnect.Schema.ADOCOnlineUser - - -## NOTES - - -## RELATED LINKS - -[Set-CsUser](Set-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md b/skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md deleted file mode 100644 index 0e70cf6600..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# 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). - -## SYNTAX - -### Identity (Default) -``` -Get-CsOnlineVoiceRoute [-Tenant <Guid>] [[-Identity] <XdsGlobalRelativeIdentity>] [-LocalStore] - [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlineVoiceRoute [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to retrieve one or more existing online voice routes in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). - -This cmdlet can be used to retrieve voice route information such as which online PSTN gateways the route is associated with (if any), which online PSTN usages are associated with the route, the pattern (in the form of a regular expression) that identifies the phone numbers to which the route applies, and caller ID settings. The PSTN usage associates the voice route to a online voice policy. - -This cmdlet is used when configuring Microsoft Phone System Direct Routing. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Get-CsOnlineVoiceRoute -``` - -Retrieves the properties for all voice routes defined within the tenant. - -### -------------------------- Example 2 -------------------------- -``` -PS C:\> Get-CsOnlineVoiceRoute -Identity Route1 -``` - -Retrieves the properties for the Route1 voice route. - -### -------------------------- 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 -------------------------- -``` -PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0} -``` - -This command retrieves all voice routes that have not had any PSTN gateways assigned. First all voice routes are retrieved using the Get-CsOnlineVoiceRoute cmdlet. These voice routes are then piped to the Where-Object cmdlet. The Where-Object cmdlet narrows down the results of the Get operation. In this case we look at each voice route (that's what the $_ represents) and check the Count property of the PstnGatewayList property. If the count of PSTN gateways is 0, the list is empty and no gateways have been defined for the route. - -## PARAMETERS - -### -Filter -This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -A string that uniquely identifies the voice route. If no identity is provided, all voice routes for the organization are returned. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[New-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps) - -[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) - -[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md b/skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md deleted file mode 100644 index 3458d6015e..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# 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. - -## SYNTAX - -### Identity (Default) -``` -Get-CsOnlineVoiceRoutingPolicy [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsOnlineVoiceRoutingPolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Skype for Business Online users an online voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks. - -Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Skype for Business Online or Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -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 -------------------------- -``` -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 -------------------------- -``` -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 -------------------------- -``` -PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -notcontains "Long Distance"} -``` - -Example 5 is a variation on the command shown in Example 4; in this case, however, information is returned only for those online voice routing policies that do not include the PSTN usage "Long Distance". In order to do that, the Where-Object cmdlet uses the -notcontains operator, which limits returned data to policies that do not include the usage "Long Distance". - -## PARAMETERS - -### -Filter -Enables you to use wildcards when retrieving one or more online voice routing 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 online voice routing policy to be retrieved. To return the global policy, use this syntax: - --Identity global - -To return a policy configured at the per-user scope, use syntax like this: - --Identity "RedmondOnlineVoiceRoutingPolicy" - -You cannot use wildcard characters when specifying the Identity. - -If neither the Identity nor the Filter parameters are specified, then `Get-CsOnlineVoiceRoutingPolicy` returns all the voice routing policies configured for use in the tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) - -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) - -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) - -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md deleted file mode 100644 index c6bf41ded3..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineVoiceUser -schema: 2.0.0 ---- - -# Get-CsOnlineVoiceUser - -## SYNOPSIS -Use the Get-CsOnlineVoiceUser cmdlet to retrieve a voice user's telephone number and location. - -## SYNTAX - -``` -Get-CsOnlineVoiceUser [-CivicAddressId <XdsCivicAddressId>] [-DomainController <Fqdn>] [-EnterpriseVoiceStatus <MultiValuedProperty>] [-ExpandLocation] [-First <Unlimited>] [-Force] [-GetFromAAD] [-GetPendingUsers] [-Identity <UserIdParameter>] [-LocationId <LocationID>] [-NumberAssigned] [-NumberNotAssigned] [-PSTNConnectivity <MultiValuedProperty>] [-SearchQuery <String>] [-Skip <Unlimited>] [-Tenant <Guid>] [-AsJob] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com -``` - -This example uses the User Principal Name (UPN) to retrieve the location and phone number information. - - -## PARAMETERS - -### -CivicAddressId -Specifies the identity of the civic address that is assigned to the target users. - -```yaml -Type: XdsCivicAddressId -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -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 -``` - -### -EnterpriseVoiceStatus -Possible values are: -* All -* Enabled -* Disabled - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandLocation -Displays the location parameter with its value. - -```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 -``` - -### -First -Specifies the number of users to return. -The default is 100. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GetFromAAD -Use this switch to get the users from Azure Active Directory. - -```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 -``` - -### -GetPendingUsers -Use this switch to get only the users in pending state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -Specifies the location identity of the location whose users will be returned. -You can find location identifiers by using the Get-CsOnlineLisLocation cmdlet. - -```yaml -Type: LocationID -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberAssigned -If specified, the query will return users who have a phone number assigned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberNotAssigned -If specified, the query will return users who do not have a phone number assigned. - -```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 -``` - -### -PSTNConnectivity -Possible values are: -* All -* Online -* OnPremises - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchQuery -The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more details about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). - -If this parameter is empty, all users are returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -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. - -```yaml -Type: Unlimited -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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - - -## OUTPUTS - -### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacUser - - -## NOTES - - -## RELATED LINKS -[Set-CsOnlineVoiceUser](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceuser?view=skype-ps) - -[Set-CsOnlineVoiceUserBulk](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceuserbulk?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md b/skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md deleted file mode 100644 index 78db64cccf..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineVoicemailPolicy -schema: 2.0.0 ---- - -# Get-CsOnlineVoicemailPolicy - -## SYNOPSIS -Use the `Get-CsOnlineVoicemailPolicy` cmdlet to get a list of all pre-configured policy instances for Voicemail service. - -## SYNTAX - -``` -Get-CsOnlineVoicemailPolicy [-LocalStore] [[-Identity] <XdsIdentity>] [-Tenant <Guid>] [-Filter <String>] [-AsJob] -[<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet retrieves information about all the voicemail policies that have been configured for use in your organization. Voicemail policies are used by the organization to manage Voicemail-related features such as transcription. - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -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 -------------------------- -``` -Get-CsOnlineVoicemailPolicy -Filter "tag:*" -``` - -Example 3 uses the Filter parameter to return all the voicemail policies that have been configured at the per-user scope. The filter value "tag:*" tells the Get-CsOnlineVoicemailPolicy cmdlet to return only those policies that have an Identity that begins with the string value "tag:". - - -## PARAMETERS - -### -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. - -```yaml -Type: String -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 -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: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account whose voicemail policy is to be retrieved. 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: 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.WritableConfig.Policy.OnlineVoicemail.OnlineVoicemailPolicy - - -## NOTES - - -## RELATED LINKS -[Set-CsOnlineVoicemailPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) - -[Grant-CsOnlineVoicemailPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csonlinevoicemailpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoicemailUserSettings.md b/skype/skype-ps/skype/Get-CsOnlineVoicemailUserSettings.md deleted file mode 100644 index 8d6eae5be1..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineVoicemailUserSettings.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineVoicemailUserSettings -schema: 2.0.0 ---- - -# Get-CsOnlineVoicemailUserSettings - -## SYNOPSIS -Use the Get-CsOnlineVoicemailUserSettings cmdlet to get information about online voicemail user settings of a specific user. - -## SYNTAX - -``` -Get-CsOnlineVoicemailUserSettings -Identity <String> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOnlineVoicemailUserSettings cmdlet returns information about online voicemail user settings of a specific user in your organization. - -**NOTE** -- **This cmdlet is currently available to PREVIEW customers only.** - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com -``` - -This example gets the online voicemail user settings of user with SIP URI sip:user@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000" -``` - -This example gets the online voicemail user settings of user with Object ID "00000000-0000-0000-0000-000000000000". - - -## 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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings - - -## NOTES - - -## RELATED LINKS - -[Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md deleted file mode 100644 index ca7e46e419..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendant -schema: 2.0.0 ---- - -# Get-CsOrganizationalAutoAttendant - -## SYNOPSIS -Use the Get-CsOrganizationalAutoAttendant cmdlet to get information about Auto Attendants (AAs). - -## SYNTAX - -``` -Get-CsOrganizationalAutoAttendant [-PrimaryUri] <Uri> [-First <UInt64>] [-Skip <UInt64>] [-IncludeStatus] [-ApplicationId <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOrganizationalAutoAttendant cmdlet returns information about the OAAs in your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOrganizationalAutoAttendant -``` - -This example gets all OAAs in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOrganizationalAutoAttendant -PrimaryUri sip:mainoaa@contoso.com -``` - -This example gets the OAAs that has the Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Get-CsOrganizationalAutoAttendant -First 10 -``` - -This example gets the first ten auto attendants configured for use in the organization. - -### -------------------------- Example 4 -------------------------- -``` -Get-CsOrganizationalAutoAttendant -Skip 5 -First 10 -``` - -This example skips initial 5 auto attendants and gets the next 10 OAAs configured for use in the organization. - - -## PARAMETERS - -### -PrimaryUri -The PrimaryUri parameter represents the SIP address for the OAA to be retrieved. If this parameter is not specified, then all created OAAs in the organization are returned. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 1 -Default value: None -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. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -The Skip parameter indicates the number of initial auto attendants to skip in the result. It is intended to be used for pagination purposes. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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. - -```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 -``` - -### -ApplicationId -Specifies a custom application ID to use for auto attendants. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### String -The String is used as the PrimaryUri input. - - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.OrgAutoAttendant - - -## NOTES - - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendant](New-CsOrganizationalAutoAttendant.md) - -[Set-CsOrganizationalAutoAttendant](Set-CsOrganizationalAutoAttendant.md) - -[Remove-CsOrganizationalAutoAttendant](Remove-CsOrganizationalAutoAttendant.md) - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index e984a37a98..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantHolidays -schema: 2.0.0 ---- - -# Get-CsOrganizationalAutoAttendantHolidays - -## SYNOPSIS -Use Get-CsOrganizationalAutoAttendantHolidays cmdlet to get the holiday information for an existing Auto Attendant (AA). - -## SYNTAX - -``` -Get-CsOrganizationalAutoAttendantHolidays [-PrimaryUri] <Uri> [-Years <List>] [-Names <List>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOrganizationalAutoAttendantHolidays provides a convenient way to visualize the information of all the holidays contained within an auto attendant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" -``` - -In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to get all holidays in an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" -Years @(2017) -``` - -In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to get all holidays in year 2017 in an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 3 -------------------------- -``` -Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" –Years @(2017) -Name @("Christmas") -``` - -In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to get holiday named Christmas in the year 2017 in an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 4 -------------------------- -``` -Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" | Format-Table -Wrap -AutoSize -``` - -In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to retrieve all holidays in an auto attendant with Primary URI of sip:mainoaa@contoso.com and the result is formatted as a table. - - -## PARAMETERS - -### -PrimaryUri -The PrimaryUri parameter represents the SIP address of the auto attendant whose holidays are to be retrieved. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 OAA are returned. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Names -The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the OAA are returned. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### String -The String is used as the PrimaryUri input. - - -## OUTPUTS - -### Microsoft.Rtc.Management.OAA.Models.HolidayVisRecord - - -## NOTES - - -## RELATED LINKS - -[Import-CsOrganizationalAutoAttendantHolidays](Import-CsOrganizationalAutoAttendantHolidays.md) - -[Export-CsOrganizationalAutoAttendantHolidays](Export-CsOrganizationalAutoAttendantHolidays.md) - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantStatus.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantStatus.md deleted file mode 100644 index 827066a681..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantStatus.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantStatus -schema: 2.0.0 ---- - -# Get-CsOrganizationalAutoAttendantStatus - -## SYNOPSIS -Use Get-CsOrganizationalAutoAttendantStatus cmdlet to get the status of an Auto Attendant (AA) provisioning. - - -## SYNTAX - -``` -Get-CsOrganizationalAutoAttendantStatus [-PrimaryUri] <Uri> [-IncludeResources <List>] [-ApplicationId <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - - -## DESCRIPTION -This cmdlet provides a way to return the provisioning status of an auto attendant configured for use in your organization. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOrganizationalAutoAttendantStatus -PrimaryUri "sip:mainoaa@contoso.com" -``` - -In Example 1, the Get-CsOrganizationalAutoAttendantStatus cmdlet is used to get status records for all resources of an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOrganizationalAutoAttendantStatus -PrimaryUri sip:mainoaa@contoso.com -IncludeResources @("AudioFile") -``` - -In Example 2, the Get-CsOrganizationalAutoAttendantStatus cmdlet is used to get status records pertaining to audio files only of an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -## PARAMETERS - -### -PrimaryUri -The Primary URI represents the SIP address of the auto attendant whose provisioning status is to be retrieved. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeResources -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 OAA. -- DialByNameVoiceResponses: Indicates status for speech recognition when using dial-by-name (directory lookup) feature with OAA. -- SipProvisioning: Indicates status for calling OAA through its SIP (Primary) URI. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: (All) -Aliases: -Accepted values: AudioFile, DialByNameVoiceResponses, SipProvisioning -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies a custom application ID to use for auto attendants. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -The Get-CsOrganizationalAutoAttendantStatus cmdlet accepts a string as the PrimaryUri parameter. - -## OUTPUTS - -### Microsoft.Rtc.Management.OAA.Models.StatusRecord - -## NOTES - -## RELATED LINKS - -[Get-CsOrganizationalAutoAttendant](Get-CsOrganizationalAutoAttendant.md) - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md deleted file mode 100644 index cc1db62b3b..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantSupportedLanguage -schema: 2.0.0 ---- - -# Get-CsOrganizationalAutoAttendantSupportedLanguage - -## SYNOPSIS -The Get-CsOrganizationalAutoAttendantSupportedLanguage cmdlet gets languages that are supported by the Auto Attendant (AA) service. - -## SYNTAX - -``` -Get-CsOrganizationalAutoAttendantSupportedLanguage [-Identity] <System.String> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOrganizationalAutoAttendantSupportedLanguage cmdlet gets all languages (and their corresponding voices/speakers) that are supported by the OAA service. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOrganizationalAutoAttendantSupportedLanguage -``` - -This example gets all supported languages. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOrganizationalAutoAttendantSupportedLanguage -Identity "en-US" -``` - -This example gets the language that the Identity parameter specifies (en-US). - -## PARAMETERS - -### -Identity -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: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.OAA.Models.Language - - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md deleted file mode 100644 index 4ada32ef3f..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantSupportedTimeZone -schema: 2.0.0 ---- - -# Get-CsOrganizationalAutoAttendantSupportedTimeZone - -## SYNOPSIS -The Get-CsOrganizationalAutoAttendantSupportedTimeZone cmdlet gets supported time zones for the Auto Attendant (AA) service. - -## SYNTAX - -``` -Get-CsOrganizationalAutoAttendantSupportedTimeZone [-Identity] <String> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOrganizationalAutoAttendantSupportedTimeZone cmdlet gets all the time zones that the OAA service supports, or a specific time zone if its Identity is provided. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOrganizationalAutoAttendantSupportedTimeZone -``` - -This example gets all supported time zones. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOrganizationalAutoAttendantSupportedTimeZone -Identity "Pacific Standard Time" -``` - -This example gets the timezone that the Identity parameter specifies (Pacific Standard Time). - - -## PARAMETERS - -### -Identity -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: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.OAA.Models.TimeZone - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md deleted file mode 100644 index 42264af980..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantTenantInformation -schema: 2.0.0 ---- - -# Get-CsOrganizationalAutoAttendantTenantInformation - -## SYNOPSIS -Gets the default tenant information for Auto Attendant (AA) feature. - -## SYNTAX - -``` -Get-CsOrganizationalAutoAttendantTenantInformation [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsOrganizationalAutoAttendantTenantInformation cmdlet gets the default tenant information for Auto Attendant (AA) feature. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOrganizationalAutoAttendantTenantInformation -``` - -Gets the default auto attendant information for the logged in tenant. - - -## PARAMETERS - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.TenantInformation - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md index 970a39aad2..5583f31ca1 100644 --- a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsOutboundCallingNumberTranslationRule @@ -140,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -163,4 +168,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md b/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md index ad5c6a350b..8b9c66c91c 100644 --- a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsOutboundTranslationRule @@ -115,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +143,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsPartnerApplication.md b/skype/skype-ps/skype/Get-CsPartnerApplication.md index 7e11de2de0..d88eef5d7f 100644 --- a/skype/skype-ps/skype/Get-CsPartnerApplication.md +++ b/skype/skype-ps/skype/Get-CsPartnerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPartnerApplication @@ -158,7 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -181,4 +186,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) [Set-CsPartnerApplication](Set-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md b/skype/skype-ps/skype/Get-CsPersistentChatAddin.md index 1e292cb8dd..72d85cb632 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatAddin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatAddin @@ -78,7 +83,7 @@ If this parameter is not specified then the Get-CsPersistentChatAddin cmdlet ret Type: String 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 Required: True Position: 1 @@ -99,7 +104,7 @@ For example: Type: String Parameter Sets: Pool Aliases: -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 @@ -109,7 +114,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md b/skype/skype-ps/skype/Get-CsPersistentChatCategory.md index ffb7c4ac3b..e00444b74c 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatCategory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatCategory @@ -89,7 +94,7 @@ The Identity consists of the Persistent Chat pool were the category is located f Type: String 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 Required: True Position: 1 @@ -106,7 +111,7 @@ When not specified, SIP addresses are used when showing these users. 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 Required: False Position: Named @@ -124,7 +129,7 @@ If you leave off both the Name and PoolFqdn parameters, then information will be Type: String Parameter Sets: Pool Aliases: -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 @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md index 6a89af604d..cf19471a4f 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatComplianceConfiguration @@ -95,7 +100,7 @@ The Filter and Identity parameters cannot be used in the same command. Type: String Parameter Sets: Filter Aliases: -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 @@ -126,7 +131,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com Type: XdsIdentity 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 Required: False Position: 2 @@ -142,7 +147,7 @@ Retrieves the Persistent Chat compliance data from the local replica of the Cent 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 Required: False Position: Named @@ -152,7 +157,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -175,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md index 8ac191b6b3..7fd56a3f4c 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatConfiguration @@ -94,7 +99,7 @@ The Filter and Identity parameters cannot be used in the same command. Type: String Parameter Sets: Filter Aliases: -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 @@ -125,7 +130,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com Type: XdsIdentity 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 Required: False Position: 2 @@ -141,7 +146,7 @@ Retrieves the Persistent Chat configuration data from the local replica of the C 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 Required: False Position: Named @@ -151,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -174,4 +179,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md b/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md index 22b3521d3b..f4405e37b0 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatEligiblePrincipal @@ -79,7 +84,7 @@ You must use either the Category or the Room parameter when calling the Get-CsPe Type: String Parameter Sets: Category Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -96,7 +101,7 @@ You must use either the Category or the Room parameter when calling the Get-CsPe Type: String Parameter Sets: Room Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -117,7 +122,7 @@ Note that the Filter parameter can only filter on user SIP addresses. 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 Required: False Position: Named @@ -136,7 +141,7 @@ For example: 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 Required: False Position: Named @@ -155,7 +160,7 @@ This parameter can only be used along with the Room parameter, and can only retu Type: SwitchParameter Parameter Sets: Room Aliases: -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 @@ -177,7 +182,7 @@ If you set the ResultSize to 7 but you have only three principals in your forest Type: Int32 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 Required: False Position: Named @@ -187,7 +192,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -208,4 +213,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md index 36c664b577..04e98b3f03 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatEndpoint @@ -75,7 +80,7 @@ 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 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -95,7 +100,7 @@ For example: 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 Required: False Position: Named @@ -117,7 +122,7 @@ For example, a filter that returns only endpoints that have been assigned a per- 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 Required: False Position: Named @@ -140,7 +145,7 @@ However, you can also use the full Identity of the endpoint; for example: Type: UserIdParameter 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 Required: False Position: 1 @@ -157,7 +162,7 @@ Because Persistent Chat endpoints have very few non-Skype for Business Server at 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 Required: False Position: Named @@ -174,7 +179,7 @@ Because new Persistent Chat endpoints are all created in the same Active Directo Type: OUIdParameter 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 Required: False Position: Named @@ -190,7 +195,7 @@ Fully qualified domain name of the Persistent Chat pool associated with the Pers 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 Required: False Position: Named @@ -212,7 +217,7 @@ If you set the ResultSize to 7 but you have only three contacts in your forest, 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 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -222,7 +227,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -243,4 +248,3 @@ String value representing the Identity or the SIP address of a Persistent Chat e [New-CsPersistentChatEndpoint](New-CsPersistentChatEndpoint.md) [Remove-CsPersistentChatEndpoint](Remove-CsPersistentChatEndpoint.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md index 8c82ff508f..7c0e9ecc89 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatPolicy @@ -86,7 +91,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same Type: String Parameter Sets: Filter Aliases: -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 @@ -119,7 +124,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsPersiste Type: XdsIdentity 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 Required: False Position: 2 @@ -135,7 +140,7 @@ Retrieves the Persistent Chat policy data from the local replica of the Central 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 Required: False Position: Named @@ -158,7 +163,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Skype for Business Server 2015 Required: False Position: Named @@ -168,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -193,4 +198,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md b/skype/skype-ps/skype/Get-CsPersistentChatRoom.md index f2a46665e9..b2f79623d0 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatRoom.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatRoom @@ -74,7 +79,7 @@ Note that you can only specify one add-in per command. 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 Required: False Position: Named @@ -91,7 +96,7 @@ When not specified, SIP addresses are used when showing these users. 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 Required: False Position: Named @@ -113,7 +118,7 @@ In addition, you cannot use the PersistentChatPoolFqdn, Filter, or Identity para 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 Required: False Position: Named @@ -129,7 +134,7 @@ Returns chat rooms whose cumulative chat content exceeds the specified value (in Type: Int32 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 Required: False Position: Named @@ -145,7 +150,7 @@ Enables you to search for active chat rooms (by using the parameter value $False 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 Required: False Position: Named @@ -166,7 +171,7 @@ That syntax returns information only for chat rooms that have the name ITChat. 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 Required: False Position: Named @@ -188,7 +193,7 @@ If you call the Get-CsPersistentChatRoom cmdlet without any parameters the cmdle Type: String 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 Required: False Position: 1 @@ -204,7 +209,7 @@ Returns chat rooms that use invitations (by using the parameter value Inherit) o Type: ChatRoomInvitations 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 Required: False Position: Named @@ -225,7 +230,7 @@ Note that you can only specify a single manager per command. 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 Required: False Position: Named @@ -246,7 +251,7 @@ Note that you can only specify a single member per command. 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 Required: False Position: Named @@ -267,7 +272,7 @@ You cannot use the Category, Filter, or Identity parameters in any command that 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 Required: False Position: Named @@ -288,7 +293,7 @@ Allowed values are: Type: ChatRoomPrivacy 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 Required: False Position: Named @@ -310,7 +315,7 @@ If you set the ResultSize to 7 but you have only three rooms in your forest, the Type: Int32 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 Required: False Position: Named @@ -330,7 +335,7 @@ For example: 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 Required: False Position: Named @@ -350,7 +355,7 @@ Allowed values are: Type: ChatRoomType 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 Required: False Position: Named @@ -360,7 +365,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -385,4 +390,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatState.md b/skype/skype-ps/skype/Get-CsPersistentChatState.md index ce0cdc5c30..232ca51c32 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatState.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPersistentChatState @@ -82,7 +87,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same Type: String Parameter Sets: Filter Aliases: -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 @@ -103,7 +108,7 @@ If this parameter is omitted then the Get-CsPersistentChatState cmdlet returns i Type: XdsIdentity 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 Required: False Position: 2 @@ -119,7 +124,7 @@ Retrieves the Persistent Chat state data from the local replica of the Central M 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 Required: False Position: Named @@ -129,7 +134,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsPersistentChatState](Set-CsPersistentChatState.md) - diff --git a/skype/skype-ps/skype/Get-CsPinPolicy.md b/skype/skype-ps/skype/Get-CsPinPolicy.md index 21a058a137..a72edbf43e 100644 --- a/skype/skype-ps/skype/Get-CsPinPolicy.md +++ b/skype/skype-ps/skype/Get-CsPinPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPinPolicy @@ -172,7 +177,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -197,4 +202,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPinPolicy](Remove-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md index 6b3f9a694a..556e9c6bbe 100644 --- a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md @@ -1,14 +1,19 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings +applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPlatformServiceSettings schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsPlatformServiceSettings ## SYNOPSIS -Returns information about Skype for Business on Mac capabilites which have been enabled in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). +Returns information about Skype for Business on Mac capabilities which have been enabled in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). ## SYNTAX @@ -91,7 +96,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -105,8 +110,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsPool.md b/skype/skype-ps/skype/Get-CsPool.md index 32af1e1a61..8c56497961 100644 --- a/skype/skype-ps/skype/Get-CsPool.md +++ b/skype/skype-ps/skype/Get-CsPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPool @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsSite](Get-CsSite.md) [Get-CsTopology](Get-CsTopology.md) - diff --git a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md b/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md index 585ca22ade..d29e9701e9 100644 --- a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md +++ b/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPoolBackupRelationship @@ -90,7 +95,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -106,4 +111,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsPoolFabricState.md b/skype/skype-ps/skype/Get-CsPoolFabricState.md index 56edfd24a1..2e915d6108 100644 --- a/skype/skype-ps/skype/Get-CsPoolFabricState.md +++ b/skype/skype-ps/skype/Get-CsPoolFabricState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPoolFabricState @@ -301,7 +306,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -319,5 +324,3 @@ String value representing the fabric state. ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md b/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md index 533bfd79f7..db2ff87bbf 100644 --- a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md +++ b/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPoolUpgradeReadinessState @@ -28,6 +33,7 @@ There are no options enabling you to run the Get-CsPoolUpgradeReadinessState cmd The functions carried out by the Get-CsPoolUpgradeReadinessState cmdlet are not available in the Skype for Business Server Control Panel. +In Skype for Business Server 2019, Get-CsPoolUpgradeReadinessState cmdlet was replaced by [Get-CsUpgradeDomainInfo](Get-CsUpgradeDomainInfo.md) cmdlet. ## EXAMPLES @@ -50,7 +56,7 @@ Prompts you for confirmation before executing the command. 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 @@ -66,7 +72,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -82,7 +88,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -99,7 +105,7 @@ By default, Get-CsPoolUpgradeReadinessState waits until the replicas have been b Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Skype for Business Server 2015 Required: False Position: Named @@ -109,7 +115,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -126,4 +132,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsPresenceManagementState.md b/skype/skype-ps/skype/Get-CsPresenceManagementState.md index 3f0aa51a8e..73930cdaf6 100644 --- a/skype/skype-ps/skype/Get-CsPresenceManagementState.md +++ b/skype/skype-ps/skype/Get-CsPresenceManagementState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPresenceManagementState @@ -71,7 +76,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -90,4 +95,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsPresenceManagementState](Set-CsPresenceManagementState.md) - diff --git a/skype/skype-ps/skype/Get-CsPresencePolicy.md b/skype/skype-ps/skype/Get-CsPresencePolicy.md index af8c0f99fd..f4d0e7294a 100644 --- a/skype/skype-ps/skype/Get-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Get-CsPresencePolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencepolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPresencePolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsPresencePolicy @@ -150,26 +155,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Tenant Globally unique identifier (GUID) of the Skype for Business Online tenant account whose presence policies are being returned. For example: @@ -194,7 +179,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -219,4 +204,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsPresenceProvider.md b/skype/skype-ps/skype/Get-CsPresenceProvider.md index b423cb7a1f..8051cd503e 100644 --- a/skype/skype-ps/skype/Get-CsPresenceProvider.md +++ b/skype/skype-ps/skype/Get-CsPresenceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPresenceProvider @@ -136,7 +141,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -161,4 +166,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) [Set-CsPresenceProvider](Set-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md index 31ef7a05d6..f008d70f24 100644 --- a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csprivacyconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPrivacyConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsPrivacyConfiguration @@ -175,28 +180,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -219,4 +204,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsProxyConfiguration.md b/skype/skype-ps/skype/Get-CsProxyConfiguration.md index 501d1d6ee8..8ab2e40fe6 100644 --- a/skype/skype-ps/skype/Get-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/Get-CsProxyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsProxyConfiguration @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsPstnUsage.md b/skype/skype-ps/skype/Get-CsPstnUsage.md index 90408f1e89..3905df1116 100644 --- a/skype/skype-ps/skype/Get-CsPstnUsage.md +++ b/skype/skype-ps/skype/Get-CsPstnUsage.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPstnUsage @@ -135,7 +140,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -158,4 +163,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsVoicePolicy](Get-CsVoicePolicy.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsPublicProvider.md b/skype/skype-ps/skype/Get-CsPublicProvider.md index b66ddb5a83..e896dc4205 100644 --- a/skype/skype-ps/skype/Get-CsPublicProvider.md +++ b/skype/skype-ps/skype/Get-CsPublicProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsPublicProvider @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -173,4 +178,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md index ecbff5a223..c691ad8fc7 100644 --- a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPushNotificationConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsPushNotificationConfiguration @@ -188,28 +193,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -226,8 +211,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) -[Remove-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsQoEConfiguration.md b/skype/skype-ps/skype/Get-CsQoEConfiguration.md index c4a42f25bd..df091a86aa 100644 --- a/skype/skype-ps/skype/Get-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/Get-CsQoEConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsQoEConfiguration @@ -126,7 +131,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsQoEConfiguration](Remove-CsQoEConfiguration.md) [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md b/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md index 1e990ee567..e5b7e3c765 100644 --- a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRegistrarConfiguration @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -172,4 +177,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsReportingConfiguration.md b/skype/skype-ps/skype/Get-CsReportingConfiguration.md index 6ee13a6a31..6a67e67c54 100644 --- a/skype/skype-ps/skype/Get-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsReportingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsReportingConfiguration @@ -126,7 +131,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +154,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md b/skype/skype-ps/skype/Get-CsRgsAgentGroup.md index ccc9b9a46c..c55cfb40ac 100644 --- a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/Get-CsRgsAgentGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRgsAgentGroup @@ -153,7 +158,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -176,4 +181,3 @@ A string value representing the Identity of the Response Group agent group. [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsConfiguration.md b/skype/skype-ps/skype/Get-CsRgsConfiguration.md index ed4710cd3c..efecbe98eb 100644 --- a/skype/skype-ps/skype/Get-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Get-CsRgsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRgsConfiguration @@ -88,7 +93,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -109,4 +114,3 @@ A string value representing the Identity of the Response Group configuration set [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) [Set-CsRgsConfiguration](Set-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md b/skype/skype-ps/skype/Get-CsRgsHolidaySet.md index e5ee69bf16..2b7b8d3bf5 100644 --- a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/Get-CsRgsHolidaySet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRgsHolidaySet @@ -169,7 +174,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -192,4 +197,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md index e075e35a67..8f06475469 100644 --- a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRgsHoursOfBusiness @@ -167,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -190,4 +195,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsQueue.md b/skype/skype-ps/skype/Get-CsRgsQueue.md index 81b87d17a1..80bee92147 100644 --- a/skype/skype-ps/skype/Get-CsRgsQueue.md +++ b/skype/skype-ps/skype/Get-CsRgsQueue.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRgsQueue @@ -153,7 +158,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -177,4 +182,3 @@ A string value representing the Identity of the Response Group queue. [Remove-CsRgsQueue](Remove-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsWorkflow.md b/skype/skype-ps/skype/Get-CsRgsWorkflow.md index 43dfbfabcc..2e3ca094e9 100644 --- a/skype/skype-ps/skype/Get-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/Get-CsRgsWorkflow.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRgsWorkflow @@ -165,7 +170,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -188,4 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md b/skype/skype-ps/skype/Get-CsRoutingConfiguration.md index 0885499310..a17cb208b0 100644 --- a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsRoutingConfiguration @@ -93,7 +98,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -118,4 +123,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsRoutingConfiguration](Set-CsRoutingConfiguration.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsServerApplication.md b/skype/skype-ps/skype/Get-CsServerApplication.md index 0457a7c8e7..79fa934203 100644 --- a/skype/skype-ps/skype/Get-CsServerApplication.md +++ b/skype/skype-ps/skype/Get-CsServerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsServerApplication @@ -165,7 +170,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -188,4 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsServerApplication](Remove-CsServerApplication.md) [Set-CsServerApplication](Set-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsServerPatchVersion.md b/skype/skype-ps/skype/Get-CsServerPatchVersion.md index 99f016b6a4..707697cc6e 100644 --- a/skype/skype-ps/skype/Get-CsServerPatchVersion.md +++ b/skype/skype-ps/skype/Get-CsServerPatchVersion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsServerPatchVersion @@ -49,7 +54,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -62,4 +67,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsServerVersion.md b/skype/skype-ps/skype/Get-CsServerVersion.md index 23bd25975b..8335546002 100644 --- a/skype/skype-ps/skype/Get-CsServerVersion.md +++ b/skype/skype-ps/skype/Get-CsServerVersion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsServerVersion @@ -53,7 +58,7 @@ This is the only way that the Get-CsServerVersion cmdlet can be used. ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -69,4 +74,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsService.md b/skype/skype-ps/skype/Get-CsService.md index daccff7d67..c0a5253689 100644 --- a/skype/skype-ps/skype/Get-CsService.md +++ b/skype/skype-ps/skype/Get-CsService.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsService @@ -813,7 +818,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -858,4 +863,3 @@ For example: [Set-CsUserServer](Set-CsUserServer.md) [Set-CsWebServer](Set-CsWebServer.md) - diff --git a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md index b9e8528b5e..aa3aa23c6e 100644 --- a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsSimpleUrlConfiguration @@ -28,12 +33,12 @@ Get-CsSimpleUrlConfiguration [-Filter <String>] [-Tenant <Guid>] [-LocalStore] [ ## DESCRIPTION In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 helped overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -193,7 +198,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -216,4 +221,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsSipDomain.md b/skype/skype-ps/skype/Get-CsSipDomain.md index f8db1de835..0b57d1b663 100644 --- a/skype/skype-ps/skype/Get-CsSipDomain.md +++ b/skype/skype-ps/skype/Get-CsSipDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsSipDomain @@ -108,7 +113,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,4 +136,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsSipDomain](Remove-CsSipDomain.md) [Set-CsSipDomain](Set-CsSipDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md index 4e5007c67e..ffac7c3b58 100644 --- a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsSipResponseCodeTranslationRule @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsSite.md b/skype/skype-ps/skype/Get-CsSite.md index e13d4d6382..fca553017d 100644 --- a/skype/skype-ps/skype/Get-CsSite.md +++ b/skype/skype-ps/skype/Get-CsSite.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsSite @@ -117,7 +122,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -136,4 +141,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsSite](Set-CsSite.md) - diff --git a/skype/skype-ps/skype/Get-CsSlaConfiguration.md b/skype/skype-ps/skype/Get-CsSlaConfiguration.md index 10b6599869..6e91991f77 100644 --- a/skype/skype-ps/skype/Get-CsSlaConfiguration.md +++ b/skype/skype-ps/skype/Get-CsSlaConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSlaConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Get-CsSlaConfiguration @@ -34,14 +39,14 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Get-CsSlaConfiguration"} Get-CsSlaConfiguration -Identity sip:emergency@contosohealth.com ``` -This example command returns information about the shared number with the Identity of “emergency@contosohealth.com”. +This example command returns information about the shared number with the Identity of "emergency@contosohealth.com". ### -------------------------- Example 2 -------------------------- ``` Get-CsSlaConfiguration emergency@contosohealth.com ``` -This example command returns information about the shared number with the Identity of “emergency@contosohealth.com”. This example specifies Identity by its position. +This example command returns information about the shared number with the Identity of "emergency@contosohealth.com". This example specifies Identity by its position. ### -------------------------- Example 3 -------------------------- ``` @@ -111,7 +116,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -128,4 +133,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md index 798e630cb1..58237d6f2b 100644 --- a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsStaticRoutingConfiguration @@ -152,7 +157,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -175,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md index 6f2ea23ce8..c6356193a8 100644 --- a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsStorageServiceConfiguration @@ -138,7 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsCallingPolicy.md deleted file mode 100644 index e74925a412..0000000000 --- a/skype/skype-ps/skype/Get-CsTeamsCallingPolicy.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online -title: Get-CsTeamsCallingPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsCallingPolicy - -## SYNOPSIS - -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. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsCallingPolicy [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsTeamsCallingPolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION - -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 and interoperability with Skype for Business. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsCallingPolicy -Identity SalesCallingPolicy -``` - -Retrieves the calling policy with name "SalesCallingPolicy" - -## 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: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the TeamsCallingPolicy that you would like to retrieve. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Microsoft internal use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Microsoft internal use. - -```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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Get-CsTeamsGuestMessagingConfiguration.md deleted file mode 100644 index ad18bfc69c..0000000000 --- a/skype/skype-ps/skype/Get-CsTeamsGuestMessagingConfiguration.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsTeamsGuestMessagingConfiguration -schema: 2.0.0 ---- - -# Get-CsTeamsGuestMessagingConfiguration - -## SYNOPSIS -TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet returns your organization's current settings. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] - [<CommonParameters>] -``` - -### Filter -``` -Get-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] - [<CommonParameters>] -``` - -## DESCRIPTION -TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. - -## EXAMPLES - -### Example 1 -``` -Get-CsTeamsGuestMessagingConfiguration -``` - -The command shown in Example 1 returns teams guest messaging configuration information for the current tenant - -## PARAMETERS - -### -Filter -Enables you to use wildcard characters in order to return a collection of tenant guest messaging configuration settings. -Because each tenant is limited to a single, global collection of guest messaging configuration settings there is no need to use the Filter parameter. - -```yaml -Type: String -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 guest messaging configuration settings to be returned. -Because each tenant is limited to a single, global collection of guest 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: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is not used with Skype for Business Online. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTeamsInteropPolicy.md b/skype/skype-ps/skype/Get-CsTeamsInteropPolicy.md deleted file mode 100644 index 8cb6f31a95..0000000000 --- a/skype/skype-ps/skype/Get-CsTeamsInteropPolicy.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsStorageServiceConfiguration -schema: 2.0.0 ---- - -# Get-CsTeamsInteropPolicy - -## SYNOPSIS - -IMPORTANT: TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. Please read description for more details. You can also find more guidance here: [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/microsoftteams/migration-interop-guidance-for-teams-with-skype). - -If TeamsUpgradePolicy has mode=Legacy, TeamsInteropPolicy determines how calls are routed between Skype for Business and Microsoft Teams. Otherwise it is ignored. - - -## SYNTAX - -``` -Get-CsTeamsInteropPolicy [-LocalStore] [[-Identity] <Object>] [-Tenant <Object>] [-Filter <Object>] [-AsJob] -``` - -## DESCRIPTION - -IMPORTANT: TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. TeamsInteropPolicy is only honored if TeamsUpgradePolicy mode=Legacy. However, Legacy mode has been deprecated and TeamsInteropPolicy will be removed in the near future. Any customer still using TeamsUpgradePolicy with mode=Legacy must update their configuration of TeamsUpgradePolicy to use a different mode. - -For any user that is still assigned TeamsInteropPolicy and in Legacy mode, these users must be assigned only one of these three built-in instances for which CallingDefaultClient = ChatDefaultClient, and for which AllowEndUserClientOverride = false. The other instances are not longer valid configurations, are not supported and will be removed. - -The valid instances are: - - -**Identity: DisallowOverrideCallingDefaultChatDefault** -**AllowEndUserClientOverride: False** -**CallingDefaultClient: Default** -**ChatDefaultClient: Default** - -**Identity: DisallowOverrideCallingSfbChatSfb** -**AllowEndUserClientOverride: False** -**CallingDefaultClient: Sfb** -**ChatDefaultClient: Sfb** - -**Identity: DisallowOverrideCallingTeamsChatTeams** -**AllowEndUserClientOverride: False** -**CallingDefaultClient: Teams** -**ChatDefaultClient: Teams** - - -Use the following cmdlet syntax, where $policy is one of the above values of identity: -`Grant-CsTeamsInteropPolicy -PolicyName $policy -Identity $SipAddress` - - -If you customized the built-in global policy, undo this by running `Remove-CsTeamsInteropPolicy`. This will remove the tenant-specific global policy and revert back to the system-wide built-in policy (which cannot be removed). Use the following syntax: -Remove-CsTeamsInteropPolicy -Identity Global - -For comprehensive documentation on this policy and its settings, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/microsoftteams/migration-interop-guidance-for-teams-with-skype). - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Filter -{{Fill Filter Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -{{Fill Identity Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -{{Fill LocalStore Description}} - -```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 -{{Fill Tenant Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. It is not honored except if TeamsUpgradePolicy mode=Legacy. Legacy mode is being deprecated so customers should update their configuration of TeamsUpgradePolicy to use modes other than Legacy. - - -## RELATED LINKS - -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/microsoftteams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md deleted file mode 100644 index 04e0e3588f..0000000000 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Set-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 ---- - - -# Get-CsTeamsMeetingBroadcastPolicy - -## SYNOPSIS -Get-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \<XdsIdentity\>\] \[-Tenant \<guid\>\] \[-LocalStore\] \[\<CommonParameters\>\] - -Get-CsTeamsMeetingBroadcastPolicy \[-Tenant \<guid\>\] \[-Filter \<string\>\] \[-LocalStore\] \[\<CommonParameters\>\] - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] - [<CommonParameters>] -``` - -### Filter -``` -Get-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer.  Use this cmdlet to retrieve one or more policies. - -## EXAMPLES - - -## PARAMETERS - -### -Filter -Enables you to use wildcard characters when specifying the policy (or policies) to be returned. For example, this syntax returns all the policies configured at the per-user scope - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the policy to be retrieved. 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 SalesPolicy. - -If this parameter is not included, the cmdlet will return a collection of all the 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 policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Not applicable to the online service. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Not applicable to online service. - -```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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md index aab79d7ec6..4c98490cbe 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTeamsUpgradeConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsTeamsUpgradeConfiguration @@ -100,7 +105,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -119,4 +124,4 @@ These settings are only honored by newer versions of Skype for Business clients. [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md index 2da0219c52..69d65757c9 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md @@ -1,14 +1,22 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online, Skype for Business Server 2019 +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 +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsTeamsUpgradePolicy ## SYNOPSIS -TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. IMPORTANT: TeamsUpgradePolicy has replaced TeamsInteropPolicy. However, aspects of TeamsUpgradePolicy are still in preview mode as described below. +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +> [!IMPORTANT] +> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). ## SYNTAX @@ -24,16 +32,14 @@ Get-CsTeamsUpgradePolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<Com ``` ## DESCRIPTION -TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. This cmdlet returns the set of instances of this policy. As an organization with Skype for Business starts to adopt Teams, administrators can manage client behavior for their end user using the concept of "mode", which defines where routing behavior (e.g in which client do chats and calls land). In the future, mode will also be used to define client behavior in Teams client in terms of what functionality will be available. TeamsUpgradePolicy can be granted either on a per user basis or on a tenant-wide basis. In addition, 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. This cmdlet returns the set of instances of this policy. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs whether chat, calling, and meeting scheduling functionality are available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. NOTES: - Except for on-premise versions of Skype for Business Server, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet. - - If you are using Skype for Business Server, there are no built-in instances and you'll need to create one. Also, only the NotifySfBUsers property is available. Mode is not present - - Instances with mode set to SfBWithTeamsCollab are not yet functional. From a routing perspective, this will behave like SfBOnly mode. - - Action property is redundnant with the combination of NotifySfBUsers and Mode. It will eventually be removed. - -IMPORTANT: TeamsUpgradePolicy has replaced TeamsInteropPolicy. Components that previously honored TeamsInteropPolicy have been updated to honor TeamsUpgradePolicy instead. + - If you are using Skype for Business Server, there are no built-in instances and you'll need to create one. Also, only the NotifySfBUsers property is available. Mode is not present. + - Using TeamsUpgradePolicy in an on-premises environmention requires Skype for Business Server 2015 with CU8 or later. +You can also find more guidance here: [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). ## EXAMPLES @@ -45,25 +51,11 @@ Identity : Global Description : Users can use either Skype for Business client or Teams client Mode : Islands NotifySfbUsers : False -Action : None - -Identity : Tag:NoUpgrade -Description : Users can use either Skype for Business client or Teams client -Mode : Legacy -NotifySfbUsers : False -Action : None - -Identity : Tag:NotifyForTeams -Description : Show notification of pending upgrade in Skype for Business client -Mode : Legacy -NotifySfbUsers : True -Action : Notify Identity : Tag:UpgradeToTeams Description : Use Teams Only Mode : TeamsOnly NotifySfbUsers : False -Action : Upgrade Identity : Tag:Islands Description : Use either Skype for Business client or Teams client @@ -75,32 +67,36 @@ Identity : Tag:IslandsWithNotify Description : Use either Skype for Business client or Teams client Mode : Islands NotifySfbUsers : True -Action : Notify Identity : Tag:SfBOnly Description : Use only Skype for Business Mode : SfBOnly NotifySfbUsers : False -Action : None Identity : Tag:SfBOnlyWithNotify Description : Use only Skype for Business Mode : SfBOnly NotifySfbUsers : True -Action : Notify Identity : Tag:SfBWithTeamsCollab Description : Use Skype for Business and use Teams only for group collaboration Mode : SfBWithTeamsCollab NotifySfbUsers : False -Action : None Identity : Tag:SfBWithTeamsCollabWithNotify Description : Use Skype for Business and use Teams only for group collaboration Mode : SfBWithTeamsCollab NotifySfbUsers : True -Action : Notify +Identity : Tag:SfBWithTeamsCollabAndMeetings +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollabAndMeetings +NotifySfbUsers : False + +Identity : Tag:SfBWithTeamsCollabAndMeetingsWithNotify +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollabAndMeetings +NotifySfbUsers : True ``` List all instances of TeamsUpgradePolicy @@ -114,7 +110,6 @@ Identity : Global Description : Users can use either Skype for Business client or Teams client Mode : Islands NotifySfbUsers : False -Action : None ``` @@ -141,7 +136,7 @@ If identity parameter is passed, this will return a specific instance. If no ide Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: 1 @@ -156,7 +151,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: Named @@ -165,21 +160,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Do Not Use - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ### -Tenant {{Fill Tenant Description}} @@ -188,7 +168,7 @@ Accept wildcard characters: False Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: Named @@ -199,7 +179,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -217,5 +197,4 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) - +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md b/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md index c8c35ba430..53ce0dee66 100644 --- a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTelemetryConfiguration @@ -24,7 +29,7 @@ Get-CsTelemetryConfiguration [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonP ``` ## DESCRIPTION -For privacy information, see the Skype for Business Privacy Statement (http://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). +For privacy information, see the Skype for Business Privacy Statement (https://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). ## EXAMPLES @@ -101,7 +106,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -117,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTenant.md b/skype/skype-ps/skype/Get-CsTenant.md deleted file mode 100644 index 3eb6342fc3..0000000000 --- a/skype/skype-ps/skype/Get-CsTenant.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsTenant -schema: 2.0.0 ---- - -# Get-CsTenant - -## SYNOPSIS -Returns information about the Skype for Business Online tenants that have been configured for use in your organization. -Tenants represent groups of online users. - -## SYNTAX - -``` -Get-CsTenant [-Filter <String>] [-DomainController <Fqdn>] [[-Identity] <OUIdParameter>] [-ResultSize <Int32>] - [<CommonParameters>] -``` - -## DESCRIPTION -In Skype for Business Online, tenants are groups of users who have accounts homed on the service. -Organizations will typically have a single tenant in which to house all their user accounts. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsTenant -``` - -The command shown in Example 1 returns information about your tenant. -Organizations will have only one tenant. - - -## PARAMETERS - -### -DomainController -This parameter is not used with Skype for Business Online. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to return data by using Active Directory attributes and without having to specify the full Active Directory distinguished name. -For example, to retrieve a tenant by using the tenant display name, use syntax similar to this: - -Get-CsTenant -Filter {DisplayName -eq "FabrikamTenant"} - -To return all tenants that use a Fabrikam domain use this syntax: - -Get-CsTenant -Filter {Domains -like "*fabrikam*"} - -The Filter parameter uses the same Windows PowerShell filtering syntax is used by the `Where-Object` cmdlet. - -You cannot use both the Identity parameter and the Filter parameter in the same command. - -```yaml -Type: String -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 -Unique identifier for the tenant. -For example: - --Identity "bf19b7db-6960-41e5-a139-2aa373474354" - -If you do not include either the Identity or the Filter parameter then the `Get-CsTenant` cmdlet will return information about all your tenants. - -```yaml -Type: OUIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -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 tenants (regardless of the number of tenants 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. - -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 tenants to 7 but you have only three contacts in your forest, the command will return those three tenants and then complete without error. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### Microsoft.Rtc.Management.ADConnect.Schema.TenantObject or String -The `Get-CsTenant` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.TenantObject object as well as string values representing the Identity of the tenant (for example "bf19b7db-6960-41e5-a139-2aa373474354"). - -## OUTPUTS - -### Microsoft.Rtc.Management.ADConnect.Schema.TenantObject - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTenantDialPlan.md b/skype/skype-ps/skype/Get-CsTenantDialPlan.md deleted file mode 100644 index 91901d8f4d..0000000000 --- a/skype/skype-ps/skype/Get-CsTenantDialPlan.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsTenantDialPlan -schema: 2.0.0 ---- - -# Get-CsTenantDialPlan - -## SYNOPSIS -Use the Get-CsTenantDialPlan cmdlet to retrieve a tenant dial plan. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTenantDialPlan [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] -``` - -### Filter -``` -Get-CsTenantDialPlan [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsTenantDialPlan cmdlet returns information about one or more tenant dial plans (also known as a location profiles) in an organization. -Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. -The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied, and whether a prefix must be dialed for external calls. - -You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information about the normalization rules of a tenant dial plan. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsTenantDialPlan -``` - -This example retrieves a tenant dial plan. - - - -### -------------------------- Example 2 -------------------------- -``` -Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 -``` - -This example retrieves the tenant dial plan that is within the scope of Vt1TenantDialplan2. - - -## PARAMETERS - -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the tenant dial plan to retrieve. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md b/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md index 5b0cc65510..af7842ce10 100644 --- a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-cstenanthybridconfiguration +applicable: Skype for Business Server 2019 title: Get-CsTenantHybridConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTenantHybridConfiguration @@ -11,6 +16,8 @@ schema: 2.0.0 Returns values for the hybrid configuration settings that enable users homed on Skype for Business Online to have access to Enterprise Voice features such as media bypass, Enhanced 9-1-1, and call parking. A hybrid scenario (also known as a split-domain scenario) is a Skype for Business Server deployment in which some users have accounts homed on-premises while other users have accounts homed on Skype for Business Online. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -29,15 +36,15 @@ In a hybrid or "split domain" deployment, an organization has some users who hav By default, users homed on Skype for Business Online do not have access to the complete range of capabilities offered by Enterprise Voice; that's because the Skype for Business Server servers do not have direct access to Skype for Business Online deployment and network configuration information. Among other things, Skype for Business Online users do not have default access to such things as: -Enhanced 9-1-1, the service used for making emergency phone calls. +* Enhanced 9-1-1, the service used for making emergency phone calls. -Call parking, the service that enables users to place a call on hold phone A, then retrieve that call from phone B. +* Call parking, the service that enables users to place a call on hold phone A, then retrieve that call from phone B. -Media bypass, which enables calls to and from the public switched telephone network (PSTN) to bypass the Mediation server, helping to minimize transcoding and network latency. +* Media bypass, which enables calls to and from the public switched telephone network (PSTN) to bypass the Mediation server, helping to minimize transcoding and network latency. -PSTN conferencing dial-in and dial-out, which enables users to participate in the audio portion of an online conference by using any PSTN telephone or mobile device. +* PSTN conferencing dial-in and dial-out, which enables users to participate in the audio portion of an online conference by using any PSTN telephone or mobile device. -The Response Group application, which provides a way for you to automatically route phone calls to entities such as a help desk or customer support line. +* The Response Group application, which provides a way for you to automatically route phone calls to entities such as a help desk or customer support line. By default, Skype for Business Online users cannot function as Response Group agents. In order to provide Skype for Business Online users with access to these Enterprise Voice capabilities, administrators need to assign the appropriate values to hybrid configuration settings such as the internal and external Web service URLs and the fully qualified domain name of the organization's Access Edge server. @@ -147,24 +154,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -183,4 +174,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsTenantHybridConfiguration](Set-CsTenantHybridConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md b/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md deleted file mode 100644 index 675efc91d5..0000000000 --- a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsTenantLicensingConfiguration -schema: 2.0.0 ---- - -# Get-CsTenantLicensingConfiguration - -## SYNOPSIS -Indicates whether licensing information for the specified tenant is available in the Lync admin center. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTenantHybridConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] - [<CommonParameters>] -``` - -### Filter -``` -Get-CsTenantHybridConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-CsTenantLicensingConfiguration cmdlet indicates whether licensing information for the specified tenant is available in the Lync admin center. -The cmdlet returns information similar to this: - -Identity : GlobalStatus : Enabled - -If the Status is equal to Enabled then licensing information is available in the admin center. -If not, then licensing information is not available in the admin center. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsTenantLicensingConfiguration -``` - -The command shown in Example 1 returns licensing configuration information for the current tenant: - - -## PARAMETERS - -### -Filter -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. - -```yaml -Type: String -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 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. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is not used with Skype for Business Online. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose licensing settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### Deserialized.Microsoft.Rtc.Management.WritableConfig.Settings.TenantConfiguration.TenantLicensingConfiguration - - -## NOTES - - -## RELATED LINKS - -[Get-CsTenant](Get-CsTenant.md) - diff --git a/skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md b/skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md deleted file mode 100644 index ba60faae81..0000000000 --- a/skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsTenantMigrationConfiguration -schema: 2.0.0 ---- - -# Get-CsTenantMigrationConfiguration - -## SYNOPSIS -Use the Get-CsTenantMigrationConfiguration cmdlet to check if Meeting Migration Service (MMS) is enabled in your organization. - -## SYNTAX - -``` -Get-CsTenantMigrationConfiguration [-LocalStore] [[-Identity] <XdsIdentity>] [-Tenant <Guid>] [-Filter <String>] - [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. This tool does not migrate Skype for Business meetings into Microsoft Teams meetings. - -The Get-CsTenantMigrationConfiguration cmdlet retrieves the Meeting Migration Service configuration in your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Get-CsTenantMigrationConfiguration -``` - -This example shows the MMS configuration in your organization. - -## PARAMETERS - -### -Filter -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 -``` - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Set-CsTenantMigrationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-cstenantmigrationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsTenantPublicProvider.md b/skype/skype-ps/skype/Get-CsTenantPublicProvider.md deleted file mode 100644 index 643e8372f6..0000000000 --- a/skype/skype-ps/skype/Get-CsTenantPublicProvider.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Get-CsTenantPublicProvider -schema: 2.0.0 ---- - -# Get-CsTenantPublicProvider - -## SYNOPSIS -Returns information indicating whether Skype for Business Online users are allowed to communicate with people who have accounts on the third-party IM and presence providers Windows Live, AOL, and Yahoo. - -## SYNTAX - -``` -Get-CsTenantPublicProvider [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -Public providers are organizations that provide SIP communication services for the general public. -When you establish a federation relationship with a public provider, you effectively establish federation with any user who has an account hosted by that provider. -For example, if you federate with Windows Live, then your users will be able to exchange instant messages and presence information with anyone who has a Windows Live instant messaging account. - -Skype for Business Online gives administrators the option of configuring federation with one or more of the following public IM and presence providers: - -Windows Live - -AOL - -Yahoo! - -Administrators can use the Get-CsTenantPublicProvider cmdlet to determine which of those providers (if any) have been enabled for federation. -When you call the Get-CsTenantPublicProvider cmdlet you will get back information similar to this: - -PublicProviderSet DomainPicStatus - ------------------- ------------------------ - -True {Microsoft.Rtc.Management.Hosted.DomainPICStatus} - -The PublicProviderSet property indicates whether or not federation has been enabled for one or more public provider. -If PublicProviderSet is equal to True then that means federation has been enabled with at least one provider; if PublicProviderSet is equal to False then that means that federation is disabled for all three public providers (Windows Live, AOL, and Yahoo). -To determine the actual status of each provider use this command: - -Get-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" | Select-Object -ExpandProperty DomainPICStatus - -Note that simply enabling the status of a public provider does not mean that users can exchange instant messages and presence information with users who have accounts on that provider. -In addition to enabling federation with the provider itself, administrators must also set the AllowPublicUsers property of the federation configuration settings to True. -If this property is set to False then communication will not be allowed with any of the public providers, regardless of the public provider configuration settings. - -For more information, see the help topic for the Set-CsTenantFederationConfiguration cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" | Select-Object -ExpandProperty DomainPICStatus -``` - -Example 1 returns detailed information about the status of all the public providers assigned to the tenant bf19b7db-6960-41e5-a139-2aa373474354. -To do this, the command first uses the Get-CsTenantPublicProvider cmdlet to return public provider information for the specified tenant. -That information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the DomainPICStatus property. -Expanding a property simply means displaying all the values stored in that property onscreen, and in an easy-to-read format. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" | Select-Object -ExpandProperty DomainPICStatus | Where-Object {$_.Status -eq "Enabled"} -``` - -The command shown in Example 23 is a variation of the command shown in Example 1. -In Example 2, however, the public provider information returned by "expanding" the value of the DomainPICStatus property is, in turn, piped to the Where-Object cmdlet. -The Where-Object cmdlet then picks out only those providers where the Status property is set to Enabled. -The net effect is to display only those public providers that are enabled for use. - - -## PARAMETERS - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose public provider settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.TenantPICStatus - - -## NOTES - - -## RELATED LINKS - -[Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) - -[Set-CsTenantPublicProvider](Set-CsTenantPublicProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md index 7061d09cc0..375176efc1 100644 --- a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTenantUpdateTimeWindow @@ -116,24 +121,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -142,4 +131,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTestDevice.md b/skype/skype-ps/skype/Get-CsTestDevice.md index 1abf57d81e..079667d0d1 100644 --- a/skype/skype-ps/skype/Get-CsTestDevice.md +++ b/skype/skype-ps/skype/Get-CsTestDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTestDevice @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -166,4 +171,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTestDevice](Remove-CsTestDevice.md) [Set-CsTestDevice](Set-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/Get-CsTestUserCredential.md b/skype/skype-ps/skype/Get-CsTestUserCredential.md index 7e625ded89..328d03a5ff 100644 --- a/skype/skype-ps/skype/Get-CsTestUserCredential.md +++ b/skype/skype-ps/skype/Get-CsTestUserCredential.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTestUserCredential @@ -91,7 +96,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -111,4 +116,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) [Set-CsTestUserCredential](Set-CsTestUserCredential.md) - diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md index d0706440b1..eec5a7e4a6 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsThirdPartyVideoSystem @@ -230,7 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -247,4 +252,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md index a1e6a719fb..372623ffd8 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsThirdPartyVideoSystemPolicy @@ -169,7 +174,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -194,4 +199,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsTopology.md b/skype/skype-ps/skype/Get-CsTopology.md index 4755167ae9..4f487076f5 100644 --- a/skype/skype-ps/skype/Get-CsTopology.md +++ b/skype/skype-ps/skype/Get-CsTopology.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTopology @@ -94,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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -117,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Publish-CsTopology](Publish-CsTopology.md) [Test-CsTopology](Test-CsTopology.md) - diff --git a/skype/skype-ps/skype/Get-CsTrunk.md b/skype/skype-ps/skype/Get-CsTrunk.md index d299797784..96dffbef9c 100644 --- a/skype/skype-ps/skype/Get-CsTrunk.md +++ b/skype/skype-ps/skype/Get-CsTrunk.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTrunk @@ -140,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -159,4 +164,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md b/skype/skype-ps/skype/Get-CsTrunkConfiguration.md index 76bfa482d3..c3be85f003 100644 --- a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTrunkConfiguration @@ -110,7 +115,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -135,4 +140,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsTrunkConfiguration](Set-CsTrunkConfiguration.md) [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplication.md b/skype/skype-ps/skype/Get-CsTrustedApplication.md index 7364918bf9..b4d37f606f 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplication.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTrustedApplication @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -187,4 +192,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTrustedApplication](Remove-CsTrustedApplication.md) [Set-CsTrustedApplication](Set-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md b/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md index d6e5892174..17ccc65a5d 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTrustedApplicationComputer @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) [Remove-CsTrustedApplicationComputer](Remove-CsTrustedApplicationComputer.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md index 344c5b9b69..d41c6cd9e1 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTrustedApplicationEndpoint @@ -66,7 +71,7 @@ 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 modified. +The Identity (distinguished name), SIP address, or display name of the application endpoint to be retrieved. ```yaml Type: UserIdParameter @@ -200,7 +205,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -223,4 +228,3 @@ Accepts a pipelined string value representing the Identity of a user account. [Remove-CsTrustedApplicationEndpoint](Remove-CsTrustedApplicationEndpoint.md) [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md b/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md index b3e42ce4c7..c790d1b493 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsTrustedApplicationPool @@ -242,7 +247,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -258,16 +263,8 @@ Retrieves one or more objects of type Microsoft.Rtc.Management.Xds.DisplayExtern ## RELATED LINKS -[Online Version](http://technet.microsoft.com/EN-US/library/f8dc4ad7-fc32-482b-a1cb-5ba106df3344(OCS.14).aspx) - [New-CsTrustedApplicationPool](New-CsTrustedApplicationPool.md) [Remove-CsTrustedApplicationPool](Remove-CsTrustedApplicationPool.md) [Set-CsTrustedApplicationPool](Set-CsTrustedApplicationPool.md) - -[Online Version](http://technet.microsoft.com/EN-US/library/f8dc4ad7-fc32-482b-a1cb-5ba106df3344(OCS.15).aspx) - -[Online Version](http://technet.microsoft.com/EN-US/library/f8dc4ad7-fc32-482b-a1cb-5ba106df3344(OCS.16).aspx) - - diff --git a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md index b8d21171b1..7441f11f69 100644 --- a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csucphoneconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUCPhoneConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsUCPhoneConfiguration @@ -191,28 +196,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -236,4 +221,3 @@ The Get-CsUCPhoneConfiguration cmdlet returns instances of the Microsoft.Rtc.Man [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsUICulture.md b/skype/skype-ps/skype/Get-CsUICulture.md index a4dbe511aa..071c8309d1 100644 --- a/skype/skype-ps/skype/Get-CsUICulture.md +++ b/skype/skype-ps/skype/Get-CsUICulture.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUICulture @@ -61,7 +66,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -79,4 +84,3 @@ The Get-CsUICulture cmdlet returns instances of the System.Globalization.Culture ## RELATED LINKS [Set-CsUICulture](Set-CsUICulture.md) - diff --git a/skype/skype-ps/skype/Get-CsUnassignedNumber.md b/skype/skype-ps/skype/Get-CsUnassignedNumber.md index 21152c581b..903f8ebaea 100644 --- a/skype/skype-ps/skype/Get-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/Get-CsUnassignedNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUnassignedNumber @@ -117,7 +122,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +143,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnounce [Remove-CsUnassignedNumber](Remove-CsUnassignedNumber.md) [Set-CsUnassignedNumber](Set-CsUnassignedNumber.md) - diff --git a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md b/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md new file mode 100644 index 0000000000..e8d813bd7c --- /dev/null +++ b/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md @@ -0,0 +1,126 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Get-CsUpgradeDomainInfo + +## SYNOPSIS +Returns information indicating whether or not your Skype for Business Server Registrar pools are ready to be upgraded. +The upgrade readiness state for a pool is based on the upgrade domains that have been configured for that pool. + +## SYNTAX + +``` +Get-CsUpgradeDomainInfo [-Force] [-QueryTimeout <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsUpgradeDomainInfo cmdlet returns information about the upgrade readiness for a Skype for Business Server pool. +The returned information includes the number of Front End servers assigned to the pool; the number of currently active Front End servers; the name of the upgrade domain; and a True/False value that indicates whether the current state of the pool allows it to be upgraded. +Note that this cmdlet must be run locally on a Front End server in the pool being checked. +There are no options enabling you to run the Get-CsUpgradeDomainInfo cmdlet remotely. + +The functions carried out by the Get-CsUpgradeDomainInfo cmdlet are not available in the Skype for Business Server Control Panel. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsUpgradeDomainInfo +``` + +The command shown in Example 1 returns the upgrade readiness state for the local Registrar pool. +Note that this command must be executed on a Front End server located within the pool. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before executing the command. + +```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 +``` + +### -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 +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 Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryTimeout +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Hadr.PoolUpgradeState + + +## NOTES + + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsUser.md b/skype/skype-ps/skype/Get-CsUser.md index fedb57f774..c59d7c3028 100644 --- a/skype/skype-ps/skype/Get-CsUser.md +++ b/skype/skype-ps/skype/Get-CsUser.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUser ## SYNOPSIS -Returns information about all the users in your organization who have been enabled for Skype for Business Server 2015 or a previous version of the software. +Returns information about all the users in your organization who have been enabled for Skype for Business Server 2019 or a previous version of the software. This cmdlet was introduced in Lync Server 2010. @@ -44,7 +49,7 @@ For example, if you don't want to return all your Skype for Business Server user (These parameters are mutually exclusive: if you use Filter in a command you cannot use LdapFilter in that same command, and vice-versa.) The Filter parameter enables you to limit the returned data to users who meet the specified Skype for Business Server criteria; for example, you might decide to return only users with accounts on the specified Registrar pool, or only users who have been enabled for Enterprise Voice. The LdapFilter parameter enables you to limit the returned data to users who fit other Active Directory-based criteria; for example, users who work in a specified state or province, users who do or do not have a pager, or users with a designated job title. -**Note: the equivalent command for Skype for Business Online is [Get-CsOnlineUser](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlineuser?view=skype-ps)**. +**Note: the equivalent command for Skype for Business Online is [Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/skype/get-csonlineuser?view=skype-ps)**. ## EXAMPLES @@ -384,7 +389,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -410,4 +415,3 @@ The Get-CsUser cmdlet returns instances of the Microsoft.Rtc.Management.ADConnec [Move-CsUser](Move-CsUser.md) [Set-CsUser](Set-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsUserAcp.md b/skype/skype-ps/skype/Get-CsUserAcp.md index 60dfc46fc4..430f4b037c 100644 --- a/skype/skype-ps/skype/Get-CsUserAcp.md +++ b/skype/skype-ps/skype/Get-CsUserAcp.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csuseracp +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserAcp schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsUserAcp @@ -28,10 +33,12 @@ Get-CsUserAcp \[\[-Identity\] \<UserIdParameter\>\] \[-Filter \<string\>\] \[-Ld ``` Get-CsUserAcp [[-Identity] <UserIdParameter>] [-Credential <PSCredential>] [-Filter <String>] [-LdapFilter <String>] [-ResultSize <Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32]>] - [-AsJob] [<CommonParameters>] + [<CommonParameters>] ``` ## DESCRIPTION +Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://learn.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. + An audio conferencing provider is a third-party company that provides organizations with conferencing services. Among other things, audio conferencing providers provide a way for users located off site, and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or meeting. Audio conferencing providers often provide high-end services such as live translation, transcription, and live per-conference operator assistance. @@ -215,24 +222,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -256,4 +247,3 @@ The Get-CsUserAcp cmdlet returns instances of the Microsoft.Rtc.Management.ADCon [Remove-CsUserAcp](Remove-CsUserAcp.md) [Set-CsUserAcp](Set-CsUserAcp.md) - diff --git a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md b/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md new file mode 100644 index 0000000000..3fa9eb9579 --- /dev/null +++ b/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md @@ -0,0 +1,76 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Get-CsUserCallForwardingSettings + +## SYNOPSIS +This cmdlet returns the specified user's call forwarding settings as an object, and displays the same on the screen. + +## SYNTAX + +``` +Get-CsUserCallForwardingSettings [-User] <String> [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. + +The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: + +- CsAdministrator - Get and Set for all cmdlets +- CsVoiceAdministrator - Get and Set for all cmdlets +- CsServerAdministrator - Get and Set for all cmdlets +- CsHelpDesk - Get for all cmdlets + +Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. + +## EXAMPLES + +###-------------------------- Example -------------------------- +``` +Get-CsUserCallForwardingSettings -User jphillips@contoso.com +``` +This example returns the call forwarding settings for the specified user and displays the same on screen + +## PARAMETERS + +### -User +Specifies the identity of the target user. +Acceptable values include: +Example: jphillips@contoso.com +Example: sip:jphillips@contoso.com + +```yaml +Type: String +Parameter Sets: (All) +Aliases: DisplayName, SipAddress, Identity +Applicable: Skype for Business Server 2019CU1 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Call forwarding settings for specified user + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsUserDatabaseState.md b/skype/skype-ps/skype/Get-CsUserDatabaseState.md index 6d3955ae65..e213d9e530 100644 --- a/skype/skype-ps/skype/Get-CsUserDatabaseState.md +++ b/skype/skype-ps/skype/Get-CsUserDatabaseState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUserDatabaseState @@ -119,7 +124,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -139,6 +144,3 @@ The Get-CsUserDatabaseState cmdlet returns instances of the Microsoft.Rtc.Manage [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) [Update-CsUserDatabase](Update-CsUserDatabase.md) - - - diff --git a/skype/skype-ps/skype/Get-CsUserDelegates.md b/skype/skype-ps/skype/Get-CsUserDelegates.md new file mode 100644 index 0000000000..414d0cf5f2 --- /dev/null +++ b/skype/skype-ps/skype/Get-CsUserDelegates.md @@ -0,0 +1,76 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Get-CsUserDelegates + +## SYNOPSIS +This cmdlet returns an object of delegates list, and displays the specified user's delegate list, in case of success. In case of failure, appropriate error message is shown. + +## SYNTAX + +``` +Get-CsUserDelegates [-User] <String> [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. + +The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: + +- CsAdministrator - Get and Set for all cmdlets +- CsVoiceAdministrator - Get and Set for all cmdlets +- CsServerAdministrator - Get and Set for all cmdlets +- CsHelpDesk - Get for all cmdlets + +Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. + +## EXAMPLES + +###-------------------------- Example -------------------------- +``` +Get-CsUserDelegates -User jphillips@contoso.com +``` +This example returns the list of delegates for the specified user + +## PARAMETERS + +### -User +Specifies the identity of the target user. +Acceptable values include: +Example: jphillips@contoso.com +Example: sip:jphillips@contoso.com + +```yaml +Type: String +Parameter Sets: (All) +Aliases: DisplayName, SipAddress, Identity +Applicable: Skype for Business Server 2019CU1 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### an object of delegates list + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsUserLocationStatus.md b/skype/skype-ps/skype/Get-CsUserLocationStatus.md index 9532a5d4fe..88057a3b23 100644 --- a/skype/skype-ps/skype/Get-CsUserLocationStatus.md +++ b/skype/skype-ps/skype/Get-CsUserLocationStatus.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsUserLocationStatus @@ -13,7 +18,7 @@ With `Get-CsUserLocationStatus` you can track the progress of the regionally hos ## SYNTAX ``` -Get-CsUserLocationStatus [[-Tenant] <Guid>] [[-Identity] <UserIdParameter>] [-Confirm] [-WhatIf] [-AsJob] +Get-CsUserLocationStatus [[-Tenant] <Guid>] [[-Identity] <UserIdParameter>] [-Confirm] [-WhatIf] [<CommonParameters>] ``` @@ -104,28 +109,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +123,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsUserPoolInfo.md b/skype/skype-ps/skype/Get-CsUserPoolInfo.md index 4f902de6e8..dc820faa56 100644 --- a/skype/skype-ps/skype/Get-CsUserPoolInfo.md +++ b/skype/skype-ps/skype/Get-CsUserPoolInfo.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUserPoolInfo @@ -54,8 +59,8 @@ This command returns user pool information for a single user: the user with the Get-CsUser | Get-CsUserPoolInfo ``` -In Example 2, user pool information is returned for all the users who have been enabled for Skype for Business Server 2015. -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 Skype for Business Server 2015-enabled users. +In Example 2, user pool information is returned for all the users who have been enabled for Skype for Business Server. +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 -------------------------- @@ -64,8 +69,8 @@ Get-CsUser | Where-Object {$_.RegistrarPool -ne $Null} | Get-CsUserPoolInfo ``` The command shown in Example 3 is a variation of the command used in Example 2. -In Example 2, pool information is returned for all the users who have been enabled for Skype for Business Server 2015. -However, it is possible to have users who have been enabled for Skype for Business Server 2015 but have not been assigned a Registrar pool. +In Example 2, pool information is returned for all the users who have been enabled for Skype for Business Server. +However, it is possible to have users who have been enabled for Skype for Business Server but have not been assigned a Registrar pool. The command shown in Example 2 displays an error message for each user who meets those criteria; those error messages are suppressed in Example 3. To suppress the error message, Example 3 again uses the Get-CsUser cmdlet to return a collection of all the Skype for Business Server-enabled users. @@ -88,11 +93,11 @@ Get-CsUser | Get-CsUserPoolInfo | Where-Object {$_.BackupPoolFqdn -eq $Null} ``` The command shown in Example 5 returns pool information for all the users who have not been assigned a backup Registrar pool. -To carry out this task, the command first calls the Get-CsUser cmdlet to return a collection of all the users who have been enabled for Skype for Business Server 2015. +To carry out this task, the command first calls the Get-CsUser cmdlet to return a collection of all the users who have been enabled for Skype for Business Server. 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 ------------------------ (Lync Server 2010) +### -------------------------- Example ------------------------ ``` Get-CsUserPoolInfo "Ken Myer" | Select-Object -Expand PrimaryPoolMachinesInPreferredOrder ``` @@ -110,8 +115,8 @@ Indicates the Identity of the user whose user pool information is to be retrieve 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. -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns information for users who have a last name that ends with the string value " Smith". +You can use the asterisk (\*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "\* Smith" returns information for users who have a last name that ends with the string value " Smith". @@ -147,13 +152,13 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## 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 2015. +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. The cmdlet also accepts pipelined instances of the Active Directory user object. ## OUTPUTS @@ -164,5 +169,3 @@ The Get-CsUserPoolInfo cmdlet returns instances of the Microsoft.Rtc.Management. ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsUserPstnSettings.md b/skype/skype-ps/skype/Get-CsUserPstnSettings.md index e63028d7ae..0db2a2b553 100644 --- a/skype/skype-ps/skype/Get-CsUserPstnSettings.md +++ b/skype/skype-ps/skype/Get-CsUserPstnSettings.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsUserPstnSettings @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the Get-CsUserPstnSettings cmdlet to retrieve a voice-enabled user's public switched telephone network (PSTN) settings. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -116,28 +123,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -152,5 +139,3 @@ The Get-CsUserPstnSettings cmdlet returns instances of the UserPstnSettings obje ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md index de6bbc331e..479833bdf5 100644 --- a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUserReplicatorConfiguration @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,4 +160,3 @@ The Get-CsUserReplicatorConfiguration cmdlet returns instances of the Microsoft. [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md b/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md index 2b10468474..110e94585e 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsUserServicesConfiguration @@ -165,7 +170,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +194,3 @@ The Get-CsUserServicesConfiguration cmdlet returns instances of the Microsoft.Rt [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md b/skype/skype-ps/skype/Get-CsUserServicesPolicy.md index f8674de724..2feb41556d 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Get-CsUserServicesPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicespolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserServicesPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsUserServicesPolicy @@ -181,28 +186,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -230,4 +215,3 @@ The Get-CsUserServicesPolicy cmdlet returns instances of the Microsoft.Rtc.Manag [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsUserSession.md b/skype/skype-ps/skype/Get-CsUserSession.md index c28a684d37..8871e70049 100644 --- a/skype/skype-ps/skype/Get-CsUserSession.md +++ b/skype/skype-ps/skype/Get-CsUserSession.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsUserSession @@ -13,15 +18,15 @@ Use the Get-CsUserSession cmdlet to retrieve user session information within a s ## SYNTAX ``` -Get-CsUserSession -StartTime <DateTimeOffset> -User <String> [-EndTime <DateTimeOffset>] [-AsJob] [<CommonParameters>] +Get-CsUserSession -StartTime <DateTimeOffset> -User <String> [-EndTime <DateTimeOffset>] [<CommonParameters>] ``` ## DESCRIPTION -Use the Get-CsUserSession cmdlet to retrieve session information for users within a specified date range within the past 30 days. +**Deprecation Notice**: We will be retiring this feature and cmdlet from Skype for Business Online beginning 5/30/2020. Instead, we recommend the utilization of MS Graph Call Records API, which is where we will continue to invest our development resources. For more information, see <https://learn.microsoft.com/graph/api/resources/callrecords-api-overview?view=graph-rest-beta>. -To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command: +Use the Get-CsUserSession cmdlet to retrieve session information for users within a specified date range within the past 30 days. -`Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"}` +You have to be assigned Skype For Business admin role to run this cmdlet. ## EXAMPLES @@ -84,28 +89,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -120,4 +105,3 @@ The Get-CsUserSession cmdlet returns an instance of the Microsoft.Rtc.Management ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md b/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md new file mode 100644 index 0000000000..f92d47dd5f --- /dev/null +++ b/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsUserSettingsPageConfiguration + +## SYNOPSIS +This command is used to get the current URI for setting PSTN calling and voice mail related settings. + +## SYNTAX + +### Identity (Default) +``` +Get-CsUserSettingsPageConfiguration [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsUserSettingsPageConfiguration [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +This command is used to get the current URI for setting PSTN calling and voice mail related settings. The Skype for Business Administrator may choose to update these URI based on their configured PSTN calling and Voice mail services using Set-CsUserSettingsPageConfiguration: +- PstnCallingUri: The URI of the PstnCalling User settings page +- VoicemailUri: The URI of the Voicemail tab in User Settings Portal + + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsUserSettingsPageConfiguration +``` + +This example is used to retrieve the Global User Settings Page Configuration. + +## PARAMETERS + +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the scope. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Retrieves the user pool 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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsUserTeamMembers.md b/skype/skype-ps/skype/Get-CsUserTeamMembers.md new file mode 100644 index 0000000000..a5584e71ca --- /dev/null +++ b/skype/skype-ps/skype/Get-CsUserTeamMembers.md @@ -0,0 +1,77 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Get-CsUserTeamMembers + +## SYNOPSIS +This cmdlet returns an object containing list of team members and displays the object on screen, in case of success. In case of failure, the appropriate error message is shown. + +## SYNTAX + +``` +Get-CsUserTeamMembers [-User] <String> [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. + +The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: + +- CsAdministrator - Get and Set for all cmdlets +- CsVoiceAdministrator - Get and Set for all cmdlets +- CsServerAdministrator - Get and Set for all cmdlets +- CsHelpDesk - Get for all cmdlets + +Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. + +## EXAMPLES + +###-------------------------- Example -------------------------- +``` +Get-CsUserTeamMembers -User jphillips@contoso.com +``` + +This example returns the list of team members for the specified user and displays on the screen. + +## PARAMETERS + +### -User +Specifies the identity of the target user. +Acceptable values include: +Example: jphillips@contoso.com +Example: sip:jphillips@contoso.com + +```yaml +Type: String +Parameter Sets: (All) +Aliases: DisplayName, SipAddress, Identity +Applicable: Skype for Business Server 2019CU1 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### an object of team members list + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md index 5bf6ef2c41..66425ce2e9 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVideoInteropServerConfiguration @@ -148,7 +153,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ The Get-CsVideoInteropServerConfiguration cmdlet returns instances of the Micros [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md index 4cc7d08579..007084aa59 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVideoInteropServerSyntheticTransactionConfiguration @@ -98,7 +103,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -121,4 +126,3 @@ Returns an object array, or single instance (if used with the Identity parameter [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/Get-CsVideoTrunk.md b/skype/skype-ps/skype/Get-CsVideoTrunk.md index 524853a6ae..b6024c0dac 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunk.md +++ b/skype/skype-ps/skype/Get-CsVideoTrunk.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVideoTrunk @@ -121,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -139,4 +144,3 @@ The Get-CsVideoTrunk cmdlet returns instances of the Microsoft.Rtc.Management.Xd ## RELATED LINKS [Set-CsVideoGateway](Set-CsVideoGateway.md) - diff --git a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md index 23e7ec348c..fc9b683da3 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVideoTrunkConfiguration @@ -30,7 +35,7 @@ The Video Interop Server is a Skype service that runs on a standalone pool and c To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -166,4 +171,3 @@ The Get-CsVideoTrunkConfiguration cmdlet returns instances of the Microsoft.Rtc. [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md b/skype/skype-ps/skype/Get-CsVoiceConfiguration.md index cc877e5fa9..862ecb0444 100644 --- a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVoiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVoiceConfiguration @@ -94,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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -115,4 +120,3 @@ This cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.P [Set-CsVoiceConfiguration](Set-CsVoiceConfiguration.md) [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md index 997e5a5cc3..9747b6b836 100644 --- a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsVoiceNormalizationRule @@ -12,17 +17,18 @@ Returns information about the voice normalization rules used in your organizatio Voice normalization rules convert telephone dialing requirements (for example, dialing 9 to access an outside line) to the E.164 phone number format used by Skype for Business Server. This cmdlet was introduced in Lync Server 2010. +**Note**: This cmdlet has been deprecated in Teams PowerShell Module 4.0.0. + ## SYNTAX ### Identity (Default) ``` -Get-CsVoiceNormalizationRule [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] - [<CommonParameters>] +Get-CsVoiceNormalizationRule [[-Identity] <XdsIdentity>] [-Tenant <guid>] [-LocalStore] [<CommonParameters>] ``` ### Filter ``` -Get-CsVoiceNormalizationRule [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +Get-CsVoiceNormalizationRule [-Tenant <guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] ``` ## DESCRIPTION @@ -79,7 +85,7 @@ If a value is specified for this parameter, it must be in the format scope/name; 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -97,7 +103,7 @@ For example, the filter value *lob* will return all rules at the global scope (s 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -113,7 +119,7 @@ Retrieves the voice normalization rule from the local replica of the Central Man 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,29 +129,13 @@ Accept wildcard characters: False ``` ### -Tenant -{{Fill Tenant Description}} +For internal Microsoft usage. ```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 -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -182,4 +172,3 @@ The Get-CsVoiceNormalizationRule cmdlet returns instances of the Microsoft.Rtc.M [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) [Get-CsDialPlan](Get-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Get-CsVoicePolicy.md b/skype/skype-ps/skype/Get-CsVoicePolicy.md index 0e26bca29b..ee4a8eb0cb 100644 --- a/skype/skype-ps/skype/Get-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Get-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsVoicePolicy @@ -75,7 +80,7 @@ If this parameter is omitted, all voice policies for the organization are return 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -95,7 +100,7 @@ For example, a Filter value of tag:* will return all voice policies defined at t 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -113,7 +118,7 @@ Retrieves the voice policy from the local replica of the Central Management stor 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -134,17 +139,11 @@ 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: Guid 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -154,7 +153,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -179,4 +178,3 @@ This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Pol [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) [Test-CsVoicePolicy](Test-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceRoute.md b/skype/skype-ps/skype/Get-CsVoiceRoute.md index 61fb37bb5a..f66706f65e 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Get-CsVoiceRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVoiceRoute @@ -126,7 +131,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -150,4 +155,3 @@ This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Pol [Set-CsVoiceRoute](Set-CsVoiceRoute.md) [Test-CsVoiceRoute](Test-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md index a52ddae235..05f3448032 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroutingpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceRoutingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Get-CsVoiceRoutingPolicy @@ -139,28 +144,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -184,4 +169,3 @@ The Get-CsVoiceRoutingPolicy cmdlet returns instances of the Microsoft.Rtc.Manag [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md index 95abfc2faf..3ebb3b103b 100644 --- a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVoiceTestConfiguration @@ -114,7 +119,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +143,3 @@ Returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Poli [Set-CsVoiceTestConfiguration](Set-CsVoiceTestConfiguration.md) [Test-CsVoiceTestConfiguration](Test-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md index 0fac24dbd2..18b12a31a4 100644 --- a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsVoicemailReroutingConfiguration @@ -126,7 +131,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Se [Remove-CsVoicemailReroutingConfiguration](Remove-CsVoicemailReroutingConfiguration.md) [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md index 1b0423705b..f8c31c4d96 100644 --- a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsWatcherNodeConfiguration @@ -142,7 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -166,4 +171,3 @@ The Get-CsWatcherNodeConfiguration cmdlet returns instances of the Microsoft.Rtc [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md b/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md index cb885b7acf..0955ecea76 100644 --- a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsWebServiceConfiguration @@ -163,7 +168,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -185,4 +190,3 @@ The Get-CsWebServiceConfiguration cmdlet returns instances of the Microsoft.Rtc. [Remove-CsWebServiceConfiguration](Remove-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsWindowsService.md b/skype/skype-ps/skype/Get-CsWindowsService.md index 28362902a0..1141e80426 100644 --- a/skype/skype-ps/skype/Get-CsWindowsService.md +++ b/skype/skype-ps/skype/Get-CsWindowsService.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsWindowsService @@ -216,7 +221,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -236,4 +241,3 @@ The Get-CsWindowsService cmdlet returns instances of the Microsoft.Rtc.Managemen [Start-CsWindowsService](Start-CsWindowsService.md) [Stop-CsWindowsService](Stop-CsWindowsService.md) - diff --git a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md index 052d7e187e..d842572c39 100644 --- a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsXmppAllowedPartner @@ -88,7 +93,7 @@ For example the filter value "*.org" returns a collection of all the XMPP allowe Type: String Parameter Sets: Filter Aliases: -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 @@ -105,7 +110,7 @@ If neither this parameter nor the Filter parameter is specified, then all the XM 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 Required: False Position: 2 @@ -121,7 +126,7 @@ Retrieves the XMPP allowed partner data from the local replica of the Central Ma 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 Required: False Position: Named @@ -131,7 +136,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -153,4 +158,3 @@ The Get-CsXmppAllowedPartner cmdlet returns instances of the Microsoft.Rtc.Manag [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md b/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md index 3e16e869fc..42d1978491 100644 --- a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Get-CsXmppGatewayConfiguration @@ -76,7 +81,7 @@ That syntax brings back all the XMPP gateway configuration settings that have an Type: String Parameter Sets: Filter Aliases: -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 @@ -99,7 +104,7 @@ If you prefer, however, you can use the following syntax to reference the global Type: XdsIdentity 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 Required: False Position: 2 @@ -115,7 +120,7 @@ Retrieves the XMPP gateway data from the local replica of the Central Management 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 Required: False Position: Named @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -143,4 +148,3 @@ The Get-CsXmppGatewayConfiguration cmdlet returns instances of the Microsoft.Rtc ## RELATED LINKS [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) - diff --git a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md b/skype/skype-ps/skype/Grant-CsArchivingPolicy.md index a85097925d..195e225d06 100644 --- a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsArchivingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsArchivingPolicy @@ -228,7 +233,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -255,5 +260,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md b/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md deleted file mode 100644 index 159dd4aae9..0000000000 --- a/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsBroadcastMeetingPolicy -schema: 2.0.0 ---- - -# Grant-CsBroadcastMeetingPolicy - -## SYNOPSIS -Use the Grant-CsBroadcastMeetingPolicy cmdlet to assign a broadcast meeting policy to a user. - -## SYNTAX -``` -Grant-CsBroadcastMeetingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Broadcast meeting functionality is managed by broadcast meeting configurations at the tenant level, and broadcast meeting policies at the user level. -Broadcast meeting policies are predefined in Skype for Business. -The defined settings for each policy can be displayed by using the Get-CsBroadcastMeetingPolicy cmdlet with no parameters. -New policies can't be created, and existing policies can't be modified. -They can only be granted, or assigned to users. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -Grant-CsBroadcastMeetingPolicy -Identity jphillips@contoso.com -PolicyName BroadcastMeetingPolicyAllEnabled -``` - -This example grants the BroadcastMeetingPolicyAllEnabled policy to a user identified by User Principal Name (UPN.) - - -## 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 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy to be assigned to a user. -A list of the policies for your organization can be retrieved using Get-CsBroadcastMeetingPolicy. -The PolicyName is the policy identity minus the policy scope (the "tag:" prefix). -For example, a policy with the identity "Tag:BroadcastMeetingPolicyDisabled" has a PolicyName equal to "BroadcastMeetingPolicyDisabled". -To unassign a previously assigned policy, set PolicyName to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md index f6ae59fe8c..5b5a65c2cf 100644 --- a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsCallViaWorkPolicy @@ -19,9 +24,8 @@ Grant-CsCallViaWorkPolicy [-Identity] <UserIdParameter> [-PolicyName] <String> [ ``` ## DESCRIPTION -To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command from the Windows PowerShell prompt. +This cmdlet assigns an existing per-user call via work policy to a user. Call via work policies are used to control access to the feature and manage the characteristics of outbound calls placed through the Skype for Business client. -`Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"}` ## EXAMPLES @@ -48,8 +52,8 @@ Domain name and logon name, in the form domain\logon Active Directory display name (Ken Myer), or 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" grants the policy all users who have a display name that ends in the string value " Smith". +In addition, you can use the asterisk (\*) wildcard character when using the display name as the user Identity. +For example, the Identity "\* Smith" grants the policy all users who have a display name that ends in the string value " Smith". ```yaml Type: UserIdParameter @@ -136,7 +140,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -152,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -175,5 +179,3 @@ None. [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsCallerIdPolicy.md b/skype/skype-ps/skype/Grant-CsCallerIdPolicy.md deleted file mode 100644 index a3d16d352e..0000000000 --- a/skype/skype-ps/skype/Grant-CsCallerIdPolicy.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsCallerIdPolicy -schema: 2.0.0 ---- - -# Grant-CsCallerIdPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Grant-CsCallerIdPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- (Skype for Business Online) -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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 - -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsCallingLineIdentity.md b/skype/skype-ps/skype/Grant-CsCallingLineIdentity.md deleted file mode 100644 index 0ae4c4139c..0000000000 --- a/skype/skype-ps/skype/Grant-CsCallingLineIdentity.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Grant-CsCallingLineIdentity -schema: 2.0.0 ---- - -# Grant-CsCallingLineIdentity - -## SYNOPSIS -Use the `Grant-CsCallingLineIdentity` cmdlet to apply a Caller ID policy to a user account. - -## SYNTAX - -``` -Grant-CsCallingLineIdentity [[-Identity] <UserIdParameter>] [[-PolicyName] <String>] [-Confirm] [-DomainController <Fqdn>] [-PassThru] [-Tenant <Guid>] [-WhatIf] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -You can either change or block the Caller ID (also called a Calling Line ID) for a user. By default, the Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can create a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed; you can then apply the Caller ID policy to a specific user. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Grant-CsCallingLineIdentity -Identity "Ken Myer" -PolicyName CallerIDRedmond -``` - -This example assigns the Caller ID policy with the Identity CallerIDRedmond to the user with the display name Ken Myer. - -### -------------------------- Example 2 -------------------------- -``` -Grant-CsCallingLineIdentity -PolicyName Anonymous -Identity "amos.marble@contoso.com" -``` - -This example grants the Caller ID policy "Anonymous" to the user Amos Marble. - - -## PARAMETERS - -### -Identity -The Identity (unique identifier) of the user to whom the policy is being assigned. 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). - -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: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The name (Identity) of the Caller ID 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: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the results of the command. By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Set-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/set-cscallinglineidentity?view=skype-ps) - -[Get-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/get-cscallinglineidentity?view=skype-ps) - -[Remove-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cscallinglineidentity?view=skype-ps) - -[New-CsCallingLineIdentity](https://docs.microsoft.com/en-us/powershell/module/skype/new-cscallinglineidentity?view=skype-ps) - diff --git a/skype/skype-ps/skype/Grant-CsClientPolicy.md b/skype/skype-ps/skype/Grant-CsClientPolicy.md index d902427b18..5b614c56ca 100644 --- a/skype/skype-ps/skype/Grant-CsClientPolicy.md +++ b/skype/skype-ps/skype/Grant-CsClientPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsClientPolicy @@ -101,7 +106,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam 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: 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 @@ -124,7 +129,7 @@ For example: 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 +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 @@ -141,7 +146,7 @@ If this parameter is not included then the cmdlet will use the first available d 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: 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 @@ -158,7 +163,7 @@ By default, the Grant-CsClientPolicy cmdlet does not pass objects through the pi 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: 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 @@ -174,7 +179,7 @@ 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 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 @@ -190,7 +195,7 @@ 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 +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 @@ -217,27 +222,6 @@ The Tenant parameter is primarily for use in a hybrid deployment. 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -247,7 +231,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -273,4 +257,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsClientPolicy](Remove-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md b/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md index f3d4ebf015..f3c7b5346a 100644 --- a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsClientVersionPolicy @@ -217,7 +222,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -243,4 +248,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md b/skype/skype-ps/skype/Grant-CsConferencingPolicy.md index 6c4978e60c..079b1f8b84 100644 --- a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsConferencingPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsConferencingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsConferencingPolicy @@ -208,24 +213,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -264,5 +253,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsDialPlan.md b/skype/skype-ps/skype/Grant-CsDialPlan.md index 53819a3f65..17aa244dd3 100644 --- a/skype/skype-ps/skype/Grant-CsDialPlan.md +++ b/skype/skype-ps/skype/Grant-CsDialPlan.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsDialPlan @@ -19,7 +24,7 @@ This cmdlet was introduced in Lync Server 2010. ``` Grant-CsDialPlan [-Identity] <UserIdParameter> [[-PolicyName] <String>] [-DomainController <Fqdn>] [-PassThru] - [-WhatIf] [-Confirm] [-Tenant <Guid>] [-AsJob] [<CommonParameters>] + [-WhatIf] [-Confirm] [-Tenant <Guid>] [<CommonParameters>] ``` ## DESCRIPTION @@ -29,7 +34,8 @@ Dial plans provide information required to enable Enterprise Voice users to make Users who do not have a valid dial plan will not be enabled to make calls by using Enterprise Voice. A dial plan determines such things as how normalization rules are applied and whether a prefix must be dialed for external calls. -You can check whether a user has been granted a per-user dial plan by calling a command in this format: `Get-CsUser "\<user name\>" | Select-Object DialPlan.` +You can check whether a user has been granted a per-user dial plan by calling a command in this format: `Get-CsUser "<user name>" | Select-Object DialPlan` + For example: `Get-CsUser "Ken Myer" | Select-Object DialPlan` @@ -172,7 +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 (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -204,4 +210,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Test-CsDialPlan](Test-CsDialPlan.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsDialoutPolicy.md b/skype/skype-ps/skype/Grant-CsDialoutPolicy.md deleted file mode 100644 index 0535342edf..0000000000 --- a/skype/skype-ps/skype/Grant-CsDialoutPolicy.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Grant-CsDialoutPolicy -schema: 2.0.0 ---- - -# Grant-CsDialoutPolicy - -## SYNOPSIS -Use the `Grant-CsDialoutPolicy` cmdlet to assign a per-user outbound calling restriction policy to one or more users. - -## SYNTAX -``` -Grant-CsDialoutPolicy [[-Identity] <UserIdParameter>] [[-PolicyName] <string>] [-Confirm] [-DomainController <Fqdn>] - [-PassThru] [-Tenant <Guid>] [-WhatIf] [-AsJob] [<CommonParameters>] -``` - -## DESCRIPTION -In Skype for Business Online, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. -To get all the available policies in your organization run `Get-CSOnlineDialOutPolicy`. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Grant-CsDialoutPolicy -Identity "ken.myer@contoso.com" -PolicyName "DialoutCPCandPSTNInternational" -``` - -This example assigns the per-user outbound calling restriction policy DialoutCPCandPSTNInternational to the user with the User Principal Name "ken.myer@contoso.com". - -### -------------------------- Example 2 -------------------------- -``` -PS C:\> Grant-CsDialoutPolicy -Identity "ken.myer@contoso.com" -PolicyName $Null -``` - -In this example, any per-user outbound calling restriction policy previously assigned to the user ken.myer@contoso.com is unassigned from that user; as a result, Ken Myer will be managed by the global outbound calling restriction policy. To unassign a per-user policy, set the PolicyName to a null value ($Null). - -### -------------------------- Example 3 -------------------------- -``` -PS C:\> Get-CsOnlineUser | Grant-CsDialoutPolicy -PolicyName "DialoutCPCInternationalPSTNDisabled" -``` - -This example assigns the per-user outbound calling restriction policy DialoutCPCInternationalPSTNDisabled to all the users in your organization. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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: -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 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: -Applicable: Skype for Business Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the results of the command. By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -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:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondPolicy has a PolicyName equal to RedmondPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Get-CSOnlineDialOutPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinedialoutpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md index 4bddbd7e34..cee8b30442 100644 --- a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsExternalAccessPolicy @@ -10,37 +15,51 @@ schema: 2.0.0 ## 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 have SIP accounts with a public instant messaging (IM) provider such as MSN; and, 3) 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. +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)](/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. +This cmdlet was introduced in Lync Server 2010. ## SYNTAX +### Identity (Default) +``` +Grant-CsExternalAccessPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsExternalAccessPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsExternalAccessPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> [<CommonParameters>] +``` + +### GrantToTenant ``` -Grant-CsExternalAccessPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +Grant-CsExternalAccessPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] ``` ## DESCRIPTION -When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +When you install Microsoft Teams or Skype for Business Server, your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. That might be sufficient to meet your communication needs. If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation will not automatically provide users with this capability. Instead, you must enable federation, and then assign users an external access policy that gives them the right to communicate with federated users. -2. -Communicate with people who have SIP accounts with a public instant messaging service such as MSN. +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -3. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +4. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. When you install Skype for Business Server, a global external access policy is automatically created for you. @@ -56,7 +75,6 @@ For example, suppose you create a per-user policy that allows communication with As long as that policy is in force, Ken will be allowed to communicate with federated users even if this type of communication is not allowed by Ken's site policy or by the global policy. That's because the settings in the per-user policy take precedence. - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -66,7 +84,6 @@ Grant-CsExternalAccessPolicy -Identity "Ken Myer" -PolicyName RedmondAccessPolic Example 1 assigns the external access policy RedmondAccessPolicy to the user with the Active Directory display name Ken Myer. - ### -------------------------- EXAMPLE 2 -------------------------- ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy @@ -76,7 +93,6 @@ The command shown in Example 2 assigns the external access policy RedmondAccessP To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who work in Redmond; the filter value "l=Redmond" limits returned data to those users who work in the city of Redmond (the l in the filter, a lowercase L, represents the locality). That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection. - ### -------------------------- EXAMPLE 3 -------------------------- ``` Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy @@ -86,7 +102,6 @@ In Example 3, all the users who have the job title "Sales Representative" are as To perform this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the Sales Representatives; the filter value "Title=Sales Representative" restricts the returned collection to users who have the job title "Sales Representative". This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection. - ### -------------------------- EXAMPLE 4 -------------------------- ``` Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy @@ -96,7 +111,6 @@ The command shown in Example 4 assigns the external access policy BasicAccessPol (That is, users currently being governed by a site policy or by the global policy.) To do this, the Get-CsUser cmdlet and the Filter parameter are used to return the appropriate set of users; the filter value {ExternalAccessPolicy -eq $Null} limits the returned data to user accounts where the ExternalAccessPolicy property is equal to (-eq) a null value ($Null). By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy. - ### -------------------------- EXAMPLE 5 -------------------------- ``` Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy @@ -106,7 +120,6 @@ Example 5 assigns the external access policy USAccessPolicy to all the users who The command starts off by calling the Get-CsUser cmdlet and the OU parameter; the parameter value "ou=US,dc=litwareinc,dc=com" limits the returned data to user accounts found in the US OU. The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection. - ### -------------------------- EXAMPLE 6 -------------------------- ``` Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null @@ -116,7 +129,6 @@ Example 6 unassigns any per-user external access policy previously assigned to a To do this, the command calls the Get-CsUser cmdlet (without any additional parameters) in order to return a collection of all the users enabled for Skype for Business Server. That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which uses the syntax "`-PolicyName $Null`" to remove any per-user external access policy previously assigned to these users. - ## PARAMETERS ### -Identity @@ -129,9 +141,9 @@ For example, the Identity "* Smith" returns all the users with a display name th ```yaml Type: UserIdParameter -Parameter Sets: (All) +Parameter Sets: GrantToUser Aliases: -Applicable: 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: True Position: 1 @@ -151,7 +163,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName 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 +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 @@ -168,7 +180,7 @@ If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet 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: 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 @@ -185,7 +197,7 @@ By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects throug 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: 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 @@ -201,7 +213,7 @@ 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 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 @@ -217,7 +229,7 @@ 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 +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 @@ -242,28 +254,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. +### -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. -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). +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: (All) -Aliases: -Applicable: Skype for Business Online +Parameter Sets: GrantToTenant +Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -302,5 +339,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Grant-CsExternalUserCommunicationPolicy.md deleted file mode 100644 index 65fe9bc146..0000000000 --- a/skype/skype-ps/skype/Grant-CsExternalUserCommunicationPolicy.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsExternalUserCommunicationPolicy -schema: 2.0.0 ---- - -# Grant-CsExternalUserCommunicationPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsExternalUserCommunicationPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> - [-Tenant <Guid>] [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GrantToTenant -``` -Grant-CsExternalUserCommunicationPolicy [-PolicyName] <String> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## 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: 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 - -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: Skype for Business Online - -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: Skype for Business Online - -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsGraphPolicy.md b/skype/skype-ps/skype/Grant-CsGraphPolicy.md index 59b18a5652..d1c384d7e3 100644 --- a/skype/skype-ps/skype/Grant-CsGraphPolicy.md +++ b/skype/skype-ps/skype/Grant-CsGraphPolicy.md @@ -1,15 +1,20 @@ --- -external help file: -applicable: Skype for Business Online +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Grant-CsGraphPolicy ## SYNOPSIS Use the Grant-CsGraphPolicy cmdlet to assign a previously defined graph policy to a user or to your organization. -Graph policies determine whether users can pre-load content or files that are attached to an Outlook meeting invitation into a Skype for Business Online meeting, +Graph policies determine whether users can pre-load content or files that are attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting, ## SYNTAX @@ -26,13 +31,13 @@ Grant-CsGraphPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController < ``` ## DESCRIPTION -Skype for Business Online supports a Global CsGraphPolicy that is set by default to enable Outlook content pre-load in Skype for Business Online meetings. +Microsoft Teams and Skype for Business Online support a Global CsGraphPolicy that is set by default to enable Outlook content pre-load in Microsoft Teams or Skype for Business Online meetings. The Global policy can't be changed by you. Use the Grant-CsGraphPolicy cmdlet to assign a predefined graph policy to users in your organization. To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command: -`Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"}` +`Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "<DesiredCmdletName>"}` ## EXAMPLES @@ -50,17 +55,17 @@ This example grants the "GraphDisabled" policy to Ken Myer. 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 Skype for Business Online meeting. -For example, `Grant-CsGraphPolicy -PolicyName "Graph Enabled".` +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 Skype for Business Online meeting. -For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled".` +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: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 2 @@ -76,7 +81,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -93,7 +98,7 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -109,7 +114,7 @@ Specifies the identity of the user who will be granted the graph policy. Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 1 @@ -125,7 +130,7 @@ Enables you to pass a user object through the pipeline that represents the user Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -141,7 +146,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -158,27 +163,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -188,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -203,5 +188,3 @@ The Grant-CsGraphPolicy cmdlet returns an object of type Microsoft.Rtc.Managemen ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md index 710cc8950e..9fe8d50ae6 100644 --- a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsHostedVoicemailPolicy @@ -69,7 +74,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter 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 Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -87,7 +92,7 @@ Per-user hosted voice mail policy identities include a prefix of tag: that shoul 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -104,7 +109,7 @@ If no domain controller is specified, the first available will be used. 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,7 +126,7 @@ By default, this cmdlet does not generate any output. 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -137,7 +142,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -153,39 +158,7 @@ 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -{{Fill Tenant Description}} - -```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 -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -195,7 +168,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -225,4 +198,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md b/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md index 7aace53ad7..0bc1ea6d26 100644 --- a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md +++ b/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md @@ -1,15 +1,20 @@ --- -external help file: -applicable: Skype for Business Online -title: Grant-CsIPPhonePolicy +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Grant-CsIPPhonePolicy ## SYNOPSIS Use the Grant-CsIPPhonePolicy cmdlet to assign an Internet Protocol (IP) phone policy to a user or a group of users. -IP phone policies determine the features of Skype for Business Online that are available to users. +IP phone policies determine the features of Microsoft Teams, Skype for Business Online, or Skype for Business Server 2019 that are available to users. For example, you might enable the Better Together Over Ethernet feature for some users while disabling it for others. ## SYNTAX @@ -27,7 +32,7 @@ Grant-CsIPPhonePolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController ``` ## DESCRIPTION -Skype for Business Online uses IP phone policies to determine the features and capabilities that are available to users. +Microsoft Teams or Skype for Business Online uses IP phone policies to determine the features and capabilities that are available to users. IP phone policies are applied each time a user accesses the system, regardless of where the user logs on from. ## EXAMPLES @@ -63,7 +68,7 @@ For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: 2 @@ -79,7 +84,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -95,7 +100,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -118,7 +123,7 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: 1 @@ -135,7 +140,7 @@ By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the p Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -151,7 +156,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -168,27 +173,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -198,7 +183,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -218,5 +203,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Get-CsIPPhonePolicy](Get-CsIPPhonePolicy.md) [Set-CsIPPhonePolicy](Set-CsIPPhonePolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsLocationPolicy.md b/skype/skype-ps/skype/Grant-CsLocationPolicy.md index 33522b18d0..6ea4f48cc5 100644 --- a/skype/skype-ps/skype/Grant-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Grant-CsLocationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsLocationPolicy @@ -183,7 +188,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -211,4 +216,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Test-CsLocationPolicy](Test-CsLocationPolicy.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md b/skype/skype-ps/skype/Grant-CsMobilityPolicy.md index 53fe82bb32..a6b4002ac5 100644 --- a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Grant-CsMobilityPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/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 +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsMobilityPolicy @@ -10,7 +15,7 @@ schema: 2.0.0 ## SYNOPSIS Grants a per-user mobility policy to a user or group of users. -Mobility policies determine whether or not a user can use a mobile device (such as a cell phone) to connect to Skype for Business Server. +Mobility policies determine whether or not a user can use a mobile device (such as a cell phone) to connect to Microsoft Teams or Skype for Business Server. These policies also manage a user's ability to employ Call via Work, a feature that enables users to make and receive phone calls on their mobile phone by using their work phone number instead of their mobile phone number. Mobility policies can also be used to require Wi-Fi connections when making or receiving calls. This cmdlet was introduced in the cumulative update for Lync Server 2010: November 2011. @@ -25,19 +30,19 @@ Grant-CsMobilityPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainControlle ## DESCRIPTION -Skype for Business Mobile is a client application that enables users to run Skype for Business Server on their mobile phones. +Microsoft Teams Mobile or Skype for Business Mobile is a client application that enables users to run Microsoft Teams or Skype for Business Server on their mobile phones. Call via Work provides a way for users to make calls on their mobile phone and yet have it appear as though the call originated from their work phone number instead of their mobile phone number. Users who have been enabled for Call via Work can achieve this either by dialing directly from their mobile phone or by using the dial-out conferencing option. 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 Skype for Business Server, mobile devices can make or receive phone calls by using either the standard cellular phone network. +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. Mobility policies can be used to require Wi-Fi connections and to prevent calls over the cellular network. -When you install Skype for Business Server, you will have a single, global mobility policy that applies to all your users. +When you install Microsoft Teams or Skype for Business Server, you will have a single, global mobility policy that applies to all your users. However, administrators can use the New-CsMobilityPolicy cmdlet to create custom policies at either the site or the per-user scope. If you create a new policy at the site scope that policy will automatically be assigned to the appropriate site. @@ -114,7 +119,7 @@ For example, the Identity "* Smith" will assign the policy to all the users who 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: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -130,7 +135,7 @@ Prompts you for confirmation before executing the command. 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 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -147,7 +152,7 @@ If this parameter is not specified then the Grant-CsMobilityPolicy cmdlet will c Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -164,7 +169,7 @@ By default, the Grant-CsMobilityPolicy cmdlet does not pass objects through the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -189,7 +194,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -205,7 +210,7 @@ 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 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -221,23 +226,6 @@ Accept wildcard characters: False 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 -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -247,7 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -276,5 +264,3 @@ However, if you include the PassThru parameter, the cmdlet will be able to pipel ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsOUPermission.md b/skype/skype-ps/skype/Grant-CsOUPermission.md index 42f75c210e..222046671f 100644 --- a/skype/skype-ps/skype/Grant-CsOUPermission.md +++ b/skype/skype-ps/skype/Grant-CsOUPermission.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsOUPermission @@ -261,7 +266,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -281,5 +286,3 @@ The Grant-CsOUPermission cmdlet does not return any objects or values. [Revoke-CsOUPermission](Revoke-CsOUPermission.md) [Test-CsOUPermission](Test-CsOUPermission.md) - - diff --git a/skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md b/skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md deleted file mode 100644 index 9f2dbf8051..0000000000 --- a/skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Grant-CsOnlineVoiceRoutingPolicy - -## SYNOPSIS -Assigns a per-user online voice routing policy to one or more users. Online voice routing policies manage online PSTN usages for Phone System users. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsOnlineVoiceRoutingPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GrantToTenant -``` -Grant-CsOnlineVoiceRoutingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Skype for Business Online users an online voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks. - -Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Skype for Business Online or Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Grant-CsOnlineVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName "RedmondOnlineVoiceRoutingPolicy" -``` - -The command shown in Example 1 assigns the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy to the user with the display name "Ken Myer". - -### -------------------------- Example 2 -------------------------- -``` -PS C:\> Grant-CsOnlineVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName $Null -``` - -In Example 2, any per-user online voice routing policy previously assigned to the user Ken Myer is unassigned from that user; as a result, Ken Myer will be managed by the global online voice routing policy. To unassign a per-user policy, set the PolicyName to a null value ($Null). - -### -------------------------- Example 3 -------------------------- -``` -PS C:\> Get-CsOnlineUser | Grant-CsOnlineVoiceRoutingPolicy -PolicyName "RedmondOnlineVoiceRoutingPolicy" -``` - -Example 3 assigns the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy to all the users in the tenant. To do this, the command first calls the `Get-CsOnlineUser` cmdlet to get all users accounts enabled for Skype for Business Online. Those user accounts are then piped to the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet, which assigns each user the online voice routing policy RedmondOnlineVoiceRoutingPolicy. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your 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 -``` - -### -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). - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -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: (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: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: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) - -[Get-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) - -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) - -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md b/skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md deleted file mode 100644 index 77df9270ea..0000000000 --- a/skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsOnlineVoicemailPolicy -schema: 2.0.0 ---- - -# Grant-CsOnlineVoicemailPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Grant-CsOnlineVoicemailPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- (Skype for Business Online) -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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 - -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md index 4d0f822f3e..2802ff6d76 100644 --- a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsPersistentChatPolicy @@ -98,7 +103,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam Type: UserIdParameter 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 Required: True Position: 1 @@ -114,7 +119,7 @@ Prompts you for confirmation before executing the command. 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 @@ -134,7 +139,7 @@ If this parameter is not specified then the Grant-CsPersistentChatPolicy cmdlet 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 Required: False Position: Named @@ -151,7 +156,7 @@ By default, the Grant-CsPersistentChatPolicy cmdlet does not pass objects throug 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 Required: False Position: Named @@ -170,7 +175,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName 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 Required: False Position: 2 @@ -186,7 +191,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -196,7 +201,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -222,4 +227,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsPinPolicy.md b/skype/skype-ps/skype/Grant-CsPinPolicy.md index 8516b9dea0..7abc34da1c 100644 --- a/skype/skype-ps/skype/Grant-CsPinPolicy.md +++ b/skype/skype-ps/skype/Grant-CsPinPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsPinPolicy @@ -192,7 +197,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -218,5 +223,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsPinPolicy](Remove-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsPresencePolicy.md b/skype/skype-ps/skype/Grant-CsPresencePolicy.md index 0ccbd5989e..0b4f666350 100644 --- a/skype/skype-ps/skype/Grant-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Grant-CsPresencePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsPresencePolicy @@ -209,7 +214,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -235,4 +240,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsSetupPermission.md b/skype/skype-ps/skype/Grant-CsSetupPermission.md index b0fb48b59e..7884f28095 100644 --- a/skype/skype-ps/skype/Grant-CsSetupPermission.md +++ b/skype/skype-ps/skype/Grant-CsSetupPermission.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsSetupPermission @@ -209,7 +214,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -231,5 +236,3 @@ The Grant-CsSetupPermission cmdlet does not return any objects or values. [Revoke-CsSetupPermission](Revoke-CsSetupPermission.md) [Test-CsSetupPermission](Test-CsSetupPermission.md) - - diff --git a/skype/skype-ps/skype/Grant-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsCallingPolicy.md deleted file mode 100644 index 640685cbe5..0000000000 --- a/skype/skype-ps/skype/Grant-CsTeamsCallingPolicy.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online -title: Grant-CsTeamsCallingPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsCallingPolicy - -## SYNOPSIS - -Cmdlet to assign a specific Teams Calling Policy to a user. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsCallingPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GrantToTenant -``` -Grant-CsTeamsCallingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Teams Calling Policies designate which users are able to use calling functionality within teams and determine the interopability state with Skype for Business. This cmdlet allows admins to grant user level policies to individual users. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsCallingPolicy -identity "Ken Myer" -PolicyName SalesCallingPolicy -``` - -Assigns the TeamsCallingPolicy called "SalesCallingPolicy" to the user "Ken Myer" - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Internal Microsoft use - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Internal Microsoft use - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The user object to whom the policy is being assigned. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The name of the 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: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsInteropPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsInteropPolicy.md deleted file mode 100644 index 64e7271d6d..0000000000 --- a/skype/skype-ps/skype/Grant-CsTeamsInteropPolicy.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Grant-CsTeamsInteropPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsInteropPolicy - -## SYNOPSIS - -IMPORTANT: TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. See description for more information. You can also find more guidance here: https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype - -This cmdlet previously determined how calls are routed between Skype for Business and Microsoft Teams. It is no longer honored, except if TeamsUpgradePolicy mode=Legacy. However, Legacy mode has been deprecated and customers should update their configurations to use a mode other than Legacy. - - -## SYNTAX - -``` -Grant-CsTeamsInteropPolicy [-PassThru] [-Confirm] [[-PolicyName] <Object>] [[-Identity] <Object>] - [-Tenant <Object>] [-DomainController <Object>] [-WhatIf] [-AsJob] -``` - -## DESCRIPTION - -IMPORTANT: TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. It is no longer honored by the system, except if TeamsUpgradePolicy has mode=Lgeacy. Legacy mode is being deprecated. Customers that are still using Legacy mode should update their configurations to use a mode other than Legacy. Granting mode=Legacy is now blocked by default, although admins can override this using -Force for the time being. Eventually, the -Force switch will be removed and granting mode=Legacy will not be possible. - -Any customers still using Legacy mode must ensure the following: - - The global policy must have CallingDefaultClient=ChatDefaultClient, and AllowEndUserClientOverride must be false. If you customized the built-in global policy, undo this by running `Remove-CsTeamsInteropPolicy`. This will remove the tenant-specific global policy and revert back to the system-wide built-in policy (which cannot be removed). Use the following syntax: - -Remove-CsTeamsInteropPolicy -Identity Global - - - If TeamsInteropPolicy is explicitly assigned to any users, one of these three built-in instances for which CallingDefaultClient = ChatDefaultClient, and for which AllowEndUserClientOverride = false. The other instances are no longer valid configurations, are not supported, and will soon be removed from the system. The valid instances are: - - -**Identity: DisallowOverrideCallingDefaultChatDefault** -**AllowEndUserClientOverride: False** -**CallingDefaultClient: Default** -**ChatDefaultClient: Default** - -**Identity: DisallowOverrideCallingSfbChatSfb** -**AllowEndUserClientOverride: False** -**CallingDefaultClient: Sfb** -**ChatDefaultClient: Sfb** - -**Identity: DisallowOverrideCallingTeamsChatTeams** -**AllowEndUserClientOverride: False** -**CallingDefaultClient: Teams** -**ChatDefaultClient: Teams** - - -Use the following cmdlet syntax, where $policy is one of the above values of identity: -`Grant-CsTeamsInteropPolicy -PolicyName $policy -Identity $SipAddress` - - -For comprehensive documentation on this policy and its settings, see [Microsoft Teams and Skype for Business Interoperability](https://docs.microsoft.com/MicrosoftTeams/teams-and-skypeforbusiness-interoperability). - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Grant-CsTeamsInteropPolicy -PolicyName DisallowOverrideCallingDefaultChatDefault -Identity user@contoso.com -``` - -**Default Policy** - -By default, Microsoft Teams is configured to ensure that existing Skype for Business and Microsoft Teams calling workloads remain distinct and separate. -This is a safe configuration for organizations just beginning to experiment with Teams Calling. - -### -------------------------- Example 2 -------------------------- -``` -Grant-CsTeamsInteropPolicy -PolicyName DisallowOverrideCallingTeamsChatTeams -Identity user@contoso.com -``` - -**Policy to enable all inbound calls and chats to be routed to Microsoft Teams (assumed Mode=Legacy)** - -Users who have calling plans and would like to receive their calls in Microsoft Teams can have their calls routed to Teams. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 -{{Fill DomainController Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -For this cmdlet, the full UserPrincipleName/SIP address is required. If you don't provide the full UPN/SIP and instead provide an Alias, the cmdlet can throw an "Object reference not set to an instance of an object" error. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```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 -``` - -### -PolicyName -{{Fill PolicyName Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -{{Fill Tenant Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES -This policy has been deprecated. Customters should use TeamsUpgradePolicy to control interop and routing. - -## RELATED LINKS - -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/microsoftteams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md deleted file mode 100644 index 4cbd86d356..0000000000 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Grant-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 ---- - - -# Grant-CsTeamsMeetingBroadcastPolicy - -## SYNOPSIS -Grant-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \<UserIdParameter\>\] \[-PolicyName\] \<string\> \[-Tenant \<guid\>\] \[-DomainController \<Fqdn\>\] \[-PassThru\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] - -Grant-CsTeamsMeetingBroadcastPolicy \[-PolicyName\] \<string\> \[-Tenant \<guid\>\] \[-DomainController \<Fqdn\>\] \[-PassThru\] \[-Global\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsMeetingBroadcastPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> - [-Tenant <Guid>] [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GrantToTenant -``` -Grant-CsTeamsMeetingBroadcastPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## 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. - -## 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 -``` - -### -DomainController -Not applicable to online service. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the user account the policy should be assigned to. 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: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md deleted file mode 100644 index a1d3f622c5..0000000000 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsTeamsMeetingPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsMeetingPolicy - -## SYNOPSIS -Assigns a teams meeting policy at the per-user scope. The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users - - -## SYNTAX - -``` -Grant-CsTeamsMeetingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Assigns a teams meeting policy at the per-user scope. The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsMeetingPolicy -identity "Ken Myer" -PolicyName StudentMeetingPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the StudentMeetingPolicy - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 - -```yaml -Type: Fqdn -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 -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: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -```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 -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md deleted file mode 100644 index 196ecc70ef..0000000000 --- a/skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsTeamsMessagingPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsMessagingPolicy - -## SYNOPSIS -Assigns a teams messaging policy at the per-user scope. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. - - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsMessagingPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GrantToTenant -``` -Grant-CsTeamsMessagingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Granular control over which messaging features your users can or cannot use is an important feature for many organizations. This cmdlet lets you assign 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. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsMessagingPolicy -identity "Ken Myer" -PolicyName StudentMessagingPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the StudentMessagingPolicy - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index 20453c057e..49be661490 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -1,93 +1,179 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online, Skype for Business Server 2019 +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 +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsTeamsUpgradePolicy ## SYNOPSIS -TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. IMPORTANT: TeamsUpgradePolicy has replaced TeamsInteropPolicy. However, aspects of TeamsUpgradePolicy are still in preview mode as described below. +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. ## SYNTAX +### Identity (Default) ``` -Grant-CsTeamsUpgradePolicy [[-Identity] <UserIdParameter>] [-PolicyName] <string> [-Tenant <guid>] [-Confirm] [<CommonParameters>] +Grant-CsTeamsUpgradePolicy [[-Identity] <String>] [-MigrateMeetingsToTeams <Boolean>] [-PassThru] + [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams <Boolean>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Force] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams <Boolean>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] ``` ## 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 client behavior for their end user using the concept of coexistence "mode", which defines in which client chats and calls land. In the future, mode will also be used to define Teams client behavior in terms of what functionality will be available. In addition, 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. TeamsUpgradePolicy can be granted either on a per user basis or on a tenant-wide basis. +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs what functionality is available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. + +This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. + +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). +Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: -IMPORTANT: TeamsUpgradePolicy has replaced TeamsInteropPolicy. Components that previously honored TeamsInteropPolicy have been fully updated to honor TeamsUpgradePolicy instead. TeamsInteropPolicy is not honored, except if TeamsUpgradePolicy mode=Legacy. However, Legacy mode is being deprecated. +|Identity|Mode|NotifySfbUsers|Comments| +|---|---|---|---| +|Islands|Islands|False|Default configuration. Allows a single user to evaluate both clients side by side. Chats and calls can land in either client, so users must always run both clients.| +|IslandsWithNotify|Islands|True|Same as Islands and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBOnly|SfBOnly|False|Calling, chat functionality and meeting scheduling in the Teams app are disabled.| +|SfBOnlyWithNotify|SfBOnly|True|Same as SfBOnly and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBWithTeamsCollab|SfBWithTeamsCollab|False|Calling, chat functionality and meeting scheduling in the Teams app are disabled.| +|SfBWithTeamsCollabWithNotify|SfBWithTeamsCollab|True|Same as SfBWithTeamsCollab and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBWithTeamsCollabAndMeetings|SfBWithTeamsCollabAndMeetings|False|Calling and chat functionality in the Teams app are disabled.| +|SfBWithTeamsCollabAndMeetingsWithNotify|SfBWithTeamsCollabAndMeetings|True|Same as SfBWithTeamsCollabAndMeetings and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|UpgradeToTeams|TeamsOnly|False|Use this mode to upgrade users to Teams and to prevent chat, calling, and meeting scheduling in Skype for Business.| +|Global|Islands|False|| -When you use Grant-CsTeamsUpgradePolicy you should NOT use Grant-CsTeamsInteropPolicy except if you choose mode=Legacy. Additionally, do not grant both policies at the same time. Instead grant one policy and then wait 30 minutes before granting the next policy. +>[!IMPORTANT] +>TeamsUpgradePolicy can be assigned to any Teams user, whether that user have an on-premises account in Skype for Business Server or not. However, **TeamsOnly mode can only be assigned to a user who is already homed in Skype for Business Online**. This is because interop with Skype for Business users and federation as well as Microsoft 365 Phone System functionality are only possible if the user is homed in Skype for Business Online. In addition, you cannot assign TeamsOnly mode as the tenant-wide default if you have any Skype for Business on-premises deployment (which is detected by presence of a lyncdiscover DNS record that points to a location other than Office 365. To make these users TeamsOnly you must first move these users individually to the cloud using `Move-CsUser`. Once all users have been moved to the cloud, you can [disable hybrid to complete migration to the cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid) and then apply TeamsOnly mode at the tenant level to ensure future users are TeamsOnly by default. +> [!NOTE] +> - TeamsUpgradePolicy is available in both Office 365 and in on-premises versions of Skype for Business Server, but there are differences: +> +> - In Office 365, admins can specify both coexistence mode and whether to trigger notifications of pending upgrade. +> +> - In on-premises with Skype for Business Server, the only available option is to trigger notifications. Skype for Business Server 2015 with CU8 or Skype for Business Server 2019 are required. +> +> - TeamsUpgradePolicy in Office 365 can be granted to users homed on-premises in hybrid deployments of Skype for Business as follows: +> +> - Coexistence mode is honored by users homed on-premises, however on-premises users cannot be granted the UpgradeToTeams instance (mode=TeamsOnly) of TeamsUpgradePolicy. To be upgraded to TeamsOnly mode, users must be either homed in Skype for Business Online or have no Skype account anywhere. +> +> - The NotifySfBUsers setting of Office 365 TeamsUpgradePolicy is not honored by users homed on-premises. Instead, the on-premises version of TeamsUpgradePolicy must be used. +> +> - In Office 365, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet available. In contrast, Skype for Business Server does not contain built-in instances, so the New cmdlet is available on-premises. Only NotifySfBUsers property is available in on-premises. +> +> - When granting a user a policy with mode=TeamsOnly or mode=SfBWithTeamsCollabAndMeetings, by default, meetings organized by that user will be migrated to Teams. For details, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). -Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. -</br> -</br> -|Identity|Mode|NotifySfbUsers|Action|Comments| -|---|---|---|---|---| -|Islands|Islands|False|None|| -|IslandsWithNotify|Islands|True|Notify|| -|SfBOnly|SfBOnly|False|None|For now, this mode is effectively the same as setting preferred client=SfB. We expect in the future this will restrict Teams functionality.| -|SfBOnlyWithNotify|SfBOnly|True|Notify|For now, this mode is effectively the same as setting preferred client=SfB. We expect in the future this will restrict Teams functionality.| -|SfBWithTeamsCollab|SfBWithTeamsCollab|False|None|This mode exists at the PowerShell layer but is not yet exposed in the admin user experience. From a routing perspective, this is the same as SfBOnly mode. When TeamsAppPolicy is available, this will only allow Channels in Teams app.| -|SfBWithTeamsCollabWithNotify|SfBWithTeamsCollab|True|Notify|This mode exists at the PowerShell layer but is not yet exposed in the admin user experience. From a routing perspective, this is the same as SfBOnly mode. When TeamsAppPolicy is available, this will only allow Channels in Teams app.| -|UpgradeToTeams|TeamsOnly|False|Upgrade|Use this mode to upgrade users to Teams and to prevent chat, calling, and meeting scheduling in Skype for Business.| -|Global|Legacy|False|None|The mode will soon be updated to Islands.| -|NoUpgrade|Legacy|False|None|This instance will soon be retired.| -|NotifyForTeams|Legacy|True|Notify|This instance will soon be retired.| -|||||| +When users are in any of the Skype for Business modes (SfBOnly, SfBWithTeamsCollab, SfBWithTeamsCollabAndMeetings), calling and chat functionality in the Teams app are disabled (but chat in the context of a Teams meeting is still allowed). Similarly, when users are in the SfBOnly or SfBWithTeamsCollab modes, meeting scheduling is disabled. For more details, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). +The `Grant-CsTeamsUpgradePolicy` cmdlet checks the configuration of the corresponding settings in TeamsMessagingPolicy, TeamsCallingPolicy, and TeamsMeetingPolicy to determine if those settings would be superceded by TeamsUpgradePolicy and if so, an informational message is provided in PowerShell. It is not necessary to set these other policy settings. This is for informational purposes only. Below is an example of what the PowerShell warning looks like: -NOTES: -- 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 availble option is to trigger notifications. -- 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. Users must be either homed in Skype for Business Online or have no Skype account anywhere to be upgraded to TeamsOnly mode. - - The NotifySfBUsers setting of Office 365 TeamsUpgradePolicy is not honored by users homed on-premises. Instead, the on-premise 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 avaiable. 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. -- Instances with mode set to SfBWithTeamsCollab are not yet functional. From a routing perspective, this will behave like SfBOnly mode. -- The Action property is redundnant with the combination of NotifySfBUsers and Mode. It will eventually be removed. +`Grant-CsTeamsUpgradePolicy -Identity user1@contoso.com -PolicyName SfBWithTeamsCollab` +`WARNING: The user 'user1@contoso.com' currently has enabled values for: AllowUserChat, AllowPrivateCalling, AllowPrivateMeetingScheduling, AllowChannelMeetingScheduling, however these values will be ignored. This is because you are granting this user TeamsUpgradePolicy with mode=SfBWithTeamsCollab, which causes the Teams client to behave as if they are disabled.` + +> [!NOTE] +> These warning messages are not affected by the -WarningAction parameter. ## EXAMPLES ### Example 1: Grant Policy to an individual user -``` + +```powershell PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName UpgradeToTeams -Identity mike@contoso.com ``` -The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. This effectively upgrades the user to Teams only mode. This command will only succeed if the user does not have 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 -### Example 2: Grant Policy to the entire tenant +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName $null -Identity mike@contoso.com ``` -PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly + +The above cmdlet removes any policy changes made to user Mike@contoso.com and effectively Inherits the global tenant setting for teams Upgrade. + +### Example 3: Grant Policy to the entire tenant + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly -Global ``` -To grant a policy to all users in the org (except any that have an explicit policy assinged), omit the identity parameter. +To grant a policy to all users in the org (except any that have an explicit policy assigned), omit the identity parameter. If you do not specify the -Global parameter, you will be prompted to confirm the operation. -## PARAMETERS +### Example 4 Get a report on existing TeamsUpgradePolicy users (Screen Report) + +You can get the output on the screen, on CSV or Html format. For Screen Report + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +``` + +### Example 5 Get a report on existing TeamsUpgradePolicy users (CSV Report) + +```powershell +$objUsers = Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +$objusers | ConvertTo-Csv -NoTypeInformation | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.csv" +``` + +This will create a CSV file on the Desktop of the current user with the name "TeamsUpgrade.csv" + +### Example 6 Get a report on existing TeamsUpgradePolicy users (HTML Report) + +```powershell +$objUsers = Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +$objusers | ConvertTo-Html | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.html" + +``` + +After running these lines will create an HTML file on the Desktop of the current user with the name "TeamUpgrade.html" + +### Example 7 Get a report on existing TeamsUpgradePolicy users (CSV Report - Oneliner version) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* | ConvertTo-Csv -NoTypeInformation | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.csv" +``` +This will create a CSV file on the Desktop of the current user with the name "TeamsUpgrade.csv" + +### Example 8 Get a report on existing TeamsUpgradePolicy users (HTML Report - Oneliner Version) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* | ConvertTo-Html | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.html" +``` + +After running these lines will create an HTML file on the Desktop of the current user with the name "TeamUpgrade.html" + +## PARAMETERS ### -Identity -{{Fill Identity Description}} + +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml Type: UserIdParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: 0 @@ -97,13 +183,31 @@ Accept wildcard characters: False ``` ### -PolicyName -{{Fill PolicyName Description}} + +The name of the policy instance. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online Required: False Position: 1 @@ -113,13 +217,14 @@ 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, Skype for Business Server 2019 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: Named @@ -128,15 +233,79 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -Tenant -{{Fill Tenant Description}} + +Do not use. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +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: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -145,31 +314,57 @@ 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 +``` ## INPUTS ### Microsoft.Rtc.Management.AD.UserIdParameter - ## OUTPUTS ### System.Object -## NOTES -It is *no longer required* to coordinate granting of TeamsUpgradePolicy and TeamsInteropPolicy. TeamsInteropPolicy is no longer honored and should not be used. +## RELATED LINKS +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) -## RELATED LINKS +[Coexistence with Skype for Business](https://learn.microsoft.com/microsoftteams/coexistence-chat-calls-presence) [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) - -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md deleted file mode 100644 index e84c03d182..0000000000 --- a/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online -title: Grant-CsTeamsVideoInteropServicePolicy -schema: 2.0.0 ---- - -# 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. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsVideoInteropServicePolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> - [-Tenant <System.Guid>] [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GrantToTenant -``` -Grant-CsTeamsVideoInteropServicePolicy [-PolicyName] <String> [-Tenant <System.Guid>] - [-DomainController <Fqdn>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## 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 policies for use in your organization or assign the policy to specific users. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsVideoInteropServicePolicy -PolicyName ServiceProviderDisabled -``` - -In this example, Cloud Video Interop has been disabled for the entire tenant, except for those users that have an explicit policy assigned to them. - -### Example 2 -```powershell -PS C:\> Grant-CsTeamsVideoInteropServicePolicy -PolicyName ServiceProviderDisabled -Identity bob@contoso.com -``` - -In this example, Cloud Video Interop has been disabled only for one user - Bob - but the default tenant policy has been left on for all other users who do not have an explicit assignment. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Internal Microsoft use only. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Use this flag to override the warning when assigning the global policy for your tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -{{Fill Identity Description}} - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsVideoInteropServicePolicy 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 -Specify the pre-constructed policy that you would like to assign to your tenant or a particular user. You can get the policies available for your organization using the cmdlet Get-CsTeamsVideoInteropServicePolicy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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 -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTenantDialPlan.md b/skype/skype-ps/skype/Grant-CsTenantDialPlan.md deleted file mode 100644 index 338e054b35..0000000000 --- a/skype/skype-ps/skype/Grant-CsTenantDialPlan.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Grant-CsTenantDialPlan -schema: 2.0.0 ---- - -# Grant-CsTenantDialPlan - -## SYNOPSIS -Use the Grant-DsTenantDialPlan cmdlet to assign an existing tenant dial plan to a user. - -## SYNTAX - -``` -Grant-CsTenantDialPlan [-PolicyName] <String> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Grant-DsTenantDialPlan cmdlet assigns an existing tenant dial plan to a user. -Tenant dial plans provide information that is required for Enterprise Voice users to make telephone calls. -Users who do not have a valid tenant dial plan cannot make calls by using Enterprise Voice. -A tenant dial plan determines such things as how normalization rules are applied, and whether a prefix must be dialed for external calls. - -You can check whether a user has been granted a per-user tenant dial plan by calling a command in this format: `Get-CsOnlineUser "\<user name\>" | Select-Object TenantDialPlan.` -## EXAMPLES - -### -------------------------- Example 1 -------------------------- (Skype for Business Online) -``` -Grant-CsTenantDialPlan -PolicyName Vt1tenantDialPlan9 -Identity (Get-CsOnlineUser Vt1_User1).SipAddress -``` - -This example grants the Vt1tenantDialPlan 9 dial plan to Vt1_User1. - - -## PARAMETERS - -### -Identity -The Identity parameter identifies the user to whom the policy should be assigned. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The PolicyName parameter is the name of the tenant dial plan to assign to the specified user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".` -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md index 087b16fcb3..c5066205d9 100644 --- a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsThirdPartyVideoSystemPolicy @@ -27,7 +32,7 @@ One key management task related to VTC devices is to enable (or disable) the abi By default, VTC devices are allowed to send low-resolution video. However, administrators can create third-party video system policies that disable the use of low-resolution video. This might be useful for devices located in conference rooms or other areas where low-resolution video is not considered acceptable. -The Grant-CsThirdPartyVideoSystem cmdlet provides a way for administrators to assign (or unassign) third-party video system policies created at the per-user scope. +The Grant-CsThirdPartyVideoSystemPolicy cmdlet provides a way for administrators to assign (or unassign) third-party video system policies created at the per-user scope. Note that this cmdlet can only be used to assign per-user policies; that's because policies at the global or the site scope do not need to be assigned. If you want a VTC device to be managed by the global policy or (if available) the device site policy, simply unassign any per-user policy previously assigned to the device. @@ -48,7 +53,7 @@ This device is then piped to the Grant-CsThirdPartyVideoSystemPolicy cmdlet, whi ### -------------------------- Example 2 -------------------------- ``` -Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video Contact"} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName $Null +Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video Device"} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName $Null ``` The command shown in Example 2 is effectively the inverse of the command shown in Example 1: in this case, any per-user policy previously assigned to Redmond Video Device is removed. @@ -174,7 +179,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -200,4 +205,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md b/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md index 420a319013..cbb4c917da 100644 --- a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsUserServicesPolicy @@ -185,7 +190,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -211,4 +216,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsVoicePolicy.md b/skype/skype-ps/skype/Grant-CsVoicePolicy.md index 13b43af37d..f553602f84 100644 --- a/skype/skype-ps/skype/Grant-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Grant-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-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 +ms.author: hirshah +ms.reviewer: --- # Grant-CsVoicePolicy @@ -28,18 +33,19 @@ Grant-CsVoicePolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainController < [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] ``` + ## DESCRIPTION This cmdlet assigns an existing per-user voice policy to a user. Voice policies are used to manage such Enterprise Voice-related features as simultaneous ringing (the ability to have a second phone ring each time someone calls your office phone) and call forwarding. Use this cmdlet to assign the settings that enable and disable these features for a specific user. -You can check whether a user has been granted a per-user voice policy by calling a command in this format: `Get-CsUser "\<user name\>" | Select-Object VoicePolicy.` +You can check whether a user has been granted a per-user voice policy by calling a command in this format: `Get-CsUser "<user name>" | Select-Object VoicePolicy.` For example: `Get-CsUser "Ken Myer" | Select-Object VoicePolicy` - + NOTE - For accounts hosted in Skype for Business Online, it is not possible to grant a voice policy via PowerShell. In this scenario, the voice policy is automatically granted based on user licensing. ## EXAMPLES @@ -69,7 +75,7 @@ The Identity (unique identifier) of the user to whom the policy is being assigne 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). -Note that you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +Note that you can use the asterisk (\*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" would return all the users with the last name Smith. Full Data Type: Microsoft.Rtc.Management.AD.UserIdParameter @@ -78,7 +84,7 @@ Full Data Type: Microsoft.Rtc.Management.AD.UserIdParameter 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 Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -96,7 +102,7 @@ Per-user policy identities include a prefix of tag: that should not be included 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -113,7 +119,7 @@ If no domain controller is specified, the first available will be used. 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,7 +136,7 @@ By default, this cmdlet does not generate any output. 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -146,7 +152,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -162,7 +168,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -181,10 +187,6 @@ You can return your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - ```yaml Type: Guid Parameter Sets: (All) @@ -198,28 +200,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -247,6 +229,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Test-CsVoicePolicy](Test-CsVoicePolicy.md) [Get-CsUser](Get-CsUser.md) - -[Get-CsOnlineUser](Get-CsOnlineUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md index 77276cb875..741af07a2c 100644 --- a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/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 +ms.author: tomkau +ms.reviewer: rogupta --- # Grant-CsVoiceRoutingPolicy @@ -11,7 +16,7 @@ schema: 2.0.0 Assigns a per-user voice routing policy to one or more users. Voice routing policies manage PSTN usages for users of hybrid voice. -Hybrid voice enables users homed on Skype for Business Online to take advantage of the Enterprise Voice capabilities available in an on-premises installation of Skype for Business Server. +Hybrid voice enables users homed on Microsoft Teams or Skype for Business Online to take advantage of the Enterprise Voice capabilities available in an on-premises installation of Skype for Business Server. This cmdlet was introduced in Lync Server 2013. @@ -26,7 +31,7 @@ Grant-CsVoiceRoutingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainContr ## DESCRIPTION Voice routing policies are used in "hybrid" scenarios: when some of your users are homed on the on-premises version of Skype for Business Server and other users are homed on Skype for Business Online. -Assigning your Skype for Business Online users a voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks. +Assigning your Skype for Business Online users a voice routing policy enables those users to receive and to place phone calls to the public switched telephone network by using your on-premises SIP trunks. Note that simply assigning a user a voice routing policy will not enable them to make PSTN calls via Skype for Business Online. Among other things, you will also need to enable those users for Enterprise Voice and will need to assign them an appropriate voice policy and dial plan. @@ -71,14 +76,14 @@ User Identities are typically specified using one of four formats: 1) the user's 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". +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: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -94,7 +99,7 @@ Prompts you for confirmation before executing the command. 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 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,7 +116,7 @@ To connect to a particular domain controller, include the DomainController param Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -128,7 +133,7 @@ By default, the Grant-CsVoiceRoutingPolicy cmdlet does not pass objects through Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -148,7 +153,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -158,13 +163,13 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -180,27 +185,6 @@ This parameter is reserved for internal Microsoft use. 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -210,7 +194,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -236,4 +220,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Import-CSAnnouncementFile.md b/skype/skype-ps/skype/Import-CSAnnouncementFile.md index 10d987c367..37882297f1 100644 --- a/skype/skype-ps/skype/Import-CSAnnouncementFile.md +++ b/skype/skype-ps/skype/Import-CSAnnouncementFile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CSAnnouncementFile @@ -12,8 +17,6 @@ schema: 2.0.0 Imports an announcement file to the Announcement service audio library. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ``` @@ -32,24 +35,18 @@ At that point the New-CsUnassignedNumber or Set-CsUnassignedNumber cmdlet can be Imported files must be WAV or WMA files. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- ``` -$a = Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte +$a = [System.IO.File]::ReadAllBytes('.\GreetingFile.wav') Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content $a ``` These commands import an audio file into the Announcement service File Store. -Because audio files must be imported as byte arrays, we first need to call the Get-Content cmdlet to retrieve the audio file as an array of individual bytes. -Get-Content is a Windows PowerShell built-in cmdlet to which we pass the name (including path) of the file we want to use for our announcement. -Next we pass a value of 0 to the ReadCount parameter, meaning we want to read the whole file at once. -We then pass a value of Byte to the Encoding parameter, which tells Get-Content that we want the contents of the file as an array of bytes. -We assign that array to the variable $a. +Because audio files must be imported as byte arrays, we first need to retrieve the audio file as an array of individual bytes. We assign that array to the variable $a. In the second line we call the Import-CsAnnouncementFile cmdlet to actually import the file. We pass the service Identity ApplicationServer:redmond.litwareinc.com to the Parent parameter, then we pass a name to the FileName parameter (WelcomeMessage.wav). @@ -59,23 +56,21 @@ Finally, we pass the variable $a as the value to the Content parameter to read i ### -------------------------- EXAMPLE 2 -------------------------- ``` -Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content (Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte) +Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content ([System.IO.File]::ReadAllBytes('.\GreetingFile.wav')) ``` -Example 2 is identical to Example 1 except that we included the Get-Content command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable. - +Example 2 is identical to Example 1 except that we included the command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable. ### -------------------------- EXAMPLE 3 -------------------------- ``` -Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte | Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" +[System.IO.File]::ReadAllBytes('.\GreetingFile.wav') | Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" ``` Example 3 is yet another variation of Example 1. -The difference in this example is that rather than use the Content parameter, we first call the Get-Content cmdlet, then pipe the results to Import-CsAnnouncementFile. +The difference in this example is that rather than use the Content parameter, we first call the command to read the file, then pipe the results to Import-CsAnnouncementFile. This is the most reliable way of importing an announcement file from a remote session. - ## PARAMETERS ### -Parent @@ -114,6 +109,8 @@ Accept wildcard characters: False ### -Content The contents of the audio file as a byte array. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). + ```yaml Type: Byte[] Parameter Sets: (All) @@ -176,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -194,4 +191,3 @@ This cmdlet does not return a value. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Import-CsCertificate.md b/skype/skype-ps/skype/Import-CsCertificate.md index 555f810877..ba39973617 100644 --- a/skype/skype-ps/skype/Import-CsCertificate.md +++ b/skype/skype-ps/skype/Import-CsCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsCertificate @@ -291,7 +296,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -319,4 +324,3 @@ None. [Request-CsCertificate](Request-CsCertificate.md) [Set-CsCertificate](Set-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md b/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md index ca684d786c..68beb13982 100644 --- a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md +++ b/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsCompanyPhoneNormalizationRules @@ -162,7 +167,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -185,5 +190,3 @@ None [New-CsAddressBookNormalizationConfiguration](New-CsAddressBookNormalizationConfiguration.md) [Get-CsAddressBookNormalizationConfiguration](Get-CsAddressBookNormalizationConfiguration.md) - - diff --git a/skype/skype-ps/skype/Import-CsConfiguration.md b/skype/skype-ps/skype/Import-CsConfiguration.md index 246ef80481..6f8f568b9c 100644 --- a/skype/skype-ps/skype/Import-CsConfiguration.md +++ b/skype/skype-ps/skype/Import-CsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsConfiguration @@ -161,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -180,5 +185,3 @@ The Import-CsConfiguration cmdlet does not return any values or objects. ## RELATED LINKS [Export-CsConfiguration](Export-CsConfiguration.md) - - diff --git a/skype/skype-ps/skype/Import-CsDeviceUpdate.md b/skype/skype-ps/skype/Import-CsDeviceUpdate.md index 9a4efcd426..a5c01e0bfd 100644 --- a/skype/skype-ps/skype/Import-CsDeviceUpdate.md +++ b/skype/skype-ps/skype/Import-CsDeviceUpdate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsDeviceUpdate @@ -166,7 +171,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -184,5 +189,3 @@ The Import-CsDeviceUpdate cmdlet imports instances of the Microsoft.Rtc.Manageme ## RELATED LINKS [Get-CsDeviceUpdateRule](Get-CsDeviceUpdateRule.md) - - diff --git a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md b/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md index 567e8c2ace..aa6269159b 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md +++ b/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsLegacyConferenceDirectory @@ -116,7 +121,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -138,5 +143,3 @@ The Import-CsLegacyConferenceDirectory cmdlet does not return any objects or val [Merge-CsLegacyTopology](Merge-CsLegacyTopology.md) [Move-CsLegacyUser](Move-CsLegacyUser.md) - - diff --git a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md b/skype/skype-ps/skype/Import-CsLegacyConfiguration.md index 01b9ca4cc6..51ac1f67d2 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md +++ b/skype/skype-ps/skype/Import-CsLegacyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsLegacyConfiguration @@ -160,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -182,5 +187,3 @@ The Import-CsLegacyConfiguration cmdlet does not return any objects or values. [Merge-CsLegacyTopology](Merge-CsLegacyTopology.md) [Move-CsLegacyUser](Move-CsLegacyUser.md) - - diff --git a/skype/skype-ps/skype/Import-CsLisConfiguration.md b/skype/skype-ps/skype/Import-CsLisConfiguration.md index ed5df1a920..20298f3573 100644 --- a/skype/skype-ps/skype/Import-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Import-CsLisConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsLisConfiguration @@ -12,8 +17,6 @@ schema: 2.0.0 Imports an Enterprise Voice Enhanced 9-1-1 (E9-1-1) configuration from a backup file. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ### ByteInput @@ -43,11 +46,8 @@ You call the Export-CsLisConfiguration cmdlet to back up your configuration. Later, you modify the Location property of that wireless access point to Building30/Rooms20-40. If you then call the Import-CsLisConfiguration cmdlet to restore the backed-up configuration, the location for that WAP will be Building30/Room10 (the location before the backup), but the location for Building30/Rooms20-40 will remain in the location configuration database. - - ## EXAMPLES - ### -------------------------- EXAMPLE 1 -------------------------- ``` @@ -56,7 +56,6 @@ Import-CsLisConfiguration -FileName C:\E911Config.bak This example imports the E9-1-1 configuration from the backup file named E911Config.back to the location configuration database. - ### -------------------------- EXAMPLE 2 -------------------------- ``` @@ -73,34 +72,25 @@ In line 2 the Import-CsLisConfiguration cmdlet is called. The ByteInput parameter receives a value of $lisconfig, which is the variable containing the byte array we exported. This will import that byte array back into the location configuration database. - - ### -------------------------- EXAMPLE 3 -------------------------- ``` $lisconfig = Export-CsLisConfiguration -AsBytes -$listconfig | Set-Content -Path C:\E911Config.bak -Encoding byte +[System.IO.File]::WriteAllBytes('C:\E911Config.bak', $lisconfig) -Get-Content -ReadCount 0 -Encoding byte -Path C:\E911Config.bak | Import-CsLisConfiguration +[System.IO.File]::ReadAllBytes('C:\E911Config.bak') | Import-CsLisConfiguration ``` Example 3 is a more complete version of Example 2. The first line is the same, we call the Export-CsLisConfiguration cmdlet with the AsBytes parameter to store the LIS configuration as an array of bytes in the variable $lisconfig. The rest of this example shows how to save that configuration to a file and then import it back into the location configuration database. -In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the Windows PowerShell Set-Content cmdlet. -We assign values to two parameters of the Set-Content cmdlet: Path and Encoding. -We assign the full path and file name of the file to which we want to save the configuration to the Path parameter. -We use the Encoding parameter with a value of byte to ensure the configuration is stored as an array of bytes. +In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the full path and file name of the file to which we want to save the configuration. Finally, in line 3 we import the configuration back into the location configuration database. -First we call the Get-Content cmdlet to retrieve the contents from the file. -We pass a value of 0 to the ReadCount property, which tells the Get-Content cmdlet to read all the contents of the file at once rather than one line at a time. -We again use the Encoding parameter with a value of byte to specify what type of data we're reading from the file. -Finally we pass the file name to the Path parameter. -The contents of the file that we read with the Get-Content cmdlet is piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location configuration database. - +First we retrieve the contents from the file. +The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location database. ## PARAMETERS @@ -139,7 +129,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -167,4 +157,3 @@ This cmdlet does not return a value. [Debug-CsLisConfiguration](Debug-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index 0ac1158f00..0000000000 --- a/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Import-CsOrganizationalAutoAttendantHolidays -schema: 2.0.0 ---- - -# Import-CsOrganizationalAutoAttendantHolidays - -## SYNOPSIS -Use Import-CsOrganizationalAutoAttendantHolidays cmdlet to import holiday schedules of an existing Auto Attendant (AA) that were previously exported using the Export-CsOrganizationalAutoAttendantHolidays cmdlet. - -## SYNTAX - -``` -Import-CsOrganizationalAutoAttendantHolidays [-PrimaryUri] <Uri> -Input <byte[]> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Export-CsOrganizationalAutoAttendantHolidays cmdlet and the Import-CsOrganizationalAutoAttendantHolidays cmdlet enable you to export holiday schedules in your auto attendant and then later import that information. This can be extremely useful in a situation where you need to configure same holiday sets in multiple auto attendants. - -The Export-CsOrganizationalAutoAttendantHolidays cmdlet returns the holiday schedule information in serialized form (as a byte array). The caller can then write the bytes to the disk to obtain a CSV file. Similarly, the Import-CsOrganizationalAutoAttendantHolidays cmdlet accepts the holiday schedule information as a byte array, which can be read from the aforementioned CSV file. The first line of the CSV file is considered a header record and is always ignored. - -**NOTE** -- Each line in the CSV file used by Export-CsOrganizationalAutoAttendantHolidays and Import-CsOrganizationalAutoAttendantHolidays cmdlet should be of the following format: - - `HolidayName,StartDateTime1,EndDateTime1,StartDateTime2,EndDateTime2,…,StartDateTime10,EndDateTime10` - - where - - HolidayName is the name of the holiday to be imported. - - StartDateTimeX and EndDateTimeX specify a date/time range for the holiday and are optional. If no date-time ranges are defined, then the holiday is imported without any date/time ranges. They follow the same format as New-CsOnlineDateTimeRange cmdlet. - - EndDateTimeX is optional. If it is not specified, the end bound of the date time range is set to 00:00 of the day after the start date. -- The first line of the CSV file is considered a header record and is always ignored by Import-CsOrganizationalAutoAttendantHolidays cmdlet. -- If the destination auto attendant for the import already contains a call flow or schedule by the same name as one of the holidays being imported, the corresponding CSV record is skipped. -- For holidays that are successfully imported, a default call flow is created which is configured without any greeting and simply disconnects the call on being executed. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") -Import-CsOrganizationalAutoAttendantHolidays -PrimaryUri sip:mainoaa@contoso.com -Input $bytes -``` - -In this example, the Import-CsOrganizationalAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path “C:\Imports\Holidays.csv” to an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -$bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") -Import-CsOrganizationalAutoAttendantHolidays -PrimaryUri sip:mainoaa@contoso.com -Input $bytes | Format-Table -Wrap -AutoSize -``` - -In this example, the Import-CsOrganizationalAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path “C:\Imports\Holidays.csv” to an auto attendant with Primary URI of sip:mainoaa@contoso.com. The result of the import process is formatted as a table. - -## PARAMETERS - -### -PrimaryUri -The Primary URI represents the SIP address of the auto attendant in where the holiday schedule information is to be imported. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Input -The Input parameter specifies the holiday schedule information that is to be imported. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -The String is used as the PrimaryUri input. - - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.HolidayImportResult - - -## NOTES - - -## RELATED LINKS - -[Export-CsOrganizationalAutoAttendantHolidays](Export-CsOrganizationalAutoAttendantHolidays.md) - -[Get-CsOrganizationalAutoAttendantHolidays](Get-CsOrganizationalAutoAttendantHolidays.md) - diff --git a/skype/skype-ps/skype/Import-CsPersistentChatData.md b/skype/skype-ps/skype/Import-CsPersistentChatData.md index 84cecfa12e..a6407326d2 100644 --- a/skype/skype-ps/skype/Import-CsPersistentChatData.md +++ b/skype/skype-ps/skype/Import-CsPersistentChatData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsPersistentChatData @@ -64,7 +69,7 @@ When specified, data is imported as a byte array rather than an XML file. Type: Byte[] Parameter Sets: ByteInput Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -86,7 +91,7 @@ For example, this syntax specifies the database found in the RTC database instan 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 Required: True Position: Named @@ -105,7 +110,7 @@ For example: Type: String Parameter Sets: FileName Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -121,7 +126,7 @@ Prompts you for confirmation before executing the command. 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 @@ -142,7 +147,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. 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 Required: False Position: Named @@ -158,7 +163,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -168,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -184,5 +189,3 @@ None. ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Import-CsRgsAudioFile.md b/skype/skype-ps/skype/Import-CsRgsAudioFile.md index b5eb61dd48..2e14bd423a 100644 --- a/skype/skype-ps/skype/Import-CsRgsAudioFile.md +++ b/skype/skype-ps/skype/Import-CsRgsAudioFile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsRgsAudioFile @@ -12,8 +17,6 @@ schema: 2.0.0 Imports a new audio file for use with the Response Group application. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ``` @@ -32,14 +35,12 @@ Note that you must run Import-CsRgsAudioFile each time you want to use an audio For example, suppose Workflow A uses a given audio file as its custom music on hold file and you now want to use that same audio file as the custom music on hold for Workflow B. Even though the audio file is already used by the Response Group application you will still need to import the file in order to use it with Workflow B. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- ``` -$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content (Get-Content C:\Media\WhileYouWait.wav -Encoding byte -ReadCount 0) +$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) $y = Get-CsRgsWorkflow -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Workflow" @@ -53,16 +54,14 @@ To perform this task, the first command uses Import-CsRgsAudioFile to import the In addition to the Identity parameter (which specifies the service location) the FileName parameter is used to specify the file name of the file being imported. At the same time, the Content parameter is used to import the audio file. -File importing is carried out by calling the Get-Content cmdlet followed by the path to the file being imported. -Get-Content also requires you to set the encoding type to byte and the ReadCount to 0. -(Setting the ReadCount to 0 ensures that the entire file is read in a single operation.) The imported file is then stored in a variable named $x. +File importing is carried out by calling the `[System.IO.File]::ReadAllBytes` command with the path to the file being imported. +The imported file is then stored in a variable named $x. In the second command, Get-CsRgsWorkflow is used to create an object reference ($y) to the workflow Help Desk Workflow. After this object reference has been created, command 3 sets the value of the CustomMusicOnHoldFile property to $x, the variable containing the imported audio file. Finally, the last command in the example uses Set-CsRgsWorkflow to write these changes to the actual workflow Help Desk Workflow. If you do not call Set-CsRgsWorkflow, your modifications will exist only in memory, and will disappear as soon as you close Windows PowerShell or delete the variables $x or $y. - ## PARAMETERS ### -Identity @@ -84,8 +83,8 @@ Accept wildcard characters: False ### -Content Actual content of the audio file being imported. -The Content property is populated by calling the Get-Content cmdlet. -When calling Get-Content, set the Encoding parameter to byte and the ReadCount parameter to 0 (for details, see the Examples section in this topic). + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -166,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -186,5 +185,3 @@ Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Audio [New-CsRgsWorkflow](New-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - - diff --git a/skype/skype-ps/skype/Import-CsRgsConfiguration.md b/skype/skype-ps/skype/Import-CsRgsConfiguration.md index 5cc3d8271a..a18372286a 100644 --- a/skype/skype-ps/skype/Import-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Import-CsRgsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsRgsConfiguration @@ -158,7 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -176,4 +181,3 @@ None. ## RELATED LINKS [Export-CsRgsConfiguration](Export-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Import-CsUserData.md b/skype/skype-ps/skype/Import-CsUserData.md index f11fd9355a..d282e09e95 100644 --- a/skype/skype-ps/skype/Import-CsUserData.md +++ b/skype/skype-ps/skype/Import-CsUserData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Import-CsUserData @@ -35,6 +40,8 @@ Import-CsUserData -FileName <String> -PoolFqdn <Fqdn> [-ConfDirectoryFilter <Str The Import-CsUserData cmdlet is used to import previously-saved user data and/or conference directory data to Skype for Business Server. Note that this data must have been exported by using the Export-CsUserData cmdlet. +To make sure changes happen after this cmdlet, FE services need to be stopped in all FE servers in the pool firstly then be restarted at the same time after executing Import-CsUserdata cmdlet. + Skype for Business Server Control Panel: The functions carried out by the Import-CsUserData cmdlet are not available in the Skype for Business Server Control Panel. @@ -229,7 +236,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -253,5 +260,3 @@ None. [Sync-CsUserData](Sync-CsUserData.md) [Update-CsUserData](Update-CsUserData.md) - - diff --git a/skype/skype-ps/skype/Install-CsAdServerSchema.md b/skype/skype-ps/skype/Install-CsAdServerSchema.md index ea6e0d45c5..9a20d7aaef 100644 --- a/skype/skype-ps/skype/Install-CsAdServerSchema.md +++ b/skype/skype-ps/skype/Install-CsAdServerSchema.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Install-CsAdServerSchema @@ -203,7 +208,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -221,5 +226,3 @@ The Install-CsAdServerSchema cmdlet does not return any values or objects. ## RELATED LINKS [Get-CsAdServerSchema](Get-CsAdServerSchema.md) - - diff --git a/skype/skype-ps/skype/Install-CsDatabase.md b/skype/skype-ps/skype/Install-CsDatabase.md index a4d6c3abf0..cfa2fa1de6 100644 --- a/skype/skype-ps/skype/Install-CsDatabase.md +++ b/skype/skype-ps/skype/Install-CsDatabase.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Install-CsDatabase @@ -60,21 +65,21 @@ The Install-CsDatabase cmdlet provides a way for you to install any of the SQL S When running the Install-CsDatabase cmdlet there are basically three different ways to handle the configuration of the database being installed: Option 1 -- Run the cmdlet without including a parameter that specifies the database paths. -When the Install-CsDatabase cmdlet is run without the DatabasePath or the UseDefaultSqlPath parameter the cmdlet uses a built-on algorithm to choose the storage location for the database logs and data files. +When the Install-CsDatabase cmdlet is run without the DatabasePaths or the UseDefaultSqlPath parameter the cmdlet uses a built-on algorithm to choose the storage location for the database logs and data files. Note that this built-in algorithm works with a stand-alone SQL Server, it will not work with a SQL Server cluster. -To install a database on a SQL Server cluster your command must include either the DatabasePath or the UseDefaultSqlPath parameter +To install a database on a SQL Server cluster your command must include either the DatabasePaths or the UseDefaultSqlPath parameter -Option 2 -- Run the cmdlet along with the DatabasePath parameter. -When the Install-CsDatabase is cmdlet run with the DatabasePath parameter the built-in algorithm is not used to choose the storage location for the database logs and data files. +Option 2 -- Run the cmdlet along with the DatabasePaths parameter. +When the Install-CsDatabase is cmdlet run with the DatabasePaths parameter the built-in algorithm is not used to choose the storage location for the database logs and data files. Instead, administrators can select the location for these logs and data files. To install both data files and SQL Server logs in the same location, simply specify the path to the folder where this data should be stored. For example: -`-DatabasePath C:\SqlData` +`-DatabasePaths C:\SqlData` To store data files in one location and log files in a second location, specify the path to each folder, separating the two locations by using a comma (be careful not to put a blank space before or after the comma): -`-DatabasePath C:\SqlLogs,D:\SqlData` +`-DatabasePaths C:\SqlLogs,D:\SqlData` The log files will always be stored on the first location specified, while data files will be stored in the second location. @@ -614,7 +619,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -632,5 +637,3 @@ The Install-CsDatabase cmdlet does not return any values or objects. ## RELATED LINKS [Uninstall-CsDatabase](Uninstall-CsDatabase.md) - - diff --git a/skype/skype-ps/skype/Install-CsMirrorDatabase.md b/skype/skype-ps/skype/Install-CsMirrorDatabase.md index 0f096e0de1..feb4acc5d3 100644 --- a/skype/skype-ps/skype/Install-CsMirrorDatabase.md +++ b/skype/skype-ps/skype/Install-CsMirrorDatabase.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Install-CsMirrorDatabase @@ -336,7 +341,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -356,4 +361,3 @@ None. [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md b/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md index e31e76fad8..dbb310849d 100644 --- a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md +++ b/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsArchivingDatabasePurge @@ -254,7 +259,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -273,4 +278,3 @@ The Invoke-CsArchivingDatabasePurge cmdlet returns instances of the Microsoft.Rt [New-CsArchivingConfiguration](New-CsArchivingConfiguration.md) [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) - diff --git a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md b/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md index 922c849939..4c9944e54e 100644 --- a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md +++ b/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsBackupServiceSync @@ -73,7 +78,9 @@ ConfServices.DataConf CentralMgmt.CMSMaster +ApplicationServer.RGSDataStore +ApplicationServer.RGSFileStore ```yaml Type: String @@ -105,7 +112,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -123,4 +130,3 @@ None. ## RELATED LINKS [Backup-CsPool](Backup-CsPool.md) - diff --git a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md b/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md index 119a7a1a51..1aff964a92 100644 --- a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md +++ b/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsCdrDatabasePurge @@ -244,7 +249,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -264,4 +269,3 @@ The Invoke-CsCdrDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Mana [New-CsCdrConfiguration](New-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md b/skype/skype-ps/skype/Invoke-CsComputerFailBack.md index 1f6c40d11a..2700d5b25c 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md +++ b/skype/skype-ps/skype/Invoke-CsComputerFailBack.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsComputerFailBack @@ -161,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -179,4 +184,3 @@ None. ## RELATED LINKS [Invoke-CsComputerFailOver](Invoke-CsComputerFailOver.md) - diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md b/skype/skype-ps/skype/Invoke-CsComputerFailOver.md index 0107136a77..723b08653b 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md +++ b/skype/skype-ps/skype/Invoke-CsComputerFailOver.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsComputerFailOver @@ -31,13 +36,19 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ### -------------------------- 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 ``` 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) +``` +$TimeSpan = New-TimeSpan -Minutes 30 +Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -DrainingTimeout $TimeSpan +``` + +This example force to drain all conferences and sessions after 30 minutes. If users aren't moved to different front end after 30 minutes, it will drain all conferences and sessions and stop all services in the front end. ## PARAMETERS @@ -78,6 +89,8 @@ Accept wildcard characters: False ### -Force 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. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -162,7 +175,7 @@ Accept wildcard characters: False ``` ### -DrainingTimeout -Draining timeout in minutes to gracefully drain MCUs. +Draining timeout in TimeSpan format to gracefully drain MCUs. ```yaml Type: TimeSpan @@ -178,7 +191,7 @@ Accept wildcard characters: False ``` ### -SkipFabricHealthCheck -{{Fill SkipFabricHealthCheck Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter @@ -194,7 +207,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -212,4 +225,3 @@ None. ## RELATED LINKS [Invoke-CsComputerFailBack](Invoke-CsComputerFailBack.md) - diff --git a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md b/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md index 5a93b590fe..95e2fcf516 100644 --- a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md +++ b/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsDatabaseFailover @@ -251,7 +256,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -271,4 +276,3 @@ None. [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md b/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md index 6c1cb11824..342f852532 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md +++ b/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsManagementServerFailover @@ -227,7 +232,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -245,4 +250,3 @@ None. ## RELATED LINKS [Invoke-CsDatabaseFailover](Invoke-CsDatabaseFailover.md) - diff --git a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md b/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md index 317a5dec40..c002ae71c5 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md +++ b/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsManagementStoreReplication @@ -102,7 +107,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -120,5 +125,3 @@ The Invoke-CsManagementStoreReplication cmdlet does not return any objects. ## RELATED LINKS [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) - - diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md b/skype/skype-ps/skype/Invoke-CsPoolFailBack.md index 6b639d9245..99b453decd 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md +++ b/skype/skype-ps/skype/Invoke-CsPoolFailBack.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsPoolFailBack @@ -199,7 +204,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -217,4 +222,3 @@ None. ## RELATED LINKS [Invoke-CsPoolFailOver](Invoke-CsPoolFailOver.md) - diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md b/skype/skype-ps/skype/Invoke-CsPoolFailOver.md index b84d0c4934..45d8e8e11f 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md +++ b/skype/skype-ps/skype/Invoke-CsPoolFailOver.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsPoolFailOver @@ -107,7 +112,7 @@ When present, indicates that failover is being performed in "disaster mode." If If this parameter is not present that means that the pool is still up and running and that failover occurred by administrator choice; for example, the pool might temporarily be failed over in order to do hardware or software upgrades on the server. -Note: The parameteris required for an Enterprise pool if the backend SQL services are down but the front end servers are still up. +Note: The parameters required for an Enterprise pool if the backend SQL services are down but the front end servers are still up. @@ -241,7 +246,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -259,4 +264,3 @@ None. ## RELATED LINKS [Invoke-CsPoolFailBack](Invoke-CsPoolFailBack.md) - diff --git a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md b/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md index 74e817df99..573235dd3b 100644 --- a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md +++ b/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsQoEDatabasePurge @@ -213,7 +218,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -232,4 +237,3 @@ The Invoke-CsQoEDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Mana [New-CsQoEConfiguration](New-CsQoEConfiguration.md) [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md b/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md new file mode 100644 index 0000000000..a62fee6b1d --- /dev/null +++ b/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md @@ -0,0 +1,84 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# 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. + +## SYNTAX + +``` +Invoke-CsRGSStoreReplicateData -PoolFqdn <Fqdn> [-Force] [<CommonParameters>] +``` + +## 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. +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. + + +## EXAMPLES + +### Example 1 +``` +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. + +## PARAMETERS + +### -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 2019CU1 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolFqdn +Fully qualified domain name of the pool whose data will be replicated. +For example: +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2019CU1 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None. The Invoke-CsRGSStoreReplicateData cmdlet does not accept pipelined data. + +## OUTPUTS + +### None. + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md b/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md index 1ee5c961c1..90e2298abf 100644 --- a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md +++ b/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Invoke-CsStorageServiceFlush @@ -175,7 +180,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -193,4 +198,3 @@ String value. ## RELATED LINKS [Invoke-CsPoolFailOver](Invoke-CsPoolFailOver.md) - diff --git a/skype/skype-ps/skype/Invoke-CsUcsRollback.md b/skype/skype-ps/skype/Invoke-CsUcsRollback.md index 9e4fd88c72..b0d139bbd3 100644 --- a/skype/skype-ps/skype/Invoke-CsUcsRollback.md +++ b/skype/skype-ps/skype/Invoke-CsUcsRollback.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csucsrollback +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsUcsRollback schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Invoke-CsUcsRollback @@ -19,7 +24,7 @@ This cmdlet was introduced in Lync Server 2013. ``` Invoke-CsUcsRollback [-Identity] <UserIdParameter> [-Confirm] [-DomainController <Fqdn>] [-Force] [-PassThru] - [-WhatIf] [-AsJob] [<CommonParameters>] + [-WhatIf] [<CommonParameters>] ``` ## DESCRIPTION @@ -198,24 +203,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -247,4 +236,3 @@ None. [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) [Test-CsUnifiedContactStore](Test-CsUnifiedContactStore.md) - diff --git a/skype/skype-ps/skype/Lock-CsClientPin.md b/skype/skype-ps/skype/Lock-CsClientPin.md index b18e8b96d0..4e7c015374 100644 --- a/skype/skype-ps/skype/Lock-CsClientPin.md +++ b/skype/skype-ps/skype/Lock-CsClientPin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Lock-CsClientPin @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -174,4 +179,3 @@ Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Manage [Set-CsClientPin](Set-CsClientPin.md) [Unlock-CsClientPin](Unlock-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Merge-CsLegacyTopology.md b/skype/skype-ps/skype/Merge-CsLegacyTopology.md index 43fb611480..c472df4e40 100644 --- a/skype/skype-ps/skype/Merge-CsLegacyTopology.md +++ b/skype/skype-ps/skype/Merge-CsLegacyTopology.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Merge-CsLegacyTopology @@ -212,7 +217,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -234,4 +239,3 @@ The Merge-CsLegacyTopology cmdlet does not return any objects or values. [Import-CsLegacyConferenceDirectory](Import-CsLegacyConferenceDirectory.md) [Move-CsLegacyUser](Move-CsLegacyUser.md) - diff --git a/skype/skype-ps/skype/Move-CsAnalogDevice.md b/skype/skype-ps/skype/Move-CsAnalogDevice.md index 6e79096e42..70102968cd 100644 --- a/skype/skype-ps/skype/Move-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Move-CsAnalogDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsAnalogDevice @@ -292,7 +297,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -317,4 +322,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md b/skype/skype-ps/skype/Move-CsApplicationEndpoint.md index 65c4255a9d..1947fce031 100644 --- a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md +++ b/skype/skype-ps/skype/Move-CsApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsApplicationEndpoint @@ -195,7 +200,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -213,4 +218,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M ## RELATED LINKS [Get-CsApplicationEndpoint](Get-CsApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md b/skype/skype-ps/skype/Move-CsCommonAreaPhone.md index a37ff4ff42..55cd8f84f2 100644 --- a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Move-CsCommonAreaPhone.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsCommonAreaPhone @@ -302,7 +307,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -327,4 +332,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Move-CsConferenceDirectory.md b/skype/skype-ps/skype/Move-CsConferenceDirectory.md index e2fdfe9ed1..239a0646db 100644 --- a/skype/skype-ps/skype/Move-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/Move-CsConferenceDirectory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsConferenceDirectory @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -186,4 +191,3 @@ None. [New-CsConferenceDirectory](New-CsConferenceDirectory.md) [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) - diff --git a/skype/skype-ps/skype/Move-CsExUmContact.md b/skype/skype-ps/skype/Move-CsExUmContact.md index ad2fc92c08..fd94b648a5 100644 --- a/skype/skype-ps/skype/Move-CsExUmContact.md +++ b/skype/skype-ps/skype/Move-CsExUmContact.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsExUmContact @@ -275,7 +280,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -299,4 +304,3 @@ When called with the PassThru parameter, returns an object of type Microsoft.Rtc [Set-CsExUmContact](Set-CsExUmContact.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Move-CsLegacyUser.md b/skype/skype-ps/skype/Move-CsLegacyUser.md index f934b86093..9bc5c5ed52 100644 --- a/skype/skype-ps/skype/Move-CsLegacyUser.md +++ b/skype/skype-ps/skype/Move-CsLegacyUser.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsLegacyUser @@ -387,7 +392,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -414,4 +419,3 @@ Instead, the cmdlet moves instances of the Microsoft.Rtc.Management.ADConnect.Sc [Move-CsUser](Move-CsUser.md) [Set-CsUser](Set-CsUser.md) - diff --git a/skype/skype-ps/skype/Move-CsManagementServer.md b/skype/skype-ps/skype/Move-CsManagementServer.md index 9e4a648b14..5e869c100f 100644 --- a/skype/skype-ps/skype/Move-CsManagementServer.md +++ b/skype/skype-ps/skype/Move-CsManagementServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsManagementServer @@ -230,7 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -249,5 +254,3 @@ The Move-CsManagementServer cmdlet does not return any objects. ## RELATED LINKS [Set-CsManagementServer](Set-CsManagementServer.md) - - diff --git a/skype/skype-ps/skype/Move-CsMeetingRoom.md b/skype/skype-ps/skype/Move-CsMeetingRoom.md index c9a2ef7be6..25aefd9c8e 100644 --- a/skype/skype-ps/skype/Move-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Move-CsMeetingRoom.md @@ -1,58 +1,49 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsMeetingRoom ## SYNOPSIS - -Moves a Skype for Business Server meeting room object from one Registrar pool to another. +Moves a Skype for Business Server 2015 meeting room object from one Registrar pool to another, or to Skype for Business Online. A meeting room is a conferencing device designed to address video conferencing and collaboration scenarios in small conference rooms. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX -### (Default) -``` -Move-CsMeetingRoom [-Identity] <UserIdParameter> [-Target] <Fqdn> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool <Fqdn>] [-WhatIf] [<CommonParameters>] -``` - -### Identity +### Identity (Default) ``` -Move-CsMeetingRoom [-Identity] <UserIdParameter> [-Target] <Fqdn> [-Confirm] [-DomainController <Fqdn>] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool <Fqdn>] [-Report <String>] [-WhatIf] - [<CommonParameters>] +Move-CsMeetingRoom [-HostedMigrationOverrideUrl <String>] [-Credential <PSCredential>] [-Target] <Fqdn> + [-Report <String>] [-Force] [-IgnoreBackendStoreException] [-ProxyPool <Fqdn>] [-DomainController <Fqdn>] + [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ### Users ``` -Move-CsMeetingRoom [-Target] <Fqdn> -UserList <String> [-ConcurrentMovesPerFE <Int32>] [-Confirm] - [-DomainController <Fqdn>] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool <Fqdn>] - [-Report <String>] [-WhatIf] [<CommonParameters>] +Move-CsMeetingRoom [-HostedMigrationOverrideUrl <String>] [-Credential <PSCredential>] [-Target] <Fqdn> + -UserList <String> [-Report <String>] [-Force] [-IgnoreBackendStoreException] [-ProxyPool <Fqdn>] + [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION +In Skype for Business Server 2015, meeting rooms are self-contained computer appliances that are installed in conference rooms and supply advanced meeting capabilities such as: -In Skype for Business Server, meeting rooms are self-contained computer appliances that are installed in conference rooms and supply advanced meeting capabilities such as: - -One touch meeting join experience - -Multi-view video gallery +* One touch meeting join experience +* Multi-view video gallery +* Touch-enabled white-boarding on the front of room screen +* Calendar integration to provide access to scheduled meetings +* Content sharing and switching -Touch-enabled white-boarding on the front of room screen - -Calendar integration to provide access to scheduled meetings - -Content sharing and switching - -In order to manage these new endpoint devices you must, among other things, create and enable a Exchange resource mailbox account for the device, then enable that resource account for Skype for Business Server. -Note that, for Skype for Business Server, there are no cmdlets for creating or removing meeting rooms. +In order to manage these new endpoint devices you must, among other things, create and enable an Exchange resource mailbox account for the device, then enable that resource account for Skype for Business Server 2015. +Note that, for Skype for Business Server 2015, there are no cmdlets for creating or removing meeting rooms. Instead, you use the Enable-CsMeetingRoom cmdlet to enable meeting rooms and the Disable-CsMeetingRoom cmdlet to disable meeting rooms. The resource account must already exist in order for you to enable the meeting room, and disabling a meeting room only removes that room from your collection of meeting rooms; it does not delete the resource mailbox account. @@ -64,16 +55,13 @@ Skype for Business Server Control Panel: The functions carried out by the Move-C ### -------------------------- 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 -------------------------- ``` - Get-CsMeetingRoom | Move-CsMeetingRoom -Target "atl-cs-001.litwareinc.com" ``` @@ -81,6 +69,12 @@ 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 -------------------------- +``` +Move-CsMeetingRoom -Identity "Room 15" -HostedMigrationOverrideUrl "https://admin2a.online.lync.com/HostedMigration/hostedmigrationservice.svc" -Target "sipfed.online.lync.com" -Credential $credential +``` + +The command shown in Example 3 moves the meeting room with the display name "Room 15" to Skype for Business Online. ## PARAMETERS @@ -151,12 +145,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -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. -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. +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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. ```yaml Type: SwitchParameter @@ -171,6 +181,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HostedMigrationOverrideUrl +URL for the hosted migration service used when moving a user to Lync Online. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 the move meeting room despite those errors. @@ -205,11 +230,8 @@ Accept wildcard characters: False ``` ### -ProxyPool - This parameter is not used with the on-premises version of Skype for Business Online. - - ```yaml Type: Fqdn Parameter Sets: (All) @@ -255,24 +277,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 - -```yaml -Type: Int32 -Parameter Sets: Users -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 -``` - ### -Report -PARAMVALUE: String +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: String @@ -288,7 +297,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -311,5 +320,3 @@ None. [Get-CsMeetingRoom](Get-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - - diff --git a/skype/skype-ps/skype/Move-CsRgsConfiguration.md b/skype/skype-ps/skype/Move-CsRgsConfiguration.md index 27f19ea5bd..c0b6514042 100644 --- a/skype/skype-ps/skype/Move-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Move-CsRgsConfiguration.md @@ -1,55 +1,54 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsRgsConfiguration ## SYNOPSIS - -Enables you to migrate Response Group configuration settings from Microsoft Office Communications Server 2007 R2 or Microsoft Lync Server 2010 to Skype for Business Server. +Enables you to migrate Response Group configuration settings from legacy version pool to newer version pool. For example, from Microsoft Office Communications Server 2007 R2 or Microsoft Lync Server 2010/2013 to Skype for Business Server 2015. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX - ``` Move-CsRgsConfiguration [-Source] <String> [-Destination] <String> [-Force] [-ResolveNameConflicts] [<CommonParameters>] ``` ## DESCRIPTION - The Response Group application provides a way for you to automatically route phone calls to entities such as a help desk or customer support line. When someone calls a designated phone number, that call can be automatically routed to the appropriate set of Response Group agents. Alternatively, the call might be routed to an interactive voice response (IVR) queue. In that queue, the caller would be asked a series of questions (for example, "Are you calling about an existing order?") and then, based on the answers to those questions, be given the asked-for information or be routed to a Response Group agent. -If you are currently running the Response Group application on Office Communications Server 2007 R2 or on Lync Server 2010, the Move-CsRgsConfiguration cmdlet provides a way for you to migrate this service to Skype for Business Server. +If you are currently running the Response Group application on legacy server, the Move-CsRgsConfiguration cmdlet provides a way for you to migrate this service to newer version server. To migrate the service, you need to call the Move-CsRgsConfiguration cmdlet and specify: 1) the fully qualified domain name (FQDN) for the existing version of the Response Group application (the Source); and, 2) the FQDN for the new Skype for Business Server version of the service (the Destination). -Move-CsRgsConfiguration will then move all the configuration settings, audio files, and contact objects from the existing version (either Office Communications Server 2007 R2 or Lync Server 2010) to Skype for Business Server. -After the service has been migrated, all calls to a Response Group phone number will be handled by Skype for Business Server. +Move-CsRgsConfiguration will then move all the configuration settings, audio files, and contact objects from the existing version (for example, Office Communications Server 2007 R2 or Lync Server 2010) to newer version. +After the service has been migrated, all calls to a Response Group phone number will be handled by the newer server. Calls will no longer be handled by the previous version of the service. -Before you can run Move-CsRgsConfiguration, you must first install the Windows Management Instrumentation (WMI) Backward Compatibility interfaces package; this application is installed by running OCSWMIBC.msi. -The file OCSWMIBC.msi can be found on the installation DVD in the Setup folder. +>[!Note] +> If you are running this service on Office Communications Server 2007 R2 or Lync Server 2010, before you can run Move-CsRgsConfiguration, you must first install the Windows Management Instrumentation (WMI) Backward Compatibility interfaces package; this application is installed by running OCSWMIBC.msi. The file OCSWMIBC.msi can be found on the installation DVD in the Setup folder. -If Office Communications Server 2007 is running Microsoft SQL Server 2005 then, before you attempt to migrate the Response Group application, you must install the Microsoft SQL Server 2005 Native Client on the computer where you will be running the Move-CsRgsConfiguration cmdlet. +>[!Note] +> If Office Communications Server 2007 is running Microsoft SQL Server 2005 then, before you attempt to migrate the Response Group application, you must install the Microsoft SQL Server 2005 Native Client on the computer where you will be running the Move-CsRgsConfiguration cmdlet. If the Native Client is not installed you will receive the error message "Cannot access WMI settings" when you call Move-CsRgsConfiguration. -The Move-CsRgsConfiguration cmdlet is only for migrating from Office Communications Server 2007 R2 or Lync Server 2010 to Skype for Business Server; you cannot use this cmdlet to migrate from one instance of Skype for Business Server to a new instance of Skype for Business Server. +>[!Note] +> The Move-CsRgsConfiguration cmdlet is only for migrating from legacy version to newer version; you cannot use this cmdlet to migrate between the same version (for example, one instance of Skype for Business Server 2015 to a new instance of Skype for Business Server 2015). That type of migration can only be done by using the new Import-CsRgsConfiguration and Export-CsRgsConfiguration cmdlets. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- ``` - Move-CsRgsConfiguration -Source atl-ocsrgs-001.litwareinc.com -Destination redmond-lyncrgs-001.litwareinc.com ``` @@ -59,10 +58,7 @@ The command shown in Example 1 migrates the Response Group application from atl- ## PARAMETERS ### -Destination - -FQDN of the computer where the Skype for Business Server Response Group application is to be hosted (the "copy to" location). - - +FQDN of the computer where the newer server Response Group application is to be hosted (the "copy to" location). ```yaml Type: String @@ -78,10 +74,7 @@ Accept wildcard characters: False ``` ### -Source - -FQDN of the pool where the Office Communications Server 2007 R2 or Lync Server 2010Response Group application is currently hosted (the "copy from" location). - - +FQDN of the pool where the legacy Response Group application is currently hosted (the "copy from" location). ```yaml Type: String @@ -113,7 +106,7 @@ Accept wildcard characters: False ``` ### -ResolveNameConflicts -PARAMVALUE: SwitchParameter +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 @@ -129,7 +122,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -149,4 +142,3 @@ Move-CsRgsConfiguration moves instances of the Microsoft.Rtc.Management.Writable [Get-CsRgsConfiguration](Get-CsRgsConfiguration.md) [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md index 42aa497dad..6ab001cf5a 100644 --- a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsThirdPartyVideoSystem @@ -261,7 +266,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -285,4 +290,3 @@ However, if you include the PassThru parameter you can instances of the Microsof [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/Move-CsUser.md b/skype/skype-ps/skype/Move-CsUser.md index 40375264d3..29973fc914 100644 --- a/skype/skype-ps/skype/Move-CsUser.md +++ b/skype/skype-ps/skype/Move-CsUser.md @@ -1,90 +1,128 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Move-CsUser ## SYNOPSIS -Moves one or more user accounts enabled for Skype for Business Server to a new Registrar pool, or to Office 365 (either to Teams or Skype for Business Online). +Moves one or more user accounts enabled for Skype for Business Server to TeamsOnly (or the reverse). This cmdlet also can be used to move on-premises users from one pool to another. +**PRE-REQUISITES steps for running Move-CsUser** +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later + +**PRE-REQUISITES steps for** [Office 365 operated by 21Vianet](/microsoft-365/admin/services-in-china/services-in-china?view=o365-21vianet) +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later +- Run Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/set-teamsenvironmentconfig). ## SYNTAX -### (Default) +### (Default) + ``` -Move-CsUser [-Identity] <UserIdParameter> [-Target] <Fqdn> [-Credential <PSCredential>] [-MoveToTeams] [-HostedMigrationOverrideUrl <String>] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>] +Move-CsUser [-Identity] <UserIdParameter> [-Target] <Fqdn> [-Credential <PSCredential>] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool <Fqdn>] [-MoveConferenceData] [-Report <String>] [-DomainController <Fqdn>] [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>] ``` +### UserList - - +``` +Move-CsUser -UserList <String> [-Target] <Fqdn> [-Credential <PSCredential>] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool <Fqdn>] [-MoveConferenceData] [-Report <String>] [-DomainController <Fqdn>] [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>] +``` ## DESCRIPTION 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 Office 365 (or the reverse) - - from an on-premises Skype for Business deployment to Skype for Business Online in Office 365 (or the reverse) - - from one registrar pool to another, in an on-premises Skype for Business Server deployment. -The Move-CsUser cmdlet affects only the user's Skype for Business Server account location; it does not move the user's Active Directory account to a new organizational unit (OU) or other new location. -When moving a user to or from Office 365 (either Skype for Business Online or Teams): - - Skype for Business hybrid must be configured. For more information, see https://docs.microsoft.com/en-us/SkypeForBusiness/skype-for-business-hybrid-solutions/deploy-hybrid-connectivity/deploy-hybrid-connectivity - - Contacts are moved in all cases, unless -force is specified. - - Meetings are migrated from Skype for Business Server to Skype for Business Online for any move from Skype for Business Server. Teams- only users can still join meetings hosted in Skype for Business. - - To move a user to Office 365, specify the ProxyFqdn of the hosting provider as the Target. In most cases, this is "sipfed.online.lync.com" but in specialized environments there will be variants of this address. - - Moving a user to Teams is achieved by specifying the MoveToTeams switch. This performs the same operations as a move to Skype for Business Online and also applies TeamsUpgradePolicy and TeamsInteropPolicy to the online user account. +- from an on-premises Skype for Business deployment to Teams-only in Microsoft 365 (or the reverse) +- from one registrar pool to another, in an on-premises Skype for Business Server deployment. +The Move-CsUser cmdlet affects only the user's Skype for Business Server account location; it does not move the user's Active Directory account to a new organizational unit (OU) or other new location. +When moving a user to the Microsoft 365 cloud to become TeamsOnly (or the reverse): +- Skype for Business hybrid must be configured. For more information, see [Deploy hybrid connectivity between Skype for Business Server and Skype for Business Online](https://learn.microsoft.com/SkypeForBusiness/skype-for-business-hybrid-solutions/deploy-hybrid-connectivity/deploy-hybrid-connectivity). +- To move a user to Microsoft 365, specify the ProxyFqdn of the hosting provider as the Target. In most cases, this is "sipfed.online.lync.com" but in specialized environments, there will be variants of this address. For more details, see [Move users between on-premises and cloud](/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud). +- When migrating from on-premises to the cloud, users are automatically assigned Teams Only mode and their meetings from on-premises are automatically converted to Teams meetings. This conversion happens regardless of which on-premises version of Skype for Business Server or Lync Server was being used. You no longer need to specify the `-MoveToTeams` switch. In fact, specifying that switch no longer has any impact. Teams Only users can still *join* meetings hosted in Skype for Business (for example, they're invited to a meeting by a Skype For Business user). However, beginning in October 2022, users moved from on-premises to Teams Only will no longer be provisioned with the Skype for Business Online infrastructure. At this point, Teams Only users can join Skype for Business meetings, but only anonymously. For more information, see [Skype for Business Online retirement](/microsoftteams/skype-for-business-online-retirement). +- When migrating from on-premises to the cloud, contacts from Skype for Business Server are migrated to the cloud (unless you use the `-Force` switch in the Move-CsUser command) and become available in Teams after the move is complete and the user logs on to Teams. To ensure these contacts are migrated to Teams, the migrated user must sign in to Teams within 30 days of being moved from on-premises to Teams Only. For details, see [Guidance for Organizations with on-premises deployments of Skype for Business Server](/microsoftteams/skype-for-business-online-retirement#guidance-for-organizations-with-on-premises-deployments-of-skype-for-business-server). +- If you receive an error while running this cmdlet about multiple federated Edge pools, Skype for Business Federation can only be enabled for a single Edge pool. If you have multiple Edge pools, select one to use as the federating Edge pool. -## EXAMPLES +> [!NOTE] +> +> - Moving users from On-Premises to Teams requires TLS 1.2. TLS 1.0 and TLS 1.1 have been deprecated. Please visit [Disabling TLS 1.0 and 1.1 for Microsoft 365](/microsoft-365/compliance/tls-1.0-and-1.1-deprecation-for-office-365?view=o365-worldwide) and [Preparing for TLS 1.2 in Office 365 and Office 365 GCC](/microsoft-365/compliance/prepare-tls-1.2-in-office-365?view=o365-worldwide) for details. +> - To use Multi-Factor Authentication (MFA) with Move-CsUser requires either Skype for Business Server 2015 CU12 or any version of Skype for Business Server 2019. When using MFA do not specify the -Credential 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. -### ------- EXAMPLE 1: Move a user to Teams----------------------- -``` +> [!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. -$cred=get-credential -Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -MoveToTeams -Credential $cred -``` +**MINIMUM REQUIRED SERVER VERSIONS**: -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. +As of July 31, 2022, moving users between an on-premises deployment and the cloud requires the following minimum version of either Skype for Business Server or Lync Server. In the future, moves between on-premises and the cloud will no longer be possible if you are using a version earlier than the ones listed below. If you are still using an earlier version of Skype for Business Server, you should upgrade to the specified minimum version (or later) before July 31, 2022. -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. +</br> +</br> -### ------- EXAMPLE 2: Move a user to Skype for Business Online ---- -``` +|On-premises product|Required minimum version|Required minimum build| +|---|---|---| +|Skype for Business Server 2019| CU6 |7.0.2046.385| +|Skype for Business Server 2015| CU12|6.0.9319.619| +|Lync Server 2013| CU10 with Hotfix 7|5.0.8308.1182| +|||| + +</br> +</br> + +## EXAMPLES + +### EXAMPLE 1: Move a user to Teams + +```powershell $cred=get-credential -Move-CsUser -Identity PilarA@contoso.com -Target "sipfed.online.lync.com" -Credential $cred +Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred ``` -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. +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. -### -------- EXAMPLE 3: Move a user to another on-premises pool------- -``` -Move-CsUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" +### EXAMPLE 2: Move a user to another on-premises pool + +```powershell +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 -### --------- EXAMPLE 4: Move multiple users --------------------------- -``` - +```powershell 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 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. +### EXAMPLE 4: Move multiple users listed in a file + +```powershell +Move-CsUser -UserList C:\Folder1\Folder2\file1.txt -Target "atl-cs-001.litwareinc.com" -Report C:\Folder1\Folder2\out.csv +``` +In Example 5, all the users listed in file1.txt are moved to the Registrar pool atl-cs-001.litwareinc.com. +Also, a detailed report is created in the out.csv file. ## PARAMETERS ### -Identity + 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. @@ -95,7 +133,7 @@ For example, the Identity "* Smith" returns all the users with who have a displa ```yaml Type: UserIdParameter Parameter Sets: (All), Identity -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -107,15 +145,14 @@ Accept wildcard characters: False ### -Target -If moving to an on-premises pool (either from another pool or from Office 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 Office 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 +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: Fqdn Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -125,34 +162,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - -### -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. This parameter is only available with the upcoming releases of Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - - ### -Credential Enables you to run the Move-CsUser cmdlet under alternate credentials, which is typically required when moving to Office 365. To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet help topic. - ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -162,18 +179,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedMigrationOverrideUrl - -The hosted migration service is the service in Office 365 that performs user moves. By default, there is no need to specify a value for this parameter, as long as the hosting provider has its AutoDiscover URL properly configured. However, a specific URL can be specified if required. - +### -UseOAuth +This switch is no longer relevant. Previously, this switch ensured authentication between on-premises and the cloud. This switch also ensured Skype for Business Server 2015 CU8 to CU11 used the OAuth protocol (supported in those versions, but not used by default). All currently supported versions for migration to Teams (see the list earlier in this article) automatically use OAuth, so this switch is no longer required. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - +Aliases: +Applicable: Skype for Business Server 2015 Required: False Position: Named Default value: None @@ -182,7 +196,8 @@ Accept wildcard characters: False ``` ### -BypassAudioConferencingCheck -By default, if the on-premise user is configured for dial in conferencing, moving the user to Office 365 will provision the user for Audio Conferencing, 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 Audio Conferencing, specify this switch to by-pass the license check. This parameter is only available with the upcoming releases of Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. + +This parameter has been deprecated and should not be used. ```yaml Type: SwitchParameter @@ -195,8 +210,10 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -BypassEnterpriseVoiceCheck -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. This parameter is only available with the upcoming releases of Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. + +This parameter has been deprecated and should not be used. ```yaml Type: SwitchParameter @@ -211,8 +228,8 @@ Accept wildcard characters: False ``` ### -TenantAdminUserName -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 the upcoming releases of Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. +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: UserIdParameter @@ -225,15 +242,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProxyPool + +This is an optional parameter that can be used to specify the front-end pool for user migration. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveConferenceData + +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 +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 +``` ### -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. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -243,8 +295,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -Confirm + 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: @@ -258,7 +310,7 @@ If you would prefer to have the confirmation prompt then use this syntax: Type: SwitchParameter Parameter Sets: (All) Aliases: cf -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 @@ -268,14 +320,48 @@ Accept wildcard characters: False ``` ### -Report -PARAMVALUE: String + +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 -Aliases: +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 +``` + +### -UserList + +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: String +Parameter Sets: Users +Aliases: 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 +``` + +### -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: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named Default value: None @@ -284,13 +370,14 @@ 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-CsUser cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -301,6 +388,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Describes what would happen if you executed the command without actually executing the command. ```yaml @@ -316,22 +404,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` + +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS +### String -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The Move-CsUser cmdlet accepts a pipelined string value representing the Identity 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 -### +### None + The Move-CsUser cmdlet does not return a value or object. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. @@ -339,9 +429,12 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.ADConnect ## RELATED LINKS -[Get-CsUser](Get-CsUser.md) +[Move users between on-premises and cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud) + +[Configure Skype for Business hybrid](https://learn.microsoft.com/SkypeForBusiness/hybrid/configure-federation-with-skype-for-business-online) -[Skype for Business Hybrid Solutions](https://docs.microsoft.com/en-us/SkypeForBusiness/skype-for-business-hybrid-solutions/skype-for-business-hybrid-solutions) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) +[Guidance for Organizations with on-premises deployments of Skype for Business Server](https://learn.microsoft.com/microsoftteams/skype-for-business-online-retirement#guidance-for-organizations-with-on-premises-deployments-of-skype-for-business-server) diff --git a/skype/skype-ps/skype/New-CSOnlinePSTNGateway.md b/skype/skype-ps/skype/New-CSOnlinePSTNGateway.md deleted file mode 100644 index 63c4a505ab..0000000000 --- a/skype/skype-ps/skype/New-CSOnlinePSTNGateway.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: -applicable: Skype for Business Online -title: New-CSOnlinePSTNGateway -schema: 2.0.0 ---- - -# New-CSOnlinePSTNGateway - -## SYNOPSIS -Creates a new Session Border Controller (SBC) Configuration that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. - -## SYNTAX - -### Identity (Default) -``` -New-CSOnlinePSTNGateway [-Tenant <System.Guid>] -SipSignallingPort <Int32> [-CodecPriority <String>] - [-ExcludedCodecs <String>] [-FailoverTimeSeconds <Int32>] [-ForwardCallHistory <Boolean>] - [-ForwardPai <Boolean>] [-SendSipOptions <Boolean>] [-MaxConcurrentSessions <System.Int32>] - [-Enabled <Boolean>] [-MediaBypass <Boolean>] [-GatewaySiteId <String>] [-GatewaySiteLbrEnabled <Boolean>] [-Identity] <XdsGlobalRelativeIdentity> [-InMemory] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentAndRelativeKey -``` -New-CSOnlinePSTNGateway [-Tenant <System.Guid>] -Fqdn <String> -SipSignallingPort <Int32> - [-CodecPriority <String>] [-ExcludedCodecs <String>] [-FailoverTimeSeconds <Int32>] - [-ForwardCallHistory <Boolean>] [-ForwardPai <Boolean>] [-SendSipOptions <Boolean>] - [-MaxConcurrentSessions <System.Int32>] [-Enabled <Boolean>] [-MediaBypass <Boolean>] [-GatewaySiteId <String>] [-GatewaySiteLbrEnabled <Boolean>] [-InMemory] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to create a new Session Border Controller (SBC) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter is set to $false, the SBC will continue existing calls, but all new calls will be routed to another SBC in a route (if exists). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CSOnlinePSTNGateway - FQDN sbc.contoso.com -SIPSignallingPort 5061 -``` - -This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. All others parameters will stay default. Note the SBC will be in the disabled state. - -### Example 2 -```powershell -PS C:\> New-CSOnlinePSTNGateway - FQDN sbc.contoso.com -SIPSignallingPort 5061 -ForwardPAI $true -Enabled $true -``` - -This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. For each outbound to SBC session, the Direct Routing interface will report in P-Asserted-Identity fields the TEL URI and SIP address of the user who made a call. This is useful when a tenant administrator set identity of the caller as "Anonymous" or a general number of the company, but for the billing purposes the real identity of the user should be reported. - -## PARAMETERS - -### -CodecPriority -Allows choosing codec priority when media is negotiated between Media Proxy and SBC. Default priority is ("SILKWB,SILKNB,PCMU,PCMA"). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: ("SILKWB,SILKNB,PCMU,PCMA") -Accept 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC, while it is being updated or during maintenance. Note of the parameter not set the SBC will be created as disabled (default value -Enabled $false). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedCodecs -Allows exclude some codecs during the process of media negotiation between Media Proxy and SBC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverTimeSeconds -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 gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: 10 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -```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 -``` - -### -ForwardCallHistory -Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fqdn -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: Skype for Business Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The parameter is not mandatory when creating a new SBC, the identity must be identical to the -FQDN parameter, described below. If the parameter not defined the Idetity will be copied from the -FQDN parameter. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory - -```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 -``` - -### -MaxConcurrentSessions -Used by 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 parameter is not set, the alerts are not generated. However, the monitoring system will report number of concurrent session every 24 hours. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MediaBypass -Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewaySiteId -PSTN Gateway Site Id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -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 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: Skype for Business Online -Required: False -Position: Named -Default value: $false -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SipSignallingPort -Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md) - -[Get-CSOnlinePSTNGateway](Get-CSOnlinePSTNGateway.md) - -[Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md index 36907b08f6..89161bbc99 100644 --- a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAVEdgeConfiguration @@ -220,7 +225,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -242,4 +247,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.M [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md b/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md index d80ccc3e30..02cf488052 100644 --- a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAdditionalInternalDomain ## SYNOPSIS -Creates a new additional internal domain for use in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 – December 2017. +Creates a new additional internal domain for use in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 - December 2017. ## SYNTAX @@ -139,7 +144,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -153,7 +158,6 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[Remove-CsAdditionalInternalDomain](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csadditionalinternaldomain?view=skype-ps) - -[Get-CsAdditionalInternalDomain](https://docs.microsoft.com/en-us/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Remove-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md b/skype/skype-ps/skype/New-CsAddressBookConfiguration.md index 7196ffa30c..2e6b1c092e 100644 --- a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/New-CsAddressBookConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAddressBookConfiguration @@ -390,7 +395,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -412,5 +417,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Addres [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md index 30a92e67d9..3291177ad9 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAddressBookNormalizationConfiguration @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -170,5 +175,3 @@ The New-CsAddressBookNormalizationConfiguration cmdlet creates new instances of [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - - diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md index 143c8d87d1..9aa677a96c 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAddressBookNormalizationRule @@ -255,7 +260,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -277,4 +282,3 @@ The New-CsAddressBookNormalizationRule cmdlet creates instances of the Microsoft [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/New-CsAdminRole.md b/skype/skype-ps/skype/New-CsAdminRole.md index e95c4f592c..afa8e62603 100644 --- a/skype/skype-ps/skype/New-CsAdminRole.md +++ b/skype/skype-ps/skype/New-CsAdminRole.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAdminRole @@ -346,7 +351,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -361,4 +366,3 @@ The New-CsAdminRole cmdlet creates new instances of the Microsoft.Rtc.Management ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsAllowedDomain.md b/skype/skype-ps/skype/New-CsAllowedDomain.md index 0b901ef53a..4bd2464f78 100644 --- a/skype/skype-ps/skype/New-CsAllowedDomain.md +++ b/skype/skype-ps/skype/New-CsAllowedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAllowedDomain @@ -296,7 +301,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -320,5 +325,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.A [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsAllowedDomain](Set-CsAllowedDomain.md) - - diff --git a/skype/skype-ps/skype/New-CsAnalogDevice.md b/skype/skype-ps/skype/New-CsAnalogDevice.md index aae81719c2..78fd82666f 100644 --- a/skype/skype-ps/skype/New-CsAnalogDevice.md +++ b/skype/skype-ps/skype/New-CsAnalogDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAnalogDevice @@ -277,7 +282,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -301,4 +306,3 @@ The New-CsAnalogDevice cmdlet creates new instances of the Microsoft.Rtc.Managem [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/New-CsAnnouncement.md b/skype/skype-ps/skype/New-CsAnnouncement.md index c628bf19af..5d2ff20332 100644 --- a/skype/skype-ps/skype/New-CsAnnouncement.md +++ b/skype/skype-ps/skype/New-CsAnnouncement.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsAnnouncement @@ -328,7 +333,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -355,4 +360,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Annou [New-CsUnassignedNumber](New-CsUnassignedNumber.md) [Set-CsUnassignedNumber](Set-CsUnassignedNumber.md) - diff --git a/skype/skype-ps/skype/New-CsArchivingConfiguration.md b/skype/skype-ps/skype/New-CsArchivingConfiguration.md index 03f8706de9..16ef9e0722 100644 --- a/skype/skype-ps/skype/New-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/New-CsArchivingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsArchivingConfiguration @@ -355,7 +360,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -379,4 +384,3 @@ The New-CsArchivingConfiguration cmdlet creates new instances of the Microsoft.R [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/New-CsArchivingPolicy.md b/skype/skype-ps/skype/New-CsArchivingPolicy.md index 2c0af5033c..1abff2dd90 100644 --- a/skype/skype-ps/skype/New-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/New-CsArchivingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsArchivingPolicy @@ -250,7 +255,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -274,5 +279,3 @@ The New-CsArchivingPolicy cmdlet creates instances of the Microsoft.Rtc.Manageme [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md index 8fd8d4b92e..0e9d77cb0a 100644 --- a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAutodiscoverConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsAutodiscoverConfiguration @@ -62,14 +67,14 @@ Because the WebLinks parameter was not included, these settings will not contain ### -------------------------- EXAMPLE 2 -------------------------- ``` -$Link1 = New-CsWebLink -Token "Fabrikam" -Href "http://lyncdiscover.fabrikam.com/" +$Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://lyncdiscover.fabrikam.com/" -$Link2 = New-CsWebLink -Token "Fabrikam" -Href "http://lyncdiscoverinternal.fabrikam.com/" +$Link2 = New-CsWebLink -Token "Fabrikam" -Href "https://lyncdiscoverinternal.fabrikam.com/" New-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1,$Link2} ``` -The commands shown in Example 2 create a new collection of Autodiscover configuration settings for the Redmond site and assign those new settings a pair of Autodiscover URLs: http://LyncDiscover.fabrikam.com and http://LyncDiscoverInternal.fabrikam.com. +The commands shown in Example 2 create a new collection of Autodiscover configuration settings for the Redmond site and assign those new settings a pair of Autodiscover URLs: `https://LyncDiscover.fabrikam.com` and `https://LyncDiscoverInternal.fabrikam.com`. In order to carry out this task, the first two commands use the New-CsWebLink cmdlet to create the two Autodiscover URLs; the newly-created URLs are then stored in variables named $Link1 and $Link2. After the two URLs are created, the third command uses the New-CsAutoDiscoverConfiguration cmdlet to create the new Autodiscover configuration settings. In order to assign the two URLs to these settings, the WebLinks parameter is included along with the parameter value @{Add=$Link1,$Link2}. @@ -228,7 +233,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -246,4 +251,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.A ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md index 167026613b..3a2dc9990e 100644 --- a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsBandwidthPolicyServiceConfiguration @@ -222,7 +227,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -243,4 +248,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Bandw [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsBlockedDomain.md b/skype/skype-ps/skype/New-CsBlockedDomain.md index ccf4661349..4b9231b7d5 100644 --- a/skype/skype-ps/skype/New-CsBlockedDomain.md +++ b/skype/skype-ps/skype/New-CsBlockedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsBlockedDomain @@ -213,7 +218,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -237,5 +242,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.B [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsBlockedDomain](Set-CsBlockedDomain.md) - - diff --git a/skype/skype-ps/skype/New-CsCallParkOrbit.md b/skype/skype-ps/skype/New-CsCallParkOrbit.md index fff330c750..fb35a67100 100644 --- a/skype/skype-ps/skype/New-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/New-CsCallParkOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsCallParkOrbit @@ -261,7 +266,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -282,5 +287,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.Voice.Helpers.Dis [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) - - diff --git a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md index 34a1fea152..cc14b7f786 100644 --- a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsCallViaWorkPolicy @@ -19,9 +24,7 @@ New-CsCallViaWorkPolicy [-Identity] <XdsIdentity> [-AdminCallbackNumber <String> ``` ## DESCRIPTION -To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command from the Windows PowerShell prompt. - -Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"} +This cmdlet creates a new call via work policy. ## EXAMPLES @@ -41,13 +44,13 @@ The policy is enabled, the administrative callback number is specified and enfor 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.` +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-CsCallViawork cmdlet instead. +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-CsCallViawork cmdlet. +If you need to make changes to an existing policy, use the Set-CsCallViaWorkPolicy cmdlet. ```yaml Type: XdsIdentity @@ -183,7 +186,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -199,7 +202,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -222,5 +225,3 @@ The New-CsCallViaWorkPolicy returns Microsoft.Rtc.Management.WritableConfig.Poli [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsCallerIdPolicy.md b/skype/skype-ps/skype/New-CsCallerIdPolicy.md deleted file mode 100644 index 2aa672c255..0000000000 --- a/skype/skype-ps/skype/New-CsCallerIdPolicy.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsCallerIdPolicy -schema: 2.0.0 ---- - -# New-CsCallerIdPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -New-CsCallerIdPolicy [-Tenant <Guid>] [-Description <String>] [-Name <String>] - [-EnableUserOverride <Boolean>] [-ServiceNumber <String>] [-CallerIDSubstitute <CallerIDSubstitute>] - [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerIDSubstitute -PARAMVALUE: Anonymous | Service | LineUri - -```yaml -Type: CallerIDSubstitute -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 -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUserOverride -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md deleted file mode 100644 index 2fea656837..0000000000 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsCallingLineIdentity -schema: 2.0.0 ---- - -# New-CsCallingLineIdentity - -## SYNOPSIS -Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for your organization. - -## SYNTAX - -``` -New-CsCallingLineIdentity [-Tenant <Guid>] [-Description <String>] [-EnableUserOverride <Boolean>] - [-ServiceNumber <String>] [-CallingIDSubstitute <CallingIDSubstituteType>] - [-BlockIncomingPstnCallerID <Boolean>] [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -You can either change or block the Caller ID (also called a Calling Line ID) for a user. By default, the Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can create a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed. - -Note: -- Identity must be unique. -- ServiceNumber must be a valid Service Number in the Skype for Business Online online telephone number inventory. -- If CallerIdSubstitute is given as “Service”, then ServiceNumber cannot be empty. - - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -``` - -The following example creates a new Caller ID policy that sets the Caller ID to Anonymous. - -### -------------------------- Example 2 -------------------------- -``` -New-CsCallingLineIdentity -Identity "UKOrgAA" -CallingIdSubstitute "Service" -ServiceNumber "14258828080" -EnableUserOverride $false -Verbose -``` - -The following example creates a new Caller ID policy that sets the Caller ID to a specified service number. - -### -------------------------- Example 3 -------------------------- -``` -New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true -``` - -The following example creates a new Caller ID policy that blocks the incoming Caller ID. - -## PARAMETERS - -### -Identity -The Identity parameter identifies the Caller ID policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockIncomingPstnCallerID -The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. - -The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a Lync user, then Caller ID for incoming calls is suppressed/anonymous. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingIDSubstitute -PARAMVALUE: Anonymous | Service | LineUri - -The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. - -```yaml -Type: CallingIDSubstituteType -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter briefly describes the Caller ID policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUserOverride -The EnableUserOverride switch lets the user override the Caller ID policy. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -The ServiceNumber parameter lets you add any valid service number for the CallingIdSubstitute. - -Note: Do not add ‘+’ to the Service number. For example, if the Service number is +1425-xxx-xxxx then valid input is 1425xxxxxxx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 - -## RELATED LINKS - -[Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) - -[Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) - -[Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) - -[Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) - diff --git a/skype/skype-ps/skype/New-CsCdrConfiguration.md b/skype/skype-ps/skype/New-CsCdrConfiguration.md index 33e4b12235..68b89ad829 100644 --- a/skype/skype-ps/skype/New-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/New-CsCdrConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsCdrConfiguration @@ -264,7 +269,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -286,5 +291,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDe [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsClientPolicy.md b/skype/skype-ps/skype/New-CsClientPolicy.md index 073d1b7b7a..38bddfb4fe 100644 --- a/skype/skype-ps/skype/New-CsClientPolicy.md +++ b/skype/skype-ps/skype/New-CsClientPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClientPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # New-CsClientPolicy @@ -74,7 +79,7 @@ If you need to make changes to the global policy, use the Set-CsClientPolicy cmd Keep in mind that client policies differ from many other policies in that most of the policy settings do not have default values. -The following parameters are not applicable to Skype for Business Online: AddressBookAvailability, AsJob, AttendantSafeTransfer, AutoDiscoveryRetryInterval, BlockConversationFromFederatedContacts, CalendarStatePublicationInterval, ConferenceIMIdleTimeout, CustomizedHelpUrl, CustomLinkInErrorMessages, CustomStateUrl, Description, DGRefreshInterval, DisableContactCardOrganizationTab, DisableFederatedPromptDisplayName, DisableFeedsTab, DisableMeetingSubjectAndLocation, DisableOneNote12Integration, DisableOnlineContextualSearch, DisablePhonePresence, DisablePICPromptDisplayName, EnableEventLogging, EnableExchangeContactsFolder, EnableExchangeDelegateSync, EnableFullScreenVideo, EnableHighPerformanceConferencingAppSharing, EnableHighPerformanceP2PAppSharing, EnableMediaRedirection, EnableMeetingEngagement, EnableNotificationForNewSubscribers, EnableOnlineFeedback, EnableOnlineFeedbackScreenshots, EnableSQMData, EnableTracing, EnableViewBasedSubscriptionMode, EnableVOIPCallDefault, Force, HelpEnvironment, Identity, IMLatencyErrorThreshold, IMLatencySpinnerDelay, InMemory, MAPIPollInterval, MaximumDGsAllowedInContactList, MaximumNumberOfContacts, MaxPhotoSizeKB, P2PAppSharingEncryption, PipelineVariable, PolicyEntry, PublicationBatchDelay, RateMyCallAllowCustomUserFeedback, RequireContentPin, SearchPrefixFlags, SPSearchCenterExternalURL, SPSearchCenterInternalURL, SPSearchExternalURL, SPSearchInternalURL, SupportModernFilePicker, TabURL, TelemetryTier, Tenant, and WebServicePollInterval +The following parameters are not applicable to Skype for Business Online: AddressBookAvailability, AttendantSafeTransfer, AutoDiscoveryRetryInterval, BlockConversationFromFederatedContacts, CalendarStatePublicationInterval, ConferenceIMIdleTimeout, CustomizedHelpUrl, CustomLinkInErrorMessages, CustomStateUrl, Description, DGRefreshInterval, DisableContactCardOrganizationTab, DisableFederatedPromptDisplayName, DisableFeedsTab, DisableMeetingSubjectAndLocation, DisableOneNote12Integration, DisableOnlineContextualSearch, DisablePhonePresence, DisablePICPromptDisplayName, EnableEventLogging, EnableExchangeContactsFolder, EnableExchangeDelegateSync, EnableFullScreenVideo, EnableHighPerformanceConferencingAppSharing, EnableHighPerformanceP2PAppSharing, EnableMediaRedirection, EnableMeetingEngagement, EnableNotificationForNewSubscribers, EnableOnlineFeedback, EnableOnlineFeedbackScreenshots, EnableSQMData, EnableTracing, EnableViewBasedSubscriptionMode, EnableVOIPCallDefault, Force, HelpEnvironment, Identity, IMLatencyErrorThreshold, IMLatencySpinnerDelay, InMemory, MAPIPollInterval, MaximumDGsAllowedInContactList, MaximumNumberOfContacts, MaxPhotoSizeKB, P2PAppSharingEncryption, PipelineVariable, PolicyEntry, PublicationBatchDelay, RateMyCallAllowCustomUserFeedback, RequireContentPin, SearchPrefixFlags, SPSearchCenterExternalURL, SPSearchCenterInternalURL, SPSearchExternalURL, SPSearchInternalURL, SupportModernFilePicker, TabURL, TelemetryTier, Tenant, and WebServicePollInterval ## EXAMPLES @@ -1303,7 +1308,7 @@ 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 "http://www.litwareinc.com/feedback"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` +`$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. @@ -1348,11 +1353,9 @@ To search only last name, first name, and display name you would construct this 1110000 After the binary value has been constructed, it must then be converted to a decimal value before being assigned to SearchPrefixFlags. -To convert a binary number to a decimal number, you can use the a Windows PowerShell command similar to this: - -`\[Convert\]::ToInt32("1110111", 2)` - +To convert a binary number to a decimal number, you can use a Windows PowerShell command similar to this: +`[Convert]::ToInt32("1110111", 2)` ```yaml Type: UInt16 @@ -2007,6 +2010,7 @@ 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. ```yaml Type: Boolean @@ -2022,6 +2026,7 @@ Accept wildcard characters: False ``` ### -RateMyCallDisplayPercentage +This parameter controls how often the form is shown. ```yaml Type: UInt16 @@ -2107,23 +2112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -2153,5 +2143,3 @@ The New-CsClientPolicy cmdlet creates new instances of the Microsoft.Rtc.Managem [Remove-CsClientPolicy](Remove-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsClientPolicyEntry.md b/skype/skype-ps/skype/New-CsClientPolicyEntry.md index e1040f55a8..4fb43fb573 100644 --- a/skype/skype-ps/skype/New-CsClientPolicyEntry.md +++ b/skype/skype-ps/skype/New-CsClientPolicyEntry.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClientPolicyEntry @@ -41,7 +46,7 @@ Instead, you will need to wait for notification from Microsoft regarding names a ### -------------------------- EXAMPLE 1 -------------------------- ``` -$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "http://www.litwareinc.com/feedback" +$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback" $y = Get-CsClientPolicy -Identity global @@ -55,7 +60,7 @@ This example adds a new feedback option to Skype for Business. Note that this example is for demonstration purposes. You should not expect to be able to run these commands and add a similar feedback option to your copy of Skype for Business. -In order to add the new policy entry, the first command in the example uses the New-CsClientPolicyEntry cmdlet to create an entry with the Name OnlineFeedbackURL and the Value http://www.litwareinc.com/feedback. +In order to add the new policy entry, the first command in the example uses the New-CsClientPolicyEntry cmdlet to create an entry with the Name OnlineFeedbackURL and the Value https://www.litwareinc.com/feedback. The resulting policy entry object is stored in a variable named $x. In the second command, the Get-CsClientPolicy cmdlet is used to create an object reference ($y) to the global client policy. @@ -69,7 +74,7 @@ If you do not call the Set-CsClientPolicy cmdlet, your changes will exist only i ### -------------------------- EXAMPLE 2 -------------------------- ``` -$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "http://www.litwareinc.com/feedback" +$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback" Set-CsClientPolicy -Identity global -PolicyEntry $x ``` @@ -133,7 +138,7 @@ Accept wildcard characters: False ### -Value Value to be assigned to the new policy entry. -For example: `-Value http://www.litwareinc.com/feedback.` +For example: `-Value https://www.litwareinc.com/feedback.` ```yaml Type: String @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -169,4 +174,3 @@ The New-CsClientPolicyEntry cmdlet creates new instances of the Microsoft.Rtc.Ma [New-CsClientPolicy](New-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md b/skype/skype-ps/skype/New-CsClientVersionConfiguration.md index 74657f59f8..a361347d9f 100644 --- a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/New-CsClientVersionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClientVersionConfiguration @@ -241,7 +246,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -263,5 +268,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Clie [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicy.md b/skype/skype-ps/skype/New-CsClientVersionPolicy.md index 3377a458e9..d8e270a440 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/New-CsClientVersionPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClientVersionPolicy @@ -233,7 +238,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -257,4 +262,3 @@ The New-CsClientVersionPolicy cmdlet creates new instances of the Microsoft.Rtc. [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md index a9154bba41..2cb0dc194e 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClientVersionPolicyRule @@ -85,7 +90,7 @@ Client version policies enforced in your organization do not override the client ### -------------------------- EXAMPLE 1 -------------------------- ``` -$x = \[guid\]::NewGuid() +$x = [guid]::NewGuid() New-CsClientVersionPolicyRule -Parent "site:Redmond" -RuleId $x -MajorVersion 4 -UserAgent InHouse ``` @@ -103,7 +108,7 @@ In this case, the UserAgent parameter represents an in-house client application. ### -------------------------- EXAMPLE 2 -------------------------- ``` -$x = \[guid\]::NewGuid() +$x = [guid]::NewGuid() $z = New-CsClientVersionPolicyRule -Parent "site:Redmond" -RuleId $x -InMemory @@ -402,7 +407,7 @@ Accept wildcard characters: False Globally unique identifier (GUID) for the rule. In Windows PowerShell, you can create a GUID by using the following command: -`$x = \[guid\]::NewGuid()` +`$x = [guid]::NewGuid()` ```yaml Type: String @@ -529,7 +534,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -551,5 +556,3 @@ The New-CsClientVersionPolicyRule cmdlet creates new instances of Microsoft.Rtc. [Remove-CsClientVersionPolicyRule](Remove-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - - diff --git a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md index 773fbeebe5..9508f13493 100644 --- a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md @@ -1,9 +1,13 @@ --- 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 -online version: schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsCloudCallDataConnectorConfiguration @@ -58,7 +62,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -73,7 +77,7 @@ Enables upload of call data (CDR and QoE). Type: Boolean Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -88,7 +92,7 @@ Suppresses the display of any non-fatal error message that might occur when runn Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -103,7 +107,7 @@ Represents the unique identifier to be assigned to the new collection of CloudCa Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None @@ -112,13 +116,13 @@ 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>. +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: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -134,7 +138,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -144,7 +148,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/New-CsClsConfiguration.md b/skype/skype-ps/skype/New-CsClsConfiguration.md index f00bbf0ffc..123753063b 100644 --- a/skype/skype-ps/skype/New-CsClsConfiguration.md +++ b/skype/skype-ps/skype/New-CsClsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClsConfiguration @@ -467,7 +472,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -489,4 +494,3 @@ The New-CsClsConfiguration cmdlet creates new instances of the icrosoft.Rtc.Mana [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) [Set-CsClsConfiguration](Set-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsClsProvider.md b/skype/skype-ps/skype/New-CsClsProvider.md index ae666529b3..33da9f6a09 100644 --- a/skype/skype-ps/skype/New-CsClsProvider.md +++ b/skype/skype-ps/skype/New-CsClsProvider.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClsProvider @@ -195,7 +200,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -215,4 +220,3 @@ The New-CsClsProvider cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsClsScenario](New-CsClsScenario.md) [Set-CsClsScenario](Set-CsClsScenario.md) - diff --git a/skype/skype-ps/skype/New-CsClsRegion.md b/skype/skype-ps/skype/New-CsClsRegion.md index 5b6c6fbe11..e25b134904 100644 --- a/skype/skype-ps/skype/New-CsClsRegion.md +++ b/skype/skype-ps/skype/New-CsClsRegion.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClsRegion @@ -244,7 +249,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -266,6 +271,3 @@ The New-CsClsRegion cmdlet creates new instances of the Microsoft.Rtc.Management [Remove-CsClsRegion](Remove-CsClsRegion.md) [Set-CsClsRegion](Set-CsClsRegion.md) - - - diff --git a/skype/skype-ps/skype/New-CsClsScenario.md b/skype/skype-ps/skype/New-CsClsScenario.md index 36b524b12c..c8ab273146 100644 --- a/skype/skype-ps/skype/New-CsClsScenario.md +++ b/skype/skype-ps/skype/New-CsClsScenario.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClsScenario @@ -48,7 +53,9 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ### -------------------------- Example 1 -------------------------- (Lync Server 2013) ``` +$provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" +New-CsClsScenario -Identity "global/RedmondHybridVoice"-Provider $provider ``` The commands shown in Example 1 create a new centralized logging scenario with the Identity global/RedmondHybridVoice. @@ -56,13 +63,13 @@ In order to carry out this task, the first command in the example uses the New-C After the description and the provider have been created, the final command in the example calls New-CsClsScenario in order to create the scenario, using the data stored in $provider to assign a value to the Provider property. -$provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" -New-CsClsScenario -Identity "global/RedmondHybridVoice"-Provider $provider ### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) ``` +$provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" +New-CsClsScenario -Identity "global/RedmondHybridVoice"-Provider $provider ``` The commands shown in Example 1 create a new centralized logging scenario with the Identity global/RedmondHybridVoice. @@ -70,9 +77,7 @@ In order to carry out this task, the first command in the example uses the New-C After the description and the provider have been created, the final command in the example calls the New-CsClsScenario cmdlet in order to create the scenario, using the data stored in $provider to assign a value to the Provider property. -$provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" -New-CsClsScenario -Identity "global/RedmondHybridVoice"-Provider $provider ## PARAMETERS @@ -235,7 +240,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -251,6 +256,3 @@ The New-CsClsScenario cmdlet creates new instances of the Microsoft.Rtc.Manageme ## NOTES ## RELATED LINKS - - - diff --git a/skype/skype-ps/skype/New-CsClsSecurityGroup.md b/skype/skype-ps/skype/New-CsClsSecurityGroup.md index e96aee6fb3..6e4d1cada3 100644 --- a/skype/skype-ps/skype/New-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/New-CsClsSecurityGroup.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsClsSecurityGroup @@ -214,7 +219,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -236,4 +241,3 @@ The New-CsClsSecurityGroup cmdlet creates new instances of the Microsoft.Rtc.Man [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/New-CsCommonAreaPhone.md b/skype/skype-ps/skype/New-CsCommonAreaPhone.md index 8b6ebae1ef..948f235f55 100644 --- a/skype/skype-ps/skype/New-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/New-CsCommonAreaPhone.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsCommonAreaPhone @@ -288,7 +293,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -312,6 +317,3 @@ The New-CsCommonAreaPhone cmdlet creates new instances of the Microsoft.Rtc.Mana [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - - - diff --git a/skype/skype-ps/skype/New-CsConferenceDirectory.md b/skype/skype-ps/skype/New-CsConferenceDirectory.md index dbffa75920..4a9c8747e0 100644 --- a/skype/skype-ps/skype/New-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/New-CsConferenceDirectory.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsConferenceDirectory @@ -131,7 +136,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -153,6 +158,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Ps [Move-CsConferenceDirectory](Move-CsConferenceDirectory.md) [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) - - - diff --git a/skype/skype-ps/skype/New-CsConferencingConfiguration.md b/skype/skype-ps/skype/New-CsConferencingConfiguration.md index e82ead5dc1..dd911eb816 100644 --- a/skype/skype-ps/skype/New-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/New-CsConferencingConfiguration.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsConferencingConfiguration @@ -615,7 +620,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -637,6 +642,3 @@ The New-CsConferencingConfiguration cmdlet creates new instances of the Microsof [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) - - - diff --git a/skype/skype-ps/skype/New-CsConferencingPolicy.md b/skype/skype-ps/skype/New-CsConferencingPolicy.md index 20ae60d419..08fab2b313 100644 --- a/skype/skype-ps/skype/New-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/New-CsConferencingPolicy.md @@ -1,16 +1,19 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingpolicy +applicable: Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # New-CsConferencingPolicy ## SYNOPSIS -Creates a new conferencing policy for use in your organization. -Conferencing policies determine the features and capabilities that can be used in a conference; this includes everything from whether or not the conference can include IP audio and video to the maximum number of people who can attend a meeting. -This cmdlet was introduced in Lync Server. +Creates a new conferencing policy for your organization. Conferencing policy determines the features and capabilities that can be used in a conference as well as in a broadcast meeting; this includes everything from whether or not the conference can include IP audio and video to the maximum number of people who can attend a meeting. @@ -38,7 +41,7 @@ New-CsConferencingPolicy [-Tenant <System.Guid>] [-AllowIPAudio <Boolean>] [-All ``` ## DESCRIPTION -Conferencing is an important part of Skype for Business Server: conferencing enables groups of users to come together online to view slides and video, share applications, exchange files, and otherwise communicate and collaborate. +Conferencing is an important part of Skype for Business Online and Skype for Business Server: conferencing enables groups of users to come together online to view slides and video, share applications, exchange files, and otherwise communicate and collaborate. It's important for administrators to maintain control over conferences and conference settings. In some cases, there might be security concerns: by default, anyone, including unauthenticated users, can participate in meetings and save any of the slides or handouts distributed during those meetings. @@ -47,32 +50,26 @@ In addition, there might be occasional legal concerns. For example, by default meeting participants are allowed to make annotations on shared content; however, these annotations are not saved when the meeting is archived. If your organization is required to keep a record of all electronic communication, you might want to disable annotations. -Needing to manage conferencing settings is one thing; actually managing these settings is another. -In Skype for Business Server, conferences are managed by using conferencing policies. -(In previous versions of the software, these were known as meeting policies.) As noted, conferencing policies determine the features and capabilities that can be used in a conference, including everything from whether or not the conference can include IP audio and video to the maximum number of people who can attend a meeting. -Conferencing policies can be configured at the global scope; at the site scope; or at the per-user scope. -This provides administrators with enormous flexibility when it comes to deciding which capabilities will be made available to which users. +In Skype for Business Online and Skype for Business Server, conferences are managed using conferencing policy. Conferencing policy determines the features and capabilities that can be used in a conference, including everything from whether or not the conference can include IP audio and video to the maximum number of people who can attend a meeting. In Skype for Business Online, conferencing policy also governs certain aspects of broadcast meetings, in particular, the video bit rate. -The New-CsConferencingPolicy cmdlet enables you to create new conferencing policies at either the site or the per-user scope. -You cannot create a new global policy because the global policy already exists. -However, you can modify the property values of the global policy by using the Set-CsConferencingPolicy cmdlet. + - In Skype for Business Online, conferencing policy is managed on a per-user basis. Skype for Business Online provides several built-in conferencing policy instances, and if needed administrators, can create their own policy instances as well, using the New-CsConferencingPolicy cmdlet. + - In Skype for Business Server, conferencing policies can be created at either the site or the per-user scope. If you need to modify property values of the global conferencing policy, use the Set-CsConferencingPolicy cmdlet. -The following parameters are not applicable to Skype for Business Online: ApplicationSharingMode, AsJob, AudioBitRateKb, Description, EnableMultiViewJoin, EnableOnlineMeetingPromptForLyncResources, EnableReliableConferenceDeletion, FileTransferBitRateKb, Force, Identity, InMemory, MaxMeetingSize, MaxVideoConferenceResolution, PipelineVariable, Tenant, and TotalReceiveVideoBitRateKb. +The following parameters are not applicable to Skype for Business Online: ApplicationSharingMode, AudioBitRateKb, Description, EnableMultiViewJoin, EnableOnlineMeetingPromptForLyncResources, EnableReliableConferenceDeletion, FileTransferBitRateKb, Force, Identity, InMemory, MaxMeetingSize, MaxVideoConferenceResolution, PipelineVariable, Tenant, and TotalReceiveVideoBitRateKb. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1: Create a new conferencing policy with per user scope (Skype for Business Online, Skype for Business Server) ``` New-CsConferencingPolicy -Identity SalesConferencingPolicy -MaxMeetingSize 50 ``` -The command shown in Example 1 uses the New-CsConferencingPolicy cmdlet to create a new conferencing policy with the Identity SalesConferencingPolicy. -This policy will use all the default values for a conferencing policy except one: MaxMeetingSize; in this example, the maximum size for a meeting will be set to 50 instead of the default value of 250. +The command shown in Example 1 uses the New-CsConferencingPolicy cmdlet to create a new conferencing policy with the Identity SalesConferencingPolicy. This policy will use all the default values for a conferencing policy except one: MaxMeetingSize; in this example, the maximum size for a meeting will be set to 50 instead of the default value of 250. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2: Create a new conferencing policy with per site scope (Skype for Business Server) ``` New-CsConferencingPolicy -Identity site:Redmond -MaxMeetingSize 100 -AllowParticipantControl $False ``` @@ -86,7 +83,7 @@ All other policy properties will use the default values. ### -Identity Unique identifier for the conferencing policy to be created. -Conferencing policies can be created at the site or per-user scopes. +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.` @@ -558,7 +555,7 @@ After the maximum number of participants has been reached, anyone else who tries 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 http://go.microsoft.com/fwlink/p/?linkId=242073 (http://go.microsoft.com/fwlink/p/?linkId=242073). +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. @@ -771,9 +768,11 @@ Accept wildcard characters: False ### -VideoBitRateKb Bit rate (in kilobits) used for video transmissions. -The default value is 50000. +The default value is 400. -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. +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. @@ -781,7 +780,7 @@ This setting is enforced at the per-user level, and for both conferences and pee 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 +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, Required: False Position: Named @@ -1006,7 +1005,7 @@ Accept wildcard characters: False ``` ### -CloudRecordingServiceSupport -{{Fill CloudRecordingServiceSupport Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: CloudRecordingServiceSupport @@ -1046,7 +1045,7 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -1078,23 +1077,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -1122,6 +1106,3 @@ The New-CsConferencingPolicy cmdlet creates a new instance of the Microsoft.Rtc. [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) - - - diff --git a/skype/skype-ps/skype/New-CsCpsConfiguration.md b/skype/skype-ps/skype/New-CsCpsConfiguration.md index a87b7b5f84..dfaf405eee 100644 --- a/skype/skype-ps/skype/New-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/New-CsCpsConfiguration.md @@ -1,7 +1,12 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsCpsConfiguration @@ -245,7 +250,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -268,5 +273,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Se [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - - diff --git a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md index 23e93ccbac..e0f256355d 100644 --- a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDeviceUpdateConfiguration @@ -475,7 +480,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -496,16 +501,8 @@ The New-CsDeviceUpdateConfiguration cmdlet creates instances of the Microsoft.Rt ## RELATED LINKS -[Online Version](http://technet.microsoft.com/EN-US/library/2a06450d-291e-40f9-a780-45e2c4b28494(OCS.14).aspx) - [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) - -[Online Version](http://technet.microsoft.com/EN-US/library/2a06450d-291e-40f9-a780-45e2c4b28494(OCS.15).aspx) - -[Online Version](http://technet.microsoft.com/EN-US/library/2a06450d-291e-40f9-a780-45e2c4b28494(OCS.16).aspx) - - diff --git a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md index a4f304b130..db23830811 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDiagnosticConfiguration @@ -385,7 +390,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -409,8 +414,6 @@ The New-CsDiagnosticConfiguration cmdlet creates new instances of the Microsoft. ## RELATED LINKS -[Online Version](http://technet.microsoft.com/EN-US/library/9028d9c1-e812-4055-bdf0-59cb83c6f50f(OCS.14).aspx) - [Get-CsDiagnosticConfiguration](Get-CsDiagnosticConfiguration.md) [New-CsDiagnosticsFilter](New-CsDiagnosticsFilter.md) @@ -418,9 +421,3 @@ The New-CsDiagnosticConfiguration cmdlet creates new instances of the Microsoft. [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) - -[Online Version](http://technet.microsoft.com/EN-US/library/9028d9c1-e812-4055-bdf0-59cb83c6f50f(OCS.15).aspx) - -[Online Version](http://technet.microsoft.com/EN-US/library/9028d9c1-e812-4055-bdf0-59cb83c6f50f(OCS.16).aspx) - - diff --git a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md index bb0a70371d..7906c3c207 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDiagnosticHeaderConfiguration @@ -230,7 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -254,5 +259,3 @@ The New-CsDiagnosticHeaderConfiguration cmdlet creates new instances of the Micr [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md b/skype/skype-ps/skype/New-CsDiagnosticsFilter.md index f9aa90aa61..d2f329786f 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md +++ b/skype/skype-ps/skype/New-CsDiagnosticsFilter.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDiagnosticsFilter @@ -21,6 +26,7 @@ This cmdlet was introduced in Lync Server 2010. New-CsDiagnosticsFilter [-Enabled <Boolean>] [-ExcludeConferenceMessages <Boolean>] [-ExcludePresenceNotifications <Boolean>] [-ExcludeRegisterMessages <Boolean>] [-Fqdn <PSListModifier>] [-Uri <PSListModifier>] [-ExcludeSubscribeMessages <Boolean>] [-ExcludeSuccessfulRequests <Boolean>] + [-ExcludeMidDialogRequests <Boolean>] [-ExcludeTypingNotifications <Boolean>] [<CommonParameters>] ``` @@ -48,7 +54,7 @@ After creating one of these virtual filters, you will then need to use either th ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsDiagnosticsFilter -Fqdn "fabrikam.com" -Enabled $False @@ -66,7 +72,7 @@ In this case, any existing values in the Filter property will be replaced by the -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsDiagnosticsFilter -Fqdn "fabrikam.com","contoso.com" -Enabled $False @@ -230,8 +236,38 @@ 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```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 (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -252,5 +288,3 @@ The New-CsDiagnosticsFilter cmdlet creates new instances of the Microsoft.Rtc.Ma [New-CsDiagnosticConfiguration](New-CsDiagnosticConfiguration.md) [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md index b51dce3955..96f6b14689 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDialInConferencingAccessNumber @@ -363,7 +368,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -386,5 +391,3 @@ The New-CsDialInConferencingAccessNumber cmdlet creates new instances of the Mic [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - - diff --git a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md index 4cc73fb54e..d05fb34422 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDialInConferencingConfiguration @@ -253,7 +258,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -275,5 +280,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Di [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md index 56bd336417..80d7835196 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDialInConferencingDtmfConfiguration @@ -349,7 +354,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -371,5 +376,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Di [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDialPlan.md b/skype/skype-ps/skype/New-CsDialPlan.md index e295c812df..aff1a6f077 100644 --- a/skype/skype-ps/skype/New-CsDialPlan.md +++ b/skype/skype-ps/skype/New-CsDialPlan.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsDialPlan @@ -357,7 +362,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -390,4 +395,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/New-CsEdgeDomainPattern.md b/skype/skype-ps/skype/New-CsEdgeDomainPattern.md deleted file mode 100644 index f629f9107d..0000000000 --- a/skype/skype-ps/skype/New-CsEdgeDomainPattern.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsEdgeDomainPattern -schema: 2.0.0 ---- - -# 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 - -``` -New-CsEdgeDomainPattern -Domain <String> [<CommonParameters>] -``` - -## DESCRIPTION -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: - -Whether or not users can communicate with people from other domains and, if so, which domains they are allowed to communicate with. - -Whether or not users can communicate with people who have accounts on public IM and presence providers such as Windows Live, AOL, and Yahoo. - -Federation is managed, in part, by using allowed domain and blocked domain lists. -The allowed domain list specifies the domains that users are allowed to communicate with; the blocked domain list specifies the domains that users are not allowed to communicate with. -By default, users can communicate with any domain that does not appear on the blocked list. -However, administrators can modify this default setting and limit communication to domains that are on the allowed domains list. - -Skype for Business Online does not allow you to directly modify the allowed list or the blocked list; for example, you cannot use a command similar to this one, which passes a string value representing a domain name to the blocked domains list: - -`Set-CsTenantFederationConfiguration -BlockedDomains "fabrikam.com"` - -Instead, you must create a domain object by using the New-CsEdgeDomainPattern cmdlet, store that domain object in a variable (in this example, $x), then pass the variable name to the blocked domains list: - -`$x = New-CsEdgeDomainPattern -Domain "fabrikam.com"` - -`Set-CsTenantFederationConfiguration -BlockedDomains $x` - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$x = New-CsEdgeDomainPattern -Domain "fabrikam.com" - -Set-CsTenantFederationConfiguration -BlockedDomains $x -``` - -Example 1 demonstrates how you can assign a single domain to the blocked domains list for a specified tenant. -To do this, the first command in the example creates a domain object for the domain fabrikam.com; this is done by calling the New-CsEdgeDomainPattern cmdlet and by saving the resulting domain object in a variable named $x. -The second command then uses the Set-CsTenantFederationConfiguration cmdlet and the BlockedDomains parameter to configure fabrikam.com as the only domain blocked by the current tenant. - - -## PARAMETERS - -### -Domain -Fully qualified domain name of the domain to be added to the allow list. -For example: - -`-Domain "fabrikam.com"` - -Note that you cannot use wildcards when specifying a domain name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### -None. -The New-CsEdgeDomainPattern cmdlet does not accept pipelined input. - -## OUTPUTS - -### -The New-CsEdgeDomainPattern cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DomainPattern object. - -## NOTES - -## RELATED LINKS - -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsEmergencyNumber.md b/skype/skype-ps/skype/New-CsEmergencyNumber.md index 05a8455253..f871386781 100644 --- a/skype/skype-ps/skype/New-CsEmergencyNumber.md +++ b/skype/skype-ps/skype/New-CsEmergencyNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsEmergencyNumber @@ -80,7 +85,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -93,6 +98,6 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[New-CsLocationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-cslocationpolicy?view=skype-ps) +[New-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy?view=skype-ps) -[Set-CsLocationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-cslocationpolicy?view=skype-ps) +[Set-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsExUmContact.md b/skype/skype-ps/skype/New-CsExUmContact.md index c3bb488e3c..a9107cd958 100644 --- a/skype/skype-ps/skype/New-CsExUmContact.md +++ b/skype/skype-ps/skype/New-CsExUmContact.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsExUmContact @@ -234,7 +239,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -259,5 +264,3 @@ Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmCon [Move-CsExUmContact](Move-CsExUmContact.md) [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsExtendedTest.md b/skype/skype-ps/skype/New-CsExtendedTest.md index 983c4a77d4..0b33391159 100644 --- a/skype/skype-ps/skype/New-CsExtendedTest.md +++ b/skype/skype-ps/skype/New-CsExtendedTest.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsExtendedTest @@ -115,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -135,5 +140,3 @@ The New-CsExtendedTest cmdlet creates new instances of the Microsoft.Rtc.Managem [New-CsWatcherNodeConfiguration](New-CsWatcherNodeConfiguration.md) [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md b/skype/skype-ps/skype/New-CsExternalAccessPolicy.md index 91feaf3331..0e86942e9c 100644 --- a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/New-CsExternalAccessPolicy.md @@ -1,27 +1,35 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-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 +ms.author: tomkau +ms.reviewer: rogupta --- # New-CsExternalAccessPolicy ## SYNOPSIS +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter EnablePublicCloudAccess can no longer be used. Enables you to create a new external access policy. -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 MSN; and, 3) 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. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. + +This cmdlet was introduced in Lync Server 2010. +For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) and [Teams and Skype interoperability](/microsoftteams/teams-skype-interop) for specific details. ## SYNTAX -``` -New-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] - [-EnableXmppAccess <Boolean>] [-EnablePublicCloudAccess <Boolean>] - [-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableOutsideAccess <Boolean>] [-Identity] <XdsIdentity> +```powershell +New-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-EnableAcsFederationAccess <Boolean>] + [-EnableXmppAccess <Boolean>] [-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableTeamsConsumerAccess <Boolean>] [-EnableTeamsConsumerInbound <Boolean>] [-EnableOutsideAccess <Boolean>] [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] + ``` ## DESCRIPTION @@ -33,18 +41,19 @@ That might be sufficient to meet your communication needs. If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. -Communicate with people who have SIP accounts with a public instant messaging service such as MSN. +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). -3. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. + When you install Skype for Business Server, a global external access policy is automatically created for you. In addition to the global policy, you can also create custom external access policies at either the site or the per-user scope. If you create an external access policy at the site scope, that policy will automatically be assigned to the site upon creation. @@ -55,11 +64,10 @@ New external access policies can be created by using the New-CsExternalAccessPol Note that these policies can only be created at the site or the per-user scope; you cannot create a new policy at the global scope. In addition, you can have only one external access policy per site: if the Redmond site already has been assigned an external access policy you cannot create a second policy for the site. -The following parameters are not applicable to Skype for Business Online: AsJob, Description, EnableXmppAccess, Force, Identity, InMemory, PipelineVariable, and Tenant +The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, InMemory, PipelineVariable, and Tenant ## EXAMPLES - ### -------------------------- EXAMPLE 1 -------------------------- ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True @@ -68,26 +76,38 @@ 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 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true +New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false +``` + +In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. + +### -------------------------- Example 3 ------------------------ +``` +New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False +``` +The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. +Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. -### -------------------------- EXAMPLE 2 -------------------------- +### -------------------------- EXAMPLE 4 -------------------------- ``` $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory $x.EnableFederationAccess = $True -$x.EnablePublicCloudAccess = $True - $x.EnableOutsideAccess = $True Set-CsExternalAccessPolicy -Instance $x ``` -Example 2 demonstrates the use of the InMemory parameter; this parameter enables you to create an in-memory-only instance of an external access policy. +Example 4 demonstrates the use of the InMemory parameter; this parameter enables you to create an in-memory-only instance of an external access policy. After it has been created, you can modify the in-memory-only instance, then use the Set-CsExternalAccessPolicy cmdlet to transform the virtual policy into a real external access policy. To do this, the first command in the example uses the New-CsExternalAccessPolicy cmdlet and the InMemory parameter to create a virtual policy with the Identity RedmondAccessPolicy; this virtual policy is stored in a variable named $x. -The next three commands are used to modify 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. @@ -108,7 +128,7 @@ If you need to make changes to an existing policy, use the Set-CsExternalAccessP ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -125,7 +145,7 @@ For example, the Description might include information about the users the polic ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -137,47 +157,90 @@ Accept wildcard characters: False ### -EnableFederationAccess Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. -The default value is False. +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideAccess -Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. -The default value is False. +### -EnableTeamsConsumerAccess +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerInbound +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcsFederationAccess +Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams Required: False Position: Named -Default value: 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. +### -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 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -193,7 +256,7 @@ When set to False, audio and video options in Skype for Business Server will be ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -209,7 +272,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -226,7 +289,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -275,7 +338,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -298,7 +361,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -308,28 +371,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -355,5 +398,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Exte [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md index 8d22b8c522..728455d346 100644 --- a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsExternalUserCommunicationPolicy @@ -30,7 +35,7 @@ This cmdlet allows you to block P2P file transfer with Federated partners only. PS C:\> New-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` -This example creates a new policy to block external file transfer. Then you can use `Grant-CsExternalUserCommunicationPolicy` to assign it to an user account. +This example creates a new policy to block external file transfer. Then you can use `Grant-CsExternalUserCommunicationPolicy` to assign it to a user account. ## PARAMETERS @@ -51,7 +56,7 @@ Accept wildcard characters: False ``` ### -EnableFileTransfer -{{Fill EnableFileTransfer Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -66,7 +71,7 @@ Accept wildcard characters: False ``` ### -AllowPresenceVisibility -{{Fill AllowPresenceVisibility Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -81,7 +86,7 @@ Accept wildcard characters: False ``` ### -AllowTitleVisibility -{{Fill AllowTitleVisibility Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -127,7 +132,7 @@ Accept wildcard characters: False ``` ### -Force -{{Fill Force Description}} +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 @@ -197,7 +202,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -210,10 +215,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Set-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) -[Get-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/get-csexternalusercommunicationpolicy?view=skype-ps) +[Get-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsFIPSConfiguration.md b/skype/skype-ps/skype/New-CsFIPSConfiguration.md index f8d03096b3..64a8204ef3 100644 --- a/skype/skype-ps/skype/New-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/New-CsFIPSConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsFIPSConfiguration @@ -25,7 +30,7 @@ New-CsFIPSConfiguration [-Identity] <XdsIdentity> [-Confirm] [-Force] [-InMemory ## DESCRIPTION The Federal Information Processing Standards (FIPS) are a series of standards and guidelines used by computers engaged in work for the United States government; for example, there are FIPS standards that govern the use of such things as cryptography, encryption, and digital signatures. -(See http://www.itl.nist.gov/fipspubs/by-num.htm (http://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. +(See httpss://www.itl.nist.gov/fipspubs/by-num.htm (https://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. If you need to work with the United States government (or with other entities that follow FIPS) then you can enable FIPS compliance in Skype for Business Server. Keep in mind, however, that, for the on-premises version of Skype for Business Server, you have only a single, global collection of FIPS configuration settings: FIPS compliance can only be enabled or disabled for your entire Skype for Business Server implementation. @@ -197,7 +202,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -219,5 +224,3 @@ The New-CsFIPSConfiguration cmdlet creates new instances of the Microsoft.Rtc.Ma [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md index 87e0284c6c..166f9d2ba7 100644 --- a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsFileTransferFilterConfiguration @@ -254,7 +259,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -275,5 +280,3 @@ The New-CsFileTransferFilterConfiguration cmdlet creates new instances of the Mi [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md index 56d701b33c..2b89c659fb 100644 --- a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsGroupPickupUserOrbit @@ -47,7 +52,7 @@ The first parameter after the cmdlet is assumed to be the User parameter value. ### -Orbit Specifies the group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see New-CsCallParkOrbit (https://technet.microsoft.com/en-us/library/gg398936.aspx). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -149,5 +154,3 @@ This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.Gr ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md index 94408abd9c..836ccad607 100644 --- a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsHealthMonitoringConfiguration @@ -284,7 +289,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -306,5 +311,3 @@ The New-CsHealthMonitoringConfiguration cmdlet creates new instances of the Micr [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md index 0f1843e30b..31d525c270 100644 --- a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsHostedVoicemailPolicy @@ -33,6 +38,8 @@ You can call the Get-CsUser cmdlet and check the HostedVoiceMail property to det Policies created at the site scope will be automatically assigned to the users homed on those sites. Policies created at the per-user scope must be assigned to users or contact objects with the Grant-CsHostedVoicemailPolicy cmdlet. +> [!NOTE] +> Cloud Voicemail takes the place of Exchange Unified Messaging (UM) in providing voice messaging functionality for Skype for Business 2019 voice users who have mailboxes on Exchange Server 2019 or Exchange Online, and for Skype for Business Online voice users. For more information please check [Plan Cloud Voicemail service](https://learn.microsoft.com/skypeforbusiness/hybrid/plan-cloud-voicemail) and [Retiring Unified Messaging in Exchange Online](https://techcommunity.microsoft.com/t5/Exchange-Team-Blog/Retiring-Unified-Messaging-in-Exchange-Online/ba-p/608991). ## EXAMPLES @@ -229,7 +236,7 @@ You can return the tenant ID for each of your tenants by running this command: Type: Guid 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 Required: False Position: Named @@ -239,7 +246,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -262,5 +269,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsHostingProvider.md b/skype/skype-ps/skype/New-CsHostingProvider.md index 3adbbfd365..ef1f878ccf 100644 --- a/skype/skype-ps/skype/New-CsHostingProvider.md +++ b/skype/skype-ps/skype/New-CsHostingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsHostingProvider @@ -342,7 +347,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -368,5 +373,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Ed [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - - diff --git a/skype/skype-ps/skype/New-CsHuntGroup.md b/skype/skype-ps/skype/New-CsHuntGroup.md deleted file mode 100644 index 8b7aed8d12..0000000000 --- a/skype/skype-ps/skype/New-CsHuntGroup.md +++ /dev/null @@ -1,493 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsHuntGroup -schema: 2.0.0 ---- - -# New-CsHuntGroup - -## SYNOPSIS -Creates new Call Queue in your Skype for Business Online organization. Call Queues are part of Phone System in Office 365. - -## SYNTAX - -``` -New-CsHuntGroup -Domain <System.String> -Name <System.String> [-AgentAlertTime <Int16>] [-AllowOptOut <System.Boolean>] [-DistributionLists <System.Collections.Generic.List`1[System.Guid]>] - [-LineUri <System.Uri>] [-MusicOnHoldFileContent <System.Byte[]>] [-MusicOnHoldFileName <System.String>] [-OverflowAction <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.OverflowAction>] - [-OverflowActionTarget <System.Uri>] [-OverflowThreshold <Int16>] [-RoutingMethod <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.RoutingMethod>] [-TimeoutAction <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.TimeoutAction>] [-TimeoutActionTarget <System.Uri>] [-TimeoutThreshold <Int16>] [-UseDefaultMusicOnHold <System.Boolean>] - [-WelcomeMusicFileContent <System.Byte[]>] [-WelcomeMusicFileName <System.String>] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Call Queue in your Skype for Business Online organization. Call Queues are part of Phone System in Office 365. - -Note, you need to specify UseDefaultMusicOnHold $True (default is none), or provide MusicOnHoldFileName and MusicOnHoldFileContent. - -MusicOnHoldFileName and MusicOnHoldFileContent cannot be empty so you must specify a valid MusicOnHoldFileName and MusicOnHoldFileContent or set UseDefaultMusicOnHold to true. - -The New-CsHuntGroup cmdlet may suggest additional steps required to complete the Call Queue setup. - -The following parameters are not applicable to Skype for Business Online: AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, PipelineVariable, and Ring. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CsHuntGroup -Name "Help Desk" -Domain "litwareinc.com" -UseDefaultMusicOnHold $true -``` - -This example creates a Call Queue for the organization named "Help Desk" in the domain "litwareinc.com" using default music on hold. - -### -------------------------- Example 2 -------------------------- -``` -$musicOnHoldContent = Get-Content ".\MusicOnHold.wav" -ReadCount 0 -Encoding Byte -$welcomeMusicContent = Get-Content ".\WelcomeMusic.wav" -ReadCount 0 -Encoding Byte -New-CsHuntGroup -Name "Help desk" -Domain "litwareinc.com" -LineUri "tel:+19998881234" -RoutingMethod Attendant -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -AllowOptOut $false -AgentAlertTime 30 -OverflowThreshold 15 -OverflowAction Forward -OverflowActionTarget "sip:backup_user@litwareinc.com" -TimeoutThreshold 30 -TimeoutAction Disconnect -MusicOnHoldFileName "MusicOnHold.wav" -MusicOnHoldFileContent $musicOnHoldContent -WelcomeMusicFileName "WelcomeMusic.wav" -``` - -This example saves the contents of music on hold and welcome music files in temporary variables. Then, it creates a Call Queue for the organization named "Help Desk" in the domain "litwareinc.com" using those contents and other configurable parameters. - - -## PARAMETERS - -### -Domain -The Domain parameter denotes the domain part of the primary uri for the Call Queue. This domain name is validated against the list of domains that the tenant owns. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the Call Queue. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 30 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 30 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOptOut -The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. - -```yaml -Type: System.Collections.Generic.List`1[System.Guid] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LineUri -The LineUri parameter is the phone number for the Call Queue. 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". - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldFileContent -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the content of the audio file. Supported formats are: .wav, .mp3, and .wma. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldFileName -The MusicOnHoldFileName parameter represents music to play when callers are placed on hold. This is the name of the audio file. Supported formats are: .wav, .mp3, and .wma. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 three values: DisconnectWithBusy, Forward, and Voicemail. - -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail - -```yaml -Type: Microsoft.Rtc.Management.Hosted.HuntGroup.Models.OverflowAction -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: DisconnectWithBusy -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a SIP address. Otherwise, this parameter is optional. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 50 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. - -PARAMVALUE: Attendant | Serial - -```yaml -Type: Microsoft.Rtc.Management.Hosted.HuntGroup.Models.RoutingMethod -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Attendant -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following three values: Disconnect, Forward, and Voicemail. The default value is Disconnect. - -PARAMVALUE: Disconnect | Forward | Voicemail - -```yaml -Type: Microsoft.Rtc.Management.Hosted.HuntGroup.Models.TimeoutAction -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Disconnect -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a SIP address. Otherwise, this field is optional. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 1200 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldFileName and MusicOnHoldFileContent. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeMusicFileContent -The WelcomeMusicFileContent parameter represents the audio file to play when callers are connected with the Call Queue. This is the content of the audio file. Supported formats are: .wav, .mp3, .and wma. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeMusicFileName -The WelcomeMusicFileName parameter represents audio file to play when callers are connected with the Call Queue. This is the name to the audio file. Supported formats are: .wav, .mp3, and .wma. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassDualWrite -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAudience -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for Microsoft internal use only. - -PARAMVALUE: Fqdn - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HuntGroupServiceCallbackUri -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.HuntGroup.Models.HuntGroup - -## NOTES - -## RELATED LINKS -[Create a Phone System Call Queue](https://support.office.com/en-us/article/Create-a-Phone-System-call-queue-67ccda94-1210-43fb-a25b-7b9785f8a061) - diff --git a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md index 1479cb3fde..55b09cfd15 100644 --- a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsHybridApplicationEndpoint @@ -24,13 +29,13 @@ Skype for Business application endpoint can be connected to the Skype for Busine Hybrid connectivity between Skype for Business Server and Skype for Business Online means users of a domain, such as contoso.com, are split between using Skype for Business Server on premises and Skype for Business Online. Some of the domain users are homed on premises, and some users are homed online. Application endpoint will be configured as online users reachable by the on-premises users. -Before `New-CsHybridApplicationEndpoint` you must run `New-CsOnlineApplicationEndpoint` to register your application endpoint in Skype for Business Online. Please make sure that the `New-CsHybridApplicationEndpoint` parameters: ApplicationId, DisplayName and SipAddress have the same values as `New-CsOnlineApplicationEndpoint` parameters: ApplicationID, Name and Uri, respectively. +`New-CsHybridApplicationEndpoint` must be run in Skype for Business Server. It will be copied to Skype for Business Online via dir sync. ## EXAMPLES ### -------------------------- 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" +PS C:\> New-CsHybridApplicationEndpoint -ApplicationId 41ec7d50-ba91-1208-73ee-136b88859725 -DisplayName NewBot1 -SipAddress sip:newbot1@litwareinc.com -OU "ou=Redmond,dc=litwareinc,dc=com" ``` This example creates a hybrid application endpoint named NewBot1 in Skype for Business Server. This application was created using the Skype for Business Bot Framework which allows you to build and connect intelligent bots to interact with your Skype for Business users using text, cards, or speech. @@ -38,7 +43,11 @@ This example creates a hybrid application endpoint named NewBot1 in Skype for Bu ## PARAMETERS ### -ApplicationId -The ApplicationId for the application endpoint that is being created. +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: +* Auto Attendant: ce933385-9390-45d1-9512-c8d228074e07 +* Call Queue: 11cd3e2e-fccb-42ad-ad00-878b93575e07 ```yaml Type: Guid @@ -102,7 +111,7 @@ Accept wildcard characters: False ``` ### -OU -Active Directory Organizational Unit (OU) for the disabled user to be created. Wait for the newly created user object to be directory synced to the Azure Active Directory or start a new directory sync cycle by running the [Start-ADSyncSyncCycle](https://docs.microsoft.com/en-us/azure/active-directory/connect/active-directory-aadconnectsync-feature-scheduler#start-the-scheduler) on the domain controller machine. +Active Directory Organizational Unit (OU) for the disabled user to be created. Wait for the newly created user object to be directory synced to the Microsoft Entra ID or start a new directory sync cycle by running the [Start-ADSyncSyncCycle](https://learn.microsoft.com/azure/active-directory/connect/active-directory-aadconnectsync-feature-scheduler#start-the-scheduler) on the domain controller machine. ```yaml Type: OUIdParameter @@ -167,7 +176,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -181,8 +190,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[Get-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsHybridPSTNSite.md b/skype/skype-ps/skype/New-CsHybridPSTNSite.md index d4881cb145..7bd818bd11 100644 --- a/skype/skype-ps/skype/New-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/New-CsHybridPSTNSite.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsHybridPSTNSite @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the New-CsHybridPSTNSite cmdlet to create a new hybrid public switched telephone network (PSTN) site. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -214,24 +221,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -246,4 +237,3 @@ The New-CsHybridPSTNSite cmdlet returns instances of the HybridPstnSite object. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsImConfiguration.md b/skype/skype-ps/skype/New-CsImConfiguration.md index 556f2eeee7..bff157c1c2 100644 --- a/skype/skype-ps/skype/New-CsImConfiguration.md +++ b/skype/skype-ps/skype/New-CsImConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsImConfiguration @@ -97,7 +102,7 @@ Accept wildcard characters: False ``` ### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>. +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 @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -158,8 +163,8 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsImFilterConfiguration.md b/skype/skype-ps/skype/New-CsImFilterConfiguration.md index df3d374f65..07c90a6de3 100644 --- a/skype/skype-ps/skype/New-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/New-CsImFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsImFilterConfiguration @@ -301,7 +306,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -322,4 +327,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFil [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md b/skype/skype-ps/skype/New-CsImTranslationConfiguration.md index 3c75cb6a9e..02129499f3 100644 --- a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/New-CsImTranslationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsImTranslationConfiguration @@ -211,7 +216,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -220,5 +225,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsIssuedCertId.md b/skype/skype-ps/skype/New-CsIssuedCertId.md index 6cab77a537..0303d409ac 100644 --- a/skype/skype-ps/skype/New-CsIssuedCertId.md +++ b/skype/skype-ps/skype/New-CsIssuedCertId.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsIssuedCertId @@ -111,7 +116,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -129,5 +134,3 @@ New-CsIssuedCertId creates instances of the Microsoft.Rtc.Management.WritableCon ## RELATED LINKS [New-CsSipProxyTLS](New-CsSipProxyTLS.md) - - diff --git a/skype/skype-ps/skype/New-CsKerberosAccount.md b/skype/skype-ps/skype/New-CsKerberosAccount.md index a50fcd9076..85ed0abd14 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccount.md +++ b/skype/skype-ps/skype/New-CsKerberosAccount.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsKerberosAccount @@ -168,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -186,5 +191,3 @@ The New-CsKerberosAccount cmdlet creates new instances of the Microsoft.Rtc.Mana ## RELATED LINKS [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) - - diff --git a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md index 1dcbb727b9..d02844a752 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsKerberosAccountAssignment @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -188,4 +193,3 @@ The New-CsKerberosAccountAssignment cmdlet creates new instances of the Microsof [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/New-CsLocationPolicy.md b/skype/skype-ps/skype/New-CsLocationPolicy.md index 78e906657c..bea3233f4e 100644 --- a/skype/skype-ps/skype/New-CsLocationPolicy.md +++ b/skype/skype-ps/skype/New-CsLocationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsLocationPolicy @@ -470,7 +475,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -499,5 +504,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Locatio [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - - diff --git a/skype/skype-ps/skype/New-CsMcxConfiguration.md b/skype/skype-ps/skype/New-CsMcxConfiguration.md index 5f426e95f1..58a5312e5f 100644 --- a/skype/skype-ps/skype/New-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/New-CsMcxConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsMcxConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsMcxConfiguration @@ -266,7 +271,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -282,5 +287,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.M ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsMediaConfiguration.md b/skype/skype-ps/skype/New-CsMediaConfiguration.md index 6afefe2a4c..b90eef34a2 100644 --- a/skype/skype-ps/skype/New-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/New-CsMediaConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsMediaConfiguration @@ -81,13 +86,7 @@ Accept wildcard characters: False ``` ### -EnableQoS - -QoS monitors the quality of voice signals over a network. -The EnableIncallQoS attribute enables or disables the ability of Skype for Business clients to send the raw data that's required to generate IncallQuality messages. - -Default: False - - +QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. ```yaml Type: Boolean @@ -97,7 +96,7 @@ Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -125,7 +124,6 @@ Accept wildcard characters: False ``` ### -EncryptionLevel - The level of encryption between unified communications devices. Valid values: @@ -198,7 +196,6 @@ 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\>. @@ -301,7 +298,7 @@ Accept wildcard characters: False ``` ### -EnableInCallQoS -When set to True, enables call Quality of Service (QoS) settings. +Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. ```yaml Type: Boolean @@ -317,7 +314,7 @@ Accept wildcard characters: False ``` ### -EnableRtpRtcpMultiplexing -PARAMVALUE: $true | $false +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: Boolean @@ -349,7 +346,7 @@ Accept wildcard characters: False ``` ### -EnableVideoBasedSharing -Use this parameter to enable video based sharing. +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml Type: Boolean @@ -365,7 +362,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -386,5 +383,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsMeetingConfiguration.md b/skype/skype-ps/skype/New-CsMeetingConfiguration.md index cd245894d3..77faa8bbc2 100644 --- a/skype/skype-ps/skype/New-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/New-CsMeetingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsMeetingConfiguration @@ -387,7 +392,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -409,5 +414,3 @@ The New-CsMeetingConfiguration cmdlet creates new instances of the Microsoft.Rtc [Remove-CsMeetingConfiguration](Remove-CsMeetingConfiguration.md) [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsMobilityPolicy.md b/skype/skype-ps/skype/New-CsMobilityPolicy.md index 8c6c6c8b77..5e9016c50f 100644 --- a/skype/skype-ps/skype/New-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/New-CsMobilityPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsMobilityPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # New-CsMobilityPolicy @@ -12,10 +17,10 @@ schema: 2.0.0 Creates a new mobility policy at the site or the per-user scope. Mobility policies determine whether or not a user can use Skype for Business Mobile. These policies also manage a user's ability to employ Call via Work, a feature that enables users to make and receive phone calls on their mobile phone by using their work phone number instead of their mobile phone number. -Mobility policies can also be used to require Wi-Fi connections when making or receiving calls. +Mobility policies can also be used to require Wi-Fi connections when making or receiving IP video/screen share calls. This cmdlet was introduced in the cumulative update for Lync Server 2010: November 2011. -The following parameters are not applicable to Skype for Business Online: AllowAutomaticPstnFallback, AllowCustomerExperienceImprovementProgram, AllowExchangeConnectivity, AllowSaveCallLogs, AsJob, Description, EncryptAppData, Force, Identity, InMemory, PipelineVariable, RequireIntune, Tenant, and VoiceSettings +The following parameters are not applicable to Skype for Business Online: AllowAutomaticPstnFallback, AllowCustomerExperienceImprovementProgram, AllowExchangeConnectivity, AllowSaveCallLogs, Description, EncryptAppData, Force, Identity, InMemory, PipelineVariable, RequireIntune, Tenant, and VoiceSettings ## SYNTAX @@ -42,7 +47,6 @@ Both of these capabilities can be managed by using mobility policies. With 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. -Mobility policies can be used to require Wi-Fi connections and to prevent calls over the cellular network. When you install Skype for Business Server, you will have a single, global mobility policy that applies to all your users. However, administrators can use the New-CsMobilityPolicy cmdlet to create custom policies at either the site or the per-user scope. @@ -56,22 +60,20 @@ In turn, that means that the user will not be able to use Call via Work, regardl To use Call via Work, users must be managed by a voice policy that allows simultaneous ringing. - - ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- -``` +### -------------------------- EXAMPLE 1 -------------------------- + +```powershell 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 $x.EnableOutsideVoice = $False @@ -87,10 +89,10 @@ In command 2, the EnableOutsideVoice property for the virtual policy is set to F After that, command 3 uses the Set-CsMobilityPolicy cmdlet and the Instance parameter to write the changes to Lync Server and create a mobility policy for the Redmond site. If you do not call the Set-CsMobilityPolicy cmdlet, the policy will not be created, and, in fact, will disappear as soon as you end your Windows PowerShell command-line interface session or delete the variable $x. - ## 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. @@ -109,7 +111,7 @@ If you need to make changes to an existing policy, use the Set-CsMobilityPolicy ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -120,6 +122,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. ```yaml @@ -140,14 +143,10 @@ Accept wildcard characters: False 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: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -164,12 +163,10 @@ The default value is True, meaning that VoIP calls are allowed. This parameter was introduced in Lync Server 2013. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -183,12 +180,10 @@ Accept wildcard characters: False When set to True, users are allowed to use Skype for Business Mobile. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -205,12 +200,10 @@ When set to False, users cannot use Call via Work. The default value is True. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -224,12 +217,10 @@ Accept wildcard characters: False Suppresses the display of any non-fatal error message that might occur when running the command. - - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -244,12 +235,10 @@ Accept wildcard characters: False 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: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -259,29 +248,6 @@ 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 WiFi 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: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -RequireWIFIForIPVideo When set to True, the user can use IP video only in calls made when mobile device is connected to a Wi-Fi network. @@ -290,12 +256,10 @@ If this property is set to False (the default value) then the user can make or r This parameter was introduced in Lync Server 2013. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -309,7 +273,6 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -324,12 +287,13 @@ Accept wildcard characters: False ``` ### -AllowAutomaticPstnFallback -{{Fill AllowAutomaticPstnFallback Description}} + +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -343,12 +307,10 @@ Accept wildcard characters: False When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -359,12 +321,15 @@ Accept wildcard characters: False ``` ### -AllowDeviceContactsSync -{{Fill AllowDeviceContactsSync Description}} + +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: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -378,12 +343,10 @@ Accept wildcard characters: False 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: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -399,12 +362,10 @@ When set to True (the default value) users will be allowed to save a call log of Note that this setting does not apply to Android devices. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -419,12 +380,10 @@ Accept wildcard characters: False 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: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -438,12 +397,10 @@ Accept wildcard characters: False 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: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -454,12 +411,13 @@ Accept wildcard characters: False ``` ### -EnablePushNotifications -{{Fill EnablePushNotifications Description}} + +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: +Aliases: Applicable: Skype for Business Online Required: False @@ -470,12 +428,13 @@ Accept wildcard characters: False ``` ### -EncryptAppData -{{Fill EncryptAppData Description}} + +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: +Aliases: Applicable: Skype for Business Online Required: False @@ -486,12 +445,13 @@ Accept wildcard characters: False ``` ### -RequireIntune -{{Fill RequireIntune Description}} + +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -509,12 +469,10 @@ When set to False (the default value) mobile users can participate in applicatio If this value is set to True, then users then users will not be able to change their sharing configuration settings. If this value is set to False users can use the Options page to modify their sharing configuration settings. - - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -535,12 +493,10 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` - - ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -551,28 +507,19 @@ Accept wildcard characters: False ``` ### -VoiceSettings -{{Fill VoiceSettings Description}} -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +**VoIPAlways:** WiFi will be used when available, otherwise a call back will be performed. + +**VoIPOverWiFi:** If WiFi is not available, a call back to the pre-defined phone number will be performed. -### -AsJob -{{Fill AsJob Description}} +**Cellular:** Always perform a call back to the pre-defined phone number. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -583,18 +530,20 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` + +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -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-CsMobilityPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility + Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object. ### System.Object @@ -602,5 +551,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mob ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md b/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md index 6a2b98dcef..cb3e77828a 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md +++ b/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkBWAlternatePath @@ -94,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/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -113,4 +118,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [New-CsNetworkRegion](New-CsNetworkRegion.md) [Set-CsNetworkRegion](Set-CsNetworkRegion.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md b/skype/skype-ps/skype/New-CsNetworkBWPolicy.md index e68f8dbfa7..f6cd2973a3 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md +++ b/skype/skype-ps/skype/New-CsNetworkBWPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkBWPolicy @@ -113,7 +118,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -132,4 +137,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [New-CsNetworkBandwidthPolicyProfile](New-CsNetworkBandwidthPolicyProfile.md) [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md index ba8ca35cae..0c27af1dff 100644 --- a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkBandwidthPolicyProfile @@ -268,7 +273,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -291,4 +296,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) [New-CsNetworkBWPolicy](New-CsNetworkBWPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md index 2980eeae1e..5a44fa962c 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkInterRegionRoute @@ -234,7 +239,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -255,5 +260,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md index 53a8d0931a..445ced2da8 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkInterSitePolicy @@ -207,7 +212,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -228,5 +233,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md b/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md index da3f01b95c..37c19d474c 100644 --- a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md +++ b/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkmediabypassconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkMediaBypassConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # New-CsNetworkMediaBypassConfiguration @@ -12,9 +17,6 @@ schema: 2.0.0 Creates new global settings for media bypass. This cmdlet was introduced in Lync Server 2010. - - - ## SYNTAX ``` @@ -35,8 +37,6 @@ The object created by this cmdlet must be saved to a variable and then assigned The settings created with this cmdlet can be retrieved only by accessing the MediaBypassSettings property of the global network configuration. To retrieve these settings, run this command: (Get-CsNetworkConfiguration).MediaBypassSettings. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -56,7 +56,7 @@ Setting Enabled to True enables media bypass, while setting AlwaysBypass to True The media bypass configuration is stored with the network configuration settings. Therefore, in line 2 of the example, we save the media bypass configuration changes to the network configuration by calling the Set-CsNetworkConfiguration cmdlet and passing the media bypass configuration object ($a) we created in line 1 to the MediaBypassSettings parameter. -The following parameters are not applicable to Skype for Business Online: AsJob, BypassID, EnableDefaultBypassID, EnabledForAudioVideoConferences, ExternalBypassMode, InternalBypassMode, PipelineVariable, and Tenant +The following parameters are not applicable to Skype for Business Online: BypassID, EnableDefaultBypassID, EnabledForAudioVideoConferences, ExternalBypassMode, InternalBypassMode, PipelineVariable, and Tenant ### -------------------------- EXAMPLE 2 -------------------------- @@ -81,7 +81,6 @@ We assign those settings to the variable $a. In line 2 we modify the settings stored in variable $a by assigning the value False ($false) to the AlwaysBypass property. Finally, in line 3 we call the Set-CsNetworkConfiguration cmdlet, passing the MediaBypassSettings parameter the variable $a, which saves the change we made to the AlwaysBypass property. - ## PARAMETERS ### -AlwaysBypass @@ -103,8 +102,6 @@ Setting AlwaysBypass and Enabled both to True will auto-generate a bypass ID tha Default: False - - ```yaml Type: Boolean Parameter Sets: (All) @@ -128,8 +125,6 @@ This ID must be in the format of a GUID (for example, 96f14dea-5170-429a-b92b-f1 However, you will typically not have to set or change this parameter. This value is automatically generated when Enabled is set to True and either: 1) AlwaysBypass is set to True, or 2) the EnableDefaultBypassID parameter is set to True. - - ```yaml Type: String Parameter Sets: (All) @@ -153,7 +148,6 @@ At that point bypass decisions will be based on the value of the AlwaysBypass se Default: False - ```yaml Type: Boolean Parameter Sets: (All) @@ -180,8 +174,6 @@ Any subnets associated with the core need not be defined and bypass will automat Default: False - - ```yaml Type: Boolean Parameter Sets: (All) @@ -202,8 +194,6 @@ External media bypass is not supported in Skype for Business Server. Default: Off - - ```yaml Type: BypassModeEnumType Parameter Sets: (All) @@ -225,9 +215,6 @@ Other values for this parameter are reserved for future use. Default: Off - - - ```yaml Type: BypassModeEnumType Parameter Sets: (All) @@ -246,9 +233,6 @@ Accept wildcard characters: False Indicates whether media bypass should be used for audio/video conferences. The default value is False ($False). - - - ```yaml Type: Boolean Parameter Sets: (All) @@ -279,7 +263,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -300,4 +284,3 @@ Creates an object reference of type Microsoft.Rtc.Management.WritableConfig.Sett [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) [Set-CsNetworkConfiguration](Set-CsNetworkConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkRegion.md b/skype/skype-ps/skype/New-CsNetworkRegion.md index 176ee8ce4e..eee2fe72cc 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegion.md +++ b/skype/skype-ps/skype/New-CsNetworkRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkRegion @@ -330,7 +335,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -353,5 +358,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Get-CsNetworkRegion](Get-CsNetworkRegion.md) [New-CsNetworkBWAlternatePath](New-CsNetworkBWAlternatePath.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkRegionLink.md b/skype/skype-ps/skype/New-CsNetworkRegionLink.md index 668f95e510..20c21b9c30 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/New-CsNetworkRegionLink.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkRegionLink @@ -210,7 +215,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -235,5 +240,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Se [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) [New-CsNetworkSite](New-CsNetworkSite.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkSite.md b/skype/skype-ps/skype/New-CsNetworkSite.md index 91401ee494..160f838625 100644 --- a/skype/skype-ps/skype/New-CsNetworkSite.md +++ b/skype/skype-ps/skype/New-CsNetworkSite.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkSite @@ -322,7 +327,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -351,5 +356,3 @@ Create an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Networ [Get-CsLocationPolicy](Get-CsLocationPolicy.md) [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkSubnet.md b/skype/skype-ps/skype/New-CsNetworkSubnet.md index 1a51e05d12..38d0bfaf72 100644 --- a/skype/skype-ps/skype/New-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/New-CsNetworkSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsNetworkSubnet @@ -247,7 +252,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -270,4 +275,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) [Get-CsNetworkSite](Get-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/New-CsOAuthServer.md b/skype/skype-ps/skype/New-CsOAuthServer.md index dc850d7119..683832a330 100644 --- a/skype/skype-ps/skype/New-CsOAuthServer.md +++ b/skype/skype-ps/skype/New-CsOAuthServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsOAuthServer @@ -46,7 +51,7 @@ New-CsOAuthServer -Identity "Office 365" -MetadataUrl "https://sts.office365.mic ``` Example 1 creates a new OAuth Server named "Office 365". -The new server uses the metadata URL https://sts.office365.microsoft.com/metadata/json/1. +The new server uses the metadata URL `https://sts.office365.microsoft.com/metadata/json/1`. ## PARAMETERS @@ -250,7 +255,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -272,5 +277,3 @@ The New-CsOAuthServer cmdlet creates new instances of the Microsoft.Rtc.Manageme [Remove-CsOAuthServer](Remove-CsOAuthServer.md) [Set-CsOAuthServer](Set-CsOAuthServer.md) - - diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md deleted file mode 100644 index 59693d3904..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsOnlineApplicationEndpoint -schema: 2.0.0 ---- - -# New-CsOnlineApplicationEndpoint - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -New-CsOnlineApplicationEndpoint -ApplicationId <Guid> [-CallbackUri <String>] -Name <String> [-Region <String>] - [-Uri] <String> [-Audience <String>] [-Ring <String>] [-PhoneNumber <String>] [-IsInternalRun <Boolean>] - [-Tenant <System.Guid>] [-RunFullProvisioningFlow <System.Boolean>] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The following parameters are not applicable to Skype for Business Online: AsJob, Audience, CallbackUri, DomainController, Force, IsInternalRun, PipelineVariable, Region, Ring, and RunFullProvisioningFlow - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - - -## PARAMETERS - -### -ApplicationId -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallbackUri -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -{{Fill RunFullProvisioningFlow Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsOnlineAudioFile.md b/skype/skype-ps/skype/New-CsOnlineAudioFile.md deleted file mode 100644 index 28ab6d503c..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineAudioFile.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOnlineAudioFile -schema: 2.0.0 ---- - -# New-CsOnlineAudioFile - -## SYNOPSIS -Use the New-CsOnlineAudioFile cmdlet to create a new audio file. - -## SYNTAX - -``` -New-CsOnlineAudioFile -FileName <String> -Content <Byte[]> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOnlineAudioFile cmdlet creates a new audio file for use with the Organizational Auto Attendant (OAA) service. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$content = Get-Content "C:\Media\Welcome.wav" -Encoding byte -ReadCount 0 -$audioFile = New-CsOnlineAudioFile -FileName "Hello.wav" -Content $content -``` - -This example creates a new audio file using the WAV content that has a filename of Hello.wav. - -## PARAMETERS - -### -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. - -```yaml -Type: System.string -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.Online.Models.AudioFile - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md b/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md deleted file mode 100644 index 6ad5e625bf..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsOnlineBulkAssignmentInput -schema: 2.0.0 ---- - -# New-CsOnlineBulkAssignmentInput - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -New-CsOnlineBulkAssignmentInput [-Identity] <UserIdParameter> [-TelephoneNumber <String>] - [-LocationID <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - - -## PARAMETERS - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationID -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsOnlineDateTimeRange.md b/skype/skype-ps/skype/New-CsOnlineDateTimeRange.md deleted file mode 100644 index c9c573eaf7..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineDateTimeRange.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOnlineDateTimeRange -schema: 2.0.0 ---- - -# New-CsOnlineDateTimeRange - -## SYNOPSIS -Use the New-CsOnlineDateTimeRange cmdlet to create a new date-time range. - -## SYNTAX - -``` -New-CsOnlineDateTimeRange -Start <String> [-End <String>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOnlineDateTimeRange cmdlet creates a new date-time range to be used with the Organizational Auto Attendant (OAA) service. Date time ranges are used to form schedules. - -**NOTE** -- The start bound of the range must be less than its end bound. -- The time part of the range must be aligned with 30/60-minutes boundaries. -- A date time range bound can only be input in the following formats: - - "d/m/yyyy H:mm" - - "d/m/yyyy" (the time component of the date-time range is set to 00:00) - - -## EXAMPLES - -### Example 1 -``` -$dtr = New-CsOnlineDateTimeRange -Start "1/1/2017" -``` - -This example creates a date-time range for spanning from January 1, 2017 12AM to January 2, 2017 12AM. - -### Example 2 -``` -$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017 09:00" -End "27/12/2017 00:00" -``` - -This example creates a date-time range spanning from December 24, 2017 9AM to December 27, 2017 12AM. - -## PARAMETERS - -### -Start -The Start parameter represents the start bound of the date-time range. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -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. - -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.Online.Models.DateTimeRange - -## NOTES - -## RELATED LINKS - -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) diff --git a/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md deleted file mode 100644 index aa159fdf37..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,417 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsOnlineLisCivicAddress -schema: 2.0.0 ---- - -# New-CsOnlineLisCivicAddress - -## SYNOPSIS -Use the New-CsOnlineLisCivicAddress cmdlet to create a civic address in the Location Information Service (LIS.) - -## SYNTAX - -``` -New-CsOnlineLisCivicAddress [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-StreetName <String>] - [-StreetSuffix <String>] [-PostDirectional <String>] [-PreDirectional <String>] [-City <String>] - [-CityAlias <String>] [-StateOrProvince <String>] -CountryOrRegion <String> [-PostalCode <String>] - [-Description <String>] -CompanyName <String> [-CompanyTaxId <String>] [-ValidationStatus <String>] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Because each civic address needs at least one location to assign to users, creating a new civic address also creates a default location. -This is useful in cases where a civic address has no particular sub-locations. -In that scenario you can create the civic address using the New -CsOnlineLisCivicAddress cmdlet and use the default location identifier for assignment to users. -The example output from the Get-CsOnlineLisCivicAddress below shows the DefaultLocationId property. - -CivicAddressId : 51a8a6e3-dae4-4653-9a99-a6e71c4c24ac - -HouseNumber : - -HouseNumberSuffix : - -PreDirectional : - -StreetName : - -StreetSuffix : - -PostDirectional : - -City : - -PostalCode : - -StateOrProvince : - -CountryOrRegion : US - -Description : - -CompanyName : MSFT - -DefaultLocationId : 75301b5d-3609-458e-a379-da9a1ab33228 - -ValidationStatus : NotValidated - -NumberOfVoiceUsers : 0 - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New -CsOnlineLisCivicAddress -HouseNumber 3910 -StreetName Smith -StreetSuffix Street -PostDirectional NE -City Redmond -StateorProvince Washington -Country US -PostalCode 98052 -Description "West Coast Headquarters" -CompanyName Contoso -``` - -This example creates a new civic address described as "West Coast Headquarters": 3910 Smith Street NE, Redmond WA, 98052. - -## PARAMETERS - -### -CompanyName -Specifies the name of your organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the city of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CityAlias -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyTaxId -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an administrator defined description of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumber -Specifies the numeric portion of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumberSuffix -Specifies the numeric suffix of the 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". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the postal code of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostDirectional -Specifies the directional attribute of the new civic address which follows the street name. -For example, "425 Smith Avenue NE". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreDirectional -Specifies the directional attribute of the new civic address which precedes the street name. -For example, "425 NE Smith Avenue ". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -Specifies the state or province of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetName -Specifies the street name of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -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. - -```yaml -Type: String -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 -``` - -### -ValidationStatus -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### -None - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsOnlineLisLocation.md b/skype/skype-ps/skype/New-CsOnlineLisLocation.md deleted file mode 100644 index 1e673be0e3..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineLisLocation.md +++ /dev/null @@ -1,403 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsOnlineLisLocation -schema: 2.0.0 ---- - -# New-CsOnlineLisLocation - -## SYNOPSIS -Use the New-CsOnlineLisLocation cmdlet to either to create a new emergency dispatch location within an existing civic address, or to create both a new civic address and a location assigned to that address. -There can be multiple locations in a civic address. -Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. - -## SYNTAX - -### ExistingCivicAddress (Default) -``` -New-CsOnlineLisLocation -CivicAddressId <Guid> -Location <String> [-CompanyName <String>] - [-CompanyTaxId <String>] [-HouseNumberSuffix <String>] [-CityAlias <String>] [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateCivicAddress -``` -New-CsOnlineLisLocation [-Location <String>] [-CompanyName <String>] [-CompanyTaxId <String>] - [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-StreetName <String>] [-StreetSuffix <String>] - [-PostDirectional <String>] [-PreDirectional <String>] [-City <String>] [-CityAlias <String>] - [-StateOrProvince <String>] -CountryOrRegion <String> [-PostalCode <String>] [-Description <String>] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CsOnlineLisLocation -CivicAddressId b39ff77d-db51-4ce5-8d50-9e9c778e1617 -Location "Office 101, 1st Floor" -``` - -This example creates a new location called "Office 101, 1st Floor" in the civic address specified by its identity. - - -## PARAMETERS - -### -CivicAddressId -Specifies the unique identifier of the civic address that will contain the new location. -If specified, no other address description parameters are allowed. -Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. - -```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 -``` - -### -CountryOrRegion -Specifies the country or region of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -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: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the city of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CityAlias -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyName -Specifies the name of your organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyTaxId -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an administrator defined description of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumber -Specifies the numeric portion of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumberSuffix -Specifies the numeric suffix of the civic address. -For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the postal code of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -Specifies the state or province of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: State -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetName -Specifies the street name of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetSuffix -Specifies the modifier of the street name. -The street suffix will typically be something like street, avenue, way, or boulevard. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md deleted file mode 100644 index 8d4fe1a143..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,742 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsOnlineNumberPortInOrder -schema: 2.0.0 ---- - -# New-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -New-CsOnlineNumberPortInOrder [-Tenant <Guid>] -InventoryType <String> [-TelephoneNumbers <String[]>] - [-LOABase64PayLoad <String>] [-LOAContentType <String>] [-LOAAuthorizingPerson <String>] - [-SubscriberArea <String>] [-SubscriberCity <String>] [-SubscriberCountry <String>] - [-SubscriberStreetName <String>] [-SubscriberBuildingNumber <String>] [-SubscriberZipCode <String>] - [-SubscriberBusinessName <String>] [-BillingTelephoneNumber <String>] [-SubscriberFirstName <String>] - [-SubscriberLastName <String>] [-EmailAddresses <String[]>] [-RequestedFocDate <DateTime>] - [-LosingTelcoPin <String>] [-LosingTelcoAccountId <String>] [-IsPartialPort] - [-SubscriberAddressLine1 <String>] [-SubscriberAddressLine2 <String>] [-SubscriberAddressLine3 <String>] - [-FriendlyName <String>] [-IsManual] [-RequestedFocDateBegin <DateTimeOffset>] - [-RequestedFocDateEnd <System.DateTimeOffset>] [-RangeHolder <String>] [-TelephoneNumberRanges <String[][]>] - [-SubscriberAdditionalInfo <String>] [-SubscriberBuildingNumberSuffix <String>] - [-SubscriberStreetSuffix <String>] [-SubscriberPreDirectional <String>] [-SubscriberPostDirectional <String>] - [-SubscriberDescription <String>] [-SubscriberCounty <String>] [-SubscriberCompanyName <String>] - [-SubscriberCityAlias <String>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - -## PARAMETERS - -### -InventoryType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BillingTelephoneNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsManual -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPartialPort -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAAuthorizingPerson -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOABase64PayLoad -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAContentType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoAccountId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoPin -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RangeHolder -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDateBegin -PARAMVALUE: DateTimeOffset - -```yaml -Type: DateTimeOffset -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDateEnd -PARAMVALUE: DateTimeOffset - -```yaml -Type: DateTimeOffset -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAdditionalInfo -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine1 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine2 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine3 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberArea -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBuildingNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBuildingNumberSuffix -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBusinessName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCityAlias -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCompanyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCountry -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCounty -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberDescription -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberFirstName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberLastName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberPostDirectional -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberPreDirectional -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberStreetName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberStreetSuffix -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberZipCode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberRanges -PARAMVALUE: String\[\]\[\] - -```yaml -Type: String[][] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumbers -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsOnlineSchedule.md b/skype/skype-ps/skype/New-CsOnlineSchedule.md deleted file mode 100644 index 020a2a380f..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineSchedule.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOnlineSchedule -schema: 2.0.0 ---- - -# New-CsOnlineSchedule - -## SYNOPSIS -Use the New-CsOnlineSchedule cmdlet to create a new schedule. - -## SYNTAX - -### WeeklyRecurrentSchedule -``` -New-CsOnlineSchedule -Name <String> -WeeklyRecurrentSchedule [-MondayHours <List>] -[-TuesdayHours <List>] [-WednesdayHours <List>] [-ThursdayHours <List>] [-FridayHours <List>] -[-SaturdayHours <List>] [-SundayHours <List>] [-Complement] [-Tenant <Guid>] [-CommonParameters] -``` - -### FixedSchedule -``` -New-CsOnlineSchedule -Name <String> -FixedSchedule [-DateTimeRanges <List>] [-Tenant <Guid>] [-CommonParameters] -``` - -## DESCRIPTION -The New-CsOnlineSchedule cmdlet creates a new schedule for the Organizational Auto Attendant (OAA) service. The OAA service uses schedules to conditionally execute call flows when a specific schedule is in effect. - -**NOTE** -- The type of the schedule cannot be altered after the schedule is created. -- Currently, only two types of schedules can be created: WeeklyRecurrentSchedule or FixedSchedule. -- The schedule types are mutually exclusive. So a weekly recurrent schedule cannot be a fixed schedule and vice versa. -- For a weekly recurrent schedule, at least one day should have time ranges specified. -- You can create a new time range by using New-CsOnlineTimeRange cmdlet. -- A fixed schedule can be created without any date-time ranges. In this case, it would never be in effect. -- 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. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 -$tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 -$businessHours = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1, $tr2) -TuesdayHours @($tr1, $tr2) -WednesdayHours @($tr1, $tr2) -ThursdayHours @($tr1, $tr2) -FridayHours @($tr1, $tr2) -``` - -This example creates a weekly recurrent schedule that is active on Monday-Friday from 9AM-12PM and 1PM-5PM. - -### -------------------------- Example 2 -------------------------- -``` -$tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 -$tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 -$afterHours = New-CsOnlineSchedule -Name " After Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1, $tr2) -TuesdayHours @($tr1, $tr2) -WednesdayHours @($tr1, $tr2) -ThursdayHours @($tr1, $tr2) -FridayHours @($tr1, $tr2) -Complement -``` - -This example creates a weekly recurrent schedule that is active at all times except Monday-Friday, 9AM-12PM and 1PM-5PM. - -### -------------------------- Example 3 -------------------------- -``` -$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" -$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) -``` - -This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017. - -### -------------------------- Example 4 -------------------------- -``` -$dtr1 = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" -$dtr2 = New-CsOnlineDateTimeRange -Start "24/12/2018" -End "26/12/2018" -$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr1, $dtr2) -``` - -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 -------------------------- -``` -$dtr1 = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" -$dtr2 = New-CsOnlineDateTimeRange -Start "24/12/2018" -End "26/12/2018" -$notInEffectSchedule = New-CsOnlineSchedule -Name "NotInEffect" -FixedSchedule -``` - -This example creates a fixed schedule that is never active. - -## PARAMETERS - -### -Name -The Name parameter represents a unique friendly name for the schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: SwitchParameter -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MondayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TuesdayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WednesdayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThursdayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FridayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SaturdayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SundayHours -List of time ranges for that day. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: WeeklyRecurrentSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FixedSchedule -The FixedSchedule parameter indicates that a fixed schedule is to be created. - -```yaml -Type: SwitchParameter -Parameter Sets: FixedSchedule -Aliases: -Applicable: Skype for Business Online - -Required: True -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. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: FixedSchedule -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.Online.Models.Schedule - - -## NOTES - -## RELATED LINKS - -[New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) - -[New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) - -[New-CsOrganizationalAutoAttendantCallFlow](New-CsOrganizationalAutoAttendantCallFlow.md) diff --git a/skype/skype-ps/skype/New-CsOnlineTimeRange.md b/skype/skype-ps/skype/New-CsOnlineTimeRange.md deleted file mode 100644 index 1d54694018..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineTimeRange.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOnlineTimeRange -schema: 2.0.0 ---- - -# New-CsOnlineTimeRange - -## SYNOPSIS -The New-CsOnlineTimeRange cmdlet creates a new time range. - -## SYNTAX - -``` -New-CsOnlineTimeRange -Start <TimeSpan> -End <TimeSpan> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOnlineTimeRange cmdlet creates a new time range to be used with the Organizational Auto Attendant (OAA) service. Time ranges are used to form schedules. - -**NOTE** -- The start bound of the range must be less than its end bound. -- A time range must be aligned with 30/60-minutes boundaries. -- A time range can span from one minute to 24 hours. - - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -$allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00 -``` - -This example creates a 24-hour time range. - - -## PARAMETERS - -### -Start -The Start parameter represents the start bound of the time range. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -End -The End parameter represents the end bound of the time range. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.Online.Models.TimeRange - - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsOnlineVoiceRoute.md b/skype/skype-ps/skype/New-CsOnlineVoiceRoute.md deleted file mode 100644 index 693f65135b..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineVoiceRoute.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# 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). - -## SYNTAX - -### Identity (Default) -``` -New-CsOnlineVoiceRoute [-Tenant <Guid>] [-Description <String>] [-NumberPattern <String>] - [-OnlinePstnUsages <PSListModifier>] [-OnlinePstnGatewayList <PSListModifier>] [-Priority <Int32>] - [-Identity] <XdsGlobalRelativeIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentAndRelativeKey -``` -New-CsOnlineVoiceRoute [-Tenant <Guid>] -Name <String> [-Description <String>] [-NumberPattern <String>] - [-OnlinePstnUsages <PSListModifier>] [-OnlinePstnGatewayList <PSListModifier>] [-Priority <Int32>] [-InMemory] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to create a new online voice route. All online voice routes are created at the Global scope. However, multiple global voice routes can be defined. This is accomplished through the Identity parameter, which requires a unique route name. - -Voice routes are associated with online voice policies through online PSTN usages. A voice route includes a regular expression that identifies which phone numbers will be routed through a given voice route: phone numbers matching the regular expression will be routed through this route. - -This cmdlet is used when configuring Microsoft Phone System Direct Routing. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> 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 -------------------------- -``` -PS C:\> New-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} -OnlinePstnGatewayList @{add="OnlinePstnGateway: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 -------------------------- -``` -PS C:\> $x = (Get-CsOnlinePstnUsage).Usage - -New-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add=$x} -``` - -This example creates a new online voice route named Route1 and populates that route's list of PSTN usages with all the existing usages for the organization. The first command in this example retrieves the list of global online PSTN usages. Notice that the call to the `Get-CsOnlinePstnUsage` cmdlet is in parentheses; this means that we first retrieve an object containing PSTN usage information. (Because there is only one, global, online PSTN usage, only one object will be retrieved.) The command then retrieves the Usage property of this object. That property, which contains a list of usages, is assigned to the variable $x. In the second line of this example, the `New-CsOnlineVoiceRoute` cmdlet is called to create a new online voice route. This voice route will have an identity of Route1. Notice the value passed to the OnlinePstnUsages parameter: @{add=$x}. This value says to add the contents of $x, which contain the phone usages list retrieved in line 1, to the list of online PSTN usages for this route. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the 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 description of what this online voice route is for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```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 online 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-CsOnlineVoiceRoute cmdlet.) - -If Identity is specified, the Name must be left blank. The value of the Identity will be assigned to the Name. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The unique name of the voice route. If this parameter is set, the value will be automatically applied to the online 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 -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. - -Default: [0-9]{10} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlinePstnGatewayList -This parameter contains a list of online gateways associated with this online voice route. Each member of this list must be the service Identity of the online PSTN gateway. The service Identity is a string in the format OnlinePstnGateway:<FQDN>, where FQDN is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, OnlinePstnGateway:redmondpool.litwareinc.com. - -By default this list is empty. However, if you leave this parameter blank when creating a new voice route, you'll receive a warning message. - -```yaml -Type: PSListModifier -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, Long Distance, etc.) that can be applied to this online voice route. The PSTN usage must be an existing usage (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). - -By default this list is empty. However, if you leave this parameter blank when creating a new online voice route, you'll receive a warning message. - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -A number could resolve to multiple online 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: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -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-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) - -[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) - -[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md b/skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md deleted file mode 100644 index 133e1536dd..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# New-CsOnlineVoiceRoutingPolicy - -## SYNOPSIS -Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. - -## SYNTAX -### Identity -``` -New-CsOnlineVoiceRoutingPolicy [-Tenant <Guid>] [-OnlinePstnUsages <PSListModifier>] - [-Description <String>] [-RouteType <String>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Skype for Business Online users an online voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks. - -Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Skype for Business Online or Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -Name "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 -------------------------- -``` -PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -Name "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance", "Local", "Internal" -``` - -Example 2 is a variation of the command shown in Example 1; in this case, however, the new policy is assigned three online PSTN usages: Long Distance; Local; Internal. Multiple usages can be assigned simply by separating each usage using a comma. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the 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 an online 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: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -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 voice routing policy. The online PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsOnlinePstnUsage` cmdlet.) - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteType -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 -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -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-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) - -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) - -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) - -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendant.md deleted file mode 100644 index 76e362ec13..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,497 +0,0 @@ ---- -external help file: New-CsOrganizationalAutoAttendant.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendant -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendant - -## SYNOPSIS -Use the New-CsOrganizationalAutoAttendant cmdlet to create a new Auto Attendant (AA). - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendant -Name <String> [-Domain <String>] [-LineUris <>] -LanguageId <String> - [-VoiceId <String>] -DefaultCallFlow <CallFlow> [-Operator <CallableEntity>] [-EnableVoiceResponse] - [-ApplicationId <Guid>] [-CallbackUri <Uri>] [-Ring <String>] [-ClientAudience <Uri>] - -TimeZoneId <String> [-CallFlows <List>] [-Schedules <List>] [-CallHandlingAssociations <List>] - [-InclusionScope <DialScope>] [-ExclusionScope <DialScope>] [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Auto Attendants (AAs) are a key element in the Cloud PBX application. -Each OAA can be associated with a phone number that allows callers to reach specific people in the organization through a directory lookup. -Alternatively, it can route the calls to an operator, a user, another OAA, or a call queue. - -You can create new OAAs by using the New-CsOrganizationalAutoAttendant cmdlet; each newly created OAA gets assigned a random Primary (SIP) URI that serves as the identity of the OAA. - -**NOTE** -- PrimaryUri of OAAs is a SIP URI. -- The default call flow has the lowest precedence, and any custom call flow has a higher precedence and is executed if the schedule associated with it is in effect. -- Holiday call flows have higher priority than after-hours call flows. Thus, if a holiday schedule and an after-hours schedule are both in effect at a particular time, the call flow corresponding to the holiday call flow will be rendered. -- The default call flow can be used either as the 24/7 call flow if no other call flows are specified, or as the business hours call flow if an “after hours” call flow was specified together with the corresponding schedule and call handling association. -- If a user is present in both inclusion and exclusion scopes, then exclusion scope always takes priority, i.e., the user will not be able to be contacted through directory lookup feature. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$lineUri = [System.Uri] "tel:+11098765432" - -$operatorUri = "sip:operator@contoso.com" -$operatorEntity = New-CsOrganizationalAutoAttendantCallableEntity -Identity $operatorUri -Type User - -$greetingPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" -$menuOptionZero = New-CsOrganizationalAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign or press 0 to reach the operator." -$defaultMenu = New-CsOrganizationalAutoAttendantMenu -Name "Default menu" -Prompts @($menuPrompt) -MenuOptions @($menuOptionZero) -EnableDialByName -$defaultCallFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Default call flow" -Greetings @($greetingPrompt) -Menu $defaultMenu - -$afterHoursGreetingPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso! Unfortunately, you have reached us outside of our business hours. We value your call please call us back Monday to Friday, between 9 A.M. to 12 P.M. and 1 P.M. to 5 P.M. Goodbye!" -$automaticMenuOption = New-CsOrganizationalAutoAttendantMenuOption -Action Disconnect -DtmfResponse Automatic -$afterHoursMenu=New-CsOrganizationalAutoAttendantMenu -Name "After Hours menu" -MenuOptions @($automaticMenuOption) -$afterHoursCallFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "After Hours call flow" -Greetings @($afterHoursGreetingPrompt) -Menu $afterHoursMenu - -$timerange1 = New-CsOnlineTimeRange -Start 09:00 -end 12:00 -$timerange2 = New-CsOnlineTimeRange -Start 13:00 -end 17:00 -$afterHoursSchedule = New-CsOnlineSchedule -Name "After Hours Schedule" -WeeklyRecurrentSchedule -MondayHours @($timerange1, $timerange2) -TuesdayHours @($timerange1, $timerange2) -WednesdayHours @($timerange1, $timerange2) -ThursdayHours @($timerange1, $timerange2) -FridayHours @($timerange1, $timerange2) -Complement - -$afterHoursCallHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $afterHoursSchedule.Id -CallFlowId $afterHoursCallFlow.Id - -$inclusionScopeGroupIds = @(“4c3053a6-20bf-43df-bf7a-156124168856”) -$inclusionScope = New-CsOrganizationalAutoAttendantDialScope -GroupScope -GroupIds $inclusionScopeGroupIds - -$o=New-CsOrganizationalAutoAttendant -Name "Main auto attendant" -LineUris @($lineUri) -DefaultCallFlow $defaultCallFlow -EnableVoiceResponse -Schedules @($afterHoursSchedule) -CallFlows @($afterHoursCallFlow) -CallHandlingAssociations @($afterHoursCallHandlingAssociation) -Language "en-US" -TimeZoneId "UTC" -Operator $operatorEntity -InclusionScope $inclusionScope -``` - -This example creates a new OAA named _Main auto attendant_ that has the following properties: - -- A phone number is assigned. -- It sets a default call flow. -- It sets an after-hours call flow. -- It enables voice response. -- The default language is en-US. -- The time zone is set to UTC. -- An inclusion scope is specified. - -### -------------------------- Example 2 -------------------------- -``` -$lineUri = [System.Uri] "tel:+11098765432" - -$operatorUri = "sip:operator@contoso.com" -$operatorEntity = New-CsOrganizationalAutoAttendantCallableEntity -Identity $operatorUri -Type User - -$dcfGreetingPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" -$dcfMenuOptionZero = New-CsOrganizationalAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 -$dcfMenuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign or press 0 to reach the operator." -$dcfMenu=New-CsOrganizationalAutoAttendantMenu -Name "Default menu" -Prompts @($dcfMenuPrompt) -MenuOptions @($dcfMenuOptionZero) -EnableDialByName -$defaultCallFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Default call flow" -Greetings @($dcfGreetingPrompt) -Menu $dcfMenu - -$afterHoursGreetingPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso! Unfortunately, you have reached us outside of our business hours. We value your call please call us back Monday to Friday, between 9 A.M. to 12 P.M. and 1 P.M. to 5 P.M. Goodbye!" -$afterHoursMenuOption = New-CsOrganizationalAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic -$afterHoursMenu=New-CsOrganizationalAutoAttendantMenu -Name "After Hours menu" -MenuOptions @($afterHoursMenuOption) -$afterHoursCallFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "After Hours call flow" -Greetings @($afterHoursGreetingPrompt) -Menu $afterHoursMenu - -$timerange1 = New-CsOnlineTimeRange -Start 09:00 -end 12:00 -$timerange2 = New-CsOnlineTimeRange -Start 13:00 -end 17:00 -$afterHoursSchedule = New-CsOnlineSchedule -Name "After Hours Schedule" -WeeklyRecurrentSchedule -MondayHours @($timerange1, $timerange2) -TuesdayHours @($timerange1, $timerange2) -WednesdayHours @($timerange1, $timerange2) -ThursdayHours @($timerange1, $timerange2) -FridayHours @($timerange1, $timerange2) -Complement - -$afterHoursCallHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $afterHoursSchedule.Id -CallFlowId $afterHoursCallFlow.Id - -$christmasGreetingPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." -$christmasMenuOption = New-CsOrganizationalAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic -$christmasMenu = New-CsOrganizationalAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($christmasMenuOption) -$christmasCallFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Christmas" -Greetings @($christmasGreetingPrompt) -Menu $christmasMenu - -$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" -$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) - -$christmasCallHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $christmasSchedule.Id -CallFlowId $christmasCallFlow.Id - -$o=New-CsOrganizationalAutoAttendant -Name "Main auto attendant" -LineUris @($lineUri) -DefaultCallFlow $defaultCallFlow -EnableVoiceResponse -Schedules @($afterHoursSchedule, $christmasSchedule) -CallFlows @($afterHoursCallFlow, $christmasCallFlow) -CallHandlingAssociations @($afterHoursCallHandlingAssociation, $christmasCallHandlingAssociation) -Language "en-US" -TimeZoneId "UTC" -Operator $operatorEntity -``` - -This example creates a new OAA named _Main auto attendant_ that has the following properties: - -- A phone number is assigned. -- It sets a default call flow. -- It sets an after-hours call flow. -- It sets a call flow for Christmas holiday. -- It enables voice response. -- The default language is en-US. -- The time zone is set to UTC. - -## PARAMETERS - -### -Name -The Name parameter is a friendly name that is assigned to the OAA. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LanguageId -The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. - -You can query the supported languages using the Get-CsOrganizationalAutoAttendantSupportedLanguage cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZoneId -The TimeZoneId parameter represents the OAA time zone. All schedules are evaluated based on this time zone. - -You can query the supported timezones using the Get-CsOrganizationalAutoAttendantSupportedTimeZone cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultCallFlow -The DefaultCallFlow parameter is the flow to be executed when no other call flow is in effect (for example, during business hours). - -You can create the DefaultCallFlow by using the New-CsOrganizationalAutoAttendantCallFlow cmdlet. - -```yaml -Type: CallFlow -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallFlows -The CallFlows parameter represents call flows, which are required if they are referenced in the Associations parameter. - -You can create CallFlows by using the New-CsOrganizationalAutoAttendantCallFlow cmdlet. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedules -The Schedules parameter reflects schedules that are associated with the OAA. Schedules are required if they are referenced in the CallHandlingAssociations parameter. - -You can create schedules by using the New-CsOnlineSchedule cmdlet. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallHandlingAssociations -The CallHandlingAssociations parameter represents the call handling associations. -The OAA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. - -You can create CallHandlingAssociations by using the New-CsOrganizationalAutoAttendantCallHandlingAssociation cmdlet. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LineUris -The LineUris parameter represents PSTN numbers that are assigned to the OAA. -PSTN numbers must be your Service number or Toll-free number; User PSTN Numbers (normal numbers) cannot be added to Auto Attendant. -Each 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: `-LineUris [System.Uri]"tel:+4255551219"`. - -Note: Only PSTN numbers that are acquired through or migrated to Skype for Business Online are supported. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operator -The Operator parameter represents the SIP address or PSTN number of the operator. - -You can create callable entities by using the New-CsOrganizationalAutoAttendantCallableEntity cmdlet. - -```yaml -Type: CallableEntity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter represents the domain part of the Primary (SIP) URI that is generated for the OAA. -The domain name is validated against the list of domains that are configured by the tenant. -If not provided, then a domain is randomly chosen for primary URI. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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. - -You can query the supported voices by using the Get-CsOrganizationalAutoAttendantSupportedLanguage cmdlet. You can determine the default voice for a language by issuing the following command: - -``` -$language = Get-CsOrganizationalAutoAttendantSupportedLanguage -Identity "en-US"` -$defaultVoice = $language.Voices[0].Gender -``` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableVoiceResponse -The EnableVoiceResponse parameter indicates whether voice response for OAA is enabled. - -```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 -``` - -### -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. - -Dial scopes can be created by using the New-CsOrganizationalAutoAttendantDialScope cmdlet. - -```yaml -Type: DialScope -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -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. - -Dial scopes can be created by using the New-CsOrganizationalAutoAttendantDialScope cmdlet. - - -```yaml -Type: DialScope -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies a custom application ID to use for OAAs. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallbackUri -Specifies a custom Callback URI for OAAs. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAudience -Specifies a custom client audience for OAAs. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -Specifies a custom ring for OAAs. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Rtc.Management.OAA.Models.OrgAutoAttendant - - -## NOTES - - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendantCallFlow](New-CsOrganizationalAutoAttendantCallFlow.md) - -[New-CsOrganizationalAutoAttendantCallHandlingAssociation](New-CsOrganizationalAutoAttendantCallHandlingAssociation.md) - -[New-CsOrganizationalAutoAttendantCallableEntity](New-CsOrganizationalAutoAttendantCallableEntity.md) - -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) - -[Get-CsOrganizationalAutoAttendantSupportedLanguage](Get-CsOrganizationalAutoAttendantSupportedLanguage.md) - -[Get-CsOrganizationalAutoAttendantSupportedTimeZone](Get-CsOrganizationalAutoAttendantSupportedTimeZone.md) - diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallFlow.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallFlow.md deleted file mode 100644 index 25def48319..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallFlow.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: New-CsOrganizationalAutoAttendantCallFlow.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantCallFlow -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantCallFlow - -## SYNOPSIS -Use the New-CsOrganizationalAutoAttendantCallFlow cmdlet to create a new call flow. - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendantCallFlow -Name <String> [-Greetings <List>] -Menu <Menu> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOrganizationalAutoAttendantCallFlow cmdlet creates a new call flow for use with the Auto Attendant (AA) service. The OAA service uses the call flow to handle inbound calls by playing a greeting (if present), and provide callers with actions through a menu. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName -$callFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -``` - -This example creates a new call flow that renders the “Default Menu” menu. - -### -------------------------- Example 2 -------------------------- -``` -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName -$greeting = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" -$callFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting -``` - -This example creates a new call flow that plays a greeting before rendering the “Default Menu” menu. - -## PARAMETERS - -### -Name -The Name parameter represents a unique friendly name for the call flow. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Menu -The Menu parameter identifies the menu to render when the call flow is executed. - -You can create a new menu by using the New-CsOrganizationalAutoAttendantMenu cmdlet. - -```yaml -Type: Menu -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -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. - -You can create prompts by using the New-CsOrganizationalAutoAttendantPrompt cmdlet. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.CallFlow - - -## NOTES - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendantMenu](New-CsOrganizationalAutoAttendantMenu.md) - -[New-CsOrganizationalAutoAttendantPrompt](New-CsOrganizationalAutoAttendantPrompt.md) diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md deleted file mode 100644 index 041291ed75..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantCallHandlingAssociation -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantCallHandlingAssociation - -## SYNOPSIS -Use the New-CsOrganizationalAutoAttendantCallHandlingAssociation cmdlet to create a new call handling association. - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendantCallHandlingAssociation -CallFlowId <String> -ScheduleId <String> -Type <AfterHours | Holiday> [-Disable] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOrganizationalAutoAttendantCallHandlingAssociation cmdlet creates a new call handling association to be used with the Auto Attendant (AA) service. The OAA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 -$schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -$scheduleId = $schedule.Id - -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName -$callFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -$callFlowId = $callFlow.Id - -$callHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $scheduleId -CallFlowId $callFlowId -``` - -This example creates a new after-hours call handling association. - -### -------------------------- Example 2 -------------------------- -``` -$tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 -$schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -$scheduleId = $schedule.Id - -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName -$callFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -$callFlowId = $callFlow.Id - -$disabledCallHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $scheduleId -CallFlowId $callFlowId -Disable -``` - -This example creates a disabled after-hours call handling association. - -### -------------------------- Example 3 -------------------------- -``` -$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -$schedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) -$scheduleId = $schedule.Id - -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "We are closed for Christmas. Please call back later." -$menuOption = New-CsOrganizationalAutoAttendantMenuOption -DtmfResponse Automatic -Action DisconnectCall -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($menuOption) -$callFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Christmas" -Greetings @($greeting) -Menu $menu -$callFlowId = $callFlow.Id - -$callHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $scheduleId -CallFlowId $callFlowId -``` - -This example creates a holiday call handling association. - -## PARAMETERS - -### -CallFlowId -The CallFlowId parameter represents the call flow to be associated with the schedule. - -You can create a call flow by using the New-CsOrganizationalAutoAttendantCallFlow cmdlet. - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleId -The ScheduleId parameter represents the schedule to be associated with the call flow. - -You can create a schedule by using the New-CsOnlineSchedule cmdlet - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter represents the type of the call handling association. Currently, only AfterHours and Holiday are supported. - - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -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. - -```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 - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Rtc.Management.OAA.Models.CallHandlingAssociation - - -## NOTES - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendantCallFlow](New-CsOrganizationalAutoAttendantCallFlow.md) - -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallableEntity.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallableEntity.md deleted file mode 100644 index b32e21754b..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallableEntity.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantCallableEntity -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantCallableEntity - -## SYNOPSIS -The New-CsOrganizationalAutoAttendantCallableEntity cmdlet lets you create a callable entity. - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendantCallableEntity -Identity <String> -Type <User | OrganizationalAutoAttendant | HuntGroup> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOrganizationalAutoAttendantCallableEntity cmdlet lets you create a callable entity for use with call transfers from the Auto Attendant service. Callable entities can be created using either SIP or TEL URIs and can refer to any of the following entities: - -- User -- OrganizationalAutoAttendant -- HuntGroup - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$callableEntity = New-CsOrganizationalAutoAttendantCallableEntity -Identity sip:operator@contoso.com -Type User -``` - -This example creates a user callable entity. - -### -------------------------- Example 2 -------------------------- -``` -$callableEntity = New-CsOrganizationalAutoAttendantCallableEntity -Identity "tel:+1234567890" -Type OrganizationalAutoAttendant -``` - -This example creates an auto attendant callable entity. - -## PARAMETERS - -### -Identity -The Identity parameter represents the ID of the callable entity; this can be either a SIP URI or a TEL URI. - -- Only the SIP URIs of users that have Enterprise Voice enabled are supported. -- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. -- SIP URIs can be used for a user only. -- TEL URIs can be a user, an auto attendant, or a hunt group (call queue). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter represents the type of the callable entity, which can be any of the following: - -- User -- OrganizationalAutoAttendant -- Huntgroup - - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.OAA.Models.CallableEntity - - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantDialScope.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantDialScope.md deleted file mode 100644 index 88331b4fbc..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantDialScope.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantDialScope -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantDialScope - -## SYNOPSIS -Use New-CsOrganizationalAutoAttendantDialScope cmdlet to create dial-scopes for use with Auto Attendant (AA) service. - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendantDialScope -GroupScope -GroupIds <List> [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet creates a new dial-scope to be used with Auto Attendant (AA) service. OAAs use dial-scopes to restrict the scope of call transfers that can be made through directory lookup feature. - -**NOTE** -- The returned dial-scope model composes a member for the underlying type/implementation, e.g. in case of the group-based dial scope, in order to modify its Group IDs, you can access them through `DialScope.GroupScope.GroupIds`. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$groupIds = @("00000000-0000-0000-0000-000000000000") -$dialScope = New-CsOrganizationalAutoAttendantDialScope -GroupScope -GroupIds $groupIds -``` - -In Example 1, the New-CsOrganizationalAutoAttendantDialScope cmdlet is used to create a dial-scope with a group whose id is 00000000-0000-0000-0000-000000000000. - -## PARAMETERS - -### -GroupScope -Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -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. - -Group IDs can be obtained by using the Find-CsGroup cmdlet. - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.OAA.Models.DialScope - - -## NOTES - -## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenu.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenu.md deleted file mode 100644 index cd62fd7a20..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenu.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantMenu -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantMenu - -## SYNOPSIS -The New-CsOrganizationalAutoAttendantMenu cmdlet creates a new menu. - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendantMenu -Name <String> -MenuOptions <List> [-Prompts <List>] [-EnableDialByName] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOrganizationalAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA) service. The OAA service uses menus to provide callers with choices, and then takes action based on the selection. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName -``` - -This example creates a new menu that allows the caller to reach a target by name. - -### -------------------------- Example 2 -------------------------- -``` -$menuOptionZero = New-CsOrganizationalAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 -$menuPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign. For operator, press zero." -$menu = New-CsOrganizationalAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -MenuOptions @($menuOptionZero) -EnableDialByName -``` - -This example creates a new menu that allows the caller to reach a target by name or the operator by pressing the 0 key. - - -## PARAMETERS - -### -Name -The Name parameter represents a friendly name for the menu. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -You can create menu options by using the New-CsOrganizationalAutoAttendantMenuOption cmdlet. - - -```yaml -Type: System.Collections.Generic.List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prompts -The Prompts parameter reflects the prompts to play when the menu is activated. - -You can create new prompts by using the New-CsOrganizationalAutoAttendantPrompt cmdlet. - - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableDialByName -The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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.Rtc.Management.Hosted.OAA.Models.Menu - - -## NOTES - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendantMenuOption](New-CsOrganizationalAutoAttendantMenuOption.md) -[New-CsOrganizationalAutoAttendantPrompt](New-CsOrganizationalAutoAttendantPrompt.md) - diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenuOption.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenuOption.md deleted file mode 100644 index b6d08c330d..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenuOption.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: New-CsOrganizationalAutoAttendantMenuOption.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantMenuOption -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantMenuOption - -## SYNOPSIS -Use the New-CsOrganizationalAutoAttendantMenuOption cmdlet to create a new menu option. - -## SYNTAX - -``` -New-CsOrganizationalAutoAttendantMenuOption -Action <ActionType> -DtmfResponse <DtmfTone> [-VoiceResponses <List>] - [-CallTarget <CallableEntity>] [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOrganizationalAutoAttendantMenuOption cmdlet creates a new menu option for the Auto Attendant (AA) service. The OAA service uses the menu options to respond to a caller with the appropriate action. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$menuOption = New-CsOrganizationalAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 -``` - -This example creates a menu option to call the operator when the 0 key is pressed. - -### -------------------------- Example 2 -------------------------- -``` -$troubleShootUri = "sip:troubleShoot@contoso.com" -$troubleShootEntity = New-CsOrganizationalAutoAttendantCallableEntity -Identity $troubleShootUri -Type OrganizationalAutoAttendant -$menuOption = New-CsOrganizationalAutoAttendantMenuOption -Action TransferCallToTarget -DtmfResponse Tone1 -VoiceResponses "Sales" -CallTarget $troubleShootEntity -``` - -This example creates a menu option to transfer the call to an auto attendant when the caller speaks the word "Sales" or presses the 1 key. - - -## PARAMETERS - -### -Action -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: - -- DisconnectCall - The call is disconnected. -- TransferCallToOperator - the call is transferred to the operator. -- TransferCallToTarget - The call is transferred to the menu option’s call target. - -```yaml -Type: ActionType -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -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: - -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- Automatic - The action is executed without user response. - -```yaml -Type: DtmfTone -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -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. - -Voice responses are currently limited to one voice response per menu option. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallTarget -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-CsOrganizationalAutoAttendantCallableEntity cmdlet to create new callable entities. - -```yaml -Type: CallableEntity -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 - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.MenuOption - - -## NOTES - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendantCallableEntity](New-CsOrganizationalAutoAttendantCallableEntity.md) diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantPrompt.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantPrompt.md deleted file mode 100644 index 8e109159d2..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantPrompt.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: New-CsOrganizationalAutoAttendantPrompt.xml -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantPrompt -schema: 2.0.0 ---- - -# New-CsOrganizationalAutoAttendantPrompt - -## SYNOPSIS -Use the New-CsOrganizationalAutoAttendantPrompt cmdlet to create a new prompt. - -## SYNTAX - -### AudioFileParamSet (Default) -``` -New-CsOrganizationalAutoAttendantPrompt -AudioFilePrompt <AudioFile> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -### DualParamSet -``` -New-CsOrganizationalAutoAttendantPrompt -ActiveType <PromptType> [-AudioFilePrompt <AudioFile>] - [-TextToSpeechPrompt <String>] [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -### TextToSpeechParamSet -``` -New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt <String> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -The New-CsOrganizationalAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant (AA) service. A prompt is either an audio file that is played, or text that is read aloud to give callers additional information. A prompt can be disabled by setting the ActiveType to None. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$ttsPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" -``` - -This example creates a new prompt that reads the supplied text. - - - -### -------------------------- Example 2 -------------------------- -``` -$content = Get-Content "C:\Media\Welcome.wav" -Encoding byte -ReadCount 0 -$audioFile = New-CsOnlineAudioFile -FileName "hello.wav" -Content $content -$audioFilePrompt = New-CsOrganizationalAutoAttendantPrompt -AudioFilePrompt $audioFile -``` - -This example creates a new prompt that plays the selected audio file. - -### -------------------------- Example 3 -------------------------- -``` -$content = Get-Content "C:\Media\Welcome.wav" -Encoding byte -ReadCount 0 -$audioFile = New-CsOnlineAudioFile -FileName "hello.wav" -Content $content -$dualPrompt = New-CsOrganizationalAutoAttendantPrompt -ActiveType AudioFile -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to Contoso!" -``` - -This example creates a new prompt that has both audio file and text-to-speech data, but will play the audio file when the prompt is activated (rendered). - - -## PARAMETERS - -### -ActiveType -PARAMVALUE: None | TextToSpeech | AudioFile - -The ActiveType parameter identifies the active type (modality) of the OAA 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). - -This is explicitly required if both Audio File and TTS prompts are specified. Otherwise, it is inferred. - -```yaml -Type: PromptType -Parameter Sets: Dual -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AudioFilePrompt -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 New-CsOnlineAudioFile cmdlet. - -```yaml -Type: AudioFile -Parameter Sets: AudioFile, Dual -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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. - -This parameter is required when text to speech prompts are being created. - -```yaml -Type: String -Parameter Sets: TextToSpeech, Dual -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt - - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) - diff --git a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md index 79f19f3ce5..db567dff75 100644 --- a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsOutboundCallingNumberTranslationRule @@ -266,7 +271,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -289,5 +294,3 @@ The New-CsOutboundCallingNumberTranslationRule cmdlet creates new instances of t [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) - - diff --git a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md b/skype/skype-ps/skype/New-CsOutboundTranslationRule.md index adcb592907..73e18b5b4f 100644 --- a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/New-CsOutboundTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsOutboundTranslationRule @@ -271,7 +276,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -292,5 +297,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Se [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) - - diff --git a/skype/skype-ps/skype/New-CsPartnerApplication.md b/skype/skype-ps/skype/New-CsPartnerApplication.md index 8a1984ee11..60a75d1f84 100644 --- a/skype/skype-ps/skype/New-CsPartnerApplication.md +++ b/skype/skype-ps/skype/New-CsPartnerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPartnerApplication @@ -67,12 +72,12 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ### -------------------------- Example 1 -------------------------- ``` -New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationTrustLevel "Full" -MetadataUrl"https://autodiscover.litwareinc.com/metadata/json/1" +New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationTrustLevel "Full" -MetadataUrl "https://autodiscover.litwareinc.com/metadata/json/1" ``` The command shown in Example 1 creates a new partner application with the Identity "MicrosoftExchange". -In this example, the new partner application uses the metadata URL https://autodiscover.litwareinc.com/metadata/json/1. +In this example, the new partner application uses the metadata URL `https://autodiscover.litwareinc.com/metadata/json/1`. ### -------------------------- Example 2 -------------------------- @@ -158,9 +163,9 @@ Accept wildcard characters: False Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these: -`$x = Get-Content "C:\Certificates\PartnerApplication.cer" -Encoding Byte` +`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` -`$y = \[Convert\]::ToBase64String($x)` +`$y = [Convert]::ToBase64String($x)` You can then use this syntax to assign the certificate data stored in the variable $y: @@ -387,7 +392,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -409,4 +414,3 @@ The New-CsPartnerApplication cmdlet creates new instances of the Microsoft.Rtc.M [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) [Set-CsPartnerApplication](Set-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/New-CsPersistentChatAddin.md b/skype/skype-ps/skype/New-CsPersistentChatAddin.md index 4fd6f8c659..6b554367cb 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/New-CsPersistentChatAddin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatAddin @@ -13,8 +18,6 @@ Enables you to configure a new Persistent Chat add-in. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -35,18 +38,16 @@ Instead, the CsPersistentChatAddin cmdlets are used to associate (or disassociat Skype for Business Server Control Panel: To create a new Persistent Chat add-in using the Skype for Business Server Control Panel, click Persistent Chat, click Add-in, and then click New. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- ``` -New-CsPersistentChatAddin -Name "ITPersistentChatAddin" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Url "http://atl-cs-001.litwareinc.com/itchat" +New-CsPersistentChatAddin -Name "ITPersistentChatAddin" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Url "https://atl-cs-001.litwareinc.com/itchat" ``` The command shown in Example 1 creates a new Persistent Chat add-in (with the name ITPersistentChatAddin) for the pool atl-cs-001.litwareinc.com. -The URL parameter and the parameter value http://atl-cs-001.litwareinc.com/itchat specify the location of the add-in's webpage. +The URL parameter and the parameter value `https://atl-cs-001.litwareinc.com/itchat` specify the location of the add-in's webpage. ## PARAMETERS @@ -56,13 +57,11 @@ The URL parameter and the parameter value http://atl-cs-001.litwareinc.com/itcha 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, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -75,13 +74,11 @@ Accept wildcard characters: False 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, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -94,13 +91,11 @@ Accept wildcard characters: False 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, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -110,7 +105,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -133,5 +128,3 @@ The New-CsPersistentChatAddin cmdlet creates new instances of the Microsoft.Rtc. [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatCategory.md b/skype/skype-ps/skype/New-CsPersistentChatCategory.md index 2185849195..807ee1f92c 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/New-CsPersistentChatCategory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatCategory @@ -17,8 +22,6 @@ Instead, existing rooms must later be assigned to a category by using the Set-Cs However, new chat rooms can be assigned to the category at the same time the room is created. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -41,8 +44,6 @@ That means that you must create at least one category before you can add any cha Skype for Business Server Control Panel: To create a new Persistent Chat category using the Skype for Business Server Control Panel, click Persistent Chat, click Category, and then click New. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -65,7 +66,7 @@ Names must be unique per Persistent Chat pool. 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 Required: True Position: Named @@ -82,7 +83,7 @@ For example, the Description might explain the purpose of the category and what 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 Required: False Position: Named @@ -98,7 +99,7 @@ When present, allows file uploads to the chat rooms in the category. 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 Required: False Position: Named @@ -115,7 +116,7 @@ Among other things, this means that users on the AllowedMembers list will automa 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 Required: False Position: Named @@ -131,7 +132,7 @@ Fully qualified domain name of the Persistent Chat pool where the category shoul 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 Required: False Position: Named @@ -148,7 +149,7 @@ Typically, chat history is only disabled for chat rooms that are used for announ 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 Required: False Position: Named @@ -158,7 +159,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -180,4 +181,3 @@ The New-CsPersistentChatCategory cmdlet creates new instances of the Microsoft.R [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md index fdba4d011e..98ea85b68d 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatComplianceConfiguration @@ -13,8 +18,6 @@ Creates a new collection of Persistent Chat compliance configuration settings at Persistent Chat compliance enables administrators to maintain an archive of Persistent Chat items and activities including: new messages; new events (for example, a user entering or existing a chat room); file uploads and downloads; and searches run against the chat history. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -38,8 +41,6 @@ In addition, Persistent Chat compliance can only be managed using the Windows Po Skype for Business Server Control Panel: The functions carried out by the New-CsPersistentChatComplianceConfiguration cmdlet are not available in the Skype for Business Server Control Panel. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -79,7 +80,7 @@ To create new settings at the service scope, use syntax like this: Type: XdsIdentity 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 Required: True Position: 2 @@ -96,7 +97,7 @@ Adapters are third-party products that convert the data in the compliance databa 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 Required: False Position: Named @@ -113,7 +114,7 @@ You must have a separate folder for each adapter. 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 Required: False Position: Named @@ -129,13 +130,11 @@ This adapter is supplied by a third-party or can be set to the internal XML adap If you do not specify an adapter type Persistent Chat will not save compliance data. - - ```yaml Type: String Parameter Sets: (All) Aliases: -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 @@ -151,13 +150,11 @@ This has the potential to greatly increase the size of the compliance data. 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 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -173,13 +170,11 @@ This has the potential to greatly increase the size of the compliance data. 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 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -195,7 +190,7 @@ Prompts you for confirmation before executing the command. 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 @@ -209,13 +204,11 @@ Accept wildcard characters: False When set to True, additional output files will be created to track file transfers within chat rooms. These files will have the file extension .ATTACH and are placed in the location specified by the AdapterOutputDirectory. - - ```yaml Type: Boolean Parameter Sets: (All) Aliases: -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 @@ -228,13 +221,11 @@ Accept wildcard characters: False XSLT transform script that enables Persistent Chat to save compliance data in a custom format of your design. - - ```yaml Type: String Parameter Sets: (All) Aliases: -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 @@ -250,7 +241,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -267,7 +258,7 @@ If you assign the output of this cmdlet called with this parameter to a variable 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 Required: False Position: Named @@ -284,7 +275,7 @@ The default value is False. 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 Required: False Position: Named @@ -307,7 +298,7 @@ The default value is 15 minutes (00:15:00). Type: TimeSpan 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 Required: False Position: Named @@ -323,7 +314,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -333,7 +324,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -355,5 +346,3 @@ The New-CsPersistentChatComplianceConfiguration cmdlet creates new instances of [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md index 7db82fbb7d..ede3df5de1 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatConfiguration @@ -14,8 +19,6 @@ Persistent Chat configuration settings are used to manage the Persistent Chat se For example, these settings allow you to specify the maximum number of users who can participate in a chat room. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -35,8 +38,6 @@ These settings can be configured at the global or the site scope, or at the serv Skype for Business Server Control Panel: To create a new collection of Persistent Chat configuration settings using the Skype for Business Server Control Panel, click Persistent Chat, click Persistent Chat Configuration, click New, and then click either Site configuration or Pool configuration. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -48,7 +49,6 @@ New-CsPersistentChatConfiguration -Identity "site:Redmond" -ParticipantUpdateLim The command shown in Example 1 creates a new set of Persistent Chat configuration settings applied to the Redmond site. In this example, the ParticipantUpdateLimit property is set to 100. - ## PARAMETERS ### -Identity @@ -66,7 +66,7 @@ To create new settings at the service scope, use syntax like this: Type: XdsIdentity 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 Required: True Position: 2 @@ -82,7 +82,7 @@ Prompts you for confirmation before executing the command. 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 @@ -102,7 +102,7 @@ The default value is 30. Type: Int16 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 Required: False Position: Named @@ -118,7 +118,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -135,7 +135,7 @@ If you assign the output of this cmdlet called with this parameter to a variable 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 Required: False Position: Named @@ -152,7 +152,7 @@ The default value is 20000 KB. Type: UInt32 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 Required: False Position: Named @@ -169,7 +169,7 @@ The default value is 75. Type: UInt32 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 Required: False Position: Named @@ -185,7 +185,7 @@ URL for the Web page that administrators can use to manage individual chat rooms 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 Required: False Position: Named @@ -201,7 +201,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -211,7 +211,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -233,5 +233,3 @@ The New-CsPersistentChatConfiguration cmdlet creates new instances of the Micros [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md index 3e1112807c..ea7227eca8 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatEndpoint @@ -59,7 +64,7 @@ For example: 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 Required: True Position: Named @@ -81,7 +86,7 @@ The SIP address must use the sip: prefix as well as a valid SIP domain; for exam 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 Required: True Position: Named @@ -97,7 +102,7 @@ Prompts you for confirmation before executing the command. 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 @@ -113,7 +118,7 @@ Active Directory display name for the new contact object. 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 Required: False Position: Named @@ -130,7 +135,7 @@ By default, the New-CsPersistentChatEndpoint cmdlet does not pass objects throug 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 Required: False Position: Named @@ -146,7 +151,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -156,7 +161,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -176,4 +181,3 @@ The New-CsPersistentChatEndpoint cmdlet creates new instances of the Microsoft.R [Get-CsPersistentChatEndpoint](Get-CsPersistentChatEndpoint.md) [Remove-CsPersistentChatEndpoint](Remove-CsPersistentChatEndpoint.md) - diff --git a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md b/skype/skype-ps/skype/New-CsPersistentChatPolicy.md index cd2a902b64..24a866881d 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/New-CsPersistentChatPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatPolicy @@ -84,7 +89,7 @@ If you need to make changes to an existing policy, use the Set-CsPersistentChatP Type: XdsIdentity 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 Required: True Position: 2 @@ -100,7 +105,7 @@ Prompts you for confirmation before executing the command. 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 @@ -117,7 +122,7 @@ For example, the Description might include information about the users the polic 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 Required: False Position: Named @@ -134,7 +139,7 @@ When set to False (the default value) users affected by the policy will not be a 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 Required: False Position: Named @@ -150,7 +155,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -167,7 +172,7 @@ If you assign the output of this cmdlet called with this parameter to a variable 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 Required: False Position: Named @@ -183,7 +188,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -206,7 +211,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Skype for Business Server 2015 Required: False Position: Named @@ -216,7 +221,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -240,5 +245,3 @@ The New-CsPersistentChatPolicy cmdlet creates new instances of the Microsoft.Rtc [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatRoom.md b/skype/skype-ps/skype/New-CsPersistentChatRoom.md index 2585f383a6..b387851687 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/New-CsPersistentChatRoom.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPersistentChatRoom @@ -45,7 +50,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat chat ro ### -------------------------- Example 1 -------------------------- ``` -New-CsPersistentChatRoom -Name "ITChatRoom" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com"-Category "IT" +New-CsPersistentChatRoom -Name "ITChatRoom" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Category "IT" ``` The command shown in Example 1 creates a new Persistent Chat chat room named ITChatRoom on the pool atl-cs-001.litwareinc.com. @@ -66,7 +71,7 @@ Categories, which are collections of Persistent Chat chat rooms, can be created 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 Required: True Position: Named @@ -83,7 +88,7 @@ Names must be unique per Persistent Chat pool. 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 Required: True Position: Named @@ -101,7 +106,7 @@ Add-ins can be created by using the New-CsPersistentChatAddin cmdlet. 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 Required: False Position: Named @@ -117,7 +122,7 @@ Enables administrators to provide additional information about the new chat room 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 Required: False Position: Named @@ -134,7 +139,7 @@ If this parameter is not used then the new chat room will be enabled and availab 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 Required: False Position: Named @@ -151,7 +156,7 @@ Among other things, this means that users on the AllowedMembers list will automa Type: ChatRoomInvitations 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 Required: False Position: Named @@ -170,7 +175,7 @@ For example: 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 Required: False Position: Named @@ -191,7 +196,7 @@ Allowed values are: Type: ChatRoomPrivacy 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 Required: False Position: Named @@ -212,7 +217,7 @@ The default value is Normal. Type: ChatRoomType 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 Required: False Position: Named @@ -222,7 +227,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -246,5 +251,3 @@ The New-CsPersistentChatRoom cmdlet creates new instances of the Microsoft.Rtc.M [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) - - diff --git a/skype/skype-ps/skype/New-CsPinPolicy.md b/skype/skype-ps/skype/New-CsPinPolicy.md index bce26ef88e..36afdd1b3c 100644 --- a/skype/skype-ps/skype/New-CsPinPolicy.md +++ b/skype/skype-ps/skype/New-CsPinPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPinPolicy @@ -359,7 +364,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -383,5 +388,3 @@ Creates a new instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Use [Remove-CsPinPolicy](Remove-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md b/skype/skype-ps/skype/New-CsPlatformServiceSettings.md index 69a13e4c20..a469445901 100644 --- a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/New-CsPlatformServiceSettings.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPlatformServiceSettings schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsPlatformServiceSettings @@ -278,7 +283,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -292,8 +297,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[Set-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsPresencePolicy.md b/skype/skype-ps/skype/New-CsPresencePolicy.md index 73b5c0b5c1..3fbe18e8f8 100644 --- a/skype/skype-ps/skype/New-CsPresencePolicy.md +++ b/skype/skype-ps/skype/New-CsPresencePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPresencePolicy @@ -264,7 +269,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -288,5 +293,3 @@ The New-CsPresencePolicy cmdlet creates new instances of the Microsoft.Rtc.Manag [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsPresenceProvider.md b/skype/skype-ps/skype/New-CsPresenceProvider.md index f3fdbd2904..a7723a9ad6 100644 --- a/skype/skype-ps/skype/New-CsPresenceProvider.md +++ b/skype/skype-ps/skype/New-CsPresenceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPresenceProvider @@ -213,7 +218,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -237,4 +242,3 @@ The New-CsPresenceProvider cmdlet creates new instances of the Microsoft.Rtc.Man [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) [Set-CsPresenceProvider](Set-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md b/skype/skype-ps/skype/New-CsPrivacyConfiguration.md index 2e1e927657..73c2badb7b 100644 --- a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/New-CsPrivacyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPrivacyConfiguration @@ -285,7 +290,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -307,5 +312,3 @@ The New-CsPrivacyConfiguration cmdlet creates new instances of the Microsoft.Rtc [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsProxyConfiguration.md b/skype/skype-ps/skype/New-CsProxyConfiguration.md index 9faa9e2578..2d9e20f244 100644 --- a/skype/skype-ps/skype/New-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/New-CsProxyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsProxyConfiguration @@ -588,7 +593,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -610,5 +615,3 @@ The New-CsProxyConfiguration cmdlet creates new instances of the Microsoft.Rtc.M [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsPublicProvider.md b/skype/skype-ps/skype/New-CsPublicProvider.md index ad4a55e2ff..3350062fcf 100644 --- a/skype/skype-ps/skype/New-CsPublicProvider.md +++ b/skype/skype-ps/skype/New-CsPublicProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsPublicProvider @@ -346,7 +351,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -372,5 +377,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Ed [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - - diff --git a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md index ed8047c20c..614ff79df4 100644 --- a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPushNotificationConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsPushNotificationConfiguration @@ -239,7 +244,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -255,9 +260,8 @@ The New-CsPushNotificationConfiguration cmdlet creates new instances of the Micr ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) - -[Remove-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsQoEConfiguration.md b/skype/skype-ps/skype/New-CsQoEConfiguration.md index 4c81213fec..936e584b5d 100644 --- a/skype/skype-ps/skype/New-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/New-CsQoEConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsQoEConfiguration @@ -296,7 +301,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -317,5 +322,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.QoE.Q [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md b/skype/skype-ps/skype/New-CsRegistrarConfiguration.md index 07af5bbe74..cb6eea8e9f 100644 --- a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/New-CsRegistrarConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRegistrarConfiguration @@ -373,7 +378,7 @@ Accept wildcard characters: False ``` ### -UserCertificateReplicationThreshold -PARAMVALUE: UInt64 +Minimum interval in minutes for user certificate to be replicated. ```yaml Type: UInt64 @@ -389,7 +394,7 @@ Accept wildcard characters: False ``` ### -WinFabMaxLogsSizeMb -PARAMVALUE: Int32 +Limits the maximum disk space used by Fabric traces. Only applies to deployments using Windows Fabric 3.0 or newer ```yaml Type: Int32 @@ -405,7 +410,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -427,5 +432,3 @@ The New-CsRegistrarConfiguration cmdlet creates new instances of the Microsoft.R [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsReportingConfiguration.md b/skype/skype-ps/skype/New-CsReportingConfiguration.md index ce178cd17d..5b76d057c5 100644 --- a/skype/skype-ps/skype/New-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/New-CsReportingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsReportingConfiguration @@ -53,7 +58,7 @@ New-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-001.l ``` The command shown in Example 1 creates a new collection of reporting configuration settings assigned to the monitoring database with the identity service:MonitoringDatabase:atl-sql-001.litwareinc.com. -In this example, the value of the ReportingUrl property is set to "https://atl-sql-001.litwareinc.com/lync_reports". +In this example, the value of the ReportingUrl property is set to `https://atl-sql-001.litwareinc.com/lync_reports`. ## PARAMETERS @@ -161,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -184,5 +189,3 @@ The New-CsReportingConfiguration cmdlet creates new instances of the Microsoft.R [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsAgentGroup.md b/skype/skype-ps/skype/New-CsRgsAgentGroup.md index 274fceb444..ce81c7775c 100644 --- a/skype/skype-ps/skype/New-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/New-CsRgsAgentGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsAgentGroup @@ -315,7 +320,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -337,4 +342,3 @@ New-CsRgsAgentGroup creates new instances of the Microsoft.Rtc.Rgs.Management.Wr [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/New-CsRgsAnswer.md b/skype/skype-ps/skype/New-CsRgsAnswer.md index ebbacc93f0..446e74549c 100644 --- a/skype/skype-ps/skype/New-CsRgsAnswer.md +++ b/skype/skype-ps/skype/New-CsRgsAnswer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsAnswer @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -167,5 +172,3 @@ Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Answe ## RELATED LINKS [New-CsRgsQuestion](New-CsRgsQuestion.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsCallAction.md b/skype/skype-ps/skype/New-CsRgsCallAction.md index 2e118c353f..5e38c17538 100644 --- a/skype/skype-ps/skype/New-CsRgsCallAction.md +++ b/skype/skype-ps/skype/New-CsRgsCallAction.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsCallAction @@ -204,7 +209,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -224,4 +229,3 @@ New-CsRgsCallAction creates new instances of the Microsoft.Rtc.Rgs.Management.Wr [New-CsRgsQueue](New-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/New-CsRgsHoliday.md b/skype/skype-ps/skype/New-CsRgsHoliday.md index 9250cc1a3c..18b0630657 100644 --- a/skype/skype-ps/skype/New-CsRgsHoliday.md +++ b/skype/skype-ps/skype/New-CsRgsHoliday.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsHoliday @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -159,4 +164,3 @@ New-CsRgsHoliday creates new instances of the Microsoft.Rtc.Rgs.Management.Writa [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/New-CsRgsHolidaySet.md b/skype/skype-ps/skype/New-CsRgsHolidaySet.md index afb6d65410..d86a40c358 100644 --- a/skype/skype-ps/skype/New-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/New-CsRgsHolidaySet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsHolidaySet @@ -218,7 +223,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -242,5 +247,3 @@ New-CsRgsHolidaySet creates new instances of the Microsoft.Rtc.Rgs.Management.Wr [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md index 082196e211..137037c180 100644 --- a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsHoursOfBusiness @@ -534,7 +539,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -558,4 +563,3 @@ Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Busin [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/New-CsRgsPrompt.md b/skype/skype-ps/skype/New-CsRgsPrompt.md index dc19561434..663c604f09 100644 --- a/skype/skype-ps/skype/New-CsRgsPrompt.md +++ b/skype/skype-ps/skype/New-CsRgsPrompt.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsPrompt @@ -13,8 +18,6 @@ Creates a new workflow prompt for the Response Group application. A workflow prompt is either an audio file that is played or text that is read aloud in order to supply callers with additional information. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ``` @@ -44,8 +47,6 @@ Each time you need to use a prompt it must be created from scratch; there is no If you provide both a text-to-speech and an audio file prompt, the Response Group application will use the audio file by default, and will rely on the text-to-speech prompt only if the audio file is unavailable. After new prompts are created in memory, the corresponding object reference is then typically added to a Response Group call action. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -68,16 +69,14 @@ The final command in the example uses New-CsRgsCallAction to create a new Respon When creating the call action, the object reference $prompt (which contains the newly-created workflow prompt) is used as the value for the Prompt parameter; the object reference $queue is likewise used in conjunction with the QueueID parameter. After running this command, the new call action and its new workflow prompt are ready to be added to a Response Group workflow. - ### -------------------------- EXAMPLE 2 -------------------------- ``` $queue = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" -$audioFile = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "welcome.wav" -Content (Get-Content C:\Media\Welcome.wav -Encoding byte -ReadCount 0) +$audioFile = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "welcome.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\Welcome.wav')) -$prompt = New-CsRgsPrompt -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to the help desk. -Please hold." +$prompt = New-CsRgsPrompt -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to the help desk. Please hold." $z = New-CsRgsCallAction -Prompt $prompt -Action TransferToQueue -QueueID $queue.Identity ``` @@ -91,7 +90,6 @@ After the audio file has been imported, both it and a text-to-speech prompt are To do this, the AudioFilePrompt parameter is set to $audioFile, and the TextToSpeechPrompt parameter is set to the text value "Welcome to the help desk. Please hold." - ## PARAMETERS ### -TextToSpeechPrompt @@ -129,7 +127,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -149,5 +147,3 @@ New-CsRgsPrompt creates instances of the Microsoft.Rtc.Management.WritableSettin [Import-CsRgsAudioFile](Import-CsRgsAudioFile.md) [New-CsRgsCallAction](New-CsRgsCallAction.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsQuestion.md b/skype/skype-ps/skype/New-CsRgsQuestion.md index 949264ca6c..9a30312ad9 100644 --- a/skype/skype-ps/skype/New-CsRgsQuestion.md +++ b/skype/skype-ps/skype/New-CsRgsQuestion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsQuestion @@ -170,7 +175,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -188,5 +193,3 @@ New-CsRgsQuestion creates instances of the Microsoft.Rtc.Management.WriteableSet ## RELATED LINKS [New-CsRgsAnswer](New-CsRgsAnswer.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsQueue.md b/skype/skype-ps/skype/New-CsRgsQueue.md index ad45164c2c..119cd58947 100644 --- a/skype/skype-ps/skype/New-CsRgsQueue.md +++ b/skype/skype-ps/skype/New-CsRgsQueue.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsQueue @@ -295,7 +300,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -317,5 +322,3 @@ New-CsRgsQueue creates new instances of the Microsoft.Rtc.Rgs.Management.Writabl [Remove-CsRgsQueue](Remove-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsTimeRange.md b/skype/skype-ps/skype/New-CsRgsTimeRange.md index e78b4c44bf..7d567a2ff5 100644 --- a/skype/skype-ps/skype/New-CsRgsTimeRange.md +++ b/skype/skype-ps/skype/New-CsRgsTimeRange.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsTimeRange @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -170,4 +175,3 @@ New-CsRgsTimeRange creates new instances of the Microsoft.Rtc.Rgs.Management.Wri [New-CsRgsHoursOfBusiness](New-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/New-CsRgsWorkflow.md b/skype/skype-ps/skype/New-CsRgsWorkflow.md index 92b5c703f4..dd48bcbd80 100644 --- a/skype/skype-ps/skype/New-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/New-CsRgsWorkflow.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRgsWorkflow @@ -317,7 +322,7 @@ However, that language can be used in a workflow only if it is a language suppor The language must be specified using one of the following language codes: -ca-ES - Catalan (Spain) +ca-ES - Catalan da-DK - Danish (Denmark) @@ -570,7 +575,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -592,4 +597,3 @@ The New-CsRgsWorkflow cmdlet creates new instances of the Microsoft.Rtc.Rgs.Mana [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/New-CsRoutingConfiguration.md b/skype/skype-ps/skype/New-CsRoutingConfiguration.md index 8cd92e33fa..b71bf8d54b 100644 --- a/skype/skype-ps/skype/New-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/New-CsRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsRoutingConfiguration @@ -196,7 +201,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -221,5 +226,3 @@ Can create an in-memory object of type Microsoft.Rtc.Management.WritableConfig.P [New-CsVoiceRoute](New-CsVoiceRoute.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - - diff --git a/skype/skype-ps/skype/New-CsServerApplication.md b/skype/skype-ps/skype/New-CsServerApplication.md index d118415c02..00a0588174 100644 --- a/skype/skype-ps/skype/New-CsServerApplication.md +++ b/skype/skype-ps/skype/New-CsServerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsServerApplication @@ -136,7 +141,7 @@ Accept wildcard characters: False ### -Uri Unique Uniform Resource Identifier (URI) for the application. -For example, the QoEAgent application has the URI http://www.microsoft.com/LCS/QoEAgent. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml Type: String @@ -325,7 +330,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -347,5 +352,3 @@ The New-CsServerApplication cmdlet creates new instances of the Microsoft.Rtc.Ma [Remove-CsServerApplication](Remove-CsServerApplication.md) [Set-CsServerApplication](Set-CsServerApplication.md) - - diff --git a/skype/skype-ps/skype/New-CsSimpleUrl.md b/skype/skype-ps/skype/New-CsSimpleUrl.md index 4e7d6bf7bf..93d388cd74 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrl.md +++ b/skype/skype-ps/skype/New-CsSimpleUrl.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSimpleUrl @@ -13,10 +18,7 @@ Creates a new simple URL, which can then be added to a simple URL configuration Simple URLs make it easier for users to join meetings and conferences, and also make it easier for administrators to log on to the Skype for Business Server Control Panel. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX - ``` New-CsSimpleUrl -Component <String> -Domain <String> [-SimpleUrlEntry <PSListModifier>] [-ActiveUrl <String>] [<CommonParameters>] @@ -26,12 +28,12 @@ New-CsSimpleUrl -Component <String> -Domain <String> [-SimpleUrlEntry <PSListMod In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -51,7 +53,7 @@ When you install Skype for Business Server, a global collection is created for y This gives you the ability to use different simple URLs at each of your sites. To add an actual URL to a simple URL collection, you must first create the URL by using the New-CsSimpleUrl cmdlet and the New-CsSimpleUrlEntry cmdlet. -The New-CsSimpleUrlEntry cmdlet creates a URL entry: a URL (such as https://meet.litwareinc.com) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes). +The New-CsSimpleUrlEntry cmdlet creates a URL entry: a URL (such as `https://meet.litwareinc.com`) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes). The object created by the New-CsSimpleUrlEntry cmdlet is added to the SimpleUrlEntry property of a new simple URL. You must use a separate cmdlet to create the object because the SimpleUrlEntry property can hold multiple URLs. (However, only one such URL can be designated as the active URL. @@ -61,13 +63,10 @@ After creating a simple URL entry, you then use the New-CsSimpleUrl cmdlet to cr After you have created an object representing the simple URL, that object can then be added to a new (or existing) simple URL collection. After updating a simple URL collection, you must then run the Enable-CsComputer cmdlet. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- ``` - $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com/" $simpleUrl = New-CsSimpleUrl -Component "meet" -Domain "fabrikam.com" -SimpleUrlEntry $urlEntry -ActiveUrl "https://meet.fabrikam.com/" @@ -76,35 +75,33 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` Example 1 shows how a new URL can be added to an existing collection of simple URLs. -To begin with, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To begin with, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. In the second command, the New-CsSimpleUrl cmdlet is used to create an in-memory-only instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com; and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com`; and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. After the URL has been created (and stored in the object reference $simpleUrl) the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter, and the parameter value @{Add=$simpleUrl}. This syntax causes the URL stored in the object reference $simpleUrl to be added to the SimpleUrl property. - ## PARAMETERS ### -Component - Indicates the type of simple URL being created. Valid values are: -Meet - URL used for managing meetings. +- Meet - URL used for managing meetings. + +- Admin - URL that points to the Skype for Business Server Control Panel. -Admin - URL that points to the Skype for Business Server Control Panel. +- Dialin - URL used for dial-in conferencing. -Dialin - URL used for dial-in conferencing. +- WebScheduler - URL used for schedule meetings. For example: `-Component "Meet"` - - ```yaml Type: String Parameter Sets: (All) @@ -142,7 +139,7 @@ Accept wildcard characters: False ### -SimpleUrlEntry 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. +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. Simple URL entries must be created by using the New-CsSimpleUrlEntry cmdlet. @@ -169,7 +166,7 @@ An error will occur if you try to set the ActiveUrl to a value not found in the To assign an active URL, simply use the URL itself as the parameter value. For example: -`-ActiveUrl https://meet.litwareinc.com"` +`-ActiveUrl "https://meet.litwareinc.com/"` @@ -187,7 +184,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -207,4 +204,3 @@ The New-CsSimpleUrl cmdlet creates new instances of the Microsoft.Rtc.Management [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) [New-CsSimpleUrlEntry](New-CsSimpleUrlEntry.md) - diff --git a/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md index db803c05fb..4bcbbf4b6a 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSimpleUrlConfiguration @@ -27,12 +32,12 @@ New-CsSimpleUrlConfiguration [-Identity] <XdsIdentity> [-SimpleUrl <PSListModifi In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -84,11 +89,11 @@ New-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` Example 2 shows how you can create a new collection of simple URLs that includes two simple URLs (one for meeting management and one for dial-in conferencing). -To do this, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://dialin.litwareinc.com; this URL entry is stored in a variable named $urlEntry. -The second command then creates another URL entry, this one pointing to https://meet.fabrikam.com. +To do this, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to `https://dialin.litwareinc.com`; this URL entry is stored in a variable named $urlEntry. +The second command then creates another URL entry, this one pointing to `https://meet.fabrikam.com`. Next, the New-CsSimpleUrl cmdlet is used to create an in-memory-only instance of a simple URL. -In this example, the URL Component is set to dialin; the domain is set to an asterisk (*); the ActiveUrl is set to https://dialin.fabrikam.com; and the SimpleUrl property is set to $urlEntry. +In this example, the URL Component is set to dialin; the domain is set to an asterisk (*); the ActiveUrl is set to `https://dialin.fabrikam.com`; and the SimpleUrl property is set to $urlEntry. (The variable $urlEntry represents the URL entry created in the first command.) A similar command is then used to create a simple URL for meet.fabrikam.com. After the URLs have been created (and stored in the object references $simpleUrl and $simpleUrl2) the final command in the example creates a new simple URL collection for the Redmond site, adding the two new in-memory-only URLs to that collection. @@ -101,7 +106,8 @@ That syntax causes the URLs stored in the object references $simpleUrl and $simp ### -Identity Unique identifier for the new simple URL configuration collection. -Because new collections can only be created at the site scope, the Identity must be the prefix "site:" followed by the name of the site. +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"` @@ -236,7 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -261,5 +267,3 @@ The New-CsSimpleUrlConfiguration cmdlet creates new instances of the Microsoft.R [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsSimpleUrlEntry.md b/skype/skype-ps/skype/New-CsSimpleUrlEntry.md index d2c4f43b96..f748308d5a 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrlEntry.md +++ b/skype/skype-ps/skype/New-CsSimpleUrlEntry.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSimpleUrlEntry @@ -25,12 +30,12 @@ New-CsSimpleUrlEntry -Url <String> [<CommonParameters>] In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are obviously an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -50,7 +55,7 @@ When you install Skype for Business Server, a global collection is created for y This gives you the ability to use different simple URLs at each of your sites. To add an actual URL to a simple URL collection, you must first create the URL by using the New-CsSimpleUrl cmdlet and the New-CsSimpleUrlEntry cmdlet. -The New-CsSimpleUrlEntry cmdlet creates a URL entry; this is nothing more than a URL (such as https://meet.litwareinc.com) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes). +The New-CsSimpleUrlEntry cmdlet creates a URL entry; this is nothing more than a URL (such as `https://meet.litwareinc.com`) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes). The object created by the New-CsSimpleUrlEntry cmdlet is then added to the SimpleUrlEntry property of a new simple URL. You must use a separate cmdlet to create the object; that's because the SimpleUrlEntry property can hold multiple URLs. (However, only one such URL can be designated as the active URL. @@ -75,10 +80,10 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` Example 1 shows how a new URL can be added to an existing collection of simple URLs. -To begin with, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To begin with, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. In the second command, the New-CsSimpleUrl cmdlet is used to create an in-memory-only instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com; and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com`; and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. After the URL has been created (and stored in the object reference $simpleUrl) the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter and the parameter value @{Add=$simpleUrl}. @@ -100,12 +105,12 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` In Example 2, a pair of URL entries is added to an existing collection of simple URLs. -To do this, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To do this, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. The second command then creates a second URL entry, this one stored in the variable $urlEntry2 and pointing to the URL https:// dialin.fabrikam.com. After the two URL entries have been created, the New-CsSimpleUrl cmdlet is used to create two in-memory-only instances of a simple URL. -In the first instance, the URL Component is set to Meet; the domain is set to fabrikam.com; and the ActiveUrl is set to https://meet.fabrikam.com. -In the second instance, the component is set to Dialin; the domain to an asterisk (*); and the ActiveURL property is set to https://dialin.fabrikam.com. +In the first instance, the URL Component is set to Meet; the domain is set to fabrikam.com; and the ActiveUrl is set to `https://meet.fabrikam.com`. +In the second instance, the component is set to Dialin; the domain to an asterisk (*); and the ActiveURL property is set to `https://dialin.fabrikam.com`. After the URLs have been created (and stored in the object references $simpleUrl and $simpleUrl2), the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter, and the parameter value @{Add=$simpleUrl, $simpleUrl2}. @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -158,5 +163,3 @@ The New-CsSimpleUrlEntry cmdlet creates new instances of the Microsoft.Rtc.Manag [New-CsSimpleUrl](New-CsSimpleUrl.md) [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsSipDomain.md b/skype/skype-ps/skype/New-CsSipDomain.md index 614397688a..e3f6128773 100644 --- a/skype/skype-ps/skype/New-CsSipDomain.md +++ b/skype/skype-ps/skype/New-CsSipDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipDomain @@ -152,7 +157,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -175,5 +180,3 @@ The New-CsSipDomain cmdlet creates new instances of the Microsoft.Rtc.Management [Remove-CsSipDomain](Remove-CsSipDomain.md) [Set-CsSipDomain](Set-CsSipDomain.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyCustom.md b/skype/skype-ps/skype/New-CsSipProxyCustom.md index 7897a2bc1a..1e9b87ddfd 100644 --- a/skype/skype-ps/skype/New-CsSipProxyCustom.md +++ b/skype/skype-ps/skype/New-CsSipProxyCustom.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyCustom @@ -60,7 +65,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -80,5 +85,3 @@ The New-CsSipProxyCustom cmdlet creates new instances of the Microsoft.Rtc.Manag [New-CsSipProxyRealm](New-CsSipProxyRealm.md) [New-CsSipProxyUseDefault](New-CsSipProxyUseDefault.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyRealm.md b/skype/skype-ps/skype/New-CsSipProxyRealm.md index e635fb3046..28a9713563 100644 --- a/skype/skype-ps/skype/New-CsSipProxyRealm.md +++ b/skype/skype-ps/skype/New-CsSipProxyRealm.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyRealm @@ -82,7 +87,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -102,5 +107,3 @@ The New-CsSipProxyRealm cmdlet creates new instances of the Microsoft.Rtc.Manage [New-CsSipProxyCustom](New-CsSipProxyCustom.md) [New-CsSipProxyUseDefault](New-CsSipProxyUseDefault.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyTCP.md b/skype/skype-ps/skype/New-CsSipProxyTCP.md index b68c830601..60a6fa4a29 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTCP.md +++ b/skype/skype-ps/skype/New-CsSipProxyTCP.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyTCP @@ -78,7 +83,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -98,5 +103,3 @@ The New-CsSipProxyTCP cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsSipProxyTLS](New-CsSipProxyTLS.md) [New-CsSipProxyTransport](New-CsSipProxyTransport.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyTLS.md b/skype/skype-ps/skype/New-CsSipProxyTLS.md index e75b835cc0..8083398419 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTLS.md +++ b/skype/skype-ps/skype/New-CsSipProxyTLS.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyTLS @@ -105,7 +110,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS @@ -127,5 +132,3 @@ The New-CsSipProxyTLS cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsSipProxyTransport](New-CsSipProxyTransport.md) [New-CsSipProxyUseDefaultCert](New-CsSipProxyUseDefaultCert.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyTransport.md b/skype/skype-ps/skype/New-CsSipProxyTransport.md index 9767817346..3986103a26 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTransport.md +++ b/skype/skype-ps/skype/New-CsSipProxyTransport.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyTransport @@ -109,7 +114,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -129,4 +134,3 @@ The `New-CsSipProxyTransport` cmdlet creates new instances of the Microsoft.Rtc. [New-CsSipProxyTCP](New-CsSipProxyTCP.md) [New-CsSipProxyTLS](New-CsSipProxyTLS.md) - diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md b/skype/skype-ps/skype/New-CsSipProxyUseDefault.md index 40acc5747f..c4b0c49aba 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md +++ b/skype/skype-ps/skype/New-CsSipProxyUseDefault.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyUseDefault @@ -55,7 +60,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -75,4 +80,3 @@ The `New-CsSipProxyUseDefault` cmdlet creates new instances of the Microsoft.Rtc [New-CsSipProxyCustom](New-CsSipProxyCustom.md) [New-CsSipProxyRealm](New-CsSipProxyRealm.md) - diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md b/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md index afaa36333c..c3e2de765f 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md +++ b/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipProxyUseDefaultCert @@ -74,7 +79,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -92,4 +97,3 @@ The `New-CsSipProxyUseDefaultCert` cmdlet creates new instances of the Microsoft ## RELATED LINKS [New-CsSipProxyTLS](New-CsSipProxyTLS.md) - diff --git a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md index 060761523d..79e5457a51 100644 --- a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsSipResponseCodeTranslationRule @@ -284,7 +289,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -306,4 +311,3 @@ The `New-CsSipResponseCodeTranslationRule` cmdlet creates new instances of the M [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/New-CsStaticRoute.md b/skype/skype-ps/skype/New-CsStaticRoute.md index de061f74c6..f7208b4025 100644 --- a/skype/skype-ps/skype/New-CsStaticRoute.md +++ b/skype/skype-ps/skype/New-CsStaticRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsStaticRoute @@ -301,7 +306,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -321,4 +326,3 @@ The `New-CsStaticRoute` cmdlet creates new instances of the Microsoft.Rtc.Manage [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md index 974c2c9d68..f59880c6ef 100644 --- a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsStaticRoutingConfiguration @@ -165,7 +170,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +194,3 @@ The `New-CsStaticRoutingConfiguration` cmdlet creates new instances of the Micro [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md index cac8e42353..b9fb8758da 100644 --- a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsStorageServiceConfiguration @@ -199,7 +204,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -221,4 +226,3 @@ The `New-CsStorageServiceConfiguration` cmdlet creates new instances of the Micr [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md deleted file mode 100644 index 5d245a9900..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ /dev/null @@ -1,425 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsTeamsMeetingPolicy -schema: 2.0.0 ---- - -# New-CsTeamsMeetingPolicy - -## SYNOPSIS - The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users -## SYNTAX - -``` -New-CsTeamsMeetingPolicy [-Tenant <Guid>] [-Description <String>] - [-AllowChannelMeetingScheduling <Boolean>] [-AllowMeetNow <Boolean>] [-AllowIPVideo <Boolean>] - [-AllowAnonymousUsersToDialOut <Boolean>] [-AllowAnonymousUsersToStartMeeting <Boolean>] - [-AllowPrivateMeetingScheduling <Boolean>] [-AutoAdmittedUsers <String>] [-AllowCloudRecording <Boolean>] - [-AllowOutlookAddIn <Boolean>] [-AllowPowerPointSharing <Boolean>] - [-AllowParticipantGiveRequestControl <Boolean>] [-AllowExternalParticipantGiveRequestControl <Boolean>] - [-AllowSharedNotes <Boolean>] [-AllowWhiteboard <Boolean>] [-AllowTranscription <Boolean>] - [-MediaBitRateKb <UInt32>] [-ScreenSharingMode <String>] [-Identity] <XdsIdentity> [-InMemory] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## 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 -------------------------- -``` -New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $false -``` - -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 -------------------------- -``` -New-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False -``` - -In Example 2, the New-CsTeamsMeetingPolicy cmdlet is used to create a meeting policy with the Identity HrMeetingPolicy. -In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. -All other policy properties will use the default values. - - -## PARAMETERS - -### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymousUsersToStartMeeting -Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCloudRecording -Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowExternalParticipantGiveRequestControl -Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowIPVideo -Determines whether video is enabled in  a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings.  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOutlookAddIn -Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPowerPointSharing -Determines whether Powerpoint sharing is allowed in a user’s meetings. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSharedNotes -Determines whether users are allowed to take shared notes.  Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTranscription -Determines whether real-time and/or post-meeting captions and transcriptions are allowed in a user's meetings.  Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowWhiteboard -Determines whether whiteboard is allowed in a user’s meetings. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoAdmittedUsers -Determines what types of participants will automatically be added to meetings organized by this user. Set this to EveryoneInCompany if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. Set this to Everyone if you'd like to admit anonymous users by default. Set this to EveryoneInSameAndFederatedCompany if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the meeting policy. -For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings  - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScreenSharingMode -Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an  application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md deleted file mode 100644 index 5b7f20bbc1..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsTeamsMessagingPolicy -schema: 2.0.0 ---- - -# New-CsTeamsMessagingPolicy - -## SYNOPSIS -The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. - -## SYNTAX - -``` -New-CsTeamsMessagingPolicy [-Tenant <Guid>] [-Description <String>] [-AllowUrlPreviews <Boolean>] - [-AllowOwnerDeleteMessage <Boolean>] [-AllowUserEditMessage <Boolean>] [-AllowUserDeleteMessage <Boolean>] - [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] [-GiphyRatingType <String>] [-AllowMemes <Boolean>] - [-AllowStickers <Boolean>] [-AllowUserTranslation <Boolean>] [-ReadReceiptsEnabledType <String>] - [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet creates a new Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. - -## EXAMPLES - -### Example 1 -``` -powershell -PS C:\> New-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false -``` - -In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. -All other policy properties will use the default values. - - -## PARAMETERS - -### -AllowGiphy -Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMemes -Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOwnerDeleteMessage -Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickers -Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserChat -Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessage -Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserEditMessage -Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserTranslation -Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of your policy to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyRatingType -Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams messaging policy to be created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md index f684f52939..e0076883f9 100644 --- a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md @@ -1,51 +1,52 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness -online version: -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsupgradepolicy +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTeamsUpgradePolicy schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsTeamsUpgradePolicy ## SYNOPSIS -In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables adminstrators to control whether user see a notification in their Skype for Business client of a pending upgrade to Teams. In addition, when this policy is assigned to a user, administrators can optionally have Win32 versions of Skype for Business clients silently download Teams based on the value of CsTeamsUpgradeConfiguration. - - +In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables administrators to control whether user see a notification in their Skype for Business client of a pending upgrade to Teams. In addition, when this policy is assigned to a user, administrators can optionally have Win32 versions of Skype for Business clients silently download Teams based on the value of CsTeamsUpgradeConfiguration. ## SYNTAX ``` -New-CsTeamsUpgradePolicy [-Identity] <XdsIdentity> [-NotifySfbUsers <Boolean>] [-Description <String>] - +New-CsTeamsUpgradePolicy [-Identity] <XdsIdentity> [-NotifySfbUsers <Boolean>] [-Description <String>] ``` ## DESCRIPTION -In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables adminstrators to control whether users see a notification of a pending upgrade to Teams in their Skype for Business client. The new-CsTeamsUpgradePolicy lets the adminstrator create a policy that can be assigned to users homed in Skype for Business on-premises to notify of them of a pending upgrade to Teams. Notifications are enabled by the boolean parameter NotifySfBUsers. + +In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables administrators to control whether users see a notification of a pending upgrade to Teams in their Skype for Business client. The new-CsTeamsUpgradePolicy lets the administrator create a policy that can be assigned to users homed in Skype for Business on-premises to notify of them of a pending upgrade to Teams. Notifications are enabled by the boolean parameter NotifySfBUsers. For users with Win32 versions of Skype for Business, if DownloadTeams=true in CsTeamsUpgradeConfiguration, users who are assigned an instance of TeamsUpgradePolicy with NotifySfBUsers=true will have Teams automatically downloaded in the background. -Notes: -* Instances of TeamsUpgradePolicy created in on-premises will not apply to any users that are already homed online. +Notes: +* Instances of TeamsUpgradePolicy created in on-premises will not apply to any users that are already homed online. * Skype for Business Online already provides built-in instances of TeamsUpgradePolicy, so there is no New-CsTeamsUpgradePolicy cmdlet for the online environment by design. - - - ## EXAMPLES ### Example 1: Create a site-level policy + ```powershell -PS C:\> new-CsTeamsUpgradePolicy -identity site:Redmond1 -NotifySfBUsers $true +PS C:\> new-CsTeamsUpgradePolicy -identity site:Redmond1 -NotifySfBUsers $true ``` -This creates a policy for users in the site Redmond1. +This creates a policy for users in the site Redmond1. ### Example 2: Create a policy not specific to a site. + ```powershell -PS C:\> new-CsTeamsUpgradePolicy -identity EnableNotifications -NotifySfBUsers $true +PS C:\> new-CsTeamsUpgradePolicy -identity EnableNotifications -NotifySfBUsers $true ``` This creates a policy for users that can be granted as desired to individual users @@ -53,6 +54,7 @@ This creates a policy for users that can be granted as desired to individual use ## PARAMETERS ### -NotifySfbUsers + 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 @@ -67,11 +69,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - - ### -Description -Free form text that can be used as needed by adminsitrators. + +Free form text that can be used as needed by administrators. ```yaml Type: String @@ -85,11 +85,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\<name>" where \<name> 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. -### -Identity -The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:<name>" where <name> is the name of the site. To specfy a policy that can be assigned as needed to any users, simply specify a name of your choosing. - ```yaml Type: XdsIdentity Parameter Sets: (All) @@ -102,19 +101,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - - - ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object @@ -123,18 +118,18 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) -[Grant-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md) +[Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Get-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md) +[Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) -[New-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md) +[New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) -[Remove-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md) +[Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) -[Set-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md) +[Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) -[Get-CsTeamsUpgradeConfiguration](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md) +[Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) -[Set-CsTeamsUpgradeConfiguration](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md) +[Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) diff --git a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md b/skype/skype-ps/skype/New-CsTelemetryConfiguration.md index 6d0ce90ae0..8cff3d883a 100644 --- a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/New-CsTelemetryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTelemetryConfiguration @@ -19,7 +24,7 @@ New-CsTelemetryConfiguration [-Identity] <XdsIdentity> [-Confirm] [-EnableClient ``` ## DESCRIPTION -For privacy information, see the Skype for Business Privacy Statement (http://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). +For privacy information, see the Skype for Business Privacy Statement (https://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). ## EXAMPLES @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -159,4 +164,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTenantDialPlan.md b/skype/skype-ps/skype/New-CsTenantDialPlan.md deleted file mode 100644 index f3fbb2964c..0000000000 --- a/skype/skype-ps/skype/New-CsTenantDialPlan.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: New-CsTenantDialPlan -schema: 2.0.0 ---- - -# New-CsTenantDialPlan - -## SYNOPSIS -Use the `New-CsTenantDialPlan` cmdlet to create a new tenant dial plan. - -## SYNTAX - -``` -New-CsTenantDialPlan [-Tenant <Guid>] [-Description <String>] [-NormalizationRules <List>] - [-ExternalAccessPrefix <String>] [-SimpleName <String>] [-OptimizeDeviceDialing <Boolean>] - [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -You can use this cmdlet to create a new tenant dial plan. -Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. -The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. - -You can add new normalization rules to a tenant dial plan by calling the `New-CsVoiceNormalizationRule` (https://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CsTenantDialPlan -Identity vt1tenantDialPlan9 -``` - -This example creates a tenant dial plan that has an Identity of vt1tenantDialPlan9. - - -### -------------------------- Example 2 -------------------------- -``` -$nr2 = New-CsVoiceNormalizationRule -Identity Global/NR2 -Description "TestNR1" -Pattern '^(d{11})$' -Translation '+1' -InMemory - -New-CsTenantDialPlan -Identity vt1tenantDialPlan91 -NormalizationRules @{Add=$nr2} -``` - -This example creates a new normalization rule and then applies that rule to a new tenant dial plan. - - -## PARAMETERS - -### -Identity -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: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to and any other information that helps to identify the purpose of the tenant dial plan. -Maximum characters: 512. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccessPrefix -The ExternalAccessPrefix parameter is a number (or set of numbers) that designates the call as external to the organization. -(For example, to tenant-dial an outside line, first press 9.) This prefix is ignored by the normalization rules, although these rules are applied to the remainder of the number. - -The OptimizeDeviceDialing parameter must be set to True for this value to take effect. -This parameter must match the regular expression \[0-9\]{1,4}: that is, it must be a value 0 through 9 and one to four digits in length. -The default value is 9. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -The InMemory parameter creates an object reference without actually committing the object as a permanent change. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NormalizationRules -The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the `New-CsVoiceNormalizationRule` (https://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. - -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 25 per TenantDialPlan. - -You can create a new normalization rule by calling the `New-CsVoiceNormalizationRule` (https://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptimizeDeviceDialing -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleName -The SimpleName parameter is a display name for the tenant dial plan. -This name must be unique among all tenant dial plans within the Skype for Business Server deployment. - -This string can be up to 256 characters long. -Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()). - -This parameter must contain a value. -However, if you don't provide a value, a default value will be supplied. -The default value for a Global tenant dial plan is Prefix All. -The default value for a site-level tenant dial plan is the name of the site. -The default value for a service is the name of the service (Registrar or PSTN gateway) followed by an underscore, followed by the service fully qualified domain name (FQDN). -For example: Registrar_pool0.litwareinc.com. -The default value for a per-user tenant dial plan is the Identity of the tenant dial plan. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md index 8a071ccf31..11a5b21e8e 100644 --- a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsTenantUpdateTimeWindow @@ -323,7 +328,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -332,4 +337,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTestDevice.md b/skype/skype-ps/skype/New-CsTestDevice.md index 6482115551..74d4439948 100644 --- a/skype/skype-ps/skype/New-CsTestDevice.md +++ b/skype/skype-ps/skype/New-CsTestDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTestDevice @@ -240,7 +245,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -262,4 +267,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.De [Remove-CsTestDevice](Remove-CsTestDevice.md) [Set-CsTestDevice](Set-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md index 9557f57cff..b99a3a2d81 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsThirdPartyVideoSystem @@ -227,7 +232,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -251,4 +256,3 @@ The `New-CsThirdPartyVideoSystem` cmdlet creates new instances of the Microsoft. [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md index 69db587b25..4043433c11 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsThirdPartyVideoSystemPolicy @@ -167,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -191,4 +196,3 @@ The `New-CsThirdPartyVideoSystemPolicy` cmdlet creates new instances of the Micr [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsTrunkConfiguration.md b/skype/skype-ps/skype/New-CsTrunkConfiguration.md index e748089793..f7e31d7df2 100644 --- a/skype/skype-ps/skype/New-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/New-CsTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTrunkConfiguration @@ -22,7 +27,7 @@ New-CsTrunkConfiguration [-Identity] <XdsIdentity> [-ConcentratedTopology <Boole [-RTCPActiveCalls <Boolean>] [-RTCPCallsOnHold <Boolean>] [-SipResponseCodeTranslationRulesList <PSListModifier>] [-SRTPMode <SRTPMode>] [-Force] [-InMemory] [-WhatIf] [-Confirm] [-Enable3pccRefer <Boolean>] [-EnableFastFailoverTimer <Boolean>] [-EnableOnlineVoice <Boolean>] - [-EnableRTPLatching <Boolean>] [-ForwardCallHistory <Boolean>] [-ForwardPAI <Boolean>] + [-EnableRTPLatching <Boolean>] [-ForwardCallHistory <Boolean>] [-ForwardPAI <Boolean>] [-ForwardAnonymousCallGatewayPAI <Boolean>] [-OutboundCallingNumberTranslationRulesList <PSListModifier>] [-PstnUsages <PSListModifier>] [-EnableLocationRestriction <Boolean>] [-NetworkSiteID <String>] [<CommonParameters>] ``` @@ -593,6 +598,26 @@ 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). + +**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 + +Required: False +Position: Named +Default value: None +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: @@ -674,7 +699,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -699,4 +724,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Trunk [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplication.md b/skype/skype-ps/skype/New-CsTrustedApplication.md index ee0d085651..a46ee864c0 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplication.md +++ b/skype/skype-ps/skype/New-CsTrustedApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTrustedApplication @@ -237,7 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -258,4 +263,3 @@ Creates an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication [Set-CsTrustedApplication](Set-CsTrustedApplication.md) [Get-CsTrustedApplication](Get-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md b/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md index e9e9e7ce83..1f2dd613a9 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTrustedApplicationComputer @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -151,4 +156,3 @@ Creates an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. [New-CsTrustedApplicationPool](New-CsTrustedApplicationPool.md) [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md index 7034844628..9013c9e9a4 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTrustedApplicationEndpoint @@ -266,7 +271,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -287,4 +292,3 @@ Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplica [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md b/skype/skype-ps/skype/New-CsTrustedApplicationPool.md index 15d69470ad..cd945137d5 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/New-CsTrustedApplicationPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsTrustedApplicationPool @@ -382,7 +387,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -407,4 +412,3 @@ Creates an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) [Get-CsSite](Get-CsSite.md) - diff --git a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md index 14bef3379f..30a0ec713e 100644 --- a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsUCPhoneConfiguration @@ -327,7 +332,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -349,4 +354,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Uc [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsUnassignedNumber.md b/skype/skype-ps/skype/New-CsUnassignedNumber.md index a42b830c63..963f52646a 100644 --- a/skype/skype-ps/skype/New-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/New-CsUnassignedNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsUnassignedNumber @@ -276,7 +281,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -303,4 +308,3 @@ Creates an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnounce [Get-CsAnnouncement](Get-CsAnnouncement.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md index 669dc3bd75..285f45e328 100644 --- a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsUserReplicatorConfiguration @@ -222,7 +227,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -244,4 +249,3 @@ The `New-CsUserReplicatorConfiguration` cmdlet creates new instances of the Micr [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md b/skype/skype-ps/skype/New-CsUserServicesConfiguration.md index 03ba3cf8b5..6a6f17e252 100644 --- a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/New-CsUserServicesConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsUserServicesConfiguration @@ -418,7 +423,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -440,4 +445,3 @@ The `New-CsUserServicesConfiguration` cmdlet creates new instances of the Micros [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsUserServicesPolicy.md b/skype/skype-ps/skype/New-CsUserServicesPolicy.md index 7736ea0dd2..d9608afa86 100644 --- a/skype/skype-ps/skype/New-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/New-CsUserServicesPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsUserServicesPolicy @@ -225,7 +230,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -249,4 +254,3 @@ The `New-CsUserServicesPolicy` cmdlet creates new instances of the Microsoft.Rtc [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md index e6d6ec5f85..3c55431495 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVideoInteropServerConfiguration @@ -158,7 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -180,4 +185,3 @@ The `New-CsVideoInteropServerConfiguration` cmdlet creates new instances of the [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md index 586a02be60..090e344050 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVideoInteropServerSyntheticTransactionConfiguration @@ -151,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -174,4 +179,3 @@ Returns a VideoInteropServerSyntheticTransactionConfiguration object. [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md index 0e8b7f95e5..554d14112c 100644 --- a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVideoTrunkConfiguration @@ -27,7 +32,7 @@ The Video Interop Server is a Skype service that runs on a standalone pool and c To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -237,7 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -259,4 +264,3 @@ The `New-CsVideoTrunkConfiguration` cmdlet creates new instances of the Microsof [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md index 97af55d79c..9404a4f7ca 100644 --- a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md @@ -1,15 +1,22 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicenormalizationrule +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceNormalizationRule schema: 2.0.0 +manager: bulenteg +author: jenstrier +ms.author: serdars --- # New-CsVoiceNormalizationRule ## SYNOPSIS Creates a new voice normalization rule. -Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by Skype for Business Server. + +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. @@ -32,13 +39,17 @@ New-CsVoiceNormalizationRule [-Tenant <Guid>] -Parent <String> -Name <String> [- ## DESCRIPTION This cmdlet creates a named voice normalization rule. These rules are a required part of phone authorization and call routing. -They define the requirements for converting (or translating) numbers from an internal Skype for Business Server format to a standard (E.164) format. +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. -Rules that are created by using this cmdlet are part of the dial plan and in addition to being accessible through the `Get-CsVoiceNormalizationRule` cmdlet, can also be accessed through the NormalizationRules property returned by a call to the `Get-CsDialPlan` cmdlet. +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 +the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. + ## EXAMPLES @@ -73,6 +84,13 @@ 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 -------------------------- +``` +$nr1=New-CsVoiceNormalizationRule -Identity dp1/nr1 -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' -InMemory +New-CsTenantDialPlan -Identity DP1 -NormalizationRules @{Add=$nr1} +``` + +This example creates a new in-memory voice normalization rule and then adds it to a new tenant dial plan DP1 to be used for Microsoft Teams users. ## PARAMETERS @@ -82,10 +100,12 @@ The Identity specified must include the scope followed by a slash and then the n The name portion will automatically be stored in the Name property. You cannot specify values for Identity and Name in the same command. -Voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. +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. @@ -94,7 +114,7 @@ You cannot include the Identity parameter and the Parent parameter in the same c 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: 2 @@ -114,7 +134,7 @@ The Name parameter and the Identity parameter cannot be used in the same command Type: String Parameter Sets: ParentAndRelativeKey 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 Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named @@ -125,7 +145,8 @@ Accept wildcard characters: False ### -Parent The scope at which the new normalization rule will be created. -This value must be global; site:\<sitename\>, where \<sitename\> 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. +This value must be global; site:\<sitename\>, where \<sitename\> 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. @@ -136,7 +157,7 @@ If you include the Parent parameter, the Name parameter is also required. 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -154,7 +175,7 @@ Maximum string length: 512 characters. 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -166,7 +187,7 @@ 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 is set to False. +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 @@ -174,7 +195,7 @@ Default: 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -192,7 +213,7 @@ Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -210,7 +231,7 @@ This parameter sets the order in which the rules are tested against the number. 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -228,7 +249,7 @@ Default: +$1 (The default prefixes the number with a plus sign \[+\].) 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -244,7 +265,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak 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 Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -255,13 +276,15 @@ 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\>. + +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-\<cmdlet\>. ```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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -270,6 +293,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Describes what would happen if you executed the command without actually executing the command. @@ -277,7 +313,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -293,7 +329,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -303,13 +339,13 @@ Accept wildcard characters: False ``` ### -Tenant -{{Fill Tenant Description}} +For internal Microsoft usage. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -319,7 +355,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/New-CsVoicePolicy.md b/skype/skype-ps/skype/New-CsVoicePolicy.md index 7d53be56ec..1f0e3f4982 100644 --- a/skype/skype-ps/skype/New-CsVoicePolicy.md +++ b/skype/skype-ps/skype/New-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVoicePolicy @@ -569,7 +574,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -596,4 +601,3 @@ This cmdlet creates an instance of the Microsoft.Rtc.Management.WritableConfig.V [Test-CsVoicePolicy](Test-CsVoicePolicy.md) [Get-CsPstnUsage](Get-CsPstnUsage.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceRegex.md b/skype/skype-ps/skype/New-CsVoiceRegex.md index 73f302aafe..dfa493a3db 100644 --- a/skype/skype-ps/skype/New-CsVoiceRegex.md +++ b/skype/skype-ps/skype/New-CsVoiceRegex.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceregex +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceRegex schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # New-CsVoiceRegex @@ -167,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -188,4 +193,3 @@ Creates on object of type Microsoft.Rtc.Management.Voice.OcsVoiceRegex. [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) [New-CsVoiceRoute](New-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceRoute.md b/skype/skype-ps/skype/New-CsVoiceRoute.md index 635bbc555f..f6633618bd 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoute.md +++ b/skype/skype-ps/skype/New-CsVoiceRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVoiceRoute @@ -330,7 +335,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -357,4 +362,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.R [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md index 6073594d81..f6a0bd7f8b 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVoiceRoutingPolicy @@ -190,7 +195,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -214,4 +219,3 @@ The `New-CsVoiceRoutingPolicy` cmdlet creates new instances of Microsoft.Rtc.Man [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md index e95c3b1231..bff35169f4 100644 --- a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVoiceTestConfiguration @@ -308,7 +313,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -339,4 +344,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsDialPlan](Get-CsDialPlan.md) [Get-CsVoicePolicy](Get-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md index 069133c560..58bcb680ea 100644 --- a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsVoicemailReroutingConfiguration @@ -198,7 +203,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -219,4 +224,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumR [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md index 2eb0a61b57..7127cbf0ec 100644 --- a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsWatcherNodeConfiguration @@ -340,7 +345,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -356,4 +361,3 @@ The `New-CsWatcherNodeConfiguration` cmdlet creates new instances of the Microso ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsWebLink.md b/skype/skype-ps/skype/New-CsWebLink.md index 922ee17984..56cf68d55b 100644 --- a/skype/skype-ps/skype/New-CsWebLink.md +++ b/skype/skype-ps/skype/New-CsWebLink.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csweblink +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebLink schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsWebLink @@ -42,19 +47,19 @@ When you install Skype for Business Server a global collection of settings will Managing Autodiscover configuration settings typically means adding Autodiscover URLs. These URLs must be created using the `New-CsWebLink` cmdlet, with the resulting URL stored in a variable and then added to a collection of Autodiscover configuration settings. -Autodiscover URLs are based on the SIP domains used in your organization; administrators will typically create one URL for use by users outside the organization's firewall (for example, http://LyncDiscover.litwareinc.com) and a second URL (for example, http://LyncDiscoverInternal.litwareinc.com) for use by users inside the firewall. +Autodiscover URLs are based on the SIP domains used in your organization; administrators will typically create one URL for use by users outside the organization's firewall (for example, `https://LyncDiscover.litwareinc.com`) and a second URL (for example, `https://LyncDiscoverInternal.litwareinc.com``) for use by users inside the firewall. ## EXAMPLES ### -------------------------- Example 1 -------------------------- ``` -$Link1 = New-CsWebLink -Token "Fabrikam" -Href "http://lyncdiscover.fabrikam.com/" +$Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://lyncdiscover.fabrikam.com/" Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1} ``` -The commands shown in Example 1 add a new Autodiscover URL (http://LyncDiscover.fabrikam.com) to the Autodiscover configuration settings assigned to the Redmond site. +The commands shown in Example 1 add a new Autodiscover URL (`https://LyncDiscover.fabrikam.com`) to the Autodiscover configuration settings assigned to the Redmond site. To do this, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL; that URL is stored in a variable named $Link1. After that, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to add the new URL to any URLs already assigned to these settings. This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. @@ -62,14 +67,14 @@ This is done by using the WebLinks parameter and the parameter value @{Add=$Link ### -------------------------- Example 2 -------------------------- ``` -$Link1 = New-CsWebLink -Token "Fabrikam" -Href "http://lyncdiscover.fabrikam.com/" +$Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://lyncdiscover.fabrikam.com/" -$Link2 = New-CsWebLink -Token "Fabrikam" -Href "http://lyncdiscoverinternal.fabrikam.com/" +$Link2 = New-CsWebLink -Token "Fabrikam" -Href "https://lyncdiscoverinternal.fabrikam.com/" Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1,$Link2} ``` -The commands in Example 2 assign a pair of Autodiscover URLs (http://LyncDiscover.fabrikam.com and http://LyncDiscoverInternal.fabrikam.com) to the Autodiscover configuration settings assigned to the Redmond site.. +The commands in Example 2 assign a pair of Autodiscover URLs (`https://LyncDiscover.fabrikam.com` and `https://LyncDiscoverInternal.fabrikam.com`) to the Autodiscover configuration settings assigned to the Redmond site.. In order to carry out this task, the first two commands use the `New-CsWebLink` cmdlet to create the two Autodiscover URLs; the newly-created URLs are then stored in variables named $Link1 and $Link2. After the two URLs are created, the third command uses the `Set-CsAutoDiscoverConfiguration` cmdlet to assign the two URLs to the Redmond site. To do this, the WebLinks parameter is included along with the parameter value @{Add=$Link1,$Link2}. @@ -81,7 +86,7 @@ That syntax causes the values stored in the variables $Link1 and $Link2 to be ad ### -Href URL for the Autodiscover service, For example: -`-Href "http://lyncdiscover.fabrikam.com/"` +`-Href "https://lyncdiscover.fabrikam.com/"` ```yaml Type: String @@ -116,7 +121,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.W ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsWebOrigin.md b/skype/skype-ps/skype/New-CsWebOrigin.md index d373523dd0..f4c97376ec 100644 --- a/skype/skype-ps/skype/New-CsWebOrigin.md +++ b/skype/skype-ps/skype/New-CsWebOrigin.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csweborigin +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebOrigin schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsWebOrigin @@ -82,7 +87,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -102,4 +107,3 @@ The `New-CsWebOrigin` cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md b/skype/skype-ps/skype/New-CsWebServiceConfiguration.md index d9937fcd36..8b4f16252e 100644 --- a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/New-CsWebServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsWebServiceConfiguration @@ -27,6 +32,7 @@ New-CsWebServiceConfiguration [-Identity] <XdsIdentity> [-AllowAnonymousAccessTo [-ShowAlternateJoinOptionsExpanded <Boolean>] [-UseWsFedPassiveAuth <Boolean>] [-WsFedPassiveMetadataUri <String>] [-CrossDomainAuthorizationList <PSListModifier>] [-EnableMediaBasicAuth <Boolean>] [-EnableStatisticsInResponse <Boolean>] [-HstsMaxAgeInSeconds <Int64>] + [-PendingGetWaitTimeOutInMinutes <Int64>] [-PendingGetWaitSupportingApps <String>] [-MobilePreferredAuthType <MobilePreferredAuthType>] [-UseDomainAuthInLWA <Boolean>] [-UseWebClientLegacyUI <Boolean>] [<CommonParameters>] ``` @@ -47,7 +53,7 @@ Likewise, your command will fail if you try to create a new collection at, for i ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsWebServiceConfiguration -Identity site:Redmond -EnableGroupExpansion $False -UseCertificateAuth $True ``` @@ -60,7 +66,7 @@ Note that this command will fail if a collection of Web Services configuration s That's because sites are limited to a single collection of Web Services configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsWebServiceConfiguration -Identity site:Redmond -InMemory @@ -82,7 +88,7 @@ If you do not call the `Set-CsWebServiceConfiguration` cmdlet, no new settings w Instead, your virtual Web Services configuration settings will disappear as soon as you end your Windows PowerShell session or delete the variable $x. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = New-CsWebOrigin -Url "http://fabrikam.com/" @@ -97,7 +103,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 4 -------------------------- +### Example 4 ``` $x = New-CsWebOrigin -Url "http://fabrikam.com/" @@ -728,6 +734,46 @@ 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. + +```yaml +Type: Int64 +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 +``` + +### -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. + +```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 +``` + ### -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. @@ -801,7 +847,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -823,4 +869,3 @@ The `New-CsWebServiceConfiguration` cmdlet creates new instances of the Microsof [Remove-CsWebServiceConfiguration](Remove-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md b/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md index 2d6eaa71bf..1ae3b83bb3 100644 --- a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md +++ b/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # New-CsWebTrustedCACertificate @@ -94,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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -114,4 +119,3 @@ The `New-CsWebTrustedCACertificate` cmdlet creates new instances of the Microsof [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md b/skype/skype-ps/skype/New-CsXmppAllowedPartner.md index 6646680e6d..3143cc1192 100644 --- a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/New-CsXmppAllowedPartner.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-csxmppallowedpartner +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsXmppAllowedPartner schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # New-CsXmppAllowedPartner @@ -365,7 +370,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -387,4 +392,3 @@ The `New-CsXmppAllowedPartner` cmdlet creates new instances of the Microsoft.Rtc [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Publish-CsLisConfiguration.md b/skype/skype-ps/skype/Publish-CsLisConfiguration.md index f990df4fc5..a3a95573fd 100644 --- a/skype/skype-ps/skype/Publish-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Publish-CsLisConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Publish-CsLisConfiguration @@ -55,7 +60,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -87,7 +92,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -112,4 +117,3 @@ This cmdlet does not return a value. [Export-CsLisConfiguration](Export-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Publish-CsTopology.md b/skype/skype-ps/skype/Publish-CsTopology.md index be374acf9d..a947773c93 100644 --- a/skype/skype-ps/skype/Publish-CsTopology.md +++ b/skype/skype-ps/skype/Publish-CsTopology.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Publish-CsTopology @@ -188,7 +193,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -238,7 +243,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -263,4 +268,3 @@ Instead, the `Publish-CsTopology` cmdlet publishes instances of the Microsoft.Rt [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) [Test-CsTopology](Test-CsTopology.md) - diff --git a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md index e7af78b0ce..9dcace377f 100644 --- a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Register-CsHybridPSTNAppliance @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the `Register-CsHybridPSTNAppliance` cmdlet to create a new Skype for Business Cloud Connector Edition appliance. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -187,7 +194,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -196,4 +203,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md deleted file mode 100644 index 1115fb3271..0000000000 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Register-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 ---- - -# Register-CsOnlineDialInConferencingServiceNumber - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### UniqueNumberParams -``` -Register-CsOnlineDialInConferencingServiceNumber [-Identity] <String> [-BridgeId <Guid>] - [-BridgeName <String>] [-Tenant <Guid>] [-TenantDomain <String>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -### InstanceParams -``` -Register-CsOnlineDialInConferencingServiceNumber [-Instance] <ConferencingServiceNumber> - [-BridgeId <Guid>] [-BridgeName <String>] [-Tenant <Guid>] [-TenantDomain <String>] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: ConferencingServiceNumber - -```yaml -Type: ConferencingServiceNumber -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeId -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CSOnlinePSTNGateway.md b/skype/skype-ps/skype/Remove-CSOnlinePSTNGateway.md deleted file mode 100644 index f024cd02ab..0000000000 --- a/skype/skype-ps/skype/Remove-CSOnlinePSTNGateway.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: -applicable: Skype for Business Online -title: Remove-CSOnlinePSTNGateway -schema: 2.0.0 ---- - -# Remove-CSOnlinePSTNGateway - -## SYNOPSIS -Removes 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. - -## SYNTAX -``` -Remove-CSOnlinePSTNGateway -Identity <SBCFQDN> -``` - -## DESCRIPTION -Use this cmdlet to remove the configuration of the previously created Session Border Controller(s) (SBC(s)) configuration. Note the SBC must be removed from all voice routes before executing this cmdlet - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CSOnlinePSTNGateway -Identity sbc.contoso.com -``` - -This example removes SBC with Identity (and FQDN) sbc.contoso.com - -### Example 2 -```powershell -PS C:\> Removes-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"} -``` - -This example removes the SBC with identities (and FQDNs) matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc - -## PARAMETERS - -### -Identity -The parameter is mandatory for the cmdlet. The Identity is the same as the SBC FQDN. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md) - -[New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md) - -[Get-CSOnlinePSTNGateway](Get-CSOnlinePSTNGateway.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md index 88465d83f9..37d8b834d3 100644 --- a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAVEdgeConfiguration @@ -136,7 +141,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsAVEdgeConfiguration](New-CsAVEdgeConfiguration.md) [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md b/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md index 5ee41889c5..9840f5844b 100644 --- a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAdditionalInternalDomain ## SYNOPSIS -Removes an additional internal domain previously configured for use in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 – December 2017. +Removes an additional internal domain previously configured for use in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 - December 2017. ## SYNTAX @@ -27,8 +32,8 @@ domains. ## EXAMPLES ### -------------------------- Example 1 ------------------------ -``` -PS C:\> Remove-CsAdditionalInternalDomain -Identity fabrikam.com +```powershell +Remove-CsAdditionalInternalDomain -Identity fabrikam.com ``` Example 1 removes the additional internal domain with the Identity fabrikam.com. @@ -84,7 +89,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +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 @@ -101,7 +106,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -115,6 +120,6 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsAdditionalInternalDomain](https://docs.microsoft.com/en-us/powershell/module/skype/new-csadditionalinternaldomain?view=skype-ps) +[New-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain?view=skype-ps) -[Get-CsAdditionalInternalDomain](https://docs.microsoft.com/en-us/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md b/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md index dfccc52be9..6462ca6564 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAddressBookConfiguration @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -162,4 +167,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [New-CsAddressBookConfiguration](New-CsAddressBookConfiguration.md) [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md index b1b097b2c3..5aa40f5cda 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAddressBookNormalizationConfiguration @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ Instead, the `Remove-CsAddressBookNormalizationConfiguration` cmdlet deletes exi [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md index 8e7f5838de..b1f7133ca9 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAddressBookNormalizationRule @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ Instead, the `Remove-CsAddressBookNormalizationRule` cmdlet deletes existing ins [New-CsAddressBookNormalizationRule](New-CsAddressBookNormalizationRule.md) [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsAdminRole.md b/skype/skype-ps/skype/Remove-CsAdminRole.md index f5b2735014..0902573360 100644 --- a/skype/skype-ps/skype/Remove-CsAdminRole.md +++ b/skype/skype-ps/skype/Remove-CsAdminRole.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAdminRole @@ -234,7 +239,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -250,4 +255,3 @@ The `Remove-CsAdminRole` cmdlet deletes existing instances of the Microsoft.Rtc. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsAllowedDomain.md b/skype/skype-ps/skype/Remove-CsAllowedDomain.md index c8131f8252..369b896c1d 100644 --- a/skype/skype-ps/skype/Remove-CsAllowedDomain.md +++ b/skype/skype-ps/skype/Remove-CsAllowedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAllowedDomain @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,4 +176,3 @@ Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.A [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsAllowedDomain](Set-CsAllowedDomain.md) - diff --git a/skype/skype-ps/skype/Remove-CsAnalogDevice.md b/skype/skype-ps/skype/Remove-CsAnalogDevice.md index 846c3a1b64..2934cae81d 100644 --- a/skype/skype-ps/skype/Remove-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Remove-CsAnalogDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAnalogDevice @@ -130,7 +135,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -154,4 +159,3 @@ The `Remove-CsAnalogDevice` cmdlet deletes existing instances of the Microsoft.R [New-CsAnalogDevice](New-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Remove-CsAnnouncement.md b/skype/skype-ps/skype/Remove-CsAnnouncement.md index a5e2abfcc7..b51ed922b3 100644 --- a/skype/skype-ps/skype/Remove-CsAnnouncement.md +++ b/skype/skype-ps/skype/Remove-CsAnnouncement.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAnnouncement @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -144,4 +149,3 @@ Deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settin [Set-CsAnnouncement](Set-CsAnnouncement.md) [Get-CsAnnouncement](Get-CsAnnouncement.md) - diff --git a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md b/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md index 82e8068a53..cd4dcbd64d 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsArchivingConfiguration @@ -152,7 +157,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -177,4 +182,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md b/skype/skype-ps/skype/Remove-CsArchivingPolicy.md index 500fd5894f..aad1e6bdd9 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsArchivingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsArchivingPolicy @@ -184,7 +189,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -209,4 +214,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [New-CsArchivingPolicy](New-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md index caf94843e7..28d818613b 100644 --- a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAutodiscoverConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsAutodiscoverConfiguration @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableC ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md index 6995e6bc54..c6a0bc6cfc 100644 --- a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsBackupServiceConfiguration @@ -110,7 +115,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -130,4 +135,3 @@ Instead, the `Remove-CsBackupServiceConfiguration` cmdlet deletes instances of t [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md index a9e0347aea..41f3e9cac6 100644 --- a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsBandwidthPolicyServiceConfiguration @@ -118,7 +123,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -141,4 +146,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ba [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsBlockedDomain.md b/skype/skype-ps/skype/Remove-CsBlockedDomain.md index 1a30d92ca3..29b6a48035 100644 --- a/skype/skype-ps/skype/Remove-CsBlockedDomain.md +++ b/skype/skype-ps/skype/Remove-CsBlockedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsBlockedDomain @@ -138,7 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -162,4 +167,3 @@ Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.B [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsBlockedDomain](Set-CsBlockedDomain.md) - diff --git a/skype/skype-ps/skype/Remove-CsBusyOptions.md b/skype/skype-ps/skype/Remove-CsBusyOptions.md index d0598dac67..3a462337d7 100644 --- a/skype/skype-ps/skype/Remove-CsBusyOptions.md +++ b/skype/skype-ps/skype/Remove-CsBusyOptions.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsBusyOptions @@ -98,7 +103,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -113,6 +118,6 @@ This cmdlet does not return any objects. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://docs.microsoft.com/en-us/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://docs.microsoft.com/en-us/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md b/skype/skype-ps/skype/Remove-CsCallParkOrbit.md index 65e2f232f3..c2fc47f998 100644 --- a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/Remove-CsCallParkOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsCallParkOrbit @@ -124,7 +129,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallP [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) - diff --git a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md index fc08ae6e9e..80f2007953 100644 --- a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsCallViaWorkPolicy @@ -19,9 +24,7 @@ Remove-CsCallViaWorkPolicy [-Identity] <XdsIdentity> [-Confirm] [-Force] [-Tenan ``` ## DESCRIPTION -To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command from the Windows PowerShell prompt. - -`Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"}` +Use this cmdlet to delete an existing call via work policy. ## EXAMPLES @@ -107,7 +110,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -123,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +149,3 @@ None. [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsCallerIdPolicy.md b/skype/skype-ps/skype/Remove-CsCallerIdPolicy.md deleted file mode 100644 index 4c4b5fd633..0000000000 --- a/skype/skype-ps/skype/Remove-CsCallerIdPolicy.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsCallerIdPolicy -schema: 2.0.0 ---- - -# Remove-CsCallerIdPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Remove-CsCallerIdPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsCallingLineIdentity.md b/skype/skype-ps/skype/Remove-CsCallingLineIdentity.md deleted file mode 100644 index 51ce18d87b..0000000000 --- a/skype/skype-ps/skype/Remove-CsCallingLineIdentity.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsCallingLineIdentity -schema: 2.0.0 ---- - -# Remove-CsCallingLineIdentity - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Remove-CsCallingLineIdentity [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md b/skype/skype-ps/skype/Remove-CsCdrConfiguration.md index ffa6ace51f..fd052dd951 100644 --- a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsCdrConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsCdrConfiguration @@ -142,7 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsCdrConfiguration](New-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsCertificate.md b/skype/skype-ps/skype/Remove-CsCertificate.md index a40f91a1d0..f66a9b06f6 100644 --- a/skype/skype-ps/skype/Remove-CsCertificate.md +++ b/skype/skype-ps/skype/Remove-CsCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsCertificate @@ -211,7 +216,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Remove-CsClientPolicy.md b/skype/skype-ps/skype/Remove-CsClientPolicy.md index 2f55972f1f..dad1f49490 100644 --- a/skype/skype-ps/skype/Remove-CsClientPolicy.md +++ b/skype/skype-ps/skype/Remove-CsClientPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClientPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Remove-CsClientPolicy @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +194,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsClientPolicy](New-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md b/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md index 697b0f70cd..fee4af8bf2 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClientVersionConfiguration @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -162,4 +167,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsClientVersionConfiguration](New-CsClientVersionConfiguration.md) [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md b/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md index ae3a857e8a..73274296e7 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClientVersionPolicy @@ -167,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -191,4 +196,3 @@ The `Remove-CsClientVersionPolicy` cmdlet deletes existing instances of the Micr [New-CsClientVersionPolicy](New-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md index 62c4a9432f..9ab5db8977 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClientVersionPolicyRule @@ -186,7 +191,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -209,4 +214,3 @@ Instead, the `Remove-CsClientVersionPolicyRule` cmdlet deletes instances of the [New-CsClientVersionPolicyRule](New-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsClsConfiguration.md b/skype/skype-ps/skype/Remove-CsClsConfiguration.md index 1531349133..2e6f11933a 100644 --- a/skype/skype-ps/skype/Remove-CsClsConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsClsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClsConfiguration @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -172,4 +177,3 @@ Instead, the `Remove-CsClsConfiguration` cmdlet deletes existing instances of th [New-CsClsConfiguration](New-CsClsConfiguration.md) [Set-CsClsConfiguration](Set-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsClsRegion.md b/skype/skype-ps/skype/Remove-CsClsRegion.md index 9f340cfc0d..d453a56054 100644 --- a/skype/skype-ps/skype/Remove-CsClsRegion.md +++ b/skype/skype-ps/skype/Remove-CsClsRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClsRegion @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ Instead, the `Remove-CsClsRegion` cmdlet deletes existing instances of the Micro [New-CsClsRegion](New-CsClsRegion.md) [Set-CsClsRegion](Set-CsClsRegion.md) - diff --git a/skype/skype-ps/skype/Remove-CsClsScenario.md b/skype/skype-ps/skype/Remove-CsClsScenario.md index 7eac6a0c55..c1cf3ade17 100644 --- a/skype/skype-ps/skype/Remove-CsClsScenario.md +++ b/skype/skype-ps/skype/Remove-CsClsScenario.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClsScenario @@ -131,7 +136,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -147,4 +152,3 @@ Instead, the `Remove-CsClsScenario` cmdlet deletes existing instances of the Mic ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md b/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md index 4777666181..823296de5b 100644 --- a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsClsSecurityGroup @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ Instead, the `Remove-CsClsSecurityGroup` cmdlet deletes existing instances of th [New-CsClsSecurityGroup](New-CsClsSecurityGroup.md) [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md b/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md index 8ea531af26..2a890219dc 100644 --- a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsCommonAreaPhone @@ -127,7 +132,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -151,4 +156,3 @@ The `Remove-CsCommonAreaPhone` cmdlet deletes existing instances of the Microsof [New-CsCommonAreaPhone](New-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md b/skype/skype-ps/skype/Remove-CsConferenceDirectory.md index 45dde638f4..407a22cf8c 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/Remove-CsConferenceDirectory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsConferenceDirectory @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ Instead, the `Removes-CsConferenceDirectory` cmdlet deletes instances of the Mic [Move-CsConferenceDirectory](Move-CsConferenceDirectory.md) [New-CsConferenceDirectory](New-CsConferenceDirectory.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md b/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md index e3c6cb72b9..efd4048142 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md +++ b/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsConferenceDisclaimer @@ -109,7 +114,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -130,4 +135,3 @@ Instead, the `Remove-CsConferenceDisclaimer` cmdlet resets existing instances of [Get-CsConferenceDisclaimer](Get-CsConferenceDisclaimer.md) [Set-CsConferenceDisclaimer](Set-CsConferenceDisclaimer.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md b/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md index e97dda92ee..4164a16021 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsConferencingConfiguration @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -172,4 +177,3 @@ Instead, the `Remove-CsConferencingConfiguration` cmdlet deletes existing instan [New-CsConferencingConfiguration](New-CsConferencingConfiguration.md) [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md b/skype/skype-ps/skype/Remove-CsConferencingPolicy.md index 55771a4942..cbc2051711 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsConferencingPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConferencingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Remove-CsConferencingPolicy @@ -175,7 +180,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -200,4 +205,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsConferencingPolicy](New-CsConferencingPolicy.md) [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md b/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md index 74d506ddf0..654ff393a0 100644 --- a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsConfigurationStoreLocation @@ -140,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ The `Remove-CsConfigurationStoreLocation` cmdlet does not return any objects or [Get-CsConfigurationStoreLocation](Get-CsConfigurationStoreLocation.md) [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md b/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md index 3f60750708..1d6e47fc07 100644 --- a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsConversationHistoryConfiguration @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ Instead, `Remove-CsConversationHistoryConfiguration` resets instances of the Mic [Get-CsConversationHistoryConfiguration](Get-CsConversationHistoryConfiguration.md) [Set-CsConversationHistoryConfiguration](Set-CsConversationHistoryConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md b/skype/skype-ps/skype/Remove-CsCpsConfiguration.md index 53fbc9a46b..31f01a2608 100644 --- a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsCpsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsCpsConfiguration @@ -122,7 +127,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallP [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md index 9a7d391082..3ba03e403a 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDeviceUpdateConfiguration @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -173,4 +178,3 @@ Instead, the `Remove-CsDeviceUpdateConfiguration` cmdlet deletes instances of th [New-CsDeviceUpdateConfiguration](New-CsDeviceUpdateConfiguration.md) [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md index 1241cd96dc..f13625d1e3 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDeviceUpdateRule @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -169,4 +174,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md index d0e750965e..863e71f71f 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDiagnosticConfiguration @@ -139,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -162,4 +167,3 @@ Instead, the `Remove-CsDiagnosticConfiguration` cmdlet deletes existing instance [New-CsDiagnosticConfiguration](New-CsDiagnosticConfiguration.md) [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md index 3a5f539887..5b42883a96 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDiagnosticHeaderConfiguration @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -167,4 +172,3 @@ Instead, the `Remove-CsDiagnosticHeaderConfiguration` cmdlet deletes existing in [New-CsDiagnosticHeaderConfiguration](New-CsDiagnosticHeaderConfiguration.md) [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md index 053a4bff25..7f4137e2f9 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDialInConferencingAccessNumber @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -167,4 +172,3 @@ The `Remove-CsDialInConferencingAccessNumber` cmdlet deletes instances of the Mi [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md index 0a21b0d893..e0c94267aa 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDialInConferencingConfiguration @@ -138,7 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -161,4 +166,3 @@ Instead, the `Remove-CSDialInConferencingConfiguration` cmdlet deletes instances [New-CsDialInConferencingConfiguration](New-CsDialInConferencingConfiguration.md) [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md index 4ff6663ed5..8eaaf5a8d7 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDialInConferencingDtmfConfiguration @@ -143,7 +148,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -166,4 +171,3 @@ Instead, the `Remove-CSDialInConferencingDtmfConfiguration` cmdlet deletes insta [New-CsDialInConferencingDtmfConfiguration](New-CsDialInConferencingDtmfConfiguration.md) [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialPlan.md b/skype/skype-ps/skype/Remove-CsDialPlan.md index 3c77832e66..e42285747c 100644 --- a/skype/skype-ps/skype/Remove-CsDialPlan.md +++ b/skype/skype-ps/skype/Remove-CsDialPlan.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsDialPlan @@ -120,7 +125,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -150,4 +155,3 @@ This cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Pol [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md index 83a7133cac..12953178d6 100644 --- a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsEnhancedEmergencyServiceDisclaimer @@ -106,7 +111,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -129,4 +134,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Loc [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) [Get-CsLocationPolicy](Get-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsExUmContact.md b/skype/skype-ps/skype/Remove-CsExUmContact.md index bd83367a69..264bd46774 100644 --- a/skype/skype-ps/skype/Remove-CsExUmContact.md +++ b/skype/skype-ps/skype/Remove-CsExUmContact.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsExUmContact @@ -101,7 +106,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -126,4 +131,3 @@ It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUm [Get-CsExUmContact](Get-CsExUmContact.md) [Move-CsExUmContact](Move-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md index 143280cca8..d10506b89c 100644 --- a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md @@ -1,18 +1,22 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalaccesspolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsExternalAccessPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Remove-CsExternalAccessPolicy ## SYNOPSIS Enables you to remove an existing external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live and 3) access Skype for Business Server over the Internet, without having to log on to your internal network. +External access policies determine whether or not your users can: 1) Communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) Communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; 3) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop) and 4) Access Skype for Business Server over the Internet, without having to log on to your internal network. This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ``` @@ -24,18 +28,17 @@ Remove-CsExternalAccessPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. -1. -That might be sufficient to meet your communication needs. +1. That might be sufficient to meet your communication needs. If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -2. -Communicate with people who have SIP accounts with a federated organization. +2. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -3. -Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. +3. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. @@ -48,7 +51,6 @@ You can also run the `Remove-CsExternalAccessPolicy` cmdlet against the global e In that case, however, the global policies will not be deleted; by design, global policies cannot be deleted. Instead, the properties of the global policy will simply be reset to their default values. - ## EXAMPLES ### -------------------------- Example 1 ------------------------ @@ -59,7 +61,6 @@ Remove-CsExternalAccessPolicy -Identity site:Redmond In Example 1, the external access policy with the Identity site:Redmond is deleted. After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. - ### -------------------------- Example 2 ------------------------ ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy @@ -69,7 +70,6 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. - ### -------------------------- Example 3 ------------------------ ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy @@ -80,7 +80,6 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. - ### -------------------------- Example 4 ------------------------ ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy @@ -95,7 +94,6 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo `Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True}` - ## PARAMETERS ### -Identity @@ -108,11 +106,10 @@ To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessP Note that wildcards are not allowed when specifying an Identity. - ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -125,11 +122,10 @@ Accept wildcard characters: False ### -Force Suppresses the display of any non-fatal error message that might occur when running the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -142,7 +138,6 @@ Accept wildcard characters: False ### -WhatIf Describes what would happen if you executed the command without actually executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -159,7 +154,6 @@ Accept wildcard characters: False ### -Confirm Prompts you for confirmation before executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -183,11 +177,10 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` - ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -198,7 +191,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -224,4 +217,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md index 53ab8d82a4..a7a6576fd6 100644 --- a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Remove-CsExternalUserCommunicationPolicy @@ -113,7 +118,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -126,4 +131,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md b/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md index 8a834ec8e7..21351e05ab 100644 --- a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsFIPSConfiguration @@ -22,7 +27,7 @@ Remove-CsFIPSConfiguration [-Identity] <XdsIdentity> [-Confirm] [-Force] [-Tenan ## DESCRIPTION The Federal Information Processing Standards (FIPS) are a series of standards and guidelines used by computers engaged in work for the United States government; for example, there are FIPS standards that govern the use of such things as cryptography, encryption, and digital signatures. -(See http://www.itl.nist.gov/fipspubs/by-num.htm (http://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. +(See https://www.itl.nist.gov/fipspubs/by-num.htm (https://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. If you need to work with the United States government (or with other entities that follow FIPS) then you can enable FIPS compliance in Skype for Business Server. Keep in mind, however, that, for the on-premises version of Skype for Business Server, you have only a single, global collection of FIPS configuration settings: FIPS compliance can only be enabled or disabled for your entire Skype for Business Server implementation. @@ -142,7 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -164,4 +169,3 @@ Instead, the `Remove-CsFIPSConfiguration` cmdlet deletes existing instances of t [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md index 079abeba4e..bcffa2634d 100644 --- a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsFileTransferFilterConfiguration @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,4 +160,3 @@ Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Set [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md index 0878803ade..f6a9d6484e 100644 --- a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsGroupPickupUserOrbit @@ -104,7 +109,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -119,4 +124,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md index e7f1efe190..d7ea78fe80 100644 --- a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsHealthMonitoringConfiguration @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ Instead, the `Remove-CsHealthMonitoringConfiguration` cmdlet deletes existing in [New-CsHealthMonitoringConfiguration](New-CsHealthMonitoringConfiguration.md) [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md index d7073d7dee..ce701e607c 100644 --- a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsHostedVoicemailPolicy @@ -135,7 +140,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voic [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsHostingProvider.md b/skype/skype-ps/skype/Remove-CsHostingProvider.md index acabf26128..8dd1e03560 100644 --- a/skype/skype-ps/skype/Remove-CsHostingProvider.md +++ b/skype/skype-ps/skype/Remove-CsHostingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsHostingProvider @@ -167,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -194,4 +199,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsHostingProvider](New-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsHuntGroup.md b/skype/skype-ps/skype/Remove-CsHuntGroup.md deleted file mode 100644 index 46bcb36601..0000000000 --- a/skype/skype-ps/skype/Remove-CsHuntGroup.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Remove-CsHuntGroup -schema: 2.0.0 ---- - -# Remove-CsHuntGroup - -## SYNOPSIS -The Remove-CsHuntGroup cmdlet deletes an existing Call Queue. - -## SYNTAX - -``` -Remove-CsHuntGroup -PrimaryUri <System.Uri> [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-CsHuntGroup cmdlet deletes an existing Call Queue specified by the PrimaryUri parameter. - -The Remove-CsHuntGroup cmdlet may suggest additional steps required to complete the Call Queue setup. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" -``` - -This example deletes the Call Queue with the primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com". - - - - -## PARAMETERS - -### -PrimaryUri -The PrimaryUri parameter represents the SIP address for the Call Queue. It must start with "sip:". - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassDualWrite -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for Microsoft internal use only. - -PARAMVALUE: Fqdn - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. This parameter is reserved for Microsoft internal use only. - -```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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Uri - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.HuntGroup.Models.HuntGroup - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md index 0bdfbe5f9f..947839dc20 100644 --- a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsHybridApplicationEndpoint @@ -82,7 +87,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -96,8 +101,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md b/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md index 9f42400a53..57891ebc8e 100644 --- a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Remove-CsHybridPSTNSite @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the `Remove-CsHybridPSTNSite` cmdlet to remove a previously specified hybrid public switched telephone network (PSTN) site. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -134,7 +141,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +156,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsImConfiguration.md b/skype/skype-ps/skype/Remove-CsImConfiguration.md index fd4350aa64..9b6ba26e08 100644 --- a/skype/skype-ps/skype/Remove-CsImConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsImConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsImConfiguration @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -125,8 +130,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md b/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md index 173451d222..25c342bb06 100644 --- a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsImFilterConfiguration @@ -118,7 +123,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +145,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFil [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md b/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md index 536adaf479..f3d59ef6ed 100644 --- a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsImTranslationConfiguration @@ -97,7 +102,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -106,4 +111,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md index c618292b7f..acd10f5224 100644 --- a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsKerberosAccountAssignment @@ -130,7 +135,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -154,4 +159,3 @@ Instead, the cmdlet deletes existing instances of the Microsoft.Rtc.Management.W [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisLocation.md b/skype/skype-ps/skype/Remove-CsLisLocation.md index 57247aca3c..ccca42e1b3 100644 --- a/skype/skype-ps/skype/Remove-CsLisLocation.md +++ b/skype/skype-ps/skype/Remove-CsLisLocation.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLisLocation @@ -458,7 +463,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -488,4 +493,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Remove-CsLisWirelessAccessPoint](Remove-CsLisWirelessAccessPoint.md) [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisPort.md b/skype/skype-ps/skype/Remove-CsLisPort.md index 9ac7e75142..6a06ce9cb4 100644 --- a/skype/skype-ps/skype/Remove-CsLisPort.md +++ b/skype/skype-ps/skype/Remove-CsLisPort.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLisPort @@ -154,7 +159,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -178,4 +183,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Remove-CsLisLocation](Remove-CsLisLocation.md) [Remove-CsLisSwitch](Remove-CsLisSwitch.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md b/skype/skype-ps/skype/Remove-CsLisServiceProvider.md index 0c122d0742..e7c73e5c72 100644 --- a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md +++ b/skype/skype-ps/skype/Remove-CsLisServiceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLisServiceProvider @@ -70,7 +75,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -90,4 +95,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Set-CsLisServiceProvider](Set-CsLisServiceProvider.md) [Get-CsLisServiceProvider](Get-CsLisServiceProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisSubnet.md b/skype/skype-ps/skype/Remove-CsLisSubnet.md index e2e98115b7..3ce56e33d1 100644 --- a/skype/skype-ps/skype/Remove-CsLisSubnet.md +++ b/skype/skype-ps/skype/Remove-CsLisSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLisSubnet @@ -110,7 +115,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,4 +136,3 @@ This cmdlet removes an object of type System.Management.Automation.PSCustomObjec [Get-CsLisSubnet](Get-CsLisSubnet.md) [Remove-CsLisLocation](Remove-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisSwitch.md b/skype/skype-ps/skype/Remove-CsLisSwitch.md index f2cc5ff2e8..5ef8122f1d 100644 --- a/skype/skype-ps/skype/Remove-CsLisSwitch.md +++ b/skype/skype-ps/skype/Remove-CsLisSwitch.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLisSwitch @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -136,4 +141,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Remove-CsLisLocation](Remove-CsLisLocation.md) [Get-CsLisPort](Get-CsLisPort.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md b/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md index 869a0bfc58..044104f835 100644 --- a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLisWirelessAccessPoint @@ -106,7 +111,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -127,4 +132,3 @@ This cmdlet removes an object of type System.Management.Automation.PSCustomObjec [Get-CsLisWirelessAccessPoint](Get-CsLisWirelessAccessPoint.md) [Remove-CsLisLocation](Remove-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Remove-CsLocationPolicy.md b/skype/skype-ps/skype/Remove-CsLocationPolicy.md index 760b126717..b6aa1cf457 100644 --- a/skype/skype-ps/skype/Remove-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Remove-CsLocationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsLocationPolicy @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -176,4 +181,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) [Test-CsLocationPolicy](Test-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsManagementConnection.md b/skype/skype-ps/skype/Remove-CsManagementConnection.md index eaf1c4223d..6df3c26265 100644 --- a/skype/skype-ps/skype/Remove-CsManagementConnection.md +++ b/skype/skype-ps/skype/Remove-CsManagementConnection.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsManagementConnection @@ -79,7 +84,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -102,4 +107,3 @@ Instead, the `Remove-CsManagementConnection` cmdlet deletes instances of the Mic [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) [Set-CsManagementConnection](Set-CsManagementConnection.md) - diff --git a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md b/skype/skype-ps/skype/Remove-CsMcxConfiguration.md index c0b43a6925..87060d1bca 100644 --- a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsMcxConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsMcxConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsMcxConfiguration @@ -163,7 +168,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -180,4 +185,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableC ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md b/skype/skype-ps/skype/Remove-CsMediaConfiguration.md index 82824ec0eb..afa18b9584 100644 --- a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsMediaConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsMediaConfiguration @@ -127,7 +132,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +154,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md b/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md index b3c256d2eb..29096e1294 100644 --- a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsMeetingConfiguration @@ -162,7 +167,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -185,4 +190,3 @@ Instead, the `Remove-CsMeetingConfiguration` cmdlet deletes existing instances o [New-CsMeetingConfiguration](New-CsMeetingConfiguration.md) [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md b/skype/skype-ps/skype/Remove-CsMobilityPolicy.md index fb563fba4a..bf1e210f0e 100644 --- a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Remove-CsMobilityPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsMobilityPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Remove-CsMobilityPolicy @@ -194,7 +199,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -211,4 +216,3 @@ Instead, the `Remove-CsMobilityPolicy` cmdlet deletes instances of the Microsoft ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md index 2cba7bbfd9..134bd4667f 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkBandwidthPolicyProfile @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +153,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md b/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md index 024ab43345..ae7068d77e 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkConfiguration @@ -102,7 +107,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -137,4 +142,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md index d222701da1..3df20e1a1b 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkInterRegionRoute @@ -118,7 +123,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -141,4 +146,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md index 8f3035fb1f..8dc5aaec89 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkInterSitePolicy @@ -113,7 +118,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -136,4 +141,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegion.md b/skype/skype-ps/skype/Remove-CsNetworkRegion.md index 8eff3f89d6..3f35e18280 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegion.md +++ b/skype/skype-ps/skype/Remove-CsNetworkRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkRegion @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkRegion](Set-CsNetworkRegion.md) [Get-CsNetworkRegion](Get-CsNetworkRegion.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md b/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md index b5f80f522c..57fec11fcc 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkRegionLink @@ -115,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +143,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkRegionLink](Set-CsNetworkRegionLink.md) [Get-CsNetworkRegionLink](Get-CsNetworkRegionLink.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkSite.md b/skype/skype-ps/skype/Remove-CsNetworkSite.md index 161cd8c223..385a4f9411 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSite.md +++ b/skype/skype-ps/skype/Remove-CsNetworkSite.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkSite @@ -113,7 +118,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -136,4 +141,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkSite](Set-CsNetworkSite.md) [Get-CsNetworkSite](Get-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md b/skype/skype-ps/skype/Remove-CsNetworkSubnet.md index c60bdf0e73..60a89146b9 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/Remove-CsNetworkSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsNetworkSubnet @@ -115,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +143,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) - diff --git a/skype/skype-ps/skype/Remove-CsOAuthServer.md b/skype/skype-ps/skype/Remove-CsOAuthServer.md index 553db9d3a5..8841ad2fa5 100644 --- a/skype/skype-ps/skype/Remove-CsOAuthServer.md +++ b/skype/skype-ps/skype/Remove-CsOAuthServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsOAuthServer @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -169,4 +174,3 @@ Instead, the `Remove-CsOAuthServer` cmdlet deletes existing instances of the Mic [New-CsOAuthServer](New-CsOAuthServer.md) [Set-CsOAuthServer](Set-CsOAuthServer.md) - diff --git a/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md deleted file mode 100644 index 41adcc5fd4..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsOnlineApplicationEndpoint -schema: 2.0.0 ---- - -# Remove-CsOnlineApplicationEndpoint - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Remove-CsOnlineApplicationEndpoint [-Uri] <String> [-Audience <String>] [-Ring <String>] - [-PhoneNumber <String>] [-IsInternalRun <Boolean>] [-Tenant <Guid>] - [-RunFullProvisioningFlow <Boolean>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The following parameters are not applicable to Skype for Business Online: AsJob, Audience, DomainController, Force, IsInternalRun, PhoneNumber, PipelineVariable, Ring, and RunFullProvisioningFlow - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Uri -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -{{Fill IsInternalRun Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -{{Fill Ring Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -{{Fill RunFullProvisioningFlow Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md deleted file mode 100644 index 2958ec9cdf..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsOnlineLisCivicAddress -schema: 2.0.0 ---- - -# Remove-CsOnlineLisCivicAddress - -## SYNOPSIS -Use the `Remove-CsOnlineLisCivicAddress` cmdlet to delete an existing civic address from the Location Information Server (LIS.) You can't remove a civic address if any of its associated locations are assigned to users. - -## SYNTAX - -``` -Remove-CsOnlineLisCivicAddress -CivicAddressId <Guid> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsOnlineLisCivicAddress -CivicAddressId ee38d9a5-33dc-4a32-9fb8-f234cedb91ac -``` - -This example removes the emergency civic address with the specified identification. - - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineLisCivicAddress -City Redmond | Remove-CsOnlineLisCivicAddress -``` - -This example removes all the emergency civic addresses in the city of Redmond. - - -## PARAMETERS - -### -CivicAddressId -Specifies the unique identifier of the civic address to be deleted. -You can find civic address identifiers by using the `Get-CsOnlineLisCivicAddress` cmdlet. - -```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 -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet accepts pipelined input from the `Get-CsOnlineLisCivicAddress` cmdlet. - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisLocation.md b/skype/skype-ps/skype/Remove-CsOnlineLisLocation.md deleted file mode 100644 index 3af2250003..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineLisLocation.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsOnlineLisLocation -schema: 2.0.0 ---- - -# Remove-CsOnlineLisLocation - -## SYNOPSIS -Use the `Remove-CsOnlineLisLocation` cmdlet to remove an existing emergency location from the Location Information Service (LIS.) You can only remove locations that have no assigned users. - -## SYNTAX -``` -Remove-CsOnlineLisLocation -LocationId <Guid> [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -If the location specified for removal is assigned to users, the cmdlet will fail until the users assignments are removed. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsOnlineLisLocation -LocationId 788dd820-c136-4255-9f61-24b880ad0763 -``` - -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet supports pipelined input from the `Get-CsOnlineLisLocation` cmdlet. - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md deleted file mode 100644 index a8fa009f3f..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsOnlineNumberPortInOrder -schema: 2.0.0 ---- - -# Remove-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -Remove-CsOnlineNumberPortInOrder [-Tenant <Guid>] -PortInOrderId <String> [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -PortInOrderId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsOnlineTelephoneNumber.md b/skype/skype-ps/skype/Remove-CsOnlineTelephoneNumber.md deleted file mode 100644 index b57179ae8f..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineTelephoneNumber.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsOnlineTelephoneNumber -schema: 2.0.0 ---- - -# Remove-CsOnlineTelephoneNumber - -## SYNOPSIS -Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove a telephone number from the Business Voice Directory. - -## SYNTAX - -``` -Remove-CsOnlineTelephoneNumber -TelephoneNumber <String[]> [-Tenant <Guid>] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsOnlineTelephoneNumber -TelephoneNumber +14258884567 -``` - -This example removes the specified telephone number from the Business Voice Directory. - - -## PARAMETERS - -### -TelephoneNumber -Specifies the target telephone number. -For example: -TelephoneNumber tel:+18005551234, or -TelephoneNumber +14251234567 - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md b/skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md deleted file mode 100644 index 5f0fc71dd1..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Remove-CsOnlineVoiceRoute - -## SYNOPSIS -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). - -## SYNTAX -``` -Remove-CsOnlineVoiceRoute [-Tenant <Guid>] [[-Identity] <XdsGlobalRelativeIdentity>] [-Force] [-WhatIf] [-Confirm] -``` - -## DESCRIPTION -Use this cmdlet to remove an existing online voice route. Online voice routes are associated with online voice policies through online PSTN usages, so removing a online voice route does not change any values relating to an online voice policy, it simply changes the routing for the numbers that had matched the pattern for the deleted online voice route. - -This cmdlet is used when configuring Microsoft Phone System Direct Routing. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Remove-CsOnlineVoiceRoute -Identity Route1 -``` - -Removes the settings for the online voice route with the identity Route1. - -### -------------------------- 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 -------------------------- -``` -PS C:\ Get-CsOnlineVoiceRoute -Filter *Redmond* | Remove-CsOnlineVoiceRoute -``` - -This command removes all online voice routes with an identity that includes the string "Redmond". First the `Get-CsOnlineVoiceRoute` cmdlet is called with the Filter parameter. The value of the Filter parameter is the string Redmond surrounded by wildcard characters (\*), which specifies that the string can be anywhere within the Identity. After all of the online voice routes with identities that include the string Redmond are retrieved, these online voice routes are piped to the `Remove-CsOnlineVoiceRoute` cmdlet, which removes each one. - -## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 -``` - -### -Identity -The unique identity of the online voice route. (If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) - -[New-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps) - -[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md b/skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md deleted file mode 100644 index 222ab9da65..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Remove-CsOnlineVoiceRoutingPolicy - -## SYNOPSIS -Deletes an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. - -## SYNTAX - -### Identity -``` -Remove-CsOnlineVoiceRoutingPolicy [[-Identity] <XdsIdentity>] [-Tenant <Guid>] [-Force] [-WhatIf] -[-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Skype for Business Online users an online voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks. - -Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Skype for Business Online or Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Remove-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -``` - -The command shown in Example 1 deletes the online voice routing policy RedmondOnlineVoiceRoutingPolicy. - -### -------------------------- 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 -------------------------- -``` -PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} | Remove-CsOnlineVoiceRoutingPolicy -``` - -In Example 3, all the online voice routing polices that include the online PSTN usage "Long Distance" are removed. To carry out this task, the `Get-CsOnlineVoiceRoutingPolicy` cmdlet is first called without any parameters in order to return a collection of all the available online voice routing policies. That 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". Policies that meet that criterion are then piped to the `Remove-CsOnlineVoiceRoutingPolicy`, which removes each online voice routing policy that includes the online PSTN usage "Long Distance". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) - -[Get-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) - -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) - -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Remove-CsOrganizationalAutoAttendant.md deleted file mode 100644 index 481aa4b676..0000000000 --- a/skype/skype-ps/skype/Remove-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Remove-CsOrganizationalAutoAttendant -schema: 2.0.0 ---- - -# Remove-CsOrganizationalAutoAttendant - -## SYNOPSIS -Use the Remove-CsOrganizationalAutoAttendant cmdlet to delete an Auto Attendant (AA). - -## SYNTAX - -``` -Remove-CsOrganizationalAutoAttendant [-PrimaryUri] <Uri> [-ApplicationId <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-CsOrganizationalAutoAttendant cmdlet deletes an OAA that is specified by using the PrimaryUri parameter. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsOrganizationalAutoAttendant -PrimaryUri "sip:mainoaa@contoso.com" -``` - -This example deletes the OAA that has a Primary URI of sip:mainoaa@contoso.com. - - -## PARAMETERS - -### -PrimaryUri -The PrimaryUri parameter represents the SIP address for the OAA to be removed. - - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies a custom application ID to use for OAAs. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String -The Remove-CsOrganizationalAutoAttendant cmdlet accepts a string as the PrimaryUri parameter. - - -## OUTPUTS - -### None - - -## NOTES - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendant](New-CsOrganizationalAutoAttendant.md) - -[Get-CsOrganizationalAutoAttendant](Get-CsOrganizationalAutoAttendant.md) - -[Set-CsOrganizationalAutoAttendant](Set-CsOrganizationalAutoAttendant.md) diff --git a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md index 5acbe15649..340683cf93 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsOutboundCallingNumberTranslationRule @@ -135,7 +140,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,4 +162,3 @@ Instead, the `Remove-CsOutboundCallingNumberTranslationRule` cmdlet deletes exis [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md b/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md index 7f5fba3614..4ead086ae1 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsOutboundTranslationRule @@ -119,7 +124,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -142,4 +147,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Tr [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsPartnerApplication.md b/skype/skype-ps/skype/Remove-CsPartnerApplication.md index 53ec430a51..1095f08f13 100644 --- a/skype/skype-ps/skype/Remove-CsPartnerApplication.md +++ b/skype/skype-ps/skype/Remove-CsPartnerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPartnerApplication @@ -159,7 +164,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -181,4 +186,3 @@ Instead, the `Remove-CsPartnerApplication` cmdlet deletes existing instances of [New-CsPartnerApplication](New-CsPartnerApplication.md) [Set-CsPartnerApplication](Set-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md b/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md index 8a72610568..40d9000d06 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatAddin @@ -73,7 +78,7 @@ For example: Type: String 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 Required: True Position: 1 @@ -89,7 +94,7 @@ Allows you to pass a reference to an object to the cmdlet. Type: Addin Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 1 @@ -105,7 +110,7 @@ Prompts you for confirmation before executing the command. 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 @@ -121,7 +126,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -137,7 +142,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ Instead, the `Remove-CsPersistentChatAddin` cmdlet deletes existing instances of [New-CsPersistentChatAddin](New-CsPersistentChatAddin.md) [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md b/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md index be44192a0b..658c5fe6a8 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatCategory @@ -78,7 +83,7 @@ An Identity consists of the PoolFqdn plus the category Name; for example: Type: String 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 Required: True Position: 1 @@ -94,7 +99,7 @@ Allows you to pass a reference to an object to the cmdlet. Type: Category Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 1 @@ -110,7 +115,7 @@ Prompts you for confirmation before executing the command. 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 @@ -126,7 +131,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -136,7 +141,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -159,4 +164,3 @@ Instead, the `Remove-CsPersistentChatCategory` cmdlet deletes existing instances [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md index 4f7e38da79..cfca03a5d7 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatComplianceConfiguration @@ -87,7 +92,7 @@ Instead, all the properties within that collection will be reset to their defaul Type: XdsIdentity 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 Required: True Position: 2 @@ -103,7 +108,7 @@ Prompts you for confirmation before executing the command. 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 @@ -119,7 +124,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -135,7 +140,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -167,4 +172,3 @@ Instead, the `Remove-CsPersistentChatComplianceConfiguration` cmdlet deletes exi [New-CsPersistentChatComplianceConfiguration](New-CsPersistentChatComplianceConfiguration.md) [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md index 8d9e16aad3..9ad34a8583 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatConfiguration @@ -87,7 +92,7 @@ Instead, all the properties within that collection will be reset to their defaul Type: XdsIdentity 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 Required: True Position: 2 @@ -103,7 +108,7 @@ Prompts you for confirmation before executing the command. 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 @@ -119,7 +124,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -135,7 +140,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -145,7 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -167,4 +172,3 @@ Instead, the `Remove-CsPersistentChatConfiguration` cmdlet deletes existing inst [New-CsPersistentChatConfiguration](New-CsPersistentChatConfiguration.md) [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md index a2cb5fc5b8..7443eaddef 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatEndpoint @@ -79,7 +84,7 @@ However, you can also use the full Identity of the endpoint; for example: Type: UserIdParameter 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 Required: True Position: 1 @@ -95,7 +100,7 @@ Prompts you for confirmation before executing the command. 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 @@ -111,7 +116,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -127,7 +132,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -137,7 +142,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,4 +162,3 @@ The `Remove-CsPersistentChatEndpoint` cmdlet does not return objects or data. [Get-CsPersistentChatEndpoint](Get-CsPersistentChatEndpoint.md) [New-CsPersistentChatEndpoint](New-CsPersistentChatEndpoint.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md b/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md index 55946e0c54..dd1b9a62b1 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatMessage @@ -72,7 +77,7 @@ For example: 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 Required: True Position: Named @@ -90,7 +95,7 @@ You cannot use both the Remove parameter and the ReplaceMessage parameter in the Type: SwitchParameter Parameter Sets: Remove Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -107,7 +112,7 @@ By default, the replacement message reads "This message was replaced by the Pers Type: String Parameter Sets: Replace Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -124,7 +129,7 @@ When present, indicates that case sensitivity should be used when searching for 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 Required: False Position: Named @@ -140,7 +145,7 @@ Prompts you for confirmation before executing the command. 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 @@ -156,7 +161,7 @@ Enables you to filter for messages that were posted on or before the specified d Type: DateTime 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 Required: False Position: Named @@ -183,7 +188,7 @@ To look for messages using any one of the provided keywords, use the MatchClause 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 Required: False Position: Named @@ -209,7 +214,7 @@ For example, this syntax searches for messages that have the exact phrase "For i Type: AndOr 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 Required: False Position: Named @@ -225,7 +230,7 @@ Enables you to filter for messages that were posted on or after the specified da Type: DateTime 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 Required: False Position: Named @@ -241,7 +246,7 @@ SIP address of the user who posted the message (or messages) that should be remo 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 Required: False Position: Named @@ -257,7 +262,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -267,7 +272,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -285,4 +290,3 @@ None. ## RELATED LINKS [Clear-CsPersistentChatRoom](Clear-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md index 3dc184999c..75517edccd 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatPolicy @@ -86,7 +91,7 @@ Instead, all the properties in the global policy will be reset to their default Type: XdsIdentity 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 Required: True Position: 2 @@ -102,7 +107,7 @@ Prompts you for confirmation before executing the command. 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 @@ -120,7 +125,7 @@ If not present, you will be asked to confirm the deletion request before a polic 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 Required: False Position: Named @@ -136,7 +141,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -159,7 +164,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Skype for Business Server 2015 Required: False Position: Named @@ -169,7 +174,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -193,4 +198,3 @@ Instead, the `Remove-CsPersistentChatPolicy` cmdlet deletes existing instances o [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md b/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md index a4cbbd9624..d789e263f1 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPersistentChatRoom @@ -81,7 +86,7 @@ The Identity for a chat room consists of the Persistent Chat pool where the room Type: String 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 Required: True Position: 1 @@ -97,7 +102,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: ChatRoom Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 1 @@ -113,7 +118,7 @@ Prompts you for confirmation before executing the command. 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 @@ -129,7 +134,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -145,7 +150,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -155,7 +160,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -179,4 +184,3 @@ Instead, the `Remove-CsPersistentChatRoom` cmdlet deletes existing instances of [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Remove-CsPinPolicy.md b/skype/skype-ps/skype/Remove-CsPinPolicy.md index 06d72f8399..b50a7851b2 100644 --- a/skype/skype-ps/skype/Remove-CsPinPolicy.md +++ b/skype/skype-ps/skype/Remove-CsPinPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPinPolicy @@ -185,7 +190,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -210,4 +215,3 @@ Instead, the cmdlet removes one or more instances of the Microsoft.Rtc.Managemen [New-CsPinPolicy](New-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md index cf626b693b..a4f1d6ea41 100644 --- a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPlatformServiceSettings schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPlatformServiceSettings @@ -99,7 +104,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -113,8 +118,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsPresencePolicy.md b/skype/skype-ps/skype/Remove-CsPresencePolicy.md index 18daf1eae3..7257c10c6d 100644 --- a/skype/skype-ps/skype/Remove-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Remove-CsPresencePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPresencePolicy @@ -174,7 +179,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -199,4 +204,3 @@ Instead, the `Remove-CsPresencePolicy` cmdlet deletes instances of the Microsoft [New-CsPresencePolicy](New-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsPresenceProvider.md b/skype/skype-ps/skype/Remove-CsPresenceProvider.md index ef4e739e4f..66ad10e6b7 100644 --- a/skype/skype-ps/skype/Remove-CsPresenceProvider.md +++ b/skype/skype-ps/skype/Remove-CsPresenceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPresenceProvider @@ -135,7 +140,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -159,4 +164,3 @@ Instead, the `Remove-CsPresenceProvider` cmdlet deletes instances of the Microso [New-CsPresenceProvider](New-CsPresenceProvider.md) [Set-CsPresenceProvider](Set-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md index 2ff56a1616..f0a1d07838 100644 --- a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPrivacyConfiguration @@ -175,7 +180,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -198,4 +203,3 @@ Instead, the `Remove-CsPrivacyConfiguration` cmdlet deletes existing instances o [New-CsPrivacyConfiguration](New-CsPrivacyConfiguration.md) [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md b/skype/skype-ps/skype/Remove-CsProxyConfiguration.md index 10b27a754c..fdf06b7833 100644 --- a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsProxyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsProxyConfiguration @@ -140,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -163,4 +168,3 @@ Instead, the `Remove-CsProxyConfiguration` cmdlet deletes existing instances of [New-CsProxyConfiguration](New-CsProxyConfiguration.md) [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsPublicProvider.md b/skype/skype-ps/skype/Remove-CsPublicProvider.md index 7ad3ce9fa0..85a18e6544 100644 --- a/skype/skype-ps/skype/Remove-CsPublicProvider.md +++ b/skype/skype-ps/skype/Remove-CsPublicProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPublicProvider @@ -138,7 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsPublicProvider](New-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md index ad12887d12..75b54cd946 100644 --- a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPushNotificationConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsPushNotificationConfiguration @@ -175,7 +180,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -192,8 +197,8 @@ Instead, the `Remove-CsPushNotificationConfiguration` cmdlet deletes instances o ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md b/skype/skype-ps/skype/Remove-CsQoEConfiguration.md index 6955334008..02136f6354 100644 --- a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsQoEConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsQoEConfiguration @@ -126,7 +131,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +154,3 @@ Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Set [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md b/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md index 1c5a7347b5..698ba81e59 100644 --- a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRegistrarConfiguration @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ Instead, the `Remove-CsRegistrarConfiguration` cmdlet deletes existing instances [New-CsRegistrarConfiguration](New-CsRegistrarConfiguration.md) [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md b/skype/skype-ps/skype/Remove-CsReportingConfiguration.md index 6d6efbda5e..f39a678c24 100644 --- a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsReportingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsReportingConfiguration @@ -50,9 +55,12 @@ This collection is then piped to the `Remove-CsReportingConfiguration` cmdlet, w Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -eq "https://atl-sql-002.litwareinc.com/lync_reports" | Remove-CsReportingConfiguration ``` -The command shown in Example 3 deletes any reporting configuration settings where the reporting URL is set to https://atl-sql-002.litwareinc.com/lync_reports. +The command shown in Example 3 deletes any reporting configuration settings where the reporting URL is set to `https://atl-sql-002.litwareinc.com/lync_reports`. + To carry out this task, the command first uses the `Get-CsReportingConfiguration` cmdlet to return all the reporting configuration settings currently in use. -This collection is then piped to the `Where-Object` cmdlet, which selects only those settings where the ReportingURL property is equal to https://atl-sql-002.litwareinc.com/lync_reports. + +This collection is then piped to the `Where-Object` cmdlet, which selects only those settings where the ReportingURL property is equal to `https://atl-sql-002.litwareinc.com/lync_reports`. + That filtered collection is then piped to the `Remove-CsReportingConfiguration` cmdlet, which removes each item in the collection. @@ -126,7 +134,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +156,3 @@ Instead, the `Remove-CsReportingConfiguration` cmdlet deletes existing instances [New-CsReportingConfiguration](New-CsReportingConfiguration.md) [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md b/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md index 3ab80ca1aa..7062f37fd4 100644 --- a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRgsAgentGroup @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. [New-CsRgsAgentGroup](New-CsRgsAgentGroup.md) [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md b/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md index df0366dee6..65b20debef 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRgsHolidaySet @@ -167,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +194,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md index c2bffa2feb..d9620b6ae4 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRgsHoursOfBusiness @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -186,4 +191,3 @@ Deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings. [New-CsRgsHoursOfBusiness](New-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsQueue.md b/skype/skype-ps/skype/Remove-CsRgsQueue.md index 2b8f3063de..a930605625 100644 --- a/skype/skype-ps/skype/Remove-CsRgsQueue.md +++ b/skype/skype-ps/skype/Remove-CsRgsQueue.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRgsQueue @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -172,4 +177,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. [New-CsRgsQueue](New-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md b/skype/skype-ps/skype/Remove-CsRgsWorkflow.md index 4b640131b3..e12c40c092 100644 --- a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/Remove-CsRgsWorkflow.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRgsWorkflow @@ -162,7 +167,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -184,4 +189,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. [New-CsRgsWorkflow](New-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md b/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md index 28a8b547d7..ad76c4dab3 100644 --- a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsRoutingConfiguration @@ -106,7 +111,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.Policy.V [Remove-CsVoiceRoute](Remove-CsVoiceRoute.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Remove-CsServerApplication.md b/skype/skype-ps/skype/Remove-CsServerApplication.md index 4fb022b64c..a83b20565e 100644 --- a/skype/skype-ps/skype/Remove-CsServerApplication.md +++ b/skype/skype-ps/skype/Remove-CsServerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsServerApplication @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -150,4 +155,3 @@ The `Remove-CsServerApplication` cmdlet deletes existing instances of the Micros [New-CsServerApplication](New-CsServerApplication.md) [Set-CsServerApplication](Set-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md index 55e558ef43..4d7b1655df 100644 --- a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsSimpleUrlConfiguration @@ -23,12 +28,12 @@ Remove-CsSimpleUrlConfiguration [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-C ## DESCRIPTION In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -198,4 +203,3 @@ None. [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsSipDomain.md b/skype/skype-ps/skype/Remove-CsSipDomain.md index 78793db72a..d59dc449bb 100644 --- a/skype/skype-ps/skype/Remove-CsSipDomain.md +++ b/skype/skype-ps/skype/Remove-CsSipDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsSipDomain @@ -129,7 +134,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -152,4 +157,3 @@ Instead, the `Remove-CsSipDomain` cmdlet deletes existing instance of the Micros [New-CsSipDomain](New-CsSipDomain.md) [Set-CsSipDomain](Set-CsSipDomain.md) - diff --git a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md index 4b7056ce3b..6dcccff10c 100644 --- a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsSipResponseCodeTranslationRule @@ -142,7 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ Instead, the cmdlet deletes modifies instances of the Microsoft.Rtc.Management.W [New-CsSipResponseCodeTranslationRule](New-CsSipResponseCodeTranslationRule.md) [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md b/skype/skype-ps/skype/Remove-CsSlaConfiguration.md index 4af84709cb..9cf8fa98a8 100644 --- a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsSlaConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSlaConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsSlaConfiguration @@ -104,7 +109,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -113,6 +118,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) -[Set-CsSlaConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/set-csslaconfiguration?view=skype-ps) +[Set-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsSlaDelegates.md b/skype/skype-ps/skype/Remove-CsSlaDelegates.md index 8212800e6a..66462078dc 100644 --- a/skype/skype-ps/skype/Remove-CsSlaDelegates.md +++ b/skype/skype-ps/skype/Remove-CsSlaDelegates.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssladelegates +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSlaDelegates schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsSlaDelegates @@ -58,16 +63,12 @@ Accept wildcard characters: False ### -Identity 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 -- User principal name (UPN) - - Example: kenmyer@litwareinc.com -- Domain name and logon name in the form domain\logon - - Example: litwareinc\kenmyer -- Active Directory display name (this form typically requires quotes) - - Example: "Ken Myer" -- Active Directory distinguished name - - Example: CN=KenMyer,CN=Users,DC=Atlanta,DC=Corp,DC=litware,DC=com + +- SIP address. Example: sip:kenmyer@litwareinc.com. +- User principal name (UPN). Example: kenmyer@litwareinc.com. +- Domain name and logon name in the form domain\logon. Example: litwareinc\kenmyer. +- Active Directory display name (this form typically requires quotes). Example: "Ken Myer". +- Active Directory distinguished name. Example: CN=KenMyer,CN=Users,DC=Atlanta,DC=Corp,DC=litware,DC=com. ```yaml Type: UserIdParameter @@ -131,7 +132,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +141,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Add-CsSlaDelegates](https://docs.microsoft.com/en-us/powershell/module/skype/add-cssladelegates?view=skype-ps) +[Add-CsSlaDelegates](https://learn.microsoft.com/powershell/module/skype/add-cssladelegates?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md index 90e032f1f9..7c0a317d02 100644 --- a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsStaticRoutingConfiguration @@ -148,7 +153,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,4 +176,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md index 897a3a65f9..47b61a9369 100644 --- a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsStorageServiceConfiguration @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -154,4 +159,3 @@ The `Remove-CsStorageServiceConfiguration` cmdlet does not return any objects or [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsTeamsInteropPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsInteropPolicy.md deleted file mode 100644 index 632c3b3588..0000000000 --- a/skype/skype-ps/skype/Remove-CsTeamsInteropPolicy.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsStorageServiceConfiguration -schema: 2.0.0 ---- - -# Remove-CsTeamsInteropPolicy - -## SYNOPSIS - -IMPORTANT: TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. See description for details. You can also find more guidance here: https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype - -This cmdlet previously determined how calls are routed between Skype for Business and Microsoft Teams. It is no longer honored, except if TeamsUpgradePolicy mode=Legacy. However, Legacy mode has been deprecated and customers should update their configurations to use a mode other than Legacy. - -## SYNTAX - -``` -Remove-CsTeamsInteropPolicy [-WhatIf] [-Confirm] [[-Identity] <Object>] [-Tenant <Object>] [-Force] [-AsJob] -``` - -## DESCRIPTION - -IMPORTANT: TeamsInteropPolicy has been replaced by TeamsUpgradePolicy. It is no longer honored by the system, except if TeamsUpgradePolicy has mode=Lgeacy. Legacy mode is being deprecated. Customers that are still using Legacy mode should update their configurations to use a mode other than Legacy. Granting mode=Legacy is now blocked by default, although admins can override this using -Force for the time being. Eventually, the -Force switch will be removed and granting mode=Legacy will not be possible. - - -Any customers still using Legacy mode must ensure the following: - - The global policy must have CallingDefaultClient=ChatDefaultClient, and AllowEndUserClientOverride must be false. If you customized the built-in global policy, undo this by running Remove-CsTeamsInteropPolicy. This will remove the tenant-specific global policy and revert back to the system-wide built-in policy (which cannot be removed). Use the following syntax: - - `Remove-CsTeamsInteropPolicy -Identity Global` - - If TeamsInteropPolicy is explicitly assigned to any users, one of these three built-in instances for which CallingDefaultClient = ChatDefaultClient, and for which AllowEndUserClientOverride = false. The other instances are no longer valid configurations, are not supported, and will soon be removed from the system. The valid instances are: - - -**Identity: DisallowOverrideCallingDefaultChatDefault** - - AllowEndUserClientOverride: False - - CallingDefaultClient: Default - - ChatDefaultClient: Default - -**Identity: DisallowOverrideCallingSfbChatSfb** - - AllowEndUserClientOverride: False - - CallingDefaultClient: Sfb - - ChatDefaultClient: Sfb - -**Identity: DisallowOverrideCallingTeamsChatTeams** - - AllowEndUserClientOverride: False - - CallingDefaultClient: Teams - - ChatDefaultClient: Teams - - -Use the following cmdlet syntax, where $policy is one of the above values of identity: -`Grant-CsTeamsInteropPolicy -PolicyName $policy -Identity $SipAddress` - - -For comprehensive documentation on this policy and its settings, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/microsoftteams/migration-interop-guidance-for-teams-with-skype). - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -{{Fill Identity Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -{{Fill Tenant Description}} - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -This policy has been deprecated. Customters should use TeamsUpgradePolicy to control interop and routing. - -## RELATED LINKS - -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/microsoftteams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingPolicy.md deleted file mode 100644 index 9b6f541d89..0000000000 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingPolicy.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsTeamsMeetingPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsMeetingPolicy - -## SYNOPSIS -Remove-CsTeamsMeetingPolicy \[-Identity\] \<XdsIdentity\> \[-Tenant \<guid\>\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] - -## SYNTAX - -``` -Remove-CsTeamsMeetingPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Deletes a previously created TeamsMeetingPolicy. 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-CsTeamsMeetingPolicy -Identity StudentMeetingPolicy -``` - -In the example shown above, the command will delete the student meeting 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 - -```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 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 StudentMeetingPolicy . - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md index d66203fdf9..f8d9052ec0 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md @@ -1,16 +1,21 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness -online version: -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamsupgradepolicy +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTeamsUpgradePolicy schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTeamsUpgradePolicy ## SYNOPSIS -In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables adminstrators to control whether users see a notification in their Skype for Business client of a pending upgrade to Teams. In addition, when this policy is assigned to a user, administrators can optionally have Win32 versions of Skype for Business clients silently download the Teams app based on the value of TeamsUpgradeConfiguration. + +In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables administrators to control whether users see a notification in their Skype for Business client of a pending upgrade to Teams. In addition, when this policy is assigned to a user, administrators can optionally have Win32 versions of Skype for Business clients silently download the Teams app based on the value of TeamsUpgradeConfiguration. ## SYNTAX @@ -19,13 +24,15 @@ Remove-CsTeamsUpgradePolicy [-Identity] <XdsIdentity> ``` ## DESCRIPTION -In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables adminstrators to control whether users see a notification of a pending upgrade to Teams in their Skype for Business client. The Remove-CsTeamsUpgradePolicy lets the adminstrator remove instances of TeamsUpgradePolicy that were previously created by the administrator. + +In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables administrators to control whether users see a notification of a pending upgrade to Teams in their Skype for Business client. The Remove-CsTeamsUpgradePolicy lets the administrator remove instances of TeamsUpgradePolicy that were previously created by the administrator. Instances of TeamsUpgradePolicy created on-premises will not apply to any users that are already homed online. This cmdlet cannot be used to remove the built-in instances of TeamsUpgradePolicy provided in Office 365. There is no Remove-CsTeamsUpgradePolicy cmdlet for the online environment by design. ## EXAMPLES ### Example 1 + ```powershell PS C:\> Remove-CsTeamsUpgradePolicy -Identity Site:Redmond1 ``` @@ -34,11 +41,9 @@ This removes the TeamsUpgradePolicy for site named Redmond1. ## PARAMETERS - - - ### -Identity -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 specfy a policy that can be assigned as needed to any users, simply specify a name of your choosing. + +The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\<name>" where "\<name>" 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 @@ -52,12 +57,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` - ## INPUTS ### Microsoft.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object @@ -66,18 +69,18 @@ Accept wildcard characters: False ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) -[Grant-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md) +[Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Get-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md) +[Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) -[New-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md) +[New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) -[Remove-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md) +[Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) -[Set-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md) +[Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) -[Get-CsTeamsUpgradeConfiguration](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md) +[Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) -[Set-CsTeamsUpgradeConfiguration](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md) +[Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) diff --git a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md b/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md index f4a173eb36..ce9b3db03d 100644 --- a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTelemetryConfiguration @@ -18,7 +23,7 @@ Remove-CsTelemetryConfiguration [-Identity] <XdsIdentity> [-Confirm] [-Force] [- ``` ## DESCRIPTION -For privacy information, see the Skype for Business Privacy Statement (http://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). +For privacy information, see the Skype for Business Privacy Statement (https://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). ## EXAMPLES @@ -121,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -136,4 +141,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTenantDialPlan.md b/skype/skype-ps/skype/Remove-CsTenantDialPlan.md deleted file mode 100644 index 4d36381efc..0000000000 --- a/skype/skype-ps/skype/Remove-CsTenantDialPlan.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Remove-CsTenantDialPlan -schema: 2.0.0 ---- - -# Remove-CsTenantDialPlan - -## SYNOPSIS -Use the `Remove-CsTenantDialPlan` cmdlet to remove a tenant dial plan. - -## SYNTAX - -``` -Remove-CsTenantDialPlan [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The `Remove-CsTenantDialPlan` cmdlet removes an existing tenant dial plan (also known as a location profile). -Tenant dial plans provide required information to allow Enterprise Voice users to make telephone calls. -The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. - -Removing a tenant dial plan also removes any associated normalization rules. -If no tenant dial plan is assigned to an organization, the Global dial plan is used. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 -``` - -This example removes the Vt1TenantDialPlan2. - - -## PARAMETERS - -### -Identity -The Identity parameter is the unique identifier of the tenant dial plan to remove. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm parameter prompts you for confirmation before the command is executed. - -```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 -``` - -### -Force -The Force parameter suppresses any confirmation prompts that are otherwise displayed before the changes are made. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md index cb6b4a54d5..0927a0240a 100644 --- a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Remove-CsTenantUpdateTimeWindow @@ -122,7 +127,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,4 +136,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTestDevice.md b/skype/skype-ps/skype/Remove-CsTestDevice.md index a0706f0d83..0cf245979f 100644 --- a/skype/skype-ps/skype/Remove-CsTestDevice.md +++ b/skype/skype-ps/skype/Remove-CsTestDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTestDevice @@ -159,7 +164,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -182,4 +187,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsTestDevice](New-CsTestDevice.md) [Set-CsTestDevice](Set-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/Remove-CsTestUserCredential.md b/skype/skype-ps/skype/Remove-CsTestUserCredential.md index 3a198fd8ba..2d8afa8192 100644 --- a/skype/skype-ps/skype/Remove-CsTestUserCredential.md +++ b/skype/skype-ps/skype/Remove-CsTestUserCredential.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTestUserCredential @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,4 +160,3 @@ Instead, the `Remove-CsTestUserCredential` cmdlet deletes existing instances of [Get-CsTestUserCredential](Get-CsTestUserCredential.md) [Set-CsTestUserCredential](Set-CsTestUserCredential.md) - diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md index 83c3b33a85..a55a5ee89b 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsThirdPartyVideoSystem @@ -108,7 +113,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ The `Remove-CsThirdPartyVideoSystem` cmdlet does not return any objects or data. [New-CsThirdPartyVideoSystem](New-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md index 277fbbd304..e2e7dcdc56 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsThirdPartyVideoSystemPolicy @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -200,4 +205,3 @@ Instead, the `Remove-CsThirdPartyVideoSystemPolicy` cmdlet deletes instances of [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md b/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md index eb44136771..4c863ae2fc 100644 --- a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTrunkConfiguration @@ -114,7 +119,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -139,4 +144,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Tr [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplication.md b/skype/skype-ps/skype/Remove-CsTrustedApplication.md index 777acf6978..f740667361 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplication.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTrustedApplication @@ -122,7 +127,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -145,4 +150,3 @@ It removes an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplicat [Set-CsTrustedApplication](Set-CsTrustedApplication.md) [Get-CsTrustedApplication](Get-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md b/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md index 47c6a9354c..b98867daaa 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTrustedApplicationComputer @@ -119,7 +124,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -144,4 +149,3 @@ It removes an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. [Remove-CsTrustedApplicationPool](Remove-CsTrustedApplicationPool.md) [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md index 195ff187d6..e90e6d3555 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTrustedApplicationEndpoint @@ -97,7 +102,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -120,4 +125,3 @@ It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADAppl [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md b/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md index fb76fe8070..1d488c17fc 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsTrustedApplicationPool @@ -121,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -144,4 +149,3 @@ It removes an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. [Set-CsTrustedApplicationPool](Set-CsTrustedApplicationPool.md) [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) - diff --git a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md index 807c50581f..f45cd01e67 100644 --- a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsUCPhoneConfiguration @@ -160,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -183,4 +188,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [New-CsUCPhoneConfiguration](New-CsUCPhoneConfiguration.md) [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md b/skype/skype-ps/skype/Remove-CsUnassignedNumber.md index 18a102db37..76c0291f9f 100644 --- a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/Remove-CsUnassignedNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsUnassignedNumber @@ -113,7 +118,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +145,3 @@ It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnou [Get-CsAnnouncement](Get-CsAnnouncement.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Remove-CsUserAcp.md b/skype/skype-ps/skype/Remove-CsUserAcp.md index 8c70aec9ea..dc022a2e7e 100644 --- a/skype/skype-ps/skype/Remove-CsUserAcp.md +++ b/skype/skype-ps/skype/Remove-CsUserAcp.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuseracp +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsUserAcp schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Remove-CsUserAcp @@ -16,10 +21,12 @@ This cmdlet was introduced in Lync Server 2010. ``` Remove-CsUserAcp [-Identity] <UserIdParameter> [-Name <String>] [-TollNumber <String>] [-PassThru] [-WhatIf] - [-Confirm] [-ParticipantPasscode <String>] [-AsJob] [<CommonParameters>] + [-Confirm] [-ParticipantPasscode <String>] [<CommonParameters>] ``` ## DESCRIPTION +Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://learn.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. + An audio conferencing provider is a third-party company that provides organizations with conferencing services. Among other things, audio conferencing providers provide a way for users located off site and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or meeting. Audio conferencing providers often provide high-end services such as live translation, transcription, and live per-conference operator assistance. @@ -216,24 +223,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -254,4 +245,3 @@ None. [Get-CsUserAcp](Get-CsUserAcp.md) [Set-CsUserAcp](Set-CsUserAcp.md) - diff --git a/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md index 3c52cf511e..1c2fa5fc3f 100644 --- a/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsUserReplicatorConfiguration @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,4 +162,3 @@ Instead, the `Remove-CsUserReplicatorConfiguration` cmdlet deletes instances of [New-CsUserReplicatorConfiguration](New-CsUserReplicatorConfiguration.md) [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md b/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md index 817a950e48..373e6cace5 100644 --- a/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsUserServicesConfiguration @@ -142,7 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ Instead, the `Remove-CsUserServicesConfiguration` cmdlet deletes existing instan [New-CsUserServicesConfiguration](New-CsUserServicesConfiguration.md) [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md b/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md index 44c4558d8d..b5402b89cb 100644 --- a/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsUserServicesPolicy @@ -170,7 +175,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -194,4 +199,3 @@ Instead, the `Remove-CsUserServicesPolicy` cmdlet deletes existing instances of [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md b/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md index fb77e9e0ce..a03b9546bf 100644 --- a/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md +++ b/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsUserStoreBackupData @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -130,4 +135,3 @@ None. ## RELATED LINKS [Get-CsBackupServiceStatus](Get-CsBackupServiceStatus.md) - diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md index 21364480e0..3aebb35e96 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVideoInteropServerConfiguration @@ -143,7 +148,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ The `Remove-CsVideoInteropServerConfiguration` cmdlet deletes instances of the M [New-CsVideoInteropServerConfiguration](New-CsVideoInteropServerConfiguration.md) [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md index 9c1312036b..c5fe430c83 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVideoInteropServerSyntheticTransactionConfiguration @@ -107,7 +112,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -130,4 +135,3 @@ None [New-CsVideoInteropServerSyntheticTransactionConfiguration](New-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServiceProvider.md b/skype/skype-ps/skype/Remove-CsVideoInteropServiceProvider.md deleted file mode 100644 index 0b120f70f8..0000000000 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServiceProvider.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online -title: Remove-CsVideoInteropServiceProvider -schema: 2.0.0 ---- - -# 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. - -## SYNTAX - -## 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. - -## EXAMPLES - -## PARAMETERS - -### -Identity -Specify the VideoInteropServiceProvider to be removed. - -```yaml -Type: XdsGlobalRelativeIdentity -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 - -### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md index 6a54e42aee..820a5f657f 100644 --- a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVideoTrunkConfiguration @@ -23,7 +28,7 @@ The VIS is a service that runs on a standalone pool and cannot be co-located on To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -135,7 +140,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,4 +162,3 @@ The `Remove-CsVideoTrunkConfiguration` cmdlet removes specified Microsoft.Rtc.Ma [New-CsVideoTrunkConfiguration](New-CsVideoTrunkConfiguration.md) [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md b/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md index f9a416f5f3..ce31f612a4 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVoiceConfiguration @@ -107,7 +112,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,4 +136,3 @@ This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.Writable [Remove-CsVoiceTestConfiguration](Remove-CsVoiceTestConfiguration.md) [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md index 8e7e89a48c..4513a469fb 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Remove-CsVoiceNormalizationRule @@ -12,12 +17,12 @@ Removes a voice normalization rule. Voice normalization rules are used to convert telephone dialing requirements (for example, dialing 9 to access an outside line) to the E.164 phone number format used by Skype for Business Server. This cmdlet was introduced in Lync Server 2010. +**Note**: This cmdlet has been deprecated in Teams PowerShell Module 4.0.0. ## SYNTAX ``` -Remove-CsVoiceNormalizationRule [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] +Remove-CsVoiceNormalizationRule [-Identity] <XdsIdentity> [-Tenant <guid>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION @@ -60,7 +65,7 @@ If the value passed to the Identity contains only the scope (site:Redmond), all 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 2 @@ -77,7 +82,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -94,7 +99,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,7 +116,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,13 +126,13 @@ Accept wildcard characters: False ``` ### -Tenant -{{Fill Tenant Description}} +For internal Microsoft usage. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -137,7 +142,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ This cmdlet deletes an object of type Microsoft.Rtc.Management.WritableConfig.Po [Remove-CsDialPlan](Remove-CsDialPlan.md) [Get-CsDialPlan](Get-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoicePolicy.md b/skype/skype-ps/skype/Remove-CsVoicePolicy.md index 15a89ed3a2..137f719863 100644 --- a/skype/skype-ps/skype/Remove-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Remove-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVoicePolicy @@ -56,7 +61,7 @@ A unique identifier specifying the scope and in some cases the name, of the poli 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 2 @@ -72,7 +77,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -88,7 +93,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -104,7 +109,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,16 +128,11 @@ 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: Guid 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -142,7 +142,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -169,4 +169,3 @@ It removes an instance of a Microsoft.Rtc.Management.WritableConfig.Policy.Voice [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) [Test-CsVoicePolicy](Test-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoiceRoute.md b/skype/skype-ps/skype/Remove-CsVoiceRoute.md index e7b2a540e5..97f01579c4 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Remove-CsVoiceRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVoiceRoute @@ -122,7 +127,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.R [Get-CsVoiceRoute](Get-CsVoiceRoute.md) [Test-CsVoiceRoute](Test-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md index 667e64f78a..2d439ee40e 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVoiceRoutingPolicy @@ -144,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +173,3 @@ Instead, the `Remove-CsVoiceRoutingPolicy` cmdlet deletes existing instances of [New-CsVoiceRoutingPolicy](New-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md index a90b0e7b35..0a7f3baca9 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVoiceTestConfiguration @@ -111,7 +116,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -135,4 +140,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.T [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) [Test-CsVoiceTestConfiguration](Test-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md index 34ee77cbeb..9a5d3a1dfd 100644 --- a/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsVoicemailReroutingConfiguration @@ -118,7 +123,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +145,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumR [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md index 5b17dcdbf9..e6ad98fce0 100644 --- a/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsWatcherNodeConfiguration @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -158,4 +163,3 @@ Instead, the `Remove-CsWatcherNodeConfiguration` cmdlet deletes existing instanc [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md index 6b626fe13b..11ae5b1038 100644 --- a/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsWebServiceConfiguration @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ Instead, the `Remove-CsWebServiceConfiguration` cmdlet deletes existing instance [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md index a76aacb54c..fabbb2d393 100644 --- a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Remove-CsXmppAllowedPartner @@ -76,7 +81,7 @@ For example: Type: XdsGlobalRelativeIdentity 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 Required: True Position: 2 @@ -92,7 +97,7 @@ Prompts you for confirmation before executing the command. 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 @@ -108,7 +113,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -124,7 +129,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,4 +161,3 @@ Instead, the `Remove-CsXmppAllowedPartner` cmdlet deletes existing instances of [New-CsXmppAllowedPartner](New-CsXmppAllowedPartner.md) [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Request-CsCertificate.md b/skype/skype-ps/skype/Request-CsCertificate.md index 92cbce5638..56a2d03fd8 100644 --- a/skype/skype-ps/skype/Request-CsCertificate.md +++ b/skype/skype-ps/skype/Request-CsCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Request-CsCertificate @@ -93,7 +98,7 @@ Example 3 uses the Output parameter to create an offline certificate request. ### -------------------------- Example 4 ----------------------- ``` -Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Standard Edition Certficate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-cs-001.litwareinc.com,atl-ext.litwareinc.com" +Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Standard Edition Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-cs-001.litwareinc.com,atl-ext.litwareinc.com" ``` Example 4 is a more detailed (and more realistic) example of how to use the `Request-CsCertificate` cmdlet. @@ -695,7 +700,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -720,4 +725,3 @@ Instead, the `Request-CsCertificate` cmdlet helps manage instances of the Micros [Remove-CsCertificate](Remove-CsCertificate.md) [Set-CsCertificate](Set-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md index 2696f1bb11..70da9753fa 100644 --- a/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Reset-CsDeviceUpdateRule @@ -163,7 +168,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -188,4 +193,3 @@ Instead, the `Reset-CsDeviceUpdateRule` cmdlet resets instances of the Microsoft [Remove-CsDeviceUpdateRule](Remove-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Reset-CsNotificationQueues.md b/skype/skype-ps/skype/Reset-CsNotificationQueues.md index b04545bbb6..dff712feba 100644 --- a/skype/skype-ps/skype/Reset-CsNotificationQueues.md +++ b/skype/skype-ps/skype/Reset-CsNotificationQueues.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Reset-CsNotificationQueues @@ -95,7 +100,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -108,4 +113,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md b/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md index 4c4b9c733f..db9733ae64 100644 --- a/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md +++ b/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Reset-CsPoolRegistrarState ## SYNOPSIS -Resets the Registrar and Windows fabric services for the specified Registrar pool. +Resets the Registrar and Windows Fabric services for the specified Registrar pool. This cmdlet was introduced in Lync Server 2013. @@ -60,7 +65,7 @@ Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType Quor In Example 3, a quorum loss recovery reset is carried on the pool `atl-cs-001.litwareinc.com`. A quorum loss recovery is reset is typically used when the number of active Front End servers in a pool falls below the quorum state (that is, when fewer than 85% of the Front End servers in a pool are currently active). Note that only those services that are in a quorum loss will have to reload user data from the backup store. -Other services will be unaffected by this command/ +Other services will be unaffected by this command. ### -------------------------- Example 4 -------------------------- @@ -77,7 +82,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 4 -------------------------- +### -------------------------- Example 5 -------------------------- ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType FullReset -NoReStart ``` @@ -197,14 +202,14 @@ Accept wildcard characters: False ### -ResetType Type of reset to be performed. Allowed values are: +<ul> +<li>ServiceReset. The RtcSrv and FabricHostSvc services are stopped and restarted. +A service reset will be performed if the ResetType is not specified.</li> -ServiceReset - The RtcSrv and FabricHostSvc services are stopped and restarted. -A service reset will be performed if the ResetType is not specified. - -QuorumLossRecovery - Reloads user data 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.) Data not yet written to the database could be lost when you do this type of reset. +<li>QuorumLossRecovery. Reloads user data 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.) Data not yet written to the database could be lost when you do this type of reset.</li> -FullReset - performs the same type of reset as QuorumLossRecovery but, in addition, rebuilds the local Skype for Business Server databases. +<li> FullReset. Performs the same type of reset as QuorumLossRecovery but, in addition, rebuilds the local Skype for Business Server databases. This type of reset can be potentially long and resource-intensive. Using the FullReset value can cause previously disabled nodes to be reenabled. @@ -213,11 +218,11 @@ For example, if you use the FullReset value while one of the Front End Servers i Using the FullReset value when attempting to restart a pool will sometimes result in failure and the pool will not actually restart. Because of that, it is recommended that you first try to restart the pool using one of the other ResetType options. If that fails, please consult Microsoft support personnel before using the FullReset option. -Typically FullReset is only used when changing a topology from a pool with a single Front End server to a pool with multiple Front End servers. - -MachineStateRemoved -- Removes the specified server from the pool. -This type of reset should be used only when the server in question (or its databases) have been permanently lost. +Typically FullReset is only used when changing a topology from a pool with a single Front End server to a pool with multiple Front End servers.</li> +<li>MachineStateRemoved. Removes the specified server from the pool. +This type of reset should be used only when the server in question (or its databases) have been permanently lost.</li> +</ul> ```yaml Type: PoolResetType @@ -265,7 +270,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -284,4 +289,3 @@ The `Reset-CsPoolRegistrarState` cmdlet does not return objects. ## RELATED LINKS [Get-CsPoolFabricState](Get-CsPoolFabricState.md) - diff --git a/skype/skype-ps/skype/Reset-CsRoutingGroup.md b/skype/skype-ps/skype/Reset-CsRoutingGroup.md index d584729a85..af1ce598f9 100644 --- a/skype/skype-ps/skype/Reset-CsRoutingGroup.md +++ b/skype/skype-ps/skype/Reset-CsRoutingGroup.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Reset-CsRoutingGroup ## SYNOPSIS -Enables administrators to reset a Windows fabric routing group that is not working correctly. +Enables administrators to reset a Windows Fabric routing group that is not working correctly. ## SYNTAX @@ -26,7 +31,7 @@ Missing routing groups can be identified by using the `Get-CsPoolFabricState` cm ### -------------------------- Example 1 -------------------------- ``` -Reset-CsRoutingGroup -RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c" -Type "Transient" +Reset-CsRoutingGroup -RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c" -ResetType "Transient" ``` The command shown in Example 1 performs a transient on the routing group with the identity bef5fa3b-3c97-4af0-abe7-611deee7616c. @@ -137,11 +142,11 @@ Accept wildcard characters: False Type of reset to be performed. Allowed values are: -Invalid +- Permanent. Takes everything back from Back End Servers and recreates the whole routing group. -Permanent +- Transient. Resets the Windows Fabric service and fixes any issues, then syncs up any missing data from the RTCLocal Database. -Transient +- Recreate. Deletes existing data from Windows Fabric service about the routing group and reloads them from the RTCLocal Database. ```yaml Type: RgResetType @@ -189,7 +194,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -206,4 +211,3 @@ The `Reset-CsRoutingGroup` cmdlet does return objects or data. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md index 2cdd3181d3..2bff596090 100644 --- a/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Restore-CsDeviceUpdateRule @@ -166,7 +171,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -191,4 +196,3 @@ Instead, the `Restore-CsDeviceUpdateRule` cmdlet restores instances of the Micro [Remove-CsDeviceUpdateRule](Remove-CsDeviceUpdateRule.md) [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Revoke-CsClientCertificate.md b/skype/skype-ps/skype/Revoke-CsClientCertificate.md index 2e89dc8906..5b2828745f 100644 --- a/skype/skype-ps/skype/Revoke-CsClientCertificate.md +++ b/skype/skype-ps/skype/Revoke-CsClientCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Revoke-CsClientCertificate @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -145,4 +150,3 @@ Instead, the `Revoke-CsClientCertificate` cmdlet revokes instances of the Micros ## RELATED LINKS [Get-CsClientCertificate](Get-CsClientCertificate.md) - diff --git a/skype/skype-ps/skype/Revoke-CsOUPermission.md b/skype/skype-ps/skype/Revoke-CsOUPermission.md index 552f7f370f..e78386a8cd 100644 --- a/skype/skype-ps/skype/Revoke-CsOUPermission.md +++ b/skype/skype-ps/skype/Revoke-CsOUPermission.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Revoke-CsOUPermission @@ -225,7 +230,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -245,4 +250,3 @@ The `Revoke-CsOUPermission` cmdlet does not return any objects or values. [Grant-CsOUPermission](Grant-CsOUPermission.md) [Test-CsOUPermission](Test-CsOUPermission.md) - diff --git a/skype/skype-ps/skype/Revoke-CsSetupPermission.md b/skype/skype-ps/skype/Revoke-CsSetupPermission.md index 4d77a781bb..2749dcce16 100644 --- a/skype/skype-ps/skype/Revoke-CsSetupPermission.md +++ b/skype/skype-ps/skype/Revoke-CsSetupPermission.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Revoke-CsSetupPermission @@ -198,7 +203,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -218,4 +223,3 @@ None. [Grant-CsSetupPermission](Grant-CsSetupPermission.md) [Test-CsSetupPermission](Test-CsSetupPermission.md) - diff --git a/skype/skype-ps/skype/Search-CsClsLogging.md b/skype/skype-ps/skype/Search-CsClsLogging.md index daefe16b1a..012dcf1d84 100644 --- a/skype/skype-ps/skype/Search-CsClsLogging.md +++ b/skype/skype-ps/skype/Search-CsClsLogging.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Search-CsClsLogging @@ -399,7 +404,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -425,4 +430,3 @@ String values or XML. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Search-CsOnlineTelephoneNumberInventory.md b/skype/skype-ps/skype/Search-CsOnlineTelephoneNumberInventory.md deleted file mode 100644 index 10f8ce1d01..0000000000 --- a/skype/skype-ps/skype/Search-CsOnlineTelephoneNumberInventory.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Search-CsOnlineTelephoneNumberInventory -schema: 2.0.0 ---- - -# Search-CsOnlineTelephoneNumberInventory - -## SYNOPSIS -Use the `Search-CsOnlineTelephoneNumberInventory` cmdlet to reserve a telephone numbers that are in inventory and available to be acquired. - -## SYNTAX - -``` -Search-CsOnlineTelephoneNumberInventory [-Tenant <Guid>] -RegionalGroup <String> - -CountryOrRegion <String> -Area <String> -CapitalOrMajorCity <String> -Quantity <Int32> - [-TelephoneNumber <String>] [-AreaCode <String>] -InventoryType <String> [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION -Acquiring tenant telephone numbers is a two step process. - -+12127539059 +1 (212) 753 9059 - -`Select-CsOnlineTelephoneNumberInventory -ReservationId 76ce711f-9da4-46d9-b81d-471172450443 -TelephoneNumbers 12127539058,12127539059 -Region NOAM -Country US -Area NY -City NY` - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Search-CsOnlineTelephoneNumberInventory -InventoryType Service -Region NOAM -Country US -Area NY -City NY -Quantity 10 -``` - -This example reserves 10 Service type telephone numbers in New York, New York. - - -## PARAMETERS - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -Specifies the target geographical city for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: City -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quantity -Specifies the quantity of telephone numbers to reserve. -The maximum value is 500. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AreaCode -Specifies the area code to search for telephone numbers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -Specifies either an individual telephone number to reserve, or multiple telephone numbers can be entered separated by a comma. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies your tenant identifier. -To find your tenant id use the command: `Get-CsTenant | fl objectid`. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -This cmdlets returns an Microsoft.Rtc.Management.Hosted.Bvd.Types.NumberReservationResponse object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md b/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md deleted file mode 100644 index 91fb9da11b..0000000000 --- a/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Select-CsOnlineTelephoneNumberInventory -schema: 2.0.0 ---- - -# Select-CsOnlineTelephoneNumberInventory - -## SYNOPSIS -Use the `Select-CsOnlineTelephoneNumberInventory` cmdlet to acquire a list of inventoried telephone numbers and associate them with a Business Voice Directory tenant. -The input must be from a telephone number search operation generated by the `Search-CsOnlineTelephoneNumberInventory` cmdlet. - -## SYNTAX - -``` -Select-CsOnlineTelephoneNumberInventory [-Tenant <Guid>] -RegionalGroup <String> - -CountryOrRegion <String> -Area <String> -CapitalOrMajorCity <String> -ReservationId <String> - -TelephoneNumbers <String[]> [-LocationId <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -## DESCRIPTION -Acquiring tenant telephone numbers is a two step process. - -+12127539059 +1 (212) 753 9059 - -`Select-CsOnlineTelephoneNumberInventory -ReservationId 76ce711f-9da4-46d9-b81d-471172450443 -TelephoneNumbers 12127539058,12127539059 -RegionalGroup NOAM -CountryOrRegion US -Area NY -CapitalOrMajorCity NY` - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Select-CsOnlineTelephoneNumberInventory -ReservationId 76ce711f-9da4-46d9-b81d-471172450443 -TelephoneNumbers 12127539058,12127539059 -RegionalGroup NOAM -CountryOrRegion US -Area NY -CapitalOrMajorCity NY -``` - -This example assigns two telephone numbers to New York City. - -## PARAMETERS - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -Specifies the target geographical city for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: City -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -Specifies the telephone number reservation to access. -The reservation itself is created by the `Search-CsOnlineTelephoneNumberInventory` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumbers -Specifies the telephone numbers you wish to assign, separated by commas. -The numbers must be in E.164 format. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -This cmdlets returns an Microsoft.Rtc.Management.Hosted.Bvd.Types.NumberReservationResponse object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CSOnlinePSTNGateway.md b/skype/skype-ps/skype/Set-CSOnlinePSTNGateway.md deleted file mode 100644 index 090c3aded0..0000000000 --- a/skype/skype-ps/skype/Set-CSOnlinePSTNGateway.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: -applicable: Skype for Business Online -title: Set-CSOnlinePSTNGateway -schema: 2.0.0 ---- - -# Set-CSOnlinePSTNGateway - -## SYNOPSIS -Modifies the previously defined Session Border Controller (SBC) Configuration that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. - -## SYNTAX - -### Identity (Default) -``` -Set-CSOnlinePSTNGateway [-Tenant <System.Guid>] [-SipSignallingPort <Int32>] [-CodecPriority <String>] - [-ExcludedCodecs <String>] [-FailoverTimeSeconds <Int32>] [-ForwardCallHistory <Boolean>] - [-ForwardPai <Boolean>] [-SendSipOptions <Boolean>] [-MaxConcurrentSessions <System.Int32>] - [-Enabled <Boolean>] [-MediaBypass <Boolean>] [-GatewaySiteId <String>] [-GatewaySiteLbrEnabled <Boolean>] [[-Identity] <XdsGlobalRelativeIdentity>] [-Force] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CSOnlinePSTNGateway [-Tenant <System.Guid>] [-SipSignallingPort <Int32>] [-CodecPriority <String>] - [-ExcludedCodecs <String>] [-FailoverTimeSeconds <Int32>] [-ForwardCallHistory <Boolean>] - [-ForwardPai <Boolean>] [-SendSipOptions <Boolean>] [-MaxConcurrentSessions <System.Int32>] - [-Enabled <Boolean>] [-MediaBypass <Boolean>] [-GatewaySiteId <String>] [-GatewaySiteLbrEnabled <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to modify the configuration of the previously created Session Border Controller (SBC) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter set to $false, the SBC will continue existing calls, but all new calls routed to another SBC in a route (if exists). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CSOnlinePSTNGateway - Identity sbc.contoso.com -Enabled $true -``` - -This example enables previously created SBC with Identity (and FQDN) sbc.contoso.com. All others parameters will stay default. - -### Example 2 -```powershell -PS C:\> Set-CSOnlinePSTNGateway -Identity sbc.contoso.com -SIPSignallingPort 5064 -ForwardPAI $true -Enabled $true -``` - -This example modifies the configuration of an SBC with identity (and FQDN) sbc.contoso.com. It changes the SIPSignallingPort to 5064 and enabled P-Asserted-Identity field on outbound connections (outbound from Direct Routing to SBC). For each outbound to SBC session, the Direct Routing interface will report in P-Asserted-Identity fields the TEL URI and SIP address of the user who made a call. This is useful when a tenant administrator set identity of the caller as "Anonymous" or a general number of the company, but for the billing purposes the real identity of the user should be reported. - -## PARAMETERS - -### -CodecPriority -Allows choosing codec priority when media is negotiated between Media Proxy and SBC. Default priority is ("SILKWB,SILKNB,PCMU,PCMA"). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: ("SILKWB,SILKNB,PCMU,PCMA") -Accept 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC, while it is being updated or during maintenance. Note of the parameter not set the SBC will be created as disabled (default value -Enabled $false). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedCodecs -Allows exclude some codecs during the process of media negotiation between Media Proxy and SBC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverTimeSeconds -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 gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: 10 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -```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 -``` - -### -ForwardCallHistory -Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The parameter is mandatory when modifying an existing SBC. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaxConcurrentSessions -Used by 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 parameter is not set, the alerts are not generated. However, the monitoring system will report number of concurrent session every 24 hours. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MediaBypass -Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $false -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewaySiteId -PSTN Gateway Site Id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -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 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: Skype for Business Online -Required: False -Position: Named -Default value: $false -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: $true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SipSignallingPort -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: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md) - -[Get-CSOnlinePSTNGateway](Get-CSOnlinePSTNGateway.md) - -[Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md index b0ea4366ba..32085367bd 100644 --- a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAVEdgeConfiguration @@ -194,7 +199,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -217,4 +222,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsAVEdgeConfiguration](New-CsAVEdgeConfiguration.md) [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md b/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md index 61f2d95c9b..a8885119cb 100644 --- a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAccessEdgeConfiguration @@ -636,7 +641,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -654,4 +659,3 @@ The `Set-CsAccessEdgeConfiguration` cmdlet does not return any objects or values ## RELATED LINKS [Get-CsAccessEdgeConfiguration](Get-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md b/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md index ab8cad119c..deb444e50b 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAddressBookConfiguration @@ -375,7 +380,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -398,4 +403,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsAddressBookConfiguration](New-CsAddressBookConfiguration.md) [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md index 55d7ba6916..eb9e97ae29 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAddressBookNormalizationConfiguration @@ -191,7 +196,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -215,4 +220,3 @@ Instead, the `Set-CsAddressBookNormalizationConfiguration` cmdlet modifies exist [Remove-CsAddressBookNormalizationConfiguration](Remove-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md index caf9227f34..c68c1560bb 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAddressBookNormalizationRule @@ -44,7 +49,7 @@ The command shown in Example 1 changes the priority of the RedmondAddresses norm ### -------------------------- Example 2 -------------------------- ``` -Get-CsAddressBookNormalizationRule | Where-Object {$_.Translation -eq '+1206556$1'} Set-CsAddressBookNormalizationRule -Translation '+1425556$1' +Get-CsAddressBookNormalizationRule | Where-Object {$_.Translation -eq '+1206556$1'} | Set-CsAddressBookNormalizationRule -Translation '+1425556$1' ``` In Example 2, all the normalization rules that use the Translation +12065556$1 are updated to use the Translation +14255556$1; this might be required if an area code changes from 206 to 425. @@ -212,7 +217,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -234,4 +239,3 @@ Instead, the `Set-CsAddressBookNormalizationRule` cmdlet modifies existing insta [New-CsAddressBookNormalizationRule](New-CsAddressBookNormalizationRule.md) [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsAdminRole.md b/skype/skype-ps/skype/Set-CsAdminRole.md index bb0f3eb333..844768e6e6 100644 --- a/skype/skype-ps/skype/Set-CsAdminRole.md +++ b/skype/skype-ps/skype/Set-CsAdminRole.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAdminRole @@ -314,7 +319,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -330,4 +335,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsAllowedDomain.md b/skype/skype-ps/skype/Set-CsAllowedDomain.md index 02ce89200c..09d21b4f92 100644 --- a/skype/skype-ps/skype/Set-CsAllowedDomain.md +++ b/skype/skype-ps/skype/Set-CsAllowedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAllowedDomain @@ -264,7 +269,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -289,4 +294,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsAllowedDomain](Remove-CsAllowedDomain.md) [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAnalogDevice.md b/skype/skype-ps/skype/Set-CsAnalogDevice.md index d18b39444b..5c9cadbf2c 100644 --- a/skype/skype-ps/skype/Set-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Set-CsAnalogDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAnalogDevice @@ -308,7 +313,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -333,4 +338,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [New-CsAnalogDevice](New-CsAnalogDevice.md) [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Set-CsAnnouncement.md b/skype/skype-ps/skype/Set-CsAnnouncement.md index 92c9600b66..7ed8e2878a 100644 --- a/skype/skype-ps/skype/Set-CsAnnouncement.md +++ b/skype/skype-ps/skype/Set-CsAnnouncement.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAnnouncement @@ -259,7 +264,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -284,4 +289,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsAnnouncement](Get-CsAnnouncement.md) [Import-CsAnnouncementFile](Import-CsAnnouncementFile.md) - diff --git a/skype/skype-ps/skype/Set-CsApplicationServer.md b/skype/skype-ps/skype/Set-CsApplicationServer.md index e1fea7c830..0d12488539 100644 --- a/skype/skype-ps/skype/Set-CsApplicationServer.md +++ b/skype/skype-ps/skype/Set-CsApplicationServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsApplicationServer @@ -403,7 +408,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -422,4 +427,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsServerApplication](Get-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md b/skype/skype-ps/skype/Set-CsArchivingConfiguration.md index 8e5ae6cff1..f3a3c69100 100644 --- a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsArchivingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsArchivingConfiguration @@ -356,7 +361,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -381,4 +386,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsArchivingConfiguration](Remove-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/Set-CsArchivingPolicy.md b/skype/skype-ps/skype/Set-CsArchivingPolicy.md index 3cafa1ed9f..f4e73c3195 100644 --- a/skype/skype-ps/skype/Set-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Set-CsArchivingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsArchivingPolicy @@ -235,7 +240,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -260,4 +265,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsArchivingPolicy](New-CsArchivingPolicy.md) [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsArchivingServer.md b/skype/skype-ps/skype/Set-CsArchivingServer.md index f5d9949270..8d31fba3a6 100644 --- a/skype/skype-ps/skype/Set-CsArchivingServer.md +++ b/skype/skype-ps/skype/Set-CsArchivingServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsArchivingServer @@ -132,7 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -151,4 +156,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.Displ ## RELATED LINKS [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md b/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md index a3bd08193d..bb891a7b26 100644 --- a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAudioTestServiceApplication @@ -334,7 +339,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -351,4 +356,3 @@ The `Set-CsAudioTestServiceApplication` cmdlet does not return any objects or va ## RELATED LINKS [Get-CsAudioTestServiceApplication](Get-CsAudioTestServiceApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsAuthConfig.md b/skype/skype-ps/skype/Set-CsAuthConfig.md index 02379567e7..3e47cfbe63 100644 --- a/skype/skype-ps/skype/Set-CsAuthConfig.md +++ b/skype/skype-ps/skype/Set-CsAuthConfig.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -applicable: Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Set-CsAuthConfig @@ -31,23 +36,27 @@ Use the Set-CsAuthConfig cmdlet to modify the authentication configuration for y This cmdlet sets configuration on both the Registrar and the Web Services roles. -It is only meant to be run at the global level (and not at the pool level), and we highly recommend that you only use it in this manner. However, technically it can be run at a pool level. But realize that if the pool only has one of the roles needed (say, Registrar and not Web Services), then only the settings for Registrar will be set and the Web Services settings will come from the global setting. No special warning will be given because some settings were not set. If a client uses the Registrar settings from one pool and the Web Services settings from another pool and the authentication settings are in an inconsistent state, the client may be unable to log on. If neither role is present for a pool, both Get will return an error message. If both roles are present for a pool but policies aren't defined at the pool level, Get will return an error message. +It is only meant to be run at the global level (and not at the pool level), and we highly recommend that you only use it in this manner. However, technically it can be run at a pool level. But realize that if the pool only has one of the roles needed (say, Registrar and not Web Services), then only the settings for Registrar will be set and the Web Services settings will come from the global setting. No special warning will be given because some settings were not set. If a client uses the Registrar settings from one pool and the Web Services settings from another pool and the authentication settings are in an inconsistent state, the client may be unable to log on. If neither role is present for a pool, Get will return an error message. If both roles are present for a pool but policies aren't defined at the pool level, Get will return an error message. ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-CsAuthConfig -BlockWindowsAuthExternally +PS C:\> Set-CsAuthConfig -Scenario BlockWindowsAuthExternally ``` This example forces all external clients to use MA 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. ### Example 2 -PS C:\> Set-CsAuthConfig -BlockWindowsAuthExternallyAndModernAuthInternally +```powershell +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 @@ -58,7 +67,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -73,7 +82,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: 0 Default value: None @@ -89,7 +98,7 @@ Type: AuthConfigScenario Parameter Sets: (All) Aliases: Accepted values: Custom, AllowAllExternallyAndInternally, BlockWindowsAuthExternally, BlockWindowsAuthExternallyAndInternally, BlockWindowsAuthExternalyAndModernAuthInternally, BlockModernAuthInternally -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None @@ -105,7 +114,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -115,7 +124,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -126,6 +135,9 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## OUTPUTS ### System.Object + ## 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. + ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md index 207aa8a056..19027a504c 100644 --- a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAutodiscoverConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsAutodiscoverConfiguration @@ -19,14 +24,14 @@ This cmdlet was introduced in the cumulative update for Lync Server 2010: Novemb ``` Set-CsAutodiscoverConfiguration [[-Identity] <XdsIdentity>] [-Confirm] [-ExternalSipClientAccessFqdn <String>] [-ExternalSipClientAccessPort <UInt32>] [-Force] [-WebLinks <PSListModifier>] [-WhatIf] - [-EnableCertificateProvisioningServiceUrl <Boolean>] [<CommonParameters>] + [-EnableCertificateProvisioningServiceUrl <Boolean>] [-EnableCORS <Boolean>] [<CommonParameters>] ``` ### Instance ``` Set-CsAutodiscoverConfiguration [-Confirm] [-ExternalSipClientAccessFqdn <String>] [-ExternalSipClientAccessPort <UInt32>] [-Force] [-Instance <PSObject>] [-WebLinks <PSListModifier>] [-WhatIf] - [-EnableCertificateProvisioningServiceUrl <Boolean>] [<CommonParameters>] + [-EnableCertificateProvisioningServiceUrl <Boolean>] [-EnableCORS <Boolean>] [<CommonParameters>] ``` ## DESCRIPTION @@ -57,12 +62,12 @@ From there, you can use the `Set-CsAutoDiscoverConfiguration` cmdlet to add or r ### -------------------------- Example 1 -------------------------- ``` -$Link1 = New-CsWebLink -Token "Fabrikam" -Href "http://lyncdiscover.fabrikam.com/" +$Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://lyncdiscover.fabrikam.com/" Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1} ``` -The commands shown in Example 1 add a new Autodiscover URL (http://LyncDiscover.fabrikam.com) to the Autodiscover configuration settings assigned to the Redmond site. +The commands shown in Example 1 add a new Autodiscover URL (`https://LyncDiscover.fabrikam.com`) to the Autodiscover configuration settings assigned to the Redmond site. To do this, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL; that URL is stored in a variable named $Link1. In the second command, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to add the new URL to any URLs already assigned to these settings. This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. @@ -88,14 +93,14 @@ To do this, the command uses the WebLinks parameter and the parameter value @{Re ### -------------------------- Example 3 -------------------------- ``` -$Link2 = New-CsWebLink -Token "Contoso" -Href "http://lyncdiscover.contoso.com/" +$Link2 = New-CsWebLink -Token "Contoso" -Href "https://lyncdiscover.contoso.com/" Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Replace=$Link2} ``` Example 3 shows how you can replace an existing collection of Autodiscover URLs with, in this case, a single URL. -To carry out this task, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL for http://LyncDiscover.contoso.com; the resulting URL is stored in a variable named $Link2. -The second command then uses the `Set-CsAutoDiscoverConfiguration` cmdlet and the WebLinks parameter to remove any URLs previously assigned to the Redmond site and replace them with the URL for http://LyncDiscover.contoso.com. +To carry out this task, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL for `https://LyncDiscover.contoso.com`; the resulting URL is stored in a variable named $Link2. +The second command then uses the `Set-CsAutoDiscoverConfiguration` cmdlet and the WebLinks parameter to remove any URLs previously assigned to the Redmond site and replace them with the URL for `https://LyncDiscover.contoso.com`. To do this, the command uses the Replace method instead of the Add or Remove method. @@ -127,6 +132,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableCORS + +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 + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalSipClientAccessFqdn Fully qualified domain name (FQDN) of the server that is used for external client access. @@ -267,8 +289,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableCORS + +If set to True, Cross-Origin Resource Sharing is enabled. + +```yaml +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 +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -284,4 +323,3 @@ The `Set-CsAutoDiscoverConfiguration` cmdlet modifies instances of the Microsoft ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md b/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md index 7f621628d1..dec80abb43 100644 --- a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsBackupServiceConfiguration @@ -20,7 +25,7 @@ This cmdlet was introduced in Lync Server 2013. Set-CsBackupServiceConfiguration [[-Identity] <XdsIdentity>] [-AuthorizedLocalAccounts <String>] [-AuthorizedUniversalGroups <String>] [-Confirm] [-Force] [-MaxBatchesPerCmsSync <Int32>] [-MaxBatchesPerUserStoreSync <Int32>] [-MaxConcurrentCalls <Int32>] [-MaxDataConfPackageSizeKB <Int32>] - [-SyncInterval <TimeSpan>] [-WhatIf] [-MaxHighPriQueuePercentagePerUserStoreSync <Int32>] [<CommonParameters>] + [-SyncInterval <TimeSpan>] [-WhatIf] [-MaxHighPriQueuePercentagePerUserStoreSync <Int32>] [-EnableRgsBackupService <Boolean>] [<CommonParameters>] ``` ### Instance @@ -28,7 +33,7 @@ Set-CsBackupServiceConfiguration [[-Identity] <XdsIdentity>] [-AuthorizedLocalAc Set-CsBackupServiceConfiguration [-AuthorizedLocalAccounts <String>] [-AuthorizedUniversalGroups <String>] [-Confirm] [-Force] [-Instance <PSObject>] [-MaxBatchesPerCmsSync <Int32>] [-MaxBatchesPerUserStoreSync <Int32>] [-MaxConcurrentCalls <Int32>] [-MaxDataConfPackageSizeKB <Int32>] - [-SyncInterval <TimeSpan>] [-WhatIf] [-MaxHighPriQueuePercentagePerUserStoreSync <Int32>] [<CommonParameters>] + [-SyncInterval <TimeSpan>] [-WhatIf] [-MaxHighPriQueuePercentagePerUserStoreSync <Int32>] [-EnableRgsBackupService <Boolean>] [<CommonParameters>] ``` ## DESCRIPTION @@ -290,8 +295,24 @@ 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 + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2019 + +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -311,4 +332,3 @@ Instead, the `Set-CsBackupServiceConfiguration` cmdlet modifies existing instanc [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) [Remove-CsBackupServiceConfiguration](Remove-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md index ceb3ea07b9..cc5fd68c6b 100644 --- a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsBandwidthPolicyServiceConfiguration @@ -209,7 +214,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -232,4 +237,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.B [Remove-CsBandwidthPolicyServiceConfiguration](Remove-CsBandwidthPolicyServiceConfiguration.md) [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsBlockedDomain.md b/skype/skype-ps/skype/Set-CsBlockedDomain.md index e549f15c73..15662712d0 100644 --- a/skype/skype-ps/skype/Set-CsBlockedDomain.md +++ b/skype/skype-ps/skype/Set-CsBlockedDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsBlockedDomain @@ -177,7 +182,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -202,4 +207,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsBlockedDomain](Remove-CsBlockedDomain.md) [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md index 21270710d0..62a74c0304 100644 --- a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsBroadcastMeetingConfiguration @@ -427,7 +432,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -442,4 +447,3 @@ None ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsBusyOptions.md b/skype/skype-ps/skype/Set-CsBusyOptions.md index 26aad68565..5743b4b153 100644 --- a/skype/skype-ps/skype/Set-CsBusyOptions.md +++ b/skype/skype-ps/skype/Set-CsBusyOptions.md @@ -3,6 +3,10 @@ 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 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsBusyOptions @@ -32,7 +36,7 @@ After configuration, the Busy Options setting is in effect for all the user's Sk Users will see missed-call notifications on their Skype for Business clients and devices, and they will be notified by email as well. Callers whose call was rejected due to Busy on Busy will see a notification in their Skype for Business client stating that the user they attempted to reach is busy on another call. -For more information about how to enable Busy Options in your organization, see (https://docs.microsoft.com/en-us/skypeforbusiness/deploy/deploy-enterprise-voice/install-and-configure-busy-options). +For more information about how to enable Busy Options in your organization, see (https://learn.microsoft.com/skypeforbusiness/deploy/deploy-enterprise-voice/install-and-configure-busy-options). ## EXAMPLES @@ -92,7 +96,7 @@ Accept wildcard characters: False ### -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". +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 @@ -141,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -158,6 +162,6 @@ Microsoft.Rtc.Management.AD.UserIdParameter object. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://docs.microsoft.com/en-us/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) -[Remove-CsBusyOptions](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsCallParkOrbit.md b/skype/skype-ps/skype/Set-CsCallParkOrbit.md index a517459337..1962bcc635 100644 --- a/skype/skype-ps/skype/Set-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/Set-CsCallParkOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCallParkOrbit @@ -242,7 +247,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -264,4 +269,3 @@ This cmdlet modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.Di [Remove-CsCallParkOrbit](Remove-CsCallParkOrbit.md) [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) - diff --git a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md b/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md index 979865fc44..81af567605 100644 --- a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md +++ b/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCallParkServiceMusicOnHoldFile @@ -40,17 +45,13 @@ Audio files must be in the following format: Windows Media Audio 9, 44 kHz, 16 b ### -------------------------- Example 1 -------------------------- ``` -$a = Get-Content -ReadCount 0 -Encoding byte "C:\MoHFiles\soothingmusic.wma" +$a = [System.IO.File]::ReadAllBytes('C:\MoHFiles\soothingmusic.wma') Set-CsCallParkServiceMusicOnHoldFile -Service ApplicationServer:pool0.litwareinc.com -Content $a ``` This example sets the file SoothingMusic.wma to be the audio file that is played to callers whose calls are parked. -The first line of this example is a call to the `Get-Content` cmdlet. -This cmdlet simply reads the contents of a file and assigns them, in this case, to the variable $a. -We pass a value of 0 to the ReadCount parameter so the `Get-Content` cmdlet will read the entire file at once (rather than try to read it line by line, which doesn't apply to an audio file). -We set the Encoding parameter to byte. -This tells the `Get-Content` cmdlet that the content we want to read into variable $a is a byte array rather than the audio file in .wma format. +The first line of this example uses the `[System.IO.File]::ReadAllBytes` command to read the contents of a file in byte format and assign them, in this case, to the variable $a. Line 2 in this example is where we actually assign the audio file. We call the `Set-CsCallParkServiceMusicOnHoldFile` cmdlet and specify the service ID where the Call Park service is running. @@ -79,8 +80,7 @@ Accept wildcard characters: False ### -Content The contents of the audio file in byte format. -Use the `Get-Content` cmdlet to retrieve the contents of the audio file in byte format. -(For details, see the Examples section in this topic.) +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -144,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,4 +168,3 @@ This cmdlet does not return a value. [Set-CsCpsConfiguration](Set-CsCpsConfiguration.md) [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md index ab051c5b06..5177db6710 100644 --- a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCallViaWorkPolicy ## SYNOPSIS -Use the `Set-CsCallViaWorkPolicy` to modify an existing call via work policy that enables and manages the characteristics of outbound calls placed through the Skype for Business client. +Use the `Set-CsCallViaWorkPolicy` cmdlet to modify an existing call via work policy that enables and manages the characteristics of outbound calls placed through the Skype for Business client. ## SYNTAX @@ -26,9 +31,7 @@ Set-CsCallViaWorkPolicy [-AdminCallbackNumber <String>] [-Confirm] [-Enabled <Bo ``` ## DESCRIPTION -To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command from the Windows PowerShell prompt. - -`Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\<DesiredCmdletName\>"}` +Use this cmdlet to modify an existing call via work policy that enables and manages the characteristics of outbound calls placed through the Skype for Business client. ## EXAMPLES @@ -185,7 +188,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -201,7 +204,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -226,4 +229,3 @@ None. [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsCallerIdPolicy.md b/skype/skype-ps/skype/Set-CsCallerIdPolicy.md deleted file mode 100644 index e1f5e8a29c..0000000000 --- a/skype/skype-ps/skype/Set-CsCallerIdPolicy.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsCallerIdPolicy -schema: 2.0.0 ---- - -# Set-CsCallerIdPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Set-CsCallerIdPolicy [-Tenant <Guid>] [-Description <String>] [-Name <String>] - [-EnableUserOverride <Boolean>] [-ServiceNumber <String>] [-CallerIDSubstitute <CallerIDSubstitute>] - [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsCallerIdPolicy [-Tenant <Guid>] [-Description <String>] [-Name <String>] - [-EnableUserOverride <Boolean>] [-ServiceNumber <String>] [-CallerIDSubstitute <CallerIDSubstitute>] - [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -CallerIDSubstitute -PARAMVALUE: Anonymous | Service | LineUri - -```yaml -Type: CallerIDSubstitute -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 -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUserOverride -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: PSObject - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCallingLineIdentity.md b/skype/skype-ps/skype/Set-CsCallingLineIdentity.md deleted file mode 100644 index bc1065a30d..0000000000 --- a/skype/skype-ps/skype/Set-CsCallingLineIdentity.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsCallingLineIdentity -schema: 2.0.0 ---- - -# Set-CsCallingLineIdentity - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Set-CsCallingLineIdentity [-Tenant <Guid>] [-Description <String>] [-EnableUserOverride <Boolean>] - [-ServiceNumber <String>] [-CallingIDSubstitute <CallingIDSubstituteType>] - [-BlockIncomingPstnCallerID <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Instance -``` -Set-CsCallingLineIdentity [-Tenant <Guid>] [-Description <String>] [-EnableUserOverride <Boolean>] - [-ServiceNumber <String>] [-CallingIDSubstitute <CallingIDSubstituteType>] - [-BlockIncomingPstnCallerID <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -BlockIncomingPstnCallerID -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingIDSubstitute -PARAMVALUE: Anonymous | Service | LineUri - -```yaml -Type: CallingIDSubstituteType -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 -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUserOverride -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: PSObject - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -PARAMVALUE: String - -Note: Do not add ‘+’ to the Service number. For example, if the Service number is +1425-xxx-xxxx then valid input is 1425xxxxxxx - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md index 88d245005a..4d556a212d 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsCceApplianceConfigurationReplicationStatus @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS {{Fill in the Synopsis}} +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -136,7 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -149,4 +156,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md index febaf45a0c..1ca389b8ab 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsCceApplianceDeploymentStatus @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Provide the topic introduction here. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -204,7 +211,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -213,4 +220,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceStatus.md index 99f89b49ed..634a66015e 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceStatus.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsCceApplianceStatus @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Provide the topic introduction here. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -186,7 +193,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -195,4 +202,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCdrConfiguration.md b/skype/skype-ps/skype/Set-CsCdrConfiguration.md index 9739677e77..adac626963 100644 --- a/skype/skype-ps/skype/Set-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/Set-CsCdrConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCdrConfiguration @@ -19,15 +24,15 @@ This cmdlet was introduced in Lync Server 2010. ### Identity ``` Set-CsCdrConfiguration [[-Identity] <XdsIdentity>] [-EnableCDR <Boolean>] [-EnablePurging <Boolean>] - [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] + [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] + [-EnableUdcLite <Boolean>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ### Instance ``` Set-CsCdrConfiguration [-Instance <PSObject>] [-EnableCDR <Boolean>] [-EnablePurging <Boolean>] - [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] + [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] + [-EnableUdcLite <Boolean>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION @@ -218,6 +223,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableUdcLite +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses the display of any non-fatal error message that might occur when running the command. @@ -267,7 +287,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -290,4 +310,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsCdrConfiguration](New-CsCdrConfiguration.md) [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsCertificate.md b/skype/skype-ps/skype/Set-CsCertificate.md index 09d3541dba..a88a78863d 100644 --- a/skype/skype-ps/skype/Set-CsCertificate.md +++ b/skype/skype-ps/skype/Set-CsCertificate.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCertificate @@ -348,7 +353,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -371,4 +376,3 @@ The `Set-CsCertificate` cmdlet does not return any values or objects. [Remove-CsCertificate](Remove-CsCertificate.md) [Request-CsCertificate](Request-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Set-CsClientPin.md b/skype/skype-ps/skype/Set-CsClientPin.md index f51a1bd6f0..186c380a81 100644 --- a/skype/skype-ps/skype/Set-CsClientPin.md +++ b/skype/skype-ps/skype/Set-CsClientPin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClientPin @@ -178,7 +183,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -202,4 +207,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.UserPin [Lock-CsClientPin](Lock-CsClientPin.md) [Unlock-CsClientPin](Unlock-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Set-CsClientPolicy.md b/skype/skype-ps/skype/Set-CsClientPolicy.md index d6e378bf13..6af1ef3225 100644 --- a/skype/skype-ps/skype/Set-CsClientPolicy.md +++ b/skype/skype-ps/skype/Set-CsClientPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClientPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsClientPolicy @@ -113,9 +118,9 @@ You can even create a custom policy that gets assigned to a single user. Client policies can be configured at the global, site and per-user scopes. The `Set-CsClientPolicy` cmdlet enables you to modify any (or all) of the client policies that have been configured for use in your organization. -Keep in mind that client policies differ from many other policies in that most of the policy settings do not have default values. +Keep in mind that client policies differ from many other policies in that most of the policy settings do not have default values. When setting is null/none just means that server in band provisioning does not override default client value. Basically, default values are set by client for these cases. -The following parameters are not applicable to Skype for Business Online: AddressBookAvailability, AsJob, AttendantSafeTransfer, AutoDiscoveryRetryInterval, BlockConversationFromFederatedContacts, CalendarStatePublicationInterval, ConferenceIMIdleTimeout, CustomizedHelpUrl, CustomLinkInErrorMessages, CustomStateUrl, Description, DGRefreshInterval, DisableContactCardOrganizationTab, DisableFederatedPromptDisplayName, DisableFeedsTab, DisableMeetingSubjectAndLocation, DisableOneNote12Integration, DisableOnlineContextualSearch, DisablePhonePresence, DisablePICPromptDisplayName, EnableEventLogging, EnableExchangeContactsFolder, EnableExchangeDelegateSync, EnableFullScreenVideo, EnableHighPerformanceConferencingAppSharing, EnableHighPerformanceP2PAppSharing, EnableMediaRedirection, EnableMeetingEngagement, EnableNotificationForNewSubscribers, EnableOnlineFeedback, EnableOnlineFeedbackScreenshots, EnableSQMData, EnableTracing, EnableViewBasedSubscriptionMode, EnableVOIPCallDefault, Force, HelpEnvironment, Identity, IMLatencyErrorThreshold, IMLatencySpinnerDelay, Instance, MAPIPollInterval, MaximumDGsAllowedInContactList, MaximumNumberOfContacts, MaxPhotoSizeKB, P2PAppSharingEncryption, PipelineVariable, PolicyEntry, PublicationBatchDelay, RateMyCallAllowCustomUserFeedback, RequireContentPin, SearchPrefixFlags, SPSearchCenterExternalURL, SPSearchCenterInternalURL, SPSearchExternalURL, SPSearchInternalURL, SupportModernFilePicker, TabURL, TelemetryTier, Tenant, and WebServicePollInterval +The following parameters are not applicable to Skype for Business Online: AddressBookAvailability, AttendantSafeTransfer, AutoDiscoveryRetryInterval, BlockConversationFromFederatedContacts, CalendarStatePublicationInterval, ConferenceIMIdleTimeout, CustomizedHelpUrl, CustomLinkInErrorMessages, CustomStateUrl, Description, DGRefreshInterval, DisableContactCardOrganizationTab, DisableFederatedPromptDisplayName, DisableFeedsTab, DisableMeetingSubjectAndLocation, DisableOneNote12Integration, DisableOnlineContextualSearch, DisablePhonePresence, DisablePICPromptDisplayName, EnableEventLogging, EnableExchangeContactsFolder, EnableExchangeDelegateSync, EnableFullScreenVideo, EnableHighPerformanceConferencingAppSharing, EnableHighPerformanceP2PAppSharing, EnableMediaRedirection, EnableMeetingEngagement, EnableNotificationForNewSubscribers, EnableOnlineFeedback, EnableOnlineFeedbackScreenshots, EnableSQMData, EnableTracing, EnableViewBasedSubscriptionMode, EnableVOIPCallDefault, Force, HelpEnvironment, Identity, IMLatencyErrorThreshold, IMLatencySpinnerDelay, Instance, MAPIPollInterval, MaximumDGsAllowedInContactList, MaximumNumberOfContacts, MaxPhotoSizeKB, P2PAppSharingEncryption, PipelineVariable, PolicyEntry, PublicationBatchDelay, RateMyCallAllowCustomUserFeedback, RequireContentPin, SearchPrefixFlags, SPSearchCenterExternalURL, SPSearchCenterInternalURL, SPSearchExternalURL, SPSearchInternalURL, SupportModernFilePicker, TabURL, TelemetryTier, Tenant, and WebServicePollInterval ## EXAMPLES @@ -1320,7 +1325,7 @@ 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 "http://www.litwareinc.com/feedback"` +`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"` `Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` @@ -1367,8 +1372,7 @@ To search only display name, first name, and last name you would construct this After the binary value has been constructed it must then be converted to a decimal value before being assigned to SearchPrefixFlags. To convert a binary number to a decimal number you can use the following Windows PowerShell command: -`\[Convert\]::ToInt32("1110111", 2)` - +`[Convert]::ToInt32("1110111", 2)` ```yaml Type: UInt16 @@ -1827,7 +1831,7 @@ Accept wildcard characters: False ``` ### -EnableMeetingEngagement -{{Fill EnableMeetingEngagement Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -1914,7 +1918,7 @@ Accept wildcard characters: False ``` ### -EnableViewBasedSubscriptionMode -{{Fill EnableViewBasedSubscriptionMode Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -1964,7 +1968,7 @@ Accept wildcard characters: False ``` ### -PublicationBatchDelay -{{Fill PublicationBatchDelay Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: UInt32 @@ -2017,7 +2021,7 @@ Accept wildcard characters: False ``` ### -RequireContentPin -{{Fill RequireContentPin Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -2033,7 +2037,7 @@ Accept wildcard characters: False ``` ### -SupportModernFilePicker -{{Fill SupportModernFilePicker Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -2049,7 +2053,7 @@ Accept wildcard characters: False ``` ### -TelemetryTier -{{Fill TelemetryTier Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -2089,7 +2093,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -2114,4 +2118,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsClientPolicy](New-CsClientPolicy.md) [Remove-CsClientPolicy](Remove-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md b/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md index 34643025b4..c7a71cdaca 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClientVersionConfiguration @@ -238,7 +243,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -261,4 +266,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsClientVersionConfiguration](New-CsClientVersionConfiguration.md) [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md b/skype/skype-ps/skype/Set-CsClientVersionPolicy.md index d0d3992743..dfff66f31a 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Set-CsClientVersionPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClientVersionPolicy @@ -222,7 +227,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -247,4 +252,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md index 3230c6a8b7..b9933740d1 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClientVersionPolicyRule @@ -457,7 +462,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -480,4 +485,3 @@ Instead, the `Set-CsClientVersionPolicyRule` cmdlet modifies instances of the Mi [New-CsClientVersionPolicyRule](New-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md b/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md index 1f45861d5d..d15bbdcaf8 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md +++ b/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md @@ -1,9 +1,13 @@ --- 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 -online version: schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsCloudCallDataConnector @@ -31,9 +35,12 @@ The Set-CsCloudCallDataConnector cmdlet provides a way for you to store an on-pr PS C:\> New-CsCloudCallDataConnection | Set-CsCloudCallDataConnector -TenantId <tenant_id> ``` -If you're logged in to Skype for Business Online Powershell within the Skype for Business Server Management Shell 2019, this command in example 1 takes the output of the New-CsCloudCallDataConnection online cmdlet and passes it to the Set-CsCloudCallDataConnector cmdlet via pipeline so that the Token can be stored on premises. Along with the Token, the TenantId of your O365 tenant will get stored on premises as well. +If you're logged in to Microsoft Teams PowerShell Module within the Skype for Business Server Management Shell 2019, this command in example 1 takes the output of the New-CsCloudCallDataConnection online cmdlet and passes it to the Set-CsCloudCallDataConnector cmdlet via pipeline so that the Token can be stored on premises. Along with the Token, the TenantId of your O365 tenant will get stored on premises as well. ### Example 2 +```PowerShell +Set-CsCloudCallDataConnector -Identity Global -TenantId <tenant_id> -Token <token-copied-from-online> +``` Example showing the scenario when we aren't piping the output from online cmdlet. ## PARAMETERS @@ -45,7 +52,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -60,7 +67,7 @@ Suppresses the display of any non-fatal error message that might occur when runn Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -75,7 +82,7 @@ Allows you to pass a reference to an object to the cmdlet, rather than set indiv Type: PSObject Parameter Sets: Instance Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -90,7 +97,7 @@ Office 365 TenantID of your tenant. Type: String Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -105,7 +112,7 @@ Data ingestion token for CloudCallDataConnector telemetry endpoint. Type: String Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -121,7 +128,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -131,7 +138,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md index 298d72c797..021a5cf3e8 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md @@ -1,9 +1,13 @@ --- 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 -online version: schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsCloudCallDataConnectorConfiguration @@ -16,13 +20,13 @@ Modifies an existing collection of Cloud Call Data Connector configuration setti ### Identity (Default) ``` Set-CsCloudCallDataConnectorConfiguration [-EnableCallDataConnector <Boolean>] [[-Identity] <XdsIdentity>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] + [-Force] [-WhatIf] [<CommonParameters>] ``` ### Instance ``` Set-CsCloudCallDataConnectorConfiguration [-EnableCallDataConnector <Boolean>] [-Instance <PSObject>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] + [-WhatIf] [<CommonParameters>] ``` ## DESCRIPTION @@ -55,26 +59,14 @@ Get-CsCloudCallDataConnectorConfiguration -Filter "site:*"| Set-CsCloudCallDataC ``` Another variation of the command used in Example 1 is shown in Example 3. + In this example, the PurgeHourOfDay property is changed for all the Cloud Call Data Connector settings that have been configured at the site scope. -To perform this task, the command first calls the \`Get-CsCloudCallDataConnectorConfiguration\` cmdlet along with the Filter parameter; the filter value "site:*" ensures that only Cloud Call Data Connector settings that have an Identity that begins with the string value "site:" will be returned. -The filtered collection is then piped to the \`Set-CsCloudCallDataConnectorConfiguration\` cmdlet, which changes the EnableCallDataConnector property for each item in that collection. -## PARAMETERS +To perform this task, the command first calls the `Get-CsCloudCallDataConnectorConfiguration` cmdlet along with the Filter parameter; the filter value "site:*" ensures that only Cloud Call Data Connector settings that have an Identity that begins with the string value "site:" will be returned. -### -Confirm -Prompts you for confirmation before running the cmdlet. +The filtered collection is then piped to the `Set-CsCloudCallDataConnectorConfiguration` cmdlet, which changes the EnableCallDataConnector property for each item in that collection. -```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 -``` +## PARAMETERS ### -EnableCallDataConnector Enables upload of call data. @@ -83,7 +75,7 @@ Enables upload of call data. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -98,7 +90,7 @@ Suppresses the display of any non-fatal error message that might occur when runn Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -113,7 +105,7 @@ Represents the unique identifier to be assigned to the new collection of CloudCa Type: XdsIdentity Parameter Sets: Identity Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -128,7 +120,7 @@ Allows you to pass a reference to an object to the cmdlet, rather than set indiv Type: PSObject Parameter Sets: Instance Aliases: -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -144,7 +136,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Skype for Business Server 2019 +Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -154,7 +146,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Set-CsClsConfiguration.md b/skype/skype-ps/skype/Set-CsClsConfiguration.md index e96ded3f29..ac2b5e0018 100644 --- a/skype/skype-ps/skype/Set-CsClsConfiguration.md +++ b/skype/skype-ps/skype/Set-CsClsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClsConfiguration @@ -24,6 +29,7 @@ Set-CsClsConfiguration [[-Identity] <XdsIdentity>] [-CacheFileLocalFolders <Stri [-Force] [-MinimumClsAgentServiceVersion <UInt32>] [-Regions <PSListModifier>] [-Scenarios <PSListModifier>] [-SearchTerms <PSListModifier>] [-SecurityGroups <PSListModifier>] [-TmfFileSearchPath <String>] [-WhatIf] [-NetworkUsagePacketSize <UInt32>] [-NetworkUsageThreshold <UInt32>] [-Version <String>] [<CommonParameters>] + [-ETLMinFreeSpaceInDiskInBytes<Int64>] [-ETLEnoughFreeSpaceInDiskInBytes<Int64>] [-ETLMinQuotaInBytes <Int64>] [-ETLMaxQuotaInBytes <Int64>] [-ETLEnoughQuotaInBytes <Int64>] [EtlMaxRetentionInDays <UInt32>] ``` ### Instance @@ -35,6 +41,7 @@ Set-CsClsConfiguration [-CacheFileLocalFolders <String>] [-CacheFileLocalMaxDisk [-MinimumClsAgentServiceVersion <UInt32>] [-Regions <PSListModifier>] [-Scenarios <PSListModifier>] [-SearchTerms <PSListModifier>] [-SecurityGroups <PSListModifier>] [-TmfFileSearchPath <String>] [-WhatIf] [-NetworkUsagePacketSize <UInt32>] [-NetworkUsageThreshold <UInt32>] [-Version <String>] [<CommonParameters>] + [-ETLMinFreeSpaceInDiskInBytes<Int64>] [-ETLEnoughFreeSpaceInDiskInBytes<Int64>] [-ETLMinQuotaInBytes <Int64>] [-ETLMaxQuotaInBytes <Int64>] [-ETLEnoughQuotaInBytes <Int64>] [EtlMaxRetentionInDays <UInt32>] ``` ## DESCRIPTION @@ -491,8 +498,107 @@ 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 + +Required: False +Position: Named +Default value: 2000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLEnoughFreeSpaceInDiskInBytes +Enough free disk space to make purge stop due low free disk space. +If disk size reaches this size, purge stops. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2019 + +Required: False +Position: Named +Default value: 4000000000 +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 + +Required: False +Position: Named +Default value: 3221225472 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMaxQuotaInBytes +Max allowed quota used by ETL files before purge starts + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2019 + +Required: False +Position: Named +Default value: 400000000000 +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 +``` + + +### -ETLMaxRetentionInDays +Maximum retention time in days for ETL files + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2019 + +Required: False +Position: Named +Default value: 14 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -514,4 +620,3 @@ Instead, the `Set-CsClsConfiguration` cmdlet modifies existing instances of the [New-CsClsConfiguration](New-CsClsConfiguration.md) [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsClsRegion.md b/skype/skype-ps/skype/Set-CsClsRegion.md index 1db0b38de6..89a4dee70b 100644 --- a/skype/skype-ps/skype/Set-CsClsRegion.md +++ b/skype/skype-ps/skype/Set-CsClsRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClsRegion @@ -186,7 +191,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -208,4 +213,3 @@ Instead, the `Set-CsClsRegion` cmdlet modifies existing instances of the Microso [New-CsClsRegion](New-CsClsRegion.md) [Remove-CsClsRegion](Remove-CsClsRegion.md) - diff --git a/skype/skype-ps/skype/Set-CsClsScenario.md b/skype/skype-ps/skype/Set-CsClsScenario.md index 8f4f09c9cf..156d2a64db 100644 --- a/skype/skype-ps/skype/Set-CsClsScenario.md +++ b/skype/skype-ps/skype/Set-CsClsScenario.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClsScenario @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -192,4 +197,3 @@ Instead, the `Set-CsClsScenario` cmdlet modifies existing instances of the Micro ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsClsSearchTerm.md b/skype/skype-ps/skype/Set-CsClsSearchTerm.md index ac11e2f866..f3cb33712c 100644 --- a/skype/skype-ps/skype/Set-CsClsSearchTerm.md +++ b/skype/skype-ps/skype/Set-CsClsSearchTerm.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClsSearchTerm @@ -164,7 +169,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -182,4 +187,3 @@ Instead, the `Set-CsClsSearchTerm` cmdlet modifies existing instances of the Mic ## RELATED LINKS [Get-CsClsSearchTerm](Get-CsClsSearchTerm.md) - diff --git a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md b/skype/skype-ps/skype/Set-CsClsSecurityGroup.md index 34c9db84e9..a0d8f37e29 100644 --- a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/Set-CsClsSecurityGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsClsSecurityGroup @@ -183,7 +188,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -205,4 +210,3 @@ Instead, the `Set-CsClsSecurityGroup` cmdlet modifies existing instances of the [New-CsClsSecurityGroup](New-CsClsSecurityGroup.md) [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md b/skype/skype-ps/skype/Set-CsCommonAreaPhone.md index 2409942a68..0339c1c04d 100644 --- a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Set-CsCommonAreaPhone.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCommonAreaPhone @@ -320,7 +325,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -344,4 +349,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [New-CsCommonAreaPhone](New-CsCommonAreaPhone.md) [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md b/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md index e3ff715c7b..161abd1d7d 100644 --- a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md +++ b/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsConferenceDisclaimer @@ -166,7 +171,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -187,4 +192,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsConferenceDisclaimer](Get-CsConferenceDisclaimer.md) [Remove-CsConferenceDisclaimer](Remove-CsConferenceDisclaimer.md) - diff --git a/skype/skype-ps/skype/Set-CsConferenceServer.md b/skype/skype-ps/skype/Set-CsConferenceServer.md index b3197267de..b10649feaa 100644 --- a/skype/skype-ps/skype/Set-CsConferenceServer.md +++ b/skype/skype-ps/skype/Set-CsConferenceServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsConferenceServer @@ -26,7 +31,7 @@ Set-CsConferenceServer [[-Identity] <XdsGlobalRelativeIdentity>] [-AppSharingSip ## DESCRIPTION Conference Servers (also known as A/V Conferencing Servers) are used to provide audio and video capabilities to conferences. In turn, the `Set-CsConferenceServer` cmdlet can be used to modify the properties of these servers; in particular, you can specify which ports are used for such things as audio traffic, video traffic and application sharing. -You can also use the `Set-CsConferenceServer` cmdlet to associate a given server with a Edge Server or Archiving Server. +You can also use the `Set-CsConferenceServer` cmdlet to associate a given server with an Edge Server or Archiving Server. ## EXAMPLES @@ -342,7 +347,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -363,4 +368,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsConferencingConfiguration](Get-CsConferencingConfiguration.md) [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md b/skype/skype-ps/skype/Set-CsConferencingConfiguration.md index 2cbcf1dc38..6af69082b4 100644 --- a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsConferencingConfiguration @@ -26,7 +31,7 @@ Set-CsConferencingConfiguration [[-Identity] <XdsIdentity>] [-ClientAppSharingPo [-HelpdeskExternalUrl <String>] [-HelpdeskInternalUrl <String>] [-MaxBandwidthPerAppSharingServiceMb <UInt64>] [-MaxContentStorageMb <UInt16>] [-Organization <String>] [-Force] [-WhatIf] [-Confirm] [-MaxUploadFileSizeMb <UInt16>] [-CloudPollServicePrimaryUrl <String>] - [-CloudPollServiceSecondaryUrl <String>] [<CommonParameters>] + [-CloudPollServiceSecondaryUrl <String>] [-EncryptArchivedData <Boolean>] [<CommonParameters>] ``` ### Instance @@ -40,7 +45,7 @@ Set-CsConferencingConfiguration [-Instance <PSObject>] [-ClientAppSharingPort <U [-HelpdeskExternalUrl <String>] [-HelpdeskInternalUrl <String>] [-MaxBandwidthPerAppSharingServiceMb <UInt64>] [-MaxContentStorageMb <UInt16>] [-Organization <String>] [-Force] [-WhatIf] [-Confirm] [-MaxUploadFileSizeMb <UInt16>] [-CloudPollServicePrimaryUrl <String>] - [-CloudPollServiceSecondaryUrl <String>] [<CommonParameters>] + [-CloudPollServiceSecondaryUrl <String>] [-EncryptArchivedData <Boolean>] [<CommonParameters>] ``` ## DESCRIPTION @@ -640,8 +645,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EncryptArchivedData +Boolean flag to turn on/off encryption for a conference's archived attachments. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2019 + +Required: False +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 (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -664,4 +685,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsConferencingConfiguration](New-CsConferencingConfiguration.md) [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsConferencingPolicy.md b/skype/skype-ps/skype/Set-CsConferencingPolicy.md index bf96c8b3e4..96b5bc05d9 100644 --- a/skype/skype-ps/skype/Set-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Set-CsConferencingPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConferencingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsConferencingPolicy @@ -78,7 +83,7 @@ This provides administrators with enormous flexibility when it comes to deciding Policy property values can be configured at the time a policy is created. In addition to that, you can, at any time, use the `Set-CsConferencingPolicy` cmdlet to modify the property values of an existing policy. -The following parameters are not applicable to Skype for Business Online: ApplicationSharingMode, AsJob, AudioBitRateKb, Description, EnableMultiViewJoin, EnableOnlineMeetingPromptForLyncResources, EnableReliableConferenceDeletion, FileTransferBitRateKb, Force, Identity, Instance, MaxMeetingSize, MaxVideoConferenceResolution, PipelineVariable, Tenant, and TotalReceiveVideoBitRateKb +The following parameters are not applicable to Skype for Business Online: ApplicationSharingMode, AudioBitRateKb, Description, EnableMultiViewJoin, EnableOnlineMeetingPromptForLyncResources, EnableReliableConferenceDeletion, FileTransferBitRateKb, Force, Identity, Instance, MaxMeetingSize, MaxVideoConferenceResolution, PipelineVariable, Tenant, and TotalReceiveVideoBitRateKb ## EXAMPLES @@ -424,8 +429,7 @@ 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. @@ -462,6 +466,8 @@ Accept wildcard characters: False ``` ### -EnableDialInConferencing +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. @@ -472,7 +478,7 @@ However, the user can take part in other conferences where dial-in conferencing 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -569,7 +575,7 @@ After the maximum number of participants has been reached anyone else who tries 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 http://go.microsoft.com/fwlink/p/?linkId=242073 (http://go.microsoft.com/fwlink/p/?linkId=242073). +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. @@ -894,7 +900,12 @@ Accept wildcard characters: False ``` ### -AllowFederatedParticipantJoinAsSameEnterprise -PARAMVALUE: $true | $false +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. + ```yaml Type: Boolean @@ -904,7 +915,7 @@ Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -955,7 +966,7 @@ Determines the protocol used for screen sharing - VbSS vs RDP. This parameter i Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, 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 @@ -998,13 +1009,14 @@ Accept wildcard characters: False ``` ### -EnableReliableConferenceDeletion -PARAMVALUE: $true | $false +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: Skype for Business Online +Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -1038,7 +1050,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -1063,4 +1075,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsConferencingPolicy](New-CsConferencingPolicy.md) [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md b/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md index 9a762fbb32..e52a31a523 100644 --- a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsConfigurationStoreLocation @@ -230,7 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -250,4 +255,3 @@ The `Set-CsConfigurationStoreLocation` cmdlet does not return any objects or val [Get-CsConfigurationStoreLocation](Get-CsConfigurationStoreLocation.md) [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md b/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md index 6f7d74fec9..4852521547 100644 --- a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsConversationHistoryConfiguration @@ -195,7 +200,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -215,4 +220,3 @@ Instead, `Set-CsConversationHistoryConfiguration` modifies instances of the Micr [Get-CsConversationHistoryConfiguration](Get-CsConversationHistoryConfiguration.md) [Remove-CsConversationHistoryConfiguration](Remove-CsConversationHistoryConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsCpsConfiguration.md b/skype/skype-ps/skype/Set-CsCpsConfiguration.md index aed1621165..ae868b8cba 100644 --- a/skype/skype-ps/skype/Set-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/Set-CsCpsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsCpsConfiguration @@ -235,7 +240,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -259,4 +264,3 @@ Modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Call [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - diff --git a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md index 330a184175..8f111fabab 100644 --- a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDeviceUpdateConfiguration @@ -347,7 +352,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -370,4 +375,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsDeviceUpdateConfiguration](New-CsDeviceUpdateConfiguration.md) [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md index d7293907d8..505b7d16bb 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDiagnosticConfiguration @@ -253,7 +258,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -278,4 +283,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsDiagnosticsFilter](New-CsDiagnosticsFilter.md) [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md index 9e7ec9932f..4d2cb97630 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDiagnosticHeaderConfiguration @@ -222,7 +227,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -245,4 +250,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsDiagnosticHeaderConfiguration](New-CsDiagnosticHeaderConfiguration.md) [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md index e627d37a94..01205b59cd 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDialInConferencingAccessNumber @@ -394,7 +399,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -417,4 +422,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Xds.Acc [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md index 31dcfad8b3..05992d1033 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDialInConferencingConfiguration @@ -260,7 +265,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -283,4 +288,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsDialInConferencingConfiguration](New-CsDialInConferencingConfiguration.md) [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md index bca531d897..f9a7d636a3 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDialInConferencingDtmfConfiguration @@ -342,7 +347,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -365,4 +370,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsDialInConferencingDtmfConfiguration](New-CsDialInConferencingDtmfConfiguration.md) [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDialPlan.md b/skype/skype-ps/skype/Set-CsDialPlan.md index a2930d9244..f8e44ed1dd 100644 --- a/skype/skype-ps/skype/Set-CsDialPlan.md +++ b/skype/skype-ps/skype/Set-CsDialPlan.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDialPlan @@ -313,7 +318,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -348,4 +353,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsDirector.md b/skype/skype-ps/skype/Set-CsDirector.md index b958c6abb0..49d7fa107e 100644 --- a/skype/skype-ps/skype/Set-CsDirector.md +++ b/skype/skype-ps/skype/Set-CsDirector.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsDirector @@ -294,7 +299,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -313,4 +318,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsEdgeServer.md b/skype/skype-ps/skype/Set-CsEdgeServer.md index 11672813db..5f2b5044cf 100644 --- a/skype/skype-ps/skype/Set-CsEdgeServer.md +++ b/skype/skype-ps/skype/Set-CsEdgeServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsEdgeServer @@ -408,7 +413,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -427,4 +432,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md index 85b4c07d4e..25d66021cd 100644 --- a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsEnhancedEmergencyServiceDisclaimer @@ -30,7 +35,7 @@ Set-CsEnhancedEmergencyServiceDisclaimer [-Instance <PSObject>] [-Body <String>] ## DESCRIPTION In order for an Enterprise Voice implementation to provide E9-1-1 service, locations must be mapped to ports, subnets, switches and wireless access points to identify the caller's location. -When the caller is connecting from outside one of these mapped points, he must enter his location manually for it to be received by emergency services. +When the caller is connecting from outside one of these mapped points, they must enter their location manually for it to be received by emergency services. This cmdlet sets a text string that will be displayed to users who decide not to enter their location information. This message will be displayed only if the LocationRequired property of the user's location policy is set to Disclaimer. (You can retrieve location policy settings by calling the `Get-CsLocationPolicy` cmdlet.) @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -170,4 +175,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Loc [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) [Get-CsLocationPolicy](Get-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsExUmContact.md b/skype/skype-ps/skype/Set-CsExUmContact.md index a8ecb2cd41..aaee007975 100644 --- a/skype/skype-ps/skype/Set-CsExUmContact.md +++ b/skype/skype-ps/skype/Set-CsExUmContact.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsExUmContact @@ -285,7 +290,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -310,4 +315,3 @@ When the PassThru parameter is used, it also returns an object of this type. [Get-CsExUmContact](Get-CsExUmContact.md) [Move-CsExUmContact](Move-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md index 2846471ad1..7261e645e0 100644 --- a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md @@ -1,33 +1,39 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalaccesspolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsExternalAccessPolicy schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsExternalAccessPolicy ## SYNOPSIS +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter EnablePublicCloudAccess can no longer be used. + Enables you to modify the properties of an existing external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as MSN and 3) 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. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. +This cmdlet was introduced in Lync Server 2010. ## SYNTAX ### Identity (Default) ``` -Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] - [-EnableXmppAccess <Boolean>] [-EnablePublicCloudAccess <Boolean>] - [-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableOutsideAccess <Boolean>] [[-Identity] <XdsIdentity>] +Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-EnableAcsFederationAccess <Boolean>] + [-EnableXmppAccess <Boolean>] [-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableTeamsConsumerAccess <Boolean>] [-EnableTeamsConsumerInbound <Boolean>] [-EnableOutsideAccess <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ### Instance ``` -Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] - [-EnableXmppAccess <Boolean>] [-EnablePublicCloudAccess <Boolean>] - [-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableOutsideAccess <Boolean>] [-Instance <PSObject>] +Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-EnableAcsFederationAccess <Boolean>] + [-EnableXmppAccess <Boolean>] + [-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableTeamsConsumerAccess <Boolean>] [-EnableTeamsConsumerInbound <Boolean>] [-EnableOutsideAccess <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` @@ -39,24 +45,25 @@ That might be sufficient to meet your communication needs. If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. -Communicate with people who have SIP accounts with a public instant messaging service such as MSN. +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). -3. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + + 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. + After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. If you would like to grant this capability to all of your users you can call the `Set-CsExternalAccessPolicy` cmdlet and set the value of the global policy's EnableFederationAccess property to True. -The following parameters are not applicable to Skype for Business Online: AsJob, Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant - ## EXAMPLES ### -------------------------- Example 1 ------------------------ @@ -67,7 +74,6 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. - ### -------------------------- Example 2 ------------------------ ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True @@ -77,29 +83,31 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. - ### -------------------------- Example 3 ------------------------ ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` Example 3 enables federation access for all the external access policies that have been configured at the per-user scope. -To carry out this task, the first thing the command does is use the `Get-CsExternalAcessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. +To carry out this task, the first thing the command does is use the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. (The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. - ### -------------------------- Example 4 ------------------------ ``` -Get-CsExternalAccessPolicy | Where-Object {$_.EnablePublicCloudAccess -eq $True} | Set-CsExternalAccessPolicy -EnableFederationAccess $True +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false +New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $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. +In this example, the Global policy is updated to disallow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation enabled and which can be assigned to selected users for which Team-ACS federation will be allowed. + +### -------------------------- Example 5 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true +New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false +``` +In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. ## PARAMETERS @@ -116,7 +124,7 @@ Note that wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -132,7 +140,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi ```yaml Type: PSObject Parameter Sets: Instance -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -146,11 +154,10 @@ Accept wildcard characters: False Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. - ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -162,13 +169,13 @@ Accept wildcard characters: False ### -EnableFederationAccess Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. -The default value is False. - +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -178,20 +185,23 @@ 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. -The default value is False. +### -EnableAcsFederationAccess +Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. + +Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - +Aliases: +Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -201,11 +211,10 @@ Indicates whether the user is allowed to conduct audio/video conversations with When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -215,14 +224,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableTeamsConsumerAccess +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerInbound +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses the display of any non-fatal error message that might occur when running the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -235,7 +285,6 @@ Accept wildcard characters: False ### -WhatIf Describes what would happen if you executed the command without actually executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -252,7 +301,6 @@ Accept wildcard characters: False ### -Confirm Prompts you for confirmation before executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -270,11 +318,10 @@ Accept wildcard characters: False Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -288,11 +335,10 @@ Accept wildcard characters: False Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -312,7 +358,6 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` - ```yaml Type: Guid Parameter Sets: (All) @@ -327,7 +372,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -352,4 +397,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md index b48953ec5e..58dfe5fefc 100644 --- a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md @@ -1,14 +1,19 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsExternalUserCommunicationPolicy ## SYNOPSIS -{{Fill in the Synopsis}} +Modifies an existing external user communication policy for use in your organization to block P2P file transfer with Federated partners only. ## SYNTAX @@ -30,21 +35,22 @@ Set-CsExternalUserCommunicationPolicy [-Tenant <Guid>] [-EnableFileTransfer <Boo ## DESCRIPTION -The following parameters are not applicable to Skype for Business Online: AllowPresenceVisibility, AllowTitleVisibility, AsJob, EnableFileTransfer, Force, Identity, Instance, PipelineVariable, and Tenant +The following parameters are not applicable to Skype for Business Online: AllowPresenceVisibility, AllowTitleVisibility, EnableFileTransfer, Force, Identity, Instance, PipelineVariable, and Tenant ## EXAMPLES ### -------------------------- Example 1 ------------------------ ``` -PS C:\> {{ Add example code here }} +PS C:\> Set-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` -{{ Add example description here }} +This example modifies an existing policy to block external file transfer. + ## PARAMETERS ### -AllowPresenceVisibility -{{Fill AllowPresenceVisibility Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -60,7 +66,7 @@ Accept wildcard characters: False ``` ### -AllowTitleVisibility -{{Fill AllowTitleVisibility Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -92,7 +98,7 @@ Accept wildcard characters: False ``` ### -EnableFileTransfer -{{Fill EnableFileTransfer Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -108,7 +114,7 @@ Accept wildcard characters: False ``` ### -EnableP2PFileTransfer -{{Fill EnableP2PFileTransfer Description}} +Indicates whether file transfers to Federated partners are allowed. The default value is True. ```yaml Type: Boolean @@ -124,7 +130,7 @@ Accept wildcard characters: False ``` ### -Force -{{Fill Force Description}} +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 @@ -140,7 +146,7 @@ Accept wildcard characters: False ``` ### -Identity -{{Fill Identity Description}} +Unique identifier for the external user communication policy to be modified. ```yaml Type: XdsIdentity @@ -156,7 +162,7 @@ Accept wildcard characters: False ``` ### -Instance -{{Fill Instance Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: PSObject @@ -172,7 +178,8 @@ Accept wildcard characters: False ``` ### -Tenant -{{Fill Tenant Description}} +This parameter is reserved for internal Microsoft use. + ```yaml Type: Guid @@ -205,7 +212,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -218,4 +225,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md b/skype/skype-ps/skype/Set-CsFIPSConfiguration.md index e6d78339b9..609a96b73c 100644 --- a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/Set-CsFIPSConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsFIPSConfiguration @@ -29,7 +34,7 @@ Set-CsFIPSConfiguration [-Confirm] [-Force] [-Instance <PSObject>] [-RequireFIPS ## DESCRIPTION The Federal Information Processing Standards (FIPS) are a series of standards and guidelines used by computers engaged in work for the United States government; for example, there are FIPS standards that govern the use of such things as cryptography, encryption, and digital signatures. -(See http://www.itl.nist.gov/fipspubs/by-num.htm (http://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. +(See https://www.itl.nist.gov/fipspubs/by-num.htm (https://www.itl.nist.gov/fipspubs/by-num.htm) for more information.) Skype for Business Server provides an option that enables the software to use only algorithms that meet the FIPS standards. If you need to work with the United States government (or with other entities that follow FIPS) then you can enable FIPS compliance in Skype for Business Server. Keep in mind, however, that, for the on-premises version of Skype for Business Server, you have only a single, global collection of FIPS configuration settings: FIPS compliance can only be enabled or disabled for your entire Skype for Business Server implementation. @@ -188,7 +193,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -210,4 +215,3 @@ Instead, the `Set-CsFIPSConfiguration` cmdlet modifies existing instances of the [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md index d228f715a7..711fda67d7 100644 --- a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsFileTransferFilterConfiguration @@ -249,7 +254,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -272,4 +277,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md index 4af345f878..5b56d01e9e 100644 --- a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsGroupPickupUserOrbit @@ -38,7 +43,7 @@ In this case, the display name "Ken Myer". ### -Orbit Specifies the new group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see `New-CsCallParkOrbit` (https://technet.microsoft.com/en-us/library/gg398936.aspx). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). @@ -125,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +145,3 @@ This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.Gr ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md index 9b420af4f1..6ad6748d7f 100644 --- a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsHealthMonitoringConfiguration @@ -239,7 +244,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -262,4 +267,3 @@ Instead, the `Set-CsHealthMonitoringConfiguration` cmdlet modifies existing inst [New-CsHealthMonitoringConfiguration](New-CsHealthMonitoringConfiguration.md) [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md index d4cacaea66..812ec3758b 100644 --- a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsHostedVoicemailPolicy @@ -134,7 +139,6 @@ If you attempt to enable a user for hosted voice mail and the user's assigned po This value must be 255 characters or less and in a format matching the regular expression string ^\[a-zA-Z0-9\-_\]+(\.\[a-zA-Z0-9\-_\]+){0,}$. This just means it should be in the form of an FQDN, such as server.litwareinc.com. - ```yaml Type: String Parameter Sets: (All) @@ -152,7 +156,6 @@ Accept wildcard characters: False 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: String Parameter Sets: (All) @@ -224,7 +227,8 @@ You can return the tenant ID for each of your tenants by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - +> [!NOTE] +> In Skype for Business Server 2019, you can notice that you can use -TenantID in the same way as this parameter. ```yaml Type: Guid @@ -240,7 +244,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -264,4 +268,3 @@ This cmdlet modifies an object of type Microsoft.Rtc.Management.WritableConfig.P [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsHostingProvider.md b/skype/skype-ps/skype/Set-CsHostingProvider.md index 0bee5f5cc1..0e74e387f7 100644 --- a/skype/skype-ps/skype/Set-CsHostingProvider.md +++ b/skype/skype-ps/skype/Set-CsHostingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsHostingProvider @@ -311,7 +316,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -338,4 +343,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsHostingProvider](New-CsHostingProvider.md) [Remove-CsHostingProvider](Remove-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsHuntGroup.md b/skype/skype-ps/skype/Set-CsHuntGroup.md deleted file mode 100644 index e4a817408e..0000000000 --- a/skype/skype-ps/skype/Set-CsHuntGroup.md +++ /dev/null @@ -1,505 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Set-CsHuntGroup -schema: 2.0.0 ---- - -# Set-CsHuntGroup - -## SYNOPSIS -Updates a Call Queue in your Skype for Business Online organization. - -## SYNTAX - -``` -Set-CsHuntGroup -PrimaryUri <System.Uri> [-AgentAlertTime <Int16>] [-AllowOptOut <System.Boolean>] [-DistributionLists <System.Collections.Generic.List`1[System.Guid]>] [-LineUri <System.Uri>] - [-MusicOnHoldFileContent <System.Byte[]>] [-MusicOnHoldFileName <System.String>] [-Name <System.String>] - [-OverflowAction <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.OverflowAction>] [-OverflowActionTarget <System.Uri>] [-OverflowThreshold <Int16>] - [-RoutingMethod <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.RoutingMethod>] [-TimeoutAction <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.TimeoutAction>] - [-TimeoutActionTarget <System.Uri>] [-TimeoutThreshold <Int16>] [-UseDefaultMusicOnHold <System.Boolean>] [-WelcomeMusicFileContent <System.Byte[]>] - [-WelcomeMusicFileName <System.String>] [<CommonParameters>] -``` - -## DESCRIPTION - -Set-CsHuntGroup cmdlet provides a way for you to modify the properties of an existing Call Queue; for example, you can change the phone number for the Call Queue, the distribution lists associated with the Call Queue, or the welcome audio file. - -The Set-CsHuntGroup cmdlet may suggest additional steps required to complete the Call Queue setup. - -The following parameters are not applicable to Skype for Business Online: AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, and PipelineVariable - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" -UseDefaultMusicOnHold $true -``` - -This example updates the Call Queue with primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" by making it use the default music on hold. - -### -------------------------- Example 2 -------------------------- -``` -$musicOnHoldContent = Get-Content ".\MusicOnHold.wav" -ReadCount 0 -Encoding Byte -Set-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" -LineUri "tel:+19998881234" -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldFileName "MusicOnHold.wav" -MusicOnHoldFileContent $musicOnHoldContent -``` - -This example saves the contents of music on hold to a temporary variable. Then, it updates the Call Queue with new phone number, distribution lists, and the name and content of the music on hold file. - - -## PARAMETERS - -### -PrimaryUri -The PrimaryUri parameter represents the SIP address for the Call Queue. It must start with "sip:". - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentAlertTime -The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 30 and 180 seconds (3 minutes), inclusive. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 30 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOptOut -The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. - -```yaml -Type: System.Collections.Generic.List`1[System.Guid] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LineUri -The LineUri parameter is the phone number for the Call Queue. 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". - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldFileContent -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the content of the audio file. Supported formats are: .wav, .mp3, and .wma. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldFileName -The MusicOnHoldFileName parameter represents music to play when callers are placed on hold. This is the name of the audio file. Supported formats are: .wav, .mp3, and .wma. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies a unique name for the Call Queue. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 three values: DisconnectWithBusy, Forward, and Voicemail. - -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail - -```yaml -Type: Microsoft.Rtc.Management.Hosted.HuntGroup.Models.OverflowAction -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: DisconnectWithBusy -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a SIP address. Otherwise, this parameter is optional. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 50 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. - -PARAMVALUE: Attendant | Serial - -```yaml -Type: Microsoft.Rtc.Management.Hosted.HuntGroup.Models.RoutingMethod -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Attendant -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following three values: Disconnect, Forward, and Voicemail. The default value is Disconnect. - -PARAMVALUE: Disconnect | Forward | Voicemail - -```yaml -Type: Microsoft.Rtc.Management.Hosted.HuntGroup.Models.TimeoutAction -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Disconnect -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a SIP address. Otherwise, this field is optional. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 1200 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldFileName and MusicOnHoldFileContent. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeMusicFileContent -The WelcomeMusicFileContent parameter represents the audio file to play when callers are connected with the Call Queue. This is the content of the audio file. Supported formats are: .wav, .mp3, .and wma. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeMusicFileName -The WelcomeMusicFileName parameter represents audio file to play when callers are connected with the Call Queue. This is the name to the audio file. Supported formats are: .wav, .mp3, and .wma. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassDualWrite -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAudience -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for Microsoft internal use only. - -PARAMVALUE: Fqdn - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HuntGroupServiceCallbackUri -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. This parameter is reserved for Microsoft internal use only. - -```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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.HuntGroup.Models.HuntGroup - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md index 7b5bd74c35..33c98d57dc 100644 --- a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsHybridApplicationEndpoint @@ -18,7 +23,7 @@ Set-CsHybridApplicationEndpoint [-Identity] <HybridApplicationEndpointIdParamete ``` ## DESCRIPTION -The `Set-CsHybridApplicationEndpoint` cmdlet enables you to modify the Skype for Business Server related hybrid application endpoint attributes that are stored in Active Directory Domain Services. For example, you can modify an enpoint's line URI number; or modify an enpoint's display name. +The `Set-CsHybridApplicationEndpoint` cmdlet enables you to modify the Skype for Business Server related hybrid application endpoint attributes that are stored in Active Directory Domain Services. For example, you can modify an endpoint's line URI number; or modify an endpoint's display name. ## EXAMPLES @@ -145,7 +150,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -159,8 +164,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsHybridMediationServer.md b/skype/skype-ps/skype/Set-CsHybridMediationServer.md index 8c7a9cee04..22cc44dca7 100644 --- a/skype/skype-ps/skype/Set-CsHybridMediationServer.md +++ b/skype/skype-ps/skype/Set-CsHybridMediationServer.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsHybridMediationServer @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Sets the external FQDN of an Edge server access proxy as the hosting provider for a user. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -142,7 +149,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -153,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsHybridMediationServer](Get-CsHybridMediationServer.md) - diff --git a/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md index 4534f21425..b3f6d8058f 100644 --- a/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsHybridPSTNAppliance @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the `Set-CsHybridPSTNAppliance` cmdlet to modify an existing Skype for Business Cloud Connector Edition appliance's attributes. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -180,7 +187,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -189,4 +196,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsHybridPSTNSite.md b/skype/skype-ps/skype/Set-CsHybridPSTNSite.md index 74d8ca7cd1..9cc149848a 100644 --- a/skype/skype-ps/skype/Set-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Set-CsHybridPSTNSite.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsHybridPSTNSite @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the `Set-CsHybridPSTNSite` cmdlet to modify an existing hybrid public switched telephone network (PSTN) site's attributes. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -221,7 +228,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -236,4 +243,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsIPPhonePolicy.md b/skype/skype-ps/skype/Set-CsIPPhonePolicy.md index f6cd85a6ad..944e00aac7 100644 --- a/skype/skype-ps/skype/Set-CsIPPhonePolicy.md +++ b/skype/skype-ps/skype/Set-CsIPPhonePolicy.md @@ -1,14 +1,19 @@ --- -external help file: -applicable: Skype for Business Online +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsIPPhonePolicy ## SYNOPSIS -Use the Set-CsIPPhonePolicy cmdlet to modify the settings of the Skype for Business Online global IP phone policy. IP phone policies define the Skype for Business Online features that are available to users. +Use the Set-CsIPPhonePolicy cmdlet to modify the settings of the Skype for Business Online and Skype for Business Server 2019 global IP phone policy. IP phone policies define the Skype for Business features that are available to users. ## SYNTAX @@ -56,22 +61,24 @@ This example modifies the global IP phone policy UserDialTimeoutMS parameter to Set-CsIPPhonePolicy -EnablePowerSaveMode $False -EnableOneTouchVoicemail $False -EnableDeviceUpdate $False ``` -This example sets the EnablePowerSaveModeproperty, EnableOneTouchVoicemailvalues, and EnableDeviceUpdate parameters to $false. +This example sets the EnablePowerSaveMode, EnableOneTouchVoicemail and EnableDeviceUpdate parameters to $false. ## PARAMETERS ### -BetterTogetherOverEthernetPairingMode -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. +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. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named -Default value: None +Default value: Manual Accept pipeline input: False Accept wildcard characters: False ``` @@ -83,7 +90,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -99,7 +106,7 @@ Specifies the time format to be used. The acceptable values are "24" for a 24 ho Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -109,13 +116,13 @@ Accept wildcard characters: False ``` ### -EnableBetterTogetherOverEthernet -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 Online. The default is $true. +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 +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -125,13 +132,13 @@ Accept wildcard characters: False ``` ### -EnableDeviceUpdate -Specifies whether the IP device will be updated by the Skype for Business Online 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. +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 +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -141,13 +148,13 @@ Accept wildcard characters: False ``` ### -EnableExchangeCalendaring -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 enabled to connect to their calendars. The default is $true. +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 +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -163,7 +170,7 @@ Specifies whether the Visual Voicemail feature in Skype for Business Online is e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -173,13 +180,13 @@ Accept wildcard characters: False ``` ### -EnablePowerSaveMode -If enabled, phone goes to power savings mode (display turns off) based on values of the PowerSaveDuringOfficeHoursTimeoutMS and PowerSavePostOfficeHoursTimeoutMS parameters. +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 +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -195,7 +202,7 @@ The Force switch specifies whether to suppress warning and confirmation messages Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -211,7 +218,7 @@ This parameter is reserved for internal Microsoft use. Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: 1 @@ -227,7 +234,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -243,7 +250,7 @@ Specifies the maximum number of retries allowed for phone unlock. The default is Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -259,7 +266,7 @@ Specifies the address of the provisioning server for your organization. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -275,7 +282,7 @@ Specifies the password for the provisioning server. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -291,7 +298,7 @@ Specifies the server type for the phone. The default is FTP. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -307,7 +314,7 @@ Specifies a username for the provisioning server. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -323,7 +330,7 @@ Specifies the time in milliseconds to wait during office hours before turning on Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -339,7 +346,7 @@ Specifies the time in milliseconds to wait after office hours before turning on Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -355,7 +362,7 @@ Specifies the order in which to prioritize codecs. The default is: "G722_8000;PC Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -371,7 +378,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -381,13 +388,13 @@ 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. +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 +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -405,7 +412,7 @@ The WhatIf switch causes the command to simulate its results. By using this swit Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -415,7 +422,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -427,9 +434,8 @@ Microsoft.Rtc.Management.ADConnect.Schema.ADUser ## OUTPUTS ### System.Object -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. +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 ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsImConfiguration.md b/skype/skype-ps/skype/Set-CsImConfiguration.md index ff989cf12a..d086c199eb 100644 --- a/skype/skype-ps/skype/Set-CsImConfiguration.md +++ b/skype/skype-ps/skype/Set-CsImConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsImConfiguration @@ -151,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -164,8 +169,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsImFilterConfiguration.md b/skype/skype-ps/skype/Set-CsImFilterConfiguration.md index 1119fbb763..cbe1b6db70 100644 --- a/skype/skype-ps/skype/Set-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/Set-CsImFilterConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsImFilterConfiguration @@ -306,7 +311,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -329,4 +334,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsImFilterConfiguration](Remove-CsImFilterConfiguration.md) [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md b/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md index f2acaaa535..4b9375f9fb 100644 --- a/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsImTranslationConfiguration @@ -218,7 +223,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -227,4 +232,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md index e8432bc573..2805bab96e 100644 --- a/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsKerberosAccountAssignment @@ -161,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -186,4 +191,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md b/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md index ad5c22de7d..53c7a9e3e7 100644 --- a/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md +++ b/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsKerberosAccountPassword @@ -182,7 +187,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -198,4 +203,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsLisLocation.md b/skype/skype-ps/skype/Set-CsLisLocation.md index c64671fa6f..61ea6408ff 100644 --- a/skype/skype-ps/skype/Set-CsLisLocation.md +++ b/skype/skype-ps/skype/Set-CsLisLocation.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLisLocation @@ -553,7 +558,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -583,4 +588,3 @@ It creates or modifies an object of type System.Management.Automation.PSCustomOb [Set-CsLisWirelessAccessPoint](Set-CsLisWirelessAccessPoint.md) [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Set-CsLisPort.md b/skype/skype-ps/skype/Set-CsLisPort.md index 46085f9c3c..62814d4f3e 100644 --- a/skype/skype-ps/skype/Set-CsLisPort.md +++ b/skype/skype-ps/skype/Set-CsLisPort.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLisPort @@ -601,7 +606,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -624,4 +629,3 @@ This cmdlet creates or modifies an object of type System.Management.Automation.P [Get-CsLisLocation](Get-CsLisLocation.md) [Get-CsLisSwitch](Get-CsLisSwitch.md) - diff --git a/skype/skype-ps/skype/Set-CsLisServiceProvider.md b/skype/skype-ps/skype/Set-CsLisServiceProvider.md index cb3b0c372c..135b7b925b 100644 --- a/skype/skype-ps/skype/Set-CsLisServiceProvider.md +++ b/skype/skype-ps/skype/Set-CsLisServiceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLisServiceProvider @@ -157,7 +162,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -176,4 +181,3 @@ This cmdlet creates or modifies an object of type System.Management.Automation.P [Remove-CsLisServiceProvider](Remove-CsLisServiceProvider.md) [Get-CsLisServiceProvider](Get-CsLisServiceProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsLisSubnet.md b/skype/skype-ps/skype/Set-CsLisSubnet.md index ceca2485c4..d8f243e8d0 100644 --- a/skype/skype-ps/skype/Set-CsLisSubnet.md +++ b/skype/skype-ps/skype/Set-CsLisSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLisSubnet @@ -522,7 +527,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -543,4 +548,3 @@ This cmdlet creates or modifies an object of type System.Management.Automation.P [Get-CsLisSubnet](Get-CsLisSubnet.md) [Get-CsLisLocation](Get-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Set-CsLisSwitch.md b/skype/skype-ps/skype/Set-CsLisSwitch.md index 71e762e954..13f563aa57 100644 --- a/skype/skype-ps/skype/Set-CsLisSwitch.md +++ b/skype/skype-ps/skype/Set-CsLisSwitch.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLisSwitch @@ -539,7 +544,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -564,4 +569,3 @@ This cmdlet creates or modifies an object of type System.Management.Automation.P [Set-CsLisPort](Set-CsLisPort.md) [Get-CsLisPort](Get-CsLisPort.md) - diff --git a/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md b/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md index 4384d57777..31b0d854db 100644 --- a/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLisWirelessAccessPoint @@ -534,7 +539,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -555,4 +560,3 @@ This cmdlet creates or modifies an object of type System.Management.Automation.P [Get-CsLisWirelessAccessPoint](Get-CsLisWirelessAccessPoint.md) [Get-CsLisLocation](Get-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Set-CsLocationPolicy.md b/skype/skype-ps/skype/Set-CsLocationPolicy.md index 1f953d85fe..6586f63b11 100644 --- a/skype/skype-ps/skype/Set-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Set-CsLocationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsLocationPolicy @@ -446,7 +451,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -477,4 +482,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Set-CsManagementConnection.md b/skype/skype-ps/skype/Set-CsManagementConnection.md index 2f06b1f27d..66a2a17e21 100644 --- a/skype/skype-ps/skype/Set-CsManagementConnection.md +++ b/skype/skype-ps/skype/Set-CsManagementConnection.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsManagementConnection @@ -160,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -183,4 +188,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Store.S [Remove-CsManagementConnection](Remove-CsManagementConnection.md) [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Set-CsManagementServer.md b/skype/skype-ps/skype/Set-CsManagementServer.md index b9c6d9e7c4..0d77658545 100644 --- a/skype/skype-ps/skype/Set-CsManagementServer.md +++ b/skype/skype-ps/skype/Set-CsManagementServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsManagementServer @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -144,4 +149,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsService](Get-CsService.md) [Move-CsManagementServer](Move-CsManagementServer.md) - diff --git a/skype/skype-ps/skype/Set-CsMcxConfiguration.md b/skype/skype-ps/skype/Set-CsMcxConfiguration.md index 8bc1f3f36f..664b12f04d 100644 --- a/skype/skype-ps/skype/Set-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/Set-CsMcxConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Set-CsMcxConfiguration @@ -258,7 +263,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -275,4 +280,3 @@ Instead, the `Set-CsMcxConfiguration` cmdlet modifies existing instances of the ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsMediaConfiguration.md b/skype/skype-ps/skype/Set-CsMediaConfiguration.md index 56ef9fcd46..17f1f8b8b8 100644 --- a/skype/skype-ps/skype/Set-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/Set-CsMediaConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsMediaConfiguration @@ -20,7 +25,8 @@ Set-CsMediaConfiguration [[-Identity] <XdsIdentity>] [-EnableQoS <Boolean>] [-En [-EncryptionLevel <EncryptionLevel>] [-MaxVideoRateAllowed <MaxVideoRateAllowed>] [-Force] [-WhatIf] [-Confirm] [-EnableAdaptiveBandWidthEstimation <Boolean>] [-EnableG722StereoCodec <Boolean>] [-EnableH264Codec <Boolean>] [-EnableInCallQoS <Boolean>] [-EnableRtpRtcpMultiplexing <Boolean>] - [-InCallQoSIntervalSeconds <UInt16>] [-EnableVideoBasedSharing <Boolean>] [<CommonParameters>] + [-InCallQoSIntervalSeconds <UInt16>] [-EnableVideoBasedSharing <Boolean>] [-EnableDtls <Boolean>] [-EnableSilkForAudioVideoConferences <Boolean>] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx <Boolean>] [-EnableAVBundling <Boolean>] [-EnableReceiveAgc <Boolean>] + [<CommonParameters>] ``` ### Instance @@ -29,7 +35,8 @@ Set-CsMediaConfiguration [-Instance <PSObject>] [-EnableQoS <Boolean>] [-EnableS [-EncryptionLevel <EncryptionLevel>] [-MaxVideoRateAllowed <MaxVideoRateAllowed>] [-Force] [-WhatIf] [-Confirm] [-EnableAdaptiveBandWidthEstimation <Boolean>] [-EnableG722StereoCodec <Boolean>] [-EnableH264Codec <Boolean>] [-EnableInCallQoS <Boolean>] [-EnableRtpRtcpMultiplexing <Boolean>] - [-InCallQoSIntervalSeconds <UInt16>] [-EnableVideoBasedSharing <Boolean>] [<CommonParameters>] + [-InCallQoSIntervalSeconds <UInt16>] [-EnableVideoBasedSharing <Boolean>] [-EnableDtls <Boolean>] [-EnableSilkForAudioVideoConferences <Boolean>] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx <Boolean>] [-EnableAVBundling <Boolean>] [-EnableReceiveAgc <Boolean>] + [<CommonParameters>] ``` ## DESCRIPTION @@ -39,7 +46,8 @@ These actions relate to audio and video calls between client endpoints. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 + ``` Set-CsMediaConfiguration -Identity site:Redmond1 -MaxVideoRateAllowed hd720p15m ``` @@ -49,7 +57,8 @@ Note that the value passed to the MaxVideoRateAllowed parameter must be one of t Also note that the values are not case sensitive; the value entered here as hd720p15m will be automatically converted to the appropriate casing (in this instance, to Hd720p15M). -### -------------------------- Example 2 -------------------------- +### Example 2 + ``` Set-CsMediaConfiguration site:Redmond1 -EncryptionLevel donotsupportencryption ``` @@ -97,9 +106,7 @@ Accept wildcard characters: False ``` ### -EnableQoS -QoS monitors the quality of voice signals over a network. -The EnableIncallQoS attribute enables or disables the ability of Skype for Business clients to send the raw data that's required to generate IncallQuality messages. - +QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. ```yaml Type: Boolean @@ -241,7 +248,7 @@ 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 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: Boolean @@ -291,7 +298,7 @@ Accept wildcard characters: False ``` ### -EnableInCallQoS -PARAMVALUE: $true | $false +Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. ```yaml Type: Boolean @@ -307,7 +314,7 @@ Accept wildcard characters: False ``` ### -EnableRtpRtcpMultiplexing -PARAMVALUE: $true | $false +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: Boolean @@ -317,13 +324,13 @@ Applicable: 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 ``` ### -InCallQoSIntervalSeconds -PARAMVALUE: UInt16 +Specifies the interval between call QoS actions. ```yaml Type: UInt16 @@ -339,7 +346,7 @@ Accept wildcard characters: False ``` ### -EnableVideoBasedSharing -{{Fill EnableVideoBasedSharing Description}} +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 @@ -354,8 +361,117 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableDtls +Enables the use of Datagram Transport Layer Security (DTLS) for ICE + +```yaml +Type: Boolean +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 +``` + +### -EnableSilkForAudioVideoConferences +Enables the use of SILK codec for A/V conferences + +```yaml +Type: Boolean +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 +``` + +### -EnableServerFecForVideoInterop +Enables the use of server Forward Error Correction for video interoperability + +```yaml +Type: Boolean +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 +``` + +### -WaitIceCompletedToAddDialOutUser +Waits until ICE negotiation is complete to dial out other people + +```yaml +Type: Boolean +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 +``` + +### -EnableRtx +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAVBundling +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableReceiveAgc +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -378,4 +494,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsMediaConfiguration](Remove-CsMediaConfiguration.md) [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsMediationServer.md b/skype/skype-ps/skype/Set-CsMediationServer.md index e82cdd3aa6..35d51973bb 100644 --- a/skype/skype-ps/skype/Set-CsMediationServer.md +++ b/skype/skype-ps/skype/Set-CsMediationServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsMediationServer @@ -256,7 +261,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -275,4 +280,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsMeetingConfiguration.md b/skype/skype-ps/skype/Set-CsMeetingConfiguration.md index bd15d4cad0..3e3103f124 100644 --- a/skype/skype-ps/skype/Set-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsMeetingConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsMeetingConfiguration @@ -120,11 +125,7 @@ Accept wildcard characters: False ``` ### -AdmitAnonymousUsersByDefault -Determines whether meetings will, by default, allow attendance by anonymous users (that is, by unauthenticated users) or by federated users (authenticated users from other tenants). -Set this value to True if you would like new meetings to allow for attendance by anonymous users or federated 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 or federated users. When set to False, anonymous and federated users will be placed in the lobby of a meeting when trying to join it. After being placed in the lobby, they can be admitted by any presenter in the meeting. -When this value is changed, the change will only apply to new meetings and it will not applied to meetings already scheduled. -The default value is True. +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: Boolean @@ -171,12 +172,14 @@ Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype Required: False Position: Named -Default value: None +Default value: Company Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableAssignedConferenceType +This parameter is not available in Skype for Business Online. + 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. @@ -186,7 +189,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -438,7 +441,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Set-CsMeetingRoom.md b/skype/skype-ps/skype/Set-CsMeetingRoom.md index f5baab68a9..c7bc7a6973 100644 --- a/skype/skype-ps/skype/Set-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Set-CsMeetingRoom.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsMeetingRoom @@ -12,6 +17,8 @@ Modifies the property values of an existing Skype for Business Server meeting ro A meeting room is a conferencing device designed to address video conferencing and collaboration scenarios in small conference rooms. This cmdlet was introduced in Lync Server 2013. +**Note**: This cmdlet is not supported for managing Microsoft Teams Rooms. You must use the methods described in the [Microsoft Teams Rooms](/microsoftteams/rooms) documentation to manage Microsoft Teams Rooms. + ## SYNTAX @@ -21,7 +28,7 @@ Set-CsMeetingRoom [-Identity] <UserIdParameter> [-AudioVideoDisabled <Boolean>] [-Confirm] [-DomainController <Fqdn>] [-Enabled <Boolean>] [-EnterpriseVoiceEnabled <Boolean>] [-ExchangeArchivingPolicy <ExchangeArchivingPolicyOptionsEnum>] [-HostedVoiceMail <Boolean>] [-LineServerURI <String>] [-LineURI <String>] [-PassThru] [-PrivateLine <String>] - [-RemoteCallControlTelephonyEnabled <Boolean>] [-SipAddress <String>] [-WhatIf] [-AsJob] [<CommonParameters>] + [-RemoteCallControlTelephonyEnabled <Boolean>] [-SipAddress <String>] [-WhatIf] [<CommonParameters>] ``` ## DESCRIPTION @@ -419,24 +426,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -460,4 +451,3 @@ Instead, the `Set-CsMeetingRoom` cmdlet modifies existing instances of the Micro [Get-CsMeetingRoom](Get-CsMeetingRoom.md) [Move-CsMeetingRoom](Move-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Set-CsMobilityPolicy.md b/skype/skype-ps/skype/Set-CsMobilityPolicy.md index ae1f07cf30..b159325592 100644 --- a/skype/skype-ps/skype/Set-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Set-CsMobilityPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsMobilityPolicy @@ -63,7 +68,7 @@ In turn, that means that the user will not be able to use Call via Work, regardl To use Call via Work, users must be managed by a voice policy that allows simultaneous ringing. -The following parameters are not applicable to Skype for Business Online: AllowAutomaticPstnFallback, AllowCustomerExperienceImprovementProgram, AllowExchangeConnectivity, AllowSaveCallLogs, AsJob, Description, EncryptAppData, Force, Identity, Instance, PipelineVariable, RequireIntune, Tenant, VoiceSettings +The following parameters are not applicable to Skype for Business Online: AllowAutomaticPstnFallback, AllowCustomerExperienceImprovementProgram, AllowExchangeConnectivity, AllowSaveCallLogs, Description, EncryptAppData, Force, Identity, Instance, PipelineVariable, RequireIntune, Tenant, VoiceSettings ## EXAMPLES @@ -91,7 +96,7 @@ That filtered collection of policies is then piped to the `Set-CsMobilityPolicy` Get-CsMobilityPolicy | Where-Object {$_.Description -eq $Null} | Set-CsMobilityPolicy -Description "Policy owner: kenmyer@litwareinc.com" ``` -In Example 3, a new description is added to any mobility policy property that does not currently have a description. +In Example 3, a new description is added to any mobility policy that does not currently have a description. To do this, the first uses the `Get-CsMobilityPolicy` cmdlet to return a collection of all the mobility policies currently in use in the organization. This collection is then piped to the `Where-Object` cmdlet, which selects only those policies where the Description property is equal to (-eq) a null value. That filtered collection is then piped to the `Set-CsMobilityPolicy` cmdlet, which sets the Description property for each policy to the string value "Policy owner: kenmyer@litwareinc.com". @@ -256,7 +261,7 @@ 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 WiFi network. +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. @@ -277,9 +282,9 @@ Accept wildcard characters: False ``` ### -RequireWIFIForIPVideo -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. +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. @@ -315,7 +320,7 @@ Accept wildcard characters: False ``` ### -AllowAutomaticPstnFallback -{{Fill AllowAutomaticPstnFallback Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -348,7 +353,9 @@ Accept wildcard characters: False ``` ### -AllowDeviceContactsSync -{{Fill AllowDeviceContactsSync Description}} +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 @@ -403,6 +410,9 @@ Accept wildcard characters: False 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: Boolean @@ -435,7 +445,7 @@ Accept wildcard characters: False ``` ### -EnablePushNotifications -{{Fill EnablePushNotifications Description}} +When set to True users will be allowed to receive push notifications on their mobile devices. ```yaml Type: Boolean @@ -451,7 +461,7 @@ Accept wildcard characters: False ``` ### -EncryptAppData -{{Fill EncryptAppData Description}} +When set to True users will be allowed to encrypt data on their mobile apps. ```yaml Type: Boolean @@ -467,13 +477,13 @@ Accept wildcard characters: False ``` ### -RequireIntune -{{Fill RequireIntune Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -483,11 +493,11 @@ Accept wildcard characters: False ``` ### -RequireWiFiForSharing -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. +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. -If this value is set to True, then users then users will not be able to change their sharing configuration settings. -If this value is set to False users can use the Options page to modify their sharing configuration settings. +If this value is set to True, users will not be able to change their sharing configuration settings. +If this value is set to False, users can use the Options page to modify their sharing configuration settings. ```yaml @@ -530,9 +540,9 @@ 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: -**VoIPAlways:** WiFi will be used when available, otherwise a call back will be performed. +**VoIPAlways:** Wi-Fi will be used when available, otherwise a call back will be performed. -**VoIPOverWiFi:** If WiFi is not available, a call back to the pre-defined phone number will be performed. +**VoIPOverWiFi:** If Wi-Fi is not available, a call back to the pre-defined phone number will be performed. **Cellular:** Always perform a call back to the pre-defined phone number. @@ -550,7 +560,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -567,4 +577,3 @@ Instead, the `Set-CsMobilityPolicy` cmdlet modifies existing instances of the Mi ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsMonitoringServer.md b/skype/skype-ps/skype/Set-CsMonitoringServer.md index 90ff6ef39d..4906331044 100644 --- a/skype/skype-ps/skype/Set-CsMonitoringServer.md +++ b/skype/skype-ps/skype/Set-CsMonitoringServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsMonitoringServer @@ -152,7 +157,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -171,4 +176,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md index d221a0a8bb..dffaff9982 100644 --- a/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkBandwidthPolicyProfile @@ -340,7 +345,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -365,4 +370,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) [New-CsNetworkBWPolicy](New-CsNetworkBWPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkConfiguration.md b/skype/skype-ps/skype/Set-CsNetworkConfiguration.md index 56ab2921d3..c57f41a6da 100644 --- a/skype/skype-ps/skype/Set-CsNetworkConfiguration.md +++ b/skype/skype-ps/skype/Set-CsNetworkConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsNetworkConfiguration @@ -51,7 +56,7 @@ If at any point in the validation you choose to stop validation (by typing N at If EnableBandwidthPolicyCheck is already set to True, you can call the `Set-CsNetworkConfiguration` cmdlet and pass a value of True to the parameter EnableBandwidthPolicyCheck to run the validation without modifying any settings. In addition, when EnableBandwidthPolicyCheck is True, any changes you attempt to make by calling the `Set-CsNetworkConfiguration` cmdlet will again cause the validation check to run. -The following parameters are not applicable to Skype for Business Online: AsJob, BWPolicyProfiles, EnableBandwidthPolicyCheck, Force, Identity, Instance, InterNetworkRegionRoutes, InterNetworkSitePolicies, NetworkRegionLinks, NetworkRegions, NetworkSites, PipelineVariable, Subnets, and Tenant +The following parameters are not applicable to Skype for Business Online: BWPolicyProfiles, EnableBandwidthPolicyCheck, Force, Identity, Instance, InterNetworkRegionRoutes, InterNetworkSitePolicies, NetworkRegionLinks, NetworkRegions, NetworkSites, PipelineVariable, Subnets, and Tenant ## EXAMPLES @@ -342,7 +347,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -379,4 +384,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableC [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) [New-CsNetworkMediaBypassConfiguration](New-CsNetworkMediaBypassConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md index 175e9586df..2c6e2a913f 100644 --- a/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkInterRegionRoute @@ -225,7 +230,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -248,4 +253,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Remove-CsNetworkInterRegionRoute](Remove-CsNetworkInterRegionRoute.md) [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md index dc4d07bde9..549ddcf054 100644 --- a/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkInterSitePolicy @@ -181,7 +186,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -204,4 +209,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Remove-CsNetworkInterSitePolicy](Remove-CsNetworkInterSitePolicy.md) [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkRegion.md b/skype/skype-ps/skype/Set-CsNetworkRegion.md index 9d3eac41f3..5262233618 100644 --- a/skype/skype-ps/skype/Set-CsNetworkRegion.md +++ b/skype/skype-ps/skype/Set-CsNetworkRegion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkRegion @@ -291,7 +296,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -316,4 +321,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Get-CsNetworkRegion](Get-CsNetworkRegion.md) [New-CsNetworkBWAlternatePath](New-CsNetworkBWAlternatePath.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkRegionLink.md b/skype/skype-ps/skype/Set-CsNetworkRegionLink.md index 91694bc086..c56b65a75a 100644 --- a/skype/skype-ps/skype/Set-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/Set-CsNetworkRegionLink.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkRegionLink @@ -180,7 +185,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -205,5 +210,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Get-CsNetworkRegionLink](Get-CsNetworkRegionLink.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - - diff --git a/skype/skype-ps/skype/Set-CsNetworkSite.md b/skype/skype-ps/skype/Set-CsNetworkSite.md index b23365adf0..92a478becd 100644 --- a/skype/skype-ps/skype/Set-CsNetworkSite.md +++ b/skype/skype-ps/skype/Set-CsNetworkSite.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkSite @@ -286,7 +291,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -317,4 +322,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Get-CsLocationPolicy](Get-CsLocationPolicy.md) [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsNetworkSubnet.md b/skype/skype-ps/skype/Set-CsNetworkSubnet.md index 403e1078fb..c12c29f142 100644 --- a/skype/skype-ps/skype/Set-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/Set-CsNetworkSubnet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsNetworkSubnet @@ -192,7 +197,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -215,4 +220,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.N [Remove-CsNetworkSubnet](Remove-CsNetworkSubnet.md) [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) - diff --git a/skype/skype-ps/skype/Set-CsOAuthConfiguration.md b/skype/skype-ps/skype/Set-CsOAuthConfiguration.md index c66dbe978e..ad81bf71a0 100644 --- a/skype/skype-ps/skype/Set-CsOAuthConfiguration.md +++ b/skype/skype-ps/skype/Set-CsOAuthConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsOAuthConfiguration @@ -41,7 +46,7 @@ Each Skype for Business Online tenant is also limited to a single collection of Skype for Business Server Control Panel: The functions carried out by the `Set-CsOAuthConfiguration` cmdlet are not available in the Skype for Business Server Control Panel. -The following parameters are not applicable to Skype for Business Online: AdditionalAudienceUrls, AlternateAudienceUrl, AsJob, ClientAuthorizationOAuthServerIdentity, ExchangeAutodiscoverAllowedDomains, ExchangeAutodiscoverUrl, Force, Identity, Instance, PipelineVariable, Realm, ServiceName, and Tenant +The following parameters are not applicable to Skype for Business Online: AdditionalAudienceUrls, AlternateAudienceUrl, ClientAuthorizationOAuthServerIdentity, ExchangeAutodiscoverAllowedDomains, ExchangeAutodiscoverUrl, Force, Identity, Instance, PipelineVariable, Realm, ServiceName, and Tenant ## EXAMPLES @@ -77,7 +82,7 @@ Accept wildcard characters: False Collection of domains that autodiscover requests can be redirected to. For example: -`-ExchangeAutodiscoverAllowedDomains "*.contoso.com","*.fabrikam.com"` +`-ExchangeAutodiscoverAllowedDomains "*.contoso.com;*.fabrikam.com"` ```yaml @@ -240,7 +245,7 @@ Accept wildcard characters: False ``` ### -AdditionalAudienceUrls -{{Fill AdditionalAudienceUrls Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -256,7 +261,7 @@ Accept wildcard characters: False ``` ### -AlternateAudienceUrl -{{Fill AlternateAudienceUrl Description}} +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -272,7 +277,15 @@ Accept wildcard characters: False ``` ### -ClientAdalAuthOverride -{{Fill ClientAdalAuthOverride Description}} +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 @@ -306,7 +319,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -324,4 +337,3 @@ Instead, the `Set-CsOAuthConfiguration` cmdlet modifies existing instances of th ## RELATED LINKS [Get-CsOAuthConfiguration](Get-CsOAuthConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsOAuthServer.md b/skype/skype-ps/skype/Set-CsOAuthServer.md index 462733072f..0749b9d100 100644 --- a/skype/skype-ps/skype/Set-CsOAuthServer.md +++ b/skype/skype-ps/skype/Set-CsOAuthServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsOAuthServer @@ -220,7 +225,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -242,4 +247,3 @@ Instead, the `Set-CsOAuthServer` cmdlet modifies existing instances of the Micro [New-CsOAuthServer](New-CsOAuthServer.md) [Remove-CsOAuthServer](Remove-CsOAuthServer.md) - diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Set-CsOnlineApplicationEndpoint.md deleted file mode 100644 index 0f007b7fee..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineApplicationEndpoint -schema: 2.0.0 ---- - -# Set-CsOnlineApplicationEndpoint - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Set-CsOnlineApplicationEndpoint [-CallbackUri <String>] [-Name <String>] [-Uri] <String> [-Audience <String>] - [-Ring <String>] [-PhoneNumber <String>] [-IsInternalRun <Boolean>] [-Tenant <Guid>] - [-RunFullProvisioningFlow <Boolean>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION - -The following parameters are not applicable to Skype for Business Online: AsJob, Audience, CallbackUri, DomainController, Force, IsInternalRun, PipelineVariable, Ring, and RunFullProvisioningFlow - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Uri -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallbackUri -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -{{Fill IsInternalRun Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -{{Fill Ring Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -{{Fill RunFullProvisioningFlow Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingTenantSettings.md b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingTenantSettings.md deleted file mode 100644 index e58efa030f..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingTenantSettings.md +++ /dev/null @@ -1,460 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineDialInConferencingTenantSettings -schema: 2.0.0 ---- - -# Set-CsOnlineDialInConferencingTenantSettings - -## SYNOPSIS -Use the `Set-CsOnlineDialInConferencingTenantSettings` to modify the tenant level settings of dial-in conferencing. -Dial-in conferencing tenant settings control the conference experience of users and manage some conferencing administrative functions. - -## SYNTAX - -### Identity (Default) -``` -Set-CsOnlineDialInConferencingTenantSettings [-Tenant <Guid>] [-EnableEntryExitNotifications <Boolean>] - [-EntryExitAnnouncementsType <EntryExitAnnouncementsType>] [-EnableNameRecording <Boolean>] - [-IncludeTollFreeNumberInMeetingInvites <Boolean>] [-PinLength <UInt32>] - [-AllowPSTNOnlyMeetingsByDefault <Boolean>] [-AutomaticallySendEmailsToUsers <Boolean>] - [-SendEmailFromOverride <Boolean>] [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] - [-AutomaticallyReplaceAcpProvider <Boolean>] [-UseUniqueConferenceIds <Boolean>] - [-AutomaticallyMigrateUserMeetings <Boolean>] [-MigrateServiceNumbersOnCrossForestMove <Boolean>] - [-EnableDialOutJoinConfirmation <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Instance -``` -Set-CsOnlineDialInConferencingTenantSettings [-Tenant <Guid>] [-EnableEntryExitNotifications <Boolean>] - [-EntryExitAnnouncementsType <EntryExitAnnouncementsType>] [-EnableNameRecording <Boolean>] - [-IncludeTollFreeNumberInMeetingInvites <Boolean>] [-PinLength <UInt32>] - [-AllowPSTNOnlyMeetingsByDefault <Boolean>] [-AutomaticallySendEmailsToUsers <Boolean>] - [-SendEmailFromOverride <Boolean>] [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] - [-AutomaticallyReplaceAcpProvider <Boolean>] [-UseUniqueConferenceIds <Boolean>] - [-AutomaticallyMigrateUserMeetings <Boolean>] [-MigrateServiceNumbersOnCrossForestMove <Boolean>] - [-EnableDialOutJoinConfirmation <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Dial-in conferencing tenant settings control what functions are available during a conference call. -For example, whether or not entries and exits from the call are announced. -The settings also manage some of the administrative functions, such as when users get notification of administrative actions, like a PIN change. -By contrast, the higher level dial-in conferencing configuration only maintains a flag for whether dial-in conferencing is enabled for your organization. -For more information, see `Get-CsOnlineDialinConferencingTenantConfiguration`. - -There is always a single instance of the dial-in conferencing settings per tenant. -You can modify the settings using `Set-CsOnlineDialInConferencingTenantSettings` and revert those settings to their defaults by using `Remove-CsOnlineDialInConferencingTenantSettings`. - -The following parameters are not applicable to Skype for Business Online: AsJob, EnableDialOutJoinConfirmation, IncludeTollFreeNumberInMeetingInvites, MigrateServiceNumbersOnCrossForestMove, and UseUniqueConferenceIds - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True -EnableNameRecording $True -PinLength 7 -``` - -This example sets the tenant's conferencing settings to enable entry and exit notifications supported by name recording. -The PIN length is set to 7. - - -### -------------------------- Example 2 -------------------------- -``` -Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendEmailFromAddress admin@contoso.com -SendEmailFromDisplayName "Conferencing Administrator" -``` - -This example defines the contact information to be used in dial-in conferencing email notifications and enables the default address to be overridden. - - -## PARAMETERS - -### -AllowPSTNOnlyMeetingsByDefault -Specifies the default value that gets assigned to the "AllowPSTNOnlyMeetings" setting of users when they are enabled for dial-in conferencing, or when a user's dial-in conferencing provider is set to Microsoft. -If set to $true, the "AllowPSTNOnlyMeetings" setting of the user will also be set to true. -If $false, the user setting will be false. -The default value for AllowPSTNOnlyMeetingsByDefault is $false. - -When AllowPSTNOnlyMeetingsByDefault is changed, the value of the "AllowPSTNOnlyMeetings" setting of currently enabled users doesn't change. -The new default value will only be applied to users that are subsequently enabled for dial-in conferencing, or whose provider is changed to Microsoft. - -The "AllowPSTNOnlyMeetings" setting of a user defines if 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 the organizer PIN when joining the meeting. - -For more information on the "AllowPSTNOnlyMeetings" user setting, see `Set-CsOnlineDialInConferencingUser`. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticallyMigrateUserMeetings -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticallyReplaceAcpProvider -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticallySendEmailsToUsers -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. - -User is enabled or disabled for dial-in conferencing. - -The dial-in conferencing provider is changed either to Microsoft, or from Microsoft to another provider, or none. - -The dial-in conferencing PIN is reset by the tenant administrator. - -Changes to either the user's conference ID, or the user's default dial-in conference number. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableEntryExitNotifications -Specifies if, by default, announcements are made as users enter and exit a conference call. -Set to $true to enable notifications, $false to disable notifications. -The default is $true. - -This setting can be overridden on a meeting by meeting basis when a user joins a meeting via a Skype for Business client and modifies the Announce when people enter or leave setting on the Skype Meeting Options menu of a meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableNameRecording -Specifies whether the name of a user is recorded on entry to the conference. -This recording is used during entry and exit notifications. -Set to $true to enable name recording, set to $false to bypass name recording. -The default is $true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryExitAnnouncementsType -PARAMVALUE: UseNames | ToneOnly - -```yaml -Type: EntryExitAnnouncementsType -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTollFreeNumberInMeetingInvites -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateServiceNumbersOnCrossForestMove -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PinLength -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. - -A user's PIN will only authenticate them as leaders for a meeting they scheduled. -The PIN of a user that did not schedule the meeting will not enable that user to lead the meeting. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromAddress -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 \<UserAlias\>@\<Domain\>. -For example, "KenMyer@Contoso.com" or "Admin@Contoso.com". - -The SendEmailFromAddress value is used only if the SendEmailFromDisplayName setting is specified, and the SendEmailFromOverride setting is $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 -``` - -### -SendEmailFromDisplayName -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromOverride -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. -The default is $false. - -SendEmailFromOverride can't be $true if SendEmailFromAddress and SendEmailFromDisplayName aren't specified. - -If you want to change the email address information, you need to make sure that your inbound email policies allow for emails that come from the address specified by the SendEmailFromAddress parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseUniqueConferenceIds -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -None. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md deleted file mode 100644 index 1b8458a2e3..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md +++ /dev/null @@ -1,430 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineDialInConferencingUser -schema: 2.0.0 ---- - -# Set-CsOnlineDialInConferencingUser - -## SYNOPSIS -Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. - -## SYNTAX - -### TenantIdParams (Default) -``` -Set-CsOnlineDialInConferencingUser [-Identity] <UserIdParameter> [-BridgeId <Guid>] - [-BridgeName <String>] [-Tenant <Guid>] [-ConferenceId <System.Int32>] [-ResetConferenceId] - [-ServiceNumber <String>] [-TollFreeServiceNumber <String>] [-AllowPSTNOnlyMeetings <Boolean>] [-Force] - [-ResetLeaderPin] [-AllowTollFreeDialIn <Boolean>] [-SendEmailToAddress <String>] - [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] [-SendEmail] [-DomainController <Fqdn>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TenantDomainParams -``` -Set-CsOnlineDialInConferencingUser [-Identity] <UserIdParameter> [-BridgeId <Guid>] - [-BridgeName <String>] -TenantDomain <String> [-ConferenceId <Int32>] [-ResetConferenceId] - [-ServiceNumber <String>] [-TollFreeServiceNumber <String>] [-AllowPSTNOnlyMeetings <Boolean>] [-Force] - [-ResetLeaderPin] [-AllowTollFreeDialIn <Boolean>] [-SendEmailToAddress <String>] - [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] [-SendEmail] [-DomainController <Fqdn>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-CsOnlineDialInConferencingUser` cmdlet is used to modify properties for a Microsoft audio conferencing user. -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. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ConferenceId 3542699 -ResetLeaderPin -ServiceNumber 14255037265 -``` - -This example shows how to set a ConferenceId for a user, reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. - - -### -------------------------- Example 2 -------------------------- -``` -Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" -ConferenceId 3542699 -``` - -This example sets a user's ConferenceId and 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. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -Specifies the domain name for the tenant or organization. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPSTNOnlyMeetings -If true, non-authenticated users can start meetings. -If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. -An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. -The default is false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeId -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. - -```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 -Specifies the name of the audio conferencing bridge. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConferenceId -Specifies the ConferenceId that will be used by the user for dial-in meetings. -The cmdlet will fail if: - -The ConferenceId is already being used in the bridge where the user is assigned, or to which the user would be assigned. - -The ConferenceId doesn't meet the ConferenceId format requirements. - -ConferenceId and ResetConferenceId are mutually exclusive. -When ConferenceId is specified the new ConferenceId will be assigned to the user. -When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: Passcode -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -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: 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 -``` - -### -ResetConferenceId -Specifies whether to reset the ConferenceId for meetings that the user is organizing. -If specified, the meetings using the old ConferenceId will fail. -The user will have to reschedule his existing meetings, or run the meeting migration tool. - -ConferenceId and ResetConferenceId are mutually exclusive. -When ConferenceId is specified the new ConferenceId will be assigned to the user. -When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ResetPasscode -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetLeaderPin -Specifies whether to reset the meeting organizer or leaders PIN for meetings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmail -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromAddress -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromDisplayName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToAddress -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -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. - -The service number can be specified in the following formats: E.164 number, +\<E.164 number\> and tel:\<E.164 number\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TollFreeServiceNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. Please note that making modifications to this value could trigger rescheduling all existing meetings organized by the given users, and all meeting invites will be resent to all participants. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md deleted file mode 100644 index 594fd0f878..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineDialInConferencingUserDefaultNumber -schema: 2.0.0 ---- - -# Set-CsOnlineDialInConferencingUserDefaultNumber - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### BridgeNameParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain <String>] [-Tenant <Guid>] - -BridgeName <String> [-FromNumber <String>] -ToNumber <String> -NumberType <String> - [-CountryOrRegion <String>] [-AreaOrState <String>] [-CapitalOrMajorCity <String>] [-RescheduleMeetings] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FilterByUsageLocation -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain <String>] [-Tenant <Guid>] - [-BridgeName <String>] -BridgeId <Guid> -ToNumber <String> -NumberType <String> - -CountryOrRegion <String> [-AreaOrState <String>] [-CapitalOrMajorCity <String>] [-RescheduleMeetings] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UniqueBridgeParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain <String>] [-Tenant <Guid>] - -BridgeId <System.Guid> -FromNumber <String> -ToNumber <String> -NumberType <String> [-RescheduleMeetings] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -BridgeId -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AreaOrState -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RescheduleMeetings -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md b/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md deleted file mode 100644 index 7c9cbc258f..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineDirectoryUser -schema: 2.0.0 ---- - -# Set-CsOnlineDirectoryUser - -## SYNOPSIS -Use the `Set-CsOnlineDirectoryUser` cmdlet to create or modify a PSTN enabled user in Business Voice Directory. -This should be done via provisioning or operations in special cases. - -## SYNTAX - -``` -Set-CsOnlineDirectoryUser [-Identity] <UserIdParameter> [-Tenant <Guid>] [-Ring <String>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md deleted file mode 100644 index 1878844d94..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 ---- - -# Set-CsOnlineEnhancedEmergencyServiceDisclaimer - -## SYNOPSIS -Use the `Set-CsOnlineEnhancedEmergencyServiceDisclaimer` cmdlet to record your organization's acceptance of the enhanced emergency service terms and conditions. -Any tenant administrator can accept the terms and conditions. - -## SYNTAX - -``` -Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion <String> [-Version <String>] [-ForceAccept] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - - -## DESCRIPTION -You must run this cmdlet prior to assigning phone numbers and locations to voice enabled users in the United States. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion US -``` - -This example accepts the U.S. -version of the enhanced emergency service terms and conditions. - - -## PARAMETERS - -### -CountryOrRegion -Specifies the region or country whose terms and conditions you wish to accept. -The United States is currently the only country supported, but it must be specified as "US". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -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 -``` - -### -ForceAccept -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/Set-CsOnlineLisCivicAddress.md deleted file mode 100644 index 17d3d135e4..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,400 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineLisCivicAddress -schema: 2.0.0 ---- - -# 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. - -## SYNTAX - -``` -Set-CsOnlineLisCivicAddress -CivicAddressId <Guid> [-CompanyName <String>] [-CompanyTaxId <String>] - [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-StreetName <String>] [-StreetSuffix <String>] - [-PreDirectional <String>] [-PostDirectional <String>] [-City <String>] [-CityAlias <String>] - [-StateOrProvince <String>] [-CountryOrRegion <String>] [-PostalCode <String>] [-Description <String>] - [-ValidationStatus <String>] [-Tenant <System.Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineLisCivicAddress -CivicAddressid a363a9b8-1acd-41de-916a-296c7998a024 -Description "City Center" -CompanyName Contoso -``` - -This example modifies the description and company name of the civic address with the identity a363a9b8-1acd-41de-916a-296c7998a024. - - -## PARAMETERS - -### -CivicAddressId -Specifies the unique identifier of the civic address to be modified. - -```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 -``` - -### -City -Specifies a new city for the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CityAlias -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyName -Specifies a new company name for the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyTaxId -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies a new country or region for the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a new description for the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumber -Specifies the new numeric portion of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumberSuffix -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". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the new postal code of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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 ". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -Specifies the new state or province of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetName -Specifies the new street name of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: String -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 -``` - -### -ValidationStatus -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineLisLocation.md b/skype/skype-ps/skype/Set-CsOnlineLisLocation.md deleted file mode 100644 index 715324f9bb..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineLisLocation.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineLisLocation -schema: 2.0.0 ---- - -# Set-CsOnlineLisLocation - -## SYNOPSIS -Use the `Set-CsOnlineLisLocation` cmdlet to modify an existing emergency dispatch location. -There can be multiple locations in a civic address. -Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. - -## SYNTAX - -### UseCivicAddressId -``` -Set-CsOnlineLisLocation -CivicAddressId <Guid> [-CompanyName <String>] [-CompanyTaxId <String>] - [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-StreetName <String>] [-StreetSuffix <String>] - [-PreDirectional <String>] [-PostDirectional <String>] [-City <String>] [-CityAlias <String>] - [-StateOrProvince <String>] [-CountryOrRegion <String>] [-PostalCode <String>] [-Description <String>] - [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UseLocationId -``` -Set-CsOnlineLisLocation -LocationId <Guid> [-Location <String>] [-CityAlias <String>] [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineLisLocation -LocationId 5aa884e8-d548-4b8e-a289-52bfd5265a6e -Location "B5 2nd Floor" -``` - -This example changes the location description of the location specified by its location identity. - - -## PARAMETERS - -### -CivicAddressId -Specifies the unique identifier of the civic address that contains the location to be modified. -Civic address identities can be discovered by using the `Get-CsOnlineLisCivicAddress` cmdlet. - -```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 -``` - -### -LocationId -Specifies the unique identifier of the location to be modified. -If specified, no other address parameters are allowed. -Location identities can be discovered by using the `Get-CsOnlineLisLocation` cmdlet. - -```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 -``` - -### -City -Specifies the city of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CityAlias -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyName -Specifies the name of your organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyTaxId -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the country or region of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an administrator defined description of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumber -Specifies the numeric portion of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumberSuffix -Specifies the numeric suffix of the civic address. -For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -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: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the postal code of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -Specifies the state or province of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetName -Specifies the street name of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetSuffix -Specifies a modifier of the street name of the civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md deleted file mode 100644 index 8d3d49324f..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,502 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineNumberPortInOrder -schema: 2.0.0 ---- - -# Set-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -Set-CsOnlineNumberPortInOrder [-Tenant <Guid>] -PortInOrderId <String> [-LOABase64PayLoad <String>] - [-LOAContentType <String>] [-LOAAuthorizingPerson <String>] [-SubscriberArea <String>] - [-SubscriberCity <String>] [-SubscriberCountry <String>] [-SubscriberStreetName <String>] - [-SubscriberBuildingNumber <String>] [-SubscriberZipCode <String>] [-SubscriberBusinessName <String>] - [-BillingTelephoneNumber <String>] [-SubscriberFirstName <String>] [-SubscriberLastName <String>] - [-EmailAddresses <String[]>] [-RequestedFocDate <DateTime>] [-LosingTelcoPin <String>] - [-LosingTelcoAccountId <String>] [-SubscriberAddressLine1 <String>] [-SubscriberAddressLine2 <String>] - [-IsPartialPort <Boolean>] [-SubscriberAddressLine3 <String>] [-FriendlyName <String>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -PortInOrderId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BillingTelephoneNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPartialPort -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAAuthorizingPerson -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOABase64PayLoad -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAContentType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoAccountId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoPin -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine1 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine2 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine3 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberArea -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBuildingNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBusinessName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCountry -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberFirstName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberLastName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberStreetName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberZipCode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md b/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md deleted file mode 100644 index 4ad2e0f21e..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineNumberPortOutOrderPin -schema: 2.0.0 ---- - -# Set-CsOnlineNumberPortOutOrderPin - -## SYNOPSIS -{{Fill in the Synopsis}} - - -## SYNTAX - -``` -Set-CsOnlineNumberPortOutOrderPin [-Tenant <Guid>] [-PortOrderPin <String>] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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 -{{Fill DomainController Description}} - -```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 -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortOrderPin -{{Fill PortOrderPin Description}} - -```yaml -Type: String -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 -{{Fill Tenant Description}} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlinePstnUsage.md b/skype/skype-ps/skype/Set-CsOnlinePstnUsage.md deleted file mode 100644 index c7840527f3..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlinePstnUsage.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Set-CsOnlinePstnUsage - -## SYNOPSIS -Modifies a set of strings that identify the allowed online public switched telephone network (PSTN) usages. This cmdlet can be used to add usages to the list of online PSTN usages or remove usages from the list. - -## SYNTAX - -### Identity (Default) -``` -Set-CsOnlinePstnUsage [-Tenant <Guid>] [-Usage <PSListModifier>] [[-Identity] <XdsIdentity>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsOnlinePstnUsage [-Tenant <Guid>] [-Usage <PSListModifier>] [-Instance <PSObject>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Online PSTN usages are string values that are used for call authorization. An online PSTN usage links an online voice policy to a route. The `Set-CsOnlinePstnUsage` cmdlet is used to add or remove phone usages to or from the usage list. This list is global so it can be used by policies and routes throughout the tenant. - -This cmdlet is used when configuring Microsoft Phone System Direct Routing. - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{remove="Local"} -``` - -This command removes the string "Local" from the list of available PSTN usages. - -### -------------------------- 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 -------------------------- -``` -PS C:\> Set-CsOnlinePstnUsage -Usage @{replace="International","Restricted"} -``` - -This command replaces everything in the usage list with the values International and Restricted. All previously existing usages are removed. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The scope at which these settings are applied. The Identity for this cmdlet is always Global. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Usage -Contains a list of allowable usage strings. These entries can be any string value. - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlinePstnUsage](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinepstnusage?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md b/skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md deleted file mode 100644 index 5a9abe06ad..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Set-CsOnlineVoiceRoute - -## SYNOPSIS -Modifies 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). - -## SYNTAX - -### Identity (Default) -``` -Set-CsOnlineVoiceRoute [-Tenant <Guid>] [-Description <String>] [-NumberPattern <String>] - [-OnlinePstnUsages <PSListModifier>] [-OnlinePstnGatewayList <PSListModifier>] [-Priority <Int32>] - [[-Identity] <XdsGlobalRelativeIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsOnlineVoiceRoute [-Tenant <Guid>] [-Description <String>] [-NumberPattern <String>] - [-OnlinePstnUsages <PSListModifier>] [-OnlinePstnGatewayList <PSListModifier>] [-Priority <Int32>] - [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use this cmdlet to modify an existing online voice route. Online voice routes are associated with online voice policies through online public switched telephone network (PSTN) usages. A online voice route includes a regular expression that identifies which phone numbers will be routed through a given voice route: phone numbers matching the regular expression will be routed through this route. - -This cmdlet is used when configuring Microsoft Phone System Direct Routing. - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -PstnUsages @{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 -------------------------- -``` -PS C:\> $x = (Get-CsOnlinePstnUsage).Usage - -PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{replace=$x} -``` - -This example modifies the online voice route named Route1 to populate that route's list of online PSTN usages with all the existing usages for the organization. The first command in this example retrieves the list of global online PSTN usages. Notice that the call to the `Get-CsOnlinePstnUsage` cmdlet is in parentheses; this means that we first retrieve an object containing PSTN usage information. (Because there is only one--global--PSTN usage, only one object will be retrieved.) The command then retrieves the Usage property of this object. That property, which contains a list of online PSTN usages, is assigned to the variable $x. In the second line of this example, the Set-CsOnlineVoiceRoute cmdlet is called to modify the online voice route with the identity Route1. Notice the value passed to the OnlinePstnUsages parameter: @{replace=$x}. This value says to replace everything in the OnlinePstnUsages list for this route with the contents of $x, which contain the online PSTN usages list retrieved in line 1. - -### -------------------------- Example 4 -------------------------- -``` -PS C:\> $x = Get-CsOnlineVoiceRoute -Identity Route1 - -PS C:\> $x.Name = "RouteA" - -PS C:\> Set-CsOnlineVoiceRoute -Instance $x -``` - -This set of commands changes the Name property of the online voice route with the identity Route1 to RouteA. Changing the Name property automatically changes the Identity property, in this case to RouteA. - -In the first line, the `Get-CsOnlineVoiceRoute` cmdlet is called to retrieve the online voice route with the identity Route1. The returned object is stored in the variable $x. 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-CsOnlineVoiceRoute` cmdlet to make the change. - -### -------------------------- Example 5 -------------------------- -``` -PS C:\> $y = Get-CsOnlineVoiceRoute -Identity Route1 - -PS C:\> $y.OnlinePstnGatewayList.Add("OnlinePstnGateway:192.168.0.100") - -PS C:\> Set-CsOnlineVoiceRoute -Instance $y -``` - -This example modifies the online voice route named Route1 and populates that route's list of online PSTN gateways (OnlinePstnGatewayList) with the server role of the gateway with the identity PstnGateway:192.168.0.100. In the first line of this example, the `Get-CsOnlineVoiceRoute` cmdlet is called to retrieve the online voice route we want to modify, in this case Route1. Next we call the Add method on the OnlinePstnGatewayList property of Route1. We pass the Add method the Identity of the service we want to add. Finally, we call the `Set-CsOnlineVoiceRoute` cmdlet, passing the Instance parameter the variable $y, which will update Route1 (stored in $y) with the newly-added online PSTN gateway. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the 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 description of what this phone route is for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The unique identity of the online voice route. (If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object can be retrieved by calling the `Get-CsOnlineVoiceRoute` 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 -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlinePstnGatewayList -This parameter contains a list of online gateways associated with this online voice route. Each member of this list must be the service Identity of the online PSTN gateway. The service Identity is a string in the format OnlinePstnGateway:<FQDN>, where FQDN is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, OnlinePstnGateway:redmondpool.litwareinc.com. - -By default this list is empty. However, if you leave this parameter blank when creating a new voice route, you'll receive a warning message. - -```yaml -Type: PSListModifier -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, Long Distance, etc.) that can be applied to this online voice route. The PSTN usage must be an existing usage (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). - -By default this list is empty. However, if you leave this parameter blank when creating a new online voice route, you'll receive a warning message. - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -A number could resolve to multiple online 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: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) - -[New-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps) - -[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md b/skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md deleted file mode 100644 index 81061d9b75..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 ---- - -# Set-CsOnlineVoiceRoutingPolicy - -## SYNOPSIS -Modifies an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. - -## SYNTAX - -### Identity (Default) -``` -Set-CsOnlineVoiceRoutingPolicy [-Tenant <Guid>] [-OnlinePstnUsages <PSListModifier>] - [-Description <String>] [-RouteType <String>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Instance -``` -Set-CsOnlineVoiceRoutingPolicy [-Tenant <Guid>] [-OnlinePstnUsages <PSListModifier>] - [-Description <String>] [-RouteType <String>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Skype for Business Online users an online voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks. - -Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Skype for Business Online or Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. - -## EXAMPLES - -### -------------------------- 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 -------------------------- -``` -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 -------------------------- -``` -PS C:\> Set-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Local"} | Set-CsOnlineVoiceRoutingPolicy -OnlinePstnUsages @{Remove="Local"} -``` - -Example 3 removes the online PSTN usage "Local" is removed from all the online voice routing policies that include that usage. In order to do this, the command first calls the `Get-CsOnlineVoiceRoutingPolicy` cmdlet without any parameters in order to return a collection of all the available online voice routing policies. That collection is then piped to the Where-Object cmdlet, which picks out only those policies where the OnlinePstnUsages property includes (-contains) the "Local" usage. Those policies are then piped to the `Set-CsOnlineVoiceRoutingPolicy` cmdlet, which deletes the Local usage from each 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 -Enables administrators to provide explanatory text to accompany an online 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: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. Online voice routing policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: - --Identity global - -To refer to a per-user policy, use syntax similar to this: - --Identity "RedmondOnlineVoiceRoutingPolicy" - -If you do not specify an Identity, then the `Set-CsOnlineVoiceRoutingPolicy` cmdlet will modify the global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OnlinePstnUsages -A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online voice routing policy. The online PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsOnlinePstnUsage` cmdlet.) - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteType -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 -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) - -[Get-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) - -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) - -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Set-CsOnlineVoiceUser.md deleted file mode 100644 index 2a7282717e..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceUser.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineVoiceUser -schema: 2.0.0 ---- - -# Set-CsOnlineVoiceUser - -## SYNOPSIS -Use the `Set-CsOnlineVoiceUser` to set the PSTN specific parameters (like telephone numbers and emergency response locations.) - -## SYNTAX - -``` -Set-CsOnlineVoiceUser [-Identity] <UserIdParameter> [-Tenant <Guid>] [-TelephoneNumber <String>] - [-LocationID <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineVoiceUser -Identity 3c37e1c7-78f9-4703-82ee-a6b68516794e -TelephoneNumber +4255037311 -LocationID c7c5a17f-00d7-47c0-9ddb-3383229d606b -``` - -This example sets the telephone number and location for a user identified by the user ObjectID. - - -## 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: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationID -Specifies the unique identifier of the emergency location to assign to the user. -Location identities can be discovered by using the `Get-CsOnlineLisLocation` cmdlet. - -This parameter is required for users based in the US. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -None - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md b/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md deleted file mode 100644 index e33f64fb37..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineVoiceUserBulk -schema: 2.0.0 ---- - -# Set-CsOnlineVoiceUserBulk - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Set-CsOnlineVoiceUserBulk [-Tenant <Guid>] [-NumberAssignmentDetails <>] [-DomainController <Fqdn>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberAssignmentDetails -PARAMVALUE: List - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md b/skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md deleted file mode 100644 index b7f8190fd5..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsOnlineVoicemailPolicy -schema: 2.0.0 ---- - -# Set-CsOnlineVoicemailPolicy - -## SYNOPSIS -Modifies an existing Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription and profanity masking for the voicemail transcriptions are enabled for a user. - -## SYNTAX - -### Identity (Default) -``` -Set-CsOnlineVoicemailPolicy [-Tenant <Guid>] [-EnableTranscription <Boolean>] [-ShareData <String>] - [-EnableTranscriptionProfanityMasking <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Instance -``` -Set-CsOnlineVoicemailPolicy [-Tenant <Guid>] [-EnableTranscription <Boolean>] [-ShareData <String>] - [-EnableTranscriptionProfanityMasking <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Online Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. - -By default, users enabled for Phone System will be enabled for Online Voicemail, and Online Voicemail policy controls whether or not voicemail transcription and profanity masking for the voicemail transcriptions are enabled for a user. Online Voicemail transcription is enabled by default and transcription profanity masking is disabled by default, and you can modify existing policies to match your organization's requirements. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTranscription -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTranscriptionProfanityMasking -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: PSObject - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineVoicemailUserSettings.md b/skype/skype-ps/skype/Set-CsOnlineVoicemailUserSettings.md deleted file mode 100644 index 6816c908e4..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoicemailUserSettings.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Set-CsOnlineVoicemailUserSettings -schema: 2.0.0 ---- - -# Set-CsOnlineVoicemailUserSettings - -## SYNOPSIS -Use the Set-CsOnlineVoicemailUserSettings cmdlet to modify the online voicemail user settings of a specific user. -New online voicemail user settings of the user would be returned after executing. - -## SYNTAX - -``` -Set-CsOnlineVoicemailUserSettings -Identity <String> [-VoicemailEnabled <Boolean>] [-PromptLanguage <String>] [-OofGreetingEnabled <Boolean>] [-OofGreetingFollowAutomaticRepliesEnabled <Boolean>] [-OofGreetingFollowCalendarEnabled <Boolean>] [-CallAnswerRule <DeclineCall | PromptOnly | PromptOnlyWithTransfer | RegularVoicemail | VoicemailWithTransferOption>] [-TransferTarget <String>] [-DefaultGreetingPromptOverwrite <String>] [-DefaultOofGreetingPromptOverwrite <String>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-CsOnlineVoicemailUserSettings cmdlet lets tenant admin modify the online voicemail user settings of a specific user in the organization. New online voicemail user settings of the user would be returned after executing. -For example, tenant admin could enable/disable voicemail, change voicemail prompt language, modify out-of-office voicemail greeting settings, or setup simple call answer rules. Only those properties that tenant admin have actually provided with be modified. If an online voicemail user setting was not set by tenant admin, it would remain the old value after this cmdlet has been executed. - -**NOTE** -- **This cmdlet is currently available to PREVIEW customers only.** - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com -VoicemailEnabled $true -``` - -This example changes VoicemailEnabled setting to true for the user with SIP URI sip:user@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -Set-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000" -PromptLanguage "en-US" -OofGreetingFollowCalendarEnabled $false -``` - -This example changes PromptLanguage setting to "en-US" and OofGreetingFollowCalendarEnabled setting to false for the user with Object ID "00000000-0000-0000-0000-000000000000". - -### -------------------------- Example 3 -------------------------- -``` -Set-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000" -CallAnswerRule PromptOnlyWithTransfer -TransferTarget sip:user2@contoso.com -``` - -This example changes CallAnswerRule setting to PromptOnlyWithTransfer and set TransferTarget to "sip:user2@contoso.com" for the user with Object ID "00000000-0000-0000-0000-000000000000". - -### -------------------------- Example 4 -------------------------- -``` -Set-CsOnlineVoicemailUserSettings -Identity "00000000-0000-0000-0000-000000000000" -DefaultGreetingPromptOverwrite "Hi, I am currently not available." -``` - -This example changes DefaultGreetingPromptOverwrite setting to "Hi, I am currently not available." for the user with Object ID "00000000-0000-0000-0000-000000000000". - - -## 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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VoicemailEnabled -The VoicemailEnabled parameter represents whether to enable voicemail service. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PromptLanguage -The PromptLanguage parameter represents the language that is used to play voicemail prompts. - -Now the following languages are supported: - -- "ar-EG" (Arabic - Egypt) -- "ca-ES" (Catalan - Catalan) -- "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) -- "nl-NL" (Dutch - Netherlands) -- "nb-NO" (Norwegian, Bokmål - Norway) -- "pl-PL" (Polish - Poland) -- "pt-BR" (Portuguese - Brazil) -- "pt-PT" (Portuguese - Portugal) -- "ru-RU" (Russian - Russia) -- "sv-SE" (Swedish - Sweden) -- "tr-TR" (Turkish - Turkey) -- "zh-CN" (Chinese - Simplified, PRC) -- "zh-TW" (Chinese - Traditional, Taiwan) -- "zh-HK" (Chinese - Traditional, Hong Kong S.A.R.) -- "cs-CZ" (Czech - Czech Republic) -- "th-TH" (Thai - Thailand) -- "el-GR" (Greek - Greece) -- "hu-HU" (Hungarian - Hungary) -- "sk-SK" (Slovak - Slovakia) -- "hr-HR" (Croatian - Croatia) -- "sl-SI" (Slovenian - Slovenia) -- "id-ID" (Indonesian - Indonesia) -- "ro-RO" (Romanian - Romania) -- "vi-VN" (Vietnamese - Viet Nam) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OofGreetingEnabled -The OofGreetingEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OofGreetingFollowAutomaticRepliesEnabled -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: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OofGreetingFollowCalendarEnabled -The OofGreetingFollowCalendarEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario when user set out-of-office in calendar. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -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: - -- DeclineCall -- PromptOnly -- PromptOnlyWithTransfer -- RegularVoicemail -- VoicemailWithTransferOption - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransferTarget -The TransferTarget parameter represents the target to transfer the call when call answer rule set to PromptOnlyWithTransfer or VoicemailWithTransferOption. -Value of this parameter should be a SIP URI of another user, an auto attendant, or a hunt group (call queue) in your organization. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultGreetingPromptOverwrite -The DefaultGreetingPromptOverwrite parameter represents the contents that overwrite the default normal greeting prompt. -If user normal custom greeting is not set and DefaultGreetingPromptOverwrite is not empty, voicemail service will play this overwrite greeting instead of default normal greeting in voicemail deposit scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultOofGreetingPromptOverwrite -The DefaultOofGreetingPromptOverwrite parameter represents the contents that overwrite the default out-of-office greeting prompt. -If user out-of-office custom greeting is not set and DefaultOofGreetingPromptOverwrite is not empty, voicemail service will play this overwrite greeting instead of default out-of-office greeting in voicemail deposit scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings - - -## NOTES - - -## RELATED LINKS - -[Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) - diff --git a/skype/skype-ps/skype/Set-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Set-CsOrganizationalAutoAttendant.md deleted file mode 100644 index f062287173..0000000000 --- a/skype/skype-ps/skype/Set-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Set-CsOrganizationalAutoAttendant.xml -applicable: Skype for Business Online -title: Set-CsOrganizationalAutoAttendant -schema: 2.0.0 ---- - -# Set-CsOrganizationalAutoAttendant - -## SYNOPSIS -Use the Set-CsOrganizationalAutoAttendant cmdlet to modify the properties of an existing Auto Attendant (AA). - -## SYNTAX - -``` -Set-CsOrganizationalAutoAttendant [-Instance] <OrgAutoAttendant> [-Tenant <Guid>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-CsOrganizationalAutoAttendant cmdlet lets you modify the properties of an auto attendant. For example, you can change the phone number, the operator, the greeting, or the menu prompts. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$oaa = Get-CsOrganizationalAutoAttendant -PrimaryUri "sip:mainoaa@contoso.com" -$oaa.LineUris = @([System.Uri] "tel:+11098765432") -Set-CsOrganizationalAutoAttendant -Instance $oaa -``` - -This example changes the telephone number for the OAA that has a Primary URI of sip:mainoaa@contoso.com. - -### -------------------------- Example 2 -------------------------- -``` -$oaa = Get-CsOrganizationalAutoAttendant -PrimaryUri "sip:mainoaa@contoso.com" - -$christmasGreetingPrompt = New-CsOrganizationalAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." -$christmasMenuOption = New-CsOrganizationalAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic -$christmasMenu = New-CsOrganizationalAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($christmasMenuOption) -$christmasCallFlow = New-CsOrganizationalAutoAttendantCallFlow -Name "Christmas" -Greetings @($christmasGreetingPrompt) -Menu $christmasMenu - -$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" -$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) - -$christmasCallHandlingAssociation = New-CsOrganizationalAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $christmasSchedule.Id -CallFlowId $christmasCallFlow.Id - -$oaa.CallFlows = $oaa.CallFlows + @($christmasCallFlow) -$oaa.Schedules = $oaa.Schedules + @($christmasSchedule) -$oaa.CallHandlingAssociations = $oaa.CallHandlingAssociations + @($christmasCallHandlingAssociation) - -Set-CsOrganizationalAutoAttendant -Instance $oaa -``` - -This example adds a Christmas holiday to an OAA that a Primary URI of sip:mainoaa@contoso.com. - -## PARAMETERS - -### -Instance -The Instance parameter is the object reference to the OAA to be modified. - -You can retrieve an object reference to an existing OAA by using the Get-CsOrganizationalAutoAttendant cmdlet and assigning the returned value to a variable. - -```yaml -Type: OrgAutoAttendant -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -{{Fill DomainController Description}} - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Hosted.OAA.Models.OrgAutoAttendant -The Set-CsOrganizationalAutoAttendant cmdlet accepts a Microsoft.Rtc.Management.Hosted.OAA.Models.OrgAutoAttendant object as the Instance parameter. - - -## OUTPUTS - -### None -The Set-CsOrganizationalAutoAttendant cmdlet does not return any objects or values. Instead, the cmdlet modifies the instance of the Microsoft.Rtc.Management.Hosted.OAA.Models.OrgAutoAttendant object that is passed in as the Instance parameter. - - -## NOTES - -## RELATED LINKS - -[New-CsOrganizationalAutoAttendant](New-CsOrganizationalAutoAttendant.md) - -[Get-CsOrganizationalAutoAttendant](Get-CsOrganizationalAutoAttendant.md) - diff --git a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md index 80d6f6b3ac..02b03a405f 100644 --- a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsOutboundCallingNumberTranslationRule @@ -205,7 +210,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -227,4 +232,3 @@ Instead, the `Set-CsOutboundCallingNumberTranslationRule` cmdlet modifies existi [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md b/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md index 167b9439ad..8840737092 100644 --- a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsOutboundTranslationRule @@ -228,7 +233,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -251,4 +256,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.T [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsPartnerApplication.md b/skype/skype-ps/skype/Set-CsPartnerApplication.md index b86458e34d..b1273b0d76 100644 --- a/skype/skype-ps/skype/Set-CsPartnerApplication.md +++ b/skype/skype-ps/skype/Set-CsPartnerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPartnerApplication @@ -126,9 +131,9 @@ Accept wildcard characters: False Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these: -`$x = Get-Content "C:\Certificates\PartnerApplication.cer" -Encoding Byte` +`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` -`$y = \[Convert\]::ToBase64String($x)` +`$y = [Convert]::ToBase64String($x)` You can then use this syntax to assign the certificate data stored in the variable $y: @@ -347,7 +352,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -370,4 +375,3 @@ Instead, the `Set-CsPartnerApplication` cmdlet modifies existing instances of th [New-CsPartnerApplication](New-CsPartnerApplication.md) [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md b/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md index efc09b2c0d..6bb38b73c1 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatActiveServer @@ -88,7 +93,7 @@ Collection of fully-qualified domain names representing the active Persistent Ch Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Deploy.Fqdn] Parameter Sets: Explicit Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -104,7 +109,7 @@ When specified, swaps the active state for all the Persistent Chat servers in th Type: SwitchParameter Parameter Sets: Swap Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -120,7 +125,7 @@ Prompts you for confirmation before executing the command. 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 @@ -136,7 +141,7 @@ Suppresses the display of any non-fatal error message that might arise when runn 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 Required: False Position: Named @@ -154,7 +159,7 @@ Note that you can only have a single collection of Persistent Chat servers. Type: XdsGlobalRelativeIdentity 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 Required: False Position: 2 @@ -170,7 +175,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -180,7 +185,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -198,4 +203,3 @@ None. ## RELATED LINKS [Set-CsPersistentChatState](Set-CsPersistentChatState.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md b/skype/skype-ps/skype/Set-CsPersistentChatAddin.md index d93a25af20..57d307c906 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatAddin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatAddin @@ -45,11 +50,11 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat a ### -------------------------- Example 1 -------------------------- ``` -Set-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin" -Url "http://atl-cs-001.litwareinc.com/itchat2" +Set-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin" -Url "https://atl-cs-001.litwareinc.com/itchat2" ``` Example 1 modifies the URL assigned to the Persistent Chat add-in ITPersistentChatAddin. -In this case, the URL is changed to http://atl-cs-001.litwareinc.com/itchat2. +In this case, the URL is changed to `https://atl-cs-001.litwareinc.com/itchat2`. ## PARAMETERS @@ -65,7 +70,7 @@ For example: Type: String 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 Required: True Position: 1 @@ -81,7 +86,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: Addin Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 1 @@ -97,7 +102,7 @@ Prompts you for confirmation before executing the command. 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 @@ -114,7 +119,7 @@ Names must be unique per Persistent Chat pool. 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 Required: False Position: Named @@ -130,7 +135,7 @@ URL of the Web page to be displayed by the Persistent Chat add-in. 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 Required: False Position: Named @@ -146,7 +151,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -156,7 +161,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -178,4 +183,3 @@ Instead, the `Set-CsPersistentChatAddin` cmdlet modifies existing instances of t [New-CsPersistentChatAddin](New-CsPersistentChatAddin.md) [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md b/skype/skype-ps/skype/Set-CsPersistentChatCategory.md index cbb9439a96..5398bb8787 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatCategory.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatCategory @@ -81,7 +86,7 @@ The Identity consists of the Persistent Chat pool were the category is located f Type: String 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 Required: True Position: 1 @@ -97,7 +102,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: Category Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -137,7 +142,7 @@ To add all the users in a distribution list, use the Active Directory distinguis Type: System.Management.Automation.PSListModifier`1[System.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 Required: False Position: Named @@ -154,7 +159,7 @@ When not specified, SIP addresses are used when managing these lists. 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 Required: False Position: Named @@ -164,14 +169,14 @@ Accept wildcard characters: False ``` ### -ChatHistory -When set the False ($False), the chat history feature will be disabled for the new category. +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, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -187,7 +192,7 @@ Prompts you for confirmation before executing the command. 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 @@ -227,7 +232,7 @@ To add all the users in a distribution list, use the Active Directory distinguis Type: System.Management.Automation.PSListModifier`1[System.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 Required: False Position: Named @@ -267,7 +272,7 @@ To deny access to all the users in a distribution list, use the Active Directory Type: System.Management.Automation.PSListModifier`1[System.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 Required: False Position: Named @@ -284,7 +289,7 @@ For example, the Description might explain the purpose of the category and what 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 Required: False Position: Named @@ -300,7 +305,7 @@ When set to True ($True), allows file uploads to the chat rooms in the category. 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 Required: False Position: Named @@ -317,7 +322,7 @@ Among other things, this means that users on the AllowedMembers list will automa 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 Required: False Position: Named @@ -334,7 +339,7 @@ Names must be unique per Persistent Chat pool. 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 Required: False Position: Named @@ -350,7 +355,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -360,7 +365,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -382,4 +387,3 @@ Instead, the `Set-CsPersistentChatCategory` cmdlet modifies existing instances o [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md index 6cd3429237..9dabe65046 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatComplianceConfiguration @@ -75,7 +80,7 @@ Adapters are third-party products that convert the data in the compliance databa 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 Required: False Position: Named @@ -92,7 +97,7 @@ You must have a separate folder for each adapter. 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 Required: False Position: Named @@ -112,7 +117,7 @@ If you do not specify an adapter type Persistent Chat will not save compliance d 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 Required: False Position: Named @@ -132,7 +137,7 @@ The default value is False. 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 Required: False Position: Named @@ -152,7 +157,7 @@ The default value is False. 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 Required: False Position: Named @@ -168,7 +173,7 @@ Prompts you for confirmation before executing the command. 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 @@ -186,7 +191,7 @@ These files will have the file extension .ATTACH and are placed in the location 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 Required: False Position: Named @@ -203,7 +208,7 @@ XSLT transform script that enables Persistent Chat to save compliance data in a 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 Required: False Position: Named @@ -219,7 +224,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -249,7 +254,7 @@ If this parameter is not included then the `Set-CsPersistentChatComplianceConfig Type: XdsIdentity 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 Required: False Position: 2 @@ -265,7 +270,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance Aliases: -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 @@ -282,7 +287,7 @@ The default value is False. 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 Required: False Position: Named @@ -304,7 +309,7 @@ The RunInterval can be set to any value between 1 minute (00:01.00) and 30 days Type: TimeSpan 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 Required: False Position: Named @@ -320,7 +325,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -330,7 +335,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -352,4 +357,3 @@ Instead, the `Set-CsPersistentChatComplianceConfiguration` cmdlet modifies exist [New-CsPersistentChatComplianceConfiguration](New-CsPersistentChatComplianceConfiguration.md) [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md index 108e15aef0..f174447fa0 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatConfiguration @@ -91,7 +96,7 @@ Prompts you for confirmation before executing the command. 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 @@ -111,7 +116,7 @@ The default value is 30. Type: Int16 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 Required: False Position: Named @@ -127,7 +132,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -157,7 +162,7 @@ If you do not include the Identity parameter the `Set-CsPersistentChatConfigurat Type: XdsIdentity 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 Required: False Position: 2 @@ -173,7 +178,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance Aliases: -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 @@ -190,7 +195,7 @@ The default value is 20000 KB. Type: UInt32 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 Required: False Position: Named @@ -207,7 +212,7 @@ The default value is 75. Type: UInt32 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 Required: False Position: Named @@ -223,7 +228,7 @@ URL for the Web page administrators can use to manage individual chat rooms. 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 Required: False Position: Named @@ -239,7 +244,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -249,7 +254,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -271,4 +276,3 @@ Instead, the `Set-CsPersistentChatConfiguration` cmdlet modifies existing instan [New-CsPersistentChatConfiguration](New-CsPersistentChatConfiguration.md) [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md index 9baae03117..0be410776e 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatPolicy @@ -61,7 +66,7 @@ Prompts you for confirmation before executing the command. 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 @@ -78,7 +83,7 @@ For example, the Description might include information about the users the polic 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 Required: False Position: Named @@ -95,7 +100,7 @@ When set to False (the default value) users affected by the policy will not be a 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 Required: False Position: Named @@ -111,7 +116,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -141,7 +146,7 @@ If you do not include the Identity parameter the `Set-CsPersistentChatPolicy` cm Type: XdsIdentity 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 Required: False Position: 2 @@ -157,7 +162,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance Aliases: -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 @@ -173,7 +178,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -196,7 +201,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Skype for Business Server 2015 Required: False Position: Named @@ -206,7 +211,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -230,4 +235,3 @@ Instead, the `Set-CsPersistentChatPolicy` cmdlet modifies existing instances of [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md b/skype/skype-ps/skype/Set-CsPersistentChatRoom.md index f61cf270b3..0a6014d89c 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatRoom.md @@ -1,14 +1,19 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatRoom ## SYNOPSIS -Modifies and existing Persistent Chat chat room. +Modifies an existing Persistent Chat chat room. A chat room is a discussion forum that typically revolves around a specific topic. This cmdlet was introduced in Lync Server 2013. @@ -91,7 +96,7 @@ The Identity for a chat room consists of the Persistent Chat pool where the room Type: String 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 Required: True Position: 1 @@ -107,7 +112,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: ChatRoom Parameter Sets: Instance Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 1 @@ -125,7 +130,7 @@ Add-ins can be created by using the `New-CsPersistentChatAddin` cmdlet. 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 Required: False Position: Named @@ -142,7 +147,7 @@ When not specified, SIP addresses are used when managing these lists. 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 Required: False Position: Named @@ -163,7 +168,7 @@ Categories, which are a collection of chat rooms, can be created by using the `N 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 Required: False Position: Named @@ -179,7 +184,7 @@ Prompts you for confirmation before executing the command. 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 @@ -195,7 +200,7 @@ Enables administrators to provide additional information about the new chat room 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 Required: False Position: Named @@ -212,7 +217,7 @@ If this parameter is not used then the new chat room will be enabled and availab 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 Required: False Position: Named @@ -228,7 +233,7 @@ Suppresses the display of any non-fatal error message that might arise when runn 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 Required: False Position: Named @@ -247,7 +252,7 @@ If set to Inherit, the room will use the Invitations setting specified for its C Type: ChatRoomInvitations 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 Required: False Position: Named @@ -288,7 +293,7 @@ To make all the users in a distribution list chat room managers, use the Active Type: System.Management.Automation.PSListModifier`1[System.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 Required: False Position: Named @@ -330,7 +335,7 @@ To make all the users in a distribution list chat room members, use the Active D Type: System.Management.Automation.PSListModifier`1[System.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 Required: False Position: Named @@ -347,7 +352,7 @@ Names must be unique per Persistent Chat pool. 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 Required: False Position: Named @@ -388,7 +393,7 @@ To make all the users in a distribution list chat room presenters, use the Activ Type: System.Management.Automation.PSListModifier`1[System.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 Required: False Position: Named @@ -409,7 +414,7 @@ Allowed values are: Type: ChatRoomPrivacy 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 Required: False Position: Named @@ -430,7 +435,7 @@ The default value is Normal. Type: ChatRoomType 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 Required: False Position: Named @@ -446,7 +451,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -456,7 +461,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -480,4 +485,3 @@ Instead, the `Set-CsPersistentChatRoom` cmdlet modifies existing instances of th [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatState.md b/skype/skype-ps/skype/Set-CsPersistentChatState.md index bae2f961a5..b0d38cefb9 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatState.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPersistentChatState @@ -55,7 +60,7 @@ Prompts you for confirmation before executing the command. 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 @@ -71,7 +76,7 @@ Suppresses the display of any non-fatal error message that might arise when runn 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 Required: False Position: Named @@ -90,7 +95,7 @@ For example: Type: XdsIdentity 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 Required: False Position: 2 @@ -106,7 +111,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance Aliases: -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 @@ -128,7 +133,7 @@ The default value is Normal. Type: PoolState 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 Required: False Position: Named @@ -144,7 +149,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -154,7 +159,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -174,4 +179,3 @@ Instead, the `Set-CsPersistentChatState` cmdlet modifies existing instances of t [Get-CsPersistentChatState](Get-CsPersistentChatState.md) [Set-CsPersistentChatActiveServer](Set-CsPersistentChatActiveServer.md) - diff --git a/skype/skype-ps/skype/Set-CsPinPolicy.md b/skype/skype-ps/skype/Set-CsPinPolicy.md index a0fc5c3d20..8432fb8fd2 100644 --- a/skype/skype-ps/skype/Set-CsPinPolicy.md +++ b/skype/skype-ps/skype/Set-CsPinPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPinPolicy @@ -332,7 +337,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -357,4 +362,3 @@ Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Manage [New-CsPinPolicy](New-CsPinPolicy.md) [Remove-CsPinPolicy](Remove-CsPinPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md index c189d06852..9bf4ba1881 100644 --- a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md @@ -1,14 +1,19 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPlatformServiceSettings schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsPlatformServiceSettings ## SYNOPSIS -Modifies the Skype for Business on Mac capabilites in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). +Modifies the Skype for Business on Mac capabilities in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). ## SYNTAX @@ -274,7 +279,7 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -288,8 +293,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsPresenceManagementState.md b/skype/skype-ps/skype/Set-CsPresenceManagementState.md index cca28725ca..863e995fa9 100644 --- a/skype/skype-ps/skype/Set-CsPresenceManagementState.md +++ b/skype/skype-ps/skype/Set-CsPresenceManagementState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPresenceManagementState @@ -239,7 +244,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -256,4 +261,3 @@ None. ## RELATED LINKS [Get-CsPresenceManagementState](Get-CsPresenceManagementState.md) - diff --git a/skype/skype-ps/skype/Set-CsPresencePolicy.md b/skype/skype-ps/skype/Set-CsPresencePolicy.md index 6717b22b07..b700f28738 100644 --- a/skype/skype-ps/skype/Set-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Set-CsPresencePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPresencePolicy @@ -260,7 +265,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -285,4 +290,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsPresencePolicy](New-CsPresencePolicy.md) [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsPresenceProvider.md b/skype/skype-ps/skype/Set-CsPresenceProvider.md index 3ac70e5e3a..253ee70774 100644 --- a/skype/skype-ps/skype/Set-CsPresenceProvider.md +++ b/skype/skype-ps/skype/Set-CsPresenceProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPresenceProvider @@ -141,7 +146,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ Instead, the `Set-CsPresenceProvider` cmdlet modifies existing instances of the [New-CsPresenceProvider](New-CsPresenceProvider.md) [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md index 7fd4424412..2cca0f6368 100644 --- a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csprivacyconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPrivacyConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsPrivacyConfiguration @@ -12,12 +17,11 @@ Modifies an existing set of privacy configuration settings. Privacy configuration settings help determine how much information users make available to other users. This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ### Identity (Default) ``` -Set-CsPrivacyConfiguration [-Tenant <Guid>] [-EnablePrivacyMode <Boolean>] +Set-CsPrivacyConfiguration [-EnablePrivacyMode <Boolean>] [-AutoInitiateContacts <Boolean>] [-PublishLocationDataDefault <Boolean>] [-DisplayPublishedPhotoDefault <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] @@ -25,7 +29,7 @@ Set-CsPrivacyConfiguration [-Tenant <Guid>] [-EnablePrivacyMode <Boolean>] ### Instance ``` -Set-CsPrivacyConfiguration [-Tenant <Guid>] [-EnablePrivacyMode <Boolean>] +Set-CsPrivacyConfiguration [-EnablePrivacyMode <Boolean>] [-AutoInitiateContacts <Boolean>] [-PublishLocationDataDefault <Boolean>] [-DisplayPublishedPhotoDefault <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] @@ -174,6 +178,7 @@ In advanced privacy mode, only people on your Contacts list will be allowed to v If False, your presence information will be available to anyone in your organization. The default value is False. +For information about privacy mode in Microsoft Teams, see [User presence in Teams](/microsoftteams/presence-admins). ```yaml Type: Boolean @@ -224,34 +229,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the privacy configuration settings 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: 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 -``` - ### -WhatIf Describes what would happen if you executed the command without actually executing the command. @@ -287,7 +264,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -310,4 +287,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsPrivacyConfiguration](New-CsPrivacyConfiguration.md) [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsProxyConfiguration.md b/skype/skype-ps/skype/Set-CsProxyConfiguration.md index ec6e1e57d2..9d347a53bc 100644 --- a/skype/skype-ps/skype/Set-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/Set-CsProxyConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsProxyConfiguration @@ -592,7 +597,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -615,4 +620,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsProxyConfiguration](New-CsProxyConfiguration.md) [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsPstnGateway.md b/skype/skype-ps/skype/Set-CsPstnGateway.md index 971616693f..652c120b20 100644 --- a/skype/skype-ps/skype/Set-CsPstnGateway.md +++ b/skype/skype-ps/skype/Set-CsPstnGateway.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPstnGateway @@ -261,7 +266,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -280,4 +285,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsPstnUsage.md b/skype/skype-ps/skype/Set-CsPstnUsage.md index d6f26665e5..d588c47094 100644 --- a/skype/skype-ps/skype/Set-CsPstnUsage.md +++ b/skype/skype-ps/skype/Set-CsPstnUsage.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPstnUsage @@ -174,7 +179,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -193,4 +198,3 @@ Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig. ## RELATED LINKS [Get-CsPstnUsage](Get-CsPstnUsage.md) - diff --git a/skype/skype-ps/skype/Set-CsPublicProvider.md b/skype/skype-ps/skype/Set-CsPublicProvider.md index a90eaee72d..4895b36792 100644 --- a/skype/skype-ps/skype/Set-CsPublicProvider.md +++ b/skype/skype-ps/skype/Set-CsPublicProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsPublicProvider @@ -212,7 +217,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -239,4 +244,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsPublicProvider](New-CsPublicProvider.md) [Remove-CsPublicProvider](Remove-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md index 817c241780..7a86381463 100644 --- a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPushNotificationConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsPushNotificationConfiguration @@ -244,7 +249,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -261,4 +266,3 @@ Instead, the `Set-CsPushNotificationConfiguration` cmdlet modifies existing inst ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsQoEConfiguration.md b/skype/skype-ps/skype/Set-CsQoEConfiguration.md index f24d3cf84e..257965025e 100644 --- a/skype/skype-ps/skype/Set-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/Set-CsQoEConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsQoEConfiguration @@ -284,7 +289,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -307,4 +312,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsQoEConfiguration](Remove-CsQoEConfiguration.md) [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsRegistrar.md b/skype/skype-ps/skype/Set-CsRegistrar.md index 310822b463..b304b0a075 100644 --- a/skype/skype-ps/skype/Set-CsRegistrar.md +++ b/skype/skype-ps/skype/Set-CsRegistrar.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRegistrar @@ -615,7 +620,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -634,4 +639,3 @@ Instead, the command modifies existing instances of the Microsoft.Rtc.Management ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md b/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md index 030d9c041d..42491be2c9 100644 --- a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRegistrarConfiguration @@ -388,7 +393,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -411,4 +416,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsRegistrarConfiguration](New-CsRegistrarConfiguration.md) [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsReportingConfiguration.md b/skype/skype-ps/skype/Set-CsReportingConfiguration.md index 7353c83ead..9e96050de2 100644 --- a/skype/skype-ps/skype/Set-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsReportingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsReportingConfiguration @@ -54,7 +59,7 @@ Set-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.l ``` The command shown in Example 1 modifies the reporting URL for the reporting configuration settings with the Identity service:MonitoringDatabase:atl-sql-002.litwareinc.com. -In this example, the reporting URL is changed to "https://atl-sql-002.litwareinc.com/lync_reports". +In this example, the reporting URL is changed to `https://atl-sql-002.litwareinc.com/lync_reports`. ## PARAMETERS @@ -160,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -182,4 +187,3 @@ Instead, the `Set-CsReportingConfiguration` cmdlet modifies existing instances o [New-CsReportingConfiguration](New-CsReportingConfiguration.md) [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md b/skype/skype-ps/skype/Set-CsRgsAgentGroup.md index 43680112b9..287057404c 100644 --- a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/Set-CsRgsAgentGroup.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRgsAgentGroup @@ -179,7 +184,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -202,4 +207,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsAgentGroup](New-CsRgsAgentGroup.md) [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsConfiguration.md b/skype/skype-ps/skype/Set-CsRgsConfiguration.md index 4779f1bf32..6114842831 100644 --- a/skype/skype-ps/skype/Set-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Set-CsRgsConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRgsConfiguration @@ -61,7 +66,7 @@ In turn, those computers are piped to the `ForEach-Object` cmdlet. ### -------------------------- Example 3 ------------------------ ``` -$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content (Get-Content C:\Media\WhileYouWait.wav -Encoding byte -ReadCount 0) +$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) Set-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -DefaultMusicOnHoldFile $x ``` @@ -71,13 +76,11 @@ To perform this task, the first command uses `Import-CsRgsAudioFile` to import t In addition to the Identity parameter (which specifies the service location), the FileName parameter is used to specify the file name of the file being imported. Equally important, the Content parameter is used to import the audio file. -File importing is carried out by calling the `Get-Content` cmdlet followed by the path to the file being imported. -`Get-Content` also requires you to set the encoding type to byte and the ReadCount to 0. -(Setting the ReadCount to 0 ensures that the entire file is read in a single operation). The imported file is then stored in a variable named $x. +File importing is carried out by using the `[System.IO.File]::ReadAllBytes` command with the path to the file being imported. +The imported file is then stored in a variable named $x. After the file has been imported, `Set-CsRgsConfiguration` is called in order to set the DefaultMusicOnHoldFile property to the audio file stored in $x. - ## PARAMETERS ### -Identity @@ -225,7 +228,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -246,4 +249,3 @@ Instead, the cmdlet configures existing instances of the Microsoft.Rtc.Rgs.Manag [Get-CsRgsConfiguration](Get-CsRgsConfiguration.md) [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md b/skype/skype-ps/skype/Set-CsRgsHolidaySet.md index 6f3c647439..479d34c95d 100644 --- a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/Set-CsRgsHolidaySet.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRgsHolidaySet @@ -179,7 +184,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -204,4 +209,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md index aec1ce62bd..2357b448fd 100644 --- a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRgsHoursOfBusiness @@ -173,7 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -197,4 +202,3 @@ Modifies existing instances of the Microsoft.Rtc.Rgs.Management.WriteableSetting [New-CsRgsTimeRange](New-CsRgsTimeRange.md) [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsQueue.md b/skype/skype-ps/skype/Set-CsRgsQueue.md index d643249c6c..4fbf3f12e4 100644 --- a/skype/skype-ps/skype/Set-CsRgsQueue.md +++ b/skype/skype-ps/skype/Set-CsRgsQueue.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRgsQueue @@ -156,7 +161,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -179,4 +184,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsQueue](New-CsRgsQueue.md) [Remove-CsRgsQueue](Remove-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsWorkflow.md b/skype/skype-ps/skype/Set-CsRgsWorkflow.md index 5c5fefc776..2a4c7f6b0e 100644 --- a/skype/skype-ps/skype/Set-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/Set-CsRgsWorkflow.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRgsWorkflow @@ -78,7 +83,9 @@ After the description has been changed, command 3 uses the `Set-CsRgsWorkflow` t ### -------------------------- Example 3 ------------------------ ``` -$musicFile = Get-Content -ReadCount 0 -Encoding Byte C:\MediaFiles\Hold.wav | Import-CsRgsAudioFile -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -FileName "HelpDeskHoldMusic.wav" +$musicFile = [System.IO.File]::ReadAllBytes('C:\MediaFiles\Hold.wav') | Import-CsRgsAudioFile -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -FileName "HelpDeskHoldMusic.wav" + + $y = Get-CsRgsWorkflow -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -89,7 +96,7 @@ Set-CsRgsWorkflow -Instance $y The commands shown in Example 3 import a new Response Group audio file, then assign this audio file to an existing workflow. To do this, the first command in the example imports the new audio file. -This is done by calling the `Get-Content` cmdlet in order to read in the audio file (C:\MediaFiles\Hold.wav) byte-by-byte; to ensure that the audio file is read in correctly, you must include the ReadCount parameter (set to 0) and the Encoding parameter (set to Byte). +This is done by using the `[System.IO.File]::ReadAllBytes` command in order to read in the audio file (C:\MediaFiles\Hold.wav) byte-by-byte. After the audio file has been read in, the data is piped to `New-CsRgsAudioFile`, which creates a new file on ApplicationServer:atl-cs-001.litwareinc.com. An object reference to this file (which has the name HelpDeskHoldMusic.wav), is stored in a variable named $musicFile. @@ -176,7 +183,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -199,4 +206,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsWorkflow](New-CsRgsWorkflow.md) [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md b/skype/skype-ps/skype/Set-CsRoutingConfiguration.md index 3e9b775f41..5a2141d994 100644 --- a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsRoutingConfiguration @@ -210,7 +215,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -239,4 +244,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Get-CsVoiceRoute](Get-CsVoiceRoute.md) [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsServerApplication.md b/skype/skype-ps/skype/Set-CsServerApplication.md index a46f407269..96b56c6e53 100644 --- a/skype/skype-ps/skype/Set-CsServerApplication.md +++ b/skype/skype-ps/skype/Set-CsServerApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsServerApplication @@ -169,7 +174,7 @@ Accept wildcard characters: False ### -Uri Unique Uniform Resource Identifier (URI) for the application. -For example, the QoEAgent application has the URI http://www.microsoft.com/LCS/QoEAgent. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml Type: String @@ -258,7 +263,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -281,4 +286,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsServerApplication](New-CsServerApplication.md) [Remove-CsServerApplication](Remove-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md index 269be432ea..c34fbf16bf 100644 --- a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsSimpleUrlConfiguration @@ -30,12 +35,12 @@ Set-CsSimpleUrlConfiguration [-Instance <PSObject>] [-SimpleUrl <PSListModifier> ## DESCRIPTION In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Microsoft Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -89,10 +94,10 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` Example 2 shows how a new URL can be added to an existing collection of simple URLs. -To begin with, the first command in the example uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To begin with, the first command in the example uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. In the second command, the `New-CsSimpleUrl` cmdlet is used to create an in-memory-only instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com` and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. After the URL has been created (and stored in the object reference $simpleUrl) the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the `Set-CsSimpleUrlConfiguration` cmdlet, the SimpleUrl parameter and the parameter value @{Add=$simpleUrl}. @@ -110,10 +115,10 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Remove=$simpl The commands shown in Example 3 demonstrate how you can delete a single URL from a simple URL collection. Because the `Set-CsSimpleUrlConfiguration` cmdlet needs to work with URL objects, the example starts by creating a new object that contains the exact same property values as the URL to be deleted. -To do that, the first command uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To do that, the first command uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. After the URL entry has been created, the second command uses the `New-CsSimpleUrl` cmdlet to create an in-memory instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com; and the SimpleUrl property is set to $urlEntry, $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com`; and the SimpleUrl property is set to $urlEntry, $urlEntry being the URL entry created in the first command. This creates an in-memory URL ($simpleUrl) that has the same property values as the URL to be deleted. The final command in the example then deletes the URL from the simple URL collection for the Redmond site. @@ -256,7 +261,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -282,4 +287,3 @@ None. [New-CsSimpleUrlEntry](New-CsSimpleUrlEntry.md) [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsSipDomain.md b/skype/skype-ps/skype/Set-CsSipDomain.md index 45992d8ffa..dc43ae35bf 100644 --- a/skype/skype-ps/skype/Set-CsSipDomain.md +++ b/skype/skype-ps/skype/Set-CsSipDomain.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsSipDomain @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -157,4 +162,3 @@ Instead, the cmdlet is used to modify existing instances of the Microsoft.Rtc.Ma [New-CsSipDomain](New-CsSipDomain.md) [Remove-CsSipDomain](Remove-CsSipDomain.md) - diff --git a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md index 99a9ef4619..8709e8d4e9 100644 --- a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsSipResponseCodeTranslationRule @@ -237,7 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -260,4 +265,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableC [New-CsSipResponseCodeTranslationRule](New-CsSipResponseCodeTranslationRule.md) [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsSite.md b/skype/skype-ps/skype/Set-CsSite.md index b94fb84d43..b5779296c3 100644 --- a/skype/skype-ps/skype/Set-CsSite.md +++ b/skype/skype-ps/skype/Set-CsSite.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsSite @@ -227,7 +232,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -246,4 +251,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Deploy.In ## RELATED LINKS [Get-CsSite](Get-CsSite.md) - diff --git a/skype/skype-ps/skype/Set-CsSlaConfiguration.md b/skype/skype-ps/skype/Set-CsSlaConfiguration.md index 96dd1cce77..17fb0a02a8 100644 --- a/skype/skype-ps/skype/Set-CsSlaConfiguration.md +++ b/skype/skype-ps/skype/Set-CsSlaConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSlaConfiguration schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsSlaConfiguration @@ -122,7 +127,7 @@ Accept wildcard characters: False ``` ### -MissedCallForwardTarget -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 sintax: +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:\<PhoneNumber\> * sip:\<NameofDelegate@domain\> @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### -Target -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 sintax: +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:\<PhoneNumber\> * sip:\<NameofDelegate@domain\> @@ -210,7 +215,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -219,7 +224,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/get-csslaconfiguration?view=skype-ps) - -[Remove-CsSlaConfiguration](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Remove-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md index 333dbcbb00..e573931e83 100644 --- a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsStaticRoutingConfiguration @@ -203,7 +208,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -228,4 +233,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md index 7a6dcbc143..e8dde2d1fe 100644 --- a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsStorageServiceConfiguration @@ -207,7 +212,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -229,4 +234,3 @@ The `Set-CsStorageServiceConfiguration` cmdlet does not return any data or objec [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md deleted file mode 100644 index aa6b8c757c..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online -title: Set-CsTeamsCallingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsCallingPolicy - -## SYNOPSIS - -Use this cmdlet to update values in existing Teams Calling Policies. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsCallingPolicy [-Tenant <Guid>] [-AllowCalling <Boolean>] [-AllowPrivateCalling <Boolean>] - [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsCallingPolicy [-Tenant <Guid>] [-AllowCalling <Boolean>] [-AllowPrivateCalling <Boolean>] - [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Teams Calling Policies designate which users are able to use calling functionality within teams and determine the interopability state with Skype for Business. This cmdlet allows admins to set values in a given calling policy - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsCallingPolicy -Identity Global -AllowPrivateCalling $true -``` - -Sets the value of the parameter AllowPrivateCalling, which controls whether or not users can leverage calling functionality in Microsoft Teams, in the global (default) tenant CallingPolicy -## PARAMETERS - -### -AllowCalling -Controls interop calling capabilities. Turning this on will allow Skype for Business users to have one-on-one calls with Teams users and vice-versa. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateCalling -controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy being modified. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Internal Microsoft use - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMeetingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMeetingConfiguration.md deleted file mode 100644 index 4b7de3e4b8..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMeetingConfiguration.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online -title: Set-CsTeamsGuestMeetingConfiguration -schema: 2.0.0 ---- - -# Set-CsTeamsGuestMeetingConfiguration - -## SYNOPSIS - -Designates what meeting features guests using Microsoft Teams will have available. Use this cmdlet to set the configuration. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsGuestMeetingConfiguration [-Tenant <Guid>] [-AllowIPVideo <Boolean>] - [-ScreenSharingMode <String>] [-AllowMeetNow <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsGuestMeetingConfiguration [-Tenant <Guid>] [-AllowIPVideo <Boolean>] - [-ScreenSharingMode <String>] [-AllowMeetNow <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION - -The TeamsGuestMeetingConfiguration designates which meeting features guests leveraging Microsoft Teams will have available. This configuration will apply to all guests utilizing Microsoft Teams. Use the Set-CsTeamsGuestMeetingConfiguration cmdlet to designate what values are set for your organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsGuestMeetingConfiguration -Identity Global -AllowMeetNow $false -AllowIPVideo $false -``` - -Disables Guests' usage of MeetNow and Video calling in the organization; all other values of the configuration are left as is. - -## PARAMETERS - -### -AllowIPVideo -Determines whether video is enabled in  a user's meetings or calls. Set this to TRUE to allow guests to share their video. Set this to FALSE to prohibit guests from sharing their video - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetNow -Determines whether guests can start ad-hoc meetings. Set this to TRUE to allow guests to start ad-hoc meetings. Set this to FALSE to prohibit guests from starting ad-hoc meetings.  - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all non fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The only input allowed is "Global" - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Pipe the existing configuration from a Get- call. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScreenSharingMode -Determines the mode in which guests can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an  application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md deleted file mode 100644 index bf9211f77e..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTeamsGuestMessagingConfiguration -schema: 2.0.0 ---- - -# Set-CsTeamsGuestMessagingConfiguration - -## SYNOPSIS -TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [-AllowUserEditMessage <Boolean>] - [-AllowUserDeleteMessage <Boolean>] [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] - [-GiphyRatingType <String>] [-AllowMemes <Boolean>] [-AllowStickers <Boolean>] [[-Identity] <XdsIdentity>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [-AllowUserEditMessage <Boolean>] - [-AllowUserDeleteMessage <Boolean>] [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] - [-GiphyRatingType <String>] [-AllowMemes <Boolean>] [-AllowStickers <Boolean>] [-Instance <PSObject>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet lets you update the guest messaging options you'd like to enable in your organization. - -## EXAMPLES - -### Example 1 -``` -Set-CsTeamsGuestMessagingConfiguration -AllowMemes $False -``` - -The command shown in Example 1 disables memes usage by guests within Teams. - -## PARAMETERS - -### -AllowGiphy -Determines if Giphy images are available. - -```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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickers -Determines if stickers are available for use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserChat -Determines if a user is allowed to chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessage -Determines if a user is allowed to delete their own messages. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserEditMessage -Determines if a user is allowed to edit their own messages. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the 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 - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyRatingType -Determines Giphy content restrictions. Default value is "Moderate", other option is "Strict" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md deleted file mode 100644 index 76900fe94a..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Set-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 ---- - - -# Set-CsTeamsMeetingBroadcastPolicy - -## SYNOPSIS -Set-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \<XdsIdentity\>\] \[-Tenant \<guid\>\] \[-Description \<string\>\] \[-AllowBroadcastScheduling \<bool\>\] \[-AllowBroadcastTranscription \<bool\>\] \[-BroadcastAttendeeVisibilityMode \<string\>\] \[-BroadcastRecordingMode \<string\>\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] - -Set-CsTeamsMeetingBroadcastPolicy \[-Tenant \<guid\>\] \[-Description \<string\>\] \[-AllowBroadcastScheduling \<bool\>\] \[-AllowBroadcastTranscription \<bool\>\] \[-BroadcastAttendeeVisibilityMode \<string\>\] \[-BroadcastRecordingMode \<string\>\] \[-Instance \<psobject\>\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Description <String>] - [-AllowBroadcastScheduling <Boolean>] [-AllowBroadcastTranscription <Boolean>] - [-BroadcastAttendeeVisibilityMode <String>] [-BroadcastRecordingMode <String>] [[-Identity] <XdsIdentity>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Description <String>] - [-AllowBroadcastScheduling <Boolean>] [-AllowBroadcastTranscription <Boolean>] - [-BroadcastAttendeeVisibilityMode <String>] [-BroadcastRecordingMode <String>] [-Instance <PSObject>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer.  Use this cmdlet to update an existing policy. - - -## EXAMPLES -### Example 1 -```powershell -PS C:\> Set-CsTeamsMeetingBroadcastPolicy -Identity Global -AllowBroadcastScheduling $false -``` - -Sets the value of the Default (Global) Broadcast Policy in the organization to disable broadcast scheduling, and leaves all other parameters the same. - -## PARAMETERS - -### -AllowBroadcastScheduling -Specifies whether this user can create broadcast events in Teams.  This settng impacts broadcasts that use both self-service and external encoder production methods.  - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBroadcastTranscription -Specifies whether real-time transcription and translation can be enabled in the broadcast event.  Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastAttendeeVisibilityMode -Specifies the attendee visibility mode of the broadcast events created by this user.  This setting controls who can watch the broadcast event - e.g. anyone can watch this event including anonymous users or only authenticated users in my company can watch the event.  Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastRecordingMode -Specifies whether broadcast events created by this user are always recorded, never recorded or user can choose whether to record or not.  Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. - - -```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 about the conferencing policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: ObjStringect -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might 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 -Unique identifier for the policy to be modified. Policies can be configured at the global or per-user scopes. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity SalesPolicy. - -Note that wildcards are not allowed when specifying an Identity. If you do not specify an Identity the 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 -``` - -### -Tenant -Not applicable to online service. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsMeetingConfiguration.md deleted file mode 100644 index 3cb4a5df62..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingConfiguration.md +++ /dev/null @@ -1,361 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online -title: Set-CsTeamsMeetingConfiguration -schema: 2.0.0 ---- - - -# Set-CsTeamsMeetingConfiguration - -## SYNOPSIS - -The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants.  - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsMeetingConfiguration [-Tenant <Guid>] [-LogoURL <String>] [-LegalURL <String>] - [-HelpURL <String>] [-CustomFooterText <String>] [-DisableAnonymousJoin <Boolean>] [-EnableQoS <Boolean>] - [-ClientAudioPort <UInt32>] [-ClientAudioPortRange <UInt32>] [-ClientVideoPort <UInt32>] - [-ClientVideoPortRange <UInt32>] [-ClientAppSharingPort <UInt32>] [-ClientAppSharingPortRange <UInt32>] - [-ClientMediaPortRangeEnabled <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsMeetingConfiguration [-Tenant <Guid>] [-LogoURL <String>] [-LegalURL <String>] - [-HelpURL <String>] [-CustomFooterText <String>] [-DisableAnonymousJoin <Boolean>] [-EnableQoS <Boolean>] - [-ClientAudioPort <UInt32>] [-ClientAudioPortRange <UInt32>] [-ClientVideoPort <UInt32>] - [-ClientVideoPortRange <UInt32>] [-ClientAppSharingPort <UInt32>] [-ClientAppSharingPortRange <UInt32>] - [-ClientMediaPortRangeEnabled <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants.  Use this cmdlet to set the configuration for your organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsMeetingConfiguration -EnableQoS $true -ClientVideoPort 10000 -Identity Global -``` - -In this example, the user is enabling collection of QoS data in his organization and lowering the video stream quality to accommodate low bandwidth networks. - -## PARAMETERS - -### -ClientAppSharingPort -Determines the starting port number for client screen sharing or application sharing. -Minimum allowed value: 1024 -Maximum allowed value: 65535 -Default value: 50040 - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAppSharingPortRange -Determines the total number of ports available for client sharing or application sharing. Default value is 20 - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAudioPort -Determines the starting port number for client audio. -Minimum allowed value: 1024 -Maximum allowed value: 65535 -Default value: 50000 - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAudioPortRange -Determines the total number of ports available for client audio. Default value is 20 - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientMediaPortRangeEnabled -Determines whether custom media port and range selections need to be enforced. When set to True, clients will use the specified port range for media traffic. When set to False (the default value) for any available port (from port 1024 through port 65535) will be used to accommodate media traffic. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientVideoPort -Determines the starting port number for client video. -Minimum allowed value: 1024 -Maximum allowed value: 65535 -Default value: 50020 - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientVideoPortRange -Determines the total number of ports available for client video. Default value is 20 - - -```yaml -Type: UInt32 -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 -``` - -### -CustomFooterText -Text to be used on custom meeting invitations - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAnonymousJoin -Determines whether anonymous users are blocked from joining meetings in the tenant. Set this to TRUE to block anonymous users from joining. Set this to FALSE to allow anonymous users to join meetings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableQoS -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: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The only valid input is Global - -```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 parameter to update a saved configuration instance - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -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 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md deleted file mode 100644 index c9f060c2d3..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ /dev/null @@ -1,444 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTeamsMeetingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsMeetingPolicy - -## SYNOPSIS - The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsMeetingPolicy [-Tenant <Guid>] [-Description <String>] - [-AllowChannelMeetingScheduling <Boolean>] [-AllowMeetNow <Boolean>] [-AllowIPVideo <Boolean>] - [-AllowAnonymousUsersToDialOut <Boolean>] [-AllowAnonymousUsersToStartMeeting <Boolean>] - [-AllowPrivateMeetingScheduling <Boolean>] [-AutoAdmittedUsers <String>] [-AllowCloudRecording <Boolean>] - [-AllowOutlookAddIn <Boolean>] [-AllowPowerPointSharing <Boolean>] - [-AllowParticipantGiveRequestControl <Boolean>] [-AllowExternalParticipantGiveRequestControl <Boolean>] - [-AllowSharedNotes <Boolean>] [-AllowWhiteboard <Boolean>] [-AllowTranscription <Boolean>] - [-MediaBitRateKb <UInt32>] [-ScreenSharingMode <String>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsMeetingPolicy [-Tenant <Guid>] [-Description <String>] - [-AllowChannelMeetingScheduling <Boolean>] [-AllowMeetNow <Boolean>] [-AllowIPVideo <Boolean>] - [-AllowAnonymousUsersToDialOut <Boolean>] [-AllowAnonymousUsersToStartMeeting <Boolean>] - [-AllowPrivateMeetingScheduling <Boolean>] [-AutoAdmittedUsers <String>] [-AllowCloudRecording <Boolean>] - [-AllowOutlookAddIn <Boolean>] [-AllowPowerPointSharing <Boolean>] - [-AllowParticipantGiveRequestControl <Boolean>] [-AllowExternalParticipantGiveRequestControl <Boolean>] - [-AllowSharedNotes <Boolean>] [-AllowWhiteboard <Boolean>] [-AllowTranscription <Boolean>] - [-MediaBitRateKb <UInt32>] [-ScreenSharingMode <String>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users - -The Set-CsTeamsMeetingPolicy cmdlet allows administrators to update existing meeting policies that can be assigned to particular users to control Teams features related to meetings. -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` - -Set-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $false -``` - -The command shown in Example 1 uses the Set-CsTeamsMeetingPolicy cmdlet to update an existing meeting policy with the Identity SalesMeetingPolicy. -This policy will use all the existing values except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. - - -### -------------------------- EXAMPLE 2 -------------------------- -``` - -Set-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False -``` - -In Example 2, the Set-CsTeamsMeetingPolicy cmdlet is used to update a meeting policy with the Identity HrMeetingPolicy. -In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. -All other policy properties will use the existing values. - - -## PARAMETERS - -### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymousUsersToStartMeeting -Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -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  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCloudRecording -Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowExternalParticipantGiveRequestControl -Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowIPVideo -Determines whether video is enabled in  a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings.  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOutlookAddIn -Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPowerPointSharing -Determines whether Powerpoint sharing is allowed in a user’s meetings. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user  - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSharedNotes -Determines whether users are allowed to take shared notes.  Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTranscription -Determines whether real-time and/or post-meeting captions and transcriptions are allowed in a user's meetings.  Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowWhiteboard -Determines whether whiteboard is allowed in a user’s meetings. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -AutoAdmittedUsers -Determines what types of participants will automatically be added to meetings organized by this user. Set this to EveryoneInCompany  if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. Set this to Everyone if you'd like to admit anonymous users by default. Set this to EveryoneInSameAndFederatedCompany if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. This setting also applies to participants joining via a PSTN device (i.e. a traditional phone) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the meeting policy. -For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Specify the name of the policy being modified. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings  - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScreenSharingMode -Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an  application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md deleted file mode 100644 index d8e92570f8..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTeamsMessagingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsMessagingPolicy - -## SYNOPSIS -The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsMessagingPolicy [-Tenant <Guid>] [-Description <String>] [-AllowUrlPreviews <Boolean>] - [-AllowOwnerDeleteMessage <Boolean>] [-AllowUserEditMessage <Boolean>] [-AllowUserDeleteMessage <Boolean>] - [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] [-GiphyRatingType <String>] [-AllowMemes <Boolean>] - [-AllowStickers <Boolean>] [-AllowUserTranslation <Boolean>] [-ReadReceiptsEnabledType <String>] - [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTeamsMessagingPolicy [-Tenant <Guid>] [-Description <String>] [-AllowUrlPreviews <Boolean>] - [-AllowOwnerDeleteMessage <Boolean>] [-AllowUserEditMessage <Boolean>] [-AllowUserDeleteMessage <Boolean>] - [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] [-GiphyRatingType <String>] [-AllowMemes <Boolean>] - [-AllowStickers <Boolean>] [-AllowUserTranslation <Boolean>] [-ReadReceiptsEnabledType <String>] - [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet updates a Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. - - -## EXAMPLES - -### Example 1 -``` -powershell -PS C:\> Set-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false -``` - -In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. -All other policy properties will be left as previously assigned - -### Example 2 -``` -powershell -PS C:\> Get-CsTeamsMessagingPolicy | Set-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false -``` - -In this example two different property values are configured for all teams messaging policies in the organization: AllowGiphy is set to false and AllowMemes is set to False. -All other policy properties will be left as previously assigned - - -## PARAMETERS - -### -AllowGiphy -Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMemes -Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOwnerDeleteMessage -Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickers -Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserChat -Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessage -Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserEditMessage -Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserTranslation -Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of your policy to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyRatingType -Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity TeamsMessagingPolicy. - -If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance - -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md index ef356a1692..c8556d260f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +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 +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsTeamsUpgradeConfiguration @@ -175,4 +180,4 @@ These settings are only honored by newer versions of Skype for Business clients. [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md index 275e940184..86e0f3e376 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md @@ -1,55 +1,65 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness -online version: -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradepolicy +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTeamsUpgradePolicy schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Set-CsTeamsUpgradePolicy ## SYNOPSIS -In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables adminstrators to control whether users see a notification in their Skype for Business client of a pending upgrade to Teams. In addition, when this policy is assigned to a user, administrators can optionally have Win32 versions of Skype for Business clients silently download the Teams app based on the value of TeamsUpgradeConfiguration. + +In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables administrators to control whether users see a notification in their Skype for Business client of a pending upgrade to Teams. In addition, when this policy is assigned to a user, administrators can optionally have Win32 versions of Skype for Business clients silently download the Teams app based on the value of TeamsUpgradeConfiguration. ## SYNTAX ### Identity (Default) + ``` Set-CsTeamsUpgradePolicy [-Tenant <Guid>] [-Description <String>] [-NotifySfbUsers <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ### Instance + ``` Set-CsTeamsUpgradePolicy [-Tenant <Guid>] [-Description <String>] [-NotifySfbUsers <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION -In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables adminstrators to control whether users see a notification of a pending upgrade to Teams in their Skype for Business client. The Set-CsTeamsUpgradePolicy lets the adminstrator modify an existing instance of TeamsUpgradePolicy for users homed in Skype for Business on-premises. Notifications are enabled by the boolean parameter NotifySfBUsers. - -For users with Win32 versions of Skype for Business, if DownloadTeams=true in TeamsUpgradeConfiguration, users who are assigned an instance of TeamsUpgradePolicy with NotifySfBUsers=true will have Teams automatically downloaded in the background. +**NOTE**: This cmdlet is only relevant for Skype for Business Server 2019. It does not apply for Skype for Business Online. + +In on-premises deployments of Skype for Business Server, TeamsUpgradePolicy enables administrators to control whether users see a notification of a pending upgrade to Teams in their Skype for Business client. The Set-CsTeamsUpgradePolicy lets the administrator modify an existing instance of TeamsUpgradePolicy for users homed in Skype for Business on-premises. Notifications are enabled by the boolean parameter NotifySfBUsers. + +For users with Win32 versions of Skype for Business, if DownloadTeams=true in TeamsUpgradeConfiguration, users who are assigned an instance of TeamsUpgradePolicy with NotifySfBUsers=true will have Teams automatically downloaded in the background. -Notes: -* Instances of TeamsUpgradePolicy created in on-premises will not apply to any users that are already homed online. -* Office 365 already provides built-in instances of TeamsUpgradePolicy, so there is no New-CsTeamsUpgradePolicy cmdlet for the online environment by design. +Notes: +- Instances of TeamsUpgradePolicy created in on-premises will not apply to any users that are already homed online. +- Office 365 already provides built-in instances of TeamsUpgradePolicy, so there is no Set-CsTeamsUpgradePolicy cmdlet for the online environment by design. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> Set-CsTeamsUpgradePolicy -Identity Site:Redmond1 -NotifySfbUsers $false +Set-CsTeamsUpgradePolicy -Identity Site:Redmond1 -NotifySfbUsers $false ``` -This disables notifications for users in the Redmond1 site. +This disables notifications for users in the Redmond1 site. ## PARAMETERS - ### -Description -Free form text that can be used by administrators as desired. + +Free form text that can be used by administrators as desired. ```yaml Type: String @@ -63,10 +73,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - ### -Identity -The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:<name>" where <name> is the name of the site. To specfiy any other policy provide the name of that policy. + +The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\<name>" where \<name> is the name of the site. To specify any other policy provide the name of that policy. ```yaml Type: XdsIdentity @@ -80,8 +89,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -NotifySfbUsers + If true, users with this policy see a notification in their Skype for Business client indicating that Teams is coming soon. ```yaml @@ -97,6 +106,7 @@ Accept wildcard characters: False ``` ### -Tenant + {{Fill Tenant Description}} ```yaml @@ -111,16 +121,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object @@ -129,18 +138,18 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/en-us/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) -[Grant-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md) +[Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Get-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md) +[Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) -[New-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md) +[New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) -[Remove-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md) +[Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) -[Set-CsTeamsUpgradePolicy](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md) +[Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) -[Get-CsTeamsUpgradeConfiguration](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md) +[Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) -[Set-CsTeamsUpgradeConfiguration](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md) +[Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) diff --git a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md b/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md index 4c0783faf3..8a7a2ec48f 100644 --- a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTelemetryConfiguration @@ -26,7 +31,7 @@ Set-CsTelemetryConfiguration [-Confirm] [-EnableClientTelemetry <Boolean>] [-For ``` ## DESCRIPTION -For privacy information, see the Skype for Business Privacy Statement (http://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). +For privacy information, see the Skype for Business Privacy Statement (https://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409). ## EXAMPLES @@ -150,7 +155,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ None ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTenantDialPlan.md b/skype/skype-ps/skype/Set-CsTenantDialPlan.md deleted file mode 100644 index 77e9506d32..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantDialPlan.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTenantDialPlan -schema: 2.0.0 ---- - -# Set-CsTenantDialPlan - -## SYNOPSIS -Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTenantDialPlan [-Tenant <Guid>] [-Description <String>] [-NormalizationRules <List>] - [-ExternalAccessPrefix <String>] [-SimpleName <String>] [-OptimizeDeviceDialing <Boolean>] - [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTenantDialPlan [-Tenant <Guid>] [-Description <String>] [-NormalizationRules <List>] - [-ExternalAccessPrefix <String>] [-SimpleName <String>] [-OptimizeDeviceDialing <Boolean>] - [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The `Set-CsTenantDialPlan` cmdlet modifies an existing tenant dial plan. -Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. -The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. - -Although normalization rules of a tenant dial plan can be added by using this cmdlet, it is recommended that you use the `New-CsVoiceNormalizationRule` (https://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet instead. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9 -``` - -This example updates the vt1tenantDialPlan9 tenant dial plan to use an external access prefix of 123. - - -### -------------------------- Example 2 -------------------------- -``` -$nr2 = Get-CsVoiceNormalizationRule -Identity Global/NR2 - -Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9 -NormalizationRules @{Add=$nr2} -``` - -This example updates the vt1tenantDialPlan9 tenant dial plan to have an external access prefix of 123 and use the Global/NR2 normalization rules. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. -Maximum characters is 512. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccessPrefix -The ExternalAccessPrefix parameter is a number (or set of numbers) that designates the call as external to the organization. -(For example, to tenant-dial an outside line, first dial 9). This prefix is ignored by the normalization rules, although these rules will be applied to the rest of the number. -The OptimizeDeviceDialing parameter must be set to True for this value to take effect. - -The value of this parameter must match the regular expression \[0-9\]{1,4}. -This means it must be a value one to four digits in length, with each digit being a number 0 through 9. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter is a unique identifier that designates the scope, or for per-user plans a name, to identify the tenant dial plan to modify. -For example, a site Identity is in the format site:\<sitename\>, where sitename is the name of the site. -A tenant dial plan at the service scope is a Registrar or PSTN gateway service, where the Identity value is formatted in this way: Registrar:Redmond.litwareinc.com. -A per-user Identity is a unique string value. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantDialPlan` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NormalizationRules -The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the `New-CsVoiceNormalizationRule` (https://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. - -The number of normalization rules cannot exceed 25 per TenantDialPlan. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptimizeDeviceDialing -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleName -The SimpleName parameter is a display name for the tenant dial plan. -This name must be unique among all tenant dial plans within the Skype for Business Server deployment. - -This string can be up to 256 characters long. -Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md b/skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md deleted file mode 100644 index f64ac682f2..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTenantFederationConfiguration -schema: 2.0.0 ---- - -# 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 - -### Identity (Default) -``` -Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>] - [-BlockedDomains <List>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] - [-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>] - [-AllowedDomainsAsAList <List>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>] - [-BlockedDomains <List>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] - [-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>] - [-AllowedDomainsAsAList <List>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -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: - -Whether or not users can communicate with people from other domains and if so, which domains they are allowed to communicate with. - -Whether or not users can communicate with people who have accounts on public IM and presence providers such as Windows Live, AOL and Yahoo. - -Administrators can use the `Set-CsTenantFederationConfiguration` cmdlet to enable and disable federation with other domains and federation with public providers. -In addition, this cmdlet can be used to expressly indicate the domains that users can communicate with and/or the domains that users are not allowed to communicate with. -However, administrators must use the `Set-CsTenantPublicProvider` cmdlet in order to indicate the public IM and presence providers that users can and cannot communicate with. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsTenantFederationConfiguration -AllowPublicUsers $False -``` - -The command shown in Example 1 disables communication with public providers for the current tenant. - - -### -------------------------- Example 2 -------------------------- -``` -$x = New-CsEdgeDomainPattern "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. -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 -------------------------- -``` -$x = New-CsEdgeDomainPattern "fabrikam.com" - -Set-CsTenantFederationConfiguration -BlockedDomains @{Remove=$x} -``` - -The commands shown in Example 3 remove fabrikam.com from the list of domains blocked by the current tenant. -To do this, the first command in the example uses the `New-CsEdgeDomainPattern` cmdlet to create a domain object for fabrikam.com. -The resulting domain object is then stored in a variable named $x. - -The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Remove method to remove fabrikam.com from the blocked domains list for the specified tenant. - - -### -------------------------- Example 4 -------------------------- -``` -$x = New-CsEdgeDomainPattern "fabrikam.com" - -Set-CsTenantFederationConfiguration -BlockedDomains @{Add=$x} -``` - -The commands shown in Example 4 add the domain fabrikam.com to the list of domains blocked by the current tenant. -To add a new blocked domain, the first command in the example uses the `New-CsEdgeDomainPattern` cmdlet to create a domain object for fabrikam.com. -This object is stored in a variable named $x. - -After the domain object has been created, the second command then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Add method to add fabrikam.com to any domains already on the blocked domains list. - - -### -------------------------- Example 5 -------------------------- -``` -Set-CsTenantFederationConfiguration -BlockedDomains $Null -``` - -Example 5 shows how you can remove all the domains assigned to the blocked domains list for the current tenant. -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. - - -## PARAMETERS - -### -AllowedDomains -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. - -Note that string values cannot be passed directly to the AllowedDomains parameter. -Instead, you must create an object reference using the `New-CsEdgeAllowList` cmdlet or the `New-CsEdgeAllowAllKnownDomains` cmdlet and then use the object reference variable as the parameter value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPublicUsers -When set to True (the default value) users will be potentially allowed to communicate with users who have accounts on public IM and presence providers such as Windows Live, Yahoo, and AOL. -The collection of public providers that users can actually communicate with is managed by using the `Set-CsTenantPublicProvider` cmdlet. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the collection of tenant federation configuration settings to be modified. -Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the `Set-CsTenantFederationConfiguration` cmdlet. -If you do choose to use the Identity parameter you must also include the Tenant parameter. -For example: - -`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -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 - -Required: False -Position: Named -Default value: None -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 gave have different SIP domains. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -The `Set-CsTenantFederationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object. - -## OUTPUTS - -### -None. -Instead, the `Set-CsTenantFederationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object. - -## NOTES - -## RELATED LINKS - -[Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) - -[Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md b/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md index 3f97db8b8c..ca249562b2 100644 --- a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsTenantHybridConfiguration @@ -11,6 +16,8 @@ schema: 2.0.0 Used in a hybrid scenario to give users homed on Skype for Business Online access to on-premises Enterprise Voice features such as media bypass, Enhanced 9-1-1, and call parking. A hybrid scenario (also known as a split-domain scenario) is a deployment in which some users have accounts homed on-premises while other users have accounts homed on Skype for Business Online. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ### Identity (Default) @@ -236,7 +243,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -254,4 +261,3 @@ None. ## RELATED LINKS [Get-CsTenantHybridConfiguration](Get-CsTenantHybridConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md b/skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md deleted file mode 100644 index 991bbdc1fa..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTenantMigrationConfiguration -schema: 2.0.0 ---- - -# Set-CsTenantMigrationConfiguration - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTenantMigrationConfiguration [-Tenant <Guid>] [-MeetingMigrationEnabled <Boolean>] - [-ACPMeetingMigrationTriggerEnabled <Boolean>] - [-MeetingMigrationSourceMeetingTypes <MeetingMigrationSourceMeetingTypes>] - [-MeetingMigrationTargetMeetingTypes <MeetingMigrationTargetMeetingTypes>] [[-Identity] <XdsIdentity>] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Instance -``` -Set-CsTenantMigrationConfiguration [-Tenant <Guid>] [-MeetingMigrationEnabled <Boolean>] - [-ACPMeetingMigrationTriggerEnabled <Boolean>] - [-MeetingMigrationSourceMeetingTypes <MeetingMigrationSourceMeetingTypes>] - [-MeetingMigrationTargetMeetingTypes <MeetingMigrationTargetMeetingTypes>] [-Instance <PSObject>] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: PSObject - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingMigrationEnabled -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ACPMeetingMigrationTriggerEnabled -{{Fill ACPMeetingMigrationTriggerEnabled Description}} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTenantPublicProvider.md b/skype/skype-ps/skype/Set-CsTenantPublicProvider.md deleted file mode 100644 index 51674d4f61..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantPublicProvider.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Set-CsTenantPublicProvider -schema: 2.0.0 ---- - -# Set-CsTenantPublicProvider - -## SYNOPSIS -Enables and disables communication with the third-party IM and presence providers Windows Live, AOL, and Yahoo. -When enabled, Skype for Business Online users will be able to exchange IM and presence information with users who have accounts on the specified public provider. - -## SYNTAX - -``` -Set-CsTenantPublicProvider [-Provider <String[]>] [-Tenant <Guid>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Public providers are organizations that provide SIP communication services for the general public. -When you establish a federation relationship with a public provider, you effectively establish federation with any user who has an account hosted by that provider. -For example, if you federate with Windows Live, then your users will be able to exchange instant messages and presence information with anyone who has a Windows Live instant messaging account. - -Skype for Business Online gives administrators the option of configuring federation with one or more of the following public IM and presence providers: - -Windows Live - -AOL - -Yahoo! - -The `Set-CsTenantPublicProvider` cmdlet can be used to enable or disable federation with any of these public providers. -When using this cmdlet, keep in mind that each time you run the `Set-CsTenantPublicProvider` cmdlet you must specify all of the providers that should be enabled. -For example, suppose all three providers are disabled and you run this command: - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "WindowsLive"` - -As you might expect, that will enable Windows Live, and will leave AOL and Yahoo disabled. - -Now, suppose you next run this command: - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "AOL"` - -That command will enable AOL. -However, it will also disable Windows Live: that's because Windows Live was not specified as part of the parameter value supplied to the Provider parameter. -If you want to enable AOL and keep Windows Live enabled as well, then you must specify both AOL and Windows Live when calling Set-CsTenantPublicProvider: - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "AOL","WindowsLive"` - -To disable federation for all three providers, set the Provider property to an empty string (""): - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider ""` - -Note that simply enabling the status of a public provider does not mean that users can exchange instant messages and presence information with users who have accounts on that provider. -In addition to enabling federation with the provider itself, administrators must also set the AllowPublicUsers property of the federation configuration settings to True. -If this property is set to False then communication will not be allowed with any of the public providers, regardless of the public provider configuration settings. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "WindowsLive" -``` - -The command shown in Example 1 enables federation with Windows Live for the tenant with the tenant ID bf19b7db-6960-41e5-a139-2aa373474354. -Because Windows Live is the only provider specified, both the AOL and Yahoo providers will be disabled after the command executes. - - -### -------------------------- Example 2 -------------------------- -``` -Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "WindowsLive","AOL" -``` - -In Example 2, two public providers are enabled: Windows Live and AOL. -That means that only the Yahoo public provider will be disabled for the specified tenant. - - -### -------------------------- Example 3 -------------------------- -``` -Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "" -``` - -Example 3 shows how you can disable all the public providers for a given tenant. -This is done by setting the Provider property to an empty string (""). - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -Indicates the public provider (or providers) that users will be allowed to communicate with. -Valid values are: - -* AOL -* WindowsLive -* Yahoo - -Note that, when configuring public providers, any provider included in the Provider parameter value will be enabled for use, while any provider not included in the parameter value will be disabled. -For example, this syntax enables only Yahoo, while disabling Windows Live and AOL: - -`-Provider "Yahoo"` - -You can enable multiple providers by separating the provider names by using commas: - -`-Provider "AOL","WindowsLive"` - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose public provider settings are being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -The `Set-CsTenantPublicProvider` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Hosted.TenantPICStatus object. - -## OUTPUTS - -### -None. -Instead, the `Set-CsTenantPublicProvider` cmdlet modifies existing instances of the Microsoft.Rtc.Management.Hosted.TenantPICStatus object. - -## NOTES - -## RELATED LINKS - -[Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) - -[Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md index 92d2860f1b..16213f56b6 100644 --- a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsTenantUpdateTimeWindow @@ -330,7 +335,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -339,4 +344,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTestDevice.md b/skype/skype-ps/skype/Set-CsTestDevice.md index 9d789caf18..47708627fc 100644 --- a/skype/skype-ps/skype/Set-CsTestDevice.md +++ b/skype/skype-ps/skype/Set-CsTestDevice.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTestDevice @@ -196,7 +201,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -219,4 +224,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsTestDevice](New-CsTestDevice.md) [Remove-CsTestDevice](Remove-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/Set-CsTestUserCredential.md b/skype/skype-ps/skype/Set-CsTestUserCredential.md index a580aa0828..35ebd6a75a 100644 --- a/skype/skype-ps/skype/Set-CsTestUserCredential.md +++ b/skype/skype-ps/skype/Set-CsTestUserCredential.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTestUserCredential @@ -204,7 +209,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -225,4 +230,3 @@ Instead, the `Set-CsTestUserCredential` cmdlet modifies existing instances of th [Get-CsTestUserCredential](Get-CsTestUserCredential.md) [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) - diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md index 8374cf3350..8ceafe90ca 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsThirdPartyVideoSystem @@ -220,7 +225,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -242,4 +247,3 @@ However, if you include the PassThru parameter the cmdlet will pass instances of [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md index cecf8a87e6..c59e5e1f93 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsThirdPartyVideoSystemPolicy @@ -196,7 +201,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -220,4 +225,3 @@ Instead, the `Set-CsThirdPartyVideoSystemPolicy` cmdlet modifies existing instan [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md b/skype/skype-ps/skype/Set-CsTrunkConfiguration.md index 368a5fecd2..d679673e79 100644 --- a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTrunkConfiguration @@ -23,9 +28,9 @@ Set-CsTrunkConfiguration [[-Identity] <XdsIdentity>] [-ConcentratedTopology <Boo [-RTCPActiveCalls <Boolean>] [-RTCPCallsOnHold <Boolean>] [-SipResponseCodeTranslationRulesList <PSListModifier>] [-SRTPMode <SRTPMode>] [-Force] [-WhatIf] [-Confirm] [-Enable3pccRefer <Boolean>] [-EnableFastFailoverTimer <Boolean>] [-EnableOnlineVoice <Boolean>] - [-EnableRTPLatching <Boolean>] [-ForwardCallHistory <Boolean>] [-ForwardPAI <Boolean>] + [-EnableRTPLatching <Boolean>] [-ForwardCallHistory <Boolean>] [-ForwardPAI <Boolean>] [-ForwardAnonymousCallGatewayPAI <Boolean>] [-OutboundCallingNumberTranslationRulesList <PSListModifier>] [-PstnUsages <PSListModifier>] - [-EnableLocationRestriction <Boolean>] [-NetworkSiteID <String>] [<CommonParameters>] + [-EnableLocationRestriction <Boolean>] [-NetworkSiteID <String>] [AcceptGatewayPAIForOutboundCalls] [<CommonParameters>] ``` ### Instance @@ -37,9 +42,9 @@ Set-CsTrunkConfiguration [-Instance <PSObject>] [-ConcentratedTopology <Boolean> [-RTCPActiveCalls <Boolean>] [-RTCPCallsOnHold <Boolean>] [-SipResponseCodeTranslationRulesList <PSListModifier>] [-SRTPMode <SRTPMode>] [-Force] [-WhatIf] [-Confirm] [-Enable3pccRefer <Boolean>] [-EnableFastFailoverTimer <Boolean>] [-EnableOnlineVoice <Boolean>] - [-EnableRTPLatching <Boolean>] [-ForwardCallHistory <Boolean>] [-ForwardPAI <Boolean>] + [-EnableRTPLatching <Boolean>] [-ForwardCallHistory <Boolean>] [-ForwardPAI <Boolean>] [-ForwardAnonymousCallGatewayPAI <Boolean>] [-OutboundCallingNumberTranslationRulesList <PSListModifier>] [-PstnUsages <PSListModifier>] - [-EnableLocationRestriction <Boolean>] [-NetworkSiteID <String>] [<CommonParameters>] + [-EnableLocationRestriction <Boolean>] [-NetworkSiteID <String>] [AcceptGatewayPAIForOutboundCalls] [<CommonParameters>] ``` ## DESCRIPTION @@ -617,6 +622,26 @@ 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). + +**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 + +Required: False +Position: Named +Default value: None +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: @@ -693,8 +718,26 @@ 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) + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -722,4 +765,3 @@ This cmdlet does not return a value; it modifies an object of type Microsoft.Rtc [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsTrustedApplication.md b/skype/skype-ps/skype/Set-CsTrustedApplication.md index f2ad2b3e5e..5decd88312 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplication.md +++ b/skype/skype-ps/skype/Set-CsTrustedApplication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTrustedApplication @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -151,4 +156,3 @@ It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplica [Remove-CsTrustedApplication](Remove-CsTrustedApplication.md) [Get-CsTrustedApplication](Get-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md index 41e6177024..505d5b29a7 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTrustedApplicationEndpoint @@ -313,7 +318,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -336,4 +341,3 @@ It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApp [Remove-CsTrustedApplicationEndpoint](Remove-CsTrustedApplicationEndpoint.md) [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md b/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md index 6ee3dc8704..aa6bd0be59 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsTrustedApplicationPool @@ -295,7 +300,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -320,4 +325,3 @@ It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) - diff --git a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md index 6bb243add6..5a7d9ecb84 100644 --- a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csucphoneconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUCPhoneConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsUCPhoneConfiguration @@ -49,7 +54,7 @@ In addition to creating new collections of UC phone settings, you can use the `S For example, by default logging is disabled for UC phones. To enable logging at the global level, you can use the `Set-CsUCPhoneConfiguration` cmdlet to change the value of the global collection's LoggingLevel property to True. -The following parameters are not applicable to Skype for Business Online: AsJob, CalendarPollInterval, Force, Identity, Instance, PipelineVariable, SIPSecurityMode, Tenant, Voice8021p, and VoiceDiffServTag +The following parameters are not applicable to Skype for Business Online: CalendarPollInterval, Force, Identity, Instance, PipelineVariable, SIPSecurityMode, Tenant, Voice8021p, and VoiceDiffServTag ## EXAMPLES @@ -385,7 +390,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -408,4 +413,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsUCPhoneConfiguration](New-CsUCPhoneConfiguration.md) [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsUICulture.md b/skype/skype-ps/skype/Set-CsUICulture.md index 2e3b7a5f70..e596429fed 100644 --- a/skype/skype-ps/skype/Set-CsUICulture.md +++ b/skype/skype-ps/skype/Set-CsUICulture.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUICulture @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,4 +136,3 @@ Instead, the cmdlet modifies existing instances of the System.Globalization.Cult ## RELATED LINKS [Get-CsUICulture](Get-CsUICulture.md) - diff --git a/skype/skype-ps/skype/Set-CsUnassignedNumber.md b/skype/skype-ps/skype/Set-CsUnassignedNumber.md index 89f62ecd75..404dd230e4 100644 --- a/skype/skype-ps/skype/Set-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/Set-CsUnassignedNumber.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUnassignedNumber @@ -277,7 +282,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -306,4 +311,3 @@ It modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnno [Get-CsAnnouncement](Get-CsAnnouncement.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index e183ebcd37..6578b30a14 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/skype/Set-CsUser.md @@ -1,17 +1,23 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csuser +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUser schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsUser ## SYNOPSIS -Modifies Skype for Business Server properties for an existing user account. -Properties can be modified only for accounts that have been enabled for use with Skype for Business Server. +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](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -25,20 +31,19 @@ Set-CsUser [-DomainController <Fqdn>] [-Identity] <UserIdParameter> [-PassThru] ``` ## DESCRIPTION -The `Set-CsUser` cmdlet enables you to modify the Skype for Business Server related user account attributes that are stored in Active Directory Domain Services. -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. -The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business Server. +The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Microsoft Entra ID. +For example, you can disable or re-enable a user for Skype for Business Server; enable or disable a user for audio/video (A/V) communications; or modify a user's private line and line URI numbers. For Skype for Business online enable or disable a user for enterprise voice, hosted voicemail, or modify the user's on premise line uri. +The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business. -The only attributes you can modify using the `Set-CsUser` cmdlet are attributes related to Skype for Business Server. +The only attributes you can modify using the `Set-CsUser` cmdlet are attributes related to Skype for Business. Other user account attributes, such as the user's job title or department, cannot be modified by using this cmdlet. -Keep in mind, however, that the Skype for Business Server attributes should only be modified by using the `Set-CsUser` cmdlet or the Skype for Business Server Control Panel. +Keep in mind, however, that the Skype for Business attributes should only be modified by using the `Set-CsUser` cmdlet or the Skype for Business Server Control Panel. You should not attempt to manually configure these attributes. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- -``` +```powershell Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True ``` @@ -48,7 +53,7 @@ This task is carried out by adding the EnterpriseVoiceEnabled parameter, and the ### -------------------------- Example 2 -------------------------- -``` +```powershell Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True ``` @@ -56,6 +61,13 @@ 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 -------------------------- +```powershell +Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" +``` + +In Example 3, the `Set-CsUser` cmdlet is used to modify the user account with the Identity Pilar Ackerman. +In this case, the account is modified to set the phone number assigned to the user settings its LineUri property. ## PARAMETERS @@ -67,11 +79,10 @@ User Identities can also be referenced by using the user's Active Directory dist 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: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -87,12 +98,13 @@ If set to True, the user will largely be restricted to sending and receiving ins You cannot disable A/V communications if a user is currently enabled for remote call control, Enterprise Voice, and/or Internet Protocol private branch exchange (IP-PBX) soft phone routing. +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -110,12 +122,11 @@ If you later re-enable the account by using the Enabled parameter, the associate This differs from using the `Disable-CsUser` cmdlet to disable a user account. When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data associated with that account is deleted. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -128,12 +139,11 @@ Accept wildcard characters: False Enables you to specify a domain controller to connect to when modifying a user account. If this parameter is not included then the cmdlet will use the first available domain controller. - ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -146,11 +156,12 @@ Accept wildcard characters: False Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -164,11 +175,12 @@ Accept wildcard characters: False When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. +**Note**: It is not required to set this parameter for Microsoft Teams users. Using this parameter has been deprecated for Microsoft Teams users in commercial and GCC cloud instances. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -179,25 +191,26 @@ Accept wildcard characters: False ``` ### -LineURI -Phone number assigned to the user. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. - -It is important to note that Skype for Business Server treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not be flagged as a duplicate number. -This is due to the fact that, depending on your setup, those two numbers could actually be different. -For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. -Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. -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 +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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -211,12 +224,11 @@ The URI of the remote call control telephone gateway assigned to the user. The LineServerUri is the gateway URI, prefaced by "sip:". For example: sip:rccgateway@litwareinc.com - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -231,15 +243,14 @@ A private line is a phone number that is not published in Active Directory Domai In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. -The private line value should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. - +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -258,12 +269,11 @@ For details, see the parameter EnterpriseVoiceEnabled. To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -276,12 +286,11 @@ Accept wildcard characters: False Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -294,11 +303,13 @@ Accept wildcard characters: False Enables you to pass a user object through the pipeline that represents the user whose account is being modified. By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -314,7 +325,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -330,7 +341,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -343,12 +354,11 @@ Accept wildcard characters: False Enables you to assign one or more third-party audio conferencing providers to a user. However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. - ```yaml Type: AcpInfo Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -369,12 +379,11 @@ ArchivingToExchange NoArchiving - ```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: +Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -385,20 +394,24 @@ Accept wildcard characters: False ### -OnPremLineURI Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -Note that Skype for Business treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed. +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. Depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +**Note**: Using this parameter for Microsoft Teams users 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: +Aliases: Applicable: Skype for Business Online Required: False @@ -409,7 +422,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -435,5 +448,3 @@ The `Set-CsUser` cmdlet does not return any objects. [Move-CsUser](Move-CsUser.md) -[Get-CsOnlineUser](Get-CsOnlineUser.md) - diff --git a/skype/skype-ps/skype/Set-CsUserAcp.md b/skype/skype-ps/skype/Set-CsUserAcp.md index afdcd420a6..e79059fc9a 100644 --- a/skype/skype-ps/skype/Set-CsUserAcp.md +++ b/skype/skype-ps/skype/Set-CsUserAcp.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csuseracp +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserAcp schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsUserAcp @@ -17,10 +22,12 @@ This cmdlet was introduced in Lync Server 2010. ``` Set-CsUserAcp [-Identity] <UserIdParameter> -Domain <String> -Name <String> -ParticipantPasscode <String> -TollNumber <String> [-IsDefault <Boolean>] [-TollFreeNumbers <String[]>] [-Url <String>] [-PassThru] - [-WhatIf] [-Confirm] [-AsJob] [<CommonParameters>] + [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION +Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://learn.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. + An audio conferencing provider is a third-party company that provides organizations with conferencing services. Among other things, audio conferencing providers offer a way for users located off site and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or meeting. Audio conferencing providers often include high-end services such as live translation, transcription and live per-conference operator assistance. @@ -225,7 +232,7 @@ Accept wildcard characters: False ### -Url Web URL for the audio conferencing provider; for example: -`-Url "http://acp.fabrikam.com/"` +`-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. @@ -295,24 +302,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -333,4 +324,3 @@ None. [Get-CsUserAcp](Get-CsUserAcp.md) [Remove-CsUserAcp](Remove-CsUserAcp.md) - diff --git a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md b/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md new file mode 100644 index 0000000000..1c371c4113 --- /dev/null +++ b/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md @@ -0,0 +1,309 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Set-CsUserCallForwardingSettings + +## SYNOPSIS +This cmdlet modifies the specified user's call forwarding settings. This cmdlet returns the specified user's call forwarding settings as an object, and displays the same on the screen, in case of success. In case of failure, the appropriate error message is shown. + +## SYNTAX + +### DisableForwarding +``` +Set-CsUserCallForwardingSettings [-DisableForwarding] [-SettingsActiveWorkHours] [-UnansweredToVoicemail] + [-UnansweredToOther <String>] [-UnansweredWaitTime <Int32>] [-User] <String> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### EnableForwarding +``` +Set-CsUserCallForwardingSettings -EnableForwarding <String> [-SettingsActiveWorkHours] + [-DelegateRingWaitTime <Int32>] [-Delegates <System.Management.Automation.PSListModifier`1[System.String]>] + [-User] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableSimulRing +``` +Set-CsUserCallForwardingSettings -EnableSimulRing <String> [-SettingsActiveWorkHours] [-UnansweredToVoicemail] + [-UnansweredToOther <String>] [-UnansweredWaitTime <Int32>] [-TeamDelegateRingWaitTime <Int32>] + [-Delegates <System.Management.Automation.PSListModifier`1[System.String]>] + [-Team <System.Management.Automation.PSListModifier`1[System.String]>] [-User] <String> [-Force] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. + +The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: + +- CsAdministrator - Get and Set for all cmdlets +- CsVoiceAdministrator - Get and Set for all cmdlets +- CsServerAdministrator - Get and Set for all cmdlets +- CsHelpDesk - Get for all cmdlets + +Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsUserCallForwardingSettings -User user@contoso.com -DisableForwarding +``` + +This example disables the user's call forwarding settings. + +### Example 2 +```powershell +PS C:\> Set-CsUserCallForwardingSettings -User user@contoso.com -EnableForwarding +4721956666 +``` + +This example modifies the user's call forwarding settings, activating call forwarding to a specific phone number. + +### Example 3 +```powershell +PS C:\> Set-CsUserCallForwardingSettings -User user1@contoso.com -EnableSimulRing Team -Team user2@contoso.com,user2@contoso.com -TeamDelegateRingWaitTime 5 +``` + +This example modifies the SimulRing settings, activating simultaneous ring for the users listed in the Team parameter. + +### Example 4 +```powershell +PS C:\> Set-CsUserCallForwardingSettings -User user@contoso.com -DisableForwarding -UnansweredToVoicemail -UnansweredWaitTime 30 +``` + +This example sends unanswered calls to voicemail after 30 seconds. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +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. + + +```yaml +Type: Int32 +Parameter Sets: EnableForwarding +Aliases: +Applicable: Skype for Business Server 2019CU1 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegates +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableForwarding +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableForwarding +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSimulRing +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: "\<phone number\>", Team, Delegates. + + +```yaml +Type: String +Parameter Sets: EnableSimulRing +Aliases: +Applicable: Skype for Business Server 2019CU1 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingsActiveWorkHours +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Team +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamDelegateRingWaitTime +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredToOther +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredToVoicemail +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredWaitTime +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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 +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 + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsUserDatabaseState.md b/skype/skype-ps/skype/Set-CsUserDatabaseState.md index 4e4625ecb6..457fd92a5b 100644 --- a/skype/skype-ps/skype/Set-CsUserDatabaseState.md +++ b/skype/skype-ps/skype/Set-CsUserDatabaseState.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUserDatabaseState @@ -181,7 +186,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -202,4 +207,3 @@ Instead, the `Set-CsUserDatabaseState` cmdlet modifies existing instances of the [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) [Update-CsUserDatabase](Update-CsUserDatabase.md) - diff --git a/skype/skype-ps/skype/Set-CsUserDelegates.md b/skype/skype-ps/skype/Set-CsUserDelegates.md new file mode 100644 index 0000000000..51ab7a0a53 --- /dev/null +++ b/skype/skype-ps/skype/Set-CsUserDelegates.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Set-CsUserDelegates + +## SYNOPSIS +Used to modify a user's delegates list. + +## SYNTAX + +``` +Set-CsUserDelegates -Delegates <PSListModifier> [-User] <String> + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: CsAdministrator - Get and Set for all cmdlets, CsVoiceAdministrator - Get and Set for all cmdlets, CsServerAdministrator - Get and Set for all cmdlets, CsHelpDesk - Get for all cmdlets Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. For more information see [Using SEFAUtil functionality via PowerShell in Skype for Business Server 2019](https://learn.microsoft.com/skypeforbusiness/sefautil-functionality). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsUserDelegates -Delegates @{add='ChewDavid@contoso.com','dmx@contoso.com'} -User "Ken.Myer@contoso.com" +``` + +This cmdlet modifies the specified user's delegation settings, returns an object of delegates list and displays the list of delegates, in case of success. In case of failure, an appropriate error message will be shown. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the 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. + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: DisplayName, SipAddress, Identity + +Required: True +Position: 0 +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsUserPstnSettings.md b/skype/skype-ps/skype/Set-CsUserPstnSettings.md index 4266fa4546..92e36241ea 100644 --- a/skype/skype-ps/skype/Set-CsUserPstnSettings.md +++ b/skype/skype-ps/skype/Set-CsUserPstnSettings.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsUserPstnSettings @@ -10,6 +15,8 @@ schema: 2.0.0 ## SYNOPSIS Use the `Set-CsUserPstnSettings` cmdlet to modify an existing voice-enabled user's public switched telephone network (PSTN) settings. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` @@ -152,7 +159,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -167,4 +174,3 @@ The `Set-CsUserPstnSettings` cmdlet returns instances of the UserPstnSettings ob ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md index a90c1460ae..55e92367ce 100644 --- a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUserReplicatorConfiguration @@ -262,7 +267,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -285,4 +290,3 @@ Instead, the cmdlet modifies the global instance (the only such instance) of the [New-CsUserReplicatorConfiguration](New-CsUserReplicatorConfiguration.md) [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsUserServer.md b/skype/skype-ps/skype/Set-CsUserServer.md index 1de988b568..5e4b1ca974 100644 --- a/skype/skype-ps/skype/Set-CsUserServer.md +++ b/skype/skype-ps/skype/Set-CsUserServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUserServer @@ -226,7 +231,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -245,4 +250,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md b/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md index cc0c216ff4..e84ea92d4a 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUserServicesConfiguration @@ -431,7 +436,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -454,4 +459,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsUserServicesConfiguration](New-CsUserServicesConfiguration.md) [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md b/skype/skype-ps/skype/Set-CsUserServicesPolicy.md index 91b121affc..b616c7d545 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Set-CsUserServicesPolicy.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: hirshah +ms.reviewer: --- # Set-CsUserServicesPolicy @@ -47,7 +52,7 @@ After that, you must then use the `Invoke-CsUcsRollback` cmdlet to "manually" mi Skype for Business Server Control Panel: The functions carried out by the `Set-CsUserServicesPolicy` cmdlet are not available in the Skype for Business Server Control Panel. -The following parameters are not applicable to Skype for Business Online: AsJob, Force, Identity, Instance, MigrationDelayInDays, PipelineVariable, and Tenant +The following parameters are not applicable to Skype for Business Online: Force, Identity, Instance, MigrationDelayInDays, PipelineVariable, and Tenant ## EXAMPLES @@ -81,7 +86,7 @@ Suppresses the display of any non-fatal error message that might arise when runn 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 +Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -98,7 +103,7 @@ Suppresses the display of any non-fatal error message that might arise when runn Type: SwitchParameter 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,7 +135,7 @@ If this parameter is not included then the `Set-CsUserServicesPolicy` cmdlet wil Type: XdsIdentity Parameter Sets: Identity 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 Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -147,7 +152,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -171,7 +176,7 @@ You can return the tenant ID for each of your tenants by running this command: Type: Guid 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -189,7 +194,7 @@ When set to False, users can be removed from the unified contact store, but only Type: Boolean 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,7 +211,7 @@ 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 +Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -223,7 +228,7 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, 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 @@ -242,7 +247,7 @@ The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, 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 @@ -252,7 +257,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -276,4 +281,3 @@ Instead, the `Set-CsUserServicesPolicy` cmdlet modifies existing instances of th [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsUserTeamMembers.md b/skype/skype-ps/skype/Set-CsUserTeamMembers.md new file mode 100644 index 0000000000..ec4147db30 --- /dev/null +++ b/skype/skype-ps/skype/Set-CsUserTeamMembers.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: hirshah +ms.reviewer: +--- + +# Set-CsUserTeamMembers + +## SYNOPSIS +Used to modify a user's team members list. + +## SYNTAX + +``` +Set-CsUserTeamMembers -Team <PSListModifier> [-User] <String> + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The feature enables the use of SEFAUtil (Secondary Extension Feature Activation) functionality in PowerShell. SEFAUtil enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: CsAdministrator - Get and Set for all cmdlets, CsVoiceAdministrator - Get and Set for all cmdlets, CsServerAdministrator - Get and Set for all cmdlets, CsHelpDesk - Get for all cmdlets Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. For more information see [Using SEFAUtil functionality via PowerShell in Skype for Business Server 2019](https://learn.microsoft.com/skypeforbusiness/sefautil-functionality). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsUserTeamMembers -User "Ken.Myer@contoso.com" -Team @{add='ChewDavid@contoso.com','dmx@contoso.com'} +``` + +This cmdlet adds two other users to the specified user's team members list, returns an object that contains the team member list and displays the object on the screen, in case of success. In case of failure, an appropriate error message will be shown. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Team +Specifies list of team members. 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: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) the SIP address; 2) the user principal name (UPN); 3) the domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: DisplayName, SipAddress, Identity + +Required: True +Position: 0 +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsVideoGateway.md b/skype/skype-ps/skype/Set-CsVideoGateway.md index e299b3c2e4..166e402503 100644 --- a/skype/skype-ps/skype/Set-CsVideoGateway.md +++ b/skype/skype-ps/skype/Set-CsVideoGateway.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVideoGateway @@ -168,7 +173,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -186,4 +191,3 @@ The `Set-CsVideoGateway` cmdlet does not return any objects or values. ## RELATED LINKS [Get-CsVideoTrunk](Get-CsVideoTrunk.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServer.md b/skype/skype-ps/skype/Set-CsVideoInteropServer.md index 878776f195..206a48e916 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServer.md +++ b/skype/skype-ps/skype/Set-CsVideoInteropServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVideoInteropServer @@ -276,7 +281,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -296,4 +301,3 @@ The `Set-CsVideoInteropServer` cmdlet does not return any objects or values. [Set-CsVideoGateway](Set-CsVideoGateway.md) [Get-CsVideoTrunk](Get-CsVideoTrunk.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md index a68171dd0b..80989a190d 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVideoInteropServerConfiguration @@ -178,7 +183,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -200,4 +205,3 @@ The `Set-CsVideoInteropServerConfiguration` cmdlet modifies existing instances o [New-CsVideoInteropServerConfiguration](New-CsVideoInteropServerConfiguration.md) [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md index 4e33941a54..05da2f52c4 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVideoInteropServerSyntheticTransactionConfiguration @@ -154,7 +159,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -177,4 +182,3 @@ None. [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md index 0f8246cbf7..32c668c947 100644 --- a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVideoTrunkConfiguration @@ -34,7 +39,7 @@ The Video Interop Server is a Skype service that runs on a standalone pool and c To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -253,7 +258,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -275,4 +280,3 @@ The `Set-CsVideoTrunkConfiguration` cmdlet modifies existing instances of the Mi [New-CsVideoTrunkConfiguration](New-CsVideoTrunkConfiguration.md) [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md b/skype/skype-ps/skype/Set-CsVoiceConfiguration.md index 00b70b2ddb..55b566c49c 100644 --- a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVoiceConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVoiceConfiguration @@ -182,7 +187,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -209,4 +214,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Set-CsVoiceTestConfiguration](Set-CsVoiceTestConfiguration.md) [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md index 169c6b71b7..75e02f9f89 100644 --- a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-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 +ms.author: tomkau +ms.reviewer: rogupta --- # Set-CsVoiceNormalizationRule @@ -12,19 +17,20 @@ Modifies a 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. This cmdlet was introduced in Lync Server 2010. +**Note**: This cmdlet has been deprecated in Teams PowerShell Module 4.0.0. ## SYNTAX ### Identity (Default) ``` -Set-CsVoiceNormalizationRule [-Tenant <Guid>] [-Description <String>] [-Pattern <String>] - [-Translation <String>] [-IsInternalExtension <Boolean>] [-Priority <Int32>] [[-Identity] <XdsIdentity>] +Set-CsVoiceNormalizationRule [-Description <String>] [-Pattern <String>] + [-Translation <String>] [-IsInternalExtension <Boolean>] [-Priority <Int32>] [[-Identity] <XdsIdentity>] [-Tenant <guid>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ### Instance ``` -Set-CsVoiceNormalizationRule [-Tenant <Guid>] [-Description <String>] [-Pattern <String>] +Set-CsVoiceNormalizationRule [-Tenant <guid>] [-Description <String>] [-Pattern <String>] [-Translation <String>] [-IsInternalExtension <Boolean>] [-Priority <Int32>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] ``` @@ -62,13 +68,11 @@ For example, if the existing pattern matched any four-digit number and the numbe ### -------------------------- Example 3 -------------------------- ``` $a = Get-CsVoiceNormalizationRule -Identity global/RedmondFourDigit - $a.name = "RedmondRule" - Set-CsVoiceNormalizationRule -Instance $a ``` -Example 3 changes the name of the normalization rule. +Example 3 applies to Skype For Business Server only and changes the name of the normalization rule. Keep in mind that changing the name also changes the name portion of the Identity. The `Set-CsVoiceNormalizationRule` cmdlet doesn't have a Name parameter, so in order to change the name we first call the `Get-CsVoiceNormalizationRule` cmdlet to retrieve the rule with the Identity global/RedmondFourDigit and assign the returned object to the variable $a. We then assign the string RedmondRule to the Name property of the object. @@ -85,7 +89,7 @@ The Identity specified must include the scope followed by a slash followed by th 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -103,7 +107,7 @@ This object must be of type NormalizationRule and can be retrieved by calling th 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: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -122,7 +126,7 @@ Maximum string length: 512 characters. 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,7 +145,7 @@ This value is ignored if the value of the OptimizeDeviceDialing property of the 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,7 +164,7 @@ This parameter sets the order in which the rules are tested against the number. 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -177,7 +181,7 @@ A regular expression that the dialed number must match in order for this rule to 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -194,7 +198,7 @@ The regular expression pattern that will be applied to the number to convert it 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -211,7 +215,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -228,7 +232,7 @@ 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -245,7 +249,7 @@ 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 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -255,13 +259,13 @@ Accept wildcard characters: False ``` ### -Tenant -{{Fill Tenant Description}} +For internal Microsoft usage. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -271,7 +275,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -300,4 +304,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Set-CsDialPlan](Set-CsDialPlan.md) [Get-CsDialPlan](Get-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Set-CsVoicePolicy.md b/skype/skype-ps/skype/Set-CsVoicePolicy.md index 4a5f55277f..bd2491217f 100644 --- a/skype/skype-ps/skype/Set-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Set-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVoicePolicy @@ -540,7 +545,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -569,4 +574,3 @@ Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig. [Test-CsVoicePolicy](Test-CsVoicePolicy.md) [Get-CsPstnUsage](Get-CsPstnUsage.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceRoute.md b/skype/skype-ps/skype/Set-CsVoiceRoute.md index eda3ca2c07..7a66daa439 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Set-CsVoiceRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVoiceRoute @@ -332,7 +337,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -361,4 +366,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md index ac2e0dc4a0..1c2aeaffd5 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVoiceRoutingPolicy @@ -212,7 +217,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -236,4 +241,3 @@ Instead, the `Set-CsVoiceRoutingPolicy` cmdlet modifies existing instances of th [New-CsVoiceRoutingPolicy](New-CsVoiceRoutingPolicy.md) [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md index 64f25a2401..56905fbe1a 100644 --- a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVoiceTestConfiguration @@ -265,7 +270,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -297,4 +302,3 @@ This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsDialPlan](Get-CsDialPlan.md) [Get-CsVoicePolicy](Get-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md index d489af09b7..b20a8c0c9d 100644 --- a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsVoicemailReroutingConfiguration @@ -198,7 +203,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -221,4 +226,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.E [Remove-CsVoicemailReroutingConfiguration](Remove-CsVoicemailReroutingConfiguration.md) [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md index 7bd6f49c24..8f943ec290 100644 --- a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsWatcherNodeConfiguration @@ -343,7 +348,7 @@ Accept wildcard characters: False ### -UseAutoDiscovery When set to True ($True), watcher nodes will use the Autodiscover service locate the target pool. -When set the False (the default value), watcher nodes will use the pool FQDN and SRV records to locate pools. +When set to False (the default value), watcher nodes will use the pool FQDN and SRV records to locate pools. ```yaml Type: Boolean @@ -359,7 +364,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -383,4 +388,3 @@ Instead, the `Set-CsWatcherNodeConfiguration` cmdlet modifies existing instances [Remove-CsWatcherNodeConfiguration](Remove-CsWatcherNodeConfiguration.md) [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsWebServer.md b/skype/skype-ps/skype/Set-CsWebServer.md index 900c77277a..5bf3b8c7cc 100644 --- a/skype/skype-ps/skype/Set-CsWebServer.md +++ b/skype/skype-ps/skype/Set-CsWebServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsWebServer @@ -607,7 +612,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -626,4 +631,3 @@ Instead, the `Set-CsWebServer` cmdlet modifies instances of the Microsoft.Rtc.Ma ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md b/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md index 62d4e664cd..7a41b51175 100644 --- a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md @@ -1,23 +1,29 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsWebServiceConfiguration ## SYNOPSIS + Modifies an existing collection of Web Services configuration settings. This cmdlet was introduced in Lync Server 2010. - ## SYNTAX -### Identity +### Identity (Default) + ``` Set-CsWebServiceConfiguration [[-Identity] <XdsIdentity>] [-AllowAnonymousAccessToLWAConference <Boolean>] - [-CASigningKeyLength <UInt64>] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <Boolean>] + [-CASigningKeyLength <UInt64>] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <Boolean>] [-EnableCORS <Boolean>] [-EnableGroupExpansion <Boolean>] [-InferCertChainFromSSL <Boolean>] [-MACResolverUrl <String>] [-MaxCSRKeySize <UInt64>] [-MaxGroupSizeToExpand <UInt32>] [-MaxValidityPeriodHours <UInt64>] [-MinCSRKeySize <UInt64>] [-MinValidityPeriodHours <UInt64>] [-SecondaryLocationSourceUrl <String>] @@ -28,11 +34,14 @@ Set-CsWebServiceConfiguration [[-Identity] <XdsIdentity>] [-AllowAnonymousAccess [-UseWsFedPassiveAuth <Boolean>] [-WsFedPassiveMetadataUri <String>] [-CrossDomainAuthorizationList <PSListModifier>] [-EnableMediaBasicAuth <Boolean>] [-EnableStatisticsInResponse <Boolean>] [-HstsMaxAgeInSeconds <Int64>] + [-PendingGetWaitTimeOutInMinutes <Int64>] [-PendingGetWaitSupportingApps <String>] [-MobilePreferredAuthType <MobilePreferredAuthType>] [-UseDomainAuthInLWA <Boolean>] + [-OverrideAuthTypeForInternalClients <String>] [-OverrideAuthTypeForExternalClients <String>] [-UseWebClientLegacyUI <Boolean>] [<CommonParameters>] ``` ### Instance + ``` Set-CsWebServiceConfiguration [-Instance <PSObject>] [-AllowAnonymousAccessToLWAConference <Boolean>] [-CASigningKeyLength <UInt64>] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <Boolean>] @@ -46,11 +55,14 @@ Set-CsWebServiceConfiguration [-Instance <PSObject>] [-AllowAnonymousAccessToLWA [-UseWsFedPassiveAuth <Boolean>] [-WsFedPassiveMetadataUri <String>] [-CrossDomainAuthorizationList <PSListModifier>] [-EnableMediaBasicAuth <Boolean>] [-EnableStatisticsInResponse <Boolean>] [-HstsMaxAgeInSeconds <Int64>] + [-PendingGetWaitTimeOutInMinutes <Int64>] [-PendingGetWaitSupportingApps <String>] [-MobilePreferredAuthType <MobilePreferredAuthType>] [-UseDomainAuthInLWA <Boolean>] + [-OverrideAuthTypeForInternalClients <String>] [-OverrideAuthTypeForExternalClients <String>] [-UseWebClientLegacyUI <Boolean>] [<CommonParameters>] ``` ## DESCRIPTION + Many Skype for Business Server components are web-based: these components either use Web Services or webpages to carry out their tasks. For example, users employ a web service when searching for new contacts in the Address Book or when using group expansion to view the individual members of a distribution group. Likewise, components ranging from dial-in conferencing to Skype for Business Server Control Panel use web pages as the interface between Skype for Business Server and users. @@ -65,20 +77,20 @@ Because you can configure different settings at the global, site and service sco Custom settings (for example, custom validity periods for certificates) can be specified at the time you create a new Web Services configuration setting collection. Alternatively, you can modify the property values for an existing collection by using the `Set-CsWebServiceConfiguration` cmdlet. - ## EXAMPLES -### -------------------------- Example 1 ------------------------ -``` +### Example 1 + +```powershell Set-CsWebServiceConfiguration -Identity site:Redmond -EnableGroupExpansion $True ``` Example 1 enables group expansion for the Web Services configuration settings applied to the Redmond site (-Identity site:Redmond). This is done by including the EnableGroupExpansion property and setting the parameter value to True. +### Example 2 -### -------------------------- Example 2 ------------------------ -``` +```powershell Get-CsWebServiceConfiguration -Filter "site:*" | Set-CsWebServiceConfiguration -MaxValidityPeriodHours 16 ``` @@ -86,9 +98,9 @@ In Example 2, the maximum validity period for all the Web Services configuration To carry out this task, the `Get-CsWebServiceConfiguration` cmdlet is called along with the Filter parameter; the filter value "site:*" limits the returned data to settings where the Identity begins with the characters "site:". This collection is then piped to the `Set-CsWebServiceConfiguration` cmdlet, which takes each item in the collection and changes the MaxValidityPeriodHours property to 16. +### Example 3 -### -------------------------- Example 3 ------------------------ -``` +```powershell Get-CsWebServiceConfiguration | Where-Object {$_.EnableGroupExpansion -eq $True} | Set-CsWebServiceConfiguration -MaxGroupSizeToExpand 400 ``` @@ -97,39 +109,39 @@ To do this, the `Get-CsWebServiceConfiguration` cmdlet is called without any par This collection is then piped to the `Where-Object` cmdlet, which selects only those settings where the EnableGroupExpansion property is equal to True. In turn, this filtered collection is piped to the `Set-CsWebServiceConfiguration` cmdlet, which takes each item in the collection and sets the value of the MaxGroupSizeToExpand property to 400. +### Example 4 -### -------------------------- Example 4 ------------------------ -``` +```powershell Set-CsWebServiceConfiguration -Identity global -ShowDownloadCommunicatorAttendeeLink $True ``` The command shown in Example 4 shows how the global Web Services settings can be configured so that any person joining a meeting using a client application other than Skype for Business Server will first be shown a link to a site where he or she can download Skype for Business Web App. This is done by including the ShowDownloadCommunicatorAttendeeLink parameter and setting the parameter value to $True. +### Example 5 -### -------------------------- Example 5 -------------------------- -``` -$x = New-CsWebOrigin -Url "http://fabrikam.com/" +```powershell +$x = New-CsWebOrigin -Url "https://fabrikam.com/" Set-CsWebServiceConfiguration -Identity "site:Redmond" - CrossDomainAuthorizationList @{Add=$x} ``` -The commands shown in Example 5 add the domain http://fabrikam.com to an existing collection of Web service configuration settings. +The commands shown in Example 5 add the domain https://fabrikam.com to an existing collection of Web service configuration settings. To carry out this task, the first command in the example uses the `New-CsWebOrigin` cmdlet to create a domain object for fabrikam.com. The resulting domain object is stored in a variable named $x. -The second command in the example uses the `Set-CsWebServiceConfiguration` cmdlet to add http://fabrikam.com to the Web service configuration settings applied to the Redmond site. +The second command in the example uses the `Set-CsWebServiceConfiguration` cmdlet to add https://fabrikam.com to the Web service configuration settings applied to the Redmond site. The syntax @{Add=$x} adds the domain to any domains already in the collection of domains authorized for cross-domain scripting. -To replace the existing collection with just http://fabrikam.com use the syntax @{Replace=$x}. +To replace the existing collection with just https://fabrikam.com use the syntax @{Replace=$x}. +### Example 6 -### -------------------------- Example 6 -------------------------- -``` +```powershell $x = Get-CsWebServiceConfiguration -Identity "site:Redmond" $x.CrossDomainAuthorizationList.RemoveAt(0) -Set-CsWebServiceConfguration -Instance $x +Set-CsWebServiceConfiguration -Instance $x ``` In Example 6, the first domain listed in the collection of domains authorized for cross-domain scripting is removed from the web service configuration settings for the Redmond site. @@ -145,19 +157,19 @@ To remove the second domain (index number 1) from the CrossDomainAuthorizationLi Note that command 2 removes the domain from the copy of the Redmond site stored in the variable $x and not from the site itself. To actually remove the domain from the Redmond site, the third command in the example uses the `Set-CsWebServiceConfiguration` cmdlet and the Instance parameter to overwrite settings for the Redmond site with the settings stored in $x. +### Example 7 -### -------------------------- Example 7 -------------------------- -``` +```powershell Set-CsWebServiceConfiguration -Identity "site:Redmond" - CrossDomainAuthorizationList $Null ``` The command shown in Example 7 modifies the web service configuration settings for the Redmond site by removing all the domains that are authorized for cross-domain scripting. This is done by setting the CrossDomainAuthorizationList property to a null value ($Null). - ## 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: @@ -173,11 +185,10 @@ To modify settings configured at the global scope, you can use this syntax: If the Identity parameter is not used then the `Set-CsWebServiceConfiguration` cmdlet will automatically modify the global collection. - ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -188,12 +199,13 @@ 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: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -204,13 +216,13 @@ Accept wildcard characters: False ``` ### -AllowAnonymousAccessToLWAConference -When set to True, anonymous users will be allowed to attend Skype for Business Web App conferences. +When set to True, anonymous users will be allowed to attend Skype for Business Web App conferences. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -221,13 +233,14 @@ Accept wildcard characters: False ``` ### -CASigningKeyLength + 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. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -238,6 +251,7 @@ Accept wildcard characters: False ``` ### -DefaultValidityPeriodHours + 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. @@ -247,7 +261,7 @@ The default value is 4320 (180 days). ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -258,6 +272,7 @@ Accept wildcard characters: False ``` ### -EnableCertChainDownload + 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. @@ -265,7 +280,7 @@ Certificates will not be accepted for authentication unless the certificate's CA ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -274,17 +289,34 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableCORS + +If set to True, Cross-Origin Resource Sharing is enabled. + +```yaml +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 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` ### -EnableGroupExpansion + 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. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -295,13 +327,14 @@ 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. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -312,15 +345,15 @@ 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. - ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -331,6 +364,7 @@ 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 for a CSR key can be set to any integer value between 1024 and 16384 bytes. The default value is 16384. @@ -338,7 +372,7 @@ The default value is 16384. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -349,6 +383,7 @@ 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. @@ -358,7 +393,7 @@ The default value is 100. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -369,6 +404,7 @@ 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. @@ -378,7 +414,7 @@ The default value is 8760. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -389,6 +425,7 @@ Accept wildcard characters: False ``` ### -MinCSRKeySize + 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. @@ -396,7 +433,7 @@ The default value is 16384. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -407,6 +444,7 @@ 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. @@ -416,7 +454,7 @@ The default value is 8. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -427,13 +465,14 @@ Accept wildcard characters: False ``` ### -SecondaryLocationSourceUrl + 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: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -444,6 +483,7 @@ Accept wildcard characters: False ``` ### -ShowDownloadCommunicatorAttendeeLink + 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. @@ -452,7 +492,7 @@ If set to True (the default value), users joining a meeting by using a client ap ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -463,16 +503,16 @@ Accept wildcard characters: False ``` ### -ShowJoinUsingLegacyClientLink + 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: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -483,6 +523,7 @@ 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 by using the `New-CsWebTrustedCACertificate` cmdlet. @@ -491,7 +532,7 @@ This collection is not used if the InferCertChainFromSSL property is set to True ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -502,13 +543,14 @@ Accept wildcard characters: False ``` ### -UseCertificateAuth + 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: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -519,13 +561,14 @@ Accept wildcard characters: False ``` ### -UsePinAuth + 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: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -536,6 +579,7 @@ 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: @@ -548,7 +592,7 @@ None - Windows authentication will not be allowed. ```yaml Type: UseWindowsAuth Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -559,6 +603,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Describes what would happen if you executed the command without actually executing the command. ```yaml @@ -575,6 +620,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. ```yaml @@ -591,13 +637,14 @@ 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: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -608,12 +655,13 @@ Accept wildcard characters: False ``` ### -AllowExternalAuthentication + When set to True (the default value), OAuth authentication can be used to authenticate external users. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -624,17 +672,17 @@ Accept wildcard characters: False ``` ### -AutoLaunchLyncWebAccess + 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: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -645,16 +693,16 @@ Accept wildcard characters: False ``` ### -ShowAlternateJoinOptionsExpanded + 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: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -665,13 +713,14 @@ 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). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -682,12 +731,13 @@ Accept wildcard characters: False ``` ### -WsFedPassiveMetadataUri + URI used by the WS-federation Web requestor protocol. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -698,6 +748,7 @@ 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. 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. @@ -709,7 +760,7 @@ This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -720,12 +771,13 @@ Accept wildcard characters: False ``` ### -EnableMediaBasicAuth + When set to True ($True), enables basic authentication for media. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -736,13 +788,14 @@ 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). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -753,10 +806,29 @@ Accept wildcard characters: False ``` ### -HstsMaxAgeInSeconds + 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: Int64 +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 +``` + +### -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. + ```yaml Type: Int64 Parameter Sets: (All) @@ -770,7 +842,30 @@ 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. + +```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 +``` + ### -MobilePreferredAuthType + Specifies the default authentication method used for mobile client connectivity. Values can include: None | OAuth | WebTicketServiceAnon | WebTicketServiceWinNegotiate | WebTicketServiceWinNtlm | WebTicketServiceCert | WebTicketServicePin | WsFedPassive | WsFedBearer | WebTicketServiceAuth. @@ -779,7 +874,7 @@ Note that if this value is set to a method that is not supported, the web ticket ```yaml Type: MobilePreferredAuthType Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -790,12 +885,13 @@ 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. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -806,13 +902,14 @@ Accept wildcard characters: False ``` ### -UseWebClientLegacyUI + 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: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -822,18 +919,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OverrideAuthTypeForExternalClients + +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideAuthTypeForInternalClients + +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). + +```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). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Web.WebServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings + The `Set-CsWebServiceConfiguration` cmdlet accepts pipelined input of the Web Services settings object. ## OUTPUTS -### +### None + The `Set-CsWebServiceConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. @@ -846,4 +977,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) [Remove-CsWebServiceConfiguration](Remove-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md index 7cac13250b..cb19f7f293 100644 --- a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsXmppAllowedPartner @@ -102,7 +107,7 @@ Additional XMPP domains belonging to the allowed partner. Type: PSListModifier 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 Required: False Position: Named @@ -118,7 +123,7 @@ Prompts you for confirmation before executing the command. 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 @@ -134,7 +139,7 @@ Specifies the maximum number of simultaneous connections to a specific partner. Type: UInt32 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 Required: False Position: Named @@ -151,7 +156,7 @@ For example, the Description might include contact information for the partner. 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 Required: False Position: Named @@ -167,7 +172,7 @@ Indicates whether or not the XMPP partner should periodically transmit "keep ali 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 Required: False Position: Named @@ -183,7 +188,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -199,7 +204,7 @@ Fully qualified domain name (FQDN) of the XMPP allowed partner to be modified (f 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 Required: False Position: 2 @@ -215,7 +220,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance Aliases: -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 @@ -239,7 +244,7 @@ The default value is PublicUnverified. Type: PartnerType 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 Required: False Position: Named @@ -255,7 +260,7 @@ Full qualified domain name of the proxy server used by the XMPP partner. 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 Required: False Position: Named @@ -279,7 +284,7 @@ The default value is Required. Type: SaslNegotiation 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 Required: False Position: Named @@ -303,7 +308,7 @@ The default value is True. 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 Required: False Position: Named @@ -328,7 +333,7 @@ The default value is Required. Type: TlsNegotiation 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 Required: False Position: Named @@ -344,7 +349,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -354,7 +359,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -376,4 +381,3 @@ Instead, the `Set-CsXmppAllowedPartner` cmdlet modifies existing instances of th [New-CsXmppAllowedPartner](New-CsXmppAllowedPartner.md) [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md b/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md index e7973d5e42..4a97a22ae7 100644 --- a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Set-CsXmppGatewayConfiguration @@ -87,7 +92,7 @@ The default value is 1000. Type: UInt32 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 Required: False Position: Named @@ -105,7 +110,7 @@ The XMPP gateway calls the partner back, and the communication session can then 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 Required: False Position: Named @@ -125,7 +130,7 @@ The default value is False. 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 Required: False Position: Named @@ -141,7 +146,7 @@ Suppresses the display of any non-fatal error message that might occur when runn 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 Required: False Position: Named @@ -162,7 +167,7 @@ If you prefer, however, you can use the following syntax to reference the global Type: XdsIdentity 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 Required: False Position: 2 @@ -178,7 +183,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi Type: PSObject Parameter Sets: Instance Aliases: -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 @@ -196,7 +201,7 @@ The default value is 300 seconds. Type: UInt32 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 Required: False Position: Named @@ -213,7 +218,7 @@ The default value is 20. Type: UInt32 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 Required: False Position: Named @@ -231,7 +236,7 @@ The default value is 60 seconds. Type: UInt32 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 Required: False Position: Named @@ -248,7 +253,7 @@ The default value is 600 seconds (10 minutes). Type: UInt32 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 Required: False Position: Named @@ -265,7 +270,7 @@ The default value is 28800 seconds (8 hours). Type: UInt32 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 Required: False Position: Named @@ -281,7 +286,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -291,7 +296,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -309,4 +314,3 @@ Instead, the `Set-CsXmppGatewayConfiguration` cmdlet modifies existing instances ## RELATED LINKS [Get-CsXmppGatewayConfiguration](Get-CsXmppGatewayConfiguration.md) - diff --git a/skype/skype-ps/skype/Show-CsClsLogging.md b/skype/skype-ps/skype/Show-CsClsLogging.md index 4a3b67e5ab..034eb323fd 100644 --- a/skype/skype-ps/skype/Show-CsClsLogging.md +++ b/skype/skype-ps/skype/Show-CsClsLogging.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Show-CsClsLogging @@ -40,7 +45,7 @@ The `Show-CsClsLogging` cmdlet returns information about all the scenarios curre Show-CsClsLogging ``` -The command shown in Example 1 returns information about the scenarios currently being logged on all the Computers in the topology. +The command shown in Example 1 returns information about the scenarios currently being logged on the server where this cmdlet is run. ### -------------------------- Example 2 -------------------------- @@ -48,7 +53,7 @@ The command shown in Example 1 returns information about the scenarios currently Show-CsClsLogging -Pools "atl-cs-001.litwareinc.com" ``` -In Example 2, logging information is returned for all the servers in the pool `atl-cs-001…litwareinc.com…` +In Example 2, logging information is returned for all the servers in the pool `atl-cs-001...litwareinc.com...` ## PARAMETERS @@ -121,7 +126,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -148,4 +153,3 @@ The `Show-CsClsLogging` cmdlet does not return objects. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Start-CsClsLogging.md b/skype/skype-ps/skype/Start-CsClsLogging.md index 592c450794..52f1ac216a 100644 --- a/skype/skype-ps/skype/Start-CsClsLogging.md +++ b/skype/skype-ps/skype/Start-CsClsLogging.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Start-CsClsLogging @@ -105,7 +110,7 @@ Multiple servers can be specified by separating the computer FQDNs using commas: `-Computers "atl-server-001.litwareinc.com","red-server-002.litwareinc.com"` -If you do not include the Computers parameter or the Pools parameter, the `Start-CsClsLogging` cmdlet will automatically run against all the computers in the topology. +If you do not include the Computers parameter or the Pools parameter, the `Start-CsClsLogging` cmdlet will automatically run against the server you are connected to. ```yaml @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -203,4 +208,3 @@ The `Start-CsClsLogging` cmdlet does not return objects. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Start-CsExMeetingMigration.md b/skype/skype-ps/skype/Start-CsExMeetingMigration.md deleted file mode 100644 index ae4f852ebe..0000000000 --- a/skype/skype-ps/skype/Start-CsExMeetingMigration.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Start-CsExMeetingMigration -schema: 2.0.0 ---- - -# Start-CsExMeetingMigration - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Start-CsExMeetingMigration [-SourceMeetingType <MmsSourceMeetingTypes>] [-TargetMeetingType <MmsTargetMeetingTypes>] - [-Tenant <Guid>] [-Identity] <UserIdParameter> [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Start-CsPool.md b/skype/skype-ps/skype/Start-CsPool.md index de1dcd500b..61b0bbeaf5 100644 --- a/skype/skype-ps/skype/Start-CsPool.md +++ b/skype/skype-ps/skype/Start-CsPool.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Start-CsPool @@ -162,7 +167,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -181,4 +186,3 @@ None [Backup-CsPool](Backup-CsPool.md) [Get-CsPool](Get-CsPool.md) - diff --git a/skype/skype-ps/skype/Start-CsWindowsService.md b/skype/skype-ps/skype/Start-CsWindowsService.md index 10e94c24cc..ab1c0c8008 100644 --- a/skype/skype-ps/skype/Start-CsWindowsService.md +++ b/skype/skype-ps/skype/Start-CsWindowsService.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Start-CsWindowsService @@ -232,7 +237,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -253,4 +258,3 @@ Instead, the `Start-CsWindowsService` cmdlet starts instances of the Microsoft.R [Get-CsWindowsService](Get-CsWindowsService.md) [Stop-CsWindowsService](Stop-CsWindowsService.md) - diff --git a/skype/skype-ps/skype/Stop-CsClsLogging.md b/skype/skype-ps/skype/Stop-CsClsLogging.md index cb8282b8ac..46d2784689 100644 --- a/skype/skype-ps/skype/Stop-CsClsLogging.md +++ b/skype/skype-ps/skype/Stop-CsClsLogging.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Stop-CsClsLogging @@ -101,7 +106,7 @@ Multiple servers can be specified by separating the computer FQDNs using commas: `-Computers "atl-server-001.litwareinc.com","red-server-002.litwareinc.com"` -If you do not include the Computers parameter or the Pools parameter, the `Stop-CsClsLogging` cmdlet will run the command against all pools in the topology. +If you do not include the Computers parameter or the Pools parameter, the `Stop-CsClsLogging` cmdlet will automatically run against the server you are connected to. ```yaml @@ -142,7 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -169,4 +174,3 @@ The `Stop-CsClsLogging` cmdlet does not return objects. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Stop-CsWindowsService.md b/skype/skype-ps/skype/Stop-CsWindowsService.md index c33fdcbfdd..fa3302b7ad 100644 --- a/skype/skype-ps/skype/Stop-CsWindowsService.md +++ b/skype/skype-ps/skype/Stop-CsWindowsService.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Stop-CsWindowsService @@ -273,7 +278,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Sync-CsClsLogging.md b/skype/skype-ps/skype/Sync-CsClsLogging.md index 0c76839f64..f1e1fb7909 100644 --- a/skype/skype-ps/skype/Sync-CsClsLogging.md +++ b/skype/skype-ps/skype/Sync-CsClsLogging.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Sync-CsClsLogging @@ -123,7 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -150,4 +155,3 @@ The `Sync-CsClsLogging` cmdlet does not return objects. [Stop-CsClsLogging](Stop-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Sync-CsUserData.md b/skype/skype-ps/skype/Sync-CsUserData.md index 6d240b19d4..24515c4190 100644 --- a/skype/skype-ps/skype/Sync-CsUserData.md +++ b/skype/skype-ps/skype/Sync-CsUserData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Sync-CsUserData @@ -107,7 +112,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,4 +136,3 @@ None. [Import-CsUserData](Import-CsUserData.md) [Update-CsUserData](Update-CsUserData.md) - diff --git a/skype/skype-ps/skype/Test-CsASConference.md b/skype/skype-ps/skype/Test-CsASConference.md index d87b6e31d0..099b932352 100644 --- a/skype/skype-ps/skype/Test-CsASConference.md +++ b/skype/skype-ps/skype/Test-CsASConference.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsASConference @@ -348,7 +353,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -368,4 +373,3 @@ The `Test-CsASConference` cmdlet returns an instance of the Microsoft.Rtc.Synthe [Get-CsConferencingPolicy](Get-CsConferencingPolicy.md) [Test-CsDataConference](Test-CsDataConference.md) - diff --git a/skype/skype-ps/skype/Test-CsAVConference.md b/skype/skype-ps/skype/Test-CsAVConference.md index 33694c8622..10358b7db6 100644 --- a/skype/skype-ps/skype/Test-CsAVConference.md +++ b/skype/skype-ps/skype/Test-CsAVConference.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsAVConference @@ -373,7 +378,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -392,4 +397,3 @@ The `Test-CsAVConference` cmdlet returns an instance of the Microsoft.Rtc.Synthe [Get-CsAVEdgeConfiguration](Get-CsAVEdgeConfiguration.md) [Test-CsDialInConferencing](Test-CsDialInConferencing.md) - diff --git a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md b/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md index 2b7f81c9bf..4a02865927 100644 --- a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md +++ b/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsAVEdgeConnectivity @@ -303,7 +308,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -321,4 +326,3 @@ The `Test-CsAVEdgeConnectivity` cmdlet returns instances of the Microsoft.Rtc.Sy ## RELATED LINKS [Get-CsAVEdgeConfiguration](Get-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsAddressBookService.md b/skype/skype-ps/skype/Test-CsAddressBookService.md index 4e8b60a82f..cd35b1f681 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookService.md +++ b/skype/skype-ps/skype/Test-CsAddressBookService.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsAddressBookService @@ -356,7 +361,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -376,4 +381,3 @@ The `Test-CsAddressBookService` cmdlet returns an instance of the Microsoft.Rtc. [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) [Update-CsAddressBook](Update-CsAddressBook.md) - diff --git a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md b/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md index a4ca733298..6347a249c5 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md +++ b/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsAddressBookWebQuery @@ -400,7 +405,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -420,4 +425,3 @@ The `Test-CsAddressBookWebQuery` cmdlet returns an instance of the Microsoft.Rtc [Test-CsAddressBookService](Test-CsAddressBookService.md) [Update-CsAddressBook](Update-CsAddressBook.md) - diff --git a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md b/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md index 1cd96c2faa..5c7f75a011 100644 --- a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md +++ b/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsAudioConferencingProvider @@ -331,7 +336,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -347,4 +352,3 @@ The `Test-CsAudioConferencingProvider` cmdlet returns an instance of the Microso ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md b/skype/skype-ps/skype/Test-CsCertificateConfiguration.md index eafaf5aae7..a47d84c519 100644 --- a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md +++ b/skype/skype-ps/skype/Test-CsCertificateConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsCertificateConfiguration @@ -83,7 +88,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -101,4 +106,3 @@ The `Test-CsCertificateConfiguration` cmdlet returns instances of the Microsoft. ## RELATED LINKS [Get-CsCertificate](Get-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Test-CsClientAuth.md b/skype/skype-ps/skype/Test-CsClientAuth.md index e0a7653773..6bd285963b 100644 --- a/skype/skype-ps/skype/Test-CsClientAuth.md +++ b/skype/skype-ps/skype/Test-CsClientAuth.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: hirshah +ms.reviewer: --- # Test-CsClientAuth @@ -188,7 +193,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -203,4 +208,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsClientAuthentication.md b/skype/skype-ps/skype/Test-CsClientAuthentication.md index 775e1025b7..b8dd9c675a 100644 --- a/skype/skype-ps/skype/Test-CsClientAuthentication.md +++ b/skype/skype-ps/skype/Test-CsClientAuthentication.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsClientAuthentication @@ -223,7 +228,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -242,4 +247,3 @@ The `Test-CsClientAuthentication` cmdlet returns an instance of the Microsoft.Rt [Get-CsWebServiceConfiguration](Get-CsWebServiceConfiguration.md) [Test-CsRegistration](Test-CsRegistration.md) - diff --git a/skype/skype-ps/skype/Test-CsComputer.md b/skype/skype-ps/skype/Test-CsComputer.md index 0a29ee24a7..24f055387a 100644 --- a/skype/skype-ps/skype/Test-CsComputer.md +++ b/skype/skype-ps/skype/Test-CsComputer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsComputer @@ -86,7 +91,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -108,4 +113,3 @@ The `Test-CsComputer` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT [Enable-CsComputer](Enable-CsComputer.md) [Get-CsComputer](Get-CsComputer.md) - diff --git a/skype/skype-ps/skype/Test-CsDataConference.md b/skype/skype-ps/skype/Test-CsDataConference.md index 1aec6a02e4..261a1b7fce 100644 --- a/skype/skype-ps/skype/Test-CsDataConference.md +++ b/skype/skype-ps/skype/Test-CsDataConference.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsDataConference @@ -62,7 +67,7 @@ $credential2 = Get-Credential "litwareinc\kenmyer" Test-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" -SenderSipAddress "sip:pilar@litwareinc.com" -SenderCredential $credential1 -ReceiverSipAddress "sip:kenmyer@litwareinc.com" -ReceiverCredential $credential2 ``` -The commands shown in Example 2 test the ability of a pair of users (litwareinc\pilar and litwareinc\kenmyer) to log on to Skype for Business Server and then conduct an data conference. +The commands shown in Example 2 test the ability of a pair of users (litwareinc\pilar and litwareinc\kenmyer) to log on to Skype for Business Server and then conduct a data conference. To do this, the first command in the example uses the `Get-Credential` cmdlet to create a Windows PowerShell command-line interface credential object containing the name and password of the user Pilar Ackerman. (Because the logon name, litwareinc\pilar, has been included as a parameter, the Windows PowerShell Credential Request dialog box only requires the administrator to enter the password for the Pilar Ackerman account.) The resulting credential object is then stored in a variable named $cred1. The second command does the same thing, this time returning a credential object for the Ken Myer account. @@ -372,7 +377,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -390,4 +395,3 @@ The `Test-CsDataConference` cmdlet returns instances of the Microsoft.Rtc.Synthe ## RELATED LINKS [Test-CsASConference](Test-CsASConference.md) - diff --git a/skype/skype-ps/skype/Test-CsDatabase.md b/skype/skype-ps/skype/Test-CsDatabase.md index eee7ed8909..8d7c71703f 100644 --- a/skype/skype-ps/skype/Test-CsDatabase.md +++ b/skype/skype-ps/skype/Test-CsDatabase.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsDatabase @@ -282,7 +287,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -304,4 +309,3 @@ The `Test-CsDatabase` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT [Get-CsService](Get-CsService.md) [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) - diff --git a/skype/skype-ps/skype/Test-CsDialInConferencing.md b/skype/skype-ps/skype/Test-CsDialInConferencing.md index a398594649..b081788241 100644 --- a/skype/skype-ps/skype/Test-CsDialInConferencing.md +++ b/skype/skype-ps/skype/Test-CsDialInConferencing.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsDialInConferencing @@ -334,7 +339,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -352,4 +357,3 @@ The `Test-CsDialInConferencing` cmdlet returns an instance of the Microsoft.Rtc. ## RELATED LINKS [Test-CsAVConference](Test-CsAVConference.md) - diff --git a/skype/skype-ps/skype/Test-CsDialPlan.md b/skype/skype-ps/skype/Test-CsDialPlan.md index 783e162646..77e180d416 100644 --- a/skype/skype-ps/skype/Test-CsDialPlan.md +++ b/skype/skype-ps/skype/Test-CsDialPlan.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsDialPlan @@ -114,7 +119,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -140,4 +145,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.LocationProfileTestResu [Get-CsDialPlan](Get-CsDialPlan.md) [Grant-CsDialPlan](Grant-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Test-CsEffectiveTenantDialPlan.md b/skype/skype-ps/skype/Test-CsEffectiveTenantDialPlan.md deleted file mode 100644 index dade670c65..0000000000 --- a/skype/skype-ps/skype/Test-CsEffectiveTenantDialPlan.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Test-CsEffectiveTenantDialPlan -schema: 2.0.0 ---- - -# Test-CsEffectiveTenantDialPlan - -## SYNOPSIS -Use the `Test-CsEffectiveTenantDialPlan` cmdlet to test a tenant dial plan. - -## SYNTAX - -### Identity -``` -Test-CsEffectiveTenantDialPlan [-DialedNumber <PhoneNumber>] [-Identity <UserIdParameter>] [-TenantScopeOnly] - [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EffectiveTDPName -``` -Test-CsEffectiveTenantDialPlan -DialedNumber <PhoneNumber> [-EffectiveTenantDialPlanName <String>] - [-TenantScopeOnly] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The `Test-CsEffectiveTenantDialPlan` cmdlet normalizes the dialed number by applying the normalization rules from the effective tenant dial plan that is returned for the specified user. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsEffectiveTenantDialPlan -Identity vt1_user1 | Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 - -Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity 5d3ff00a-8d23-42d0-ac9e-32a2c518bc1c_Global_Vt1TenantDialPlan2 -``` - -This example gets the Identity of a dial plan that is associated with a dialed number, and applies the retrieved tenant dial plan to normalize the dialed number. - - -## PARAMETERS - -### -DialedNumber -The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. - -```yaml -Type: PhoneNumber -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter is the effective tenant dial plan name in the form of TenantId_GlobalVoiceDialPlan_TenantDialPlan. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EffectiveTenantDialPlanName -{{Fill EffectiveTenantDialPlanName Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantScopeOnly -{{Fill TenantScopeOnly Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md b/skype/skype-ps/skype/Test-CsExStorageConnectivity.md index 59ba1e0a8f..c2e02985e3 100644 --- a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md +++ b/skype/skype-ps/skype/Test-CsExStorageConnectivity.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsExStorageConnectivity @@ -186,7 +191,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -204,4 +209,3 @@ The `Test-CsExStorageConnectivity` cmdlet returns instances of the Microsoft.Rtc ## RELATED LINKS [Test-CsExStorageNotification](Test-CsExStorageNotification.md) - diff --git a/skype/skype-ps/skype/Test-CsExStorageNotification.md b/skype/skype-ps/skype/Test-CsExStorageNotification.md index 2271ae5b26..0a1a1928e8 100644 --- a/skype/skype-ps/skype/Test-CsExStorageNotification.md +++ b/skype/skype-ps/skype/Test-CsExStorageNotification.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsExStorageNotification @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -146,4 +151,3 @@ The `Test-CsExStorageNotification` cmdlet returns instances of the Microsoft.Rtc ## RELATED LINKS [Test-CsExStorageConnectivity](Test-CsExStorageConnectivity.md) - diff --git a/skype/skype-ps/skype/Test-CsExUMConnectivity.md b/skype/skype-ps/skype/Test-CsExUMConnectivity.md index 6d4cc13cdf..89de2a0acc 100644 --- a/skype/skype-ps/skype/Test-CsExUMConnectivity.md +++ b/skype/skype-ps/skype/Test-CsExUMConnectivity.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsExUMConnectivity @@ -279,7 +284,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -297,4 +302,3 @@ The `Test-CsExUMConnectivity` cmdlet returns an instance of the Microsoft.Rtc.Sy ## RELATED LINKS [Test-CsExUMVoiceMail](Test-CsExUMVoiceMail.md) - diff --git a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md b/skype/skype-ps/skype/Test-CsExUMVoiceMail.md index 6c4337e3a2..54fb97e64e 100644 --- a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md +++ b/skype/skype-ps/skype/Test-CsExUMVoiceMail.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsExUMVoiceMail @@ -185,11 +190,11 @@ 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` +`$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` +`$TestOutput.ToXML() > C:\Logs\TestOutput.xml` ```yaml Type: String @@ -332,7 +337,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -350,4 +355,3 @@ The `Test-CsExUMVoiceMail` cmdlet returns an instance of the Microsoft.Rtc.Synth ## RELATED LINKS [Test-CsExUMConnectivity](Test-CsExUMConnectivity.md) - diff --git a/skype/skype-ps/skype/Test-CsFederatedPartner.md b/skype/skype-ps/skype/Test-CsFederatedPartner.md index 3baa73bb6a..91379de7a9 100644 --- a/skype/skype-ps/skype/Test-CsFederatedPartner.md +++ b/skype/skype-ps/skype/Test-CsFederatedPartner.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsFederatedPartner @@ -24,7 +29,7 @@ Test-CsFederatedPartner [-TargetFqdn] <String> [-Domain] <String> [-Certificate `Test-CsFederatedPartner` verifies your ability to connect to the domain of a federated partner. In order to verify the connectivity to a domain, that domain must be listed in the collection of allowed (federated) domains. Domains can be added to the allowed list by using the `New-CsAllowedDomain` cmdlet. -When using this cmdlet, make sure that the TargetFqdn parameter points to the internal edge of the proxy server to which federated SIP traffic is directed. +When using this cmdlet, make sure that the TargetFqdn parameter points to the internal Edge Server FQDN to which federated SIP traffic is directed. ## EXAMPLES @@ -35,12 +40,12 @@ Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain fabrikam. ``` The command shown in Example 1 verifies the connection between the local access proxy server (accessproxy.litwareinc.com) and the federated domain Fabrikam.com. -Note that TargetFqdn must point to the internal edge of the proxy server to which federated SIP traffic is directed. +Note that TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. ### -------------------------- Example 2 -------------------------- ``` -Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinco.com -Domain push.lync.com -ProxyFqdn sipfed.online.lync.com +Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain push.lync.com -ProxyFqdn sipfed.online.lync.com ``` Example 2 shows how you can test the connection between your domain and the Lync Server Push Notification Service. @@ -80,7 +85,7 @@ 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 of the proxy server to which federated SIP traffic is directed. +The TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. ```yaml Type: String @@ -211,7 +216,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -229,4 +234,3 @@ None. ## RELATED LINKS [Get-CsAllowedDomain](Get-CsAllowedDomain.md) - diff --git a/skype/skype-ps/skype/Test-CsGroupExpansion.md b/skype/skype-ps/skype/Test-CsGroupExpansion.md index 0861ce561a..857d5182b8 100644 --- a/skype/skype-ps/skype/Test-CsGroupExpansion.md +++ b/skype/skype-ps/skype/Test-CsGroupExpansion.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsGroupExpansion @@ -371,7 +376,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -391,4 +396,3 @@ The `Test-CsGroupExpansion` cmdlet returns an instance of the Microsoft.Rtc.Synt [Test-CsAddressBookService](Test-CsAddressBookService.md) [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) - diff --git a/skype/skype-ps/skype/Test-CsGroupIM.md b/skype/skype-ps/skype/Test-CsGroupIM.md index d3bdc79606..02b1dae31c 100644 --- a/skype/skype-ps/skype/Test-CsGroupIM.md +++ b/skype/skype-ps/skype/Test-CsGroupIM.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsGroupIM @@ -387,7 +392,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -405,4 +410,3 @@ The `Test-CsGroupIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTr ## RELATED LINKS [Test-CsIM](Test-CsIM.md) - diff --git a/skype/skype-ps/skype/Test-CsIM.md b/skype/skype-ps/skype/Test-CsIM.md index 25955de384..76029053a9 100644 --- a/skype/skype-ps/skype/Test-CsIM.md +++ b/skype/skype-ps/skype/Test-CsIM.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsIM @@ -472,7 +477,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -490,4 +495,3 @@ The `Test-CsIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransac ## RELATED LINKS [Test-CsGroupIM](Test-CsGroupIM.md) - diff --git a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md b/skype/skype-ps/skype/Test-CsInterTrunkRouting.md index b71358b460..c0afe78bea 100644 --- a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md +++ b/skype/skype-ps/skype/Test-CsInterTrunkRouting.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsInterTrunkRouting @@ -118,7 +123,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +143,3 @@ None. [Get-CsTrunk](Get-CsTrunk.md) [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md index 9984019908..f5ecfa9315 100644 --- a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsKerberosAccountAssignment @@ -91,7 +96,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -115,4 +120,3 @@ The `Test-CsKerberosAccountAssignment` cmdlet does not return any objects or val [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Test-CsLisCivicAddress.md b/skype/skype-ps/skype/Test-CsLisCivicAddress.md index 58261e374c..2ff376a8bc 100644 --- a/skype/skype-ps/skype/Test-CsLisCivicAddress.md +++ b/skype/skype-ps/skype/Test-CsLisCivicAddress.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsLisCivicAddress @@ -289,7 +294,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -306,4 +311,3 @@ This cmdlet does not return a value. ## RELATED LINKS [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Test-CsLisConfiguration.md b/skype/skype-ps/skype/Test-CsLisConfiguration.md index ac689f7f68..40c2654be8 100644 --- a/skype/skype-ps/skype/Test-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Test-CsLisConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsLisConfiguration @@ -95,7 +100,7 @@ Test-CsLisConfiguration -TargetUri https://atl-cs-001.litwareinc.com/locationinf The first line of this example calls the `Get-Credential` cmdlet, which prompts the user for a user ID and password. This information is stored in an encrypted fashion in the variable $cred. -Line 2 tests the LIS configuration by making a call to the web service URI (https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc) based on the SIP address of the remote user (sip:kmyer@litwareinc.com), and using the credentials we obtained in line 1 by passing them to the WebCredential parameter. +Line 2 tests the LIS configuration by making a call to the web service URI (`https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc`) based on the SIP address of the remote user (sip:kmyer@litwareinc.com), and using the credentials we obtained in line 1 by passing them to the WebCredential parameter. The test will be successful if a connection can be made with the given user credentials to the LIS web service at that URI. If a location can be found that maps to the subnet IP address 192.168.0.0, the MAC address 0A-23-00-00-00-AA or the Port ID 4500 and ChassisId 0A-23-00-00-00-AA, that location address will be returned. @@ -474,7 +479,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -499,4 +504,3 @@ The `Test-CsLisConfiguration` cmdlet returns an instance of the Microsoft.Rtc.Sy [Import-CsLisConfiguration](Import-CsLisConfiguration.md) [Export-CsLisConfiguration](Export-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsLocationPolicy.md b/skype/skype-ps/skype/Test-CsLocationPolicy.md index a896d53405..a4881b7d5b 100644 --- a/skype/skype-ps/skype/Test-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Test-CsLocationPolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsLocationPolicy @@ -311,7 +316,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -342,4 +347,3 @@ The `Test-CsLocationPolicy` cmdlet returns an instance of the Microsoft.Rtc.Synt [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) [Set-CsNetworkSite](Set-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/Test-CsManagementServer.md b/skype/skype-ps/skype/Test-CsManagementServer.md index f4ba1e020f..3f9787e03b 100644 --- a/skype/skype-ps/skype/Test-CsManagementServer.md +++ b/skype/skype-ps/skype/Test-CsManagementServer.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsManagementServer @@ -58,7 +63,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -76,4 +81,3 @@ The `Test-CsManagementServer` cmdlet returns an instance of the Microsoft.Rtc.Sy ## RELATED LINKS [Set-CsManagementServer](Set-CsManagementServer.md) - diff --git a/skype/skype-ps/skype/Test-CsMcxConference.md b/skype/skype-ps/skype/Test-CsMcxConference.md index cf4fb4fa55..ead7987bb7 100644 --- a/skype/skype-ps/skype/Test-CsMcxConference.md +++ b/skype/skype-ps/skype/Test-CsMcxConference.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxconference +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxConference schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Test-CsMcxConference @@ -304,7 +309,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -320,4 +325,3 @@ The `Test-CsMcxConference` cmdlet returns an instance of the Microsoft.Rtc.Synth ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsMcxP2PIM.md b/skype/skype-ps/skype/Test-CsMcxP2PIM.md index ca9e567b2f..b56a148b8b 100644 --- a/skype/skype-ps/skype/Test-CsMcxP2PIM.md +++ b/skype/skype-ps/skype/Test-CsMcxP2PIM.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxP2PIM schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Test-CsMcxP2PIM @@ -257,7 +262,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -273,4 +278,3 @@ The `Test-CsMcxP2PIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsMcxPushNotification.md b/skype/skype-ps/skype/Test-CsMcxPushNotification.md index 8dab1114c2..cc044294c2 100644 --- a/skype/skype-ps/skype/Test-CsMcxPushNotification.md +++ b/skype/skype-ps/skype/Test-CsMcxPushNotification.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxPushNotification schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Test-CsMcxPushNotification @@ -149,7 +154,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -165,4 +170,3 @@ The `Test-CsMcxPushNotification` cmdlet returns an instance of the Microsoft.Rtc ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsOUPermission.md b/skype/skype-ps/skype/Test-CsOUPermission.md index 8c7ec46956..1dfd1ab566 100644 --- a/skype/skype-ps/skype/Test-CsOUPermission.md +++ b/skype/skype-ps/skype/Test-CsOUPermission.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsOUPermission @@ -188,7 +193,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -208,4 +213,3 @@ The `Test-CsOUPermission` cmdlet returns an instance of the Microsoft.Rtc.Synthe [Grant-CsOUPermission](Grant-CsOUPermission.md) [Revoke-CsOUPermission](Revoke-CsOUPermission.md) - diff --git a/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md b/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md deleted file mode 100644 index 9d2c8eca4b..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Test-CsOnlineCarrierPortabilityIn -schema: 2.0.0 ---- - -# Test-CsOnlineCarrierPortabilityIn - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. - - -## SYNTAX - -``` -Test-CsOnlineCarrierPortabilityIn -TelephoneNumbers <String[]> [-DomainController <Fqdn>] [-Force] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - - -## PARAMETERS - -### -TelephoneNumbers -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md deleted file mode 100644 index ede7539ed8..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,368 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Test-CsOnlineLisCivicAddress -schema: 2.0.0 ---- - -# Test-CsOnlineLisCivicAddress - - -## SYNOPSIS -Use the `Test-CsOnlineLisCivicAddress` cmdlet to verify that a civic address exists in the master street address guide (MSAG), and is suitable for emergency dispatch. - - -## SYNTAX - -### TestWithExistingAddr (Default) -``` -Test-CsOnlineLisCivicAddress -CivicAddressId <Guid> [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - -### TestWithNewAddr -``` -Test-CsOnlineLisCivicAddress -CompanyName <String> [-CompanyTaxId <String>] [-HouseNumber <String>] - [-HouseNumberSuffix <String>] [-StreetName <String>] [-StreetSuffix <String>] [-PostDirectional <String>] - [-PreDirectional <String>] [-City <String>] [-StateOrProvince <String>] -CountryOrRegion <String> - [-PostalCode <String>] [-Description <String>] [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] - [<CommonParameters>] -``` - - -## DESCRIPTION -The `Test-CsOnlineLisCivicAddress` cmdlet operates in two modes. - -Validate and report: When called along with a list of address parameters, the cmdlet will test the address and report the result. -Neither the address, nor the validation status is saved in the Location Information Service (LIS.) Use this mode to verify the address before creating it using the `New-CsOnlineLisCivicAddress` cmdlet. - -Validate and save: When called with only the CivicAddressId parameter specified, the cmdlet will test the address and, if validated, save the validation status in the Location Information Service (LIS.) - -The `Test-CsOnlineLisCivicAddress` produces three results: - -Accepted as is: The address entered (validate and report mode), or specified (validate and save mode) is valid. - -Accepted with changes: The address entered or specified would be valid with changes. -The changes required are specified in the output. - -Rejected: The address entered or specified cannot be found, and no suggested changes can be defined. -The output will contain the reason the validation failed. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -``` - -This example tests emergency dispatch suitability for the civic address with the specified identification. - - -### -------------------------- Example 2 -------------------------- -``` -Test-CsOnlineLisCivicAddress -HouseNumber 3910 -StreetName Smith -StreetSuffix Street -PostDirectional NE -City Redmond -StateorProvince Washington -CountryOrRegion US -PostalCode 98052 -Description "Puget Sound" -CompanyName Contoso -``` - -This examples tests the emergency dispatch suitability for the civic address specified by address definition parameters. - - -## PARAMETERS - -### -CivicAddressId -Specifies the identification number of the civic address to test. -If specified, no other address definition parameters are allowed. -Civic address identities can be discovered by using the `Get-CsOnlineLisCivicAddress` cmdlet. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyName -Specifies the name of your organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the country or region of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the city of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyTaxId -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an administrator defined description of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumber -Specifies the numeric portion of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumberSuffix -Specifies the numeric suffix of the civic address. -For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the postal code of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -Specifies the state or province of the new civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetName -Specifies the street name of the civic address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetSuffix -Specifies a modifier of the street name of the civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -The address accepts pipelined input from the `Get-CsOnlineLisCivicAddress` cmdlet. - -## OUTPUTS - -### -None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md b/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md deleted file mode 100644 index bede186eab..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Test-CsOnlinePortabilityIn -schema: 2.0.0 ---- - -# Test-CsOnlinePortabilityIn - -## SYNOPSIS -Tests the ability to use ported phone numbers from your current service provider to Skype for Business. - -## SYNTAX - -``` -Test-CsOnlinePortabilityIn [-TelephoneNumbers <String[]>] [-TelephoneNumberRanges <String[][]>] - [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Tests the ability to use ported phone numbers from your current service provider to Skype for Business. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberRanges -Defines a telephone number range to test. For example, let's say you want to test all of your 25 phone numbers (+1 425-555-1235 through 1259). You should enter: "+14255551234-+14255551259". - -```yaml -Type: String[][] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumbers -Defines a list of telephone numbers to test. For example, let's say you want to test +1 425-555-1235, +1 425-555-1245 and +1 425-555-1259. You should enter: "+14255551235,+14255551245,+14255551259". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsP2PAV.md b/skype/skype-ps/skype/Test-CsP2PAV.md index 04ace1d9cd..8c3e9d9900 100644 --- a/skype/skype-ps/skype/Test-CsP2PAV.md +++ b/skype/skype-ps/skype/Test-CsP2PAV.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsP2PAV @@ -365,7 +370,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -383,4 +388,3 @@ The `Test-CsP2PAV` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTran ## RELATED LINKS [Test-CsAVConference](Test-CsAVConference.md) - diff --git a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md b/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md index bfec2277e7..73035ead45 100644 --- a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md +++ b/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsP2PVideoInteropServerSipTrunkAV @@ -270,7 +275,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -293,4 +298,3 @@ None [New-CsVideoInteropServerSyntheticTransactionConfiguration](New-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md b/skype/skype-ps/skype/Test-CsPersistentChatMessage.md index d5a4e99c20..d670ad8f25 100644 --- a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md +++ b/skype/skype-ps/skype/Test-CsPersistentChatMessage.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-cspersistentchatmessage +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPersistentChatMessage schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Test-CsPersistentChatMessage @@ -396,7 +401,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -418,4 +423,3 @@ The `Test-CsPersistentChatMessage` cmdlet returns instances of the Microsoft.Rtc [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md b/skype/skype-ps/skype/Test-CsPhoneBootstrap.md index b40790df91..d6cb06ded2 100644 --- a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md +++ b/skype/skype-ps/skype/Test-CsPhoneBootstrap.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsPhoneBootstrap @@ -260,7 +265,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -278,4 +283,3 @@ The `Test-CsPhoneBootstrap` cmdlet returns an instance of the Microsoft.Rtc.Synt ## RELATED LINKS [Test-CsRegistration](Test-CsRegistration.md) - diff --git a/skype/skype-ps/skype/Test-CsPresence.md b/skype/skype-ps/skype/Test-CsPresence.md index c1fc192a4c..8a2d1f60ca 100644 --- a/skype/skype-ps/skype/Test-CsPresence.md +++ b/skype/skype-ps/skype/Test-CsPresence.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsPresence @@ -383,7 +388,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -401,4 +406,3 @@ The `Test-CsPresence` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT ## RELATED LINKS [Test-CsRegistration](Test-CsRegistration.md) - diff --git a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md b/skype/skype-ps/skype/Test-CsPstnOutboundCall.md index 918f73ebec..dad3350baa 100644 --- a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md +++ b/skype/skype-ps/skype/Test-CsPstnOutboundCall.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsPstnOutboundCall @@ -335,7 +340,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -353,4 +358,3 @@ The `Test-CsPstnOutboundCall` cmdlet returns an instance of the Microsoft.Rtc.Sy ## RELATED LINKS [Test-CsPstnPeerToPeerCall](Test-CsPstnPeerToPeerCall.md) - diff --git a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md b/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md index aa6d61d235..58c8bf1766 100644 --- a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md +++ b/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsPstnPeerToPeerCall @@ -378,7 +383,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -396,4 +401,3 @@ The `Test-CsPstnPeerToPeerCall` cmdlet returns an instance of the Microsoft.Rtc. ## RELATED LINKS [Test-CsPstnOutboundCall](Test-CsPstnOutboundCall.md) - diff --git a/skype/skype-ps/skype/Test-CsRegistration.md b/skype/skype-ps/skype/Test-CsRegistration.md index 35f1d3c87c..6310aa0ec1 100644 --- a/skype/skype-ps/skype/Test-CsRegistration.md +++ b/skype/skype-ps/skype/Test-CsRegistration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsRegistration @@ -306,7 +311,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -324,4 +329,3 @@ The `Test-CsRegistration` cmdlet returns an instance of the Microsoft.Rtc.Synthe ## RELATED LINKS [Test-CsClientAuth](Test-CsClientAuth.md) - diff --git a/skype/skype-ps/skype/Test-CsReplica.md b/skype/skype-ps/skype/Test-CsReplica.md index 08bb33a1ff..fa960e4ed6 100644 --- a/skype/skype-ps/skype/Test-CsReplica.md +++ b/skype/skype-ps/skype/Test-CsReplica.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsReplica @@ -111,7 +116,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -127,4 +132,3 @@ The `Test-CsReplica` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTr ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsSetupPermission.md b/skype/skype-ps/skype/Test-CsSetupPermission.md index acc622e651..d3a68325b5 100644 --- a/skype/skype-ps/skype/Test-CsSetupPermission.md +++ b/skype/skype-ps/skype/Test-CsSetupPermission.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsSetupPermission @@ -147,7 +152,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -167,4 +172,3 @@ The `Test-CsSetupPermission` cmdlet returns an instance of the Microsoft.Rtc.Syn [Grant-CsSetupPermission](Grant-CsSetupPermission.md) [Revoke-CsSetupPermission](Revoke-CsSetupPermission.md) - diff --git a/skype/skype-ps/skype/Test-CsTopology.md b/skype/skype-ps/skype/Test-CsTopology.md index bb231b0e88..09df3bc984 100644 --- a/skype/skype-ps/skype/Test-CsTopology.md +++ b/skype/skype-ps/skype/Test-CsTopology.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsTopology @@ -151,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -173,4 +178,3 @@ The `Test-CsTopology` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT [Get-CsTopology](Get-CsTopology.md) [Publish-CsTopology](Publish-CsTopology.md) - diff --git a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md b/skype/skype-ps/skype/Test-CsTrunkConfiguration.md index 183f7e89e1..7cbb042b1c 100644 --- a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Test-CsTrunkConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsTrunkConfiguration @@ -96,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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -120,4 +125,3 @@ Returns a value of type Microsoft.Rtc.Management.Voice.TrunkConfigurationTestRes [Set-CsTrunkConfiguration](Set-CsTrunkConfiguration.md) [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsUcwaConference.md b/skype/skype-ps/skype/Test-CsUcwaConference.md index 6ce10f857e..c94960225f 100644 --- a/skype/skype-ps/skype/Test-CsUcwaConference.md +++ b/skype/skype-ps/skype/Test-CsUcwaConference.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsUcwaConference @@ -337,7 +342,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -359,4 +364,3 @@ The `Test-CsUcwaConference` cmdlet returns instances of the Microsoft.Rtc.Synthe [Test-CsDataConference](Test-CsDataConference.md) [Test-CsAVConference](Test-CsAVConference.md) - diff --git a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md b/skype/skype-ps/skype/Test-CsUnifiedContactStore.md index 0d12205ad6..e4e5ffea71 100644 --- a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md +++ b/skype/skype-ps/skype/Test-CsUnifiedContactStore.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsUnifiedContactStore @@ -292,7 +297,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -312,4 +317,3 @@ The `Test-CsUnifiedContactStore` cmdlet returns instances of the Microsoft.Rtc.S [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md index 0f3a85ae3c..7506be3ac9 100644 --- a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md @@ -1,22 +1,27 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicenormalizationrule +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsVoiceNormalizationRule schema: 2.0.0 +manager: bulenteg +author: jenstrier +ms.author: serdars --- # Test-CsVoiceNormalizationRule ## SYNOPSIS Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. -Voice normalization rules are 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 used by Skype for Business Server. +Voice normalization rules are typically used to convert a telephone dialing requirement (for example, you must dial 9 to access an outside line) to the E.164 phone +number format. This cmdlet was introduced in Lync Server 2010. ## SYNTAX ``` -Test-CsVoiceNormalizationRule -DialedNumber <PhoneNumber> -NormalizationRule <NormalizationRule> [-AsJob] +Test-CsVoiceNormalizationRule -DialedNumber <PhoneNumber> -NormalizationRule <NormalizationRule> [<CommonParameters>] ``` @@ -34,7 +39,7 @@ Use this cmdlet to troubleshoot dialing issues or to verify that rules will work Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" | Test-CsVoiceNormalizationRule -DialedNumber 14255559999 ``` -This example runs a voice normalization test against the voice normalization rule with the Identity "global/11 digit number rule". +For Lync or Skype for Business Server, this example runs a voice normalization test against the voice normalization rule with the Identity "global/11 digit number rule". First the `Get-CsVoiceNormalizationRule` cmdlet is run to retrieve the rule with the Identity "global/11 digit number rule". That rule object is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where the rule is tested against the telephone number 14255559999. The output will be the DialedNumber after the voice normalization rule "global/11 digit number rule" has been applied. @@ -44,11 +49,12 @@ If this rule does not apply to the DialedNumber value (for example, if the norma ### -------------------------- Example 2 -------------------------- ``` $a = Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" - Test-CsVoiceNormalizationRule -DialedNumber 5551212 -NormalizationRule $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 NormalizationRule to be used as the voice normalization rule against which the test will run. +For Lync or Skype for Business Server, example 2 is identical to Example 1 except that instead of piping the results of the Get operation directly to the Test cmdlet, the +object is first stored in the variable $a and then is passed as the value to the parameter NormalizationRule to be used as the voice normalization rule against which the +test will run. ### -------------------------- Example 3 -------------------------- @@ -56,11 +62,36 @@ Example 2 is identical to Example 1 except that instead of piping the results of Get-CsVoiceNormalizationRule | Test-CsVoiceNormalizationRule -DialedNumber 2065559999 ``` -This example runs a voice normalization test against all voice normalization rules defined within the Skype for Business Server deployment. -First the `Get-CsVoiceNormalizationRule` cmdlet is run (with no parameters) to retrieve all the voice normalization rules. -The collection of rules that is returned is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where each rule in the collection is tested against the telephone number 2065559999. -The output will be a list of translated numbers, one for each rule tested. -If a rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) there will be a blank line in the list for that rule. +For Lync or Skype for Business Server, this example runs a voice normalization test against all voice normalization rules defined within the Skype for Business +Server deployment. First the `Get-CsVoiceNormalizationRule` cmdlet is run (with no parameters) to retrieve all the voice normalization rules. +The collection of rules that is returned is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where each rule in the collection is tested against the telephone +number 2065559999. The output will be a list of translated numbers, one for each rule tested. +If a rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) there +will be a blank line in the list for that rule. + +### -------------------------- Example 4 -------------------------- +```powershell +$nr=(Get-CsTenantDialPlan -Identity dp1).NormalizationRules +$nr[0] +``` +```output +Description : +Pattern : ^(\d{4})$ +Translation : +1206555$1 +Name : nr1 +IsInternalExtension : False +``` +```powershell +Test-CsVoiceNormalizationRule -DialedNumber 1234 -NormalizationRule $nr[0] +``` +```output +TranslatedNumber +---------------- ++12065551234 +``` + +For Microsoft Teams, this example gets all the normalization rules in the tenant dial plan DP1, shows the first of these rules, and then test that rule on the +dialed number 1234. The output shows that the rule normalize the dialed number to +12065551234. ## PARAMETERS @@ -75,7 +106,7 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber Type: PhoneNumber Parameter 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 Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named @@ -87,14 +118,14 @@ Accept wildcard characters: False ### -NormalizationRule An object containing a reference to the normalization rule against which you want to test the number specified in the DialedNumber parameter. -You can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. - +For Lync and Skype for Business Server, you can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. +For Microsoft Teams, you can retrieve voice normalization rules by calling the `Get-CsTenantDialPlan` cmdlet. ```yaml Type: NormalizationRule Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named @@ -103,24 +134,8 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Test-CsVoicePolicy.md b/skype/skype-ps/skype/Test-CsVoicePolicy.md index a23eae17f1..9e26043f76 100644 --- a/skype/skype-ps/skype/Test-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Test-CsVoicePolicy.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsVoicePolicy @@ -134,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +165,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.VoicePolicyTestResult. [Get-CsVoicePolicy](Get-CsVoicePolicy.md) [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceRoute.md b/skype/skype-ps/skype/Test-CsVoiceRoute.md index 5f0e39d87b..4291233efd 100644 --- a/skype/skype-ps/skype/Test-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Test-CsVoiceRoute.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsVoiceRoute @@ -140,7 +145,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -164,4 +169,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.VoiceRouteTestResult. [Set-CsVoiceRoute](Set-CsVoiceRoute.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md index f52d80523e..ff6c869062 100644 --- a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsVoiceTestConfiguration @@ -230,7 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -260,4 +265,3 @@ This cmdlet returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceTes [Get-CsVoicePolicy](Get-CsVoicePolicy.md) [Get-CsRoutingConfiguration](Get-CsRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceUser.md b/skype/skype-ps/skype/Test-CsVoiceUser.md index 01407d3612..d31c01af75 100644 --- a/skype/skype-ps/skype/Test-CsVoiceUser.md +++ b/skype/skype-ps/skype/Test-CsVoiceUser.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsVoiceUser @@ -115,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -132,4 +137,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceUserTestResult. ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md index 8e9c2b43c0..ab6e773b6e 100644 --- a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsWatcherNodeConfiguration @@ -82,7 +87,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -106,4 +111,3 @@ The `Test-CsWatcherNodeConfiguration` cmdlet returns an instance of the Microsof [Remove-CsWatcherNodeConfiguration](Remove-CsWatcherNodeConfiguration.md) [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsWebApp.md b/skype/skype-ps/skype/Test-CsWebApp.md index f580bd047b..fc6945a42c 100644 --- a/skype/skype-ps/skype/Test-CsWebApp.md +++ b/skype/skype-ps/skype/Test-CsWebApp.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsWebApp @@ -393,7 +398,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -410,4 +415,3 @@ The Test-CsWebApp cmdlet returns an instance of the Microsoft.Rtc.SyntheticTrans ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md b/skype/skype-ps/skype/Test-CsWebAppAnonymous.md index 392b72e648..56fef6875f 100644 --- a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md +++ b/skype/skype-ps/skype/Test-CsWebAppAnonymous.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsWebAppAnonymous @@ -343,7 +348,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -360,4 +365,3 @@ The `Test-CsWebAppAnonymous` cmdlet returns an instance of the Microsoft.Rtc.Syn ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsWebScheduler.md b/skype/skype-ps/skype/Test-CsWebScheduler.md index 549bca5392..8339aaae79 100644 --- a/skype/skype-ps/skype/Test-CsWebScheduler.md +++ b/skype/skype-ps/skype/Test-CsWebScheduler.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsWebScheduler @@ -335,7 +340,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -353,4 +358,3 @@ The `Test-CsWebScheduler` cmdlet returns instances of the Microsoft.Rtc.Syntheti ## RELATED LINKS [Set-CsWebServer](Set-CsWebServer.md) - diff --git a/skype/skype-ps/skype/Test-CsXmppIM.md b/skype/skype-ps/skype/Test-CsXmppIM.md index b009cd95c1..2f3d174cf0 100644 --- a/skype/skype-ps/skype/Test-CsXmppIM.md +++ b/skype/skype-ps/skype/Test-CsXmppIM.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Test-CsXmppIM @@ -280,7 +285,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -298,4 +303,3 @@ The `Test-CsXmppIM` cmdlet returns instances of the Microsoft.Rtc.SyntheticTrans ## RELATED LINKS [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) - diff --git a/skype/skype-ps/skype/Uninstall-CsDatabase.md b/skype/skype-ps/skype/Uninstall-CsDatabase.md index ea19eb08ab..5963d866fb 100644 --- a/skype/skype-ps/skype/Uninstall-CsDatabase.md +++ b/skype/skype-ps/skype/Uninstall-CsDatabase.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Uninstall-CsDatabase @@ -237,7 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -255,4 +260,3 @@ The `Uninstall-CsDatabase` cmdlet does not return any values or objects. ## RELATED LINKS [Install-CsDatabase](Install-CsDatabase.md) - diff --git a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md b/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md index a27ca4cf05..882ce126eb 100644 --- a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md +++ b/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Uninstall-CsMirrorDatabase @@ -78,7 +83,7 @@ User Type: DatabaseNameType 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 Required: True Position: Named @@ -100,7 +105,7 @@ This should be the FQDN of the primary SQL Server computer. 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 Required: True Position: Named @@ -116,7 +121,7 @@ Prompts you for confirmation before executing the command. 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 @@ -132,7 +137,7 @@ When present, deletes any existing copies of the mirrored databases from the mir 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 Required: False Position: Named @@ -152,7 +157,7 @@ For example: 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 Required: False Position: Named @@ -171,7 +176,7 @@ If this parameter is omitted, the `Uninstall-CsMirrorDatabase` cmdlet will use t 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 Required: False Position: Named @@ -187,7 +192,7 @@ 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 Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -197,7 +202,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -217,4 +222,3 @@ None. [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Unlock-CsClientPin.md b/skype/skype-ps/skype/Unlock-CsClientPin.md index 8c01d7dbd8..9e0e115c1e 100644 --- a/skype/skype-ps/skype/Unlock-CsClientPin.md +++ b/skype/skype-ps/skype/Unlock-CsClientPin.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Unlock-CsClientPin @@ -128,7 +133,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -152,4 +157,3 @@ Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Manage [Lock-CsClientPin](Lock-CsClientPin.md) [Set-CsClientPin](Set-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md b/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md index 83ce66a70d..6b754867cf 100644 --- a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Unpublish-CsLisConfiguration @@ -87,7 +92,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -112,4 +117,3 @@ This cmdlet does not return a value. [Export-CsLisConfiguration](Export-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md index b26eddbdb2..458d44b4aa 100644 --- a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md @@ -1,8 +1,13 @@ --- -external help file: +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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Unregister-CsHybridPSTNAppliance @@ -10,11 +15,13 @@ schema: 2.0.0 ## SYNOPSIS Use the `Unregister-CsHybridPSTNAppliance` cmdlet to unregister a previously specified Skype for Business Cloud Connector Edition appliance. +**Note**: This cmdlet will be deprecated from Teams PowerShell Module. + ## SYNTAX ``` Unregister-CsHybridPSTNAppliance [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Confirm] [-Force] - [-Instance <Object>] [-Tenant <Object>] [-WhatIf] [-AsJob] [<CommonParameters>] + [-Instance <Object>] [-Tenant <Object>] [-WhatIf] [<CommonParameters>] ``` ## DESCRIPTION @@ -154,24 +161,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -180,4 +171,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md b/skype/skype-ps/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md deleted file mode 100644 index 2747a7a897..0000000000 --- a/skype/skype-ps/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: -applicable: Skype for Business Online -title: Unregister-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 ---- - -# Unregister-CsOnlineDialInConferencingServiceNumber - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -``` -Unregister-CsOnlineDialInConferencingServiceNumber [-Identity] <String> [-BridgeId <Guid>] - [-BridgeName <String>] [-Tenant <Guid>] [-TenantDomain <String>] [-RemoveDefaultServiceNumber] - [-DomainController <Fqdn>] [-Force] [<CommonParameters>] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -PARAMVALUE: ConferencingServiceNumber - -```yaml -Type: ConferencingServiceNumber -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeId -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDefaultServiceNumber -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Update-CsAddressBook.md b/skype/skype-ps/skype/Update-CsAddressBook.md index d036cfa6b4..3db49c7148 100644 --- a/skype/skype-ps/skype/Update-CsAddressBook.md +++ b/skype/skype-ps/skype/Update-CsAddressBook.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Update-CsAddressBook @@ -87,7 +92,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -110,4 +115,3 @@ Instead, the Update-CsAddressBook cmdlet updates existing instances of the Micro [Test-CsAddressBookService](Test-CsAddressBookService.md) [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) - diff --git a/skype/skype-ps/skype/Update-CsAdminRole.md b/skype/skype-ps/skype/Update-CsAdminRole.md index 391284de24..6b1a812753 100644 --- a/skype/skype-ps/skype/Update-CsAdminRole.md +++ b/skype/skype-ps/skype/Update-CsAdminRole.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/update-csadminrole +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Update-CsAdminRole schema: 2.0.0 +manager: rogupta +author: hirenshah1 +ms.author: hirshah +ms.reviewer: --- # Update-CsAdminRole @@ -70,7 +75,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -86,7 +91,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -103,4 +108,3 @@ The Update-CsAdminRole cmdlet does not return any data or objects. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Update-CsClsLogging.md b/skype/skype-ps/skype/Update-CsClsLogging.md index f66c955788..1478045d95 100644 --- a/skype/skype-ps/skype/Update-CsClsLogging.md +++ b/skype/skype-ps/skype/Update-CsClsLogging.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Update-CsClsLogging @@ -155,7 +160,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -181,4 +186,3 @@ String value. [Stop-CsClsLogging](Stop-CsClsLogging.md) [Sync-CsClsLogging](Sync-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md deleted file mode 100644 index a08c050a8b..0000000000 --- a/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -title: Update-CsOrganizationalAutoAttendant -schema: 2.0.0 ---- - -# Update-CsOrganizationalAutoAttendant - -## SYNOPSIS -Use Update-CsOrganizationalAutoAttendant cmdlet to force an update of resources associated with an Auto Attendant (AA) provisioning. - -## SYNTAX - -``` -Update-CsOrganizationalAutoAttendant [-PrimaryUri] <Uri> [-ApplicationId <Guid>] [-Tenant <Guid>] [<CommonParameters>] -``` - -## 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 and the SIP provisioning 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-CsOrganizationalAutoAttendantStatus cmdlet. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Update-CsOrganizationalAutoAttendant -PrimaryUri "sip:mainoaa@contoso.com" -``` - -In Example 1, the Update-CsOrganizationalAutoAttendant cmdlet is used to update all resources of an auto attendant with Primary URI of sip:mainoaa@contoso.com. - -## PARAMETERS - -### -PrimaryUri -The Primary URI represents the SIP address of the auto attendant whose resources are to be updated. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies a custom application ID to use for OAAs. This parameter is reserved for Microsoft internal use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String -The Update-CsOrganizationalAutoAttendant cmdlet accepts a string as the PrimaryUri parameter. - - -## OUTPUTS - -### None - - -## NOTES - -## RELATED LINKS - -[Get-CsOrganizationalAutoAttendantStatus](Get-CsOrganizationalAutoAttendantStatus.md) - diff --git a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md b/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md index 5a514d3428..03dc67a577 100644 --- a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md +++ b/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md @@ -1,8 +1,13 @@ --- 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 +ms.author: tomkau +ms.reviewer: williamlooney --- # Update-CsTenantMeetingUrl @@ -14,7 +19,7 @@ The updated URL uses a simpler, more standardized format that makes it easier fo ## SYNTAX ``` -Update-CsTenantMeetingUrl [-Confirm] [-Force] [-Tenant <Guid>] [-WhatIf] [-AsJob] +Update-CsTenantMeetingUrl [-Confirm] [-Force] [-Tenant <Guid>] [-WhatIf] [<CommonParameters>] ``` @@ -23,18 +28,18 @@ The `Update-CsTenantMeetingUrl` updates the Skype for Business Online meeting UR For example, suppose an organization sets up an Office 365 domain with the name contoso.onmicrosoft.com. When they do that, meetings will have URLs similar to this: -https://meet.lync.com/onmicrosoft/contoso/user1/45GZFH99 +`https://meet.lync.com/onmicrosoft/contoso/user1/45GZFH99` Now, suppose the organization undergoes some changes and decides to use the "vanity" URL litwareinc.com instead of the onmicrosoft.com URL. The organization modifies their user email addresses to use the litwareinc.com domain. However, meeting URLs will still use the old domain name: -https://meet.lync.com/contoso/user1/45GZFH99 +`https://meet.lync.com/contoso/user1/45GZFH99` To fix this problem, administrators should run the `Update-CsTenantMeetingUrl` cmdlet. That will replace the old meeting URL with a new one that features the vanity URL instead: -https://meet.lync.com/litwareinc.com/user1/37JYLP71 +`https://meet.lync.com/litwareinc.com/user1/37JYLP71` Running the `Update-CsTenantMeetingUrl` cmdlet is the only way to make this change. @@ -146,7 +151,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -161,24 +166,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Update-CsUserData.md b/skype/skype-ps/skype/Update-CsUserData.md index 9cc1a307c2..1002d5a2b2 100644 --- a/skype/skype-ps/skype/Update-CsUserData.md +++ b/skype/skype-ps/skype/Update-CsUserData.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Update-CsUserData @@ -157,7 +162,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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 @@ -237,7 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -261,4 +266,3 @@ The Update-CsUserData cmdlet updates Skype for Business Server 2015 user informa [Import-CsUserData](Import-CsUserData.md) [Sync-CsUserData](Sync-CsUserData.md) - diff --git a/skype/skype-ps/skype/Update-CsUserDatabase.md b/skype/skype-ps/skype/Update-CsUserDatabase.md index 976d53db14..e4b3514b60 100644 --- a/skype/skype-ps/skype/Update-CsUserDatabase.md +++ b/skype/skype-ps/skype/Update-CsUserDatabase.md @@ -1,8 +1,13 @@ --- 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 +ms.author: hirshah +ms.reviewer: --- # Update-CsUserDatabase @@ -21,7 +26,7 @@ Update-CsUserDatabase [[-Fqdn] <Fqdn>] [-Force] [<CommonParameters>] ## DESCRIPTION The Skype for Business Server user database holds detailed information about such things as contacts, groups, and access permissions. -As such, the database is required to periodically synch its contents with the information stored in Active Directory. +As such, the database is required to periodically synchronize its contents with the information stored in Active Directory. More often than not, the automatic synch between the user database and Active Directory will keep the information in the user database up to date. However, it is possible that a problem might occur that prevents this automatic synchronization from taking place. @@ -84,7 +89,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -105,4 +110,3 @@ Instead, the `Update-CsUserDatabase` cmdlet updates instances of the Microsoft.R [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) - diff --git a/skype/skype-ps/skype/skype.md b/skype/skype-ps/skype/skype.md index c5eef7c9be..54e242ca7d 100644 --- a/skype/skype-ps/skype/skype.md +++ b/skype/skype-ps/skype/skype.md @@ -2,9 +2,7 @@ Module Name: SkypeForBusiness Module Guid: 01dfdcd9-c48d-46a9-b09a-587ca5c4829a Help Version: 17.0.15229.2100 -Download Help Link: https://officedocs-cdn.azureedge.net/powershell/skype/ title: skype -Locale: en-US Additional Locale: de-DE,es-ES,fr-FR,it-IT,ja-JP,ko-KR,pt-BR,ru-RU,zh-CN,zh-TW de-DE Version: 17.0.15229.2100 es-ES Version: 17.0.15229.2100 @@ -18,3109 +16,893 @@ zh-CN Version: 17.0.15229.2100 zh-TW Version: 17.0.15229.2100 --- -# Skype for Business PowerShell +# Skype for Business Server PowerShell ## Description -The following cmdlet references are for Skype for Business. - -## Skype for Business Cmdlets -### [New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md) -{{Manually Enter New-CSOnlinePSTNGateway Description Here}} - -### [Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md) -{{Manually Enter Set-CSOnlinePSTNGateway Description Here}} - -### [Get-CSOnlinePSTNGateway](Get-CSOnlinePSTNGateway.md) -{{Manually Enter Get-CSOnlinePSTNGateway Description Here}} - -### [Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md) -{{Manually Enter Remove-CSOnlinePSTNGateway Description Here}} +The following cmdlet references are for Skype for Business Server Management Shell and you can find information about it here: https://learn.microsoft.com/skypeforbusiness/manage/management-shell. +## Skype for Business Server Cmdlets ### [Add-CsSlaDelegates](Add-CsSlaDelegates.md) -{{Manually Enter Add-CsSlaDelegates Description Here}} - ### [Approve-CsDeviceUpdateRule](Approve-CsDeviceUpdateRule.md) -{{Manually Enter Approve-CsDeviceUpdateRule Description Here}} - ### [Backup-CsPool](Backup-CsPool.md) -{{Manually Enter Backup-CsPool Description Here}} - ### [Clear-CsDeviceUpdateFile](Clear-CsDeviceUpdateFile.md) -{{Manually Enter Clear-CsDeviceUpdateFile Description Here}} - ### [Clear-CsDeviceUpdateLog](Clear-CsDeviceUpdateLog.md) -{{Manually Enter Clear-CsDeviceUpdateLog Description Here}} - -### [Clear-CsOnlineTelephoneNumberReservation](Clear-CsOnlineTelephoneNumberReservation.md) -{{Manually Enter Clear-CsOnlineTelephoneNumberReservation Description Here}} - ### [Clear-CsPersistentChatRoom](Clear-CsPersistentChatRoom.md) -{{Manually Enter Clear-CsPersistentChatRoom Description Here}} - -### [Complete-CsCceApplianceRegistration](Complete-CsCceApplianceRegistration.md) -{{Manually Enter Complete-CsCceApplianceRegistration Description Here}} - -### [Complete-CsCceApplianceUnregistration](Complete-CsCceApplianceUnregistration.md) -{{Manually Enter Complete-CsCceApplianceUnregistration Description Here}} - ### [Convert-CsUserData](Convert-CsUserData.md) -{{Manually Enter Convert-CsUserData Description Here}} - -### [ConvertTo-JsonForPSWS](ConvertTo-JsonForPSWS.md) -{{Manually Enter ConvertTo-JsonForPSWS Description Here}} - ### [Copy-CsVoicePolicy](Copy-CsVoicePolicy.md) -{{Manually Enter Copy-CsVoicePolicy Description Here}} - ### [Debug-CsAddressBookReplication](Debug-CsAddressBookReplication.md) -{{Manually Enter Debug-CsAddressBookReplication Description Here}} - ### [Debug-CsDataConference](Debug-CsDataConference.md) -{{Manually Enter Debug-CsDataConference Description Here}} - ### [Debug-CsInterPoolReplication](Debug-CsInterPoolReplication.md) -{{Manually Enter Debug-CsInterPoolReplication Description Here}} - ### [Debug-CsIntraPoolReplication](Debug-CsIntraPoolReplication.md) -{{Manually Enter Debug-CsIntraPoolReplication Description Here}} - ### [Debug-CsLisConfiguration](Debug-CsLisConfiguration.md) -{{Manually Enter Debug-CsLisConfiguration Description Here}} - ### [Debug-CsStorageServiceFailures](Debug-CsStorageServiceFailures.md) -{{Manually Enter Debug-CsStorageServiceFailures Description Here}} - ### [Debug-CsUnifiedContactStore](Debug-CsUnifiedContactStore.md) -{{Manually Enter Debug-CsUnifiedContactStore Description Here}} - ### [Disable-CsAdDomain](Disable-CsAdDomain.md) -{{Manually Enter Disable-CsAdDomain Description Here}} - ### [Disable-CsAdForest](Disable-CsAdForest.md) -{{Manually Enter Disable-CsAdForest Description Here}} - ### [Disable-CsComputer](Disable-CsComputer.md) -{{Manually Enter Disable-CsComputer Description Here}} - ### [Disable-CsHostingProvider](Disable-CsHostingProvider.md) -{{Manually Enter Disable-CsHostingProvider Description Here}} - ### [Disable-CsMeetingRoom](Disable-CsMeetingRoom.md) -{{Manually Enter Disable-CsMeetingRoom Description Here}} - ### [Disable-CsOnlineDialInConferencingUser](Disable-CsOnlineDialInConferencingUser.md) -{{Manually Enter Disable-CsOnlineDialInConferencingUser Description Here}} - ### [Disable-CsPublicProvider](Disable-CsPublicProvider.md) -{{Manually Enter Disable-CsPublicProvider Description Here}} - ### [Disable-CsUser](Disable-CsUser.md) -{{Manually Enter Disable-CsUser Description Here}} - ### [Enable-CsAdDomain](Enable-CsAdDomain.md) -{{Manually Enter Enable-CsAdDomain Description Here}} - ### [Enable-CsAdForest](Enable-CsAdForest.md) -{{Manually Enter Enable-CsAdForest Description Here}} - ### [Enable-CsComputer](Enable-CsComputer.md) -{{Manually Enter Enable-CsComputer Description Here}} - ### [Enable-CsHostingProvider](Enable-CsHostingProvider.md) -{{Manually Enter Enable-CsHostingProvider Description Here}} - ### [Enable-CsMeetingRoom](Enable-CsMeetingRoom.md) -{{Manually Enter Enable-CsMeetingRoom Description Here}} - -### [Enable-CsOnlineDialInConferencingUser](Enable-CsOnlineDialInConferencingUser.md) -{{Manually Enter Enable-CsOnlineDialInConferencingUser Description Here}} - ### [Enable-CsPublicProvider](Enable-CsPublicProvider.md) -{{Manually Enter Enable-CsPublicProvider Description Here}} - ### [Enable-CsReplica](Enable-CsReplica.md) -{{Manually Enter Enable-CsReplica Description Here}} - ### [Enable-CsTopology](Enable-CsTopology.md) -{{Manually Enter Enable-CsTopology Description Here}} - ### [Enable-CsUser](Enable-CsUser.md) -{{Manually Enter Enable-CsUser Description Here}} - ### [Export-CsArchivingData](Export-CsArchivingData.md) -{{Manually Enter Export-CsArchivingData Description Here}} - ### [Export-CsConfiguration](Export-CsConfiguration.md) -{{Manually Enter Export-CsConfiguration Description Here}} - ### [Export-CsLisConfiguration](Export-CsLisConfiguration.md) -{{Manually Enter Export-CsLisConfiguration Description Here}} - ### [Export-CsPersistentChatData](Export-CsPersistentChatData.md) -{{Manually Enter Export-CsPersistentChatData Description Here}} - ### [Export-CsRgsConfiguration](Export-CsRgsConfiguration.md) -{{Manually Enter Export-CsRgsConfiguration Description Here}} - ### [Export-CsUserData](Export-CsUserData.md) -{{Manually Enter Export-CsUserData Description Here}} - -### [Find-CsGroup](Find-CsGroup.md) -{{Manually Enter Find-CsGroup Description Here}} - ### [Get-CsAccessEdgeConfiguration](Get-CsAccessEdgeConfiguration.md) -{{Manually Enter Get-CsAccessEdgeConfiguration Description Here}} - ### [Get-CsAdContact](Get-CsAdContact.md) -{{Manually Enter Get-CsAdContact Description Here}} - +### [Get-CsAdditionalInternalDomain](Get-CsAdditionalInternalDomain.md) ### [Get-CsAdDomain](Get-CsAdDomain.md) -{{Manually Enter Get-CsAdDomain Description Here}} - ### [Get-CsAddressBookConfiguration](Get-CsAddressBookConfiguration.md) -{{Manually Enter Get-CsAddressBookConfiguration Description Here}} - ### [Get-CsAddressBookNormalizationConfiguration](Get-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter Get-CsAddressBookNormalizationConfiguration Description Here}} - ### [Get-CsAddressBookNormalizationRule](Get-CsAddressBookNormalizationRule.md) -{{Manually Enter Get-CsAddressBookNormalizationRule Description Here}} - ### [Get-CsAdForest](Get-CsAdForest.md) -{{Manually Enter Get-CsAdForest Description Here}} - ### [Get-CsAdminRole](Get-CsAdminRole.md) -{{Manually Enter Get-CsAdminRole Description Here}} - ### [Get-CsAdminRoleAssignment](Get-CsAdminRoleAssignment.md) -{{Manually Enter Get-CsAdminRoleAssignment Description Here}} - ### [Get-CsAdPrincipal](Get-CsAdPrincipal.md) -{{Manually Enter Get-CsAdPrincipal Description Here}} - ### [Get-CsAdServerSchema](Get-CsAdServerSchema.md) -{{Manually Enter Get-CsAdServerSchema Description Here}} - ### [Get-CsAdUser](Get-CsAdUser.md) -{{Manually Enter Get-CsAdUser Description Here}} - ### [Get-CsAllowedDomain](Get-CsAllowedDomain.md) -{{Manually Enter Get-CsAllowedDomain Description Here}} - ### [Get-CsAnalogDevice](Get-CsAnalogDevice.md) -{{Manually Enter Get-CsAnalogDevice Description Here}} - ### [Get-CsAnnouncement](Get-CsAnnouncement.md) -{{Manually Enter Get-CsAnnouncement Description Here}} - ### [Get-CsApplicationEndpoint](Get-CsApplicationEndpoint.md) -{{Manually Enter Get-CsApplicationEndpoint Description Here}} - ### [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) -{{Manually Enter Get-CsArchivingConfiguration Description Here}} - ### [Get-CsArchivingPolicy](Get-CsArchivingPolicy.md) -{{Manually Enter Get-CsArchivingPolicy Description Here}} - -### [Get-CsAudioConferencingProvider](Get-CsAudioConferencingProvider.md) -{{Manually Enter Get-CsAudioConferencingProvider Description Here}} - ### [Get-CsAudioTestServiceApplication](Get-CsAudioTestServiceApplication.md) -{{Manually Enter Get-CsAudioTestServiceApplication Description Here}} - +### [Get-CsAuthConfig](Get-CsAuthConfig.md) ### [Get-CsAutodiscoverConfiguration](Get-CsAutodiscoverConfiguration.md) -{{Manually Enter Get-CsAutodiscoverConfiguration Description Here}} - ### [Get-CsAVEdgeConfiguration](Get-CsAVEdgeConfiguration.md) -{{Manually Enter Get-CsAVEdgeConfiguration Description Here}} - ### [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) -{{Manually Enter Get-CsBackupServiceConfiguration Description Here}} - ### [Get-CsBackupServiceStatus](Get-CsBackupServiceStatus.md) -{{Manually Enter Get-CsBackupServiceStatus Description Here}} - ### [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter Get-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [Get-CsBlockedDomain](Get-CsBlockedDomain.md) -{{Manually Enter Get-CsBlockedDomain Description Here}} - -### [Get-CsBroadcastMeetingConfiguration](Get-CsBroadcastMeetingConfiguration.md) -{{Manually Enter Get-CsBroadcastMeetingConfiguration Description Here}} - -### [Get-CsBroadcastMeetingPolicy](Get-CsBroadcastMeetingPolicy.md) -{{Manually Enter Get-CsBroadcastMeetingPolicy Description Here}} - ### [Get-CsBusyOptions](Get-CsBusyOptions.md) -{{Manually Enter Get-CsBusyOptions Description Here}} - -### [Get-CsCallerIdPolicy](Get-CsCallerIdPolicy.md) -{{Manually Enter Get-CsCallerIdPolicy Description Here}} - -### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) -{{Manually Enter Get-CsCallingLineIdentity Description Here}} - ### [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) -{{Manually Enter Get-CsCallParkOrbit Description Here}} - ### [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) -{{Manually Enter Get-CsCallViaWorkPolicy Description Here}} - ### [Get-CsCdrConfiguration](Get-CsCdrConfiguration.md) -{{Manually Enter Get-CsCdrConfiguration Description Here}} - ### [Get-CsCertificate](Get-CsCertificate.md) -{{Manually Enter Get-CsCertificate Description Here}} - ### [Get-CsClientAccessLicense](Get-CsClientAccessLicense.md) -{{Manually Enter Get-CsClientAccessLicense Description Here}} - ### [Get-CsClientCertificate](Get-CsClientCertificate.md) -{{Manually Enter Get-CsClientCertificate Description Here}} - ### [Get-CsClientPinInfo](Get-CsClientPinInfo.md) -{{Manually Enter Get-CsClientPinInfo Description Here}} - ### [Get-CsClientPolicy](Get-CsClientPolicy.md) -{{Manually Enter Get-CsClientPolicy Description Here}} - ### [Get-CsClientVersionConfiguration](Get-CsClientVersionConfiguration.md) -{{Manually Enter Get-CsClientVersionConfiguration Description Here}} - ### [Get-CsClientVersionPolicy](Get-CsClientVersionPolicy.md) -{{Manually Enter Get-CsClientVersionPolicy Description Here}} - ### [Get-CsClientVersionPolicyRule](Get-CsClientVersionPolicyRule.md) -{{Manually Enter Get-CsClientVersionPolicyRule Description Here}} - -### [Get-CsCloudMeetingPolicy](Get-CsCloudMeetingPolicy.md) -{{Manually Enter Get-CsCloudMeetingPolicy Description Here}} - +### [Get-CsCloudCallDataConnector](Get-CsCloudCallDataConnector.md) +### [Get-CsCloudCallDataConnectorConfiguration](Get-CsCloudCallDataConnectorConfiguration.md) ### [Get-CsClsAgentStatus](Get-CsClsAgentStatus.md) -{{Manually Enter Get-CsClsAgentStatus Description Here}} - ### [Get-CsClsConfiguration](Get-CsClsConfiguration.md) -{{Manually Enter Get-CsClsConfiguration Description Here}} - ### [Get-CsClsRegion](Get-CsClsRegion.md) -{{Manually Enter Get-CsClsRegion Description Here}} - ### [Get-CsClsScenario](Get-CsClsScenario.md) -{{Manually Enter Get-CsClsScenario Description Here}} - ### [Get-CsClsSearchTerm](Get-CsClsSearchTerm.md) -{{Manually Enter Get-CsClsSearchTerm Description Here}} - ### [Get-CsClsSecurityGroup](Get-CsClsSecurityGroup.md) -{{Manually Enter Get-CsClsSecurityGroup Description Here}} - ### [Get-CsCommonAreaPhone](Get-CsCommonAreaPhone.md) -{{Manually Enter Get-CsCommonAreaPhone Description Here}} - ### [Get-CsComputer](Get-CsComputer.md) -{{Manually Enter Get-CsComputer Description Here}} - ### [Get-CsConferenceDirectory](Get-CsConferenceDirectory.md) -{{Manually Enter Get-CsConferenceDirectory Description Here}} - ### [Get-CsConferenceDisclaimer](Get-CsConferenceDisclaimer.md) -{{Manually Enter Get-CsConferenceDisclaimer Description Here}} - ### [Get-CsConferencingConfiguration](Get-CsConferencingConfiguration.md) -{{Manually Enter Get-CsConferencingConfiguration Description Here}} - ### [Get-CsConferencingPolicy](Get-CsConferencingPolicy.md) -{{Manually Enter Get-CsConferencingPolicy Description Here}} - ### [Get-CsConfigurationStoreLocation](Get-CsConfigurationStoreLocation.md) -{{Manually Enter Get-CsConfigurationStoreLocation Description Here}} - ### [Get-CsConversationHistoryConfiguration](Get-CsConversationHistoryConfiguration.md) -{{Manually Enter Get-CsConversationHistoryConfiguration Description Here}} - ### [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) -{{Manually Enter Get-CsCpsConfiguration Description Here}} - ### [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) -{{Manually Enter Get-CsDatabaseMirrorState Description Here}} - ### [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) -{{Manually Enter Get-CsDeviceUpdateConfiguration Description Here}} - ### [Get-CsDeviceUpdateRule](Get-CsDeviceUpdateRule.md) -{{Manually Enter Get-CsDeviceUpdateRule Description Here}} - ### [Get-CsDiagnosticConfiguration](Get-CsDiagnosticConfiguration.md) -{{Manually Enter Get-CsDiagnosticConfiguration Description Here}} - ### [Get-CsDiagnosticHeaderConfiguration](Get-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter Get-CsDiagnosticHeaderConfiguration Description Here}} - ### [Get-CsDialInConferencingAccessNumber](Get-CsDialInConferencingAccessNumber.md) -{{Manually Enter Get-CsDialInConferencingAccessNumber Description Here}} - ### [Get-CsDialInConferencingConfiguration](Get-CsDialInConferencingConfiguration.md) -{{Manually Enter Get-CsDialInConferencingConfiguration Description Here}} - ### [Get-CsDialInConferencingDtmfConfiguration](Get-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter Get-CsDialInConferencingDtmfConfiguration Description Here}} - ### [Get-CsDialInConferencingLanguageList](Get-CsDialInConferencingLanguageList.md) -{{Manually Enter Get-CsDialInConferencingLanguageList Description Here}} - ### [Get-CsDialPlan](Get-CsDialPlan.md) -{{Manually Enter Get-CsDialPlan Description Here}} - ### [Get-CsEffectivePolicy](Get-CsEffectivePolicy.md) -{{Manually Enter Get-CsEffectivePolicy Description Here}} - -### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) -{{Manually Enter Get-CsEffectiveTenantDialPlan Description Here}} - ### [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Get-CsEnhancedEmergencyServiceDisclaimer Description Here}} - ### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) -{{Manually Enter Get-CsExternalAccessPolicy Description Here}} - -### [Get-CsExternalUserCommunicationPolicy](Get-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Get-CsExternalUserCommunicationPolicy Description Here}} - ### [Get-CsExUmContact](Get-CsExUmContact.md) -{{Manually Enter Get-CsExUmContact Description Here}} - ### [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) -{{Manually Enter Get-CsFileTransferFilterConfiguration Description Here}} - ### [Get-CsFIPSConfiguration](Get-CsFIPSConfiguration.md) -{{Manually Enter Get-CsFIPSConfiguration Description Here}} - -### [Get-CsGraphPolicy](Get-CsGraphPolicy.md) -{{Manually Enter Get-CsGraphPolicy Description Here}} - ### [Get-CsGroupPickupUserOrbit](Get-CsGroupPickupUserOrbit.md) -{{Manually Enter Get-CsGroupPickupUserOrbit Description Here}} - ### [Get-CsHealthMonitoringConfiguration](Get-CsHealthMonitoringConfiguration.md) -{{Manually Enter Get-CsHealthMonitoringConfiguration Description Here}} - ### [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) -{{Manually Enter Get-CsHostedVoicemailPolicy Description Here}} - ### [Get-CsHostingProvider](Get-CsHostingProvider.md) -{{Manually Enter Get-CsHostingProvider Description Here}} - -### [Get-CsHuntGroup](Get-CsHuntGroup.md) -{{Manually Enter Get-CsHuntGroup Description Here}} - -### [Get-CsHuntGroupTenantInformation](Get-CsHuntGroupTenantInformation.md) -{{Manually Enter Get-CsHuntGroupTenantInformation Description Here}} - -### [Get-CsHybridMediationServer](Get-CsHybridMediationServer.md) -{{Manually Enter Get-CsHybridMediationServer Description Here}} - -### [Get-CsHybridPSTNAppliance](Get-CsHybridPSTNAppliance.md) -{{Manually Enter Get-CsHybridPSTNAppliance Description Here}} - -### [Get-CsHybridPSTNSite](Get-CsHybridPSTNSite.md) -{{Manually Enter Get-CsHybridPSTNSite Description Here}} - +### [Get-CsHybridApplicationEndpoint](Get-CsHybridApplicationEndpoint.md) ### [Get-CsImConfiguration](Get-CsImConfiguration.md) -{{Manually Enter Get-CsImConfiguration Description Here}} - ### [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) -{{Manually Enter Get-CsImFilterConfiguration Description Here}} - ### [Get-CsImTranslationConfiguration](Get-CsImTranslationConfiguration.md) -{{Manually Enter Get-CsImTranslationConfiguration Description Here}} - ### [Get-CsIPPhonePolicy](Get-CsIPPhonePolicy.md) -{{Manually Enter Get-CsIPPhonePolicy Description Here}} - ### [Get-CsKerberosAccountAssignment](Get-CsKerberosAccountAssignment.md) -{{Manually Enter Get-CsKerberosAccountAssignment Description Here}} - ### [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) -{{Manually Enter Get-CsLisCivicAddress Description Here}} - ### [Get-CsLisLocation](Get-CsLisLocation.md) -{{Manually Enter Get-CsLisLocation Description Here}} - ### [Get-CsLisPort](Get-CsLisPort.md) -{{Manually Enter Get-CsLisPort Description Here}} - ### [Get-CsLisServiceProvider](Get-CsLisServiceProvider.md) -{{Manually Enter Get-CsLisServiceProvider Description Here}} - ### [Get-CsLisSubnet](Get-CsLisSubnet.md) -{{Manually Enter Get-CsLisSubnet Description Here}} - ### [Get-CsLisSwitch](Get-CsLisSwitch.md) -{{Manually Enter Get-CsLisSwitch Description Here}} - ### [Get-CsLisWirelessAccessPoint](Get-CsLisWirelessAccessPoint.md) -{{Manually Enter Get-CsLisWirelessAccessPoint Description Here}} - ### [Get-CsLocationPolicy](Get-CsLocationPolicy.md) -{{Manually Enter Get-CsLocationPolicy Description Here}} - ### [Get-CsManagementConnection](Get-CsManagementConnection.md) -{{Manually Enter Get-CsManagementConnection Description Here}} - ### [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) -{{Manually Enter Get-CsManagementStoreReplicationStatus Description Here}} - ### [Get-CsMcxConfiguration](Get-CsMcxConfiguration.md) -{{Manually Enter Get-CsMcxConfiguration Description Here}} - ### [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) -{{Manually Enter Get-CsMediaConfiguration Description Here}} - ### [Get-CsMeetingConfiguration](Get-CsMeetingConfiguration.md) -{{Manually Enter Get-CsMeetingConfiguration Description Here}} - -### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) -{{Manually Enter Get-CsMeetingMigrationStatus Description Here}} - ### [Get-CsMeetingRoom](Get-CsMeetingRoom.md) -{{Manually Enter Get-CsMeetingRoom Description Here}} - ### [Get-CsMobilityPolicy](Get-CsMobilityPolicy.md) -{{Manually Enter Get-CsMobilityPolicy Description Here}} - ### [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter Get-CsNetworkBandwidthPolicyProfile Description Here}} - ### [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) -{{Manually Enter Get-CsNetworkConfiguration Description Here}} - ### [Get-CsNetworkInterface](Get-CsNetworkInterface.md) -{{Manually Enter Get-CsNetworkInterface Description Here}} - ### [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) -{{Manually Enter Get-CsNetworkInterRegionRoute Description Here}} - ### [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) -{{Manually Enter Get-CsNetworkInterSitePolicy Description Here}} - ### [Get-CsNetworkRegion](Get-CsNetworkRegion.md) -{{Manually Enter Get-CsNetworkRegion Description Here}} - ### [Get-CsNetworkRegionLink](Get-CsNetworkRegionLink.md) -{{Manually Enter Get-CsNetworkRegionLink Description Here}} - ### [Get-CsNetworkSite](Get-CsNetworkSite.md) -{{Manually Enter Get-CsNetworkSite Description Here}} - ### [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) -{{Manually Enter Get-CsNetworkSubnet Description Here}} - ### [Get-CsOAuthConfiguration](Get-CsOAuthConfiguration.md) -{{Manually Enter Get-CsOAuthConfiguration Description Here}} - ### [Get-CsOAuthServer](Get-CsOAuthServer.md) -{{Manually Enter Get-CsOAuthServer Description Here}} - -### [Get-CsOnlineApplicationEndpoint](Get-CsOnlineApplicationEndpoint.md) -{{Manually Enter Get-CsOnlineApplicationEndpoint Description Here}} - ### [Get-CsOnlineDialInConferencingBridge](Get-CsOnlineDialInConferencingBridge.md) -{{Manually Enter Get-CsOnlineDialInConferencingBridge Description Here}} - ### [Get-CsOnlineDialInConferencingLanguagesSupported](Get-CsOnlineDialInConferencingLanguagesSupported.md) -{{Manually Enter Get-CsOnlineDialInConferencingLanguagesSupported Description Here}} - -### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) -{{Manually Enter Get-CsOnlineDialinConferencingPolicy Description Here}} - -### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Get-CsOnlineDialInConferencingServiceNumber Description Here}} - -### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) -{{Manually Enter Get-CsOnlineDialinConferencingTenantConfiguration Description Here}} - -### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) -{{Manually Enter Get-CsOnlineDialInConferencingTenantSettings Description Here}} - -### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) -{{Manually Enter Get-CsOnlineDialInConferencingUser Description Here}} - ### [Get-CsOnlineDialInConferencingUserInfo](Get-CsOnlineDialInConferencingUserInfo.md) -{{Manually Enter Get-CsOnlineDialInConferencingUserInfo Description Here}} - ### [Get-CsOnlineDialInConferencingUserState](Get-CsOnlineDialInConferencingUserState.md) -{{Manually Enter Get-CsOnlineDialInConferencingUserState Description Here}} - -### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) -{{Manually Enter Get-CsOnlineDialOutPolicy Description Here}} - -### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) -{{Manually Enter Get-CsOnlineDirectoryTenant Description Here}} - -### [Get-CsOnlineDirectoryTenantNumberCities](Get-CsOnlineDirectoryTenantNumberCities.md) -{{Manually Enter Get-CsOnlineDirectoryTenantNumberCities Description Here}} - -### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Get-CsOnlineEnhancedEmergencyServiceDisclaimer Description Here}} - -### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) -{{Manually Enter Get-CsOnlineLisCivicAddress Description Here}} - -### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) -{{Manually Enter Get-CsOnlineLisLocation Description Here}} - ### [Get-CsOnlineNumberPortInOrder](Get-CsOnlineNumberPortInOrder.md) -{{Manually Enter Get-CsOnlineNumberPortInOrder Description Here}} - ### [Get-CsOnlineNumberPortOutOrderPin](Get-CsOnlineNumberPortOutOrderPin.md) -{{Manually Enter Get-CsOnlineNumberPortOutOrderPin Description Here}} - -### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) -{{Manually Enter Get-CsOnlineTelephoneNumber Description Here}} - -### [Get-CsOnlineTelephoneNumberAvailableCount](Get-CsOnlineTelephoneNumberAvailableCount.md) -{{Manually Enter Get-CsOnlineTelephoneNumberAvailableCount Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryAreas](Get-CsOnlineTelephoneNumberInventoryAreas.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryAreas Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryCities](Get-CsOnlineTelephoneNumberInventoryCities.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryCities Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryCountries](Get-CsOnlineTelephoneNumberInventoryCountries.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryCountries Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryRegions](Get-CsOnlineTelephoneNumberInventoryRegions.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryRegions Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryTypes](Get-CsOnlineTelephoneNumberInventoryTypes.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryTypes Description Here}} - -### [Get-CsOnlineTelephoneNumberReservationsInformation](Get-CsOnlineTelephoneNumberReservationsInformation.md) -{{Manually Enter Get-CsOnlineTelephoneNumberReservationsInformation Description Here}} - -### [Get-CsOnlineUser](Get-CsOnlineUser.md) -{{Manually Enter Get-CsOnlineUser Description Here}} - -### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) -{{Manually Enter Get-CsOnlineVoicemailPolicy Description Here}} - -### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) -{{Manually Enter Get-CsOnlineVoiceUser Description Here}} - -### [Get-CsOrganizationalAutoAttendant](Get-CsOrganizationalAutoAttendant.md) -{{Manually Enter Get-CsOrganizationalAutoAttendant Description Here}} - -### [Get-CsOrganizationalAutoAttendantStatus](Get-CsOrganizationalAutoAttendantStatus.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantStatus Description Here}} - -### [Get-CsOrganizationalAutoAttendantSupportedLanguage](Get-CsOrganizationalAutoAttendantSupportedLanguage.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantSupportedLanguage Description Here}} - -### [Get-CsOrganizationalAutoAttendantSupportedTimeZone](Get-CsOrganizationalAutoAttendantSupportedTimeZone.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantSupportedTimeZone Description Here}} - -### [Get-CsOrganizationalAutoAttendantTenantInformation](Get-CsOrganizationalAutoAttendantTenantInformation.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantTenantInformation Description Here}} - ### [Get-CsOutboundCallingNumberTranslationRule](Get-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter Get-CsOutboundCallingNumberTranslationRule Description Here}} - ### [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) -{{Manually Enter Get-CsOutboundTranslationRule Description Here}} - ### [Get-CsPartnerApplication](Get-CsPartnerApplication.md) -{{Manually Enter Get-CsPartnerApplication Description Here}} - ### [Get-CsPersistentChatAddin](Get-CsPersistentChatAddin.md) -{{Manually Enter Get-CsPersistentChatAddin Description Here}} - ### [Get-CsPersistentChatCategory](Get-CsPersistentChatCategory.md) -{{Manually Enter Get-CsPersistentChatCategory Description Here}} - ### [Get-CsPersistentChatComplianceConfiguration](Get-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter Get-CsPersistentChatComplianceConfiguration Description Here}} - ### [Get-CsPersistentChatConfiguration](Get-CsPersistentChatConfiguration.md) -{{Manually Enter Get-CsPersistentChatConfiguration Description Here}} - ### [Get-CsPersistentChatEligiblePrincipal](Get-CsPersistentChatEligiblePrincipal.md) -{{Manually Enter Get-CsPersistentChatEligiblePrincipal Description Here}} - ### [Get-CsPersistentChatEndpoint](Get-CsPersistentChatEndpoint.md) -{{Manually Enter Get-CsPersistentChatEndpoint Description Here}} - ### [Get-CsPersistentChatPolicy](Get-CsPersistentChatPolicy.md) -{{Manually Enter Get-CsPersistentChatPolicy Description Here}} - ### [Get-CsPersistentChatRoom](Get-CsPersistentChatRoom.md) -{{Manually Enter Get-CsPersistentChatRoom Description Here}} - ### [Get-CsPersistentChatState](Get-CsPersistentChatState.md) -{{Manually Enter Get-CsPersistentChatState Description Here}} - ### [Get-CsPinPolicy](Get-CsPinPolicy.md) -{{Manually Enter Get-CsPinPolicy Description Here}} - +### [Get-CsPlatformServiceSettings](Get-CsPlatformServiceSettings.md) ### [Get-CsPool](Get-CsPool.md) -{{Manually Enter Get-CsPool Description Here}} - ### [Get-CsPoolBackupRelationship](Get-CsPoolBackupRelationship.md) -{{Manually Enter Get-CsPoolBackupRelationship Description Here}} - ### [Get-CsPoolFabricState](Get-CsPoolFabricState.md) -{{Manually Enter Get-CsPoolFabricState Description Here}} - ### [Get-CsPoolUpgradeReadinessState](Get-CsPoolUpgradeReadinessState.md) -{{Manually Enter Get-CsPoolUpgradeReadinessState Description Here}} - ### [Get-CsPresenceManagementState](Get-CsPresenceManagementState.md) -{{Manually Enter Get-CsPresenceManagementState Description Here}} - ### [Get-CsPresencePolicy](Get-CsPresencePolicy.md) -{{Manually Enter Get-CsPresencePolicy Description Here}} - ### [Get-CsPresenceProvider](Get-CsPresenceProvider.md) -{{Manually Enter Get-CsPresenceProvider Description Here}} - ### [Get-CsPrivacyConfiguration](Get-CsPrivacyConfiguration.md) -{{Manually Enter Get-CsPrivacyConfiguration Description Here}} - ### [Get-CsProxyConfiguration](Get-CsProxyConfiguration.md) -{{Manually Enter Get-CsProxyConfiguration Description Here}} - ### [Get-CsPstnUsage](Get-CsPstnUsage.md) -{{Manually Enter Get-CsPstnUsage Description Here}} - ### [Get-CsPublicProvider](Get-CsPublicProvider.md) -{{Manually Enter Get-CsPublicProvider Description Here}} - ### [Get-CsPushNotificationConfiguration](Get-CsPushNotificationConfiguration.md) -{{Manually Enter Get-CsPushNotificationConfiguration Description Here}} - ### [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) -{{Manually Enter Get-CsQoEConfiguration Description Here}} - ### [Get-CsRegistrarConfiguration](Get-CsRegistrarConfiguration.md) -{{Manually Enter Get-CsRegistrarConfiguration Description Here}} - ### [Get-CsReportingConfiguration](Get-CsReportingConfiguration.md) -{{Manually Enter Get-CsReportingConfiguration Description Here}} - ### [Get-CsRgsAgentGroup](Get-CsRgsAgentGroup.md) -{{Manually Enter Get-CsRgsAgentGroup Description Here}} - ### [Get-CsRgsConfiguration](Get-CsRgsConfiguration.md) -{{Manually Enter Get-CsRgsConfiguration Description Here}} - ### [Get-CsRgsHolidaySet](Get-CsRgsHolidaySet.md) -{{Manually Enter Get-CsRgsHolidaySet Description Here}} - ### [Get-CsRgsHoursOfBusiness](Get-CsRgsHoursOfBusiness.md) -{{Manually Enter Get-CsRgsHoursOfBusiness Description Here}} - ### [Get-CsRgsQueue](Get-CsRgsQueue.md) -{{Manually Enter Get-CsRgsQueue Description Here}} - ### [Get-CsRgsWorkflow](Get-CsRgsWorkflow.md) -{{Manually Enter Get-CsRgsWorkflow Description Here}} - ### [Get-CsRoutingConfiguration](Get-CsRoutingConfiguration.md) -{{Manually Enter Get-CsRoutingConfiguration Description Here}} - ### [Get-CsServerApplication](Get-CsServerApplication.md) -{{Manually Enter Get-CsServerApplication Description Here}} - ### [Get-CsServerPatchVersion](Get-CsServerPatchVersion.md) -{{Manually Enter Get-CsServerPatchVersion Description Here}} - ### [Get-CsServerVersion](Get-CsServerVersion.md) -{{Manually Enter Get-CsServerVersion Description Here}} - ### [Get-CsService](Get-CsService.md) -{{Manually Enter Get-CsService Description Here}} - ### [Get-CsSimpleUrlConfiguration](Get-CsSimpleUrlConfiguration.md) -{{Manually Enter Get-CsSimpleUrlConfiguration Description Here}} - ### [Get-CsSipDomain](Get-CsSipDomain.md) -{{Manually Enter Get-CsSipDomain Description Here}} - ### [Get-CsSipResponseCodeTranslationRule](Get-CsSipResponseCodeTranslationRule.md) -{{Manually Enter Get-CsSipResponseCodeTranslationRule Description Here}} - ### [Get-CsSite](Get-CsSite.md) -{{Manually Enter Get-CsSite Description Here}} - ### [Get-CsSlaConfiguration](Get-CsSlaConfiguration.md) -{{Manually Enter Get-CsSlaConfiguration Description Here}} - ### [Get-CsStaticRoutingConfiguration](Get-CsStaticRoutingConfiguration.md) -{{Manually Enter Get-CsStaticRoutingConfiguration Description Here}} - ### [Get-CsStorageServiceConfiguration](Get-CsStorageServiceConfiguration.md) -{{Manually Enter Get-CsStorageServiceConfiguration Description Here}} - -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) -{{Manually Enter Get-CsTeamsMeetingPolicy Description Here}} - +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) ### [Get-CsTelemetryConfiguration](Get-CsTelemetryConfiguration.md) -{{Manually Enter Get-CsTelemetryConfiguration Description Here}} - -### [Get-CsTenant](Get-CsTenant.md) -{{Manually Enter Get-CsTenant Description Here}} - -### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) -{{Manually Enter Get-CsTenantDialPlan Description Here}} - -### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) -{{Manually Enter Get-CsTenantFederationConfiguration Description Here}} - ### [Get-CsTenantHybridConfiguration](Get-CsTenantHybridConfiguration.md) -{{Manually Enter Get-CsTenantHybridConfiguration Description Here}} - -### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) -{{Manually Enter Get-CsTenantLicensingConfiguration Description Here}} - -### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) -{{Manually Enter Get-CsTenantMigrationConfiguration Description Here}} - -### [Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) -{{Manually Enter Get-CsTenantPublicProvider Description Here}} - -### [Get-CsTenantUpdateTimeWindow](Get-CsTenantUpdateTimeWindow.md) -{{Manually Enter Get-CsTenantUpdateTimeWindow Description Here}} - ### [Get-CsTestDevice](Get-CsTestDevice.md) -{{Manually Enter Get-CsTestDevice Description Here}} - ### [Get-CsTestUserCredential](Get-CsTestUserCredential.md) -{{Manually Enter Get-CsTestUserCredential Description Here}} - ### [Get-CsThirdPartyVideoSystem](Get-CsThirdPartyVideoSystem.md) -{{Manually Enter Get-CsThirdPartyVideoSystem Description Here}} - ### [Get-CsThirdPartyVideoSystemPolicy](Get-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Get-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Get-CsTopology](Get-CsTopology.md) -{{Manually Enter Get-CsTopology Description Here}} - ### [Get-CsTrunk](Get-CsTrunk.md) -{{Manually Enter Get-CsTrunk Description Here}} - ### [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) -{{Manually Enter Get-CsTrunkConfiguration Description Here}} - ### [Get-CsTrustedApplication](Get-CsTrustedApplication.md) -{{Manually Enter Get-CsTrustedApplication Description Here}} - ### [Get-CsTrustedApplicationComputer](Get-CsTrustedApplicationComputer.md) -{{Manually Enter Get-CsTrustedApplicationComputer Description Here}} - ### [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) -{{Manually Enter Get-CsTrustedApplicationEndpoint Description Here}} - ### [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) -{{Manually Enter Get-CsTrustedApplicationPool Description Here}} - ### [Get-CsUCPhoneConfiguration](Get-CsUCPhoneConfiguration.md) -{{Manually Enter Get-CsUCPhoneConfiguration Description Here}} - ### [Get-CsUICulture](Get-CsUICulture.md) -{{Manually Enter Get-CsUICulture Description Here}} - ### [Get-CsUnassignedNumber](Get-CsUnassignedNumber.md) -{{Manually Enter Get-CsUnassignedNumber Description Here}} - +### [Get-CsUpgradeDomainInfo](Get-CsUpgradeDomainInfo.md) ### [Get-CsUser](Get-CsUser.md) -{{Manually Enter Get-CsUser Description Here}} - ### [Get-CsUserAcp](Get-CsUserAcp.md) -{{Manually Enter Get-CsUserAcp Description Here}} - +### [Get-CsUserCallForwardingSettings](Get-CsUserCallForwardingSettings.md) ### [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) -{{Manually Enter Get-CsUserDatabaseState Description Here}} - -### [Get-CsUserLocationStatus](Get-CsUserLocationStatus.md) -{{Manually Enter Get-CsUserLocationStatus Description Here}} - +### [Get-CsUserDelegates](Get-CsUserDelegates.md) ### [Get-CsUserPoolInfo](Get-CsUserPoolInfo.md) -{{Manually Enter Get-CsUserPoolInfo Description Here}} - -### [Get-CsUserPstnSettings](Get-CsUserPstnSettings.md) -{{Manually Enter Get-CsUserPstnSettings Description Here}} - ### [Get-CsUserReplicatorConfiguration](Get-CsUserReplicatorConfiguration.md) -{{Manually Enter Get-CsUserReplicatorConfiguration Description Here}} - ### [Get-CsUserServicesConfiguration](Get-CsUserServicesConfiguration.md) -{{Manually Enter Get-CsUserServicesConfiguration Description Here}} - ### [Get-CsUserServicesPolicy](Get-CsUserServicesPolicy.md) -{{Manually Enter Get-CsUserServicesPolicy Description Here}} - -### [Get-CsUserSession](Get-CsUserSession.md) -{{Manually Enter Get-CsUserSession Description Here}} - +### [Get-CsUserSettingsPageConfiguration](Get-CsUserSettingsPageConfiguration.md) +### [Get-CsUserTeamMembers](Get-CsUserTeamMembers.md) ### [Get-CsVideoInteropServerConfiguration](Get-CsVideoInteropServerConfiguration.md) -{{Manually Enter Get-CsVideoInteropServerConfiguration Description Here}} - ### [Get-CsVideoInteropServerSyntheticTransactionConfiguration](Get-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter Get-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [Get-CsVideoTrunk](Get-CsVideoTrunk.md) -{{Manually Enter Get-CsVideoTrunk Description Here}} - ### [Get-CsVideoTrunkConfiguration](Get-CsVideoTrunkConfiguration.md) -{{Manually Enter Get-CsVideoTrunkConfiguration Description Here}} - ### [Get-CsVoiceConfiguration](Get-CsVoiceConfiguration.md) -{{Manually Enter Get-CsVoiceConfiguration Description Here}} - ### [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) -{{Manually Enter Get-CsVoicemailReroutingConfiguration Description Here}} - ### [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) -{{Manually Enter Get-CsVoiceNormalizationRule Description Here}} - ### [Get-CsVoicePolicy](Get-CsVoicePolicy.md) -{{Manually Enter Get-CsVoicePolicy Description Here}} - ### [Get-CsVoiceRoute](Get-CsVoiceRoute.md) -{{Manually Enter Get-CsVoiceRoute Description Here}} - ### [Get-CsVoiceRoutingPolicy](Get-CsVoiceRoutingPolicy.md) -{{Manually Enter Get-CsVoiceRoutingPolicy Description Here}} - ### [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) -{{Manually Enter Get-CsVoiceTestConfiguration Description Here}} - ### [Get-CsWatcherNodeConfiguration](Get-CsWatcherNodeConfiguration.md) -{{Manually Enter Get-CsWatcherNodeConfiguration Description Here}} - ### [Get-CsWebServiceConfiguration](Get-CsWebServiceConfiguration.md) -{{Manually Enter Get-CsWebServiceConfiguration Description Here}} - ### [Get-CsWindowsService](Get-CsWindowsService.md) -{{Manually Enter Get-CsWindowsService Description Here}} - ### [Get-CsXmppAllowedPartner](Get-CsXmppAllowedPartner.md) -{{Manually Enter Get-CsXmppAllowedPartner Description Here}} - ### [Get-CsXmppGatewayConfiguration](Get-CsXmppGatewayConfiguration.md) -{{Manually Enter Get-CsXmppGatewayConfiguration Description Here}} - ### [Grant-CsArchivingPolicy](Grant-CsArchivingPolicy.md) -{{Manually Enter Grant-CsArchivingPolicy Description Here}} - -### [Grant-CsBroadcastMeetingPolicy](Grant-CsBroadcastMeetingPolicy.md) -{{Manually Enter Grant-CsBroadcastMeetingPolicy Description Here}} - -### [Grant-CsCallerIdPolicy](Grant-CsCallerIdPolicy.md) -{{Manually Enter Grant-CsCallerIdPolicy Description Here}} - -### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) -{{Manually Enter Grant-CsCallingLineIdentity Description Here}} - ### [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) -{{Manually Enter Grant-CsCallViaWorkPolicy Description Here}} - ### [Grant-CsClientPolicy](Grant-CsClientPolicy.md) -{{Manually Enter Grant-CsClientPolicy Description Here}} - ### [Grant-CsClientVersionPolicy](Grant-CsClientVersionPolicy.md) -{{Manually Enter Grant-CsClientVersionPolicy Description Here}} - -### [Grant-CsCloudMeetingPolicy](Grant-CsCloudMeetingPolicy.md) -{{Manually Enter Grant-CsCloudMeetingPolicy Description Here}} - ### [Grant-CsConferencingPolicy](Grant-CsConferencingPolicy.md) -{{Manually Enter Grant-CsConferencingPolicy Description Here}} - -### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) -{{Manually Enter Grant-CsDialoutPolicy Description Here}} - ### [Grant-CsDialPlan](Grant-CsDialPlan.md) -{{Manually Enter Grant-CsDialPlan Description Here}} - ### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) -{{Manually Enter Grant-CsExternalAccessPolicy Description Here}} - -### [Grant-CsExternalUserCommunicationPolicy](Grant-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Grant-CsExternalUserCommunicationPolicy Description Here}} - -### [Grant-CsGraphPolicy](Grant-CsGraphPolicy.md) -{{Manually Enter Grant-CsGraphPolicy Description Here}} - ### [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) -{{Manually Enter Grant-CsHostedVoicemailPolicy Description Here}} - ### [Grant-CsIPPhonePolicy](Grant-CsIPPhonePolicy.md) -{{Manually Enter Grant-CsIPPhonePolicy Description Here}} - ### [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) -{{Manually Enter Grant-CsLocationPolicy Description Here}} - ### [Grant-CsMobilityPolicy](Grant-CsMobilityPolicy.md) -{{Manually Enter Grant-CsMobilityPolicy Description Here}} - -### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) -{{Manually Enter Grant-CsOnlineVoicemailPolicy Description Here}} - ### [Grant-CsOUPermission](Grant-CsOUPermission.md) -{{Manually Enter Grant-CsOUPermission Description Here}} - ### [Grant-CsPersistentChatPolicy](Grant-CsPersistentChatPolicy.md) -{{Manually Enter Grant-CsPersistentChatPolicy Description Here}} - ### [Grant-CsPinPolicy](Grant-CsPinPolicy.md) -{{Manually Enter Grant-CsPinPolicy Description Here}} - ### [Grant-CsPresencePolicy](Grant-CsPresencePolicy.md) -{{Manually Enter Grant-CsPresencePolicy Description Here}} - ### [Grant-CsSetupPermission](Grant-CsSetupPermission.md) -{{Manually Enter Grant-CsSetupPermission Description Here}} - -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) -{{Manually Enter Grant-CsTeamsMeetingPolicy Description Here}} - -### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) -{{Manually Enter Grant-CsTenantDialPlan Description Here}} - +### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) ### [Grant-CsThirdPartyVideoSystemPolicy](Grant-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Grant-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Grant-CsUserServicesPolicy](Grant-CsUserServicesPolicy.md) -{{Manually Enter Grant-CsUserServicesPolicy Description Here}} - ### [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) -{{Manually Enter Grant-CsVoicePolicy Description Here}} - ### [Grant-CsVoiceRoutingPolicy](Grant-CsVoiceRoutingPolicy.md) -{{Manually Enter Grant-CsVoiceRoutingPolicy Description Here}} - ### [Import-CSAnnouncementFile](Import-CSAnnouncementFile.md) -{{Manually Enter Import-CSAnnouncementFile Description Here}} - ### [Import-CsCertificate](Import-CsCertificate.md) -{{Manually Enter Import-CsCertificate Description Here}} - ### [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) -{{Manually Enter Import-CsCompanyPhoneNormalizationRules Description Here}} - ### [Import-CsConfiguration](Import-CsConfiguration.md) -{{Manually Enter Import-CsConfiguration Description Here}} - ### [Import-CsDeviceUpdate](Import-CsDeviceUpdate.md) -{{Manually Enter Import-CsDeviceUpdate Description Here}} - ### [Import-CsLegacyConferenceDirectory](Import-CsLegacyConferenceDirectory.md) -{{Manually Enter Import-CsLegacyConferenceDirectory Description Here}} - ### [Import-CsLegacyConfiguration](Import-CsLegacyConfiguration.md) -{{Manually Enter Import-CsLegacyConfiguration Description Here}} - ### [Import-CsLisConfiguration](Import-CsLisConfiguration.md) -{{Manually Enter Import-CsLisConfiguration Description Here}} - ### [Import-CsPersistentChatData](Import-CsPersistentChatData.md) -{{Manually Enter Import-CsPersistentChatData Description Here}} - ### [Import-CsRgsAudioFile](Import-CsRgsAudioFile.md) -{{Manually Enter Import-CsRgsAudioFile Description Here}} - ### [Import-CsRgsConfiguration](Import-CsRgsConfiguration.md) -{{Manually Enter Import-CsRgsConfiguration Description Here}} - ### [Import-CsUserData](Import-CsUserData.md) -{{Manually Enter Import-CsUserData Description Here}} - ### [Install-CsAdServerSchema](Install-CsAdServerSchema.md) -{{Manually Enter Install-CsAdServerSchema Description Here}} - ### [Install-CsDatabase](Install-CsDatabase.md) -{{Manually Enter Install-CsDatabase Description Here}} - ### [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) -{{Manually Enter Install-CsMirrorDatabase Description Here}} - ### [Invoke-CsArchivingDatabasePurge](Invoke-CsArchivingDatabasePurge.md) -{{Manually Enter Invoke-CsArchivingDatabasePurge Description Here}} - ### [Invoke-CsBackupServiceSync](Invoke-CsBackupServiceSync.md) -{{Manually Enter Invoke-CsBackupServiceSync Description Here}} - ### [Invoke-CsCdrDatabasePurge](Invoke-CsCdrDatabasePurge.md) -{{Manually Enter Invoke-CsCdrDatabasePurge Description Here}} - ### [Invoke-CsComputerFailBack](Invoke-CsComputerFailBack.md) -{{Manually Enter Invoke-CsComputerFailBack Description Here}} - ### [Invoke-CsComputerFailOver](Invoke-CsComputerFailOver.md) -{{Manually Enter Invoke-CsComputerFailOver Description Here}} - ### [Invoke-CsDatabaseFailover](Invoke-CsDatabaseFailover.md) -{{Manually Enter Invoke-CsDatabaseFailover Description Here}} - ### [Invoke-CsManagementServerFailover](Invoke-CsManagementServerFailover.md) -{{Manually Enter Invoke-CsManagementServerFailover Description Here}} - ### [Invoke-CsManagementStoreReplication](Invoke-CsManagementStoreReplication.md) -{{Manually Enter Invoke-CsManagementStoreReplication Description Here}} - ### [Invoke-CsPoolFailBack](Invoke-CsPoolFailBack.md) -{{Manually Enter Invoke-CsPoolFailBack Description Here}} - ### [Invoke-CsPoolFailOver](Invoke-CsPoolFailOver.md) -{{Manually Enter Invoke-CsPoolFailOver Description Here}} - ### [Invoke-CsQoEDatabasePurge](Invoke-CsQoEDatabasePurge.md) -{{Manually Enter Invoke-CsQoEDatabasePurge Description Here}} - +### [Invoke-CsRgsStoreReplicateData](Invoke-CsRgsStoreReplicateData.md) ### [Invoke-CsStorageServiceFlush](Invoke-CsStorageServiceFlush.md) -{{Manually Enter Invoke-CsStorageServiceFlush Description Here}} - ### [Invoke-CsUcsRollback](Invoke-CsUcsRollback.md) -{{Manually Enter Invoke-CsUcsRollback Description Here}} - ### [Lock-CsClientPin](Lock-CsClientPin.md) -{{Manually Enter Lock-CsClientPin Description Here}} - ### [Merge-CsLegacyTopology](Merge-CsLegacyTopology.md) -{{Manually Enter Merge-CsLegacyTopology Description Here}} - ### [Move-CsAnalogDevice](Move-CsAnalogDevice.md) -{{Manually Enter Move-CsAnalogDevice Description Here}} - ### [Move-CsApplicationEndpoint](Move-CsApplicationEndpoint.md) -{{Manually Enter Move-CsApplicationEndpoint Description Here}} - ### [Move-CsCommonAreaPhone](Move-CsCommonAreaPhone.md) -{{Manually Enter Move-CsCommonAreaPhone Description Here}} - ### [Move-CsConferenceDirectory](Move-CsConferenceDirectory.md) -{{Manually Enter Move-CsConferenceDirectory Description Here}} - ### [Move-CsExUmContact](Move-CsExUmContact.md) -{{Manually Enter Move-CsExUmContact Description Here}} - ### [Move-CsLegacyUser](Move-CsLegacyUser.md) -{{Manually Enter Move-CsLegacyUser Description Here}} - ### [Move-CsManagementServer](Move-CsManagementServer.md) -{{Manually Enter Move-CsManagementServer Description Here}} - ### [Move-CsMeetingRoom](Move-CsMeetingRoom.md) -{{Manually Enter Move-CsMeetingRoom Description Here}} - ### [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) -{{Manually Enter Move-CsRgsConfiguration Description Here}} - ### [Move-CsThirdPartyVideoSystem](Move-CsThirdPartyVideoSystem.md) -{{Manually Enter Move-CsThirdPartyVideoSystem Description Here}} - ### [Move-CsUser](Move-CsUser.md) -{{Manually Enter Move-CsUser Description Here}} - +### [New-CsAdditionalInternalDomain](New-CsAdditionalInternalDomain.md) ### [New-CsAddressBookConfiguration](New-CsAddressBookConfiguration.md) -{{Manually Enter New-CsAddressBookConfiguration Description Here}} - ### [New-CsAddressBookNormalizationConfiguration](New-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter New-CsAddressBookNormalizationConfiguration Description Here}} - ### [New-CsAddressBookNormalizationRule](New-CsAddressBookNormalizationRule.md) -{{Manually Enter New-CsAddressBookNormalizationRule Description Here}} - ### [New-CsAdminRole](New-CsAdminRole.md) -{{Manually Enter New-CsAdminRole Description Here}} - ### [New-CsAllowedDomain](New-CsAllowedDomain.md) -{{Manually Enter New-CsAllowedDomain Description Here}} - ### [New-CsAnalogDevice](New-CsAnalogDevice.md) -{{Manually Enter New-CsAnalogDevice Description Here}} - ### [New-CsAnnouncement](New-CsAnnouncement.md) -{{Manually Enter New-CsAnnouncement Description Here}} - ### [New-CsArchivingConfiguration](New-CsArchivingConfiguration.md) -{{Manually Enter New-CsArchivingConfiguration Description Here}} - ### [New-CsArchivingPolicy](New-CsArchivingPolicy.md) -{{Manually Enter New-CsArchivingPolicy Description Here}} - ### [New-CsAutodiscoverConfiguration](New-CsAutodiscoverConfiguration.md) -{{Manually Enter New-CsAutodiscoverConfiguration Description Here}} - ### [New-CsAVEdgeConfiguration](New-CsAVEdgeConfiguration.md) -{{Manually Enter New-CsAVEdgeConfiguration Description Here}} - ### [New-CsBandwidthPolicyServiceConfiguration](New-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter New-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [New-CsBlockedDomain](New-CsBlockedDomain.md) -{{Manually Enter New-CsBlockedDomain Description Here}} - -### [New-CsCallerIdPolicy](New-CsCallerIdPolicy.md) -{{Manually Enter New-CsCallerIdPolicy Description Here}} - -### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) -{{Manually Enter New-CsCallingLineIdentity Description Here}} - ### [New-CsCallParkOrbit](New-CsCallParkOrbit.md) -{{Manually Enter New-CsCallParkOrbit Description Here}} - ### [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) -{{Manually Enter New-CsCallViaWorkPolicy Description Here}} - ### [New-CsCdrConfiguration](New-CsCdrConfiguration.md) -{{Manually Enter New-CsCdrConfiguration Description Here}} - ### [New-CsClientPolicy](New-CsClientPolicy.md) -{{Manually Enter New-CsClientPolicy Description Here}} - ### [New-CsClientPolicyEntry](New-CsClientPolicyEntry.md) -{{Manually Enter New-CsClientPolicyEntry Description Here}} - ### [New-CsClientVersionConfiguration](New-CsClientVersionConfiguration.md) -{{Manually Enter New-CsClientVersionConfiguration Description Here}} - ### [New-CsClientVersionPolicy](New-CsClientVersionPolicy.md) -{{Manually Enter New-CsClientVersionPolicy Description Here}} - ### [New-CsClientVersionPolicyRule](New-CsClientVersionPolicyRule.md) -{{Manually Enter New-CsClientVersionPolicyRule Description Here}} - +### [New-CsCloudCallDataConnectorConfiguration](New-CsCloudCallDataConnectorConfiguration.md) ### [New-CsClsConfiguration](New-CsClsConfiguration.md) -{{Manually Enter New-CsClsConfiguration Description Here}} - ### [New-CsClsProvider](New-CsClsProvider.md) -{{Manually Enter New-CsClsProvider Description Here}} - ### [New-CsClsRegion](New-CsClsRegion.md) -{{Manually Enter New-CsClsRegion Description Here}} - ### [New-CsClsScenario](New-CsClsScenario.md) -{{Manually Enter New-CsClsScenario Description Here}} - ### [New-CsClsSecurityGroup](New-CsClsSecurityGroup.md) -{{Manually Enter New-CsClsSecurityGroup Description Here}} - ### [New-CsCommonAreaPhone](New-CsCommonAreaPhone.md) -{{Manually Enter New-CsCommonAreaPhone Description Here}} - ### [New-CsConferenceDirectory](New-CsConferenceDirectory.md) -{{Manually Enter New-CsConferenceDirectory Description Here}} - ### [New-CsConferencingConfiguration](New-CsConferencingConfiguration.md) -{{Manually Enter New-CsConferencingConfiguration Description Here}} - ### [New-CsConferencingPolicy](New-CsConferencingPolicy.md) -{{Manually Enter New-CsConferencingPolicy Description Here}} - ### [New-CsCpsConfiguration](New-CsCpsConfiguration.md) -{{Manually Enter New-CsCpsConfiguration Description Here}} - ### [New-CsDeviceUpdateConfiguration](New-CsDeviceUpdateConfiguration.md) -{{Manually Enter New-CsDeviceUpdateConfiguration Description Here}} - ### [New-CsDiagnosticConfiguration](New-CsDiagnosticConfiguration.md) -{{Manually Enter New-CsDiagnosticConfiguration Description Here}} - ### [New-CsDiagnosticHeaderConfiguration](New-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter New-CsDiagnosticHeaderConfiguration Description Here}} - ### [New-CsDiagnosticsFilter](New-CsDiagnosticsFilter.md) -{{Manually Enter New-CsDiagnosticsFilter Description Here}} - ### [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) -{{Manually Enter New-CsDialInConferencingAccessNumber Description Here}} - ### [New-CsDialInConferencingConfiguration](New-CsDialInConferencingConfiguration.md) -{{Manually Enter New-CsDialInConferencingConfiguration Description Here}} - ### [New-CsDialInConferencingDtmfConfiguration](New-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter New-CsDialInConferencingDtmfConfiguration Description Here}} - ### [New-CsDialPlan](New-CsDialPlan.md) -{{Manually Enter New-CsDialPlan Description Here}} - -### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) -{{Manually Enter New-CsEdgeAllowAllKnownDomains Description Here}} - -### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) -{{Manually Enter New-CsEdgeAllowList Description Here}} - -### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) -{{Manually Enter New-CsEdgeDomainPattern Description Here}} - ### [New-CsEmergencyNumber](New-CsEmergencyNumber.md) -{{Manually Enter New-CsEmergencyNumber Description Here}} - ### [New-CsExtendedTest](New-CsExtendedTest.md) -{{Manually Enter New-CsExtendedTest Description Here}} - ### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) -{{Manually Enter New-CsExternalAccessPolicy Description Here}} - -### [New-CsExternalUserCommunicationPolicy](New-CsExternalUserCommunicationPolicy.md) -{{Manually Enter New-CsExternalUserCommunicationPolicy Description Here}} - ### [New-CsExUmContact](New-CsExUmContact.md) -{{Manually Enter New-CsExUmContact Description Here}} - ### [New-CsFileTransferFilterConfiguration](New-CsFileTransferFilterConfiguration.md) -{{Manually Enter New-CsFileTransferFilterConfiguration Description Here}} - ### [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) -{{Manually Enter New-CsFIPSConfiguration Description Here}} - ### [New-CsGroupPickupUserOrbit](New-CsGroupPickupUserOrbit.md) -{{Manually Enter New-CsGroupPickupUserOrbit Description Here}} - ### [New-CsHealthMonitoringConfiguration](New-CsHealthMonitoringConfiguration.md) -{{Manually Enter New-CsHealthMonitoringConfiguration Description Here}} - ### [New-CsHostedVoicemailPolicy](New-CsHostedVoicemailPolicy.md) -{{Manually Enter New-CsHostedVoicemailPolicy Description Here}} - ### [New-CsHostingProvider](New-CsHostingProvider.md) -{{Manually Enter New-CsHostingProvider Description Here}} - -### [New-CsHuntGroup](New-CsHuntGroup.md) -{{Manually Enter New-CsHuntGroup Description Here}} - -### [New-CsHybridPSTNSite](New-CsHybridPSTNSite.md) -{{Manually Enter New-CsHybridPSTNSite Description Here}} - +### [New-CsHybridApplicationEndpoint](New-CsHybridApplicationEndpoint.md) ### [New-CsImConfiguration](New-CsImConfiguration.md) -{{Manually Enter New-CsImConfiguration Description Here}} - ### [New-CsImFilterConfiguration](New-CsImFilterConfiguration.md) -{{Manually Enter New-CsImFilterConfiguration Description Here}} - ### [New-CsImTranslationConfiguration](New-CsImTranslationConfiguration.md) -{{Manually Enter New-CsImTranslationConfiguration Description Here}} - ### [New-CsIssuedCertId](New-CsIssuedCertId.md) -{{Manually Enter New-CsIssuedCertId Description Here}} - ### [New-CsKerberosAccount](New-CsKerberosAccount.md) -{{Manually Enter New-CsKerberosAccount Description Here}} - ### [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) -{{Manually Enter New-CsKerberosAccountAssignment Description Here}} - ### [New-CsLocationPolicy](New-CsLocationPolicy.md) -{{Manually Enter New-CsLocationPolicy Description Here}} - ### [New-CsMcxConfiguration](New-CsMcxConfiguration.md) -{{Manually Enter New-CsMcxConfiguration Description Here}} - ### [New-CsMediaConfiguration](New-CsMediaConfiguration.md) -{{Manually Enter New-CsMediaConfiguration Description Here}} - ### [New-CsMeetingConfiguration](New-CsMeetingConfiguration.md) -{{Manually Enter New-CsMeetingConfiguration Description Here}} - ### [New-CsMobilityPolicy](New-CsMobilityPolicy.md) -{{Manually Enter New-CsMobilityPolicy Description Here}} - ### [New-CsNetworkBandwidthPolicyProfile](New-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter New-CsNetworkBandwidthPolicyProfile Description Here}} - ### [New-CsNetworkBWAlternatePath](New-CsNetworkBWAlternatePath.md) -{{Manually Enter New-CsNetworkBWAlternatePath Description Here}} - ### [New-CsNetworkBWPolicy](New-CsNetworkBWPolicy.md) -{{Manually Enter New-CsNetworkBWPolicy Description Here}} - ### [New-CsNetworkInterRegionRoute](New-CsNetworkInterRegionRoute.md) -{{Manually Enter New-CsNetworkInterRegionRoute Description Here}} - ### [New-CsNetworkInterSitePolicy](New-CsNetworkInterSitePolicy.md) -{{Manually Enter New-CsNetworkInterSitePolicy Description Here}} - ### [New-CsNetworkMediaBypassConfiguration](New-CsNetworkMediaBypassConfiguration.md) -{{Manually Enter New-CsNetworkMediaBypassConfiguration Description Here}} - ### [New-CsNetworkRegion](New-CsNetworkRegion.md) -{{Manually Enter New-CsNetworkRegion Description Here}} - ### [New-CsNetworkRegionLink](New-CsNetworkRegionLink.md) -{{Manually Enter New-CsNetworkRegionLink Description Here}} - ### [New-CsNetworkSite](New-CsNetworkSite.md) -{{Manually Enter New-CsNetworkSite Description Here}} - ### [New-CsNetworkSubnet](New-CsNetworkSubnet.md) -{{Manually Enter New-CsNetworkSubnet Description Here}} - ### [New-CsOAuthServer](New-CsOAuthServer.md) -{{Manually Enter New-CsOAuthServer Description Here}} - -### [New-CsOnlineApplicationEndpoint](New-CsOnlineApplicationEndpoint.md) -{{Manually Enter New-CsOnlineApplicationEndpoint Description Here}} - -### [New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) -{{Manually Enter New-CsOnlineAudioFile Description Here}} - ### [New-CsOnlineBulkAssignmentInput](New-CsOnlineBulkAssignmentInput.md) -{{Manually Enter New-CsOnlineBulkAssignmentInput Description Here}} - -### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) -{{Manually Enter New-CsOnlineDateTimeRange Description Here}} - -### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) -{{Manually Enter New-CsOnlineLisCivicAddress Description Here}} - -### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) -{{Manually Enter New-CsOnlineLisLocation Description Here}} - ### [New-CsOnlineNumberPortInOrder](New-CsOnlineNumberPortInOrder.md) -{{Manually Enter New-CsOnlineNumberPortInOrder Description Here}} - -### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) -{{Manually Enter New-CsOnlineSchedule Description Here}} - -### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) -{{Manually Enter New-CsOnlineTimeRange Description Here}} - -### [New-CsOrganizationalAutoAttendant](New-CsOrganizationalAutoAttendant.md) -{{Manually Enter New-CsOrganizationalAutoAttendant Description Here}} - -### [New-CsOrganizationalAutoAttendantCallableEntity](New-CsOrganizationalAutoAttendantCallableEntity.md) -{{Manually Enter New-CsOrganizationalAutoAttendantCallableEntity Description Here}} - -### [New-CsOrganizationalAutoAttendantCallFlow](New-CsOrganizationalAutoAttendantCallFlow.md) -{{Manually Enter New-CsOrganizationalAutoAttendantCallFlow Description Here}} - -### [New-CsOrganizationalAutoAttendantCallHandlingAssociation](New-CsOrganizationalAutoAttendantCallHandlingAssociation.md) -{{Manually Enter New-CsOrganizationalAutoAttendantCallHandlingAssociation Description Here}} - -### [New-CsOrganizationalAutoAttendantDialScope](New-CsOrganizationalAutoAttendantDialScope.md) -{{Manually Enter New-CsOrganizationalAutoAttendantDialScope Description Here}} - -### [New-CsOrganizationalAutoAttendantMenu](New-CsOrganizationalAutoAttendantMenu.md) -{{Manually Enter New-CsOrganizationalAutoAttendantMenu Description Here}} - -### [New-CsOrganizationalAutoAttendantMenuOption](New-CsOrganizationalAutoAttendantMenuOption.md) -{{Manually Enter New-CsOrganizationalAutoAttendantMenuOption Description Here}} - -### [New-CsOrganizationalAutoAttendantPrompt](New-CsOrganizationalAutoAttendantPrompt.md) -{{Manually Enter New-CsOrganizationalAutoAttendantPrompt Description Here}} - +### [New-CsOnlineSession](New-CsOnlineSession.md) ### [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter New-CsOutboundCallingNumberTranslationRule Description Here}} - ### [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) -{{Manually Enter New-CsOutboundTranslationRule Description Here}} - ### [New-CsPartnerApplication](New-CsPartnerApplication.md) -{{Manually Enter New-CsPartnerApplication Description Here}} - ### [New-CsPersistentChatAddin](New-CsPersistentChatAddin.md) -{{Manually Enter New-CsPersistentChatAddin Description Here}} - ### [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) -{{Manually Enter New-CsPersistentChatCategory Description Here}} - ### [New-CsPersistentChatComplianceConfiguration](New-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter New-CsPersistentChatComplianceConfiguration Description Here}} - ### [New-CsPersistentChatConfiguration](New-CsPersistentChatConfiguration.md) -{{Manually Enter New-CsPersistentChatConfiguration Description Here}} - ### [New-CsPersistentChatEndpoint](New-CsPersistentChatEndpoint.md) -{{Manually Enter New-CsPersistentChatEndpoint Description Here}} - ### [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) -{{Manually Enter New-CsPersistentChatPolicy Description Here}} - ### [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) -{{Manually Enter New-CsPersistentChatRoom Description Here}} - ### [New-CsPinPolicy](New-CsPinPolicy.md) -{{Manually Enter New-CsPinPolicy Description Here}} - +### [New-CsPlatformServiceSettings](New-CsPlatformServiceSettings.md) ### [New-CsPresencePolicy](New-CsPresencePolicy.md) -{{Manually Enter New-CsPresencePolicy Description Here}} - ### [New-CsPresenceProvider](New-CsPresenceProvider.md) -{{Manually Enter New-CsPresenceProvider Description Here}} - ### [New-CsPrivacyConfiguration](New-CsPrivacyConfiguration.md) -{{Manually Enter New-CsPrivacyConfiguration Description Here}} - ### [New-CsProxyConfiguration](New-CsProxyConfiguration.md) -{{Manually Enter New-CsProxyConfiguration Description Here}} - ### [New-CsPublicProvider](New-CsPublicProvider.md) -{{Manually Enter New-CsPublicProvider Description Here}} - ### [New-CsPushNotificationConfiguration](New-CsPushNotificationConfiguration.md) -{{Manually Enter New-CsPushNotificationConfiguration Description Here}} - ### [New-CsQoEConfiguration](New-CsQoEConfiguration.md) -{{Manually Enter New-CsQoEConfiguration Description Here}} - ### [New-CsRegistrarConfiguration](New-CsRegistrarConfiguration.md) -{{Manually Enter New-CsRegistrarConfiguration Description Here}} - ### [New-CsReportingConfiguration](New-CsReportingConfiguration.md) -{{Manually Enter New-CsReportingConfiguration Description Here}} - ### [New-CsRgsAgentGroup](New-CsRgsAgentGroup.md) -{{Manually Enter New-CsRgsAgentGroup Description Here}} - ### [New-CsRgsAnswer](New-CsRgsAnswer.md) -{{Manually Enter New-CsRgsAnswer Description Here}} - ### [New-CsRgsCallAction](New-CsRgsCallAction.md) -{{Manually Enter New-CsRgsCallAction Description Here}} - ### [New-CsRgsHoliday](New-CsRgsHoliday.md) -{{Manually Enter New-CsRgsHoliday Description Here}} - ### [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) -{{Manually Enter New-CsRgsHolidaySet Description Here}} - ### [New-CsRgsHoursOfBusiness](New-CsRgsHoursOfBusiness.md) -{{Manually Enter New-CsRgsHoursOfBusiness Description Here}} - ### [New-CsRgsPrompt](New-CsRgsPrompt.md) -{{Manually Enter New-CsRgsPrompt Description Here}} - ### [New-CsRgsQuestion](New-CsRgsQuestion.md) -{{Manually Enter New-CsRgsQuestion Description Here}} - ### [New-CsRgsQueue](New-CsRgsQueue.md) -{{Manually Enter New-CsRgsQueue Description Here}} - ### [New-CsRgsTimeRange](New-CsRgsTimeRange.md) -{{Manually Enter New-CsRgsTimeRange Description Here}} - ### [New-CsRgsWorkflow](New-CsRgsWorkflow.md) -{{Manually Enter New-CsRgsWorkflow Description Here}} - ### [New-CsRoutingConfiguration](New-CsRoutingConfiguration.md) -{{Manually Enter New-CsRoutingConfiguration Description Here}} - ### [New-CsServerApplication](New-CsServerApplication.md) -{{Manually Enter New-CsServerApplication Description Here}} - ### [New-CsSimpleUrl](New-CsSimpleUrl.md) -{{Manually Enter New-CsSimpleUrl Description Here}} - ### [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) -{{Manually Enter New-CsSimpleUrlConfiguration Description Here}} - ### [New-CsSimpleUrlEntry](New-CsSimpleUrlEntry.md) -{{Manually Enter New-CsSimpleUrlEntry Description Here}} - ### [New-CsSipDomain](New-CsSipDomain.md) -{{Manually Enter New-CsSipDomain Description Here}} - ### [New-CsSipProxyCustom](New-CsSipProxyCustom.md) -{{Manually Enter New-CsSipProxyCustom Description Here}} - ### [New-CsSipProxyRealm](New-CsSipProxyRealm.md) -{{Manually Enter New-CsSipProxyRealm Description Here}} - ### [New-CsSipProxyTCP](New-CsSipProxyTCP.md) -{{Manually Enter New-CsSipProxyTCP Description Here}} - ### [New-CsSipProxyTLS](New-CsSipProxyTLS.md) -{{Manually Enter New-CsSipProxyTLS Description Here}} - ### [New-CsSipProxyTransport](New-CsSipProxyTransport.md) -{{Manually Enter New-CsSipProxyTransport Description Here}} - ### [New-CsSipProxyUseDefault](New-CsSipProxyUseDefault.md) -{{Manually Enter New-CsSipProxyUseDefault Description Here}} - ### [New-CsSipProxyUseDefaultCert](New-CsSipProxyUseDefaultCert.md) -{{Manually Enter New-CsSipProxyUseDefaultCert Description Here}} - ### [New-CsSipResponseCodeTranslationRule](New-CsSipResponseCodeTranslationRule.md) -{{Manually Enter New-CsSipResponseCodeTranslationRule Description Here}} - ### [New-CsStaticRoute](New-CsStaticRoute.md) -{{Manually Enter New-CsStaticRoute Description Here}} - ### [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) -{{Manually Enter New-CsStaticRoutingConfiguration Description Here}} - ### [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) -{{Manually Enter New-CsStorageServiceConfiguration Description Here}} - -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) -{{Manually Enter New-CsTeamsMeetingPolicy Description Here}} - +### [New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) ### [New-CsTelemetryConfiguration](New-CsTelemetryConfiguration.md) -{{Manually Enter New-CsTelemetryConfiguration Description Here}} - -### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) -{{Manually Enter New-CsTenantDialPlan Description Here}} - -### [New-CsTenantUpdateTimeWindow](New-CsTenantUpdateTimeWindow.md) -{{Manually Enter New-CsTenantUpdateTimeWindow Description Here}} - ### [New-CsTestDevice](New-CsTestDevice.md) -{{Manually Enter New-CsTestDevice Description Here}} - ### [New-CsThirdPartyVideoSystem](New-CsThirdPartyVideoSystem.md) -{{Manually Enter New-CsThirdPartyVideoSystem Description Here}} - ### [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter New-CsThirdPartyVideoSystemPolicy Description Here}} - ### [New-CsTrunkConfiguration](New-CsTrunkConfiguration.md) -{{Manually Enter New-CsTrunkConfiguration Description Here}} - ### [New-CsTrustedApplication](New-CsTrustedApplication.md) -{{Manually Enter New-CsTrustedApplication Description Here}} - ### [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) -{{Manually Enter New-CsTrustedApplicationComputer Description Here}} - ### [New-CsTrustedApplicationEndpoint](New-CsTrustedApplicationEndpoint.md) -{{Manually Enter New-CsTrustedApplicationEndpoint Description Here}} - ### [New-CsTrustedApplicationPool](New-CsTrustedApplicationPool.md) -{{Manually Enter New-CsTrustedApplicationPool Description Here}} - ### [New-CsUCPhoneConfiguration](New-CsUCPhoneConfiguration.md) -{{Manually Enter New-CsUCPhoneConfiguration Description Here}} - ### [New-CsUnassignedNumber](New-CsUnassignedNumber.md) -{{Manually Enter New-CsUnassignedNumber Description Here}} - ### [New-CsUserReplicatorConfiguration](New-CsUserReplicatorConfiguration.md) -{{Manually Enter New-CsUserReplicatorConfiguration Description Here}} - ### [New-CsUserServicesConfiguration](New-CsUserServicesConfiguration.md) -{{Manually Enter New-CsUserServicesConfiguration Description Here}} - ### [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) -{{Manually Enter New-CsUserServicesPolicy Description Here}} - ### [New-CsVideoInteropServerConfiguration](New-CsVideoInteropServerConfiguration.md) -{{Manually Enter New-CsVideoInteropServerConfiguration Description Here}} - ### [New-CsVideoInteropServerSyntheticTransactionConfiguration](New-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter New-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [New-CsVideoTrunkConfiguration](New-CsVideoTrunkConfiguration.md) -{{Manually Enter New-CsVideoTrunkConfiguration Description Here}} - ### [New-CsVoicemailReroutingConfiguration](New-CsVoicemailReroutingConfiguration.md) -{{Manually Enter New-CsVoicemailReroutingConfiguration Description Here}} - ### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) -{{Manually Enter New-CsVoiceNormalizationRule Description Here}} - ### [New-CsVoicePolicy](New-CsVoicePolicy.md) -{{Manually Enter New-CsVoicePolicy Description Here}} - ### [New-CsVoiceRegex](New-CsVoiceRegex.md) -{{Manually Enter New-CsVoiceRegex Description Here}} - ### [New-CsVoiceRoute](New-CsVoiceRoute.md) -{{Manually Enter New-CsVoiceRoute Description Here}} - ### [New-CsVoiceRoutingPolicy](New-CsVoiceRoutingPolicy.md) -{{Manually Enter New-CsVoiceRoutingPolicy Description Here}} - ### [New-CsVoiceTestConfiguration](New-CsVoiceTestConfiguration.md) -{{Manually Enter New-CsVoiceTestConfiguration Description Here}} - ### [New-CsWatcherNodeConfiguration](New-CsWatcherNodeConfiguration.md) -{{Manually Enter New-CsWatcherNodeConfiguration Description Here}} - ### [New-CsWebLink](New-CsWebLink.md) -{{Manually Enter New-CsWebLink Description Here}} - ### [New-CsWebOrigin](New-CsWebOrigin.md) -{{Manually Enter New-CsWebOrigin Description Here}} - ### [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) -{{Manually Enter New-CsWebServiceConfiguration Description Here}} - ### [New-CsWebTrustedCACertificate](New-CsWebTrustedCACertificate.md) -{{Manually Enter New-CsWebTrustedCACertificate Description Here}} - ### [New-CsXmppAllowedPartner](New-CsXmppAllowedPartner.md) -{{Manually Enter New-CsXmppAllowedPartner Description Here}} - ### [Publish-CsLisConfiguration](Publish-CsLisConfiguration.md) -{{Manually Enter Publish-CsLisConfiguration Description Here}} - ### [Publish-CsTopology](Publish-CsTopology.md) -{{Manually Enter Publish-CsTopology Description Here}} - -### [Register-CsHybridPSTNAppliance](Register-CsHybridPSTNAppliance.md) -{{Manually Enter Register-CsHybridPSTNAppliance Description Here}} - -### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Register-CsOnlineDialInConferencingServiceNumber Description Here}} - +### [Remove-CsAdditionalInternalDomain](Remove-CsAdditionalInternalDomain.md) ### [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) -{{Manually Enter Remove-CsAddressBookConfiguration Description Here}} - ### [Remove-CsAddressBookNormalizationConfiguration](Remove-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter Remove-CsAddressBookNormalizationConfiguration Description Here}} - ### [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) -{{Manually Enter Remove-CsAddressBookNormalizationRule Description Here}} - ### [Remove-CsAdminRole](Remove-CsAdminRole.md) -{{Manually Enter Remove-CsAdminRole Description Here}} - ### [Remove-CsAllowedDomain](Remove-CsAllowedDomain.md) -{{Manually Enter Remove-CsAllowedDomain Description Here}} - ### [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) -{{Manually Enter Remove-CsAnalogDevice Description Here}} - ### [Remove-CsAnnouncement](Remove-CsAnnouncement.md) -{{Manually Enter Remove-CsAnnouncement Description Here}} - ### [Remove-CsArchivingConfiguration](Remove-CsArchivingConfiguration.md) -{{Manually Enter Remove-CsArchivingConfiguration Description Here}} - ### [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) -{{Manually Enter Remove-CsArchivingPolicy Description Here}} - ### [Remove-CsAutodiscoverConfiguration](Remove-CsAutodiscoverConfiguration.md) -{{Manually Enter Remove-CsAutodiscoverConfiguration Description Here}} - ### [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) -{{Manually Enter Remove-CsAVEdgeConfiguration Description Here}} - ### [Remove-CsBackupServiceConfiguration](Remove-CsBackupServiceConfiguration.md) -{{Manually Enter Remove-CsBackupServiceConfiguration Description Here}} - ### [Remove-CsBandwidthPolicyServiceConfiguration](Remove-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter Remove-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [Remove-CsBlockedDomain](Remove-CsBlockedDomain.md) -{{Manually Enter Remove-CsBlockedDomain Description Here}} - ### [Remove-CsBusyOptions](Remove-CsBusyOptions.md) -{{Manually Enter Remove-CsBusyOptions Description Here}} - -### [Remove-CsCallerIdPolicy](Remove-CsCallerIdPolicy.md) -{{Manually Enter Remove-CsCallerIdPolicy Description Here}} - -### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) -{{Manually Enter Remove-CsCallingLineIdentity Description Here}} - ### [Remove-CsCallParkOrbit](Remove-CsCallParkOrbit.md) -{{Manually Enter Remove-CsCallParkOrbit Description Here}} - ### [Remove-CsCallViaWorkPolicy](Remove-CsCallViaWorkPolicy.md) -{{Manually Enter Remove-CsCallViaWorkPolicy Description Here}} - ### [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) -{{Manually Enter Remove-CsCdrConfiguration Description Here}} - ### [Remove-CsCertificate](Remove-CsCertificate.md) -{{Manually Enter Remove-CsCertificate Description Here}} - ### [Remove-CsClientPolicy](Remove-CsClientPolicy.md) -{{Manually Enter Remove-CsClientPolicy Description Here}} - ### [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) -{{Manually Enter Remove-CsClientVersionConfiguration Description Here}} - ### [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) -{{Manually Enter Remove-CsClientVersionPolicy Description Here}} - ### [Remove-CsClientVersionPolicyRule](Remove-CsClientVersionPolicyRule.md) -{{Manually Enter Remove-CsClientVersionPolicyRule Description Here}} - ### [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) -{{Manually Enter Remove-CsClsConfiguration Description Here}} - ### [Remove-CsClsRegion](Remove-CsClsRegion.md) -{{Manually Enter Remove-CsClsRegion Description Here}} - ### [Remove-CsClsScenario](Remove-CsClsScenario.md) -{{Manually Enter Remove-CsClsScenario Description Here}} - ### [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) -{{Manually Enter Remove-CsClsSecurityGroup Description Here}} - ### [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) -{{Manually Enter Remove-CsCommonAreaPhone Description Here}} - ### [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) -{{Manually Enter Remove-CsConferenceDirectory Description Here}} - ### [Remove-CsConferenceDisclaimer](Remove-CsConferenceDisclaimer.md) -{{Manually Enter Remove-CsConferenceDisclaimer Description Here}} - ### [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) -{{Manually Enter Remove-CsConferencingConfiguration Description Here}} - ### [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) -{{Manually Enter Remove-CsConferencingPolicy Description Here}} - ### [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) -{{Manually Enter Remove-CsConfigurationStoreLocation Description Here}} - ### [Remove-CsConversationHistoryConfiguration](Remove-CsConversationHistoryConfiguration.md) -{{Manually Enter Remove-CsConversationHistoryConfiguration Description Here}} - ### [Remove-CsCpsConfiguration](Remove-CsCpsConfiguration.md) -{{Manually Enter Remove-CsCpsConfiguration Description Here}} - ### [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) -{{Manually Enter Remove-CsDeviceUpdateConfiguration Description Here}} - ### [Remove-CsDeviceUpdateRule](Remove-CsDeviceUpdateRule.md) -{{Manually Enter Remove-CsDeviceUpdateRule Description Here}} - ### [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) -{{Manually Enter Remove-CsDiagnosticConfiguration Description Here}} - ### [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter Remove-CsDiagnosticHeaderConfiguration Description Here}} - ### [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) -{{Manually Enter Remove-CsDialInConferencingAccessNumber Description Here}} - ### [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) -{{Manually Enter Remove-CsDialInConferencingConfiguration Description Here}} - ### [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter Remove-CsDialInConferencingDtmfConfiguration Description Here}} - ### [Remove-CsDialPlan](Remove-CsDialPlan.md) -{{Manually Enter Remove-CsDialPlan Description Here}} - ### [Remove-CsEnhancedEmergencyServiceDisclaimer](Remove-CsEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Remove-CsEnhancedEmergencyServiceDisclaimer Description Here}} - ### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) -{{Manually Enter Remove-CsExternalAccessPolicy Description Here}} - -### [Remove-CsExternalUserCommunicationPolicy](Remove-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Remove-CsExternalUserCommunicationPolicy Description Here}} - ### [Remove-CsExUmContact](Remove-CsExUmContact.md) -{{Manually Enter Remove-CsExUmContact Description Here}} - ### [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) -{{Manually Enter Remove-CsFileTransferFilterConfiguration Description Here}} - ### [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) -{{Manually Enter Remove-CsFIPSConfiguration Description Here}} - ### [Remove-CsGroupPickupUserOrbit](Remove-CsGroupPickupUserOrbit.md) -{{Manually Enter Remove-CsGroupPickupUserOrbit Description Here}} - ### [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) -{{Manually Enter Remove-CsHealthMonitoringConfiguration Description Here}} - ### [Remove-CsHostedVoicemailPolicy](Remove-CsHostedVoicemailPolicy.md) -{{Manually Enter Remove-CsHostedVoicemailPolicy Description Here}} - ### [Remove-CsHostingProvider](Remove-CsHostingProvider.md) -{{Manually Enter Remove-CsHostingProvider Description Here}} - -### [Remove-CsHuntGroup](Remove-CsHuntGroup.md) -{{Manually Enter Remove-CsHuntGroup Description Here}} - -### [Remove-CsHybridPSTNSite](Remove-CsHybridPSTNSite.md) -{{Manually Enter Remove-CsHybridPSTNSite Description Here}} - +### [Remove-CsHybridApplicationEndpoint](Remove-CsHybridApplicationEndpoint.md) ### [Remove-CsImConfiguration](Remove-CsImConfiguration.md) -{{Manually Enter Remove-CsImConfiguration Description Here}} - ### [Remove-CsImFilterConfiguration](Remove-CsImFilterConfiguration.md) -{{Manually Enter Remove-CsImFilterConfiguration Description Here}} - ### [Remove-CsImTranslationConfiguration](Remove-CsImTranslationConfiguration.md) -{{Manually Enter Remove-CsImTranslationConfiguration Description Here}} - ### [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) -{{Manually Enter Remove-CsKerberosAccountAssignment Description Here}} - ### [Remove-CsLisLocation](Remove-CsLisLocation.md) -{{Manually Enter Remove-CsLisLocation Description Here}} - ### [Remove-CsLisPort](Remove-CsLisPort.md) -{{Manually Enter Remove-CsLisPort Description Here}} - ### [Remove-CsLisServiceProvider](Remove-CsLisServiceProvider.md) -{{Manually Enter Remove-CsLisServiceProvider Description Here}} - ### [Remove-CsLisSubnet](Remove-CsLisSubnet.md) -{{Manually Enter Remove-CsLisSubnet Description Here}} - ### [Remove-CsLisSwitch](Remove-CsLisSwitch.md) -{{Manually Enter Remove-CsLisSwitch Description Here}} - ### [Remove-CsLisWirelessAccessPoint](Remove-CsLisWirelessAccessPoint.md) -{{Manually Enter Remove-CsLisWirelessAccessPoint Description Here}} - ### [Remove-CsLocationPolicy](Remove-CsLocationPolicy.md) -{{Manually Enter Remove-CsLocationPolicy Description Here}} - ### [Remove-CsManagementConnection](Remove-CsManagementConnection.md) -{{Manually Enter Remove-CsManagementConnection Description Here}} - ### [Remove-CsMcxConfiguration](Remove-CsMcxConfiguration.md) -{{Manually Enter Remove-CsMcxConfiguration Description Here}} - ### [Remove-CsMediaConfiguration](Remove-CsMediaConfiguration.md) -{{Manually Enter Remove-CsMediaConfiguration Description Here}} - ### [Remove-CsMeetingConfiguration](Remove-CsMeetingConfiguration.md) -{{Manually Enter Remove-CsMeetingConfiguration Description Here}} - ### [Remove-CsMobilityPolicy](Remove-CsMobilityPolicy.md) -{{Manually Enter Remove-CsMobilityPolicy Description Here}} - ### [Remove-CsNetworkBandwidthPolicyProfile](Remove-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter Remove-CsNetworkBandwidthPolicyProfile Description Here}} - ### [Remove-CsNetworkConfiguration](Remove-CsNetworkConfiguration.md) -{{Manually Enter Remove-CsNetworkConfiguration Description Here}} - ### [Remove-CsNetworkInterRegionRoute](Remove-CsNetworkInterRegionRoute.md) -{{Manually Enter Remove-CsNetworkInterRegionRoute Description Here}} - ### [Remove-CsNetworkInterSitePolicy](Remove-CsNetworkInterSitePolicy.md) -{{Manually Enter Remove-CsNetworkInterSitePolicy Description Here}} - ### [Remove-CsNetworkRegion](Remove-CsNetworkRegion.md) -{{Manually Enter Remove-CsNetworkRegion Description Here}} - ### [Remove-CsNetworkRegionLink](Remove-CsNetworkRegionLink.md) -{{Manually Enter Remove-CsNetworkRegionLink Description Here}} - ### [Remove-CsNetworkSite](Remove-CsNetworkSite.md) -{{Manually Enter Remove-CsNetworkSite Description Here}} - ### [Remove-CsNetworkSubnet](Remove-CsNetworkSubnet.md) -{{Manually Enter Remove-CsNetworkSubnet Description Here}} - ### [Remove-CsOAuthServer](Remove-CsOAuthServer.md) -{{Manually Enter Remove-CsOAuthServer Description Here}} - -### [Remove-CsOnlineApplicationEndpoint](Remove-CsOnlineApplicationEndpoint.md) -{{Manually Enter Remove-CsOnlineApplicationEndpoint Description Here}} - -### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) -{{Manually Enter Remove-CsOnlineDialInConferencingTenantSettings Description Here}} - -### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) -{{Manually Enter Remove-CsOnlineLisCivicAddress Description Here}} - -### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) -{{Manually Enter Remove-CsOnlineLisLocation Description Here}} - ### [Remove-CsOnlineNumberPortInOrder](Remove-CsOnlineNumberPortInOrder.md) -{{Manually Enter Remove-CsOnlineNumberPortInOrder Description Here}} - -### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) -{{Manually Enter Remove-CsOnlineTelephoneNumber Description Here}} - -### [Remove-CsOrganizationalAutoAttendant](Remove-CsOrganizationalAutoAttendant.md) -{{Manually Enter Remove-CsOrganizationalAutoAttendant Description Here}} - ### [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter Remove-CsOutboundCallingNumberTranslationRule Description Here}} - ### [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) -{{Manually Enter Remove-CsOutboundTranslationRule Description Here}} - ### [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) -{{Manually Enter Remove-CsPartnerApplication Description Here}} - ### [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) -{{Manually Enter Remove-CsPersistentChatAddin Description Here}} - ### [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) -{{Manually Enter Remove-CsPersistentChatCategory Description Here}} - ### [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter Remove-CsPersistentChatComplianceConfiguration Description Here}} - ### [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) -{{Manually Enter Remove-CsPersistentChatConfiguration Description Here}} - ### [Remove-CsPersistentChatEndpoint](Remove-CsPersistentChatEndpoint.md) -{{Manually Enter Remove-CsPersistentChatEndpoint Description Here}} - ### [Remove-CsPersistentChatMessage](Remove-CsPersistentChatMessage.md) -{{Manually Enter Remove-CsPersistentChatMessage Description Here}} - ### [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) -{{Manually Enter Remove-CsPersistentChatPolicy Description Here}} - ### [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) -{{Manually Enter Remove-CsPersistentChatRoom Description Here}} - ### [Remove-CsPinPolicy](Remove-CsPinPolicy.md) -{{Manually Enter Remove-CsPinPolicy Description Here}} - +### [Remove-CsPlatformServiceSettings](Remove-CsPlatformServiceSettings.md) ### [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) -{{Manually Enter Remove-CsPresencePolicy Description Here}} - ### [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) -{{Manually Enter Remove-CsPresenceProvider Description Here}} - ### [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) -{{Manually Enter Remove-CsPrivacyConfiguration Description Here}} - ### [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) -{{Manually Enter Remove-CsProxyConfiguration Description Here}} - ### [Remove-CsPublicProvider](Remove-CsPublicProvider.md) -{{Manually Enter Remove-CsPublicProvider Description Here}} - ### [Remove-CsPushNotificationConfiguration](Remove-CsPushNotificationConfiguration.md) -{{Manually Enter Remove-CsPushNotificationConfiguration Description Here}} - ### [Remove-CsQoEConfiguration](Remove-CsQoEConfiguration.md) -{{Manually Enter Remove-CsQoEConfiguration Description Here}} - ### [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) -{{Manually Enter Remove-CsRegistrarConfiguration Description Here}} - ### [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) -{{Manually Enter Remove-CsReportingConfiguration Description Here}} - ### [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) -{{Manually Enter Remove-CsRgsAgentGroup Description Here}} - ### [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) -{{Manually Enter Remove-CsRgsHolidaySet Description Here}} - ### [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) -{{Manually Enter Remove-CsRgsHoursOfBusiness Description Here}} - ### [Remove-CsRgsQueue](Remove-CsRgsQueue.md) -{{Manually Enter Remove-CsRgsQueue Description Here}} - ### [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) -{{Manually Enter Remove-CsRgsWorkflow Description Here}} - ### [Remove-CsRoutingConfiguration](Remove-CsRoutingConfiguration.md) -{{Manually Enter Remove-CsRoutingConfiguration Description Here}} - ### [Remove-CsServerApplication](Remove-CsServerApplication.md) -{{Manually Enter Remove-CsServerApplication Description Here}} - ### [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) -{{Manually Enter Remove-CsSimpleUrlConfiguration Description Here}} - ### [Remove-CsSipDomain](Remove-CsSipDomain.md) -{{Manually Enter Remove-CsSipDomain Description Here}} - ### [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) -{{Manually Enter Remove-CsSipResponseCodeTranslationRule Description Here}} - ### [Remove-CsSlaConfiguration](Remove-CsSlaConfiguration.md) -{{Manually Enter Remove-CsSlaConfiguration Description Here}} - ### [Remove-CsSlaDelegates](Remove-CsSlaDelegates.md) -{{Manually Enter Remove-CsSlaDelegates Description Here}} - ### [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) -{{Manually Enter Remove-CsStaticRoutingConfiguration Description Here}} - ### [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) -{{Manually Enter Remove-CsStorageServiceConfiguration Description Here}} - -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) -{{Manually Enter Remove-CsTeamsMeetingPolicy Description Here}} - +### [Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) ### [Remove-CsTelemetryConfiguration](Remove-CsTelemetryConfiguration.md) -{{Manually Enter Remove-CsTelemetryConfiguration Description Here}} - -### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) -{{Manually Enter Remove-CsTenantDialPlan Description Here}} - -### [Remove-CsTenantUpdateTimeWindow](Remove-CsTenantUpdateTimeWindow.md) -{{Manually Enter Remove-CsTenantUpdateTimeWindow Description Here}} - ### [Remove-CsTestDevice](Remove-CsTestDevice.md) -{{Manually Enter Remove-CsTestDevice Description Here}} - ### [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) -{{Manually Enter Remove-CsTestUserCredential Description Here}} - ### [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) -{{Manually Enter Remove-CsThirdPartyVideoSystem Description Here}} - ### [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Remove-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Remove-CsTrunkConfiguration](Remove-CsTrunkConfiguration.md) -{{Manually Enter Remove-CsTrunkConfiguration Description Here}} - ### [Remove-CsTrustedApplication](Remove-CsTrustedApplication.md) -{{Manually Enter Remove-CsTrustedApplication Description Here}} - ### [Remove-CsTrustedApplicationComputer](Remove-CsTrustedApplicationComputer.md) -{{Manually Enter Remove-CsTrustedApplicationComputer Description Here}} - ### [Remove-CsTrustedApplicationEndpoint](Remove-CsTrustedApplicationEndpoint.md) -{{Manually Enter Remove-CsTrustedApplicationEndpoint Description Here}} - ### [Remove-CsTrustedApplicationPool](Remove-CsTrustedApplicationPool.md) -{{Manually Enter Remove-CsTrustedApplicationPool Description Here}} - ### [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) -{{Manually Enter Remove-CsUCPhoneConfiguration Description Here}} - ### [Remove-CsUnassignedNumber](Remove-CsUnassignedNumber.md) -{{Manually Enter Remove-CsUnassignedNumber Description Here}} - ### [Remove-CsUserAcp](Remove-CsUserAcp.md) -{{Manually Enter Remove-CsUserAcp Description Here}} - ### [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) -{{Manually Enter Remove-CsUserReplicatorConfiguration Description Here}} - ### [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) -{{Manually Enter Remove-CsUserServicesConfiguration Description Here}} - ### [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) -{{Manually Enter Remove-CsUserServicesPolicy Description Here}} - ### [Remove-CsUserStoreBackupData](Remove-CsUserStoreBackupData.md) -{{Manually Enter Remove-CsUserStoreBackupData Description Here}} - ### [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) -{{Manually Enter Remove-CsVideoInteropServerConfiguration Description Here}} - ### [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter Remove-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) -{{Manually Enter Remove-CsVideoTrunkConfiguration Description Here}} - ### [Remove-CsVoiceConfiguration](Remove-CsVoiceConfiguration.md) -{{Manually Enter Remove-CsVoiceConfiguration Description Here}} - ### [Remove-CsVoicemailReroutingConfiguration](Remove-CsVoicemailReroutingConfiguration.md) -{{Manually Enter Remove-CsVoicemailReroutingConfiguration Description Here}} - ### [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) -{{Manually Enter Remove-CsVoiceNormalizationRule Description Here}} - ### [Remove-CsVoicePolicy](Remove-CsVoicePolicy.md) -{{Manually Enter Remove-CsVoicePolicy Description Here}} - ### [Remove-CsVoiceRoute](Remove-CsVoiceRoute.md) -{{Manually Enter Remove-CsVoiceRoute Description Here}} - ### [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) -{{Manually Enter Remove-CsVoiceRoutingPolicy Description Here}} - ### [Remove-CsVoiceTestConfiguration](Remove-CsVoiceTestConfiguration.md) -{{Manually Enter Remove-CsVoiceTestConfiguration Description Here}} - ### [Remove-CsWatcherNodeConfiguration](Remove-CsWatcherNodeConfiguration.md) -{{Manually Enter Remove-CsWatcherNodeConfiguration Description Here}} - ### [Remove-CsWebServiceConfiguration](Remove-CsWebServiceConfiguration.md) -{{Manually Enter Remove-CsWebServiceConfiguration Description Here}} - ### [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) -{{Manually Enter Remove-CsXmppAllowedPartner Description Here}} - ### [Request-CsCertificate](Request-CsCertificate.md) -{{Manually Enter Request-CsCertificate Description Here}} - ### [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) -{{Manually Enter Reset-CsDeviceUpdateRule Description Here}} - ### [Reset-CsNotificationQueues](Reset-CsNotificationQueues.md) -{{Manually Enter Reset-CsNotificationQueues Description Here}} - ### [Reset-CsPoolRegistrarState](Reset-CsPoolRegistrarState.md) -{{Manually Enter Reset-CsPoolRegistrarState Description Here}} - ### [Reset-CsRoutingGroup](Reset-CsRoutingGroup.md) -{{Manually Enter Reset-CsRoutingGroup Description Here}} - ### [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) -{{Manually Enter Restore-CsDeviceUpdateRule Description Here}} - ### [Revoke-CsClientCertificate](Revoke-CsClientCertificate.md) -{{Manually Enter Revoke-CsClientCertificate Description Here}} - ### [Revoke-CsOUPermission](Revoke-CsOUPermission.md) -{{Manually Enter Revoke-CsOUPermission Description Here}} - ### [Revoke-CsSetupPermission](Revoke-CsSetupPermission.md) -{{Manually Enter Revoke-CsSetupPermission Description Here}} - ### [Search-CsClsLogging](Search-CsClsLogging.md) -{{Manually Enter Search-CsClsLogging Description Here}} - -### [Search-CsOnlineTelephoneNumberInventory](Search-CsOnlineTelephoneNumberInventory.md) -{{Manually Enter Search-CsOnlineTelephoneNumberInventory Description Here}} - -### [Select-CsOnlineTelephoneNumberInventory](Select-CsOnlineTelephoneNumberInventory.md) -{{Manually Enter Select-CsOnlineTelephoneNumberInventory Description Here}} - ### [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) -{{Manually Enter Set-CsAccessEdgeConfiguration Description Here}} - ### [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) -{{Manually Enter Set-CsAddressBookConfiguration Description Here}} - ### [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter Set-CsAddressBookNormalizationConfiguration Description Here}} - ### [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) -{{Manually Enter Set-CsAddressBookNormalizationRule Description Here}} - ### [Set-CsAdminRole](Set-CsAdminRole.md) -{{Manually Enter Set-CsAdminRole Description Here}} - ### [Set-CsAllowedDomain](Set-CsAllowedDomain.md) -{{Manually Enter Set-CsAllowedDomain Description Here}} - ### [Set-CsAnalogDevice](Set-CsAnalogDevice.md) -{{Manually Enter Set-CsAnalogDevice Description Here}} - ### [Set-CsAnnouncement](Set-CsAnnouncement.md) -{{Manually Enter Set-CsAnnouncement Description Here}} - ### [Set-CsApplicationServer](Set-CsApplicationServer.md) -{{Manually Enter Set-CsApplicationServer Description Here}} - ### [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) -{{Manually Enter Set-CsArchivingConfiguration Description Here}} - ### [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) -{{Manually Enter Set-CsArchivingPolicy Description Here}} - ### [Set-CsArchivingServer](Set-CsArchivingServer.md) -{{Manually Enter Set-CsArchivingServer Description Here}} - ### [Set-CsAudioTestServiceApplication](Set-CsAudioTestServiceApplication.md) -{{Manually Enter Set-CsAudioTestServiceApplication Description Here}} - +### [Set-CsAuthConfig](Set-CsAuthConfig.md) ### [Set-CsAutodiscoverConfiguration](Set-CsAutodiscoverConfiguration.md) -{{Manually Enter Set-CsAutodiscoverConfiguration Description Here}} - ### [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) -{{Manually Enter Set-CsAVEdgeConfiguration Description Here}} - ### [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) -{{Manually Enter Set-CsBackupServiceConfiguration Description Here}} - ### [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter Set-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [Set-CsBlockedDomain](Set-CsBlockedDomain.md) -{{Manually Enter Set-CsBlockedDomain Description Here}} - -### [Set-CsBroadcastMeetingConfiguration](Set-CsBroadcastMeetingConfiguration.md) -{{Manually Enter Set-CsBroadcastMeetingConfiguration Description Here}} - ### [Set-CsBusyOptions](Set-CsBusyOptions.md) -{{Manually Enter Set-CsBusyOptions Description Here}} - -### [Set-CsCallerIdPolicy](Set-CsCallerIdPolicy.md) -{{Manually Enter Set-CsCallerIdPolicy Description Here}} - -### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) -{{Manually Enter Set-CsCallingLineIdentity Description Here}} - ### [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) -{{Manually Enter Set-CsCallParkOrbit Description Here}} - ### [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) -{{Manually Enter Set-CsCallParkServiceMusicOnHoldFile Description Here}} - ### [Set-CsCallViaWorkPolicy](Set-CsCallViaWorkPolicy.md) -{{Manually Enter Set-CsCallViaWorkPolicy Description Here}} - -### [Set-CsCceApplianceConfigurationReplicationStatus](Set-CsCceApplianceConfigurationReplicationStatus.md) -{{Manually Enter Set-CsCceApplianceConfigurationReplicationStatus Description Here}} - -### [Set-CsCceApplianceDeploymentStatus](Set-CsCceApplianceDeploymentStatus.md) -{{Manually Enter Set-CsCceApplianceDeploymentStatus Description Here}} - -### [Set-CsCceApplianceStatus](Set-CsCceApplianceStatus.md) -{{Manually Enter Set-CsCceApplianceStatus Description Here}} - ### [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) -{{Manually Enter Set-CsCdrConfiguration Description Here}} - ### [Set-CsCertificate](Set-CsCertificate.md) -{{Manually Enter Set-CsCertificate Description Here}} - ### [Set-CsClientPin](Set-CsClientPin.md) -{{Manually Enter Set-CsClientPin Description Here}} - ### [Set-CsClientPolicy](Set-CsClientPolicy.md) -{{Manually Enter Set-CsClientPolicy Description Here}} - ### [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) -{{Manually Enter Set-CsClientVersionConfiguration Description Here}} - ### [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) -{{Manually Enter Set-CsClientVersionPolicy Description Here}} - ### [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) -{{Manually Enter Set-CsClientVersionPolicyRule Description Here}} - +### [Set-CsCloudCallDataConnector](Set-CsCloudCallDataConnector.md) +### [Set-CsCloudCallDataConnectorConfiguration](Set-CsCloudCallDataConnectorConfiguration.md) ### [Set-CsClsConfiguration](Set-CsClsConfiguration.md) -{{Manually Enter Set-CsClsConfiguration Description Here}} - ### [Set-CsClsRegion](Set-CsClsRegion.md) -{{Manually Enter Set-CsClsRegion Description Here}} - ### [Set-CsClsScenario](Set-CsClsScenario.md) -{{Manually Enter Set-CsClsScenario Description Here}} - ### [Set-CsClsSearchTerm](Set-CsClsSearchTerm.md) -{{Manually Enter Set-CsClsSearchTerm Description Here}} - ### [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) -{{Manually Enter Set-CsClsSecurityGroup Description Here}} - ### [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) -{{Manually Enter Set-CsCommonAreaPhone Description Here}} - ### [Set-CsConferenceDisclaimer](Set-CsConferenceDisclaimer.md) -{{Manually Enter Set-CsConferenceDisclaimer Description Here}} - ### [Set-CsConferenceServer](Set-CsConferenceServer.md) -{{Manually Enter Set-CsConferenceServer Description Here}} - ### [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) -{{Manually Enter Set-CsConferencingConfiguration Description Here}} - ### [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) -{{Manually Enter Set-CsConferencingPolicy Description Here}} - ### [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) -{{Manually Enter Set-CsConfigurationStoreLocation Description Here}} - ### [Set-CsConversationHistoryConfiguration](Set-CsConversationHistoryConfiguration.md) -{{Manually Enter Set-CsConversationHistoryConfiguration Description Here}} - ### [Set-CsCpsConfiguration](Set-CsCpsConfiguration.md) -{{Manually Enter Set-CsCpsConfiguration Description Here}} - ### [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) -{{Manually Enter Set-CsDeviceUpdateConfiguration Description Here}} - ### [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) -{{Manually Enter Set-CsDiagnosticConfiguration Description Here}} - ### [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter Set-CsDiagnosticHeaderConfiguration Description Here}} - ### [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) -{{Manually Enter Set-CsDialInConferencingAccessNumber Description Here}} - ### [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) -{{Manually Enter Set-CsDialInConferencingConfiguration Description Here}} - ### [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter Set-CsDialInConferencingDtmfConfiguration Description Here}} - ### [Set-CsDialPlan](Set-CsDialPlan.md) -{{Manually Enter Set-CsDialPlan Description Here}} - ### [Set-CsDirector](Set-CsDirector.md) -{{Manually Enter Set-CsDirector Description Here}} - ### [Set-CsEdgeServer](Set-CsEdgeServer.md) -{{Manually Enter Set-CsEdgeServer Description Here}} - ### [Set-CsEnhancedEmergencyServiceDisclaimer](Set-CsEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Set-CsEnhancedEmergencyServiceDisclaimer Description Here}} - ### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) -{{Manually Enter Set-CsExternalAccessPolicy Description Here}} - -### [Set-CsExternalUserCommunicationPolicy](Set-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Set-CsExternalUserCommunicationPolicy Description Here}} - ### [Set-CsExUmContact](Set-CsExUmContact.md) -{{Manually Enter Set-CsExUmContact Description Here}} - ### [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) -{{Manually Enter Set-CsFileTransferFilterConfiguration Description Here}} - ### [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) -{{Manually Enter Set-CsFIPSConfiguration Description Here}} - ### [Set-CsGroupPickupUserOrbit](Set-CsGroupPickupUserOrbit.md) -{{Manually Enter Set-CsGroupPickupUserOrbit Description Here}} - ### [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) -{{Manually Enter Set-CsHealthMonitoringConfiguration Description Here}} - ### [Set-CsHostedVoicemailPolicy](Set-CsHostedVoicemailPolicy.md) -{{Manually Enter Set-CsHostedVoicemailPolicy Description Here}} - ### [Set-CsHostingProvider](Set-CsHostingProvider.md) -{{Manually Enter Set-CsHostingProvider Description Here}} - -### [Set-CsHuntGroup](Set-CsHuntGroup.md) -{{Manually Enter Set-CsHuntGroup Description Here}} - -### [Set-CsHybridMediationServer](Set-CsHybridMediationServer.md) -{{Manually Enter Set-CsHybridMediationServer Description Here}} - -### [Set-CsHybridPSTNAppliance](Set-CsHybridPSTNAppliance.md) -{{Manually Enter Set-CsHybridPSTNAppliance Description Here}} - -### [Set-CsHybridPSTNSite](Set-CsHybridPSTNSite.md) -{{Manually Enter Set-CsHybridPSTNSite Description Here}} - +### [Set-CsHybridApplicationEndpoint](Set-CsHybridApplicationEndpoint.md) ### [Set-CsImConfiguration](Set-CsImConfiguration.md) -{{Manually Enter Set-CsImConfiguration Description Here}} - ### [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) -{{Manually Enter Set-CsImFilterConfiguration Description Here}} - ### [Set-CsImTranslationConfiguration](Set-CsImTranslationConfiguration.md) -{{Manually Enter Set-CsImTranslationConfiguration Description Here}} - ### [Set-CsIPPhonePolicy](Set-CsIPPhonePolicy.md) -{{Manually Enter Set-CsIPPhonePolicy Description Here}} - ### [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) -{{Manually Enter Set-CsKerberosAccountAssignment Description Here}} - ### [Set-CsKerberosAccountPassword](Set-CsKerberosAccountPassword.md) -{{Manually Enter Set-CsKerberosAccountPassword Description Here}} - ### [Set-CsLisLocation](Set-CsLisLocation.md) -{{Manually Enter Set-CsLisLocation Description Here}} - ### [Set-CsLisPort](Set-CsLisPort.md) -{{Manually Enter Set-CsLisPort Description Here}} - ### [Set-CsLisServiceProvider](Set-CsLisServiceProvider.md) -{{Manually Enter Set-CsLisServiceProvider Description Here}} - ### [Set-CsLisSubnet](Set-CsLisSubnet.md) -{{Manually Enter Set-CsLisSubnet Description Here}} - ### [Set-CsLisSwitch](Set-CsLisSwitch.md) -{{Manually Enter Set-CsLisSwitch Description Here}} - ### [Set-CsLisWirelessAccessPoint](Set-CsLisWirelessAccessPoint.md) -{{Manually Enter Set-CsLisWirelessAccessPoint Description Here}} - ### [Set-CsLocationPolicy](Set-CsLocationPolicy.md) -{{Manually Enter Set-CsLocationPolicy Description Here}} - ### [Set-CsManagementConnection](Set-CsManagementConnection.md) -{{Manually Enter Set-CsManagementConnection Description Here}} - ### [Set-CsManagementServer](Set-CsManagementServer.md) -{{Manually Enter Set-CsManagementServer Description Here}} - ### [Set-CsMcxConfiguration](Set-CsMcxConfiguration.md) -{{Manually Enter Set-CsMcxConfiguration Description Here}} - ### [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) -{{Manually Enter Set-CsMediaConfiguration Description Here}} - ### [Set-CsMediationServer](Set-CsMediationServer.md) -{{Manually Enter Set-CsMediationServer Description Here}} - ### [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) -{{Manually Enter Set-CsMeetingConfiguration Description Here}} - ### [Set-CsMeetingRoom](Set-CsMeetingRoom.md) -{{Manually Enter Set-CsMeetingRoom Description Here}} - ### [Set-CsMobilityPolicy](Set-CsMobilityPolicy.md) -{{Manually Enter Set-CsMobilityPolicy Description Here}} - ### [Set-CsMonitoringServer](Set-CsMonitoringServer.md) -{{Manually Enter Set-CsMonitoringServer Description Here}} - ### [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter Set-CsNetworkBandwidthPolicyProfile Description Here}} - ### [Set-CsNetworkConfiguration](Set-CsNetworkConfiguration.md) -{{Manually Enter Set-CsNetworkConfiguration Description Here}} - ### [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) -{{Manually Enter Set-CsNetworkInterRegionRoute Description Here}} - ### [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) -{{Manually Enter Set-CsNetworkInterSitePolicy Description Here}} - ### [Set-CsNetworkRegion](Set-CsNetworkRegion.md) -{{Manually Enter Set-CsNetworkRegion Description Here}} - ### [Set-CsNetworkRegionLink](Set-CsNetworkRegionLink.md) -{{Manually Enter Set-CsNetworkRegionLink Description Here}} - ### [Set-CsNetworkSite](Set-CsNetworkSite.md) -{{Manually Enter Set-CsNetworkSite Description Here}} - ### [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) -{{Manually Enter Set-CsNetworkSubnet Description Here}} - ### [Set-CsOAuthConfiguration](Set-CsOAuthConfiguration.md) -{{Manually Enter Set-CsOAuthConfiguration Description Here}} - ### [Set-CsOAuthServer](Set-CsOAuthServer.md) -{{Manually Enter Set-CsOAuthServer Description Here}} - -### [Set-CsOnlineApplicationEndpoint](Set-CsOnlineApplicationEndpoint.md) -{{Manually Enter Set-CsOnlineApplicationEndpoint Description Here}} - -### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) -{{Manually Enter Set-CsOnlineDialInConferencingBridge Description Here}} - -### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Set-CsOnlineDialInConferencingServiceNumber Description Here}} - -### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) -{{Manually Enter Set-CsOnlineDialInConferencingTenantSettings Description Here}} - -### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) -{{Manually Enter Set-CsOnlineDialInConferencingUser Description Here}} - ### [Set-CsOnlineDialInConferencingUserDefaultNumber](Set-CsOnlineDialInConferencingUserDefaultNumber.md) -{{Manually Enter Set-CsOnlineDialInConferencingUserDefaultNumber Description Here}} - ### [Set-CsOnlineDirectoryUser](Set-CsOnlineDirectoryUser.md) -{{Manually Enter Set-CsOnlineDirectoryUser Description Here}} - -### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Set-CsOnlineEnhancedEmergencyServiceDisclaimer Description Here}} - -### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) -{{Manually Enter Set-CsOnlineLisCivicAddress Description Here}} - -### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) -{{Manually Enter Set-CsOnlineLisLocation Description Here}} - ### [Set-CsOnlineNumberPortInOrder](Set-CsOnlineNumberPortInOrder.md) -{{Manually Enter Set-CsOnlineNumberPortInOrder Description Here}} - ### [Set-CsOnlineNumberPortOutOrderPin](Set-CsOnlineNumberPortOutOrderPin.md) -{{Manually Enter Set-CsOnlineNumberPortOutOrderPin Description Here}} - -### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) -{{Manually Enter Set-CsOnlineVoicemailPolicy Description Here}} - -### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) -{{Manually Enter Set-CsOnlineVoiceUser Description Here}} - ### [Set-CsOnlineVoiceUserBulk](Set-CsOnlineVoiceUserBulk.md) -{{Manually Enter Set-CsOnlineVoiceUserBulk Description Here}} - -### [Set-CsOrganizationalAutoAttendant](Set-CsOrganizationalAutoAttendant.md) -{{Manually Enter Set-CsOrganizationalAutoAttendant Description Here}} - ### [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter Set-CsOutboundCallingNumberTranslationRule Description Here}} - ### [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) -{{Manually Enter Set-CsOutboundTranslationRule Description Here}} - ### [Set-CsPartnerApplication](Set-CsPartnerApplication.md) -{{Manually Enter Set-CsPartnerApplication Description Here}} - ### [Set-CsPersistentChatActiveServer](Set-CsPersistentChatActiveServer.md) -{{Manually Enter Set-CsPersistentChatActiveServer Description Here}} - ### [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) -{{Manually Enter Set-CsPersistentChatAddin Description Here}} - ### [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) -{{Manually Enter Set-CsPersistentChatCategory Description Here}} - ### [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter Set-CsPersistentChatComplianceConfiguration Description Here}} - ### [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) -{{Manually Enter Set-CsPersistentChatConfiguration Description Here}} - ### [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) -{{Manually Enter Set-CsPersistentChatPolicy Description Here}} - ### [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) -{{Manually Enter Set-CsPersistentChatRoom Description Here}} - ### [Set-CsPersistentChatState](Set-CsPersistentChatState.md) -{{Manually Enter Set-CsPersistentChatState Description Here}} - ### [Set-CsPinPolicy](Set-CsPinPolicy.md) -{{Manually Enter Set-CsPinPolicy Description Here}} - +### [Set-CsPlatformServiceSettings](Set-CsPlatformServiceSettings.md) ### [Set-CsPresenceManagementState](Set-CsPresenceManagementState.md) -{{Manually Enter Set-CsPresenceManagementState Description Here}} - ### [Set-CsPresencePolicy](Set-CsPresencePolicy.md) -{{Manually Enter Set-CsPresencePolicy Description Here}} - ### [Set-CsPresenceProvider](Set-CsPresenceProvider.md) -{{Manually Enter Set-CsPresenceProvider Description Here}} - ### [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) -{{Manually Enter Set-CsPrivacyConfiguration Description Here}} - ### [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) -{{Manually Enter Set-CsProxyConfiguration Description Here}} - ### [Set-CsPstnGateway](Set-CsPstnGateway.md) -{{Manually Enter Set-CsPstnGateway Description Here}} - ### [Set-CsPstnUsage](Set-CsPstnUsage.md) -{{Manually Enter Set-CsPstnUsage Description Here}} - ### [Set-CsPublicProvider](Set-CsPublicProvider.md) -{{Manually Enter Set-CsPublicProvider Description Here}} - ### [Set-CsPushNotificationConfiguration](Set-CsPushNotificationConfiguration.md) -{{Manually Enter Set-CsPushNotificationConfiguration Description Here}} - ### [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) -{{Manually Enter Set-CsQoEConfiguration Description Here}} - ### [Set-CsRegistrar](Set-CsRegistrar.md) -{{Manually Enter Set-CsRegistrar Description Here}} - ### [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) -{{Manually Enter Set-CsRegistrarConfiguration Description Here}} - ### [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) -{{Manually Enter Set-CsReportingConfiguration Description Here}} - ### [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) -{{Manually Enter Set-CsRgsAgentGroup Description Here}} - ### [Set-CsRgsConfiguration](Set-CsRgsConfiguration.md) -{{Manually Enter Set-CsRgsConfiguration Description Here}} - ### [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) -{{Manually Enter Set-CsRgsHolidaySet Description Here}} - ### [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) -{{Manually Enter Set-CsRgsHoursOfBusiness Description Here}} - ### [Set-CsRgsQueue](Set-CsRgsQueue.md) -{{Manually Enter Set-CsRgsQueue Description Here}} - ### [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) -{{Manually Enter Set-CsRgsWorkflow Description Here}} - ### [Set-CsRoutingConfiguration](Set-CsRoutingConfiguration.md) -{{Manually Enter Set-CsRoutingConfiguration Description Here}} - ### [Set-CsServerApplication](Set-CsServerApplication.md) -{{Manually Enter Set-CsServerApplication Description Here}} - ### [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) -{{Manually Enter Set-CsSimpleUrlConfiguration Description Here}} - ### [Set-CsSipDomain](Set-CsSipDomain.md) -{{Manually Enter Set-CsSipDomain Description Here}} - ### [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) -{{Manually Enter Set-CsSipResponseCodeTranslationRule Description Here}} - ### [Set-CsSite](Set-CsSite.md) -{{Manually Enter Set-CsSite Description Here}} - ### [Set-CsSlaConfiguration](Set-CsSlaConfiguration.md) -{{Manually Enter Set-CsSlaConfiguration Description Here}} - ### [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) -{{Manually Enter Set-CsStaticRoutingConfiguration Description Here}} - ### [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) -{{Manually Enter Set-CsStorageServiceConfiguration Description Here}} - -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) -{{Manually Enter Set-CsTeamsMeetingPolicy Description Here}} - +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +### [Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) ### [Set-CsTelemetryConfiguration](Set-CsTelemetryConfiguration.md) -{{Manually Enter Set-CsTelemetryConfiguration Description Here}} - -### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) -{{Manually Enter Set-CsTenantDialPlan Description Here}} - -### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) -{{Manually Enter Set-CsTenantFederationConfiguration Description Here}} - ### [Set-CsTenantHybridConfiguration](Set-CsTenantHybridConfiguration.md) -{{Manually Enter Set-CsTenantHybridConfiguration Description Here}} - -### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) -{{Manually Enter Set-CsTenantMigrationConfiguration Description Here}} - -### [Set-CsTenantPublicProvider](Set-CsTenantPublicProvider.md) -{{Manually Enter Set-CsTenantPublicProvider Description Here}} - -### [Set-CsTenantUpdateTimeWindow](Set-CsTenantUpdateTimeWindow.md) -{{Manually Enter Set-CsTenantUpdateTimeWindow Description Here}} - ### [Set-CsTestDevice](Set-CsTestDevice.md) -{{Manually Enter Set-CsTestDevice Description Here}} - ### [Set-CsTestUserCredential](Set-CsTestUserCredential.md) -{{Manually Enter Set-CsTestUserCredential Description Here}} - ### [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) -{{Manually Enter Set-CsThirdPartyVideoSystem Description Here}} - ### [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Set-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Set-CsTrunkConfiguration](Set-CsTrunkConfiguration.md) -{{Manually Enter Set-CsTrunkConfiguration Description Here}} - ### [Set-CsTrustedApplication](Set-CsTrustedApplication.md) -{{Manually Enter Set-CsTrustedApplication Description Here}} - ### [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) -{{Manually Enter Set-CsTrustedApplicationEndpoint Description Here}} - ### [Set-CsTrustedApplicationPool](Set-CsTrustedApplicationPool.md) -{{Manually Enter Set-CsTrustedApplicationPool Description Here}} - ### [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) -{{Manually Enter Set-CsUCPhoneConfiguration Description Here}} - ### [Set-CsUICulture](Set-CsUICulture.md) -{{Manually Enter Set-CsUICulture Description Here}} - ### [Set-CsUnassignedNumber](Set-CsUnassignedNumber.md) -{{Manually Enter Set-CsUnassignedNumber Description Here}} - ### [Set-CsUser](Set-CsUser.md) -{{Manually Enter Set-CsUser Description Here}} - ### [Set-CsUserAcp](Set-CsUserAcp.md) -{{Manually Enter Set-CsUserAcp Description Here}} - +### [Set-CsUserCallForwardingSettings](Set-CsUserCallForwardingSettings.md) ### [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) -{{Manually Enter Set-CsUserDatabaseState Description Here}} - -### [Set-CsUserPstnSettings](Set-CsUserPstnSettings.md) -{{Manually Enter Set-CsUserPstnSettings Description Here}} - +### [Set-CsUserDelegates](Set-CsUserDelegates.md) ### [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) -{{Manually Enter Set-CsUserReplicatorConfiguration Description Here}} - ### [Set-CsUserServer](Set-CsUserServer.md) -{{Manually Enter Set-CsUserServer Description Here}} - ### [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) -{{Manually Enter Set-CsUserServicesConfiguration Description Here}} - ### [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) -{{Manually Enter Set-CsUserServicesPolicy Description Here}} - +### [Set-CsUserTeamMembers](Set-CsUserTeamMembers.md) ### [Set-CsVideoGateway](Set-CsVideoGateway.md) -{{Manually Enter Set-CsVideoGateway Description Here}} - ### [Set-CsVideoInteropServer](Set-CsVideoInteropServer.md) -{{Manually Enter Set-CsVideoInteropServer Description Here}} - ### [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) -{{Manually Enter Set-CsVideoInteropServerConfiguration Description Here}} - ### [Set-CsVideoInteropServerSyntheticTransactionConfiguration](Set-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter Set-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) -{{Manually Enter Set-CsVideoTrunkConfiguration Description Here}} - ### [Set-CsVoiceConfiguration](Set-CsVoiceConfiguration.md) -{{Manually Enter Set-CsVoiceConfiguration Description Here}} - ### [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) -{{Manually Enter Set-CsVoicemailReroutingConfiguration Description Here}} - ### [Set-CsVoiceNormalizationRule](Set-CsVoiceNormalizationRule.md) -{{Manually Enter Set-CsVoiceNormalizationRule Description Here}} - ### [Set-CsVoicePolicy](Set-CsVoicePolicy.md) -{{Manually Enter Set-CsVoicePolicy Description Here}} - ### [Set-CsVoiceRoute](Set-CsVoiceRoute.md) -{{Manually Enter Set-CsVoiceRoute Description Here}} - ### [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) -{{Manually Enter Set-CsVoiceRoutingPolicy Description Here}} - ### [Set-CsVoiceTestConfiguration](Set-CsVoiceTestConfiguration.md) -{{Manually Enter Set-CsVoiceTestConfiguration Description Here}} - ### [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) -{{Manually Enter Set-CsWatcherNodeConfiguration Description Here}} - ### [Set-CsWebServer](Set-CsWebServer.md) -{{Manually Enter Set-CsWebServer Description Here}} - ### [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) -{{Manually Enter Set-CsWebServiceConfiguration Description Here}} - ### [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) -{{Manually Enter Set-CsXmppAllowedPartner Description Here}} - ### [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) -{{Manually Enter Set-CsXmppGatewayConfiguration Description Here}} - ### [Show-CsClsLogging](Show-CsClsLogging.md) -{{Manually Enter Show-CsClsLogging Description Here}} - +### [skype](skype.md) ### [Start-CsClsLogging](Start-CsClsLogging.md) -{{Manually Enter Start-CsClsLogging Description Here}} - -### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) -{{Manually Enter Start-CsExMeetingMigration Description Here}} - ### [Start-CsPool](Start-CsPool.md) -{{Manually Enter Start-CsPool Description Here}} - ### [Start-CsWindowsService](Start-CsWindowsService.md) -{{Manually Enter Start-CsWindowsService Description Here}} - ### [Stop-CsClsLogging](Stop-CsClsLogging.md) -{{Manually Enter Stop-CsClsLogging Description Here}} - ### [Stop-CsWindowsService](Stop-CsWindowsService.md) -{{Manually Enter Stop-CsWindowsService Description Here}} - ### [Sync-CsClsLogging](Sync-CsClsLogging.md) -{{Manually Enter Sync-CsClsLogging Description Here}} - ### [Sync-CsUserData](Sync-CsUserData.md) -{{Manually Enter Sync-CsUserData Description Here}} - ### [Test-CsAddressBookService](Test-CsAddressBookService.md) -{{Manually Enter Test-CsAddressBookService Description Here}} - ### [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) -{{Manually Enter Test-CsAddressBookWebQuery Description Here}} - ### [Test-CsASConference](Test-CsASConference.md) -{{Manually Enter Test-CsASConference Description Here}} - ### [Test-CsAudioConferencingProvider](Test-CsAudioConferencingProvider.md) -{{Manually Enter Test-CsAudioConferencingProvider Description Here}} - ### [Test-CsAVConference](Test-CsAVConference.md) -{{Manually Enter Test-CsAVConference Description Here}} - ### [Test-CsAVEdgeConnectivity](Test-CsAVEdgeConnectivity.md) -{{Manually Enter Test-CsAVEdgeConnectivity Description Here}} - ### [Test-CsCertificateConfiguration](Test-CsCertificateConfiguration.md) -{{Manually Enter Test-CsCertificateConfiguration Description Here}} - ### [Test-CsClientAuth](Test-CsClientAuth.md) -{{Manually Enter Test-CsClientAuth Description Here}} - ### [Test-CsClientAuthentication](Test-CsClientAuthentication.md) -{{Manually Enter Test-CsClientAuthentication Description Here}} - ### [Test-CsComputer](Test-CsComputer.md) -{{Manually Enter Test-CsComputer Description Here}} - ### [Test-CsDatabase](Test-CsDatabase.md) -{{Manually Enter Test-CsDatabase Description Here}} - ### [Test-CsDataConference](Test-CsDataConference.md) -{{Manually Enter Test-CsDataConference Description Here}} - ### [Test-CsDialInConferencing](Test-CsDialInConferencing.md) -{{Manually Enter Test-CsDialInConferencing Description Here}} - ### [Test-CsDialPlan](Test-CsDialPlan.md) -{{Manually Enter Test-CsDialPlan Description Here}} - -### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) -{{Manually Enter Test-CsEffectiveTenantDialPlan Description Here}} - ### [Test-CsExStorageConnectivity](Test-CsExStorageConnectivity.md) -{{Manually Enter Test-CsExStorageConnectivity Description Here}} - ### [Test-CsExStorageNotification](Test-CsExStorageNotification.md) -{{Manually Enter Test-CsExStorageNotification Description Here}} - ### [Test-CsExUMConnectivity](Test-CsExUMConnectivity.md) -{{Manually Enter Test-CsExUMConnectivity Description Here}} - ### [Test-CsExUMVoiceMail](Test-CsExUMVoiceMail.md) -{{Manually Enter Test-CsExUMVoiceMail Description Here}} - ### [Test-CsFederatedPartner](Test-CsFederatedPartner.md) -{{Manually Enter Test-CsFederatedPartner Description Here}} - ### [Test-CsGroupExpansion](Test-CsGroupExpansion.md) -{{Manually Enter Test-CsGroupExpansion Description Here}} - ### [Test-CsGroupIM](Test-CsGroupIM.md) -{{Manually Enter Test-CsGroupIM Description Here}} - ### [Test-CsIM](Test-CsIM.md) -{{Manually Enter Test-CsIM Description Here}} - ### [Test-CsInterTrunkRouting](Test-CsInterTrunkRouting.md) -{{Manually Enter Test-CsInterTrunkRouting Description Here}} - ### [Test-CsKerberosAccountAssignment](Test-CsKerberosAccountAssignment.md) -{{Manually Enter Test-CsKerberosAccountAssignment Description Here}} - ### [Test-CsLisCivicAddress](Test-CsLisCivicAddress.md) -{{Manually Enter Test-CsLisCivicAddress Description Here}} - ### [Test-CsLisConfiguration](Test-CsLisConfiguration.md) -{{Manually Enter Test-CsLisConfiguration Description Here}} - ### [Test-CsLocationPolicy](Test-CsLocationPolicy.md) -{{Manually Enter Test-CsLocationPolicy Description Here}} - ### [Test-CsManagementServer](Test-CsManagementServer.md) -{{Manually Enter Test-CsManagementServer Description Here}} - ### [Test-CsMcxConference](Test-CsMcxConference.md) -{{Manually Enter Test-CsMcxConference Description Here}} - ### [Test-CsMcxP2PIM](Test-CsMcxP2PIM.md) -{{Manually Enter Test-CsMcxP2PIM Description Here}} - ### [Test-CsMcxPushNotification](Test-CsMcxPushNotification.md) -{{Manually Enter Test-CsMcxPushNotification Description Here}} - ### [Test-CsOnlineCarrierPortabilityIn](Test-CsOnlineCarrierPortabilityIn.md) -{{Manually Enter Test-CsOnlineCarrierPortabilityIn Description Here}} - ### [Test-CsOnlineLisCivicAddress](Test-CsOnlineLisCivicAddress.md) -{{Manually Enter Test-CsOnlineLisCivicAddress Description Here}} - ### [Test-CsOnlinePortabilityIn](Test-CsOnlinePortabilityIn.md) -{{Manually Enter Test-CsOnlinePortabilityIn Description Here}} - ### [Test-CsOUPermission](Test-CsOUPermission.md) -{{Manually Enter Test-CsOUPermission Description Here}} - ### [Test-CsP2PAV](Test-CsP2PAV.md) -{{Manually Enter Test-CsP2PAV Description Here}} - ### [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) -{{Manually Enter Test-CsP2PVideoInteropServerSipTrunkAV Description Here}} - ### [Test-CsPersistentChatMessage](Test-CsPersistentChatMessage.md) -{{Manually Enter Test-CsPersistentChatMessage Description Here}} - ### [Test-CsPhoneBootstrap](Test-CsPhoneBootstrap.md) -{{Manually Enter Test-CsPhoneBootstrap Description Here}} - ### [Test-CsPresence](Test-CsPresence.md) -{{Manually Enter Test-CsPresence Description Here}} - ### [Test-CsPstnOutboundCall](Test-CsPstnOutboundCall.md) -{{Manually Enter Test-CsPstnOutboundCall Description Here}} - ### [Test-CsPstnPeerToPeerCall](Test-CsPstnPeerToPeerCall.md) -{{Manually Enter Test-CsPstnPeerToPeerCall Description Here}} - ### [Test-CsRegistration](Test-CsRegistration.md) -{{Manually Enter Test-CsRegistration Description Here}} - ### [Test-CsReplica](Test-CsReplica.md) -{{Manually Enter Test-CsReplica Description Here}} - ### [Test-CsSetupPermission](Test-CsSetupPermission.md) -{{Manually Enter Test-CsSetupPermission Description Here}} - ### [Test-CsTopology](Test-CsTopology.md) -{{Manually Enter Test-CsTopology Description Here}} - ### [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) -{{Manually Enter Test-CsTrunkConfiguration Description Here}} - ### [Test-CsUcwaConference](Test-CsUcwaConference.md) -{{Manually Enter Test-CsUcwaConference Description Here}} - ### [Test-CsUnifiedContactStore](Test-CsUnifiedContactStore.md) -{{Manually Enter Test-CsUnifiedContactStore Description Here}} - ### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) -{{Manually Enter Test-CsVoiceNormalizationRule Description Here}} - ### [Test-CsVoicePolicy](Test-CsVoicePolicy.md) -{{Manually Enter Test-CsVoicePolicy Description Here}} - ### [Test-CsVoiceRoute](Test-CsVoiceRoute.md) -{{Manually Enter Test-CsVoiceRoute Description Here}} - ### [Test-CsVoiceTestConfiguration](Test-CsVoiceTestConfiguration.md) -{{Manually Enter Test-CsVoiceTestConfiguration Description Here}} - ### [Test-CsVoiceUser](Test-CsVoiceUser.md) -{{Manually Enter Test-CsVoiceUser Description Here}} - ### [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) -{{Manually Enter Test-CsWatcherNodeConfiguration Description Here}} - ### [Test-CsWebApp](Test-CsWebApp.md) -{{Manually Enter Test-CsWebApp Description Here}} - ### [Test-CsWebAppAnonymous](Test-CsWebAppAnonymous.md) -{{Manually Enter Test-CsWebAppAnonymous Description Here}} - ### [Test-CsWebScheduler](Test-CsWebScheduler.md) -{{Manually Enter Test-CsWebScheduler Description Here}} - ### [Test-CsXmppIM](Test-CsXmppIM.md) -{{Manually Enter Test-CsXmppIM Description Here}} - ### [Uninstall-CsDatabase](Uninstall-CsDatabase.md) -{{Manually Enter Uninstall-CsDatabase Description Here}} - ### [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) -{{Manually Enter Uninstall-CsMirrorDatabase Description Here}} - ### [Unlock-CsClientPin](Unlock-CsClientPin.md) -{{Manually Enter Unlock-CsClientPin Description Here}} - ### [Unpublish-CsLisConfiguration](Unpublish-CsLisConfiguration.md) -{{Manually Enter Unpublish-CsLisConfiguration Description Here}} - -### [Unregister-CsHybridPSTNAppliance](Unregister-CsHybridPSTNAppliance.md) -{{Manually Enter Unregister-CsHybridPSTNAppliance Description Here}} - -### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Unregister-CsOnlineDialInConferencingServiceNumber Description Here}} - ### [Update-CsAddressBook](Update-CsAddressBook.md) -{{Manually Enter Update-CsAddressBook Description Here}} - ### [Update-CsAdminRole](Update-CsAdminRole.md) -{{Manually Enter Update-CsAdminRole Description Here}} - ### [Update-CsClsLogging](Update-CsClsLogging.md) -{{Manually Enter Update-CsClsLogging Description Here}} - -### [Update-CsOrganizationalAutoAttendant](Update-CsOrganizationalAutoAttendant.md) -{{Manually Enter Update-CsOrganizationalAutoAttendant Description Here}} - -### [Update-CsTenantMeetingUrl](Update-CsTenantMeetingUrl.md) -{{Manually Enter Update-CsTenantMeetingUrl Description Here}} - ### [Update-CsUserData](Update-CsUserData.md) -{{Manually Enter Update-CsUserData Description Here}} - ### [Update-CsUserDatabase](Update-CsUserDatabase.md) -{{Manually Enter Update-CsUserDatabase Description Here}} - -### [Get-CsTeamsInteropPolicy](Get-CsTeamsInteropPolicy.md) -{{Manually Enter Get-CsTeamsInteropPolicy Description Here}} - -### [Grant-CsTeamsInteropPolicy](Grant-CsTeamsInteropPolicy.md) -{{Manually Enter Grant-CsTeamsInteropPolicy Description Here}} - -### [Remove-CsTeamsInteropPolicy](Remove-CsTeamsInteropPolicy.md) -{{Manually Enter Remove-CsTeamsInteropPolicy Description Here}} - -### [Set-CsPlatformServiceSettings](Set-CsPlatformServiceSettings.md) -{{Manually Enter Set-CsPlatformServiceSettings Description Here}} - -### [Get-CsPlatformServiceSettings](Get-CsPlatformServiceSettings.md) -{{Manually Enter Get-CsPlatformServiceSettings Description Here}} - -### [New-CsPlatformServiceSettings](New-CsPlatformServiceSettings.md) -{{Manually Enter New-CsPlatformServiceSettings Description Here}} - -### [Remove-CsPlatformServiceSettings](Remove-CsPlatformServiceSettings.md) -{{Manually Enter Remove-CsPlatformServiceSettings Description Here}} - -### [Get-CsAdditionalInternalDomain](Get-CsAdditionalInternalDomain.md) -{{Manually Enter Get-CsAdditionalInternalDomain Description Here}} - -### [New-CsAdditionalInternalDomain](New-CsAdditionalInternalDomain.md) -{{Manually Enter New-CsAdditionalInternalDomain Description Here}} - -### [Remove-CsAdditionalInternalDomain](Remove-CsAdditionalInternalDomain.md) -{{Manually Enter Remove-CsAdditionalInternalDomain Description Here}} - -### [Get-CsHybridApplicationEndpoint](Get-CsHybridApplicationEndpoint.md) -{{Manually Enter Get-CsHybridApplicationEndpoint Description Here}} - -### [New-CsHybridApplicationEndpoint](New-CsHybridApplicationEndpoint.md) -{{Manually Enter New-CsHybridApplicationEndpoint Description Here}} - -### [Set-CsHybridApplicationEndpoint](Set-CsHybridApplicationEndpoint.md) -{{Manually Enter Set-CsHybridApplicationEndpoint Description Here}} - -### [Remove-CsHybridApplicationEndpoint](Remove-CsHybridApplicationEndpoint.md) -{{Manually Enter Remove-CsHybridApplicationEndpoint Description Here}} - -### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) - -### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) - -### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) - -### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) - -### [New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) - -### [Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) - -### [Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) - -### [Get-CsCloudCallDataConnector](Get-CsCloudCallDataConnector.md) - -### [Get-CsCloudCallDataConnectorConfiguration](Get-CsCloudCallDataConnectorConfiguration.md) - -### [New-CsCloudCallDataConnectorConfiguration](New-CsCloudCallDataConnectorConfiguration.md) - -### [Set-CsCloudCallDataConnector](Set-CsCloudCallDataConnector.md) - -### [Set-CsCloudCallDataConnectorConfiguration](Set-CsCloudCallDataConnectorConfiguration.md) - -### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) - -### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) - -### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) - -### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) - -### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) - -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) - -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) - -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) - -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) - -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) - -### [Set-CsAuthConfig](Set-CsAuthConfig.md) - -### [Get-CsAuthConfig](Get-CsAuthConfig.md) - -### [Get-CsOnlineSipDomains](Get-CsOnlineSipDomains.md) - -### [Enable-CsOnlineSipDomains](Enable-CsOnlineSipDomains.md) - -### [Disable-CsOnlineSipDomains](Disable-CsOnlineSipDomains.md) diff --git a/spmt/docfx.json b/spmt/docfx.json index e81deb8333..44cc42e8b1 100644 --- a/spmt/docfx.json +++ b/spmt/docfx.json @@ -2,7 +2,9 @@ "build": { "content": [ { - "files": ["**/*.md"], + "files": [ + "**/*.md" + ], "src": "docs-conceptual", "version": "spmt-ps", "dest": "spmt", @@ -12,26 +14,37 @@ "README.md", "LICENSE", "LICENSE-CODE", - "ThirdPartyNotices"] + "ThirdPartyNotices" + ] }, { - "files": ["toc.yml"], + "files": [ + "toc.yml" + ], "src": "docs-conceptual", "version": "spmt-ps", "dest": "spmt/spmt-ps" }, { - "files": ["**/*.md"], - "src": "spmt-ps", - "version": "spmt-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "spmt-ps", - "version": "spmt-ps", - "dest": "module/spmt-ps" - } + "files": [ + "**/*.yml", + "**/spmt.md" + ], + "exclude": [ + "toc.yml" + ], + "src": "spmt-ps", + "version": "spmt-ps", + "dest": "module" + }, + { + "files": [ + "toc.yml" + ], + "src": "spmt-ps", + "version": "spmt-ps", + "dest": "module/spmt-ps" + } ], "resource": [ { @@ -53,18 +66,22 @@ "overwrite": [], "externalReference": [], "globalMetadata": { - "author" : "kenwith", - "ms.author" : "kenwith", - "manager" : "serdars", - "ms.topic" : "reference", - "ms.service" : "spmt-powershell", - "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "uhfHeaderId": "MSDocsHeader-M365-IT", + "author": "serdarsoysal", + "ms.author": "serdars", + "manager": "serdars", + "ms.topic": "reference", + "ms.service": "spmt-powershell", + "products": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/9d7be3ef-f27c-4c7f-9eba-67c3cd429995", + "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" + ], + "ms.devlang": "powershell", + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": {}, "template": [], "dest": "spmt-ps" } -} \ No newline at end of file +} diff --git a/spmt/docs-conceptual/index.md b/spmt/docs-conceptual/index.md index 4b4800be11..520cbb77ca 100644 --- a/spmt/docs-conceptual/index.md +++ b/spmt/docs-conceptual/index.md @@ -1,11 +1,14 @@ --- -localization_priority: Normal +ms.localizationpriority: medium +title: Microsoft SharePoint Migration Tool cmdlet help reference +ms.date: 01/01/2020 +description: "Learn about the Microsoft SharePoint Migration Tool PowerShell cmdlet help reference." --- -#Microsoft SharePoint Migration Tool cmdlet reference +# Microsoft SharePoint Migration Tool cmdlet help reference -Welcome to the Microsoft SharePoint Migration Tool PowerShell cmdlet help references. The Microsoft SharePoint Migration Tool cmdlets provide the command line interface for service administration and management. +Welcome to the Microsoft SharePoint Migration Tool PowerShell cmdlet **Help** reference. The Microsoft SharePoint Migration Tool cmdlets provide the command line interface for service administration and management. -Here you will find all of the Microsoft SharePoint Migration Tool PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here, you will find all of the Microsoft SharePoint Migration Tool PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. \ No newline at end of file +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. diff --git a/spmt/docs-conceptual/intro.md b/spmt/docs-conceptual/intro.md index 7caa898177..7d2f08a7ba 100644 --- a/spmt/docs-conceptual/intro.md +++ b/spmt/docs-conceptual/intro.md @@ -1,13 +1,16 @@ --- -localization_priority: Normal +ms.localizationpriority: medium +title: Microsoft SharePoint Migration Tool cmdlet reference +ms.date: 01/01/2020 +description: "Learn about Microsoft SharePoint Migration Tool cmdlets." --- -#Microsoft SharePoint Migration Tool cmdlet reference +# Microsoft SharePoint Migration Tool cmdlet reference Welcome to the Microsoft SharePoint Migration Tool PowerShell cmdlet help references. The Microsoft SharePoint Migration Tool cmdlets provide the command line interface for service administration and management. -Here you will find all of the Microsoft SharePoint Migration Tool PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here you will find all of the Microsoft SharePoint Migration Tool PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. -To find other modules you can use the PowerShell Module Browser located at: https://docs.microsoft.com/en-us/powershell/module. For example, to see the SharePoint modules you could use this query: https://docs.microsoft.com/en-us/powershell/module/?term=sharepoint. +To find other modules you can use the PowerShell Module Browser located at: `https://learn.microsoft.com/powershell/module`. For example, to see the SharePoint modules you could use this query: `https://learn.microsoft.com/powershell/module/?term=sharepoint`. diff --git a/spmt/docs-conceptual/overview.md b/spmt/docs-conceptual/overview.md index c7ef055789..d9f557df03 100644 --- a/spmt/docs-conceptual/overview.md +++ b/spmt/docs-conceptual/overview.md @@ -1,3 +1,9 @@ -#My overview +--- +title: My overview +ms.date: 01/01/2020 +description: "Microsoft SharePoint Migration Tool cmdlet reference." +--- + +# My overview This is an overview page \ No newline at end of file diff --git a/spmt/mapping/monikerMapping.json b/spmt/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from spmt/mapping/monikerMapping.json rename to spmt/mapping/MAML2Yaml/monikerMapping.json diff --git a/spmt/spmt-ps/spmt/Add-SPMTTask.md b/spmt/spmt-ps/spmt/Add-SPMTTask.md index 244f281881..eb66f4701b 100644 --- a/spmt/spmt-ps/spmt/Add-SPMTTask.md +++ b/spmt/spmt-ps/spmt/Add-SPMTTask.md @@ -1,105 +1,51 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Add-SPMTTask -Online version: -Schema: 2.0.0 +online version: https://learn.microsoft.com/powershell/module/spmt/add-spmttask +applicable: SharePoint Migration Tool +title: Add-SPMTTask +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +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. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task. + ## SYNTAX ### FileShare -``` +```powershell Add-SPMTTask -FileShareSource <String> -TargetSiteUrl <String> -TargetList <String> [-TargetListRelativePath <String>] ``` + ### SharePointMigrateAll -``` -Add-SPMTTask -SharePointSourceCredential <PSCredential> -SharePointSourceSiteUrl <string> -TargetSiteUrl <string> -MigrateAll +```powershell +Add-SPMTTask -SharePointSourceCredential <PSCredential> -SharePointSourceSiteUrl <string> -TargetSiteUrl <string> -MigrateAll ``` ### SharePointMigrateSelected -``` +```powershell Add-SPMTTask -SharePointSourceSiteUrl <string> -SharePointSourceCredential <PSCredential> -SourceList <string> [-SourceListRelativePath <string>] -TargetSiteUrl <string> -TargetList <string> [-TargetListRelativePath <string>] ``` ### Json +```powershell +Add-SPMTTask [-SharePointSourceCredential <PSCredential>] -JsonDefinition <String> [<CommonParameters>] ``` -Add-SPMTTask [-JsonDefinition <string>] # This cmdlet is for File Share migration - -Add-SPMTTask -SharePointSourceCredential <PSCredential> [-JsonDefinition <string>] # This cmdlet is for SharePoint migration -Json sample for File Share migration: -{ - "SourcePath":"\\LocalOrFileShareDataSource", - "TargetPath":"https://yourtargetsite/", - "TargetList":"Documents", - "TargetListRelativePath":"subfolder" -} - -Json sample for SharePoint migration(lists only): -{ - "SourcePath":"http://youronpremsite/", - "TargetPath":"https://yourtargetsite/", - "Items":{ - "Lists":[ - { - "SourceList":"sourceListName", - "TargetList":"targetListName" - } - ] - } -} - -Json sample for SharePoint migration(lists and subsites): -{ - "SourcePath":"http://youronpremsite/", - "TargetPath":"https://yourtargetsite/", - "Items":{ - "Lists":[ - { - "SourceList":"listVersion2", - "TargetList":"ListVersion2" - }, - { - "SourceList":"listVersion3", - "TargetList":"ListVersion3" - } - ], - "SubSites":[ - { - "SourceSubSitePath":"subSite", - "TargetSubSitePath":"targetSubSite", - "Lists":[ - { - "SourceList":"testSubListB", - "TargetList":"targetSubList" - } - ] - } - ] - } -} - -Json sample for SharePoint migration(whole site): -{ - "SourcePath":"http://youronpremsite/subsite2", - "TargetPath":"https://yourtargetsite/targetSubSite2" -} -``` ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$Global:SourceSiteUrl = "https://youronpremsite/" $Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$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" @@ -118,51 +64,51 @@ $Global:FileshareSource = "YourFileShareDataSource" Import-Module Microsoft.SharePoint.MigrationTool.PowerShell #Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force +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 -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName ``` -Add one File Share migration task and one SharePoint 2013 migration task to the registered migration session. +This example adds one File Share migration task and one SharePoint 2013 migration task to the registered migration session. + +### EXAMPLE 2 -### 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. +```powershell -### Example 2 -Code snippets for bulk migration by loading the sample CSV with the name of spmt.csv: +# Code snippets for bulk migration by loading the sample CSV with the name of spmt.csv -### Load 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 - } + } + +# Two migration tasks are defined in the file spmt.csv -Two migration tasks are defined in the file of 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 -Code snippets for bulk migration by loading one JSON file: - -### Load JSON - $jsonItems = Get-Content -Raw -Path "C:\spmt.json" | ConvertFrom-Json +# 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 - } - -Three migration tasks are defined in the file of spmt.json. + Add-SPMTTask -JsonDefinition $jsonString -SharePointSourceCredential $onpremCredential + } + +# Three migration tasks are defined in the file spmt.json. + -``` { "Tasks":[ { - "SourcePath":"http://on-prem/sites/test", + "SourcePath":"https://on-prem/sites/test", "TargetPath":"https://yourspo.sharepoint.com/", "Items":{ "Lists":[ @@ -177,7 +123,7 @@ Three migration tasks are defined in the file of spmt.json. } }, { - "SourcePath":"http://on-prem/sites/test", + "SourcePath":"https://on-prem/sites/test", "TargetPath":"https://yourspo.sharepoint.com/", "Items":{ "Lists":[ @@ -192,7 +138,7 @@ Three migration tasks are defined in the file of spmt.json. } }, { - "SourcePath":"http://on-prem/sites/test", + "SourcePath":"https://on-prem/sites/test", "TargetPath":"https://yourspo.sharepoint.com/", "Items":{ "Lists":[ @@ -208,8 +154,110 @@ Three migration tasks are defined in the file of spmt.json. } ] } +``` +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 +``` +{ + "SourcePath":"\\LocalOrFileShareDataSource", + "TargetPath":"https://yourtargetsite/", + "TargetList":"Documents", + "TargetListRelativePath":"subfolder" +} + +Json sample for SharePoint migration(lists only): +{ + "SourcePath":"https://youronpremsite/", + "TargetPath":"https://yourtargetsite/", + "Items":{ + "Lists":[ + { + "SourceList":"sourceListName", + "TargetList":"targetListName" + } + ] + } +} + +Json sample for SharePoint migration(lists and subsites): +{ + "SourcePath":"https://youronpremsite/", + "TargetPath":"https://yourtargetsite/", + "Items":{ + "Lists":[ + { + "SourceList":"listVersion2", + "TargetList":"ListVersion2" + }, + { + "SourceList":"listVersion3", + "TargetList":"ListVersion3" + } + ], + "SubSites":[ + { + "SourceSubSitePath":"subSite", + "TargetSubSitePath":"targetSubSite", + "Lists":[ + { + "SourceList":"testSubListB", + "TargetList":"targetSubList" + } + ] + } + ] + } +} + +Json sample for SharePoint migration(whole site): +{ + "SourcePath":"https://youronpremsite/subsite2", + "TargetPath":"https://yourtargetsite/targetSubSite2" +} +Json sample with task level setting: +{ + "Tasks": [ + { + "SourcePath": "https://youronpremserversiteurl/", + "TargetPath": "https://yourtargetsiteurl/", + "Items": { + "Lists": [ + { + "SourceList": "SourceListName", + "TargetList": "TargetListName" + } + ], + "SubSites": [] + }, + "Settings": { + "MigrateFileVersionHistory": true, + "KeepFileVersions": 100, + "MigrateHiddenItems": false, + "MigrateItemsCreatedAfter": "yyyy-MM-dd", + "MigrateItemsModifiedAfter": "yyyy-MM-dd", + "SkipFilesWithExtensions": "txt:mp3:OtherFileExtentionsYouwantSkip", + "EnableAzureDirectoryLookup": false, + "PreservePermission": true, + "UseCustomAzureStorage": false, + "CustomAzureStorageAccount": null, + "CustomAzureAccessKey": null, + "CustomAzureDeletionAfterMig": false, + "UserMappingCSVFile": null, + "SkipListWithAudienceEnabled": true, + "EnableIncremental": false, + "MigrateOneNoteNotebook": true, + "MigrateAllWebStructures": false, + "FilterOutPathSpecialCharacters": false + } + } + ] +} +Note: Datetime format is "yyyy-MM-dd" ``` +This is a Json sample for File Share migration. ## PARAMETERS @@ -219,11 +267,11 @@ This parameter is mandatory for File Share migration. Please specify the source ```yaml Type: String Parameter Sets: FileShare -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -234,23 +282,25 @@ Define one File share task or SharePoint task in JSON format. ```yaml Type: String Parameter Sets: Json -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: None Accept pipeline input: False 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 Parameter Sets: SharePointMigrateAll -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: False Position: Named Default value: False @@ -258,27 +308,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharePointSourceCredential -Use this parameter to define SharePoint 2013 sign-in credentials. +### -SharePointSourceCredential +Use this parameter to define SharePoint 2013 sign-in credentials. ```yaml Type: PSCredential -Parameter Sets: SharePointMigrateAll, SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Parameter Sets: SharePointMigrateAll, SharePointMigrateSelected, Json +Aliases: -```yaml -Type: PSCredential -Parameter Sets: Json -Aliases: -applicable: SharePoint Migration Tool -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -291,11 +329,11 @@ Use this parameter to define SharePoint data source site URL. ```yaml Type: String Parameter Sets: SharePointMigrateAll, SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -306,26 +344,26 @@ This parameter is mandatory and is to define source document library name or lis ```yaml Type: String Parameter Sets: SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -SourceListRelativePath -This parameter is optional and is to define data source relative path. +This parameter is optional and is to define data source relative path. ```yaml Type: String Parameter Sets: SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: False Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -336,25 +374,26 @@ This parameter is mandatory and is to define target library name or list name. ```yaml Type: String Parameter Sets: FileShare, SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TargetListRelativePath -This parameter is optional and is to define target relative path. +This parameter is optional and is to define target relative path. + ```yaml Type: String Parameter Sets: FileShare, SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: False Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -365,24 +404,22 @@ This parameter is mandatory for both File Share and SharePoint migration and is ```yaml Type: String Parameter Sets: FileShare, SharePointMigrateAll, SharePointMigrateSelected -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -## INPUTS - -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 diff --git a/spmt/spmt-ps/spmt/Get-SPMTMigration.md b/spmt/spmt-ps/spmt/Get-SPMTMigration.md index a95ae0a655..1e4b20d6a6 100644 --- a/spmt/spmt-ps/spmt/Get-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Get-SPMTMigration.md @@ -1,39 +1,44 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Get-SPMTMigration -Online version: -Schema: 2.0.0 +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 +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 -``` -Get-SPMTMigration +```powershell +Get-SPMTMigration [<CommonParameters>] ``` ## DESCRIPTION -Return object of current session. It includes current tasks status and current session level settings. +Return object of current session. +It includes current tasks status and current session level settings. + ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$Global:SourceSiteUrl = "https://youronpremsite/" $Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$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" @@ -52,33 +57,30 @@ $Global:FileshareSource = "YourFileShareDataSource" Import-Module Microsoft.SharePoint.MigrationTool.PowerShell #Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force +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 -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 +$session = Get-SPMTMigration ``` -Start a migration first, and then run "Get-SPMTMigration" to get the object of current migration. -## PARAMETERS +This example starts a migration first, and then run "Get-SPMTMigration" to get the object of current migration. -## INPUTS +## PARAMETERS -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 - - diff --git a/spmt/spmt-ps/spmt/Register-SPMTMigration.md b/spmt/spmt-ps/spmt/Register-SPMTMigration.md index 25a4cbd769..f092abf2ef 100644 --- a/spmt/spmt-ps/spmt/Register-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Register-SPMTMigration.md @@ -1,31 +1,35 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Register-SPMTMigration -Online version: -Schema: 2.0.0 +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. +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 -``` -Register-SPMTMigration [-Credentials <PSCredential>][-Incremental <bool>] [-ScanOnly <bool>][-MigrateFilesAndFoldersWithInvalidChars <bool>][-AzureActiveDirectoryLookup <bool>] [-CustomAzureAccessKey <string>] [-CustomAzureStorageAccount <bool>] [-DeleteTempFilesWhenMigrationDone <bool>] [-EnableEncryption <bool>] [-KeepAllVersions <bool>] [-MigrateFileVersionHistory <bool>] [-MigrateOneNoteFolderAsOneNoteNoteBook <bool>] [-MigrateFilesCreatedAfter <DateTime>] [-MigrateFilesModifiedAfter <DateTime>] [-SkipFilesWithExtensions <string>] [-MigrateHiddenFiles <bool>] [-NumberOfVersionToKeep <int>] [-PreserveUserPermissionsForFileShare <bool>] [-PreserveUserPermissionsForForSharePointSource <bool>][-SkipListWithAudienceTargetingEnabled <bool>] [-StartMigrationAutomaticallyWhenNoScanIssue <bool>] [-UseCustomAzureStorage <bool>] [-UserMappingFile <string>][-MigrateAllSiteFieldsAndContentTypes<bool>][-WorkingFolder <string>]-Force +```powershell +Register-SPMTMigration [-SPOCredentials<PSCredential>] [-EnableMultiRound <bool>] [-ScanOnly <bool>] [-AzureActiveDirectoryLookup <bool>] [-CustomAzureAccessKey <string>] [-CustomAzureStorageAccount <bool>] [-DeleteTempFilesWhenMigrationDone <bool>] [-EnableEncryption <bool>] [-IgnoreUpdate <SwitchParameter>] [-KeepAllVersions <bool>] [-MigrateFileVersionHistory <bool>] [-MigrateOneNoteFolderAsOneNoteNoteBook <bool>] [-MigrateFilesCreatedAfter <DateTime>] [-MigrateFilesModifiedAfter <DateTime>] [-SkipFilesWithExtension <string>] [-IncludeHiddenFiles <bool>] [-NumberOfVersionToMigrate <int>] [-PreserveUserPermissionsForFileShare <bool>] [-PreserveUserPermissionsForSharePointSource <bool>] [-SkipListWithAudienceTargetingEnabled <bool>] [-StartMigrationAutomaticallyWhenNoScanIssue <bool>] [-UseCustomAzureStorage <bool>] [-UserMappingFile <string>] [-MigrateAllSiteFieldsAndContentTypes<bool>] [-WorkingFolder <string>] [-SkipSitesWithName <string>] [-SkipListsWithName <string>] [-SkipContentTypesWithName <string>] [-DuplicatePageBehavior <string>] [-MigrateNavigation <string>] [-MigrateTermGroups <string>] [-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. +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 -### Create a migration session and connecting to SPO. -``` +### EXAMPLE 1 +```powershell #Define SPO target# $Global:SPOUrl = "https://contoso.sharepoint.com/" $Global:UserName = "admin@contoso.onmicrosoft.com" @@ -39,93 +43,108 @@ Import-Module Microsoft.SharePoint.MigrationTool.PowerShell Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force ``` -Create a migration session. +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 Azure Active Directory is used as the default for user mapping. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: Empty +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: Empty +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: False +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Force -Forcibly stop and unregister existing migration. -If you have never run “Register-SPMTMigration”, with or without the Force parameter, a new session will be created. -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 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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named Default value: False @@ -133,172 +152,199 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Incremental -The default setting is On. This lets you rerun the migration with same source and target at a later date, migrating only the changes or additions since the previous run. -Important: If you wish to be able to submit the same job again for incremental migration, this setting must be set to On * before* the initial migration job is submitted. +### -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: Boolean -Parameter Sets: -Aliases: -applicable: SharePoint Migration Tool +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +Default value: False 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. +### -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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateFileVersionHistory -If set to Off, only the most recent versions of the file will be migrated. If set to On, you can choose whether to keep all versions, or limit it to a specific number. By default, it is set to On. +### -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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateFilesAndFoldersWithInvalidChars -The default is On. Files and folders with invalid characters (for example:<, >, :, ", |, ?, *, /, \,\u007f) in the names will be migrated by default. If set to Off, files and folders with invalid characters in names will not be migrated. +### -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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: null +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: null +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateHiddenFiles -If set to On, hidden system files will be migrated. By default, it is set to On. +### -IncludeHiddenFiles +If set to true, hidden system files will be migrated. +By default, it is set to true. + ```yaml Type: Boolean -Parameter Sets: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value:False +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: 10 +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. +By default, this is set to Off. +If set to On, permissions will be preserved. + ```yaml Type: Boolean -Parameter Sets: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: False +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. +By default, this is set to On. +If set to Off, no permissions will be preserved. ```yaml Type: Boolean -Parameter Sets: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named Default value: None @@ -307,132 +353,258 @@ 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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: False +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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: null +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -SkipListWithAudienceTargetingEnabled -By default, this is set to On. Lists with an audience field migration will fail with the warning “Does not support list with audience settings” unless customer enables the “Ignore audience” setting. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -StartMigrationAutomaticallyWhenNoScanIssue -By default, this is set to On. When StartMigrationAutomaticallyWhenNoScanIssue is turned on, migration starts automatically if no scan issue is found. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UseCustomAzureStorage -If you use your own Azure storage, you enter Azure account and Azure key, and select if you want to enable or disable encryption, and whether temporary files are deleted when migration is completed. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UserMappingFile -By default, Azure AD lookup is used to map users when submitting migration jobs. If you choose to use a custom user mapping file and you want to preserve user permissions, turn off Azure Active Directory lookup. By doing so, if a user isn't found in the mapping file, the tool won't look it up in AAD. +By default, Microsoft Entra lookup is used to map users when submitting migration jobs. +If you choose to use a custom user mapping file and you want to preserve user permissions, turn off Microsoft Entra lookup.By doing so, if a user isn't found in the mapping file, the tool won't look it up in Microsoft Entra ID. ```yaml Type: String -Parameter Sets: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: Empty +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -MigrateAllSiteFieldsAndContentTypes -By default, MigrateAllSiteFieldsAndContentTypes is Off. If it is 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. +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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -WorkingFolder -By default, the working folder is %appdata%\Microsoft\MigrationToolStorage. If you wish to specify your own specific working folder, create it first, then use it as -WorkingFolder parameter. The changed working folder will take effect till you close the PowerShell window. +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 +``` -Notes: -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. +### -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: -Aliases: -applicable: SharePoint Migration Tool +Parameter Sets: (All) +Aliases: + Required: False Position: Named -Default value: %appdata%\Microsoft\MigrationToolStorage +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -## INPUTS +### -SkipListsWithName +To prevent certain lists from migrating, list each list name, separating it with a semicolon. +The default value is null. -### None +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -## OUTPUTS +### -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 -### System.Object +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 diff --git a/spmt/spmt-ps/spmt/Remove-SPMTTask.md b/spmt/spmt-ps/spmt/Remove-SPMTTask.md index c85d01b54e..a8c0c3f424 100644 --- a/spmt/spmt-ps/spmt/Remove-SPMTTask.md +++ b/spmt/spmt-ps/spmt/Remove-SPMTTask.md @@ -1,10 +1,13 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Remove-SPMTTask -Online version: -Schema: 2.0.0 +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 @@ -14,7 +17,7 @@ Remove an existing migration task from the registered migration. ## SYNTAX -``` +```powershell Remove-SPMTTask -TaskId <Guid> [-Force] ``` @@ -23,13 +26,13 @@ Remove an existing migration task from the registered migration. ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$Global:SourceSiteUrl = "https://youronpremsite/" $Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$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" @@ -48,30 +51,32 @@ $Global:FileshareSource = "YourFileShareDataSource" Import-Module Microsoft.SharePoint.MigrationTool.PowerShell #Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force +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 -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 +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 ``` -Remove an existing migration task from the migration. +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. +This parameter is optional. +To remove a task already started, the Force parameter is required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: False Position: Named Default value: False @@ -85,25 +90,23 @@ This parameter is mandatory and defines the ID of task to be removed. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: True Position: Named -Default value: Empty +Default value: 00000000-0000-0000-0000-000000000000 Accept pipeline input: False Accept wildcard characters: False ``` -## INPUTS -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 - diff --git a/spmt/spmt-ps/spmt/SharePointMigrationTool.md b/spmt/spmt-ps/spmt/SharePointMigrationTool.md new file mode 100644 index 0000000000..0faff30e0e --- /dev/null +++ b/spmt/spmt-ps/spmt/SharePointMigrationTool.md @@ -0,0 +1,35 @@ +--- +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 index 379b849151..5d9ded7974 100644 --- a/spmt/spmt-ps/spmt/Show-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Show-SPMTMigration.md @@ -1,35 +1,38 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Show-SPMTMigration -Online version: -Schema: 2.0.0 +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. +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 +```powershell +Show-SPMTMigration [<CommonParameters>] ``` ## DESCRIPTION -If the user starts the migration with -NoShow parameter, running the ‘Show-SPMTMigration’ cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. +If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$Global:SourceSiteUrl = "https://youronpremsite/" $Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$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" @@ -48,31 +51,28 @@ $Global:FileshareSource = "YourFileShareDataSource" Import-Module Microsoft.SharePoint.MigrationTool.PowerShell #Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force +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 -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 +Start-SPMTMigration -NoShow +Show-SPMTMigration ``` -First, start a migration with -NoShow parameter, then run ‘Show-SPMTMigration’, the migration task ID, data source location, target location and migration status will show up in the console. +This example, first, starts a migration with -NoShow parameter, then run 'Show-SPMTMigration', the migration task ID, data source location, target location and migration status will show up in the console. ## PARAMETERS -## INPUTS - -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 - diff --git a/spmt/spmt-ps/spmt/Start-SPMTMigration.md b/spmt/spmt-ps/spmt/Start-SPMTMigration.md index d4ccc554ee..285f7f17c9 100644 --- a/spmt/spmt-ps/spmt/Start-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Start-SPMTMigration.md @@ -1,19 +1,23 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Start-SPMTMigration -Online version: -Schema: 2.0.0 +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] ``` @@ -22,11 +26,11 @@ This cmdlet will start the registered SPMT migration. ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$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 @@ -50,27 +54,28 @@ Import-Module Microsoft.SharePoint.MigrationTool.PowerShell 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 -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 ``` -Start a migration with one SharePoint migration task and one File Share migration task. +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 in the console. +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: -applicable: SharePoint Migration Tool +Aliases: + Required: False Position: Named Default value: False @@ -79,13 +84,13 @@ Accept wildcard characters: False ``` ### -ParametersValidationOnly -Validate the parameters: check source access permissions, source existence and if the TargetUrl is valid. +Validate the parameters: check source access permissions, source existence and if TargetUrl is valid. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: SharePoint Migration Tool +Aliases: + Required: False Position: Named Default value: False @@ -93,16 +98,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -## INPUTS - -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 - diff --git a/spmt/spmt-ps/spmt/Stop-SPMTMigration.md b/spmt/spmt-ps/spmt/Stop-SPMTMigration.md index 1bc2605817..211d84a4ec 100644 --- a/spmt/spmt-ps/spmt/Stop-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Stop-SPMTMigration.md @@ -1,33 +1,36 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Stop-SPMTMigration -Online version: -Schema: 2.0.0 +online version: https://learn.microsoft.com/powershell/module/spmt/stop-spmtmigration +applicable: SharePoint Migration Tool +title: Stop-SPMTMigration +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Stop-SPMTMigration ## SYNOPSIS -Cancel the current migration session. +Cancel the current migration session. ## SYNTAX -``` -Stop-SPMTMigration +```powershell +Stop-SPMTMigration [<CommonParameters>] ``` ## DESCRIPTION -Cancel the current migration session. +Cancel the current migration session. ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$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 @@ -60,20 +63,18 @@ Start-SPMTMigration -NoShow #cancel the started migration.# Stop-SPMTMigration ``` -Start a migration first, then run "Stop-SPMTMigration" to cancel the migration. -## PARAMETERS +This example starts a migration first, then run "Stop-SPMTMigration" to cancel the migration. -## INPUTS +## PARAMETERS -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 - diff --git a/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md b/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md index ce8a10a437..173a2fee3e 100644 --- a/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md @@ -1,21 +1,24 @@ --- -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 -Applicable: SharePoint Migration Tool -Title: Unregister-SPMTMigration -Online version: -Schema: 2.0.0 +online version: https://learn.microsoft.com/powershell/module/spmt/unregister-spmtmigration +applicable: SharePoint Migration Tool +title: Unregister-SPMTMigration +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Unregister-SPMTMigration ## SYNOPSIS -Remove the SPMT migration session created. +Remove the SPMT migration session created. ## SYNTAX -``` -Unregister-SPMTMigration +```powershell +Unregister-SPMTMigration [<CommonParameters>] ``` ## DESCRIPTION @@ -23,17 +26,16 @@ Remove the SPMT migration session created. ## EXAMPLES -### Example 1 -``` +### EXAMPLE 1 +```powershell #Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "http://youronpremsite/" +$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" @@ -61,20 +63,18 @@ Start-SPMTMigration -NoShow Stop-SPMTMigration Unregister-SPMTMigration ``` -Cancel the started migration and unregister the migration session. -## PARAMETERS +This example cancels the started migration and unregister the migration session. -## INPUTS +## PARAMETERS -### None +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 - diff --git a/spmt/spmt-ps/spmt/spmt.md b/spmt/spmt-ps/spmt/spmt.md deleted file mode 100644 index f2a45325ca..0000000000 --- a/spmt/spmt-ps/spmt/spmt.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -Module Name: SharePoint Migration Tool -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Title: SharePoint Migration Tool -Locale: en-US ---- - -# 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](http://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/staffhub/docfx.json b/staffhub/docfx.json deleted file mode 100644 index 8c85e45c60..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": ["**/*.md"], - "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" : "kenwith", - "ms.author" : "kenwith", - "manager" : "serdars", - "ms.date" : "09/25/2017", - "ms.topic" : "reference", - "ms.service" : "staffhub-powershell", - "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" - }, - "fileMetadata": {}, - "template": [], - "dest": "staffhub-ps" - } -} \ No newline at end of file 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/docs-conceptual/index.md b/staffhub/docs-conceptual/index.md deleted file mode 100644 index c4c1726152..0000000000 --- a/staffhub/docs-conceptual/index.md +++ /dev/null @@ -1,11 +0,0 @@ -#Microsoft StaffHub cmdlet reference - -Welcome to the Microsoft StaffHub cmdlet help references. The Microsoft StaffHub cmdlets provide the command line interface for service administration and management. - -Here you will find all of the Microsoft StaffHub PowerShell help topics. The reference documentation can be found here: https://docs.microsoft.com/en-us/powershell/module/staffhub/?view=staffhub-ps - -Instructions on installing the StaffHub cmdlet module can be found here: https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha - -These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. - -The repo is located here: https://github.com/MicrosoftDocs/office-docs-powershell and you can find the README displayed at the bottom of the page. diff --git a/staffhub/docs-conceptual/intro.md b/staffhub/docs-conceptual/intro.md deleted file mode 100644 index c4c1726152..0000000000 --- a/staffhub/docs-conceptual/intro.md +++ /dev/null @@ -1,11 +0,0 @@ -#Microsoft StaffHub cmdlet reference - -Welcome to the Microsoft StaffHub cmdlet help references. The Microsoft StaffHub cmdlets provide the command line interface for service administration and management. - -Here you will find all of the Microsoft StaffHub PowerShell help topics. The reference documentation can be found here: https://docs.microsoft.com/en-us/powershell/module/staffhub/?view=staffhub-ps - -Instructions on installing the StaffHub cmdlet module can be found here: https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha - -These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. - -The repo is located here: https://github.com/MicrosoftDocs/office-docs-powershell and you can find the README displayed at the bottom of the page. diff --git a/staffhub/docs-conceptual/overview.md b/staffhub/docs-conceptual/overview.md deleted file mode 100644 index c7ef055789..0000000000 --- a/staffhub/docs-conceptual/overview.md +++ /dev/null @@ -1,3 +0,0 @@ -#My overview - -This is an overview page \ No newline at end of file diff --git a/staffhub/docs-conceptual/toc.yml b/staffhub/docs-conceptual/toc.yml deleted file mode 100644 index 2f726b4da1..0000000000 --- a/staffhub/docs-conceptual/toc.yml +++ /dev/null @@ -1,5 +0,0 @@ -- name: Overview - href: index.md - items: - - name: Introduction - href: intro.md diff --git a/staffhub/mapping/monikerMapping.json b/staffhub/mapping/monikerMapping.json deleted file mode 100644 index 2439d024bf..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": {} - } - } -} \ No newline at end of file diff --git a/staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md b/staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md deleted file mode 100644 index 3a6f92830b..0000000000 --- a/staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Add-StaffHubMember -online version: -schema: 2.0.0 ---- - -# Add-StaffHubMember - -## SYNOPSIS -Adds a member or manager to the specified team - -Note: This cmdlet currently is in Beta. - -## SYNTAX - -``` -Add-StaffHubMember [-TeamId] <String> [-FirstName] <String> [-LastName] <String> [[-Email] <String>] - [[-PhoneNumber] <String>] [-IsManager] <Boolean> -``` - -## DESCRIPTION -Adds a member or manager to the specified team. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-StaffHubMember -TeamId "TEAM_1234" -FirstName "Abc" -LastName "123" -Email "abc@contoso.com" -IsManager $false -``` - -Adds the member with specified email/PhoneNumber to the team. Either PhoneNumber/Email is mandatory. - -## PARAMETERS - -### -Email -Office 365 email of the member to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -First name of the member to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsManager -Should the person be added as a manager. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -Last name of the member to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -Phone number of the member to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId -ID of the team to which the member is to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet currently is in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md b/staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md deleted file mode 100644 index 090e42ee86..0000000000 --- a/staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Add-StaffHubShift -online version: -schema: 2.0.0 ---- - -# Add-StaffHubShift - -## SYNOPSIS -Adds a shift to the specified member in a team. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Add-StaffHubShift [-Title] <String> [[-Notes] <String>] [-StartDateTime] <DateTime> [-EndDateTime] <DateTime> - [-ShiftType] <String> [-MemberId] <String> [-TeamId] <String> -``` - -## DESCRIPTION -Adds a shift to the specified member in a team. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -$startTime = Get-Date -Date "2018-01-01T00:10:00" -$endTime = Get-Date -Date "2018-01-01T04:10:00" -Add-StaffHubShift -Title "Title" -StartDateTime $startTime -EndDateTime $endTime -ShiftType Working -MemberId "MBER_1234" -TeamId "TEAM_1234" -``` - -Creates a shift for member MBER_1234 under the team TEAM_1234. - -## PARAMETERS - -### -EndDateTime -End time of the shift. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberId -Member to which the shift is to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Additional notes for the shift. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftType -ShiftType - Working/Absence. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Accepted values: Working, Absence -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDateTime -Start time of the shift. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId -ID of the team to which the shift is to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Title of the shift. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md b/staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md deleted file mode 100644 index 93cca4304b..0000000000 --- a/staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Add-StaffHubTeam -online version: -schema: 2.0.0 ---- - -# Add-StaffHubTeam - -## SYNOPSIS -Creates a team. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Add-StaffHubTeam [-Name] <String> [-TimeZone] <String> [[-ManagerEmail] <String>] -``` - -## DESCRIPTION -Creates a team. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Add-StaffHubTeam -Name "TeamFromCmdletTest" -TimeZone "Asia/Calcutta" -ManagerEmail "abc@contoso.com" -``` - -Creates a team with abc@contoso.com as manager. - -### -------------------------- Example 2 -------------------------- -``` -Add-StaffHubTeam -Name "TeamFromCmdletTest" -TimeZone "Asia/Calcutta" -``` - -Creates a team with the logged in user as manager. - -## PARAMETERS - -### -ManagerEmail -Organizational email of the member who should be the manager of the team. If not specified, the logged in user is assigned as the manager. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the team to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -TimeZone of the team. Format - tz database. -Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Connect-StaffHub.md b/staffhub/staffhub-ps/staffhub/Connect-StaffHub.md deleted file mode 100644 index f4be7072bf..0000000000 --- a/staffhub/staffhub-ps/staffhub/Connect-StaffHub.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Connect-StaffHub -online version: -schema: 2.0.0 ---- - -# Connect-StaffHub - -## SYNOPSIS -The `Connect-StaffHub` cmdlet connects an authenticated account to use for Microsoft StaffHub cmdlet requests. -You can use this authenticated account only with Microsoft StaffHub cmdlets. - -Note: The cmdlet is currently in Beta. - -## SYNTAX - -``` -Connect-StaffHub [[-Credentials] <PSCredential>] [[-LogLocation] <String>] [[-LogHistoryInDays] <Int32>] [[-CultureInfo] <String>] -``` - -## DESCRIPTION -The `Connect-StaffHub` cmdlet connects an authenticated account. This cmdlet authenticates a user for Staff Hub. -You can use this authenticated account only with Microsoft StaffHub cmdlets. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Connect-StaffHub -Credentials $mycreds -``` - -LogIn the session with the specified credential. - -### -------------------------- Example 2 -------------------------- -``` -Connect-StaffHub -``` - -Prompts to enter credentials and then Log in. - -## PARAMETERS - -### -Credentials -PSCredential object of the credential. -Eg: $secpasswd = ConvertTo-SecureString "password" -AsPlainText -Force -$mycreds = New-Object System.Management.Automation.PSCredential ("username", $secpasswd) - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CultureInfo -CultureInfo in which the message is to be displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 3 -Default value: en-US -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogHistoryInDays -Number of days the logs are to be persisted. -Default value is 10 days. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 2 -Default value: 10 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLocation -Location where the logs are to be persisted in user's box. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -The cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md b/staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md deleted file mode 100644 index e429bb0b13..0000000000 --- a/staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Get-StaffHubMember -online version: -schema: 2.0.0 ---- - -# Get-StaffHubMember - -## SYNOPSIS -Get details for all team members or for a specified team member. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Get-StaffHubMember [-TeamId] <String> [[-MemberId] <String>] -``` - -## DESCRIPTION -Get details of team members. - -## EXAMPLES - -### Example 1 -``` -Get-StaffHubMember -TeamId "TEAM_1234" -MemberId MBER_1234 -``` - -Get the details of MBER_1234 in team TEAM_1234. - -### Example 2 -``` -Get-StaffHubMember -TeamId "TEAM_1234" -``` - -Get the details of all the members in team TEAM_1234. - -## PARAMETERS - -### -MemberId -MemberId for the specified member in the team. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId -TeamId for which all the members are to be fetched. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md b/staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md deleted file mode 100644 index ade33aa588..0000000000 --- a/staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -online version: -applicable: Microsoft StaffHub -title: Get-StaffHubShifts -schema: 2.0.0 ---- - -# Get-StaffHubShifts - -## SYNOPSIS -Note: This cmdlet is currently in Beta. -Get details of shifts for all team members or for a specified team member for the given time window. - -## SYNTAX - -``` -Get-StaffHubShifts [-TeamId] <String> [-StartDateTime] <DateTime> [-EndDateTime] <DateTime> - [[-MemberId] <String>] [<CommonParameters>] -``` - -## DESCRIPTION -Get details of the shifts for all team members or for a specified team member - -## EXAMPLES - -### Example 1 -``` -$startTime = Get-Date -Date "2018-01-01T00:10:00" -$endTime = Get-Date -Date "2018-01-01T04:10:00" -Get-StaffHubShifts -TeamId "TEAM_1234" -StartDateTime $startTime -EndDateTime $endTime -MemberId MBER_1234 -``` -Get the details of the shifts for MBER_1234 in the team TEAM_1234 between start time and end time - -### Example 2 -``` -$startTime = Get-Date -Date "2018-01-01T00:10:00" -$endTime = Get-Date -Date "2018-01-01T04:10:00" -Get-StaffHubShifts -TeamId "TEAM_1234" -StartDateTime $startTime -EndDateTime $endTime -``` - -Get the details of the shifts for all the members in team TEAM_1234 between start time and end time - -## PARAMETERS - -### -EndDateTime -EndDateTime for the time window between which shifts are to be fetched - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberId -MemberId of the member for which the shifts are to be fetched - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDateTime -StartDateTime for the time window between which shifts are to be fetched - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId -TeamId of the team for which the shifts are to be fetched - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md b/staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md deleted file mode 100644 index daec4449c6..0000000000 --- a/staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Get-StaffHubTeamsForTenant -online version: -schema: 2.0.0 ---- - -# Get-StaffHubTeamsForTenant - -## SYNOPSIS -Get all the teams in the tenant of the logged in user. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Get-StaffHubTeamsForTenant [[-ContinuationToken] <String>] [[-Top] <Int32>] -``` - -## DESCRIPTION -Get all the teams in the tenant of the logged in user. -ContinuationToken from the call is stored in $nextToken Variable. -So the next call can be made like Get-StaffHubTeamsForTenant -Top 10 -ContinuationToken $nextToken. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-StaffHubTeamsForTenant -Top 10 -``` - -Get first 10 teams in the tenant by ascending creation time order. -If 'Top' parameter is not specified, then it defaults it to 1000. -This returns a continuation token stored in $nextToken variable which can be used by the following call. -Eg: Get-StaffHubTeamsForTenant -Top 10 -ContinuationToken $nextToken. - -### -------------------------- Example 2 -------------------------- -``` -Get-StaffHubTeamsForTenant -``` - -Get all teams in the tenant with page size restricted to 1000 by default. - -## PARAMETERS - -### -ContinuationToken -Continuation Token returned by the previous call. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Top 'n' items to be fetched sorted by ascending creation time order. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md b/staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md deleted file mode 100644 index 733d680f20..0000000000 --- a/staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -online version: -applicable: Microsoft StaffHub -title: Get-StaffHubUsersForTenant -schema: 2.0.0 ---- - -# Get-StaffHubUsersForTenant - -## SYNOPSIS -Note: This cmdlet is currently in Beta. -Get all the StaffHub users in the tenant of the logged in user. - -## SYNTAX - -``` -Get-StaffHubUsersForTenant [[-ContinuationToken] <String>] [[-Top] <Int32>] -``` - -## DESCRIPTION -Get all the StaffHub users in the tenant of the logged in user. -ContinuationToken from the call is stored in $nextToken variable. -Here is an example of the next call that can be made: Get-StaffHubUsersForTenant -Top 10 -ContinuationToken $nextToken - -## EXAMPLES - -### Example 1 -``` -Get-StaffHubUsersForTenant -Top 10 -``` - -Get first 10 StaffHub users in the tenant by ascending creation time order. -If 'Top' parameter is not specified, then it defaults to 1000. -This returns a continuation token stored in $nextToken variable which can be used by the following call. -Eg: Get-StaffHubUsersForTenant -Top 10 -ContinuationToken $nextToken - -### Example 2 -``` -Get-StaffHubUsersForTenant -``` - -Get all StaffHub users in the tenant with page size restricted to 1000 by default. - -## PARAMETERS - -### -ContinuationToken -Continuation Token returned by the previous call - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Top 'n' items to be fetched sorted by ascending creation time order. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md b/staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md deleted file mode 100644 index c29f00fb7b..0000000000 --- a/staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Import-StaffHubMember -online version: -schema: 2.0.0 ---- - -# Import-StaffHubMember - -## SYNOPSIS -Import a list of members and adds them to teams. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Import-StaffHubMember [-Path] <String> [[-Encoding] <String>] -``` - -## DESCRIPTION - -Import a list of members and add them to teams. -Format of the file context - TeamId,FirstName,LastName,Email,PhoneNumber,IsManager. Either Email or PhoneNumber is required. -Eg: TEAM_1234,Staff,five,abc@contoso.com,True -Failure in adding one member does not stop the other members from getting added. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-StaffHubMember -Path "C:\member.txt" -``` - -Imports the list of members from the file in the specified path. - -## PARAMETERS - -### -Encoding -Encoding type of the file. -https://msdn.microsoft.com/en-us/library/system.text.encoding(v=vs.110).aspx - Encoding parameter value list - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Location of the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Import-StaffHubShift.md b/staffhub/staffhub-ps/staffhub/Import-StaffHubShift.md deleted file mode 100644 index c28229b58a..0000000000 --- a/staffhub/staffhub-ps/staffhub/Import-StaffHubShift.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Import-StaffHubShift -online version: -schema: 2.0.0 ---- - -# Import-StaffHubShift - -## SYNOPSIS -Imports a list of shifts and adds them to members in the specified teams. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Import-StaffHubShift [-Path] <String> [[-Encoding] <String>] -``` - -## DESCRIPTION - -Imports a list of shifts and adds them to members in the specified teams. -Format of the file content - Title,Notes,StartDateTime,EndDateTime,ShiftType,MemberId,TeamId -Eg: Title,Notes,2018-11-28T00:00:00Z,2018-11-28T02:00:00Z,Working,MBER_1234,TEAM_1234 -Failure in adding one shift does not stop the other shifts from getting added. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-StaffHubShift -Path "C:\shift.txt" -``` - -Imports the list of shifts from the file in the specified path. - -## PARAMETERS - -### -Encoding -Encoding type of the file -https://msdn.microsoft.com/en-us/library/system.text.encoding(v=vs.110).aspx - Encoding parameter value list - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Location of the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Import-StaffHubTeam.md b/staffhub/staffhub-ps/staffhub/Import-StaffHubTeam.md deleted file mode 100644 index 03becaeeed..0000000000 --- a/staffhub/staffhub-ps/staffhub/Import-StaffHubTeam.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Import-StaffHubTeam -online version: -schema: 2.0.0 ---- - -# Import-StaffHubTeam - -## SYNOPSIS -Imports a set of teams from a specified file - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Import-StaffHubTeam [-Path] <String> [[-Encoding] <String>] -``` - -## DESCRIPTION - -Imports a set of teams from a specified file. -Format of the File content - Name,TimeZone,ManagerEmail -Eg: CmdletTestTeam,Asia/Calcutta,abc@contoso.com -Failure in adding one team does not stop the other teams from getting added. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Import-StaffHubTeam -Path "C:\team.txt" -``` - -Imports a list of teams from the file in the specified path. - -## PARAMETERS - -### -Encoding -Encoding type of the file -https://msdn.microsoft.com/en-us/library/system.text.encoding(v=vs.110).aspx - Encoding parameter value list - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Location of the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Remove-StaffHubMember.md b/staffhub/staffhub-ps/staffhub/Remove-StaffHubMember.md deleted file mode 100644 index 01b36e5aab..0000000000 --- a/staffhub/staffhub-ps/staffhub/Remove-StaffHubMember.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -applicable: Microsoft StaffHub -title: Remove-StaffHubMember -online version: -schema: 2.0.0 ---- - -# Remove-StaffHubMember - -## SYNOPSIS -Removes the specified member from the team. - -Note: This cmdlet is currently in Beta. - -## SYNTAX - -``` -Remove-StaffHubMember [-TeamId] <String> [[-MemberId] <String>] [[-MemberObject] <PSObject>] -``` - -## DESCRIPTION -Removes the specified member from the team. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-StaffHubMember -TeamId "TEAM_1234" -MemberId "MBER_1234" -``` - -This removes member MBER_1234 from TEAM_1234. - -## PARAMETERS - -### -MemberId -MemberId of the member to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberObject -Entire member object returned from `Get-StaffHubMember`. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId -TeamId from which the specified member is to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -This cmdlet is currently in Beta. - -## RELATED LINKS - -[MicrosoftStaffHub Module in Gallery](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha) diff --git a/staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md b/staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md deleted file mode 100644 index 725aa01522..0000000000 --- a/staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml -Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -online version: -applicable: Microsoft StaffHub -title: Remote-StaffHubUser -schema: 2.0.0 ---- - -# Remove-StaffHubUser - -## SYNOPSIS -Note: This cmdlet is currently in Beta. -Removes the specified user from StaffHub (Only for users deleted in AAD already) - -## SYNTAX - -``` -Remove-StaffHubUser [-UserId] <String> -``` - -## DESCRIPTION -Removes the specified user from StaffHub. -Pre-requisite is to delete the user from AAD. - -## EXAMPLES - -### Example 1 -``` -Remove-StaffHubUser -UserId "USER_1234" -``` - -This removes the user "USER_1234" from StaffHub, if the user has been deleted in AAD already. - -## PARAMETERS - -### -UserId -UserId of the user to be removed from StaffHub - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft StaffHub - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/staffhub/staffhub-ps/staffhub/staffhub.md b/staffhub/staffhub-ps/staffhub/staffhub.md deleted file mode 100644 index 026db9c930..0000000000 --- a/staffhub/staffhub-ps/staffhub/staffhub.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -Module Name: Microsoft StaffHub PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: staffhub -Locale: en-US ---- - -# Microsoft StaffHub PowerShell -## Description -The following cmdlet references are for Microsoft StaffHub. - -## staffhub Cmdlets -### [Add-StaffHubMember](Add-StaffHubMember.md) -{{Manually Enter Add-StaffHubMember Description Here}} - -### [Add-StaffHubShift](Add-StaffHubShift.md) -{{Manually Enter Add-StaffHubShift Description Here}} - -### [Add-StaffHubTeam](Add-StaffHubTeam.md) -{{Manually Enter Add-StaffHubTeam Description Here}} - -### [Connect-StaffHub](Connect-StaffHub.md) -{{Manually Enter Connect-StaffHub Description Here}} - -### [Get-StaffHubMember](Get-StaffHubMember.md) -{{Manually Enter Get-StaffHubMember Description Here}} - -### [Get-StaffHubShifts](Get-StaffHubShifts.md) -{{Manually Enter Get-StaffHubShifts Description Here}} - -### [Get-StaffHubTeamsForTenant](Get-StaffHubTeamsForTenant.md) -{{Manually Enter Get-StaffHubTeamsForTenant Description Here}} - -### [Get-StaffHubUsersForTenant](Get-StaffHubUsersForTenant.md) -{{Manually Enter Get-StaffHubUsersForTenant Description Here}} - -### [Import-StaffHubMember](Import-StaffHubMember.md) -{{Manually Enter Import-StaffHubMember Description Here}} - -### [Import-StaffHubShift](Import-StaffHubShift.md) -{{Manually Enter Import-StaffHubShift Description Here}} - -### [Import-StaffHubTeam](Import-StaffHubTeam.md) -{{Manually Enter Import-StaffHubTeam Description Here}} - -### [Remove-StaffHubMember](Remove-StaffHubMember.md) -{{Manually Enter Remove-StaffHubMember Description Here}} - -### [Remove-StaffHubUser](Remove-StaffHubUser.md) -{{Manually Enter Remove-StaffHubUser Description Here}} - diff --git a/teams/LICENSE.txt b/teams/LICENSE.txt new file mode 100644 index 0000000000..51f5ba2f39 --- /dev/null +++ b/teams/LICENSE.txt @@ -0,0 +1,76 @@ +Your use of the Microsoft Teams PowerShell is subject to the terms and conditions of the agreement you agreed to when you signed up for the Microsoft Teams subscription and by which you acquired a license for the software. For instance, if you are: + +• a volume license customer, use of this software is subject to your volume license agreement. +• a Microsoft Online Subscription customer, use of this software is subject to the Microsoft Online Subscription agreement. + +You may not use the service or software if you have not validly acquired a license from Microsoft or its licensed distributors. + +----------------START OF THIRD PARTY NOTICE-------------------------------- +The software includes the Polly library ("Polly"). The New BSD License set out below is provided for informational purposes only. It is not the license that governs any part of the software. + +Copyright (c) 2015-2020, App vNext +All rights reserved. + +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 App vNext 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 <COPYRIGHT HOLDER> 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--------- + +The software includes the Polly.Contrib.WaitAndRetry library ("Polly-Contrib"). The New BSD License set out below is provided for informational purposes only. It is not the license that governs any part of the software. + +Copyright (c) 2015-2020, App vNext and contributors +All rights reserved. + +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 App vNext 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 <COPYRIGHT HOLDER> 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--------- + +The software includes Newtonsoft.Json. The MIT License set out below is provided for informational purposes only. It is not the license that governs any part of the software. + +Newtonsoft.Json + +The MIT License (MIT) +Copyright (c) 2007 James Newton-King +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 THIRD PARTY NOTICE---------------------------------------- diff --git a/teams/docfx.json b/teams/docfx.json index d2d135bfc9..401d0beb8b 100644 --- a/teams/docfx.json +++ b/teams/docfx.json @@ -21,7 +21,8 @@ "dest": "teams/teams-ps" }, { - "files": ["**/*.md"], + "files": ["**/*.yml"], + "exclude": ["toc.yml"], "src": "teams-ps", "version": "teams-ps", "dest": "module" @@ -53,19 +54,22 @@ "overwrite": [], "externalReference": [], "globalMetadata": { - "author" : "kenwith", - "ms.author" : "kenwith", + "uhfHeaderId": "MSDocsHeader-MicrosoftTeams", + "author" : "serdarsoysal", + "ms.author" : "serdars", "manager" : "serdars", - "ms.date" : "09/25/2017", "ms.topic" : "reference", "ms.service" : "teams-powershell", + "products" : [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/63959238-cb90-4871-a33d-4a5519097e47", + "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" + ], "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": {}, "template": [], "dest": "teams-ps" } -} \ No newline at end of file +} diff --git a/teams/docs-conceptual/index.md b/teams/docs-conceptual/index.md index e34741bca5..83c900e736 100644 --- a/teams/docs-conceptual/index.md +++ b/teams/docs-conceptual/index.md @@ -1,13 +1,16 @@ --- -localization_priority: Normal +ms.localizationpriority: medium +title: Microsoft Teams cmdlet help reference +ms.date: 01/01/2020 +description: "Learn about the Microsoft Teams PowerShell cmdlet help reference." --- -#Microsoft Teams cmdlet reference +# Microsoft Teams cmdlet help reference -Welcome to the Microsoft Teams PowerShell cmdlet help references. Cmdlets for managing Microsoft Teams service are split between two powershell modules: the Skype for Business Online module and the Microsoft Teams module. +Welcome to the Microsoft Teams PowerShell cmdlet **Help** reference. -This powershell module is used for provisioning and management of teams and their backing groups themselves. The module is currently in Beta and can be installed here: https://www.powershellgallery.com/packages/MicrosoftTeams/ . To manage the policies and configurations that apply to the Microsoft Teams service, please see the reference docs for the Skype for Business module: https://docs.microsoft.com/en-us/powershell/module/skype/?view=skype-ps +This PowerShell module is used for provisioning and management of teams and their backing groups themselves. The module can be installed here: <https://www.powershellgallery.com/packages/MicrosoftTeams/>. -Here you will find all of the Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here, you will find all of the Microsoft Teams PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. diff --git a/teams/docs-conceptual/intro.md b/teams/docs-conceptual/intro.md deleted file mode 100644 index e34741bca5..0000000000 --- a/teams/docs-conceptual/intro.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -localization_priority: Normal ---- - -#Microsoft Teams cmdlet reference - -Welcome to the Microsoft Teams PowerShell cmdlet help references. Cmdlets for managing Microsoft Teams service are split between two powershell modules: the Skype for Business Online module and the Microsoft Teams module. - -This powershell module is used for provisioning and management of teams and their backing groups themselves. The module is currently in Beta and can be installed here: https://www.powershellgallery.com/packages/MicrosoftTeams/ . To manage the policies and configurations that apply to the Microsoft Teams service, please see the reference docs for the Skype for Business module: https://docs.microsoft.com/en-us/powershell/module/skype/?view=skype-ps - -Here you will find all of the Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. - -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. diff --git a/teams/docs-conceptual/overview.md b/teams/docs-conceptual/overview.md index c7ef055789..e4b420d32e 100644 --- a/teams/docs-conceptual/overview.md +++ b/teams/docs-conceptual/overview.md @@ -1,3 +1,9 @@ -#My overview +--- +title: My overview +ms.date: 01/01/2020 +description: "Microsoft Teams cmdlet help reference." +--- + +# My overview This is an overview page \ No newline at end of file diff --git a/teams/docs-conceptual/toc.yml b/teams/docs-conceptual/toc.yml index 2f726b4da1..1ba183cc0b 100644 --- a/teams/docs-conceptual/toc.yml +++ b/teams/docs-conceptual/toc.yml @@ -1,5 +1,2 @@ - name: Overview href: index.md - items: - - name: Introduction - href: intro.md diff --git a/teams/mapping/monikerMapping.json b/teams/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from teams/mapping/monikerMapping.json rename to teams/mapping/MAML2Yaml/monikerMapping.json diff --git a/teams/teams-ps/teams/Add-TeamChannelUser.md b/teams/teams-ps/teams/Add-TeamChannelUser.md new file mode 100644 index 0000000000..dcc55539d1 --- /dev/null +++ b/teams/teams-ps/teams/Add-TeamChannelUser.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser +title: Add-TeamChannelUser +schema: 2.0.0 +--- + +# Add-TeamChannelUser + +## 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 + +``` +Add-TeamChannelUser -GroupId <String> -DisplayName <String> -User <String> [-Role <String>] [-TenantId <String>] [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +``` +Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com +``` + +Add user dmx@example.com to private channel with name "Engineering" under the given group. + +### Example 2 +``` +Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com -Role Owner +``` + +Promote user dmx@example.com to an owner of private channel with name "Engineering" under the given group. + +### Example 3 +``` +Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User 0e4249a7-6cfd-8c93-a510-91cda44c8c73 -TenantId dcd143cb-c4ae-4364-9faf-e1c3242bf4ff +``` + +Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. + +## PARAMETERS + +### -GroupId +GroupId of the parent team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Display name of the private channel + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Role +Owner + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +TenantId of the external user + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### GroupId, DisplayName, User, Role, TenantId + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Add-TeamUser.md b/teams/teams-ps/teams/Add-TeamUser.md index 94b7689094..91f29ce8bb 100644 --- a/teams/teams-ps/teams/Add-TeamUser.md +++ b/teams/teams-ps/teams/Add-TeamUser.md @@ -1,54 +1,48 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/add-teamuser title: Add-TeamUser -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Add-TeamUser ## SYNOPSIS -Note: This cmdlet is currently in Beta. - -Adds an owner or member to the team, -and to 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. - -To turn an existing Member into an Owner, -first Add-TeamUser -Role Owner -User to add them to the owners list, -then Remove-TeamUser -User foo to remove them from the members list. +The `Add-TeamUser` adds an owner or member to the team, and to the unified group which backs the team. ## SYNTAX - ``` -Add-TeamUser -GroupId <String> -User <String> [-Role <String>] +Add-TeamUser -GroupId <String> -User <String> [-Role <String>] [<CommonParameters>] ``` ## DESCRIPTION +This cmdlet adds an owner or member to the team, and to the unified group which backs the team. + +> [!Note] +> The command will return immediately, but the Teams application will not reflect the update immediately. The change can take between 24 and 48 hours to appear within the Teams client. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Add-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com ``` -Add user dmx@example.com to group. +This example adds the user "dmx@example.com" to a group with the id "31f1ff6c-d48c-4f8a-b2e1-abca7fd399df". ## PARAMETERS ### -GroupId -GroupId of the team +GroupId of the team. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -58,14 +52,12 @@ Accept wildcard characters: False ``` ### -User -User's UPN (user principal name - e.g. -johndoe@example.com) +UPN of a user of the organization (user principal name - e.g. johndoe@example.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -75,21 +67,23 @@ Accept wildcard characters: False ``` ### -Role -Member or Owner +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: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Member Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### GroupId, User, Role @@ -99,4 +93,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Add-TeamsAppInstallation.md b/teams/teams-ps/teams/Add-TeamsAppInstallation.md new file mode 100644 index 0000000000..031a1aa094 --- /dev/null +++ b/teams/teams-ps/teams/Add-TeamsAppInstallation.md @@ -0,0 +1,122 @@ +--- +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 <String> -TeamId <String> [-Permissions <String>] [<CommonParameters>] +``` + +### UserScope +``` +Add-TeamsAppInstallation -AppId <String> -UserId <String> [-Permissions <String>] [<CommonParameters>] +``` + +## 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/Clear-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md new file mode 100644 index 0000000000..36eee8cbf2 --- /dev/null +++ b/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md @@ -0,0 +1,102 @@ +--- +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 +manager: mreddy +author: TristanChen-msft +ms.author: jiaych +ms.reviewer: julienp +--- + +# Clear-CsOnlineTelephoneNumberOrder + +## SYNOPSIS + +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. + +## SYNTAX + +``` +Clear-CsOnlineTelephoneNumberOrder [-OrderId] <OrderId> [<CommonParameters>] +``` + +## DESCRIPTION + +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. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : test +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : test +NumberPrefix : 1718 +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Cancelled +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +New York City +17182000004 +``` + +This example cancels the purchase of the telephone number order containing the phone number +17182000004. + +## PARAMETERS + +### OrderId +Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) + +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) + +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) + +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) + +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) + +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md new file mode 100644 index 0000000000..62e51c733c --- /dev/null +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -0,0 +1,53 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig +title: Clear-TeamsEnvironmentConfig +schema: 2.0.0 +author: VikneshMSFT +ms.author: vimohan +ms.reviewer: pbafna +manager: vinelap +--- + +# Clear-TeamsEnvironmentConfig + +## SYNOPSIS +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +## SYNTAX + +``` +Clear-TeamsEnvironmentConfig [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. This helps in clearing and rectifying any wrong information set in Set-TeamsEnvironmentConfig. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Clear-TeamsEnvironmentConfig +``` + +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +We do not recommend using Clear-TeamsEnvironmentConfig in Commercial, GCC, GCC High, or DoD environments. This cmdlet is available in Microsoft Teams PowerShell module from version 5.2.0-GA. + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md new file mode 100644 index 0000000000..8e367470c6 --- /dev/null +++ b/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md @@ -0,0 +1,102 @@ +--- +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 +manager: mreddy +author: TristanChen-msft +ms.author: jiaych +ms.reviewer: julienp +--- + +# Complete-CsOnlineTelephoneNumberOrder + +## SYNOPSIS + +Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. + +## SYNTAX + +``` +Complete-CsOnlineTelephoneNumberOrder [-OrderId] <OrderId> [<CommonParameters>] +``` + +## DESCRIPTION + +Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 | fl + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : test +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : test +NumberPrefix : 1718 +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Completed +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> (Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912).TelephoneNumber + +Location TelephoneNumber +-------- --------------- +New York City +17182000004 +``` + +This example completes the purchase of the telephone number order containing the phone number +17182000004. + +## PARAMETERS + +### OrderId +Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) + +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) + +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) + +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) + +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) + +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/teams/Connect-MicrosoftTeams.md index 8faccd0761..c713e2275a 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Connect-MicrosoftTeams.md @@ -1,56 +1,243 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams title: Connect-MicrosoftTeams -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- - # Connect-MicrosoftTeams ## SYNOPSIS -Note: This cmdlet is currently in Beta. -The Connect-MicrosoftTeams cmdlet connects an authenticated account to use for Microsoft Teams cmdlet requests. -You can use this authenticated account only with Microsoft Teams cmdlets. +The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with cmdlets from the MicrosoftTeams module. ## SYNTAX ### UserCredential (Default) ``` -Connect-MicrosoftTeams [-TenantId <String>] [-Credential <PSCredential>] [-AccountId <String>] - [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] +Connect-MicrosoftTeams +[-TenantId <String>] +[-Credential <PSCredential>] +[-AccountId <String>] +[-LogLevel <LogLevel>] +[-LogFilePath <String>] +[-TeamsEnvironmentName <String>] +[-UseDeviceAuthentication] +[-WhatIf] +[-Confirm] +[<CommonParameters>] ``` ### ServicePrincipalCertificate ``` -Connect-MicrosoftTeams -TenantId <String> -CertificateThumbprint <String> -ApplicationId <String> - [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] +Connect-MicrosoftTeams +-TenantId <String> +-Certificate <X509Certificate2> +-ApplicationId <String> +[-LogLevel <LogLevel>] +[-LogFilePath <String>] +[-WhatIf] +[-Confirm] +[<CommonParameters>] ``` -### AccessToken +### ServicePrincipalCertificateThumbprint ``` -Connect-MicrosoftTeams [-TenantId <String>] -AadAccessToken <String> [-MsAccessToken <String>] - -AccountId <String> [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] +Connect-MicrosoftTeams +-TenantId <String> +-CertificateThumbprint <String> +-ApplicationId <String> +[-LogLevel <LogLevel>] +[-LogFilePath <String>] +[-WhatIf] +[-Confirm] +[<CommonParameters>] +``` + +### AccessTokens +``` +Connect-MicrosoftTeams +[-TenantId <String>] +-AccessTokens <String[]> +[-LogLevel <LogLevel>] +[-LogFilePath <String>] +[-WhatIf] +[-Confirm] +[<CommonParameters>] ``` ## DESCRIPTION +The Connect-MicrosoftTeams cmdlet connects to Microsoft Teams with an authenticated account for use with cmdlets from the MicrosoftTeams PowerShell module. After executing this cmdlet, you can disconnect from MicrosoftTeams account using Disconnect-MicrosoftTeams. + +**Note**: With versions 4.x.x or later, enablement of basic authentication is not needed anymore in commercial, GCC, GCC High, and DoD environments. ## EXAMPLES +### Example 1: Connect to MicrosoftTeams +This example connects to an Azure account. You must provide a Microsoft account or organizational ID credentials. If multi-factor authentication is enabled for your credentials, you must log in using the interactive option. + +```powershell +Connect-MicrosoftTeams +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +### Example 2: Connect to MicrosoftTeams +The first command prompts for user credentials and stores them in the $Credential variable. The second command connects to an Azure account using the credentials stored in $credential. This account authenticates with Azure using organizational ID credentials. + +```powershell +$credential = Get-Credential +Connect-MicrosoftTeams -Credential $credential +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +### Example 3: Connect to MicrosoftTeams in a specific environment +This example connects to an Azure account in a specific environment. You must provide a Microsoft account or organizational ID credentials. If multi-factor authentication is enabled for your credentials, you must log in using the interactive option. + +```powershell +Connect-MicrosoftTeams -TeamsEnvironmentName TeamsGCCH +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com TeamsGCCH xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +### Example 4: Connect to MicrosoftTeams using a certificate thumbprint +This example demonstrates how to authenticate using a certificate thumbprint. Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, please see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```powershell +Connect-MicrosoftTeams -CertificateThumbprint "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" +``` + +### Example 5: Connect to MicrosoftTeams using a certificate object +This example demonstrates how to authenticate using a certificate object. The Certificate parameter is available from Teams PowerShell Module version 4.9.2-preview or later. For details about application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```powershell +$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2("C:\exampleCert.pfx",$password) +Connect-MicrosoftTeams -Certificate $cert -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" +``` + +### Example 6: Connect to MicrosoftTeams using Application-based Access Tokens +This example demonstrates how to authenticate with an application using Access Tokens. Access Tokens can be retrieved via the login.microsoftonline.com endpoint. It requires two Access Tokens: "MS Graph" and "Skype and Teams Tenant Admin API" resources. + +Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```powershell +$ClientSecret = "..." +$ApplicationID = "00000000-0000-0000-0000-000000000000" +$TenantID = "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" + +$graphtokenBody = @{ + Grant_Type = "client_credentials" + Scope = "https://graph.microsoft.com/.default" + Client_Id = $ApplicationID + Client_Secret = $ClientSecret +} + +$graphToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $graphtokenBody | Select-Object -ExpandProperty Access_Token + +$teamstokenBody = @{ + Grant_Type = "client_credentials" + Scope = "48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default" + Client_Id = $ApplicationID + Client_Secret = $ClientSecret +} + +$teamsToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $teamstokenBody | Select-Object -ExpandProperty Access_Token + +Connect-MicrosoftTeams -AccessTokens @("$graphToken", "$teamsToken") +``` + +### Example 7: Connect to MicrosoftTeams using Access Tokens in the delegated flow +This example demonstrates how to sign in using Access Tokens. Admin can retrieve Access Tokens via the login.microsoftonline.com endpoint. It requires two tokens, MS Graph Access Token and Teams Resource token. + +A delegated flow, such as Resource Owner Password Credentials (ROPC) or device code, must be used, with the following delegated app permissions required. + +| API | Grant type | Permission | +|-|-|-| +| Microsoft Graph | Delegated | User.Read.All | +| Microsoft Graph | Delegated | Group.ReadWrite.All | +| Microsoft Graph | Delegated | AppCatalog.ReadWrite.All | +| Microsoft Graph | Delegated | TeamSettings.ReadWrite.All | +| Microsoft Graph | Delegated | Channel.Delete.All | +| Microsoft Graph | Delegated | ChannelSettings.ReadWrite.All | +| Microsoft Graph | Delegated | ChannelMember.ReadWrite.All | +| Skype and Teams Tenant Admin API | Delegated | user_impersonation | + +```powershell +$ClientID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +$ClientSecret = "..." +$ClientSecret = [Net.WebUtility]::URLEncode($ClientSecret) +$TenantID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +$Username = "user@contoso.onmicrosoft.com" +$Password = "..." +$Password = [Net.WebUtility]::URLEncode($Password) + +$URI = "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" +$Body = "client_id=$ClientID&client_secret=$ClientSecret&grant_type=password&username=$Username&password=$Password" +$RequestParameters = @{ + URI = $URI + Method = "POST" + ContentType = "application/x-www-form-urlencoded" +} +$GraphToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=https://graph.microsoft.com/.default").access_token +$TeamsToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default").access_token +Connect-MicrosoftTeams -AccessTokens @($GraphToken, $TeamsToken) + +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + ## PARAMETERS -### -AadAccessToken -Specifies a Azure Active Directory Graph access token. +### AccessTokens +Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" resources. Both the tokens used should be of the same type. + +- Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +- Delegated flow - The following steps must be performed by Tenant Admin in the Azure portal when using your own application. + + Steps to configure the Microsoft Entra application. + 1. Go to Azure portal and go to App Registrations. + 2. Create or select the existing application. + 3. Add the following permission to this Application. + 4. Click API permissions. + 5. Click Add a permission. + 6. Click on the Microsoft Graph, and then select Delegated permissions. + 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". + 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. + 9. Navigate to "APIs my organization uses" + 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. + 11. Add all the listed permissions. + 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. + +```yaml +Type: String[] +Parameter Sets: AccessTokens +Aliases: +Required: True +Position: Named +Default value: None +Accept wildcard characters: False +``` + +### -AadAccessToken (Removed from version 2.3.2-preview) +Specifies an Azure Active Directory Graph access token. +> [!WARNING] +>This parameter has been removed from version 2.3.2-preview. ```yaml Type: String Parameter Sets: AccessToken -Aliases: -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -58,14 +245,12 @@ Accept wildcard characters: False ``` ### -AccountId -Specifies the ID of an account. You must specify the UPN of the user when authenticating with a user access token. +Specifies the ID of an account. ```yaml Type: String Parameter Sets: UserCredential -Aliases: -Applicable: Microsoft Teams - +Aliases: Required: False Position: Named Default value: None @@ -73,27 +258,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApplicationId +Specifies the application ID of the service principal that is used in application-based authentication. + +This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + ```yaml Type: String -Parameter Sets: AccessToken -Aliases: -Applicable: Microsoft Teams - -Required: False +Parameter Sets: ServicePrincipalCertificate +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -Specifies the application ID of the service principal. +### -Certificate +Specifies the certificate that is used for application-based authentication. A valid value is the X509Certificate2 object value of the certificate. + +This parameter has been introduced with version 4.9.2-preview. For more information about application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). ```yaml -Type: String +Type: X509Certificate2 Parameter Sets: ServicePrincipalCertificate -Aliases: -Applicable: Microsoft Teams +Aliases: CertificateThumbprint Required: True Position: Named @@ -103,14 +292,14 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint -Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action. +Specifies the certificate thumbprint of a digital public key X.509 certificate of an application that has permission to perform this action. + +This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). ```yaml Type: String Parameter Sets: ServicePrincipalCertificate -Aliases: -Applicable: Microsoft Teams - +Aliases: Required: True Position: Named Default value: None @@ -125,8 +314,6 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams - Required: False Position: Named Default value: False @@ -135,17 +322,15 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a **PSCredential** object. -For more information about the **PSCredential** object, type Get-Help Get-Credential. +Specifies a PSCredential object. +For more information about the PSCredential object, type Get-Help Get-Credential. -The **PSCredential** object provides the user ID and password for organizational ID credentials. +The PSCredential object provides the user ID and password for organizational ID credentials. ```yaml Type: PSCredential Parameter Sets: UserCredential -Aliases: -Applicable: Microsoft Teams - +Aliases: Required: False Position: Named Default value: None @@ -161,8 +346,6 @@ Provide a value here if you need to deviate from the default PowerShell log file Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams - Required: False Position: Named Default value: None @@ -171,8 +354,8 @@ Accept wildcard characters: False ``` ### -LogLevel -Specifies the log level. -The acceptable values for this parameter are: +Specifies the log level. +The acceptable values for this parameter are: - Info - Error @@ -184,9 +367,7 @@ The default value is Info. ```yaml Type: LogLevel Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - +Aliases: Required: False Position: Named Default value: None @@ -194,15 +375,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsAccessToken +### -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: String Parameter Sets: AccessToken -Aliases: -Applicable: Microsoft Teams - +Aliases: Required: False Position: Named Default value: None @@ -215,14 +396,12 @@ 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. +You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. ```yaml Type: String Parameter Sets: UserCredential, AccessToken Aliases: Domain, TenantDomain -Applicable: Microsoft Teams - Required: False Position: Named Default value: None @@ -234,8 +413,6 @@ Accept wildcard characters: False Type: String Parameter Sets: ServicePrincipalCertificate Aliases: Domain, TenantDomain -Applicable: Microsoft Teams - Required: True Position: Named Default value: None @@ -247,13 +424,10 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams - Required: False Position: Named Default value: False @@ -261,18 +435,106 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsEnvironmentName +Specifies the Teams environment. The following environments are supported: + + - Commercial or GCC environments: Don't use this parameter, this is the default. + - GCC High environment: TeamsGCCH + - DoD environment: TeamsDOD + - Microsoft Teams operated by 21Vianet: TeamsChina + +```yaml +Type: String +Parameter Sets: UserCredential +Aliases: +Required: False +Position: Named +Default value: None +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 +``` + +### -ManagedServiceHostName +Host name for managed service login. + +```yaml +Type: String +Parameter Sets: ManagedServiceLogin +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicePort +Port number for managed service login. + +```yaml +Type: Int32 +Parameter Sets: ManagedServiceLogin +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDeviceAuthentication +Use device code authentication instead of a browser control. + +```yaml +Type: SwitchParameter +Parameter Sets: UserCredential +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS ## NOTES -Tips for troubleshooting: -1. Confirm SAML 2.0 is being used. -IDP is outputting invalid SAML information. Needs to have SAML 2.0 vs. SAML 1.0 for the module to connect. -You might experience an error if the Identity Provider (IDP) only allows the use of SAML1.0 when trying to auth via basic authentication. -Which in turn, isn't expected to work because the cmdlet expects either OAUTH2 (which is used when doing just connect-microsofteams), or SAML2.0. -2. Confirm you have the latest version of the cmdlet. You can find the version by running: `get-module -listavailable` and then looking for the MicrosoftTeams name and the version to the left of it. - ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md new file mode 100644 index 0000000000..932a55f2fe --- /dev/null +++ b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md @@ -0,0 +1,132 @@ +--- +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 +ms.author: tomkau +ms.reviewer: rogupta +--- + +# 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. + +## SYNTAX + +```powershell +Disable-CsOnlineSipDomain -Domain <String> [-Force] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Note: Only one Skype for Business forest can be in hybrid mode at a given time. For full details on this scenario, including step-by-step instructions, see [Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation). + +This cmdlet enables 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. When an online SIP domain is disabled in Skype for Business Online, provisioning is blocked for users in this SIP domain. This ensures routing for any on-premises users in this SIP domain continues to function properly. + +This cmdlet facilitates consolidation of multiple Skype for Business Server deployments into a single Office 365 tenant. Consolidation can be achieved by moving one deployment at a time into Office 365, **provided the following key requirements are met**: + +- There must be at most 1 O365 tenant involved. Consolidation in scenarios with >1 O365 tenant is not supported. + +- At any given time, only 1 on-premises SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) + +- If 1 deployment is in hybrid mode, all sip domains from any other SfB forests must be disabled using this cmdlet before they can be synchronized into the tenant with Microsoft Entra Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. + +- Organizations must fully migrate each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the "hybrid" deployment, *before* moving on to migrate the next on-premises SfB deployment. + +This cmdlet may also be useful for organizations with on-premises deployments of Skype for Business Server that have not properly configured Microsoft Entra Connect. If the organization does not sync msRTCSIP-DeploymentLocator for its users, then Skype for Business Online will attempt to provision online any users with an assigned Skype for Business license, despite there being users on-premises. While the correct fix is to update the configuration for Microsoft Entra Connect to sync those attributes, using Disable-CsOnlineSipDomain can also mitigate the problem until that configuration change can be made. If this cmdlet is run, any users that were previously provisioned online in that domain will be de-provisioned in Skype for Business Online. + +Important: This cmdlet should not be run for domains that contain users hosted in Skype for Business Online. Any users in a sip domain that are already provisioned *online* will cease to function if you disable the online sip domain: +- Their SIP addresses will be removed. +- All contacts and meetings for these users hosted in Skype for Business Online will be deleted. +- These users will no longer be able to login to the Skype for Business Online environment. +- If these users use Teams, they will no longer be able to inter-operate with Skype for Business users, nor will they be able to federate with any users in other organizations. + +Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Business Online, Online SIP Domains must be disabled in all regions. You must execute this cmdlet in each region that is added in Allowed Data Location. + +## EXAMPLES + +### Example 1 + +```powershell +Disable-CsOnlineSipDomain -Domain Fabrikam.com +``` + +The cmdlet above disables the online sip domain Fabrikam.com. This would be useful in the case where a company, Contoso.com, that has Skype for Business acquires Fabrikam, which also has an on-premises deployment of Skype for Business Server. If Contoso is in hybrid mode with Skype for Business Online or if the intent is to configure it for hybrid, then if the organization wants to synchronize identities from Fabrikam.com into the same O365 tenant, the organization must first run this cmdlet. + +## PARAMETERS + +### -Domain + +The SIP domain to be disabled for online provisioning in Skype for Business Online. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the 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 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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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 + +This cmdlet is for advanced scenarios only. Organizations that are pure online or have only 1 on-premises deployment need not run this cmdlet. + +## RELATED LINKS + +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) + +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) + +[Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md new file mode 100644 index 0000000000..84d184eb9d --- /dev/null +++ b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Disable-CsTeamsShiftsConnectionErrorReport +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport +schema: 2.0.0 +--- + +# Disable-CsTeamsShiftsConnectionErrorReport + +## SYNOPSIS + +**Note:** This cmdlet is currently in public preview. + +This cmdlet disables an error report. + +## SYNTAX + +``` +Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet disables an error report. All available instances can be found by running [Get-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 +``` + +Disables the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. + +## PARAMETERS + +### -ErrorReportId + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md b/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md index 25e75097db..b840da266f 100644 --- a/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md @@ -1,61 +1,70 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/disconnect-microsoftteams title: Disconnect-MicrosoftTeams -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Disconnect-MicrosoftTeams ## SYNOPSIS -Note: This cmdlet is currently in Beta. ## SYNTAX ``` -Disconnect-MicrosoftTeams [-WhatIf] [-Confirm] +Disconnect-MicrosoftTeams [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION ## EXAMPLES +### Example 1 +```powershell +PS C:\> Disconnect-MicrosoftTeams +``` + +Disconnects from the Microsoft Teams environment. + ## PARAMETERS ### -WhatIf -@{Text=} +Simulates what would happen if the cmdlet is run. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm -@{Text=} +Proactively accepts any confirmation prompts. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -63,4 +72,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md b/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md new file mode 100644 index 0000000000..7356c8e473 --- /dev/null +++ b/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md @@ -0,0 +1,122 @@ +--- +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 +ms.author: tomkau +ms.reviewer: rogupta +--- + +# 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. + +## SYNTAX + +```powershell +Enable-CsOnlineSipDomain -Domain <String> [-Force] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet enables online provisioning of users in the specified SIP domain. In conjunction with Disable-CsOnlineSipDomain, this cmdlet allows organizations to consolidate *multiple on-premises deployments of Skype for Business Server (or Lync Server)* into a single Office 365 tenant. Consolidation can be achieved by moving one deployment at a time into Office 365, provided the following key requirements are met: + +- There must be at most 1 O365 tenant involved. Consolidation for scenarios with > 1 O365 tenant is not supported. + +- At any given time, only 1 on-premises SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) + +- If 1 deployment is in hybrid mode, all online SIP domains from any other SfB forests must be disabled before they can be synchronized into the tenant with Microsoft Entra Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. + +- Organizations must fully migrate (e.g move all users to the cloud) each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the "hybrid" deployment, *before* moving on to migrate the next on-premises SfB deployment. + +Before running this cmdlet for any SIP domain in a Skype for Business Server deployment, you must complete migration of any other existing hybrid SfB deployment that is in progress. All users in an existing hybrid deployment must be moved to the cloud, and that existing hybrid deployment must be detached from Office 365, as described in this article: [Disable hybrid to complete migration to the cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid). + +Important: If you have more than one on-premises deployment of Skype for Business Server, you *must* ensure SharedSipAddressSpace is disabled in all other Skype for Business Server deployments except the deployment containing the SIP domain that is being enabled. + +Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Business Online, Online SIP Domains must be Enabled in all regions. You must execute this cmdlet in each region that is added in Allowed Data Location for Skype for Business. + +## EXAMPLES + +### Example 1 + +```powershell +Enable-CsOnlineSipDomain -Domain contoso.com +``` + +Enables the domain contoso.com for online provisioning in Skype for Business Online. + +## PARAMETERS + +### -Domain + +The SIP domain to be enabled for online provisioning in Skype for Business Online. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, +-OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) + +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) diff --git a/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md b/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md new file mode 100644 index 0000000000..2af9e62f5d --- /dev/null +++ b/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber +applicable: Microsoft Teams +title: Export-CsAcquiredPhoneNumber +author: pavellatif +ms.author: pavellatif +ms.reviewer: +manager: roykuntz +schema: 2.0.0 +--- + +# Export-CsAcquiredPhoneNumber + +## SYNOPSIS +This cmdlet exports the list of phone numbers acquired by Teams Phone tenant. + +## SYNTAX + +``` +Export-CsAcquiredPhoneNumber [-Property <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet exports all the acquired phone numbers by the tenant to a file. The cmdlet is an asynchronus operation and will return an OrderId. [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) cmdlet can be used to check the status of the OrderId including the download link to exported file. + +By default, this cmdlet returns all the phone numbers acquired by the tenant with all corresponding properties in the results. The tenant admin may indicate specific properties as an input to get a list with only selected properties in the file. + +**Available properties to use are**: + +- TelephoneNumber +- OperatorId +- NumberType +- LocationId +- CivicAddressId +- NetworkSiteId +- AvailableCapabilities +- AcquiredCapabilities +- AssignmentStatus +- PlaceName +- ActivationState +- PartnerName +- IsoCountryCode +- PortInOrderStatus +- CapabilityUpdateSupported +- AcquisitionDate +- TargetId +- TargetType +- AssignmentCategory +- CallingProfileId +- IsoSubdivisionCode +- NumberSource +- SupportedCustomerActions +- ReverseNumberLookup +- RoutingOptions + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Export-CsAcquiredPhoneNumber +``` +```output +0e923e2c-ab0e-4b7a-be5a-906be8c +``` +This example displays the output of the export acquired phone numbers operation. The OrderId shown as the output string and can be used to get the download link for the file. + +### Example 2 +```powershell +PS C:\> Export-CsAcquiredPhoneNumber -Property "TelephoneNumber, NumberType, AssignmentStatus" +``` +```output +0e923e2c-ab0e-6h8c-be5a-906be8c +``` +This example displays the output of the export acquired phone numbers operation with filtered properties. This file will only contain the properties indicated. + +### Example 3 +```powershell +PS C:\> $orderId = Export-CsAcquiredPhoneNumber +``` +This example displays the use of variable "orderId" for the export acquired phone numbers operation. The OrderId string will be stored in the variable named "orderId" and no output will be shown for the cmdlet. + +### Example 4 +```powershell +PS C:\> Export-CsAcquiredPhoneNumber -Property "TelephoneNumber, NumberType, AssignmentStatus" +``` +```output +OrderId : 0e923e2c-ab0e-6h8c-be5a-906be8c +``` +This example displays the use of variable "orderId" for the export acquired phone numbers operation with filtered properties. The OrderId string will be stored in the variable named "orderId" and no output will be shown for the cmdlet. + +## PARAMETERS + +### -Property +{{ Fill Property Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES +The cmdlet is available in Teams PowerShell module 6.1.0 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md b/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md new file mode 100644 index 0000000000..610335e471 --- /dev/null +++ b/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +``` +Export-CsAutoAttendantHolidays -Identity <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Export-CsAutoAttendantHolidays cmdlet and the Import-CsAutoAttendantHolidays cmdlet enable you to export holiday schedules in your auto attendant and then later import that information. This can be extremely useful in a situation where you need to configure same holiday sets in multiple tenants. + +The Export-CsAutoAttendantHolidays cmdlet returns the holiday schedule information in serialized form (as a byte array). The caller can then write the bytes to the disk to obtain a CSV file. Similarly, the Import-CsAutoAttendantHolidays cmdlet accepts the holiday schedule information as a byte array, which can be read from the aforementioned CSV file. The first line of the CSV file is considered a header record and is always ignored. + +**NOTE**: Each line in the CSV file used by Export-CsAutoAttendantHolidays and Import-CsAutoAttendantHolidays cmdlet should be of the following format: + +`HolidayName,StartDateTime1,EndDateTime1,StartDateTime2,EndDateTime2,...,StartDateTime10,EndDateTime10` + +where + +- HolidayName is the name of the holiday to be imported. +- StartDateTimeX and EndDateTimeX specify a date/time range for the holiday and are optional. If no date-time ranges are defined, then the holiday is imported without any date/time ranges. They follow the same format as New-CsOnlineDateTimeRange cmdlet. +- EndDateTimeX is optional. If it is not specified, the end bound of the date time range is set to 00:00 of the day after the start date. + +- The first line of the CSV file is considered a header record and is always ignored by Import-CsAutoAttendantHolidays cmdlet. +- If the destination auto attendant for the import already contains a call flow or schedule by the same name as one of the holidays being imported, the corresponding CSV record is skipped. +- For holidays that are successfully imported, a default call flow is created which is configured without any greeting and simply disconnects the call on being executed. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$bytes = Export-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 +[System.IO.File]::WriteAllBytes("C:\Exports\Holidays.csv", $bytes) +``` + +In this example, the Export-CsAutoAttendantHolidays cmdlet is used to export holiday schedules of an auto attendant with Identity of 6abea1cd-904b-520b-be96-1092cc096432. The exported bytes are then written to a file with the path "C:\Exports\Holidays.csv". + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Export-CsAutoAttendantHolidays cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### System.Byte[] + +## NOTES + +## RELATED LINKS + +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) + +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Find-CsGroup.md b/teams/teams-ps/teams/Find-CsGroup.md new file mode 100644 index 0000000000..18c265455b --- /dev/null +++ b/teams/teams-ps/teams/Find-CsGroup.md @@ -0,0 +1,151 @@ +--- +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 +schema: 2.0.0 +--- + +# Find-CsGroup + +## SYNOPSIS +Use the Find-CsGroup cmdlet to search groups. + +## SYNTAX + +``` +Find-CsGroup [-Tenant <Guid>] -SearchQuery <String> [-MaxResults <UInt32>] [-ExactMatchOnly <Boolean>] [-MailEnabledOnly <Boolean>] +[-Force] [<CommonParameters>] +``` + +## DESCRIPTION +The Find-CsGroup cmdlet lets you search groups in the Azure Address Book Service (AABS). + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +Find-CsGroup -SearchQuery "ed0d1180-169e-47c7-b718-bf9e60543914" -ExactMatchOnly $true +``` + +This example finds and displays only those groups that are an exact match to the search query. + +## 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExactMatchOnly +The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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 +``` + +### -MaxResults +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailEnabledOnly +Instructs the cmdlet to return mail enabled only groups. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel +The Find-CsGroup cmdlet returns a list of Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel. Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel contains Id and DisplayName. + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..2744bd46e0 --- /dev/null +++ b/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md @@ -0,0 +1,178 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Find-CsOnlineApplicationInstance + +## SYNOPSIS +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. + +## SYNTAX + +``` +Find-CsOnlineApplicationInstance [-SearchQuery] <string> [[-MaxResults] <uint>] [-ExactMatchOnly] [-AssociatedOnly] [-UnAssociatedOnly] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. + +If MaxResults is not specified, the number of returned applications instances is limited to 10 application instances. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Find-CsOnlineApplicationInstance -SearchQuery "Test" +``` + +This example returns up to 10 application instances whose name starts with "Test". + +### -------------------------- Example 2 -------------------------- +```powershell +Find-CsOnlineApplicationInstance -SearchQuery "Test" -MaxResults 5 +``` + +This example returns up to 5 application instances whose name starts with "Test". + +### -------------------------- 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 -------------------------- +```powershell +Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -AssociatedOnly +``` + +This example returns up to 10 application instances whose name is "Test Auto Attendant", and who are associated with an application configuration, like auto attendant or call queue. + +## 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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExactMatchOnly +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 +Default value: None +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. + +```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 +``` + +### -UnAssociatedOnly +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: None +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. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.FindApplicationInstanceResult + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md b/teams/teams-ps/teams/Get-ALLM365TeamsApps.md new file mode 100644 index 0000000000..b3dd4967bb --- /dev/null +++ b/teams/teams-ps/teams/Get-ALLM365TeamsApps.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-ALLM365TeamsApps +applicable: Microsoft Teams +title: Get-ALLM365TeamsApps +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 04/24/2024 +schema: 2.0.0 +--- + +# Get-AllM365TeamsApps + +## SYNOPSIS + +This cmdlet returns all Microsoft Teams apps in the app catalog, including Microsoft, custom, and non-Microsoft apps. + +## SYNTAX + +```powershell +Get-AllM365TeamsApps [<CommonParameters>] +``` + +## DESCRIPTION + +Get-AllM365TeamsApps retrieves a complete list of all Teams apps in an organization, their statuses, and their availability information. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-AllM365TeamsApps +``` + +Returns a complete list of all Teams apps in an organization, their statuses, and their availability information. + +### Example 2 + +```powershell +PS C:\> Get-AllM365TeamsApps | Select-Object -Property Id, IsBlocked, AvailableTo -ExpandProperty AvailableTo +``` + +Returns a complete list of all Teams apps in an organization, their statuses, and their availability information in expanded format. + +### Example 3 + +```powershell +PS C:\> Get-AllM365TeamsApps | Select-Object -Property Id, IsBlocked, AvailableTo, InstalledFor -ExpandProperty InstalledFor +``` + +Returns a complete list of all Teams apps in an organization, their statuses, their availability and their installation information in expanded format. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +**Id** +Application ID of the Teams app. + +**IsBlocked** +The state of the app in the tenant. +Values: + +- Blocked +- Unblocked + +**AvailableTo** +Provides available to properties for the app. +Properties: + +- AssignmentType: App availability type. + Values: + - Everyone + - UsersandGroups + - Noone +- LastUpdatedTimestamp: Time and date when the app AvailableTo value was last updated. +- AssignedBy: UserID of the last user who updated the app available to value. + +**InstalledFor** +Provides installation status for the app. +Properties: + +- AppInstallType: App availability type. + Values: + - Everyone + - UsersandGroups + - Noone +- LastUpdatedTimestamp: Time and date when the app AvailableTo value was last updated. +- InstalledBy: UserID of the last user who installed the app available to value. +- InstalledSource: Source of Installation +- Version: Version of the app installed + +## NOTES + +## RELATED LINKS + +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) diff --git a/teams/teams-ps/teams/Get-AssociatedTeam.md b/teams/teams-ps/teams/Get-AssociatedTeam.md new file mode 100644 index 0000000000..2bc7566964 --- /dev/null +++ b/teams/teams-ps/teams/Get-AssociatedTeam.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-associatedteam +title: Get-AssociatedTeam +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-AssociatedTeam + +## SYNOPSIS +This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. + +## SYNTAX +```PowerShell +Get-AssociatedTeam [-User <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports retrieving all associated teams of a user, including teams which host shared channels. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-AssociatedTeam +``` + +Returns associated teams of the current user. + +### Example 2 +```PowerShell +Get-AssociatedTeam -user example@example.com +``` + +Returns associated teams of a given user email. + +### Example 3 +```PowerShell +Get-AssociatedTeam -user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 +``` + +Returns associated teams of a given user ID. + +## PARAMETERS + +### -User +User's UPN (user principal name, for example +johndoe@example.com) or user ID (for example 0e4249a7-6cfd-8c93-a510-91cda44c8c73). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### User + +## OUTPUTS + +### Team + +## NOTES + +## RELATED LINKS +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-SharedWithTeam](https://learn.microsoft.com/powershell/module/teams/get-team) diff --git a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..a3cd76b4a4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csapplicationaccesspolicy +applicable: Microsoft Teams +title: Get-CsApplicationAccessPolicy +schema: 2.0.0 +manager: zhengni +author: frankpeng7 +ms.author: frpeng +ms.reviewer: +--- + +# Get-CsApplicationAccessPolicy + +## SYNOPSIS + +Retrieves information about the application access policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsApplicationAccessPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsApplicationAccessPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet retrieves information about the application access policy configured for use in the tenant. + +## EXAMPLES + +### Retrieve all application access policies + +```powershell +PS C:\> Get-CsApplicationAccessPolicy +``` + +The command shown above returns information of all application access policies that have been configured for use in the tenant. + +### Retrieve specific application access policy + +```powershell +PS C:\> Get-CsApplicationAccessPolicy -Identity "ASimplePolicy" +``` + +In the command shown above, information is returned for a single application access policy: the policy with the Identity ASimplePolicy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) + +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) + +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csapplicationaccesspolicy) + +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md b/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md new file mode 100644 index 0000000000..0980ee7a04 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: yoren +ms.reviewer: +--- + +# Get-CsApplicationMeetingConfiguration + +## SYNOPSIS + +Retrieves information about the application meeting configuration settings configured for the tenant. + +## SYNTAX + +### Identity + +``` +Get-CsApplicationMeetingConfiguration [-Identity <XdsIdentity>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet retrieves information about the application meeting configuration settings configured for the tenant. + +## EXAMPLES + +### Retrieve application meeting configuration settings for the tenant. + +``` +PS C:\> Get-CsApplicationMeetingConfiguration +``` + +The command shown above returns application meeting configuration settings that have been configured for the tenant. + +## PARAMETERS + +### -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: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.WritableConfig.Settings.PlatformApplications.ApplicationMeetingConfiguration + +## NOTES + +## RELATED LINKS + +[Set-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csapplicationmeetingconfiguration) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendant.md b/teams/teams-ps/teams/Get-CsAutoAttendant.md new file mode 100644 index 0000000000..7fc22623fe --- /dev/null +++ b/teams/teams-ps/teams/Get-CsAutoAttendant.md @@ -0,0 +1,246 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsAutoAttendant + +## SYNOPSIS +Use the Get-CsAutoAttendant cmdlet to get information about your Auto Attendants (AA). + +## SYNTAX + +``` +Get-CsAutoAttendant [-Identity <String>] [-First <UInt32>] [-Skip <UInt32>] [-NameFilter <String>] [-SortBy <String>] [-Descending] [-IncludeStatus] [-ExcludeContent] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsAutoAttendant cmdlet returns information about the AAs in your organization. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsAutoAttendant +``` + +This example gets the first 100 auto attendants in the organization. + +### Example 2 +```powershell +Get-CsAutoAttendant -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" + +# Id : f7a821dc-2d69-5ae8-8525-bcb4a4556093 +# TenantId : 977c9d5b-2dae-5d82-aada-628bc1c14213 +# Name : Main Auto Attendant +# LanguageId : en-US +# VoiceId : Female +# DefaultCallFlow : Default Call Flow +# Operator : +# TimeZoneId : Pacific Standard Time +# VoiceResponseEnabled : False +# CallFlows : +# Schedules : +# CallHandlingAssociations : +# Status : +# DialByNameResourceId : +# DirectoryLookupScope : +# ApplicationInstances : {fa2f17ec-ebd5-43f8-81ac-959c245620fa, 56421bbe-5649-4208-a60c-24dbeded6f18, c7af9c3c-ae40-455d-a37c-aeec771e623d} +``` + +This example gets the AA that has the identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. + +### Example 3 +``` +Get-CsAutoAttendant -First 10 +``` + +This example gets the first ten auto attendants configured for use in the organization. + +### Example 4 +``` +Get-CsAutoAttendant -Skip 5 -First 10 +``` + +This example skips initial 5 auto attendants and gets the next 10 AAs configured in the organization. + +## PARAMETERS + +### -Identity +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: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -First +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NameFilter +If specified, only auto attendants whose names match that value would be returned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +If specified, the retrieved auto attendants would be sorted by the specified property. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Descending +If specified, the retrieved auto attendants would be sorted in descending order. + +```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 +``` + +### -IncludeStatus +If specified, the status records for each auto attendant in the result set are also retrieved. + +```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 +``` + +### -ExcludeContent +If specified, only auto attendants' names, identities and associated application instances will be retrieved. + +```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 + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Get-CsAutoAttendant cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) + +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) + +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) + +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) + +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md b/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md new file mode 100644 index 0000000000..92114b548b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md @@ -0,0 +1,141 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsAutoAttendantHolidays + +## SYNOPSIS +Use Get-CsAutoAttendantHolidays cmdlet to get the holiday information for an existing Auto Attendant (AA). + +## SYNTAX + +``` +Get-CsAutoAttendantHolidays [-Identity] <string> [-Force] [-Names <List[string]>] [-Years <List[int]>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsAutoAttendantHolidays provides a convenient way to visualize the information of all the holidays contained within an auto attendant. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +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 -------------------------- +``` +(Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas")).DateTimeRanges +``` + +In this example, the Get-CsAutoAttendantHolidays cmdlet is used to retrieve the DateTimeRanges for the holiday named Christmas in the year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Collections.Generic.List[System.String] +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: System.Collections.Generic.List[System.Int32] +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Get-CsAutoAttendantHolidays cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.HolidayVisRecord + +## NOTES +The DateTimeRanges parameter in the output needs to be explicitly referenced to show the value. See Example 4 for one way of doing it. + +## RELATED LINKS + +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) + +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md b/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md new file mode 100644 index 0000000000..69b5630115 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md @@ -0,0 +1,112 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsAutoAttendantStatus + +## SYNOPSIS +Use Get-CsAutoAttendantStatus cmdlet to get the status of an Auto Attendant (AA) provisioning. + +## SYNTAX + +``` +Get-CsAutoAttendantStatus -Identity <String> [-IncludeResources <List>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet provides a way to return the provisioning status of an auto attendant configured for use in your organization. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -IncludeResources @("AudioFile") +``` + +In Example 2, the Get-CsAutoAttendantStatus cmdlet is used to get status records pertaining to audio files only of an auto attendant with identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -IncludeResources +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. +- SipProvisioning: Indicates status for calling AA through its SIP (Primary) URI. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +Accepted values: AudioFile, DialByNameVoiceResponses, SipProvisioning +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: 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 + +### System.String +The Get-CsAutoAttendantStatus cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.StatusRecord + +## NOTES + +## RELATED LINKS + +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md new file mode 100644 index 0000000000..c6cb4253af --- /dev/null +++ b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsAutoAttendantSupportedLanguage + +## SYNOPSIS +The Get-CsAutoAttendantSupportedLanguage cmdlet gets languages that are supported by the Auto Attendant (AA) service. + +## SYNTAX + +``` +Get-CsAutoAttendantSupportedLanguage [-Identity <String>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsAutoAttendantSupportedLanguage cmdlet gets all languages (and their corresponding voices/speakers) that are supported by the AA service, or a specific language if its Identity is provided. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsAutoAttendantSupportedLanguage +``` + +This example gets all supported languages. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsAutoAttendantSupportedLanguage -Identity "en-US" +``` + +This example gets the language that the Identity parameter specifies (en-US). + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Get-CsAutoAttendantSupportedLanguage cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.Language + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md new file mode 100644 index 0000000000..1e0491d7e4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md @@ -0,0 +1,92 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsAutoAttendantSupportedTimeZone + +## SYNOPSIS +The Get-CsAutoAttendantSupportedTimeZone cmdlet gets supported time zones for the Auto Attendant (AA) service. + +## SYNTAX + +``` +Get-CsAutoAttendantSupportedTimeZone [-Identity <String>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsAutoAttendantSupportedTimeZone cmdlet gets all the time zones that the AA service supports, or a specific time zone if its Identity is provided. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsAutoAttendantSupportedTimeZone +``` + +This example gets all supported time zones. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsAutoAttendantSupportedTimeZone -Identity "Pacific Standard Time" +``` + +This example gets the timezone that the Identity parameter specifies (Pacific Standard Time). + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +### System.String +The Get-CsAutoAttendantSupportedTimeZone cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.TimeZone + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md b/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md new file mode 100644 index 0000000000..92a3a9bbc1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md @@ -0,0 +1,66 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsAutoAttendantTenantInformation + +## SYNOPSIS +Gets the default tenant information for Auto Attendant (AA) feature. + +## SYNTAX + +``` +Get-CsAutoAttendantTenantInformation [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsAutoAttendantTenantInformation cmdlet gets the default tenant information for Auto Attendant (AA) feature. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsAutoAttendantTenantInformation +``` + +Gets the default auto attendant information for the logged in tenant. + +## PARAMETERS + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.TenantInformation + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md new file mode 100644 index 0000000000..b9a3895727 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation +title: Get-CsBatchPolicyAssignmentOperation +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsBatchPolicyAssignmentOperation + +## SYNOPSIS + +This cmdlet is used to retrieve the status of batch policy assignment operations. + +## SYNTAX + +### Get (Default) +``` +Get-CsBatchPolicyAssignmentOperation [-Status <String>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get1 +``` +Get-CsBatchPolicyAssignmentOperation -Identity <String> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlets returns the status of all batch policy assignment operations for the last 30 days. If an operation ID is specified, the detailed status for that operation is returned including the status for each user in the batch. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-CsBatchPolicyAssignmentOperation +``` + +```output +OperationId OperationName OverallStatus CreatedTime CreatedBy +----------- ------------- ------------- ----------- --------- +e640a5c9-c74f-4df7-b62e-4b01ae878bdc Assigning Kiosk mtg Completed 1/30/2020 3:21:07 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +01b9b2b7-5dbb-487c-b4ea-887c7c66559c Assigning allow calling Completed 1/30/2020 3:55:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +47bbc636-365d-4441-af34-9e0eceb05ef1 Completed 1/30/2020 4:14:22 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +In this example, the status of all batch assignment operations is returned. + +### EXAMPLE 2 +```powershell +Get-CsBatchPolicyAssignmentOperation -OperationId 01b9b2b7-5dbb-487c-b4ea-887c7c66559c | fl +``` + +```output +OperationId : 01b9b2b7-5dbb-487c-b4ea-887c7c66559c +OperationName : Assigning allow calling +OverallStatus : Completed +CreatedBy : aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +CreatedTime : 1/30/2020 3:55:16 PM +CompletedTime : 1/30/2020 3:59:06 PM +CompletedCount : 3 +ErrorCount : 1 +InProgressCount : 0 +NotStartedCount : 0 +UserState : {f0d9c148-27c1-46f5-9685-544d20170ea1, cc05e18d-5fc0-4096-8461-ded64d7356e0, + bcff5b7e-8d3c-4721-b34a-63552a6a53f9} +``` + +In this example, the details of a specific operation are returned. + +### EXAMPLE 3 +```powershell +Get-CsBatchPolicyAssignmentOperation -OperationId 001141c3-1daa-4da1-88e9-66cc01c511e1 | Select -ExpandProperty UserState +``` + +```output +Id Result State +-- ------ ----- +f0d9c148-27c1-46f5-9685-544d20170ea1 Success Completed +cc05e18d-5fc0-4096-8461-ded64d7356e0 Success Completed +bcff5b7e-8d3c-4721-b34a-63552a6a53f9 User not found Completed +``` + +In this example, the UserState property is expanded to see the status of each user in the batch. In this example, one of the users was not found. + +## 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 + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### OperationId +The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation. + +### CompletedCount +The number of users in the batch for which the assignment has been completed (possibly with an error). + +### CompletedTime +The date and time when the operation was completed. + +### CreatedTime +The date and time when the operation was created. + +### ErrorCount +The number of users in the batch for which the assignment failed. + +### InProgressCount +The number of users in the batch for which the assignment is in progress. + +### NotStartedCount +The number of users in the batch for which the assignment has not yet been performed. + +### OperationId +The ID of the operation. + +### OperationName +The name of the operation, if one was specific when the operation was created. + +### OverallStatus +The overall status of the operations: NotStarted, InProgress, Complete + +### UserState +Contains the status for each user in the batch. + +**Id:** The ID of the user as specified when the batch was submitted. Either the user object ID (guid) or UPN/SIP/email. + +**result:** The result of the assignment operation for the user: Success or an error. Some common errors include: +- User not found. Check the ID or SIP address of the user to confirm it is correct. If the UPN or email address was used, but it does not match the SIP address, then the user will not be found. +- Multiple users found with a given SIP address. This is typically a result of on-prem to cloud sync. Check your directory and update the affected users. +- User invalid. If you are syncing users from on-prem to the cloud, some users might not have been synced properly and are in an invalid state. Check the sync status for the user. +- User ineligible for the policy or missing a necessary license. Check the documentation for the specific policy type being assigned to understand the requirements and update the user accordingly. +- The policy settings are incorrect. Check the documentation for the specific policy type being assigned to understand the requirements and update the policy accordingly. +- Unknown errors. In rare cases, there can be transient system errors that failed on all initial retry attempts during batch process. Resubmit these users in a separate batch. + +**state:** The status for the user: NotStarted, InProgress, Completed + +## NOTES + +## RELATED LINKS + +[New-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md b/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md new file mode 100644 index 0000000000..2fdd9166f2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus +title: Get-CsBatchTeamsDeploymentStatus +schema: 2.0.0 +--- + +# Get-CsBatchTeamsDeploymentStatus + +## SYNOPSIS + +This cmdlet is used to get the status of the batch deployment orchestration. + +## SYNTAX + +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId <String> + -InputObject <IConfigApiBasedCmdletsIdentity> + [<CommonParameters>] +``` + +## DESCRIPTION +After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. + +To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" +``` + +This command provides the status of the specified batch deployment orchestrationId. + +## PARAMETERS + +### OrchestrationId +This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Status of the orchestrationId + +Running: The orchestration is running. +Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. + +## NOTES + +## RELATED LINKS + +[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment) diff --git a/teams/teams-ps/teams/Get-CsCallQueue.md b/teams/teams-ps/teams/Get-CsCallQueue.md new file mode 100644 index 0000000000..9ea06bec8e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsCallQueue.md @@ -0,0 +1,190 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsCallQueue + +## SYNOPSIS +The Get-CsCallQueue cmdlet returns the identified Call Queues. + +## SYNTAX + +``` +Get-CsCallQueue [-Identity <Guid>] [-Tenant <Guid>] [-First <Int32>] [-Skip <Int32>] [-ExcludeContent <Switch>] [-Sort <String>] [-Descending <Switch>] [-NameFilter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsCallQueue cmdlet lets you retrieve information about the Call Queues in your organization. Call Queue output contains statistical data on the number of active calls that are in the queue. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsCallQueue +``` + +This example gets the first 100 call queues in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Call Queue exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +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 +``` + +### -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 +``` + +### -First +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 +Default value: 100 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The Skip parameter skips the first N call queues. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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 Call Queues + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The Sort parameter specifies the property used to sort. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: Name +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Descending +The Descending parameter sorts Call Queues in descending order + +```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 +``` + +### -NameFilter +The NameFilter parameter returns Call Queues where name contains specified string + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Identity +Represents the unique identifier of a Call Queue. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md b/teams/teams-ps/teams/Get-CsCallingLineIdentity.md new file mode 100644 index 0000000000..bbd56f2336 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsCallingLineIdentity.md @@ -0,0 +1,102 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsCallingLineIdentity + +## SYNOPSIS +Use the `Get-CsCallingLineIdentity` cmdlet to display the Caller ID policies for your organization. + +## SYNTAX + +### Identity (Default) +``` +Get-CsCallingLineIdentity [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsCallingLineIdentity [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the `Get-CsCallingLineIdentity` cmdlet to display the Caller ID policies for your organization. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Get-CsCallingLineIdentity +``` + +The example gets and displays the Caller ID policies for your organization. + +### Example 2 +``` +PS C:\> Get-CsCallingLineIdentity -Filter "tag:Sales*" +``` + +The example gets and displays the Caller ID policies with Identity starting with Sales. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the Caller ID policy. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The Filter parameter lets you insert a string through which your search results are filtered. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) + +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) + +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) + +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md new file mode 100644 index 0000000000..f2b7e131f9 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md @@ -0,0 +1,62 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsCloudCallDataConnection +online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection +schema: 2.0.0 +author: 2012ucp1544 +ms.author: uditagrawal +ms.reviewer: pbafna +manager: subadjat + +--- + +# Get-CsCloudCallDataConnection + +## SYNOPSIS +This cmdlet retrieves an already existing online call data connection. + +## SYNTAX + +```powershell +Get-CsCloudCallDataConnection [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet retrieves an already existing online call data connection. Output of this cmdlet contains a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsCloudCallDataConnection + +Token +----- +00000000-0000-0000-0000-000000000000 +``` + +Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. + +## RELATED LINKS + +[Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) +[New-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection) diff --git a/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..9d668b7749 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: Get-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +Get-CsComplianceRecordingForCallQueueTemplate [-Id <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-CsComplianceRecordingForCallQueueTemplate cmdlet to retrieve a Compliance Recording for Call Queues template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsComplianceRecordingForCallQueueTemplate +``` + +This example gets all Compliance Recording for Call Queue Templates in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Compliance Recording for Call Queue template with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Compliance Recording for Call Queue template exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Id +The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Get-CsDialPlan.md b/teams/teams-ps/teams/Get-CsDialPlan.md new file mode 100644 index 0000000000..f7d347abb0 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsDialPlan.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csdialplan +applicable: Microsoft Teams +title: Get-CsDialPlan +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsDialPlan + +## SYNOPSIS +Returns information about the dial plans used in your organization. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Get-CsDialPlan [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsDialPlan [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## 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-CsEffectiveTenantDialPlan.md b/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md new file mode 100644 index 0000000000..e7be699f75 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md @@ -0,0 +1,137 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsEffectiveTenantDialPlan + +## SYNOPSIS +Use the Get-CsEffectiveTenantDialPlan cmdlet to retrieve an effective tenant dial plan. + +## SYNTAX + +``` +Get-CsEffectiveTenantDialPlan [-Identity] <UserIdParameter> [-OU <OUIdParameter>] [-ResultSize <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsEffectiveTenantDialPlan cmdlet returns information about the effective tenant dial plan in an organization. +The returned effective Tenant Dial Plan contains the EffectiveTenantDialPlanName and the Normalization rules that are effective for the user while using +the EnterpriseVoice features. The EffectiveTenantDialPlanName is in the form TenantGUID_GlobalVoiceDialPlan_TenantDialPlan. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsEffectiveTenantDialPlan -Identity Vt1_User1 +``` + +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. + +```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 +``` + +### -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 +``` + +### -OU +**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. +Only objects that exist in the specified location are returned. + +```yaml +Type: OUIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +**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. +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. + +```yaml +Type: Int32 +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/Get-CsExportAcquiredPhoneNumberStatus.md b/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md new file mode 100644 index 0000000000..1571bfb68b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus +applicable: Microsoft Teams +title: Get-CsExportAcquiredPhoneNumberStatus +author: pavellatif +ms.author: pavellatif +ms.reviewer: +manager: roykuntz +schema: 2.0.0 +--- + +# Get-CsExportAcquiredPhoneNumberStatus + +## SYNOPSIS +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. + +## SYNTAX + +### Get-CsExportAcquiredPhoneNumberStatus (Default) +``` +Get-CsExportAcquiredPhoneNumberStatus -OrderId <String> [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet returns OrderId status from the respective [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) operation. The response will include the download link to the file if operation has been completed. + +By default, the download link will remain active for 1 hour. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsExportAcquiredPhoneNumberStatus -OrderId 0e923e2c-ab0e-4b7a-be5a-906be8c +``` +```output +Id : 0e923e2c-ab0e-4b7a-be5a-906be8c +CreatedAt : 2024-08-29 21:50:54Z +status : Success +DownloadLinkExpiry : 2024-08-29 22:51:17Z +DownloadLink : <link> +``` +This example displays the status of the export acquired phone numbers operation. The OrderId is the output from [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. The status contains the download link for the file along with expiry date. + +### Example 2 +```powershell +PS C:\> Get-CsExportAcquiredPhoneNumberStatus -OrderId $orderId +``` +```output +Id : 0e923e2c-ab0e-4b7a-be5a-906be8c +CreatedAt : 2024-08-29 21:50:54Z +status : Success +DownloadLinkExpiry : 2024-08-29 22:51:17Z +DownloadLink : <link> +``` +This example displays the status of the export acquired phone numbers operation with the use of a variable named "orderId". + +### Example 3 +```powershell +PS C:\> $order = Get-CsExportAcquiredPhoneNumberStatus -OrderId $orderId +PS C:\> $order +``` +```output +Id : 0e923e2c-ab0e-4b7a-be5a-906be8c +CreatedAt : 2024-08-29 21:50:54Z +status : Success +DownloadLinkExpiry : 2024-08-29 22:51:17Z +DownloadLink : <link> +``` +This example stores the [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) cmdlet status for the "orderId" in the variable "order". This will allow a quick view of the order status without typing the cmdlet again. + +## PARAMETERS + +### -OrderId +The orderId of the ExportAcquiredNumberStatus cmdlet. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISkypeTelephoneNumberMgmtGetExportAcquiredTelephoneNumbersResponse + +## NOTES +The cmdlet is available in Teams PowerShell module 6.1.0 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..6b5e5dfbaa --- /dev/null +++ b/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md @@ -0,0 +1,282 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy +applicable: Microsoft Teams +title: Get-CsExternalAccessPolicy +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsExternalAccessPolicy + +## SYNOPSIS +Returns information about the external access policies that have been configured for use in your organization. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Get-CsExternalAccessPolicy [-Tenant <Guid>] [-Include <PolicyFilter>] [-ApplicableTo <UserIdParameter>] + [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsExternalAccessPolicy [-Tenant <Guid>] [-Include <PolicyFilter>] [-ApplicableTo <UserIdParameter>] + [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +When you first configure Skype for Business Online your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Online organization or in your Active Directory Domain Services for on-premises deployments. + +For on-premises deployments, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +The Get-CsExternalAccessPolicy cmdlet provides a way for you to return information about all of the external access policies that have been configured for use in your organization. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-CsExternalAccessPolicy +``` + +Example 1 returns a collection of all the external access policies configured for use in your organization. +Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. + +### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) +``` +Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" +``` + +Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. +Because access policy Identities must be unique, this command will never return more than one item. + +### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +``` +Get-CsExternalAccessPolicy -Identity site:Redmond +``` + +Example 2 uses the Identity parameter to return the external access policy that has the Identity site:Redmond. +Because access policy Identities must be unique, this command will never return more than one item. + +### -------------------------- Example 3 -------------------------- +``` +Get-CsExternalAccessPolicy -Filter tag:* +``` + +The command shown in Example 3 uses the Filter parameter to return all of the external access policies that have been configured at the per-user scope; the parameter value "tag:*" limits returned data to those policies that have an Identity that begins with the string value "tag:". +By definition, any policy that has an Identity beginning with "tag:" is a policy that has been configured at the per-user scope. + +### -------------------------- Example 4 -------------------------- +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} +``` + +In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet are used to return all the external access policies that grant users federation access. +To do this, the Get-CsExternalAccessPolicy cmdlet is first used to return a collection of all the external access policies currently in use in the organization. +This collection is then piped to the Where-Object cmdlet, which selects only those policies where the EnableFederationAccess property is equal to True. + +### -------------------------- Example 5 -------------------------- +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} +``` + +The command shown in Example 5 returns the external access policies that meet two criteria: both federation access and public cloud access are allowed. +In order to perform this task, the command first uses the Get-CsExternalAccessPolicy cmdlet to return a collection of all the access policies in use in the organization. +That collection is then piped to the Where-Object cmdlet, which picks out only those policies that meet two criteria: the EnableFederationAccess property must be equal to True and the EnablePublicCloudAccess property must also be equal to True. +Only policies in which both EnableFederationAccess and EnablePublicCloudAccess are True will be returned and displayed on the screen. + +### -------------------------- EXAMPLE 6 -------------------------- +``` +Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" +``` + +In Example 6, the ApplicableTo parameter is used to return only the policies that can be assigned to the user "kenmyer@litwareinc.com". + +NOTE: The ApplicableTo parameter can only be used with Skype for Business Online; that's because, with Skype for Business Online, there might be policies that cannot be assigned to certain users due to licensing and/or country/region restrictions. + +NOTE: This command requires the Office 365 UsageLocation property to be configured for the user's Active Directory user account. + +## PARAMETERS + +### -Identity +Unique Identity assigned to the policy when it was created. +External access policies can be assigned at the global, site, or per-user scope. +To refer to the global instance use this syntax: -Identity global. +To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. +To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. + +Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. +To do a wildcard search for policies, use the Filter parameter instead. + +If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +**Below Content Applies To:** Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 + +Enables you to do a wildcard search for external access policies. +For example, to find all the policies configured at the site scope, use this Filter: + +`site:*` + +To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: + +`"S*".` + +Note that the Filter parameter can only be applied to the policy Identity. + +**Below Content Applies To:** Skype for Business Online + +Enables you to do a wildcard search for external access policies. +For example, to find all the policies configured at the per-user scope, use this Filter: + +`"tag:*"` + +To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: + +`"tag:S*"` + +Note that the Filter parameter can only be applied to the policy Identity. + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +NOTE: This parameter is not used with Skype for Business Online. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicableTo +Returns a list of the external access policies that can be assigned to the specified user. +For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: + +`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` + +The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. +This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. +For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. +If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. + +The ApplicableTo parameter applies only to Skype for Business Online. +This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Include +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly + +```yaml +Type: PolicyFilter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy + +## NOTES + +## RELATED LINKS + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md new file mode 100644 index 0000000000..015cc6cfd9 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment +title: Get-CsGroupPolicyAssignment +schema: 2.0.0 +--- + +# Get-CsGroupPolicyAssignment + +## SYNOPSIS + +This cmdlet is used to return group policy assignments. + +## SYNTAX + +```powershell +Get-CsGroupPolicyAssignment [-GroupId <String>] [-PolicyType <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlets returns group policy assignments. Optional parameters allow the results to be restricted to policies assigned to a specific group or policies of a specific type. + +## EXAMPLES + +### Example 1 +In this example, all group policy assignments are returned. + +```powershell +Get-CsGroupPolicyAssignment + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingBroadcastPolicy Vendor Live Events 1 10/25/2019 12:40:09 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +19b881b4-c54c-4075-b1e8-a6ce55b12818 TeamsMeetingPolicy Kiosk 2 11/1/2019 8:22:06 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +0c0c1b45-bfc9-4718-b8ae-291439ac6fa4 TeamsCallingPolicy AllowCalling 2 11/1/2019 10:51:43 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +19c4909c-7d34-4e1f-b736-47caa2205768 TeamsMeetingBroadcastPolicy Employees Events 2 11/4/2019 12:56:57 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy DisallowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +### Example 2 +In this example, only the policies assigned to a specific group are returned. + +```powershell +Get-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingBroadcastPolicy Vendor Live Events 1 10/25/2019 12:40:09 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy AllowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy kiosk 7 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +### Example 3 +In this example, only the policies of a specific type are returned. + +Get-CsGroupPolicyAssignment -PolicyType TeamsCallingPolicy + +```powershell +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +0c0c1b45-bfc9-4718-b8ae-291439ac6fa4 TeamsCallingPolicy AllowCalling 2 11/1/2019 10:51:43 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy AllowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +## PARAMETERS + +### -GroupId +The ID of a group whose policy assignments will be returned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyType +The policy type for which group policy assignments will be returned. +Possible values: + +ApplicationAccessPolicy +CallingLineIdentity +ExternalAccessPolicy +OnlineAudioConferencingRoutingPolicy +OnlineVoicemailPolicy +OnlineVoiceRoutingPolicy +TeamsAppSetupPolicy +TeamsAudioConferencingPolicy +TeamsCallHoldPolicy +TeamsCallingPolicy +TeamsCallParkPolicy +TeamsChannelsPolicy +TeamsComplianceRecordingPolicy +TeamsCortanaPolicy +TeamsEmergencyCallingPolicy +TeamsEmergencyCallRoutingPolicy +TeamsEnhancedEncryptionPolicy +TeamsEventsPolicy +TeamsFeedbackPolicy +TeamsFilesPolicy +TeamsIPPhonePolicy +TeamsMediaLoggingPolicy +TeamsMeetingBrandingPolicy +TeamsMeetingBroadcastPolicy +TeamsMeetingPolicy +TeamsMeetingTemplatePermissionPolicy +TeamsMessagingPolicy +TeamsMobilityPolicy +TeamsRoomVideoTeleConferencingPolicy +TeamsSharedCallingRoutingPolicy +TeamsShiftsPolicy +TeamsUpdateManagementPolicy +TeamsVdiPolicy +TeamsVideoInteropServicePolicy +TeamsVirtualAppointmentsPolicy +TenantDialPlan + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) + +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) + +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..15b1d9e69b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md @@ -0,0 +1,111 @@ +--- +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. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **Get-CsPhoneNumberAssignment** cmdlet to display information about one or more phone numbers. Detailed instructions on how to use the new cmdlet can be found at [Get-CsPhoneNumberAssignment](/powershell/module/teams/get-csphonenumberassignment?view=teams-ps) + +## SYNTAX + +### Assignment (Default) +```powershell +Get-CsHybridTelephoneNumber [-TelephoneNumber <string>] -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## 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-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md new file mode 100644 index 0000000000..bf831c5aa7 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Get-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# Get-CsInboundBlockedNumberPattern + +## SYNOPSIS +Returns a list of all blocked number patterns added to the tenant list. + +## SYNTAX + +### Identity (Default) +``` +Get-CsInboundBlockedNumberPattern [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsInboundBlockedNumberPattern [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet returns a list of all blocked number patterns added to the tenant list including Name, Description, Enabled (True/False), and Pattern for each. + +## EXAMPLES + +### Example 1 +```powershell +PS> Get-CsInboundBlockedNumberPattern +``` + +In this example, the *Get-CsInboundBlockedNumberPattern* cmdlet is called without any parameters in order to return all the blocked number patterns. + +### Example 2 +```powershell +PS> Get-CsInboundBlockedNumberPattern -Filter Block* +``` + +In this example, the *Get-CsInboundBlockedNumberPattern* cmdlet will return all the blocked number patterns which identity starts with Block. + +## PARAMETERS + +### -Filter +Enables you to limit the returned data by filtering on the Identity. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the blocked number patterns to return. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) + +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) + +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md new file mode 100644 index 0000000000..9f59ffa49a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: Get-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Get-CsInboundExemptNumberPattern + +## SYNOPSIS +Returns a specific or the full list of all number patterns exempt from call blocking. + +## SYNTAX + +### Identity (Default) +``` +Get-CsInboundBlockedNumberPattern [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsInboundBlockedNumberPattern [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet returns a specific or all exempt number patterns added to the tenant list for call blocking including Name, Description, Enabled (True/False), and Pattern for each. + +## EXAMPLES + +### Example 1 +```powershell +PS>Get-CsInboundExemptNumberPattern +``` +This returns all exempt number patterns. + +### Example 2 +```powershell +PS>Get-CsInboundExemptNumberPattern -Identity "Exempt1" +``` + +This returns the exempt number patterns with Identity Exempt1. + +### Example 3 +```powershell +PS>Get-CsInboundExemptNumberPattern -Filter "Exempt*" +``` + +This example returns the exempt number patterns with Identity starting with Exempt. + +## PARAMETERS + +### -Filter +Enables you to limit the returned data by filtering on Identity. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the exempt number pattern to be listed. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. + +## RELATED LINKS +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) + +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) + +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md b/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md new file mode 100644 index 0000000000..36129dc3a8 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md @@ -0,0 +1,165 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsMeetingMigrationStatus + +## SYNOPSIS +You use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. + +## SYNTAX +``` +Get-CsMeetingMigrationStatus [[-Identity] <UserIdParameter>] [-EndTime <DateTime>] [-StartTime <DateTime>] [-SummaryOnly] [-State <StateType>] [<CommonParameters>] +``` + +## DESCRIPTION +Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. + +You can use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsMeetingMigrationStatus -SummaryOnly +``` + +This example is used to get a summary status of all MMS migrations. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsMeetingMigrationStatus -Identity "ashaw@contoso.com" +``` + +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. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start date of the date range. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end date of the date range. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummaryOnly +Specified that you want a summary status of MMS migrations returned. + +```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 +``` + +### -State +With this parameter you can filter by migration state. Possible values are: + +- Pending +- InProgress +- Failed +- Succeeded + +```yaml +Type: StateType +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +CorrelationId : 849d3e3b-3e1d-465f-8dde-785aa9e3f856 +CreateDate : 2024-04-27T00:24:00.1442688Z +FailedMeeting : 0 +InvitesUpdate : 0 +LastMessage : +MigrationType : AllToTeams +ModifiedDate : 2024-04-27T00:24:00.1442688Z +RetryCount : 0 +State : Pending +SucceededMeeting : 0 +TotalMeeting : 0 +UserId : 27c6ee67-c71d-4386-bf84-ebfdc7c3a171 +UserPrincipalName : syntest1-prod@TESTTESTMMSSYNTHETICUSWESTT.onmicrosoft.com + +where **MigrationType** can have the following values: + +- **SfbToTeams** (Skype for Business On-prem to Teams) +- **TeamsToTeams** (Teams to Teams) +- **ToSameType** (Same source and target meeting types) +- **AllToTeams** (All types to Teams) + +## RELATED LINKS +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) + +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) + +[Start-CsExMeetingMigration](https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..c153103192 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance +applicable: Microsoft Teams +title: Get-CsOnlineApplicationInstance +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineApplicationInstance + +## SYNOPSIS +Get application instance for the tenant from Microsoft Entra ID. + +## SYNTAX + +``` +Get-CsOnlineApplicationInstance [[-Identity] <string>] [[-Identities] <string>] [[-ResultSize] <int>] [[-Skip] <int>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is used to get details of an application instance. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com +``` + +This example returns the application instance with identity "appinstance01@contoso.com". +### -------------------------- Example 2 -------------------------- +```powershell +Get-CsOnlineApplicationInstance -Identities appinstance01@contoso.com,appinstance02@contoso.com +``` + +This example returns the application instance with identities "appinstance01@contoso.com" and "appinstance02@contoso.com". Query with multiple comma separated Identity. + +### -------------------------- Example 3 -------------------------- +```powershell +Get-CsOnlineApplicationInstance -ResultSize 10 +``` + +This example returns the first 10 application instances. + +### -------------------------- Example 4 -------------------------- +```powershell +Get-CsOnlineApplicationInstance +``` + +This example returns the details of all application instances. + +## PARAMETERS + +### -Identity +The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identities +The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The result size for bulk get. This parameter is currently not working. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md new file mode 100644 index 0000000000..f837f328ee --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation +applicable: Microsoft Teams +title: Get-CsOnlineApplicationInstanceAssociation +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineApplicationInstanceAssociation + +## SYNOPSIS +Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information about the associations setup in your organization. + +## SYNTAX + +``` +Get-CsOnlineApplicationInstanceAssociation -Identity <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information about the associations setup between online application instances and the application configurations, like auto attendants and call queues. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Get-CsOnlineApplicationInstanceAssociation -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" +``` + +This example gets the association object for the application instance that has the identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Get-CsOnlineApplicationInstanceAssociation cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.ApplicationInstanceAssociation + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) + +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) + +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md new file mode 100644 index 0000000000..bf4db93e15 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus +applicable: Microsoft Teams +title: Get-CsOnlineApplicationInstanceAssociationStatus +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineApplicationInstanceAssociationStatus + +## SYNOPSIS +Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get the provisioning status for the associations you have setup in your organization. + +## SYNTAX + +``` +Get-CsOnlineApplicationInstanceAssociationStatus -Identity <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get provisioning status for the associations you have setup between online application instances and the application configurations, like auto attendants and call queues. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Get-CsOnlineApplicationInstanceAssociationStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" +``` + +This example gets the provisioning status for the association object of the application instance that has the identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Get-CsOnlineApplicationInstanceAssociationStatus cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.StatusRecord + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) + +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) + +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..e2a5e510e0 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,120 @@ +--- +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] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] + [<CommonParameters>] +``` + +## 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/teams/Get-CsOnlineAudioFile.md new file mode 100644 index 0000000000..65d7fc94b4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineAudioFile.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile +applicable: Microsoft Teams +title: Get-CsOnlineAudioFile +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: + +--- + +# Get-CsOnlineAudioFile + +## SYNOPSIS +Returns information about a specific or all uploaded audio files of a given application type. + +## SYNTAX + +```powershell +Get-CsOnlineAudioFile [[-Identity] <string>] [-ApplicationId <OrgAutoAttendant | HuntGroup | TenantGlobal>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet returns information on a specific or all uploaded audio files of a given application type. If you are not specifying any parameters you will get information of all uploaded audio files with ApplicationId = TenantGlobal. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsOnlineAudioFile + +``` +```Output +Id : 85364afb59a143fc9466979e0f34f749 +FileName : CustomMoH.mp3 +ApplicationId : TenantGlobal +MarkedForDeletion : False +``` +This returns information about all uploaded audio files with ApplicationId = TenantGlobal. + +### Example 2 +```powershell +Get-CsOnlineAudioFile -ApplicationId HuntGroup -Identity dcfcc31daa9246f29d94d0a715ef877e + +``` +```Output +Id : dcfcc31daa9246f29d94d0a715ef877e +FileName : SupportCQ.mp3 +ApplicationId : HuntGroup +MarkedForDeletion : False +``` +This cmdlet returns information about the audio file with Id dcfcc31daa9246f29d94d0a715ef877e and with ApplicationId = HuntGroup. + +### Example 3 +```powershell +Get-CsOnlineAudioFile -ApplicationId OrgAutoAttendant + +``` +```Output +Id : 58083ae8bc9e4a66a6b2810b2e1f4e4e +FileName : MainAAAnnouncement.mp3 +ApplicationId : OrgAutoAttendant +MarkedForDeletion : False +``` +This cmdlet returns information about all uploaded audio files with ApplicationId = OrgAutoAttendant. + +## PARAMETERS + +### -ApplicationId +The ApplicationId parameter specifies the identifier for the application that was specified when audio file was uploaded. For example, if the audio file is used with an auto attendant, then it should specified as "OrgAutoAttendant". +If the audio file is used with a hunt group (call queue), then it needs to be specified as "HuntGroup". If the audio file is used for music on hold, the it needs to specified as "TenantGlobal". + +If you are not specifying an ApplicationId it is assumed to be TenantGlobal. + +Supported values: + +- OrgAutoAttendant +- HuntGroup +- TenantGlobal + +```yaml +Type: System.string +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TenantGlobal +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific audio file that you would like to see information about. If you are only specifying -Identity, the -ApplicationId it is assumed to be TenantGlobal. + +If you need to see the information of a specific audio file with ApplicationId of OrgAutoAttendant or HuntGroup, you need to specify -ApplicationId with the corresponding value and -Identity with the Id of the audio file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.4.0-preview or later. + +If you call the cmdlet without having uploaded any audio files, with a non-existing Identity or with an illegal ApplicationId, you will receive a generic error message. In addition, the ApplicationId is case sensitive. + +## RELATED LINKS +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md similarity index 87% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md index 433113d966..8668124a9a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingBridge schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingBridge @@ -37,20 +42,19 @@ However, if the PSTN conferencing service status of the tenant is Disabled, no r ## EXAMPLES ### -------------------------- 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 -------------------------- -``` +```powershell Get-CsOnlineDialInConferencingBridge -Tenant 26efe125-c070-46f9-8ed0-fc02165a167c ``` This example shows how to return all of the audio conferencing bridges for the given tenant. - ## PARAMETERS ### -Identity @@ -59,7 +63,7 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -75,7 +79,7 @@ Specifies the name of the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -89,11 +93,11 @@ Accept wildcard characters: False Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: -Fully qualified domain name (FQDN): +Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com` -Computer name: +Computer name: `-DomainController atl-cs-001` @@ -120,7 +124,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -136,7 +140,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -152,23 +156,7 @@ 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 -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -179,21 +167,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### None - ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md similarity index 83% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md index 3791b8e9a9..b8c773dd60 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingLanguagesSupported schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingLanguagesSupported @@ -26,14 +31,12 @@ When no languages are specified for a dial-in service number it will get the set ## EXAMPLES ### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDialInConferencingLanguagesSupported |fl +```powershell +Get-CsOnlineDialInConferencingLanguagesSupported | fl ``` This example allows returns the list of supported languages when you are using Microsoft as your dial-in audio conferencing provider and displays them in a formatted list. - - ## PARAMETERS ### -DomainController @@ -65,23 +68,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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -92,7 +79,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -101,4 +88,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md similarity index 79% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md index ce0f0895ef..daa9adb621 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingServiceNumber schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingServiceNumber @@ -70,7 +75,6 @@ Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" This example returns all of the default service numbers for the audio conferencing bridge named "Conference Bridge". - ## PARAMETERS ### -BridgeId @@ -80,8 +84,8 @@ When it's used it returns all of the service numbers that are configured on the ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -96,8 +100,8 @@ Specifies the default dial-in service number string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -112,8 +116,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -128,8 +132,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -145,8 +149,8 @@ When it is used it returns all of the service numbers that are configured on the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -162,8 +166,8 @@ When used it lists all of the service numbers for a specific city geocode. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -184,7 +188,7 @@ Computer name: `-DomainController atl-cs-001` Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -201,8 +205,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -223,28 +227,8 @@ If you set the ResultSize to 7 but you have only three users in your forest, the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -254,7 +238,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -263,4 +247,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md new file mode 100644 index 0000000000..5f1ea406de --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings +applicable: Microsoft Teams +title: Get-CsOnlineDialInConferencingTenantSettings +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineDialInConferencingTenantSettings + +## SYNOPSIS +Use the Get-CsOnlineDialInConferencingTenantSettings cmdlet to retrieve tenant level settings for dial-in conferencing. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlineDialInConferencingTenantSettings [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineDialInConferencingTenantSettings [-Tenant <Guid>] [-Filter <String>] [-LocalStore] + [<CommonParameters>] +``` + +## DESCRIPTION + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineDialInConferencingTenantSettings +``` + +This example returns the global setting for the tenant administrator's organization. + +## PARAMETERS + +### -Filter +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.WritableConfig.Settings.OnLineDialInConferencing.OnLineDialInConferencingTenantSettings + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md new file mode 100644 index 0000000000..7c7a3686cb --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md @@ -0,0 +1,271 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineDialInConferencingUser + +## SYNOPSIS +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. + +## SYNTAX + +``` +Get-CsOnlineDialInConferencingUser [-BridgeName <String>] [-ServiceNumber <String>] [-TenantDomain <String>] + [-LdapFilter <String>] [[-Identity] <UserIdParameter>] [-Tenant <Guid>] [-BridgeId <Guid>] [-ResultSize <Int32>] + [-DomainController <Fqdn>] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will only return users that have been enabled for audio conferencing using Microsoft as the audio conferencing provider. +Users that are enabled for audio conferencing using a third-party audio conferencing provider won't be returned. +If there are no users in the organization that have been enabled for audio conferencing, then the cmdlet will return no results. + +The see a list of users with conferencing providers other than Microsoft use the Get-CsUserAcp cmdlet. + +**NOTE**: In the Teams PowerShell Module version 3.0 or later, the following input parameters have been deprecated for TeamsOnly customers (removed or very low usage): + +- BridgeId +- BridgeName +- DomainController +- Force +- LdapFilter +- ServiceNumber +- TenantDomain +- Common Parameters + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CsOnlineDialInConferencingUser -Identity Ken.Myer@contoso.com +``` + +This example uses the User Principal Name (UPN) to retrieve the BridgeID and ServiceNumber information. + +## PARAMETERS + +### -BridgeId + +*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. + +```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 +``` + +### -BridgeName + +*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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +``` + +### -ServiceNumber + +*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, +\<E.164 number\> and tel:\<E.164 number\>. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +*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. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: DC +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +*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. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapFilter + +*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). +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: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. +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: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. + +NOTE: This parameter is reserved for internal Microsoft use. + +Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. +For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". +You can find your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantDomain + +*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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md b/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md new file mode 100644 index 0000000000..050f8fa643 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md @@ -0,0 +1,100 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineDialOutPolicy + +## SYNOPSIS +Use the `Get-CsOnlineDialOutPolicy` cmdlet to get all the available outbound calling restriction policies in your organization. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlineDialOutPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineDialOutPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +In Microsoft Teams, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. The policies apply to all the different PSTN connectivity options for Microsoft Teams; Calling Plan, Direct Routing, and Operator Connect. + +To get all the available policies in your organization run `Get-CsOnlineDialOutPolicy`. +To assign one of these policies to a user run `Grant-CsDialoutPolicy`. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsOnlineDialOutPolicy +``` + +In Example 1, `Get-CsOnlineDialOutPolicy` is called without any additional parameters; this returns a collection of all the outbound calling restriction policies configured for use in your organization. + +### Example 2 +```powershell +Get-CsOnlineDialOutPolicy -Identity DialoutCPCandPSTNDisabled +``` + +In Example 2, `Get-CsOnlineDialOutPolicy` is used to return the per-user outbound calling restriction policy that has an Identity DialoutCPCandPSTNDisabled. Because identities are unique, this command will never return more than one item. + +## 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: True +``` + +### -Identity +Unique identifier of the outbound calling restriction 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 DialoutCPCandPSTNDisabled. + +If this parameter is omitted, then all the outbound calling restriction policies configured for use in your tenant will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Grant-CsDialoutPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md new file mode 100644 index 0000000000..44a0e83fd6 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingpolicy +applicable: Microsoft Teams +title: Get-CsOnlineDialinConferencingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineDialinConferencingPolicy + +## SYNOPSIS +Retrieves the available Dial-in Conferencing policies in the tenant. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlineDialinConferencingPolicy [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineDialinConferencingPolicy [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the available Dial-in Conferencing policies in the tenant. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineDialinConferencingPolicy +``` + +This example retrieves all the available Dial in Conferencing policies in the tenant. + +## 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: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Reserved for Microsoft Internal use. + +```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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md new file mode 100644 index 0000000000..7c1dbe713c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantconfiguration +applicable: Microsoft Teams +title: Get-CsOnlineDialinConferencingTenantConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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 + +### Identity (Default) +``` +Get-CsOnlineDialinConferencingTenantConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] + [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineDialinConferencingTenantConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] + [<CommonParameters>] +``` + +## DESCRIPTION +The dial-in conferencing configuration specifies only if dial-in conferencing is enabled for the tenant. +By contrast, the dial-in conferencing tenant settings specify what functions are available during a conference call. +For example, whether or not entries and exits from the call are announced. +The settings also manage some of the administrative functions, such as when users get notification of administrative actions, like a PIN change. +For more information on settings and their customization, see Set-CsOnlineDialInConferencingTenantSettings. + +This cmdlet currently displays only the enabled or disabled status of your tenant configuration. +There is one configuration per tenant. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineDialinConferencingTenantConfiguration +``` + +This example returns the configuration for the tenant administrator's organization. + +## PARAMETERS + +### -Filter +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.WritableConfig.Settings.OnLineDialInConferencing.OnLineDialInConferencingTenantConfiguration + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md b/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md new file mode 100644 index 0000000000..35a0ee1afb --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedirectorytenant +applicable: Microsoft Teams +title: Get-CsOnlineDirectoryTenant +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineDirectoryTenant + +## SYNOPSIS +Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve a tenant and associated parameters from the Business Voice Directory. + +## SYNTAX +``` +Get-CsOnlineDirectoryTenant [[-Tenant] <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +**Note**: Starting with Teams PowerShell Module 4.0, this cmdlet will be deprecated. Use the Get-CsTenant or Get-CsOnlineDialInConferencingBridge cmdlet to view information previously present in Get-CsOnlineDirectoryTenant. + +Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve tenant parameters like AnnouncementsDisabled, NameRecordingDisabled and Bridges from the Business Voice Directory. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5 +``` + +This example returns the tenant specified by GUID. + +## PARAMETERS + +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: DC +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: 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` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacTenant + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md new file mode 100644 index 0000000000..4c7b04e076 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -0,0 +1,135 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineEnhancedEmergencyServiceDisclaimer + +## SYNOPSIS +Use the Get-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. + +## SYNTAX + +``` +Get-CsOnlineEnhancedEmergencyServiceDisclaimer [-CountryOrRegion <CountryInfo>] [-DomainController <Fqdn>] [-Force] [-Tenant <Guid>] [-Version <String>] [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. The United States is currently the only country supported. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion "US" +``` + +This example returns your organization's enhanced emergency service terms and conditions acceptance status. + +## PARAMETERS + +### -CountryOrRegion +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". + +```yaml +Type: CountryInfo +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS +[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md new file mode 100644 index 0000000000..3a889df518 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md @@ -0,0 +1,265 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineLisCivicAddress + +## SYNOPSIS +Use the Get-CsOnlineLisCivicAddress cmdlet to retrieve information about existing emergency civic addresses defined in the Location Information Service (LIS). + +## SYNTAX + +``` +Get-CsOnlineLisCivicAddress [-AssignmentStatus <string>] [-City <string>] [-CivicAddressId <guid>] [-CountryOrRegion <string>] +[-Description <string>] [-Force] [-LocationId <guid>] [-NumberOfResultsToSkip <int>] [-PopulateNumberOfTelephoneNumbers] [-PopulateNumberOfVoiceUsers] +[-ResultSize <long>] [-ValidationStatus <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns one or more emergency civic addresses. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsOnlineLisCivicAddress -CivicAddressId 235678321ee38d9a5-33dc-4a32-9fb8-f234cedb91ac +``` + +This example returns the civic address with the specified identification. + +### Example 2 +```powershell +Get-CsOnlineLisCivicAddress -City Seattle +``` + +This example returns all the civic addresses in the city of Seattle. + +## PARAMETERS + +### -AssignmentStatus + +**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. +Valid inputs are "Assigned", or "Unassigned". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +Specifies the city of the target civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CivicAddressId +Specifies the identity of the civic address to return. + +```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 +``` + +### -CountryOrRegion +Specifies the country or region of the target civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the administrator defined description of the target civic address. + +```yaml +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 +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfResultsToSkip +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. +For example the command below will return civic addresses 26-50 for Seattle. + +\`Get-CsOnlineLisCivicAddress -City Seattle -ResultSize 25 -NumberOfResultsToSkip 25\` + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopulateNumberOfTelephoneNumbers +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 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopulateNumberOfVoiceUsers +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 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +Specifies the maximum number of results to return. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationStatus +Specifies the validation status of the addresses to be returned. +Valid inputs are: Valid, Invalid, and Notvalidated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) + +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) + +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md b/teams/teams-ps/teams/Get-CsOnlineLisLocation.md new file mode 100644 index 0000000000..2fb1346e9a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineLisLocation.md @@ -0,0 +1,322 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineLisLocation + +## SYNOPSIS +Use the Get-CsOnlineLisLocation cmdlet to retrieve information on previously defined locations in the Location Information Service (LIS.) + +## SYNTAX + +### GetByLocationID (Default) +``` +Get-CsOnlineLisLocation [-AssignmentStatus <string>] [-City <string>] [-CountryOrRegion <string>] [-Description <string>] [-Force] + [-NumberOfResultsToSkip <int>] [-PopulateNumberOfTelephoneNumbers] [-PopulateNumberOfVoiceUsers] [-ResultSize <long>] [-ValidationStatus <string>] + [<CommonParameters>] +``` + +### UseCivicAddressId +``` +Get-CsOnlineLisLocation -CivicAddressId <guid> [-AssignmentStatus <string>] [-City <string>] [-CountryOrRegion <string>] [-Description <string>] + [-Force] [-NumberOfResultsToSkip <int>] [-PopulateNumberOfTelephoneNumbers] [-PopulateNumberOfVoiceUsers] [-ResultSize <long>] + [-ValidationStatus <string>] [<CommonParameters>] +``` + +### UseLocation +``` +Get-CsOnlineLisLocation -Location <string> [-AssignmentStatus <string>] [-City <string>] [-CountryOrRegion <string>] [-Description <string>] + [-Force] [-NumberOfResultsToSkip <int>] [-PopulateNumberOfTelephoneNumbers] [-PopulateNumberOfVoiceUsers] [-ResultSize <long>] + [-ValidationStatus <string>] [<CommonParameters>] +``` + +### UseLocationId +``` +Get-CsOnlineLisLocation [-AssignmentStatus <string>] [-City <string>] [-CountryOrRegion <string>] [-Description <string>] [-Force] + [-NumberOfResultsToSkip <int>] [-PopulateNumberOfTelephoneNumbers] [-PopulateNumberOfVoiceUsers] [-ResultSize <long>] [-ValidationStatus <string>] + [-LocationId <guid>] [<CommonParameters>] +``` + +## DESCRIPTION + +## EXAMPLES + +### Example 1 +``` +Get-CsOnlineLisLocation -City Seattle -ResultSize 25 -ValidationStatus Validated +``` + +This example returns a maximum of 25 validated locations in Seattle. + +### Example 2 +``` +Get-CsOnlineLisLocation -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 +``` + +This example returns the locations associated with a civic address specified by its unique identifier. + +### Example 3 +``` +Get-CsOnlineLisLocation -Location "3rd Floor Cafe" +``` + +This example returns the location described as the "3rd Floor Cafe". + +### Example 4 +``` +Get-CsOnlineLisLocation -LocationId 5aa884e8-d548-4b8e-a289-52bfd5265a6e +``` + +This example returns the information on one location specified by its unique identifier. + +## PARAMETERS + +### -CivicAddressId +Specifies the identification number of the civic address that is associated with the target locations. + +```yaml +Type: Guid +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Location +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: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignmentStatus + +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. + +Specifies whether the retrieved locations have been assigned to users or not. +Valid inputs are "Assigned", or "Unassigned". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +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: True +Accept wildcard characters: False +``` + +### -CountryOrRegion +Specifies the country or region of the target location. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +Specifies the unique identifier of the target location. + +```yaml +Type: Guid +Parameter Sets: UseLocationId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -NumberOfResultsToSkip +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. +For example the command below will return locations 26-50 for Seattle. + +\`Get-CsOnlineLisLocation -City Seattle -ResultSize 25 -NumberOfResultsToSkip 25\` + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopulateNumberOfTelephoneNumbers +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 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopulateNumberOfVoiceUsers +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 +Default value: False +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ResultSize +Specifies the maximum number of results to return. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationStatus +Specifies the validation status of the addresses to be returned. +Valid inputs are: Validated, Invalid, and Notvalidated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Returns an instance, or instances of emergency location objects. + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) + +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) + +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisPort.md b/teams/teams-ps/teams/Get-CsOnlineLisPort.md new file mode 100644 index 0000000000..190850463c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineLisPort.md @@ -0,0 +1,172 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +``` +Get-CsOnlineLisPort [[-ChassisID] <string>] [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] [-PortID <string>] [-TargetStore <string>] [<CommonParameters>] +``` + +## DESCRIPTION +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 + +### Example 1 +``` +Get-CsOnlineLisPort +``` +```output +PortID ChassisID LocationId Description +------ --------- ---------- ----------- +G1/0/30 B8-BE-BF-4A-A3-00 9905bca0-6fb0-11ec-84a4-25019013784a +S2/0/25 F6-26-79-B5-3D-49 d7714269-ee52-4635-97b0-d7c228801d24 +``` + +Example 1 retrieves all Location Information Server (LIS) ports and any associated locations. + +### Example 2 +``` +Get-CsOnlineLisPort -ChassisID 'B8-BE-BF-4A-A3-00' -PortID 'G1/0/30' +``` +```output +PortID ChassisID LocationId Description +------ --------- ---------- ----------- +G1/0/30 B8-BE-BF-4A-A3-00 9905bca0-6fb0-11ec-84a4-25019013784a +``` + +Example 2 retrieves the location information for port G1/0/30 with ChassisID B8-BE-BF-4A-A3-00. + +## PARAMETERS + +### -ChassisID +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortID +This parameter identifies the ID of the port. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) + +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md b/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md new file mode 100644 index 0000000000..7aff6725b1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md @@ -0,0 +1,167 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +``` +Get-CsOnlineLisSubnet [[-TenantId] <Guid>] [[-Subnet] <String>] [-IsDebug <Boolean>] [-TargetStore <String>] + [-NCSApiUrl <String>] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +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 subnet through which calls are routed. + +The location ID which is associating with the subnet is not required to be the existing location. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineLisSubnet +``` + +Example 1 retrieves all Location Information Server (LIS) subnets. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsOnlineLisSubnet -Subnet 10.106.89.12 +``` + +Example 2 retrieves the Location Information Server (LIS) subnet for Subnet ID "10.106.89.12". + +### -------------------------- Example 3 -------------------------- +``` +Get-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e +``` + +Example 2 retrieves the Location Information Server (LIS) subnet for Subnet ID "2001:4898:e8:6c:90d2:28d4:76a4:ec5e". + +## PARAMETERS + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md b/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md new file mode 100644 index 0000000000..c5be65a3ec --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md @@ -0,0 +1,156 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +``` +Get-CsOnlineLisSwitch [[-ChassisID] <string>] [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] [-TargetStore <string>] [<CommonParameters>] +``` + +## DESCRIPTION +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 + +### Example 1 +``` +Get-CsOnlineLisSwitch +``` +```output +ChassisID LocationId Description +--------- ---------- ----------- +B8-BE-BF-4A-A3-00 9905bca0-6fb0-11ec-84a4-25019013784a DKSwitch1 +F6-26-79-B5-3D-49 d7714269-ee52-4635-97b0-d7c228801d24 USSwitch1 +``` + +Example 1 retrieves all Location Information Server (LIS) switches and any associated locations. + +### Example 2 +``` +Get-CsOnlineLisSwitch -ChassisID B8-BE-BF-4A-A3-00 +``` +```output +ChassisID LocationId Description +--------- ---------- ----------- +B8-BE-BF-4A-A3-00 9905bca0-6fb0-11ec-84a4-25019013784a DKSwitch1 +``` + +Example 2 retrieves Location Information Server (LIS) switch "B8-BE-BF-4A-A3-00" and associated location. + +## PARAMETERS + +### -ChassisID +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) + +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md new file mode 100644 index 0000000000..a8526f7ab2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md @@ -0,0 +1,183 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +``` +Get-CsOnlineLisWirelessAccessPoint [[-BSSID] <string>] [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] [-TargetStore <string>] [<CommonParameters>] +``` + +## DESCRIPTION +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). + +If a BSSID with a wildcard format is already exists, a location request with a WAP which is within this wildcard range will return the access point that is configured with the wildcard format. + +## EXAMPLES + +### Example 1 +``` +Get-CsOnlineLisWirelessAccessPoint +``` +```output +BSSID LocationId Description +----- ---------- ----------- +F0-6E-0B-C2-03-23 d7714269-ee52-4635-97b0-d7c228801d24 USWAP1 +34-E3-80-D5-AB-60 9905bca0-6fb0-11ec-84a4-25019013784a DKWAP1 +F0-6E-0B-C2-03-* b2804a1a-e4cf-47df-8964-3eaf6fe1ae3a SEWAPs +``` + +Example 1 retrieves all Location Information Server (LIS) wireless access points and any associated locations. + +### Example 2 +``` +Get-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-03-23 +``` +```output +BSSID LocationId Description +----- ---------- ----------- +F0-6E-0B-C2-03-23 d7714269-ee52-4635-97b0-d7c228801d24 USWAP1 +``` + +Example 2 retrieves Location Information Server (LIS) wireless access point "F0-6E-0B-C2-03-23" and associated location. + +### Example 3 +``` +Get-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-03-* +``` +```output +BSSID LocationId Description +----- ---------- ----------- +F0-6E-0B-C2-03-* b2804a1a-e4cf-47df-8964-3eaf6fe1ae3a SEWAPs +``` + +Example 3 retrieves Location Information Server (LIS) wireless access point "F0-6E-0B-C2-03-*" and associated location. + +### Example 4 +``` +Get-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-03-12 +``` +```output +BSSID LocationId Description +----- ---------- ----------- +F0-6E-0B-C2-03-* b2804a1a-e4cf-47df-8964-3eaf6fe1ae3a SEWAPs +``` + +Example 4 retrieves Location Information Server (LIS) wireless access point "F0-6E-0B-C2-03-12" and associated location. + +## PARAMETERS + +### -BSSID +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) + +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md new file mode 100644 index 0000000000..c7574f56ce --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md @@ -0,0 +1,99 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlinePSTNGateway + +## SYNOPSIS +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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlinePSTNGateway [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlinePSTNGateway [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to show the configuration of the previously created Session Border Controller(s) (SBC(s)) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter set to $false, the SBC will continue existing calls, bit all new calls routed to another SBC in a route (if exists). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsOnlinePSTNGateway +``` + +This example shows all SBCs paired with the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsOnlinePSTNGateway -Filter "*.contoso.com" +``` + +This example selects all SBCs with identities matching the pattern *.contoso.com, such as sbc1.contoso.com and sbc2.contoso.com. + +## PARAMETERS + +### -Filter + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) + +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) + +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md b/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md new file mode 100644 index 0000000000..c70a50caf0 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md @@ -0,0 +1,90 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlinePstnUsage + +## SYNOPSIS +Returns information about online public switched telephone network (PSTN) usage records used in your tenant. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlinePstnUsage [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlinePstnUsage [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Online PSTN usages are string values that are used for call authorization. An online PSTN usage links an online voice policy to a route. The `Get-CsOnlinePstnUsage` cmdlet retrieves the list of all online PSTN usages available within a tenant. + +This cmdlet is used when configuring Microsoft Phone System Direct Routing. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CSOnlinePSTNUsage +``` + +This command returns the list of global PSTN usages available within the tenant. + +## PARAMETERS + +### -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. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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: 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-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage) diff --git a/teams/teams-ps/teams/Get-CsOnlineSchedule.md b/teams/teams-ps/teams/Get-CsOnlineSchedule.md new file mode 100644 index 0000000000..9b0227da05 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineSchedule.md @@ -0,0 +1,81 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineSchedule + +## SYNOPSIS +Use the Get-CsOnlineSchedule cmdlet to get information about schedules that belong to your organization. + +## SYNTAX + +``` +Get-CsOnlineSchedule -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsOnlineSchedule cmdlet returns information about the schedules in your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineSchedule +``` + +This example retrieves all schedules that belong to your organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsOnlineSchedule -Id "f7a821dc-2d69-5ae8-8525-bcb4a4556093" +``` + +This example gets the schedules that has the Id of f7a821dc-2d69-5ae8-8525-bcb4a4556093. + +## PARAMETERS + +### -Id +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Get-CsOnlineSchedule cmdlet accepts a string as the Id parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule + +## NOTES + +## RELATED LINKS + +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) + +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) + +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) diff --git a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md b/teams/teams-ps/teams/Get-CsOnlineSipDomain.md new file mode 100644 index 0000000000..0627f86a2a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineSipDomain.md @@ -0,0 +1,95 @@ +--- +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 +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsOnlineSipDomain + +## SYNOPSIS +This cmdlet lists online sip domains and their enabled/disabled status. In a disabled domain, provisioning of users is blocked. Once a domain is re-enabled, provisioning of users in that domain will happen. + +## SYNTAX + +``` +Get-CsOnlineSipDomain [-Domain <String>] [-DomainStatus <DomainStatus>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is useful for organizations consolidating multiple on-premises deployments of Skype for Business Server into a single Office 365 tenant. During consolidation, sip domains for all forests hosting Skype for Business Server - other than the forest currently in hybrid mode - must be disabled. Once a hybrid deployment is fully migrated to the cloud and detached from Office 365, the next forest can start migration to the cloud. This cmdlet allows administrators to view the status of sip domains in their Office 365 tenant. For full details on cloud consolidation scenarios, see [Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsOnlineSipDomain +``` + +List all online SIP domains in the tenant and show their enabled/disabled status. + +### Example 2 +```powershell +PS C:\> Get-CsOnlineSipDomain -DomainStatus Disabled +``` + +List all disabled online SIP domains in the tenant. + +## PARAMETERS + +### -Domain +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainStatus +This indicates the status of an online sip domain, which can be either enabled or disabled. + +```yaml +Type: DomainStatus +Parameter Sets: (All) +Aliases: +Accepted values: All, Enabled, Disabled +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Provision.OSD.OnlineSipDomainBase+DomainState + +## NOTES + +## RELATED LINKS + +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) + +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) + +[Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumber.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md similarity index 76% rename from skype/skype-ps/skype/Get-CsOnlineTelephoneNumber.md rename to teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md index 524a17145d..0fced81daf 100644 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber +applicable: Microsoft Teams title: Get-CsOnlineTelephoneNumber schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-CsOnlineTelephoneNumber @@ -10,15 +15,33 @@ schema: 2.0.0 ## 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 ``` -Get-CsOnlineTelephoneNumber [-ActivationState <String>] [-Assigned <MultiValuedProperty>] [-CapitalOrMajorCity <String>] [-DomainController <Fqdn>] [-ExpandLocation] [-Force] [-InventoryType <MultiValuedProperty>] [-IsNotAssigned] [-ResultSize <UInt32>] [-TelephoneNumber <String>] [-TelephoneNumberGreaterThan <String>] [-TelephoneNumberLessThan <String>] [-TelephoneNumberStartsWith <String>] [-Tenant <Guid>] [-AsJob] [<CommonParameters>] +Get-CsOnlineTelephoneNumber [-ActivationState <String>] [-Assigned <MultiValuedProperty>] [-CapitalOrMajorCity <String>] [-DomainController <Fqdn>] [-ExpandLocation] [-Force] [-InventoryType <MultiValuedProperty>] [-IsNotAssigned] [-ResultSize <UInt32>] [-TelephoneNumber <String>] [-TelephoneNumberGreaterThan <String>] [-TelephoneNumberLessThan <String>] [-TelephoneNumberStartsWith <String>] [-Tenant <Guid>] [<CommonParameters>] ``` ## DESCRIPTION -Here is an example of the output of the `Get-CsOnlineTelephoneNumber` cmdlet. +Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. +Note: By default the result size is limited to 500 items, specify a higher result size using ResultSize parameter. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177 +``` +This example gets the attributes of a specific phone number. + +### -------------------------- Example 2 -------------------------- +``` +PS C:\> Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY +``` + +```output RunspaceId : f90303a9-c6a8-483c-b3b3-a5b8cdbab19c ActivationState : Activated @@ -52,20 +75,6 @@ UserId : IsManagedByServiceDesk : True PortInOrderStatus : - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177 -``` - -This example gets the attributes of a specific phone number. - -### -------------------------- Example 2 -------------------------- -``` -PS C:\> Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY ``` This example gets the phone numbers with the city code designating New York, New York. @@ -78,8 +87,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -101,8 +110,8 @@ The values for the Assigned parameter are case-sensitive. ```yaml Type: MultiValuedProperty Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -121,7 +130,7 @@ The values for the CapitalOrMajorCity parameter are case-sensitive. Type: String Parameter Sets: (All) Aliases: CityCode -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -137,7 +146,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -152,8 +161,8 @@ Displays the location parameter with its value. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -170,8 +179,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -184,15 +193,17 @@ Accept wildcard characters: False Specifies the target telephone number type for the cmdlet. Acceptable values are: -* "Service" for numbers assigned to conferencing support. +* "Service" for numbers assigned to conferencing support, call queue or auto attendant. * "Subscriber" for numbers supporting public switched telephone network (PSTN) functions. +The values for the InventoryType parameter are case-sensitive. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -207,8 +218,8 @@ Specifying this switch parameter will return only telephone numbers which are no ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -225,8 +236,8 @@ If set to 0, the command will run, but no data will be returned. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -237,15 +248,15 @@ Accept wildcard characters: False ### -TelephoneNumber Specifies the target telephone number. -For example: +For example: `-TelephoneNumber tel:+18005551234, or -TelephoneNumber +14251234567` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -262,8 +273,8 @@ The telephone number should be in E.164 format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -280,8 +291,8 @@ The telephone number should be in E.164 format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -299,8 +310,8 @@ You can use up to nine digits. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -315,28 +326,8 @@ 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 -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -346,7 +337,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -360,4 +351,4 @@ An instance or array of the objects. ## NOTES ## RELATED LINKS -[Remove-CsOnlineTelephoneNumber](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinetelephonenumber?view=skype-ps) +[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md new file mode 100644 index 0000000000..e2731e0eed --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md @@ -0,0 +1,69 @@ +--- +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 +manager: mreddy +author: TristanChen-msft +ms.author: jiaych +ms.reviewer: julienp +--- + +# 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. + +## SYNTAX + +``` +PS C:\> Get-CsOnlineTelephoneNumberCountry [<CommonParameters>] +``` +## 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 -------------------------- +``` +Get-CsOnlineTelephoneNumberCountry +``` + +```output +Name Value +---- ----- +Antigua and Barbuda AG +Argentina AR +Australia AU +Austria AT +... +United Kingdom GB +United States US +Uruguay UY +Venezuela VE +Vietnam VN +``` + +This example returns the list of supported countries or regions for the cmdlet search and acquire of new 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## 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) + +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md new file mode 100644 index 0000000000..5725171ad6 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md @@ -0,0 +1,215 @@ +--- +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 +manager: mreddy +author: TristanChen-msft +ms.author: jiaych +ms.reviewer: julienp +--- + +# Get-CsOnlineTelephoneNumberOrder + +## SYNOPSIS +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. + +## SYNTAX + +``` +Get-CsOnlineTelephoneNumberOrder -OrderId <String> [-OrderType <String>] + [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### Example 1 +``` +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderType Search -OrderId 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be + +Key Value +--- ----- +Id 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be +Name Postal Code Search Test +CreatedAt 2024-11-30T00:34:00.0825627+00:00 +CreatedBy ContosoAdmin +Description Postal Code Search Test +NumberType UserSubscriber +SearchType PostalCode +AreaCode 778 +PostalOrZipCode V7Y 1G5 +Quantity 2 +Status Reserved +IsManual False +TelephoneNumbers {System.Collections.Generic.Dictionary`2[System.String,System.Object], System.Collections.Generic.Dictionary`2[System.String,System.Object]} +ReservationExpiryDate 2024-11-30T00:50:01.1794152+00:00 +ErrorCode NoError +InventoryType Subscriber +SendToServiceDesk False +CountryCode CA + +PS C:\> $order.TelephoneNumbers + +Key Value +--- ----- +Location Vancouver +TelephoneNumber +16046606034 +Location Vancouver +TelephoneNumber +16046606030 +``` + +This example returns a successful telephone number search and the telephone numbers are reserved for purchase. + +### Example 2 +``` +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderType Search -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042 + +Key Value +--- ----- +Id 8d23e073-bc98-4f73-8e05-7517655d7042 +Name Postal Code Search Test +CreatedAt 2024-11-30T00:34:00.0825627+00:00 +CreatedBy ContosoAdmin +Description Prefix Search Test +NumberType UserSubscriber +SearchType Prefix +AreaCode +PostalOrZipCode +Quantity 1 +Status Error +IsManual False +TelephoneNumbers {} +ReservationExpiryDate +ErrorCode OutOfStock +InventoryType Subscriber +SendToServiceDesk False +CountryCode +``` + +This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`. + +### Example 3 +```powershell +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be + +Key Value +--- ----- +Id 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be +Name Postal Code Search Test +CreatedAt 2024-11-30T00:34:00.0825627+00:00 +CreatedBy TNM +Description Postal Code Search Test from Postman +NumberType UserSubscriber +SearchType PostalCode +AreaCode 778 +PostalOrZipCode V7Y 1G5 +Quantity 2 +Status Expired +IsManual False +TelephoneNumbers {System.Collections.Generic.Dictionary`2[System.String,System.Object], System.Collections.Generic.Dictionary`2[System.String,System.Object]} +ReservationExpiryDate 2024-11-30T00:50:01.1794152+00:00 +ErrorCode NoError +InventoryType Subscriber +SendToServiceDesk False +CountryCode CA +``` + +When the OrderType is not indicated, the cmdlet will default to a Search order. This example returns a successful telephone number search and the telephone numbers are reserved for purchase. + +### Example 4 +```powershell +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId 6aa4f786-8628-4923-9df1-896f3d84016c + +Key Value +--- ----- +OrderId 6aa4f786-8628-4923-9df1-896f3d84016c +CreatedAt 2024-11-27T06:44:26.1975766+00:00 +Status Complete +TotalCount 3 +SuccessCount 3 +FailureCount 0 +SuccessPhoneNumbers {+12063866355, +12063868075, +12063861642} +FailedPhoneNumbers {} +``` + +This example returns the status of a successful release order for Direct Routing telephone numbers. + +### Example 5 +```powershell +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId faef09f7-5bd5-4740-9e76-9a5762380f34 + +Key Value +--- ----- +OrderId faef09f7-5bd5-4740-9e76-9a5762380f34 +CreatedAt 2024-11-30T00:22:59.4989508+00:00 +Status Success +TotalCount 1 +SuccessCount 1 +FailureCount 0 +WarningCount 0 +FailedPhoneNumbers {} +WarningPhoneNumbers {} +SuccessPhoneNumbers {+99999980} +``` + +This example returns the status of a successful upload order for a Direct Routing phone number. + +## PARAMETERS + +### -OrderId +Use the OrderId received as output of your order creation cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderType +Specifies the type of telephone number order to look up. Currently supported values are **Search**, **Release**, and **DirectRoutingNumberCreation**. If this value is unspecified, then it will default to a **Search** order. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +Updates in Teams PowerShell Module version 6.7.1 and later: +- A new optional parameter `OrderType` is introduced. If no OrderType is provided, it will default to a Search order. +- [BREAKING CHANGE] When a Search order is queried, the property name `TelephoneNumber` in the output will be changed to `TelephoneNumbers`. The structure of the `TelephoneNumbers` output will remain unchanged. + - Impact: Scripts and processes that reference the `TelephoneNumber` property will need to be updated to use `TelephoneNumbers`. + +## RELATED LINKS +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) +[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md new file mode 100644 index 0000000000..47c397e14b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md @@ -0,0 +1,110 @@ +--- +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 +manager: mreddy +author: TristanChen-msft +ms.author: jiaych +ms.reviewer: julienp +--- + +# 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. + +## SYNTAX + +``` +Get-CsOnlineTelephoneNumberType [-Country] <CountryCode> [<CommonParameters>] +``` + +## DESCRIPTION + +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. The `NumberType` field in the response is used to indicate the capabilities of a given offering. The telephone numbers can then be used to set up calling features for users and services in your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CsOnlineTelephoneNumberType -Country US +``` + +```output +AllowedSearchType : {CivicAddress, Prefix} +AreaCode : +AvailabilityInfo : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.AvailabilityInfo +Id : 470316bd-815e-459d-80e7-d7332f00fcb9 +NumberType : UserSubscriber +OfferModel : DirectStock +PrefixSearchOption : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.PrefixSearchOptions +RequiresCivicAddress : True + +AllowedSearchType : {CivicAddress, Prefix} +AreaCode : +AvailabilityInfo : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.AvailabilityInfo +Id : 25444938-a335-4a85-b64d-d445b45f04e3 +NumberType : UserSubscriberVoiceAndSms +OfferModel : DirectStock +PrefixSearchOption : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.PrefixSearchOptions +RequiresCivicAddress : True +``` + +This example returns the list of supported number offerings in United States. + +### -------------------------- Example 2 -------------------------- +``` +PS C:\> Get-CsOnlineTelephoneNumberType -Country CA | ft NumberType +``` + +```output +NumberType +---------- +UserSubscriber +UserSubscriberVoiceAndSms +ConferenceToll +ConferenceTollFree +CallQueueToll +CallQueueTollFree +AutoAttendantToll +AutoAttendantTollFree +``` +This example returns the list of supported NumberTypes in Canada. + +## PARAMETERS + +### Country +Specifies the country or region that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries or regions can be found by calling `Get-CsOnlineTelephoneNumberCountry`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) + +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineUser.md b/teams/teams-ps/teams/Get-CsOnlineUser.md new file mode 100644 index 0000000000..73ccb9f1c7 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineUser.md @@ -0,0 +1,591 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser +applicable: Microsoft Teams +title: Get-CsOnlineUser +schema: 2.0.0 +manager: sshastri +author: praspatil +ms.author: praspatil +ms.reviewer: +--- + +# Get-CsOnlineUser + +## SYNOPSIS +Returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. + +## SYNTAX + +``` +Get-CsOnlineUser [[-Identity] <UserIdParameter>] + [-AccountType <String>] + [-Filter <String>] + [-Properties <String>] + [-ResultSize <Unlimited>] + [-SkipUserPolicies] + [-SoftDeletedUser] + [-Sort] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsOnlineUser cmdlet returns information about users who have accounts homed on Microsoft Teams +The returned information includes standard Active Directory account information (such as the department the user works in, his or her address and phone number, etc.): the Get-CsOnlineUser cmdlet returns information about such things as whether or not the user has been enabled for Enterprise Voice and which per-user policies (if any) have been assigned to the user. + +Note that the Get-CsOnlineUser cmdlet does not have a TenantId parameter; that means you cannot use a command similar to this in order to limit the returned data to users who have accounts with a specific Microsoft Teams or Skype for Business Online tenant: + +`Get-CsOnlineUser -TenantId "bf19b7db-6960-41e5-a139-2aa373474354"` + +However, if you have multiple tenants you can return users from a specified tenant by using the Filter parameter and a command similar to this: + +`Get-CsOnlineUser -Filter "TenantId -eq 'bf19b7db-6960-41e5-a139-2aa373474354'"` + +That command will limit the returned data to user accounts belong to the tenant with the TenantId "bf19b7db-6960-41e5-a139-2aa373474354". +If you do not know your tenant IDs you can return that information by using this command: + +`Get-CsTenant` + +If you have a hybrid or "split domain" deployment (that is, a deployment in which some users have accounts homed on Skype for Business Online while other users have accounts homed on an on-premises version of Skype for Business Server 2015) keep in mind that the Get-CsOnlineUser cmdlet only returns information for Skype for Business Online users. +However, the cmdlet will return information for both online users and on-premises users. +If you want to exclude Skype for Business Online users from the data returned by the Get-CsUser cmdlet, use the following command: + +`Get-CsUser -Filter "TenantId -eq '00000000-0000-0000-0000-000000000000'"` + +By definition, users homed on the on-premises version will always have a TenantId equal to 00000000-0000-0000-0000-000000000000. +Users homed on Skype for Business Online will a TenantId that is equal to some value other than 00000000-0000-0000-0000-000000000000. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineUser +``` + +The command shown in Example 1 returns information for all the users configured as online users. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" +``` + +In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". + +### -------------------------- Example 3 -------------------------- +``` +Get-CsOnlineUser -Filter "ArchivingPolicy -eq 'RedmondArchiving'" +``` + +Example 3 uses the Filter parameter to limit the returned data to online users who have been assigned the per-user archiving policy RedmondArchiving. + +To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". + +### -------------------------- Example 4 -------------------------- +``` +Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} +``` + +Example 4 returns information only for user accounts that have been configured so that the account does not appear in Microsoft Exchange address lists. + +(That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. + +### -------------------------- Example 5 -------------------------- +``` +Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} +Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} +Get-CsOnlineUser -Filter {LineURI -eq "1234"} +``` + +Example 5 returns information for user accounts that have been assigned a designated phone number. + +### -------------------------- Example 6 -------------------------- +``` +Get-CsOnlineUser -AccountType ResourceAccount +``` + +Example 6 returns information for user accounts that are categorized as resource accounts. + +### -------------------------- Example 7 -------------------------- +``` +Get-CsOnlineUser -Filter "FeatureTypes -Contains 'PhoneSystem'" +``` + +Example 7 returns information for user's assigned plans. + +## PARAMETERS + +### -AccountType +This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate the user type. The possible values for the AccountType parameter are: + +- `User` - to query for user accounts. +- `ResourceAccount` - to query for app endpoints or resource accounts. +- `Guest` - to query for guest accounts. +- `SfBOnPremUser` - to query for users that are hosted on-premises +- `IneligibleUser` - to query for a user that does not have valid Teams license (except Guest, ResourceAccount and SfbOnPremUser). + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account to be retrieved. + +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account: + +- GUID +- SIP address +- UPN +- Alias + +Using the Teams PowerShell Module version 2.6 or earlier only, you can use the following values to identify the account: + +- GUID +- SIP address +- UPN +- Alias +- Display name. Supports the asterisk ( \* ) wildcard character. For example, `-Identity "* Smith"` returns all the users whose display names end with Smith. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. + +The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. + +Examples: +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties + +Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. + +Examples: +- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes +- Get-CsOnlineUser -Properties DisplayName, Alias, LineURI + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize + +**Note**: Starting with Teams PowerShell Modules version 4.0 and later, "-ResultSize" type has been changed to uint32. + +Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. + +The result size can be set to any whole number between 0 and 2147483647, inclusive. The value 0 returns no data. If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUserPolicies +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedUser + +This parameter enables you to return a collection of all the users who are deleted and can be restored within 30 days from their deletion time + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort + +Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-OrderBy" parameters. For example: + +- Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" +- Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} + +**Note**: Sorting on few attributes like LineURI can be case-sensitive. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: OrderBy +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +A recent fix has addressed an issue where some Guest users were being omitted from the output of the Get-CsOnlineUser cmdlet, resulting in an increase in the reported user count. + +**Commonly used FeatureTypes and their descriptions:** + +- Teams: Enables Users to access Teams +- AudioConferencing': Enables users to call-in to Teams meetings from their phones +- PhoneSystem: Enables users to place, receive, transfer, mute, unmute calls in Teams with mobile device, PC, or IP Phones +- CallingPlan: Enables an All-in-the-cloud voice solution for Teams users that connects Teams Phone System to the PSTN to enable external calling. With this option, Microsoft acts as the PSTN carrier. +- TeamsMultiGeo: Enables Teams chat data to be stored at rest in a specified geo location +- VoiceApp: Enables to set up resource accounts to support voice applications like Auto Attendants and Call Queues +- M365CopilotTeams: Enables Copilot in Teams +- TeamsProMgmt: Enables enhanced meeting recap features like AI generated notes and tasks from meetings, view when a screen was shared etc +- TeamsProProtection: Enables additional ways to safeguard and monitor users' Teams experiences with features like Sensitivity labels, Watermarking, end-to-end encryption etc. +- TeamsProWebinar: Enables advances webinar features like engagement reports, RTMP-In, Webinar Wait List, in Teams. +- TeamsProCust: Enables meeting customization features like branded meetings, together mode, in Teams. +- TeamsProVirtualAppt: Enables advances virtual appointment features like SMS notifications, custom waiting room, in Teams. +- TeamsRoomPro: Enables premium in-room meeting experience like intelligent audio, large galleries in Teams. +- TeamsRoomBasic: Enables core meeting experience with Teams Rooms Systems. +- TeamsAdvComms: Enables advances communication management like custom communication policies in Teams. +- TeamsMobileExperience: Enables users to use a single phone number in Teams across both sim-enabled mobile phone and desk lines. +- Conferencing_RequiresCommunicationCredits: Allows pay-per minute Audio Conferencing without monthly licenses. +- CommunicationCredits: Enables users to pay Teams calling and conferencing through the credits. + +**Updates in Teams PowerShell Module verion 7.1.1 Preview and later**: + +- EffectivePolicyAssignments: The EffectivePolicyAssignments attribute has been added to the Get-CsOnlineUser cmdlet in commercial environments. This new attribute provides information about a user's effective policy assignments. Each assignment includes the following details: + - PolicyType - which specifies the type of policy assigned (for example, TeamsMeetingPolicy, TeamsCallingPolicy, and so on.) + - PolicyAssignment - which includes the display name of the assigned policy (displayName), the assignment type (assignmentType) indicating whether it is direct or group-based, the unique identifier of the policy (policyId), and the group identifier (groupId) if applicable. + **Note**: The policyId property isn't currently supported. + +**Updates in Teams PowerShell Module**: + +- DialPlan: DialPlan attribute will be deprecated and no longer populated in the output of Get-CsOnlineUser in all clouds. + +**Updates in Teams PowerShell Module version 7.0.0 and later**: + +- OptionFlags: OptionFlags attribute will no longer be populated with value in the output of Get-CsOnlineUser in all clouds. It's important to note that other details besides EnterpriseVoiceEnabled, previously found in OptionFlags, are no longer relevant for Teams. Administrators can still utilize the EnterpriseVoiceEnabled attribute in the output of the Get-CsOnlineUser cmdlet to get this information. This change will be rolled out to all Teams Powershell Module versions. + +**Updates in Teams PowerShell Module version 6.9.0 and later**: + +Adds new attribute in the output of Get-CsOnlineUser cmdlet in commercial environments. + - TelephoneNumbers: A new list of complex object that includes telephone number and its corresponding assignment category. The assignment category can include values such as 'Primary', 'Private', and 'Alternate'. + +Adds new parameter to the Get-CsOnlineUser cmdlet in all clouds: + - Properties: Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Note that the following properties will always be present in the output: Identity, UserPrincipalName, Alias, AccountEnabled, DisplayName. + +**Updates in Teams PowerShell Module version 6.8.0 and later**: + +New policies - TeamsBYODAndDesksPolicy, TeamsAIPolicy, TeamsWorkLocationDetectionPolicy, TeamsMediaConnectivityPolicy, TeamsMeetingTemplatePermissionPolicy, TeamsVirtualAppointmentsPolicy and TeamsWorkLoadPolicy will be visible in the Get-CsOnlineUser cmdlet output. + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 6.8.0 or later for Microsoft Teams operated by 21Vianet. These updates will be rolled out gradually to older Microsoft Teams PowerShell versions. + +The following attributes are populated with correct values in the output of Get-CsOnlineUser when not using the "-identity" parameter: + +- CountryAbbreviation +- UserValidationErrors +- WhenCreated + +The following updates are applicable to the output in scenarios where "-identity" parameter is not used: + +- Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. +- Guest are available in the output +- Unlicensed Users: Unlicensed users would show up in the output of Get-CsOnlineUser (note Unlicensed users in commercial clouds would show up in the output for only 30 days post-license removal.) +- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. +- AccountType as Unknown will be renamed to AccountType as IneligibleUser in GCC High and DoD environments. IneligibleUser will include users who do not have any valid Teams licenses (except Guest, SfbOnPremUser, ResourceAccount). + +If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. + +If Guest, Soft Deleted Users, IneligibleUser are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp. For example: + +- Get-CsOnlineUser -Filter {AccountType -ne 'Guest'} +- Get-CsOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +- Get-CsOnlineUser -Filter {AccountType -ne 'IneligibleUser'} + +**Updates in Teams PowerShell Module version 6.1.1 Preview and later**: + +The following updates are applicable for organizations that use Microsoft Teams PowerShell version 6.1.1 (Targeted Release: April 15th, 2024) or later. These changes will be gradually rolled out for all tenants starting from April 26th, 2024. + +When using the Get-CsOnlineUser cmdlet in Teams PowerShell Module without the -identity parameter, we are introducing these updates: + +- Before the rollout, unlicensed users who did not have a valid Teams license were displayed in the output of the Get-CsOnlineUser cmdlet for 30 days after license removal. After the rollout, Get-CsOnlineUser will show unlicensed users after the initial 30 days and also include unlicensed users who never had a valid Teams license. +- The AccountType value Unknown is being renamed to IneligibleUser, and will include users who do not have a valid Teams license (exceptions: Guest, SfbOnPremUser, and ResourceAccount). +- You can exclude users with the AccountType as IneligibleUser from the output with the AccountType filter. For example, Get-CsOnlineUser -Filter {AccountType -ne 'IneligibleUser'} + +When Get-CsOnlineUser is used with the -identity parameter, you can also use UPN, Alias, and SIP Address with the -identity parameter to obtain the information for a specific unlicensed user. + +**Updates in Teams PowerShell Module version 6.1.0 and later**: + +The following updates are applicable for organizations that use Microsoft Teams PowerShell version 6.1.0 or later. + +- LocationPolicy: LocationPolicy attribute is being deprecated from the output of Get-CsOnlineUser in all clouds. Get-CsPhoneNumberAssignment -IsoCountryCode can be used to get the LocationPolicy information. (Note: LocationPolicy attribute will no longer be populated with value in the older Teams Powershell Module versions (<6.1.0) starting from 20th March 2024.) + +**Updates in Teams PowerShell Module version 6.0.0 and later**: + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 6.0.0 or later. + +- GracePeriodExpiryDate: GracePeriodExpiryDate attribute is being introduced within the AssignedPlan JSON array. It specifies the date when the grace period of a previously deleted license expires, and the license will be permanently deleted. The attribute remains empty/null for active licenses. (Note: The attribute is currently in private preview and will display valid values only for private preview) + +- IsInGracePeriod: IsInGracePeriod attribute is a boolean flag that indicates that the associated plan is in grace period after deletion. (Note: The attribute is currently in private preview and will display valid values only for private preview) + +**Updates in Teams PowerShell Module version 5.9.0 and later**: + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.9.0 or later in GCC High and DoD environments (note that these changes are already rolled out in commercial environments). These updates will be applicable to older Teams PowerShell versions from 15th March 2024 in GCC High and DoD environments: + +The following attributes are populated with correct values in the output of Get-CsOnlineUser when not using the "-identity" parameter: + +- CountryAbbreviation +- UserValidationErrors +- WhenCreated + +The following updates are applicable to the output in scenarios where "-identity" parameter is not used: + +- Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. +- Guest are available in the output +- Unlicensed Users: Unlicensed users would show up in the output of Get-CsOnlineUser (note Unlicensed users in commercial clouds would show up in the output for only 30 days post-license removal.) +- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. +- AccountType as Unknown will be renamed to AccountType as IneligibleUser in GCC High and DoD environments. IneligibleUser will include users who do not have any valid Teams licenses (except Guest, SfbOnPremUser, ResourceAccount). + +If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. + +If Guest, Soft Deleted Users, IneligibleUser are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp. For example: + +- Get-CsOnlineUser -Filter {AccountType -ne 'Guest'} +- Get-CsOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +- Get-CsOnlineUser -Filter {AccountType -ne 'IneligibleUser'} + +**Updates in Teams PowerShell Module version 3.0.0 and above**: + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0: + +_New user attributes_: + +FeatureTypes: Array of unique strings specifying what features are enabled for a user. This attribute is an alternative to several attributes that have been dropped as outlined in the next section. + +Some of the commonly used FeatureTypes include: + +- Teams +- AudioConferencing +- PhoneSystem +- CallingPlan + +**Note**: This attribute is now filterable in Teams PowerShell Module versions 4.0.0 and later using the "-Contains" operator as shown in Example 7. + +AccountEnabled: Indicates whether a user is enabled for login in Microsoft Entra ID. + +_Dropped attributes_: + +The following attributes are no longer relevant to Teams and have been dropped from the output: + +- AcpInfo +- AdminDescription +- ArchivingPolicy +- AudioVideoDisabled +- BaseSimpleUrl +- BroadcastMeetingPolicy +- CallViaWorkPolicy +- ClientPolicy +- ClientUpdateOverridePolicy +- ClientVersionPolicy +- CloudMeetingOpsPolicy +- CloudMeetingPolicy +- CloudVideoInteropPolicy +- ContactOptionFlags +- CountryOrRegionDisplayName +- Description +- DistinguishedName +- EnabledForRichPresence +- ExchangeArchivingPolicy +- ExchUserHoldPolicies +- ExperiencePolicy +- ExternalUserCommunicationPolicy +- ExUmEnabled +- Guid +- HomeServer +- HostedVoicemailPolicy +- IPPBXSoftPhoneRoutingEnabled +- IPPhone +- IPPhonePolicy +- IsByPassValidation +- IsValid +- LegalInterceptPolicy +- LicenseRemovalTimestamp +- LineServerURI +- Manager +- MNCReady +- Name +- NonPrimaryResource +- ObjectCategory +- ObjectClass +- ObjectState +- OnPremHideFromAddressLists +- OriginalPreferredDataLocation +- OriginatingServer +- OriginatorSid +- OverridePreferredDataLocation +- PendingDeletion +- PrivateLine +- ProvisioningCounter +- ProvisioningStamp +- PublishingCounter +- PublishingStamp +- Puid +- RemoteCallControlTelephonyEnabled +- RemoteMachine +- SamAccountName +- ServiceInfo +- StsRefreshTokensValidFrom +- SubProvisioningCounter +- SubProvisioningStamp +- SubProvisionLineType +- SyncingCounter +- TargetRegistrarPool +- TargetServerIfMoving +- TeamsInteropPolicy +- ThumbnailPhoto +- UpgradeRetryCounter +- UserAccountControl +- UserProvisionType +- UserRoutingGroupId +- VoicePolicy - Alternative is the CallingPlan and PhoneSystem string in FeatureTypes +- XForestMovePolicy +- AddressBookPolicy +- GraphPolicy +- PinPolicy +- PreferredDataLocationOverwritePolicy +- PresencePolicy +- SmsServicePolicy +- TeamsVoiceRoute +- ThirdPartyVideoSystemPolicy +- UserServicesPolicy +- ConferencingPolicy +- Id +- MobilityPolicy +- OnlineDialinConferencingPolicy - Alternative is the AudioConferencing string in FeatureTypes +- Sid +- TeamsWorkLoadPolicy +- VoiceRoutingPolicy +- ClientUpdatePolicy +- HomePhone +- HostedVoiceMail +- MobilePhone +- OtherTelephone +- StreetAddress +- WebPage +- AssignedLicenses +- OnPremisesUserPrincipalName +- HostedVoiceMail +- LicenseAssignmentStates +- OnPremDomainName +- OnPremSecurityIdentifier +- OnPremSamAccountName +- CallerIdPolicy +- Fax +- LastName (available in Teams PowerShell Module 4.2.1 and later) +- Office +- Phone +- WindowsEmailAddress +- SoftDeletedUsers (available in Teams PowerShell Module 4.4.3 and later) + +The following attributes are temporarily unavailable in the output when using the "-Filter" or when used without the "-Identity" parameter: + +- WhenChanged +- CountryAbbreviation + +**Note**: These attributes will be available in the near future. + +_Attributes renamed_: + +- ObjectId renamed to Identity +- FirstName renamed to GivenName +- DirSyncEnabled renamed to UserDirSyncEnabled +- MCOValidationErrors renamed to UserValidationErrors +- Enabled renamed to IsSipEnabled +- TeamsBranchSurvivabilityPolicy renamed to TeamsSurvivableBranchAppliancePolicy +- CountryOrRegionDisplayName introduced as Country (in versions 4.2.0 and later) +- InterpretedUserType: "AADConnectEnabledOnline" prefix for the InterpretedUserType output value has now been renamed DirSyncEnabledOnline, for example, AADConnectEnabledOnlineTeamsOnlyUser is now DirSyncEnabledOnlineTeamsOnlyUser. + +_Attributes that have changed in meaning/format_: + +**OnPremLineURI**: This attribute previously used to refer to both: + +1. LineURI set via OnPrem AD. +2. Direct Routing numbers assigned to users via Set-CsUser. + +In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the LineURI set via OnPrem AD. Direct Routing numbers will be available from the LineURI field. Direct Routing Numbers can be distinguished from Calling Plan Numbers by looking at the FeatureTypes attribute. + +- **The output format of AssignedPlan and ProvisionedPlan have now changed from XML to JSON array.** +- **The output format of Policies has now changed from String to JSON type UserPolicyDefinition.** + +## RELATED LINKS + +[Set-CsUser](https://learn.microsoft.com/powershell/module/teams/set-csuser) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md new file mode 100644 index 0000000000..530da92267 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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). + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlineVoiceRoute [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineVoiceRoute [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to retrieve one or more existing online voice routes in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). + +This cmdlet can be used to retrieve voice route information such as which online PSTN gateways the route is associated with (if any), which online PSTN usages are associated with the route, the pattern (in the form of a regular expression) that identifies the phone numbers to which the route applies, and caller ID settings. The PSTN usage associates the voice route to an online voice policy. + +This cmdlet is used when configuring Microsoft Phone System Direct Routing. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CsOnlineVoiceRoute +``` + +Retrieves the properties for all voice routes defined within the tenant. + +### -------------------------- Example 2 -------------------------- +``` +PS C:\> Get-CsOnlineVoiceRoute -Identity Route1 +``` + +Retrieves the properties for the Route1 voice route. + +### -------------------------- 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 -------------------------- +``` +PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0} +``` + +This command retrieves all voice routes that have not had any PSTN gateways assigned. First all voice routes are retrieved using the Get-CsOnlineVoiceRoute cmdlet. These voice routes are then piped to the Where-Object cmdlet. The Where-Object cmdlet narrows down the results of the Get operation. In this case we look at each voice route (that's what the $_ represents) and check the Count property of the PstnGatewayList property. If the count of PSTN gateways is 0, the list is empty and no gateways have been defined for the route. + +## PARAMETERS + +### -Filter +This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) + +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) + +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md new file mode 100644 index 0000000000..1aec9c2d0a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlineVoiceRoutingPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineVoiceRoutingPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Teams users an online voice routing policy enables those users to receive and to place phone calls to the public switched telephone network by using your on-premises SIP trunks. + +Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +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 -------------------------- +``` +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 -------------------------- +``` +PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -notcontains "Long Distance"} +``` + +Example 5 is a variation on the command shown in Example 4; in this case, however, information is returned only for those online voice routing policies that do not include the PSTN usage "Long Distance". In order to do that, the Where-Object cmdlet uses the -notcontains operator, which limits returned data to policies that do not include the usage "Long Distance". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more online voice routing 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 online voice routing policy to be retrieved. To return the global policy, use this syntax: + +-Identity global + +To return a policy configured at the per-user scope, use syntax like this: + +-Identity "RedmondOnlineVoiceRoutingPolicy" + +You cannot use wildcard characters when specifying the Identity. + +If neither the Identity nor the Filter parameters are specified, then `Get-CsOnlineVoiceRoutingPolicy` returns all the voice routing policies configured for use in the tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) + +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) + +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) + +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md b/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md new file mode 100644 index 0000000000..71f7ff2efb --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md @@ -0,0 +1,396 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineVoiceUser + +## SYNOPSIS +Use the `Get-CsOnlineVoiceUser` cmdlet to retrieve a voice user's telephone number and location. + +## SYNTAX + +``` +Get-CsOnlineVoiceUser [-CivicAddressId <XdsCivicAddressId>] [-DomainController <Fqdn>] [-EnterpriseVoiceStatus <MultiValuedProperty>] [-ExpandLocation] [-First <Unlimited>] [-Force] [-GetFromAAD] [-GetPendingUsers] [-Identity <UserIdParameter>] [-LocationId <LocationID>] [-NumberAssigned] [-NumberNotAssigned] [-PSTNConnectivity <MultiValuedProperty>] [-SearchQuery <String>] [-Skip <Unlimited>] [-Tenant <Guid>] + [<CommonParameters>] +``` + +## DESCRIPTION + +**Note**: This cmdlet **is no longer supported** on the public and GCC cloud instances. You should use the replacement cmdlets described here. + +The following table lists the parameters to `Get-CsOnlineVoiceUser` and the alternative method of getting the same data using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, `Get-CsOnlineLisLocation`, and `Get-CsOnlineLisCivicAddress`. + +| Parameter | Description | Alternative | +| :------------| :------- | :------- | +| No parameters | Get information for all users | `Get-CsOnlineUser -Filter {(FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| CivicAddressId | Find phone number information where the assigned phone number is associated with the CivicAddressId | `Get-CsPhoneNumberAssignment -CivicAddressId <CivicAddressId>` | +| EnterpriseVoiceStatus | Find enabled users based on EnterpriseVoiceEnabled | `Get-CsOnlineUser -Filter {(EnterpriseVoiceEnabled -eq $True) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` or `Get-CsOnlineUser -Filter {(EnterpriseVoiceEnabled -eq $False) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| ExpandLocation | Show information about the LocationId | `Get-CsOnlineLisLocation -LocationId <LocationId>` | +| Identity | Get information for a user | `Get-CsOnlineUser -Identity <Identity>` | +| LocationId | Find phone number information where the assigned phone number is associated with the LocationId | `Get-CsPhoneNumberAssignment -LocationId <LocationId>` | +| NumberAssigned | Find enabled users with a phone number assigned | `Get-CsOnlineUser -Filter {(LineUri -ne $Null) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| NumberNotAssigned | Find users without a phone number assigned | `Get-CsOnlineUser -Filter {(LineUri -eq $Null) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| PSTNConnectivity | Find enabled users with PhoneSystem (OnPremises) or CallingPlan (Online) | Online: `Get-CsOnlineUser -Filter {(FeatureTypes -contains 'CallingPlan') -and (AccountEnabled -eq $True)} -AccountType User` OnPremises: `Get-CsOnlineUser -Filter {-not (FeatureTypes -contains 'CallingPlan') -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | + +The following table lists the output fields from `Get-CsOnlineVoiceUser` and the alternative method of getting the same information using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, and `Get-CsOnlineLisLocation`. + +| Output field | Alternative | +| :---------------------------------| :--------------------------------- | +| Name | DisplayName in the output from `Get-CsOnlineUser` | +| Id | Identity in the output from `Get-CsOnlineUser`| +| SipDomain | Extract SipDomain from the SipAddress in the output from `Get-CsOnlineUser` | +| DataCenter | Extract DataCenter from RegistrarPool in the output from `Get-CsOnlineUser`| +| TenantId | TenantId in the output from `Get-CsOnlineUser`| +| PstnConnectivity | FeatureTypes in the output from `Get-CsOnlineUser`. If FeatureTypes contains `CallingPlan`, PstnConnectivity is `Online`. If FeatureTypes contains `PhoneSystem` and does not contain `CallingPlan`, PstnConnectivity is `OnPremises` | +| UsageLocation | UsageLocation in the output from `Get-CsOnlineUser` | +| EnterpriseVoiceEnabled | EnterpriseVoiceEnabled in the output from `Get-CsOnlineUser` | +| Number | LineUri in the output from `Get-CsOnlineUser`. You can get same phone number format by doing LineUri.Replace('tel:+','') | +| Location | Use LocationId in the output from `Get-CsPhoneNumberAssignment -AssignedPstnTargetId <Identity>` as the input to `Get-CsOnlineLisLocation -LocationId` | + +In Teams PowerShell Module version 3.0 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following improvements have been introduced for organizations using Teams: +- This cmdlet now accurately returns users who are voice-enabled (the older cmdlet in version 2.6.0 and earlier returned users without MCOEV* plans assigned). +- The result size is not limited to 100 users anymore (the older cmdlet in version 2.6.0 and earlier limited the result size to 100). + +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: + +- Force +- NumberOfResultsToSkip +- CorrelationId +- Verb +- ResultSize +- LicenceState + +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following input parameters are deprecated for organizations with Teams users due to low or zero usage: + +- DomainController +- Force +- GetFromAAD +- GetPendingUsers +- SearchQuery +- Skip +- Tenant +- Common Parameters + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com +``` + +This example uses the User Principal Name (UPN) to retrieve the location and phone number information. + +## PARAMETERS + +### -CivicAddressId +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 +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: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceStatus +Possible values are: +* All +* Enabled +* Disabled + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandLocation +Displays the location parameter with its value. + +```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 +``` + +### -First +Specifies the number of users to return. +The default is 100. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +*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. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetFromAAD +*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. + +Use this switch to get the users from Microsoft Entra ID. + +```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 +``` + +### -GetPendingUsers +*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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +Specifies the location identity of the location whose users will be returned. +You can find location identifiers by using the `Get-CsOnlineLisLocation` cmdlet. + +```yaml +Type: LocationID +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberAssigned +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberNotAssigned +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSTNConnectivity + +Possible values are: +* All +* Online +* OnPremises + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchQuery +*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). + +If this parameter is empty, all users are returned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +*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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacUser + +## NOTES + +## RELATED LINKS +[Set-CsOnlineVoiceUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md new file mode 100644 index 0000000000..844b74b828 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md @@ -0,0 +1,109 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineVoicemailPolicy + +## SYNOPSIS +Use the `Get-CsOnlineVoicemailPolicy` cmdlet to get a list of all pre-configured policy instances related to Cloud Voicemail service. + +## SYNTAX + +### Identity (Default) +``` +Get-CsOnlineVoicemailPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsOnlineVoicemailPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet retrieves information about one or more voicemail policies that have been configured for use in your organization. Voicemail policies are used by the organization to manage Voicemail-related features such as transcription. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +Get-CsOnlineVoicemailPolicy -Filter "tag:*" +``` + +Example 3 uses the Filter parameter to return all the voicemail policies that have been configured at the per-user scope. The filter value "tag:*" tells the Get-CsOnlineVoicemailPolicy cmdlet to return only those policies that have an Identity that begins with the string value "tag:". + +## PARAMETERS + +### -Identity +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: 1 +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.WritableConfig.Policy.OnlineVoicemail.OnlineVoicemailPolicy + +## NOTES + +## RELATED LINKS +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) + +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) + +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) + +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md new file mode 100644 index 0000000000..b4437f7b08 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md @@ -0,0 +1,84 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineVoicemailUserSettings + +## SYNOPSIS +Use the Get-CsOnlineVoicemailUserSettings cmdlet to get information about online voicemail user settings of a specific user. + +## SYNTAX + +``` +Get-CsOnlineVoicemailUserSettings [-Identity] <string> [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsOnlineVoicemailUserSettings cmdlet returns information about online voicemail user settings of a specific user in your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com +``` + +This example gets the online voicemail user settings of user with SIP URI sip:user@contoso.com. + +## PARAMETERS + +### -Identity +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: +applicable: Microsoft Teams + +Required: True +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 Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md new file mode 100644 index 0000000000..9b68146e1f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md @@ -0,0 +1,602 @@ +--- +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 <string>] [-AssignedPstnTargetId <string>] [-AssignmentCategory <string>] + [-CapabilitiesContain <string>] [-CivicAddressId <string>] [-Filter <String>] [-IsoCountryCode <string>] + [-LocationId <string>] [-NetworkSiteId <string>] [-NumberType <string>] [-PstnAssignmentStatus <string>] [-Skip <int>] [-TelephoneNumber <string>] + [-TelephoneNumberContain <string>] [-TelephoneNumberGreaterThan <string>] [-TelephoneNumberLessThan <string>] + [-TelephoneNumberStartsWith <string>] [-Top <int>] [<CommonParameters>] +``` + +## 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 : {} +``` +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 -Skip 1000 -Top 1000 +``` +This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. + +### Example 9 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' +``` +This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. + +### Example 10 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {SkipInternalVoip} +``` +This example displays when SkipInternalVoip option is turned on for a number. + +### Example 11 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +``` +This example shows a way to use -Filter parameter to display information of a specific number. + +### Example 12 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +``` +This example shows a way to get filtered results using multiple Filter parameters. + + +## PARAMETERS + +### -ActivationState +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 used to differentiate between Primary and Private line assignment for a user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +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) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberTag.md b/teams/teams-ps/teams/Get-CsPhoneNumberTag.md new file mode 100644 index 0000000000..beba5186cd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsPhoneNumberTag.md @@ -0,0 +1,58 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag +applicable: Microsoft Teams +title: Get-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Get-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows the admin to get a list of existing tags for telephone numbers. + +## SYNTAX + +``` +Get-CsPhoneNumberTag [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will get a list of all existing tags that are assigned to phone numbers in the tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsPhoneNumberTag +``` +```output +TagValue +HR +Redmond HQ +Executives +``` + +This example shows how to get a list of existing tags for telephone numbers + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISkypeTelephoneNumberMgmtCmdletTenantTagRecord + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsPolicyPackage.md b/teams/teams-ps/teams/Get-CsPolicyPackage.md new file mode 100644 index 0000000000..0e3330e1af --- /dev/null +++ b/teams/teams-ps/teams/Get-CsPolicyPackage.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsPolicyPackage +author: serdarsoysal +ms.author: serdars +manager: amitar +online version: https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage +schema: 2.0.0 +--- + +# Get-CsPolicyPackage + +## SYNOPSIS + +This cmdlet supports retrieving all the policy packages available on a tenant. + +## SYNTAX + +```powershell +Get-CsPolicyPackage [[-Identity] <String>] -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet supports retrieving all the policy packages available on a tenant. Provide the identity of a specific policy package to retrieve its definition, including details on the policies applied with the package. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsPolicyPackage +``` + +Returns all policy packages available on the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsPolicyPackage -Identity Education_PrimaryStudent +``` + +Returns only the Education_PrimaryStudent policy package. + +### Example 3 +```powershell +PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent +PS C:\> $a.Policies + +# In module versions 1.1.9+ +PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent +PS C:\> $a.Policies.AdditionalProperties + +Key Value +--- ----- +TeamsMessagingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsMeetingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsAppSetupPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsCallingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsMeetingBroadcastPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +``` + +Returns the set of policies in the Education_PrimaryStudent policy package. + +## PARAMETERS + +### -Identity + +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 +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) + +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) + +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md new file mode 100644 index 0000000000..7152c35e07 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md @@ -0,0 +1,66 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +online version: +title: Get-CsSdgBulkSignInRequestStatus +schema: 2.0.0 +--- + +# Get-CsSdgBulkSignInRequestStatus + +## SYNOPSIS +Get the status of an active bulk sign in request. + +## SYNTAX + +``` +Get-CsSdgBulkSignInRequestStatus -Batchid <String> [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to get granular device level details of a bulk sign in request. Status is shown for every username and hardware ID pair included in the device details CSV used as input to the bulk sign in request. + +## EXAMPLES + +### Example 1 +```powershell +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC +$newBatchResponse.BatchId +$getBatchStatusResponse = Get-CsSdgBulkSignInRequestStatus -Batchid $newBatchResponse.BatchId +$getBatchStatusResponse | ft +$getBatchStatusResponse.BatchItem +``` + +This example shows how to read the batch status response into a new variable and print the status for every batch item. + +## PARAMETERS + +### -Batchid +Batch ID is the response returned by the `New-CsSdgBulkSignInRequest` cmdlet. It is used as input for querying the status of the batch through `Get-CsSdgBulkSignInRequestStatus` cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISdgBulkSignInRequestStatusResult + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md new file mode 100644 index 0000000000..b1f9e93472 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md @@ -0,0 +1,48 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +online version: +title: Get-CsSdgBulkSignInRequestsSummary +schema: 2.0.0 +--- + +# Get-CsSdgBulkSignInRequestsSummary + +## SYNOPSIS +Get the tenant level summary of all bulk sign in requests executed in the past 30 days. + +## SYNTAX + +``` +Get-CsSdgBulkSignInRequestsSummary [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet gives the overall tenant level summary of all bulk sign in requests executed for a particular tenant within the last 30 days. Status is shown at batch level as succeeded / failed. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsSdgBulkSignInRequestsSummary +``` + +This example shows how to run the cmdlet to get a tenant level summary. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISdgBulkSignInRequestsSummaryResponseItem + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..eed80beb3f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: Get-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +Get-CsSharedCallQueueHistoryTemplate -Id <string> [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsSharedCallQueueHistoryTemplate -Id 3a4b3d9b-91d8-4fbf-bcff-6907f325842c +``` + +This example retrieves the Shared Call Queue History Template with the Id `3a4b3d9b-91d8-4fbf-bcff-6907f325842c` + +### -------------------------- Example 2 -------------------------- +``` +Get-CsSharedCallQueueHistoryTemplate +``` + +This example retrieves all the Shared Call Queue History Templates + +## PARAMETERS + +### -Id +The Id of the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: false +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsSharedCallQueueHistoryTemplate](./New-CsSharedCallQueueHistoryTemplate.md) + +[Set-CsSharedCallQueueHistoryTemplate](./Set-CsSharedCallQueueHistoryTemplate.md) + +[Remove-CsSharedCallQueueHistoryTemplate](./Remove-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/Get-CsTeamTemplate.md b/teams/teams-ps/teams/Get-CsTeamTemplate.md new file mode 100644 index 0000000000..de8f75a2f2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamTemplate.md @@ -0,0 +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 <String> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## 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 \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter + - `[Bssid <String>]`: + - `[ChassisId <String>]`: + - `[CivicAddressId <String>]`: Civic address id. + - `[Country <String>]`: + - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. + - `[Id <String>]`: + - `[Identity <String>]`: + - `[Locale <String>]`: + - `[LocationId <String>]`: Location id. + - `[OdataId <String>]`: A composite URI of a template. + - `[OperationId <String>]`: The ID of a batch policy assignment operation. + - `[OrderId <String>]`: + - `[PackageName <String>]`: The name of a specific policy package + - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. + - `[Port <String>]`: + - `[PortInOrderId <String>]`: + - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. + - `[SubnetId <String>]`: + - `[TenantId <String>]`: + - `[UserId <String>]`: 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) diff --git a/teams/teams-ps/teams/Get-CsTeamTemplateList.md b/teams/teams-ps/teams/Get-CsTeamTemplateList.md new file mode 100644 index 0000000000..c9928c4038 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamTemplateList.md @@ -0,0 +1,147 @@ +--- +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] <String>] [<CommonParameters>] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplateList -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## 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 \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter\ +\[Bssid \<String\>\]:\ +\[ChassisId \<String\>\]:\ +\[CivicAddressId \<String\>\]: Civic address id.\ +\[Country \<String\>\]:\ +\[GroupId \<String\>\]: The ID of a group whose policy assignments will be returned.\ +\[Id \<String\>\]:\ +\[Identity \<String\>\]:\ +\[Locale \<String\>\]: The language and country code of templates localization.\ +\[LocationId \<String\>\]: Location id.\ +\[OdataId \<String\>\]: A composite URI of a template.\ +\[OperationId \<String\>\]: The ID of a batch policy assignment operation.\ +\[OrderId \<String\>\]:\ +\[PackageName \<String\>\]: The name of a specific policy package\ +\[PolicyType \<String\>\]: The policy type for which group policy assignments will be returned.\ +\[Port \<String\>\]:\ +\[PortInOrderId \<String\>\]:\ +\[SubnetId \<String\>\]:\ +\[TenantId \<String\>\]:\ +\[UserId \<String\>\]: 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) diff --git a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..77a631f12f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Get-CsTeamsAIPolicy + +## SYNOPSIS + +This cmdlet retrieves all Teams AI policies for the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsAIPolicy [[-Identity] <String>] [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet retrieves all Teams AI policies for the tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsAIPolicy +``` + +Retrieves Teams AI policies and shows "EnrollFace", "EnrollVoice" and "SpeakerAttributionBYOD" values. + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md new file mode 100644 index 0000000000..6ba81b228a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsAcsFederationConfiguration +author: tomkau +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration +schema: 2.0.0 +--- + +# 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). + +## SYNTAX + +```powershell +Get-CsTeamsAcsFederationConfiguration + [-Identity <String[]>] + [-Filter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION + +Federation between Teams and Azure Communication Services (ACS) allows users of custom solutions built with ACS to connect and communicate with Teams users over voice, video, Teams users over voice, video and screen sharing, and more. For more information, see [Teams interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). + +This cmdlet is used retrieve the Teams and ACS federation configuration for a Teams tenant. + +You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. + +## Examples + +### Example 1 +```powershell +PS C:\> Get-CsTeamsAcsFederationConfiguration + +Identity : Global +AllowedAcsResources : {'faced04c-2ced-433d-90db-063e424b87b1'} +EnableAcsUsers : True +``` + +In this example, federation has been enabled for just one ACS resource. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsAcsFederationConfiguration + +Identity : Global +AllowedAcsResources : {} +EnableAcsUsers : False +``` + +In this example, federation is disabled for all ACS resources. + +## PARAMETERS + +### -Filter +Enables you to use wildcards when specifying the Teams and ACS federation configuration settings to be returned. +Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. +However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the collection of tenant federation configuration settings to be modified. Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the Set-CsTenantFederationConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. For example: + +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md new file mode 100644 index 0000000000..cc36983ff2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Get-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# Get-CsTeamsAppPermissionPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies> and about app centric management at <https://learn.microsoft.com/microsoftteams/app-centric-management>. + +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsAppPermissionPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsAppPermissionPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies>. + +## EXAMPLES + +### Example 1 + +```powershell +Get-CsTeamsAppPermissionPolicy -Identity Global +``` + +```Output +Identity : Global +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList +``` +Get the global Teams app permission policy. + +### Example 2 + +```powershell +Get-CsTeamsAppPermissionPolicy +``` + +```Output +Identity : Global +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList + +Identity : Tag:test +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList +``` +Get all the Teams app permission policies. + +## PARAMETERS + +### -Filter +Do not use + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the app setup permission policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..47de4b4b99 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md @@ -0,0 +1,165 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsAppSetupPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsAppSetupPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## EXAMPLES + +### Example 1 + +```powershell +Get-CsTeamsAppSetupPolicy -Identity Global +``` + +```Output +Identity : Global +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4...} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True +``` +Get all the Teams App Setup Policies. + +### Example 2 + +```powershell +Get-CsTeamsAppSetupPolicy +``` + +```Output +Identity : Global +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4...} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True + +Identity : Tag:Set-test +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4...} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True +``` +Get all the Teams App Setup Policies. + +## PARAMETERS + +### -Filter +Do not use. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of 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 +``` + +### -LocalStore +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md new file mode 100644 index 0000000000..77cad0be0c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md @@ -0,0 +1,110 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy +title: Get-CsTeamsAudioConferencingPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsAudioConferencingPolicy + +## SYNOPSIS + +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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsAudioConferencingPolicy [[-Identity] <String>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsAudioConferencingPolicy [-LocalStore] [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsTeamsAudioConferencingPolicy cmdlet enables administrators to control audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. The Get-CsTeamsAudioConferencingPolicy cmdlet enables you to return information about all the audio-conferencing policies that have been configured for use in your organization. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Get-CsTeamsAudioConferencingPolicy +``` + +The command shown in Example 1, Get-CsTeamsAudioConferencingPolicy is called without any additional parameters; this returns a collection of all the teams audio conferencing policies configured for use in your organization. + +### EXAMPLE 2 +``` +PS C:\> Get-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" +``` + +The command shown in Example 2, Get-CsTeamsAudioConferencingPolicy is used to return the per-user audio conferencing policy that has an Identity "EMEA Users". Because identities are unique, this command will never return more than one item. + +## 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 for the policy to be retrieved. To retrieve the global policy, use this syntax: -Identity global. To retrieve a per-user policy use syntax similar to this: -Identity "EMEA Users". +If this parameter is not included, the Get-CsTeamsAudioConferencingPolicy cmdlet will return a collection of all the teams audio conferencing policies configured for use in your organization. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +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 + +### Object +## NOTES + +## RELATED LINKS + +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) + +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) + +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md new file mode 100644 index 0000000000..479035c0ea --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy +applicable: Microsoft Teams +title: Get-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Get-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Returns information about the policies configured to customize the call hold experience for Teams clients. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCallHoldPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsCallHoldPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy +``` + +The command shown in Example 1 returns information for all the Teams call hold policies configured for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerCallHoldPolicy' +``` + +In Example 2, information is returned for a single Teams call hold policy: the policy with the Identity ContosoPartnerCallHoldPolicy. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' +``` + +The command shown in Example 3 returns information about all the Teams call hold policies configured at the per-user scope. +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more Teams call hold policies. +For example, to return all the policies configured at the per-user scope, use this syntax: + +-Filter "Tag:\*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the Teams call hold policy to be retrieved. + +To return the global policy, use this syntax: + +`-Identity "Global"` + +To return a policy configured at the per-user scope, use syntax like this: + +`-Identity "ContosoPartnerCallHoldPolicy"` + +You cannot use wildcard characters when specifying the Identity. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md new file mode 100644 index 0000000000..e9b195959d --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md @@ -0,0 +1,121 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCallParkPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsCallParkPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsCallParkPolicy +``` + +Retrieve all policies that are available in your organization. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the unique name of a policy you would like to retrieve + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Internal Microsoft use only. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..44a936109d --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTeamsCallingPolicy + +## SYNOPSIS + +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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCallingPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsCallingPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION + +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 and interoperability with Skype for Business. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsCallingPolicy -Identity SalesCallingPolicy +``` + +Retrieves the calling policy with the Identity "SalesCallingPolicy". + +### Example 2 +```powershell +Get-CsTeamsCallingPolicy -Filter "tag:Sales*" +``` + +Retrieves the calling policies with Identity starting with Sales. + +## PARAMETERS + +### -Identity +Specify the TeamsCallingPolicy that you would like to retrieve. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) + +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md new file mode 100644 index 0000000000..444867452e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md @@ -0,0 +1,122 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTeamsChannelsPolicy + +## SYNOPSIS + +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsChannelsPolicy [[-Identity] <XdsIdentity>] [-LocalStore] [-Tenant <System.Guid>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsChannelsPolicy [-Filter <String>] [-LocalStore] [-Tenant <System.Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. The Get-CsTeamsChannelsPolicy returns policies that are available for use within your organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsChannelsPolicy +``` + +Retrieves all policies related to Teams & Channels that are available in your organization. + +## 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:<Name>`, but the `<Name>` 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: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Internal Microsoft use only. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsClientConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTeamsClientConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md index dc61fa1cf2..8ade0c1ba8 100644 --- a/skype/skype-ps/skype/Get-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md @@ -1,9 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsclientconfiguration +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Get-CsTeamsClientConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsClientConfiguration @@ -33,7 +38,7 @@ Use in conjunction with Set-CsTeamsClientConfiguration to update the settings in ### Example 1 ```powershell -PS C:\> Get-CsTeamsClientConfiguration +Get-CsTeamsClientConfiguration ``` Retrieves the effective client configuration in the tenant. @@ -101,14 +106,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md new file mode 100644 index 0000000000..a480bcadfc --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: Get-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Get-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Filter <String>] + [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Note that if neither the Identity nor the Filter parameters are specified, then Get-CsTeamsComplianceRecordingApplication returns all application instances of policy-based recording applications that are associated with a Teams recording policy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication +``` + +The command shown in Example 1 returns information for all the application instances of policy-based recording applications associated with Teams recording policies. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144' +``` + +In Example 2, information is returned for a single application instance of a policy-based recording application with the Identity Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication -Filter 'Tag:*' +``` + +The command shown in Example 3 returns all the application instances associated with Teams recording policies at the per-user scope. +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". + +### Example 4 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication -Filter 'Tag:ContosoPartnerComplianceRecordingPolicy*' +``` + +The command shown in Example 4 returns all the application instances associated with Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +To do this, the command uses the Filter parameter and the filter value "Tag:ContosoPartnerComplianceRecordingPolicy\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:ContosoPartnerComplianceRecordingPolicy". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more application instances of policy-based recording applications. +For example, to return all the application instances associated with Teams recording policies at the per-user scope, use this syntax: + +-Filter "Tag:\*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Identity +Unique identifier of the application instance of a policy-based recording application to be retrieved. + +You cannot use wildcard characters when specifying the Identity. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md new file mode 100644 index 0000000000..a406247e81 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Get-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Get-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Returns information about the policies configured for governing automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsComplianceRecordingPolicy [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsComplianceRecordingPolicy [-Tenant <System.Guid>] [-Filter <String>] + [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that if neither the Identity nor the Filter parameters are specified, then Get-CsTeamsComplianceRecordingPolicy returns all the Teams recording policies configured for use in the tenant. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy +``` + +The command shown in Example 1 returns information for all the Teams recording policies configured for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' +``` + +In Example 2, information is returned for a single Teams recording policy: the policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy -Filter 'Tag:*' +``` + +The command shown in Example 3 returns information about all the Teams recording policies configured at the per-user scope. +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more Teams recording policies. +For example, to return all the policies configured at the per-user scope, use this syntax: + +-Filter "Tag:\*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Identity +Unique identifier of the Teams recording policy to be retrieved. +To return the global policy, use this syntax: + +-Identity "Global" + +To return a policy configured at the per-user scope, use syntax like this: + +-Identity "ContosoPartnerComplianceRecordingPolicy" + +You cannot use wildcard characters when specifying the Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md new file mode 100644 index 0000000000..e56310edf7 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Get-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCortanaPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsCortanaPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, if a user can use Cortana voice assistant in Microsoft Teams and determines Cortana invocation behavior via CortanaVoiceInvocationMode parameter - + +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsCortanaPolicy +``` +In the first example, the Get-CsTeamsCortanaPolicy cmdlet is called without specifying any additional parameters. This causes the Get-CsTeamsCortanaPolicy cmdlet to return a collection of all the Cortana voice assistant policies configured for use in your organization. + +## PARAMETERS + +### -Filter + +Enables you to use wildcards when specifying the policy (or policies) to be retrieved. For example, this syntax returns all the policies that have been configured at the site scope: -Filter "site:". This syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:". +You cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be returned. To return the global policy, use this syntax: -Identity global. To return a policy configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To return a policy configured at the service scope, use syntax similar to this: -Identity "Registrar:atl-cs-001.litwareinc.com". + +Policies can also be configured at the per-user scope. To return one of these policies, use syntax similar to this: -Identity "SalesDepartmentPolicy". +If this parameter is not included then all of Cortana voice assistant policies configured for use in your organization will be returned. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore + +Retrieves the Cortana voice assistant policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Cortana voice assistant policies are being returned. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..963877780a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md @@ -0,0 +1,79 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscustombannertext +title: Get-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# Get-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCustomBannerText [[-Identity] <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +Returns all or a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsCustomBannerText +``` + +This example gets the properties of all instances of the TeamsCustomBannerText. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsCustomBannerText -Identity CustomText +``` + +This example gets the properties of the CustomText instance of TeamsCustomBannerText. + +## PARAMETERS + +### -Identity +Policy instance name (optional). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md new file mode 100644 index 0000000000..9a3a36317e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md @@ -0,0 +1,121 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEducationAssignmentsAppPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsEducationAssignmentsAppPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] + [<CommonParameters>] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEducationAssignmentsAppPolicy +``` + +Retrieves the policy in your organization + +## PARAMETERS + +### -Filter +Not applicable - you cannot create custom policies, so will always be retrieving the global policy for your organization. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only value supported is "Global" + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Internal use only. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsTeamsEducationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md new file mode 100644 index 0000000000..09801a74c1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsEducationConfiguration +author: SaritaBehera +ms.author: saritabehera +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsEducationConfiguration + +## SYNOPSIS + +This cmdlet is used to retrieve the organization-wide education configuration for Teams. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsEducationConfiguration [-Identity <String>] [<CommonParameters>] +``` + +### Filter +```powershell +Get-CsTeamsEducationConfiguration [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet is used to retrieve the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + +You must be a Teams Service Administrator for your organization to run the cmdlet. + +## Examples + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEducationConfiguration + +Identity : Global +ParentGuardianPreferredContactMethod : Email +UpdateParentInformation : Enabled +``` + +In this example, the organization has set the defaults as follows: + +- Email is set as the preferred contact method for the parent communication invites. +- Capability to edit parent contact information by educators is enabled. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters in order to return a collection of team education configuration settings. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the configuration. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md new file mode 100644 index 0000000000..82cff25140 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md @@ -0,0 +1,107 @@ +--- +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 +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Get-CsTeamsEmergencyCallRoutingPolicy + +## SYNOPSIS +This cmdlet returns one or more Emergency Call Routing policies. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEmergencyCallRoutingPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsEmergencyCallRoutingPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet returns one or more Emergency Call Routing policies. This policy is used for the life cycle of emergency call routing - emergency numbers and routing configuration. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsEmergencyCallRoutingPolicy +``` + +Retrieves all emergency call routing policies that are available in your scope. + +### Example 2 +```powershell +Get-CsTeamsEmergencyCallRoutingPolicy -Identity TestECRP +``` + +Retrieves one emergency call routing policy specifying the identity. + +### Example 3 +```powershell +Get-CsTeamsEmergencyCallRoutingPolicy -Filter 'Test*' +``` + +Retrieves all emergency call routing policies with identity starting with Test. + +## PARAMETERS + +### -Identity +Specify the policy that you would like to retrieve. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```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 + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) + +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) + +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..2bae2ad08c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,126 @@ +--- +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 +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Get-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEmergencyCallingPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsEmergencyCallingPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet returns one or more emergency calling policies. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsEmergencyCallingPolicy +``` + +Retrieves all emergency calling policies that are available in your scope. + +### Example 2 +```powershell +Get-CsTeamsEmergencyCallingPolicy -Identity TestECP +``` + +Retrieves an emergency calling policy with the identity TestECP + +### Example 3 +```powershell +Get-CsTeamsEmergencyCallingPolicy -Filter Test* +``` + +Retrieves all emergency calling policies with Identity starting with Test. + +### Example 4 +```powershell +(Get-CsTeamsEmergencyCallingPolicy -Identity TestECP).ExtendedNotifications +``` +```output +EmergencyDialString : 112 +NotificationGroup : alert2@contoso.com +NotificationDialOutNumber : +NotificationMode : ConferenceUnMuted + +EmergencyDialString : 911 +NotificationGroup : alert3@contoso.com +NotificationDialOutNumber : +14255551234 +NotificationMode : NotificationOnly +``` + +This example displays extended notifications set on emergency calling policy with the identity TestECP. + +## PARAMETERS + +### -Identity +Specify the policy that you would like to retrieve. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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. + +```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 + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) + +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md new file mode 100644 index 0000000000..d1c2fd903d --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md @@ -0,0 +1,111 @@ +--- +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] <Object>] [-Filter <Object>] + [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..db497af1ae --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md @@ -0,0 +1,90 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy +title: Get-CsTeamsEventsPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsEventsPolicy + +## SYNOPSIS +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEventsPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsEventsPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEventsPolicy +``` + +Returns information for all Teams Events policies available for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsEventsPolicy -Identity Global +``` + +Returns information for Teams Events policy with identity "Global". + +## PARAMETERS + +### -Filter +Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md new file mode 100644 index 0000000000..ca976fe3ca --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsexternalaccessconfiguration +title: Get-CsTeamsExternalAccessConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsExternalAccessConfiguration + +## SYNOPSIS +The TeamsExternalAccessConfiguration contains all configurations that can be used to enhance the security of the entire organization, such as managing blocked users. This cmdlet returns the current settings of your organization. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsExternalAccessConfiguration [[-Identity] <XdsIdentity>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsExternalAccessConfiguration [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the current Teams External Access Configuration in the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsExternalAccessConfiguration +``` + +In this example, we retrieve the Teams External Access Configuration in the organization. + +## PARAMETERS + +### -Filter +Internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only value accepted is Global + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsExternalAccessConfiguration.Cmdlets.TeamsExternalAccessConfiguration + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..5000645a03 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md @@ -0,0 +1,88 @@ +--- +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 +ms.author: tomkau +ms.reviewer: +--- + +# Get-CsTeamsFeedbackPolicy + +## SYNOPSIS + +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. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsFeedbackPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsFeedbackPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the current Teams Feedback policies (the ability to send feedback about Teams to Microsoft and whether they receive the survey) in the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsFeedbackPolicy +``` + +In this example, we retrieve all the existing Teams feedback policies in the organization. + +## PARAMETERS + +### -Identity +The unique identifier of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Internal Microsoft use + +```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 diff --git a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..0340a280a1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy +title: Get-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsFilesPolicy + +## SYNOPSIS +Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured policy instances related to teams files. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsFilesPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsFilesPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet retrieves information about one or more teams files policies that have been configured for use in your organization. +teams files policies are used by the organization to manage files-related features such as third party storage provider for files from teams. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsFilesPolicy +``` + +In Example 1, the Get-CsTeamsFilesPolicy cmdlet is called without any additional parameters; this returns a collection of all the teams files policies configured for use in your organization. + +### Example 2 +``` +Get-CsTeamsFilesPolicy -Identity TranscriptionDisabled +``` + +In Example 2, the Get-CsTeamsFilesPolicy cmdlet is used to return the per-user teams files policy that has an Identity TranscriptionDisabled. +Because identities are unique, this command will never return more than one item. + +### Example 3 +``` +Get-CsTeamsFilesPolicy -Filter "tag:*" +``` + +Example 3 uses the Filter parameter to return all the teams files policies that have been configured at the per-user scope. +The filter value "tag:*" tells the Get-CsTeamsFilesPolicy cmdlet to return only those policies that have an Identity that begins with the string value "tag:". + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. +If this parameter is omitted, all teams files policies available for use are returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. +For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md new file mode 100644 index 0000000000..274a3a8171 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration +title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration +schema: 2.0.0 +author: boboPD +ms.author: pradas +--- + +# Get-CsTeamsFirstPartyMeetingTemplateConfiguration + +## SYNOPSIS +This cmdlet fetches the first-party meeting templates stored on the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsFirstPartyMeetingTemplateConfiguration [[-Identity] <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Fetches the list of first-party templates on the tenant. Each template object contains its list of meeting options, the name of the template, and its ID. + +This is a read-only configuration. + +## EXAMPLES + +### Example 1 - Fetching all first party meeting templates on the tenant + +```powershell +PS C:\> Get-CsTeamsFirstPartyMeetingTemplateConfiguration + +Identity : Global +TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb, + firstparty_399f69a3-c482-41bf-9cf7-fcdefe269ce6, + firstparty_64c92390-c8a2-471e-96d9-4ee8f6080155...} +Description : The `TeamsMeetingTemplates` property contains the meeting template details: + +TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby, + EntryExitAnnouncementsEnabled...} +Description : Townhall +Name : firstparty_21f91ef7-6265-4064-b78b-41ab66889d90 +Category : + +TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption} +Description : Virtual appointment +Name : firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 +Category : +``` + +Fetches all the first-party templates on the tenant. + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the configuration. + +Note: This configuration is read only and will only have the Global instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) diff --git a/skype/skype-ps/skype/Get-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Get-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md index 8eadf567f9..c14d3fbeec 100644 --- a/skype/skype-ps/skype/Get-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md @@ -1,9 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestcallingconfiguration +Module Name: MicrosoftTeams title: Get-CsTeamsGuestCallingConfiguration -online version: schema: 2.0.0 +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: --- # Get-CsTeamsGuestCallingConfiguration @@ -33,10 +37,10 @@ Returns information about the GuestCallingConfiguration, which specifies what op ### Example 1 ```powershell -PS C:\> Get-CsTeamsGuestCallingConfiguration +Get-CsTeamsGuestCallingConfiguration ``` -Returns the results +Returns the results ## PARAMETERS @@ -101,15 +105,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None + ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Get-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md index 2194e93bae..fb9aee778f 100644 --- a/skype/skype-ps/skype/Get-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md @@ -1,10 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online -title: Get-CsTeamsGuestCallingConfiguration +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmeetingconfiguration +applicable: Microsoft Teams +title: Get-CsTeamsGuestMeetingConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsGuestMeetingConfiguration @@ -35,7 +39,7 @@ The TeamsGuestMeetingConfiguration designates which meeting features guests leve ### Example 1 ```powershell -PS C:\> Get-CsTeamsGuestMeetingConfiguration +Get-CsTeamsGuestMeetingConfiguration ``` Returns the TeamsGuestMeetingConfiguration set in your organization. @@ -103,15 +107,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None + ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md new file mode 100644 index 0000000000..c5dbf828bd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmessagingconfiguration +applicable: Microsoft Teams +title: Get-CsTeamsGuestMessagingConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTeamsGuestMessagingConfiguration + +## SYNOPSIS +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet returns your organization's current settings. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] + [<CommonParameters>] +``` + +## DESCRIPTION +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsGuestMessagingConfiguration +``` + +The command shown in Example 1 returns teams guest messaging configuration information for the current tenant + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters in order to return a collection of tenant guest messaging configuration settings. +Because each tenant is limited to a single, global collection of guest messaging configuration settings there is no need to use the Filter parameter. + +```yaml +Type: String +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 guest messaging configuration settings to be returned. +Because each tenant is limited to a single, global collection of guest 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: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +This parameter is not used with Skype for Business Online. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md new file mode 100644 index 0000000000..4df635ab40 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsipphonepolicy +applicable: Microsoft Teams +title: Get-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Get-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Get-CsTeamsIPPhonePolicy allows IT Admins to view policies for IP Phone experiences in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsIPPhonePolicy [[-Identity] <String>] + [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsIPPhonePolicy [-Filter <String>] + [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +## DESCRIPTION + +Returns information about the Teams IP Phone Policies configured for use in your organization. Teams IP phone policies enable you to configure the different sign-in experiences based upon the function the device is performing; example: common area phone. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsIPPhonePolicy -identity CommonAreaPhone +``` + +Retrieves the IP Phone Policy with name "CommonAreaPhone". + +## PARAMETERS + +### -Identity +Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +Internal Microsoft use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..8c4debe867 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Get-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS + +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMediaConnectivityPolicy [-Identity <String>] [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsMediaConnectivityPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMediaConnectivityPolicy + +Identity DirectConnection +-------- ---------------- +Tag:Test Enabled +``` + +This example retrieves the Teams media connectivity policies and shows the result as identity tag and "DirectConnection" value. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Media Connectivity Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) + +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md new file mode 100644 index 0000000000..85ecd6cb9c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md @@ -0,0 +1,111 @@ +--- +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 +manager: shalages +schema: 2.0.0 +--- + +# Get-CsTeamsMediaLoggingPolicy + +## SYNOPSIS + +Returns information about the Teams Media Logging policy. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsMediaLoggingPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter + +``` +Get-CsTeamsMediaLoggingPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +Returns information about the Teams Media Logging policy. +TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After removing the policy, media logging setting will revert to the previous value. + +NOTES: +TeamsMediaLoggingPolicy has only one instance that is built into the system, so there is no corresponding New cmdlet. + +## EXAMPLES + +### EXAMPLE 1 + +```PowerShell +PS C:\> Get-CsTeamsMediaLoggingPolicy +``` + +Return information for all Teams Media Logging policies available for use in the tenant. + +### EXAMPLE 2 + +```PowerShell +PS C:\> Get-CsTeamsMediaLoggingPolicy -Identity Global +``` + +Return Teams Media Logging policy that is set for the entire tenant. + +## PARAMETERS + +### -Identity + +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: Identity +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +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. + +```yaml +Type: String +Parameter Sets: Filter +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Grant-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..d7a61ce63f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# Get-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMeetingBrandingPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsMeetingBrandingPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The `Get-CsTeamsMeetingBrandingPolicy` cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. + +## EXAMPLES + +### Return all branding policies +```powershell +PS C:\> Get-CsTeamsMeetingBrandingPolicy +``` + +In this example, the command returns a collection of all the teams meeting branding policies configured for use in your organization. + +### Return specified policy +```powershell +PS C:\> CsTeamsMeetingBrandingPolicy -Identity "policy test2" +``` + +In this example, the command returns the meeting branding policy that has an **Identity** `policy test 2`. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: `-Identity global`. If this parameter is omitted, then all the meeting branding policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### TeamsMeetingBrandingPolicy.Cmdlets.TeamsMeetingBrandingPolicy + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md index d8cbf0b9e5..973021d356 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md @@ -1,10 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastconfiguration +applicable: Microsoft Teams title: Get-CsTeamsMeetingBroadcastConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsMeetingBroadcastConfiguration @@ -29,7 +33,7 @@ Get-CsTeamsMeetingBroadcastConfiguration [-Tenant <Guid>] [-ExposeSDNConfigurati ``` ## DESCRIPTION -Tenant level configuration for broadcast events in Teams +Tenant level configuration for broadcast events in Teams ## EXAMPLES @@ -111,15 +115,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None + ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md new file mode 100644 index 0000000000..0b2ca7c3cd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md @@ -0,0 +1,128 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTeamsMeetingBroadcastPolicy + +## SYNOPSIS +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to retrieve one or more policies. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsMeetingBroadcastPolicy +``` +Returns all the Teams Meeting Broadcast policies. + +### Example 2 +``` +Get-CsTeamsMeetingBroadcastPolicy -Filter "Education_Teacher" +``` + +In this example, the -Filter parameter is used to return all the policies that match "Education_Teacher". + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when specifying the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the policy to be retrieved. 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 SalesPolicy. + +If this parameter is not included, the cmdlet will return a collection of all the 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 policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Not applicable to the online service. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Not applicable to online service. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md similarity index 78% rename from skype/skype-ps/skype/Get-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md index 417dc65cbc..3cd9448904 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md @@ -1,35 +1,44 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingconfiguration +applicable: Microsoft Teams title: Get-CsTeamsMeetingConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsMeetingConfiguration ## SYNOPSIS -The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants.  +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. ## SYNTAX ### Identity (Default) + ``` Get-CsTeamsMeetingConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] ``` ### Filter + ``` Get-CsTeamsMeetingConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] ``` ## DESCRIPTION -The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants.  Use this cmdlet to retrieve the configuration set in your organization. + +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. Use this cmdlet to retrieve the configuration set in your organization. ## EXAMPLES ### Example 1 + ```powershell PS C:\> Get-CsTeamsMeetingConfiguration ``` @@ -39,6 +48,7 @@ Returns the configuration set in the organization. ## PARAMETERS ### -Filter + Internal Microsoft use ```yaml @@ -54,6 +64,7 @@ Accept wildcard characters: False ``` ### -Identity + The only valid input is "Global" ```yaml @@ -84,6 +95,7 @@ Accept wildcard characters: False ``` ### -Tenant + Internal Microsoft use ```yaml @@ -99,15 +111,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None + ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md similarity index 76% rename from skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md index 59f34252fc..3679deb1f5 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy +applicable: Microsoft Teams title: Get-CsTeamsMeetingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsMeetingPolicy @@ -32,15 +37,14 @@ The Get-CsTeamsMeetingPolicy cmdlet enables you to return information about all ## EXAMPLES ### -------------------------- 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 -------------------------- -``` +```powershell Get-CsTeamsMeetingPolicy -Identity SalesPolicy ``` @@ -48,7 +52,7 @@ In Example 2, Get-CsTeamsMeetingPolicy is used to return the per-user meeting po Because identities are unique, this command will never return more than one item. ### -------------------------- Example 3 -------------------------- -``` +```powershell Get-CsTeamsMeetingPolicy | Where-Object {$_.AllowMeetNow -eq $True} ``` @@ -56,6 +60,18 @@ 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 -------------------------- +```powershell +Get-CsTeamsMeetingPolicy -Identity Global | fl NewMeetingRecordingExpirationDays +``` + +```Output +NewMeetingRecordingExpirationDays : 60 +``` + +The above command returns expiration date setting currently applied on TMR. For more details, see: +[Auto-expiration of Teams meeting recordings](https://learn.microsoft.com/microsoftteams/cloud-recording#auto-expiration-of-teams-meeting-recordings). + ## PARAMETERS ### -Filter @@ -117,25 +133,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob - -```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 ### None - ## OUTPUTS ### System.Object @@ -143,4 +147,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md new file mode 100644 index 0000000000..f5121f5202 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsMeetingTemplateConfiguration +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsMeetingTemplateConfiguration + +## SYNOPSIS +This cmdlet fetches the custom meeting templates stored on the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsMeetingTemplateConfiguration [[-Identity] <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Fetches the list of custom templates on the tenant. Each template object contains its list of meeting options, the name of the template, and its ID. + +## EXAMPLES + +### Example 1 - Fetching all custom meeting templates on the tenant + +```powershell +PS C:\> Get-CsTeamsMeetingTemplateConfiguration + +Identity : Global +TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, + customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5, + customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...} +Description : The `TeamsMeetingTemplates` property contains the meeting template details: + +TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby, + EntryExitAnnouncementsEnabled...} +Description : Custom Template 1 +Name : customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969 +Category : + +TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption} +Description : Custom Template 2 +Name : customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5 +Category : +``` + +Fetches all the custom templates on the tenant. + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the configuration. + +Note: This configuration is read only and will only have the Global instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..22af122659 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. + +## SYNTAX + +### Identity +```powershell +Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +```powershell +Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Fetches the instances of the policy. Each policy object contains a property called `HiddenMeetingTemplates`.This array contains the list of meeting template IDs that will be hidden by that instance of the policy. + +## EXAMPLES + +### Example 1 - Fetching all policies + +```powershell +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy + +Identity : Global +HiddenMeetingTemplates : {} +Description : + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : + +Identity : Tag:dashbrd test +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : test + +Identity : Tag:Default +HiddenMeetingTemplates : {} +Description : +``` + +Fetches all the policy instances currently available. + +### Example 2 - Fetching a specific policy using its identity + +```powershell +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +Fetches an instance of a policy with known identity. + +### Example 3 - Fetching policies using regex + +```powershell +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy -Filter *Foo* + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md similarity index 76% rename from skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md index 8dfc68e91e..8f998b1d2f 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md @@ -1,16 +1,19 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy +applicable: Microsoft Teams title: Get-CsTeamsMessagingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsMessagingPolicy ## SYNOPSIS -Get-CsTeamsMessagingPolicy \[\[-Identity\] \<XdsIdentity\>\] \[-Tenant \<guid\>\] \[-LocalStore\] \[\<CommonParameters\>\] - -Get-CsTeamsMessagingPolicy \[-Tenant \<guid\>\] \[-Filter \<string\>\] \[-LocalStore\] \[\<CommonParameters\>\] +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. ## SYNTAX @@ -102,25 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob - -```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 ### None - ## OUTPUTS ### System.Object @@ -128,4 +119,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md new file mode 100644 index 0000000000..3a147f9743 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Get-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Get-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMobilityPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsMobilityPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The Get-CsTeamsMobilityPolicy cmdlet allows administrators to get all teams mobility policies. + +NOTE: Please note that this cmdlet was deprecated and then removed from this PowerShell module. This reference will continue to be listed here for legacy purposes. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMobilityPolicy +``` +Retrieve all teams mobility policies that are available in your organization + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the unique name of a policy you would like to retrieve + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md new file mode 100644 index 0000000000..73ca7780ac --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md @@ -0,0 +1,50 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsTeamsMultiTenantOrganizationConfiguration +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +author: samlyu +ms.author: samlyu +--- + +# Get-CsTeamsMultiTenantOrganizationConfiguration + +## SYNOPSIS + +This cmdlet retrieves all tenant settings for Multi-tenant Organizations + +## SYNTAX + +``` +Get-CsTeamsMultiTenantOrganizationConfiguration [<CommonParameters>] +``` + +## DESCRIPTION + +The Get-CsTeamsMultiTenantOrganizationConfiguration cmdlet enables Teams meeting administrators to retrieve the Multi-Tenant Organization settings for their tenant. This includes the *CopilotFromHomeTenant* field, which specifies whether users in a Multi-Tenant Organization are allowed to utilize their Copilot license from their home tenant during cross-tenant meetings. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMultiTenantOrganizationConfiguration +``` + +Retrieves tenant's Multi-tenant Organization Configuration, including CopilotFromHomeTenant. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsMultiTenantOrganizationConfiguration](Set-CsTeamsMultiTenantOrganizationConfiguration.md) diff --git a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md new file mode 100644 index 0000000000..f098d86971 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md @@ -0,0 +1,123 @@ +--- +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: +manager: mreddy +schema: 2.0.0 +--- + +# Get-CsTeamsNetworkRoamingPolicy + +## SYNOPSIS + +Get-CsTeamsNetworkRoamingPolicy allows IT Admins to view policies for the Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsNetworkRoamingPolicy [-Identity <String>] + [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsNetworkRoamingPolicy [-Filter <String>] + [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns information about the Teams Network Roaming Policies configured for use in your organization. + +The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. + +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). + +To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +PS C:\> Get-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy +``` + +In Example 2, Get-CsTeamsNetworkRoamingPolicy is used to return the network roaming policy that has an Identity OfficePolicy. +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. + +```yaml +Type: String +Parameter Sets: Identity +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. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +Internal Microsoft use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md new file mode 100644 index 0000000000..95ac82e696 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md @@ -0,0 +1,100 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy +title: Get-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsNotificationAndFeedsPolicy +``` + +The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. + +## PARAMETERS + +### -Filter +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..f4c168932c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Get-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Get-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsRecordingRollOutPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsRecordingRollOutPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The Get-CsTeamsRecordingRollOutPolicy cmdlet enables you to return information about all the CsTeamsRecordingRollOutPolicy that have been configured for use in your organization. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsRecordingRollOutPolicy +``` + +In Example 1, Get-CsTeamsRecordingRollOutPolicy is called without any additional parameters; this returns a collection of all the CsTeamsRecordingRollOutPolicy configured for use in your organization. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. +If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..d0da8be66e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,99 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy +title: Get-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The name the tenant admin gave to the Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md b/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md new file mode 100644 index 0000000000..74dc4c20ca --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md @@ -0,0 +1,83 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp +title: Get-CsTeamsSettingsCustomApp +schema: 2.0.0 +--- + +# Get-CsTeamsSettingsCustomApp + +## SYNOPSIS +Get the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsSettingsCustomApp + +IsSideloadedAppsInteractionEnabled +---------------------------------- + False +``` + +Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..817189ce6e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,114 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Get-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Get-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Use the Get-CsTeamsSharedCallingRoutingPolicy cmdlet to get Teams shared calling routing policy information. +Teams shared calling routing policy is used to configure shared calling. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsSharedCallingRoutingPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsSharedCallingRoutingPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +TeamsSharedCallingRoutingPolicy is used to configure shared calling. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsSharedCallingRoutingPolicy +``` +The command shown in Example 1 returns information for all the Teams shared calling routing policies configured for use in the organization. + +### Example 2 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Identity "Seattle" +``` +In Example 2, information is returned for a single Teams shared calling routing policy; the policy with Identity Seattle. + +### Example 3 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Filter "tag:*" +``` +The command shown in Example 3 returns information about all the Teams shared calling routing policies configured at the per-user scope. + +### Example 4 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Identity Global +``` +The command shown in Example 4 returns information about the Global policy instance. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams shared calling routing policy to be retrieved. + +You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy +returns all the Teams shared calling routing policies configured for use in the organization. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md new file mode 100644 index 0000000000..e669a7e816 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md @@ -0,0 +1,107 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy +title: Get-CsTeamsShiftsAppPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsShiftsAppPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsShiftsAppPolicy +``` + +Lists any available Teams Shifts Apps Policies. + +## PARAMETERS + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique Identity assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..5bfed6ecbd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection. + +## SYNTAX + +### Get (Default) +```powershell +Get-CsTeamsShiftsConnection [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get1 +```powershell +Get-CsTeamsShiftsConnection -ConnectionId <string> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnection | Format-List +``` +```output +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : My connection 1 +State : Active +TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : My connection 2 +State : Active +TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 +``` + +Returns the list of connections. + +### Example 2 +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId a2d1b091-5140-4dd2-987a-98a8b5338744 +PS C:\> $connection.ToJsonString() +``` +```output +{ + "connectorSpecificSettings": { + "apiUrl": "https://www.contoso.com/api", + "ssoUrl": "https://www.contoso.com/sso", + "clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + }, + "id": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-000000000000", + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "name": "My connection 2", + "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", + "createdDateTime": "2023-04-06T11:05:39.8790000Z", + "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z", + "state": "Active" +} +``` +Returns the connection with the specified -ConnectionId. + +## PARAMETERS + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The connection ID. + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) + +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md new file mode 100644 index 0000000000..b236e9c29c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md @@ -0,0 +1,69 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionConnector +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionConnector + +## SYNOPSIS + +This cmdlet supports retrieving the available Shifts Connectors. + +## SYNTAX + +``` +Get-CsTeamsShiftsConnectionConnector [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet shows the available list of Shifts Connectors that can be used to synchronize a third-party workforce management system with Teams and the types of data that can be synchronized. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionConnector | Format-List +``` +``` +Id : 6A51B888-FF44-4FEA-82E1-839401E9CD74 +Name : Contoso V1 +SupportedSyncScenarioOfferShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioOpenShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioOpenShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioSwapRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeCard : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeOff : {Disabled, FromWfmToShifts} +SupportedSyncScenarioTimeOffRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioUserShiftPreference : {Disabled, FromWfmToShifts, TwoWay} +Version : 2020.3 - 2021.1 +``` +Get the list of Shifts Connectors available on the tenant. + +## 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 + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md new file mode 100644 index 0000000000..adf41720e0 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -0,0 +1,437 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionErrorReport +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionErrorReport + +## SYNOPSIS + +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. + +## SYNTAX + +### Get (Default) +```powershell +Get-CsTeamsShiftsConnectionErrorReport [-Activeness <String>] [-After <String>] [-Before <String>] + [-Code <String>] [-ConnectionId <String>] [-ConnectorInstanceId <String>] [-Operation <String>] + [-Procedure <String>] [-TeamId <String>] [-Authorization <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get1 +```powershell +Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId <String> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionErrorReport -InputObject <IConfigApiBasedCmdletsIdentity> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet returns the list of existing team mapping error reports. It can also return the configuration details for mapping result with given ID or other filters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionErrorReport +``` +```output +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +WFMAuthError 30/09/2022 14:14:08 en-US False WFMAuthErrorMessageType 74091f69-29b7-4884-aab9-ee5d705f36e3 1042 The workforce management system account credentials you've ... +WFMAuthError 17/10/2022 19:42:15 en-US False WFMAuthErrorMessageType b0d04444-d80b-490a-a573-ae3bb7f871bc 40 The workforce management system account credentials you've ... +WFMAuthError 17/10/2022 20:27:31 en-US False WFMAuthErrorMessageType 91ca35d9-1abc-4ded-bcda-dbf58a155930 94 The workforce management system account credentials you've ... +GraphUserAuthError 18/10/2022 04:46:57 en-US False GraphUserAuthErrorMessageType 4d26df1c-7133-4477-9266-5d7ffb70aa88 0 Authentication failed. Ensure that you've entered valid cre... +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD us... +BatchTeamMappingError 06/04/2023 15:24:22 en-US False BatchTeamMappingErrorMessageType bf1bc3ea-1e40-483b-b6cc-669f22f24c48 1 This designated actor profile doesn't have team ownership p... +``` + +Returns the list of all the error reports. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 74091f69-29b7-4884-aab9-ee5d705f36e3 | Format-List +``` +```output +Code : WFMAuthError +ConnectionId : +CreatedAt : 30/09/2022 14:14:08 +Culture : en-US +ErrorNotificationSent : False +ErrorType : WFMAuthErrorMessageType +Id : 74091f69-29b7-4884-aab9-ee5d705f36e3 +IntermediateIncident : 1042 +Message : The workforce management system account credentials you've provided are invalid or this account doesn't have the required permissions. +Operation : SyncSwapShiftRequestCommand +Parameter : +Procedure : ExecuteAsync +ReferenceLink : +ResolvedAt : +ResolvedNotificationSentOn : +RevisitIntervalInMinute : 1440 +RevisitedAt : +ScheduleSequenceNumber : 310673843 +Severity : Critical +TeamId : +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +TotalIncident : 1042 +Ttl : 2505600 +WfmConnectorInstanceId : WCI-6f8eb424-c347-46b4-a50b-118af8d3d546 +``` + +Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Code UserMappingError +``` +```output +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and ... +``` + +Returns the error report with error code `UserMappingError`. + +### Example 4 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Operation UserMappingHandler +``` +```output +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and ... +``` + +Returns the error report with operation `UserMappingHandler`. + +### Example 5 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2022-12-12T19:11:39.073Z +``` +```output +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 26/01/2023 14:42:27 en-US True UserMappingErrorMessageType d7ab9ab4-b60c-44d3-8c12-d8ee64a67ce8 172 Mapping failed for some users: 1 succeeded, 2 failed AAD us... +WFMAuthError 26/01/2023 16:08:31 en-US False WFMAuthErrorMessageType 7adc3e4e-124e-4613-855c-9ac1b338400a 1 The workforce management system account credentials you've ... +``` + +Returns the error report created after `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 + +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. +Set this to `Both` to get both active and inactive Error reports. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId + +The UUID of a WFM connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorInstanceId + +The UUID of a connector instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamId + +The UUID of a team in Graph. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation + +The name of the action of the controller or the name of the command. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Procedure + +The name of the executing function or procedure. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Code + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Before + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -After + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Disable-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md new file mode 100644 index 0000000000..9cae80f516 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionInstance +author: leonardospina +ms.author: lespina +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionInstance + +## SYNOPSIS +This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. + +## SYNTAX + +### Get (Default) +``` +Get-CsTeamsShiftsConnectionInstance [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get1 +``` +Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <String> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection instance. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionInstance | Format-List +``` +```output + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {testAdmin@contoso.com} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:53:59 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aaf3acd231 +Etag : "4f00c221-0000-0400-0000-642ff6480000" +Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062 +LastModifiedDateTime : 07/04/2023 10:53:59 +Name : My connection instance 1 +State : Active +SyncFrequencyInMin : 10 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : FromWfmToShifts +SyncScenarioTimeCard : FromWfmToShifts +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : FromWfmToShifts +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_2ab21992-b9b1-464a-b9cd-e0de1fac95b1 + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:54:01 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231 +Etag : "4f005d22-0000-0400-0000-642ff64a0000" +Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +LastModifiedDateTime : 07/04/2023 10:54:01 +Name : My connection instance 2 +State : Active +SyncFrequencyInMin : 30 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : Disabled +SyncScenarioTimeCard : Disabled +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : Disabled +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_6b225907-b476-4d40-9773-08b86db7b11b +``` + +Returns the list of connection instances. + +### Example 2 +```powershell +PS C:\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 +PS C:\> $ci.ToJsonString() +``` +```output +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "Disabled", + "timeCard": "Disabled", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-78F5116E-9098-45F5-B595-1153DF9D6F70", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "My connection instance 2", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" +} +``` +Returns the connection instance with the specified -ConnectorInstanceId. + +## PARAMETERS + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorInstanceId +The connector instance id + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md new file mode 100644 index 0000000000..e1910f5da5 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionOperation +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation +schema: 2.0.0 +--- + +# 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). + +## SYNTAX + +### Get (Default) +```powershell +Get-CsTeamsShiftsConnectionOperation -OperationId <String> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionOperation -InputObject <IConfigApiBasedCmdletsIdentity> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet returns the details of a specific batch team mapping operation. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> 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 +``` + +Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df-2959c7c1e5f2`. + +## PARAMETERS + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OperationId +The ID of the batch mapping operation. + +```yaml +Type: String +Parameter Sets: 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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md new file mode 100644 index 0000000000..d893f5cf7e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionSyncResult +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionSyncResult + +## SYNOPSIS + +This cmdlet supports retrieving the list of user details in the mapped teams of last sync. + +## SYNTAX + +``` +Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId <string> -TeamId <string> -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet supports retrieving the list of successful and failed users in the mapped teams of last sync. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" -TeamId "12345d29-7ee1-4259-8999-946953feb79e" +``` +```output +FailedAadUser FailedWfmUser SuccessfulUser +------------- ------------- -------------- +{LABRO} {FRPET, WAROS, JOREE} {user3@contoso.com, user2@contoso.comm, user@contoso.com} +``` + +Returns the successful and failed users in the team mapping of Teams `12345d29-7ee1-4259-8999-946953feb79e` in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. +`LABRO` in FailedAadUser column shows the list of users who failed to sync from Teams to Wfm. +`FRPET, WAROS, JOREE` in FailedWfmUser column shows the list of users who failed to sync from Wfm to Teams. +`user3@contoso.com, user2@contoso.comm, user@contoso.com` in SuccessfulUser column shows the list of users who synced in both Wfm and Teams. + +## PARAMETERS + +### -ConnectorInstanceId + +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamId + +The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: 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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md new file mode 100644 index 0000000000..7bdc708135 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionTeamMap +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionTeamMap + +## SYNOPSIS + +This cmdlet supports retrieving the list of team mappings. + +## SYNTAX + +``` +Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId <String> -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## DESCRIPTION + +Workforce management (WFM) systems have locations / sites that are mapped to a Microsoft Teams team for synchronization of shifts data. This cmdlet shows the list of mapped teams inside the connection instance. Instance IDs can be found by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" +``` +```output +TeamId TeamName TimeZone WfmTeamId WfmTeamName +------ -------- -------- --------- ----------- +12344689-758c-4598-9206-3e23416da8c2 America/Los_Angeles 1000107 +``` + +Returns the list of team mappings in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. + +In case of error, we can capture the error response as following: + +* Hold the cmdlet output in a variable: `$result=<CMDLET>` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +## PARAMETERS + +### -ConnectorInstanceId + +The ID of the connection instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -InputObject +The Identity parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: 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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap) + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md new file mode 100644 index 0000000000..f65e7c3eed --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -0,0 +1,277 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionWfmTeam +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionWfmTeam + +## SYNOPSIS + +This cmdlet supports retrieving the list of available Workforce management (WFM) teams in the connection instance. + +## SYNTAX + +### Get (Default) +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId <String> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get1 +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId <String> [-Authorization <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity1 +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <String>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -InputObject <IConfigApiBasedCmdletsIdentity> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet shows the WFM teams that are not currently mapped to a Microsoft Teams team, and thus can be mapped to a Microsoft Teams team in the connection instance. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" +``` +```output +Id Name +-- ---- +1000105 0002 - Bucktown +1000106 0003 - West Town +1000107 0005 - Old Town +1000108 0004 - River North +1000109 0001 - Wicker Park +1000111 2055 +1000112 2056 +1000114 1004 +1000115 1003 +1000116 1002 +1000122 0010 +1000124 0300 +1000125 1000 +1000126 4500 +1000128 0006 - WFM Team 1 +1000129 Test +``` + +Returns the WFM teams for the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId "a2d1b091-5140-4dd2-987a-98a8b5338744" +``` +```output +Id Name +-- ---- +1000105 0002 - Bucktown +1000106 0003 - West Town +1000107 0005 - Old Town +1000108 0004 - River North +1000109 0001 - Wicker Park +1000111 2055 +1000112 2056 +1000114 1004 +1000115 1003 +1000116 1002 +1000122 0010 +1000124 0300 +1000125 1000 +1000126 4500 +1000128 0006 - WFM Team 1 +1000129 Test +``` + +Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98a8b5338744`. + +## PARAMETERS + +### -ConnectorInstanceId + +The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId + +The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: Get1, GetViaIdentity1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity1, GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[Get-CsTeamsShiftsConnectionWfmUser](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md new file mode 100644 index 0000000000..f32eda9d1a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnectionWfmUser +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnectionWfmUser + +## SYNOPSIS + +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + +## SYNTAX + +```powershell +Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId <string> -WfmTeamId <string> -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -WfmTeamId "1000107" +``` +```output +Id Name +-- ---- +1000111 FRPET +1000121 WAROS +1000123 LABRO +1000125 JOREE +1006068 ABC +1006069 XYZ +1006095 DEF +``` + +Returns the users in the WFM team with ID `1000107` in the connection instances with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + +## PARAMETERS + +### -ConnectorInstanceId + +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WfmTeamId + +The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: 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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md new file mode 100644 index 0000000000..05e0a5d12c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md @@ -0,0 +1,99 @@ +--- +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] <XdsIdentity>] [<CommonParameters>] +``` + +### Filter +```powershell +Get-CsTeamsShiftsPolicy [-Filter <String>] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md new file mode 100644 index 0000000000..bae35132f4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md @@ -0,0 +1,53 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsSipDevicesConfiguration +author: anmandav +ms.author: anmandav +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsSipDevicesConfiguration + +## SYNOPSIS + +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration. + +## SYNTAX + +```powershell +Get-CsTeamsSipDevicesConfiguration [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration which contains settings that are applicable to SIP devices connected to Teams using Teams Sip Gateway. + +To execute the cmdlet, you need to hold a role within your organization such as Global Reader, Teams Administrator, or Teams Communication Administrator. + +## Examples + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsSipDevicesConfiguration + +Identity : Global +BulkSignIn : Enabled +``` + +In this example, the organization has Bulk SignIn enabled for their SIP devices. + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..e62879f6a5 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,95 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance +title: Get-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Get-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsSurvivableBranchAppliance [[-Identity] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode <String>] [-Filter <String>] + [<CommonParameters>] +``` + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..c978c4c0a6 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,95 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy +title: Get-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Get-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] + [<CommonParameters>] +``` + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..8b48de854b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md @@ -0,0 +1,111 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy +title: Get-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsTargetingPolicy + +## SYNOPSIS + +The Teams Targeting Policy cmdlets enable administrators to control the type of Tenant tag setting that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsTargetingPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy +``` + +In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..783c5f16c2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy +title: Get-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# Get-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Fetches the TeamsTemplatePermissionPolicy. This policy can be used to hide Teams templates from users and groups. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsTemplatePermissionPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsTemplatePermissionPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Fetches the instances of the policy. Each policy object contains a property called `HiddenTemplates`.This array contains the list of Teams template IDs that will be hidden by that instance of the policy. + +## EXAMPLES + +### Example 1 +```powershell +PS >Get-CsTeamsTemplatePermissionPolicy +``` +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Global {com.microsoft.teams.template.CoordinateIncidentResponse} +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +Fetches all the policy instances currently available. + +### Example 2 + +```powershell +PS >Get-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +Fetches an instance of a policy with known identity. + +### Example 3 + +```powershell +PS >Get-CsTeamsTemplatePermissionPolicy -Filter *Foo* +``` +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Filter +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..402b525db2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule +applicable: Microsoft Teams +title: Get-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to get an existing number manipulation rule (or list of rules). + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsTranslationRule [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsTranslationRule [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to get an existing number manipulation rule (or list of rules). The rule can be used, for example, in the settings of your SBC (Set-CSOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsTranslationRule +``` + +This command will show all translation rules that exist in the tenant. Identity, Name, Description, Pattern, and Translation parameters are listed for each rule. + +### Example 2 +```powershell +Get-CsTeamsTranslationRule -Identity AddPlus1 +``` + +This command will show Identity, Name, Description, Pattern, and Translation parameters for the "AddPlus1" rule. + +### Example 3 +```powershell +Get-CsTeamsTranslationRule -Filter 'Add*' +``` + +This command will show Identity, Name, Description, Pattern, and Translation parameters for all rules with Identity starting with Add. + +## PARAMETERS + +### -Identity +Identifier of the specific translation rule to display. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to use against the Identity of translation rules. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: +Applicable: Microsoft Teams + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md new file mode 100644 index 0000000000..cd8a81e96e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md @@ -0,0 +1,105 @@ +--- +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] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsUnassignedNumberTreatment [-Filter <string>] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..3bcd814b61 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Get-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Get-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to retrieve the current Teams Update Management policies in the organization. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsUpdateManagementPolicy [[-Identity] <String>] [-ProgressAction <ActionPreference>] + [<CommonParameters>] +``` + +### Filter +```powershell +Get-CsTeamsUpdateManagementPolicy [-Filter <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>] +``` + +## DESCRIPTION +The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsUpdateManagementPolicy +``` + +In this example, we retrieve all the existing Teams Update Management policies in the organization. + +## PARAMETERS + +### -Identity +The unique identifier of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsUpdateManagementPolicy.Cmdlets.TeamsUpdateManagementPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md new file mode 100644 index 0000000000..7443bce227 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +applicable: Microsoft Teams +title: Get-CsTeamsUpgradeConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsTeamsUpgradeConfiguration + +## SYNOPSIS +Returns information related to managing the upgrade to Teams from Skype for Business. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. For Office 365 users, it allows administrators to determine which application end users should use to join Skype for Business meetings. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUpgradeConfiguration [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsUpgradeConfiguration [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsUpgradeConfiguration is used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download the Teams app. It also allows administrators to determine which application Office 365 users should use to join Skype for Business meetings. + +Separate instances of TeamsUpgradeConfiguration exist in Office 365 and Skype for Business Server. + - TeamsUpgradeConfiguration in Office 365 applies to any user who does not have an on-premises Skype for Business account. + - TeamsUpgradeConfiguration in Skype for Business Server can used to manage on-premises users in a hybrid environment. In on-premises, only the DownloadTeams property is available. + +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download the Teams app in the background. This setting is only honored for users on Windows clients, and only if TeamsUpgradePolicy for the user meets either of these conditions: + - NotifySfbUser=true, or + - Mode=TeamsOnly + Otherwise, this setting is ignored. + +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: SkypeMeetingsApp and NativeLimitedClient. "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. This property is only available when configuring TeamsUpgradeConfiguration in Office 365. It is not honored for users homed on-premises in Skype for Business Server. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Get-CsTeamsUpgradeConfiguration +``` + +The above cmdlet lists the properties of TeamsUpgradeConfiguration. + +## PARAMETERS + +### -Identity +{{Fill Identity Description}} + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Do not use + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +These settings are only honored by newer versions of Skype for Business clients. + +## RELATED LINKS + +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) + +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) + +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md b/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md new file mode 100644 index 0000000000..1da715da85 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +applicable: Microsoft Teams +title: Get-CsTeamsUpgradePolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsTeamsUpgradePolicy + +## SYNOPSIS +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +> [!IMPORTANT] +> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUpgradePolicy [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsUpgradePolicy [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. This cmdlet returns the set of instances of this policy. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs whether chat, calling, and meeting scheduling functionality are available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. + +NOTES: + - Except for on-premise versions of Skype for Business Server, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet. + - If you are using Skype for Business Server, there are no built-in instances and you'll need to create one. Also, only the NotifySfBUsers property is available. Mode is not present. + - Using TeamsUpgradePolicy in an on-premises environmention requires Skype for Business Server 2015 with CU8 or later. + +You can also find more guidance here: [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). + +## EXAMPLES + +### Example 1: List all instances of TeamsUpgradePolicy (Skype for Business Online) +``` +PS C:\> Get-CsTeamsUpgradePolicy + +Identity : Global +Description : Users can use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : False + +Identity : Tag:UpgradeToTeams +Description : Use Teams Only +Mode : TeamsOnly +NotifySfbUsers : False + +Identity : Tag:Islands +Description : Use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : False +Action : None + +Identity : Tag:IslandsWithNotify +Description : Use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : True + +Identity : Tag:SfBOnly +Description : Use only Skype for Business +Mode : SfBOnly +NotifySfbUsers : False + +Identity : Tag:SfBOnlyWithNotify +Description : Use only Skype for Business +Mode : SfBOnly +NotifySfbUsers : True + +Identity : Tag:SfBWithTeamsCollab +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollab +NotifySfbUsers : False + +Identity : Tag:SfBWithTeamsCollabWithNotify +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollab +NotifySfbUsers : True + +Identity : Tag:SfBWithTeamsCollabAndMeetings +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollabAndMeetings +NotifySfbUsers : False + +Identity : Tag:SfBWithTeamsCollabAndMeetingsWithNotify +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollabAndMeetings +NotifySfbUsers : True +``` + +List all instances of TeamsUpgradePolicy + +### Example 2: List the global instance of TeamsUpgradePolicy (which applies to all users in a tenant unless they are explicitly assigned an instance of this policy) +``` +PS C:\> Get-CsTeamsUpgradePolicy -Identity Global + +Identity : Global +Description : Users can use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : False + +``` + +List the global instance of TeamsUpgradePolicy + +### Example 3: List all instances of TeamsUpgradePolicy in an on-premises environment +``` +PS C:\> Get-CsTeamsUpgradePolicy -Identity Global + +Identity : Global +Description : Notifications are disabled +NotifySfbUsers : False + +``` + +List all on-premises instances (if any) of TeamsUpgradePolicy. + +## PARAMETERS + +### -Identity +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -Filter +{{Fill Filter Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) + +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) + +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..41be427ab3 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy +title: Get-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsVdiPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +```powershell +Get-CsTeamsVdiPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVdiPolicy +``` + +In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy +``` + +In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} +``` + +The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md index eb5db5105d..be0b2b593d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md @@ -1,9 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvideointeropservicepolicy +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Get-CsTeamsVideoInteropServicePolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsVideoInteropServicePolicy @@ -27,7 +32,7 @@ Get-CsTeamsVideoInteropServicePolicy [-Tenant <System.Guid>] [-Filter <String>] ``` ## DESCRIPTION -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which partner(s) to use for cloud video interop. +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which partner(s) to use for cloud video interop. The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. You can assign this policy to one or more of your users leveraging the Grant-CsTeamsVideoInteropServicePolicy cmdlet. @@ -103,14 +108,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..5d698766b8 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy +title: Get-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +manager: sonaggarwal +author: emmanuelrocha001 +--- + +# Get-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to fetch policy instances of TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsVirtualAppointmentsPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsVirtualAppointmentsPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Fetches instances of TeamsVirtualAppointmentsPolicy. Each policy object contains a property called `EnableSmsNotifications`. This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment meeting template. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVirtualAppointmentsPolicy +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Global True +Tag:sms-enabled True +Tag:sms-disabled False +``` +Fetches all the policy instances currently available. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled True +``` +Fetches an instance of a policy with a known identity. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Filter *sms* +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled True +Tag:sms-disabled False +``` +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Filter +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### TeamsVirtualAppointmentsPolicy.Cmdlets.TeamsVirtualAppointmentsPolicy + +## NOTES + +## RELATED LINKS +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md new file mode 100644 index 0000000000..0a73f7a287 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy +title: Get-CsTeamsVoiceApplicationsPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsVoiceApplicationsPolicy + +## SYNOPSIS +Use the Get-CsTeamsVoiceApplicationsPolicy cmdlet to get Teams voice applications policy information. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsVoiceApplicationsPolicy [[-Identity] <String>] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsVoiceApplicationsPolicy [-Filter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION + +TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-CsTeamsVoiceApplicationsPolicy +``` +The command shown in Example 1 returns information for all the Teams voice applications policies configured for use in the tenant. + +### EXAMPLE 2 +``` +Get-CsTeamsVoiceApplicationsPolicy -Identity "SDA-Allow-All" +``` +In Example 2, information is returned for a single Teams voice applications policy; the policy with the Identity SDA-Allow-All. + +### EXAMPLE 3 +``` +Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" +``` +The command shown in Example 3 returns information about all the Teams voice applications policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". + +## PARAMETERS + +### -Identity +Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: + +-Identity global + +To return a policy configured at the per-user scope, use syntax like this: + +-Identity "SDA-Allow-All" + +You cannot use wildcard characters when specifying the Identity. + +If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsVoiceApplicationsPolicy returns all the Teams voice applications policies configured for use in the tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +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). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) + +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) + +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) + +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..894f122d6b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy +title: Get-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsWorkLoadPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsWorkLoadPolicy +``` + +Retrieves the Teams Workload Policy instances and shows assigned values. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..2dd5152b3d --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy +title: Get-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# Get-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to fetch policy instances of TeamsWorkLocationDetectionPolicy. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsWorkLocationDetectionPolicy [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTeamsWorkLocationDetectionPolicy [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Fetches instances of TeamsWorkLocationDetectionPolicy. Each policy object contains a property called `EnableWorkLocationDetection`. This setting allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsWorkLocationDetectionPolicy +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Global False +Tag:wld-policy1 True +Tag:wld-policy2 False +``` +Fetches all the policy instances currently available. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy1 +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy1 True +``` +Fetches an instance of a policy with a known identity. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsWorkLocationDetectionPolicy -Filter *wld* +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy1 True +Tag:wld-policy2 False +``` +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Filter +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### TeamsWorkLocationDetectionPolicy.Cmdlets.TeamsWorkLocationDetectionPolicy + +## NOTES + +## RELATED LINKS +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTenant.md b/teams/teams-ps/teams/Get-CsTenant.md new file mode 100644 index 0000000000..2558268bcf --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenant.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenant +applicable: Microsoft Teams +title: Get-CsTenant +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTenant + +## SYNOPSIS +Returns information about the Microsoft Teams or Skype for Business Online tenants that have been configured for use in your organization. +Tenants represent groups of online users. + +## SYNTAX + +``` +Get-CsTenant [-Filter <String>] [-DomainController <Fqdn>] [[-Identity] <OUIdParameter>] [-ResultSize <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +In Microsoft Teams or Skype for Business Online, tenants are groups of users who have accounts homed on the service. Organizations will typically have a single tenant in which to house all their user accounts. + +In the Teams PowerShell Module version 3.0.0 or later, the following attributes have been deprecated for organizations with Teams users: + +- AdminDescription +- AllowedDataLocation +- AssignedLicenses +- DefaultDataLocation +- DefaultPoolFqdn +- Description +- DisableExoPlanProvisioning +- DistinguishedName +- DomainUrlMap +- ExperiencePolicy +- Guid +- HostedVoiceMail +- HostedVoiceMailNotProvisioned +- Id +- Identity +- IsByPassValidation +- IsMNC +- IsO365MNC +- IsReadinessUploaded +- IsUpgradeReady +- IsValid +- LastSubProvisionTimeStamp +- MNCEnableTimeStamp +- Name +- NonPrimarySource +- ObjectCategory +- ObjectClass +- ObjectId +- ObjectState +- OcoDomainTracked +- OnPremisesImmutableId +- OnPremisesUserPrincipalName +- OnPremSamAccountName +- OnPremSecurityIdentifier +- OriginalRegistrarPool +- OriginatingServer +- PendingDeletion +- Phone +- ProvisioningCounter +- ProvisioningStamp +- ProvisionType +- PublicProvider +- PublishingCounter +- PublishingStamp +- RegistrarPool +- RemoteMachine +- SubProvisioningCounter +- SubProvisioningStamp +- SyncingCounter +- TeamsUpgradeEligible +- TelehealthEnabled +- TenantNotified +- TenantPoolExtension +- UpgradeRetryCounter +- UserRoutingGroupIds +- XForestMovePolicy + +In the Teams PowerShell Module version 3.0.0 or later, the following attributes have been renamed for TeamsOnly customers: + +- CountryAbbreviation is now CountryLetterCode +- CountryOrRegionDisplayName is now Country +- StateOrProvince is now State + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsTenant +``` + +The command shown in Example 1 returns information about your tenant. +Organizations will have only one tenant. + +## PARAMETERS + +### -DomainController +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. + +Enables you to return data by using Active Directory attributes and without having to specify the full Active Directory distinguished name. +For example, to retrieve a tenant by using the tenant display name, use syntax similar to this: + +Get-CsTenant -Filter {DisplayName -eq "FabrikamTenant"} + +To return all tenants that use a Fabrikam domain use this syntax: + +Get-CsTenant -Filter {Domains -like "*fabrikam*"} + +The Filter parameter uses the same Windows PowerShell filtering syntax is used by the `Where-Object` cmdlet. + +You cannot use both the Identity parameter and the Filter parameter in the same command. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. + +Unique identifier for the tenant. +For example: + +-Identity "bf19b7db-6960-41e5-a139-2aa373474354" + +If you do not include either the Identity or the Filter parameter then the `Get-CsTenant` cmdlet will return information about all your tenants. + +```yaml +Type: OUIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize + +**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. +For example, to return seven tenants (regardless of the number of tenants 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. + +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 tenants to 7 but you have only three contacts in your forest, the command will return those three tenants and then complete without error. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.ADConnect.Schema.TenantObject or String +The `Get-CsTenant` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.TenantObject object as well as string values representing the Identity of the tenant (for example "bf19b7db-6960-41e5-a139-2aa373474354"). + +## OUTPUTS + +### Microsoft.Rtc.Management.ADConnect.Schema.TenantObject + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md new file mode 100644 index 0000000000..8f125d7c02 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md @@ -0,0 +1,116 @@ +--- +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 +manager: roykuntz +--- + +# Get-CsTenantBlockedCallingNumbers + +## SYNOPSIS +Use the Get-CsTenantBlockedCallingNumbers cmdlet to retrieve tenant blocked calling numbers setting. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantBlockedCallingNumbers [[-Identity] <String>] + [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantBlockedCallingNumbers [-Filter <String>] + [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Microsoft Direct Routing, Operator Connect and Calling Plans supports blocking of inbound calls from the public switched telephone network (PSTN). This feature allows a tenant-global list of number patterns to be defined so that the caller ID of every incoming PSTN call to the tenant can be checked against the list for a match. If a match is made, an incoming call is rejected. + +The tenant blocked calling numbers includes a list of inbound blocked number patterns. Number patterns are managed through the CsInboundBlockedNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. + +You can also configure a list of number patterns to be exempt from call blocking. Exempt number patterns are managed through the CsInboundExemptNumberPattern commands New, Get, Set, and Remove. + +You can test your call blocking by using the command Test-CsInboundBlockedNumberPattern. + +The scope of tenant blocked calling numbers is global across the given tenant. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsTenantBlockedCallingNumbers +``` + +This example returns the tenant global settings for blocked calling numbers. It includes a list of inbound blocked number patterns and exempt number patterns. + +## 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. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +Internal Microsoft use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Get-CsTenantDialPlan.md b/teams/teams-ps/teams/Get-CsTenantDialPlan.md new file mode 100644 index 0000000000..6981f68fc3 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantDialPlan.md @@ -0,0 +1,107 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTenantDialPlan + +## SYNOPSIS +Use the Get-CsTenantDialPlan cmdlet to retrieve a tenant dial plan. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantDialPlan [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantDialPlan [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsTenantDialPlan cmdlet returns information about one or more tenant dial plans (also known as a location profiles) in an organization. +Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. +The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. +A tenant dial plan determines such things as which normalization rules are applied. + +You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information about the normalization rules of a tenant dial plan. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsTenantDialPlan +``` + +This example retrieves all existing tenant dial plans. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 +``` + +This example retrieves the tenant dial plan that has an identity of Vt1TenantDialplan2. + +## PARAMETERS + +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the name of the tenant dial plan to retrieve. + +```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 + +## OUTPUTS + +## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. + +## RELATED LINKS + +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/skype/skype-ps/skype/Get-CsTenantFederationConfiguration.md b/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md similarity index 76% rename from skype/skype-ps/skype/Get-CsTenantFederationConfiguration.md rename to teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md index 8c1277bfdc..8a7b9f790c 100644 --- a/skype/skype-ps/skype/Get-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration +applicable: Microsoft Teams title: Get-CsTenantFederationConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTenantFederationConfiguration @@ -37,7 +42,6 @@ The Get-CsTenantFederationConfiguration cmdlet provides a way for administrators This cmdlet can also be used to review the allowed and blocked lists, lists which are used to specify domains that users can and cannot communicate with. However, administrators must use the Get-CsTenantPublicProvider cmdlet in order to see which public IM and presence providers users are allowed to communicate with. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -49,14 +53,10 @@ The command shown in Exercise 1 returns federation configuration information for ### -------------------------- Example 2 -------------------------- ``` -Get-CsTenantFederationConfiguration | Select-Object -ExpandProperty AllowedList +Get-CsTenantFederationConfiguration | Select-Object -ExpandProperty AllowedDomains ``` -In Example 2, information is returned for all the domains found on the federation allowed list for the current tenant. -(The allowed list represents all the domains that the tenant is allowed to federate with.) To do this, the command first calls the Get-CsTenantFederationConfiguration cmdlet to return federation information for the specified tenant. -That information is then piped to the Select-Object cmdlet, which uses the ExpandProperty to "expand" the property AllowedList. -Expanding a property simply means displaying all the information stored in that property onscreen, and in an easy-to-read format. - +In Example 2, information is returned for all the allowed domains found on the federation configuration for the current tenant (This list represents all the domains that the tenant is allowed to federate with). To do this, the command first calls the Get-CsTenantFederationConfiguration cmdlet to return federation information for the specified tenant. That information is then piped to the Select-Object cmdlet, which uses the ExpandProperty to "expand" the property AllowedDomains. Expanding a property simply means displaying all the information stored in that property onscreen, and in an easy-to-read format. ## PARAMETERS @@ -70,8 +70,8 @@ However, this is valid syntax for the Get-CsTenantFederationConfiguration cmdlet ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -91,8 +91,8 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -107,8 +107,8 @@ This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -134,24 +134,8 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -161,24 +145,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings - ## NOTES - ## RELATED LINKS -[Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) - -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) - +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md b/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md new file mode 100644 index 0000000000..5eab013035 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantlicensingconfiguration +applicable: Microsoft Teams +title: Get-CsTenantLicensingConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTenantLicensingConfiguration + +## SYNOPSIS +Indicates whether licensing information for the specified tenant is available in the Teams admin center. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantLicensingConfiguration [[-Identity] <String>] [-MsftInternalProcessingMode <String>] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantLicensingConfiguration [-MsftInternalProcessingMode <String>] [-Filter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-CsTenantLicensingConfiguration cmdlet indicates whether licensing information for the specified tenant is available in the Teams admin center. +The cmdlet returns information similar to this: + +Identity : GlobalStatus : Enabled + +If the Status is equal to Enabled then licensing information is available in the admin center. +If not, then licensing information is not available in the admin center. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsTenantLicensingConfiguration +``` + +The command shown in Example 1 returns licensing configuration information for the current tenant: + +## PARAMETERS + +### -Filter +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. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Deserialized.Microsoft.Rtc.Management.WritableConfig.Settings.TenantConfiguration.TenantLicensingConfiguration + +## NOTES + +## RELATED LINKS + +[Get-CsTenant](https://learn.microsoft.com/powershell/module/teams/get-cstenant) diff --git a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md b/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md new file mode 100644 index 0000000000..23ce62dd9e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md @@ -0,0 +1,115 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTenantMigrationConfiguration + +## SYNOPSIS +Use the Get-CsTenantMigrationConfiguration cmdlet to check if Meeting Migration Service (MMS) is enabled in your organization. + +## SYNTAX + +``` +Get-CsTenantMigrationConfiguration [-LocalStore] [[-Identity] <XdsIdentity>] [-Tenant <Guid>] [-Filter <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. This tool does not migrate Skype for Business meetings into Microsoft Teams meetings. + +The Get-CsTenantMigrationConfiguration cmdlet retrieves the Meeting Migration Service configuration in your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Get-CsTenantMigrationConfiguration +``` + +This example shows the MMS configuration in your organization. + +## PARAMETERS + +### -Filter +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md b/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md new file mode 100644 index 0000000000..110a8e54cc --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkconfiguration +applicable: Microsoft Teams +title: Get-CsTenantNetworkConfiguration +schema: 2.0.0 +ms.reviewer: +--- + +# Get-CsTenantNetworkConfiguration + +## SYNOPSIS +Returns information about the network regions, sites and subnets in the tenant network configuration. Tenant network configuration is used for Location Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantNetworkConfiguration [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantNetworkConfiguration [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +Tenant Network Configuration contains the list of network sites, subnets and regions configured. + +A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. Network sites are defined as a collection of IP subnets. + +A best practice for Location Based Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. Each network site must be associated with a network region. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration. + +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. + +Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. + +A network region interconnects various parts of a network across multiple geographic areas. + +A network region contains a collection of network sites. For example, if your organization has many sites located in India, then you may choose to designate "India" as a network region. + +Location-Based Routing is a feature that allows PSTN toll bypass to be restricted for users based on policy and the user's geographic location at the time of an incoming or outgoing PSTN call. + +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in Microsoft 365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTenantNetworkConfiguration +``` +The command shown in Example 1 returns the list of network configuration for the current tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTenantNetworkConfiguration -Identity Global +``` +The command shown in Example 2 returns the network configuration within the scope of Global. + +### Example 3 +```powershell +PS C:\> Get-CsTenantNetworkConfiguration -Filter "global" +``` +The command shown in Example 3 returns the network site that matches the specified filter. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the network configuration (or network configurations) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier for the network configuration. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Identity +The Identity of the network configuration. + +### NetworkRegions +The list of network regions of the network configuration. + +### NetworkSites +The list of network sites of the network configuration. + +### Subnets +The list of network subnets of the network configuration. + +### PostalCodes +This parameter is reserved for internal Microsoft use. + +## NOTES + +## RELATED LINKS +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) + diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md new file mode 100644 index 0000000000..4e5bac9aa2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md @@ -0,0 +1,105 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTenantNetworkRegion + +## SYNOPSIS +Returns information about the network region setting in the tenant. Tenant network region is used for Location Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantNetworkRegion [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantNetworkRegion [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +A network region interconnects various parts of a network across multiple geographic areas. + +A network region contains a collection of network sites. For example, if your organization has many sites located in India, then you may choose to designate "India" as a network region. + +Location-Based Routing is a feature that allows PSTN toll bypass to be restricted for users based on policy and the user's geographic location at the time of an incoming or outgoing PSTN call. + +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in Microsoft 365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTenantNetworkRegion +``` + +The command shown in Example 1 returns the list of network regions for the current tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTenantNetworkRegion -Identity RedmondRegion +``` + +The command shown in Example 2 returns the network region within the scope of RedmondRegion. + +## PARAMETERS + +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network region to be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters ](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) + +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) + +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md b/teams/teams-ps/teams/Get-CsTenantNetworkSite.md new file mode 100644 index 0000000000..140fb2c326 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantNetworkSite.md @@ -0,0 +1,172 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTenantNetworkSite + +## SYNOPSIS +Returns information about the network site setting in the tenant. Tenant network site is used for Location Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantNetworkSite [[-Identity] <string>] [-IncludePhoneNumbers <bool>] [<CommonParameters>] +``` + +### QueryParameter +``` +Get-CsTenantNetworkSite [-IncludePhoneNumbers <bool>] [-Filter <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantNetworkSite [-IncludePhoneNumbers <bool>] [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. Network sites are defined as a collection of IP subnets. + +A best practice for Location Bsed Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. Each network site must be associated with a network region. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration. + +Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. + +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTenantNetworkSite +``` +The command shown in Example 1 returns the list of network sites for the current tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTenantNetworkSite -Identity siteA +``` +The command shown in Example 2 returns the network site within the scope of siteA. + +### Example 3 +```powershell +PS C:\> Get-CsTenantNetworkSite -Filter "Los Angeles" +``` +The command shown in Example 3 returns the network site that matches the specified filter. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the site (or sites) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier for the site. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePhoneNumbers +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: All +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Identity +The Identity of the site. + +### Description +The description of the site. + +### NetworkRegionID +The network region ID of the site. + +### LocationPolicyID +The ID of the location policy assigned to the site. + +### SiteAddress +This parameter is reserved for internal Microsoft use. + +### NetworkSiteID +The ID of the network site. + +### OnlineVoiceRoutingPolicyTagID +The ID of the online voice routing policy assigned to the site. + +### EnableLocationBasedRouting +Boolean stating whether Location-Based Routing is enabled on the site. + +### EmergencyCallRoutingPolicyTagID +The ID of the Teams emergency call routing policy assigned to the site. + +### EmergencyCallingPolicyTagID +The ID of the Teams emergency calling policy assigned to the site. + +### NetworkRoamingPolicyTagID +The ID of the Teams network roaming policy assigned to the site. + +### EmergencyCallRoutingPolicyName +The name of the Teams emergency call routing policy assigned to the site. + +### EmergencyCallingPolicyName +The name of the Teams emergency calling policy assigned to the site. + +### NetworkRoamingPolicyName +The name of the Teams network roaming policy assigned to the site. + +### PhoneNumbers +This parameter is reserved for internal Microsoft use. + +## NOTES +The parameter IncludePhoneNumbers was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) + +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) + +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md new file mode 100644 index 0000000000..451655976b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md @@ -0,0 +1,104 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTenantNetworkSubnet + +## SYNOPSIS +Returns information about the network subnet setting in the tenant. Tenant network subnet is used for Location Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantNetworkSubnet [[-Identity] <string>] [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantNetworkSubnet [-Filter <string>] [<CommonParameters>] +``` + +## DESCRIPTION +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. + +Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. + +Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. + +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTenantNetworkSubnet +``` + +The command shown in Example 1 returns the list of network subnets for the current tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTenantNetworkSubnet -Identity '2001:4898:e8:25:844e:926f:85ad:dd70' +``` + +The command shown in Example 2 returns the IPv6 format network subnet within the scope of '2001:4898:e8:25:844e:926f:85ad:dd70'. + +## PARAMETERS + +### -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: Identity +Aliases: + +Required: False +Position: 1 +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. + +```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 + +## NOTES + +## RELATED LINKS + +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) + +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) + +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md new file mode 100644 index 0000000000..178e4bd1fa --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md @@ -0,0 +1,131 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsTenantTrustedIPAddress + +## SYNOPSIS +Returns information about the external trusted IPs in the tenant. Trusted IP address from user's endpoint will be checked to determine which internal subnet the user's endpoint is located. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantTrustedIPAddress [-Tenant <System.Guid>] [[-Identity] <XdsGlobalRelativeIdentity>] [-LocalStore] + [<CommonParameters>] +``` + +### Filter +``` +Get-CsTenantTrustedIPAddress [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] +``` + +## 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. Trusted IP addresses in both IPv4 and IPv6 formats are accepted. + +If the user's external IP matches one defined in the trusted list, then Location-Based Routing will check to determine which internal subnet the user's endpoint is located. If the user's external IP doesn't match one defined in the trusted list, the endpoint will be classified as being at an unknown and any PSTN calls to/from an LBR enabled user are blocked. + +Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. + +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. + +## EXAMPLES + +###-------------------------- Example 1 -------------------------- +```powershell +PS C:\> Get-CsTenantTrustedIPAddress +``` + +The command shown in Example 1 returns the list of trusted IP addresses for the current tenant. + +###-------------------------- Example 2 -------------------------- +```powershell +PS C:\> Get-CsTenantTrustedIPAddress -Identity '2001:4898:e8:25:8440::' +``` + +The command shown in Example 2 returns the IPv6 format trusted IP address detail of '2001:4898:e8:25:8440::'. + +## PARAMETERS + +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the scope. It specifies the collection of trusted IP address to be returned. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose trusted IP addresses are being returned. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsUserCallingSettings.md b/teams/teams-ps/teams/Get-CsUserCallingSettings.md new file mode 100644 index 0000000000..43b422011c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsUserCallingSettings.md @@ -0,0 +1,249 @@ +--- +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 <String> [<CommonParameters>] + +``` + +## 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) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md new file mode 100644 index 0000000000..692be05e33 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment +title: Get-CsUserPolicyAssignment +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsUserPolicyAssignment + +## SYNOPSIS + +This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. + +## SYNTAX + +### Get (Default) +``` +Get-CsUserPolicyAssignment -Identity <String> [-PolicyType <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-CsUserPolicyAssignment -InputObject <IIc3AdminConfigRpPolicyIdentity> [-PolicyType <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlets returns the effective policies for a user, based on either direct policy assignment or inheritance from a group policy assignment. For a given policy type, if an effective policy is not returned, this indicates that the effective policy for the user is either the tenant global default policy (if set) or the system global default policy. + +This cmdlet does not currently support returning policies for multiple users. + +## EXAMPLES + +### Example 1 +This examples returns the policies that are either directly assigned to a user or that the user inherited from a group. + +``` +Get-CsUserPolicyAssignment -Identity f0d9c148-27c1-46f5-9685-544d20170ea1 + +PolicyType PolicyName PolicySource +---------- ---------- ------------ +TeamsMeetingPolicy Kiosk {Kiosk, Kiosk} +MeetingPolicy BposSAllModality {BposSAllModality} +ExternalAccessPolicy FederationAndPICDefault {FederationAndPICDefault} +TeamsMeetingBroadcastPolicy Vendor Live Events {Vendor Live Events, Employees Events} +TeamsCallingPolicy AllowCalling {AllowCalling} +``` + +### Example 2 +The PolicySource property can be expanded to show more details for a particular policy type. The PolicySource property indicates whether a particular policy was directly assigned to the user or inherited from a group. + +In this example, the details for the TeamsBroadcastMeetingPolicy are shown. The user was directly assigned the "Employees Events" policy, which took precedence over the "Vendor Live Events" policy which is assigned to a group (566b8d39-5c5c-4aaa-bc07-4f36278a1b38) that the user belongs to. + +``` +Get-CsUserPolicyAssignment -Identity 3b90faad-9056-49ff-8357-0b53b1d45d39 -PolicyType TeamsMeetingBroadcastPolicy | select -ExpandProperty PolicySource + +AssignmentType PolicyName Reference +-------------- ---------- --------- +Direct Employees Events +Group Vendor Live Events 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 +``` + +### Example 3 +In this example, the details for the TeamsMeetingPolicy are shown. The user is a member of two groups, each of which is assigned a TeamsMeetingPolicy. The user has inherited the "AllOn" policy because the priority of the assignment is higher than that of the "Kiosk" policy assignment to the other group. + +``` +Get-CsUserPolicyAssignment -Identity 3b90faad-9056-49ff-8357-0b53b1d45d39 -PolicyType TeamsMeetingPolicy | select -ExpandProperty PolicySource + +AssignmentType PolicyName Reference +-------------- ---------- --------- +Group AllOn d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 +Group Kiosk 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +## 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) + +```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: IIc3AdminConfigRpPolicyIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyType +Use to filter to a specific policy type. + +```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 + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Config.Cmdlets.Models.IIc3AdminConfigRpPolicyIdentity +## OUTPUTS + +### Microsoft.Teams.Config.Cmdlets.Models.IEffectivePolicy +## 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 \<IIc3AdminConfigRpPolicyIdentity\>: Identity Parameter + \[GroupId \<String\>\]: The ID of a group whose policy assignments will be returned. + \[Identity \<String\>\]: + \[OperationId \<String\>\]: The ID of a batch policy assignment operation. + \[PolicyType \<String\>\]: The policy type for which group policy assignments will be returned. + +## RELATED LINKS + +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) + +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) + +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md b/teams/teams-ps/teams/Get-CsUserPolicyPackage.md new file mode 100644 index 0000000000..c0edaf3689 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsUserPolicyPackage.md @@ -0,0 +1,71 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsUserPolicyPackage +author: serdarsoysal +ms.author: serdars +manager: amitar +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage +schema: 2.0.0 +--- + +# Get-CsUserPolicyPackage + +## SYNOPSIS + +This cmdlet supports retrieving the policy package that's assigned to a user. + +## SYNTAX + +``` +Get-CsUserPolicyPackage [-Identity] <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet supports retrieving the policy package that's assigned to a user. Provide the identity of a user to retrieve the definition of their assigned policy package. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsUserPolicyPackage -Identity johndoe@example.com +``` + +Returns the policy package that's assigned to johndoe@example.com. + +## PARAMETERS + +### -Identity + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) + +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md b/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md new file mode 100644 index 0000000000..ca19b2c0d9 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md @@ -0,0 +1,71 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsUserPolicyPackageRecommendation +author: serdarsoysal +ms.author: serdars +manager: amitar +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation +schema: 2.0.0 +--- + +# Get-CsUserPolicyPackageRecommendation + +## SYNOPSIS + +This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. + +## SYNTAX + +``` +Get-CsUserPolicyPackageRecommendation [-Identity] <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. This recommendation is based on tenant and user information such as license types. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsUserPolicyPackageRecommendation -Identity johndoe@example.com +``` + +Returns recommendations for which policy packages are best suited for johndoe@example.com. The recommendation value per package can either be none, weak, or strong based on how confident the existing signals (e.g. license type) imply a user role. + +## PARAMETERS + +### -Identity + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) + +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md similarity index 87% rename from skype/skype-ps/skype/Get-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md index 92470d401e..2210e9d40f 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md @@ -1,9 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Get-CsVideoInteropServiceProvider schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsVideoInteropServiceProvider @@ -11,7 +16,6 @@ schema: 2.0.0 ## SYNOPSIS Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. - ## SYNTAX ### Identity (Default) @@ -100,14 +104,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md new file mode 100644 index 0000000000..445cec3c6a --- /dev/null +++ b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md @@ -0,0 +1,53 @@ +--- +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] <Number> [<CommonParameters>] +``` + +## 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-M365TeamsApp.md b/teams/teams-ps/teams/Get-M365TeamsApp.md new file mode 100644 index 0000000000..2d665c2c79 --- /dev/null +++ b/teams/teams-ps/teams/Get-M365TeamsApp.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365TeamsApp +applicable: Microsoft Teams +title: Get-M365TeamsApp +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +schema: 2.0.0 +--- + +# Get-M365TeamsApp + +## SYNOPSIS + +This cmdlet returns app availability and state for the Microsoft Teams app. + +## SYNTAX + +```powershell +Get-M365TeamsApp -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION + +Get-M365TeamsApps retrieves information about the Teams app. This includes app state, app availability, user who updated app availability, and the associated timestamp. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-M365TeamsApp -Id b782e2e8-9682-4898-b211-a304714f4f6b +``` + +Provides information about b782e2e8-9682-4898-b211-a304714f4f6b app, which includes app state, app availability, user who updated app availability, and the associated timestamp. + +## PARAMETERS + +### -Id + +Application ID of the Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +**ID** +Application ID of the Teams app. + +**IsBlocked** +The state of the app in the tenant. +Values: + +- Blocked +- Unblocked + +**AvailableTo** +Provides available to properties for the app. +Properties: + +- AssignmentType: App availability type. + Values: + - Everyone + - UsersandGroups + - Noone +- Users: List of all the users for whom the app is enabled. + Values: + - Id: GUID of UserIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. +- Groups: List of all the groups for whom the app is enabled. + Values: + - Id: GUID of GroupIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. + +**InstalledFor** +Provides installed for properties for the app. +Properties: + +- AppInstallType: App install type. + Values: + - Everyone + - UsersandGroups + - Noone +- LastUpdatedTimestamp: Last Updated date +- InstalledBy: The user performing the installation +- InstalledSource: Source of installation +- Version: Version of the app installed +- InstallForUsers: List of all the users for whom the app is enabled. + Values: + - Id: GUID of UserIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. +- InstallForGroups: List of all the groups for whom the app is enabled. + Values: + - Id: GUID of GroupIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. + +## NOTES + +## RELATED LINKS + +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md b/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md new file mode 100644 index 0000000000..0e4deaa2f7 --- /dev/null +++ b/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedCustomPendingApps +applicable: Microsoft Teams +title: Get-M365UnifiedCustomPendingApps +author: michelle-paradis +ms.author: mparadis +manager: swmerchant +ms.date: 01/14/2025 +schema: 2.0.0 +--- + +# Get-M365UnifiedCustomPendingApps + +## SYNOPSIS + +This cmdlet returns all custom Microsoft Teams apps that are pending review from an IT Admin. + +## SYNTAX + +```powershell +Get-M365UnifiedCustomPendingApps [<CommonParameters>] +``` + +## DESCRIPTION + +Get-M365UnifiedCustomPendingApps retrieves a complete list of all custom Microsoft Teams apps that are pending review, and their review statuses. + +## EXAMPLES + +### Example + +```powershell +PS C:\> Get-M365UnifiedCustomPendingApps +``` + +Returns a complete list of all custom Microsoft Teams apps that are pending review, and their review statuses. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +**Id**: +Application ID of the Teams app. + +**ExternalId**: +External ID of the Teams app. + +**Iteration**: +The Staged App Definition Etag of the app. This is a unique tag created everytime the staged app is updated, to help track changes. + +**CreatedBy**: +The User ID of the user that created the app. + +**LastUpdateDateTime**: +The date and time the app was last updated. + +**ReviewStatus**: +The review status of the app. +Values: + +- PendingPublishing: A new custom app was requested that hasn't been published before. +- PendingUpdate: An existing custom app that was previously published and now has an update. + +**Metadata**: +The metadata of the app. diff --git a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md b/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md new file mode 100644 index 0000000000..c67594e6ff --- /dev/null +++ b/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedTenantSettings +applicable: Microsoft Teams +title: Get-M365UnifiedTenantSettings +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 10/22/2024 +schema: 2.0.0 +--- + +# Get-M365UnifiedTenantSettings + +## SYNOPSIS + +This cmdlet returns the current tenant settings for a particular tenant + +## SYNTAX + +```powershell +Get-M365UnifiedTenantSettings -SettingNames <String[]> [<CommonParameters>] +``` + +## DESCRIPTION + +Get-M365UnifiedTenantSettings retrieves the current tenant settings for a particular tenant. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-M365UnifiedTenantSettings +``` + +Returns all the current tenant settings for this tenant. + +### Example 2 + +```powershell +PS C:\> Get-M365UnifiedTenantSettings -SettingNames DefaultApp +``` + +Returns the current tenant setting for DefaultApp for this tenant. + +### Example 3 + +```powershell +PS C:\> Get-M365UnifiedTenantSettings -SettingNames DefaultApp,EnableCopilotExtensibility +``` + +Returns the current tenant setting for DefaultApp and EnableCopilotExtensibility for this tenant. + +## PARAMETERS + +### -SettingNames + +Setting names requested. Possible values - DefaultApp,GlobalApp,PrivateApp,EnableCopilotExtensibility + +```yaml +Type: String +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +**SettingName** +Setting Name returned. + +**SettingValue** +The status of this setting in the tenant. +Values: + +- All +- None +- Some (only applicable for EnableCopilotExtensibility) + +**Users** +The list of users this setting is applicable to (only applicable for EnableCopilotExtensibility). + +**Groups** +The list of groups this setting is applicable to (only applicable for EnableCopilotExtensibility). + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-SharedWithTeam.md b/teams/teams-ps/teams/Get-SharedWithTeam.md new file mode 100644 index 0000000000..4728ffa1b4 --- /dev/null +++ b/teams/teams-ps/teams/Get-SharedWithTeam.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam +title: Get-SharedWithTeam +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-SharedWithTeam + +## SYNOPSIS +This cmdlet supports retrieving teams with which a specified channel is shared. + +## SYNTAX +```PowerShell +Get-SharedWithTeam -HostTeamId <String> -ChannelId <String> [-SharedWithTeamId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports retrieving teams with which a specified channel is shared. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +``` + +Returns teams with which a specified channel is shared. + +### Example 2 +```PowerShell +Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b +``` + +Returns detail of a team with which a specified channel is shared. + +## PARAMETERS + +### -HostTeamId +Team ID of the host team (Group ID). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChannelId +Thread ID of the shared channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedWithTeamId +Team ID of the shared with team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### HostTeamId, ChannelId, SharedWithTeamId + +## OUTPUTS + +### Team + +## NOTES + +## RELATED LINKS +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-AssociatedTeam](https://learn.microsoft.com/powershell/module/teams/get-team) diff --git a/teams/teams-ps/teams/Get-SharedWithTeamUser.md b/teams/teams-ps/teams/Get-SharedWithTeamUser.md new file mode 100644 index 0000000000..4a3f016867 --- /dev/null +++ b/teams/teams-ps/teams/Get-SharedWithTeamUser.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser +title: Get-SharedWithTeamUser +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-SharedWithTeamUser + +## SYNOPSIS +This cmdlet supports retrieving users of a shared with team. + +## SYNTAX +```PowerShell +Get-SharedWithTeamUser -HostTeamId <String> -ChannelId <String> -SharedWithTeamId <String> [-Role <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports retrieving users of a shared with team. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-SharedWithTeamUser -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b +``` + +Returns users of a team with which a specified channel is shared. + +### Example 2 +```PowerShell +Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b -Role owner +``` + +Returns owners of a team with which a specified channel is shared. + +## PARAMETERS + +### -HostTeamId +Team ID of the host team (Group ID). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChannelId +Thread ID of the shared channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedWithTeamId +Team ID of the shared with team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Role +Filters the results to only users with the given role of "Owner" or "Member". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### HostTeamId, ChannelId, SharedWithTeamId + +## OUTPUTS + +### User + +## NOTES + +## RELATED LINKS +[Get-TeamUser](https://learn.microsoft.com/powershell/module/teams/get-teamuser) diff --git a/teams/teams-ps/teams/Get-Team.md b/teams/teams-ps/teams/Get-Team.md index df9a7723ae..b2edb13e51 100644 --- a/teams/teams-ps/teams/Get-Team.md +++ b/teams/teams-ps/teams/Get-Team.md @@ -1,36 +1,74 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/get-team title: Get-Team -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-Team ## SYNOPSIS -Note: This cmdlet is currently in Beta. -Gets all the teams that the user belongs to. +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. ## SYNTAX +### Identity ``` -Get-Team [-User <String>] +Get-Team -GroupId <String> [-User <String>] [-Archived <Boolean>] [-Visibility <String>] + [-DisplayName <String>] [-MailNickName <String>] [<CommonParameters>] [-NumberOfThreads <Int32>] +``` + +### Filters +``` +Get-Team [-User <String>] [-Archived <Boolean>] [-Visibility <String>] [-DisplayName <String>] + [-MailNickName <String>] [<CommonParameters>] [-NumberOfThreads <Int32>] ``` ## DESCRIPTION -Gets all the teams the user is part of. -The user must be you - you can only get information on yourself. +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. + +> [!NOTE] +> Get-Team may return multiple results matching the input and not just the exact match for attributes like DisplayName/MailNickName. This is known behavior. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS> Get-Team -User dmx1@example.com ``` +Returns all teams that a user (dmx1@example.com) belongs to + +### Example 2 +``` +PS> Get-Team -Archived $true -Visibility Private +``` +Returns all teams that are private and have been archived. + +### Example 3 +``` +PS> Get-Team -MailNickName "BusinessDevelopment" +``` +Returns the team with the specified MailNickName. (This acts as a filter rather than an exact match.) + +### Example 4 +``` +PS> Get-Team -DisplayName "Sales and Marketing" +``` +Returns the team that includes the specified text in its DisplayName. (This acts as a filter rather than an exact match). + +### Example 5 +``` +PS> $team=[uri]::EscapeDataString('AB&C') +PS> Get-Team -DisplayName $team +``` +Returns the team that includes the specified escaped representation of its DisplayName, useful when the DisplayName has special characters. (This acts as a filter rather than an exact match.) + ## PARAMETERS ### -User @@ -39,17 +77,169 @@ johndoe@example.com) ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams 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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specify this parameter to return teams with the provided display name as a filter. As the display name is not unique, multiple values can be returned. Note that this filter value is case-sensitive. + +```yaml +Type: String +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 +``` + +### -GroupId +Specify the specific GroupId (as a string) of the team to be returned. This is a unique identifier and returns exact match. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailNickName +Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. + +```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 +``` + +### -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: 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 +``` + +### -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 @@ -62,6 +252,6 @@ Accept wildcard characters: False ## RELATED LINKS -[New-Team](New-Team.md) +[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) -[Set-Team](Set-Team.md) \ No newline at end of file +[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) diff --git a/teams/teams-ps/teams/Get-TeamAllChannel.md b/teams/teams-ps/teams/Get-TeamAllChannel.md new file mode 100644 index 0000000000..eae8aeb08e --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamAllChannel.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamallchannel +title: Get-TeamAllChannel +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-TeamAllChannel + +## SYNOPSIS +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +## SYNTAX +```PowerShell +Get-TeamAllChannel -GroupId <String> [-MembershipType <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 +``` + +Returns all channels of a team. + +### Example 2 +```PowerShell +Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -MembershipType Shared +``` + +Returns all shared channels of a team. + +## PARAMETERS + +### -GroupId +Returns the Group ID of the team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MembershipType +Membership type of the channel to display; Standard, Private, or Shared + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### GroupId, MembershipType + +## OUTPUTS + +### Channel + +## NOTES + +## RELATED LINKS +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamIncomingChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamChannel.md b/teams/teams-ps/teams/Get-TeamChannel.md index 2e0ba86be5..9eae890d9e 100644 --- a/teams/teams-ps/teams/Get-TeamChannel.md +++ b/teams/teams-ps/teams/Get-TeamChannel.md @@ -1,34 +1,40 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamchannel title: Get-TeamChannel -online version: schema: 2.0.0 --- # Get-TeamChannel ## SYNOPSIS -Note: This cmdlet is currently in Beta. - -Get all the channels for a team. +This cmdlet supports retrieving channels hosted by a team. ## SYNTAX - ``` -Get-TeamChannel -GroupId <String> +Get-TeamChannel -GroupId <String> [-MembershipType <String>] [<CommonParameters>] ``` ## DESCRIPTION +This cmdlet supports retrieving channels hosted by a team. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-TeamChannel -GroupId af55e84c-dc67-4e48-9005-86e0b07272f9 ``` +Get channels of the group. + +### Example 2 +``` +Get-TeamChannel -GroupId af55e84c-dc67-4e48-9005-86e0b07272f9 -MembershipType Private +``` + +Get all private channels of the group. + ## PARAMETERS ### -GroupId @@ -38,7 +44,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -47,6 +52,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -MembershipType +Membership type of the channel to display, Standard or Private (available in private preview) + +```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 @@ -54,4 +77,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamChannelUser.md b/teams/teams-ps/teams/Get-TeamChannelUser.md new file mode 100644 index 0000000000..a245c41c40 --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamChannelUser.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser +title: Get-TeamChannelUser +schema: 2.0.0 +--- + +# Get-TeamChannelUser + +## SYNOPSIS +Returns users of a channel. + +## SYNTAX + +``` +Get-TeamChannelUser -GroupId <String> -DisplayName <String> [-Role <String>] [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +``` +Get-TeamChannelUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Engineering" -Role Owner +``` + +Get owners of channel with display name as "Engineering" + +## PARAMETERS + +### -GroupId +GroupId of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Display name of the channel + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Role +Filter the results to only users with the given role: Owner or Member. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamFunSettings.md b/teams/teams-ps/teams/Get-TeamFunSettings.md index ee61b0796f..00fb19db53 100644 --- a/teams/teams-ps/teams/Get-TeamFunSettings.md +++ b/teams/teams-ps/teams/Get-TeamFunSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-TeamFunSettings -online version: +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 currently in Beta. +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. @@ -54,4 +57,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamGuestSettings.md b/teams/teams-ps/teams/Get-TeamGuestSettings.md index 3e51336fbd..91b260b35c 100644 --- a/teams/teams-ps/teams/Get-TeamGuestSettings.md +++ b/teams/teams-ps/teams/Get-TeamGuestSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-TeamGuestSettings -online version: +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 currently in Beta. +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. @@ -54,4 +57,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamHelp.md b/teams/teams-ps/teams/Get-TeamHelp.md deleted file mode 100644 index 72a8d84d6a..0000000000 --- a/teams/teams-ps/teams/Get-TeamHelp.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamHelp -online version: -schema: 2.0.0 ---- - -# Get-TeamHelp - -## SYNOPSIS -Note: This cmdlet is currently in Beta. - -Gets a list of commands for Microsoft Teams. - -## SYNTAX - -``` -Get-TeamHelp -``` - -## DESCRIPTION - -## EXAMPLES - - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamIncomingChannel.md b/teams/teams-ps/teams/Get-TeamIncomingChannel.md new file mode 100644 index 0000000000..b1ad0429ef --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamIncomingChannel.md @@ -0,0 +1,66 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel +title: Get-TeamIncomingChannel +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-TeamIncomingChannel + +## SYNOPSIS +This cmdlet supports retrieving incoming channels of a team. + +## SYNTAX +```PowerShell +Get-TeamIncomingChannel -GroupId <String> [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports retrieving incoming channels of a team. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-TeamIncomingChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 +``` + +Returns incoming channels of a team. + +## PARAMETERS + +### -GroupId +Group ID of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### GroupId + +## OUTPUTS + +### Channel + +## NOTES + +## RELATED LINKS +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamAllChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamMemberSettings.md b/teams/teams-ps/teams/Get-TeamMemberSettings.md index 6e0e2bf15b..f2b4df4491 100644 --- a/teams/teams-ps/teams/Get-TeamMemberSettings.md +++ b/teams/teams-ps/teams/Get-TeamMemberSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-TeamMemberSettings -online version: +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 currently in Beta. +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. @@ -54,4 +57,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamMessagingSettings.md b/teams/teams-ps/teams/Get-TeamMessagingSettings.md index 521f42c76c..75cbd47356 100644 --- a/teams/teams-ps/teams/Get-TeamMessagingSettings.md +++ b/teams/teams-ps/teams/Get-TeamMessagingSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-TeamMessagingSettings -online version: +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 currently in Beta. +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. @@ -54,4 +57,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md b/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md new file mode 100644 index 0000000000..2480953c1b --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus +title: Get-TeamTargetingHierarchyStatus +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- +# Get-TeamTargetingHierarchyStatus + +## SYNOPSIS + +Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) + +## SYNTAX + +### Get (Default) +``` +Get-TeamTargetingHierarchyStatus [-RequestId <String>] [-ApiVersion <String>] [<CommonParameters>] +``` + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv + +Key Value +--- ----- +requestId c67e86109d88479e9708c3b7e8ff7217 + +PS C:\> Get-TeamTargetingHierarchyStatus -RequestId c67e86109d88479e9708c3b7e8ff7217 + +# When an error occurs, you will see the details in the ErrorMessage field. + +Id : c67e86109d88479e9708c3b7e8ff7217 +Status : Failed +LastKnownStatus : Validating +ErrorMessage : 1 error(s) were found. + Error: InvalidTeamId + Descriptions: + TeamID in row 2 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 3 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 4 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 5 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 6 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 7 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + +LastUpdatedAt : 2021-02-17T22:28:08.7832795+00:00 +LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 +FileName : hier1.csv + +# When the hierarchy uploads and parses successfully, you will see this status. + +Id : c67e86109d88479e9708c3b7e8ff7217 +Status : Successful +LastKnownStatus : +ErrorMessage : +LastUpdatedAt : 2021-02-17T22:48:41.6664097+00:00 +LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 +FileName : hier.csv +``` + +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: false +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Get-TeamUser.md b/teams/teams-ps/teams/Get-TeamUser.md index 323e9553e7..a7b4fd3d69 100644 --- a/teams/teams-ps/teams/Get-TeamUser.md +++ b/teams/teams-ps/teams/Get-TeamUser.md @@ -1,33 +1,35 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamuser title: Get-TeamUser -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Get-TeamUser ## SYNOPSIS -Note: This cmdlet is currently in Beta. - Returns users of a team. ## SYNTAX ``` -Get-TeamUser -GroupId <String> [-Role <String>] +Get-TeamUser -GroupId <String> [-Role <String>] [<CommonParameters>] ``` ## DESCRIPTION +Returns an array containing the UPN, UserId, Name and Role of users belonging to an specific GroupId. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-TeamUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -Role Owner ``` +This example returns the UPN, UserId, Name, and Role of the owners of the specified GroupId. ## PARAMETERS @@ -38,7 +40,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -48,13 +49,12 @@ Accept wildcard characters: False ``` ### -Role -Filter the results to only users with the given role: Owner, Member, or Guest. +Filter the results to only users with the given role: Owner or Member. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -63,6 +63,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -70,4 +73,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamsApp.md b/teams/teams-ps/teams/Get-TeamsApp.md new file mode 100644 index 0000000000..e393faf0f5 --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamsApp.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +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 +schema: 2.0.0 +--- + +# Get-TeamsApp + +## SYNOPSIS +Returns app information from the Teams tenant app store. + +## SYNTAX + +``` +Get-TeamsApp [-Id <String>] [-ExternalId <String>] [-DisplayName <String>] [-DistributionMethod <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Use any optional parameter to retrieve app information from the Teams tenant app store. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 +``` + +### Example 2 +```powershell +PS C:\> Get-TeamsApp -ExternalId b00080be-9b31-4927-9e3e-fa8024a7d98a -DisplayName <String>] [-DistributionMethod <String>] +``` + +### Example 3 +```powershell +PS C:\> Get-TeamsApp -DisplayName SampleApp -DistributionMethod organization +``` + +## PARAMETERS + +### -DisplayName +Name of the app visible to users + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionMethod +The type of app in Teams: global or organization. For LOB apps, use "organization" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalId +The external ID of the app, provided by the app developer and used by 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 +``` + +### -Id +The app's ID generated by Teams (different from the external 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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamsAppInstallation.md b/teams/teams-ps/teams/Get-TeamsAppInstallation.md new file mode 100644 index 0000000000..39ef59a41c --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamsAppInstallation.md @@ -0,0 +1,118 @@ +--- +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 <String> [-AppInstallationId <String>] [-AppId <String>] [<CommonParameters>] +``` + +### UserScope +``` +Get-TeamsAppInstallation -UserId <String> [-AppInstallationId <String>] [-AppId <String>] [<CommonParameters>] +``` + +## 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-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..b321e2118c --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md @@ -0,0 +1,234 @@ +--- +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 +ms.author: frpeng +ms.reviewer: +--- + +# Grant-CsApplicationAccessPolicy + +## SYNOPSIS + +Assigns a per-user application access policy to one or more users. After assigning an application access policy to a user, the applications configured in the policy will be authorized to access online meetings on behalf of that user. + +## SYNTAX + +### Identity + +``` +Grant-CsApplicationAccessPolicy [-Identity <UserIdParameter>] [-PolicyName <String>] [-Global] +``` + +### GrantToTenant (Default) +``` +Grant-CsApplicationAccessPolicy [-Global] [-PassThru] [-PolicyName <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsApplicationAccessPolicy [-PassThru] [-PolicyName <String>] [-MsftInternalProcessingMode <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet assigns a per-user application access policy to one or more users. After assigning an application access policy to a user, the applications configured in the policy will be authorized to access online meetings on behalf of that user.**Note:** You can assign only 1 application access policy at a time to a particular user. Assigning a new application access policy to a user will override the existing application access policy if any. + +## EXAMPLES + +### Assign an application access policy to a user + +``` +PS C:\> Grant-CsApplicationAccessPolicy -Identity "dc17674c-81d9-4adb-bfb2-8f6a442e4624" -PolicyName "ASimplePolicy" +``` + +The command shown above assigns the per-user application access policy "ASimplePolicy" to the user with object ID "dc17674c-81d9-4adb-bfb2-8f6a442e4624". + +### Unassign an application access policy from a user + +``` +PS C:\> Grant-CsApplicationAccessPolicy -Identity "dc17674c-81d9-4adb-bfb2-8f6a442e4624" -PolicyName $Null +``` + +In the command shown above, any per-user application access policy previously assigned to the user with user (object) ID "dc17674c-81d9-4adb-bfb2-8f6a442e4624" is unassigned from that user; as a result, applications configured in the policy can no longer access online meetings on behalf of that user. To unassign a per-user policy, set the PolicyName to a null value ($Null). + +### Assign an application access policy to all users in the tenant + +``` +PS C:\> Get-CsOnlineUser | Grant-CsApplicationAccessPolicy -PolicyName "ASimplePolicy" +``` + +The command shown above assigns the per-user application access policy ASimplePolicy to all the users in the tenant. To do this, the command first calls the `Get-CsOnlineUser` cmdlet to get all user accounts enabled for Microsoft Teams or Skype for Business Online. Those user accounts are then piped to the `Grant-CsApplicationAccessPolicy` cmdlet, which assigns each user the application access policy "ASimplePolicy". + +### Assign an application access policy to users who have not been assigned one + +``` +PS C:\> Grant-CsApplicationAccessPolicy -PolicyName "ASimplePolicy" -Global +``` + +The command shown above assigns the per-user application access policy "ASimplePolicy" to all the users in the tenant, except any that have an explicit policy assignment. + +## 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. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. For example, if the user already have application access policy "A" assigned, and tenant admin assigns "B" globally, then application access policy "A" will take effect for the user. + +```yaml +Type: SwitchParameter +Parameter Sets:(All) +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 +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. Be aware that this parameter is tied to the cmdlet itself instead of to a property of the input object. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## 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) diff --git a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md b/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md new file mode 100644 index 0000000000..bac8b79e4c --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md @@ -0,0 +1,209 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsCallingLineIdentity + +## SYNOPSIS +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. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsCallingLineIdentity [[-PolicyName] <string>] [-Global] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsCallingLineIdentity [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Identity +``` +Grant-CsCallingLineIdentity [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can either assign a Caller ID policy to a specific user, to a group of users, or you can set the Global policy instance. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Grant-CsCallingLineIdentity -Identity Ken.Myer@contoso.com -PolicyName CallerIDRedmond +``` + +This example assigns the Caller ID policy with the Identity CallerIDRedmond to the user Ken.Myer@contoso.com + +### Example 2 +``` +Grant-CsCallingLineIdentity -PolicyName CallerIDSeattle -Global +``` + +This example copies the Caller ID policy CallerIDSeattle to the Global policy instance. + +### Example 3 +``` +Grant-CsCallingLineIdentity -Group sales@contoso.com -PolicyName CallerIDSeattle -Rank 10 +``` + +This example assigns the Caller ID policy with the Identity CallerIDSeattle to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: SwitchParameter +Parameter Sets: (GrantToTenant) +Aliases: +applicable: Microsoft Teams + +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-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. + +```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 +``` + +### -PolicyName +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: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: +applicable: Microsoft Teams + +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: +applicable: Microsoft Teams + +Required: False +Position: Named +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. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 0 +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 +``` + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +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) + +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) + +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) + +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) diff --git a/skype/skype-ps/skype/Grant-CsCloudMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md similarity index 76% rename from skype/skype-ps/skype/Grant-CsCloudMeetingPolicy.md rename to teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md index 6b0403b8e4..e85a10218d 100644 --- a/skype/skype-ps/skype/Grant-CsCloudMeetingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-cscloudmeetingpolicy +applicable: Microsoft Teams title: Grant-CsCloudMeetingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Grant-CsCloudMeetingPolicy @@ -19,7 +24,7 @@ Grant-CsCloudMeetingPolicy [-PolicyName] <String> [-Tenant <Guid>] [-DomainContr ## DESCRIPTION The Grant-CsCloudMeetingPolicy cmdlet enables or disables automatic scheduling of Skype Meetings features for a specified user. -The default is disbaled. +The default is disabled. To enable automatic scheduling for all users in a tenant, use the Set-CsCloudMeetingPolicy cmdlet. @@ -27,7 +32,7 @@ Note that the policies to use this cmdlet are not available unless the Set-CsClo ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Online) +### -------------------------- Example 1 -------------------------- ``` Grant-CsCloudMeetingPolicy -PolicyName AutoScheduleEnabled -Identity "JaneC" @@ -35,7 +40,6 @@ Grant-CsCloudMeetingPolicy -PolicyName AutoScheduleEnabled -Identity "JaneC" This example enables Skype Meetings automatic scheduling for a user. - ## PARAMETERS ### -Identity @@ -45,8 +49,8 @@ For example: `-Identity "SeattlePSTN".` ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -56,14 +60,14 @@ Accept wildcard characters: False ``` ### -PolicyName -Specifes the policy for all users automatic Skype Meeting Ready scheduling. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -79,7 +83,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -95,8 +99,8 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -111,8 +115,8 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -133,8 +137,8 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -151,23 +155,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -{{Fill AsJob Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -177,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -186,5 +174,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS - - diff --git a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md b/teams/teams-ps/teams/Grant-CsDialoutPolicy.md new file mode 100644 index 0000000000..73c1d5c787 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsDialoutPolicy.md @@ -0,0 +1,226 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsDialoutPolicy + +## SYNOPSIS +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. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsDialoutPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsDialoutPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsDialoutPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +In Microsoft Teams, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. The policies apply to all the different PSTN connectivity options for Microsoft Teams; Calling Plan, Direct Routing, and Operator Connect. + +To get all the available policies in your organization run `Get-CsOnlineDialOutPolicy`. + +## EXAMPLES + +### Example 1 +``` +Grant-CsDialoutPolicy -Identity "ken.myer@contoso.com" -PolicyName "DialoutCPCandPSTNInternational" +``` + +This example assigns the per-user outbound calling restriction policy DialoutCPCandPSTNInternational to the user with the User Principal Name "ken.myer@contoso.com". + +### Example 2 +``` +Grant-CsDialoutPolicy -Identity "ken.myer@contoso.com" -PolicyName $Null +``` + +In this example, any per-user outbound calling restriction policy previously assigned to the user ken.myer@contoso.com is unassigned from that user; as a result, Ken Myer will be managed by the global outbound calling restriction policy. To unassign a per-user policy, set the PolicyName to a null value ($Null). + +### Example 3 +``` +Get-CsOnlineUser | Grant-CsDialoutPolicy -PolicyName "DialoutCPCInternationalPSTNDisabled" +``` + +This example assigns the per-user outbound calling restriction policy DialoutCPCInternationalPSTNDisabled to all the users in your organization. + +### Example 4 +``` +Grant-CsDialoutPolicy -Global -PolicyName "DialoutCPCandPSTNInternational" +``` + +This example sets the tenant global policy instance to DialoutCPCandPSTNInternational. + +### Example 5 +``` +Grant-CsDialoutPolicy -Group support@contoso.com -Rank 10 -PolicyName "DialoutCPCandPSTNInternational" +``` + +This example assigns the policy instance "DialoutCPCandPSTNInternational" to the members of the group support@contoso.com. + +## PARAMETERS + +### -Global +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 +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: +Applicable: Microsoft Teams + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of 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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PassThru +Returns the results of the command. By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +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:DialoutCPCZoneAPSTNDomestic has a PolicyName equal to DialoutCPCZoneAPSTNDomestic. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +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: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +The cmdlet is not supported for Teams resource accounts. + +## RELATED LINKS +[Get-CsOnlineDialOutPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy) diff --git a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..ffce2c43e2 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md @@ -0,0 +1,297 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy +applicable: Microsoft Teams +title: Grant-CsExternalAccessPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Grant-CsExternalAccessPolicy + +## SYNOPSIS + +Enables you to assign an external access policy to a user or a group of users. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsExternalAccessPolicy [<CommonParameters>] +``` + +### GrantToUser +```powershell +Grant-CsExternalAccessPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsExternalAccessPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsExternalAccessPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION + +When you install Microsoft Teams or Skype for Business Server, your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation will not automatically provide users with this capability. +Instead, you must enable federation, and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +4. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +When you install Skype for Business Server, a global external access policy is automatically created for you. +In addition to this global policy, you can use the New-CsExternalAccessPolicy cmdlet to create additional external access policies configured at either the site or the per-user scope. + +When a policy is created at the site scope, it is automatically assigned to the site in question; for example, an external access policy with the Identity site:Redmond will automatically be assigned to the Redmond site. +By contrast, policies created at the per-user scope are not automatically assigned to anyone. +Instead, these policies must be explicitly assigned to a user or a group of users. +Assigning per-user policies is the job of the Grant-CsExternalAccessPolicy cmdlet. + +Note that per-user policies always take precedent over site policies and the global policy. +For example, suppose you create a per-user policy that allows communication with federated users, and you assign that policy to Ken Myer. +As long as that policy is in force, Ken will be allowed to communicate with federated users even if this type of communication is not allowed by Ken's site policy or by the global policy. +That's because the settings in the per-user policy take precedence. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Grant-CsExternalAccessPolicy -Identity "Ken Myer" -PolicyName RedmondAccessPolicy +``` + +Example 1 assigns the external access policy RedmondAccessPolicy to the user with the Active Directory display name Ken Myer. + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy +``` + +The command shown in Example 2 assigns the external access policy RedmondAccessPolicy to all the users who work in the city of Redmond. +To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who work in Redmond; the filter value "l=Redmond" limits returned data to those users who work in the city of Redmond (the l in the filter, a lowercase L, represents the locality). +That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection. + +### -------------------------- EXAMPLE 3 -------------------------- +```powershell +Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy +``` + +In Example 3, all the users who have the job title "Sales Representative" are assigned the external access policy SalesAccessPolicy. +To perform this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the Sales Representatives; the filter value "Title=Sales Representative" restricts the returned collection to users who have the job title "Sales Representative". +This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection. + +### -------------------------- EXAMPLE 4 -------------------------- +```powershell +Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy +``` + +The command shown in Example 4 assigns the external access policy BasicAccessPolicy to all the users who have not been explicitly assigned a per-user policy. +(That is, users currently being governed by a site policy or by the global policy.) To do this, the Get-CsUser cmdlet and the Filter parameter are used to return the appropriate set of users; the filter value {ExternalAccessPolicy -eq $Null} limits the returned data to user accounts where the ExternalAccessPolicy property is equal to (-eq) a null value ($Null). +By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy. + +### -------------------------- EXAMPLE 5 -------------------------- +```powershell +Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy +``` + +Example 5 assigns the external access policy USAccessPolicy to all the users who have accounts in the US organizational unit (OU). +The command starts off by calling the Get-CsUser cmdlet and the OU parameter; the parameter value "ou=US,dc=litwareinc,dc=com" limits the returned data to user accounts found in the US OU. +The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection. + +### -------------------------- EXAMPLE 6 -------------------------- +```powershell +Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null +``` + +Example 6 unassigns any per-user external access policy previously assigned to any of the users enabled for Skype for Business Server. +To do this, the command calls the Get-CsUser cmdlet (without any additional parameters) in order to return a collection of all the users enabled for Skype for Business Server. +That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which uses the syntax "`-PolicyName $Null`" to remove any per-user external access policy previously assigned to these users. + +## PARAMETERS + +### -Identity +Identity of the user account the policy should be assigned to. +User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when specifying the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith." + +```yaml +Type: UserIdParameter +Parameter Sets: GrantToUser +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter +String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. + +Grant-CsExternalAccessPolicy accepts pipelined input of string values representing the Identity of a user account. +The cmdlet also accepts pipelined input of user objects. + +## OUTPUTS + +### Output types +By default, Grant-CsExternalAccessPolicy does not return a value or object. + +However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md new file mode 100644 index 0000000000..d587ae4503 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md @@ -0,0 +1,167 @@ +--- +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] <UserIdParameter>] [-PolicyName] <String> + [-Tenant <Guid>] [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsExternalUserCommunicationPolicy [-PolicyName] <String> [-Tenant <Guid>] + [-DomainController <Fqdn>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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/Grant-CsGroupPolicyPackageAssignment.md b/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md new file mode 100644 index 0000000000..a3f18f52c8 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Grant-CsGroupPolicyPackageAssignment +author: serdarsoysal +ms.author: serdars +manager: dasosby +online version: https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment +schema: 2.0.0 +--- + +# Grant-CsGroupPolicyPackageAssignment + +## SYNOPSIS + +This cmdlet assigns a policy package to a group in a tenant. + +## SYNTAX + +``` +Grant-CsGroupPolicyPackageAssignment -GroupId <String> -PackageName <String> [-PolicyRankings <String[]>] [<CommonParameters>] [-Confirm] [-WhatIf] +``` + +## DESCRIPTION + +This cmdlet assigns a policy package to a group in a tenant. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. For more information on policy packages, please review [Manage policy packages in Microsoft Teams](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). + +Policy rankings can be optionally specified for each policy type in the package to determine which policies will be assigned to the user in case they belong to two or more groups. If policy rankings for a policy type is not specified, one of two things can happen: + +- If the policy type was previously assigned to the group, the ranking for the policy type will not change. +- If the policy type was not previously assigned to the group, the ranking for the policy type will be ranked last. + +Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsGroupPolicyPackageAssignment -GroupId 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_PrimaryStudent +``` + +Assigns the Education_PrimaryStudent policy package to the group. The group will receive the lowest policy ranking for each policy type in the Education_PrimaryStudent package if the policy type is newly assigned to the group. If a policy type was already assigned to the group, the group will receive the same policy ranking as before. + +### Example 2 +```powershell +PS C:\> Grant-CsGroupPolicyPackageAssignment -GroupId 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_Teacher -PolicyRankings "TeamsMessagingPolicy, 1", "TeamsMeetingPolicy, 1", "TeamsCallingPolicy, 2" +``` + +Assigns the Education_Teacher policy package to the group. The group will receive a policy ranking of 1 for TeamsMessagingPolicy policy type, a policy ranking of 1 for TeamsMeetingPolicy policy type and a policy ranking of 2 for TeamsCallingPolicy policy type. For each unspecified policy type in the package, the group will receive the lowest policy ranking if it is newly assigned to the group. If a policy type was already assigned to the group, the group will receive the same policy ranking as before. + +## PARAMETERS + +### -GroupId + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageName + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRankings + +The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "\<PolicyType\>, \<PolicyRank\>". 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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..d9f1d28be6 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,247 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy +title: Grant-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Grant-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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 "<testuser@test.onmicrosoft.com>". + +### 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: <testuser@test.onmicrosoft.com> + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: 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/teams/Grant-CsOnlineVoiceRoutingPolicy.md new file mode 100644 index 0000000000..4f5598bbb8 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md @@ -0,0 +1,191 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsOnlineVoiceRoutingPolicy + +## SYNOPSIS +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. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsOnlineVoiceRoutingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsOnlineVoiceRoutingPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsOnlineVoiceRoutingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [<CommonParameters>] +``` + +## DESCRIPTION +Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Teams users an online voice routing policy enables those users to receive and to place phone calls to the public switched telephone network by using your on-premises SIP trunks. + +Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsOnlineVoiceRoutingPolicy -Identity Ken.Myer@contoso.com -PolicyName "RedmondOnlineVoiceRoutingPolicy" +``` + +The command shown in Example 1 assigns the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy to the user ken.myer@contoso.com. + +### Example 2 +```powershell +Grant-CsOnlineVoiceRoutingPolicy -Identity Ken.Myer@contoso.com -PolicyName $Null +``` + +In Example 2, any per-user online voice routing policy previously assigned to the user Ken Myer is unassigned from that user; as a result, Ken Myer will be managed by the global online voice routing policy. To unassign a per-user policy, set the PolicyName to a null value ($null). + +### Example 3 +```powershell +Get-CsOnlineUser | Grant-CsOnlineVoiceRoutingPolicy -PolicyName "RedmondOnlineVoiceRoutingPolicy" +``` + +Example 3 assigns the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy to all the users in the tenant. To do this, the command first calls the `Get-CsOnlineUser` cmdlet to get all user accounts enabled for Microsoft Teams or Skype for Business Online. Those user accounts are then piped to the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet, which assigns each user the online voice routing policy RedmondOnlineVoiceRoutingPolicy. + +### Example 4 +```powershell +Grant-CsOnlineVoiceRoutingPolicy -PolicyName "RedmondOnlineVoiceRoutingPolicy" -Global +``` + +Example 4 assigns the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy as the global online voice routing policy. This affects all the users in the tenant, except any that have an explicit policy assignment. + +### Example 5 +```powershell +Grant-CsOnlineVoiceRoutingPolicy -Group sales@contoso.com -Rank 10 -PolicyName "RedmondOnlineVoiceRoutingPolicy" +``` + +Example 5 assigns the online voice routing policy RedmondOnlineVoiceRoutingPolicy to all members of the group sales@contoso.com. + +## 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). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` 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: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: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, 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: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) + +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) + +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) + +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md new file mode 100644 index 0000000000..fada417049 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md @@ -0,0 +1,201 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsOnlineVoicemailPolicy + +## SYNOPSIS +Assigns an online voicemail policy to a user account, to a group of users, or set the tenant Global instance. Online voicemail policies manage usages for Voicemail service. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsOnlineVoicemailPolicy [[-PolicyName] <string>] [-Global] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` +### GrantToGroup +``` +Grant-CsOnlineVoicemailPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Identity +``` +Grant-CsOnlineVoicemailPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet assigns an existing user-specific online voicemail policy to a user, a group of users, or the Global policy instance. + +## EXAMPLES + +### Example 1 +``` +Grant-CsOnlineVoicemailPolicy -Identity "user@contoso.com" -PolicyName TranscriptionDisabled +``` + +The command shown in Example 1 assigns the per-user online voicemail policy TranscriptionDisabled to a single user user@contoso.com. + +### Example 2 +``` +Grant-CsOnlineVoicemailPolicy -Group sales@contoso.com -Rank 10 -PolicyName TranscriptionDisabled +``` + +The command shown in Example 2 assigns the online voicemail policy TranscriptionDisabled to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. + +```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 +``` + +### -PolicyName +A unique identifier(name) of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: +applicable: Microsoft Teams + +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: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) + +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) + +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) + +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..4b3575f42c --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Grant-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Grant-CsTeamsAIPolicy + +## SYNOPSIS +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsAIPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsAIPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsAIPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) \ No newline at end of file diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md new file mode 100644 index 0000000000..76d9afbba6 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# Grant-CsTeamsAppPermissionPolicy + +## SYNOPSIS +**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies> and about app centric management at <https://learn.microsoft.com/microsoftteams/app-centric-management>. + +This is only applicable for tenants who have not been migrated to ACM or UAM. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsAppPermissionPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsAppPermissionPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsAppPermissionPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsAppPermissionPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies>. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsAppPermissionPolicy -Identity "Ken Myer" -PolicyName StudentAppPermissionPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the StudentAppPermissionPolicy + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Do not use. +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Resets the values in the global policy to match those in the provided (PolicyName) policy. Note that this means all users with no explicit policy assigned will have these new policy settings. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user to whom the policy should be assigned. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..3568887beb --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md @@ -0,0 +1,226 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsAppSetupPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsAppSetupPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsAppSetupPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsAppSetupPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsAppSetupPolicy -identity "Ken Myer" -PolicyName StudentAppSetupPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the StudentAppSetupPolicy + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Do not use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Resets the values in the global policy to match those in the provided (PolicyName) policy. Note that this means all users with no explicit policy assigned will have these new policy settings. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user to whom the policy should be assigned. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md new file mode 100644 index 0000000000..10b0d7085d --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md @@ -0,0 +1,191 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy +title: Grant-CsTeamsAudioConferencingPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsAudioConferencingPolicy + +## SYNOPSIS + +Assigns a Teams audio-conferencing policy at the per-user scope. 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. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsTeamsAudioConferencingPolicy [-Global] [-PassThru] [[-PolicyName] <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsAudioConferencingPolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Identity +``` +Grant-CsTeamsAudioConferencingPolicy [-PassThru] [[-PolicyName] <String>] [[-Identity] <String>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Granular control over which audio conferencing features your users can or cannot use is an important feature for many organizations. This cmdlet lets you assign a teams audio conferencing policy at the per-user scope. Audio conferencing policies determine the audio-conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Grant-CsTeamsAudioCOnferencingPolicy -identity "Ken Myer" -PolicyName "Emea Users" +``` + +In this example, a user with identity "Ken Myer" is being assigned the "Emea Users" policy. + +## PARAMETERS + +### -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: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: False +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). + +```yaml +Type: String +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 account being assigned the online voice routing policy. +Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: 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 +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +## OUTPUTS + +### Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) + +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) + +[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md new file mode 100644 index 0000000000..6d1b8028b7 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Grant-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Assigns a per-user Teams call hold policy to one or more users. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsCallHoldPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsCallHoldPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsCallHoldPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsCallHoldPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 1 assigns the per-user Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". + +### Example 2 +```powershell +Grant-CsTeamsCallHoldPolicy -Identity 'Ken Myer' -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 2 assigns the per-user Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the user with the display name "Ken Myer". + +### Example 3 +```powershell +Grant-CsTeamsCallHoldPolicy -Identity 'Ken Myer' -PolicyName $null +``` + +In Example 3, any per-user Teams call hold policy previously assigned to the user "Ken Myer" is revoked. +As a result, the user will be managed by the global Teams call hold policy. + +### Example 4 +```powershell +Grant-CsTeamsCallHoldPolicy -Global -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 4 sets the Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, as the Global policy which will apply to all users in your tenant. + +### Example 5 +```powershell +Grant-CsTeamsCallHoldPolicy -Group sales@contoso.com -Rank 10 -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 5 sets the Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams call hold policy. +User Identities can be specified using one of the following formats: + +- The user's SIP address; +- The user's user principal name (UPN); +- The user's Active Directory display name (for example, Ken Myer). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the Grant-CsTeamsCallHoldPoly cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +For example, a policy with the Identity Tag:ContosoPartnerCallHoldPolicy has a PolicyName equal to ContosoPartnerCallHoldPolicy. + +To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md new file mode 100644 index 0000000000..65c8d7ab00 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md @@ -0,0 +1,202 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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 + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsCallParkPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsCallParkPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsCallParkPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsCallParkPolicy -PolicyName SalesPolicy -Identity Ken.Myer@contoso.com +``` + +Assigns a custom policy "Sales Policy" to the user Ken Myer. + +### Example 2 +```powershell +Grant-CsTeamsCallParkPolicy -Group sales@contoso.com -Rank 10 -PolicyName SalesPolicy +``` + +Assigns a custom policy "Sales Policy" to the members of the group sales@contoso.com. + +## PARAMETERS + +### -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: (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 ("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: (All) +Aliases: + +Required: True +Position: 1 +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: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS +[Set-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy) + +[Get-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy) + +[New-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy) + +[Remove-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..c843a89e58 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md @@ -0,0 +1,177 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsTeamsCallingPolicy + +## SYNOPSIS + +Assigns a specific Teams Calling Policy to a user, a group of users, or sets the Global policy instance. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsCallingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsCallingPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsCallingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [<CommonParameters>] +``` + +## DESCRIPTION +The Teams Calling Policies designate how users are able to use calling functionality 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 +```powershell +Grant-CsTeamsCallingPolicy -identity user1@contoso.com -PolicyName SalesCallingPolicy +``` + +Assigns the TeamsCallingPolicy called "SalesCallingPolicy" to user1@contoso.com + +### Example 2 +```powershell +Grant-CsTeamsCallingPolicy -Global -PolicyName SalesCallingPolicy +``` + +Assigns the TeamsCallingPolicy called "SalesCallingPolicy" to the Global policy instance. This sets the parameters in the Global policy instance to the values found +in the SalesCallingPolicy instance. + +### Example 3 +```powershell +Grant-CsTeamsCallingPolicy -Group sales@contoso.com -Rank 10 -PolicyName SalesCallingPolicy +``` + +Assigns the TeamsCallingPolicy called "SalesCallingPolicy" 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: 0 +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the 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: 1 +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: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: (GrantToGroup) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS + +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) + +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md new file mode 100644 index 0000000000..abfbdfe908 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md @@ -0,0 +1,216 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Grant-CsTeamsChannelsPolicy + +## SYNOPSIS + +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsChannelsPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> [-Tenant <System.Guid>] + [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsChannelsPolicy [-PolicyName] <String> [-Tenant <System.Guid>] [-DomainController <Fqdn>] + [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsChannelsPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsChannelsPolicy -Identity studentaccount@company.com -PolicyName StudentPolicy +``` + +Assigns a custom policy to a specific user in an organization. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Internal Microsoft usage only. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use the -Global flag to convert the values of the Global policy to the values of the specified policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the user to whom the policy is being assigned. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specify the policy that should be granted 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 +``` + +### -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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md new file mode 100644 index 0000000000..caa013a167 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Grant-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Assigns a per-user Teams recording policy to one or more users. +This policy is used to govern automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsComplianceRecordingPolicy [-Identity <UserIdParameter>] [-PolicyName <String>] + [-Tenant <System.Guid>] [-DomainController <Fqdn>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsComplianceRecordingPolicy [-Global] [-PolicyName <String>] + [-Tenant <System.Guid>] [-DomainController <Fqdn>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsComplianceRecordingPolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsComplianceRecordingPolicy -Identity 'Ken Myer' -PolicyName 'ContosoPartnerComplianceRecordingPolicy' +``` + +The command shown in Example 1 assigns the per-user Teams recording policy ContosoPartnerComplianceRecordingPolicy to the user with the display name "Ken Myer". + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsComplianceRecordingPolicy -Identity 'Ken Myer' -PolicyName $null +``` + +In Example 2, any per-user Teams recording policy previously assigned to the user "Ken Myer" is revoked. +As a result, the user will be managed by the global Teams recording policy. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams recording policy. +User Identities can be specified using one of the following formats: + +- The user's SIP address; +- The user's user principal name (UPN); +- The user's Active Directory display name (for example, Ken Myer). + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. +To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. +The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. +For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. + +To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. +By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md new file mode 100644 index 0000000000..ef2205b07d --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Grant-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsCortanaPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> [-Tenant <System.Guid>] + [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsCortanaPolicy [-PolicyName] <String> [-Tenant <System.Guid>] [-DomainController <Fqdn>] + [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsCortanaPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +This cmdlet lets you assign a Teams Cortana policy at the per-user scope. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsCortanaPolicy -identity "Ken Myer" -PolicyName MyCortanaPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the MyCortanaPolicy + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +You can return your tenant ID by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md new file mode 100644 index 0000000000..c86a84aa89 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsEmergencyCallRoutingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Grant-CsTeamsEmergencyCallRoutingPolicy + +## SYNOPSIS +This cmdlet assigns a Teams Emergency Call Routing policy. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsTeamsEmergencyCallRoutingPolicy [[-PolicyName] <string>] [-Global] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsEmergencyCallRoutingPolicy [-Group] <string> [[-PolicyName] <string>] + [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Identity +``` +Grant-CsTeamsEmergencyCallRoutingPolicy [[-Identity] <string>] [[-PolicyName] <string>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet assigns a Teams Emergency Call Routing policy to a user, a group of users, or to the Global policy instance. Teams Emergency Call Routing policy is used for the life cycle of emergency call routing - emergency numbers and routing configuration. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsEmergencyCallRoutingPolicy -Identity user1 -PolicyName Test +``` + +This example assigns a Teams Emergency Call Routing policy (Test) to a user (user1). + +### Example 2 +```powershell +Grant-CsTeamsEmergencyCallRoutingPolicy -Group sales@contoso.com -Rank 10 -PolicyName Test +``` + +This example assigns the Teams Emergency Call Routing policy (Test) to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: SwitchParameter +Parameter Sets: (GrantToTenant) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The Identity of the Teams Emergency Call Routing policy to apply. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) + +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) + +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..6a5ce3b2a9 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsEmergencyCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc, pthota +schema: 2.0.0 +--- + +# Grant-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS +This cmdlet assigns a Teams Emergency Calling policy. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsTeamsEmergencyCallingPolicy [[-PolicyName] <string>] [-Global] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Identity +``` +Grant-CsTeamsCallingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsEmergencyCallingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet assigns a Teams Emergency Calling policy to a user, a group of users, or to the Global policy instance. Emergency Calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsEmergencyCallingPolicy -Identity user1 -PolicyName TestTECP +``` + +This example assigns the Teams Emergency Calling policy TestTECP to a user + +### Example 2 +```powershell +Grant-CsTeamsEmergencyCallingPolicy -Global -PolicyName SalesTECP +``` + +Assigns the Teams Emergency Calling policy called "SalesTECP" to the Global policy instance. This sets the parameters in the Global policy instance to the values found in the SalesTECP instance. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: SwitchParameter +Parameter Sets: (GrantToTenant) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The Identity of the Teams Emergency Calling policy to apply to the user. To remove an existing user level policy assignment, specify PolicyName as $null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md new file mode 100644 index 0000000000..58b0be1886 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md @@ -0,0 +1,201 @@ +--- +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] <String>] [-PassThru] [[-PolicyName] <String>][-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] <String>] -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..ad83d722d4 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md @@ -0,0 +1,207 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy +title: Grant-CsTeamsEventsPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsEventsPolicy + +## SYNOPSIS +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEventsPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] <String>] + [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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/teams/Grant-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..cacbfb5a0b --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md @@ -0,0 +1,217 @@ +--- +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 +ms.author: tomkau +ms.reviewer: +--- + +# Grant-CsTeamsFeedbackPolicy + +## SYNOPSIS + +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). + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsFeedbackPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsFeedbackPolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsFeedbackPolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Grants a specific Teams Feedback policy to a user (the ability to send feedback about Teams to Microsoft and whether they receive the survey) or to set a specific Teams feedback policy the new effective global policy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsFeedbackPolicy -PolicyName "New Hire Feedback Policy" -Identity kenmyer@litwareinc.com +``` + +In this example, the policy "New Hire Feedback Policy" is granted to the user kenmyer@litwareinc.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. + +```yaml +Type: Object +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The identity of the policy to be granted. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..3f44d72269 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy +title: Grant-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsFilesPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsFilesPolicy [<CommonParameters>] +``` + +### GrantToUser + +```powershell +Grant-CsTeamsFilesPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> [<CommonParameters>] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## 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: <testuser@test.onmicrosoft.com> + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: 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/teams/Grant-CsTeamsIPPhonePolicy.md new file mode 100644 index 0000000000..4e0833c5a5 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsipphonepolicy +applicable: Microsoft Teams +title: Grant-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Grant-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a user account or group of user accounts. Teams phone policies determine the features that are available to users of Teams phones. For example, you might enable the hot desking feature for some users while disabling it for others. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsIPPhonePolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsIPPhonePolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsIPPhonePolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a phone signed in with an account that may be used by end users, common area phones, or meeting room accounts. + +Note: Assigning a per user policy will override any global policy taking effect against the respective user account. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsIPPhonePolicy -Identity Foyer1@contoso.com -PolicyName CommonAreaPhone +``` + +This example shows assignment of the CommonAreaPhone policy to user account Foyer1@contoso.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Microsoft Internal Use Only. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. + +```yaml +Type: Object +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The Identity of the Teams phone policy to apply to the user. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Microsoft internal usage only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..126e7adfd2 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Grant-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Grant-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMediaConnectivityPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsMediaConnectivityPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md new file mode 100644 index 0000000000..960fd62910 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md @@ -0,0 +1,242 @@ +--- +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 +manager: shalages +schema: 2.0.0 +--- + +# Grant-CsTeamsMediaLoggingPolicy + +## SYNOPSIS + +Assigns Teams Media Logging policy to a user or entire tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMediaLoggingPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Assigns Teams Media Logging policy to a user or entire tenant. +TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After unassigning the policy, media logging setting will revert to the previous value. + +## EXAMPLES + +### EXAMPLE 1 + +```PowerShell +PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName Enabled +``` + +Assign Teams Media Logging policy to a single user with the user principal name (UPN) "KenMyer@contoso.com". This will enable media logging for the user. + +### EXAMPLE 2 + +```PowerShell +PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName $null +``` + +Unassign Teams Media Logging policy from a single user with the user principal name (UPN) "KenMyer@contoso.com". This will revert media logging setting to the previous value. + +### EXAMPLE 3 + +```PowerShell +PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName Enabled +``` + +Assign Teams Media Logging policy to the entire tenant. Note that this will enable logging for every single user in the tenant without a possibility to disable it for individual users. + +### EXAMPLE 4 + +```PowerShell +PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName $null +``` + +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 + +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: +applicable: Microsoft Teams + +Required: False +Position: 1 +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-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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 +``` + +### -Global + +When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 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 +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..cd29d655c1 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# Grant-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +Assigns a teams meeting branding policy at the per-user scope. The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +### GrantToUser +``` +Grant-CsTeamsMeetingBrandingPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +Assigns a teams meeting branding policy at the per-user scope. The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## EXAMPLES + +### Assign TeamsMeetingBrandingPolicy to a user +```powershell +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "alice@contoso.com" -PolicyName "Policy Test" +``` + +In this example, the command assigns TeamsMeetingBrandingPolicy with the name `Policy Test` to user `alice@contoso.com`. + +### Assign TeamsMeetingBrandingPolicy to a group +```powershell +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group group@contoso.com -PolicyName "Policy Test" -Rank 1 +``` + +In this example, the command will assign TeamsMeetingBrandingPolicy with the name `Policy Test` to group `group@contoso.com`. + +## PARAMETERS + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user you want to grant policy to. This can be specified as an SIP address, UserPrincipalName, or ObjectId. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to `$Null`. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md new file mode 100644 index 0000000000..1fac390b29 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md @@ -0,0 +1,207 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Grant-CsTeamsMeetingBroadcastPolicy + +## SYNOPSIS +Grant-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \<UserIdParameter\>\] \[-PolicyName\] \<string\> \[-Tenant \<guid\>\] \[-DomainController \<Fqdn\>\] \[-PassThru\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] + +Grant-CsTeamsMeetingBroadcastPolicy \[-PolicyName\] \<string\> \[-Tenant \<guid\>\] \[-DomainController \<Fqdn\>\] \[-PassThru\] \[-Global\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMeetingBroadcastPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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. + +## 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 +``` + +### -DomainController +Not applicable to online service. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: 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 +``` + +### -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 +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md new file mode 100644 index 0000000000..555e7a9518 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsMeetingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Grant-CsTeamsMeetingPolicy + +## SYNOPSIS +Assigns a teams meeting policy at the per-user scope. The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users + +## SYNTAX + +### GrantToTenant (Default) +```powershell +Grant-CsTeamsMeetingPolicy [-Global] [-PassThru] [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] <String>] + [[-Group] <String>] [-Rank <Int32>] [<CommonParameters>] +``` + +### Identity +```powershell +Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] <String>] + [[-Identity] <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Assigns a teams meeting policy at the per-user scope. The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMeetingPolicy -identity "Ken Myer" -PolicyName StudentMeetingPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the StudentMeetingPolicy + +## PARAMETERS + +### -DomainController + +```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 +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: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```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 +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..591125a048 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Grant-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +Pass in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 - Assign a policy to a user + +```powershell +PS> Grant-CsTeamsMeetingTemplatePermissionPolicy -PolicyName Foobar -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +## PARAMETERS + +### -PolicyName + +Specifies the Identity of the policy to assign to the user or group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This is the identifier of the user that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md new file mode 100644 index 0000000000..cbe96c09cb --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsMessagingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Grant-CsTeamsMessagingPolicy + +## SYNOPSIS +Assigns a teams messaging policy at the per-user scope. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMessagingPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMessagingPolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMessagingPolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Granular control over which messaging features your users can or cannot use is an important feature for many organizations. This cmdlet lets you assign 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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMessagingPolicy -identity "Ken Myer" -PolicyName StudentMessagingPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the StudentMessagingPolicy + +### Example 2 +```powershell +PS C:\> Get-CsOnlineUser -Filter {Department -eq 'Executive Management'} | Grant-CsTeamsMessagingPolicy -PolicyName "ExecutivesPolicy" +``` + +In this example, the ExecutivesPolicy is being assigned to a whole department by piping the result of Get-CsOnlineUser cmdlet + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md new file mode 100644 index 0000000000..9ca488f23b --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Grant-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Grant-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMobilityPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsMobilityPolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsMobilityPolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Assigns a teams mobility policy at the per-user scope. + +The Grant-CsTeamsMobilityPolicy cmdlet lets an Admin assign a custom teams mobility policy to a user. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMobilityPolicy -PolicyName SalesPolicy -Identity "Ken Myer" +``` +Assigns a custom policy "Sales Policy" to the user "Ken Myer" + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The User Id of the user to whom the policy is being assigned. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..de38261c46 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Grant-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Grant-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +Grant-CsTeamsRecordingRollOutPolicy -Identity <String> -PolicyName <String> [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The Grant-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to assign a CsTeamsRecordingRollOutPolicy at the per-user scope. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMeetingPolicy -identity "Ken Myer" -PolicyName OrganizerPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the OrganizerPolicy + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..e9460ea3d0 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,204 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy +title: Grant-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The alias of the Teams room that the IT admin is granting this PolicyName to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Corresponds to the name of the policy under -Identity from the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..4eb7f30ac5 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Grant-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS + +Assigns a specific Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsSharedCallingRoutingPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsSharedCallingRoutingPolicy [[-PolicyName] <string>] -Identity <string> [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsSharedCallingRoutingPolicy -Global [[-PolicyName] <string>] [-Force] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsSharedCallingRoutingPolicy [-Group] <string> [[-PolicyName] <string>] -Rank <int> [<CommonParameters>] +``` + +## EXAMPLES + +### EXAMPLE 1 +``` +Grant-CsTeamsSharedCallingRoutingPolicy -Identity "user@contoso.com" -PolicyName "Seattle" +``` +The command shown in Example 1 assigns the per-user Teams shared calling routing policy instance Seattle to the user user@contoso.com. + +### EXAMPLE 2 +``` +Grant-CsTeamsSharedCallingRoutingPolicy -PolicyName "Seattle" -Global +``` +Example 2 assigns the per-user Teams shared calling routing policy instance Seattle to all the users in the organization, except any that have an explicit Teams shared calling routing policy assignment. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your organization, except any that have an explicit policy assignment. To prevent a warning when you carry out this operation, specify this parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: (GrantToGroup) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: (GrantToGroup) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md new file mode 100644 index 0000000000..43875faa32 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md @@ -0,0 +1,162 @@ +--- +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 [<CommonParameters>] +``` + +### GrantToUser +```powershell +Grant-CsTeamsShiftsPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..bbe885264d --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,199 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy +title: Grant-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the user. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..d17f961f44 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Grant-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to grant a specific Teams Update Management policy to a user. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsUpdateManagementPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-ProgressAction <ActionPreference>] + [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] + [-Global] [-ProgressAction <ActionPreference>] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] + [-Group] <String> [-Rank <Int32>] [-ProgressAction <ActionPreference>] + [<CommonParameters>] +``` + +## DESCRIPTION +Grants a specific Teams Update Management policy to a user or sets a specific Teams Update Management policy as the new effective global policy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsUpdateManagementPolicy -PolicyName "Campaign Policy" -Identity kenmyer@litwareinc.com +``` + +In this example, the policy "Campaign Policy" is granted to the user kenmyer@litwareinc.com. + +## PARAMETERS + +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The identity of the policy to be granted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md new file mode 100644 index 0000000000..54251476e5 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +applicable: Microsoft Teams +title: Grant-CsTeamsUpgradePolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Grant-CsTeamsUpgradePolicy + +## SYNOPSIS +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsUpgradePolicy [[-Identity] <String>] [-MigrateMeetingsToTeams <Boolean>] [-PassThru] + [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams <Boolean>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-Force] [-Global] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams <Boolean>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] -Group <String> [-Rank <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION + +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs what functionality is available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. + +This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. + +**NOTE**: Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](https://learn.microsoft.com/powershell/module/skype/start-csexmeetingmigration). + +Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: + +|Identity|Mode|NotifySfbUsers|Comments| +|---|---|---|---| +|Islands|Islands|False|Default configuration. Allows a single user to evaluate both clients side by side. Chats and calls can land in either client, so users must always run both clients.| +|IslandsWithNotify|Islands|True|Same as Islands and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBOnly|SfBOnly|False|Calling, chat functionality and meeting scheduling in the Teams app are disabled.| +|SfBOnlyWithNotify|SfBOnly|True|Same as SfBOnly and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBWithTeamsCollab|SfBWithTeamsCollab|False|Calling, chat functionality and meeting scheduling in the Teams app are disabled.| +|SfBWithTeamsCollabWithNotify|SfBWithTeamsCollab|True|Same as SfBWithTeamsCollab and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBWithTeamsCollabAndMeetings|SfBWithTeamsCollabAndMeetings|False|Calling and chat functionality in the Teams app are disabled.| +|SfBWithTeamsCollabAndMeetingsWithNotify|SfBWithTeamsCollabAndMeetings|True|Same as SfBWithTeamsCollabAndMeetings and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|UpgradeToTeams|TeamsOnly|False|Use this mode to upgrade users to Teams and to prevent chat, calling, and meeting scheduling in Skype for Business.| +|Global|Islands|False|| + +> [!IMPORTANT] +> TeamsUpgradePolicy can be assigned to any Teams user, whether that user have an on-premises account in Skype for Business Server or not. However, **TeamsOnly mode can only be assigned to a user who is already homed in Skype for Business Online**. This is because interop with Skype for Business users and federation as well as Microsoft 365 Phone System functionality are only possible if the user is homed in Skype for Business Online. In addition, you cannot assign TeamsOnly mode as the tenant-wide default if you have any Skype for Business on-premises deployment (which is detected by presence of a lyncdiscover DNS record that points to a location other than Office 365. To make these users TeamsOnly you must first move these users individually to the cloud using `Move-CsUser`. Once all users have been moved to the cloud, you can [disable hybrid to complete migration to the cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid) and then apply TeamsOnly mode at the tenant level to ensure future users are TeamsOnly by default. + +> [!NOTE] +> +> - TeamsUpgradePolicy is available in both Office 365 and in on-premises versions of Skype for Business Server, but there are differences: +> - In Office 365, admins can specify both coexistence mode and whether to trigger notifications of pending upgrade. +> - In on-premises with Skype for Business Server, the only available option is to trigger notifications. Skype for Business Server 2015 with CU8 or Skype for Business Server 2019 are required. +> - TeamsUpgradePolicy in Office 365 can be granted to users homed on-premises in hybrid deployments of Skype for Business as follows: +> - Coexistence mode is honored by users homed on-premises, however on-premises users cannot be granted the UpgradeToTeams instance (mode=TeamsOnly) of TeamsUpgradePolicy. To be upgraded to TeamsOnly mode, users must be either homed in Skype for Business Online or have no Skype account anywhere. +> - The NotifySfBUsers setting of Office 365 TeamsUpgradePolicy is not honored by users homed on-premises. Instead, the on-premises version of TeamsUpgradePolicy must be used. +> - In Office 365, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet available. In contrast, Skype for Business Server does not contain built-in instances, so the New cmdlet is available on-premises. Only NotifySfBUsers property is available in on-premises. +> - When granting a user a policy with mode=TeamsOnly or mode=SfBWithTeamsCollabAndMeetings, by default, meetings organized by that user will be migrated to Teams. For details, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). + +When users are in any of the Skype for Business modes (SfBOnly, SfBWithTeamsCollab, SfBWithTeamsCollabAndMeetings), calling and chat functionality in the Teams app are disabled (but chat in the context of a Teams meeting is still allowed). Similarly, when users are in the SfBOnly or SfBWithTeamsCollab modes, meeting scheduling is disabled. For more details, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). + +The `Grant-CsTeamsUpgradePolicy` cmdlet checks the configuration of the corresponding settings in TeamsMessagingPolicy, TeamsCallingPolicy, and TeamsMeetingPolicy to determine if those settings would be superceded by TeamsUpgradePolicy and if so, an informational message is provided in PowerShell. It is not necessary to set these other policy settings. This is for informational purposes only. Below is an example of what the PowerShell warning looks like: + +`Grant-CsTeamsUpgradePolicy -Identity user1@contoso.com -PolicyName SfBWithTeamsCollab` + +**WARNING**: The user `user1@contoso.com` currently has enabled values for: AllowUserChat, AllowPrivateCalling, AllowPrivateMeetingScheduling, AllowChannelMeetingScheduling, however these values will be ignored. This is because you are granting this user TeamsUpgradePolicy with mode=SfBWithTeamsCollab, which causes the Teams client to behave as if they are disabled. + +> [!NOTE] +> These warning messages are not affected by the -WarningAction parameter. + +## EXAMPLES + +### Example 1: Grant Policy to an individual user + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName UpgradeToTeams -Identity mike@contoso.com +``` + +The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. This effectively upgrades the user to Teams only mode. This command will only succeed if the user does not have an on-premises Skype for Business account. + +### Example 2: Remove Policy for an individual user + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName $null -Identity mike@contoso.com +``` + +The above cmdlet removes any policy changes made to user Mike@contoso.com and effectively Inherits the global tenant setting for teams Upgrade. + +### Example 3: Grant Policy to the entire tenant + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly -Global +``` + +To grant a policy to all users in the org (except any that have an explicit policy assigned), omit the identity parameter. If you do not specify the -Global parameter, you will be prompted to confirm the operation. + +### Example 4 Get a report on existing TeamsUpgradePolicy users (Screen Report) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +``` + +You can get the output on the screen, on CSV or Html format. For Screen Report. + +### Example 5 Get a report on existing TeamsUpgradePolicy users (CSV Report) + +```powershell +$objUsers = Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +$objusers | ConvertTo-Csv -NoTypeInformation | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.csv" +``` + +This will create a CSV file on the Desktop of the current user with the name "TeamsUpgrade.csv" + +### Example 6 Get a report on existing TeamsUpgradePolicy users (HTML Report) + +```powershell +$objUsers = Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +$objusers | ConvertTo-Html | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.html" +``` + +After running these lines will create an HTML file on the Desktop of the current user with the name "TeamUpgrade.html" + +### Example 7 Get a report on existing TeamsUpgradePolicy users (CSV Report - Oneliner version) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* | ConvertTo-Csv -NoTypeInformation | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.csv" +``` + +This will create a CSV file on the Desktop of the current user with the name "TeamsUpgrade.csv" + +### Example 8 Get a report on existing TeamsUpgradePolicy users (HTML Report - Oneliner Version) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* | ConvertTo-Html | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.html" +``` + +After running these lines will create an HTML file on the Desktop of the current user with the name "TeamUpgrade.html" + +## PARAMETERS + +### -Identity + +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PolicyName + +The name of the policy instance. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +Do not use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) + +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) + +[Coexistence with Skype for Business](https://learn.microsoft.com/microsoftteams/coexistence-chat-calls-presence) + +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) + +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) + +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..6d3a365fa0 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy +title: Grant-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsVdiPolicy + +## SYNOPSIS +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsVdiPolicy [<CommonParameters>] +``` + +### GrantToUser +```powershell +Grant-CsTeamsVdiPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> [<CommonParameters>] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## 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/teams/Grant-CsTeamsVideoInteropServicePolicy.md new file mode 100644 index 0000000000..a6a5f02703 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md @@ -0,0 +1,266 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsVideoInteropServicePolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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**: + +Q: After running `Grant-CsTeamsVideoInteropServicePolicy -PolicyName <Identity of the Policy>` to assign a policy to the whole tenant, the result of `Get-CsOnlineUser -Identity {User Identity} | Format-List TeamsVideoInteropServicePolicy` that checks if the User Policy is empty. + +A: Global/Tenant level Policy Assignment can be checked by running `Get-CsTeamsVideoInteropServicePolicy Global`. + +Q: I assigned CVI policy to a user, but I can't create a VTC meeting with that policy or I made changes to policy assignment, but it didn't reflect on new meetings I created. + +A: The policy is cached for 6 hours. Changes to the policy are updated after the cache expires. Check for your changes after 6 hours. + +**Frequently used commands that can help identify the policy assignment**: + +- Command to get full list of user along with their CVI policy: `Get-CsOnlineUser | Format-List UserPrincipalName,TeamsVideoInteropServicePolicy` + +- Command to get the policy assigned to the whole tenant: `Get-CsTeamsVideoInteropServicePolicy Global` + +## EXAMPLES + +### Example 1: The whole tenant has the same provider + +```powershell +Grant-CsTeamsVideoInteropServicePolicy -PolicyName <Identity of the Policy | $null> -Global +``` + +Specify the provider for the whole tenant or use the value $null to remove the tenant-level provider and let the whole tenant fall back to the Global policy. + +### Example 2: The tenant has two (or three) interop service providers + +```powershell +Grant-CsTeamsVideoInteropServicePolicy -PolicyName <Identity of the Policy | $null> -Identity <UserId> +``` + +Specify each user with the Identity parameter, and use Provider-1 or Provider-2 for the value of the PolicyName parameter. Use the value $null to remove the provider and let the user's provider fallback to Global policy. + +### Example 3: The tenant has a default interop service provider, but specific users (say IT folks) want to pilot another interop provider. + +```powershell +Grant-CsTeamsVideoInteropServicePolicy -PolicyName <Identity of the Policy | ServiceProviderDisabled> [-Identity <UserId>] +``` + +- To assign Provider-1 as the default interop service provider, don't use the Identity parameter and use the value Provider-1 for the PolicyName parameter. + +- For specific users to try Provider-2, specify each user with the Identity parameter, and use the value Provider-2 for the PolicyName parameter. + +- For specific users who need to disable CVI, specify each user with the Identity parameter and use the value ServiceProviderDisabled for the PolicyName parameter. + +### Example 4: Cloud Video Interop has been disabled for the entire tenant, except for those users that have an explicit policy assigned to them. + +```powershell +Grant-CsTeamsVideoInteropServicePolicy -PolicyName ServiceProviderDisabled +``` + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Internal Microsoft use only. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this flag to override the warning when assigning the global policy for your tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +{{Fill Identity Description}} + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsVideoInteropServicePolicy 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 +Specify the pre-constructed policy that you would like to assign to your tenant or a particular user. You can get the policies available for your organization using the cmdlet Get-CsTeamsVideoInteropServicePolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +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 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..1203279e74 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy +title: Grant-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +manager: sonaggarwal +author: emmanuelrocha001 +--- + +# Grant-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsVirtualAppointmentsPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsVirtualAppointmentsPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsVirtualAppointmentsPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsVirtualAppointmentsPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -PolicyName sms-enabled -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName sms-enabled +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Global -PolicyName sms-enabled +``` + +Assigns a given policy to the tenant. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Global -PolicyName sms-enabled +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + diff --git a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md new file mode 100644 index 0000000000..e97f8b3ab1 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md @@ -0,0 +1,196 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy +title: Grant-CsTeamsVoiceApplicationsPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsVoiceApplicationsPolicy + +## SYNOPSIS +Assigns a per-user Teams voice applications policy to one or more users. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsVoiceApplicationsPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsVoiceApplicationsPolicy [-PassThru] [[-PolicyName] <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsVoiceApplicationsPolicy [-PassThru] [[-PolicyName] <String>] + -Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + +## EXAMPLES + +### EXAMPLE 1 +``` +Grant-CsTeamsVoiceApplicationsPolicy -Identity "Ken Myer" -PolicyName "SDA-Allow-All" +``` +The command shown in Example 1 assigns the per-user Teams voice applications policy SDA-Allow-All to the user with the display name "Ken Myer". + +### EXAMPLE 2 +``` +Grant-CsTeamsVoiceApplicationsPolicy -PolicyName "SDA-Allow-All" -Global +``` +Example 2 assigns the per-user online voice routing policy "SDA-Allow-All to all the users in the tenant, except any that have an explicit policy assignment. + +## 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). + +```yaml +Type: String +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 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: + +Required: False +Position: Named +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). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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 +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) + +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) + +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) + +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..b6dcf697af --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,253 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy +title: Grant-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsWorkLoadPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] + [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] + [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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: <testuser@test.onmicrosoft.com> + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..35c5297361 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy +title: Grant-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# Grant-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsWorkLocationDetectionPolicy [<CommonParameters>] +``` + +### GrantToUser +``` +Grant-CsTeamsWorkLocationDetectionPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTeamsWorkLocationDetectionPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> + [<CommonParameters>] +``` + +### GrantToTenant +``` +Grant-CsTeamsWorkLocationDetectionPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -PolicyName sms-policy -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName wld-policy +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-policy +``` + +Assigns a given policy to the tenant. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-policy +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md b/teams/teams-ps/teams/Grant-CsTenantDialPlan.md new file mode 100644 index 0000000000..9f4245e9a8 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTenantDialPlan.md @@ -0,0 +1,185 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsTenantDialPlan + +## SYNOPSIS +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. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsTenantDialPlan [[-PolicyName] <string>] [-Global] [-PassThru] [<CommonParameters>] +``` + +### GrantToGroup +``` +Grant-CsTenantDialPlan [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [<CommonParameters>] +``` + +### Identity +``` +Grant-CsTenantDialPlan [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +The Grant-CsTenantDialPlan cmdlet assigns an existing tenant dial plan to a user, a group of users, or sets the Global policy instance. +Tenant dial plans provide information that is required for Enterprise Voice users to make telephone calls. +Users who do not have a valid tenant dial plan cannot make calls by using Enterprise Voice. +A tenant dial plan determines such things as how normalization rules are applied. + +You can check whether a user has been granted a per-user tenant dial plan by calling a command in this format: `Get-CsUserPolicyAssignment -Identity "<user name>" -PolicyType TenantDialPlan.` + +## EXAMPLES + +### Example 1 + +```powershell +Grant-CsTenantDialPlan -PolicyName Vt1tenantDialPlan9 -Identity Ken.Myer@contoso.com +``` + +This example grants the Vt1tenantDialPlan9 dial plan to Ken.Meyer@contoso.com. + +### Example 2 +```powershell +Grant-CsTenantDialPlan -Identity Ken.Myer@contoso.com -PolicyName $Null +``` + +In Example 2, any dial plan previously assigned to the user Ken Myer is unassigned from that user; as a result, Ken Myer will be managed by the global dial plan. +To unassign a custom tenant dial plan, set the PolicyName to a null value ($Null). + +### Example 3 + +```powershell +Grant-CsTenantDialPlan -Group sales@contoso.com -Rank 10 -PolicyName Vt1tenantDialPlan9 +``` + +This example grants the Vt1tenantDialPlan9 dial plan to members of the group sales@contoso.com. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: SwitchParameter +Parameter Sets: (GrantToTenant) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```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 +``` + +### -PolicyName +The PolicyName parameter is the name of the tenant dial plan to be assigned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: (GrantToGroup) +Aliases: +Applicable: Microsoft Teams + +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: +Applicable: Microsoft Teams + +Required: False +Position: Named +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. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. + +## RELATED LINKS + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md b/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md new file mode 100644 index 0000000000..6d4fc120b3 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Grant-CsUserPolicyPackage +author: serdarsoysal +ms.author: serdars +manager: amitar +online version: https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage +schema: 2.0.0 +--- + +# Grant-CsUserPolicyPackage + +## SYNOPSIS + +This cmdlet supports applying a policy package to users in a tenant. Note that there is a limit of 20 users you can apply the package to at a time. To apply a policy package to a larger number of users, consider using New-CsBatchPolicyPackageAssignmentOperation. + +## SYNTAX + +``` +Grant-CsUserPolicyPackage [-Identity] <String[]> [-PackageName] <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet supports applying a policy package to users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsUserPolicyPackage -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,johndoe@example.com -PackageName Education_PrimaryStudent +``` + +Applies the Education_PrimaryStudent policy package to two users in the tenant. + +## PARAMETERS + +### -Identity + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageName + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) + +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) + +[New-CsBatchPolicyPackageAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation) diff --git a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md b/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md new file mode 100644 index 0000000000..aee3150e6e --- /dev/null +++ b/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md @@ -0,0 +1,130 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Import-CsAutoAttendantHolidays + +## SYNOPSIS +Use Import-CsAutoAttendantHolidays cmdlet to import holiday schedules of an existing Auto Attendant (AA) that were previously exported using the Export-CsAutoAttendantHolidays cmdlet. + +## SYNTAX + +``` +Import-CsAutoAttendantHolidays -Identity <String> -Input <byte[]> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Export-CsAutoAttendantHolidays cmdlet and the Import-CsAutoAttendantHolidays cmdlet enable you to export holiday schedules in your auto attendant and then later import that information. This can be extremely useful in a situation where you need to configure same holiday sets in multiple auto attendants. + +The Export-CsAutoAttendantHolidays cmdlet returns the holiday schedule information in serialized form (as a byte array). The caller can then write the bytes to the disk to obtain a CSV file. Similarly, the Import-CsAutoAttendantHolidays cmdlet accepts the holiday schedule information as a byte array, which can be read from the aforementioned CSV file. The first line of the CSV file is considered a header record and is always ignored. + +**NOTES**: + +Each line in the CSV file used by Export-CsAutoAttendantHolidays and Import-CsAutoAttendantHolidays cmdlet should be of the following format: + + `HolidayName,StartDateTime1,EndDateTime1,StartDateTime2,EndDateTime2,...,StartDateTime10,EndDateTime10` + +where + +- HolidayName is the name of the holiday to be imported. +- StartDateTimeX and EndDateTimeX specify a date/time range for the holiday and are optional. If no date-time ranges are defined, then the holiday is imported without any date/time ranges. They follow the same format as New-CsOnlineDateTimeRange cmdlet. +- EndDateTimeX is optional. If it is not specified, the end bound of the date time range is set to 00:00 of the day after the start date. + +- The first line of the CSV file is considered a header record and is always ignored by Import-CsAutoAttendantHolidays cmdlet. +- If the destination auto attendant for the import already contains a call flow or schedule by the same name as one of the holidays being imported, the corresponding CSV record is skipped. +- For holidays that are successfully imported, a default call flow is created which is configured without any greeting and simply disconnects the call on being executed. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") +Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes +``` + +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 -------------------------- +``` +$bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") +Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes | Format-Table -Wrap -AutoSize +``` + +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. The result of the import process is formatted as a table. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Input +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Import-CsAutoAttendantHolidays cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.HolidayImportResult + +## NOTES + +## RELATED LINKS + +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) + +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md b/teams/teams-ps/teams/Import-CsOnlineAudioFile.md new file mode 100644 index 0000000000..08de362834 --- /dev/null +++ b/teams/teams-ps/teams/Import-CsOnlineAudioFile.md @@ -0,0 +1,133 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Import-CsOnlineAudioFile + +## SYNOPSIS +Use the Import-CsOnlineAudioFile cmdlet to upload a new audio file. + +## SYNTAX + +```powershell +Import-CsOnlineAudioFile -ApplicationId <String> -FileName <string> -Content <Byte[]> [<CommonParameters>] +``` + +## DESCRIPTION +The Import-CsOnlineAudioFile cmdlet uploads a new audio file for use with the Auto Attendant (AA), Call Queue (CQ) service or Music on Hold for Microsoft Teams. + +## EXAMPLES + +### Example 1 +```powershell +$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). + +### Example 2 +```powershell +$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. + +### Example 3 +```powershell +$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. + +## PARAMETERS + +### -ApplicationId +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: + +- OrgAutoAttendant +- HuntGroup +- TenantGlobal + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.AudioFile + +## NOTES + +When you import an audio file to be used for Auto Attendant or Call Queue, the audio file will automatically be marked for deletion (as seen by running +Get-CsOnlineAudioFile) and it will be deleted after 48 to 72 hours from the time of import, unless the audio file is associated to an +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) + +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) + +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..1f6d71a39b --- /dev/null +++ b/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md @@ -0,0 +1,114 @@ +--- +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 +ms.author: frpeng +ms.reviewer: +--- + +# New-CsApplicationAccessPolicy + +## SYNOPSIS + +Creates a new application access policy. Application access policy contains a list of application (client) IDs. When granted to a user, those applications will be authorized to access online meetings on behalf of that user. + +## SYNTAX + +### Identity + +``` +New-CsApplicationAccessPolicy [-Identity <XdsIdentity>] [-AppIds <PSListModifier>] [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet creates a new application access policy. Application access policy contains a list of application (client) IDs. When granted to a user, those applications will be authorized to access online meetings on behalf of that user. + +## EXAMPLES + +### Create a new application access policy with one app ID + +``` +PS C:\> New-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds "d39597bf-8407-40ca-92ef-1ec26b885b7b" -Description "Some description" +``` + +The command shown above shows how to create a new policy with one app IDs configured. + +### Create a new application access policy with multiple app IDs + +``` +PS C:\> New-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds "d39597bf-8407-40ca-92ef-1ec26b885b71", "57caaef9-5ed0-48d5-8862-e5abfa71b3e1", "dc17674c-81d9-4adb-bfb2-8f6a442e4620" -Description "Some description" +``` + +The command shown above shows how to create a new policy with a list of (three) app IDs configured. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppIds + +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Specifies the description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## 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) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md new file mode 100644 index 0000000000..98e32e7234 --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -0,0 +1,577 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendant + +## SYNOPSIS +Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA). + +## SYNTAX + +```powershell +New-CsAutoAttendant -Name <String> -LanguageId <String> -TimeZoneId <String> -DefaultCallFlow <Object> [-CallFlows <Object>] [-CallHandlingAssociations <Object>] [-Operator <Object>] [-VoiceId <String>] [-EnableVoiceResponse] [-InclusionScope <Object>] [-ExclusionScope <Object>] [-AuthorizedUsers <List>] [-HideAuthorizedUsers <List>] [-UserNameExtension <String>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +Auto Attendants (AAs) are a key element in the Office 365 Phone System. +Each AA can be associated with phone numbers that allow callers to reach specific people in the organization through a directory lookup. Alternatively, it can route the calls to an operator, a user, another AA, or a call queue. + +You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly created AA gets assigned a random string that serves as the identity of the AA. + +> [!CAUTION] +> The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items: +> +> - -HideAuthorizedUsers +> - -UserNameExtension + +**NOTES**: + +- To setup your AA for calling, you need to create an application instance first using `New-CsOnlineApplicationInstance` cmdlet , then associate it with your AA configuration using `New-CsOnlineApplicationInstanceAssociation` cmdlet. +- The default call flow has the lowest precedence, and any custom call flow has a higher precedence and is executed if the schedule associated with it is in effect. +- Holiday call flows have higher priority than after-hours call flows. Thus, if a holiday schedule and an after-hours schedule are both in effect at a particular time, the call flow corresponding to the holiday call flow will be rendered. +- The default call flow can be used either as the 24/7 call flow if no other call flows are specified, or as the business hours call flow if an "after hours" call flow was specified together with the corresponding schedule and call handling association. +- If a user is present in both inclusion and exclusion scopes, then exclusion scope always takes priority, i.e., the user will not be able to be contacted through directory lookup feature. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity +$operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User + +$greetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" +$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 or press 0 to reach the operator." +$defaultMenu = New-CsAutoAttendantMenu -Name "Default menu" -Prompts @($menuPrompt) -MenuOptions @($menuOptionZero) -EnableDialByName +$defaultCallFlow = New-CsAutoAttendantCallFlow -Name "Default call flow" -Greetings @($greetingPrompt) -Menu $defaultMenu + +$afterHoursGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso! Unfortunately, you have reached us outside of our business hours. We value your call please call us back Monday to Friday, between 9 A.M. to 12 P.M. and 1 P.M. to 5 P.M. Goodbye!" +$automaticMenuOption = New-CsAutoAttendantMenuOption -Action Disconnect -DtmfResponse Automatic +$afterHoursMenu=New-CsAutoAttendantMenu -Name "After Hours menu" -MenuOptions @($automaticMenuOption) +$afterHoursCallFlow = New-CsAutoAttendantCallFlow -Name "After Hours call flow" -Greetings @($afterHoursGreetingPrompt) -Menu $afterHoursMenu + +$timerange1 = New-CsOnlineTimeRange -Start 09:00 -end 12:00 +$timerange2 = New-CsOnlineTimeRange -Start 13:00 -end 17:00 +$afterHoursSchedule = New-CsOnlineSchedule -Name "After Hours Schedule" -WeeklyRecurrentSchedule -MondayHours @($timerange1, $timerange2) -TuesdayHours @($timerange1, $timerange2) -WednesdayHours @($timerange1, $timerange2) -ThursdayHours @($timerange1, $timerange2) -FridayHours @($timerange1, $timerange2) -Complement + +$afterHoursCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $afterHoursSchedule.Id -CallFlowId $afterHoursCallFlow.Id + +$inclusionScopeGroupIds = @("4c3053a6-20bf-43df-bf7a-156124168856") +$inclusionScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $inclusionScopeGroupIds + +$aa = New-CsAutoAttendant -Name "Main auto attendant" -DefaultCallFlow $defaultCallFlow -EnableVoiceResponse -CallFlows @($afterHoursCallFlow) -CallHandlingAssociations @($afterHoursCallHandlingAssociation) -LanguageId "en-US" -TimeZoneId "UTC" -Operator $operatorEntity -InclusionScope $inclusionScope +``` + +This example creates a new AA named _Main auto attendant_ that has the following properties: + +- It sets a default call flow. +- It sets an after-hours call flow. +- It enables voice response. +- The default language is en-US. +- The time zone is set to UTC. +- An inclusion scope is specified. + +### -------------------------- Example 2 -------------------------- +```powershell +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity +$operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User + +$dcfGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" +$dcfMenuOptionZero = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 +$dcfMenuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign or press 0 to reach the operator." +$dcfMenu=New-CsAutoAttendantMenu -Name "Default menu" -Prompts @($dcfMenuPrompt) -MenuOptions @($dcfMenuOptionZero) -EnableDialByName +$defaultCallFlow = New-CsAutoAttendantCallFlow -Name "Default call flow" -Greetings @($dcfGreetingPrompt) -Menu $dcfMenu + +$afterHoursGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso! Unfortunately, you have reached us outside of our business hours. We value your call please call us back Monday to Friday, between 9 A.M. to 12 P.M. and 1 P.M. to 5 P.M. Goodbye!" +$afterHoursMenuOption = New-CsAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic +$afterHoursMenu=New-CsAutoAttendantMenu -Name "After Hours menu" -MenuOptions @($afterHoursMenuOption) +$afterHoursCallFlow = New-CsAutoAttendantCallFlow -Name "After Hours call flow" -Greetings @($afterHoursGreetingPrompt) -Menu $afterHoursMenu + +$timerange1 = New-CsOnlineTimeRange -Start 09:00 -end 12:00 +$timerange2 = New-CsOnlineTimeRange -Start 13:00 -end 17:00 +$afterHoursSchedule = New-CsOnlineSchedule -Name "After Hours Schedule" -WeeklyRecurrentSchedule -MondayHours @($timerange1, $timerange2) -TuesdayHours @($timerange1, $timerange2) -WednesdayHours @($timerange1, $timerange2) -ThursdayHours @($timerange1, $timerange2) -FridayHours @($timerange1, $timerange2) -Complement + +$afterHoursCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $afterHoursSchedule.Id -CallFlowId $afterHoursCallFlow.Id + +$christmasGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." +$christmasMenuOption = New-CsAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic +$christmasMenu = New-CsAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($christmasMenuOption) +$christmasCallFlow = New-CsAutoAttendantCallFlow -Name "Christmas" -Greetings @($christmasGreetingPrompt) -Menu $christmasMenu + +$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" +$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) + +$christmasCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $christmasSchedule.Id -CallFlowId $christmasCallFlow.Id + +$aa = New-CsAutoAttendant -Name "Main auto attendant" -DefaultCallFlow $defaultCallFlow -EnableVoiceResponse -CallFlows @($afterHoursCallFlow, $christmasCallFlow) -CallHandlingAssociations @($afterHoursCallHandlingAssociation, $christmasCallHandlingAssociation) -LanguageId "en-US" -TimeZoneId "UTC" -Operator $operatorEntity +``` + +This example creates a new AA named _Main auto attendant_ that has the following properties: + +- It sets a default call flow. +- It sets an after-hours call flow. +- It sets a call flow for Christmas holiday. +- It enables voice response. +- The default language is en-US. +- The time zone is set to UTC. + +### -------------------------- Example 3 -------------------------- +```powershell +# Create Christmas Schedule +$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" +$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) + +# Create First Auto Attendant +$dcfGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso Customer Support!" +$dcfMenuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." +$dcfMenu = New-CsAutoAttendantMenu -Name "Default menu" -Prompts @($dcfMenuPrompt) -EnableDialByName -DirectorySearchMethod ByName +$defaultCallFlow = New-CsAutoAttendantCallFlow -Name "Default call flow" -Greetings @($dcfGreetingPrompt) -Menu $dcfMenu + +$christmasGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." +$christmasMenuOption = New-CsAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic +$christmasMenu = New-CsAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($christmasMenuOption) +$christmasCallFlow = New-CsAutoAttendantCallFlow -Name "Christmas" -Greetings @($christmasGreetingPrompt) -Menu $christmasMenu + +$christmasCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $christmasSchedule.Id -CallFlowId $christmasCallFlow.Id + +New-CsAutoAttendant -Name "Customer Support Auto Attendant" -DefaultCallFlow $defaultCallFlow -EnableVoiceResponse -CallFlows @($afterHoursCallFlow, $christmasCallFlow) -CallHandlingAssociations @($afterHoursCallHandlingAssociation, $christmasCallHandlingAssociation) -LanguageId "en-US" -TimeZoneId "UTC" + +# Id : a65b3434-05a1-48ed-883d-e3ca35a60af8 +# TenantId : f6b89083-a2f8-55cc-9f62-33b73af44164 +# Name : Customer Support Auto Attendant +# LanguageId : en-US +# VoiceId : Female +# DefaultCallFlow : Default call flow +# Operator : +# TimeZoneId : UTC +# VoiceResponseEnabled : True +# CallFlows : Christmas +# Schedules : Christmas +# CallHandlingAssociations : Holiday(1) +# Status : Successful +# DialByNameResourceId : caddaea5-c001-5a09-b997-9d3a33e834f2 +# DirectoryLookupScope : +# ApplicationInstances : + +# Create Second Auto Attendant +$dcfGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso Store!" +$dcfMenuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." +$dcfMenu = New-CsAutoAttendantMenu -Name "Default menu" -Prompts @($dcfMenuPrompt) -EnableDialByName -DirectorySearchMethod ByName +$defaultCallFlow = New-CsAutoAttendantCallFlow -Name "Default call flow" -Greetings @($dcfGreetingPrompt) -Menu $dcfMenu + +$christmasGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." +$christmasMenuOption = New-CsAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic +$christmasMenu = New-CsAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($christmasMenuOption) +$christmasCallFlow = New-CsAutoAttendantCallFlow -Name "Christmas" -Greetings @($christmasGreetingPrompt) -Menu $christmasMenu + +$christmasCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $christmasSchedule.Id -CallFlowId $christmasCallFlow.Id + +New-CsAutoAttendant -Name "Main auto attendant" -DefaultCallFlow $defaultCallFlow -EnableVoiceResponse -CallFlows @($afterHoursCallFlow, $christmasCallFlow) -CallHandlingAssociations @($afterHoursCallHandlingAssociation, $christmasCallHandlingAssociation) -LanguageId "en-US" -TimeZoneId "UTC" + +# Id : 236450c4-9f1e-4c19-80eb-d68819d36a15 +# TenantId : f6b89083-a2f8-55cc-9f62-33b73af44164 +# Name : Main auto attendant +# LanguageId : en-US +# VoiceId : Female +# DefaultCallFlow : Default call flow +# Operator : +# TimeZoneId : UTC +# VoiceResponseEnabled : True +# CallFlows : Christmas +# Schedules : Christmas +# CallHandlingAssociations : Holiday(1) +# Status : Successful +# DialByNameResourceId : 5abfa626-8f80-54ff-97eb-03c2aadcc329 +# DirectoryLookupScope : +# ApplicationInstances : + +# Show the auto attendants associated with this holiday schedule: +Get-CsOnlineSchedule $christmasSchedule.Id + +# Id : 578745b2-1f94-4a38-844c-6bf6996463ee +# Name : Christmas +# Type : Fixed +# WeeklyRecurrentSchedule : +# FixedSchedule : 24/12/2017 00:00 - 26/12/2017 00:00 +# AssociatedConfigurationIds : a65b3434-05a1-48ed-883d-e3ca35a60af8, 236450c4-9f1e-4c19-80eb-d68819d36a15 +``` + +This example creates two new AAs named _Main auto attendant_ and _Customer Support Auto Attendant_. Both AAs share the same Christmas holiday schedule. This was done by reusing the Schedule ID of the _Christmas_ holiday when creating the call handling associations for those two AAs using New-CsAutoAttendantCallHandlingAssociation cmdlet. + +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. + +### -------------------------- Example 4 -------------------------- +```powershell +$aaName = "Main Auto Attendant" +$language = "en-US" +$greetingText = "Welcome to Contoso" +$mainMenuText = "To reach your party by name, say it now. To talk to Sales, please press 1. To talk to User2 press 2. Please press 0 for operator" +$afterHoursText = "Sorry Contoso is closed. Please call back during week days from 7AM to 8PM. Goodbye!" +$tz = "Romance Standard Time" +$operatorId = (Get-CsOnlineUser -Identity "sip:user1@contoso.com").Identity +$user1Id = (Get-CsOnlineUser -Identity "sip:user2@contoso.com").Identity +$salesCQappinstance = (Get-CsOnlineUser -Identity "sales@contoso.com").Identity # one of the application instances associated to the Call Queue +$tr1 = New-CsOnlineTimeRange -Start 07:00 -End 20:00 + +# After hours +$afterHoursSchedule = New-CsOnlineSchedule -Name "After Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1) -TuesdayHours @($tr1) -WednesdayHours @($tr1) -ThursdayHours @($tr1) -FridayHours @($tr1) -Complement +$afterHoursGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt $afterHoursText +$afterHoursMenuOption = New-CsAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic +$afterHoursMenu = New-CsAutoAttendantMenu -Name "AA menu1" -MenuOptions @($afterHoursMenuOption) +$afterHoursCallFlow = New-CsAutoAttendantCallFlow -Name "After Hours" -Menu $afterHoursMenu -Greetings @($afterHoursGreetingPrompt) +$afterHoursCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $afterHoursSchedule.Id -CallFlowId $afterHoursCallFlow.Id + +# Business hours menu options +$operator = New-CsAutoAttendantCallableEntity -Identity $operatorId -Type User +$sales = New-CsAutoAttendantCallableEntity -Identity $salesCQappinstance -Type applicationendpoint +$user1 = New-CsAutoAttendantCallableEntity -Identity $user1Id -Type User +$menuOption0 = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 -CallTarget $operator +$menuOption1 = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfResponse Tone1 -CallTarget $sales +$menuOption2 = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfResponse Tone2 -CallTarget $user1 + +# Business hours menu +$greetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt $greetingText +$menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt $mainMenuText +$menu = New-CsAutoAttendantMenu -Name "AA menu2" -Prompts @($menuPrompt) -EnableDialByName -MenuOptions @($menuOption0,$menuOption1,$menuOption2) +$callFlow = New-CsAutoAttendantCallFlow -Name "Default" -Menu $menu -Greetings $greetingPrompt + +# Auto attendant +New-CsAutoAttendant -Name $aaName -LanguageId $language -CallFlows @($afterHoursCallFlow) -TimeZoneId $tz -Operator $operator -DefaultCallFlow $callFlow -CallHandlingAssociations @($afterHoursCallHandlingAssociation) -EnableVoiceResponse +``` + +This example creates a new AA named _Main auto attendant_ that has the following properties: + +- It sets a default call flow. +- It sets an after-hours call flow. +- It sets a business hours options. +- It references a call queue as a menu option. +- The default language is en-US. +- The time zone is set to Romance Standard. +- It sets user1 as operator. +- It has user2 also as a menu option. +- The Auto Attendant is voice enabled. + +## PARAMETERS + +### -Name +The Name parameter is a friendly name that is assigned to the AA. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageId +The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. + +You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZoneId +The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. + +You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultCallFlow +The DefaultCallFlow parameter is the flow to be executed when no other call flow is in effect (for example, during business hours). + +You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +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. + +You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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. + +You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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. + +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 +Default value: None +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. + +You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. You can determine the default voice for a language by issuing the following command: + +``` +$language = Get-CsAutoAttendantSupportedLanguage -Identity "en-US" +$defaultVoice = $language.Voices[0].Id +``` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVoiceResponse +The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. + +```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 +``` + +### -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. + +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +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. + +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers +_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ + +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserNameExtension +_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ + +The UserNameExtension parameter is a string that specifies how to extend usernames in dial search by appending additional information after the name. +This parameter is used in dial search when multiple search results are found, as it helps to distinguish users with similar names. Possible values are: + +- None: Default value, which means the username is pronounced as is. +- Office: Adds office information from the user profile. +- Department: Adds department information from the user profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: false +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) + +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) + +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) + +[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) + +[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) + +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) + +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) + +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) + +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) + +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) + +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) + +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md new file mode 100644 index 0000000000..e5d964c2c4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md @@ -0,0 +1,151 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantCallFlow + +## SYNOPSIS +Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. + +## SYNTAX + +```powershell +New-CsAutoAttendantCallFlow -Name <String> -Menu <Object> [-Greetings <List>] [-Tenant <Guid>] [-ForceListenMenuEnabled] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsAutoAttendantCallFlow cmdlet creates a new call flow for use with the Auto Attendant (AA) service. The AA service uses the call flow to handle inbound calls by playing a greeting (if present), and provide callers with actions through a menu. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```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 +$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu +``` + +This example creates a new call flow that renders the "Default Menu" menu. + +### -------------------------- 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 +$greeting = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" +$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting -ForceListenMenuEnabled +``` + +This example creates a new call flow that plays a greeting before rendering the "Default Menu" menu with Force listen menu enabled. + +## PARAMETERS + +### -Name +The Name parameter represents a unique friendly name for the call flow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Menu +The Menu parameter identifies the menu to render when the call flow is executed. + +You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) cmdlet. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +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. + +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceListenMenuEnabled + +If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.CallFlow + +## NOTES + +## RELATED LINKS + +[New-CsAutoAttendantMenu](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) + +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md b/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md new file mode 100644 index 0000000000..0dd8a74ae2 --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md @@ -0,0 +1,206 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantCallHandlingAssociation + +## SYNOPSIS +Use the `New-CsAutoAttendantCallHandlingAssociation` cmdlet to create a new call handling association. + +## SYNTAX + +```powershell +New-CsAutoAttendantCallHandlingAssociation -CallFlowId <String> -ScheduleId <String> -Type <AfterHours | Holiday> [-Disable] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The `New-CsAutoAttendantCallHandlingAssociation` cmdlet creates a new call handling association to be used with the Auto Attendant (AA) service. The OAA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. + +## EXAMPLES + +### -------------------------- 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 +$scheduleId = $schedule.Id + +$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 +$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu +$callFlowId = $callFlow.Id + +$callHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $scheduleId -CallFlowId $callFlowId +``` + +This example creates the following: + +- a new after-hours schedule +- a new after-hours call flow +- a new after-hours call handling association + +### -------------------------- 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 +$scheduleId = $schedule.Id + +$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 +$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu +$callFlowId = $callFlow.Id + +$disabledCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type AfterHours -ScheduleId $scheduleId -CallFlowId $callFlowId -Disable +``` + +This example creates the following: + +- a new after-hours schedule +- a new after-hours call flow +- a disabled after-hours call handling association + +### -------------------------- Example 3 -------------------------- +```powershell +$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" +$schedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) +$scheduleId = $schedule.Id + +$menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "We are closed for Christmas. Please call back later." +$menuOption = New-CsAutoAttendantMenuOption -DtmfResponse Automatic -Action DisconnectCall +$menu = New-CsAutoAttendantMenu -Name "Christmas Menu" -Prompts @($menuPrompt) -MenuOptions @($menuOption) +$callFlow = New-CsAutoAttendantCallFlow -Name "Christmas" -Greetings @($greeting) -Menu $menu +$callFlowId = $callFlow.Id + +$callHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $scheduleId -CallFlowId $callFlowId +``` + +This example creates the following: + +- a new holiday schedule +- a new holiday call flow +- a new holiday call handling association + +## PARAMETERS + +### -CallFlowId +The CallFlowId parameter represents the call flow to be associated with the schedule. + +You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleId +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/teams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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: + +- `AfterHours` +- `Holiday` + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +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. + +```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 +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.CallHandlingAssociation + +## NOTES + +## RELATED LINKS + +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) + +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) + +[Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md b/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md new file mode 100644 index 0000000000..b496fcaaad --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md @@ -0,0 +1,214 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantCallableEntity + +## SYNOPSIS +The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity. + +## SYNTAX + +```powershell +New-CsAutoAttendantCallableEntity -Identity <String> -Type <User | ApplicationEndpoint | ConfigurationEndpoint | ExternalPstn | SharedVoicemail> [-Tenant <Guid>] [-EnableTranscription] [-EnableSharedVoicemailSystemPromptSuppression] [-CallPriority <Int16>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity for use with call transfers from the Auto Attendant service. Callable entities can be created using either Object ID or TEL URIs and can refer to any of the following entities: + +- User +- ApplicationEndpoint +- ConfigurationEndpoint +- ExternalPstn +- SharedVoicemail + +**NOTE**: In order to setup a shared voicemail, an Office 365 Group that can receive external emails is required. + +## EXAMPLES + +### Example 1 +```powershell +$callableEntity = New-CsAutoAttendantCallableEntity -Identity "9bad1a25-3203-5207-b34d-1bd933b867a5" -Type User +``` + +This example creates a user callable entity. + +### Example 2 +```powershell +$callableEntity = New-CsAutoAttendantCallableEntity -Identity "tel:+1234567890" -Type ExternalPSTN +``` + +This example creates an ExternalPSTN callable entity. + +### Example 3 +```powershell +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId +$callableEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User +``` + +This example gets a user object using Get-CsOnlineUser cmdlet. We then use the Microsoft Entra ObjectId of that user object to create a user callable entity. + +### Example 4 +```powershell +$callableEntityId = Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Attendant" -MaxResults 1 | Select-Object -Property Id +$callableEntity = New-CsAutoAttendantCallableEntity -Identity $callableEntityId.Id -Type ApplicationEndpoint +``` + +This example gets an application instance by name using Find-CsOnlineApplicationInstance cmdlet. We then use the Microsoft Entra ObjectId of that application instance to create an application endpoint callable entity. + +### Example 5 +```powershell +$callableEntityGroup = Find-CsGroup -SearchQuery "Main Auto Attendant" -ExactMatchOnly $true -MailEnabledOnly $true +$callableEntity = New-CsAutoAttendantCallableEntity -Identity $callableEntityGroup -Type SharedVoicemail -EnableTranscription +``` + +This example gets an Office 365 group by name using Find-CsGroup cmdlet. Then the Guid of that group is used to create a shared voicemail callable entity that supports transcription. + +## PARAMETERS + +### -Identity +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: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +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: + +- 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: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### -EnableTranscription +Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. + +```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 +``` + +### -EnableSharedVoicemailSystemPromptSuppression +Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. + +```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 +``` + +### -CallPriority +_Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint` or `ConfigurationEndpoint`. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.CallableEntity + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md b/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md new file mode 100644 index 0000000000..acea07c42e --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md @@ -0,0 +1,113 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantDialScope + +## SYNOPSIS +Use New-CsAutoAttendantDialScope cmdlet to create dial-scopes for use with Auto Attendant (AA) service. + +## SYNTAX + +``` +New-CsAutoAttendantDialScope -GroupScope -GroupIds <List> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new dial-scope to be used with Auto Attendant (AA) service. AAs use dial-scopes to restrict the scope of call transfers that can be made through directory lookup feature. + +**NOTE**: The returned dial-scope model composes a member for the underlying type/implementation, e.g. in case of the group-based dial scope, in order to modify its Group IDs, you can access them through `DialScope.GroupScope.GroupIds`. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$groupIds = @("00000000-0000-0000-0000-000000000000") +$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 -------------------------- +``` +$groupIds = Find-CsGroup -SearchQuery "Contoso Sales" | % { $_.Id } +$dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds +``` + +In Example 2, we use the Find-CsGroup cmdlet to find groups with name "Contoso Sales", and then use the identities of those groups to create an auto attendant dial scope using the New-CsAutoAttendantDialScope cmdlet. + +## PARAMETERS + +### -GroupScope +Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupIds +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: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.DialScope + +## NOTES + +## RELATED LINKS + +[Find-CsGroup](https://learn.microsoft.com/powershell/module/teams/find-csgroup) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md b/teams/teams-ps/teams/New-CsAutoAttendantMenu.md new file mode 100644 index 0000000000..762182a023 --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenu.md @@ -0,0 +1,169 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantMenu + +## SYNOPSIS +The New-CsAutoAttendantMenu cmdlet creates a new menu. + +## SYNTAX + +``` +New-CsAutoAttendantMenu -Name <String> [-MenuOptions <List>] [-Prompts <List>] [-EnableDialByName] [-Tenant <Guid>] [-DirectorySearchMethod] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA) service. The OAA service uses menus to provide callers with choices, and then takes action based on the selection. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$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 +``` + +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 -------------------------- +``` +$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." +$menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -MenuOptions @($menuOptionZero) -EnableDialByName -DirectorySearchMethod ByName +``` + +This example creates a new menu that allows the caller to reach a target by name or the operator by pressing the 0 key, and also defines the Directory Search Method to Dial By Name. + +## PARAMETERS + +### -Name +The Name parameter represents a friendly name for the menu. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prompts +The Prompts parameter reflects the prompts to play when the menu is activated. + +You can create new prompts by using the New-CsAutoAttendantPrompt cmdlet. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```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 +``` + +### -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) + +Possible values are + +- None +- ByName +- ByExtension + +```yaml +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.Menu + +## NOTES + +## RELATED LINKS + +[New-CsAutoAttendantMenuOption](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md new file mode 100644 index 0000000000..075d0dccbd --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md @@ -0,0 +1,185 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantMenuOption + +## SYNOPSIS +Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option. + +## SYNTAX + +``` +New-CsAutoAttendantMenuOption -Action <DisconnectCall | TransferCallToOperator | TransferCallToTarget> -DtmfResponse <Tone0 | Tone1 | Tone2 | Tone3 | Tone4 | Tone5 | Tone6 | Tone7 | Tone8 | Tone9 | Automatic> [-VoiceResponses <List>] [-CallTarget <Object>] [-Prompt <Object>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +$troubleShootObjectId = (Get-CsOnlineUser troubleShoot@contoso.com).ObjectId +$troubleShootEntity = New-CsAutoAttendantCallableEntity -Identity $troubleShootObjectId -Type ApplicationEndpoint +$menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfResponse Tone1 -VoiceResponses "Sales" -CallTarget $troubleShootEntity +``` + +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 -------------------------- +``` +$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 +``` + +This example creates a menu option to play an announcement for the defined prompt. After playing the announcement, the **Menu Prompt** is repeated. + +## PARAMETERS + +### -Action +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 +- DisconnectCall - The call is disconnected. +- TransferCallToOperator - the call is transferred to the operator. +- TransferCallToTarget - The call is transferred to the menu option's call target. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +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: + +- 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: True +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. + +Voice responses are currently limited to one voice response per menu option. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallTarget +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: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prompt +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. + +This parameter is required if the **Action** is set to **Announcement**. + +```yaml +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.MenuOption + +## NOTES + +## RELATED LINKS + +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md b/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md new file mode 100644 index 0000000000..9a601bd5d8 --- /dev/null +++ b/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md @@ -0,0 +1,153 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsAutoAttendantPrompt + +## SYNOPSIS +Use the New-CsAutoAttendantPrompt cmdlet to create a new prompt. + +## SYNTAX + +### AudioFile +```powershell +New-CsAutoAttendantPrompt -AudioFilePrompt <Object> [-Tenant <Guid>] [<CommonParameters>] +``` + +### TextToSpeech +```powershell +New-CsAutoAttendantPrompt -TextToSpeechPrompt <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +### Dual +```powershell +New-CsAutoAttendantPrompt -ActiveType <None | TextToSpeech | AudioFile> -AudioFilePrompt <Object> -TextToSpeechPrompt <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant (AA) service. A prompt is either an audio file that is played, or text that is read aloud to give callers additional information. A prompt can be disabled by setting the ActiveType to None. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +$ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" +``` + +This example creates a new prompt that reads the supplied text. + +### -------------------------- Example 2 -------------------------- +```powershell +$content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') +$audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content +$audioFilePrompt = New-CsAutoAttendantPrompt -AudioFilePrompt $audioFile +``` + +This example creates a new prompt that plays the selected audio file. + +### -------------------------- Example 3 -------------------------- +```powershell +$content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') +$audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content +$dualPrompt = New-CsAutoAttendantPrompt -ActiveType AudioFile -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to Contoso!" +``` + +This example creates a new prompt that has both audio file and text-to-speech data, but will play the audio file when the prompt is activated (rendered). + +## PARAMETERS + +### -ActiveType +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). + +This is explicitly required if both Audio File and TTS prompts are specified. Otherwise, it is inferred. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioFilePrompt +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. + +```yaml +Type: Object +Parameter Sets: AudioFile, Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +This parameter is required when text to speech prompts are being created. + +```yaml +Type: System.String +Parameter Sets: TextToSpeech, Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt + +## NOTES + +## RELATED LINKS + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md new file mode 100644 index 0000000000..e710dfbc0a --- /dev/null +++ b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation +title: New-CsBatchPolicyAssignmentOperation +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsBatchPolicyAssignmentOperation + +## SYNOPSIS + +This cmdlet is used to assign or unassign a policy to a batch of users. + +## SYNTAX + +``` +New-CsBatchPolicyAssignmentOperation [-OperationName <String>] -Identity <String[]> -PolicyType <String> + [-AdditionalParameters <Hashtable>] [-PolicyName <String>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +When a policy is assigned to a batch of users, the assignments are performed as an asynchronous operation. The cmdlet returns the operation ID which can be used to track the progress and status of the assignments. + +Users can be specified by their object ID (guid) or by their SIP address (user@contoso.com). Note that a user's SIP address often has the same value as the User Principal Name (UPN), but this is not required. If a user is specified using their UPN, but it has a different value than their SIP address, then the policy assignment will fail for the user. + +A batch may contain up to 5,000 users. If a batch includes duplicate users, the duplicates will be removed from the batch before processing and status will only be provided for the unique users remaining in the batch. For best results, do not submit more than a few batches at a time. Allow batches to complete processing before submitting more batches. + +You must be a Teams service admin or a Teams communication admin to run the cmdlet. + +Batch policy assignment is currently limited to the following policy types: +CallingLineIdentity, ExternalAccessPolicy, OnlineVoiceRoutingPolicy, TeamsAppSetupPolicy, TeamsAppPermissionPolicy, TeamsCallingPolicy, TeamsCallParkPolicy, TeamsChannelsPolicy, TeamsEducationAssignmentsAppPolicy, TeamsEmergencyCallingPolicy, TeamsMeetingBroadcastPolicy, TeamsEmergencyCallRoutingPolicy, TeamsMeetingPolicy, TeamsMessagingPolicy, TeamsTemplatePermissionPolicy, TeamsUpdateManagementPolicy, TeamsUpgradePolicy, TeamsVerticalPackagePolicy, TeamsVideoInteropServicePolicy, TenantDialPlan + +## EXAMPLES + +### EXAMPLE 1 +``` +$users_ids = @("psmith@contoso.com","tsanchez@contoso.com","bharvest@contoso.com") +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" +``` + +In this example, the batch of users is specified as an array of user SIP addresses. + +### EXAMPLE 2 +``` +$users_ids = @("2bdb15a9-2cf1-4b27-b2d5-fcc1d13eebc9", "d928e0fc-c957-4685-991b-c9e55a3534c7", "967cc9e4-4139-4057-9b84-1af80f4856fc") +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName $null -Identity $users_ids -OperationName "Batch unassign meeting policy" +``` + +In this example, a policy is removed from a batch of users by passing $null as the policy name. + +### EXAMPLE 3 +``` +$users_ids = Get-Content .\users_ids.txt +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" +``` + +In this example, the batch of users is read from a text file containing user object IDs (guids). + +### EXAMPLE 4 +``` +Connect-AzureAD +$users = Get-AzureADUser +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users.SipProxyAddress -OperationName "batch assign kiosk" +``` + +In this example, the batch of users is obtained by connecting to Microsoft Entra ID and retrieving a collection of users and then referencing the SipProxyAddress property. + +## 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationName +An optional name for the batch assignment operation. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalParameters +. + +```yaml +Type: Hashtable +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 + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### OperationId +The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation. + +## NOTES + +## RELATED LINKS + +[Get-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md b/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md new file mode 100644 index 0000000000..7ff16c4092 --- /dev/null +++ b/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsBatchPolicyPackageAssignmentOperation +author: serdarsoysal +ms.author: serdars +manager: amitar +online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation +schema: 2.0.0 +--- + +# New-CsBatchPolicyPackageAssignmentOperation + +## SYNOPSIS +This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. A batch may contain up to 5000 users. + +## SYNTAX + +``` +New-CsBatchPolicyPackageAssignmentOperation -Identity <String[]> -PackageName <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsBatchPolicyPackageAssignmentOperation -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,johndoe@example.com,richardroe@example.com -PackageName Education_PrimaryStudent +``` + +Applies the Education_PrimaryStudent policy package to three users in the tenant. + +## PARAMETERS + +### -Identity + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageName + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) + +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) diff --git a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md b/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md new file mode 100644 index 0000000000..90392de568 --- /dev/null +++ b/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md @@ -0,0 +1,98 @@ +--- +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 <String> -UsersFilePath <String> + -UsersToNotify <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/New-CsCallQueue.md b/teams/teams-ps/teams/New-CsCallQueue.md new file mode 100644 index 0000000000..003cdb37c1 --- /dev/null +++ b/teams/teams-ps/teams/New-CsCallQueue.md @@ -0,0 +1,1706 @@ +--- +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 +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsCallQueue + +## SYNOPSIS +Creates new Call Queue in your Skype for Business Online organization. + +## SYNTAX + +``` +New-CsCallQueue -Name <String> [-AgentAlertTime <Int16>] [-AllowOptOut <Boolean>] [-DistributionLists <List>] [-Tenant <Guid>] [-UseDefaultMusicOnHold <Boolean>] [-WelcomeMusicAudioFileId <Guid>] [-MusicOnHoldAudioFileId <Guid>] [-OverflowAction <Object>] [-OverflowActionTarget <Guid>] [-OverflowActionCallPriority <Int16>] [-OverflowThreshold <Int16>] [-TimeoutAction <Object>] [-TimeoutActionTarget <Guid>] [-TimeoutActionCallPriority <Int16>] [-TimeoutThreshold <Int16>] [-NoAgentAction <Object>] [-NoAgentActionTarget <Guid>] [-NoAgentActionCallPriority <Int16>] [-RoutingMethod <Object>] [-PresenceBasedRouting <Boolean>] [-ConferenceMode <Boolean>] [-User <List>] [-LanguageId <String>] [-LineUri <String>] [-OboResourceAccountIds <List>] [-OverflowDisconnectTextToSpeechPrompt <String>][-OverflowDisconnectAudioFilePrompt <Guid>] [-OverflowRedirectPersonTextToSpeechPrompt <String>][-OverflowRedirectPersonAudioFilePrompt <Guid>] [-OverflowRedirectVoiceAppTextToSpeechPrompt <String>] [-OverflowRedirectVoiceAppAudioFilePrompt <Guid>] [-OverflowRedirectPhoneNumberTextToSpeechPrompt <String>] [-OverflowRedirectPhoneNumberAudioFilePrompt <Guid>] [-OverflowRedirectVoicemailTextToSpeechPrompt <String>] [-OverflowRedirectVoicemailAudioFilePrompt <Guid>] [-OverflowSharedVoicemailTextToSpeechPrompt <String>] [-OverflowSharedVoicemailAudioFilePrompt <Guid>] [-EnableOverflowSharedVoicemailTranscription <Boolean>] [-EnableOverflowSharedVoicemailSystemPromptSuppression <Boolean>] [-TimeoutDisconnectTextToSpeechPrompt <String>][-TimeoutDisconnectAudioFilePrompt <Guid>] [-TimeoutRedirectPersonTextToSpeechPrompt <String>] [-TimeoutRedirectPersonAudioFilePrompt <Guid>] [-TimeoutRedirectVoiceAppTextToSpeechPrompt <String>] [-TimeoutRedirectVoiceAppAudioFilePrompt <Guid>] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt <String>] [-TimeoutRedirectPhoneNumberAudioFilePrompt <Guid>] [-TimeoutRedirectVoicemailTextToSpeechPrompt <String>] [-TimeoutRedirectVoicemailAudioFilePrompt <Guid>] [-TimeoutSharedVoicemailTextToSpeechPrompt <String>] [-TimeoutSharedVoicemailAudioFilePrompt <Guid>] [-EnableTimeoutSharedVoicemailTranscription <Boolean>] [-EnableTimeoutSharedVoicemailSystemPromptSuppression <Boolean>] [-NoAgentApplyTo <String>] [-NoAgentDisconnectTextToSpeechPrompt <String>][-NoAgentDisconnectAudioFilePrompt <Guid>] [-NoAgentRedirectPersonTextToSpeechPrompt <String>] [-NoAgentRedirectPersonAudioFilePrompt <Guid>] [-NoAgentRedirectVoiceAppTextToSpeechPrompt <String>] [-NoAgentRedirectVoiceAppAudioFilePrompt <Guid>] [-NoAgentRedirectPhoneNumberTextToSpeechPrompt <String>] [-NoAgentRedirectPhoneNumberAudioFilePrompt <Guid>] [-NoAgentRedirectVoicemailTextToSpeechPrompt <String>] [-NoAgentRedirectVoicemailAudioFilePrompt <Guid>] [-NoAgentSharedVoicemailTextToSpeechPrompt <String>] [-NoAgentSharedVoicemailAudioFilePrompt <Guid>] [-EnableNoAgentSharedVoicemailTranscription <Boolean>] [-EnableNoAgentSharedVoicemailSystemPromptSuppression <Boolean>] [-ChannelId <String>] [-ChannelUserObjectId <Guid>] [-ShiftsTeamId <String>] [-ShiftsSchedulingGroupId <String>] [-AuthorizedUsers <List>] [-HideAuthorizedUsers <List>] [-WelcomeTextToSpeechPrompt <String>] [-IsCallbackEnabled <Boolean>] [-CallbackRequestDtmf <String>] [-WaitTimeBeforeOfferingCallbackInSecond <Int16>] [-NumberOfCallsInQueueBeforeOfferingCallback <Int16>] [-CallToAgentRatioThresholdBeforeOfferingCallback <Int16>] [-CallbackOfferAudioFilePromptResourceId <Guid>] [-CallbackOfferTextToSpeechPrompt <String>] [-CallbackEmailNotificationTarget <Guid>] [-ServiceLevelThresholdResponseTimeInSecond <Int16> ] [-ComplianceRecordingForCallQueueTemplateId <List>] [-TextAnnouncementForCR <String>] [-CustomAudioFileAnnouncementForCR <Guid>] [-TextAnnouncementForCRFailure <String>] [-CustomAudioFileAnnouncementForCRFailure <Guid>] [-ShouldOverwriteCallableChannelProperty <Boolean>] [-SharedCallQueueHistoryTemplateId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsCallQueue cmdlet creates a new Call Queue. + +> [!CAUTION] +> The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items: +> +> - -HideAuthorizedUsers +> - -OverflowActionCallPriority +> - -OverflowRedirectPersonTextToSpeechPrompt +> - -OverflowRedirectPersonAudioFilePrompt +> - -OverflowRedirectVoicemailTextToSpeechPrompt +> - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutActionCallPriority +> - -TimeoutRedirectPersonTextToSpeechPrompt +> - -TimeoutRedirectPersonAudioFilePrompt +> - -TimeoutRedirectVoicemailTextToSpeechPrompt +> - -TimeoutRedirectVoicemailAudioFilePrompt +> - -NoAgentActionCallPriority +> - -NoAgentRedirectPersonTextToSpeechPrompt +> - -NoAgentRedirectPersonAudioFilePrompt +> - -NoAgentRedirectVoicemailTextToSpeechPrompt +> - -NoAgentRedirectVoicemailAudioFilePrompt +> +> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. +> +> - -ShiftsTeamId +> - -ShiftsSchedulingGroupId +> - -ComplianceRecordingForCallQueueTemplateId +> - -TextAnnouncementForCR +> - -CustomAudioFileAnnouncementForCR +> - -TextAnnouncementForCRFailure +> - -CustomAudioFileAnnouncementForCRFailure +> - -SharedCallQueueHistoryTemplateId +> +> [Nesting Auto attendants and Call queues](/microsoftteams/plan-auto-attendant-call-queue#nested-auto-attendants-and-call-queues) without a resource account isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. +> +> Authorized users can't edit call flows with call priorities at this time. + +## EXAMPLES + +### Example 1 +``` +New-CsCallQueue -Name "Help Desk" -UseDefaultMusicOnHold $true +``` + +This example creates a Call Queue for the organization named "Help Desk" using default music on hold. + +### Example 2 +``` +New-CsCallQueue -Name "Help desk" -RoutingMethod Attendant -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -AllowOptOut $false -AgentAlertTime 30 -OverflowThreshold 15 -OverflowAction Forward -OverflowActionTarget 7fd04db1-1c8e-4fdf-9af5-031514ba1358 -TimeoutThreshold 30 -TimeoutAction Disconnect -MusicOnHoldAudioFileId 1e81adaf-7c3e-4db1-9d61-5d135abb1bcc -WelcomeMusicAudioFileId 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 + +``` + +This example creates a Call Queue for the organization named "Help Desk" with music on hold and welcome music audio files. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentAlertTime +The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 30 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOptOut +The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionLists +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultMusicOnHold +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeMusicAudioFileId +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldAudioFileId +The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowAction +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: DisconnectWithBusy +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionTarget +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverFlowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowThreshold +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutAction +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionTarget +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutThreshold +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 1200 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentApplyTo +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentAction +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionTarget +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingMethod +The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Attendant +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PresenceBasedRouting +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConferenceMode +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageId +The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter if either OverflowAction or TimeoutAction is set to SharedVoicemail. + +You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OboResourceAccountIds +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. + +Only Call Queue managed by a Teams Channel will be able to use this feature. For more information, refer to [Manage your support Call Queue in Teams](https://support.microsoft.com/office/manage-your-support-call-queue-in-teams-9f07dabe-91c6-4a9b-a545-8ffdddd2504e). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailTextToSpeechPrompt +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailAudioFilePrompt +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailTranscription +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailSystemPromptSuppression +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppAudioFilePrompt +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailTextToSpeechPrompt +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailAudioFilePrompt +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailTranscription +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailSystemPromptSuppression +The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectTextToSpeechPrompt +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectAudioFilePrompt +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppTextToSpeechPrompt +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppAudioFilePrompt +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberAudioFilePrompt +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailTextToSpeechPrompt +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailAudioFilePrompt +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailTranscription +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailSystemPromptSuppression +The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelId +Id of the channel to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelUserObjectId +Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsTeamId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsSchedulingGroupId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackRequestDtmf + +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitTimeBeforeOfferingCallbackInSecond + +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfCallsInQueueBeforeOfferingCallback + +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallToAgentRatioThresholdBeforeOfferingCallback + +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of 1. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferAudioFilePromptResourceId + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferTextToSpeechPrompt + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackEmailNotificationTarget + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS +[Create a Phone System Call Queue](https://support.office.com/article/Create-a-Phone-System-call-queue-67ccda94-1210-43fb-a25b-7b9785f8a061) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) diff --git a/teams/teams-ps/teams/New-CsCallingLineIdentity.md b/teams/teams-ps/teams/New-CsCallingLineIdentity.md new file mode 100644 index 0000000000..93e83c74a1 --- /dev/null +++ b/teams/teams-ps/teams/New-CsCallingLineIdentity.md @@ -0,0 +1,237 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# New-CsCallingLineIdentity + +## SYNOPSIS +Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for your organization. + +## SYNTAX + +``` +New-CsCallingLineIdentity [-Identity] <string> [-BlockIncomingPstnCallerID <bool>] [-CallingIDSubstitute <string>] [-CompanyName <string>] +[-Description <string>] [-EnableUserOverride <bool>] [-ResourceAccount <string>] +[-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can either change or block the Caller ID (also called a Calling Line ID) for a user. By default, the Teams or Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can create a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed. + +Note: +- Identity must be unique. +- If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty. + +## EXAMPLES + +### Example 1 +``` +New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false +``` + +This example creates a new Caller ID policy that sets the Caller ID to Anonymous. + +### Example 2 +``` +New-CsCallingLineIdentity -Identity BlockIncomingCLID -BlockIncomingPstnCallerID $true +``` + +This example creates a new Caller ID policy that blocks the incoming Caller ID. + +### Example 3 +``` +$ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId +New-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -EnableUserOverride $false -ResourceAccount $ObjId -CompanyName "Contoso" +``` + +This example creates a new Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso + +### Example 4 +``` +New-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true +``` + +This example creates a new Caller ID policy that allows Teams users to make anonymous calls. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the Caller ID policy. + +```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 +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallingIDSubstitute +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +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 +``` + +### -Description +The Description parameter briefly describes the Caller ID policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUserOverride +The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. + +If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. + +EnableUserOverride has precedence over other settings in the policy unless substitution is set to Anonymous. For example, assume the policy instance has substitution using a resource account and EnableUserOverride is set and enabled by the user. In this case, the outbound caller ID will be blocked and Anonymous will be used. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) + +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) + +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) + +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md new file mode 100644 index 0000000000..772f8f1d49 --- /dev/null +++ b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md @@ -0,0 +1,62 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsCloudCallDataConnection +online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection +schema: 2.0.0 +author: 2012ucp1544 +ms.author: uditagrawal +ms.reviewer: pbafna +manager: subadjat + +--- + +# New-CsCloudCallDataConnection + +## SYNOPSIS +This cmdlet creates an online call data connection. + +## SYNTAX + +```powershell +New-CsCloudCallDataConnection [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates an online call data connection. If you get an error that the connection already exists, it means that the call data connection already exists for your tenant. In this case, run Get-CsCloudCallDataConnection. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsCloudCallDataConnection + +Token +----- +00000000-0000-0000-0000-000000000000 +``` + +Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +The New-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. + +## RELATED LINKS + +[Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) +[Get-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection) diff --git a/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..f98067448d --- /dev/null +++ b/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/New-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: New-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +New-CsComplianceRecordingForCallQueueTemplate -Name <String> -Description <String> -BotId <String> [-RequiredDuringCall <Boolean>] [-RequiredBeforeCall <Boolean>] [-CurrentInvitationCount <Int32>] [-PairedApplication <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsComplianceRecordingForCallQueueTemplate -Name "Customer Service" -Description "Required before/during call" -BotId 14732826-8206-42e3-b51e-6693e2abb698 -RequiredDuringCall $true -RequiredBeforeCall $true +``` + +This example creates a new Compliance Recording for Call Queue template. + +## PARAMETERS + +### -Name +The name of the compliance recording for call queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the compliance recording for call queues template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BotId +The Id of the compliance recording for call queue bot to invite. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall +Indicates if the compliance recording for call queues bot must remain part of the call. +*Strict recording* - if the bot leaves the call, the call will end. + +```yaml +Type: System.Booleen +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCall +Indicates if the compliance recording for call queues bot must be able to join the call. +*Strict recording* - if the bot can't join the call, the call will end. + +```yaml +Type: System.Booleen +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount +The number of concurrent invitations to send to the compliance recording for call queue bot. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PairedApplication +The PairedApplication parameter specifies the paired application for the call queue. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md b/teams/teams-ps/teams/New-CsCustomPolicyPackage.md new file mode 100644 index 0000000000..bf6a5dfc6b --- /dev/null +++ b/teams/teams-ps/teams/New-CsCustomPolicyPackage.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsCustomPolicyPackage +author: sunguchuan +ms.author: gucsun +manager: dasosby +online version: https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage +schema: 2.0.0 +--- + +# New-CsCustomPolicyPackage + +## SYNOPSIS + +**Note:** This cmdlet is currently in private preview. + +This cmdlet creates a custom policy package. + +## SYNTAX + +``` +New-CsCustomPolicyPackage -Identity <String> -PolicyList <String[]> [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, see [Managing policy packages in Teams](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy" +``` + +Creates a custom package named "MyPackage" with one policy in the package: a messaging policy of name "MyMessagingPolicy". +### Example 2 +```powershell +PS C:\> New-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy", "TeamsMeetingPolicy, MyMeetingPolicy" -Description "My package" +``` + +Creates a custom package named "MyPackage" with description "My package" and two policies in the package: a messaging policy of name "MyMessagingPolicy" and a meeting policy of name "MyMeetingPolicy". + +## PARAMETERS + +### -Identity + +The name of the custom package. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyList + +A list of one or more policies to be added in the package. To specify the policy list, follow this format: "\<PolicyType\>, \<PolicyName\>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the custom package. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) + +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) diff --git a/skype/skype-ps/skype/New-CsEdgeAllowAllKnownDomains.md b/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md similarity index 81% rename from skype/skype-ps/skype/New-CsEdgeAllowAllKnownDomains.md rename to teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md index b91eb612ab..2aef1fe8ea 100644 --- a/skype/skype-ps/skype/New-CsEdgeAllowAllKnownDomains.md +++ b/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md @@ -1,8 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowallknowndomains +applicable: Microsoft Teams title: New-CsEdgeAllowAllKnownDomains schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsEdgeAllowAllKnownDomains @@ -13,7 +18,7 @@ Enables Skype for Business Online federation with all domains except for those d ## SYNTAX ``` -New-CsEdgeAllowAllKnownDomains [-AsJob] [<CommonParameters>] +New-CsEdgeAllowAllKnownDomains [<CommonParameters>] ``` ## DESCRIPTION @@ -46,7 +51,7 @@ To configure federation with all known domains, use a set of commands similar to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### -------------------------- Example 1 -------------------------- ``` $x = New-CsEdgeAllowAllKnownDomains @@ -57,44 +62,24 @@ The two commands shown in Example 1 configure the federation settings for the cu To do this, the first command in the example uses the New-CsEdgeAllowAllKnownDomains cmdlet to create an instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowAllKnownDomains object; this instance is stored in a variable named $x. In the second command, the Set-CsTenantFederationConfiguration cmdlet is called along with the AllowedDomains parameter; using $x as the parameter value configures the federation settings to allow all known domains. - - ## PARAMETERS -### -AsJob -{{Fill AsJob Description}} - -```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 -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None. The New-CsEdgeAllowAllKnownDomains cmdlet does not accept pipelined input. ## OUTPUTS -### +### Output types The New-CsEdgeAllowAllKnownDomains cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowAllKnownDomains object. ## NOTES ## RELATED LINKS -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) - - +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/skype/skype-ps/skype/New-CsEdgeAllowList.md b/teams/teams-ps/teams/New-CsEdgeAllowList.md similarity index 78% rename from skype/skype-ps/skype/New-CsEdgeAllowList.md rename to teams/teams-ps/teams/New-CsEdgeAllowList.md index d464df81af..051c806683 100644 --- a/skype/skype-ps/skype/New-CsEdgeAllowList.md +++ b/teams/teams-ps/teams/New-CsEdgeAllowList.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowlist +applicable: Microsoft Teams title: New-CsEdgeAllowList schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsEdgeAllowList @@ -51,7 +56,7 @@ When this command finishes executing, users will only be allowed to communicate ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### -------------------------- Example 1 -------------------------- ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -67,11 +72,8 @@ 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 -------------------------- ``` -$newAllowList = New-CsEdgeAllowList -AllowedDomain $x,$y - $x = New-CsEdgeDomainPattern -Domain "contoso.com" $y = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -85,7 +87,7 @@ Example 2 shows how you can add multiple domains to an allowed domains list. This is done by calling the `New-CsEdgeDomainPattern` cmdlet multiple times (one for each domain to be added to the list), and storing the resulting domain objects in separate variables. Each of those variables can then be added to the allow list created by the `New-CsEdgeAllowList` cmdlet simply by using the AllowedDomain parameter and separating the variables name by using commas. -### -------------------------- Example 3 -------------------------- +### -------------------------- Example 3 -------------------------- ``` $newAllowList = New-CsEdgeAllowList -AllowedDomain $Null @@ -109,28 +111,8 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -140,23 +122,23 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None. The `New-CsEdgeAllowList` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Output types The `New-CsEdgeAllowList` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowList object. ## NOTES ## RELATED LINKS -[New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) +[New-CsEdgeDomainPattern](https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern) -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md b/teams/teams-ps/teams/New-CsEdgeDomainPattern.md new file mode 100644 index 0000000000..5bc669bc16 --- /dev/null +++ b/teams/teams-ps/teams/New-CsEdgeDomainPattern.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern +applicable: Microsoft Teams +title: New-CsEdgeDomainPattern +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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 + +``` +New-CsEdgeDomainPattern -Domain <String> [<CommonParameters>] +``` + +## DESCRIPTION +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: + +Whether or not users can communicate with people from other domains and, if so, which domains they are allowed to communicate with. + +Whether or not users can communicate with people who have accounts on public IM and presence providers such as Windows Live, AOL, and Yahoo. + +Federation is managed, in part, by using allowed domain and blocked domain lists. +The allowed domain list specifies the domains that users are allowed to communicate with; the blocked domain list specifies the domains that users are not allowed to communicate with. +By default, users can communicate with any domain that does not appear on the blocked list. +However, administrators can modify this default setting and limit communication to domains that are on the allowed domains list. + +Skype for Business Online does not allow you to directly modify the allowed list or the blocked list; for example, you cannot use a command similar to this one, which passes a string value representing a domain name to the blocked domains list: + +`Set-CsTenantFederationConfiguration -BlockedDomains "fabrikam.com"` + +Instead, you must create a domain object by using the New-CsEdgeDomainPattern cmdlet, store that domain object in a variable (in this example, $x), then pass the variable name to the blocked domains list: + +`$x = New-CsEdgeDomainPattern -Domain "fabrikam.com"` + +`Set-CsTenantFederationConfiguration -BlockedDomains $x` + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$x = New-CsEdgeDomainPattern -Domain "fabrikam.com" + +Set-CsTenantFederationConfiguration -BlockedDomains $x +``` + +Example 1 demonstrates how you can assign a single domain to the blocked domains list for a specified tenant. +To do this, the first command in the example creates a domain object for the domain fabrikam.com; this is done by calling the New-CsEdgeDomainPattern cmdlet and by saving the resulting domain object in a variable named $x. +The second command then uses the Set-CsTenantFederationConfiguration cmdlet and the BlockedDomains parameter to configure fabrikam.com as the only domain blocked by the current tenant. + +## PARAMETERS + +### -Domain +Fully qualified domain name of the domain to be added to the allow list. +For example: + +`-Domain "fabrikam.com"` + +Note that you cannot use wildcards when specifying a domain name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +None. +The New-CsEdgeDomainPattern cmdlet does not accept pipelined input. + +## OUTPUTS + +### Output types +The New-CsEdgeDomainPattern cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DomainPattern object. + +## NOTES + +## RELATED LINKS + +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md b/teams/teams-ps/teams/New-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..5534e03ef3 --- /dev/null +++ b/teams/teams-ps/teams/New-CsExternalAccessPolicy.md @@ -0,0 +1,533 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy +applicable: Microsoft Teams +title: New-CsExternalAccessPolicy +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# New-CsExternalAccessPolicy + +## SYNOPSIS + +Enables you to create a new external access policy. + +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. + +This cmdlet was introduced in Lync Server 2010. + +For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) and [Teams and Skype interoperability](https://learn.microsoft.com/microsoftteams/teams-skype-interop) for specific details. + +## SYNTAX + +```powershell +New-CsExternalAccessPolicy [-Identity] <XdsIdentity> + [-AllowedExternalDomains <List>] + [-BlockedExternalDomains <List>] + [-CommunicationWithExternalOrgs <String>] + [-Confirm] + [-Description <String>] + [-EnableAcsFederationAccess <Boolean>] + [-EnableFederationAccess <Boolean>] + [-EnableOutsideAccess <Boolean>] + [-EnablePublicCloudAudioVideoAccess <Boolean>] + [-EnableTeamsConsumerAccess <Boolean>] + [-EnableTeamsConsumerInbound <Boolean>] + [-EnableTeamsSmsAccess <Boolean>] + [-EnableXmppAccess <Boolean>] + [-FederatedBilateralChats <Boolean>] + [-Force] + [-InMemory] + [-RestrictTeamsConsumerAccessToExternalUserProfiles <Boolean>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION + +When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. + +When you install Skype for Business Server, a global external access policy is automatically created for you. +In addition to the global policy, you can also create custom external access policies at either the site or the per-user scope. +If you create an external access policy at the site scope, that policy will automatically be assigned to the site upon creation. +If you create an external access policy at the per-user scope, that policy will be created but will not be assigned to any users. +To assign the policy to a user or group of users, use the Grant-CsExternalAccessPolicy cmdlet. + +New external access policies can be created by using the New-CsExternalAccessPolicy cmdlet. +Note that these policies can only be created at the site or the per-user scope; you cannot create a new policy at the global scope. +In addition, you can have only one external access policy per site: if the Redmond site already has been assigned an external access policy you cannot create a second policy for the site. + +The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, InMemory, PipelineVariable, and Tenant + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True +``` + +The command shown in Example 1 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. +Note that this new policy sets both the EnableFederationAccess and the EnableOutsideAccess properties to True. + +### -------------------------- Example 2 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true +New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false +``` + +In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. + +### -------------------------- Example 3 ------------------------ +``` +New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False +``` + +The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. +Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. + +### -------------------------- EXAMPLE 4 -------------------------- +``` +$x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory + +$x.EnableFederationAccess = $True + +$x.EnableOutsideAccess = $True + +Set-CsExternalAccessPolicy -Instance $x +``` + +Example 4 demonstrates the use of the InMemory parameter; this parameter enables you to create an in-memory-only instance of an external access policy. +After it has been created, you can modify the in-memory-only instance, then use the Set-CsExternalAccessPolicy cmdlet to transform the virtual policy into a real external access policy. + +To do this, the first command in the example uses the New-CsExternalAccessPolicy cmdlet and the InMemory parameter to create a virtual policy with the Identity RedmondAccessPolicy; this virtual policy is stored in a variable named $x. +The next three commands are used to modify two properties of the virtual policy: EnableFederationAccess and the EnableOutsideAccess. +Finally, the last command uses the Set-CsExternalAccessPolicy cmdlet to create an actual per-user external access policy with the Identity RedmondAccessPolicy. +If you do not call the Set-CsExternalAccessPolicy cmdlet, then the virtual policy will disappear as soon as you end your Windows PowerShell session or delete the variable $x. +Should that happen, an external access policy with the Identity RedmondAccessPolicy will never be created. + +### -------------------------- Example 5 ------------------------ +``` +New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") +Set-CsTenantFederationConfiguration -CustomizeFederation $true +``` + +In this example, we create an ExternalAccessPolicy named "GranularFederationExample" that allows communication with specific external domains, namely `example1.com` and `example2.com`. The federation policy is set to restrict communication to only these allowed domains. + +## PARAMETERS + +### -Identity +Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope. + +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. + +For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` + +To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. + +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains allowed to communicate with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `AllowSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains blocked from communicating with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `BlockSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunicationWithExternalOrgs +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Indicates how users assigned to the policy can communicate with external organizations (domains). This setting has 5 possible values: + +- OrganizationDefault: users follow the federation settings specified in `TenantFederationConfiguration`. This is the default value. +- AllowAllExternalDomains: users are allowed to communicate with all domains. +- AllowSpecificExternalDomains: users can communicate with external domains listed in `AllowedExternalDomains`. +- BlockSpecificExternalDomains: users are blocked from communicating with domains listed in `BlockedExternalDomains`. +- BlockAllExternalDomains: users cannot communicate with any external domains. + +The setting is only applicable when `EnableFederationAccess` is set to true. This setting can only be modified in custom policies. In the Global (default) policy, it is fixed to `OrganizationDefault` and cannot be changed. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: OrganizationDefault +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcsFederationAccess +Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFederationAccess +Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOutsideAccess +Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePublicCloudAudioVideoAccess +Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. +When set to False, audio and video options in Skype for Business Server will be disabled any time a user is communicating with a public Internet connectivity contact. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerAccess +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerInbound +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsSmsAccess +Allows you to control whether users can have SMS text messaging capabilities within Teams. + +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableXmppAccess +Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedBilateralChats +> [!NOTE] +> Please note that this parameter is in Private Preview. + +This setting enables bi-lateral chats for the users included in the messaging policy. + +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + +Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. + +This policy doesn't apply to meetings, meeting chats, or channels. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\<cmdlet\>. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictTeamsConsumerAccessToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory + +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new external access policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +None. +The New-CsExternalAccessPolicy cmdlet does not accept pipelined input. + +## OUTPUTS + +### Output types +Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md new file mode 100644 index 0000000000..efbf01984f --- /dev/null +++ b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment +title: New-CsGroupPolicyAssignment +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsGroupPolicyAssignment + +## SYNOPSIS + +This cmdlet is used to assign a policy to a security group or distribution list. + +## SYNTAX + +``` +New-CsGroupPolicyAssignment -GroupId <String> -PolicyType <String> -PolicyName <String> [-Rank <Int32>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +> [!NOTE] +> As of May 2023, group policy assignment functionality in Teams PowerShell Module has been extended to support all policy types used in Teams except for the following: +> - Teams App Permission Policy +> - Teams Network Roaming Policy +> - Teams Emergency Call Routing Policy +> - Teams Voice Applications Policy +> - Teams Upgrade Policy +> +> This cmdlet will be deprecated in the future. Going forward, group policy assignment can be performed by using the corresponding Grant-Cs[PolicyType] cmdlet with the '-Group' parameter. + +This cmdlet is used to assign a policy to a Microsoft 365 group, a security group, or a distribution list. When creating a group policy assignment, you must specify a rank, which indicates the precedence of that assignment relative to any other group assignments for the same policy type that may exist. The assignment will be applied to users in the group for any user that does not have a direct policy assignment, provided the user does not have any higher-ranking assignments from other groups for the same policy type. + +The group policy assignment rank is set at the time a policy is assigned to a group and it is relative to other group policy assignments of the same policy type. For example, if there are two groups, each assigned a Teams Meeting policy, then one of the group assignments will be rank 1 while the other will be rank 2. It's helpful to think of rank as determining the position of each policy assignment in an ordered list, from highest rank to lowest rank. In fact, rank can be specified as any number, but these are converted into sequential values 1, 2, 3, etc. with 1 being the highest rank. When assigning a policy to a group, set the rank to be the position in the list where you want the new group policy assignment to be. If a rank is not specified, the policy assignment will be given the lowest rank, corresponding to the end of the list. Assignments applied directly to a user will be treated like rank 0, having precedence over all assignments applied via groups. + +Once a group policy assignment is created, the policy assignment will be propagated to the members of the group, including users that are added to the group after the assignment was created. Propagation time of the policy assignments to members of the group varies based on the number of users in the group. Propagation time for subsequent group membership changes also varies based on the number of users being added or removed from the group. For large groups, propagation to all members may take 24 hours or more. When using group policy assignment, the recommended maximum group membership size is 50,000 users per group. + +> [!NOTE] +> - 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). +> - Group policy assignment is currently not available in the Microsoft 365 DoD deployment. + +## EXAMPLES + +### Example 1 +In this example, a policy is assigned to a group specified by its object id. + +``` +New-CsGroupPolicyAssignment -GroupId d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 -PolicyType TeamsMeetingPolicy -PolicyName AllOn -Rank 1 + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +### Example 2 +In this example, a policy is assigned to a group specified by email/SIP address. The rank is not specified so it will be set to the lowest rank for the given policy type. + +``` +New-CsGroupPolicyAssignment -GroupId salesdepartment@contoso.com -PolicyType TeamsMeetingPolicy -PolicyName Kiosk + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +### Example 3 +In this example, the policy assignment rank is set to 2. The current rank 2 policy assignment of the same type will be updated to rank 3. + +``` +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + +New-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingpolicy -PolicyName AllOff -Rank 2 + +Get-CsGroupPolicyAssignment + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +## PARAMETERS + +### -GroupId +The ID of a batch policy assignment operation. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyType +The type of policy 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 +``` + +### -PolicyName +The name of the policy 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 +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment) + +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) + +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..80fbe8f586 --- /dev/null +++ b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md @@ -0,0 +1,105 @@ +--- +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. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **New-CsOnlineDirectRoutingTelephoneNumberUploadOrder** cmdlet to add a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder?view=teams-ps) + +## SYNTAX + +### Identity (Default) +```powershell +New-CsHybridTelephoneNumber -TelephoneNumber <string> [-Force] -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>] +``` + +## 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-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md new file mode 100644 index 0000000000..ba2c63af2f --- /dev/null +++ b/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern +applicable: Microsoft Teams +title: New-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# New-CsInboundBlockedNumberPattern + +## SYNOPSIS +Adds a blocked number pattern to the tenant list. + +## SYNTAX + +### Identity (Default) +``` +New-CsInboundBlockedNumberPattern [-Identity] <string> -Pattern <string> [-Description <string>] [-Enabled <boolean>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsInboundBlockedNumberPattern -Pattern <string> -Name <string> [-Description <string>] [-Enabled <boolean>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet adds a blocked number pattern to the tenant list. An inbound PSTN call from a number that matches the blocked number pattern will be blocked. + +## EXAMPLES + +### Example 1 +```powershell +PS> New-CsInboundBlockedNumberPattern -Description "Avoid Unwanted Automatic Call" -Name "BlockAutomatic" -Pattern "^\+11234567890" +``` + +This example adds a blocked number pattern to block inbound calls from +11234567890 number. + +## PARAMETERS + +### -Description +A friendly description for the blocked number pattern to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +If this parameter is set to True, the inbound calls matching the pattern will be blocked. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier specifying the blocked number pattern to be created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A displayable name describing the blocked number pattern to be created. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the calling number must match in order to be blocked. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) + +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) + +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md new file mode 100644 index 0000000000..63ed383946 --- /dev/null +++ b/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: New-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# New-CsInboundExemptNumberPattern + +## SYNOPSIS + +This cmdlet lets you configure a new number pattern that is exempt from tenant call blocking. + +## SYNTAX + +### Identity (Default) + +```powershell +New-CsInboundExemptNumberPattern -Identity <String> -Pattern <String> [-Description <String>] [-Enabled <Boolean>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsInboundExemptNumberPattern -Pattern <string> -Name <string> [-Description <string>] [-Enabled <boolean>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS> New-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Pattern "^\+?1312555888[2|3]$" -Description "Allow Contoso helpdesk" -Enabled $True +``` + +Creates a new inbound exempt number pattern for the numbers 1 (312) 555-88882 and 1 (312) 555-88883 and enables it + +## PARAMETERS + +### -Description + +Sets the description of the number pattern. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter determines whether the number pattern is enabled for exemption or not. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the exempt number pattern to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A displayable name describing the exempt number pattern to be created. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern + +A regular expression that the calling number must match in order to be exempt from blocking. It is best practice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +You can use Test-CsInboundBlockedNumberPattern to test your block and exempt phone number ranges. + +## RELATED LINKS + +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) + +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) + +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..0254f15626 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance +applicable: Microsoft Teams +title: New-CsOnlineApplicationInstance +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsOnlineApplicationInstance + +## SYNOPSIS +Creates an application instance in Microsoft Entra ID. + +## SYNTAX + +``` +New-CsOnlineApplicationInstance [-UserPrincipalName] <string> [[-ApplicationId] <guid>] [[-DisplayName] <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is used to create an application instance in Microsoft Entra ID. This same cmdlet is also run when creating a new resource account using Teams Admin Center. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" +``` + +This example creates a new application instance for an Auto Attendant with UserPrincipalName "appinstance01@contoso.com", ApplicationId "ce933385-9390-45d1-9512-c8d228074e07", DisplayName "AppInstance01" for the tenant. + +## PARAMETERS + +### -UserPrincipalName +The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md new file mode 100644 index 0000000000..9cc704f634 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md @@ -0,0 +1,226 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsOnlineApplicationInstanceAssociation + +## SYNOPSIS +Use the New-CsOnlineApplicationInstanceAssociation cmdlet to associate either a single or multiple application instances with an application configuration, like auto attendant or call queue. + +## SYNTAX + +``` +New-CsOnlineApplicationInstanceAssociation -Identities <String[]> -ConfigurationId <String> -ConfigurationType <Object> [-CallPriority <Int16>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsOnlineApplicationInstanceAssociation cmdlet associates either a single or multiple application instances with an application configuration, like auto attendant or call queue. When an association is created between an application instance and an application configuration, calls reaching that application instance would be handled based on the associated application configuration. For more information on how to create _Application Instances_, check `New-CsOnlineApplicationInstance` cmdlet documentation. + +You can get the Identity of the application instance from the ObjectId of the AD object. + +## EXAMPLES + +### -------------------------- 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 + +New-CsOnlineApplicationInstanceAssociation -Identities @($applicationInstanceId) -ConfigurationId $autoAttendantId -ConfigurationType AutoAttendant + +Get-CsAutoAttendant -Identity $autoAttendantId + +# Id : c2ee3e18-b738-5515-a97b-46be52dfc057 +# TenantId : 977c9d5b-2dae-5d82-aada-628bc1c14213 +# Name : Main Auto Attendant +# LanguageId : en-US +# VoiceId : Female +# DefaultCallFlow : Default Call Flow +# Operator : +# TimeZoneId : Pacific Standard Time +# VoiceResponseEnabled : False +# CallFlows : +# Schedules : +# CallHandlingAssociations : +# Status : +# DialByNameResourceId : +# DirectoryLookupScope : +# ApplicationInstances : {76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19} +``` + +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 -------------------------- +```powershell +$applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "tel:+1206") | Select-Object -Property Id + +# Id +# -- +# fa2f17ec-ebd5-43f8-81ac-959c245620fa +# 56421bbe-5649-4208-a60c-24dbeded6f18 +# c7af9c3c-ae40-455d-a37c-aeec771e623d + +$autoAttendantId = (Get-CsAutoAttendant -NameFilter "Main Auto Attendant").Id # c2ee3e18-b738-5515-a97b-46be52dfc057 + +New-CsOnlineApplicationInstanceAssociation -Identities $applicationInstancesIdentities -ConfigurationId $autoAttendantId -ConfigurationType AutoAttendant + +Get-CsAutoAttendant -Identity $autoAttendantId + +# Id : c2ee3e18-b738-5515-a97b-46be52dfc057 +# TenantId : 977c9d5b-2dae-5d82-aada-628bc1c14213 +# Name : Main Auto Attendant +# LanguageId : en-US +# VoiceId : Female +# DefaultCallFlow : Default Call Flow +# Operator : +# TimeZoneId : Pacific Standard Time +# VoiceResponseEnabled : False +# CallFlows : +# Schedules : +# CallHandlingAssociations : +# Status : +# DialByNameResourceId : +# DirectoryLookupScope : +# ApplicationInstances : {fa2f17ec-ebd5-43f8-81ac-959c245620fa, 56421bbe-5649-4208-a60c-24dbeded6f18, c7af9c3c-ae40-455d-a37c-aeec771e623d} +``` + +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 -------------------------- +```powershell +$applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Attendant") | Select-Object -Property Id + +# Id +# -- +# fa2f17ec-ebd5-43f8-81ac-959c245620fa +# 56421bbe-5649-4208-a60c-24dbeded6f18 +# c7af9c3c-ae40-455d-a37c-aeec771e623d + +$autoAttendantId = (Get-CsAutoAttendant -NameFilter "Main Auto Attendant").Id # c2ee3e18-b738-5515-a97b-46be52dfc057 + +New-CsOnlineApplicationInstanceAssociation -Identities $applicationInstancesIdentities -ConfigurationId $autoAttendantId -ConfigurationType AutoAttendant +``` + +This example creates an association between multiple application instances that we had created before with display name starting with "Main Auto Attendant", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". + +## PARAMETERS + +### -Identities +The Identities parameter is the identities of application instances to be associated with the provided configuration ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationType +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: + +- AutoAttendant +- CallQueue + +```yaml +Type: System.string +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallPriority +The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.AssociationOperationOutput + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) + +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) + +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..f38c088398 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,177 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy +title: New-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# New-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet creates a Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +New-CsOnlineAudioConferencingRoutingPolicy [-Identity] <String> [-Description <String>] + [-OnlinePstnUsages <Object>] [-RouteType <String>] [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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/teams/New-CsOnlineDateTimeRange.md new file mode 100644 index 0000000000..ad73e8f554 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md @@ -0,0 +1,117 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsOnlineDateTimeRange + +## SYNOPSIS +Use the New-CsOnlineDateTimeRange cmdlet to create a new date-time range. + +## SYNTAX + +``` +New-CsOnlineDateTimeRange -Start <String> [-End <String>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsOnlineDateTimeRange cmdlet creates a new date-time range to be used with the Organizational Auto Attendant (OAA) service. Date time ranges are used to form schedules. + +**NOTE**: + +- The start bound of the range must be less than its end bound. +- The time part of the range must be aligned with 30/60-minutes boundaries. +- A date time range bound can only be input in the following formats: + - "d/m/yyyy H:mm" + - "d/m/yyyy" (the time component of the date-time range is set to 00:00) + +## EXAMPLES + +### Example 1 +``` +$dtr = New-CsOnlineDateTimeRange -Start "1/1/2017" +``` + +This example creates a date-time range for spanning from January 1, 2017 12AM to January 2, 2017 12AM. + +### Example 2 +``` +$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017 09:00" -End "27/12/2017 00:00" +``` + +This example creates a date-time range spanning from December 24, 2017 9AM to December 27, 2017 12AM. + +## PARAMETERS + +### -Start +The Start parameter represents the start bound of the date-time range. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -End +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: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.DateTimeRange + +## NOTES + +## RELATED LINKS + +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md b/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md new file mode 100644 index 0000000000..b7d52913b8 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder +applicable: Microsoft Teams +title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# New-CsOnlineDirectRoutingTelephoneNumberUploadOrder + +## SYNOPSIS +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. The output of the cmdlet is the "orderId" of the asynchronous Direct Routing Number creation operation. A maximum of 10,000 phone numbers can be uploaded at a time. If more than 10,000 numbers need to be uploaded, the requests should be divided into multiple increments of up to 10,000 numbers. + +## SYNTAX + +``` +New-CsOnlineDirectRoutingTelephoneNumberUploadOrder [-TelephoneNumber <String>] [-StartingNumber <String>] [-EndingNumber <String>] [-FileContent <Byte[]>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet uploads Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. Once uploaded the phone numbers will be visible in Teams PowerShell as acquired Direct Routing phone numbers. + +The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -TelephoneNumber "+123456789" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a new Direct Routing telephone number "+123456789" is being uploaded to Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +### Example 2 +```powershell +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -TelephoneNumber "+123456789,+134567890,+145678901" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c14 +``` + +In this example, a list of telephone numbers is being uploaded to Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +### Example 3 +```powershell +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -StartingNumber "+12000000" -EndingNumber "+12000009" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a range of Direct Routing telephone numbers from "+12000000" to "+12000009" are being uploaded to Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +### Example 4 +```powershell +PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -FileContent $drlist +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c19 +``` + +In this example, the content of a file with a list of Direct Routing telephone numbers are being uploaded via file upload. The file should be in Comma Separated Values (CSV) file format and only containing the list of DR numbers. Only the content of the file can be passed to the New-CsOnlineDirectRoutingTelephoneNumberUploadOrder cmdlet. Additional fields will be supported via file upload in future releases. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +## PARAMETERS + +### -TelephoneNumber +This is the Direct Routing telephone numbers you wish to upload to Microsoft Teams telephone number management inventory. It is comma delimited list of one or more Direct Routing telephone numbers. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartingNumber +This is the starting number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndingNumber +This is the ending number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileContent +This is the content of a .csv file that includes the Direct Routing telephone numbers to be uploaded to the Microsoft Teams telephone number management inventory. This parameter can be used to upload up to 10,000 numbers at a time. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES +The cmdlet is available in Teams PowerShell module 6.7.1 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) +[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md new file mode 100644 index 0000000000..18fa5f7f05 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md @@ -0,0 +1,467 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# New-CsOnlineLisCivicAddress + +## SYNOPSIS +Use the New-CsOnlineLisCivicAddress cmdlet to create a civic address in the Location Information Service (LIS). + +## SYNTAX + +``` +New-CsOnlineLisCivicAddress -CompanyName <string> -CountryOrRegion <string> [-City <string>] [-CityAlias <string>] [-CompanyTaxId <string>] +[-Description <string>] [-Elin <string>] [-Force] [-HouseNumber <string>] [-HouseNumberSuffix <string>] +[-Latitude <string>] [-Longitude <string>] [-PostalCode <string>] [-PostDirectional <string>] [-PreDirectional <string>] +[-StateOrProvince <string>] [-StreetName <string>] [-StreetSuffix <string>] [-Confidence <String>] [-IsAzureMapValidationRequired <String>] [-ValidationStatus <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Because each civic address needs at least one location to assign to users, creating a new civic address also creates a default location. +This is useful in cases where a civic address has no particular sub-locations. +In that scenario you can create the civic address using the New -CsOnlineLisCivicAddress cmdlet and use the default location identifier for assignment to users. +The example output from the Get-CsOnlineLisCivicAddress below shows the DefaultLocationId property. + +CivicAddressId : 51a8a6e3-dae4-4653-9a99-a6e71c4c24ac + +HouseNumber : + +HouseNumberSuffix : + +PreDirectional : + +StreetName : + +StreetSuffix : + +PostDirectional : + +City : + +PostalCode : + +StateOrProvince : + +CountryOrRegion : US + +Description : + +CompanyName : MSFT + +DefaultLocationId : 75301b5d-3609-458e-a379-da9a1ab33228 + +ValidationStatus : NotValidated + +NumberOfVoiceUsers : 0 + +## EXAMPLES + +### Example 1 +```powershell +New-CsOnlineLisCivicAddress -HouseNumber 1 -StreetName 'Microsoft Way' -City Redmond -StateorProvince Washington -CountryOrRegion US -PostalCode 98052 -Description "West Coast Headquarters" -CompanyName Contoso -Latitude 47.63952 -Longitude -122.12781 -Elin MICROSOFT_ELIN +``` + +This example creates a new civic address described as "West Coast Headquarters": 1 Microsoft Way, Redmond WA, 98052 and sets the geo-coordinates. + +## PARAMETERS + +### -CompanyName +Specifies the name of your organization. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +Specifies the city of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CityAlias +Specifies the city alias of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyTaxId +Specifies the company tax identifier of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies an administrator defined description of the new civic address. + +```yaml +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 +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 +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HouseNumber +Specifies the numeric portion of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HouseNumberSuffix +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". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. 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 +Default value: None +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. 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +Specifies the postal code of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostDirectional +Specifies the directional attribute of the new civic address which follows the street name. +For example, "425 Smith Avenue NE". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreDirectional +Specifies the directional attribute of the new civic address which precedes the street name. +For example, "425 NE Smith Avenue". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StateOrProvince +Specifies the state or province of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetName +Specifies the street name of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confidence +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationStatus +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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: 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 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) + +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) + +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/New-CsOnlineLisLocation.md b/teams/teams-ps/teams/New-CsOnlineLisLocation.md new file mode 100644 index 0000000000..418b3f5aa2 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineLisLocation.md @@ -0,0 +1,454 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# New-CsOnlineLisLocation + +## SYNOPSIS +Use the New-CsOnlineLisLocation cmdlet to create a new emergency dispatch location within an existing civic address. Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. + +## SYNTAX + +``` +New-CsOnlineLisLocation -Location <string> -CivicAddressId <guid> [-Elin <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +## EXAMPLES + +### Example 1 +```powershell +New-CsOnlineLisLocation -CivicAddressId b39ff77d-db51-4ce5-8d50-9e9c778e1617 -Location "Office 101, 1st Floor" +``` + +This example creates a new location called "Office 101, 1st Floor" in the civic address specified by its identity. + +## 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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +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". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CountryOrRegion +Specifies the country or region of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: Country +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -City +Specifies the city of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CityAlias +Specifies the city alias. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CompanyName +Specifies the name of your organization. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Name +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyTaxId +The company tax ID. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies an administrator defined description of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Elin +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 +``` + +### -HouseNumber +Specifies the numeric portion of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -HouseNumberSuffix +Specifies the numeric suffix of the civic address. +For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Longitude +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +Specifies the postal code of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +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". + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PreDirectional +Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue". + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StateOrProvince +Specifies the state or province of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: State +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StreetName +Specifies the street name of the civic address. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StreetSuffix +Specifies the modifier of the street name. The street suffix will typically be something like street, avenue, way, or boulevard. + +**Note:** This parameter is not supported and is deprecated. + +```yaml +Type: String +Parameter Sets: CreateCivicAddress +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 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 +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) + +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) + +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md new file mode 100644 index 0000000000..3da8fd129c --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md @@ -0,0 +1,459 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsOnlinePSTNGateway + +## SYNOPSIS +Creates a new Session Border Controller (SBC) Configuration that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. + +## SYNTAX + +### Identity (Default) +``` +New-CsOnlinePSTNGateway [-Identity] <string> -SipSignalingPort <int> [-BypassMode <string>] [-Description <string>] [-Enabled <boolean>] + [-FailoverResponseCodes <string>] [-FailoverTimeSeconds <int>] [-ForwardCallHistory <boolean>] [-ForwardPai <boolean>] [-GatewayLbrEnabledUserOverride <boolean>] + [-GatewaySiteId <string>] [-GatewaySiteLbrEnabled <boolean>] [-InboundPstnNumberTranslationRules <Object>] [-InboundTeamsNumberTranslationRules <Object>] + [-MaxConcurrentSessions <int>] [-MediaBypass <boolean>] [-MediaRelayRoutingLocationOverride <string>] [-OutboundPstnNumberTranslationRules <Object>] + [-OutboundTeamsNumberTranslationRules <Object>] [-PidfLoSupported <boolean>] [-ProxySbc <string>] [-SendSipOptions <boolean>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsOnlinePSTNGateway -SipSignalingPort <int> -Fqdn <string> [-BypassMode <string>] [-Description <string>] [-Enabled <boolean>] + [-FailoverResponseCodes <string>] [-FailoverTimeSeconds <int>] [-ForwardCallHistory <boolean>] [-ForwardPai <boolean>] [-GatewayLbrEnabledUserOverride <boolean>] + [-GatewaySiteId <string>] [-GatewaySiteLbrEnabled <boolean>] [-InboundPstnNumberTranslationRules <Object>] [-InboundTeamsNumberTranslationRules <Object>] + [-MaxConcurrentSessions <int>] [-MediaBypass <boolean>] [-MediaRelayRoutingLocationOverride <string>] [-OutboundPstnNumberTranslationRules <Object>] + [-OutboundTeamsNumberTranslationRules <Object>] [-PidfLoSupported <boolean>] [-ProxySbc <string>] [-SendSipOptions <boolean>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to create a new Session Border Controller (SBC) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as the SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP Options, and specify the limit of maximum concurrent sessions. The cmdlet also lets the administrator drain the SBC by setting parameter -Enabled to $true or $false state. When the Enabled parameter is set to $false, the SBC will continue existing calls, but all new calls will be routed to another SBC in a route (if one exists). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsOnlinePSTNGateway -FQDN sbc.contoso.com -SIPSignalingPort 5061 +``` + +This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. All others parameters will stay default. Note the SBC will be in the disabled state. + +### Example 2 +```powershell +PS C:\> New-CsOnlinePSTNGateway -FQDN sbc.contoso.com -SIPSignalingPort 5061 -ForwardPAI $true -Enabled $true +``` + +This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. For each outbound to SBC session, the Direct Routing interface will report in P-Asserted-Identity fields the TEL URI and SIP address of the user who made a call. This is useful when a tenant administrator sets the identity of the caller as "Anonymous" or a general number of the company, but for billing purposes the real identity of the user is required. + +## PARAMETERS + +### -Description +Free-format string to describe the gateway. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverResponseCodes +If Direct Routing receives any 4xx or 6xx SIP error code in response to an outgoing Invite the call is considered completed by default. (Outgoing in this context is a call +from a Teams client to the PSTN with traffic flow: Teams Client -> Direct Routing -> SBC -> Telephony network). Setting the SIP codes in this parameter forces Direct Routing +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 +System Direct Routing" documentation. + +Setting this parameter overwrites the default values, so if you want to include the default values, please add them to string. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: 408, 503, 504 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverTimeSeconds +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardCallHistory +Indicates whether call history information will be forwarded to the SBC. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). + +```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 +``` + +### -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). 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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewaySiteId +PSTN Gateway Site Id. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +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). + +```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 +``` + +### -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. + +```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 +``` + +### -Identity +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 +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBypass +Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC. + +```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 +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: $false +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. + +```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 +``` + +### -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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```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 +``` + +### -ProxySbc +The FQDN of the proxy SBC. Used in Local Media Optimization configurations. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) + +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) + +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/New-CsOnlineSchedule.md b/teams/teams-ps/teams/New-CsOnlineSchedule.md new file mode 100644 index 0000000000..321a1e96c4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineSchedule.md @@ -0,0 +1,324 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsOnlineSchedule + +## SYNOPSIS +Use the New-CsOnlineSchedule cmdlet to create a new schedule. + +## SYNTAX + +### WeeklyRecurrentSchedule +```powershell +New-CsOnlineSchedule -Name <String> -WeeklyRecurrentSchedule [-MondayHours <List>] [-TuesdayHours <List>] [-WednesdayHours <List>] [-ThursdayHours <List>] [-FridayHours <List>] [-SaturdayHours <List>] [-SundayHours <List>] [-Complement] [-Tenant <Guid>] [<CommonParameters>] +``` + +### FixedSchedule +```powershell +New-CsOnlineSchedule -Name <String> -FixedSchedule [-DateTimeRanges <List>] [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsOnlineSchedule cmdlet creates a new schedule for the Auto Attendant (AA) service. The AA service uses schedules to conditionally execute call flows when a specific schedule is in effect. + +**NOTES**: + +- The type of the schedule cannot be altered after the schedule is created. +- Currently, only two types of schedules can be created: WeeklyRecurrentSchedule or FixedSchedule. +- The schedule types are mutually exclusive. So a weekly recurrent schedule cannot be a fixed schedule and vice versa. +- For a weekly recurrent schedule, at least one day should have time ranges specified. +- You can create a new time range by using New-CsOnlineTimeRange cmdlet. +- A fixed schedule can be created without any date-time ranges. In this case, it would never be in effect. +- For a fixed schedule, at most 10 date-time ranges can be specified. +- You can create a new date-time range for a fixed schedule by using the New-CsOnlineDateTimeRange cmdlet. +- The return type of this cmdlet composes a member for the underlying type/implementation. For example, in case of the weekly recurrent schedule, you can modify Monday's time ranges through the Schedule.WeeklyRecurrentSchedule.MondayHours property. Similarly, date-time ranges of a fixed schedule can be modified by using the Schedule.FixedSchedule.DateTimeRanges property. +- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation). + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +$tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 +$tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 +$businessHours = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1, $tr2) -TuesdayHours @($tr1, $tr2) -WednesdayHours @($tr1, $tr2) -ThursdayHours @($tr1, $tr2) -FridayHours @($tr1, $tr2) +``` + +This example creates a weekly recurrent schedule that is active on Monday-Friday from 9AM-12PM and 1PM-5PM. + +### -------------------------- Example 2 -------------------------- +```powershell +$tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 +$tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 +$afterHours = New-CsOnlineSchedule -Name " After Hours" -WeeklyRecurrentSchedule -MondayHours @($tr1, $tr2) -TuesdayHours @($tr1, $tr2) -WednesdayHours @($tr1, $tr2) -ThursdayHours @($tr1, $tr2) -FridayHours @($tr1, $tr2) -Complement +``` + +This example creates a weekly recurrent schedule that is active at all times except Monday-Friday, 9AM-12PM and 1PM-5PM. + +### -------------------------- Example 3 -------------------------- +```powershell +$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" +$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) +``` + +This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017. + +### -------------------------- 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" +$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr1, $dtr2) +``` + +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 -------------------------- +```powershell +$notInEffectSchedule = New-CsOnlineSchedule -Name "NotInEffect" -FixedSchedule +``` + +This example creates a fixed schedule that is never active. + +## PARAMETERS + +### -Name +The Name parameter represents a unique friendly name for the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MondayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TuesdayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WednesdayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThursdayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FridayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaturdayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SundayHours +List of time ranges for that day. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixedSchedule +The FixedSchedule parameter indicates that a fixed schedule is to be created. + +```yaml +Type: SwitchParameter +Parameter Sets: FixedSchedule +Aliases: +applicable: Microsoft Teams + +Required: True +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. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: FixedSchedule +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule + +## NOTES + +## RELATED LINKS + +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) + +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) + +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) + +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) + +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md new file mode 100644 index 0000000000..e60b5f483c --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md @@ -0,0 +1,276 @@ +--- +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 +manager: mreddy +author: TristanChen-msft +ms.author: jiaych +ms.reviewer: julienp +--- + +# New-CsOnlineTelephoneNumberOrder + +## SYNOPSIS +Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. + +## SYNTAX + +``` +New-CsOnlineTelephoneNumberOrder [-Name] <orderName> [-Description] <orderDescription> [-Country] <countryCode> [-NumberType] <numberType> [-Quantity] <quantity> [-CivicAddressId] <civicAddressId> [-NumberPrefix] <numberPrefix> [-AreaCode] <areaCode> [<CommonParameters>] +``` + +## DESCRIPTION + +Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. Use the `Get-CsOnlineTelephoneNumberType` cmdlet to find out the supported types of searches for each NumberType and construct the search request demonstrated below: + +Telephone numbers can be created with 3 ways: + +- **Civic Address Search**: A telephone number search order can be created base on a given civic address ID. The service will look up the address and fulfill the search order using available telephone numbers local to the given address. For civic address based search, the parameter `CivicAddressId` is required. + +- **Number Prefix Search**: A telephone number search order can be created base on a given number prefix. The number prefix search allow the tenant to acquire telephone numbers with a fixed number prefix. For number prefix based search, the parameter `NumberPrefix` is required. + +- **Area Code Selection Search**: A telephone number search order can be created base on a give area code. Certain service numbers are only offered with a dedicated set of area codes. With area code selection search, the tenant can acquire the desired telephone numbers by area code. For area code selection based search, the parameter `AreaCode` is required. + +## EXAMPLES + +### -------------------------- 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 + +AreaCode : +CivicAddressId : 3b175352-4131-431e-970c-273226b8fb46 +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : Civic address search example +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : Example 1 +NumberPrefix : +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : CivicAddress +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +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 -------------------------- +``` +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 + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : Number prefix search example +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : Example 2 +NumberPrefix : +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +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 -------------------------- +``` +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 + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : Area code selection search example +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Service +IsManual : False +Name : Example 3 +NumberPrefix : +NumberType : ConferenceTollFree +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : AreaCodeSelection +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +Toll Free +18002000004 +``` + +This example demonstrates an area code selection based telephone number search. Telephone number +18002000004 is found to have the desired area code and is reserved for purchase. + +## PARAMETERS + +### Name +Specifies the telephone number search order name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Description +Specifies the telephone number search order description. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Country +Specifies the telephone number search order country/region. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries/regions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### NumberType +Specifies the telephone number search order number type. Use `Get-CsOnlineTelephoneNumberType` to find the supported number types. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Quantity +Specifies the telephone number search order quantity. The number of allowed quantity is based on the tenant licenses. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CivicAddressId +Specifies the telephone number search order civic address. CivicAddressId is required for civic address based search and when RequiresCivicAddress is true for a given NumberType. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### NumberPrefix +Specifies the telephone number search order number prefix. NumberPrefix is required for number prefix based search. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### AreaCode +Specifies the telephone number search order number area code. AreaCode is required for area code selection based search. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) + +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md new file mode 100644 index 0000000000..b9ccb97cab --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version:online version: https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder +applicable: Microsoft Teams +title: New-CsOnlineTelephoneNumberReleaseOrder +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# New-CsOnlineTelephoneNumberReleaseOrder + +## SYNOPSIS +This cmdlet creates a request to release Direct Routing telephone numbers from Microsoft Teams telephone number management inventory. + +## SYNTAX + +``` +New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber <String>] [-StartingNumber <String>] [-EndingNumber <String>] [-FileContent <Byte[]>] [<CommonParameters>] +``` + +## 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-CsOnlineTimeRange.md b/teams/teams-ps/teams/New-CsOnlineTimeRange.md new file mode 100644 index 0000000000..e331b4ffe5 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineTimeRange.md @@ -0,0 +1,110 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsOnlineTimeRange + +## SYNOPSIS +The New-CsOnlineTimeRange cmdlet creates a new time range. + +## SYNTAX + +``` +New-CsOnlineTimeRange -Start <TimeSpan> -End <TimeSpan> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsOnlineTimeRange cmdlet creates a new time range to be used with the Auto Attendant (AA) service. Time ranges are used to form schedules. + +**NOTES**: + +- The start bound of the range must be less than its end bound. +- Time ranges within a weekly recurrent schedule must align with 15-minute boundaries. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +$allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00 +``` + +This example creates a 24-hour time range. + +## PARAMETERS + +### -Start +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -End +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.TimeRange + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md new file mode 100644 index 0000000000..270d9deed1 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md @@ -0,0 +1,249 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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). + +## SYNTAX + +### Identity (Default) +``` +New-CsOnlineVoiceRoute [-Identity] <String> [-BridgeSourcePhoneNumber <String>] [-Description <String>] + [-NumberPattern <String>] [-OnlinePstnGatewayList <Object>] [-OnlinePstnUsages <Object>] [-Priority <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsOnlineVoiceRoute [-BridgeSourcePhoneNumber <String>] [-Description <String>] [-NumberPattern <String>] + [-OnlinePstnGatewayList <Object>] [-OnlinePstnUsages <Object>] [-Priority <Int32>] + -Name <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to create a new online voice route. All online voice routes are created at the Global scope. However, multiple global voice routes can be defined. This is accomplished through the Identity parameter, which requires a unique route name. + +Voice routes are associated with online voice policies through online PSTN usages. A voice route includes a regular expression that identifies which phone numbers will be routed through a given voice route: phone numbers matching the regular expression will be routed through this route. + +This cmdlet is used when configuring Microsoft Phone System Direct Routing. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> 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 -------------------------- +``` +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 -------------------------- +``` +PS C:\> $x = (Get-CsOnlinePstnUsage).Usage + +New-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add=$x} +``` + +This example creates a new online voice route named Route1 and populates that route's list of PSTN usages with all the existing usages for the organization. The first command in this example retrieves the list of global online PSTN usages. Notice that the call to the `Get-CsOnlinePstnUsage` cmdlet is in parentheses; this means that we first retrieve an object containing PSTN usage information. (Because there is only one, global, online PSTN usage, only one object will be retrieved.) The command then retrieves the Usage property of this object. That property, which contains a list of usages, is assigned to the variable $x. In the second line of this example, the `New-CsOnlineVoiceRoute` cmdlet is called to create a new online voice route. This voice route will have an identity of Route1. Notice the value passed to the OnlinePstnUsages parameter: @{add=$x}. This value says to add the contents of $x, which contain the phone usages list retrieved in line 1, to the list of online PSTN usages for this route. + +## PARAMETERS + +### -BridgeSourcePhoneNumber +BridgeSourcePhoneNumber is an E.164 formatted Operator Connect Conferencing phone number assigned to your Audio Conferencing Bridge. Using BridgeSourcePhoneNumber in an online voice route is mutually exclusive with using OnlinePstnGatewayList in the same online voice route. + +When using BridgeSourcePhoneNumber in an online voice route, the OnlinePstnUsages used in the online voice route should only be used in a corresponding OnlineAudioConferencingRoutingPolicy. The same OnlinePstnUsages should not be used in online voice routes that are not using BridgeSourcePhoneNumber. + +For more information about Operator Connect Conferencing, please see [Configure Operator Connect Conferencing](https://learn.microsoft.com/microsoftteams/operator-connect-conferencing-configure). + +```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 +A description of what this online voice route is for. + +```yaml +Type: String +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 online 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-CsOnlineVoiceRoute 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 +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +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 online 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 +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. + +Default: [0-9]{10} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnGatewayList +This parameter contains a list of online gateways associated with this online voice route. Each member of this list must be the service Identity of the online PSTN gateway. The service Identity is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, redmondpool.litwareinc.com. + +By default this list is empty. However, if you leave this parameter blank when creating a new voice route, you'll receive a warning message. + +```yaml +Type: PSListModifier +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, Long Distance, etc.) that can be applied to this online voice route. The PSTN usage must be an existing usage (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +By default this list is empty. However, if you leave this parameter blank when creating a new online voice route, you'll receive a warning message. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +A number could resolve to multiple online voice routes. The priority determines the order in which the routes will be applied if more than one route is possible. The lowest priority will be applied first and then in ascendant order. + +```yaml +Type: 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: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) + +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) + +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md new file mode 100644 index 0000000000..a4646da2fa --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md @@ -0,0 +1,160 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# New-CsOnlineVoiceRoutingPolicy + +## SYNOPSIS +Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +## SYNTAX + +### Identity +``` +New-CsOnlineVoiceRoutingPolicy [-Identity] <string> [-Description <string>] [-OnlinePstnUsages <Object>] [-RouteType <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Teams users an online voice routing policy enables those users to receive and to place phone calls to the public switched telephone network by using your on-premises SIP trunks. + +Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance", "Local", "Internal" +``` + +Example 2 is a variation of the command shown in Example 1; in this case, however, the new policy is assigned three online PSTN usages: Long Distance; Local; Internal. Multiple usages can be assigned simply by separating each usage using a comma. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the 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 an online 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: + +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 +``` + +### -OnlinePstnUsages +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online voice routing policy. The online PSTN usage must be an existing usage (PSTN usages can be retrieved by calling the `Get-CsOnlinePstnUsage` cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) + +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) + +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) + +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md new file mode 100644 index 0000000000..04a4f92099 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md @@ -0,0 +1,308 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +### Identity (Default) + +```powershell +New-CsOnlineVoicemailPolicy [-Identity] <string> [-EnableEditingCallAnswerRulesSetting <boolean>] [-EnableTranscription <boolean>] +[-EnableTranscriptionProfanityMasking <boolean>] [-EnableTranscriptionTranslation <boolean>] [-MaximumRecordingLength <timespan>] +[-PostAmbleAudioFile <string>] [-PreambleAudioFile <string>] [-PreamblePostambleMandatory <boolean>] +[-PrimarySystemPromptLanguage <string>] [-SecondarySystemPromptLanguage <string>] [-ShareData <string>] [-WhatIf] [-Confirm] [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. + +By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. + +- Voicemail transcription is enabled by default +- Transcription profanity masking is disabled by default +- Transcription translation is enabled by default +- Editing call answer rule settings is enabled by default +- Voicemail maximum recording length is set to 5 minutes by default +- Primary and secondary system prompt languages are set to null by default and the user's voicemail language setting is used + +Tenant admin would be able to create a customized online voicemail policy to match the organization's requirements. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) +``` + +The command shown in Example 1 creates a per-user online voicemail policy CustomOnlineVoicemailPolicy with MaximumRecordingLength set to 60 seconds and other fields set to tenant level global value. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -EnableEditingCallAnswerRulesSetting +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTranscription +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTranscriptionProfanityMasking +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTranscriptionTranslation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumRecordingLength +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostambleAudioFile +The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -PreambleAudioFile +The audio file to play to the caller before the user's voicemail greeting is played. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreamblePostambleMandatory +Is playing the Pre- or Post-amble mandatory before the caller can leave a message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySystemPromptLanguage +The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareData +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) + +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) + +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) + +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md b/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md new file mode 100644 index 0000000000..3c44267712 --- /dev/null +++ b/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md @@ -0,0 +1,92 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +online version: +title: New-CsSdgBulkSignInRequest +schema: 2.0.0 +--- + +# New-CsSdgBulkSignInRequest + +## SYNOPSIS +Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices. + +## SYNTAX + +``` +New-CsSdgBulkSignInRequest -DeviceDetailsFilePath <String> -Region <String> [<CommonParameters>] +``` + +## DESCRIPTION +Bulk Sign In for Teams SIP Gateway enables you to sign in a batch of devices in one go. This feature is intended for admins and works for shared devices. +The password for the shared device account is reset at runtime to an unknown value and the cmdlet uses the new credential for fetching token from Entra ID. Admins can sign in shared account remotely and in bulk using this feature. + +## EXAMPLES + +### Example 1 +```powershell +Import-Module MicrosoftTeams +$credential = Get-Credential // Enter your admin's email and password +Connect-MicrosoftTeams -Credential $credential +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC +``` + +This example shows how to connect to Microsoft Teams PowerShell module, and read the output of the New-SdgBulkSignInRequest cmdlet into a variable newBatchResponse. The cmdlet uses Example.csv as the device details file, and SIP Gateway region as APAC. + +### Example 2 +```powershell +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC +$newBatchResponse.BatchId +$getBatchStatusResponse = Get-CsSdgBulkSignInRequestStatus -Batchid $newBatchResponse.BatchId +$getBatchStatusResponse | ft +$getBatchStatusResponse.BatchItem +``` +This example shows how to view the status of a bulk sign in batch. + +## PARAMETERS + +### -DeviceDetailsFilePath +This is the path of the device details CSV file. The CSV file contains two columns - username and hardware ID, where username is of the format FirstFloorLobbyPhone1@contoso.com and hardware ID is the device MAC address in the format 1A-2B-3C-4D-5E-6F + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +This is the SIP Gateway region. Possible values include NOAM, EMEA, APAC. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..f71b11582d --- /dev/null +++ b/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/New-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: New-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +New-CsSharedCallQueueHistoryTemplate -Name <String> -Description <String> [-IncomingMissedCalls <Object>] [-AnsweredAndOutboundCalls <Object>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsSharedCallQueueHistoryTemplate -Name "Customer Service" -Description "Missed:All Answered:Auth" -IncomingMissedCall XXXXXX -AnsweredAndOutboundCalls XXXXX +``` + +This example creates a new Shared CallQueue History template where incoming missed calls are shown to authorized users and agents and, answered and outbound calls are shown to authorized users only. + +## PARAMETERS + +### -Name +The name of the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncomingMissedCalls +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Off +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnsweredAndOutboundCalls +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Off +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[Get-CsSharedCallQueueHistoryTemplate](./Get-CsSharedCallQueueHistoryTemplate.md) + +[Set-CsSharedCallQueueHistoryTemplate](./Set-CsSharedCallQueueHistoryTemplate.md) + +[Remove-CsSharedCallQueueHistoryTemplate](./Remove-CsSharedCallQueueHistoryTemplate.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/New-CsTeamTemplate.md b/teams/teams-ps/teams/New-CsTeamTemplate.md new file mode 100644 index 0000000000..4230e09bf3 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamTemplate.md @@ -0,0 +1,810 @@ +--- +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 <String> -DisplayName <String> -ShortDescription <String> + [-App <ITeamsAppTemplate[]>] [-Category <String[]>] [-Channel <IChannelTemplate[]>] + [-Classification <String>] [-Description <String>] [-DiscoverySetting <ITeamDiscoverySettings>] + [-FunSetting <ITeamFunSettings>] [-GuestSetting <ITeamGuestSettings>] [-Icon <String>] + [-IsMembershipLimitedToOwner] [-MemberSetting <ITeamMemberSettings>] + [-MessagingSetting <ITeamMessagingSettings>] [-OwnerUserObjectId <String>] [-PublishedBy <String>] + [-Specialization <String>] [-TemplateId <String>] [-Uri <String>] [-Visibility <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### New + +```powershell +New-CsTeamTemplate -Locale <String> -Body <ITeamTemplate> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewViaIdentity + +```powershell +New-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> -Body <ITeamTemplate> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewViaIdentityExpanded + +```powershell +New-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> -DisplayName <String> + -ShortDescription <String> [-App <ITeamsAppTemplate[]>] [-Category <String[]>] + [-Channel <IChannelTemplate[]>] [-Classification <String>] [-Description <String>] + [-DiscoverySetting <ITeamDiscoverySettings>] [-FunSetting <ITeamFunSettings>] + [-GuestSetting <ITeamGuestSettings>] [-Icon <String>] [-IsMembershipLimitedToOwner] + [-MemberSetting <ITeamMemberSettings>] [-MessagingSetting <ITeamMessagingSettings>] + [-OwnerUserObjectId <String>] [-PublishedBy <String>] [-Specialization <String>] [-TemplateId <String>] + [-Uri <String>] [-Visibility <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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 <ITeamsAppTemplate[]>: 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 <String>]`: Gets or sets the app's ID in the global apps catalog. + +BODY \<ITeamTemplate\>: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName <String>`: Gets or sets the team's DisplayName. +- `ShortDescription <String>`: Gets or sets template short description. +- `[App <ITeamsAppTemplate[]>]`: 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 <String>]`: Gets or sets the app's ID in the global apps catalog. +- `[Category <String[]>]`: Gets or sets list of categories. +- `[Channel <IChannelTemplate[]>]`: Gets or sets the set of channel templates included in the team template. + - `[Description <String>]`: Gets or sets channel description as displayed to users. + - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. + - `[Id <String>]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault <Boolean?>]`: 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 <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. + - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id <String>]`: Gets or sets identifier for the channel tab template. + - `[Key <String>]`: Gets a unique identifier. + - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name <String>]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. +- `[Classification <String>]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description <String>]`: Gets or sets the team's Description. +- `[DiscoverySetting <ITeamDiscoverySettings>]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting <ITeamFunSettings>]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. +- `[GuestSetting <ITeamGuestSettings>]`: Guest role settings for the team. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon <String>]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner <Boolean?>]`: 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 <ITeamMemberSettings>]`: Member role settings for the team. + - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting <ITeamMessagingSettings>]`: 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 <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId <String>]`: 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 <String>]`: Gets or sets published name. +- `[Specialization <String>]`: 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 <String>]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri <String>]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility <String>]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL <IChannelTemplate[]>: Gets or sets the set of channel templates included in the team template. + +- `[Description <String>]`: Gets or sets channel description as displayed to users. +- `[DisplayName <String>]`: Gets or sets channel name as displayed to users. +- `[Id <String>]`: Gets or sets identifier for the channel template. +- `[IsFavoriteByDefault <Boolean?>]`: 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 <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. + - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id <String>]`: Gets or sets identifier for the channel tab template. + - `[Key <String>]`: Gets a unique identifier. + - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name <String>]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \<ITeamDiscoverySettings\>: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \<ITeamFunSettings\>: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. + +GUESTSETTING \<ITeamGuestSettings\>: Guest role settings for the team. + +- `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter + +- `[Bssid <String>]`: +- `[ChassisId <String>]`: +- `[CivicAddressId <String>]`: Civic address id. +- `[Country <String>]`: +- `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. +- `[Id <String>]`: +- `[Identity <String>]`: +- `[Locale <String>]`: +- `[LocationId <String>]`: Location id. +- `[OdataId <String>]`: A composite URI of a template. +- `[OperationId <String>]`: The ID of a batch policy assignment operation. +- `[OrderId <String>]`: +- `[PackageName <String>]`: The name of a specific policy package +- `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. +- `[Port <String>]`: +- `[PortInOrderId <String>]`: +- `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. +- `[SubnetId <String>]`: +- `[TenantId <String>]`: +- `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \<ITeamMemberSettings\>: Member role settings for the team. + +- `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \<ITeamMessagingSettings\>: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage <Boolean>`: 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) diff --git a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md b/teams/teams-ps/teams/New-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..4a7ff4af67 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsAIPolicy.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# New-CsTeamsAIPolicy + +## SYNOPSIS +This cmdlet creates a Teams AI policy. + +## SYNTAX + +```powershell +New-CsTeamsAIPolicy -Identity <String> + [-EnrollFace <string>] + [-EnrollVoice <string>] + [-SpeakerAttributionBYOD <string>] + [-Description <string>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet creates a Teams AI policy. If you get an error that the policy already exists, it means that the policy already exists for your tenant. In this case, run Get-CsTeamsAIPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsAIPolicy -Identity Test +``` +Creates a new Teams AI policy with the specified identity. +The newly created policy with value will be printed on success. + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollFace +Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollVoice +Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md new file mode 100644 index 0000000000..ff4308f76f --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md @@ -0,0 +1,67 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: New-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# New-CsTeamsAppPermissionPolicy + +## SYNOPSIS + +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies> and about app centric management at <https://learn.microsoft.com/microsoftteams/app-centric-management>. + +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + +## SYNTAX + +``` +New-CsTeamsAppPermissionPolicy [[-Identity] <String>] + [-Confirm] + [-DefaultCatalogApps <DefaultCatalogApp[]>] + [-DefaultCatalogAppsType <String>] + [-Description <String>] + [-Force] + [-GlobalCatalogApps <GlobalCatalogApp[]>] + [-GlobalCatalogAppsType <String>] + [-InMemory] + [-PrivateCatalogApps <PrivateCatalogApp[]>] + [-PrivateCatalogAppsType <String>] + [-Tenant <Object>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies>. + +## EXAMPLES + +### Example 1 +Intentionally omitted. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..ff00d0c8a6 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsappsetuppolicy +applicable: Microsoft Teams +title: New-CsTeamsAppSetupPolicy +schema: 2.0.0 +--- + +# New-CsTeamsAppSetupPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. + +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +``` +New-CsTeamsAppSetupPolicy [-Identity] <String> + [-AllowSideLoading <Boolean>] + [-AllowUserPinning <Boolean>] + [-AppPresetList <Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[]>] + [-Confirm] + [-Description <String>] + [-Force] + [-PinnedAppBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[]>] + [-PinnedCallingBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[]>] + [-PinnedMessageBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[]>] + [-AppPresetMeetingList <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting]>] + [-AdditionalCustomizationApps <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp]>] + [-Tenant <System.Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## EXAMPLES + +### Example 1 + +```powershell +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) +``` +Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Policy configuration is used by default. + +### Example 2 + +```powershell +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AllowUserPinning $true +``` +Create a new TeamsAppSetupPolicy. Users can upload a custom app package in the Teams app because AllowSideLoading is set as True, and existing app pins can be added to the list of pinned apps because AllowUserPinning is set as True. + +### Example 3 + +```powershell +# Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps +$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} +$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} +$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} +$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) + +# Settings to pin these apps to the app bar in Teams client. +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowUserPinning $true -PinnedAppBarApps $PinnedAppBarApps +``` + +Create a new TeamsAppSetupPolicy and pin ActivityApp, ChatApp, TeamsApp apps to the app bar in Teams client by setting these apps as PinnedAppBarApps. + +### Example 4 + +```powershell +# Set VivaConnectionsApp as PinnedMessageBarApps +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$PinnedMessageBarApps = @($VivaConnectionsApp) +# Settings to pin these apps to the messaging extension in Teams client. +Set-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowUserPinning $true -PinnedMessageBarApps $PinnedMessageBarApps +``` + +Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by setting these apps as PinnedMessageBarApps. + +### Example 5 + +```powershell +# Set VivaConnectionsApp as AppPresetList +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$AppPresetList = @($VivaConnectionsApp) +# Settings to install these apps in your users' personal Teams environment +Set-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AppPresetList $AppPresetList +``` + +Create a new TeamsAppSetupPolicy and install VivaConnections App in users' personal Teams environment by setting these apps as AppPresetList. + +## PARAMETERS + +### -Identity +Name of App setup policy. If empty, all Identities will be used by default. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSideLoading +This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your organization without having to submit it to the Teams app store. Uploading a custom app also lets you test an app before you distribute it more widely by only assigning it to a single user or group of users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserPinning +If you turn this on, the user's existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user's existing app pins will be removed and replaced with the apps defined in this policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetList +Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the app setup policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedMessageBarApps +Apps are pinned in messaging extensions and into the ellipsis menu. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetMeetingList +This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md new file mode 100644 index 0000000000..e95b230bdc --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md @@ -0,0 +1,163 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy +title: New-CsTeamsAudioConferencingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsAudioConferencingPolicy + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsAudioConferencingPolicy [-Identity] <String> [-AllowTollFreeDialin <Boolean>] [-Force] [-InMemory] + [-MeetingInvitePhoneNumbers <Object>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-CsTeamsAudioConferencingPolicy cmdlet enables administrators to control audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. This cmdlet creates a new Teams audio conferencing policy. Custom policies can then be assigned to users using the Grant-CsTeamsAudioConferencingPolicy cmdlet. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> New-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $False +``` + +The command shown in Example 1 uses the New-CsTeamsAudioConferencingPolicy cmdlet to create a new audio-conferencing policy with the Identity "EMEA users". This policy will use all the default values for a meeting policy except one: AllowTollFreeDialin; in this example, meetings created by users with this policy cannot include Toll Free phone numbers. + +### EXAMPLE 2 +``` +PS C:\> New-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $True -MeetingInvitePhoneNumbers "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ" +``` + +The command shown in Example 2 uses the New-CsTeamsAudioConferencingPolicy cmdlet to create a new audio-conferencing policy with the Identity "EMEA users". This policy will use all the default values for a meeting policy except one: MeetingInvitePhoneNumbers; in this example, meetings created by users with this policy will include the following toll and toll free phone numbers "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ". + +## PARAMETERS + +### -AllowTollFreeDialin +Determines whether users of the Policy can have Toll free numbers + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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 +``` + +### -Identity +Specify the name of the policy that you are creating + +```yaml +Type: String +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- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInvitePhoneNumbers +Determines the list of audio-conferencing Toll- and Toll-free telephone numbers that will be included in meetings invites created by users of this policy. + +```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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Object +## NOTES + +## RELATED LINKS + +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) + +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) + +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md new file mode 100644 index 0000000000..92744364e9 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy +applicable: Microsoft Teams +title: New-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# New-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Creates a new Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +``` +New-CsTeamsCallHoldPolicy [-Identity] <string> [-Description <string>] [-AudioFileId <string>] [-StreamingSourceUrl <string>] [-StreamingSourceAuthType <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -Description "country music" -AudioFileID "c65233-ac2a27-98701b-123ccc" +``` + +The command shown in Example 1 creates a new, per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. +This policy is assigned the audio file ID: c65233-ac2a27-98701b-123ccc, which is the ID referencing an audio file that was uploaded using the Import-CsOnlineAudioFile cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their call holds customized such that the user being held will hear the audio file specified by AudioFileId. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams call hold policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceAuthType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md new file mode 100644 index 0000000000..ba4ca721a7 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md @@ -0,0 +1,225 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +### Identity (Default) +```powershell +New-CsTeamsCallParkPolicy [-Tenant <System.Guid>] [-AllowCallPark <Boolean>] [[-Identity] <XdsIdentity>] [-PickupRangeStart <Integer>] [-PickupRangeEnd <Integer>] [-ParkTimeoutSeconds <Integer>] [-Force] [-WhatIf] [-Confirm] [-Description <String>] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsCallParkPolicy -Identity "SalesPolicy" -AllowCallPark $true +``` + +Create a new custom policy that has call park enabled. This policy can then be assigned to individual users. + +### Example 2 +```powershell +PS C:\> New-CsTeamsCallParkPolicy -Identity "SalesPolicy" -AllowCallPark $true -PickupRangeStart 500 -PickupRangeEnd 1500 +``` + +Create a new custom policy that has call park enabled. This policy will generate pickup numbers starting from 500 and up until 1500. + +### Example 3 +```powershell +PS C:\> New-CsTeamsCallParkPolicy -Identity "SalesPolicy" -AllowCallPark $true -ParkTimeoutSeconds 600 +``` + +Create a new custom call park policy which will ring back the parker after 600 seconds if the parked call is unanswered + +## PARAMETERS + +### -AllowCallPark +If set to true, customers will be able to leverage the call park feature to place calls on hold and then decide how the call should be handled - transferred to another department, retrieved using the same phone, or retrieved using a different phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier for the policy - this will be used to retrieve the policy later on to assign it to specific users. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +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. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 99 +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). + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 300 +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. + +Note: PickupRangeStart must be smaller than PickupRangeEnd. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 10 +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..638a131b09 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md @@ -0,0 +1,732 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy +applicable: Microsoft Teams +title: New-CsTeamsCallingPolicy +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: alejandramu +--- + +# New-CsTeamsCallingPolicy + +## SYNOPSIS +Use this cmdlet to create a new instance of a Teams Calling Policy. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsCallingPolicy [-Identity] <string> + [-AIInterpreter <string>] + [-AllowCallForwardingToPhone <boolean>] + [-AllowCallForwardingToUser <boolean>] + [-AllowCallGroups <boolean>] + [-AllowCallRedirect <string>] + [-AllowCloudRecordingForCalls <boolean>] + [-AllowDelegation <boolean>] + [-AllowPrivateCalling <boolean>] + [-AllowSIPDevicesCalling <boolean>] + [-AllowTranscriptionForCalling <boolean>] + [-AllowVoicemail <string>] + [-AllowWebPSTNCalling <boolean>] + [-AutoAnswerEnabledType <string>] + [-BusyOnBusyEnabledType <string>] + [-CallingSpendUserLimit <long>] + [-CallRecordingExpirationDays <long>] + [-Confirm] + [-Copilot <string>] + [-Description <string>] + [-EnableSpendLimits <boolean>] + [-EnableWebPstnMediaBypass <Boolean>] + [-Force] + [-InboundFederatedCallRoutingTreatment <string>] + [-InboundPstnCallRoutingTreatment <string>] + [-LiveCaptionsEnabledTypeForCalling <string>] + [-MusicOnHoldEnabledType <string>] + [-PopoutAppPathForIncomingPstnCalls <string>] + [-PopoutForIncomingPstnCalls <string>] + [-PreventTollBypass <boolean>] + [-SpamFilteringEnabledType <string>] + [-VoiceSimulationInInterpreter <string>] + [-RealTimeText <string>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to create new policy instances. + +## EXAMPLES + +### Example 1 +``` +PS C:\> New-CsTeamsCallingPolicy -Identity Sales -AllowPrivateCalling $false +``` + +The cmdlet create the policy instance Sales and sets the value of the parameter AllowPrivateCalling to False. The rest of the parameters are set to the corresponding +values in the Global policy instance. + +## PARAMETERS + +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToPhone +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToUser +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallGroups +Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallRedirect +Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. + +Valid options are: +- Enabled: Enables the user to redirect an incoming call. +- Disabled: The user is not enabled to redirect an incoming call. + +- UserOverride: This option is not available for use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecordingForCalls +Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDelegation +Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateCalling +Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. +If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSIPDevicesCalling +Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscriptionForCalling +Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVoicemail +Enables inbound calls to be routed to voicemail. + +Valid options are: + +- AlwaysEnabled: Calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user. +- AlwaysDisabled: Calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams. +- UserOverride: Calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebPSTNCalling +Allows PSTN calling from the Team web client. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAnswerEnabledType +Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams Phones. This setting applies only to incoming meeting invites and does not include support for other call types. + +Valid options are: + +- Enabled: Auto-answer is enabled. +- Disabled: Auto-answer is disabled. This is the default setting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BusyOnBusyEnabledType +Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. + +Valid options are: + +- Enabled: New or incoming calls will be rejected with a busy signal. +- Unanswered: The user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. +- Disabled: New or incoming calls will be presented to the user. +- UserOverride: Users can set their busy options directly from call settings in Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallingSpendUserLimit +The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. + +Possible values: any positive integer + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallRecordingExpirationDays +Sets the expiration of the recorded 1:1 calls. Default is 60 days. + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. + +Valid options are: +- Enabled: Copilot can work with or without transcription during calls. This is the default value. +- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. +- Disabled: Copilot is disabled for calls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpendLimits +This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. + +Possible values: + +- True +- False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWebPstnMediaBypass +Determines if MediaBypass is enabled for PSTN calls on specified Web platforms. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundFederatedCallRoutingTreatment +Setting this parameter lets you control how inbound federated calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound federated call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. + +- Voicemail: The inbound federated call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPstnCallRoutingTreatment +Setting this parameter lets you control how inbound PSTN calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound PSTN call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. +- Voicemail: The inbound PSTN call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. +- UserOverride: For now, setting the value to UserOverride is the same as RegularIncoming. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledTypeForCalling +Determines whether real-time captions are available for the user in Teams calls. + +Valid options are: + +- DisabledUserOverride: Allows the user to turn on live captions. +- Disabled: Prohibits the user from turning on live captions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldEnabledType +Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. + +Valid options are: + +- Enabled: Music on hold is enabled. This is the default. +- Disabled: Music on hold is disabled. +- UserOverride: For now, setting the value to UserOverride is the same as Enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutAppPathForIncomingPstnCalls +Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: "" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutForIncomingPstnCalls +Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventTollBypass +Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. + +> [!NOTE] +> Do not set this parameter to True for Calling Plan or Operator Connect users as it will prevent successful call routing. This setting only works with Direct Routing which is configured to handle location-based routing restrictions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamFilteringEnabledType +Determines Spam filtering mode. + +Possible values: + +- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. +- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. +- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md new file mode 100644 index 0000000000..fd19f2ca12 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md @@ -0,0 +1,258 @@ +--- +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 +schema: 2.0.0 +--- + +# New-CsTeamsChannelsPolicy + +## SYNOPSIS + +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +## SYNTAX +``` +New-CsTeamsChannelsPolicy [-Tenant <Guid>] [-AllowOrgWideTeamCreation <Boolean>] + [-EnablePrivateTeamDiscovery <Boolean>] [-AllowPrivateChannelCreation <Boolean>] + [-AllowUserToParticipateInExternalSharedChannel <Boolean>] [-AllowChannelSharingToExternalUser <Boolean>] [-AllowSharedChannelCreation <Boolean>] [-ThreadedChannelCreation <String>] + [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +This cmdlet allows you to create new policies of this type, which can later be assigned to specific users. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsChannelsPolicy -Identity StudentPolicy -EnablePrivateTeamDiscovery $false +``` + +This example shows creating a new policy with name "StudentPolicy" where Private Team Discovery is disabled. + +## PARAMETERS + +### -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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Bypasses all non-fatal errors. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreadedChannelCreation +This setting enables/disables Threaded Channel creation and editing. + +Possible Values: +- Enabled: Users are allowed to create and edit Threaded Channels. +- Disabled: Users are not allowed to create and edit Threaded Channels. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy) + +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) + +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) + +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md new file mode 100644 index 0000000000..a08b36dfb9 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md @@ -0,0 +1,443 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: New-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# New-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Creates a new association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-RequiredBeforeMeetingJoin <Boolean>] [-RequiredDuringMeeting <Boolean>] + [-RequiredBeforeCallEstablishment <Boolean>] [-RequiredDuringCall <Boolean>] + [-ConcurrentInvitationCount <UInt32>] [-ComplianceRecordingPairedApplications <ComplianceRecordingPairedApplication[]>] + [-Priority <Int32>] [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] -Parent <String> -Id <String> + [-RequiredBeforeMeetingJoin <Boolean>] [-RequiredDuringMeeting <Boolean>] + [-RequiredBeforeCallEstablishment <Boolean>] [-RequiredDuringCall <Boolean>] + [-ConcurrentInvitationCount <UInt32>] [-ComplianceRecordingPairedApplications <ComplianceRecordingPairedApplication[]>] + [-Priority <Int32>] [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' +``` + +The command shown in Example 1 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +### Example 2 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' +``` + +The command shown in Example 2 is a variation of Example 1. +It also creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy, but it does this by using the Parent and Id parameters instead of the Identity parameter. + +### Example 3 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false +``` + +The command shown in Example 3 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is deemed optional for meetings but mandatory for calls. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. + +### Example 4 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeCallEstablishment $false -RequiredDuringCall $false +``` + +The command shown in Example 4 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is deemed optional for calls but mandatory for meetings. +Please refer to the documentation of the RequiredBeforeCallEstablishment and RequiredDuringCall parameters for more information. + +### Example 5 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -ConcurrentInvitationCount 2 +``` + +The command shown in Example 5 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by specifying that two invites must be sent to the same application for the same call or meeting. +Please refer to the documentation of the ConcurrentInvitationCount parameter for more information. + +### Example 6 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +The command shown in Example 6 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by pairing it with another application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +Separate invites are sent to the paired applications for the same call or meeting. +Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. + +## PARAMETERS + +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. + +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent +The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. +For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. +For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. + +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. + +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. + +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. + +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. + +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. + +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. + +All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. +So this parameter does not affect the order of invitations to the applications, or any other routing. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md new file mode 100644 index 0000000000..d444f6ae79 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication +applicable: Microsoft Teams +title: New-CsTeamsComplianceRecordingPairedApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# New-CsTeamsComplianceRecordingPairedApplication + +## SYNOPSIS +Creates a new association between multiple application instances of policy-based recording applications to achieve application resiliency in automatic policy-based recording scenarios. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +``` +New-CsTeamsComplianceRecordingPairedApplication -Id <String> + [<CommonParameters>] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application, to determine if application resiliency is needed for your workflows, and how best to achieve application resiliency. +Please also refer to the documentation of CsTeamsComplianceRecordingApplication cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144' +``` + +The command shown in Example 1 creates an in-memory instance of an application instance of a policy-based recording application that can be associated with other such application instances to achieve application resiliency. + +Note that this cmdlet is only used in conjunction with New-CsTeamsComplianceRecordingApplication and Set-CsTeamsComplianceRecordingApplication to create associations between multiple application instances of policy-based recording applications. +Please refer to the documentation of CsTeamsComplianceRecordingApplication cmdlets for examples and further information. + +## PARAMETERS + +### -Id +The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. +For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md new file mode 100644 index 0000000000..e1caae78f9 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md @@ -0,0 +1,346 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: New-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +--- + +# New-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +```powershell +New-CsTeamsComplianceRecordingPolicy [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-Enabled <Boolean>] [-WarnUserOnRemoval <Boolean>] [-DisableComplianceRecordingAudioNotificationForCalls <Boolean>] + [-RecordReroutedCalls <Boolean>] [-Description <String>] + [-ComplianceRecordingApplications <ComplianceRecordingApplication[]>] [-CustomBanner <Guid>] + [-CustomPromptsEnabled <Boolean>] [-CustomPromptsPackageId <String>] + [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899') +``` + +The command shown in Example 1 creates a new per-user Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. +This policy is assigned a single application instance of a policy-based recording application: d93fefc7-93cc-4d44-9a5d-344b0fff2899, which is the ObjectId of the application instance as obtained from the Get-CsOnlineApplicationInstance cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by that application instance. Existing calls and meetings are unaffected. + +### Example 2 +```powershell +PS C:\> New-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899'), @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +Example 2 is a variation of Example 1. +In this case, the Teams recording policy is assigned two application instances of policy-based recording applications. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by both those application instances. Existing calls and meetings are unaffected. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomBanner +References the Custom Banner text in the storage. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WarnUserOnRemoval +This parameter is reserved for future use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +```yaml +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPromptsEnabled +Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPromptsPackageId +Reference to custom prompts package. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md new file mode 100644 index 0000000000..247ea3b3a6 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: New-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +``` +New-CsTeamsCortanaPolicy [-Tenant <System.Guid>] [-Description <String>] [-CortanaVoiceInvocationMode <String>] + [-AllowCortanaVoiceInvocation <Boolean>] [-AllowCortanaAmbientListening <Boolean>] + [-AllowCortanaInContextSuggestions <Boolean>] [-Identity] <XdsIdentity> [-InMemory] [-Force] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +This cmdlet creates a new Teams Cortana policy. Custom policies can then be assigned to users using the Grant-CsTeamsCortanaPolicy cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -CortanaVoiceInvocationMode PushToTalkUserOverride +``` + +In this example, a new Teams Cortana Policy is created. Cortana voice invocation mode is set to 'push to talk' i.e. Cortana in Teams can be invoked by tapping on the Cortana mic button only. Wake word ("Hey Cortana") invocation is not allowed. + +## PARAMETERS + +### -AllowCortanaAmbientListening +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaInContextSuggestions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaVoiceInvocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CortanaVoiceInvocationMode +The value of this field indicates if Cortana is enabled and mode of invocation. +* Disabled - Cortana voice assistant is turned off and cannot be used. +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of your policy to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for Teams cortana policy you're creating. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText b/teams/teams-ps/teams/New-CsTeamsCustomBannerText new file mode 100644 index 0000000000..af23fbf760 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCustomBannerText @@ -0,0 +1,95 @@ +--- +Module Name: MicrosoftTeams +title: New-CsTeamsCustomBannerText +author: saleens7 +ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsCustomBannerText +schema: 2.0.0 +--- + +# New-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsCustomBannerText [[-Id] <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION + +Creates a single instance of a custom banner text. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsCustomBannerText -Identity CustomText +``` + +Creates an instance of TeamsCustomBannerText with the name CustomText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that the tenant admin would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that the tenant admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..4ed97c99b6 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md @@ -0,0 +1,95 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext +title: New-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# New-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsCustomBannerText [[-Id] <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION + +Creates a single instance of a custom banner text. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" +``` + +This example creates an instance of TeamsCustomBannerText with the name CustomText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that the global admin would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that the global admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md new file mode 100644 index 0000000000..0cc06eb366 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md @@ -0,0 +1,163 @@ +--- +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 +manger: roykuntz +ms.reviewer: chenc, vaddank +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyCallRoutingPolicy + +## SYNOPSIS +This cmdlet creates a new Teams Emergency Call Routing policy with one or more emergency number. + +## SYNTAX + +``` +New-CsTeamsEmergencyCallRoutingPolicy [-Identity] <string> [-AllowEnhancedEmergencyServices <bool>] + [-Description <string>] [-EmergencyNumbers <Object>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new Teams Emergency Call Routing policy with one or more emergency numbers. Teams Emergency Call Routing policy is used for the life cycle of emergency call routing - emergency numbers and routing configuration. + +## EXAMPLES + +### Example 1 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "911" -EmergencyDialMask "933" -OnlinePSTNUsage "USE911" +New-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{add=$en1} -AllowEnhancedEmergencyServices:$true -Description "test" +``` + +This example first creates a new Teams emergency number object and then creates a Teams Emergency Call Routing policy with this emergency number object. +Note that the OnlinePSTNUsage specified in the first command must previously exist. Note that the resulting object from the New-CsTeamsEmergencyNumber only exists in memory, so you must apply it to a policy to be used. +Note that {@add=....} will try to append a new emergency number to the values taken from the global instance. + +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "911" -EmergencyDialMask "933" -OnlinePSTNUsage "USE911" +New-CsTeamsEmergencyCallRoutingPolicy -Identity "testecrp" -EmergencyNumbers $en1 -AllowEnhancedEmergencyServices:$true -Description "test" +``` +This example overrides the global emergency numbers from the global instance. + +## PARAMETERS + +### -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 +``` + +### -AllowEnhancedEmergencyServices +Flag to enable Enhanced Emergency Services. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter describes the Teams Emergency Call Routing policy - what it's for, what type of user it applies to and any other information that helps to identify the purpose of this policy. Maximum characters: 512. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyNumbers +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) + +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) + +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) + +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md new file mode 100644 index 0000000000..693ea5b9cd --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification +applicable: Microsoft Teams +title: New-CsTeamsEmergencyCallingExtendedNotification +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyCallingExtendedNotification + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString <string> [-NotificationGroup <string>] + [-NotificationDialOutNumber <string>] [-NotificationMode <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports creating specific emergency calling notification settings per emergency phone number. It is used with TeamsEmergencyCallingPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +``` + +Creates an extended emergency calling notification for the emergency phone number 911 and stores it in the variable $en1. The variable should be added afterward to a TeamsEmergencyCallingPolicy instance. + +## PARAMETERS + +### -EmergencyDialString +Specifies the emergency phone number. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 entries consisting of users and/or groups can be added to the NotificationGroup. The total number of users notified cannot exceed 50. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. + +```yaml +Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..60f9db0fb7 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy +applicable: Microsoft Teams +title: New-CsTeamsEmergencyCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsEmergencyCallingPolicy [-Identity] <string> [-ExtendedNotifications <PSListModifier[TeamsEmergencyCallingExtendedNotification]>] + [-NotificationGroup <string>] [-NotificationDialOutNumber <string>] [-ExternalLocationLookupMode <ExternalLocationLookupMode>] + [-NotificationMode <NotificationMode>] [-EnhancedEmergencyServiceDisclaimer <string>] [-Description <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] + ``` + +## DESCRIPTION +This cmdlet creates a new Teams Emergency Calling policy. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Emergency calling policy Example 1 +In the following example, ECP1, an emergency calling policy with identify ECP1 is configured with full security desk configuration. Extended notifications for the test emergency number, 933, are set to null. +**ECP1** +<ul> + <li>Notification group: alert@contoso.com</li> + <li>Notification Dial Out Number - 14255551234</li> + <li>Notification Mode - Conferenced in and are unmuted</li> + <li>External Lookup Mode - On</li> +</ul> + +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "933" +New-CsTeamsEmergencyCallingPolicy -Identity ECP1 -Description "Test ECP1" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode ConferenceUnMuted -ExternalLocationLookupMode Enabled -ExtendedNotifications @{add=$en1} +``` + +### Emergency calling policy Example 2 +In the following example, ECP2, an emergency calling policy with identify ECP2 is configured with both 911 and 933 in the extended notification settings. Extended notifications for the test emergency number 911 are set to notify two groups separated by ";" and for 933 are set to null. +**ECP2** +<ul> + <li>Notification group: null</li> + <li>Notification Dial Out Number - null</li> + <li>Notification Mode - null</li> + <li>External Lookup Mode - On</li> +</ul> + +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert@contoso.com;567@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode ConferenceUnMuted +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "933" +New-CsTeamsEmergencyCallingPolicy -Identity ECP2 -Description "Test ECP2" -ExternalLocationLookupMode Enabled -ExtendedNotifications @{add=$en1,$en2} +``` + +## PARAMETERS + +### -Identity + The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter describes the Teams Emergency Calling policy - what it is for, what type of user it applies to and any other information that helps to identify the purpose of this policy. Maximum characters: 512. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnhancedEmergencyServiceDisclaimer +Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. The disclaimer can be up to 350 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedNotifications + +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. + +If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. + +```yaml +Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalLocationLookupMode +Enable ExternalLocationLookupMode. This mode allow users to set Emergency addresses for remote locations. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call via Teams chat. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and a maximum of 50 users in total can be notified. Both UPN and SMTP address are accepted when adding users directly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. +Possible values are NotificationOnly, ConferenceMuted, and ConferenceUnMuted. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) + +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md b/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md new file mode 100644 index 0000000000..9d89a4ced3 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md @@ -0,0 +1,107 @@ +--- +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 +manager: roykuntz +ms.reviewer: chenc, pthota +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyNumber + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsEmergencyNumber [-EmergencyDialString <String>] [-EmergencyDialMask <String>] + [-OnlinePSTNUsage <String>] [<CommonParameters>] +``` + +## DESCRIPTION + This cmdlet supports creating multiple Teams emergency numbers. Used with TeamsEmergencyCallRoutingPolicy and only relevant for Direct Routing. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsEmergencyNumber -EmergencyDialString 911 -EmergencyDialMask 933 -OnlinePSTNUsage "US911" +``` + + Create a new Teams emergency number + +### Example 2 +```powershell +PS C:\> New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "117;897" -OnlinePSTNUsage "EU112" +``` + +Create a new Teams emergency number with multiple emergency dial masks. + +## PARAMETERS + +### -EmergencyDialMask + For each Teams 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. Dial mask must be list of numbers separated by semicolon. Each number string must be made of the digits 0 through 9 and can be from 1 to 10 digits in length. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyDialString + Specifies the emergency phone number + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePSTNUsage + Specify the online public switched telephone network (PSTN) usage + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md new file mode 100644 index 0000000000..94d8089d7a --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -0,0 +1,189 @@ +--- +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 <Object>] [-CallingEndtoEndEncryptionEnabledType <Object>] [-MeetingEndToEndEncryption <Object>] + [[-Identity] <Object>] [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..778df29878 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md @@ -0,0 +1,391 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy +title: New-CsTeamsEventsPolicy +schema: 2.0.0 +ms.date: 04/23/2025 +--- + +# New-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +## SYNTAX + +```powershell +New-CsTeamsEventsPolicy [-Identity] <String> [-AllowWebinars <String>] [-AllowTownhalls <String>] [-AllowEmailEditing <String>] [-Description <String>] +[-TownhallEventAttendeeAccess <String>] [-RecordingForTownhall <String>] [-RecordingForWebinar <String>] +[-TranscriptionForTownhall <String>] [-TranscriptionForWebinar <String>] [-AllowEventIntegrations <Boolean>] [-TownhallChatExperience <String>] +[-UseMicrosoftECDN <String>] [-EventAccessType <String>] [-BroadcastPremiumApps <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests +``` + +The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. + +### Example 2 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled +``` + +The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. + +## PARAMETERS + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town hall. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType +This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. + +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + + - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting governs which types of town halls can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting governs which types of webinars can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs the access to the integrations tab in the event creation workflow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallChatExperience +This setting governs if the user can enable the Comment Stream chat experience for Townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..97eb4b84ce --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md @@ -0,0 +1,237 @@ +--- +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 +schema: 2.0.0 +--- + +# New-CsTeamsFeedbackPolicy + +## SYNOPSIS +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. + +## SYNTAX + +```powershell +New-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] <Object>] [-Tenant <Object>] [-InMemory] +[-AllowEmailCollection <Boolean>] [-AllowLogCollection <Boolean>] [-AllowScreenshotCollection <Boolean>] [-EnableFeatureSuggestions <Boolean>] + [-UserInitiatedMode <String>] [-ReceiveSurveysMode <String>] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to control whether users in your organization can send feedback about Teams to Microsoft through Give feedback and whether they receive the survey. By default, all users in your organization are automatically assigned the global (Org-wide default) policy and the Give feedback feature and survey are enabled in the policy. The exception is Teams for Education, where the features are enabled for teachers and disabled for students. For more information, visit [Manage feedback policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-feedback-policies-in-teams). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsFeedbackPolicy -identity "New Hire Feedback Policy" -userInitiatedMode disabled -receiveSurveysMode disabled +``` + +In this example, we create a feedback policy called New Hire Feedback Policy and we turn off the ability to give feedback through Give feedback and the survey. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the 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 +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +The InMemory parameter creates an object reference without actually committing the object as a permanent change. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailCollection +Set this to TRUE to enable Email collection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLogCollection +Set this to TRUE to enable log collection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFeatureSuggestions + This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..dca829ac76 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy +title: New-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# New-CsTeamsFilesPolicy + +## SYNOPSIS +Creates a new teams files policy. +teams files policies determine whether or not files entry points to sharepoint enabled for a user. +The policies also specify third party app id to allow file storage(eg. Box). + +## SYNTAX + +```powershell +New-CsTeamsFilesPolicy [-NativeFileEntryPoints <String>] [-SPChannelFilesTab <String>] + [-DefaultFileUploadAppId <String>] [-FileSharingInChatswithExternalUsers <String>] [-Identity] <String> + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +If your organization chooses a third-party for content storage, you can turn off the NativeFileEntryPoints parameter in the Teams Files policy. This parameter is enabled by default, which shows option to attach OneDrive / SharePoint content from Teams chats or channels. When this parameter is disabled, users won't see access points for OneDrive and SharePoint in Teams. Please note that OneDrive app in the left navigation pane in Teams isn't affected by this policy. +Teams administrators would be able to create a customized teams files policy to match the organization's requirements. + +## EXAMPLES + +### Example 1 +```powershell +New-CsTeamsFilesPolicy -Identity "CustomTeamsFilesPolicy" -NativeFileEntryPoints Disabled/Enabled +``` + +The command shown in Example 1 creates a per-user teams files policy CustomTeamsFilesPolicy with NativeFileEntryPoints set to Disabled/Enabled and other fields set to tenant level global value. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +``` + +### -DefaultFileUploadAppId +This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPChannelFilesTab + +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) + diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md new file mode 100644 index 0000000000..afae69de7e --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -0,0 +1,72 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsHiddenMeetingTemplate +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsHiddenMeetingTemplate +schema: 2.0.0 +--- + +# New-CsTeamsHiddenMeetingTemplate + +## SYNOPSIS +This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. + +## SYNTAX + +```powershell +New-CsTeamsHiddenMeetingTemplate -Id <string> [<CommonParameters>] +``` + +## DESCRIPTION + +Creates an object that can be supplied as `HiddenMeetingTemplate` to the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. + +## EXAMPLES + +### Example 1 - Creating a new hidden meeting template + +Creates a new hidden meeting template object: + +```powershell +PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +``` + +Creates a new HiddenMeetingTemplate object with the given template ID. + +For more examples of how this can be used, see the examples for [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy). + +## PARAMETERS + +### -Id + +ID of the meeting template to hide. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md new file mode 100644 index 0000000000..5df0f7b450 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md @@ -0,0 +1,69 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate +title: New-CsTeamsHiddenTemplate +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# New-CsTeamsHiddenTemplate + +## SYNOPSIS +This cmdlet is used to create a `HiddenTemplate` object for use with the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. + +## SYNTAX + +``` +New-CsTeamsHiddenTemplate -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +``` + +Creates a new hidden Teams template object. For more examples of how this can be used, see the examples for [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy). + +## PARAMETERS + +### -Id +ID of the Teams template to hide. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### HiddenTemplate.Cmdlets.HiddenTemplate + +## NOTES + +## RELATED LINKS +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md new file mode 100644 index 0000000000..93cdfa7a78 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsipphonepolicy +applicable: Microsoft Teams +title: New-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# New-CsTeamsIPPhonePolicy + +## SYNOPSIS + +New-CsTeamsIPPhonePolicy allows you to create a policy to manage features related to Teams phone experiences. Teams phone policies determine the features that are available to users. + +## SYNTAX + +``` +New-CsTeamsIPPhonePolicy [[-Identity] <XdsIdentity>] + [-AllowBetterTogether <String>] + [-AllowHomeScreen <String>] + [-AllowHotDesking <Boolean>] + [-Confirm] + [-Description <String>] + [-Force] + [-HotDeskingIdleTimeoutInMinutes <Int>] + [-InMemory] + [-SearchOnCommonAreaPhoneMode <Object>] + [-SignInMode <String>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION + +The New-CsTeamsIPPhonePolicy cmdlet allows you to create a policy to manage features related to Teams phone experiences assigned to a user account used to sign into a Teams phone. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin +``` +This example shows a new policy being created called "CommonAreaPhone" setting the SignInMode as "CommonAreaPhoneSignIn". + +## PARAMETERS + +### -Identity +The identity of the policy that you want to create. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBetterTogether +Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. +Possible values this parameter can take: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHomeScreen +Determines whether the Home Screen feature of the Teams IP Phones is enabled. +Possible values this parameter can take: + +- Enabled +- EnabledUserOverride +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHotDesking +Determines whether hot desking mode is enabled. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free form text that can be used by administrators as desired. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotDeskingIdleTimeoutInMinutes +Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchOnCommonAreaPhoneMode +Determines whether a user can search the Global Address List in Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInMode +Determines the sign in mode for the device when signing in to Teams. +Possible Values: +- 'UserSignIn: Enables the individual user's Teams experience on the phone' +- 'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone' +- 'MeetingSignIn: Enables the meeting/conference room experience on the phone' + +```yaml +Type: String + +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..3f141907b4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# New-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS +This cmdlet creates a Teams media connectivity policy. + +## SYNTAX + +```powershell +New-CsTeamsMediaConnectivityPolicy -Identity <String> [-DirectConnection <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a Teams media connectivity policy. If you get an error that the policy already exists, it means that the policy already exists for your tenant. In this case, run Get-CsTeamsMediaConnectivityPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsMediaConnectivityPolicy -Identity Test + +Identity DirectConnection +------------------------- +Tag:Test Enabled +``` +Creates a new Teams media connectivity policy with the specified identity. +The newly created policy with value will be printed on success. + +## PARAMETERS + +### -Identity +Identity of the Teams media connectivity policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectConnection +This setting will enable Tenant Admins to control the Teams media connectivity behavior in Teams for both Meetings and 1:1 calls. If this setting is set to true, a direct media connection between the current user and a remote user is allowed which may improve the meeting quality and reduce the egress bandwidth usage for the customer. If this setting is set to disabled, no direct media connection will be allowed for the current user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) + +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..6a2c7ee7cd --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# New-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +```powershell +New-CsTeamsMeetingBrandingPolicy + [-MeetingBackgroundImages <PSListModifier>] + [-MeetingBrandingThemes <PSListModifier>] + [-DefaultTheme <String>] [-EnableMeetingOptionsThemeOverride <Boolean>] + [-EnableNdiAssuranceSlate <Boolean>] [-NdiAssuranceSlateImages <PSListModifier>] [-RequireBackgroundEffect <Boolean>] + [-EnableMeetingBackgroundImages <Boolean>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new **TeamsMeetingBrandingPolicy**. +You can only create an empty meeting branding policy with this cmdlet, image upload is not supported. +If you want to upload the images, you should use Teams Admin Center. + +## EXAMPLES + +### Create empty meeting branding policy +```powershell +PS C:\> New-CsTeamsMeetingBrandingPolicy -Identity "test policy" +``` + +In this example, the command will create an empty meeting branding policy with the identity `test policy`. + +## PARAMETERS + +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity of meeting branding policy that will be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* +List of meeting branding themes. +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNdiAssuranceSlate +This enables meeting Network Device Interface Assurance Slate branding. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NdiAssuranceSlateImages +Used to specify images that can be used as assurance slates during NDI (Network Device Interface) streaming in Teams meetings. This parameter allows administrators to define a set of images that can be displayed to participants to ensure that the NDI stream is functioning correctly. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireBackgroundEffect +This mandates a meeting background for participants. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md similarity index 78% rename from skype/skype-ps/skype/New-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md index e0a19b7ef5..898cfcd848 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md @@ -1,14 +1,19 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: New-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- - # New-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS + New-CsTeamsMeetingBroadcastPolicy \[-Identity\] \<XdsIdentity\> \[-Tenant \<guid\>\] \[-Description \<string\>\] \[-AllowBroadcastScheduling \<bool\>\] \[-AllowBroadcastTranscription \<bool\>\] \[-BroadcastAttendeeVisibilityMode \<string\>\] \[-BroadcastRecordingMode \<string\>\] \[-InMemory\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\<CommonParameters\>\] ## SYNTAX @@ -21,22 +26,22 @@ New-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Description <String>] ``` ## 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. Use this cmdlet to create a new policy. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> New-CsTeamsMeetingBroadcastPolicy -Identity Students -AllowBroadcastScheduling $false +PS C:\> New-CsTeamsMeetingBroadcastPolicy -Identity Students -AllowBroadcastScheduling $false ``` Creates a new MeetingBroadcastPolicy with broadcast scheduling disabled, which can then be assigned to individual users using the corresponding grant- command. - ## PARAMETERS ### -AllowBroadcastScheduling -Specifies whether this user can create broadcast events in Teams.  This settng impacts broadcasts that use both self-service and external encoder production methods.  +Specifies whether this user can create broadcast events in Teams. This setting impacts broadcasts that use both self-service and external encoder production methods. ```yaml Type: Boolean @@ -51,7 +56,7 @@ Accept wildcard characters: False ``` ### -AllowBroadcastTranscription -Specifies whether real-time transcription and translation can be enabled in the broadcast event.  Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. +Specifies whether real-time transcription and translation can be enabled in the broadcast event. Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. ```yaml Type: Boolean @@ -66,8 +71,7 @@ Accept wildcard characters: False ``` ### -BroadcastAttendeeVisibilityMode -Specifies the attendee visibility mode of the broadcast events created by this user.  This setting controls who can watch the broadcast event - e.g. anyone can watch this event including anonymous users or only authenticated users in my company can watch the event.  Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. - +Specifies the attendee visibility mode of the broadcast events created by this user. This setting controls who can watch the broadcast event - e.g. anyone can watch this event including anonymous users or only authenticated users in my company can watch the event. Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. ```yaml Type: String @@ -82,7 +86,7 @@ Accept wildcard characters: False ``` ### -BroadcastRecordingMode -Specifies whether broadcast events created by this user are always recorded, never recorded or user can choose whether to record or not.  Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. +Specifies whether broadcast events created by this user are always recorded, never recorded or user can choose whether to record or not. Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. ```yaml Type: String @@ -97,6 +101,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -112,6 +117,7 @@ Accept wildcard characters: False ``` ### -Description + Specifies why this policy is being created. ```yaml @@ -127,6 +133,7 @@ Accept wildcard characters: False ``` ### -Force + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml @@ -142,6 +149,7 @@ Accept wildcard characters: False ``` ### -Identity + Specifies the name of the policy being created ```yaml @@ -157,6 +165,7 @@ Accept wildcard characters: False ``` ### -InMemory + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml @@ -172,6 +181,7 @@ Accept wildcard characters: False ``` ### -Tenant + Not applicable, you can only specify policies for your own logged-in tenant. ```yaml @@ -187,6 +197,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -203,16 +214,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None + ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md new file mode 100644 index 0000000000..8c7b734046 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md @@ -0,0 +1,1964 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingpolicy +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsTeamsMeetingPolicy +schema: 2.0.0 +manager: bulenteg +ms.reviewer: alejandramu +ms.date: 2/26/2025 +--- + +# New-CsTeamsMeetingPolicy + +## SYNOPSIS + The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +## SYNTAX + +```powershell +New-CsTeamsMeetingPolicy [-Identity] <XdsIdentity> + [-AIInterpreter <string>] + [-AllowAnonymousUsersToDialOut <Boolean>] + [-AllowAnonymousUsersToJoinMeeting <Boolean>] + [-AllowAnonymousUsersToStartMeeting <Boolean>] + [-AllowAnnotations <Boolean>] + [-AllowAvatarsInGallery <Boolean>] + [-AllowBreakoutRooms <String>] + [-AllowCarbonSummary <Boolean>] + [-AllowCartCaptionsScheduling <string>] + [-AllowChannelMeetingScheduling <Boolean>] + [-AllowCloudRecording <Boolean>] + [-AllowDocumentCollaboration <String>] + [-AllowedUsersForMeetingContext <String>] + [-AllowEngagementReport <String>] + [-AllowExternalNonTrustedMeetingChat <Boolean>] + [-AllowExternalParticipantGiveRequestControl <Boolean>] + [-AllowImmersiveView <Boolean>] + [-AllowIPAudio <Boolean>] + [-AllowIPVideo <Boolean>] + [-AllowLocalRecording] + [-AllowMeetingCoach <Boolean>] + [-AllowMeetNow <Boolean>] + [-AllowMeetingReactions <Boolean>] + [-AllowMeetingRegistration <Boolean>] + [-AllowNDIStreaming <Boolean>] + [-AllowNetworkConfigurationSettingsLookup <Boolean>] + [-AllowOrganizersToOverrideLobbySettings <Boolean>] + [-AllowOutlookAddIn <Boolean>] + [-AllowPSTNUsersToBypassLobby <Boolean>] + [-AllowParticipantGiveRequestControl <Boolean>] + [-AllowPowerPointSharing <Boolean>] + [-AllowPrivateMeetNow <Boolean>] + [-AllowPrivateMeetingScheduling <Boolean>] + [-AllowRecordingStorageOutsideRegion <Boolean>] + [-AllowScreenContentDigitization <Boolean>] + [-AllowSharedNotes <Boolean>] + [-AllowTasksFromTranscript <String>] + [-AllowTrackingInReport <Boolean>] + [-AllowTranscription <Boolean>] + [-AllowUserToJoinExternalMeeting <String>] + [-AllowWatermarkCustomizationForCameraVideo <Boolean>] + [-AllowWatermarkCustomizationForScreenSharing <Boolean>] + [-AllowWatermarkForCameraVideo <Boolean>] + [-AllowWatermarkForScreenSharing <Boolean>] + [-AllowWhiteboard <Boolean>] + [-AllowedStreamingMediaInput <String>] + [-AnonymousUserAuthenticationMethod <String>] + [-AttendeeIdentityMasking <String>] + [-AudibleRecordingNotification <String>] + [-AutoAdmittedUsers <String>] + [-AutomaticallyStartCopilot <String>] + [-BlockedAnonymousJoinClientTypes <List>] + [-CaptchaVerificationForMeetingJoin <String>] + [-ChannelRecordingDownload <String>] + [-ConnectToMeetingControls <String>] + [-Confirm] + [-ContentSharingInExternalMeetings <String>] + [-Copilot <String>] + [-CopyRestriction <Boolean>] + [-Description <String>] + [-DesignatedPresenterRoleMode <String>] + [-DetectSensitiveContentDuringScreenSharing <Boolean>] + [-EnrollUserOverride <String>] + [-ExplicitRecordingConsent <String>] + [-ExternalMeetingJoin <String>] + [-Force] + [-IPAudioMode <String>] + [-IPVideoMode <String>] + [-InfoShownInReportMode <String>] + [-InMemory] + [-LiveCaptionsEnabledType <String>] + [-LiveInterpretationEnabledType <String>] + [-LiveStreamingMode <String>] + [-LobbyChat <string>] + [-MediaBitRateKb <UInt32>] + [-MeetingChatEnabledType <String>] + [-MeetingInviteLanguages <String>] + [-NewMeetingRecordingExpirationDays <Int32>] + [-NoiseSuppressionForDialInParticipants <String>] + [-ParticipantNameChange <String>] + [-PreferredMeetingProviderForIslandsMode <String>] + [-QnAEngagementMode <String>] + [-RecordingStorageMode <String>] + [-RoomAttributeUserOverride <String>] + [-RoomPeopleNameUserOverride <String>] + [-ScreenSharingMode <String>] + [-SmsNotifications <String>] + [-SpeakerAttributionMode <String>] + [-StreamingAttendeeMode <String>] + [-TeamsCameraFarEndPTZMode <String>] + [-Tenant <Guid>] + [-UsersCanAdmitFromLobby <String>] + [-VideoFiltersMode <String>] + [-VoiceIsolation <String>] + [-VoiceSimulationInInterpreter <string>] + [-WatermarkForAnonymousUsers <String>] + [-WatermarkForCameraVideoOpacity <Int64>] + [-WatermarkForCameraVideoPattern <String>] + [-WatermarkForScreenSharingOpacity <Int64>] + [-WatermarkForScreenSharingPattern <String>] + [-AllowedUsersForMeetingDetails <String>] + [-RealTimeText <String>] + [-WhatIf] + [-WhoCanRegister <Object>] + [<CommonParameters>] +``` + +## 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 -------------------------- +``` +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 -------------------------- +``` +New-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False +``` + +In Example 2, the New-CsTeamsMeetingPolicy cmdlet is used to create a meeting policy with the Identity HrMeetingPolicy. +In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. +All other policy properties will use the default values. + +## PARAMETERS + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToDialOut +Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. + +> [!NOTE] +> This parameter is temporarily disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToJoinMeeting + +> [!NOTE] +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check <https://learn.microsoft.com/microsoftteams/meeting-settings-in-teams> for details. + +Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToStartMeeting +Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnnotations +This setting will allow admins to choose which users will be able to use the Annotation feature. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAvatarsInGallery +If admins disable avatars in 2D meetings, then users cannot represent themselves as avatars in the Gallery view. This does not disable avatars in Immersive view. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. If set to True the meeting organizer will share their location to the client of the participant to enable the calculation of distance and the resulting carbon. + +>[!NOTE] +>Location data will not be visible to the organizer or participants in this case and only carbon avoided will be shown. If set to False then organizer location data will not be shown and no carbon summary screen will be displayed to the participants. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCartCaptionsScheduling +Determines whether a user can add a URL for captions from a Communications Access Real-Time Translation (CART) captioner for providing real-time captions in meetings. + +Possible values are: + +- **EnabledUserOverride**: CART captions are available by default but you can disable them. +- **DisabledUserOverride**: If you would like users to be able to use CART captions in meetings but they are disabled by default. +- **Disabled**: If you do not want to allow CART captions in meetings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecording +Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDocumentCollaboration +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -AllowEngagementReport +Determines whether users are allowed to download the attendee engagement report. Set this to Enabled to allow the user to download the report. Set this to Disabled to prohibit the user to download it. ForceEnabled will enable attendee report generation and prohibit meeting organizer from disabling it. + +Possible values: + +- Enabled +- Disabled +- ForceEnabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalNonTrustedMeetingChat + +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalParticipantGiveRequestControl +Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveView +If admins have disabled avatars, this does not disable using avatars in Immersive view on Teams desktop or web. Additionally, it does not prevent users from joining the Teams meeting on VR headsets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPAudio +Determines whether audio is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their audio. Set this to FALSE to prohibit the user from sharing their audio. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. + +Possible values: + +- true +- false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNDIStreaming +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookups can be made by users who are not Enterprise Voice enabled. It is used to enable Network Roaming policies. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOrganizersToOverrideLobbySettings +Set this parameter to true to enable Organizers to override lobby settings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOutlookAddIn +Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPSTNUsersToBypassLobby +Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to True, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRecordingStorageOutsideRegion +Allow storing recording outside of region. All meeting recordings will be permanently stored in another region, and can't be migrated. For more info, see <https://aka.ms/in-region>. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowScreenContentDigitization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSharedNotes +Determines whether users are allowed to take shared notes. Set this to TRUE to allow. Set this to FALSE to prohibit + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTasksFromTranscript +This policy setting allows for the extraction of AI-Assisted Action Items/Tasks from the Meeting Transcript. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTrackingInReport +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscription +Determines whether real-time and/or post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserToJoinExternalMeeting +Possible values are: + +- Enabled +- FederatedOnly +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkCustomizationForCameraVideo +Allows the admin to grant customization permissions to a meeting organizer + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkCustomizationForScreenSharing +Allows the admin to grant customization permissions to a meeting organizer + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWhiteboard +Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: + +- \<blank\> +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnonymousUserAuthenticationMethod +Determines how anonymous users will be authenticated when joining a meeting. + +Possible values are: +- **OneTimePasscode**, if you would like anonymous users to be sent a one time passcode to their email when joining a meeting +- **None**, if you would like to disable authentication for anonymous users joining a meeting + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: OneTimePasscode +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttendeeIdentityMasking +This setting will allow admins to enable or disable Masked Attendee mode in Meetings. Masked Attendee meetings will hide attendees' identifying information (e.g., name, contact information, profile photo). + +Possible Values: Enabled: Hides attendees' identifying information in meetings. Disabled: Does not allow attendees' to hide identifying information in meetings + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudibleRecordingNotification +The setting controls whether recording notification is played to all attendees or just PSTN users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAdmittedUsers +Determines what types of participants will automatically be added to meetings organized by this user. +Possible values are: + +- **EveryoneInCompany**, if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. +- **EveryoneInSameAndFederatedCompany**, if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. +- **Everyone**, if you'd like to admit anonymous users by default. +- **OrganizerOnly**, if you would like that only meeting organizers can bypass the lobby. +- **EveryoneInCompanyExcludingGuests**, if you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately. +- **InvitedUsers**, if you would like that only meeting organizers and invited users can bypass the lobby. + +This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticallyStartCopilot +> [!Note] +> This feature has not been fully released yet, so the setting will have no effect.* + +This setting gives admins the ability to auto-start Copilot. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedAnonymousJoinClientTypes +A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. + +The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Empty List +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaptchaVerificationForMeetingJoin +Require a verification check for meeting join. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelRecordingDownload +Controls how channel meeting recordings are saved, permissioned, and who can download them. + +Possible values: + +Allow - Saves channel meeting recordings to a "Recordings" folder in the channel. The permissions on the recording files will be based on the Channel SharePoint permissions. This is the same as any other file uploaded for the channel. +Block - Saves channel meeting recordings to a "Recordings\View only" folder in the channel. Channel owners will have full rights to the recordings in this folder, but channel members will have read access without the ability to download. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: + +Enabled +Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSharingInExternalMeetings +This policy allows admins to determine whether the user can share content in meetings organized by external organizations. The user should have a Teams Premium license to be protected under this policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +This setting allows the admin to choose whether Copilot will be enabled with a persisted transcript or a non-persisted transcript. + +Possible values are: + +- Enabled +- EnabledWithTranscript + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledWithTranscript +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyRestriction +Enables a setting that controls a meeting option which allows users to disable right-click or Ctrl+C to copy, Copy link, Forward message, and Share to Outlook for meeting chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the meeting policy. +For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedPresenterRoleMode +Determines if users can change the default value of the _Who can present?_ setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings. + +Possible values are: + +- EveryoneUserOverride: All meeting participants can be presenters. This is the default value. This parameter corresponds to the _Everyone_ setting in Teams. +- EveryoneInCompanyUserOverride: Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the _People in my organization_ setting in Teams. +- EveryoneInSameAndFederatedCompanyUserOverride: Authenticated users in the organization, including guest users and users from federated organizations, can be presenters. This parameter corresponds to the _People in my organization and trusted organizations_ setting in Teams. +- OrganizerOnlyUserOverride: Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the _Only me_ setting in Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EveryoneUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetectSensitiveContentDuringScreenSharing +Allows the admin to enable sensitive content detection during screen share. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollUserOverride +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitRecordingConsent +Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. + +Possible Values: + +- Enabled: Explicit consent, requires participant agreement. +- Disabled: Implicit consent, does not require participant agreement. +- LegitimateInterest: Legitimate interest, less restrictive consent to meet legitimate interest without requiring explicit agreement from participants. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMeetingJoin +Possible values are: + +- EnabledForAnyone +- EnabledForTrustedOrgs +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledForAnyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfoShownInReportMode +This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMode +Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMode +Determines whether video can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming video in the meeting. Set this to DISABLED to prohibit outgoing and incoming video in the meeting. Invalid value combination IPVideoMode: EnabledOutgoingIncoming and IPAudioMode: Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveInterpretationEnabledType +Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. + +Possible values are: + +DisabledUserOverride, if you would like users to be able to use interpretation in meetings but by default it is disabled. +Disabled, prevents the option to be enabled in Meeting Options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveStreamingMode +Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP). + +Possible values are: + +- Disabled (default) +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LobbyChat + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether chat messages are allowed in the lobby. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingChatEnabledType +Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInviteLanguages +Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. + +> [!NOTE] +> All Teams supported languages can be specified using language codes. For more information about its delivery date, see the [roadmap (Feature ID: 81521)](https://www.microsoft.com/microsoft-365/roadmap?filters=&searchterms=81521). + +The preliminary list of available languages is shown below: + +`ar-SA,az-Latn-AZ,bg-BG,ca-ES,cs-CZ,cy-GB,da-DK,de-DE,el-GR,en-GB,en-US,es-ES,es-MX,et-EE,eu-ES,fi-FI,fil-PH,fr-CA,fr-FR,gl-ES,he-IL,hi-IN,hr-HR,hu-HU,id-ID,is-IS,it-IT,ja-JP,ka-GE,kk-KZ,ko-KR,lt-LT,lv-LV,mk-MK,ms-MY,nb-NO,nl-NL,nn-NO,pl-PL,pt-BR,pt-PT,ro-RO,ru-RU,sk-SK,sl-SL,sq-AL,sr-Latn-RS,sv-SE,th-TH,tr-TR,uk-UA,vi-VN,zh-CN,zh-TW`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewMeetingRecordingExpirationDays +Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. + +> [!NOTE] +> You may opt to set Meeting Recordings to never expire by entering the value -1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoiseSuppressionForDialInParticipants + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Control Noises Supression Feature for PST legs joining a meeting. + +Possible Values: + +- MicrosoftDefault +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParticipantNameChange +This setting will enable Tenant Admins to turn on/off participant renaming feature. + +Possible Values: Enabled: Turns on the Participant Renaming feature. Disabled: Turns off the Particpant Renaming feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMeetingProviderForIslandsMode +Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TeamsAndSfb +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QnAEngagementMode +This setting enables Microsoft 365 Tenant Admins to Enable or Disable the Questions and Answers experience (Q+A). When Enabled, Organizers can turn on Q+A for their meetings. When Disabled, Organizers cannot turn on Q+A in their meetings. The setting is enforced when a meeting is created or is updated by Organizers. Attendees can use Q+A in meetings where it was previously added. Organizers can remove Q+A for those meetings through Teams and Outlook Meeting Options. Possible values: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingStorageMode +This parameter can take two possible values: + +- Stream +- OneDriveForBusiness + +> [!Note] +> The change of storing Teams meeting recordings from Classic Stream to OneDrive and SharePoint (ODSP) has been completed as of August 30th, 2021. All recordings are now stored in ODSP. This change overrides the RecordingStorageMode parameter, and modifying the setting in PowerShell no longer has any impact. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomAttributeUserOverride +Possible values: + +- Off +- Distinguish +- Attribute + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomPeopleNameUserOverride +Enabling people recognition requires the tenant CsTeamsMeetingPolicy roomPeopleNameUserOverride to be "On" and roomAttributeUserOverride to be Attribute for allowing individual voice and face profiles to be used for recognition in meetings. + +> [!Note] +> In some locations, people recognition can't be used due to local laws or regulations. +Possible values: + +- On +- Off + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScreenSharingMode +Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmsNotifications +Participants can sign up for text message meeting reminders. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionMode +Possible values: + +- EnabledUserOverride +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingAttendeeMode +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCameraFarEndPTZMode +Possible values are: + +- Disabled +- AutoAcceptInTenant +- AutoAcceptAll + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanAdmitFromLobby +This policy controls who can admit from the lobby. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoFiltersMode +Determines the background effects that a user can configure in the Teams client. Possible values are: + +- NoFilters: No filters are available. +- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://learn.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). +- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. +- AllFilters: All filters are available, including custom images. This is the default value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: AllFilters +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceIsolation +Determines whether you provide support for your users to enable voice isolation in Teams meeting calls. + +Possible values are: + +- Enabled (default) +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForAnonymousUsers +Determines the meeting experience and watermark content of an anonymous user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoOpacity +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoPattern +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingOpacity +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingPattern +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhoCanRegister +Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts, set the value to 'EveryoneInCompany'. + +Possible values: + +- Everyone +- EveryoneInCompany + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..48a5347d44 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# New-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell + New-CsTeamsMeetingTemplatePermissionPolicy [-Identity] <string> [-HiddenMeetingTemplates<PSListModifier[HiddenMeetingTemplate]>] [-Description <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden meeting template IDs. The template IDs passed into the `HiddenMeetingTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) respectively. + +## EXAMPLES + +### Example 1 - Creating a new meeting template permission policy + +Assuming there are two valid templates with IDs `firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748` and `customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056`, we will first create the `HiddenMeetingTemplate` objects. + +The next step would be to create the policy instance. +```powershell +$hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +$hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 + +New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy" +``` + +```output +Identity : Tag:Test_Policy +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748} +Description : This is a test policy +``` + +## PARAMETERS + +### -Identity + +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenMeetingTemplates + +The list of meeting template IDs to hide. +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). + +```yaml +Type: HiddenMeetingTemplate[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate) + +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md new file mode 100644 index 0000000000..f25c5317c1 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md @@ -0,0 +1,771 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmessagingpolicy +applicable: Microsoft Teams +title: New-CsTeamsMessagingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsMessagingPolicy + +## SYNOPSIS +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +## SYNTAX + +```powershell +New-CsTeamsMessagingPolicy [[-Identity] <XdsIdentity>] + [-AllowChatWithGroup <Boolean>] + [-AllowCommunicationComplianceEndUserReporting <Boolean>] + [-AllowCustomGroupChatAvatars <Boolean>] + [-AllowExtendedWorkInfoInSearch <Boolean>] + [-AllowFluidCollaborate <Boolean>] + [-AllowFullChatPermissionUserToDeleteAnyMessage <Boolean>] + [-AllowGiphy <Boolean>] + [-AllowGiphyDisplay <Boolean>] + [-AllowGroupChatJoinLinks <Boolean>] + [-AllowImmersiveReader <Boolean>] + [-AllowMemes <Boolean>] + [-AllowOwnerDeleteMessage <Boolean>] + [-AllowPasteInternetImage <Boolean>] + [-AllowPriorityMessages <Boolean>] + [-AllowRemoveUser <Boolean>] + [-AllowSecurityEndUserReporting <Boolean>] + [-AllowSmartCompose] <Boolean>] + [-AllowSmartReply <Boolean>] + [-AllowStickers <Boolean>] + [-AllowUrlPreviews <Boolean>] + [-AllowUserChat <Boolean>] + [-AllowUserDeleteChat <Boolean>] + [-AllowUserDeleteMessage <Boolean>] + [-AllowUserEditMessage <Boolean>] + [-AllowUserTranslation <Boolean>] + [-AllowVideoMessages <Boolean>] + [-AudioMessageEnabledType <AudioMessageEnabledTypeEnum>] + [-ChannelsInChatListEnabledType <ChannelsInChatListEnabledTypeEnum>] + [-ChatPermissionRole <String>] + [-Confirm] + [-CreateCustomEmojis <Boolean>] + [-DeleteCustomEmojis <Boolean>] + [-Description <String>] + [-DesignerForBackgroundsAndImages <String>] + [-Force] + [-GiphyRatingType <String>] + [-InMemory] + [-InOrganizationChatControl <String>] + [-ReadReceiptsEnabledType <String>] + [-Tenant <Guid>] + [-UsersCanDeleteBotMessages <Boolean>] + [<CommonParameters>] + [-WhatIf] + ``` + +## DESCRIPTION +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet creates a new Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false +``` + +In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. +All other policy properties will use the default values. + +## PARAMETERS + +### -Identity +Unique identifier for the teams messaging policy to be created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowChatWithGroup + +This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCommunicationComplianceEndUserReporting + +This setting determines if users can report offensive messages to their admin for Communication Compliance. Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCustomGroupChatAvatars + +These settings enables, disables updating or fetching custom group chat avatars for the users included in the messaging policy. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExtendedWorkInfoInSearch +This setting enables/disables showing company name and department name in search results for MTO users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFluidCollaborate + +This field enables or disables Fluid Collaborate feature for users. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFullChatPermissionUserToDeleteAnyMessage + +This setting determines if users with the 'Full permissions' role can delete any group or meeting chat message within their tenant. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphy +Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphyDisplay + +Determines if Giphy images should be displayed that had been already sent or received in chat. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGroupChatJoinLinks + +This setting determines if users in a group chat can create and share join links for other users within the organization to join that chat. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveReader +Determines whether a user is allowed to use Immersive Reader for reading conversation messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMemes +Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOwnerDeleteMessage +Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit. + +If the `-AllowUserDeleteMessage` parameter is set to FALSE, the team owner will not be able to delete their own messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPasteInternetImage + +Determines if a user is allowed to paste internet-based images in compose. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPriorityMessages +Determines whether a user is allowed to send priorities messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRemoveUser +Determines whether a user is allowed to remove a user from a conversation. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSecurityEndUserReporting + +This setting determines if users can report any security concern posted in messages to their admin. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartCompose +Turn on this setting to let a user get text predictions for chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Con nombre +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartReply +Turn this setting on to enable suggested replies for chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickers +Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUrlPreviews +Use this setting to turn automatic URL previewing on or off in messages. Set this to TRUE to turn on. Set this to FALSE to turn off. +Note: [Optional Connected Experiences](https://learn.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for URL previews to be allowed. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserChat +Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteChat + +Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessage +Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessage +Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserTranslation +Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVideoMessages + +This setting determines if users can create and send video messages. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioMessageEnabledType +Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels,ChatsOnly,Disabled. + +```yaml +Type: AudioMessageEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelsInChatListEnabledType +On mobile devices, enable to display favorite channels above recent chats. + +Possible values are: DisabledUserOverride,EnabledUserOverride. + +```yaml +Type: ChannelsInChatListEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChatPermissionRole +Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the environment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Restricted +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateCustomEmojis +This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteCustomEmojis +These settings enable and disable the editing and deletion of custom emojis and reactions for the users included in the messaging policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Allows you to provide a description of your policy to note the purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignerForBackgroundsAndImages + +This setting determines whether a user is allowed to create custom AI-powered backgrounds and images with MS Designer. + +Possible values are: Enabled, Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GiphyRatingType +Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InOrganizationChatControl + +This setting determines if chat regulation for internal communication in the tenant is allowed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadReceiptsEnabledType + +Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanDeleteBotMessages + +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy) + +[Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy) + +[Grant-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy) + +[Remove-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md new file mode 100644 index 0000000000..8bd31ac80b --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmobilitypolicy +applicable: Microsoft Teams +title: New-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# New-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +``` +New-CsTeamsMobilityPolicy [-Tenant <System.Guid>] [-Description <String>] [-IPVideoMobileMode <String>] + [-IPAudioMobileMode <String>] [-Identity] <XdsIdentity>] [-MobileDialerPreference <String>] [-InMemory] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The New-CsTeamsMobilityPolicy cmdlet lets an Admin create a custom teams mobility policy to assign to particular sets of users. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsMobilityPolicy -Identity SalesMobilityPolicy -IPAudioMobileMode "WifiOnly" +``` + +The command shown in Example 1 uses the New-CsTeamsMobilityPolicy cmdlet to create a new Teams Mobility Policy with the Identity SalesMobilityPolicy and IPAudioMobileMode equal to WifiOnly. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMobileMode +When set to WifiOnly, prohibits the user from making and receiving calls or joining meetings using VoIP calls on the mobile device while on a cellular data connection. Possible values are: WifiOnly, AllNetworks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMobileMode +When set to WifiOnly, prohibits the user from making and receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on a cellular data connection. Possible values are: WifiOnly, AllNetworks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md new file mode 100644 index 0000000000..54b53972d8 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md @@ -0,0 +1,127 @@ +--- +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: +manager: mreddy +schema: 2.0.0 +--- + +# New-CsTeamsNetworkRoamingPolicy + +## SYNOPSIS + +New-CsTeamsNetworkRoamingPolicy allows IT Admins to create policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +## SYNTAX + +``` +New-CsTeamsNetworkRoamingPolicy [-Tenant <System.Guid>] [-Identity <XdsIdentity>] [-AllowIPVideo <Boolean>] [-MediaBitRateKb <Integer>] [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates new Teams Network Roaming Policies configured for use in your organization. + +The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. + +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). + +To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsNetworkRoamingPolicy -Identity "RedmondRoaming" -AllowIPVideo $true -MediaBitRateKb 2000 -Description "Redmond campus roaming policy" +``` + +The command shown in Example 1 creates a new teams network roaming policy with Identity "RedmondRoaming" with IP Video feature enabled, and the maximum media bit rate is capped at 2000 Kbps. + +### Example 2 +```powershell +PS C:\> New-CsTeamsNetworkRoamingPolicy -Identity "RemoteRoaming" +``` + +The command shown in Example 2 creates a new teams network roaming policy with Identity "RemoteRoaming" with IP Video feature enabled, and the maximum media bit rate is capped at 50000 Kbps by default. + +## PARAMETERS + +### -Identity +Unique identifier of the policy to be created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. +Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 50000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the new policy 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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-CsTeamsPinnedApp.md b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md new file mode 100644 index 0000000000..6c96bf3b11 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md @@ -0,0 +1,215 @@ +--- +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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsPinnedApp [-Tenant <System.Guid>] -Order <Int64> [-Priority <Int32>] [-Identity] <XdsIdentity> + [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsPinnedApp [-Tenant <System.Guid>] -Parent <String> -Id <String> -Order <Int64> [-Priority <Int32>] + [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/MicrosoftTeams/teams-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/New-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..be3f26d1a2 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: New-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# New-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +New-CsTeamsRecordingRollOutPolicy [-MeetingRecordingOwnership <String>] [-Identity] <String> [-Force] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The New-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to define new CsTeamsRecordingRollOutPolicy that can be assigned to particular users to control Teams features related to meetings. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy -MeetingRecordingOwnership MeetingOrganizer +``` + +The command shown in Example 1 uses the New-CsTeamsRecordingRollOutPolicy cmdlet to create a new TeamsRecordingRollOutPolicy with the Identity OrganizerPolicy. +This policy will set MeetingRecordingOwnership to MeetingOrganizer. Recordings for this policy group's users as organizer would get saved to organizers' own OneDrive. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingRecordingOwnership +Specifies where the meeting recording get stored. Possible values are: +- MeetingOrganizer +- RecordingInitiator + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..ad5c601ece --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,225 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy +title: New-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] <String> [-AreaCode <String>] [-Description <String>] + [-Enabled <Boolean>] [-PlaceExternalCalls <String>] [-PlaceInternalCalls <String>] + [-ReceiveExternalCalls <String>] [-ReceiveInternalCalls <String>] [-MsftInternalProcessingMode <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..1b61b77f9d --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,201 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +title: New-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Use the New-CsTeamsSharedCallingRoutingPolicy cmdlet to configure a shared calling routing policy. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsSharedCallingRoutingPolicy [-Identity] <string> [-EmergencyNumbers <PSListModifier[string]>] + [-ResourceAccount <string>] [-Description <string>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams shared calling routing policy configures the caller ID for normal outbound PSTN and emergency calls made by users enabled for Shared Calling using this policy instance. + +The caller ID for normal outbound PSTN calls is the phone number assigned to the resource account specified in the policy instance. Typically this is the organization's main auto attendant phone number. Callbacks will go to the auto attendant and the PSTN caller can use the auto attendant to be transferred to the shared calling user. + +When a shared calling user makes an emergency call, the emergency services need to be able to make a direct callback to the user who placed the emergency call. One of the defined emergency numbers is used for this purpose as caller ID for the emergency call. It will be reserved for the next 60 minutes and any inbound call to that number will directly ring the shared calling user who made the emergency call. If no emergency numbers are defined, the phone number of the resource account is used as caller ID. If no free emergency numbers are available, the first number in the list is reused. + +The emergency call will contain the location of the shared calling user. The location will be either the dynamic emergency location obtained by the Teams client or if that is not available the static location assigned to the phone number of the resource account used in the shared calling policy instance. + +## EXAMPLES + +### Example 1 +``` +$ra = Get-CsOnlineUser -Identity ra1@contoso.com +$PhoneNumber=Get-CsPhoneNumberAssignment -AssignedPstnTargetId ra1@contoso.com +$CivicAddress = Get-CsOnlineLisCivicAddress -City Seattle +Set-CsPhoneNumberAssignment -LocationId $CivicAddress.DefaultLocationId -PhoneNumber $PhoneNumber.TelephoneNumber +New-CsTeamsSharedCallingRoutingPolicy -Identity Seattle -ResourceAccount $ra.Identity -EmergencyNumbers @{add='+14255556677','+14255554321'} -Description 'Seattle' +``` +The command shown in Example 1 gets the identity and phone number assigned to the Teams resource account ra1@contoso.com, sets the location of the phone number to be the Seattle location, and creates a new Shared Calling policy called Seattle that is using the Teams resource account ra1@contoso.com and the emergency numbers +14255556677 and +14255554321. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the new policy instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyNumbers +An array of phone numbers used as caller ID on emergency calls. + +The emergency numbers must be routable for inbound PSTN calls, and for Calling Plan and Operator Connect phone numbers, must be available within the organization. + +The emergency numbers specified must all be of the same phone number type and country as the phone number assigned to the specified resource account. If the resource account has a Calling Plan service number assigned, the emergency numbers need to be Calling Plan subscriber numbers. + +The emergency numbers must be unique and can't be reused in other shared calling policy instances. The emergency numbers can't be assigned to any user or resource account. + +If no emergency numbers are configured, the phone number of the resource account is used as the Caller ID for the emergency call. + +```yaml +Type: System.Management.Automation.PSListModifier[String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +In some Calling Plan markets, you are not allowed to set the location on service numbers. In this instance, kindly contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +If you are attempting to use a resource account with an Operator Connect phone number assigned, you should confirm support for Shared Calling with your operator. + +Shared Calling is not supported for Calling Plan service phone numbers in Romania, the Czech Republic, Hungary, Singapore, New Zealand, Australia, and Japan. A limited number of existing Calling Plan service phone numbers in other countries are also not supported for Shared Calling. For such service phone numbers, please contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..f09cf35e77 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -0,0 +1,367 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection +schema: 2.0.0 +--- + +# New-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet creates a new workforce management (WFM) connection. + +## SYNTAX + +### New (Default) +```powershell +New-CsTeamsShiftsConnection -Body <IWfmConnectionRequest> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewExpanded +```powershell +New-CsTeamsShiftsConnection -ConnectorId <string> -ConnectorSpecificSettings <IWfmConnectionRequestConnectorSpecificSettings> -Name <string> -State <string> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a Shifts WFM connection. It allows the admin to set up the environment for creating connection instances. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2" + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1" + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" + cookieAuthUrl = "https://contoso.com/retail/data/login" + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output +{ +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +} +``` + +Returns the object of the created connection. + +In case of an error, we can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=<CMDLET>` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +### Example 2 + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + +## PARAMETERS + +### -Body + +The request body. + +```yaml +Type: IConnectorInstanceRequest +Parameter Sets: New +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +The WFM connector ID. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection name. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connection name. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) + +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) + +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md new file mode 100644 index 0000000000..0dcfcf6db0 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsShiftsConnectionBatchTeamMap +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap +schema: 2.0.0 +--- + +# New-CsTeamsShiftsConnectionBatchTeamMap + +## SYNOPSIS + +This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. + +## SYNTAX + +``` +New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId <string> -TeamMapping <TeamMap[]> [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $map1 = @{ +teamId = 'eddc3b94-21d5-4ef0-a76a-2e4d6f4a50be' +wfmTeamId = 1000553 +timeZone = "America/Los_Angeles" +} + +$map2 = @{ +teamId = '1d8f6288-0459-4c53-8e98-9de7b781844a' +wfmTeamId = 1000555 +timeZone = "America/Los_Angeles" +} + +New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a343e01 -TeamMapping @($map1, $map2) +``` +```output +CreatedDateTime LastActionDateTime OperationId Status +--------------- ------------------ ----------- ------ +12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2639c7c1e5f0 NotStarted +``` + +Sends 2 team mappings: one maps the Teams team with ID `eddc3b94-21d5-4ef0-a76a-2e4d6f4a50be` and WFM team with ID `1000553` and the other maps the Teams team with ID `1d8f6288-0459-4c53-8e98-9de7b781844a` and WFM team with ID `1000555` in the instance with ID `WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a343e01`. + +## PARAMETERS + +### -ConnectorInstanceId + +The connection instance ID used to map teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamMapping + +The Teams mapping object list. + +```yaml +Type: TeamMap[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +Please check the example section for the format of TeamMap. + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md new file mode 100644 index 0000000000..9570c08ad4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -0,0 +1,463 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsShiftsConnectionInstance +author: leonardospina +ms.author: lespina +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance +schema: 2.0.0 +--- + +# New-CsTeamsShiftsConnectionInstance + +## SYNOPSIS +This cmdlet creates a Shifts connection instance. + +## SYNTAX + +### New (Default) +``` +New-CsTeamsShiftsConnectionInstance -Body <IConnectorInstanceRequest> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewExpanded +``` +New-CsTeamsShiftsConnectionInstance [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>][-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>][-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a Shifts connection instance. It allows the admin to set up the environment for further connection settings. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnectionInstance ` +-connectionId "79964000-286a-4216-ac60-c795a426d61a" ` +-name "Cmdlet test instance" ` +-connectorAdminEmail @("admin@contoso.com", "superadmin@contoso.com") ` +-designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` +-State "Active" ` +-syncFrequencyInMin "10" ` +-SyncScenarioOfferShiftRequest "FromWfmToShifts" ` +-SyncScenarioOpenShift "FromWfmToShifts" ` +-SyncScenarioOpenShiftRequest "FromWfmToShifts" ` +-SyncScenarioShift "FromWfmToShifts" ` +-SyncScenarioSwapRequest "FromWfmToShifts" ` +-SyncScenarioTimeCard "FromWfmToShifts" ` +-SyncScenarioTimeOff "FromWfmToShifts" ` +-SyncScenarioTimeOffRequest "FromWfmToShifts" ` +-SyncScenarioUserShiftPreference "Disabled" +PS C:\> $result.ToJsonString() +``` + +```output +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "79964000-286a-4216-ac60-c795a426d61a", + "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" +} +``` + +Returns the object of created connector instance. + +In case of an error, we can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=<CMDLET>` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +## PARAMETERS + +### -Body + +The request body + +```yaml +Type: IConnectorInstanceRequest +Parameter Sets: New +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. + +```yaml +Type: String[] +Parameter Sets: NewExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph Api calls. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +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". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +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 +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: NewExpanded +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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncFrequencyInMin +The sync frequency in minutes. + +```yaml +Type: Int32 +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) + +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md new file mode 100644 index 0000000000..57a7c3e428 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md @@ -0,0 +1,228 @@ +--- +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 <String>] [-ShiftNoticeMessageType <String>] + [-ShiftNoticeMessageCustom <String>] [-AccessType <String>] [-AccessGracePeriodMinutes <Int64>] + [-EnableScheduleOwnerPermissions <Boolean>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..e4ca073509 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,160 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance +title: New-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# New-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +New-CsTeamsSurvivableBranchAppliance [-Identity] <String> [-Description <String>] [-Site <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey + +```powershell +New-CsTeamsSurvivableBranchAppliance [-Description <String>] [-Site <String>] + [-MsftInternalProcessingMode <String>] -Fqdn <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Free format text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +The FQDN of the SBA. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..4fe55cb48c --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,119 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy +title: New-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# New-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] <String> [-BranchApplianceFqdns <Object>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..88462d4a72 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy +title: New-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# New-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +New-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate]>] + [-Description <String>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist). + +## EXAMPLES + +### Example 1 + +Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. + +The next step would be to create the policy instance. +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList +``` + +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md b/teams/teams-ps/teams/New-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..e760bec361 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsTranslationRule.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule +applicable: Microsoft Teams +title: New-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to create a new telephone number manipulation rule. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsTranslationRule [-Identity] <string> [-Description <string>] [-Pattern <string>] [-Translation <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsTranslationRule -Name <string> [-Description <string>] [-Pattern <string>] [-Translation <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to create a new number manipulation rule. The rule can be used, for example, in the settings of your SBC (Set-CSOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System + +## EXAMPLES + +### Example 1 +```powershell +New-CsTeamsTranslationRule -Identity 'AddPlus1' -Pattern '^(\d{10})$' -Translation '+1$1' +``` + +This example creates a rule that adds +1 to any ten digits number. For example, 2065555555 will be translated to +1206555555 + +### Example 2 +```powershell +New-CsTeamsTranslationRule -Identity 'StripPlus1' -Pattern '^\+1(\d{10})$' -Translation '$1' +``` + +This example creates a rule that strips +1 from any E.164 eleven digits number. For example, +12065555555 will be translated to 206555555 + +### Example 3 +```powershell +New-CsTeamsTranslationRule -Identity 'AddE164SeattleAreaCode' -Pattern '^(\d{4})$' -Translation '+120655$1' +``` + +This example creates a rule that adds +1206555 to any four digits number (converts it to E.164number). For example, 5555 will be translated to +1206555555 + +### Example 4 +```powershell +New-CsTeamsTranslationRule -Identity 'AddSeattleAreaCode' -Pattern '^(\d{4})$' -Translation '425555$1' +``` + +This example creates a rule that adds 425555 to any four digits number (converts to non-E.164 ten digits number). For example, 5555 will be translated to 4255555555 + +### Example 5 +```powershell +New-CsTeamsTranslationRule -Identity 'StripE164SeattleAreaCode' -Pattern '^\+1206555(\d{4})$' -Translation '$1' +``` + +This example creates a rule that strips +1206555 from any E.164 ten digits number. For example, +12065555555 will be translated to 5555 + +### Example 6 +```powershell +New-CsTeamsTranslationRule -Identity 'GenerateFullNumber' -Pattern '^\+1206555(\d{4})$' -Translation '+1206555$1;ext=$1' +``` + +This example creates a rule that adds the last four digits of a phone number starting with +1206555 as the extension. For example, +12065551234 will be translated to +12065551234;ext=1234. + +## PARAMETERS + +### -Identity +The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A friendly description of the normalization rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Translation +The regular expression pattern that will be applied to the number to convert it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule. + +```yaml +Type: String +Parameter Sets: (ParentAndRelativeKey) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md new file mode 100644 index 0000000000..cf47048628 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md @@ -0,0 +1,201 @@ +--- +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] <string> [-Description <string>] [-Pattern <string>] [-Target <string>] + [-TargetType <string>] [-TreatmentPriority <int>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsUnassignedNumberTreatment -TreatmentId <string> [-Description <string>] [-Pattern <string>] [-Target <string>] + [-TargetType <string>] [-TreatmentPriority <int>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..d439835fe4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,315 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: New-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# New-CsTeamsUpdateManagementPolicy + +## SYNOPSIS + +Use this cmdlet to create Teams Update Management policy. + +## SYNTAX + +```powershell +New-CsTeamsUpdateManagementPolicy + [-DisabledInProductMessages <System.Management.Automation.PSListModifier`1[System.String]>] + [-Description <String>] [-AllowManagedUpdates <Boolean>] [-AllowPreview <Boolean>] [-UpdateDayOfWeek <Int64>] + [-UpdateTime <String>] [-UpdateTimeOfDay <DateTime>] [-AllowPublicPreview <String>] + [-AllowPrivatePreview <AllowPrivatePreview>] [-UseNewTeamsClient <String>] + [-BlockLegacyAuthorization <Boolean>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. + +This cmdlet can be used to create a new policy to manage the visibility of some Teams in-product messages. Executing the cmdlet will suppress the corresponding category of messages from appearing for the specified user group. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" -DisabledInProductMessages @("91382d07-8b89-444c-bbcb-cfe43133af33") +``` + +Disable the in-product messages with the category "What's New". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: + +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowManagedUpdates + +Enables/Disables managed updates for the user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPreview + +Indicates whether all feature flags are switched on or off. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivatePreview + +This setting will allow admins to allow users in their tenant to opt in to Private Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is Forced, then users will be switched to Private Preview. + +```yaml +Type: AllowPrivatePreview +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPublicPreview + +This setting will allow admins to allow users in their tenant to opt in to Public Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is FollowOfficePreview, then users will not be able to opt in and instead follow their Office channel, and be switched to Public Preview if their Office channel is CC (Preview). The ring switcher UI will be hidden in the Desktop Client. This is not applicable to the Web Client. + If it is Forced, then users will be switched to Public Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization + +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. + If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. + If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDayOfWeek + + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTime + +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsUpdateManagementPolicy.Cmdlets.TeamsUpdateManagementPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..a8a03debbe --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy +title: New-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# New-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +```powershell +New-CsTeamsVdiPolicy [-DisableCallsAndMeetings <Boolean>] [-DisableAudioVideoInCallsAndMeetings <Boolean>] + [-VDI2Optimization <String>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..e231df2c8c --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy +title: New-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +author: emmanuelrocha001 +manager: sonaggarwal +--- + +# New-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to create a new instance of the TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +``` +New-CsTeamsVirtualAppointmentsPolicy [-EnableSmsNotifications <Boolean>] [-Identity] <String> [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new instance of the TeamsVirtualAppointmentsPolicy. This policy can be used to tailor the virtual appointment template meeting experience. The parameter `EnableSmsNotifications` allows you to specify whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using the virtual appointment meeting template. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled True +``` +Creates a new policy instance with the identity enable-sms. `EnableSmsNotifications` will default to true if it is not specified. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVirtualAppointmentsPolicy -Identity disable-sms -EnableSmsNotifications $false +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled False +``` +Creates a new policy instance with the identity sms-disabled. `EnableSmsNotifications` is set to the value specified in the command. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSmsNotifications +This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### TeamsVirtualAppointmentsPolicy.Cmdlets.TeamsVirtualAppointmentsPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md new file mode 100644 index 0000000000..fd60490292 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -0,0 +1,770 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy +title: New-CsTeamsVoiceApplicationsPolicy +schema: 2.0.0 +ROBOTS: NOINDEX +--- + +# New-CsTeamsVoiceApplicationsPolicy + +## SYNOPSIS + +Creates a new Teams voice applications policy. `TeamsVoiceApplications` policy governs what permissions the supervisors/users have over auto attendants and call queues. + +## SYNTAX + +```powershell +New-CsTeamsVoiceApplicationsPolicy [-Identity] <String> + [-AllowAutoAttendantBusinessHoursGreetingChange <Boolean>] + [-AllowAutoAttendantAfterHoursGreetingChange <Boolean>] + [-AllowAutoAttendantHolidayGreetingChange <Boolean>] + [-AllowAutoAttendantBusinessHoursChange <Boolean>] + [-AllowAutoAttendantHolidaysChange <Boolean>] + [-AllowAutoAttendantTimeZoneChange <Boolean>] + [-AllowAutoAttendantLanguageChange <Boolean>] + [-AllowAutoAttendantBusinessHoursRoutingChange <Boolean>] + [-AllowAutoAttendantAfterHoursRoutingChange <Boolean>] + [-AllowAutoAttendantHolidayRoutingChange <Boolean>] + + [-AllowCallQueueWelcomeGreetingChange <Boolean>] + [-AllowCallQueueMusicOnHoldChange <Boolean>] + [-AllowCallQueueOverflowSharedVoicemailGreetingChange <Boolean>] + [-AllowCallQueueTimeoutSharedVoicemailGreetingChange <Boolean>] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange <bool>] + [-AllowCallQueueLanguageChange <Boolean>] + [-AllowCallQueueMembershipChange <Boolean>] + [-AllowCallQueueConferenceModeChange <Boolean>] + [-AllowCallQueueRoutingMethodChange <Boolean>] + [-AllowCallQueuePresenceBasedRoutingChange <Boolean>] + [-AllowCallQueueOptOutChange <Boolean>] + [-AllowCallQueueOverflowRoutingChange <Boolean>] + [-AllowCallQueueTimeoutRoutingChange <Boolean>] + [-AllowCallQueueNoAgentsRoutingChange <Boolean>] + [-AllowCallQueueAgentOptChange <Boolean>] + + [-CallQueueAgentMonitorMode <Disabled | Monitor | Whisper | Barge | Takeover>] + [-CallQueueAgentMonitorNotificationMode <Disabled | Agent>] + + [-RealTimeAutoAttendantMetricsPermission <string>] + [-RealTimeCallQueueMetricsPermission <string>] + [-RealTimeAgentMetricsPermission <string>] + + [-HistoricalAutoAttendantMetricsPermission <string>] + [-HistoricalCallQueueMetricsPermission <string>] + [-HistoricalAgentMetricsPermission <string>] + + [-Description <String>] + [-WhatIf] + [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows admins in the organization to permit certain users to make changes to auto attendant and call queue configurations. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-CQ-Moh -AllowCallQueueMusicOnHoldChange $true +``` + +The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity `SDA-Allow-Moh`. This policy allows delegated administrators to change the music on hold information. + +### EXAMPLE 2 + +```powershell +New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-AA-After-Hour -AllowAutoAttendantAfterHoursGreetingChange $true +``` + +The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity `SDA-Allow-AA-After-Hour`. This policy allows delegated administrators to change after-hours greetings for auto attendants. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantAfterHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidayGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidaysChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantTimeZoneChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantAfterHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidayRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueWelcomeGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueMusicOnHoldChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOverflowSharedVoicemailGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange + +_This option is not currently available in Queues app._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueMembershipChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueConferenceModeChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueRoutingMethodChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueuePresenceBasedRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOptOutChange + +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOverflowRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueTimeoutRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueNoAgentsRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueAgentOptChange + +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorMode + +PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. + +When set to `Monitor`, users affected by the policy will be allowed to monitor and listen to call sessions. + +When set to `Whisper`, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + +When set to `Barge`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + +When set to `Takeover`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorNotificationMode + +PARAMVALUE: Disabled | Agent + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. + +When set to `Agent`, users affected by the policy will be allowed to monitor agents during call sessions. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```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 +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) + +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) + +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) + +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..e2f6188c48 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,239 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy +title: New-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# New-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet creates a Teams Workload Policy instance for the tenant. + +## SYNTAX + +```powershell +New-CsTeamsWorkLoadPolicy [-Identity] <String> [-AllowCalling <Boolean>] [-AllowCallingPinned <Boolean>] + [-AllowMeeting <Boolean>] [-AllowMeetingPinned <Boolean>] [-AllowMessaging <Boolean>] + [-AllowMessagingPinned <Boolean>] [-Description <String>] [-MsftInternalProcessingMode <String>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test +``` + +Creates a new Teams Workload Policy with the specified identity of "Test". + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Teams Workload policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..c99f3955de --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy +title: New-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# New-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. The end user experience utilizing this policy has rolled out to the general public. You can see updates at [Microsoft 365 Roadmap | Microsoft 365](https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2Cset%2Cwork%2Clocation%22https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2cset%2cwork%2clocation%22) and to learn more on how to enable the end user experience, please see [Setting up Bookable Desks in Microsoft Teams - Microsoft Teams | Microsoft Learn.](https://learn.microsoft.com/microsoftteams/rooms/bookable-desks) + +## SYNTAX + +``` +New-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection <Boolean>] [-Identity] <String> [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new instance of the TeamsWorkLocationDetectionPolicy. This policy can be used to tailor the work location detection experience. The parameter `EnableWorkLocationDetection` allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy -EnableWorkLocationDetection $true +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy True +``` +Creates a new policy instance with the identity wld-enabled. `EnableWorkLocationDetection` is set to the value specified in the command. + +### Example 2 +```powershell +PS C:\> New-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy False +``` +Creates a new policy instance with the identity wld-policy. `EnableWorkLocationDetection` will default to false if it is not specified. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWorkLocationDetection +This setting allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### TeamsWorkLocationDetectionPolicy.Cmdlets.TeamsWorkLocationDetectionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/New-CsTenantDialPlan.md b/teams/teams-ps/teams/New-CsTenantDialPlan.md new file mode 100644 index 0000000000..3496d58772 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTenantDialPlan.md @@ -0,0 +1,185 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# New-CsTenantDialPlan + +## SYNOPSIS +Use the `New-CsTenantDialPlan` cmdlet to create a new tenant dial plan. + +## SYNTAX + +``` +New-CsTenantDialPlan [-Identity] <string> [-Description <string>] [-NormalizationRules <Object>] + [-SimpleName <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to create a new tenant dial plan. Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. +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. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsTenantDialPlan -Identity vt1tenantDialPlan9 +``` + +This example creates a tenant dial plan that has an Identity of vt1tenantDialPlan9. + +### -------------------------- Example 2 -------------------------- +``` +$nr2 = New-CsVoiceNormalizationRule -Identity Global/NR2 -Description "TestNR1" -Pattern '^(d{11})$' -Translation '+1' -InMemory +New-CsTenantDialPlan -Identity vt1tenantDialPlan91 -NormalizationRules @{Add=$nr2} +``` + +This example creates a new normalization rule and then applies that rule to a new tenant dial plan. + +## PARAMETERS + +### -Identity +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 + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to and any other information that helps to identify the purpose of the tenant dial plan. +Maximum characters: 1040. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NormalizationRules +The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) cmdlet. + +Each time a new tenant dial plan is created, a new voice normalization rule with default settings is also created for that site, service, or per-user tenant dial plan. +By default, the Identity of the new voice normalization rule is the tenant dial plan Identity followed by a slash and then followed by the name Prefix All. +(For example, TAG:Redmond/Prefix All.) The number of normalization rules cannot exceed 50 per TenantDialPlan. + +You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleName +The SimpleName parameter is a display name for the tenant dial plan. +This name must be unique among all tenant dial plans. + +This string can be up to 49 characters long. +Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()). + +This parameter must contain a value. +However, if you don't provide a value, a default value matching the Identity of the tenant dial plan will be supplied. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf 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 +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. + +## RELATED LINKS + +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md b/teams/teams-ps/teams/New-CsTenantNetworkRegion.md new file mode 100644 index 0000000000..33bb7d2c2d --- /dev/null +++ b/teams/teams-ps/teams/New-CsTenantNetworkRegion.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion +applicable: Microsoft Teams +title: New-CsTenantNetworkRegion +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsTenantNetworkRegion + +## SYNOPSIS +As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + +## SYNTAX + +### Identity (Default) +``` +New-CsTenantNetworkRegion [-Identity] <string> [-BypassID <string>] [-CentralSite <string>] + [-Description <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTenantNetworkRegion -NetworkRegionID <string> [-BypassID <string>] [-CentralSite <string>] +[-Description <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTenantNetworkRegion -NetworkRegionID "RegionA" +``` + +The command shown in Example 1 creates the network region 'RegionA' with no description. Identity and CentralSite will both be set identically to NetworkRegionID. + +## PARAMETERS + +### -Identity +Unique identifier for the network region to be created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassID +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CentralSite +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network region to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRegionID +The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) + +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) + +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSite.md b/teams/teams-ps/teams/New-CsTenantNetworkSite.md new file mode 100644 index 0000000000..81412644a9 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTenantNetworkSite.md @@ -0,0 +1,264 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# New-CsTenantNetworkSite + +## SYNOPSIS +As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. The organization's network site is used for Location-Based Routing. + +## SYNTAX + +### Identity (Default) +``` +New-CsTenantNetworkSite [-Identity] <string> [-Description <string>] [-EmergencyCallingPolicy <string>] + [-EmergencyCallRoutingPolicy <string>] [-EnableLocationBasedRouting <bool>] [-LocationPolicy <string>] + [-NetworkRegionID <string>] [-NetworkRoamingPolicy <string>] [-SiteAddress <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTenantNetworkSite -NetworkSiteID <string> [-Description <string>] [-EmergencyCallingPolicy <string>] + [-EmergencyCallRoutingPolicy <string>] [-EnableLocationBasedRouting <bool>] [-LocationPolicy <string>] + [-NetworkRegionID <string>] [-NetworkRoamingPolicy <string>] [-SiteAddress <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. + +A best practice for Location Based Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration. In addition, network sites can also be used for configuring Network Roaming Policy capabilities. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTenantNetworkSite -NetworkSiteID "MicrosoftSite1" -NetworkRegionID "RegionRedmond" +``` + +The command shown in Example 1 created the network site 'MicrosoftSite1' with no description. Identity will be set identical with NetworkSiteID. + +The network region 'RegionRedmond' is created beforehand and 'MicrosoftSite1' will be associated with 'RegionRedmond'. + +NetworkSites can exist without all parameters excepts NetworkSiteID. NetworkRegionID can be left blank. + +### Example 2 +```powershell +PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site2" -Description "site 2" -NetworkRegionID "RedmondRegion" -LocationPolicy "TestLocationPolicy" -EnableLocationBasedRouting $true +``` + +The command shown in Example 2 creates the network site 'site2' with the description 'site 2'. This site is enabled for LBR, and associates with network region 'RedmondRegion' and with location policy 'TestLocationPolicy'. + +### Example 3 +```powershell +PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site3" -Description "site 3" -NetworkRegionID "RedmondRegion" -NetworkRoamingPolicy "TestNetworkRoamingPolicy" +``` + +The command shown in Example 3 creates the network site 'site3' with the description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. +## PARAMETERS + +### -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 +``` + +### -Description +Provide a description of the network site to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyCallingPolicy +This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLocationBasedRouting +This parameter determines whether the current site is enabled for Location-Based Routing. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPolicy +This parameter is reserved for Microsoft internal use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRegionID +NetworkRegionID is the identifier for the network region to which the current network site is associated to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRoamingPolicy +NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteID +The name of the network site. This must be a string that is unique. You cannot specify an NetworkSiteID and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAddress +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) + +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) + +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md new file mode 100644 index 0000000000..0639975119 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md @@ -0,0 +1,183 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +New-CsTenantNetworkSubnet [-Identity] <string> -MaskBits <int> [-Description <string>] + [-NetworkSiteID <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTenantNetworkSubnet -MaskBits <int> -SubnetID <string> [-Description <string>] + [-NetworkSiteID <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. + +When the client is sending the network subnet, please make sure we have already whitelisted the IP address by running this command-let, otherwise the request will be rejected. If you are only adding the IPv4 address by running this command-let, but your client are only sending and IPv6 address, it will be rejected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTenantNetworkSubnet -SubnetID "192.168.0.1" -MaskBits "24" -NetworkSiteID "site1" +``` + +The command shown in Example 1 created the network subnet '192.168.0.1' with no description. The subnet is IPv4 format, and the subnet is assigned to network site 'site1'. The maskbits is set to 24. + +IPv4 format subnet accepts maskbits from 0 to 32 inclusive. + +### Example 2 +```powershell +PS C:\> New-CsTenantNetworkSubnet -SubnetID "2001:4898:e8:25:844e:926f:85ad:dd8e" -MaskBits "120" -NetworkSiteID "site1" +``` + +The command shown in Example 2 created the network subnet '2001:4898:e8:25:844e:926f:85ad:dd8e' with no description. The subnet is IPv6 format, and the subnet is assigned to network site 'site1'. The maskbits is set to 120. + +IPv6 format subnet accepts maskbits from 0 to 128 inclusive. + +## PARAMETERS + +### -Identity +Unique identifier for the network subnet 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 +``` + +### -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: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network subnet to identify the purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteID +NetworkSiteID is the identifier for the network site which the current network subnet is associating to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetID +The name of the network subnet. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an NetworkSubnetID and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) + +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) + +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md new file mode 100644 index 0000000000..95772cba10 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +Module Name: tmp_rf3olqzj.wbj +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenanttrustedipaddress +title: New-CsTenantTrustedIPAddress +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: +--- + +# New-CsTenantTrustedIPAddress + +## SYNOPSIS +As an Admin, you can use the Windows PowerShell command, New-CsTenantTrustedIPAddress to define external subnets and assign them to the tenant. You can define an unlimited number of external subnets for a tenant. + +## SYNTAX + +### Identity (Default) +``` +New-CsTenantTrustedIPAddress [-Tenant <System.Guid>] [-MaskBits <System.Int32>] [-Description <String>] + [-Identity] <XdsGlobalRelativeIdentity> [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsTenantTrustedIPAddress [-Tenant <System.Guid>] -IPAddress <String> [-MaskBits <System.Int32>] + [-Description <String>] [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +###-------------------------- Example 1 -------------------------- +```powershell +PS C:\> New-CsTenantTrustedIPAddress -IPAddress "192.168.0.1" +``` + +The command shown in Example 1 created the IP address '192.168.0.1' with no description. The IP address is in IPv4 format, and the maskbits is set to 32 by default. + +###-------------------------- Example 2 -------------------------- +```powershell +PS C:\> New-CsTenantTrustedIPAddress -IPAddress "192.168.2.0" -MaskBits "24" +``` + +The command shown in Example 2 created the IP address '192.168.2.0' with no description. The IP address is in IPv4 format, and the maskbits is set to 24. + +IPv4 format IP address accepts maskbits from 0 to 32 inclusive. + +###-------------------------- Example 3 -------------------------- +```powershell +PS C:\> New-CsTenantTrustedIPAddress -IPAddress "2001:4898:e8:25:844e:926f:85ad:dd8e" -Description "IPv6 IP address" +``` + +The command shown in Example 3 created the IP address '2001:4898:e8:25:844e:926f:85ad:dd8e' with description. The IP address is in IPv6 format, and the maskbits is set to 128 by default. + +IPv6 format IP address accepts maskbits from 0 to 128 inclusive. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the trusted IP address to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaskBits +This parameter determines the length of bits to mask to the subnet. + +IPv4 format IP address accepts maskbits from 0 to 32 inclusive. If not provided, the value is set to 32. + +IPv6 format IP address accepts maskbits from 0 to 128 inclusive. If not provided, the value is set to 128. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose IP addresses are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsUserCallingDelegate.md b/teams/teams-ps/teams/New-CsUserCallingDelegate.md new file mode 100644 index 0000000000..bcb61efbcc --- /dev/null +++ b/teams/teams-ps/teams/New-CsUserCallingDelegate.md @@ -0,0 +1,137 @@ +--- +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 <String> -Delegate <String> -MakeCalls <Boolean> -ReceiveCalls <Boolean> -ManageSettings <Boolean> [<CommonParameters>] +``` + +## 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) diff --git a/skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md similarity index 80% rename from skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md index 524c2c7f1a..06ece90114 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md @@ -1,9 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: New-CsVideoInteropServiceProvider schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsVideoInteropServiceProvider @@ -32,7 +37,7 @@ Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join T 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 -Name 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 "Name" matches a valid policy. Make sure that your "Name" matches a valid policy. +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 @@ -46,7 +51,7 @@ PS C:\> New-CsVideoInteropServiceProvider ## PARAMETERS ### -AadApplicationIds -This is an optional parameter. A semicolon separated list of AAD AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. +This is an optional parameter. A semicolon separated list of Microsoft Entra AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. ```yaml Type: String @@ -62,7 +67,7 @@ Accept wildcard characters: False ### -AllowAppGuestJoinsAsAuthenticated This is an optional parameter. Default = false. -This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots AAD application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. +This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots Microsoft Entra application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. ```yaml Type: Boolean @@ -111,7 +116,7 @@ This is mandatory parameter and can have only one of the 6 values PolycomServiceProviderEnabled PexipServiceProviderEnabled BlueJeansServiceProviderEnabled - + PolycomServiceProviderDisabled PexipServiceProviderDisabled BlueJeansServiceProviderDisabled @@ -159,14 +164,12 @@ Accept wildcard characters: False ``` ### -Name -This is mandatory parameter and can have only one of the 6 values -PolycomServiceProviderEnabled -PexipServiceProviderEnabled -BlueJeansServiceProviderEnabled - -PolycomServiceProviderDisabled -PexipServiceProviderDisabled -BlueJeansServiceProviderDisabled +This is mandatory parameter and can have only one of the 4 values + +Polycom +BlueJeans +Pexip +Cisco ```yaml Type: String @@ -175,7 +178,7 @@ Aliases: Required: True Position: Named -Default value: None +Default value: DefaultProvider Accept pipeline input: False Accept wildcard characters: False ``` @@ -227,14 +230,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md b/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md new file mode 100644 index 0000000000..50a147a31f --- /dev/null +++ b/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md @@ -0,0 +1,372 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule +applicable: Microsoft Teams +title: New-CsVoiceNormalizationRule +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +--- + +# New-CsVoiceNormalizationRule + +## SYNOPSIS +Creates a new voice normalization rule. + +Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by +Skype for Business Server or Microsoft Teams. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +New-CsVoiceNormalizationRule [-Tenant <Guid>] [-Description <String>] [-Pattern <String>] + [-Translation <String>] [-IsInternalExtension <Boolean>] [-Priority <Int32>] [-Identity] <XdsIdentity> + [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndRelativeKey +``` +New-CsVoiceNormalizationRule [-Tenant <Guid>] -Parent <String> -Name <String> [-Description <String>] + [-Pattern <String>] [-Translation <String>] [-IsInternalExtension <Boolean>] [-Priority <Int32>] [-InMemory] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a named voice normalization rule. +These rules are a required part of phone authorization and call routing. +They define the requirements for converting (or translating) numbers from an internal format to a standard (E.164) format. +An understanding of regular expressions is helpful in order to define number patterns that will be translated. + +For Lync or Skype for Business Server, rules that are created by using this cmdlet are part of the dial plan and in addition to being accessible through the +`Get-CsVoiceNormalizationRule` cmdlet can also be accessed through the NormalizationRules property returned by a call to the `Get-CsDialPlan` cmdlet. +You cannot create a normalization rule unless a dial plan with an Identity matching the scope specified in the normalization rule Identity already exists. +For example, you can't create a normalization rule with the Identity site:Redmond/RedmondNormalizationRule unless a dial plan for site:Redmond already exists. + +For Microsoft Teams, rules that are created by using this cmdlet can only be created with the InMemory switch and should be added to a tenant dial plan using +the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" +``` + +This example creates a new voice normalization rule for site Redmond named Prefix Redmond. +Because no other parameters are specified, the rule is created with the default values. +Notice that the value passed to the Identity parameter is in double quotes; this is because the name of the rule (Prefix Redmond) contains a space. +If the rule name does not contain a space you don't need to enclose the Identity in double quotes. + +Keep in mind that a dial plan for the Redmond site must exist for this command to succeed. +You can create a new dial plan by calling the `New-CsDialPlan` cmdlet. + +### -------------------------- Example 2 -------------------------- +``` +New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' +``` + +This example creates a new voice normalization rule named SeattleFourDigit that applies to the per-user dial plan with the Identity SeattleUser. +(Note: Rather than specifying a Parent and a Name, we could have instead created this same rule by specifying -Identity SeattleUser/SeattleFourDigit.) We've included a Description explaining that this rule is for translating numbers dialed internally with only a 4-digit extension. +In addition, Pattern and Translation values have been specified. +These values translate a four-digit number (specified by the regular expression in the Pattern) to the same four-digit number, but prefixed by the Translation value (+1206555). +For example, if the extension 1234 was entered, this rule would translate that extension to the number +12065551234. + +Note the single quotes around the Pattern and Translation values. +Single quotes are required for these values; double quotes (or no quotes) will not work in this instance. + +As in Example 1, a dial plan with the given scope must exist. +In this case, that means a dial plan with the Identity SeattleUser must already exist. + +### -------------------------- Example 3 -------------------------- +``` +$nr1=New-CsVoiceNormalizationRule -Identity dp1/nr1 -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' -InMemory +New-CsTenantDialPlan -Identity DP1 -NormalizationRules @{Add=$nr1} +``` + +This example creates a new in-memory voice normalization rule and then adds it to a new tenant dial plan DP1 to be used for Microsoft Teams users. + +## PARAMETERS + +### -Identity +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +The name portion will automatically be stored in the Name property. +You cannot specify values for Identity and Name in the same command. + +For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. +A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. +(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) + +For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. + +The Identity parameter is required unless the Parent parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule. +This parameter is required if a value has been specified for the Parent parameter. +If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. +For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. +The Name parameter and the Identity parameter cannot be used in the same command. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent +The scope at which the new normalization rule will be created. +This value must be global; site:\<sitename\>, where \<sitename\> is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as +PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. +A dial plan with the specified scope must already exist or the command will fail. + +The Parent parameter is required unless the Identity parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. +If you include the Parent parameter, the Name parameter is also required. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A friendly description of the normalization rule. + +Maximum string length: 512 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsInternalExtension +If True, the result of applying this rule will be a number internal to the organization. +If False, applying the rule results in an external number. +This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. + +Default: False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the dialed number must match in order for this rule to be applied. + +Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The order in which rules are applied. +A phone number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Translation +The regular expression pattern that will be applied to the number to convert it to E.164 format. + +Default: +$1 (The default prefixes the number with a plus sign \[+\].) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. + +For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the +object reference and then commit those changes by calling this cmdlet's matching Set-\<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 +``` + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +For internal Microsoft usage. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +None. + +## OUTPUTS + +### Output types +This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule. + +## NOTES + +## RELATED LINKS + +[Test-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule) + +[Get-CsDialPlan](https://learn.microsoft.com/powershell/module/teams/get-csdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-Team.md b/teams/teams-ps/teams/New-Team.md index 6aa44b09f1..5ca7ae7b5c 100644 --- a/teams/teams-ps/teams/New-Team.md +++ b/teams/teams-ps/teams/New-Team.md @@ -1,25 +1,48 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/new-team title: New-Team -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-Team ## SYNOPSIS -This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. If you want these groups to appear in Outlook clients, you can use the Set-UnifiedGroup (https://docs.microsoft.com/en-us/powershell/module/exchange/users-and-groups/set-unifiedgroup?view=exchange-ps) cmdlet in the Exchange Powershell Module to set the parameter HiddenFromExchangeClients to $false. +This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. +Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. -Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. -Note: This cmdlet is currently in Beta and functionality may change. +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) ``` -New-Team [-Group <String>] [-DisplayName <String>] [-Description <String>] [-Alias <String>] - [-Classification <String>] [-AccessType <String>] [-AddCreatorAsMember <Boolean>] [-Template <String>] [<CommonParameters>] +New-Team -DisplayName <String> [-Description <String>] [-MailNickName <String>] [-Classification <String>] + [-Visibility <String>] [-Template <String>] [-Owner <String>] [-AllowGiphy <Boolean>] + [-GiphyContentRating <String>] [-AllowStickersAndMemes <Boolean>] [-AllowCustomMemes <Boolean>] + [-AllowGuestCreateUpdateChannels <Boolean>] [-AllowGuestDeleteChannels <Boolean>] + [-AllowCreateUpdateChannels <Boolean>] [-AllowDeleteChannels <Boolean>] [-AllowAddRemoveApps <Boolean>] + [-AllowCreateUpdateRemoveTabs <Boolean>] [-AllowCreateUpdateRemoveConnectors <Boolean>] + [-AllowUserEditMessages <Boolean>] [-AllowUserDeleteMessages <Boolean>] [-AllowOwnerDeleteMessages <Boolean>] + [-AllowTeamMentions <Boolean>] [-AllowChannelMentions <Boolean>] [-ShowInTeamsSearchAndSuggestions <Boolean>] + [-RetainCreatedGroup <SwitchParameter>] [-AllowCreatePrivateChannels <Boolean>] [<CommonParameters>] +``` + +### MigrateGroup +``` +New-Team -GroupId <String> [-Owner <String>] [-AllowGiphy <Boolean>] [-GiphyContentRating <String>] + [-AllowStickersAndMemes <Boolean>] [-AllowCustomMemes <Boolean>] [-AllowGuestCreateUpdateChannels <Boolean>] + [-AllowGuestDeleteChannels <Boolean>] [-AllowCreateUpdateChannels <Boolean>] [-AllowDeleteChannels <Boolean>] + [-AllowAddRemoveApps <Boolean>] [-AllowCreateUpdateRemoveTabs <Boolean>] + [-AllowCreateUpdateRemoveConnectors <Boolean>] [-AllowUserEditMessages <Boolean>] + [-AllowUserDeleteMessages <Boolean>] [-AllowOwnerDeleteMessages <Boolean>] [-AllowTeamMentions <Boolean>] + [-AllowChannelMentions <Boolean>][-ShowInTeamsSearchAndSuggestions <Boolean>] [-RetainCreatedGroup <SwitchParameter>] [<CommonParameters>] ``` ## DESCRIPTION @@ -32,35 +55,41 @@ Creates a new team with user specified settings, and returns a Group object with New-Team -DisplayName "Tech Reads" ``` +This example creates a team with all parameters with their default values. + ### Example 2 ``` -New-Team -DisplayName "Tech Reads" -Description "Team to post technical articles and blogs" -AccessType Public +New-Team -DisplayName "Tech Reads" -Description "Team to post technical articles and blogs" -Visibility Public ``` +This example creates a team with a specific description and public visibility. + ### Example 3 ``` -Connect-MicrosoftTeams -AccountId myaccount@example.com -$group = New-Team -alias "TestTeam" -displayname "Test Teams" -AccessType "private" +$group = New-Team -MailNickname "TestTeam" -displayname "Test Teams" -Visibility "private" Add-TeamUser -GroupId $group.GroupId -User "fred@example.com" Add-TeamUser -GroupId $group.GroupId -User "john@example.com" Add-TeamUser -GroupId $group.GroupId -User "wilma@example.com" New-TeamChannel -GroupId $group.GroupId -DisplayName "Q4 planning" New-TeamChannel -GroupId $group.GroupId -DisplayName "Exec status" New-TeamChannel -GroupId $group.GroupId -DisplayName "Contracts" -Set-TeamFunSettings -GroupId $group.GroupId -AllowCustomMemes true ``` +This example creates a team, adds three members to it, and creates three channels within it. + ## PARAMETERS -### -AccessType -Team visibility. -Valid values are "Private" and "Public". -Default is "Private". -(In Set-Team this parameter is called Visibility.) +### -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: (All) +Parameter Sets: CreateTeam Aliases: Required: False @@ -70,30 +99,27 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -AddCreatorAsMember -This setting lets you decide, if you will be added as a member of the group. -Because you are automatically an owner of the group, you will always be added as a member to the team. +### -Classification +This parameter is reserved for internal Microsoft use. ```yaml -Type: Boolean -Parameter Sets: (All) +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 ``` -### -Alias -The Alias 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 Alias parameter has to be unique across your tenant. - -For more details about the naming conventions see here: [New-UnifiedGroup, Parameter: -Alias](https://docs.microsoft.com/en-us/powershell/module/exchange/users-and-groups/new-unifiedgroup?view=exchange-ps#optional-parameters). +### -Description +Team description. Characters Limit - 1024. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: CreateTeam Aliases: Required: False @@ -103,28 +129,30 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Classification -Team classification +### -DisplayName +Team display name. Characters Limit - 256. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: CreateTeam Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Team description. -Team Description Characters Limit - 1024. +### -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: (All) +Parameter Sets: CreateTeam Aliases: Required: False @@ -134,9 +162,11 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Team display name. -Team Name Characters Limit - 256. +### -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: String @@ -150,28 +180,233 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Group -Use this parameter to specify the GroupId of a group you would like to convert to a team. -If you are using this parameter, do not specify other parameters. +### -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 ``` +### -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. -### -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. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -Valid values are: "EDU_Class" or "EDU_PLC" +Required: False +Position: Named +Default value: True +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCustomMemes +Setting that determines whether or not members can use the custom memes functionality in teams. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphy +Setting that determines whether or not giphy can be used in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGuestCreateUpdateChannels +Setting that determines whether or not guests can create channels in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGuestDeleteChannels +Setting that determines whether or not guests can delete in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickersAndMemes +Setting that determines whether stickers and memes usage is allowed in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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) + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessages +Setting that determines whether or not members can delete messages that they have posted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessages +Setting that determines whether or not users can edit messages that they have posted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +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" ```yaml Type: String @@ -180,15 +415,89 @@ Aliases: Required: False Position: Named +Default value: Moderate +Accept pipeline input: False +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). + +```yaml +Type: String +Parameter Sets: MigrateGroup +Aliases: + +Required: True +Position: Named Default value: None 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 +``` + +### -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 +``` + +### -RetainCreatedGroup +Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. + +```yaml +Type: Boolean +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -199,6 +508,9 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## NOTES ## RELATED LINKS -[Get-Team](Get-Team.md) -[Set-Team](Set-Team.md) +[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) + +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) + +[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) diff --git a/teams/teams-ps/teams/New-TeamChannel.md b/teams/teams-ps/teams/New-TeamChannel.md index d7d4e302d8..579b2c7209 100644 --- a/teams/teams-ps/teams/New-TeamChannel.md +++ b/teams/teams-ps/teams/New-TeamChannel.md @@ -1,33 +1,43 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/new-teamchannel title: New-TeamChannel -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # New-TeamChannel ## SYNOPSIS -Note: This cmdlet is currently in Beta. Add a new channel to a team. ## SYNTAX ``` -New-TeamChannel -GroupId <String> -DisplayName <String> [-Description <String>] +New-TeamChannel -GroupId <String> -DisplayName <String> [-Description <String>] [-MembershipType <String>] [-Owner <String>] [<CommonParameters>] ``` ## DESCRIPTION +Add a new channel to a team. + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-TeamChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -DisplayName "Architecture" ``` +Create a standard channel with display name as "Architecture" + +### Example 2 +``` +New-TeamChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -DisplayName "Engineering" -MembershipType Private +``` +Create a private channel with display name as "Engineering" ## PARAMETERS @@ -38,7 +48,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -55,7 +64,6 @@ Names must be 50 characters or less, and can't contain the characters # % & * { Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -72,7 +80,6 @@ Channel description can be up to 1024 characters. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -81,13 +88,42 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -## INPUTS +### -MembershipType +Channel membership type, Standard, Shared, or Private. -### GroupId +```yaml +Type: String +Parameter Sets: (All) +Aliases: -### DisplayName +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` -### Description +### -Owner +UPN of owner that can be specified while creating a private channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### GroupId, DisplayName, Description, MembershipType, Owner ## OUTPUTS @@ -96,4 +132,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/New-TeamsApp.md b/teams/teams-ps/teams/New-TeamsApp.md new file mode 100644 index 0000000000..1ba731d7b5 --- /dev/null +++ b/teams/teams-ps/teams/New-TeamsApp.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-teamsapp +title: New-TeamsApp +schema: 2.0.0 +--- + +# New-TeamsApp + +## SYNOPSIS +Creates a new app in the Teams tenant app store. + +## SYNTAX + +``` +New-TeamsApp -DistributionMethod <String> -Path <String> [<CommonParameters>] +``` + +## DESCRIPTION +Use a Teams app manifest zip file to upload an app to the tenant app store. DistributionMethod specifies that the app should be added to the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-TeamsApp -DistributionMethod organization -Path c:\Path\SampleApp.zip +``` + +## PARAMETERS + +### -DistributionMethod +The type of app in Teams: global or organization. For LOB apps, use "organization" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The local path of the app manifest zip file, for use in New and Set + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md new file mode 100644 index 0000000000..e2c1985c62 --- /dev/null +++ b/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/register-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams +title: Register-CsOnlineDialInConferencingServiceNumber +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Register-CsOnlineDialInConferencingServiceNumber + +## SYNOPSIS +When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Microsoft Teams meetings using a phone. +In addition to the phone numbers already assigned to your conferencing bridge, you can get additional service numbers (toll and toll-free numbers used for audio conferencing) from other locations, and then assign them to the conferencing bridge so you can expand coverage for your users. The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. + +## SYNTAX + +### UniqueNumberParams +``` +Register-CsOnlineDialInConferencingServiceNumber [-Identity] <String> [-BridgeId <Guid>] + [-BridgeName <String>] [-Tenant <Guid>] [-TenantDomain <String>] [-DomainController <Fqdn>] [-Force] + [<CommonParameters>] +``` + +### InstanceParams +``` +Register-CsOnlineDialInConferencingServiceNumber [-Instance] <ConferencingServiceNumber> + [-BridgeId <Guid>] [-BridgeName <String>] [-Tenant <Guid>] [-TenantDomain <String>] + [-DomainController <Fqdn>] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Register-CsOnlineDialinConferencingServiceNumber -Identity +1425555XXX -BridgeId fb91u3e9-5c2a-42c3-8yy5-ec02beexxx09 +``` + +This command registers the telephone number +1425555XXX to your conference bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. + +## PARAMETERS + +### -Identity +PARAMVALUE: String + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +PARAMVALUE: ConferencingServiceNumber + +```yaml +Type: ConferencingServiceNumber +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BridgeId +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 +``` + +### -BridgeName +PARAMVALUE: String + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +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: DC +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: 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 +``` + +### -TenantDomain +PARAMVALUE: String + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..29aebeff75 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md @@ -0,0 +1,73 @@ +--- +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 +ms.author: frpeng +ms.reviewer: +--- + +# Remove-CsApplicationAccessPolicy + +## SYNOPSIS + +Deletes an existing application access policy. + +## SYNTAX + +### Identity + +``` +Remove-CsApplicationAccessPolicy [-Identity <XdsIdentity>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet deletes an existing application access policy. + +## EXAMPLES + +### Remove an application access policy + +``` +PS C:\> Remove-CsApplicationAccessPolicy -Identity "ASimplePolicy" +``` + +The command shown above deletes the application access policy ASimplePolicy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsAutoAttendant.md b/teams/teams-ps/teams/Remove-CsAutoAttendant.md new file mode 100644 index 0000000000..a847c6ab1f --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsAutoAttendant.md @@ -0,0 +1,92 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsAutoAttendant + +## 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 + +``` +Remove-CsAutoAttendant -Identity <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-CsAutoAttendant cmdlet deletes an AA that is specified by the Identity parameter. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Remove-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" +``` + +This example deletes the AA that has an identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. + +## PARAMETERS + +### -Identity +The identity for the AA to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### String +The Remove-CsAutoAttendant cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) + +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) + +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) diff --git a/teams/teams-ps/teams/Remove-CsCallQueue.md b/teams/teams-ps/teams/Remove-CsCallQueue.md new file mode 100644 index 0000000000..b4138debb8 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsCallQueue.md @@ -0,0 +1,85 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsCallQueue + +## SYNOPSIS +The Remove-CsCallQueue cmdlet deletes an existing Call Queue. + +## SYNTAX + +``` +Remove-CsCallQueue -Identity <Guid> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-CsCallQueue cmdlet deletes an existing Call Queue specified by the Identity parameter. The removal will fail if there are any ApplicationInstances still associated with the Call Queue. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example removes the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Call Queue exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Identity +Represents the unique identifier of a Call Queue. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md b/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md new file mode 100644 index 0000000000..0a95b6cbed --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md @@ -0,0 +1,103 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsCallingLineIdentity + +## SYNOPSIS +Use the `Remove-CsCallingLineIdentity` cmdlet to remove a Caller ID policy from your organization. + +## SYNTAX + +``` +Remove-CsCallingLineIdentity [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will remove a Caller ID policy from your organization or resets the Global policy instance to the default values. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Remove-CsCallingLineIdentity -Identity Anonymous +``` + +This example removes a Caller ID policy. + +## PARAMETERS + +### -Identity +The Identity parameter identifies the Caller ID policy. + +```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 +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) + +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) + +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) + +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..8d0edf2cca --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: Remove-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +Remove-CsComplianceRecordingForCallQueueTemplate -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. If the template is currently assigned to a call queue, an error will be returned. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example deletes the Compliance Recording for Call Queue template with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Compliance Recording for Call Queue template exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Id +The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md b/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md new file mode 100644 index 0000000000..c5fbbf878d --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md @@ -0,0 +1,71 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsCustomPolicyPackage +author: sunguchuan +ms.author: gucsun +manager: dasosby +online version: https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage +schema: 2.0.0 +--- + +# Remove-CsCustomPolicyPackage + +## SYNOPSIS + +This cmdlet deletes a custom policy package. + +## SYNTAX + +``` +Remove-CsCustomPolicyPackage -Identity <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet deletes a custom policy package. All available package names can be found by running Get-CsPolicyPackage. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsCustomPolicyPackage -Identity "MyPackage" +``` + +Deletes a custom package named "MyPackage". + +## PARAMETERS + +### -Identity + +The name of the custom package. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +Default packages created by Microsoft cannot be deleted. + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) + +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..a801caa0bb --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy +applicable: Microsoft Teams +title: Remove-CsExternalAccessPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Remove-CsExternalAccessPolicy + +## SYNOPSIS +Enables you to remove an existing external access policy. +External access policies determine whether or not your users can: 1) Communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) Communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; 3) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop) and 4) Access Skype for Business Server over the Internet, without having to log on to your internal network. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +``` +Remove-CsExternalAccessPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +1. That might be sufficient to meet your communication needs. +If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +2. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +3. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. + +Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +When you install Skype for Business Server, a global external access policy is automatically created for you. +In addition to the global policy, you can use the `New-CsExternalAccessPolicy` cmdlet to create external access policies configured at the site or per-user scopes. + +The `Remove-CsExternalAccessPolicy` cmdlet enables you to delete any policies that were created by using the `New-CsExternalAccessPolicy` cmdlet; that means you can delete any policies assigned to the site scope or the per-user scope. +You can also run the `Remove-CsExternalAccessPolicy` cmdlet against the global external access policy. +In that case, however, the global policies will not be deleted; by design, global policies cannot be deleted. +Instead, the properties of the global policy will simply be reset to their default values. + +## EXAMPLES + +### -------------------------- Example 1 ------------------------ +``` +Remove-CsExternalAccessPolicy -Identity site:Redmond +``` + +In Example 1, the external access policy with the Identity site:Redmond is deleted. +After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. + +### -------------------------- Example 2 ------------------------ +``` +Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy +``` + +Example 2 deletes all the external access policies that have been configured at the site scope. +To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". +The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. + +### -------------------------- Example 3 ------------------------ +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy +``` + +In Example 3, all the external access policies that allow federation access are deleted. +To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to return a collection of all the external access policies configured for use in the organization. +This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. +This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. + +### -------------------------- Example 4 ------------------------ +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy +``` + +Example 4 deletes all the external access policies that meet at least one of two criteria: federation access is allowed, public cloud access is allowed, or both are allowed. +To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet to return a collection of all the external access policies configured for use in the organization. +This collection is then piped to the `Where-Object` cmdlet, which selects only those policies that meet the following criteria: either EnableFederationAccess is equal to True and/or EnablePublicCloudAccess is equal to True. +Policies meeting one (or both) of those criteria are then piped to and removed by, the `Remove-CsExternalAccessPolicy` cmdlet. + +To delete all the policies where both EnableFederationAccess and EnablePublicCloudAccess are True use the -and operator when calling the `Where-Object` cmdlet: + +`Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True}` + +## PARAMETERS + +### -Identity +Unique identifier for the external access policy to be removed. +External access policies can be configured at the global, site, or per-user scopes. +To "remove" the global policy, use this syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. +Instead, all the properties in the global policy will be reset to their default values.) To remove a site policy, use syntax similar to this: `-Identity site:Redmond`. +To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. + +Note that wildcards are not allowed when specifying an Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being removed. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +The `Remove-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. + +## OUTPUTS + +### Output types +None. +Instead, the `Remove-CsExternalAccessPolicy` cmdlet does not return a value or object. +Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md new file mode 100644 index 0000000000..db975cb1bc --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment +title: Remove-CsGroupPolicyAssignment +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsGroupPolicyAssignment + +## SYNOPSIS + +This cmdlet is used to remove a group policy assignment. + +## SYNTAX + +``` +Remove-CsGroupPolicyAssignment -GroupId <String> -PolicyType <String> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes the policy of a specific type from a group. A group can only be assigned one policy of a given type, so the name of the policy to be removed does not need to be specified. + +When a policy assignment is removed from a group, any other group policy assignments of the same type that have lower rank will be updated. For example, if the policy assignment with rank 2 is removed, then the rank 3 and 4 policy assignments will be updated to rank 2 and 3 respectively. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + +Remove-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingPolicy + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +``` + +In this example, the policy assignment with rank 2 is removed. As a result, the policy assignment with rank 3 is updated to rank 2. + +## PARAMETERS + +### -GroupId +The ID of the group from which the assignment will be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +``` + +### -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 +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) + +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) + +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..d08b9fba67 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber +applicable: Microsoft Teams +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +title: Remove-CsHybridTelephoneNumber +schema: 2.0.0 +--- + +# Remove-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet removes a hybrid telephone number. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the new **New-CsOnlineTelephoneNumberReleaseOrder** cmdlet to remove a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineTelephoneNumberReleaseOrder](/powershell/module/teams/new-csonlinetelephonenumberreleaseorder?view=teams-ps). + +## SYNTAX + +### Identity (Default) +```powershell +Remove-CsHybridTelephoneNumber -TelephoneNumber <string> [-Force] [-WhatIf] [-Confirm][<CommonParameters>] +``` + +## 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-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md new file mode 100644 index 0000000000..c41907981c --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Remove-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# Remove-CsInboundBlockedNumberPattern + +## SYNOPSIS +Removes a blocked number pattern from the tenant list. + +## SYNTAX + +``` +Remove-CsInboundBlockedNumberPattern [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes a blocked number pattern from the tenant list. + +## EXAMPLES + +### Example 1 +```powershell +PS> Remove-CsInboundBlockedNumberPattern -Identity "BlockAutomatic" +``` + +This example removes a blocked number pattern identified as "BlockAutomatic". + +## PARAMETERS + +### -Identity +A unique identifier specifying the blocked number pattern to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) + +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) + +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md new file mode 100644 index 0000000000..2abeb0572b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: Remove-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Remove-CsInboundExemptNumberPattern + +## SYNOPSIS +Removes a number pattern exempt from call blocking. + +## SYNTAX + +``` +Remove-CsInboundExemptNumberPattern [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes a specific exempt number pattern from the tenant list for call blocking. + +## EXAMPLES + +### Example 1 +```powershell +PS>Remove-CsInboundExemptNumberPattern -Identity "Exempt1" +``` + +This removes the exempt number patterns with Identity Exempt1. + +## PARAMETERS + +### -Identity +Unique identifier for the exempt number pattern to be listed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. + +## RELATED LINKS +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) + +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) + +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md new file mode 100644 index 0000000000..1fb51dfc00 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md @@ -0,0 +1,91 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsOnlineApplicationInstanceAssociation + +## SYNOPSIS +Use the Remove-CsOnlineApplicationInstanceAssociation cmdlet to remove the association between an application instance and the associated application configuration. + +## SYNTAX + +``` +Remove-CsOnlineApplicationInstanceAssociation -Identities <String[]> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Remove-CsOnlineApplicationInstanceAssociation cmdlet to remove the association between an application instance and the associated application configuration. + +This is useful when you want to associate this application instance with another application configuration for handling incoming calls. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Remove-CsOnlineApplicationInstanceAssociation -Identities "f7a821dc-2d69-5ae8-8525-bcb4a4556093" +``` + +This example removes the configuration association for the application instance that has the identity of "f7a821dc-2d69-5ae8-8525-bcb4a4556093". + +## PARAMETERS + +### -Identities +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] +The Remove-CsOnlineApplicationInstanceAssociation cmdlet accepts a string array as the Identities parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.AssociationOperationOutput + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) + +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) + +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..b9ca408b21 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,128 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy +title: Remove-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Remove-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] <String> [-MsftInternalProcessingMode <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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/teams/Remove-CsOnlineAudioFile.md new file mode 100644 index 0000000000..61f7bace1f --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile +applicable: Microsoft Teams +title: Remove-CsOnlineAudioFile +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Remove-CsOnlineAudioFile + +## SYNOPSIS +Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours). + +## SYNTAX + +```powershell +Remove-CsOnlineAudioFile -Identity <string> [<CommonParameters>] + +``` + +## DESCRIPTION +This cmdlet marks an audio file of application type TenantGlobal for deletion and later removal. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsOnlineAudioFile -Identity dcfcc31daa9246f29d94d0a715ef877e +``` +This cmdlet marks the audio file with Id dcfcc31daa9246f29d94d0a715ef877e for deletion and later removal. + +## PARAMETERS + +### -Identity +The Id of the specific audio file that you would like to mark for deletion. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +Please note that using this cmdlet on other application types like OrgAutoAttendant and HuntGroup does not mark the audio file for deletion. These kinds of audio files will automatically be deleted, when + +the corresponding Auto Attendant or Call Queue is deleted. + +The cmdlet is available in Teams PS module 2.4.0-preview or later. + +## RELATED LINKS + +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) + +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/skype/skype-ps/skype/Remove-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md index d181b02559..09faa588af 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings +applicable: Microsoft Teams title: Remove-CsOnlineDialInConferencingTenantSettings schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Remove-CsOnlineDialInConferencingTenantSettings @@ -30,7 +35,6 @@ Remove-CsOnlineDialInConferencingTenantSettings This example reverts the tenant level dial-in conferencing settings to their original defaults. - ## PARAMETERS ### -Identity @@ -39,8 +43,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -56,7 +60,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -73,8 +77,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -89,8 +93,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -107,7 +111,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -117,19 +121,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None - ## OUTPUTS -### -None - ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md new file mode 100644 index 0000000000..e78d109481 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md @@ -0,0 +1,134 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineLisCivicAddress + +## SYNOPSIS +Use the Remove-CsOnlineLisCivicAddress cmdlet to delete an existing civic address from the Location Information Server (LIS). + +You can't remove a civic address if any of its associated locations are assigned to users or phone numbers. + +## SYNTAX + +``` +Remove-CsOnlineLisCivicAddress -CivicAddressId <guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes the specified emergency address or addresses. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsOnlineLisCivicAddress -CivicAddressId ee38d9a5-33dc-4a32-9fb8-f234cedb91ac +``` + +This example removes the emergency civic address with the specified identification. + +### Example 2 +```powershell +Get-CsOnlineLisCivicAddress -City Redmond | Remove-CsOnlineLisCivicAddress +``` + +This example removes all the emergency civic addresses in the city of Redmond. + +## PARAMETERS + +### -CivicAddressId +Specifies the unique identifier of the civic address to be deleted. +You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress cmdlet. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### This cmdlet accepts pipelined input from the Get-CsOnlineLisCivicAddress cmdlet. + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) + +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) + +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md b/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md new file mode 100644 index 0000000000..4006964361 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md @@ -0,0 +1,127 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineLisLocation + +## SYNOPSIS +Use the Remove-CsOnlineLisLocation cmdlet to remove an existing emergency location from the Location Information Service (LIS). + +You can only remove locations that have no assigned users or phone numbers. You can't remove the default location, you will have to delete the associated +civic address which will delete the default location. + +## SYNTAX +``` +Remove-CsOnlineLisLocation -LocationId <Guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +If the location specified for removal is assigned to users, the cmdlet will fail until the users assignments are removed. + +## EXAMPLES + +### Example 1 +``` +Remove-CsOnlineLisLocation -LocationId 788dd820-c136-4255-9f61-24b880ad0763 +``` + +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 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +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 +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### This cmdlet supports pipelined input from the Get-CsOnlineLisLocation cmdlet. + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) + +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) + +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md b/teams/teams-ps/teams/Remove-CsOnlineLisPort.md new file mode 100644 index 0000000000..6e1665a058 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineLisPort.md @@ -0,0 +1,190 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineLisPort + +## SYNOPSIS +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. + +## SYNTAX + +``` +Remove-CsOnlineLisPort [-ChassisID] <string> -PortID <string> [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] [-TargetStore <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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 removes an association between a physical location and a port through which calls will be routed by removing the port from the location configuration database. + +Removing a port location will not remove the actual location of the port; it removes only the port. + +## EXAMPLES + +### Example 1 +``` +Remove-CsOnlineLisPort -PortID 12174 -ChassisID 0B-23-CD-16-AA-CC +``` + +Example 1 removes the location information for port 12174 with ChassisID 0B-23-CD-16-AA-CC. + +## PARAMETERS + +### -ChassisID +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PortID +This parameter identifies the ID of the port. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) + +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md b/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md new file mode 100644 index 0000000000..eec633e37e --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md @@ -0,0 +1,191 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineLisSubnet + +## SYNOPSIS +Removes a Location Information Server (LIS) subnet. + +## SYNTAX + +``` +Remove-CsOnlineLisSubnet [[-TenantId] <Guid>] [-Subnet] <String> [-IsDebug <Boolean>] [-TargetStore <String>] + [-NCSApiUrl <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Enhanced 9-1-1 (E9-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 removes a subnet from the location configuration database. Removing the subnet will not remove the location associated with that subnet. Use the \`Remove-CsOnlineLisLocation\` cmdlet to remove a location. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsOnlineLisSubnet -Subnet 10.10.10.10 +``` + +Example 1 removes the Location Information Service subnet "10.10.10.10". + +### -------------------------- Example 2 -------------------------- +``` +Remove-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e +``` + +Example 1 removes the Location Information Service subnet "2001:4898:e8:6c:90d2:28d4:76a4:ec5e". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: 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 + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md b/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md new file mode 100644 index 0000000000..be82fd7ba5 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md @@ -0,0 +1,172 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineLisSwitch + +## SYNOPSIS +Removes a Location Information Server (LIS) network switch. + +## SYNTAX + +``` +Remove-CsOnlineLisSwitch [-ChassisID] <string> [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] + [-TargetStore <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Enhanced 9-1-1 (E9-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 removes a switch from the location configuration database. Removing a switch will not remove the actual location; it removes only the switch. To remove the location, call the \`Remove-CsLisOnlineLocation\` cmdlet. + +## EXAMPLES + +### Example 1 +``` +Remove-CsOnlineLisSwitch -ChassisID 0B-23-CD-16-AA-CC +``` + +Example 1 removes the switch with Chassis ID "0B-23-CD-16-AA-CC". + +## PARAMETERS + +### -ChassisID +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) + +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md new file mode 100644 index 0000000000..ff2c7da4d7 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md @@ -0,0 +1,181 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineLisWirelessAccessPoint + +## SYNOPSIS +Removes a Location Information Server (LIS) wireless access point (WAP). + +## SYNTAX + +``` +Remove-CsOnlineLisWirelessAccessPoint [-BSSID] <string> [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] [-TargetStore <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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 removes a WAP from the location configuration database. Removing the WAP will not remove the location associated with that WAP. Use the \`Remove-CsLisOnlineLocation\` cmdlet to remove a location. + +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 a range which are sharing the same description and Location ID. The wildcard '*' can be on either the last one or two character(s). + +If a BSSID with wildcard format is already exists, the request for removing a single BSSID which is within this wildcard range and with the same location ID will not be accepted. + +## EXAMPLES + +### Example 1 +``` +Remove-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-03-23 +``` + +Example 1 removes the Location Information Server (LIS) wireless access point with BSS ID "F0-6E-0B-C2-03-23". + +### Example 2 +``` +Remove-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-04-* +``` + +Example 2 removes the Location Information Server (LIS) wireless access point with BSS ID "F0-6E-0B-C2-04-*". + +## PARAMETERS + +### -BSSID +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) + +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md new file mode 100644 index 0000000000..6af2287599 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md @@ -0,0 +1,69 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlinePSTNGateway + +## SYNOPSIS +Removes 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. + +## SYNTAX +``` +Remove-CsOnlinePSTNGateway [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to remove the configuration of the previously created Session Border Controller(s) (SBC(s)) configuration. Note the SBC must be removed from all voice routes before executing this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsOnlinePSTNGateway -Identity sbc.contoso.com +``` + +This example removes SBC with Identity (and FQDN) sbc.contoso.com. + +## PARAMETERS + +### -Identity +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 +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 + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) + +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) + +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md b/teams/teams-ps/teams/Remove-CsOnlineSchedule.md new file mode 100644 index 0000000000..6dc49f8900 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineSchedule.md @@ -0,0 +1,86 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsOnlineSchedule + +## SYNOPSIS +Use the Remove-CsOnlineSchedule cmdlet to remove a schedule. + +## SYNTAX +``` +Remove-CsOnlineSchedule -Id <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-CsOnlineSchedule cmdlet deletes a schedule that is specified by using the Id parameter. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" +``` + +This example deletes the schedule that has an Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. + +## PARAMETERS + +### -Id +The Id for the schedule to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Remove-CsOnlineSchedule cmdlet accepts a string as the Id parameter. + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) + +[Set-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule) diff --git a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md b/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md new file mode 100644 index 0000000000..4c26d98627 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md @@ -0,0 +1,137 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineTelephoneNumber + +## SYNOPSIS +Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove one or more unassigned telephone numbers from your tenant. + +## SYNTAX + +``` +Remove-CsOnlineTelephoneNumber -TelephoneNumber <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes one or more unassigned telephone numbers from your tenant. If at least one of the telephone numbers is assigned to a user or resource account, the cmdlet will fail and will not remove any of the specified telephone numbers. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsOnlineTelephoneNumber -TelephoneNumber 14258884567 +``` +```Output +NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk +---------------- --------------------- ------------------------- ----------------------------- +{14258884567} {} {} {} +``` + +This example removes the specified telephone number from the tenant. + +### -------------------------- Example 2 -------------------------- +``` +[string[]]$tns="+14255551234","+14255551233" +Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns +``` +```Output +NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk +---------------- --------------------- ------------------------- ----------------------------- +{14255551234, {} {} {} + 14255551233} +``` + +This example removes the specified list of telephone numbers from the tenant. + +## PARAMETERS + +### -TelephoneNumber +Specifies the telephone number(s) to remove. The format can be with or without the prefixed +, but needs to include country code etc. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +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 +``` + +### -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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +None + +## OUTPUTS + +### Output types +None + +## NOTES +If one or more of the telephone numbers are assigned to a user or a service, the cmdlet will display an error message and none of the telephone numbers specified will be removed from your tenant. + +## RELATED LINKS +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md new file mode 100644 index 0000000000..c2487ee802 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md @@ -0,0 +1,115 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineVoiceRoute + +## SYNOPSIS +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). + +## SYNTAX +``` +Remove-CsOnlineVoiceRoute [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to remove an existing online voice route. Online voice routes are associated with online voice policies through online PSTN usages, so removing an online voice route does not change any values relating to an online voice policy, it simply changes the routing for the numbers that had matched the pattern for the deleted online voice route. + +This cmdlet is used when configuring Microsoft Phone System Direct Routing. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Remove-CsOnlineVoiceRoute -Identity Route1 +``` + +Removes the settings for the online voice route with the identity Route1. + +### -------------------------- 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 -------------------------- +``` +PS C:\ Get-CsOnlineVoiceRoute -Filter *Redmond* | Remove-CsOnlineVoiceRoute +``` + +This command removes all online voice routes with an identity that includes the string "Redmond". First the `Get-CsOnlineVoiceRoute` cmdlet is called with the Filter parameter. The value of the Filter parameter is the string Redmond surrounded by wildcard characters (\*), which specifies that the string can be anywhere within the Identity. After all of the online voice routes with identities that include the string Redmond are retrieved, these online voice routes are piped to the `Remove-CsOnlineVoiceRoute` cmdlet, which removes each one. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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 identity of the online voice route. (If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: 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 + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) + +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) + +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md new file mode 100644 index 0000000000..a92e803b2c --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md @@ -0,0 +1,119 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineVoiceRoutingPolicy + +## SYNOPSIS +Deletes an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +## SYNTAX + +### Identity +``` +Remove-CsOnlineVoiceRoutingPolicy [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Teams users an online voice routing policy enables those users to receive and to place phone calls to the public switched telephone network by using your on-premises SIP trunks. + +Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Remove-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" +``` + +The command shown in Example 1 deletes the online voice routing policy RedmondOnlineVoiceRoutingPolicy. + +### -------------------------- 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 -------------------------- +``` +PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} | Remove-CsOnlineVoiceRoutingPolicy +``` + +In Example 3, all the online voice routing polices that include the online PSTN usage "Long Distance" are removed. To carry out this task, the `Get-CsOnlineVoiceRoutingPolicy` cmdlet is first called without any parameters in order to return a collection of all the available online voice routing policies. That 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". Policies that meet that criterion are then piped to the `Remove-CsOnlineVoiceRoutingPolicy`, which removes each online voice routing policy that includes the online PSTN usage "Long Distance". + +## PARAMETERS + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: ByPropertyName +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) + +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) + +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) + +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md new file mode 100644 index 0000000000..37611ecdb3 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md @@ -0,0 +1,102 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsOnlineVoicemailPolicy + +## SYNOPSIS +Deletes an existing Online Voicemail policy or resets the Global policy instance to the default values. + +## SYNTAX + +``` +Remove-CsOnlineVoicemailPolicy [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing Online Voicemail policy or resets the Global policy instance to the default values. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" +``` +The command shown in Example 1 deletes a per-user online voicemail policy CustomOnlineVoicemailPolicy. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You 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) + +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) + +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) + +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md new file mode 100644 index 0000000000..2bd32016e0 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md @@ -0,0 +1,135 @@ +--- +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 <String> -PhoneNumber <String> -PhoneNumberType <String> [<CommonParameters>] +``` + +### RemoveAll +```powershell +Remove-CsPhoneNumberAssignment -Identity <String> -RemoveAll [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md b/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md new file mode 100644 index 0000000000..38cda0282c --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumbertag +applicable: Microsoft Teams +title: Remove-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Remove-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows admin to remove a tag from phone number. + +## SYNTAX + +``` +Remove-CsPhoneNumberTag -Tag <String> [-PhoneNumber <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet allows telephone number administrators to remove existing tags from any telephone numbers. This method does not delete the tag from the system if the tag is assigned to other telephone numbers. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR" +``` + +This example shows how to remove the tag "HR" from telephone number +123456789. + +## PARAMETERS + +### -PhoneNumber +Indicates the phone number for the the tag to be removed from + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Indicates the tag to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..b50b153b93 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: Remove-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +Remove-CsSharedCallQueueHistoryTemplate -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +Use the Remove-CsSharedCallQueueHistoryTemplate cmdlet to delete a Shared Call Queue History template. If the template is currently assigned to a call queue, an error will be returned. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsSharedCallQueueHistoryTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example deletes the Shared Call Queue History template with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Shared Call Queue History template exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Id +The Id parameter is the unique identifier assigned to the Shared Call Queue History template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsSharedCallQueueHistoryTemplate](./New-CsSharedCallQueueHistoryTemplate.md) + +[Set-CsSharedCallQueueHistoryTemplate](./Set-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsSharedCallQueueHistoryTemplate](./Get-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Remove-CsTeamTemplate.md b/teams/teams-ps/teams/Remove-CsTeamTemplate.md new file mode 100644 index 0000000000..ee73ec6d3d --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamTemplate.md @@ -0,0 +1,273 @@ +--- +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 <String> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity + +```powershell +Remove-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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 \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter + +- `[Bssid <String>]`: +- `[ChassisId <String>]`: +- `[CivicAddressId <String>]`: Civic address id. +- `[Country <String>]`: +- `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. +- `[Id <String>]`: +- `[Identity <String>]`: +- `[Locale <String>]`: +- `[LocationId <String>]`: Location id. +- `[OdataId <String>]`: A composite URI of a template. +- `[OperationId <String>]`: The ID of a batch policy assignment operation. +- `[OrderId <String>]`: +- `[PackageName <String>]`: The name of a specific policy package +- `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. +- `[Port <String>]`: +- `[PortInOrderId <String>]`: +- `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. +- `[SubnetId <String>]`: +- `[TenantId <String>]`: +- `[UserId <String>]`: 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) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..01ddbc1bcc --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md @@ -0,0 +1,73 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Remove-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Remove-CsTeamsAIPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams AI policy. + +## SYNTAX + +``` +Remove-CsTeamsAIPolicy -Identity <String> [<CommonParameters>] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet deletes a Teams AI policy with the specified identity string. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsAIPolicy -Identity "Test" +``` + +Deletes a Teams AI policy with the identify of "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md new file mode 100644 index 0000000000..409570c300 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# Remove-CsTeamsAppPermissionPolicy + +## SYNOPSIS + +**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies> and about app centric management at <https://learn.microsoft.com/microsoftteams/app-centric-management>. + +This cmdlet allows you to remove app permission policies that have been created within your organization. If you run `Remove-CsTeamsAppPermissionPolicy` on the Global policy, it will be reset to the defaults provided for new organizations. + +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + +## SYNTAX + +``` +Remove-CsTeamsAppSetupPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies>. + +This cmdlet allows you to remove app permission policies that have been created within your organization. If you run Remove-CsTeamsAppPermissionPolicy on the Global policy, it will be reset to the defaults provided for new organizations. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsAppPermissionPolicy -Identity SalesPolicy +``` + +Deletes a custom policy that has already been created in the organization. + +## PARAMETERS + +### -Identity +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..fa290e6383 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md @@ -0,0 +1,147 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. + +## SYNTAX + +``` +Remove-CsTeamsAppSetupPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +**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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsAppSetupPolicy -Identity SalesPolicy +``` + +Deletes a custom policy that has already been created in the organization. + +## PARAMETERS + +### -Identity +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md new file mode 100644 index 0000000000..5866a31e39 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md @@ -0,0 +1,114 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy +title: Remove-CsTeamsAudioConferencingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsAudioConferencingPolicy + +## SYNOPSIS + +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. + +## SYNTAX + +``` +Remove-CsTeamsAudioConferencingPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a previously created TeamsAudioConferencingPolicy. Any users with no explicitly assigned policies will then fall back to the default (Global) policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Remove-CsTeamsAudioCOnferencingPolicy -Identity "Emea Users" +``` + +In the example shown above, the command will delete the "Emea Users" audio conferencing policy from the organization's list of policies. + +## PARAMETERS + +### -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. + +```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 for the TeamsAudioConferencingPolicy to be removed. To remove global policy, use this syntax: -Identity global. (Note that the global policy cannot be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: `-Identity "<policy name>"`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### String +## OUTPUTS + +### Object +## NOTES + +## RELATED LINKS + +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) + +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) + +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md new file mode 100644 index 0000000000..e735cc0dc3 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Remove-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Deletes an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +``` +Remove-CsTeamsCallHoldPolicy [-Identity] <string> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 1 deletes the Teams call hold policy ContosoPartnerTeamsCallHoldPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' | Remove-CsTeamsCallHoldPolicy +``` + +In Example 2, all the Teams call hold policies configured at the per-user scope are removed. +The Filter value "Tag:*" limits the returned data to Teams call hold policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams call hold policy to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md new file mode 100644 index 0000000000..8504928e7c --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md @@ -0,0 +1,138 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-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 Remove-CsTeamsCallParkPolicy cmdlet lets delete a custom policy that has been configured in your organization. + +## SYNTAX + +``` +Remove-CsTeamsCallParkPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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 Remove-CsTeamsCallParkPolicy cmdlet lets delete a custom policy that has been configured in your organization. + +If you run Remove-CsTeamsCallParkPolicy on the Global policy, it will be reset to the defaults provided for new organizations. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsCallParkPolicy -Identity SalesPolicy +``` + +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. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..f22acb63d5 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: +schema: 2.0.0 +--- + +# Remove-CsTeamsCallingPolicy + +## SYNOPSIS + +## SYNTAX + +``` +Remove-CsTeamsCallingPolicy [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + This cmdlet removes an existing Teams Calling Policy instance or resets the Global policy instance to the default values. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsCallingPolicy -Identity Sales +``` + +This example removes the Teams Calling Policy with identity Sales + +### Example 2 +```powershell +PS C:\> Remove-CsTeamsCallingPolicy -Identity Global +``` + +This example resets the Global Policy instance to the default values. + +## PARAMETERS + +### -Identity + The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md new file mode 100644 index 0000000000..1adb7d3231 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md @@ -0,0 +1,139 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsTeamsChannelsPolicy + +## SYNOPSIS + +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +## SYNTAX + +``` +Remove-CsTeamsChannelsPolicy [-Identity] <XdsIdentity> [-Confirm] [-Force] [-Tenant <Guid>] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. The Remove-CsTeamsChannelsPolicy cmdlet lets you delete a custom policy that has been configured in your organization. + +If you run Remove-CsTeamsChannelsPolicy on the Global policy, it will be reset to the defaults provided for new organizations. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsChannelsPolicy -Identity SalesPolicy +``` + +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 + +Required: True +Position: 2 +Default value: None +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: Microsoft Teams + +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: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md new file mode 100644 index 0000000000..05cb425285 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: Remove-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Remove-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Deletes an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +``` +Remove-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' +``` + +The command shown in Example 1 deletes an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication | Remove-CsTeamsComplianceRecordingApplication +``` + +The command shown in Example 2 deletes all existing associations between application instances of policy-based recording applications and their corresponding Teams compliance recording policy. + +## PARAMETERS + +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. + +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams compliance recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md new file mode 100644 index 0000000000..c121ab2692 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Remove-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Deletes an existing Teams recording policy that is used to govern automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +``` +Remove-CsTeamsComplianceRecordingPolicy [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' +``` + +The command shown in Example 1 deletes the Teams recording policy ContosoPartnerComplianceRecordingPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy -Filter 'Tag:*' | Remove-CsTeamsComplianceRecordingPolicy +``` + +In Example 2, all the Teams recording policies configured at the per-user scope are removed. +The Filter value "Tag:*" limits the returned data to Teams recording policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md new file mode 100644 index 0000000000..bac8a3df1d --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Remove-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +``` +Remove-CsTeamsCortanaPolicy [-Tenant <System.Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a previously created TeamsCortanaPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsCortanaPolicy -Identity MyCortanaPolicy +``` + +In the example shown above, the command will delete the MyCortanaPolicy from the organization's list of policies. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity for the policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity MyCortanaPolicy. +If you do not specify an Identity the Set-CsTeamsCortanaPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +You can return your tenant ID by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText new file mode 100644 index 0000000000..9e9dcd1434 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText @@ -0,0 +1,71 @@ +--- +Module Name: MicrosoftTeams +title: Remove-CsTeamsCustomBannerText +author: saleens7 +ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText +schema: 2.0.0 +--- + +# Remove-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Remove-CsTeamsCustomBannerText [[-Identity] <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +Removes a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText +``` + +Removes a TeamsCustomBannerText instance with the name "CustomText". + +## PARAMETERS + +### -Identity +Policy instance name (optional). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..8619d8cca2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md @@ -0,0 +1,71 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText +title: Remove-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# Remove-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Remove-CsTeamsCustomBannerText [[-Identity] <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +Removes a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText +``` + +This example removes a TeamsCustomBannerText instance with the name "CustomText". + +## PARAMETERS + +### -Identity +Policy instance name (optional). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md new file mode 100644 index 0000000000..09e839d382 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md @@ -0,0 +1,108 @@ +--- +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 +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Remove-CsTeamsEmergencyCallRoutingPolicy + +## SYNOPSIS +This cmdlet removes an existing Teams Emergency Call Routing policy instance. + +## SYNTAX + +``` +Remove-CsTeamsEmergencyCallRoutingPolicy [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes an existing Teams Emergency Call Routing policy instance. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsEmergencyCallRoutingPolicy -Identity Test +``` + +This example removes Teams Emergency Call Routing policy with identity Test. + +### Example 2 +```powershell +Remove-CsTeamsEmergencyCallRoutingPolicy -Identity Global +``` + +This example resets the Teams Emergency Call Routing Global policy instance to its default values. + +## PARAMETERS + +### -Identity +The Identity parameter is the unique identifier of the Teams Emergency Call Routing policy to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) + +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) + +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..0f35301904 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,111 @@ +--- +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 +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Remove-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS + +## SYNTAX + +``` +Remove-CsTeamsEmergencyCallingPolicy [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes an existing Teams Emergency Calling policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsEmergencyCallingPolicy -Identity testECP +``` + +This example removes an existing Teams Emergency Calling policy with identity testECP. + +### Example 2 +```powershell +Remove-CsTeamsEmergencyCallingPolicy -Identity Global +``` + +This example resets the Global Policy instance to the default values. + +## PARAMETERS + +### -Identity + The Identity parameter is the unique identifier of the Teams Emergency Calling policy to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) + +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md new file mode 100644 index 0000000000..2e310c4d61 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md @@ -0,0 +1,128 @@ +--- +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] <Object>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..adc94c0242 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md @@ -0,0 +1,94 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy +title: Remove-CsTeamsEventsPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsEventsPolicy + +## SYNOPSIS +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Remove-CsTeamsEventsPolicy [-Identity] <String> [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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/teams/Remove-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..c001e0e880 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md @@ -0,0 +1,133 @@ +--- +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 +ms.author: tomkau +ms.reviewer: +--- + +# Remove-CsTeamsFeedbackPolicy + +## SYNOPSIS + +Use this cmdlet to remove a Teams Feedback policy from the Tenant. + +## SYNTAX + +``` +Remove-CsTeamsFeedbackPolicy [[-Identity] <String>] + [-Confirm] + [-Force] + [-Tenant <Object>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Removes a Teams Feedback policy from the Tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsFeedbackPolicy -Identity "New Hire Feedback Policy" +``` + +In this example, the policy "New Hire Feedback Policy" is being removed. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..8b2f609c8e --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy +title: Remove-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsFilesPolicy + +## SYNOPSIS +Deletes an existing teams files policy or resets the Global policy instance to the default values. + +## SYNTAX + +``` +Remove-CsTeamsFilesPolicy [-Identity] <String> [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing teams files or resets the Global policy instance to the default values. + +## EXAMPLES + +### Example 1 +``` +Remove-CsTeamsFilesPolicy -Identity "Customteamsfilespolicy" +``` + +The command shown in Example 1 deletes a per-user teams files policy Customteamsfilespolicy. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You are not able to delete the pre-configured policy instances Default, TranscriptionProfanityMaskingEnabled and TranscriptionDisabled + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) + diff --git a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md new file mode 100644 index 0000000000..f31fdeafd5 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsipphonepolicy +applicable: Microsoft Teams +title: Remove-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Remove-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams phone experiences. + +## SYNTAX + +``` +Remove-CsTeamsIPPhonePolicy [[-Identity] <XdsIdentity>] + [-Confirm] + [-Force] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams IP Phones experiences. + +Note: Ensure the policy is not assigned to any users or the policy deletion will fail. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsIPPhonePolicy -Identity CommonAreaPhone +``` +This example shows the deletion of the policy CommonAreaPhone. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the TeamsIPPhonePolicy that you would like to remove. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..a2b3b79a34 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,69 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Remove-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Remove-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams media connectivity policy. + +## SYNTAX + +``` +Remove-CsTeamsMediaConnectivityPolicy -Identity <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet deletes a Teams media connectivity policy with the specified identity string. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMediaConnectivityPolicy -Identity "Test" +``` + +Deletes a Teams media connectivity policy with the identify of "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams media connectivity policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..ac3f34c82e --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# Remove-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +``` +Remove-CsTeamsMeetingBrandingPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a previously created TeamsMeetingBrandingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should first assign a different policy to them. + +## EXAMPLES + +### Remove meeting branding policy +```powershell +PS C:\> Remove-CsTeamsMeetingBrandingPolicy -Identity "policy test" +``` + +In this example, the command deletes the `policy test` meeting branding policy from the organization's list of meeting branding policies and removes all assignments of this policy from users who have the policy assigned. + +## PARAMETERS + +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md index 6d23a8d0d6..3b8ee0ebd4 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md @@ -1,11 +1,15 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: Remove-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- - # Remove-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS @@ -19,11 +23,10 @@ Remove-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> ``` ## 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. Use this cmdlet to delete an existing policy. ## EXAMPLES - ## PARAMETERS ### -Confirm @@ -57,7 +60,7 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier for the policy to be removed. Policies can be configured at the global or per-user scopes. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) +Unique identifier for the policy to be removed. Policies can be configured at the global or per-user scopes. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a per-user policy, use syntax similar to this: -Identity SalesPolicy. @@ -107,8 +110,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -116,6 +118,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md new file mode 100644 index 0000000000..afc4b6bca6 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsMeetingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsTeamsMeetingPolicy + +## SYNOPSIS +The `CsTeamsMeetingPolicy` cmdlets removes a previously created TeamsMeetingPolicy. + +## SYNTAX + +``` +Remove-CsTeamsMeetingPolicy [-Tenant <Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a previously created TeamsMeetingPolicy. 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 StudentMeetingPolicy +``` + +In the example shown above, the command will delete the student meeting 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 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 StudentMeetingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..b813ff072b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy [-Identity] <string> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 - Deleting a meeting template permission policy + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy +``` + +Deletes a policy instance with the Identity *Test_Policy*. + +### Example 2 - Deleting a policy when its assigned to a user + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsMeetingTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users. Assign a different policy to the users before removing +this one. Please refer to documentation. CorrelationId: 8698472b-f441-423b-8ee3-0469c7e07528 +At line:1 char:1 ++ Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsM...ermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsMeetingTemplatePermissionPolicyCmdlet +``` + +## PARAMETERS + +### -Identity + +Identity of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md similarity index 79% rename from skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md index 8c87ead9fd..1529b4300f 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md @@ -1,14 +1,19 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy +applicable: Microsoft Teams title: Remove-CsTeamsMessagingPolicy schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Remove-CsTeamsMessagingPolicy ## SYNOPSIS -Deletes a custom messaging policy. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. +Deletes a custom messaging policy. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. ## SYNTAX @@ -105,11 +110,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### Microsoft.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object @@ -117,4 +124,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md new file mode 100644 index 0000000000..8cce132f98 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Remove-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Remove-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +``` +Remove-CsTeamsMobilityPolicy [-Tenant <System.Guid>] [-Identity] <XdsIdentity> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The Remove-CsTeamsMobilityPolicy cmdlet lets an Admin delete a custom teams mobility policy that has been created. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMobilityPolicy -Identity SalesPolicy +``` + +Deletes a custom policy that has already been created in the organization. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the client policy to be removed. To "remove" the global policy, use the following syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: -Identity "SalesDepartmentPolicy". You cannot use wildcards when specifying a policy Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md new file mode 100644 index 0000000000..5192c02bc6 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md @@ -0,0 +1,86 @@ +--- +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: +manager: mreddy +schema: 2.0.0 +--- + +# Remove-CsTeamsNetworkRoamingPolicy + +## SYNOPSIS + +Remove-CsTeamsNetworkRoamingPolicy allows IT Admins to delete policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +## SYNTAX + +``` +Remove-CsTeamsNetworkRoamingPolicy [[-Identity] <XdsIdentity>] [-Tenant <System.Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the Teams Network Roaming Policies configured for use in your organization. + +The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. + +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +PS C:\> Remove-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy +``` + +In Example 1, Remove-CsTeamsNetworkRoamingPolicy is used to delete the network roaming policy that has an Identity OfficePolicy. + +## PARAMETERS + +### -Identity +Unique identifier of the policy to be removed. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md new file mode 100644 index 0000000000..172211f455 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md @@ -0,0 +1,109 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy +title: Remove-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Deletes an existing Teams Notification and Feeds Policy + +## SYNTAX + +```powershell +Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] <String> [-MsftInternalProcessingMode <String>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## 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/teams/Remove-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md new file mode 100644 index 0000000000..669b830d56 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md @@ -0,0 +1,60 @@ +--- +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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +``` +Remove-CsTeamsPinnedApp [[-Identity] <Object>] + [-Confirm] + [-Force] + [-Tenant <Object>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/MicrosoftTeams/teams-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-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..6a51b6ae29 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Remove-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Remove-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +Remove-CsTeamsRecordingRollOutPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Removes a previously created CsTeamsRecordingRollOutPolicy. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy +``` + +In the example shown above, the command will delete the OrganizerPolicy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the CsTeamsRecordingRollOutPolicy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity SomePolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..e1a8839e41 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,107 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy +title: Remove-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] <String> [-MsftInternalProcessingMode <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..536843d50b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,126 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Remove-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Deletes an existing Teams shared calling routing policy instance. + +## SYNTAX + +``` +Remove-CsTeamsSharedCallingRoutingPolicy [-Identity] <string> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsSharedCallingRoutingPolicy is used to configure shared calling. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-CsTeamsSharedCallingRoutingPolicy -Identity "Seattle" +``` +The command shown in Example 1 deletes the Teams shared calling routing policy instance Seattle. + +### EXAMPLE 2 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Filter "tag:*" | Remove-CsTeamsSharedCallingRoutingPolicy +``` +In Example 2, all Teams shared calling routing policies configured at the per-user scope are removed. To do this, the command first +calls the Get-CsTeamsSharedCallingRoutingPolicy cmdlet along with the Filter parameter; the filter value "tag:*" limits the +returned data to Teams shared calling routing policies configured at the per-user scope. Those per-user policies are then piped to +and removed by the Remove-CsTeamsSharedCallingRoutingPolicy cmdlet. + +## PARAMETERS + +### -Identity +Unique identifier assigned to the policy when it is created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..a86968dfd2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: stepfitz +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Remove-CsTeamsShiftsConnection + +## SYNOPSIS + +This cmdlet deletes a Shifts connection. + +## SYNTAX + +``` +Remove-CsTeamsShiftsConnection -ConnectionId <String> -InputObject <IConfigApiBasedCmdletsIdentity> [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet deletes a connection. All available connections can be found by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsConnection -ConnectionId 43cd0e23-b62d-44e8-9321-61cb5fcfae85 +``` + +Deletes the connection with ID `43cd0e23-b62d-44e8-9321-61cb5fcfae85`. + +## PARAMETERS + +### -ConnectionId + +The ID of the connection that you want to delete. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md new file mode 100644 index 0000000000..843cf262ce --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md @@ -0,0 +1,70 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsShiftsConnectionInstance +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance +schema: 2.0.0 +--- + +# Remove-CsTeamsShiftsConnectionInstance + +## SYNOPSIS + +This cmdlet deletes a Shifts connection instance. + +## SYNTAX + +``` +Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <String> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet deletes a connection instance. All available instances can be found by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b +``` + +Deletes the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + +## PARAMETERS + +### -ConnectorInstanceId + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md new file mode 100644 index 0000000000..48935f7bec --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsShiftsConnectionTeamMap +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap +schema: 2.0.0 +--- + +# Remove-CsTeamsShiftsConnectionTeamMap + +## SYNOPSIS + +This cmdlet removes the mapping between the Microsoft Teams team and workforce management (WFM) team. + +## SYNTAX + +```powershell +Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId <String> -TeamId <string> -InputObject <IConfigApiBasedCmdletsIdentity> [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet removes the mapping between the Microsoft Teams team and WFM team. All team mappings can be found by running [Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId "30b625bd-f0f7-4d5c-8793-9ccef5a63119" +``` + +Unmaps the Teams team with ID "30b625bd-f0f7-4d5c-8793-9ccef5a63119" in the instance with ID "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b". + +## PARAMETERS + +### -ConnectorInstanceId + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamId + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap) + +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md new file mode 100644 index 0000000000..f7201e43a2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md @@ -0,0 +1,70 @@ +--- +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] <XdsIdentity> [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md new file mode 100644 index 0000000000..5c64fec405 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md @@ -0,0 +1,315 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsShiftsScheduleRecord +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord +schema: 2.0.0 +--- + +# Remove-CsTeamsShiftsScheduleRecord + +## SYNOPSIS + +This cmdlet enqueues the clear schedule message. + +## SYNTAX + +### RemoveExpanded (Default) +```powershell +Remove-CsTeamsShiftsScheduleRecord [-ClearSchedulingGroup] -EntityType <String[]> -TeamId <String> + [-DateRangeEndDate <DateTime>] [-DateRangeStartDate <DateTime>] [-DesignatedActorId <String>] + [-TimeZone <String>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] + [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### Remove +```powershell +Remove-CsTeamsShiftsScheduleRecord -Body <IClearScheduleRequest> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet sends a request of removing Shifts schedule with specified time range. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsScheduleRecord -TeamId "eddc3b94-21d5-4ef0-a76a-2e4d632e50be" -DateRangeStartDate "2021-09-30T00:00:00" -DateRangeEndDate "2021-10-01T00:00:00" -ClearSchedulingGroup:$false -EntityType "swapRequest", "openShiftRequest" -DesignatedActorId "683af6f2-4f72-4770-b8e1-4ec31836156ad" +``` + +Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios in the team with ID `eddc3b94-21d5-4ef0-a76a-2e4d632e50be` from 09/30/2021 to 10/01/2021. + +## PARAMETERS + +### -ClearSchedulingGroup +A value indicating whether to clear schedule group. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateRangeEndDate +The end date of removing schedule record. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateRangeStartDate +The start date of removing schedule record. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedActorId +The user ID of designated actor. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The entity types. + +```yaml +Type: String[] +Parameter Sets: RemoveExpanded +Aliases: +Applicable: Microsoft Teams +Required: True +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. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The request body. + +```yaml +Type: IClearScheduleRequest +Parameter Sets: Remove +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Used to return an object that represents the item being modified. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +The Timezone parameter ensures that the shifts are displayed in the correct time zone based on your team's location. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +The parameters of start time, end time and designated actor ID are optional only when removing the schedule record of a linked team. + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..ec60890b7b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,103 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance +title: Remove-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Remove-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Remove-CsTeamsSurvivableBranchAppliance [-Identity] <String> [-MsftInternalProcessingMode <String>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The Identity parameter is the unique identifier for the SBA. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..6aa49338fb --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,103 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy +title: Remove-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] <String> [-MsftInternalProcessingMode <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..669d6bc872 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md @@ -0,0 +1,120 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy +title: Remove-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsTargetingPolicy [-Identity] <String> [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy +``` + +In the example shown above, the command will delete the student tag policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the teams meeting policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity StudentTagPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..28ecb18cd4 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy +title: Remove-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# Remove-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsTemplatePermissionPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +Deletes a policy instance with the Identity *Foobar*. + +### Example 2 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f +At line:1 char:1 ++ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet +``` + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..a1cc4fdcae --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule +applicable: Microsoft Teams +title: Remove-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to remove an existing number manipulation rule (or list of rules). + +## SYNTAX + +``` +Remove-CsTeamsTranslationRule [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to remove an existing number manipulation rule (or list of rules). The rule can be used, for example, in the settings of your SBC (Set-CsOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsTranslationRule -Identity AddPlus1 +``` + +This example removes the "AddPlus1" translation rule. As the rule can be used in some places, integrity check is preformed to ensure that the rule is not in use. If the rule is in use an error thrown with specifying which SBC use this rule. + +### Example 2 +```powershell +Get-CsTeamsTranslationRule -Filter 'tst*' | Remove-CsTeamsTranslationRule +``` + +This example removes all translation rules with Identifier starting with tst. + +## PARAMETERS + +### -Identity +Identifier of the rule. This parameter is required. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md new file mode 100644 index 0000000000..118a64f812 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md @@ -0,0 +1,74 @@ +--- +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] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..e558236294 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Remove-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to remove a Teams Update Management policy from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsUpdateManagementPolicy [-Identity] <String> [-Force] [-ProgressAction <ActionPreference>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a Teams Update Management policy from the tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" +``` + +In this example, the policy "Campaign Policy" is being removed. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..66afd2e7e6 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy +title: Remove-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsVdiPolicy + +## SYNOPSIS +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsVdiPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a previously created TeamsVdiPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy +``` + +In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams Vdi policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity RestrictedUserPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..a1a3852ec4 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy +title: Remove-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +author: emmanuelrocha001 +manager: sonaggarwal +--- + +# Remove-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to delete an instance of TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +``` +Remove-CsTeamsVirtualAppointmentsPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an instance of TeamsVirtualAppointmentsPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\>Remove-CsTeamsVirtualAppointmentsPolicy -Identity Foobar +``` + +Deletes a given policy instance with the Identity Foobar. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md new file mode 100644 index 0000000000..8458e8f402 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md @@ -0,0 +1,106 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy +title: Remove-CsTeamsVoiceApplicationsPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsVoiceApplicationsPolicy + +## SYNOPSIS +Deletes an existing Teams voice applications policy. + +## SYNTAX + +``` +Remove-CsTeamsVoiceApplicationsPolicy [-Identity] <String> [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-CsTeamsVoiceApplicationsPolicy -Identity "SDA-Allow-All" +``` +The command shown in Example 1 deletes the Teams voice applications policy SDA-Allow-All. + +### EXAMPLE 2 +``` +Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" | Remove-CsTeamsVoiceApplicationsPolicy +``` +In Example 2, all Teams voice applications policies configured at the per-user scope are removed. To do this, the command first calls the Get-CsTeamsVoiceApplicationsPolicy cmdlet along with the Filter parameter; the filter value "tag:*" limits the returned data to Teams voice applications policies configured at the per-user scope. Those per-user policies are then piped to and removed by the Remove-CsTeamsVoiceApplicationsPolicy cmdlet. + +## 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: 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 + +### System.String +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) + +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) + +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) + +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..c32aafbb08 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,125 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy +title: Remove-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams Workload Policy instance. + +## SYNTAX + +```powershell +Remove-CsTeamsWorkLoadPolicy [-Identity] <String> [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" +``` + +Deletes a Teams Workload policy instance with the identity of "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal Use Only + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..fd2938fd43 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy +title: Remove-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# Remove-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to delete an instance of TeamsWorkLocationDetectionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsWorkLocationDetectionPolicy [-Identity] <String> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an instance of TeamsWorkLocationDetectionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +## EXAMPLES + +### Example 1 +```powershell +PS C:\>Remove-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy +``` + +Deletes a given policy instance with the Identity wld-policy. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md b/teams/teams-ps/teams/Remove-CsTenantDialPlan.md new file mode 100644 index 0000000000..41c2e91c20 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTenantDialPlan.md @@ -0,0 +1,111 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTenantDialPlan + +## SYNOPSIS +Use the `Remove-CsTenantDialPlan` cmdlet to remove a tenant dial plan. + +## SYNTAX + +``` +Remove-CsTenantDialPlan [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Remove-CsTenantDialPlan` cmdlet removes an existing tenant dial plan (also known as a location profile). +Tenant dial plans provide required information to allow Enterprise Voice users to make telephone calls. +The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. +A tenant dial plan determines such things as which normalization rules are applied. + +Removing a tenant dial plan also removes any associated normalization rules. +If no tenant dial plan is assigned to an organization, the Global dial plan is used. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 +``` + +This example removes the Vt1TenantDialPlan2. + +## PARAMETERS + +### -Identity +The Identity parameter is the unique identifier of the tenant dial plan to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm parameter prompts you for confirmation before the command is executed. + +```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 +``` + +### -WhatIf +The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. + +## RELATED LINKS + +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md new file mode 100644 index 0000000000..5e4b94b289 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md @@ -0,0 +1,101 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTenantNetworkRegion + +## SYNOPSIS +Use the `Remove-CsTenantNetworkRegion` cmdlet to remove a tenant network region. + +## SYNTAX +``` +Remove-CsTenantNetworkRegion [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Remove-CsTenantNetworkRegion` cmdlet removes an existing tenant network region. + +A network region contains a collection of network sites. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTenantNetworkRegion -Identity "RedmondRegion" +``` + +The command shown in Example 1 removes 'RedmondRegion'. + +## PARAMETERS + +### -Identity +Unique identifier for the network region to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) + +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) + +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md b/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md new file mode 100644 index 0000000000..a21acb85be --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md @@ -0,0 +1,102 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTenantNetworkSite + +## SYNOPSIS +Use the `Remove-CsTenantNetworkSite` cmdlet to remove a tenant network site. + +## SYNTAX + +``` +Remove-CsTenantNetworkSite [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Remove-CsTenantNetworkSite` cmdlet removes an existing tenant 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. Network sites are defined as a collection of IP subnets. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTenantNetworkSite -Identity "site1" +``` + +The command shown in Example 1 removes 'site1'. + +## PARAMETERS + +### -Identity +Unique identifier for the network site to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) + +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) + +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md new file mode 100644 index 0000000000..2e8c9def13 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md @@ -0,0 +1,100 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTenantNetworkSubnet + +## SYNOPSIS +Use the `Remove-CsTenantNetworkSubnet` cmdlet to remove a tenant network subnet. + +## SYNTAX + +``` +Remove-CsTenantNetworkSubnet [-Identity] <string> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Remove-CsTenantNetworkSubnet` cmdlet removes an existing tenant network subnet. + +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTenantNetworkSubnet -Identity "192.168.0.1" +``` + +The command shown in Example 1 removes '192.168.0.1'. + +## PARAMETERS + +### -Identity +Unique identifier for the network subnet to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) + +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) + +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md new file mode 100644 index 0000000000..36eb4e2803 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md @@ -0,0 +1,136 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsTenantTrustedIPAddress + +## SYNOPSIS +Use the `Remove-CsTenantTrustedIPAddress` cmdlet to remove a tenant trusted IP address. + +## SYNTAX + +``` +Remove-CsTenantTrustedIPAddress [-Tenant <System.Guid>] [-Identity] <XdsGlobalRelativeIdentity> [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Remove-CsTenantTrustedIPAddress` cmdlet removes an existing tenant trusted IP address. + +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. + +## EXAMPLES + +###-------------------------- Example 1 -------------------------- +```powershell +PS C:\> Remove-CsTenantTrustedIPAddress -Identity "192.168.0.1" +``` + +The command shown in Example 1 removes '192.168.0.1'. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the trusted IP address to be removed. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose trusted IP address are being removed. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md b/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md new file mode 100644 index 0000000000..56d6d9bce2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md @@ -0,0 +1,91 @@ +--- +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 <String> -Delegate <String> [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md b/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md new file mode 100644 index 0000000000..8ba1f83cc3 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserlicensegraceperiod +title: Remove-CsUserLicenseGracePeriod +description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. +schema: 2.0.0 +ms.date: 02/01/2024 +author: serdarsoysal +ms.author: serdars +--- + +# Remove-CsUserLicenseGracePeriod + +## SYNOPSIS + +The `CsUserLicenseGracePeriod` cmdlet expedites the delicensing operation for the assigned plan(s) of a user/resource account by removing the grace period, permanently deleting the assigned plan(s). +Note that this cmdlet is to be used only by tenants with license resiliency enabled. (License resiliency is currently under private preview and not available for everyone.) + +## SYNTAX + +```powershell +Remove-CsUserLicenseGracePeriod +[-Identity] <String> +[-Capability <String>] +-InputObject <IConfigApiBasedCmdletsIdentity> +[-Action <String>] +-Body <IUserDelicensingAccelerationPatch> +[-PassThru] +[-Force] +[-WhatIf] +[-Confirm] +[<CommonParameters>] +``` + +## DESCRIPTION + +The command removes the grace period of the assigned plan(s) against the specified user(s)/resource account(s), permanently deleting the plan(s). +Permanently deletes all/specified plans belonging to the user, which has a grace period assosciated with it. +Assigned plans with no subsequent grace period will see no change. + +If you want to verify the grace period of any assigned plan against a user, you can return that information by using this command: + +`Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354` + +## EXAMPLES + +### Example 1 + +```powershell +Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 +``` + +In Example 1, the command removes the grace period of all assigned plan(s) against the specified user ID, marking the subsequent assigned plan(s) as deleted. Assigned plans with no subsequent grace period will see no change. + +### Example 2 + +```powershell +Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -Capability 'MCOEV,MCOMEETADD' +``` + +In Example 2, the capability specified refers to plans assigned to the user(s) under AssignedPlans. The command removes the grace period of the specified assigned plans, marking the subsequent plan(s) as deleted. + +## PARAMETERS + +### -Identity + +Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName,ByValue) +Accept wildcard characters: False +``` + +### -Capability + +Denotes the plan(s) assigned to the specified user, which are to be permanently deleted if they are currently serving their grace period. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName,ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Returns the results of the command. By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Action + +Used to specify which action should be taken. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +Specifies the body of the request. + +```yaml +Type: IUserDelicensingAccelerationPatch +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md new file mode 100644 index 0000000000..9344dcff1d --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md @@ -0,0 +1,67 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +``` +Remove-CsVideoInteropServiceProvider [[-Identity] <Object>] + [-Confirm] + [-Force] + [-Tenant <Object>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +## PARAMETERS + +### -Identity +Specify the VideoInteropServiceProvider to be removed. + +```yaml +Type: XdsGlobalRelativeIdentity +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 + +### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-SharedWithTeam.md b/teams/teams-ps/teams/Remove-SharedWithTeam.md new file mode 100644 index 0000000000..e143bc6c3c --- /dev/null +++ b/teams/teams-ps/teams/Remove-SharedWithTeam.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam +title: Remove-SharedWithTeam +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Remove-SharedWithTeam + +## SYNOPSIS +This cmdlet supports unsharing a channel with a team. + +## SYNTAX +```PowerShell +Remove-SharedWithTeam -HostTeamId <String> -ChannelId <String> -SharedWithTeamId <String> [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet supports unsharing a channel with a team. + +## EXAMPLES + +### Example 1 +```PowerShell +Remove-SharedWithTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b +``` + +Unshares a channel with a team. + +## PARAMETERS + +### -HostTeamId +Team ID of the host team (Group ID). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChannelId +Thread ID of the shared channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedWithTeamId +Team ID of the shared with team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### HostTeamId, ChannelId, SharedWithTeamId + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) diff --git a/teams/teams-ps/teams/Remove-Team.md b/teams/teams-ps/teams/Remove-Team.md index fcc2ba0495..b379c99308 100644 --- a/teams/teams-ps/teams/Remove-Team.md +++ b/teams/teams-ps/teams/Remove-Team.md @@ -1,32 +1,37 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/remove-team title: Remove-Team -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-Team ## SYNOPSIS -Note: This cmdlet is currently in Beta. -Deletes a team. +This cmdlet deletes a specified Team from Microsoft Teams. + +NOTE: The associated Office 365 Unified Group will also be removed. ## SYNTAX ``` -Remove-Team -GroupId <String> +Remove-Team -GroupId <String> [<CommonParameters>] ``` ## DESCRIPTION +Removes a specified team via GroupID and all its associated components, like O365 Unified Group... + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -Remove-Team -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df +Remove-Team -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df ``` ## PARAMETERS @@ -38,7 +43,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -47,6 +51,9 @@ 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 ## OUTPUTS @@ -55,3 +62,4 @@ Accept wildcard characters: False ## RELATED LINKS +[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) diff --git a/teams/teams-ps/teams/Remove-TeamChannel.md b/teams/teams-ps/teams/Remove-TeamChannel.md index a9e6840709..9ab0da2703 100644 --- a/teams/teams-ps/teams/Remove-TeamChannel.md +++ b/teams/teams-ps/teams/Remove-TeamChannel.md @@ -1,34 +1,38 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchannel title: Remove-TeamChannel -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-TeamChannel ## SYNOPSIS -Note: This cmdlet is currently in Beta. Delete a channel. This will not delete content in associated tabs. -Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. +Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. ## SYNTAX ``` -Remove-TeamChannel -GroupId <String> -DisplayName <String> +Remove-TeamChannel -GroupId <String> -DisplayName <String> [<CommonParameters>] ``` ## DESCRIPTION +> [!IMPORTANT] +> Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here `https://www.poshtestgallery.com/packages/MicrosoftTeams`. + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-TeamChannel -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Tech Reads" ``` @@ -42,7 +46,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -58,7 +61,6 @@ Channel name to be deleted Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -67,6 +69,9 @@ 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 ## OUTPUTS @@ -74,4 +79,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-TeamChannelUser.md b/teams/teams-ps/teams/Remove-TeamChannelUser.md new file mode 100644 index 0000000000..5593e0c440 --- /dev/null +++ b/teams/teams-ps/teams/Remove-TeamChannelUser.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser +title: Remove-TeamChannelUser +schema: 2.0.0 +--- + +# Remove-TeamChannelUser + +## SYNOPSIS +> [!Note] +> The command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. + +To turn an existing Owner into a Member, specify role parameter as Owner. + +> [!Note] +> Last owner cannot be removed from the private channel. + +## SYNTAX + +``` +Remove-TeamChannelUser -GroupId <String> -DisplayName <String> -User <String> [-Role <String>] + [<CommonParameters>] +``` + +## 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). + +## EXAMPLES + +### Example 1 +``` +Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com +``` + +## PARAMETERS + +### -GroupId +GroupId of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Display name of the private channel + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -User +User's email address (e.g. +johndoe@example.com) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md b/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md new file mode 100644 index 0000000000..01e2e675e0 --- /dev/null +++ b/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md @@ -0,0 +1,64 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams +title: Remove-TeamTargetingHierarchy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- +# Remove-TeamTargetingHierarchy + +## SYNOPSIS + +Removes the tenant's hierarchy. + +## SYNTAX + +### Remove (Default) +``` +Remove-TeamTargetingHierarchy [-ApiVersion <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Removes the tenant's hierarchy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-TeamTargetingHierarchy +``` + +## PARAMETERS + +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: false +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Remove-TeamUser.md b/teams/teams-ps/teams/Remove-TeamUser.md index 460d3c944e..1bc56b8ac7 100644 --- a/teams/teams-ps/teams/Remove-TeamUser.md +++ b/teams/teams-ps/teams/Remove-TeamUser.md @@ -1,39 +1,46 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamuser title: Remove-TeamUser -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Remove-TeamUser ## SYNOPSIS -Note: This cmdlet is currently in Beta. -Remove an owner or member from a team, -and from the unified group which backs the team. +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: 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 ``` -Remove-TeamUser -GroupId <String> -User <String> -Role <String> +Remove-TeamUser -GroupId <String> -User <String> [-Role <String>] [<CommonParameters>] ``` ## DESCRIPTION ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 +``` +Remove-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com -Role Owner +``` +In this example, the user "dmx" is removed the role Owner but stays as a team member. + +### Example 2 ``` Remove-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com ``` +In this example, the user "dmx" is removed from the team. ## PARAMETERS @@ -44,7 +51,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -61,7 +67,6 @@ johndoe@example.com) Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -71,21 +76,25 @@ Accept wildcard characters: False ``` ### -Role -Use this to demote a user from owner to member of the team +If cmdlet is called with -Role parameter as "Owner", the specified user is removed as an owner of the team but stays as a team member. + +Note: The last owner cannot be removed from the team. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +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 ## OUTPUTS @@ -93,4 +102,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-TeamsApp.md b/teams/teams-ps/teams/Remove-TeamsApp.md new file mode 100644 index 0000000000..a7462e20f9 --- /dev/null +++ b/teams/teams-ps/teams/Remove-TeamsApp.md @@ -0,0 +1,60 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsapp +title: Remove-TeamsApp +schema: 2.0.0 +--- + +# Remove-TeamsApp + +## SYNOPSIS +Removes an app in the Teams tenant app store. + +## SYNTAX + +``` +Remove-TeamsApp -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +Removes an app in the Teams tenant app store. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 +``` + +## PARAMETERS + +### -Id +The app's ID generated by Teams (different from the external ID) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md new file mode 100644 index 0000000000..36234579ef --- /dev/null +++ b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md @@ -0,0 +1,120 @@ +--- +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 <String>] [-AppId <String>] -TeamId <String> + [<CommonParameters>] +``` + +### UserScope +``` +Remove-TeamsAppInstallation [-AppInstallationId <String>] [-AppId <String>] -UserId <String> + [<CommonParameters>] +``` + +## 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-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Set-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..5fe3b54419 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsApplicationAccessPolicy.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csapplicationaccesspolicy +applicable: Microsoft Teams +title: Set-CsApplicationAccessPolicy +schema: 2.0.0 +manager: zhengni +author: frankpeng7 +ms.author: frpeng +ms.reviewer: +--- + +# Set-CsApplicationAccessPolicy + +## SYNOPSIS + +Modifies an existing application access policy. + +## SYNTAX + +```powershell +Set-CsApplicationAccessPolicy [-AppIds <Object>] [-Description <String>] [[-Identity] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet modifies an existing application access policy. + +## EXAMPLES + +### Add new app ID to the policy + +```powershell +PS C:\> Set-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds @{Add="5817674c-81d9-4adb-bfb2-8f6a442e4622"} +``` + +The command shown above adds a new app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" to the per-user application access policy ASimplePolicy. + +### Remove app IDs from the policy + +```powershell +PS C:\> Set-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds @{Remove="5817674c-81d9-4adb-bfb2-8f6a442e4622"} +``` + +The command shown above removes the app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" from the per-user application access policy ASimplePolicy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppIds + +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free format text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md b/teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md new file mode 100644 index 0000000000..c6c427fe87 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-CsApplicationMeetingConfiguration +applicable: Teams +title: Set-CsApplicationMeetingConfiguration +schema: 2.0.0 +manager: zhengni +author: jackry6350 +ms.author: yoren +ms.reviewer: +--- + +# Set-CsApplicationMeetingConfiguration + +## SYNOPSIS + +Modifies an existing application meeting configuration for the tenant. + +## SYNTAX + +### Identity + +``` +Set-CsApplicationMeetingConfiguration [-Identity <XdsIdentity>] [-AllowRemoveParticipantAppIds <PSListModifier>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsApplicationMeetingConfiguration [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet modifies an existing application meeting configuration for the tenant. + +## EXAMPLES + +### Add new app ID to the configuration to allow remove participant for the tenant + +``` +PS C:\> Set-CsApplicationMeetingConfiguration -AllowRemoveParticipantAppIds @{Add="5817674c-81d9-4adb-bfb2-8f6a442e4622"} +``` + +The command shown above adds a new app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" to the application meeting configuration settings for the tenant to allow it to remove participant. + +### Remove app IDs from the configuration to allow remove participant for the tenant + +``` +PS C:\> Set-CsApplicationMeetingConfiguration -AllowRemoveParticipantAppIds @{Remove="5817674c-81d9-4adb-bfb2-8f6a442e4622"} +``` + +The command shown above removes the app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" from the application meeting configuration settings for the tenant to disallow it to remove participant. + +## PARAMETERS + +### -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: XdsIdentity +Parameter Sets: (All) +Aliases: + +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: PSObject +Parameter Sets: Instance +Aliases: +Applicable: Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AllowRemoveParticipantAppIds + +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +None. +The `Set-CsApplicationMeetingConfiguration` cmdlet does not accept pipelined input. + +## OUTPUTS + +### Output types +The `Set-CsApplicationMeetingConfiguration` cmdlet does not return any objects or values. + +## NOTES + +## RELATED LINKS + +[Get-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csapplicationmeetingconfiguration) diff --git a/teams/teams-ps/teams/Set-CsAutoAttendant.md b/teams/teams-ps/teams/Set-CsAutoAttendant.md new file mode 100644 index 0000000000..f1241561ad --- /dev/null +++ b/teams/teams-ps/teams/Set-CsAutoAttendant.md @@ -0,0 +1,177 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsAutoAttendant + +## SYNOPSIS +Use the Set-CsAutoAttendant cmdlet to modify the properties of an existing Auto Attendant (AA). + +## SYNTAX + +```powershell +Set-CsAutoAttendant -Instance <Object> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-CsAutoAttendant cmdlet lets you modify the properties of an auto attendant. For example, you can change the operator, the greeting, or the menu prompts. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +$autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" + +$christmasGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." +$christmasMenuOption = New-CsAutoAttendantMenuOption -Action DisconnectCall -DtmfResponse Automatic +$christmasMenu = New-CsAutoAttendantMenu -Name "Christmas Menu" -MenuOptions @($christmasMenuOption) +$christmasCallFlow = New-CsAutoAttendantCallFlow -Name "Christmas" -Greetings @($christmasGreetingPrompt) -Menu $christmasMenu + +$dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" +$christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) + +$christmasCallHandlingAssociation = New-CsAutoAttendantCallHandlingAssociation -Type Holiday -ScheduleId $christmasSchedule.Id -CallFlowId $christmasCallFlow.Id + +$autoAttendant.CallFlows += @($christmasCallFlow) +$autoAttendant.CallHandlingAssociations += @($christmasCallHandlingAssociation) + +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 -------------------------- +```powershell +$autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" + +$autoAttendant.CallFlows + +# Id : e68dfc2f-587b-42ee-98c7-b9c9ebd46fd1 +# Name : After hours +# Greetings : +# Menu : After Hours Menu + +# Id : 8ab460f0-770c-4d30-a2ff-a6469718844f +# Name : Christmas CallFlow +# Greetings : +# Menu : Christmas Menu + +$autoAttendant.CallFlows[1].Greetings + +# ActiveType : TextToSpeech +# TextToSpeechPrompt : We are closed for Christmas. Please call back later. +# AudioFilePrompt : + +$christmasGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Our offices are closed for Christmas from December 24 to December 26. Please call back later." +$autoAttendant.CallFlows[1].Greetings = @($christmasGreetingPrompt) + +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 -------------------------- +```powershell +$autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" +$autoAttendant.CallHandlingAssociations + +# Type : Holiday +# ScheduleId : 578745b2-1f94-4a38-844c-6bf6996463ee +# CallFlowId : a661e694-e2df-4aaa-a183-67bf819c3cac +# Enabled : True + +# Type : AfterHours +# ScheduleId : c2f160ca-119d-55d8-818c-def2bcb85515 +# CallFlowId : e7dd255b-ee20-57f0-8a2b-fc403321e284 +# Enabled : True + +$autoAttendant.CallHandlingAssociations = $autoAttendant.CallHandlingAssociations | where-object {$_.ScheduleId -ne "578745b2-1f94-4a38-844c-6bf6996463ee"} + +$autoAttendant.CallFlows + +# Id : e68dfc2f-587b-42ee-98c7-b9c9ebd46fd1 +# Name : After hours +# Greetings : +# Menu : After Hours Menu + +# Id : 8ab460f0-770c-4d30-a2ff-a6469718844f +# Name : Christmas CallFlow +# Greetings : +# Menu : Christmas Menu + +$autoAttendant.CallFlows = $autoAttendant.CallFlows | where-object {$_.Id -ne "8ab460f0-770c-4d30-a2ff-a6469718844f"} + +Set-CsAutoAttendant -Instance $autoAttendant +``` + +This example modifies an existing AA, removing the Christmas holiday call handling. We removed the call handling association for Christmas holiday, along with the related call flow. + +## PARAMETERS + +### -Instance +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant +The Set-CsAutoAttendant cmdlet accepts a `Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant` object as the Instance parameter. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant +The modified instance of the `Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant` object. + +## NOTES + +## RELATED LINKS + +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) + +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) + +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) + +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) + +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Set-CsCallQueue.md b/teams/teams-ps/teams/Set-CsCallQueue.md new file mode 100644 index 0000000000..8f93fc3973 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsCallQueue.md @@ -0,0 +1,1727 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cscallqueue +applicable: Microsoft Teams +title: Set-CsCallQueue +schema: 2.0.0 +ms.reviewer: +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsCallQueue + +## SYNOPSIS +Updates a Call Queue in your Skype for Business Online or Teams organization. + +## SYNTAX + +``` +Set-CsCallQueue -Identity <Guid> [-AgentAlertTime <Int16>] [-AllowOptOut <Boolean>] [-ChannelId <Guid>] [-ChannelUserObjectId <Guid>] [-ShiftsTeamId <String>] [-ShiftsSchedulingGroupId <String>] [-DistributionLists <List>] [-MusicOnHoldAudioFileId <Guid>] [-Name <String>] [-OboResourceAccountIds <List>] [-OverflowAction <Object>] [-OverflowActionTarget <Guid>] [-OverflowActionCallPriority <Int16>] [-OverflowThreshold <Int16>] [-RoutingMethod <Object>] [-TimeoutAction <Object>] [-Tenant <Guid>] [-TimeoutActionTarget <Guid>] [-TimeoutActionCallPriority <Int16>] [-TimeoutThreshold <Int16>] [-NoAgentApplyTo <String>] [-NoAgentAction <Object>] [-NoAgentActionTarget <Guid>] [-NoAgentActionCallPriority <Int16>] [-UseDefaultMusicOnHold <Boolean>] [-WelcomeMusicAudioFileId <Guid>] [-PresenceBasedRouting <Boolean>] [-ConferenceMode <Boolean>] [-Users <List>] [-LanguageId <String>] [-LineUri <String>] [-OverflowDisconnectTextToSpeechPrompt <String>][-OverflowDisconnectAudioFilePrompt <Guid>] [-OverflowRedirectPersonTextToSpeechPrompt <String>] [-OverflowRedirectPersonAudioFilePrompt <Guid>] [-OverflowRedirectVoiceAppTextToSpeechPrompt <String>] [-OverflowRedirectVoiceAppAudioFilePrompt <Guid>] [-OverflowRedirectPhoneNumberTextToSpeechPrompt <String>] [-OverflowRedirectPhoneNumberAudioFilePrompt <Guid>] [-OverflowRedirectVoicemailTextToSpeechPrompt <String>] [-OverflowRedirectVoicemailAudioFilePrompt <Guid>] [-OverflowSharedVoicemailTextToSpeechPrompt <String>] [-OverflowSharedVoicemailAudioFilePrompt <Guid>] [-EnableOverflowSharedVoicemailTranscription <Boolean>] [-EnableOverflowSharedVoicemailSystemPromptSuppression <Boolean>] [-TimeoutDisconnectTextToSpeechPrompt <String>][-TimeoutDisconnectAudioFilePrompt <Guid>] [-TimeoutRedirectPersonTextToSpeechPrompt <String>] [-TimeoutRedirectPersonAudioFilePrompt <Guid>] [-TimeoutRedirectVoiceAppTextToSpeechPrompt <String>] [-TimeoutRedirectVoiceAppAudioFilePrompt <Guid>] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt <String>][-TimeoutRedirectPhoneNumberAudioFilePrompt <Guid>] [-TimeoutRedirectVoicemailTextToSpeechPrompt <String>] [-TimeoutRedirectVoicemailAudioFilePrompt <Guid>] [-TimeoutSharedVoicemailTextToSpeechPrompt <String>] [-TimeoutSharedVoicemailAudioFilePrompt <Guid>] [-TimeoutSharedVoicemailTextToSpeechPrompt <String>] [-TimeoutSharedVoicemailAudioFilePrompt <Guid>] [-EnableTimeoutSharedVoicemailTranscription <Boolean>] [-EnableTimeoutSharedVoicemailSystemPromptSuppression <Boolean>] [-NoAgentDisconnectTextToSpeechPrompt <String>][-NoAgentDisconnectAudioFilePrompt <Guid>] [-NoAgentRedirectPersonTextToSpeechPrompt <String>] [-NoAgentRedirectPersonAudioFilePrompt <Guid>] [-NoAgentRedirectVoiceAppTextToSpeechPrompt <String>] [-NoAgentRedirectVoiceAppAudioFilePrompt <Guid>] [-NoAgentRedirectPhoneNumberTextToSpeechPrompt <String>] [-NoAgentRedirectPhoneNumberAudioFilePrompt <Guid>] [-NoAgentRedirectVoicemailTextToSpeechPrompt <String>] [-NoAgentRedirectVoicemailAudioFilePrompt <Guid>] [-NoAgentSharedVoicemailTextToSpeechPrompt <String>] [-NoAgentSharedVoicemailAudioFilePrompt <Guid>] [-EnableNoAgentSharedVoicemailTranscription <Boolean>] [-EnableNoAgentSharedVoicemailSystemPromptSuppression <Boolean>] [AuthorizedUsers <List>] [-HideAuthorizedUsers <List>] [-WelcomeTextToSpeechPrompt <String>] [-IsCallbackEnabled <Boolean>] [-CallbackRequestDtmf <String>] [-WaitTimeBeforeOfferingCallbackInSecond <Int16>] [-NumberOfCallsInQueueBeforeOfferingCallback <Int16>] [-CallToAgentRatioThresholdBeforeOfferingCallback <Int16>] [-CallbackOfferAudioFilePromptResourceId <Guid>] [-CallbackOfferTextToSpeechPrompt <String>] [-CallbackEmailNotificationTarget <Guid>] [-ServiceLevelThresholdResponseTimeInSecond [Int16> ] [-ComplianceRecordingForCallQueueTemplateId <List>] [-TextAnnouncementForCR <String>] [-CustomAudioFileAnnouncementForCR <Guid>] [-TextAnnouncementForCRFailure <String>] [-CustomAudioFileAnnouncementForCRFailure <Guid>] [-ShouldOverwriteCallableChannelProperty <Boolean>] [-SharedCallQueueHistoryTemplateId <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +Set-CsCallQueue cmdlet provides a way for you to modify the properties of an existing Call Queue; for example, you can change the name for the Call Queue, the distribution lists associated with the Call Queue, or the welcome audio file. + +The Set-CsCallQueue cmdlet may suggest additional steps required to complete the Call Queue setup. + +Note that this cmdlet is in the Skype for Business Online PowerShell module and also affects Teams. The reason the "Applies To:" is stated as Skype for Business Online is because it must match the actual module name of the cmdlet. To learn how this cmdlet is used with Skype for Business Online and Teams, see https://learn.microsoft.com/microsoftteams/create-a-phone-system-call-queue. + +> [!CAUTION] +> The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items. +> +> - -HideAuthorizedUsers +> - -OverflowActionCallPriority +> - -OverflowRedirectPersonTextToSpeechPrompt +> - -OverflowRedirectPersonAudioFilePrompt +> - -OverflowRedirectVoicemailTextToSpeechPrompt +> - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutActionCallPriority +> - -TimeoutRedirectPersonTextToSpeechPrompt +> - -TimeoutRedirectPersonAudioFilePrompt +> - -TimeoutRedirectVoicemailTextToSpeechPrompt +> - -TimeoutRedirectVoicemailAudioFilePrompt +> - -NoAgentActionCallPriority +> - -NoAgentRedirectPersonTextToSpeechPrompt +> - -NoAgentRedirectPersonAudioFilePrompt +> - -NoAgentRedirectVoicemailTextToSpeechPrompt +> - -NoAgentRedirectVoicemailAudioFilePrompt +> +> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. +> +> - -ShiftsTeamId +> - -ShiftsSchedulingGroupId +> - -ComplianceRecordingForCallQueueTemplateId +> - -TextAnnouncementForCR +> - -CustomAudioFileAnnouncementForCR +> - -TextAnnouncementForCRFailure +> - -CustomAudioFileAnnouncementForCRFailure +> - -SharedCallQueueHistoryTemplateId +> +> [Nesting Auto attendants and Call queues](/microsoftteams/plan-auto-attendant-call-queue#nested-auto-attendants-and-call-queues) without a resource account isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. +> +> Authorized users can't edit call flows with call priorities at this time. + + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -UseDefaultMusicOnHold $true +``` + +This example updates the Call Queue with identity e7e00636-47da-449c-a36b-1b3d6ee04440 by making it use the default music on hold. + +### -------------------------- Example 2 -------------------------- +``` +Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldAudioFileId $audioFile.Id +``` + +This example updates the Call Queue with new distribution lists and references a new music on hold audio file using the audio file ID from the stored variable $audioFile created with the [Import-CsOnlineAudioFile cmdlet](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentAlertTime +The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 30 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOptOut +The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionLists +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldAudioFileId +The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OboResourceAccountIds +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowAction +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: DisconnectWithBusy +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionTarget +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowThreshold +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingMethod +The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Attendant +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutAction +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionTarget +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutThreshold +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 1200 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentApplyTo +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentAction +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionTarget +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultMusicOnHold +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeMusicAudioFileId +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PresenceBasedRouting +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConferenceMode +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageId +The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. + +You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailTextToSpeechPrompt +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailAudioFilePrompt +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailTranscription +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailSystemPromptSuppression +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonAudioFilePrompt +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailTextToSpeechPrompt +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailAudioFilePrompt +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailTranscription +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailSystemPromptSuppression +The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectTextToSpeechPrompt +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectAudioFilePrompt +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppTextToSpeechPrompt +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppAudioFilePrompt +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberAudioFilePrompt +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailTextToSpeechPrompt +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailAudioFilePrompt +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailTranscription +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailSystemPromptSuppression +The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelId +Id of the channel to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelUserObjectId +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsTeamId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsSchedulingGroupId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackRequestDtmf + +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitTimeBeforeOfferingCallbackInSecond + +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfCallsInQueueBeforeOfferingCallback + +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallToAgentRatioThresholdBeforeOfferingCallback + +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This conditon applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferAudioFilePromptResourceId + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferTextToSpeechPrompt + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackEmailNotificationTarget + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS +[Create a Phone System Call Queue](https://support.office.com/article/Create-a-Phone-System-call-queue-67ccda94-1210-43fb-a25b-7b9785f8a061) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) + diff --git a/teams/teams-ps/teams/Set-CsCallingLineIdentity.md b/teams/teams-ps/teams/Set-CsCallingLineIdentity.md new file mode 100644 index 0000000000..16e76a4a04 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsCallingLineIdentity.md @@ -0,0 +1,236 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsCallingLineIdentity + +## SYNOPSIS +Use the `Set-CsCallingLineIdentity` cmdlet to modify a Caller ID policy in your organization. + +## SYNTAX + +### Identity (Default) +``` +Set-CsCallingLineIdentity [[-Identity] <string>] [-BlockIncomingPstnCallerID <boolean>] [-CallingIDSubstitute <string>] [-CompanyName <string>] +[-Description <string>] [-EnableUserOverride <boolean>] [-ResourceAccount <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can either change or block the Caller ID (also called a Calling Line ID) for a user. +By default, the Microsoft Teams or Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. +You can modify a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed. + +Note: +- Identity must be unique. +- If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Set-CsCallingLineIdentity -Identity "MyBlockingPolicy" -BlockIncomingPstnCallerID $true +``` + +This example blocks the incoming caller ID. + +### Example 2 +``` +PS C:\> Set-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true +``` + +This example modifies the new Anonymous Caller ID policy to block the incoming Caller ID. + +### Example 3 +``` +$ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId +Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -ResourceAccount $ObjId -CompanyName "Contoso" +``` + +This example modifies the Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso + +### Example 4 +``` +Set-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true +``` + +This example modifies the Caller ID policy and allows Teams users to make anonymous calls. + +## PARAMETERS + +### -BlockIncomingPstnCallerID +The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. + +The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a Teams user, then Caller ID for incoming calls is suppressed/anonymous. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallingIDSubstitute +The CallingIDSubstitute parameter lets you specify an alternate Caller ID. +The possible values are Anonymous, LineUri and Resource. + +```yaml +Type: CallingIDSubstituteType +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +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 +``` + +### -Description +The Description parameter briefly describes the Caller ID policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUserOverride +The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. + +If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. + +EnableUserOverride has precedence over other settings in the policy unless substitution is set to Anonymous. For example, assume the policy instance has substitution using a resource account and EnableUserOverride is set and enabled by the user. In this case, the outbound caller ID will be blocked and Anonymous will be used. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter identifies the Caller ID policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceAccount +This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts. + +```yaml +Type: 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 +``` + +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) + +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) + +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) + +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..2ee33ba19c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: Set-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +Set-CsComplianceRecordingForCallQueueTemplate -Instance <Object> [<CommonParameters>] +``` + +## DESCRIPTION +Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to an existing Compliance Recording for Call Queues template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$template = CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +$template.BotId = 14732826-8206-42e3-b51e-6693e2abb698 +Set-CsComplianceRecordingForCallQueueTemplate $template +``` + +The Set-CsComplianceRecordingForCallQueueTemplate cmdlet lets you modify the properties of a Compliance Recording for Call Queue Template. + +## PARAMETERS + +### -Instance +The Instance parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CscomplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQuuee](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..4c738c2d83 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md @@ -0,0 +1,553 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy +applicable: Microsoft Teams +title: Set-CsExternalAccessPolicy +schema: 2.0.0 +ms.reviewer: rogupta +--- + +# Set-CsExternalAccessPolicy + +## SYNOPSIS +Enables you to modify the properties of an existing external access policy. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Set-CsExternalAccessPolicy [[-Identity] <XdsIdentity>] + [-AllowedExternalDomains <List>] + [-BlockedExternalDomains <List>] + [-CommunicationWithExternalOrgs <String>] + [-Confirm] + [-Description <String>] + [-EnableAcsFederationAccess <Boolean>] + [-EnableFederationAccess <Boolean>] + [-EnableOutsideAccess <Boolean>] + [-EnablePublicCloudAudioVideoAccess <Boolean>] + [-EnableTeamsConsumerAccess <Boolean>] + [-EnableTeamsConsumerInbound <Boolean>] + [-EnableTeamsSmsAccess <Boolean>] + [-EnableXmppAccess <Boolean>] + [-FederatedBilateralChats <Boolean>] + [-Force] + [-RestrictTeamsConsumerAccessToExternalUserProfiles <Boolean>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +### Instance +``` +Set-CsExternalAccessPolicy [-Instance <PSObject>] + [-AllowedExternalDomains <List>] + [-BlockedExternalDomains <List>] + [-CommunicationWithExternalOrgs <String>] + [-Confirm] + [-Description <String>] + [-EnableAcsFederationAccess <Boolean>] + [-EnableFederationAccess <Boolean>] + [-EnableOutsideAccess <Boolean>] + [-EnablePublicCloudAudioVideoAccess <Boolean>] + [-EnableTeamsConsumerAccess <Boolean>] + [-EnableTeamsConsumerInbound <Boolean>] + [-EnableTeamsSmsAccess <Boolean>] + [-EnableXmppAccess <Boolean>] + [-FederatedBilateralChats <Boolean>] + [-Force] + [-RestrictTeamsConsumerAccessToExternalUserProfiles <Boolean>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet. + +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + + The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant + +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet or Teams admin center under the External Access setting. + +After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. +For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. +If you would like to grant this capability to all of your users you can call the `Set-CsExternalAccessPolicy` cmdlet and set the value of the global policy's EnableFederationAccess property to True. + +## EXAMPLES + +### -------------------------- Example 1 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True +``` + +The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. +In this example, the command changes the value of the EnableFederationAccess property to True. + +### -------------------------- Example 2 ------------------------ +``` +Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True +``` + +In Example 2, federation access is enabled for all the external access policies configured for use in the organization. +To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. +That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. + +### -------------------------- Example 3 ------------------------ +``` +Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True +``` + +Example 3 enables federation access for all the external access policies that have been configured at the per-user scope. +To carry out this task, the first thing the command does is use the `Get-CsExternalAcessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. +(The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". +Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. + +### -------------------------- Example 4 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false +New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true +``` + +In this example, the Global policy is updated to disallow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation enabled and which can be assigned to selected users for which Team-ACS federation will be allowed. + +### -------------------------- Example 5 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true +New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false +``` + +In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. + +### -------------------------- Example 6 ------------------------ +``` +New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") +Set-CsTenantFederationConfiguration -CustomizeFederation $true +``` +In this example, we create an ExternalAccessPolicy named "GranularFederationExample" that allows communication with specific external domains, namely `example1.com` and `example2.com`. The federation policy is set to restrict communication to only these allowed domains. + +## PARAMETERS + +### -Identity +Unique identifier for the external access policy to be modified. +External access policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +If this parameter is not specified then the global policy will be modified. + +Note that wildcards are not allowed when specifying an Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AllowedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains allowed to communicate with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `AllowSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains blocked from communicating with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `BlockSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunicationWithExternalOrgs +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options: + +- OrganizationDefault: users follow the federation settings specified in `TenantFederationConfiguration`. This is the default value. +- AllowAllExternalDomains: users are allowed to communicate with all domains. +- AllowSpecificExternalDomains: users can communicate with external domains listed in `AllowedExternalDomains`. +- BlockSpecificExternalDomains: users are blocked from communicating with domains listed in `BlockedExternalDomains`. +- BlockAllExternalDomains: users cannot communicate with any external domains. + +The setting is only applicable when `EnableFederationAccess` is set to true. This setting can only be modified in custom policies. In the Global (default) policy, it is fixed to `OrganizationDefault` and cannot be changed. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: OrganizationDefault +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide additional text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcsFederationAccess +Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. + +Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFederationAccess +Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOutsideAccess +Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePublicCloudAudioVideoAccess +Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. +When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerAccess +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerInbound +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsSmsAccess +Allows you to control whether users can have SMS text messaging capabilities within Teams. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableXmppAccess +Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedBilateralChats +> [!NOTE] +> Please note that this parameter is in Private Preview. + +This setting enables bi-lateral chats for the users included in the messaging policy. + +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + +Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. + +This policy doesn't apply to meetings, meeting chats, or channels. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictTeamsConsumerAccessToExternalUserProfiles +Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +The `Set-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. + +## OUTPUTS + +### Output types +The `Set-CsExternalAccessPolicy` cmdlet does not return a value or object. +Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md new file mode 100644 index 0000000000..c74a4f85ba --- /dev/null +++ b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md @@ -0,0 +1,25 @@ +--- +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-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md new file mode 100644 index 0000000000..010cb41526 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Set-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# Set-CsInboundBlockedNumberPattern + +## SYNOPSIS +Modifies one or more parameters of a blocked number pattern in the tenant list. + +## SYNTAX + +### Identity (Default) +``` +Set-CsInboundBlockedNumberPattern [[-Identity] <string>] [-Description <string>] [-Enabled <boolean>] [-Pattern <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet modifies one or more parameters of a blocked number pattern in the tenant list. + +## EXAMPLES + +### Example 1 +```powershell +PS> Set-CsInboundBlockedNumberPattern -Identity "BlockAutomatic" -Pattern "^\+11234567890" +``` + +This example modifies a blocked number pattern to block inbound calls from +11234567890 number. + +## PARAMETERS + +### -Description +A friendly description for the blocked number pattern to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +If this parameter is set to True, the inbound calls matching the pattern will be blocked. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier specifying the blocked number pattern to be modified. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the calling number must match in order to be blocked. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) + +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) + +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md new file mode 100644 index 0000000000..592cc10d0f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: Set-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Set-CsInboundExemptNumberPattern + +## SYNOPSIS + +Modifies one or more parameters of an exempt number pattern in the tenant list. + +## SYNTAX + +### Identity (Default) +``` +Set-CsInboundExemptNumberPattern [[-Identity] <string>] [-Description <string>] [-Enabled <boolean>] [-Pattern <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet modifies one or more parameters of an exempt number pattern in the tenant list. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS> Set-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Pattern "^\+?1312555888[2|3]$" +``` + +Sets the inbound exempt number pattern for AllowContoso1 + +### EXAMPLE 2 + +```powershell +PS> Set-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Enabled $False +``` + +Disables the exempt number pattern from usage in call blocking + +## PARAMETERS + +### -Description + +Sets the description of the number pattern. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter determines whether the number pattern is enabled for exemption or not. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the exempt number pattern to be changed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern + +A regular expression that the calling number must match in order to be exempt from blocking. It is best practice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +You can use Test-CsInboundBlockedNumberPattern to test your block and exempt phone number ranges. + +## RELATED LINKS + +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) + +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) + +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..4e64fee3fa --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance +applicable: Microsoft Teams +title: Set-CsOnlineApplicationInstance +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineApplicationInstance + +## SYNOPSIS +Updates an application instance in Microsoft Entra ID. + +**Note**: The use of this cmdlet for assigning phone numbers in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + +## SYNTAX + +``` +Set-CsOnlineApplicationInstance [-Identity] <string> [[-OnpremPhoneNumber] <string>] [[-ApplicationId] <guid>] [[-AcsResourceId] <guid>] [[-DisplayName] <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is used to update an application instance in Microsoft Entra ID. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Set-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" +``` + +This example shows updated ApplicationId and DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". + +## PARAMETERS + +### -Identity +The URI or ID of the application instance to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnpremPhoneNumber +**Note**: Using this parameter has been deprecated in commercial and GCC cloud instances. Use the new Set-CsPhoneNumberAssignment cmdlet instead. + +Assigns a hybrid (on-premise) telephone number to the application instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..a1b9ec1f59 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,177 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy +title: Set-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Set-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +## SYNTAX + +```powershell +Set-CsOnlineAudioConferencingRoutingPolicy [-Description <String>] [[-Identity] <String>] + [-OnlinePstnUsages <Object>] [-RouteType <String>] [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" +``` + +Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md similarity index 86% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md index 9c42cf9815..a0d2c3d32d 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingbridge +applicable: Microsoft Teams title: Set-CsOnlineDialInConferencingBridge schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsOnlineDialInConferencingBridge @@ -45,7 +50,6 @@ Set-CsOnlineDialInConferencingBridge -Name "Conference Bridge" -DefaultServiceNu This example sets the default dial-in phone number to 14255551234 for the audio conferencing bridge named "Conference Bridge". - ### -------------------------- Example 2 -------------------------- ``` $bridge = Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" @@ -55,8 +59,7 @@ $Bridge.Name = "O365 Bridge" Set-CsOnlineDialInConferencingBridge -Instance $bridge ``` -This example changes the name of a conference bridge by creating an conference bridge instance, changing the instance's name and then setting the conference bridge to the instance. - +This example changes the name of a conference bridge by creating a conference bridge instance, changing the instance's name and then setting the conference bridge to the instance. ## PARAMETERS @@ -66,8 +69,8 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -82,8 +85,8 @@ Allows you to pass a reference to a Microsoft audio conferencing bridge object t ```yaml Type: ConferencingBridge Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -98,8 +101,8 @@ Specifies the name of the audio conferencing bridge to be modified. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -115,7 +118,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -134,8 +137,8 @@ Also, when the default service number is changed, the service number of existing ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -156,7 +159,7 @@ Computer name: -DomainController atl-cs-001 Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -173,8 +176,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -189,8 +192,8 @@ PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -205,8 +208,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -221,8 +224,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -239,7 +242,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -249,7 +252,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -258,4 +261,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md similarity index 89% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md index 2d33e730d3..a64dcc2c2b 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md @@ -1,8 +1,13 @@ --- -external help file: -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams title: Set-CsOnlineDialInConferencingServiceNumber schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsOnlineDialInConferencingServiceNumber @@ -89,7 +94,6 @@ Set-CsOnlineDialInConferencingServiceNumber -Identity +14255551234 -PrimaryLangu This example sets the primary language to German (Germany) and the secondary languages to US English, Japanese, and UK English for the dial-in service number +14255551234. - ## PARAMETERS ### -Identity @@ -99,8 +103,8 @@ The service number can be specified in the following formats: E.164 number, +\<E ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -115,8 +119,8 @@ Allows you to pass a reference to the Office 365 audio service number object to ```yaml Type: ConferencingServiceNumber Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -132,7 +136,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -153,7 +157,7 @@ Computer name: -DomainController atl-cs-001 Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -170,8 +174,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -190,8 +194,8 @@ Use the `Get-CsOnlineDialInConferencingLanguagesSupported` cmdlet to get a list ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -206,8 +210,8 @@ Including this switch restores all of the default languages for the audio confer ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -228,8 +232,8 @@ Use the `Get-CsOnlineDialInConferencingLanguagesSupported` cmdlet to get a list ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -244,8 +248,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -262,7 +266,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -272,7 +276,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -281,4 +285,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md new file mode 100644 index 0000000000..26cf1b24c2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md @@ -0,0 +1,562 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-CsOnlineDialInConferencingTenantSettings + +## SYNOPSIS +Use the `Set-CsOnlineDialInConferencingTenantSettings` to modify the tenant level settings of dial-in conferencing. +Dial-in conferencing tenant settings control the conference experience of users and manage some conferencing administrative functions. + +## SYNTAX + +```powershell +Set-CsOnlineDialInConferencingTenantSettings [-AllowedDialOutExternalDomains <Object>] + [-AllowFederatedUsersToDialOutToSelf <String>] [-AllowFederatedUsersToDialOutToThirdParty <String>] + [-AllowPSTNOnlyMeetingsByDefault <Boolean>] [-AutomaticallyMigrateUserMeetings <Boolean>] + [-AutomaticallyReplaceAcpProvider <Boolean>] [-AutomaticallySendEmailsToUsers <Boolean>] + [-EnableDialOutJoinConfirmation <Boolean>] [-EnableEntryExitNotifications <Boolean>] + [-EnableNameRecording <Boolean>] [-EntryExitAnnouncementsType <String>] [[-Identity] <String>] + [-IncludeTollFreeNumberInMeetingInvites <Boolean>] [-MaskPstnNumbersType <String>] + [-MigrateServiceNumbersOnCrossForestMove <Boolean>] [-PinLength <UInt32>] [-SendEmailFromAddress <String>] + [-SendEmailFromDisplayName <String>] [-SendEmailFromOverride <Boolean>] [-UseUniqueConferenceIds <Boolean>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Dial-in conferencing tenant settings control what functions are available during a conference call. +For example, whether or not entries and exits from the call are announced. +The settings also manage some of the administrative functions, such as when users get notification of administrative actions, like a PIN change. +By contrast, the higher level dial-in conferencing configuration only maintains a flag for whether dial-in conferencing is enabled for your organization. +For more information, see `Get-CsOnlineDialinConferencingTenantConfiguration`. + +There is always a single instance of the dial-in conferencing settings per tenant. +You can modify the settings using `Set-CsOnlineDialInConferencingTenantSettings` and revert those settings to their defaults by using `Remove-CsOnlineDialInConferencingTenantSettings`. + +The following parameters are not applicable to Teams: EnableDialOutJoinConfirmation, IncludeTollFreeNumberInMeetingInvites, MigrateServiceNumbersOnCrossForestMove, and UseUniqueConferenceIds + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True -EnableNameRecording $True -PinLength 7 +``` + +This example sets the tenant's conferencing settings to enable entry and exit notifications supported by name recording. +The PIN length is set to 7. + +### -------------------------- Example 2 -------------------------- +``` +Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendEmailFromAddress admin@contoso.com -SendEmailFromDisplayName "Conferencing Administrator" +``` + +This example defines the contact information to be used in dial-in conferencing email notifications and enables the default address to be overridden. + +## PARAMETERS + +### -AllowedDialOutExternalDomains + +Used to specify which external domains are allowed for dial-out conferencing. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedUsersToDialOutToSelf + +Meeting participants can call themselves when they join a meeting. Possible settings are [No|Yes|RequireSameEnterpriseUser]. + This parameter is Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedUsersToDialOutToThirdParty + +Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. +This parameter is Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPSTNOnlyMeetingsByDefault +Specifies the default value that gets assigned to the "AllowPSTNOnlyMeetings" setting of users when they are enabled for dial-in conferencing, or when a user's dial-in conferencing provider is set to Microsoft. +If set to $true, the "AllowPSTNOnlyMeetings" setting of the user will also be set to true. +If $false, the user setting will be false. +The default value for AllowPSTNOnlyMeetingsByDefault is $false. + +When AllowPSTNOnlyMeetingsByDefault is changed, the value of the "AllowPSTNOnlyMeetings" setting of currently enabled users doesn't change. +The new default value will only be applied to users that are subsequently enabled for dial-in conferencing, or whose provider is changed to Microsoft. + +The "AllowPSTNOnlyMeetings" setting of a user defines if 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 the organizer PIN when joining the meeting. + +For more information on the "AllowPSTNOnlyMeetings" user setting, see `Set-CsOnlineDialInConferencingUser`. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticallyMigrateUserMeetings + +Specifies if meetings of users in the tenant should automatically be rescheduled via the Meeting Migration Service when there's a change in the users' Cloud PSTN Confernecing coordinates, e.g. when a user is provisioned, de-provisoned, assigned a new default service number etc. If this is false, users will need to manually migrate their conferences using the Meeting Migration tool. +PARAMVALUE: $true | $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticallyReplaceAcpProvider + +Specifies if a user already enabled for a 3rd party Audio Conferencing Provider (ACP) should automatically be converted to Microsoft's Online DialIn Conferencing service when a license for Microsoft's service is assigned to the user. If this is false, tenant admins will need to manually provision the user with the Enable-CsOnlineDialInConferencingUser cmdlet with the -ReplaceProvider switch present. +PARAMVALUE: $true | $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticallySendEmailsToUsers +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. + +User is enabled or disabled for dial-in conferencing. + +The dial-in conferencing provider is changed either to Microsoft, or from Microsoft to another provider, or none. + +The dial-in conferencing PIN is reset by the tenant administrator. + +Changes to either the user's conference ID, or the user's default dial-in conference number. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -EnableDialOutJoinConfirmation + +Specifies if the callees need to confirm to join the conference call. If true, the callees will hear prompts to ask for confirmation to join the conference call, otherwise callees will join the conference call directly. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEntryExitNotifications + +Specifies if, by default, announcements are made as users enter and exit a conference call. +Set to $true to enable notifications, $false to disable notifications. +The default is $true. + +This setting can be overridden on a meeting by meeting basis when a user joins a meeting via a Skype for Business client and modifies the Announce when people enter or leave setting on the Skype Meeting Options menu of a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNameRecording + +Specifies whether the name of a user is recorded on entry to the conference. +This recording is used during entry and exit notifications. +Set to $true to enable name recording, set to $false to bypass name recording. +The default is $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntryExitAnnouncementsType + +Specifies if the Entry and Exit Announcement Uses names or tones only. +PARAMVALUE: UseNames | ToneOnly + +```yaml +Type: EntryExitAnnouncementsType +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTollFreeNumberInMeetingInvites +This parameter is obsolete and not functional. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateServiceNumbersOnCrossForestMove + +Specifies whether service numbers assigned to the tenant should be migrated to the new forest of the tenant when the tenant is migrated cross region. If false, service numbers will be released back to stock once the migration completes. This settings does not apply to ported-in numbers that are always migrated. +PARAMVALUE: $true | $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinLength +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. + +A user's PIN will only authenticate them as leaders for a meeting they scheduled. +The PIN of a user that did not schedule the meeting will not enable that user to lead the meeting. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmailFromAddress +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 \<UserAlias\>@\<Domain\>. +For example, "KenMyer@Contoso.com" or "Admin@Contoso.com". + +The SendEmailFromAddress value is used only if the SendEmailFromDisplayName setting is specified, and the SendEmailFromOverride setting is $true. + +Note: The parameter has been deprecated and may be removed in future versions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmailFromDisplayName +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. + +Note: The parameter has been deprecated and may be removed in future versions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmailFromOverride +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. +The default is $false. + +SendEmailFromOverride can't be $true if SendEmailFromAddress and SendEmailFromDisplayName aren't specified. + +If you want to change the email address information, you need to make sure that your inbound email policies allow for emails that come from the address specified by the SendEmailFromAddress parameter. + +Note: The parameter has been deprecated and may be removed in future versions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseUniqueConferenceIds + +Specifies if Private Meetings are enabled for the users in this tenant. +PARAMVALUE: $true | $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -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 +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) + +[Remove-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md new file mode 100644 index 0000000000..a0768687dc --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md @@ -0,0 +1,400 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser +applicable: Microsoft Teams +title: Set-CsOnlineDialInConferencingUser +schema: 2.0.0 +--- + +# 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 + +### TenantIdParams (Default) +``` +Set-CsOnlineDialInConferencingUser [-Identity] <UserIdParameter> [-BridgeId <Guid>] + [-BridgeName <String>] [-Tenant <Guid>] [-ServiceNumber <String>] [-TollFreeServiceNumber <String>] [-AllowPSTNOnlyMeetings <Boolean>] [-Force] + [-ResetLeaderPin] [-AllowTollFreeDialIn <Boolean>] [-SendEmailToAddress <String>] + [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] [-SendEmail] [-DomainController <Fqdn>] [-AsJob] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### TenantDomainParams +``` +Set-CsOnlineDialInConferencingUser [-Identity] <UserIdParameter> [-BridgeId <Guid>] + [-BridgeName <String>] [-TenantDomain <String>] [-ServiceNumber <String>] [-TollFreeServiceNumber <String>] [-AllowPSTNOnlyMeetings <Boolean>] [-Force] + [-ResetLeaderPin] [-AllowTollFreeDialIn <Boolean>] [-SendEmailToAddress <String>] + [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] [-SendEmail] [-DomainController <Fqdn>] [-AsJob] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Set-CsOnlineDialInConferencingUser` cmdlet is used to modify properties for a Microsoft audio conferencing user. +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. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" +``` + +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. + +```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 +``` + +### -TenantDomain +Specifies the domain name for the tenant or organization. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPSTNOnlyMeetings +If true, non-authenticated users can start meetings. +If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. +An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. +The default is false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BridgeId +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BridgeName +Specifies the name of the audio conferencing bridge. + +```yaml +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 +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 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: Fqdn +Parameter Sets: (All) +Aliases: DC +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetLeaderPin +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmail +Send an email to the user containing their Audio Conference information. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmailFromAddress +You can specify the From Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromDisplayName and -SendEmail. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmailFromDisplayName +You can specify the Display Name to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromAddress and -SendEmail. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendEmailToAddress +You can specify the To Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmail. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceNumber +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. + +The service number can be specified in the following formats: E.164 number, +\<E.164 number\> and tel:\<E.164 number\>. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. +For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. +You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TollFreeServiceNumber +Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. The toll-free number can be specified in the following formats: E.164 number, +\<E.164 number\> and tel:\<E.164 number\>. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf parameter is not implemented for this cmdlet. + +```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 +``` + +### -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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +The parameter is used to run commands as background jobs. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) + +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md new file mode 100644 index 0000000000..9b13013f9e --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md @@ -0,0 +1,320 @@ +--- +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 <String>] [-Tenant <Guid>] + -BridgeName <String> [-FromNumber <String>] -ToNumber <String> -NumberType <String> + [-CountryOrRegion <String>] [-AreaOrState <String>] [-CapitalOrMajorCity <String>] [-RescheduleMeetings] + [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FilterByUsageLocation +``` +Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain <String>] [-Tenant <Guid>] + [-BridgeName <String>] -BridgeId <Guid> -ToNumber <String> -NumberType <String> + -CountryOrRegion <String> [-AreaOrState <String>] [-CapitalOrMajorCity <String>] [-RescheduleMeetings] + [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UniqueBridgeParams +``` +Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain <String>] [-Tenant <Guid>] + -BridgeId <System.Guid> -FromNumber <String> -ToNumber <String> -NumberType <String> [-RescheduleMeetings] + [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md new file mode 100644 index 0000000000..289ee4575e --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer +applicable: Microsoft Teams +title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsOnlineEnhancedEmergencyServiceDisclaimer + +## SYNOPSIS +When using Microsoft Teams PSTN Calling Services you need to record your organization's acceptance of the enhanced emergency service terms and conditions. This is done per +country/region and it needs to be done before you can provide PSTN calling services to Microsoft Teams users in the country/region. + +You can record your organization's acceptance using the Set-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet at any time. If you haven't accepted it for a given country/region +you will be prompted to do so by warning information in the Teams PS Module, when you try to assign a phone number to a Microsoft Teams user, or in the Teams admin center, +when you create an emergency address in a country/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 + +``` +Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion <String> [-Version <String>] [-ForceAccept] + [-Tenant <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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 -------------------------- +``` +Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion US +``` + +This example accepts the U.S. +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". + +```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 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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: DC + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceAccept +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +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 +``` + +### -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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md new file mode 100644 index 0000000000..49f8ab38fe --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md @@ -0,0 +1,481 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +> [!IMPORTANT] +> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. + +> [!Note] +> This cmdlet is only available for public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. + +## SYNTAX + +``` +Set-CsOnlineLisCivicAddress -CivicAddressId <Guid> [-CompanyName <String>] [-CompanyTaxId <String>] + [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-StreetName <String>] [-StreetSuffix <String>] + [-PreDirectional <String>] [-PostDirectional <String>] [-City <String>] [-CityAlias <String>] + [-StateOrProvince <String>] [-CountryOrRegion <String>] [-PostalCode <String>] [-Description <String>] + [-ValidationStatus <String>] [-Latitude <String>] [-Longitude <String>] [-Confidence <String>] + [-Elin <String>] [-IsAzureMapValidationRequired <String>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Use the `Set-CsOnlineLisCivicAddress` cmdlet to modify limited fields of an existing civic address. + +Editing address using this cmdlet is restricted to the following countries/regions: +Australia, Brazil, Canada, Croatia, Czech Republic, Estonia, Hong Kong, Hungary, Israel, Japan, Latvia, Lithuania, Mexico, New Zealand, Poland, Puerto Rico, Romania, Singapore, South Korea, Slovenia, South Africa, United States. + +If the user runs this cmdlet on one of the unsupported countries, it may interfere with number assignment and potentially is against regulatory requirements, so public use of the API is limited to the above countries/regions. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -Description "City Center" -CompanyName Contoso +``` + +This example modifies the description and company name of the civic address with the identity a363a9b8-1acd-41de-916a-296c7998a024. + +### Example 2 +```powershell +Set-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -Latitude 47.63952 -Longitude -122.12781 -ELIN MICROSOFT_ELIN +``` + +This example modifies the latitude, longitude and ELIN name of the civic address with the identity a363a9b8-1acd-41de-916a-296c7998a024. + +## PARAMETERS + +### -CivicAddressId +Specifies the unique identifier of the civic address to be modified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +Specifies a new city 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 +``` + +### -CityAlias +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyTaxId +Used to store TaxId for regulatory reasons. +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion +Specifies a new country or region for the civic address. +For public use, restricted to the following countries: + +**AU, BR, CA, HR, CZ, EE, HK, HU, IL, JP, LV, LT, MX, NZ, PL, PR, RO, SG, KR, SI, ZA, US** + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HouseNumber +Specifies the new numeric portion of 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 +``` + +### -HouseNumberSuffix +Specifies the new numeric suffix of the new civic address. +For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +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 +Default value: None +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". + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreDirectional +Specifies the new directional attribute of the civic address which precedes the street name. +For example, "425 NE Smith Avenue ". + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StateOrProvince +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetName +Specifies the new street name of 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 +``` + +### -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. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationStatus +Microsoft internal use only + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confidence +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Elin +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 +``` + +### -Latitude +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 +Default value: None +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. + +```yaml +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) + +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) + +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md b/teams/teams-ps/teams/Set-CsOnlineLisLocation.md new file mode 100644 index 0000000000..d93fd56f49 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineLisLocation.md @@ -0,0 +1,504 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineLisLocation + +## SYNOPSIS +Use the \`Set-CsOnlineLisLocation\` cmdlet to modify an existing emergency dispatch location. There can be multiple locations in a civic address. +Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. + +## SYNTAX + +### UseCivicAddressId (Default) +``` +Set-CsOnlineLisLocation -CivicAddressId <guid> [-City <string>] [-CityAlias <string>] [-CompanyName <string>] [-CompanyTaxId <string>] + [-Confidence <string>] [-CountryOrRegion <string>] [-Description <string>] [-Elin <string>] [-Force] [-HouseNumber <string>] [-HouseNumberSuffix <string>] + [-Latitude <string>] [-Longitude <string>] [-PostalCode <string>] [-PostDirectional <string>] [-PreDirectional <string>] + [-StateOrProvince <string>] [-StreetName <string>] [-StreetSuffix <string>] [-IsAzureMapValidationRequired <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseLocationId +``` +Set-CsOnlineLisLocation -LocationId <guid> [-CityAlias <string>] [-Confidence <string>] [-Elin <string>] [-Force] + [-Latitude <string>] [-Longitude <string>] [-Location <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +## EXAMPLES + +### Example 1 +```powershell +Set-CsOnlineLisLocation -LocationId 5aa884e8-d548-4b8e-a289-52bfd5265a6e -Location "B5 2nd Floor" +``` + +This example changes the location description of the location specified by its location identity. + +## PARAMETERS + +### -CivicAddressId +Specifies the unique identifier of the civic address that contains the location to be modified. +Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: Guid +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: True +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 +``` + +### -City +Specifies the city of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CityAlias + +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Specifies the name of your organization. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -CompanyTaxId +The company tax ID. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confidence + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion +Specifies the country or region of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Description +Specifies an administrator defined description of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Elin +Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. + +**Note:** You can set or change the ELIN, but you can't clear its value. If you need to clear the value, you should recreate the location. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -HouseNumber +Specifies the numeric portion of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -HouseNumberSuffix +Specifies the numeric suffix of the civic address. +For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Longitude +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +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". + +```yaml +Type: String +Parameter Sets: UseLocationId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PostalCode +Specifies the postal code of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +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". + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PreDirectional +Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StateOrProvince +Specifies the state or province of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -StreetName +Specifies the street name of the civic address. + +**Note:** This parameter is not supported and will be deprecated. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +**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: True +Accept wildcard characters: False +``` + +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teans + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) + +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) + +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisPort.md b/teams/teams-ps/teams/Set-CsOnlineLisPort.md new file mode 100644 index 0000000000..39f8049001 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineLisPort.md @@ -0,0 +1,234 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineLisPort + +## SYNOPSIS +Creates a Location Information Server (LIS) port, creates an association between a port and a location, or modifies an existing port and its associated location. The association between a port and location is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + +## SYNTAX + +``` +Set-CsOnlineLisPort [-ChassisID] <string> -LocationId <guid> -PortID <string> [-Description <string>] [-Force] [-IsDebug <bool>] + [-NCSApiUrl <string>] [-TargetStore <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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 allows the administrator to map physical locations to the port through which the client is connected. + +## EXAMPLES + +### Example 1 +``` +Set-CsOnlineLisPort -PortID 12174 -ChassisID 0B-23-CD-16-AA-CC -Description "LisPort 12174" -LocationId efd7273e-3092-4a56-8541-f5c896bb6fee +``` + +Example 1 creates the association between port "12174" and LocationId "efd7273e-3092-4a56-8541-f5c896bb6fee". + +### Example 2 +``` +Set-CsOnlineLisPort -PortID 0A-25-55-AB-CD-FF -ChassisID 0B-23-CD-16-AA-CC -Description "LisPort 0A-25-55-AB-CD-FF" -LocationId efd7273e-3092-4a56-8541-f5c896bb6fee +``` + +Example 2 creates the association between port "0A-25-55-AB-CD-FF" and LocationId "efd7273e-3092-4a56-8541-f5c896bb6fee". + +### Example 3 +``` +Set-CsOnlineLisPort -PortID 12174 -ChassisID 55123 -Description "LisPort 12174" -LocationId efd7273e-3092-4a56-8541-f5c896bb6fee +``` + +Example 3 creates the association between port "12174" and LocationId "efd7273e-3092-4a56-8541-f5c896bb6fee". (Note: in this example, ChassisID sub-type is InterfaceName) + +## PARAMETERS + +### -ChassisID +If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. 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 +Default value: None +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 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the administrator defined description of the port. + +```yaml +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 +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) + +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md b/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md new file mode 100644 index 0000000000..ae42f3ce2d --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md @@ -0,0 +1,228 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineLisSubnet + +## SYNOPSIS +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. The association between a subnet and location is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + +## SYNTAX + +``` +Set-CsOnlineLisSubnet [[-TenantId] <Guid>] [-Subnet] <String> -LocationId <Guid> [-Description <String>] + [-IsDebug <Boolean>] [-TargetStore <String>] [-NCSApiUrl <String>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +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 allows the administrator to map physical locations to the subnet through which the client is connected. + +The location ID which is associating with the subnet is not required to be the existing location. + +LIS subnets must be defined by the Network ID matching the subnet IP range assigned to clients. For example, the network ID for a client IP/mask of 10.10.10.150/25 is 10.10.10.128. For more information, see [Understand TCP/IP addressing and subnetting basics](https://learn.microsoft.com/troubleshoot/windows-client/networking/tcpip-addressing-and-subnetting). + +## EXAMPLES + +### Example 1 +``` +Set-CsOnlineLisSubnet -Subnet 10.10.10.128 -LocationId f037a9ad-4334-455a-a1c5-3838ec0f5d02 -Description "Subnet 10.10.10.128" +``` + +Example 1 creates the Location Information Service subnet "10.10.10.128" associated to Location ID "f037a9ad-4334-455a-a1c5-3838ec0f5d02". + +### Example 2 +``` +Set-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e -LocationId f037a9ad-4334-455a-a1c5-3838ec0f5d02 -Description "Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e" +``` + +Example 2 creates the Location Information Service subnet in IPv6 format "2001:4898:e8:6c:90d2:28d4:76a4:ec5e" associated to Location ID "f037a9ad-4334-455a-a1c5-3838ec0f5d02". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +Specifies the unique identifier of the location to be modified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: 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 + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md b/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md new file mode 100644 index 0000000000..71e862e8a2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md @@ -0,0 +1,205 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineLisSwitch + +## SYNOPSIS +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. The association between a switch and location is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + +## SYNTAX + +``` +Set-CsOnlineLisSwitch [-ChassisID] <string> -LocationId <guid> [-Description <string>] [-Force] [-IsDebug <bool>] + [-NCSApiUrl <string>] [-TargetStore <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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 allows the administrator to map physical locations to the network switch through which the client is connected. + +## EXAMPLES + +### Example 1 +``` +Set-CsOnlineLisSwitch -ChassisID B8-BE-BF-4A-A3-00 -Description "DKSwitch1" -LocationId 9905bca0-6fb0-11ec-84a4-25019013784a +``` + +Example 1 creates a switch with Chassis ID "B8-BE-BF-4A-A3-00", and associates it with location ID 9905bca0-6fb0-11ec-84a4-25019013784a. + +## PARAMETERS + +### -ChassisID +If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -LocationId +The name for this location. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the administrator defined description of the switch. + +```yaml +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 +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) + +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md new file mode 100644 index 0000000000..75045602f9 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md @@ -0,0 +1,215 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineLisWirelessAccessPoint + +## SYNOPSIS +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. The association between a WAP and location is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + +## SYNTAX + +``` +Set-CsOnlineLisWirelessAccessPoint [-BSSID] <string> -LocationId <guid> [-Description <string>] [-Force] [-IsDebug <bool>] [-NCSApiUrl <string>] + [-TargetStore <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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 allows the administrator to map physical locations to the WAP through which calls will be routed. + +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 a range which share the same description and Location ID. The wildcard '*' can be on either the last one or two character(s). + +If a BSSID with wildcard format is already existing, the request for adding one more new BSSID which is within this wildcard range and with the same location ID will not be accepted. + +## EXAMPLES + +### Example 1 +``` +Set-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-03-23 -Description "USWAP1" -LocationId d7714269-ee52-4635-97b0-d7c228801d24 +``` + +Example 1 creates the wireless access point with BSSID "F0-6E-0B-C2-03-23", associated with location ID d7714269-ee52-4635-97b0-d7c228801d24. + +### Example 2 +``` +Set-CsOnlineLisWirelessAccessPoint -BSSID F0-6E-0B-C2-04-* -LocationId b2804a1a-e4cf-47df-8964-3eaf6fe1ae3a -Description 'SEWAPs' +``` + +Example 2 creates the wireless access point with Chassis ID "F0-6E-0B-C2-04-*", associated with location ID b2804a1a-e4cf-47df-8964-3eaf6fe1ae3a. BSSID "F0-6E-0B-C2-04-*" is in wildcard format which is equivalent to adding all BSSIDs with the same LocationID in the range "F0-6E-0B-C2-04-[0-9A-F][0-9A-F]". + +## PARAMETERS + +### -BSSID +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -LocationId +The name for this location. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the administrator defined description of the WAP. + +```yaml +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 +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDebug +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NCSApiUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) + +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md new file mode 100644 index 0000000000..aa577953e6 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md @@ -0,0 +1,429 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlinePSTNGateway + +## SYNOPSIS +Modifies the previously defined Session Border Controller (SBC) Configuration that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. + +## SYNTAX + +``` +Set-CsOnlinePSTNGateway [[-Identity] <string>] [-BypassMode <string>] [-Description <string>] [-Enabled <boolean>] + [-FailoverResponseCodes <string>] [-FailoverTimeSeconds <int>] [-ForwardCallHistory <boolean>] [-ForwardPai <boolean>] [-GatewayLbrEnabledUserOverride <boolean>] + [-GatewaySiteId <string>] [-GatewaySiteLbrEnabled <boolean>] [-InboundPstnNumberTranslationRules <Object>] [-InboundTeamsNumberTranslationRules <Object>] + [-MaxConcurrentSessions <int>] [-MediaBypass <boolean>] [-MediaRelayRoutingLocationOverride <string>] [-OutboundPstnNumberTranslationRules <Object>] + [-OutboundTeamsNumberTranslationRules <Object>] [-PidfLoSupported <boolean>] [-ProxySbc <string>] [-SendSipOptions <boolean>] [-SipSignalingPort <int>] + [-WhatIf] [-Confirm] [<CommonParameters>] + ``` + +## DESCRIPTION +Use this cmdlet to modify the configuration of the previously created Session Border Controller (SBC) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter set to $false, the SBC will continue existing calls, but all new calls routed to another SBC in a route (if exists). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsOnlinePSTNGateway -Identity sbc.contoso.com -Enabled $true +``` + +This example enables previously created SBC with Identity (and FQDN) sbc.contoso.com. All others parameters will stay default. + +### Example 2 +```powershell +PS C:\> Set-CsOnlinePSTNGateway -Identity sbc.contoso.com -SIPSignalingPort 5064 -ForwardPAI $true -Enabled $true +``` + +This example modifies the configuration of an SBC with identity (and FQDN) sbc.contoso.com. It changes the SIPSignalingPort to 5064 and enabled P-Asserted-Identity field on outbound connections (outbound from Direct Routing to SBC). For each outbound to SBC session, the Direct Routing interface will report in P-Asserted-Identity fields the TEL URI and SIP address of the user who made a call. This is useful when a tenant administrator set identity of the caller as "Anonymous" or a general number of the company, but for the billing purposes the real identity of the user should be reported. + +## PARAMETERS + +### -Description +Free-format string to describe the gateway. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverResponseCodes +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). +Please find more in "Reference" section of "Phone System Direct Routing" documentation + +Setting this parameter overwrites the default values, so if you want to include the default values, please add them to string. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: 408, 503, 504 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverTimeSeconds +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardCallHistory +Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). + +```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 +``` + +### -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). 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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewaySiteId +PSTN Gateway Site Id. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +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. + +```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 +``` + +### -GatewaySiteLbrEnabled +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +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 +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. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBypass +Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. + +```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 +``` + +### -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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: $false +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. + +```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 +``` + +### -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. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```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 +``` + +### -ProxySbc +The FQDN of the proxy SBC. Used in Local Media Optimization configurations. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) + +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) + +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md b/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md new file mode 100644 index 0000000000..549dcdcc10 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md @@ -0,0 +1,137 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlinePstnUsage + +## SYNOPSIS +Modifies a set of strings that identify the allowed online public switched telephone network (PSTN) usages. This cmdlet can be used to add usages to the list of online PSTN usages or remove usages from the list. + +## SYNTAX + +### Identity (Default) +``` +Set-CsOnlinePstnUsage [[-Identity] <string>] [-Usage <Object>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Online PSTN usages are string values that are used for call authorization. An online PSTN usage links an online voice policy to a route. The `Set-CsOnlinePstnUsage` cmdlet is used to add or remove phone usages to or from the usage list. This list is global so it can be used by policies and routes throughout the tenant. + +This cmdlet is used when configuring Microsoft Phone System Direct Routing. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{remove="Local"} +``` + +This command removes the string "Local" from the list of available PSTN usages. + +### -------------------------- 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 -------------------------- +``` +PS C:\> Set-CsOnlinePstnUsage -Usage @{replace="International","Restricted"} +``` + +This command replaces everything in the usage list with the values International and Restricted. All previously existing usages are 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 +``` + +### -Identity +The scope at which these settings are applied. The Identity for this cmdlet is always Global. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Usage +Contains a list of allowable usage strings. These entries can be any string value. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage) diff --git a/teams/teams-ps/teams/Set-CsOnlineSchedule.md b/teams/teams-ps/teams/Set-CsOnlineSchedule.md new file mode 100644 index 0000000000..7f4392b0fa --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineSchedule.md @@ -0,0 +1,108 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsOnlineSchedule + +## SYNOPSIS +Use the Set-CsOnlineSchedule cmdlet to update a schedule. + +## SYNTAX +```powershell +Set-CsOnlineSchedule -Instance <Object> [-Tenant <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-CsOnlineSchedule cmdlet lets you modify the properties of a schedule. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +$schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" +$schedule.Name = "Christmas Holiday" +Set-CsOnlineSchedule -Instance $schedule +``` + +This example modifies the name of the schedule that has a Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. + +### -------------------------- Example 2 -------------------------- +```powershell +$schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" + +$schedule + + Id : 5d3e0315-533b-473d-8524-36c954d1fc93 + Name : Thanksgiving + Type : Fixed + WeeklyRecurrentSchedule : + FixedSchedule : 22/11/2018 00:00 - 23/11/2018 00:00, 28/11/2019 00:00 - 29/11/2019 00:00, 26/11/2020 00:00 - 27/11/2020 00:00 + +# Add a new Date Time Range +$schedule.FixedSchedule.DateTimeRanges += New-CsOnlineDateTimeRange -Start "25/11/2021" -End "26/11/2021" + +Set-CsOnlineSchedule -Instance $schedule +``` + +This example updates an existing holiday schedule, adding a new date/time range to it. + +## PARAMETERS + +### -Instance +The Instance parameter is the object reference to the schedule to be modified. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule +The modified instance of the `Microsoft.Rtc.Management.Hosted.Online.Models.Schedule` object. + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) + +[Remove-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md b/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md new file mode 100644 index 0000000000..f62687992e --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceapplicationinstance +applicable: Microsoft Teams +title: Set-CsOnlineVoiceApplicationInstance +ms.reviewer: +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +--- + +# Set-CsOnlineVoiceApplicationInstance + +## SYNOPSIS +The `Set-CsOnlineVoiceApplicationInstance` modifies an application instance in Microsoft Entra ID. + +**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + +## SYNTAX +``` +Set-CsOnlineVoiceApplicationInstance [[-Identity] <String>] + [-Confirm] + [-DomainController <Fqdn>] + [-Force] + [-TelephoneNumber <String>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is used to modify an application instance in Microsoft Entra ID. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsOnlineVoiceApplicationInstance -Identity testra1@contoso.com -TelephoneNumber +14255550100 +``` + +This example sets a phone number to the resource account testra1@contoso.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: DC + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user principal name (UPN) of the resource account in Microsoft Entra ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber +The phone number to be assigned to the resource account. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md new file mode 100644 index 0000000000..e88a324e6f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md @@ -0,0 +1,221 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsOnlineVoiceRoute + +## SYNOPSIS +Modifies an online voice route. Online voice routes contain instructions that tell Microsoft Teams how to route calls from Microsoft or Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). + +## SYNTAX + +### Identity +``` +Set-CsOnlineVoiceRoute [-BridgeSourcePhoneNumber <String>] [-Description <String>] [[-Identity] <String>] + [-NumberPattern <String>] [-OnlinePstnGatewayList <Object>] [-OnlinePstnUsages <Object>] [-Priority <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to modify an existing online voice route. Online voice routes are associated with online voice policies through online public switched telephone network (PSTN) usages. A online voice route includes a regular expression that identifies which phone numbers will be routed through a given voice route: phone numbers matching the regular expression will be routed through this route. + +This cmdlet is used when configuring Microsoft Phone System Direct Routing. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +PS C:\> $x = (Get-CsOnlinePstnUsage).Usage + +PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{replace=$x} +``` + +This example modifies the online voice route named Route1 to populate that route's list of online PSTN usages with all the existing usages for the organization. The first command in this example retrieves the list of global online PSTN usages. Notice that the call to the `Get-CsOnlinePstnUsage` cmdlet is in parentheses; this means that we first retrieve an object containing PSTN usage information. (Because there is only one--global--PSTN usage, only one object will be retrieved.) The command then retrieves the Usage property of this object. That property, which contains a list of online PSTN usages, is assigned to the variable $x. In the second line of this example, the Set-CsOnlineVoiceRoute cmdlet is called to modify the online voice route with the identity Route1. Notice the value passed to the OnlinePstnUsages parameter: @{replace=$x}. This value says to replace everything in the OnlinePstnUsages list for this route with the contents of $x, which contain the online PSTN usages list retrieved in line 1. + +## PARAMETERS + +### -BridgeSourcePhoneNumber +BridgeSourcePhoneNumber is an E.164 formatted Operator Connect Conferencing phone number assigned to your Audio Conferencing Bridge. Using BridgeSourcePhoneNumber in an online voice route is mutually exclusive with using OnlinePstnGatewayList in the same online voice route. + +When using BridgeSourcePhoneNumber in an online voice route, the OnlinePstnUsages used in the online voice route should only be used in a corresponding OnlineAudioConferencingRoutingPolicy. The same OnlinePstnUsages should not be used in online voice routes that are not using BridgeSourcePhoneNumber. + +For more information about Operator Connect Conferencing, please see [Configure Operator Connect Conferencing](https://learn.microsoft.com/microsoftteams/operator-connect-conferencing-configure). + +```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 +A description of what this phone route is for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identity of the online voice route. (If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberPattern +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnGatewayList +This parameter contains a list of online gateways associated with this online voice route. Each member of this list must be the service Identity of the online PSTN gateway. The service Identity is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, redmondpool.litwareinc.com. + +By default this list is empty. However, if you leave this parameter blank when creating a new voice route, you'll receive a warning message. + +```yaml +Type: PSListModifier +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, Long Distance, etc.) that can be applied to this online voice route. The PSTN usage must be an existing usage (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +By default this list is empty. However, if you leave this parameter blank when creating a new online voice route, you'll receive a warning message. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +A number could resolve to multiple online voice routes. The priority determines the order in which the routes will be applied if more than one route is possible. The lowest priority will be applied first and then in ascendant order. + +```yaml +Type: 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: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) + +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) + +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md new file mode 100644 index 0000000000..c541ead593 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md @@ -0,0 +1,174 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineVoiceRoutingPolicy + +## SYNOPSIS +Modifies an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsOnlineVoiceRoutingPolicy [[-Identity] <string>] [-Description <string>] + [-OnlinePstnUsages <Object>] [-RouteType <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Online voice routing policies are used in Microsoft Phone System Direct Routing scenarios. Assigning your Teams users an online voice routing policy enables those users to receive and to place phone calls to the public switched telephone network by using your on-premises SIP trunks. + +Note that simply assigning a user an online voice routing policy will not enable them to make PSTN calls via Teams. Among other things, you will also need to enable those users for Phone System and will need to assign them an appropriate online voice policy. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +PS C:\> Set-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Local"} | Set-CsOnlineVoiceRoutingPolicy -OnlinePstnUsages @{Remove="Local"} +``` + +Example 3 removes the online PSTN usage "Local" from all the online voice routing policies that include that usage. In order to do this, the command first calls the `Get-CsOnlineVoiceRoutingPolicy` cmdlet without any parameters in order to return a collection of all the available online voice routing policies. That collection is then piped to the Where-Object cmdlet, which picks out only those policies where the OnlinePstnUsages property includes (-contains) the "Local" usage. Those policies are then piped to the `Set-CsOnlineVoiceRoutingPolicy` cmdlet, which deletes the Local usage from each 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 +Enables administrators to provide explanatory text to accompany an online 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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. Online voice routing policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: + +-Identity global + +To refer to a per-user policy, use syntax similar to this: + +-Identity "RedmondOnlineVoiceRoutingPolicy" + +If you do not specify an Identity, then the `Set-CsOnlineVoiceRoutingPolicy` cmdlet will modify the global policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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 voice routing policy. The online PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsOnlinePstnUsage` cmdlet.) + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) + +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) + +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) + +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md b/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md new file mode 100644 index 0000000000..d7f09686d0 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md @@ -0,0 +1,202 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineVoiceUser + +## 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 + +``` +Set-CsOnlineVoiceUser [-Identity] <UserIdParameter> [-Tenant <Guid>] [-TelephoneNumber <String>] + [-LocationID <Guid>] [-DomainController <Fqdn>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +Set-CsOnlineVoiceUser -Identity user@domain.com -TelephoneNumber $null +``` + +This example removes the telephone number for a user identified by the user's SIP address. + +## 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 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +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: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationID +Specifies the unique identifier of the emergency location to assign to the user. +Location identities can be discovered by using the `Get-CsOnlineLisLocation` cmdlet. + +This parameter is required for users based in the US. + +```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 +``` + +### -TelephoneNumber +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf parameter is not implemented for this cmdlet. + +```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/Set-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md new file mode 100644 index 0000000000..e5f0a4f436 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md @@ -0,0 +1,311 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineVoicemailPolicy + +## SYNOPSIS +Modifies an existing Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsOnlineVoicemailPolicy [[-Identity] <string>] [-Description <String>] [-EnableEditingCallAnswerRulesSetting <boolean>] [-EnableTranscription <boolean>] +[-EnableTranscriptionProfanityMasking <boolean>] [-EnableTranscriptionTranslation <boolean>] [-MaximumRecordingLength <timespan>] +[-PostambleAudioFile <string>] [-PostambleAudioFile <string>] [-PreamblePostambleMandatory <boolean>] +[-PrimarySystemPromptLanguage <string>] [-SecondarySystemPromptLanguage <string>] [-ShareData <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. + +By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. + +- Voicemail transcription is enabled by default +- Transcription profanity masking is disabled by default +- Transcription translation is enabled by default +- Editing call answer rule settings is enabled by default +- Voicemail maximum recording length is set to 5 minutes by default +- Primary and secondary system prompt languages are set to null by default and the user's voicemail language setting is used + +Tenant admin would be able to create a customized online voicemail policy to match the organization's requirements. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +Set-CsOnlineVoicemailPolicy -EnableTranscriptionProfanityMasking $false +``` + +The command shown in Example 2 changes the EnableTranscriptionProfanityMasking to false for tenant level global online voicemail policy when calling without Identity parameter. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEditingCallAnswerRulesSetting +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTranscription +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTranscriptionProfanityMasking +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTranscriptionTranslation +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumRecordingLength +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostambleAudioFile +The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -PreambleAudioFile +The audio file to play to the caller before the user's voicemail greeting is played. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreamblePostambleMandatory +Is playing the Pre- or Post-amble mandatory before the caller can leave a message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimarySystemPromptLanguage +The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareData +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) + +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) + +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) + +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md new file mode 100644 index 0000000000..679bea74c8 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md @@ -0,0 +1,360 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineVoicemailUserSettings + +## SYNOPSIS +Use the Set-CsOnlineVoicemailUserSettings cmdlet to modify the online voicemail user settings of a specific user. +New online voicemail user settings of the user would be returned after executing. + +## SYNTAX + +``` +Set-CsOnlineVoicemailUserSettings [-Identity] <string> [-CallAnswerRule <Object>] [-DefaultGreetingPromptOverwrite <string>] +[-DefaultOofGreetingPromptOverwrite <string>] [-Force] [-OofGreetingEnabled <boolean>] [-OofGreetingFollowAutomaticRepliesEnabled <boolean>] +[-OofGreetingFollowCalendarEnabled <boolean>] [-PromptLanguage <string>] [-ShareData <boolean>] [-TransferTarget <string>] +[-VoicemailEnabled <boolean>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-CsOnlineVoicemailUserSettings cmdlet lets tenant admin modify the online voicemail user settings of a specific user in the organization. New online voicemail user settings of the user would be returned after executing. +For example, tenant admin could enable/disable voicemail, change voicemail prompt language, modify out-of-office voicemail greeting settings, or setup simple call answer rules. Only those properties that tenant admin have actually provided with be modified. If an online voicemail user setting was not set by tenant admin, it would remain the old value after this cmdlet has been executed. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +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 -------------------------- +``` +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 -------------------------- +``` +Set-CsOnlineVoicemailUserSettings -Identity user6@contoso.com -DefaultGreetingPromptOverwrite "Hi, I am currently not available." +``` + +This example changes DefaultGreetingPromptOverwrite setting to "Hi, I am currently not available." for user6@contoso.com. + +## 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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallAnswerRule +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: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultGreetingPromptOverwrite +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOofGreetingPromptOverwrite +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +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 +``` + +### -OofGreetingEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OofGreetingFollowAutomaticRepliesEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PromptLanguage +The PromptLanguage parameter represents the language that is used to play voicemail prompts. + +The following languages are supported: + +- "ar-EG" (Arabic - Egypt) +- "ar-SA" (Arabic - Saudi Arabia) +- "bg-BG" (Bulgarian - Bulgaria) +- "ca-ES" (Catalan - Catalan) +- "cy-GB" (Welsh - United Kingdom) +- "cs-CZ" (Czech - Czech Republic) +- "da-DK" (Danish - Denmark) +- "de-AT" (German - Austria) +- "de-CH" (German - Switzerland) +- "de-DE" (German - Germany) +- "el-GR" (Greek - Greece) +- "en-AU" (English - Australia) +- "en-CA" (English - Canada) +- "en-GB" (English - United Kingdom) +- "en-IE" (English - Ireland) +- "en-IN" (English - India) +- "en-PH" (English - Philippines) +- "en-US" (English - United States) +- "en-ZA" (English - South Africa) +- "es-ES" (Spanish - Spain) +- "es-MX" (Spanish - Mexico) +- "et-EE" (Estonian - Estonia) +- "fi-FI" (Finnish - Finland) +- "fr-BE" (French - Belgium) +- "fr-CA" (French - Canada) +- "fr-CH" (French - Switzerland) +- "fr-FR" (French - France) +- "he-IL" (Hebrew - Israel) +- "hi-IN" (Hindi - India) +- "hr-HR" (Croatian - Croatia) +- "hu-HU" (Hungarian - Hungary) +- "id-ID" (Indonesian - Indonesia) +- "it-IT" (Italian - Italy) +- "ja-JP" (Japanese - Japan) +- "ko-KR" (Korean - Korea) +- "lt-LT" (Lithuanian - Lithuania) +- "lv-LV" (Latvian - Latvia) +- "nl-BE" (Dutch - Belgium) +- "nl-NL" (Dutch - Netherlands) +- "nb-NO" (Norwegian, Bokmål - Norway) +- "pl-PL" (Polish - Poland) +- "pt-BR" (Portuguese - Brazil) +- "pt-PT" (Portuguese - Portugal) +- "ro-RO" (Romanian - Romania) +- "ru-RU" (Russian - Russia) +- "sk-SK" (Slovak - Slovakia) +- "sl-SI" (Slovenian - Slovenia) +- "sv-SE" (Swedish - Sweden) +- "th-TH" (Thai - Thailand) +- "tr-TR" (Turkish - Turkey) +- "vi-VN" (Vietnamese - Viet Nam) +- "zh-CN" (Chinese - Simplified, PRC) +- "zh-TW" (Chinese - Traditional, Taiwan) +- "zh-HK" (Chinese - Traditional, Hong Kong S.A.R.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareData +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransferTarget +The TransferTarget parameter represents the target to transfer the call when call answer rule set to PromptOnlyWithTransfer or VoicemailWithTransferOption. +Value of this parameter should be a SIP URI of another user in your organization. +For user with Enterprise Voice enabled, a valid telephone number could also be accepted as TransferTarget. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoicemailEnabled +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md new file mode 100644 index 0000000000..4ef22599c9 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -0,0 +1,330 @@ +--- +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 <string> -LocationId <string> [<CommonParameters>] +``` + +### NetworkSiteUpdate +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber <string> -NetworkSiteId <string> [<CommonParameters>] +``` + +### Assignment +```powershell +Set-CsPhoneNumberAssignment -Identity <String> -PhoneNumber <String> -PhoneNumberType <String> + [-LocationId <String>] [-NetworkSiteId <string>] [-AssignmentCategory <string>] [<CommonParameters>] +``` + +### Attribute +```powershell +Set-CsPhoneNumberAssignment -Identity <String> -EnterpriseVoiceEnabled <Boolean> [<CommonParameters>] +``` + +### ReverseNumberLookup +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber <string> -ReverseNumberLookup <string> [<CommonParameters>] +``` + +### Notify +```powershell +Set-CsPhoneNumberAssignment -Identity <string> -PhoneNumber <string> -PhoneNumberType <String> -Notify [<CommonParameters>] +``` + +## 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. + +### Example 12 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private +``` +This example shows how to assign a private phone number (incoming calls only) to a user. +### Example 13 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify +``` +This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. + +## PARAMETERS + +### -AssignmentCategory +This parameter indicates the phone number assignment category if it isn't the primary phone number. For example, a Private line can be assigned to a user using '-AssignmentCategory Private'. + +```yaml +Type: System.String +Parameter Sets: (Assignment) +Aliases: +Applicable: Microsoft Teams + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceEnabled +Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. + +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 +``` + +### -Notify +Sends an email to Teams phone user about new telephone number assignment. + +```yaml +Type: Switch +Parameter Sets: (Assignment) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberTag.md b/teams/teams-ps/teams/Set-CsPhoneNumberTag.md new file mode 100644 index 0000000000..c571a93910 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsPhoneNumberTag.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumbertag +applicable: Microsoft Teams +title: Set-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Set-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows the admin to create and assign a tag to a phone number. + +## SYNTAX + +``` +Set-CsPhoneNumberTag -PhoneNumber <String> -Tag <String> [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet allows telephone number administrators to create and assign tags to phone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. Each phone number can have up to 50 tags assigned. To improve readability, it is recommended to avoid assigning too many tags to a single phone number. If the desired tag already exist, the telephone number will get assigned the existing tag. If the tag is not already available, a new tag will be created. [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag) can be used to check a list of already existing tags. The tags can be used as a filter for [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) to filter on certain list. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR" +``` +Above example shows how to set a "HR" tag to +123456789 number. + +## PARAMETERS + +### -PhoneNumber +Indicates the phone number for the the tag to be assigned + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Indicates the tag to be assigned or created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..5cd82bcea2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: Set-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +Set-CsSharedCallQueueHistoryTemplate -Instance <instance> [<CommonParameters>] +``` + +## DESCRIPTION +Use the Set-SharedCallQueueHistory cmdlet to change a Shared Call Queue History template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$SharedCQHistory = Get-CsSharedCallQueueHistory -Id 66f0dc32-d344-4bb1-b524-027d4635515c +$SharedCQHisotry.AnsweredAndOutboundCalls = "AuthorizedUsersAndAgents" +Set-CsSharedCallQueueHistoryTemplate -Instance $SharedCQHistory +``` + +This example sets the AnsweredOutboundCalls value in the Shared Call History Template with the Id `66f0dc32-d344-4bb1-b524-027d4635515c` + +## PARAMETERS + +### -Instance +The instance of the shared call queue history template to change. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsSharedCallQueueHistoryTemplate](./New-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsSharedCallQueueHistoryTemplate](./Get-CsSharedCallQueueHistoryTemplate.md) + +[Remove-CsSharedCallQueueHistoryTemplate](./Remove-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..2c43c43e51 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Set-CsTeamsAIPolicy + +## SYNOPSIS + +This cmdlet sets Teams AI policy value for users in the tenant. + +## SYNTAX + +```powershell +Set-CsTeamsAIPolicy [[-Identity] <string>] + [-EnrollFace <string>] + [-EnrollVoice <string>] + [-SpeakerAttributionBYOD <string>] + [-Description <string>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet sets the EnrollFace, EnrollVoice, and SpeakerAttributionBYOD values within the csTeamsAIPolicy. These policies can be assigned to users, and each setting can be configured as "Enabled" or "Disabled". " + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Global -EnrollFace Disabled +``` + +Set Teams AI policy "EnrollFace" value to "Disabled" for global as default. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Global -EnrollVoice Disabled +``` + +Set Teams AI policy "EnrollVoice" value to "Disabled" for global as default. + +### Example 3 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Global -SpeakerAttributionBYOD Disabled +``` + +Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for global as default. + +### Example 4 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollFace Enabled +``` + +Set Teams AI policy "EnrollFace" value to "Enabled" for identity "Test". + +### Example 5 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollVoice Enabled +``` + +Set Teams AI policy "EnrollVoice" value to "Enabled" for identity "Test". + +### Example 6 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -SpeakerAttributionBYOD Enabled +``` + +Set Teams AI policy "SpeakerAttributionBYOD" value to "Enabled" for identity "Test". + +### Example 7 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollFace Disabled +``` + +Set Teams AI policy "EnrollFace" value to "Disabled" for identity "Test". + +### Example 8 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollVoice Disabled +``` + +Set Teams AI policy "EnrollVoice" value to "Disabled" for identity "Test". + +### Example 9 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -SpeakerAttributionBYOD Disabled +``` + +Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for identity "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollFace +Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollVoice +Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md new file mode 100644 index 0000000000..d5d3e1c8a6 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsAcsFederationConfiguration +author: tomkau +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsAcsFederationConfiguration + +## SYNOPSIS + +This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. For more information, please see [Azure Communication Services and Teams Interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). + +## SYNTAX + +```powershell +Set-CsTeamsAcsFederationConfiguration + [-Identity <String[]>] + [-EnableAcsUsers <Boolean>] + [-AllowedAcsResources <String[]>] + [-WhatIf] + [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +Federation between Teams and Azure Communication Services (ACS) allows external users from ACS to connect and communicate with Teams users over voice and video. These custom applications may be used by end users or by bots, and there is no differentiation in how they appear to Teams users unless the developer of the application explicitly indicates this as part of the communication. For more information, see [Teams interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). + +This cmdlet is used to enable or disable Teams and ACS federation for a Teams tenant, and to specify which ACS resources can connect to Teams. Only listed ACS resources can be allowed. + +You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. + +## EXAMPLES + +### Example 1 +In this example, federation between Teams and ACS is disabled completely. + +```powershell +Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $False +``` + +### Example 2 +In this example, federation is enabled for just one ACS resource. + +```powershell +$allowlist = @('faced04c-2ced-433d-90db-063e424b87b1') +Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources $allowlist +``` + +## PARAMETERS + +### -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 +``` + +### -AllowedAcsResources + +The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. + +The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. + +```yaml +Type: String[] +Position: Named +Default value: Empty/Null +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the collection of tenant federation configuration settings to be modified. Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the Set-CsTenantFederationConfiguration cmdlet. If you do choose to use the Identity parameter, you must also include the Tenant parameter. For example: + +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md new file mode 100644 index 0000000000..58ff1553f7 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md @@ -0,0 +1,319 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Set-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +author: serdarsoysal +ms.author: serdars +--- + +# Set-CsTeamsAppPermissionPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies> and about app centric management at <https://learn.microsoft.com/microsoftteams/app-centric-management>. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsAppPermissionPolicy [-Tenant <System.Guid>] [-DefaultCatalogApps <>] [-GlobalCatalogApps <>] + [-PrivateCatalogApps <>] [-Description <String>] [-DefaultCatalogAppsType <String>] + [-GlobalCatalogAppsType <String>] [-PrivateCatalogAppsType <String>] [[-Identity] <XdsIdentity>] [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsAppPermissionPolicy [-Tenant <System.Guid>] [-DefaultCatalogApps <>] [-GlobalCatalogApps <>] + [-PrivateCatalogApps <>] [-Description <String>] [-DefaultCatalogAppsType <String>] + [-GlobalCatalogAppsType <String>] [-PrivateCatalogAppsType <String>] [-Instance <PSObject>] [-Force] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/microsoftteams/teams-app-permission-policies>. + +## EXAMPLES + +### Example 1 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppPermissionPolicy -Identity Set-$identity +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -DefaultCatalogApps @()-GlobalCatalogAppsType -GlobalCatalogApps @() BlockedAppList -PrivateCatalogAppsType BlockedAppList -PrivateCatalogApps @() +``` +This example allows all Microsoft apps, third-party apps, and custom apps. No apps are blocked. + +### Example 2 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppPermissionPolicy -Identity Set-$identity +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps @() -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps @() +``` +This example blocks all Microsoft apps, third-party apps, and custom apps. No apps are allowed. + +### Example 3 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -GlobalCatalogAppsType AllowedAppList -PrivateCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() + +$ListsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp -Property @{Id="0d820ecd-def2-4297-adad-78056cde7c78"} +$OneNoteApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp -Property @{Id="26bc2873-6023-480c-a11b-76b66605ce8c"} +$DefaultCatalogAppList = @($ListsApp,$OneNoteApp) +# set allow Lists and OneNote apps and block other Microsoft apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps $DefaultCatalogAppList +``` +This example allows Microsoft Lists and OneNote apps and blocks other Microsoft apps. Microsoft Lists and OneNote can be installed by your users. + +### Example 4 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -GlobalCatalogAppsType AllowedAppList -PrivateCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() +$TaskListApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp -Property @{Id="57c81e84-9b7b-4783-be4e-0b7ffc0719af"} +$OnePlanApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp -Property @{Id="ca0540bf-6b61-3027-6313-a7cb4470bf1b"} +$GlobalCatalogAppList = @($TaskListApp,$OnePlanApp) +# set allow TaskList and OnePlan apps and block other Third-party apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps $GlobalCatalogAppList +``` +This example allows third-party TaskList and OnePlan apps and blocks other third-party apps. TaskList and OnePlan can be installed by your users. + +### Example 5 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -GlobalCatalogAppsType BlockedAppList -PrivateCatalogAppsType BlockedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() +$GetStartApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp -Property @{Id="f8374f94-b179-4cd2-8343-9514dc5ea377"} +$TestBotApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp -Property @{Id="47fa3584-9366-4ce7-b1eb-07326c6ba799"} +$PrivateCatalogAppList = @($GetStartApp,$TestBotApp) +# set allow TaskList and OnePlan apps and block other custom apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps $PrivateCatalogAppList +``` +This example allows custom GetStartApp and TestBotApp apps and blocks other custom apps. GetStartApp and TestBotApp can be installed by your users. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultCatalogApps +Choose which Teams apps published by Microsoft or its partners can be installed by your users. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultCatalogAppsType +Choose to allow or block the installation of Microsoft apps. Values that can be used: AllowedAppList, BlockedAppList. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of app setup permission policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalCatalogApps +Choose which Teams apps published by a third party can be installed by your users. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalCatalogAppsType +Choose to allow or block the installation of third-party apps. Values that can be used: AllowedAppList, BlockedAppList. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of App setup permission policy. If empty, all Identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateCatalogApps +Choose to allow or block the installation of custom apps. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCatalogAppsType +Choose which custom apps can be installed by your users. Values that can be used: AllowedAppList, BlockedAppList. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..1e6e8b5c3a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsappsetuppolicy +applicable: Microsoft Teams +title: Set-CsTeamsAppSetupPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsAppSetupPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. + +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsAppSetupPolicy [[-Identity] <XdsIdentity>] + [-AllowSideLoading <Boolean>] + [-AllowUserPinning <Boolean>] + [-AppPresetList <Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[]>] + [-Confirm] + [-Description <String>] + [-Force] + [-PinnedAppBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[]>] + [-PinnedCallingBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[]>] + [-PinnedMessageBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[]>] + [-AppPresetMeetingList <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting]>] + [-AdditionalCustomizationApps <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp]>] + [-Tenant <System.Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +### Instance +```powershell +Set-CsTeamsAppSetupPolicy [-Instance <PSObject>] + [-AllowSideLoading <Boolean>] + [-AllowUserPinning <Boolean>] + [-AppPresetList <Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[]>] + [-Confirm] + [-Description <String>] + [-Force] + [-PinnedAppBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[]>] + [-PinnedCallingBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[]>] + [-PinnedMessageBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[]>] + [-AppPresetMeetingList <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting]>] + [-AdditionalCustomizationApps <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp]>] + [-Tenant <System.Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## EXAMPLES + +### Example 1 + +```powershell +# Create new teams app setup policy named "Set-Test". +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AllowUserPinning $true -AllowSideLoading $false +``` + +Step 1: Create a new Teams app setup policy named "Set-Test". +Step 2: Set AllowUserPinning as true, AllowSideLoading as false. + +### Example 2 + +```powershell +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} +$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} +$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} +$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedAppBarApps $PinnedAppBarApps +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps. +Step 3: Settings to pin these apps to the app bar in Teams client. + +### Example 3 + +```powershell +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$PinnedMessageBarApps = @($VivaConnectionsApp) +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedMessageBarApps $PinnedMessageBarApps +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set VivaConnectionsApp as PinnedAppBarApps. +Step 3: Settings to pin these apps to the messaging extension in Teams client. + +### Example 4 + +```powershell +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$AppPresetList = @($VivaConnectionsApp) +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AppPresetList $AppPresetList +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set VivaConnectionsApp as AppPresetList +Step 3: Settings to install these apps in your users' personal Teams environment. + +## PARAMETERS + +### -Identity +Name of app setup policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AllowSideLoading +This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your organization without having to submit it to the Teams app store. Uploading a custom app also lets you test an app before you distribute it more widely by only assigning it to a single user or group of users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserPinning +If you turn this on, the user's existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user's existing app pins will be removed and replaced with the apps defined in this policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetList +Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetMeetingList +This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of App setup policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that users need the most and promote ease of access. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedMessageBarApps +Apps will be pinned in messaging extensions and into the ellipsis menu. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md new file mode 100644 index 0000000000..aee67a3709 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md @@ -0,0 +1,174 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy +title: Set-CsTeamsAudioConferencingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsAudioConferencingPolicy + +## SYNOPSIS + +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. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsAudioConferencingPolicy [-AllowTollFreeDialin <Boolean>] [-Force] [[-Identity] <String>] + [-MeetingInvitePhoneNumbers <Object>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsAudioConferencingPolicy [-AllowTollFreeDialin <Boolean>] [-Force] + [-MeetingInvitePhoneNumbers <Object>] [-Instance <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-CsTeamsAudioConferencingPolicy cmdlet enables administrators to control audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. The Set-CsTeamsAudioConferencingPolicy can be used to update an audio-conferencing policy that has been configured for use in your organization. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Set-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $False +``` + +In this example, AllowTollFreeDialin is set to false. All other policy properties will be left as previously assigned. + +### EXAMPLE 2 +``` +PS C:\> Set-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $True -MeetingInvitePhoneNumbers "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ" +``` + +In this example, two different property values are configured: AllowTollFreeDialIn is set to True and -MeetingInvitePhoneNumbers is set to include the following Toll and Toll free numbers - "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ" other policy properties will be left as previously assigned. + +## PARAMETERS + +### -AllowTollFreeDialin +Determines if users of this Policy can have Toll free numbers. 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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 +``` + +### -Identity +Unique identifier for the policy to be Set. To set the global policy, use this syntax: -Identity global. To set a per-user policy use syntax similar to this: -Identity "Emea Users". +If this parameter is not included, the Set-CsTeamsAudioConferencingPolicy cmdlet will modify the Global policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MeetingInvitePhoneNumbers +Determines the list of audio-conferencing Toll- and Toll-free telephone numbers that will be included in meetings invites created by users of this policy. If no phone numbers are specified, then the phone number that is displayed in meeting invites created by users would be based on the location of the users. + +```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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PSObject +## OUTPUTS + +### Object +## NOTES + +## RELATED LINKS + +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) + +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) + +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md new file mode 100644 index 0000000000..27aaba2f36 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy +applicable: Microsoft Teams +title: Set-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Set-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Modifies an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCallHoldPolicy [-Identity] <string> [-Description <string>] [-AudioFileId <string>] [-StreamingSourceUrl <string>] [-StreamingSourceAuthType <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. + +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -AudioFileId "c65233-ac2a27-98701b-123ccc" +``` + +The command shown in Example 1 modifies an existing per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. + +This policy is re-assigned the audio file ID to be used to: c65233-ac2a27-98701b-123ccc, which is the ID referencing an audio file that was uploaded using the Import-CsOnlineAudioFile cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their call holds customized such that the user being held will hear the audio file specified by AudioFileId. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -Description "country music" +``` + +The command shown in Example 2 modifies an existing per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. + +This policy is re-assigned the description from its existing value to "country music". + +## PARAMETERS + +### -Identity +Unique identifier of the Teams call hold policy being modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams call hold policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceAuthType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md new file mode 100644 index 0000000000..14c75e129a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md @@ -0,0 +1,267 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +```powershell +Set-CsTeamsCallParkPolicy [-AllowCallPark <Boolean>] [-Description <String>] [[-Identity] <String>] + [-ParkTimeoutSeconds <Int64>] [-PickupRangeEnd <Int64>] [-PickupRangeStart <Int64>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Identity (Default) +```powershell +Set-CsTeamsCallParkPolicy [-Tenant <System.Guid>] [-AllowCallPark <Boolean>] [-PickupRangeStart <Integer>] [-PickupRangeEnd <Integer>] [-ParkTimeoutSeconds <Integer>] [[-Identity] <XdsIdentity>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +```powershell +Set-CsTeamsCallParkPolicy [-Tenant <System.Guid>] [-AllowCallPark <Boolean>] [-Instance <PSObject>] [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsCallParkPolicy -Identity SalesPolicy -AllowCallPark $true +``` + +Update the existing policy "SalesPolicy" to enable the call park feature. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsCallParkPolicy -Identity "SalesPolicy" -PickupRangeStart 500 -PickupRangeEnd 1500 +``` + +Update the existing policy "SalesPolicy" to generate pickup numbers starting from 500 and up until 1500. + +### Example 3 +```powershell +PS C:\> New-CsTeamsCallParkPolicy -Identity "SalesPolicy" -ParkTimeoutSeconds 600 +``` + +Update the existing policy "SalesPolicy" to ring back the parker after 600 seconds if the parked call is unanswered + +## PARAMETERS + +### -AllowCallPark +If set to true, customers will be able to leverage the call park feature to place calls on hold and then decide how the call should be handled - transferred to another department, retrieved using the same phone, or retrieved using a different phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the policy being updated. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +This parameter is used when piping a specific policy retrieved from Get-CsTeamsCallParkPolicy that you then want to update. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 99 +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). + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 300 +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. + +Note: PickupRangeStart must be smaller than PickupRangeEnd. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 10 +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 +``` + +### -MsftInternalProcessingMode +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..1f3a0f0fe7 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md @@ -0,0 +1,738 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsCallingPolicy +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: alejandramu +--- + +# Set-CsTeamsCallingPolicy + +## SYNOPSIS +Use this cmdlet to update values in existing Teams Calling Policies. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsCallingPolicy [-Identity] <string> + [-AIInterpreter <string>] + [-AllowCallForwardingToPhone <boolean>] + [-AllowCallForwardingToUser <boolean>] + [-AllowCallGroups <boolean>] + [-AllowCallRedirect <string>] + [-AllowCloudRecordingForCalls <boolean>] + [-AllowDelegation <boolean>] + [-AllowPrivateCalling <boolean>] + [-AllowSIPDevicesCalling <boolean>] + [-AllowTranscriptionForCalling <boolean>] + [-AllowVoicemail <string>] + [-AllowWebPSTNCalling <boolean>] + [-AutoAnswerEnabledType <String>] + [-BusyOnBusyEnabledType <string>] + [-CallRecordingExpirationDays <long>] + [-CallingSpendUserLimit <long>] + [-Confirm] + [-Copilot <string>] + [-EnableSpendLimits <boolean>] + [-EnableWebPstnMediaBypass <Boolean>] + [-Force] + [-InboundFederatedCallRoutingTreatment <string>] + [-InboundPstnCallRoutingTreatment <string>] + [-LiveCaptionsEnabledTypeForCalling <string>] + [-MusicOnHoldEnabledType <string>] + [-PopoutAppPathForIncomingPstnCalls <string>] + [-PopoutForIncomingPstnCalls <string>] + [-PreventTollBypass <boolean>] + [-SpamFilteringEnabledType <string>] + [-VoiceSimulationInInterpreter <string>] + [-RealTimeText <string>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to set values in +a given Calling Policy instance. + +Only the parameters specified are changed. Other parameters keep their existing values. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Set-CsTeamsCallingPolicy -Identity Global -AllowPrivateCalling $true +``` + +Sets the value of the parameter AllowPrivateCalling in the Global (default) Teams Calling Policy instance. + +### Example 2 +``` +PS C:\> Set-CsTeamsCallingPolicy -Identity HRPolicy -LiveCaptionsEnabledTypeForCalling Disabled +``` + +Sets the value of the parameter LiveCaptionsEnabledTypeForCalling to Disabled in the Teams Calling Policy instance called HRPolicy. + +## PARAMETERS + +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToPhone +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToUser +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallGroups +Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallRedirect +Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. + +Valid options are: + +- Enabled: Enables the user to redirect an incoming call. +- Disabled: The user is not enabled to redirect an incoming call. +- UserOverride: This option is not available for use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecordingForCalls +Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDelegation +Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateCalling +Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. +If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSIPDevicesCalling +Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscriptionForCalling +Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVoicemail +Enables inbound calls to be routed to voicemail. + +Valid options are: + +- AlwaysEnabled: Calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user. +- AlwaysDisabled: Calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams. +- UserOverride: Calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebPSTNCalling +Allows PSTN calling from the Teams web client. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAnswerEnabledType + +Allow admins to enable or disable Auto-answer settings for users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BusyOnBusyEnabledType +Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. + +Valid options are: + +- Enabled: New or incoming calls will be rejected with a busy signal. +- Unanswered: The user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. +- Disabled: New or incoming calls will be presented to the user. +- UserOverride: Users can set their busy options directly from call settings in Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallingSpendUserLimit +The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. + +Possible values: any positive integer + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallRecordingExpirationDays +Sets the expiration of the recorded 1:1 calls. Default is 60 days. + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. + +Valid options are: +- Enabled: Copilot can work with or without transcription during calls. This is the default value. +- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. +- Disabled: Copilot is disabled for calls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpendLimits +This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. + +Possible values: + +- True +- False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWebPstnMediaBypass + +Determines if MediaBypass is enabled for PSTN calls on specified Web platforms. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundFederatedCallRoutingTreatment +Setting this parameter lets you control how inbound federated calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound federated call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. +- Voicemail: The inbound federated call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPstnCallRoutingTreatment +Setting this parameter lets you control how inbound PSTN calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound PSTN call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. +- Voicemail: The inbound PSTN call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. +- UserOverride: Users can determine their PSTN call routing choice from call settings in the Teams app. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledTypeForCalling +Determines whether real-time captions are available for the user in Teams calls. + +Valid options are: + +- DisabledUserOverride: Allows the user to turn on live captions. +- Disabled: Prohibits the user from turning on live captions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldEnabledType +Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. + +Valid options are: + +- Enabled: Music on hold is enabled. This is the default. +- Disabled: Music on hold is disabled. +- UserOverride: For now, setting the value to UserOverride is the same as Enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutAppPathForIncomingPstnCalls +Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: "" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutForIncomingPstnCalls +Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventTollBypass +Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. + +> [!NOTE] +> Do not set this parameter to True for Calling Plan or Operator Connect users as it will prevent successful call routing. This setting only works with Direct Routing which is configured to handle location-based routing restrictions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamFilteringEnabledType +Determines if spam detection is enabled for inbound PSTN calls. + +Possible values: + +- Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams. +- Disabled: Spam detection is disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md new file mode 100644 index 0000000000..a6e29ca6ed --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md @@ -0,0 +1,270 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsTeamsChannelsPolicy + +## SYNOPSIS + +The CsTeamsChannelsPolicy allows you to manage features related to the Teams and Channels experience within the Teams application. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsChannelsPolicy [-Tenant <Guid>] [-AllowOrgWideTeamCreation <Boolean>] + [-EnablePrivateTeamDiscovery <Boolean>] [-AllowPrivateChannelCreation <Boolean>] + [-AllowUserToParticipateInExternalSharedChannel <Boolean>] [-AllowChannelSharingToExternalUser <Boolean>] [-AllowSharedChannelCreation <Boolean>] [-ThreadedChannelCreation <String>] + [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsChannelsPolicy [-Tenant <Guid>] [-AllowOrgWideTeamCreation <Boolean>] + [-EnablePrivateTeamDiscovery <Boolean>] [-AllowPrivateChannelCreation <Boolean>] + [-AllowUserToParticipateInExternalSharedChannel <Boolean>] [-AllowChannelSharingToExternalUser <Boolean>] [-AllowSharedChannelCreation <Boolean>] + [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +This cmdlet allows you to update existing policies of this type. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsChannelsPolicy -Identity StudentPolicy -EnablePrivateTeamDiscovery $true +``` + +This example shows updating an existing policy with name "StudentPolicy" and enabling Private Team Discovery. + +## 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Bypass all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Use this parameter to specify the name of the policy being updated. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreadedChannelCreation +This setting enables/disables Threaded Channel creation and editing. + +Possible Values: +- Enabled: Users are allowed to create and edit Threaded Channels. +- Disabled: Users are not allowed to create and edit Threaded Channels. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy) + +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) + +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) + +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md similarity index 79% rename from skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md index fa615e18f0..d2685ba41e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md @@ -1,22 +1,27 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsclientconfiguration +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Set-CsTeamsClientConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsTeamsClientConfiguration ## SYNOPSIS -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. +The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. ## SYNTAX ### Identity (Default) ``` Set-CsTeamsClientConfiguration [-Tenant <System.Guid>] [-AllowEmailIntoChannel <Boolean>] - [-RestrictedSenderList <String>] [-AllowDropBox <Boolean>] [-AllowBox <Boolean>] [-AllowGoogleDrive <Boolean>] + [-RestrictedSenderList <String>] [-AllowDropBox <Boolean>] [-AllowEgnyte <Boolean>] [-AllowBox <Boolean>] [-AllowGoogleDrive <Boolean>] [-AllowRoleBasedChatPermissions <Boolean>] [-AllowShareFile <Boolean>] [-AllowOrganizationTab <Boolean>] [-AllowSkypeBusinessInterop <Boolean>] [-AllowTBotProactiveMessaging <Boolean>] [-ContentPin <String>] [-AllowResourceAccountSendMessage <Boolean>] [-ResourceAccountContentAccess <String>] [-AllowGuestUser <Boolean>] @@ -27,7 +32,7 @@ Set-CsTeamsClientConfiguration [-Tenant <System.Guid>] [-AllowEmailIntoChannel < ### Instance ``` Set-CsTeamsClientConfiguration [-Tenant <System.Guid>] [-AllowEmailIntoChannel <Boolean>] - [-RestrictedSenderList <String>] [-AllowDropBox <Boolean>] [-AllowBox <Boolean>] [-AllowGoogleDrive <Boolean>] + [-RestrictedSenderList <String>] [-AllowDropBox <Boolean>] [-AllowEgnyte <Boolean>] [-AllowBox <Boolean>] [-AllowGoogleDrive <Boolean>] [-AllowRoleBasedChatPermissions <Boolean>] [-AllowShareFile <Boolean>] [-AllowOrganizationTab <Boolean>] [-AllowSkypeBusinessInterop <Boolean>] [-AllowTBotProactiveMessaging <Boolean>] [-ContentPin <String>] [-AllowResourceAccountSendMessage <Boolean>] [-ResourceAccountContentAccess <String>] [-AllowGuestUser <Boolean>] @@ -36,9 +41,9 @@ Set-CsTeamsClientConfiguration [-Tenant <System.Guid>] [-AllowEmailIntoChannel < ``` ## DESCRIPTION -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and whether or not meeting room devices running teams are can display content from user accounts. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. +The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and whether or not meeting room devices running teams are can display content from user accounts. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. -An organization can have only one effective Teams Client Configuration - these settings will apply across the entire organization for the particular features they control. +An organization can have only one effective Teams Client Configuration - these settings will apply across the entire organization for the particular features they control. Note that three of these settings (ContentPin, ResourceAccountContentAccess, and AllowResourceAccountSendMessage) control resource account behavior for Surface Hub devices attending Skype for Business meetings, and are not used in Microsoft Teams. @@ -83,10 +88,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowEgnyte +Designates whether users are able to leverage Egnyte as a third party storage solution in Microsoft Teams. If $true, users will be able to add Egnyte in the client and interact with the files stored there. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowEmailIntoChannel When set to $true, mail hooks are enabled, and users can post messages to a channel by sending an email to the email address of Teams channel. -To find the email address for a channel, click the More options menu for the channel and then select Get email address. +To find the email address for a channel, click the More options menu for the channel and then select Get email address. ```yaml Type: Boolean @@ -116,7 +136,7 @@ Accept wildcard characters: False ``` ### -AllowGuestUser -Designates whether or not guest users in your organization will have access to the Teams client. If $true, guests in your tenant will be able to access the Teams client. Note that this setting has a core dependency on Guest Access being enabled in your Office 365 tenant. For more information on this topic, read Authorize Guest Access in Microsoft Teams: https://docs.microsoft.com/en-us/microsoftteams/teams-dependencies +Designates whether or not guest users in your organization will have access to the Teams client. If $true, guests in your tenant will be able to access the Teams client. Note that this setting has a core dependency on Guest Access being enabled in your Office 365 tenant. For more information on this topic, read Authorize Guest Access in Microsoft Teams: https://learn.microsoft.com/microsoftteams/teams-dependencies ```yaml Type: Boolean @@ -146,7 +166,7 @@ Accept wildcard characters: False ``` ### -AllowResourceAccountSendMessage -Surface Hub uses a device account to provide email and collaboration services (IM, video, voice). This device account is used as the originating identity (the “from” party) when sending email, IM, and placing calls. As this account is not coming from an individual, identifiable user, it is deemed “anonymous” because it originated from the Surface Hub's device account. If set to $true, these device accounts will be able to send chat messages in Skype for Business Online (does not apply to Microsoft Teams). +Surface Hub uses a device account to provide email and collaboration services (IM, video, voice). This device account is used as the originating identity (the "from" party) when sending email, IM, and placing calls. As this account is not coming from an individual, identifiable user, it is deemed "anonymous" because it originated from the Surface Hub's device account. If set to $true, these device accounts will be able to send chat messages in Skype for Business Online (does not apply to Microsoft Teams). ```yaml Type: Boolean @@ -160,6 +180,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowRoleBasedChatPermissions +When set to True, Supervised Chat is enabled for the tenant. + +```yaml +Type: Boolean +Parameter Sets: (All) + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowScopedPeopleSearchandAccess If set to $true, the Exchange address book policy (ABP) will be used to provide customized view of the global address book for each user. This is only a virtual separation and not a legal separation. @@ -176,7 +210,7 @@ Accept wildcard characters: False ``` ### -AllowShareFile -Designates whether users are able to leverage ShareFile as a third party storage solution in Microsoft Teams. If $true, users will be able to add ShareFile in the client and interact with the files stored there. +Designates whether users are able to leverage Citrix ShareFile as a third party storage solution in Microsoft Teams. If $true, users will be able to add Citrix ShareFile in the client and interact with the files stored there. ```yaml Type: Boolean @@ -191,7 +225,7 @@ Accept wildcard characters: False ``` ### -AllowSkypeBusinessInterop -When set to $true, Teams conversations automatically show up in Skype for Business for users that aren't enabled for Teams. +When set to $true, Teams conversations automatically show up in Skype for Business for users that aren't enabled for Teams. ```yaml Type: Boolean @@ -238,7 +272,7 @@ Accept wildcard characters: False ### -ContentPin This setting applies only to Skype for Business Online (not Microsoft Teams) and defines whether the user must provide a secondary form of authentication to access the meeting content *from a resource device account*. Meeting content is defined as files that are shared to the "Content Bin" - files that have been attached to the meeting. -Possible Values: NotRequired, RequiredOutsideScheduledMeeting, AlwaysRequired . Default Value: RequiredOutsideScheduledMeeting +Possible Values: NotRequired, RequiredOutsideScheduleMeeting, AlwaysRequired . Default Value: RequiredOutsideScheduleMeeting ```yaml Type: String @@ -269,6 +303,7 @@ Accept wildcard characters: False ### -Identity The only valid input is Global - the tenant wide configuration. + ```yaml Type: XdsIdentity Parameter Sets: Identity @@ -297,7 +332,9 @@ Accept wildcard characters: False ``` ### -ResourceAccountContentAccess -If $true, resource accounts for Surface Hub devices calling into Skype for Business meetings will be able to access content uploaded to the Content Bin. Use with -ContentPIN parameter to designate whether a ContentPIN is required when access content from a device. +Require a secondary form of authentication to access meeting content. + +Possible values: NoAccess, PartialAccess and FullAccess ```yaml Type: String @@ -312,7 +349,7 @@ Accept wildcard characters: False ``` ### -RestrictedSenderList -Senders domains can be further restricted to ensure that only allowed SMTP domains can send emails to the Teams channels. This is a comma-separated string of the domains you'd like to *allow* to send emails to Teams channels. +Senders domains can be further restricted to ensure that only allowed SMTP domains can send emails to the Teams channels. This is a semicolon-separated string of the domains you'd like to *allow* to send emails to Teams channels. ```yaml Type: String @@ -342,8 +379,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +The WhatIf switch does not work with this cmdlet. ```yaml Type: SwitchParameter @@ -358,14 +394,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md new file mode 100644 index 0000000000..1e7e7f36f9 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md @@ -0,0 +1,415 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: Set-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Set-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Modifies an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-RequiredBeforeMeetingJoin <Boolean>] [-RequiredDuringMeeting <Boolean>] + [-RequiredBeforeCallEstablishment <Boolean>] [-RequiredDuringCall <Boolean>] + [-ConcurrentInvitationCount <UInt32>] [-ComplianceRecordingPairedApplications <ComplianceRecordingPairedApplication[]>] + [-Priority <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Instance <PSObject>] + [-RequiredBeforeMeetingJoin <Boolean>] [-RequiredDuringMeeting <Boolean>] + [-RequiredBeforeCallEstablishment <Boolean>] [-RequiredDuringCall <Boolean>] + [-ConcurrentInvitationCount <UInt32>] [-ComplianceRecordingPairedApplications <ComplianceRecordingPairedApplication[]>] + [-Priority <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false +``` + +The command shown in Example 1 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made optional for meetings. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeCallEstablishment $false -RequiredDuringCall $false +``` + +The command shown in Example 2 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made optional for calls. +Please refer to the documentation of the RequiredBeforeCallEstablishment and RequiredDuringCall parameters for more information. + +### Example 3 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ConcurrentInvitationCount 2 +``` + +The command shown in Example 3 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by specifying that two invites must be sent to the same application for the same call or meeting. +Please refer to the documentation of the ConcurrentInvitationCount parameter for more information. + +### Example 4 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +The command shown in Example 4 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by pairing it with another application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +Separate invites are sent to the paired applications for the same call or meeting. +Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. + +### Example 5 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications $null +``` + +The command shown in Example 5 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application's resiliency is removed by removing the pairing it had with the application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. + +### Example 6 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication | Set-CsTeamsComplianceRecordingApplication -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false +``` + +The command shown in Example 6 modifies all existing associations between application instances of policy-based recording applications and their corresponding Teams recording policy. + +In this example, all applications are made optional for meetings. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. + +## PARAMETERS + +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. + +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \<Identity of the associated Teams recording policy\>/\<ObjectId of the application instance\>. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. + +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. + +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. + +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. + +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. + +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. + +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. + +All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. +So this parameter does not affect the order of invitations to the applications, or any other routing. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md new file mode 100644 index 0000000000..482a4c801b --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md @@ -0,0 +1,361 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Set-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Modifies an existing Teams recording policy for governing automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsComplianceRecordingPolicy [-Tenant <System.Guid>] [-Identity <XdsIdentity>] + [-Enabled <Boolean>] [-WarnUserOnRemoval <Boolean>] [-Description <String>] + [-DisableComplianceRecordingAudioNotificationForCalls <Boolean>] [-RecordReroutedCalls <Boolean>] + [-ComplianceRecordingApplications <ComplianceRecordingApplication[]>] [-CustomBanner <Guid>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsComplianceRecordingPolicy [-Tenant <System.Guid>] [-Instance <PSObject>] + [-Enabled <Boolean>] [-WarnUserOnRemoval <Boolean>] [-Description <String>] + [-ComplianceRecordingApplications <ComplianceRecordingApplication[]>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899') +``` + +The command shown in Example 1 modifies an existing per-user Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. +This policy is re-assigned a single application instance of a policy-based recording application: d93fefc7-93cc-4d44-9a5d-344b0fff2899, which is the ObjectId of the application instance as obtained from the Get-CsOnlineApplicationInstance cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by that application instance. Existing calls and meetings are unaffected. + +### Example 2 + +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899'), @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +Example 2 is a variation of Example 1. +In this case, the Teams recording policy is re-assigned two application instances of policy-based recording applications. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by both those application instances. Existing calls and meetings are unaffected. + +### Example 3 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $false +``` + +The command shown in Example 3 stops automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +### Example 4 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true +``` + +The command shown in Example 4 causes automatic policy-based recording to occur for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +### Example 5 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy | Set-CsTeamsComplianceRecordingPolicy -Enabled $false +``` + +The command shown in Example 5 stops automatic policy-based recording for all Teams recording policies. +This effectively stops automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned any Teams recording policy. Existing calls and meetings are unaffected. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CustomBanner +References the Custom Banner text in the storage. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WarnUserOnRemoval +This parameter is reserved for future use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +```yaml +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md new file mode 100644 index 0000000000..15607b6980 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Set-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCortanaPolicy [-Tenant <System.Guid>] [-Description <String>] [-CortanaVoiceInvocationMode <String>] + [-AllowCortanaVoiceInvocation <Boolean>] [-AllowCortanaAmbientListening <Boolean>] + [-AllowCortanaInContextSuggestions <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsCortanaPolicy [-Tenant <System.Guid>] [-Description <String>] [-CortanaVoiceInvocationMode <String>] + [-AllowCortanaVoiceInvocation <Boolean>] [-AllowCortanaAmbientListening <Boolean>] + [-AllowCortanaInContextSuggestions <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -CortanaVoiceInvocationMode Disabled +``` +In this example, Cortana voice assistant is set to disabled. + +## PARAMETERS + +### -AllowCortanaAmbientListening +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaInContextSuggestions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaVoiceInvocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CortanaVoiceInvocationMode +The value of this field indicates if Cortana is enabled and mode of invocation. +* Disabled - Cortana voice assistant is turned off and cannot be used. +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of your policy to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity for the policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity MyCortanaPolicy. +If you do not specify an Identity the Set-CsTeamsCortanaPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +You can return your tenant ID by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText new file mode 100644 index 0000000000..e13c9bf900 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText @@ -0,0 +1,93 @@ +--- +Module Name: MicrosoftTeams +title: Set-CsTeamsCustomBannerText +author: saleens7 +ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText +schema: 2.0.0 +--- + +# Set-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCustomBannerText [[-Id] <Guid>] [<CommonParameters>] +``` + +## DESCRIPTION + +Updates a single instance of a custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Set-CsTeamsCustomBannerText -Identity CustomText +``` + +Sets the properties of the CustomText instance of TeamsCustomBannerText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that the tenant admin would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that the tenant admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..131dd52c2a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md @@ -0,0 +1,93 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText +title: Set-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# Set-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCustomBannerText [-Id <Guid>] [-Text <String>] [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +Updates a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Set-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" +``` + +This example sets the properties of the CustomText instance of TeamsCustomBannerText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that you would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that you would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md new file mode 100644 index 0000000000..3306c4828f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md @@ -0,0 +1,228 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-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. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsEducationAssignmentsAppPolicy [-Tenant <System.Guid>] [-ParentDigestEnabledType <String>] + [-MakeCodeEnabledType <String>] [-TurnItInEnabledType <String>] [-TurnItInApiUrl <String>] + [-TurnItInApiKey <String>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsEducationAssignmentsAppPolicy [-Tenant <System.Guid>] [-ParentDigestEnabledType <String>] + [-MakeCodeEnabledType <String>] [-TurnItInEnabledType <String>] [-TurnItInApiUrl <String>] + [-TurnItInApiKey <String>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsEducationAssignmentsAppPolicy -TurnItInEnabledType "Enabled" +``` + +Enables the TurnItIn app for the organization + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy being modified. The only value supported is "Global", as you cannot create user level policies of this type. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Pass in the policy fetched from Get-CsTeamsEducationAssignmentsAppPolicy +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MakeCodeEnabledType +Block-based coding activities to introduce computer science concepts. Possible values are "Enabled" or "Disabled" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentDigestEnabledType +Send digest emails to parents/guardians. Possible values are "Enabled" or "Disabled" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal 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 +``` + +### -TurnItInApiKey +The api key in order to enable TurnItIn. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TurnItInApiUrl +The api url in order to enable TurnItIn + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TurnItInEnabledType +A service that detects plagiarism in student writing. Possible values are "Enabled" or "Disabled" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsEducationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md new file mode 100644 index 0000000000..2574fce8c8 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsEducationConfiguration +author: SaritaBehera +ms.author: saritabehera +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsEdcuationConfiguration + +## SYNOPSIS + +This cmdlet is used to manage the organization-wide education configuration for Teams. + +## SYNTAX + +```powershell +Set-CsTeamsEducationConfiguration + [-ParentGuardianPreferredContactMethod <String>] + [-UpdateParentInformation <String>] + [-WhatIf] + [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet is used to manage the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + +You must be a Teams Service Administrator for your organization to run the cmdlet. + +## EXAMPLES + +### Example 1 +In this example, Email is set as the preferred contact method used for parent communication invitations across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod Email +``` + +### Example 2 +In this example, SMS is set as the preferred contact method used for parent communication invitations across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod SMS +``` + +### Example 3 +In this example, updating parents contact information is enabled by educators across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -UpdateParentInformation Enabled +``` + +### Example 4 +In this example, updating parents contact information is disabled by educators across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -UpdateParentInformation Disabled +``` + +## PARAMETERS + +### -ParentGuardianPreferredContactMethod +Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. + +```yaml +Type: String +Position: Named +Default value: Email +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateParentInformation +Indicates whether updating parents contact information is Enabled/Disabled by educators. Possible values are 'Enabled' and 'Disabled'. + +```yaml +Type: String +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md new file mode 100644 index 0000000000..f17f6774c5 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md @@ -0,0 +1,165 @@ +--- +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 +ms.author: serdars +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Set-CsTeamsEmergencyCallRoutingPolicy + +## SYNOPSIS +This cmdlet modifies an existing Teams Emergency Call Routing Policy. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsEmergencyCallRoutingPolicy [[-Identity] <string>] [-AllowEnhancedEmergencyServices <bool>] + [-Description <string>] [-EmergencyNumbers <Object>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet modifies an existing Teams Emergency Call Routing Policy. Teams Emergency Call Routing policy is used for the life cycle of emergency call routing - emergency numbers and routing configuration + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -AllowEnhancedEmergencyServices:$false -Description "test" +``` + +This example modifies an existing Teams Emergency Call Routing Policy. + +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "911" -EmergencyDialMask "933" -OnlinePSTNUsage "USE911" +$en2 = New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "9112" -OnlinePSTNUsage "DKE911" +Set-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{add=$en1,$en2} +``` + +This example first creates new Teams emergency number objects and then adds these Teams emergency numbers to an existing Teams Emergency Call Routing policy. + +### Example 3 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "9112" -OnlinePSTNUsage "DKE911" +Set-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{remove=$en1} +``` + +This example first creates a new Teams emergency number object and then removes that Teams emergency number from an existing Teams Emergency Call Routing policy. + +## PARAMETERS + +### -AllowEnhancedEmergencyServices +Flag to enable Enhanced Emergency Services. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the name of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) + +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) + +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) + +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) + +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..b67d6b3cd5 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsEmergencyCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Set-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsEmergencyCallingPolicy [-Identity] <string> [-ExtendedNotifications <PSListModifier[TeamsEmergencyCallingExtendedNotification]>] + [-NotificationGroup <string>] [-NotificationDialOutNumber <string>] [-ExternalLocationLookupMode <ExternalLocationLookupMode>] + [-NotificationMode <NotificationMode>] [-EnhancedEmergencyServiceDisclaimer <string>] + [-Description <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet modifies an existing Teams Emergency Calling policy. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -NotificationGroup "123@contoso.com;567@contoso.com" +``` + +This example modifies NotificationGroup of an existing policy instance with identity TestECP. + +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{remove=$en1} +``` + +This example first creates a new Teams Emergency Calling Extended Notification object and then removes that Teams Emergency Calling Extended Notification from an existing Teams Emergency Calling policy. + +### Example 3 +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode ConferenceUnMuted +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "933" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{add=$en1,$en2} +``` + +This example first creates two new Teams Emergency Calling Extended Notification objects and then adds them to an existing Teams Emergency Calling policy with identity TestECP. + +## PARAMETERS + +### -Description +Provides a description of the Teams Emergency Calling policy to identify the purpose of setting it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnhancedEmergencyServiceDisclaimer +Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. The disclaimer can be up to 350 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedNotifications +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. + +If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. + +```yaml +Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalLocationLookupMode +Enables ExternalLocationLookupMode. This mode allows users to set Emergency addresses for remote locations. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call via Teams chat. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and a maximum of 50 users in total can be notified. Both UPN and SMTP address are accepted when adding users directly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. +Possible values are NotificationOnly, ConferenceMuted, and ConferenceUnMuted. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) + +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md new file mode 100644 index 0000000000..33b326f662 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -0,0 +1,209 @@ +--- +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 <Object>] [-CallingEndtoEndEncryptionEnabledType <Object>] [-MeetingEndToEndEncryption <Object>] + [[-Identity] <Object>] [-Force] [-Instance <Object>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..bf14cb6cb1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md @@ -0,0 +1,453 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy +title: Set-CsTeamsEventsPolicy +schema: 2.0.0 +ms.date: 04/23/2025 +--- + +# Set-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Set-CsTeamsEventsPolicy [-AllowWebinars <String>] [-EventAccessType <String>] [-AllowTownhalls <String>] + [-TownhallEventAttendeeAccess <String>] [-AllowEmailEditing <String>] [-AllowedQuestionTypesInRegistrationForm <String>] + [-AllowEventIntegrations <Boolean>] [-AllowedWebinarTypesForRecordingPublish <String>] + [-AllowedTownhallTypesForRecordingPublish <String>] [-TownhallChatExperience <String>] [-Description <String>] + [-RecordingForTownhall <String>] [-RecordingForWebinar <String>] + [-TranscriptionForTownhall <String>] [-TranscriptionForWebinar <String>] + [-UseMicrosoftECDN <Boolean>] [-BroadcastPremiumApps <String>] +``` + +## DESCRIPTION +User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +``` + +The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. + +## PARAMETERS + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town halls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType + +> [!NOTE] +> Currently, webinar and town hall event access is managed together via EventAccessType. + +This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: +DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting describes how IT admins can control which types of webinar attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs access to the integrations tab in the event creation workflow. + +Possible values +true, false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallChatExperience +This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. + +Possible values are: Optimized, None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md new file mode 100644 index 0000000000..3538e2a0af --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsexternalaccessconfiguration +title: Set-CsTeamsExternalAccessConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsExternalAccessConfiguration + +## SYNOPSIS + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsExternalAccessConfiguration [-BlockedUsers <List>] [-BlockExternalUserAccess <Boolean>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Allows admins to set values in the TeamsExternalAccessConfiguration, which specifies configs that can be used to improve entire org security. This configuration primarily allows admins to block malicious external users from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsExternalAccessConfiguration -Identity Global -BlockExternalAccessUserAccess $true +``` + +In this example, the admin has enabled the BlockExternalUserAccess. The users in the BlockedUsers will be blocked from communicating with the internal users. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsExternalAccessConfiguration -Identity Global -BlockedUsers @("user1@malicious.com", "user2@malicious.com") +``` + +In this example, the admin has added two malicious users into the blocked list. These blocked users can't communicate with internal users anymore. + +## PARAMETERS + +### -BlockExternalAccessUserAccess +Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedUsers +You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Bypass confirmation + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only option is Global + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..c6a1f2b39c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md @@ -0,0 +1,253 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-CsTeamsFeedbackPolicy + +## SYNOPSIS + +Use this cmdlet to modify a Teams feedback policy (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +## SYNTAX + +``` +Set-CsTeamsFeedbackPolicy [[-Identity] <String>] + [-AllowEmailCollection <Boolean>] + [-AllowLogCollection <Boolean>] + [-AllowScreenshotCollection <Boolean>] + [-Confirm] + [-EnableFeatureSuggestions <Boolean>] + [-Force] + [-Instance <Object>] + [-ReceiveSurveysMode <String>] + [-Tenant <Object>] + [-UserInitiatedMode <String>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Modifies a Teams feedback policy (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsFeedbackPolicy -identity "New Hire Feedback Policy" -userInitiatedMode enabled -receiveSurveysMode disabled +``` + +In this example, the policy "New Hire Feedback Policy" is modified, sets the userInitiatedMode parameter to enabled and the receiveSurveysMode parameter to disabled. + +## PARAMETERS + +### -Identity +The unique identifier 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 +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailCollection +Set this to TRUE to enable Email collection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLogCollection +Set this to TRUE to enable log collection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFeatureSuggestions +This setting will enable Tenant Admins to hide or show the Teams menu item "Help | Suggest a Feature". +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..1a28cf4317 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy +title: Set-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsFilesPolicy + +## SYNOPSIS +Creates a new teams files policy. + Teams files policies determine whether or not files entry points to SharePoint enabled for a user. +The policies also specify third-party app ID to allow file storage (e.g., Box). + +## SYNTAX + +```powershell +Set-CsTeamsFilesPolicy [-NativeFileEntryPoints <String>] [-SPChannelFilesTab <String>] + [-DefaultFileUploadAppId <String>] [-FileSharingInChatswithExternalUsers <String>] [-Identity] <String> + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +If your organization chooses a third-party for content storage, you can turn off the NativeFileEntryPoints parameter in the Teams Files policy. This parameter is enabled by default, which shows option to attach OneDrive / SharePoint content from Teams chats or channels. When this parameter is disabled, users won't see access points for OneDrive and SharePoint in Teams. Please note that OneDrive app in the left navigation pane in Teams isn't affected by this policy. +Teams administrators can also choose which file service will be used by default when users upload files from their local devices by dragging and dropping them in a chat or channel. OneDrive and SharePoint are the existing defaults, but admins can now change it to a third-party app. +Teams administrators would be able to create a customized teams files policy to match the organization's requirements. + +## EXAMPLES + +### Example 1 +``` +Set-CsTeamsFilesPolicy -Identity "CustomOnlineVoicemailPolicy" -NativeFileEntryPoints Disabled/Enabled +``` + +The command shown in Example 1 changes the teams files policy CustomTeamsFilesPolicy with NativeFileEntryPoints set to Disabled/Enabled. + +### Example 2 +``` +Set-CsTeamsFilesPolicy -DefaultFileUploadAppId GUID_appId +``` + +The command shown in Example 2 changes the DefaultFileUploadAppId to AppId_GUID for tenant level global teams files policy when calling without Identity parameter. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +``` +### -DefaultFileUploadAppId +This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPChannelFilesTab + +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) + diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md index 8920bd0dda..f79231986e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md @@ -1,17 +1,20 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestcallingconfiguration +applicable: Microsoft Teams title: Set-CsTeamsGuestCallingConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsTeamsGuestCallingConfiguration ## SYNOPSIS Allows admins to set values in the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. - ## SYNTAX ### Identity (Default) @@ -101,7 +104,7 @@ Accept wildcard characters: False ``` ### -Instance -Internal Microsoft use +Internal Microsoft use ```yaml Type: PSObject @@ -147,8 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -156,6 +158,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md new file mode 100644 index 0000000000..1c4ee27ee2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmeetingconfiguration +applicable: Microsoft Teams +title: Set-CsTeamsGuestMeetingConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsGuestMeetingConfiguration + +## SYNOPSIS + +Designates what meeting features guests using Microsoft Teams will have available. Use this cmdlet to set the configuration. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsGuestMeetingConfiguration [-Tenant <Guid>] [-AllowIPVideo <Boolean>] + [-ScreenSharingMode <String>] [-AllowMeetNow <Boolean>] [-AllowTranscription <Boolean>] [-LiveCaptionsEnabledType <String>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### Instance +```powershell +Set-CsTeamsGuestMeetingConfiguration [-Tenant <Guid>] [-AllowIPVideo <Boolean>] + [-ScreenSharingMode <String>] [-AllowMeetNow <Boolean>] [-AllowTranscription <Boolean>] [-LiveCaptionsEnabledType <String>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The TeamsGuestMeetingConfiguration designates which meeting features guests leveraging Microsoft Teams will have available. This configuration will apply to all guests utilizing Microsoft Teams. Use the Set-CsTeamsGuestMeetingConfiguration cmdlet to designate what values are set for your organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsGuestMeetingConfiguration -Identity Global -AllowMeetNow $false -AllowIPVideo $false +``` + +Disables Guests' usage of MeetNow and Video calling in the organization; all other values of the configuration are left as is. + +## PARAMETERS + +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow guests to share their video. Set this to FALSE to prohibit guests from sharing their video + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetNow +Determines whether guests can start ad-hoc meetings. Set this to TRUE to allow guests to start ad-hoc meetings. Set this to FALSE to prohibit guests from starting ad-hoc meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only input allowed is "Global" + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Pipe the existing configuration from a Get- call. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for guests in Teams meetings. Set this to DisabledUserOverride to allow guests to turn on live captions. Set this to Disabled to prohibit. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScreenSharingMode +Determines the mode in which guests can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscription +Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md new file mode 100644 index 0000000000..41682046d1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md @@ -0,0 +1,300 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmessagingconfiguration +applicable: Microsoft Teams +title: Set-CsTeamsGuestMessagingConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsTeamsGuestMessagingConfiguration + +## SYNOPSIS +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [-AllowUserEditMessage <Boolean>] + [-AllowImmersiveReader <Boolean>] [-AllowUserDeleteMessage <Boolean>] [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] + [-AllowUserDeleteChat <Boolean>] [-GiphyRatingType <String>] [-AllowMemes <Boolean>] [-AllowStickers <Boolean>] [-UsersCanDeleteBotMessages <Boolean>] [[-Identity] <XdsIdentity>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsGuestMessagingConfiguration [-Tenant <Guid>] [-AllowUserEditMessage <Boolean>] + [-AllowImmersiveReader <Boolean>] [-AllowUserDeleteMessage <Boolean>] [-AllowUserChat <Boolean>] [-AllowGiphy <Boolean>] + [-AllowUserDeleteChat <Boolean>] [-GiphyRatingType <String>] [-AllowMemes <Boolean>] [-AllowStickers <Boolean>] [-UsersCanDeleteBotMessages <Boolean>] [-Instance <PSObject>] [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet lets you update the guest messaging options you'd like to enable in your organization. + +## EXAMPLES + +### Example 1 +``` +Set-CsTeamsGuestMessagingConfiguration -AllowMemes $False +``` + +The command shown in Example 1 disables memes usage by guests within Teams. + +## PARAMETERS + +### -AllowGiphy +Determines if Giphy images are available. + +```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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickers +Determines if stickers are available for use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserChat +Determines if a user is allowed to chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessage +Determines if a user is allowed to delete their own messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessage +Determines if a user is allowed to edit their own messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanDeleteBotMessages +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GiphyRatingType +Determines Giphy content restrictions. Default value is "Moderate", other options are "NoRestriction" and "Strict" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +``` + +### -Identity + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md new file mode 100644 index 0000000000..0f608fbf29 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsipphonepolicy +applicable: Microsoft Teams +title: Set-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Set-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings. + +## SYNTAX + +``` +Set-CsTeamsIPPhonePolicy [[-Identity] <XdsIdentity>] + [-AllowBetterTogether <String>] + [-AllowHomeScreen <String>] + [-AllowHotDesking <Boolean>] + [-Confirm] + [-Description <String>] + [-Force] + [-HotDeskingIdleTimeoutInMinutes <Int>] + [-Instance <Object>] + [-SearchOnCommonAreaPhoneMode <String>] + [-SignInMode <String>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION + +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing TeamsIPPhonePolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin +``` +This example shows the SignInMode "CommonAreaPhoneSignIn" being set against the policy named "CommonAreaPhone". + +## PARAMETERS + +### -AllowBetterTogether +Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. +Possible values this parameter can take: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHomeScreen +Determines whether the Home Screen feature of the Teams IP Phones is enabled. +Possible values this parameter can take: + +- Enabled +- EnabledUserOverride +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHotDesking +Determines if the hot desking feature is enabled or not. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free form text that can be used by administrators as desired. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotDeskingIdleTimeoutInMinutes +Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out. + +```yaml +Type: Int +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy. To specify the global policy for the organization, use "global". To specify any other policy provide the name of that policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchOnCommonAreaPhoneMode +Determines whether a user can look up contacts from the tenant's global address book when the phone is signed into the Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInMode +Determines the sign in mode for the device when signing in to Teams. +Possible Values: +- 'UserSignIn: Enables the individual user's Teams experience on the phone' +- 'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone' +- 'MeetingSignIn: Enables the meeting/conference room experience on the phone' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..7bb81a371f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Set-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS + +This cmdlet Set Teams media connectivity policy value for current tenant. + +## SYNTAX + +``` +Set-CsTeamsMediaConnectivityPolicy -Identity <String> -DirectConnection <Boolean> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet Set Teams media connectivity policy DirectConnection value for current tenant. The value can be "Enabled" or "Disabled" + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsMediaConnectivityPolicy -Identity Test -DirectConnection Disabled + +Identity DirectConnection +-------- ---------------- +Global Enabled +Tag:Test Disabled +``` + +Set Teams media connectivity policy "DirectConnection" value to "Disabled" for identity "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams media connectivity policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectConnection +Policy value of the Teams media connectivity DirectConnection policy. + +```yaml +Type: Boolean +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..033a024718 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +applicable: Microsoft Teams +--- + +# Set-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +``` +Set-CsTeamsMeetingBrandingPolicy + [-MeetingBackgroundImages <PSListModifier>] + [-MeetingBrandingThemes <PSListModifier>] + [-DefaultTheme <String>] [-EnableMeetingOptionsThemeOverride <Boolean>] + [-EnableMeetingBackgroundImages <Boolean>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The `Set-CsTeamsMeetingBrandingPolicy` cmdlet allows administrators to update existing meeting branding policies. +However, it cannot be used to upload the images. If you want to upload the images, you should use Teams Admin Center. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMeetingBrandingPolicy +PS C:\> $brandingPolicy = Get-CsTeamsMeetingBrandingPolicy -Identity "demo branding" +PS C:\> $brandingPolicy.MeetingBrandingThemes[0].BrandAccentColor = "#FF0000" +PS C:\> Set-CsTeamsMeetingBrandingPolicy -Identity "demo branding" -MeetingBrandingThemes $brandingPolicy.MeetingBrandingThemes +``` + +In this example, the commands will change the brand accent color of the theme inside the `demo branding` meeting branding policy to `#FF0000` + +## PARAMETERS + +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingBackgroundImages +Enables custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allows organizers to control meeting themes. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: `-Identity global`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +It is not possible to add or remove background images using cmdlets. You should use Teams Admin Center for that purpose. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBrandingThemes +List of meeting branding themes. You can alter the list returned by the `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. +It is not possible to add or remove meeting branding themes using cmdlets. You should use Teams Admin Center for that purpose. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md index 1309356be0..a369ef43c1 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md @@ -1,11 +1,15 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastconfiguration +applicable: Microsoft Teams title: Set-CsTeamsMeetingBroadcastConfiguration schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- - # Set-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS @@ -34,14 +38,14 @@ Set-CsTeamsMeetingBroadcastConfiguration [-Tenant <Guid>] [-SupportURL <String>] ``` ## DESCRIPTION -Tenant level configuration for broadcast events in Teams +Tenant level configuration for broadcast events in Teams ## EXAMPLES ## PARAMETERS ### -AllowSdnProviderForBroadcastMeeting -If set to $true,  Teams meeting broadcast streams are enabled to take advantage of the network and bandwidth management capabilities of your Software Defined Network (SDN) provider.  +If set to $true, Teams meeting broadcast streams are enabled to take advantage of the network and bandwidth management capabilities of your Software Defined Network (SDN) provider. ```yaml Type: Boolean @@ -116,7 +120,7 @@ Accept wildcard characters: False ``` ### -SdnApiTemplateUrl -Specifies the Software Defined Network (SDN) provider's HTTP API endpoint. This information is provided to you by the SDN provider. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true.  +Specifies the Software Defined Network (SDN) provider's HTTP API endpoint. This information is provided to you by the SDN provider. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. ```yaml Type: String @@ -131,7 +135,7 @@ Accept wildcard characters: False ``` ### -SdnApiToken -Specifies the Software Defined Network (SDN) provider's authentication token which is required to use their SDN license. This is required by some SDN providers who will give you the required token. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true.  +Specifies the Software Defined Network (SDN) provider's authentication token which is required to use their SDN license. This is required by some SDN providers who will give you the required token. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. ```yaml Type: String @@ -146,7 +150,7 @@ Accept wildcard characters: False ``` ### -SdnLicenseId -Specifies the Software Defined Network (SDN) license identifier. This is required and provided by some SDN providers. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true.  +Specifies the Software Defined Network (SDN) license identifier. This is required and provided by some SDN providers. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. ```yaml Type: String @@ -161,7 +165,22 @@ Accept wildcard characters: False ``` ### -SdnProviderName -Specifies the Software Defined Network (SDN) provider's name. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true.  +Specifies the Software Defined Network (SDN) provider's name. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SdnRuntimeConfiguration +Specifies connection parameters used to connect with a 3rd party eCDN provider. These parameters should be obtained from the SDN provider to be used. ```yaml Type: String @@ -176,7 +195,7 @@ Accept wildcard characters: False ``` ### -SupportURL -Specifies a URL where broadcast event attendees can find support information or FAQs specific to that event. The URL will be displayed to the attendees during the broadcast.  +Specifies a URL where broadcast event attendees can find support information or FAQs specific to that event. The URL will be displayed to the attendees during the broadcast. ```yaml Type: String @@ -222,8 +241,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -231,6 +249,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md new file mode 100644 index 0000000000..5fda5b675c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md @@ -0,0 +1,269 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsTeamsMeetingBroadcastPolicy + +## SYNOPSIS + +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +## SYNTAX + +### Identity (Default) + +```powershell +Set-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Description <String>] + [-AllowBroadcastScheduling <Boolean>] [-AllowBroadcastTranscription <Boolean>] + [-BroadcastAttendeeVisibilityMode <String>] [-BroadcastRecordingMode <String>] [[-Identity] <XdsIdentity>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance + +```powershell +Set-CsTeamsMeetingBroadcastPolicy [-Tenant <Guid>] [-Description <String>] + [-AllowBroadcastScheduling <Boolean>] [-AllowBroadcastTranscription <Boolean>] + [-BroadcastAttendeeVisibilityMode <String>] [-BroadcastRecordingMode <String>] [-Instance <PSObject>] [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to update an existing policy. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMeetingBroadcastPolicy -Identity Global -AllowBroadcastScheduling $false +``` + +Sets the value of the Default (Global) Broadcast Policy in the organization to disable broadcast scheduling, and leaves all other parameters the same. + +## PARAMETERS + +### -AllowBroadcastScheduling + +Specifies whether this user can create broadcast events in Teams. This setting impacts broadcasts that use both self-service and external encoder production methods. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBroadcastTranscription + +Specifies whether real-time transcription and translation can be enabled in the broadcast event. + +> [!NOTE] +> This setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastAttendeeVisibilityMode + +Specifies the attendee visibility mode of the broadcast events created by this user. This setting controls who can watch the broadcast event - e.g. anyone can watch this event including anonymous users or only authenticated users in my company can watch the event. + +> [!NOTE] +> This setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. + +Possible values: +- Everyone +- EveryoneInCompany +- InvitedUsersInCompany +- EveryoneInCompanyAndExternal +- InvitedUsersInCompanyAndExternal + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastRecordingMode + +Specifies whether broadcast events created by this user are always recorded (AlwaysEnabled), never recorded (AlwaysDisabled) or user can choose whether to record or not (UserOverride). + +> [!NOTE] +> This setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. + +Possible values: +- AlwaysEnabled +- AlwaysDisabled +- UserOverride + +```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 about the conferencing 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 + +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 + +Unique identifier for the policy to be modified. Policies can be configured at the global or per-user scopes. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity SalesPolicy. + +Note that wildcards are not allowed when specifying an Identity. If you do not specify an Identity the 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 +``` + +### -Tenant + +Not applicable to online service. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md new file mode 100644 index 0000000000..10cd0d63f9 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md @@ -0,0 +1,434 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingconfiguration +applicable: Microsoft Teams +title: Set-CsTeamsMeetingConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsMeetingConfiguration + +## SYNOPSIS + +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +## SYNTAX + +### Identity (Default) + +```powershell +Set-CsTeamsMeetingConfiguration [-Tenant <Guid>] [-LogoURL <String>] [-LegalURL <String>] + [-HelpURL <String>] [-CustomFooterText <String>] [-DisableAnonymousJoin <Boolean>] [-EnableQoS <Boolean>] + [-ClientAudioPort <UInt32>] [-ClientAudioPortRange <UInt32>] [-ClientVideoPort <UInt32>] + [-ClientVideoPortRange <UInt32>] [-ClientAppSharingPort <UInt32>] [-ClientAppSharingPortRange <UInt32>] + [-ClientMediaPortRangeEnabled <Boolean>] [-DisableAppInteractionForAnonymousUsers <Boolean>] [[-Identity] <XdsIdentity>] [-FeedbackSurveyForAnonymousUsers <String>] [-LimitPresenterRolePermissions <Boolean>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Instance + +```powershell +Set-CsTeamsMeetingConfiguration [-Tenant <Guid>] [-LogoURL <String>] [-LegalURL <String>] + [-HelpURL <String>] [-CustomFooterText <String>] [-DisableAnonymousJoin <Boolean>] [-EnableQoS <Boolean>] + [-ClientAudioPort <UInt32>] [-ClientAudioPortRange <UInt32>] [-ClientVideoPort <UInt32>] + [-ClientVideoPortRange <UInt32>] [-ClientAppSharingPort <UInt32>] [-ClientAppSharingPortRange <UInt32>] + [-ClientMediaPortRangeEnabled <Boolean>] [-DisableAppInteractionForAnonymousUsers <Boolean>] [-FeedbackSurveyForAnonymousUsers <String>] [-LimitPresenterRolePermissions <Boolean>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. Use this cmdlet to set the configuration for your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMeetingConfiguration -EnableQoS $true -ClientVideoPort 10000 -Identity Global +``` + +In this example, the user is enabling collection of QoS data in his organization and lowering the video stream quality to accommodate low bandwidth networks. + +## PARAMETERS + +### -ClientAppSharingPort + +Determines the starting port number for client screen sharing or application sharing. +Minimum allowed value: 1024 +Maximum allowed value: 65535 +Default value: 50040 + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAppSharingPortRange + +Determines the total number of ports available for client sharing or application sharing. Default value is 20 + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAudioPort + +Determines the starting port number for client audio. +Minimum allowed value: 1024 +Maximum allowed value: 65535 +Default value: 50000 + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAudioPortRange + +Determines the total number of ports available for client audio. Default value is 20 + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientMediaPortRangeEnabled + +Determines whether custom media port and range selections need to be enforced. When set to True, clients will use the specified port range for media traffic. When set to False (the default value) for any available port (from port 1024 through port 65535) will be used to accommodate media traffic. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientVideoPort + +Determines the starting port number for client video. +Minimum allowed value: 1024 +Maximum allowed value: 65535 +Default value: 50020 + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientVideoPortRange + +Determines the total number of ports available for client video. Default value is 20 + +```yaml +Type: UInt32 +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 +``` + +### -CustomFooterText + +Text to be used on custom meeting invitations + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAnonymousJoin + +Determines whether anonymous users are blocked from joining meetings in the tenant. Set this to TRUE to block anonymous users from joining. Set this to FALSE to allow anonymous users to join meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableQoS + +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: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +{{Fill Force Description}} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only valid input is Global + +```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 parameter to update a saved configuration instance + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +Internal Microsoft use + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeedbackSurveyForAnonymousUsers +Determines if anonymous participants receive surveys to provide feedback about their meeting experience. Set to Disabled to disable anonymous meeting participants to receive surveys. Set to Enabled to allow anonymous meeting participants to receive surveys. +Possible values: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitPresenterRolePermissions +When set to True, users within the Tenant will have their presenter role capabilities limited. +When set to False, the presenter role capabilities will not be impacted and will remain as is. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md new file mode 100644 index 0000000000..5adc506782 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md @@ -0,0 +1,2031 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsMeetingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: alejandramu +ms.date: 2/26/2025 +--- + +# Set-CsTeamsMeetingPolicy + +## SYNOPSIS +The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +## SYNTAX + +### Identity (Default) + +```powershell +Set-CsTeamsMeetingPolicy [[-Identity] <XdsIdentity>] + [-AIInterpreter <string>] + [-AllowAnnotations <Boolean>] + [-AllowAnonymousUsersToDialOut <Boolean>] + [-AllowAnonymousUsersToJoinMeeting <Boolean>] + [-AllowAnonymousUsersToStartMeeting <Boolean>] + [-AllowAvatarsInGallery <Boolean>] + [-AllowBreakoutRooms <Boolean>] + [-AllowCarbonSummary <Boolean>] + [-AllowCartCaptionsScheduling <String>] + [-AllowChannelMeetingScheduling <Boolean>] + [-AllowCloudRecording <Boolean>] + [-AllowDocumentCollaboration <String>] + [-AllowEngagementReport <String>] + [-AllowExternalNonTrustedMeetingChat <Boolean>] + [-AllowExternalParticipantGiveRequestControl <Boolean>] + [-AllowImmersiveView <Boolean>] + [-AllowIPAudio <Boolean>] + [-AllowIPVideo <Boolean>] + [-AllowLocalRecording <Boolean>] + [-AllowMeetingCoach <Boolean>] + [-AllowMeetNow <Boolean>] + [-AllowMeetingReactions <Boolean>] + [-AllowMeetingRegistration <Boolean>] + [-AllowNDIStreaming <Boolean>] + [-AllowNetworkConfigurationSettingsLookup <Boolean>] + [-AllowOrganizersToOverrideLobbySettings <Boolean>] + [-AllowOutlookAddIn <Boolean>] + [-AllowPSTNUsersToBypassLobby <Boolean>] + [-AllowParticipantGiveRequestControl <Boolean>] + [-AllowPowerPointSharing <Boolean>] + [-AllowPrivateMeetNow <Boolean>] + [-AllowPrivateMeetingScheduling <Boolean>] + [-AllowRecordingStorageOutsideRegion <Boolean>] + [-AllowScreenContentDigitization <Boolean>] + [-AllowSharedNotes <Boolean>] + [-AllowTasksFromTranscript <String>] + [-AllowTrackingInReport <Boolean>] + [-AllowTranscription <Boolean>] + [-AllowedUsersForMeetingContext <String>] + [-AllowUserToJoinExternalMeeting <String>] + [-AllowWatermarkCustomizationForCameraVideo <Boolean>] + [-AllowWatermarkCustomizationForScreenSharing <Boolean>] + [-AllowWatermarkForCameraVideo <Boolean>] + [-AllowWatermarkForScreenSharing <Boolean>] + [-AllowWhiteboard <Boolean>] + [-AllowedStreamingMediaInput <String>] + [-AnonymousUserAuthenticationMethod <String>] + [-AttendeeIdentityMasking <String>] + [-AudibleRecordingNotification <String>] + [-AutoAdmittedUsers <String>] + [-AutoRecording <String>] + [-AutomaticallyStartCopilot <String>] + [-BlockedAnonymousJoinClientTypes <List>] + [-CaptchaVerificationForMeetingJoin <String>] + [-ChannelRecordingDownload <String>] + [-Confirm] + [-ConnectToMeetingControls <String>] + [-ContentSharingInExternalMeetings <String>] + [-Copilot <String>] + [-CopyRestriction <Boolean>] + [-Description <String>] + [-DesignatedPresenterRoleMode <String>] + [-DetectSensitiveContentDuringScreenSharing <Boolean>] + [-EnrollUserOverride <String>] + [-ExplicitRecordingConsent <String>] + [-ExternalMeetingJoin <String>] + [-Force] + [-InfoShownInReportMode <String>] + [-IPAudioMode <String>] + [-IPVideoMode <String>] + [-LiveCaptionsEnabledType <String>] + [-LiveInterpretationEnabledType <String>] + [-LiveStreamingMode <String>] + [-LobbyChat <String> ] + [-MediaBitRateKb <UInt32>] + [-MeetingChatEnabledType <String>] + [-MeetingInviteLanguages <String>] + [-NewMeetingRecordingExpirationDays <Int32>] + [-NoiseSuppressionForDialInParticipants <String>] + [-ParticipantNameChange <String>] + [-PreferredMeetingProviderForIslandsMode <String>] + [-QnAEngagementMode <String>] + [-RecordingStorageMode <String>] + [-RoomAttributeUserOverride <String>] + [-RoomPeopleNameUserOverride <String>] + [-ScreenSharingMode <String>] + [-SmsNotifications <String>] + [-SpeakerAttributionMode <String>] + [-StreamingAttendeeMode <String>] + [-TeamsCameraFarEndPTZMode <String>] + [-Tenant <Guid>] + [-UsersCanAdmitFromLobby <String>] + [-VideoFiltersMode <String>] + [-VoiceIsolation <String>] + [-VoiceSimulationInInterpreter <string>] + [-WatermarkForAnonymousUsers <String>] + [-WatermarkForCameraVideoOpacity <Int32>] + [-WatermarkForCameraVideoPattern <String>] + [-WatermarkForScreenSharingOpacity <Int32>] + [-WatermarkForScreenSharingPattern <String>] + [-AllowedUsersForMeetingDetails <String>] + [-RealTimeText <String>] + [-WhatIf] + [-WhoCanRegister <String>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +The Set-CsTeamsMeetingPolicy cmdlet allows administrators to update existing meeting policies that can be assigned to particular users to control Teams features related to meetings. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Set-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True +``` + +The command shown in Example 1 uses the Set-CsTeamsMeetingPolicy cmdlet to update an existing meeting policy with the Identity SalesMeetingPolicy. +This policy will use all the existing values except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. + +### EXAMPLE 2 + +```powershell +Set-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False +``` + +In Example 2, the Set-CsTeamsMeetingPolicy cmdlet is used to update a meeting policy with the Identity HrMeetingPolicy. +In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. +All other policy properties will use the existing values. + +### EXAMPLE 3 + +```powershell +Set-CsTeamsMeetingPolicy -Identity NonEVNetworkRoamingPolicy -AllowNetworkConfigurationSettingsLookup $True +``` + +In Example 3, the Set-CsTeamsMeetingPolicy cmdlet is used to update an existing meeting policy with the Identity NonEVNetworkRoamingPolicy. +This policy will use all the existing values except one: AllowNetworkConfigurationSettingsLookup; in this example, we will fetch network roaming policy for the non-EV user with NonEVNetworkRoamingPolicy based on his current network location. + +## PARAMETERS + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnnotations + +This setting will allow admins to choose which users will be able to use the Annotation feature. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToDialOut + +Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToJoinMeeting +> [!NOTE] +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check <https://learn.microsoft.com/microsoftteams/meeting-settings-in-teams> for details. + +Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToStartMeeting +Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowAvatarsInGallery + +If admins disable avatars in 2D meetings, then users cannot represent themselves as avatars in the Gallery view. This does not disable avatars in Immersive view. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCarbonSummary + +This setting will enable Tenant Admins to enable/disable the sharing of location data necessary to provide the end of meeting carbon summary screen for either the entire tenant or for a particular user. +If set to True the meeting organizer will share their location to the client of the participant to enable the calculation of distance and the resulting carbon. + +> [!NOTE] +> Location data will not be visible to the organizer or participants in this case and only carbon avoided will be shown. +If set to False then organizer location data will not be shown and no carbon summary screen will be displayed to the participants. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCartCaptionsScheduling +Determines whether a user can add a URL for captions from a Communications Access Real-Time Translation (CART) captioner for providing real time captions in meetings. +Possible values are: + +- **EnabledUserOverride**, CART captions is available by default but a user can disable. +- **DisabledUserOverride**, if you would like users to be able to use CART captions in meetings but by default it is disabled. +- **Disabled**, if you'd like to not allow CART captions in meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecording +Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDocumentCollaboration + +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEngagementReport +Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: + +- Enabled: allow the meeting organizer to download the report. +- Disabled: disable attendee report generation and prohibit meeting organizer from downloading it. +- ForceEnabled: enable attendee report generation and prohibit meeting organizer from disabling it. + +If set to Enabled or ForceEnabled, only meeting organizers and co-organizers will get a link to download the report in Teams. Regular attendees will have no access to it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalNonTrustedMeetingChat + +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalParticipantGiveRequestControl +Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveView + +If admins have disabled avatars, this does not disable using avatars in Immersive view on Teams desktop or web. Additionally, it does not prevent users from joining the Teams meeting on VR headsets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPAudio +Determines whether audio is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their audio. Set this to FALSE to prohibit the user from sharing their audio. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingCoach +This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. + If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. + If set to False, then users will not have the option to turn on Meeting Coach during calls. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. + +Possible values: + +- True +- False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOrganizersToOverrideLobbySettings +This parameter has been deprecated and currently has no effect. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOutlookAddIn +Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateMeetNow +This setting controls whether a user can start an ad hoc private meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPSTNUsersToBypassLobby +Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to **True**, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRecordingStorageOutsideRegion +Allows storing recordings outside of the region. All meeting recordings will be permanently stored in another region, and can't be migrated. This does not apply to recordings saved in OneDrive or SharePoint. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowScreenContentDigitization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSharedNotes +Determines whether users are allowed to take shared Meeting notes. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTasksFromTranscript + +This policy setting allows for the extraction of AI-Assisted Action Items/Tasks from the Meeting Transcript. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTrackingInReport +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscription +Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext + +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserToJoinExternalMeeting +Currently, this parameter has no effect. + +Possible values are: + +- Enabled +- FederatedOnly +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalNonTrustedMeetingChat +This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWhiteboard +Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: + +- \<blank\> +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnonymousUserAuthenticationMethod +Determines how anonymous users will be authenticated when joining a meeting. +Possible values are: + +- **OneTimePasscode**, if you would like anonymous users to be sent a one time passcode to their email when joining a meeting +- **None**, if you would like to disable authentication for anonymous users joining a meeting + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: OneTimePasscode +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttendeeIdentityMasking + +This setting will allow admins to enable or disable Masked Attendee mode in Meetings. +Masked Attendee meetings will hide attendees' identifying information (e.g., name, contact information, profile photo). + +Possible Values: Enabled: Hides attendees' identifying information in meetings. Disabled: Does not allow attendees' to hide identifying information in meetings + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudibleRecordingNotification + +The setting controls whether recording notification is played to all attendees or just PSTN users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRecording + +This setting allows admins to control the visibility of the auto recording feature in the organizer's **Meeting options**. If the you enable this setting, the **Record and transcribe automatically** setting appears in **Meeting options** with the default value set to **Off** (except for webinars and townhalls). Organizers need to manually toggle this setting to **On** to for their meetings to be automatically recorded. If you disable this setting, **Record and transcribe automatically** is hidden, preventing organizers from setting any meetings to be auto-recorded. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAdmittedUsers +Determines what types of participants will automatically be added to meetings organized by this user. +Possible values are: + +- **EveryoneInCompany**, if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. +- **EveryoneInSameAndFederatedCompany**, if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. +- **Everyone**, if you'd like to admit anonymous users by default. +- **OrganizerOnly**, if you would like that only meeting organizers can bypass the lobby. +- **EveryoneInCompanyExcludingGuests**, if you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately. +- **InvitedUsers**, if you would like that only meeting organizers and invited users can bypass the lobby. + +This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticallyStartCopilot +> [!NOTE] +> This feature has not been fully released yet, so the setting will have no effect. + +This setting gives admins the ability to auto-start Copilot. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedAnonymousJoinClientTypes +A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. + +The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Empty List +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaptchaVerificationForMeetingJoin +Require a verification check for meeting join. + +Possible values: +- **NotRequired**, CAPTCHA not required to join the meeting +- **AnonymousUsersAndUntrustedOrganizations**, Anonymous users and people from untrusted organizations must complete a CAPTCHA challenge to join the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelRecordingDownload +Controls how channel meeting recordings are saved, permissioned, and who can download them. + +Possible values: + +- Allow - Saves channel meeting recordings to a "Recordings" folder in the channel. The permissions on the recording files will be based on the Channel SharePoint permissions. This is the same as any other file uploaded for the channel. +- Block - Saves channel meeting recordings to a "Recordings\View only" folder in the channel. Channel owners will have full rights to the recordings in this folder, but channel members will have read access without the ability to download. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Allow +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSharingInExternalMeetings +This policy allows admins to determine whether the user can share content in meetings organized by external organizations. The user should have a Teams Premium license to be protected under this policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +This setting allows the admin to choose whether Copilot will be enabled with a persisted transcript or a non-persisted transcript. + +Possible values are: + +- Enabled +- EnabledWithTranscript + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyRestriction +This parameter enables a setting that controls a meeting option which allows users to disable right-click or Ctrl+C to copy, Copy link, Forward message, and Share to Outlook for meeting chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the meeting policy. +For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedPresenterRoleMode +Determines if users can change the default value of the _Who can present?_ setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings. + +Possible values are: + +- EveryoneUserOverride: All meeting participants can be presenters. This is the default value. This parameter corresponds to the _Everyone_ setting in Teams. +- EveryoneInCompanyUserOverride: Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the _People in my organization_ setting in Teams. +- EveryoneInSameAndFederatedCompanyUserOverride: Authenticated users in the organization, including guest users and users from federated organizations, can be presenters. This parameter corresponds to the _People in my organization and trusted organizations_ setting in Teams. +- OrganizerOnlyUserOverride: Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the _Only me_ setting in Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetectSensitiveContentDuringScreenSharing + +Allows the admin to enable sensitive content detection during screen share. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollUserOverride +Turn on/off Biometric enrollment +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitRecordingConsent +Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. + +Possible Values: + +- Enabled: Explicit consent, requires participant agreement. +- Disabled: Implicit consent, does not require participant agreement. +- LegitimateInterest: Legitimate interest, less restrictive consent to meet legitimate interest without requiring explicit agreement from participants. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMeetingJoin +Determines whether the user is allowed to join external meetings. + +Possible values are: + +- EnabledForAnyone +- EnabledForTrustedOrgs +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledForAnyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfoShownInReportMode + +This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMode +Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMode +Determines whether video can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming video in the meeting. Set this to DISABLED to prohibit outgoing and incoming video in the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveInterpretationEnabledType +Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. +Possible values are: + +- **DisabledUserOverride**, if you would like users to be able to use interpretation in meetings but by default it is disabled. +- **Disabled**, prevents the option to be enabled in Meeting Options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveStreamingMode +Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP). + +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LobbyChat + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether chat messages are allowed in the lobby. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingChatEnabledType +Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. + +> [!NOTE] +> Due to a new feature rollout, in order to set the value of MeetingChatEnabledType to Disabled, you will need to also set the value of LobbyChat to disabled. e.g., +> Install-Module MicrosoftTeams -RequiredVersion 6.6.1-preview -Force -AllowClobber -AllowPrereleaseConnect-MicrosoftTeams Set-CsTeamsMeetingPolicy -Identity Global -MeetingChatEnabledType Disabled -LobbyChat Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInviteLanguages +Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. + +> [!NOTE] +> All Teams supported languages can be specified using language codes. For more information about its delivery date, see the [roadmap (Feature ID: 81521)](https://www.microsoft.com/microsoft-365/roadmap?filters=&searchterms=81521). + +The preliminary list of available languages is shown below: + +`ar-SA,az-Latn-AZ,bg-BG,ca-ES,cs-CZ,cy-GB,da-DK,de-DE,el-GR,en-GB,en-US,es-ES,es-MX,et-EE,eu-ES,fi-FI,fil-PH,fr-CA,fr-FR,gl-ES,he-IL,hi-IN,hr-HR,hu-HU,id-ID,is-IS,it-IT,ja-JP,ka-GE,kk-KZ,ko-KR,lt-LT,lv-LV,mk-MK,ms-MY,nb-NO,nl-NL,nn-NO,pl-PL,pt-BR,pt-PT,ro-RO,ru-RU,sk-SK,sl-SL,sq-AL,sr-Latn-RS,sv-SE,th-TH,tr-TR,uk-UA,vi-VN,zh-CN,zh-TW`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewMeetingRecordingExpirationDays +Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. Value can also be -1 to set meeting recordings to never expire. + +> [!NOTE] +> You may opt to set Meeting Recordings to never expire by entering the value -1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -NoiseSuppressionForDialInParticipants + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Control Noises Supression Feature for PST legs joining a meeting. + +Possible Values: + +- MicrosoftDefault +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParticipantNameChange + +This setting will enable Tenant Admins to turn on/off participant renaming feature. + +Possible Values: +Enabled: Turns on the Participant Renaming feature. +Disabled: Turns off the Participant Renaming feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMeetingProviderForIslandsMode +Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TeamsAndSfb +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QnAEngagementMode + +This setting enables Microsoft 365 Tenant Admins to Enable or Disable the Questions and Answers experience (Q+A). + When Enabled, Organizers can turn on Q+A for their meetings. When Disabled, Organizers cannot turn on Q+A in their meetings. + The setting is enforced when a meeting is created or is updated by Organizers. + Attendees can use Q+A in meetings where it was previously added. Organizers can remove Q+A for those meetings through Teams and Outlook Meeting Options. +Possible values: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingStorageMode +This parameter can take two possible values: + +- Stream +- OneDriveForBusiness + +> [!NOTE] +> The change of storing Teams meeting recordings from Classic Stream to OneDrive and SharePoint (ODSP) has been completed as of August 30th, 2021. All recordings are now stored in ODSP. This change overrides the RecordingStorageMode parameter, and modifying the setting in PowerShell no longer has any impact. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomAttributeUserOverride +Possible values: + +- Off +- Distinguish +- Attribute + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomPeopleNameUserOverride + +Enabling people recognition requires the tenant CsTeamsMeetingPolicy roomPeopleNameUserOverride to be "On" and roomAttributeUserOverride to be Attribute for allowing individual voice and face profiles to be used for recognition in meetings. + +> [!NOTE] +> In some locations, people recognition can't be used due to local laws or regulations. +Possible values: +> +> - Off: No People Recognition option on Microsoft Teams Room (Default). +> - On: Policy value allows People recognition option on Microsoft Teams Rooms under call control bar. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScreenSharingMode +Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmsNotifications +Participants can sign up for text message meeting reminders. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionMode +Determines if users are identified in transcriptions and if they can change the value of the _Automatically identify me in meeting captions and transcripts_ setting. + +Possible values: + +- **Enabled**: Speakers are identified in transcription. +- **EnabledUserOverride**: Speakers are identified in transcription. If enabled, users can override this setting and choose not to be identified in their Teams profile settings. +- **DisabledUserOverride**: Speakers are not identified in transcription. If enabled, users can override this setting and choose to be identified in their Teams profile settings. +- **Disabled**: Speakers are not identified in transcription. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingAttendeeMode + +Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality). + +Possible values are: + +- Disabled +- Enabled + +Set this to Enabled to allow up to 20,000 extra view-only attendees to join. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCameraFarEndPTZMode +Possible values are: + +- Disabled +- AutoAcceptInTenant +- AutoAcceptAll + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanAdmitFromLobby + +This policy controls who can admit from the lobby. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoFiltersMode +Determines the background effects that a user can configure in the Teams client. Possible values are: + +- NoFilters: No filters are available. +- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://learn.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). +- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. +- AllFilters: All filters are available, including custom images. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceIsolation +Determines whether you provide support for your users to enable voice isolation in Teams meeting calls. + +Possible values are: +- Enabled (default) +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForAnonymousUsers + +Determines the meeting experience and watermark content of an anonymous user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoOpacity + +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoPattern + +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingOpacity + +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingPattern + +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhoCanRegister +Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts set the value to 'EveryoneInCompany'. + +Possible values: + +- Everyone +- EveryoneInCompany + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..e9a319c5d3 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell + Set-CsTeamsMeetingTemplatePermissionPolicy [-Identity] <string> [-HiddenMeetingTemplates <PSListModifier[HiddenMeetingTemplate]>] [-Description <string>] [-Force][-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Update any of the properties of an existing instance of the TeamsMeetingTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 - Updating the description of an existing policy + +```powershell +PS> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -Description "updated description" +``` + +Updates the description field of a policy. + +### Example 2 - Updating the hidden meeting template list of an existing policy + +```powershell +PS> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) +``` + +Updates the hidden meeting templates array. + +## PARAMETERS + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenMeetingTemplates + +The updated list of meeting template IDs to hide. +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). + +```yaml +Type: HiddenMeetingTemplate[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md new file mode 100644 index 0000000000..d7182ff633 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md @@ -0,0 +1,818 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsMessagingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsMessagingPolicy + +## SYNOPSIS +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsMessagingPolicy [[-Identity] <XdsIdentity>] + [-AllowChatWithGroup <Boolean>] + [-AllowCommunicationComplianceEndUserReporting <Boolean>] + [-AllowCustomGroupChatAvatars <Boolean>] + [-AllowExtendedWorkInfoInSearch <String>] + [-AllowFluidCollaborate <Boolean>] + [-AllowFullChatPermissionUserToDeleteAnyMessage <Boolean>] + [-AllowGiphy <Boolean>] + [-AllowGiphyDisplay <Boolean>] + [-AllowGroupChatJoinLinks <Boolean>] + [-AllowImmersiveReader <Boolean>] + [-AllowMemes <Boolean>] + [-AllowOwnerDeleteMessage <Boolean>] + [-AllowPasteInternetImage <Boolean>] + [-AllowPriorityMessages <Boolean>] + [-AllowRemoveUser <Boolean>] + [-AllowSecurityEndUserReporting <Boolean>] + [-AllowSmartCompose] <Boolean>] + [-AllowSmartReply <Boolean>] + [-AllowStickers <Boolean>] + [-AllowUrlPreviews <Boolean>] + [-AllowUserChat <Boolean>] + [-AllowUserDeleteChat <Boolean>] + [-AllowUserDeleteMessage <Boolean>] + [-AllowUserEditMessage <Boolean>] + [-AllowUserTranslation <Boolean>] + [-AllowVideoMessages <Boolean>] + [-AudioMessageEnabledType <AudioMessageEnabledTypeEnum>] + [-ChannelsInChatListEnabledType <ChannelsInChatListEnabledTypeEnum>] + [-ChatPermissionRole <String>] + [-Confirm] + [-CreateCustomEmojis <Boolean>] + [-DeleteCustomEmojis <Boolean>] + [-Description <String>] + [-DesignerForBackgroundsAndImages <DesignerForBackgroundsAndImagesTypeEnum>] + [-Force] + [-GiphyRatingType <String>] + [-InOrganizationChatControl <String>] + [-ReadReceiptsEnabledType <String>] + [-Tenant <Guid>] + [-UsersCanDeleteBotMessages <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsMessagingPolicy [-Instance <PSObject>] + [-AllowChatWithGroup <Boolean>] + [-AllowCommunicationComplianceEndUserReporting <Boolean>] + [-AllowCustomGroupChatAvatars <Boolean>] + [-AllowExtendedWorkInfoInSearch <String>] + [-AllowFluidCollaborate <Boolean>] + [-AllowFullChatPermissionUserToDeleteAnyMessage <Boolean>] + [-AllowGiphy <Boolean>] + [-AllowGiphyDisplay <Boolean>] + [-AllowGroupChatJoinLinks <Boolean>] + [-AllowImmersiveReader <Boolean>] + [-AllowMemes <Boolean>] + [-AllowOwnerDeleteMessage <Boolean>] + [-AllowPasteInternetImage <Boolean>] + [-AllowPriorityMessages <Boolean>] + [-AllowRemoveUser <Boolean>] + [-AllowSecurityEndUserReporting <Boolean>] + [-AllowSmartCompose] <Boolean>] + [-AllowSmartReply <Boolean>] + [-AllowStickers <Boolean>] + [-AllowUrlPreviews <Boolean>] + [-AllowUserChat <Boolean>] + [-AllowUserDeleteChat <Boolean>] + [-AllowUserDeleteMessage <Boolean>] + [-AllowUserEditMessage <Boolean>] + [-AllowUserTranslation <Boolean>] + [-AllowVideoMessages <Boolean>] + [-AudioMessageEnabledType <AudioMessageEnabledTypeEnum>] + [-ChannelsInChatListEnabledType <ChannelsInChatListEnabledTypeEnum>] + [-Confirm] + [-CreateCustomEmojis <Boolean>] + [-DeleteCustomEmojis <Boolean>] + [-Description <String>] + [-DesignerForBackgroundsAndImages <DesignerForBackgroundsAndImagesTypeEnum>] + [-Force] + [-GiphyRatingType <String>] + [-InOrganizationChatControl <String>] + [-ReadReceiptsEnabledType <String>] + [-Tenant <Guid>] + [-UsersCanDeleteBotMessages <Boolean>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet updates a Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false +``` + +In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. +All other policy properties will be left as previously assigned. + +### Example 2 + +```powershell +PS C:\> Get-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy | Set-CsTeamsMessagingPolicy -AllowGiphy $false -AllowMemes $false +``` + +In this example two different property values are configured for all teams messaging policies in the organization: AllowGiphy is set to false and AllowMemes is set to False. +All other policy properties will be left as previously assigned. + +## PARAMETERS + +### -Identity +Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. + +If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowChatWithGroup +This setting determines if users can chat with groups (Distribution, M365 and Security groups). +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCommunicationComplianceEndUserReporting +This setting determines if users can report offensive messages to their admin for Communication Compliance. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCustomGroupChatAvatars +These settings enables, disables updating or fetching custom group chat avatars for the users included in the messaging policy. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExtendedWorkInfoInSearch +This setting enables/disables showing company name and department name in search results for MTO users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFluidCollaborate +This field enables or disables Fluid Collaborate feature for users. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFullChatPermissionUserToDeleteAnyMessage +This setting determines if users with the 'Full permissions' role can delete any group or meeting chat message within their tenant. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphy +Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit. + +**Note**: [Optional Connected Experiences](https://learn.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for Giphys to be allowed. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphyDisplay +Determines if Giphy images should be displayed that had been already sent or received in chat. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGroupChatJoinLinks +This setting determines if users in a group chat can create and share join links for other users within the organization to join that chat. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveReader +Determines whether a user is allowed to use Immersive Reader for reading conversation messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMemes +Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOwnerDeleteMessage +Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPasteInternetImage +Determines if a user is allowed to paste internet-based images in compose. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPriorityMessages +Determines whether a user is allowed to send priority messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRemoveUser +Determines whether a user is allowed to remove a user from a conversation. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSecurityEndUserReporting +This setting determines if users can report any security concern posted in message to their admin. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartCompose +Turn on this setting to let a user get text predictions for chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Con nombre +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartReply +Turn this setting on to enable suggested replies for chat messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickers +Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUrlPreviews +Use this setting to turn automatic URL previewing on or off in messages. Set this to TRUE to turn on. Set this to FALSE to turn off. + +Note that [Optional Connected Experiences](https://learn.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for URL previews to be allowed. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserChat +Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their 1:1, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessage +Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. +If this value is set to FALSE, the team owner will not be able to delete their own messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessage +Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserTranslation +Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVideoMessages +This setting determines if users can create and send video messages. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioMessageEnabledType +Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels, ChatsOnly, Disabled. + +```yaml +Type: AudioMessageEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelsInChatListEnabledType +On mobile devices, enable to display favorite channels above recent chats. + +Possible values are: DisabledUserOverride, EnabledUserOverride. + +```yaml +Type: ChannelsInChatListEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChatPermissionRole +Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the environment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. + +```yaml +Type: String +Position: Named +Default value: Restricted +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateCustomEmojis +This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteCustomEmojis +These settings enable and disable the editing and deletion of custom emojis and reactions for the users included in the messaging policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of your policy to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignerForBackgroundsAndImages +This setting determines whether a user is allowed to create custom AI-powered backgrounds and images with MS Designer. + +Possible values are: Enabled, Disabled. + +```yaml +Type: DesignerForBackgroundsAndImagesTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GiphyRatingType +Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InOrganizationChatControl +This setting determines if chat regulation for internal communication in the tenant is allowed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadReceiptsEnabledType +Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanDeleteBotMessages +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md new file mode 100644 index 0000000000..483c23e72a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Set-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Set-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsMobilityPolicy [-Tenant <System.Guid>] [-Description <String>] [-IPVideoMobileMode <String>] + [-IPAudioMobileMode <String>] [[-Identity] <XdsIdentity>] [-MobileDialerPreference <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsMobilityPolicy [-Tenant <System.Guid>] [-Description <String>] [-IPVideoMobileMode <String>] + [-IPAudioMobileMode <String>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The Set-CsTeamsMobilityPolicy cmdlet allows administrators to update teams mobility policies. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsMobilityPolicy -Identity SalesPolicy -IPVideoMobileMode "WifiOnly +``` +The command shown in Example 1 uses the Set-CsTeamsMobilityPolicy cmdlet to update an existing teams mobility policy with the Identity SalesPolicy. This SalesPolicy will not have IPVideoMobileMode equal to "WifiOnly". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Bypasses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMobileMode +When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMobileMode +When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md new file mode 100644 index 0000000000..0e092c6abe --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsMultiTenantOrganizationConfiguration +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +author: samlyu +ms.author: samlyu +--- + +# Set-CsTeamsMultiTenantOrganizationConfiguration + +## SYNOPSIS + +This cmdlet configures the Multi-tenant Organization settings for the tenant. + +## SYNTAX + +``` +Set-CsTeamsMultiTenantOrganizationConfiguration + [[-Identity] <string>] + [-CopilotFromHomeTenant <Enabled/Disabled>] +``` + +## DESCRIPTION +The Set-CsTeamsMultiTenantOrganizationConfiguration cmdlet configures tenant settings for Multi-tenant Organizations. This includes the CopilotFromHomeTenant parameter, which determines if users in a Multi-Tenant Organization can use their Copilot license from their home tenant during cross-tenant meetings + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsMultiTenantOrganizationConfiguration -Identity Global -CopilotFromHomeTenant Disabled +``` + +Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "Disabled" for global as default. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsMultiTenantOrganizationConfiguration -Identity Global -CopilotFromHomeTenant Enabled + +``` + +Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "Enabled" for global as default. + +## PARAMETERS + +### -Identity +Identity of the Teams Multi-tenant Organization Setting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopilotFromHomeTenant +Setting value of the Teams Multi-tenant Organization Setting. CopilotFromHomeTenant controls user access to Copilot license in their home tenant during cross-tenant meetings. + +```yaml +Type: Boolean +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMultiTenantOrganizationConfiguration](Get-CsTeamsMultiTenantOrganizationConfiguration.md) diff --git a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md new file mode 100644 index 0000000000..f7d01f2e45 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md @@ -0,0 +1,125 @@ +--- +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: +manager: mreddy +schema: 2.0.0 +--- + +# Set-CsTeamsNetworkRoamingPolicy + +## SYNOPSIS + +Set-CsTeamsNetworkRoamingPolicy allows IT Admins to create or update policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +## SYNTAX + +``` +Set-CsTeamsNetworkRoamingPolicy [-Identity <XdsIdentity>] + [-AllowIPVideo <Boolean>] + [-Description <String>] + [-MediaBitRateKb <Integer>] + [-Tenant <System.Guid>] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates or creates new Teams Network Roaming Policies configured for use in your organization. + +The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. + +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). + +To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +PS C:\> Set-CsTeamsNetworkRoamingPolicy -Identity "RedmondRoaming" -AllowIPVideo $true -MediaBitRateKb 2000 -Description "Redmond campus roaming policy" +``` + +The command shown in Example 1 updates the teams network roaming policy with Identity "RedmondRoaming" with IP Video feature enabled, and the maximum media bit rate is capped at 2000 Kbps. + +## PARAMETERS + +### -Identity +Unique identifier of the policy to be modified. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. +Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. + +```yaml +Type: Integer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 50000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the policy to be edited. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md new file mode 100644 index 0000000000..b5598c89ee --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md @@ -0,0 +1,166 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy +title: Set-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS + +Modifies an existing Teams Notifications and Feeds Policy + +## SYNTAX + +```powershell +Set-CsTeamsNotificationAndFeedsPolicy [-Description <String>] [[-Identity] <String>] + [-SuggestedFeedsEnabledType <String>] [-TrendingFeedsEnabledType <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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/teams/Set-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md new file mode 100644 index 0000000000..fac26286e2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md @@ -0,0 +1,184 @@ +--- +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: <https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies>. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsPinnedApp [-Tenant <System.Guid>] [-Order <Int64>] [-Priority <Int32>] [[-Identity] <XdsIdentity>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTeamsPinnedApp [-Tenant <System.Guid>] [-Order <Int64>] [-Priority <Int32>] [-Instance <PSObject>] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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: <https://learn.microsoft.com/MicrosoftTeams/teams-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-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..f41ad5f975 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Set-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Set-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +Set-CsTeamsRecordingRollOutPolicy [-MeetingRecordingOwnership <String>] [-Identity] <String> [-Force] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The Set-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to update existing CsTeamsRecordingRollOutPolicy that can be assigned to particular users to control Teams recording storage place. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy -MeetingRecordingOwnership RecordingInitiator +``` + +The command shown in Example 1 uses the Set-CsTeamsMeetingPolicy cmdlet to update an existing CsTeamsRecordingRollOutPolicy with the Identity OrganizerPolicy. +This policy will set MeetingRecordingOwnership to RecordingInitiator; in this example, recordings for this policy group's users as organizer would get saved to recording initiators' own OneDrive. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingRecordingOwnership +Specifies where the meeting recording get stored. Possible values are: +- MeetingOrganizer +- RecordingInitiator + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..171a3e9cd7 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,225 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy +title: Set-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode <String>] [-Description <String>] [-Enabled <Boolean>] + [[-Identity] <String>] [-PlaceExternalCalls <String>] [-PlaceInternalCalls <String>] + [-ReceiveExternalCalls <String>] [-ReceiveInternalCalls <String>] [-MsftInternalProcessingMode <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md b/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md new file mode 100644 index 0000000000..455aab2ff0 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md @@ -0,0 +1,95 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp +title: Set-CsTeamsSettingsCustomApp +schema: 2.0.0 +--- + +# Set-CsTeamsSettingsCustomApp + +## SYNOPSIS +Set the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled <Boolean> + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True +``` + +Set the value of Custom Apps Setting to true. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -isSideloadedAppsInteractionEnabled +The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..31c805cfbb --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,197 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: + +--- + +# Set-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Use the Set-CsTeamsSharedCallingRoutingPolicy cmdlet to change a shared calling routing policy instance. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsSharedCallingRoutingPolicy [-Identity] <string> [-EmergencyNumbers <PSListModifier[string]>] + [-ResourceAccount <string>] [-Description <string>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams shared calling routing policy configures the caller ID for normal outbound PSTN and emergency calls made by users enabled for shared calling using this policy instance. + +The caller ID for normal outbound PSTN calls is the phone number assigned to the resource account specified in the policy instance. Typically this is the organization's main auto attendant phone number. Callbacks will go to the auto attendant and the PSTN caller can use the auto attendant to be transferred to the shared calling user. + +When a shared calling user makes an emergency call, the emergency services need to be able to make a direct callback to the user who placed the emergency call. One of the defined emergency numbers is used for this purpose as caller ID for the emergency call. It will be reserved for the next 60 minutes and any inbound call to that number will directly ring the shared calling user who made the emergency call. If no emergency numbers are defined, the phone number of the resource account will be used as caller ID. If no free emergency numbers are available, the first number in the list will be reused. + +The emergency call will contain the location of the shared calling user. The location will either be the dynamic emergency location obtained by the Teams client or if that is not available the static location assigned to the phone number of the resource account used in the shared calling policy instance. + +## EXAMPLES + +### Example 1 +``` +Set-CsTeamsSharedCallingRoutingPolicy -Identity Seattle -EmergencyNumbers @{remove='+14255556677'} +``` +The command shown in Example 1 removes the emergency callback number +14255556677 from the policy called Seattle. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the new policy instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyNumbers +An array of phone numbers used as caller ID on emergency calls. + +The emergency numbers must be routable for inbound PSTN calls, and for Calling Plan and Operator Connect phone numbers, must be available within the organization. + +The emergency numbers specified must all be of the same phone number type and country as the phone number assigned to the specified resource account. If the resource account has a Calling Plan service number assigned, the emergency numbers need to be Calling Plan subscriber numbers. + +The emergency numbers must be unique and can't be reused in other shared calling policy instances. The emergency numbers can't be assigned to any user or resource account. + +If no emergency numbers are configured, the phone number of the resource account will be used as Caller ID for the emergency call. + +```yaml +Type: System.Management.Automation.PSListModifier[String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +In some Calling Plan markets, you are not allowed to set the location on service numbers. In this instance, kindly contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +If you are attempting to use a resource account with an Operator Connect phone number assigned, kindly confirm support for Shared Calling with your operator. + +Shared Calling is not supported for Calling Plan service phone numbers in Romania, the Czech Republic, Hungary, Singapore, New Zealand, Australia, and Japan. A limited number of existing Calling Plan service phone numbers in other countries are also not supported for Shared Calling. For such service phone numbers, you should contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md new file mode 100644 index 0000000000..abbbb97e70 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md @@ -0,0 +1,133 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy +title: Set-CsTeamsShiftsAppPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Allows you to set or update properties of a Teams Shifts App Policy instance. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection <Boolean>] [[-Identity] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False +``` + +Change Settings on a Teams Shift App Policy (only works on Global policy) + +## PARAMETERS + +### -AllowTimeClockLocationDetection + +Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..dd1eca6bb1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -0,0 +1,467 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet sets an existing workforce management (WFM) connection. + +## SYNTAX + +### Set (Default) +```powershell +Set-CsTeamsShiftsConnection -ConnectionId <string> -Body <IUpdateWfmConnectionRequest> [-Authorization <string>] [-IfMatch <string>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] +[-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetExpanded +```powershell +Set-CsTeamsShiftsConnection -ConnectionId <string> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] + [-ConnectorSpecificSettings <IUpdateWfmConnectionRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] + [-State <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] +[-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +```powershell +Set-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] + [-ConnectorSpecificSettings <IUpdateWfmConnectionRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] [-State <string>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentity +```powershell +Set-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> -Body <IUpdateWfmConnectionRequest> [-Authorization <string>] +[-IfMatch <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] + [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates a Shifts WFM connection. It allows the admin to make changes to the settings such as the name and WFM URLs. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserName to be included. +This cmdlet can update every input field except -ConnectorId and -ConnectionId. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2" + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1" + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" + cookieAuthUrl = "https://contoso.com/retail/data/login" + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" + +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the instance with the specified -ConnectionId. Returns the object of the updated connection. + +In case of an error, you can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=<CMDLET>` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +### Example 2 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection - updated +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the instance with the specified -ConnectionId. Returns the object of the updated connection. + +In case of an error, you can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=<CMDLET>` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateWfmConnectionRequest +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: SetExpanded, Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the etag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connection name. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connector-specific settings. + +```yaml +Type: IUpdateWfmConnectionRequestConnectorSpecificSettings +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md new file mode 100644 index 0000000000..eb62460fc0 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -0,0 +1,547 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsShiftsConnectionInstance +author: leonardospina +ms.author: lespina +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsConnectionInstance + +## SYNOPSIS +This cmdlet updates a Shifts connection instance. + +## SYNTAX + +### Set (Default) +```powershell +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <string> -Body <IUpdateConnectorInstanceRequest> +[-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] +[-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetExpanded +```powershell +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] +[-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] +[-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] + [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +```powershell +Set-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] + [-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] +[-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] + [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentity +```powershell +Set-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> -IfMatch <string> -Body <IUpdateConnectorInstanceRequest> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. +This cmdlet can update every input field except -ConnectorId and -ConnectorInstanceId. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -connectorAdminEmail @() ` + -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` + -State "Active" ` + -syncFrequencyInMin "10" ` + -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` + -SyncScenarioOpenShift "FromWfmToShifts" ` + -SyncScenarioOpenShiftRequest "FromWfmToShifts" ` + -SyncScenarioShift "FromWfmToShifts" ` + -SyncScenarioSwapRequest "FromWfmToShifts" ` + -SyncScenarioTimeCard "FromWfmToShifts" ` + -SyncScenarioTimeOff "FromWfmToShifts" ` + -SyncScenarioTimeOffRequest "FromWfmToShifts" ` + -SyncScenarioUserShiftPreference "Disabled" + +PS C:\> $result.ToJsonString() +``` + +```output + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" +} + +``` + +Updates the instance with the specified -ConnectorInstanceId. Returns the object of the updated connector instance. + +In case of error, we can capture the error response as following: + +* Hold the cmdlet output in a variable: `$result=<CMDLET>` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +## PARAMETERS + +### -Body +The request body + +```yaml +Type: IConnectorInstanceRequest +Parameter Sets: Set, SetViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. + +```yaml +Type: String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorInstanceId +The Id of the connector instance to be updated. + +```yaml +Type: String +Parameter Sets: SetExpanded, Set +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the etag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncFrequencyInMin +The sync frequency in minutes. + +```yaml +Type: Int32 +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance) + +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md new file mode 100644 index 0000000000..6835a0dfa9 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md @@ -0,0 +1,220 @@ +--- +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 <String>] [-ShiftNoticeMessageType <String>] + [-ShiftNoticeMessageCustom <String>] [-AccessType <String>] [-AccessGracePeriodMinutes <Int64>] + [-EnableScheduleOwnerPermissions <Boolean>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md new file mode 100644 index 0000000000..2163f1d2f1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsSipDevicesConfiguration +author: anmandav +ms.author: anmandav +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsSipDevicesConfiguration + +## SYNOPSIS + +This cmdlet is used to manage the organization-wide Teams SIP devices configuration. + +## SYNTAX + +```powershell +Set-CsTeamsSipDevicesConfiguration [-BulkSignIn <String>] + [-Confirm] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet is used to manage the organization-wide Teams SIP devices configuration which contains settings that are applicable to SIP devices connected to Teams using Teams Sip Gateway. + +To execute the cmdlet, you need to hold a role within your organization such as Teams Administrator or Teams Communication Administrator. + +## EXAMPLES + +### Example 1 + +```powershell +Set-CsTeamsSipDevicesConfiguration -BulkSignIn "Enabled" +``` + +In this example, Bulk SignIn is set to Enabled across the organization. + +### Example 2 + +```powershell +Set-CsTeamsSipDevicesConfiguration -BulkSignIn "Disabled" +``` + +In this example, Bulk SignIn is set to Disabled across the organization. + +## PARAMETERS + +### -BulkSignIn +Indicates whether Bulk SingIn into Teams SIP devices is enabled or disabled for the common area phone (CAP) accounts across the organization. Possible values are **Enabled** and '**Disabled**. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..49fabb2ff1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,135 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance +title: Set-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Set-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Set-CsTeamsSurvivableBranchAppliance [-Description <String>] [[-Identity] <String>] [-Site <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..fe8cc3c54b --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,119 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy +title: Set-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Set-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns <Object>] [[-Identity] <String>] + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..f1e5d3000d --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md @@ -0,0 +1,204 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy +title: Set-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## SYNTAX + +```powershell +Set-CsTeamsTargetingPolicy [-CustomTagsMode <String>] [-Description <String>] [[-Identity] <String>] + [-ManageTagsPermissionMode <String>] [-ShiftBackedTagsMode <String>] [-SuggestedPresetTags <String>] + [-TeamOwnersEditWhoCanManageTagsMode <String>] [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled +``` + +The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomTagsMode + +Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageTagsPermissionMode + +Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftBackedTagsMode + +Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamOwnersEditWhoCanManageTagsMode + +Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..8aa49764df --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy +title: Set-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# Set-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Set-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate]>] + [-Description <String>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList +``` + +Updates the hidden templates array. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Adds a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The updated list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..64bcdc16c5 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule +applicable: Microsoft Teams +title: Set-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to modify an existing normalization rule. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsTranslationRule [[-Identity] <string>] [-Description <string>] [-Pattern <string>] [-Translation <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can use this cmdlet to modify an existing number manipulation rule. The rule can be used, for example, in the settings of your SBC (Set-CsOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsTranslationRule -Identity StripE164SeattleAreaCode -Pattern ^+12065555(\d{3})$ -Translation $1 +``` + +This example modifies the rule that initially configured to strip +1206555 from any E.164 ten digits number. For example, +12065555555 translated to 5555 to a new pattern. Modified rule now only applies to three digit number (initially to four digits number) and adds one more number in prefix (+120655555 instead of +1206555) + +## PARAMETERS + +### -Identity +Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A friendly description of the normalization rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Translation +The regular expression pattern that will be applied to the number to convert it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md new file mode 100644 index 0000000000..75ea8483a8 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md @@ -0,0 +1,166 @@ +--- +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] <string>] [-Description <string>] [-Pattern <string>] [-Target <string>] [-TargetType <string>] + [-TreatmentPriority <int>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..4567271d50 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,312 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Set-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Set-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to modify a Teams Update Management policy. + +## SYNTAX + +```powershell +Set-CsTeamsUpdateManagementPolicy + [-DisabledInProductMessages <System.Management.Automation.PSListModifier`1[System.String]>] + [-Description <String>] [-AllowManagedUpdates <Boolean>] [-AllowPreview <Boolean>] [-UpdateDayOfWeek <Int64>] + [-UpdateTime <String>] [-UpdateTimeOfDay <DateTime>] [-AllowPublicPreview <String>] + [-AllowPrivatePreview <AllowPrivatePreview>] [-UseNewTeamsClient <String>] + [-BlockLegacyAuthorization <Boolean>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. + + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" -DisabledInProductMessages @("91382d07-8b89-444c-bbcb-cfe43133af33") +``` + +In this example, the policy "Campaign Policy" is modified, disabling the in-product messages with the category "What's New". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: + +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowManagedUpdates + +Enables/Disables managed updates for the user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPreview + +Indicates whether all feature flags are switched on or off. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivatePreview + +This setting will allow admins to allow users in their tenant to opt in to Private Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is Forced, then users will be switched to Private Preview. + +```yaml +Type: AllowPrivatePreview +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPublicPreview + +This setting will allow admins to allow users in their tenant to opt in to Public Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is FollowOfficePreview, then users will not be able to opt in and instead follow their Office channel, and be switched to Public Preview if their Office channel is CC (Preview). The ring switcher UI will be hidden in the Desktop Client. This is not applicable to the Web Client. + If it is Forced, then users will be switched to Public Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization + +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. + If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. + If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDayOfWeek + + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTime + +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md new file mode 100644 index 0000000000..001f0dbe19 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration +applicable: Microsoft Teams +title: Set-CsTeamsUpgradeConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsUpgradeConfiguration + +## SYNOPSIS +Administrators can use Set-CsTeamsUpgradeConfiguration to manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsUpgradeConfiguration [-Tenant <Guid>] [-DownloadTeams <Boolean>] [-SfBMeetingJoinUx <String>] [-BlockLegacyAuthorization <Boolean>] + [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +```powershell +Set-CsTeamsUpgradeConfiguration [-Tenant <Guid>] [-DownloadTeams <Boolean>] [-SfBMeetingJoinUx <String>] [-BlockLegacyAuthorization <Boolean>] + [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +TeamsUpgradeConfiguration is used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. + +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. + +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: SkypeMeetingsApp and NativeLimitedClient. "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Set-CsTeamsUpgradeConfiguration -DownloadTeams $true -SfBMeetingJoinUx SkypeMeetingsApp +``` + +The above cmdlet specifies that users subject to upgrade should download Teams in the background, and that they should use the Skype For Business Meetings app to join Skype for Business meetings. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DownloadTeams +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` +### -SfBMeetingJoinUx +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +```yaml +Type: string +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: NativeLimitedClient +Accept pipeline input: False +Accept wildcard characters: False +``` +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +For internal use only. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +For internal use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. +If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. +If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES +These settings are only honored by newer versions of Skype for Business clients. + +## RELATED LINKS + +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) + +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) + +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..5c21d8c52c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy +title: Set-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +```powershell +Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings <Boolean>] [-DisableAudioVideoInCallsAndMeetings <Boolean>] + [-VDI2Optimization <String>] [-Identity] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..363ba6ac2f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy +title: Set-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +author: emmanuelrocha001 +ms.author: erocha +manager: sonaggarwal +--- + +# Set-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to update an instance of TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +``` +Set-CsTeamsVirtualAppointmentsPolicy [-EnableSmsNotifications <Boolean>] [-Identity] <String> [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of TeamsVirtualAppointmentsPolicy. + +## EXAMPLES + +### Example 1 + +```powershell +PS> Set-CsTeamsVirtualAppointmentsPolicy -Identity ExistingPolicyInstance -EnableSmsNotifications $false +``` + +Updates the `EnableSmsNotifications` field of a given policy. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSmsNotifications +This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md new file mode 100644 index 0000000000..e39d07bd9a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -0,0 +1,751 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy +title: Set-CsTeamsVoiceApplicationsPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsVoiceApplicationsPolicy + +## SYNOPSIS + +Modifies an existing Teams voice applications policy. + +## SYNTAX + +``` +Set-CsTeamsVoiceApplicationsPolicy + [-AllowAutoAttendantBusinessHoursGreetingChange <Boolean>] + [-AllowAutoAttendantAfterHoursGreetingChange <Boolean>] + [-AllowAutoAttendantHolidayGreetingChange <Boolean>] + [-AllowAutoAttendantBusinessHoursChange <Boolean>] + [-AllowAutoAttendantHolidaysChange <Boolean>] + [-AllowAutoAttendantTimeZoneChange <Boolean>] + [-AllowAutoAttendantLanguageChange <Boolean>] + [-AllowAutoAttendantBusinessHoursRoutingChange <Boolean>] + [-AllowAutoAttendantAfterHoursRoutingChange <Boolean>] + [-AllowAutoAttendantHolidayRoutingChange <Boolean>] + + [-AllowCallQueueWelcomeGreetingChange <Boolean>] + [-AllowCallQueueMusicOnHoldChange <Boolean>] + [-AllowCallQueueOverflowSharedVoicemailGreetingChange <Boolean>] + [-AllowCallQueueTimeoutSharedVoicemailGreetingChange <Boolean>] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange <bool>] + [-AllowCallQueueLanguageChange <Boolean>] + [-AllowCallQueueMembershipChange <Boolean>] + [-AllowCallQueueConferenceModeChange <Boolean>] + [-AllowCallQueueRoutingMethodChange <Boolean>] + [-AllowCallQueuePresenceBasedRoutingChange <Boolean>] + [-AllowCallQueueOptOutChange <Boolean>] + [-AllowCallQueueOverflowRoutingChange <Boolean>] + [-AllowCallQueueTimeoutRoutingChange <Boolean>] + [-AllowCallQueueNoAgentsRoutingChange <Boolean>] + [-AllowCallQueueAgentOptChange <Boolean>] + + [-CallQueueAgentMonitorMode <Disabled | Monitor | Whisper | Barge | Takeover>] + [-CallQueueAgentMonitorNotificationMode <Disabled | Agent>] + + [-RealTimeAutoAttendantMetricsPermission <string>] + [-RealTimeCallQueueMetricsPermission <string>] + [-RealTimeAgentMetricsPermission <string>] + + [-HistoricalAutoAttendantMetricsPermission <string>] + [-HistoricalCallQueueMetricsPermission <string>] + [-HistoricalAgentMetricsPermission <string>] + + [[-Identity] <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows admins in the organization to permit certain users to make changes to auto attendant and call queue configurations. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCallQueueOverflowSharedVoicemailGreetingChange $true +``` + +The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. + +## PARAMETERS + +### -AllowAutoAttendantBusinessHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantAfterHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidayGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidaysChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantTimeZoneChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantAfterHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidayRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueWelcomeGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueMusicOnHoldChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOverflowSharedVoicemailGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueMembershipChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueConferenceModeChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueRoutingMethodChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueuePresenceBasedRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOptOutChange + +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOverflowRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueTimeoutRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueNoAgentsRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueAgentOptChange + +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorMode + +PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. + +When set to `Monitor`, users affected by the policy will be allowed to monitor and listen to call sessions. + +When set to `Whisper`, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + +When set to `Barge`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + +When set to `Takeover`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorNotificationMode + +PARAMVALUE: Disabled | Agent + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. + +When set to `Agent`, users affected by the policy will be allowed to monitor agents during call sessions. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: + +-Identity global + +To refer to a per-user policy, use syntax similar to this: + +-Identity "SDA-Allow-All" + +If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the 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-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) + +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) + +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) + +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..1db49482a3 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,239 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy +title: Set-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet sets the Teams Workload Policy value for current tenant. + +## SYNTAX + +```powershell +Set-CsTeamsWorkLoadPolicy [-AllowCalling <Boolean>] [-AllowCallingPinned <Boolean>] [-AllowMeeting <Boolean>] + [-AllowMeetingPinned <Boolean>] [-AllowMessaging <Boolean>] [-AllowMessagingPinned <Boolean>] + [-Description <String>] [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled +``` + +This sets the Teams Workload Policy Global value of AllowCalling to disabled. + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Work Load Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..176485db17 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy +title: Set-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +author: artemiykozlov +ms.author: arkozlov +manager: prashibadkur +--- + +# Set-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to update an instance of TeamsWorkLocationDetectionPolicy. + +## SYNTAX + +``` +Set-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection <Boolean>] [-Identity] <String> [-Force] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of TeamsWorkLocationDetectionPolicy. + +## EXAMPLES + +### Example 1 + +```powershell +PS> Set-CsTeamsWorkLocationDetectionPolicy -Identity ExistingPolicyInstance -EnableWorkLocationDetection $true +``` + +Updates the `EnableWorkLocationDetection` field of a given policy. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWorkLocationDetection +This setting allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md new file mode 100644 index 0000000000..616604a4f9 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md @@ -0,0 +1,247 @@ +--- +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 +manager: roykuntz +--- + +# Set-CsTenantBlockedCallingNumbers + +## SYNOPSIS +Use the Set-CsTenantBlockedCallingNumbers cmdlet to set tenant blocked calling numbers setting. + +## SYNTAX + +``` +Set-CsTenantBlockedCallingNumbers [[-Identity] <String>] + [-Confirm] + [-Enabled <Object>] + [-Force] + [-InboundBlockedNumberPatterns <Object>] + [-InboundExemptNumberPatterns <Object>] + [-Instance <Object>] + [-Name <Object>] + [-Tenant <Object>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Microsoft Direct Routing, Operator Connect and Calling Plans supports blocking of inbound calls from the public switched telephone network (PSTN). This feature allows a tenant-global list of number patterns to be defined so that the caller ID of every incoming PSTN call to the tenant can be checked against the list for a match. If a match is made, an incoming call is rejected. + +The tenant blocked calling numbers includes a list of inbound blocked number patterns. Number patterns are managed through the CsInboundBlockedNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. + +The tenant blocked calling numbers also includes a list of number patterns exempt from call blocking. Exempt number patterns are managed through the CsInboundExemptNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. + +You can test your number blocking by using the Test-CsInboundBlockedNumberPattern command. + +The scope of tenant blocked calling numbers is global across the given tenant. This command-let can also turn on/off the blocked calling numbers setting at the tenant level. + +To get the current tenant blocked calling numbers setting, use Get-CsTenantBlockedCallingNumbers + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +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 -------------------------- +``` +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 -------------------------- +``` +Set-CsTenantBlockedCallingNumbers -InboundBlockedNumberPatterns @((New-CsInboundBlockedNumberPattern -Name "AnonymousBlockedPattern" -Enabled $true -Pattern "^(?!)Anonymous")) +``` + +This example sets the tenant blocked calling numbers with a new list of inbound blocked number patterns. There is a new InboundBlockedNumberPattern being created. The pattern name is "AnonymousBlockedPattern". The pattern is turned on. The pattern is a normalization rule which contains "Anonymous". + +Note that if the current InboundBlockedNumberPatterns already contains a list of patterns while a new pattern needs to be created, this example will wipe out the existing patterns and only add the new one. Please save the current InboundBlockedNumberPatterns list before adding new patterns. + +## 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The switch to turn on or turn off the blocked calling numbers setting. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch overrides the confirmation prompt displayed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundBlockedNumberPatterns +The InboundBlockedNumberPatterns parameter contains the list of InboundBlockedNumberPatterns. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundExemptNumberPatterns +The InboundExemptNumberPatterns parameter contains the list of InboundExemptNumberPatterns. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +This parameter allows you to provide a name to the TenantBlockedCallingNumbers setting. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsTenantDialPlan.md b/teams/teams-ps/teams/Set-CsTenantDialPlan.md new file mode 100644 index 0000000000..1df48b83dc --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantDialPlan.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan +applicable: Microsoft Teams +title: Set-CsTenantDialPlan +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTenantDialPlan + +## SYNOPSIS +Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantDialPlan [[-Identity] <string>] [-Description <string>] [-NormalizationRules <Object>] + [-SimpleName <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Set-CsTenantDialPlan` cmdlet modifies an existing tenant dial plan. A tenant dial plan determines such things as which normalization rules are applied. Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. +The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. + +## EXAMPLES + +### Example 1 +``` +$nr2 = Get-CsVoiceNormalizationRule -Identity "US/US Long Distance" +Set-CsTenantDialPlan -Identity vt1tenantDialPlan9 -NormalizationRules @{Add=$nr2} +``` + +This example updates the vt1tenantDialPlan9 tenant dial plan to use the US/US Long Distance normalization rules. + +### Example 2 +``` +$DP = Get-CsTenantDialPlan -Identity Global +$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit") +$NR.Name = "RedmondRule" +Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRules +``` + +This example changes the name of a normalization rule. Keep in mind that changing the name also changes the name portion of the Identity. +The `Set-CsVoiceNormalizationRule` cmdlet doesn't have a Name parameter, so in order to change the name, we first call the `Get-CsTenantDialPlan` cmdlet to retrieve the Dial Plan with +the Identity Global and assign the returned object to the variable $DP. Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign the returned object to +the variable $NR. We then assign the string RedmondRule to the Name property of the object. Finally, we pass the variable back to the NormalizationRules parameter of the +`Set-CsTenantDialPlan` cmdlet to make the change permanent. + +### Example 3 +``` +$DP = Get-CsTenantDialPlan -Identity Global +$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit") +$DP.NormalizationRules.Remove($NR) +Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRules +``` + +This example removes a normalization rule. We utilize the same functionality as for Example 3 to manipulate the Normalization Rule Object and update it with the +`Set-CsTenantDialPlan` cmdlet. We first call the `Get-CsTenantDialPlan` cmdlet to retrieve the Dial Plan with the Identity Global and assign the returned object to the variable $DP. +Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign it to the variable $NR. Next, we remove this Object with the Remove Method from $DP.NormalizationRules. +Finally, we pass the variable back to the NormalizationRules parameter of the `Set-CsTenantDialPlan` cmdlet to make the change permanent. + +## PARAMETERS + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. +Maximum characters is 1040. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NormalizationRules +The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. + +The number of normalization rules cannot exceed 50 per TenantDialPlan. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleName +The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. + +This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), and parentheses (()). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. + +## RELATED LINKS + +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md b/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md new file mode 100644 index 0000000000..957f463b80 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md @@ -0,0 +1,564 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration +applicable: Microsoft Teams +title: Set-CsTenantFederationConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +ms.date: 12/11/2024 +--- + +# Set-CsTenantFederationConfiguration + +## SYNOPSIS +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. + +Manages federation configuration settings for your Skype for Business Online tenants. +These settings are used to determine which domains (if any) your users are allowed to communicate with. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantFederationConfiguration [-Tenant <Guid>] + [-AllowedDomains <IAllowedDomainsChoice>] [-BlockedDomains <List>] [-BlockAllSubdomains <Boolean>] + [-AllowFederatedUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>] + [-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>] [-RestrictTeamsConsumerToExternalUserProfiles <Boolean>] + [-AllowedDomainsAsAList <List>] [-ExternalAccessWithTrialTenants <ExternalAccessWithTrialTenantsType>] + [-AllowedTrialTenantDomains <List>] + [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>] + [-BlockedDomains <List>] [-BlockAllSubdomains <Boolean>] [-AllowFederatedUsers <Boolean>] + [-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>] [-RestrictTeamsConsumerToExternalUserProfiles <Boolean>] + [-AllowedDomainsAsAList <List>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +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: + +Whether or not users can communicate with people from other domains and if so, which domains they are allowed to communicate with. + +Whether or not users can communicate with people who have accounts on public IM and presence providers such as Windows Live, Skype, or people using Microsoft Teams with an account that's not managed by an organization. + +Administrators can use the `Set-CsTenantFederationConfiguration` cmdlet to enable and disable federation with other domains and federation with public providers. +In addition, this cmdlet can be used to expressly indicate the domains that users can communicate with and/or the domains that users are not allowed to communicate with. +However, administrators must use the `Set-CsTenantPublicProvider` cmdlet in order to indicate the public IM and presence providers that users can and cannot communicate with. + +## EXAMPLES + +### -------------------------- 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. +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 -------------------------- +``` +$x = New-CsEdgeDomainPattern -Domain "fabrikam.com" + +Set-CsTenantFederationConfiguration -BlockedDomains @{Remove=$x} +``` + +The commands shown in Example 3 remove fabrikam.com from the list of domains blocked by the current tenant. +To do this, the first command in the example uses the `New-CsEdgeDomainPattern` cmdlet to create a domain object for fabrikam.com. +The resulting domain object is then stored in a variable named $x. + +The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Remove method to remove fabrikam.com from the blocked domains list for the specified tenant. + +### -------------------------- Example 4 -------------------------- +``` +$x = New-CsEdgeDomainPattern -Domain "fabrikam.com" + +Set-CsTenantFederationConfiguration -BlockedDomains @{Add=$x} +``` + +The commands shown in Example 4 add the domain fabrikam.com to the list of domains blocked by the current tenant. +To add a new blocked domain, the first command in the example uses the `New-CsEdgeDomainPattern` cmdlet to create a domain object for fabrikam.com. +This object is stored in a variable named $x. + +After the domain object has been created, the second command then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Add method to add fabrikam.com to any domains already on the blocked domains list. + +### -------------------------- Example 5 -------------------------- +``` +Set-CsTenantFederationConfiguration -BlockedDomains $Null +``` + +Example 5 shows how you can remove all the domains assigned to the blocked domains list for the current tenant. +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 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") +Set-CsTenantFederationConfiguration -AllowedDomainsAsAList $list +``` + +Example 6 shows how you can replace domains in the Allowed Domains using a List collection object. +First, a List collection is created and domains are added to it, then, simply include the AllowedDomainsAsAList parameter and set the parameter value to the List object. +When this command completes, the allowed domains list will be replaced with those domains. + +### -------------------------- Example 7 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") +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 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") +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 -------------------------- +``` +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 ------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") +Set-CsTenantFederationConfiguration -BlockedDomains $list + +Set-CsTenantFederationConfiguration -BlockAllSubdomains $True +``` + +Example 10 shows how you can block all subdomains of domains in BlockedDomains list. +In this example, all users from contoso.com and fabrikam.com will be blocked. +When the BlockAllSubdomains is enabled, all users from all subdomains of all domains in BlockedDomains list will also be blocked. +So, users from subdomain.contoso.com and subdomain.fabrikam.com will be blocked. +Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain of contoso.com. + +### -------------------------- Example 11 ------------------------- +``` +Set-CsTenantFederationConfiguration -ExternalAccessWithTrialTenants "Allowed" +``` + +Example 11 shows how you can allow users to communicate with users in tenants that contain only trial licenses (default value is Blocked). + +### -------------------------- Example 12 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") + +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains $list +``` + +Using the `AllowedTrialTenantDomains` parameter, you can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. Example 12 shows how you can set or replace domains in the Allowed Trial Tenant Domains using a List collection object. +First, a List collection is created and domains are added to it, then, simply include the `AllowedTrialTenantDomains` parameter and set the parameter value to the List object. +When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains. + +### -------------------------- Example 13 -------------------------- +``` +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @("contoso.com", "fabrikam.com") +``` + +Example 13 shows another way to set a value of `AllowedTrialTenantDomains`. It uses array of objects and it always replaces value of the `AllowedTrialTenantDomains`. When this command completes, the result is the same as in example 12. + +The array of `AllowedTrialTenantDomains` can be emptied by running the following command: `Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @()`. + +### -------------------------- Example 14 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") + +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Add=$list} +``` + +Example 14 shows how you can add domains to the existing Allowed Trial Tenant Domains using a List collection object. +First, a List is created and domains are added to it, then, use the Add method in the `AllowedTrialTenantDomains` parameter to add the domains to the existing allowed domains list. +When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list. + +### -------------------------- Example 15 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") + +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Remove=$list} +``` + +Example 15 shows how you can remove domains from the existing Allowed Trial Tenant Domains using a List collection object. +First, a List is created and domains are added to it, then use the Remove method in the `AllowedTrialTenantDomains` parameter to remove the domains from the existing allowed domains list. +When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list. + +## PARAMETERS + +### -AllowedDomains +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. + +Note that string values cannot be passed directly to the AllowedDomains parameter. +Instead, you must create an object reference using the `New-CsEdgeAllowList` cmdlet or the `New-CsEdgeAllowAllKnownDomains` cmdlet and then use the object reference variable as the parameter value. + +The AllowedDomains parameter can support up to 4,000 domains. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTeamsConsumer +Allows federation with people using Teams with an account that's not managed by an organization. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +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. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockAllSubdomains +If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking. +If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored. +Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains. +But all subdomains for domains in this list will also be blocked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the collection of tenant federation configuration settings to be modified. +Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the `Set-CsTenantFederationConfiguration` cmdlet. +If you do choose to use the Identity parameter you must also include the Tenant parameter. +For example: + +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +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). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedDomainsAsAList +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: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAccessWithTrialTenants +When set to 'Blocked', all external access with users from Teams subscriptions that contain only trial licenses will be blocked. This means users from these trial-only tenants will not be able to reach to your users via chats, Teams calls, and meetings (using the users authenticated identity) and your users will not be able to reach users in these trial-only tenants. If this setting is set to "Blocked", users from the trial-only tenant will also be removed from existing chats. + +Allowed - Communication with other tenants is allowed based on other settings. + +Blocked - Communication with users in tenants that contain only trial licenses will be blocked. + +```yaml +Type: ExternalAccessWithTrialTenantsType +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTrialTenantDomains +You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list. + +Note: +- The list supports up to maximum 4k domains. +- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked. +- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictTeamsConsumerToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +The `Set-CsTenantFederationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object. + +## OUTPUTS + +### Output types +None. +Instead, the `Set-CsTenantFederationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object. + +## NOTES + +## RELATED LINKS + +[Get-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md b/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md new file mode 100644 index 0000000000..9008b4da94 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration +applicable: Microsoft Teams +title: Set-CsTenantMigrationConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsTenantMigrationConfiguration + +## SYNOPSIS +Used to enable or disable Meeting Migration Service (MMS). + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantMigrationConfiguration [[-Identity] <String>] + [-Confirm] + [-Force] + [-MeetingMigrationEnabled <Boolean>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +### Instance +``` +Set-CsTenantMigrationConfiguration [-Instance <Object>] + [-Confirm] + [-Force] + [-MeetingMigrationEnabled <Boolean>] + [-Tenant <Guid>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Used to enable or disable Meeting Migration Service (MMS). +For more information, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Set-CsTenantMigrationConfiguration -MeetingMigrationEnabled $false +``` + +This example disables MMS in the organization. + +## PARAMETERS + +### -Identity +Unique identifier for the Migration Configuration. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. +You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingMigrationEnabled +Set this to false to disable the Meeting Migration Service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Migration Configurations are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```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/Set-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md new file mode 100644 index 0000000000..7ec40da511 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion +applicable: Microsoft Teams +title: Set-CsTenantNetworkRegion +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTenantNetworkRegion + +## SYNOPSIS +As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantNetworkRegion [[-Identity] <string>] [-CentralSite <string>] [-Description <string>] + [-NetworkRegionID <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTenantNetworkRegion -Identity "RegionA" -Description "Region A" +``` + +The command shown in Example 1 sets the network region 'RegionA' with the description 'Region A'. + +## PARAMETERS + +### -Identity +Unique identifier for the network region to be set. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CentralSite +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network region to identify purpose of setting it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRegionID +The name of the network region. Not required in this PowerShell command. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) + +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) + +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md b/teams/teams-ps/teams/Set-CsTenantNetworkSite.md new file mode 100644 index 0000000000..9f97f7495e --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantNetworkSite.md @@ -0,0 +1,227 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTenantNetworkSite [[-Identity] <string>] [-Description <string>] [-EmergencyCallingPolicy <string>] [-EmergencyCallRoutingPolicy <string>] + [-EnableLocationBasedRouting <bool>] [-LocationPolicy <string>] [-NetworkRegionID <string>] [-NetworkRoamingPolicy <string>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. + +A best practice for Location Based Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration. In addition, network sites can also be used for configuring Network Roaming Policy capabilities. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTenantNetworkSite -Identity "MicrosoftSite1" -NetworkRegionID "RegionRedmond" -Description "Microsoft site 1" +``` + +The command shown in Example 1 set the network site 'MicrosoftSite1' with description 'Microsoft site 1'. + +The network region 'RegionRedmond' is created beforehand and 'MicrosoftSite1' will be associated with 'RegionRedmond'. + +### Example 2 +```powershell +PS C:\> Set-CsTenantNetworkSite -Identity "site2" -Description "site 2" -NetworkRegionID "RedmondRegion" -EnableLocationBasedRouting $true +``` + +The command shown in Example 2 sets the network site 'site2' with description 'site 2'. This site is enabled for LBR. The example associates the site with network region 'RedmondRegion'. + +### Example 3 +```powershell +PS C:\> Set-CsTenantNetworkSite -Identity "site3" -Description "site 3" -NetworkRegionID "RedmondRegion" -NetworkRoamingPolicy "TestNetworkRoamingPolicy" +``` + +The command shown in Example 3 sets the network site 'site3' with description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. + +## PARAMETERS + +### -Identity +Unique identifier for the network site to be set. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network site to identify purpose of setting it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyCallRoutingPolicy +This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLocationBasedRouting +This parameter determines whether the current site is enabled for Location-Based Routing. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationPolicy +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 +``` + +### -NetworkRegionID +NetworkRegionID is the identifier for the network region which the current network site is associating to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRoamingPolicy +NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) + +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) + +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md new file mode 100644 index 0000000000..52e3aea595 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md @@ -0,0 +1,157 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantNetworkSubnet [[-Identity] <string>] [-Description <string>] + [-MaskBits <int>] [-NetworkSiteID <string>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based Routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTenantNetworkSubnet -Identity "192.168.0.1" -MaskBits "24" -NetworkSiteID "site1" +``` + +The command shown in Example 1 set the network subnet '192.168.0.1'. The subnet is in IPv4 format, and the subnet is assigned to network site 'site1'. The maskbits is set to 24. + +IPv4 format subnet accepts maskbits from 0 to 32 inclusive. + +### Example 2 +```powershell +PS C:\> Set-CsTenantNetworkSubnet -Identity "2001:4898:e8:25:844e:926f:85ad:dd8e" -MaskBits "120" -NetworkSiteID "site1" -Description "Subnet 2001:4898:e8:25:844e:926f:85ad:dd8e" +``` + +The command shown in Example 2 set the network subnet '2001:4898:e8:25:844e:926f:85ad:dd8e' with description 'Subnet 2001:4898:e8:25:844e:926f:85ad:dd8e'. The subnet is in IPv6 format, and the subnet is assigned to network site 'site1'. The maskbits is set to 120. + +IPv6 format subnet accepts maskbits from 0 to 128 inclusive. + +## PARAMETERS + +### -Identity +Unique identifier for the network subnet to be set. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network subnet to identify purpose of setting it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) + +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) + +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md new file mode 100644 index 0000000000..8e93bf341c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md @@ -0,0 +1,211 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# 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. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantTrustedIPAddress [-Tenant <System.Guid>] [-MaskBits <System.Int32>] [-Description <String>] + [[-Identity] <XdsGlobalRelativeIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Instance +``` +Set-CsTenantTrustedIPAddress [-Tenant <System.Guid>] [-MaskBits <System.Int32>] [-Description <String>] + [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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. + +When the client is sending the trusted IP address, please make sure we have already whitelisted the IP address by running this command-let, otherwise the request will be rejected. If you are only adding the IPv4 address by running this command-let, but your client are only sending and IPv6 address, it will be rejected. + +## EXAMPLES + +###-------------------------- Example 1 -------------------------- +```powershell +PS C:\> Set-CsTenantTrustedIPAddress -Identity "192.168.0.1" -Description "External IP 192.168.0.1" +``` + +The command shown in Example 1 created the IP address '192.168.0.1' with description 'External IP 192.168.0.1'. + +###-------------------------- Example 2 -------------------------- +```powershell +PS C:\> Set-CsTenantTrustedIPAddress -Identity "192.168.0.2" -MaskBits "24" +``` + +The command shown in Example 2 set the IP address '192.168.0.2'. The IP address is in IPv4 format, and the maskbits is set to 24. + +IPv4 format IP address accepts maskbits from 0 to 32 inclusive. + +###-------------------------- Example 3 -------------------------- +```powershell +PS C:\> Set-CsTenantTrustedIPAddress -Identity "2001:4898:e8:25:844e:926f:85ad:dd8e" -Description "IPv6 IP address" +``` + +The command shown in Example 3 set the IP address '2001:4898:e8:25:844e:926f:85ad:dd8e' with description 'IPv6 IP address'. + +IPv6 format IP address accepts maskbits from 0 to 128 inclusive. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network site to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the IP address to be set. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. +You can retrieve this object reference by calling the `Get-CsTenantTrustedIPAddress` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaskBits +This parameter determines the length of bits to mask to the subnet. + +IPv4 format IP address accepts maskbits from 0 to 32 inclusive. IPv6 format IP address accepts maskbits from 0 to 128 inclusive. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose IP addresses are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsUser.md b/teams/teams-ps/teams/Set-CsUser.md new file mode 100644 index 0000000000..97f1298690 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsUser.md @@ -0,0 +1,442 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csuser +applicable: Microsoft Teams +title: Set-CsUser +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Set-CsUser + +## SYNOPSIS +Modifies Skype for Business properties for an existing user account. +Properties can be modified only for accounts that have been enabled for use with Skype for Business. +This cmdlet was introduced in Lync Server 2010. + +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + +## SYNTAX + +``` +Set-CsUser [-DomainController <Fqdn>] [-Identity] <UserIdParameter> [-PassThru] [-WhatIf] [-Confirm] + [-OnPremLineURI <String>] [-LineServerURI <String>] [-AudioVideoDisabled <Boolean>] + [-RemoteCallControlTelephonyEnabled <Boolean>] [-PrivateLine <String>] [-AcpInfo <AcpInfo>] + [-HostedVoiceMail <Boolean>] [-EnterpriseVoiceEnabled <Boolean>] + [-ExchangeArchivingPolicy <ExchangeArchivingPolicyOptionsEnum>] [-LineURI <String>] [-SipAddress <String>] + [-Enabled <Boolean>] [<CommonParameters>] +``` + +## DESCRIPTION +The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Microsoft Entra ID. +For example, you can disable or re-enable a user for Skype for Business Server; enable or disable a user for audio/video (A/V) communications; or modify a user's private line and line URI numbers. For Skype for Business online enable or disable a user for enterprise voice, hosted voicemail, or modify the user's on premise line uri. +The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business. + +The only attributes you can modify using the `Set-CsUser` cmdlet are attributes related to Skype for Business. +Other user account attributes, such as the user's job title or department, cannot be modified by using this cmdlet. +Keep in mind, however, that the Skype for Business attributes should only be modified by using the `Set-CsUser` cmdlet or the Skype for Business Server Control Panel. +You should not attempt to manually configure these attributes. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True +``` + +In Example 1, the `Set-CsUser` cmdlet is used to modify the user account with the Identity Pilar Ackerman. +In this case, the account is modified to enable Enterprise Voice, the Microsoft implementation of VoIP. +This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True. + +### -------------------------- Example 2 -------------------------- +```powershell +Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True +``` + +In Example 2, all the users in the Finance department have their accounts enabled for Enterprise Voice. +In this command, the `Get-CsUser` cmdlet and the LdapFilter parameter are first used to return a collection of all the users who work in the Finance department. +That information is then piped to the `Set-CsUser` cmdlet, which enables Enterprise Voice for each account in the collection. + +### -------------------------- Example 3 -------------------------- +```powershell +Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" +``` + +In Example 3, the `Set-CsUser` cmdlet is used to modify the user account with the Identity Pilar Ackerman. +In this case, the account is modified to set the phone number assigned to the user settings its LineUri property. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be modified. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the display name as the user Identity. +For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AudioVideoDisabled +Indicates whether the user is allowed to make audio/visual (A/V) calls by using Skype for Business. +If set to True, the user will largely be restricted to sending and receiving instant messages. + +You cannot disable A/V communications if a user is currently enabled for remote call control, Enterprise Voice, and/or Internet Protocol private branch exchange (IP-PBX) soft phone routing. + +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether or not the user has been enabled for Skype for Business Server. +If you set this value to False, the user will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the user's logon privileges. + +If you disable an account by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the user is enabled for Enterprise Voice and/or remote call control) is retained. +If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. +This differs from using the `Disable-CsUser` cmdlet to disable a user account. +When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data associated with that account is deleted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: CsEnabled +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Enables you to specify a domain controller to connect to when modifying a user account. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceEnabled +Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). +With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedVoiceMail +When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. +In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. + +**Note**: It is not required to set this parameter for Microsoft Teams users. Using this parameter has been deprecated for Microsoft Teams users in commercial and GCC cloud instances. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineURI +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. + +For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. + +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineServerURI +The URI of the remote call control telephone gateway assigned to the user. +The LineServerUri is the gateway URI, prefaced by "sip:". +For example: sip:rccgateway@litwareinc.com + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLine +Phone number for the user's private telephone line. +A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. +In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. +Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. + +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteCallControlTelephonyEnabled +Indicates whether the user has been enabled for remote call control telephony. +When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. +Phone calls can also be made using Skype for Business. +These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). +To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. +For details, see the parameter EnterpriseVoiceEnabled. + +To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SipAddress +Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. +The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user whose account is being modified. +By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. + +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcpInfo +Enables you to assign one or more third-party audio conferencing providers to a user. +However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. + +```yaml +Type: AcpInfo +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeArchivingPolicy +Indicates where the user's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving + +```yaml +Type: ExchangeArchivingPolicyOptionsEnum +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremLineURI +Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. +Depending on your setup, those two numbers could actually be different. +For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. +Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +The `Set-CsUser` cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. +The cmdlet also accepts pipelined instances of the Active Directory user object. + +## OUTPUTS + +### Output types +The `Set-CsUser` cmdlet does not return any objects. + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md b/teams/teams-ps/teams/Set-CsUserCallingDelegate.md new file mode 100644 index 0000000000..ac17aa7a8a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsUserCallingDelegate.md @@ -0,0 +1,144 @@ +--- +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 <String> -Delegate <String> [-MakeCalls <Boolean>] [-ReceiveCalls <Boolean>] [-ManageSettings <Boolean>] [<CommonParameters>] +``` + +## 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) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/teams/Set-CsUserCallingSettings.md new file mode 100644 index 0000000000..4b590f4ab2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsUserCallingSettings.md @@ -0,0 +1,414 @@ +--- +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 <String> [<CommonParameters>] +``` + +### ForwardingOnOff +```powershell +Set-CsUserCallingSettings -Identity <String> -IsForwardingEnabled <Boolean> [<CommonParameters>] +``` + +### Forwarding +```powershell +Set-CsUserCallingSettings -Identity <String> -IsForwardingEnabled <Boolean> -ForwardingType <String> [-ForwardingTarget <String>] -ForwardingTargetType <String> [<CommonParameters>] +``` + +### UnansweredOnOff +```powershell +Set-CsUserCallingSettings -Identity <String> -IsUnansweredEnabled <Boolean> [<CommonParameters>] +``` + +### Unanswered +```powershell +Set-CsUserCallingSettings -Identity <String> -IsUnansweredEnabled <Boolean> [-UnansweredTarget <String>] -UnansweredTargetType <String> -UnansweredDelay <String> [<CommonParameters>] +``` + +### CallGroup +```powershell +Set-CsUserCallingSettings -Identity <String> -CallGroupOrder <String> -CallGroupTargets <String[]> [<CommonParameters>] +``` + +### CallGroupMembership +```powershell +Set-CsUserCallingSettings -Identity <String> -GroupMembershipDetails <ICallGroupMembershipDetails[]> [<CommonParameters>] +``` + +### CallGroupNotification +```powershell +Set-CsUserCallingSettings -Identity <String> -GroupNotificationOverride <String> [<CommonParameters>] +``` + +## 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) diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md similarity index 80% rename from skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md index b160d529a3..87c3b8383b 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md @@ -1,9 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Set-CsVideoInteropServiceProvider schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsVideoInteropServiceProvider @@ -36,15 +41,15 @@ Use the Set-CsVideoInteropServiceProvider to update information about a supporte ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Set-CsVideoInteropServiceProvider -Identity cviprovider -AllowAppGuestJoinsAsAuthenticated $true ``` -{{ Add example description here }} +This example enables a VTC device joining anonymously to shown in the meeting as authenticated, for a supported CVI partner your organization uses. ## PARAMETERS ### -AadApplicationIds -This is an optional parameter. A semicolon separated list of AAD AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. +This is an optional parameter. A semicolon separated list of Microsoft Entra AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. ```yaml Type: String @@ -60,7 +65,7 @@ Accept wildcard characters: False ### -AllowAppGuestJoinsAsAuthenticated This is an optional parameter. Default = false. -This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots AAD application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. +This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots Microsoft Entra application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. ```yaml Type: Boolean @@ -196,14 +201,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-Team.md b/teams/teams-ps/teams/Set-Team.md index ade7ed2b63..ec7260f07c 100644 --- a/teams/teams-ps/teams/Set-Team.md +++ b/teams/teams-ps/teams/Set-Team.md @@ -1,31 +1,39 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/set-team title: Set-Team -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-Team ## SYNOPSIS -Note: This cmdlet is currently in Beta. - -Updates a team. +This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. ## SYNTAX ``` -Set-Team -GroupId <String> [-DisplayName <String>] [-Description <String>] [-Alias <String>] - [-Classification <String>] [-Visibility <String>] +Set-Team -GroupId <String> [-DisplayName <String>] [-Description <String>] [-MailNickName <String>] + [-Classification <String>] [-Visibility <String>] [-AllowGiphy <Boolean>] [-GiphyContentRating <String>] + [-AllowStickersAndMemes <Boolean>] [-AllowCustomMemes <Boolean>] [-AllowGuestCreateUpdateChannels <Boolean>] + [-AllowGuestDeleteChannels <Boolean>] [-AllowCreateUpdateChannels <Boolean>] [-AllowDeleteChannels <Boolean>] + [-AllowAddRemoveApps <Boolean>] [-AllowCreateUpdateRemoveTabs <Boolean>] + [-AllowCreateUpdateRemoveConnectors <Boolean>] [-AllowUserEditMessages <Boolean>] + [-AllowUserDeleteMessages <Boolean>] [-AllowOwnerDeleteMessages <Boolean>] [-AllowTeamMentions <Boolean>] + [-AllowChannelMentions <Boolean>] [-ShowInTeamsSearchAndSuggestions <Boolean>] [-AllowCreatePrivateChannels <Boolean>] [<CommonParameters>] ``` ## DESCRIPTION +This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. This cmdlet includes all settings that used to be set using the Set-TeamFunSettings, Set-TeamGuestSettings, etc. cmdlets + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-Team -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Updated TeamName" -Visibility Public ``` @@ -39,7 +47,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -56,7 +63,6 @@ Team Name Characters Limit - 256. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -73,7 +79,6 @@ Team Description Characters Limit - 1024. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -82,15 +87,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Alias -Same as displayName without any spaces. -Team Alias Characters Limit - 64 +### -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 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,13 +105,12 @@ Accept wildcard characters: False ``` ### -Classification -Team classification. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -123,7 +127,6 @@ Valid values are "Private" and "Public" Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,6 +135,278 @@ 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCustomMemes +Setting that determines whether or not members can use the custom memes functionality in teams. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphy +Setting that determines whether or not giphy can be used in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGuestCreateUpdateChannels +Setting that determines whether or not guests can create channels in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGuestDeleteChannels +Setting that determines whether or not guests can delete in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickersAndMemes +Setting that determines whether stickers and memes usage is allowed in the team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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) + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessages +Setting that determines whether or not members can delete messages that they have posted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessages +Setting that determines whether or not users can edit messages that they have posted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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" + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInTeamsSearchAndSuggestions +The parameter has been deprecated. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. + +```yaml +Type: Boolean +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -140,6 +415,6 @@ Accept wildcard characters: False ## RELATED LINKS -[Get-Team](Get-Team.md) +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[New-Team](New-Team.md) \ No newline at end of file +[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) diff --git a/teams/teams-ps/teams/Set-TeamArchivedState.md b/teams/teams-ps/teams/Set-TeamArchivedState.md new file mode 100644 index 0000000000..5b3b53ee89 --- /dev/null +++ b/teams/teams-ps/teams/Set-TeamArchivedState.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +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: +--- + +# Set-TeamArchivedState + +## SYNOPSIS +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. You can unarchive the team anytime. + +## SYNTAX + +``` +Set-TeamArchivedState -GroupId <String> -Archived <Boolean> [-SetSpoSiteReadOnlyForMembers <Boolean>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is used to freeze all of the team activity and also specify whether SharePoint site should be marked as Read-Only. +Teams administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true +``` + +This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived + +### Example 2 +```powershell +PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true -SetSpoSiteReadOnlyForMembers:$true +``` + +This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members. + +### Example 3 +```powershell +PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$false +``` + +This example unarchives the group with id 105b16e2-dc55-4f37-a922-97551e9e862d. + +## PARAMETERS + +### -Archived +Boolean value that determines whether or not the Team is archived. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +GroupId of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SetSpoSiteReadOnlyForMembers +Use this parameter switch to make the SharePoint site read-only for team members. + +```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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamChannel.md b/teams/teams-ps/teams/Set-TeamChannel.md index d8db61977c..14b6fa83e6 100644 --- a/teams/teams-ps/teams/Set-TeamChannel.md +++ b/teams/teams-ps/teams/Set-TeamChannel.md @@ -1,16 +1,17 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/set-teamchannel title: Set-TeamChannel -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-TeamChannel ## SYNOPSIS -Note: This cmdlet is currently in Beta. Update Team channels settings. @@ -18,16 +19,19 @@ Update Team channels settings. ``` Set-TeamChannel -GroupId <String> -CurrentDisplayName <String> [-NewDisplayName <String>] - [-Description <String>] + [-Description <String>] [<CommonParameters>] ``` ## DESCRIPTION +> [!IMPORTANT] +> Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here `https://www.poshtestgallery.com/packages/MicrosoftTeams`. + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayName TechReads -NewDisplayName "Technical Reads" +Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayName TechReads -NewDisplayName "Technical Reads" ``` ## PARAMETERS @@ -39,7 +43,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -55,7 +58,6 @@ Current channel name Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -73,7 +75,6 @@ Names must be 50 characters or less, and can't contain the characters # % & * { Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -90,7 +91,6 @@ Channel Description Characters Limit - 1024. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -99,6 +99,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -106,4 +109,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamFunSettings.md b/teams/teams-ps/teams/Set-TeamFunSettings.md index b1a92c81b3..b0c4f9d5ab 100644 --- a/teams/teams-ps/teams/Set-TeamFunSettings.md +++ b/teams/teams-ps/teams/Set-TeamFunSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamFunSettings -online version: +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 currently in Beta. +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. @@ -124,4 +127,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamGuestSettings.md b/teams/teams-ps/teams/Set-TeamGuestSettings.md index d88cf71e8a..97674abb46 100644 --- a/teams/teams-ps/teams/Set-TeamGuestSettings.md +++ b/teams/teams-ps/teams/Set-TeamGuestSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamGuestSettings -online version: +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 currently in Beta. +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. @@ -92,4 +95,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamMemberSettings.md b/teams/teams-ps/teams/Set-TeamMemberSettings.md index 72f0fd886c..0e21dfe1c8 100644 --- a/teams/teams-ps/teams/Set-TeamMemberSettings.md +++ b/teams/teams-ps/teams/Set-TeamMemberSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamMemberSettings -online version: +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 currently in Beta. +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. @@ -153,4 +156,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamMessagingSettings.md b/teams/teams-ps/teams/Set-TeamMessagingSettings.md index ec88b74c2a..eebbf86afa 100644 --- a/teams/teams-ps/teams/Set-TeamMessagingSettings.md +++ b/teams/teams-ps/teams/Set-TeamMessagingSettings.md @@ -3,14 +3,17 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamMessagingSettings -online version: +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 currently in Beta. +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. @@ -155,4 +158,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamPicture.md b/teams/teams-ps/teams/Set-TeamPicture.md index 2790419b1f..eeb537153b 100644 --- a/teams/teams-ps/teams/Set-TeamPicture.md +++ b/teams/teams-ps/teams/Set-TeamPicture.md @@ -1,35 +1,38 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -applicable: Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/set-teampicture title: Set-TeamPicture -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-TeamPicture ## SYNOPSIS -Note: This cmdlet is currently in Beta. Update the team picture. -Note: the command will return immediately, but the Teams application will not reflect the update immediately. +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 ``` -Set-TeamPicture -GroupId <String> -ImagePath <String> +Set-TeamPicture -GroupId <String> -ImagePath <String> [<CommonParameters>] ``` ## DESCRIPTION ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -Set-TeamPicture -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -ImagePath c:\Image\TeamPictire.png +Set-TeamPicture -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -ImagePath c:\Image\TeamPicture.png ``` ## PARAMETERS @@ -41,7 +44,6 @@ GroupId of the team Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -51,13 +53,12 @@ Accept wildcard characters: False ``` ### -ImagePath -File path and image (*.png,*.gif, *.jpg, or *.jpeg) +File path and image ( .png, .gif, .jpg, or .jpeg) ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -66,6 +67,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -73,4 +77,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md b/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md new file mode 100644 index 0000000000..4f8a952534 --- /dev/null +++ b/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams +title: Set-TeamTargetingHierarchy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- +# Set-TeamTargetingHierarchy + +## SYNOPSIS + +Upload a hierarchy to the tenant. A tenant may only have 1 active hierarchy. Each Set-TeamTargetingHierarchy cmdlet call will overwrite the previous one. + +## SYNTAX + +### Get (Default) +``` +Set-TeamTargetingHierarchyStatus [-FilePath <String>] [-ApiVersion <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +A sample CSV file uses the following format: + +`TargetName,ParentName,TeamId,Location:Clothing,Location:Jewelry,#Bucket1,#Bucket2`<br>`Apogee,,A8A6626F-87B3-4B8A-9469-47BCD1174673,0,0`<br>`New Jersey,Apogee,06763207-4F56-4DFE-96AE-4C7F9ADCFB43,0,0`<br>`Basking Ridge,NewJersey,5F44CC65-9521-4F7F-9099-64320153CA07,1,0`<br>`Mountain Lakes,NewJersey,58A21379-8E4D-4DA5-AA35-9CC188D8A998,0,1` + +Based on the CSV file, the following hierarchy is created: + +- Apogee +-    New Jersey +-       Basking Ridge +-       Mountain Lakes + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv + +Key Value +--- ----- +requestId c67e86109d88479e9708c3b7e8ff7217 +``` + +## PARAMETERS + +### -FilePath +Specifies the path to a CSV file that defines the hierarchy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: false +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-TeamTargetingHierarchyStatus](https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus) diff --git a/teams/teams-ps/teams/Set-TeamsApp.md b/teams/teams-ps/teams/Set-TeamsApp.md new file mode 100644 index 0000000000..3f493249cb --- /dev/null +++ b/teams/teams-ps/teams/Set-TeamsApp.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsapp +title: Set-TeamsApp +schema: 2.0.0 +--- + +# Set-TeamsApp + +## SYNOPSIS +Updates an app in the Teams tenant app store. + +## SYNTAX + +``` +Set-TeamsApp -Id <String> -Path <String> [<CommonParameters>] +``` + +## DESCRIPTION +Use a Teams app manifest zip file to upload an app to the tenant app store. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -Path c:\Path\SampleApp.zip +``` + +## PARAMETERS + +### -Id +The app's ID generated by Teams (different from the external ID) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The local path of the app manifest zip file, for use in New and Set + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md new file mode 100644 index 0000000000..81c1a3382e --- /dev/null +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig +title: Set-TeamsEnvironmentConfig +schema: 2.0.0 +author: VikneshMSFT +ms.author: vimohan +ms.reviewer: pbafna +manager: vinelap +--- + +# Set-TeamsEnvironmentConfig + +## SYNOPSIS + +Sets environment-specific configurations on the local machine and is used to connect to the right environment when running Connect-MicrosoftTeams. + +## SYNTAX + +``` +Set-TeamsEnvironmentConfig [-EndpointUris <Hashtable>] [-TeamsEnvironmentName <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet sets environment-specific configurations like endpoint URIs(such as Microsoft Entra ID and Microsoft Graph) and Teams environment (such as GCCH and DOD) on the local machine. + +When running Connect-MicrosoftTeams, environment-specific information set in this cmdlet will be considered unless overridden by Connect-MicrosoftTeams parameters. + +Parameters passed to Connect-MicrosoftTeams will take precedence over the information set by this cmdlet. + +Clear-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina +``` + +Sets the environment as Gallatin China on a local machine and when Connect-MicrosoftTeams is run, authentication will happen in the Gallatin China cloud and Microsoft Teams module will connect to the Gallatin environment. + +### Example 2 +```powershell +$endPointUriDict = @{ActiveDirectory = 'https://login.microsoftonline.us/';MsGraphEndpointResourceId = 'https://graph.microsoft.us/'} +Set-TeamsEnvironmentConfig -TeamsEnvironmentName $endPointUriDict +``` +Sets endpoint URIs required for special clouds. + +### Example 3 +```powershell +Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +$cred=get-credential +Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred +``` +This cmdlet is mainly introduced to support Skype for Business to Microsoft Teams user migration using Move-CsUser. + +This example shows how tenant admins can run Move-CsUser in Gallatin and other special clouds after setting the environment configuration using Set-TeamsEnvironmentConfig. + +Note that Set-TeamsEnvironmentConfig needs to be run only once for each machine. There is no need to run it each time before running Move-CsUser. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointUris +Provides custom endpoints. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEnvironmentName +Provides a Teams environment to connect to, for example, Teams GCCH or Teams DoD. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +Set-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Start-CsExMeetingMigration.md b/teams/teams-ps/teams/Start-CsExMeetingMigration.md new file mode 100644 index 0000000000..411d082929 --- /dev/null +++ b/teams/teams-ps/teams/Start-CsExMeetingMigration.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration +applicable: Microsoft Teams +title: Start-CsExMeetingMigration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Start-CsExMeetingMigration + +## SYNOPSIS +This cmdlet manually trigger a meeting migration request for the specified user. + +## SYNTAX + +``` +Start-CsExMeetingMigration [-SourceMeetingType <MmsSourceMeetingTypes>] [-TargetMeetingType <MmsTargetMeetingTypes>] [-Identity] <UserIdParameter> [<CommonParameters>] +``` + +## DESCRIPTION +Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. +MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. + +Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migration manually. For more information about requirements of the Meeting Migration Service (MMS), see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Start-CsExMeetingMigration -Identity ashaw@contoso.com -TargetMeetingType Teams +``` + +This example below shows how to initiate meeting migration for user ashaw@contoso.com so that all meetings are migrated to Teams. + +## PARAMETERS + +### -Identity +Specifies the Identity of the user account to be modified. A user identity can be specified by using one of four formats: +1. The user's SIP address +2. The user's user principal name (UPN) +3. The user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) +4. The user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMeetingType +The possible values are: +* **All:** indicates that both Skype for Business meetings and Teams meetings should be updated. This is the **default value**. +* **SfB:** indicates that only Skype for Business meetings (whether on-premises or online) should be updated. +* **Teams:** indicates that only Teams meetings should be updated. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: All +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetMeetingType +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. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Current +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## 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) + +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) + +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..8076e411c3 --- /dev/null +++ b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance +applicable: Microsoft Teams +title: Sync-CsOnlineApplicationInstance +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +manager: naveenv +ms.reviewer: +--- + +# Sync-CsOnlineApplicationInstance + +## SYNOPSIS +Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. + +## SYNTAX + +``` +Sync-CsOnlineApplicationInstance -ObjectId <guid> [-CallbackUri <string>] [-Force] [-ApplicationId <guid>] [-AcsResourceId <guid>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Microsoft Entra ID into Agent Provisioning Service. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +``` + +This example sync application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" and application ID "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" into Agent Provisioning Service. + +### -------------------------- Example 2 -------------------------- +```powershell +Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId 00000000-0000-0000-0000-000000000000 +``` +This command is helpful when there's already a mapping in Agent Provisioning Service and you want to set a different app ID value. In this case, when running the cmdlet in example 1, you will see `Sync-CsOnlineApplicationInstance : An item with the same key has already been added.`. + +The command removes the mapping for application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". Run the example cmdlet again to create the mapping in Agent Provisioning Service. + +## PARAMETERS + +### -CallbackUri +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The application instance ID. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md b/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md new file mode 100644 index 0000000000..1402626383 --- /dev/null +++ b/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-cseffectivetenantdialplan +applicable: Microsoft Teams +title: Test-CsEffectiveTenantDialPlan +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Test-CsEffectiveTenantDialPlan + +## SYNOPSIS +Use the Test-CsEffectiveTenantDialPlan cmdlet to test a tenant dial plan. + +## SYNTAX + +### Identity +``` +Test-CsEffectiveTenantDialPlan [-DialedNumber <PhoneNumber>] [-Identity <UserIdParameter>] [-TenantScopeOnly] + [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EffectiveTDPName +``` +Test-CsEffectiveTenantDialPlan -DialedNumber <PhoneNumber> [-EffectiveTenantDialPlanName <String>] + [-TenantScopeOnly] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Test-CsEffectiveTenantDialPlan` cmdlet normalizes the dialed number by applying the normalization rules from the effective tenant dial plan that is returned for the specified user. + +## EXAMPLES + +### -------------------------- 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 -------------------------- +``` +Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity adelev@contoso.onmicrosoft.com +``` + +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. + +```yaml +Type: PhoneNumber +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -EffectiveTenantDialPlanName +The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +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). + +```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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md new file mode 100644 index 0000000000..56da11fbfd --- /dev/null +++ b/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Test-CsInboundBlockedNumberPattern +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Test-CsInboundBlockedNumberPattern + +## SYNOPSIS +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +## SYNTAX + +``` +Test-CsInboundBlockedNumberPattern -PhoneNumber <String> [-TenantId <Guid>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Test-CsInboundBlockedNumberPattern -PhoneNumber "321321321" +``` + +Tests the "321321321" number to check if it will be blocked for inbound calls. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to be tested. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md b/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md new file mode 100644 index 0000000000..7d7fd3966d --- /dev/null +++ b/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Test-CsTeamsShiftsConnectionValidate +author: gucsun +ms.author: gucsun +manager: navinth +online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate +schema: 2.0.0 +--- + +# Test-CsTeamsShiftsConnectionValidate + +## SYNOPSIS + +This cmdlet validates workforce management (WFM) connection settings. + +## SYNTAX + +``` +Test-CsTeamsShiftsConnectionValidate -ConnectorId <string> -ConnectorSpecificSettings <IConnectorInstanceRequestConnectorSpecificSettings> -Name <string> [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet validates Workforce management (WFM) connection settings. It validates that the provided WFM account/password and required endpoints are set correctly. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $InstanceName = "test instance name" +PS C:\> $WfmUserName = "WfmUserName" +PS C:\> $plainPwd = "plainPwd" +PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest -Property @{ AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3"; SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4"; EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2"; RetailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1"; CookieAuthUrl = "https://contoso.com/retail/data/login"; FederatedAuthUrl = "https://contoso.com/retail/data/login"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName +``` + +Returns the list of conflicts if there are any. Empty result means there's no conflict. + +### Example 2 +```powershell +PS C:\> $InstanceName = "test instance name" +PS C:\> $WfmUserName = "WfmUserName" +PS C:\> $plainPwd = "plainPwd" +PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest -Property @{ apiUrl = "https://contoso.com/api"; ssoUrl = "https://contoso.com/sso"; appKey = "myAppKey"; clientId = "myClientId"; clientSecret = "PlaceholderForClientSecret"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName +``` + +Returns the list of conflicts if there are any. Empty result means there's no conflict. + +## PARAMETERS + +### -ConnectorId + +The ID of the shifts connector. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +The connector's instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connector specific settings. + +```yaml +Type: IConnectorInstanceRequestConnectorSpecificSettings +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..42891b66a8 --- /dev/null +++ b/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md @@ -0,0 +1,84 @@ +--- +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 <string>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +## EXAMPLES + +### Example 1 +```powershell +Test-CsTeamsTranslationRule -PhoneNumber 1234 +``` +```output +Identity Pattern PhoneNumberTranslated Translation +-------- ------- --------------------- ----------- +rule1 ^1234$ 4321 4321 +``` +This example displays information about the manipulation rule matching the phone number 1234. + +## PARAMETERS + +### -PhoneNumber +The phone number to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES +The cmdlet is available in Teams PowerShell Module 4.5.0 or later. + +The matching logic used in the cmdlet is the same as when the manipulation rule has been associated with an SBC and a call is being routed. + +If a match is found in two or more manipulation rules, the first one is returned. + +There is a short delay before newly created manipulation rules are added to the evaluation. + +## RELATED LINKS +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md new file mode 100644 index 0000000000..1682ef0ba6 --- /dev/null +++ b/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md @@ -0,0 +1,73 @@ +--- +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 +ms.author: osakande +schema: 2.0.0 +--- + +# Test-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. + +## SYNTAX + +``` +Test-CsTeamsUnassignedNumberTreatment -PhoneNumber <string> [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. If a match is found, the matching treatment is displayed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Test-CsTeamsUnassignedNumberTreatment -PhoneNumber "321321321" +``` + +Tests the "321321321" number to check if there is a matching unassigned number treatment. + +## PARAMETERS + +### -PhoneNumber +The phone number to be tested. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default Value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +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) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md b/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md new file mode 100644 index 0000000000..43647176a6 --- /dev/null +++ b/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule +applicable: Microsoft Teams +title: Test-CsVoiceNormalizationRule +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +--- + +# Test-CsVoiceNormalizationRule + +## SYNOPSIS +Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. +Voice normalization rules are typically used to convert a telephone dialing requirement (for example, you must dial 9 to access an outside line) to the E.164 phone +number format. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +``` +Test-CsVoiceNormalizationRule -DialedNumber <PhoneNumber> -NormalizationRule <NormalizationRule> + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet allows you to see the results of applying a voice normalization rule to a given telephone number. +Voice normalization rules are a required part of phone authorization and call routing. +They define the requirements for converting--or translating-- numbers from a format typically entered by users to a standard (E.164) format. +Use this cmdlet to troubleshoot dialing issues or to verify that rules will work as expected against given numbers. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" | Test-CsVoiceNormalizationRule -DialedNumber 14255559999 +``` + +For Lync or Skype for Business Server, this example runs a voice normalization test against the voice normalization rule with the Identity "global/11 digit number rule". +First the `Get-CsVoiceNormalizationRule` cmdlet is run to retrieve the rule with the Identity "global/11 digit number rule". +That rule object is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where the rule is tested against the telephone number 14255559999. +The output will be the DialedNumber after the voice normalization rule "global/11 digit number rule" has been applied. +If this rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) no value will be returned. + +### -------------------------- Example 2 -------------------------- +``` +$a = Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" +Test-CsVoiceNormalizationRule -DialedNumber 5551212 -NormalizationRule $a +``` + +For Lync or Skype for Business Server, example 2 is identical to Example 1 except that instead of piping the results of the Get operation directly to the Test cmdlet, the +object is first stored in the variable $a and then is passed as the value to the parameter NormalizationRule to be used as the voice normalization rule against which the +test will run. + +### -------------------------- Example 3 -------------------------- +``` +Get-CsVoiceNormalizationRule | Test-CsVoiceNormalizationRule -DialedNumber 2065559999 +``` + +For Lync or Skype for Business Server, this example runs a voice normalization test against all voice normalization rules defined within the Skype for Business +Server deployment. First the `Get-CsVoiceNormalizationRule` cmdlet is run (with no parameters) to retrieve all the voice normalization rules. +The collection of rules that is returned is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where each rule in the collection is tested against the telephone +number 2065559999. The output will be a list of translated numbers, one for each rule tested. +If a rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) there +will be a blank line in the list for that rule. + +### -------------------------- Example 4 -------------------------- +```powershell +$nr=(Get-CsTenantDialPlan -Identity dp1).NormalizationRules +$nr[0] +``` +```output +Description : +Pattern : ^(\d{4})$ +Translation : +1206555$1 +Name : nr1 +IsInternalExtension : False +``` +```powershell +Test-CsVoiceNormalizationRule -DialedNumber 1234 -NormalizationRule $nr[0] +``` +```output +TranslatedNumber +---------------- ++12065551234 +``` + +For Microsoft Teams, this example gets all the normalization rules in the tenant dial plan DP1, shows the first of these rules, and then test that rule on the +dialed number 1234. The output shows that the rule normalize the dialed number to +12065551234. + +## PARAMETERS + +### -DialedNumber +The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter. + +Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber + +```yaml +Type: PhoneNumber +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NormalizationRule +An object containing a reference to the normalization rule against which you want to test the number specified in the DialedNumber parameter. + +For Lync and Skype for Business Server, you can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. +For Microsoft Teams, you can retrieve voice normalization rules by calling the `Get-CsTenantDialPlan` cmdlet. + +```yaml +Type: NormalizationRule +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +Accepts pipelined input of voice normalization rule objects. + +## OUTPUTS + +### Output types +Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestResult. + +## NOTES + +## RELATED LINKS + +[New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md new file mode 100644 index 0000000000..a2f7712c39 --- /dev/null +++ b/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/unregister-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams +title: Unregister-CsOnlineDialInConferencingServiceNumber +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Unregister-CsOnlineDialInConferencingServiceNumber + +## SYNOPSIS +Unassigns the previously assigned service number as default Conference Bridge number. + +## SYNTAX + +``` +Unregister-CsOnlineDialInConferencingServiceNumber [-Identity] <String> [-BridgeId <Guid>] + [-BridgeName <String>] [-Tenant <Guid>] [-TenantDomain <String>] [-RemoveDefaultServiceNumber] + [-DomainController <Fqdn>] [-Force] [<CommonParameters>] +``` + +## DESCRIPTION +Unassigns the previously assigned service number as default Conference Bridge number. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Unregister-CsOnlineDialInConferencingServiceNumber -BridgeName "Conference Bridge" -RemoveDefaultServiceNumber 1234 +``` + +Unassigns the 1234 Service Number to the given Conference Bridge. + +## PARAMETERS + +### -Identity +PARAMVALUE: String + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +PARAMVALUE: ConferencingServiceNumber + +```yaml +Type: ConferencingServiceNumber +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BridgeId +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 +``` + +### -BridgeName +PARAMVALUE: String + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +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: DC +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDefaultServiceNumber +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 +``` + +### -TenantDomain +PARAMVALUE: String + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Update-CsAutoAttendant.md b/teams/teams-ps/teams/Update-CsAutoAttendant.md new file mode 100644 index 0000000000..e904781ef4 --- /dev/null +++ b/teams/teams-ps/teams/Update-CsAutoAttendant.md @@ -0,0 +1,93 @@ +--- +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 +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Update-CsAutoAttendant + +## SYNOPSIS +Use Update-CsAutoAttendant cmdlet to force an update of resources associated with an Auto Attendant (AA) provisioning. + +## SYNTAX + +```powershell +Update-CsAutoAttendant -Identity <String> [-Tenant <Guid>] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Update-CsAutoAttendant -Identity "6abea1cd-904b-520b-be96-1092cc096432" +``` + +In Example 1, the Update-CsAutoAttendant cmdlet is used to update all resources of an auto attendant with Identity of 6abea1cd-904b-520b-be96-1092cc096432. + +## PARAMETERS + +### -Identity +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 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Tenant + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +The Update-CsAutoAttendant cmdlet accepts a string as the Identity parameter. + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) + +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) + +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) + +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) diff --git a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md b/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md new file mode 100644 index 0000000000..b993377f9a --- /dev/null +++ b/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Update-CsCustomPolicyPackage +author: sunguchuan +ms.author: gucsun +manager: dasosby +online version: https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage +schema: 2.0.0 +--- + +# Update-CsCustomPolicyPackage + +## SYNOPSIS + +**Note:** This cmdlet is currently in private preview. + +This cmdlet updates a custom policy package. + +## SYNTAX + +``` +Update-CsCustomPolicyPackage -Identity <String> -PolicyList <String[]> [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet updates a custom policy package with new package settings. For more information on policy packages and the policy types available, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Update-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy" +``` + +Updates the custom package named "MyPackage" to have one policy in the package: a messaging policy of name "MyMessagingPolicy". +### Example 2 +```powershell +PS C:\> Update-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy", "TeamsMeetingPolicy, MyMeetingPolicy" -Description "My package" +``` + +Updates the custom package named "MyPackage" to have a description of "My package" and two policies in the package: a messaging policy of name "MyMessagingPolicy" and a meeting policy of name "MyMeetingPolicy". + +## PARAMETERS + +### -Identity + +The name of the custom package. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyList + +A list of one or more policies to be included in the updated package. To specify the policy list, follow this format: "\<PolicyType\>, \<PolicyName\>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the custom package. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +The resulting custom package's contents will be replaced by the new one instead of a union. Default packages created by Microsoft cannot be updated. + +## RELATED LINKS + +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) + +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) + +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Update-CsPhoneNumberTag.md b/teams/teams-ps/teams/Update-CsPhoneNumberTag.md new file mode 100644 index 0000000000..31d633d8dd --- /dev/null +++ b/teams/teams-ps/teams/Update-CsPhoneNumberTag.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/update-csphonenumbertag +applicable: Microsoft Teams +title: Update-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Update-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows admin to update existing telephone number tags. + +## SYNTAX + +``` +Update-CsPhoneNumberTag -NewTag <String> -Tag <String> [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to update existing tags for telephone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. An admin can get a list of all existing tags using [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Update-CsPhoneNumberTag -Tag "Redmond" -NewTag "Redmond HQ" +``` + +This example shows how to update an existing tag "Redmond" to "Redmond HQ" + +## PARAMETERS + +### -NewTag +This is the new tag. A tag can be maximum 50 characters long. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +This is the old tag which the admin wants to update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Update-CsTeamTemplate.md b/teams/teams-ps/teams/Update-CsTeamTemplate.md new file mode 100644 index 0000000000..67710e31ba --- /dev/null +++ b/teams/teams-ps/teams/Update-CsTeamTemplate.md @@ -0,0 +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 <String> -DisplayName <String> -ShortDescription <String> + [-App <ITeamsAppTemplate[]>] [-Category <String[]>] [-Channel <IChannelTemplate[]>] + [-Classification <String>] [-Description <String>] [-DiscoverySetting <ITeamDiscoverySettings>] + [-FunSetting <ITeamFunSettings>] [-GuestSetting <ITeamGuestSettings>] [-Icon <String>] + [-IsMembershipLimitedToOwner] [-MemberSetting <ITeamMemberSettings>] + [-MessagingSetting <ITeamMessagingSettings>] [-OwnerUserObjectId <String>] [-PublishedBy <String>] + [-Specialization <String>] [-TemplateId <String>] [-Uri <String>] [-Visibility <String>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update + +```powershell +Update-CsTeamTemplate -OdataId <String> -Body <ITeamTemplate> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentity + +```powershell +Update-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> -Body <ITeamTemplate> [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded + +```powershell +Update-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> -DisplayName <String> + -ShortDescription <String> [-App <ITeamsAppTemplate[]>] [-Category <String[]>] + [-Channel <IChannelTemplate[]>] [-Classification <String>] [-Description <String>] + [-DiscoverySetting <ITeamDiscoverySettings>] [-FunSetting <ITeamFunSettings>] + [-GuestSetting <ITeamGuestSettings>] [-Icon <String>] [-IsMembershipLimitedToOwner] + [-MemberSetting <ITeamMemberSettings>] [-MessagingSetting <ITeamMessagingSettings>] + [-OwnerUserObjectId <String>] [-PublishedBy <String>] [-Specialization <String>] [-TemplateId <String>] + [-Uri <String>] [-Visibility <String>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## 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 \<ITeamsAppTemplate[]\>: 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 <String>]`: Gets or sets the app's ID in the global apps catalog. + +BODY \<ITeamTemplate\>: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName <String>`: Gets or sets the team's DisplayName. +- `ShortDescription <String>`: Gets or sets template short description. +- `[App <ITeamsAppTemplate[]>]`: 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 <String>]`: Gets or sets the app's ID in the global apps catalog. +- `[Category <String[]>]`: Gets or sets list of categories. +- `[Channel <IChannelTemplate[]>]`: Gets or sets the set of channel templates included in the team template. + - `[Description <String>]`: Gets or sets channel description as displayed to users. + - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. + - `[Id <String>]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault <Boolean?>]`: 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 <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. + - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id <String>]`: Gets or sets identifier for the channel tab template. + - `[Key <String>]`: Gets a unique identifier. + - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name <String>]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. +- `[Classification <String>]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description <String>]`: Gets or sets the team's Description. +- `[DiscoverySetting <ITeamDiscoverySettings>]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting <ITeamFunSettings>]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. +- `[GuestSetting <ITeamGuestSettings>]`: Guest role settings for the team. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon <String>]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner <Boolean?>]`: 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 <ITeamMemberSettings>]`: Member role settings for the team. + - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting <ITeamMessagingSettings>]`: 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 <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId <String>]`: 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 <String>]`: Gets or sets published name. +- `[Specialization <String>]`: 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 <String>]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri <String>]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility <String>]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL <IChannelTemplate[]>: Gets or sets the set of channel templates included in the team template. + +- `[Description <String>]`: Gets or sets channel description as displayed to users. +- `[DisplayName <String>]`: Gets or sets channel name as displayed to users. +- `[Id <String>]`: Gets or sets identifier for the channel template. +- `[IsFavoriteByDefault <Boolean?>]`: 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 <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. + - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id <String>]`: Gets or sets identifier for the channel tab template. + - `[Key <String>]`: Gets a unique identifier. + - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name <String>]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \<ITeamDiscoverySettings\>: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \<ITeamFunSettings\>: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. + +GUESTSETTING \<ITeamGuestSettings\>: Guest role settings for the team. + +- `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter + +- `[Bssid <String>]`: +- `[ChassisId <String>]`: +- `[CivicAddressId <String>]`: Civic address id. +- `[Country <String>]`: +- `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. +- `[Id <String>]`: +- `[Identity <String>]`: +- `[Locale <String>]`: +- `[LocationId <String>]`: Location id. +- `[OdataId <String>]`: A composite URI of a template. +- `[OperationId <String>]`: The ID of a batch policy assignment operation. +- `[OrderId <String>]`: +- `[PackageName <String>]`: The name of a specific policy package +- `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. +- `[Port <String>]`: +- `[PortInOrderId <String>]`: +- `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. +- `[SubnetId <String>]`: +- `[TenantId <String>]`: +- `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \<ITeamMemberSettings\>: Member role settings for the team. + +- `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \<ITeamMessagingSettings\>: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage <Boolean>`: 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) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..776c82c956 --- /dev/null +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -0,0 +1,433 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Update-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: +online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Update-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet updates an existing workforce management (WFM) connection. + +## SYNTAX + +### Update (Default) +```powershell +Update-CsTeamsShiftsConnection -ConnectionId <string> -Body <IUpdateWfmConnectionFieldsRequest> [-Authorization <string>] [-IfMatch <string>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateExpanded +```powershell +Update-CsTeamsShiftsConnection -ConnectionId <string> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] + [-ConnectorSpecificSettings <IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] + [-State <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] +[-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +```powershell +Update-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <string>] [-IfMatch <string>] + [-ConnectorId <string>] [-ConnectorSpecificSettings <IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings>] [-Etag <string>] + [-Name <string>] [-State <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] + [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentity +```powershell +Update-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> -Body <IUpdateWfmConnectionFieldsRequest> [-Authorization <string>] + [-IfMatch <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] + [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsConnection cmdlet, it allows the admin to make changes to the settings in the connection. The complete list of fields is not required allowing the user to update single fields of the connection. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -name "Cmdlet test connection - updated" ` + +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection. + +### Example 2 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : 79964000-286a-4216-ac60-c795a426d61a +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + +Updates the connection with the specified -ConnectionId with the given settings. Returns the object of the updated connection. + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateWfmConnectionFieldsRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the ETag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts. + +```yaml +Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionFieldsRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md new file mode 100644 index 0000000000..466a0bf1c7 --- /dev/null +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -0,0 +1,529 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Update-CsTeamsShiftsConnectionInstance +author: nunocorreia-ms +ms.author: nunocorreia +manager: +online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance +schema: 2.0.0 +--- + +# Update-CsTeamsShiftsConnectionInstance + +## SYNOPSIS +This cmdlet updates Shifts connection instance fields. + +## SYNTAX + +### Update (Default) +```powershell +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <string> -Body <IUpdateConnectorInstanceFieldsRequest> [-Break] +[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] +[-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateExpanded +```powershell +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] +[-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] + [-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] + [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +```powershell +Update-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> -IfMatch <string> + [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-State <string>] + [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] [-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] +[-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] +[-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentity +```powershell +Update-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> -IfMatch <string> -Body <IUpdateConnectorInstanceFieldsRequest> + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates a Shifts connection instance. Similar to the Set-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -syncFrequencyInMin "30" ` + +PS C:\> $result.ToJsonString() +``` + +```output + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state" : "Active" +} + +``` + +Updates the instance with the specified -ConnectorInstanceId with the given name and sync frequency. Returns the object of the updated connector instance. + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateConnectorInstanceFieldsRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. + +```yaml +Type: String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorInstanceId +The connector instance ID. + +```yaml +Type: String +Parameter Sets: Update, UpdateExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedActorId +The designated actor ID that App acts as for Shifts Graph API calls. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the ETag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncFrequencyInMin +The sync frequency in minutes. + +```yaml +Type: Int32 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateConnectorInstanceFieldsRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-M365TeamsApp.md b/teams/teams-ps/teams/Update-M365TeamsApp.md new file mode 100644 index 0000000000..7fccff1744 --- /dev/null +++ b/teams/teams-ps/teams/Update-M365TeamsApp.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365TeamsApp +applicable: Microsoft Teams +title: Update-M365TeamsApp +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 04/24/2024 +schema: 2.0.0 +--- + +# Update-M365TeamsApp + +## SYNOPSIS + +This cmdlet updates app state and app available values for the Microsoft Teams app. + +## SYNTAX + +```powershell +Update-M365TeamsApp -Id <String> [-IsBlocked <Boolean>] -AppAssignmentType <String> -OperationType <String> + [-Users <String[]>] [-Groups <String[]>] -AppInstallType <String> -InstallForOperationType <String> [-InstallForUsers <String[]> -InstallForGroups <String[]> -InstallVersion <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet allows administrators to modify app state, availability and installation status by adding or removing users and groups or changing assignment type or installation status. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Update-M365TeamsApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -AppAssignmentType Everyone +``` +Updates the availability value for Bookings app (App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b) to Everyone. + +### Example 2 + +```powershell +PS C:\> Update-M365TeamsApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -IsBlocked $true -AppAssignmentType UsersAndGroups -OperationType Add -Users eec823bd-0979-4cf8-9924-85bb6ffcb57d, eec823bd-0979-4cf8-9924-85bb6ffcb57e -Groups 37da2d58-fc14-453e-9a14-5065ebd63a1d, 37da2d58-fc14-453e-9a14-5065ebd63a1e, 37da2d58-fc14-453e-9a14-5065ebd63a1b, 37da2d58-fc14-453e-9a14-5065ebd63a1f, 37da2d58-fc14-453e-9a14-5065ebd63a1a +``` +Unblocks CSP Customer App (App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b) and updates availability setting for the app to include 2 users and 5 groups. + +### Example 3 + +```powershell +PS C:\> Update-M365TeamsApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -IsBlocked $true +``` +Unblocks Bookings app (App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b). + +### Example 4 + +```powershell +PS C:\> Update-M365TeamsApp -Id 2b876f4d-2e6b-4ee7-9b09-8893808c1380 -IsBlocked $false -AppInstallType UsersAndGroups -InstallForOperationType Add -InstallForUsers 77f5d400-a12e-4168-8e63-ccd2243d33a8,f2f4d8bc-1fb3-4292-867e-6d19efb0eb7c,37b6fc6a-32a4-4767-ac2e-c2f2307bad5c -InstallForGroups 926d57ad-431c-4e6a-9e16-347eacc91aa4 -InstallVersion 4.1.2 +``` +Unblocks 1Page App (App ID 2b876f4d-2e6b-4ee7-9b09-8893808c1380) and updates installation setting for the app to include 3 users and 1 group. + +## PARAMETERS + +### -AppAssignmentType + +App availability type. + +```yaml +Type: String +Parameter Sets: (Everyone, UsersandGroups, Noone) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups + +List of all the groups for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id + +Application ID of Microsoft Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsBlocked + +The state of the app in the tenant. + +```yaml +Type: Boolean +Parameter Sets: (true, false) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationType + +Operation performed on the app assigment. + +```yaml +Type: String +Parameter Sets: (Add, Remove) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users + +List of all the users for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppInstallType + +App installation type. + +```yaml +Type: String +Parameter Sets: (Everyone, UsersandGroups, Noone) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallForOperationType + +Operation performed on the app installation. + +```yaml +Type: String +Parameter Sets: (Add, Remove) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallForUsers + +List of all the users for whom the app is installed. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallForGroups + +List of all the groups for whom the app is installed. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallVersion + +App version to be installed. + +```yaml +Type: String +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md b/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md new file mode 100644 index 0000000000..f2292aee01 --- /dev/null +++ b/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedCustomPendingApp +applicable: Microsoft Teams +title: Update-M365UnifiedCustomPendingApp +author: michelle-paradis +ms.author: mparadis +manager: swmerchant +ms.date: 01/20/2025 +schema: 2.0.0 +--- + +# Update-M365UnifiedCustomPendingApp + +## SYNOPSIS + +This cmdlet updates the review status for a custom Microsoft Teams app that is pending review from an IT Admin. The requester to publish the custom app will not be notified when this cmdlet is completed. + +## SYNTAX + +```powershell +Update-M365UnifiedCustomPendingApp -Id <String> -ReviewStatus <String> +``` + +## DESCRIPTION + +This cmdlet allows administrators to reject or publish custom Microsoft Teams apps that are pending review from an IT Admin. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Published +``` +Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Published. + +### Example 2 + +```powershell +PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Rejected +``` +Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Rejected. + +## PARAMETERS + +### Id + +Application ID of the Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### ReviewStatus + +The review status of the Teams app. + +```yaml +Type: String +Parameter Sets: (Published, Rejected) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES diff --git a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md b/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md new file mode 100644 index 0000000000..ed119948d2 --- /dev/null +++ b/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedTenantSettings +applicable: Microsoft Teams +title: Update-M365UnifiedTenantSettings +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 10/22/2024 +schema: 2.0.0 +--- + +# Update-M365UnifiedTenantSettings + +## SYNOPSIS + +This cmdlet updates tenant settings. + +## SYNTAX + +```powershell +Update-M365UnifiedTenantSettings -SettingName <String> -SettingValue <String> [-Users <String[]>] [-Groups <String[]>] [-Operation <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +This cmdlet allows administrators to modify tenant settings. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> PS C:\> Update-M365UnifiedTenantSettings -SettingName EnableCopilotExtensibility -SettingValue Some -Users d156010d-fb18-497f-804c-155ec2aa06d3,a62fba7e-e362-493c-a094-fdec17e2fee8 -Groups 37da2d58-fc14-453e-9a14-5065ebd63a1d, 37da2d58-fc14-453e-9a14-5065ebd63a1e -Operation add +``` +Updates the tenant setting for EnableCopilotExtensibility to 2 users and 2 groups. + +### Example 2 + +```powershell +PS C:\> Update-M365UnifiedTenantSettings -SettingName GlobalApp -SettingValue None +``` +Updates the tenant setting for GlobalApp to None + +## PARAMETERS + +### -SettingName + +Setting Name to be changed. + +```yaml +Type: String +Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingValue +Setting Value to be changed. + +```yaml +Type: String +Parameter Sets: (All, None, Some) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation + +Operation performed (whether we are adding or removing users/groups). + +```yaml +Type: String +Parameter Sets: (add, remove) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users + +List of all the users for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups + +List of all the groups for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Update-TeamsAppInstallation.md b/teams/teams-ps/teams/Update-TeamsAppInstallation.md new file mode 100644 index 0000000000..d7ce547680 --- /dev/null +++ b/teams/teams-ps/teams/Update-TeamsAppInstallation.md @@ -0,0 +1,143 @@ +--- +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 <String>] [-AppId <String>] -TeamId <String> + [-Permissions <String>] [<CommonParameters>] +``` + +### UserScope +``` +Update-TeamsAppInstallation [-AppInstallationId <String>] [-AppId <String>] -UserId <String> + [-Permissions <String>] [<CommonParameters>] +``` + +## 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/export-csonlineaudiofile.md b/teams/teams-ps/teams/export-csonlineaudiofile.md new file mode 100644 index 0000000000..f0b747b543 --- /dev/null +++ b/teams/teams-ps/teams/export-csonlineaudiofile.md @@ -0,0 +1,97 @@ +--- +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 +ms.author: serdars +ms.reviewer: +--- + +# Export-CsOnlineAudioFile + +## SYNOPSIS +Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. + +## SYNTAX + +```powershell +Export-CsOnlineAudioFile [[-Identity] <string>] [-ApplicationId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The Export-CsOnlineAudioFile cmdlet downloads an existing Auto Attendant (AA), Call Queue (CQ) service or Music on Hold audio file. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +$content=Export-CsOnlineAudioFile -ApplicationId "HuntGroup" -Identity 57f800408f8848548dd1fbc18073fe46 +[System.IO.File]::WriteAllBytes('C:\MyWaveFile.wav', $content) +``` + +This example exports a Call Queue audio file and saves it as MyWaveFile.wav. + +## PARAMETERS + +### -ApplicationId +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: + +- OrgAutoAttendant +- HuntGroup +- TenantGlobal + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: TenantGlobal +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific audio file that you would like to export. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Byte[] + +## NOTES +The audio content generated by Export-CsOnlineAudioFile is always in WAV format (PCM 16 bit and mono) irrespective on which format the audio was imported as. +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) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md b/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md new file mode 100644 index 0000000000..fc5ad06309 --- /dev/null +++ b/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMessagingConfiguration +title: Get-CsTeamsMessagingConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsMessagingConfiguration + +## SYNOPSIS + +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMessagingConfiguration [[-Identity] <String>] [<CommonParameters>] +``` + +### Filter + +```powershell +Get-CsTeamsMessagingConfiguration [-Filter <String>] [<CommonParameters>] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsMessagingConfiguration +``` + +The command shown in Example 1 returns teams messaging configuration information for the current tenant. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md b/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md new file mode 100644 index 0000000000..79f4c96eb3 --- /dev/null +++ b/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMessagingConfiguration +title: Set-CsTeamsMessagingConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsMessagingConfiguration + +## SYNOPSIS + +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +## SYNTAX + +```powershell +Set-CsTeamsMessagingConfiguration [-Identity] <String> + [-Confirm] + [-CustomEmojis <Boolean>] + [-EnableInOrganizationChatControl <Boolean>] + [-EnableVideoMessageCaptions <Boolean>] + [-FileTypeCheck <string>] + [-Force] + [-MessagingNotes <String>] + [-UrlReputationCheck <string>] + [-ContentBasedPhishingCheck <string>] + [-ReportIncorrectSecurityDetections<string>] + [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False +``` + +The command shown in example 1 disables custom emojis within Teams. + +## PARAMETERS + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmojis + +This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInOrganizationChatControl + +This setting determines if chat regulation for internal communication in tenant is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVideoMessageCaptions + + This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. + Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if FileType check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingNotes + +This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlReputationCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if UrlReputationCheck check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentBasedPhishingCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Content Based Phishing Check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportIncorrectSecurityDetections + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Report Incorrect Security Detections is enabled in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index fb7efb0b47..058504f325 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -2,80 +2,547 @@ Module Name: Microsoft Teams PowerShell Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX title: teams -Locale: en-US --- # Microsoft Teams PowerShell + ## Description The following cmdlet references are for Microsoft Teams. ## Microsoft Teams Cmdlets -### [Add-TeamUser](Add-TeamUser.md) -{{Manually Enter Add-TeamUser Description Here}} +### [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) -{{Manually Enter Connect-MicrosoftTeams Description Here}} - +### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +### [Disable-CsTeamsShiftsConnectionErrorReport](Disable-CsTeamsShiftsConnectionErrorReport.md) ### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) -{{Manually Enter Disconnect-MicrosoftTeams Description Here}} - +### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) +### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) +### [export-csonlineaudiofile](export-csonlineaudiofile.md) +### [Find-CsGroup](Find-CsGroup.md) +### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +### [Get-AssociatedTeam](Get-AssociatedTeam.md) +### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) +### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) +### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) +### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) +### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) +### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) +### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) +### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) +### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +### [Get-CsCallQueue](Get-CsCallQueue.md) +### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) +### [Get-CsDialPlan](Get-CsDialPlan.md) +### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) +### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) +### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) +### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) +### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) +### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) +### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) +### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) +### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +### [Get-CsCsOnlineAudioConferencingRoutingPolicy][Get-CsOnlineAudioConferencingRoutingPolicy.md] +### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) +### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) +### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) +### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) +### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) +### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) +### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) +### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) +### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) +### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) +### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) +### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) +### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) +### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) +### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +### [Get-CsOnlineUser](Get-CsOnlineUser.md) +### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) +### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) +### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) +### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) +### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) +### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) +### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) +### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) +### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) +### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) +### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) +### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) +### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) +### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) +### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) +### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) +### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) +### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) +### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) +### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) +### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) +### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) +### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) +### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) +### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) +### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) +### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) +### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) +### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) +### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) +### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) +### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) +### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) +### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) +### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) +### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) +### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) +### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) +### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) +### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) +### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) +### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) +### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) +### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) +### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) +### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) +### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) +### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) +### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) +### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) +### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) +### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) +### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) +### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) +### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) +### [Get-CsTenant](Get-CsTenant.md) +### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) +### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) +### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) +### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) +### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) +### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) +### [Get-LicenseReportForChangeNotificationSubscription](Get-LicenseReportForChangeNotificationSubscription.md) +### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) +### [Get-SharedWithTeam](Get-SharedWithTeam.md) +### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) ### [Get-Team](Get-Team.md) -{{Manually Enter Get-Team Description Here}} - +### [Get-TeamAllChannel](Get-TeamAllChannel.md) ### [Get-TeamChannel](Get-TeamChannel.md) -{{Manually Enter Get-TeamChannel Description Here}} - +### [Get-TeamChannelUser](Get-TeamChannelUser.md) ### [Get-TeamFunSettings](Get-TeamFunSettings.md) -{{Manually Enter Get-TeamFunSettings Description Here}} - ### [Get-TeamGuestSettings](Get-TeamGuestSettings.md) -{{Manually Enter Get-TeamGuestSettings Description Here}} - -### [Get-TeamHelp](Get-TeamHelp.md) -{{Manually Enter Get-TeamHelp Description Here}} - +### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) ### [Get-TeamMemberSettings](Get-TeamMemberSettings.md) -{{Manually Enter Get-TeamMemberSettings Description Here}} - ### [Get-TeamMessagingSettings](Get-TeamMessagingSettings.md) -{{Manually Enter Get-TeamMessagingSettings Description Here}} - +### [Get-TeamsApp](Get-TeamsApp.md) +### [Get-TeamsAppInstallation](Get-TeamsAppInstallation.md) +### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) ### [Get-TeamUser](Get-TeamUser.md) -{{Manually Enter Get-TeamUser Description Here}} - +### [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) -{{Manually Enter New-Team Description Here}} - ### [New-TeamChannel](New-TeamChannel.md) -{{Manually Enter New-TeamChannel Description Here}} - +### [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) -{{Manually Enter Remove-Team Description Here}} - ### [Remove-TeamChannel](Remove-TeamChannel.md) -{{Manually Enter Remove-TeamChannel Description Here}} - +### [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) -{{Manually Enter Remove-TeamUser Description Here}} - +### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) +### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) +### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) +### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +### [Set-CsCallQueue](Set-CsCallQueue.md) +### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) +### [Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) +### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) +### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) +### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +### [Set-CsCsOnlineAudioConferencingRoutingPolicy][Set-CsOnlineAudioConferencingRoutingPolicy.md] +### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) +### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) +### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) +### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) +### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) +### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) +### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) +### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) +### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) +### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) +### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) +### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) +### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) +### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) +### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) +### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) +### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) +### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) +### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) +### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) +### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) +### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) +### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) +### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) +### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) +### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) +### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) +### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) +### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) +### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) +### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) +### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) +### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) +### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) +### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) +### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) +### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) +### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) +### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) +### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) +### [Set-CsTeamsPinnedApp](Set-CsTeamsPinnedApp.md) +### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) +### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) +### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) +### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) +### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) +### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) +### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) +### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) +### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) +### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) +### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) +### [Set-CsUser](Set-CsUser.md) +### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) +### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) ### [Set-Team](Set-Team.md) -{{Manually Enter Set-Team Description Here}} - +### [Set-TeamArchivedState](Set-TeamArchivedState.md) ### [Set-TeamChannel](Set-TeamChannel.md) -{{Manually Enter Set-TeamChannel Description Here}} - ### [Set-TeamFunSettings](Set-TeamFunSettings.md) -{{Manually Enter Set-TeamFunSettings Description Here}} - ### [Set-TeamGuestSettings](Set-TeamGuestSettings.md) -{{Manually Enter Set-TeamGuestSettings Description Here}} - ### [Set-TeamMemberSettings](Set-TeamMemberSettings.md) -{{Manually Enter Set-TeamMemberSettings Description Here}} - ### [Set-TeamMessagingSettings](Set-TeamMessagingSettings.md) -{{Manually Enter Set-TeamMessagingSettings Description Here}} - ### [Set-TeamPicture](Set-TeamPicture.md) -{{Manually Enter Set-TeamPicture Description Here}} - +### [Set-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/tools/office-cmdlet-updater/README.md b/tools/office-cmdlet-updater/README.md index 5867533255..d4400fe9f0 100644 --- a/tools/office-cmdlet-updater/README.md +++ b/tools/office-cmdlet-updater/README.md @@ -1,32 +1,24 @@ # Office PowerShell Cmdlet Updater -## Usage: +## Usage 1. Clone repo at: https://github.com/microsoftdocs/office-docs-powershell -2. Configure your email address in tools/.local/config/default.json to receive emailed logs. (OPTIONAL) +2. Update configuration file `tools/.local/default.json`. Here is a brief explanation of all parameters + * (REQUIRED) - `credentials\login` and `credentials\pass` should be updated with an account with Office 365 subscription and should have appropriate services in that subscription + * (OPTIONAL) - `sendgrid\apiKey` and `sendgrid\emailSettings` should be updated with account details from an active sendgrid subscription + * (OPTIONAL) - `github` section should be updated with account details from an active github account 3. Confirm you have NodeJS installed. Open PowerShell or GitBash and type `npm --version`. If not, install from [https://nodejs.org/en/download/](https://nodejs.org/en/download/). -4. Open GitBash or PowerShell and cd into office-docs-powershell/tools/office-powershell-updater +4. Open GitBash or PowerShell and run `cd <EnterThePathHere>/office-docs-powershell/tools/office-cmdlet-updater` 5. Install the required modules, type `npm install` and press Enter. -6. Install required PowerShell modules and connectors: +6. Install required PowerShell modules and connectors that will not be installed by the tool: - Skype for Business Online: - - https://www.microsoft.com/en-in/download/confirmation.aspx?id=39366 - - execute into console winrm quickconfig - - Microsoft Teams: + - https://www.microsoft.com/en-us/download/details.aspx?id=39366 + - execute into console `winrm quickconfig` - SharePoint Online: - - https://www.microsoft.com/en-gb/download/details.aspx?id=35588 + - https://www.microsoft.com/en-us/download/details.aspx?id=35588 - Exchange Online: - - Whiteboard: - - StaffHub: - - Office Online Server: - - SharePoint Migration Tool (SPMT): -7. Run the app, type `npm start` and press Enter. - -## Notes -1. The modules are installed from the PowerShell Gallery (PSGallery). - This gallery contains user submitted code. - If you would rather not install modules from the PSGallery then you can install the modules manually prior to running the tool. - If you need to add PSGallery as a trusted source, you can do so with the following command: - `Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted` - -## Sample Run + - cmdlets could be imported using [this guide](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) +7. Run the app, type `node index` and press Enter in order to get info for all modules +8. Run the app for a certain module, type `node index -m <TypeModuleNameHere>`, with one of the following options - teams, skype, sharepoint, whiteboard, exchange, staffhub. For example, you should run `node index -m teams` to run the tool for Microsoft Teams +9. Run `node index -help` to get help information for all available commands diff --git a/tools/office-cmdlet-updater/config/default.json b/tools/office-cmdlet-updater/config/default.json index 79a30a387a..9c2a491559 100644 --- a/tools/office-cmdlet-updater/config/default.json +++ b/tools/office-cmdlet-updater/config/default.json @@ -1,6 +1,6 @@ { "name": "Office cmdlet updater", - "description": "Update documentation for modules in this repository", + "description": "Update documentation for modules in this repository. Available Modules: teams, skype, sharepoint, whiteboard, exchange, staffhub", "version": "0.0.3", "platyPS": { "credentials": { @@ -23,11 +23,11 @@ "path": "..\\..\\sharepoint\\sharepoint-ps\\sharepoint-online", "metaTags": [] }, -// { -// "name": "staffhub", -// "path": "..\\..\\staffhub\\staffhub-ps\\staffhub", -// "metaTags": [] -// }, + { + "name": "staffhub", + "path": "..\\..\\staffhub\\staffhub-ps\\staffhub", + "metaTags": [] + }, { "name": "whiteboard", "path": "..\\..\\whiteboard\\whiteboard-ps\\whiteboard", @@ -41,17 +41,37 @@ ], "ignoreFiles": [ "..\\..\\teams\\teams-ps\\teams\\teams.md", - "..\\..\\whiteboard\\whiteboard-ps\\whiteboard\\whiteboard.md" + "..\\..\\whiteboard\\whiteboard-ps\\whiteboard\\whiteboard.md", + "..\\..\\sharepoint\\sharepoint-ps\\sharepoint-online\\sharepoint-online.md", + "..\\..\\staffhub\\staffhub-ps\\staffhub\\staffhub.md" ], "tempFolderPath": ".\\.local\\temp" }, "sendgrid": { - "sendMailNotification": false, "apiKey": "<API_KEY>", "emailSettings": { "from": "no-replay@outlook.com", "to": "test@gmail.com", "subject": "Test subject" } + }, + "github": { + "token": "<TOKEN>", + "login": "<LOGIN>", + "pass": "<PASSWORD>", + "name": "Bot", + "email": "bot@example.com", + "commitMessage": "Automatically created commit with cmdlets updates", + "repositoryName": "office-docs-powershell", + "repositoryLocalPath": "..\\..\\", + "remoteName": "origin", + "head": "refs/heads/tools", + "base": "refs/heads/tools", + "pullRequest": { + "title": "Automatically created commit with cmdlets updates", + "body": "Last cmdlets updates", + "head": "tools", + "base": "master" + } } } diff --git a/tools/office-cmdlet-updater/constants/commands.js b/tools/office-cmdlet-updater/constants/commands.js index daf2ace9dd..ac7fe47121 100644 --- a/tools/office-cmdlet-updater/constants/commands.js +++ b/tools/office-cmdlet-updater/constants/commands.js @@ -1,16 +1,20 @@ module.exports = { GET_TEAM: 'Get-Team', + GET_TEAMS_CREDENTIALS: '$credentials=Get-Credential', + INSTALL_PS_GALLERY: 'Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted', INSTALL_PACKAGE_PROVIDER: 'Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force', + IMPORT_MICROSOFT_TEAM: 'Import-Module MicrosoftTeams', INSTALL_MICROSOFT_TEAM: 'Install-Module MicrosoftTeams -SkipPublisherCheck -Force', - CONNECT_MICROSOFT_TEAM: 'Connect-MicrosoftTeams', + CONNECT_MICROSOFT_TEAM: 'Connect-MicrosoftTeams -Credential $cred', INSTALL_PLATYPS: 'Install-Module -Name platyPS -SkipPublisherCheck -Scope CurrentUser -Force', IMPORT_PLATYPS: 'Import-Module platyPS', UPDATE_MARKDOWN: 'Update-MarkdownHelp -Path "{}" -LogPath "{}" -Session $Session', - SKYPE_SET_POLICY: 'Set-ExecutionPolicy RemoteSigned ', - SKYPE_INSTALL_MODULE: 'Import-Module "C:\\\\Program Files\\\\Common Files\\\\Skype for Business Online\\\\Modules\\\\SkypeOnlineConnector\\\\SkypeOnlineConnector.psd1" -Force', + SKYPE_ENABLE_WIN_RM: 'sc.exe start WinRM', + SKYPE_INSTALL_LYNC_MODULE: 'Import-Module LyncOnlineConnector', + SKYPE_INSTALL_MODULE: 'Import-Module SkypeOnlineConnector -Force', SKYPE_GET_CRED: '$cred = Get-Credential', SKYPE_CREATE_SESSION: '$session = New-CsOnlineSession -Credential $cred -Verbose', - SKYPE_IMPORT_SESSION: 'Import-PSSession -Session $session', + SKYPE_IMPORT_SESSION: 'Import-PSSession -Session $session -Verbose', SHAREPOINT_INSTALL_MODULE: 'Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking', WHITEBOARD_INSTALL_MODULE: 'Install-Module -Name WhiteboardAdmin -Force', EXCHANGE_INSTALL_MODULE: 'Install-Module -Name ExchangeOnlineShell -Force', @@ -21,5 +25,5 @@ module.exports = { SET_PASS: '$Password = \'{}\'', CONVERT_PASS_TO_SEC_STRING: '$SecureString = ConvertTo-SecureString -AsPlainText $Password -Force', CREAT_CRED: '$cred = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Username,$SecureString', - STUFFHUB_INSTALL: 'Install-Module -Name MicrosoftStaffHub -RequiredVersion 1.0.0-alpha -AllowPrerelease -Force' + STUFFHUB_INSTALL: 'Install-Module -Name MicrosoftStaffHub -Force' }; diff --git a/tools/office-cmdlet-updater/constants/errors.js b/tools/office-cmdlet-updater/constants/errors.js index ab2652b1e2..02b0a2a0e6 100644 --- a/tools/office-cmdlet-updater/constants/errors.js +++ b/tools/office-cmdlet-updater/constants/errors.js @@ -1,9 +1,17 @@ +module.exports.general = { + TOOL_PLATFORM_TYPE: "The Cmdlet Updater is only supported on x64 architecture. X86 is not supported." +}; + module.exports.powerShellErrors = { + PS_GALLERY_INSTALL_ERROR: "You should use x64 version of PowerShell", DOC_PATH_DOESNT_EXIST: "Path to documentation folder doesn't exist", INSTALL_PLATYPS_ERROR: "Can't install 'platyPS' module", IMPORT_PLATYPS_ERROR: "Cant't import 'platyPS' module", INSTALL_MICROSOFT_TEAM_ERROR: "Can't install 'Microsoft team' module", - AUTH_MICROSOFT_TEAM_ERROR: "Can't auth into 'Microsoft team'" + AUTH_MICROSOFT_TEAM_ERROR: "Can't auth into 'Microsoft team'", + EMPTY_CONFIG_CREDENTIALS: "Empty credentials fields in a config file. Please, fill 'platyPS.credentials' section into a config file", + SKYPE_INSTALL_ERROR: "The Skype PowerShell module does not appear to be installed. Please review the README to install the Skype module and try again.", + EXCHANGE_INSTALL_ERROR: "The Exchange PowerShell module does not appear to be installed. Please review the README to install the Exchange module and try again.", }; module.exports.markdownErrors = { diff --git a/tools/office-cmdlet-updater/constants/logs.js b/tools/office-cmdlet-updater/constants/logs.js new file mode 100644 index 0000000000..0b6240ed0d --- /dev/null +++ b/tools/office-cmdlet-updater/constants/logs.js @@ -0,0 +1,36 @@ +const titleKeyword = { + value: 'UPDATING Cmdlet ', + displayName: 'UPDATING Cmdlet' +}; + +module.exports.titleKeyword = titleKeyword; + +module.exports.keywords = [ + titleKeyword, + { + value: 'Parameter Added', + displayName: 'Parameter Added' + }, + { + value: 'Parameter Deleted', + displayName: 'Parameter Deleted' + }, + { + value: 'Parameter Updated', + displayName: 'Parameter Updated' + }, + { + value: 'Parameter Set Added', + displayName: 'Parameter Set Added' + }, + { + value: 'Parameter Set Deleted', + displayName: 'Parameter Set Deleted' + }, + { + value: 'Parameter Set Name Updated', + displayName: 'Parameter Set Name Updated' + } +]; + +module.exports.noChangeValue = '__AllParameterSets'; diff --git a/tools/office-cmdlet-updater/controllers/cli.controller.js b/tools/office-cmdlet-updater/controllers/cli.controller.js index 2d7bfb2f83..d50ff9e7d6 100644 --- a/tools/office-cmdlet-updater/controllers/cli.controller.js +++ b/tools/office-cmdlet-updater/controllers/cli.controller.js @@ -1,9 +1,12 @@ +const { errorColor } = require('../helpers/colors'); +const checkWindowPlatformType = require('../helpers/os'); + class CliController { constructor( cliService, cmdletService, - markdownController, - powerShellService + powerShellService, + markdownController ) { this.cliService = cliService; this.cmdletService = cmdletService; @@ -12,10 +15,12 @@ class CliController { } start(argv) { try { + checkWindowPlatformType(); + this.startCli(argv); } catch (e) { this.powerShellService.dispose(); - console.error(e.message); + console.error(errorColor(e)); } } @@ -47,13 +52,36 @@ class CliController { } }); + this.cliService.addOption({ + option: '-e --send-email', + description: 'send email notification' + }); + + this.cliService.addOption({ + option: '-p --create-pr', + description: 'create pull request' + }); + this.cliService.start(argv, async (cli) => { - const { module, cmdlet } = cli; + const { + module: cliModuleName, + cmdlet: cliCmdletName, + sendEmail: isNeedEmail, + createPr: isNeedPullRequest + } = cli; + + await this.markdownController + .updateMarkdown({ + cliModuleName, + cliCmdletName, + isNeedPullRequest, + isNeedEmail + }) + .catch((err) => { + console.error(errorColor(err)); - await this.markdownController.updateMarkdown({ - moduleName: module, - cmdlet - }); + this.powerShellService.dispose(); + }); }); } } diff --git a/tools/office-cmdlet-updater/controllers/github.controller.js b/tools/office-cmdlet-updater/controllers/github.controller.js new file mode 100644 index 0000000000..d0300c223e --- /dev/null +++ b/tools/office-cmdlet-updater/controllers/github.controller.js @@ -0,0 +1,63 @@ +const { errorColor } = require('../helpers/colors'); + +class GithubController { + constructor(config, gitService, githubService) { + this.config = config; + this.gitService = gitService; + this.githubService = githubService; + } + + async createPullRequest({ prBody, cb = () => {} }) { + const { + login, + pass, + commitMessage, + repositoryLocalPath: path, + repositoryName, + remoteName, + head, + base, + pullRequest + } = this.config.get('github'); + + const repository = await this.gitService.openRepository({ path }); + const id = await this.gitService.stageAllFiles({ + filesMask: '*.md', + repository + }); + + await this.gitService.createCommit({ repository, commitMessage, id }); + await this.gitService.pushCommit({ + remoteName, + repository, + login, + pass, + head, + base + }); + + const githubRepository = this.githubService.openRepository({ + repositoryName + }); + + const body = prBody || pullRequest.body; + + this.githubService.createPullRequest({ + repository: githubRepository, + ...pullRequest, + body, + cb + }); + } + + _pullRequestCb(err, data) { + if (err) { + console.error(errorColor(err)); + return; + } + + console.log(data); + } +} + +module.exports = GithubController; diff --git a/tools/office-cmdlet-updater/controllers/logs.controller.js b/tools/office-cmdlet-updater/controllers/logs.controller.js new file mode 100644 index 0000000000..28cc34be47 --- /dev/null +++ b/tools/office-cmdlet-updater/controllers/logs.controller.js @@ -0,0 +1,38 @@ +class LogsController { + constructor(logParseService, logStoreService) { + this.logParseService = logParseService; + this.logStoreService = logStoreService; + } + + saveAndParseLogs({ moduleResults }) { + let parsedModules = []; + + for (let { module, logs, errors } of moduleResults) { + this._saveLogsIntoFs({ module, logs, errors }); + + const parsedLogs = this._parseLogs({ logs }); + + parsedModules = [...parsedModules, { module, parsedLogs }]; + } + + return parsedModules; + } + + _saveLogsIntoFs({ module, logs, errors }) { + this.logStoreService.saveInFs({ name: module, logs, errors }); + } + + _parseLogs({ logs }) { + let parsedLogs = []; + + logs.forEach((log) => { + const logObj = this.logParseService.parse({ log }); + + parsedLogs = [...parsedLogs, logObj]; + }); + + return parsedLogs; + } +} + +module.exports = LogsController; diff --git a/tools/office-cmdlet-updater/controllers/markdown.controller.js b/tools/office-cmdlet-updater/controllers/markdown.controller.js index ac24c43ed5..ceef26f5ed 100644 --- a/tools/office-cmdlet-updater/controllers/markdown.controller.js +++ b/tools/office-cmdlet-updater/controllers/markdown.controller.js @@ -1,40 +1,112 @@ -const fs = require('fs-extra'); -const of = require('await-of').default; -const { powerShellErrors } = require('../constants/errors'); - class MarkdownController { - constructor(powerShellService, markdownService, config) { + constructor( + powerShellService, + moduleController, + logStoreService, + logsController, + notificationController, + githubController + ) { this.powerShellService = powerShellService; - this.markdownService = markdownService; - this.config = config; + this.moduleController = moduleController; + this.logsController = logsController; + this.notificationController = notificationController; + this.githubController = githubController; + + this.isNeedEmail = false; + this.mailText = ''; + + this._handlePrResult = this._handlePrResult.bind(this); + this._successfulHandlePrResult = this._successfulHandlePrResult.bind( + this + ); } - async updateMarkdown({ moduleName, cmdlet }) { - let err; - const { docs } = this.config.get('platyPS'); + async updateMarkdown({ + cliModuleName, + cliCmdletName, + isNeedPullRequest, + isNeedEmail + }) { + const moduleResults = await this.moduleController.updateMarkdown({ + cliModuleName, + cliCmdletName, + isNeedPullRequest + }); - docs.filter((doc) => this._filterModules(doc, moduleName)).forEach( - async (doc) => { - if (!(await fs.pathExists(doc.path))) { - throw new Error(powerShellErrors.DOC_PATH_DOESNT_EXIST); - } + this.powerShellService.dispose(); - [, err] = await of(this.markdownService.updateMd(doc, cmdlet)); + const parsedModules = this.logsController.saveAndParseLogs({ + moduleResults + }); + const mailText = this.notificationController.generateMailText({ + parsedModules + }); - if (err) { - this.powerShellService.dispose(); - console.error(err.message); - } - } - ); + if (!mailText) { + console.log(`No changes found in module ${cliModuleName}`); + return; + } + + this._printResultIntoConsole({ text: mailText }); + + if (isNeedEmail && !isNeedPullRequest) { + this.notificationController.sendMailNotification({ mailText }); + } + + this.isNeedEmail = isNeedEmail; + this.mailText = mailText; + + if (isNeedPullRequest) { + await this.githubController.createPullRequest({ + prBody: mailText, + cb: this._handlePrResult + }); + } + } + + _handlePrResult(err, data) { + if (err) { + this._errorHandlePrResult(err); + } + + this._successfulHandlePrResult(data); + } + + _errorHandlePrResult(err) { + const { + body: { errors } + } = err; + + errors.forEach(({ message }) => console.log(message)); + + throw new Error("Can't create new pull request"); } - _filterModules(doc, moduleName) { - if (moduleName === 'all') { - return true; + _successfulHandlePrResult(data) { + const { html_url } = data; + + console.log(`New pull request created. Url: ${html_url}`); + + if (this.isNeedEmail) { + const mailTextWithPr = + `New pull request created. Url: ${html_url} <br><br><br>` + + this.mailText; + + this.notificationController.sendMailNotification({ + mailText: mailTextWithPr + }); } + } + + _printResultIntoConsole({ text }) { + const oldBreakSymbol = '<br>'; + const newBreakSymbol = '\n'; + + const consoleText = text.replace(new RegExp(oldBreakSymbol, 'g'), newBreakSymbol); - return doc.name === moduleName; + console.log(`Report: ${newBreakSymbol}`); + console.log(consoleText); } } diff --git a/tools/office-cmdlet-updater/controllers/module.controller.js b/tools/office-cmdlet-updater/controllers/module.controller.js new file mode 100644 index 0000000000..55b7d877d2 --- /dev/null +++ b/tools/office-cmdlet-updater/controllers/module.controller.js @@ -0,0 +1,121 @@ +const shortId = require('shortid'); +const of = require('await-of').default; +const { errorColor } = require('../helpers/colors'); + +class ModuleController { + constructor( + config, + moduleService, + cmdletService, + powerShellService, + logStoreService, + cmdletDependenciesService + ) { + this.config = config; + this.moduleService = moduleService; + this.pss = powerShellService; + this.logStoreService = logStoreService; + this.cmdletService = cmdletService; + this.cds = cmdletDependenciesService; + + this.installedDependencies = []; + } + + async updateMarkdown({ cliModuleName, cliCmdletName, isNeedPullRequest }) { + const modules = await this._getCmdletsAndInstallDependencies({ + cliModuleName, + cliCmdletName + }); + + return this._getUpdateResult({ modules, isNeedPullRequest }); + } + + async _installDependenciesForModules({ modules }) { + for (let module of modules) { + await this._installDependenceIfNeeded(module); + } + } + + async _installDependenceIfNeeded({ name }) { + if (!this.installedDependencies.includes(name)) { + this.installedDependencies.push(name); + + await this.cds.installDependencies({ cmdletName: name }); + } + } + + async _getCmdletsAndInstallDependencies({ cliModuleName, cliCmdletName }) { + let { docs: modules, ignoreFiles } = this.config.get('platyPS'); + + modules = this.moduleService.filterModules({ cliModuleName, modules }); + + await this._installDependenciesForModules({ modules }); + + return this.cmdletService.getModulesCmdlets({ + cliCmdletName, + ignoreFiles, + modules + }); + } + + async _getUpdateResult({ modules, isNeedPullRequest }) { + const { tempFolderPath } = this.config.get('platyPS'); + let moduleResults = []; + + for (let { cmdlets, module } of modules) { + let logs = [], + errors = []; + + for (let cmdletPath of cmdlets) { + const logFilePath = `${tempFolderPath}\\${shortId()}.log`; + + if (!isNeedPullRequest) { + const cmdletTempFolderPath = `${tempFolderPath}\\${shortId()}`; + + cmdletPath = await this.cmdletService.copyMdInTempFolder( + cmdletPath, + cmdletTempFolderPath + ); + } + + const { logContent, err } = await this._updateCmdletMarkdown({ + cmdletPath, + logFilePath + }); + + if (err) { + console.log(errorColor(err)); + + errors = [...errors, err]; + continue; + } + + console.log(logContent); + + logs = [...logs, logContent]; + } + + moduleResults = [...moduleResults, { module, logs, errors }]; + } + + return moduleResults; + } + + async _updateCmdletMarkdown({ cmdletPath, logFilePath }) { + const [, err] = await of( + this.pss.updateMarkdown(cmdletPath, logFilePath) + ); + + if (err) { + return { err }; + } + + const logContent = await this.logStoreService.getLogFileContent({ + logFilePath + }); + + return { logContent }; + } +} + +module.exports = ModuleController; diff --git a/tools/office-cmdlet-updater/controllers/notification.controller.js b/tools/office-cmdlet-updater/controllers/notification.controller.js new file mode 100644 index 0000000000..ff996293af --- /dev/null +++ b/tools/office-cmdlet-updater/controllers/notification.controller.js @@ -0,0 +1,94 @@ +const { keywords, noChangeValue, titleKeyword } = require('../constants/logs'); + +class NotificationController { + constructor(mailNotificationService, config) { + this.mailNotificationService = mailNotificationService; + this.config = config; + } + + sendMailNotification({ mailText }) { + this._sendMail({ mailText }); + } + + generateMailText({ parsedModules }) { + let mailText = ''; + + for (let { module, parsedLogs } of parsedModules) { + const { + isModuleChange, + mailText: moduleText + } = this._generateMailTextForModule({ + parsedLogs, + module + }); + + if (isModuleChange) { + mailText += moduleText; + } + } + + return mailText; + } + + _generateMailTextForModule({ parsedLogs, module }) { + const logsContent = [`Module: ${module}`]; + + parsedLogs.forEach((log) => { + let mailText = '', + isMailHasContent; + + for (const key in log) { + if (!log.hasOwnProperty(key)) { + continue; + } + + const value = log[key]; + + const isContent = value === noChangeValue || value === ''; + const isTitle = key === titleKeyword.value.trim(); + + if (isContent) { + continue; + } + + if (isTitle) { + const title = value.split(',')[0]; + + mailText += `File: ${title}<br>`; + continue; + } + + const { displayName } = keywords.find((kw) => kw.value === key); + + isMailHasContent = true; + mailText += `${displayName || key}: ${value}<br>`; + } + + if (isMailHasContent) { + logsContent.push(mailText); + } + }); + + return { + isModuleChange: logsContent.length > 1, + mailText: logsContent.join('<br><br>') + }; + } + + _sendMail({ mailText }) { + const { to, from, subject } = this.config.get('sendgrid.emailSettings'); + + const msg = { + html: mailText, + to, + from, + subject + }; + + this.mailNotificationService.addEmailToQueue(msg); + + console.log(`Email send successful to email: ${to}`); + } +} + +module.exports = NotificationController; diff --git a/tools/office-cmdlet-updater/db/index.js b/tools/office-cmdlet-updater/db/index.js deleted file mode 100644 index e623bc4beb..0000000000 --- a/tools/office-cmdlet-updater/db/index.js +++ /dev/null @@ -1,14 +0,0 @@ -const low = require('lowdb'); -const Memory = require('lowdb/adapters/Memory'); - -module.exports = () => { - const db = low(new Memory()); - - db.defaults({ - logs: new Map(), - errors: new Map(), - tempFolders: new Map() - }).write(); - - return db; -}; diff --git a/tools/office-cmdlet-updater/helpers/colors.js b/tools/office-cmdlet-updater/helpers/colors.js new file mode 100644 index 0000000000..cb2ad302c4 --- /dev/null +++ b/tools/office-cmdlet-updater/helpers/colors.js @@ -0,0 +1,14 @@ +const chalk = require('chalk'); + +const errorColor = (err) => { + const message = err.message || err; + + // remove default error color + const processedMsg = message.replace(/\[31m/g, '').replace(/\[39m/g, ''); + + return chalk.redBright.bgBlack(processedMsg); +}; + +module.exports = { + errorColor +}; diff --git a/tools/office-cmdlet-updater/helpers/di.container.js b/tools/office-cmdlet-updater/helpers/di.container.js index 9ad93f23ac..73aabf7503 100644 --- a/tools/office-cmdlet-updater/helpers/di.container.js +++ b/tools/office-cmdlet-updater/helpers/di.container.js @@ -1,17 +1,21 @@ const awilix = require('awilix'); const config = require('../services/config.service')(); const PowerShellService = require('../services/power.shell.service'); -const MarkdownService = require('../services/markdown.service'); const LogStoreService = require('../services/log.store.service'); const LogParseService = require('../services/log.parse.service'); const MailNotificationService = require('../services/mail.notification.service'); -const MarkdownController = require('../controllers/markdown.controller'); -const db = require('../db')(); const CmdletDependenciesService = require('../services/cmdlet.dependencies.service'); -const FsService = require('../services/fs.service'); const CliService = require('../services/cli.service'); const CliController = require('../controllers/cli.controller'); const CmdletService = require('../services/cmdlet.service'); +const GitService = require('../services/git.service'); +const GithubService = require('../services/github.service'); +const GithubController = require('../controllers/github.controller'); +const ModuleController = require('../controllers/module.controller'); +const ModuleService = require('../services/module.service'); +const LogsController = require('../controllers/logs.controller'); +const NotificationController = require('../controllers/notification.controller'); +const MarkdownController = require('../controllers/markdown.controller'); module.exports = () => { const container = awilix.createContainer({ @@ -20,8 +24,7 @@ module.exports = () => { }); container.register({ - config: awilix.asValue(config), - db: awilix.asValue(db) + config: awilix.asValue(config) }); container.register({ @@ -35,14 +38,21 @@ module.exports = () => { cmdletDependenciesService: awilix .asClass(CmdletDependenciesService) .singleton(), - fsService: awilix.asClass(FsService).singleton(), - markdownService: awilix.asClass(MarkdownService).singleton(), - cmdletService: awilix.asClass(CmdletService).singleton() + cmdletService: awilix.asClass(CmdletService).singleton(), + gitService: awilix.asClass(GitService).singleton(), + githubService: awilix.asClass(GithubService).singleton(), + moduleService: awilix.asClass(ModuleService) }); container.register({ - markdownController: awilix.asClass(MarkdownController).singleton(), - cliController: awilix.asClass(CliController).singleton() + moduleController: awilix.asClass(ModuleController), + cliController: awilix.asClass(CliController).singleton(), + githubController: awilix.asClass(GithubController).singleton(), + logsController: awilix.asClass(LogsController).singleton(), + notificationController: awilix + .asClass(NotificationController) + .singleton(), + markdownController: awilix.asClass(MarkdownController).singleton() }); return container; diff --git a/tools/office-cmdlet-updater/helpers/os.js b/tools/office-cmdlet-updater/helpers/os.js new file mode 100644 index 0000000000..9bcfaafc78 --- /dev/null +++ b/tools/office-cmdlet-updater/helpers/os.js @@ -0,0 +1,16 @@ +const { general } = require('../constants/errors'); + +const platforms = { + WIN_32: 'x86', + WIN_64: 'x64' +}; + +const checkWindowPlatformType = () => { + const isWin64 = process.arch === platforms.WIN_64; + + if (!isWin64) { + throw general.TOOL_PLATFORM_TYPE; + } +}; + +module.exports = checkWindowPlatformType; diff --git a/tools/office-cmdlet-updater/helpers/strings.js b/tools/office-cmdlet-updater/helpers/strings.js new file mode 100644 index 0000000000..744f082fd4 --- /dev/null +++ b/tools/office-cmdlet-updater/helpers/strings.js @@ -0,0 +1,11 @@ +module.exports.ciEquals = (a, b) => { + return typeof a === 'string' && typeof b === 'string' + ? a.localeCompare(b, undefined, { sensitivity: 'accent' }) === 0 + : a === b; +}; + +module.exports.ciEndsWith = (a, b) => { + const regex = new RegExp(`\\w*${a}`, 'gi'); + + return regex.test(b); +}; diff --git a/tools/office-cmdlet-updater/package.json b/tools/office-cmdlet-updater/package.json index f2704e0c02..514632f45a 100644 --- a/tools/office-cmdlet-updater/package.json +++ b/tools/office-cmdlet-updater/package.json @@ -27,12 +27,14 @@ "await-of": "^1.1.2", "awilix": "^3.0.9", "better-queue": "^3.8.10", + "chalk": "^2.4.2", "commander": "^2.19.0", "config": "^2.0.1", "fs-extra": "^7.0.0", - "lowdb": "^1.0.0", "moment": "^2.22.2", "node-powershell": "^3.3.1", + "nodegit": "^0.23.0", + "octonode": "^0.9.5", "shortid": "^2.2.13", "string-format": "^2.0.0" } diff --git a/tools/office-cmdlet-updater/services/cmdlet.dependencies.service.js b/tools/office-cmdlet-updater/services/cmdlet.dependencies.service.js index 7eb1c2c78b..da4ea446f9 100644 --- a/tools/office-cmdlet-updater/services/cmdlet.dependencies.service.js +++ b/tools/office-cmdlet-updater/services/cmdlet.dependencies.service.js @@ -1,4 +1,5 @@ const commands = require('../constants/commands'); +const errors = require('../constants/errors'); const format = require('string-format'); class CmdletDependenciesService { @@ -8,11 +9,13 @@ class CmdletDependenciesService { } async installDependencies({ cmdletName }) { - await this.installPlatyPs(); + await this.installGlobalDependencies(); switch (cmdletName) { case 'teams': { - await this.preInstallTeams(); + const { login, pass } = this._getCredentialsFromConfig(); + + await this.preInstallTeams({ login, pass }); break; } case 'skype': { @@ -39,19 +42,35 @@ class CmdletDependenciesService { await this.preInstallStuffHub(); break; } + default: { + } } } + async installGlobalDependencies() { + await this.installPsGallery(); + await this.installPlatyPs(); + } + async installPlatyPs() { await this.ps.invokeCommand(commands.INSTALL_PACKAGE_PROVIDER); await this.ps.invokeCommand(commands.INSTALL_PLATYPS); await this.ps.invokeCommand(commands.IMPORT_PLATYPS); } - async preInstallTeams() { - // TODO: check if user already auth + async installPsGallery() { + try { + await this.ps.invokeCommand(commands.INSTALL_PS_GALLERY); + } catch (e) { + throw errors.powerShellErrors.PS_GALLERY_INSTALL_ERROR; + } + } + async preInstallTeams({ login, pass }) { + await this._createCredInPs({ login, pass }); + //await this.ps.invokeCommand(commands.GET_TEAMS_CREDENTIALS); await this.ps.invokeCommand(commands.INSTALL_MICROSOFT_TEAM); + await this.ps.invokeCommand(commands.IMPORT_MICROSOFT_TEAM); await this.ps.invokeCommand(commands.CONNECT_MICROSOFT_TEAM); } @@ -62,9 +81,20 @@ class CmdletDependenciesService { async preInstallSkype({ login, pass }) { await this._createCredInPs({ login, pass }); - // await this.ps.invokeCommand(commands.SKYPE_INSTALL_MODULE); - await this.ps.invokeCommand(commands.SKYPE_CREATE_SESSION); - await this.ps.invokeCommand(commands.SKYPE_IMPORT_SESSION); + try { + await this.ps.invokeCommandAndIgnoreError({ + command: commands.SKYPE_ENABLE_WIN_RM, + printError: true + }); + + //await this.ps.invokeCommand(commands.SKYPE_GET_CRED); + await this.ps.invokeCommand(commands.SKYPE_INSTALL_LYNC_MODULE); + await this.ps.invokeCommand(commands.SKYPE_INSTALL_MODULE); + await this.ps.invokeCommand(commands.SKYPE_CREATE_SESSION); + await this.ps.invokeCommand(commands.SKYPE_IMPORT_SESSION); + } catch (e) { + throw errors.powerShellErrors.SKYPE_INSTALL_ERROR; + } } async preInstallWhiteboard() { @@ -74,21 +104,30 @@ class CmdletDependenciesService { async preInstallExchange({ login, pass }) { await this._createCredInPs({ login, pass }); - //await this.ps.invokeCommand(commands.EXCHANGE_INSTALL_MODULE); - await this.ps.invokeCommand(commands.EXCHANGE_GET_SESSION); - await this.ps.invokeCommand(commands.EXCHANGE_SESSION_IMPORT); + try { + await this.ps.invokeCommandAndIgnoreError({ + command: commands.SKYPE_ENABLE_WIN_RM, + printError: true + }); + + await this.ps.invokeCommand(commands.EXCHANGE_INSTALL_MODULE); + await this.ps.invokeCommand(commands.EXCHANGE_GET_SESSION); + await this.ps.invokeCommand(commands.EXCHANGE_SESSION_IMPORT); + } catch (e) { + throw errors.powerShellErrors.EXCHANGE_INSTALL_ERROR; + } } async preInstallStuffHub() { // TODO: install module when installation error will be fix - // await this.ps.invokeCommand(commands.STUFFHUB_INSTALL); + await this.ps.invokeCommand(commands.STUFFHUB_INSTALL); } _getCredentialsFromConfig() { const { login, pass } = this.config.get('platyPS.credentials'); if (!login || !pass) { - throw new Error('Invalid credentials'); + throw new Error(errors.powerShellErrors.EMPTY_CONFIG_CREDENTIALS); } return { login, pass }; diff --git a/tools/office-cmdlet-updater/services/cmdlet.service.js b/tools/office-cmdlet-updater/services/cmdlet.service.js index db41cb4c89..9e224e038c 100644 --- a/tools/office-cmdlet-updater/services/cmdlet.service.js +++ b/tools/office-cmdlet-updater/services/cmdlet.service.js @@ -1,3 +1,9 @@ +const fs = require('fs-extra'); +const path = require('path'); +const { ciEquals, ciEndWith } = require('../helpers/strings'); + +const mdExt = '.md'; + class CmdletService { constructor(config) { this.config = config; @@ -6,12 +12,127 @@ class CmdletService { ensureModuleExist(moduleName) { const modules = this.config.get('platyPS.docs'); - const isExist = modules.find(({ name }) => name === moduleName); + const isExist = modules.find(({ name }) => ciEquals(name, moduleName)); if (!isExist) { throw new Error(`Module with name "${moduleName}" didn't exist`); } } + + async getModulesCmdlets({ modules, cliCmdletName, ignoreFiles }) { + let cmdletsArr = []; + + for (let module of modules) { + const cmdlets = await this.getModuleCmdlets({ + cliCmdletName, + ignoreFiles, + module + }); + + if (!cmdlets.length) { + throw new Error( + `Can't find cmdlets in module "${module.name}"` + ); + } + + cmdletsArr = [...cmdletsArr, { module: module.name, cmdlets }]; + } + + return cmdletsArr; + } + + // region getModuleCmdlets + + async getModuleCmdlets({ module, ignoreFiles, cliCmdletName }) { + const { path, metaTags } = module; + const mdFiles = await this._getMdFiles(path); + + return mdFiles.filter( + (filePath) => + !this._isFileIgnore({ filePath, ignoreFiles }) && + this._isContainsTag({ filePath, metaTags }) && + this._filterCmdlets({ filePath, cliCmdletName }) + ); + } + + async _getMdFiles(folderPath) { + const allFiles = await this._getFolderFiles(folderPath); + + return allFiles.filter((file) => file.endsWith(mdExt)); + } + + async _getFolderFiles(folderPath) { + const files = await fs.readdir(folderPath); + + return await files.reduce(async (promiseResult, filePath) => { + const result = await promiseResult; + const absolute = path.resolve(folderPath, filePath); + + const fileStat = await fs.stat(absolute); + + if (fileStat.isDirectory()) { + const subDirFiles = await this._getFolderFiles(absolute); + + return [...result, ...subDirFiles]; + } + + return [...result, absolute]; + }, []); + } + + _isFileIgnore({ filePath, ignoreFiles }) { + const ignoreAbsolutePathsArr = ignoreFiles.map((f) => path.resolve(f)); + + const absoluteFilePath = path.resolve(filePath); + + return ignoreAbsolutePathsArr.includes(absoluteFilePath); + } + + _isContainsTag({ filePath, metaTags }) { + if (!metaTags.length) { + return true; + } + + const metaTagRegex = /(?<=applicable: ).+/gmu; + + const groups = fs + .readFileSync(filePath, 'utf8') + .toString() + .match(metaTagRegex); + + if (!groups) { + return false; + } + + for (const metaTag of metaTags) { + if (groups[0].indexOf(metaTag) !== -1) { + return true; + } + } + + return false; + } + + _filterCmdlets({ filePath, cliCmdletName }) { + if (!cliCmdletName) { + return true; + } + + return ciEndsWith(`${cliCmdletName}${mdExt}`, filePath); + } + + // endregion + + async copyMdInTempFolder(srcFilePath, tempFolderPath) { + const fileName = path.basename(srcFilePath); + const distFilePath = `${tempFolderPath}\\${fileName}`; + + await fs.ensureDir(tempFolderPath); + + await fs.copy(srcFilePath, distFilePath); + + return distFilePath; + } } module.exports = CmdletService; diff --git a/tools/office-cmdlet-updater/services/fs.service.js b/tools/office-cmdlet-updater/services/fs.service.js deleted file mode 100644 index 34be3aefb7..0000000000 --- a/tools/office-cmdlet-updater/services/fs.service.js +++ /dev/null @@ -1,138 +0,0 @@ -const path = require('path'); -const fs = require('fs-extra'); -const shortId = require('shortid'); - -class FsService { - constructor(config, logStoreService) { - this.config = config; - this.logStoreService = logStoreService; - - this.getTempFolderPath = this.getTempFolderPath.bind(this); - this.removeTempFolders = this.removeTempFolders.bind(this); - } - - // region getModuleFiles - - async getModuleFiles({ path, metaTags }) { - const { ignoreFiles } = this.config.get('platyPS'); - - const mdFiles = await this._getMdFiles(path); - - return mdFiles.filter( - (fileName) => - !this._isFileIgnore({ fileName, ignoreFiles }) && - this._isContainsTag({ filePath: fileName, metaTags }) - ); - } - - async _getMdFiles(folderPath) { - const mdExt = '.md'; - - const allFiles = await this._getFolderFiles(folderPath); - - return allFiles.filter((file) => file.endsWith(mdExt)); - } - - async _getFolderFiles(folderPath) { - const files = await fs.readdir(folderPath); - - return await files.reduce(async (promiseResult, filePath) => { - const result = await promiseResult; - const absolute = path.resolve(folderPath, filePath); - - const fileStat = await fs.stat(absolute); - - if (fileStat.isDirectory()) { - const subDirFiles = await this._getFolderFiles(absolute); - - return [...result, ...subDirFiles]; - } - - return [...result, absolute]; - }, []); - } - - _isFileIgnore({ fileName, ignoreFiles }) { - const ignoreAbsolutePathsArr = ignoreFiles.map((f) => path.resolve(f)); - - const absoluteFilePath = path.resolve(fileName); - - return ignoreAbsolutePathsArr.includes(absoluteFilePath); - } - - _isContainsTag({ filePath, metaTags }) { - if (!metaTags.length) { - return true; - } - - const metaTagRegex = /(?<=applicable: ).+/gmu; - - const groups = fs - .readFileSync(filePath, 'utf8') - .toString() - .match(metaTagRegex); - - if (!groups) { - return false; - } - - for (const metaTag of metaTags) { - if (groups[0].indexOf(metaTag) !== -1) { - return true; - } - } - - return false; - } - - // endregion - - async getTempFolderPath({ name }, path) { - let tempFolders = this.logStoreService.getAllTempFolders(); - - await fs.ensureDir(path); - - if (!tempFolders.has(name)) { - const tempFolderPath = `${path}\\${shortId()}`; - - this.logStoreService.addTempFolder(tempFolderPath, name); - - tempFolders = this.logStoreService.getAllTempFolders(); - } - - return tempFolders.get(name); - } - - async copyMdInTempFolder(srcFilePath, tempFolderPath) { - const fileName = path.basename(srcFilePath); - const distFilePath = `${tempFolderPath}\\${fileName}`; - - await fs.ensureDir(tempFolderPath); - - await fs.copy(srcFilePath, distFilePath); - - return distFilePath; - } - - async getFileContent(logFilePath) { - await fs.ensureFile(logFilePath); - - return (await fs.readFile(logFilePath)).toString(); - } - - async removeTempFolders() { - const { getAllTempFolders } = this.logStoreService; - - const tempFolders = [...getAllTempFolders().values()]; - - const tempFoldersPath = tempFolders.map((path) => path[0]); - - for (const path of tempFoldersPath) { - if (fs.pathExists(path)) { - fs.remove(path); - } - } - } -} - -module.exports = FsService; diff --git a/tools/office-cmdlet-updater/services/git.service.js b/tools/office-cmdlet-updater/services/git.service.js new file mode 100644 index 0000000000..0904395c61 --- /dev/null +++ b/tools/office-cmdlet-updater/services/git.service.js @@ -0,0 +1,51 @@ +const { Repository, Reference, Signature, Cred } = require('nodegit'); + +class GitService { + constructor(config) { + this.config = config; + } + + async openRepository({ path }) { + return await Repository.open(path); + } + + async stageAllFiles({ repository, filesMask }) { + const index = await repository.index(); + + await index.addAll(filesMask); + await index.write(); + return await index.writeTree(); + } + + async createCommit({ repository, commitMessage, id }) { + const { name, email } = this.config.get('github'); + + const author = Signature.now(name, email); + const commiter = Signature.now(name, email); + + const commitHead = await Reference.nameToId(repository, 'HEAD'); + const parentCommit = await repository.getCommit(commitHead); + + return await repository.createCommit( + 'HEAD', + author, + commiter, + commitMessage, + id, + [parentCommit] + ); + } + + async pushCommit({ remoteName, repository, login, pass, head, base }) { + const remote = await repository.getRemote(remoteName); + + await remote.push([`${head}:${base}`], { + callbacks: { + certificateCheck: () => 1, + credentials: () => Cred.userpassPlaintextNew(login, pass) + } + }); + } +} + +module.exports = GitService; diff --git a/tools/office-cmdlet-updater/services/github.service.js b/tools/office-cmdlet-updater/services/github.service.js new file mode 100644 index 0000000000..f2fa30e7dd --- /dev/null +++ b/tools/office-cmdlet-updater/services/github.service.js @@ -0,0 +1,29 @@ +const { client } = require('octonode'); + +class GithubService { + constructor(config) { + this.config = config; + + const { token } = config.get('github'); + + this.client = client(token); + } + + openRepository({ repositoryName }) { + return this.client.repo(repositoryName); + } + + createPullRequest({ repository, title, body, head, base, cb }) { + this.client.limit((err, left) => { + if (!left) { + console.log('Achieved GitHub token limit'); + + return; + } + + repository.pr({ title, body, head, base }, cb); + }); + } +} + +module.exports = GithubService; diff --git a/tools/office-cmdlet-updater/services/log.parse.service.js b/tools/office-cmdlet-updater/services/log.parse.service.js index 0e1299e532..ca2d3f4f1f 100644 --- a/tools/office-cmdlet-updater/services/log.parse.service.js +++ b/tools/office-cmdlet-updater/services/log.parse.service.js @@ -1,78 +1,10 @@ -class LogParseService { - constructor(logStoreService, mailNotificationService, config) { - this.logStoreService = logStoreService; - this.mns = mailNotificationService; - this.config = config; - - this.noChangeValue = '__AllParameterSets'; - this.titleKeyword = { - value: 'UPDATING Cmdlet ', - displayName: 'UPDATING Cmdlet' - }; - this.keywords = [ - this.titleKeyword, - { - value: 'Parameter Added', - displayName: 'Parameter Added' - }, - { - value: 'Parameter Deleted', - displayName: 'Parameter Deleted' - }, - { - value: 'Parameter Updated', - displayName: 'Parameter Updated' - }, - { - value: 'Parameter Set Added', - displayName: 'Parameter Set Added' - }, - { - value: 'Parameter Set Deleted', - displayName: 'Parameter Set Deleted' - }, - { - value: 'Parameter Set Name Updated', - displayName: 'Parameter Set Name Updated' - } - ]; - } - - parseAll() { - const parseLogs = []; - - const allLogs = [...this.logStoreService.getAllLogs().values()]; - - const logs = allLogs.reduce( - (acc, cur) => [...acc, ...cur], - [] - ); - - logs.forEach((log) => { - const logObj = this.parse(log); - - parseLogs.push(logObj); - }); +const { keywords } = require('../constants/logs'); - const msg = this.generateMailText(parseLogs); - - if (msg) { - const outputText = msg.replace(new RegExp('<br>', 'g'), '\n'); - - console.log(`\n\n${outputText}`); - - this.sendLogByEmailIfNeeded(msg); - } else { - const { docPath } = this.config.get('platyPS'); - - console.log(`In folder '${docPath}' didn't found any changes`); - } - } - - parse(log) { +class LogParseService { + parse({ log }) { const logObj = {}; - this.keywords.forEach(({ value }) => { + keywords.forEach(({ value }) => { const regex = new RegExp(`\t*(?<=${value}: ).*?(?=\\s)`, 'gi'); const values = log.match(regex); @@ -81,63 +13,6 @@ class LogParseService { return logObj; } - - generateMailText(logObjs) { - const logsContent = []; - - logObjs.forEach((log) => { - let mailText = '', - isMailHasContent; - - for (const key in log) { - if (!log.hasOwnProperty(key)) { - continue; - } - - const value = log[key]; - - const isContent = value === this.noChangeValue || value === ''; - const isTitle = key === this.titleKeyword.value.trim(); - - if (isContent) { - continue; - } - - if (isTitle) { - const title = value.split(',')[0]; - - mailText += `File: ${title}<br>`; - continue; - } - - const { displayName } = this.keywords.find( - (kw) => kw.value === key - ); - - isMailHasContent = true; - mailText += `${displayName || key}: ${value}<br>`; - } - - if (isMailHasContent) { - logsContent.push(mailText); - } - }); - - return logsContent.join('<br><br>'); - } - - sendLogByEmailIfNeeded(text) { - const { to, from, subject } = this.config.get('sendgrid.emailSettings'); - - const msg = { - html: text, - to, - from, - subject - }; - - this.mns.addEmailToQueue(msg); - } } module.exports = LogParseService; diff --git a/tools/office-cmdlet-updater/services/log.store.service.js b/tools/office-cmdlet-updater/services/log.store.service.js index 2ceb30b8f3..3554679701 100644 --- a/tools/office-cmdlet-updater/services/log.store.service.js +++ b/tools/office-cmdlet-updater/services/log.store.service.js @@ -3,71 +3,22 @@ const fs = require('fs-extra'); const moment = require('moment'); class LogStoreService { - constructor(db) { - this.db = db; + async getLogFileContent({ logFilePath }) { + await fs.ensureFile(logFilePath); - this.getAllTempFolders = this.getAllTempFolders.bind(this); + return (await fs.readFile(logFilePath)).toString(); } - addLog(log, name) { - this._addMap('logs', log, name); - } - - addError(err, name) { - this._addMap('errors', err, name); - } - - addTempFolder(name, tempFolderName) { - this._addMap('tempFolders', name, tempFolderName); - } - - getAllLogs() { - return this._getAll('logs'); - } - - getAllErrors() { - return this._getAll('errors'); - } - - getAllTempFolders() { - return this._getAll('tempFolders'); - } - - _addMap(collection, obj, name) { - const map = this.db.get(collection).value(); - - if (!map.has(name)) { - map.set(name, []); - } - - const arr = [...map.get(name), obj]; - - map.set(name, arr); - - this.db.set(collection, map).write(); - } - - _getAll(collection) { - return this.db.get(collection).value(); - } - - saveInFs() { - const logs = this.getAllLogs(); - - for (const key of logs.keys()) { - const fileName = `${this._getLogName()}.log`; - const filePath = path.join('.local', 'logs', key, fileName); - - fs.ensureFileSync(filePath); + saveInFs({ name, logs, errors }) { + const fileName = `${this._getLogName()}.log`; + const filePath = path.join('.local', 'logs', name, fileName); - const logs = this.getAllLogs().get(key); - const logsContent = logs ? logs.join('\n') : ''; + fs.ensureFileSync(filePath); - const errors = this.getAllErrors().get(key); - const errorContent = errors ? errors.join('\n') : ''; + const logsContent = logs ? logs.join('\n') : ''; + const errorContent = errors ? errors.join('\n') : ''; - fs.writeFile(filePath, logsContent + errorContent); - } + fs.writeFile(filePath, logsContent + errorContent); } _getLogName() { diff --git a/tools/office-cmdlet-updater/services/mail.notification.service.js b/tools/office-cmdlet-updater/services/mail.notification.service.js index 559a13639d..ffd5c7e10a 100644 --- a/tools/office-cmdlet-updater/services/mail.notification.service.js +++ b/tools/office-cmdlet-updater/services/mail.notification.service.js @@ -4,29 +4,13 @@ const { mailErrors } = require('../constants/errors'); const of = require('await-of').default; class MailNotificationService { - constructor(logStoreService, config) { - const { apiKey, sendMailNotification } = config.get('sendgrid'); - - this.sendMailNotification = sendMailNotification; + constructor(config) { + const { apiKey } = config.get('sendgrid'); if (!apiKey) { throw new Error(mailErrors.CANT_GET_SENDGRID_API_KEY); } - const { from, to, subject } = config.get('sendgrid.emailSettings'); - - if (!from) { - throw new Error(mailErrors.CANT_GET_MAIL_FROM); - } - - if (!to) { - throw new Error(mailErrors.CANT_GET_MAIL_TO); - } - - if (!subject) { - throw new Error(mailErrors.CANT_GET_MAIL_SUBJECT); - } - sgMail.setApiKey(apiKey); this.sgMail = sgMail; @@ -37,10 +21,6 @@ class MailNotificationService { } addEmailToQueue(mail) { - if (!this.sendMailNotification) { - return; - } - this.queue.push(mail); } diff --git a/tools/office-cmdlet-updater/services/markdown.service.js b/tools/office-cmdlet-updater/services/markdown.service.js deleted file mode 100644 index 24f5e68c49..0000000000 --- a/tools/office-cmdlet-updater/services/markdown.service.js +++ /dev/null @@ -1,142 +0,0 @@ -const Queue = require('better-queue'); -const of = require('await-of').default; -const shortId = require('shortid'); - -class MarkdownService { - constructor( - powerShellService, - logStoreService, - logParseService, - cmdletDependenciesService, - fsService, - config - ) { - this.logStoreService = logStoreService; - this.pss = powerShellService; - this.logParseService = logParseService; - this.config = config; - this.cds = cmdletDependenciesService; - this.fsService = fsService; - - this.processQueue = this.processQueue.bind(this); - this.queueFinishHandler = this.queueFinishHandler.bind(this); - this.updateMd = this.updateMd.bind(this); - this.addMdFilesInQueue = this.addMdFilesInQueue.bind(this); - this.queueEmptyHandler = this.queueEmptyHandler.bind(this); - this.queueFailedHandler = this.queueFailedHandler.bind(this); - - this.queue = new Queue(this.processQueue); - this.queue.on('empty', this.queueEmptyHandler); - - this.installedDependencies = []; - } - - async updateMd(doc, cmdlet) { - return this.addMdFilesInQueue(doc, cmdlet); - } - - async addMdFilesInQueue(doc, cmdlet) { - const mdFiles = (await this.fsService.getModuleFiles(doc)).filter( - (file) => this._filterCmdlets(file, cmdlet) - ); - - if (!mdFiles.length) { - throw new Error( - `Can't find cmdlet "${cmdlet}" in module "${doc.name}"` - ); - } - - mdFiles.forEach((file) => { - this.queue - .push({ file, doc }) - .on('failed', this.queueFailedHandler) - .on('finish', this.queueFinishHandler); - }); - } - - _filterCmdlets(mdPath, cmdletName) { - if (!cmdletName) { - return true; - } - - const mdExt = '.md'; - - return mdPath.endsWith(`${cmdletName}${mdExt}`); - } - - async processQueue({ file, doc }, cb) { - let result, err; - - let { tempFolderPath } = this.config.get('platyPS'); - const { - copyMdInTempFolder, - getTempFolderPath, - getFileContent - } = this.fsService; - - await this._installDependenceIfNeeded(doc); - - [tempFolderPath] = await getTempFolderPath(doc, tempFolderPath); - - const logFilePath = `${tempFolderPath}\\${shortId()}.log`; - - [result, err] = await of(copyMdInTempFolder(file, tempFolderPath)); - - if (err) { - return cb(err, null); - } - - [result, err] = await of(this.pss.updateMarkdown(result, logFilePath)); - - if (err) { - console.error(err); - - this.logStoreService.addError(err, doc.name); - - return cb(null, ''); - } - - console.log(result); // print powershell command result - - [result, err] = await of(getFileContent(logFilePath)); - - console.log(result); // print update file log - - if (err) { - return cb(err, null); - } - - return cb(null, { result, doc }); - } - - async queueFailedHandler(err) { - throw new Error(err); - } - - queueFinishHandler({ result, doc }) { - if (!result) { - return; - } - this.logStoreService.addLog(result, doc.name); - } - - async queueEmptyHandler() { - this.pss.dispose(); - - this.logStoreService.saveInFs(); - - await this.fsService.removeTempFolders(); - - this.logParseService.parseAll(); - } - - async _installDependenceIfNeeded({ name }) { - if (!this.installedDependencies.includes(name)) { - this.installedDependencies.push(name); - - await this.cds.installDependencies({ cmdletName: name }); - } - } -} - -module.exports = MarkdownService; diff --git a/tools/office-cmdlet-updater/services/module.service.js b/tools/office-cmdlet-updater/services/module.service.js new file mode 100644 index 0000000000..5ed28de838 --- /dev/null +++ b/tools/office-cmdlet-updater/services/module.service.js @@ -0,0 +1,16 @@ +const { ciEquals } = require('../helpers/strings'); + +class ModuleService { + constructor() {} + + filterModules({ cliModuleName, modules }) { + // TODO: move 'all' into constants + if (cliModuleName === 'all') { + return modules; + } + + return modules.filter((module) => ciEquals(module.name, cliModuleName)); + } +} + +module.exports = ModuleService; diff --git a/tools/office-cmdlet-updater/services/power.shell.service.js b/tools/office-cmdlet-updater/services/power.shell.service.js index 501546e825..af8a7fc5a9 100644 --- a/tools/office-cmdlet-updater/services/power.shell.service.js +++ b/tools/office-cmdlet-updater/services/power.shell.service.js @@ -2,12 +2,13 @@ const Shell = require('node-powershell'); const of = require('await-of').default; const commands = require('../constants/commands'); const format = require('string-format'); +const { errorColor } = require('../helpers/colors'); class PowerShellService { constructor(config) { this.config = config; this.ps = new Shell({ - executionPolicy: 'Bypass', + executionPolicy: 'Unrestricted', noProfile: true }); } @@ -24,14 +25,24 @@ class PowerShellService { const [output, err] = await of(this.ps.invoke()); if (err) { - console.error(err); - throw new Error(err); } return output; } + async invokeCommandAndIgnoreError({ command, printError = false }) { + await this.ps.addCommand(command); + + const [output, err] = await of(this.ps.invoke()); + + if (err && printError) { + console.error(errorColor(err)); + } + + return output; + } + async dispose() { return await this.ps.dispose(); } diff --git a/whiteboard/docfx.json b/whiteboard/docfx.json index a7e705cca0..b5ec7d6eab 100644 --- a/whiteboard/docfx.json +++ b/whiteboard/docfx.json @@ -21,7 +21,8 @@ "dest": "whiteboard/whiteboard-ps" }, { - "files": ["**/*.md"], + "files": ["**/*.yml"], + "exclude": ["toc.yml"], "src": "whiteboard-ps", "version": "whiteboard-ps", "dest": "module" @@ -53,6 +54,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author" : "tbrosman", "ms.author" : "tbrosman", "manager" : "shanejc", @@ -60,9 +62,8 @@ "ms.topic" : "reference", "ms.service" : "whiteboard-powershell", "ms.devlang" : "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": {}, "template": [], diff --git a/whiteboard/docs-conceptual/LICENSE.txt b/whiteboard/docs-conceptual/LICENSE.txt index e3dd3fb292..a8ffd9d069 100644 --- a/whiteboard/docs-conceptual/LICENSE.txt +++ b/whiteboard/docs-conceptual/LICENSE.txt @@ -1,6 +1,6 @@ ------------------------------------------- START OF LICENSE ----------------------------------------- -Microsoft Whiteboard Admin PowerShell Cmdlets +Microsoft Whiteboard Admin PowerShell Cmdlets Copyright (c) Microsoft Corporation. All rights reserved. diff --git a/whiteboard/docs-conceptual/index.md b/whiteboard/docs-conceptual/index.md index 0c07b51a60..331ec723d3 100644 --- a/whiteboard/docs-conceptual/index.md +++ b/whiteboard/docs-conceptual/index.md @@ -1,7 +1,12 @@ +--- +title: Microsoft Whiteboard PowerShell +description: "Learn about Microsoft Whiteboard PowerShell." +--- + # Microsoft Whiteboard PowerShell Welcome to the Microsoft Whiteboard PowerShell cmdlet help references. The Microsoft Whiteboard cmdlets provide the command line interface for service administration and management. -Here you will find all of the Microsoft Whiteboard PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here you will find all of the Microsoft Whiteboard PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. \ No newline at end of file +The repo is located here: <https://github.com/microsoftdocs/office-docs-powershell> and you can find the README displayed at the bottom of the page. diff --git a/whiteboard/docs-conceptual/overview.md b/whiteboard/docs-conceptual/overview.md index df7913c47c..38782d52de 100644 --- a/whiteboard/docs-conceptual/overview.md +++ b/whiteboard/docs-conceptual/overview.md @@ -1,3 +1,8 @@ +--- +title: Whiteboard Overview +description: "Whiteboard PowerShell overview." +--- + # Overview ## Installing @@ -6,18 +11,44 @@ To install and use the Microsoft Whiteboard cmdlets: 1. Open the start menu and search for Windows PowerShell 2. Right-click on Windows PowerShell and choose Run As Administrator -3. Type or copy this command into the window and press the Enter key: Install-Module -Name WhiteboardAdmin +3. Type or copy this command into the window and press the Enter key: + +```powershell +Install-Module -Name WhiteboardAdmin +``` + +By default, the PowerShell Gallery (PSGallery) isn't configured as a trusted repository for **PowerShellGet**. The first time you use the PSGallery, you'll see the following message: + +```console +Untrusted repository + +You are installing the modules from an untrusted repository. If you trust this repository, change +its InstallationPolicy value by running the `Set-PSRepository` cmdlet. -You may need to update your execution policy, which you can do by typing or copying this command into the window and pressing the Enter key: Set-ExecutionPolicy RemoteSigned +Are you sure you want to install the modules from 'PSGallery'? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): +``` -Note: For more information on Execution_Policies, go to https://go.microsoft.com/fwlink/?LinkID=135170 +Answer **Yes** or **Yes to All** to continue with the installation. + +You may need to update your execution policy, which you can do by typing or copying this command into the window and pressing the Enter key: + +```powershell +Set-ExecutionPolicy RemoteSigned +``` + +Note: For more information on Execution_Policies, go to <https://go.microsoft.com/fwlink/p/?LinkID=135170>. ## User IDs -Cmdlets taking user IDs use the ID from Azure Active Directory. To get a user ID, you can use the Microsoft Graph Explorer. For more information, go to https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/user_get +Cmdlets taking user IDs use the ID from Microsoft Entra ID. To get a user ID, you can use the Microsoft Graph Explorer. For more information, go to </graph/api/user-get>. + +## Exporting Whiteboard Content + +The Microsoft Whiteboard cmdlets are often used to facilitate the export of Whiteboard content for users that no longer have access to whiteboard. To accomplish this you must first transfer the whiteboard owner to someone who has access to Whiteboard. Then the user who now owns the whiteboard can sign into the app and export the content. ## Common Cmdlets -* [Get-Whiteboard](../whiteboard-ps/whiteboard/Get-Whiteboard.md) -* [Set-WhiteboardOwner](../whiteboard-ps/whiteboard/Set-WhiteboardOwner.md) -* [Invoke-TransferAllWhiteboard](../whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md) \ No newline at end of file +* @MicrosoftWhiteboardAdmin.Get-Whiteboard +* @MicrosoftWhiteboardAdmin.Set-WhiteboardOwner +* @MicrosoftWhiteboardAdmin.Invoke-TransferAllWhiteboards diff --git a/whiteboard/mapping/MAML2Yaml/monikerMapping.json b/whiteboard/mapping/MAML2Yaml/monikerMapping.json new file mode 100644 index 0000000000..eed7eeed64 --- /dev/null +++ b/whiteboard/mapping/MAML2Yaml/monikerMapping.json @@ -0,0 +1,11 @@ +{ + "whiteboard-ps": { + "conceptualToc": "docs-conceptual/toc.yml", + "conceptualTocUrl": "/powershell/whiteboard/whiteboard-ps/toc.json", + "referenceTocUrl": "/powershell/module/whiteboard-ps/toc.json", + "packageRoot": "whiteboard-ps", + "modules": { + "whiteboard": {} + } + } +} diff --git a/whiteboard/mapping/monikerMapping.json b/whiteboard/mapping/monikerMapping.json deleted file mode 100644 index de334b7c4b..0000000000 --- a/whiteboard/mapping/monikerMapping.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "whiteboard-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/whiteboard/whiteboard-ps/toc.json", - "referenceTocUrl": "/powershell/module/whiteboard-ps/toc.json", - "packageRoot": "whiteboard-ps", - "modules": { - "whiteboard": {} - } - } -} diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md new file mode 100644 index 0000000000..1b2ef53c77 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md @@ -0,0 +1,111 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboards +applicable: Microsoft Whiteboard +title: Get-OriginalFluidWhiteboards +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-OriginalFluidWhiteboards + +## SYNOPSIS + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive and return them as objects. + +## SYNTAX + +```powershell +Get-OriginalFluidWhiteboards [-UserId] [-ForceAuthPrompt] [<CommonParameters>] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001 +``` + +Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive. + +### Output + +```yaml +Drive Items found for User 00000000-0000-0000-0000-000000000001 --------------------------------------------------- +Name: TradeTestwhiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: 00000000-0000-0000-0000-000000000001 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: 00000000-0000-0000-0000-000000000001 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +``` + +## PARAMETERS + +### -UserId + +The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that user whiteboards. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md new file mode 100644 index 0000000000..e6779e12ce --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md @@ -0,0 +1,178 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboardsfortenant +applicable: Microsoft Whiteboard +title: Get-OriginalFluidWhiteboardsForTenant +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-OriginalFluidWhiteboardsForTenant + +## SYNOPSIS + +Gets one or more whiteboards that are originally created as fluid directly into OneDrive for all users under that admin and returns them as objects. + +## SYNTAX + +```powershell +Get-OriginalFluidWhiteboardsForTenant [-IncrementalRunName <String>] [-ForceAuthPrompt] [<CommonParameters>] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are originally created as fluid directly into OneDrive and returns them as objects. It output all boards created directly into OneDrive in all user accounts under that Tenant + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant +``` + +Get all user's originally created fluid whiteboards in that tenant and outputs in cmd with all users whiteboards provided admin has access to all those users oneDrive for which it is intended to get whiteboards. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd --------------------------------------------------- +Name: Azure111 whiteboard 1.whiteboard +ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ +Last Modified: 02/13/2025 16:45:58 +Size: 23110 bytes +Migration Date: 02/13/2025 16:45:37 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +Name: Azure111 whiteboard.whiteboard +ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL +Last Modified: 02/19/2025 07:35:25 +Size: 12007 bytes +Migration Date: 02/19/2025 07:35:24 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS +Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive. +``` + +### EXAMPLE 2 + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant -IncrementalRunName 1 +``` + +Get all user's originally created fluid whiteboards in that tenant and incrementally creates file "WhiteboardsOriginalFluid-$IncrementalRunName.txt" with all users whiteboards provided admin has access to all those users oneDrive for which it is intended to get whiteboards. + +### Output + +```yaml +[ + "Name: Test11whiteboard.whiteboard", + "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", + "Last Modified: 03/06/2025 09:59:32", + "Size: 15222 bytes", + "Migration Date: 03/06/2025 09:58:57", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------", + "Name: Untitled.whiteboard", + "ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M", + "Last Modified: 02/19/2025 05:19:04", + "Size: 15307 bytes", + "Migration Date: 02/19/2025 05:19:04", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------" +] +[ + "Name: Azure111 whiteboard.whiteboard", + "ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL", + "Last Modified: 02/19/2025 07:35:25", + "Size: 12007 bytes", + "Migration Date: 02/19/2025 07:35:24", + "User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd", + "User Email: admin@M365x86764163.onmicrosoft.com", + "User Name: MOD Administrator", + "-----------------------------------------------" +] +``` + +## PARAMETERS + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: + +- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md index 098bc8574b..a533b03ca5 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md @@ -1,86 +1,104 @@ --- -external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftWhiteboard +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboard applicable: Microsoft Whiteboard title: Get-Whiteboard -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +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 -### Get a specific Whiteboard - -```powershell -Get-Whiteboard [-Token <AuthenticationResult>] -UserId <Guid> -WhiteboardId <Guid> [<CommonParameters>] -``` - -### Get all Whiteboards for a user - ```powershell -Get-Whiteboard [-Token <AuthenticationResult>] -UserId <Guid> [<CommonParameters>] +Get-Whiteboard [-UserId] <Guid> [[-WhiteboardId] <Guid>] [-ForceAuthPrompt] [<CommonParameters>] ``` ## 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 -------------------------- +### EXAMPLE 1 -``` +```powershell PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 ``` -Get all of a user's Whiteboards. +Get all of a user's whiteboards. +### EXAMPLE 2 -## PARAMETERS +```powershell +PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` -### -Token -The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated. +Get a user's specific whiteboard. + +### Output ```yaml -Type: Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult -Required: false -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false -Applicable: Microsoft Whiteboard +baseApi: baseApi-value +id: whiteboardId-value +userId: userId-value +folioId: folioId-value +title: title-value +createdBy: createdBy-value +ownerId: ownerId-value +ownerTenantId: ownerTenantId-value +isShared: isShared-value +createdTime: createdTime-value +invitedTime: invitedTime-value +personalLastModifiedTime: personalLastModifiedTime-value +lastModifiedTime: lastModifiedTime-value +globalLastViewedTime: globalLastViewedTime-value +lastViewedTime: lastViewedTime-value +meetingId: meetingId-value +eTag: eTag-value ``` +## PARAMETERS + ### -UserId -Optional. The ID of the user account to query Whiteboards for. All Whiteboards this account has access to will be returned. + +The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned. ```yaml -Type: Guid -Required: true -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` ### -WhiteboardId -Optional. The ID of a specific Whiteboard. +Optional. The ID of a specific whiteboard. ```yaml -Type: Guid -Required: true -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` @@ -89,25 +107,28 @@ Applicable: Microsoft Whiteboard Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: false -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -## INPUTS +### CommonParameters -### None +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) -## OUTPUTS +## INPUTS -### System.Object +## OUTPUTS ## NOTES -For details on user IDs, see the [overview page](whiteboard.md). +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md new file mode 100644 index 0000000000..1f5bb1aa2a --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md @@ -0,0 +1,113 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardowners +applicable: Microsoft Whiteboard +title: Get-WhiteboardOwners +schema: 2.0.0 +author: shlevari +ms.author: shlevari +ms.reviewer: +--- + +# Get-WhiteboardOwners + +## SYNOPSIS + +Gets all the users in a tenant who own whiteboards in a specified geography. + +## SYNTAX + +```powershell +Get-WhiteboardOwners [-Geography] <String> [[-ContinuationToken] <String>] [-ForceAuthPrompt] [<CommonParameters>] +``` + +## 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. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardOwners -Geography Europe +``` + +Get the owners in the European geography. + +### Output + +```yaml +TenantId: tenantId +Geography: The geography queried for +Items: List of user ids +ContinuationToken: continuation token +``` + +## PARAMETERS + +### -Geography + +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: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ContinuationToken + +Optional. The continuation token returned in a previous call. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md new file mode 100644 index 0000000000..ca58a28bde --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md @@ -0,0 +1,87 @@ +--- +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 + +```powershell +Get-WhiteboardSettings + [-ForceAuthPrompt] + [<CommonParameters>] +``` + +## DESCRIPTION + +Gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +## EXAMPLES + +### EXAMPLE 1 + +This command gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +```powershell +PS C:\> Get-WhiteboardSettings +``` + +```Output +isClaimEnabled : True +privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} +tenantMetadata : @{isGovUser=False; isEduUser=False} +isSharePointDefault : False +isSharePointDefaultGa : True +isSharePointDefaultRolledOut : True +isAzureBlocked : False +licenseCheckInformation : Success +isFluidMigrationEnabled : False +isTenantAdminMigrationEnabled : True +isEnabled : True +isEnabledGa : True +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md new file mode 100644 index 0000000000..531dc66db0 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md @@ -0,0 +1,148 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenant +applicable: Microsoft Whiteboard +title: Get-WhiteboardsForTenant +schema: 2.0.0 +author: samanehrajabi +ms.author: srajabi +ms.reviewer: +--- + +# Get-WhiteboardsForTenant + +## SYNOPSIS + +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +## SYNTAX + +```powershell +Get-WhiteboardsForTenant [-Geography <String>] + [-IncrementalRunName <String>] + [-ForceAuthPrompt] + [<CommonParameters>] +``` + +## DESCRIPTION + +Gets all the whiteboards in Azure in a tenant in a specified geography. Returns a list of whiteboard objects. The data is pre-calculated approximately every two weeks and is not realtime. + +## EXAMPLES + +### EXAMPLE 1 + +This command gets all the whiteboards in Azure associated with the caller's tenant in Europe as a list of whiteboard metadata objects. + +```powershell +PS C:\> Get-WhiteboardsForTenant -Geography Europe +``` + +```Output +baseApi : eu.whiteboard.microsoft.com +id : 00000000-0000-0000-0000-000000000001 +userId : 00000000-0000-0000-0000-000000000000 +folioId : 00000000-0000-0000-0000-000000000000 +title : title1 +createdBy : 00000000-0000-0000-0000-000000000000 +ownerId : 00000000-0000-0000-0000-000000000000 +ownerTenantId : 00000000-0000-0000-0000-000000000000 +isShared : False +createdTime : 2022-09-10T19:59:03.3407011Z +invitedTime : +personalLastModifiedTime : 2022-09-11T15:53:32.4494737Z +lastModifiedTime : 2022-09-11T15:53:32.4494737Z +globalLastViewedTime : 2022-09-11T15:55:28.7242817Z +lastViewedTime : 2022-09-11T15:55:28.7242817Z +meetingId : +eTag : W/"datetime'2022-09-11T19%3A23%3A56.2845616Z'" + +baseApi : eu.whiteboard.microsoft.com +id : 00000000-0000-0000-0000-000000000002 +userId : 00000000-0000-0000-0000-000000000000 +folioId : 00000000-0000-0000-0000-000000000000 +title : title2 +createdBy : 00000000-0000-0000-0000-000000000000 +ownerId : 00000000-0000-0000-0000-000000000000 +ownerTenantId : 00000000-0000-0000-0000-000000000000 +isShared : False +createdTime : 2023-01-06T19:23:04.8807147Z +invitedTime : +personalLastModifiedTime : 2023-01-06T19:23:13.6235107Z +lastModifiedTime : 2023-01-06T19:23:13.6235107Z +globalLastViewedTime : 2023-01-06T19:23:56.0264268Z +lastViewedTime : 2023-01-06T19:23:56.0264268Z +meetingId : +eTag : W/"datetime'2023-01-06T19%3A22%3A42.6717851Z'" +``` + +## PARAMETERS + +### -Geography + +The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` (all boards not in Australia or Europe). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Use to resume a partially completed run. Use the same **IncrementalRunName** value on later calls to continue a previously canceled or failed run. Writes progress and results to `.txt` files in the current directory: + +- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. +- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided **IncrementalRunName**. This file should not be modified manually. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md new file mode 100644 index 0000000000..c29105b13b --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md @@ -0,0 +1,178 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenantmigrated +applicable: Microsoft Whiteboard +title: Get-WhiteboardsForTenantMigrated +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardsForTenantMigrated + +## SYNOPSIS + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +## SYNTAX + +```powershell +Get-WhiteboardsForTenantMigrated [-IncrementalRunName <String>] [-ForceAuthPrompt] [<CommonParameters>] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. It output all boards migrated to OneDrive in all user accounts under that Tenant provided Admin have access to all those users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardsForTenantMigrated +``` + +Get all user's migrated whiteboards in that tenant and outputs in cmd with all users whiteboards provided admin has access to all those users oneDrive. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd --------------------------------------------------- +Name: Azure111 whiteboard 1.whiteboard +ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ +Last Modified: 02/13/2025 16:45:58 +Size: 23110 bytes +Migration Date: 02/13/2025 16:45:37 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +Name: Azure111 whiteboard.whiteboard +ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL +Last Modified: 02/19/2025 07:35:25 +Size: 12007 bytes +Migration Date: 02/19/2025 07:35:24 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS +Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive. +``` + +### EXAMPLE 2 + +```powershell +PS C:\>Get-WhiteboardsForTenantMigrated -IncrementalRunName 1 +``` + +Get all user's migrated whiteboards in that tenant and incrementally creates file "WhiteboardsMigrated-$IncrementalRunName.txt" with all users whiteboards provided admin has access to all those users oneDrive. + +### Output + +```yaml +[ + "Name: Test11whiteboard.whiteboard", + "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", + "Last Modified: 03/06/2025 09:59:32", + "Size: 15222 bytes", + "Migration Date: 03/06/2025 09:58:57", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------", + "Name: Untitled.whiteboard", + "ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M", + "Last Modified: 02/19/2025 05:19:04", + "Size: 15307 bytes", + "Migration Date: 02/19/2025 05:19:04", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------" +] +[ + "Name: Azure111 whiteboard.whiteboard", + "ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL", + "Last Modified: 02/19/2025 07:35:25", + "Size: 12007 bytes", + "Migration Date: 02/19/2025 07:35:24", + "User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd", + "User Email: admin@M365x86764163.onmicrosoft.com", + "User Name: MOD Administrator", + "-----------------------------------------------" +] +``` + +## PARAMETERS + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: + +- `WhiteboardsMigrated-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md new file mode 100644 index 0000000000..6bff3167e4 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md @@ -0,0 +1,111 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsmigrated +applicable: Microsoft Whiteboard +title: Get-WhiteboardsMigrated +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardsMigrated + +## SYNOPSIS + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +## SYNTAX + +```powershell +Get-WhiteboardsMigrated [-UserId] [-ForceAuthPrompt] [<CommonParameters>] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are migrated to OneDrive for particular user and returns them as objects provided Admin have access to that user OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardsMigrated -UserId e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +``` + +Get all user's migrated whiteboards. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +``` + +## PARAMETERS + +### -UserId + +The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that users whiteboards. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md b/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md index 1809365418..a770d4b062 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md +++ b/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md @@ -1,74 +1,65 @@ --- -external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftWhiteboard +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/invoke-transferallwhiteboards applicable: Microsoft Whiteboard -title: Set-WhiteboardOwner -online version: +title: Invoke-TransferAllWhiteboards schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +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 [[-Token] <AuthenticationResult>] [-OwnerId] <Guid> [-NewOwnerId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>] +Invoke-TransferAllWhiteboards [-OldOwnerId] <Guid> [-NewOwnerId] <Guid> [-ForceAuthPrompt] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION -Transfer ownership of all Whiteboards owned by a user to another user. +Transfer ownership of all whiteboards owned by a user to another user. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 -``` +```powershell PS C:\>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. +Check how many whiteboards will be transferred without transferring them. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 -``` +```powershell PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 ``` Transfer (and prompt before performing any write actions). - ## PARAMETERS -### -Token - -The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated. - -```yaml -Type: Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult -Required: false -Position: 1 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false -Applicable: Microsoft Whiteboard -``` - ### -OldOwnerId The ID of the previous owner. ```yaml -Type: Guid -Required: true -Position: 3 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` @@ -77,12 +68,15 @@ Applicable: Microsoft Whiteboard The ID of the new owner. ```yaml -Type: Guid -Required: true -Position: 4 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` @@ -91,49 +85,62 @@ Applicable: Microsoft Whiteboard Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: false -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` ### -WhatIf +Execute the command without making any actual changes. Only calls read methods on the REST service. + ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -Confirm [<SwitchParameter>] +### -Confirm + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -## INPUTS +### CommonParameters -### None +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). -## OUTPUTS +## INPUTS -### System.Object +## OUTPUTS ## NOTES -For details on user IDs, see the [overview page](whiteboard.md). +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md new file mode 100644 index 0000000000..69a0893606 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md @@ -0,0 +1,102 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/remove-whiteboard +applicable: Microsoft Whiteboard +title: Remove-Whiteboard +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +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. + +## SYNTAX + +```powershell +Remove-Whiteboard [-UserId] <Guid> [-WhiteboardId] <Guid> [-ForceAuthPrompt] [<CommonParameters>] +``` + +## DESCRIPTION + +Removes the specified whiteboard (owner) or a joined user removes themselves from the specified whiteboard. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` + +Deletes the whiteboard. + +## PARAMETERS + +### -UserId + +The ID of the user account to delete the whiteboard from. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -WhiteboardId + +The ID of a specific whiteboard to delete. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +(Optional) Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md new file mode 100644 index 0000000000..5ceb33569e --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md @@ -0,0 +1,86 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/restore-whiteboard +applicable: Microsoft Whiteboard +title: Restore-Whiteboard +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Restore-Whiteboard + +## SYNOPSIS + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. + +## SYNTAX + +```powershell +Restore-Whiteboard [-WhiteboardId] <Guid> [-ForceAuthPrompt] [<CommonParameters>] +``` + +## DESCRIPTION + +Restores the azure board. The migrated onedrive board will be retained to not lose any updates done to Azure board. +Restoration is only possible for approximately 90 days after migration, when the original board is still available. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Restore-Whiteboard -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` + +Restore the whiteboard. + +## PARAMETERS + +### -WhiteboardId + +The ID of a specific whiteboard to restore. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +(Optional) Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md index 2129607786..3b05afdd46 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md @@ -1,65 +1,57 @@ --- -external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftWhiteboard +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardowner applicable: Microsoft Whiteboard title: Set-WhiteboardOwner -online version: schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: --- # Set-WhiteboardOwner ## SYNOPSIS -Sets the owner for a Whiteboard. +Sets the owner for a whiteboard. ## SYNTAX ```powershell -Set-WhiteboardOwner [[-Token] <AuthenticationResult>] [-WhiteboardId] <Guid> [-OldOwnerId] <Guid> [-NewOwnerId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>] +Set-WhiteboardOwner [-WhiteboardId] <Guid> [-OldOwnerId] <Guid> [-NewOwnerId] <Guid> [-ForceAuthPrompt] [-WhatIf] [-Confirm] [<CommonParameters>] ``` ## DESCRIPTION -Sets the owner for a Whiteboard. +Sets the owner for a whiteboard. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 -``` -PS C:\>Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 +```powershell +PS C:\>Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhiteboardId 00000000-0000-0000-0000-000000000003 ``` -Move a Whiteboard from one user to another. +Move whiteboard ownership from one user to another. ## PARAMETERS -### -Token - -The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated. - -```yaml -Type: Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult -Required: false -Position: 1 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false -Applicable: Microsoft Whiteboard -``` - ### -WhiteboardId -The Whiteboard for which the owner is being changed. +The whiteboard for which the owner is being changed. ```yaml -Type: Guid -Required: true -Position: 2 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` @@ -68,12 +60,15 @@ Applicable: Microsoft Whiteboard The ID of the previous owner. ```yaml -Type: Guid -Required: true -Position: 3 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` @@ -82,12 +77,15 @@ Applicable: Microsoft Whiteboard The ID of the new owner. ```yaml -Type: Guid -Required: true -Position: 4 -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` @@ -96,49 +94,62 @@ Applicable: Microsoft Whiteboard Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: false -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` ### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -Confirm [<SwitchParameter>] +### -Confirm + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter -Required: false -Position: named -Default value: None -Accept pipeline input: false -Accept wildcard characters: false +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -## INPUTS +### CommonParameters -### None +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). -## OUTPUTS +## INPUTS -### System.Object +## OUTPUTS ## NOTES -For details on user IDs, see the [overview page](whiteboard.md). +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). -## RELATED LINKS \ No newline at end of file +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md new file mode 100644 index 0000000000..f7c57fa1bf --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -0,0 +1,92 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardsettings +applicable: Microsoft Whiteboard +title: Set-WhiteboardSettings +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Set-WhiteboardSettings + +## SYNOPSIS + +Get the users Whiteboard settings. + +## SYNTAX + +```powershell +Set-WhiteboardSettings + [-ForceAuthPrompt][-Settings] + [<CommonParameters>] +``` + +## DESCRIPTION + +Sets the tenant settings for the Microsoft Whiteboard services. + +## EXAMPLES + +### EXAMPLE 1 + +This command sets the tenant settings for the Microsoft Whiteboard services. + +```powershell +PS C:\> $settings = Get-WhiteboardSettings +$settings.isEnabledGa = $true +Set-WhiteboardSettings -Settings $settings +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -Settings + +The object to use as Whiteboard Settings. Should be retrieved via [Get-WhiteboardSettings](Get-WhiteboardSettings.md). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md index f6874f3e71..ba9d6b6572 100644 --- a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md @@ -2,17 +2,74 @@ Module Name: Microsoft Whiteboard Admin Module Guid: CC24F7D4-4CF7-46D3-BD87-30A3D44ECF96 title: Microsoft Whiteboard -Locale: en-US --- # Microsoft Whiteboard Admin ## Description -The following cmdlet references are for Microsoft Whiteboard. See [Overview](../../docs-conceptual/overview.md) for details on installing the module. +The following cmdlet references are for Microsoft Whiteboard. See [Overview](https://learn.microsoft.com/powershell/whiteboard/overview) for details on installing the module. The module can only be run by users with Global Administrator or SharePoint Administrator roles. The module described here is for Whiteboard content stored in Azure. + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. To learn more, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles). + +## Prerequisite for commands Get-OriginalFluidWhiteboards, Get-OriginalFluidWhiteboardsForTenant, Get-WhiteboardsMigrated, Get-WhiteboardsForTenantMigrated to get whiteboards from users OneDrive + +Inorder to get whiteboards which is in OneDrive for any users, Admin should have access to all those users OneDrive. +Admin can use Admin portal to give "Site-CollectionAdmin" role to users account for which they want to get all whiteboards in OneDrive. +Go to sharepoint Admin center > On left hand side, click "More features" > In User profiles, click "Open". +Manage User profiles > Search user > Manage site collection owners > Add Admin as Site Collection Administrator. + +## Microsoft Whiteboard Admin cmdlets ### [Get-Whiteboard](Get-Whiteboard.md) -### [Set-WhiteboardOwner](Set-WhiteboardOwner.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-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) + +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +### [Get-OriginalFluidWhiteboards](Get-OriginalFluidWhiteboards.md) + +Gets one or more whiteboards that are originally created as Fluid whiteboards directly into users OneDrive and return them as objects. + +### [Get-OriginalFluidWhiteboardsForTenant](Get-OriginalFluidWhiteboardsForTenant.md) + +Gets one or more whiteboards that are originally created as fluid whiteboards directly into OneDrive for all users under that admin and returns them as objects. + +### [Get-WhiteboardsMigrated](Get-WhiteboardsMigrated.md) + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +### [Get-WhiteboardsForTenantMigrated](Get-WhiteboardsForTenantMigrated.md) + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. ### [Invoke-TransferAllWhiteboard](Invoke-TransferAllWhiteboards.md) + +Transfer ownership of all whiteboards owned by a user to another user. + +### [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. + +### [Restore-Whiteboard](Restore-Whiteboard.md) + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. + +### [Get-WhiteboardSettings](Get-WhiteboardSettings.md) + +Gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +### [Set-WhiteboardSettings](Set-WhiteboardSettings.md) + +Sets the tenant settings for the Microsoft Whiteboard services.